diff --git a/aws/README.md b/aws/README.md new file mode 100644 index 00000000..785ac792 --- /dev/null +++ b/aws/README.md @@ -0,0 +1,56 @@ +# AWS CLI v2 + +This bundle contains a built executable of the AWS CLI v2. Note that the AWS +CLI v2 is in developer preview. In the future, there may be backwards +incompatible changes introduced to the AWS CLI v2. + +## Installation + +To install the AWS CLI v2, run the `install` script: +``` +$ sudo ./install +You can now run: /usr/local/bin/aws2 --version +``` +This will install the AWS CLI v2 at `/usr/local/bin/aws2`. Assuming +`/usr/local/bin` is on your `PATH`, you can now run: +``` +$ aws2 --verison +``` + + +### Installing without sudo + +If you don't have ``sudo`` permissions or want to install the AWS +CLI v2 only for the current user, run the `install` script with the `-b` +and `-i` options: +``` +$ ./install -i ~/.local/aws-cli -b ~/.local/bin +``` +This will install the AWS CLI v2 in `~/.local/aws-cli` and create +symlinks for `aws2` and `aws2_completer` in `~/.local/bin`. For more +information about these options, run the `install` script with `-h`: +``` +$ ./install -h +``` + +### Updating + +If you run the `install` script and there is a previously installed version +of the AWS CLI v2, the script will error out. To update to the version included +in this bundle, run the `install` script with `--update`: +``` +$ sudo ./install --update +``` + + +### Removing the installation + +To remove the AWS CLI v2, delete the its installation and symlinks: +``` +$ sudo rm -rf /usr/local/aws-cli +$ sudo rm /usr/local/bin/aws2 +$ sudo rm /usr/local/bin/aws2_completer +``` +Note if you installed the AWS CLI v2 using the `-b` or `-i` options, you will +need to remove the installation and the symlinks in the directories you +specified. diff --git a/aws/dist/.Python b/aws/dist/.Python new file mode 100755 index 00000000..61be62f7 Binary files /dev/null and b/aws/dist/.Python differ diff --git a/aws/dist/_asyncio.cpython-37m-darwin.so b/aws/dist/_asyncio.cpython-37m-darwin.so new file mode 100755 index 00000000..e3935b17 Binary files /dev/null and b/aws/dist/_asyncio.cpython-37m-darwin.so differ diff --git a/aws/dist/_bisect.cpython-37m-darwin.so b/aws/dist/_bisect.cpython-37m-darwin.so new file mode 100755 index 00000000..dc7f965b Binary files /dev/null and b/aws/dist/_bisect.cpython-37m-darwin.so differ diff --git a/aws/dist/_blake2.cpython-37m-darwin.so b/aws/dist/_blake2.cpython-37m-darwin.so new file mode 100755 index 00000000..082321fd Binary files /dev/null and b/aws/dist/_blake2.cpython-37m-darwin.so differ diff --git a/aws/dist/_bz2.cpython-37m-darwin.so b/aws/dist/_bz2.cpython-37m-darwin.so new file mode 100755 index 00000000..70d02c3d Binary files /dev/null and b/aws/dist/_bz2.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_cn.cpython-37m-darwin.so b/aws/dist/_codecs_cn.cpython-37m-darwin.so new file mode 100755 index 00000000..63f46700 Binary files /dev/null and b/aws/dist/_codecs_cn.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_hk.cpython-37m-darwin.so b/aws/dist/_codecs_hk.cpython-37m-darwin.so new file mode 100755 index 00000000..4d76816d Binary files /dev/null and b/aws/dist/_codecs_hk.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_iso2022.cpython-37m-darwin.so b/aws/dist/_codecs_iso2022.cpython-37m-darwin.so new file mode 100755 index 00000000..9a18df61 Binary files /dev/null and b/aws/dist/_codecs_iso2022.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_jp.cpython-37m-darwin.so b/aws/dist/_codecs_jp.cpython-37m-darwin.so new file mode 100755 index 00000000..c41e86e4 Binary files /dev/null and b/aws/dist/_codecs_jp.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_kr.cpython-37m-darwin.so b/aws/dist/_codecs_kr.cpython-37m-darwin.so new file mode 100755 index 00000000..6f389bfa Binary files /dev/null and b/aws/dist/_codecs_kr.cpython-37m-darwin.so differ diff --git a/aws/dist/_codecs_tw.cpython-37m-darwin.so b/aws/dist/_codecs_tw.cpython-37m-darwin.so new file mode 100755 index 00000000..bf2948eb Binary files /dev/null and b/aws/dist/_codecs_tw.cpython-37m-darwin.so differ diff --git a/aws/dist/_contextvars.cpython-37m-darwin.so b/aws/dist/_contextvars.cpython-37m-darwin.so new file mode 100755 index 00000000..f1820a6b Binary files /dev/null and b/aws/dist/_contextvars.cpython-37m-darwin.so differ diff --git a/aws/dist/_csv.cpython-37m-darwin.so b/aws/dist/_csv.cpython-37m-darwin.so new file mode 100755 index 00000000..f68f9e80 Binary files /dev/null and b/aws/dist/_csv.cpython-37m-darwin.so differ diff --git a/aws/dist/_ctypes.cpython-37m-darwin.so b/aws/dist/_ctypes.cpython-37m-darwin.so new file mode 100755 index 00000000..1672ca00 Binary files /dev/null and b/aws/dist/_ctypes.cpython-37m-darwin.so differ diff --git a/aws/dist/_datetime.cpython-37m-darwin.so b/aws/dist/_datetime.cpython-37m-darwin.so new file mode 100755 index 00000000..11a85d51 Binary files /dev/null and b/aws/dist/_datetime.cpython-37m-darwin.so differ diff --git a/aws/dist/_decimal.cpython-37m-darwin.so b/aws/dist/_decimal.cpython-37m-darwin.so new file mode 100755 index 00000000..049067a7 Binary files /dev/null and b/aws/dist/_decimal.cpython-37m-darwin.so differ diff --git a/aws/dist/_elementtree.cpython-37m-darwin.so b/aws/dist/_elementtree.cpython-37m-darwin.so new file mode 100755 index 00000000..1e95bd25 Binary files /dev/null and b/aws/dist/_elementtree.cpython-37m-darwin.so differ diff --git a/aws/dist/_hashlib.cpython-37m-darwin.so b/aws/dist/_hashlib.cpython-37m-darwin.so new file mode 100755 index 00000000..72531200 Binary files /dev/null and b/aws/dist/_hashlib.cpython-37m-darwin.so differ diff --git a/aws/dist/_heapq.cpython-37m-darwin.so b/aws/dist/_heapq.cpython-37m-darwin.so new file mode 100755 index 00000000..dca73346 Binary files /dev/null and b/aws/dist/_heapq.cpython-37m-darwin.so differ diff --git a/aws/dist/_json.cpython-37m-darwin.so b/aws/dist/_json.cpython-37m-darwin.so new file mode 100755 index 00000000..24064088 Binary files /dev/null and b/aws/dist/_json.cpython-37m-darwin.so differ diff --git a/aws/dist/_lzma.cpython-37m-darwin.so b/aws/dist/_lzma.cpython-37m-darwin.so new file mode 100755 index 00000000..84349743 Binary files /dev/null and b/aws/dist/_lzma.cpython-37m-darwin.so differ diff --git a/aws/dist/_md5.cpython-37m-darwin.so b/aws/dist/_md5.cpython-37m-darwin.so new file mode 100755 index 00000000..feae6094 Binary files /dev/null and b/aws/dist/_md5.cpython-37m-darwin.so differ diff --git a/aws/dist/_multibytecodec.cpython-37m-darwin.so b/aws/dist/_multibytecodec.cpython-37m-darwin.so new file mode 100755 index 00000000..478f60fd Binary files /dev/null and b/aws/dist/_multibytecodec.cpython-37m-darwin.so differ diff --git a/aws/dist/_multiprocessing.cpython-37m-darwin.so b/aws/dist/_multiprocessing.cpython-37m-darwin.so new file mode 100755 index 00000000..381fa579 Binary files /dev/null and b/aws/dist/_multiprocessing.cpython-37m-darwin.so differ diff --git a/aws/dist/_opcode.cpython-37m-darwin.so b/aws/dist/_opcode.cpython-37m-darwin.so new file mode 100755 index 00000000..38f0047d Binary files /dev/null and b/aws/dist/_opcode.cpython-37m-darwin.so differ diff --git a/aws/dist/_pickle.cpython-37m-darwin.so b/aws/dist/_pickle.cpython-37m-darwin.so new file mode 100755 index 00000000..5d86e0d6 Binary files /dev/null and b/aws/dist/_pickle.cpython-37m-darwin.so differ diff --git a/aws/dist/_posixsubprocess.cpython-37m-darwin.so b/aws/dist/_posixsubprocess.cpython-37m-darwin.so new file mode 100755 index 00000000..eba36a19 Binary files /dev/null and b/aws/dist/_posixsubprocess.cpython-37m-darwin.so differ diff --git a/aws/dist/_queue.cpython-37m-darwin.so b/aws/dist/_queue.cpython-37m-darwin.so new file mode 100755 index 00000000..3967fc66 Binary files /dev/null and b/aws/dist/_queue.cpython-37m-darwin.so differ diff --git a/aws/dist/_random.cpython-37m-darwin.so b/aws/dist/_random.cpython-37m-darwin.so new file mode 100755 index 00000000..10b38db5 Binary files /dev/null and b/aws/dist/_random.cpython-37m-darwin.so differ diff --git a/aws/dist/_ruamel_yaml.cpython-37m-darwin.so b/aws/dist/_ruamel_yaml.cpython-37m-darwin.so new file mode 100755 index 00000000..2f2bb0a8 Binary files /dev/null and b/aws/dist/_ruamel_yaml.cpython-37m-darwin.so differ diff --git a/aws/dist/_scproxy.cpython-37m-darwin.so b/aws/dist/_scproxy.cpython-37m-darwin.so new file mode 100755 index 00000000..1203dfc9 Binary files /dev/null and b/aws/dist/_scproxy.cpython-37m-darwin.so differ diff --git a/aws/dist/_sha1.cpython-37m-darwin.so b/aws/dist/_sha1.cpython-37m-darwin.so new file mode 100755 index 00000000..58f17262 Binary files /dev/null and b/aws/dist/_sha1.cpython-37m-darwin.so differ diff --git a/aws/dist/_sha256.cpython-37m-darwin.so b/aws/dist/_sha256.cpython-37m-darwin.so new file mode 100755 index 00000000..5265b0ab Binary files /dev/null and b/aws/dist/_sha256.cpython-37m-darwin.so differ diff --git a/aws/dist/_sha3.cpython-37m-darwin.so b/aws/dist/_sha3.cpython-37m-darwin.so new file mode 100755 index 00000000..756a4f7c Binary files /dev/null and b/aws/dist/_sha3.cpython-37m-darwin.so differ diff --git a/aws/dist/_sha512.cpython-37m-darwin.so b/aws/dist/_sha512.cpython-37m-darwin.so new file mode 100755 index 00000000..4140280e Binary files /dev/null and b/aws/dist/_sha512.cpython-37m-darwin.so differ diff --git a/aws/dist/_socket.cpython-37m-darwin.so b/aws/dist/_socket.cpython-37m-darwin.so new file mode 100755 index 00000000..6c3a7ee5 Binary files /dev/null and b/aws/dist/_socket.cpython-37m-darwin.so differ diff --git a/aws/dist/_sqlite3.cpython-37m-darwin.so b/aws/dist/_sqlite3.cpython-37m-darwin.so new file mode 100755 index 00000000..e13cbba5 Binary files /dev/null and b/aws/dist/_sqlite3.cpython-37m-darwin.so differ diff --git a/aws/dist/_ssl.cpython-37m-darwin.so b/aws/dist/_ssl.cpython-37m-darwin.so new file mode 100755 index 00000000..ae9f89c1 Binary files /dev/null and b/aws/dist/_ssl.cpython-37m-darwin.so differ diff --git a/aws/dist/_struct.cpython-37m-darwin.so b/aws/dist/_struct.cpython-37m-darwin.so new file mode 100755 index 00000000..6a003319 Binary files /dev/null and b/aws/dist/_struct.cpython-37m-darwin.so differ diff --git a/aws/dist/_struct/cpython-37m-darwin/sotruct.cpython-37m-darwin.so b/aws/dist/_struct/cpython-37m-darwin/sotruct.cpython-37m-darwin.so new file mode 100755 index 00000000..6a003319 Binary files /dev/null and b/aws/dist/_struct/cpython-37m-darwin/sotruct.cpython-37m-darwin.so differ diff --git a/aws/dist/_uuid.cpython-37m-darwin.so b/aws/dist/_uuid.cpython-37m-darwin.so new file mode 100755 index 00000000..3ca04ebb Binary files /dev/null and b/aws/dist/_uuid.cpython-37m-darwin.so differ diff --git a/aws/dist/array.cpython-37m-darwin.so b/aws/dist/array.cpython-37m-darwin.so new file mode 100755 index 00000000..a3b644a9 Binary files /dev/null and b/aws/dist/array.cpython-37m-darwin.so differ diff --git a/aws/dist/aws2 b/aws/dist/aws2 new file mode 100755 index 00000000..dd9d9c8c Binary files /dev/null and b/aws/dist/aws2 differ diff --git a/aws/dist/aws2_completer b/aws/dist/aws2_completer new file mode 100755 index 00000000..2a0787d3 Binary files /dev/null and b/aws/dist/aws2_completer differ diff --git a/aws/dist/awscli/customizations/wizard/wizards/configure/_main.yml b/aws/dist/awscli/customizations/wizard/wizards/configure/_main.yml new file mode 100644 index 00000000..91d792ad --- /dev/null +++ b/aws/dist/awscli/customizations/wizard/wizards/configure/_main.yml @@ -0,0 +1,146 @@ +version: "0.1" +title: Configure the AWS CLI +description: This wizard will create a new CLI config profile for you +plan: + decide_profile_type: + values: + config_type: + type: prompt + description: "What would you like to configure" + choices: + # There's also Web Identity and SAML but we're skipping that. + - display: Static Credentials + actual_value: static_creds + - display: Assume Role + actual_value: assume_role + - display: Process Provider + actual_value: proc_provider + - display: Additional CLI configuration + actual_value: additional_config + profile_name: + type: prompt + description: Enter the name of the profile + next_step: + switch: config_type + static_creds: get_static_creds + assume_role: get_assume_role + proc_provider: get_process_provider + additional_config: get_extra_cli_config + get_static_creds: + values: + access_key_id: + type: prompt + description: Enter your Access Key Id + secret_key: + type: prompt + description: Enter your Secret Access Key + next_step: DONE + get_process_provider: + values: + creds_process: + type: prompt + description: Enter the credential process command + next_step: DONE + get_assume_role: + values: + existing_profiles: + type: sharedconfig + operation: ListProfiles + existing_roles: + type: apicall + operation: iam.ListRoles + params: {} + query: "sort_by(Roles[].{display: RoleName, actual_value: Arn}, &display)" + role_arn: + type: prompt + description: Select the role you want to assume + choices: existing_roles + credential_source_type: + type: prompt + description: Select your credentials source type + choices: + - display: Source Profile + actual_value: source_profile + - display: Environment Variables + actual_value: Environment + - display: Amazon EC2 Instance Metadata + actual_value: Ec2InstanceMetadata + - display: Amazon ECS Container Credentials + actual_value: EcsContainer + next_step: + switch: credential_source_type + source_profile: get_source_profile + Environment: DONE + Ec2InstanceMetadata: DONE + EcsContainer: DONE + get_source_profile: + values: + source_profile: + type: prompt + description: Select the source profile + choices: existing_profiles + next_step: DONE + get_extra_cli_config: + # TODO: Not implemented yet. I think we want a loop for this? + # Keep prompting for as many key/value pairs as they want. + values: + region: + type: prompt + description: "Enter the region name" +execute: + # All the logic needed when the user selects assume role. + assume_role: + - type: sharedconfig + operation: SetValues + profile: "{profile_name}" + condition: + variable: config_type + equals: assume_role + params: + role_arn: "{role_arn}" + - type: sharedconfig + operation: SetValues + condition: + variable: credential_source_type + equals: source_profile + profile: "{profile_name}" + params: + source_profile: "{source_profile}" + - type: sharedconfig + operation: SetValues + condition: + - variable: source_profile + equals: null + - variable: config_type + equals: assume_role + profile: "{profile_name}" + params: + credential_source: "{credential_source_type}" + static_creds: + - type: sharedconfig + operation: SetValues + profile: "{profile_name}" + condition: + variable: config_type + equals: static_creds + params: + aws_access_key_id: "{access_key_id}" + aws_secret_access_key: "{secret_key}" + proc_provider: + - type: sharedconfig + operation: SetValues + profile: "{profile_name}" + condition: + variable: config_type + equals: proc_provider + params: + credential_process: "{creds_process}" + additional_config: + - type: sharedconfig + operation: SetValues + profile: "{profile_name}" + condition: + variable: config_type + equals: additional_config + params: + region: "{region}" diff --git a/aws/dist/awscli/customizations/wizard/wizards/iam/new-role.yml b/aws/dist/awscli/customizations/wizard/wizards/iam/new-role.yml new file mode 100644 index 00000000..c405aba3 --- /dev/null +++ b/aws/dist/awscli/customizations/wizard/wizards/iam/new-role.yml @@ -0,0 +1,146 @@ +version: "0.1" +title: Create An IAM Role and Policy +description: This wizard will create a new IAM role for you +plan: + decide_role_type: + values: + # This will prompt the user using the 'description' value. + # The value the user enters is saved under the global variable + # 'name'. + role_type: + type: prompt + description: Select type of trusted entity + choices: + # There's also Web Identity and SAML but we're skipping that. + - display: AWS Service + actual_value: aws_service + - display: Another AWS Account + actual_value: aws_account + next_step: + switch: role_type + aws_service: get_role_service + aws_account: get_account_info + get_role_service: + values: + service_name: + type: prompt + description: Choose the service that will use this role + choices: + - display: Amazon EC2 + actual_value: ec2 + - display: AWS Lambda + actual_value: lambda + trust_policy: + type: template + value: | + {{ + "Version": "2008-10-17", + "Statement": [ + {{ + "Action": "sts:AssumeRole", + "Principal": {{ + "Service": "{service_name}.amazonaws.com" + }}, + "Effect": "Allow", + "Sid": "" + }} + ] + }} + next_step: ask_role_permissions + get_account_info: + values: + account_id: + type: prompt + description: Enter the Account ID that can use this role + trust_policy: + type: template + value: | + {{ + "Version": "2008-10-17", + "Statement": [ + {{ + "Action": "sts:AssumeRole", + "Principal": {{ + "AWS": "arn:aws:iam::{account_id}:root" + }}, + "Effect": "Allow", + "Sid": "" + }} + ] + }} + next_step: ask_role_permissions + ask_role_permissions: + # The console by default asks you to pick an existing policy + # to attach to. We'll just go with that behavior for now. + values: + existing_policies: + type: apicall + operation: iam.ListPolicies + params: + Scope: AWS + query: "sort_by(Policies[].{display: PolicyName, actual_value: Arn}, &display)" + policy_arn: + type: prompt + description: Choose a policy to attach to your new role + choices: existing_policies + ask_role_name: + values: + role_name: + type: prompt + description: Role name + role_description: + type: prompt + description: Role description + ask_profile_config: + values: + wants_config_profile: + type: prompt + description: Do you want to create a new CLI profile with this role? + choices: + - display: Yes + actual_value: yes + - display: No + actual_value: no + next_step: + switch: wants_config_profile + yes: get_profile_info + no: DONE + get_profile_info: + values: + new_profile_name: + type: prompt + description: Enter the name of the new profile + existing_profiles: + type: sharedconfig + operation: ListProfiles + source_profile: + type: prompt + description: Name of the source profile + choices: existing_profiles +execute: + default: + - type: apicall + operation: iam.CreateRole + params: + RoleName: "{role_name}" + AssumeRolePolicyDocument: "{trust_policy}" + Description: "{role_description}" + output_var: role_arn + query: Role.Arn + - type: apicall + operation: iam.AttachRolePolicy + params: + RoleName: "{role_name}" + PolicyArn: "{policy_arn}" + write_config_file: + - type: sharedconfig + operation: SetValues + condition: + variable: wants_config_profile + equals: yes + profile: "{new_profile_name}" + params: + source_profile: "{source_profile}" + # This role_arn comes from the `output_var` in the previous + # executor step. + role_arn: "{role_arn}" diff --git a/aws/dist/awscli/customizations/wizard/wizards/lambda/new-function.yml b/aws/dist/awscli/customizations/wizard/wizards/lambda/new-function.yml new file mode 100644 index 00000000..8f556d52 --- /dev/null +++ b/aws/dist/awscli/customizations/wizard/wizards/lambda/new-function.yml @@ -0,0 +1,63 @@ +version: "0.1" +title: Create An AWS Lambda Function +description: This wizard will create a new AWS Lambda function for you +plan: + basics: + values: + function_name: + type: prompt + description: Enter the function name + runtime: + type: prompt + description: Select the Lambda runtime + choices: + - actual_value: python2.7 + display: Python 2.7 + - actual_value: python3.6 + display: Python 3.6 + - actual_value: python3.7 + display: Python 3.7 + - actual_value: nodejs4.3 + display: Node.js 4.3 + - actual_value: nodejs6.10 + display: Node.js 6.10 + - actual_value: nodejs8.10 + display: Node.js 8.10 + - actual_value: java8 + display: Java 8 + - actual_value: dotnetcore1.0 + display: .NET Core 1.0 (C#) + - actual_value: dotnetcore2.0 + display: .NET Core 2.0 (C#) + - actual_value: dotnetcore2.1 + display: .NET Core 2.1 (C#) + - actual_value: go1. + display: Go 1.x + existing_roles: + type: apicall + operation: iam.ListRoles + params: {} + query: "sort_by(Roles[].{display: RoleName, actual_value: Arn}, &display)" + role_arn: + type: prompt + description: Select the role to use + choices: existing_roles + handler: + type: prompt + description: Enter the handler for your function + zip_filename: + type: fileprompt + description: Enter the new location of your code zip file +execute: + default: + - type: apicall + operation: lambda.CreateFunction + params: + FunctionName: "{function_name}" + Role: "{role_arn}" + Runtime: "{runtime}" + Handler: "{handler}" + Code: + ZipFile: + __wizard__:File: + path: "{zip_filename}" diff --git a/aws/dist/awscli/data/ac.index b/aws/dist/awscli/data/ac.index new file mode 100644 index 00000000..fae73f4f Binary files /dev/null and b/aws/dist/awscli/data/ac.index differ diff --git a/aws/dist/awscli/data/cli.json b/aws/dist/awscli/data/cli.json new file mode 100644 index 00000000..8bad30a7 --- /dev/null +++ b/aws/dist/awscli/data/cli.json @@ -0,0 +1,70 @@ +{ + "description": "The AWS Command Line Interface is a unified tool to manage your AWS services.", + "synopsis": "aws [options] [parameters]", + "help_usage": "Use *aws command help* for information on a specific command. Use *aws help topics* to view a list of available help topics. The synopsis for each command shows its parameters and their usage. Optional parameters are shown in square brackets.", + "options": { + "debug": { + "action": "store_true", + "help": "

Turn on debug logging.

" + }, + "endpoint-url": { + "help": "

Override command's default URL with the given URL.

" + }, + "no-verify-ssl": { + "action": "store_false", + "dest": "verify_ssl", + "help": "

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

" + }, + "no-paginate": { + "action": "store_false", + "help": "

Disable automatic pagination.

", + "dest": "paginate" + }, + "output": { + "choices": [ + "json", + "text", + "table", + "yaml" + ], + "help": "

The formatting style for command output.

" + }, + "query": { + "help": "

A JMESPath query to use in filtering the response data.

" + }, + "profile": { + "help": "

Use a specific profile from your credential file.

" + }, + "region": { + "help": "

The region to use. Overrides config/env settings.

" + }, + "version": { + "action": "version", + "help": "

Display the version of this tool.

" + }, + "color": { + "choices": ["on", "off", "auto"], + "default": "auto", + "help": "

Turn on/off color output.

" + }, + "no-sign-request": { + "action": "store_false", + "dest": "sign_request", + "help": "

Do not sign requests. Credentials will not be loaded if this argument is provided.

" + }, + "ca-bundle": { + "dest": "ca_bundle", + "help": "

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

" + }, + "cli-read-timeout": { + "dest": "read_timeout", + "type": "int", + "help": "

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout.

" + }, + "cli-connect-timeout": { + "dest": "connect_timeout", + "type": "int", + "help": "

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout.

" + } + } +} diff --git a/aws/dist/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst b/aws/dist/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst new file mode 100644 index 00000000..3b4c2907 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/create-certificate-authority-audit-report.rst @@ -0,0 +1,5 @@ +**To create a certificate authority audit report** + +The following ``create-certificate-authority-audit-report`` command creates an audit report for the private CA identified by the ARN. :: + + aws acm-pca create-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-east-1:accountid:certificate-authority/12345678-1234-1234-1234-123456789012 --s3-bucket-name your-bucket-name --audit-report-response-format JSON \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/create-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/create-certificate-authority.rst new file mode 100644 index 00000000..9e4b33ab --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/create-certificate-authority.rst @@ -0,0 +1,5 @@ +**To create a private certificate authority** + +The following ``create-certificate-authority`` command creates a private certificate authority in your AWS account. :: + + aws acm-pca create-certificate-authority --certificate-authority-configuration file://C:\ca_config.txt --revocation-configuration file://C:\revoke_config.txt --certificate-authority-type "SUBORDINATE" --idempotency-token 98256344 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/delete-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/delete-certificate-authority.rst new file mode 100644 index 00000000..e2c1c2eb --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/delete-certificate-authority.rst @@ -0,0 +1,5 @@ +**To delete a private certificate authority** + +The following ``delete-certificate-authority`` command deletes the certificate authority identified by the ARN. :: + + aws acm-pca delete-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst b/aws/dist/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst new file mode 100644 index 00000000..e90b3cb0 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/describe-certificate-authority-audit-report.rst @@ -0,0 +1,5 @@ +**To describe an audit report for a certificate authority** + +The following ``describe-certificate-authority-audit-report`` command lists information about the specified audit report for the CA identified by the ARN. :: + + aws acm-pca describe-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/99999999-8888-7777-6666-555555555555 --audit-report-id 11111111-2222-3333-4444-555555555555 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/describe-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/describe-certificate-authority.rst new file mode 100644 index 00000000..0599f8cd --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/describe-certificate-authority.rst @@ -0,0 +1,5 @@ +**To describe a private certificate authority** + +The following ``describe-certificate-authority`` command lists information about the private CA identified by the ARN. :: + + aws acm-pca describe-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/get-certificate-authority-certificate.rst b/aws/dist/awscli/examples/acm-pca/get-certificate-authority-certificate.rst new file mode 100644 index 00000000..3a562c8f --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/get-certificate-authority-certificate.rst @@ -0,0 +1,5 @@ +**To retrieve a certificate authority (CA) certificate** + +The following ``get-certificate-authority-certificate`` command retrieves the certificate and certificate chain for the private CA specified by the ARN. :: + + aws acm-pca get-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/get-certificate-authority-csr.rst b/aws/dist/awscli/examples/acm-pca/get-certificate-authority-csr.rst new file mode 100644 index 00000000..a18c734c --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/get-certificate-authority-csr.rst @@ -0,0 +1,5 @@ +**To retrieve the certificate signing request for a certificate authority** + +The following ``get-certificate-authority-csr`` command retrieves the CSR for the private CA specified by the ARN. :: + + aws acm-pca get-certificate-authority-csr --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --output text \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/get-certificate.rst b/aws/dist/awscli/examples/acm-pca/get-certificate.rst new file mode 100644 index 00000000..0a6371fc --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/get-certificate.rst @@ -0,0 +1,28 @@ +**To retrieve an issued certificate** + +The following ``get-certificate`` example retrieves a certificate from the specified private CA. :: + + aws acm-pca get-certificate \ + --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 \ + --certificate-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/6707447683a9b7f4055627ffd55cebcc \ + --output text + +Output: + +The first part of the output is the certificate itself. The second part is the certificate chain that chains to the root CA certificate. Note that when you use the ``--output text`` option, a ``TAB`` character is inserted between the two certificate pieces (that is the cause of the indented text). If you intend to take this output and parse the certificates with other tools, you might need to remove the ``TAB`` character so it is processed correctly. :: + + -----BEGIN CERTIFICATE----- + MIIEDzCCAvegAwIBAgIRAJuJ8f6ZVYL7gG/rS3qvrZMwDQYJKoZIhvcNAQELBQAw + cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl + ....certificate body truncated for brevity.... + tKCSglgZZrd4FdLw1EkGm+UVXnodwMtJEQyy3oTfZjURPIyyaqskTu/KSS7YDjK0 + KQNy73D6LtmdOEbAyq10XiDxqY41lvKHJ1eZrPaBmYNABxU= + -----END CERTIFICATE----- + -----BEGIN CERTIFICATE----- + MIIDrzCCApegAwIBAgIRAOskdzLvcj1eShkoyEE693AwDQYJKoZIhvcNAQELBQAw + cTELMAkGA1UEBhMCVVMxEzARBgNVBAgMCldhc2hpbmd0b24xEDAOBgNVBAcMB1Nl + ...certificate body truncated for brevity.... + kdRGB6P2hpxstDOUIwAoCbhoaWwfA4ybJznf+jOQhAziNlRdKQRR8nODWpKt7H9w + dJ5nxsTk/fniJz86Ddtp6n8s82wYdkN3cVffeK72A9aTCOU= + -----END CERTIFICATE----- + diff --git a/aws/dist/awscli/examples/acm-pca/import-certificate-authority-certificate.rst b/aws/dist/awscli/examples/acm-pca/import-certificate-authority-certificate.rst new file mode 100644 index 00000000..e197b7c5 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/import-certificate-authority-certificate.rst @@ -0,0 +1,5 @@ +**To import your certificate authority certificate into ACM PCA** + +The following ``import-certificate-authority-certificate`` command imports the signed private CA certificate for the CA specified by the ARN into ACM PCA. :: + + aws acm-pca import-certificate-authority-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate file://C:\ca_cert.pem --certificate-chain file://C:\ca_cert_chain.pem \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/issue-certificate.rst b/aws/dist/awscli/examples/acm-pca/issue-certificate.rst new file mode 100644 index 00000000..c12c37fd --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/issue-certificate.rst @@ -0,0 +1,5 @@ +**To issue a private certificate** + +The following ``issue-certificate`` command uses the private CA specified by the ARN to issue a private certificate. :: + + aws acm-pca issue-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --csr file://C:\cert_1.csr --signing-algorithm "SHA256WITHRSA" --validity Value=365,Type="DAYS" --idempotency-token 1234 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/list-certificate-authorities.rst b/aws/dist/awscli/examples/acm-pca/list-certificate-authorities.rst new file mode 100644 index 00000000..8a43d121 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/list-certificate-authorities.rst @@ -0,0 +1,5 @@ +**To list your private certificate authorities** + +The following ``list-certificate-authorities`` command lists information about all of the private CAs in your account. :: + + aws acm-pca list-certificate-authorities --max-results 10 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/list-tags.rst b/aws/dist/awscli/examples/acm-pca/list-tags.rst new file mode 100644 index 00000000..2ec192d5 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/list-tags.rst @@ -0,0 +1,5 @@ +**To list the tags for your certificate authority** + +The following ``list-tags`` command lists the tags associated with the private CA specified by the ARN. :: + + aws acm-pca list-tags --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/123455678-1234-1234-1234-123456789012 --max-results 10 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/revoke-certificate.rst b/aws/dist/awscli/examples/acm-pca/revoke-certificate.rst new file mode 100644 index 00000000..6786d7b2 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/revoke-certificate.rst @@ -0,0 +1,5 @@ +**To revoke a private certificate** + +The following ``revoke-certificate`` command revokes a private certificate from the CA identified by the ARN. :: + + aws acm-pca revoke-certificate --certificate-authority-arn arn:aws:acm-pca:us-west-2:1234567890:certificate-authority/12345678-1234-1234-1234-123456789012 --certificate-serial 67:07:44:76:83:a9:b7:f4:05:56:27:ff:d5:5c:eb:cc --revocation-reason "KEY_COMPROMISE" \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/tag-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/tag-certificate-authority.rst new file mode 100644 index 00000000..161f0617 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/tag-certificate-authority.rst @@ -0,0 +1,5 @@ +**To attach tags to a private certificate authority** + +The following ``tag-certificate-authority`` command attaches one or more tags to your private CA. :: + + aws acm-pca tag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/untag-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/untag-certificate-authority.rst new file mode 100644 index 00000000..8292a510 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/untag-certificate-authority.rst @@ -0,0 +1,5 @@ +**To remove one or more tags from your private certificate authority** + +The following ``untag-certificate-authority`` command removes tags from the private CA identified by the ARN. :: + + aws acm-pca untag-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 --tags Key=Purpose,Value=Website \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm-pca/update-certificate-authority.rst b/aws/dist/awscli/examples/acm-pca/update-certificate-authority.rst new file mode 100644 index 00000000..962057e2 --- /dev/null +++ b/aws/dist/awscli/examples/acm-pca/update-certificate-authority.rst @@ -0,0 +1,5 @@ +**To update the configuration of your private certificate authority** + +The following ``update-certificate-authority`` command updates the status and configuration of the private CA identified by the ARN. :: + + aws acm-pca update-certificate-authority --certificate-authority-arn arn:aws:acm-pca:us-west-2:123456789012:certificate-authority/12345678-1234-1234-1234-1232456789012 --revocation-configuration file://C:\revoke_config.txt --status "DISABLED" \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm/add-tags-to-certificate.rst b/aws/dist/awscli/examples/acm/add-tags-to-certificate.rst new file mode 100644 index 00000000..3924b20a --- /dev/null +++ b/aws/dist/awscli/examples/acm/add-tags-to-certificate.rst @@ -0,0 +1,7 @@ +**To add tags to an existing ACM Certificate** + +The following ``add-tags-to-certificate`` command adds two tags to the specified certificate. Use a space to separate multiple tags:: + + aws acm add-tags-to-certificate --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website + + diff --git a/aws/dist/awscli/examples/acm/delete-certificate.rst b/aws/dist/awscli/examples/acm/delete-certificate.rst new file mode 100644 index 00000000..ef24b25c --- /dev/null +++ b/aws/dist/awscli/examples/acm/delete-certificate.rst @@ -0,0 +1,5 @@ +**To delete an ACM certificate from your account** + +The following ``delete-certificate`` command deletes the certificate with the specified ARN:: + + aws acm delete-certificate --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 \ No newline at end of file diff --git a/aws/dist/awscli/examples/acm/describe-certificate.rst b/aws/dist/awscli/examples/acm/describe-certificate.rst new file mode 100644 index 00000000..07ee0508 --- /dev/null +++ b/aws/dist/awscli/examples/acm/describe-certificate.rst @@ -0,0 +1,59 @@ +**To retrieve the fields contained in an ACM certificate** + +The following ``describe-certificate`` command retrieves all of the fields for the certificate with the specified ARN:: + + aws acm describe-certificate --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + +Output similar to the following is displayed:: + + { + "Certificate": { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", + "CreatedAt": 1446835267.0, + "DomainName": "www.example.com", + "DomainValidationOptions": [ + { + "DomainName": "www.example.com", + "ValidationDomain": "www.example.com", + "ValidationEmails": [ + "hostmaster@example.com", + "admin@example.com", + "owner@example.com.whoisprivacyservice.org", + "tech@example.com.whoisprivacyservice.org", + "admin@example.com.whoisprivacyservice.org", + "postmaster@example.com", + "webmaster@example.com", + "administrator@example.com" + ] + }, + { + "DomainName": "www.example.net", + "ValidationDomain": "www.example.net", + "ValidationEmails": [ + "postmaster@example.net", + "admin@example.net", + "owner@example.net.whoisprivacyservice.org", + "tech@example.net.whoisprivacyservice.org", + "admin@example.net.whoisprivacyservice.org", + "hostmaster@example.net", + "administrator@example.net", + "webmaster@example.net" + ] + } + ], + "InUseBy": [], + "IssuedAt": 1446835815.0, + "Issuer": "Amazon", + "KeyAlgorithm": "RSA-2048", + "NotAfter": 1478433600.0, + "NotBefore": 1446768000.0, + "Serial": "0f:ac:b0:a3:8d:ea:65:52:2d:7d:01:3a:39:36:db:d6", + "SignatureAlgorithm": "SHA256WITHRSA", + "Status": "ISSUED", + "Subject": "CN=www.example.com", + "SubjectAlternativeNames": [ + "www.example.com", + "www.example.net" + ] + } + } diff --git a/aws/dist/awscli/examples/acm/get-certificate.rst b/aws/dist/awscli/examples/acm/get-certificate.rst new file mode 100644 index 00000000..0f9c51ae --- /dev/null +++ b/aws/dist/awscli/examples/acm/get-certificate.rst @@ -0,0 +1,75 @@ +**To retrieve an ACM certificate** + +The following ``get-certificate`` command retrieves the certificate for the specified ARN and the certificate chain:: + + aws acm get-certificate --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + +Output similar to the following is displayed:: + + { + "Certificate": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----", + + "CertificateChain": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----", + "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----", + "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----" + } diff --git a/aws/dist/awscli/examples/acm/list-certificates.rst b/aws/dist/awscli/examples/acm/list-certificates.rst new file mode 100644 index 00000000..df5a9977 --- /dev/null +++ b/aws/dist/awscli/examples/acm/list-certificates.rst @@ -0,0 +1,58 @@ +**To list the ACM certificates for an AWS account** + +The following ``list-certificates`` command lists the ARNs of the certificates in your account:: + + aws acm list-certificates + +The preceding command produces output similar to the following:: + + { + "CertificateSummaryList": [ + { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", + "DomainName": "www.example.com" + }, + { + "CertificateArn": "arn:aws:acm:us-east-1:493619779192:certificate/87654321-4321-4321-4321-210987654321", + "DomainName": "www.example.net" + } + ] + } + +You can decide how many certificates you want to display each time you call ``list-certificates``. For example, if you have four certificates and you want to display no more than two at a time, set the ``max-items`` argument to 2 as in the following example:: + + aws acm list-certificates --max-items 2 + +Two certificate ARNs and a ``NextToken`` value will be displayed:: + + "CertificateSummaryList": [ + { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012: \ + certificate/12345678-1234-1234-1234-123456789012", + "DomainName": "www.example.com" + }, + { + "CertificateArn": "arn:aws:acm:us-east-1:123456789012: \ + certificate/87654321-4321-4321-4321-210987654321", + "DomainName": "www.example.net" + } + ], + "NextToken": "9f4d9f69-275a-41fe-b58e-2b837bd9ba48" + +To display the next two certificates in your account, set this ``NextToken`` value in your next call:: + + aws acm list-certificates --max-items 2 --next-token 9f4d9f69-275a-41fe-b58e-2b837bd9ba48 + + +You can filter your output by using the ``certificate-statuses`` argument. The following command displays certificates that have a PENDING_VALIDATION status:: + + aws acm list-certificates --certificate-statuses PENDING_VALIDATION + +You can also filter your output by using the ``includes`` argument. The following command displays certificates filtered on the following properties. The certificates to be displayed:: + + - Specify that the RSA algorithm and a 2048 bit key are used to generate key pairs. + - Contain a Key Usage extension that specifies that the certificates can be used to create digital signatures. + - Contain an Extended Key Usage extension that specifies that the certificates can be used for code signing. + + aws acm list-certificates --max-items 10 --includes extendedKeyUsage=CODE_SIGNING,keyUsage=DIGITAL_SIGNATURE,keyTypes=RSA_2048 + diff --git a/aws/dist/awscli/examples/acm/list-tags-for-certificate.rst b/aws/dist/awscli/examples/acm/list-tags-for-certificate.rst new file mode 100644 index 00000000..cc9b4a44 --- /dev/null +++ b/aws/dist/awscli/examples/acm/list-tags-for-certificate.rst @@ -0,0 +1,20 @@ +**To list the tags applied to an ACM Certificate** + +The following ``list-tags-for-certificate`` command lists the tags applied to a certificate in your account:: + + aws acm list-tags-for-certificate --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 + +The preceding command produces ouput similar to the following:: + + { + "Tags": [ + { + "Value": "Website", + "Key": "Purpose" + }, + { + "Value": "Alice", + "Key": "Admin" + } + ] + } diff --git a/aws/dist/awscli/examples/acm/remove-tags-from-certificate.rst b/aws/dist/awscli/examples/acm/remove-tags-from-certificate.rst new file mode 100644 index 00000000..051e0e4b --- /dev/null +++ b/aws/dist/awscli/examples/acm/remove-tags-from-certificate.rst @@ -0,0 +1,7 @@ +**To remove a tag from an ACM Certificate** + +The following ``remove-tags-from-certificate`` command removes two tags from the specified certificate. Use a space to separate multiple tags:: + + aws acm remove-tags-from-certificate --certificate-arn arn:aws:acm:us-east-1:1234567890122:certificate/12345678-1234-1234-1234-123456789012 --tags Key=Admin,Value=Alice Key=Purpose,Value=Website + + diff --git a/aws/dist/awscli/examples/acm/request-certificate.rst b/aws/dist/awscli/examples/acm/request-certificate.rst new file mode 100644 index 00000000..26b2846b --- /dev/null +++ b/aws/dist/awscli/examples/acm/request-certificate.rst @@ -0,0 +1,33 @@ +**To request a new ACM certificate** + +The following ``request-certificate`` command requests a new certificate for the www.example.com domain using DNS validation:: + + aws acm request-certificate --domain-name www.example.com --validation-method DNS + +You can enter an idempotency token to distinguish between calls to ``request-certificate``:: + + aws acm request-certificate --domain-name www.example.com --validation-method DNS --idempotency-token 91adc45q + +You can enter one or more subject alternative names to request a certificate that will protect more than one apex domain:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.net + +You can enter an alternative name that can also be used to reach your website:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names www.example.com + +You can use an asterisk (*) as a wildcard to create a certificate for several subdomains in the same domain:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --idempotency-token 91adc45q --subject-alternative-names *.example.com + +You can also enter multiple alternative names:: + + aws acm request-certificate --domain-name example.com --validation-method DNS --subject-alternative-names b.example.com c.example.com d.example.com + +If you are using email for validation, you can enter domain validation options to specify the domain to which the validation email will be sent:: + + aws acm request-certificate --domain-name example.com --validation-method EMAIL --subject-alternative-names www.example.com --domain-validation-options DomainName=example.com,ValidationDomain=mail.example.com + +The following command opts out of certificate transparency logging when you request a new certificate:: + + aws acm request-certificate --domain-name www.example.com --validation-method DNS --certificate-options CertificateTransparencyLoggingPreference=DISABLED --idempotency-token 184627 diff --git a/aws/dist/awscli/examples/acm/resend-validation-email.rst b/aws/dist/awscli/examples/acm/resend-validation-email.rst new file mode 100644 index 00000000..c89c46ec --- /dev/null +++ b/aws/dist/awscli/examples/acm/resend-validation-email.rst @@ -0,0 +1,5 @@ +**To resend validation email for your ACM certificate request** + +The following ``resend-validation-email`` command tells the Amazon certificate authority to send validation email to the appropriate addresses:: + + aws acm resend-validation-email --certificate-arn arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012 --domain www.example.com --validation-domain example.com diff --git a/aws/dist/awscli/examples/acm/update-certificate-options.rst b/aws/dist/awscli/examples/acm/update-certificate-options.rst new file mode 100644 index 00000000..be048cf8 --- /dev/null +++ b/aws/dist/awscli/examples/acm/update-certificate-options.rst @@ -0,0 +1,6 @@ +**To update the certificate options** + +The following ``update-certificate-options`` command opts out of certificate transparency logging:: + + aws acm update-certificate-options --certificate-arn arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012 --options CertificateTransparencyLoggingPreference=DISABLED + diff --git a/aws/dist/awscli/examples/apigateway/create-api-key.rst b/aws/dist/awscli/examples/apigateway/create-api-key.rst new file mode 100644 index 00000000..de1d76a7 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-api-key.rst @@ -0,0 +1,5 @@ +**To create an API key that is enabled for an existing API and Stage** + +Command:: + + aws apigateway create-api-key --name 'Dev API Key' --description 'Used for development' --enabled --stage-keys restApiId='a1b2c3d4e5',stageName='dev' diff --git a/aws/dist/awscli/examples/apigateway/create-authorizer.rst b/aws/dist/awscli/examples/apigateway/create-authorizer.rst new file mode 100644 index 00000000..c65cb271 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-authorizer.rst @@ -0,0 +1,36 @@ +**To create a token based API Gateway Custom Authorizer for the API** + +Command:: + + aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Token_Custom_Authorizer' --type TOKEN --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations' --identity-source 'method.request.header.Authorization' --authorizer-result-ttl-in-seconds 300 + +Output:: + + { + "authType": "custom", + "name": "First_Token_Custom_Authorizer", + "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthFunction/invocations", + "authorizerResultTtlInSeconds": 300, + "identitySource": "method.request.header.Authorization", + "type": "TOKEN", + "id": "z40xj0" + } + +**To create a Cognito User Pools based API Gateway Custom Authorizer for the API** + +Command:: + + aws apigateway create-authorizer --rest-api-id 1234123412 --name 'First_Cognito_Custom_Authorizer' --type COGNITO_USER_POOLS --provider-arns 'arn:aws:cognito-idp:us-east-1:123412341234:userpool/us-east-1_aWcZeQbuD' --identity-source 'method.request.header.Authorization' + +Output:: + + { + "authType": "cognito_user_pools", + "identitySource": "method.request.header.Authorization", + "name": "First_Cognito_Custom_Authorizer", + "providerARNs": [ + "arn:aws:cognito-idp:us-east-1:342398297714:userpool/us-east-1_qWbZzQhzE" + ], + "type": "COGNITO_USER_POOLS", + "id": "5yid1t" + } diff --git a/aws/dist/awscli/examples/apigateway/create-base-path-mapping.rst b/aws/dist/awscli/examples/apigateway/create-base-path-mapping.rst new file mode 100644 index 00000000..93bbae18 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-base-path-mapping.rst @@ -0,0 +1,5 @@ +**To create the base path mapping for a custom domain name** + +Command:: + + aws apigateway create-base-path-mapping --domain-name subdomain.domain.tld --rest-api-id 1234123412 --stage prod --base-path v1 diff --git a/aws/dist/awscli/examples/apigateway/create-deployment.rst b/aws/dist/awscli/examples/apigateway/create-deployment.rst new file mode 100644 index 00000000..e451d195 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-deployment.rst @@ -0,0 +1,16 @@ +**To deploy the configured resources for an API to a new Stage** + +Command:: + + aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --stage-description 'Development Stage' --description 'First deployment to the dev stage' + +**To deploy the configured resources for an API to an existing stage** + +Command:: + + aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Second deployment to the dev stage' + +**To deploy the configured resources for an API to an existing stage with Stage Variables** + + aws apigateway create-deployment --rest-api-id 1234123412 --stage-name dev --description 'Third deployment to the dev stage' --variables key='value',otherKey='otherValue' + diff --git a/aws/dist/awscli/examples/apigateway/create-domain-name.rst b/aws/dist/awscli/examples/apigateway/create-domain-name.rst new file mode 100644 index 00000000..96f62d02 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-domain-name.rst @@ -0,0 +1,5 @@ +**To create the custom domain name** + +Command:: + + aws apigateway create-domain-name --domain-name 'my.domain.tld' --certificate-name 'my.domain.tld cert' --certificate-arn 'arn:aws:acm:us-east-1:012345678910:certificate/fb1b9770-a305-495d-aefb-27e5e101ff3' diff --git a/aws/dist/awscli/examples/apigateway/create-model.rst b/aws/dist/awscli/examples/apigateway/create-model.rst new file mode 100644 index 00000000..9723a53e --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-model.rst @@ -0,0 +1,15 @@ +**To create a model for an API** + +Command:: + + aws apigateway create-model --rest-api-id 1234123412 --name 'firstModel' --description 'The First Model' --content-type 'application/json' --schema '{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "firstModel", "type": "object", "properties": { "firstProperty" : { "type": "object", "properties": { "key": { "type": "string" } } } } }' + +Output:: + + { + "contentType": "application/json", + "description": "The First Model", + "name": "firstModel", + "id": "2rzg0l", + "schema": "{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\": \"firstModel\", \"type\": \"object\", \"properties\": { \"firstProperty\" : { \"type\": \"object\", \"properties\": { \"key\": { \"type\": \"string\" } } } } }" + } diff --git a/aws/dist/awscli/examples/apigateway/create-resource.rst b/aws/dist/awscli/examples/apigateway/create-resource.rst new file mode 100644 index 00000000..45dcbadc --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-resource.rst @@ -0,0 +1,5 @@ +**To create a resource in an API** + +Command:: + + aws apigateway create-resource --rest-api-id 1234123412 --parent-id a1b2c3 --path-part 'new-resource' diff --git a/aws/dist/awscli/examples/apigateway/create-rest-api.rst b/aws/dist/awscli/examples/apigateway/create-rest-api.rst new file mode 100644 index 00000000..14f845bd --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-rest-api.rst @@ -0,0 +1,11 @@ +**To create an API** + +Command:: + + aws apigateway create-rest-api --name 'My First API' --description 'This is my first API' + +**To create a duplicate API from an existing API** + +Command:: + + aws apigateway create-rest-api --name 'Copy of My First API' --description 'This is a copy of my first API' --clone-from 1234123412 diff --git a/aws/dist/awscli/examples/apigateway/create-stage.rst b/aws/dist/awscli/examples/apigateway/create-stage.rst new file mode 100644 index 00000000..ed3dcd7b --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-stage.rst @@ -0,0 +1,11 @@ +**To create a stage in an API which will contain an existing deployment** + +Command:: + + aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 + +**To create a stage in an API which will contain an existing deployment and custom Stage Variables** + +Command:: + + aws apigateway create-stage --rest-api-id 1234123412 --stage-name 'dev' --description 'Development stage' --deployment-id a1b2c3 --variables key='value',otherKey='otherValue' diff --git a/aws/dist/awscli/examples/apigateway/create-usage-plan-key.rst b/aws/dist/awscli/examples/apigateway/create-usage-plan-key.rst new file mode 100644 index 00000000..c515456a --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-usage-plan-key.rst @@ -0,0 +1,5 @@ +**Associate an existing API key with a Usage Plan** + +Command:: + + aws apigateway create-usage-plan-key --usage-plan-id a1b2c3 --key-type "API_KEY" --key-id 4vq3yryqm5 diff --git a/aws/dist/awscli/examples/apigateway/create-usage-plan.rst b/aws/dist/awscli/examples/apigateway/create-usage-plan.rst new file mode 100644 index 00000000..230baa16 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/create-usage-plan.rst @@ -0,0 +1,5 @@ +**To create a usage plan with throttle and quota limits that resets at the beginning of the month** + +Command:: + + aws apigateway create-usage-plan --name "New Usage Plan" --description "A new usage plan" --throttle burstLimit=10,rateLimit=5 --quota limit=500,offset=0,period=MONTH diff --git a/aws/dist/awscli/examples/apigateway/delete-api-key.rst b/aws/dist/awscli/examples/apigateway/delete-api-key.rst new file mode 100644 index 00000000..1b491f8f --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-api-key.rst @@ -0,0 +1,5 @@ +**To delete an API key** + +Command:: + + aws apigateway delete-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk diff --git a/aws/dist/awscli/examples/apigateway/delete-authorizer.rst b/aws/dist/awscli/examples/apigateway/delete-authorizer.rst new file mode 100644 index 00000000..391f1f83 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-authorizer.rst @@ -0,0 +1,5 @@ +**To delete a Custom Authorizer in an API** + +Command:: + + aws apigateway delete-authorizer --rest-api-id 1234123412 --authorizer-id 7gkfbo diff --git a/aws/dist/awscli/examples/apigateway/delete-base-path-mapping.rst b/aws/dist/awscli/examples/apigateway/delete-base-path-mapping.rst new file mode 100644 index 00000000..27d529e0 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-base-path-mapping.rst @@ -0,0 +1,5 @@ +**To delete a base path mapping for a custom domain name** + +Command:: + + aws apigateway delete-base-path-mapping --domain-name 'api.domain.tld' --base-path 'dev' diff --git a/aws/dist/awscli/examples/apigateway/delete-client-certificate.rst b/aws/dist/awscli/examples/apigateway/delete-client-certificate.rst new file mode 100644 index 00000000..5bfc9ba6 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-client-certificate.rst @@ -0,0 +1,5 @@ +**To delete a client certificate** + +Command:: + + aws apigateway delete-client-certificate --client-certificate-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/delete-deployment.rst b/aws/dist/awscli/examples/apigateway/delete-deployment.rst new file mode 100644 index 00000000..d33b2411 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-deployment.rst @@ -0,0 +1,5 @@ +**To delete a deployment in an API** + +Command:: + + aws apigateway delete-deployment --rest-api-id 1234123412 --deployment-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/delete-domain-name.rst b/aws/dist/awscli/examples/apigateway/delete-domain-name.rst new file mode 100644 index 00000000..33068d31 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-domain-name.rst @@ -0,0 +1,5 @@ +**To delete a custom domain name** + +Command:: + + aws apigateway delete-domain-name --domain-name 'api.domain.tld' diff --git a/aws/dist/awscli/examples/apigateway/delete-integration-response.rst b/aws/dist/awscli/examples/apigateway/delete-integration-response.rst new file mode 100644 index 00000000..ed010ef0 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-integration-response.rst @@ -0,0 +1,5 @@ +**To delete an integration response for a given resource, method, and status code in an API** + +Command:: + + aws apigateway delete-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 diff --git a/aws/dist/awscli/examples/apigateway/delete-integration.rst b/aws/dist/awscli/examples/apigateway/delete-integration.rst new file mode 100644 index 00000000..8c6253bf --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-integration.rst @@ -0,0 +1,5 @@ +**To delete an integration for a given resource and method in an API** + +Command:: + + aws apigateway delete-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET diff --git a/aws/dist/awscli/examples/apigateway/delete-method-response.rst b/aws/dist/awscli/examples/apigateway/delete-method-response.rst new file mode 100644 index 00000000..76242041 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-method-response.rst @@ -0,0 +1,5 @@ +**To delete a method response for the given resource, method, and status code in an API** + +Command:: + + aws apigateway delete-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 diff --git a/aws/dist/awscli/examples/apigateway/delete-method.rst b/aws/dist/awscli/examples/apigateway/delete-method.rst new file mode 100644 index 00000000..eb0e5263 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-method.rst @@ -0,0 +1,5 @@ +**To delete a method for the given resource in an API** + +Command:: + + aws apigateway delete-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET diff --git a/aws/dist/awscli/examples/apigateway/delete-model.rst b/aws/dist/awscli/examples/apigateway/delete-model.rst new file mode 100644 index 00000000..07f6eb0b --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-model.rst @@ -0,0 +1,5 @@ +**To delete a model in the given API** + +Command:: + + aws apigateway delete-model --rest-api-id 1234123412 --model-name 'customModel' diff --git a/aws/dist/awscli/examples/apigateway/delete-resource.rst b/aws/dist/awscli/examples/apigateway/delete-resource.rst new file mode 100644 index 00000000..eb89324a --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-resource.rst @@ -0,0 +1,5 @@ +**To delete a resource in an API** + +Command:: + + aws apigateway delete-resource --rest-api-id 1234123412 --resource-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/delete-rest-api.rst b/aws/dist/awscli/examples/apigateway/delete-rest-api.rst new file mode 100644 index 00000000..9febb362 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-rest-api.rst @@ -0,0 +1,5 @@ +**To delete an API** + +Command:: + + aws apigateway delete-rest-api --rest-api-id 1234123412 diff --git a/aws/dist/awscli/examples/apigateway/delete-stage.rst b/aws/dist/awscli/examples/apigateway/delete-stage.rst new file mode 100644 index 00000000..4f701b82 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-stage.rst @@ -0,0 +1,5 @@ +**To delete a stage in an API** + +Command:: + + aws apigateway delete-stage --rest-api-id 1234123412 --stage-name 'dev' diff --git a/aws/dist/awscli/examples/apigateway/delete-usage-plan-key.rst b/aws/dist/awscli/examples/apigateway/delete-usage-plan-key.rst new file mode 100644 index 00000000..37f7ab01 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-usage-plan-key.rst @@ -0,0 +1,5 @@ +**To remove an API key from a Usage Plan** + +Command:: + + aws apigateway delete-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu diff --git a/aws/dist/awscli/examples/apigateway/delete-usage-plan.rst b/aws/dist/awscli/examples/apigateway/delete-usage-plan.rst new file mode 100644 index 00000000..6ea501e8 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/delete-usage-plan.rst @@ -0,0 +1,5 @@ +**To delete a Usage Plan** + +Command:: + + aws apigateway delete-usage-plan --usage-plan-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/flush-stage-authorizers-cache.rst b/aws/dist/awscli/examples/apigateway/flush-stage-authorizers-cache.rst new file mode 100644 index 00000000..75c36cf3 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/flush-stage-authorizers-cache.rst @@ -0,0 +1,5 @@ +**To flush all authorizer cache entries on a stage** + +Command:: + + aws apigateway flush-stage-authorizers-cache --rest-api-id 1234123412 --stage-name dev diff --git a/aws/dist/awscli/examples/apigateway/flush-stage-cache.rst b/aws/dist/awscli/examples/apigateway/flush-stage-cache.rst new file mode 100644 index 00000000..3fdae727 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/flush-stage-cache.rst @@ -0,0 +1,5 @@ +**To flush the cache for an API's stage** + +Command:: + + aws apigateway flush-stage-cache --rest-api-id 1234123412 --stage-name dev diff --git a/aws/dist/awscli/examples/apigateway/generate-client-certificate.rst b/aws/dist/awscli/examples/apigateway/generate-client-certificate.rst new file mode 100644 index 00000000..11b7143d --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/generate-client-certificate.rst @@ -0,0 +1,5 @@ +**To create a Client-Side SSL Certificate** + +Command:: + + aws apigateway generate-client-certificate --description 'My First Client Certificate' diff --git a/aws/dist/awscli/examples/apigateway/get-account.rst b/aws/dist/awscli/examples/apigateway/get-account.rst new file mode 100644 index 00000000..ef8bd598 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-account.rst @@ -0,0 +1,15 @@ +**To get API Gateway account settings** + +Command:: + + aws apigateway get-account + +Output:: + + { + "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogsRole", + "throttleSettings": { + "rateLimit": 500.0, + "burstLimit": 1000 + } + } diff --git a/aws/dist/awscli/examples/apigateway/get-api-key.rst b/aws/dist/awscli/examples/apigateway/get-api-key.rst new file mode 100644 index 00000000..46e7323e --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-api-key.rst @@ -0,0 +1,20 @@ +**To get the information about a specific API key** + +Command:: + + aws apigateway get-api-key --api-key 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk + +Output:: + + { + "description": "My first key", + "enabled": true, + "stageKeys": [ + "a1b2c3d4e5/dev", + "e5d4c3b2a1/dev" + ], + "lastUpdatedDate": 1456184515, + "createdDate": 1456184452, + "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", + "name": "My key" + } diff --git a/aws/dist/awscli/examples/apigateway/get-api-keys.rst b/aws/dist/awscli/examples/apigateway/get-api-keys.rst new file mode 100644 index 00000000..7e12532a --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-api-keys.rst @@ -0,0 +1,24 @@ +**To get the list of API keys** + +Command:: + + aws apigateway get-api-keys + +Output:: + + { + "items": [ + { + "description": "My first key", + "enabled": true, + "stageKeys": [ + "a1b2c3d4e5/dev", + "e5d4c3b2a1/dev" + ], + "lastUpdatedDate": 1456184515, + "createdDate": 1456184452, + "id": "8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk", + "name": "My key" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-authorizer.rst b/aws/dist/awscli/examples/apigateway/get-authorizer.rst new file mode 100644 index 00000000..bb1b22e4 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-authorizer.rst @@ -0,0 +1,16 @@ +**To get the API Gateway per-API Authorizer settings** + +Command:: + + aws apigateway get-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 + +Output:: + + { + "authorizerResultTtlInSeconds": 300, + "name": "MyAuthorizer", + "type": "TOKEN", + "identitySource": "method.request.header.Authorization", + "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:authorizer_function/invocations", + "id": "gfi4n3" + } diff --git a/aws/dist/awscli/examples/apigateway/get-authorizers.rst b/aws/dist/awscli/examples/apigateway/get-authorizers.rst new file mode 100644 index 00000000..da061442 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-authorizers.rst @@ -0,0 +1,20 @@ +**To get the list of authorizers for a REST API** + +Command:: + + aws apigateway get-authorizers --rest-api-id 1234123412 + +Output:: + + { + "items": [ + { + "name": "MyAuthorizer", + "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Authorizer_Function/invocations", + "authorizerResultTtlInSeconds": 300, + "identitySource": "method.request.header.Authorization", + "type": "TOKEN", + "id": "gfi4n3" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-base-path-mapping.rst b/aws/dist/awscli/examples/apigateway/get-base-path-mapping.rst new file mode 100644 index 00000000..bd507ecf --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-base-path-mapping.rst @@ -0,0 +1,13 @@ +**To get the base path mapping for a custom domain name** + +Command:: + + aws apigateway get-base-path-mapping --domain-name subdomain.domain.tld --base-path v1 + +Output:: + + { + "basePath": "v1", + "restApiId": "1234w4321e", + "stage": "api" + } diff --git a/aws/dist/awscli/examples/apigateway/get-base-path-mappings.rst b/aws/dist/awscli/examples/apigateway/get-base-path-mappings.rst new file mode 100644 index 00000000..be79d958 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-base-path-mappings.rst @@ -0,0 +1,22 @@ +**To get the base path mappings for a custom domain name** + +Command:: + + aws apigateway get-base-path-mappings --domain-name subdomain.domain.tld + +Output:: + + { + "items": [ + { + "basePath": "(none)", + "restApiId": "1234w4321e", + "stage": "dev" + }, + { + "basePath": "v1", + "restApiId": "1234w4321e", + "stage": "api" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-client-certificate.rst b/aws/dist/awscli/examples/apigateway/get-client-certificate.rst new file mode 100644 index 00000000..027fbdd4 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-client-certificate.rst @@ -0,0 +1,5 @@ +**To get a client certificate** + +Command:: + + aws apigateway get-client-certificate --client-certificate-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/get-client-certificates.rst b/aws/dist/awscli/examples/apigateway/get-client-certificates.rst new file mode 100644 index 00000000..579f3e99 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-client-certificates.rst @@ -0,0 +1,20 @@ +**To get a list of client certificates** + +Command:: + + aws apigateway get-client-certificates + +Output:: + + { + "items": [ + { + "pemEncodedCertificate": "-----BEGIN CERTIFICATE----- -----END CERTIFICATE-----", + "clientCertificateId": "a1b2c3", + "expirationDate": 1483556561, + "description": "My Client Certificate", + "createdDate": 1452020561 + } + ] + } + diff --git a/aws/dist/awscli/examples/apigateway/get-deployment.rst b/aws/dist/awscli/examples/apigateway/get-deployment.rst new file mode 100644 index 00000000..8b5f431e --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-deployment.rst @@ -0,0 +1,13 @@ +**To get information about a deployment** + +Command:: + + aws apigateway get-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 + +Output:: + + { + "description": "myDeployment", + "id": "ztt4m2", + "createdDate": 1455218022 + } diff --git a/aws/dist/awscli/examples/apigateway/get-deployments.rst b/aws/dist/awscli/examples/apigateway/get-deployments.rst new file mode 100644 index 00000000..22881ffc --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-deployments.rst @@ -0,0 +1,18 @@ +**To get a list of deployments for a REST API** + +Command:: + + aws apigateway get-deployments --rest-api-id 1234123412 + +Output:: + + { + "items": [ + { + "createdDate": 1453797217, + "id": "0a2b4c", + "description": "Deployed my API for the first time" + } + ] + } + diff --git a/aws/dist/awscli/examples/apigateway/get-domain-name.rst b/aws/dist/awscli/examples/apigateway/get-domain-name.rst new file mode 100644 index 00000000..ac87fd04 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-domain-name.rst @@ -0,0 +1,14 @@ +**To get information about a custom domain name** + +Command:: + + aws apigateway get-domain-name --domain-name api.domain.tld + +Output:: + + { + "domainName": "api.domain.tld", + "distributionDomainName": "d1a2f3a4c5o6d.cloudfront.net", + "certificateName": "uploadedCertificate", + "certificateUploadDate": 1462565487 + } diff --git a/aws/dist/awscli/examples/apigateway/get-domain-names.rst b/aws/dist/awscli/examples/apigateway/get-domain-names.rst new file mode 100644 index 00000000..b3d2b4a3 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-domain-names.rst @@ -0,0 +1,18 @@ +**To get a list of custom domain names** + +Command:: + + aws apigateway get-domain-names + +Output:: + + { + "items": [ + { + "distributionDomainName": "d9511k3l09bkd.cloudfront.net", + "certificateUploadDate": 1452812505, + "certificateName": "my_custom_domain-certificate", + "domainName": "subdomain.domain.tld" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-export.rst b/aws/dist/awscli/examples/apigateway/get-export.rst new file mode 100644 index 00000000..55742402 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-export.rst @@ -0,0 +1,18 @@ +**To get the JSON Swagger template for a stage** + +Command:: + + aws apigateway get-export --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json + +**To get the JSON Swagger template + API Gateway Extentions for a stage** + +Command:: + + aws apigateway get-export --parameters extensions='integrations' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json + +**To get the JSON Swagger template + Postman Extensions for a stage** + +Command:: + + aws apigateway get-export --parameters extensions='postman' --rest-api-id a1b2c3d4e5 --stage-name dev --export-type swagger /path/to/filename.json + diff --git a/aws/dist/awscli/examples/apigateway/get-integration-response.rst b/aws/dist/awscli/examples/apigateway/get-integration-response.rst new file mode 100644 index 00000000..9947e519 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-integration-response.rst @@ -0,0 +1,15 @@ +**To get the integration response configuration for a HTTP method defined under a REST API's resource** + +Command:: + + aws apigateway get-integration-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 + +Output:: + + { + "statusCode": "200", + "responseTemplates": { + "application/json": null + } + } + diff --git a/aws/dist/awscli/examples/apigateway/get-integration.rst b/aws/dist/awscli/examples/apigateway/get-integration.rst new file mode 100644 index 00000000..686baeb2 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-integration.rst @@ -0,0 +1,24 @@ +**To get the integration configuration for a HTTP method defined under a REST API's resource** + +Command:: + + aws apigateway get-integration --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET + +Output:: + + { + "httpMethod": "POST", + "integrationResponses": { + "200": { + "responseTemplates": { + "application/json": null + }, + "statusCode": "200" + } + }, + "cacheKeyParameters": [], + "type": "AWS", + "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations", + "cacheNamespace": "y9h6rt" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-method-response.rst b/aws/dist/awscli/examples/apigateway/get-method-response.rst new file mode 100644 index 00000000..aa3283d8 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-method-response.rst @@ -0,0 +1,15 @@ +**To get the method response resource configuration for a HTTP method defined under a REST API's resource** + +Command:: + + aws apigateway get-method-response --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET --status-code 200 + +Output:: + + { + "responseModels": { + "application/json": "Empty" + }, + "statusCode": "200" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-method.rst b/aws/dist/awscli/examples/apigateway/get-method.rst new file mode 100644 index 00000000..7aee2757 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-method.rst @@ -0,0 +1,38 @@ +**To get the method resource configuration for a HTTP method defined under a REST API's resource** + +Command:: + + aws apigateway get-method --rest-api-id 1234123412 --resource-id y9h6rt --http-method GET + +Output:: + + { + "apiKeyRequired": false, + "httpMethod": "GET", + "methodIntegration": { + "integrationResponses": { + "200": { + "responseTemplates": { + "application/json": null + }, + "statusCode": "200" + } + }, + "cacheKeyParameters": [], + "uri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:My_Function/invocations", + "httpMethod": "POST", + "cacheNamespace": "y9h6rt", + "type": "AWS" + }, + "requestParameters": {}, + "methodResponses": { + "200": { + "responseModels": { + "application/json": "Empty" + }, + "statusCode": "200" + } + }, + "authorizationType": "NONE" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-model-template.rst b/aws/dist/awscli/examples/apigateway/get-model-template.rst new file mode 100644 index 00000000..9b5093be --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-model-template.rst @@ -0,0 +1,12 @@ +**To get the mapping template for a model defined under a REST API** + +Command:: + + aws apigateway get-model-template --rest-api-id 1234123412 --model-name Empty + +Output:: + + { + "value": "#set($inputRoot = $input.path('$'))\n{ }" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-model.rst b/aws/dist/awscli/examples/apigateway/get-model.rst new file mode 100644 index 00000000..2008e9b9 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-model.rst @@ -0,0 +1,16 @@ +**To get the configuration for a model defined under a REST API** + +Command:: + + aws apigateway get-model --rest-api-id 1234123412 --model-name Empty + +Output:: + + { + "contentType": "application/json", + "description": "This is a default empty schema model", + "name": "Empty", + "id": "etd5w5", + "schema": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-models.rst b/aws/dist/awscli/examples/apigateway/get-models.rst new file mode 100644 index 00000000..8f011d3e --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-models.rst @@ -0,0 +1,26 @@ +**To get a list of models for a REST API** + +Command:: + + aws apigateway get-models --rest-api-id 1234123412 + +Output:: + + { + "items": [ + { + "description": "This is a default error schema model", + "schema": "{\n \"$schema\" : \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Error Schema\",\n \"type\" : \"object\",\n \"properties\" : {\n \"message\" : { \"type\" : \"string\" }\n }\n}", + "contentType": "application/json", + "id": "7tpbze", + "name": "Error" + }, + { + "description": "This is a default empty schema model", + "schema": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"title\" : \"Empty Schema\",\n \"type\" : \"object\"\n}", + "contentType": "application/json", + "id": "etd5w5", + "name": "Empty" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-resource.rst b/aws/dist/awscli/examples/apigateway/get-resource.rst new file mode 100644 index 00000000..2584bec2 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-resource.rst @@ -0,0 +1,14 @@ +**To get information about a resource** + +Command:: + + aws apigateway get-resource --rest-api-id 1234123412 --resource-id zwo0y3 + +Output:: + + { + "path": "/path", + "pathPart": "path", + "id": "zwo0y3", + "parentId": "uyokt6ij2g" + } diff --git a/aws/dist/awscli/examples/apigateway/get-resources.rst b/aws/dist/awscli/examples/apigateway/get-resources.rst new file mode 100644 index 00000000..ad016cf8 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-resources.rst @@ -0,0 +1,21 @@ +**To get a list of resources for a REST API** + +Command:: + + aws apigateway get-resources --rest-api-id 1234123412 + +Output:: + + { + "items": [ + { + "path": "/resource/subresource", + "resourceMethods": { + "POST": {} + }, + "id": "024ace", + "pathPart": "subresource", + "parentId": "ai5b02" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-rest-api.rst b/aws/dist/awscli/examples/apigateway/get-rest-api.rst new file mode 100644 index 00000000..6f1ffcdb --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-rest-api.rst @@ -0,0 +1,13 @@ +**To get information about an API** + +Command:: + + aws apigateway get-rest-api --rest-api-id 1234123412 + +Output:: + + { + "name": "myAPI", + "id": "o1y243m4f5", + "createdDate": 1453416433 + } diff --git a/aws/dist/awscli/examples/apigateway/get-rest-apis.rst b/aws/dist/awscli/examples/apigateway/get-rest-apis.rst new file mode 100644 index 00000000..e33e9fd0 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-rest-apis.rst @@ -0,0 +1,17 @@ +**To get a list of REST APIs** + +Command:: + + aws apigateway get-rest-apis + +Output:: + + { + "items": [ + { + "createdDate": 1438884790, + "id": "12s44z21rb", + "name": "My First API" + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-sdk.rst b/aws/dist/awscli/examples/apigateway/get-sdk.rst new file mode 100644 index 00000000..ace55b83 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-sdk.rst @@ -0,0 +1,39 @@ +**To get the Android SDK for a REST API stage** + +Command:: + + aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip + +Output:: + + { + "contentType": "application/octet-stream", + "contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\"" + } + +**To get the IOS SDK for a REST API stage** + +Command:: + + aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip + +Output:: + + { + "contentType": "application/octet-stream", + "contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\"" + } + +**To get the Javascript SDK for a REST API stage** + +Command:: + + aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip + +Output:: + + { + "contentType": "application/octet-stream", + "contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\"" + } + diff --git a/aws/dist/awscli/examples/apigateway/get-stage.rst b/aws/dist/awscli/examples/apigateway/get-stage.rst new file mode 100644 index 00000000..29d363ef --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-stage.rst @@ -0,0 +1,43 @@ +**To get information about an API's stage** + +Command:: + + aws apigateway get-stage --rest-api-id 1234123412 --stage-name dev + +Output:: + + { + "stageName": "dev", + "cacheClusterSize": "0.5", + "cacheClusterEnabled": false, + "cacheClusterStatus": "NOT_AVAILABLE", + "deploymentId": "rbh1fj", + "lastUpdatedDate": 1466802961, + "createdDate": 1460682074, + "methodSettings": { + "*/*": { + "cacheTtlInSeconds": 300, + "loggingLevel": "INFO", + "dataTraceEnabled": false, + "metricsEnabled": true, + "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", + "throttlingRateLimit": 500.0, + "cacheDataEncrypted": false, + "cachingEnabled": false, + "throttlingBurstLimit": 1000, + "requireAuthorizationForCacheControl": true + }, + "~1resource/GET": { + "cacheTtlInSeconds": 300, + "loggingLevel": "INFO", + "dataTraceEnabled": false, + "metricsEnabled": true, + "unauthorizedCacheControlHeaderStrategy": "SUCCEED_WITH_RESPONSE_HEADER", + "throttlingRateLimit": 500.0, + "cacheDataEncrypted": false, + "cachingEnabled": false, + "throttlingBurstLimit": 1000, + "requireAuthorizationForCacheControl": true + } + } + } diff --git a/aws/dist/awscli/examples/apigateway/get-stages.rst b/aws/dist/awscli/examples/apigateway/get-stages.rst new file mode 100644 index 00000000..dac5ce26 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-stages.rst @@ -0,0 +1,33 @@ +**To get the list of stages for a REST API** + +Command:: + + aws apigateway get-stages --rest-api-id 1234123412 + +Output:: + + { + "item": [ + { + "stageName": "dev", + "cacheClusterSize": "0.5", + "cacheClusterEnabled": true, + "cacheClusterStatus": "AVAILABLE", + "deploymentId": "123h64", + "lastUpdatedDate": 1456185138, + "createdDate": 1453589092, + "methodSettings": { + "~1resource~1subresource/POST": { + "cacheTtlInSeconds": 300, + "loggingLevel": "INFO", + "dataTraceEnabled": true, + "metricsEnabled": true, + "throttlingRateLimit": 500.0, + "cacheDataEncrypted": false, + "cachingEnabled": false, + "throttlingBurstLimit": 1000 + } + } + } + ] + } diff --git a/aws/dist/awscli/examples/apigateway/get-usage-plan-key.rst b/aws/dist/awscli/examples/apigateway/get-usage-plan-key.rst new file mode 100644 index 00000000..e5cf88be --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-usage-plan-key.rst @@ -0,0 +1,5 @@ +**To get the details of an API key associated with a Usage Plan** + +Command:: + + aws apigateway get-usage-plan-key --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu diff --git a/aws/dist/awscli/examples/apigateway/get-usage-plan-keys.rst b/aws/dist/awscli/examples/apigateway/get-usage-plan-keys.rst new file mode 100644 index 00000000..39820304 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-usage-plan-keys.rst @@ -0,0 +1,5 @@ +**To get the list of API keys associated with a Usage Plan** + +Command:: + + aws apigateway get-usage-plan-keys --usage-plan-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/get-usage-plan.rst b/aws/dist/awscli/examples/apigateway/get-usage-plan.rst new file mode 100644 index 00000000..2c662a5c --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-usage-plan.rst @@ -0,0 +1,5 @@ +**To get the details of a Usage Plan** + +Command:: + + aws apigateway get-usage-plan --usage-plan-id a1b2c3 diff --git a/aws/dist/awscli/examples/apigateway/get-usage-plans.rst b/aws/dist/awscli/examples/apigateway/get-usage-plans.rst new file mode 100644 index 00000000..6bd34385 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-usage-plans.rst @@ -0,0 +1,5 @@ +**To get the details of all Usage Plans** + +Command:: + + aws apigateway get-usage-plans diff --git a/aws/dist/awscli/examples/apigateway/get-usage.rst b/aws/dist/awscli/examples/apigateway/get-usage.rst new file mode 100644 index 00000000..fd2fb8f4 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/get-usage.rst @@ -0,0 +1,5 @@ +**To get the usage details for a Usage Plan** + +Command:: + + aws apigateway get-usage --usage-plan-id a1b2c3 --start-date "2016-08-16" --end-date "2016-08-17" diff --git a/aws/dist/awscli/examples/apigateway/import-rest-api.rst b/aws/dist/awscli/examples/apigateway/import-rest-api.rst new file mode 100644 index 00000000..74f163a3 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/import-rest-api.rst @@ -0,0 +1,5 @@ +**To import a Swagger template and create an API** + +Command:: + + aws apigateway import-rest-api --body 'file:///path/to/API_Swagger_template.json' diff --git a/aws/dist/awscli/examples/apigateway/put-integration-response.rst b/aws/dist/awscli/examples/apigateway/put-integration-response.rst new file mode 100644 index 00000000..b179587d --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/put-integration-response.rst @@ -0,0 +1,11 @@ +**To create an integration response as the default response with a mapping template defined** + +Command:: + + aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --selection-pattern "" --response-templates '{"application/json": "{\"json\": \"template\"}"}' + +**To create an integration response with a regex of 400 and a statically defined header value** + +Command:: + + aws apigateway put-integration-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --selection-pattern 400 --response-parameters '{"method.response.header.custom-header": "'"'"'custom-value'"'"'"}' diff --git a/aws/dist/awscli/examples/apigateway/put-integration.rst b/aws/dist/awscli/examples/apigateway/put-integration.rst new file mode 100644 index 00000000..a29f6000 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/put-integration.rst @@ -0,0 +1,17 @@ +**To create a MOCK integration request** + +Command:: + + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type MOCK --request-templates '{ "application/json": "{\"statusCode\": 200}" }' + +**To create a HTTP integration request** + +Command:: + + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type HTTP --integration-http-method GET --uri 'https://domain.tld/path' + +**To create an AWS integration request with a Lambda Function endpoint** + +Command:: + + aws apigateway put-integration --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --type AWS --integration-http-method POST --uri 'arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:function_name/invocations' diff --git a/aws/dist/awscli/examples/apigateway/put-method-response.rst b/aws/dist/awscli/examples/apigateway/put-method-response.rst new file mode 100644 index 00000000..9f51a63b --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/put-method-response.rst @@ -0,0 +1,5 @@ +**To create a method response under the specified status code with a custom method response header** + +Command:: + + aws apigateway put-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 400 --response-parameters "method.response.header.custom-header=false" diff --git a/aws/dist/awscli/examples/apigateway/put-method.rst b/aws/dist/awscli/examples/apigateway/put-method.rst new file mode 100644 index 00000000..dbe2e02c --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/put-method.rst @@ -0,0 +1,5 @@ +**To create a method for a resource in an API with no authorization, no API key, and a custom method request header** + +Command:: + + aws apigateway put-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method PUT --authorization-type "NONE" --no-api-key-required --request-parameters "method.request.header.custom-header=false" diff --git a/aws/dist/awscli/examples/apigateway/put-rest-api.rst b/aws/dist/awscli/examples/apigateway/put-rest-api.rst new file mode 100644 index 00000000..ea373f63 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/put-rest-api.rst @@ -0,0 +1,11 @@ +**To overwrite an existing API using a Swagger template** + +Command:: + + aws apigateway put-rest-api --rest-api-id 1234123412 --mode overwrite --body 'file:///path/to/API_Swagger_template.json' + +**To merge a Swagger template into an existing API** + +Command:: + + aws apigateway put-rest-api --rest-api-id 1234123412 --mode merge --body 'file:///path/to/API_Swagger_template.json' diff --git a/aws/dist/awscli/examples/apigateway/test-invoke-authorizer.rst b/aws/dist/awscli/examples/apigateway/test-invoke-authorizer.rst new file mode 100644 index 00000000..476f65b9 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/test-invoke-authorizer.rst @@ -0,0 +1,5 @@ +**To test invoke a request to a Custom Authorizer including the required header and value** + +Command:: + + aws apigateway test-invoke-authorizer --rest-api-id 1234123412 --authorizer-id 5yid1t --headers Authorization='Value' diff --git a/aws/dist/awscli/examples/apigateway/test-invoke-method.rst b/aws/dist/awscli/examples/apigateway/test-invoke-method.rst new file mode 100644 index 00000000..499e275a --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/test-invoke-method.rst @@ -0,0 +1,11 @@ +**To test invoke the root resource in an API by making a GET request** + +Command:: + + aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id avl5sg8fw8 --http-method GET --path-with-query-string '/' + +**To test invoke a sub-resource in an API by making a GET request with a path parameter value specified** + +Command:: + + aws apigateway test-invoke-method --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --path-with-query-string '/pets/1' diff --git a/aws/dist/awscli/examples/apigateway/update-account.rst b/aws/dist/awscli/examples/apigateway/update-account.rst new file mode 100644 index 00000000..fa2a5800 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-account.rst @@ -0,0 +1,15 @@ +**To change the IAM Role ARN for logging to CloudWatch Logs** + +Command:: + + aws apigateway update-account --patch-operations op='replace',path='/cloudwatchRoleArn',value='arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs' + +Output:: + + { + "cloudwatchRoleArn": "arn:aws:iam::123412341234:role/APIGatewayToCloudWatchLogs", + "throttleSettings": { + "rateLimit": 1000.0, + "burstLimit": 2000 + } + } diff --git a/aws/dist/awscli/examples/apigateway/update-api-key.rst b/aws/dist/awscli/examples/apigateway/update-api-key.rst new file mode 100644 index 00000000..ea97f897 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-api-key.rst @@ -0,0 +1,39 @@ +**To change the name for an API Key** + +Command:: + + aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/description',value='newName' + +Output:: + + { + "description": "currentDescription", + "enabled": true, + "stageKeys": [ + "41t2j324r5/dev" + ], + "lastUpdatedDate": 1470086052, + "createdDate": 1445460347, + "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", + "name": "newName" + } + +**To disable the API Key** + +Command:: + + aws apigateway update-api-key --api-key sNvjQDMReA1eEQPNAW8r37XsU2rDD7fc7m2SiMnu --patch-operations op='replace',path='/enabled',value='false' + +Output:: + + { + "description": "currentDescription", + "enabled": false, + "stageKeys": [ + "41t2j324r5/dev" + ], + "lastUpdatedDate": 1470086052, + "createdDate": 1445460347, + "id": "sNvjQDMReA1vEQPNzW8r3dXsU2rrD7fcjm2SiMnu", + "name": "newName" + } diff --git a/aws/dist/awscli/examples/apigateway/update-authorizer.rst b/aws/dist/awscli/examples/apigateway/update-authorizer.rst new file mode 100644 index 00000000..2acb8278 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-authorizer.rst @@ -0,0 +1,35 @@ +**To change the name of the Custom Authorizer** + +Command:: + + aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/name',value='testAuthorizer' + +Output:: + + { + "authType": "custom", + "name": "testAuthorizer", + "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:customAuthorizer/invocations", + "authorizerResultTtlInSeconds": 300, + "identitySource": "method.request.header.Authorization", + "type": "TOKEN", + "id": "gfi4n3" + } + +**To change the Lambda Function that is invoked by the Custom Authorizer** + +Command:: + + aws apigateway update-authorizer --rest-api-id 1234123412 --authorizer-id gfi4n3 --patch-operations op='replace',path='/authorizerUri',value='arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations' + +Output:: + + { + "authType": "custom", + "name": "testAuthorizer", + "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123412341234:function:newAuthorizer/invocations", + "authorizerResultTtlInSeconds": 300, + "identitySource": "method.request.header.Authorization", + "type": "TOKEN", + "id": "gfi4n3" + } diff --git a/aws/dist/awscli/examples/apigateway/update-base-path-mapping.rst b/aws/dist/awscli/examples/apigateway/update-base-path-mapping.rst new file mode 100644 index 00000000..42097dec --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-base-path-mapping.rst @@ -0,0 +1,13 @@ +**To change the base path for a custom domain name** + +Command:: + + aws apigateway update-base-path-mapping --domain-name api.domain.tld --base-path prod --patch-operations op='replace',path='/basePath',value='v1' + +Output:: + + { + "basePath": "v1", + "restApiId": "1234123412", + "stage": "api" + } diff --git a/aws/dist/awscli/examples/apigateway/update-client-certificate.rst b/aws/dist/awscli/examples/apigateway/update-client-certificate.rst new file mode 100644 index 00000000..922bd02c --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-client-certificate.rst @@ -0,0 +1,5 @@ +**To update the description of a client certificate** + +Command:: + + aws apigateway update-client-certificate --client-certificate-id a1b2c3 --patch-operations op='replace',path='/description',value='My new description' diff --git a/aws/dist/awscli/examples/apigateway/update-deployment.rst b/aws/dist/awscli/examples/apigateway/update-deployment.rst new file mode 100644 index 00000000..bcb418a2 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-deployment.rst @@ -0,0 +1,14 @@ +**To change the description of a deployment** + +Command:: + + aws apigateway update-deployment --rest-api-id 1234123412 --deployment-id ztt4m2 --patch-operations op='replace',path='/description',value='newDescription' + +Output:: + + { + "description": "newDescription", + "id": "ztt4m2", + "createdDate": 1455218022 + } + diff --git a/aws/dist/awscli/examples/apigateway/update-domain-name.rst b/aws/dist/awscli/examples/apigateway/update-domain-name.rst new file mode 100644 index 00000000..bf6adcd0 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-domain-name.rst @@ -0,0 +1,18 @@ +**To change the certificate name for a custom domain name** + +The following ``update-domain-name`` example changes the certificate name for a custom domain. :: + + aws apigateway update-domain-name \ + --domain-name api.domain.tld \ + --patch-operations op='replace',path='/certificateArn',value='arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE' + +Output:: + + { + "domainName": "api.domain.tld", + "distributionDomainName": "d123456789012.cloudfront.net", + "certificateArn": "arn:aws:acm:us-west-2:111122223333:certificate/CERTEXAMPLE123EXAMPLE", + "certificateUploadDate": 1462565487 + } + +For more information, see `Set up Custom Domain Name for an API in API Gateway `_ in the *Amazon API Gateway Developer Guide*. diff --git a/aws/dist/awscli/examples/apigateway/update-integration-response.rst b/aws/dist/awscli/examples/apigateway/update-integration-response.rst new file mode 100644 index 00000000..9096fe15 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-integration-response.rst @@ -0,0 +1,21 @@ +**To change an integration response header to have a static mapping of '*'** + +Command:: + + aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='replace',path='/responseParameters/method.response.header.Access-Control-Allow-Origin',value='"'"'*'"'"' + +Output:: + + { + "statusCode": "200", + "responseParameters": { + "method.response.header.Access-Control-Allow-Origin": "'*'" + } + } + +**To remove an integration response header** + +Command:: + + aws apigateway update-integration-response --rest-api-id 1234123412 --resource-id 3gapai --http-method GET --status-code 200 --patch-operations op='remove',path='/responseParameters/method.response.header.Access-Control-Allow-Origin' + diff --git a/aws/dist/awscli/examples/apigateway/update-integration.rst b/aws/dist/awscli/examples/apigateway/update-integration.rst new file mode 100644 index 00000000..451f965c --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-integration.rst @@ -0,0 +1,24 @@ +**To add the 'Content-Type: application/json' Mapping Template configured with Input Passthrough** + +Command:: + + aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='add',path='/requestTemplates/application~1json' + +**To update (replace) the 'Content-Type: application/json' Mapping Template configured with a custom template** + +Command:: + + aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='replace',path='/requestTemplates/application~1json',value='{"example": "json"}' + +**To update (replace) a custom template associated with 'Content-Type: application/json' with Input Passthrough** + +Command:: + + aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='replace',path='requestTemplates/application~1json' + +**To remove the 'Content-Type: application/json' Mapping Template** + +Command:: + + aws apigateway update-integration --rest-api-id a1b2c3d4e5 --resource-id a1b2c3 --http-method POST --patch-operations op='remove',path='/requestTemplates/application~1json' + diff --git a/aws/dist/awscli/examples/apigateway/update-method-response.rst b/aws/dist/awscli/examples/apigateway/update-method-response.rst new file mode 100644 index 00000000..4d966c0e --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-method-response.rst @@ -0,0 +1,11 @@ +**To create a new method response header for the 200 response in a method and define it as not required (default)** + +Command:: + + aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="add",path="/responseParameters/method.response.header.custom-header",value="false" + +**To delete a response model for the 200 response in a method** + +Command:: + + aws apigateway update-method-response --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --status-code 200 --patch-operations op="remove",path="/responseModels/application~1json" diff --git a/aws/dist/awscli/examples/apigateway/update-method.rst b/aws/dist/awscli/examples/apigateway/update-method.rst new file mode 100644 index 00000000..743c51d7 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-method.rst @@ -0,0 +1,11 @@ +**To modify a method to require an API Key** + +Command:: + + aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/apiKeyRequired",value="true" + +**To modify a method to require IAM Authorization** + +Command:: + + aws apigateway update-method --rest-api-id 1234123412 --resource-id a1b2c3 --http-method GET --patch-operations op="replace",path="/authorizationType",value="AWS_IAM" diff --git a/aws/dist/awscli/examples/apigateway/update-model.rst b/aws/dist/awscli/examples/apigateway/update-model.rst new file mode 100644 index 00000000..60aed46f --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-model.rst @@ -0,0 +1,11 @@ +**To change the description of a model in an API** + +Command:: + + aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/description,value='New Description' + +**To change the schema of a model in an API** + +Command:: + + aws apigateway update-model --rest-api-id 1234123412 --model-name 'Empty' --patch-operations op=replace,path=/schema,value='"{ \"$schema\": \"http://json-schema.org/draft-04/schema#\", \"title\" : \"Empty Schema\", \"type\" : \"object\" }"' diff --git a/aws/dist/awscli/examples/apigateway/update-resource.rst b/aws/dist/awscli/examples/apigateway/update-resource.rst new file mode 100644 index 00000000..452bdf51 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-resource.rst @@ -0,0 +1,29 @@ +**To move a resource and place it under a different parent resource in an API** + +Command:: + + aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/parentId,value='3c2b1a' + +Output:: + + { + "path": "/resource", + "pathPart": "resource", + "id": "1a2b3c", + "parentId": "3c2b1a" + } + +**To rename a resource (pathPart) in an API** + +Command:: + + aws apigateway update-resource --rest-api-id 1234123412 --resource-id 1a2b3c --patch-operations op=replace,path=/pathPart,value=newresourcename + +Output:: + + { + "path": "/newresourcename", + "pathPart": "newresourcename", + "id": "1a2b3c", + "parentId": "3c2b1a" + } diff --git a/aws/dist/awscli/examples/apigateway/update-rest-api.rst b/aws/dist/awscli/examples/apigateway/update-rest-api.rst new file mode 100644 index 00000000..5beab5b3 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-rest-api.rst @@ -0,0 +1,11 @@ +**To change the name of an API** + +Command:: + + aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/name,value='New Name' + +**To change the description of an API** + +Command:: + + aws apigateway update-rest-api --rest-api-id 1234123412 --patch-operations op=replace,path=/description,value='New Description' diff --git a/aws/dist/awscli/examples/apigateway/update-stage.rst b/aws/dist/awscli/examples/apigateway/update-stage.rst new file mode 100644 index 00000000..c4ae8a01 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-stage.rst @@ -0,0 +1,11 @@ +**To override the stage settings and disable full request/response logging for a specific resource and method in an API's stage** + +Command:: + + aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/~1resourceName/GET/logging/dataTrace,value=false + +**To enable full request/response logging for all resources/methods in an API's stage** + +Command:: + + aws apigateway update-stage --rest-api-id 1234123412 --stage-name 'dev' --patch-operations op=replace,path=/*/*/logging/dataTrace,value=true diff --git a/aws/dist/awscli/examples/apigateway/update-usage-plan.rst b/aws/dist/awscli/examples/apigateway/update-usage-plan.rst new file mode 100644 index 00000000..f11c03ec --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-usage-plan.rst @@ -0,0 +1,23 @@ +**To change the period defined in a Usage Plan** + +Command:: + + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/period",value="MONTH" + +**To change the quota limit defined in a Usage Plan** + +Command:: + + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/quota/limit",value="500" + +**To change the throttle rate limit defined in a Usage Plan** + +Command:: + + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/rateLimit",value="10" + +**To change the throttle burst limit defined in a Usage Plan** + +Command:: + + aws apigateway update-usage-plan --usage-plan-id a1b2c3 --patch-operations op="replace",path="/throttle/burstLimit",value="20" diff --git a/aws/dist/awscli/examples/apigateway/update-usage.rst b/aws/dist/awscli/examples/apigateway/update-usage.rst new file mode 100644 index 00000000..b6b549c0 --- /dev/null +++ b/aws/dist/awscli/examples/apigateway/update-usage.rst @@ -0,0 +1,5 @@ +**To temporarily modify the quota on an API key for the current period defined in the Usage Plan** + +Command:: + + aws apigateway update-usage --usage-plan-id a1b2c3 --key-id 1NbjQzMReAkeEQPNAW8r3dXsU2rDD7fc7f2Sipnu --patch-operations op="replace",path="/remaining",value="50" diff --git a/aws/dist/awscli/examples/apigatewayv2/create-api.rst b/aws/dist/awscli/examples/apigatewayv2/create-api.rst new file mode 100644 index 00000000..f94755fd --- /dev/null +++ b/aws/dist/awscli/examples/apigatewayv2/create-api.rst @@ -0,0 +1,21 @@ +**To create a WebSocket API** + +The following ``create-api`` example creates a WebSocket API with the specified name. :: + + aws apigatewayv2 create-api \ + --name "myWebSocketApi" \ + --protocol-type WEBSOCKET \ + --route-selection-expression '$request.body.action' + +Output:: + + { + "ApiKeySelectionExpression": "$request.header.x-api-key", + "Name": "myWebSocketApi", + "CreatedDate": "2018-11-15T06:23:51Z", + "ProtocolType": "WEBSOCKET", + "RouteSelectionExpression": "'$request.body.action'", + "ApiId": "aabbccddee" + } + +For more information, see `Create a WebSocket API in API Gateway `_ in the *Amazon API Gateway Developer Guide*. diff --git a/aws/dist/awscli/examples/apigatewayv2/create-integration.rst b/aws/dist/awscli/examples/apigatewayv2/create-integration.rst new file mode 100644 index 00000000..9dcfc5dc --- /dev/null +++ b/aws/dist/awscli/examples/apigatewayv2/create-integration.rst @@ -0,0 +1,27 @@ +**To create a WebSocket API Integration Request** + +The following ``create-integration`` requests an integration for a WebSocket API. :: + + aws apigatewayv2 create-integration \ + --api-id aabbccddee \ + --passthrough-behavior WHEN_NO_MATCH \ + --timeout-in-millis 29000 \ + --connection-type INTERNET + --request-templates "{\"application/json\": \"{\"statusCode\":200}\"}" + --integration-type MOCK + +Output:: + + { + "PassthroughBehavior": "WHEN_NO_MATCH", + "TimeoutInMillis": 29000, + "ConnectionType": "INTERNET", + "IntegrationResponseSelectionExpression": "${response.statuscode}", + "RequestTemplates": { + "application/json": "{"statusCode":200}" + }, + "IntegrationId": "0abcdef", + "IntegrationType": "MOCK" + } + +For more information, see `Set up a WebSocket API Integration Request in API Gateway `_ in the *Amazon API Gateway Developer Guide*. diff --git a/aws/dist/awscli/examples/apigatewayv2/create-route.rst b/aws/dist/awscli/examples/apigatewayv2/create-route.rst new file mode 100644 index 00000000..901bcefb --- /dev/null +++ b/aws/dist/awscli/examples/apigatewayv2/create-route.rst @@ -0,0 +1,18 @@ +**To create a route for a WebSocket API** + +The following ``create-route`` example creates a route for a WebSocket API. :: + + aws apigatewayv2 create-route \ + --api-id aabbccddee \ + --route-key $default + +Output:: + + { + "ApiKeyRequired": false, + "AuthorizationType": "NONE", + "RouteKey": "$default", + "RouteId": "1122334" + } + +For more information, see `Set up Routes for a WebSocket API in API Gateway `_ in the *Amazon API Gateway Developer Guide* diff --git a/aws/dist/awscli/examples/application-autoscaling/delete-scaling-policy.rst b/aws/dist/awscli/examples/application-autoscaling/delete-scaling-policy.rst new file mode 100644 index 00000000..d586a8d5 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/delete-scaling-policy.rst @@ -0,0 +1,7 @@ +**To delete a scaling policy** + +This example deletes a scaling policy for the Amazon ECS service `web-app` running in the `default` cluster. + +Command:: + + aws application-autoscaling delete-scaling-policy --policy-name web-app-cpu-lt-25 --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app --service-namespace ecs diff --git a/aws/dist/awscli/examples/application-autoscaling/delete-scheduled-action.rst b/aws/dist/awscli/examples/application-autoscaling/delete-scheduled-action.rst new file mode 100644 index 00000000..6f3aacaf --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/delete-scheduled-action.rst @@ -0,0 +1,13 @@ +**To delete a scheduled action** + +The follwing ``delete-scheduled-action`` example deletes the specified scheduled action from the specified Amazon AppStream 2.0 fleet:: + + aws application-autoscaling delete-scheduled-action \ + --service-namespace appstream \ + --scalable-dimension appstream:fleet:DesiredCapacity \ + --resource-id fleet/sample-fleet \ + --scheduled-action-name my-recurring-action + +This command produces no output. + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/application-autoscaling/deregister-scalable-target.rst b/aws/dist/awscli/examples/application-autoscaling/deregister-scalable-target.rst new file mode 100644 index 00000000..e018263f --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/deregister-scalable-target.rst @@ -0,0 +1,17 @@ +**To deregister a scalable target** + +This example deregisters a scalable target for an Amazon ECS service called `web-app` that is running in the `default` cluster. + +Command:: + + aws application-autoscaling deregister-scalable-target --service-namespace ecs --scalable-dimension ecs:service:DesiredCount --resource-id service/default/web-app + +This example deregisters a scalable target for a custom resource. The custom-resource-id.txt file contains a string that identifies the Resource ID, which, for a custom resource, is the path to the custom resource through your Amazon API Gateway endpoint. + +Command:: + + aws application-autoscaling deregister-scalable-target --service-namespace custom-resource --scalable-dimension custom-resource:ResourceType:Property --resource-id file://~/custom-resource-id.txt + +Contents of custom-resource-id.txt file:: + + https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 diff --git a/aws/dist/awscli/examples/application-autoscaling/describe-scalable-targets.rst b/aws/dist/awscli/examples/application-autoscaling/describe-scalable-targets.rst new file mode 100644 index 00000000..ae3c0cea --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/describe-scalable-targets.rst @@ -0,0 +1,29 @@ +**To describe scalable targets** + +The following ``describe-scalable-targets`` example command displays details for the the scalable targets for the ``ecs`` service namespace:: + + aws application-autoscaling describe-scalable-targets \ + --service-namespace ecs + +Output:: + + { + "ScalableTargets": [ + { + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::123456789012:role/ApplicationAutoscalingECSRole", + "SuspendedState": { + "DynamicScalingOutSuspended": false, + "ScheduledScalingSuspended": false, + "DynamicScalingInSuspended": false + }, + "CreationTime": 1462558906.199, + "MinCapacity": 1, + "ServiceNamespace": "ecs", + "MaxCapacity": 10 + } + ] + } + +For more information, see `What Is Application Auto Scaling? `__ in the *Application Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/application-autoscaling/describe-scaling-activities.rst b/aws/dist/awscli/examples/application-autoscaling/describe-scaling-activities.rst new file mode 100644 index 00000000..beeba704 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/describe-scaling-activities.rst @@ -0,0 +1,91 @@ +**Example 1: To describe scaling activities for a scalable target** + +The following ``describe-scaling-activities`` example displays details for th the scaling activities for an Amazon ECS service called `web-app` that is running in the `default` cluster. :: + + aws application-autoscaling describe-scaling-activities \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app + +Output:: + + { + "ScalingActivities": [ + { + "ScalableDimension": "ecs:service:DesiredCount", + "Description": "Setting desired count to 1.", + "ResourceId": "service/default/web-app", + "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", + "StartTime": 1462575838.171, + "ServiceNamespace": "ecs", + "EndTime": 1462575872.111, + "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", + "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.", + "StatusCode": "Successful" + } + ] + } + +**Example 2: To describe scaling activities triggered by scheduled actions** + +The following ``describe-scaling-activities`` example describes the scaling activities for the specified DynamoDB table. The output shows scaling activities triggered by two different scheduled actions:: + + aws application-autoscaling describe-scaling-activities \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:table:WriteCapacityUnits \ + --resource-id table/my-table + +Output:: + + { + "ScalingActivities": [ + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting write capacity units to 10.", + "ResourceId": "table/my-table", + "ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547", + "StartTime": 1561574415.086, + "ServiceNamespace": "dynamodb", + "EndTime": 1561574449.51, + "Cause": "maximum capacity was set to 10", + "StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting min capacity to 5 and max capacity to 10", + "ResourceId": "table/my-table", + "ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7", + "StartTime": 1561574414.644, + "ServiceNamespace": "dynamodb", + "Cause": "scheduled action name my-second-scheduled-action was triggered", + "StatusMessage": "Successfully set min capacity to 5 and max capacity to 10", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting write capacity units to 15.", + "ResourceId": "table/my-table", + "ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b", + "StartTime": 1561574108.904, + "ServiceNamespace": "dynamodb", + "EndTime": 1561574140.255, + "Cause": "minimum capacity was set to 15", + "StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.", + "StatusCode": "Successful" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Description": "Setting min capacity to 15 and max capacity to 20", + "ResourceId": "table/my-table", + "ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2", + "StartTime": 1561574108.512, + "ServiceNamespace": "dynamodb", + "Cause": "scheduled action name my-first-scheduled-action was triggered", + "StatusMessage": "Successfully set min capacity to 15 and max capacity to 20", + "StatusCode": "Successful" + } + ] + } + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/application-autoscaling/describe-scaling-policies.rst b/aws/dist/awscli/examples/application-autoscaling/describe-scaling-policies.rst new file mode 100644 index 00000000..f61bf96d --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/describe-scaling-policies.rst @@ -0,0 +1,64 @@ +**To describe scaling policies** + +This example command describes the scaling policies for the `ecs` service namespace. + +Command:: + + aws application-autoscaling describe-scaling-policies --service-namespace ecs + +Output:: + + { + "ScalingPolicies": [ + { + "PolicyName": "web-app-cpu-gt-75", + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "CreationTime": 1462561899.23, + "StepScalingPolicyConfiguration": { + "Cooldown": 60, + "StepAdjustments": [ + { + "ScalingAdjustment": 200, + "MetricIntervalLowerBound": 0.0 + } + ], + "AdjustmentType": "PercentChangeInCapacity" + }, + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "Alarms": [ + { + "AlarmName": "web-app-cpu-gt-75", + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75" + } + ], + "ServiceNamespace": "ecs" + }, + { + "PolicyName": "web-app-cpu-lt-25", + "ScalableDimension": "ecs:service:DesiredCount", + "ResourceId": "service/default/web-app", + "CreationTime": 1462562575.099, + "StepScalingPolicyConfiguration": { + "Cooldown": 1, + "StepAdjustments": [ + { + "ScalingAdjustment": -50, + "MetricIntervalUpperBound": 0.0 + } + ], + "AdjustmentType": "PercentChangeInCapacity" + }, + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-lt-25", + "PolicyType": "StepScaling", + "Alarms": [ + { + "AlarmName": "web-app-cpu-lt-25", + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-lt-25" + } + ], + "ServiceNamespace": "ecs" + } + ] + } diff --git a/aws/dist/awscli/examples/application-autoscaling/describe-scheduled-actions.rst b/aws/dist/awscli/examples/application-autoscaling/describe-scheduled-actions.rst new file mode 100644 index 00000000..fc2fbd41 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/describe-scheduled-actions.rst @@ -0,0 +1,41 @@ +**To describe scheduled actions** + +The following ``describe-scheduled-actions`` example displays details for the scheduled actions for the specified service namespace:: + + aws application-autoscaling describe-scheduled-actions \ + --service-namespace dynamodb + +Output:: + + { + "ScheduledActions": [ + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:35:00)", + "ResourceId": "table/my-table", + "CreationTime": 1561571888.361, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 15, + "MaxCapacity": 20 + }, + "ScheduledActionName": "my-first-scheduled-action", + "ServiceNamespace": "dynamodb" + }, + { + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "Schedule": "at(2019-05-20T18:40:00)", + "ResourceId": "table/my-table", + "CreationTime": 1561571946.021, + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", + "ScalableTargetAction": { + "MinCapacity": 5, + "MaxCapacity": 10 + }, + "ScheduledActionName": "my-second-scheduled-action", + "ServiceNamespace": "dynamodb" + } + ] + } + +For more information, see `Scheduled Scaling `__ in the *Application Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/application-autoscaling/put-scaling-policy.rst b/aws/dist/awscli/examples/application-autoscaling/put-scaling-policy.rst new file mode 100755 index 00000000..727b9359 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/put-scaling-policy.rst @@ -0,0 +1,122 @@ +**Example 1: To apply a target tracking scaling policy with a predefined metric specification** + +The following ``put-scaling-policy`` example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds. The output contains the ARNs and names of the two CloudWatch alarms created on your behalf. :: + + aws application-autoscaling put-scaling-policy --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name cpu75-target-tracking-scaling-policy --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +This example assumes that you have a `config.json` file in the current directory with the following contents:: + + { + "TargetValue": 75.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ECSServiceAverageCPUUtilization" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60 + } + +Output:: + + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", + "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d" + } + ] + } + +**Example 2: To apply a target tracking scaling policy with a customized metric specification** + +The following ``put-scaling-policy`` example applies a target tracking scaling policy with a customized metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds. The output contains the ARNs and names of the two CloudWatch alarms created on your behalf. :: + + aws application-autoscaling put-scaling-policy --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name cms75-target-tracking-scaling-policy + --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +This example assumes that you have a `config.json` file in the current directory with the following contents:: + + { + "TargetValue":75.0, + "CustomizedMetricSpecification":{ + "MetricName":"MyUtilizationMetric", + "Namespace":"MyNamespace", + "Dimensions": [ + { + "Name":"MyOptionalMetricDimensionName", + "Value":"MyOptionalMetricDimensionValue" + } + ], + "Statistic":"Average", + "Unit":"Percent" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60 + } + +Output:: + + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy: 8784a896-b2ba-47a1-b08c-27301cc499a1:resource/ecs/service/default/web-app:policyName/cms75-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0", + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-9bc77b56-0571-4276-ba0f-d4178882e0a0" + }, + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4", + "AlarmName": "TargetTracking-service/default/web-app-AlarmLow-9b6ad934-6d37-438e-9e05-02836ddcbdc4" + } + ] + } + +**Example 3: To apply a target tracking scaling policy for scale out only** + +The following ``put-scaling-policy`` example applies a target tracking scaling policy to an Amazon ECS service called ``web-app`` in the default cluster. The policy is used to scale out the ECS service when the ``RequestCountPerTarget`` metric from the Application Load Balancer exceeds the threshold. The output contains the ARN and name of the CloudWatch alarm created on your behalf. :: + + aws application-autoscaling put-scaling-policy \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --policy-name alb-scale-out-target-tracking-scaling-policy \ + --policy-type TargetTrackingScaling \ + --target-tracking-scaling-policy-configuration file://config.json + +Contents of ``config.json``:: + + { + "TargetValue": 1000.0, + "PredefinedMetricSpecification": { + "PredefinedMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/EC2Co-EcsEl-1TKLTMITMM0EO/f37c06a68c1748aa/targetgroup/EC2Co-Defau-LDNM7Q3ZH1ZN/6d4ea56ca2d6a18d" + }, + "ScaleOutCooldown": 60, + "ScaleInCooldown": 60, + "DisableScaleIn": true + } + +Output:: + + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/alb-scale-out-target-tracking-scaling-policy", + "Alarms": [ + { + "AlarmName": "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", + "AlarmARN": "arn:aws:cloudwatch:us-west-2:123456789012:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca" + } + ] + } + +For more information, see `Target Tracking Scaling Policies for Application Auto Scaling `_ in the *AWS Application Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/application-autoscaling/put-scheduled-action.rst b/aws/dist/awscli/examples/application-autoscaling/put-scheduled-action.rst new file mode 100644 index 00000000..d82d7444 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/put-scheduled-action.rst @@ -0,0 +1,11 @@ +**To add a scheduled action to a DynamoDB table** + +This example adds a scheduled action to a DynamoDB table called `TestTable` to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity. + +Command:: + + aws application-autoscaling put-scheduled-action --service-namespace dynamodb --scheduled-action-name my-recurring-action --schedule "cron(15 12 * * ? *)" --resource-id table/TestTable --scalable-dimension dynamodb:table:WriteCapacityUnits --scalable-target-action MinCapacity=6 + +For more information, see `Scheduled Scaling`_ in the *Application Auto Scaling User Guide*. + +.. _`Scheduled Scaling`: https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-scheduled-scaling.html diff --git a/aws/dist/awscli/examples/application-autoscaling/register-scalable-target.rst b/aws/dist/awscli/examples/application-autoscaling/register-scalable-target.rst new file mode 100644 index 00000000..c9cc24a9 --- /dev/null +++ b/aws/dist/awscli/examples/application-autoscaling/register-scalable-target.rst @@ -0,0 +1,93 @@ +**Example 1: To register a new scalable target for Amazon ECS** + +The following ``register-scalable-target`` example registers a scalable target for an Amazon ECS service called web-app, running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace ecs \ + --scalable-dimension ecs:service:DesiredCount \ + --resource-id service/default/web-app \ + --min-capacity 1 \ + --max-capacity 10 + +**Example 2: To register a new scalable target for a Spot Fleet** + +The following ``register-scalable-target`` example registers the target capacity of an Amazon EC2 Spot Fleet request using its request ID, with a minimum capacity of 2 instances and a maximum capacity of 10 instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace ec2 \ + --scalable-dimension ec2:spot-fleet-request:TargetCapacity \ + --resource-id spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE \ + --min-capacity 2 \ + --max-capacity 10 + +**Example 3: To register a new scalable target for AppStream 2.0** + +The following ``register-scalable-target`` example registers the desired capacity of an AppStream 2.0 fleet called sample-fleet, with a minimum capacity of 1 fleet instance and a maximum capacity of 5 fleet instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace appstream \ + --scalable-dimension appstream:fleet:DesiredCapacity \ + --resource-id fleet/sample-fleet \ + --min-capacity 1 \ + --max-capacity 5 + +**Example 4: To register a new scalable target for a DynamoDB table** + +The following ``register-scalable-target`` example registers the provisioned write capacity of a DynamoDB table called my-table, with a minimum capacity of 5 write capacity units and a maximum capacity of 10 write capacity units. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:table:WriteCapacityUnits \ + --resource-id table/my-table \ + --min-capacity 5 \ + --max-capacity 10 + +**Example 5: To register a new scalable target for a DynamoDB global secondary index** + +The following ``register-scalable-target`` example registers the provisioned write capacity of a DynamoDB global secondary index called my-table-index, with a minimum capacity of 5 write capacity units and a maximum capacity of 10 write capacity units. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace dynamodb \ + --scalable-dimension dynamodb:index:WriteCapacityUnits \ + --resource-id table/my-table/index/my-table-index \ + --min-capacity 5 \ + --max-capacity 10 + +**Example 6: To register a new scalable target for Aurora DB** + +The following ``register-scalable-target`` example registers the count of Aurora Replicas in an Aurora DB cluster called my-db-cluster, with a minimum capacity of 1 Aurora Replica and a maximum capacity of 8 Aurora Replicas. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace rds \ + --scalable-dimension rds:cluster:ReadReplicaCount \ + --resource-id cluster:my-db-cluster \ + --min-capacity 1 \ + --max-capacity 8 + +**Example 7: To register a new scalable target for Amazon Sagemaker** + +The following ``register-scalable-target`` example registers the desired EC2 instance count for an Amazon Sagemaker product variant called my-variant, running on the my-endpoint endpoint, with a minimum capacity of 1 instance and a maximum capacity of 8 instances. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace sagemaker \ + --scalable-dimension sagemaker:variant:DesiredInstanceCount \ + --resource-id endpoint/my-endpoint/variant/my-variant \ + --min-capacity 1 \ + --max-capacity 8 + +**Example 8: To register a new scalable target for a custom resource** + +The following ``register-scalable-target`` example registers a custom resource as a scalable target, with a minimum desired count of 1 capacity unit and a maximum desired count of 10 capacity units. The ``custom-resource-id.txt`` file contains a string that identifies the Resource ID, which for a custom resource is the path to the custom resource through your Amazon API Gateway endpoint. :: + + aws application-autoscaling register-scalable-target \ + --service-namespace custom-resource \ + --scalable-dimension custom-resource:ResourceType:Property \ + --resource-id file://~/custom-resource-id.txt \ + --min-capacity 1 \ + --max-capacity 10 + +Contents of ``custom-resource-id.txt``:: + + https://example.execute-api.us-west-2.amazonaws.com/prod/scalableTargetDimensions/1-23456789 + +For more information, see the `Application Auto Scaling User Guide `__. diff --git a/aws/dist/awscli/examples/appmesh/create-mesh.rst b/aws/dist/awscli/examples/appmesh/create-mesh.rst new file mode 100644 index 00000000..977f976b --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/create-mesh.rst @@ -0,0 +1,54 @@ +**Example 1: To create a new service mesh** + +The following ``create-mesh`` example creates a service mesh. :: + + aws appmesh create-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh":{ + "meshName":"app1", + "metadata":{ + "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt":1563809909.282, + "lastUpdatedAt":1563809909.282, + "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version":1 + }, + "spec":{}, + "status":{ + "status":"ACTIVE" + } + } + } + +**Example 2: To create a new service mesh with multiple tags** + +The following ``create-mesh`` example creates a service mesh with multiple tags. :: + + aws appmesh create-mesh \ + --mesh-name app2 \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +Output:: + + { + "mesh":{ + "meshName":"app2", + "metadata":{ + "arn":"arn:aws:appmesh:us-east-1:123456789012:mesh/app2", + "createdAt":1563822121.877, + "lastUpdatedAt":1563822121.877, + "uid":"a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version":1 + }, + "spec":{}, + "status":{ + "status":"ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/create-route.rst b/aws/dist/awscli/examples/appmesh/create-route.rst new file mode 100644 index 00000000..e595ee06 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/create-route.rst @@ -0,0 +1,325 @@ +**Example 1: To create a new route with weighting** + +The following ``create-route`` example uses a `JSON input file `__ to create a route with weighted targets. :: + + aws appmesh create-route \ + --cli-input-json file://create-route-weighted.json + +Contents of ``create-route-weighted.json``:: + + { + "meshName" : "app1", + "routeName" : "toVnServiceB-weighted", + "spec" : { + "httpRoute" : { + "action" : { + "weightedTargets" : [ + { + "virtualNode" : "vnServiceBv1", + "weight" : 90 + }, + { + "virtualNode" : "vnServiceBv2", + "weight" : 10 + } + ] + }, + "match" : { + "prefix" : "/" + } + } + }, + "virtualRouterName" : "vrServiceB" + } + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563811384.015, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 90 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 10 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. + +**Example 2: To create a new route with path-based routing** + +The following ``create-route`` example uses a `JSON input file `__ to create a route with path-based routing. :: + + aws appmesh create-route \ + --cli-input-json file://create-route-path.json + +Contents of ``create-route-path.json``:: + + { + "meshName": "app1", + "routeName": "toVnServiceB-path", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 100 + } + ] + }, + "match": { + "prefix": "/metrics" + } + } + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-path", + "createdAt": 1563823638.831, + "lastUpdatedAt": 1563823638.831, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "toVnServiceB-path", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 100 + } + ] + }, + "match": { + "prefix": "/metrics" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Path-based Routing `__ in the *AWS App Mesh User Guide*. + +**Example 3: To create a new route based on an HTTP header** + +The following ``create-route`` example uses a `JSON input file `__ to create a route that will route all requests to ``serviceB`` that have any path prefix in an HTTPS post where the ``clientRequestId`` header has a prefix of ``123``:: + + aws appmesh create-route \ + --cli-input-json file://create-route-headers.json + +Contents of ``create-route-headers.json``:: + + { + "meshName" : "app1", + "routeName" : "route-headers", + "spec" : { + "httpRoute" : { + "action" : { + "weightedTargets" : [ + { + "virtualNode" : "serviceB", + "weight" : 100 + } + ] + }, + "match" : { + "headers" : [ + { + "invert" : false, + "match" : { + "prefix" : "123" + }, + "name" : "clientRequestId" + } + ], + "method" : "POST", + "prefix" : "/", + "scheme" : "https" + } + } + }, + "virtualRouterName" : "virtual-router1" + } + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/virtual-router1/route/route-headers", + "createdAt": 1565963028.608, + "lastUpdatedAt": 1565963028.608, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "route-headers", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "serviceB", + "weight": 100 + } + ] + }, + "match": { + "headers": [ + { + "invert": false, + "match": { + "prefix": "123" + }, + "name": "clientRequestId" + } + ], + "method": "POST", + "prefix": "/", + "scheme": "https" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "virtual-router1" + } + } + +For more information, see `HTTP Headers `__ in the *AWS App Mesh User Guide*. + +**Example 4: To create a new route with a retry policy** + +The following ``create-route`` example uses a JSON input file to create a route with a retry policy.:: + + aws appmesh create-route \ + --cli-input-json file://create-route-retry-policy.json + +Contents of ``create-route-retry-policy.json``:: + + { + "meshName": "App1", + "routeName": "Route-retries1", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "ServiceB", + "weight": 100 + } + ] + }, + "match": { + "prefix": "/" + }, + "retryPolicy": { + "perRetryTimeout": { + "value": 15, + "unit": "s" + }, + "maxRetries": 3, + "httpRetryEvents": [ + "server-error", + "gateway-error" + ], + "tcpRetryEvents": [ + "connection-error" + ] + } + } + }, + "virtualRouterName": "Virtual-router1" + } + +Output:: + + { + "route": { + "meshName": "App1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/App1/virtualRouter/Virtual-router1/route/Route-retries1", + "createdAt": 1568142345.942, + "lastUpdatedAt": 1568142345.942, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "Route-retries1", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "ServiceB", + "weight": 100 + } + ] + }, + "match": { + "prefix": "/" + }, + "retryPolicy": { + "httpRetryEvents": [ + "server-error", + "gateway-error" + ], + "maxRetries": 3, + "perRetryTimeout": { + "unit": "s", + "value": 15 + }, + "tcpRetryEvents": [ + "connection-error" + ] + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "Virtual-router1" + } + } + +For more information, see `Retry Policy `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/create-virtual-node.rst b/aws/dist/awscli/examples/appmesh/create-virtual-node.rst new file mode 100644 index 00000000..7a8bc11b --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/create-virtual-node.rst @@ -0,0 +1,155 @@ +**Example 1: To create a new virtual node that uses DNS for discovery** + +The following ``create-virtual-node`` example uses a JSON input file to create a virtual node that uses DNS for service discovery. :: + + aws appmesh create-virtual-node \ + --cli-input-json file://create-virtual-node-dns.json + +Contents of ``create-virtual-node-dns.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "virtualNodeName": "vnServiceBv1" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563810019.874, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +**Example 2: To create a new virtual node that uses AWS Cloud Map for discovery** + +The following ``create-virtual-node`` example uses a JSON input file to create a virtual node that uses AWS Cloud Map for service discovery. :: + + aws appmesh create-virtual-node \ + --cli-input-json file://create-virtual-node-cloud-map.json + +Contents of ``create-virtual-node-cloud-map.json``:: + + { + "meshName": "app1", + "spec": { + "backends": [ + { + "virtualService": { + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + ], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "awsCloudMap": { + "attributes": [ + { + "key": "Environment", + "value": "Testing" + } + ], + "namespaceName": "namespace1", + "serviceName": "serviceA" + } + } + }, + "virtualNodeName": "vnServiceA" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceA", + "createdAt": 1563810859.465, + "lastUpdatedAt": 1563810859.465, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "backends": [ + { + "virtualService": { + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + ], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "awsCloudMap": { + "attributes": [ + { + "key": "Environment", + "value": "Testing" + } + ], + "namespaceName": "namespace1", + "serviceName": "serviceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceA" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/create-virtual-router.rst b/aws/dist/awscli/examples/appmesh/create-virtual-router.rst new file mode 100644 index 00000000..6858d828 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/create-virtual-router.rst @@ -0,0 +1,54 @@ +**To create a new virtual router** + +The following ``create-virtual-router`` example uses a JSON input file to create a virtual router with a listener for HTTP using port 80. :: + + aws appmesh create-virtual-router \ + --cli-input-json file://create-virtual-router.json + +Contents of ``create-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563810546.59, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/create-virtual-service.rst b/aws/dist/awscli/examples/appmesh/create-virtual-service.rst new file mode 100644 index 00000000..6bcbf683 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/create-virtual-service.rst @@ -0,0 +1,97 @@ +**Example 1: To create a new virtual service with a virtual node provider** + +The following ``create-virtual-service`` example uses a JSON input file to create a virtual service with a virtual node provider. :: + + aws appmesh create-virtual-service \ + --cli-input-json file://create-virtual-service-virtual-node.json + +Contents of ``create-virtual-service-virtual-node.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualNode": { + "virtualNodeName": "vnServiceA" + } + } + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "createdAt": 1563810859.474, + "lastUpdatedAt": 1563810967.179, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "provider": { + "virtualNode": { + "virtualNodeName": "vnServiceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + +For more information, see `Virtual Node `__ in the *AWS App Mesh User Guide*. + +**Example 2: To create a new virtual service with a virtual router provider** + +The following ``create-virtual-service`` example uses a JSON input file to create a virtual service with a virtual router provider. :: + + aws appmesh create-virtual-service \ + --cli-input-json file://create-virtual-service-virtual-router.json + +Contents of ``create-virtual-service-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563908363.999, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Services`__ in the *AWS App Mesh User Guide* \ No newline at end of file diff --git a/aws/dist/awscli/examples/appmesh/delete-mesh.rst b/aws/dist/awscli/examples/appmesh/delete-mesh.rst new file mode 100644 index 00000000..f1769c4f --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/delete-mesh.rst @@ -0,0 +1,31 @@ +**To delete a service mesh** + +The following ``delete-mesh`` example deletes the specified service mesh. :: + + aws appmesh delete-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563824981.248, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + }, + "status": { + "status": "DELETED" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/delete-route.rst b/aws/dist/awscli/examples/appmesh/delete-route.rst new file mode 100644 index 00000000..3a58e27d --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/delete-route.rst @@ -0,0 +1,49 @@ +**To delete a route** + +The following ``delete-route`` example deletes the specified route. :: + + aws appmesh delete-route \ + --mesh-name app1 \ + --virtual-router-name vrServiceB \ + --route-name toVnServiceB-weighted + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563823915.936, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "DELETED" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/delete-virtual-node.rst b/aws/dist/awscli/examples/appmesh/delete-virtual-node.rst new file mode 100644 index 00000000..d44021d7 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/delete-virtual-node.rst @@ -0,0 +1,44 @@ +**To delete a virtual node** + +The following ``delete-virtual-node`` example deletes the specified virtual node. :: + + aws appmesh delete-virtual-node \ + --mesh-name app1 \ + --virtual-node-name vnServiceBv2 + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", + "createdAt": 1563810117.297, + "lastUpdatedAt": 1563824700.678, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "backends": [], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv2.svc.cluster.local" + } + } + }, + "status": { + "status": "DELETED" + }, + "virtualNodeName": "vnServiceBv2" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/delete-virtual-router.rst b/aws/dist/awscli/examples/appmesh/delete-virtual-router.rst new file mode 100644 index 00000000..245d9e7a --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/delete-virtual-router.rst @@ -0,0 +1,38 @@ +**To delete a virtual router** + +The following ``delete-virtual-router`` example deletes the specified virtual router. :: + + aws appmesh delete-virtual-router \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563824253.467, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "DELETED" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/delete-virtual-service.rst b/aws/dist/awscli/examples/appmesh/delete-virtual-service.rst new file mode 100644 index 00000000..90d1b31a --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/delete-virtual-service.rst @@ -0,0 +1,29 @@ +**To delete a virtual service** + +The following ``delete-virtual-service`` example deletes the specified virtual service. :: + + aws appmesh delete-virtual-service \ + --mesh-name app1 \ + --virtual-service-name serviceB.svc.cluster.local + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563913940.866, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": {}, + "status": { + "status": "DELETED" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Service `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/describe-mesh.rst b/aws/dist/awscli/examples/appmesh/describe-mesh.rst new file mode 100644 index 00000000..43bed0d8 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/describe-mesh.rst @@ -0,0 +1,27 @@ +**To describe a service mesh** + +The following ``describe-mesh`` example returns details about the specified service mesh. :: + + aws appmesh describe-mesh \ + --mesh-name app1 + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563809909.282, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": {}, + "status": { + "status": "ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/describe-route.rst b/aws/dist/awscli/examples/appmesh/describe-route.rst new file mode 100644 index 00000000..19389865 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/describe-route.rst @@ -0,0 +1,49 @@ +**To describe a route** + +The following ``describe-route`` example returns details about the specified route. :: + + aws appmesh describe-route \ + --mesh-name app1 \ + --virtual-router-name vrServiceB \ + --route-name toVnServiceB-weighted + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563811384.015, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 90 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 10 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/describe-virtual-node.rst b/aws/dist/awscli/examples/appmesh/describe-virtual-node.rst new file mode 100644 index 00000000..96300ca9 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/describe-virtual-node.rst @@ -0,0 +1,44 @@ +**To describe a virtual node** + +The following ``describe-virtual-node`` example returns details about the specified virtual node. :: + + aws appmesh describe-virtual-node \ + --mesh-name app1 \ + --virtual-node-name vnServiceBv1 + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563810019.874, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "backends": [], + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/describe-virtual-router.rst b/aws/dist/awscli/examples/appmesh/describe-virtual-router.rst new file mode 100644 index 00000000..868f9cfc --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/describe-virtual-router.rst @@ -0,0 +1,38 @@ +**To describe a virtual router** + +The following ``describe-virtual-router`` example returns details about the specified virtual router. :: + + aws appmesh describe-virtual-router \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563810546.59, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/describe-virtual-service.rst b/aws/dist/awscli/examples/appmesh/describe-virtual-service.rst new file mode 100644 index 00000000..9f9e4936 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/describe-virtual-service.rst @@ -0,0 +1,35 @@ +**To describe a virtual service** + +The following ``describe-virtual-service`` example returns details about the specified virtual service. :: + + aws appmesh describe-virtual-service \ + --mesh-name app1 \ + --virtual-service-name serviceB.svc.cluster.local + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "createdAt": 1563908363.999, + "lastUpdatedAt": 1563908363.999, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 1 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceB" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceB.svc.cluster.local" + } + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/list-meshes.rst b/aws/dist/awscli/examples/appmesh/list-meshes.rst new file mode 100644 index 00000000..75d5fff8 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-meshes.rst @@ -0,0 +1,18 @@ +**To list service meshes** + +The following ``list-meshes`` example lists all of the service meshes in the current AWS Region. :: + + aws appmesh list-meshes + +Output:: + + { + "meshes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "meshName": "app1" + } + ] + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/list-routes.rst b/aws/dist/awscli/examples/appmesh/list-routes.rst new file mode 100644 index 00000000..feba62a0 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-routes.rst @@ -0,0 +1,22 @@ +**To list routes** + +The following ``list-routes`` example lists all of the routes for the specified virtual router. :: + + aws appmesh list-routes \ + --mesh-name app1 \ + --virtual-router-name vrServiceB + +Output:: + + { + "routes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB", + "meshName": "app1", + "routeName": "toVnServiceB-weighted", + "virtualRouterName": "vrServiceB" + } + ] + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/list-tags-for-resource.rst b/aws/dist/awscli/examples/appmesh/list-tags-for-resource.rst new file mode 100644 index 00000000..5633d018 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-tags-for-resource.rst @@ -0,0 +1,25 @@ +**To list tags for a resource** + +The following ``list-tags-for-resource`` example lists all of the tags assigned to the specified resource. :: + + aws appmesh list-tags-for-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 + +Output:: + + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } diff --git a/aws/dist/awscli/examples/appmesh/list-virtual-nodes.rst b/aws/dist/awscli/examples/appmesh/list-virtual-nodes.rst new file mode 100644 index 00000000..c3fcf08e --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-virtual-nodes.rst @@ -0,0 +1,25 @@ +**To list virtual nodes** + +The following ``list-virtual-nodes`` example lists all of the virtual nodes in the specified service mesh. :: + + aws appmesh list-virtual-nodes \ + --mesh-name app1 + +Output:: + + { + "virtualNodes": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "meshName": "app1", + "virtualNodeName": "vnServiceBv1" + }, + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv2", + "meshName": "app1", + "virtualNodeName": "vnServiceBv2" + } + ] + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/list-virtual-routers.rst b/aws/dist/awscli/examples/appmesh/list-virtual-routers.rst new file mode 100644 index 00000000..30ca3abd --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-virtual-routers.rst @@ -0,0 +1,20 @@ +**To list virtual routers** + +The following ``list-virtual-routers`` example lists all of the virtual routers in the specified service mesh. :: + + aws appmesh list-virtual-routers \ + --mesh-name app1 + +Output:: + + { + "virtualRouters": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "meshName": "app1", + "virtualRouterName": "vrServiceB" + } + ] + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/list-virtual-services.rst b/aws/dist/awscli/examples/appmesh/list-virtual-services.rst new file mode 100644 index 00000000..45b99d4b --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/list-virtual-services.rst @@ -0,0 +1,25 @@ +**To list virtual services** + +The following ``list-virtual-services`` example lists all of the virtual services in the specified service mesh. :: + + aws appmesh list-virtual-services \ + --mesh-name app1 + +Output:: + + { + "virtualServices": [ + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "meshName": "app1", + "virtualServiceName": "serviceA.svc.cluster.local" + }, + { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceB.svc.cluster.local", + "meshName": "app1", + "virtualServiceName": "serviceB.svc.cluster.local" + } + ] + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/tag-resource.rst b/aws/dist/awscli/examples/appmesh/tag-resource.rst new file mode 100644 index 00000000..6949761d --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/tag-resource.rst @@ -0,0 +1,9 @@ +**To tag a resource** + +The following ``tag-resource`` example adds the tag ``key1`` with the value ``value1`` to the specified resource. :: + + aws appmesh tag-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ + --tags key=key1,value=value1 + +This command produces no output. diff --git a/aws/dist/awscli/examples/appmesh/untag-resource.rst b/aws/dist/awscli/examples/appmesh/untag-resource.rst new file mode 100644 index 00000000..a41b3cc8 --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/untag-resource.rst @@ -0,0 +1,9 @@ +**To untag a resource** + +The following ``untag-resource`` example removes a tag with the key ``key1`` from the specified resource. :: + + aws appmesh untag-resource \ + --resource-arn arn:aws:appmesh:us-east-1:123456789012:mesh/app1 \ + --tag-keys key1 + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/appmesh/update-mesh.rst b/aws/dist/awscli/examples/appmesh/update-mesh.rst new file mode 100644 index 00000000..d2fe0fdf --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/update-mesh.rst @@ -0,0 +1,42 @@ +**To update a service mesh** + +The following ``update-mesh`` example uses a JSON input file to update a service mesh to allow all external egress traffic to be forwarded through the Envoy proxy untouched. :: + + aws appmesh update-mesh \ + --cli-input-json file://update-mesh.json + +Contents of ``update-mesh.json``:: + + { + "meshName": "app1", + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + } + } + +Output:: + + { + "mesh": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1", + "createdAt": 1563809909.282, + "lastUpdatedAt": 1563812829.687, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "egressFilter": { + "type": "ALLOW_ALL" + } + }, + "status": { + "status": "ACTIVE" + } + } + } + +For more information, see `Service Meshes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/update-route.rst b/aws/dist/awscli/examples/appmesh/update-route.rst new file mode 100644 index 00000000..8410ecbd --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/update-route.rst @@ -0,0 +1,74 @@ +**To update a route** + +The following ``update-route`` example uses a JSON input file to update the weights for a route. :: + + aws appmesh update-route \ + --cli-input-json file://update-route-weighted.json + +Contents of ``update-route-weighted.json``:: + + { + "meshName": "app1", + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "route": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB/route/toVnServiceB-weighted", + "createdAt": 1563811384.015, + "lastUpdatedAt": 1563819600.022, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "routeName": "toVnServiceB-weighted", + "spec": { + "httpRoute": { + "action": { + "weightedTargets": [ + { + "virtualNode": "vnServiceBv1", + "weight": 80 + }, + { + "virtualNode": "vnServiceBv2", + "weight": 20 + } + ] + }, + "match": { + "prefix": "/" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Routes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/update-virtual-node.rst b/aws/dist/awscli/examples/appmesh/update-virtual-node.rst new file mode 100644 index 00000000..1839112c --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/update-virtual-node.rst @@ -0,0 +1,83 @@ +**To update a virtual node** + +The following ``update-virtual-node`` example uses a JSON input file to add a health check to a virtual node. :: + + aws appmesh update-virtual-node \ + --cli-input-json file://update-virtual-node.json + +Contents of ``update-virtual-node.json``:: + + { + "clientToken": "500", + "meshName": "app1", + "spec": { + "listeners": [ + { + "healthCheck": { + "healthyThreshold": 5, + "intervalMillis": 10000, + "path": "/", + "port": 80, + "protocol": "http", + "timeoutMillis": 3000, + "unhealthyThreshold": 3 + }, + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "virtualNodeName": "vnServiceBv1" + } + +Output:: + + { + "virtualNode": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/vnServiceBv1", + "createdAt": 1563810019.874, + "lastUpdatedAt": 1563819234.825, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "listeners": [ + { + "healthCheck": { + "healthyThreshold": 5, + "intervalMillis": 10000, + "path": "/", + "port": 80, + "protocol": "http", + "timeoutMillis": 3000, + "unhealthyThreshold": 3 + }, + "portMapping": { + "port": 80, + "protocol": "http" + } + } + ], + "serviceDiscovery": { + "dns": { + "hostname": "serviceBv1.svc.cluster.local" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualNodeName": "vnServiceBv1" + } + } + +For more information, see `Virtual Nodes `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/update-virtual-router.rst b/aws/dist/awscli/examples/appmesh/update-virtual-router.rst new file mode 100644 index 00000000..8d91b49e --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/update-virtual-router.rst @@ -0,0 +1,54 @@ +**To update a virtual router** + +The following ``update-virtual-router`` example uses a JSON input file to update a virtual router listener port. :: + + aws appmesh update-virtual-router \ + --cli-input-json file://update-virtual-router.json + +Contents of ``update-virtual-router.json``:: + + { + "meshName": "app1", + "spec": { + "listeners": [ + { + "portMapping": { + "port": 8080, + "protocol": "http" + } + } + ] + }, + "virtualRouterName": "vrServiceB" + } + +Output:: + + { + "virtualRouter": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualRouter/vrServiceB", + "createdAt": 1563810546.59, + "lastUpdatedAt": 1563819431.352, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 2 + }, + "spec": { + "listeners": [ + { + "portMapping": { + "port": 8080, + "protocol": "http" + } + } + ] + }, + "status": { + "status": "ACTIVE" + }, + "virtualRouterName": "vrServiceB" + } + } + +For more information, see `Virtual Routers `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/appmesh/update-virtual-service.rst b/aws/dist/awscli/examples/appmesh/update-virtual-service.rst new file mode 100644 index 00000000..2300527a --- /dev/null +++ b/aws/dist/awscli/examples/appmesh/update-virtual-service.rst @@ -0,0 +1,48 @@ +**To update a virtual service** + +The following ``update-virtual-service`` example uses a JSON input file to update a virtual service to use a virtual router provider. :: + + aws appmesh update-virtual-service \ + --cli-input-json file://update-virtual-service.json + +Contents of ``update-virtual-service.json``:: + + { + "meshName": "app1", + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceA" + } + } + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + +Output:: + + { + "virtualService": { + "meshName": "app1", + "metadata": { + "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualService/serviceA.svc.cluster.local", + "createdAt": 1563810859.474, + "lastUpdatedAt": 1563820257.411, + "uid": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "version": 3 + }, + "spec": { + "provider": { + "virtualRouter": { + "virtualRouterName": "vrServiceA" + } + } + }, + "status": { + "status": "ACTIVE" + }, + "virtualServiceName": "serviceA.svc.cluster.local" + } + } + +For more information, see `Virtual Services `__ in the *AWS App Mesh User Guide*. diff --git a/aws/dist/awscli/examples/autoscaling-plans/create-scaling-plan.rst b/aws/dist/awscli/examples/autoscaling-plans/create-scaling-plan.rst new file mode 100644 index 00000000..538d26d8 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/create-scaling-plan.rst @@ -0,0 +1,54 @@ +**To create a scaling plan** + +The following ``create-scaling-plan`` example creates a scaling plan named ``my-scaling-plan`` using an already-created JSON file (named config.json). The structure of the scaling plan includes a scaling instruction for an Auto Scaling group named ``my-asg``. It specifies the ``TagFilters`` property as the application source and enables predictive scaling and dynamic scaling. :: + + aws autoscaling-plans create-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --cli-input-json file://~/config.json + +Contents of ``config.json`` file:: + + { + "ApplicationSource": { + "TagFilters": [ + { + "Key": "purpose", + "Values": [ + "my-application" + ] + } + ] + }, + "ScalingInstructions": [ + { + "ServiceNamespace": "autoscaling", + "ResourceId": "autoScalingGroup/my-asg", + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "ScheduledActionBufferTime": 300, + "PredictiveScalingMaxCapacityBehavior": "SetForecastCapacityToMaxCapacity", + "PredictiveScalingMode": "ForecastAndScale", + "PredefinedLoadMetricSpecification": { + "PredefinedLoadMetricType": "ASGTotalCPUUtilization" + }, + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "MinCapacity": 1, + "MaxCapacity": 4, + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ASGAverageCPUUtilization" + }, + "TargetValue": 50 + } + ] + } + ] + } + +Output:: + + { + "ScalingPlanVersion": 1 + } + +For more information, see the `AWS Auto Scaling User Guide `__. diff --git a/aws/dist/awscli/examples/autoscaling-plans/delete-scaling-plan.rst b/aws/dist/awscli/examples/autoscaling-plans/delete-scaling-plan.rst new file mode 100644 index 00000000..545f7da3 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/delete-scaling-plan.rst @@ -0,0 +1,11 @@ +**To delete a scaling plan** + +The following ``delete-scaling-plan`` example deletes the specified scaling plan. :: + + aws autoscaling-plans delete-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 + +This command produces no output. + +For more information, see the `AWS Auto Scaling User Guide `__. diff --git a/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst b/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst new file mode 100644 index 00000000..c37468a0 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plan-resources.rst @@ -0,0 +1,38 @@ +**To describe the scalable resources for a scaling plan** + +The following ``describe-scaling-plan-resources`` example displays details about the single scalable resource (an Auto Scaling group) that is associated with the specified scaling plan. :: + + aws autoscaling-plans describe-scaling-plan-resources \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 + +Output:: + + { + "ScalingPlanResources": [ + { + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "ScalingPlanVersion": 1, + "ResourceId": "autoScalingGroup/my-asg", + "ScalingStatusCode": "Active", + "ScalingStatusMessage": "Target tracking scaling policies have been applied to the resource.", + "ScalingPolicies": [ + { + "PolicyName": "AutoScaling-my-asg-b1ab65ae-4be3-4634-bd64-c7471662b251", + "PolicyType": "TargetTrackingScaling", + "TargetTrackingConfiguration": { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ALBRequestCountPerTarget", + "ResourceLabel": "app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d" + }, + "TargetValue": 40.0 + } + } + ], + "ServiceNamespace": "autoscaling", + "ScalingPlanName": "my-scaling-plan" + } + ] + } + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plans.rst b/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plans.rst new file mode 100644 index 00000000..9fc46d0d --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/describe-scaling-plans.rst @@ -0,0 +1,95 @@ +**To describe a scaling plan** + +The following ``describe-scaling-plans`` example displays the details of the specified scaling plan. :: + + aws autoscaling-plans describe-scaling-plans \ + --scaling-plan-names scaling-plan-with-asg-and-ddb + +Output:: + + { + "ScalingPlans": [ + { + "LastMutatingRequestTime": 1565388443.963, + "ScalingPlanVersion": 1, + "CreationTime": 1565388443.963, + "ScalingInstructions": [ + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "autoscaling:autoScalingGroup:DesiredCapacity", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "ASGAverageCPUUtilization" + }, + "TargetValue": 50.0, + "EstimatedInstanceWarmup": 300, + "DisableScaleIn": false + } + ], + "ResourceId": "autoScalingGroup/my-asg", + "DisableDynamicScaling": false, + "MinCapacity": 1, + "ServiceNamespace": "autoscaling", + "MaxCapacity": 10 + }, + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "dynamodb:table:ReadCapacityUnits", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "DynamoDBReadCapacityUtilization" + }, + "TargetValue": 50.0, + "ScaleInCooldown": 60, + "DisableScaleIn": false, + "ScaleOutCooldown": 60 + } + ], + "ResourceId": "table/my-table", + "DisableDynamicScaling": false, + "MinCapacity": 5, + "ServiceNamespace": "dynamodb", + "MaxCapacity": 10000 + }, + { + "ScalingPolicyUpdateBehavior": "ReplaceExternalPolicies", + "ScalableDimension": "dynamodb:table:WriteCapacityUnits", + "TargetTrackingConfigurations": [ + { + "PredefinedScalingMetricSpecification": { + "PredefinedScalingMetricType": "DynamoDBWriteCapacityUtilization" + }, + "TargetValue": 50.0, + "ScaleInCooldown": 60, + "DisableScaleIn": false, + "ScaleOutCooldown": 60 + } + ], + "ResourceId": "table/my-table", + "DisableDynamicScaling": false, + "MinCapacity": 5, + "ServiceNamespace": "dynamodb", + "MaxCapacity": 10000 + } + ], + "ApplicationSource": { + "TagFilters": [ + { + "Values": [ + "my-application-id" + ], + "Key": "application" + } + ] + }, + "StatusStartTime": 1565388455.836, + "ScalingPlanName": "scaling-plan-with-asg-and-ddb", + "StatusMessage": "Scaling plan has been created and applied to all resources.", + "StatusCode": "Active" + } + ] + } + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst b/aws/dist/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst new file mode 100644 index 00000000..f1e7a621 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/get-scaling-plan-resource-forecast-data.rst @@ -0,0 +1,21 @@ +**To retrieve load forecast data** + +This example retrieves load forecast data for a scalable resource (an Auto Scaling group) that is associated with the specified scaling plan. :: + + aws autoscaling-plans get-scaling-plan-resource-forecast-data \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 \ + --service-namespace "autoscaling" \ + --resource-id autoScalingGroup/my-asg \ + --scalable-dimension "autoscaling:autoScalingGroup:DesiredCapacity" \ + --forecast-data-type "LoadForecast" \ + --start-time "2019-08-30T00:00:00Z" \ + --end-time "2019-09-06T00:00:00Z" + +Output:: + + { + "Datapoints": [...] + } + +For more information, see `What Is AWS Auto Scaling `__ in the *AWS Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/autoscaling-plans/update-scaling-plan.rst b/aws/dist/awscli/examples/autoscaling-plans/update-scaling-plan.rst new file mode 100644 index 00000000..0d718d8f --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling-plans/update-scaling-plan.rst @@ -0,0 +1,12 @@ +**To update a scaling plan** + +The following ``update-scaling-plan`` example modifies the scaling metric for an Auto Scaling group in the specified scaling plan. :: + + aws autoscaling-plans update-scaling-plan \ + --scaling-plan-name my-scaling-plan \ + --scaling-plan-version 1 \ + --scaling-instructions '{"ScalableDimension":"autoscaling:autoScalingGroup:DesiredCapacity","ResourceId":"autoScalingGroup/my-asg","ServiceNamespace":"autoscaling","TargetTrackingConfigurations":[{"PredefinedScalingMetricSpecification": {"PredefinedScalingMetricType":"ALBRequestCountPerTarget","ResourceLabel":"app/my-alb/f37c06a68c1748aa/targetgroup/my-target-group/6d4ea56ca2d6a18d"},"TargetValue":40.0}],"MinCapacity": 1,"MaxCapacity": 10}' + +This command produces no output. + +For more information, see `What Is AWS Auto Scaling? `__ in the *AWS Auto Scaling User Guide*. diff --git a/aws/dist/awscli/examples/autoscaling/attach-instances.rst b/aws/dist/awscli/examples/autoscaling/attach-instances.rst new file mode 100644 index 00000000..2b9fa5a0 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/attach-instances.rst @@ -0,0 +1,5 @@ +**To attach an instance to an Auto Scaling group** + +This example attaches the specified instance to the specified Auto Scaling group:: + + aws autoscaling attach-instances --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group diff --git a/aws/dist/awscli/examples/autoscaling/attach-load-balancer-target-groups.rst b/aws/dist/awscli/examples/autoscaling/attach-load-balancer-target-groups.rst new file mode 100755 index 00000000..6e5a5fd3 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/attach-load-balancer-target-groups.rst @@ -0,0 +1,5 @@ +**To attach a target group to an Auto Scaling group** + +This example attaches the specified target group to the specified Auto Scaling group:: + + aws autoscaling attach-load-balancer-target-groups --auto-scaling-group-name my-auto-scaling-group --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 diff --git a/aws/dist/awscli/examples/autoscaling/attach-load-balancers.rst b/aws/dist/awscli/examples/autoscaling/attach-load-balancers.rst new file mode 100644 index 00000000..97ef04df --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/attach-load-balancers.rst @@ -0,0 +1,5 @@ +**To attach a load balancer to an Auto Scaling group** + +This example attaches the specified load balancer to the specified Auto Scaling group:: + + aws autoscaling attach-load-balancers --load-balancer-names my-load-balancer --auto-scaling-group-name my-auto-scaling-group diff --git a/aws/dist/awscli/examples/autoscaling/complete-lifecycle-action.rst b/aws/dist/awscli/examples/autoscaling/complete-lifecycle-action.rst new file mode 100644 index 00000000..bdbb2797 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/complete-lifecycle-action.rst @@ -0,0 +1,5 @@ +**To complete the lifecycle action** + +This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance:: + + aws autoscaling complete-lifecycle-action --lifecycle-hook-name my-lifecycle-hook --auto-scaling-group-name my-auto-scaling-group --lifecycle-action-result CONTINUE --lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635 diff --git a/aws/dist/awscli/examples/autoscaling/create-auto-scaling-group.rst b/aws/dist/awscli/examples/autoscaling/create-auto-scaling-group.rst new file mode 100644 index 00000000..39d5780a --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/create-auto-scaling-group.rst @@ -0,0 +1,68 @@ +**To create an Auto Scaling group using a launch configuration** + +This example creates an Auto Scaling group in a VPC using a launch configuration to specify the type of EC2 instance that Amazon EC2 Auto Scaling creates:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" + +This example creates an Auto Scaling group and configures it to use an Elastic Load Balancing load balancer:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --load-balancer-names my-load-balancer --health-check-type ELB --health-check-grace-period 120 --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" + +This example specifies a desired capacity as well as a minimum and maximum capacity. It also launches instances into a placement group and sets the termination policy to terminate the oldest instances first:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-configuration-name my-launch-config --min-size 1 --max-size 3 --desired-capacity 1 --placement-group my-placement-group --termination-policies "OldestInstance" --availability-zones us-west-2c + +**To create an Auto Scaling group using an EC2 instance** + +This example creates an Auto Scaling group from the specified EC2 instance and assigns a tag to instances in the group:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --instance-id i-22c99e2a --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" --tags "ResourceId=my-asg,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true" + +**To create an Auto Scaling group using a launch template** + +This example creates an Auto Scaling group in a VPC using a launch template to specify the type of EC2 instance that Amazon EC2 Auto Scaling creates:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-template "LaunchTemplateName=my-template-for-auto-scaling,Version=1" --min-size 1 --max-size 3 --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" + +This example uses the default version of the specified launch template. It specifies Availability Zones and subnets and enables the instance protection setting:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg --launch-template LaunchTemplateId=lt-0a4872e2c396d941c --min-size 1 --max-size 3 --desired-capacity 2 --availability-zones us-west-2a us-west-2b us-west-2c --vpc-zone-identifier "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782" --new-instances-protected-from-scale-in + +This example creates an Auto Scaling group that launches a single instance using a launch template to optionally specify the ID of an existing network interface (ENI ID) to use. It specifies an Availability Zone that matches the specified network interface:: + + aws autoscaling create-auto-scaling-group --auto-scaling-group-name my-asg-single-instance --launch-template "LaunchTemplateName=my-single-instance-asg-template,Version=2" --min-size 1 --max-size 1 --availability-zones us-west-2a + +This example creates an Auto Scaling group with a lifecycle hook that supports a custom action at instance termination:: + + aws autoscaling create-auto-scaling-group --cli-input-json file://~/config.json + +Contents of config.json file:: + + { + "AutoScalingGroupName": "my-asg", + "LaunchTemplate": { + "LaunchTemplateId": "lt-0a4872e2c396d941c" + }, + "LifecycleHookSpecificationList": [{ + "LifecycleHookName": "my-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_TERMINATING", + "NotificationTargetARN": "arn:aws:sqs:us-west-2:123456789012:my-sqs-queue", + "RoleARN": "arn:aws:iam::123456789012:role/my-notification-role", + "HeartbeatTimeout": 300, + "DefaultResult": "CONTINUE" + }], + "MinSize": 1, + "MaxSize": 5, + "VPCZoneIdentifier": "subnet-5ea0c127,subnet-6194ea3b,subnet-c934b782", + "Tags": [{ + "ResourceType": "auto-scaling-group", + "ResourceId": "my-asg", + "PropagateAtLaunch": true, + "Value": "test", + "Key": "environment" + }] + } + +For more information, see the `Amazon EC2 Auto Scaling User Guide`_. + +.. _`Amazon EC2 Auto Scaling User Guide`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/what-is-amazon-ec2-auto-scaling.html diff --git a/aws/dist/awscli/examples/autoscaling/create-launch-configuration.rst b/aws/dist/awscli/examples/autoscaling/create-launch-configuration.rst new file mode 100644 index 00000000..d500add2 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/create-launch-configuration.rst @@ -0,0 +1,43 @@ +**To create a launch configuration** + +This example creates a launch configuration:: + + aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --image-id ami-c6169af6 --instance-type m1.medium + +This example creates a launch configuration with a key pair and a bootstrapping script:: + + aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --key-name my-key-pair --image-id ami-c6169af6 --instance-type m1.small --user-data file://myuserdata.txt + +This example creates a launch configuration based on an existing instance. In addition, it also specifies launch configuration attributes such as a security group, tenancy, Amazon EBS optimization, and a bootstrapping script:: + + aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --key-name my-key-pair --instance-id i-7e13c876 --security-groups sg-eb2af88e --instance-type m1.small --user-data file://myuserdata.txt --instance-monitoring Enabled=true --no-ebs-optimized --no-associate-public-ip-address --placement-tenancy dedicated --iam-instance-profile my-autoscaling-role + +Add the following parameter to add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100. + +Parameter:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdh\",\"Ebs\":{\"VolumeSize\":100}}]" + +Add the following parameter to add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``. + +Parameter:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdc\",\"VirtualName\":\"ephemeral1\"}]" + +Add the following parameter to omit a device included on the instance (for example, ``/dev/sdf``). + +Parameter:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdf\",\"NoDevice\":\"\"}]" + +For more information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. + +This example creates a launch configuration that uses Spot Instances:: + + aws autoscaling create-launch-configuration --launch-configuration-name my-launch-config --image-id ami-01e24be29428c15b2 --instance-type c5.large --spot-price "0.50" + +For more information, see `Launching Spot Instances in Your Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings + +.. _`Launching Spot Instances in Your Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-launch-spot-instances.html diff --git a/aws/dist/awscli/examples/autoscaling/create-or-update-tags.rst b/aws/dist/awscli/examples/autoscaling/create-or-update-tags.rst new file mode 100644 index 00000000..de6a9b6a --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/create-or-update-tags.rst @@ -0,0 +1,5 @@ +**To create or update tags for an Auto Scaling group** + +This example adds two tags to the specified Auto Scaling group:: + + aws autoscaling create-or-update-tags --tags ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=Role,Value=WebServer,PropagateAtLaunch=true ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=Dept,Value=Research,PropagateAtLaunch=true diff --git a/aws/dist/awscli/examples/autoscaling/delete-auto-scaling-group.rst b/aws/dist/awscli/examples/autoscaling/delete-auto-scaling-group.rst new file mode 100644 index 00000000..63f87636 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-auto-scaling-group.rst @@ -0,0 +1,13 @@ +**To delete an Auto Scaling group** + +This example deletes the specified Auto Scaling group:: + + aws autoscaling delete-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group + +To delete the Auto Scaling group without waiting for the instances in the group to terminate, use the ``--force-delete`` parameter:: + + aws autoscaling delete-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --force-delete + +For more information, see `Deleting Your Auto Scaling Infrastructure`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Deleting Your Auto Scaling Infrastructure`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html diff --git a/aws/dist/awscli/examples/autoscaling/delete-launch-configuration.rst b/aws/dist/awscli/examples/autoscaling/delete-launch-configuration.rst new file mode 100644 index 00000000..4b9b3629 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-launch-configuration.rst @@ -0,0 +1,9 @@ +**To delete a launch configuration** + +This example deletes the specified launch configuration:: + + aws autoscaling delete-launch-configuration --launch-configuration-name my-launch-config + +For more information, see `Deleting Your Auto Scaling Infrastructure`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Deleting Your Auto Scaling Infrastructure`: http://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/as-process-shutdown.html diff --git a/aws/dist/awscli/examples/autoscaling/delete-lifecycle-hook.rst b/aws/dist/awscli/examples/autoscaling/delete-lifecycle-hook.rst new file mode 100644 index 00000000..4c2c8a4b --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-lifecycle-hook.rst @@ -0,0 +1,5 @@ +**To delete a lifecycle hook** + +This example deletes the specified lifecycle hook:: + + aws autoscaling delete-lifecycle-hook --lifecycle-hook-name my-lifecycle-hook --auto-scaling-group-name my-auto-scaling-group diff --git a/aws/dist/awscli/examples/autoscaling/delete-notification-configuration.rst b/aws/dist/awscli/examples/autoscaling/delete-notification-configuration.rst new file mode 100644 index 00000000..0a7023f9 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-notification-configuration.rst @@ -0,0 +1,9 @@ +**To delete an Auto Scaling notification** + +This example deletes the specified notification from the specified Auto Scaling group:: + + aws autoscaling delete-notification-configuration --auto-scaling-group-name my-auto-scaling-group --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic + +For more information, see `Delete the Notification Configuration`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Delete the Notification Configuration`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#delete-settingupnotifications diff --git a/aws/dist/awscli/examples/autoscaling/delete-policy.rst b/aws/dist/awscli/examples/autoscaling/delete-policy.rst new file mode 100644 index 00000000..da32cf0c --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-policy.rst @@ -0,0 +1,5 @@ +**To delete an Auto Scaling policy** + +This example deletes the specified Auto Scaling policy:: + + aws autoscaling delete-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn diff --git a/aws/dist/awscli/examples/autoscaling/delete-scheduled-action.rst b/aws/dist/awscli/examples/autoscaling/delete-scheduled-action.rst new file mode 100644 index 00000000..c2b67d35 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-scheduled-action.rst @@ -0,0 +1,5 @@ +**To delete a scheduled action from an Auto Scaling group** + +This example deletes the specified scheduled action from the specified Auto Scaling group:: + + aws autoscaling delete-scheduled-action --auto-scaling-group-name my-auto-scaling-group --scheduled-action-name my-scheduled-action diff --git a/aws/dist/awscli/examples/autoscaling/delete-tags.rst b/aws/dist/awscli/examples/autoscaling/delete-tags.rst new file mode 100644 index 00000000..33492557 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/delete-tags.rst @@ -0,0 +1,9 @@ +**To delete a tag from an Auto Scaling group** + +This example deletes the specified tag from the specified Auto Scaling group:: + + aws autoscaling delete-tags --tags ResourceId=my-auto-scaling-group,ResourceType=auto-scaling-group,Key=Dept,Value=Research + +For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Tagging Auto Scaling Groups and Instances`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-account-limits.rst b/aws/dist/awscli/examples/autoscaling/describe-account-limits.rst new file mode 100644 index 00000000..5db97d33 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-account-limits.rst @@ -0,0 +1,18 @@ +**To describe your Auto Scaling account limits** + +This example describes the Auto Scaling limits for your AWS account:: + + aws autoscaling describe-account-limits + +The following is example output:: + + { + "NumberOfLaunchConfigurations": 5, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "MaxNumberOfAutoScalingGroups": 20 + } + +For more information, see `Amazon EC2 Auto Scaling Limits`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Amazon EC2 Auto Scaling Limits`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-account-limits.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-adjustment-types.rst b/aws/dist/awscli/examples/autoscaling/describe-adjustment-types.rst new file mode 100644 index 00000000..9ee213da --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-adjustment-types.rst @@ -0,0 +1,25 @@ +**To describe the Auto Scaling adjustment types** + +This example describes the available adjustment types:: + + aws autoscaling describe-adjustment-types + +The following is example output:: + + { + "AdjustmentTypes": [ + { + "AdjustmentType": "ChangeInCapacity" + }, + { + "AdjustmentType": "ExactCapcity" + }, + { + "AdjustmentType": "PercentChangeInCapacity" + } + ] + } + +For more information, see `Scaling Adjustment Types`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Scaling Adjustment Types`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html#as-scaling-adjustment diff --git a/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-groups.rst b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-groups.rst new file mode 100644 index 00000000..c311ff72 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-groups.rst @@ -0,0 +1,61 @@ +**To get a description of an Auto Scaling group** + +This example describes the specified Auto Scaling group:: + + aws autoscaling describe-auto-scaling-groups --auto-scaling-group-name my-auto-scaling-group + +This example describes the specified Auto Scaling groups. It allows you to specify up to 100 group names:: + + aws autoscaling describe-auto-scaling-groups --max-items 100 --auto-scaling-group-name "group1" "group2" "group3" "group4" + +This example describes the Auto Scaling groups in the specified region, up to a maximum of 75 groups:: + + aws autoscaling describe-auto-scaling-groups --max-items 75 --region us-east-1 + +The following is example output:: + + { + "AutoScalingGroups": [ + { + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group", + "HealthCheckGracePeriod": 300, + "SuspendedProcesses": [], + "DesiredCapacity": 1, + "Tags": [], + "EnabledMetrics": [], + "LoadBalancerNames": [], + "AutoScalingGroupName": "my-auto-scaling-group", + "DefaultCooldown": 300, + "MinSize": 0, + "Instances": [ + { + "InstanceId": "i-4ba0837f", + "AvailabilityZone": "us-west-2c", + "HealthStatus": "Healthy", + "LifecycleState": "InService", + "LaunchConfigurationName": "my-launch-config" + } + ], + "MaxSize": 1, + "VPCZoneIdentifier": null, + "TerminationPolicies": [ + "Default" + ], + "LaunchConfigurationName": "my-launch-config", + "CreatedTime": "2013-08-19T20:53:25.584Z", + "AvailabilityZones": [ + "us-west-2c" + ], + "HealthCheckType": "EC2", + "NewInstancesProtectedFromScaleIn": false + } + ] + } + +To return a specific number of Auto Scaling groups, use the ``max-items`` parameter:: + + aws autoscaling describe-auto-scaling-groups --max-items 1 + +If the output includes a ``NextToken`` field, there are more groups. To get the additional groups, use the value of this field with the ``starting-token`` parameter in a subsequent call as follows:: + + aws autoscaling describe-auto-scaling-groups --starting-token Z3M3LMPEXAMPLE diff --git a/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-instances.rst b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-instances.rst new file mode 100644 index 00000000..b43ff7a9 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-instances.rst @@ -0,0 +1,46 @@ +**To describe one or more instances** + +This example describes the specified instance:: + + aws autoscaling describe-auto-scaling-instances --instance-ids i-4ba0837f + +The following is example output:: + + { + "AutoScalingInstances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "InstanceId": "i-4ba0837f", + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthStatus": "HEALTHY", + "LifecycleState": "InService", + "LaunchConfigurationName": "my-launch-config" + } + ] + } + +This example uses the ``max-items`` parameter to specify how many instances to return with this call:: + + aws autoscaling describe-auto-scaling-instances --max-items 1 + +The following is example output:: + + { + "NextToken": "Z3M3LMPEXAMPLE", + "AutoScalingInstances": [ + { + "ProtectedFromScaleIn": false, + "AvailabilityZone": "us-west-2c", + "InstanceId": "i-4ba0837f", + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthStatus": "HEALTHY", + "LifecycleState": "InService", + "LaunchConfigurationName": "my-launch-config" + } + ] + } + +If the output includes a ``NextToken`` field, there are more instances. To get the additional instances, use the value of this field with the ``starting-token`` parameter in a subsequent call as follows:: + + aws autoscaling describe-auto-scaling-instances --starting-token Z3M3LMPEXAMPLE diff --git a/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst new file mode 100644 index 00000000..c0830bb7 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-auto-scaling-notification-types.rst @@ -0,0 +1,21 @@ +**To describe the Auto Scaling notification types** + +This example describes the available notification types:: + + aws autoscaling describe-auto-scaling-notification-types + +The following is example output:: + + { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + } + +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-launch-configurations.rst b/aws/dist/awscli/examples/autoscaling/describe-launch-configurations.rst new file mode 100644 index 00000000..97d188eb --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-launch-configurations.rst @@ -0,0 +1,68 @@ +**To describe Auto Scaling launch configurations** + +This example describes the specified launch configuration:: + + aws autoscaling describe-launch-configurations --launch-configuration-names my-launch-config + +The following is example output:: + + { + "LaunchConfigurations": [ + { + "UserData": null, + "EbsOptimized": false, + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "InstanceMonitoring": { + "Enabled": true + }, + "ImageId": "ami-043a5034", + "CreatedTime": "2014-05-07T17:39:28.599Z", + "BlockDeviceMappings": [], + "KeyName": null, + "SecurityGroups": [ + "sg-67ef0308" + ], + "LaunchConfigurationName": "my-launch-config", + "KernelId": null, + "RamdiskId": null, + "InstanceType": "t1.micro", + "AssociatePublicIpAddress": true + } + ] + } + +To return a specific number of launch configurations, use the ``max-items`` parameter:: + + aws autoscaling describe-launch-configurations --max-items 1 + +The following is example output:: + + { + "NextToken": "Z3M3LMPEXAMPLE", + "LaunchConfigurations": [ + { + "UserData": null, + "EbsOptimized": false, + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "InstanceMonitoring": { + "Enabled": true + }, + "ImageId": "ami-043a5034", + "CreatedTime": "2014-05-07T17:39:28.599Z", + "BlockDeviceMappings": [], + "KeyName": null, + "SecurityGroups": [ + "sg-67ef0308" + ], + "LaunchConfigurationName": "my-launch-config", + "KernelId": null, + "RamdiskId": null, + "InstanceType": "t1.micro", + "AssociatePublicIpAddress": true + } + ] + } + +If the output includes a ``NextToken`` field, there are more launch configurations. To get the additional launch configurations, use the value of this field with the ``starting-token`` parameter in a subsequent call as follows:: + + aws autoscaling describe-launch-configurations --starting-token Z3M3LMPEXAMPLE diff --git a/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hook-types.rst b/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hook-types.rst new file mode 100644 index 00000000..3fdba4d8 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hook-types.rst @@ -0,0 +1,14 @@ +**To describe the available types of lifecycle hooks** + +This example describes the available lifecycle hook types:: + + aws autoscaling describe-lifecycle-hook-types + +The following is example output:: + + { + "LifecycleHookTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCHING", + "autoscaling:EC2_INSTANCE_TERMINATING" + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hooks.rst b/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hooks.rst new file mode 100644 index 00000000..387738ff --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-lifecycle-hooks.rst @@ -0,0 +1,22 @@ +**To describe your lifecycle hooks** + +This example describes the lifecycle hooks for the specified Auto Scaling group:: + + aws autoscaling describe-lifecycle-hooks --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "LifecycleHooks": [ + { + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role", + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "DefaultResult": "ABANDON", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/describe-load-balancer-target-groups.rst b/aws/dist/awscli/examples/autoscaling/describe-load-balancer-target-groups.rst new file mode 100755 index 00000000..00f19889 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-load-balancer-target-groups.rst @@ -0,0 +1,16 @@ +**To describe the target groups for an Auto Scaling group** + +This example describes the target groups attached to the specified Auto Scaling group:: + + aws autoscaling describe-load-balancer-target-groups --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "LoadBalancerTargetGroups": [ + { + "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "State": "Added" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/describe-load-balancers.rst b/aws/dist/awscli/examples/autoscaling/describe-load-balancers.rst new file mode 100644 index 00000000..a6a32482 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-load-balancers.rst @@ -0,0 +1,16 @@ +**To describe the load balancers for an Auto Scaling group** + +This example describes the load balancers for the specified Auto Scaling group:: + + aws autoscaling describe-load-balancers --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "LoadBalancers": [ + { + "State": "Added", + "LoadBalancerName": "my-load-balancer" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/describe-metric-collection-types.rst b/aws/dist/awscli/examples/autoscaling/describe-metric-collection-types.rst new file mode 100644 index 00000000..2ef5cacf --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-metric-collection-types.rst @@ -0,0 +1,45 @@ +**To describe the Auto Scaling metric collection types** + +This example describes the available metric collection types:: + + aws autoscaling describe-metric-collection-types + +The following is example output:: + + { + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ], + "Granularities": [ + { + "Granularity": "1Minute" + } + ] + } + +For more information, see `Auto Scaling Group Metrics`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Auto Scaling Group Metrics`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html#as-group-metrics diff --git a/aws/dist/awscli/examples/autoscaling/describe-notification-configurations.rst b/aws/dist/awscli/examples/autoscaling/describe-notification-configurations.rst new file mode 100644 index 00000000..c1436859 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-notification-configurations.rst @@ -0,0 +1,47 @@ +**To describe the Auto Scaling notification configurations** + +This example describes the notification configurations for the specified Auto Scaling group:: + + aws autoscaling describe-notification-configurations --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + } + +To return a specific number of notification configurations, use the ``max-items`` parameter:: + + aws autoscaling describe-notification-configurations --auto-scaling-group-name my-auto-scaling-group --max-items 1 + +The following is example output:: + + { + "NextToken": "Z3M3LMPEXAMPLE", + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + } + ] + } + +Use the ``NextToken`` field with the ``starting-token`` parameter in a subsequent call to get additional notification configurations:: + + aws autoscaling describe-notification-configurations --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE + +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-policies.rst b/aws/dist/awscli/examples/autoscaling/describe-policies.rst new file mode 100644 index 00000000..3ae2e316 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-policies.rst @@ -0,0 +1,62 @@ +**To describe Auto Scaling policies** + +This example describes the policies for the specified Auto Scaling group:: + + aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "ScalingPolicies": [ + { + "PolicyName": "ScaleIn", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "AdjustmentType": "ChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": -1 + }, + { + "PolicyName": "ScalePercentChange", + "MinAdjustmentStep": 2, + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "Cooldown": 60, + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": 25 + } + ] + } + +To return specific scaling policies, use the ``policy-names`` parameter:: + + aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --policy-names ScaleIn + +To return a specific number of policies, use the ``max-items`` parameter:: + + aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --max-items 1 + +The following is example output:: + + { + "ScalingPolicies": [ + { + "PolicyName": "ScaleIn", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "AdjustmentType": "ChangeInCapacity", + "Alarms": [], + "ScalingAdjustment": -1 + } + ], + "NextToken": "Z3M3LMPEXAMPLE" + } + +If the output includes a ``NextToken`` field, use the value of this field with the ``starting-token`` parameter in a subsequent call to get the additional policies:: + + aws autoscaling describe-policies --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE + +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-scaling-activities.rst b/aws/dist/awscli/examples/autoscaling/describe-scaling-activities.rst new file mode 100644 index 00000000..b5fc177f --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-scaling-activities.rst @@ -0,0 +1,35 @@ +**To get a description of the scaling activities for an Auto Scaling group** + +This example describes the scaling activities for the specified Auto Scaling group:: + + aws autoscaling describe-scaling-activities --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "Activities": [ + { + "Description": "Launching a new EC2 instance: i-4ba0837f", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", + "Details": "{"Availability Zone":"us-west-2c"}", + "StartTime": "2013-08-19T20:53:29.930Z", + "Progress": 100, + "EndTime": "2013-08-19T20:54:02Z", + "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", + "StatusCode": "Successful" + } + ] + } + +To describe a specific scaling activity, use the ``activity-ids`` parameter:: + + aws autoscaling describe-scaling-activities --activity-ids b55c7b67-c8aa-4d10-b240-730ff91d8895 + +To return a specific number of activities, use the ``max-items`` parameter:: + + aws autoscaling describe-scaling-activities --max-items 1 + +If the output includes a ``NextToken`` field, there are more activities. To get the additional activities, use the value of this field with the ``starting-token`` parameter in a subsequent call as follows:: + + aws autoscaling describe-scaling-activities --starting-token Z3M3LMPEXAMPLE diff --git a/aws/dist/awscli/examples/autoscaling/describe-scaling-process-types.rst b/aws/dist/awscli/examples/autoscaling/describe-scaling-process-types.rst new file mode 100644 index 00000000..7e4b9b2f --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-scaling-process-types.rst @@ -0,0 +1,40 @@ +**To describe the Auto Scaling process types** + +This example describes the Auto Scaling process types:: + + aws autoscaling describe-scaling-process-types + +The following is example output:: + + { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + } + +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-scheduled-actions.rst b/aws/dist/awscli/examples/autoscaling/describe-scheduled-actions.rst new file mode 100644 index 00000000..e26b4cca --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-scheduled-actions.rst @@ -0,0 +1,70 @@ +**To describe scheduled actions** + +This example describes all your scheduled actions:: + + aws autoscaling describe-scheduled-actions + +The following is example output:: + + { + "ScheduledUpdateGroupActions": [ + { + "MinSize": 2, + "DesiredCapacity": 4, + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 6, + "Recurrence": "30 0 1 12 *", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2019-12-01T00:30:00Z", + "Time": "2019-12-01T00:30:00Z" + } + ] + } + +To describe the scheduled actions for a specific Auto Scaling group, use the ``auto-scaling-group-name`` parameter:: + + aws autoscaling describe-scheduled-actions --auto-scaling-group-name my-auto-scaling-group + +To describe a specific scheduled action, use the ``scheduled-action-names`` parameter:: + + aws autoscaling describe-scheduled-actions --scheduled-action-names my-scheduled-action + +To describe the scheduled actions that start at a specific time, use the ``start-time`` parameter:: + + aws autoscaling describe-scheduled-actions --start-time "2019-12-01T00:30:00Z" + +To describe the scheduled actions that end at a specific time, use the ``end-time`` parameter:: + + aws autoscaling describe-scheduled-actions --end-time "2022-12-01T00:30:00Z" + +To return a specific number of scheduled actions, use the ``max-items`` parameter:: + + aws autoscaling describe-scheduled-actions --auto-scaling-group-name my-auto-scaling-group --max-items 1 + +The following is example output:: + + { + "NextToken": "Z3M3LMPEXAMPLE", + "ScheduledUpdateGroupActions": [ + { + "MinSize": 2, + "DesiredCapacity": 4, + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 6, + "Recurrence": "30 0 1 12 *", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2019-12-01T00:30:00Z", + "Time": "2019-12-01T00:30:00Z" + } + ] + } + +Use the ``NextToken`` field with the ``starting-token`` parameter in a subsequent call to get the additional scheduled actions:: + + aws autoscaling describe-scheduled-actions --auto-scaling-group-name my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE + +For more information, see `Scheduled Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Scheduled Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-tags.rst b/aws/dist/awscli/examples/autoscaling/describe-tags.rst new file mode 100644 index 00000000..041d8bbe --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-tags.rst @@ -0,0 +1,57 @@ +**To describe tags** + +This example describes all your tags:: + + aws autoscaling describe-tags + +The following is example output:: + + { + "Tags": [ + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "Research", + "Key": "Dept" + }, + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "WebServer", + "Key": "Role" + } + ] + } + +To describe tags for a specific Auto Scaling group, use the ``filters`` parameter:: + + aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-auto-scaling-group + +To return a specific number of tags, use the ``max-items`` parameter:: + + aws autoscaling describe-tags --max-items 1 + +The following is example output:: + + { + "NextToken": "Z3M3LMPEXAMPLE", + "Tags": [ + { + "ResourceType": "auto-scaling-group", + "ResourceId": "my-auto-scaling-group", + "PropagateAtLaunch": true, + "Value": "Research", + "Key": "Dept" + } + ] + } + +Use the ``NextToken`` field with the ``starting-token`` parameter in a subsequent call to get the additional tags:: + + aws autoscaling describe-tags --filters Name=auto-scaling-group,Values=my-auto-scaling-group --starting-token Z3M3LMPEXAMPLE + +For more information, see `Tagging Auto Scaling Groups and Instances`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Tagging Auto Scaling Groups and Instances`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-tagging.html diff --git a/aws/dist/awscli/examples/autoscaling/describe-termination-policy-types.rst b/aws/dist/awscli/examples/autoscaling/describe-termination-policy-types.rst new file mode 100644 index 00000000..aa076109 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/describe-termination-policy-types.rst @@ -0,0 +1,23 @@ +**To describe termination policy types** + +This example describes the available termination policy types:: + + aws autoscaling describe-termination-policy-types + +The following is example output:: + + { + "TerminationPolicyTypes": [ + "AllocationStrategy", + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration", + "OldestLaunchTemplate" + ] + } + +For more information, see `Controlling Which Instances Auto Scaling Terminates During Scale In`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Controlling Which Instances Auto Scaling Terminates During Scale In`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-termination.html diff --git a/aws/dist/awscli/examples/autoscaling/detach-instances.rst b/aws/dist/awscli/examples/autoscaling/detach-instances.rst new file mode 100644 index 00000000..bbaac0d8 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/detach-instances.rst @@ -0,0 +1,22 @@ +**To detach an instance from an Auto Scaling group** + +This example detaches the specified instance from the specified Auto Scaling group:: + + aws autoscaling detach-instances --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group --should-decrement-desired-capacity + +The following is example output:: + + { + "Activities": [ + { + "Description": "Detaching EC2 instance: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "Details": {"Availability Zone": "us-west-2a"}, + "StartTime": "2015-04-12T15:02:16.179Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/detach-load-balancer-target-groups.rst b/aws/dist/awscli/examples/autoscaling/detach-load-balancer-target-groups.rst new file mode 100755 index 00000000..22359e22 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/detach-load-balancer-target-groups.rst @@ -0,0 +1,5 @@ +**To detach a target group from an Auto Scaling group** + +This example detaches the specified target group from the specified Auto Scaling group:: + + aws autoscaling detach-load-balancer-target-groups --auto-scaling-group-name my-auto-scaling-group --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 diff --git a/aws/dist/awscli/examples/autoscaling/detach-load-balancers.rst b/aws/dist/awscli/examples/autoscaling/detach-load-balancers.rst new file mode 100644 index 00000000..9839e6fd --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/detach-load-balancers.rst @@ -0,0 +1,5 @@ +**To detach a load balancer from an Auto Scaling group** + +This example detaches the specified load balancer from the specified Auto Scaling group:: + + aws autoscaling detach-load-balancers --load-balancer-names my-load-balancer --auto-scaling-group-name my-auto-scaling-group diff --git a/aws/dist/awscli/examples/autoscaling/disable-metrics-collection.rst b/aws/dist/awscli/examples/autoscaling/disable-metrics-collection.rst new file mode 100644 index 00000000..a6a9cc69 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/disable-metrics-collection.rst @@ -0,0 +1,9 @@ +**To disable metrics collection for an Auto Scaling group** + +This example disables collecting data for the ``GroupDesiredCapacity`` metric for the specified Auto Scaling group:: + + aws autoscaling disable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --metrics GroupDesiredCapacity + +For more information, see `Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html diff --git a/aws/dist/awscli/examples/autoscaling/enable-metrics-collection.rst b/aws/dist/awscli/examples/autoscaling/enable-metrics-collection.rst new file mode 100644 index 00000000..3b0d6b96 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/enable-metrics-collection.rst @@ -0,0 +1,13 @@ +**To enable metrics collection for an Auto Scaling group** + +This example enables data collection for the specified Auto Scaling group:: + + aws autoscaling enable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --granularity "1Minute" + +To collect data for a specific metric, use the ``metrics`` parameter:: + + aws autoscaling enable-metrics-collection --auto-scaling-group-name my-auto-scaling-group --metrics GroupDesiredCapacity --granularity "1Minute" + +For more information, see `Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Monitoring Your Auto Scaling Groups and Instances Using Amazon CloudWatch`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-instance-monitoring.html diff --git a/aws/dist/awscli/examples/autoscaling/enter-standby.rst b/aws/dist/awscli/examples/autoscaling/enter-standby.rst new file mode 100644 index 00000000..57fff4ab --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/enter-standby.rst @@ -0,0 +1,22 @@ +**To move instances into standby mode** + +This example puts the specified instance into standby mode:: + + aws autoscaling enter-standby --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group --should-decrement-desired-capacity + +The following is example output:: + + { + "Activities": [ + { + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "Details": {"Availability Zone": "us-west-2a"}, + "StartTime": "2015-04-12T15:10:23.640Z", + "Progress": 50, + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "StatusCode": "InProgress" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/execute-policy.rst b/aws/dist/awscli/examples/autoscaling/execute-policy.rst new file mode 100644 index 00000000..a9d7d9c0 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/execute-policy.rst @@ -0,0 +1,9 @@ +**To execute an Auto Scaling policy** + +This example executes the specified Auto Scaling policy for the specified Auto Scaling group:: + + aws autoscaling execute-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn --honor-cooldown + +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff --git a/aws/dist/awscli/examples/autoscaling/exit-standby.rst b/aws/dist/awscli/examples/autoscaling/exit-standby.rst new file mode 100644 index 00000000..64eff025 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/exit-standby.rst @@ -0,0 +1,22 @@ +**To move instances out of standby mode** + +This example moves the specified instance out of standby mode:: + + aws autoscaling exit-standby --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group + +The following is example output:: + + { + "Activities": [ + { + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "AutoScalingGroupName": "my-auto-scaling-group", + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "Details": {"Availability Zone": "us-west-2a"}, + "StartTime": "2015-04-12T15:14:29.886Z", + "Progress": 30, + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "StatusCode": "PreInService" + } + ] + } diff --git a/aws/dist/awscli/examples/autoscaling/put-lifecycle-hook.rst b/aws/dist/awscli/examples/autoscaling/put-lifecycle-hook.rst new file mode 100644 index 00000000..8f4e5efa --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/put-lifecycle-hook.rst @@ -0,0 +1,9 @@ +**To create a lifecycle hook** + +This example creates a lifecycle hook:: + + aws autoscaling put-lifecycle-hook --lifecycle-hook-name my-lifecycle-hook --auto-scaling-group-name my-auto-scaling-group --lifecycle-transition autoscaling:EC2_INSTANCE_LAUNCHING --notification-target-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn arn:aws:iam::123456789012:role/my-auto-scaling-role + +For more information, see `Add Lifecycle Hooks`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Add Lifecycle Hooks`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html#adding-lifecycle-hooks diff --git a/aws/dist/awscli/examples/autoscaling/put-notification-configuration.rst b/aws/dist/awscli/examples/autoscaling/put-notification-configuration.rst new file mode 100644 index 00000000..bd800a2b --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/put-notification-configuration.rst @@ -0,0 +1,9 @@ +**To add an Auto Scaling notification** + +This example adds the specified notification to the specified Auto Scaling group:: + + aws autoscaling put-notification-configuration --auto-scaling-group-name my-auto-scaling-group --topic-arn arn:aws:sns:us-west-2:123456789012:my-sns-topic --notification-type autoscaling:TEST_NOTIFICATION + +For more information, see `Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Getting Amazon SNS Notifications When Your Auto Scaling Group Scales`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html#as-configure-asg-for-sns diff --git a/aws/dist/awscli/examples/autoscaling/put-scaling-policy.rst b/aws/dist/awscli/examples/autoscaling/put-scaling-policy.rst new file mode 100644 index 00000000..59fc5188 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/put-scaling-policy.rst @@ -0,0 +1,20 @@ +**To add a scaling policy to an Auto Scaling group** + +This example adds a simple scaling policy to the specified Auto Scaling group:: + + aws autoscaling put-scaling-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScaleIn --scaling-adjustment -1 --adjustment-type ChangeInCapacity + +To change the size of the Auto Scaling group by a specific number of instances, set the ``adjustment-type`` parameter to ``PercentChangeInCapacity``. Then, assign a value to +the ``min-adjustment-step`` parameter, where the value represents the number of instances the policy adds or removes from the Auto Scaling group:: + + aws autoscaling put-scaling-policy --auto-scaling-group-name my-auto-scaling-group --policy-name ScalePercentChange --scaling-adjustment 25 --adjustment-type PercentChangeInCapacity --cooldown 60 --min-adjustment-step 2 + +The output includes the ARN of the policy. The following is example output:: + + { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn" + } + +For more information, see `Dynamic Scaling`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Dynamic Scaling`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-scale-based-on-demand.html diff --git a/aws/dist/awscli/examples/autoscaling/put-scheduled-update-group-action.rst b/aws/dist/awscli/examples/autoscaling/put-scheduled-update-group-action.rst new file mode 100644 index 00000000..dc2239c0 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/put-scheduled-update-group-action.rst @@ -0,0 +1,13 @@ +**To add a scheduled action to an Auto Scaling group** + +This example adds the specified scheduled action to the specified Auto Scaling group:: + + aws autoscaling put-scheduled-update-group-action --auto-scaling-group-name my-auto-scaling-group --scheduled-action-name my-scheduled-action --start-time "2014-05-12T08:00:00Z" --end-time "2014-05-12T08:00:00Z" --min-size 2 --max-size 6 --desired-capacity 4 + +This example creates a scheduled action to scale on a recurring schedule that is scheduled to execute at 00:30 hours on the first of January, June, and December every year:: + + aws autoscaling put-scheduled-update-group-action --auto-scaling-group-name my-auto-scaling-group --scheduled-action-name my-scheduled-action --recurrence "30 0 1 1,6,12 *" --min-size 2 --max-size 6 --desired-capacity 4 + +For more information, see `Scheduled Scaling`__ in the *Amazon EC2 Auto Scaling User Guide*. + +.. __: https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/autoscaling/record-lifecycle-action-heartbeat.rst b/aws/dist/awscli/examples/autoscaling/record-lifecycle-action-heartbeat.rst new file mode 100644 index 00000000..ba4b4fac --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/record-lifecycle-action-heartbeat.rst @@ -0,0 +1,5 @@ +**To record a lifecycle action heartbeat** + +This example records a lifecycle action heartbeat to keep the instance in a pending state:: + + aws autoscaling record-lifecycle-action-heartbeat --lifecycle-hook-name my-lifecycle-hook --auto-scaling-group-name my-auto-scaling-group --lifecycle-action-token bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635 diff --git a/aws/dist/awscli/examples/autoscaling/resume-processes.rst b/aws/dist/awscli/examples/autoscaling/resume-processes.rst new file mode 100644 index 00000000..b615c473 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/resume-processes.rst @@ -0,0 +1,9 @@ +**To resume Auto Scaling processes** + +This example resumes the specified suspended scaling process for the specified Auto Scaling group:: + + aws autoscaling resume-processes --auto-scaling-group-name my-auto-scaling-group --scaling-processes AlarmNotification + +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff --git a/aws/dist/awscli/examples/autoscaling/set-desired-capacity.rst b/aws/dist/awscli/examples/autoscaling/set-desired-capacity.rst new file mode 100644 index 00000000..09afd638 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/set-desired-capacity.rst @@ -0,0 +1,5 @@ +**To set the desired capacity for an Auto Scaling group** + +This example sets the desired capacity for the specified Auto Scaling group:: + + aws autoscaling set-desired-capacity --auto-scaling-group-name my-auto-scaling-group --desired-capacity 2 --honor-cooldown diff --git a/aws/dist/awscli/examples/autoscaling/set-instance-health.rst b/aws/dist/awscli/examples/autoscaling/set-instance-health.rst new file mode 100644 index 00000000..7d337f99 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/set-instance-health.rst @@ -0,0 +1,5 @@ +**To set the health status of an instance** + +This example sets the health status of the specified instance to ``Unhealthy``:: + + aws autoscaling set-instance-health --instance-id i-93633f9b --health-status Unhealthy diff --git a/aws/dist/awscli/examples/autoscaling/set-instance-protection.rst b/aws/dist/awscli/examples/autoscaling/set-instance-protection.rst new file mode 100644 index 00000000..297ff037 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/set-instance-protection.rst @@ -0,0 +1,9 @@ +**To change the instance protection setting for an instance** + +This example enables instance protection for the specified instance:: + + aws autoscaling set-instance-protection --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group --protected-from-scale-in + +This example disables instance protection for the specified instance:: + + aws autoscaling set-instance-protection --instance-ids i-93633f9b --auto-scaling-group-name my-auto-scaling-group --no-protected-from-scale-in diff --git a/aws/dist/awscli/examples/autoscaling/suspend-processes.rst b/aws/dist/awscli/examples/autoscaling/suspend-processes.rst new file mode 100644 index 00000000..e5ac07e5 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/suspend-processes.rst @@ -0,0 +1,9 @@ +**To suspend Auto Scaling processes** + +This example suspends the specified scaling process for the specified Auto Scaling group:: + + aws autoscaling suspend-processes --auto-scaling-group-name my-auto-scaling-group --scaling-processes AlarmNotification + +For more information, see `Suspending and Resuming Scaling Processes`_ in the *Amazon EC2 Auto Scaling User Guide*. + +.. _`Suspending and Resuming Scaling Processes`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html diff --git a/aws/dist/awscli/examples/autoscaling/terminate-instance-in-auto-scaling-group.rst b/aws/dist/awscli/examples/autoscaling/terminate-instance-in-auto-scaling-group.rst new file mode 100644 index 00000000..da544c14 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/terminate-instance-in-auto-scaling-group.rst @@ -0,0 +1,7 @@ +**To terminate an instance in an Auto Scaling group** + +This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group:: + + aws autoscaling terminate-instance-in-auto-scaling-group --instance-id i-93633f9b --no-should-decrement-desired-capacity + +Auto Scaling launches a replacement instance after the specified instance terminates. diff --git a/aws/dist/awscli/examples/autoscaling/update-auto-scaling-group.rst b/aws/dist/awscli/examples/autoscaling/update-auto-scaling-group.rst new file mode 100644 index 00000000..82561889 --- /dev/null +++ b/aws/dist/awscli/examples/autoscaling/update-auto-scaling-group.rst @@ -0,0 +1,21 @@ +**To update an Auto Scaling group** + +This example updates the specified Auto Scaling group to use Elastic Load Balancing health checks:: + + aws autoscaling update-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --health-check-type ELB --health-check-grace-period 60 + +This example updates the launch configuration, minimum and maximum size of the group, and which subnet to use:: + + aws autoscaling update-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --launch-configuration-name new-launch-config --min-size 1 --max-size 3 --vpc-zone-identifier subnet-41767929 + +This example updates the desired capacity, default cooldown, placement group, termination policy, and which Availability Zone to use:: + + aws autoscaling update-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --default-cooldown 600 --placement-group my-placement-group --termination-policies "OldestInstance" --availability-zones us-west-2c + +This example enables the instance protection setting for the specified Auto Scaling group:: + + aws autoscaling update-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --new-instances-protected-from-scale-in + +This example disables the instance protection setting for the specified Auto Scaling group:: + + aws autoscaling update-auto-scaling-group --auto-scaling-group-name my-auto-scaling-group --no-new-instances-protected-from-scale-in diff --git a/aws/dist/awscli/examples/backup/create-backup-plan.rst b/aws/dist/awscli/examples/backup/create-backup-plan.rst new file mode 100644 index 00000000..bca09e7d --- /dev/null +++ b/aws/dist/awscli/examples/backup/create-backup-plan.rst @@ -0,0 +1,17 @@ +**To create a backup plan** + +The following ``create-backup-plan`` example creates the specified backup plan with a 35 day retention. :: + + aws backup create-backup-plan \ + --backup-plan "{\"BackupPlanName\":\"Example-Backup-Plan\",\"Rules\":[{\"RuleName\":\"DailyBackups\",\"ScheduleExpression\":\"cron(0 5 ? * * *)\",\"StartWindowMinutes\":480,\"TargetBackupVaultName\":\"Default\",\"Lifecycle\":{\"DeleteAfterDays\":35}}]}" + +Output:: + + { + "BackupPlanId": "1fa3895c-a7f5-484a-a371-2dd6a1a9f729", + "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:1fa3895c-a7f5-484a-a371-2dd6a1a9f729", + "CreationDate": 1568928754.747, + "VersionId": "ZjQ2ZTI5YWQtZDg5Yi00MzYzLWJmZTAtMDI1MzhlMDhjYjEz" + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff --git a/aws/dist/awscli/examples/backup/create-backup-vault.rst b/aws/dist/awscli/examples/backup/create-backup-vault.rst new file mode 100644 index 00000000..c0382cec --- /dev/null +++ b/aws/dist/awscli/examples/backup/create-backup-vault.rst @@ -0,0 +1,17 @@ +**To create a backup vault** + +The following ``create-backup-vault`` example creates a backup vault with the specified name. :: + + aws backup create-backup-vault + --backup-vault-name sample-vault + +This command produces no output. +Output:: + + { + "BackupVaultName": "sample-vault", + "BackupVaultArn": "arn:aws:backup:us-west-2:123456789012:backup-vault:sample-vault", + "CreationDate": 1568928338.385 + } + +For more information, see `Creating a Backup Vault `__ in the *AWS Backup Developer Guide*. diff --git a/aws/dist/awscli/examples/backup/get-backup-plan-from-template.rst b/aws/dist/awscli/examples/backup/get-backup-plan-from-template.rst new file mode 100644 index 00000000..7fb065d3 --- /dev/null +++ b/aws/dist/awscli/examples/backup/get-backup-plan-from-template.rst @@ -0,0 +1,25 @@ +**To get an existing backup plan from a template** + +The following ``get-backup-plan-from-template`` example gets an existing backup plan from a template that specifies a daily backup with a 35 day retention. :: + + aws backup get-backup-plan-from-template \ + --backup-plan-template-id "87c0c1ef-254d-4180-8fef-2e76a2c38aaa" + +Output:: + + { + "BackupPlanDocument": { + "Rules": [ + { + "RuleName": "DailyBackups", + "ScheduleExpression": "cron(0 5 ? * * *)", + "StartWindowMinutes": 480, + "Lifecycle": { + "DeleteAfterDays": 35 + } + } + ] + } + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff --git a/aws/dist/awscli/examples/backup/get-backup-plan.rst b/aws/dist/awscli/examples/backup/get-backup-plan.rst new file mode 100644 index 00000000..14ae8e3d --- /dev/null +++ b/aws/dist/awscli/examples/backup/get-backup-plan.rst @@ -0,0 +1,33 @@ +**To get the details of a backup plan** + +The following ``get-backup-plan`` example displays the details of the specified backup plan. :: + + aws backup get-backup-plan \ + --backup-plan-id "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5" + +Output:: + + { + "BackupPlan": { + "BackupPlanName": "Example-Backup-Plan", + "Rules": [ + { + "RuleName": "DailyBackups", + "TargetBackupVaultName": "Default", + "ScheduleExpression": "cron(0 5 ? * * *)", + "StartWindowMinutes": 480, + "CompletionWindowMinutes": 10080, + "Lifecycle": { + "DeleteAfterDays": 35 + }, + "RuleId": "70e0ccdc-e9df-4e83-82ad-c1e5a9471cc3" + } + ] + }, + "BackupPlanId": "fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", + "BackupPlanArn": "arn:aws:backup:us-west-2:123456789012:backup-plan:fcbf5d8f-bd77-4f3a-9c97-f24fb3d373a5", + "VersionId": "NjQ2ZTZkODktMGVhNy00MmQ0LWE4YjktZTkwNTQ3OTkyYTcw", + "CreationDate": 1568926091.57 + } + +For more information, see `Creating a Backup Plan `__ in the *AWS Backup Developer Guide*. diff --git a/aws/dist/awscli/examples/batch/cancel-job.rst b/aws/dist/awscli/examples/batch/cancel-job.rst new file mode 100644 index 00000000..4cdd8810 --- /dev/null +++ b/aws/dist/awscli/examples/batch/cancel-job.rst @@ -0,0 +1,7 @@ +**To cancel a job** + +This example cancels a job with the specified job ID. + +Command:: + + aws batch cancel-job --job-id bcf0b186-a532-4122-842e-2ccab8d54efb --reason "Cancelling job." diff --git a/aws/dist/awscli/examples/batch/create-compute-environment.rst b/aws/dist/awscli/examples/batch/create-compute-environment.rst new file mode 100644 index 00000000..5512f994 --- /dev/null +++ b/aws/dist/awscli/examples/batch/create-compute-environment.rst @@ -0,0 +1,97 @@ +**To create a managed compute environment with On-Demand instances** + +This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called `C4OnDemand`. + +Command:: + + aws batch create-compute-environment --cli-input-json file:///C4OnDemand.json + +JSON file format:: + + { + "computeEnvironmentName": "C4OnDemand", + "type": "MANAGED", + "state": "ENABLED", + "computeResources": { + "type": "EC2", + "minvCpus": 0, + "maxvCpus": 128, + "desiredvCpus": 48, + "instanceTypes": [ + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "tags": { + "Name": "Batch Instance - C4OnDemand" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" + } + +Output:: + + { + "computeEnvironmentName": "C4OnDemand", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" + } + +**To create a managed compute environment with Spot Instances** + +This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called `M4Spot`. + +Command:: + + aws batch create-compute-environment --cli-input-json file:///M4Spot.json + +JSON file format:: + + { + "computeEnvironmentName": "M4Spot", + "type": "MANAGED", + "state": "ENABLED", + "computeResources": { + "type": "SPOT", + "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", + "minvCpus": 0, + "maxvCpus": 128, + "desiredvCpus": 4, + "instanceTypes": [ + "m4" + ], + "bidPercentage": 20, + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "tags": { + "Name": "Batch Instance - M4Spot" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" + } + +Output:: + + { + "computeEnvironmentName": "M4Spot", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" + } diff --git a/aws/dist/awscli/examples/batch/create-job-queue.rst b/aws/dist/awscli/examples/batch/create-job-queue.rst new file mode 100644 index 00000000..c5671817 --- /dev/null +++ b/aws/dist/awscli/examples/batch/create-job-queue.rst @@ -0,0 +1,61 @@ +**To create a low priority job queue with a single compute environment** + +This example creates a job queue called `LowPriority` that uses the `M4Spot` compute environment. + +Command:: + + aws batch create-job-queue --cli-input-json file:///LowPriority.json + +JSON file format:: + + { + "jobQueueName": "LowPriority", + "state": "ENABLED", + "priority": 10, + "computeEnvironmentOrder": [ + { + "order": 1, + "computeEnvironment": "M4Spot" + } + ] + } + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", + "jobQueueName": "LowPriority" + } + +**To create a high priority job queue with two compute environments** + +This example creates a job queue called `HighPriority` that uses the `C4OnDemand` compute environment with an order of 1 and the `M4Spot` compute environment with an order of 2. The scheduler will attempt to place jobs on the `C4OnDemand` compute environment first. + +Command:: + + aws batch create-job-queue --cli-input-json file:///HighPriority.json + +JSON file format:: + + { + "jobQueueName": "HighPriority", + "state": "ENABLED", + "priority": 1, + "computeEnvironmentOrder": [ + { + "order": 1, + "computeEnvironment": "C4OnDemand" + }, + { + "order": 2, + "computeEnvironment": "M4Spot" + } + ] + } + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority" + } diff --git a/aws/dist/awscli/examples/batch/delete-compute-environment.rst b/aws/dist/awscli/examples/batch/delete-compute-environment.rst new file mode 100644 index 00000000..f4d5343b --- /dev/null +++ b/aws/dist/awscli/examples/batch/delete-compute-environment.rst @@ -0,0 +1,7 @@ +**To delete a compute environment** + +This example deletes the `P2OnDemand` compute environment. + +Command:: + + aws batch delete-compute-environment --compute-environment P2OnDemand diff --git a/aws/dist/awscli/examples/batch/delete-job-queue.rst b/aws/dist/awscli/examples/batch/delete-job-queue.rst new file mode 100644 index 00000000..52f01a6b --- /dev/null +++ b/aws/dist/awscli/examples/batch/delete-job-queue.rst @@ -0,0 +1,7 @@ +**To delete a job queue** + +This example deletes the GPGPU job queue. + +Command:: + + aws batch delete-job-queue --job-queue GPGPU diff --git a/aws/dist/awscli/examples/batch/deregister-job-definition.rst b/aws/dist/awscli/examples/batch/deregister-job-definition.rst new file mode 100644 index 00000000..b0fd9964 --- /dev/null +++ b/aws/dist/awscli/examples/batch/deregister-job-definition.rst @@ -0,0 +1,8 @@ +**To deregister a job definition** + +This example deregisters a job definition called sleep10. + +Command:: + + aws batch deregister-job-definition --job-definition sleep10 + diff --git a/aws/dist/awscli/examples/batch/describe-compute-environments.rst b/aws/dist/awscli/examples/batch/describe-compute-environments.rst new file mode 100644 index 00000000..2b5c972a --- /dev/null +++ b/aws/dist/awscli/examples/batch/describe-compute-environments.rst @@ -0,0 +1,46 @@ +**To describe a compute environment** + +This example describes the `P2OnDemand` compute environment. + +Command:: + + aws batch describe-compute-environments --compute-environments P2OnDemand + +Output:: + + { + "computeEnvironments": [ + { + "status": "VALID", + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeResources": { + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - P2OnDemand" + }, + "desiredvCpus": 48, + "minvCpus": 0, + "instanceTypes": [ + "p2" + ], + "securityGroupIds": [ + "sg-cf5093b2" + ], + "instanceRole": "ecsInstanceRole", + "maxvCpus": 128, + "type": "EC2", + "ec2KeyPair": "id_rsa" + }, + "statusReason": "ComputeEnvironment Healthy", + "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", + "state": "ENABLED", + "computeEnvironmentName": "P2OnDemand", + "type": "MANAGED" + } + ] + } diff --git a/aws/dist/awscli/examples/batch/describe-job-definitions.rst b/aws/dist/awscli/examples/batch/describe-job-definitions.rst new file mode 100644 index 00000000..42270396 --- /dev/null +++ b/aws/dist/awscli/examples/batch/describe-job-definitions.rst @@ -0,0 +1,35 @@ +**To describe active job definitions** + +This example describes all of your active job definitions. + +Command:: + + aws batch describe-job-definitions --status ACTIVE + +Output:: + + { + "jobDefinitions": [ + { + "status": "ACTIVE", + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", + "containerProperties": { + "mountPoints": [], + "parameters": {}, + "image": "busybox", + "environment": {}, + "vcpus": 1, + "command": [ + "sleep", + "60" + ], + "volumes": [], + "memory": 128, + "ulimits": [] + }, + "type": "container", + "jobDefinitionName": "sleep60", + "revision": 1 + } + ] + } diff --git a/aws/dist/awscli/examples/batch/describe-job-queues.rst b/aws/dist/awscli/examples/batch/describe-job-queues.rst new file mode 100644 index 00000000..b43ed11a --- /dev/null +++ b/aws/dist/awscli/examples/batch/describe-job-queues.rst @@ -0,0 +1,28 @@ +**To describe a job queue** + +This example describes the `HighPriority` job queue. + +Command:: + + aws batch describe-job-queues --job-queues HighPriority + +Output:: + + { + "jobQueues": [ + { + "status": "VALID", + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "computeEnvironmentOrder": [ + { + "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "order": 1 + } + ], + "statusReason": "JobQueue Healthy", + "priority": 1, + "state": "ENABLED", + "jobQueueName": "HighPriority" + } + ] + } diff --git a/aws/dist/awscli/examples/batch/describe-jobs.rst b/aws/dist/awscli/examples/batch/describe-jobs.rst new file mode 100644 index 00000000..d57537b0 --- /dev/null +++ b/aws/dist/awscli/examples/batch/describe-jobs.rst @@ -0,0 +1,37 @@ +**To describe a job** + +This example describes a job with the specified job ID. + +Command:: + + aws batch describe-jobs --jobs bcf0b186-a532-4122-842e-2ccab8d54efb + +Output:: + + { + "jobs": [ + { + "status": "SUBMITTED", + "container": { + "mountPoints": [], + "image": "busybox", + "environment": [], + "vcpus": 1, + "command": [ + "sleep", + "60" + ], + "volumes": [], + "memory": 128, + "ulimits": [] + }, + "parameters": {}, + "jobDefinition": "sleep60", + "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobId": "bcf0b186-a532-4122-842e-2ccab8d54efb", + "dependsOn": [], + "jobName": "example", + "createdAt": 1480483387803 + } + ] + } diff --git a/aws/dist/awscli/examples/batch/list-jobs.rst b/aws/dist/awscli/examples/batch/list-jobs.rst new file mode 100644 index 00000000..2c4e69d0 --- /dev/null +++ b/aws/dist/awscli/examples/batch/list-jobs.rst @@ -0,0 +1,39 @@ +**To list running jobs** + +This example lists the running jobs in the `HighPriority` job queue. + +Command:: + + aws batch list-jobs --job-queue HighPriority + +Output:: + + { + "jobSummaryList": [ + { + "jobName": "example", + "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb" + } + ] + } + + +**To list submitted jobs** + +This example lists jobs in the `HighPriority` job queue that are in the `SUBMITTED` job status. + +Command:: + + aws batch list-jobs --job-queue HighPriority --job-status SUBMITTED + +Output:: + + { + "jobSummaryList": [ + { + "jobName": "example", + "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786" + } + ] + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/batch/register-job-definition.rst b/aws/dist/awscli/examples/batch/register-job-definition.rst new file mode 100644 index 00000000..2b743f0e --- /dev/null +++ b/aws/dist/awscli/examples/batch/register-job-definition.rst @@ -0,0 +1,15 @@ +**To register a job definition** + +This example registers a job definition for a simple container job. + +Command:: + + aws batch register-job-definition --job-definition-name sleep30 --type container --container-properties '{ "image": "busybox", "vcpus": 1, "memory": 128, "command": [ "sleep", "30"]}' + +Output:: + + { + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1", + "jobDefinitionName": "sleep30", + "revision": 1 + } diff --git a/aws/dist/awscli/examples/batch/submit-job.rst b/aws/dist/awscli/examples/batch/submit-job.rst new file mode 100644 index 00000000..67335e08 --- /dev/null +++ b/aws/dist/awscli/examples/batch/submit-job.rst @@ -0,0 +1,14 @@ +**To submit a job** + +This example submits a simple container job called `example` to the `HighPriority` job queue. + +Command:: + + aws batch submit-job --job-name example --job-queue HighPriority --job-definition sleep60 + +Output:: + + { + "jobName": "example", + "jobId": "876da822-4198-45f2-a252-6cea32512ea8" + } diff --git a/aws/dist/awscli/examples/batch/terminate-job.rst b/aws/dist/awscli/examples/batch/terminate-job.rst new file mode 100644 index 00000000..9906ec3c --- /dev/null +++ b/aws/dist/awscli/examples/batch/terminate-job.rst @@ -0,0 +1,7 @@ +**To terminate a job** + +This example terminates a job with the specified job ID. + +Command:: + + aws batch terminate-job --job-id 61e743ed-35e4-48da-b2de-5c8333821c84 --reason "Terminating job." diff --git a/aws/dist/awscli/examples/batch/update-compute-environment.rst b/aws/dist/awscli/examples/batch/update-compute-environment.rst new file mode 100644 index 00000000..745ca8e0 --- /dev/null +++ b/aws/dist/awscli/examples/batch/update-compute-environment.rst @@ -0,0 +1,14 @@ +**To update a compute environment** + +This example disables the `P2OnDemand` compute environment so it can be deleted. + +Command:: + + aws batch update-compute-environment --compute-environment P2OnDemand --state DISABLED + +Output:: + + { + "computeEnvironmentName": "P2OnDemand", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand" + } diff --git a/aws/dist/awscli/examples/batch/update-job-queue.rst b/aws/dist/awscli/examples/batch/update-job-queue.rst new file mode 100644 index 00000000..6d53a0dc --- /dev/null +++ b/aws/dist/awscli/examples/batch/update-job-queue.rst @@ -0,0 +1,14 @@ +**To update a job queue** + +This example disables a job queue so that it can be deleted. + +Command:: + + aws batch update-job-queue --job-queue GPGPU --state DISABLE + +Output:: + + { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", + "jobQueueName": "GPGPU" + } diff --git a/aws/dist/awscli/examples/budgets/create-budget.rst b/aws/dist/awscli/examples/budgets/create-budget.rst new file mode 100644 index 00000000..e3dd4033 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/create-budget.rst @@ -0,0 +1,57 @@ +**To create a Cost and Usage budget** + +This example creates a Cost and Usage budget. + +Command:: + + aws budgets create-budget --account-id 111122223333 --budget file://budget.json --notifications-with-subscribers file://notifications-with-subscribers.json + +budget.json:: + + { + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "BudgetType": "COST", + "CostFilters": { + "AZ" : [ "us-east-1" ] + }, + "CostTypes": { + "IncludeCredit": true, + "IncludeDiscount": true, + "IncludeOtherSubscription": true, + "IncludeRecurring": true, + "IncludeRefund": true, + "IncludeSubscription": true, + "IncludeSupport": true, + "IncludeTax": true, + "IncludeUpfront": true, + "UseBlended": false + }, + "TimePeriod": { + "Start": 1477958399, + "End": 3706473600 + }, + "TimeUnit": "MONTHLY" + } + +notifications-with-subscribers.json:: + + [ + { + "Notification": { + "ComparisonOperator": "GREATER_THAN", + "NotificationType": "ACTUAL", + "Threshold": 80, + "ThresholdType": "PERCENTAGE" + }, + "Subscribers": [ + { + "Address": "example@example.com", + "SubscriptionType": "EMAIL" + } + ] + } + ] diff --git a/aws/dist/awscli/examples/budgets/create-notification.rst b/aws/dist/awscli/examples/budgets/create-notification.rst new file mode 100644 index 00000000..2a52dbc1 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/create-notification.rst @@ -0,0 +1,8 @@ +**To create a notification for the specified Cost and Usage budget** + +This example creates a notification for the specified Cost and Usage budget. + +Command:: + + aws budgets create-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff --git a/aws/dist/awscli/examples/budgets/create-subscriber.rst b/aws/dist/awscli/examples/budgets/create-subscriber.rst new file mode 100644 index 00000000..7a55c124 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/create-subscriber.rst @@ -0,0 +1,8 @@ +**To create a subscriber for a notification associated with a Cost and Usage budget** + +This example creates a subscriber for the specified notification. + +Command:: + + aws budgets create-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff --git a/aws/dist/awscli/examples/budgets/delete-budget.rst b/aws/dist/awscli/examples/budgets/delete-budget.rst new file mode 100644 index 00000000..4de98d60 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/delete-budget.rst @@ -0,0 +1,8 @@ +**To delete a Cost and Usage budget** + +This example deletes the specified Cost and Usage budget. + +Command:: + + aws budgets delete-budget --account-id 111122223333 --budget-name "Example Budget" + diff --git a/aws/dist/awscli/examples/budgets/delete-notification.rst b/aws/dist/awscli/examples/budgets/delete-notification.rst new file mode 100644 index 00000000..4089214c --- /dev/null +++ b/aws/dist/awscli/examples/budgets/delete-notification.rst @@ -0,0 +1,8 @@ +**To delete a notification from a budget** + +This example deletes the specified notification from the specified budget. + +Command:: + + aws budgets delete-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE + diff --git a/aws/dist/awscli/examples/budgets/delete-subscriber.rst b/aws/dist/awscli/examples/budgets/delete-subscriber.rst new file mode 100644 index 00000000..0c5f716b --- /dev/null +++ b/aws/dist/awscli/examples/budgets/delete-subscriber.rst @@ -0,0 +1,8 @@ +**To delete a subscriber from a notification** + +This example deletes the specified subscriber from the specified notification. + +Command:: + + aws budgets delete-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com + diff --git a/aws/dist/awscli/examples/budgets/describe-budget.rst b/aws/dist/awscli/examples/budgets/describe-budget.rst new file mode 100644 index 00000000..28d8cac9 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/describe-budget.rst @@ -0,0 +1,54 @@ +**To retrieve a budget associated with an account** + +This example retrieves the specified Cost and Usage budget. + +Command:: + + aws budgets describe-budget --account-id 111122223333 --budget-name "Example Budget" + +Output:: + + { + "Budget": { + "CalculatedSpend": { + "ForecastedSpend": { + "Amount": "2641.54800000000022919266484677791595458984375", + "Unit": "USD" + }, + "ActualSpend": { + "Amount": "604.4560000000000172803993336856365203857421875", + "Unit": "USD" + } + }, + "BudgetType": "COST", + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "CostTypes": { + "IncludeOtherSubscription": true, + "IncludeUpfront": true, + "IncludeRefund": true, + "UseBlended": false, + "IncludeDiscount": true, + "UseAmortized": false, + "IncludeTax": true, + "IncludeCredit": true, + "IncludeSupport": true, + "IncludeRecurring": true, + "IncludeSubscription": true + }, + "TimeUnit": "MONTHLY", + "TimePeriod": { + "Start": 1477958399.0, + "End": 3706473600.0 + }, + "CostFilters": { + "AZ": [ + "us-east-1" + ] + } + } + } + diff --git a/aws/dist/awscli/examples/budgets/describe-budgets.rst b/aws/dist/awscli/examples/budgets/describe-budgets.rst new file mode 100644 index 00000000..9642d212 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/describe-budgets.rst @@ -0,0 +1,56 @@ +**To retrieve the budgets associated with an account** + +This example retrieves the Cost and Usage budgets for an account. + +Command:: + + aws budgets describe-budgets --account-id 111122223333 --max-results 20 + +Output:: + + { + "Budgets": [ + { + "CalculatedSpend": { + "ForecastedSpend": { + "Amount": "2641.54800000000022919266484677791595458984375", + "Unit": "USD" + }, + "ActualSpend": { + "Amount": "604.4560000000000172803993336856365203857421875", + "Unit": "USD" + } + }, + "BudgetType": "COST", + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "CostTypes": { + "IncludeOtherSubscription": true, + "IncludeUpfront": true, + "IncludeRefund": true, + "UseBlended": false, + "IncludeDiscount": true, + "UseAmortized": false, + "IncludeTax": true, + "IncludeCredit": true, + "IncludeSupport": true, + "IncludeRecurring": true, + "IncludeSubscription": true + }, + "TimeUnit": "MONTHLY", + "TimePeriod": { + "Start": 1477958399.0, + "End": 3706473600.0 + }, + "CostFilters": { + "AZ": [ + "us-east-1" + ] + } + } + ] + } + diff --git a/aws/dist/awscli/examples/budgets/describe-notifications-for-budget.rst b/aws/dist/awscli/examples/budgets/describe-notifications-for-budget.rst new file mode 100644 index 00000000..04ba9684 --- /dev/null +++ b/aws/dist/awscli/examples/budgets/describe-notifications-for-budget.rst @@ -0,0 +1,19 @@ +**To retrieve the notifications for a budget** + +This example retrieves the notifications for a Cost and Usage budget. + +Command:: + + aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5 + +Output:: + + { + "Notifications": [ + { + "Threshold": 80.0, + "ComparisonOperator": "GREATER_THAN", + "NotificationType": "ACTUAL" + } + ] + } diff --git a/aws/dist/awscli/examples/budgets/describe-subscribers-for-notification.rst b/aws/dist/awscli/examples/budgets/describe-subscribers-for-notification.rst new file mode 100644 index 00000000..9146fd9f --- /dev/null +++ b/aws/dist/awscli/examples/budgets/describe-subscribers-for-notification.rst @@ -0,0 +1,22 @@ +**To retrieve the subscribers for a budget notification** + +This example retrieves the subscribers for a Cost and Usage budget notification. + +Command:: + + aws budgets describe-subscribers-for-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --max-results 5 + +Output:: + + { + "Subscribers": [ + { + "SubscriptionType": "EMAIL", + "Address": "example2@example.com" + }, + { + "SubscriptionType": "EMAIL", + "Address": "example@example.com" + } + ] + } diff --git a/aws/dist/awscli/examples/budgets/update-budget.rst b/aws/dist/awscli/examples/budgets/update-budget.rst new file mode 100644 index 00000000..11924c5b --- /dev/null +++ b/aws/dist/awscli/examples/budgets/update-budget.rst @@ -0,0 +1,40 @@ +**To replace a budget for a Cost and Usage budget** + +This example replaces a Cost and Usage budget with a new budget. + +Command:: + + aws budgets update-budget --account-id 111122223333 --new-budget file://new-budget.json + +new-budget.json:: + + { + "BudgetLimit": { + "Amount": "100", + "Unit": "USD" + }, + "BudgetName": "Example Budget", + "BudgetType": "COST", + "CostFilters": { + "AZ" : [ "us-east-1" ] + }, + "CostTypes": { + "IncludeCredit": false, + "IncludeDiscount": true, + "IncludeOtherSubscription": true, + "IncludeRecurring": true, + "IncludeRefund": true, + "IncludeSubscription": true, + "IncludeSupport": true, + "IncludeTax": true, + "IncludeUpfront": true, + "UseBlended": false, + "UseAmortized": true + }, + "TimePeriod": { + "Start": 1477958399, + "End": 3706473600 + }, + "TimeUnit": "MONTHLY" + } + diff --git a/aws/dist/awscli/examples/budgets/update-notification.rst b/aws/dist/awscli/examples/budgets/update-notification.rst new file mode 100644 index 00000000..8078f01c --- /dev/null +++ b/aws/dist/awscli/examples/budgets/update-notification.rst @@ -0,0 +1,8 @@ +**To replace a notification for a Cost and Usage budget** + +This example replaces an 80% notification for a Cost and Usage budget with a 90% notification. + +Command:: + + aws budgets update-notification --account-id 111122223333 --budget-name "Example Budget" --old-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --new-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=90,ThresholdType=PERCENTAGE + diff --git a/aws/dist/awscli/examples/budgets/update-subscriber.rst b/aws/dist/awscli/examples/budgets/update-subscriber.rst new file mode 100644 index 00000000..a15b344d --- /dev/null +++ b/aws/dist/awscli/examples/budgets/update-subscriber.rst @@ -0,0 +1,7 @@ +**To replace a subscriber for a Cost and Usage budget** + +This example replaces the subscriber for a Cost and Usage budget. + +Command:: + + aws budgets update-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --old-subscriber SubscriptionType=EMAIL,Address=example@example.com --new-subscriber SubscriptionType=EMAIL,Address=example2@example.com diff --git a/aws/dist/awscli/examples/ce/get-cost-and-usage.rst b/aws/dist/awscli/examples/ce/get-cost-and-usage.rst new file mode 100644 index 00000000..6e8c1565 --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-cost-and-usage.rst @@ -0,0 +1,88 @@ +**To retrieve the S3 usage of an account for the month of September 2017** + +The following ``get-cost-and-usage`` example retrieves the S3 usage of an account for the month of September 2017. :: + + aws ce get-cost-and-usage \ + --time-period Start=2017-09-01,End=2017-10-01 \ + --granularity MONTHLY \ + --metrics "BlendedCost" "UnblendedCost" "UsageQuantity" \ + --group-by Type=DIMENSION,Key=SERVICE Type=TAG,Key=Environment \ + --filter file://filters.json + +Contents of ``filters.json``:: + + { + "Dimensions": { + "Key": "SERVICE", + "Values": [ + "Amazon Simple Storage Service" + ] + } + } + +Output:: + + { + "GroupDefinitions": [ + { + "Type": "DIMENSION", + "Key": "SERVICE" + }, + { + "Type": "TAG", + "Key": "Environment" + } + ], + "ResultsByTime": [ + { + "Estimated": false, + "TimePeriod": { + "Start": "2017-09-01", + "End": "2017-10-01" + }, + "Total": {}, + "Groups": [ + { + "Keys": [ + "Amazon Simple Storage Service", + "Environment$" + ], + "Metrics": { + "BlendedCost": { + "Amount": "40.3527508453", + "Unit": "USD" + }, + "UnblendedCost": { + "Amount": "40.3543773134", + "Unit": "USD" + }, + "UsageQuantity": { + "Amount": "9312771.098461578", + "Unit": "N/A" + } + } + }, + { + "Keys": [ + "Amazon Simple Storage Service", + "Environment$Dev" + ], + "Metrics": { + "BlendedCost": { + "Amount": "0.2682364644", + "Unit": "USD" + }, + "UnblendedCost": { + "Amount": "0.2682364644", + "Unit": "USD" + }, + "UsageQuantity": { + "Amount": "22403.4395271182", + "Unit": "N/A" + } + } + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/ce/get-dimension-values.rst b/aws/dist/awscli/examples/ce/get-dimension-values.rst new file mode 100644 index 00000000..a473546f --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-dimension-values.rst @@ -0,0 +1,40 @@ +**To retrieve the tags for the dimension SERVICE, with a value of "Elastic"** + +This example retrieves the tags for the dimension SERVICE, with a value of "Elastic" for January 01 2017 through May 18 2017. + +Command:: + + aws ce get-dimension-values --search-string Elastic --time-period Start=2017-01-01,End=2017-05-18 --dimension SERVICE + +Output:: + + { + "TotalSize": 6, + "DimensionValues": [ + { + "Attributes": {}, + "Value": "Amazon ElastiCache" + }, + { + "Attributes": {}, + "Value": "EC2 - Other" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Compute Cloud - Compute" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Load Balancing" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic MapReduce" + }, + { + "Attributes": {}, + "Value": "Amazon Elasticsearch Service" + } + ], + "ReturnSize": 6 + } diff --git a/aws/dist/awscli/examples/ce/get-reservation-coverage.rst b/aws/dist/awscli/examples/ce/get-reservation-coverage.rst new file mode 100644 index 00000000..70695630 --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-reservation-coverage.rst @@ -0,0 +1,62 @@ +**To retrieve the reservation coverage for EC2 t2.nano instances in the us-east-1 region** + +This example retrieves the reservation coverage for EC2 t2.nano instances in the us-east-1 region for July-September of 2017. + +Command:: + + aws ce get-reservation-coverage --time-period Start=2017-07-01,End=2017-10-01 --group-by Type=Dimension,Key=REGION --filter file://filters.json + +filters.json:: + + { + "And": [ + { + "Dimensions": { + "Key": "INSTANCE_TYPE", + "Values": [ + "t2.nano" + ] + }, + "Dimensions": { + "Key": "REGION", + "Values": [ + "us-east-1" + ] + } + } + ] + } + +Output:: + + { + "TotalSize": 6, + "DimensionValues": [ + { + "Attributes": {}, + "Value": "Amazon ElastiCache" + }, + { + "Attributes": {}, + "Value": "EC2 - Other" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Compute Cloud - Compute" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic Load Balancing" + }, + { + "Attributes": {}, + "Value": "Amazon Elastic MapReduce" + }, + { + "Attributes": {}, + "Value": "Amazon Elasticsearch Service" + } + ], + "ReturnSize": 6 + } + diff --git a/aws/dist/awscli/examples/ce/get-reservation-purchase-recommendation.rst b/aws/dist/awscli/examples/ce/get-reservation-purchase-recommendation.rst new file mode 100644 index 00000000..b8f64034 --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-reservation-purchase-recommendation.rst @@ -0,0 +1,19 @@ +**To retrieve the reservation recommendations for Partial Upfront EC2 RIs with a three year term** + +The following ``get-reservation-purchase-recommendation`` example retrieves recommendations for Partial Upfront EC2 instances with a three-year term, based on the last 60 days of EC2 usage. :: + + aws ce get-reservation-purchase-recommendation \ + --service "Amazon Redshift" \ + --lookback-period-in-days SIXTY_DAYS \ + --term-in-years THREE_YEARS \ + --payment-option PARTIAL_UPFRONT + +Output:: + + { + "Recommendations": [], + "Metadata": { + "GenerationTimestamp": "2018-08-08T15:20:57Z", + "RecommendationId": "00d59dde-a1ad-473f-8ff2-iexample3330b" + } + } diff --git a/aws/dist/awscli/examples/ce/get-reservation-utilization.rst b/aws/dist/awscli/examples/ce/get-reservation-utilization.rst new file mode 100644 index 00000000..485d7a79 --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-reservation-utilization.rst @@ -0,0 +1,36 @@ +**To retrieve the reservation utilization for your account** + +The following ``get-reservation-utilization`` example retrieves the RI utilization for all t2.nano instance types from 2018-03-01 to 2018-08-01 for the account. :: + + aws ce get-reservation-utilization \ + --time-period Start=2018-03-01,End=2018-08-01 \ + --filter file://filters.json + +Contents of ``filters.json``:: + + { + "Dimensions": { + "Key": "INSTANCE_TYPE", + "Values": [ + "t2.nano" + ] + } + } + +Output:: + + { + "Total": { + "TotalAmortizedFee": "0", + "UtilizationPercentage": "0", + "PurchasedHours": "0", + "NetRISavings": "0", + "TotalActualHours": "0", + "AmortizedRecurringFee": "0", + "UnusedHours": "0", + "TotalPotentialRISavings": "0", + "OnDemandCostOfRIHoursUsed": "0", + "AmortizedUpfrontFee": "0" + }, + "UtilizationsByTime": [] + } diff --git a/aws/dist/awscli/examples/ce/get-tags.rst b/aws/dist/awscli/examples/ce/get-tags.rst new file mode 100644 index 00000000..5658514c --- /dev/null +++ b/aws/dist/awscli/examples/ce/get-tags.rst @@ -0,0 +1,18 @@ +**To retrieve keys and values for a cost allocation tag** + +This example retrieves all cost allocation tags with a key of "Project" and a value that contains "secretProject". + +Command:: + + aws ce get-tags --search-string secretProject --time-period Start=2017-01-01,End=2017-05-18 --tag-key Project + +Output:: + + { + "ReturnSize": 2, + "Tags": [ + "secretProject1", + "secretProject2" + ], + "TotalSize": 2 + } diff --git a/aws/dist/awscli/examples/chime/associate-phone-number-with-user.rst b/aws/dist/awscli/examples/chime/associate-phone-number-with-user.rst new file mode 100644 index 00000000..f1cb20b4 --- /dev/null +++ b/aws/dist/awscli/examples/chime/associate-phone-number-with-user.rst @@ -0,0 +1,12 @@ +**To associate a phone number with a user** + +The following ``associate-phone-number-with-user`` example associates the specified phone number with a user. :: + + aws chime associate-phone-number-with-user \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ + --e164-phone-number "+12065550100" + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst b/aws/dist/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst new file mode 100644 index 00000000..96099dac --- /dev/null +++ b/aws/dist/awscli/examples/chime/associate-phone-numbers-with-voice-connector.rst @@ -0,0 +1,15 @@ +**To associate phone numbers with an Amazon Chime Voice Connector** + +The following ``associate-phone-numbers-with-voice-connector`` example associates the specified phone numbers with an Amazon Chime Voice Connector. :: + + aws chime associate-phone-numbers-with-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --e164-phone-numbers "+12065550100" "+12065550101" + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/batch-delete-phone-number.rst b/aws/dist/awscli/examples/chime/batch-delete-phone-number.rst new file mode 100644 index 00000000..0ec8373c --- /dev/null +++ b/aws/dist/awscli/examples/chime/batch-delete-phone-number.rst @@ -0,0 +1,15 @@ +**To delete multiple phone numbers** + +The following ``batch-delete-phone-number`` example deletes all of the specified phone numbers. :: + + aws chime batch-delete-phone-number \ + --phone-number-ids "%2B12065550100" "%2B12065550101" + +This command produces no output. +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/batch-suspend-user.rst b/aws/dist/awscli/examples/chime/batch-suspend-user.rst new file mode 100644 index 00000000..58697578 --- /dev/null +++ b/aws/dist/awscli/examples/chime/batch-suspend-user.rst @@ -0,0 +1,13 @@ +**To suspend multiple users** + +The following ``batch-suspend-user`` example suspends the listed users from the specified Amazon Chime account. :: + + aws chime batch-suspend-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + +Output:: + + { + "UserErrors": [] + } diff --git a/aws/dist/awscli/examples/chime/batch-unsuspend-user.rst b/aws/dist/awscli/examples/chime/batch-unsuspend-user.rst new file mode 100644 index 00000000..4f1241be --- /dev/null +++ b/aws/dist/awscli/examples/chime/batch-unsuspend-user.rst @@ -0,0 +1,14 @@ +**To unsuspend multiple users** + +The following ``batch-unsuspend-user`` example removes any previous suspension for the listed users on the specified Amazon Chime account. :: + + aws chime batch-unsuspend-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id-list "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE" "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + +Output:: + + { + "UserErrors": [] + } + diff --git a/aws/dist/awscli/examples/chime/batch-update-phone-number.rst b/aws/dist/awscli/examples/chime/batch-update-phone-number.rst new file mode 100644 index 00000000..632369e6 --- /dev/null +++ b/aws/dist/awscli/examples/chime/batch-update-phone-number.rst @@ -0,0 +1,14 @@ +**To update several phone numbers at the same time** + +The following ``batch-update-phone-number`` example updates the product types for all of the specified phone numbers. :: + + aws chime batch-update-phone-number \ + --update-phone-number-request-items PhoneNumberId=%2B12065550100,ProductType=BusinessCalling PhoneNumberId=%2B12065550101,ProductType=BusinessCalling + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/batch-update-user.rst b/aws/dist/awscli/examples/chime/batch-update-user.rst new file mode 100644 index 00000000..90f6cdfb --- /dev/null +++ b/aws/dist/awscli/examples/chime/batch-update-user.rst @@ -0,0 +1,13 @@ +**To update multiple users in a single command** + +The following ``batch-update-user`` example updates the ``LicenseType`` for each of the listed users in the specified Amazon Chime account. :: + + aws chime batch-update-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + --update-user-request-items "UserId=a1b2c3d4-5678-90ab-cdef-22222EXAMPLE,LicenseType=Basic" "UserId=a1b2c3d4-5678-90ab-cdef-33333EXAMPLE,LicenseType=Basic" + +Output:: + + { + "UserErrors": [] + } diff --git a/aws/dist/awscli/examples/chime/create-account.rst b/aws/dist/awscli/examples/chime/create-account.rst new file mode 100644 index 00000000..0d9e7bf2 --- /dev/null +++ b/aws/dist/awscli/examples/chime/create-account.rst @@ -0,0 +1,24 @@ +**To create an account** + +The following ``create-account`` example creates a new Amazon Chime account under the administrator's AWS account. :: + + aws chime create-account --name MyChimeAccount + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "MyChimeAccount", + "AccountType": "Team", + "CreatedTimestamp": "2019-01-04T17:11:22.003Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ] + } + } + +For more information, see `Getting Started `_ in the *Amazon Chime Administration Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/chime/create-bot.rst b/aws/dist/awscli/examples/chime/create-bot.rst new file mode 100644 index 00000000..0031d792 --- /dev/null +++ b/aws/dist/awscli/examples/chime/create-bot.rst @@ -0,0 +1,26 @@ +**To create an Amazon Chime bot** + +The following ``create-bot`` example creates a bot for the specified Amazon Chime Enterprise account. :: + + aws chime create-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --display-name "myBot" \ + --domain "example.com" + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Integrate a Chat Bot with Amazon Chime `__ in the *Amazon Chime Developer Guide*. diff --git a/aws/dist/awscli/examples/chime/create-phone-number-order.rst b/aws/dist/awscli/examples/chime/create-phone-number-order.rst new file mode 100644 index 00000000..70c59fb6 --- /dev/null +++ b/aws/dist/awscli/examples/chime/create-phone-number-order.rst @@ -0,0 +1,35 @@ +**To create a phone number order** + +The following ``create-phone-number-order`` example creates a phone number order for the specified phone numbers. :: + + aws chime create-phone-number-order \ + --product-type VoiceConnector \ + --e164-phone-numbers "+12065550100" "+12065550101" "+12065550102" + +Output:: + + { + "PhoneNumberOrder": { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Processing", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Processing" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Processing" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Processing" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:22.408Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/create-voice-connector.rst b/aws/dist/awscli/examples/chime/create-voice-connector.rst new file mode 100644 index 00000000..c58aa27f --- /dev/null +++ b/aws/dist/awscli/examples/chime/create-voice-connector.rst @@ -0,0 +1,22 @@ +**To create an Amazon Chime Voice Connector** + +The following ``create-voice-connector`` example creates an Amazon Chime Voice Connector with encryption enabled. :: + + aws chime create-voice-connector \ + --name Test \ + --require-encryption + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "Name": "Test", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-06-04T18:46:56.508Z", + "UpdatedTimestamp": "2019-06-04T18:46:56.508Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-account.rst b/aws/dist/awscli/examples/chime/delete-account.rst new file mode 100644 index 00000000..510e6c04 --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-account.rst @@ -0,0 +1,9 @@ +**To delete an account** + +The following ``delete-account`` example deletes the specified account. :: + + aws chime delete-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +This command produces no output. + +For more information, see `Deleting Your Account `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-phone-number.rst b/aws/dist/awscli/examples/chime/delete-phone-number.rst new file mode 100644 index 00000000..3d6e6c22 --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-phone-number.rst @@ -0,0 +1,10 @@ +**To delete a phone number** + +The following ``delete-phone-number`` example moves the specified phone number into the deletion queue. :: + + aws chime delete-phone-number \ + --phone-number-id "+12065550100" + +This command produces no output. + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-voice-connector-origination.rst b/aws/dist/awscli/examples/chime/delete-voice-connector-origination.rst new file mode 100644 index 00000000..76221faf --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-voice-connector-origination.rst @@ -0,0 +1,10 @@ +**To delete origination settings** + +The following ``delete-voice-connector-origination`` example deletes the origination host, port, protocol, priority, and weight from the specified Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-voice-connector-termination-credentials.rst b/aws/dist/awscli/examples/chime/delete-voice-connector-termination-credentials.rst new file mode 100644 index 00000000..ba0e11a2 --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-voice-connector-termination-credentials.rst @@ -0,0 +1,11 @@ +**To delete termination credentials** + +The following ``delete-voice-connector-termination-credentials`` example deletes the termination credentials for the specified user name and Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --usernames "jdoe" + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-voice-connector-termination.rst b/aws/dist/awscli/examples/chime/delete-voice-connector-termination.rst new file mode 100644 index 00000000..fb7dc10a --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-voice-connector-termination.rst @@ -0,0 +1,10 @@ +**To delete termination settings** + +The following ``delete-voice-connector-termination`` example deletes the termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime delete-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/delete-voice-connector.rst b/aws/dist/awscli/examples/chime/delete-voice-connector.rst new file mode 100644 index 00000000..6ff00b2e --- /dev/null +++ b/aws/dist/awscli/examples/chime/delete-voice-connector.rst @@ -0,0 +1,10 @@ +**To delete an Amazon Chime Voice Connector** + +The following ``delete-voice-connector`` example doesthis :: + + aws chime delete-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/disassociate-phone-number-from-user.rst b/aws/dist/awscli/examples/chime/disassociate-phone-number-from-user.rst new file mode 100644 index 00000000..4e70d7d8 --- /dev/null +++ b/aws/dist/awscli/examples/chime/disassociate-phone-number-from-user.rst @@ -0,0 +1,11 @@ +**To disassociate a phone number from a user** + +The following ``disassociate-phone-number-from-user`` example disassociates a phone number from the specified user. :: + + aws chime disassociate-phone-number-from-user \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst b/aws/dist/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst new file mode 100644 index 00000000..1a002ed8 --- /dev/null +++ b/aws/dist/awscli/examples/chime/disassociate-phone-numbers-from-voice-connector.rst @@ -0,0 +1,15 @@ +**To disassociate phone numbers from an Amazon Chime Voice Connector** + +The following ``disassociate-phone-numbers-from-voice-connector`` example disassociates the specified phone numbers from an Amazon Chime Voice Connector. :: + + aws chime disassociate-phone-numbers-from-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --e164-phone-numbers "+12065550100" "+12065550101" + +Output:: + + { + "PhoneNumberErrors": [] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-account-settings.rst b/aws/dist/awscli/examples/chime/get-account-settings.rst new file mode 100644 index 00000000..42b88b97 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-account-settings.rst @@ -0,0 +1,16 @@ +**To retrieve settings for an account** + +The following ``get-account-settings`` example retrieves the account settings for the specified account. :: + + aws chime get-account-settings --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "AccountSettings": { + "DisableRemoteControl": false, + "EnableDialOut": false + } + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-account.rst b/aws/dist/awscli/examples/chime/get-account.rst new file mode 100644 index 00000000..6ec4bf11 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-account.rst @@ -0,0 +1,24 @@ +**To retrieve the details for an account** + +The following ``get-account`` example retrieves the details for the specified Amazon Chime account. :: + + aws chime get-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "EnterpriseDirectory", + "AccountType": "EnterpriseDirectory", + "CreatedTimestamp": "2018-12-20T18:38:02.181Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ] + } + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-bot.rst b/aws/dist/awscli/examples/chime/get-bot.rst new file mode 100644 index 00000000..f4e07ed9 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-bot.rst @@ -0,0 +1,25 @@ +**To retrieve details about a bot** + +The following ``get-bot`` example displays the details for the specified bot. :: + + aws chime get-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Update Chat Bots `__ in the *Amazon Chime Developer Guide*. diff --git a/aws/dist/awscli/examples/chime/get-global-settings.rst b/aws/dist/awscli/examples/chime/get-global-settings.rst new file mode 100644 index 00000000..4a81312c --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-global-settings.rst @@ -0,0 +1,18 @@ +**To get global settings** + +The following ``get-global-settings`` example retrieves the S3 bucket names used to store call detail records for Amazon Chime Business Calling and Amazon Chime Voice Connectors associated with the administrator's AWS account. :: + + aws chime get-global-settings + +Output:: + + { + "BusinessCalling": { + "CdrBucket": "s3bucket" + }, + "VoiceConnector": { + "CdrBucket": "s3bucket" + } + } + +For more information, see `Managing Global Settings `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-phone-number-order.rst b/aws/dist/awscli/examples/chime/get-phone-number-order.rst new file mode 100644 index 00000000..0d83a0c2 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-phone-number-order.rst @@ -0,0 +1,34 @@ +**To get details for a phone number order** + +The following ``get-phone-number-order`` example displays the details of the specified phone number order. :: + + aws chime get-phone-number-order \ + --phone-number-order-id abc12345-de67-89f0-123g-h45i678j9012 + +Output:: + + { + "PhoneNumberOrder": { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-phone-number.rst b/aws/dist/awscli/examples/chime/get-phone-number.rst new file mode 100644 index 00000000..c2d9337c --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-phone-number.rst @@ -0,0 +1,31 @@ +**To get phone number details** + +The following ``get-phone-number`` example displays the details of the specified phone number. :: + + aws chime get-phone-number \ + --phone-number-id +12065550100 + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "VoiceConnector", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-user-settings.rst b/aws/dist/awscli/examples/chime/get-user-settings.rst new file mode 100644 index 00000000..88e113fe --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-user-settings.rst @@ -0,0 +1,21 @@ +**To retrieve user settings** + +The following ``get-user-settings`` example displays the specified user settings. :: + + aws chime get-user-settings \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k + +Output:: + + { + "UserSettings": { + "Telephony": { + "InboundCalling": true, + "OutboundCalling": true, + "SMS": true + } + } + } + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-user.rst b/aws/dist/awscli/examples/chime/get-user.rst new file mode 100644 index 00000000..8b328957 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-user.rst @@ -0,0 +1,24 @@ +**To get details about a user** + +The following ``get-user`` example retrieves the details for the specified user. :: + + aws chime get-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "marthar@example.com", + "DisplayName": "Martha Rivera", + "LicenseType": "Pro", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z", + "PersonalPIN": "XXXXXXXXXX" + } + } + +For more information, see `Managing Users `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-voice-connector-origination.rst b/aws/dist/awscli/examples/chime/get-voice-connector-origination.rst new file mode 100644 index 00000000..e3c6cd09 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-voice-connector-origination.rst @@ -0,0 +1,25 @@ +**To retrieve origination settings** + +The following ``get-voice-connector-origination`` example retrieves the origination host, port, protocol, priority, and weight for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "Origination": { + "Routes": [ + { + "Host": "10.24.34.0", + "Port": 1234, + "Protocol": "TCP", + "Priority": 1, + "Weight": 5 + } + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-voice-connector-termination-health.rst b/aws/dist/awscli/examples/chime/get-voice-connector-termination-health.rst new file mode 100644 index 00000000..16865be6 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-voice-connector-termination-health.rst @@ -0,0 +1,17 @@ +**To retrieve termination health details** + +The following ``get-voice-connector-termination-health`` example retrieves the termination health details for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-termination-health \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "TerminationHealth": { + "Timestamp": "Fri Aug 23 16:45:55 UTC 2019", + "Source": "10.24.34.0" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-voice-connector-termination.rst b/aws/dist/awscli/examples/chime/get-voice-connector-termination.rst new file mode 100644 index 00000000..f0c7f663 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-voice-connector-termination.rst @@ -0,0 +1,25 @@ +**To retrieve termination settings** + +The following ``get-voice-connector-termination`` example retrieves the termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. +Output:: + + { + "Termination": { + "CpsLimit": 1, + "DefaultPhoneNumber": "+12065550100", + "CallingRegions": [ + "US" + ], + "CidrAllowedList": [ + "10.24.34.0/23" + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/get-voice-connector.rst b/aws/dist/awscli/examples/chime/get-voice-connector.rst new file mode 100644 index 00000000..c5cb47e1 --- /dev/null +++ b/aws/dist/awscli/examples/chime/get-voice-connector.rst @@ -0,0 +1,21 @@ +**To get details for an Amazon Chime Voice Connector** + +The following ``get-voice-connector`` example displays the details of the specified Amazon Chime Voice Connector. :: + + aws chime get-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "Name": "MyVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-06-04T18:46:56.508Z", + "UpdatedTimestamp": "2019-08-09T21:47:48.641Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/invite-users.rst b/aws/dist/awscli/examples/chime/invite-users.rst new file mode 100644 index 00000000..76324a4e --- /dev/null +++ b/aws/dist/awscli/examples/chime/invite-users.rst @@ -0,0 +1,28 @@ +**To invite users to join Amazon Chime** + +The following ``invite-users`` example sends an email to invite a user to the specified Amazon Chime account. :: + + aws chime invite-users \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-email-list "alejandror@example.com" "janed@example.com" + +Output:: + + { + "Invites": [ + { + "InviteId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "Status": "Pending", + "EmailAddress": "alejandror@example.com", + "EmailStatus": "Sent" + } + { + "InviteId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "Status": "Pending", + "EmailAddress": "janed@example.com", + "EmailStatus": "Sent" + } + ] + } + +For more information, see `Inviting and Suspending Users `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-accounts.rst b/aws/dist/awscli/examples/chime/list-accounts.rst new file mode 100644 index 00000000..06fda02b --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-accounts.rst @@ -0,0 +1,38 @@ +**To get a list of accounts** + +The following ``list-accounts`` example retrieves a list of the Amazon Chime accounts in the administrator's AWS account. :: + + aws chime list-accounts + +Output:: + + { + "Accounts": [ + { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "First Chime Account", + "AccountType": "EnterpriseDirectory", + "CreatedTimestamp": "2018-12-20T18:38:02.181Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ] + }, + { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "Name": "Second Chime Account", + "AccountType": "Team", + "CreatedTimestamp": "2018-09-04T21:44:22.292Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ] + } + ] + } + +For more information, see `Managing Your Amazon Chime Accounts `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-bots.rst b/aws/dist/awscli/examples/chime/list-bots.rst new file mode 100644 index 00000000..fa8ccb28 --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-bots.rst @@ -0,0 +1,24 @@ +**To retrieve a list of bots** + +The following ``list-bots`` example lists the bots associated with the specified Amazon Chime Enterprise account. :: + + aws chime list-bots \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + } + } + +For more information, see `Use Chat Bots with Amazon Chime `__ in the *Amazon Chime Developer Guide*. diff --git a/aws/dist/awscli/examples/chime/list-phone-number-orders.rst b/aws/dist/awscli/examples/chime/list-phone-number-orders.rst new file mode 100644 index 00000000..d06183ae --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-phone-number-orders.rst @@ -0,0 +1,56 @@ +**To list phone number orders** + +The following ``list-phone-number-orders`` example lists the phone number orders associated with the Amazon Chime administrator's account. :: + + aws chime list-phone-number-orders + +Output:: + + { + "PhoneNumberOrders": [ + { + "PhoneNumberOrderId": "abc12345-de67-89f0-123g-h45i678j9012", + "ProductType": "VoiceConnector", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550100", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550101", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550102", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + { + "PhoneNumberOrderId": "cba54321-ed76-09f5-321g-h54i876j2109", + "ProductType": "BusinessCalling", + "Status": "Partial", + "OrderedPhoneNumbers": [ + { + "E164PhoneNumber": "+12065550103", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550104", + "Status": "Acquired" + }, + { + "E164PhoneNumber": "+12065550105", + "Status": "Failed" + } + ], + "CreatedTimestamp": "2019-08-09T21:35:21.427Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.926Z" + } + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-phone-numbers.rst b/aws/dist/awscli/examples/chime/list-phone-numbers.rst new file mode 100644 index 00000000..2869d258 --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-phone-numbers.rst @@ -0,0 +1,51 @@ +**To list phone numbers for an Amazon Chime account** + +The following ``list-phone-numbers`` example lists the phone numbers associated with the administrator's Amazon Chime account. :: + + aws chime list-phone-numbers + +This command produces no output. +Output:: + + { + "PhoneNumbers": [ + { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "VoiceConnector", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" + } + { + "PhoneNumberId": "%2B12065550101", + "E164PhoneNumber": "+12065550101", + "Type": "Local", + "ProductType": "VoiceConnector", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-09T21:35:31.745Z" + } + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-users.rst b/aws/dist/awscli/examples/chime/list-users.rst new file mode 100644 index 00000000..8e908207 --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-users.rst @@ -0,0 +1,50 @@ +**To list the users in an account** + +The following ``list-users`` example lists the users for the specified Amazon Chime account. :: + + aws chime list-users --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "Users": [ + { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "mariag@example.com", + "DisplayName": "Maria Garcia", + "LicenseType": "Pro", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z" + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "richardr@example.com", + "DisplayName": "Richard Roe", + "LicenseType": "Pro", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:45.415Z" + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "saanvis@example.com", + "DisplayName": "Saanvi Sarkar", + "LicenseType": "Basic", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:46:57.747Z" + }, + { + "UserId": "a1b2c3d4-5678-90ab-cdef-55555EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "wxiulan@example.com", + "DisplayName": "Wang Xiulan", + "LicenseType": "Basic", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:47:15.390Z" + } + ] + } + +For more information, see `Managing Users `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-voice-connector-termination-credentials.rst b/aws/dist/awscli/examples/chime/list-voice-connector-termination-credentials.rst new file mode 100644 index 00000000..c52ca1ef --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-voice-connector-termination-credentials.rst @@ -0,0 +1,17 @@ +**To retrieve a list of termination credentials** + +The following ``list-voice-connector-termination-credentials`` example retrieves a list of the termination credentials for the specified Amazon Chime Voice Connector. :: + + aws chime list-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 + +This command produces no output. +Output:: + + { + "Usernames": [ + "jdoe" + ] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/list-voice-connectors.rst b/aws/dist/awscli/examples/chime/list-voice-connectors.rst new file mode 100644 index 00000000..d9d31423 --- /dev/null +++ b/aws/dist/awscli/examples/chime/list-voice-connectors.rst @@ -0,0 +1,22 @@ +**To list Amazon Chime Voice Connectors for an account** + +The following ``list-voice-connectors`` example lists the Amazon Chime Voice Connectors associated with the administrator's account. :: + + aws chime list-voice-connectors + +Output:: + + { + "VoiceConnectors": [ + { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "Name": "MyVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-06-04T18:46:56.508Z", + "UpdatedTimestamp": "2019-08-09T21:47:48.641Z" + } + ] + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/logout-user.rst b/aws/dist/awscli/examples/chime/logout-user.rst new file mode 100644 index 00000000..10db1fbf --- /dev/null +++ b/aws/dist/awscli/examples/chime/logout-user.rst @@ -0,0 +1,9 @@ +**To log out a user** + +The following ``logout-user`` example logs out the specified user. :: + + aws chime logout-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/chime/put-voice-connector-origination.rst b/aws/dist/awscli/examples/chime/put-voice-connector-origination.rst new file mode 100644 index 00000000..a125fe34 --- /dev/null +++ b/aws/dist/awscli/examples/chime/put-voice-connector-origination.rst @@ -0,0 +1,26 @@ +**To set up origination settings** + +The following ``put-voice-connector-origination`` example sets up the origination host, port, protocol, priority, and weight for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-origination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --origination Routes=[{Host="10.24.34.0",Port=1234,Protocol="TCP",Priority=1,Weight=5}],Disabled=false + +Output:: + + { + "Origination": { + "Routes": [ + { + "Host": "10.24.34.0", + "Port": 1234, + "Protocol": "TCP", + "Priority": 1, + "Weight": 5 + } + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/put-voice-connector-termination-credentials.rst b/aws/dist/awscli/examples/chime/put-voice-connector-termination-credentials.rst new file mode 100644 index 00000000..b42f7f6f --- /dev/null +++ b/aws/dist/awscli/examples/chime/put-voice-connector-termination-credentials.rst @@ -0,0 +1,11 @@ +**To set up termination credentials** + +The following ``put-voice-connector-termination-credentials`` example sets termination credentials for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-termination-credentials \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --credentials Username="jdoe",Password="XXXXXXXX" + +This command produces no output. + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/put-voice-connector-termination.rst b/aws/dist/awscli/examples/chime/put-voice-connector-termination.rst new file mode 100644 index 00000000..fb0093e0 --- /dev/null +++ b/aws/dist/awscli/examples/chime/put-voice-connector-termination.rst @@ -0,0 +1,24 @@ +**To set up termination settings** + +The following ``put-voice-connector-termination`` example sets the calling regions and allowed IP host termination settings for the specified Amazon Chime Voice Connector. :: + + aws chime put-voice-connector-termination \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --termination CallingRegions="US",CidrAllowedList="10.24.34.0/23",Disabled=false + +Output:: + + { + "Termination": { + "CpsLimit": 0, + "CallingRegions": [ + "US" + ], + "CidrAllowedList": [ + "10.24.34.0/23" + ], + "Disabled": false + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/regenerate-security-token.rst b/aws/dist/awscli/examples/chime/regenerate-security-token.rst new file mode 100644 index 00000000..4a0f41e1 --- /dev/null +++ b/aws/dist/awscli/examples/chime/regenerate-security-token.rst @@ -0,0 +1,26 @@ +**To regenerate a security token** + +The following ``regenerate-security-token`` example regenerates the security token for the specified bot. :: + + aws chime regenerate-security-token \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": false, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" + } + } + + +For more information, see `Authenticate Chat Bot Requests `__ in the *Amazon Chime Developer Guide*. diff --git a/aws/dist/awscli/examples/chime/reset-personal-pin.rst b/aws/dist/awscli/examples/chime/reset-personal-pin.rst new file mode 100644 index 00000000..ddbbc005 --- /dev/null +++ b/aws/dist/awscli/examples/chime/reset-personal-pin.rst @@ -0,0 +1,24 @@ +**To reset a user's personal meeting PIN** + +The following ``reset-personal-pin`` example resets the specified user's personal meeting PIN. :: + + aws chime reset-personal-pin \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "PrimaryEmail": "mateo@example.com", + "DisplayName": "Mateo Jackson", + "LicenseType": "Pro", + "UserRegistrationStatus": "Registered", + "RegisteredOn": "2018-12-20T18:45:25.231Z", + "PersonalPIN": "XXXXXXXXXX" + } + } + +For more information, see `Changing Personal Meeting PINs `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/restore-phone-number.rst b/aws/dist/awscli/examples/chime/restore-phone-number.rst new file mode 100644 index 00000000..6832a8e0 --- /dev/null +++ b/aws/dist/awscli/examples/chime/restore-phone-number.rst @@ -0,0 +1,31 @@ +**To restore a phone number** + +The following ``restore-phone-number`` example restores the specified phone number from the deletion queue. :: + + aws chime restore-phone-number \ + --phone-number-id "+12065550100" + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "BusinessCalling", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-12T22:06:36.355Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/search-available-phone-numbers.rst b/aws/dist/awscli/examples/chime/search-available-phone-numbers.rst new file mode 100644 index 00000000..1a6a20c8 --- /dev/null +++ b/aws/dist/awscli/examples/chime/search-available-phone-numbers.rst @@ -0,0 +1,25 @@ +**To search available phone numbers** + +The following ``search-available-phone-numbers`` example searches available phone numbers by area code. :: + + aws chime search-available-phone-numbers \ + --area-code "206" + +Output:: + + { + "E164PhoneNumbers": [ + "+12065550100", + "+12065550101", + "+12065550102", + "+12065550103", + "+12065550104", + "+12065550105", + "+12065550106", + "+12065550107", + "+12065550108", + "+12065550109", + ] + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/update-account-settings.rst b/aws/dist/awscli/examples/chime/update-account-settings.rst new file mode 100644 index 00000000..4e241463 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-account-settings.rst @@ -0,0 +1,9 @@ +**To update the settings for your account** + +The following ``update-account-settings`` example disables the remote control of shared screens for the specified Amazon Chime account. :: + + aws chime update-account-settings \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --account-settings DisableRemoteControl=true + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/chime/update-account.rst b/aws/dist/awscli/examples/chime/update-account.rst new file mode 100644 index 00000000..ad2eeb04 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-account.rst @@ -0,0 +1,24 @@ +**To update an account** + +The following ``update-account`` example updates the specified account name. :: + + aws chime update-account --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE --name MyAccountName + +Output:: + + { + "Account": { + "AwsAccountId": "111122223333", + "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "Name": "MyAccountName", + "AccountType": "Team", + "CreatedTimestamp": "2018-09-04T21:44:22.292Z", + "DefaultLicense": "Pro", + "SupportedLicenses": [ + "Basic", + "Pro" + ] + } + } + +For more information, see `Renaming Your Account `_ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/update-bot.rst b/aws/dist/awscli/examples/chime/update-bot.rst new file mode 100644 index 00000000..de53d8b3 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-bot.rst @@ -0,0 +1,26 @@ +**To update a bot** + +The following ``update-bot`` example updates the status of the specified bot to stop it from running. :: + + aws chime update-bot \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --bot-id 123abcd4-5ef6-789g-0h12-34j56789012k \ + --disabled + +Output:: + + { + "Bot": { + "BotId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "UserId": "123abcd4-5ef6-789g-0h12-34j56789012k", + "DisplayName": "myBot (Bot)", + "BotType": "ChatBot", + "Disabled": true, + "CreatedTimestamp": "2019-09-09T18:05:56.749Z", + "UpdatedTimestamp": "2019-09-09T18:05:56.749Z", + "BotEmail": "myBot-chimebot@example.com", + "SecurityToken": "je7MtGbClwBF/2Zp9Utk/h3yCo8nvbEXAMPLEKEY" + } + } + +For more information, see `Update Chat Bots `__ in the *Amazon Chime Developer Guide*. diff --git a/aws/dist/awscli/examples/chime/update-global-settings.rst b/aws/dist/awscli/examples/chime/update-global-settings.rst new file mode 100644 index 00000000..9ac8eac9 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-global-settings.rst @@ -0,0 +1,11 @@ +**To update global settings** + +The following ``update-global-settings`` example updates the S3 bucket used to store call detail records for Amazon Chime Business Calling and Amazon Chime Voice Connectors associated with the administrator's AWS account. :: + + aws chime update-global-settings \ + --business-calling CdrBucket="s3bucket" \ + --voice-connector CdrBucket="s3bucket" + +This command produces no output. + +For more information, see `Managing Global Settings `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/update-phone-number.rst b/aws/dist/awscli/examples/chime/update-phone-number.rst new file mode 100644 index 00000000..0f84003a --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-phone-number.rst @@ -0,0 +1,32 @@ +**To update the details for a phone number** + +The following ``update-phone-number`` example updates the specified phone number's product type. :: + + aws chime update-phone-number \ + --phone-number-id "+12065550100" \ + --product-type "BusinessCalling" + +Output:: + + { + "PhoneNumber": { + "PhoneNumberId": "%2B12065550100", + "E164PhoneNumber": "+12065550100", + "Type": "Local", + "ProductType": "BusinessCalling", + "Status": "Unassigned", + "Capabilities": { + "InboundCall": true, + "OutboundCall": true, + "InboundSMS": true, + "OutboundSMS": true, + "InboundMMS": true, + "OutboundMMS": true + }, + "Associations": [], + "CreatedTimestamp": "2019-08-09T21:35:21.445Z", + "UpdatedTimestamp": "2019-08-12T21:44:07.591Z" + } + } + +For more information, see `Working with Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/update-user-settings.rst b/aws/dist/awscli/examples/chime/update-user-settings.rst new file mode 100644 index 00000000..c9eb08e1 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-user-settings.rst @@ -0,0 +1,12 @@ +**To update user settings** + +The following ``update-user-settings`` example enables the specified user to make inbound and outbound calls and send and receive SMS messages. :: + + aws chime update-user-settings \ + --account-id 12a3456b-7c89-012d-3456-78901e23fg45 \ + --user-id 1ab2345c-67de-8901-f23g-45h678901j2k \ + --user-settings "Telephony={InboundCalling=true,OutboundCalling=true,SMS=true}" + +This command produces no output. + +For more information, see `Managing User Phone Numbers `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/chime/update-user.rst b/aws/dist/awscli/examples/chime/update-user.rst new file mode 100644 index 00000000..e7134698 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-user.rst @@ -0,0 +1,18 @@ +**To update user details** + +This example updates the specified details for the specified user. + +Command:: + + aws chime update-user \ + --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE \ + --license-type "Basic" + +Output:: + + { + "User": { + "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + } + } diff --git a/aws/dist/awscli/examples/chime/update-voice-connector.rst b/aws/dist/awscli/examples/chime/update-voice-connector.rst new file mode 100644 index 00000000..53dadbc6 --- /dev/null +++ b/aws/dist/awscli/examples/chime/update-voice-connector.rst @@ -0,0 +1,23 @@ +**To update the details for an Amazon Chime Voice Connector** + +The following ``update-voice-connector`` example updates the name of the specified Amazon Chime Voice Connector. :: + + aws chime update-voice-connector \ + --voice-connector-id abcdef1ghij2klmno3pqr4 \ + --name MyVoiceConnector \ + --require-encryption + +Output:: + + { + "VoiceConnector": { + "VoiceConnectorId": "abcdef1ghij2klmno3pqr4", + "Name": "MyVoiceConnector", + "OutboundHostName": "abcdef1ghij2klmno3pqr4.voiceconnector.chime.aws", + "RequireEncryption": true, + "CreatedTimestamp": "2019-06-04T18:46:56.508Z", + "UpdatedTimestamp": "2019-08-09T21:47:48.641Z" + } + } + +For more information, see `Working with Amazon Chime Voice Connectors `__ in the *Amazon Chime Administration Guide*. diff --git a/aws/dist/awscli/examples/cloud9/create-environment-ec2.rst b/aws/dist/awscli/examples/cloud9/create-environment-ec2.rst new file mode 100644 index 00000000..f16c1bc4 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/create-environment-ec2.rst @@ -0,0 +1,13 @@ +**To create an AWS Cloud9 EC2 development environment** + +This example creates an AWS Cloud9 development environment with the specified settings, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment. + +Command:: + + aws cloud9 create-environment-ec2 --name my-demo-env --description "My demonstration development environment." --instance-type t2.micro --subnet-id subnet-1fab8aEX --automatic-stop-time-minutes 60 --owner-arn arn:aws:iam::123456789012:user/MyDemoUser + +Output:: + + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/create-environment-membership.rst b/aws/dist/awscli/examples/cloud9/create-environment-membership.rst new file mode 100644 index 00000000..d97a81ec --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/create-environment-membership.rst @@ -0,0 +1,18 @@ +**To add an environment member to an AWS Cloud9 development environment** + +This example adds the specified environment member to the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 create-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-write + +Output:: + + { + "membership": { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-write" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/delete-environment-membership.rst b/aws/dist/awscli/examples/cloud9/delete-environment-membership.rst new file mode 100644 index 00000000..93aab631 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/delete-environment-membership.rst @@ -0,0 +1,11 @@ +**To delete an environment member from an AWS Cloud9 development environment** + +This example deletes the specified environment member from the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 delete-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/delete-environment.rst b/aws/dist/awscli/examples/cloud9/delete-environment.rst new file mode 100644 index 00000000..cfe2cec7 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/delete-environment.rst @@ -0,0 +1,11 @@ +**To delete an AWS Cloud9 development environment** + +This example deletes the specified AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance. + +Command:: + + aws cloud9 delete-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/describe-environment-memberships.rst b/aws/dist/awscli/examples/cloud9/describe-environment-memberships.rst new file mode 100644 index 00000000..fd2bd4ab --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/describe-environment-memberships.rst @@ -0,0 +1,76 @@ +**To gets information about environment members for an AWS Cloud9 development environment** + +This example gets information about environment members for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX + +Output:: + + { + "memberships": [ + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-write" + }, + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } + +**To get information about the owner of an AWS Cloud9 development environment** + +This example gets information about the owner of the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-memberships --environment-id 8a34f51ce1e04a08882f1e811bd706EX --permissions owner + +Output:: + + { + "memberships": [ + { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } + +**To get information about an environment member for multiple AWS Cloud9 development environments** + +This example gets information about the specified environment member for multiple AWS Cloud9 development environments. + +Command:: + + aws cloud9 describe-environment-memberships --user-arn arn:aws:iam::123456789012:user/MyDemoUser + +Output:: + + { + "memberships": [ + { + "environmentId": "10a75714bd494714929e7f5ec4125aEX", + "lastAccess": 1516213427.0, + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + }, + { + "environmentId": "1980b80e5f584920801c09086667f0EX", + "lastAccess": 1516144884.0, + "userId": "AIDAJNUEDQAQWFELJDLEX", + "userArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "permissions": "owner" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/describe-environment-status.rst b/aws/dist/awscli/examples/cloud9/describe-environment-status.rst new file mode 100644 index 00000000..dd9060e8 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/describe-environment-status.rst @@ -0,0 +1,14 @@ +**To get status information for an AWS Cloud9 development environment** + +This example gets status information for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 describe-environment-status --environment-id 685f892f431b45c2b28cb69eadcdb0EX + +Output:: + + { + "status": "ready", + "message": "Environment is ready to use" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/describe-environments.rst b/aws/dist/awscli/examples/cloud9/describe-environments.rst new file mode 100644 index 00000000..a9dadc10 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/describe-environments.rst @@ -0,0 +1,36 @@ +**To get information about AWS Cloud9 development environments** + +This example gets information about the specified AWS Cloud9 development environments. + +Command:: + + aws cloud9 describe-environments --environment-ids 685f892f431b45c2b28cb69eadcdb0EX 349c86d4579e4e7298d500ff57a6b2EX + +Output:: + + { + "environments": [ + { + "id": "685f892f431b45c2b28cb69eadcdb0EX", + "name": "my-demo-ec2-env", + "description": "Created from CodeStar.", + "type": "ec2", + "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:685f892f431b45c2b28cb69eadcdb0EX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "lifecycle": { + "status": "CREATED" + } + }, + { + "id": "349c86d4579e4e7298d500ff57a6b2EX", + "name": my-demo-ssh-env", + "description": "", + "type": "ssh", + "arn": "arn:aws:cloud9:us-east-1:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX", + "ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser", + "lifecycle": { + "status": "CREATED" + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/list-environments.rst b/aws/dist/awscli/examples/cloud9/list-environments.rst new file mode 100644 index 00000000..79f291df --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/list-environments.rst @@ -0,0 +1,16 @@ +**To get a list of available AWS Cloud9 development environment identifiers** + +This example gets a list of available AWS Cloud9 development environment identifiers. + +Command:: + + aws cloud9 list-environments + +Output:: + + { + "environmentIds": [ + "685f892f431b45c2b28cb69eadcdb0EX", + "1980b80e5f584920801c09086667f0EX" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/update-environment-membership.rst b/aws/dist/awscli/examples/cloud9/update-environment-membership.rst new file mode 100644 index 00000000..deaec3e1 --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/update-environment-membership.rst @@ -0,0 +1,18 @@ +**To change the settings of an existing environment member for an AWS Cloud9 development environment** + +This example changes the settings of the specified existing environment member for the specified AWS Cloud9 development environment. + +Command:: + + aws cloud9 update-environment-membership --environment-id 8a34f51ce1e04a08882f1e811bd706EX --user-arn arn:aws:iam::123456789012:user/AnotherDemoUser --permissions read-only + +Output:: + + { + "membership": { + "environmentId": "8a34f51ce1e04a08882f1e811bd706EX", + "userId": "AIDAJ3LOROMOUXTBSU6EX", + "userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser", + "permissions": "read-only" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloud9/update-environment.rst b/aws/dist/awscli/examples/cloud9/update-environment.rst new file mode 100644 index 00000000..0bb9651b --- /dev/null +++ b/aws/dist/awscli/examples/cloud9/update-environment.rst @@ -0,0 +1,11 @@ +**To change the settings of an existing AWS Cloud9 development environment** + +This example changes the specified settings of the specified existing AWS Cloud9 development environment. + +Command:: + + aws cloud9 update-environment --environment-id 8a34f51ce1e04a08882f1e811bd706EX --name my-changed-demo-env --description "My changed demonstration development environment." + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/_deploy_description.rst b/aws/dist/awscli/examples/cloudformation/_deploy_description.rst new file mode 100644 index 00000000..dc34d4e6 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/_deploy_description.rst @@ -0,0 +1,8 @@ +Deploys the specified AWS CloudFormation template by creating and then executing +a change set. The command terminates after AWS CloudFormation executes the +change set. If you want to view the change set before AWS CloudFormation +executes it, use the ``--no-execute-changeset`` flag. + +To update a stack, specify the name of an existing stack. To create a new stack, +specify a new stack name. + diff --git a/aws/dist/awscli/examples/cloudformation/_package_description.rst b/aws/dist/awscli/examples/cloudformation/_package_description.rst new file mode 100644 index 00000000..88ff2fe9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/_package_description.rst @@ -0,0 +1,48 @@ +Packages the local artifacts (local paths) that your AWS CloudFormation template +references. The command uploads local artifacts, such as source code for an AWS +Lambda function or a Swagger file for an AWS API Gateway REST API, to an S3 +bucket. The command returns a copy of your template, replacing references to +local artifacts with the S3 location where the command uploaded the artifacts. + +Use this command to quickly upload local artifacts that might be required by +your template. After you package your template's artifacts, run the deploy +command to ``deploy`` the returned template. + +This command can upload local artifacts referenced in the following places: + + + - ``BodyS3Location`` property for the ``AWS::ApiGateway::RestApi`` resource + - ``Code`` property for the ``AWS::Lambda::Function`` resource + - ``CodeUri`` property for the ``AWS::Serverless::Function`` resource + - ``DefinitionS3Location`` property for the ``AWS::AppSync::GraphQLSchema`` resource + - ``RequestMappingTemplateS3Location`` property for the ``AWS::AppSync::Resolver`` resource + - ``ResponseMappingTemplateS3Location`` property for the ``AWS::AppSync::Resolver`` resource + - ``DefinitionUri`` property for the ``AWS::Serverless::Api`` resource + - ``Location`` parameter for the ``AWS::Include`` transform + - ``SourceBundle`` property for the ``AWS::ElasticBeanstalk::ApplicationVersion`` resource + - ``TemplateURL`` property for the ``AWS::CloudFormation::Stack`` resource + - ``Command.ScriptLocation`` property for the ``AWS::Glue::Job`` resource + + +To specify a local artifact in your template, specify a path to a local file or folder, +as either an absolute or relative path. The relative path is a location +that is relative to your template's location. + +For example, if your AWS Lambda function source code is in the +``/home/user/code/lambdafunction/`` folder, specify +``CodeUri: /home/user/code/lambdafunction`` for the +``AWS::Serverless::Function`` resource. The command returns a template and replaces +the local path with the S3 location: ``CodeUri: s3://mybucket/lambdafunction.zip``. + +If you specify a file, the command directly uploads it to the S3 bucket. If you +specify a folder, the command zips the folder and then uploads the .zip file. +For most resources, if you don't specify a path, the command zips and uploads the +current working directory. The exception is ``AWS::ApiGateway::RestApi``; +if you don't specify a ``BodyS3Location``, this command will not upload an artifact to S3. + +Before the command uploads artifacts, it checks if the artifacts are already +present in the S3 bucket to prevent unnecessary uploads. The command uses MD5 +checksums to compare files. If the values match, the command doesn't upload the +artifacts. Use the ``--force flag`` to skip this check and always upload the +artifacts. + diff --git a/aws/dist/awscli/examples/cloudformation/cancel-update-stack.rst b/aws/dist/awscli/examples/cloudformation/cancel-update-stack.rst new file mode 100644 index 00000000..3bdff6bc --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/cancel-update-stack.rst @@ -0,0 +1,5 @@ +**To cancel a stack update that is in progress** + +The following ``cancel-update-stack`` command cancels a stack update on the ``myteststack`` stack:: + + aws cloudformation cancel-update-stack --stack-name myteststack diff --git a/aws/dist/awscli/examples/cloudformation/continue-update-rollback.rst b/aws/dist/awscli/examples/cloudformation/continue-update-rollback.rst new file mode 100755 index 00000000..e6423f53 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/continue-update-rollback.rst @@ -0,0 +1,8 @@ +**To retry an update rollback** + +The following ``continue-update-rollback`` example resumes a rollback operation from a previously failed stack update. :: + + aws cloudformation continue-update-rollback \ + --stack-name my-stack + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/create-change-set.rst b/aws/dist/awscli/examples/cloudformation/create-change-set.rst new file mode 100755 index 00000000..795b8054 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/create-change-set.rst @@ -0,0 +1,16 @@ +**To create a change set** + +The following ``create-change-set`` example creates a change set with the ``CAPABILITY_IAM`` capability. The file ``template.yaml`` is an AWS CloudFormation template in the current folder that defines a stack that includes IAM resources. :: + + aws cloudformation create-change-set \ + --stack-name my-application \ + --change-set-name my-change-set \ + --template-body file://template.yaml \ + --capabilities CAPABILITY_IAM + +Output:: + + { + "Id": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-application/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" + } diff --git a/aws/dist/awscli/examples/cloudformation/create-stack-instances.rst b/aws/dist/awscli/examples/cloudformation/create-stack-instances.rst new file mode 100755 index 00000000..b8d066be --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/create-stack-instances.rst @@ -0,0 +1,17 @@ +**To create stack instances** + +The following ``create-stack-instances`` example creates instances of a stack set in two accounts and in four regions. The fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be created. :: + + aws cloudformation create-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 223456789012 \ + --regions us-east-1 us-east-2 us-west-1 us-west-2 \ + --operation-preferences FailureToleranceCount=7 + +Output:: + + { + "OperationId": "d7995c31-83c2-xmpl-a3d4-e9ca2811563f" + } + +To create a stack set, use the ``create-stack-set`` command. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/create-stack-set.rst b/aws/dist/awscli/examples/cloudformation/create-stack-set.rst new file mode 100755 index 00000000..62a9f7ed --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/create-stack-set.rst @@ -0,0 +1,16 @@ +**To create a stack set** + +The following ``create-stack-set`` example creates a stack set using the specified YAML file temlplate. ``template.yaml`` is an AWS CloudFormation template in the current folder that defines a stack. :: + + aws cloudformation create-stack-set \ + --stack-set-name my-stack-set \ + --template-body file://template.yaml \ + --description "SNS topic" + +Output:: + + { + "StackSetId": "my-stack-set:8d0f160b-d157-xmpl-a8e6-c0ce8e5d8cc1" + } + +To add stack instances to the stack set, use the ``create-stack-instances`` command. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/create-stack.rst b/aws/dist/awscli/examples/cloudformation/create-stack.rst new file mode 100644 index 00000000..f6418490 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/create-stack.rst @@ -0,0 +1,15 @@ +**To create an AWS CloudFormation stack** + +The following ``create-stacks`` command creates a stack with the name ``myteststack`` using the ``sampletemplate.json`` template:: + + aws cloudformation create-stack --stack-name myteststack --template-body file://sampletemplate.json --parameters ParameterKey=KeyPairName,ParameterValue=TestKey ParameterKey=SubnetIDs,ParameterValue=SubnetID1\\,SubnetID2 + +Output:: + + { + "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896" + } + +For more information, see `Stacks`_ in the *AWS CloudFormation User Guide*. + +.. _`Stacks`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html diff --git a/aws/dist/awscli/examples/cloudformation/delete-change-set.rst b/aws/dist/awscli/examples/cloudformation/delete-change-set.rst new file mode 100755 index 00000000..72ca6435 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/delete-change-set.rst @@ -0,0 +1,16 @@ +**To delete a change set** + +The following ``delete-change-set`` example deletes a change set by specifying the change set name and stack name. :: + + aws cloudformation delete-change-set \ + --stack-name my-stack \ + --change-set-name my-change-set + +This command produces no output. + +The following ``delete-change-set`` example deletes a change set by specifying the full ARN of the change set. :: + + aws cloudformation delete-change-set \ + --change-set-name arn:aws:cloudformation:us-east-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0 + +This command produces no output. diff --git a/aws/dist/awscli/examples/cloudformation/delete-stack-instances.rst b/aws/dist/awscli/examples/cloudformation/delete-stack-instances.rst new file mode 100755 index 00000000..f40d7f9f --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/delete-stack-instances.rst @@ -0,0 +1,17 @@ +**To delete stack instances** + +The following ``delete-stack-instances`` example deletes instances of a stack set in two accounts in two regions and terminates the stacks. :: + + aws cloudformation delete-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 567890123456 \ + --regions us-east-1 us-west-1 \ + --no-retain-stacks + +Output:: + + { + "OperationId": "ad49f10c-fd1d-413f-a20a-8de6e2fa8f27" + } + +To delete an empty stack set, use the ``delete-stack-set`` command. diff --git a/aws/dist/awscli/examples/cloudformation/delete-stack-set.rst b/aws/dist/awscli/examples/cloudformation/delete-stack-set.rst new file mode 100755 index 00000000..39fa6aa9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/delete-stack-set.rst @@ -0,0 +1,10 @@ +**To delete a stack set** + +The following command deletes the specified empty stack set. The stack set must be empty. :: + + aws cloudformation delete-stack-set \ + --stack-set-name my-stack-set + +This command produces no output. + +To delete instances from the stack set, use the ``delete-stack-instances`` command. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/delete-stack.rst b/aws/dist/awscli/examples/cloudformation/delete-stack.rst new file mode 100755 index 00000000..2d8e67c8 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/delete-stack.rst @@ -0,0 +1,8 @@ +**To delete a stack** + +The following ``delete-stack`` example deletes the specified stack. :: + + aws cloudformation delete-stack \ + --stack-name my-stack + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/deploy.rst b/aws/dist/awscli/examples/cloudformation/deploy.rst new file mode 100644 index 00000000..77159d12 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/deploy.rst @@ -0,0 +1,6 @@ +Following command deploys template named ``template.json`` to a stack named +``my-new-stack``:: + + + aws cloudformation deploy --template-file /path_to_template/template.json --stack-name my-new-stack --parameter-overrides Key1=Value1 Key2=Value2 --tags Key1=Value1 Key2=Value2 + diff --git a/aws/dist/awscli/examples/cloudformation/describe-account-limits.rst b/aws/dist/awscli/examples/cloudformation/describe-account-limits.rst new file mode 100755 index 00000000..16d59eac --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-account-limits.rst @@ -0,0 +1,24 @@ +**To get information about your account limits** + +The following command retrieves a list of regional limits for the current account. :: + + aws cloudformation describe-account-limits + +Output:: + + { + "AccountLimits": [ + { + "Name": "StackLimit", + "Value": 200 + }, + { + "Name": "StackOutputsLimit", + "Value": 60 + }, + { + "Name": "ConcurrentResourcesLimit", + "Value": 2500 + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-change-set.rst b/aws/dist/awscli/examples/cloudformation/describe-change-set.rst new file mode 100755 index 00000000..126147bd --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-change-set.rst @@ -0,0 +1,59 @@ +**To get information about a change set** + +The following ``describe-change-set`` example displays the details of the change set specified by change set name and stack name. :: + + aws cloudformation describe-change-set \ + --change-set-name my-change-set \ + --stack-name my-stack + +The following ``describe-change-set`` example displays the details of the change set specified by the full ARN of the change set:: + + aws cloudformation describe-change-set \ + --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 + +Output:: + + { + "Changes": [ + { + "Type": "Resource", + "ResourceChange": { + "Action": "Modify", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "Replacement": "False", + "Scope": [ + "Properties" + ], + "Details": [ + { + "Target": { + "Attribute": "Properties", + "Name": "Timeout", + "RequiresRecreation": "Never" + }, + "Evaluation": "Static", + "ChangeSource": "DirectModification" + } + ] + } + } + ], + "ChangeSetName": "my-change-set", + "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/4eca1a01-e285-xmpl-8026-9a1967bfb4b0", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackName": "my-stack", + "Description": null, + "Parameters": null, + "CreationTime": "2019-10-02T05:20:56.651Z", + "ExecutionStatus": "AVAILABLE", + "Status": "CREATE_COMPLETE", + "StatusReason": null, + "NotificationARNs": [], + "RollbackConfiguration": {}, + "Capabilities": [ + "CAPABILITY_IAM" + ], + "Tags": null + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst new file mode 100755 index 00000000..77fc16da --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-drift-detection-status.rst @@ -0,0 +1,17 @@ +**To check a drift detection operation's status** + +The following ``describe-stack-drift-detection-status`` example displays the status of a drift detection operation. Get the by ID running the ``detect-stack-drift`` command. :: + + aws cloudformation describe-stack-drift-detection-status \ + --stack-drift-detection-id 1a229160-e4d9-xmpl-ab67-0a4f93df83d4 + +Output:: + + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4", + "StackDriftStatus": "DRIFTED", + "DetectionStatus": "DETECTION_COMPLETE", + "DriftedStackResourceCount": 1, + "Timestamp": "2019-10-02T05:54:30.902Z" + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-events.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-events.rst new file mode 100755 index 00000000..74ae6872 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-events.rst @@ -0,0 +1,33 @@ +**To describe stack events** + +The following ``describe-stack-events`` example displays the 2 most recent events for the specified stack. :: + + aws cloudformation describe-stack-events \ + --stack-name my-stack \ + --max-items 2 + + { + "StackEvents": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "EventId": "4e1516d0-e4d6-xmpl-b94f-0a51958a168c", + "StackName": "my-stack", + "LogicalResourceId": "my-stack", + "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "ResourceType": "AWS::CloudFormation::Stack", + "Timestamp": "2019-10-02T05:34:29.556Z", + "ResourceStatus": "UPDATE_COMPLETE" + }, + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "EventId": "4dd3c810-e4d6-xmpl-bade-0aaf8b31ab7a", + "StackName": "my-stack", + "LogicalResourceId": "my-stack", + "PhysicalResourceId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "ResourceType": "AWS::CloudFormation::Stack", + "Timestamp": "2019-10-02T05:34:29.127Z", + "ResourceStatus": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" + } + ], + "NextToken": "eyJOZXh0VG9XMPLiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-instance.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-instance.rst new file mode 100755 index 00000000..3add0573 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-instance.rst @@ -0,0 +1,22 @@ +**To describe a stack instance** + +The following command describes an instance of the specified stack set in the specified account and Region. The stack set is in the current region and account, and the instance is in the ``us-west-2`` region in account ``123456789012``.:: + + aws cloudformation describe-stack-instance \ + --stack-set-name my-stack-set \ + --stack-instance-account 123456789012 \ + --stack-instance-region us-west-2 + +Output:: + + { + "StackInstance": { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/4287f9a0-e615-xmpl-894a-12b31d3117be", + "ParameterOverrides": [], + "Status": "OUTDATED", + "StatusReason": "ResourceLogicalId:ConfigBucket, ResourceType:AWS::S3::Bucket, ResourceStatusReason:You have attempted to create more buckets than allowed (Service: Amazon S3; Status Code: 400; Error Code: TooManyBuckets; Request ID: F7F21CXMPL580224; S3 Extended Request ID: egd/Fdt89BXMPLyiqbMNljVk55Yqqvi3NYW2nKLUVWhUGEhNfCmZdyj967lhriaG/dWMobSO40o=)." + } + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-resource-drifts.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-resource-drifts.rst new file mode 100755 index 00000000..68244554 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-resource-drifts.rst @@ -0,0 +1,37 @@ +**To get information about resources that drifted from the stack definition** + +The following command displays information about drifted resources for the specified stack. To initiate drift detection, use the ``detect-stack-drift`` command.:: + + aws cloudformation describe-stack-resource-drifts \ + --stack-name my-stack + +The output shows an AWS Lambda function that was modified out-of-band:: + + { + "StackResourceDrifts": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "PropertyDifferences": [ + { + "PropertyPath": "/MemorySize", + "ExpectedValue": "128", + "ActualValue": "256", + "DifferenceType": "NOT_EQUAL" + }, + { + "PropertyPath": "/Timeout", + "ExpectedValue": "900", + "ActualValue": "22", + "DifferenceType": "NOT_EQUAL" + } + ], + "StackResourceDriftStatus": "MODIFIED", + "Timestamp": "2019-10-02T05:54:44.064Z" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-resource.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-resource.rst new file mode 100755 index 00000000..5aae5b1e --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-resource.rst @@ -0,0 +1,25 @@ +**To get information about a stack resource** + +The following ``describe-stack-resource`` example displays details for the resource named ``MyFunction`` in the specified stack. :: + + aws cloudformation describe-stack-resource \ + --stack-name MyStack \ + --logical-resource-id MyFunction + +Output:: + + { + "StackResourceDetail": { + "StackName": "MyStack", + "StackId": "arn:aws:cloudformation:us-east-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "MyFunction", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "Metadata": "{}", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-resources.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-resources.rst new file mode 100755 index 00000000..38025701 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-resources.rst @@ -0,0 +1,49 @@ +**To get information about a stack resource** + +The following ``describe-stack-resources`` example displays details for the resources in the specified stack. :: + + aws cloudformation describe-stack-resources \ + --stack-name my-stack + +Output:: + + { + "StackResources": [ + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "bucket", + "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", + "ResourceType": "AWS::S3::Bucket", + "Timestamp": "2019-10-02T04:34:11.345Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "Timestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "StackName": "my-stack", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "functionRole", + "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", + "ResourceType": "AWS::IAM::Role", + "Timestamp": "2019-10-02T04:34:06.350Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-set-operation.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-set-operation.rst new file mode 100755 index 00000000..db06d7c7 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-set-operation.rst @@ -0,0 +1,32 @@ +**To get information about a stack set operation** + +The following `describe-stack-set-operation`` example displays details for an update operation on the specified stack set. :: + + aws cloudformation describe-stack-set-operation \ + --stack-set-name enable-config \ + --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 + +Output:: + + { + "StackSetOperation": { + "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Action": "UPDATE", + "Status": "SUCCEEDED", + "OperationPreferences": { + "RegionOrder": [ + "us-east-1", + "us-west-2", + "eu-west-1", + "us-west-1" + ], + "FailureToleranceCount": 7, + "MaxConcurrentCount": 2 + }, + "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", + "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole", + "CreationTimestamp": "2019-10-03T16:28:44.377Z", + "EndTimestamp": "2019-10-03T16:42:08.607Z" + } + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stack-set.rst b/aws/dist/awscli/examples/cloudformation/describe-stack-set.rst new file mode 100755 index 00000000..04cab3e9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stack-set.rst @@ -0,0 +1,24 @@ +**To get information about a stack set** + +The following `describe-stack-set`` example displays details about the specified stack set. :: + + aws cloudformation describe-stack-set \ + --stack-set-name my-stack-set + +Output:: + + { + "StackSet": { + "StackSetName": "my-stack-set", + "StackSetId": "my-stack-set:296a3360-xmpl-40af-be78-9341e95bf743", + "Description": "Create an Amazon SNS topic", + "Status": "ACTIVE", + "TemplateBody": "AWSTemplateFormatVersion: '2010-09-09'\nDescription: An AWS SNS topic\nResources:\n topic:\n Type: AWS::SNS::Topic", + "Parameters": [], + "Capabilities": [], + "Tags": [], + "StackSetARN": "arn:aws:cloudformation:us-west-2:123456789012:stackset/enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "AdministrationRoleARN": "arn:aws:iam::123456789012:role/AWSCloudFormationStackSetAdministrationRole", + "ExecutionRoleName": "AWSCloudFormationStackSetExecutionRole" + } + } diff --git a/aws/dist/awscli/examples/cloudformation/describe-stacks.rst b/aws/dist/awscli/examples/cloudformation/describe-stacks.rst new file mode 100644 index 00000000..3f49238c --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/describe-stacks.rst @@ -0,0 +1,33 @@ +**To describe AWS CloudFormation stacks** + +The following ``describe-stacks`` command shows summary information for the ``myteststack`` stack:: + + aws cloudformation describe-stacks --stack-name myteststack + +Output:: + + { + "Stacks": [ + { + "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896", + "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", + "Tags": [], + "Outputs": [ + { + "Description": "Name of S3 bucket to hold website content", + "OutputKey": "BucketName", + "OutputValue": "myteststack-s3bucket-jssofi1zie2w" + } + ], + "StackStatusReason": null, + "CreationTime": "2013-08-23T01:02:15.422Z", + "Capabilities": [], + "StackName": "myteststack", + "StackStatus": "CREATE_COMPLETE", + "DisableRollback": false + } + ] + +For more information, see `Stacks`_ in the *AWS CloudFormation User Guide*. + +.. _`Stacks`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html diff --git a/aws/dist/awscli/examples/cloudformation/detect-stack-drift.rst b/aws/dist/awscli/examples/cloudformation/detect-stack-drift.rst new file mode 100755 index 00000000..115fdbbf --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/detect-stack-drift.rst @@ -0,0 +1,14 @@ +**To detect drifted resources** + +The following ``detect-stack-drift`` example initiates drift detection for the specified stack. :: + + aws cloudformation detect-stack-drift \ + --stack-name my-stack + +Output:: + + { + "StackDriftDetectionId": "1a229160-e4d9-xmpl-ab67-0a4f93df83d4" + } + +You can then use this ID with the ``describe-stack-resource-drifts`` command to describe drifted resources. diff --git a/aws/dist/awscli/examples/cloudformation/detect-stack-resource-drift.rst b/aws/dist/awscli/examples/cloudformation/detect-stack-resource-drift.rst new file mode 100755 index 00000000..c75b7846 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/detect-stack-resource-drift.rst @@ -0,0 +1,36 @@ +**To detect drift for a resource** + +The following ``detect-stack-resource-drift`` example checks a resource named ``MyFunction`` in a stack named ``MyStack`` for drift:: + + aws cloudformation detect-stack-resource-drift \ + --stack-name MyStack \ + --logical-resource-id MyFunction + +The output shows an AWS Lambda function that was modified out-of-band:: + + { + "StackResourceDrift": { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/MyStack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "LogicalResourceId": "MyFunction", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "ExpectedProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":128,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":900,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "ActualProperties": "{\"Description\":\"Write a file to S3.\",\"Environment\":{\"Variables\":{\"bucket\":\"my-stack-bucket-1vc62xmplgguf\"}},\"Handler\":\"index.handler\",\"MemorySize\":256,\"Role\":\"arn:aws:iam::123456789012:role/my-functionRole-HIZXMPLEOM9E\",\"Runtime\":\"nodejs10.x\",\"Tags\":[{\"Key\":\"lambda:createdBy\",\"Value\":\"SAM\"}],\"Timeout\":22,\"TracingConfig\":{\"Mode\":\"Active\"}}", + "PropertyDifferences": [ + { + "PropertyPath": "/MemorySize", + "ExpectedValue": "128", + "ActualValue": "256", + "DifferenceType": "NOT_EQUAL" + }, + { + "PropertyPath": "/Timeout", + "ExpectedValue": "900", + "ActualValue": "22", + "DifferenceType": "NOT_EQUAL" + } + ], + "StackResourceDriftStatus": "MODIFIED", + "Timestamp": "2019-10-02T05:58:47.433Z" + } + } diff --git a/aws/dist/awscli/examples/cloudformation/estimate-template-cost.rst b/aws/dist/awscli/examples/cloudformation/estimate-template-cost.rst new file mode 100755 index 00000000..eaa3fc4c --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/estimate-template-cost.rst @@ -0,0 +1,12 @@ +**To estimate template cost** + +The following ``estimate-template-cost`` example generates a cost estimate for a template named ``template.yaml`` in the current folder. :: + + aws cloudformation estimate-template-cost \ + --template-body file://template.yaml + +Output:: + + { + "Url": "http://calculator.s3.amazonaws.com/calc5.html?key=cloudformation/7870825a-xmpl-4def-92e7-c4f8dd360cca" + } diff --git a/aws/dist/awscli/examples/cloudformation/execute-change-set.rst b/aws/dist/awscli/examples/cloudformation/execute-change-set.rst new file mode 100755 index 00000000..675335db --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/execute-change-set.rst @@ -0,0 +1,12 @@ +**To execute a change set** + +The following ``execute-change-set`` example executes a change set specified by change set name and stack name. :: + + aws cloudformation execute-change-set \ + --change-set-name my-change-set \ + --stack-name my-stack + +The following ``execute-change-set`` example executes a change set specified by the full ARN of the change set. :: + + aws cloudformation execute-change-set \ + --change-set-name arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/bc9555ba-a949-xmpl-bfb8-f41d04ec5784 diff --git a/aws/dist/awscli/examples/cloudformation/get-stack-policy.rst b/aws/dist/awscli/examples/cloudformation/get-stack-policy.rst new file mode 100755 index 00000000..46086dd9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/get-stack-policy.rst @@ -0,0 +1,12 @@ +**To view a stack policy** + +The following ``get-stack-policy`` example displays the stack policy for the specified stack. To attach a policy to a stack, use the ``set-stack-policy`` command. :: + + aws cloudformation get-stack-policy \ + --stack-name my-stack + +Output:: + + { + "StackPolicyBody": "{\n \"Statement\" : [\n {\n \"Effect\" : \"Allow\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"*\"\n },\n {\n \"Effect\" : \"Deny\",\n \"Action\" : \"Update:*\",\n \"Principal\": \"*\",\n \"Resource\" : \"LogicalResourceId/bucket\"\n }\n ]\n}\n" + } diff --git a/aws/dist/awscli/examples/cloudformation/get-template-summary.rst b/aws/dist/awscli/examples/cloudformation/get-template-summary.rst new file mode 100755 index 00000000..522ba2e7 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/get-template-summary.rst @@ -0,0 +1,24 @@ +**To display a template summary** + +The following command displays summary information about the resources and metadata for the specified template file. :: + + aws cloudformation get-template-summary \ + --template-body file://template.yaml + +Output:: + + { + "Parameters": [], + "Description": "A VPC and subnets.", + "ResourceTypes": [ + "AWS::EC2::VPC", + "AWS::EC2::Subnet", + "AWS::EC2::Subnet", + "AWS::EC2::RouteTable", + "AWS::EC2::VPCEndpoint", + "AWS::EC2::SubnetRouteTableAssociation", + "AWS::EC2::SubnetRouteTableAssociation", + "AWS::EC2::VPCEndpoint" + ], + "Version": "2010-09-09" + } diff --git a/aws/dist/awscli/examples/cloudformation/get-template.rst b/aws/dist/awscli/examples/cloudformation/get-template.rst new file mode 100644 index 00000000..a911f7a9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/get-template.rst @@ -0,0 +1,30 @@ +**To view the template body for an AWS CloudFormation stack** + +The following ``get-template`` command shows the template for the ``myteststack`` stack:: + + aws cloudformation get-template --stack-name myteststack + +Output:: + + { + "TemplateBody": { + "AWSTemplateFormatVersion": "2010-09-09", + "Outputs": { + "BucketName": { + "Description": "Name of S3 bucket to hold website content", + "Value": { + "Ref": "S3Bucket" + } + } + }, + "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", + "Resources": { + "S3Bucket": { + "Type": "AWS::S3::Bucket", + "Properties": { + "AccessControl": "PublicRead" + } + } + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/list-change-sets.rst b/aws/dist/awscli/examples/cloudformation/list-change-sets.rst new file mode 100755 index 00000000..c31968b7 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-change-sets.rst @@ -0,0 +1,22 @@ +**To list change sets** + +The following ``list-change-sets`` example displays a list of the pending change sets for the specified stack. :: + + aws cloudformation list-change-sets \ + --stack-name my-stack + +Output:: + + { + "Summaries": [ + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204", + "StackName": "my-stack", + "ChangeSetId": "arn:aws:cloudformation:us-west-2:123456789012:changeSet/my-change-set/70160340-7914-xmpl-bcbf-128a1fa78b5d", + "ChangeSetName": "my-change-set", + "ExecutionStatus": "AVAILABLE", + "Status": "CREATE_COMPLETE", + "CreationTime": "2019-10-02T05:38:54.297Z" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-exports.rst b/aws/dist/awscli/examples/cloudformation/list-exports.rst new file mode 100755 index 00000000..f7093cb5 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-exports.rst @@ -0,0 +1,27 @@ +**To list exports** + +The following ``list-exports`` example displays a list of the exports from stacks in the current region. :: + + aws cloudformation list-exports + +Output:: + + { + "Exports": [ + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-subnet-a", + "Value": "subnet-07b410xmplddcfa03" + }, + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-subnet-b", + "Value": "subnet-075ed3xmplebd2fb1" + }, + { + "ExportingStackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/private-vpc/99764070-b56c-xmpl-bee8-062a88d1d800", + "Name": "private-vpc-vpcid", + "Value": "vpc-011d7xmpl100e9841" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-imports.rst b/aws/dist/awscli/examples/cloudformation/list-imports.rst new file mode 100755 index 00000000..49a218db --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-imports.rst @@ -0,0 +1,14 @@ +**To list imports** + +The following ``list-imports`` example lists the stacks that import the specified export. To get the list of available exports, use the ``list-exports`` command. :: + + aws cloudformation list-imports \ + --export-name private-vpc-vpcid + +Output:: + + { + "Imports": [ + "my-database-stack" + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-stack-instances.rst b/aws/dist/awscli/examples/cloudformation/list-stack-instances.rst new file mode 100755 index 00000000..75ee9dd5 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stack-instances.rst @@ -0,0 +1,28 @@ +**To list instances for a stack** + +The following ``list-stack-instances`` example lists the instances created from the specified stack set. :: + + aws cloudformation list-stack-instances \ + --stack-set-name enable-config + +The example output includes details about a stack that failed to update due to an error:: + + { + "Summaries": [ + { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:ap-northeast-1:123456789012:stack/StackSet-enable-config-35a6ac50-d9f8-4084-86e4-7da34d5de4c4/a1631cd0-e5fb-xmpl-b474-0aa20f14f06e", + "Status": "CURRENT" + }, + { + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Region": "us-west-2", + "Account": "123456789012", + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532/eab53680-e5fa-xmpl-ba14-0a522351f81e", + "Status": "OUTDATED", + "StatusReason": "ResourceLogicalId:ConfigDeliveryChannel, ResourceType:AWS::Config::DeliveryChannel, ResourceStatusReason:Failed to put delivery channel 'StackSet-enable-config-e6cac20f-xmpl-46e9-8314-53e0d4591532-ConfigDeliveryChannel-1OJWJ7XD59WR0' because the maximum number of delivery channels: 1 is reached. (Service: AmazonConfig; Status Code: 400; Error Code: MaxNumberOfDeliveryChannelsExceededException; Request ID: d14b34a0-ef7c-xmpl-acf8-8a864370ae56)." + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-stack-resources.rst b/aws/dist/awscli/examples/cloudformation/list-stack-resources.rst new file mode 100755 index 00000000..5a3d9da0 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stack-resources.rst @@ -0,0 +1,43 @@ +**To list resources in a stack** + +The following command displays the list of resources in the specified stack. :: + + aws cloudformation list-stack-resources \ + --stack-name my-stack + +Output:: + + { + "StackResourceSummaries": [ + { + "LogicalResourceId": "bucket", + "PhysicalResourceId": "my-stack-bucket-1vc62xmplgguf", + "ResourceType": "AWS::S3::Bucket", + "LastUpdatedTimestamp": "2019-10-02T04:34:11.345Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "LogicalResourceId": "function", + "PhysicalResourceId": "my-function-SEZV4XMPL4S5", + "ResourceType": "AWS::Lambda::Function", + "LastUpdatedTimestamp": "2019-10-02T05:34:27.989Z", + "ResourceStatus": "UPDATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + }, + { + "LogicalResourceId": "functionRole", + "PhysicalResourceId": "my-functionRole-HIZXMPLEOM9E", + "ResourceType": "AWS::IAM::Role", + "LastUpdatedTimestamp": "2019-10-02T04:34:06.350Z", + "ResourceStatus": "CREATE_COMPLETE", + "DriftInformation": { + "StackResourceDriftStatus": "IN_SYNC" + } + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-stack-set-operation-results.rst b/aws/dist/awscli/examples/cloudformation/list-stack-set-operation-results.rst new file mode 100755 index 00000000..0e25d791 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stack-set-operation-results.rst @@ -0,0 +1,31 @@ +**To list stack set operation results** + +The following command displays the results of an update operation on instances in the specified stack set. :: + + aws cloudformation list-stack-set-operation-results \ + --stack-set-name enable-config \ + --operation-id 35d45ebc-ed88-xmpl-ab59-0197a1fc83a0 + +Output:: + + { + "Summaries": [ + { + "Account": "223456789012", + "Region": "us-west-2", + "Status": "SUCCEEDED", + "AccountGateResult": { + "Status": "SKIPPED", + "StatusReason": "Function not found: arn:aws:lambda:eu-west-1:223456789012:function:AWSCloudFormationStackSetAccountGate" + } + }, + { + "Account": "223456789012", + "Region": "ap-south-1", + "Status": "CANCELLED", + "StatusReason": "Cancelled since failure tolerance has exceeded" + } + ] + } + +**Note:** The ``SKIPPED`` status for ``AccountGateResult`` is expected for successful operations unless you create an account gate function. diff --git a/aws/dist/awscli/examples/cloudformation/list-stack-set-operations.rst b/aws/dist/awscli/examples/cloudformation/list-stack-set-operations.rst new file mode 100755 index 00000000..685bf7b4 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stack-set-operations.rst @@ -0,0 +1,27 @@ +**To list stack set operations** + +The following ``list-stack-set-operations`` example displays the list of the most recent operations on the specified stack set. :: + + aws cloudformation list-stack-set-operations \ + --stack-set-name my-stack-set + +Output:: + + { + "Summaries": [ + { + "OperationId": "35d45ebc-ed88-xmpl-ab59-0197a1fc83a0", + "Action": "UPDATE", + "Status": "SUCCEEDED", + "CreationTimestamp": "2019-10-03T16:28:44.377Z", + "EndTimestamp": "2019-10-03T16:42:08.607Z" + }, + { + "OperationId": "891aa98f-7118-xmpl-00b2-00954d1dd0d6", + "Action": "UPDATE", + "Status": "FAILED", + "CreationTimestamp": "2019-10-03T15:43:53.916Z", + "EndTimestamp": "2019-10-03T15:45:58.925Z" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-stack-sets.rst b/aws/dist/awscli/examples/cloudformation/list-stack-sets.rst new file mode 100755 index 00000000..768b28c2 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stack-sets.rst @@ -0,0 +1,18 @@ +**To list stack sets** + +The following ``list-stack-sets`` example displays the list of stack sets in the current region and account. :: + + aws cloudformation list-stack-sets + +Output:: + + { + "Summaries": [ + { + "StackSetName": "enable-config", + "StackSetId": "enable-config:296a3360-xmpl-40af-be78-9341e95bf743", + "Description": "Enable AWS Config", + "Status": "ACTIVE" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/list-stacks.rst b/aws/dist/awscli/examples/cloudformation/list-stacks.rst new file mode 100644 index 00000000..81a0e27f --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/list-stacks.rst @@ -0,0 +1,18 @@ +**To list AWS CloudFormation stacks** + +The following ``list-stacks`` command shows a summary of all stacks that have a status of ``CREATE_COMPLETE``:: + + aws cloudformation list-stacks --stack-status-filter CREATE_COMPLETE + +Output:: + + [ + { + "StackId": "arn:aws:cloudformation:us-east-1:123456789012:stack/myteststack/466df9e0-0dff-08e3-8e2f-5088487c4896", + "TemplateDescription": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", + "StackStatusReason": null, + "CreationTime": "2013-08-26T03:27:10.190Z", + "StackName": "myteststack", + "StackStatus": "CREATE_COMPLETE" + } + ] \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/package.rst b/aws/dist/awscli/examples/cloudformation/package.rst new file mode 100644 index 00000000..48c8a499 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/package.rst @@ -0,0 +1,6 @@ +Following command exports a template named ``template.json`` by uploading local +artifacts to S3 bucket ``bucket-name`` and writes the exported template to +``packaged-template.json``:: + + aws cloudformation package --template-file /path_to_template/template.json --s3-bucket bucket-name --output-template-file packaged-template.json + diff --git a/aws/dist/awscli/examples/cloudformation/set-stack-policy.rst b/aws/dist/awscli/examples/cloudformation/set-stack-policy.rst new file mode 100755 index 00000000..05e3276a --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/set-stack-policy.rst @@ -0,0 +1,26 @@ +**To apply a stack policy** + +The following ``set-stack-policy`` example disables updates for the specified resource in the specified stack. ``stack-policy.json`` is a JSON document that defines the operations allowed on resources in the stack. :: + + aws cloudformation set-stack-policy \ + --stack-name my-stack \ + --stack-policy-body file://stack-policy.json + +Output:: + + { + "Statement" : [ + { + "Effect" : "Allow", + "Action" : "Update:*", + "Principal": "*", + "Resource" : "*" + }, + { + "Effect" : "Deny", + "Action" : "Update:*", + "Principal": "*", + "Resource" : "LogicalResourceId/bucket" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudformation/signal-resource.rst b/aws/dist/awscli/examples/cloudformation/signal-resource.rst new file mode 100755 index 00000000..59b04027 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/signal-resource.rst @@ -0,0 +1,11 @@ +**To signal a resource** + +The following ``signal-resource`` example signals ``success`` to fulfill the wait condition named ``MyWaitCondition`` in the stack named ``my-stack``. :: + + aws cloudformation signal-resource \ + --stack-name my-stack \ + --logical-resource-id MyWaitCondition \ + --unique-id 1234 \ + --status SUCCESS + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/stop-stack-set-operation.rst b/aws/dist/awscli/examples/cloudformation/stop-stack-set-operation.rst new file mode 100755 index 00000000..e15a6040 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/stop-stack-set-operation.rst @@ -0,0 +1,9 @@ +**To stop a stack set operation** + +The following ``stop-stack-set-operation`` example stops an in-progess update operation on the specified stack set. :: + + aws cloudformation stop-stack-set-operation \ + --stack-set-name my-stack-set \ + --operation-id 1261cd27-490b-xmpl-ab42-793a896c69e6 + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudformation/update-stack-instances.rst b/aws/dist/awscli/examples/cloudformation/update-stack-instances.rst new file mode 100755 index 00000000..3050ceb7 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/update-stack-instances.rst @@ -0,0 +1,15 @@ +**To update stack instances** + +The following ``update-stack-instances`` example retries an update on stack instances in two accounts in two regions with the most recent settings. The specified fault tolerance setting ensures that the update is attempted in all accounts and regions, even if some stacks cannot be updated. :: + + aws cloudformation update-stack-instances \ + --stack-set-name my-stack-set \ + --accounts 123456789012 567890123456 \ + --regions us-east-1 us-west-2 \ + --operation-preferences FailureToleranceCount=3 + +Output:: + + { + "OperationId": "103ebdf2-21ea-xmpl-8892-de5e30733132" + } diff --git a/aws/dist/awscli/examples/cloudformation/update-stack-set.rst b/aws/dist/awscli/examples/cloudformation/update-stack-set.rst new file mode 100755 index 00000000..b6a070f2 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/update-stack-set.rst @@ -0,0 +1,14 @@ +**To update a stack set** + +The following ``update-stack-set`` example adds a tag with the key name ``Owner`` and a value of ``IT`` to the stack instances in the specified stack set. :: + + aws cloudformation update-stack-set \ + --stack-set-name my-stack-set \ + --use-previous-template \ + --tags Key=Owner,Value=IT + +Output:: + + { + "OperationId": "e2b60321-6cab-xmpl-bde7-530c6f47950e" + } diff --git a/aws/dist/awscli/examples/cloudformation/update-stack.rst b/aws/dist/awscli/examples/cloudformation/update-stack.rst new file mode 100644 index 00000000..b5c5f565 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/update-stack.rst @@ -0,0 +1,16 @@ +**To update AWS CloudFormation stacks** + +The following ``update-stack`` command updates the template and input parameters for the ``mystack`` stack:: + + aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,ParameterValue=SampleKeyPair ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,SampleSubnetID2 + +The following ``update-stack`` command updates just the ``SubnetIDs`` parameter value for the ``mystack`` stack. If you +don't specify a parameter value, the default value that is specified in the template is used:: + + aws cloudformation update-stack --stack-name mystack --template-url https://s3.amazonaws.com/sample/updated.template --parameters ParameterKey=KeyPairName,UsePreviousValue=true ParameterKey=SubnetIDs,ParameterValue=SampleSubnetID1\\,UpdatedSampleSubnetID2 + +The following ``update-stack`` command adds two stack notification topics to the ``mystack`` stack:: + + aws cloudformation update-stack --stack-name mystack --use-previous-template --notification-arns "arn:aws:sns:use-east-1:123456789012:mytopic1" "arn:aws:sns:us-east-1:123456789012:mytopic2" + +For more information, see `Updating a Stack`_ in the *AWS CloudFormation User Guide*. diff --git a/aws/dist/awscli/examples/cloudformation/update-termination-protection.rst b/aws/dist/awscli/examples/cloudformation/update-termination-protection.rst new file mode 100755 index 00000000..7371db60 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/update-termination-protection.rst @@ -0,0 +1,13 @@ +**To enable termination protection** + +The following ``update-termination-protection`` example enables termination protection on the specified stack. :: + + aws cloudformation update-termination-protection \ + --stack-name my-stack \ + --enable-termination-protection + +Output:: + + { + "StackId": "arn:aws:cloudformation:us-west-2:123456789012:stack/my-stack/d0a825a0-e4cd-xmpl-b9fb-061c69e99204" + } diff --git a/aws/dist/awscli/examples/cloudformation/validate-template.rst b/aws/dist/awscli/examples/cloudformation/validate-template.rst new file mode 100644 index 00000000..f3019607 --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/validate-template.rst @@ -0,0 +1,17 @@ +**To validate an AWS CloudFormation template** + +The following ``validate-template`` command validates the ``sampletemplate.json`` template:: + + aws cloudformation validate-template --template-body file://sampletemplate.json + +Output:: + + { + "Description": "AWS CloudFormation Sample Template S3_Bucket: Sample template showing how to create a publicly accessible S3 bucket. **WARNING** This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", + "Parameters": [], + "Capabilities": [] + } + +For more information, see `Working with AWS CloudFormation Templates`_ in the *AWS CloudFormation User Guide*. + +.. _`Working with AWS CloudFormation Templates`: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-guide.html diff --git a/aws/dist/awscli/examples/cloudformation/wait/change-set-create-complete.rst b/aws/dist/awscli/examples/cloudformation/wait/change-set-create-complete.rst new file mode 100755 index 00000000..7741565c --- /dev/null +++ b/aws/dist/awscli/examples/cloudformation/wait/change-set-create-complete.rst @@ -0,0 +1,9 @@ +**To wait for a change set to finish creating** + +The following ``wait change-set-create-complete`` example pauses and resumes only after it can confirm that the specified change set in the specified stack is ready to run. :: + + aws cloudformation wait change-set-create-complete \ + --stack-name my-stack \ + --change-set-name my-change-set + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudfront/create-distribution.rst b/aws/dist/awscli/examples/cloudfront/create-distribution.rst new file mode 100644 index 00000000..9344fa79 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/create-distribution.rst @@ -0,0 +1,163 @@ +**To create a CloudFront Web Distribution** + +You can create a CloudFront web distribution for an S3 domain (such as +my-bucket.s3.amazonaws.com) or for a custom domain (such as example.com). +The following command shows an example for an S3 domain, and optionally also +specifies a default root object:: + + aws cloudfront create-distribution \ + --origin-domain-name my-bucket.s3.amazonaws.com \ + --default-root-object index.html + +Or you can use the following command together with a JSON document to do the +same thing:: + + aws cloudfront create-distribution --distribution-config file://distconfig.json + +The file ``distconfig.json`` is a JSON document in the current folder that defines a CloudFront distribution:: + + { + "CallerReference": "my-distribution-2015-09-01", + "Aliases": { + "Quantity": 0 + }, + "DefaultRootObject": "index.html", + "Origins": { + "Quantity": 1, + "Items": [ + { + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com", + "S3OriginConfig": { + "OriginAccessIdentity": "" + } + } + ] + }, + "DefaultCacheBehavior": { + "TargetOriginId": "my-origin", + "ForwardedValues": { + "QueryString": true, + "Cookies": { + "Forward": "none" + } + }, + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "ViewerProtocolPolicy": "allow-all", + "MinTTL": 3600 + }, + "CacheBehaviors": { + "Quantity": 0 + }, + "Comment": "", + "Logging": { + "Enabled": false, + "IncludeCookies": true, + "Bucket": "", + "Prefix": "" + }, + "PriceClass": "PriceClass_All", + "Enabled": true + } + + +Output:: + + { + "Distribution": { + "Status": "InProgress", + "DomainName": "d2wkuj2w9l34gt.cloudfront.net", + "InProgressInvalidationBatches": 0, + "DistributionConfig": { + "Comment": "", + "CacheBehaviors": { + "Quantity": 0 + }, + "Logging": { + "Bucket": "", + "Prefix": "", + "Enabled": false, + "IncludeCookies": false + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DefaultRootObject": "", + "PriceClass": "PriceClass_All", + "Enabled": true, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "CallerReference": "my-distribution-2015-09-01", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + }, + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "LastModifiedTime": "2015-08-31T21:11:29.093Z", + "Id": "S11A16G5KZMEQD" + }, + "ETag": "E37HOT42DHPVYH", + "Location": "https://cloudfront.amazonaws.com/2015-04-17/distribution/S11A16G5KZMEQD" + } diff --git a/aws/dist/awscli/examples/cloudfront/create-invalidation.rst b/aws/dist/awscli/examples/cloudfront/create-invalidation.rst new file mode 100644 index 00000000..8b71998d --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/create-invalidation.rst @@ -0,0 +1,45 @@ +**To create an invalidation for a CloudFront distribution** + +The following command creates an invalidation for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront create-invalidation --distribution-id S11A16G5KZMEQD \ + --paths /index.html /error.html + +The --paths will automatically generate a random ``CallerReference`` every time. + +Or you can use the following command to do the same thing, so that you can have a chance to specify your own ``CallerReference`` here:: + + aws cloudfront create-invalidation --invalidation-batch file://invbatch.json --distribution-id S11A16G5KZMEQD + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + +The file ``invbatch.json`` is a JSON document in the current folder that specifies two paths to invalidate:: + + { + "Paths": { + "Quantity": 2, + "Items": ["/index.html", "/error.html"] + }, + "CallerReference": "my-invalidation-2015-09-01" + } + +Output of both commands:: + + { + "Invalidation": { + "Status": "InProgress", + "InvalidationBatch": { + "Paths": { + "Items": [ + "/index.html", + "/error.html" + ], + "Quantity": 2 + }, + "CallerReference": "my-invalidation-2015-09-01" + }, + "Id": "YNY2LI2BVJ4NJU", + "CreateTime": "2015-08-31T21:15:52.042Z" + }, + "Location": "https://cloudfront.amazonaws.com/2015-04-17/distribution/S11A16G5KZMEQD/invalidation/YNY2LI2BVJ4NJU" + } diff --git a/aws/dist/awscli/examples/cloudfront/delete-distribution.rst b/aws/dist/awscli/examples/cloudfront/delete-distribution.rst new file mode 100644 index 00000000..cf8ae014 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/delete-distribution.rst @@ -0,0 +1,7 @@ +**To delete a CloudFront distribution** + +The following command deletes a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront delete-distribution --id S11A16G5KZMEQD --if-match 8UBQECEJX24ST + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The distribution must be disabled with ``update-distribution`` prior to deletion. The ETag value ``8UBQECEJX24ST`` for the ``if-match`` parameter is available in the output of ``update-distribution``, ``get-distribution`` or ``get-distribution-config``. diff --git a/aws/dist/awscli/examples/cloudfront/get-distribution-config.rst b/aws/dist/awscli/examples/cloudfront/get-distribution-config.rst new file mode 100644 index 00000000..61b2331c --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/get-distribution-config.rst @@ -0,0 +1,93 @@ +**To get information about a Cloudfront distribution config** + +The following command gets a distribution config for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront get-distribution-config --id S11A16G5KZMEQD + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + +Output:: + + { + "ETag": "E37HOT42DHPVYH", + "DistributionConfig": { + "Comment": "", + "CacheBehaviors": { + "Quantity": 0 + }, + "Logging": { + "Bucket": "", + "Prefix": "", + "Enabled": false, + "IncludeCookies": false + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DefaultRootObject": "", + "PriceClass": "PriceClass_All", + "Enabled": true, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "CallerReference": "my-distribution-2015-09-01", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + } + } diff --git a/aws/dist/awscli/examples/cloudfront/get-distribution.rst b/aws/dist/awscli/examples/cloudfront/get-distribution.rst new file mode 100644 index 00000000..e3a34de9 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/get-distribution.rst @@ -0,0 +1,104 @@ +**To get information about a CloudFront distribution** + +The following command gets a distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront get-distribution --id S11A16G5KZMEQD + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + +Output:: + + { + "Distribution": { + "Status": "Deployed", + "DomainName": "d2wkuj2w9l34gt.cloudfront.net", + "InProgressInvalidationBatches": 0, + "DistributionConfig": { + "Comment": "", + "CacheBehaviors": { + "Quantity": 0 + }, + "Logging": { + "Bucket": "", + "Prefix": "", + "Enabled": false, + "IncludeCookies": false + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DefaultRootObject": "", + "PriceClass": "PriceClass_All", + "Enabled": true, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "CallerReference": "my-distribution-2015-09-01", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + }, + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "LastModifiedTime": "2015-08-31T21:11:29.093Z", + "Id": "S11A16G5KZMEQD" + }, + "ETag": "E37HOT42DHPVYH" + } diff --git a/aws/dist/awscli/examples/cloudfront/get-invalidation.rst b/aws/dist/awscli/examples/cloudfront/get-invalidation.rst new file mode 100644 index 00000000..fee15e48 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/get-invalidation.rst @@ -0,0 +1,27 @@ +**To get information about an invalidation** + +The following command retrieves an invalidation with the ID ``YNY2LI2BVJ4NJU`` for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront get-invalidation --id YNY2LI2BVJ4NJU --distribution-id S11A16G5KZMEQD + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The invalidation ID is available in the output of ``create-invalidation`` and ``list-invalidations``. + +Output:: + + { + "Invalidation": { + "Status": "Completed", + "InvalidationBatch": { + "Paths": { + "Items": [ + "/index.html", + "/error.html" + ], + "Quantity": 2 + }, + "CallerReference": "my-invalidation-2015-09-01" + }, + "Id": "YNY2LI2BVJ4NJU", + "CreateTime": "2015-08-31T21:15:52.042Z" + } + } diff --git a/aws/dist/awscli/examples/cloudfront/list-distributions.rst b/aws/dist/awscli/examples/cloudfront/list-distributions.rst new file mode 100644 index 00000000..a8982bb3 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/list-distributions.rst @@ -0,0 +1,95 @@ +**To list CloudFront distributions** + +The following command retrieves a list of distributions:: + + aws cloudfront list-distributions + +Output:: + + { + "DistributionList": { + "Marker": "", + "Items": [ + { + "Status": "Deployed", + "ARN": "arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5", + "CacheBehaviors": { + "Quantity": 0 + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DomainName": "d2wkuj2w9l34gt.cloudfront.net", + "PriceClass": "PriceClass_All", + "Enabled": true, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "Comment": "", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "LastModifiedTime": "2015-08-31T21:11:29.093Z", + "Id": "S11A16G5KZMEQD", + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + } + ], + "IsTruncated": false, + "MaxItems": 100, + "Quantity": 1 + } + } diff --git a/aws/dist/awscli/examples/cloudfront/list-invalidations.rst b/aws/dist/awscli/examples/cloudfront/list-invalidations.rst new file mode 100644 index 00000000..c8efeb08 --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/list-invalidations.rst @@ -0,0 +1,25 @@ +**To list CloudFront invalidations** + +The following command retrieves a list of invalidations for a CloudFront web distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront list-invalidations --distribution-id S11A16G5KZMEQD + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. + +Output:: + + { + "InvalidationList": { + "Marker": "", + "Items": [ + { + "Status": "Completed", + "Id": "YNY2LI2BVJ4NJU", + "CreateTime": "2015-08-31T21:15:52.042Z" + } + ], + "IsTruncated": false, + "MaxItems": 100, + "Quantity": 1 + } + } diff --git a/aws/dist/awscli/examples/cloudfront/update-distribution.rst b/aws/dist/awscli/examples/cloudfront/update-distribution.rst new file mode 100644 index 00000000..e116c11a --- /dev/null +++ b/aws/dist/awscli/examples/cloudfront/update-distribution.rst @@ -0,0 +1,195 @@ +**To update a CloudFront distribution** + +The following command updates the Default Root Object to "index.html" +for a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront update-distribution --id S11A16G5KZMEQD \ + --default-root-object index.html + +The following command disables a CloudFront distribution with the ID ``S11A16G5KZMEQD``:: + + aws cloudfront update-distribution --id S11A16G5KZMEQD --distribution-config file://distconfig-disabled.json --if-match E37HOT42DHPVYH + +The distribution ID is available in the output of ``create-distribution`` and ``list-distributions``. The ETag value ``E37HOT42DHPVYH`` for the ``if-match`` parameter is available in the output of ``create-distribution``, ``get-distribution`` or ``get-distribution-config``. + +The file ``distconfig-disabled.json`` is a JSON document in the current folder that modifies the existing distribution config for ``S11A16G5KZMEQD`` to disable the distribution. This file was created by taking the existing config from the ``DistributionConfig`` key in the output of ``get-distribution-config`` and changing the ``Enabled`` key's value to ``false``:: + + { + "Comment": "", + "CacheBehaviors": { + "Quantity": 0 + }, + "Logging": { + "Bucket": "", + "Prefix": "", + "Enabled": false, + "IncludeCookies": false + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DefaultRootObject": "", + "PriceClass": "PriceClass_All", + "Enabled": false, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "CallerReference": "my-distribution-2015-09-01", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + } + +After disabling a CloudFront distribution you can delete it with ``delete-distribution``. + +The output includes the updated distribution config. Note that the ``ETag`` value has also changed:: + + { + "Distribution": { + "Status": "InProgress", + "DomainName": "d2wkuj2w9l34gt.cloudfront.net", + "InProgressInvalidationBatches": 0, + "DistributionConfig": { + "Comment": "", + "CacheBehaviors": { + "Quantity": 0 + }, + "Logging": { + "Bucket": "", + "Prefix": "", + "Enabled": false, + "IncludeCookies": false + }, + "Origins": { + "Items": [ + { + "OriginPath": "", + "S3OriginConfig": { + "OriginAccessIdentity": "" + }, + "Id": "my-origin", + "DomainName": "my-bucket.s3.amazonaws.com" + } + ], + "Quantity": 1 + }, + "DefaultRootObject": "", + "PriceClass": "PriceClass_All", + "Enabled": false, + "DefaultCacheBehavior": { + "TrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "TargetOriginId": "my-origin", + "ViewerProtocolPolicy": "allow-all", + "ForwardedValues": { + "Headers": { + "Quantity": 0 + }, + "Cookies": { + "Forward": "none" + }, + "QueryString": true + }, + "MaxTTL": 31536000, + "SmoothStreaming": false, + "DefaultTTL": 86400, + "AllowedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "CachedMethods": { + "Items": [ + "HEAD", + "GET" + ], + "Quantity": 2 + }, + "Quantity": 2 + }, + "MinTTL": 3600 + }, + "CallerReference": "my-distribution-2015-09-01", + "ViewerCertificate": { + "CloudFrontDefaultCertificate": true, + "MinimumProtocolVersion": "SSLv3" + }, + "CustomErrorResponses": { + "Quantity": 0 + }, + "Restrictions": { + "GeoRestriction": { + "RestrictionType": "none", + "Quantity": 0 + } + }, + "Aliases": { + "Quantity": 0 + } + }, + "ActiveTrustedSigners": { + "Enabled": false, + "Quantity": 0 + }, + "LastModifiedTime": "2015-09-01T17:54:11.453Z", + "Id": "S11A16G5KZMEQD" + }, + "ETag": "8UBQECEJX24ST" + } diff --git a/aws/dist/awscli/examples/cloudsearchdomain/upload-documents.rst b/aws/dist/awscli/examples/cloudsearchdomain/upload-documents.rst new file mode 100644 index 00000000..52ae672f --- /dev/null +++ b/aws/dist/awscli/examples/cloudsearchdomain/upload-documents.rst @@ -0,0 +1,11 @@ +The following ``upload-documents`` command uploads a batch of JSON documents to an Amazon CloudSearch domain:: + + aws cloudsearchdomain upload-documents --endpoint-url https://doc-my-domain.us-west-1.cloudsearch.amazonaws.com --content-type application/json --documents document-batch.json + +Output:: + + { + "status": "success", + "adds": 5000, + "deletes": 0 + } diff --git a/aws/dist/awscli/examples/cloudtrail/add-tags.rst b/aws/dist/awscli/examples/cloudtrail/add-tags.rst new file mode 100644 index 00000000..b7cfba76 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/add-tags.rst @@ -0,0 +1,5 @@ +**To add tags to trail** + +The following ``add-tags`` command adds tags for ``Trail1``:: + + aws cloudtrail add-tags --resource-id arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --tags-list Key=name,Value=Alice Key=location,Value=us diff --git a/aws/dist/awscli/examples/cloudtrail/create-subscription.rst b/aws/dist/awscli/examples/cloudtrail/create-subscription.rst new file mode 100644 index 00000000..b3f2fc0e --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/create-subscription.rst @@ -0,0 +1,32 @@ +**To create and configure AWS resources for a trail** + +The following ``create-subscription`` command creates a new S3 bucket and SNS topic for ``Trail1``:: + + aws cloudtrail create-subscription --name Trail1 --s3-new-bucket my-bucket --sns-new-topic my-topic + +Output:: + + Setting up new S3 bucket my-bucket... + Setting up new SNS topic my-topic... + Creating/updating CloudTrail configuration... + CloudTrail configuration: + { + "trailList": [ + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail1", + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": false, + "S3BucketName": "my-bucket", + "SnsTopicName": "my-topic", + "HomeRegion": "us-east-1" + } + ], + "ResponseMetadata": { + "HTTPStatusCode": 200, + "RequestId": "f39e51f6-c615-11e5-85bd-d35ca21ee3e2" + } + } + Starting CloudTrail service... + Logs will be delivered to my-bucket \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/create-trail.rst b/aws/dist/awscli/examples/cloudtrail/create-trail.rst new file mode 100644 index 00000000..95d33cbe --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/create-trail.rst @@ -0,0 +1,17 @@ +**To create a trail** + +The following ``create-trail`` command creates a multi-region trail named ``Trail1`` and specifies an S3 bucket:: + + aws cloudtrail create-trail --name Trail1 --s3-bucket-name my-bucket --is-multi-region-trail + +Output:: + + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail1", + "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": true, + "S3BucketName": "my-bucket" + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/delete-trail.rst b/aws/dist/awscli/examples/cloudtrail/delete-trail.rst new file mode 100644 index 00000000..523947ee --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/delete-trail.rst @@ -0,0 +1,6 @@ +**To delete a trail** + +The following ``delete-trail`` command deletes a trail named ``Trail1``:: + + aws cloudtrail delete-trail --name Trail1 + \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/describe-trails.rst b/aws/dist/awscli/examples/cloudtrail/describe-trails.rst new file mode 100644 index 00000000..f09a67b5 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/describe-trails.rst @@ -0,0 +1,35 @@ +**To describe a trail** + +The following ``describe-trails`` command returns the settings for ``Trail1`` and ``Trail2``:: + + aws cloudtrail describe-trails --trail-name-list Trail1 Trail2 + +Output:: + + { + "trailList": [ + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail1", + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": false, + "S3BucketName": "my-bucket", + "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/CloudTrail_CloudWatchLogs_Role", + "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:123456789012:log-group:CloudTrail:*", + "SnsTopicName": "my-topic", + "HomeRegion": "us-east-1" + }, + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail2", + "S3KeyPrefix": "my-prefix", + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": false, + "S3BucketName": "my-bucket", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c5ae5ac-3c13-421e-8335-c7868ef6a769", + "HomeRegion": "us-east-1" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/get-event-selectors.rst b/aws/dist/awscli/examples/cloudtrail/get-event-selectors.rst new file mode 100755 index 00000000..620b41a1 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/get-event-selectors.rst @@ -0,0 +1,18 @@ +**To view the event selector settings for a trail** + +The following ``get-event-selectors`` command returns the settings for ``Trail1``:: + + aws cloudtrail get-event-selectors --trail-name Trail1 + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1" + } diff --git a/aws/dist/awscli/examples/cloudtrail/get-trail-status.rst b/aws/dist/awscli/examples/cloudtrail/get-trail-status.rst new file mode 100644 index 00000000..a60cb5c0 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/get-trail-status.rst @@ -0,0 +1,22 @@ +**To get the status of a trail** + +The following ``get-trail-status`` command returns the delivery and logging details for ``Trail1``:: + + aws cloudtrail get-trail-status --name Trail1 + +Output:: + + { + "LatestNotificationTime": 1454022144.869, + "LatestNotificationAttemptSucceeded": "2016-01-28T23:02:24Z", + "LatestDeliveryAttemptTime": "2016-01-28T23:02:24Z", + "LatestDeliveryTime": 1454022144.869, + "TimeLoggingStarted": "2015-11-06T18:36:38Z", + "LatestDeliveryAttemptSucceeded": "2016-01-28T23:02:24Z", + "IsLogging": true, + "LatestCloudWatchLogsDeliveryTime": 1454022144.918, + "StartLoggingTime": 1446834998.695, + "StopLoggingTime": 1446834996.933, + "LatestNotificationAttemptTime": "2016-01-28T23:02:24Z", + "TimeLoggingStopped": "2015-11-06T18:36:36Z" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/list-public-keys.rst b/aws/dist/awscli/examples/cloudtrail/list-public-keys.rst new file mode 100644 index 00000000..119664dc --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/list-public-keys.rst @@ -0,0 +1,18 @@ +**To list all public keys for a trail** + +The following ``list-public-keys`` command returns all public keys whose private keys were used to sign the digest files within the specified time range:: + + aws cloudtrail list-public-keys --start-time 2016-01-01T20:30:00.000Z + +Output:: + + { + "PublicKeyList": [ + { + "ValidityStartTime": 1453076702.0, + "ValidityEndTime": 1455668702.0, + "Value": "MIIBCgKCAQEAlSS3cl92HDycr/MTj0moOhas8habjrraXw+KzlWF0axSI2tcF+3iJ9BKQAVSKxGwxwu3m0wG3J+kUl1xboEcEPHYoIYMbgfSw7KGnuDKwkLzsQWhUJ0cIbOHASox1vv/5fNXkrHhGbDCHeVXm804c83nvHUEFYThr1PfyP/8HwrCtR3FX5OANtQCP61C1nJtSSkC8JSQUOrIP4CuwJjc+4WGDk+BGH5m9iuiAKkipEHWmUl8/P7XpfpWQuk4h8g3pXZOrNXr08lbh4d39svj7UqdhvOXoBISp9t/EXYuePGEtBdrKD9Dz+VHwyUPtBQvYr9BnkF88qBnaPNhS44rzwIDAQAB", + "Fingerprint": "7f3f401420072e50a65a141430817ab3" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/list-tags.rst b/aws/dist/awscli/examples/cloudtrail/list-tags.rst new file mode 100644 index 00000000..13f1c6c6 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/list-tags.rst @@ -0,0 +1,34 @@ +**To list the tags for a trail** + +The following ``list-tags`` command lists the tags for ``Trail1`` and ``Trail2``:: + + aws cloudtrail list-tags --resource-id-list arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2 + +Output:: + + { + "ResourceTagList": [ + { + "ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", + "TagsList": [ + { + "Value": "Alice", + "Key": "name" + }, + { + "Value": "us", + "Key": "location" + } + ] + }, + { + "ResourceId": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail2", + "TagsList": [ + { + "Value": "Bob", + "Key": "name" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/lookup-events.rst b/aws/dist/awscli/examples/cloudtrail/lookup-events.rst new file mode 100644 index 00000000..73a81a5d --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/lookup-events.rst @@ -0,0 +1,20 @@ +**To look up events for a trail** + +The following ``lookup-events`` command looks up API activity events by the attribute ``EventName``:: + + aws cloudtrail lookup-events --lookup-attributes AttributeKey=EventName,AttributeValue=ConsoleLogin + +Output:: + + { + "Events": [ + { + "EventId": "654ccbc0-ba0d-486a-9076-dbf7274677a7", + "Username": "my-session-name", + "EventTime": 1453844532.0, + "CloudTrailEvent": "{\"eventVersion\":\"1.02\",\"userIdentity\":{\"type\":\"AssumedRole\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4:my-session-name\",\"arn\":\"arn:aws:sts::123456789012:assumed-role/my-role/my-session-name\",\"accountId\":\"123456789012\",\"sessionContext\":{\"attributes\":{\"mfaAuthenticated\":\"false\",\"creationDate\":\"2016-01-26T21:42:12Z\"},\"sessionIssuer\":{\"type\":\"Role\",\"principalId\":\"AROAJIKPFTA72SWU4L7T4\",\"arn\":\"arn:aws:iam::123456789012:role/my-role\",\"accountId\":\"123456789012\",\"userName\":\"my-role\"}}},\"eventTime\":\"2016-01-26T21:42:12Z\",\"eventSource\":\"signin.amazonaws.com\",\"eventName\":\"ConsoleLogin\",\"awsRegion\":\"us-east-1\",\"sourceIPAddress\":\"72.21.198.70\",\"userAgent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/47.0.2526.111 Safari/537.36\",\"requestParameters\":null,\"responseElements\":{\"ConsoleLogin\":\"Success\"},\"additionalEventData\":{\"MobileVersion\":\"No\",\"MFAUsed\":\"No\"},\"eventID\":\"654ccbc0-ba0d-486a-9076-dbf7274677a7\",\"eventType\":\"AwsConsoleSignIn\",\"recipientAccountId\":\"123456789012\"}", + "EventName": "ConsoleLogin", + "Resources": [] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/put-event-selectors.rst b/aws/dist/awscli/examples/cloudtrail/put-event-selectors.rst new file mode 100755 index 00000000..6b359862 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/put-event-selectors.rst @@ -0,0 +1,70 @@ +**To configure event selectors for a trail** + +To create an event selector, run the ''put-event-selectors'' command. When an event occurs in your account, CloudTrail evaluates +the configuration for your trails. If the event matches any event selector for a trail, the trail processes and logs the event. +You can configure up to 5 event selectors for a trail and up to 250 data resources for a trail. + +The following example creates an event selector for a trail named ''TrailName'' to include read-only and write-only management events, +data events for two Amazon S3 bucket/prefix combinations, and data events for a single AWS Lambda function named ''hello-world-python-function'':: + + + + aws cloudtrail put-event-selectors --trail-name TrailName --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::mybucket/prefix","arn:aws:s3:::mybucket2/prefix2"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda:us-west-2:999999999999:function:hello-world-python-function"]}]}]' + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [ + { + "Values": [ + "arn:aws:s3:::mybucket/prefix", + "arn:aws:s3:::mybucket2/prefix2" + ], + "Type": "AWS::S3::Object" + }, + { + "Values": [ + "arn:aws:lambda:us-west-2:123456789012:function:hello-world-python-function" + ], + "Type": "AWS::Lambda::Function" + }, + ], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName" + } + +The following example creates an event selector for a trail named ''TrailName2'' that includes all events, including read-only and write-only management events, and all data events for all Amazon S3 buckets and AWS Lambda functions in the AWS account:: + + aws cloudtrail put-event-selectors --trail-name TrailName2 --event-selectors '[{"ReadWriteType": "All","IncludeManagementEvents": true,"DataResources": [{"Type":"AWS::S3::Object", "Values": ["arn:aws:s3:::"]},{"Type": "AWS::Lambda::Function","Values": ["arn:aws:lambda"]}]}]' + +Output:: + + { + "EventSelectors": [ + { + "IncludeManagementEvents": true, + "DataResources": [ + { + "Values": [ + "arn:aws:s3:::" + ], + "Type": "AWS::S3::Object" + }, + { + "Values": [ + "arn:aws:lambda" + ], + "Type": "AWS::Lambda::Function" + }, + ], + "ReadWriteType": "All" + } + ], + "TrailARN": "arn:aws:cloudtrail:us-east-2:123456789012:trail/TrailName2" + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/remove-tags.rst b/aws/dist/awscli/examples/cloudtrail/remove-tags.rst new file mode 100644 index 00000000..b6c36c36 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/remove-tags.rst @@ -0,0 +1,5 @@ +**To remove tags for a trail** + +The following ``remove-tags`` command removes the specified tags for ``Trail1``:: + + aws cloudtrail remove-tags --resource-id arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --tags-list Key=name Key=location diff --git a/aws/dist/awscli/examples/cloudtrail/start-logging.rst b/aws/dist/awscli/examples/cloudtrail/start-logging.rst new file mode 100644 index 00000000..ff692d92 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/start-logging.rst @@ -0,0 +1,5 @@ +**To start logging for a trail** + +The following ``start-logging`` command turns on logging for ``Trail1``:: + + aws cloudtrail start-logging --name Trail1 diff --git a/aws/dist/awscli/examples/cloudtrail/stop-logging.rst b/aws/dist/awscli/examples/cloudtrail/stop-logging.rst new file mode 100644 index 00000000..e82108a7 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/stop-logging.rst @@ -0,0 +1,5 @@ +**To stop logging a trail** + +The following ``stop-logging`` command turns off logging for ``Trail1``:: + + aws cloudtrail stop-logging --name Trail1 diff --git a/aws/dist/awscli/examples/cloudtrail/update-subscription.rst b/aws/dist/awscli/examples/cloudtrail/update-subscription.rst new file mode 100644 index 00000000..fb0316a5 --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/update-subscription.rst @@ -0,0 +1,30 @@ +**To update the configuration settings for a trail** + +The following ``update-subscription`` command updates the trail to specify a new S3 bucket and SNS topic:: + + aws cloudtrail update-subscription --name Trail1 --s3-new-bucket my-bucket-new --sns-new-topic my-topic-new + +Output:: + + Setting up new S3 bucket my-bucket-new... + Setting up new SNS topic my-topic-new... + Creating/updating CloudTrail configuration... + CloudTrail configuration: + { + "trailList": [ + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail1", + "TrailARN": "arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": false, + "S3BucketName": "my-bucket-new", + "SnsTopicName": "my-topic-new", + "HomeRegion": "us-east-1" + } + ], + "ResponseMetadata": { + "HTTPStatusCode": 200, + "RequestId": "31126f8a-c616-11e5-9cc6-2fd637936879" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/update-trail.rst b/aws/dist/awscli/examples/cloudtrail/update-trail.rst new file mode 100644 index 00000000..37539b0b --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/update-trail.rst @@ -0,0 +1,16 @@ +**To update a trail** + +The following ``update-trail`` command updates a trail to use an existing bucket for log delivery:: + + aws cloudtrail update-trail --name Trail1 --s3-bucket-name my-bucket + +Output:: + + { + "IncludeGlobalServiceEvents": true, + "Name": "Trail1", + "TrailARN": "arn:aws:cloudtrail:us-west-2:123456789012:trail/Trail1", + "LogFileValidationEnabled": false, + "IsMultiRegionTrail": true, + "S3BucketName": "my-bucket" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudtrail/validate-logs.rst b/aws/dist/awscli/examples/cloudtrail/validate-logs.rst new file mode 100644 index 00000000..4a3a3efa --- /dev/null +++ b/aws/dist/awscli/examples/cloudtrail/validate-logs.rst @@ -0,0 +1,13 @@ +**To validate a log file** + +The following ``validate-logs`` command validates the logs for ``Trail1``:: + + aws cloudtrail validate-logs --trail-arn arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 --start-time 20160129T19:00:00Z + +Output:: + + Validating log files for trail arn:aws:cloudtrail:us-east-1:123456789012:trail/Trail1 between 2016-01-29T19:00:00Z and 2016-01-29T22:15:43Z + Results requested for 2016-01-29T19:00:00Z to 2016-01-29T22:15:43Z + Results found for 2016-01-29T19:24:57Z to 2016-01-29T21:24:57Z: + 3/3 digest files valid + 15/15 log files valid \ No newline at end of file diff --git a/aws/dist/awscli/examples/cloudwatch/delete-alarms.rst b/aws/dist/awscli/examples/cloudwatch/delete-alarms.rst new file mode 100644 index 00000000..5ba5f2eb --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/delete-alarms.rst @@ -0,0 +1,10 @@ +**To delete an alarm** + +The following example uses the ``delete-alarms`` command to delete the Amazon CloudWatch alarm +named "myalarm":: + + aws cloudwatch delete-alarms --alarm-names myalarm + +Output:: + + This command returns to the prompt if successful. diff --git a/aws/dist/awscli/examples/cloudwatch/describe-alarm-history.rst b/aws/dist/awscli/examples/cloudwatch/describe-alarm-history.rst new file mode 100644 index 00000000..f46462c1 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/describe-alarm-history.rst @@ -0,0 +1,28 @@ +**To retrieve history for an alarm** + +The following example uses the ``describe-alarm-history`` command to retrieve history for the Amazon +CloudWatch alarm named "myalarm":: + + aws cloudwatch describe-alarm-history --alarm-name "myalarm" --history-item-type StateUpdate + +Output:: + + { + "AlarmHistoryItems": [ + { + "Timestamp": "2014-04-09T18:59:06.442Z", + "HistoryItemType": "StateUpdate", + "AlarmName": "myalarm", + "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"},\"newState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}}}", + "HistorySummary": "Alarm updated from ALARM to OK" + }, + { + "Timestamp": "2014-04-09T18:59:05.805Z", + "HistoryItemType": "StateUpdate", + "AlarmName": "myalarm", + "HistoryData": "{\"version\":\"1.0\",\"oldState\":{\"stateValue\":\"OK\",\"stateReason\":\"Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.839999999999996, 39.714].\",\"stateReasonData\":{\"version\":\"1.0\",\"queryDate\":\"2014-03-11T22:45:41.569+0000\",\"startDate\":\"2014-03-11T22:30:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.839999999999996,39.714],\"threshold\":70.0}},\"newState\":{\"stateValue\":\"ALARM\",\"stateReason\":\"testing purposes\"}}", + "HistorySummary": "Alarm updated from OK to ALARM" + } + ] + } + diff --git a/aws/dist/awscli/examples/cloudwatch/describe-alarms-for-metric.rst b/aws/dist/awscli/examples/cloudwatch/describe-alarms-for-metric.rst new file mode 100644 index 00000000..4842e2d1 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/describe-alarms-for-metric.rst @@ -0,0 +1,72 @@ +**To display information about alarms associated with a metric** + +The following example uses the ``describe-alarms-for-metric`` command to display information about +any alarms associated with the Amazon EC2 CPUUtilization metric and the instance with the ID i-0c986c72.:: + + aws cloudwatch describe-alarms-for-metric --metric-name CPUUtilization --namespace AWS/EC2 --dimensions Name=InstanceId,Value=i-0c986c72 + +Output:: + + { + "MetricAlarms": [ + { + "EvaluationPeriods": 10, + "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm2", + "StateUpdatedTimestamp": "2013-10-30T03:03:51.479Z", + "AlarmConfigurationUpdatedTimestamp": "2013-10-30T03:03:50.865Z", + "ComparisonOperator": "GreaterThanOrEqualToThreshold", + "AlarmActions": [ + "arn:aws:sns:us-east-1:111122223333:NotifyMe" + ], + "Namespace": "AWS/EC2", + "AlarmDescription": "CPU usage exceeds 70 percent", + "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2013-10-30T03:03:51.479+0000\",\"startDate\":\"2013-10-30T02:08:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[40.698,39.612,42.432,39.796,38.816,42.28,42.854,40.088,40.760000000000005,41.316],\"threshold\":70.0}", + "Period": 300, + "StateValue": "OK", + "Threshold": 70.0, + "AlarmName": "myHighCpuAlarm2", + "Dimensions": [ + { + "Name": "InstanceId", + "Value": "i-0c986c72" + } + ], + "Statistic": "Average", + "StateReason": "Threshold Crossed: 10 datapoints were not greater than or equal to the threshold (70.0). The most recent datapoints: [40.760000000000005, 41.316].", + "InsufficientDataActions": [], + "OKActions": [], + "ActionsEnabled": true, + "MetricName": "CPUUtilization" + }, + { + "EvaluationPeriods": 2, + "AlarmArn": "arn:aws:cloudwatch:us-east-1:111122223333:alarm:myHighCpuAlarm", + "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", + "AlarmConfigurationUpdatedTimestamp": "2014-04-09T22:26:05.958Z", + "ComparisonOperator": "GreaterThanThreshold", + "AlarmActions": [ + "arn:aws:sns:us-east-1:111122223333:HighCPUAlarm" + ], + "Namespace": "AWS/EC2", + "AlarmDescription": "CPU usage exceeds 70 percent", + "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", + "Period": 300, + "StateValue": "OK", + "Threshold": 70.0, + "AlarmName": "myHighCpuAlarm", + "Dimensions": [ + { + "Name": "InstanceId", + "Value": "i-0c986c72" + } + ], + "Statistic": "Average", + "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", + "InsufficientDataActions": [], + "OKActions": [], + "ActionsEnabled": false, + "MetricName": "CPUUtilization" + } + ] + } + diff --git a/aws/dist/awscli/examples/cloudwatch/describe-alarms.rst b/aws/dist/awscli/examples/cloudwatch/describe-alarms.rst new file mode 100644 index 00000000..4e13e712 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/describe-alarms.rst @@ -0,0 +1,41 @@ +**To list information about an alarm** + +The following example uses the ``describe-alarms`` command to provide information about the alarm named "myalarm":: + + aws cloudwatch describe-alarms --alarm-names "myalarm" + +Output:: + + { + "MetricAlarms": [ + { + "EvaluationPeriods": 2, + "AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm", + "StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z", + "AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z", + "ComparisonOperator": "GreaterThanThreshold", + "AlarmActions": [ + "arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm" + ], + "Namespace": "AWS/EC2", + "AlarmDescription": "CPU usage exceeds 70 percent", + "StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}", + "Period": 300, + "StateValue": "OK", + "Threshold": 70.0, + "AlarmName": "myalarm", + "Dimensions": [ + { + "Name": "InstanceId", + "Value": "i-0c986c72" + } + ], + "Statistic": "Average", + "StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].", + "InsufficientDataActions": [], + "OKActions": [], + "ActionsEnabled": true, + "MetricName": "CPUUtilization" + } + ] + } diff --git a/aws/dist/awscli/examples/cloudwatch/disable-alarm-actions.rst b/aws/dist/awscli/examples/cloudwatch/disable-alarm-actions.rst new file mode 100644 index 00000000..beae6c24 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/disable-alarm-actions.rst @@ -0,0 +1,8 @@ +**To disable actions for an alarm** + +The following example uses the ``disable-alarm-actions`` command to disable all actions for the alarm named myalarm.:: + + aws cloudwatch disable-alarm-actions --alarm-names myalarm + +This command returns to the prompt if successful. + diff --git a/aws/dist/awscli/examples/cloudwatch/enable-alarm-actions.rst b/aws/dist/awscli/examples/cloudwatch/enable-alarm-actions.rst new file mode 100644 index 00000000..9e2e6f89 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/enable-alarm-actions.rst @@ -0,0 +1,8 @@ +**To enable all actions for an alarm** + +The following example uses the ``enable-alarm-actions`` command to enable all actions for the alarm named myalarm.:: + + aws cloudwatch enable-alarm-actions --alarm-names myalarm + +This command returns to the prompt if successful. + diff --git a/aws/dist/awscli/examples/cloudwatch/get-metric-statistics.rst b/aws/dist/awscli/examples/cloudwatch/get-metric-statistics.rst new file mode 100644 index 00000000..28fb08a4 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/get-metric-statistics.rst @@ -0,0 +1,145 @@ +**To get the CPU utilization per EC2 instance** + +The following example uses the ``get-metric-statistics`` command to get the CPU utilization for an EC2 +instance with the ID i-abcdef. + +.. __: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html + +:: + + aws cloudwatch get-metric-statistics --metric-name CPUUtilization --start-time 2014-04-08T23:18:00Z --end-time 2014-04-09T23:18:00Z --period 3600 --namespace AWS/EC2 --statistics Maximum --dimensions Name=InstanceId,Value=i-abcdef + +Output:: + + { + "Datapoints": [ + { + "Timestamp": "2014-04-09T11:18:00Z", + "Maximum": 44.79, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T20:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T19:18:00Z", + "Maximum": 50.85, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T09:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T03:18:00Z", + "Maximum": 76.84, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T21:18:00Z", + "Maximum": 48.96, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T14:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T08:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T16:18:00Z", + "Maximum": 45.55, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T06:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T13:18:00Z", + "Maximum": 45.08, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T05:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T18:18:00Z", + "Maximum": 46.88, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T17:18:00Z", + "Maximum": 52.08, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T07:18:00Z", + "Maximum": 47.92, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T02:18:00Z", + "Maximum": 51.23, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T12:18:00Z", + "Maximum": 47.67, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-08T23:18:00Z", + "Maximum": 46.88, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T10:18:00Z", + "Maximum": 51.91, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T04:18:00Z", + "Maximum": 47.13, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T15:18:00Z", + "Maximum": 48.96, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T00:18:00Z", + "Maximum": 48.16, + "Unit": "Percent" + }, + { + "Timestamp": "2014-04-09T01:18:00Z", + "Maximum": 49.18, + "Unit": "Percent" + } + ], + "Label": "CPUUtilization" + } + +**Specifying multiple dimensions** + +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name/Value pair, with a comma between the name and the value. Multiple dimensions are separated by a space. If a single metric includes multiple dimensions, you must specify a value for every defined dimension. + +For more examples using the ``get-metric-statistics`` command, see `Get Statistics for a Metric`__ in the *Amazon CloudWatch Developer Guide*. + +.. __: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/US_GetStatistics.html + +:: + + aws cloudwatch get-metric-statistics --metric-name Buffers --namespace MyNameSpace --dimensions Name=InstanceID,Value=i-abcdef Name=InstanceType,Value=m1.small --start-time 2016-10-15T04:00:00Z --end-time 2016-10-19T07:00:00Z --statistics Average --period 60 diff --git a/aws/dist/awscli/examples/cloudwatch/list-metrics.rst b/aws/dist/awscli/examples/cloudwatch/list-metrics.rst new file mode 100644 index 00000000..7755756b --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/list-metrics.rst @@ -0,0 +1,93 @@ +**To list the metrics for Amazon EC2** + +The following example uses the ``list-metrics`` command to list the metrics for Amazon SNS.:: + + aws cloudwatch list-metrics --namespace "AWS/SNS" + +Output:: + + { + "Metrics": [ + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "PublishSize" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "PublishSize" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfNotificationsFailed" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfNotificationsDelivered" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "NotifyMe" + } + ], + "MetricName": "NumberOfMessagesPublished" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfMessagesPublished" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfNotificationsDelivered" + }, + { + "Namespace": "AWS/SNS", + "Dimensions": [ + { + "Name": "TopicName", + "Value": "CFO" + } + ], + "MetricName": "NumberOfNotificationsFailed" + } + ] + } + diff --git a/aws/dist/awscli/examples/cloudwatch/put-metric-alarm.rst b/aws/dist/awscli/examples/cloudwatch/put-metric-alarm.rst new file mode 100644 index 00000000..0bb86b17 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/put-metric-alarm.rst @@ -0,0 +1,13 @@ +**To send an Amazon Simple Notification Service email message when CPU utilization exceeds 70 percent** + +The following example uses the ``put-metric-alarm`` command to send an Amazon Simple Notification Service email message when CPU utilization exceeds 70 percent:: + + aws cloudwatch put-metric-alarm --alarm-name cpu-mon --alarm-description "Alarm when CPU exceeds 70 percent" --metric-name CPUUtilization --namespace AWS/EC2 --statistic Average --period 300 --threshold 70 --comparison-operator GreaterThanThreshold --dimensions "Name=InstanceId,Value=i-12345678" --evaluation-periods 2 --alarm-actions arn:aws:sns:us-east-1:111122223333:MyTopic --unit Percent + +This command returns to the prompt if successful. If an alarm with the same name already exists, it will be overwritten by the new alarm. + +**To specify multiple dimensions** + +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name/Value pair, with a comma between the name and the value. Multiple dimensions are separated by a space:: + + aws cloudwatch put-metric-alarm --alarm-name "Default_Test_Alarm3" --alarm-description "The default example alarm" --namespace "CW EXAMPLE METRICS" --metric-name Default_Test --statistic Average --period 60 --evaluation-periods 3 --threshold 50 --comparison-operator GreaterThanOrEqualToThreshold --dimensions Name=key1,Value=value1 Name=key2,Value=value2 diff --git a/aws/dist/awscli/examples/cloudwatch/put-metric-data.rst b/aws/dist/awscli/examples/cloudwatch/put-metric-data.rst new file mode 100644 index 00000000..2d6f58bf --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/put-metric-data.rst @@ -0,0 +1,28 @@ +**To publish a custom metric to Amazon CloudWatch** + +The following example uses the ``put-metric-data`` command to publish a custom metric to Amazon CloudWatch:: + + aws cloudwatch put-metric-data --namespace "Usage Metrics" --metric-data file://metric.json + +The values for the metric itself are stored in the JSON file, ``metric.json``. + +Here are the contents of that file:: + + [ + { + "MetricName": "New Posts", + "Timestamp": "Wednesday, June 12, 2013 8:28:20 PM", + "Value": 0.50, + "Unit": "Count" + } + ] + +For more information, see `Publishing Custom Metrics`_ in the *Amazon CloudWatch Developer Guide*. + +.. _`Publishing Custom Metrics`: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/publishingMetrics.html + +**To specify multiple dimensions** + +The following example illustrates how to specify multiple dimensions. Each dimension is specified as a Name=Value pair. Multiple dimensions are separated by a comma.:: + + aws cloudwatch put-metric-data --metric-name Buffers --namespace MyNameSpace --unit Bytes --value 231434333 --dimensions InstanceID=1-23456789,InstanceType=m1.small diff --git a/aws/dist/awscli/examples/cloudwatch/set-alarm-state.rst b/aws/dist/awscli/examples/cloudwatch/set-alarm-state.rst new file mode 100644 index 00000000..aeca35c5 --- /dev/null +++ b/aws/dist/awscli/examples/cloudwatch/set-alarm-state.rst @@ -0,0 +1,8 @@ +**To temporarily change the state of an alarm** + +The following example uses the ``set-alarm-state`` command to temporarily change the state of an +Amazon CloudWatch alarm named "myalarm" and set it to the ALARM state for testing purposes:: + + aws cloudwatch set-alarm-state --alarm-name "myalarm" --state-value ALARM --state-reason "testing purposes" + +This command returns to the prompt if successful. diff --git a/aws/dist/awscli/examples/codebuild/batch-delete-builds.rst b/aws/dist/awscli/examples/codebuild/batch-delete-builds.rst new file mode 100644 index 00000000..6b94a52b --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/batch-delete-builds.rst @@ -0,0 +1,22 @@ +**To delete builds in AWS CodeBuild.** + +The following ``batch-delete-builds`` example deletes builds in CodeBuild with the specified IDs. :: + + aws codebuild batch-delete-builds --ids my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE + +Output:: + + { + "buildsNotDeleted": [ + { + "id": "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-one:a1b2c3d4-5678-9012-abcd-11111EXAMPLE", + "statusCode": "BUILD_IN_PROGRESS" + } + ], + "buildsDeleted": [ + "arn:aws:codebuild:us-west-2:123456789012:build/my-build-project-two:a1b2c3d4-5678-9012-abcd-22222EXAMPLE" + ] + } + +For more information, see `Delete Builds (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff --git a/aws/dist/awscli/examples/codebuild/batch-get-builds.rst b/aws/dist/awscli/examples/codebuild/batch-get-builds.rst new file mode 100644 index 00000000..80e00f20 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/batch-get-builds.rst @@ -0,0 +1,369 @@ +**To view details of builds in AWS CodeBuild.** + +The following ``batch-get-builds`` example gets information about builds in CodeBuild with the specified IDs. :: + + aws codebuild batch-get-builds --ids codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE + +Output:: + + { + "buildsNotFound": [], + "builds": [ + { + "artifacts": { + "md5sum": "0e95edf915048a0c22efe6d139fff837", + "location": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/BuildArtif/6DJsqQa", + "encryptionDisabled": false, + "sha256sum": "cfa0df33a090966a737f64ae4fe498969fdc842a0c9aec540bf93c37ac0d05a2" + }, + "logs": { + "cloudWatchLogs": { + "status": "ENABLED" + }, + "s3Logs": { + "status": "DISABLED" + }, + "streamName": "46472baf-8f6b-43c2-9255-b3b963af2732", + "groupName": "/aws/codebuild/codebuild-demo-project", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=46472baf-8f6b-43c2-9255-b3b963af2732" + }, + "timeoutInMinutes": 60, + "environment": { + "privilegedMode": false, + "computeType": "BUILD_GENERAL1_MEDIUM", + "image": "aws/codebuild/windows-base:1.0", + "environmentVariables": [], + "type": "WINDOWS_CONTAINER" + }, + "projectName": "codebuild-demo-project", + "buildComplete": true, + "source": { + "gitCloneDepth": 1, + "insecureSsl": false, + "type": "CODEPIPELINE" + }, + "buildStatus": "SUCCEEDED", + "secondaryArtifacts": [], + "phases": [ + { + "durationInSeconds": 0, + "startTime": 1548717462.122, + "phaseType": "SUBMITTED", + "endTime": 1548717462.484, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "startTime": 1548717462.484, + "phaseType": "QUEUED", + "endTime": 1548717462.775, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 34, + "endTime": 1548717496.909, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717462.775, + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 15, + "endTime": 1548717512.555, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717496.909, + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548717512.734, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.555, + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548717512.924, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.734, + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548717522.254, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717512.924, + "phaseType": "BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 3, + "endTime": 1548717525.498, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717522.254, + "phaseType": "POST_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548717534.646, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717525.498, + "phaseType": "UPLOAD_ARTIFACTS", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 2, + "endTime": 1548717536.846, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548717534.646, + "phaseType": "FINALIZING", + "phaseStatus": "SUCCEEDED" + }, + { + "startTime": 1548717536.846, + "phaseType": "COMPLETED" + } + ], + "startTime": 1548717462.122, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "initiator": "codepipeline/CodeBuild-Pipeline", + "secondarySources": [], + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "currentPhase": "COMPLETED", + "id": "codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", + "cache": { + "type": "NO_CACHE" + }, + "sourceVersion": "arn:aws:s3:::codepipeline-us-west-2-820783811474/CodeBuild-Python-Pip/SourceArti/1TspnN3.zip", + "endTime": 1548717536.846, + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:e9c4f4df-3f43-41d2-ab3a-60fe2EXAMPLE", + "queuedTimeoutInMinutes": 480, + "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" + }, + { + "artifacts": { + "md5sum": "", + "overrideArtifactName": false, + "location": "arn:aws:s3:::my-artifacts/codebuild-demo-project", + "encryptionDisabled": false, + "sha256sum": "" + }, + "logs": { + "cloudWatchLogs": { + "status": "ENABLED" + }, + "s3Logs": { + "status": "DISABLED" + }, + "streamName": "4dea3ca4-20ec-4898-b22a-a9eb9292775d", + "groupName": "/aws/codebuild/codebuild-demo-project", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/codebuild-demo-project;stream=4dea3ca4-20ec-4898-b22a-a9eb9292775d" + }, + "timeoutInMinutes": 60, + "environment": { + "privilegedMode": false, + "computeType": "BUILD_GENERAL1_MEDIUM", + "image": "aws/codebuild/windows-base:1.0", + "environmentVariables": [], + "type": "WINDOWS_CONTAINER" + }, + "projectName": "codebuild-demo-project", + "buildComplete": true, + "source": { + "gitCloneDepth": 1, + "location": "https://github.com/my-repo/codebuild-demo-project.git", + "insecureSsl": false, + "reportBuildStatus": false, + "type": "GITHUB" + }, + "buildStatus": "SUCCEEDED", + "secondaryArtifacts": [], + "phases": [ + { + "durationInSeconds": 0, + "startTime": 1548716241.89, + "phaseType": "SUBMITTED", + "endTime": 1548716242.241, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "startTime": 1548716242.241, + "phaseType": "QUEUED", + "endTime": 1548716242.536, + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 33, + "endTime": 1548716276.171, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716242.536, + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 15, + "endTime": 1548716291.809, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716276.171, + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548716291.993, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716291.809, + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 0, + "endTime": 1548716292.191, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716291.993, + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 9, + "endTime": 1548716301.622, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716292.191, + "phaseType": "BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 3, + "endTime": 1548716304.783, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716301.622, + "phaseType": "POST_BUILD", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 8, + "endTime": 1548716313.775, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716304.783, + "phaseType": "UPLOAD_ARTIFACTS", + "phaseStatus": "SUCCEEDED" + }, + { + "durationInSeconds": 2, + "endTime": 1548716315.935, + "contexts": [ + { + "statusCode": "", + "message": "" + } + ], + "startTime": 1548716313.775, + "phaseType": "FINALIZING", + "phaseStatus": "SUCCEEDED" + }, + { + "startTime": 1548716315.935, + "phaseType": "COMPLETED" + } + ], + "startTime": 1548716241.89, + "secondarySourceVersions": [], + "initiator": "my-codebuild-project", + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "currentPhase": "COMPLETED", + "id": "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE", + "cache": { + "type": "NO_CACHE" + }, + "endTime": 1548716315.935, + "secondarySources": [], + "queuedTimeoutInMinutes": 480, + "resolvedSourceVersion": "f2194c1757bbdcb0f8f229254a4b3c8b27d43e0b" + } + ] + } + +For more information, see `View Build Details (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff --git a/aws/dist/awscli/examples/codebuild/batch-get-projects.rst b/aws/dist/awscli/examples/codebuild/batch-get-projects.rst new file mode 100644 index 00000000..b54ff61c --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/batch-get-projects.rst @@ -0,0 +1,89 @@ +**To get a list of AWS CodeBuild build project names.** + +The following ``batch-get-projects`` example gets a list of CodeBuild build projects specified by name. :: + + aws codebuild batch-get-projects --names codebuild-demo-project codebuild-demo-project2 my-other-demo-project + +In the following output, the ``projectsNotFound`` array lists any build project names that were specified, but not found. The ``projects`` array lists details for each build project where information was found. :: + + { + "projectsNotFound": [], + "projects": [ + { + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "name": "codebuild-demo-project2", + "queuedTimeoutInMinutes": 480, + "timeoutInMinutes": 60, + "source": { + "buildspec": "version: 0.2\n\n#env:\n #variables:\n # key: \"value\"\n # key: \"value\"\n #parameter-store:\n # key: \"value\"\n # key:\"value\"\n\nphases:\n #install:\n #commands:\n # - command\n # - command\n #pre_build:\n #commands:\n # - command\n # - command\n build:\n commands:\n # - command\n # - command\n #post_build:\n #commands:\n # - command\n # - command\n#artifacts:\n #files:\n # - location\n # - location\n #name: $(date +%Y-%m-%d)\n #discard-paths: yes\n #base-directory: location\n#cache:\n #paths:\n # - paths", + "type": "NO_SOURCE", + "insecureSsl": false, + "gitCloneDepth": 1 + }, + "artifacts": { + "type": "NO_ARTIFACTS" + }, + "badge": { + "badgeEnabled": false + }, + "lastModified": 1540588091.108, + "created": 1540588091.108, + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/test-for-sample", + "secondarySources": [], + "secondaryArtifacts": [], + "cache": { + "type": "NO_CACHE" + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-test-role", + "environment": { + "image": "aws/codebuild/java:openjdk-8", + "privilegedMode": true, + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [] + }, + "tags": [] + }, + { + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "name": "my-other-demo-project", + "queuedTimeoutInMinutes": 480, + "timeoutInMinutes": 60, + "source": { + "location": "https://github.com/iversonic/codedeploy-sample.git", + "reportBuildStatus": false, + "buildspec": "buildspec.yml", + "insecureSsl": false, + "gitCloneDepth": 1, + "type": "GITHUB", + "auth": { + "type": "OAUTH" + } + }, + "artifacts": { + "type": "NO_ARTIFACTS" + }, + "badge": { + "badgeEnabled": false + }, + "lastModified": 1523401711.73, + "created": 1523401711.73, + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/Project2", + "cache": { + "type": "NO_CACHE" + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/codebuild-Project2-service-role", + "environment": { + "image": "aws/codebuild/nodejs:4.4.7", + "privilegedMode": false, + "type": "LINUX_CONTAINER", + "computeType": "BUILD_GENERAL1_SMALL", + "environmentVariables": [] + }, + "tags": [] + } + ] + } + +For more information, see `View a Build Project's Details (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff --git a/aws/dist/awscli/examples/codebuild/create-project.rst b/aws/dist/awscli/examples/codebuild/create-project.rst new file mode 100755 index 00000000..e500233b --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/create-project.rst @@ -0,0 +1,112 @@ +**Example 1: To create an AWS CodeBuild build project** + +The following ``create-project`` example creates a CodeBuild build project using source files from an S3 bucket :: + + aws codebuild create-project \ + --name "my-demo-project" \ + --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source.zip\"}" \ + --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket\""} \ + --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_SMALL\"}" \ + --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" + +Output:: + + { + "project": { + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", + "name": "my-cli-demo-project", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "lastModified": 1556839783.274, + "badge": { + "badgeEnabled": false + }, + "queuedTimeoutInMinutes": 480, + "environment": { + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_SMALL", + "type": "LINUX_CONTAINER", + "imagePullCredentialsType": "CODEBUILD", + "privilegedMode": false, + "environmentVariables": [] + }, + "artifacts": { + "location": "codebuild-us-west-2-123456789012-output-bucket", + "name": "my-cli-demo-project", + "namespaceType": "NONE", + "type": "S3", + "packaging": "NONE", + "encryptionDisabled": false + }, + "source": { + "type": "S3", + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", + "insecureSsl": false + }, + "timeoutInMinutes": 60, + "cache": { + "type": "NO_CACHE" + }, + "created": 1556839783.274 + } + } + +**Example 2: To create an AWS CodeBuild build project using a JSON input file for the parameters** + +The following ``create-project`` example creates a CodeBuild build project by passing all of the required parameters in a JSON input file. Create the input file template by running the command with only the ``--generate-cli-skeleton parameter``. :: + + aws codebuild create-project --cli-input-json file://create-project.json + +The input JSON file ``create-project.json`` contains the following content:: + + { + "name": "codebuild-demo-project", + "source": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" + }, + "artifacts": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-output-bucket" + }, + "environment": { + "type": "LINUX_CONTAINER", + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_SMALL" + }, + "serviceRole": "serviceIAMRole" + } + +Output:: + + { + "project": { + "name": "codebuild-demo-project", + "serviceRole": "serviceIAMRole", + "tags": [], + "artifacts": { + "packaging": "NONE", + "type": "S3", + "location": "codebuild-region-ID-account-ID-output-bucket", + "name": "message-util.zip" + }, + "lastModified": 1472661575.244, + "timeoutInMinutes": 60, + "created": 1472661575.244, + "environment": { + "computeType": "BUILD_GENERAL1_SMALL", + "image": "aws/codebuild/standard:1.0", + "type": "LINUX_CONTAINER", + "environmentVariables": [] + }, + "source": { + "type": "S3", + "location": "codebuild-region-ID-account-ID-input-bucket/MessageUtil.zip" + }, + "encryptionKey": "arn:aws:kms:region-ID:account-ID:alias/aws/s3", + "arn": "arn:aws:codebuild:region-ID:account-ID:project/codebuild-demo-project" + } + } + +For more information, see `Create a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff --git a/aws/dist/awscli/examples/codebuild/create-webhook.rst b/aws/dist/awscli/examples/codebuild/create-webhook.rst new file mode 100755 index 00000000..449fcd38 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/create-webhook.rst @@ -0,0 +1,50 @@ +**To create webhook filters for an AWS CodeBuild project** + +The following ``create-webhook`` example creates a webhook for a CodeBuild project named ``my-project`` that has two filter groups. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression ``^refs/heads/master$`` and head references that match ``^refs/heads/myBranch$``. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression ``^refs/heads/myBranch$``. :: + + aws codebuild create-webhook \ + --project-name my-project \ + --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" + +Output:: + + { + "webhook": { + "payloadUrl": "https://codebuild.us-west-2.amazonaws.com/webhooks?t=eyJlbmNyeXB0ZWREYXRhIjoiVVl5MGtoeGRwSzZFRXl2Wnh4bld1Z0tKZ291TVpQNEtFamQ3RDlDYWpRaGIreVFrdm9EQktIVk1NeHJEWEpmUDUrVUNOMUIyRHJRc1VxcHJ6QlNDSnljPSIsIml2UGFyYW1ldGVyU3BlYyI6InN4Tm1SeUt5MUhaUVRWbGciLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&v=1", + "url": "https://api.github.com/repos/iversonic/codedeploy-sample/hooks/105190656", + "lastModifiedSecret": 1556311319.069, + "filterGroups": [ + [ + { + "type": "EVENT", + "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", + "excludeMatchedPattern": false + }, + { + "type": "HEAD_REF", + "pattern": "refs/heads/myBranch$", + "excludeMatchedPattern": true + }, + { + "type": "BASE_REF", + "pattern": "refs/heads/master$", + "excludeMatchedPattern": true + } + ], + [ + { + "type": "EVENT", + "pattern": "PUSH", + "excludeMatchedPattern": false + }, + { + "type": "HEAD_REF", + "pattern": "refs/heads/myBranch$", + "excludeMatchedPattern": true + } + ] + ] + } + } + +For more information, see `Filter GitHub Webhook Events (SDK) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/delete-project.rst b/aws/dist/awscli/examples/codebuild/delete-project.rst new file mode 100755 index 00000000..6260cabe --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/delete-project.rst @@ -0,0 +1,9 @@ +**To delete an AWS CodeBuild build project** + +The following ``delete-project`` example deletes the specified CodeBuild build project. :: + + aws codebuild delete-project --name my-project + +This command produces no output. + +For more information, see `Delete a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/delete-source-credentials.rst b/aws/dist/awscli/examples/codebuild/delete-source-credentials.rst new file mode 100755 index 00000000..3d303364 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/delete-source-credentials.rst @@ -0,0 +1,13 @@ +**To disconnect from a source provider and remove its access tokens.** + +The following ``delete-source-credentials`` example disconnects from a source provider and removes its tokens. The ARN of source credentials used to connect to the source provider determines which source credentials. :: + + aws codebuild delete-source-credentials --arn arn-of-your-credentials + +Output:: + + { + "arn": "arn:aws:codebuild:your-region:your-account-id:token/your-server-type" + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/delete-webhook.rst b/aws/dist/awscli/examples/codebuild/delete-webhook.rst new file mode 100755 index 00000000..b5f0afd2 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/delete-webhook.rst @@ -0,0 +1,9 @@ +**To delete a webhook filter from an AWS CodeBuild project** + +The following ``delete-webhook`` example deletes a webhook from the specified CodeBuild project. :: + + aws codebuild delete-webhook --project-name my-project + +This command produces no output. + +For more information, see `Stop Running Builds Automatically (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/import-source-credentials.rst b/aws/dist/awscli/examples/codebuild/import-source-credentials.rst new file mode 100755 index 00000000..69b0f186 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/import-source-credentials.rst @@ -0,0 +1,13 @@ +**Connect an AWS CodeBuild user to a source provider by importing credentials for the source provider.** + +The following ``import-source-credentials`` example imports a token for a Bitbucket repository that uses BASIC_AUTH for its authentication type. :: + + aws codebuild import-source-credentials --server-type BITBUCKET --auth-type BASIC_AUTH --token my-Bitbucket-password --username my-Bitbucket-username + +Output:: + + { + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket" + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/invalidate-project-cache.rst b/aws/dist/awscli/examples/codebuild/invalidate-project-cache.rst new file mode 100755 index 00000000..26436b1d --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/invalidate-project-cache.rst @@ -0,0 +1,9 @@ +**To reset the cache for an AWS CodeBuild build project.** + +The following ``invalidate-project-cache`` example resets the cache for the specified CodeBuild project. :: + + aws codebuild invalidate-project-cache --project-name my-project + +This command produces no output. + +For more information, see `Build Caching in CodeBuild `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/list-builds-for-project.rst b/aws/dist/awscli/examples/codebuild/list-builds-for-project.rst new file mode 100755 index 00000000..4db3478f --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/list-builds-for-project.rst @@ -0,0 +1,19 @@ +**To view a list of builds for an AWS CodeBuild build project.** + +The following ``list-builds-for-project`` example lists the build IDs in descending order for the specified CodeBuild build project. :: + + aws codebuild list-builds-for-project --project-name codebuild-demo-project --sort-order DESCENDING + +Output:: + + { + "ids": [ + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-11111example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-22222example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-33333example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-44444example", + "codebuild-demo-project:1a2b3c4d-5678-90ab-cdef-55555example" + ] + } + +For more information, see `View a List of Build IDs for a Build Project (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff --git a/aws/dist/awscli/examples/codebuild/list-builds.rst b/aws/dist/awscli/examples/codebuild/list-builds.rst new file mode 100755 index 00000000..d9ae898f --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/list-builds.rst @@ -0,0 +1,35 @@ +**To get a list of AWS CodeBuild builds IDs.** + +The following ``list-builds`` example gets a list of CodeBuild IDs sorted in ascending order. :: + + aws codebuild list-builds --sort-order ASCENDING + +The output includes a ``nextToken`` value which indicates that there is more output available. :: + + { + "nextToken": "4AEA6u7J...The full token has been omitted for brevity...MzY2OA==", + "ids": [ + "codebuild-demo-project:815e755f-bade-4a7e-80f0-efe51EXAMPLE" + "codebuild-demo-project:84a7f3d1-d40e-4956-b4cf-7a9d4EXAMPLE" + ... The full list of build IDs has been omitted for brevity ... + "codebuild-demo-project:931d0b72-bf6f-4040-a472-5c707EXAMPLE" + ] + } + +Run this command again and provide the ``nextToken`` value in the previous response as a parameter to get the next part of the output. Repeat until you don't receive a ``nextToken`` value in the response. :: + + aws codebuild list-builds --sort-order ASCENDING --next-token 4AEA6u7J...The full token has been omitted for brevity...MzY2OA== + +Next part of the output:: + + { + "ids": [ + "codebuild-demo-project:49015049-21cf-4b50-9708-df115EXAMPLE", + "codebuild-demo-project:543e7206-68a3-46d6-a4da-759abEXAMPLE", + ... The full list of build IDs has been omitted for brevity ... + "codebuild-demo-project:c282f198-4582-4b38-bdc0-26f96EXAMPLE" + ] + } + +For more information, see `View a List of Build IDs (AWS CLI) `_ in the *AWS CodeBuild User Guide* + diff --git a/aws/dist/awscli/examples/codebuild/list-curated-environment-images.rst b/aws/dist/awscli/examples/codebuild/list-curated-environment-images.rst new file mode 100755 index 00000000..f1b975a1 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/list-curated-environment-images.rst @@ -0,0 +1,40 @@ +**To get a list of Docker images managed by AWS CodeBuild that you can use for your builds.** + +The following ``list-curated-environment-images`` example lists the Docker images managed by CodeBuild that can be used for builds.:: + + aws codebuild list-curated-environment-images + +Output:: + + { + "platforms": [ + { + "platform": "AMAZON_LINUX", + "languages": [ + { + "language": "JAVA", + "images": [ + { + "description": "AWS ElasticBeanstalk - Java 7 Running on Amazon Linux 64bit v2.1.3", + "name": "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3", + "versions": [ + "aws/codebuild/eb-java-7-amazonlinux-64:2.1.3-1.0.0" + ] + }, + { + "description": "AWS ElasticBeanstalk - Java 8 Running on Amazon Linux 64bit v2.1.3", + "name": "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3", + "versions": [ + "aws/codebuild/eb-java-8-amazonlinux-64:2.1.3-1.0.0" + ] + }, + ... LIST TRUNCATED FOR BREVITY ... + ] + } + ] + } + ] + } + + +For more information, see `Docker Images Provided by CodeBuild `_ in the *AWS CodeBuild User Guide* diff --git a/aws/dist/awscli/examples/codebuild/list-projects.rst b/aws/dist/awscli/examples/codebuild/list-projects.rst new file mode 100755 index 00000000..13e7f903 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/list-projects.rst @@ -0,0 +1,33 @@ +**To get a list of AWS CodeBuild build project names.** + +The following ``list-projects`` example gets a list of CodeBuild build projects sorted by name in ascending order. :: + + aws codebuild list-projects --sort-by NAME --sort-order ASCENDING + +The output includes a ``nextToken`` value which indicates that there is more output available. :: + + { + "nextToken": "Ci33ACF6...The full token has been omitted for brevity...U+AkMx8=", + "projects": [ + "codebuild-demo-project", + "codebuild-demo-project2", + ... The full list of build project names has been omitted for brevity ... + "codebuild-demo-project99" + ] + } + +Run this command again and provide the ``nextToken`` value from the previous response as a parameter to get the next part of the output. Repeat until you don't receive a ``nextToken`` value in the response. :: + + aws codebuild list-projects --sort-by NAME --sort-order ASCENDING --next-token Ci33ACF6...The full token has been omitted for brevity...U+AkMx8= + + { + "projects": [ + "codebuild-demo-project100", + "codebuild-demo-project101", + ... The full list of build project names has been omitted for brevity ... + "codebuild-demo-project122" + ] + } + +For more information, see `View a List of Build Project Names (AWS CLI) `_ in the *AWS CodeBuild User Guide*. + diff --git a/aws/dist/awscli/examples/codebuild/list-source-credentials.rst b/aws/dist/awscli/examples/codebuild/list-source-credentials.rst new file mode 100755 index 00000000..0eca272d --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/list-source-credentials.rst @@ -0,0 +1,24 @@ +**To view a list of sourceCredentialsObjects** + +The following ``list-source-credentials`` example lists tokens for an AWS account connected to one Bitbucket account and one GitHub account. Each ``sourceCredentialsInfos`` object in the response contains connected source credentials information. :: + + aws codebuild list-source-credentials + +Output:: + + { + "sourceCredentialsInfos": [ + { + "serverType": "BITBUCKET", + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/bitbucket", + "authType": "BASIC_AUTH" + }, + { + "serverType": "GITHUB", + "arn": "arn:aws:codebuild:us-west-2:123456789012:token/github", + "authType": "OAUTH" + } + ] + } + +For more information, see `Connect Source Providers with Access Tokens (CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/start-build.rst b/aws/dist/awscli/examples/codebuild/start-build.rst new file mode 100755 index 00000000..b12d87fb --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/start-build.rst @@ -0,0 +1,66 @@ +**To start running a build of an AWS CodeBuild build project.** + +The following ``start-build`` example starts a build for the specified CodeBuild project. The build overrides both the project's setting for the number of minutes the build is allowed to be queued before it times out and the project's artifact settings. :: + + aws codebuild start-build \ + --project-name "my-demo-project" \ + --queued-timeout-in-minutes-override 5 \ + --artifacts-override {"\"type\": \"S3\",\"location\": \"arn:aws:s3:::artifacts-override\",\"overrideArtifactName\":true"} + +Output:: + + { + "build": { + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "buildStatus": "IN_PROGRESS", + "buildComplete": false, + "projectName": "my-demo-project", + "timeoutInMinutes": 60, + "source": { + "insecureSsl": false, + "type": "S3", + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip" + }, + "queuedTimeoutInMinutes": 5, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "currentPhase": "QUEUED", + "startTime": 1556905683.568, + "environment": { + "computeType": "BUILD_GENERAL1_MEDIUM", + "environmentVariables": [], + "type": "LINUX_CONTAINER", + "privilegedMode": false, + "image": "aws/codebuild/standard:1.0", + "imagePullCredentialsType": "CODEBUILD" + }, + "phases": [ + { + "phaseStatus": "SUCCEEDED", + "startTime": 1556905683.568, + "phaseType": "SUBMITTED", + "durationInSeconds": 0, + "endTime": 1556905684.524 + }, + { + "startTime": 1556905684.524, + "phaseType": "QUEUED" + } + ], + "logs": { + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=null;stream=null" + }, + "artifacts": { + "encryptionDisabled": false, + "location": "arn:aws:s3:::artifacts-override/my-demo-project", + "overrideArtifactName": true + }, + "cache": { + "type": "NO_CACHE" + }, + "id": "my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE", + "initiator": "my-aws-account-name", + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project::12345678-a1b2-c3d4-e5f6-11111EXAMPLE" + } + } + +For more information, see `Run a Build (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/stop-build.rst b/aws/dist/awscli/examples/codebuild/stop-build.rst new file mode 100755 index 00000000..0c519d8c --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/stop-build.rst @@ -0,0 +1,132 @@ +**To stop a build of an AWS CodeBuild build project.** + +The following ``stop-build`` example stops the specified CodeBuild build. :: + + aws codebuild stop-build --id my-demo-project:12345678-a1b2-c3d4-e5f6-11111EXAMPLE + +Output:: + + { + "build": { + "startTime": 1556906956.318, + "initiator": "my-aws-account-name", + "projectName": "my-demo-project", + "currentPhase": "COMPLETED", + "cache": { + "type": "NO_CACHE" + }, + "source": { + "insecureSsl": false, + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source.zip", + "type": "S3" + }, + "id": "my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "endTime": 1556906974.781, + "phases": [ + { + "durationInSeconds": 0, + "phaseType": "SUBMITTED", + "endTime": 1556906956.935, + "phaseStatus": "SUCCEEDED", + "startTime": 1556906956.318 + }, + { + "durationInSeconds": 1, + "phaseType": "QUEUED", + "endTime": 1556906958.272, + "phaseStatus": "SUCCEEDED", + "startTime": 1556906956.935 + }, + { + "phaseType": "PROVISIONING", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 14, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906972.847, + "startTime": 1556906958.272 + }, + { + "phaseType": "DOWNLOAD_SOURCE", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.552, + "startTime": 1556906972.847 + }, + { + "phaseType": "INSTALL", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.75, + "startTime": 1556906973.552 + }, + { + "phaseType": "PRE_BUILD", + "phaseStatus": "SUCCEEDED", + "durationInSeconds": 0, + "contexts": [ + { + "message": "", + "statusCode": "" + } + ], + "endTime": 1556906973.937, + "startTime": 1556906973.75 + }, + { + "durationInSeconds": 0, + "phaseType": "BUILD", + "endTime": 1556906974.781, + "phaseStatus": "STOPPED", + "startTime": 1556906973.937 + }, + { + "phaseType": "COMPLETED", + "startTime": 1556906974.781 + } + ], + "artifacts": { + "location": "arn:aws:s3:::artifacts-override/my-demo-project", + "encryptionDisabled": false, + "overrideArtifactName": true + }, + "buildComplete": true, + "buildStatus": "STOPPED", + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "queuedTimeoutInMinutes": 5, + "timeoutInMinutes": 60, + "environment": { + "type": "LINUX_CONTAINER", + "environmentVariables": [], + "computeType": "BUILD_GENERAL1_MEDIUM", + "privilegedMode": false, + "image": "aws/codebuild/standard:1.0", + "imagePullCredentialsType": "CODEBUILD" + }, + "logs": { + "streamName": "1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "deepLink": "https://console.aws.amazon.com/cloudwatch/home?region=us-west-2#logEvent:group=/aws/codebuild/my-demo-project;stream=1a2b3c4d-5678-90ab-cdef-11111EXAMPLE", + "groupName": "/aws/codebuild/my-demo-project" + }, + "arn": "arn:aws:codebuild:us-west-2:123456789012:build/my-demo-project:1a2b3c4d-5678-90ab-cdef-11111EXAMPLE" + } + } + +For more information, see `Stop a Build (AWS CLI) `_ in the *AWS CodeBuild User Guide*. diff --git a/aws/dist/awscli/examples/codebuild/update-project.rst b/aws/dist/awscli/examples/codebuild/update-project.rst new file mode 100755 index 00000000..aeee91a4 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/update-project.rst @@ -0,0 +1,56 @@ +**To change an AWS CodeBuild build project's settings.** + +The following ``update-project`` example changes the settings of the specified CodeBuild build project named my-demo-project. :: + + aws codebuild update-project --name "my-demo-project" \ + --description "This project is updated" \ + --source "{\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip\"}" \ + --artifacts {"\"type\": \"S3\",\"location\": \"codebuild-us-west-2-123456789012-output-bucket-2\""} \ + --environment "{\"type\": \"LINUX_CONTAINER\",\"image\": \"aws/codebuild/standard:1.0\",\"computeType\": \"BUILD_GENERAL1_MEDIUM\"}" \ + --service-role "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role" + +The output displays the updated settings. :: + + { + "project": { + "arn": "arn:aws:codebuild:us-west-2:123456789012:project/my-demo-project", + "environment": { + "privilegedMode": false, + "environmentVariables": [], + "type": "LINUX_CONTAINER", + "image": "aws/codebuild/standard:1.0", + "computeType": "BUILD_GENERAL1_MEDIUM", + "imagePullCredentialsType": "CODEBUILD" + }, + "queuedTimeoutInMinutes": 480, + "description": "This project is updated", + "artifacts": { + "packaging": "NONE", + "name": "my-demo-project", + "type": "S3", + "namespaceType": "NONE", + "encryptionDisabled": false, + "location": "codebuild-us-west-2-123456789012-output-bucket-2" + }, + "encryptionKey": "arn:aws:kms:us-west-2:123456789012:alias/aws/s3", + "badge": { + "badgeEnabled": false + }, + "serviceRole": "arn:aws:iam::123456789012:role/service-role/my-codebuild-service-role", + "lastModified": 1556840545.967, + "tags": [], + "timeoutInMinutes": 60, + "created": 1556839783.274, + "name": "my-demo-project", + "cache": { + "type": "NO_CACHE" + }, + "source": { + "type": "S3", + "insecureSsl": false, + "location": "codebuild-us-west-2-123456789012-input-bucket/my-source-2.zip" + } + } + } + +For more information, see `Change a Build Project's Settings (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff --git a/aws/dist/awscli/examples/codebuild/update-webhook.rst b/aws/dist/awscli/examples/codebuild/update-webhook.rst new file mode 100755 index 00000000..ff3db761 --- /dev/null +++ b/aws/dist/awscli/examples/codebuild/update-webhook.rst @@ -0,0 +1,47 @@ +**To update the webhook for an AWS CodeBuild project** + +The following ``update-webhook`` example updates a webhook for the specified CodeBuild project with two filter groups. The ``--rotate-secret`` parameter specifies that GitHub rotate the project's secret key every time a code change triggers a build. The first filter group specifies pull requests that are created, updated, or reopened on branches with Git reference names that match the regular expression ``^refs/heads/master$`` and head references that match ``^refs/heads/myBranch$``. The second filter group specifies push requests on branches with Git reference names that do not match the regular expression ``^refs/heads/myBranch$``. :: + + aws codebuild update-webhook \ + --project-name Project2 \ + --rotate-secret \ + --filter-groups "[[{\"type\":\"EVENT\",\"pattern\":\"PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true},{\"type\":\"BASE_REF\",\"pattern\":\"^refs/heads/master$\",\"excludeMatchedPattern\":true}],[{\"type\":\"EVENT\",\"pattern\":\"PUSH\"},{\"type\":\"HEAD_REF\",\"pattern\":\"^refs/heads/myBranch$\",\"excludeMatchedPattern\":true}]]" + +Output:: + + { + "webhook": { + "filterGroups": [ + [ + { + "pattern": "PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED", + "type": "EVENT" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/myBranch$", + "type": "HEAD_REF" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/master$", + "type": "BASE_REF" + } + ], + [ + { + "pattern": "PUSH", + "type": "EVENT" + }, + { + "excludeMatchedPattern": true, + "pattern": "refs/heads/myBranch$", + "type": "HEAD_REF" + } + ] + ], + "lastModifiedSecret": 1556312220.133 + } + } + +For more information, see `Change a Build Project's Settings (AWS CLI) `_ in the *AWS CodeBuild User Guide* diff --git a/aws/dist/awscli/examples/codecommit/batch-describe-merge-conflicts.rst b/aws/dist/awscli/examples/codecommit/batch-describe-merge-conflicts.rst new file mode 100644 index 00000000..72740de2 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/batch-describe-merge-conflicts.rst @@ -0,0 +1,71 @@ +**To get information about merge conflicts in all files or a subset of files in a merge between two commit specifiers** + +The following ``batch-describe-merge-conflicts`` example determines the merge conflicts for merging a source branch named ``feature-randomizationfeature`` with a destination branch named ``master`` using the ``THREE_WAY_MERGE`` strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit batch-describe-merge-conflicts \ + --source-commit-specifier feature-randomizationfeature \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo + +Output:: + + { + "conflicts": [ + { + "conflictMetadata": { + "filePath": "readme.md", + "fileSizes": { + "source": 139, + "destination": 230, + "base": 85 + }, + "fileModes": { + "source": "NORMAL", + "destination": "NORMAL", + "base": "NORMAL" + }, + "objectTypes": { + "source": "FILE", + "destination": "FILE", + "base": "FILE" + }, + "numberOfConflicts": 1, + "isBinaryFile": { + "source": false, + "destination": false, + "base": false + }, + "contentConflict": true, + "fileModeConflict": false, + "objectTypeConflict": false, + "mergeOperations": { + "source": "M", + "destination": "M" + } + }, + "mergeHunks": [ + { + "isConflict": true, + "source": { + "startLine": 0, + "endLine": 3, + "hunkContent": "VGhpcyBpEXAMPLE==" + }, + "destination": { + "startLine": 0, + "endLine": 1, + "hunkContent": "VXNlIHRoEXAMPLE=" + } + } + ] + } + ], + "errors": [], + "destinationCommitId": "86958e0aEXAMPLE", + "sourceCommitId": "6ccd57fdEXAMPLE", + "baseCommitId": "767b6958EXAMPLE" + } + + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/batch-get-commits.rst b/aws/dist/awscli/examples/codecommit/batch-get-commits.rst new file mode 100644 index 00000000..94a3a5a2 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/batch-get-commits.rst @@ -0,0 +1,54 @@ +**To view information about multiple commits** + +The following ``batch-get-commits`` example displays details about the specified commits. :: + + aws codecommit batch-get-commits \ + --repository-name MyDemoRepo \ + --commit-ids 317f8570EXAMPLE 4c925148EXAMPLE + +Output:: + + { + "commits": [ + { + "additionalData": "", + "committer": { + "date": "1508280564 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "author": { + "date": "1508280564 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "commitId": "317f8570EXAMPLE", + "treeId": "1f330709EXAMPLE", + "parents": [ + "6e147360EXAMPLE" + ], + "message": "Change variable name and add new response element" + }, + { + "additionalData": "", + "committer": { + "date": "1508280542 -0800", + "name": "Li Juan", + "email": "li_juan@example.com" + }, + "author": { + "date": "1508280542 -0800", + "name": "Li Juan", + "email": "li_juan@example.com" + }, + "commitId": "4c925148EXAMPLE", + "treeId": "1f330709EXAMPLE", + "parents": [ + "317f8570EXAMPLE" + ], + "message": "Added new class" + } + } + + +For more information, see `View Commit Details `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/batch-get-repositories.rst b/aws/dist/awscli/examples/codecommit/batch-get-repositories.rst new file mode 100644 index 00000000..de164cfb --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/batch-get-repositories.rst @@ -0,0 +1,39 @@ +**To view details about multiple repositories** + +This example shows details about multiple AWS CodeCommit repositories. + +Command:: + + aws codecommit batch-get-repositories --repository-names MyDemoRepo MyOtherDemoRepo + +Output:: + + { + "repositories": [ + { + "creationDate": 1429203623.625, + "defaultBranch": "master", + "repositoryName": "MyDemoRepo", + "cloneUrlSsh": "ssh://ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos//v1/repos/MyDemoRepo", + "lastModifiedDate": 1430783812.0869999, + "repositoryDescription": "My demonstration repository", + "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", + "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + "Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyDemoRepo", + "accountId": "111111111111" + }, + { + "creationDate": 1429203623.627, + "defaultBranch": "master", + "repositoryName": "MyOtherDemoRepo", + "cloneUrlSsh": "ssh://ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos//v1/repos/MyOtherDemoRepo", + "lastModifiedDate": 1430783812.0889999, + "repositoryDescription": "My other demonstration repository", + "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyOtherDemoRepo", + "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE", + "Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyOtherDemoRepo", + "accountId": "111111111111" + } + ], + "repositoriesNotFound": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/create-branch.rst b/aws/dist/awscli/examples/codecommit/create-branch.rst new file mode 100644 index 00000000..ea0964e5 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/create-branch.rst @@ -0,0 +1,11 @@ +**To create a branch** + +This example creates a branch in an AWS CodeCommit repository. This command produces output only if there are errors. + +Command:: + + aws codecommit create-branch --repository-name MyDemoRepo --branch-name MyNewBranch --commit-id 317f8570EXAMPLE + +Output:: + + None. diff --git a/aws/dist/awscli/examples/codecommit/create-commit.rst b/aws/dist/awscli/examples/codecommit/create-commit.rst new file mode 100755 index 00000000..61236319 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/create-commit.rst @@ -0,0 +1,25 @@ +**To create a commit** + +The following ``create-commit`` example demonstrates how to create an initial commit for a repository that adds a ``readme.md`` file to a repository named ``MyDemoRepo`` in the ``master`` branch. :: + + aws codecommit create-commit --repository-name MyDemoRepo --branch-name master --put-files "filePath=readme.md,fileContent='Welcome to our team repository.'" + +Output:: + + { + "filesAdded": [ + { + "blobId": "5e1c309d-EXAMPLE", + "absolutePath": "readme.md", + "fileMode": "NORMAL" + } + ], + "commitId": "4df8b524-EXAMPLE", + "treeId": "55b57003-EXAMPLE", + "filesDeleted": [], + "filesUpdated": [] + } + +For more information, see `Create a Commit in AWS CodeCommit`_ in the *AWS CodeCommit User Guide*. + +.. _`Create a Commit in AWS CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-create-commit.html#how-to-create-commit-cli \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/create-pull-request.rst b/aws/dist/awscli/examples/codecommit/create-pull-request.rst new file mode 100644 index 00000000..311d342c --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/create-pull-request.rst @@ -0,0 +1,36 @@ +**To create a pull request** + +The following ``create-pull-request`` example creates a pull request named 'My Pull Request' with a description of 'Please review these changes by Tuesday' that targets the 'MyNewBranch' source branch and is to be merged to the default branch 'master' in an AWS CodeCommit repository named 'MyDemoRepo'. :: + + aws codecommit create-pull-request \ + --title "My Pull Request" \ + --description "Please review these changes by Tuesday" \ + --client-request-token 123Example \ + --targets repositoryName=MyDemoRepo,sourceReference=MyNewBranch + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "clientRequestToken": "123Example", + "creationDate": 1508962823.285, + "description": "Please review these changes by Tuesday", + "lastActivityDate": 1508962823.285, + "pullRequestId": "42", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "5d036259EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "317f8570EXAMPLE", + "sourceReference": "refs/heads/MyNewBranch" + } + ], + "title": "My Pull Request" + } + } diff --git a/aws/dist/awscli/examples/codecommit/create-repository.rst b/aws/dist/awscli/examples/codecommit/create-repository.rst new file mode 100644 index 00000000..1e9685dc --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/create-repository.rst @@ -0,0 +1,22 @@ +**To create a repository** + +This example creates a repository and associates it with the user's AWS account. + +Command:: + + aws codecommit create-repository --repository-name MyDemoRepo --repository-description "My demonstration repository" + +Output:: + + { + "repositoryMetadata": { + "repositoryName": "MyDemoRepo", + "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", + "lastModifiedDate": 1444766838.027, + "repositoryDescription": "My demonstration repository", + "cloneUrlHttp": "https://git-codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", + "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + "Arn": "arn:aws:codecommit:us-east-1:111111111111EXAMPLE:MyDemoRepo", + "accountId": "111111111111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/create-unreferenced-merge-commit.rst b/aws/dist/awscli/examples/codecommit/create-unreferenced-merge-commit.rst new file mode 100644 index 00000000..dac9be6e --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/create-unreferenced-merge-commit.rst @@ -0,0 +1,21 @@ +**To create an unreferenced commit that represents the result of merging two commit specifiers** + +The following ``create-unreferenced-merge-commit`` example creates a commit that represents the results of a merge between a source branch named ``bugfix-1234`` with a destination branch named ``master`` using the THREE_WAY_MERGE strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit create-unreferenced-merge-commit \ + --source-commit-specifier bugfix-1234 \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Testing the results of this merge." + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/credential-helper.rst b/aws/dist/awscli/examples/codecommit/credential-helper.rst new file mode 100755 index 00000000..017d93ab --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/credential-helper.rst @@ -0,0 +1,18 @@ +**To set up the credential helper included in the AWS CLI with AWS CodeCommit** + +The ``credential-helper`` utility is not designed to be called directly from the AWS CLI. Instead it is intended to be used as a parameter with the ``git config`` command to set up your local computer. It enables Git to use HTTPS and a cryptographically signed version of your IAM user credentials or Amazon EC2 instance role whenever Git needs to authenticate with AWS to interact with CodeCommit repositories. :: + + git config --global credential.helper '!aws codecommit credential-helper $@' + git config --global credential.UseHttpPath true + +Output:: + + [credential] + helper = !aws codecommit credential-helper $@ + UseHttpPath = true + +For more information, see `Setting up for AWS CodeCommit Using Other Methods`_ in the *AWS CodeCommit User Guide*. Review the content carefully, and then follow the procedures in one of the following topics: `For HTTPS Connections on Linux, macOS, or Unix`_ or `For HTTPS Connections on Windows`_ in the *AWS CodeCommit User Guide*. + +.. _`Setting up for AWS CodeCommit Using Other Methods`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up.html?shortFooter=true#setting-up-other +.. _`For HTTPS Connections on Linux, macOS, or Unix`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-unixes.html +.. _`For HTTPS Connections on Windows`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-https-windows.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/delete-branch.rst b/aws/dist/awscli/examples/codecommit/delete-branch.rst new file mode 100644 index 00000000..72c28779 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/delete-branch.rst @@ -0,0 +1,16 @@ +**To delete a branch** + +This example shows how to delete a branch in an AWS CodeCommit repository. + +Command:: + + aws codecommit delete-branch --repository-name MyDemoRepo --branch-name MyNewBranch + +Output:: + + { + "branch": { + "commitId": "317f8570EXAMPLE", + "branchName": "MyNewBranch" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/delete-comment-content.rst b/aws/dist/awscli/examples/codecommit/delete-comment-content.rst new file mode 100644 index 00000000..c02261b3 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/delete-comment-content.rst @@ -0,0 +1,18 @@ +**To delete the content of a comment** + +You can only delete the content of a comment if you created the comment. This example demonstrates how to delete the content of a comment with the system-generated ID of 'ff30b348EXAMPLEb9aa670f':: + + aws codecommit delete-comment-content --comment-id ff30b348EXAMPLEb9aa670f + +Output:: + + { + "comment": { + "creationDate": 1508369768.142, + "deleted": true, + "lastModifiedDate": 1508369842.278, + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/delete-file.rst b/aws/dist/awscli/examples/codecommit/delete-file.rst new file mode 100755 index 00000000..5fdad2f7 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/delete-file.rst @@ -0,0 +1,18 @@ +**To delete a file** + +The following ``delete-file`` example demonstrates how to delete a file named ``README.md`` from a branch named ``master`` with a most recent commit ID of ``c5709475EXAMPLE`` in a repository named ``MyDemoRepo``. :: + + aws codecommit delete-file --repository-name MyDemoRepo --branch-name master --file-path README.md --parent-commit-id c5709475EXAMPLE + +Output:: + + { + "blobId":"559b44fEXAMPLE", + "commitId":"353cf655EXAMPLE", + "filePath":"README.md", + "treeId":"6bc824cEXAMPLE" + } + +For more information, see `Edit or Delete a File in AWS CodeCommit`_ in the *AWS CodeCommit API Reference* guide. + +.. _`Edit or Delete a File in AWS CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/how-to-edit-file.html?shortFooter=true#how-to-edit-file-cli \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/delete-repository.rst b/aws/dist/awscli/examples/codecommit/delete-repository.rst new file mode 100644 index 00000000..c3232814 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/delete-repository.rst @@ -0,0 +1,13 @@ +**To delete a repository** + +This example shows how to delete an AWS CodeCommit repository. + +Command:: + + aws codecommit delete-repository --repository-name MyDemoRepo + +Output:: + + { + "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/describe-merge-conflicts.rst b/aws/dist/awscli/examples/codecommit/describe-merge-conflicts.rst new file mode 100644 index 00000000..3eddab0b --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/describe-merge-conflicts.rst @@ -0,0 +1,66 @@ +**To get detailed information about merge conflicts** + +The following ``describe-merge-conflicts`` example determines the merge conflicts for a file named ``readme.md`` in the specified source branch and destination branch using the THREE_WAY_MERGE strategy. :: + + aws codecommit describe-merge-conflicts \ + --source-commit-specifier feature-randomizationfeature \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --file-path readme.md \ + --repository-name MyDemoRepo + +Output:: + + { + "conflictMetadata": { + "filePath": "readme.md", + "fileSizes": { + "source": 139, + "destination": 230, + "base": 85 + }, + "fileModes": { + "source": "NORMAL", + "destination": "NORMAL", + "base": "NORMAL" + }, + "objectTypes": { + "source": "FILE", + "destination": "FILE", + "base": "FILE" + }, + "numberOfConflicts": 1, + "isBinaryFile": { + "source": false, + "destination": false, + "base": false + }, + "contentConflict": true, + "fileModeConflict": false, + "objectTypeConflict": false, + "mergeOperations": { + "source": "M", + "destination": "M" + } + }, + "mergeHunks": [ + { + "isConflict": true, + "source": { + "startLine": 0, + "endLine": 3, + "hunkContent": "VGhpcyBpEXAMPLE=" + }, + "destination": { + "startLine": 0, + "endLine": 1, + "hunkContent": "VXNlIHRoEXAMPLE=" + } + } + ], + "destinationCommitId": "86958e0aEXAMPLE", + "sourceCommitId": "6ccd57fdEXAMPLE", + "baseCommitId": "767b69580EXAMPLE" + } + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/describe-pull-request-events.rst b/aws/dist/awscli/examples/codecommit/describe-pull-request-events.rst new file mode 100644 index 00000000..7297bc08 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/describe-pull-request-events.rst @@ -0,0 +1,27 @@ +**To view events in a pull request** + +The following ``describe-pull-request-events`` example retrieves the events for a pull request with the ID of '8'. :: + + aws codecommit describe-pull-request-events --pull-request-id 8 + +Output:: + + { + "pullRequestEvents": [ + { + "pullRequestId": "8", + "pullRequestEventType": "PULL_REQUEST_CREATED", + "eventDate": 1510341779.53, + "actor": "arn:aws:iam::111111111111:user/Zhang_Wei" + }, + { + "pullRequestStatusChangedEventMetadata": { + "pullRequestStatus": "CLOSED" + }, + "pullRequestId": "8", + "pullRequestEventType": "PULL_REQUEST_STATUS_CHANGED", + "eventDate": 1510341930.72, + "actor": "arn:aws:iam::111111111111:user/Jane_Doe" + } + ] + } diff --git a/aws/dist/awscli/examples/codecommit/get-blob.rst b/aws/dist/awscli/examples/codecommit/get-blob.rst new file mode 100644 index 00000000..6588a0a0 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-blob.rst @@ -0,0 +1,11 @@ +**To view information about a Git blob object** + +The following ``get-blob`` example retrieves information about a Git blob with the ID of '2eb4af3bEXAMPLE' in an AWS CodeCommit repository named 'MyDemoRepo'. :: + + aws codecommit get-blob --repository-name MyDemoRepo --blob-id 2eb4af3bEXAMPLE + +Output:: + + { + "content": "QSBCaW5hcnkgTGFyToEXAMPLE=" + } diff --git a/aws/dist/awscli/examples/codecommit/get-branch.rst b/aws/dist/awscli/examples/codecommit/get-branch.rst new file mode 100644 index 00000000..1100d334 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-branch.rst @@ -0,0 +1,16 @@ +**To get information about a branch** + +This example gets information about a branch in an AWS CodeCommit repository. + +Command:: + + aws codecommit get-branch --repository-name MyDemoRepo --branch-name MyNewBranch + +Output:: + + { + "BranchInfo": { + "commitID": "317f8570EXAMPLE", + "branchName": "MyNewBranch" + } + } diff --git a/aws/dist/awscli/examples/codecommit/get-comment.rst b/aws/dist/awscli/examples/codecommit/get-comment.rst new file mode 100644 index 00000000..2a8bfca7 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-comment.rst @@ -0,0 +1,20 @@ +**To view details of a comment** + +This example demonstrates how to view details of a comment with the system-generated comment ID of 'ff30b348EXAMPLEb9aa670f':: + + aws codecommit get-comment --comment-id ff30b348EXAMPLEb9aa670f + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "content": "Whoops - I meant to add this comment to the line, but I don't see how to delete it.", + "creationDate": 1508369768.142, + "deleted": false, + "commentId": "", + "lastModifiedDate": 1508369842.278 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/get-comments-for-compared-commit.rst b/aws/dist/awscli/examples/codecommit/get-comments-for-compared-commit.rst new file mode 100644 index 00000000..947cb5f6 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-comments-for-compared-commit.rst @@ -0,0 +1,47 @@ +**To view comments on a commit** + +This example demonstrates how to view view comments made on the comparison between two commits in a repository named 'MyDemoRepo':: + + aws codecommit get-comments-for-compared-commit --repository-name MyDemoRepo --before-commit-ID 6e147360EXAMPLE --after-commit-id 317f8570EXAMPLE + +Output:: + + { + "commentsForComparedCommitData": [ + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "317f8570EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "6e147360EXAMPLE", + "comments": [ + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "ff30b348EXAMPLEb9aa670f", + "content": "Whoops - I meant to add this comment to the line, not the file, but I don't see how to delete it.", + "creationDate": 1508369768.142, + "deleted": false, + "CommentId": "123abc-EXAMPLE", + "lastModifiedDate": 1508369842.278 + }, + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "553b509bEXAMPLE56198325", + "content": "Can you add a test case for this?", + "creationDate": 1508369612.240, + "deleted": false, + "commentId": "456def-EXAMPLE", + "lastModifiedDate": 1508369612.240 + } + ], + "location": { + "filePath": "cl_sample.js", + "filePosition": 1232, + "relativeFileVersion": "after" + }, + "repositoryName": "MyDemoRepo" + } + ], + "nextToken": "exampleToken" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/get-comments-for-pull-request.rst b/aws/dist/awscli/examples/codecommit/get-comments-for-pull-request.rst new file mode 100644 index 00000000..0821e099 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-comments-for-pull-request.rst @@ -0,0 +1,50 @@ +**To view comments for a pull request** + +This example demonstrates how to view comments for a pull request in a repository named 'MyDemoRepo'. :: + + aws codecommit get-comments-for-pull-request \ + --repository-name MyDemoRepo \ + --before-commit-ID 317f8570EXAMPLE \ + --after-commit-id 5d036259EXAMPLE + +Output:: + + { + "commentsForPullRequestData": [ + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "5d036259EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "317f8570EXAMPLE", + "comments": [ + { + "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", + "clientRequestToken": "", + "commentId": "abcd1234EXAMPLEb5678efgh", + "content": "These don't appear to be used anywhere. Can we remove them?", + "creationDate": 1508369622.123, + "deleted": false, + "lastModifiedDate": 1508369622.123 + }, + { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "442b498bEXAMPLE5756813", + "content": "Good catch. I'll remove them.", + "creationDate": 1508369829.104, + "deleted": false, + "commentId": "abcd1234EXAMPLEb5678efgh", + "lastModifiedDate": 150836912.273 + } + ], + "location": { + "filePath": "ahs_count.py", + "filePosition": 367, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo", + "pullRequestId": "42" + } + ], + "nextToken": "exampleToken" + } diff --git a/aws/dist/awscli/examples/codecommit/get-commit.rst b/aws/dist/awscli/examples/codecommit/get-commit.rst new file mode 100644 index 00000000..3453d3c8 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-commit.rst @@ -0,0 +1,30 @@ +**To view information about a commit in a repository** + +This example shows details about a commit with the system-generated ID of '7e9fd3091thisisanexamplethisisanexample1' in an AWS CodeCommit repository named 'MyDemoRepo'. + +Command:: + + aws codecommit get-commit --repository-name MyDemoRepo --commit-id 7e9fd3091thisisanexamplethisisanexample1 + +Output:: + + { + "commit": { + "additionalData": "", + "committer": { + "date": "1484167798 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "author": { + "date": "1484167798 -0800", + "name": "Mary Major", + "email": "mary_major@example.com" + }, + "treeId": "347a3408thisisanexampletreeidexample", + "parents": [ + "7aa87a031thisisanexamplethisisanexample1" + ], + "message": "Fix incorrect variable name" + } + } diff --git a/aws/dist/awscli/examples/codecommit/get-differences.rst b/aws/dist/awscli/examples/codecommit/get-differences.rst new file mode 100644 index 00000000..f60f4033 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-differences.rst @@ -0,0 +1,27 @@ +**To get information about differences for a commit specifier in a repository** + +This example shows view metadata information about changes between two commit specifiers (branch, tag, HEAD, or other fully qualified references, such as commit IDs) in a renamed folder in AWS CodeCommit repository named MyDemoRepo. The example includes several options that are not required, including --before-commit-specifier, --before-path, and --after-path, in order to more fully illustrate how you can use these options to limit the results. The response includes file mode permissions. + +Command:: + + aws codecommit get-differences --repository-name MyDemoRepo --before-commit-specifier 955bba12thisisanexamplethisisanexample --after-commit-specifier 14a95463thisisanexamplethisisanexample --before-path tmp/example-folder --after-path tmp/renamed-folder + +Output:: + + { + "differences": [ + { + "afterBlob": { + "path": "blob.txt", + "blobId": "2eb4af3b1thisisanexamplethisisanexample1", + "mode": "100644" + }, + "changeType": "M", + "beforeBlob": { + "path": "blob.txt", + "blobId": "bf7fcf281thisisanexamplethisisanexample1", + "mode": "100644" + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/get-file.rst b/aws/dist/awscli/examples/codecommit/get-file.rst new file mode 100755 index 00000000..8fb5d47e --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-file.rst @@ -0,0 +1,20 @@ +**To get the base-64 encoded contents of a file in an AWS CodeCommit repository** + +The following ``get-file`` example demonstrates how to get the base-64 encoded contents of a file named ``README.md`` from a branch named ``master`` in a repository named ``MyDemoRepo``. :: + + aws codecommit get-file --repository-name MyDemoRepo --commit-specifier master --file-path README.md + +Output:: + + { + "blobId":"559b44fEXAMPLE", + "commitId":"c5709475EXAMPLE", + "fileContent":"IyBQaHVzEXAMPLE", + "filePath":"README.md", + "fileMode":"NORMAL", + "fileSize":1563 + } + +For more information, see `GetFile`_ in the *AWS CodeCommit API Reference* guide. + +.. _`GetFile`: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFile.html diff --git a/aws/dist/awscli/examples/codecommit/get-folder.rst b/aws/dist/awscli/examples/codecommit/get-folder.rst new file mode 100755 index 00000000..011992d1 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-folder.rst @@ -0,0 +1,63 @@ +**To get the contents of a folder in an AWS CodeCommit repository** + +The following ``get-folder`` example demonstrates how to get the contents of a top-level folder from a repository named ``MyDemoRepo``. :: + + aws codecommit get-folder --repository-name MyDemoRepo --folder-path "" + +Output:: + + { + "commitId":"c5709475EXAMPLE", + "files":[ + { + "absolutePath":".gitignore", + "blobId":"74094e8bEXAMPLE", + "fileMode":"NORMAL", + "relativePath":".gitignore" + }, + { + "absolutePath":"Gemfile", + "blobId":"9ceb72f6EXAMPLE", + "fileMode":"NORMAL", + "relativePath":"Gemfile" + }, + { + "absolutePath":"Gemfile.lock", + "blobId":"795c4a2aEXAMPLE", + "fileMode":"NORMAL", + "relativePath":"Gemfile.lock" + }, + { + "absolutePath":"LICENSE.txt", + "blobId":"0c7932c8EXAMPLE", + "fileMode":"NORMAL", + "relativePath":"LICENSE.txt" + }, + { + "absolutePath":"README.md", + "blobId":"559b44feEXAMPLE", + "fileMode":"NORMAL", + "relativePath":"README.md" + } + ], + "folderPath":"", + "subFolders":[ + { + "absolutePath":"public", + "relativePath":"public", + "treeId":"d5e92ae3aEXAMPLE" + }, + { + "absolutePath":"tmp", + "relativePath":"tmp", + "treeId":"d564d0bcEXAMPLE" + } + ], + "subModules":[], + "symbolicLinks":[], + "treeId":"7b3c4dadEXAMPLE" + } + +For more information, see `GetFolder`_ in the *AWS CodeCommit API Reference* guide. + +.. _`GetFolder`: https://docs.aws.amazon.com/codecommit/latest/APIReference/API_GetFolder.html diff --git a/aws/dist/awscli/examples/codecommit/get-merge-commit.rst b/aws/dist/awscli/examples/codecommit/get-merge-commit.rst new file mode 100644 index 00000000..50775708 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-merge-commit.rst @@ -0,0 +1,20 @@ +**To get detailed information about a merge commit** + +The following ``get-merge-commit`` example displays details about a merge commit for the source branch named ``bugfix-bug1234`` with a destination branch named ``master`` using the THREE_WAY_MERGE strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit get-merge-commit \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier master \ + --merge-option THREE_WAY_MERGE \ + --repository-name MyDemoRepo + +Output:: + + { + "sourceCommitId": "c5709475EXAMPLE", + "destinationCommitId": "317f8570EXAMPLE", + "baseCommitId": "fb12a539EXAMPLE", + "mergeCommitId": "ffc4d608eEXAMPLE" + } + +For more information, see `View Commit Details `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/get-merge-conflicts.rst b/aws/dist/awscli/examples/codecommit/get-merge-conflicts.rst new file mode 100644 index 00000000..7d16cd4f --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-merge-conflicts.rst @@ -0,0 +1,17 @@ +**To view whether there are any merge conflicts for a pull request** + +The following ``get-merge-conflicts`` example displays whether there are any merge conflicts between the tip of a source branch named 'my-feature-branch' and a destination branch named 'master' in a repository named 'MyDemoRepo'. :: + + aws codecommit get-merge-conflicts \ + --repository-name MyDemoRepo \ + --source-commit-specifier my-feature-branch \ + --destination-commit-specifier master \ + --merge-option FAST_FORWARD_MERGE + +Output:: + + { + "destinationCommitId": "fac04518EXAMPLE", + "mergeable": false, + "sourceCommitId": "16d097f03EXAMPLE" + } diff --git a/aws/dist/awscli/examples/codecommit/get-merge-options.rst b/aws/dist/awscli/examples/codecommit/get-merge-options.rst new file mode 100644 index 00000000..9304b1f8 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-merge-options.rst @@ -0,0 +1,24 @@ +**To get information about the merge options available for merging two specified branches** + +The following ``get-merge-options`` example determines the merge options available for merging a source branch named ``bugfix-bug1234`` with a destination branch named ``master`` in a repository named ``MyDemoRepo``. :: + + aws codecommit get-merge-options \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier master \ + --repository-name MyDemoRepo + +Output:: + + { + "mergeOptions": [ + "FAST_FORWARD_MERGE", + "SQUASH_MERGE", + "THREE_WAY_MERGE" + ], + "sourceCommitId": "18059494EXAMPLE", + "destinationCommitId": "ffd3311dEXAMPLE", + "baseCommitId": "ffd3311dEXAMPLE" + } + + +For more information, see `Resolve Conflicts in a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/get-pull-request.rst b/aws/dist/awscli/examples/codecommit/get-pull-request.rst new file mode 100644 index 00000000..1a64667c --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-pull-request.rst @@ -0,0 +1,32 @@ +**To view details of a pull request** + +This example demonstrates how to view information about a pull request with the ID of '42':: + + aws codecommit get-pull-request --pull-request-id 42 + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "title": "Pronunciation difficulty analyzer" + "pullRequestTargets": [ + { + "destinationReference": "refs/heads/master", + "destinationCommit": "5d036259EXAMPLE", + "sourceReference": "refs/heads/jane-branch" + "sourceCommit": "317f8570EXAMPLE", + "repositoryName": "MyDemoRepo", + "mergeMetadata": { + "isMerged": false, + }, + } + ], + "lastActivityDate": 1508442444, + "pullRequestId": "42", + "clientRequestToken": "123Example", + "pullRequestStatus": "OPEN", + "creationDate": 1508962823, + "description": "A code review of the new feature I just added to the service.", + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/get-repository-triggers.rst b/aws/dist/awscli/examples/codecommit/get-repository-triggers.rst new file mode 100644 index 00000000..081c155a --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-repository-triggers.rst @@ -0,0 +1,36 @@ +**To get information about triggers in a repository** + +This example shows details about triggers configured for an AWS CodeCommit repository named 'MyDemoRepo'. + +Command:: + + aws codecommit get-repository-triggers --repository-name MyDemoRepo + +Output:: + + { + "configurationId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + "triggers": [ + { + "destinationArn": "arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic", + "branches": [ + "mainline", + "preprod" + ], + "name": "MyFirstTrigger", + "customData": "", + "events": [ + "all" + ] + }, + { + "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", + "branches": [], + "name": "MySecondTrigger", + "customData": "EXAMPLE", + "events": [ + "all" + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/get-repository.rst b/aws/dist/awscli/examples/codecommit/get-repository.rst new file mode 100644 index 00000000..02a88aa6 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/get-repository.rst @@ -0,0 +1,24 @@ +**To get information about a repository** + +This example shows details about an AWS CodeCommit repository. + +Command:: + + aws codecommit get-repository --repository-name MyDemoRepo + +Output:: + + { + "repositoryMetadata": { + "creationDate": 1429203623.625, + "defaultBranch": "master", + "repositoryName": "MyDemoRepo", + "cloneUrlSsh": "ssh://git-codecommit.us-east-1.amazonaws.com/v1/repos/v1/repos/MyDemoRepo", + "lastModifiedDate": 1430783812.0869999, + "repositoryDescription": "My demonstration repository", + "cloneUrlHttp": "https://codecommit.us-east-1.amazonaws.com/v1/repos/MyDemoRepo", + "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + "Arn": "arn:aws:codecommit:us-east-1:80398EXAMPLE:MyDemoRepo + "accountId": "111111111111" + } + } diff --git a/aws/dist/awscli/examples/codecommit/list-branches.rst b/aws/dist/awscli/examples/codecommit/list-branches.rst new file mode 100644 index 00000000..ed7b2921 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/list-branches.rst @@ -0,0 +1,16 @@ +**To view a list of branch names** + +This example lists all branch names in an AWS CodeCommit repository. + +Command:: + + aws codecommit list-branches --repository-name MyDemoRepo + +Output:: + + { + "branches": [ + "MyNewBranch", + "master" + ] + } diff --git a/aws/dist/awscli/examples/codecommit/list-pull-requests.rst b/aws/dist/awscli/examples/codecommit/list-pull-requests.rst new file mode 100644 index 00000000..314a0c12 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/list-pull-requests.rst @@ -0,0 +1,12 @@ +**To view a list of pull requests in a repository** + +This example demonstrates how to list pull requests created by an IAM user with the ARN 'arn:aws:iam::111111111111:user/Li_Juan' and the status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':: + + aws codecommit list-pull-requests --author-arn arn:aws:iam::111111111111:user/Li_Juan --pull-request-status CLOSED --repository-name MyDemoRepo + +Output:: + + { + "nextToken": "", + "pullRequestIds": ["2","12","16","22","23","35","30","39","47"] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/list-repositories.rst b/aws/dist/awscli/examples/codecommit/list-repositories.rst new file mode 100644 index 00000000..7c37e0c2 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/list-repositories.rst @@ -0,0 +1,22 @@ +**To view a list of repositories** + +This example lists all AWS CodeCommit repositories associated with the user's AWS account. + +Command:: + + aws codecommit list-repositories + +Output:: + + { + "repositories": [ + { + "repositoryName": "MyDemoRepo" + "repositoryId": "f7579e13-b83e-4027-aaef-650c0EXAMPLE", + }, + { + "repositoryName": "MyOtherDemoRepo" + "repositoryId": "cfc29ac4-b0cb-44dc-9990-f6f51EXAMPLE" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/list-tags-for-resource.rst b/aws/dist/awscli/examples/codecommit/list-tags-for-resource.rst new file mode 100644 index 00000000..e1d31595 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/list-tags-for-resource.rst @@ -0,0 +1,18 @@ +**To view the AWS tags for a repository** + +The following ``list-tags-for-resource`` example lists tag keys and tag values for the specified repository. :: + + aws codecommit list-tags-for-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo + +Output:: + + { + "tags": { + "Status": "Secret", + "Team": "Saanvi" + } + } + + +For more information, see `View Tags for a Repository `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/merge-branches-by-fast-forward.rst b/aws/dist/awscli/examples/codecommit/merge-branches-by-fast-forward.rst new file mode 100644 index 00000000..06e051d5 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-branches-by-fast-forward.rst @@ -0,0 +1,17 @@ +**To merge two branches using the fast-forward merge strategy** + +The following ``merge-branches-by-fast-forward`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-fast-forward \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier bugfix-bug1233 \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/merge-branches-by-squash.rst b/aws/dist/awscli/examples/codecommit/merge-branches-by-squash.rst new file mode 100644 index 00000000..8f2a46a0 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-branches-by-squash.rst @@ -0,0 +1,21 @@ +**To merge two branches using the squash merge strategy** + +The following ``merge-branches-by-squash`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-squash \ + --source-commit-specifier bugfix-bug1234 \ + --destination-commit-specifier bugfix-bug1233 \ + --author-name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Merging two fix branches to prepare for a general patch." \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/merge-branches-by-three-way.rst b/aws/dist/awscli/examples/codecommit/merge-branches-by-three-way.rst new file mode 100644 index 00000000..5d458f8f --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-branches-by-three-way.rst @@ -0,0 +1,19 @@ +**To merge two branches using the three-way merge strategy** + +The following ``merge-branches-by-three-way`` example merges the specified source branch with the specified destination branch in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-branches-by-three-way \ + --source-commit-specifier master \ + --destination-commit-specifier bugfix-bug1234 \ + --author-name "Jorge Souza" --email "jorge_souza@example.com" \ + --commit-message "Merging changes from master to bugfix branch before additional testing." \ + --repository-name MyDemoRepo + +Output:: + + { + "commitId": "4f178133EXAMPLE", + "treeId": "389765daEXAMPLE" + } + +For more information, see `Compare and Merge Branches `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst new file mode 100644 index 00000000..aaeee21c --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-fast-forward.rst @@ -0,0 +1,33 @@ +**To merge and close a pull request** + +This example demonstrates how to merge and close a pull request with the ID of '47' and a source commit ID of '99132ab0EXAMPLE' in a repository named 'MyDemoRepo':: + + aws codecommit merge-pull-request-by-fast-forward --pull-request-id 47 --source-commit-id 99132ab0EXAMPLE --repository-name MyDemoRepo + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Mary_Major" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/merge-pull-request-by-squash.rst b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-squash.rst new file mode 100644 index 00000000..190ff986 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-squash.rst @@ -0,0 +1,42 @@ +**To merge a pull request using the squash merge strategy** + +The following ``merge-pull-request-by-squash`` example merges and closes the specified pull request using the conflict resolution strategy of ACCEPT_SOURCE in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-pull-request-by-squash \ + --pull-request-id 47 \ + --source-commit-id 99132ab0EXAMPLE \ + --repository-name MyDemoRepo \ + --conflict-detail-level LINE_LEVEL \ + --conflict-resolution-strategy ACCEPT_SOURCE \ + --name "Jorge Souza" --email "jorge_souza@example.com" \ + --commit-message "Merging pull request 47 by squash and accepting source in merge conflicts" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Jorge_Souza" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } + +For more information, see `Merge a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/merge-pull-request-by-three-way.rst b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-three-way.rst new file mode 100644 index 00000000..4068c98e --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/merge-pull-request-by-three-way.rst @@ -0,0 +1,41 @@ +**To merge a pull request using the three-way merge strategy** + +The following ``merge-pull-request-by-three-way`` example merges and closes the specified pull request using the default options for conflict detail and conflict resolution strategy in a repository named ``MyDemoRepo``. :: + + aws codecommit merge-pull-request-by-three-way \ + --pull-request-id 47 \ + --source-commit-id 99132ab0EXAMPLE \ + --repository-name MyDemoRepo \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "Merging pull request 47 by three-way with default options" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.142, + "description": "Review the latest changes and updates to the global variables", + "lastActivityDate": 1508887223.155, + "pullRequestId": "47", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": true, + "mergedBy": "arn:aws:iam::111111111111:user/Maria_Garcia" + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } + +For more information, see `Merge a Pull Request `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/post-comment-for-compared-commit.rst b/aws/dist/awscli/examples/codecommit/post-comment-for-compared-commit.rst new file mode 100644 index 00000000..faa18574 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/post-comment-for-compared-commit.rst @@ -0,0 +1,30 @@ +**To create a comment on a commit** + +This example demonstrates how to add the comment '"Can you add a test case for this?"' on the change to the 'cl_sample.js' file in the comparison between two commits in a repository named 'MyDemoRepo':: + + aws codecommit post-comment-for-compared-commit --repository-name MyDemoRepo --before-commit-id 317f8570EXAMPLE --after-commit-id 5d036259EXAMPLE --client-request-token 123Example --content "Can you add a test case for this?" --location filePath=cl_sample.js,filePosition=1232,relativeFileVersion=AFTER + +Output:: + + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "317f8570EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "6e147360EXAMPLE", + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "553b509bEXAMPLE56198325", + "content": "Can you add a test case for this?", + "creationDate": 1508369612.203, + "deleted": false, + "commentId": "abc123-EXAMPLE", + "lastModifiedDate": 1508369612.203 + }, + "location": { + "filePath": "cl_sample.js", + "filePosition": 1232, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/post-comment-for-pull-request.rst b/aws/dist/awscli/examples/codecommit/post-comment-for-pull-request.rst new file mode 100644 index 00000000..376cc46e --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/post-comment-for-pull-request.rst @@ -0,0 +1,38 @@ +**To add a comment to a pull request** + +The following ``post-comment-for-pull-request`` example adds the comment "These don't appear to be used anywhere. Can we remove them?" on the change to the ``ahs_count.py`` file in a pull request with the ID of '47' in a repository named 'MyDemoRepo'. :: + + aws codecommit post-comment-for-pull-request \ + --pull-request-id "47" \ + --repository-name MyDemoRepo \ + --before-commit-id 317f8570EXAMPLE \ + --after-commit-id 5d036259EXAMPLE \ + --client-request-token 123Example \ + --content "These don't appear to be used anywhere. Can we remove them?" \ + --location filePath=ahs_count.py,filePosition=367,relativeFileVersion=AFTER + +Output:: + + { + "afterBlobId": "1f330709EXAMPLE", + "afterCommitId": "5d036259EXAMPLE", + "beforeBlobId": "80906a4cEXAMPLE", + "beforeCommitId": "317f8570EXAMPLE", + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Saanvi_Sarkar", + "clientRequestToken": "123Example", + "commentId": "abcd1234EXAMPLEb5678efgh", + "content": "These don't appear to be used anywhere. Can we remove them?", + "creationDate": 1508369622.123, + "deleted": false, + "CommentId": "", + "lastModifiedDate": 1508369622.123 + }, + "location": { + "filePath": "ahs_count.py", + "filePosition": 367, + "relativeFileVersion": "AFTER" + }, + "repositoryName": "MyDemoRepo", + "pullRequestId": "47" + } diff --git a/aws/dist/awscli/examples/codecommit/post-comment-reply.rst b/aws/dist/awscli/examples/codecommit/post-comment-reply.rst new file mode 100644 index 00000000..e4bcf469 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/post-comment-reply.rst @@ -0,0 +1,20 @@ +**To reply to a comment on a commit or in a pull request** + +This example demonstrates how to add the reply '"Good catch. I'll remove them."' to the comment with the system-generated ID of 'abcd1234EXAMPLEb5678efgh':: + + aws codecommit post-comment-reply --in-reply-to abcd1234EXAMPLEb5678efgh --content "Good catch. I'll remove them." --client-request-token 123Example + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "123Example", + "commentId": "442b498bEXAMPLE5756813", + "content": "Good catch. I'll remove them.", + "creationDate": 1508369829.136, + "deleted": false, + "CommentId": "abcd1234EXAMPLEb5678efgh", + "lastModifiedDate": 150836912.221 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/put-file.rst b/aws/dist/awscli/examples/codecommit/put-file.rst new file mode 100644 index 00000000..ff9c8a41 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/put-file.rst @@ -0,0 +1,21 @@ +**To add a file to a repository** + +The following ``put-file`` example adds a file named 'ExampleSolution.py' to a repository named 'MyDemoRepo' to a branch named 'feature-randomizationfeature' whose most recent commit has an ID of '4c925148EXAMPLE'. :: + + aws codecommit put-file \ + --repository-name MyDemoRepo \ + --branch-name feature-randomizationfeature \ + --file-content file://MyDirectory/ExampleSolution.py \ + --file-path /solutions/ExampleSolution.py \ + --parent-commit-id 4c925148EXAMPLE \ + --name "Maria Garcia" \ + --email "maria_garcia@example.com" \ + --commit-message "I added a third randomization routine." + +Output:: + + { + "blobId": "2eb4af3bEXAMPLE", + "commitId": "317f8570EXAMPLE", + "treeId": "347a3408EXAMPLE" + } diff --git a/aws/dist/awscli/examples/codecommit/put-repository-triggers.rst b/aws/dist/awscli/examples/codecommit/put-repository-triggers.rst new file mode 100644 index 00000000..e9ab1cef --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/put-repository-triggers.rst @@ -0,0 +1,42 @@ +**To add or update a trigger in a repository** + +This example demonstrates how to update triggers named 'MyFirstTrigger' and 'MySecondTrigger' using an already-created JSON file (here named MyTriggers.json) that contains the structure of all the triggers for a repository named MyDemoRepo. To learn how to get the JSON for existing triggers, see the get-repository-triggers command. + + +Command:: + + aws codecommit put-repository-triggers --repository-name MyDemoRepo file://MyTriggers.json + + JSON file sample contents: + { + "repositoryName": "MyDemoRepo", + "triggers": [ + { + "destinationArn": "arn:aws:sns:us-east-1:80398EXAMPLE:MyCodeCommitTopic", + "branches": [ + "master", + "preprod" + ], + "name": "MyFirstTrigger", + "customData": "", + "events": [ + "all" + ] + }, + { + "destinationArn": "arn:aws:lambda:us-east-1:111111111111:function:MyCodeCommitPythonFunction", + "branches": [], + "name": "MySecondTrigger", + "customData": "EXAMPLE", + "events": [ + "all" + ] + } + ] + } + +Output:: + + { + "configurationId": "6fa51cd8-35c1-EXAMPLE" + } diff --git a/aws/dist/awscli/examples/codecommit/tag-resource.rst b/aws/dist/awscli/examples/codecommit/tag-resource.rst new file mode 100644 index 00000000..76518a75 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/tag-resource.rst @@ -0,0 +1,11 @@ +**To add AWS tags to an existing repository** + +The following ``tag-resource`` example tags the specified repository with two tags. :: + + aws codecommit tag-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ + --tags Status=Secret,Team=Saanvi + +This command produces no output. + +For more information, see `Add a Tag to a Repository `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/test-repository-triggers.rst b/aws/dist/awscli/examples/codecommit/test-repository-triggers.rst new file mode 100644 index 00000000..b18fd097 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/test-repository-triggers.rst @@ -0,0 +1,18 @@ +**To test triggers in a repository** + +This example demonstrates how to test a trigger named 'MyFirstTrigger' in an AWS CodeCommit repository named MyDemoRepo. In this example, events in the repository trigger notifications +from an Amazon Simple Notification Service (Amazon SNS) topic. + + +Command:: + + aws codecommit test-repository-triggers --repository-name MyDemoRepo --triggers name=MyFirstTrigger,destinationArn=arn:aws:sns:us-east-1:111111111111:MyCodeCommitTopic,branches=mainline,preprod,events=all + +Output:: + + { + "successfulExecutions": [ + "MyFirstTrigger" + ], + "failedExecutions": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/untag-resource.rst b/aws/dist/awscli/examples/codecommit/untag-resource.rst new file mode 100644 index 00000000..0661008e --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove AWS tags from a repository** + +The following ``untag-resource`` example removes the tag with the specified key from the repository named ``MyDemoRepo``. :: + + aws codecommit untag-resource \ + --resource-arn arn:aws:codecommit:us-west-2:111111111111:MyDemoRepo \ + --tag-keys Status + +This command produces no output. + +For more information, see `Remove a Tag from a Repository `__ in the *AWS CodeCommit User Guide*. diff --git a/aws/dist/awscli/examples/codecommit/update-comment.rst b/aws/dist/awscli/examples/codecommit/update-comment.rst new file mode 100644 index 00000000..e0824251 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-comment.rst @@ -0,0 +1,19 @@ +**To update a comment on a commit** + +This example demonstrates how to add the content '"Fixed as requested. I'll update the pull request."' to a comment with an ID of '442b498bEXAMPLE5756813':: + + aws codecommit update-comment --comment-id 442b498bEXAMPLE5756813 --content "Fixed as requested. I'll update the pull request." + +Output:: + + { + "comment": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "commentId": "442b498bEXAMPLE5756813", + "content": "Fixed as requested. I'll update the pull request.", + "creationDate": 1508369929.783, + "deleted": false, + "lastModifiedDate": 1508369929.287 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/update-default-branch.rst b/aws/dist/awscli/examples/codecommit/update-default-branch.rst new file mode 100644 index 00000000..30ba4f5a --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-default-branch.rst @@ -0,0 +1,11 @@ +**To change the default branch for a repository** + +This example changes the default branch for an AWS CodeCommit repository. This command produces output only if there are errors. + +Command:: + + aws codecommit update-default-branch --repository-name MyDemoRepo --default-branch-name MyNewBranch + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/update-pull-request-description.rst b/aws/dist/awscli/examples/codecommit/update-pull-request-description.rst new file mode 100644 index 00000000..7054e705 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-pull-request-description.rst @@ -0,0 +1,32 @@ +**To change the description of a pull request** + +This example demonstrates how to change the description of a pull request with the ID of '47':: + + aws codecommit update-pull-request-description --pull-request-id 47 --description "Updated the pull request to remove unused global variable." + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.155, + "description": "Updated the pull request to remove unused global variable.", + "lastActivityDate": 1508372423.204, + "pullRequestId": "47", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables" + } + } diff --git a/aws/dist/awscli/examples/codecommit/update-pull-request-status.rst b/aws/dist/awscli/examples/codecommit/update-pull-request-status.rst new file mode 100644 index 00000000..0712b03d --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-pull-request-status.rst @@ -0,0 +1,32 @@ +**To change the status of a pull request** + +This example demonstrates how to to change the status of a pull request with the ID of '42' to a status of 'CLOSED' in an AWS CodeCommit repository named 'MyDemoRepo':: + + aws codecommit update-pull-request-status --pull-request-id 42 --pull-request-status CLOSED + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Jane_Doe", + "clientRequestToken": "123Example", + "creationDate": 1508962823.165, + "description": "A code review of the new feature I just added to the service.", + "lastActivityDate": 1508442444.12, + "pullRequestId": "42", + "pullRequestStatus": "CLOSED", + "pullRequestTargets": [ + { + "destinationCommit": "5d036259EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "317f8570EXAMPLE", + "sourceReference": "refs/heads/jane-branch" + } + ], + "title": "Pronunciation difficulty analyzer" + } + } diff --git a/aws/dist/awscli/examples/codecommit/update-pull-request-title.rst b/aws/dist/awscli/examples/codecommit/update-pull-request-title.rst new file mode 100644 index 00000000..677f258c --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-pull-request-title.rst @@ -0,0 +1,32 @@ +**To change the title of a pull request** + +This example demonstrates how to change the title of a pull request with the ID of '47':: + + aws codecommit update-pull-request-title --pull-request-id 47 --title "Consolidation of global variables - updated review" + +Output:: + + { + "pullRequest": { + "authorArn": "arn:aws:iam::111111111111:user/Li_Juan", + "clientRequestToken": "", + "creationDate": 1508530823.12, + "description": "Review the latest changes and updates to the global variables. I have updated this request with some changes, including removing some unused variables.", + "lastActivityDate": 1508372657.188, + "pullRequestId": "47", + "pullRequestStatus": "OPEN", + "pullRequestTargets": [ + { + "destinationCommit": "9f31c968EXAMPLE", + "destinationReference": "refs/heads/master", + "mergeMetadata": { + "isMerged": false, + }, + "repositoryName": "MyDemoRepo", + "sourceCommit": "99132ab0EXAMPLE", + "sourceReference": "refs/heads/variables-branch" + } + ], + "title": "Consolidation of global variables - updated review" + } + } diff --git a/aws/dist/awscli/examples/codecommit/update-repository-description.rst b/aws/dist/awscli/examples/codecommit/update-repository-description.rst new file mode 100644 index 00000000..86cf4193 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-repository-description.rst @@ -0,0 +1,11 @@ +**To change the description for a repository** + +This example changes the description for an AWS CodeCommit repository. This command produces output only if there are errors. + +Command:: + + aws codecommit update-repository-description --repository-name MyDemoRepo --repository-description "This description was changed" + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codecommit/update-repository-name.rst b/aws/dist/awscli/examples/codecommit/update-repository-name.rst new file mode 100644 index 00000000..da174fc9 --- /dev/null +++ b/aws/dist/awscli/examples/codecommit/update-repository-name.rst @@ -0,0 +1,11 @@ +**To change the name of a repository** + +This example changes the name of an AWS CodeCommit repository. This command produces output only if there are errors. Changing the name of the AWS CodeCommit repository will change the SSH and HTTPS URLs that users need to connect to the repository. Users will not be able to connect to this repository until they update their connection settings. Also, because the repository's ARN will change, changing the repository name will invalidate any IAM user policies that rely on this repository's ARN. + +Command:: + + aws codecommit update-repository-name --old-name MyDemoRepo --new-name MyRenamedDemoRepo + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/acknowledge-job.rst b/aws/dist/awscli/examples/codepipeline/acknowledge-job.rst new file mode 100644 index 00000000..15829f77 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/acknowledge-job.rst @@ -0,0 +1,13 @@ +**To retrieve information about a specified job** + +This example returns information about a specified job, including the status of that job if it exists. This is only used for job workers and custom actions. To determine the value of nonce and the job ID, use aws codepipeline poll-for-jobs. + +Command:: + + aws codepipeline acknowledge-job --job-id f4f4ff82-2d11-EXAMPLE --nonce 3 + +Output:: + + { + "status": "InProgress" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/create-custom-action-type.rst b/aws/dist/awscli/examples/codepipeline/create-custom-action-type.rst new file mode 100644 index 00000000..321f7692 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/create-custom-action-type.rst @@ -0,0 +1,38 @@ +**To create a custom action** + +This example creates a custom action for AWS CodePipeline using an already-created JSON file (here named MyCustomAction.json) that contains the structure of the custom action. For more information about the requirements for creating a custom action, including the structure of the file, see the AWS CodePipeline User Guide. :: + + aws codepipeline create-custom-action-type --cli-input-json file://MyCustomAction.json + +Contents of JSON file ``MyCustomAction.json``:: + + { + "category": "Build", + "provider": "MyJenkinsProviderName", + "version": "1", + "settings": { + "entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/", + "executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/lastSuccessfulBuild/{ExternalExecutionId}/" + }, + "configurationProperties": [ + { + "name": "MyJenkinsExampleBuildProject", + "required": true, + "key": true, + "secret": false, + "queryable": false, + "description": "The name of the build project must be provided when this action is added to the pipeline.", + "type": "String" + } + ], + "inputArtifactDetails": { + "maximumCount": 1, + "minimumCount": 0 + }, + "outputArtifactDetails": { + "maximumCount": 1, + "minimumCount": 0 + } + } + +This command returns the structure of the custom action. diff --git a/aws/dist/awscli/examples/codepipeline/create-pipeline.rst b/aws/dist/awscli/examples/codepipeline/create-pipeline.rst new file mode 100644 index 00000000..7c329eb3 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/create-pipeline.rst @@ -0,0 +1,77 @@ +**To create a pipeline** + +This example creates a pipeline in AWS CodePipeline using an already-created JSON file (here named MySecondPipeline.json) that contains the structure of the pipeline. For more information about the requirements for creating a pipeline, including the structure of the file, see the AWS CodePipeline User Guide. + +Command:: + + aws codepipeline create-pipeline --cli-input-json file://MySecondPipeline.json + +JSON file sample contents:: + + { + "pipeline": { + "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", + "stages": [ + { + "name": "Source", + "actions": [ + { + "inputArtifacts": [], + "name": "Source", + "actionTypeId": { + "category": "Source", + "owner": "AWS", + "version": "1", + "provider": "S3" + }, + "outputArtifacts": [ + { + "name": "MyApp" + } + ], + "configuration": { + "S3Bucket": "awscodepipeline-demo-bucket", + "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" + }, + "runOrder": 1 + } + ] + }, + { + "name": "Beta", + "actions": [ + { + "inputArtifacts": [ + { + "name": "MyApp" + } + ], + "name": "CodePipelineDemoFleet", + "actionTypeId": { + "category": "Deploy", + "owner": "AWS", + "version": "1", + "provider": "CodeDeploy" + }, + "outputArtifacts": [], + "configuration": { + "ApplicationName": "CodePipelineDemoApplication", + "DeploymentGroupName": "CodePipelineDemoFleet" + }, + "runOrder": 1 + } + ] + } + ], + "artifactStore": { + "type": "S3", + "location": "codepipeline-us-east-1-11EXAMPLE11" + }, + "name": "MySecondPipeline", + "version": 1 + } + } + +Output:: + + This command returns the structure of the pipeline. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/delete-custom-action-type.rst b/aws/dist/awscli/examples/codepipeline/delete-custom-action-type.rst new file mode 100644 index 00000000..9495009a --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/delete-custom-action-type.rst @@ -0,0 +1,19 @@ +**To delete a custom action** + +This example deletes a custom action in AWS CodePipeline by using an already-created JSON file (here named DeleteMyCustomAction.json) that contains the action type, provider name, and version number of the action to be deleted. Use the list-action-types command to view the correct values for category, version, and provider. + +Command:: + + aws codepipeline delete-custom-action-type --cli-input-json file://DeleteMyCustomAction.json + +JSON file sample contents:: + + { + "category": "Build", + "version": "1", + "provider": "MyJenkinsProviderName" + } + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/delete-pipeline.rst b/aws/dist/awscli/examples/codepipeline/delete-pipeline.rst new file mode 100644 index 00000000..385e4dd2 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/delete-pipeline.rst @@ -0,0 +1,12 @@ +**To delete a pipeline** + +This example deletes a pipeline named MySecondPipeline from AWS CodePipeline. Use the list-pipelines command to view a list of pipelines associated with your AWS account. + +Command:: + + aws codepipeline delete-pipeline --name MySecondPipeline + + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/disable-stage-transition.rst b/aws/dist/awscli/examples/codepipeline/disable-stage-transition.rst new file mode 100644 index 00000000..9a59a9ac --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/disable-stage-transition.rst @@ -0,0 +1,12 @@ +**To disable a transition to a stage in a pipeline** + +This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline. + +Command:: + + aws codepipeline disable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound + + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/enable-stage-transition.rst b/aws/dist/awscli/examples/codepipeline/enable-stage-transition.rst new file mode 100644 index 00000000..43fcbf73 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/enable-stage-transition.rst @@ -0,0 +1,12 @@ +**To enable a transition to a stage in a pipeline** + +This example enables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline. + +Command:: + + aws codepipeline enable-stage-transition --pipeline-name MyFirstPipeline --stage-name Beta --transition-type Inbound + + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/get-job-details.rst b/aws/dist/awscli/examples/codepipeline/get-job-details.rst new file mode 100644 index 00000000..73e60a55 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/get-job-details.rst @@ -0,0 +1,64 @@ +**To get details of a job** + +This example returns details about a job whose ID is represented by f4f4ff82-2d11-EXAMPLE. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if required for the custom action. This command will also return any secret values defined for the action, if any are defined. + +Command:: + + aws codepipeline get-job-details --job-id f4f4ff82-2d11-EXAMPLE + + +Output:: + + { + "jobDetails": { + "accountId": "111111111111", + "data": { + "actionConfiguration": { + "__type": "ActionConfiguration", + "configuration": { + "ProjectName": "MyJenkinsExampleTestProject" + } + }, + "actionTypeId": { + "__type": "ActionTypeId", + "category": "Test", + "owner": "Custom", + "provider": "MyJenkinsProviderName", + "version": "1" + }, + "artifactCredentials": { + "__type": "AWSSessionCredentials", + "accessKeyId": "AKIAIOSFODNN7EXAMPLE", + "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" + }, + "inputArtifacts": [ + { + "__type": "Artifact", + "location": { + "s3Location": { + "bucketName": "codepipeline-us-east-1-11EXAMPLE11", + "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE" + }, + "type": "S3" + }, + "name": "MyAppBuild" + } + ], + "outputArtifacts": [], + "pipelineContext": { + "__type": "PipelineContext", + "action": { + "name": "MyJenkinsTest-Action" + }, + "pipelineName": "MySecondPipeline", + "stage": { + "name": "Testing" + } + } + }, + "id": "f4f4ff82-2d11-EXAMPLE" + } + } + + \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/get-pipeline-state.rst b/aws/dist/awscli/examples/codepipeline/get-pipeline-state.rst new file mode 100644 index 00000000..051b1c66 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/get-pipeline-state.rst @@ -0,0 +1,53 @@ +**To get information about the state of a pipeline** + +This example returns the most recent state of a pipeline named MyFirstPipeline. + +Command:: + + aws codepipeline get-pipeline-state --name MyFirstPipeline + + +Output:: + + { + "created": 1446137312.204, + "pipelineName": "MyFirstPipeline", + "pipelineVersion": 1, + "stageStates": [ + { + "actionStates": [ + { + "actionName": "Source", + "entityUrl": "https://console.aws.amazon.com/s3/home?#", + "latestExecution": { + "lastStatusChange": 1446137358.328, + "status": "Succeeded" + } + } + ], + "stageName": "Source" + }, + { + "actionStates": [ + { + "actionName": "CodePipelineDemoFleet", + "entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet", + "latestExecution": { + "externalExecutionId": "d-EXAMPLE", + "externalExecutionUrl": "https://console.aws.amazon.com/codedeploy/home?#/deployments/d-EXAMPLE", + "lastStatusChange": 1446137493.131, + "status": "Succeeded", + "summary": "Deployment Succeeded" + } + } + ], + "inboundTransitionState": { + "enabled": true + }, + "stageName": "Beta" + } + ], + "updated": 1446137312.204 + } + + \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/get-pipeline.rst b/aws/dist/awscli/examples/codepipeline/get-pipeline.rst new file mode 100644 index 00000000..4a49b3fb --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/get-pipeline.rst @@ -0,0 +1,76 @@ +**To view the structure of a pipeline** + +This example returns the structure of a pipeline named MyFirstPipeline. + +Command:: + + aws codepipeline get-pipeline --name MyFirstPipeline + + +Output:: + + { + "pipeline": { + "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", + "stages": [ + { + "name": "Source", + "actions": [ + { + "inputArtifacts": [], + "name": "Source", + "actionTypeId": { + "category": "Source", + "owner": "AWS", + "version": "1", + "provider": "S3" + }, + "outputArtifacts": [ + { + "name": "MyApp" + } + ], + "configuration": { + "S3Bucket": "awscodepipeline-demo-bucket", + "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" + }, + "runOrder": 1 + } + ] + }, + { + "name": "Beta", + "actions": [ + { + "inputArtifacts": [ + { + "name": "MyApp" + } + ], + "name": "CodePipelineDemoFleet", + "actionTypeId": { + "category": "Deploy", + "owner": "AWS", + "version": "1", + "provider": "CodeDeploy" + }, + "outputArtifacts": [], + "configuration": { + "ApplicationName": "CodePipelineDemoApplication", + "DeploymentGroupName": "CodePipelineDemoFleet" + }, + "runOrder": 1 + } + ] + } + ], + "artifactStore": { + "type": "S3", + "location": "codepipeline-us-east-1-11EXAMPLE11" + }, + "name": "MyFirstPipeline", + "version": 1 + } + } + + \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/list-action-types.rst b/aws/dist/awscli/examples/codepipeline/list-action-types.rst new file mode 100644 index 00000000..bc6e57b0 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/list-action-types.rst @@ -0,0 +1,73 @@ +**To view the action types available** + +Used by itself, the list-action-types command returns the structure of all actions available to your AWS account. This example uses the --action-owner-filter option to return only custom actions. + +Command:: + + aws codepipeline list-action-types --action-owner-filter Custom + + +Output:: + + { + "actionTypes": [ + { + "inputArtifactDetails": { + "maximumCount": 5, + "minimumCount": 0 + }, + "actionConfigurationProperties": [ + { + "secret": false, + "required": true, + "name": "MyJenkinsExampleBuildProject", + "key": true, + "queryable": true + } + ], + "outputArtifactDetails": { + "maximumCount": 5, + "minimumCount": 0 + }, + "id": { + "category": "Build", + "owner": "Custom", + "version": "1", + "provider": "MyJenkinsProviderName" + }, + "settings": { + "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", + "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}" + } + }, + { + "inputArtifactDetails": { + "maximumCount": 5, + "minimumCount": 0 + }, + "actionConfigurationProperties": [ + { + "secret": false, + "required": true, + "name": "MyJenkinsExampleTestProject", + "key": true, + "queryable": true + } + ], + "outputArtifactDetails": { + "maximumCount": 5, + "minimumCount": 0 + }, + "id": { + "category": "Test", + "owner": "Custom", + "version": "1", + "provider": "MyJenkinsProviderName" + }, + "settings": { + "entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}", + "executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/{ExternalExecutionId}" + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/list-pipelines.rst b/aws/dist/awscli/examples/codepipeline/list-pipelines.rst new file mode 100644 index 00000000..1f24d7c7 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/list-pipelines.rst @@ -0,0 +1,26 @@ +**To view a list of pipelines** + +This example lists all AWS CodePipeline pipelines associated with the user's AWS account. + +Command:: + + aws codepipeline list-pipelines + +Output:: + + { + "pipelines": [ + { + "updated": 1439504274.641, + "version": 1, + "name": "MyFirstPipeline", + "created": 1439504274.641 + }, + { + "updated": 1436461837.992, + "version": 2, + "name": "MySecondPipeline", + "created": 1436460801.381 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/poll-for-jobs.rst b/aws/dist/awscli/examples/codepipeline/poll-for-jobs.rst new file mode 100644 index 00000000..21736506 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/poll-for-jobs.rst @@ -0,0 +1,79 @@ +**To view any available jobs** + +This example returns information about any jobs for a job worker to act upon. This example uses a pre-defined JSON file (MyActionTypeInfo.json) to supply information about the action type for which the job worker processes jobs. This command is only used for custom actions. When this command is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline. This command will also return any secret values defined for the action, if any are defined. + +Command:: + + aws codepipeline poll-for-jobs --cli-input-json file://MyActionTypeInfo.json + +JSON file sample contents:: + + { + "actionTypeId": { + "category": "Test", + "owner": "Custom", + "provider": "MyJenkinsProviderName", + "version": "1" + }, + "maxBatchSize": 5, + "queryParam": { + "ProjectName": "MyJenkinsTestProject" + } + } + +Output:: + + { + "jobs": [ + { + "accountId": "111111111111", + "data": { + "actionConfiguration": { + "__type": "ActionConfiguration", + "configuration": { + "ProjectName": "MyJenkinsExampleTestProject" + } + }, + "actionTypeId": { + "__type": "ActionTypeId", + "category": "Test", + "owner": "Custom", + "provider": "MyJenkinsProviderName", + "version": "1" + }, + "artifactCredentials": { + "__type": "AWSSessionCredentials", + "accessKeyId": "AKIAIOSFODNN7EXAMPLE", + "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + "sessionToken": "fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTbNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=" + }, + "inputArtifacts": [ + { + "__type": "Artifact", + "location": { + "s3Location": { + "bucketName": "codepipeline-us-east-1-11EXAMPLE11", + "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE" + }, + "type": "S3" + }, + "name": "MyAppBuild" + } + ], + "outputArtifacts": [], + "pipelineContext": { + "__type": "PipelineContext", + "action": { + "name": "MyJenkinsTest-Action" + }, + "pipelineName": "MySecondPipeline", + "stage": { + "name": "Testing" + } + } + }, + "id": "ef66c259-64f9-EXAMPLE", + "nonce": "3" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/start-pipeline-execution.rst b/aws/dist/awscli/examples/codepipeline/start-pipeline-execution.rst new file mode 100644 index 00000000..036dddc5 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/start-pipeline-execution.rst @@ -0,0 +1,14 @@ +**To run the latest revision through a pipeline** + +This example runs the latest revision present in the source stage of a pipeline through the pipeline named "MyFirstPipeline". + +Command:: + + aws codepipeline start-pipeline-execution --name MyFirstPipeline + + +Output:: + + { + "pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/codepipeline/update-pipeline.rst b/aws/dist/awscli/examples/codepipeline/update-pipeline.rst new file mode 100644 index 00000000..e4af5f69 --- /dev/null +++ b/aws/dist/awscli/examples/codepipeline/update-pipeline.rst @@ -0,0 +1,147 @@ +**To update the structure of a pipeline** + +This example uses the update-pipeline command with the --cli-input-json argument. This example uses a pre-defined JSON file (MyFirstPipeline.json) to update the structure of a pipeline. AWS CodePipeline recognizes the pipeline name contained in the JSON file, and then applies any changes from modified fields in the pipeline structure to update the pipeline. + +Use the following guidelines when creating the pre-defined JSON file: + +- If you are working with a pipeline structure retrieved using the get-pipeline command, you must remove the metadata section from the pipeline structure in the JSON file (the "metadata": { } lines and the "created," "pipelineARN," and "updated" fields within). +- The pipeline name cannot be changed. + +Command:: + + aws codepipeline update-pipeline --cli-input-json file://MyFirstPipeline.json + +Sample JSON file contents:: + + { + "pipeline": { + "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", + "stages": [ + { + "name": "Source", + "actions": [ + { + "inputArtifacts": [], + "name": "Source", + "actionTypeId": { + "category": "Source", + "owner": "AWS", + "version": "1", + "provider": "S3" + }, + "outputArtifacts": [ + { + "name": "MyApp" + } + ], + "configuration": { + "S3Bucket": "awscodepipeline-demo-bucket2", + "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" + }, + "runOrder": 1 + } + ] + }, + { + "name": "Beta", + "actions": [ + { + "inputArtifacts": [ + { + "name": "MyApp" + } + ], + "name": "CodePipelineDemoFleet", + "actionTypeId": { + "category": "Deploy", + "owner": "AWS", + "version": "1", + "provider": "CodeDeploy" + }, + "outputArtifacts": [], + "configuration": { + "ApplicationName": "CodePipelineDemoApplication", + "DeploymentGroupName": "CodePipelineDemoFleet" + }, + "runOrder": 1 + } + ] + } + ], + "artifactStore": { + "type": "S3", + "location": "codepipeline-us-east-1-11EXAMPLE11" + }, + "name": "MyFirstPipeline", + "version": 1 + } + } + + +Output:: + + { + "pipeline": { + "artifactStore": { + "location": "codepipeline-us-east-1-11EXAMPLE11", + "type": "S3" + }, + "name": "MyFirstPipeline", + "roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", + "stages": [ + { + "actions": [ + { + "actionTypeId": { + "__type": "ActionTypeId", + "category": "Source", + "owner": "AWS", + "provider": "S3", + "version": "1" + }, + "configuration": { + "S3Bucket": "awscodepipeline-demo-bucket2", + "S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip" + }, + "inputArtifacts": [], + "name": "Source", + "outputArtifacts": [ + { + "name": "MyApp" + } + ], + "runOrder": 1 + } + ], + "name": "Source" + }, + { + "actions": [ + { + "actionTypeId": { + "__type": "ActionTypeId", + "category": "Deploy", + "owner": "AWS", + "provider": "CodeDeploy", + "version": "1" + }, + "configuration": { + "ApplicationName": "CodePipelineDemoApplication", + "DeploymentGroupName": "CodePipelineDemoFleet" + }, + "inputArtifacts": [ + { + "name": "MyApp" + } + ], + "name": "CodePipelineDemoFleet", + "outputArtifacts": [], + "runOrder": 1 + } + ], + "name": "Beta" + } + ], + "version": 3 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-identity/create-identity-pool.rst b/aws/dist/awscli/examples/cognito-identity/create-identity-pool.rst new file mode 100644 index 00000000..2cf19bf8 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/create-identity-pool.rst @@ -0,0 +1,24 @@ +**To create an identity pool with Cognito identity pool provider** + +This example creates an identity pool named MyIdentityPool. It has a Cognito identity pool provider. +Unauthenticated identities are not allowed. + +Command:: + + aws cognito-identity create-identity-pool --identity-pool-name MyIdentityPool --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_aaaaaaaaa",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } + diff --git a/aws/dist/awscli/examples/cognito-identity/delete-identities.rst b/aws/dist/awscli/examples/cognito-identity/delete-identities.rst new file mode 100644 index 00000000..d3f0b0af --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/delete-identities.rst @@ -0,0 +1,13 @@ +**To delete identity pool** + +This example deletes an identity ppol. + +Command:: + + aws cognito-identity delete-identity-pool --identity-ids-to-delete "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "UnprocessedIdentityIds": [] + } diff --git a/aws/dist/awscli/examples/cognito-identity/delete-identity-pool.rst b/aws/dist/awscli/examples/cognito-identity/delete-identity-pool.rst new file mode 100644 index 00000000..b9922429 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/delete-identity-pool.rst @@ -0,0 +1,10 @@ +**To delete identity pool** + +The following ``delete-identity-pool`` example deletes the specified identity pool. + +Command:: + + aws cognito-identity delete-identity-pool \ + --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +This command produces no output. diff --git a/aws/dist/awscli/examples/cognito-identity/describe-identity-pool.rst b/aws/dist/awscli/examples/cognito-identity/describe-identity-pool.rst new file mode 100644 index 00000000..2f96b4dc --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/describe-identity-pool.rst @@ -0,0 +1,22 @@ +**To describe an identity pool** + +This example describes an identity pool. + +Command:: + + aws cognito-identity describe-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } diff --git a/aws/dist/awscli/examples/cognito-identity/get-identity-pool-roles.rst b/aws/dist/awscli/examples/cognito-identity/get-identity-pool-roles.rst new file mode 100644 index 00000000..0f8b1887 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/get-identity-pool-roles.rst @@ -0,0 +1,17 @@ +**To get identity pool roles** + +This example gets identity pool roles. + +Command:: + + aws cognito-identity get-identity-pool-roles --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "Roles": { + "authenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role", + "unauthenticated": "arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolUnauth_Role" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-identity/list-identity-pools.rst b/aws/dist/awscli/examples/cognito-identity/list-identity-pools.rst new file mode 100644 index 00000000..d99a531c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/list-identity-pools.rst @@ -0,0 +1,26 @@ +**To list identity pools** + +This example lists identity pools. There s a maximum of 20 identities listed. + +Command:: + + aws cognito-identity list-identity-pools --max-results 20 + +Output:: + + { + "IdentityPools": [ + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool" + }, + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "AnotherIdentityPool" + }, + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "IdentityPoolRegionA" + } + ] + } diff --git a/aws/dist/awscli/examples/cognito-identity/set-identity-pool-roles.rst b/aws/dist/awscli/examples/cognito-identity/set-identity-pool-roles.rst new file mode 100644 index 00000000..e4a6fce9 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/set-identity-pool-roles.rst @@ -0,0 +1,7 @@ +**To get identity pool roles** + +The following ``set-identity-pool-roles`` example sets an identity pool role. :: + + aws cognito-identity set-identity-pool-roles \ + --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" \ + --roles authenticated="arn:aws:iam::111111111111:role/Cognito_MyIdentityPoolAuth_Role" diff --git a/aws/dist/awscli/examples/cognito-identity/update-identity-pool.rst b/aws/dist/awscli/examples/cognito-identity/update-identity-pool.rst new file mode 100644 index 00000000..2ac50616 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-identity/update-identity-pool.rst @@ -0,0 +1,23 @@ +**To update an identity pool** + +This example updates an identity pool. It sets the name to MyIdentityPool. It adds Cognito as an identity provider. +It disallows unauthenticated identities. + +Command:: + + aws cognito-identity update-identity-pool --identity-pool-id "us-west-2:11111111-1111-1111-1111-111111111111" --identity-pool-name "MyIdentityPool" --no-allow-unauthenticated-identities --cognito-identity-providers ProviderName="cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111",ClientId="3n4b5urk1ft4fl3mg5e62d9ado",ServerSideTokenCheck=false + +Output:: + + { + "IdentityPoolId": "us-west-2:11111111-1111-1111-1111-111111111111", + "IdentityPoolName": "MyIdentityPool", + "AllowUnauthenticatedIdentities": false, + "CognitoIdentityProviders": [ + { + "ProviderName": "cognito-idp.us-west-2.amazonaws.com/us-west-2_111111111", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "ServerSideTokenCheck": false + } + ] + } diff --git a/aws/dist/awscli/examples/cognito-idp/add-custom-attributes.rst b/aws/dist/awscli/examples/cognito-idp/add-custom-attributes.rst new file mode 100644 index 00000000..923612c4 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/add-custom-attributes.rst @@ -0,0 +1,8 @@ +**To add a custom attribute** + +This example adds a custom attribute CustomAttr1 to a user pool. It is a String type, +and requires a minimum of 1 character and a maximum of 15. It is not required. + +Command:: + + aws cognito-idp add-custom-attributes --user-pool-id us-west-2_aaaaaaaaa --custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}" diff --git a/aws/dist/awscli/examples/cognito-idp/admim-disable-user.rst b/aws/dist/awscli/examples/cognito-idp/admim-disable-user.rst new file mode 100644 index 00000000..57e8ec36 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admim-disable-user.rst @@ -0,0 +1,8 @@ +**To disable a user** + +This example disables user jane@example.com. + +Command:: + + aws cognito-idp admin-disable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/admim-enable-user.rst b/aws/dist/awscli/examples/cognito-idp/admim-enable-user.rst new file mode 100644 index 00000000..79bc468e --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admim-enable-user.rst @@ -0,0 +1,8 @@ +**To enable a user** + +This example enables username jane@example.com. + +Command:: + + aws cognito-idp admin-enable-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-add-user-to-group.rst b/aws/dist/awscli/examples/cognito-idp/admin-add-user-to-group.rst new file mode 100644 index 00000000..6fa23ad3 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-add-user-to-group.rst @@ -0,0 +1,8 @@ +**To add a user to a group** + +This example adds user Jane to group MyGroup. + +Command:: + + aws cognito-idp admin-add-user-to-group --user-pool-id us-west-2_aaaaaaaaa --username Jane --group-name MyGroup + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-confirm-sign-up.rst b/aws/dist/awscli/examples/cognito-idp/admin-confirm-sign-up.rst new file mode 100644 index 00000000..dd0bb917 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-confirm-sign-up.rst @@ -0,0 +1,8 @@ +**To confirm user registration** + +This example confirms user jane@example.com. + +Command:: + + aws cognito-idp admin-confirm-sign-up --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-create-user.rst b/aws/dist/awscli/examples/cognito-idp/admin-create-user.rst new file mode 100644 index 00000000..1e069050 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-create-user.rst @@ -0,0 +1,35 @@ +**To create a user** + +This example creates username diego@example.com. An email address and phone number +are specified. + +Command:: + + aws cognito-idp admin-create-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes=Name=email,Value=kermit2@somewhere.com,Name=phone_number,Value="+15555551212" --message-action SUPPRESS + +Output:: + + { + "User": { + "Username": "7325c1de-b05b-4f84-b321-9adc6e61f4a2", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548099495.428, + "UserLastModifiedDate": 1548099495.428, + "Attributes": [ + { + "Name": "sub", + "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" + }, + { + "Name": "phone_number", + "Value": "+15555551212" + }, + { + "Name": "email", + "Value": "diego@example.com" + } + ] + } + } + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-delete-user-attributes.rst b/aws/dist/awscli/examples/cognito-idp/admin-delete-user-attributes.rst new file mode 100644 index 00000000..d96fb176 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-delete-user-attributes.rst @@ -0,0 +1,8 @@ +**To delete a user attribute** + +This example deletes a custom attribute CustomAttr1 for user diego@example.com. + +Command:: + + aws cognito-idp admin-delete-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attribute-names "custom:CustomAttr1" + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-delete-user.rst b/aws/dist/awscli/examples/cognito-idp/admin-delete-user.rst new file mode 100644 index 00000000..ac0bbb36 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-delete-user.rst @@ -0,0 +1,8 @@ +**To delete a user** + +This example deletes a user. + +Command:: + + aws cognito-idp admin-delete-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-forget-device.rst b/aws/dist/awscli/examples/cognito-idp/admin-forget-device.rst new file mode 100644 index 00000000..f23c77d7 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-forget-device.rst @@ -0,0 +1,8 @@ +**To forget a device** + +This example forgets device for username jane@example.com + +Command:: + + aws cognito-idp admin-forget-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678 + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-get-device.rst b/aws/dist/awscli/examples/cognito-idp/admin-get-device.rst new file mode 100644 index 00000000..92fff255 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-get-device.rst @@ -0,0 +1,8 @@ +**To get a device** + +This example gets a device for username jane@example.com + +Command:: + + aws cognito-idp admin-get-device --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --device-key us-west-2_abcd_1234-5678 + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-get-user.rst b/aws/dist/awscli/examples/cognito-idp/admin-get-user.rst new file mode 100644 index 00000000..3de46a14 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-get-user.rst @@ -0,0 +1,39 @@ +**To get a user** + +This example gets information about username jane@example.com. + +Command:: + + aws cognito-idp admin-get-user --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com + +Output:: + + { + "Username": "4320de44-2322-4620-999b-5e2e1c8df013", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548108509.537, + "UserAttributes": [ + { + "Name": "sub", + "Value": "4320de44-2322-4620-999b-5e2e1c8df013" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "phone_number_verified", + "Value": "true" + }, + { + "Name": "phone_number", + "Value": "+01115551212" + }, + { + "Name": "email", + "Value": "jane@example.com" + } + ], + "UserLastModifiedDate": 1548108509.537 + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/admin-initiate-auth.rst b/aws/dist/awscli/examples/cognito-idp/admin-initiate-auth.rst new file mode 100644 index 00000000..bdb01054 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-initiate-auth.rst @@ -0,0 +1,25 @@ +**To initiate authorization** + +This example initiates authorization using the ADMIN_NO_SRP_AUTH flow for username jane@example.com + +The client must have sign-in API for server-based authentication (ADMIN_NO_SRP_AUTH) enabled. + +Use the session information in the return value to call `admin-respond-to-auth-challenge`_. + +Command:: + + aws cognito-idp admin-initiate-auth --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --auth-flow ADMIN_NO_SRP_AUTH --auth-parameters USERNAME=jane@example.com,PASSWORD=password + +Output:: + + { + "ChallengeName": "NEW_PASSWORD_REQUIRED", + "Session": "SESSION", + "ChallengeParameters": { + "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894", + "requiredAttributes": "[]", + "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}" + } + } + +.. _`admin-respond-to-auth-challenge`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/admin-respond-to-auth-challenge.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/admin-list-devices.rst b/aws/dist/awscli/examples/cognito-idp/admin-list-devices.rst new file mode 100644 index 00000000..2b710876 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-list-devices.rst @@ -0,0 +1,7 @@ +**To list devices for a user** + +This example lists devices for username jane@example.com. + +Command:: + + aws cognito-idp admin-list-devices --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com diff --git a/aws/dist/awscli/examples/cognito-idp/admin-list-groups-for-user.rst b/aws/dist/awscli/examples/cognito-idp/admin-list-groups-for-user.rst new file mode 100644 index 00000000..aa213497 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-list-groups-for-user.rst @@ -0,0 +1,23 @@ +**To list groups for a user** + +This example lists groups for username jane@example.com. + +Command:: + + aws cognito-idp admin-list-groups-for-user --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + +Output:: + + { + "Groups": [ + { + "Description": "Sample group", + "Precedence": 1, + "LastModifiedDate": 1548097827.125, + "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", + "GroupName": "SampleGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "CreationDate": 1548097827.125 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/admin-list-user-auth-events.rst b/aws/dist/awscli/examples/cognito-idp/admin-list-user-auth-events.rst new file mode 100644 index 00000000..eeff1edb --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-list-user-auth-events.rst @@ -0,0 +1,8 @@ +**To list authorization events for a user** + +This example lists authorization events for username diego@example.com. + +Command:: + + aws cognito-idp admin-list-user-auth-events --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-remove-user-from-group.rst b/aws/dist/awscli/examples/cognito-idp/admin-remove-user-from-group.rst new file mode 100644 index 00000000..4f41bf8b --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-remove-user-from-group.rst @@ -0,0 +1,7 @@ +**To remove a user from a group** + +This example removes jane@example.com from SampleGroup. + +Command:: + + aws cognito-idp admin-remove-user-from-group --user-pool-id us-west-2_aaaaaaaaa --username jane@example.com --group-name SampleGroup diff --git a/aws/dist/awscli/examples/cognito-idp/admin-reset-user-password.rst b/aws/dist/awscli/examples/cognito-idp/admin-reset-user-password.rst new file mode 100644 index 00000000..7732c674 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-reset-user-password.rst @@ -0,0 +1,7 @@ +**To reset a user password** + +This example resets the password for diego@example.com. + +Command:: + + aws cognito-idp admin-reset-user-password --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com diff --git a/aws/dist/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst b/aws/dist/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst new file mode 100644 index 00000000..7cbd28c4 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-set-user-mfa-preference.rst @@ -0,0 +1,8 @@ +**To set the user MFA preference** + +This example sets the SMS MFA preference for username diego@example.com. + +Command:: + + aws cognito-idp admin-set-user-mfa-preference --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --sms-mfa-settings Enabled=false,PreferredMfa=false + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-set-user-settings.rst b/aws/dist/awscli/examples/cognito-idp/admin-set-user-settings.rst new file mode 100644 index 00000000..d5d7d7a3 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-set-user-settings.rst @@ -0,0 +1,8 @@ +**To set user settings** + +This example sets the MFA delivery preference for username diego@example.com to EMAIL. + +Command:: + + aws cognito-idp admin-set-user-settings --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --mfa-options DeliveryMedium=EMAIL + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst b/aws/dist/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst new file mode 100644 index 00000000..06065188 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-update-auth-event-feedback.rst @@ -0,0 +1,8 @@ +**To provide feedback for an authorization event** + +This example sets the feedback value for an authorization event identified by event-id to Valid. + +Command:: + + aws cognito-idp admin-update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id c2c2cf89-c0d3-482d-aba6-99d78a5b0bfe --feedback-value Valid + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-update-device-status.rst b/aws/dist/awscli/examples/cognito-idp/admin-update-device-status.rst new file mode 100644 index 00000000..7c009b69 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-update-device-status.rst @@ -0,0 +1,8 @@ +**To update device status** + +This example sets the device remembered status for the device identified by device-key to not_remembered. + +Command:: + + aws cognito-idp admin-update-device-status --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --device-key xxxx --device-remembered-status not_remembered + diff --git a/aws/dist/awscli/examples/cognito-idp/admin-update-user-attributes.rst b/aws/dist/awscli/examples/cognito-idp/admin-update-user-attributes.rst new file mode 100644 index 00000000..f077605a --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/admin-update-user-attributes.rst @@ -0,0 +1,8 @@ +**To update user attributes** + +This example updates a custom user attribute CustomAttr1 for user diego@example.com. + +Command:: + + aws cognito-idp admin-update-user-attributes --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --user-attributes Name="custom:CustomAttr1",Value="Purple" + diff --git a/aws/dist/awscli/examples/cognito-idp/change-password.rst b/aws/dist/awscli/examples/cognito-idp/change-password.rst new file mode 100644 index 00000000..7c787e75 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/change-password.rst @@ -0,0 +1,7 @@ +**To change a password** + +This example changes a password. + +Command:: + + aws cognito-idp change-password --previous-password OldPassword --proposed-password NewPassword --access-token ACCESS_TOKEN diff --git a/aws/dist/awscli/examples/cognito-idp/confirm-forgot-password.rst b/aws/dist/awscli/examples/cognito-idp/confirm-forgot-password.rst new file mode 100644 index 00000000..93d8e717 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/confirm-forgot-password.rst @@ -0,0 +1,8 @@ +**To confirm a forgotten password** + +This example confirms a forgotten password for username diego@example.com. + +Command:: + + aws cognito-idp confirm-forgot-password --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --password PASSWORD --confirmation-code CONF_CODE + diff --git a/aws/dist/awscli/examples/cognito-idp/confirm-sign-up.rst b/aws/dist/awscli/examples/cognito-idp/confirm-sign-up.rst new file mode 100644 index 00000000..08efe9fe --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/confirm-sign-up.rst @@ -0,0 +1,8 @@ +**To confirm sign-up** + +This example confirms sign-up for username diego@example.com. + +Command:: + + aws cognito-idp confirm-sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username=diego@example.com --confirmation-code CONF_CODE + \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/create-group.rst b/aws/dist/awscli/examples/cognito-idp/create-group.rst new file mode 100644 index 00000000..35e5c6ea --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/create-group.rst @@ -0,0 +1,41 @@ +**To create a group** + +This example creates a group with a description. + +Command:: + + aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroup --description "New group." + +Output:: + + { + "Group": { + "GroupName": "MyNewGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New group.", + "LastModifiedDate": 1548270073.795, + "CreationDate": 1548270073.795 + } + } + +**To create a group with a role and precedence** + +This example creates a group with a description. It also includes a role and precedence. + +Command:: + + aws cognito-idp create-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyNewGroupWithRole --description "New group with a role." --role-arn arn:aws:iam::111111111111:role/MyNewGroupRole --precedence 2 + +Output:: + + { + "Group": { + "GroupName": "MyNewGroupWithRole", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New group with a role.", + "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", + "Precedence": 2, + "LastModifiedDate": 1548270211.761, + "CreationDate": 1548270211.761 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/create-user-import-job.rst b/aws/dist/awscli/examples/cognito-idp/create-user-import-job.rst new file mode 100644 index 00000000..46e66def --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/create-user-import-job.rst @@ -0,0 +1,35 @@ +**To create a user import job** + +This example creates a user import job named MyImportJob. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp create-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-name MyImportJob --cloud-watch-logs-role-arn arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole + +Output:: + + { + "UserImportJob": { + "JobName": "MyImportJob", + "JobId": "import-qQ0DCt2fRh", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271795.471, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +Upload the .csv file with curl using the pre-signed URL: + +Command:: + + curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL" + + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/create-user-pool-client.rst b/aws/dist/awscli/examples/cognito-idp/create-user-pool-client.rst new file mode 100644 index 00000000..3d9129ae --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/create-user-pool-client.rst @@ -0,0 +1,26 @@ +**To create a user pool client** + +This example creates a new user pool client with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH. + +Command:: + + aws cognito-idp create-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-name MyNewClient --no-generate-secret --explicit-auth-flows "USER_PASSWORD_AUTH" "ADMIN_NO_SRP_AUTH" + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "MyNewClient", + "ClientId": "6p3bs000no6a4ue1idruvd05ad", + "LastModifiedDate": 1548697449.497, + "CreationDate": 1548697449.497, + "RefreshTokenValidity": 30, + "ExplicitAuthFlows": [ + "USER_PASSWORD_AUTH", + "ADMIN_NO_SRP_AUTH" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } + diff --git a/aws/dist/awscli/examples/cognito-idp/create-user-pool-domain.rst b/aws/dist/awscli/examples/cognito-idp/create-user-pool-domain.rst new file mode 100644 index 00000000..77e6185c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/create-user-pool-domain.rst @@ -0,0 +1,8 @@ +**To create a user pool domain** + +This example creates a new user pool domain. with two explicit authorization flows: USER_PASSWORD_AUTH and ADMIN_NO_SRP_AUTH. + +Command:: + + aws cognito-idp create-user-pool-domain --user-pool-id us-west-2_aaaaaaaaa --domain my-new-domain + diff --git a/aws/dist/awscli/examples/cognito-idp/create-user-pool.rst b/aws/dist/awscli/examples/cognito-idp/create-user-pool.rst new file mode 100644 index 00000000..ce41f20c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/create-user-pool.rst @@ -0,0 +1,506 @@ +**To create a minimally configured user pool** + +This example creates a user pool named MyUserPool using default values. There are no required attributes +and no application clients. MFA and advanced security is disabled. + +Command:: + + aws cognito-idp create-user-pool --pool-name MyUserPool + +Output:: + + { + "UserPool": { + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "LastModifiedDate": 1547833345.777, + "AdminCreateUserConfig": { + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": {}, + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "CreationDate": 1547833345.777, + "EstimatedNumberOfUsers": 0, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } + +**To create a user pool with two required attributes** + +This example creates a user pool MyUserPool. The pool is configured to accept +email as a username attribute. It also sets the email source address to a +validated address using Amazon Simple Email Service. + +Command:: + + aws cognito-idp create-user-pool --pool-name MyUserPool --username-attributes "email" --email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com" + +Output:: + + { + "UserPool": { + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "LastModifiedDate": 1547837788.189, + "AdminCreateUserConfig": { + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": { + "ReplyToEmailAddress": "jane@example.com", + "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" + }, + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "UsernameAttributes": [ + "email" + ], + "CreationDate": 1547837788.189, + "EstimatedNumberOfUsers": 0, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } diff --git a/aws/dist/awscli/examples/cognito-idp/delete-group.rst b/aws/dist/awscli/examples/cognito-idp/delete-group.rst new file mode 100644 index 00000000..9b6d2911 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-group.rst @@ -0,0 +1,8 @@ +**To delete a group** + +This example deletes a group. + +Command:: + + aws cognito-idp delete-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroupName + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-identity-provider.rst b/aws/dist/awscli/examples/cognito-idp/delete-identity-provider.rst new file mode 100644 index 00000000..dd0d3383 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-identity-provider.rst @@ -0,0 +1,8 @@ +**To delete an identity provider** + +This example deletes an identity provider. + +Command:: + + aws cognito-idp delete-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-resource-server.rst b/aws/dist/awscli/examples/cognito-idp/delete-resource-server.rst new file mode 100644 index 00000000..5498f504 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-resource-server.rst @@ -0,0 +1,8 @@ +**To delete a resource server** + +This example deletes a resource server named weather.example.com. + +Command:: + + aws cognito-idp delete-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-user-attributes.rst b/aws/dist/awscli/examples/cognito-idp/delete-user-attributes.rst new file mode 100644 index 00000000..3856abc4 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-user-attributes.rst @@ -0,0 +1,8 @@ +**To delete user attributes** + +This example deletes the user attribute "FAVORITE_ANIMAL". + +Command:: + + aws cognito-idp delete-user-attributes --access-token ACCESS_TOKEN --user-attribute-names "FAVORITE_ANIMAL" + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-user-pool-client.rst b/aws/dist/awscli/examples/cognito-idp/delete-user-pool-client.rst new file mode 100644 index 00000000..331dab5b --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-user-pool-client.rst @@ -0,0 +1,8 @@ +**To delete a user pool client** + +This example deletes a user pool client. + +Command:: + + aws cognito-idp delete-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-user-pool-domain.rst b/aws/dist/awscli/examples/cognito-idp/delete-user-pool-domain.rst new file mode 100644 index 00000000..8260b907 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-user-pool-domain.rst @@ -0,0 +1,7 @@ +**To delete a user pool domain** + +The following ``delete-user-pool-domain`` example deletes a user pool domain named ``my-domain`` :: + + aws cognito-idp delete-user-pool \ + --user-pool-id us-west-2_aaaaaaaaa \ + --domain my-domain diff --git a/aws/dist/awscli/examples/cognito-idp/delete-user-pool.rst b/aws/dist/awscli/examples/cognito-idp/delete-user-pool.rst new file mode 100644 index 00000000..c66dcf35 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-user-pool.rst @@ -0,0 +1,8 @@ +**To delete a user pool** + +This example deletes a user pool using the user pool id, us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp delete-user-pool --user-pool-id us-west-2_aaaaaaaaa + diff --git a/aws/dist/awscli/examples/cognito-idp/delete-user.rst b/aws/dist/awscli/examples/cognito-idp/delete-user.rst new file mode 100644 index 00000000..d00d5cb3 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/delete-user.rst @@ -0,0 +1,8 @@ +**To delete a user** + +This example deletes a user. + +Command:: + + aws cognito-idp delete-user --access-token ACCESS_TOKEN + diff --git a/aws/dist/awscli/examples/cognito-idp/describe-identity-provider.rst b/aws/dist/awscli/examples/cognito-idp/describe-identity-provider.rst new file mode 100644 index 00000000..21f5d94e --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-identity-provider.rst @@ -0,0 +1,33 @@ +**To describe an identity provider** + +This example describes an identity provider named Facebook. + +Command:: + + aws cognito-idp describe-identity-provider --user-pool-id us-west-2_aaaaaaaaa --provider-name Facebook + +Output:: + + { + "IdentityProvider": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ProviderName": "Facebook", + "ProviderType": "Facebook", + "ProviderDetails": { + "attributes_url": "https://graph.facebook.com/me?fields=", + "attributes_url_add_attributes": "true", + "authorize_scopes": myscope", + "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", + "client_id": "11111", + "client_secret": "11111", + "token_request_method": "GET", + "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" + }, + "AttributeMapping": { + "username": "id" + }, + "IdpIdentifiers": [], + "LastModifiedDate": 1548105901.736, + "CreationDate": 1548105901.736 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/describe-resource-server.rst b/aws/dist/awscli/examples/cognito-idp/describe-resource-server.rst new file mode 100644 index 00000000..e9af34b6 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-resource-server.rst @@ -0,0 +1,32 @@ +**To describe a resource server** + +This example describes the resource server weather.example.com. + +Command:: + + aws cognito-idp describe-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com + +Output:: + + { + "ResourceServer": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "Identifier": "weather.example.com", + "Name": "Weather", + "Scopes": [ + { + "ScopeName": "weather.update", + "ScopeDescription": "Update weather forecast" + }, + { + "ScopeName": "weather.read", + "ScopeDescription": "Read weather forecasts" + }, + { + "ScopeName": "weather.delete", + "ScopeDescription": "Delete a weather forecast" + } + ] + } + } + diff --git a/aws/dist/awscli/examples/cognito-idp/describe-risk-configuration.rst b/aws/dist/awscli/examples/cognito-idp/describe-risk-configuration.rst new file mode 100644 index 00000000..c1bb7d2c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-risk-configuration.rst @@ -0,0 +1,61 @@ +**To describe a risk configuration** + +This example describes the risk configuration associated with pool us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp describe-risk-configuration --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "RiskConfiguration": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CompromisedCredentialsRiskConfiguration": { + "EventFilter": [ + "SIGN_IN", + "SIGN_UP", + "PASSWORD_CHANGE" + ], + "Actions": { + "EventAction": "BLOCK" + } + }, + "AccountTakeoverRiskConfiguration": { + "NotifyConfiguration": { + "From": "diego@example.com", + "ReplyTo": "diego@example.com", + "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", + "BlockEmail": { + "Subject": "Blocked sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We blocked an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", + "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + }, + "NoActionEmail": { + "Subject": "New sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We observed an unrecognized sign-in to your account with this information:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", + "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + }, + "MfaEmail": { + "Subject": "New sign-in attempt", + "HtmlBody": "\n\n\n\tHTML email context\n\t\n\n\n
We required you to use multi-factor authentication for the following sign-in attempt:\n
    \n
  • Time: {login-time}
    • \n
  • Device: {device-name}
    • \n
  • Location: {city}, {country}
    • \n
\nIf this sign-in was not by you, you should change your password and notify us by clicking on this link\nIf this sign-in was by you, you can follow this link to let us know
\n\n", + "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" + } + }, + "Actions": { + "LowAction": { + "Notify": true, + "EventAction": "NO_ACTION" + }, + "MediumAction": { + "Notify": true, + "EventAction": "MFA_IF_CONFIGURED" + }, + "HighAction": { + "Notify": true, + "EventAction": "MFA_IF_CONFIGURED" + } + } + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/describe-user-import-job.rst b/aws/dist/awscli/examples/cognito-idp/describe-user-import-job.rst new file mode 100644 index 00000000..2f791f78 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-user-import-job.rst @@ -0,0 +1,28 @@ +**To describe a user import job** + +This example describes a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp describe-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test1", + "JobId": "import-TZqNQvDRnW", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED URL", + "CreationDate": 1548271708.512, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/describe-user-pool-client.rst b/aws/dist/awscli/examples/cognito-idp/describe-user-pool-client.rst new file mode 100644 index 00000000..a8858bab --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-user-pool-client.rst @@ -0,0 +1,70 @@ +**To describe a user pool client** + +This example describes a user pool client. + +Command:: + + aws cognito-idp describe-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 38fjsnc484p94kpqsnet7mpld0 + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "MyApp", + "ClientId": "38fjsnc484p94kpqsnet7mpld0", + "ClientSecret": "CLIENT_SECRET", + "LastModifiedDate": 1548108676.163, + "CreationDate": 1548108676.163, + "RefreshTokenValidity": 30, + "ReadAttributes": [ + "address", + "birthdate", + "custom:CustomAttr1", + "custom:CustomAttr2", + "email", + "email_verified", + "family_name", + "gender", + "given_name", + "locale", + "middle_name", + "name", + "nickname", + "phone_number", + "phone_number_verified", + "picture", + "preferred_username", + "profile", + "updated_at", + "website", + "zoneinfo" + ], + "WriteAttributes": [ + "address", + "birthdate", + "custom:CustomAttr1", + "custom:CustomAttr2", + "email", + "family_name", + "gender", + "given_name", + "locale", + "middle_name", + "name", + "nickname", + "phone_number", + "picture", + "preferred_username", + "profile", + "updated_at", + "website", + "zoneinfo" + ], + "ExplicitAuthFlows": [ + "ADMIN_NO_SRP_AUTH", + "USER_PASSWORD_AUTH" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/describe-user-pool-domain.rst b/aws/dist/awscli/examples/cognito-idp/describe-user-pool-domain.rst new file mode 100644 index 00000000..8c64536f --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-user-pool-domain.rst @@ -0,0 +1,22 @@ +**To describe a user pool client** + +This example describes a user pool domain named my-domain. + +Command:: + + aws cognito-idp describe-user-pool-domain --domain my-domain + +Output:: + + { + "DomainDescription": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "AWSAccountId": "111111111111", + "Domain": "my-domain", + "S3Bucket": "aws-cognito-prod-pdx-assets", + "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", + "Version": "20190128175402", + "Status": "ACTIVE", + "CustomDomainConfig": {} + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/describe-user-pool.rst b/aws/dist/awscli/examples/cognito-idp/describe-user-pool.rst new file mode 100644 index 00000000..130a301f --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/describe-user-pool.rst @@ -0,0 +1,267 @@ +**To describe a user pool** + +This example describes a user pool with the user pool id us-west-2_aaaaaaaaa. + +Command:: + + aws cognito-idp describe-user-pool --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UserPool": { + "SmsVerificationMessage": "Your verification code is {####}. ", + "SchemaAttributes": [ + { + "Name": "sub", + "StringAttributeConstraints": { + "MinLength": "1", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": false + }, + { + "Name": "name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "given_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "family_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "middle_name", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "nickname", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "preferred_username", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "profile", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "picture", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "website", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "email", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": true, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "email_verified", + "Mutable": true + }, + { + "Name": "gender", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "birthdate", + "StringAttributeConstraints": { + "MinLength": "10", + "MaxLength": "10" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "zoneinfo", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "locale", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "phone_number", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "AttributeDataType": "Boolean", + "DeveloperOnlyAttribute": false, + "Required": false, + "Name": "phone_number_verified", + "Mutable": true + }, + { + "Name": "address", + "StringAttributeConstraints": { + "MinLength": "0", + "MaxLength": "2048" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "String", + "Mutable": true + }, + { + "Name": "updated_at", + "NumberAttributeConstraints": { + "MinValue": "0" + }, + "DeveloperOnlyAttribute": false, + "Required": false, + "AttributeDataType": "Number", + "Mutable": true + } + ], + "EmailVerificationSubject": "Your verification code", + "MfaConfiguration": "OFF", + "Name": "MyUserPool", + "EmailVerificationMessage": "Your verification code is {####}. ", + "SmsAuthenticationMessage": "Your authentication code is {####}. ", + "LastModifiedDate": 1547763720.822, + "AdminCreateUserConfig": { + "InviteMessageTemplate": { + "EmailMessage": "Your username is {username} and temporary password is {####}. ", + "EmailSubject": "Your temporary password", + "SMSMessage": "Your username is {username} and temporary password is {####}. " + }, + "UnusedAccountValidityDays": 7, + "AllowAdminCreateUserOnly": false + }, + "EmailConfiguration": { + "ReplyToEmailAddress": "myemail@mydomain.com" + "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com" + }, + "AutoVerifiedAttributes": [ + "email" + ], + "Policies": { + "PasswordPolicy": { + "RequireLowercase": true, + "RequireSymbols": true, + "RequireNumbers": true, + "MinimumLength": 8, + "RequireUppercase": true + } + }, + "UserPoolTags": {}, + "UsernameAttributes": [ + "email" + ], + "CreationDate": 1547763720.822, + "EstimatedNumberOfUsers": 1, + "Id": "us-west-2_aaaaaaaaa", + "LambdaConfig": {} + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/forget-device.rst b/aws/dist/awscli/examples/cognito-idp/forget-device.rst new file mode 100644 index 00000000..5141fe69 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/forget-device.rst @@ -0,0 +1,8 @@ +**To forget a device** + +This example forgets device a device. + +Command:: + + aws cognito-idp forget-device --device-key us-west-2_abcd_1234-5678 + diff --git a/aws/dist/awscli/examples/cognito-idp/forgot-password.rst b/aws/dist/awscli/examples/cognito-idp/forgot-password.rst new file mode 100644 index 00000000..8ab382af --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/forgot-password.rst @@ -0,0 +1,15 @@ +**To force a password change** + +The following ``forgot-password`` example sends a message to jane@example.com to change their password. :: + + aws cognito-idp forgot-password --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com + +Output:: + + { + "CodeDeliveryDetails": { + "Destination": "j***@e***.com", + "DeliveryMedium": "EMAIL", + "AttributeName": "email" + } + } diff --git a/aws/dist/awscli/examples/cognito-idp/get-csv-header.rst b/aws/dist/awscli/examples/cognito-idp/get-csv-header.rst new file mode 100644 index 00000000..6e6db1a8 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/get-csv-header.rst @@ -0,0 +1,40 @@ +**To create a csv header** + +This example creates a csv header. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp get-csv-header --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CSVHeader": [ + "name", + "given_name", + "family_name", + "middle_name", + "nickname", + "preferred_username", + "profile", + "picture", + "website", + "email", + "email_verified", + "gender", + "birthdate", + "zoneinfo", + "locale", + "phone_number", + "phone_number_verified", + "address", + "updated_at", + "cognito:mfa_enabled", + "cognito:username" + ] + } + +... _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/get-group.rst b/aws/dist/awscli/examples/cognito-idp/get-group.rst new file mode 100644 index 00000000..61a87756 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/get-group.rst @@ -0,0 +1,19 @@ +**To get information about a group** + +This example gets information about a group named MyGroup. + +Command:: + + aws cognito-idp get-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup + +Output:: + + { + "Group": { + "GroupName": "MyGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "A sample group.", + "LastModifiedDate": 1548270073.795, + "CreationDate": 1548270073.795 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/get-signing-certificate.rst b/aws/dist/awscli/examples/cognito-idp/get-signing-certificate.rst new file mode 100644 index 00000000..f7c26f1b --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/get-signing-certificate.rst @@ -0,0 +1,13 @@ +**To get a signing certificate** + +This example gets a signing certificate for a user pool. + +Command:: + + aws cognito-idp get-signing-certificate --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "Certificate": "CERTIFICATE_DATA" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/get-ui-customization.rst b/aws/dist/awscli/examples/cognito-idp/get-ui-customization.rst new file mode 100644 index 00000000..8943912c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/get-ui-customization.rst @@ -0,0 +1,19 @@ +**To get UI customization information** + +This example gets UI customization information for a user pool. + +Command:: + + aws cognito-idp get-ui-customization --user-pool-id us-west-2_aaaaaaaaa + +Output:: + + { + "UICustomization": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientId": "ALL", + "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg", + "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", + "CSSVersion": "20190128231240" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/list-user-import-jobs.rst b/aws/dist/awscli/examples/cognito-idp/list-user-import-jobs.rst new file mode 100644 index 00000000..e279cd01 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/list-user-import-jobs.rst @@ -0,0 +1,57 @@ +**To list user import jobs** + +This example lists user import jobs. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp list-user-import-jobs --user-pool-id us-west-2_aaaaaaaaa --max-results 20 + +Output:: + + { + "UserImportJobs": [ + { + "JobName": "Test2", + "JobId": "import-d0OnwGA3mV", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548272793.069, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + }, + { + "JobName": "Test1", + "JobId": "import-qQ0DCt2fRh", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271795.471, + "Status": "Created", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + }, + { + "JobName": "import-Test1", + "JobId": "import-TZqNQvDRnW", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548271708.512, + "StartDate": 1548277247.962, + "CompletionDate": 1548277248.912, + "Status": "Failed", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 1, + "CompletionMessage": "Too many users have failed or been skipped during the import." + } + ] + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/list-user-pools.rst b/aws/dist/awscli/examples/cognito-idp/list-user-pools.rst new file mode 100644 index 00000000..302487ef --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/list-user-pools.rst @@ -0,0 +1,22 @@ +**To list user pools** + +This example lists up to 20 user pools. + +Command:: + + aws cognito-idp list-user-pools --max-results 20 + +Output:: + + { + "UserPools": [ + { + "CreationDate": 1547763720.822, + "LastModifiedDate": 1547763720.822, + "LambdaConfig": {}, + "Id": "us-west-2_aaaaaaaaa", + "Name": "MyUserPool" + } + ] + } + diff --git a/aws/dist/awscli/examples/cognito-idp/list-users-in-group.rst b/aws/dist/awscli/examples/cognito-idp/list-users-in-group.rst new file mode 100644 index 00000000..25c54c8b --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/list-users-in-group.rst @@ -0,0 +1,56 @@ +**To list users in a group** + +This example lists users in group MyGroup. + +Command:: + + aws cognito-idp list-users-in-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup + +Output:: + + { + "Users": [ + { + "Username": "acf10624-80bb-401a-ac61-607bee2110ec", + "Attributes": [ + { + "Name": "sub", + "Value": "acf10624-80bb-401a-ac61-607bee2110ec" + }, + { + "Name": "custom:CustomAttr1", + "Value": "New Value!" + }, + { + "Name": "email", + "Value": "jane@example.com" + } + ], + "UserCreateDate": 1548102770.284, + "UserLastModifiedDate": 1548103204.893, + "Enabled": true, + "UserStatus": "CONFIRMED" + }, + { + "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", + "Attributes": [ + { + "Name": "sub", + "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "email", + "Value": "diego@example.com" + } + ], + "UserCreateDate": 1548089817.683, + "UserLastModifiedDate": 1548089817.683, + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD" + } + ] + } diff --git a/aws/dist/awscli/examples/cognito-idp/list-users.rst b/aws/dist/awscli/examples/cognito-idp/list-users.rst new file mode 100644 index 00000000..6245e17c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/list-users.rst @@ -0,0 +1,35 @@ +**To list users** + +This example lists up to 20 users. + +Command:: + + aws cognito-idp list-users --user-pool-id us-west-2_aaaaaaaaa --limit 20 + +Output:: + + { + "Users": [ + { + "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", + "Enabled": true, + "UserStatus": "FORCE_CHANGE_PASSWORD", + "UserCreateDate": 1548089817.683, + "UserLastModifiedDate": 1548089817.683, + "Attributes": [ + { + "Name": "sub", + "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" + }, + { + "Name": "email_verified", + "Value": "true" + }, + { + "Name": "email", + "Value": "mary@example.com" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/cognito-idp/resend-confirmation-code.rst b/aws/dist/awscli/examples/cognito-idp/resend-confirmation-code.rst new file mode 100644 index 00000000..7bf38c6d --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/resend-confirmation-code.rst @@ -0,0 +1,17 @@ +**To force a password change** + +This example sends a message to jane@example.com to change their password. + +Command:: + + aws cognito-idp forget-device --client-id 38fjsnc484p94kpqsnet7mpld0 --username jane@example.com + +Output:: + + { + "CodeDeliveryDetails": { + "Destination": "j***@e***.com", + "DeliveryMedium": "EMAIL", + "AttributeName": "email" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/respond-to-auth-challenge.rst b/aws/dist/awscli/examples/cognito-idp/respond-to-auth-challenge.rst new file mode 100644 index 00000000..282d97eb --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/respond-to-auth-challenge.rst @@ -0,0 +1,27 @@ +**To respond to an authorization challenge** + +This example responds to an authorization challenge initiated with `initiate-auth`_. It is a response to the NEW_PASSWORD_REQUIRED challenge. +It sets a password for user jane@example.com. + +Command:: + + aws cognito-idp respond-to-auth-challenge --client-id 3n4b5urk1ft4fl3mg5e62d9ado --challenge-name NEW_PASSWORD_REQUIRED --challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session "SESSION_TOKEN" + +Output:: + + { + "ChallengeParameters": {}, + "AuthenticationResult": { + "AccessToken": "ACCESS_TOKEN", + "ExpiresIn": 3600, + "TokenType": "Bearer", + "RefreshToken": "REFRESH_TOKEN", + "IdToken": "ID_TOKEN", + "NewDeviceMetadata": { + "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23", + "DeviceGroupKey": "-wt2ha1Zd" + } + } + } + +.. _`initiate-auth`: https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/initiate-auth.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/set-risk-configuration.rst b/aws/dist/awscli/examples/cognito-idp/set-risk-configuration.rst new file mode 100644 index 00000000..5c78c0a9 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/set-risk-configuration.rst @@ -0,0 +1,23 @@ +**To set risk configuration** + +This example sets the risk configuration for a user pool. It sets the sign-up event action to NO_ACTION. + +Command:: + + aws cognito-idp set-risk-configuration --user-pool-id us-west-2_aaaaaaaaa --compromised-credentials-risk-configuration EventFilter=SIGN_UP,Actions={EventAction=NO_ACTION} + +Output:: + + { + "RiskConfiguration": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "CompromisedCredentialsRiskConfiguration": { + "EventFilter": [ + "SIGN_UP" + ], + "Actions": { + "EventAction": "NO_ACTION" + } + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/set-ui-customization.rst b/aws/dist/awscli/examples/cognito-idp/set-ui-customization.rst new file mode 100644 index 00000000..7864e3a7 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/set-ui-customization.rst @@ -0,0 +1,18 @@ +**To set UI customization** + +This example customizes the CSS setting for a user pool. + +Command:: + + aws cognito-idp set-ui-customization --user-pool-id us-west-2_aaaaaaaaa --css ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n" + +Output:: + + { + "UICustomization": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientId": "ALL", + "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #faf;\n}\n", + "CSSVersion": "20190129172214" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/set-user-mfa-preference.rst b/aws/dist/awscli/examples/cognito-idp/set-user-mfa-preference.rst new file mode 100644 index 00000000..95f49bf1 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/set-user-mfa-preference.rst @@ -0,0 +1,8 @@ +**To set user MFA settings** + +This example modifies the MFA delivery options. It changes the MFA delivery medium to SMS. + +Command:: + + aws cognito-idp set-user-mfa-preference --access-token ACCESS_TOKEN --mfa-options DeliveryMedium="SMS",AttributeName="phone_number" + diff --git a/aws/dist/awscli/examples/cognito-idp/set-user-settings.rst b/aws/dist/awscli/examples/cognito-idp/set-user-settings.rst new file mode 100644 index 00000000..0a5973f8 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/set-user-settings.rst @@ -0,0 +1,8 @@ +**To set user settings** + +This example sets the MFA delivery preference to EMAIL. + +Command:: + + aws cognito-idp set-user-settings --access-token ACCESS_TOKEN --mfa-options DeliveryMedium=EMAIL + diff --git a/aws/dist/awscli/examples/cognito-idp/sign-up.rst b/aws/dist/awscli/examples/cognito-idp/sign-up.rst new file mode 100644 index 00000000..7ab74233 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/sign-up.rst @@ -0,0 +1,14 @@ +**To sign up a user** + +This example signs up jane@example.com. + +Command:: + + aws cognito-idp sign-up --client-id 3n4b5urk1ft4fl3mg5e62d9ado --username jane@example.com --password PASSWORD --user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane" + +Output:: + + { + "UserConfirmed": false, + "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" + } diff --git a/aws/dist/awscli/examples/cognito-idp/start-user-import-job.rst b/aws/dist/awscli/examples/cognito-idp/start-user-import-job.rst new file mode 100644 index 00000000..e33be386 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/start-user-import-job.rst @@ -0,0 +1,29 @@ +**To start a user import job** + +This example starts a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp start-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test10", + "JobId": "import-lmpxSOuIzH", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548278378.928, + "StartDate": 1548278397.334, + "Status": "Pending", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0 + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/stop-user-import-job.rst b/aws/dist/awscli/examples/cognito-idp/stop-user-import-job.rst new file mode 100644 index 00000000..4d62b7f1 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/stop-user-import-job.rst @@ -0,0 +1,31 @@ +**To stop a user import job** + +This example stops a user input job. + +For more information about importing users, see `Importing Users into User Pools From a CSV File`_. + +Command:: + + aws cognito-idp stop-user-import-job --user-pool-id us-west-2_aaaaaaaaa --job-id import-TZqNQvDRnW + +Output:: + + { + "UserImportJob": { + "JobName": "import-Test5", + "JobId": "import-Fx0kARISFL", + "UserPoolId": "us-west-2_aaaaaaaaa", + "PreSignedUrl": "PRE_SIGNED_URL", + "CreationDate": 1548278576.259, + "StartDate": 1548278623.366, + "CompletionDate": 1548278626.741, + "Status": "Stopped", + "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", + "ImportedUsers": 0, + "SkippedUsers": 0, + "FailedUsers": 0, + "CompletionMessage": "The Import Job was stopped by the developer." + } + } + +.. _`Importing Users into User Pools From a CSV File`: https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/update-auth-event-feedback.rst b/aws/dist/awscli/examples/cognito-idp/update-auth-event-feedback.rst new file mode 100644 index 00000000..b84b711c --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-auth-event-feedback.rst @@ -0,0 +1,7 @@ +**To update auth event feedback** + +This example updates authorization event feedback. It marks the event "Valid". + +Command:: + + aws cognito-idp update-auth-event-feedback --user-pool-id us-west-2_aaaaaaaaa --username diego@example.com --event-id EVENT_ID --feedback-token FEEDBACK_TOKEN --feedback-value "Valid" diff --git a/aws/dist/awscli/examples/cognito-idp/update-device-status.rst b/aws/dist/awscli/examples/cognito-idp/update-device-status.rst new file mode 100644 index 00000000..cabe6bff --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-device-status.rst @@ -0,0 +1,7 @@ +**To update device status** + +This example updates the status for a device to "not_remembered". + +Command:: + + aws cognito-idp update-device-status --access-token ACCESS_TOKEN --device-key DEVICE_KEY --device-remembered-status "not_remembered" diff --git a/aws/dist/awscli/examples/cognito-idp/update-group.rst b/aws/dist/awscli/examples/cognito-idp/update-group.rst new file mode 100644 index 00000000..88d60ba0 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-group.rst @@ -0,0 +1,21 @@ +**To update a group** + +This example updates the description and precedence for MyGroup. + +Command:: + + aws cognito-idp update-group --user-pool-id us-west-2_aaaaaaaaa --group-name MyGroup --description "New description" --precedence 2 + +Output:: + + { + "Group": { + "GroupName": "MyGroup", + "UserPoolId": "us-west-2_aaaaaaaaa", + "Description": "New description", + "RoleArn": "arn:aws:iam::111111111111:role/MyRole", + "Precedence": 2, + "LastModifiedDate": 1548800862.812, + "CreationDate": 1548097827.125 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/update-resource-server.rst b/aws/dist/awscli/examples/cognito-idp/update-resource-server.rst new file mode 100644 index 00000000..4b06e89e --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-resource-server.rst @@ -0,0 +1,23 @@ +**To update a resource server** + +This example updates the the resource server Weather. It adds a new scope. + +Command:: + + aws cognito-idp update-resource-server --user-pool-id us-west-2_aaaaaaaaa --identifier weather.example.com --name Weather --scopes ScopeName=NewScope,ScopeDescription="New scope description" + +Output:: + + { + "ResourceServer": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "Identifier": "weather.example.com", + "Name": "Happy", + "Scopes": [ + { + "ScopeName": "NewScope", + "ScopeDescription": "New scope description" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/update-user-attributes.rst b/aws/dist/awscli/examples/cognito-idp/update-user-attributes.rst new file mode 100644 index 00000000..3f723772 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-user-attributes.rst @@ -0,0 +1,7 @@ +**To update user attributes** + +This example updates the user attribute "nickname". + +Command:: + + aws cognito-idp update-user-attributes --access-token ACCESS_TOKEN --user-attributes Name="nickname",Value="Dan" diff --git a/aws/dist/awscli/examples/cognito-idp/update-user-pool-client.rst b/aws/dist/awscli/examples/cognito-idp/update-user-pool-client.rst new file mode 100644 index 00000000..b2f922eb --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-user-pool-client.rst @@ -0,0 +1,24 @@ +**To update a user pool client** + +This example updates the name of a user pool client. It also adds a writeable attribute "nickname". + +Command:: + + aws cognito-idp update-user-pool-client --user-pool-id us-west-2_aaaaaaaaa --client-id 3n4b5urk1ft4fl3mg5e62d9ado --client-name "NewClientName" --write-attributes "nickname" + +Output:: + + { + "UserPoolClient": { + "UserPoolId": "us-west-2_aaaaaaaaa", + "ClientName": "NewClientName", + "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", + "LastModifiedDate": 1548802761.334, + "CreationDate": 1548178931.258, + "RefreshTokenValidity": 30, + "WriteAttributes": [ + "nickname" + ], + "AllowedOAuthFlowsUserPoolClient": false + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/cognito-idp/update-user-pool.rst b/aws/dist/awscli/examples/cognito-idp/update-user-pool.rst new file mode 100644 index 00000000..a3948e59 --- /dev/null +++ b/aws/dist/awscli/examples/cognito-idp/update-user-pool.rst @@ -0,0 +1,7 @@ +**To update a user pool** + +This example adds tags to a user pool. + +Command:: + + aws cognito-idp update-user-pool --user-pool-id us-west-2_aaaaaaaaa --user-pool-tags Team=Blue,Area=West diff --git a/aws/dist/awscli/examples/configservice/delete-config-rule.rst b/aws/dist/awscli/examples/configservice/delete-config-rule.rst new file mode 100644 index 00000000..19b650d4 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/delete-config-rule.rst @@ -0,0 +1,5 @@ +**To delete an AWS Config rule** + +The following command deletes an AWS Config rule named ``MyConfigRule``:: + + aws configservice delete-config-rule --config-rule-name MyConfigRule \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/delete-delivery-channel.rst b/aws/dist/awscli/examples/configservice/delete-delivery-channel.rst new file mode 100644 index 00000000..0676a685 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/delete-delivery-channel.rst @@ -0,0 +1,5 @@ +**To delete a delivery channel** + +The following command deletes the default delivery channel:: + + aws configservice delete-delivery-channel --delivery-channel-name default \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/delete-evaluation-results.rst b/aws/dist/awscli/examples/configservice/delete-evaluation-results.rst new file mode 100755 index 00000000..93452828 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/delete-evaluation-results.rst @@ -0,0 +1,5 @@ +**To manually delete evaluation results** + +The following command deletes the current evaluation results for the AWS managed rule s3-bucket-versioning-enabled:: + + aws configservice delete-evaluation-results --config-rule-name s3-bucket-versioning-enabled \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/deliver-config-snapshot.rst b/aws/dist/awscli/examples/configservice/deliver-config-snapshot.rst new file mode 100644 index 00000000..cd32a878 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/deliver-config-snapshot.rst @@ -0,0 +1,11 @@ +**To deliver a configuration snapshot** + +The following command delivers a configuration snapshot to the Amazon S3 bucket that belongs to the default delivery channel:: + + aws configservice deliver-config-snapshot --delivery-channel-name default + +Output:: + + { + "configSnapshotId": "d0333b00-a683-44af-921e-examplefb794" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-compliance-by-config-rule.rst b/aws/dist/awscli/examples/configservice/describe-compliance-by-config-rule.rst new file mode 100644 index 00000000..03eb8207 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-compliance-by-config-rule.rst @@ -0,0 +1,34 @@ +**To get compliance information for your AWS Config rules** + +The following command returns compliance information for each AWS Config rule that is violated by one or more AWS resources:: + + aws configservice describe-compliance-by-config-rule --compliance-types NON_COMPLIANT + +In the output, the value for each ``CappedCount`` attribute indicates how many resources do not comply with the related rule. For example, the following output indicates that 3 resources do not comply with the rule named ``InstanceTypesAreT2micro``. + +Output:: + + { + "ComplianceByConfigRules": [ + { + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + }, + "ConfigRuleName": "InstanceTypesAreT2micro" + }, + { + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 10, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + }, + "ConfigRuleName": "RequiredTagsForVolumes" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-compliance-by-resource.rst b/aws/dist/awscli/examples/configservice/describe-compliance-by-resource.rst new file mode 100644 index 00000000..d65c3c9b --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-compliance-by-resource.rst @@ -0,0 +1,36 @@ +**To get compliance information for your AWS resources** + +The following command returns compliance information for each EC2 instance that is recorded by AWS Config and that violates one or more rules:: + + aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance --compliance-types NON_COMPLIANT + +In the output, the value for each ``CappedCount`` attribute indicates how many rules the resource violates. For example, the following output indicates that instance ``i-1a2b3c4d`` violates 2 rules. + +Output:: + + { + "ComplianceByResources": [ + { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 2, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + } + }, + { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-2a2b3c4d ", + "Compliance": { + "ComplianceContributorCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceType": "NON_COMPLIANT" + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-config-rule-evaluation-status.rst b/aws/dist/awscli/examples/configservice/describe-config-rule-evaluation-status.rst new file mode 100644 index 00000000..86c30dba --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-config-rule-evaluation-status.rst @@ -0,0 +1,19 @@ +**To get status information for an AWS Config rule** + +The following command returns the status information for an AWS Config rule named ``MyConfigRule``:: + + aws configservice describe-config-rule-evaluation-status --config-rule-names MyConfigRule + +Output:: + + { + "ConfigRulesEvaluationStatus": [ + { + "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", + "FirstActivatedTime": 1450311703.844, + "ConfigRuleId": "config-rule-abcdef", + "LastSuccessfulInvocationTime": 1450314643.156, + "ConfigRuleName": "MyConfigRule" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-config-rules.rst b/aws/dist/awscli/examples/configservice/describe-config-rules.rst new file mode 100644 index 00000000..2b033663 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-config-rules.rst @@ -0,0 +1,35 @@ +**To get details for an AWS Config rule** + +The following command returns details for an AWS Config rule named ``InstanceTypesAreT2micro``:: + + aws configservice describe-config-rules --config-rule-names InstanceTypesAreT2micro + +Output:: + + { + "ConfigRules": [ + { + "ConfigRuleState": "ACTIVE", + "Description": "Evaluates whether EC2 instances are the t2.micro type.", + "ConfigRuleName": "InstanceTypesAreT2micro", + "ConfigRuleArn": "arn:aws:config:us-east-1:123456789012:config-rule/config-rule-abcdef", + "Source": { + "Owner": "CUSTOM_LAMBDA", + "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", + "SourceDetails": [ + { + "EventSource": "aws.config", + "MessageType": "ConfigurationItemChangeNotification" + } + ] + }, + "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "ConfigRuleId": "config-rule-abcdef" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-configuration-recorder-status.rst b/aws/dist/awscli/examples/configservice/describe-configuration-recorder-status.rst new file mode 100644 index 00000000..d2f69367 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-configuration-recorder-status.rst @@ -0,0 +1,20 @@ +**To get status information for the configuration recorder** + +The following command returns the status of the default configuration recorder:: + + aws configservice describe-configuration-recorder-status + +Output:: + + { + "ConfigurationRecordersStatus": [ + { + "name": "default", + "lastStatus": "SUCCESS", + "recording": true, + "lastStatusChangeTime": 1452193834.344, + "lastStartTime": 1441039997.819, + "lastStopTime": 1441039992.835 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-configuration-recorders.rst b/aws/dist/awscli/examples/configservice/describe-configuration-recorders.rst new file mode 100644 index 00000000..d9b2eeef --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-configuration-recorders.rst @@ -0,0 +1,21 @@ +**To get details about the configuration recorder** + +The following command returns details about the default configuration recorder:: + + aws configservice describe-configuration-recorders + +Output:: + + { + "ConfigurationRecorders": [ + { + "recordingGroup": { + "allSupported": true, + "resourceTypes": [], + "includeGlobalResourceTypes": true + }, + "roleARN": "arn:aws:iam::123456789012:role/config-ConfigRole-A1B2C3D4E5F6", + "name": "default" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-delivery-channel-status.rst b/aws/dist/awscli/examples/configservice/describe-delivery-channel-status.rst new file mode 100644 index 00000000..f65cffa2 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-delivery-channel-status.rst @@ -0,0 +1,29 @@ +**To get status information for the delivery channel** + +The following command returns the status of the delivery channel:: + + aws configservice describe-delivery-channel-status + +Output:: + + { + "DeliveryChannelsStatus": [ + { + "configStreamDeliveryInfo": { + "lastStatusChangeTime": 1452193834.381, + "lastStatus": "SUCCESS" + }, + "configHistoryDeliveryInfo": { + "lastSuccessfulTime": 1450317838.412, + "lastStatus": "SUCCESS", + "lastAttemptTime": 1450317838.412 + }, + "configSnapshotDeliveryInfo": { + "lastSuccessfulTime": 1452185597.094, + "lastStatus": "SUCCESS", + "lastAttemptTime": 1452185597.094 + }, + "name": "default" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/describe-delivery-channels.rst b/aws/dist/awscli/examples/configservice/describe-delivery-channels.rst new file mode 100644 index 00000000..44f26a2e --- /dev/null +++ b/aws/dist/awscli/examples/configservice/describe-delivery-channels.rst @@ -0,0 +1,17 @@ +**To get details about the delivery channel** + +The following command returns details about the delivery channel:: + + aws configservice describe-delivery-channels + +Output:: + + { + "DeliveryChannels": [ + { + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "name": "default", + "s3BucketName": "config-bucket-123456789012" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-compliance-details-by-config-rule.rst b/aws/dist/awscli/examples/configservice/get-compliance-details-by-config-rule.rst new file mode 100644 index 00000000..cd966494 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-compliance-details-by-config-rule.rst @@ -0,0 +1,51 @@ +**To get the evaluation results for an AWS Config rule** + +The following command returns the evaluation results for all of the resources that don't comply with an AWS Config rule named ``InstanceTypesAreT2micro``:: + + aws configservice get-compliance-details-by-config-rule --config-rule-name InstanceTypesAreT2micro --compliance-types NON_COMPLIANT + +Output:: + + { + "EvaluationResults": [ + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314645.261, + "ConfigRuleInvokedTime": 1450314642.948, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-2a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314645.18, + "ConfigRuleInvokedTime": 1450314642.902, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-3a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314643.346, + "ConfigRuleInvokedTime": 1450314643.124, + "ComplianceType": "NON_COMPLIANT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-compliance-details-by-resource.rst b/aws/dist/awscli/examples/configservice/get-compliance-details-by-resource.rst new file mode 100644 index 00000000..5baf6b22 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-compliance-details-by-resource.rst @@ -0,0 +1,38 @@ +**To get the evaluation results for an AWS resource** + +The following command returns the evaluation results for each rule with which the EC2 instance ``i-1a2b3c4d`` does not comply:: + + aws configservice get-compliance-details-by-resource --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d --compliance-types NON_COMPLIANT + +Output:: + + { + "EvaluationResults": [ + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "InstanceTypesAreT2micro" + } + }, + "ResultRecordedTime": 1450314643.288, + "ConfigRuleInvokedTime": 1450314643.034, + "ComplianceType": "NON_COMPLIANT" + }, + { + "EvaluationResultIdentifier": { + "OrderingTimestamp": 1450314635.065, + "EvaluationResultQualifier": { + "ResourceType": "AWS::EC2::Instance", + "ResourceId": "i-1a2b3c4d", + "ConfigRuleName": "RequiredTagForEC2Instances" + } + }, + "ResultRecordedTime": 1450314645.261, + "ConfigRuleInvokedTime": 1450314642.948, + "ComplianceType": "NON_COMPLIANT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst b/aws/dist/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst new file mode 100644 index 00000000..5d8e52c2 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-compliance-summary-by-config-rule.rst @@ -0,0 +1,23 @@ +**To get the compliance summary for your AWS Config rules** + +The following command returns the number of rules that are compliant and the number that are noncompliant:: + + aws configservice get-compliance-summary-by-config-rule + +In the output, the value for each ``CappedCount`` attribute indicates how many rules are compliant or noncompliant. + +Output:: + + { + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1452204131.493, + "CompliantResourceCount": { + "CappedCount": 2, + "CapExceeded": false + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst b/aws/dist/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst new file mode 100644 index 00000000..5b30a7f8 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-compliance-summary-by-resource-type.rst @@ -0,0 +1,56 @@ +**To get the compliance summary for all resource types** + +The following command returns the number of AWS resources that are noncompliant and the number that are compliant:: + + aws configservice get-compliance-summary-by-resource-type + +In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. + +Output:: + + { + "ComplianceSummariesByResourceType": [ + { + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 16, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1453237464.543, + "CompliantResourceCount": { + "CappedCount": 10, + "CapExceeded": false + } + } + } + ] + } + +**To get the compliance summary for a specific resource type** + +The following command returns the number of EC2 instances that are noncompliant and the number that are compliant:: + + aws configservice get-compliance-summary-by-resource-type --resource-types AWS::EC2::Instance + +In the output, the value for each ``CappedCount`` attribute indicates how many resources are compliant or noncompliant. + +Output:: + + { + "ComplianceSummariesByResourceType": [ + { + "ResourceType": "AWS::EC2::Instance", + "ComplianceSummary": { + "NonCompliantResourceCount": { + "CappedCount": 3, + "CapExceeded": false + }, + "ComplianceSummaryTimestamp": 1452204923.518, + "CompliantResourceCount": { + "CappedCount": 7, + "CapExceeded": false + } + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-resource-config-history.rst b/aws/dist/awscli/examples/configservice/get-resource-config-history.rst new file mode 100644 index 00000000..d2f08bcc --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-resource-config-history.rst @@ -0,0 +1,5 @@ +**To get the configuration history of an AWS resource** + +The following command returns a list of configuration items for an EC2 instance with an ID of ``i-1a2b3c4d``:: + + aws configservice get-resource-config-history --resource-type AWS::EC2::Instance --resource-id i-1a2b3c4d \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/get-status.rst b/aws/dist/awscli/examples/configservice/get-status.rst new file mode 100644 index 00000000..1dde5a5d --- /dev/null +++ b/aws/dist/awscli/examples/configservice/get-status.rst @@ -0,0 +1,20 @@ +**To get the status for AWS Config** + +The following command returns the status of the delivery channel and configuration recorder:: + + aws configservice get-status + +Output:: + + Configuration Recorders: + + name: default + recorder: ON + last status: SUCCESS + + Delivery Channels: + + name: default + last stream delivery status: SUCCESS + last history delivery status: SUCCESS + last snapshot delivery status: SUCCESS \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/list-discovered-resources.rst b/aws/dist/awscli/examples/configservice/list-discovered-resources.rst new file mode 100644 index 00000000..7b86d768 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/list-discovered-resources.rst @@ -0,0 +1,24 @@ +**To list resources that AWS Config has discovered** + +The following command lists the EC2 instances that AWS Config has discovered:: + + aws configservice list-discovered-resources --resource-type AWS::EC2::Instance + +Output:: + + { + "resourceIdentifiers": [ + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-1a2b3c4d" + }, + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-2a2b3c4d" + }, + { + "resourceType": "AWS::EC2::Instance", + "resourceId": "i-3a2b3c4d" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/put-config-rule.rst b/aws/dist/awscli/examples/configservice/put-config-rule.rst new file mode 100644 index 00000000..872f5fd6 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/put-config-rule.rst @@ -0,0 +1,64 @@ +**To add an AWS managed Config rule** + +The following command provides JSON code to add an AWS managed Config rule:: + + aws configservice put-config-rule --config-rule file://RequiredTagsForEC2Instances.json + +``RequiredTagsForEC2Instances.json`` is a JSON file that contains the rule configuration:: + + { + "ConfigRuleName": "RequiredTagsForEC2Instances", + "Description": "Checks whether the CostCenter and Owner tags are applied to EC2 instances.", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "Source": { + "Owner": "AWS", + "SourceIdentifier": "REQUIRED_TAGS" + }, + "InputParameters": "{\"tag1Key\":\"CostCenter\",\"tag2Key\":\"Owner\"}" + } + +For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because the rule is a managed rule, the ``Owner`` attribute is set to ``AWS``, and the ``SourceIdentifier`` attribute is set to the rule identifier, ``REQUIRED_TAGS``. For the ``InputParameters`` attribute, the tag keys that the rule requires, ``CostCenter`` and ``Owner``, are specified. + +If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html + +**To add a customer managed Config rule** + +The following command provides JSON code to add a customer managed Config rule:: + + aws configservice put-config-rule --config-rule file://InstanceTypesAreT2micro.json + +``InstanceTypesAreT2micro.json`` is a JSON file that contains the rule configuration:: + + { + "ConfigRuleName": "InstanceTypesAreT2micro", + "Description": "Evaluates whether EC2 instances are the t2.micro type.", + "Scope": { + "ComplianceResourceTypes": [ + "AWS::EC2::Instance" + ] + }, + "Source": { + "Owner": "CUSTOM_LAMBDA", + "SourceIdentifier": "arn:aws:lambda:us-east-1:123456789012:function:InstanceTypeCheck", + "SourceDetails": [ + { + "EventSource": "aws.config", + "MessageType": "ConfigurationItemChangeNotification" + } + ] + }, + "InputParameters": "{\"desiredInstanceType\":\"t2.micro\"}" + } + +For the ``ComplianceResourceTypes`` attribute, this JSON code limits the scope to resources of the ``AWS::EC2::Instance`` type, so AWS Config will evaluate only EC2 instances against the rule. Because this rule is a customer managed rule, the ``Owner`` attribute is set to ``CUSTOM_LAMBDA``, and the ``SourceIdentifier`` attribute is set to the ARN of the AWS Lambda function. The ``SourceDetails`` object is required. The parameters that are specified for the ``InputParameters`` attribute are passed to the AWS Lambda function when AWS Config invokes it to evaluate resources against the rule. + +If the command succeeds, AWS Config returns no output. To verify the rule configuration, run the `describe-config-rules`__ command, and specify the rule name. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-config-rules.html + diff --git a/aws/dist/awscli/examples/configservice/put-configuration-recorder.rst b/aws/dist/awscli/examples/configservice/put-configuration-recorder.rst new file mode 100644 index 00000000..e6e964a3 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/put-configuration-recorder.rst @@ -0,0 +1,35 @@ +**To record all supported resources** + +The following command creates a configuration recorder that tracks changes to all supported resource types, including global resource types:: + + aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group allSupported=true,includeGlobalResourceTypes=true + +**To record specific types of resources** + +The following command creates a configuration recorder that tracks changes to only those types of resources that are specified in the JSON file for the `--recording-group` option:: + + aws configservice put-configuration-recorder --configuration-recorder name=default,roleARN=arn:aws:iam::123456789012:role/config-role --recording-group file://recordingGroup.json + +`recordingGroup.json` is a JSON file that specifies the types of resources that AWS Config will record:: + + { + "allSupported": false, + "includeGlobalResourceTypes": false, + "resourceTypes": [ + "AWS::EC2::EIP", + "AWS::EC2::Instance", + "AWS::EC2::NetworkAcl", + "AWS::EC2::SecurityGroup", + "AWS::CloudTrail::Trail", + "AWS::EC2::Volume", + "AWS::EC2::VPC", + "AWS::IAM::User", + "AWS::IAM::Policy" + ] + } + +Before you can specify resource types for the `resourceTypes` key, you must set the `allSupported` and `includeGlobalResourceTypes` options to false or omit them. + +If the command succeeds, AWS Config returns no output. To verify the settings of your configuration recorder, run the `describe-configuration-recorders`__ command. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-configuration-recorders.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/put-delivery-channel.rst b/aws/dist/awscli/examples/configservice/put-delivery-channel.rst new file mode 100644 index 00000000..493f4490 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/put-delivery-channel.rst @@ -0,0 +1,42 @@ +**To create a delivery channel** + +The following command provides the settings for the delivery channel as JSON code:: + + aws configservice put-delivery-channel --delivery-channel file://deliveryChannel.json + +The ``deliveryChannel.json`` file specifies the delivery channel attributes:: + + { + "name": "default", + "s3BucketName": "config-bucket-123456789012", + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "configSnapshotDeliveryProperties": { + "deliveryFrequency": "Twelve_Hours" + } + } + +This example sets the following attributes: + +- ``name`` - The name of the delivery channel. By default, AWS Config assigns the name ``default`` to a new delivery channel. + + You cannot update the delivery channel name with the ``put-delivery-channel`` command. For the steps to change the name, see `Renaming the Delivery Channel`__. + + .. __: http://docs.aws.amazon.com/config/latest/developerguide/update-dc.html#update-dc-rename + +- ``s3BucketName`` - The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. + + If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon S3 Bucket`__. + +.. __: http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html + +- ``snsTopicARN`` - The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. + + If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see `Permissions for the Amazon SNS Topic`__. + +.. __: http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html + +- ``configSnapshotDeliveryProperties`` - Contains the ``deliveryFrequency`` attribute, which sets how often AWS Config delivers configuration snapshots and how often it invokes evaluations for periodic Config rules. + +If the command succeeds, AWS Config returns no output. To verify the settings of your delivery channel, run the `describe-delivery-channels`__ command. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/describe-delivery-channels.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/start-config-rules-evaluation.rst b/aws/dist/awscli/examples/configservice/start-config-rules-evaluation.rst new file mode 100755 index 00000000..3034c288 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/start-config-rules-evaluation.rst @@ -0,0 +1,5 @@ +**To run an on-demand evaluation for AWS Config rules** + +The following command starts an evaluation for two AWS managed rules:: + + aws configservice start-config-rules-evaluation --config-rule-names s3-bucket-versioning-enabled cloudtrail-enabled \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/start-configuration-recorder.rst b/aws/dist/awscli/examples/configservice/start-configuration-recorder.rst new file mode 100644 index 00000000..2eb5fadb --- /dev/null +++ b/aws/dist/awscli/examples/configservice/start-configuration-recorder.rst @@ -0,0 +1,9 @@ +**To start the configuration recorder** + +The following command starts the default configuration recorder:: + + aws configservice start-configuration-recorder --configuration-recorder-name default + +If the command succeeds, AWS Config returns no output. To verify that AWS Config is recording your resources, run the `get-status`__ command. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/get-status.html diff --git a/aws/dist/awscli/examples/configservice/stop-configuration-recorder.rst b/aws/dist/awscli/examples/configservice/stop-configuration-recorder.rst new file mode 100644 index 00000000..8f3f6881 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/stop-configuration-recorder.rst @@ -0,0 +1,9 @@ +**To stop the configuration recorder** + +The following command stops the default configuration recorder:: + + aws configservice stop-configuration-recorder --configuration-recorder-name default + +If the command succeeds, AWS Config returns no output. To verify that AWS Config is not recording your resources, run the `get-status`__ command. + +.. __: http://docs.aws.amazon.com/cli/latest/reference/configservice/get-status.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/configservice/subscribe.rst b/aws/dist/awscli/examples/configservice/subscribe.rst new file mode 100644 index 00000000..c9b7e723 --- /dev/null +++ b/aws/dist/awscli/examples/configservice/subscribe.rst @@ -0,0 +1,31 @@ +**To subscribe to AWS Config** + +The following command creates the default delivery channel and configuration recorder. The command also specifies the Amazon S3 bucket and Amazon SNS topic to which AWS Config will deliver configuration information:: + + aws configservice subscribe --s3-bucket config-bucket-123456789012 --sns-topic arn:aws:sns:us-east-1:123456789012:config-topic --iam-role arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6 + +Output:: + + Using existing S3 bucket: config-bucket-123456789012 + Using existing SNS topic: arn:aws:sns:us-east-1:123456789012:config-topic + Subscribe succeeded: + + Configuration Recorders: [ + { + "recordingGroup": { + "allSupported": true, + "resourceTypes": [], + "includeGlobalResourceTypes": false + }, + "roleARN": "arn:aws:iam::123456789012:role/ConfigRole-A1B2C3D4E5F6", + "name": "default" + } + ] + + Delivery Channels: [ + { + "snsTopicARN": "arn:aws:sns:us-east-1:123456789012:config-topic", + "name": "default", + "s3BucketName": "config-bucket-123456789012" + } + ] \ No newline at end of file diff --git a/aws/dist/awscli/examples/configure/_description.rst b/aws/dist/awscli/examples/configure/_description.rst new file mode 100644 index 00000000..15bae506 --- /dev/null +++ b/aws/dist/awscli/examples/configure/_description.rst @@ -0,0 +1,37 @@ +Configure AWS CLI options. If this command is run with no +arguments, you will be prompted for configuration values such as your AWS +Access Key Id and you AWS Secret Access Key. You can configure a named +profile using the ``--profile`` argument. If your config file does not exist +(the default location is ``~/.aws/config``), the AWS CLI will create it +for you. To keep an existing value, hit enter when prompted for the value. +When you are prompted for information, the current value will be displayed in +``[brackets]``. If the config item has no value, it be displayed as +``[None]``. Note that the ``configure`` command only work with values from the +config file. It does not use any configuration values from environment +variables or the IAM role. + +Note: the values you provide for the AWS Access Key ID and the AWS Secret +Access Key will be written to the shared credentials file +(``~/.aws/credentials``). + + +======================= +Configuration Variables +======================= + +The following configuration variables are supported in the config file: + +* **aws_access_key_id** - The AWS access key part of your credentials +* **aws_secret_access_key** - The AWS secret access key part of your credentials +* **aws_session_token** - The session token part of your credentials (session tokens only) +* **metadata_service_timeout** - The number of seconds to wait until the metadata service + request times out. This is used if you are using an IAM role to provide + your credentials. +* **metadata_service_num_attempts** - The number of attempts to try to retrieve + credentials. If you know for certain you will be using an IAM role on an + Amazon EC2 instance, you can set this value to ensure any intermittent + failures are retried. By default this value is 1. + +For more information on configuration options, see `Configuring the AWS Command Line Interface`_ in the *AWS CLI User Guide*. + +.. _`Configuring the AWS Command Line Interface`: http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/configure/add-model.rst b/aws/dist/awscli/examples/configure/add-model.rst new file mode 100644 index 00000000..60b943ea --- /dev/null +++ b/aws/dist/awscli/examples/configure/add-model.rst @@ -0,0 +1,9 @@ +**Add a model** + +The following command adds a service model from a file named ``service.json``:: + + aws configure add-model --service-model file://service.json + +Adding a model replaces existing commands for the service defined in the model. To leave existing commands as-is, specify a different service name to use for the new commands:: + + aws configure add-model --service-model file://service.json --service-name service2 diff --git a/aws/dist/awscli/examples/configure/get/_description.rst b/aws/dist/awscli/examples/configure/get/_description.rst new file mode 100644 index 00000000..757192fb --- /dev/null +++ b/aws/dist/awscli/examples/configure/get/_description.rst @@ -0,0 +1,40 @@ +Get a configuration value from the config file. + +The ``aws configure get`` command can be used to print a configuration value in +the AWS config file. The ``get`` command supports two types of configuration +values, *unqualified* and *qualified* config values. + + +Note that ``aws configure get`` only looks at values in the AWS configuration +file. It does **not** resolve configuration variables specified anywhere else, +including environment variables, command line arguments, etc. + + +Unqualified Names +----------------- + +Every value in the AWS configuration file must be placed in a section (denoted +by ``[section-name]`` in the config file). To retrieve a value from the +config file, the section name and the config name must be known. + +An unqualified configuration name refers to a name that is not scoped to a +specific section in the configuration file. Sections are specified by +separating parts with the ``"."`` character (``section.config-name``). An +unqualified name will be scoped to the current profile. For example, +``aws configure get aws_access_key_id`` will retrieve the ``aws_access_key_id`` +from the current profile, or the ``default`` profile if no profile is +specified. You can still provide a ``--profile`` argument to the ``aws +configure get`` command. For example, ``aws configure get region --profile +testing`` will print the region value for the ``testing`` profile. + + +Qualified Names +--------------- + +A qualified name is a name that has at least one ``"."`` character in the name. +This name provides a way to specify the config section from which to retrieve +the config variable. When a qualified name is provided to ``aws configure +get``, the currently specified profile is ignored. Section names that have +the format ``[profile profile-name]`` can be specified by using the +``profile.profile-name.config-name`` syntax, and the default profile can be +specified using the ``default.config-name`` syntax. diff --git a/aws/dist/awscli/examples/configure/get/_examples.rst b/aws/dist/awscli/examples/configure/get/_examples.rst new file mode 100644 index 00000000..48190ef8 --- /dev/null +++ b/aws/dist/awscli/examples/configure/get/_examples.rst @@ -0,0 +1,29 @@ +Suppose you had the following config file:: + + [default] + aws_access_key_id=default_access_key + aws_secret_access_key=default_secret_key + + [profile testing] + aws_access_key_id=testing_access_key + aws_secret_access_key=testing_secret_key + region=us-west-2 + +The following commands would have the corresponding output:: + + $ aws configure get aws_access_key_id + default_access_key + + $ aws configure get default.aws_access_key_id + default_access_key + + $ aws configure get aws_access_key_id --profile testing + testing_access_key + + $ aws configure get profile.testing.aws_access_key_id + testing_access_key + + $ aws configure get profile.does-not-exist + $ + $ echo $? + 1 diff --git a/aws/dist/awscli/examples/configure/set/_description.rst b/aws/dist/awscli/examples/configure/set/_description.rst new file mode 100644 index 00000000..b915e396 --- /dev/null +++ b/aws/dist/awscli/examples/configure/set/_description.rst @@ -0,0 +1,18 @@ +Set a configuration value from the config file. + +The ``aws configure set`` command can be used to set a single configuration +value in the AWS config file. The ``set`` command supports both the +*qualified* and *unqualified* config values documented in the ``get`` command +(see ``aws configure get help`` for more information). + +To set a single value, provide the configuration name followed by the +configuration value. + +If the config file does not exist, one will automatically be created. If the +configuration value already exists in the config file, it will updated with the +new configuration value. + +Setting a value for the ``aws_access_key_id``, ``aws_secret_access_key``, or +the ``aws_session_token`` will result in the value being writen to the +shared credentials file (``~/.aws/credentials``). All other values will +be written to the config file (default location is ``~/.aws/config``). diff --git a/aws/dist/awscli/examples/configure/set/_examples.rst b/aws/dist/awscli/examples/configure/set/_examples.rst new file mode 100644 index 00000000..66ce9fe9 --- /dev/null +++ b/aws/dist/awscli/examples/configure/set/_examples.rst @@ -0,0 +1,26 @@ +Given an empty config file, the following commands:: + + $ aws configure set aws_access_key_id default_access_key + $ aws configure set aws_secret_access_key default_secret_key + $ aws configure set default.region us-west-2 + $ aws configure set default.ca_bundle /path/to/ca-bundle.pem + $ aws configure set region us-west-1 --profile testing + $ aws configure set profile.testing2.region eu-west-1 + +will produce the following config file:: + + [default] + region = us-west-2 + ca_bundle = /path/to/ca-bundle.pem + + [profile testing] + region = us-west-1 + + [profile testing2] + region = eu-west-1 + +and the following ``~/.aws/credentials`` file:: + + [default] + aws_access_key_id = default_access_key + aws_secret_access_key = default_secret_key diff --git a/aws/dist/awscli/examples/cur/delete-report-definition.rst b/aws/dist/awscli/examples/cur/delete-report-definition.rst new file mode 100644 index 00000000..bf80fd06 --- /dev/null +++ b/aws/dist/awscli/examples/cur/delete-report-definition.rst @@ -0,0 +1,7 @@ +**To delete an AWS Cost and Usage Report** + +This example deletes an AWS Cost and Usage Report. + +Command:: + + aws cur --region us-east-1 delete-report-definition --report-name "ExampleReport" diff --git a/aws/dist/awscli/examples/cur/describe-report-definitions.rst b/aws/dist/awscli/examples/cur/describe-report-definitions.rst new file mode 100644 index 00000000..d3298c0e --- /dev/null +++ b/aws/dist/awscli/examples/cur/describe-report-definitions.rst @@ -0,0 +1,30 @@ +**To retrieve a list of AWS Cost and Usage Reports** + +This example describes a list of AWS Cost and Usage Reports owned by an account. + +Command:: + + aws cur --region us-east-1 describe-report-definitions --max-items 5 + +Output:: + + { + "ReportDefinitions": [ + { + "ReportName": "ExampleReport", + "Compression": "ZIP", + "S3Region": "us-east-1", + "Format": "textORcsv", + "S3Prefix": "exampleprefix", + "S3Bucket": "example-s3-bucket", + "TimeUnit": "DAILY", + "AdditionalArtifacts": [ + "REDSHIFT", + "QUICKSIGHT" + ], + "AdditionalSchemaElements": [ + "RESOURCES" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/cur/put-report-definition.rst b/aws/dist/awscli/examples/cur/put-report-definition.rst new file mode 100644 index 00000000..a47132ce --- /dev/null +++ b/aws/dist/awscli/examples/cur/put-report-definition.rst @@ -0,0 +1,25 @@ +**To create an AWS Cost and Usage Reports** + +The following ``put-report-definition`` example creates a daily AWS Cost and Usage Report that you can upload into Amazon Redshift or Amazon QuickSight. :: + + aws cur put-report-definition --report-definition file://report-definition.json + +Contents of ``report-definition.json``:: + + { + "ReportName": "ExampleReport", + "TimeUnit": "DAILY", + "Format": "textORcsv", + "Compression": "ZIP", + "AdditionalSchemaElements": [ + "RESOURCES" + ], + "S3Bucket": "example-s3-bucket", + "S3Prefix": "exampleprefix", + "S3Region": "us-east-1", + "AdditionalArtifacts": [ + "REDSHIFT", + "QUICKSIGHT" + ] + } + diff --git a/aws/dist/awscli/examples/datapipeline/activate-pipeline.rst b/aws/dist/awscli/examples/datapipeline/activate-pipeline.rst new file mode 100644 index 00000000..5e9824e6 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/activate-pipeline.rst @@ -0,0 +1,9 @@ +**To activate a pipeline** + +This example activates the specified pipeline:: + + aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE + +To activate the pipeline at a specific date and time, use the following command:: + + aws datapipeline activate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --start-timestamp 2015-04-07T00:00:00Z diff --git a/aws/dist/awscli/examples/datapipeline/add-tags.rst b/aws/dist/awscli/examples/datapipeline/add-tags.rst new file mode 100644 index 00000000..2f7d6262 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/add-tags.rst @@ -0,0 +1,22 @@ +**To add a tag to a pipeline** + +This example adds the specified tag to the specified pipeline:: + + aws datapipeline add-tags --pipeline-id df-00627471SOVYZEXAMPLE --tags key=environment,value=production key=owner,value=sales + +To view the tags, use the describe-pipelines command. For example, the tags added in the example command appear as follows in the output for describe-pipelines:: + + { + ... + "tags": [ + { + "value": "production", + "key": "environment" + }, + { + "value": "sales", + "key": "owner" + } + ] + ... + } diff --git a/aws/dist/awscli/examples/datapipeline/create-pipeline.rst b/aws/dist/awscli/examples/datapipeline/create-pipeline.rst new file mode 100644 index 00000000..b951ffb4 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/create-pipeline.rst @@ -0,0 +1,11 @@ +**To create a pipeline** + +This example creates a pipeline:: + + aws datapipeline create-pipeline --name my-pipeline --unique-id my-pipeline-token + +The following is example output:: + + { + "pipelineId": "df-00627471SOVYZEXAMPLE" + } diff --git a/aws/dist/awscli/examples/datapipeline/deactivate-pipeline.rst b/aws/dist/awscli/examples/datapipeline/deactivate-pipeline.rst new file mode 100644 index 00000000..eea93ab5 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/deactivate-pipeline.rst @@ -0,0 +1,9 @@ +**To deactivate a pipeline** + +This example deactivates the specified pipeline:: + + aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE + +To deactivate the pipeline only after all running activities finish, use the following command:: + + aws datapipeline deactivate-pipeline --pipeline-id df-00627471SOVYZEXAMPLE --no-cancel-active diff --git a/aws/dist/awscli/examples/datapipeline/delete-pipeline.rst b/aws/dist/awscli/examples/datapipeline/delete-pipeline.rst new file mode 100644 index 00000000..4b99ad4a --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/delete-pipeline.rst @@ -0,0 +1,5 @@ +**To delete a pipeline** + +This example deletes the specified pipeline:: + + aws datapipeline delete-pipeline --pipeline-id df-00627471SOVYZEXAMPLE diff --git a/aws/dist/awscli/examples/datapipeline/describe-pipelines.rst b/aws/dist/awscli/examples/datapipeline/describe-pipelines.rst new file mode 100644 index 00000000..b43330a8 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/describe-pipelines.rst @@ -0,0 +1,55 @@ +**To describe your pipelines** + +This example describes the specified pipeline:: + + aws datapipeline describe-pipelines --pipeline-ids df-00627471SOVYZEXAMPLE + +The following is example output:: + + { + "pipelineDescriptionList": [ + { + "fields": [ + { + "stringValue": "PENDING", + "key": "@pipelineState" + }, + { + "stringValue": "my-pipeline", + "key": "name" + }, + { + "stringValue": "2015-04-07T16:05:58", + "key": "@creationTime" + }, + { + "stringValue": "df-00627471SOVYZEXAMPLE", + "key": "@id" + }, + { + "stringValue": "123456789012", + "key": "pipelineCreator" + }, + { + "stringValue": "PIPELINE", + "key": "@sphere" + }, + { + "stringValue": "123456789012", + "key": "@userId" + }, + { + "stringValue": "123456789012", + "key": "@accountId" + }, + { + "stringValue": "my-pipeline-token", + "key": "uniqueId" + } + ], + "pipelineId": "df-00627471SOVYZEXAMPLE", + "name": "my-pipeline", + "tags": [] + } + ] + } diff --git a/aws/dist/awscli/examples/datapipeline/get-pipeline-definition.rst b/aws/dist/awscli/examples/datapipeline/get-pipeline-definition.rst new file mode 100644 index 00000000..0e62f1c4 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/get-pipeline-definition.rst @@ -0,0 +1,90 @@ +**To get a pipeline definition** + +This example gets the pipeline definition for the specified pipeline:: + + aws datapipeline get-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE + +The following is example output:: + + { + "parameters": [ + { + "type": "AWS::S3::ObjectKey", + "id": "myS3OutputLoc", + "description": "S3 output folder" + }, + { + "default": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", + "type": "AWS::S3::ObjectKey", + "id": "myS3InputLoc", + "description": "S3 input folder" + }, + { + "default": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt", + "type": "String", + "id": "myShellCmd", + "description": "Shell command to run" + } + ], + "objects": [ + { + "type": "Ec2Resource", + "terminateAfter": "20 Minutes", + "instanceType": "t1.micro", + "id": "EC2ResourceObj", + "name": "EC2ResourceObj" + }, + { + "name": "Default", + "failureAndRerunMode": "CASCADE", + "resourceRole": "DataPipelineDefaultResourceRole", + "schedule": { + "ref": "DefaultSchedule" + }, + "role": "DataPipelineDefaultRole", + "scheduleType": "cron", + "id": "Default" + }, + { + "directoryPath": "#{myS3OutputLoc}/#{format(@scheduledStartTime, 'YYYY-MM-dd-HH-mm-ss')}", + "type": "S3DataNode", + "id": "S3OutputLocation", + "name": "S3OutputLocation" + }, + { + "directoryPath": "#{myS3InputLoc}", + "type": "S3DataNode", + "id": "S3InputLocation", + "name": "S3InputLocation" + }, + { + "startAt": "FIRST_ACTIVATION_DATE_TIME", + "name": "Every 15 minutes", + "period": "15 minutes", + "occurrences": "4", + "type": "Schedule", + "id": "DefaultSchedule" + }, + { + "name": "ShellCommandActivityObj", + "command": "#{myShellCmd}", + "output": { + "ref": "S3OutputLocation" + }, + "input": { + "ref": "S3InputLocation" + }, + "stage": "true", + "type": "ShellCommandActivity", + "id": "ShellCommandActivityObj", + "runsOn": { + "ref": "EC2ResourceObj" + } + } + ], + "values": { + "myS3OutputLoc": "s3://my-s3-bucket/", + "myS3InputLoc": "s3://us-east-1.elasticmapreduce.samples/pig-apache-logs/data", + "myShellCmd": "grep -rc \"GET\" ${INPUT1_STAGING_DIR}/* > ${OUTPUT1_STAGING_DIR}/output.txt" + } + } diff --git a/aws/dist/awscli/examples/datapipeline/list-pipelines.rst b/aws/dist/awscli/examples/datapipeline/list-pipelines.rst new file mode 100644 index 00000000..74f637d4 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/list-pipelines.rst @@ -0,0 +1,28 @@ +**To list your pipelines** + +This example lists your pipelines:: + + aws datapipeline list-pipelines + +The following is example output:: + + { + "pipelineIdList": [ + { + "id": "df-00627471SOVYZEXAMPLE", + "name": "my-pipeline" + }, + { + "id": "df-09028963KNVMREXAMPLE", + "name": "ImportDDB" + }, + { + "id": "df-0870198233ZYVEXAMPLE", + "name": "CrossRegionDDB" + }, + { + "id": "df-00189603TB4MZEXAMPLE", + "name": "CopyRedshift" + } + ] + } diff --git a/aws/dist/awscli/examples/datapipeline/list-runs.rst b/aws/dist/awscli/examples/datapipeline/list-runs.rst new file mode 100644 index 00000000..841b4686 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/list-runs.rst @@ -0,0 +1,20 @@ +**Example 1: To list your pipeline runs** + +The following ``list-runs`` example lists the runs for the specified pipeline. :: + + aws datapipeline list-runs --pipeline-id df-00627471SOVYZEXAMPLE + +Output:: + + Name Scheduled Start Status ID Started Ended + ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + 1. EC2ResourceObj 2015-04-12T17:33:02 CREATING @EC2ResourceObj_2015-04-12T17:33:02 2015-04-12T17:33:10 + 2. S3InputLocation 2015-04-12T17:33:02 FINISHED @S3InputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 2015-04-12T17:33:09 + 3. S3OutputLocation 2015-04-12T17:33:02 WAITING_ON_DEPENDENCIES @S3OutputLocation_2015-04-12T17:33:02 2015-04-12T17:33:09 + 4. ShellCommandActivityObj 2015-04-12T17:33:02 WAITING_FOR_RUNNER @ShellCommandActivityObj_2015-04-12T17:33:02 2015-04-12T17:33:09 + +**Example 2: To list the pipeline runs between the specified dates** + +The following ``list-runs`` example uses the ``--start-interval`` to specify the dates to include in the output. :: + + aws datapipeline list-runs --pipeline-id df-01434553B58A2SHZUKO5 --start-interval 2017-10-07T00:00:00,2017-10-08T00:00:00 diff --git a/aws/dist/awscli/examples/datapipeline/put-pipeline-definition.rst b/aws/dist/awscli/examples/datapipeline/put-pipeline-definition.rst new file mode 100644 index 00000000..a2ea0748 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/put-pipeline-definition.rst @@ -0,0 +1,13 @@ +**To upload a pipeline definition** + +This example uploads the specified pipeline definition to the specified pipeline:: + + aws datapipeline put-pipeline-definition --pipeline-id df-00627471SOVYZEXAMPLE --pipeline-definition file://my-pipeline-definition.json + +The following is example output:: + + { + "validationErrors": [], + "errored": false, + "validationWarnings": [] + } diff --git a/aws/dist/awscli/examples/datapipeline/remove-tags.rst b/aws/dist/awscli/examples/datapipeline/remove-tags.rst new file mode 100644 index 00000000..824d4a18 --- /dev/null +++ b/aws/dist/awscli/examples/datapipeline/remove-tags.rst @@ -0,0 +1,5 @@ +**To remove a tag from a pipeline** + +This example removes the specified tag from the specified pipeline:: + + aws datapipeline remove-tags --pipeline-id df-00627471SOVYZEXAMPLE --tag-keys environment diff --git a/aws/dist/awscli/examples/ddb/put.rst b/aws/dist/awscli/examples/ddb/put.rst new file mode 100644 index 00000000..dfdbbbe0 --- /dev/null +++ b/aws/dist/awscli/examples/ddb/put.rst @@ -0,0 +1,58 @@ +**To add an item to a table** + +This example adds a new item to the *MusicCollection* table. + +Command:: + + aws ddb put MusicCollection '{Artist: "No One You Know", SongTitle: "Call Me Today", AlbumTitle: "Somewhat Famous"}' + +**To add items to a table from a file** + +This example adds two new items from a file to the *MusicCollection* table. + +Command:: + + aws ddb put MusicCollection file://items.json + +The items to add to the table are in a JSON file, ``items.json``. Here are the +contents of that file:: + + [ + { + "Artist": "No One You Know", + "SongTitle": "Call Me Today", + "AlbumTitle": "Somewhat Famous" + }, + { + "Artist": "No One You Know", + "SongTitle": "Scared of My Shadow", + "AlbumTitle": "Blue Sky Blues" + } + ] + +**To add items to a table from stdin** + +This example adds a new item to the *MusicCollection* table by reading it from +stdin. + +Command:: + + echo '{Artist: "No One You Know", SongTitle: "Call Me Today"}' \ + | aws ddb put MusicCollection - + +**Conditional Expressions** + +This example shows how to perform a one-line conditional operation. +This put call to the table *MusicCollection* table will only succeed if the +artist "Obscure Indie Band" does not exist in the table. + +Command:: + + aws ddb put MusicCollection '{Artist: "Obscure Indie Band", SongTitle: "Atlas"}' \ + --condition 'attribute_not_exists(Artist)' + +If the key already exists, you should see: + +Output:: + + A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed diff --git a/aws/dist/awscli/examples/ddb/select.rst b/aws/dist/awscli/examples/ddb/select.rst new file mode 100644 index 00000000..91d9a34e --- /dev/null +++ b/aws/dist/awscli/examples/ddb/select.rst @@ -0,0 +1,40 @@ +**To scan an entire table** + +This example scans the entire *MusicCollection* table, and then narrows the +results to songs by the artist "No One You Know". For each item, only the album +title and song title are returned. + +Command:: + + aws ddb select MusicCollection --projection 'SongTitle, AlbumTitle' \ + --filter 'Artist = "No One You Know"' + +Output:: + + Count: 2 + Items: + - SongTitle: "Call Me Today" + AlbumTitle: "Somewhat Famous" + - SongTitle: "Scared of My Shadow" + AlbumTitle: "Blue Sky Blues" + ScannedCount: 3 + +**To query for specific primary keys** + +This example queries items in the *MusicCollection* table. The table has a +hash-and-range primary key (*Artist* and *SongTitle*), but this query only +specifies the hash key value. It returns song titles by the artist named "No +One You Know". + +Command:: + + aws ddb select MusicCollection --projection SongTitle \ + --key-condition-expression 'Artist = "No One You Know"' + +Output:: + + Count: 2 + Items: + - SongTitle: "Call Me Today" + - SongTitle: "Scared of My Shadow" + ScannedCount: 2 diff --git a/aws/dist/awscli/examples/deploy/add-tags-to-on-premises-instances.rst b/aws/dist/awscli/examples/deploy/add-tags-to-on-premises-instances.rst new file mode 100755 index 00000000..747c79d8 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/add-tags-to-on-premises-instances.rst @@ -0,0 +1,9 @@ +**To add tags to on-premises instances** + +The follwoing ``add-tags-to-on-premises-instances`` example associates in AWS CodeDeploy the same on-premises instance tag to two on-premises instances. It does not register the on-premises instances with AWS CodeDeploy. :: + + aws deploy add-tags-to-on-premises-instances \ + --instance-names AssetTag12010298EX AssetTag23121309EX \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/batch-get-application-revisions.rst b/aws/dist/awscli/examples/deploy/batch-get-application-revisions.rst new file mode 100755 index 00000000..5e0fdbdf --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-application-revisions.rst @@ -0,0 +1,34 @@ +**To retrieve information about application revisions** + +The following ``batch-get-application-revisions`` example retrieves information about the specified revision stored in a GitHub repository. :: + + aws deploy batch-get-application-revisions \ + --application-name my-codedeploy-application \ + --revisions "[{\"gitHubLocation\": {\"commitId\": \"fa85936EXAMPLEa31736c051f10d77297EXAMPLE\",\"repository\": \"my-github-token/my-repository\"},\"revisionType\": \"GitHub\"}]" + +Output:: + + { + "revisions": [ + { + "genericRevisionInfo": { + "description": "Application revision registered by Deployment ID: d-A1B2C3111", + "lastUsedTime": 1556912355.884, + "registerTime": 1556912355.884, + "firstUsedTime": 1556912355.884, + "deploymentGroups": [] + }, + "revisionLocation": { + "revisionType": "GitHub", + "gitHubLocation": { + "commitId": "fa85936EXAMPLEa31736c051f10d77297EXAMPLE", + "repository": "my-github-token/my-repository" + } + } + } + ], + "applicationName": "my-codedeploy-application", + "errorMessage": "" + } + +For more information, see `BatchGetApplicationRevisions `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/batch-get-applications.rst b/aws/dist/awscli/examples/deploy/batch-get-applications.rst new file mode 100755 index 00000000..5dc5b163 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-applications.rst @@ -0,0 +1,24 @@ +**To get information about multiple applications** + +The following ``batch-get-applications`` example displays information about multiple applications that are associated with the user's AWS account. :: + + aws deploy batch-get-applications --application-names WordPress_App MyOther_App + +Output:: + + { + "applicationsInfo": [ + { + "applicationName": "WordPress_App", + "applicationId": "d9dd6993-f171-44fa-a811-211e4EXAMPLE", + "createTime": 1407878168.078, + "linkedToGitHub": false + }, + { + "applicationName": "MyOther_App", + "applicationId": "8ca57519-31da-42b2-9194-8bb16EXAMPLE", + "createTime": 1407453571.63, + "linkedToGitHub": false + } + ] + } diff --git a/aws/dist/awscli/examples/deploy/batch-get-deployment-groups.rst b/aws/dist/awscli/examples/deploy/batch-get-deployment-groups.rst new file mode 100755 index 00000000..6b9d1581 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-deployment-groups.rst @@ -0,0 +1,86 @@ +**To retrieve information about one or more deployment groups** + +The following ``batch-get-deployment-groups`` example retrieves information about two of the deployment groups that are associated with the specified CodeDeploy application. :: + + aws deploy batch-get-deployment-groups \ + --application-name my-codedeploy-application \ + --deployment-group-names "[\"my-deployment-group-1\",\"my-deployment-group-2\"]" + +Output:: + + { + "deploymentGroupsInfo": [ + { + "deploymentStyle": { + "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", + "deploymentType": "IN_PLACE" + }, + "autoRollbackConfiguration": { + "enabled": false + }, + "onPremisesTagSet": { + "onPremisesTagSetList": [] + }, + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeloyServiceRole", + "lastAttemptedDeployment": { + "endTime": 1556912366.415, + "status": "Failed", + "createTime": 1556912355.884, + "deploymentId": "d-A1B2C3111" + }, + "autoScalingGroups": [], + "deploymentGroupName": "my-deployment-group-1", + "ec2TagSet": { + "ec2TagSetList": [ + [ + { + "Type": "KEY_AND_VALUE", + "Value": "my-EC2-instance", + "Key": "Name" + } + ] + ] + }, + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111example", + "triggerConfigurations": [], + "applicationName": "my-codedeploy-application", + "computePlatform": "Server", + "deploymentConfigName": "CodeDeployDefault.AllAtOnce" + }, + { + "deploymentStyle": { + "deploymentOption": "WITHOUT_TRAFFIC_CONTROL", + "deploymentType": "IN_PLACE" + }, + "autoRollbackConfiguration": { + "enabled": false + }, + "onPremisesTagSet": { + "onPremisesTagSetList": [] + }, + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeloyServiceRole", + "autoScalingGroups": [], + "deploymentGroupName": "my-deployment-group-2", + "ec2TagSet": { + "ec2TagSetList": [ + [ + { + "Type": "KEY_AND_VALUE", + "Value": "my-EC2-instance", + "Key": "Name" + } + ] + ] + }, + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-22222example", + "triggerConfigurations": [], + "applicationName": "my-codedeploy-application", + "computePlatform": "Server", + "deploymentConfigName": "CodeDeployDefault.AllAtOnce" + } + ], + "errorMessage": "" + } + +For more information, see `BatchGetDeploymentGroups `_ in the *AWS CodeDeploy API Reference*. + \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/batch-get-deployment-targets.rst b/aws/dist/awscli/examples/deploy/batch-get-deployment-targets.rst new file mode 100755 index 00000000..c245e5c0 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-deployment-targets.rst @@ -0,0 +1,64 @@ +**To retrieve the targets associated with a deployment** + +The following ``batch-get-deployment-targets`` example returns information about one of the targets associated with the specified deployment. :: + + aws deploy batch-get-deployment-targets \ + --deployment-id "d-1A2B3C4D5" \ + --target-ids "i-01a2b3c4d5e6f1111" + +Output:: + + { + "deploymentTargets": [ + { + "deploymentTargetType": "InstanceTarget", + "instanceTarget": { + "lifecycleEvents": [ + { + "startTime": 1556918592.162, + "lifecycleEventName": "ApplicationStop", + "status": "Succeeded", + "endTime": 1556918592.247, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + }, + { + "startTime": 1556918593.193, + "lifecycleEventName": "DownloadBundle", + "status": "Succeeded", + "endTime": 1556918593.981, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + }, + { + "startTime": 1556918594.805, + "lifecycleEventName": "BeforeInstall", + "status": "Succeeded", + "endTime": 1556918681.807, + "diagnostics": { + "scriptName": "", + "errorCode": "Success", + "logTail": "", + "message": "Succeeded" + } + } + ], + "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111", + "deploymentId": "d-1A2B3C4D5", + "lastUpdatedAt": 1556918687.504, + "targetId": "i-01a2b3c4d5e6f1111", + "status": "Succeeded" + } + } + ] + } + +For more information, see `BatchGetDeploymentTargets `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/batch-get-deployments.rst b/aws/dist/awscli/examples/deploy/batch-get-deployments.rst new file mode 100755 index 00000000..0e2d8fb8 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-deployments.rst @@ -0,0 +1,68 @@ +**To get information about multiple deployments** + +The following ``batch-get-deployments`` example displays information about multiple deployments that are associated with the user's AWS account. :: + + aws deploy batch-get-deployments --deployment-ids d-A1B2C3111 d-A1B2C3222 + +Output:: + + { + "deploymentsInfo": [ + { + "applicationName": "WordPress_App", + "status": "Failed", + "deploymentOverview": { + "Failed": 0, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 1, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "deploymentGroupName": "WordPress_DG", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "version": "uTecLusEXAMPLEFXtfUcyfV8bEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + }, + "deploymentId": "d-A1B2C3111", + "createTime": 1408480721.9, + "completeTime": 1408480741.822 + }, + { + "applicationName": "MyOther_App", + "status": "Failed", + "deploymentOverview": { + "Failed": 1, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 0, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "errorInformation": { + "message": "Deployment failed: Constraint default violated: No hosts succeeded.", + "code": "HEALTH_CONSTRAINTS" + }, + "deploymentGroupName": "MyOther_DG", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", + "bucket": "CodeDeployDemoBucket", + "key": "MyOtherApp.zip" + } + }, + "deploymentId": "d-A1B2C3222", + "createTime": 1409764576.589, + "completeTime": 1409764596.101 + } + ] + } diff --git a/aws/dist/awscli/examples/deploy/batch-get-on-premises-instances.rst b/aws/dist/awscli/examples/deploy/batch-get-on-premises-instances.rst new file mode 100755 index 00000000..75306215 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/batch-get-on-premises-instances.rst @@ -0,0 +1,36 @@ +**To get information about one or more on-premises instances** + +The follwoing ``batch-get-on-premises-instances`` example gets information about two on-premises instances. :: + + aws deploy batch-get-on-premises-instances --instance-names AssetTag12010298EX AssetTag23121309EX + +Output:: + + { + "instanceInfos": [ + { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag12010298EX", + "registerTime": 1425579465.228, + "instanceArn": "arn:aws:codedeploy:us-west-2:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" + }, + { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag23121309EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag23121309EX", + "registerTime": 1425595585.988, + "instanceArn": "arn:aws:codedeploy:us-west-2:80398EXAMPLE:instance/AssetTag23121309EX_PomUy64Was" + } + ] + } diff --git a/aws/dist/awscli/examples/deploy/continue-deployment.rst b/aws/dist/awscli/examples/deploy/continue-deployment.rst new file mode 100755 index 00000000..b416be35 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/continue-deployment.rst @@ -0,0 +1,11 @@ +**To start rerouting traffic without waiting for a specified wait time to elapse.** + +The following ``continue-deployment`` example starts rerouting traffic from instances in the original environment that are ready to start shifting traffic to instances in the replacement environment. :: + + aws deploy continue-deployment \ + --deployment-d "d-A1B2C3111" \ + --deployment-wait-type "READY_WAIT" + +This command produces no output. + +For more information, see `ContinueDeployment `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/create-application.rst b/aws/dist/awscli/examples/deploy/create-application.rst new file mode 100755 index 00000000..a8df3396 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/create-application.rst @@ -0,0 +1,11 @@ +**To create an application** + +The following ``create-application`` example creates an application and associates it with the user's AWS account. :: + + aws deploy create-application --application-name MyOther_App + +Output:: + + { + "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } diff --git a/aws/dist/awscli/examples/deploy/create-deployment-config.rst b/aws/dist/awscli/examples/deploy/create-deployment-config.rst new file mode 100755 index 00000000..10315aae --- /dev/null +++ b/aws/dist/awscli/examples/deploy/create-deployment-config.rst @@ -0,0 +1,13 @@ +**To create a custom deployment configuration** + +The following ``create-deployment-config`` example creates a custom deployment configuration and associates it with the user's AWS account. :: + + aws deploy create-deployment-config \ + --deployment-config-name ThreeQuartersHealthy \ + --minimum-healthy-hosts type=FLEET_PERCENT,value=75 + +Output:: + + { + "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/create-deployment-group.rst b/aws/dist/awscli/examples/deploy/create-deployment-group.rst new file mode 100755 index 00000000..1a66b615 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/create-deployment-group.rst @@ -0,0 +1,17 @@ +**To create a deployment group** + +The following ``create-deployment-group`` example creates a deployment group and associates it with the specified application and the user's AWS account. :: + + aws deploy create-deployment-group \ + --application-name WordPress_App \ + --auto-scaling-groups CodeDeployDemo-ASG \ + --deployment-config-name CodeDeployDefault.OneAtATime \ + --deployment-group-name WordPress_DG \ + --ec2-tag-filters Key=Name,Value=CodeDeployDemo,Type=KEY_AND_VALUE \ + --service-role-arn arn:aws:iam::123456789012:role/CodeDeployDemoRole + +Output:: + + { + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } diff --git a/aws/dist/awscli/examples/deploy/create-deployment.rst b/aws/dist/awscli/examples/deploy/create-deployment.rst new file mode 100755 index 00000000..39cfad4f --- /dev/null +++ b/aws/dist/awscli/examples/deploy/create-deployment.rst @@ -0,0 +1,62 @@ +**Example 1: To create a CodeDeploy deployment using the EC2/On-premises compute platform** + +The following ``create-deployment`` example creates a deployment and associates it with the user's AWS account. :: + + aws deploy create-deployment \ + --application-name WordPress_App \ + --deployment-config-name CodeDeployDefault.OneAtATime \ + --deployment-group-name WordPress_DG \ + --description "My demo deployment" \ + --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip + +Output:: + + { + "deploymentId": "d-A1B2C3111" + } + +**Example 2: To create a CodeDeploy deployment using the Amazon ECS compute platform** + +The following ``create-deployment`` example uses the following two files to deploy an Amazon ECS service. + +Contents of ``create-deployment.json`` file:: + + { + "applicationName": "ecs-deployment", + "deploymentGroupName": "ecs-deployment-dg", + "revision": { + "revisionType": "S3", + "s3Location": { + "bucket": "ecs-deployment-bucket", + "key": "appspec.yaml", + "bundleType": "YAML" + } + } + } + +That file, in turn, retrieves the following file ``appspec.yaml`` from an S3 bucket called ``ecs-deployment-bucket``. :: + + version: 0.0 + Resources: + - TargetService: + Type: AWS::ECS::Service + Properties: + TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2" + LoadBalancerInfo: + ContainerName: "sample-app" + ContainerPort: 80 + PlatformVersion: "LATEST" + +Command:: + + aws deploy create-deployment \ + --cli-input-json file://create-deployment.json \ + --region us-east-1 + +Output:: + + { + "deploymentId": "d-1234ABCDE" + } + +For more information, see `CreateDeployment `__ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/delete-application.rst b/aws/dist/awscli/examples/deploy/delete-application.rst new file mode 100755 index 00000000..65a0c488 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/delete-application.rst @@ -0,0 +1,7 @@ +**To delete an application** + +The following ``delete-application`` example deletes the specified application that is associated with the user's AWS account. :: + + aws deploy delete-application --application-name WordPress_App + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/delete-deployment-config.rst b/aws/dist/awscli/examples/deploy/delete-deployment-config.rst new file mode 100755 index 00000000..6b67bc87 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/delete-deployment-config.rst @@ -0,0 +1,7 @@ +**To delete a deployment configuration** + +The following ``delete-deployment-config`` example deletes a custom deployment configuration that is associated with the user's AWS account. :: + + aws deploy delete-deployment-config --deployment-config-name ThreeQuartersHealthy + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/delete-deployment-group.rst b/aws/dist/awscli/examples/deploy/delete-deployment-group.rst new file mode 100755 index 00000000..065a945b --- /dev/null +++ b/aws/dist/awscli/examples/deploy/delete-deployment-group.rst @@ -0,0 +1,13 @@ +**To delete a deployment group** + +The following ``delete-deployment-group`` example deletes a deployment group that is associated with the specified application. :: + + aws deploy delete-deployment-group \ + --application-name WordPress_App \ + --deployment-group-name WordPress_DG + +Output:: + + { + "hooksNotCleanedUp": [] + } diff --git a/aws/dist/awscli/examples/deploy/delete-git-hub-account-token.rst b/aws/dist/awscli/examples/deploy/delete-git-hub-account-token.rst new file mode 100755 index 00000000..35a0ab0c --- /dev/null +++ b/aws/dist/awscli/examples/deploy/delete-git-hub-account-token.rst @@ -0,0 +1,13 @@ +**To deletes a GitHub account connection** + +The following ``delete-git-hub-account-token`` example deletes the connection of the specified GitHub account. :: + + aws deploy delete-git-hub-account-token --token-name my-github-account + +Output:: + + { + "tokenName": "my-github-account" + } + +For more information, see `DeleteGitHubAccountToken `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/deregister-on-premises-instance.rst b/aws/dist/awscli/examples/deploy/deregister-on-premises-instance.rst new file mode 100755 index 00000000..d94aa539 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/deregister-on-premises-instance.rst @@ -0,0 +1,7 @@ +**To deregister an on-premises instance** + +The following ``deregister-on-premises-instance`` example deregisters an on-premises instance with AWS CodeDeploy, but it does not delete the IAM user associated with the instance, nor does it disassociate in AWS CodeDeploy the on-premises instance tags from the instance. It also does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. :: + + aws deploy deregister-on-premises-instance --instance-name AssetTag12010298EX + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/deregister.rst b/aws/dist/awscli/examples/deploy/deregister.rst new file mode 100755 index 00000000..91215aa1 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/deregister.rst @@ -0,0 +1,18 @@ +**To deregister an on-premises instance** + +The following ``deregister`` example deregisters an on-premises instance with AWS CodeDeploy. It does not delete the IAM user that is associated with the instance. It disassociates in AWS CodeDeploy the on-premises tags from the instance. It does not uninstall the AWS CodeDeploy Agent from the instance nor remove the on-premises configuration file from the instance. :: + + aws deploy deregister \ + --instance-name AssetTag12010298EX \ + --no-delete-iam-user \ + --region us-west-2 + +Output:: + + Retrieving on-premises instance information... DONE + IamUserArn: arn:aws:iam::80398EXAMPLE:user/AWS/CodeDeploy/AssetTag12010298EX + Tags: Key=Name,Value=CodeDeployDemo-OnPrem + Removing tags from the on-premises instance... DONE + Deregistering the on-premises instance... DONE + Run the following command on the on-premises instance to uninstall the codedeploy-agent: + aws deploy uninstall diff --git a/aws/dist/awscli/examples/deploy/get-application-revision.rst b/aws/dist/awscli/examples/deploy/get-application-revision.rst new file mode 100755 index 00000000..671e16ad --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-application-revision.rst @@ -0,0 +1,29 @@ +**To get information about an application revision** + +The following ``get-application-revision`` example displays information about an application revision that is associated with the specified application. :: + + aws deploy get-application-revision \ + --application-name WordPress_App \ + --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip + +Output:: + + { + "applicationName": "WordPress_App", + "revisionInfo": { + "description": "Application revision registered by Deployment ID: d-A1B2C3111", + "registerTime": 1411076520.009, + "deploymentGroups": "WordPress_DG", + "lastUsedTime": 1411076520.009, + "firstUsedTime": 1411076520.009 + }, + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "dd56cfdEXAMPLE8e768f9d77fEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + } + } diff --git a/aws/dist/awscli/examples/deploy/get-application.rst b/aws/dist/awscli/examples/deploy/get-application.rst new file mode 100755 index 00000000..d645219b --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-application.rst @@ -0,0 +1,16 @@ +**To get information about an application** + +The following ``get-application`` example displays information about an application that is associated with the user's AWS account. :: + + aws deploy get-application --application-name WordPress_App + +Output:: + + { + "application": { + "applicationName": "WordPress_App", + "applicationId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "createTime": 1407878168.078, + "linkedToGitHub": false + } + } diff --git a/aws/dist/awscli/examples/deploy/get-deployment-config.rst b/aws/dist/awscli/examples/deploy/get-deployment-config.rst new file mode 100755 index 00000000..0e0c8269 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-deployment-config.rst @@ -0,0 +1,19 @@ +**To get information about a deployment configuration** + +The following ``get-deployment-config`` example displays information about a deployment configuration that is associated with the user's AWS account. :: + + aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy + +Output:: + + { + "deploymentConfigInfo": { + "deploymentConfigId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "minimumHealthyHosts": { + "type": "FLEET_PERCENT", + "value": 75 + }, + "createTime": 1411081164.379, + "deploymentConfigName": "ThreeQuartersHealthy" + } + } diff --git a/aws/dist/awscli/examples/deploy/get-deployment-group.rst b/aws/dist/awscli/examples/deploy/get-deployment-group.rst new file mode 100755 index 00000000..fbb7853d --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-deployment-group.rst @@ -0,0 +1,29 @@ +**To view information about a deployment group** + +The following ``get-deployment-group`` example displays information about a deployment group that is associated with the specified application. :: + + aws deploy get-deployment-group \ + --application-name WordPress_App \ + --deployment-group-name WordPress_DG + +Output:: + + { + "deploymentGroupInfo": { + "applicationName": "WordPress_App", + "autoScalingGroups": [ + "CodeDeployDemo-ASG" + ], + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "ec2TagFilters": [ + { + "Type": "KEY_AND_VALUE", + "Value": "CodeDeployDemo", + "Key": "Name" + } + ], + "deploymentGroupId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "serviceRoleArn": "arn:aws:iam::123456789012:role/CodeDeployDemoRole", + "deploymentGroupName": "WordPress_DG" + } + } diff --git a/aws/dist/awscli/examples/deploy/get-deployment-instance.rst b/aws/dist/awscli/examples/deploy/get-deployment-instance.rst new file mode 100755 index 00000000..bdc91ffe --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-deployment-instance.rst @@ -0,0 +1,58 @@ +**To get information about a deployment instance** + +The following ``get-deployment-instance`` example displays information about a deployment instance that is associated with the specified deployment. :: + + aws deploy get-deployment-instance --deployment-id d-QA4G4F9EX --instance-id i-902e9fEX + +Output:: + + { + "instanceSummary": { + "instanceId": "arn:aws:ec2:us-east-1:80398EXAMPLE:instance/i-902e9fEX", + "lifecycleEvents": [ + { + "status": "Succeeded", + "endTime": 1408480726.569, + "startTime": 1408480726.437, + "lifecycleEventName": "ApplicationStop" + }, + { + "status": "Succeeded", + "endTime": 1408480728.016, + "startTime": 1408480727.665, + "lifecycleEventName": "DownloadBundle" + }, + { + "status": "Succeeded", + "endTime": 1408480729.744, + "startTime": 1408480729.125, + "lifecycleEventName": "BeforeInstall" + }, + { + "status": "Succeeded", + "endTime": 1408480730.979, + "startTime": 1408480730.844, + "lifecycleEventName": "Install" + }, + { + "status": "Failed", + "endTime": 1408480732.603, + "startTime": 1408480732.1, + "lifecycleEventName": "AfterInstall" + }, + { + "status": "Skipped", + "endTime": 1408480732.606, + "lifecycleEventName": "ApplicationStart" + }, + { + "status": "Skipped", + "endTime": 1408480732.606, + "lifecycleEventName": "ValidateService" + } + ], + "deploymentId": "d-QA4G4F9EX", + "lastUpdatedAt": 1408480733.152, + "status": "Failed" + } + } diff --git a/aws/dist/awscli/examples/deploy/get-deployment-target.rst b/aws/dist/awscli/examples/deploy/get-deployment-target.rst new file mode 100755 index 00000000..81258b0f --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-deployment-target.rst @@ -0,0 +1,110 @@ +**To return information about a deployment target** + +The following ``get-deployment-target`` example returns information about a deployment target that is associated with the specified deployment. :: + + aws deploy get-deployment-target \ + --deployment-id "d-A1B2C3111" \ + --target-id "i-a1b2c3d4e5f611111" + +Output:: + + { + "deploymentTarget": { + "deploymentTargetType": "InstanceTarget", + "instanceTarget": { + "lastUpdatedAt": 1556918687.504, + "targetId": "i-a1b2c3d4e5f611111", + "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-a1b2c3d4e5f611111", + "status": "Succeeded", + "lifecycleEvents": [ + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ApplicationStop", + "startTime": 1556918592.162, + "endTime": 1556918592.247 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "DownloadBundle", + "startTime": 1556918593.193, + "endTime": 1556918593.981 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "BeforeInstall", + "startTime": 1556918594.805, + "endTime": 1556918681.807 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "Install", + "startTime": 1556918682.696, + "endTime": 1556918683.005 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "AfterInstall", + "startTime": 1556918684.135, + "endTime": 1556918684.216 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ApplicationStart", + "startTime": 1556918685.211, + "endTime": 1556918685.295 + }, + { + "status": "Succeeded", + "diagnostics": { + "errorCode": "Success", + "message": "Succeeded", + "logTail": "", + "scriptName": "" + }, + "lifecycleEventName": "ValidateService", + "startTime": 1556918686.65, + "endTime": 1556918686.747 + } + ], + "deploymentId": "d-A1B2C3111" + } + } + } + +For more information, see `GetDeploymentTarget `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/get-deployment.rst b/aws/dist/awscli/examples/deploy/get-deployment.rst new file mode 100755 index 00000000..8bdc8255 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-deployment.rst @@ -0,0 +1,38 @@ +**To get information about a deployment** + +The following ``get-deployment`` example displays information about a deployment that is associated with the user's AWS account. :: + + aws deploy get-deployment --deployment-id d-A1B2C3123 + +Output:: + + { + "deploymentInfo": { + "applicationName": "WordPress_App", + "status": "Succeeded", + "deploymentOverview": { + "Failed": 0, + "InProgress": 0, + "Skipped": 0, + "Succeeded": 1, + "Pending": 0 + }, + "deploymentConfigName": "CodeDeployDefault.OneAtATime", + "creator": "user", + "description": "My WordPress app deployment", + "revision": { + "revisionType": "S3", + "s3Location": { + "bundleType": "zip", + "eTag": "\"dd56cfdEXAMPLE8e768f9d77fEXAMPLE\"", + "bucket": "CodeDeployDemoBucket", + "key": "WordPressApp.zip" + } + }, + "deploymentId": "d-A1B2C3123", + "deploymentGroupName": "WordPress_DG", + "createTime": 1409764576.589, + "completeTime": 1409764596.101, + "ignoreApplicationStopFailures": false + } + } diff --git a/aws/dist/awscli/examples/deploy/get-on-premises-instance.rst b/aws/dist/awscli/examples/deploy/get-on-premises-instance.rst new file mode 100755 index 00000000..6b8520a8 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/get-on-premises-instance.rst @@ -0,0 +1,22 @@ +**To get information about an on-premises instance** + +The following ``get-on-premises-instance`` example retrieves information about the specified on-premises instance. :: + + aws deploy get-on-premises-instance --instance-name AssetTag12010298EX + +Output:: + + { + "instanceInfo": { + "iamUserArn": "arn:aws:iam::123456789012:user/AWS/CodeDeploy/AssetTag12010298EX", + "tags": [ + { + "Value": "CodeDeployDemo-OnPrem", + "Key": "Name" + } + ], + "instanceName": "AssetTag12010298EX", + "registerTime": 1425579465.228, + "instanceArn": "arn:aws:codedeploy:us-east-1:123456789012:instance/AssetTag12010298EX_4IwLNI2Alh" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/install.rst b/aws/dist/awscli/examples/deploy/install.rst new file mode 100755 index 00000000..8696e5d2 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/install.rst @@ -0,0 +1,14 @@ +**To install an on-premises instance** + +The following ``install`` example copies the on-premises configuration file from the specified location on the instance to the location on the instance that the AWS CodeDeploy Agent expects to find it. It also installs the AWS CodeDeploy Agent on the instance. It does not create any IAM user, nor register the on-premises instance with AWS CodeDeploy, nor associate any on-premises instance tags in AWS CodeDeploy for the instance. :: + + aws deploy install \ + --override-config \ + --config-file C:\temp\codedeploy.onpremises.yml \ + --region us-west-2 \ + --agent-installer s3://aws-codedeploy-us-west-2/latest/codedeploy-agent.msi + +Output:: + + Creating the on-premises instance configuration file... DONE + Installing the AWS CodeDeploy Agent... DONE diff --git a/aws/dist/awscli/examples/deploy/list-application-revisions.rst b/aws/dist/awscli/examples/deploy/list-application-revisions.rst new file mode 100755 index 00000000..fc199fd1 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-application-revisions.rst @@ -0,0 +1,36 @@ +**To get information about application revisions** + +The following ``list-application-revisions`` example displays information about all application revisions that are associated with the specified application. :: + + aws deploy list-application-revisions \ + --application-name WordPress_App \ + --s-3-bucket CodeDeployDemoBucket \ + --deployed exclude \ + --s-3-key-prefix WordPress_ \ + --sort-by lastUsedTime \ + --sort-order descending + +Output:: + + { + "revisions": [ + { + "revisionType": "S3", + "s3Location": { + "version": "uTecLusvCB_JqHFXtfUcyfV8bEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPress_App.zip", + "bundleType": "zip" + } + }, + { + "revisionType": "S3", + "s3Location": { + "version": "tMk.UxgDpMEVb7V187ZM6wVAWEXAMPLE", + "bucket": "CodeDeployDemoBucket", + "key": "WordPress_App_2-0.zip", + "bundleType": "zip" + } + } + ] + } diff --git a/aws/dist/awscli/examples/deploy/list-applications.rst b/aws/dist/awscli/examples/deploy/list-applications.rst new file mode 100755 index 00000000..fb169bdc --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-applications.rst @@ -0,0 +1,14 @@ +**To get information about applications** + +The following ``list-applications`` example displays information about all applications that are associated with the user's AWS account. :: + + aws deploy list-applications + +Output:: + + { + "applications": [ + "WordPress_App", + "MyOther_App" + ] + } diff --git a/aws/dist/awscli/examples/deploy/list-deployment-configs.rst b/aws/dist/awscli/examples/deploy/list-deployment-configs.rst new file mode 100755 index 00000000..0fbb6cbd --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-deployment-configs.rst @@ -0,0 +1,16 @@ +**To get information about deployment configurations** + +The following ``list-deployment-configs`` example displays information about all deployment configurations that are associated with the user's AWS account. :: + + aws deploy list-deployment-configs + +Output:: + + { + "deploymentConfigsList": [ + "ThreeQuartersHealthy", + "CodeDeployDefault.AllAtOnce", + "CodeDeployDefault.HalfAtATime", + "CodeDeployDefault.OneAtATime" + ] + } diff --git a/aws/dist/awscli/examples/deploy/list-deployment-groups.rst b/aws/dist/awscli/examples/deploy/list-deployment-groups.rst new file mode 100755 index 00000000..9b19b319 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-deployment-groups.rst @@ -0,0 +1,15 @@ +**To get information about deployment groups** + +The following ``list-deployment-groups`` example displays information about all deployment groups that are associated with the specified application. :: + + aws deploy list-deployment-groups --application-name WordPress_App + +Output:: + + { + "applicationName": "WordPress_App", + "deploymentGroups": [ + "WordPress_DG", + "WordPress_Beta_DG" + ] + } diff --git a/aws/dist/awscli/examples/deploy/list-deployment-instances.rst b/aws/dist/awscli/examples/deploy/list-deployment-instances.rst new file mode 100755 index 00000000..f78e457f --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-deployment-instances.rst @@ -0,0 +1,16 @@ +**To get information about deployment instances** + +The following ``list-deployment-instances`` example displays information about all deployment instances that are associated with the specified deployment. :: + + aws deploy list-deployment-instances \ + --deployment-id d-A1B2C3111 \ + --instance-status-filter Succeeded + +Output:: + + { + "instancesList": [ + "i-EXAMPLE11", + "i-EXAMPLE22" + ] + } diff --git a/aws/dist/awscli/examples/deploy/list-deployment-targets.rst b/aws/dist/awscli/examples/deploy/list-deployment-targets.rst new file mode 100755 index 00000000..ee26a7eb --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-deployment-targets.rst @@ -0,0 +1,17 @@ +**To retrieve a list of target IDs that are associated with a deployment** + +The following ``list-deployment-targets`` example retrieves a list of target IDs associated with deployments that have a status of "Failed" or "InProgress." :: + + aws deploy list-deployment-targets \ + --deployment-id "d-A1B2C3111" \ + --target-filters "{\"TargetStatus\":[\"Failed\",\"InProgress\"]}" + +Output:: + + { + "targetIds": [ + "i-0f1558aaf90e5f1f9" + ] + } + +For more information, see `ListDeploymentTargets `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/list-deployments.rst b/aws/dist/awscli/examples/deploy/list-deployments.rst new file mode 100755 index 00000000..7cf538a1 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-deployments.rst @@ -0,0 +1,19 @@ +**To get information about deployments** + +The follwoing ``list-deployments`` example displays information about all deployments that are associated with the specified application and deployment group. :: + + aws deploy list-deployments \ + --application-name WordPress_App \ + --create-time-range start=2014-08-19T00:00:00,end=2014-08-20T00:00:00 \ + --deployment-group-name WordPress_DG \ + --include-only-statuses Failed + +Output:: + + { + "deployments": [ + "d-EXAMPLE11", + "d-EXAMPLE22", + "d-EXAMPLE33" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/list-git-hub-account-token-names.rst b/aws/dist/awscli/examples/deploy/list-git-hub-account-token-names.rst new file mode 100755 index 00000000..dc7aa2d0 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-git-hub-account-token-names.rst @@ -0,0 +1,17 @@ +**To lists the names of stored connections to GitHub accounts** + +The following ``list-git-hub-account-token-names`` example lists the names of the stored connections to GitHub accounts for the current AWS user. :: + + aws deploy list-git-hub-account-token-names + +Output:: + + { + "tokenNameList": [ + "my-first-token", + "my-second-token", + "my-third-token" + ] + } + +For more information, see `ListGitHubAccountTokenNames `_ in the *AWS CodeDeploy API Reference*. diff --git a/aws/dist/awscli/examples/deploy/list-on-premises-instances.rst b/aws/dist/awscli/examples/deploy/list-on-premises-instances.rst new file mode 100755 index 00000000..3b5a4548 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/list-on-premises-instances.rst @@ -0,0 +1,15 @@ +**To get information about one or more on-premises instances** + +The following ``list-on-premises-instances`` example retrieves a list of available on-premises instance names for instances that are registered in AWS CodeDeploy and also have the specified on-premises instance tag associated in AWS CodeDeploy with the instance. :: + + aws deploy list-on-premises-instances \ + --registration-status Registered \ + --tag-filters Key=Name,Value=CodeDeployDemo-OnPrem,Type=KEY_AND_VALUE + +Output:: + + { + "instanceNames": [ + "AssetTag12010298EX" + ] + } diff --git a/aws/dist/awscli/examples/deploy/push.rst b/aws/dist/awscli/examples/deploy/push.rst new file mode 100755 index 00000000..ea30dc58 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/push.rst @@ -0,0 +1,15 @@ +**To bundle and deploy an AWS CodeDeploy compatible application revision to Amazon S3** + +The following ``push`` example bundles and deploys an application revision to Amazon S3 and then associates the application revision with the specified application. :: + + aws deploy push \ + --application-name WordPress_App \ + --description "This is my deployment" \ + --ignore-hidden-files \ + --s3-location s3://CodeDeployDemoBucket/WordPressApp.zip \ + --source /tmp/MyLocalDeploymentFolder/ + +The output describes how to use the ``create-deployment`` command to create a deployment that uses the uploaded application revision. :: + + To deploy with this revision, run: + aws deploy create-deployment --application-name WordPress_App --deployment-config-name --deployment-group-name --s3-location bucket=CodeDeployDemoBucket,key=WordPressApp.zip,bundleType=zip,eTag="cecc9b8EXAMPLE50a6e71fdb88EXAMPLE",version=LFsJAUdEXAMPLEfvKtvi79L8EXAMPLE \ No newline at end of file diff --git a/aws/dist/awscli/examples/deploy/register-application-revision.rst b/aws/dist/awscli/examples/deploy/register-application-revision.rst new file mode 100755 index 00000000..49a03130 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/register-application-revision.rst @@ -0,0 +1,10 @@ +**To register information about an already-uploaded application revision** + +The following ``register-application-revision`` example registers information about an already-uploaded application revision stored in Amazon S3 with AWS CodeDeploy. :: + + aws deploy register-application-revision \ + --application-name WordPress_App \ + --description "Revised WordPress application" \ + --s3-location bucket=CodeDeployDemoBucket,key=RevisedWordPressApp.zip,bundleType=zip,eTag=cecc9b8a08eac650a6e71fdb88EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/register-on-premises-instance.rst b/aws/dist/awscli/examples/deploy/register-on-premises-instance.rst new file mode 100755 index 00000000..a2e36cfa --- /dev/null +++ b/aws/dist/awscli/examples/deploy/register-on-premises-instance.rst @@ -0,0 +1,9 @@ +**To register an on-premises instance** + +The following ``register-on-premises-instance`` example registers an on-premises instance with AWS CodeDeploy. It does not create the specified IAM user, nor does it associate in AWS CodeDeploy any on-premises instances tags with the registered instance. :: + + aws deploy register-on-premises-instance \ + --instance-name AssetTag12010298EX \ + --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployDemoUser-OnPrem + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/register.rst b/aws/dist/awscli/examples/deploy/register.rst new file mode 100755 index 00000000..5bea0080 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/register.rst @@ -0,0 +1,16 @@ +**To register an on-premises instance** + +The following ``register`` example registers an on-premises instance with AWS CodeDeploy, associates in AWS CodeDeploy the specified on-premises instance tag with the registered instance, and creates an on-premises configuration file that can be copied to the instance. It does not create the IAM user, nor does it install the AWS CodeDeploy Agent on the instance. :: + + aws deploy register \ + --instance-name AssetTag12010298EX \ + --iam-user-arn arn:aws:iam::80398EXAMPLE:user/CodeDeployUser-OnPrem \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem \ + --region us-west-2 + +Output:: + + Registering the on-premises instance... DONE + Adding tags to the on-premises instance... DONE + Copy the on-premises configuration file named codedeploy.onpremises.yml to the on-premises instance, and run the following command on the on-premises instance to install and configure the AWS CodeDeploy Agent: + aws deploy install --config-file codedeploy.onpremises.yml diff --git a/aws/dist/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst b/aws/dist/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst new file mode 100755 index 00000000..a7ab7659 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/remove-tags-from-on-premises-instances.rst @@ -0,0 +1,9 @@ +**To remove tags from one or more on-premises instances** + +The following ``remove-tags-from-on-premises-instances`` example disassociates the specified on-premises tags in AWS CodeDeploy from on-premises instances. It does not deregister the on-premises instances in AWS CodeDeploy, nor uninstall the AWS CodeDeploy Agent from the instance, nor remove the on-premises configuration file from the instances, nor delete the IAM users that are associated with the instances. :: + + aws deploy remove-tags-from-on-premises-instances \ + --instance-names AssetTag12010298EX AssetTag23121309EX \ + --tags Key=Name,Value=CodeDeployDemo-OnPrem + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/stop-deployment.rst b/aws/dist/awscli/examples/deploy/stop-deployment.rst new file mode 100755 index 00000000..ad13a7fc --- /dev/null +++ b/aws/dist/awscli/examples/deploy/stop-deployment.rst @@ -0,0 +1,12 @@ +**To attempt to stop a deployment** + +The following ``stop-deployment`` example attempts to stop an in-progress deployment that is associated with the user's AWS account. + + aws deploy stop-deployment --deployment-id d-A1B2C3111 + +Output:: + + { + "status": "Succeeded", + "statusMessage": "No more commands will be scheduled for execution in the deployment instances" + } diff --git a/aws/dist/awscli/examples/deploy/uninstall.rst b/aws/dist/awscli/examples/deploy/uninstall.rst new file mode 100755 index 00000000..b53da214 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/uninstall.rst @@ -0,0 +1,7 @@ +**To uninstall an on-premises instance** + +The following ``uninstall`` example uninstalls the AWS CodeDeploy Agent from the on-premises instance and removes the on-premises configuration file from the instance. It doesn't deregister the instance in AWS CodeDeploy, nor disassociate any on-premises instance tags in AWS CodeDeploy from the instance, nor delete the IAM user that is associated with the instance. :: + + aws deploy uninstall + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/update-application.rst b/aws/dist/awscli/examples/deploy/update-application.rst new file mode 100755 index 00000000..72282426 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/update-application.rst @@ -0,0 +1,9 @@ +**To change details of an application** + +The following ``update-application`` example changes the name of an application that is associated with the user's AWS account. :: + + aws deploy update-application \ + --application-name WordPress_App \ + --new-application-name My_WordPress_App + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/update-deployment-group.rst b/aws/dist/awscli/examples/deploy/update-deployment-group.rst new file mode 100755 index 00000000..5c0861f3 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/update-deployment-group.rst @@ -0,0 +1,14 @@ +**To change information about a deployment group** + +The following ``update-deployment-group`` example changes the settings of a deployment group that is associated with the specified application. :: + + aws deploy update-deployment-group \ + --application-name WordPress_App \ + --auto-scaling-groups My_CodeDeployDemo_ASG \ + --current-deployment-group-name WordPress_DG \ + --deployment-config-name CodeDeployDefault.AllAtOnce \ + --ec2-tag-filters Key=Name,Type=KEY_AND_VALUE,Value=My_CodeDeployDemo \ + --new-deployment-group-name My_WordPress_DepGroup \ + --service-role-arn arn:aws:iam::80398EXAMPLE:role/CodeDeployDemo-2 + +This command produces no output. diff --git a/aws/dist/awscli/examples/deploy/wait/deployment-successful.rst b/aws/dist/awscli/examples/deploy/wait/deployment-successful.rst new file mode 100755 index 00000000..fe841a89 --- /dev/null +++ b/aws/dist/awscli/examples/deploy/wait/deployment-successful.rst @@ -0,0 +1,7 @@ +**To pause script operations until a deployment is flagged as successful** + +The following ``wait deployment-successful`` example pauses until the specified deployment completes successfully. :: + + aws deploy wait deployment-successful --deployment-id d-A1B2C3111 + +This command produces no output, but pauses operation until the condition is met. It generates an error if the condition is not met after 120 checks that are 15 seconds apart. diff --git a/aws/dist/awscli/examples/devicefarm/create-device-pool.rst b/aws/dist/awscli/examples/devicefarm/create-device-pool.rst new file mode 100644 index 00000000..61b4cd12 --- /dev/null +++ b/aws/dist/awscli/examples/devicefarm/create-device-pool.rst @@ -0,0 +1,32 @@ +**To create a device pool** + +The following command creates an Android device pool for a project:: + + aws devicefarm create-device-pool --name pool1 --rules file://device-pool-rules.json --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" + +You can get the project ARN from the output of ``create-project`` or ``list-projects``. The file ``device-pool-rules.json`` is a JSON document in the current folder that specifies the device platform:: + + [ + { + "attribute": "PLATFORM", + "operator": "EQUALS", + "value": "\"ANDROID\"" + } + ] + +Output:: + + { + "devicePool": { + "rules": [ + { + "operator": "EQUALS", + "attribute": "PLATFORM", + "value": "\"ANDROID\"" + } + ], + "type": "PRIVATE", + "name": "pool1", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:devicepool:070fc3ca-7ec1-4741-9c1f-d3e044efc506/2aa8d2a9-5e73-47ca-b929-659cb34b7dcd" + } + } diff --git a/aws/dist/awscli/examples/devicefarm/create-project.rst b/aws/dist/awscli/examples/devicefarm/create-project.rst new file mode 100644 index 00000000..32ef6a64 --- /dev/null +++ b/aws/dist/awscli/examples/devicefarm/create-project.rst @@ -0,0 +1,15 @@ +**To create a project** + +The following command creates a new project named ``my-project``:: + + aws devicefarm create-project --name my-project + +Output:: + + { + "project": { + "name": "myproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", + "created": 1503612890.057 + } + } diff --git a/aws/dist/awscli/examples/devicefarm/create-upload.rst b/aws/dist/awscli/examples/devicefarm/create-upload.rst new file mode 100644 index 00000000..bb7e3f96 --- /dev/null +++ b/aws/dist/awscli/examples/devicefarm/create-upload.rst @@ -0,0 +1,24 @@ +**To create an upload** + +The following command creates an upload for an Android app:: + + aws devicefarm create-upload --project-arn "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506" --name app.apk --type ANDROID_APP + +You can get the project ARN from the output of `create-project` or `list-projects`. + +Output:: + + { + "upload": { + "status": "INITIALIZED", + "name": "app.apk", + "created": 1503614408.769, + "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f", + "type": "ANDROID_APP", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" + } + } + +Use the signed URL in the output to upload a file to Device Farm:: + + curl -T app.apk "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aproject%3A070fc3ca-c7e1-4471-91cf-d3e4efc50604/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A123456789012%3Aupload%3A070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514/app.apk?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20170824T224008Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAEXAMPLEPBUMBC3GA%2F20170824%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=05050370c38894ef5bd09f5d009f36fc8f96fa4bb04e1bba9aca71b8dbe49a0f" diff --git a/aws/dist/awscli/examples/devicefarm/get-upload.rst b/aws/dist/awscli/examples/devicefarm/get-upload.rst new file mode 100644 index 00000000..e42a9a9d --- /dev/null +++ b/aws/dist/awscli/examples/devicefarm/get-upload.rst @@ -0,0 +1,21 @@ +**To view an upload** + +The following command retrieves information about an upload:: + + aws devicefarm get-upload --arn "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514" + +You can get the upload ARN from the output of ``create-upload``. + +Output:: + + { + "upload": { + "status": "SUCCEEDED", + "name": "app.apk", + "created": 1505262773.186, + "type": "ANDROID_APP", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:upload:070fc3ca-7ec1-4741-9c1f-d3e044efc506/dd72723a-ae9e-4087-09e6-f4cea3599514", + "metadata": "{\"device_admin\":false,\"activity_name\":\"ccom.example.client.LauncherActivity\",\"version_name\":\"1.0.2.94\",\"screens\":[\"small\",\"normal\",\"large\",\"xlarge\"],\"error_type\":null,\"sdk_version\":\"16\",\"package_name\":\"com.example.client\",\"version_code\":\"20994\",\"native_code\":[\"armeabi-v7a\"],\"target_sdk_version\":\"25\"}" + } + } + diff --git a/aws/dist/awscli/examples/devicefarm/list-projects.rst b/aws/dist/awscli/examples/devicefarm/list-projects.rst new file mode 100644 index 00000000..ad0f7159 --- /dev/null +++ b/aws/dist/awscli/examples/devicefarm/list-projects.rst @@ -0,0 +1,22 @@ +**To list projects** + +The following retrieves a list of projects:: + + aws devicefarm list-projects + +Output:: + + { + "projects": [ + { + "name": "myproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:070fc3ca-7ec1-4741-9c1f-d3e044efc506", + "created": 1503612890.057 + }, + { + "name": "otherproject", + "arn": "arn:aws:devicefarm:us-west-2:123456789012:project:a5f5b752-8098-49d1-86bf-5f7682c1c77e", + "created": 1505257519.337 + } + ] + } diff --git a/aws/dist/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst b/aws/dist/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst new file mode 100755 index 00000000..9a6905f6 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/accept-direct-connect-gateway-association-proposal.rst @@ -0,0 +1,30 @@ +**To accept a gateway association proposal** + +The following ``accept-direct-connect-gateway-association-proposal`` accepts the specified proposal. :: + + aws directconnect accept-direct-connect-gateway-association-proposal \ + --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ + --proposal-id cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE \ + --associated-gateway-owner-account 111122223333 + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "associationState": "associating", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "associationId": "6441f8bf-5917-4279-ade1-9708bEXAMPLE", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Accepting or Rejecting a Transit Gateway Association Proposal `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/allocate-connection-on-interconnect.rst b/aws/dist/awscli/examples/directconnect/allocate-connection-on-interconnect.rst new file mode 100644 index 00000000..5efbf07d --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/allocate-connection-on-interconnect.rst @@ -0,0 +1,19 @@ +**To create a hosted connection on an interconnect** + +The following ``allocate-connection-on-interconnect`` command creates a hosted connection on an interconnect:: + + aws directconnect allocate-connection-on-interconnect --bandwidth 500Mbps --connection-name mydcinterconnect --owner-account 123456789012 --interconnect-id dxcon-fgktov66 --vlan 101 + +Output:: + + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/allocate-hosted-connection.rst b/aws/dist/awscli/examples/directconnect/allocate-hosted-connection.rst new file mode 100644 index 00000000..4c3c4377 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/allocate-hosted-connection.rst @@ -0,0 +1,24 @@ +**To create a hosted connection on an interconnect** + +The following ``allocate-hosted-connection`` example creates a hosted connection on the specified interconnect. :: + + aws directconnect allocate-hosted-connection \ + --bandwidth 500Mbps \ + --connection-name mydcinterconnect \ + --owner-account 123456789012 + -connection-id dxcon-fgktov66 + -vlan 101 + +Output:: + + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } diff --git a/aws/dist/awscli/examples/directconnect/allocate-private-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/allocate-private-virtual-interface.rst new file mode 100644 index 00000000..78cab01f --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/allocate-private-virtual-interface.rst @@ -0,0 +1,24 @@ +**To provision a private virtual interface** + +The following ``allocate-private-virtual-interface`` command provisions a private virtual interface to be owned by a different customer:: + + aws directconnect allocate-private-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-private-virtual-interface-allocation virtualInterfaceName=PrivateVirtualInterface,vlan=1000,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30 + +Output:: + + { + "virtualInterfaceState": "confirming", + "asn": 65000, + "vlan": 1000, + "customerAddress": "192.168.1.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualInterfaceId": "dxvif-fgy8orxu", + "authKey": "asdf34example", + "routeFilterPrefixes": [], + "location": "TIVIT", + "customerRouterConfig": "\n \n 1000\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", + "amazonAddress": "192.168.1.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "PrivateVirtualInterface" + } diff --git a/aws/dist/awscli/examples/directconnect/allocate-public-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/allocate-public-virtual-interface.rst new file mode 100644 index 00000000..57157db4 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/allocate-public-virtual-interface.rst @@ -0,0 +1,31 @@ +**To provision a public virtual interface** + +The following ``allocate-public-virtual-interface`` command provisions a public virtual interface to be owned by a different customer:: + + aws directconnect allocate-public-virtual-interface --connection-id dxcon-ffjrkx17 --owner-account 123456789012 --new-public-virtual-interface-allocation virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}] + +Output:: + + { + "virtualInterfaceState": "confirming", + "asn": 65000, + "vlan": 2000, + "customerAddress": "203.0.113.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualInterfaceId": "dxvif-fg9xo9vp", + "authKey": "asdf34example", + "routeFilterPrefixes": [ + { + "cidr": "203.0.113.0/30" + }, + { + "cidr": "203.0.113.4/30" + } + ], + "location": "TIVIT", + "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", + "amazonAddress": "203.0.113.1/30", + "virtualInterfaceType": "public", + "virtualInterfaceName": "PublicVirtualInterface" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/allocate-transit-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/allocate-transit-virtual-interface.rst new file mode 100755 index 00000000..bcd63815 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/allocate-transit-virtual-interface.rst @@ -0,0 +1,58 @@ +**To provision a transit virtual interface to be owned by the specified AWS account** + +The following ``allocate-transit-virtual-interface`` example provisions a transit virtual interface for the specified account. :: + + aws directconnect allocate-transit-virtual-interface \ + --connection-id dxlag-fEXAMPLE \ + --owner-account 123456789012 \ + --new-transit-virtual-interface-allocation "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,tags=[{key=Tag,value=Example}]" + +Output:: + + { + "virtualInterface": { + "ownerAccount": "123456789012", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "TIVIT", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "Example Transit Virtual Interface", + "vlan": 126, + "asn": 65110, + "amazonSideAsn": 7224, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "confirming", + "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SEXAMPLE\n 7224\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-fEXAMPLE", + "asn": 65110, + "authKey": "0xzxgA9YoW9h58u8EXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "bgpPeerState": "pending", + "bgpStatus": "down", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE", + "tags": [ + { + "key": "Tag", + "value": "Example" + } + ] + } + } + +For more information, see `Creating a Hosted Transit Virtual Interface `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/associate-connection-with-lag.rst b/aws/dist/awscli/examples/directconnect/associate-connection-with-lag.rst new file mode 100644 index 00000000..bd98b3e1 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/associate-connection-with-lag.rst @@ -0,0 +1,20 @@ +**To associate a connection with a LAG** + +The following example associates the specified connection with the specified LAG. + +Command:: + + aws directconnect associate-connection-with-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "lagId": "dxlag-fhccu14t", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Con2ForLag", + "region": "us-east-1" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/associate-hosted-connection.rst b/aws/dist/awscli/examples/directconnect/associate-hosted-connection.rst new file mode 100644 index 00000000..3c177636 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/associate-hosted-connection.rst @@ -0,0 +1,22 @@ +**To associate a hosted connection with a LAG** + +The following example associates the specified hosted connection with the specified LAG. + +Command:: + + aws directconnect associate-hosted-connection --parent-connection-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "lagId": "dxlag-fhccu14t", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/associate-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/associate-virtual-interface.rst new file mode 100644 index 00000000..2e396109 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/associate-virtual-interface.rst @@ -0,0 +1,48 @@ +**To associate a virtual interface with a connection** + +The following example associates the specified virtual interface with the specified LAG. Alternatively, to associate the virtual interface with a connection, specify the ID of an AWS Direct Connect connection for ``--connection-id``; for example, ``dxcon-ffnikghc``. + +Command:: + + aws directconnect associate-virtual-interface --connection-id dxlag-ffjhj9lx --virtual-interface-id dxvif-fgputw0j + +Output:: + + { + "virtualInterfaceState": "pending", + "asn": 65000, + "vlan": 123, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxlag-ffjhj9lx", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-38e90b51", + "virtualInterfaceId": "dxvif-fgputw0j", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "routeFilterPrefixes": [], + "location": "CSVA1", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "bgpPeerState": "deleting", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0x123pK5_VBqv.UQ3kJ4123_", + "bgpPeerState": "pending", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + } + ], + "customerRouterConfig": "\n\n 123\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0x123pK5_VBqv.UQ3kJ4123_\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "VIF1A" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/confirm-connection.rst b/aws/dist/awscli/examples/directconnect/confirm-connection.rst new file mode 100644 index 00000000..2ebe49a2 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/confirm-connection.rst @@ -0,0 +1,11 @@ +**To confirm the creation of a hosted connection on an interconnect** + +The following ``confirm-connection`` command confirms the creation of a hosted connection on an interconnect:: + + aws directconnect confirm-connection --connection-id dxcon-fg2wi7hy + +Output:: + + { + "connectionState": "pending" + } diff --git a/aws/dist/awscli/examples/directconnect/confirm-private-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/confirm-private-virtual-interface.rst new file mode 100644 index 00000000..6c169222 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/confirm-private-virtual-interface.rst @@ -0,0 +1,11 @@ +**To accept ownership of a private virtual interface** + +The following ``confirm-private-virtual-interface`` command accepts ownership of a private virtual interface created by another customer:: + + aws directconnect confirm-private-virtual-interface --virtual-interface-id dxvif-fgy8orxu --virtual-gateway-id vgw-e4a47df9 + +Output:: + + { + "virtualInterfaceState": "pending" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/confirm-public-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/confirm-public-virtual-interface.rst new file mode 100644 index 00000000..8b659a92 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/confirm-public-virtual-interface.rst @@ -0,0 +1,11 @@ +**To accept ownership of a public virtual interface** + +The following ``confirm-public-virtual-interface`` command accepts ownership of a public virtual interface created by another customer:: + + aws directconnect confirm-public-virtual-interface --virtual-interface-id dxvif-fg9xo9vp + +Output:: + + { + "virtualInterfaceState": "verifying" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/confirm-transit-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/confirm-transit-virtual-interface.rst new file mode 100755 index 00000000..176915d7 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/confirm-transit-virtual-interface.rst @@ -0,0 +1,15 @@ +**To accept ownership of a transit virtual interface** + +The following ``confirm-transit-virtual-interface`` accepts ownership of a transit virtual interface created by another customer. :: + + aws directconnect confirm-transit-virtual-interface \ + --virtual-interface-id dxvif-fEXAMPLE \ + --direct-connect-gateway-id 4112ccf9-25e9-4111-8237-b6c5dEXAMPLE + +Output:: + + { + "virtualInterfaceState": "pending" + } + +For more information, see `Accepting a Hosted Virtual Interface `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/create-bgp-peer.rst b/aws/dist/awscli/examples/directconnect/create-bgp-peer.rst new file mode 100644 index 00000000..74229eef --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-bgp-peer.rst @@ -0,0 +1,50 @@ +**To create an IPv6 BGP peering session** + +The following example creates an IPv6 BGP peering session on private virtual interface ``dxvif-fg1vuj3d``. The peer IPv6 addresses are automatically allocated by Amazon. + +Command:: + + aws directconnect create-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --new-bgp-peer asn=64600,addressFamily=ipv6 + +Output:: + + { + "virtualInterface": { + "virtualInterfaceState": "available", + "asn": 65000, + "vlan": 125, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-f9eb0c90", + "virtualInterfaceId": "dxvif-fg1vuj3d", + "authKey": "0xC_ukbCerl6EYA0example", + "routeFilterPrefixes": [], + "location": "EqDC2", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0xC_ukbCerl6EYA0uexample", + "bgpPeerState": "available", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", + "addressFamily": "ipv6", + "authKey": "0xS27kAIU_VHPjjAexample", + "bgpPeerState": "pending", + "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", + "asn": 64600 + } + ], + "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0uexample\n 2001:db8:1100:2f0:0:1:9cb4:4216/125\n 2001:db8:1100:2f0:0:1:9cb4:4211/125\n 64600\n 0xS27kAIU_VHPjjAexample\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "Test" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-connection.rst b/aws/dist/awscli/examples/directconnect/create-connection.rst new file mode 100644 index 00000000..0ba878f4 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-connection.rst @@ -0,0 +1,17 @@ +**To create a connection from your network to an AWS Direct Connect location** + +The following ``create-connection`` command creates a connection from your network to an AWS Direct Connect location:: + + aws directconnect create-connection --location TIVIT --bandwidth 1Gbps --connection-name "Connection to AWS" + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg31dyv6", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "TIVIT", + "connectionName": "Connection to AWS", + "region": "sa-east-1" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst new file mode 100755 index 00000000..2a8b83b2 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association-proposal.rst @@ -0,0 +1,33 @@ +**To create a proposal to associate the specified transit gateway with the specified Direct Connect gateway** + +The following ``create-direct-connect-gateway-association-proposal`` example creates a proposal that associates the specified transit gateway with the specified Direct Connect gateway. :: + + aws directconnect create-direct-connect-gateway-association-proposal \ + --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \ + --direct-connect-gateway-owner-account 111122223333 \ + --gateway-id tgw-02f776b1a7EXAMPLE \ + --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.1.0/30 + +Output:: + + { + "directConnectGatewayAssociationProposal": { + "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "requested", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Creating a Transit Gateway Association Proposal `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association.rst b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association.rst new file mode 100644 index 00000000..a1ce40c3 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway-association.rst @@ -0,0 +1,19 @@ +**To associate a virtual private gateway with a Direct Connect gateway** + +The following example associates virtual private gateway ``vgw-6efe725e`` with Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. You must run the command in the region in which the virtual private gateway is located. + +Command:: + + aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e + +Output:: + + { + "directConnectGatewayAssociation": { + "associationState": "associating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-6efe725e", + "virtualGatewayRegion": "us-east-2" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway.rst b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway.rst new file mode 100644 index 00000000..4fa1f8b0 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-direct-connect-gateway.rst @@ -0,0 +1,19 @@ +**To create a Direct Connect gateway** + +The following example creates a Direct Connect gateway with the name ``DxGateway1``. + +Command:: + + aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1" + +Output:: + + { + "directConnectGateway": { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "available" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-interconnect.rst b/aws/dist/awscli/examples/directconnect/create-interconnect.rst new file mode 100644 index 00000000..8c0b3f02 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-interconnect.rst @@ -0,0 +1,16 @@ +**To create an interconnect between a partner's network and AWS** + +The following ``create-interconnect`` command creates an interconnect between an AWS Direct Connect partner's network and a specific AWS Direct Connect location:: + + aws directconnect create-interconnect --interconnect-name "1G Interconnect to AWS" --bandwidth 1Gbps --location TIVIT + +Output:: + + { + "region": "sa-east-1", + "bandwidth": "1Gbps", + "location": "TIVIT", + "interconnectName": "1G Interconnect to AWS", + "interconnectId": "dxcon-fgktov66", + "interconnectState": "requested" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-lag.rst b/aws/dist/awscli/examples/directconnect/create-lag.rst new file mode 100644 index 00000000..74ba9add --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-lag.rst @@ -0,0 +1,89 @@ +**To create a LAG with new connections** + +The following example creates a LAG and requests two new AWS Direct Connect connections for the LAG with a bandwidth of 1 Gbps. + +Command:: + + aws directconnect create-lag --location CSVA1 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 1GBLag + +Output:: + + { + "awsDevice": "CSVA1-23u8tlpaz8iks", + "numberOfConnections": 2, + "lagState": "pending", + "ownerAccount": "123456789012", + "lagName": "1GBLag", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffqr6x5q", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fflqyj95", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + } + ], + "lagId": "dxlag-ffjhj9lx", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "CSVA1" + } + +**To create a LAG using an existing connection** + +The following example creates a LAG from an existing connection in your account, and requests a second new connection for the LAG with the same bandwidth and location as the existing connection. + +Command:: + + aws directconnect create-lag --location EqDC2 --number-of-connections 2 --connections-bandwidth 1Gbps --lag-name 2ConnLAG --connection-id dxcon-fgk145dr + +Output:: + + { + "awsDevice": "EqDC2-4h6ce2r1bes6", + "numberOfConnections": 2, + "lagState": "pending", + "ownerAccount": "123456789012", + "lagName": "2ConnLAG", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fh6ljcvo", + "lagId": "dxlag-fhccu14t", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 1 for Lag dxlag-fhccu14t", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fgk145dr", + "lagId": "dxlag-fhccu14t", + "connectionState": "down", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "VAConn1", + "region": "us-east-1" + } + ], + "lagId": "dxlag-fhccu14t", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "EqDC2" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-private-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/create-private-virtual-interface.rst new file mode 100644 index 00000000..ff686afc --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-private-virtual-interface.rst @@ -0,0 +1,25 @@ +**To create a private virtual interface** + +The following ``create-private-virtual-interface`` command creates a private virtual interface:: + + aws directconnect create-private-virtual-interface --connection-id dxcon-ffjrkx17 --new-private-virtual-interface virtualInterfaceName=PrivateVirtualInterface,vlan=101,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,virtualGatewayId=vgw-aba37db6 + +Output:: + + { + "virtualInterfaceState": "pending", + "asn": 65000, + "vlan": 101, + "customerAddress": "192.168.1.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualGatewayId": "vgw-aba37db6", + "virtualInterfaceId": "dxvif-ffhhk74f", + "authKey": "asdf34example", + "routeFilterPrefixes": [], + "location": "TIVIT", + "customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", + "amazonAddress": "192.168.1.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "PrivateVirtualInterface" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-public-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/create-public-virtual-interface.rst new file mode 100644 index 00000000..266b6a78 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-public-virtual-interface.rst @@ -0,0 +1,31 @@ +**To create a public virtual interface** + +The following ``create-public-virtual-interface`` command creates a public virtual interface:: + + aws directconnect create-public-virtual-interface --connection-id dxcon-ffjrkx17 --new-public-virtual-interface virtualInterfaceName=PublicVirtualInterface,vlan=2000,asn=65000,authKey=asdf34example,amazonAddress=203.0.113.1/30,customerAddress=203.0.113.2/30,routeFilterPrefixes=[{cidr=203.0.113.0/30},{cidr=203.0.113.4/30}] + +Output:: + + { + "virtualInterfaceState": "verifying", + "asn": 65000, + "vlan": 2000, + "customerAddress": "203.0.113.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualInterfaceId": "dxvif-fgh0hcrk", + "authKey": "asdf34example", + "routeFilterPrefixes": [ + { + "cidr": "203.0.113.0/30" + }, + { + "cidr": "203.0.113.4/30" + } + ], + "location": "TIVIT", + "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", + "amazonAddress": "203.0.113.1/30", + "virtualInterfaceType": "public", + "virtualInterfaceName": "PublicVirtualInterface" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/create-transit-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/create-transit-virtual-interface.rst new file mode 100755 index 00000000..9d4b2504 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/create-transit-virtual-interface.rst @@ -0,0 +1,57 @@ +**To create a transit virtual interface** + +The following ``create-transit-virtual-interface`` example creates a transit virtual interface for the specified connection. :: + + ws directconnect create-transit-virtual-interface \ + --connection-id dxlag-fEXAMPLE \ + --new-transit-virtual-interface "virtualInterfaceName=Example Transit Virtual Interface,vlan=126,asn=65110,mtu=1500,authKey=0xzxgA9YoW9h58u8SvEXAMPLE,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,addressFamily=ipv4,directConnectGatewayId=8384da05-13ce-4a91-aada-5a1baEXAMPLE,tags=[{key=Tag,value=Example}]" + +Output:: + + { + "virtualInterface": { + "ownerAccount": "1111222233333", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "TIVIT", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "Example Transit Virtual Interface", + "vlan": 126, + "asn": 65110, + "amazonSideAsn": 4200000000, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "pending", + "customerRouterConfig": "\n\n 126\n 192.168.1.2/30\n 192.168.1.1/30\n 65110\n 0xzxgA9YoW9h58u8SvOmXRTw\n 4200000000\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-EXAMPLE", + "asn": 65110, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "192.168.1.1/30", + "customerAddress": "192.168.1.2/30", + "bgpPeerState": "pending", + "bgpStatus": "down", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE", + "tags": [ + { + "key": "Tag", + "value": "Example" + } + ] + } + } + +For more information, see `Creating a Transit Virtual Interface to the Direct Connect Gateway `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/delete-bgp-peer.rst b/aws/dist/awscli/examples/directconnect/delete-bgp-peer.rst new file mode 100644 index 00000000..860fcf10 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-bgp-peer.rst @@ -0,0 +1,50 @@ +**To delete a BGP peer from a virtual interface** + +The following example deletes the IPv6 BGP peer from virtual interface ``dxvif-fg1vuj3d``. + +Command:: + + aws directconnect delete-bgp-peer --virtual-interface-id dxvif-fg1vuj3d --asn 64600 --customer-address 2001:db8:1100:2f0:0:1:9cb4:4216/125 + +Output:: + + { + "virtualInterface": { + "virtualInterfaceState": "available", + "asn": 65000, + "vlan": 125, + "customerAddress": "169.254.255.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "addressFamily": "ipv4", + "virtualGatewayId": "vgw-f9eb0c90", + "virtualInterfaceId": "dxvif-fg1vuj3d", + "authKey": "0xC_ukbCerl6EYA0example", + "routeFilterPrefixes": [], + "location": "EqDC2", + "bgpPeers": [ + { + "bgpStatus": "down", + "customerAddress": "169.254.255.2/30", + "addressFamily": "ipv4", + "authKey": "0xC_ukbCerl6EYA0uexample", + "bgpPeerState": "available", + "amazonAddress": "169.254.255.1/30", + "asn": 65000 + }, + { + "bgpStatus": "down", + "customerAddress": "2001:db8:1100:2f0:0:1:9cb4:4216/125", + "addressFamily": "ipv6", + "authKey": "0xS27kAIU_VHPjjAexample", + "bgpPeerState": "deleting", + "amazonAddress": "2001:db8:1100:2f0:0:1:9cb4:4211/125", + "asn": 64600 + } + ], + "customerRouterConfig": "\n\n 125\n 169.254.255.2/30\n 169.254.255.1/30\n 65000\n 0xC_ukbCerl6EYA0example\n 7224\n private\n\n", + "amazonAddress": "169.254.255.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "Test" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/delete-connection.rst b/aws/dist/awscli/examples/directconnect/delete-connection.rst new file mode 100644 index 00000000..ace97365 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-connection.rst @@ -0,0 +1,17 @@ +**To delete a connection** + +The following ``delete-connection`` command deletes the specified connection:: + + aws directconnect delete-connection --connection-id dxcon-fg31dyv6 + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg31dyv6", + "connectionState": "deleted", + "bandwidth": "1Gbps", + "location": "TIVIT", + "connectionName": "Connection to AWS", + "region": "sa-east-1" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst b/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst new file mode 100644 index 00000000..081b60af --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway-association.rst @@ -0,0 +1,29 @@ +**To delete a Direct Connect gateway association** + +The following ``delete-direct-connect-gateway-association`` example deletes the Direct Connect gateway association with a transit gateway that has the specified association ID. :: + + aws directconnect delete-direct-connect-gateway-association --association-id be85116d-46eb-4b43-a27a-da0c2ad648de + +Output:: + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPlE", + "directConnectGatewayOwnerAccount": "123456789012", + "associationState": "disassociating", + "associatedGateway": { + "id": "tgw-095b3b0b54EXAMPLE", + "type": "transitGateway", + "ownerAccount": "123456789012", + "region": "us-east-1" + }, + "associationId": " be85116d-46eb-4b43-a27a-da0c2ad648deEXAMPLE ", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.0.1.0/28" + } + ] + } + } + +For more information, see `Associating and Disassociating Transit Gateways `_ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway.rst b/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway.rst new file mode 100644 index 00000000..1a4611bb --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-direct-connect-gateway.rst @@ -0,0 +1,19 @@ +**To delete a Direct Connect gateway** + +The following example deletes Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect delete-direct-connect-gateway --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "directConnectGateway": { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "deleting" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/delete-interconnect.rst b/aws/dist/awscli/examples/directconnect/delete-interconnect.rst new file mode 100644 index 00000000..0d372645 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-interconnect.rst @@ -0,0 +1,11 @@ +**To delete an interconnect** + +The following ``delete-interconnect`` command deletes the specified interconnect:: + + aws directconnect delete-interconnect --interconnect-id dxcon-fgktov66 + +Output:: + + { + "interconnectState": "deleted" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/delete-lag.rst b/aws/dist/awscli/examples/directconnect/delete-lag.rst new file mode 100644 index 00000000..42adba0d --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-lag.rst @@ -0,0 +1,23 @@ +**To delete a LAG** + +The following example deletes the specified LAG. + +Command:: + + aws directconnect delete-lag --lag-id dxlag-ffrhowd9 + +Output:: + + { + "awsDevice": "EqDC2-4h6ce2r1bes6", + "numberOfConnections": 0, + "lagState": "deleted", + "ownerAccount": "123456789012", + "lagName": "TestLAG", + "connections": [], + "lagId": "dxlag-ffrhowd9", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "EqDC2" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/delete-virtual-interface.rst b/aws/dist/awscli/examples/directconnect/delete-virtual-interface.rst new file mode 100644 index 00000000..2acc5066 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/delete-virtual-interface.rst @@ -0,0 +1,11 @@ +**To delete a virtual interface** + +The following ``delete-virtual-interface`` command deletes the specified virtual interface:: + + aws directconnect delete-virtual-interface --virtual-interface-id dxvif-ffhhk74f + +Output:: + + { + "virtualInterfaceState": "deleting" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-connection-loa.rst b/aws/dist/awscli/examples/directconnect/describe-connection-loa.rst new file mode 100644 index 00000000..79136fc6 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-connection-loa.rst @@ -0,0 +1,21 @@ +**To describe your LOA-CFA for a connection using Linux or Mac OS X** + +The following example describes your LOA-CFA for connection ``dxcon-fh6ayh1d``. The contents of the LOA-CFA are base64-encoded. This command uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure. The final part of the command decodes the content using the ``base64`` utility, and sends the output to a PDF file. + +.. code:: + + aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf + +**To describe your LOA-CFA for a connection using Windows** + +The previous example requires the use of the ``base64`` utility to decode the output. On a Windows computer, you can use ``certutil`` instead. In the following example, the first command describes your LOA-CFA for connection ``dxcon-fh6ayh1d`` and uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure to a file called ``myLoaCfa.base64``. The second command uses the ``certutil`` utility to decode the file and send the output to a PDF file. + +.. code:: + + aws directconnect describe-connection-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 + +.. code:: + + certutil -decode myLoaCfa.base64 myLoaCfa.pdf + +For more information about controlling AWS CLI output, see `Controlling Command Output from the AWS Command Line Interface `_ in the *AWS Command Line Interface User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-connections-on-interconnect.rst b/aws/dist/awscli/examples/directconnect/describe-connections-on-interconnect.rst new file mode 100644 index 00000000..464c1c8d --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-connections-on-interconnect.rst @@ -0,0 +1,23 @@ +**To list connections on an interconnect** + +The following ``describe-connections-on-interconnect`` command lists connections that have been provisioned on the given interconnect:: + + aws directconnect describe-connections-on-interconnect --interconnect-id dxcon-fgktov66 + +Output:: + + { + "connections": [ + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-connections.rst b/aws/dist/awscli/examples/directconnect/describe-connections.rst new file mode 100644 index 00000000..d0868461 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-connections.rst @@ -0,0 +1,24 @@ +**To list all connections in the current region** + +The following ``describe-connections`` command lists all connections in the current region:: + + aws directconnect describe-connections + +Output:: + + { + "connections": [ + { + "awsDevice": "EqDC2-123h49s71dabc", + "ownerAccount": "123456789012", + "connectionId": "dxcon-fguhmqlc", + "lagId": "dxlag-ffrz71kw", + "connectionState": "down", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "My_Connection", + "loaIssueTime": 1491568964.0, + "region": "us-east-1" + } + ] + } diff --git a/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst new file mode 100755 index 00000000..27ef9119 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-association-proposals.rst @@ -0,0 +1,64 @@ +**To describe your Direct Connect gateway association proposals** + +The following ``describe-direct-connect-gateway-association-proposals`` example displays details about your Direct Connect gateway association proposals. :: + + aws directconnect describe-direct-connect-gateway-association-proposals + +Output:: + + { + "directConnectGatewayAssociationProposals": [ + { + "proposalId": "c2ede9b4-bbc6-4d33-923c-bc4feEXAMPLE", + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "requested", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "existingAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.2.0/30" + }, + { + "cidr": "192.168.1.0/30" + } + ], + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.1.0/30" + } + ] + }, + { + "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE", + "directConnectGatewayId": "11560968-4ac1-4fd3-bcb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "proposalState": "accepted", + "associatedGateway": { + "id": "tgw-045776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "existingAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.4.0/30" + }, + { + "cidr": "192.168.5.0/30" + } + ], + "requestedAllowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.5.0/30" + } + ] + } + ] + } + +For more information, see `Associating and Disassociating Transit Gateways `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst new file mode 100644 index 00000000..17572c04 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-associations.rst @@ -0,0 +1,29 @@ +**To describe Direct Connect gateway associations** + +The following example describes all the associations with Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect describe-direct-connect-gateway-associations --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoiOU83OTFodzdycnZCbkN4MExHeHVwQT09IiwiYyI6InIxTEN0UEVHV0I1UFlkaWFnNlUxanJkRWF6eW1iOElHM0FRVW1MdHRJK0dxcnN1RWtvcFBKWFE2ZjRNRGdGTkhCa0tDZmVINEtZOEYwZ0dEYWZpbmU0ZnZMYVhKRjdXRVdENmdQZ1Y4d2w0PSJ9", + "directConnectGatewayAssociations": [ + { + "associationState": "associating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-6efe725e", + "virtualGatewayRegion": "us-east-2" + }, + { + "associationState": "disassociating", + "virtualGatewayOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualGatewayId": "vgw-ebaa27db", + "virtualGatewayRegion": "us-east-2" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst new file mode 100644 index 00000000..965d4a50 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateway-attachments.rst @@ -0,0 +1,22 @@ +**To describe Direct Connect gateway attachments** + +The following example describes the virtual interfaces that are attached to Direct Connect gateway ``5f294f92-bafb-4011-916d-9b0bexample``. + +Command:: + + aws directconnect describe-direct-connect-gateway-attachments --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample + +Output:: + + { + "directConnectGatewayAttachments": [ + { + "virtualInterfaceOwnerAccount": "123456789012", + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample", + "virtualInterfaceRegion": "us-east-2", + "attachmentState": "attaching", + "virtualInterfaceId": "dxvif-fg9zyabc" + } + ], + "nextToken": "eyJ2IjoxLCJzIjoxLCJpIjoibEhXdlNpUXF5RzhoL1JyUW52SlV2QT09IiwiYyI6Im5wQjFHQ0RyQUdRS3puNnNXcUlINCtkTTA4dTk3KzBiU0xtb05JQmlaczZ6NXRIYmk3c3VESUxFTTd6a2FzVHM0VTFwaGJkZGNxTytqWmQ3QzMzOGRQaTVrTThrOG1zelRsV3gyMWV3VTNFPSJ9" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateways.rst b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateways.rst new file mode 100644 index 00000000..f805cc91 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-direct-connect-gateways.rst @@ -0,0 +1,28 @@ +**To describe your Direct Connect gateways** + +The following example describe all of your Direct Connect gateways. + +Command:: + + aws directconnect describe-direct-connect-gateways + +Output:: + + { + "directConnectGateways": [ + { + "amazonSideAsn": 64512, + "directConnectGatewayId": "cf68415c-f4ae-48f2-87a7-3b52cexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway2", + "directConnectGatewayState": "available" + }, + { + "amazonSideAsn": 64512, + "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample", + "ownerAccount": "123456789012", + "directConnectGatewayName": "DxGateway1", + "directConnectGatewayState": "available" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-hosted-connections.rst b/aws/dist/awscli/examples/directconnect/describe-hosted-connections.rst new file mode 100644 index 00000000..07d2c3cb --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-hosted-connections.rst @@ -0,0 +1,25 @@ +**To list connections on an interconnect** + +The following example lists connections that have been provisioned on the given interconnect. + +Command:: + + aws directconnect describe-hosted-connections --connection-id dxcon-fgktov66 + +Output:: + + { + "connections": [ + { + "partnerName": "TIVIT", + "vlan": 101, + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffzc51m1", + "connectionState": "ordering", + "bandwidth": "500Mbps", + "location": "TIVIT", + "connectionName": "mydcinterconnect", + "region": "sa-east-1" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-interconnect-loa.rst b/aws/dist/awscli/examples/directconnect/describe-interconnect-loa.rst new file mode 100644 index 00000000..ac76f72a --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-interconnect-loa.rst @@ -0,0 +1,21 @@ +**To describe your LOA-CFA for an interconnect using Linux or Mac OS X** + +The following example describes your LOA-CFA for interconnect ``dxcon-fh6ayh1d``. The contents of the LOA-CFA are base64-encoded. This command uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure. The final part of the command decodes the content using the ``base64`` utility, and sends the output to a PDF file. + +.. code:: + + aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf + +**To describe your LOA-CFA for an interconnect using Windows** + +The previous example requires the use of the ``base64`` utility to decode the output. On a Windows computer, you can use ``certutil`` instead. In the following example, the first command describes your LOA-CFA for interconnect ``dxcon-fh6ayh1d`` and uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure to a file called ``myLoaCfa.base64``. The second command uses the ``certutil`` utility to decode the file and send the output to a PDF file. + +.. code:: + + aws directconnect describe-interconnect-loa --interconnect-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 + +.. code:: + + certutil -decode myLoaCfa.base64 myLoaCfa.pdf + +For more information about controlling AWS CLI output, see `Controlling Command Output from the AWS Command Line Interface `_ in the *AWS Command Line Interface User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-interconnects.rst b/aws/dist/awscli/examples/directconnect/describe-interconnects.rst new file mode 100644 index 00000000..bfd6a4c8 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-interconnects.rst @@ -0,0 +1,20 @@ +**To list interconnects** + +The following ``describe-interconnects`` command lists the interconnects owned by your AWS account:: + + aws directconnect describe-interconnects + +Output:: + + { + "interconnects": [ + { + "region": "sa-east-1", + "bandwidth": "1Gbps", + "location": "TIVIT", + "interconnectName": "1G Interconnect to AWS", + "interconnectId": "dxcon-fgktov66", + "interconnectState": "down" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-lags.rst b/aws/dist/awscli/examples/directconnect/describe-lags.rst new file mode 100644 index 00000000..88d5a324 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-lags.rst @@ -0,0 +1,48 @@ +**To describe your LAGs** + +The following command describes all of your LAGs for the current region. + +Command:: + + aws directconnect describe-lags + +Output:: + + { + "lags": [ + { + "awsDevice": "EqDC2-19y7z3m17xpuz", + "numberOfConnections": 2, + "lagState": "down", + "ownerAccount": "123456789012", + "lagName": "DA-LAG", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffnikghc", + "lagId": "dxlag-fgsu9erb", + "connectionState": "requested", + "bandwidth": "10Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 1 for Lag dxlag-fgsu9erb", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fglgbdea", + "lagId": "dxlag-fgsu9erb", + "connectionState": "requested", + "bandwidth": "10Gbps", + "location": "EqDC2", + "connectionName": "Requested Connection 2 for Lag dxlag-fgsu9erb", + "region": "us-east-1" + } + ], + "lagId": "dxlag-fgsu9erb", + "minimumLinks": 0, + "connectionsBandwidth": "10Gbps", + "region": "us-east-1", + "location": "EqDC2" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-loa.rst b/aws/dist/awscli/examples/directconnect/describe-loa.rst new file mode 100644 index 00000000..cc5ae23f --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-loa.rst @@ -0,0 +1,21 @@ +**To describe your LOA-CFA for a connection using Linux or Mac OS X** + +The following example describes your LOA-CFA for connection ``dxcon-fh6ayh1d``. The contents of the LOA-CFA are base64-encoded. This command uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure. The final part of the command decodes the content using the ``base64`` utility, and sends the output to a PDF file. + +.. code:: + + aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent|base64 --decode > myLoaCfa.pdf + +**To describe your LOA-CFA for a connection using Windows** + +The previous example requires the use of the ``base64`` utility to decode the output. On a Windows computer, you can use ``certutil`` instead. In the following example, the first command describes your LOA-CFA for connection ``dxcon-fh6ayh1d`` and uses the ``--output`` and ``--query`` parameters to control the output and extract the contents of the ``loaContent`` structure to a file called ``myLoaCfa.base64``. The second command uses the ``certutil`` utility to decode the file and send the output to a PDF file. + +.. code:: + + aws directconnect describe-loa --connection-id dxcon-fh6ayh1d --output text --query loa.loaContent > myLoaCfa.base64 + +.. code:: + + certutil -decode myLoaCfa.base64 myLoaCfa.pdf + +For more information about controlling AWS CLI output, see `Controlling Command Output from the AWS Command Line Interface `_ in the *AWS Command Line Interface User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-locations.rst b/aws/dist/awscli/examples/directconnect/describe-locations.rst new file mode 100644 index 00000000..a512adc4 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-locations.rst @@ -0,0 +1,20 @@ +**To list AWS Direct Connect partners and locations** + +The following ``describe-locations`` command lists AWS Direct Connect partners and locations in the current region:: + + aws directconnect describe-locations + +Output:: + + { + "locations": [ + { + "locationName": "NAP do Brasil, Barueri, Sao Paulo", + "locationCode": "TNDB" + }, + { + "locationName": "Tivit - Site Transamerica (Sao Paulo)", + "locationCode": "TIVIT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-tags.rst b/aws/dist/awscli/examples/directconnect/describe-tags.rst new file mode 100644 index 00000000..4d658c45 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-tags.rst @@ -0,0 +1,23 @@ +**To describe tags for your AWS Direct Connect resources** + +The following command describes the tags for the connection ``dxcon-abcabc12``. + +Command:: + + aws directconnect describe-tags --resource-arns arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 + +Output:: + + { + "resourceTags": [ + { + "resourceArn": "arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12", + "tags": [ + { + "value": "VAConnection", + "key": "Name" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-virtual-gateways.rst b/aws/dist/awscli/examples/directconnect/describe-virtual-gateways.rst new file mode 100644 index 00000000..c1c1f550 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-virtual-gateways.rst @@ -0,0 +1,16 @@ +**To list virtual private gateways** + +The following ``describe-virtual-gateways`` command lists virtual private gateways owned by your AWS account:: + + aws directconnect describe-virtual-gateways + +Output:: + + { + "virtualGateways": [ + { + "virtualGatewayId": "vgw-aba37db6", + "virtualGatewayState": "available" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/describe-virtual-interfaces.rst b/aws/dist/awscli/examples/directconnect/describe-virtual-interfaces.rst new file mode 100644 index 00000000..0aca469c --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/describe-virtual-interfaces.rst @@ -0,0 +1,53 @@ +**To list all virtual interfaces** + +The following ``describe-virtual-interfaces`` command lists the information about all virtual interfaces associated with your AWS account:: + + aws directconnect describe-virtual-interfaces --connection-id dxcon-ffjrkx17 + +Output:: + + { + "virtualInterfaces": [ + { + "virtualInterfaceState": "down", + "asn": 65000, + "vlan": 101, + "customerAddress": "192.168.1.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualGatewayId": "vgw-aba37db6", + "virtualInterfaceId": "dxvif-ffhhk74f", + "authKey": "asdf34example", + "routeFilterPrefixes": [], + "location": "TIVIT", + "customerRouterConfig": "\n\n 101\n 192.168.1.2/30\n 192.168.1.1/30\n 65000\n asdf34example\n 7224\n private\n\n", + "amazonAddress": "192.168.1.1/30", + "virtualInterfaceType": "private", + "virtualInterfaceName": "PrivateVirtualInterface" + }, + { + "virtualInterfaceState": "verifying", + "asn": 65000, + "vlan": 2000, + "customerAddress": "203.0.113.2/30", + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffjrkx17", + "virtualGatewayId": "", + "virtualInterfaceId": "dxvif-fgh0hcrk", + "authKey": "asdf34example", + "routeFilterPrefixes": [ + { + "cidr": "203.0.113.4/30" + }, + { + "cidr": "203.0.113.0/30" + } + ], + "location": "TIVIT", + "customerRouterConfig": "\n\n 2000\n 203.0.113.2/30\n 203.0.113.1/30\n 65000\n asdf34example\n 7224\n public\n\n", + "amazonAddress": "203.0.113.1/30", + "virtualInterfaceType": "public", + "virtualInterfaceName": "PublicVirtualInterface" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/directconnect/disassociate-connection-from-lag.rst b/aws/dist/awscli/examples/directconnect/disassociate-connection-from-lag.rst new file mode 100644 index 00000000..b6590bfe --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/disassociate-connection-from-lag.rst @@ -0,0 +1,19 @@ +**To disassociate a connection from a LAG** + +The following example disassociates the specified connection from the specified LAG. + +Command:: + + aws directconnect disassociate-connection-from-lag --lag-id dxlag-fhccu14t --connection-id dxcon-fg9607vm + +Output:: + + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fg9607vm", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "EqDC2", + "connectionName": "Con2ForLag", + "region": "us-east-1" + } diff --git a/aws/dist/awscli/examples/directconnect/tag-resource.rst b/aws/dist/awscli/examples/directconnect/tag-resource.rst new file mode 100644 index 00000000..5d10b237 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/tag-resource.rst @@ -0,0 +1,8 @@ +**To add a tag to an AWS Direct Connect resource** + +The following command adds a tag with a key of ``Name`` and a value of ``VAConnection`` to the connection ``dxcon-abcabc12``. If the command succeeds, no output is returned. + +Command:: + + aws directconnect tag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tags "key=Name,value=VAConnection" + diff --git a/aws/dist/awscli/examples/directconnect/untag-resource.rst b/aws/dist/awscli/examples/directconnect/untag-resource.rst new file mode 100644 index 00000000..684af0e1 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/untag-resource.rst @@ -0,0 +1,8 @@ +**To remove a tag from an AWS Direct Connect resource** + +The following command removes the tag with the key ``Name`` from connection ``dxcon-abcabc12``. If the command succeeds, no output is returned. + +Command:: + + aws directconnect untag-resource --resource-arn arn:aws:directconnect:us-east-1:123456789012:dxcon/dxcon-abcabc12 --tag-keys Name + diff --git a/aws/dist/awscli/examples/directconnect/update-direct-connect-gateway-association.rst b/aws/dist/awscli/examples/directconnect/update-direct-connect-gateway-association.rst new file mode 100755 index 00000000..f74ab26d --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/update-direct-connect-gateway-association.rst @@ -0,0 +1,34 @@ +**To update the specified attributes of the Direct Connect gateway association** + +The following ``update-direct-connect-gateway-association`` example adds the specified CIDR block to a Direct Connect gateway association. :: + + aws directconnect update-direct-connect-gateway-association \ + --association-id 820a6e4f-5374-4004-8317-3f64bEXAMPLE \ + --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.2.0/30 + +Output:: + + { + "directConnectGatewayAssociation": { + "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "directConnectGatewayOwnerAccount": "111122223333", + "associationState": "updating", + "associatedGateway": { + "id": "tgw-02f776b1a7EXAMPLE", + "type": "transitGateway", + "ownerAccount": "111122223333", + "region": "us-east-1" + }, + "associationId": "820a6e4f-5374-4004-8317-3f64bEXAMPLE", + "allowedPrefixesToDirectConnectGateway": [ + { + "cidr": "192.168.2.0/30" + }, + { + "cidr": "192.168.1.0/30" + } + ] + } + } + +For more information, see `Working with Direct Connect Gateways `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/directconnect/update-lag.rst b/aws/dist/awscli/examples/directconnect/update-lag.rst new file mode 100644 index 00000000..6e69f9c6 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/update-lag.rst @@ -0,0 +1,44 @@ +**To update a LAG** + +The following example changes the name of the specified LAG. + +Command:: + + aws directconnect update-lag --lag-id dxlag-ffjhj9lx --lag-name 2ConnLag + +Output:: + + { + "awsDevice": "CSVA1-23u8tlpaz8iks", + "numberOfConnections": 2, + "lagState": "down", + "ownerAccount": "123456789012", + "lagName": "2ConnLag", + "connections": [ + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-fflqyj95", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 2 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + }, + { + "ownerAccount": "123456789012", + "connectionId": "dxcon-ffqr6x5q", + "lagId": "dxlag-ffjhj9lx", + "connectionState": "requested", + "bandwidth": "1Gbps", + "location": "CSVA1", + "connectionName": "Requested Connection 1 for Lag dxlag-ffjhj9lx", + "region": "us-east-1" + } + ], + "lagId": "dxlag-ffjhj9lx", + "minimumLinks": 0, + "connectionsBandwidth": "1Gbps", + "region": "us-east-1", + "location": "CSVA1" + } diff --git a/aws/dist/awscli/examples/directconnect/update-virtual-interface-attributes.rst b/aws/dist/awscli/examples/directconnect/update-virtual-interface-attributes.rst new file mode 100755 index 00000000..4c01cfa5 --- /dev/null +++ b/aws/dist/awscli/examples/directconnect/update-virtual-interface-attributes.rst @@ -0,0 +1,51 @@ +**To update the MTU of a virtual interface** + +The following ``update-virtual-interface-attributes`` example updates the MTU of the specified virtual interface. :: + + aws directconnect update-virtual-interface-attributes \ + --virtual-interface-id dxvif-fEXAMPLE \ + --mtu 1500 + +Output:: + + { + "ownerAccount": "1111222233333", + "virtualInterfaceId": "dxvif-fEXAMPLE", + "location": "TIVIT", + "connectionId": "dxlag-fEXAMPLE", + "virtualInterfaceType": "transit", + "virtualInterfaceName": "example trasit virtual interface", + "vlan": 125, + "asn": 650001, + "amazonSideAsn": 64512, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "amazonAddress": "169.254.248.1/30", + "customerAddress": "169.254.248.2/30", + "addressFamily": "ipv4", + "virtualInterfaceState": "down", + "customerRouterConfig": "\n\n 125\n 169.254.248.2/30\n 169.254.248.1/30\n 650001\n 0xzxgA9YoW9h58u8SEXAMPLE\n 64512\n transit\n\n", + "mtu": 1500, + "jumboFrameCapable": true, + "virtualGatewayId": "", + "directConnectGatewayId": "879b76a1-403d-4700-8b53-4a56ed85436e", + "routeFilterPrefixes": [], + "bgpPeers": [ + { + "bgpPeerId": "dxpeer-fEXAMPLE", + "asn": 650001, + "authKey": "0xzxgA9YoW9h58u8SEXAMPLE", + "addressFamily": "ipv4", + "amazonAddress": "169.254.248.1/30", + "customerAddress": "169.254.248.2/30", + "bgpPeerState": "available", + "bgpStatus": "down", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE" + } + ], + "region": "sa-east-1", + "awsDeviceV2": "TIVIT-26wz6vEXAMPLE", + "tags": [] + } + + +For more information, see `Setting Network MTU for Private Virtual Interfaces or Transit Virtual Interfaces `__ in the *AWS Direct Connect User Guide*. diff --git a/aws/dist/awscli/examples/discovery/describe-agents.rst b/aws/dist/awscli/examples/discovery/describe-agents.rst new file mode 100644 index 00000000..32131d6b --- /dev/null +++ b/aws/dist/awscli/examples/discovery/describe-agents.rst @@ -0,0 +1,46 @@ +**Describe agents with specified collectionStatus states** + +This example command describes collection agents with collection status of "STARTED" or "STOPPED". + +Command:: + + aws discovery describe-agents --filters name="collectionStatus",values="STARTED","STOPPED",condition="EQUALS" --max-results 3 + +Output:: + + { + "Snapshots": [ + { + "version": "1.0.40.0", + "agentType": "EC2", + "hostName": "ip-172-31-40-234", + "collectionStatus": "STOPPED", + "agentNetworkInfoList": [ + { + "macAddress": "06:b5:97:14:fc:0d", + "ipAddress": "172.31.40.234" + } + ], + "health": "UNKNOWN", + "agentId": "i-003305c02a776e883", + "registeredTime": "2016-12-09T19:05:06Z", + "lastHealthPingTime": "2016-12-09T19:05:10Z" + }, + { + "version": "1.0.40.0", + "agentType": "EC2", + "hostName": "ip-172-31-39-64", + "collectionStatus": "STARTED", + "agentNetworkInfoList": [ + { + "macAddress": "06:a1:0e:c7:b2:73", + "ipAddress": "172.31.39.64" + } + ], + "health": "SHUTDOWN", + "agentId": "i-003a5e5e2b36cf8bd", + "registeredTime": "2016-11-16T16:36:25Z", + "lastHealthPingTime": "2016-11-16T16:47:37Z" + } + ] + } diff --git a/aws/dist/awscli/examples/discovery/describe-configurations.rst b/aws/dist/awscli/examples/discovery/describe-configurations.rst new file mode 100644 index 00000000..cb3b57f2 --- /dev/null +++ b/aws/dist/awscli/examples/discovery/describe-configurations.rst @@ -0,0 +1,122 @@ +**Describe selected asset configurations** + +This example command describes the configurations of two specified servers. The action detects the type of asset from the configuration ID. Only one type of asset is allowed per command. + +Command:: + + aws discovery describe-configurations --configuration-ids "d-server-099385097ef9fbcfb" "d-server-0c4f2dd1fee22c6c1" + +Output:: + + { + "configurations": [ + { + "server.performance.maxCpuUsagePct": "0.0", + "server.performance.maxDiskReadIOPS": "0.0", + "server.performance.avgCpuUsagePct": "0.0", + "server.type": "EC2", + "server.performance.maxNetworkReadsPerSecondInKB": "0.19140625", + "server.hostName": "ip-172-31-35-152", + "server.configurationId": "d-server-0c4f2dd1fee22c6c1", + "server.tags.hasMoreValues": "false", + "server.performance.minFreeRAMInKB": "1543496.0", + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.performance.maxDiskReadsPerSecondInKB": "0.0", + "server.applications": "[]", + "server.performance.numDisks": "1", + "server.performance.numCpus": "1", + "server.performance.numCores": "1", + "server.performance.maxDiskWriteIOPS": "0.0", + "server.performance.maxNetworkWritesPerSecondInKB": "0.82421875", + "server.performance.avgDiskWritesPerSecondInKB": "0.0", + "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"172.31.35.152\",\"netMask\":\"255.255.240.0\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:A7:7D:3F:54:57\",\"ipAddress\":\"fe80::4a7:7dff:fe3f:5457\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"}]", + "server.performance.avgNetworkReadsPerSecondInKB": "0.04915364583333333", + "server.tags": "[]", + "server.applications.hasMoreValues": "false", + "server.timeOfCreation": "2016-10-28 23:44:00.0", + "server.agentId": "i-4447bc1b", + "server.performance.maxDiskWritesPerSecondInKB": "0.0", + "server.performance.avgDiskReadIOPS": "0.0", + "server.performance.avgFreeRAMInKB": "1547210.1333333333", + "server.performance.avgDiskReadsPerSecondInKB": "0.0", + "server.performance.avgDiskWriteIOPS": "0.0", + "server.performance.numNetworkCards": "2", + "server.hypervisor": "xen", + "server.networkInterfaceInfo.hasMoreValues": "false", + "server.performance.avgNetworkWritesPerSecondInKB": "0.1380859375", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.performance.totalRAMInKB": "1694732.0", + "server.cpuType": "x64" + }, + { + "server.performance.maxCpuUsagePct": "100.0", + "server.performance.maxDiskReadIOPS": "0.0", + "server.performance.avgCpuUsagePct": "14.733333333333338", + "server.type": "EC2", + "server.performance.maxNetworkReadsPerSecondInKB": "13.400390625", + "server.hostName": "ip-172-31-42-208", + "server.configurationId": "d-server-099385097ef9fbcfb", + "server.tags.hasMoreValues": "false", + "server.performance.minFreeRAMInKB": "1531104.0", + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.performance.maxDiskReadsPerSecondInKB": "0.0", + "server.applications": "[]", + "server.performance.numDisks": "1", + "server.performance.numCpus": "1", + "server.performance.numCores": "1", + "server.performance.maxDiskWriteIOPS": "1.0", + "server.performance.maxNetworkWritesPerSecondInKB": "12.271484375", + "server.performance.avgDiskWritesPerSecondInKB": "0.5333333333333334", + "server.networkInterfaceInfo": "[{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"172.31.42.208\",\"netMask\":\"255.255.240.0\"},{\"name\":\"eth0\",\"macAddress\":\"06:4A:79:60:75:61\",\"ipAddress\":\"fe80::44a:79ff:fe60:7561\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"::1\"},{\"name\":\"lo\",\"macAddress\":\"00:00:00:00:00:00\",\"ipAddress\":\"127.0.0.1\",\"netMask\":\"255.0.0.0\"}]", + "server.performance.avgNetworkReadsPerSecondInKB": "2.8720052083333334", + "server.tags": "[]", + "server.applications.hasMoreValues": "false", + "server.timeOfCreation": "2016-10-28 23:44:30.0", + "server.agentId": "i-c142b99e", + "server.performance.maxDiskWritesPerSecondInKB": "4.0", + "server.performance.avgDiskReadIOPS": "0.0", + "server.performance.avgFreeRAMInKB": "1534946.4", + "server.performance.avgDiskReadsPerSecondInKB": "0.0", + "server.performance.avgDiskWriteIOPS": "0.13333333333333336", + "server.performance.numNetworkCards": "2", + "server.hypervisor": "xen", + "server.networkInterfaceInfo.hasMoreValues": "false", + "server.performance.avgNetworkWritesPerSecondInKB": "1.7977864583333332", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.performance.totalRAMInKB": "1694732.0", + "server.cpuType": "x64" + } + ] + } + + +**Describe selected asset configurations** + +This example command describes the configurations of two specified applications. The action detects the type of asset from the configuration ID. Only one type of asset is allowed per command. + +Command:: + + aws discovery describe-configurations --configuration-ids "d-application-0ac39bc0e4fad0e42" "d-application-02444a45288013764q" + +Output:: + + { + "configurations": [ + { + "application.serverCount": "0", + "application.name": "Application-12345", + "application.lastModifiedTime": "2016-12-13 23:53:27.0", + "application.description": "", + "application.timeOfCreation": "2016-12-13 23:53:27.0", + "application.configurationId": "d-application-0ac39bc0e4fad0e42" + }, + { + "application.serverCount": "0", + "application.name": "Application-67890", + "application.lastModifiedTime": "2016-12-13 23:53:33.0", + "application.description": "", + "application.timeOfCreation": "2016-12-13 23:53:33.0", + "application.configurationId": "d-application-02444a45288013764" + } + ] + } diff --git a/aws/dist/awscli/examples/discovery/list-configurations.rst b/aws/dist/awscli/examples/discovery/list-configurations.rst new file mode 100644 index 00000000..00f8e3a2 --- /dev/null +++ b/aws/dist/awscli/examples/discovery/list-configurations.rst @@ -0,0 +1,32 @@ +**To list all of the discovered servers meeting a set of filter conditions** + +This example command lists discovered servers matching either of two hostname patterns and not running Ubuntu. + +Command:: + + aws discovery list-configurations --configuration-type SERVER --filters name="server.hostName",values="172-31-35","172-31-42",condition="CONTAINS" name="server.osName",values="Ubuntu",condition="NOT_CONTAINS" + +Output:: + + { + "configurations": [ + { + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.type": "EC2", + "server.hostName": "ip-172-31-42-208", + "server.timeOfCreation": "2016-10-28 23:44:30.0", + "server.configurationId": "d-server-099385097ef9fbcfb", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.agentId": "i-c142b99e" + }, + { + "server.osVersion": "3.14.48-33.39.amzn1.x86_64", + "server.type": "EC2", + "server.hostName": "ip-172-31-35-152", + "server.timeOfCreation": "2016-10-28 23:44:00.0", + "server.configurationId": "d-server-0c4f2dd1fee22c6c1", + "server.osName": "Linux - Amazon Linux AMI release 2015.03", + "server.agentId": "i-4447bc1b" + } + ] + } diff --git a/aws/dist/awscli/examples/dlm/create-default-role.rst b/aws/dist/awscli/examples/dlm/create-default-role.rst new file mode 100644 index 00000000..b218c681 --- /dev/null +++ b/aws/dist/awscli/examples/dlm/create-default-role.rst @@ -0,0 +1,54 @@ +**To create the required IAM role for Amazon DLM** + +Amazon DLM creates the **AWSDataLifecycleManagerDefaultRole** role the first time that you create a lifecycle policy using the AWS Management Console. If you are not using the console, you can use the following command to create this role. :: + + aws dlm create-default-role + +Output:: + + { + "RolePolicy": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "ec2:CreateSnapshot", + "ec2:CreateSnapshots", + "ec2:DeleteSnapshot", + "ec2:DescribeInstances", + "ec2:DescribeVolumes", + "ec2:DescribeSnapshots" + ], + "Resource": "*" + }, + { + "Effect": "Allow", + "Action": [ + "ec2:CreateTags" + ], + "Resource": "arn:aws:ec2:*::snapshot/*" + } + ] + }, + "Role": { + "Path": "/", + "RoleName": "AWSDataLifecycleManagerDefaultRole", + "RoleId": "AROA012345678901EXAMPLE", + "Arn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole", + "CreateDate": "2019-05-29T17:47:18Z", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "dlm.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] + } + } + } diff --git a/aws/dist/awscli/examples/dlm/create-lifecycle-policy.rst b/aws/dist/awscli/examples/dlm/create-lifecycle-policy.rst new file mode 100644 index 00000000..12eb5506 --- /dev/null +++ b/aws/dist/awscli/examples/dlm/create-lifecycle-policy.rst @@ -0,0 +1,51 @@ +**To create a lifecycle policy** + +The following ``create-lifecycle-policy`` example creates a lifecycle policy that creates a daily snapshot of volumes at the specified time. The specified tags are added to the snapshots, and tags are also copied from the volume and added to the snapshots. If creating a new snapshot exceeds the specified maximum count, the oldest snapshot is deleted. :: + + aws dlm create-lifecycle-policy \ + --description "My first policy" \ + --state ENABLED \ + --execution-role-arn arn:aws:iam::12345678910:role/AWSDataLifecycleManagerDefaultRole \ + --policy-details file://policyDetails.json + +Contents of ``policyDetails.json``:: + + { + "ResourceTypes": [ + "VOLUME" + ], + "TargetTags": [ + { + "Key": "costCenter", + "Value": "115" + } + ], + "Schedules":[ + { + "Name": "DailySnapshots", + "CopyTags": true, + "TagsToAdd": [ + { + "Key": "type", + "Value": "myDailySnapshot" + } + ], + "CreateRule": { + "Interval": 24, + "IntervalUnit": "HOURS", + "Times": [ + "03:00" + ] + }, + "RetainRule": { + "Count":5 + } + } + ] + } + +Output:: + + { + "PolicyId": "policy-0123456789abcdef0" + } diff --git a/aws/dist/awscli/examples/dlm/delete-lifecycle-policy.rst b/aws/dist/awscli/examples/dlm/delete-lifecycle-policy.rst new file mode 100644 index 00000000..f6f9e853 --- /dev/null +++ b/aws/dist/awscli/examples/dlm/delete-lifecycle-policy.rst @@ -0,0 +1,5 @@ +**To delete a lifecycle policy** + +The following example deletes the specified lifecycle policy.:: + + aws dlm delete-lifecycle-policy --policy-id policy-0123456789abcdef0 diff --git a/aws/dist/awscli/examples/dlm/get-lifecycle-policies.rst b/aws/dist/awscli/examples/dlm/get-lifecycle-policies.rst new file mode 100644 index 00000000..162b6819 --- /dev/null +++ b/aws/dist/awscli/examples/dlm/get-lifecycle-policies.rst @@ -0,0 +1,17 @@ +**To get a summary of your lifecycle policies** + +The following ``get-lifecycle-policies`` example lists all of your lifecycle policies. :: + + aws dlm get-lifecycle-policies + +Output:: + + { + "Policies": [ + { + "PolicyId": "policy-0123456789abcdef0", + "Description": "My first policy", + "State": "ENABLED" + } + ] + } diff --git a/aws/dist/awscli/examples/dlm/get-lifecycle-policy.rst b/aws/dist/awscli/examples/dlm/get-lifecycle-policy.rst new file mode 100644 index 00000000..5727c03e --- /dev/null +++ b/aws/dist/awscli/examples/dlm/get-lifecycle-policy.rst @@ -0,0 +1,53 @@ +**To describe a lifecycle policy** + +The following ``get-lifecycle-policy`` example displays details for the specified lifecycle policy. :: + + aws dlm get-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 + +Output:: + + { + "Policy": { + "PolicyId": "policy-0123456789abcdef0", + "Description": "My policy", + "State": "ENABLED", + "ExecutionRoleArn": "arn:aws:iam::123456789012:role/AWSDataLifecycleManagerDefaultRole", + "DateCreated": "2019-08-08T17:45:42Z", + "DateModified": "2019-08-08T17:45:42Z", + "PolicyDetails": { + "PolicyType": "EBS_SNAPSHOT_MANAGEMENT", + "ResourceTypes": [ + "VOLUME" + ], + "TargetTags": [ + { + "Key": "costCenter", + "Value": "115" + } + ], + "Schedules": [ + { + "Name": "DailySnapshots", + "CopyTags": true, + "TagsToAdd": [ + { + "Key": "type", + "Value": "myDailySnapshot" + } + ], + "CreateRule": { + "Interval": 24, + "IntervalUnit": "HOURS", + "Times": [ + "03:00" + ] + }, + "RetainRule": { + "Count": 5 + } + } + ] + } + } + } diff --git a/aws/dist/awscli/examples/dlm/update-lifecycle-policy.rst b/aws/dist/awscli/examples/dlm/update-lifecycle-policy.rst new file mode 100644 index 00000000..6cd08fb6 --- /dev/null +++ b/aws/dist/awscli/examples/dlm/update-lifecycle-policy.rst @@ -0,0 +1,38 @@ +**Example 1: To enable a lifecycle policy** + +The following ``update-lifecycle-policy`` example enables the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 \ + --state ENABLED + +**Example 2: To disable a lifecycle policy** + +The following ``update-lifecycle-policy`` example disables the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 \ + --state DISABLED + +**Example 3: To update the details for lifecycle policy** + +The following ``update-lifecycle-policy`` example updates the target tags for the specified lifecycle policy. :: + + aws dlm update-lifecycle-policy \ + --policy-id policy-0123456789abcdef0 + --policy-details file://policyDetails.json + +Contents of ``policyDetails.json``. Other details not referenced in this file are not changed by the command. :: + + { + "TargetTags": [ + { + "Key": "costCenter", + "Value": "120" + }, + { + "Key": "project", + "Value": "lima" + } + ] + } diff --git a/aws/dist/awscli/examples/dms/create-endpoint.rst b/aws/dist/awscli/examples/dms/create-endpoint.rst new file mode 100644 index 00000000..23a6a3eb --- /dev/null +++ b/aws/dist/awscli/examples/dms/create-endpoint.rst @@ -0,0 +1,19 @@ +The following command creates a source endpoint for a MySQL RDS DB instance named ``mydb.cx1llnox7iyx.uswest-2.rds.amazonaws.com``:: + + aws dms create-endpoint --endpoint-identifier test-endpoint-1 --endpoint-type source --engine-name mysql --username username --password password --server-name mydb.cx1llnox7iyx.uswest-2.rds.amazonaws.com --port 3306 + +Output:: + + { + "Endpoint": { + "Username": "username", + "Status": "active", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", + "ServerName": "mydb.cx1llnox7iyx.us-west-2.rds.amazonaws.com", + "EndpointType": "SOURCE", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "EngineName": "mysql", + "EndpointIdentifier": "test-endpoint-1", + "Port": 3306 + } + } diff --git a/aws/dist/awscli/examples/dms/create-replication-instance.rst b/aws/dist/awscli/examples/dms/create-replication-instance.rst new file mode 100644 index 00000000..59945013 --- /dev/null +++ b/aws/dist/awscli/examples/dms/create-replication-instance.rst @@ -0,0 +1,52 @@ +The following command creates a replication instance named ``my-replication-db`` with 5GB of storage:: + + aws dms create-replication-instance --replication-instance-identifier my-replication-db --replication-instance-class dms.t2.micro --allocated-storage 5 + +Output:: + + { + "ReplicationInstance": { + "PubliclyAccessible": true, + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ ", + "ReplicationInstanceClass": "dms.t2.micro", + "ReplicationSubnetGroup": { + "ReplicationSubnetGroupDescription": "default", + "Subnets": [{ + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-f6dd91af", + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + } + }, { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-3605751d", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + } + }, { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-c2daefb5", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + } + }, { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-85e90cb8", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + } + }], + "VpcId": "vpc-6741a603", + "SubnetGroupStatus": "Complete", + "ReplicationSubnetGroupIdentifier": "default" + }, + "AutoMinorVersionUpgrade": true, + "ReplicationInstanceStatus": "creating", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/4c1731d6-5435-ed4d-be13-d53411a7cfbd", + "AllocatedStorage": 5, + "EngineVersion": "1.5.0", + "ReplicationInstanceIdentifier": "test-rep-1", + "PreferredMaintenanceWindow": "sun:06:00-sun:14:00", + "PendingModifiedValues": {} + } + } diff --git a/aws/dist/awscli/examples/dms/create-replication-task.rst b/aws/dist/awscli/examples/dms/create-replication-task.rst new file mode 100644 index 00000000..cd77cba1 --- /dev/null +++ b/aws/dist/awscli/examples/dms/create-replication-task.rst @@ -0,0 +1,58 @@ +The following command creates a replication task to copy data from one DB instance behind a DMS endpoint to another using a replication instance:: + + aws dms create-replication-task --replicationtask-identifier my-replication-task --target-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:HTWNT57CLN2WGVBUJQXJZASXWE --source-endpoint-arn arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE --replication-instance-arn arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ --migration-type full-load --table-mappings 'file://table-mappings.json' + +The file ``table-mappings.json`` is a JSON document in the current folder that specifies table mappings:: + + { + "TableMappings": [ + { + "Type": "Include", + "SourceSchema": "company", + "SourceTable": "emp%" + }, + { + "Type": "Include", + "SourceSchema": "employees", + "SourceTable": "%" + }, + { + "Type": "Exclude", + "SourceSchema": "source101", + "SourceTable": "dep%" + }, + { + "Type": "Exclude", + "SourceSchema": "source102", + "SourceTable": "%" + }, + { + "Type": "Explicit", + "SourceSchema": "company", + "SourceTable": "managers" + }, + { + "Type": "Explicit", + "SourceSchema": "company", + "SourceTable": "locations" + } + ] + } + + +Output:: + + { + "ReplicationTask": { + "SourceEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "ReplicationTaskIdentifier": "task1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ", + "TableMappings": "{\n \"TableMappings\": [\n {\n \"Type\":\"Include\",\n \"SourceSchema\": \"/\",\n \"SourceTable\": \"/\"\n}\n ]\n}\n\n", + "Status": "creating", + "ReplicationTaskArn": "arn:aws:dms:us-east-1:123456789012:task:OEAMB3NXSTZ6LFYZFEPPBBXPYM", + "ReplicationTaskCreationDate": 1457658407.492, + "MigrationType": "full-load", + "TargetEndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:ASXWXJZLNWNT5HTWCGV2BUJQ7E", + "ReplicationTaskSettings": "{\"TargetMetadata\":{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":false,\"LobMaxSize\":0},\"FullLoadSettings\":{\"FullLoadEnabled\":true,\"ApplyChangesEnabled\":false,\"TargetTablePrepMode\":\"DROP_AND_CREATE\",\"CreatePkAfterFullLoad\":false,\"StopTaskCachedChangesApplied\":false,\"StopTaskCachedChangesNotApplied\":false,\"ResumeEnabled\":false,\"ResumeMinTableSize\":100000,\"ResumeOnlyClusteredPKTables\":true,\"MaxFullLoadSubTasks\":8,\"TransactionConsistencyTimeout\":600,\"CommitRate\":10000},\"Logging\":{\"EnableLogging\":false}}" + } + } diff --git a/aws/dist/awscli/examples/dms/describe-connections.rst b/aws/dist/awscli/examples/dms/describe-connections.rst new file mode 100644 index 00000000..69105436 --- /dev/null +++ b/aws/dist/awscli/examples/dms/describe-connections.rst @@ -0,0 +1,17 @@ +The following command describes connections for an endpoint specified by ARN:: + + aws dms describe-connections --filters Name="endpoint-arn",Values="arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE" + +Output:: + + { + "Connections": [ + { + "Status": "successful", + "ReplicationInstanceIdentifier": "test", + "EndpointArn": "arn:aws:dms:us-east-arn:aws:dms:us-east-1:123456789012:endpoint:ZW5UAN6P4E77EC7YWHK4RZZ3BE", + "EndpointIdentifier": "testsrc1", + "ReplicationInstanceArn": "arn:aws:dms:us-east-1:123456789012:rep:6UTDJGBOUS3VI3SUWA66XFJCJQ" + } + ] + } diff --git a/aws/dist/awscli/examples/dms/describe-endpoints.rst b/aws/dist/awscli/examples/dms/describe-endpoints.rst new file mode 100644 index 00000000..f17d46a1 --- /dev/null +++ b/aws/dist/awscli/examples/dms/describe-endpoints.rst @@ -0,0 +1,31 @@ +The following command describes source endpoints in your account:: + + aws dms describe-endpoints --filters Name="endpoint-type",Values="source" + +Output:: + + { + "Endpoints": [{ + "Username": "dms", + "Status": "active", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:SF2WOFLWYWKVEOHID2EKLP3SJI", + "ServerName": "ec2-52-32-48-61.us-west-2.compute.amazonaws.com", + "EndpointType": "SOURCE", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/94d5c4e7-4e4c-44be-b58a-c8da7adf57cd", + "DatabaseName": "test", + "EngineName": "mysql", + "EndpointIdentifier": "pri100", + "Port": 8193 + }, { + "Username": "admin", + "Status": "active", + "EndpointArn": "arn:aws:dms:us-east-1:123456789012:endpoint:TJJZCIH3CJ24TJRU4VC32WEWFR", + "ServerName": "test.example.com", + "EndpointType": "SOURCE", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/2431021b-1cf2-a2d4-77b2-59a9e4bce323", + "DatabaseName": "EMPL", + "EngineName": "oracle", + "EndpointIdentifier": "test", + "Port": 1521 + }] + } diff --git a/aws/dist/awscli/examples/docdb/add-tags-to-resource.rst b/aws/dist/awscli/examples/docdb/add-tags-to-resource.rst new file mode 100644 index 00000000..8f3e785f --- /dev/null +++ b/aws/dist/awscli/examples/docdb/add-tags-to-resource.rst @@ -0,0 +1,11 @@ +**To add one or more tags to a specified resource** + +The following ``add-tags-to-resource`` example adds three tags to ``sample-cluster``. One tag (``CropB``) has a key name but no value. :: + + aws docdb add-tags-to-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --tags Key="CropA",Value="Apple" Key="CropB" Key="CropC",Value="Corn" + +This command produces no output. + +For more information, see `Tagging Amazon DocumentDB Resources `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/apply-pending-maintenance-action.rst b/aws/dist/awscli/examples/docdb/apply-pending-maintenance-action.rst new file mode 100644 index 00000000..1f07f487 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/apply-pending-maintenance-action.rst @@ -0,0 +1,12 @@ +**To have pending maintenance actions take place during the next maintenance window** + +The following ``apply-pending-maintenance-action`` example causes all system-update actions to be performed during the next scheduled maintenance window. :: + + aws docdb apply-pending-maintenance-action \ + --resource-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --apply-action system-update \ + --opt-in-type next-maintenance + +This command produces no output. + +For more information, see `Applying Amazon DocumentDB Updates `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/copy-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/docdb/copy-db-cluster-parameter-group.rst new file mode 100644 index 00000000..85ea7854 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/copy-db-cluster-parameter-group.rst @@ -0,0 +1,22 @@ +**To duplicate an existing DB cluster parameter group** + +The following ``copy-db-cluster-parameter-group`` example makes a copy of the parameter group ``custom-docdb3-6`` named ``custom-docdb3-6-copy``. When making the copy it adds tags to the new parameter group. :: + + aws docdb copy-db-cluster-parameter-group \ + --source-db-cluster-parameter-group-identifier custom-docdb3-6 \ + --target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \ + --target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \ + --tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes" + +Output:: + + { + "DBClusterParameterGroup": { + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy", + "DBClusterParameterGroupName": "custom-docdb3-6-copy", + "Description": "Copy of custom-docdb3-6" + } + } + +For more information, see `Copying an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/copy-db-cluster-snapshot.rst b/aws/dist/awscli/examples/docdb/copy-db-cluster-snapshot.rst new file mode 100644 index 00000000..09301cb6 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/copy-db-cluster-snapshot.rst @@ -0,0 +1,13 @@ +**To create a copy of a snapshot** + +The following ``copy-db-cluster-snapshot`` example makes a copy of ``sample-cluster-snapshot`` named ``sample-cluster-snapshot-copy``. The copy has all the tags of the original plus a new tag with the key name ``CopyNumber``. :: + + aws docdb copy-db-cluster-snapshot \ + --source-db-cluster-snapshot-identifier sample-cluster-snapshot \ + --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \ + --copy-tags \ + --tags Key="CopyNumber",Value="1" + +This command produces no output. + +For more information, see `Copying a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/create-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/docdb/create-db-cluster-parameter-group.rst new file mode 100644 index 00000000..f45f8ab5 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/create-db-cluster-parameter-group.rst @@ -0,0 +1,21 @@ +**To create an Amazon DocumentDB cluster parameter group** + +The following ``create-db-cluster-parameter-group`` example creates the DB cluster parameter group ``sample-parameter-group`` using the ``docdb3.6`` family. :: + + aws docdb create-db-cluster-parameter-group \ + --db-cluster-parameter-group-name sample-parameter-group \ + --db-parameter-group-family docdb3.6 \ + --description "Sample parameter group based on docdb3.6" + +Output:: + + { + "DBClusterParameterGroup": { + "Description": "Sample parameter group based on docdb3.6", + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-west-2:123456789012:cluster-pg:sample-parameter-group", + "DBClusterParameterGroupName": "sample-parameter-group" + } + } + +For more information, see `Creating an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/create-db-cluster-snapshot.rst b/aws/dist/awscli/examples/docdb/create-db-cluster-snapshot.rst new file mode 100644 index 00000000..376622ae --- /dev/null +++ b/aws/dist/awscli/examples/docdb/create-db-cluster-snapshot.rst @@ -0,0 +1,38 @@ +**To create a manual Amazon DocumentDB cluster snapshot** + +The following ``create-db-cluster-snapshot`` example creates an Amazon DB cluster snapshot named sample-cluster-snapshot. :: + + aws docdb create-db-cluster-snapshot \ + --db-cluster-identifier sample-cluster \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshot": { + "MasterUsername": "master-user", + "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d", + "us-west-2e", + "us-west-2f" + ], + "SnapshotType": "manual", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "EngineVersion": "3.6.0", + "PercentProgress": 0, + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "Status": "creating", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "Port": 0, + "StorageEncrypted": false, + "VpcId": "vpc-91280df6" + } + } + +For more information, see `Creating a Manual Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/create-db-cluster.rst b/aws/dist/awscli/examples/docdb/create-db-cluster.rst new file mode 100644 index 00000000..842f48db --- /dev/null +++ b/aws/dist/awscli/examples/docdb/create-db-cluster.rst @@ -0,0 +1,52 @@ +**To create an Amazon DocumentDB cluster** + +The following ``create-db-cluster`` example creates an Amazon DocumentDB cluster named ``sample-cluster`` with the preferred maintenance window on Sundays between 20:30 and 11:00. :: + + aws docdb create-db-cluster \ + --db-cluster-identifier sample-cluster \ + --engine docdb \ + --master-username master-user \ + --master-user-password password \ + --preferred-maintenance-window Sun:20:30-Sun:21:00 + +Output:: + + { + "DBCluster": { + "DBClusterParameterGroup": "default.docdb3.6", + "AssociatedRoles": [], + "DBSubnetGroup": "default", + "ClusterCreateTime": "2019-03-18T18:06:34.616Z", + "Status": "creating", + "Port": 27017, + "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", + "HostedZoneId": "ZNKXH85TT8WVW", + "DBClusterMembers": [], + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "PreferredBackupWindow": "10:12-10:42", + "AvailabilityZones": [ + "us-west-2d", + "us-west-2f", + "us-west-2e" + ], + "MasterUsername": "master-user", + "BackupRetentionPeriod": 1, + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "StorageEncrypted": false, + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", + "MultiAZ": false, + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "EngineVersion": "3.6.0" + } + } + + +For more information, see `Creating an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/create-db-instance.rst b/aws/dist/awscli/examples/docdb/create-db-instance.rst new file mode 100644 index 00000000..a9102cce --- /dev/null +++ b/aws/dist/awscli/examples/docdb/create-db-instance.rst @@ -0,0 +1,83 @@ +**To create an Amazon DocumentDB cluster instance** + +The following ``create-db-instance`` example code creates the instance ``sample-cluster-instance-2`` in the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb create-db-instance \ + --db-cluster-identifier sample-cluster \ + --db-instance-class db.r4.xlarge \ + --db-instance-identifier sample-cluster-instance-2 \ + --engine docdb + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "creating", + "PendingModifiedValues": { + "PendingCloudwatchLogsExports": { + "LogTypesToEnable": [ + "audit" + ] + } + }, + "PubliclyAccessible": false, + "PreferredBackupWindow": "00:00-00:30", + "PromotionTier": 1, + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "DBInstanceIdentifier": "sample-cluster-instance-2", + "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", + "StorageEncrypted": false, + "Engine": "docdb", + "DBClusterIdentifier": "sample-cluster", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete", + "VpcId": "vpc-91280df6", + "DBSubnetGroupName": "default" + }, + "DBInstanceClass": "db.r4.xlarge", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "AutoMinorVersionUpgrade": true, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", + "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE" + } + } + + +For more information, see `Adding an Amazon DocumentDB Instance to a Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/create-db-subnet-group.rst b/aws/dist/awscli/examples/docdb/create-db-subnet-group.rst new file mode 100644 index 00000000..82057f27 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/create-db-subnet-group.rst @@ -0,0 +1,46 @@ +**To create an Amazon DocumentDB subnet group** + +The following ``create-db-subnet-group`` example creates an Amazon DocumentDB subnet group named ``sample-subnet-group``. :: + + aws docdb create-db-subnet-group \ + --db-subnet-group-description "a sample subnet group" \ + --db-subnet-group-name sample-subnet-group \ + --subnet-ids "subnet-29ab1025" "subnet-991cb8d0" "subnet-53ab3636" + +Output:: + + { + "DBSubnetGroup": { + "SubnetGroupStatus": "Complete", + "DBSubnetGroupName": "sample-subnet-group", + "DBSubnetGroupDescription": "a sample subnet group", + "VpcId": "vpc-91280df6", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-29ab1025", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + } + ] + } + } + + +For more information, see `Creating an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/delete-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/docdb/delete-db-cluster-parameter-group.rst new file mode 100644 index 00000000..63720ad1 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/delete-db-cluster-parameter-group.rst @@ -0,0 +1,10 @@ +**To delete an Amazon DocumentDB cluster parameter group** + +The following ``delete-db-cluster-parameter-group`` example deletes the Amazon DocumentDB parameter group ``sample-parameter-group``. :: + + aws docdb delete-db-cluster-parameter-group \ + --db-cluster-parameter-group-name sample-parameter-group + +This command produces no output. + +For more information, see `Deleting an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/delete-db-cluster-snapshot.rst b/aws/dist/awscli/examples/docdb/delete-db-cluster-snapshot.rst new file mode 100644 index 00000000..e763bc0e --- /dev/null +++ b/aws/dist/awscli/examples/docdb/delete-db-cluster-snapshot.rst @@ -0,0 +1,36 @@ +**To delete an Amazon DocumentDB cluster snapshot** + +The following ``delete-db-cluster-snapshot`` example deletes the Amazon DocumentDB cluster snapshot ``sample-cluster-snapshot``. :: + + aws docdb delete-db-cluster-snapshot \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshot": { + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d" + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "VpcId": "vpc-91280df6", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "EngineVersion": "3.6.0", + "Engine": "docdb", + "SnapshotCreateTime": "2019-03-18T18:27:14.794Z", + "Status": "available", + "MasterUsername": "master-user", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "PercentProgress": 100, + "StorageEncrypted": false, + "SnapshotType": "manual", + "Port": 0 + } + } + + +For more information, see `Deleting a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/delete-db-cluster.rst b/aws/dist/awscli/examples/docdb/delete-db-cluster.rst new file mode 100644 index 00000000..cbec0a4b --- /dev/null +++ b/aws/dist/awscli/examples/docdb/delete-db-cluster.rst @@ -0,0 +1,51 @@ +**To delete an Amazon DocumentDB cluster** + +The following ``delete-db-cluster`` example deletes the Amazon DocumentDB cluster ``sample-cluster``. No backup of the cluster is made prior to deleting it. NOTE: You must delete all instances associated with the cluster before you can delete it. :: + + aws docdb delete-db-cluster \ + --db-cluster-identifier sample-cluster \ + --skip-final-snapshot + +Output:: + + { + "DBCluster": { + "DBClusterIdentifier": "sample-cluster", + "DBSubnetGroup": "default", + "EngineVersion": "3.6.0", + "Engine": "docdb", + "LatestRestorableTime": "2019-03-18T18:07:24.610Z", + "PreferredMaintenanceWindow": "sun:20:30-sun:21:00", + "StorageEncrypted": false, + "EarliestRestorableTime": "2019-03-18T18:07:24.610Z", + "Port": 27017, + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "MultiAZ": false, + "MasterUsername": "master-user", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "Status": "available", + "PreferredBackupWindow": "10:12-10:42", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "AvailabilityZones": [ + "us-west-2c", + "us-west-2b", + "us-west-2a" + ], + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DbClusterResourceId": "cluster-L3R4YRSBUYDP4GLMTJ2WF5GH5Q", + "ClusterCreateTime": "2019-03-18T18:06:34.616Z", + "AssociatedRoles": [], + "DBClusterParameterGroup": "default.docdb3.6", + "HostedZoneId": "ZNKXH85TT8WVW", + "BackupRetentionPeriod": 1, + "DBClusterMembers": [] + } + } + + +For more information, see `Deleting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/delete-db-instance.rst b/aws/dist/awscli/examples/docdb/delete-db-instance.rst new file mode 100644 index 00000000..863fa427 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/delete-db-instance.rst @@ -0,0 +1,83 @@ +**To delete an Amazon DocumentDB instance** + +The following ``delete-db-instance`` example deletes the Amazon DocumentDB instance ``sample-cluster-instance-2``. :: + + aws docdb delete-db-instance \ + --db-instance-identifier sample-cluster-instance-2 + +Output:: + + { + "DBInstance": { + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-91280df6", + "SubnetGroupStatus": "Complete" + }, + "PreferredBackupWindow": "00:00-00:30", + "InstanceCreateTime": "2019-03-18T18:37:33.709Z", + "DBInstanceClass": "db.r4.xlarge", + "DbiResourceId": "db-XEKJLEMGRV5ZKCARUVA4HO3ITE", + "BackupRetentionPeriod": 3, + "Engine": "docdb", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "AutoMinorVersionUpgrade": true, + "PromotionTier": 1, + "EngineVersion": "3.6.0", + "Endpoint": { + "Address": "sample-cluster-instance-2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "DBInstanceIdentifier": "sample-cluster-instance-2", + "PreferredMaintenanceWindow": "tue:10:28-tue:10:58", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "PendingModifiedValues": {}, + "DBInstanceStatus": "deleting", + "PubliclyAccessible": false, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance-2", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZone": "us-west-2c", + "StorageEncrypted": false + } + } + +For more information, see `Deleting an Amazon DocumentDB Instance `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/delete-db-subnet-group.rst b/aws/dist/awscli/examples/docdb/delete-db-subnet-group.rst new file mode 100644 index 00000000..fbd5056c --- /dev/null +++ b/aws/dist/awscli/examples/docdb/delete-db-subnet-group.rst @@ -0,0 +1,10 @@ +**To delete an Amazon DocumentDB subnet group** + +The following ``delete-db-subnet-group`` example deletes the Amazon DocumentDB subnet group ``sample-subnet-group``. :: + + aws docdb delete-db-subnet-group \ + --db-subnet-group-name sample-subnet-group + +This command produces no output. + +For more information, see `Deleting an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst b/aws/dist/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst new file mode 100644 index 00000000..d91a111a --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-cluster-parameter-groups.rst @@ -0,0 +1,21 @@ +**To see the details of one or more Amazon DocumentDB cluster parameter groups** + +The following ``describe-db-cluster-parameter-groups`` example displays details for the Amazon DocumentDB cluster parameter group ``custom3-6-param-grp``. :: + + aws docdb describe-db-cluster-parameter-groups \ + --db-cluster-parameter-group-name custom3-6-param-grp + +Output:: + + { + "DBClusterParameterGroups": [ + { + "DBParameterGroupFamily": "docdb3.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:custom3-6-param-grp", + "Description": "Custom docdb3.6 parameter group", + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Cluster Parameter Groups `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-cluster-parameters.rst b/aws/dist/awscli/examples/docdb/describe-db-cluster-parameters.rst new file mode 100644 index 00000000..4636d33b --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-cluster-parameters.rst @@ -0,0 +1,48 @@ +**To view the detailed parameter list for an Amazon DocumentDB cluster parameter group.** + +The following ``describe-db-cluster-parameters`` example lists the parameters for the Amazon DocumentDB parameter group custom3-6-param-grp. :: + + aws docdb describe-db-cluster-parameters \ + --db-cluster-parameter-group-name custom3-6-param-grp + +Output:: + + { + "Parameters": [ + { + "DataType": "string", + "ParameterName": "audit_logs", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "system", + "ApplyType": "dynamic", + "AllowedValues": "enabled,disabled", + "Description": "Enables auditing on cluster.", + "ParameterValue": "disabled" + }, + { + "DataType": "string", + "ParameterName": "tls", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "system", + "ApplyType": "static", + "AllowedValues": "disabled,enabled", + "Description": "Config to enable/disable TLS", + "ParameterValue": "enabled" + }, + { + "DataType": "string", + "ParameterName": "ttl_monitor", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "Source": "user", + "ApplyType": "dynamic", + "AllowedValues": "disabled,enabled", + "Description": "Enables TTL Monitoring", + "ParameterValue": "enabled" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Cluster Parameters `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst b/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst new file mode 100644 index 00000000..4e611b54 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshot-attributes.rst @@ -0,0 +1,22 @@ +**To list an Amazon DocumentDB snapshot attribute names and values** + +The following ``describe-db-cluster-snapshot-attributes`` example lists the attribute names and values for the Amazon DocumentDB snapshot ``sample-cluster-snapshot``. :: + + aws docdb describe-db-cluster-snapshot-attributes \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +For more information, see `DescribeDBClusterSnapshotAttributes `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshots.rst b/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshots.rst new file mode 100644 index 00000000..e916265d --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-cluster-snapshots.rst @@ -0,0 +1,37 @@ +**To describe Amazon DocumentDB snapshots** + +The following ``describe-db-cluster-snapshots`` example displays details for the Amazon DocumentDB snapshot ``sample-cluster-snapshot``. :: + + aws docdb describe-db-cluster-snapshots \ + --db-cluster-snapshot-identifier sample-cluster-snapshot + +Output:: + + { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b", + "us-west-2c", + "us-west-2d" + ], + "Status": "available", + "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot", + "SnapshotCreateTime": "2019-03-15T20:41:26.515Z", + "SnapshotType": "manual", + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot", + "DBClusterIdentifier": "sample-cluster", + "MasterUsername": "master-user", + "StorageEncrypted": false, + "VpcId": "vpc-91280df6", + "EngineVersion": "3.6.0", + "PercentProgress": 100, + "Port": 0, + "Engine": "docdb", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z" + } + ] + } + +For more information, see `DescribeDBClusterSnapshots `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-clusters.rst b/aws/dist/awscli/examples/docdb/describe-db-clusters.rst new file mode 100644 index 00000000..1e20b555 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-clusters.rst @@ -0,0 +1,67 @@ +**To get detailed information about one or more Amazon DocumentDB clusters.** + +The following ``describe-db-clusters`` example displays details for the Amazon DocumentDB cluster ``sample-cluster``. By omitting the ``--db-cluster-identifier`` parameter you can get information of up to 100 clusters. :: + + aws docdb describe-db-clusters + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBClusters": [ + { + "DBClusterParameterGroup": "default.docdb3.6", + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "PreferredBackupWindow": "00:00-00:30", + "DBClusterIdentifier": "sample-cluster", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "LatestRestorableTime": "2019-03-18T20:28:03.239Z", + "MasterUsername": "master-user", + "DBClusterMembers": [ + { + "PromotionTier": 1, + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": false, + "DBInstanceIdentifier": "sample-cluster" + }, + { + "PromotionTier": 1, + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": true, + "DBInstanceIdentifier": "sample-cluster2" + } + ], + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "Engine": "docdb", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBSubnetGroup": "default", + "MultiAZ": true, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 3, + "HostedZoneId": "ZNKXH85TT8WVW", + "StorageEncrypted": false, + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "AssociatedRoles": [], + "EngineVersion": "3.6.0", + "Port": 27017, + "Status": "available" + } + ] + } + +For more information, see `Describing Amazon DocumentDB Clusters `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-engine-versions.rst b/aws/dist/awscli/examples/docdb/describe-db-engine-versions.rst new file mode 100644 index 00000000..3e5fb3f2 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-engine-versions.rst @@ -0,0 +1,28 @@ +**To list available Amazon DocumentDB engine versions** + +The following ``describe-db-engine-versions`` example lists all available Amazon DocumentDB engine versions. :: + + aws docdb describe-db-engine-versions \ + --engine docdb + +Output:: + + { + "DBEngineVersions": [ + { + "DBEngineVersionDescription": "DocDB version 1.0.200837", + "DBParameterGroupFamily": "docdb3.6", + "EngineVersion": "3.6.0", + "ValidUpgradeTarget": [], + "DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)", + "SupportsLogExportsToCloudwatchLogs": true, + "Engine": "docdb", + "ExportableLogTypes": [ + "audit" + ] + } + ] + } + + +For more information, see `DescribeDBEngineVersions `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-instances.rst b/aws/dist/awscli/examples/docdb/describe-db-instances.rst new file mode 100644 index 00000000..bd86d7b9 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-instances.rst @@ -0,0 +1,85 @@ +**To find information about provisioned Amazon DocumentDB instances** + +The following ``describe-db-instances`` example displays details for about the Amazon DocumentDB instance ``sample-cluster-instance``. By omitting the ``--db-instance-identifier`` parameter you get information on up to 100 instances. :: + + aws docdb describe-db-instances \ + --db-instance-identifier sample-cluster-instance + +Output:: + + { + "DBInstances": [ + { + "Endpoint": { + "HostedZoneId": "ZNKXH85TT8WVW", + "Address": "sample-cluster-instance.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017 + }, + "PreferredBackupWindow": "00:00-00:30", + "DBInstanceStatus": "available", + "DBInstanceClass": "db.r4.large", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "DBInstanceIdentifier": "sample-cluster-instance", + "DBSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-4e26d263", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-afc329f4", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ], + "DBSubnetGroupName": "default", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-91280df6" + }, + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "Engine": "docdb", + "StorageEncrypted": false, + "AutoMinorVersionUpgrade": true, + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster-instance", + "PreferredMaintenanceWindow": "tue:08:39-tue:09:09", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "DBClusterIdentifier": "sample-cluster", + "PendingModifiedValues": {}, + "BackupRetentionPeriod": 3, + "PubliclyAccessible": false, + "EngineVersion": "3.6.0", + "PromotionTier": 1, + "AvailabilityZone": "us-west-2c", + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA" + } + ] + } + +For more information, see `Describing Amazon DocumentDB Instances `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-db-subnet-groups.rst b/aws/dist/awscli/examples/docdb/describe-db-subnet-groups.rst new file mode 100644 index 00000000..fc38aea8 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-db-subnet-groups.rst @@ -0,0 +1,53 @@ +**To retrieve a list of Amazon DocumentDB subnet descriptions** + +The following ``describe-db-subnet-groups`` example describes details for the Amazon DocumentDB subnet named ``default``. :: + + aws docdb describe-db-subnet-groups \ + --db-subnet-group-name default + +Output:: + + { + "DBSubnetGroups": [ + { + "VpcId": "vpc-91280df6", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:default", + "Subnets": [ + { + "SubnetIdentifier": "subnet-4e26d263", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetIdentifier": "subnet-afc329f4", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + } + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ], + "DBSubnetGroupName": "default", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupDescription": "default" + } + ] + } + + +For more information, see `Describing Subnet Groups `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst b/aws/dist/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst new file mode 100644 index 00000000..08ca99ff --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-engine-default-cluster-parameters.rst @@ -0,0 +1,51 @@ +**To describe the default engine and system parameter information for Amazon DocumentDB** + +The following ``describe-engine-default-cluster-parameters`` example displays details for the default engine and system parameter information for the Amazon DocumentDB parameter group ``docdb3.6``. :: + + aws docdb describe-engine-default-cluster-parameters \ + --db-parameter-group-family docdb3.6 + +Output:: + + { + "EngineDefaults": { + "DBParameterGroupFamily": "docdb3.6", + "Parameters": [ + { + "ApplyType": "dynamic", + "ParameterValue": "disabled", + "Description": "Enables auditing on cluster.", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "enabled,disabled", + "ParameterName": "audit_logs", + "IsModifiable": true + }, + { + "ApplyType": "static", + "ParameterValue": "enabled", + "Description": "Config to enable/disable TLS", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "disabled,enabled", + "ParameterName": "tls", + "IsModifiable": true + }, + { + "ApplyType": "dynamic", + "ParameterValue": "enabled", + "Description": "Enables TTL Monitoring", + "Source": "system", + "DataType": "string", + "MinimumEngineVersion": "3.6.0", + "AllowedValues": "disabled,enabled", + "ParameterName": "ttl_monitor", + "IsModifiable": true + } + ] + } + } + +For more information, see `DescribeEngineDefaultClusterParameters `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-event-categories.rst b/aws/dist/awscli/examples/docdb/describe-event-categories.rst new file mode 100644 index 00000000..d5957537 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-event-categories.rst @@ -0,0 +1,24 @@ +**To describe all Amazon DocumentDB event categories** + +The following ``describe-event-categories`` example lists all categories for the Amazon DocumentDB event source type ``db-instance``. :: + + aws docdb describe-event-categories \ + --source-type db-cluster + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "maintenance", + "notification", + "failure" + ] + } + ] + } + +For more information, see `Viewing Event Categories `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-events.rst b/aws/dist/awscli/examples/docdb/describe-events.rst new file mode 100644 index 00000000..38dfbe69 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-events.rst @@ -0,0 +1,151 @@ +**To list Amazon DocumentDB events** + +The following ``describe-events`` example list all the Amazon DocumentDB events for the last 24 hours (1440 minutes). :: + + aws docdb describe-events \ + --duration 1440 + +This command produces no output. +Output:: + + { + "Events": [ + { + "EventCategories": [ + "failover" + ], + "Message": "Started cross AZ failover to DB instance: sample-cluster", + "Date": "2019-03-18T21:36:29.807Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-cluster" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-18T21:36:40.793Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-instance" + }, + { + "EventCategories": [], + "Message": "A new writer was promoted. Restarting database as a reader.", + "Date": "2019-03-18T21:36:43.873Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-18T21:36:51.257Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "failover" + ], + "Message": "Completed failover to DB instance: sample-cluster", + "Date": "2019-03-18T21:36:53.462Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "SourceIdentifier": "sample-cluster", + "SourceType": "db-cluster" + }, + { + "Date": "2019-03-19T16:51:48.847Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter audit_logs to enabled with apply method pending-reboot", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + }, + { + "EventCategories": [ + "configuration change" + ], + "Message": "Applying modification to database instance class", + "Date": "2019-03-19T17:55:20.095Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance shutdown", + "Date": "2019-03-19T17:56:31.127Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "configuration change" + ], + "Message": "Finished applying modification to DB instance class", + "Date": "2019-03-19T18:00:45.822Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-19T18:00:53.397Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance shutdown", + "Date": "2019-03-19T18:23:36.045Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "EventCategories": [ + "availability" + ], + "Message": "DB instance restarted", + "Date": "2019-03-19T18:23:46.209Z", + "SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "SourceIdentifier": "sample-cluster2", + "SourceType": "db-instance" + }, + { + "Date": "2019-03-19T18:39:05.822Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter ttl_monitor to enabled with apply method immediate", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + }, + { + "Date": "2019-03-19T18:39:48.067Z", + "EventCategories": [ + "configuration change" + ], + "Message": "Updated parameter audit_logs to disabled with apply method immediate", + "SourceIdentifier": "custom3-6-param-grp", + "SourceType": "db-parameter-group" + } + ] + } + +For more information, see `Viewing Amazon DocumentDB Events `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-orderable-db-instance-options.rst b/aws/dist/awscli/examples/docdb/describe-orderable-db-instance-options.rst new file mode 100644 index 00000000..6148c358 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-orderable-db-instance-options.rst @@ -0,0 +1,144 @@ +**To find the Amazon DocumentDB instance options you can order** + +The following ``describe-orderable-db-instance-options`` example lists all instance options for Amazon DocumentDB for a region. :: + + aws docdb describe-orderable-db-instance-options \ + --engine docdb \ + --region us-east-1 + +Output:: + + { + "OrderableDBInstanceOptions": [ + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.16xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.2xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.4xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.8xlarge", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.large", + "LicenseModel": "na", + "Engine": "docdb" + }, + { + "Vpc": true, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "EngineVersion": "3.6.0", + "DBInstanceClass": "db.r4.xlarge", + "LicenseModel": "na", + "Engine": "docdb" + } + ] + } + + +For more information, see `Adding an Amazon DocumentDB Instance to a Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/describe-pending-maintenance-actions.rst b/aws/dist/awscli/examples/docdb/describe-pending-maintenance-actions.rst new file mode 100644 index 00000000..58b78009 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/describe-pending-maintenance-actions.rst @@ -0,0 +1,13 @@ +**To list your pending Amazon DocumentDB maintenance actions** + +The following ``describe-pending-maintenance-actions`` example lists all your pending Amazon DocumentDB maintenance actions. :: + + aws docdb describe-pending-maintenance-actions + +Output:: + + { + "PendingMaintenanceActions": [] + } + +For more information, see `Maintaining Amazon DocumentDB `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/failover-db-cluster.rst b/aws/dist/awscli/examples/docdb/failover-db-cluster.rst new file mode 100644 index 00000000..9c5d884f --- /dev/null +++ b/aws/dist/awscli/examples/docdb/failover-db-cluster.rst @@ -0,0 +1,65 @@ +**To force an Amazon DocumentDB cluster to failover to a replica** + +The following ``failover-db-cluster`` example causes the primary instance in the Amazon DocumentDB cluster sample-cluster to failover to a replica. :: + + aws docdb failover-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "AssociatedRoles": [], + "DBClusterIdentifier": "sample-cluster", + "EngineVersion": "3.6.0", + "DBSubnetGroup": "default", + "MasterUsername": "master-user", + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "LatestRestorableTime": "2019-03-18T21:35:23.548Z", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "PreferredBackupWindow": "00:00-00:30", + "Port": 27017, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "StorageEncrypted": false, + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "MultiAZ": true, + "Status": "available", + "DBClusterMembers": [ + { + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": false, + "DBInstanceIdentifier": "sample-cluster", + "PromotionTier": 1 + }, + { + "DBClusterParameterGroupStatus": "in-sync", + "IsClusterWriter": true, + "DBInstanceIdentifier": "sample-cluster2", + "PromotionTier": 2 + } + ], + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "DBClusterParameterGroup": "default.docdb3.6", + "HostedZoneId": "ZNKXH85TT8WVW", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 3, + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Engine": "docdb" + } + } + +For more information, see `Amazon DocumentDB Failover `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/list-tags-for-resource.rst b/aws/dist/awscli/examples/docdb/list-tags-for-resource.rst new file mode 100644 index 00000000..f0cbc419 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/list-tags-for-resource.rst @@ -0,0 +1,27 @@ +**To list all the tags on an Amazon DocumentDB resource** + +The following ``list-tags-for-resource`` example lists all tags on the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb list-tags-for-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster + +Output:: + + { + "TagList": [ + { + "Key": "A", + "Value": "ALPHA" + }, + { + "Key": "B", + "Value": "" + }, + { + "Key": "C", + "Value": "CHARLIE" + } + ] + } + +For more information, see `Listing Tags on an Amazon DocumentDB Resource `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/modify-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/docdb/modify-db-cluster-parameter-group.rst new file mode 100644 index 00000000..248bc1ea --- /dev/null +++ b/aws/dist/awscli/examples/docdb/modify-db-cluster-parameter-group.rst @@ -0,0 +1,16 @@ +**To modify an Amazon DocumentDB DB cluster parameter group** + +The following ``modify-db-cluster-parameter-group`` example modifies the Amazon DocumentDB cluster parameter group ``custom3-6-param-grp`` by setting the two parameters ``audit_logs`` and ``ttl_monitor`` to enabled. The changes are applied at the next reboot. :: + + aws docdb modify-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --parameters ParameterName=audit_logs,ParameterValue=enabled,ApplyMethod=pending-reboot \ + ParameterName=ttl_monitor,ParameterValue=enabled,ApplyMethod=pending-reboot + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `Modifying an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst b/aws/dist/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst new file mode 100644 index 00000000..0823a3f7 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/modify-db-cluster-snapshot-attribute.rst @@ -0,0 +1,55 @@ +**Example 1: To add an attribute to an Amazon DocumentDB snapshot** + +The following ``modify-db-cluster-snapshot-attribute`` example adds four attribute values to an Amazon DocumentDB cluster snapshot. :: + + aws docdb modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier sample-cluster-snapshot \ + --attribute-name restore \ + --values-to-add all 123456789011 123456789012 123456789013 + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "all", + "123456789011", + "123456789012", + "123456789013" + ] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +**Example 2: To remove attributes from an Amazon DocumentDB snapshot** + +The following ``modify-db-cluster-snapshot-attribute`` example removes two attribute values from an Amazon DocumentDB cluster snapshot. :: + + aws docdb modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier sample-cluster-snapshot \ + --attribute-name restore \ + --values-to-remove 123456789012 all + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789011", + "123456789013" + ] + } + ], + "DBClusterSnapshotIdentifier": "sample-cluster-snapshot" + } + } + +For more information, see `ModifyDBClusterSnapshotAttribute `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/modify-db-cluster.rst b/aws/dist/awscli/examples/docdb/modify-db-cluster.rst new file mode 100644 index 00000000..9b65b2f5 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/modify-db-cluster.rst @@ -0,0 +1,69 @@ +**To modify an Amazon DocumentDB cluster** + +The following ``modify-db-cluster`` example modifies the Amazon DocumentDB cluster ``sample-cluster`` by making the retention period for automatic backups 7 days, and changing the preferred windows for both backups and maintenance. All changes are applied at the next maintenance window. :: + + aws docdb modify-db-cluster \ + --db-cluster-identifier sample-cluster \ + --no-apply-immediately \ + --backup-retention-period 7 \ + --preferred-backup-window 18:00-18:30 \ + --preferred-maintenance-window sun:20:00-sun:20:30 + +Output:: + + { + "DBCluster": { + "Endpoint": "sample-cluster.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBClusterMembers": [ + { + "DBClusterParameterGroupStatus": "in-sync", + "DBInstanceIdentifier": "sample-cluster", + "IsClusterWriter": true, + "PromotionTier": 1 + }, + { + "DBClusterParameterGroupStatus": "in-sync", + "DBInstanceIdentifier": "sample-cluster2", + "IsClusterWriter": false, + "PromotionTier": 2 + } + ], + "HostedZoneId": "ZNKXH85TT8WVW", + "StorageEncrypted": false, + "PreferredBackupWindow": "18:00-18:30", + "MultiAZ": true, + "EngineVersion": "3.6.0", + "MasterUsername": "master-user", + "ReaderEndpoint": "sample-cluster.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DBSubnetGroup": "default", + "LatestRestorableTime": "2019-03-18T22:08:13.408Z", + "EarliestRestorableTime": "2019-03-15T20:30:47.020Z", + "PreferredMaintenanceWindow": "sun:20:00-sun:20:30", + "AssociatedRoles": [], + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "Engine": "docdb", + "DBClusterParameterGroup": "default.docdb3.6", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster", + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "Status": "available", + "DbClusterResourceId": "cluster-UP4EF2PVDDFVHHDJQTYDAIGHLE", + "ClusterCreateTime": "2019-03-15T20:29:58.836Z", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "Port": 27017 + } + } + +For more information, see `Modifying an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/modify-db-instance.rst b/aws/dist/awscli/examples/docdb/modify-db-instance.rst new file mode 100644 index 00000000..9ad34942 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/modify-db-instance.rst @@ -0,0 +1,88 @@ +**To modify an Amazon DocumentDB instance** + +The following ``modify-db-instance`` example modifies the Amazon DocumentDB instance ``sample-cluster2`` by changing its instance class to ``db.r4.4xlarge`` and its promotion tier to ``5``. The changes are applied immediately but can only be seen after the instances status is available. :: + + aws docdb modify-db-instance \ + --db-instance-identifier sample-cluster2 \ + --apply-immediately \ + --db-instance-class db.r4.4xlarge \ + --promotion-tier 5 + +Output:: + + { + "DBInstance": { + "EngineVersion": "3.6.0", + "StorageEncrypted": false, + "DBInstanceClass": "db.r4.large", + "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", + "AutoMinorVersionUpgrade": true, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "PreferredBackupWindow": "18:00-18:30", + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "AvailabilityZone": "us-west-2f", + "DBInstanceIdentifier": "sample-cluster2", + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "Engine": "docdb", + "BackupRetentionPeriod": 7, + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-4e26d263", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-afc329f4", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetStatus": "Active" + } + ], + "VpcId": "vpc-91280df6" + }, + "PromotionTier": 2, + "Endpoint": { + "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", + "DBClusterIdentifier": "sample-cluster", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "PendingModifiedValues": { + "DBInstanceClass": "db.r4.4xlarge" + }, + "PubliclyAccessible": false, + "DBInstanceStatus": "available" + } + } + +For more information, see `Modifying an Amazon DocumentDB Instance `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/modify-db-subnet-group.rst b/aws/dist/awscli/examples/docdb/modify-db-subnet-group.rst new file mode 100644 index 00000000..d699fdf0 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/modify-db-subnet-group.rst @@ -0,0 +1,45 @@ +**To modify an Amazon DocumentDB subnet group** + +The following ``modify-db-subnet-group`` example modifies the subnet group ``sample-subnet-group`` by adding the specified subnets and a new description. :: + + aws docdb modify-db-subnet-group \ + --db-subnet-group-name sample-subnet-group \ + --subnet-ids subnet-b3806e8f subnet-53ab3636 subnet-991cb8d0 \ + --db-subnet-group-description "New subnet description" + +Output:: + + { + "DBSubnetGroup": { + "DBSubnetGroupName": "sample-subnet-group", + "SubnetGroupStatus": "Complete", + "DBSubnetGroupArn": "arn:aws:rds:us-west-2:123456789012:subgrp:sample-subnet-group", + "VpcId": "vpc-91280df6", + "DBSubnetGroupDescription": "New subnet description", + "Subnets": [ + { + "SubnetIdentifier": "subnet-b3806e8f", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + } + }, + { + "SubnetIdentifier": "subnet-53ab3636", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + } + }, + { + "SubnetIdentifier": "subnet-991cb8d0", + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + } + } + ] + } + } + +For more information, see `Modifying an Amazon DocumentDB Subnet Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/reboot-db-instance.rst b/aws/dist/awscli/examples/docdb/reboot-db-instance.rst new file mode 100644 index 00000000..91a18ae8 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/reboot-db-instance.rst @@ -0,0 +1,84 @@ +**To reboot an Amazon DocumentDB instance** + +The following ``reboot-db-instance`` example reboots the Amazon DocumentDB instance ``sample-cluster2``. :: + + aws docdb reboot-db-instance \ + --db-instance-identifier sample-cluster2 + +This command produces no output. +Output:: + + { + "DBInstance": { + "PreferredBackupWindow": "18:00-18:30", + "DBInstanceIdentifier": "sample-cluster2", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ], + "DBSubnetGroup": { + "VpcId": "vpc-91280df6", + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2a" + }, + "SubnetIdentifier": "subnet-4e26d263" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2c" + }, + "SubnetIdentifier": "subnet-afc329f4" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2d" + }, + "SubnetIdentifier": "subnet-53ab3636" + }, + { + "SubnetStatus": "Active", + "SubnetAvailabilityZone": { + "Name": "us-west-2b" + }, + "SubnetIdentifier": "subnet-991cb8d0" + } + ], + "SubnetGroupStatus": "Complete", + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default" + }, + "PendingModifiedValues": {}, + "Endpoint": { + "Address": "sample-cluster2.corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "HostedZoneId": "ZNKXH85TT8WVW", + "Port": 27017 + }, + "EnabledCloudwatchLogsExports": [ + "audit" + ], + "StorageEncrypted": false, + "DbiResourceId": "db-A2GIKUV6KPOHITGGKI2NHVISZA", + "AutoMinorVersionUpgrade": true, + "Engine": "docdb", + "InstanceCreateTime": "2019-03-15T20:36:06.338Z", + "EngineVersion": "3.6.0", + "PromotionTier": 5, + "BackupRetentionPeriod": 7, + "DBClusterIdentifier": "sample-cluster", + "PreferredMaintenanceWindow": "mon:08:39-mon:09:09", + "PubliclyAccessible": false, + "DBInstanceClass": "db.r4.4xlarge", + "AvailabilityZone": "us-west-2d", + "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2", + "DBInstanceStatus": "rebooting" + } + } + +For more information, see `Rebooting an Amazon DocumentDB ILnstance `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/remove-tags-from-resource.rst b/aws/dist/awscli/examples/docdb/remove-tags-from-resource.rst new file mode 100644 index 00000000..5db2734e --- /dev/null +++ b/aws/dist/awscli/examples/docdb/remove-tags-from-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from an Amazon DocumentDB resource** + +The following ``remove-tags-from-resource`` example removes the tag with the key named ``B`` from the Amazon DocumentDB cluster ``sample-cluster``. :: + + aws docdb remove-tags-from-resource \ + --resource-name arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --tag-keys B + +This command produces no output. + +For more information, see `Removing Tags from an Amazon DocumentDBResource `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/reset-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/docdb/reset-db-cluster-parameter-group.rst new file mode 100644 index 00000000..f1b57160 --- /dev/null +++ b/aws/dist/awscli/examples/docdb/reset-db-cluster-parameter-group.rst @@ -0,0 +1,31 @@ +**To reset the specified parameter value to its defaults in an Amazon DocumentDB parameter group** + +The following ``reset-db-cluster-parameter-group`` example resets the parameter ``ttl_monitor`` in the Amazon DocumentDB parameter group ``custom3-6-param-grp`` to its default value. :: + + aws docdb reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --parameters ParameterName=ttl_monitor,ApplyMethod=immediate + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `title `__ in the *Amazon DocumentDB Developer Guide*. + +**To reset specified or all parameter values to their defaults in an Amazon DocumentDB parameter group** + +The following ``reset-db-cluster-parameter-group`` example resets all parameters in the Amazon DocumentDB parameter group ``custom3-6-param-grp`` to their default value. :: + + aws docdb reset-db-cluster-parameter-group \ + --db-cluster-parameter-group-name custom3-6-param-grp \ + --reset-all-parameters + +Output:: + + { + "DBClusterParameterGroupName": "custom3-6-param-grp" + } + +For more information, see `Resetting an Amazon DocumentDB Cluster Parameter Group `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst b/aws/dist/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst new file mode 100644 index 00000000..9f18c85a --- /dev/null +++ b/aws/dist/awscli/examples/docdb/restore-db-cluster-from-snapshot.rst @@ -0,0 +1,50 @@ +**To restore an Amazon DocumentDB cluster from an automatic or manual snapshot** + +The following ``restore-db-cluster-from-snapshot`` example creates a new Amazon DocumentDB cluster named ``sample-cluster-2019-03-16-00-01-restored`` from the snapshot ``rds:sample-cluster-2019-03-16-00-01``. :: + + aws docdb restore-db-cluster-from-snapshot \ + --db-cluster-identifier sample-cluster-2019-03-16-00-01-restored \ + --engine docdb \ + --snapshot-identifier rds:sample-cluster-2019-03-16-00-01 + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-west-2a", + "us-west-2c", + "us-west-2b" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + + +For more information, see `Restoring from a Cluster Snapshot `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst b/aws/dist/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst new file mode 100644 index 00000000..1be3216c --- /dev/null +++ b/aws/dist/awscli/examples/docdb/restore-db-cluster-to-point-in-time.rst @@ -0,0 +1,49 @@ +**To restore an Amazon DocumentDB cluster to a point-in-time from a manual snapshot** + +The following ``restore-db-cluster-to-point-in-time`` example uses the ``sample-cluster-snapshot`` to create a new Amazon DocumentDB cluster, ``sample-cluster-pit``, using the latest restorable time. :: + + aws docdb restore-db-cluster-to-point-in-time \ + --db-cluster-identifier sample-cluster-pit \ + --source-db-cluster-identifier arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster \ + --use-latest-restorable-time + +Output:: + + { + "DBCluster": { + "StorageEncrypted": false, + "BackupRetentionPeriod": 3, + "MasterUsername": "master-user", + "HostedZoneId": "ZNKXH85TT8WVW", + "PreferredBackupWindow": "00:00-00:30", + "MultiAZ": false, + "DBClusterIdentifier": "sample-cluster-pit", + "DBSubnetGroup": "default", + "ClusterCreateTime": "2019-04-03T15:55:21.320Z", + "AssociatedRoles": [], + "DBClusterParameterGroup": "default.docdb3.6", + "DBClusterMembers": [], + "Status": "creating", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2d", + "us-west-2b" + ], + "ReaderEndpoint": "sample-cluster-pit.cluster-ro-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "Port": 27017, + "Engine": "docdb", + "EngineVersion": "3.6.0", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-77186e0d", + "Status": "active" + } + ], + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "Endpoint": "sample-cluster-pit.cluster-corcjozrlsfc.us-west-2.docdb.amazonaws.com", + "DbClusterResourceId": "cluster-NLCABBXOSE2QPQ4GOLZIFWEPLM", + "DBClusterArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster-pit" + } + } + +For more information, see `Restoring a Snapshot to a Point in Time `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/start-db-cluster.rst b/aws/dist/awscli/examples/docdb/start-db-cluster.rst new file mode 100644 index 00000000..f477ffae --- /dev/null +++ b/aws/dist/awscli/examples/docdb/start-db-cluster.rst @@ -0,0 +1,47 @@ +**To start a stopped Amazon DocumentDB cluster** + +The following ``start-db-cluster`` example starts the specified Amazon DocumentDB cluster. :: + + aws docdb start-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1c", + "us-east-1f" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + +For more information, see `Stopping and Starting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/stop-db-cluster.rst b/aws/dist/awscli/examples/docdb/stop-db-cluster.rst new file mode 100644 index 00000000..afc9809d --- /dev/null +++ b/aws/dist/awscli/examples/docdb/stop-db-cluster.rst @@ -0,0 +1,47 @@ +**To stop a running Amazon DocumentDB cluster** + +The following ``stop-db-cluster`` example stops the specified Amazon DocumentDB cluster. :: + + aws docdb stop-db-cluster \ + --db-cluster-identifier sample-cluster + +Output:: + + { + "DBCluster": { + "ClusterCreateTime": "2019-03-19T18:45:01.857Z", + "HostedZoneId": "ZNKXH85TT8WVW", + "Engine": "docdb", + "DBClusterMembers": [], + "MultiAZ": false, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1c", + "us-east-1f" + ], + "StorageEncrypted": false, + "ReaderEndpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-ro-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Endpoint": "sample-cluster-2019-03-16-00-01-restored.cluster-corcjozrlsfc.us-east-1.docdb.amazonaws.com", + "Port": 27017, + "PreferredBackupWindow": "00:00-00:30", + "DBSubnetGroup": "default", + "DBClusterIdentifier": "sample-cluster-2019-03-16-00-01-restored", + "PreferredMaintenanceWindow": "sat:04:30-sat:05:00", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster-2019-03-16-00-01-restored", + "DBClusterParameterGroup": "default.docdb3.6", + "DbClusterResourceId": "cluster-XOO46Q3RH4LWSYNH3NMZKXPISU", + "MasterUsername": "master-user", + "EngineVersion": "3.6.0", + "BackupRetentionPeriod": 3, + "AssociatedRoles": [], + "Status": "creating", + "VpcSecurityGroups": [ + { + "Status": "active", + "VpcSecurityGroupId": "sg-77186e0d" + } + ] + } + } + +For more information, see `Stopping and Starting an Amazon DocumentDB Cluster `__ in the *Amazon DocumentDB Developer Guide*. diff --git a/aws/dist/awscli/examples/docdb/wait/db-instance-available.rst b/aws/dist/awscli/examples/docdb/wait/db-instance-available.rst new file mode 100644 index 00000000..161aff9c --- /dev/null +++ b/aws/dist/awscli/examples/docdb/wait/db-instance-available.rst @@ -0,0 +1,8 @@ +**To pause running until the specified instance is available** + +The following ``wait role-exists`` command pauses and continues only after it can confirm that the specified database cluster instance exists. :: + + aws docdb wait db-instance-available \ + --db-instance-identifier "sample-instance" + +This command produces no output. diff --git a/aws/dist/awscli/examples/docdb/wait/db-instance-deleted.rst b/aws/dist/awscli/examples/docdb/wait/db-instance-deleted.rst new file mode 100644 index 00000000..523f5afd --- /dev/null +++ b/aws/dist/awscli/examples/docdb/wait/db-instance-deleted.rst @@ -0,0 +1,8 @@ +**To pause running until the specified cluster instance is deleted** + +The following ``wait db-instance-deleted`` command pauses and continues only after it can confirm that the specified database cluster instance is deleted. :: + + aws docdb wait db-instance-deleted \ + --db-instance-identifier "sample-instance" + +This command produces no output. diff --git a/aws/dist/awscli/examples/dynamodb/batch-get-item.rst b/aws/dist/awscli/examples/dynamodb/batch-get-item.rst new file mode 100644 index 00000000..df0f2077 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/batch-get-item.rst @@ -0,0 +1,54 @@ +**To retrieve multiple items from a table** + +This example reads multiple items from the *MusicCollection* table using a batch of three GetItem requests. Only the *AlbumTitle* attribute is returned. + +Command:: + + aws dynamodb batch-get-item --request-items file://request-items.json + +The arguments for ``--request-items`` are stored in a JSON file, ``request-items.json``. Here are the contents of that file:: + + { + "MusicCollection": { + "Keys": [ + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"} + }, + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + }, + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"} + } + ], + "ProjectionExpression":"AlbumTitle" + } + } + +Output:: + + { + "UnprocessedKeys": {}, + "Responses": { + "MusicCollection": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + } diff --git a/aws/dist/awscli/examples/dynamodb/batch-write-item.rst b/aws/dist/awscli/examples/dynamodb/batch-write-item.rst new file mode 100644 index 00000000..2a0da991 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/batch-write-item.rst @@ -0,0 +1,47 @@ +**To add multiple items to a table** + +This example adds three new items to the *MusicCollection* table using a batch of three PutItem requests. + +Command:: + + aws dynamodb batch-write-item --request-items file://request-items.json + +The arguments for ``--request-items`` are stored in a JSON file, ``request-items.json``. Here are the contents of that file:: + + { + "MusicCollection": [ + { + "PutRequest": { + "Item": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"}, + "AlbumTitle": {"S": "Somewhat Famous"} + } + } + }, + { + "PutRequest": { + "Item": { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"}, + "AlbumTitle": {"S": "Songs About Life"} + } + } + }, + { + "PutRequest": { + "Item": { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"}, + "AlbumTitle": {"S": "Blue Sky Blues"} + } + } + } + ] + } + +Output:: + + { + "UnprocessedItems": {} + } diff --git a/aws/dist/awscli/examples/dynamodb/create-table.rst b/aws/dist/awscli/examples/dynamodb/create-table.rst new file mode 100644 index 00000000..18b5a34a --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/create-table.rst @@ -0,0 +1,44 @@ +**To create a table** + +This example creates a table named *MusicCollection*. + +Command:: + + aws dynamodb create-table --table-name MusicCollection --attribute-definitions AttributeName=Artist,AttributeType=S AttributeName=SongTitle,AttributeType=S --key-schema AttributeName=Artist,KeyType=HASH AttributeName=SongTitle,KeyType=RANGE --provisioned-throughput ReadCapacityUnits=5,WriteCapacityUnits=5 + +Output:: + + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "CREATING", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } diff --git a/aws/dist/awscli/examples/dynamodb/delete-item.rst b/aws/dist/awscli/examples/dynamodb/delete-item.rst new file mode 100644 index 00000000..ea076a3a --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/delete-item.rst @@ -0,0 +1,23 @@ +**To delete an item** + +This example deletes an item from the *MusicCollection* table. + +Command:: + + aws dynamodb delete-item --table-name MusicCollection --key file://key.json + +The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: + + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Scared of My Shadow"} + } + +Output:: + + { + "ConsumedCapacity": { + "CapacityUnits": 1.0, + "TableName": "MusicCollection" + } + } diff --git a/aws/dist/awscli/examples/dynamodb/delete-table.rst b/aws/dist/awscli/examples/dynamodb/delete-table.rst new file mode 100644 index 00000000..6eb25330 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/delete-table.rst @@ -0,0 +1,23 @@ +**To delete a table** + +This example deletes the *MusicCollection* table. + +Command:: + + aws dynamodb delete-table --table-name MusicCollection + +Output:: + + { + "TableDescription": { + "TableStatus": "DELETING", + "TableSizeBytes": 0, + "ItemCount": 0, + "TableName": "MusicCollection", + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + } + } + } diff --git a/aws/dist/awscli/examples/dynamodb/describe-table.rst b/aws/dist/awscli/examples/dynamodb/describe-table.rst new file mode 100644 index 00000000..4b866138 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/describe-table.rst @@ -0,0 +1,44 @@ +**To describe a table** + +This example describes the *MusicCollection* table. + +Command:: + + aws dynamodb describe-table --table-name MusicCollection + +Output:: + + { + "Table": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 5, + "ReadCapacityUnits": 5 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "ACTIVE", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } diff --git a/aws/dist/awscli/examples/dynamodb/get-item.rst b/aws/dist/awscli/examples/dynamodb/get-item.rst new file mode 100644 index 00000000..48167787 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/get-item.rst @@ -0,0 +1,32 @@ +**To read an item in a table** + +This example retrieves an item from the *MusicCollection* table. The table has a hash-and-range primary key (*Artist* and *SongTitle*), so you must specify both of these attributes. + + +Command:: + + aws dynamodb get-item --table-name MusicCollection --key file://key.json + +The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: + + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + } + + +Output:: + + { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } diff --git a/aws/dist/awscli/examples/dynamodb/list-tables.rst b/aws/dist/awscli/examples/dynamodb/list-tables.rst new file mode 100644 index 00000000..3c4f1f68 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/list-tables.rst @@ -0,0 +1,18 @@ +**To list tables** + +This example lists all of the tables associated with the current AWS account and endpoint + +Command:: + + aws dynamodb list-tables + +Output:: + + { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread", + ] + } diff --git a/aws/dist/awscli/examples/dynamodb/put-item.rst b/aws/dist/awscli/examples/dynamodb/put-item.rst new file mode 100644 index 00000000..967e9fd9 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/put-item.rst @@ -0,0 +1,40 @@ +**To add an item to a table** + +This example adds a new item to the *MusicCollection* table. + +Command:: + + aws dynamodb put-item --table-name MusicCollection --item file://item.json --return-consumed-capacity TOTAL + +The arguments for ``--item`` are stored in a JSON file, ``item.json``. Here are the contents of that file:: + + { + "Artist": {"S": "No One You Know"}, + "SongTitle": {"S": "Call Me Today"}, + "AlbumTitle": {"S": "Somewhat Famous"} + } + +Output:: + + { + "ConsumedCapacity": { + "CapacityUnits": 1.0, + "TableName": "MusicCollection" + } + } + + +**Conditional Expressions** + +This example shows how to perform a one-line conditional expression operation. This put-item call to the table *MusicCollection* table will only succeed if the artist "Obscure Indie Band" does not exist in the table. + +Command:: + + aws dynamodb put-item --table-name MusicCollection --item '{"Artist": {"S": "Obscure Indie Band"}}' --condition-expression "attribute_not_exists(Artist)" + + +If the key already exists, you should see: + +Output:: + + A client error (ConditionalCheckFailedException) occurred when calling the PutItem operation: The conditional request failed diff --git a/aws/dist/awscli/examples/dynamodb/query.rst b/aws/dist/awscli/examples/dynamodb/query.rst new file mode 100644 index 00000000..c98843f9 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/query.rst @@ -0,0 +1,32 @@ +**To query an item** + +This example queries items in the *MusicCollection* table. The table has a hash-and-range primary key (*Artist* and *SongTitle*), but this query only specifies the hash key value. It returns song titles by the artist named "No One You Know". + +Command:: + + aws dynamodb query --table-name MusicCollection --projection-expression "SongTitle" --key-condition-expression "Artist = :v1" --expression-attribute-values file://expression-attributes.json + + +The arguments for ``--expression-attribute-values`` are stored in a JSON file named ``expression-attributes.json``:: + + { + ":v1": {"S": "No One You Know"} + } + +Output:: + + { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ScannedCount": 2, + "ConsumedCapacity": null + } diff --git a/aws/dist/awscli/examples/dynamodb/scan.rst b/aws/dist/awscli/examples/dynamodb/scan.rst new file mode 100644 index 00000000..d871ce5d --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/scan.rst @@ -0,0 +1,47 @@ +**To scan a table** + +This example scans the entire *MusicCollection* table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned. + +Command:: + + aws dynamodb scan --table-name MusicCollection --filter-expression "Artist = :a" --projection-expression "#ST, #AT" --expression-attribute-names file://expression-attribute-names.json --expression-attribute-values file://expression-attribute-values.json + +The arguments for ``--expression-attribute-names`` are stored in a JSON file, ``expression-attribute-names.json``. Here are the contents of that file:: + + { + "#ST": "SongTitle", + "#AT":"AlbumTitle" + } + + +The arguments for ``--expression-attribute-values`` are stored in a JSON file, ``expression-attribute-values.json``. Here are the contents of that file:: + + { + ":a": {"S": "No One You Know"} + } + +Output:: + + { + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + }, + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "SongTitle": { + "S": "Scared of My Shadow" + }, + "AlbumTitle": { + "S": "Blue Sky Blues" + } + } + ], + "ScannedCount": 3, + "ConsumedCapacity": null + } diff --git a/aws/dist/awscli/examples/dynamodb/update-item.rst b/aws/dist/awscli/examples/dynamodb/update-item.rst new file mode 100644 index 00000000..09ce1200 --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/update-item.rst @@ -0,0 +1,45 @@ +**To update an item in a table** + +This example updates an item in the *MusicCollection* table. It adds a new attribute (*Year*) and modifies the *AlbumTitle* attribute. All of the attributes in the item, as they appear after the update, are returned in the response. + + +Command:: + + aws dynamodb update-item --table-name MusicCollection --key file://key.json --update-expression "SET #Y = :y, #AT = :t" --expression-attribute-names file://expression-attribute-names.json --expression-attribute-values file://expression-attribute-values.json --return-values ALL_NEW + +The arguments for ``--key`` are stored in a JSON file, ``key.json``. Here are the contents of that file:: + + { + "Artist": {"S": "Acme Band"}, + "SongTitle": {"S": "Happy Day"} + } + + +The arguments for ``--expression-attribute-names`` are stored in a JSON file, ``expression-attribute-names.json``. Here are the contents of that file:: + + { + "#Y":"Year", "#AT":"AlbumTitle" + } + +The arguments for ``--expression-attribute-values`` are stored in a JSON file, ``expression-attribute-values.json``. Here are the contents of that file:: + + { + ":y":{"N": "2015"}, + ":t":{"S": "Louder Than Ever"} + } + +Output:: + + { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "SongTitle": { + "S": "Happy Day" + }, + "Artist": { + "S": "Acme Band" + } + } + } diff --git a/aws/dist/awscli/examples/dynamodb/update-table.rst b/aws/dist/awscli/examples/dynamodb/update-table.rst new file mode 100644 index 00000000..d5520d7f --- /dev/null +++ b/aws/dist/awscli/examples/dynamodb/update-table.rst @@ -0,0 +1,45 @@ +**To modify a table's provisioned throughput** + +This example increases the provisioned read and write capacity on the *MusicCollection* table. + +Command:: + + aws dynamodb update-table --table-name MusicCollection --provisioned-throughput ReadCapacityUnits=10,WriteCapacityUnits=10 + +Output:: + + { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 0, + "WriteCapacityUnits": 1, + "LastIncreaseDateTime": 1421874759.194, + "ReadCapacityUnits": 1 + }, + "TableSizeBytes": 0, + "TableName": "MusicCollection", + "TableStatus": "UPDATING", + "KeySchema": [ + { + "KeyType": "HASH", + "AttributeName": "Artist" + }, + { + "KeyType": "RANGE", + "AttributeName": "SongTitle" + } + ], + "ItemCount": 0, + "CreationDateTime": 1421866952.062 + } + } diff --git a/aws/dist/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst b/aws/dist/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst new file mode 100644 index 00000000..02287c77 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/accept-reserved-instances-exchange-quote.rst @@ -0,0 +1,13 @@ +**To perform a Convertible Reserved Instance exchange** + +This example performs an exchange of the specified Convertible Reserved Instances. + +Command:: + + aws ec2 accept-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=b747b472-423c-48f3-8cee-679bcexample + +Output:: + + { + "ExchangeId": "riex-e68ed3c1-8bc8-4c17-af77-811afexample" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst b/aws/dist/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst new file mode 100755 index 00000000..dddfc648 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/accept-transit-gateway-vpc-attachment.rst @@ -0,0 +1,28 @@ +**To accept a request to attach a VPC to a transit gateway.** + +The following ``accept-transit-gateway-vpc-attachment`` example accepts the request forte specified attachment. :: + + accept-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "123456789012", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59EXAMPLE" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC`__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/accept-vpc-endpoint-connections.rst b/aws/dist/awscli/examples/ec2/accept-vpc-endpoint-connections.rst new file mode 100644 index 00000000..78f33d61 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/accept-vpc-endpoint-connections.rst @@ -0,0 +1,13 @@ +**To accept an interface endpoint connection request** + +This example accepts the specified endpoint connection request for the specified endpoint service. + +Command:: + + aws ec2 accept-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/accept-vpc-peering-connection.rst b/aws/dist/awscli/examples/ec2/accept-vpc-peering-connection.rst new file mode 100644 index 00000000..36b71d8f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/accept-vpc-peering-connection.rst @@ -0,0 +1,30 @@ +**To accept a VPC peering connection** + +This example accepts the specified VPC peering connection request. + +Command:: + + aws ec2 accept-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d + +Output:: + + { + "VpcPeeringConnection": { + "Status": { + "Message": "Provisioning", + "Code": "provisioning" + }, + "Tags": [], + "AccepterVpcInfo": { + "OwnerId": "444455556666", + "VpcId": "vpc-44455566", + "CidrBlock": "10.0.1.0/28" + }, + "VpcPeeringConnectionId": "pcx-1a2b3c4d", + "RequesterVpcInfo": { + "OwnerId": "444455556666", + "VpcId": "vpc-111abc45", + "CidrBlock": "10.0.0.0/28" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/advertise-byoip-cidr.rst b/aws/dist/awscli/examples/ec2/advertise-byoip-cidr.rst new file mode 100644 index 00000000..51214b8a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/advertise-byoip-cidr.rst @@ -0,0 +1,16 @@ +**To advertise an address range** + +The following ``advertise-byoip-cidr`` example advertises the specified public IPv4 address range. :: + + aws ec2 advertise-byoip-cidr \ + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "provisioned" + } + } diff --git a/aws/dist/awscli/examples/ec2/allocate-address.rst b/aws/dist/awscli/examples/ec2/allocate-address.rst new file mode 100644 index 00000000..34970f36 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/allocate-address.rst @@ -0,0 +1,29 @@ +**Example 1: To allocate an Elastic IP address for EC2-Classic** + +The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in EC2-Classic. :: + + aws ec2 allocate-address + +Output:: + + { + "PublicIp": "198.51.100.0", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + } + +**Example 2: To allocate an Elastic IP address for EC2-VPC** + +The following ``allocate-address`` example allocates an Elastic IP address to use with an instance in a VPC. :: + + aws ec2 allocate-address \ + --domain vpc + +Output:: + + { + "PublicIp": "203.0.113.0", + "PublicIpv4Pool": "amazon", + "Domain": "vpc", + "AllocationId": "eipalloc-07b6d55388acd1884" + } diff --git a/aws/dist/awscli/examples/ec2/allocate-hosts.rst b/aws/dist/awscli/examples/ec2/allocate-hosts.rst new file mode 100644 index 00000000..bc1feb51 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/allocate-hosts.rst @@ -0,0 +1,55 @@ +**Example 1: To allocate a Dedicated Host** + +The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone, onto which you can launch ``m5.large`` instances. By default, the Dedicated Host accepts only target instance launches, and does not support host recovery. :: + + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --quantity 1 + +Output:: + + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } + +**Example 2: To allocate a Dedicated Host with auto-placement and host recovery enabled** + +The following ``allocate-hosts`` example allocates a single Dedicated Host in the ``eu-west-1a`` Availability Zone with auto-placement and host recovery enabled. :: + + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --auto-placement on \ + --host-recovery on \ + --quantity 1 + +Output:: + + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } + +**Example 3: To allocate a Dedicated Host with tags** + +The following ``allocate-hosts`` example allocates a single Dedicated Host and applies a tag with a key named ``purpose`` and a value of ``production``. :: + + aws ec2 allocate-hosts \ + --instance-type m5.large \ + --availability-zone eu-west-1a \ + --quantity 1 \ + --tag-specifications 'ResourceType=dedicated-host,Tags={Key=purpose,Value=production}' + +Output:: + + { + "HostIds": [ + "h-07879acf49EXAMPLE" + ] + } + +For more information, see `Allocating Dedicated Hosts `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst b/aws/dist/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst new file mode 100644 index 00000000..192407cd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/apply-security-groups-to-client-vpn-target-network.rst @@ -0,0 +1,18 @@ +**To apply security groups to a target network for a Client VPN endpoint** + +The following ``apply-security-groups-to-client-vpn-target-network`` example applies security group ``sg-01f6e627a89f4db32`` to the association between the specified target network and Client VPN endpoint. :: + + aws ec2 apply-security-groups-to-client-vpn-target-network \ + --security-group-ids sg-01f6e627a89f4db32 \ + --vpc-id vpc-0e2110c2f324332e0 \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "SecurityGroupIds": [ + "sg-01f6e627a89f4db32" + ] + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/assign-ipv6-addresses.rst b/aws/dist/awscli/examples/ec2/assign-ipv6-addresses.rst new file mode 100644 index 00000000..3582b3fb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/assign-ipv6-addresses.rst @@ -0,0 +1,35 @@ +**To assign specific IPv6 addresses to a network interface** + +This example assigns the specified IPv6 addresses to the specified network interface. + +Command:: + + aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 2001:db8:1234:1a00:9691:9503:25ad:1761 + +Output:: + + { + "AssignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071", + "2001:db8:1234:1a00:9691:9503:25ad:1761" + ], + "NetworkInterfaceId": "eni-38664473" + } + +**To assign IPv6 addresses that Amazon selects to a network interface** + +This example assigns two IPv6 addresses to the specified network interface. Amazon automatically assigns these IPv6 addresses from the available IPv6 addresses in the IPv6 CIDR block range of the subnet. + +Command:: + + aws ec2 assign-ipv6-addresses --network-interface-id eni-38664473 --ipv6-address-count 2 + +Output:: + + { + "AssignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071", + "2001:db8:1234:1a00:9691:9503:25ad:1761" + ], + "NetworkInterfaceId": "eni-38664473" + } diff --git a/aws/dist/awscli/examples/ec2/assign-private-ip-addresses.rst b/aws/dist/awscli/examples/ec2/assign-private-ip-addresses.rst new file mode 100644 index 00000000..7ad78c46 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/assign-private-ip-addresses.rst @@ -0,0 +1,15 @@ +**To assign a specific secondary private IP address a network interface** + +This example assigns the specified secondary private IP address to the specified network interface. If the command succeeds, no output is returned. + +Command:: + + aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 + +**To assign secondary private IP addresses that Amazon EC2 selects to a network interface** + +This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with. If the command succeeds, no output is returned. + +Command:: + + aws ec2 assign-private-ip-addresses --network-interface-id eni-e5aa89a3 --secondary-private-ip-address-count 2 diff --git a/aws/dist/awscli/examples/ec2/associate-address.rst b/aws/dist/awscli/examples/ec2/associate-address.rst new file mode 100644 index 00000000..6db0020a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-address.rst @@ -0,0 +1,35 @@ +**To associate an Elastic IP addresses in EC2-Classic** + +This example associates an Elastic IP address with an instance in EC2-Classic. If the command succeeds, no output is returned. + +Command:: + + aws ec2 associate-address --instance-id i-07ffe74c7330ebf53 --public-ip 198.51.100.0 + +**To associate an Elastic IP address in EC2-VPC** + +This example associates an Elastic IP address with an instance in a VPC. + +Command:: + + aws ec2 associate-address --instance-id i-0b263919b6498b123 --allocation-id eipalloc-64d5890a + +Output:: + + { + "AssociationId": "eipassoc-2bebb745" + } + +This example associates an Elastic IP address with a network interface. + +Command:: + + aws ec2 associate-address --allocation-id eipalloc-64d5890a --network-interface-id eni-1a2b3c4d + +This example associates an Elastic IP with a private IP address that's associated with a network interface. + +Command:: + + aws ec2 associate-address --allocation-id eipalloc-64d5890a --network-interface-id eni-1a2b3c4d --private-ip-address 10.0.0.85 + + diff --git a/aws/dist/awscli/examples/ec2/associate-client-vpn-target-network.rst b/aws/dist/awscli/examples/ec2/associate-client-vpn-target-network.rst new file mode 100644 index 00000000..f460f1c7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-client-vpn-target-network.rst @@ -0,0 +1,18 @@ +**To associate a target network with a Client VPN endpoint** + +The following ``associate-client-vpn-target-network`` example associates a subnet with the specified Client VPN endpoint. :: + + aws ec2 associate-client-vpn-target-network \ + --subnet-id subnet-0123456789abcabca \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "AssociationId": "cvpn-assoc-12312312312312312", + "Status": { + "Code": "associating" + } + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/associate-dhcp-options.rst b/aws/dist/awscli/examples/ec2/associate-dhcp-options.rst new file mode 100644 index 00000000..b1a5ae52 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-dhcp-options.rst @@ -0,0 +1,15 @@ +**To associate a DHCP options set with your VPC** + +This example associates the specified DHCP options set with the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 associate-dhcp-options --dhcp-options-id dopt-d9070ebb --vpc-id vpc-a01106c2 + +**To associate the default DHCP options set with your VPC** + +This example associates the default DHCP options set with the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 associate-dhcp-options --dhcp-options-id default --vpc-id vpc-a01106c2 diff --git a/aws/dist/awscli/examples/ec2/associate-iam-instance-profile.rst b/aws/dist/awscli/examples/ec2/associate-iam-instance-profile.rst new file mode 100644 index 00000000..35c81614 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-iam-instance-profile.rst @@ -0,0 +1,21 @@ +**To associate an IAM instance profile with an instance** + +This example associates an IAM instance profile named ``admin-role`` with instance ``i-123456789abcde123``. + +Command:: + + aws ec2 associate-iam-instance-profile --instance-id i-123456789abcde123 --iam-instance-profile Name=admin-role + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "associating", + "AssociationId": "iip-assoc-0e7736511a163c209", + "IamInstanceProfile": { + "Id": "AIPAJBLK7RKJKWDXVHIEC", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } diff --git a/aws/dist/awscli/examples/ec2/associate-route-table.rst b/aws/dist/awscli/examples/ec2/associate-route-table.rst new file mode 100644 index 00000000..8ad2afcb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-route-table.rst @@ -0,0 +1,13 @@ +**To associate a route table with a subnet** + +This example associates the specified route table with the specified subnet. + +Command:: + + aws ec2 associate-route-table --route-table-id rtb-22574640 --subnet-id subnet-9d4a7b6c + +Output:: + + { + "AssociationId": "rtbassoc-781d0d1a" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/associate-subnet-cidr-block.rst b/aws/dist/awscli/examples/ec2/associate-subnet-cidr-block.rst new file mode 100644 index 00000000..5b988551 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-subnet-cidr-block.rst @@ -0,0 +1,20 @@ +**To associate an IPv6 CIDR block with a subnet** + +This example associates an IPv6 CIDR block with the specified subnet. + +Command:: + + aws ec2 associate-subnet-cidr-block --subnet-id subnet-5f46ec3b --ipv6-cidr-block 2001:db8:1234:1a00::/64 + +Output:: + + { + "SubnetId": "subnet-5f46ec3b", + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", + "AssociationId": "subnet-cidr-assoc-3aa54053", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/associate-transit-gateway-route-table.rst b/aws/dist/awscli/examples/ec2/associate-transit-gateway-route-table.rst new file mode 100755 index 00000000..4bf1f1be --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-transit-gateway-route-table.rst @@ -0,0 +1,21 @@ +**To associate a transit gateway route table with a transit gateway attachment** + +The following example associates the specified transit gateway route table with the specified VPC attachment. :: + + aws ec2 associate-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE + +Output:: + + { + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceId": "vpc-0065acced4EXAMPLE", + "ResourceType": "vpc", + "State": "associating" + } + } + +For more information, see `Associate a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/associate-vpc-cidr-block.rst b/aws/dist/awscli/examples/ec2/associate-vpc-cidr-block.rst new file mode 100644 index 00000000..d03594b6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/associate-vpc-cidr-block.rst @@ -0,0 +1,40 @@ +**To associate an IPv6 CIDR block with a VPC** + +This example associates an IPv6 CIDR block with a VPC. + +Command:: + + aws ec2 associate-vpc-cidr-block --amazon-provided-ipv6-cidr-block --vpc-id vpc-a034d6c4 + +Output:: + + { + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlockState": { + "State": "associating" + }, + "AssociationId": "vpc-cidr-assoc-eca54085" + }, + "VpcId": "vpc-a034d6c4" + } + +**To associate an additional IPv4 CIDR block with a VPC** + +This example associates the IPv4 CIDR block ``10.2.0.0/16`` with VPC ``vpc-1a2b3c4d``. + +Command:: + + aws ec2 associate-vpc-cidr-block --vpc-id vpc-1a2b3c4d --cidr-block 10.2.0.0/16 + +Output:: + + { + "CidrBlockAssociation": { + "AssociationId": "vpc-cidr-assoc-2447724d", + "CidrBlock": "10.2.0.0/16", + "CidrBlockState": { + "State": "associating" + } + }, + "VpcId": "vpc-1a2b3c4d" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/attach-classic-link-vpc.rst b/aws/dist/awscli/examples/ec2/attach-classic-link-vpc.rst new file mode 100644 index 00000000..a8efa261 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/attach-classic-link-vpc.rst @@ -0,0 +1,13 @@ +**To link (attach) an EC2-Classic instance to a VPC** + +This example links instance i-1234567890abcdef0 to VPC vpc-88888888 through the VPC security group sg-12312312. + +Command:: + + aws ec2 attach-classic-link-vpc --instance-id i-1234567890abcdef0 --vpc-id vpc-88888888 --groups sg-12312312 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/attach-internet-gateway.rst b/aws/dist/awscli/examples/ec2/attach-internet-gateway.rst new file mode 100644 index 00000000..744f1ff6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/attach-internet-gateway.rst @@ -0,0 +1,7 @@ +**To attach an Internet gateway to your VPC** + +This example attaches the specified Internet gateway to the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 attach-internet-gateway --internet-gateway-id igw-c0a643a9 --vpc-id vpc-a01106c2 \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/attach-network-interface.rst b/aws/dist/awscli/examples/ec2/attach-network-interface.rst new file mode 100644 index 00000000..21c76a1c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/attach-network-interface.rst @@ -0,0 +1,13 @@ +**To attach a network interface to an instance** + +This example attaches the specified network interface to the specified instance. + +Command:: + + aws ec2 attach-network-interface --network-interface-id eni-e5aa89a3 --instance-id i-1234567890abcdef0 --device-index 1 + +Output:: + + { + "AttachmentId": "eni-attach-66c4350a" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/attach-volume.rst b/aws/dist/awscli/examples/ec2/attach-volume.rst new file mode 100644 index 00000000..2601121c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/attach-volume.rst @@ -0,0 +1,17 @@ +**To attach a volume to an instance** + +This example command attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``. + +Command:: + + aws ec2 attach-volume --volume-id vol-1234567890abcdef0 --instance-id i-01474ef662b89480 --device /dev/sdf + +Output:: + + { + "AttachTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0", + "State": "attaching", + "Device": "/dev/sdf" + } diff --git a/aws/dist/awscli/examples/ec2/attach-vpn-gateway.rst b/aws/dist/awscli/examples/ec2/attach-vpn-gateway.rst new file mode 100644 index 00000000..382b6b3d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/attach-vpn-gateway.rst @@ -0,0 +1,16 @@ +**To attach a virtual private gateway to your VPC** + +This example attaches the specified virtual private gateway to the specified VPC. + +Command:: + + aws ec2 attach-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 --vpc-id vpc-a01106c2 + +Output:: + + { + "VpcAttachement": { + "State": "attaching", + "VpcId": "vpc-a01106c2" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/authorize-client-vpn-ingress.rst b/aws/dist/awscli/examples/ec2/authorize-client-vpn-ingress.rst new file mode 100644 index 00000000..53daf0f5 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/authorize-client-vpn-ingress.rst @@ -0,0 +1,18 @@ +**To add an authorization rule for a Client VPN endpoint** + +The following ``authorize-client-vpn-ingress`` example adds an ingress authorization rule that permits all clients to access the internet (``0.0.0.0/0``). :: + + aws ec2 authorize-client-vpn-ingress \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --target-network-cidr 0.0.0.0/0 \ + --authorize-all-groups + +Output:: + + { + "Status": { + "Code": "authorizing" + } + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/authorize-security-group-egress.rst b/aws/dist/awscli/examples/ec2/authorize-security-group-egress.rst new file mode 100644 index 00000000..654851b9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/authorize-security-group-egress.rst @@ -0,0 +1,23 @@ +**To add a rule that allows outbound traffic to a specific address range** + +This example command adds a rule that grants access to the specified address ranges on TCP port 80. + +Command (Linux):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges='[{CidrIp=10.0.0.0/16}]' + +Command (Windows):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,IpRanges=[{CidrIp=10.0.0.0/16}] + +**To add a rule that allows outbound traffic to a specific security group** + +This example command adds a rule that grants access to the specified security group on TCP port 80. + +Command (Linux):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs='[{GroupId=sg-4b51a32f}]' + +Command (Windows):: + + aws ec2 authorize-security-group-egress --group-id sg-1a2b3c4d --ip-permissions IpProtocol=tcp,FromPort=80,ToPort=80,UserIdGroupPairs=[{GroupId=sg-4b51a32f}] diff --git a/aws/dist/awscli/examples/ec2/authorize-security-group-ingress.rst b/aws/dist/awscli/examples/ec2/authorize-security-group-ingress.rst new file mode 100644 index 00000000..a7b1ee39 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/authorize-security-group-ingress.rst @@ -0,0 +1,139 @@ +**[EC2-Classic] To add a rule that allows inbound SSH traffic** + +The following example enables inbound traffic on TCP port 22 (SSH). If the command succeeds, no output is returned. :: + + aws ec2 authorize-security-group-ingress \\ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 22 \ + --cidr 203.0.113.0/24 + +This command produces no output. + +**[EC2-Classic] To add a rule that allows inbound HTTP traffic from a security group in another account** + +The following example enables inbound traffic on TCP port 80 from a source security group (``otheraccountgroup``) in a different AWS account (123456789012). Incoming traffic is allowed based on the private IP addresses of instances that are associated with the source security group (not the public IP or Elastic IP addresses). :: + + aws ec2 authorize-security-group-ingress \ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 80 \ + --source-group otheraccountgroup \ + --group-owner 123456789012 + +This command produces no output. + +**[EC2-Classic] To add a rule that allows inbound HTTPS traffic from an ELB** + +The following example enables inbound traffic on TCP port 443 from an ELB. :: + + aws ec2 authorize-security-group-ingress \ + --group-name MySecurityGroup \ + --protocol tcp \ + --port 443 \ + --source-group amazon-elb-sg \ + --group-owner amazon-elb + +**[EC2-VPC] To add a rule that allows inbound SSH traffic** + +The following example enables inbound traffic on TCP port 22 (SSH). Note that you can't reference a security group for EC2-VPC by name. :: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --protocol tcp \ + --port 22 \ + --cidr 203.0.113.0/24 + +This command produces no output. + +**[EC2-VPC] To add a rule that allows inbound HTTP traffic from another security group** + +The following example enables inbound access on TCP port 80 from the source security group ``sg-1a2b3c4d``. Note that for EC2-VPC, the source group must be in the same VPC or in a peer VPC (requires a VPC peering connection). Incoming traffic is allowed based on the private IP addresses of instances that are associated with the source security group (not the public IP or Elastic IP addresses). :: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --protocol tcp \ + --port 80 \ + --source-group sg-1a2b3c4d + +This command produces no output. + +**[EC2-VPC] To add one rule for RDP and another rule for ping/ICMP** + +The following example uses the ``ip-permissions`` parameter to add two rules, one that enables inbound access on TCP port 3389 (RDP) and the other that enables ping/ICMP. + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=172.31.0.0/16}] IpProtocol=icmp,FromPort=-1,ToPort=-1,IpRanges=[{CidrIp=172.31.0.0/16}] + +**[EC2-VPC] To add a rule for ICMP traffic** + +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4) from anywhere. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges='[{CidrIp=0.0.0.0/0}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=icmp,FromPort=3,ToPort=4,IpRanges=[{CidrIp=0.0.0.0/0}] + +This command produces no output. + +**[EC2-VPC] To add a rule for IPv6 traffic** + +The following example grants SSH access (port 22) from the IPv6 range ``2001:db8:1234:1a00::/64``. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges='[{CidrIpv6=2001:db8:1234:1a00::/64}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=22,ToPort=22,Ipv6Ranges=[{CidrIpv6=2001:db8:1234:1a00::/64}] + +**[EC2-VPC] To add a rule for ICMPv6 traffic** + +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows ICMPv6 traffic from anywhere. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=icmpv6,Ipv6Ranges='[{CidrIpv6=::/0}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=icmpv6,Ipv6Ranges=[{CidrIpv6=::/0}] + +**Add a rule with a description** + +The following example uses the ``ip-permissions`` parameter to add an inbound rule that allows RDP traffic from a specific IPv4 address range. The rule includes a description to help you identify it later. + +(Linux):: + + aws ec2 authorize-security-group-ingress \ + --group-id sg-1234567890abcdef0 \ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges='[{CidrIp=203.0.113.0/24,Description="RDP access from NY office"}]' + +(Windows):: + + aws ec2 authorize-security-group-ingress ^ + --group-id sg-1234567890abcdef0 ^ + --ip-permissions IpProtocol=tcp,FromPort=3389,ToPort=3389,IpRanges=[{CidrIp=203.0.113.0/24,Description="RDP access from NY office"}] + +For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/bundle-instance.rst b/aws/dist/awscli/examples/ec2/bundle-instance.rst new file mode 100644 index 00000000..a9cf21e8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/bundle-instance.rst @@ -0,0 +1,27 @@ +**To bundle an instance** + +This example bundles instance ``i-1234567890abcdef0`` to a bucket called ``bundletasks``. Before you specify values for your access key IDs, review and follow the guidance in `Best Practices for Managing AWS Access Keys`_. + +Command:: + + aws ec2 bundle-instance --instance-id i-1234567890abcdef0 --bucket bundletasks --prefix winami --owner-akid AK12AJEXAMPLE --owner-sak example123example + +Output:: + + { + "BundleTask": { + "UpdateTime": "2015-09-15T13:30:35.000Z", + "InstanceId": "i-1234567890abcdef0", + "Storage": { + "S3": { + "Prefix": "winami", + "Bucket": "bundletasks" + } + }, + "State": "pending", + "StartTime": "2015-09-15T13:30:35.000Z", + "BundleId": "bun-294e041f" + } + } + +.. _`Best Practices for Managing AWS Access Keys`: http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/cancel-bundle-task.rst b/aws/dist/awscli/examples/ec2/cancel-bundle-task.rst new file mode 100644 index 00000000..0d597ea9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-bundle-task.rst @@ -0,0 +1,25 @@ +**To cancel a bundle task** + +This example cancels bundle task ``bun-2a4e041c``. + +Command:: + + aws ec2 cancel-bundle-task --bundle-id bun-2a4e041c + +Output:: + + { + "BundleTask": { + "UpdateTime": "2015-09-15T13:27:40.000Z", + "InstanceId": "i-1234567890abcdef0", + "Storage": { + "S3": { + "Prefix": "winami", + "Bucket": "bundletasks" + } + }, + "State": "cancelling", + "StartTime": "2015-09-15T13:24:35.000Z", + "BundleId": "bun-2a4e041c" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/cancel-capacity-reservation.rst b/aws/dist/awscli/examples/ec2/cancel-capacity-reservation.rst new file mode 100644 index 00000000..0ba6d4bb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-capacity-reservation.rst @@ -0,0 +1,14 @@ +**To cancel a capacity reservation** + +The following ``cancel-capacity-reservation`` example cancels the specified capacity reservation. :: + + aws ec2 cancel-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE + +Output:: + + { + "Return": true + } + +For more information, see `Canceling a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/cancel-conversion-task.rst b/aws/dist/awscli/examples/ec2/cancel-conversion-task.rst new file mode 100644 index 00000000..909c5856 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-conversion-task.rst @@ -0,0 +1,7 @@ +**To cancel an active conversion of an instance or a volume** + +This example cancels the upload associated with the task ID import-i-fh95npoc. If the command succeeds, no output is returned. + +Command:: + + aws ec2 cancel-conversion-task --conversion-task-id import-i-fh95npoc diff --git a/aws/dist/awscli/examples/ec2/cancel-export-task.rst b/aws/dist/awscli/examples/ec2/cancel-export-task.rst new file mode 100644 index 00000000..6cb910f5 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-export-task.rst @@ -0,0 +1,7 @@ +**To cancel an active export task** + +This example cancels an active export task with the task ID export-i-fgelt0i7. If the command succeeds, no output is returned. + +Command:: + + aws ec2 cancel-export-task --export-task-id export-i-fgelt0i7 diff --git a/aws/dist/awscli/examples/ec2/cancel-import-task.rst b/aws/dist/awscli/examples/ec2/cancel-import-task.rst new file mode 100755 index 00000000..92e1991a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-import-task.rst @@ -0,0 +1,14 @@ +**To cancel an import task** + +The following ``cancel-import-task`` example cancels the specified import image task. :: + + aws ec2 cancel-import-task \ + --import-task-id import-ami-1234567890abcdef0 + +Output:: + + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "PreviousState": "active", + "State": "deleting" + } diff --git a/aws/dist/awscli/examples/ec2/cancel-spot-fleet-requests.rst b/aws/dist/awscli/examples/ec2/cancel-spot-fleet-requests.rst new file mode 100644 index 00000000..60625e89 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-spot-fleet-requests.rst @@ -0,0 +1,39 @@ +**To cancel Spot fleet requests** + +This example command cancels a Spot fleet request and terminates the associated Spot Instances. + +Command:: + + aws ec2 cancel-spot-fleet-requests --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE --terminate-instances + +Output:: + + { + "SuccessfulFleetRequests": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "CurrentSpotFleetRequestState": "cancelled_running", + "PreviousSpotFleetRequestState": "active" + } + ], + "UnsuccessfulFleetRequests": [] + } + +This example command cancels a Spot fleet request without terminating the associated Spot Instances. + +Command:: + + aws ec2 cancel-spot-fleet-requests --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE --no-terminate-instances + +Output:: + + { + "SuccessfulFleetRequests": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "CurrentSpotFleetRequestState": "cancelled_terminating", + "PreviousSpotFleetRequestState": "active" + } + ], + "UnsuccessfulFleetRequests": [] + } diff --git a/aws/dist/awscli/examples/ec2/cancel-spot-instance-requests.rst b/aws/dist/awscli/examples/ec2/cancel-spot-instance-requests.rst new file mode 100644 index 00000000..506bc1d7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/cancel-spot-instance-requests.rst @@ -0,0 +1,19 @@ +**To cancel Spot Instance requests** + +This example command cancels a Spot Instance request. + +Command:: + + aws ec2 cancel-spot-instance-requests --spot-instance-request-ids sir-08b93456 + +Output:: + + { + "CancelledSpotInstanceRequests": [ + { + "State": "cancelled", + "SpotInstanceRequestId": "sir-08b93456" + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/confirm-product-instance.rst b/aws/dist/awscli/examples/ec2/confirm-product-instance.rst new file mode 100644 index 00000000..d6ea5141 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/confirm-product-instance.rst @@ -0,0 +1,13 @@ +**To confirm the product instance** + +This example determines whether the specified product code is associated with the specified instance. + +Command:: + + aws ec2 confirm-product-instance --product-code 774F4FF8 --instance-id i-1234567890abcdef0 + +Output:: + + { + "OwnerId": "123456789012" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/copy-fpga-image.rst b/aws/dist/awscli/examples/ec2/copy-fpga-image.rst new file mode 100644 index 00000000..b029752c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/copy-fpga-image.rst @@ -0,0 +1,13 @@ +**To copy an Amazon FPGA image** + +This example copies the specified AFI from the ``us-east-1`` region to the current region (``eu-west-1``). + +Command:: + + aws ec2 copy-fpga-image --name copy-afi --source-fpga-image-id afi-0d123e123bfc85abc --source-region us-east-1 --region eu-west-1 + +Output:: + + { + "FpgaImageId": "afi-06b12350a123fbabc" + } diff --git a/aws/dist/awscli/examples/ec2/copy-image.rst b/aws/dist/awscli/examples/ec2/copy-image.rst new file mode 100644 index 00000000..37efb7a8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/copy-image.rst @@ -0,0 +1,13 @@ +**To copy an AMI to another region** + +This example copies the specified AMI from the ``us-east-1`` region to the ``ap-northeast-1`` region. + +Command:: + + aws ec2 copy-image --source-image-id ami-5731123e --source-region us-east-1 --region ap-northeast-1 --name "My server" + +Output:: + + { + "ImageId": "ami-438bea42" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/copy-snapshot.rst b/aws/dist/awscli/examples/ec2/copy-snapshot.rst new file mode 100644 index 00000000..6edd31c3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/copy-snapshot.rst @@ -0,0 +1,25 @@ +**Example 1: To copy a snapshot** + +The following ``copy-snapshot`` example command copies the specified snapshot from the ``us-west-2`` Region to the ``us-east-1`` Region and adds a short description. :: + + aws ec2 copy-snapshot \ + --region us-east-1 \ + --source-region us-west-2 \ + --source-snapshot-id snap-066877671789bd71b \ + --description "This is my copied snapshot." + +Output:: + + { + "SnapshotId": "snap-066877671789bd71b" + } + +**Example 2: To copy an unencrypted snapshot and encrypt the new snapshot** + +The following ``copy-snapshot`` command copies the specified unencrypted snapshot from the ``us-west-2`` Region to the current Region and encrypts the new snapshot using the specified AWS KMS customer master key (CMK). :: + + aws ec2 copy-snapshot \ + --source-region us-west-2 \ + --source-snapshot-id snap-066877671789bd71b \ + --encrypted \ + --kmd-key-id alias/my-cmk diff --git a/aws/dist/awscli/examples/ec2/create-capacity-reservation.rst b/aws/dist/awscli/examples/ec2/create-capacity-reservation.rst new file mode 100644 index 00000000..e1efa833 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-capacity-reservation.rst @@ -0,0 +1,95 @@ +**Example 1: To create a Capacity Reservation** + +The following ``create-capacity-reservation`` example creates a capacity reservation in the ``eu-west-1a`` Availability Zone, into which you can launch three ``t2.medium`` instances running a Linux/Unix operating system. By default, the capacity reservation is created with open instance matching criteria and no support for ephemeral storage, and it remains active until you manually cancel it. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type t2.medium \ + --instance-platform Linux/UNIX \ + --instance-count 3 + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:27:35.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "t2.medium" + } + } + +**Example 2: To create a Capacity Reservation that automatically ends at a specified date/time** + +The following ``create-capacity-reservation`` example creates a capacity reservation in the ``eu-west-1a`` Availability Zone, into which you can launch three ``m5.large`` instances running a Linux/Unix operating system. This capacity reservation automatically ends on 08/31/2019 at 23:59:59. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type m5.large \ + --instance-platform Linux/UNIX \ + --instance-count 3 \ + --end-date-type limited \ + --end-date 2019-08-31T23:59:59Z + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "limited", + "AvailabilityZone": "eu-west-1a", + "EndDate": "2019-08-31T23:59:59.000Z", + "InstanceMatchCriteria": "open", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T10:15:53.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "m5.large" + } + } + +**Example 3: To create a Capacity Reservation that accepts only targeted instance launches** + +The following ``create-capacity-reservation`` example creates a capacity reservation that accepts only targeted instance launches. :: + + aws ec2 create-capacity-reservation \ + --availability-zone eu-west-1a \ + --instance-type m5.large \ + --instance-platform Linux/UNIX \ + --instance-count 3 \ + --instance-match-criteria targeted + +Output:: + + { + "CapacityReservation": { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "targeted", + "EphemeralStorage": false, + "CreateDate": "2019-08-16T10:21:57.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "active", + "Tenancy": "default", + "EbsOptimized": false, + "InstanceType": "m5.large" + } + } + +For more information, see `Creating a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/create-client-vpn-endpoint.rst b/aws/dist/awscli/examples/ec2/create-client-vpn-endpoint.rst new file mode 100644 index 00000000..32aac786 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-client-vpn-endpoint.rst @@ -0,0 +1,21 @@ +**To create a Client VPN endpoint** + +The following ``create-client-vpn-endpoint`` example creates a Client VPN endpoint that uses mutual authentication and specifies a value for the client CIDR block. :: + + aws ec2 create-client-vpn-endpoint \ + --client-cidr-block "172.31.0.0/16" \ + --server-certificate-arn arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --authentication-options Type=certificate-authentication,MutualAuthentication={ClientRootCertificateChainArn=arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE} \ + --connection-log-options Enabled=false + +Output:: + + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Status": { + "Code": "pending-associate" + }, + "DnsName": "cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com" + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-client-vpn-route.rst b/aws/dist/awscli/examples/ec2/create-client-vpn-route.rst new file mode 100644 index 00000000..eab0628a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-client-vpn-route.rst @@ -0,0 +1,18 @@ +**To create a route for a Client VPN endpoint** + +The following ``create-client-vpn-route`` example adds a route to the internet (``0.0.0.0/0``) for the specified subnet of the Client VPN endpoint. :: + + aws ec2 create-client-vpn-route \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --destination-cidr-block 0.0.0.0/0 \ + --target-vpc-subnet-id subnet-0123456789abcabca + +Output:: + + { + "Status": { + "Code": "creating" + } + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-customer-gateway.rst b/aws/dist/awscli/examples/ec2/create-customer-gateway.rst new file mode 100644 index 00000000..07f68c9b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-customer-gateway.rst @@ -0,0 +1,19 @@ +**To create a customer gateway** + +This example creates a customer gateway with the specified IP address for its outside interface. + +Command:: + + aws ec2 create-customer-gateway --type ipsec.1 --public-ip 12.1.2.3 --bgp-asn 65534 + +Output:: + + { + "CustomerGateway": { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-default-subnet.rst b/aws/dist/awscli/examples/ec2/create-default-subnet.rst new file mode 100644 index 00000000..0865d822 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-default-subnet.rst @@ -0,0 +1,23 @@ +**To create a default subnet** + +This example creates a default subnet in Availability Zone ``us-east-2a``. + +Command:: + + aws ec2 create-default-subnet --availability-zone us-east-2a + + { + "Subnet": { + "AvailabilityZone": "us-east-2a", + "Tags": [], + "AvailableIpAddressCount": 4091, + "DefaultForAz": true, + "Ipv6CidrBlockAssociationSet": [], + "VpcId": "vpc-1a2b3c4d", + "State": "available", + "MapPublicIpOnLaunch": true, + "SubnetId": "subnet-1122aabb", + "CidrBlock": "172.31.32.0/20", + "AssignIpv6AddressOnCreation": false + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-default-vpc.rst b/aws/dist/awscli/examples/ec2/create-default-vpc.rst new file mode 100644 index 00000000..02d1e946 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-default-vpc.rst @@ -0,0 +1,22 @@ +**To create a default VPC** + +This example creates a default VPC. + +Command:: + + aws ec2 create-default-vpc + +Output:: + + { + "Vpc": { + "VpcId": "vpc-8eaae5ea", + "InstanceTenancy": "default", + "Tags": [], + "Ipv6CidrBlockAssociationSet": [], + "State": "pending", + "DhcpOptionsId": "dopt-af0c32c6", + "CidrBlock": "172.31.0.0/16", + "IsDefault": true + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-dhcp-options.rst b/aws/dist/awscli/examples/ec2/create-dhcp-options.rst new file mode 100644 index 00000000..5eb2dccf --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-dhcp-options.rst @@ -0,0 +1,43 @@ +**To create a set of DHCP options** + +The following ``create-dhcp-options`` example creates a set of DHCP options that specifies the domain name, the domain name servers, and the NetBIOS node type. :: + + aws ec2 create-dhcp-options \ + --dhcp-configuration "Key=domain-name-servers,Values=10.2.5.1,10.2.5.2 Key=domain-name,Values=example.com Key=netbios-node-type,Values=2" + +Output:: + + { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "example.com" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.1" + }, + { + "Value": "10.2.5.2" + } + ] + }, + { + "Key": "netbios-node-type", + "Values": [ + { + "Value": "2" + } + ] + } + ], + "DhcpOptionsId": "dopt-06d52773eff4c55f3" + } + } diff --git a/aws/dist/awscli/examples/ec2/create-egress-only-internet-gateway.rst b/aws/dist/awscli/examples/ec2/create-egress-only-internet-gateway.rst new file mode 100644 index 00000000..1964a5cd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-egress-only-internet-gateway.rst @@ -0,0 +1,21 @@ +**To create an egress-only Internet gateway** + +This example creates an egress-only Internet gateway for the specified VPC. + +Command:: + + aws ec2 create-egress-only-internet-gateway --vpc-id vpc-0c62a468 + +Output:: + + { + "EgressOnlyInternetGateway": { + "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-0c62a468" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-fleet.rst b/aws/dist/awscli/examples/ec2/create-fleet.rst new file mode 100644 index 00000000..9df1a26f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-fleet.rst @@ -0,0 +1,156 @@ +**To create an EC2 Fleet that launches Spot Instances as the default purchasing model** + +This example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model is ``spot``, which results in the fleet launching 2 Spot Instances. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "spot" + } + } + + +**To create an EC2 Fleet that launches On-Demand Instances as the default purchasing model** + +This example creates an EC2 Fleet using the minimum parameters required to launch a fleet: a launch template, target capacity, and default purchasing model. The launch template is identified by its launch template ID and version number. The target capacity for the fleet is 2 instances, and the default purchasing model is ``on-demand``, which results in the fleet launching 2 On-Demand Instances. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "on-demand" + } + } + + +**To create an EC2 Fleet that launches On-Demand Instances as the primary capacity** + +This example creates an EC2 Fleet that specifies the total target capacity of 2 instances for the fleet, and a target capacity of 1 On-Demand Instance. The default purchasing model is ``spot``. The fleet launches 1 On-Demand Instance as specified, but needs to launch one more instance to fulfil the total target capacity. The purchasing model for the difference is calculated as ``TotalTargetCapacity`` - ``OnDemandTargetCapacity`` = ``DefaultTargetCapacityType``, which results in the fleet launching 1 Spot Instance. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "OnDemandTargetCapacity":1, + "DefaultTargetCapacityType": "spot" + } + } + + +**To create an EC2 Fleet that launches Spot Instances using the lowest-price allocation strategy** + +If the allocation strategy for Spot Instances is not specified, the default allocation strategy, which is ``lowest-price``, is used. This example creates an EC2 Fleet using the ``lowest-price`` allocation strategy. The three launch specifications, which override the launch template, have different instance types but the same weighted capacity and subnet. The total target capacity is 2 instances and the default purchasing model is ``spot``. The EC2 Fleet launches 2 Spot Instances using the instance type of the launch specification with the lowest price. + +When you create an EC2 Fleet, use a JSON file to specify information about the instances to launch. + +Command:: + + aws ec2 create-fleet --cli-input-json file://file_name.json + +Output:: + + { + "FleetId": "fleet-12a34b55-67cd-8ef9-ba9b-9208dEXAMPLE" + } + +Where file_name.json contains the following:: + + { + "LaunchTemplateConfigs": [ + { + "LaunchTemplateSpecification": { + "LaunchTemplateId": "lt-0e8c754449b27161c", + "Version": "1" + } + "Overrides": [ + { + "InstanceType": "c4.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + }, + { + "InstanceType": "c3.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + }, + { + "InstanceType": "c5.large", + "WeightedCapacity": 1, + "SubnetId": "subnet-a4f6c5d3" + } + ] + + } + ], + "TargetCapacitySpecification": { + "TotalTargetCapacity": 2, + "DefaultTargetCapacityType": "spot" + } + } diff --git a/aws/dist/awscli/examples/ec2/create-flow-logs.rst b/aws/dist/awscli/examples/ec2/create-flow-logs.rst new file mode 100644 index 00000000..c635066d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-flow-logs.rst @@ -0,0 +1,34 @@ +**Example 1: To create a flow log** + +The following ``create-flow-logs`` example creates a flow log that captures all rejected traffic for the specified network interface. The flow logs are delivered to a log group in CloudWatch Logs using the permissions in the specified IAM role. :: + + aws ec2 create-flow-logs \ + --resource-type NetworkInterface \ + --resource-ids eni-11223344556677889 \ + --traffic-type REJECT \ + --log-group-name my-flow-logs \ + --deliver-logs-permission-arn arn:aws:iam::123456789101:role/publishFlowLogs + +Output:: + + { + "ClientToken": "so0eNA2uSHUNlHI0S2cJ305GuIX1CezaRdGtexample", + "FlowLogIds": [ + "fl-12345678901234567" + ], + "Unsuccessful": [] + } + +**Example 2: To create a flow log with a custom format** + +The following ``create-flow-logs`` example creates a flow log that captures all traffic for the specified VPC and delivers the flow logs to an Amazon S3 bucket. The ``--log-format`` parameter specifies a custom format for the flow log records. :: + + aws ec2 create-flow-logs \ + --resource-type VPC \ + --resource-ids vpc-00112233344556677 \ + --traffic-type ALL \ + --log-destination-type s3 \ + --log-destination arn:aws:s3:::flow-log-bucket/my-custom-flow-logs/ \ + --log-format '${version} ${vpc-id} ${subnet-id} ${instance-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${tcp-flags} ${type} ${pkt-srcaddr} ${pkt-dstaddr}' + +For more information, see `VPC Flow Logs `__ in the *Amazon VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-fpga-image.rst b/aws/dist/awscli/examples/ec2/create-fpga-image.rst new file mode 100644 index 00000000..826b05b6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-fpga-image.rst @@ -0,0 +1,14 @@ +**To create an Amazon FPGA image** + +This example creates an AFI from the specified tarball in the specified bucket. + +Command:: + + aws ec2 create-fpga-image --name my-afi --description test-afi --input-storage-location Bucket=my-fpga-bucket,Key=dcp/17_12_22-103226.Developer_CL.tar --logs-storage-location Bucket=my-fpga-bucket,Key=logs + +Output:: + + { + "FpgaImageId": "afi-0d123e123bfc85abc", + "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc" + } diff --git a/aws/dist/awscli/examples/ec2/create-image.rst b/aws/dist/awscli/examples/ec2/create-image.rst new file mode 100644 index 00000000..46649b60 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-image.rst @@ -0,0 +1,39 @@ +**To create an AMI from an Amazon EBS-backed instance** + +This example creates an AMI from the specified instance. + +Command:: + + aws ec2 create-image --instance-id i-1234567890abcdef0 --name "My server" --description "An AMI for my server" + +Output:: + + { + "ImageId": "ami-5731123e" + } + +This example creates an AMI and sets the --no-reboot parameter, so that the instance is not rebooted before the image is created. + +Command:: + + aws ec2 create-image --instance-id i-0b09a25c58929de26 --name "My server" --no-reboot + +Output:: + + { + "ImageId": "ami-1a2b3c4d" + } + +**To create an AMI using a block device mapping** + +Add the following parameter to your ``create-image`` command to add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdh\",\"Ebs\":{\"VolumeSize\":100}}]" + +Add the following parameter to your ``create-image`` command to add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdc\",\"VirtualName\":\"ephemeral1\"}]" + +Add the following parameter to your ``create-image`` command to omit a device included on the instance (for example, ``/dev/sdf``):: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdf\",\"NoDevice\":\"\"}]" diff --git a/aws/dist/awscli/examples/ec2/create-instance-export-task.rst b/aws/dist/awscli/examples/ec2/create-instance-export-task.rst new file mode 100644 index 00000000..13d442f7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-instance-export-task.rst @@ -0,0 +1,28 @@ +**To export an instance** + +This example command creates a task to export the instance i-1234567890abcdef0 to the Amazon S3 bucket +myexportbucket. + +Command:: + + aws ec2 create-instance-export-task --description "RHEL5 instance" --instance-id i-1234567890abcdef0 --target-environment vmware --export-to-s3-task DiskImageFormat=vmdk,ContainerFormat=ova,S3Bucket=myexportbucket,S3Prefix=RHEL5 + +Output:: + + { + "ExportTask": { + "State": "active", + "InstanceExportDetails": { + "InstanceId": "i-1234567890abcdef0", + "TargetEnvironment": "vmware" + }, + "ExportToS3Task": { + "S3Bucket": "myexportbucket", + "S3Key": "RHEL5export-i-fh8sjjsq.ova", + "DiskImageFormat": "vmdk", + "ContainerFormat": "ova" + }, + "Description": "RHEL5 instance", + "ExportTaskId": "export-i-fh8sjjsq" + } + } diff --git a/aws/dist/awscli/examples/ec2/create-internet-gateway.rst b/aws/dist/awscli/examples/ec2/create-internet-gateway.rst new file mode 100644 index 00000000..9855aad7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-internet-gateway.rst @@ -0,0 +1,17 @@ +**To create an Internet gateway** + +This example creates an Internet gateway. + +Command:: + + aws ec2 create-internet-gateway + +Output:: + + { + "InternetGateway": { + "Tags": [], + "InternetGatewayId": "igw-c0a643a9", + "Attachments": [] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-key-pair.rst b/aws/dist/awscli/examples/ec2/create-key-pair.rst new file mode 100644 index 00000000..1535321f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-key-pair.rst @@ -0,0 +1,14 @@ +**To create a key pair** + +This example creates a key pair named ``MyKeyPair``. + +Command:: + + aws ec2 create-key-pair --key-name MyKeyPair + +The output is an ASCII version of the private key and key fingerprint. You need to save the key to a file. + +For more information, see `Using Key Pairs`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Key Pairs`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html + diff --git a/aws/dist/awscli/examples/ec2/create-launch-template-version.rst b/aws/dist/awscli/examples/ec2/create-launch-template-version.rst new file mode 100644 index 00000000..e6562412 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-launch-template-version.rst @@ -0,0 +1,37 @@ +**To create a launch template version** + +This example creates a new launch template version based on version 1 of the launch template and specifies a different AMI ID. + +Command:: + + aws ec2 create-launch-template-version --launch-template-id lt-0abcd290751193123 --version-description WebVersion2 --source-version 1 --launch-template-data '{"ImageId":"ami-c998b6b2"}' + +Output:: + + { + "LaunchTemplateVersion": { + "VersionDescription": "WebVersion2", + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "LaunchTemplateData": { + "ImageId": "ami-c998b6b2", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "DeviceIndex": 0, + "SubnetId": "subnet-7b16de0c", + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-launch-template.rst b/aws/dist/awscli/examples/ec2/create-launch-template.rst new file mode 100644 index 00000000..6c7d8d03 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-launch-template.rst @@ -0,0 +1,49 @@ +**To create a launch template** + +This example creates a launch template that specifies the subnet in which to launch the instance (``subnet-7b16de0c``), assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance (``purpose=webserver``). :: + + aws ec2 create-launch-template --launch-template-name TemplateForWebServer --version-description WebVersion1 --launch-template-data '{"NetworkInterfaces":[{"AssociatePublicIpAddress":true,"DeviceIndex":0,"Ipv6AddressCount":1,"SubnetId":"subnet-7b16de0c"}],"ImageId":"ami-8c1be5f6","InstanceType":"t2.small","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"purpose","Value":"webserver"}]}]}' + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-01238c059e3466abc", + "LaunchTemplateName": "TemplateForWebServer", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:user/Bob", + "CreateTime": "2019-01-27T09:13:24.000Z" + } + } + +For more information, see `Launching an Instance from a Launch Template`_ in the *Amazon Elastic Compute Cloud User Guide*. + +**To create a launch template for Amazon EC2 Auto Scaling** + +This example creates a launch template named TemplateForAutoScaling with multiple tags and a block device mapping to specify an additional EBS volume when an instance launches. Specify a value for ``Groups`` that corresponds to security groups for the VPC that your Auto Scaling group will launch instances into. Specify the VPC and subnets as properties of the Auto Scaling group. :: + + aws ec2 create-launch-template --launch-template-name TemplateForAutoScaling --version-description AutoScalingVersion1 --launch-template-data '{"NetworkInterfaces":[{"DeviceIndex":0,"AssociatePublicIpAddress":true,"Groups":["sg-7c227019,sg-903004f8"],"DeleteOnTermination":true}],"ImageId":"ami-b42209de","InstanceType":"m4.large","TagSpecifications":[{"ResourceType":"instance","Tags":[{"Key":"environment","Value":"production"},{"Key":"purpose","Value":"webserver"}]},{"ResourceType":"volume","Tags":[{"Key":"environment","Value":"production"},{"Key":"cost-center","Value":"cc123"}]}],"BlockDeviceMappings":[{"DeviceName":"/dev/sda1","Ebs":{"VolumeSize":100}}]}' --region us-east-1 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-0123c79c33a54e0abc", + "LaunchTemplateName": "TemplateForAutoScaling", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:user/Bob", + "CreateTime": "2019-04-30T18:16:06.000Z" + } + } + +For more information, see `Creating a Launch Template for an Auto Scaling Group`_ in the *Amazon EC2 Auto Scaling User Guide*. + +For information about quoting JSON-formatted parameters, see `Quoting Strings`_ in the *AWS Command Line Interface User Guide*. + +.. _`Launching an Instance from a Launch Template`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html + +.. _`Creating a Launch Template for an Auto Scaling Group`: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html + +.. _`Quoting Strings`: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html#quoting-strings diff --git a/aws/dist/awscli/examples/ec2/create-nat-gateway.rst b/aws/dist/awscli/examples/ec2/create-nat-gateway.rst new file mode 100644 index 00000000..fe030b3b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-nat-gateway.rst @@ -0,0 +1,24 @@ +**To create a NAT gateway** + +This example creates a NAT gateway in subnet ``subnet-1a2b3c4d`` and associates an Elastic IP address with the allocation ID ``eipalloc-37fc1a52`` with the NAT gateway. + +Command:: + + aws ec2 create-nat-gateway --subnet-id subnet-1a2b3c4d --allocation-id eipalloc-37fc1a52 + +Output:: + + { + "NatGateway": { + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "VpcId": "vpc-1122aabb", + "State": "pending", + "NatGatewayId": "nat-08d48af2a8e83edfd", + "SubnetId": "subnet-1a2b3c4d", + "CreateTime": "2015-12-17T12:45:26.732Z" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-network-acl-entry.rst b/aws/dist/awscli/examples/ec2/create-network-acl-entry.rst new file mode 100644 index 00000000..0e3a1cae --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-network-acl-entry.rst @@ -0,0 +1,14 @@ +**To create a network ACL entry** + +This example creates an entry for the specified network ACL. The rule allows ingress traffic from any IPv4 address (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet. If the command succeeds, no output is returned. + +Command:: + + aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 --protocol udp --port-range From=53,To=53 --cidr-block 0.0.0.0/0 --rule-action allow + + +This example creates a rule for the specified network ACL that allows ingress traffic from any IPv6 address (::/0) on TCP port 80 (HTTP). + +Command:: + + aws ec2 create-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 120 --protocol tcp --port-range From=80,To=80 --ipv6-cidr-block ::/0 --rule-action allow \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-network-acl.rst b/aws/dist/awscli/examples/ec2/create-network-acl.rst new file mode 100644 index 00000000..a95e1698 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-network-acl.rst @@ -0,0 +1,35 @@ +**To create a network ACL** + +This example creates a network ACL for the specified VPC. + +Command:: + + aws ec2 create-network-acl --vpc-id vpc-a01106c2 + +Output:: + + { + "NetworkAcl": { + "Associations": [], + "NetworkAclId": "acl-5fb85d36", + "VpcId": "vpc-a01106c2", + "Tags": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": true, + "RuleAction": "deny" + }, + { + "CidrBlock": "0.0.0.0/0", + "RuleNumber": 32767, + "Protocol": "-1", + "Egress": false, + "RuleAction": "deny" + } + ], + "IsDefault": false + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-network-interface-permission.rst b/aws/dist/awscli/examples/ec2/create-network-interface-permission.rst new file mode 100644 index 00000000..4847cb88 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-network-interface-permission.rst @@ -0,0 +1,21 @@ +**To create a network interface permission** + +This example grants permission to account ``123456789012`` to attach network interface ``eni-1a2b3c4d`` to an instance. + +Command:: + + aws ec2 create-network-interface-permission --network-interface-id eni-1a2b3c4d --aws-account-id 123456789012 --permission INSTANCE-ATTACH + +Output:: + + { + "InterfacePermission": { + "PermissionState": { + "State": "GRANTED" + }, + "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", + "NetworkInterfaceId": "eni-1a2b3c4d", + "Permission": "INSTANCE-ATTACH", + "AwsAccountId": "123456789012" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-network-interface.rst b/aws/dist/awscli/examples/ec2/create-network-interface.rst new file mode 100644 index 00000000..5c898f4e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-network-interface.rst @@ -0,0 +1,39 @@ +**To create a network interface** + +This example creates a network interface for the specified subnet. + +Command:: + + aws ec2 create-network-interface --subnet-id subnet-9d4a7b6c --description "my network interface" --groups sg-903004f8 --private-ip-address 10.0.2.17 + +Output:: + + { + "NetworkInterface": { + "Status": "pending", + "MacAddress": "02:1a:80:41:52:9c", + "SourceDestCheck": true, + "VpcId": "vpc-a01106c2", + "Description": "my network interface", + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.2.17" + } + ], + "RequesterManaged": false, + "AvailabilityZone": "us-east-1d", + "Ipv6Addresses": [], + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-903004f8" + } + ], + "SubnetId": "subnet-9d4a7b6c", + "OwnerId": "123456789012", + "TagSet": [], + "PrivateIpAddress": "10.0.2.17" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-placement-group.rst b/aws/dist/awscli/examples/ec2/create-placement-group.rst new file mode 100644 index 00000000..db163254 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-placement-group.rst @@ -0,0 +1,15 @@ +**To create a placement group** + +This example command creates a placement group with the specified name. + +Command:: + + aws ec2 create-placement-group --group-name my-cluster --strategy cluster + +**To create a partition placement group** + +This example command creates a partition placement group named ``HDFS-Group-A`` with five partitions. + +Command:: + + aws ec2 create-placement-group --group-name HDFS-Group-A --strategy partition --partition-count 5 diff --git a/aws/dist/awscli/examples/ec2/create-route-table.rst b/aws/dist/awscli/examples/ec2/create-route-table.rst new file mode 100644 index 00000000..c4ff5bbd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-route-table.rst @@ -0,0 +1,26 @@ +**To create a route table** + +This example creates a route table for the specified VPC. + +Command:: + + aws ec2 create-route-table --vpc-id vpc-a01106c2 + +Output:: + + { + "RouteTable": { + "Associations": [], + "RouteTableId": "rtb-22574640", + "VpcId": "vpc-a01106c2", + "PropagatingVgws": [], + "Tags": [], + "Routes": [ + { + "GatewayId": "local", + "DestinationCidrBlock": "10.0.0.0/16", + "State": "active" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-route.rst b/aws/dist/awscli/examples/ec2/create-route.rst new file mode 100644 index 00000000..735f4ef6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-route.rst @@ -0,0 +1,21 @@ +**To create a route** + +This example creates a route for the specified route table. The route matches all IPv4 traffic (``0.0.0.0/0``) and routes it to the specified Internet gateway. If the command succeeds, no output is returned. + +Command:: + + aws ec2 create-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 --gateway-id igw-c0a643a9 + +This example command creates a route in route table rtb-g8ff4ea2. The route matches traffic for the IPv4 CIDR block +10.0.0.0/16 and routes it to VPC peering connection, pcx-111aaa22. This route enables traffic to be directed to the peer +VPC in the VPC peering connection. If the command succeeds, no output is returned. + +Command:: + + aws ec2 create-route --route-table-id rtb-g8ff4ea2 --destination-cidr-block 10.0.0.0/16 --vpc-peering-connection-id pcx-1a2b3c4d + +This example creates a route in the specified route table that matches all IPv6 traffic (``::/0``) and routes it to the specified egress-only Internet gateway. + +Command:: + + aws ec2 create-route --route-table-id rtb-dce620b8 --destination-ipv6-cidr-block ::/0 --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f diff --git a/aws/dist/awscli/examples/ec2/create-security-group.rst b/aws/dist/awscli/examples/ec2/create-security-group.rst new file mode 100644 index 00000000..dbd78e0e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-security-group.rst @@ -0,0 +1,31 @@ +**To create a security group for EC2-Classic** + +This example creates a security group named ``MySecurityGroup``. + +Command:: + + aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" + +Output:: + + { + "GroupId": "sg-903004f8" + } + +**To create a security group for EC2-VPC** + +This example creates a security group named ``MySecurityGroup`` for the specified VPC. + +Command:: + + aws ec2 create-security-group --group-name MySecurityGroup --description "My security group" --vpc-id vpc-1a2b3c4d + +Output:: + + { + "GroupId": "sg-903004f8" + } + +For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html diff --git a/aws/dist/awscli/examples/ec2/create-snapshot.rst b/aws/dist/awscli/examples/ec2/create-snapshot.rst new file mode 100644 index 00000000..cc7f930a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-snapshot.rst @@ -0,0 +1,54 @@ +**To create a snapshot** + +This example command creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot. + +Command:: + + aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description "This is my root volume snapshot" + +Output:: + + { + "Description": "This is my root volume snapshot", + "Tags": [], + "Encrypted": false, + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2018-02-28T21:06:01.000Z", + "Progress": "", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b" + } + +**To create a snapshot with tags** + +This example command creates a snapshot and applies two tags: purpose=prod and costcenter=123. + +Command:: + + aws ec2 create-snapshot --volume-id vol-1234567890abcdef0 --description 'Prod backup' --tag-specifications 'ResourceType=snapshot,Tags=[{Key=purpose,Value=prod},{Key=costcenter,Value=123}]' + +Output:: + + { + "Description": "Prod backup", + "Tags": [ + { + "Value": "prod", + "Key": "purpose" + }, + { + "Value": "123", + "Key": "costcenter" + } + ], + "Encrypted": false, + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2018-02-28T21:06:06.000Z", + "Progress": "", + "OwnerId": "012345678910", + "SnapshotId": "snap-09ed24a70bc19bbe4" + } diff --git a/aws/dist/awscli/examples/ec2/create-snapshots.rst b/aws/dist/awscli/examples/ec2/create-snapshots.rst new file mode 100644 index 00000000..7b33a7c0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-snapshots.rst @@ -0,0 +1,88 @@ +**Example 1: To create a multi-volume snapshot** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 \ + --description "This is snapshot of a volume from my-instance" + +Output:: + + { + "Snapshots": [ + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [], + "Encrypted": false, + "VolumeId": "vol-0a01d2d5a34697479", + "State": "pending", + "VolumeSize": 16, + "StartTime": "2019-08-05T16:58:19.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-07f30e3909aa0045e" + }, + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [], + "Encrypted": false, + "VolumeId": "vol-02d0d4947008cb1a2", + "State": "pending", + "VolumeSize": 20, + "StartTime": "2019-08-05T16:58:19.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-0ec20b602264aad48" + }, + ... + ] + } + +**Example 2: To create a multi-volume snapshot with tags from the source volume** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance and copies the tags from each volume to its corresponding snapshot. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 \ + --copy-tags-from-source volume \ + --description "This is snapshot of a volume from my-instance" + +Output:: + + { + "Snapshots": [ + { + "Description": "This is a snapshot of a volume from my-instance", + "Tags": [ + { + "Key": "Name", + "Value": "my-volume" + } + ], + "Encrypted": false, + "VolumeId": "vol-02d0d4947008cb1a2", + "State": "pending", + "VolumeSize": 20, + "StartTime": "2019-08-05T16:53:04.000Z", + "Progress": "", + "OwnerId": "123456789012", + "SnapshotId": "snap-053bfaeb821a458dd" + } + ... + ] + } + +**Example 3: To create a multi-volume snapshot not including the root volume** + +The following ``create-snapshots`` example creates a snapshot of all volumes attached to the specified instance except for the root volume. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0,ExcludeBootVolume=true + +**Example 4: To create a multi-volume snapshot and add tags** + +The following ``create-snapshots`` example creates snapshots of all volumes attached to the specified instance and adds two tags to each snapshot. :: + + aws ec2 create-snapshots \ + --instance-specification InstanceId=i-1234567890abcdef0 + --tag-specifications ResourceType=snapshot,Tags=[{Key=Name,Value=backup},{Key=costcenter,Value=123}] diff --git a/aws/dist/awscli/examples/ec2/create-spot-datafeed-subscription.rst b/aws/dist/awscli/examples/ec2/create-spot-datafeed-subscription.rst new file mode 100644 index 00000000..6680ea4f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-spot-datafeed-subscription.rst @@ -0,0 +1,19 @@ +**To create a Spot Instance datafeed** + +This example command creates a Spot Instance data feed for the account. + +Command:: + + aws ec2 create-spot-datafeed-subscription --bucket --prefix spotdata + +Output:: + + { + "SpotDatafeedSubscription": { + "OwnerId": "", + "Prefix": "spotdata", + "Bucket": "", + "State": "Active" + } + } + diff --git a/aws/dist/awscli/examples/ec2/create-subnet.rst b/aws/dist/awscli/examples/ec2/create-subnet.rst new file mode 100644 index 00000000..a6d325bd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-subnet.rst @@ -0,0 +1,68 @@ +**Example 1: To create a subnet with an IPv4 CIDR block** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 CIDR block. We recommend that you let us select an Availability Zone for you. Alternatively, you can use the ``--availability-zone`` option to specify the Availability Zone. :: + + aws ec2 create-subnet \ + --vpc-id vpc-081ec835f3EXAMPLE \ + --cidr-block 10.0.1.0/24 + +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-east-2c", + "AvailabilityZoneId": "use2-az3", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "pending", + "SubnetId": "subnet-0e3f5cac72EXAMPLE", + "VpcId": "vpc-081ec835f3EXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0e3f5cac72375030d" + } + } + +For more information, see `Creating a Subnet in Your VPC `__ in the *AWS VPC User Guide* + +**Example 2: To create a subnet with an IPv6 CIDR block** + +The following ``create-subnet`` example creates a subnet in the specified VPC with the specified IPv4 and IPv6 CIDR blocks (from the ranges of the VPC). :: + + aws ec2 create-subnet \ + --vpc-id vpc-07e8ffd50fEXAMPLE \ + --cidr-block 10.0.0.0/24 \ + --ipv6-cidr-block 2600:1f16:115:200::/64 + +Output:: + + { + "Subnet": { + "AvailabilityZone": "us-east-2b", + "AvailabilityZoneId": "use2-az2", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.0.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "pending", + "SubnetId": "subnet-02bf4c428bEXAMPLE", + "VpcId": "vpc-07e8ffd50EXAMPLE", + "OwnerId": "1111222233333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "subnet-cidr-assoc-002afb9f3cEXAMPLE", + "Ipv6CidrBlock": "2600:1f16:115:200::/64", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + ], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-02bf4c428bEXAMPLE" + } + } + +For more information, see `Creating a Subnet in Your VPC `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-tags.rst b/aws/dist/awscli/examples/ec2/create-tags.rst new file mode 100755 index 00000000..1b2159a8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-tags.rst @@ -0,0 +1,36 @@ +**To add a tag to a resource** + +The following ``create-tags`` example adds the tag ``Stack=production`` to the specified image, or overwrites an existing tag for the AMI where the tag key is ``Stack``. :: + + aws ec2 create-tags \ + --resources ami-1234567890abcdef0 --tags Key=Stack,Value=production + +**To add tags to multiple resources** + +The following ``create-tags`` example adds (or overwrites) two tags for an AMI and an instance. One of the tags has a key (``webserver``) but no value (value is set to an empty string). The other tag has a key (``stack``) and a value (``Production``). :: + + aws ec2 create-tags \ + --resources ami-1a2b3c4d i-1234567890abcdef0 \ + --tags Key=webserver,Value= Key=stack,Value=Production + +**To add tags containing special characters** + +The following ``create-tags`` example adds the tag ``[Group]=test`` for an instance. The square brackets ([ and ]) are special characters, and must be escaped. The following examples also use the line continuation character appropriate for each environment. + +If you are using Windows, surround the element that has special characters with double quotes ("), and then precede each double quote character with a backslash (\\) as follows:: + + aws ec2 create-tags ^ + --resources i-1234567890abcdef0 ^ + --tags Key=\"[Group]\",Value=test + +If you are using Windows PowerShell, element the value that has special characters with double quotes ("), precede each double quote character with a backslash (\\), and then surround the entire key and value structure with single quotes (') as follows:: + + aws ec2 create-tags ` + --resources i-1234567890abcdef0 ` + --tags 'Key=\"[Group]\",Value=test' + +If you are using Linux or OS X, surround the element that has special characters with double quotes ("), and then surround the entire key and value structure with single quotes (') as follows:: + + aws ec2 create-tags \ + --resources i-1234567890abcdef0 \ + --tags 'Key="[Group]",Value=test' diff --git a/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst b/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst new file mode 100644 index 00000000..28d34a49 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter-rule.rst @@ -0,0 +1,32 @@ +**To create a filter rule for incoming TCP traffic** + +The following ``create-traffic-mirror-filter-rule`` example creates a rule that you can use to mirror all incoming TCP traffic. Before you run this command, use ``create-traffic-mirror-filter`` to create the the Traffic Mirror filter. :: + + aws ec2 create-traffic-mirror-filter-rule \ + --description "TCP Rule" \ + --destination-cidr-block 0.0.0.0/0 \ + --protocol 6 \ + --rule-action accept \ + --rule-number 1 \ + --source-cidr-block 0.0.0.0/0 \ + --traffic-direction ingress \ + --traffic-mirror-filter-id tmf-04812ff784b25ae67 + +Output:: + + { + "TrafficMirrorFilterRule": { + "DestinationCidrBlock": "0.0.0.0/0", + "TrafficMirrorFilterId": "tmf-04812ff784b25ae67", + "TrafficMirrorFilterRuleId": "tmfr-02d20d996673f3732", + "SourceCidrBlock": "0.0.0.0/0", + "TrafficDirection": "ingress", + "Description": "TCP Rule", + "RuleNumber": 1, + "RuleAction": "accept", + "Protocol": 6 + }, + "ClientToken": "4752b573-40a6-4eac-a8a4-a72058761219" + } + +For more information, see `Create a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter.rst b/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter.rst new file mode 100644 index 00000000..c2cfbae5 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-traffic-mirror-filter.rst @@ -0,0 +1,12 @@ +**To create a Traffic Mirror Filter** + +The following ``create-traffic-mirror-filter`` example creates a Traffic Mirror filter. After you create the filter, use ``create-traffic-mirror-filter-rule`` to add rules to the filter. :: + + aws ec2 create-traffic-mirror-filter \ + --description "TCP Filter" + +Output:: + + { "ClientToken": "28908518-100b-4987-8233-8c744EXAMPLE", "TrafficMirrorFilter": { "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", "Description": "TCP Filter", "EgressFilterRules": [], "IngressFilterRules": [], "Tags": [], "NetworkServices": [] } } + +For more information, see `Create a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-traffic-mirror-session.rst b/aws/dist/awscli/examples/ec2/create-traffic-mirror-session.rst new file mode 100644 index 00000000..35e5ea5e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-traffic-mirror-session.rst @@ -0,0 +1,31 @@ +**To create a Traffic Mirror Session** + +The following ``create-traffic-mirror-session`` command creates a traffic mirror sessions for the specified source and target for 25 bytes of the packet. :: + + aws ec2 create-traffic-mirror-session \ + --description "example session" \ + --traffic-mirror-target-id tmt-07f75d8feeEXAMPLE \ + --network-interface-id eni-070203f901EXAMPLE \ + --session-number 1 \ + --packet-length 25 \ + --traffic-mirror-filter-id tmf-04812ff784EXAMPLE + +Output:: + + { + "TrafficMirrorSession": { + "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", + "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "NetworkInterfaceId": "eni-070203f901EXAMPLE", + "OwnerId": "111122223333", + "PacketLength": 25, + "SessionNumber": 1, + "VirtualNetworkId": 7159709, + "Description": "example session", + "Tags": [] + }, + "ClientToken": "5236cffc-ee13-4a32-bb5b-388d9da09d96" + } + +For more information, see `Create a Traffic Mirror Session `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-traffic-mirror-target.rst b/aws/dist/awscli/examples/ec2/create-traffic-mirror-target.rst new file mode 100644 index 00000000..0b178302 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-traffic-mirror-target.rst @@ -0,0 +1,35 @@ +**To create a a Network Load Balancer Traffic Mirror target** + +The following ``create-traffic-mirror-target`` example creates a Network Load Balancer Traffic Mirror target. :: + + aws ec2 create-traffic-mirror-target \ + --description "Example Network Load Balancer Target" \ + --network-load-balancer-arn arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873EXAMPLE + +Output:: + + { "TrafficMirrorTarget": { "Type": "network-load-balancer", "Tags": [], "Description": "Example Network Load Balancer Target", "OwnerId": "111122223333", "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:724145273726:loadbalancer/net/NLB/7cdec873EXAMPLE", "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE" }, "ClientToken": "d5c090f5-8a0f-49c7-8281-72c796a21f72" } + +**To create a network Traffic Mirror target** + +The following ``create-traffic-mirror-target`` example creates a network interface Traffic Mirror target. + + aws ec2 create-traffic-mirror-target \ + --description "Network interface target" \ + --network-interface-id eni-eni-01f6f631eEXAMPLE + +Output:: + + { + "ClientToken": "5289a345-0358-4e62-93d5-47ef3061d65e", + "TrafficMirrorTarget": { + "Description": "Network interface target", + "NetworkInterfaceId": "eni-01f6f631eEXAMPLE", + "TrafficMirrorTargetId": "tmt-02dcdbe2abEXAMPLE", + "OwnerId": "111122223333", + "Type": "network-interface", + "Tags": [] + } + } + +For more information, see `Create a Traffic Mirror Target `__ in the *AWS Traffic Mirroring Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-transit-gateway-route-table.rst b/aws/dist/awscli/examples/ec2/create-transit-gateway-route-table.rst new file mode 100644 index 00000000..7a8f4cf6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-transit-gateway-route-table.rst @@ -0,0 +1,21 @@ +**To create a Transit Gateway Route Table** + +The following ``create-transit-gateway-route-table`` example creates a route table for the specified transit gateway. :: + + aws ec2 create-transit-gateway-route-table \ + --transit-gateway-id tgw-0262a0e521EXAMPLE + +Output:: + + { + "TransitGatewayRouteTable": { + "TransitGatewayRouteTableId": "tgw-rtb-0960981be7EXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "State": "pending", + "DefaultAssociationRouteTable": false, + "DefaultPropagationRouteTable": false, + "CreationTime": "2019-07-10T19:01:46.000Z" + } + } + +For more information, see `Create a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-transit-gateway-route.rst b/aws/dist/awscli/examples/ec2/create-transit-gateway-route.rst new file mode 100755 index 00000000..a7c519e7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-transit-gateway-route.rst @@ -0,0 +1,27 @@ +**To create a Transit Gateway Route** + +The following ``create-transit-gateway-route`` example creates a route for the specified route table. :: + + aws ec2 create-transit-gateway-route \ + --destination-cidr-block 10.0.2.0/24 \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ + --transit-gateway-attachment-id tgw-attach-0b5968d3b6EXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-0065acced4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + } + +For more information, see `Create a Transit Gateway Route `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst b/aws/dist/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst new file mode 100644 index 00000000..0448af8b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-transit-gateway-vpc-attachment.rst @@ -0,0 +1,30 @@ +**To associate a Transit Gateway with a VPC** + +The following ``create-transit-gateway-vpc-attachment`` example creates a transit gateway attachment to the specified VPC. :: + + aws ec2 create-transit-gateway-vpc-attachment \ + --transit-gateway-id tgw-0262a0e521EXAMPLE \ + --vpc-id vpc-07e8ffd50f49335df \ + --subnet-id subnet-0752213d59efde95a + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fea0ff4a", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "111122223333", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59efde95a" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Create a Transit Gateway Attachment to a VPC `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-transit-gateway.rst b/aws/dist/awscli/examples/ec2/create-transit-gateway.rst new file mode 100644 index 00000000..b9f2583c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-transit-gateway.rst @@ -0,0 +1,31 @@ +**To create a transit gateway** + +The following ``create-transit-gateway`` This example creates a transit gateway. :: + + aws ec2 create-transit-gateway --description MyTGW \ + --options=AmazonSideAsn=64516,AutoAcceptSharedAttachments=enable,DefaultRouteTableAssociation=enable,DefaultRouteTablePropagation=enable,VpnEcmpSupport=enable,DnsSupport=enable + +Output:: + + { + "TransitGateway": { + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", + "State": "pending", + "OwnerId": "111122223333", + "Description": "MyTGW", + "CreationTime": "2019-07-10T14:02:12.000Z", + "Options": { + "AmazonSideAsn": 64516, + "AutoAcceptSharedAttachments": "enable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + } + } + } + +For more information, see `Create a Transit Gateway `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-volume.rst b/aws/dist/awscli/examples/ec2/create-volume.rst new file mode 100644 index 00000000..b1a0a614 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-volume.rst @@ -0,0 +1,103 @@ +**To create an empty General Purpose SSD (gp2) volume** + +The following ``create-volume`` example creates an 80 GiB General Purpose SSD (gp2) volume in the specified Availability Zone. Note that the current Region must be ``us-east-1``, or you can add the ``--region`` parameter to specify the Region for the command. :: + + aws ec2 create-volume \ + --volume-type gp2 \ + --size 80 \ + --availability-zone us-east-1a + +Output:: + + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 80 + } + +If you do not specify a volume type, the default volume type is ``gp2``. :: + + aws ec2 create-volume \ + --size 80 \ + --availability-zone us-east-1a + +**Example 2: To create a Provisioned IOPS SSD (io1) volume from a snapshot** + +The following ``create-volume`` example creates a Provisioned IOPS SSD (io1) volume with 1000 provisioned IOPS in the specified Availability Zone using the specified snapshot. :: + + aws ec2 create-volume \ + --volume-type io1 \ + --iops 1000 \ + --snapshot-id snap-066877671789bd71b \ + --availability-zone us-east-1a + +Output:: + + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": false, + "VolumeType": "io1", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 500 + } + +**Example 3: To create an encrypted volume** + +The following ``create-volume`` example creates an encrypted volume using the default CMK for EBS encryption. If encryption by default is disabled, you must specify the ``--encrypted`` parameter as follows. :: + + aws ec2 create-volume \ + --size 80 \ + --encrypted \ + --availability-zone us-east-1a + +Output:: + + { + "AvailabilityZone": "us-east-1a", + "Tags": [], + "Encrypted": true, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "creating", + "Iops": 240, + "SnapshotId": "", + "CreateTime": "YYYY-MM-DDTHH:MM:SS.000Z", + "Size": 80 + } + +If encryption by default is enabled, the following example command creates an encrypted volume, even without the ``--encrypted`` parameter. :: + + aws ec2 create-volume \ + --size 80 \ + --availability-zone us-east-1a + +If you use the ``--kms-key-id`` parameter to specify a customer managed CMK, you must specify the ``--encrypted`` parameter even if encryption by default is enabled. :: + + aws ec2 create-volume \ + --volume-type gp2 \ + --size 80 \ + --encrypted \ + --kms-key-id 0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE \ + --availability-zone us-east-1a + +**Example 4: To create a volume with tags** + +The following ``create-volume`` example creates a volume and adds two tags. :: + + aws ec2 create-volume \ + --availability-zone us-east-1a \ + --volume-type gp2 \ + --size 80 \ + --tag-specifications 'ResourceType=volume,Tags=[{Key=purpose,Value=production},{Key=cost-center,Value=cc123}]' diff --git a/aws/dist/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst b/aws/dist/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst new file mode 100644 index 00000000..63a17539 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpc-endpoint-connection-notification.rst @@ -0,0 +1,23 @@ +**To create an endpoint connection notification** + +This example creates a notification for a specific endpoint service that alerts you when interface endpoints have connected to your service and when endpoints have been accepted for your service. + +Command:: + + aws ec2 create-vpc-endpoint-connection-notification --connection-notification-arn arn:aws:sns:us-east-2:123456789012:VpceNotification --connection-events Connect Accept --service-id vpce-svc-1237881c0d25a3abc + +Output:: + + { + "ConnectionNotification": { + "ConnectionNotificationState": "Enabled", + "ConnectionNotificationType": "Topic", + "ServiceId": "vpce-svc-1237881c0d25a3abc", + "ConnectionEvents": [ + "Accept", + "Connect" + ], + "ConnectionNotificationId": "vpce-nfn-008776de7e03f5abc", + "ConnectionNotificationArn": "arn:aws:sns:us-east-2:123456789012:VpceNotification" + } + } diff --git a/aws/dist/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst b/aws/dist/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst new file mode 100644 index 00000000..8faab3cd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpc-endpoint-service-configuration.rst @@ -0,0 +1,32 @@ +**To create an endpoint service configuration** + +This example creates a VPC endpoint service configuration using the load balancer ``nlb-vpce``. This example also specifies that requests to connect to the service through an interface endpoint must be accepted. + +Command:: + + aws ec2 create-vpc-endpoint-service-configuration --network-load-balancer-arns arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532 --acceptance-required + +Output:: + + { + "ServiceConfiguration": { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "NetworkLoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/nlb-vpce/e94221227f1ba532" + ], + "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-03d5ebb7d9579a2b3", + "ServiceState": "Available", + "ServiceId": "vpce-svc-03d5ebb7d9579a2b3", + "AcceptanceRequired": true, + "AvailabilityZones": [ + "us-east-1d" + ], + "BaseEndpointDnsNames": [ + "vpce-svc-03d5ebb7d9579a2b3.us-east-1.vpce.amazonaws.com" + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-vpc-endpoint.rst b/aws/dist/awscli/examples/ec2/create-vpc-endpoint.rst new file mode 100644 index 00000000..c350d443 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpc-endpoint.rst @@ -0,0 +1,82 @@ +**To create a gateway endpoint** + +The following ``create-vpc-endpoint`` example creates a gateway VPC endpoint between VPC ``vpc-1a2b3c4d`` and Amazon S3 in the ``us-east-1`` region, and associates route table ``rtb-11aa22bb`` with the endpoint. :: + + aws ec2 create-vpc-endpoint \ + --vpc-id vpc-1EXAMPLE \ + --service-name com.amazonaws.us-east-1.s3 \ + --route-table-ids rtb-1EXAMPLE + +Output:: + + { + "VpcEndpoint": { + "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"\*\",\"Action\":\"\*\",\"Resource\":\"\*\"}]}", + "VpcId": "vpc-1EXAMPLE", + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.s3", + "RouteTableIds": [ + "rtb-1EXAMPLE" + ], + "VpcEndpointId": "vpce-3EXAMPLE", + "CreationTimestamp": "2015-05-15T09:40:50Z" + } + } + +For more information, see `Creating a Gateway Endpoint `__ in the *AWS VPC User Guide*. + +**To create an interface endpoint** + +The following ``create-vpc-endpoint`` example creates an interface VPC endpoint between VPC ``vpc-1a2b3c4d`` and Elastic Load Balancing in the ``us-east-1`` region. The command creates the endpoint in subnet ``subnet-7b16de0c`` and associates it with security group ``sg-1a2b3c4d``. :: + + aws ec2 create-vpc-endpoint \ + --vpc-id vpc-1EXAMPLE \ + --vpc-endpoint-type Interface \ + --service-name com.amazonaws.us-east-1.elasticloadbalancing \ + --subnet-id subnet-7EXAMPLE \ + --security-group-id sg-1EXAMPLE + +Output:: + + { + "VpcEndpoint": { + "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"\*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"\*\", \n \"Resource\": \"\*\"\n }\n ]\n}", + "VpcId": "vpc-1EXAMPLE", + "NetworkInterfaceIds": [ + "eni-bf8aa46b" + ], + "SubnetIds": [ + "subnet-7EXAMPLE" + ], + "PrivateDnsEnabled": true, + "State": "pending", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "RouteTableIds": [], + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-1EXAMPLE" + } + ], + "VpcEndpointId": "vpce-088d25a4bbEXAMPLE", + "VpcEndpointType": "Interface", + "CreationTimestamp": "2017-09-05T20:14:41.240Z", + "DnsEntries": [ + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-088d25a4bbf4a7e66-ks83awe7.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-088d25a4bbf4a7e66-ks83awe7-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z1K56Z6FNPJRR", + "DnsName": "elasticloadbalancing.us-east-1.amazonaws.com" + } + ], + "OwnerId": "123456789012" + } + } + +For more information, see `Creating an Interface Endpoint `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-vpc-peering-connection.rst b/aws/dist/awscli/examples/ec2/create-vpc-peering-connection.rst new file mode 100644 index 00000000..c2b8af9d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpc-peering-connection.rst @@ -0,0 +1,52 @@ +**To create a VPC peering connection between your VPCs** + +This example requests a peering connection between your VPCs vpc-1a2b3c4d and vpc-11122233. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 + +Output:: + + { + "VpcPeeringConnection": { + "Status": { + "Message": "Initiating Request to 444455556666", + "Code": "initiating-request" + }, + "Tags": [], + "RequesterVpcInfo": { + "OwnerId": "444455556666", + "VpcId": "vpc-1a2b3c4d", + "CidrBlock": "10.0.0.0/28" + }, + "VpcPeeringConnectionId": "pcx-111aaa111", + "ExpirationTime": "2014-04-02T16:13:36.000Z", + "AccepterVpcInfo": { + "OwnerId": "444455556666", + "VpcId": "vpc-11122233" + } + } + } + +**To create a VPC peering connection with a VPC in another account** + +This example requests a peering connection between your VPC (vpc-1a2b3c4d), and a VPC (vpc-11122233) that belongs AWS account 123456789012. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 + +**To create a VPC peering connection with a VPC in a different region** + +This example requests a peering connection between your VPC in the current region (vpc-1a2b3c4d), and a VPC (vpc-11122233) in your account in the ``us-west-2`` region. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-region us-west-2 + +This example requests a peering connection between your VPC in the current region (vpc-1a2b3c4d), and a VPC (vpc-11122233) that belongs AWS account 123456789012 that's in the ``us-west-2`` region. + +Command:: + + aws ec2 create-vpc-peering-connection --vpc-id vpc-1a2b3c4d --peer-vpc-id vpc-11122233 --peer-owner-id 123456789012 --peer-region us-west-2 \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/create-vpc.rst b/aws/dist/awscli/examples/ec2/create-vpc.rst new file mode 100644 index 00000000..5577d82f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpc.rst @@ -0,0 +1,107 @@ +**To create a VPC** + +The following ``create-vpc`` example creates a VPC with the specified IPv4 CIDR block. :: + + aws ec2 create-vpc \ + --cidr-block 10.0.0.0/16 + +Output:: + + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-5EXAMPLE", + "State": "pending", + "VpcId": "vpc-0a60eb65b4EXAMPLE", + "OwnerId": "123456789012", + "InstanceTenancy": "default", + "Ipv6CidrBlockAssociationSet": [], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-07501b79ecEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [] + } + } + +**To create a VPC with dedicated tenancy** + +The following ``create-vpc`` example creates a VPC with the specified IPv4 CIDR block and dedicated tenancy. + + aws ec2 create-vpc \ + --cidr-block 10.0.0.0/16 \ + --instance-tenancy dedicated + +Output:: + + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "pending", + "VpcId": "vpc-0a53287fa4EXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "dedicated", + "Ipv6CidrBlockAssociationSet": [], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b24cc1c2EXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [] + } + } + +**To create a VPC with an IPv6 CIDR block** + +The following ``create-vpc`` example creates a VPC with an Amazon-provided IPv6 CIDR block. + + aws ec2 create-vpc \ + --cidr-block 10.0.0.0/16 \ + --amazon-provided-ipv6-cidr-block + +Output:: + + { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "pending", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "default", + "Ipv6CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-0aed4e604eEXAMPLE", + "Ipv6CidrBlock": "", + "Ipv6CidrBlockState": { + "State": "associating" + } + } + ], + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-06472385d8EXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [] + } + } + +For more information, see `Creating a VPC `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/create-vpn-connection-route.rst b/aws/dist/awscli/examples/ec2/create-vpn-connection-route.rst new file mode 100644 index 00000000..a115f534 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpn-connection-route.rst @@ -0,0 +1,7 @@ +**To create a static route for a VPN connection** + +This example creates a static route for the specified VPN connection. If the command succeeds, no output is returned. + +Command:: + + aws ec2 create-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 diff --git a/aws/dist/awscli/examples/ec2/create-vpn-connection.rst b/aws/dist/awscli/examples/ec2/create-vpn-connection.rst new file mode 100644 index 00000000..e201b047 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpn-connection.rst @@ -0,0 +1,62 @@ +**To create a VPN connection with dynamic routing** + +This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The output includes the configuration information that your network administrator needs, in XML format. + +Command:: + + aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-0e11f167 --vpn-gateway-id vgw-9a4cacf3 + +Output:: + + { + "VpnConnection": { + "VpnConnectionId": "vpn-1a2b3c4d" + "CustomerGatewayConfiguration": "...configuration information...", + "State": "available", + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-0e11f167" + } + } + +**To create a VPN connection with static routing** + +This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The options specify static routing. The output includes the configuration information that your network administrator needs, in XML format. + +Command:: + + aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-1a1a1a1a --vpn-gateway-id vgw-9a4cacf3 --options "{\"StaticRoutesOnly\":true}" + +Output:: + + { + "VpnConnection": { + "VpnConnectionId": "vpn-11aa33cc" + "CustomerGatewayConfiguration": "...configuration information...", + "State": "pending", + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-1a1a1a1a", + "Options": { + "StaticRoutesOnly": true + } + } + } + +**To create a VPN connection and specify your own inside CIDR and pre-shared key** + +This example creates a VPN connection and specifies the inside IP address CIDR block and a custom pre-shared key for each tunnel. The specified values are returned in the ``CustomerGatewayConfiguration`` information. + +Command:: + + aws ec2 create-vpn-connection --type ipsec.1 --customer-gateway-id cgw-b4de3fdd --vpn-gateway-id vgw-f211f09b --options "{"StaticRoutesOnly":false,"TunnelOptions":[{"TunnelInsideCidr":"169.254.12.0/30","PreSharedKey":"ExamplePreSharedKey1"},{"TunnelInsideCidr":"169.254.13.0/30","PreSharedKey":"ExamplePreSharedKey2"}]}" + +Output:: + + { + "VpnConnection": { + "VpnConnectionId": "vpn-40f41529" + "CustomerGatewayConfiguration": "...configuration information...", + "State": "pending", + "VpnGatewayId": "vgw-f211f09b", + "CustomerGatewayId": "cgw-b4de3fdd" + } + } diff --git a/aws/dist/awscli/examples/ec2/create-vpn-gateway.rst b/aws/dist/awscli/examples/ec2/create-vpn-gateway.rst new file mode 100644 index 00000000..cd285ea3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/create-vpn-gateway.rst @@ -0,0 +1,39 @@ +**To create a virtual private gateway** + +This example creates a virtual private gateway. + +Command:: + + aws ec2 create-vpn-gateway --type ipsec.1 + +Output:: + + { + "VpnGateway": { + "AmazonSideAsn": 64512, + "State": "available", + "Type": "ipsec.1", + "VpnGatewayId": "vgw-9a4cacf3", + "VpcAttachments": [] + } + } + +**To create a virtual private gateway with a specific Amazon-side ASN** + +This example creates a virtual private gateway and specifies the Autonomous System Number (ASN) for the Amazon side of the BGP session. + +Command:: + + aws ec2 create-vpn-gateway --type ipsec.1 --amazon-side-asn 65001 + +Output:: + + { + "VpnGateway": { + "AmazonSideAsn": 65001, + "State": "available", + "Type": "ipsec.1", + "VpnGatewayId": "vgw-9a4cacf3", + "VpcAttachments": [] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-client-vpn-endpoint.rst b/aws/dist/awscli/examples/ec2/delete-client-vpn-endpoint.rst new file mode 100644 index 00000000..3e9c9413 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-client-vpn-endpoint.rst @@ -0,0 +1,16 @@ +**To delete a Client VPN endpoint** + +The following ``delete-client-vpn-endpoint`` example deletes the specified Client VPN endpoint. :: + + aws ec2 delete-client-vpn-endpoint \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Status": { + "Code": "deleting" + } + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-client-vpn-route.rst b/aws/dist/awscli/examples/ec2/delete-client-vpn-route.rst new file mode 100644 index 00000000..fdf8f33f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-client-vpn-route.rst @@ -0,0 +1,18 @@ +**To delete a route for a Client VPN endpoint** + +The following ``delete-client-vpn-route`` example deletes the ``0.0.0.0/0`` route for the specified subnet of a Client VPN endpoint. :: + + aws ec2 delete-client-vpn-route \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --destination-cidr-block 0.0.0.0/0 \ + --target-vpc-subnet-id subnet-0123456789abcabca + +Output:: + + { + "Status": { + "Code": "deleting" + } + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-customer-gateway.rst b/aws/dist/awscli/examples/ec2/delete-customer-gateway.rst new file mode 100644 index 00000000..33bd9f62 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-customer-gateway.rst @@ -0,0 +1,7 @@ +**To delete a customer gateway** + +This example deletes the specified customer gateway. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-customer-gateway --customer-gateway-id cgw-0e11f167 diff --git a/aws/dist/awscli/examples/ec2/delete-dhcp-options.rst b/aws/dist/awscli/examples/ec2/delete-dhcp-options.rst new file mode 100644 index 00000000..34d7b5a5 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-dhcp-options.rst @@ -0,0 +1,7 @@ +**To delete a DHCP options set** + +This example deletes the specified DHCP options set. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-dhcp-options --dhcp-options-id dopt-d9070ebb diff --git a/aws/dist/awscli/examples/ec2/delete-egress-only-internet-gateway.rst b/aws/dist/awscli/examples/ec2/delete-egress-only-internet-gateway.rst new file mode 100644 index 00000000..e22a5536 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-egress-only-internet-gateway.rst @@ -0,0 +1,13 @@ +**To delete an egress-only Internet gateway** + +This example deletes the specified egress-only Internet gateway. + +Command:: + + aws ec2 delete-egress-only-internet-gateway --egress-only-internet-gateway-id eigw-01eadbd45ecd7943f + +Output:: + + { + "ReturnCode": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-flow-logs.rst b/aws/dist/awscli/examples/ec2/delete-flow-logs.rst new file mode 100644 index 00000000..d3d7f318 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-flow-logs.rst @@ -0,0 +1,11 @@ +**To delete a flow log** + +The following ``delete-flow-logs`` example deletes the specified flow log. :: + + aws ec2 delete-flow-logs --flow-log-id fl-11223344556677889 + +Output:: + + { + "Unsuccessful": [] + } diff --git a/aws/dist/awscli/examples/ec2/delete-fpga-image.rst b/aws/dist/awscli/examples/ec2/delete-fpga-image.rst new file mode 100644 index 00000000..fdec611c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-fpga-image.rst @@ -0,0 +1,13 @@ +**To delete an Amazon FPGA image** + +This example deletes the specified AFI. + +Command:: + + aws ec2 delete-fpga-image --fpga-image-id afi-06b12350a123fbabc + +Output:: + + { + "Return": true + } diff --git a/aws/dist/awscli/examples/ec2/delete-internet-gateway.rst b/aws/dist/awscli/examples/ec2/delete-internet-gateway.rst new file mode 100644 index 00000000..27887d16 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-internet-gateway.rst @@ -0,0 +1,7 @@ +**To delete an Internet gateway** + +This example deletes the specified Internet gateway. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-internet-gateway --internet-gateway-id igw-c0a643a9 diff --git a/aws/dist/awscli/examples/ec2/delete-key-pair.rst b/aws/dist/awscli/examples/ec2/delete-key-pair.rst new file mode 100644 index 00000000..4cd64fdd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-key-pair.rst @@ -0,0 +1,12 @@ +**To delete a key pair** + +This example deletes the key pair named ``MyKeyPair``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-key-pair --key-name MyKeyPair + +For more information, see `Using Key Pairs`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Key Pairs`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html + diff --git a/aws/dist/awscli/examples/ec2/delete-launch-template-versions.rst b/aws/dist/awscli/examples/ec2/delete-launch-template-versions.rst new file mode 100644 index 00000000..7b8a653a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-launch-template-versions.rst @@ -0,0 +1,20 @@ +**To delete a launch template version** + +This example deletes the specified launch template version. + +Command:: + + aws ec2 delete-launch-template-versions --launch-template-id lt-0abcd290751193123 --versions 1 + +Output:: + + { + "UnsuccessfullyDeletedLaunchTemplateVersions": [], + "SuccessfullyDeletedLaunchTemplateVersions": [ + { + "LaunchTemplateName": "TestVersion", + "VersionNumber": 1, + "LaunchTemplateId": "lt-0abcd290751193123" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-launch-template.rst b/aws/dist/awscli/examples/ec2/delete-launch-template.rst new file mode 100644 index 00000000..23073902 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-launch-template.rst @@ -0,0 +1,20 @@ +**To delete a launch template** + +This example deletes the specified launch template. + +Command:: + + aws ec2 delete-launch-template --launch-template-id lt-0abcd290751193123 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "TestTemplate", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-23T16:46:25.000Z" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-nat-gateway.rst b/aws/dist/awscli/examples/ec2/delete-nat-gateway.rst new file mode 100644 index 00000000..8c6a6bf9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-nat-gateway.rst @@ -0,0 +1,13 @@ +**To delete a NAT gateway** + +This example deletes NAT gateway ``nat-04ae55e711cec5680``. + +Command:: + + aws ec2 delete-nat-gateway --nat-gateway-id nat-04ae55e711cec5680 + +Output:: + + { + "NatGatewayId": "nat-04ae55e711cec5680" + } diff --git a/aws/dist/awscli/examples/ec2/delete-network-acl-entry.rst b/aws/dist/awscli/examples/ec2/delete-network-acl-entry.rst new file mode 100644 index 00000000..eb725f35 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-network-acl-entry.rst @@ -0,0 +1,7 @@ +**To delete a network ACL entry** + +This example deletes ingress rule number 100 from the specified network ACL. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 diff --git a/aws/dist/awscli/examples/ec2/delete-network-acl.rst b/aws/dist/awscli/examples/ec2/delete-network-acl.rst new file mode 100644 index 00000000..344b45bd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-network-acl.rst @@ -0,0 +1,7 @@ +**To delete a network ACL** + +This example deletes the specified network ACL. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-network-acl --network-acl-id acl-5fb85d36 diff --git a/aws/dist/awscli/examples/ec2/delete-network-interface-permission.rst b/aws/dist/awscli/examples/ec2/delete-network-interface-permission.rst new file mode 100644 index 00000000..31b9b6ce --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-network-interface-permission.rst @@ -0,0 +1,13 @@ +**To delete a network interface permission** + +This example deletes the specified network interface permission. + +Command:: + + aws ec2 delete-network-interface-permission --network-interface-permission-id eni-perm-06fd19020ede149ea + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-network-interface.rst b/aws/dist/awscli/examples/ec2/delete-network-interface.rst new file mode 100644 index 00000000..4bb126c7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-network-interface.rst @@ -0,0 +1,7 @@ +**To delete a network interface** + +This example deletes the specified network interface. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-network-interface --network-interface-id eni-e5aa89a3 diff --git a/aws/dist/awscli/examples/ec2/delete-placement-group.rst b/aws/dist/awscli/examples/ec2/delete-placement-group.rst new file mode 100644 index 00000000..d0942692 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-placement-group.rst @@ -0,0 +1,7 @@ +**To delete a placement group** + +This example command deletes the specified placement group. + +Command:: + + aws ec2 delete-placement-group --group-name my-cluster diff --git a/aws/dist/awscli/examples/ec2/delete-route-table.rst b/aws/dist/awscli/examples/ec2/delete-route-table.rst new file mode 100644 index 00000000..a1b3923b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-route-table.rst @@ -0,0 +1,7 @@ +**To delete a route table** + +This example deletes the specified route table. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-route-table --route-table-id rtb-22574640 diff --git a/aws/dist/awscli/examples/ec2/delete-route.rst b/aws/dist/awscli/examples/ec2/delete-route.rst new file mode 100644 index 00000000..fbedd499 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-route.rst @@ -0,0 +1,7 @@ +**To delete a route** + +This example deletes the specified route from the specified route table. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-route --route-table-id rtb-22574640 --destination-cidr-block 0.0.0.0/0 diff --git a/aws/dist/awscli/examples/ec2/delete-security-group.rst b/aws/dist/awscli/examples/ec2/delete-security-group.rst new file mode 100644 index 00000000..1e2480d1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-security-group.rst @@ -0,0 +1,19 @@ +**[EC2-Classic] To delete a security group** + +This example deletes the security group named ``MySecurityGroup``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-security-group --group-name MySecurityGroup + +**[EC2-VPC] To delete a security group** + +This example deletes the security group with the ID ``sg-903004f8``. Note that you can't reference a security group for EC2-VPC by name. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-security-group --group-id sg-903004f8 + +For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html diff --git a/aws/dist/awscli/examples/ec2/delete-snapshot.rst b/aws/dist/awscli/examples/ec2/delete-snapshot.rst new file mode 100644 index 00000000..19db7a0f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-snapshot.rst @@ -0,0 +1,7 @@ +**To delete a snapshot** + +This example command deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-snapshot --snapshot-id snap-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/delete-spot-datafeed-subscription.rst b/aws/dist/awscli/examples/ec2/delete-spot-datafeed-subscription.rst new file mode 100644 index 00000000..62cad573 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-spot-datafeed-subscription.rst @@ -0,0 +1,7 @@ +**To cancel a Spot Instance data feed subscription** + +This example command deletes a Spot data feed subscription for the account. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-spot-datafeed-subscription diff --git a/aws/dist/awscli/examples/ec2/delete-subnet.rst b/aws/dist/awscli/examples/ec2/delete-subnet.rst new file mode 100644 index 00000000..ba2c1b1f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-subnet.rst @@ -0,0 +1,7 @@ +**To delete a subnet** + +This example deletes the specified subnet. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-subnet --subnet-id subnet-9d4a7b6c diff --git a/aws/dist/awscli/examples/ec2/delete-tags.rst b/aws/dist/awscli/examples/ec2/delete-tags.rst new file mode 100755 index 00000000..66c7e8d4 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-tags.rst @@ -0,0 +1,27 @@ +**Example 1: To delete a tag from a resource** + +The following ``delete-tags`` example deletes the tag ``Stack=Test`` from the specified image. When you specify both a value and a key name, the tag is deleted only if the tag's value matches the specified value. :: + + aws ec2 delete-tags \ + --resources ami-1234567890abcdef0 \ + --tags Key=Stack,Value=Test + +It's optional to specify the value for a tag. The following ``delete-tags`` example deletes the tag with the key name ``purpose`` from the specified instance, regardless of the tag value for the tag. :: + + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 \ + --tags Key=purpose + +If you specify the empty string as the tag value, the tag is deleted only if the tag's value is the empty string. The following ``delete-tags`` example specifies the empty string as the tag value for the tag to delete. :: + + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 \ + --tags Key=Name,Value= + +**Example 2: To delete a tag from multiple resources** + +The following ``delete-tags`` example deletes the tag``Purpose=Test`` from both an instance and an AMI. As shown in the previous example, you can omit the tag value from the command. :: + + aws ec2 delete-tags \ + --resources i-1234567890abcdef0 ami-1234567890abcdef0 \ + --tags Key=Purpose diff --git a/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst new file mode 100644 index 00000000..0c677251 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter-rule.rst @@ -0,0 +1,14 @@ +**To delete a traffic mirror filter rule** + +The following ``delete-traffic-mirror-filter-rule`` example deletes the specified traffic mirror filter rule. :: + + aws ec2 delete-traffic-mirror-filter-rule \ + --traffic-mirror-filter-rule-id tmfr-081f71283bEXAMPLE + +Output:: + + { + "TrafficMirrorFilterRuleId": "tmfr-081f71283bEXAMPLE" + } + +For more information, see `Modify Your Traffic Mirror Filter Rules `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter.rst b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter.rst new file mode 100644 index 00000000..329bf8fd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-filter.rst @@ -0,0 +1,14 @@ +**To delete a traffic mirror filter** + +The following ``delete-traffic-mirror-filter`` example deletes the specified traffic mirror filter. :: + + aws ec2 delete-traffic-mirror-filter \ + --traffic-mirror-filter-id tmf-0be0b25fcdEXAMPLE + +Output:: + + { + "TrafficMirrorFilterId": "tmf-0be0b25fcdEXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Filter `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-traffic-mirror-session.rst b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-session.rst new file mode 100644 index 00000000..0e84ebc5 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-session.rst @@ -0,0 +1,14 @@ +**To delete a traffic mirror session** + +The following ``delete-traffic-mirror-session`` example deletes the specified traffic mirror-session. :: + + aws ec2 delete-traffic-mirror-session \ + --traffic-mirror-session-id tms-0af3141ce5EXAMPLE + +Output:: + + { + "TrafficMirrorSessionId": "tms-0af3141ce5EXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Session `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-traffic-mirror-target.rst b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-target.rst new file mode 100644 index 00000000..ee26ae3e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-traffic-mirror-target.rst @@ -0,0 +1,14 @@ +**To delete a traffic mirror target** + +The following ``delete-traffic-mirror-target`` example deletes the specified traffic mirror target. :: + + aws ec2 delete-traffic-mirror-target \ + --traffic-mirror-target-id tmt-060f48ce9EXAMPLE + +Output:: + + { + "TrafficMirrorTargetId": "tmt-060f48ce9EXAMPLE" + } + +For more information, see `Delete a Traffic Mirror Target `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-transit-gateway-route-table.rst b/aws/dist/awscli/examples/ec2/delete-transit-gateway-route-table.rst new file mode 100755 index 00000000..69b934ce --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-transit-gateway-route-table.rst @@ -0,0 +1,21 @@ +**To delete a transit gateway route table** + +The following ``delete-transit-gateway-route-table`` example deletes the specified transit gateway route table. :: + + aws ec2 delete-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE + +Output:: + + { + "TransitGatewayRouteTable": { + "TransitGatewayRouteTableId": "tgw-rtb-0b6f6aaa01EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "State": "deleting", + "DefaultAssociationRouteTable": false, + "DefaultPropagationRouteTable": false, + "CreationTime": "2019-07-17T20:27:26.000Z" + } + } + +For more information, see `Delete a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-transit-gateway-route.rst b/aws/dist/awscli/examples/ec2/delete-transit-gateway-route.rst new file mode 100755 index 00000000..04ee8593 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-transit-gateway-route.rst @@ -0,0 +1,26 @@ +**To delete a CIDR block from a route table** + +The following command deletes the CIDR block from the specified transit gateway route table. :: + + aws ec2 delete-transit-gateway-route \ + --transit-gateway-route-table-id tgw-rtb-0b6f6aaa01EXAMPLE \ + --destination-cidr-block 10.0.2.0/24 + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-0065acced4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "deleted" + } + } + +For more information, see `Delete a Static Route `__ in the *AWS Transit Gateways*. diff --git a/aws/dist/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst b/aws/dist/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst new file mode 100644 index 00000000..0963dffc --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-transit-gateway-vpc-attachment.rst @@ -0,0 +1,26 @@ +**To delete a transit gateway VPC attachment** + +The following ``delete-transit-gateway-vpc-attachment`` example deletes the specified transit gateway VPC attachment. :: + + aws ec2 delete-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0d2c54bdbEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0d2c54bdb3EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "VpcId": "vpc-0065acced4f61c651", + "VpcOwnerId": "111122223333", + "State": "deleting", + "CreationTime": "2019-07-17T16:04:27.000Z" + } + }{ + "Key": { + "Key": + "Value" + } + } + +For more information, see `Delete a VPC Attachment `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-transit-gateway.rst b/aws/dist/awscli/examples/ec2/delete-transit-gateway.rst new file mode 100755 index 00000000..35d706ff --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-transit-gateway.rst @@ -0,0 +1,29 @@ +**To delete a transit gateway** + +The following ``delete-transit-gateway`` example deletes the specified transit gateway. :: + + aws ec2 delete-transit-gateway --transit-gateway-id tgw-01f04542b2EXAMPLE + +Output:: + + { + "TransitGateway": { + "TransitGatewayId": "tgw-01f04542b2EXAMPLE", + "State": "deleting", + "OwnerId": "123456789012", + "Description": "Example Transit Gateway", + "CreationTime": "2019-08-27T15:04:35.000Z", + "Options": { + "AmazonSideAsn": 64515, + "AutoAcceptSharedAttachments": "disable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-0ce7a6948fEXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + } + } + } + +For more information, see `Delete a Transit Gateway`__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/delete-volume.rst b/aws/dist/awscli/examples/ec2/delete-volume.rst new file mode 100644 index 00000000..11744013 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-volume.rst @@ -0,0 +1,7 @@ +**To delete a volume** + +This example command deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-volume --volume-id vol-049df61146c4d7901 diff --git a/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst b/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst new file mode 100644 index 00000000..8a703134 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-connection-notifications.rst @@ -0,0 +1,13 @@ +**To delete an endpoint connection notification** + +This example deletes the specified endpoint connection notification. + +Command:: + + aws ec2 delete-vpc-endpoint-connection-notifications --connection-notification-ids vpce-nfn-008776de7e03f5abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst b/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst new file mode 100644 index 00000000..32210c7b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpc-endpoint-service-configurations.rst @@ -0,0 +1,13 @@ +**To delete an endpoint service configuration** + +This example deletes the specified endpoint service configuration. + +Command:: + + aws ec2 delete-vpc-endpoint-service-configurations --service-ids vpce-svc-03d5ebb7d9579a2b3 + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-vpc-endpoints.rst b/aws/dist/awscli/examples/ec2/delete-vpc-endpoints.rst new file mode 100644 index 00000000..0f1bf6eb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpc-endpoints.rst @@ -0,0 +1,13 @@ +**To delete an endpoint** + +This example deletes endpoints vpce-aa22bb33 and vpce-1a2b3c4d. If the command is partially successful or unsuccessful, a list of unsuccessful items is returned. If the command succeeds, the returned list is empty. + +Command:: + + aws ec2 delete-vpc-endpoints --vpc-endpoint-ids vpce-aa22bb33 vpce-1a2b3c4d + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/delete-vpc-peering-connection.rst b/aws/dist/awscli/examples/ec2/delete-vpc-peering-connection.rst new file mode 100644 index 00000000..e8d3b4ac --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpc-peering-connection.rst @@ -0,0 +1,13 @@ +**To delete a VPC peering connection** + +This example deletes the specified VPC peering connection. + +Command:: + + aws ec2 delete-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d + +Output:: + + { + "Return": true + } diff --git a/aws/dist/awscli/examples/ec2/delete-vpc.rst b/aws/dist/awscli/examples/ec2/delete-vpc.rst new file mode 100644 index 00000000..ecac7f9d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpc.rst @@ -0,0 +1,7 @@ +**To delete a VPC** + +This example deletes the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-vpc --vpc-id vpc-a01106c2 diff --git a/aws/dist/awscli/examples/ec2/delete-vpn-connection-route.rst b/aws/dist/awscli/examples/ec2/delete-vpn-connection-route.rst new file mode 100644 index 00000000..7e352b1b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpn-connection-route.rst @@ -0,0 +1,7 @@ +**To delete a static route from a VPN connection** + +This example deletes the specified static route from the specified VPN connection. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-vpn-connection-route --vpn-connection-id vpn-40f41529 --destination-cidr-block 11.12.0.0/16 diff --git a/aws/dist/awscli/examples/ec2/delete-vpn-connection.rst b/aws/dist/awscli/examples/ec2/delete-vpn-connection.rst new file mode 100644 index 00000000..9e197c69 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpn-connection.rst @@ -0,0 +1,7 @@ +**To delete a VPN connection** + +This example deletes the specified VPN connection. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-vpn-connection --vpn-connection-id vpn-40f41529 diff --git a/aws/dist/awscli/examples/ec2/delete-vpn-gateway.rst b/aws/dist/awscli/examples/ec2/delete-vpn-gateway.rst new file mode 100644 index 00000000..0e3d2a6f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/delete-vpn-gateway.rst @@ -0,0 +1,7 @@ +**To delete a virtual private gateway** + +This example deletes the specified virtual private gateway. If the command succeeds, no output is returned. + +Command:: + + aws ec2 delete-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 diff --git a/aws/dist/awscli/examples/ec2/deprovision-byoip-cidr.rst b/aws/dist/awscli/examples/ec2/deprovision-byoip-cidr.rst new file mode 100644 index 00000000..424148da --- /dev/null +++ b/aws/dist/awscli/examples/ec2/deprovision-byoip-cidr.rst @@ -0,0 +1,15 @@ +**To remove an IP address range from use** + +The following example removes the specified address range from use with AWS. :: + + aws ec2 deprovision-byoip-cidr \ + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "pending-deprovision" + } + } diff --git a/aws/dist/awscli/examples/ec2/deregister-image.rst b/aws/dist/awscli/examples/ec2/deregister-image.rst new file mode 100644 index 00000000..0c614073 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/deregister-image.rst @@ -0,0 +1,7 @@ +**To deregister an AMI** + +This example deregisters the specified AMI. If the command succeeds, no output is returned. + +Command:: + + aws ec2 deregister-image --image-id ami-4fa54026 diff --git a/aws/dist/awscli/examples/ec2/describe-account-attributes.rst b/aws/dist/awscli/examples/ec2/describe-account-attributes.rst new file mode 100644 index 00000000..1dbae2d1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-account-attributes.rst @@ -0,0 +1,92 @@ +**To describe all the attributes for your AWS account** + +This example describes the attributes for your AWS account. + +Command:: + + aws ec2 describe-account-attributes + +Output:: + + { + "AccountAttributes": [ + { + "AttributeName": "vpc-max-security-groups-per-interface", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-instances", + "AttributeValues": [ + { + "AttributeValue": "20" + } + ] + }, + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + }, + { + "AttributeName": "default-vpc", + "AttributeValues": [ + { + "AttributeValue": "none" + } + ] + }, + { + "AttributeName": "max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "vpc-max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + } + ] + } + +**To describe a single attribute for your AWS account** + +This example describes the ``supported-platforms`` attribute for your AWS account. + +Command:: + + aws ec2 describe-account-attributes --attribute-names supported-platforms + +Output:: + + { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/describe-addresses.rst b/aws/dist/awscli/examples/ec2/describe-addresses.rst new file mode 100644 index 00000000..4dabe985 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-addresses.rst @@ -0,0 +1,127 @@ +**Example 1: To retrieve details about all of your Elastic IP addresses** + +The following ``describe addresses`` example displays details about your Elastic IP addresses. :: + + aws ec2 describe-addresses + +Output:: + + { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + }, + { + "Domain": "vpc", + "PublicIpv4Pool": "amazon", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } + +**Example 2: To retrieve details your Elastic IP addresses for EC2-VPC** + +The following ``describe-addresses`` example displays details about your Elastic IP addresses for use with instances in a VPC. :: + + aws ec2 describe-addresses \ + --filters "Name=domain,Values=vpc" + +Output:: + + { + "Addresses": [ + { + "Domain": "vpc", + "PublicIpv4Pool": "amazon", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "AssociationId": "eipassoc-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PublicIp": "203.0.113.0", + "AllocationId": "eipalloc-12345678", + "PrivateIpAddress": "10.0.1.241" + } + ] + } + +**Example 3: To retrieve details about an Elastic IP address specified by allocation ID** + +The following ``describe-addresses`` example displays details about the Elastic IP address with the specified allocation ID, which is associated with an instance in EC2-VPC. :: + + aws ec2 describe-addresses \ + --allocation-ids eipalloc-282d9641 + +Output:: + + { + "Addresses": [ + { + "Domain": "vpc", + "PublicIpv4Pool": "amazon", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-1a2b3c4d", + "AssociationId": "eipassoc-123abc12", + "NetworkInterfaceOwnerId": "1234567891012", + "PublicIp": "203.0.113.25", + "AllocationId": "eipalloc-282d9641", + "PrivateIpAddress": "10.251.50.12" + } + ] + } + +**Example 4: To retrieve details about an Elastic IP address specified by its VPC private IP address** + +The following ``describe-addresses`` example displays details about the Elastic IP address associated with a particular private IP address in EC2-VPC. :: + + aws ec2 describe-addresses \ + --filters "Name=private-ip-address,Values=10.251.50.12" + +**Example 5: To retrieve details about Elastic IP addresses in EC2-Classic** + +TThe following ``describe-addresses`` example displays details about your Elastic IP addresses for use in EC2-Classic. :: + + aws ec2 describe-addresses \ + --filters "Name=domain,Values=standard" + +Output:: + + { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "203.0.110.25", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + } + ] + } + +**Example 6: To retrieve details about an Elastic IP addresses specified by its public IP address** + +The following ``describe-addresses`` example displays details about the Elastic IP address with the value ``203.0.110.25``, which is associated with an instance in EC2-Classic. :: + + aws ec2 describe-addresses \ + --public-ips 203.0.110.25 + +Output:: + + { + "Addresses": [ + { + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "203.0.110.25", + "PublicIpv4Pool": "amazon", + "Domain": "standard" + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/describe-aggregate-id-format.rst b/aws/dist/awscli/examples/ec2/describe-aggregate-id-format.rst new file mode 100755 index 00000000..b057d2c8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-aggregate-id-format.rst @@ -0,0 +1,29 @@ +**To describe the longer ID format settings for all resource types in a Region** + +The following ``describe-aggregate-id-format`` example describes the overall long ID format status for the current Region. The ``Deadline`` value indicates that the deadlines for these resources to permanently switch from the short ID format to the long ID format expired. The ``UseLongIdsAggregated`` value indicates that all IAM users and IAM roles are configured to use long ID format for all resource types. :: + + aws ec2 describe-aggregate-id-format + +Output:: + + { + "UseLongIdsAggregated": true, + "Statuses": [ + { + "Deadline": "2018-08-13T02:00:00.000Z", + "Resource": "network-interface-attachment", + "UseLongIds": true + }, + { + "Deadline": "2016-12-13T02:00:00.000Z", + "Resource": "instance", + "UseLongIds": true + }, + { + "Deadline": "2018-08-13T02:00:00.000Z", + "Resource": "elastic-ip-association", + "UseLongIds": true + }, + ... + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-availability-zones.rst b/aws/dist/awscli/examples/ec2/describe-availability-zones.rst new file mode 100755 index 00000000..529a01f0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-availability-zones.rst @@ -0,0 +1,33 @@ +**To describe your Availability Zones** + +The following ``describe-availability-zones`` example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current Region. :: + + aws ec2 describe-availability-zones + +The following is example example output for the US East (Ohio) Region. :: + + { + "AvailabilityZones": [ + { + "State": "available", + "Messages": [], + "RegionName": "us-east-2", + "ZoneName": "us-east-2a", + "ZoneId": "use2-az1" + }, + { + "State": "available", + "Messages": [], + "RegionName": "us-east-2", + "ZoneName": "us-east-2b", + "ZoneId": "use2-az2" + }, + { + "State": "available", + "Messages": [], + "RegionName": "us-east-2", + "ZoneName": "us-east-2c", + "ZoneId": "use2-az3" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-bundle-tasks.rst b/aws/dist/awscli/examples/ec2/describe-bundle-tasks.rst new file mode 100644 index 00000000..8c6376e2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-bundle-tasks.rst @@ -0,0 +1,28 @@ +**To describe your bundle tasks** + +This example describes all of your bundle tasks. + +Command:: + + aws ec2 describe-bundle-tasks + +Output:: + + { + "BundleTasks": [ + { + "UpdateTime": "2015-09-15T13:26:54.000Z", + "InstanceId": "i-1234567890abcdef0", + "Storage": { + "S3": { + "Prefix": "winami", + "Bucket": "bundletasks" + } + }, + "State": "bundling", + "StartTime": "2015-09-15T13:24:35.000Z", + "Progress": "3%", + "BundleId": "bun-2a4e041c" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-byoip-cidrs.rst b/aws/dist/awscli/examples/ec2/describe-byoip-cidrs.rst new file mode 100644 index 00000000..f2940408 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-byoip-cidrs.rst @@ -0,0 +1,17 @@ +**To describe your provisioned address ranges** + +The following ``describe-byoip-cidrs`` example displays details about the public IPv4 address ranges that you provisioned for use by AWS. :: + + aws ec2 describe-byoip-cidrs + +Output:: + + { + "ByoipCidrs": [ + { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "provisioned" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-capacity-reservations.rst b/aws/dist/awscli/examples/ec2/describe-capacity-reservations.rst new file mode 100644 index 00000000..ff808842 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-capacity-reservations.rst @@ -0,0 +1,76 @@ +**Example 1: To describe one or more of your capacity reservations** + +The following ``describe-capacity-reservations`` example displays details about all of your capacity reservations in the current AWS Region. :: + + aws ec2 describe-capacity-reservations + +Output:: + + { + "CapacityReservations": [ + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:03:18.000Z", + "AvailableInstanceCount": 1, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 1, + "State": "active", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "a1.medium" + }, + { + "CapacityReservationId": "cr-abcdEXAMPLE9876ef ", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-07T11:34:19.000Z", + "AvailableInstanceCount": 3, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 3, + "State": "cancelled", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "m5.large" + } + ] + } + +**Example 2: To describe one or more of your capacity reservations** + +The following ``describe-capacity-reservations`` example displays details about the specified capacity reservation. :: + + aws ec2 describe-capacity-reservations \ + --capacity-reserveration-id cr-1234abcd56EXAMPLE + +Output:: + + { + "CapacityReservations": [ + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE", + "EndDateType": "unlimited", + "AvailabilityZone": "eu-west-1a", + "InstanceMatchCriteria": "open", + "Tags": [], + "EphemeralStorage": false, + "CreateDate": "2019-08-16T09:03:18.000Z", + "AvailableInstanceCount": 1, + "InstancePlatform": "Linux/UNIX", + "TotalInstanceCount": 1, + "State": "active", + "Tenancy": "default", + "EbsOptimized": true, + "InstanceType": "a1.medium" + } + ] + } + +For more information, see `Viewing a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/describe-classic-link-instances.rst b/aws/dist/awscli/examples/ec2/describe-classic-link-instances.rst new file mode 100644 index 00000000..eec8edd7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-classic-link-instances.rst @@ -0,0 +1,72 @@ +**To describe linked EC2-Classic instances** + +This example lists all of your linked EC2-Classic instances. + +Command:: + + aws ec2 describe-classic-link-instances + +Output:: + + { + "Instances": [ + { + "InstanceId": "i-1234567890abcdef0", + "VpcId": "vpc-88888888", + "Groups": [ + { + "GroupId": "sg-11122233" + } + ], + "Tags": [ + { + "Value": "ClassicInstance", + "Key": "Name" + } + ] + }, + { + "InstanceId": "i-0598c7d356eba48d7", + "VpcId": "vpc-12312312", + "Groups": [ + { + "GroupId": "sg-aabbccdd" + } + ], + "Tags": [ + { + "Value": "ClassicInstance2", + "Key": "Name" + } + ] + } + ] + } + +This example lists all of your linked EC2-Classic instances, and filters the response to include only instances that are linked to VPC vpc-88888888. + +Command:: + + aws ec2 describe-classic-link-instances --filter "Name=vpc-id,Values=vpc-88888888" + +Output:: + + { + "Instances": [ + { + "InstanceId": "i-1234567890abcdef0", + "VpcId": "vpc-88888888", + "Groups": [ + { + "GroupId": "sg-11122233" + } + ], + "Tags": [ + { + "Value": "ClassicInstance", + "Key": "Name" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst b/aws/dist/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst new file mode 100644 index 00000000..c9a38c7c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-client-vpn-authorization-rules.rst @@ -0,0 +1,24 @@ +**To describe the authorization rules for a Client VPN endpoint** + +The following ``describe-client-vpn-authorization-rules`` example displays details about the authorization rules for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-authorization-rules \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "AuthorizationRules": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "GroupId": "", + "AccessAll": true, + "DestinationCidr": "0.0.0.0/0", + "Status": { + "Code": "active" + } + } + ] + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-client-vpn-connections.rst b/aws/dist/awscli/examples/ec2/describe-client-vpn-connections.rst new file mode 100644 index 00000000..75901932 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-client-vpn-connections.rst @@ -0,0 +1,47 @@ +**To describe the connections to a Client VPN endpoint** + +The following ``describe-client-vpn-connections`` example displays details about the client connections to the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-connections \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Connections": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Timestamp": "2019-08-12 07:58:34", + "ConnectionId": "cvpn-connection-0e03eb24267165acd", + "ConnectionEstablishedTime": "2019-08-12 07:57:14", + "IngressBytes": "32302", + "EgressBytes": "5696", + "IngressPackets": "332", + "EgressPackets": "67", + "ClientIp": "172.31.0.225", + "CommonName": "client1.domain.tld", + "Status": { + "Code": "terminated" + }, + "ConnectionEndTime": "2019-08-12 07:58:34" + }, + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Timestamp": "2019-08-12 08:02:54", + "ConnectionId": "cvpn-connection-00668867a40f18253", + "ConnectionEstablishedTime": "2019-08-12 08:02:53", + "IngressBytes": "2951", + "EgressBytes": "2611", + "IngressPackets": "9", + "EgressPackets": "6", + "ClientIp": "172.31.0.226", + "CommonName": "client1.domain.tld", + "Status": { + "Code": "active" + }, + "ConnectionEndTime": "-" + } + ] + } + +For more information, see `Client Connections `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-client-vpn-endpoints.rst b/aws/dist/awscli/examples/ec2/describe-client-vpn-endpoints.rst new file mode 100644 index 00000000..3ce970c8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-client-vpn-endpoints.rst @@ -0,0 +1,46 @@ +**To describe your Client VPN endpoints** + +The following example displays details about all of your Client VPN endpoints. :: + + aws ec2 describe-client-vpn-endpoints + +Output:: + + { + "ClientVpnEndpoints": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Description": "", + "Status": { + "Code": "available" + }, + "CreationTime": "2019-07-08T11:37:27", + "DnsName": "*.cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com", + "ClientCidrBlock": "172.31.0.0/16", + "DnsServers": [ + "8.8.8.8" + ], + "SplitTunnel": false, + "VpnProtocol": "openvpn", + "TransportProtocol": "udp", + "ServerCertificateArn": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "AuthenticationOptions": [ + { + "Type": "certificate-authentication", + "MutualAuthentication": { + "ClientRootCertificateChain": "arn:aws:acm:ap-south-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + } + } + ], + "ConnectionLogOptions": { + "Enabled": false + }, + "Tags": [ + { + "Key": "Name", + "Value": "Client VPN" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-client-vpn-routes.rst b/aws/dist/awscli/examples/ec2/describe-client-vpn-routes.rst new file mode 100644 index 00000000..90a417e7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-client-vpn-routes.rst @@ -0,0 +1,36 @@ +**To describe the routes for a Client VPN endpoint** + +The following ``describe-client-vpn-routes`` example displays details about the routes for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-routes \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Routes": [ + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "DestinationCidr": "10.0.0.0/16", + "TargetSubnet": "subnet-0123456789abcabca", + "Type": "Nat", + "Origin": "associate", + "Status": { + "Code": "active" + }, + "Description": "Default Route" + }, + { + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "DestinationCidr": "0.0.0.0/0", + "TargetSubnet": "subnet-0123456789abcabca", + "Type": "Nat", + "Origin": "add-route", + "Status": { + "Code": "active" + } + } + ] + } + +For more information, see `Routes `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-client-vpn-target-networks.rst b/aws/dist/awscli/examples/ec2/describe-client-vpn-target-networks.rst new file mode 100644 index 00000000..776388b8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-client-vpn-target-networks.rst @@ -0,0 +1,27 @@ +**To describe the target networks for a Client VPN endpoint** + +The following ``describe-client-vpn-target-networks`` example displays details about the target networks for the specified Client VPN endpoint. :: + + aws ec2 describe-client-vpn-target-networks \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "ClientVpnTargetNetworks": [ + { + "AssociationId": "cvpn-assoc-012e837060753dc3d", + "VpcId": "vpc-11111222222333333", + "TargetNetworkId": "subnet-0123456789abcabca", + "ClientVpnEndpointId": "cvpn-endpoint-123456789123abcde", + "Status": { + "Code": "associating" + }, + "SecurityGroups": [ + "sg-012345678910abcab" + ] + } + ] + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-conversion-tasks.rst b/aws/dist/awscli/examples/ec2/describe-conversion-tasks.rst new file mode 100644 index 00000000..ddfbcd54 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-conversion-tasks.rst @@ -0,0 +1,38 @@ +**To view the status of a conversion task** + +This example returns the status of a conversion task with the ID import-i-ffvko9js. + +Command:: + + aws ec2 describe-conversion-tasks --conversion-task-ids import-i-ffvko9js + +Output:: + + { + "ConversionTasks": [ + { + "ConversionTaskId": "import-i-ffvko9js", + "ImportInstance": { + "InstanceId": "i-1234567890abcdef0", + "Volumes": [ + { + "Volume": { + "Id": "vol-049df61146c4d7901", + "Size": 16 + }, + "Status": "completed", + "Image": { + "Size": 1300687360, + "ImportManifestUrl": "https://s3.amazonaws.com/myimportbucket/411443cd-d620-4f1c-9d66-13144EXAMPLE/RHEL5.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=140EXAMPLE&Signature=XYNhznHNgCqsjDxL9wRL%2FJvEXAMPLE", + "Format": "VMDK" + }, + "BytesConverted": 1300682960, + "AvailabilityZone": "us-east-1d" + } + ] + }, + "ExpirationTime": "2014-05-14T22:06:23Z", + "State": "completed" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-customer-gateways.rst b/aws/dist/awscli/examples/ec2/describe-customer-gateways.rst new file mode 100644 index 00000000..fa2b221b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-customer-gateways.rst @@ -0,0 +1,50 @@ +**To describe your customer gateways** + +This example describes your customer gateways. + +Command:: + + aws ec2 describe-customer-gateways + +Output:: + + { + "CustomerGateways": [ + { + "CustomerGatewayId": "cgw-b4dc3961", + "IpAddress": "203.0.113.12", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65000" + }, + { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + ] + } + +**To describe a specific customer gateway** + +This example describes the specified customer gateway. + +Command:: + + aws ec2 describe-customer-gateways --customer-gateway-ids cgw-0e11f167 + +Output:: + + { + "CustomerGateways": [ + { + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1", + "BgpAsn": "65534" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-dhcp-options.rst b/aws/dist/awscli/examples/ec2/describe-dhcp-options.rst new file mode 100644 index 00000000..5da3bcaa --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-dhcp-options.rst @@ -0,0 +1,58 @@ +**To describe your DHCP options** + +The following ``describe-dhcp-options`` example retrieves details about your DHCP options. :: + + aws ec2 describe-dhcp-options + +Output:: + + { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "us-east-2.compute.internal" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "AmazonProvidedDNS" + } + ] + } + ], + "DhcpOptionsId": "dopt-19edf471", + "OwnerId": "111122223333" + }, + { + "DhcpConfigurations": [ + { + "Key": "domain-name", + "Values": [ + { + "Value": "us-east-2.compute.internal" + } + ] + }, + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "AmazonProvidedDNS" + } + ] + } + ], + "DhcpOptionsId": "dopt-fEXAMPLE", + "OwnerId": "111122223333" + } + ] + } + +For more information, see `Working with DHCP Option Sets `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-egress-only-internet-gateways.rst b/aws/dist/awscli/examples/ec2/describe-egress-only-internet-gateways.rst new file mode 100644 index 00000000..7a9b81eb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-egress-only-internet-gateways.rst @@ -0,0 +1,23 @@ +**To describe your egress-only Internet gateways** + +This example describes your egress-only Internet gateways. + +Command:: + + aws ec2 describe-egress-only-internet-gateways + +Output:: + + { + "EgressOnlyInternetGateways": [ + { + "EgressOnlyInternetGatewayId": "eigw-015e0e244e24dfe8a", + "Attachments": [ + { + "State": "attached", + "VpcId": "vpc-0c62a468" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-elastic-gpus.rst b/aws/dist/awscli/examples/ec2/describe-elastic-gpus.rst new file mode 100644 index 00000000..848b0a33 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-elastic-gpus.rst @@ -0,0 +1,5 @@ +**To describe an Elastic GPU** + +Command:: + + aws ec2 describe-elastic-gpus --elastic-gpu-ids egpu-12345678901234567890abcdefghijkl \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-export-image-tasks.rst b/aws/dist/awscli/examples/ec2/describe-export-image-tasks.rst new file mode 100755 index 00000000..025aa211 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-export-image-tasks.rst @@ -0,0 +1,38 @@ +**To monitor an export image task** + +The following ``describe-export-image-tasks`` example checks the status of the specified export image task. :: + + aws ec2 describe-export-image-tasks \ + --export-image-task-id export-ami-1234567890abcdef0 + +Output for an export image task that is in progress:: + + { + "ExportImageTasks": [ + { + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "Progress": "21", + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "active", + "StatusMessage": "updating" + } + ] + } + +Output for an export image task that is completed. The resulting image file in Amazon S3 is ``my-export-bucket/exports/export-ami-1234567890abcdef0.vmdk``. :: + + { + "ExportImageTasks": [ + { + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "completed" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-export-tasks.rst b/aws/dist/awscli/examples/ec2/describe-export-tasks.rst new file mode 100644 index 00000000..b61dcabe --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-export-tasks.rst @@ -0,0 +1,30 @@ +**To list details about an instance export task** + +This example describes the export task with ID export-i-fh8sjjsq. + +Command:: + + aws ec2 describe-export-tasks --export-task-ids export-i-fh8sjjsq + +Output:: + + { + "ExportTasks": [ + { + "State": "active", + "InstanceExportDetails": { + "InstanceId": "i-1234567890abcdef0", + "TargetEnvironment": "vmware" + }, + "ExportToS3Task": { + "S3Bucket": "myexportbucket", + "S3Key": "RHEL5export-i-fh8sjjsq.ova", + "DiskImageFormat": "vmdk", + "ContainerFormat": "ova" + }, + "Description": "RHEL5 instance", + "ExportTaskId": "export-i-fh8sjjsq" + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/describe-flow-logs.rst b/aws/dist/awscli/examples/ec2/describe-flow-logs.rst new file mode 100644 index 00000000..a467f5b1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-flow-logs.rst @@ -0,0 +1,42 @@ +**To describe all of your flow logs** + +The following ``describe-flow-logs`` example displays details for all of your flow logs. :: + + aws ec2 describe-flow-logs + +Output:: + + { + "FlowLogs": [ + { + "CreationTime": "2018-02-21T13:22:12.644Z", + "DeliverLogsPermissionArn": "arn:aws:iam::123456789012:role/flow-logs-role", + "DeliverLogsStatus": "SUCCESS", + "FlowLogId": "fl-aabbccdd112233445", + "FlowLogStatus": "ACTIVE", + "LogGroupName": "FlowLogGroup", + "ResourceId": "subnet-12345678901234567", + "TrafficType": "ALL", + "LogDestinationType": "cloud-watch-logs", + "LogFormat": "${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}" + }, + { + "CreationTime": "2019-07-19T15:22:29.986Z", + "DeliverLogsStatus": "SUCCESS", + "FlowLogId": "fl-01234567890123456", + "FlowLogStatus": "ACTIVE", + "ResourceId": "vpc-00112233445566778", + "TrafficType": "ACCEPT", + "LogDestinationType": "s3", + "LogDestination": "arn:aws:s3:::my-flow-log-bucket/custom", + "LogFormat": "${version} ${vpc-id} ${subnet-id} ${instance-id} ${interface-id} ${account-id} ${type} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${pkt-srcaddr} ${pkt-dstaddr} ${protocol} ${bytes} ${packets} ${start} ${end} ${action} ${tcp-flags} ${log-status}" + } + ] + } + +**To describe a subset of your flow logs** + +The following ``describe-flow-logs`` example uses a filter to display details for only those flow logs that are in the specified log group in Amazon CloudWatch Logs. :: + + aws ec2 describe-flow-logs \ + --filter "Name=log-group-name,Values=MyFlowLogs" diff --git a/aws/dist/awscli/examples/ec2/describe-fpga-image-attribute.rst b/aws/dist/awscli/examples/ec2/describe-fpga-image-attribute.rst new file mode 100644 index 00000000..34e9c4e6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-fpga-image-attribute.rst @@ -0,0 +1,20 @@ +**To describe the attributes of an Amazon FPGA image** + +This example describes the load permissions for the specified AFI. + +Command:: + + aws ec2 describe-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission + +Output:: + + { + "FpgaImageAttribute": { + "FpgaImageId": "afi-0d123e123bfc85abc", + "LoadPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ec2/describe-fpga-images.rst b/aws/dist/awscli/examples/ec2/describe-fpga-images.rst new file mode 100644 index 00000000..0731deb2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-fpga-images.rst @@ -0,0 +1,34 @@ +**To describe Amazon FPGA images** + +This example describes AFIs that are owned by account ``123456789012``. + +Command:: + + aws ec2 describe-fpga-images --filters Name=owner-id,Values=123456789012 + +Output:: + + { + "FpgaImages": [ + { + "UpdateTime": "2017-12-22T12:09:14.000Z", + "Name": "my-afi", + "PciId": { + "SubsystemVendorId": "0xfedd", + "VendorId": "0x1d0f", + "DeviceId": "0xf000", + "SubsystemId": "0x1d51" + }, + "FpgaImageGlobalId": "agfi-123cb27b5e84a0abc", + "Public": false, + "State": { + "Code": "available" + }, + "ShellVersion": "0x071417d3", + "OwnerId": "123456789012", + "FpgaImageId": "afi-0d123e123bfc85abc", + "CreateTime": "2017-12-22T11:43:33.000Z", + "Description": "my-afi" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-host-reservation-offerings.rst b/aws/dist/awscli/examples/ec2/describe-host-reservation-offerings.rst new file mode 100644 index 00000000..e9596adf --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-host-reservation-offerings.rst @@ -0,0 +1,62 @@ +**To describe Dedicated Host Reservation offerings** + +This example describes the Dedicated Host Reservations for the M4 instance family that are available to purchase. + +Command:: + + aws ec2 describe-host-reservation-offerings --filter Name=instance-family,Values=m4 + +Output:: + + { + "OfferingSet": [ + { + "HourlyPrice": "1.499", + "OfferingId": "hro-03f707bf363b6b324", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "UpfrontPrice": "0.000", + "Duration": 31536000 + }, + { + "HourlyPrice": "1.045", + "OfferingId": "hro-0ef9181cabdef7a02", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "UpfrontPrice": "0.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.714", + "OfferingId": "hro-04567a15500b92a51", + "InstanceFamily": "m4", + "PaymentOption": "PartialUpfront", + "UpfrontPrice": "6254.000", + "Duration": 31536000 + }, + { + "HourlyPrice": "0.484", + "OfferingId": "hro-0d5d7a9d23ed7fbfe", + "InstanceFamily": "m4", + "PaymentOption": "PartialUpfront", + "UpfrontPrice": "12720.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.000", + "OfferingId": "hro-05da4108ca998c2e5", + "InstanceFamily": "m4", + "PaymentOption": "AllUpfront", + "UpfrontPrice": "23913.000", + "Duration": 94608000 + }, + { + "HourlyPrice": "0.000", + "OfferingId": "hro-0a9f9be3b95a3dc8f", + "InstanceFamily": "m4", + "PaymentOption": "AllUpfront", + "UpfrontPrice": "12257.000", + "Duration": 31536000 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-host-reservations.rst b/aws/dist/awscli/examples/ec2/describe-host-reservations.rst new file mode 100644 index 00000000..e22f3189 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-host-reservations.rst @@ -0,0 +1,30 @@ +**To describe Dedicated Host Reservations in your account** + +This example describes the Dedicated Host Reservations in your account. + +Command:: + + aws ec2 describe-host-reservations + +Output:: + + { + "HostReservationSet": [ + { + "Count": 1, + "End": "2019-01-10T12:14:09Z", + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "OfferingId": "hro-03f707bf363b6b324", + "PaymentOption": "NoUpfront", + "State": "active", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "Start": "2018-01-10T12:14:09Z", + "HostReservationId": "hr-0d418a3a4ffc669ae", + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-hosts.rst b/aws/dist/awscli/examples/ec2/describe-hosts.rst new file mode 100644 index 00000000..f4d19f40 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-hosts.rst @@ -0,0 +1,45 @@ +**To view details about Dedicated Hosts** + +The following ``describe-hosts`` example displays details for the ``available`` Dedicated Hosts in your AWS account. :: + + aws ec2 describe-hosts --filter "Name=state,Values=available" + +Output:: + + { + "Hosts": [ + { + "HostId": "h-07879acf49EXAMPLE", + "Tags": [ + { + "Value": "production", + "Key": "purpose" + } + ], + "HostProperties": { + "Cores": 48, + "TotalVCpus": 96, + "InstanceType": "m5.large", + "Sockets": 2 + }, + "Instances": [], + "State": "available", + "AvailabilityZone": "eu-west-1a", + "AvailableCapacity": { + "AvailableInstanceCapacity": [ + { + "AvailableCapacity": 48, + "InstanceType": "m5.large", + "TotalCapacity": 48 + } + ], + "AvailableVCpus": 96 + }, + "HostRecovery": "on", + "AllocationTime": "2019-08-19T08:57:44.000Z", + "AutoPlacement": "off" + } + ] + } + +For more information, see `Viewing Dedicated Hosts `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/describe-iam-instance-profile-associations.rst b/aws/dist/awscli/examples/ec2/describe-iam-instance-profile-associations.rst new file mode 100644 index 00000000..7ca8dd65 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-iam-instance-profile-associations.rst @@ -0,0 +1,32 @@ +**To describe IAM instance profile associations** + +This example describes all of your IAM instance profile associations. + +Command:: + + aws ec2 describe-iam-instance-profile-associations + +Output:: + + { + "IamInstanceProfileAssociations": [ + { + "InstanceId": "i-09eb09efa73ec1dee", + "State": "associated", + "AssociationId": "iip-assoc-0db249b1f25fa24b8", + "IamInstanceProfile": { + "Id": "AIPAJVQN4F5WVLGCJDRGM", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + }, + { + "InstanceId": "i-0402909a2f4dffd14", + "State": "associating", + "AssociationId": "iip-assoc-0d1ec06278d29f44a", + "IamInstanceProfile": { + "Id": "AGJAJVQN4F5WVLGCJABCM", + "Arn": "arn:aws:iam::123456789012:instance-profile/user1-role" + } + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-id-format.rst b/aws/dist/awscli/examples/ec2/describe-id-format.rst new file mode 100755 index 00000000..31ac007d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-id-format.rst @@ -0,0 +1,24 @@ +**Example 1: To describe the ID format of a resource** + +The following ``describe-id-format`` example describes the ID format for security groups. :: + + aws ec2 describe-id-format \ + --resource security-group + +In the following example output, the ``Deadline`` value indicates that the deadline for this resource type to permanently switch from the short ID format to the long ID format expired at 00:00 UTC on August 15, 2018. :: + + { + "Statuses": [ + { + "Deadline": "2018-08-15T00:00:00.000Z", + "Resource": "security-group", + "UseLongIds": true + } + ] + } + +**Example 2: To describe the ID format for all resources** + +The following ``describe-id-format`` example describes the ID format for all resource types. All resource types that supported the short ID format were switched to use the long ID format. :: + + aws ec2 describe-id-format diff --git a/aws/dist/awscli/examples/ec2/describe-identity-id-format.rst b/aws/dist/awscli/examples/ec2/describe-identity-id-format.rst new file mode 100755 index 00000000..d287dfd4 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-identity-id-format.rst @@ -0,0 +1,39 @@ +**To describe the ID format for an IAM role** + +The following ``describe-identity-id-format`` example describes the ID format received by instances created by the IAM role ``EC2Role`` in your AWS account. :: + + aws ec2 describe-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:role/my-iam-role \ + --resource instance + +The following output indicates that instances created by this role receive IDs in long ID format. :: + + { + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00Z", + "Resource": "instance", + "UseLongIds": true + } + ] + } + +**To describe the ID format for an IAM user** + +The following ``describe-identity-id-format`` example describes the ID format received by snapshots created by the IAM user ``AdminUser`` in your AWS account. :: + + aws ec2 describe-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource snapshot + +The output indicates that snapshots created by this user receive IDs in long ID format. :: + + { + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00Z", + "Resource": "snapshot", + "UseLongIds": true + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-image-attribute.rst b/aws/dist/awscli/examples/ec2/describe-image-attribute.rst new file mode 100644 index 00000000..15db2493 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-image-attribute.rst @@ -0,0 +1,33 @@ +**To describe the launch permissions for an AMI** + +This example describes the launch permissions for the specified AMI. + +Command:: + + aws ec2 describe-image-attribute --image-id ami-5731123e --attribute launchPermission + +Output:: + + { + "LaunchPermissions": [ + { + "UserId": "123456789012" + } + ], + "ImageId": "ami-5731123e", + } + +**To describe the product codes for an AMI** + +This example describes the product codes for the specified AMI. Note that this AMI has no product codes. + +Command:: + + aws ec2 describe-image-attribute --image-id ami-5731123e --attribute productCodes + +Output:: + + { + "ProductCodes": [], + "ImageId": "ami-5731123e", + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-images.rst b/aws/dist/awscli/examples/ec2/describe-images.rst new file mode 100644 index 00000000..dccac239 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-images.rst @@ -0,0 +1,68 @@ +**To describe a specific AMI** + +This example describes the specified AMI. + +Command:: + + aws ec2 describe-images --image-ids ami-5731123e + +Output:: + + { + "Images": [ + { + "VirtualizationType": "paravirtual", + "Name": "My server", + "Hypervisor": "xen", + "ImageId": "ami-5731123e", + "RootDeviceType": "ebs", + "State": "available", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "Architecture": "x86_64", + "ImageLocation": "123456789012/My server", + "KernelId": "aki-88aa75e1", + "OwnerId": "123456789012", + "RootDeviceName": "/dev/sda1", + "Public": false, + "ImageType": "machine", + "Description": "An AMI for my server" + } + ] + } + +**To describe Windows AMIs from Amazon that are backed by Amazon EBS** + +This example describes Windows AMIs provided by Amazon that are backed by Amazon EBS. + +Command:: + + aws ec2 describe-images --owners amazon --filters "Name=platform,Values=windows" "Name=root-device-type,Values=ebs" + +**To describe tagged AMIs** + +This example describes all AMIs that have the tag ``Custom=Linux1``. The output is filtered to display only the AMI IDs. + +Command:: + + aws ec2 describe-images --filters "Name=tag:Custom,Values=Linux1" --query 'Images[*].{ID:ImageId}' + +Output:: + + [ + { + "ID": "ami-1a2b3c4d" + }, + { + "ID": "ami-ab12cd34" + } + ] diff --git a/aws/dist/awscli/examples/ec2/describe-import-image-tasks.rst b/aws/dist/awscli/examples/ec2/describe-import-image-tasks.rst new file mode 100755 index 00000000..e9bc4848 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-import-image-tasks.rst @@ -0,0 +1,54 @@ +**To monitor an import image task** + +The following ``describe-import-image-tasks`` example checks the status of the specified import image task. :: + + aws ec2 describe-import-image-tasks \ + --import-task-ids import-ami-1234567890abcdef0 + +Output for an import image task that is in progress. :: + + { + "ImportImageTasks": [ + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "Progress": "28", + "SnapshotDetails": [ + { + "DiskImageSize": 705638400.0, + "Format": "ova", + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "active", + "StatusMessage": "converting" + } + ] + } + +Output for an import image task that is completed. The ID of the resulting AMI is provided by ``ImageId``. :: + + { + "ImportImageTasks": [ + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "ImageId": "ami-1234567890abcdef0", + "SnapshotDetails": [ + { + "DiskImageSize": 705638400.0, + "Format": "ova", + "SnapshotId": "snap-1234567890abcdef0" + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "completed" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-import-snapshot-tasks.rst b/aws/dist/awscli/examples/ec2/describe-import-snapshot-tasks.rst new file mode 100755 index 00000000..91dc1169 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-import-snapshot-tasks.rst @@ -0,0 +1,51 @@ +**To monitor an import snapshot task** + +The following ``describe-import-snapshot-tasks`` example checks the status of the specified import snapshot task. :: + + aws ec2 describe-import-snapshot-tasks \ + --import-task-ids import-snap-1234567890abcdef0 + +Output for an import snapshot task that is in progress:: + + { + "ImportSnapshotTasks": [ + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "705638400.0", + "Format": "VMDK", + "Progress": "42", + "Status": "active", + "StatusMessage": "downloading/converting", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } + ] + } + +Output for an import snapshot task that is completed. The ID of the resulting snapshot is provided by ``SnapshotId``. :: + + { + "ImportSnapshotTasks": [ + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "705638400.0", + "Format": "VMDK", + "SnapshotId": "snap-1234567890abcdef0" + "Status": "completed", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-instance-attribute.rst b/aws/dist/awscli/examples/ec2/describe-instance-attribute.rst new file mode 100644 index 00000000..c4d5b11c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-instance-attribute.rst @@ -0,0 +1,67 @@ +**To describe the instance type** + +This example describes the instance type of the specified instance. + +Command:: + + aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute instanceType + +Output:: + + { + "InstanceId": "i-1234567890abcdef0" + "InstanceType": { + "Value": "t1.micro" + } + } + +**To describe the disableApiTermination attribute** + +This example describes the ``disableApiTermination`` attribute of the specified instance. + +Command:: + + aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute disableApiTermination + +Output:: + + { + "InstanceId": "i-1234567890abcdef0" + "DisableApiTermination": { + "Value": "false" + } + } + +**To describe the block device mapping for an instance** + +This example describes the ``blockDeviceMapping`` attribute of the specified instance. + +Command:: + + aws ec2 describe-instance-attribute --instance-id i-1234567890abcdef0 --attribute blockDeviceMapping + +Output:: + + { + "InstanceId": "i-1234567890abcdef0" + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "Status": "attached", + "DeleteOnTermination": true, + "VolumeId": "vol-049df61146c4d7901", + "AttachTime": "2013-05-17T22:42:34.000Z" + } + }, + { + "DeviceName": "/dev/sdf", + "Ebs": { + "Status": "attached", + "DeleteOnTermination": false, + "VolumeId": "vol-049df61146c4d7901", + "AttachTime": "2013-09-10T23:07:00.000Z" + } + } + ], + } diff --git a/aws/dist/awscli/examples/ec2/describe-instance-credit-specifications.rst b/aws/dist/awscli/examples/ec2/describe-instance-credit-specifications.rst new file mode 100644 index 00000000..0178aef9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-instance-credit-specifications.rst @@ -0,0 +1,18 @@ +**To describe the credit option for CPU usage of one or more instances** + +This example describes the current credit option for CPU usage of the specified instance. + +Command:: + + aws ec2 describe-instance-credit-specifications --instance-id i-1234567890abcdef0 + +Output:: + + { + "InstanceCreditSpecifications": [ + { + "InstanceId": "i-1234567890abcdef0", + "CpuCredits": "unlimited" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-instance-status.rst b/aws/dist/awscli/examples/ec2/describe-instance-status.rst new file mode 100644 index 00000000..37f08dd1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-instance-status.rst @@ -0,0 +1,40 @@ +**To describe the status of an instance** + +This example describes the current status of the specified instance. + +Command:: + + aws ec2 describe-instance-status --instance-id i-1234567890abcdef0 + +Output:: + + { + "InstanceStatuses": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceState": { + "Code": 16, + "Name": "running" + }, + "AvailabilityZone": "us-east-1d", + "SystemStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + }, + "InstanceStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "reachability" + } + ] + } + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-instances.rst b/aws/dist/awscli/examples/ec2/describe-instances.rst new file mode 100755 index 00000000..c20169eb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-instances.rst @@ -0,0 +1,165 @@ +**Example 1: To describe an Amazon EC2 instance** + +The following ``describe-instances`` example displays details about the specified instance. :: + + aws ec2 describe-instances \ + --instance-ids i-1234567890abcdef0 + +**Example 2: To describe instances based on instance type** + +The following ``describe-instances`` example displays details about only instances of the specified type. :: + + aws ec2 describe-instances \ + --filters Name=instance-type,Values=m5.large + +**Example 3: To describe instances based on a tag key and value** + +The following ``describe-instances`` example displays details about only those instances that have a tag with the specified key name and value. :: + + aws ec2 describe-instances \ + --filters "Name=tag-key,Values=Owner" + +**Example 4: To filter the results based on multiple conditions** + +The following ``describe-instances`` example displays details about all instances with the specified type that are also in the specified Availability Zone. :: + + aws ec2 describe-instances \ + --filters Name=instance-type,Values=t2.micro,t3.micro Name=availability-zone,Values=us-east-2c + +The following ``describe-instances`` example uses a JSON input file to perform the same filtering as the previous example. When filters get more complicated, they can be easier to specify in a JSON file. :: + + aws ec2 describe-instances \ + --filters file://filters.json + +Contents of ``filters.json``:: + + [ + { + "Name": "instance-type", + "Values": ["t2.micro", "t3.micro"] + }, + { + "Name": "availability-zone", + "Values": ["us-east-2c"] + } + ] + +**Example 5: To restrict the results to only specified fields** + +The following ``describe-instances`` example uses the ``--query`` parameter to display only the AMI ID and tags for the specified instance. :: + + aws ec2 describe-instances \ + --instance-id i-1234567890abcdef0 \ + --query "Reservations[*].Instances[*].[ImageId,Tags[*]]" + +The following ``describe-instances`` example uses the ``--query`` parameter to display only the instance and subnet IDs for all instances. + +Linux Command:: + + aws ec2 describe-instances \ + --query 'Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}' \ + --output json + +Windows Command:: + + aws ec2 describe-instances ^ + --query "Reservations[*].Instances[*].{Instance:InstanceId,Subnet:SubnetId}" ^ + --output json + +Output:: + + [ + { + "Instance": "i-057750d42936e468a", + "Subnet": "subnet-069beee9b12030077" + }, + { + "Instance": "i-001efd250faaa6ffa", + "Subnet": "subnet-0b715c6b7db68927a" + }, + { + "Instance": "i-027552a73f021f3bd", + "Subnet": "subnet-0250c25a1f4e15235" + } + ] + +**Example 6: To describe instances with a specific tag and filter the results to specific fields** + +The following ``describe-instances`` example displays the instance ID, Availability Zone, and the value of the ``Name`` tag for instances that have a tag with the name ``tag-key``. + +Linux Command:: + + aws ec2 describe-instances \ + --filter Name=tag-key,Values=Name \ + --query 'Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key==`Name`]|[0].Value}' \ + --output table + +Windows Command:: + + aws ec2 describe-instances ^ + --filter Name=tag-key,Values=Name ^ + --query "Reservations[*].Instances[*].{Instance:InstanceId,AZ:Placement.AvailabilityZone,Name:Tags[?Key==`Name`]|[0].Value}" ^ + --output table + +Output:: + + ------------------------------------------------------------- + | DescribeInstances | + +--------------+-----------------------+--------------------+ + | AZ | Instance | Name | + +--------------+-----------------------+--------------------+ + | us-east-2b | i-057750d42936e468a | my-prod-server | + | us-east-2a | i-001efd250faaa6ffa | test-server-1 | + | us-east-2a | i-027552a73f021f3bd | test-server-2 | + +--------------+-----------------------+--------------------+ + +**Example 7: To view the partition number for an instance in a partition placement group** + +The following ``describe-instances`` example displays details about the specified instance. The output includes the placement information for the instance, which contains the placement group name and the partition number for the instance. :: + + aws ec2 describe-instances \ + --instance-id i-0123a456700123456 + +The following output is truncated to show only the relevant information:: + + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 3, + "Tenancy": "default" + } + +For more information, see `Describing Instances in a Placement Group `__ in the *Amazon Elastic Compute Cloud Users Guide*. + +**Example 8: To filter instances for a specific partition placement group and partition number** + +The following ``describe-instances`` example filters the results to only those instances with the specified placement group and partition number. :: + + aws ec2 describe-instances \ + --filters "Name = placement-group-name, Values = HDFS-Group-A" "Name = placement-partition-number, Values = 7" + +The following output is truncated to show only the relevant pieces:: + + "Instances": [ + { + "InstanceId": "i-0123a456700123456", + "InstanceType": "r4.large", + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 7, + "Tenancy": "default" + } + }, + { + "InstanceId": "i-9876a543210987654", + "InstanceType": "r4.large", + "Placement": { + "AvailabilityZone": "us-east-1c", + "GroupName": "HDFS-Group-A", + "PartitionNumber": 7, + "Tenancy": "default" + } + ], + +For more information, see `Describing Instances in a Placement Group `__ in the *Amazon Elastic Compute Cloud Users Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-internet-gateways.rst b/aws/dist/awscli/examples/ec2/describe-internet-gateways.rst new file mode 100644 index 00000000..cce89cf9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-internet-gateways.rst @@ -0,0 +1,31 @@ +**To describe your internet gateways** + +The following ``describe-internet-gateways`` example retrieves details about all of your internet gateways. :: + + aws ec2 describe-internet-gateways + +Output:: + + { + "InternetGateways": [ + { + "Attachments": [], + "InternetGatewayId": "igw-036dde5c85EXAMPLE", + "OwnerId": "111122223333", + "Tags": [] + }, + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-cEXAMPLE" + } + ], + "InternetGatewayId": "igw-0EXAMPLE", + "OwnerId": "111122223333", + "Tags": [] + } + ] + } + +For more information, see `Internet Gateways `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-key-pairs.rst b/aws/dist/awscli/examples/ec2/describe-key-pairs.rst new file mode 100644 index 00000000..850a5f46 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-key-pairs.rst @@ -0,0 +1,23 @@ +**To display a key pair** + +This example displays the fingerprint for the key pair named ``MyKeyPair``. + +Command:: + + aws ec2 describe-key-pairs --key-name MyKeyPair + +Output:: + + { + "KeyPairs": [ + { + "KeyName": "MyKeyPair", + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f" + } + ] + } + +For more information, see `Using Key Pairs`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Key Pairs`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-keypairs.html + diff --git a/aws/dist/awscli/examples/ec2/describe-launch-template-versions.rst b/aws/dist/awscli/examples/ec2/describe-launch-template-versions.rst new file mode 100644 index 00000000..1874a860 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-launch-template-versions.rst @@ -0,0 +1,83 @@ +**To describe launch template versions** + +This example describes the versions of the specified launch template. + +Command:: + + aws ec2 describe-launch-template-versions --launch-template-id lt-068f72b72934aff71 + +Output:: + + { + "LaunchTemplateVersions": [ + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 3, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.small", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:19:54.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "KeyName": "kp-us-east", + "ImageId": "ami-6057e21a", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-1a2b3c4d", + "DeviceIndex": 0, + "Groups": [ + "sg-7c227019" + ] + } + ] + }, + "DefaultVersion": false, + "CreateTime": "2017-11-20T13:12:32.000Z" + }, + { + "LaunchTemplateId": "lt-068f72b72934aff71", + "LaunchTemplateName": "Webservers", + "VersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789102:root", + "LaunchTemplateData": { + "UserData": "", + "KeyName": "kp-us-east", + "ImageId": "ami-aabbcc11", + "InstanceType": "t2.medium", + "NetworkInterfaces": [ + { + "SubnetId": "subnet-7b16de0c", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "Groups": [ + "sg-7c227019" + ], + "AssociatePublicIpAddress": true + } + ] + }, + "DefaultVersion": true, + "CreateTime": "2017-11-20T12:52:33.000Z" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-launch-templates.rst b/aws/dist/awscli/examples/ec2/describe-launch-templates.rst new file mode 100644 index 00000000..c9d536a8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-launch-templates.rst @@ -0,0 +1,46 @@ +**To describe launch templates** + +This example describes your launch templates. + +Command:: + + aws ec2 describe-launch-templates + +Output:: + + { + "LaunchTemplates": [ + { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0e06d290751193123", + "LaunchTemplateName": "TemplateForWebServer", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-27T09:30:23.000Z" + }, + { + "LatestVersionNumber": 6, + "LaunchTemplateId": "lt-0c45b5e061ec98456", + "LaunchTemplateName": "DBServersTemplate", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-20T09:25:22.000Z" + }, + { + "LatestVersionNumber": 1, + "LaunchTemplateId": "lt-0d47d774e8e52dabc", + "LaunchTemplateName": "MyLaunchTemplate2", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-11-02T12:06:21.000Z" + }, + { + "LatestVersionNumber": 3, + "LaunchTemplateId": "lt-01e5f948eb4f589d6", + "LaunchTemplateName": "testingtemplate2", + "DefaultVersionNumber": 1, + "CreatedBy": "arn:aws:sts::123456789012:assumed-role/AdminRole/i-03ee35176e2e5aabc", + "CreateTime": "2017-12-01T08:19:48.000Z" + }, + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-moving-addresses.rst b/aws/dist/awscli/examples/ec2/describe-moving-addresses.rst new file mode 100644 index 00000000..43528dae --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-moving-addresses.rst @@ -0,0 +1,24 @@ +**To describe your moving addresses** + +This example describes all of your moving Elastic IP addresses. + +Command:: + + aws ec2 describe-moving-addresses + +Output:: + + { + "MovingAddressStatuses": [ + { + "PublicIp": "198.51.100.0", + "MoveStatus": "MovingToVpc" + } + ] + } + +This example describes all addresses that are moving to the EC2-VPC platform. + +Command:: + + aws ec2 describe-moving-addresses --filters Name=moving-status,Values=MovingToVpc \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-nat-gateways.rst b/aws/dist/awscli/examples/ec2/describe-nat-gateways.rst new file mode 100644 index 00000000..6deddf9e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-nat-gateways.rst @@ -0,0 +1,56 @@ +**To describe your NAT gateways** + +This example describes all of your NAT gateways. + +Command:: + + aws ec2 describe-nat-gateways + +Output:: + + { + "NatGateways": [ + { + "NatGatewayAddresses": [ + { + "PublicIp": "198.11.222.333", + "NetworkInterfaceId": "eni-9dec76cd", + "AllocationId": "eipalloc-89c620ec", + "PrivateIp": "10.0.0.149" + } + ], + "VpcId": "vpc-1a2b3c4d", + "Tags": [ + { + "Value": "IT", + "Key": "Department" + } + ], + "State": "available", + "NatGatewayId": "nat-05dba92075d71c408", + "SubnetId": "subnet-847e4dc2", + "CreateTime": "2015-12-01T12:26:55.983Z" + }, + { + "NatGatewayAddresses": [ + { + "PublicIp": "1.2.3.12", + "NetworkInterfaceId": "eni-71ec7621", + "AllocationId": "eipalloc-5d42583f", + "PrivateIp": "10.0.0.77" + } + ], + "VpcId": "vpc-11aa22bb", + "Tags": [ + { + "Value": "Finance", + "Key": "Department" + } + ], + "State": "available", + "NatGatewayId": "nat-0a93acc57881d4199", + "SubnetId": "subnet-7f7e4d39", + "CreateTime": "2015-12-01T12:09:22.040Z" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-network-acls.rst b/aws/dist/awscli/examples/ec2/describe-network-acls.rst new file mode 100644 index 00000000..1d314009 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-network-acls.rst @@ -0,0 +1,125 @@ +**To describe your network ACLs** + +The following ``describe-network-acls`` example retrieves details about your network ACLs. :: + + aws ec2 describe-network-acls + +Output:: + + { + "NetworkAcls": [ + { + "Associations": [ + { + "NetworkAclAssociationId": "aclassoc-0c1679dc41EXAMPLE", + "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", + "SubnetId": "subnet-0931fc2fa5EXAMPLE" + } + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": true, + "NetworkAclId": "acl-0ea1f54ca7EXAMPLE", + "Tags": [], + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "Egress": true, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 101 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "Egress": true, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32768 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 100 + }, + { + "Egress": false, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "allow", + "RuleNumber": 101 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "Egress": false, + "Ipv6CidrBlock": "::/0", + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32768 + } + ], + "IsDefault": true, + "NetworkAclId": "acl-0e2a78e4e2EXAMPLE", + "Tags": [], + "VpcId": "vpc-03914afb3eEXAMPLE", + "OwnerId": "111122223333" + } + ] + } + + +For more information, see `Network ACLs `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-network-interface-attribute.rst b/aws/dist/awscli/examples/ec2/describe-network-interface-attribute.rst new file mode 100644 index 00000000..a5e23f69 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-network-interface-attribute.rst @@ -0,0 +1,76 @@ +**To describe the attachment attribute of a network interface** + +This example command describes the ``attachment`` attribute of the specified network interface. + +Command:: + + aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute attachment + +Output:: + + { + "NetworkInterfaceId": "eni-686ea200", + "Attachment": { + "Status": "attached", + "DeviceIndex": 0, + "AttachTime": "2015-05-21T20:02:20.000Z", + "InstanceId": "i-1234567890abcdef0", + "DeleteOnTermination": true, + "AttachmentId": "eni-attach-43348162", + "InstanceOwnerId": "123456789012" + } + } + +**To describe the description attribute of a network interface** + +This example command describes the ``description`` attribute of the specified network interface. + +Command:: + + aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute description + +Output:: + + { + "NetworkInterfaceId": "eni-686ea200", + "Description": { + "Value": "My description" + } + } + +**To describe the groupSet attribute of a network interface** + +This example command describes the ``groupSet`` attribute of the specified network interface. + +Command:: + + aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute groupSet + +Output:: + + { + "NetworkInterfaceId": "eni-686ea200", + "Groups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-903004f8" + } + ] + } + +**To describe the sourceDestCheck attribute of a network interface** + +This example command describes the ``sourceDestCheck`` attribute of the specified network interface. + +Command:: + + aws ec2 describe-network-interface-attribute --network-interface-id eni-686ea200 --attribute sourceDestCheck + +Output:: + + { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": true + } + } diff --git a/aws/dist/awscli/examples/ec2/describe-network-interface-permissions.rst b/aws/dist/awscli/examples/ec2/describe-network-interface-permissions.rst new file mode 100644 index 00000000..f11fb7b8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-network-interface-permissions.rst @@ -0,0 +1,23 @@ +**To describe your network interface permissions** + +This example describes all of your network interface permissions. + +Command:: + + aws ec2 describe-network-interface-permissions + +Output:: + + { + "NetworkInterfacePermissions": [ + { + "PermissionState": { + "State": "GRANTED" + }, + "NetworkInterfacePermissionId": "eni-perm-06fd19020ede149ea", + "NetworkInterfaceId": "eni-b909511a", + "Permission": "INSTANCE-ATTACH", + "AwsAccountId": "123456789012" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-network-interfaces.rst b/aws/dist/awscli/examples/ec2/describe-network-interfaces.rst new file mode 100644 index 00000000..e4975c10 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-network-interfaces.rst @@ -0,0 +1,161 @@ +**To describe your network interfaces** + +This example describes all your network interfaces. + +Command:: + + aws ec2 describe-network-interfaces + +Output:: + + { + "NetworkInterfaces": [ + { + "Status": "in-use", + "MacAddress": "02:2f:8f:b0:cf:75", + "SourceDestCheck": true, + "VpcId": "vpc-a01106c2", + "Description": "my network interface", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "Association": { + "PublicIp": "203.0.113.12", + "AssociationId": "eipassoc-0fbb766a", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "IpOwnerId": "123456789012" + }, + "Primary": true, + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "Ipv6Addresses": [], + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "AvailabilityZone": "us-east-1d", + "Attachment": { + "Status": "attached", + "DeviceIndex": 1, + "AttachTime": "2013-11-30T23:36:42.000Z", + "InstanceId": "i-1234567890abcdef0", + "DeleteOnTermination": false, + "AttachmentId": "eni-attach-66c4350a", + "InstanceOwnerId": "123456789012" + }, + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-8637d3e3" + } + ], + "SubnetId": "subnet-b61f49f0", + "OwnerId": "123456789012", + "TagSet": [], + "PrivateIpAddress": "10.0.1.17" + }, + { + "Status": "in-use", + "MacAddress": "02:58:f5:ef:4b:06", + "SourceDestCheck": true, + "VpcId": "vpc-a01106c2", + "Description": "Primary network interface", + "Association": { + "PublicIp": "198.51.100.0", + "IpOwnerId": "amazon" + }, + "NetworkInterfaceId": "eni-f9ba99bf", + "PrivateIpAddresses": [ + { + "Association": { + "PublicIp": "198.51.100.0", + "IpOwnerId": "amazon" + }, + "Primary": true, + "PrivateIpAddress": "10.0.1.149" + } + ], + "RequesterManaged": false, + "Ipv6Addresses": [], + "AvailabilityZone": "us-east-1d", + "Attachment": { + "Status": "attached", + "DeviceIndex": 0, + "AttachTime": "2013-11-30T23:35:33.000Z", + "InstanceId": "i-0598c7d356eba48d7", + "DeleteOnTermination": true, + "AttachmentId": "eni-attach-1b9db777", + "InstanceOwnerId": "123456789012" + }, + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-8637d3e3" + } + ], + "SubnetId": "subnet-b61f49f0", + "OwnerId": "123456789012", + "TagSet": [], + "PrivateIpAddress": "10.0.1.149" + } + ] + } + + +This example describes network interfaces that have a tag with the key ``Purpose`` and the value ``Prod``. + +Command:: + + aws ec2 describe-network-interfaces --filters Name=tag:Purpose,Values=Prod + +Output:: + + { + "NetworkInterfaces": [ + { + "Status": "available", + "MacAddress": "12:2c:bd:f9:bf:17", + "SourceDestCheck": true, + "VpcId": "vpc-8941ebec", + "Description": "ProdENI", + "NetworkInterfaceId": "eni-b9a5ac93", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-1-55.ec2.internal", + "Primary": true, + "PrivateIpAddress": "10.0.1.55" + }, + { + "PrivateDnsName": "ip-10-0-1-117.ec2.internal", + "Primary": false, + "PrivateIpAddress": "10.0.1.117" + } + ], + "RequesterManaged": false, + "PrivateDnsName": "ip-10-0-1-55.ec2.internal", + "AvailabilityZone": "us-east-1d", + "Ipv6Addresses": [], + "Groups": [ + { + "GroupName": "MySG", + "GroupId": "sg-905002f5" + } + ], + "SubnetId": "subnet-31d6c219", + "OwnerId": "123456789012", + "TagSet": [ + { + "Value": "Prod", + "Key": "Purpose" + } + ], + "PrivateIpAddress": "10.0.1.55" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-placement-groups.rst b/aws/dist/awscli/examples/ec2/describe-placement-groups.rst new file mode 100644 index 00000000..2cdbd4e0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-placement-groups.rst @@ -0,0 +1,20 @@ +**To describe your placement groups** + +This example command describes all of your placement groups. + +Command:: + + aws ec2 describe-placement-groups + +Output:: + + { + "PlacementGroups": [ + { + "GroupName": "my-cluster", + "State": "available", + "Strategy": "cluster" + }, + ... + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-prefix-lists.rst b/aws/dist/awscli/examples/ec2/describe-prefix-lists.rst new file mode 100644 index 00000000..d4ad49eb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-prefix-lists.rst @@ -0,0 +1,21 @@ +**To describe prefix lists** + +This example lists all available prefix lists for the region. + +Command:: + + aws ec2 describe-prefix-lists + +Output:: + + { + "PrefixLists": [ + { + "PrefixListName": "com.amazonaws.us-east-1.s3", + "Cidrs": [ + "54.231.0.0/17" + ], + "PrefixListId": "pl-63a5400a" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-principal-id-format.rst b/aws/dist/awscli/examples/ec2/describe-principal-id-format.rst new file mode 100755 index 00000000..a24cea09 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-principal-id-format.rst @@ -0,0 +1,34 @@ +**To describe the ID format for IAM users and roles with long ID format enabled** + +The following ``describe-principal-id-format`` example describes the ID format for the root user, all IAM roles, and all IAM users with long ID format enabled. :: + + aws ec2 describe-principal-id-format \ + --resource instance + +Output:: + + { + "Principals": [ + { + "Arn": "arn:aws:iam::123456789012:root", + "Statuses": [ + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "reservation", + "UseLongIds": true + }, + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "instance", + "UseLongIds": true + }, + { + "Deadline": "2016-12-15T00:00:00.000Z", + "Resource": "volume", + "UseLongIds": true + }, + ] + }, + ... + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-public-ipv4-pools.rst b/aws/dist/awscli/examples/ec2/describe-public-ipv4-pools.rst new file mode 100644 index 00000000..6d926eba --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-public-ipv4-pools.rst @@ -0,0 +1,25 @@ +**To describe your public IPv4 address pools** + +The following ``describe-public-ipv4-pools`` example displays details about the address pools that were created when you provisioned public IPv4 address ranges using Bring Your Own IP Addresses (BYOIP). :: + + aws ec2 describe-public-ipv4-pools + +Output:: + + { + "PublicIpv4Pools": [ + { + "PoolId": "ipv4pool-ec2-1234567890abcdef0", + "PoolAddressRanges": [ + { + "FirstAddress": "203.0.113.0", + "LastAddress": "203.0.113.255", + "AddressCount": 256, + "AvailableAddressCount": 256 + } + ], + "TotalAddressCount": 256, + "TotalAvailableAddressCount": 256 + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-regions.rst b/aws/dist/awscli/examples/ec2/describe-regions.rst new file mode 100755 index 00000000..77c0081f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-regions.rst @@ -0,0 +1,266 @@ +**Example 1: To describe all of your enabled Regions** + +The following ``describe-regions`` example describes all of the Regions that are enabled for your account. :: + + aws ec2 describe-regions + +Output:: + + { + "Regions": [ + { + "Endpoint": "ec2.eu-north-1.amazonaws.com", + "RegionName": "eu-north-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-3.amazonaws.com", + "RegionName": "eu-west-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-2.amazonaws.com", + "RegionName": "eu-west-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-3.amazonaws.com", + "RegionName": "ap-northeast-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ca-central-1.amazonaws.com", + "RegionName": "ca-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2", + "OptInStatus": "opt-in-not-required" + } + ] + } + +**Example 2: To describe enabled Regions with an endpoint whose name contains a specific string** + +The following ``describe-regions`` example describes all Regions that you have enabled that have the string "us" in the endpoint. :: + + aws ec2 describe-regions --filters "Name=endpoint,Values=*us*" + +Output:: + + { + "Regions": [ + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + }, + ] + } + +**To describe all Regions** + +The following ``describe-regions`` example describes all available Regions, including opt-in Regions like HKG and BAH. For a description of opt-in Regions, see `Available Regions `__ in the *Amazon EC2 User Guide*. :: + + aws ec2 describe-regions \ + --all-regions + +Output:: + + { + "Regions": [ + { + "Endpoint": "ec2.eu-north-1.amazonaws.com", + "RegionName": "eu-north-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-3.amazonaws.com", + "RegionName": "eu-west-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-2.amazonaws.com", + "RegionName": "eu-west-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-3.amazonaws.com", + "RegionName": "ap-northeast-3", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.me-south-1.amazonaws.com", + "RegionName": "me-south-1", + "OptInStatus": "not-opted-in" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ca-central-1.amazonaws.com", + "RegionName": "ca-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-east-1.amazonaws.com", + "RegionName": "ap-east-1", + "OptInStatus": "not-opted-in" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-east-2.amazonaws.com", + "RegionName": "us-east-2", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1", + "OptInStatus": "opt-in-not-required" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2", + "OptInStatus": "opt-in-not-required" + } + ] + } + +**To list the Region names only** + +The following ``describe-regions`` example uses the ``--query`` parameter to filter the output and return only the names of the Regions as text. :: + + aws ec2 describe-regions \ + --all-regions \ + --query "Regions[].{Name:RegionName}" \ + --output text + +Output:: + + eu-north-1 + ap-south-1 + eu-west-3 + eu-west-2 + eu-west-1 + ap-northeast-3 + ap-northeast-2 + me-south-1 + ap-northeast-1 + sa-east-1 + ca-central-1 + ap-east-1 + ap-southeast-1 + ap-southeast-2 + eu-central-1 + us-east-1 + us-east-2 + us-west-1 + us-west-2 diff --git a/aws/dist/awscli/examples/ec2/describe-reserved-instances-modifications.rst b/aws/dist/awscli/examples/ec2/describe-reserved-instances-modifications.rst new file mode 100644 index 00000000..37e888de --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-reserved-instances-modifications.rst @@ -0,0 +1,47 @@ +**To describe Reserved Instances modifications** + +This example command describes all the Reserved Instances modification requests that have been submitted for your account. + +Command:: + + aws ec2 describe-reserved-instances-modifications + +Output:: + + { + "ReservedInstancesModifications": [ + { + "Status": "fulfilled", + "ModificationResults": [ + { + "ReservedInstancesId": "93bbbca2-62f1-4d9d-b225-16bada29e6c7", + "TargetConfiguration": { + "AvailabilityZone": "us-east-1b", + "InstanceType": "m1.large", + "InstanceCount": 3 + } + }, + { + "ReservedInstancesId": "1ba8e2e3-aabb-46c3-bcf5-3fe2fda922e6", + "TargetConfiguration": { + "AvailabilityZone": "us-east-1d", + "InstanceType": "m1.xlarge", + "InstanceCount": 1 + } + } + ], + "EffectiveDate": "2015-08-12T17:00:00.000Z", + "CreateDate": "2015-08-12T17:52:52.630Z", + "UpdateDate": "2015-08-12T18:08:06.698Z", + "ClientToken": "c9adb218-3222-4889-8216-0cf0e52dc37e: + "ReservedInstancesModificationId": "rimod-d3ed4335-b1d3-4de6-ab31-0f13aaf46687", + "ReservedInstancesIds": [ + { + "ReservedInstancesId": "b847fa93-e282-4f55-b59a-1342f5bd7c02" + } + ] + } + ] + } + + diff --git a/aws/dist/awscli/examples/ec2/describe-reserved-instances-offerings.rst b/aws/dist/awscli/examples/ec2/describe-reserved-instances-offerings.rst new file mode 100644 index 00000000..dd4bd398 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-reserved-instances-offerings.rst @@ -0,0 +1,112 @@ +**To describe Reserved Instances offerings** + +This example command describes all Reserved Instances available for purchase in the region. + +Command:: + + aws ec2 describe-reserved-instances-offerings + +Output:: + + { + "ReservedInstancesOfferings": [ + { + "OfferingType": "Partial Upfront", + "AvailabilityZone": "us-east-1b", + "InstanceTenancy": "default", + "PricingDetails": [], + "ProductDescription": "Red Hat Enterprise Linux", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "Amount": 0.088, + "Frequency": "Hourly" + } + ], + "Marketplace": false, + "CurrencyCode": "USD", + "FixedPrice": 631.0, + "Duration": 94608000, + "ReservedInstancesOfferingId": "9a06095a-bdc6-47fe-a94a-2a382f016040", + "InstanceType": "c1.medium" + }, + { + "OfferingType": "PartialUpfront", + "AvailabilityZone": "us-east-1b", + "InstanceTenancy": "default", + "PricingDetails": [], + "ProductDescription": "Linux/UNIX", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "Amount": 0.028, + "Frequency": "Hourly" + } + ], + "Marketplace": false, + "CurrencyCode": "USD", + "FixedPrice": 631.0, + "Duration": 94608000, + "ReservedInstancesOfferingId": "bfbefc6c-0d10-418d-b144-7258578d329d", + "InstanceType": "c1.medium" + }, + ... + } + +**To describe your Reserved Instances offerings using options** + +This example lists Reserved Instances offered by AWS with the following specifications: t1.micro instance types, Windows (Amazon VPC) product, and Heavy Utilization offerings. + +Command:: + + aws ec2 describe-reserved-instances-offerings --no-include-marketplace --instance-type "t1.micro" --product-description "Windows (Amazon VPC)" --offering-type "no upfront" + +Output:: + + { + "ReservedInstancesOfferings": [ + { + "OfferingType": "No Upfront", + "AvailabilityZone": "us-east-1b", + "InstanceTenancy": "default", + "PricingDetails": [], + "ProductDescription": "Windows", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "Amount": 0.015, + "Frequency": "Hourly" + } + ], + "Marketplace": false, + "CurrencyCode": "USD", + "FixedPrice": 0.0, + "Duration": 31536000, + "ReservedInstancesOfferingId": "c48ab04c-fe69-4f94-8e39-a23842292823", + "InstanceType": "t1.micro" + }, + + ... + { + "OfferingType": "No Upfront", + "AvailabilityZone": "us-east-1d", + "InstanceTenancy": "default", + "PricingDetails": [], + "ProductDescription": "Windows (Amazon VPC)", + "UsagePrice": 0.0, + "RecurringCharges": [ + { + "Amount": 0.015, + "Frequency": "Hourly" + } + ], + "Marketplace": false, + "CurrencyCode": "USD", + "FixedPrice": 0.0, + "Duration": 31536000, + "ReservedInstancesOfferingId": "3a98bf7d-2123-42d4-b4f5-8dbec4b06dc6", + "InstanceType": "t1.micro" + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/describe-reserved-instances.rst b/aws/dist/awscli/examples/ec2/describe-reserved-instances.rst new file mode 100644 index 00000000..78d09725 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-reserved-instances.rst @@ -0,0 +1,74 @@ +**To describe your Reserved Instances** + +This example command describes the Reserved Instances that you own. + +Command:: + + aws ec2 describe-reserved-instances + +Output:: + + { + "ReservedInstances": [ + { + "ReservedInstancesId": "b847fa93-e282-4f55-b59a-1342fexample", + "OfferingType": "No Upfront", + "AvailabilityZone": "us-west-1c", + "End": "2016-08-14T21:34:34.000Z", + "ProductDescription": "Linux/UNIX", + "UsagePrice": 0.00, + "RecurringCharges": [ + { + "Amount": 0.104, + "Frequency": "Hourly" + } + ], + "Start": "2015-08-15T21:34:35.086Z", + "State": "active", + "FixedPrice": 0.0, + "CurrencyCode": "USD", + "Duration": 31536000, + "InstanceTenancy": "default", + "InstanceType": "m3.medium", + "InstanceCount": 2 + }, + ... + ] + } + +**To describe your Reserved Instances using filters** + +This example filters the response to include only three-year, t2.micro Linux/UNIX Reserved Instances in us-west-1c. + +Command:: + + aws ec2 describe-reserved-instances --filters Name=duration,Values=94608000 Name=instance-type,Values=t2.micro Name=product-description,Values=Linux/UNIX Name=availability-zone,Values=us-east-1e + +Output:: + + { + "ReservedInstances": [ + { + "ReservedInstancesId": "f127bd27-edb7-44c9-a0eb-0d7e09259af0", + "OfferingType": "All Upfront", + "AvailabilityZone": "us-east-1e", + "End": "2018-03-26T21:34:34.000Z", + "ProductDescription": "Linux/UNIX", + "UsagePrice": 0.00, + "RecurringCharges": [], + "Start": "2015-03-27T21:34:35.848Z", + "State": "active", + "FixedPrice": 151.0, + "CurrencyCode": "USD", + "Duration": 94608000, + "InstanceTenancy": "default", + "InstanceType": "t2.micro", + "InstanceCount": 1 + } + ] + } + +For more information, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html + diff --git a/aws/dist/awscli/examples/ec2/describe-route-tables.rst b/aws/dist/awscli/examples/ec2/describe-route-tables.rst new file mode 100644 index 00000000..8400961c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-route-tables.rst @@ -0,0 +1,99 @@ +**To describe your route tables** + +The following ``describe-route-tables`` example retrieves the details about your route tables :: + + aws ec2 describe-route-tables + +Output:: + + { + "RouteTables": [ + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-0df3f54e06EXAMPLE", + "RouteTableId": "rtb-09ba434c1bEXAMPLE" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-09ba434c1bEXAMPLE", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "NatGatewayId": "nat-06c018cbd8EXAMPLE", + "Origin": "CreateRoute", + "State": "blackhole" + } + ], + "Tags": [], + "VpcId": "vpc-0065acced4EXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-9EXAMPLE", + "RouteTableId": "rtb-a1eec7de" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-a1eec7de", + "Routes": [ + { + "DestinationCidrBlock": "172.31.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-fEXAMPLE", + "Origin": "CreateRoute", + "State": "active" + } + ], + "Tags": [], + "VpcId": "vpc-3EXAMPLE", + "OwnerId": "111122223333" + }, + { + "Associations": [ + { + "Main": false, + "RouteTableAssociationId": "rtbassoc-0b100c28b2EXAMPLE", + "RouteTableId": "rtb-07a98f76e5EXAMPLE", + "SubnetId": "subnet-0d3d002af8EXAMPLE" + } + ], + "PropagatingVgws": [], + "RouteTableId": "rtb-07a98f76e5EXAMPLE", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "Origin": "CreateRouteTable", + "State": "active" + }, + { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-06cf664d80EXAMPLE", + "Origin": "CreateRoute", + "State": "active" + } + ], + "Tags": [], + "VpcId": "vpc-0065acced4EXAMPLE", + "OwnerId": "111122223333" + } + ] + } + +For more information, see `Working with Route Tables `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-scheduled-instance-availability.rst b/aws/dist/awscli/examples/ec2/describe-scheduled-instance-availability.rst new file mode 100644 index 00000000..4a3bd17d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-scheduled-instance-availability.rst @@ -0,0 +1,43 @@ +**To describe an available schedule** + +This example describes a schedule that occurs every week on Sunday, starting on the specified date. + +Command:: + + aws ec2 describe-scheduled-instance-availability --recurrence Frequency=Weekly,Interval=1,OccurrenceDays=[1] --first-slot-start-time-range EarliestTime=2016-01-31T00:00:00Z,LatestTime=2016-01-31T04:00:00Z + +Output:: + + { + "ScheduledInstanceAvailabilitySet": [ + { + "AvailabilityZone": "us-west-2b", + "TotalScheduledInstanceHours": 1219, + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", + "MinTermDurationInDays": 366, + "AvailableInstanceCount": 20, + "Recurrence": { + "OccurrenceDaySet": [ + 1 + ], + "Interval": 1, + "Frequency": "Weekly", + "OccurrenceRelativeToEnd": false + }, + "Platform": "Linux/UNIX", + "FirstSlotStartTime": "2016-01-31T00:00:00Z", + "MaxTermDurationInDays": 366, + "SlotDurationInHours": 23, + "NetworkPlatform": "EC2-VPC", + "InstanceType": "c4.large", + "HourlyPrice": "0.095" + }, + ... + ] + } + +To narrow the results, you can add filters that specify the operating system, network, and instance type. + +Command: + + --filters Name=platform,Values=Linux/UNIX Name=network-platform,Values=EC2-VPC Name=instance-type,Values=c4.large diff --git a/aws/dist/awscli/examples/ec2/describe-scheduled-instances.rst b/aws/dist/awscli/examples/ec2/describe-scheduled-instances.rst new file mode 100644 index 00000000..10b99790 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-scheduled-instances.rst @@ -0,0 +1,44 @@ +**To describe your Scheduled Instances** + +This example describes the specified Scheduled Instance. + +Command:: + + aws ec2 describe-scheduled-instances --scheduled-instance-ids sci-1234-1234-1234-1234-123456789012 + +Output:: + + { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "HourlyPrice": "0.095", + "CreateDate": "2016-01-25T21:43:38.612Z", + "Recurrence": { + "OccurrenceDaySet": [ + 1 + ], + "Interval": 1, + "Frequency": "Weekly", + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "Platform": "Linux/UNIX", + "TermEndDate": "2017-01-31T09:00:00Z", + "InstanceCount": 1, + "SlotDurationInHours": 32, + "TermStartDate": "2016-01-31T09:00:00Z", + "NetworkPlatform": "EC2-VPC", + "TotalScheduledInstanceHours": 1696, + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "InstanceType": "c4.large" + } + ] + } + +This example describes all your Scheduled Instances. + +Command:: + + aws ec2 describe-scheduled-instances diff --git a/aws/dist/awscli/examples/ec2/describe-security-group-references.rst b/aws/dist/awscli/examples/ec2/describe-security-group-references.rst new file mode 100644 index 00000000..dbf82a68 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-security-group-references.rst @@ -0,0 +1,19 @@ +**To describe security group references** + +This example describes the security group references for ``sg-bbbb2222``. The response indicates that security group ``sg-bbbb2222`` is being referenced by a security group in VPC ``vpc-aaaaaaaa``. + +Command:: + + aws ec2 describe-security-group-references --group-id sg-bbbbb22222 + +Output:: + + { + "SecurityGroupsReferenceSet": [ + { + "ReferencingVpcId": "vpc-aaaaaaaa ", + "GroupId": "sg-bbbbb22222", + "VpcPeeringConnectionId": "pcx-b04deed9" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-security-groups.rst b/aws/dist/awscli/examples/ec2/describe-security-groups.rst new file mode 100644 index 00000000..8601fc24 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-security-groups.rst @@ -0,0 +1,149 @@ +**To describe a security group for EC2-Classic** + +This example displays information about the security group named ``MySecurityGroup``. + +Command:: + + aws ec2 describe-security-groups --group-names MySecurityGroup + +Output:: + + { + "SecurityGroups": [ + { + "IpPermissionsEgress": [], + "Description": "My security group", + "IpPermissions": [ + { + "PrefixListIds": [], + "FromPort": 22, + "IpRanges": [ + { + "CidrIp": "203.0.113.0/24" + } + ], + "ToPort": 22, + "IpProtocol": "tcp", + "UserIdGroupPairs": [] + } + ], + "GroupName": "MySecurityGroup", + "OwnerId": "123456789012", + "GroupId": "sg-903004f8", + } + ] + } + +**To describe a security group for EC2-VPC** + +This example displays information about the security group with the ID sg-903004f8. Note that you can't reference a security group for EC2-VPC by name. + +Command:: + + aws ec2 describe-security-groups --group-ids sg-903004f8 + +Output:: + + { + "SecurityGroups": [ + { + "IpPermissionsEgress": [ + { + "IpProtocol": "-1", + "IpRanges": [ + { + "CidrIp": "0.0.0.0/0" + } + ], + "UserIdGroupPairs": [], + "PrefixListIds": [] + } + ], + "Description": "My security group", + "Tags": [ + { + "Value": "SG1", + "Key": "Name" + } + ], + "IpPermissions": [ + { + "IpProtocol": "-1", + "IpRanges": [], + "UserIdGroupPairs": [ + { + "UserId": "123456789012", + "GroupId": "sg-903004f8" + } + ], + "PrefixListIds": [] + }, + { + "PrefixListIds": [], + "FromPort": 22, + "IpRanges": [ + { + "Description": "Access from NY office", + "CidrIp": "203.0.113.0/24" + } + ], + "ToPort": 22, + "IpProtocol": "tcp", + "UserIdGroupPairs": [] + } + ], + "GroupName": "MySecurityGroup", + "VpcId": "vpc-1a2b3c4d", + "OwnerId": "123456789012", + "GroupId": "sg-903004f8", + } + ] + } + +**To describe security groups that have specific rules** + +(EC2-VPC only) This example uses filters to describe security groups that have a rule that allows SSH traffic (port 22) and a rule that allows traffic from all addresses (``0.0.0.0/0``). The output is filtered to display only the names of the security groups. Security groups must match all filters to be returned in the results; however, a single rule does not have to match all filters. For example, the output returns a security group with a rule that allows SSH traffic from a specific IP address and another rule that allows HTTP traffic from all addresses. + +Command:: + + aws ec2 describe-security-groups --filters Name=ip-permission.from-port,Values=22 Name=ip-permission.to-port,Values=22 Name=ip-permission.cidr,Values='0.0.0.0/0' --query "SecurityGroups[*].{Name:GroupName}" + +Output:: + + [ + { + "Name": "default" + }, + { + "Name": "Test SG" + }, + { + "Name": "SSH-Access-Group" + } + ] + +**To describe tagged security groups** + +This example describes all security groups that include ``test`` in the security group name, and that have the tag ``Test=To-delete``. The output is filtered to display only the names and IDs of the security groups. + +Command:: + + aws ec2 describe-security-groups --filters Name=group-name,Values=*test* Name=tag:Test,Values=To-delete --query "SecurityGroups[*].{Name:GroupName,ID:GroupId}" + +Output:: + + [ + { + "Name": "testfornewinstance", + "ID": "sg-33bb22aa" + }, + { + "Name": "newgrouptest", + "ID": "sg-1a2b3c4d" + } + ] + +For more information, see `Using Security Groups`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Security Groups`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-sg.html + diff --git a/aws/dist/awscli/examples/ec2/describe-snapshot-attribute.rst b/aws/dist/awscli/examples/ec2/describe-snapshot-attribute.rst new file mode 100644 index 00000000..99e31cb0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-snapshot-attribute.rst @@ -0,0 +1,25 @@ +**To describe the snapshot attributes for a snapshot** + +The following ``describe-snapshot`` example describes the ``createVolumePermission`` attribute for the specified snapshot. :: + + aws ec2 describe-snapshot-attribute \ + --snapshot-id snap-066877671789bd71b \ + --attribute createVolumePermission + +The output indicates that the specified user has volume permissions. :: + + { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [ + { + "UserId": "123456789012" + } + ] + } + +Output similar to the following indicates that there are no volume permissions. :: + + { + "SnapshotId": "snap-066877671789bd71b", + "CreateVolumePermissions": [] + } diff --git a/aws/dist/awscli/examples/ec2/describe-snapshots.rst b/aws/dist/awscli/examples/ec2/describe-snapshots.rst new file mode 100644 index 00000000..b5d9b14b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-snapshots.rst @@ -0,0 +1,67 @@ +**Example 1: To describe a snapshot** + +The following ``describe-snapshots`` example describes the specified snapshot. :: + + aws ec2 describe-snapshots \ + --snapshot-id snap-1234567890abcdef0 + +Output:: + + { + "Snapshots": [ + { + "Description": "This is my snapshot", + "Encrypted": false, + "VolumeId": "vol-049df61146c4d7901", + "State": "completed", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:28:32.000Z", + "Progress": "100%", + "OwnerId": "012345678910", + "SnapshotId": "snap-1234567890abcdef0" + } + ] + } + +**Example 2: To describe snapshots using filters** + +The following ``describe-snapshots`` example describes all snapshots owned by the specified AWS account that are in the ``pending`` state. :: + + aws ec2 describe-snapshots \ + --owner-ids 012345678910 \ + --filters Name=status,Values=pending + +Output:: + + { + "Snapshots": [ + { + "Description": "This is my copied snapshot", + "Encrypted": true, + "VolumeId": "vol-1234567890abcdef0", + "State": "pending", + "VolumeSize": 8, + "StartTime": "2014-02-28T21:37:27.000Z", + "Progress": "87%", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b" + } + ] + } + +**Example 3: To describe tagged snapshots and filter the output** + +The following ``describe-snapshots`` example describes all snapshots that have the tag ``Group=Prod``. The output is filtered to display only the snapshot IDs and the time the snapshot was started. :: + + aws ec2 describe-snapshots \ + --filters Name=tag:Group,Values=Prod \ + --query "Snapshots[*].{ID:SnapshotId,Time:StartTime}" + +Output:: + + [ + { + "ID": "snap-1234567890abcdef0", + "Time": "2014-08-04T12:48:18.000Z" + } + ] diff --git a/aws/dist/awscli/examples/ec2/describe-spot-datafeed-subscription.rst b/aws/dist/awscli/examples/ec2/describe-spot-datafeed-subscription.rst new file mode 100644 index 00000000..b532ff50 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-datafeed-subscription.rst @@ -0,0 +1,19 @@ +**To describe Spot Instance datafeed subscription for an account** + +This example command describes the data feed for the account. + +Command:: + + aws ec2 describe-spot-datafeed-subscription + +Output:: + + { + "SpotDatafeedSubscription": { + "OwnerId": "123456789012", + "Prefix": "spotdata", + "Bucket": "my-s3-bucket", + "State": "Active" + } + } + diff --git a/aws/dist/awscli/examples/ec2/describe-spot-fleet-instances.rst b/aws/dist/awscli/examples/ec2/describe-spot-fleet-instances.rst new file mode 100644 index 00000000..a6e7134e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-fleet-instances.rst @@ -0,0 +1,21 @@ +**To describe the Spot Instances associated with a Spot fleet** + +This example command lists the Spot instances associated with the specified Spot fleet. + +Command:: + + aws ec2 describe-spot-fleet-instances --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE + +Output:: + + { + "ActiveInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": "m3.medium", + "SpotInstanceRequestId": "sir-08b93456" + }, + ... + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } diff --git a/aws/dist/awscli/examples/ec2/describe-spot-fleet-request-history.rst b/aws/dist/awscli/examples/ec2/describe-spot-fleet-request-history.rst new file mode 100644 index 00000000..bd0e7aa3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-fleet-request-history.rst @@ -0,0 +1,49 @@ +**To describe Spot fleet history** + +This example command returns the history for the specified Spot fleet starting at the specified time. + +Command:: + + aws ec2 describe-spot-fleet-request-history --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE --start-time 2015-05-26T00:00:00Z + +The following example output shows the successful launches of two Spot Instances for the Spot fleet. + +Output:: + + { + "HistoryRecords": [ + { + "Timestamp": "2015-05-26T23:17:20.697Z", + "EventInformation": { + "EventSubType": "submitted" + }, + "EventType": "fleetRequestChange" + }, + { + "Timestamp": "2015-05-26T23:17:20.873Z", + "EventInformation": { + "EventSubType": "active" + }, + "EventType": "fleetRequestChange" + }, + { + "Timestamp": "2015-05-26T23:21:21.712Z", + "EventInformation": { + "InstanceId": "i-1234567890abcdef0", + "EventSubType": "launched" + }, + "EventType": "instanceChange" + }, + { + "Timestamp": "2015-05-26T23:21:21.816Z", + "EventInformation": { + "InstanceId": "i-1234567890abcdef1", + "EventSubType": "launched" + }, + "EventType": "instanceChange" + } + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", + "StartTime": "2015-05-26T00:00:00Z" + } diff --git a/aws/dist/awscli/examples/ec2/describe-spot-fleet-requests.rst b/aws/dist/awscli/examples/ec2/describe-spot-fleet-requests.rst new file mode 100644 index 00000000..d52ab4db --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-fleet-requests.rst @@ -0,0 +1,132 @@ +**To describe your Spot fleet requests** + +This example describes all of your Spot fleet requests. + +Command:: + + aws ec2 describe-spot-fleet-requests + +Output:: + + { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestConfig": { + "TargetCapacity": 20, + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "cc2.8xlarge", + "ImageId": "ami-1a2b3c4d" + }, + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "r3.8xlarge", + "ImageId": "ami-1a2b3c4d" + } + ], + "SpotPrice": "0.05", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" + }, + "SpotFleetRequestState": "active" + }, + { + "SpotFleetRequestId": "sfr-306341ed-9739-402e-881b-ce47bEXAMPLE", + "SpotFleetRequestConfig": { + "TargetCapacity": 20, + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-6e7f829e", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "m3.medium", + "ImageId": "ami-1a2b3c4d" + } + ], + "SpotPrice": "0.05", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" + }, + "SpotFleetRequestState": "active" + } + ] + } + +**To describe a Spot fleet request** + +This example describes the specified Spot fleet request. + +Command:: + + aws ec2 describe-spot-fleet-requests --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE + +Output:: + + { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestConfig": { + "TargetCapacity": 20, + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "cc2.8xlarge", + "ImageId": "ami-1a2b3c4d" + }, + { + "EbsOptimized": false, + "NetworkInterfaces": [ + { + "SubnetId": "subnet-a61dafcf", + "DeviceIndex": 0, + "DeleteOnTermination": false, + "AssociatePublicIpAddress": true, + "SecondaryPrivateIpAddressCount": 0 + } + ], + "InstanceType": "r3.8xlarge", + "ImageId": "ami-1a2b3c4d" + } + ], + "SpotPrice": "0.05", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role" + }, + "SpotFleetRequestState": "active" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-spot-instance-requests.rst b/aws/dist/awscli/examples/ec2/describe-spot-instance-requests.rst new file mode 100644 index 00000000..12a3bf2d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-instance-requests.rst @@ -0,0 +1,89 @@ +**To describe Spot Instance requests** + +This example describes all of your Spot Instance requests. + +Command:: + + aws ec2 describe-spot-instance-requests + +Output:: + + { + "SpotInstanceRequests": [ + { + "Status": { + "UpdateTime": "2014-04-30T18:16:21.000Z", + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled." + }, + "ProductDescription": "Linux/UNIX", + "InstanceId": "i-1234567890abcdef0", + "SpotInstanceRequestId": "sir-08b93456", + "State": "active", + "LaunchedAvailabilityZone": "us-west-1b", + "LaunchSpecification": { + "ImageId": "ami-7aba833f", + "KeyName": "May14Key", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeType": "standard", + "VolumeSize": 8 + } + } + ], + "EbsOptimized": false, + "SecurityGroups": [ + { + "GroupName": "launch-wizard-1", + "GroupId": "sg-e38f24a7" + } + ], + "InstanceType": "m1.small" + }, + "Type": "one-time", + "CreateTime": "2014-04-30T18:14:55.000Z", + "SpotPrice": "0.010000" + }, + { + "Status": { + "UpdateTime": "2014-04-30T18:16:21.000Z", + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled." + }, + "ProductDescription": "Linux/UNIX", + "InstanceId": "i-1234567890abcdef1", + "SpotInstanceRequestId": "sir-285b1e56", + "State": "active", + "LaunchedAvailabilityZone": "us-west-1b", + "LaunchSpecification": { + "ImageId": "ami-7aba833f", + "KeyName": "May14Key", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeType": "standard", + "VolumeSize": 8 + } + } + ], + "EbsOptimized": false, + "SecurityGroups": [ + { + "GroupName": "launch-wizard-1", + "GroupId": "sg-e38f24a7" + } + ], + "InstanceType": "m1.small" + }, + "Type": "one-time", + "CreateTime": "2014-04-30T18:14:55.000Z", + "SpotPrice": "0.010000" + } + ] + } + diff --git a/aws/dist/awscli/examples/ec2/describe-spot-price-history.rst b/aws/dist/awscli/examples/ec2/describe-spot-price-history.rst new file mode 100644 index 00000000..35dbfadb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-spot-price-history.rst @@ -0,0 +1,65 @@ +**To describe Spot price history** + +This example command returns the Spot Price history for m1.xlarge instances for a particular day in January. + +Command:: + + aws ec2 describe-spot-price-history --instance-types m1.xlarge --start-time 2014-01-06T07:08:09 --end-time 2014-01-06T08:09:10 + +Output:: + + { + "SpotPriceHistory": [ + { + "Timestamp": "2014-01-06T07:10:55.000Z", + "ProductDescription": "SUSE Linux", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.087000", + "AvailabilityZone": "us-west-1b" + }, + { + "Timestamp": "2014-01-06T07:10:55.000Z", + "ProductDescription": "SUSE Linux", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.087000", + "AvailabilityZone": "us-west-1c" + }, + { + "Timestamp": "2014-01-06T05:42:36.000Z", + "ProductDescription": "SUSE Linux (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.087000", + "AvailabilityZone": "us-west-1a" + }, + ... + } + + +**To describe Spot price history for Linux/UNIX Amazon VPC** + +This example command returns the Spot Price history for m1.xlarge, Linux/UNIX Amazon VPC instances for a particular day in January. + +Command:: + + aws ec2 describe-spot-price-history --instance-types m1.xlarge --product-description "Linux/UNIX (Amazon VPC)" --start-time 2014-01-06T07:08:09 --end-time 2014-01-06T08:09:10 + +Output:: + + { + "SpotPriceHistory": [ + { + "Timestamp": "2014-01-06T04:32:53.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1a" + }, + { + "Timestamp": "2014-01-05T11:28:26.000Z", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "InstanceType": "m1.xlarge", + "SpotPrice": "0.080000", + "AvailabilityZone": "us-west-1c" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-stale-security-groups.rst b/aws/dist/awscli/examples/ec2/describe-stale-security-groups.rst new file mode 100644 index 00000000..764964ca --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-stale-security-groups.rst @@ -0,0 +1,59 @@ +**To describe stale security groups** + +This example describes stale security group rules for ``vpc-11223344``. The response shows that sg-5fa68d3a in your account has a stale ingress SSH rule that references ``sg-279ab042`` in the peer VPC, and that ``sg-fe6fba9a`` in your account has a stale egress SSH rule that references ``sg-ef6fba8b`` in the peer VPC. + +Command:: + + aws ec2 describe-stale-security-groups --vpc-id vpc-11223344 + +Output:: + + { + "StaleSecurityGroupSet": [ + { + "VpcId": "vpc-11223344", + "StaleIpPermissionsEgress": [ + { + "ToPort": 22, + "FromPort": 22, + "UserIdGroupPairs": [ + { + "VpcId": "vpc-7a20e51f", + "GroupId": "sg-ef6fba8b", + "VpcPeeringConnectionId": "pcx-b04deed9", + "PeeringStatus": "active" + } + ], + "IpProtocol": "tcp" + } + ], + "GroupName": "MySG1", + "StaleIpPermissions": [], + "GroupId": "sg-fe6fba9a", + "Description": MySG1" + }, + { + "VpcId": "vpc-11223344", + "StaleIpPermissionsEgress": [], + "GroupName": "MySG2", + "StaleIpPermissions": [ + { + "ToPort": 22, + "FromPort": 22, + "UserIdGroupPairs": [ + { + "VpcId": "vpc-7a20e51f", + "GroupId": "sg-279ab042", + "Description": "Access from pcx-b04deed9", + "VpcPeeringConnectionId": "pcx-b04deed9", + "PeeringStatus": "active" + } + ], + "IpProtocol": "tcp" + } + ], + "GroupId": "sg-5fa68d3a", + "Description": "MySG2" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-subnets.rst b/aws/dist/awscli/examples/ec2/describe-subnets.rst new file mode 100644 index 00000000..70fcbba0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-subnets.rst @@ -0,0 +1,98 @@ +**Example 1: To describe your subnets** + +The following ``describe-subnets`` example displays the details of your subnets. :: + + aws ec2 describe-subnets + +Output:: + + { + "Subnets": [ + { + "AvailabilityZone": "us-east-2c", + "AvailabilityZoneId": "use2-az3", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.2.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-0bb1c79de3EXAMPLE", + "VpcId": "vpc-0ee975135dEXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE" + }, + { + "AvailabilityZone": "us-east-2c", + "AvailabilityZoneId": "use2-az3", + "AvailableIpAddressCount": 248, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-0931fc2fa5EXAMPLE", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "Tags": [ + { + "Key": "Name", + "Value": "MySubnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0931fc2fa5EXAMPLE" + } + ] + } + +**Example 2: To descripe a specific subnets** + +The following ``describe-subnets`` example uses a filter to retrieve details for the subnets of the specified VPC. :: + + aws ec2 describe-subnets \ + --filters "Name=vpc-id,Values=vpc-06e4ab6c6cEXAMPLE" + +Output:: + + { + "Subnets": [ + { + "AvailabilityZone": "us-east-2c", + "AvailabilityZoneId": "use2-az3", + "AvailableIpAddressCount": 248, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-0931fc2fa5EXAMPLE", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333", + "AssignIpv6AddressOnCreation": false, + "Ipv6CidrBlockAssociationSet": [], + "Tags": [ + { + "Key": "Name", + "Value": "MySubnet" + } + ], + "SubnetArn": "arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0931fc2fa5EXAMPLE" + } + ] + } + +**Example 3: To describe subnets with a specific tag** + +The following ``describe-subnets`` example uses a filter to retrieve the details of those subnets with the tag ``Name=MySubnet``. The command specifies that the output is a simple text string. :: + + aws ec2 describe-subnets \ + --filters Name=tag:Name,Values=MySubnet \ + --output text + +Output:: + + SUBNETS False us-east-2c use2-az3 248 10.0.1.0/24 False False 111122223333 available arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0931fc2fa5EXAMPLE subnet-0931fc2fa5f1cbe44 vpc-06e4ab6c6c3b23ae3 + TAGS Name MySubnet + +For more information, see `Working with VPCs and Subnets `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-tags.rst b/aws/dist/awscli/examples/ec2/describe-tags.rst new file mode 100755 index 00000000..fcc3c8da --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-tags.rst @@ -0,0 +1,132 @@ +**Example 1: To describe all tags for a single resource** + +The following ``describe-tags`` example describes the tags for the specified instance. :: + + aws ec2 describe-tags \ + --filters "Name=resource-id,Values=i-1234567890abcdef8" + +Output:: + + { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Test", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Beta Server", + "Key": "Name" + } + ] + } + +**Example 2: To describe all tags for a resource type** + +The following ``describe-tags`` example describes the tags for your volumes. :: + + aws ec2 describe-tags \ + --filters "Name=resource-type,Values=volume" + +Output:: + + { + "Tags": [ + { + "ResourceType": "volume", + "ResourceId": "vol-1234567890abcdef0", + "Value": "Project1", + "Key": "Purpose" + }, + { + "ResourceType": "volume", + "ResourceId": "vol-049df61146c4d7901", + "Value": "Logs", + "Key": "Purpose" + } + ] + } + +**Example 3: To describe all your tags** + +The following ``describe-tags`` example describes the tags for all your resources. :: + + aws ec2 describe-tags + +**Example 4: To describe the tags for your resources based on a tag key** + +The following ``describe-tags`` example describes the tags for your resources that have a tag with the key ``Stack``. :: + + aws ec2 describe-tags \ + --filters Name=key,Values=Stack + +Output:: + + { + "Tags": [ + { + "ResourceType": "volume", + "ResourceId": "vol-027552a73f021f3b", + "Value": "Production", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Test", + "Key": "Stack" + } + ] + } + +**Example 5: To describe the tags for your resources based on a tag key and tag value** + +The following ``describe-tags`` example describes the tags for your resources that have the tag ``Stack=Test``. :: + + aws ec2 describe-tags \ + --filters Name=key,Values=Stack Name=value,Values=Test + +Output:: + + { + "Tags": [ + { + "ResourceType": "image", + "ResourceId": "ami-3ac336533f021f3bd", + "Value": "Test", + "Key": "Stack" + }, + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef8", + "Value": "Test", + "Key": "Stack" + } + ] + } + +The following ``describe-tags`` example uses alternate syntax to describe resources with the tag ``Stack=Test``. :: + + aws ec2 describe-tags \ + --filters "Name=tag:Stack,Values=Test" + +The following ``describe-tags`` example describes the tags for all your instances that have a tag with the key ``Purpose`` and no value. :: + + aws ec2 describe-tags \ + --filters "Name=resource-type,Values=instance" "Name=key,Values=Purpose" "Name=value,Values=" + +Output:: + + { + "Tags": [ + { + "ResourceType": "instance", + "ResourceId": "i-1234567890abcdef5", + "Value": null, + "Key": "Purpose" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-traffic-mirror-filters.rst b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-filters.rst new file mode 100755 index 00000000..e5ee5ce0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-filters.rst @@ -0,0 +1,34 @@ +**To view your traffic mirror filters** + +The following ``describe-traffic-mirror-filters`` example displays details for all of your traffic mirror filters. :: + + aws ec2 describe-traffic-mirror-filters + +Output:: + + { + "TrafficMirrorFilters": [ + { + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "IngressFilterRules": [ + { + "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "TrafficDirection": "ingress", + "RuleNumber": 100, + "RuleAction": "accept", + "Protocol": 6, + "DestinationCidrBlock": "10.0.0.0/24", + "SourceCidrBlock": "10.0.0.0/24", + "Description": "TCP Rule" + } + ], + "EgressFilterRules": [], + "NetworkServices": [], + "Description": "Exanple Filter", + "Tags": [] + } + ] + } + +For more information, see `View Your Traffic Mirror Filters `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-traffic-mirror-sessions.rst b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-sessions.rst new file mode 100644 index 00000000..8422ae08 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-sessions.rst @@ -0,0 +1,42 @@ +**To describe a Traffic Mirror Session** + +The following ``describe-traffic-mirror-sessions`` example displays details of the your Traffic Mirror sessions. :: + + aws ec2 describe-traffic-mirror-sessions + +Output:: + + { + "TrafficMirrorSessions": [ + { + "Tags": [], + "VirtualNetworkId": 42, + "OwnerId": "111122223333", + "Description": "TCP Session", + "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", + "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", + "TrafficMirrorFilterId": "tmf-083e18f985EXAMPLE", + "PacketLength": 20, + "SessionNumber": 1, + "TrafficMirrorSessionId": "tms-0567a4c684EXAMPLE" + }, + { + "Tags": [ + { + "Key": "Name", + "Value": "tag test" + } + ], + "VirtualNetworkId": 13314501, + "OwnerId": "111122223333", + "Description": "TCP Session", + "NetworkInterfaceId": "eni-0a471a5cf3EXAMPLE", + "TrafficMirrorTargetId": "tmt-03665551cbEXAMPLE", + "TrafficMirrorFilterId": "tmf-06c787846cEXAMPLE", + "SessionNumber": 2, + "TrafficMirrorSessionId": "tms-0060101cf8EXAMPLE" + } + ] + } + +For more information, see `View Traffic Mirror Session Details `__ in the *AWS Traffic Mirroring Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-traffic-mirror-targets.rst b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-targets.rst new file mode 100644 index 00000000..adfa0c62 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-traffic-mirror-targets.rst @@ -0,0 +1,23 @@ +**To describe a Traffic Mirror Target** + +The following ``describe-traffic-mirror-targets`` example displays details of the specified Traffic Mirror target. :: + + aws ec2 describe-traffic-mirror-targets \ + --traffic-mirror-target-id tmt-0dabe9b0a6EXAMPLE + +Output:: + + { + "TrafficMirrorTargets": [ + { + "TrafficMirrorTargetId": "tmt-0dabe9b0a6EXAMPLE", + "NetworkLoadBalancerArn": "arn:aws:elasticloadbalancing:us-east-1:111122223333:loadbalancer/net/NLB/7cdec873fEXAMPLE", + "Type": "network-load-balancer", + "Description": "Example Network Load Balancer Target", + "OwnerId": "111122223333", + "Tags": [] + } + ] + } + +For more information, see `View Traffic Mirror Target Details `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-transit-gateway-attachments.rst b/aws/dist/awscli/examples/ec2/describe-transit-gateway-attachments.rst new file mode 100755 index 00000000..151cd204 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-transit-gateway-attachments.rst @@ -0,0 +1,79 @@ +**To view your transit gateway attachments** + + The following ``describe-transit-gateway-attachments`` example displays details for your transit gateway attachments. :: + + aws ec2 describe-transit-gateway-attachments + +Output:: + + { + "TransitGatewayAttachments": [ + { + "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "vpc", + "ResourceId": "vpc-3EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-26T14:59:25.000Z", + "Tags": [ + { + "Key": "Name", + "Value": "Example" + } + ] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0b5968d3b6EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "vpc", + "ResourceId": "vpc-0065acced4EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-07T17:03:07.000Z", + "Tags": [] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "direct-connect-gateway", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-14T20:27:44.000Z", + "Tags": [] + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "TransitGatewayId": "tgw-02f776b1a7EXAMPLE", + "TransitGatewayOwnerId": "123456789012", + "ResourceOwnerId": "123456789012", + "ResourceType": "direct-connect-gateway", + "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "State": "available", + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "State": "associated" + }, + "CreationTime": "2019-08-14T20:33:02.000Z", + "Tags": [] + } + ] + } + +For more information, see `Working with Transit Gateways `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-transit-gateway-route-tables.rst b/aws/dist/awscli/examples/ec2/describe-transit-gateway-route-tables.rst new file mode 100755 index 00000000..93affc3c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-transit-gateway-route-tables.rst @@ -0,0 +1,32 @@ +**To describe your transit gateway route tables** + +The following ``describe-transit-gateway-route-tables`` examples displays details for all of your transit gateway route tables. :: + + aws ec2 describe-transit-gateway-route-tables + +Output:: + + { + "TransitGatewayRouteTables": [ + { + "TransitGatewayRouteTableId": "tgw-rtb-0ca78a549EXAMPLE", + "TransitGatewayId": "tgw-0bc994abffEXAMPLE", + "State": "available", + "DefaultAssociationRouteTable": true, + "DefaultPropagationRouteTable": true, + "CreationTime": "2018-11-28T14:24:49.000Z", + "Tags": [] + }, + { + "TransitGatewayRouteTableId": "tgw-rtb-0e8f48f148EXAMPLE", + "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", + "State": "available", + "DefaultAssociationRouteTable": true, + "DefaultPropagationRouteTable": true, + "CreationTime": "2018-11-28T14:24:00.000Z", + "Tags": [] + } + ] + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst b/aws/dist/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst new file mode 100644 index 00000000..4ba20f8c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-transit-gateway-vpc-attachments.rst @@ -0,0 +1,36 @@ +**To describe your transit gateway VPC attachments** + +The following ``describe-transit-gateway-vpc-attachments`` example displays details for all of your transit gateway VPC attachments. :: + + aws ec2 describe-transit-gateway-vpc-attachments + +Output:: + + { + "TransitGatewayVpcAttachments": [ + { + "TransitGatewayAttachmentId": "tgw-attach-0a08e88308EXAMPLE", + "TransitGatewayId": "tgw-0043d72bb4EXAMPLE", + "VpcId": "vpc-0f501f7ee8EXAMPLE", + "VpcOwnerId": "111122223333", + "State": "available", + "SubnetIds": [ + "subnet-045d586432EXAMPLE", + "subnet-0a0ad478a6EXAMPLE" + ], + "CreationTime": "2019-02-13T11:04:02.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + }, + "Tags": [ + { + "Key": "Name", + "Value": "attachment name" + } + ] + } + ] + } + +For more information, see `View Your VPC Attachments `__ in the *AWS Transit Gateways* diff --git a/aws/dist/awscli/examples/ec2/describe-transit-gateways.rst b/aws/dist/awscli/examples/ec2/describe-transit-gateways.rst new file mode 100644 index 00000000..c24d1e61 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-transit-gateways.rst @@ -0,0 +1,54 @@ +**To describe your transit gateways** + +The following ``describe-transit-gateways`` example retrieves details about your transit gateways. :: + + aws ec2 describe-transit-gateways + +Output:: + + { + "TransitGateways": [ + { + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0262a0e521EXAMPLE", + "State": "available", + "OwnerId": "111122223333", + "Description": "MyTGW", + "CreationTime": "2019-07-10T14:02:12.000Z", + "Options": { + "AmazonSideAsn": 64516, + "AutoAcceptSharedAttachments": "enable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-018774adf3EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + }, + "Tags": [] + }, + { + "TransitGatewayId": "tgw-0fb8421e2dEXAMPLE", + "TransitGatewayArn": "arn:aws:ec2:us-east-2:111122223333:transit-gateway/tgw-0fb8421e2da853bf3", + "State": "available", + "OwnerId": "111122223333", + "CreationTime": "2019-03-15T22:57:33.000Z", + "Options": { + "AmazonSideAsn": 65412, + "AutoAcceptSharedAttachments": "disable", + "DefaultRouteTableAssociation": "enable", + "AssociationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", + "DefaultRouteTablePropagation": "enable", + "PropagationDefaultRouteTableId": "tgw-rtb-06a241a3d8EXAMPLE", + "VpnEcmpSupport": "enable", + "DnsSupport": "enable" + }, + "Tags": [ + { + "Key": "Name", + "Value": "TGW1" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-volume-attribute.rst b/aws/dist/awscli/examples/ec2/describe-volume-attribute.rst new file mode 100644 index 00000000..efb57fee --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-volume-attribute.rst @@ -0,0 +1,16 @@ +**To describe a volume attribute** + +This example command describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``. + +Command:: + + aws ec2 describe-volume-attribute --volume-id vol-049df61146c4d7901 --attribute autoEnableIO + +Output:: + + { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + } diff --git a/aws/dist/awscli/examples/ec2/describe-volume-status.rst b/aws/dist/awscli/examples/ec2/describe-volume-status.rst new file mode 100644 index 00000000..1affba99 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-volume-status.rst @@ -0,0 +1,51 @@ +**To describe the status of a single volume** + +This example command describes the status for the volume ``vol-1234567890abcdef0``. + +Command:: + + aws ec2 describe-volume-status --volume-ids vol-1234567890abcdef0 + +Output:: + + { + "VolumeStatuses": [ + { + "VolumeStatus": { + "Status": "ok", + "Details": [ + { + "Status": "passed", + "Name": "io-enabled" + }, + { + "Status": "not-applicable", + "Name": "io-performance" + } + ] + }, + "AvailabilityZone": "us-east-1a", + "VolumeId": "vol-1234567890abcdef0", + "Actions": [], + "Events": [] + } + ] + } + +**To describe the status of impaired volumes** + +This example command describes the status for all volumes that are impaired. In this example output, there are no impaired volumes. + +Command:: + + aws ec2 describe-volume-status --filters Name=volume-status.status,Values=impaired + +Output:: + + { + "VolumeStatuses": [] + } + +If you have a volume with a failed status check (status is impaired), see `Working with an Impaired Volume`_ in the *Amazon EC2 User Guide*. + +.. _`Working with an Impaired Volume`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-status.html#work_volumes_impaired diff --git a/aws/dist/awscli/examples/ec2/describe-volumes-modifications.rst b/aws/dist/awscli/examples/ec2/describe-volumes-modifications.rst new file mode 100644 index 00000000..8780b566 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-volumes-modifications.rst @@ -0,0 +1,23 @@ +**To describe the modification status for a volume** + +The following ``describe-volumes-modifications`` example describes the volume modification status of the specified volume. :: + + aws ec2 describe-volumes-modifications \ + --volume-ids vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 150, + "TargetVolumeType": "io1", + "ModificationState": "optimizing", + "VolumeId": " vol-1234567890abcdef0", + "TargetIops": 100, + "StartTime": "2019-05-17T11:27:19.000Z", + "Progress": 70, + "OriginalVolumeType": "io1", + "OriginalIops": 100, + "OriginalSize": 100 + } + } diff --git a/aws/dist/awscli/examples/ec2/describe-volumes.rst b/aws/dist/awscli/examples/ec2/describe-volumes.rst new file mode 100644 index 00000000..26538c69 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-volumes.rst @@ -0,0 +1,136 @@ +**Example 1: To describe all volumes** + +The following ``describe-volumes`` example describes all of your volumes in the current Region. :: + + aws ec2 describe-volumes + +Output:: + + { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + }, + { + "AvailabilityZone": "us-east-1a", + "Attachments": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "available", + "Iops": 1000, + "SnapshotId": null, + "CreateTime": "2014-02-27T00:02:41.791Z", + "Size": 100 + } + ] + } + +**Example 2: To describe volumes that are attached to a specific instance** + +The following ``describe-volumes`` example describes all volumes that are both attached to the specified instance and set to delete when the instance terminates. :: + + aws ec2 describe-volumes \ + --region us-east-1 \ + --filters Name=attachment.instance-id,Values=i-1234567890abcdef0 Name=attachment.delete-on-termination,Values=true + +Output:: + + { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "attached", + "DeleteOnTermination": true, + "Device": "/dev/sda1" + } + ], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-049df61146c4d7901", + "State": "in-use", + "SnapshotId": "snap-1234567890abcdef0", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8 + } + ] + } + +**Example 3: To describe available volumes in a specific Availability Zone** + +The following ``describe-volumes`` example describes all volumes that have a status of ``available`` and are in the specified Availability Zone. :: + + aws ec2 describe-volumes \ + --filters Name=status,Values=available Name=availability-zone,Values=us-east-1a + +Output:: + + { + "Volumes": [ + { + "AvailabilityZone": "us-east-1a", + "Attachments": [], + "Encrypted": false, + "VolumeType": "gp2", + "VolumeId": "vol-1234567890abcdef0", + "State": "available", + "Iops": 1000, + "SnapshotId": null, + "CreateTime": "2014-02-27T00:02:41.791Z", + "Size": 100 + } + ] + } + +**Example 4: To describe tagged volumes and filter the output** + +The following ``describe-volumes`` example describes all volumes that have the tag key ``Name`` and a value that begins with ``Test``. The output is then filtered with a query that displays only the tags and IDs of the volumes. :: + + aws ec2 describe-volumes \ + --filters Name=tag:Name,Values=Test* \ + --query "Volumes[*].{ID:VolumeId,Tag:Tags}" + +Output:: + + [ + { + "Tag": [ + { + "Value": "Test2", + "Key": "Name" + } + ], + "ID": "vol-1234567890abcdef0" + }, + { + "Tag": [ + { + "Value": "Test1", + "Key": "Name" + } + ], + "ID": "vol-049df61146c4d7901" + } + ] diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-attribute.rst b/aws/dist/awscli/examples/ec2/describe-vpc-attribute.rst new file mode 100644 index 00000000..df358318 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-attribute.rst @@ -0,0 +1,33 @@ +**To describe the enableDnsSupport attribute** + +This example describes the ``enableDnsSupport`` attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is ``true``, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. + +Command:: + + aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsSupport + +Output:: + + { + "VpcId": "vpc-a01106c2", + "EnableDnsSupport": { + "Value": true + } + } + +**To describe the enableDnsHostnames attribute** + +This example describes the ``enableDnsHostnames`` attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is ``true``, instances in the VPC get DNS hostnames; otherwise, they do not. + +Command:: + + aws ec2 describe-vpc-attribute --vpc-id vpc-a01106c2 --attribute enableDnsHostnames + +Output:: + + { + "VpcId": "vpc-a01106c2", + "EnableDnsHostnames": { + "Value": true + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-classic-link-dns-support.rst b/aws/dist/awscli/examples/ec2/describe-vpc-classic-link-dns-support.rst new file mode 100644 index 00000000..013e0b8b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-classic-link-dns-support.rst @@ -0,0 +1,22 @@ +**To describe ClassicLink DNS support for your VPCs** + +This example describes the ClassicLink DNS support status of all of your VPCs. + +Command:: + + aws ec2 describe-vpc-classic-link-dns-support + +Output:: + + { + "Vpcs": [ + { + "VpcId": "vpc-88888888", + "ClassicLinkDnsSupported": true + }, + { + "VpcId": "vpc-1a2b3c4d", + "ClassicLinkDnsSupported": false + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-classic-link.rst b/aws/dist/awscli/examples/ec2/describe-vpc-classic-link.rst new file mode 100644 index 00000000..a38e1d19 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-classic-link.rst @@ -0,0 +1,30 @@ +**To describe the ClassicLink status of your VPCs** + +This example lists the ClassicLink status of vpc-88888888. + +Command:: + + aws ec2 describe-vpc-classic-link --vpc-id vpc-88888888 + +Output:: + + { + "Vpcs": [ + { + "ClassicLinkEnabled": true, + "VpcId": "vpc-88888888", + "Tags": [ + { + "Value": "classiclinkvpc", + "Key": "Name" + } + ] + } + ] + } + +This example lists only VPCs that are enabled for Classiclink (the filter value of ``is-classic-link-enabled`` is set to ``true``). + +Command:: + + aws ec2 describe-vpc-classic-link --filter "Name=is-classic-link-enabled,Values=true" diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst new file mode 100644 index 00000000..2bc4a57b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connection-notifications.rst @@ -0,0 +1,27 @@ +**To describe endpoint connection notifications** + +This example describe all of your endpoint connection notifications. + +Command:: + + aws ec2 describe-vpc-endpoint-connection-notifications + +Output:: + + { + "ConnectionNotificationSet": [ + { + "ConnectionNotificationState": "Enabled", + "ConnectionNotificationType": "Topic", + "ConnectionEvents": [ + "Accept", + "Reject", + "Delete", + "Connect" + ], + "ConnectionNotificationId": "vpce-nfn-04bcb952bc8af7abc", + "ConnectionNotificationArn": "arn:aws:sns:us-east-1:123456789012:VpceNotification", + "VpcEndpointId": "vpce-0324151a02f327123" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connections.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connections.rst new file mode 100644 index 00000000..41890970 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-connections.rst @@ -0,0 +1,21 @@ +**To describe VPC endpoint connections** + +This example describes the interface endpoint connections to your endpoint service and filters the results to display endpoints that are ``PendingAcceptance``. + +Command:: + + aws ec2 describe-vpc-endpoint-connections --filters Name=vpc-endpoint-state,Values=pendingAcceptance + +Output:: + + { + "VpcEndpointConnections": [ + { + "VpcEndpointId": "vpce-0abed31004e618123", + "ServiceId": "vpce-svc-0abced088d20def56", + "CreationTimestamp": "2017-11-30T10:00:24.350Z", + "VpcEndpointState": "pendingAcceptance", + "VpcEndpointOwner": "123456789012" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst new file mode 100644 index 00000000..6f73f850 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-configurations.rst @@ -0,0 +1,34 @@ +**To describe endpoint service configurations** + +This example describes your endpoint service configurations. + +Command:: + + aws ec2 describe-vpc-endpoint-service-configurations + +Output:: + + { + "ServiceConfigurations": [ + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "NetworkLoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/NLBforService/8218753950b25648" + ], + "ServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0e7555fb6441987e1", + "ServiceState": "Available", + "ServiceId": "vpce-svc-0e7555fb6441987e1", + "AcceptanceRequired": true, + "AvailabilityZones": [ + "us-east-1d" + ], + "BaseEndpointDnsNames": [ + "vpce-svc-0e7555fb6441987e1.us-east-1.vpce.amazonaws.com" + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst new file mode 100644 index 00000000..d947f601 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-service-permissions.rst @@ -0,0 +1,18 @@ +**To describe endpoint service permissions** + +This example describes the permissions for the specified endpoint service. + +Command:: + + aws ec2 describe-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 + +Output:: + + { + "AllowedPrincipals": [ + { + "PrincipalType": "Account", + "Principal": "arn:aws:iam::123456789012:root" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-services.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-services.rst new file mode 100644 index 00000000..5ccdf4c9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoint-services.rst @@ -0,0 +1,181 @@ +**To describe VPC endpoint services** + +This example describes all available endpoint services for the region. + +Command:: + + aws ec2 describe-vpc-endpoint-services + +Output:: + + { + "ServiceDetails": [ + { + "ServiceType": [ + { + "ServiceType": "Gateway" + } + ], + "AcceptanceRequired": false, + "ServiceName": "com.amazonaws.us-east-1.dynamodb", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "BaseEndpointDnsNames": [ + "dynamodb.us-east-1.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ec2.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ec2", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ec2.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ec2messages.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ec2messages", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ec2messages.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "elasticloadbalancing.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "elasticloadbalancing.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "kinesis.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.kinesis-streams", + "VpcEndpointPolicySupported": false, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "kinesis.us-east-1.vpce.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Gateway" + } + ], + "AcceptanceRequired": false, + "ServiceName": "com.amazonaws.us-east-1.s3", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e", + "us-east-1f" + ], + "BaseEndpointDnsNames": [ + "s3.us-east-1.amazonaws.com" + ] + }, + { + "ServiceType": [ + { + "ServiceType": "Interface" + } + ], + "PrivateDnsName": "ssm.us-east-1.amazonaws.com", + "ServiceName": "com.amazonaws.us-east-1.ssm", + "VpcEndpointPolicySupported": true, + "Owner": "amazon", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c", + "us-east-1d", + "us-east-1e" + ], + "AcceptanceRequired": false, + "BaseEndpointDnsNames": [ + "ssm.us-east-1.vpce.amazonaws.com" + ] + } + ], + "ServiceNames": [ + "com.amazonaws.us-east-1.dynamodb", + "com.amazonaws.us-east-1.ec2", + "com.amazonaws.us-east-1.ec2messages", + "com.amazonaws.us-east-1.elasticloadbalancing", + "com.amazonaws.us-east-1.kinesis-streams", + "com.amazonaws.us-east-1.s3", + "com.amazonaws.us-east-1.ssm" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-endpoints.rst b/aws/dist/awscli/examples/ec2/describe-vpc-endpoints.rst new file mode 100644 index 00000000..e296d2f2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-endpoints.rst @@ -0,0 +1,72 @@ +**To describe your VPC endpoints** + +The following ``describe-vpc-endpoints`` example displays details for all of your endpoints. :: + + aws ec2 describe-vpc-endpoints + +Output:: + + { + "VpcEndpoints": [ + { + "PolicyDocument": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"*\",\"Resource\":\"*\"}]}", + "VpcId": "vpc-aabb1122", + "NetworkInterfaceIds": [], + "SubnetIds": [], + "PrivateDnsEnabled": true, + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.dynamodb", + "RouteTableIds": [ + "rtb-3d560345" + ], + "Groups": [], + "VpcEndpointId": "vpce-032a826a", + "VpcEndpointType": "Gateway", + "CreationTimestamp": "2017-09-05T20:41:28Z", + "DnsEntries": [], + "OwnerId": "123456789012" + }, + { + "PolicyDocument": "{\n \"Statement\": [\n {\n \"Action\": \"*\", \n \"Effect\": \"Allow\", \n \"Principal\": \"*\", \n \"Resource\": \"*\"\n }\n ]\n}", + "VpcId": "vpc-1a2b3c4d", + "NetworkInterfaceIds": [ + "eni-2ec2b084", + "eni-1b4a65cf" + ], + "SubnetIds": [ + "subnet-d6fcaa8d", + "subnet-7b16de0c" + ], + "PrivateDnsEnabled": false, + "State": "available", + "ServiceName": "com.amazonaws.us-east-1.elasticloadbalancing", + "RouteTableIds": [], + "Groups": [ + { + "GroupName": "default", + "GroupId": "sg-54e8bf31" + } + ], + "VpcEndpointId": "vpce-0f89a33420c1931d7", + "VpcEndpointType": "Interface", + "CreationTimestamp": "2017-09-05T17:55:27.583Z", + "DnsEntries": [ + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + }, + { + "HostedZoneId": "Z7HUB22UULQXV", + "DnsName": "vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com" + } + ], + "OwnerId": "123456789012" + } + ] + } + +For more information, see `Modifying a Gateway Endpoint `__ in the *AWS VPC User Guide*. diff --git a/aws/dist/awscli/examples/ec2/describe-vpc-peering-connections.rst b/aws/dist/awscli/examples/ec2/describe-vpc-peering-connections.rst new file mode 100644 index 00000000..e34ea35b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpc-peering-connections.rst @@ -0,0 +1,87 @@ +**To describe your VPC peering connections** + +This example describes all of your VPC peering connections. + +Command:: + + aws ec2 describe-vpc-peering-connections + +Output:: + + { + "VpcPeeringConnections": [ + { + "Status": { + "Message": "Active", + "Code": "active" + }, + "Tags": [ + { + "Value": "Peering-1", + "Key": "Name" + } + ], + "AccepterVpcInfo": { + "OwnerId": "111122223333", + "VpcId": "vpc-1a2b3c4d", + "CidrBlock": "10.0.1.0/28" + }, + "VpcPeeringConnectionId": "pcx-11122233", + "RequesterVpcInfo": { + "PeeringOptions": { + "AllowEgressFromLocalVpcToRemoteClassicLink": false, + "AllowEgressFromLocalClassicLinkToRemoteVpc": false + }, + "OwnerId": "444455556666", + "VpcId": "vpc-123abc45", + "CidrBlock": "192.168.0.0/16" + } + }, + { + "Status": { + "Message": "Pending Acceptance by 444455556666", + "Code": "pending-acceptance" + }, + "Tags": [], + "RequesterVpcInfo": { + "PeeringOptions": { + "AllowEgressFromLocalVpcToRemoteClassicLink": false, + "AllowEgressFromLocalClassicLinkToRemoteVpc": false + }, + "OwnerId": "444455556666", + "VpcId": "vpc-11aa22bb", + "CidrBlock": "10.0.0.0/28" + }, + "VpcPeeringConnectionId": "pcx-abababab", + "ExpirationTime": "2014-04-03T09:12:43.000Z", + "AccepterVpcInfo": { + "OwnerId": "444455556666", + "VpcId": "vpc-33cc44dd" + } + } + ] + } + + +**To describe specific VPC peering connections** + +This example describes all of your VPC peering connections that are in the pending-acceptance state. + +Command:: + + aws ec2 describe-vpc-peering-connections --filters Name=status-code,Values=pending-acceptance + + +This example describes all of your VPC peering connections that have the tag Owner=Finance. + +Command:: + + aws ec2 describe-vpc-peering-connections --filters Name=tag:Owner,Values=Finance + + +This example describes all of the VPC peering connections you requested for the specified VPC, vpc-1a2b3c4d. + +Command:: + + aws ec2 describe-vpc-peering-connections --filters Name=requester-vpc-info.vpc-id,Values=vpc-1a2b3c4d + diff --git a/aws/dist/awscli/examples/ec2/describe-vpcs.rst b/aws/dist/awscli/examples/ec2/describe-vpcs.rst new file mode 100644 index 00000000..63cad86d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpcs.rst @@ -0,0 +1,98 @@ +**Example 1: To describe all of your VPCs** + +The following ``describe-vpcs`` example retrieves details about your VPCs. :: + + aws ec2 describe-vpcs + +Output:: + + { + "Vpcs": [ + { + "CidrBlock": "30.1.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-0e9801d129EXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-062c64cfafEXAMPLE", + "CidrBlock": "30.1.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Not Shared" + } + ] + }, + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "222222222222", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Shared VPC" + } + ] + } + ] + } + +**Example 2: To describe a specified VPC** + +The following ``describe-vpcs`` example retrieves details for the specified VPC. :: + + aws ec2 describe-vpcs \ + --vpc-ids vpc-06e4ab6c6cEXAMPLE + +Output:: + + { + "Vpcs": [ + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-19edf471", + "State": "available", + "VpcId": "vpc-06e4ab6c6cEXAMPLE", + "OwnerId": "111122223333", + "InstanceTenancy": "default", + "CidrBlockAssociationSet": [ + { + "AssociationId": "vpc-cidr-assoc-00b17b4eddEXAMPLE", + "CidrBlock": "10.0.0.0/16", + "CidrBlockState": { + "State": "associated" + } + } + ], + "IsDefault": false, + "Tags": [ + { + "Key": "Name", + "Value": "Shared VPC" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/describe-vpn-connections.rst b/aws/dist/awscli/examples/ec2/describe-vpn-connections.rst new file mode 100644 index 00000000..d7e7129b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpn-connections.rst @@ -0,0 +1,55 @@ +**To describe your VPN connections** + +This example describes your VPN connections. + +Command:: + + aws ec2 describe-vpn-connections + +Output:: + + { + "VpnConnections": { + "VpnConnectionId": "vpn-40f41529", + "Tags": [ + { + "Value": "MyBGPVPN", + "Key": "Name" + } + ], + "CustomerGatewayConfiguration": "...configuration information...", + "Routes": [], + "State": "available", + "VpnGatewayId": "vgw-9a4cacf3", + "CustomerGatewayId": "cgw-0e11f167", + "Type": "ipsec.1", + "Options": { + "StaticRoutesOnly": false + }, + "Category": "VPN", + "VgwTelemetry": [ + { + "Status": "DOWN", + "AcceptedRouteCount": 0, + "OutsideIpAddress": "72.21.209.192", + "LastStatusChange": "2013-02-04T20:19:34.000Z", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "Status": "DOWN", + "AcceptedRouteCount": 0, + "OutsideIpAddress": "72.21.209.224", + "LastStatusChange": "2013-02-04T20:19:34.000Z", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } + +**To describe your available VPN connections** + +This example describes your VPN connections with a state of ``available``. + +Command:: + + aws ec2 describe-vpn-connections --filters "Name=state,Values=available" diff --git a/aws/dist/awscli/examples/ec2/describe-vpn-gateways.rst b/aws/dist/awscli/examples/ec2/describe-vpn-gateways.rst new file mode 100644 index 00000000..3f031485 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/describe-vpn-gateways.rst @@ -0,0 +1,36 @@ +**To describe your virtual private gateways** + +This example describes your virtual private gateways. + +Command:: + + aws ec2 describe-vpn-gateways + +Output:: + + { + "VpnGateways": [ + { + "State": "available", + "Type": "ipsec.1", + "VpnGatewayId": "vgw-f211f09b", + "VpcAttachments": [ + { + "State": "attached", + "VpcId": "vpc-98eb5ef5" + } + ] + }, + { + "State": "available", + "Type": "ipsec.1", + "VpnGatewayId": "vgw-9a4cacf3", + "VpcAttachments": [ + { + "State": "attaching", + "VpcId": "vpc-a01106c2" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/detach-classic-link-vpc.rst b/aws/dist/awscli/examples/ec2/detach-classic-link-vpc.rst new file mode 100644 index 00000000..75213ee2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/detach-classic-link-vpc.rst @@ -0,0 +1,13 @@ +**To unlink (detach) an EC2-Classic instance from a VPC** + +This example unlinks instance i-0598c7d356eba48d7 from VPC vpc-88888888. + +Command:: + + aws ec2 detach-classic-link-vpc --instance-id i-0598c7d356eba48d7 --vpc-id vpc-88888888 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/detach-internet-gateway.rst b/aws/dist/awscli/examples/ec2/detach-internet-gateway.rst new file mode 100644 index 00000000..faf575b3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/detach-internet-gateway.rst @@ -0,0 +1,7 @@ +**To detach an Internet gateway from your VPC** + +This example detaches the specified Internet gateway from the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 detach-internet-gateway --internet-gateway-id igw-c0a643a9 --vpc-id vpc-a01106c2 diff --git a/aws/dist/awscli/examples/ec2/detach-network-interface.rst b/aws/dist/awscli/examples/ec2/detach-network-interface.rst new file mode 100644 index 00000000..4869e266 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/detach-network-interface.rst @@ -0,0 +1,7 @@ +**To detach a network interface from your instance** + +This example detaches the specified network interface from the specified instance. If the command succeeds, no output is returned. + +Command:: + + aws ec2 detach-network-interface --attachment-id eni-attach-66c4350a diff --git a/aws/dist/awscli/examples/ec2/detach-volume.rst b/aws/dist/awscli/examples/ec2/detach-volume.rst new file mode 100644 index 00000000..b7186492 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/detach-volume.rst @@ -0,0 +1,17 @@ +**To detach a volume from an instance** + +This example command detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to. + +Command:: + + aws ec2 detach-volume --volume-id vol-1234567890abcdef0 + +Output:: + + { + "AttachTime": "2014-02-27T19:23:06.000Z", + "InstanceId": "i-1234567890abcdef0", + "VolumeId": "vol-049df61146c4d7901", + "State": "detaching", + "Device": "/dev/sdb" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/detach-vpn-gateway.rst b/aws/dist/awscli/examples/ec2/detach-vpn-gateway.rst new file mode 100644 index 00000000..60f2070c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/detach-vpn-gateway.rst @@ -0,0 +1,7 @@ +**To detach a virtual private gateway from your VPC** + +This example detaches the specified virtual private gateway from the specified VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 detach-vpn-gateway --vpn-gateway-id vgw-9a4cacf3 --vpc-id vpc-a01106c2 diff --git a/aws/dist/awscli/examples/ec2/disable-ebs-encryption-by-default.rst b/aws/dist/awscli/examples/ec2/disable-ebs-encryption-by-default.rst new file mode 100644 index 00000000..2fc9fc01 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disable-ebs-encryption-by-default.rst @@ -0,0 +1,11 @@ +**To disable EBS encryption by default** + +The following ``disable-ebs-encryption-by-default`` example disables EBS encryption by default for your AWS account in the current Region. :: + + aws ec2 disable-ebs-encryption-by-default + +Output:: + + { + "EbsEncryptionByDefault": false + } diff --git a/aws/dist/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst b/aws/dist/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst new file mode 100644 index 00000000..12fd6b3e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disable-transit-gateway-route-table-propagation.rst @@ -0,0 +1,21 @@ +**To disable a transit gateway attachment to propagate routes to the specified propagation route table** + +The following ``disable-transit-gateway-route-table-propagation`` example disables the specified attachment to propagate routes to the specified propagation route table. :: + + aws ec2 disable-transit-gateway-route-table-propagation \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE + +Output:: + + { + "Propagation": { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", + "State": "disabled" + } + } + +For more information, see `Disable Route Table Propagation `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/disable-vgw-route-propagation.rst b/aws/dist/awscli/examples/ec2/disable-vgw-route-propagation.rst new file mode 100644 index 00000000..9fa3312f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disable-vgw-route-propagation.rst @@ -0,0 +1,7 @@ +**To disable route propagation** + +This example disables the specified virtual private gateway from propagating static routes to the specified route table. If the command succeeds, no output is returned. + +Command:: + + aws ec2 disable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 diff --git a/aws/dist/awscli/examples/ec2/disable-vpc-classic-link-dns-support.rst b/aws/dist/awscli/examples/ec2/disable-vpc-classic-link-dns-support.rst new file mode 100644 index 00000000..f92de6eb --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disable-vpc-classic-link-dns-support.rst @@ -0,0 +1,13 @@ +**To disable ClassicLink DNS support for a VPC** + +This example disables ClassicLink DNS support for ``vpc-88888888``. + +Command:: + + aws ec2 disable-vpc-classic-link-dns-support --vpc-id vpc-88888888 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/disable-vpc-classic-link.rst b/aws/dist/awscli/examples/ec2/disable-vpc-classic-link.rst new file mode 100644 index 00000000..937fb4f2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disable-vpc-classic-link.rst @@ -0,0 +1,13 @@ +**To disable ClassicLink for a VPC** + +This example disables ClassicLink for vpc-8888888. + +Command:: + + aws ec2 disable-vpc-classic-link --vpc-id vpc-88888888 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/disassociate-address.rst b/aws/dist/awscli/examples/ec2/disassociate-address.rst new file mode 100644 index 00000000..0dcabca6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-address.rst @@ -0,0 +1,15 @@ +**To disassociate an Elastic IP addresses in EC2-Classic** + +This example disassociates an Elastic IP address from an instance in EC2-Classic. If the command succeeds, no output is returned. + +Command:: + + aws ec2 disassociate-address --public-ip 198.51.100.0 + +**To disassociate an Elastic IP address in EC2-VPC** + +This example disassociates an Elastic IP address from an instance in a VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 disassociate-address --association-id eipassoc-2bebb745 diff --git a/aws/dist/awscli/examples/ec2/disassociate-client-vpn-target-network.rst b/aws/dist/awscli/examples/ec2/disassociate-client-vpn-target-network.rst new file mode 100644 index 00000000..495521f8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-client-vpn-target-network.rst @@ -0,0 +1,18 @@ +**To disassociate a network from a Client VPN endpoint** + +The following ``disassociate-client-vpn-target-network`` example disassociates the target network that's associated with the ``cvpn-assoc-12312312312312312`` association ID for the specified Client VPN endpoint. :: + + aws ec2 disassociate-client-vpn-target-network \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --association-id cvpn-assoc-12312312312312312 + +Output:: + + { + "AssociationId": "cvpn-assoc-12312312312312312", + "Status": { + "Code": "disassociating" + } + } + +For more information, see `Target Networks `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/disassociate-iam-instance-profile.rst b/aws/dist/awscli/examples/ec2/disassociate-iam-instance-profile.rst new file mode 100644 index 00000000..429e77c9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-iam-instance-profile.rst @@ -0,0 +1,21 @@ +**To disassociate an IAM instance profile** + +This example disassociates an IAM instance profile with the association ID ``iip-assoc-05020b59952902f5f``. + +Command:: + + aws ec2 disassociate-iam-instance-profile --association-id iip-assoc-05020b59952902f5f + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-123456789abcde123", + "State": "disassociating", + "AssociationId": "iip-assoc-05020b59952902f5f", + "IamInstanceProfile": { + "Id": "AIPAI5IVIHMFFYY2DKV5Y", + "Arn": "arn:aws:iam::123456789012:instance-profile/admin-role" + } + } + } diff --git a/aws/dist/awscli/examples/ec2/disassociate-route-table.rst b/aws/dist/awscli/examples/ec2/disassociate-route-table.rst new file mode 100644 index 00000000..2ca78830 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-route-table.rst @@ -0,0 +1,7 @@ +**To disassociate a route table** + +This example disassociates the specified route table from the specified subnet. If the command succeeds, no output is returned. + +Command:: + + aws ec2 disassociate-route-table --association-id rtbassoc-781d0d1a diff --git a/aws/dist/awscli/examples/ec2/disassociate-subnet-cidr-block.rst b/aws/dist/awscli/examples/ec2/disassociate-subnet-cidr-block.rst new file mode 100644 index 00000000..19a70601 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-subnet-cidr-block.rst @@ -0,0 +1,20 @@ +**To disassociate an IPv6 CIDR block from a subnet** + +This example disassociates an IPv6 CIDR block from a subnet using the association ID for the CIDR block. + +Command:: + + aws ec2 disassociate-subnet-cidr-block --association-id subnet-cidr-assoc-3aa54053 + +Output:: + + { + "SubnetId": "subnet-5f46ec3b", + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/64", + "AssociationId": "subnet-cidr-assoc-3aa54053", + "Ipv6CidrBlockState": { + "State": "disassociating" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst b/aws/dist/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst new file mode 100755 index 00000000..9040ca89 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-transit-gateway-route-table.rst @@ -0,0 +1,21 @@ +**To disassociate a transit gateway route table from a resource attachment** + +The following ``disassociate-transit-gateway-route-table`` example disasssociates the transit gateway route table from the specified attachment. :: + + aws ec2 disassociate-transit-gateway-route-table \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-08e0bc912cEXAMPLE + +Output:: + + { + "Association": { + "TransitGatewayRouteTableId": "tgw-rtb-002573ed1eEXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "disassociating" + } + } + +For more information, see `Delete an Association for a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/disassociate-vpc-cidr-block.rst b/aws/dist/awscli/examples/ec2/disassociate-vpc-cidr-block.rst new file mode 100644 index 00000000..32b6e70e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/disassociate-vpc-cidr-block.rst @@ -0,0 +1,41 @@ +**To disassociate an IPv6 CIDR block from a VPC** + +This example disassociates an IPv6 CIDR block from a VPC using the association ID for the CIDR block. + +Command:: + + aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-eca54085 + +Output:: + + { + "Ipv6CidrBlockAssociation": { + "Ipv6CidrBlock": "2001:db8:1234:1a00::/56", + "AssociationId": "vpc-cidr-assoc-eca54085", + "Ipv6CidrBlockState": { + "State": "disassociating" + } + }, + "VpcId": "vpc-a034d6c4" + } + +**To disassociate an IPv4 CIDR block from a VPC** + +This example disassociates an IPv4 CIDR block from a VPC. + +Command:: + + aws ec2 disassociate-vpc-cidr-block --association-id vpc-cidr-assoc-0287ac6b + +Output:: + + { + "CidrBlockAssociation": { + "AssociationId": "vpc-cidr-assoc-0287ac6b", + "CidrBlock": "172.18.0.0/16", + "CidrBlockState": { + "State": "disassociating" + } + }, + "VpcId": "vpc-27621243" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/enable-ebs-encryption-by-default.rst b/aws/dist/awscli/examples/ec2/enable-ebs-encryption-by-default.rst new file mode 100644 index 00000000..7747d3d1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-ebs-encryption-by-default.rst @@ -0,0 +1,11 @@ +**To enable EBS encryption by default** + +The following ``enable-ebs-encryption-by-default`` example enables EBS encryption by default for your AWS account in the current Region. :: + + aws ec2 enable-ebs-encryption-by-default + +Output:: + + { + "EbsEncryptionByDefault": true + } diff --git a/aws/dist/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst b/aws/dist/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst new file mode 100644 index 00000000..0db10242 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-transit-gateway-route-table-propagation.rst @@ -0,0 +1,21 @@ +**To enable a transit gateway attachment to propagate routes to the specified propagation route table** + +The following ``enable-transit-gateway-route-table-propagation`` example enables the specified attachment to propagate routes to the specified propagation route table. :: + + aws ec2 enable-transit-gateway-route-table-propagation \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE + +Output:: + + { + "Propagation": { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "TransitGatewayRouteTableId": "tgw-rtb-0a823edbdeEXAMPLE", + "State": "disabled" + } + } + +For more information, see `Propagate a Route to a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/enable-vgw-route-propagation.rst b/aws/dist/awscli/examples/ec2/enable-vgw-route-propagation.rst new file mode 100644 index 00000000..8890fb8e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-vgw-route-propagation.rst @@ -0,0 +1,7 @@ +**To enable route propagation** + +This example enables the specified virtual private gateway to propagate static routes to the specified route table. If the command succeeds, no output is returned. + +Command:: + + aws ec2 enable-vgw-route-propagation --route-table-id rtb-22574640 --gateway-id vgw-9a4cacf3 diff --git a/aws/dist/awscli/examples/ec2/enable-volume-io.rst b/aws/dist/awscli/examples/ec2/enable-volume-io.rst new file mode 100644 index 00000000..370fa8bc --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-volume-io.rst @@ -0,0 +1,13 @@ +**To enable I/O for a volume** + +This example enables I/O on volume ``vol-1234567890abcdef0``. + +Command:: + + aws ec2 enable-volume-io --volume-id vol-1234567890abcdef0 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/enable-vpc-classic-link-dns-support.rst b/aws/dist/awscli/examples/ec2/enable-vpc-classic-link-dns-support.rst new file mode 100644 index 00000000..c9416eb2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-vpc-classic-link-dns-support.rst @@ -0,0 +1,13 @@ +**To enable ClassicLink DNS support for a VPC** + +This example enables ClassicLink DNS support for ``vpc-88888888``. + +Command:: + + aws ec2 enable-vpc-classic-link-dns-support --vpc-id vpc-88888888 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/enable-vpc-classic-link.rst b/aws/dist/awscli/examples/ec2/enable-vpc-classic-link.rst new file mode 100644 index 00000000..00f42c6c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/enable-vpc-classic-link.rst @@ -0,0 +1,13 @@ +**To enable a VPC for ClassicLink** + +This example enables vpc-8888888 for ClassicLink. + +Command:: + + aws ec2 enable-vpc-classic-link --vpc-id vpc-88888888 + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst b/aws/dist/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst new file mode 100644 index 00000000..5282bb4e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/export-client-vpn-client-certificate-revocation-list.rst @@ -0,0 +1,29 @@ +**To export a client certificate revocation list** + +The following ``export-client-vpn-client-certificate-revocation-list`` example exports the client certificate revocation list for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: + + aws ec2 export-client-vpn-client-certificate-revocation-list \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --output text + +Output:: + + -----BEGIN X509 CRL----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END X509 CRL----- + STATUS pending + +For more information, see `Client Certificate Revocation Lists `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/export-client-vpn-client-configuration.rst b/aws/dist/awscli/examples/ec2/export-client-vpn-client-configuration.rst new file mode 100644 index 00000000..697cd906 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/export-client-vpn-client-configuration.rst @@ -0,0 +1,43 @@ +**To export the client configuration** + +The following ``export-client-vpn-client-configuration`` example exports the client configuration for the specified Client VPN endpoint. In this example, the output is returned in text format to make it easier to read. :: + + aws ec2 export-client-vpn-client-configuration \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --output text + +Output:: + + client + dev tun + proto udp + remote cvpn-endpoint-123456789123abcde.prod.clientvpn.ap-south-1.amazonaws.com 443 + remote-random-hostname + resolv-retry infinite + nobind + persist-key + persist-tun + remote-cert-tls server + cipher AES-256-GCM + verb 3 + + -----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE----- + + reneg-sec 0 + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/export-image.rst b/aws/dist/awscli/examples/ec2/export-image.rst new file mode 100755 index 00000000..43ea48bd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/export-image.rst @@ -0,0 +1,24 @@ +**To export a VM from an AMI** + +The following ``export-image`` example exports the specified AMI to the specified bucket in the specified format. :: + + aws ec2 export-image \ + --image-id ami-1234567890abcdef0 \ + --disk-image-format VMDK \ + --s3-export-location S3Bucket=my-export-bucket,S3Prefix=exports/ + +Output:: + + { + "DiskImageFormat": "vmdk", + "ExportImageTaskId": "export-ami-1234567890abcdef0" + "ImageId": "ami-1234567890abcdef0", + "RoleName": "vmimport", + "Progress": "0", + "S3ExportLocation": { + "S3Bucket": "my-export-bucket", + "S3Prefix": "exports/" + }, + "Status": "active", + "StatusMessage": "validating" + } diff --git a/aws/dist/awscli/examples/ec2/get-capacity-reservation-usage.rst b/aws/dist/awscli/examples/ec2/get-capacity-reservation-usage.rst new file mode 100644 index 00000000..15dcffe3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-capacity-reservation-usage.rst @@ -0,0 +1,24 @@ +**To view capacity reservation usage across AWS accounts** + +The following ``get-capacity-reservation-usage`` example displays usage information for the specified capacity reservation. :: + + aws ec2 get-capacity-reservation-usage \ + --capacity-reservation-id cr-1234abcd56EXAMPLE + +Output:: + + { + "CapacityReservationId": "cr-1234abcd56EXAMPLE ", + "InstanceUsages": [ + { + "UsedInstanceCount": 1, + "AccountId": "123456789012" + } + ], + "AvailableInstanceCount": 4, + "TotalInstanceCount": 5, + "State": "active", + "InstanceType": "t2.medium" + } + +For more information, see `Viewing Shared Capacity Reservation Usage `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/get-console-output.rst b/aws/dist/awscli/examples/ec2/get-console-output.rst new file mode 100644 index 00000000..f3e82019 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-console-output.rst @@ -0,0 +1,36 @@ +**To get the console output** + +This example gets the console ouput for the specified Linux instance. + +Command:: + + aws ec2 get-console-output --instance-id i-1234567890abcdef0 + +Output:: + + { + "InstanceId": "i-1234567890abcdef0", + "Timestamp": "2013-07-25T21:23:53.000Z", + "Output": "..." + } + +**To get the latest console output** + +This example gets the latest console output for the specified instance. + +Command:: + + aws ec2 get-console-output --instance-id i-1234567890abcdef0 --latest --output text + + +Output:: + + i-1234567890abcdef0 [ 0.000000] Command line: root=LABEL=/ console=tty1 console=ttyS0 selinux=0 nvme_core.io_timeout=4294967295 + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x001: 'x87 floating point registers' + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x002: 'SSE registers' + [ 0.000000] x86/fpu: Supporting XSAVE feature 0x004: 'AVX registers' + ... + Cloud-init v. 0.7.6 finished at Wed, 09 May 2018 19:01:13 +0000. Datasource DataSourceEc2. Up 21.50 seconds + Amazon Linux AMI release 2018.03 + Kernel 4.14.26-46.32.amzn1.x86_64 on an x86_64 + 2018-05-09T19:07:01.000Z \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/get-console-screenshot.rst b/aws/dist/awscli/examples/ec2/get-console-screenshot.rst new file mode 100755 index 00000000..c2be0e5c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-console-screenshot.rst @@ -0,0 +1,13 @@ +**To retrieve a screenshot of a running instance** + +The following ``get-console-screenshot`` example retrieves a screenshot of the specified instance in .jpg format. The screenshot is returned as a Base64-encoded string. :: + + aws ec2 get-console-screenshot \ + --instance-id i-1234567890abcdef0 + +Output:: + + { + "ImageData": "997987/8kgj49ikjhewkwwe0008084EXAMPLE", + "InstanceId": "i-1234567890abcdef0" + } diff --git a/aws/dist/awscli/examples/ec2/get-ebs-default-kms-key-id.rst b/aws/dist/awscli/examples/ec2/get-ebs-default-kms-key-id.rst new file mode 100644 index 00000000..7fa0cd69 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-ebs-default-kms-key-id.rst @@ -0,0 +1,17 @@ +**To describe your default CMK for EBS encryption** + +The following ``get-ebs-default-kms-key-id`` example describes the default CMK for EBS encryption for your AWS account. :: + + aws ec2 get-ebs-default-kms-key-id + +The output shows the default CMK for EBS encryption, which is an AWS managed CMK with the alias ``alias/aws/ebs``. :: + + { + "KmsKeyId": "alias/aws/ebs" + } + +The following output shows a custom CMK for EBS encryption. :: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" + } diff --git a/aws/dist/awscli/examples/ec2/get-ebs-encryption-by-default.rst b/aws/dist/awscli/examples/ec2/get-ebs-encryption-by-default.rst new file mode 100644 index 00000000..739e5f27 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-ebs-encryption-by-default.rst @@ -0,0 +1,17 @@ +**To describe whether EBS encryption by default is enabled** + +The following ``get-ebs-encryption-by-default`` example indicates whether EBS encryption by default is enabled for your AWS account in the current Region. :: + + aws ec2 get-ebs-encryption-by-default + +The following output indicates that EBS encryption by default is disabled. :: + + { + "EbsEncryptionByDefault": false + } + +The following output indicates that EBS encryption by default is enabled. :: + + { + "EbsEncryptionByDefault": true + } diff --git a/aws/dist/awscli/examples/ec2/get-host-reservation-purchase-preview.rst b/aws/dist/awscli/examples/ec2/get-host-reservation-purchase-preview.rst new file mode 100644 index 00000000..22566bec --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-host-reservation-purchase-preview.rst @@ -0,0 +1,26 @@ +**To get a purchase preview for a Dedicated Host Reservation** + +This example provides a preview of the costs for a specified Dedicated Host Reservation for the specified Dedicated Host in your account. + +Command:: + + aws ec2 get-host-reservation-purchase-preview --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 + +Output:: + + { + "TotalHourlyPrice": "1.499", + "Purchase": [ + { + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ], + "TotalUpfrontPrice": "0.000" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/get-launch-template-data.rst b/aws/dist/awscli/examples/ec2/get-launch-template-data.rst new file mode 100644 index 00000000..ae493dc6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-launch-template-data.rst @@ -0,0 +1,51 @@ +**To get instance data for a launch template** + +This example gets data about the specified instance and uses the ``--query`` option to return the contents in ``LaunchTemplateData``. You can use the output as a base to create a new launch template or launch template version. + +Command:: + + aws ec2 get-launch-template-data --instance-id i-0123d646e8048babc --query 'LaunchTemplateData' + +Output:: + + { + "Monitoring": {}, + "ImageId": "ami-8c1be5f6", + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/xvda", + "Ebs": { + "DeleteOnTermination": true + } + } + ], + "EbsOptimized": false, + "Placement": { + "Tenancy": "default", + "GroupName": "", + "AvailabilityZone": "us-east-1a" + }, + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Description": "", + "NetworkInterfaceId": "eni-35306abc", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.0.72" + } + ], + "SubnetId": "subnet-7b16de0c", + "Groups": [ + "sg-7c227019" + ], + "Ipv6Addresses": [ + { + "Ipv6Address": "2001:db8:1234:1a00::123" + } + ], + "PrivateIpAddress": "10.0.0.72" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/get-password-data.rst b/aws/dist/awscli/examples/ec2/get-password-data.rst new file mode 100644 index 00000000..29cb4461 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-password-data.rst @@ -0,0 +1,36 @@ +**To get the encrypted password** + +This example gets the encrypted password. + +Command:: + + aws ec2 get-password-data --instance-id i-1234567890abcdef0 + +Output:: + + { + "InstanceId": "i-1234567890abcdef0", + "Timestamp": "2013-08-07T22:18:38.000Z", + "PasswordData": "gSlJFq+VpcZXqy+iktxMF6NyxQ4qCrT4+gaOuNOenX1MmgXPTj7XEXAMPLE + UQ+YeFfb+L1U4C4AKv652Ux1iRB3CPTYP7WmU3TUnhsuBd+p6LVk7T2lKUml6OXbk6WPW1VYYm/TRPB1 + e1DQ7PY4an/DgZT4mwcpRFigzhniQgDDeO1InvSDcwoUTwNs0Y1S8ouri2W4n5GNlriM3Q0AnNVelVz/ + 53TkDtxbNoU606M1gK9zUWSxqEgwvbV2j8c5rP0WCuaMWSFl4ziDu4bd7q+4RSyi8NUsVWnKZ4aEZffu + DPGzKrF5yLlf3etP2L4ZR6CvG7K1hx7VKOQVN32Dajw==" + } + +**To get the decrypted password** + +This example gets the decrypted password. + +Command:: + + aws ec2 get-password-data --instance-id i-1234567890abcdef0 --priv-launch-key C:\Keys\MyKeyPair.pem + +Output:: + + { + "InstanceId": "i-1234567890abcdef0", + "Timestamp": "2013-08-30T23:18:05.000Z", + "PasswordData": "&ViJ652e*u" + } + diff --git a/aws/dist/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst b/aws/dist/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst new file mode 100644 index 00000000..a5f3be19 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-reserved-instances-exchange-quote.rst @@ -0,0 +1,49 @@ +**To get a quote for exchanging a Convertible Reserved Instance** + +This example gets the exchange information for the specified Convertible Reserved Instances. + +Command:: + + aws ec2 get-reserved-instances-exchange-quote --reserved-instance-ids 7b8750c3-397e-4da4-bbcb-a45ebexample --target-configurations OfferingId=6fea5434-b379-434c-b07b-a7abexample + +Output:: + + { + "CurrencyCode": "USD", + "ReservedInstanceValueSet": [ + { + "ReservedInstanceId": "7b8750c3-397e-4da4-bbcb-a45ebexample", + "ReservationValue": { + "RemainingUpfrontValue": "0.000000", + "HourlyPrice": "0.027800", + "RemainingTotalValue": "730.556200" + } + } + ], + "PaymentDue": "424.983828", + "TargetConfigurationValueSet": [ + { + "TargetConfiguration": { + "InstanceCount": 5, + "OfferingId": "6fea5434-b379-434c-b07b-a7abexample" + }, + "ReservationValue": { + "RemainingUpfrontValue": "424.983828", + "HourlyPrice": "0.016000", + "RemainingTotalValue": "845.447828" + } + } + ], + "IsValidExchange": true, + "OutputReservedInstancesWillExpireAt": "2020-10-01T13:03:39Z", + "ReservedInstanceValueRollup": { + "RemainingUpfrontValue": "0.000000", + "HourlyPrice": "0.027800", + "RemainingTotalValue": "730.556200" + }, + "TargetConfigurationValueRollup": { + "RemainingUpfrontValue": "424.983828", + "HourlyPrice": "0.016000", + "RemainingTotalValue": "845.447828" + } + } diff --git a/aws/dist/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst b/aws/dist/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst new file mode 100755 index 00000000..550b6565 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-transit-gateway-attachment-propagations.rst @@ -0,0 +1,19 @@ +**To list the route tables to which the specified resource attachment propagates routes** + +The following ``get-transit-gateway-attachment-propagations`` example lists the route table to which the specified resource attachment propagates routes. :: + + aws ec2 get-transit-gateway-attachment-propagations \ + --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE + +Output:: + + { + "TransitGatewayAttachmentPropagations": [ + { + "TransitGatewayRouteTableId": "tgw-rtb-0882c61b97EXAMPLE", + "State": "enabled" + } + ] + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst b/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst new file mode 100644 index 00000000..ec04604e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-associations.rst @@ -0,0 +1,21 @@ +**To get information about the associations for the specified transit gateway route table** + +The following ``get-transit-gateway-route-table-associations`` example displays information about the associations for the specified transit gateway route table. :: + + aws ec2 get-transit-gateway-route-table-associations \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE + +Output:: + + { + "Associations": [ + { + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceId": "vpc-4d7de228", + "ResourceType": "vpc", + "State": "associating" + } + ] + } + +For more information, see `Associate a Transit Gateway Route Table `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst b/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst new file mode 100755 index 00000000..e63fb72f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/get-transit-gateway-route-table-propagations.rst @@ -0,0 +1,33 @@ +**To display information about the route table propagations for the specified transit gateway route table** + + The following ``get-transit-gateway-route-table-propagations`` example returns the route table propagations for the specified route table. :: + + ec2 get-transit-gateway-route-table-propagations \ + --transit-gateway-route-table-id tgw-rtb-002573ed1eEXAMPLE + +Output:: + + { + "TransitGatewayRouteTablePropagations": [ + { + "TransitGatewayAttachmentId": "tgw-attach-01f8100bc7EXAMPLE", + "ResourceId": "vpc-3EXAMPLE", + "ResourceType": "vpc", + "State": "enabled" + }, + { + "TransitGatewayAttachmentId": "tgw-attach-08e0bc912cEXAMPLE", + "ResourceId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "enabled" + }, + { + "TransitGatewayAttachmentId": "tgw-attach-0a89069f57EXAMPLE", + "ResourceId": "8384da05-13ce-4a91-aada-5a1baEXAMPLE", + "ResourceType": "direct-connect-gateway", + "State": "enabled" + } + ] + } + +For more information, see `View Transit Gateway Route Table Propagations`__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst b/aws/dist/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst new file mode 100644 index 00000000..8a4b8621 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/import-client-vpn-client-certificate-revocation-list.rst @@ -0,0 +1,15 @@ +**To import a client certificate revocation list** + +The following ``import-client-vpn-client-certificate-revocation-list`` example imports a client certificate revocation list to the Client VPN endpoint by specifying the location of the file on the local computer. :: + + aws ec2 import-client-vpn-client-certificate-revocation-list \ + --certificate-revocation-list file:///path/to/crl.pem \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde + +Output:: + + { + "Return": true + } + +For more information, see `Client Certificate Revocation Lists `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/import-image.rst b/aws/dist/awscli/examples/ec2/import-image.rst new file mode 100755 index 00000000..22042ce8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/import-image.rst @@ -0,0 +1,25 @@ +**To import a VM image file as an AMI** + +The following ``import-image`` example imports the specified OVA. :: + + aws ec2 import-image \ + --disk-containers Format=ova,UserBucket="{S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.ova}" + +Output:: + + { + "ImportTaskId": "import-ami-1234567890abcdef0", + "Progress": "2", + "SnapshotDetails": [ + { + "DiskImageSize": 0.0, + "Format": "ova", + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.ova" + } + } + ], + "Status": "active", + "StatusMessage": "pending" + } diff --git a/aws/dist/awscli/examples/ec2/import-key-pair.rst b/aws/dist/awscli/examples/ec2/import-key-pair.rst new file mode 100644 index 00000000..7a3a3c85 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/import-key-pair.rst @@ -0,0 +1,29 @@ +**To import a public key** + +First, generate a key pair with the tool of your choice. For example, use this ssh-keygen command: + +Command:: + + ssh-keygen -t rsa -C "my-key" -f ~/.ssh/my-key + +Output:: + + Generating public/private rsa key pair. + Enter passphrase (empty for no passphrase): + Enter same passphrase again: + Your identification has been saved in /home/ec2-user/.ssh/my-key. + Your public key has been saved in /home/ec2-user/.ssh/my-key.pub. + ... + +This example command imports the specified public key. + +Command:: + + aws ec2 import-key-pair --key-name "my-key" --public-key-material file://~/.ssh/my-key.pub + +Output:: + + { + "KeyName": "my-key", + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca" + } diff --git a/aws/dist/awscli/examples/ec2/import-snapshot.rst b/aws/dist/awscli/examples/ec2/import-snapshot.rst new file mode 100755 index 00000000..502ebfd6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/import-snapshot.rst @@ -0,0 +1,26 @@ +**To import a snapshot** + +The following ``import-snapshot`` example imports the specified disk as a snapshot. :: + + aws ec2 import-snapshot \ + --description "My server VMDK" \ + --disk-container Format=VMDK,UserBucket={S3Bucket=my-import-bucket,S3Key=vms/my-server-vm.vmdk} + +Output:: + + { + "Description": "My server VMDK", + "ImportTaskId": "import-snap-1234567890abcdef0", + "SnapshotTaskDetail": { + "Description": "My server VMDK", + "DiskImageSize": "0.0", + "Format": "VMDK", + "Progress": "3", + "Status": "active", + "StatusMessage": "pending" + "UserBucket": { + "S3Bucket": "my-import-bucket", + "S3Key": "vms/my-server-vm.vmdk" + } + } + } diff --git a/aws/dist/awscli/examples/ec2/modify-capacity-reservation.rst b/aws/dist/awscli/examples/ec2/modify-capacity-reservation.rst new file mode 100644 index 00000000..e1306bca --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-capacity-reservation.rst @@ -0,0 +1,24 @@ +**Example 1: To change the number of instances reserved by an existing capacity reservation** + +The following ``modify-capacity-reservation`` example changes the number of instances for which the capacity reservation reserves capacity. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --instance-count 5 + +Output:: + + { + "Return": true + } + +**Example 2: To change the end date and time for an existing capacity reservation** + +The following ``modify-capacity-reservation`` example modifies an existing capacity reservation to end at the specified date and time. :: + + aws ec2 modify-capacity-reservation \ + --capacity-reservation-id cr-1234abcd56EXAMPLE \ + --end-date-type limited \ + --end-date 2019-08-31T23:59:59Z + +For more information, see `Modifying a Capacity Reservation `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/modify-client-vpn-endpoint.rst b/aws/dist/awscli/examples/ec2/modify-client-vpn-endpoint.rst new file mode 100644 index 00000000..83b14ff8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-client-vpn-endpoint.rst @@ -0,0 +1,15 @@ +**To modify a Client VPN endpoint** + +The following ``modify-client-vpn-endpoint`` example enables client connection logging for the specified Client VPN endpoint. :: + + aws ec2 modify-client-vpn-endpoint \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --connection-log-options Enabled=true,CloudwatchLogGroup=ClientVPNLogs + +Output:: + + { + "Return": true + } + +For more information, see `Client VPN Endpoints `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst b/aws/dist/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst new file mode 100644 index 00000000..88a1df3b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-ebs-default-kms-key-id.rst @@ -0,0 +1,12 @@ +**To set your default CMK for EBS encryption** + +The following ``modify-ebs-default-kms-key-id`` example sets the specified CMK as the default CMK for EBS encryption for your AWS account in the current Region. :: + + aws ec2 modify-ebs-default-kms-key-id \ + --kms-key-id alias/my-cmk + +Output:: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/0ea3fef3-80a7-4778-9d8c-1c0c6EXAMPLE" + } diff --git a/aws/dist/awscli/examples/ec2/modify-fpga-image-attribute.rst b/aws/dist/awscli/examples/ec2/modify-fpga-image-attribute.rst new file mode 100644 index 00000000..1bf6867d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-fpga-image-attribute.rst @@ -0,0 +1,20 @@ +**To modify the attributes of an Amazon FPGA image** + +This example adds load permissions for account ID ``123456789012`` for the specified AFI. + +Command:: + + aws ec2 modify-fpga-image-attribute --attribute loadPermission --fpga-image-id afi-0d123e123bfc85abc --load-permission Add=[{UserId=123456789012} + +Output:: + + { + "FpgaImageAttribute": { + "FpgaImageId": "afi-0d123e123bfc85abc", + "LoadPermissions": [ + { + "UserId": "123456789012" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ec2/modify-hosts.rst b/aws/dist/awscli/examples/ec2/modify-hosts.rst new file mode 100644 index 00000000..737457d7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-hosts.rst @@ -0,0 +1,35 @@ +**Example 1: To enable auto-placement for a Dedicated Host** + +The following ``modify-hosts`` example enables auto-placement for a Dedicated Host so that it accepts any untargeted instance launches that match its instance type configuration. :: + + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --auto-placement on + +Output:: + + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } + +**Example 2: To enable host recovery for a Dedicated Host** + +The following ``modify-hosts`` example enables host recovery for the specified Dedicated Host. :: + + aws ec2 modify-hosts \ + --host-id h-06c2f189b4EXAMPLE \ + --host-recovery on + +Output:: + + { + "Successful": [ + "h-06c2f189b4EXAMPLE" + ], + "Unsuccessful": [] + } + +For more information, see `Modifying Dedicated Host Auto-Placement `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/modify-id-format.rst b/aws/dist/awscli/examples/ec2/modify-id-format.rst new file mode 100755 index 00000000..25ac5c63 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-id-format.rst @@ -0,0 +1,21 @@ +**To enable the longer ID format for a resource** + +The following ``modify-id-format`` example enables the longer ID format for the ``instance`` resource type. :: + + aws ec2 modify-id-format \ + --resource instance \ + --use-long-ids + +**To disable the longer ID format for a resource** + +The following ``modify-id-format`` example disables the longer ID format for the ``instance`` resource type. :: + + aws ec2 modify-id-format \ + --resource instance \ + --no-use-long-ids + +The following ``modify-id-format`` example enables the longer ID format for all supported resource types that are within their opt-in period. :: + + aws ec2 modify-id-format \ + --resource all-current \ + --use-long-ids diff --git a/aws/dist/awscli/examples/ec2/modify-identity-id-format.rst b/aws/dist/awscli/examples/ec2/modify-identity-id-format.rst new file mode 100755 index 00000000..76c4399f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-identity-id-format.rst @@ -0,0 +1,24 @@ +**To enable an IAM role to use longer IDs for a resource** + +The following ``modify-identity-id-format`` example enables the IAM role ``EC2Role`` in your AWS account to use long ID format for the ``instance`` resource type. :: + + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:role/EC2Role \ + --resource instance \ + --use-long-ids + +**To enable an IAM user to use longer IDs for a resource** + +The following ``modify-identity-id-format`` example enables the IAM user ``AdminUser`` in your AWS account to use the longer ID format for the ``volume`` resource type. :: + + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource volume \ + --use-long-ids + +The following ``modify-identity-id-format`` example enables the IAM user ``AdminUser`` in your AWS account to use the longer ID format for all supported resource types that are within their opt-in period. :: + + aws ec2 modify-identity-id-format \ + --principal-arn arn:aws:iam::123456789012:user/AdminUser \ + --resource all-current \ + --use-long-ids diff --git a/aws/dist/awscli/examples/ec2/modify-image-attribute.rst b/aws/dist/awscli/examples/ec2/modify-image-attribute.rst new file mode 100644 index 00000000..5358aeb8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-image-attribute.rst @@ -0,0 +1,38 @@ +**Example 1: To make an AMI public** + +The following ``modify-instance-attribute`` example makes the specified AMI public. :: + + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Add=[{Group=all}]" + +This command produces no output. + +**Example 2: To make an AMI private** + +The following ``modify-instance-attribute`` example makes the specified AMI private. :: + + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Remove=[{Group=all}]" + +This command produces no output. + +**Example 3: To grant launch permission to an AWS account** + +The following ``modify-instance-attribute`` example grants launch permissions to the specified AWS account. :: + + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Add=[{UserId=123456789012}]" + +This command produces no output. + +**Example 4: To remove launch permission from an AWS account** + +The following ``modify-instance-attribute`` example removes launch permissions from the specified AWS account. :: + + aws ec2 modify-image-attribute \ + --image-id ami-5731123e \ + --launch-permission "Remove=[{UserId=123456789012}]" + diff --git a/aws/dist/awscli/examples/ec2/modify-instance-attribute.rst b/aws/dist/awscli/examples/ec2/modify-instance-attribute.rst new file mode 100644 index 00000000..366b8ba6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-instance-attribute.rst @@ -0,0 +1,78 @@ +**Example 1: To modify the instance type** + +The following ``modify-instance-attribute`` example modifies the instance type of the specified instance. The instance must be in the ``stopped`` state. :: + + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --instance-type "{\"Value\": \"m1.small\"}" + +This command produces no output. + +**Example 2: To enable enhanced networking on an instance** + +The following ``modify-instance-attribute`` example enables enhanced networking for the specified instance. The instance must be in the ``stopped`` state. :: + + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --sriov-net-support simple + +This command produces no output. + +**Example 3: To modify the sourceDestCheck attribute** + +The following ``modify-instance-attribute`` example sets the ``sourceDestCheck`` attribute of the specified instance to ``true``. The instance must be in a VPC. :: + + aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --source-dest-check "{\"Value\": true}" + +This command produces no output. + +**Example 4: To modify the deleteOnTermination attribute of the root volume** + +The following ``modify-instance-attribute`` example sets the ``deleteOnTermination`` attribute for the root volume of the specified Amazon EBS-backed instance to ``false``. By default, this attribute is ``true`` for the root volume. + +Command:: + + aws ec2 modify-instance-attribute \ + --instance-id i-1234567890abcdef0 \ + --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\",\"Ebs\":{\"DeleteOnTermination\":false}}]" + +This command produces no output. + +**Example 5: To modify the user data attached to an instance** + +The following ``modify-instance-attribute`` example adds the contents of the file ``UserData.txt`` as the UserData for the specified instance. + +Contents of original file ``UserData.txt``:: + + #!/bin/bash + yum update -y + service httpd start + chkconfig httpd on + +The contents of the file must be base64 encoded. The first command converts the text file to base64 and saves it as a new file. + +Linux/macOS version of the command:: + + base64 UserData.txt > UserData.base64.txt + +This command produces no output. + +Windows version of the command:: + + certutil -encode UserData.txt tmp.b64 && findstr /v /c:- tmp.b64 > UserData.base64.txt + +Output:: + + Input Length = 67 + Output Length = 152 + CertUtil: -encode command completed successfully. + +Now you can reference that file in the CLI command that follows:: + + aws ec2 modify-instance-attribute \ + --instance-id=i-09b5a14dbca622e76 \ + --attribute userData --value file://UserData.base64.txt + +This command produces no output. + +For more information, see `User Data and the AWS CLI `__ in the *EC2 User Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst b/aws/dist/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst new file mode 100644 index 00000000..7d08f585 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-instance-capacity-reservation-attributes.rst @@ -0,0 +1,29 @@ +**Example 1: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance to target a specific capacity reservation. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationTarget={CapacityReservationId= cr-1234abcd56EXAMPLE }' + +Output:: + + { + "Return": true + } + +**Example 2: To modify an instance's capacity reservation targeting settings** + +The following ``modify-instance-capacity-reservation-attributes`` example modifies a stopped instance that targets the specified capacity reservation to launch in any capacity reservation that has matching attributes (instance type, platform, Availability Zone) and that has open instance matching criteria. :: + + aws ec2 modify-instance-capacity-reservation-attributes \ + --instance-id i-EXAMPLE8765abcd4e \ + --capacity-reservation-specification 'CapacityReservationPreference=open' + +Output:: + + { + "Return": true + } + +For more information, see `Modifying an Instance's Capacity Reservation Settings `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/modify-instance-credit-specification.rst b/aws/dist/awscli/examples/ec2/modify-instance-credit-specification.rst new file mode 100644 index 00000000..e3670a1a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-instance-credit-specification.rst @@ -0,0 +1,18 @@ +**To modify the credit option for CPU usage of an instance** + +This example modifies the credit option for CPU usage of the specified instance in the specified region to "unlimited". Valid credit options are "standard" and "unlimited". + +Command:: + + aws ec2 modify-instance-credit-specification --instance-credit-specification "InstanceId=i-1234567890abcdef0,CpuCredits=unlimited" + +Output:: + + { + "SuccessfulInstanceCreditSpecifications": [ + { + "InstanceId": "i-1234567890abcdef0" + } + ], + "UnsuccessfulInstanceCreditSpecifications": [] + } diff --git a/aws/dist/awscli/examples/ec2/modify-instance-event-start-time.rst b/aws/dist/awscli/examples/ec2/modify-instance-event-start-time.rst new file mode 100644 index 00000000..ca49562b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-instance-event-start-time.rst @@ -0,0 +1,20 @@ +**To modify the event start time for an instance** + +The following ``modify-instance-event-start-time`` command shows how to modify the event start time for the specified instance. Specify the event ID by using the ``--instance-event-id`` parameter. Specify the new date and time by using the ``--not-before`` parameter. :: + + aws ec2 modify-instance-event-start-time --instance-id i-1234567890abcdef0 --instance-event-id instance-event-0abcdef1234567890 --not-before 2019-03-25T10:00:00.000 + +Output:: + + "Event": { + "InstanceEventId": "instance-event-0abcdef1234567890", + "Code": "system-reboot", + "Description": "scheduled reboot", + "NotAfter": "2019-03-25T12:00:00.000Z", + "NotBefore": "2019-03-25T10:00:00.000Z", + "NotBeforeDeadline": "2019-04-22T21:00:00.000Z" + } + +For more information, see `Working with Instances Scheduled for Reboot`_ in the *Amazon Elastic Compute Cloud User Guide* + +.. _`Working with Instances Scheduled for Reboot`: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html#schedevents_actions_reboot diff --git a/aws/dist/awscli/examples/ec2/modify-instance-placement.rst b/aws/dist/awscli/examples/ec2/modify-instance-placement.rst new file mode 100644 index 00000000..f145ffa4 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-instance-placement.rst @@ -0,0 +1,62 @@ +**Example 1: To remove an instance's affinity with a Dedicated Host** + +The following ``modify-instance-placement`` example removes an instance's affinity with a Dedicated Host and enables it to launch on any available Dedicated Host in your account that supports its instance type. :: + + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity default + +Output:: + + { + "Return": true + } + +**Example 2: To establish affinity between an instance and the specified Dedicated Host** + +The following ``modify-instance-placement`` example establishes a launch relationship between an instance and a Dedicated Host. The instance is only able to run on the specified Dedicated Host. :: + + aws ec2 modify-instance-placement \ + --instance-id i-0e6ddf6187EXAMPLE \ + --affinity host \ + --host-id i-0e6ddf6187EXAMPLE + +Output:: + + { + "Return": true + } + +For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. + +**Example 3: To move an instance to a placement group** + +To move an instance to a placement group, stop the instance, modify the instance placement, and then restart the instance. :: + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name MySpreadGroup + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +For more information, see `Changing the Placement Group for an Instance `__ in the *Amazon Elastic Compute Cloud Users Guide*. + +**Example 4: To remove an instance from a placement group** + +To remove an instance from a placement group, stop the instance, modify the instance placement, and then restart the instance. The following example specifies an empty string (" ") for the placement group name to indicate that the instance is not to be located in a placement group. + + aws ec2 stop-instances \ + --instance-ids i-0123a456700123456 + + aws ec2 modify-instance-placement \ + --instance-id i-0123a456700123456 \ + --group-name " " + + aws ec2 start-instances \ + --instance-ids i-0123a456700123456 + +For more information, see `Modifying Instance Tenancy and Affinity `__ in the *Amazon Elastic Compute Cloud User Guide for Linux Instances*. diff --git a/aws/dist/awscli/examples/ec2/modify-launch-template.rst b/aws/dist/awscli/examples/ec2/modify-launch-template.rst new file mode 100644 index 00000000..95264cd7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-launch-template.rst @@ -0,0 +1,20 @@ +**To change the default launch template version** + +This example specifies version 2 of the specified launch template as the default version. + +Command:: + + aws ec2 modify-launch-template --launch-template-id lt-0abcd290751193123 --default-version 2 + +Output:: + + { + "LaunchTemplate": { + "LatestVersionNumber": 2, + "LaunchTemplateId": "lt-0abcd290751193123", + "LaunchTemplateName": "WebServers", + "DefaultVersionNumber": 2, + "CreatedBy": "arn:aws:iam::123456789012:root", + "CreateTime": "2017-12-01T13:35:46.000Z" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-network-interface-attribute.rst b/aws/dist/awscli/examples/ec2/modify-network-interface-attribute.rst new file mode 100644 index 00000000..3987f752 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-network-interface-attribute.rst @@ -0,0 +1,34 @@ +**To modify the attachment attribute of a network interface** + +This example command modifies the ``attachment`` attribute of the specified network interface. + +Command:: + + aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --attachment AttachmentId=eni-attach-43348162,DeleteOnTermination=false + + +**To modify the description attribute of a network interface** + +This example command modifies the ``description`` attribute of the specified network interface. + +Command:: + + aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --description "My description" + + +**To modify the groupSet attribute of a network interface** + +This example command modifies the ``groupSet`` attribute of the specified network interface. + +Command:: + + aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --groups sg-903004f8 sg-1a2b3c4d + + +**To modify the sourceDestCheck attribute of a network interface** + +This example command modifies the ``sourceDestCheck`` attribute of the specified network interface. + +Command:: + + aws ec2 modify-network-interface-attribute --network-interface-id eni-686ea200 --no-source-dest-check diff --git a/aws/dist/awscli/examples/ec2/modify-reserved-instances.rst b/aws/dist/awscli/examples/ec2/modify-reserved-instances.rst new file mode 100644 index 00000000..e33944a6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-reserved-instances.rst @@ -0,0 +1,50 @@ +**To modify Reserved Instances** + +This example command moves a Reserved Instance to another Availability Zone in the same region. + +Command:: + + aws ec2 modify-reserved-instances --reserved-instances-ids b847fa93-e282-4f55-b59a-1342f5bd7c02 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=10 + +Output:: + + { + "ReservedInstancesModificationId": "rimod-d3ed4335-b1d3-4de6-ab31-0f13aaf46687" + } + + +**To modify the network platform of Reserved Instances** + +This example command converts EC2-Classic Reserved Instances to EC2-VPC. + +Command:: + + aws ec2 modify-reserved-instances --reserved-instances-ids f127bd27-edb7-44c9-a0eb-0d7e09259af0 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-VPC,InstanceCount=5 + +Output:: + + { + "ReservedInstancesModificationId": "rimod-82fa9020-668f-4fb6-945d-61537009d291" + } + +For more information, see `Modifying Your Reserved Instances`_ in the *Amazon EC2 User Guide*. + +**To modify the instance size of Reserved Instances** + +This example command modifies a Reserved Instance that has 10 m1.small Linux/UNIX instances in us-west-1c so that 8 +m1.small instances become 2 m1.large instances, and the remaining 2 m1.small become 1 m1.medium instance in the same +Availability Zone. Command:: + + aws ec2 modify-reserved-instances --reserved-instances-ids 1ba8e2e3-3556-4264-949e-63ee671405a9 --target-configurations AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=2,InstanceType=m1.large AvailabilityZone=us-west-1c,Platform=EC2-Classic,InstanceCount=1,InstanceType=m1.medium + +Output:: + + { + "ReservedInstancesModificationId": "rimod-acc5f240-080d-4717-b3e3-1c6b11fa00b6" + } + +For more information, see `Modifying the Instance Size of Your Reservations`_ in the *Amazon EC2 User Guide*. + +.. _`Modifying the Instance Size of Your Reservations`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modification-instancemove.html +.. _`Modifying Your Reserved Instances`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html + diff --git a/aws/dist/awscli/examples/ec2/modify-snapshot-attribute.rst b/aws/dist/awscli/examples/ec2/modify-snapshot-attribute.rst new file mode 100644 index 00000000..37ff9c93 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-snapshot-attribute.rst @@ -0,0 +1,19 @@ +**Example 1: To modify a snapshot attribute** + +The following ``modify-snapshot-attribute`` example updates the ``createVolumePermission`` attribute for the specified snapshot, removing volume permissions for the specified user. :: + + aws ec2 modify-snapshot-attribute \ + --snapshot-id snap-1234567890abcdef0 \ + --attribute createVolumePermission \ + --operation-type remove \ + --user-ids 123456789012 + +**Example 2: To make a snapshot public** + +The following ``modify-snapshot-attribute`` example makes the specified snapshot public. :: + + aws ec2 modify-snapshot-attribute \ + --snapshot-id snap-1234567890abcdef0 \ + --attribute createVolumePermission \ + --operation-type add \ + --group-names all diff --git a/aws/dist/awscli/examples/ec2/modify-spot-fleet-request.rst b/aws/dist/awscli/examples/ec2/modify-spot-fleet-request.rst new file mode 100644 index 00000000..b8ff703e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-spot-fleet-request.rst @@ -0,0 +1,25 @@ +**To modify a Spot fleet request** + +This example command updates the target capacity of the specified Spot fleet request. + +Command:: + + aws ec2 modify-spot-fleet-request --target-capacity 20 --spot-fleet-request-id sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE + +Output:: + + { + "Return": true + } + +This example command decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result. + +Command:: + + aws ec2 modify-spot-fleet-request --target-capacity 10 --excess-capacity-termination-policy NoTermination --spot-fleet-request-ids sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE + +Output:: + + { + "Return": true + } diff --git a/aws/dist/awscli/examples/ec2/modify-subnet-attribute.rst b/aws/dist/awscli/examples/ec2/modify-subnet-attribute.rst new file mode 100644 index 00000000..a36164fd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-subnet-attribute.rst @@ -0,0 +1,19 @@ +**To change a subnet's public IPv4 addressing behavior** + +This example modifies subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned a public IPv4 address. If the command succeeds, no output is returned. + +Command:: + + aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --map-public-ip-on-launch + +**To change a subnet's IPv6 addressing behavior** + +This example modifies subnet-1a2b3c4d to specify that all instances launched into this subnet are assigned an IPv6 address from the range of the subnet. + +Command:: + + aws ec2 modify-subnet-attribute --subnet-id subnet-1a2b3c4d --assign-ipv6-address-on-creation + +For more information, see `IP Addressing in Your VPC`_ in the *AWS Virtual Private Cloud User Guide*. + +.. _`IP Addressing in Your VPC`: http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-ip-addressing.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst new file mode 100755 index 00000000..5bce3874 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-network-services.rst @@ -0,0 +1,40 @@ +**To add network services to a Traffic Mirror filter** + +The following ``modify-traffic-mirror-filter-network-services`` example adds the Amazon DNS network services to the specified filter. :: + + aws ec2 modify-traffic-mirror-filter-network-services \ + --traffic-mirror-filter-id tmf-04812ff784EXAMPLE \ + --add-network-service amazon-dns + +Output:: + + { + "TrafficMirrorFilter": { + "Tags": [ + { + "Key": "Name", + "Value": "Production" + } + ], + "EgressFilterRules": [], + "NetworkServices": [ + "amazon-dns" + ], + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "IngressFilterRules": [ + { + "SourceCidrBlock": "0.0.0.0/0", + "RuleNumber": 1, + "DestinationCidrBlock": "0.0.0.0/0", + "Description": "TCP Rule", + "Protocol": 6, + "TrafficDirection": "ingress", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "RuleAction": "accept", + "TrafficMirrorFilterRuleId": "tmf-04812ff784EXAMPLE" + } + ] + } + } + +For more information, see `Modify Traffic Mirror Filter Network Services `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst new file mode 100755 index 00000000..efecee2a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-filter-rule.rst @@ -0,0 +1,25 @@ +**To modify a traffic mirror filter rule** + +The following ``modify-traffic-mirror-filter-rule`` example modifies the description of the specified traffic mirror filter rule. :: + + aws ec2 modify-traffic-mirror-filter-rule \ + --traffic-mirror-filter-rule-id tmfr-0ca76e0e08EXAMPLE \ + --description "TCP Rule" + +Output:: + + { + "TrafficMirrorFilterRule": { + "TrafficMirrorFilterRuleId": "tmfr-0ca76e0e08EXAMPLE", + "TrafficMirrorFilterId": "tmf-0293f26e86EXAMPLE", + "TrafficDirection": "ingress", + "RuleNumber": 100, + "RuleAction": "accept", + "Protocol": 6, + "DestinationCidrBlock": "10.0.0.0/24", + "SourceCidrBlock": "10.0.0.0/24", + "Description": "TCP Rule" + } + } + +For more information, see `Modify Your Traffic Mirror Filter Rules `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-traffic-mirror-session.rst b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-session.rst new file mode 100644 index 00000000..39c5ee6c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-traffic-mirror-session.rst @@ -0,0 +1,26 @@ +**To modify a Traffic Mirror Session** + +The following ``modify-traffic-mirror-session`` example changes the traffic mirror session description and the number of packets to mirror. :: + + aws ec2 modify-traffic-mirror-session \ + --description "Change packet length" \ + --traffic-mirror-session-id tms-08a33b1214EXAMPLE \ + --remove-fields "packet-length" + +Output:: + + { + "TrafficMirrorSession": { + "TrafficMirrorSessionId": "tms-08a33b1214EXAMPLE", + "TrafficMirrorTargetId": "tmt-07f75d8feeEXAMPLE", + "TrafficMirrorFilterId": "tmf-04812ff784EXAMPLE", + "NetworkInterfaceId": "eni-070203f901EXAMPLE", + "OwnerId": "111122223333", + "SessionNumber": 1, + "VirtualNetworkId": 7159709, + "Description": "Change packet length", + "Tags": [] + } + } + +For more information, see `Modify Your Traffic MIrror Session `__ in the *AWS Traffic Mirroring Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst b/aws/dist/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst new file mode 100644 index 00000000..1a5f20a8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-transit-gateway-vpc-attachment.rst @@ -0,0 +1,30 @@ +**To modify a transit gateway VPC attachment** + +The following ``modify-transit-gateway-vpc-attachment`` example adds a subnet to the specified transit gateway VPC attachment. :: + + aws ec2 modify-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-09fbd47ddfEXAMPLE \ + --add-subnet-ids subnet-0e51f45802EXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-09fbd47ddfEXAMPLE", + "TransitGatewayId": "tgw-0560315ccfEXAMPLE", + "VpcId": "vpc-5eccc927", + "VpcOwnerId": "111122223333", + "State": "modifying", + "SubnetIds": [ + "subnet-0e51f45802EXAMPLE", + "subnet-1EXAMPLE" + ], + "CreationTime": "2019-08-08T16:47:38.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/modify-volume-attribute.rst b/aws/dist/awscli/examples/ec2/modify-volume-attribute.rst new file mode 100644 index 00000000..4e6039dc --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-volume-attribute.rst @@ -0,0 +1,7 @@ +**To modify a volume attribute** + +This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 modify-volume-attribute --volume-id vol-1234567890abcdef0 --auto-enable-io diff --git a/aws/dist/awscli/examples/ec2/modify-volume.rst b/aws/dist/awscli/examples/ec2/modify-volume.rst new file mode 100644 index 00000000..98b982ed --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-volume.rst @@ -0,0 +1,51 @@ +**Example 1: To modify a volume by changing its size** + +The following ``modify-volume`` example changes the size of the specified volume to 150GB. + +Command:: + + aws ec2 modify-volume --size 150 --volume-id vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 150, + "TargetVolumeType": "io1", + "ModificationState": "modifying", + "VolumeId": " vol-1234567890abcdef0", + "TargetIops": 100, + "StartTime": "2019-05-17T11:27:19.000Z", + "Progress": 0, + "OriginalVolumeType": "io1", + "OriginalIops": 100, + "OriginalSize": 100 + } + } + +**Example 2: To modify a volume by changing its type, size, and IOPS value** + +The following ``modify-volume`` example changes the volume type to Provisioned IOPS SSD, sets the target IOPS rate to 10000, and sets the volume size to 350GB. :: + + aws ec2 modify-volume \ + --volume-type io1 \ + --iops 10000 \ + --size 350 \ + --volume-id vol-1234567890abcdef0 + +Output:: + + { + "VolumeModification": { + "TargetSize": 350, + "TargetVolumeType": "io1", + "ModificationState": "modifying", + "VolumeId": "vol-0721c1a9d08c93bf6", + "TargetIops": 10000, + "StartTime": "2019-05-17T11:38:57.000Z", + "Progress": 0, + "OriginalVolumeType": "gp2", + "OriginalIops": 150, + "OriginalSize": 50 + } + } diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-attribute.rst b/aws/dist/awscli/examples/ec2/modify-vpc-attribute.rst new file mode 100644 index 00000000..b2e583b6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-attribute.rst @@ -0,0 +1,15 @@ +**To modify the enableDnsSupport attribute** + +This example modifies the ``enableDnsSupport`` attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is ``true``, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. If the command succeeds, no output is returned. + +Command:: + + aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-support "{\"Value\":false}" + +**To modify the enableDnsHostnames attribute** + +This example modifies the ``enableDnsHostnames`` attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is ``true``, instances in the VPC get DNS hostnames; otherwise, they do not. If the command succeeds, no output is returned. + +Command:: + + aws ec2 modify-vpc-attribute --vpc-id vpc-a01106c2 --enable-dns-hostnames "{\"Value\":false}" diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst new file mode 100644 index 00000000..00ba7606 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-connection-notification.rst @@ -0,0 +1,13 @@ +**To modify an endpoint connection notification** + +This example changes the SNS topic for the specified endpoint connection notification. + +Command:: + + aws ec2 modify-vpc-endpoint-connection-notification --connection-notification-id vpce-nfn-008776de7e03f5abc --connection-events Accept Reject --connection-notification-arn arn:aws:sns:us-east-2:123456789012:mytopic + +Output:: + + { + "ReturnValue": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst new file mode 100644 index 00000000..ab64c040 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-configuration.rst @@ -0,0 +1,13 @@ +**To modify an endpoint service configuration** + +This example changes the acceptance requirement for the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-configuration --service-id vpce-svc-09222513e6e77dc86 --no-acceptance-required + +Output:: + + { + "ReturnValue": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst new file mode 100644 index 00000000..f34e343c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint-service-permissions.rst @@ -0,0 +1,19 @@ +**To modify endpoint service permissions** + +This example adds permission for an AWS account to connect to the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:root"]' + +Output:: + + { + "ReturnValue": true + } + +This example adds permission for a specific IAM user (``admin``) to connect to the specified endpoint service. + +Command:: + + aws ec2 modify-vpc-endpoint-service-permissions --service-id vpce-svc-03d5ebb7d9579a2b3 --add-allowed-principals '["arn:aws:iam::123456789012:user/admin"]' diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-endpoint.rst b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint.rst new file mode 100644 index 00000000..1fd6574e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-endpoint.rst @@ -0,0 +1,27 @@ +**To modify a gateway endpoint** + +This example modifies gateway endpoint ``vpce-1a2b3c4d`` by associating route table ``rtb-aaa222bb`` with the endpoint, and resetting the policy document. + +Command:: + + aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-1a2b3c4d --add-route-table-ids rtb-aaa222bb --reset-policy + +Output:: + + { + "Return": true + } + +**To modify an interface endpoint** + +This example modifies interface endpoint ``vpce-0fe5b17a0707d6fa5`` by adding subnet ``subnet-d6fcaa8d`` to the endpoint. + +Command:: + + aws ec2 modify-vpc-endpoint --vpc-endpoint-id vpce-0fe5b17a0707d6fa5 --add-subnet-id subnet-d6fcaa8d + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-peering-connection-options.rst b/aws/dist/awscli/examples/ec2/modify-vpc-peering-connection-options.rst new file mode 100644 index 00000000..41bc3e01 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-peering-connection-options.rst @@ -0,0 +1,47 @@ +**To enable communication over a VPC peering connection from your local ClassicLink connection** + +In this example, for peering connection ``pcx-aaaabbb``, the owner of the requester VPC modifies the VPC peering connection options to enable a local ClassicLink connection to communicate with the peer VPC. + +Command:: + + aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowEgressFromLocalClassicLinkToRemoteVpc=true + +Output:: + + { + "RequesterPeeringConnectionOptions": { + "AllowEgressFromLocalClassicLinkToRemoteVpc": true + } + } + +**To enable communication over a VPC peering connection from your local VPC to a remote ClassicLink connection** + +In this example, the owner of the accepter VPC modifies the VPC peering connection options to enable the local VPC to communicate with the ClassicLink connection in the peer VPC. + +Command:: + + aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --accepter-peering-connection-options AllowEgressFromLocalVpcToRemoteClassicLink=true + +Output:: + + { + "AccepterPeeringConnectionOptions": { + "AllowEgressFromLocalVpcToRemoteClassicLink": true + } + } + +**To enable DNS resolution support for the VPC peering connection** + +In this example, the owner of the requester VPC modifies the VPC peering connection options for ``pcx-aaaabbbb`` to enable the local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. + +Command:: + + aws ec2 modify-vpc-peering-connection-options --vpc-peering-connection-id pcx-aaaabbbb --requester-peering-connection-options AllowDnsResolutionFromRemoteVpc=true + +Output:: + + { + "RequesterPeeringConnectionOptions": { + "AllowDnsResolutionFromRemoteVpc": true + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-vpc-tenancy.rst b/aws/dist/awscli/examples/ec2/modify-vpc-tenancy.rst new file mode 100644 index 00000000..dabebfde --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpc-tenancy.rst @@ -0,0 +1,13 @@ +**To modify the tenancy of a VPC** + +This example modifies the tenancy of VPC ``vpc-1a2b3c4d`` to ``default``. + +Command:: + + aws ec2 modify-vpc-tenancy --vpc-id vpc-1a2b3c4d --instance-tenancy default + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/modify-vpn-connection.rst b/aws/dist/awscli/examples/ec2/modify-vpn-connection.rst new file mode 100644 index 00000000..abe474fa --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpn-connection.rst @@ -0,0 +1,40 @@ +**To modify a VPN connection** + +The following ``modify-vpn-connection`` example changes the target gateway for VPN connection ``vpn-12345678901234567`` to virtual private gateway ``vgw-11223344556677889``:: + + aws ec2 modify-vpn-connection \ + --vpn-connection-id vpn-12345678901234567 \ + --vpn-gateway-id vgw-11223344556677889 + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": "...configuration information...", + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "modifying", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-07-17T07:34:00.000Z", + "OutsideIpAddress": "18.210.3.222", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-07-20T21:20:16.000Z", + "OutsideIpAddress": "34.193.129.33", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst b/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst new file mode 100644 index 00000000..1c0553bf --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-certificate.rst @@ -0,0 +1,42 @@ +**To rotate a VPN tunnel certificate** + +The following ``modify-vpn-tunnel-certificate`` example rotates the certificate for the specified tunnel for a VPN connection :: + + aws ec2 modify-vpn-tunnel-certificate \ + --vpn-tunnel-outside-ip-address 203.0.113.17 \ + --vpn-connection-id vpn-12345678901234567 + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": ...configuration information..., + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "modifying", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-11T17:27:14.000Z", + "OutsideIpAddress": "203.0.113.17", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN", + "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/c544d8ce-20b8-4fff-98b0-example" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-11T17:26:47.000Z", + "OutsideIpAddress": "203.0.114.18", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN", + "CertificateArn": "arn:aws:acm:us-east-1:123456789101:certificate/5ab64566-761b-4ad3-b259-example" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-options.rst b/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-options.rst new file mode 100644 index 00000000..a57526ee --- /dev/null +++ b/aws/dist/awscli/examples/ec2/modify-vpn-tunnel-options.rst @@ -0,0 +1,83 @@ +**To modify the tunnel options for a VPN connection** + +The following ``modify-vpn-tunnel-options`` example updates the Diffie-Hellmann groups that are permitted for the specified tunnel and VPN connection. :: + + aws ec2 modify-vpn-tunnel-options \ + --vpn-connection-id vpn-12345678901234567 \ + --vpn-tunnel-outside-ip-address 203.0.113.17 \ + --tunnel-options Phase1DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}],Phase2DHGroupNumbers=[{Value=14},{Value=15},{Value=16},{Value=17},{Value=18}] + +Output:: + + { + "VpnConnection": { + "CustomerGatewayConfiguration": "...configuration information...", + "CustomerGatewayId": "cgw-aabbccddee1122334", + "Category": "VPN", + "State": "available", + "Type": "ipsec.1", + "VpnConnectionId": "vpn-12345678901234567", + "VpnGatewayId": "vgw-11223344556677889", + "Options": { + "StaticRoutesOnly": false, + "TunnelOptions": [ + { + "OutsideIpAddress": "203.0.113.17", + "Phase1DHGroupNumbers": [ + { + "Value": 14 + }, + { + "Value": 15 + }, + { + "Value": 16 + }, + { + "Value": 17 + }, + { + "Value": 18 + } + ], + "Phase2DHGroupNumbers": [ + { + "Value": 14 + }, + { + "Value": 15 + }, + { + "Value": 16 + }, + { + "Value": 17 + }, + { + "Value": 18 + } + ] + }, + { + "OutsideIpAddress": "203.0.114.19" + } + ] + }, + "VgwTelemetry": [ + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-10T21:56:54.000Z", + "OutsideIpAddress": "203.0.113.17", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + }, + { + "AcceptedRouteCount": 0, + "LastStatusChange": "2019-09-10T21:56:43.000Z", + "OutsideIpAddress": "203.0.114.19", + "Status": "DOWN", + "StatusMessage": "IPSEC IS DOWN" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ec2/monitor-instances.rst b/aws/dist/awscli/examples/ec2/monitor-instances.rst new file mode 100644 index 00000000..8b927811 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/monitor-instances.rst @@ -0,0 +1,20 @@ +**To enable detailed monitoring for an instance** + +This example command enables detailed monitoring for the specified instance. + +Command:: + + aws ec2 monitor-instances --instance-ids i-1234567890abcdef0 + +Output:: + + { + "InstanceMonitorings": [ + { + "InstanceId": "i-1234567890abcdef0", + "Monitoring": { + "State": "pending" + } + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/move-address-to-vpc.rst b/aws/dist/awscli/examples/ec2/move-address-to-vpc.rst new file mode 100644 index 00000000..c2db7e6d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/move-address-to-vpc.rst @@ -0,0 +1,13 @@ +**To move an address to EC2-VPC** + +This example moves Elastic IP address 54.123.4.56 to the EC2-VPC platform. + +Command:: + + aws ec2 move-address-to-vpc --public-ip 54.123.4.56 + +Output:: + + { + "Status": "MoveInProgress" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/provision-byoip-cidr.rst b/aws/dist/awscli/examples/ec2/provision-byoip-cidr.rst new file mode 100644 index 00000000..294f97f2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/provision-byoip-cidr.rst @@ -0,0 +1,18 @@ +**To provision an address range** + +The following ``provision-byoip-cidr`` example provisions a public IP address range for use with AWS. :: + + aws ec2 provision-byoip-cidr \ + --cidr 203.0.113.25/24 \ + --cidr-authorization-context Message="$text_message",Signature="$signed_message" + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "State": "pending-provision" + } + } + +For more information about creating the messages strings for the authorization context, see `Bring Your Own IP Addresses `__ in the *Amazon EC2 User Guide*. diff --git a/aws/dist/awscli/examples/ec2/purchase-host-reservation.rst b/aws/dist/awscli/examples/ec2/purchase-host-reservation.rst new file mode 100644 index 00000000..ed486ed2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/purchase-host-reservation.rst @@ -0,0 +1,27 @@ +**To purchase a Dedicated Host Reservation** + +This example purchases the specified Dedicated Host Reservation offering for the specified Dedicated Host in your account. + +Command:: + + aws ec2 purchase-host-reservation --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123 + +Output:: + + { + "TotalHourlyPrice": "1.499", + "Purchase": [ + { + "HourlyPrice": "1.499", + "InstanceFamily": "m4", + "PaymentOption": "NoUpfront", + "HostIdSet": [ + "h-013abcd2a00cbd123" + ], + "HostReservationId": "hr-0d418a3a4ffc669ae", + "UpfrontPrice": "0.000", + "Duration": 31536000 + } + ], + "TotalUpfrontPrice": "0.000" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/purchase-reserved-instances-offering.rst b/aws/dist/awscli/examples/ec2/purchase-reserved-instances-offering.rst new file mode 100644 index 00000000..2adfbb1e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/purchase-reserved-instances-offering.rst @@ -0,0 +1,16 @@ +**To purchase a Reserved Instance offering** + +This example command illustrates a purchase of a Reserved Instances offering, specifying an offering ID and instance count. + +Command:: + + aws ec2 purchase-reserved-instances-offering --reserved-instances-offering-id ec06327e-dd07-46ee-9398-75b5fexample --instance-count 3 + + +Output:: + + { + "ReservedInstancesId": "af9f760e-6f91-4559-85f7-4980eexample" + } + + diff --git a/aws/dist/awscli/examples/ec2/purchase-scheduled-instances.rst b/aws/dist/awscli/examples/ec2/purchase-scheduled-instances.rst new file mode 100644 index 00000000..03fc9b31 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/purchase-scheduled-instances.rst @@ -0,0 +1,47 @@ +**To purchase a Scheduled Instance** + +This example purchases a Scheduled Instance. + +Command:: + + aws ec2 purchase-scheduled-instances --purchase-requests file://purchase-request.json + +Purchase-request.json:: + + [ + { + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", + "InstanceCount": 1 + } + ] + +Output:: + + { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "HourlyPrice": "0.095", + "CreateDate": "2016-01-25T21:43:38.612Z", + "Recurrence": { + "OccurrenceDaySet": [ + 1 + ], + "Interval": 1, + "Frequency": "Weekly", + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "Platform": "Linux/UNIX", + "TermEndDate": "2017-01-31T09:00:00Z", + "InstanceCount": 1, + "SlotDurationInHours": 32, + "TermStartDate": "2016-01-31T09:00:00Z", + "NetworkPlatform": "EC2-VPC", + "TotalScheduledInstanceHours": 1696, + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "InstanceType": "c4.large" + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/reboot-instances.rst b/aws/dist/awscli/examples/ec2/reboot-instances.rst new file mode 100644 index 00000000..69f5d540 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reboot-instances.rst @@ -0,0 +1,12 @@ +**To reboot an Amazon EC2 instance** + +This example reboots the specified instance. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reboot-instances --instance-ids i-1234567890abcdef5 + +For more information, see `Reboot Your Instance`_ in the *Amazon Elastic Compute Cloud User Guide*. + +.. _`Reboot Your Instance`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-reboot.html + diff --git a/aws/dist/awscli/examples/ec2/register-image.rst b/aws/dist/awscli/examples/ec2/register-image.rst new file mode 100644 index 00000000..b886489c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/register-image.rst @@ -0,0 +1,27 @@ +**To register an AMI using a manifest file** + +This example registers an AMI using the specified manifest file in Amazon S3. + +Command:: + + aws ec2 register-image --image-location my-s3-bucket/myimage/image.manifest.xml --name "MyImage" + +Output:: + + { + "ImageId": "ami-61341708" + } + +**To add a block device mapping** + +Add the following parameter to your ``register-image`` command to add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdh\",\"Ebs\":{\"VolumeSize\":100}}]" + +Add the following parameter to your ``register-image`` command to add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``:: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdc\",\"VirtualName\":\"ephemeral1\"}]" + +Add the following parameter to your ``register-image`` command to omit a device (for example, ``/dev/sdf``):: + + --block-device-mappings "[{\"DeviceName\": \"/dev/sdf\",\"NoDevice\":\"\"}]" diff --git a/aws/dist/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst b/aws/dist/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst new file mode 100755 index 00000000..1068a4ea --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reject-transit-gateway-vpc-attachments.rst @@ -0,0 +1,28 @@ +**To reject a Transit Gateway VPC attachment** + +The following ``reject-transit-gateway-vpc-attachment`` example rejects the specified transit gateway VPC attachment. :: + + aws ec2 reject-transit-gateway-vpc-attachment \ + --transit-gateway-attachment-id tgw-attach-0a34fe6b4fEXAMPLE + +Output:: + + { + "TransitGatewayVpcAttachment": { + "TransitGatewayAttachmentId": "tgw-attach-0a34fe6b4fEXAMPLE", + "TransitGatewayId": "tgw-0262a0e521EXAMPLE", + "VpcId": "vpc-07e8ffd50fEXAMPLE", + "VpcOwnerId": "123456789012", + "State": "pending", + "SubnetIds": [ + "subnet-0752213d59EXAMPLE" + ], + "CreationTime": "2019-07-10T17:33:46.000Z", + "Options": { + "DnsSupport": "enable", + "Ipv6Support": "disable" + } + } + } + +For more information, see `Transit Gateway Attachments to a VPC `__ in the *AWS Transit Gateways*. diff --git a/aws/dist/awscli/examples/ec2/reject-vpc-endpoint-connections.rst b/aws/dist/awscli/examples/ec2/reject-vpc-endpoint-connections.rst new file mode 100644 index 00000000..f06e7994 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reject-vpc-endpoint-connections.rst @@ -0,0 +1,13 @@ +**To reject an interface endpoint connection request** + +This example rejects the specified endpoint connection request for the specified endpoint service. + +Command:: + + aws ec2 reject-vpc-endpoint-connections --service-id vpce-svc-03d5ebb7d9579a2b3 --vpc-endpoint-ids vpce-0c1308d7312217abc + +Output:: + + { + "Unsuccessful": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/reject-vpc-peering-connection.rst b/aws/dist/awscli/examples/ec2/reject-vpc-peering-connection.rst new file mode 100644 index 00000000..55e1b9d1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reject-vpc-peering-connection.rst @@ -0,0 +1,13 @@ +**To reject a VPC peering connection** + +This example rejects the specified VPC peering connection request. + +Command:: + + aws ec2 reject-vpc-peering-connection --vpc-peering-connection-id pcx-1a2b3c4d + +Output:: + + { + "Return": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/release-address.rst b/aws/dist/awscli/examples/ec2/release-address.rst new file mode 100644 index 00000000..894e4085 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/release-address.rst @@ -0,0 +1,15 @@ +**To release an Elastic IP addresses for EC2-Classic** + +This example releases an Elastic IP address for use with instances in EC2-Classic. If the command succeeds, no output is returned. + +Command:: + + aws ec2 release-address --public-ip 198.51.100.0 + +**To release an Elastic IP address for EC2-VPC** + +This example releases an Elastic IP address for use with instances in a VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 release-address --allocation-id eipalloc-64d5890a diff --git a/aws/dist/awscli/examples/ec2/release-hosts.rst b/aws/dist/awscli/examples/ec2/release-hosts.rst new file mode 100644 index 00000000..5a3829c9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/release-hosts.rst @@ -0,0 +1,17 @@ +**To release a Dedicated host from your account** + +To release a Dedicated host from your account. Instances that are on the host must be stopped or terminated before the host can be released. + +Command:: + + aws ec2 release-hosts --host-id=h-0029d6e3cacf1b3da + +Output:: + + { + "Successful": [ + "h-0029d6e3cacf1b3da" + ], + "Unsuccessful": [] + + } diff --git a/aws/dist/awscli/examples/ec2/replace-iam-instance-profile-association.rst b/aws/dist/awscli/examples/ec2/replace-iam-instance-profile-association.rst new file mode 100644 index 00000000..b0c74664 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-iam-instance-profile-association.rst @@ -0,0 +1,21 @@ +**To replace an IAM instance profile for an instance** + +This example replaces the IAM instance profile represented by the association ``iip-assoc-060bae234aac2e7fa`` with the IAM instance profile named ``AdminRole``. :: + + aws ec2 replace-iam-instance-profile-association \ + --iam-instance-profile Name=AdminRole \ + --association-id iip-assoc-060bae234aac2e7fa + +Output:: + + { + "IamInstanceProfileAssociation": { + "InstanceId": "i-087711ddaf98f9489", + "State": "associating", + "AssociationId": "iip-assoc-0b215292fab192820", + "IamInstanceProfile": { + "Id": "AIPAJLNLDX3AMYZNWYYAY", + "Arn": "arn:aws:iam::123456789012:instance-profile/AdminRole" + } + } + } diff --git a/aws/dist/awscli/examples/ec2/replace-network-acl-association.rst b/aws/dist/awscli/examples/ec2/replace-network-acl-association.rst new file mode 100644 index 00000000..acbf722b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-network-acl-association.rst @@ -0,0 +1,13 @@ +**To replace the network ACL associated with a subnet** + +This example associates the specified network ACL with the subnet for the specified network ACL association. + +Command:: + + aws ec2 replace-network-acl-association --association-id aclassoc-e5b95c8c --network-acl-id acl-5fb85d36 + +Output:: + + { + "NewAssociationId": "aclassoc-3999875b" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/replace-network-acl-entry.rst b/aws/dist/awscli/examples/ec2/replace-network-acl-entry.rst new file mode 100644 index 00000000..b1999fad --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-network-acl-entry.rst @@ -0,0 +1,7 @@ +**To replace a network ACL entry** + +This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet. + +Command:: + + aws ec2 replace-network-acl-entry --network-acl-id acl-5fb85d36 --ingress --rule-number 100 --protocol udp --port-range From=53,To=53 --cidr-block 203.0.113.12/24 --rule-action allow diff --git a/aws/dist/awscli/examples/ec2/replace-route-table-association.rst b/aws/dist/awscli/examples/ec2/replace-route-table-association.rst new file mode 100644 index 00000000..1b2623f7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-route-table-association.rst @@ -0,0 +1,13 @@ +**To replace the route table associated with a subnet** + +This example associates the specified route table with the subnet for the specified route table association. + +Command:: + + aws ec2 replace-route-table-association --association-id rtbassoc-781d0d1a --route-table-id rtb-22574640 + +Output:: + + { + "NewAssociationId": "rtbassoc-3a1f0f58" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/replace-route.rst b/aws/dist/awscli/examples/ec2/replace-route.rst new file mode 100644 index 00000000..a6f348db --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-route.rst @@ -0,0 +1,7 @@ +**To replace a route** + +This example replaces the specified route in the specified route table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway. If the command succeeds, no output is returned. + +Command:: + + aws ec2 replace-route --route-table-id rtb-22574640 --destination-cidr-block 10.0.0.0/16 --gateway-id vgw-9a4cacf3 \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/replace-transit-gateway-route.rst b/aws/dist/awscli/examples/ec2/replace-transit-gateway-route.rst new file mode 100644 index 00000000..5576d7dc --- /dev/null +++ b/aws/dist/awscli/examples/ec2/replace-transit-gateway-route.rst @@ -0,0 +1,27 @@ +**To replace the specified route in the specified transit gateway route table** + +The following ``replace-transit-gateway-route`` example replaces the route in the specified transit gateway route table. :: + + aws ec2 replace-transit-gateway-route \ + --destination-cidr-block 10.0.2.0/24 \ + --transit-gateway-attachment-id tgw-attach-09b52ccdb5EXAMPLE \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE + +Output:: + + { + "Route": { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + } + +For more information, see `Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/report-instance-status.rst b/aws/dist/awscli/examples/ec2/report-instance-status.rst new file mode 100644 index 00000000..f847fad2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/report-instance-status.rst @@ -0,0 +1,7 @@ +**To report status feedback for an instance** + +This example command reports status feedback for the specified instance. + +Command:: + + aws ec2 report-instance-status --instances i-1234567890abcdef0 --status impaired --reason-codes unresponsive diff --git a/aws/dist/awscli/examples/ec2/request-spot-fleet.rst b/aws/dist/awscli/examples/ec2/request-spot-fleet.rst new file mode 100644 index 00000000..2efeacf8 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/request-spot-fleet.rst @@ -0,0 +1,157 @@ +**To request a Spot fleet in the subnet with the lowest price** + +This example command creates a Spot fleet request with two launch specifications that differ only by subnet. +The Spot fleet launches the instances in the specified subnet with the lowest price. +If the instances are launched in a default VPC, they receive a public IP address by default. +If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. + +Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request. + +Command:: + + aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json + +Config.json:: + + { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "InstanceType": "m3.medium", + "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + ] + } + +Output:: + + { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + + +**To request a Spot fleet in the Availability Zone with the lowest price** + +This example command creates a Spot fleet request with two launch specifications that differ only by Availability Zone. +The Spot fleet launches the instances in the specified Availability Zone with the lowest price. +If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. +If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone. + +Command:: + + aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json + +Config.json:: + + { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "InstanceType": "m3.medium", + "Placement": { + "AvailabilityZone": "us-west-2a, us-west-2b" + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + ] + } + +**To launch Spot instances in a subnet and assign them public IP addresses** + +This example command assigns public addresses to instances launched in a nondefault VPC. +Note that when you specify a network interface, you must include the subnet ID and security group ID +using the network interface. + +Command:: + + aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json + +Config.json:: + + { + "SpotPrice": "0.04", + "TargetCapacity": 2, + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "InstanceType": "m3.medium", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "SubnetId": "subnet-1a2b3c4d", + "Groups": [ "sg-1a2b3c4d" ], + "AssociatePublicIpAddress": true + } + ], + "IamInstanceProfile": { + "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" + } + } + ] + } + +**To request a Spot fleet using the diversified allocation strategy** + +This example command creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. +The launch specifications differ by instance type. The Spot fleet distributes the instances +across the launch specifications such that there are 10 instances of each type. + +Command:: + + aws ec2 request-spot-fleet --spot-fleet-request-config file://config.json + +Config.json:: + + { + "SpotPrice": "0.70", + "TargetCapacity": 30, + "AllocationStrategy": "diversified", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "c4.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + } + ] + } + +For more information, see `Spot Fleet Requests`_ in the *Amazon Elastic Compute Cloud User Guide*. + +.. _`Spot Fleet Requests`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html + diff --git a/aws/dist/awscli/examples/ec2/request-spot-instances.rst b/aws/dist/awscli/examples/ec2/request-spot-instances.rst new file mode 100644 index 00000000..41c16457 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/request-spot-instances.rst @@ -0,0 +1,153 @@ +**To request Spot Instances** + +This example command creates a one-time Spot Instance request for five instances in the specified Availability Zone. +If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. +If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone. + +Command:: + + aws ec2 request-spot-instances --spot-price "0.03" --instance-count 5 --type "one-time" --launch-specification file://specification.json + +Specification.json:: + + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroupIds": [ "sg-1a2b3c4d" ], + "InstanceType": "m3.medium", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + +Output:: + + { + "SpotInstanceRequests": [ + { + "Status": { + "UpdateTime": "2014-03-25T20:54:21.000Z", + "Code": "pending-evaluation", + "Message": "Your Spot request has been submitted for review, and is pending evaluation." + }, + "ProductDescription": "Linux/UNIX", + "SpotInstanceRequestId": "sir-df6f405d", + "State": "open", + "LaunchSpecification": { + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupName": "my-security-group", + "GroupId": "sg-1a2b3c4d" + } + ], + "Monitoring": { + "Enabled": false + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "InstanceType": "m3.medium" + }, + "Type": "one-time", + "CreateTime": "2014-03-25T20:54:20.000Z", + "SpotPrice": "0.050000" + }, + ... + ] + } + +This example command creates a one-time Spot Instance request for five instances in the specified subnet. +Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances +do not receive a public IP address by default. + +Command:: + + aws ec2 request-spot-instances --spot-price "0.050" --instance-count 5 --type "one-time" --launch-specification file://specification.json + +Specification.json:: + + { + "ImageId": "ami-1a2b3c4d", + "SecurityGroupIds": [ "sg-1a2b3c4d" ], + "InstanceType": "m3.medium", + "SubnetId": "subnet-1a2b3c4d", + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } + +Output:: + + { + "SpotInstanceRequests": [ + { + "Status": { + "UpdateTime": "2014-03-25T22:21:58.000Z", + "Code": "pending-evaluation", + "Message": "Your Spot request has been submitted for review, and is pending evaluation." + }, + "ProductDescription": "Linux/UNIX", + "SpotInstanceRequestId": "sir-df6f405d", + "State": "open", + "LaunchSpecification": { + "Placement": { + "AvailabilityZone": "us-west-2a" + } + "ImageId": "ami-1a2b3c4d" + "SecurityGroups": [ + { + "GroupName": "my-security-group", + "GroupID": "sg-1a2b3c4d" + } + ] + "SubnetId": "subnet-1a2b3c4d", + "Monitoring": { + "Enabled": false + }, + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "InstanceType": "m3.medium", + }, + "Type": "one-time", + "CreateTime": "2014-03-25T22:21:58.000Z", + "SpotPrice": "0.050000" + }, + ... + ] + } + +This example assigns a public IP address to the Spot Instances that you launch in a nondefault VPC. +Note that when you specify a network interface, you must include the subnet ID and security group ID +using the network interface. + +Command:: + + aws ec2 request-spot-instances --spot-price "0.050" --instance-count 1 --type "one-time" --launch-specification file://specification.json + +Specification.json:: + + { + "ImageId": "ami-1a2b3c4d", + "KeyName": "my-key-pair", + "InstanceType": "m3.medium", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "SubnetId": "subnet-1a2b3c4d", + "Groups": [ "sg-1a2b3c4d" ], + "AssociatePublicIpAddress": true + } + ], + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + } + } diff --git a/aws/dist/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst b/aws/dist/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst new file mode 100644 index 00000000..bd612325 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reset-ebs-default-kms-key-id.rst @@ -0,0 +1,11 @@ +**To reset your default CMK for EBS encryption** + +The following ``reset-ebs-default-kms-key-id`` example resets the default CMK for EBS encryption for your AWS account in the current Region. :: + + aws ec2 reset-ebs-default-kms-key-id + +Output:: + + { + "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/8c5b2c63-b9bc-45a3-a87a-5513eEXAMPLE" + } diff --git a/aws/dist/awscli/examples/ec2/reset-fpga-image-attribute.rst b/aws/dist/awscli/examples/ec2/reset-fpga-image-attribute.rst new file mode 100644 index 00000000..cd4a3125 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reset-fpga-image-attribute.rst @@ -0,0 +1,13 @@ +**To reset the attributes of an Amazon FPGA image** + +This example resets the load permissions for the specified AFI. + +Command:: + + aws ec2 reset-fpga-image-attribute --fpga-image-id afi-0d123e123bfc85abc --attribute loadPermission + +Output:: + + { + "Return": true + } diff --git a/aws/dist/awscli/examples/ec2/reset-image-attribute.rst b/aws/dist/awscli/examples/ec2/reset-image-attribute.rst new file mode 100644 index 00000000..ce4caf6b --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reset-image-attribute.rst @@ -0,0 +1,7 @@ +**To reset the launchPermission attribute** + +This example resets the ``launchPermission`` attribute for the specified AMI to its default value. By default, AMIs are private. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reset-image-attribute --image-id ami-5731123e --attribute launchPermission diff --git a/aws/dist/awscli/examples/ec2/reset-instance-attribute.rst b/aws/dist/awscli/examples/ec2/reset-instance-attribute.rst new file mode 100644 index 00000000..982e6fc0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reset-instance-attribute.rst @@ -0,0 +1,23 @@ +**To reset the sourceDestCheck attribute** + +This example resets the ``sourceDestCheck`` attribute of the specified instance. The instance must be in a VPC. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute sourceDestCheck + +**To reset the kernel attribute** + +This example resets the ``kernel`` attribute of the specified instance. The instance must be in the ``stopped`` state. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute kernel + +**To reset the ramdisk attribute** + +This example resets the ``ramdisk`` attribute of the specified instance. The instance must be in the ``stopped`` state. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reset-instance-attribute --instance-id i-1234567890abcdef0 --attribute ramdisk diff --git a/aws/dist/awscli/examples/ec2/reset-snapshot-attribute.rst b/aws/dist/awscli/examples/ec2/reset-snapshot-attribute.rst new file mode 100644 index 00000000..1f57f17a --- /dev/null +++ b/aws/dist/awscli/examples/ec2/reset-snapshot-attribute.rst @@ -0,0 +1,8 @@ +**To reset a snapshot attribute** + +This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 reset-snapshot-attribute --snapshot-id snap-1234567890abcdef0 --attribute createVolumePermission + diff --git a/aws/dist/awscli/examples/ec2/restore-address-to-classic.rst b/aws/dist/awscli/examples/ec2/restore-address-to-classic.rst new file mode 100644 index 00000000..50b14764 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/restore-address-to-classic.rst @@ -0,0 +1,14 @@ +**To restore an address to EC2-Classic** + +This example restores Elastic IP address 198.51.100.0 to the EC2-Classic platform. + +Command:: + + aws ec2 restore-address-to-classic --public-ip 198.51.100.0 + +Output:: + + { + "Status": "MoveInProgress", + "PublicIp": "198.51.100.0" + } diff --git a/aws/dist/awscli/examples/ec2/revoke-client-vpn-ingress.rst b/aws/dist/awscli/examples/ec2/revoke-client-vpn-ingress.rst new file mode 100644 index 00000000..9fb9376d --- /dev/null +++ b/aws/dist/awscli/examples/ec2/revoke-client-vpn-ingress.rst @@ -0,0 +1,17 @@ +**To revoke an authorization rule for a Client VPN endpoint** + +The following ``revoke-client-vpn-ingress`` example revokes a rule for internet access (``0.0.0.0/0``) for all groups. :: + + aws ec2 revoke-client-vpn-ingress \ + --client-vpn-endpoint-id cvpn-endpoint-123456789123abcde \ + --target-network-cidr 0.0.0.0/0 --revoke-all-groups + +Output:: + + { + "Status": { + "Code": "revoking" + } + } + +For more information, see `Authorization Rules `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/revoke-security-group-egress.rst b/aws/dist/awscli/examples/ec2/revoke-security-group-egress.rst new file mode 100644 index 00000000..174cb9a1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/revoke-security-group-egress.rst @@ -0,0 +1,15 @@ +**To remove the rule that allows outbound traffic to a specific address range** + +This example command removes the rule that grants access to the specified address ranges on TCP port 80. + +Command:: + + aws ec2 revoke-security-group-egress --group-id sg-1a2b3c4d --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "IpRanges": [{"CidrIp": "10.0.0.0/16"}]}]' + +**To remove the rule that allows outbound traffic to a specific security group** + +This example command removes the rule that grants access to the specified security group on TCP port 80. + +Command:: + + aws ec2 revoke-security-group-egress --group-id sg-1a2b3c4d --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "UserIdGroupPairs": [{"GroupId": "sg-4b51a32f"}]}]' diff --git a/aws/dist/awscli/examples/ec2/revoke-security-group-ingress.rst b/aws/dist/awscli/examples/ec2/revoke-security-group-ingress.rst new file mode 100644 index 00000000..b1de459e --- /dev/null +++ b/aws/dist/awscli/examples/ec2/revoke-security-group-ingress.rst @@ -0,0 +1,17 @@ +**To remove a rule from a security group** + +This example removes TCP port 22 access for the ``203.0.113.0/24`` address range from the security group named ``MySecurityGroup``. If the command succeeds, no output is returned. + +Command:: + + aws ec2 revoke-security-group-ingress --group-name MySecurityGroup --protocol tcp --port 22 --cidr 203.0.113.0/24 + +**[EC2-VPC] To remove a rule using the IP permissions set** + +This example uses the ``ip-permissions`` parameter to remove an inbound rule that allows the ICMP message ``Destination Unreachable: Fragmentation Needed and Don't Fragment was Set`` (Type 3, Code 4). If the command succeeds, no output is returned. For more information about quoting JSON-formatted parameters, see `Quoting Strings`_. + +Command:: + + aws ec2 revoke-security-group-ingress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "icmp", "FromPort": 3, "ToPort": 4, "IpRanges": [{"CidrIp": "0.0.0.0/0"}]}]' + +.. _`Quoting Strings`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#quoting-strings \ No newline at end of file diff --git a/aws/dist/awscli/examples/ec2/run-instances.rst b/aws/dist/awscli/examples/ec2/run-instances.rst new file mode 100644 index 00000000..cddbb0cf --- /dev/null +++ b/aws/dist/awscli/examples/ec2/run-instances.rst @@ -0,0 +1,352 @@ +**Example 1: To launch an instance in EC2-Classic** + +The following ``run-instances`` example launches a single instance of type ``c3.large``. The key pair and security group must already exist. :: + + aws ec2 run-instances \ + --image-id ami-1a2b3c4d \ + --count 1 \ + --instance-type c3.large \ + --key-name MyKeyPair \ + --security-groups MySecurityGroup + +Output:: + + { + "OwnerId": "123456789012", + "ReservationId": "r-08626e73c547023b1", + "Groups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-903004f8" + } + ], + "Instances": [ + { + "Monitoring": { + "State": "disabled" + }, + "PublicDnsName": null, + "RootDeviceType": "ebs", + "State": { + "Code": 0, + "Name": "pending" + }, + "EbsOptimized": false, + "LaunchTime": "2018-05-10T08:03:30.000Z", + "ProductCodes": [], + "CpuOptions": { + "CoreCount": 1, + "ThreadsPerCore": 2 + }, + "StateTransitionReason": null, + "InstanceId": "i-1234567890abcdef0", + "ImageId": "ami-1a2b3c4d", + "PrivateDnsName": null, + "KeyName": "MyKeyPair", + "SecurityGroups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-903004f8" + } + ], + "ClientToken": null, + "InstanceType": "c3.large", + "NetworkInterfaces": [], + "Placement": { + "Tenancy": "default", + "GroupName": null, + "AvailabilityZone": "us-east-1b" + }, + "Hypervisor": "xen", + "BlockDeviceMappings": [], + "Architecture": "x86_64", + "StateReason": { + "Message": "pending", + "Code": "pending" + }, + "RootDeviceName": "/dev/sda1", + "VirtualizationType": "hvm", + "AmiLaunchIndex": 0 + } + ] + } + +**Example 2: To launch an instance in EC2-VPC** + +The following ``run-instances`` example launches a single instance of type ``t2.micro`` into the specified subnet. The key pair and the security group must already exist. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --security-group-ids sg-1a2b3c4d \ + --subnet-id subnet-6e7f829e + +Output:: + + { + "Instances": [ + { + "Monitoring": { + "State": "disabled" + }, + "PublicDnsName": "", + "StateReason": { + "Message": "pending", + "Code": "pending" + }, + "State": { + "Code": 0, + "Name": "pending" + }, + "EbsOptimized": false, + "LaunchTime": "2018-05-10T08:05:20.000Z", + "PrivateIpAddress": "10.0.0.157", + "ProductCodes": [], + "VpcId": "vpc-11223344", + "CpuOptions": { + "CoreCount": 1, + "ThreadsPerCore": 1 + }, + "StateTransitionReason": "", + "InstanceId": "i-1231231230abcdef0", + "ImageId": "ami-abc12345", + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "SecurityGroups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-1a2b3c4d" + } + ], + "ClientToken": "", + "SubnetId": "subnet-6e7f829e", + "InstanceType": "t2.micro", + "NetworkInterfaces": [ + { + "Status": "in-use", + "MacAddress": "0a:ab:58:e0:67:e2", + "SourceDestCheck": true, + "VpcId": "vpc-11223344", + "Description": "", + "NetworkInterfaceId": "eni-95c6390b", + "PrivateIpAddresses": [ + { + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "Primary": true, + "PrivateIpAddress": "10.0.0.157" + } + ], + "PrivateDnsName": "ip-10-0-0-157.ec2.internal", + "Attachment": { + "Status": "attaching", + "DeviceIndex": 0, + "DeleteOnTermination": true, + "AttachmentId": "eni-attach-bf87ca1f", + "AttachTime": "2018-05-10T08:05:20.000Z" + }, + "Groups": [ + { + "GroupName": "MySecurityGroup", + "GroupId": "sg-1a2b3c4d" + } + ], + "Ipv6Addresses": [], + "OwnerId": "123456789012", + "SubnetId": "subnet-6e7f829e", + "PrivateIpAddress": "10.0.0.157" + } + ], + "SourceDestCheck": true, + "Placement": { + "Tenancy": "default", + "GroupName": "", + "AvailabilityZone": "us-east-1a" + }, + "Hypervisor": "xen", + "BlockDeviceMappings": [], + "Architecture": "x86_64", + "RootDeviceType": "ebs", + "RootDeviceName": "/dev/xvda", + "VirtualizationType": "hvm", + "AmiLaunchIndex": 0 + } + ], + "ReservationId": "r-02a3f596d91211712", + "Groups": [], + "OwnerId": "123456789012" + } + +**Example 3: To launch an instance into a non-default subnet and add a public IP address** + +The following ``run-instances`` example requests a public IP address for an instance that you're launching into a nondefault subnet. :: + + aws ec2 run-instances \ + --image-id ami-c3b8d6aa \ + --count 1 \ + --instance-type t2.medium \ + --key-name MyKeyPair \ + --security-group-ids sg-903004f8 \ + --subnet-id subnet-6e7f829e \ + --associate-public-ip-address + +**Example 4: To launch an instance using a block device mapping** + +Add the following parameter to your ``run-instances`` command to specify a file that defines block devices to attach to the new instance:: + + --block-device-mappings file://mapping.json + +To add an Amazon EBS volume with the device name ``/dev/sdh`` and a volume size of 100, specify the following in mapping.json:: + + [ + { + "DeviceName": "/dev/sdh", + "Ebs": { + "VolumeSize": 100 + } + } + ] + +To add ``ephemeral1`` as an instance store volume with the device name ``/dev/sdc``, specify the following in mapping.json:: + + [ + { + "DeviceName": "/dev/sdc", + "VirtualName": "ephemeral1" + } + ] + +To omit a device specified by the AMI used to launch the instance (for example, ``/dev/sdf``), specify the following in mapping.json:: + + [ + { + "DeviceName": "/dev/sdf", + "NoDevice": "" + } + ] + +After you create an instance with block devices this way, you can view only the Amazon EBS volumes in your block device mapping by using the console or by running the ``describe-instances`` command. To view all volumes, including the instance store volumes, run the following command from within the instance:: + + curl http://169.254.169.254/latest/meta-data/block-device-mapping/ + +Output:: + + ami + ephemeral1 + +Note that ``ami`` represents the root volume. To get details about the instance store volume ``ephemeral1``, run the following command from within the instance:: + + curl http://169.254.169.254/latest/meta-data/block-device-mapping/ephemeral1 + +Output:: + + sdc + +**Example 4: To launch an instance with a modified block device mapping** + +You can change individual characteristics of existing AMI block device mappings to suit your needs. Perhaps you want to use an existing AMI, but you want a larger root volume than the usual 8 GiB. Or, you would like to use a General Purpose (SSD) volume for an AMI that currently uses a Magnetic volume. + +Start by running the ``describe-images`` command with the image ID of the AMI you want to use to find its existing block device mapping. You should see a block device mapping in the output similar to the following:: + + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 8, + "VolumeType": "standard", + "Encrypted": false + } + } + +You can modify the above mapping by including the modified individual parameters in a block device mapping file. For example, to launch an instance with a modified block device mapping, add the following parameter to your ``run-instances`` command to change the above mapping's volume size and type:: + + --block-device-mappings file://mapping.json + +Where ``mapping.json`` contains the following (note the change in ``VolumeSize`` from ``8`` to ``100`` and the change in ``VolumeType`` from ``standard`` to ``gp2``):: + + [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "SnapshotId": "snap-1234567890abcdef0", + "VolumeSize": 100, + "VolumeType": "gp2" + } + } + ] + +**Example 5: To launch an instance that includes user data** + +You can launch an instance and specify user data that performs instance configuration, or that runs a script. The user data needs to be passed as normal string, base64 encoding is handled internally. The following example passes user data in a file called ``my_script.txt`` that contains a configuration script for your instance. The script runs at launch. :: + + aws ec2 run-instances \ + --image-id ami-abc1234 \ + --count 1 \ + --instance-type m4.large \ + --key-name keypair \ + --user-data file://my_script.txt \ + --subnet-id subnet-abcd1234 \ + --security-group-ids sg-abcd1234 + +For more information about launching instances, see `Using Amazon EC2 Instances `__ in the *AWS Command Line Interface User Guide*. + +**Example 6: To launch an instance with an instance profile** + +The following ``run-instances`` example shows the use of the ``iam-instance-profile`` option to specify an `IAM instance profile `__ by name. :: + + aws ec2 run-instances \ + --iam-instance-profile Name=MyInstanceProfile \ + --image-id ami-1a2b3c4d \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --security-groups MySecurityGroup + +**Example 7: To launch an instance with tags** + +You can launch an instance and specify tags for the instance, volumes, or both. The following example applies a tag with a key of ``webserver`` and value of ``production`` to the instance. The command also applies a tag with a key of ``cost-center`` and a value of ``cc123`` to any EBS volume that's created (in this case, the root volume). :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --subnet-id subnet-6e7f829e \ + --tag-specifications 'ResourceType=instance,Tags=[{Key=webserver,Value=production}]' 'ResourceType=volume,Tags=[{Key=cost-center,Value=cc123}]' + +**Example 8: To launch an instance with the credit option for CPU usage of ``unlimited``** + +You can launch a burstable performance instance (T2 and T3) and specify the credit option for CPU usage for the instance. If you do not specify the credit option, a T2 instance launches with the default ``standard`` credit option and a T3 instance launches with the default ``unlimited`` credit option. The following example launches a t2.micro instance with the ``unlimited`` credit option. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --credit-specification CpuCredits=unlimited + +**Example 9: To launch an instance into a partition placement group** + +You can launch an instance into a partition placement group without specifying the partition. The following ``run-instances`` example launches the instance into the specified partition placement group. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --subnet-id subnet-6e7f829e \ + --placement "GroupName = HDFS-Group-A" + +**Example 10: To launch an instance into a specific partition of a partition placement group** + +You can launch an instance into a specific partition of a partition placement group by specifying the partition number. The following ``run-instances`` example launches the instance into the specified partition placement group and into partition number ``3``. :: + + aws ec2 run-instances \ + --image-id ami-abc12345 \ + --count 1 \ + --instance-type t2.micro \ + --key-name MyKeyPair \ + --subnet-id subnet-6e7f829e\ + --placement "GroupName = HDFS-Group-A, PartitionNumber = 3" diff --git a/aws/dist/awscli/examples/ec2/run-scheduled-instances.rst b/aws/dist/awscli/examples/ec2/run-scheduled-instances.rst new file mode 100644 index 00000000..92f2c9af --- /dev/null +++ b/aws/dist/awscli/examples/ec2/run-scheduled-instances.rst @@ -0,0 +1,63 @@ +**To launch a Scheduled Instance** + +This example launches the specified Scheduled Instance in a VPC. + +Command:: + + aws ec2 run-scheduled-instances --scheduled-instance-id sci-1234-1234-1234-1234-123456789012 --instance-count 1 --launch-specification file://launch-specification.json + +Launch-specification.json:: + + { + "ImageId": "ami-12345678", + "KeyName": "my-key-pair", + "InstanceType": "c4.large", + "NetworkInterfaces": [ + { + "DeviceIndex": 0, + "SubnetId": "subnet-12345678", + "AssociatePublicIpAddress": true, + "Groups": ["sg-12345678"] + } + ], + "IamInstanceProfile": { + "Name": "my-iam-role" + } + } + +Output:: + + { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + } + +This example launches the specified Scheduled Instance in EC2-Classic. + +Command:: + + aws ec2 run-scheduled-instances --scheduled-instance-id sci-1234-1234-1234-1234-123456789012 --instance-count 1 --launch-specification file://launch-specification.json + +Launch-specification.json:: + + { + "ImageId": "ami-12345678", + "KeyName": "my-key-pair", + "SecurityGroupIds": ["sg-12345678"], + "InstanceType": "c4.large", + "Placement": { + "AvailabilityZone": "us-west-2b" + } + "IamInstanceProfile": { + "Name": "my-iam-role" + } + } + +Output:: + + { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + } diff --git a/aws/dist/awscli/examples/ec2/search-transit-gateway-routes.rst b/aws/dist/awscli/examples/ec2/search-transit-gateway-routes.rst new file mode 100644 index 00000000..6a3921cd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/search-transit-gateway-routes.rst @@ -0,0 +1,41 @@ +**To search for routes in the specified transit gateway route table** + +The following ``search-transit-gateway-routes`` example returns all the routes that are of type ``static`` in the specified route table. :: + + aws ec2 search-transit-gateway-routes \ + --transit-gateway-route-table-id tgw-rtb-0a823edbdeEXAMPLE \ + --filters "Name=type,Values=static" + +Output:: + + { + "Routes": [ + { + "DestinationCidrBlock": "10.0.2.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + }, + { + "DestinationCidrBlock": "10.1.0.0/24", + "TransitGatewayAttachments": [ + { + "ResourceId": "vpc-4EXAMPLE", + "TransitGatewayAttachmentId": "tgw-attach-09b52ccdb5EXAMPLE", + "ResourceType": "vpc" + } + ], + "Type": "static", + "State": "active" + } + ], + "AdditionalRoutesAvailable": false + } + +For more information, see `View Transit Gateway Route Tables `__ in the *AWS Transit Gateways Guide*. diff --git a/aws/dist/awscli/examples/ec2/start-instances.rst b/aws/dist/awscli/examples/ec2/start-instances.rst new file mode 100644 index 00000000..f5c90909 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/start-instances.rst @@ -0,0 +1,30 @@ +**To start an Amazon EC2 instance** + +This example starts the specified Amazon EBS-backed instance. + +Command:: + + aws ec2 start-instances --instance-ids i-1234567890abcdef0 + +Output:: + + { + "StartingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 0, + "Name": "pending" + }, + "PreviousState": { + "Code": 80, + "Name": "stopped" + } + } + ] + } + +For more information, see `Stop and Start Your Instance`_ in the *Amazon Elastic Compute Cloud User Guide*. + +.. _`Stop and Start Your Instance`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html + diff --git a/aws/dist/awscli/examples/ec2/stop-instances.rst b/aws/dist/awscli/examples/ec2/stop-instances.rst new file mode 100644 index 00000000..627c732f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/stop-instances.rst @@ -0,0 +1,30 @@ +**To stop an Amazon EC2 instance** + +This example stops the specified Amazon EBS-backed instance. + +Command:: + + aws ec2 stop-instances --instance-ids i-1234567890abcdef0 + +Output:: + + { + "StoppingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 64, + "Name": "stopping" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + +For more information, see `Stop and Start Your Instance`_ in the *Amazon Elastic Compute Cloud User Guide*. + +.. _`Stop and Start Your Instance`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html + diff --git a/aws/dist/awscli/examples/ec2/terminate-client-vpn-connections.rst b/aws/dist/awscli/examples/ec2/terminate-client-vpn-connections.rst new file mode 100644 index 00000000..2fca66d0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/terminate-client-vpn-connections.rst @@ -0,0 +1,26 @@ +**To terminate a connection to a Client VPN endpoint** + +The following ``terminate-client-vpn-connections`` example terminates the specified connection to the Client VPN endpoint. :: + + aws ec2 terminate-client-vpn-connections \ + --client-vpn-endpoint-id vpn-endpoint-123456789123abcde \ + --connection-id cvpn-connection-04edd76f5201e0cb8 + +Output:: + + { + "ClientVpnEndpointId": "vpn-endpoint-123456789123abcde", + "ConnectionStatuses": [ + { + "ConnectionId": "cvpn-connection-04edd76f5201e0cb8", + "PreviousStatus": { + "Code": "active" + }, + "CurrentStatus": { + "Code": "terminating" + } + } + ] + } + +For more information, see `Client Connections `__ in the *AWS Client VPN Administrator Guide*. diff --git a/aws/dist/awscli/examples/ec2/terminate-instances.rst b/aws/dist/awscli/examples/ec2/terminate-instances.rst new file mode 100644 index 00000000..b01fa8a3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/terminate-instances.rst @@ -0,0 +1,30 @@ +**To terminate an Amazon EC2 instance** + +This example terminates the specified instance. + +Command:: + + aws ec2 terminate-instances --instance-ids i-1234567890abcdef0 + +Output:: + + { + "TerminatingInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "CurrentState": { + "Code": 32, + "Name": "shutting-down" + }, + "PreviousState": { + "Code": 16, + "Name": "running" + } + } + ] + } + +For more information, see `Using Amazon EC2 Instances`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using Amazon EC2 Instances`: http://docs.aws.amazon.com/cli/latest/userguide/cli-ec2-launch.html + diff --git a/aws/dist/awscli/examples/ec2/unassign-ipv6-addresses.rst b/aws/dist/awscli/examples/ec2/unassign-ipv6-addresses.rst new file mode 100644 index 00000000..c63cb647 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/unassign-ipv6-addresses.rst @@ -0,0 +1,16 @@ +**To unassign an IPv6 address from a network interface** + +This example unassigns the specified IPv6 address from the specified network interface. + +Command:: + + aws ec2 unassign-ipv6-addresses --ipv6-addresses 2001:db8:1234:1a00:3304:8879:34cf:4071 --network-interface-id eni-23c49b68 + +Output:: + + { + "NetworkInterfaceId": "eni-23c49b68", + "UnassignedIpv6Addresses": [ + "2001:db8:1234:1a00:3304:8879:34cf:4071" + ] + } diff --git a/aws/dist/awscli/examples/ec2/unassign-private-ip-addresses.rst b/aws/dist/awscli/examples/ec2/unassign-private-ip-addresses.rst new file mode 100644 index 00000000..fbb066d7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/unassign-private-ip-addresses.rst @@ -0,0 +1,7 @@ +**To unassign a secondary private IP address from a network interface** + +This example unassigns the specified private IP address from the specified network interface. If the command succeeds, no output is returned. + +Command:: + + aws ec2 unassign-private-ip-addresses --network-interface-id eni-e5aa89a3 --private-ip-addresses 10.0.0.82 diff --git a/aws/dist/awscli/examples/ec2/unmonitor-instances.rst b/aws/dist/awscli/examples/ec2/unmonitor-instances.rst new file mode 100644 index 00000000..fd0fba52 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/unmonitor-instances.rst @@ -0,0 +1,20 @@ +**To disable detailed monitoring for an instance** + +This example command disables detailed monitoring for the specified instance. + +Command:: + + aws ec2 unmonitor-instances --instance-ids i-1234567890abcdef0 + +Output:: + + { + "InstanceMonitorings": [ + { + "InstanceId": "i-1234567890abcdef0", + "Monitoring": { + "State": "disabling" + } + } + ] + } diff --git a/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst b/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst new file mode 100644 index 00000000..313e2323 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-egress.rst @@ -0,0 +1,7 @@ +**To update an outbound security group rule description** + +This example updates the description for the security group rule that allows outbound access over port 80 to the ``203.0.113.0/24`` IPv4 address range. The description '``Outbound HTTP access to server 2``' replaces any existing description for the rule. If the command succeeds, no output is returned. + +Command:: + + aws ec2 update-security-group-rule-descriptions-egress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 80, "ToPort": 80, "IpRanges": [{"CidrIp": "203.0.113.0/24", "Description": "Outbound HTTP access to server 2"}]}]' diff --git a/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst b/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst new file mode 100644 index 00000000..98269eaf --- /dev/null +++ b/aws/dist/awscli/examples/ec2/update-security-group-rule-descriptions-ingress.rst @@ -0,0 +1,7 @@ +**To update an inbound security group rule description** + +This example updates the description for the security group rule that allows inbound access over port 22 from the ``203.0.113.0/16`` IPv4 address range. The description '``SSH access from ABC office``' replaces any existing description for the rule. If the command succeeds, no output is returned. + +Command:: + + aws ec2 update-security-group-rule-descriptions-ingress --group-id sg-123abc12 --ip-permissions '[{"IpProtocol": "tcp", "FromPort": 22, "ToPort": 22, "IpRanges": [{"CidrIp": "203.0.113.0/16", "Description": "SSH access from ABC office"}]}]' diff --git a/aws/dist/awscli/examples/ec2/wait/customer-gateway-available.rst b/aws/dist/awscli/examples/ec2/wait/customer-gateway-available.rst new file mode 100644 index 00000000..0e137fce --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/customer-gateway-available.rst @@ -0,0 +1,6 @@ +**To wait until a customer gateway is available** + +The following ``wait customer-gateway-available`` example pauses and resumes running only after it confirms that the specified customer gateway is available. It produces no output. :: + + aws ec2 wait customer-gateway-available \ + --customer-gateway-ids cgw-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/image-available.rst b/aws/dist/awscli/examples/ec2/wait/image-available.rst new file mode 100644 index 00000000..489e31a6 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/image-available.rst @@ -0,0 +1,6 @@ +**To wait until an image is available** + +The following ``wait image-available`` example pauses and resumes running only after it confirms that the specified Amazon Machine Image is available. It produces no output. :: + + aws ec2 wait image-available \ + --image-ids ami-0abcdef1234567890 diff --git a/aws/dist/awscli/examples/ec2/wait/image-exists.rst b/aws/dist/awscli/examples/ec2/wait/image-exists.rst new file mode 100644 index 00000000..0e911b06 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/image-exists.rst @@ -0,0 +1,6 @@ +**To wait until an image exists** + +The following ``wait image-exists`` example pauses and resumes running only after it confirms that the specified Amazon Machine Image exists. It produces no output. :: + + aws ec2 wait image-exists \ + --image-ids ami-0abcdef1234567890 diff --git a/aws/dist/awscli/examples/ec2/wait/instance-exists.rst b/aws/dist/awscli/examples/ec2/wait/instance-exists.rst new file mode 100644 index 00000000..808aca3f --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/instance-exists.rst @@ -0,0 +1,6 @@ +**To wait until an instance exists** + +The following ``wait instance-exists`` example pauses and resumes running only after it confirms that the specified instance exists. It produces no output. :: + + aws ec2 wait instance-exists \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/instance-running.rst b/aws/dist/awscli/examples/ec2/wait/instance-running.rst new file mode 100644 index 00000000..c56baabc --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/instance-running.rst @@ -0,0 +1,6 @@ +**To wait until an instance is running** + +The following ``wait instance-running`` example pauses and resumes running only after it confirms that the specified instance is running. It produces no output. :: + + aws ec2 wait instance-running \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/instance-status-ok.rst b/aws/dist/awscli/examples/ec2/wait/instance-status-ok.rst new file mode 100644 index 00000000..f05963fa --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/instance-status-ok.rst @@ -0,0 +1,6 @@ +**To wait until the status of an instance is OK** + +The following ``wait instance-status-ok`` example pauses and resumes running only after it confirms that the status of the specified instance is OK. It produces no output. :: + + aws ec2 wait instance-status-ok \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/instance-stopped.rst b/aws/dist/awscli/examples/ec2/wait/instance-stopped.rst new file mode 100644 index 00000000..561717f3 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/instance-stopped.rst @@ -0,0 +1,6 @@ +**To wait until an instance is stopped** + +The following ``wait instance-stopped`` example pauses and resumes running only after it confirms that the specified instance is stopped. It produces no output. :: + + aws ec2 wait instance-stopped \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/instance-terminated.rst b/aws/dist/awscli/examples/ec2/wait/instance-terminated.rst new file mode 100644 index 00000000..8e46b4e2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/instance-terminated.rst @@ -0,0 +1,6 @@ +**To wait until an instance terminates** + +The following ``wait instance-terminated`` example pauses and resumes running only after it confirms that the specified instance is terminated. It produces no output. :: + + aws ec2 wait instance-terminated \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/key-pair-exists.rst b/aws/dist/awscli/examples/ec2/wait/key-pair-exists.rst new file mode 100644 index 00000000..2fdaa439 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/key-pair-exists.rst @@ -0,0 +1,6 @@ +**To wait until a key pair exists** + +The following ``wait key-pair-exists`` example pauses and resumes running only after it confirms that the specified key pair exists. It produces no output. :: + + aws ec2 wait key-pair-exists \ + --key-names my-key-pair diff --git a/aws/dist/awscli/examples/ec2/wait/nat-gateway-available.rst b/aws/dist/awscli/examples/ec2/wait/nat-gateway-available.rst new file mode 100644 index 00000000..8f2abf7c --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/nat-gateway-available.rst @@ -0,0 +1,6 @@ +**To wait until a NAT gateway is available** + +The following ``wait nat-gateway-available`` example pauses and resumes running only after it confirms that the specified NAT gateway is available. It produces no output. :: + + aws ec2 wait nat-gateway-available \ + --nat-gateway-ids nat-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/network-interface-available.rst b/aws/dist/awscli/examples/ec2/wait/network-interface-available.rst new file mode 100644 index 00000000..a472b7d4 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/network-interface-available.rst @@ -0,0 +1,6 @@ +**To wait until a network interface is available** + +The following ``wait network-interface-available`` example pauses and resumes running only after it confirms that the specified network interface is available. It produces no output. :: + + aws ec2 wait network-interface-available \ + --network-interface-ids eni-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/password-data-available.rst b/aws/dist/awscli/examples/ec2/wait/password-data-available.rst new file mode 100644 index 00000000..d61005c7 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/password-data-available.rst @@ -0,0 +1,6 @@ +**To wait until the password data for a Windows instance is available** + +The following ``wait password-data-available`` example pauses and resumes running only after it confirms that the password data for the specified Windows instance is available. It produces no output. :: + + aws ec2 wait password-data-available \ + --instance-id i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/snapshot-completed.rst b/aws/dist/awscli/examples/ec2/wait/snapshot-completed.rst new file mode 100644 index 00000000..221f0ad0 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/snapshot-completed.rst @@ -0,0 +1,6 @@ +**To wait until a snapshot is completed** + +The following ``wait snapshot-completed`` example pauses and resumes running only after it confirms that the specified snapshot is completed. It produces no output. :: + + aws ec2 wait snapshot-completed \ + --snapshot-ids snap-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst b/aws/dist/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst new file mode 100644 index 00000000..99e1da71 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/spot-instance-request-fulfilled.rst @@ -0,0 +1,6 @@ +**To wait until an Spot Instance request is fulfilled** + +The following ``wait spot-instance-request-fulfilled`` example pauses and resumes running only after it confirms that a Spot Instance request is fulfilled in the specified Availability Zone. It produces no output. :: + + aws ec2 wait spot-instance-request-fulfilled \ + --filters Name=launched-availability-zone,Values=us-east-1 diff --git a/aws/dist/awscli/examples/ec2/wait/subnet-available.rst b/aws/dist/awscli/examples/ec2/wait/subnet-available.rst new file mode 100644 index 00000000..e3fca5e1 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/subnet-available.rst @@ -0,0 +1,6 @@ +**To wait until a subnet is available** + +The following ``wait subnet-available`` example pauses and resumes running only after it confirms that the specified subnet is available. It produces no output. :: + + aws ec2 wait subnet-available \ + --subnet-ids subnet-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/system-status-ok.rst b/aws/dist/awscli/examples/ec2/wait/system-status-ok.rst new file mode 100644 index 00000000..a1a98f62 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/system-status-ok.rst @@ -0,0 +1,6 @@ +**To wait until the system status is OK** + +The following ``wait system-status-ok`` example command pauses and resumes running only after it confirms that the system status of the specified instance is OK. It produces no output. :: + + aws ec2 wait system-status-ok \ + --instance-ids i-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/volume-available.rst b/aws/dist/awscli/examples/ec2/wait/volume-available.rst new file mode 100644 index 00000000..cd9543fd --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/volume-available.rst @@ -0,0 +1,6 @@ +**To wait until a volume is available** + +The following ``wait volume-available`` example command pauses and resumes running only after it confirms that the specified volume is available. It produces no output. :: + + aws ec2 wait volume-available \ + --volume-ids vol-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/volume-deleted.rst b/aws/dist/awscli/examples/ec2/wait/volume-deleted.rst new file mode 100644 index 00000000..b975c9c9 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/volume-deleted.rst @@ -0,0 +1,6 @@ +**To wait until a volume is deleted** + +The following ``wait volume-deleted`` example command pauses and resumes running only after it confirms that the specified volume is deleted. It produces no output. :: + + aws ec2 wait volume-deleted \ + --volume-ids vol-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/volume-in-use.rst b/aws/dist/awscli/examples/ec2/wait/volume-in-use.rst new file mode 100644 index 00000000..ad97f039 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/volume-in-use.rst @@ -0,0 +1,6 @@ +**To wait until a volume is in use** + +The following ``wait volume-in-use`` example pauses and resumes running only after it confirms that the specified volume is in use. It produces no output. :: + + aws ec2 wait volume-in-use \ + --volume-ids vol-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpc-available.rst b/aws/dist/awscli/examples/ec2/wait/vpc-available.rst new file mode 100644 index 00000000..4e075895 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpc-available.rst @@ -0,0 +1,6 @@ +**To wait until a virtual private cloud (VPC) is available** + +The following ``wait vpc-available`` example pauses and resumes running only after it confirms that the specified VPC is available. It produces no output. :: + + aws ec2 wait vpc-available \ + --vpc-ids vpc-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpc-exists.rst b/aws/dist/awscli/examples/ec2/wait/vpc-exists.rst new file mode 100644 index 00000000..6e999470 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpc-exists.rst @@ -0,0 +1,6 @@ +**To wait until a virtual private cloud (VPC) exists** + +The following ``wait vpc-exists`` example command pauses and resumes running only after it confirms that the specified VPC exists. :: + + aws ec2 wait vpc-exists \ + --vpc-ids vpc-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst b/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst new file mode 100644 index 00000000..c86c9dd2 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-deleted.rst @@ -0,0 +1,6 @@ +**To wait until a VPC peering connection is deleted** + +The following ``wait vpc-peering-connection-deleted`` example pauses and resumes running only after it confirms that the specified VPC peering connection is deleted. It produces no output. :: + + aws ec2 wait vpc-peering-connection-deleted \ + --vpc-peering-connection-ids pcx-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst b/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst new file mode 100644 index 00000000..fd3e63db --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpc-peering-connection-exists.rst @@ -0,0 +1,6 @@ +**To wait until a VPC peering connection exists** + +The following ``wait vpc-peering-connection-exists`` example pauses and continues only when it can confirm that the specified VPC peering connection exists. :: + + aws ec2 wait vpc-peering-connection-exists \ + --vpc-peering-connection-ids pcx-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpn-connection-available.rst b/aws/dist/awscli/examples/ec2/wait/vpn-connection-available.rst new file mode 100644 index 00000000..15560411 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpn-connection-available.rst @@ -0,0 +1,6 @@ +**To wait until a VPN connection is available** + +The following ``vpn-connection-available`` example pauses and resumes running only after it confirms that the specified VPN connection is available. It produces no output. :: + + aws ec2 wait vpn-connection-available \ + --vpn-connection-ids vpn-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/wait/vpn-connection-deleted.rst b/aws/dist/awscli/examples/ec2/wait/vpn-connection-deleted.rst new file mode 100644 index 00000000..419871af --- /dev/null +++ b/aws/dist/awscli/examples/ec2/wait/vpn-connection-deleted.rst @@ -0,0 +1,6 @@ +**To wait until a VPN connection is deleted** + +The following ``waitt vpn-connection-deleted`` example command pauses and continues when it can confirm that the specified VPN connection is deleted. It produces no output. :: + + aws ec2 wait vpn-connection-deleted \ + --vpn-connection-ids vpn-1234567890abcdef0 diff --git a/aws/dist/awscli/examples/ec2/withdraw-byoip-cidr.rst b/aws/dist/awscli/examples/ec2/withdraw-byoip-cidr.rst new file mode 100644 index 00000000..71ea1153 --- /dev/null +++ b/aws/dist/awscli/examples/ec2/withdraw-byoip-cidr.rst @@ -0,0 +1,16 @@ +**To stop advertising an address range** + +The following ``withdraw-byoip-cidr`` example stops advertising the specified address range. :: + + aws ec2 withdraw-byoip-cidr + --cidr 203.0.113.25/24 + +Output:: + + { + "ByoipCidr": { + "Cidr": "203.0.113.25/24", + "StatusMessage": "ipv4pool-ec2-1234567890abcdef0", + "State": "advertised" + } + } diff --git a/aws/dist/awscli/examples/ecr/batch-check-layer-availability.rst b/aws/dist/awscli/examples/ecr/batch-check-layer-availability.rst new file mode 100644 index 00000000..fe201d15 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/batch-check-layer-availability.rst @@ -0,0 +1,21 @@ +**To check the availability of a layer** + +The following ``batch-check-layer-availability`` example checks the availability of a layer with the digest ``sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed`` in the ``cluster-autoscaler`` repository. :: + + aws ecr batch-check-layer-availability \ + --repository-name cluster-autoscaler \ + --layer-digests sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed + +Output:: + + { + "layers": [ + { + "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed", + "layerAvailability": "AVAILABLE", + "layerSize": 2777, + "mediaType": "application/vnd.docker.container.image.v1+json" + } + ], + "failures": [] + } diff --git a/aws/dist/awscli/examples/ecr/batch-delete-image.rst b/aws/dist/awscli/examples/ecr/batch-delete-image.rst new file mode 100644 index 00000000..f4653f7f --- /dev/null +++ b/aws/dist/awscli/examples/ecr/batch-delete-image.rst @@ -0,0 +1,45 @@ +**Example 1: To delete an image** + +The following ``batch-delete-image`` example deletes an image with the tag ``precise`` in the specified repository in the default registry for an account. :: + + aws ecr batch-delete-image \ + --repository-name ubuntu \ + --image-ids imageTag=precise + +Output:: + + { + "failures": [], + "imageIds": [ + { + "imageTag": "precise", + "imageDigest": "sha256:19665f1e6d1e504117a1743c0a3d3753086354a38375961f2e665416ef4b1b2f" + } + ] + } + +**Example 2: To delete multiple images** + +The following ``batch-delete-image`` example deletes all images tagged with ``prod`` and ``team1`` in the specified repository. :: + + aws ecr batch-delete-image \ + --repository-name MyRepository \ + --image-ids imageTag=prod imageTag=team1 + +Output:: + + { + "imageIds": [ + { + "imageDigest": "sha256:123456789012", + "imageTag": "prod" + }, + { + "imageDigest": "sha256:567890121234", + "imageTag": "team1" + } + ], + "failures": [] + } + +For more information, see `Deleting an Image `__ in the *Amazon ECR User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecr/batch-get-image.rst b/aws/dist/awscli/examples/ecr/batch-get-image.rst new file mode 100644 index 00000000..782c180c --- /dev/null +++ b/aws/dist/awscli/examples/ecr/batch-get-image.rst @@ -0,0 +1,61 @@ +**Example 1: To get an image** + +The following ``batch-get-image`` example gets an image with the tag ``v1.13.6`` in a repository called +``cluster-autoscaler`` in the default registry for an account. :: + + aws ecr batch-get-image \ + --repository-name cluster-autoscaler \ + --image-ids imageTag=v1.13.6 + +Output:: + + { + "images": [ + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "imageId": { + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTag": "v1.13.6" + }, + "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 2777,\n \"digest\": \"sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 17743696,\n \"digest\": \"sha256:39fafc05754f195f134ca11ecdb1c9a691ab0848c697fffeb5a85f900caaf6e1\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 2565026,\n \"digest\": \"sha256:8c8a779d3a537b767ae1091fe6e00c2590afd16767aa6096d1b318d75494819f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28005981,\n \"digest\": \"sha256:c44ba47496991c9982ee493b47fd25c252caabf2b4ae7dd679c9a27b6a3c8fb7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 775,\n \"digest\": \"sha256:e2c388b44226544363ca007be7b896bcce1baebea04da23cbd165eac30be650f\"\n }\n ]\n}" + } + ], + "failures": [] + } + +**Example 2: To get multiple images** + +The following ``batch-get-image`` example displays details of all images tagged with ``prod`` and ``team1`` in the specified repository. :: + + aws ecr batch-get-image \ + --repository-name MyRepository \ + --image-ids imageTag=prod imageTag=team1 + +Output:: + + { + "images": [ + { + "registryId": "123456789012", + "repositoryName": "MyRepository", + "imageId": { + "imageDigest": "sha256:123456789012", + "imageTag": "prod" + }, + "imageManifest": "manifestExample1" + }, + { + "registryId": "567890121234", + "repositoryName": "MyRepository", + "imageId": { + "imageDigest": "sha256:123456789012", + "imageTag": "team1" + }, + "imageManifest": "manifestExample2" + } + ], + "failures": [] + } + +For more information, see `Images `__ in the *Amazon ECR User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecr/complete-layer-upload.rst b/aws/dist/awscli/examples/ecr/complete-layer-upload.rst new file mode 100644 index 00000000..7d156253 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/complete-layer-upload.rst @@ -0,0 +1,17 @@ +**To complete an image layer upload** + +The following ``complete-layer-upload`` example completes an image layer upload to the ``layer-test`` repository. :: + + aws ecr complete-layer-upload \ + --repository-name layer-test \ + --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ + --layer-digests 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9:48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e + +Output:: + + { + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", + "layerDigest": "sha256:9a77f85878aa1906f2020a0ecdf7a7e962d57e882250acd773383224b3fe9a02", + "repositoryName": "layer-test", + "registryId": "130757420319" + } diff --git a/aws/dist/awscli/examples/ecr/create-repository.rst b/aws/dist/awscli/examples/ecr/create-repository.rst new file mode 100644 index 00000000..e628344c --- /dev/null +++ b/aws/dist/awscli/examples/ecr/create-repository.rst @@ -0,0 +1,18 @@ +**To create a repository** + +This example creates a repository called ``nginx-web-app`` inside the +``project-a`` namespace in the default registry for an account. + +Command:: + + aws ecr create-repository --repository-name project-a/nginx-web-app + +Output:: + + { + "repository": { + "registryId": "", + "repositoryName": "project-a/nginx-web-app", + "repositoryArn": "arn:aws:ecr:us-west-2::repository/project-a/nginx-web-app" + } + } diff --git a/aws/dist/awscli/examples/ecr/delete-lifecycle-policy.rst b/aws/dist/awscli/examples/ecr/delete-lifecycle-policy.rst new file mode 100644 index 00000000..d0ddfc72 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/delete-lifecycle-policy.rst @@ -0,0 +1,15 @@ +**To delete the lifecycle policy for a repository** + +The following ``delete-lifecycle-policy`` example deletes the lifecycle policy for the ``hello-world`` repository. :: + + aws ecr delete-lifecycle-policy \ + --repository-name hello-world + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "hello-world", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Remove untagged images.\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":10},\"action\":{\"type\":\"expire\"}}]}", + "lastEvaluatedAt": 0.0 + } diff --git a/aws/dist/awscli/examples/ecr/delete-repository-policy.rst b/aws/dist/awscli/examples/ecr/delete-repository-policy.rst new file mode 100644 index 00000000..e900ee01 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/delete-repository-policy.rst @@ -0,0 +1,14 @@ +**To delete the repository policy for a repository** + +The following ``delete-repository-policy`` example deletes the repository policy for the ``cluster-autoscaler`` repository. :: + + aws ecr delete-repository-policy \ + --repository-name cluster-autoscaler + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff --git a/aws/dist/awscli/examples/ecr/delete-repository.rst b/aws/dist/awscli/examples/ecr/delete-repository.rst new file mode 100644 index 00000000..a172532e --- /dev/null +++ b/aws/dist/awscli/examples/ecr/delete-repository.rst @@ -0,0 +1,19 @@ +**To delete a repository** + +This example command force deletes a repository named ``ubuntu`` in the default +registry for an account. The ``--force`` flag is required if the repository +contains images. + +Command:: + + aws ecr delete-repository --force --repository-name ubuntu + +Output:: + + { + "repository": { + "registryId": "", + "repositoryName": "ubuntu", + "repositoryArn": "arn:aws:ecr:us-west-2::repository/ubuntu" + } + } diff --git a/aws/dist/awscli/examples/ecr/describe-images.rst b/aws/dist/awscli/examples/ecr/describe-images.rst new file mode 100644 index 00000000..b4058f63 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/describe-images.rst @@ -0,0 +1,24 @@ +**To describe an image in a repository** + +The folowing ``describe-images`` example displays details about an image in the ``cluster-autoscaler`` repository with the tag ``v1.13.6``. :: + + aws ecr describe-images \ + --repository-name cluster-autoscaler \ + --image-ids imageTag=v1.13.6 + +Output:: + + { + "imageDetails": [ + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTags": [ + "v1.13.6" + ], + "imageSizeInBytes": 48318255, + "imagePushedAt": 1565128275.0 + } + ] + } diff --git a/aws/dist/awscli/examples/ecr/describe-repositories.rst b/aws/dist/awscli/examples/ecr/describe-repositories.rst new file mode 100644 index 00000000..cc04891f --- /dev/null +++ b/aws/dist/awscli/examples/ecr/describe-repositories.rst @@ -0,0 +1,24 @@ +**To describe the repositories in a registry** + +This example describes the repositories in the default registry for an account. + +Command:: + + aws ecr describe-repositories + +Output:: + + { + "repositories": [ + { + "registryId": "012345678910", + "repositoryName": "ubuntu", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu" + }, + { + "registryId": "012345678910", + "repositoryName": "test", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test" + } + ] + } diff --git a/aws/dist/awscli/examples/ecr/get-authorization-token.rst b/aws/dist/awscli/examples/ecr/get-authorization-token.rst new file mode 100644 index 00000000..69ad9127 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-authorization-token.rst @@ -0,0 +1,58 @@ +**To get an authorization token for your default registry** + +This example command gets an authorization token for your default registry. + +Command:: + + aws ecr get-authorization-token + +Output:: + + { + "authorizationData": [ + { + "authorizationToken": "QVdTOkN...", + "expiresAt": 1448875853.241, + "proxyEndpoint": "https://.dkr.ecr.us-west-2.amazonaws.com" + } + ] + } + + +**To get the decoded password for your default registry** + +This example command gets an authorization token for your default registry and +returns the decoded password for you to use in a ``docker login`` command. + +.. note:: + + Mac OSX users should use the ``-D`` option to ``base64`` to decode the + token data. + +Command:: + + aws ecr get-authorization-token --output text \ + --query 'authorizationData[].authorizationToken' \ + | base64 -D | cut -d: -f2 + + +**To `docker login` with your decoded password** + +This example command uses your decoded password to add authentication +information to your Docker installation by using the ``docker login`` command. +The user name is ``AWS``, and you can use any email you want (Amazon ECR does +nothing with this information, but ``docker login`` required the email field). + +.. note:: + + The final argument is the ``proxyEndpoint`` returned from + ``get-authorization-token`` without the ``https://`` prefix. + +Command:: + + docker login -u AWS -p -e .dkr.ecr.us-west-2.amazonaws.com + +Output:: + + WARNING: login credentials saved in $HOME/.docker/config.json + Login Succeeded diff --git a/aws/dist/awscli/examples/ecr/get-download-url-for-layer.rst b/aws/dist/awscli/examples/ecr/get-download-url-for-layer.rst new file mode 100644 index 00000000..40cf2a55 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-download-url-for-layer.rst @@ -0,0 +1,14 @@ +**To get the download URL of a layer** + +The following ``get-download-url-for-layer`` example displays the download URL of a layer with the digest ``sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed`` in the ``cluster-autoscaler`` repository. :: + + aws ecr get-download-url-for-layer \ + --repository-name cluster-autoscaler \ + --layer-digest sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed + +Output:: + + { + "downloadUrl": "https://prod-us-west-2-starport-layer-bucket.s3.us-west-2.amazonaws.com/e501-012345678910-9cb60dc0-7284-5643-3987-da6dac0465f0/04620aac-66a5-4167-8232-55ee7ef6d565?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190814T220617Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=AKIA32P3D2JDNMVAJLGF%2F20190814%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=9161345894947a1672467a0da7a1550f2f7157318312fe4941b59976239c3337", + "layerDigest": "sha256:6171c7451a50945f8ddd72f7732cc04d7a0d1f48138a426b2e64387fdeb834ed" + } diff --git a/aws/dist/awscli/examples/ecr/get-lifecycle-policy-preview.rst b/aws/dist/awscli/examples/ecr/get-lifecycle-policy-preview.rst new file mode 100644 index 00000000..1047c4e5 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-lifecycle-policy-preview.rst @@ -0,0 +1,19 @@ +**To retrieve details for a lifecycle policy preview** + +The following ``get-lifecycle-policy-preview`` example retrieves the result of a lifecycle policy preview for a repository called ``project-a/amazon-ecs-sample`` in the default registry for an account. :: + + aws ecr get-lifecycle-policy-preview \ + --repository-name "project-a/amazon-ecs-sample" + +Output:: + + { + "registryId": "", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", + "status": "COMPLETE", + "previewResults": [], + "summary": { + "expiringImageTotalCount": 0 + } + } diff --git a/aws/dist/awscli/examples/ecr/get-lifecycle-policy.rst b/aws/dist/awscli/examples/ecr/get-lifecycle-policy.rst new file mode 100644 index 00000000..43211aa6 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-lifecycle-policy.rst @@ -0,0 +1,16 @@ +**To retrieve a lifecycle policy** + +This example retrieves the lifecycle policy for a repository called ``project-a/amazon-ecs-sample`` in the default registry for an account. + +Command:: + + aws ecr get-lifecycle-policy --repository-name "project-a/amazon-ecs-sample" + +Output:: + + { + "registryId": "", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}", + "lastEvaluatedAt": 1504295007.0 + } diff --git a/aws/dist/awscli/examples/ecr/get-login.rst b/aws/dist/awscli/examples/ecr/get-login.rst new file mode 100644 index 00000000..b6cd8e5a --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-login.rst @@ -0,0 +1,26 @@ +**To retrieve a Docker login command to your default registry** + +This example prints a command that you can use to log in to your default Amazon +ECR registry. + +Command:: + + aws ecr get-login + +Output:: + + docker login -u AWS -p -e none https://.dkr.ecr..amazonaws.com + +**To log in to another account's registry** + +This example prints one or more commands that you can use to log in to +Amazon ECR registries associated with other accounts. + +Command:: + + aws ecr get-login --registry-ids 012345678910 023456789012 + +Output:: + + docker login -u -p -e none + docker login -u -p -e none diff --git a/aws/dist/awscli/examples/ecr/get-login_description.rst b/aws/dist/awscli/examples/ecr/get-login_description.rst new file mode 100644 index 00000000..1de22ab7 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-login_description.rst @@ -0,0 +1,16 @@ +**To log in to an Amazon ECR registry** + +This command retrieves a token that is valid for a specified registry for 12 +hours, and then it prints a ``docker login`` command with that authorization +token. You can execute the printed command to log in to your registry with +Docker. After you have logged in to an Amazon ECR registry with this command, +you can use the Docker CLI to push and pull images from that registry until the +token expires. + +.. note:: + + This command writes displays ``docker login`` commands to stdout with + authentication credentials. Your credentials could be visible by other + users on your system in a process list display or a command history. If you + are not on a secure system, you should consider this risk and login + interactively. For more information, see ``get-authorization-token``. diff --git a/aws/dist/awscli/examples/ecr/get-repository-policy.rst b/aws/dist/awscli/examples/ecr/get-repository-policy.rst new file mode 100644 index 00000000..471b3190 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/get-repository-policy.rst @@ -0,0 +1,14 @@ +**To retrieve the repository policy for a repository** + +The following ``get-repository-policy`` example displays details about the repository policy for the ``cluster-autoscaler`` repository. :: + + aws ecr get-repository-policy \ + --repository-name cluster-autoscaler + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff --git a/aws/dist/awscli/examples/ecr/initiate-layer-upload.rst b/aws/dist/awscli/examples/ecr/initiate-layer-upload.rst new file mode 100644 index 00000000..81d3ae4d --- /dev/null +++ b/aws/dist/awscli/examples/ecr/initiate-layer-upload.rst @@ -0,0 +1,13 @@ +**To initiate an image layer upload** + +The following ``initiate-layer-upload`` example initiates an image layer upload to the ``layer-test`` repository. :: + + aws ecr initiate-layer-upload \ + --repository-name layer-test + +Output:: + + { + "partSize": 10485760, + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9" + } diff --git a/aws/dist/awscli/examples/ecr/list-images.rst b/aws/dist/awscli/examples/ecr/list-images.rst new file mode 100644 index 00000000..9350e454 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/list-images.rst @@ -0,0 +1,25 @@ +**To list the images in a repository** + +The following ``list-images`` example displays a list of the images in the ``cluster-autoscaler`` repository. :: + + aws ecr list-images \ + --repository-name cluster-autoscaler + +Output:: + + { + "imageIds": [ + { + "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", + "imageTag": "v1.13.8" + }, + { + "imageDigest": "sha256:99c6fb4377e9a420a1eb3b410a951c9f464eff3b7dbc76c65e434e39b94b6570", + "imageTag": "v1.13.7" + }, + { + "imageDigest": "sha256:4a1c6567c38904384ebc64e35b7eeddd8451110c299e3368d2210066487d97e5", + "imageTag": "v1.13.6" + } + ] + } diff --git a/aws/dist/awscli/examples/ecr/list-tags-for-resource.rst b/aws/dist/awscli/examples/ecr/list-tags-for-resource.rst new file mode 100644 index 00000000..4d5748fe --- /dev/null +++ b/aws/dist/awscli/examples/ecr/list-tags-for-resource.rst @@ -0,0 +1,18 @@ +**To list the tags for repository** + +The following ``list-tags-for-resource`` example displays a list of the tags associated with the ``hello-world`` repository. :: + + aws ecr list-tags-for-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world + +Output:: + + { + "tags": [ + { + "Key": "Stage", + "Value": "Integ" + } + ] + } + diff --git a/aws/dist/awscli/examples/ecr/put-image-tag-mutability.rst b/aws/dist/awscli/examples/ecr/put-image-tag-mutability.rst new file mode 100644 index 00000000..01522579 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/put-image-tag-mutability.rst @@ -0,0 +1,15 @@ +**To make a repository's image tags immutable** + +The following ``put-image-tag-mutability`` example sets immutable image tags on the ``hello-world`` repository. :: + + aws ecr put-image-tag-mutability \ + --repository-name hello-world \ + --image-tag-mutability IMMUTABLE + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "hello-world", + "imageTagMutability": "IMMUTABLE" + } diff --git a/aws/dist/awscli/examples/ecr/put-image.rst b/aws/dist/awscli/examples/ecr/put-image.rst new file mode 100644 index 00000000..c1bd3033 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/put-image.rst @@ -0,0 +1,91 @@ +**To retag an image with its manifest** + +The following ``put-image`` example creates a new tag in the ``hello-world`` repository with an existing image manifest. :: + + aws ecr put-image \ + --repository-name hello-world \ + --image-tag 2019.08 \ + --image-manifest file://hello-world.manifest.json + +Contents of ``hello-world.manifest.json``:: + + { + "schemaVersion": 2, + "mediaType": "application/vnd.docker.distribution.manifest.v2+json", + "config": { + "mediaType": "application/vnd.docker.container.image.v1+json", + "size": 5695, + "digest": "sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980" + }, + "layers": [ + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 39096921, + "digest": "sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 57938, + "digest": "sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 423, + "digest": "sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 680, + "digest": "sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 162, + "digest": "sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28268840, + "digest": "sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 35369152, + "digest": "sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 155, + "digest": "sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28737, + "digest": "sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 190, + "digest": "sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7" + }, + { + "mediaType": "application/vnd.docker.image.rootfs.diff.tar.gzip", + "size": 28748, + "digest": "sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee" + } + ] + } + +Output:: + + { + "image": { + "registryId": "130757420319", + "repositoryName": "hello-world", + "imageId": { + "imageDigest": "sha256:8ece96b74f87652876199d83bd107d0435a196133af383ac54cb82b6cc5283ae", + "imageTag": "2019.08" + }, + "imageManifest": "{\n \"schemaVersion\": 2,\n \"mediaType\": \"application/vnd.docker.distribution.manifest.v2+json\",\n \"config\": {\n \"mediaType\": \"application/vnd.docker.container.image.v1+json\",\n \"size\": 5695,\n \"digest\": \"sha256:cea5fe7701b7db3dd1c372f3cea6f43cdda444fcc488f530829145e426d8b980\"\n },\n \"layers\": [\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 39096921,\n \"digest\": \"sha256:d8868e50ac4c7104d2200d42f432b661b2da8c1e417ccfae217e6a1e04bb9295\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 57938,\n \"digest\": \"sha256:83251ac64627fc331584f6c498b3aba5badc01574e2c70b2499af3af16630eed\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 423,\n \"digest\": \"sha256:589bba2f1b36ae56f0152c246e2541c5aa604b058febfcf2be32e9a304fec610\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 680,\n \"digest\": \"sha256:d62ecaceda3964b735cdd2af613d6bb136a52c1da0838b2ff4b4dab4212bcb1c\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 162,\n \"digest\": \"sha256:6d93b41cfc6bf0d2522b7cf61588de4cd045065b36c52bd3aec2ba0622b2b22b\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28268840,\n \"digest\": \"sha256:6986b4d4c07932c680b3587f2eac8b0e013568c003cc23b04044628a5c5e599f\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 35369152,\n \"digest\": \"sha256:8c5ec60f10102dc8da0649d866c7c2f706e459d0bdc25c83ad2de86f4996c276\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 155,\n \"digest\": \"sha256:cde50b1c594539c5f67cbede9aef95c9ae321ccfb857f7b251b45b84198adc85\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28737,\n \"digest\": \"sha256:2e102807ab72a73fc9abf53e8c50e421bdc337a0a8afcb242176edeec65977e4\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 190,\n \"digest\": \"sha256:fc379bbd5ed37808772bef016553a297356c59b8f134659e6ee4ecb563c2f5a7\"\n },\n {\n \"mediaType\": \"application/vnd.docker.image.rootfs.diff.tar.gzip\",\n \"size\": 28748,\n \"digest\": \"sha256:021db240dfccf5a1aff19507d17c0177e5888e518acf295b52204b1825e8b7ee\"\n }\n ]\n}\n" + } + } diff --git a/aws/dist/awscli/examples/ecr/put-lifecycle-policy.rst b/aws/dist/awscli/examples/ecr/put-lifecycle-policy.rst new file mode 100644 index 00000000..c9b83680 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/put-lifecycle-policy.rst @@ -0,0 +1,36 @@ +**To create a lifecycle policy** + +This example creates a lifecycle policy defined by ``policy.json` for a repository called +``project-a/amazon-ecs-sample`` in the default registry for an account. + +Command:: + + aws ecr put-lifecycle-policy --repository-name "project-a/amazon-ecs-sample" --lifecycle-policy-text "file://policy.json" + +JSON file format:: + + { + "rules": [ + { + "rulePriority": 1, + "description": "Expire images older than 14 days", + "selection": { + "tagStatus": "untagged", + "countType": "sinceImagePushed", + "countUnit": "days", + "countNumber": 14 + }, + "action": { + "type": "expire" + } + } + ] + } + +Output:: + + { + "registryId": "", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\"rules\":[{\"rulePriority\":1,\"description\":\"Expire images older than 14 days\",\"selection\":{\"tagStatus\":\"untagged\",\"countType\":\"sinceImagePushed\",\"countUnit\":\"days\",\"countNumber\":14},\"action\":{\"type\":\"expire\"}}]}" + } diff --git a/aws/dist/awscli/examples/ecr/set-repository-policy.rst b/aws/dist/awscli/examples/ecr/set-repository-policy.rst new file mode 100644 index 00000000..d296b145 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/set-repository-policy.rst @@ -0,0 +1,33 @@ +**To set the repository policy for a repository** + +The following ``set-repository-polixy`` example attaches a repository policy contained in a file to the ``cluster-autoscaler`` repository. :: + + aws ecr set-repository-policy \ + --repository-name cluster-autoscaler \ + --policy-text file://my-policy.json + +Contents of ``my-policy.json``:: + + { + "Version" : "2008-10-17", + "Statement" : [ + { + "Sid" : "allow public pull", + "Effect" : "Allow", + "Principal" : "*", + "Action" : [ + "ecr:BatchCheckLayerAvailability", + "ecr:BatchGetImage", + "ecr:GetDownloadUrlForLayer" + ] + } + ] + } + +Output:: + + { + "registryId": "012345678910", + "repositoryName": "cluster-autoscaler", + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"allow public pull\",\n \"Effect\" : \"Allow\",\n \"Principal\" : \"*\",\n \"Action\" : [ \"ecr:BatchCheckLayerAvailability\", \"ecr:BatchGetImage\", \"ecr:GetDownloadUrlForLayer\" ]\n } ]\n}" + } diff --git a/aws/dist/awscli/examples/ecr/start-lifecycle-policy-preview.rst b/aws/dist/awscli/examples/ecr/start-lifecycle-policy-preview.rst new file mode 100644 index 00000000..cd58bbeb --- /dev/null +++ b/aws/dist/awscli/examples/ecr/start-lifecycle-policy-preview.rst @@ -0,0 +1,37 @@ +**To create a lifecycle policy preview** + +This example creates a lifecycle policy preview defined by ``policy.json` for a repository called +``project-a/amazon-ecs-sample`` in the default registry for an account. + +Command:: + + aws ecr start-lifecycle-policy-preview --repository-name "project-a/amazon-ecs-sample" --lifecycle-policy-text "file://policy.json" + +JSON file format:: + + { + "rules": [ + { + "rulePriority": 1, + "description": "Expire images older than 14 days", + "selection": { + "tagStatus": "untagged", + "countType": "sinceImagePushed", + "countUnit": "days", + "countNumber": 14 + }, + "action": { + "type": "expire" + } + } + ] + } + +Output:: + + { + "registryId": "", + "repositoryName": "project-a/amazon-ecs-sample", + "lifecyclePolicyText": "{\n \"rules\": [\n {\n \"rulePriority\": 1,\n \"description\": \"Expire images older than 14 days\",\n \"selection\": {\n \"tagStatus\": \"untagged\",\n \"countType\": \"sinceImagePushed\",\n \"countUnit\": \"days\",\n \"countNumber\": 14\n },\n \"action\": {\n \"type\": \"expire\"\n }\n }\n ]\n}\n", + "status": "IN_PROGRESS" + } diff --git a/aws/dist/awscli/examples/ecr/tag-resource.rst b/aws/dist/awscli/examples/ecr/tag-resource.rst new file mode 100644 index 00000000..1c6ea66a --- /dev/null +++ b/aws/dist/awscli/examples/ecr/tag-resource.rst @@ -0,0 +1,9 @@ +**To tag a repository** + +The following ``tag-resource`` example sets a tag with key ``Stage`` and value ``Integ`` on the ``hello-world`` repository. :: + + aws ecr tag-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ + --tags Key=Stage,Value=Integ + +This command produces no output. diff --git a/aws/dist/awscli/examples/ecr/untag-resource.rst b/aws/dist/awscli/examples/ecr/untag-resource.rst new file mode 100644 index 00000000..4ed80228 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/untag-resource.rst @@ -0,0 +1,9 @@ +**To untag a repository** + +The following ``untag-resource`` example removes the tag with the key ``Stage`` from the ``hello-world`` repository. :: + + aws ecr untag-resource \ + --resource-arn arn:aws:ecr:us-west-2:012345678910:repository/hello-world \ + --tag-keys Stage + +This command produces no output. diff --git a/aws/dist/awscli/examples/ecr/upload-layer-part.rst b/aws/dist/awscli/examples/ecr/upload-layer-part.rst new file mode 100644 index 00000000..156a29f6 --- /dev/null +++ b/aws/dist/awscli/examples/ecr/upload-layer-part.rst @@ -0,0 +1,19 @@ +**To upload a layer part** + +This following ``upload-layer-part`` uploads an image layer part to the ``layer-test`` repository. :: + + aws ecr upload-layer-part \ + --repository-name layer-test \ + --upload-id 6cb64b8a-9378-0e33-2ab1-b780fab8a9e9 \ + --part-first-byte 0 \ + --part-last-byte 8323314 \ + --layer-part-blob file:///var/lib/docker/image/overlay2/layerdb/sha256/ff986b10a018b48074e6d3a68b39aad8ccc002cdad912d4148c0f92b3729323e/layer.b64 + +Output:: + + { + "uploadId": "6cb64b8a-9378-0e33-2ab1-b780fab8a9e9", + "registryId": "012345678910", + "lastByteReceived": 8323314, + "repositoryName": "layer-test" + } diff --git a/aws/dist/awscli/examples/ecs/create-cluster.rst b/aws/dist/awscli/examples/ecs/create-cluster.rst new file mode 100644 index 00000000..5ec5f222 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/create-cluster.rst @@ -0,0 +1,60 @@ +**Example 1: To create a new cluster** + +The following ``create-cluster`` example creates a cluster. :: + + aws ecs create-cluster --cluster-name MyCluster + +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "MyCluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [] + } + } + +**Example 2: To create a new cluster with multiple tags** + +The following ``create-cluster`` example creates a cluster with multiple tags. For more information about adding tags using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface `_ in the *AWS CLI User Guide*. :: + + aws ecs create-cluster \ + --cluster-name MyCluster \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "MyCluster", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } + } + +For more information, see `Creating a Cluster `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/create-service.rst b/aws/dist/awscli/examples/ecs/create-service.rst new file mode 100644 index 00000000..b6c1997d --- /dev/null +++ b/aws/dist/awscli/examples/ecs/create-service.rst @@ -0,0 +1,253 @@ +**Example 1: To create a service with a Fargate task** + +The following ``create-service`` example shows how to create a service using a Fargate task. :: + + aws ecs create-service \ + --cluster MyCluster \ + --service-name MyService \ + --task-definition sample-fargate:1 \ + --desired-count 2 \ + --launch-type FARGATE \ + --platform-version LATEST \ + --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321],assignPublicIp=ENABLED}" \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +Output:: + + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", + "serviceName": "MyService", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 2, + "runningCount": 0, + "pendingCount": 0, + "launchType": "FARGATE", + "platformVersion": "LATEST", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "id": "ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:1", + "desiredCount": 2, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557119253.821, + "updatedAt": 1557119253.821, + "launchType": "FARGATE", + "platformVersion": "1.3.0", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "ENABLED" + } + } + } + ], + "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", + "events": [], + "createdAt": 1557119253.821, + "placementConstraints": [], + "placementStrategy": [], + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "ENABLED" + } + }, + "schedulingStrategy": "REPLICA", + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ], + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } + +**Example 2: To create a service using the EC2 launch type** + +The following ``create-service`` example shows how to create a service called ``ecs-simple-service`` with a task that uses the EC2 launch type. The service uses the ``sleep360`` task definition and it maintains 1 instantiation of the task. :: + + aws ecs create-service \ + --cluster MyCluster \ + --service-name ecs-simple-service \ + --task-definition sleep360:2 \ + --desired-count 1 + +Output:: + + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/ecs-simple-service", + "serviceName": "ecs-simple-service", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 1, + "runningCount": 0, + "pendingCount": 0, + "launchType": "EC2", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "id": "ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "desiredCount": 1, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557206498.798, + "updatedAt": 1557206498.798, + "launchType": "EC2" + } + ], + "events": [], + "createdAt": 1557206498.798, + "placementConstraints": [], + "placementStrategy": [], + "schedulingStrategy": "REPLICA", + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } + +**Example 3: To create a service that uses an external deployment controller** + +The following ``create-service`` example creates a service that uses an external deployment controller. :: + + aws ecs create-service \ + --cluster MyCluster \ + --service-name MyService \ + --deployment-controller type=EXTERNAL \ + --desired-count 1 + +Output:: + + { + "service": { + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService", + "serviceName": "MyService", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "loadBalancers": [], + "serviceRegistries": [], + "status": "ACTIVE", + "desiredCount": 1, + "runningCount": 0, + "pendingCount": 0, + "launchType": "EC2", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "taskSets": [], + "deployments": [], + "roleArn": "arn:aws:iam::123456789012:role/aws-service-role/ecs.amazonaws.com/AWSServiceRoleForECS", + "events": [], + "createdAt": 1557128207.101, + "placementConstraints": [], + "placementStrategy": [], + "schedulingStrategy": "REPLICA", + "deploymentController": { + "type": "EXTERNAL" + }, + "enableECSManagedTags": false, + "propagateTags": "NONE" + } + } + +**Example 4: To create a new service behind a load balancer** + +The following ``create-service`` example shows how to create a service that is behind a load balancer. You must have a load balancer configured in the same Region as your container instance. This example uses the ``--cli-input-json`` option and a JSON input file called ``ecs-simple-service-elb.json`` with the following content:: + + { + "serviceName": "ecs-simple-service-elb", + "taskDefinition": "ecs-demo", + "loadBalancers": [ + { + "loadBalancerName": "EC2Contai-EcsElast-123456789012", + "containerName": "simple-demo", + "containerPort": 80 + } + ], + "desiredCount": 10, + "role": "ecsServiceRole" + } + +Command:: + + aws ecs create-service \ + --cluster MyCluster \ + --service-name ecs-simple-service-elb \ + --cli-input-json file://ecs-simple-service-elb.json + +Output:: + + { + "service": { + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/ecs-demo:1", + "pendingCount": 0, + "loadBalancers": [ + { + "containerName": "ecs-demo", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-123456789012" + } + ], + "roleArn": "arn:aws:iam::123456789012:role/ecsServiceRole", + "desiredCount": 10, + "serviceName": "ecs-simple-service-elb", + "clusterArn": "arn:aws:ecs:`_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/create-task-set.rst b/aws/dist/awscli/examples/ecs/create-task-set.rst new file mode 100644 index 00000000..3fca4ffa --- /dev/null +++ b/aws/dist/awscli/examples/ecs/create-task-set.rst @@ -0,0 +1,45 @@ +**To create a task set** + +The following ``create-task-set`` example creates a task set in a service that uses an external deployment controller. :: + + aws ecs create-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-definition MyTaskDefinition:2 \ + --network-configuration "awsvpcConfiguration={subnets=[subnet-12344321],securityGroups=[sg-12344321]}" + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/MyTaskDefinition:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557128360.711, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557128360.711 + } + } diff --git a/aws/dist/awscli/examples/ecs/delete-account-setting.rst b/aws/dist/awscli/examples/ecs/delete-account-setting.rst new file mode 100644 index 00000000..25ee0419 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/delete-account-setting.rst @@ -0,0 +1,19 @@ +**To delete the account settings for a specific IAM user or IAM role** + +The following example ``delete-account-setting`` deletes the account settings for the specific IAM user or IAM role. :: + + aws ecs delete-account-setting \ + --name serviceLongArnFormat \ + --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/delete-attributes.rst b/aws/dist/awscli/examples/ecs/delete-attributes.rst new file mode 100644 index 00000000..904de799 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/delete-attributes.rst @@ -0,0 +1,18 @@ +**To delete one or more custom attributes from an Amazon ECS resource** + +The following ``delete-attributes`` deletes an attribute with the name ``stack`` from a container instance. :: + + aws ecs delete-attributes \ + --attributes name=stack,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } diff --git a/aws/dist/awscli/examples/ecs/delete-cluster.rst b/aws/dist/awscli/examples/ecs/delete-cluster.rst new file mode 100644 index 00000000..78440214 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/delete-cluster.rst @@ -0,0 +1,23 @@ +**To delete an empty cluster** + +The following ``delete-cluster`` example deletes the specified empty cluster. :: + + aws ecs delete-cluster --cluster MyCluster + +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "status": "INACTIVE", + "clusterName": "MyCluster", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 0 + "statistics": [], + "tags": [] + } + } + +For more information, see `Deleting a Cluster `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/delete-service.rst b/aws/dist/awscli/examples/ecs/delete-service.rst new file mode 100644 index 00000000..0611aa59 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/delete-service.rst @@ -0,0 +1,7 @@ +**To delete a service** + +The following ``ecs delete-service`` example deletes the specified service from a cluster. You can include the ``--force`` parameter to delete a service even if it has not been scaled to zero tasks. :: + + aws ecs delete-service --cluster MyCluster --service MyService1 --force + +For more information, see `Deleting a Service `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/delete-task-set.rst b/aws/dist/awscli/examples/ecs/delete-task-set.rst new file mode 100644 index 00000000..66c65694 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/delete-task-set.rst @@ -0,0 +1,45 @@ +**To delete a task set** + +The following ``delete-task-set`` example shows how to delete a task set. You can include the ``--force`` parameter to delete a task set even if it has not been scaled to zero. :: + + aws ecs delete-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ + --force + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "DRAINING", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557130260.276, + "updatedAt": 1557130290.707, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12345678" + ], + "securityGroups": [ + "sg-12345678" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557130290.707 + } + } diff --git a/aws/dist/awscli/examples/ecs/deregister-container-instance.rst b/aws/dist/awscli/examples/ecs/deregister-container-instance.rst new file mode 100644 index 00000000..32b52580 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/deregister-container-instance.rst @@ -0,0 +1,262 @@ +**To deregister a container instance from a cluster** + +The following ``deregister-container-instance`` example deregisters a container instance from the specified cluster. If there are still tasks running in the container instance, you must either stop those tasks before deregistering, or use the ``--force`` option. :: + + aws ecs deregister-container-instance \ + --cluster arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --container-instance arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \ + --force + +Output:: + + { + "containerInstance": { + "remainingResources": [ + { + "integerValue": 1024, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "CPU" + }, + { + "integerValue": 985, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "MEMORY" + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS", + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ], + "longValue": 0, + "doubleValue": 0.0 + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS_UDP", + "stringSetValue": [], + "longValue": 0, + "doubleValue": 0.0 + } + ], + "agentConnected": true, + "attributes": [ + { + "name": "ecs.capability.secrets.asm.environment-variables" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.syslog" + }, + { + "value": "ami-01a82c3fce2c3ba58", + "name": "ecs.ami-id" + }, + { + "name": "ecs.capability.secrets.asm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.none" + }, + { + "name": "ecs.capability.ecr-endpoint" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.json-file" + }, + { + "value": "vpc-1234567890123467", + "name": "ecs.vpc-id" + }, + { + "name": "ecs.capability.execution-role-awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" + }, + { + "name": "ecs.capability.docker-plugin.local" + }, + { + "name": "ecs.capability.task-eni" + }, + { + "name": "ecs.capability.task-cpu-mem-limit" + }, + { + "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" + }, + { + "name": "ecs.capability.execution-role-ecr-pull" + }, + { + "name": "ecs.capability.container-health-check" + }, + { + "value": "subnet-1234567890123467", + "name": "ecs.subnet-id" + }, + { + "value": "us-west-2a", + "name": "ecs.availability-zone" + }, + { + "value": "t2.micro", + "name": "ecs.instance-type" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" + }, + { + "name": "ecs.capability.aws-appmesh" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" + }, + { + "name": "com.amazonaws.ecs.capability.privileged-container" + }, + { + "name": "ecs.capability.container-ordering" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" + }, + { + "value": "x86_64", + "name": "ecs.cpu-architecture" + }, + { + "value": "93f43776-2018.10.0", + "name": "ecs.capability.cni-plugin-version" + }, + { + "name": "ecs.capability.secrets.ssm.environment-variables" + }, + { + "name": "ecs.capability.pid-ipc-namespace-sharing" + }, + { + "name": "com.amazonaws.ecs.capability.ecr-auth" + }, + { + "value": "linux", + "name": "ecs.os-type" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" + }, + { + "name": "ecs.capability.task-eia" + }, + { + "name": "ecs.capability.private-registry-authentication.secretsmanager" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" + } + ], + "pendingTasksCount": 0, + "tags": [], + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "registeredResources": [ + { + "integerValue": 1024, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "CPU" + }, + { + "integerValue": 985, + "doubleValue": 0.0, + "type": "INTEGER", + "longValue": 0, + "name": "MEMORY" + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS", + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ], + "longValue": 0, + "doubleValue": 0.0 + }, + { + "type": "STRINGSET", + "integerValue": 0, + "name": "PORTS_UDP", + "stringSetValue": [], + "longValue": 0, + "doubleValue": 0.0 + } + ], + "status": "INACTIVE", + "registeredAt": 1557768075.681, + "version": 4, + "versionInfo": { + "agentVersion": "1.27.0", + "agentHash": "aabe65ee", + "dockerVersion": "DockerVersion: 18.06.1-ce" + }, + "attachments": [], + "runningTasksCount": 0, + "ec2InstanceId": "i-12345678901234678" + } + } + +For more information, see `Deregister a Container Instance `_ in the *ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/deregister-task-definition.rst b/aws/dist/awscli/examples/ecs/deregister-task-definition.rst new file mode 100644 index 00000000..6fd5d4b2 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/deregister-task-definition.rst @@ -0,0 +1,36 @@ +**To deregister a task definition** + +The following ``deregister-task-definition`` example deregisters the first revision of the ``curler`` task definition in your default region. :: + + aws ecs deregister-task-definition --task-definition curler:1 + +Note that in the resulting output, the task definition status shows ``INACTIVE``:: + + { + "taskDefinition": { + "status": "INACTIVE", + "family": "curler", + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/curler:1", + "containerDefinitions": [ + { + "environment": [], + "name": "curler", + "mountPoints": [], + "image": "curl:latest", + "cpu": 100, + "portMappings": [], + "entryPoint": [], + "memory": 256, + "command": [ + "curl -v http://example.com/" + ], + "essential": true, + "volumesFrom": [] + } + ], + "revision": 1 + } + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/describe-clusters.rst b/aws/dist/awscli/examples/ecs/describe-clusters.rst new file mode 100644 index 00000000..9d3034f5 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-clusters.rst @@ -0,0 +1,24 @@ +**To describe a cluster** + +The following ``describe-clusters`` example retrieves details about the specified cluster. :: + + aws ecs describe-clusters --cluster default + +Output:: + + { + "clusters": [ + { + "status": "ACTIVE", + "clusterName": "default", + "registeredContainerInstancesCount": 0, + "pendingTasksCount": 0, + "runningTasksCount": 0, + "activeServicesCount": 1, + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default" + } + ], + "failures": [] + } + +For more information, see `Amazon ECS Clusters `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/describe-container-instances.rst b/aws/dist/awscli/examples/ecs/describe-container-instances.rst new file mode 100644 index 00000000..4b876eed --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-container-instances.rst @@ -0,0 +1,88 @@ +**To describe container instance** + +The following ``describe-container-instances`` example retrieves details for a container instance in the ``update`` cluster, using the container instance UUID as an identifier. :: + + aws ecs describe-container-instances \ + --cluster update \ + --container-instances a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "failures": [], + "containerInstances": [ + { + "status": "ACTIVE", + "registeredResources": [ + { + "integerValue": 2048, + "longValue": 0, + "type": "INTEGER", + "name": "CPU", + "doubleValue": 0.0 + }, + { + "integerValue": 3955, + "longValue": 0, + "type": "INTEGER", + "name": "MEMORY", + "doubleValue": 0.0 + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "ec2InstanceId": "i-A1B2C3D4", + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "pendingTasksCount": 0, + "remainingResources": [ + { + "integerValue": 2048, + "longValue": 0, + "type": "INTEGER", + "name": "CPU", + "doubleValue": 0.0 + }, + { + "integerValue": 3955, + "longValue": 0, + "type": "INTEGER", + "name": "MEMORY", + "doubleValue": 0.0 + }, + { + "name": "PORTS", + "longValue": 0, + "doubleValue": 0.0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678" + ], + "type": "STRINGSET", + "integerValue": 0 + } + ], + "runningTasksCount": 0, + "versionInfo": { + "agentVersion": "1.0.0", + "agentHash": "4023248", + "dockerVersion": "DockerVersion: 1.5.0" + } + } + ] + } + +For more information, see `Amazon ECS Container Instances `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/describe-services.rst b/aws/dist/awscli/examples/ecs/describe-services.rst new file mode 100644 index 00000000..b8d67ebc --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-services.rst @@ -0,0 +1,46 @@ +**To describe a service** + +The following ``describe-services`` example retrieves details for the ``my-http-service`` service in the default cluster. :: + + aws ecs describe-services --services my-http-service + +Output:: + + { + "services": [ + { + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", + "pendingCount": 0, + "loadBalancers": [], + "desiredCount": 10, + "createdAt": 1466801808.595, + "serviceName": "my-http-service", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/default", + "serviceArn": "arn:aws:ecs:us-west-2:123456789012:service/my-http-service", + "deployments": [ + { + "status": "PRIMARY", + "pendingCount": 0, + "createdAt": 1466801808.595, + "desiredCount": 10, + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/amazon-ecs-sample:1", + "updatedAt": 1428326312.703, + "id": "ecs-svc/1234567890123456789", + "runningCount": 10 + } + ], + "events": [ + { + "message": "(service my-http-service) has reached a steady state.", + "id": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "createdAt": 1466801812.435 + } + ], + "runningCount": 10 + } + ], + "failures": [] + } + +For more information, see `Services `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/describe-task-definition.rst b/aws/dist/awscli/examples/ecs/describe-task-definition.rst new file mode 100644 index 00000000..cb018af0 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-task-definition.rst @@ -0,0 +1,55 @@ +**To describe a task definition** + +The following ``describe-task-definition`` example retrieves the details of a task definition. :: + + aws ecs describe-task-definition --task-definition hello_world:8 + +Output:: + + { + "taskDefinition": { + "volumes": [], + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/hello_world:8", + "containerDefinitions": [ + { + "environment": [], + "name": "wordpress", + "links": [ + "mysql" + ], + "mountPoints": [], + "image": "wordpress", + "essential": true, + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "memory": 500, + "cpu": 10, + "volumesFrom": [] + }, + { + "environment": [ + { + "name": "MYSQL_ROOT_PASSWORD", + "value": "password" + } + ], + "name": "mysql", + "mountPoints": [], + "image": "mysql", + "cpu": 10, + "portMappings": [], + "memory": 500, + "essential": true, + "volumesFrom": [] + } + ], + "family": "hello_world", + "revision": 8 + } + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/describe-task-sets.rst b/aws/dist/awscli/examples/ecs/describe-task-sets.rst new file mode 100644 index 00000000..24e657b1 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-task-sets.rst @@ -0,0 +1,48 @@ +**To describe a task set** + +The following ``describe-task-sets`` example describes a task set in a service that uses an external deployer. :: + + aws ecs describe-task-sets \ + --cluster MyCluster \ + --service MyService \ + --task-sets arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 + +Output:: + + { + "taskSets": [ + { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557207715.195, + "updatedAt": 1557207740.014, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-1234431" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 0.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STEADY_STATE", + "stabilityStatusAt": 1557207740.014 + } + ], + "failures": [] + } + diff --git a/aws/dist/awscli/examples/ecs/describe-tasks.rst b/aws/dist/awscli/examples/ecs/describe-tasks.rst new file mode 100644 index 00000000..81f9834b --- /dev/null +++ b/aws/dist/awscli/examples/ecs/describe-tasks.rst @@ -0,0 +1,88 @@ +**To describe a task** + +The following ``describe-tasks`` example retrieves the details of a task. You can specify the task by using either the ID or full ARN of the task. :: + + aws ecs describe-tasks \ + --cluster MyCluster \ + --tasks arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789 + +Output:: + + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789", + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "overrides": { + "containerOverrides": [ + { + "name": "fargate-app" + } + ] + }, + "lastStatus": "RUNNING", + "desiredStatus": "RUNNING", + "cpu": "256", + "memory": "512", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/MyCluster/1234567890123456789", + "name": "fargate-app", + "lastStatus": "RUNNING", + "networkBindings": [], + "networkInterfaces": [ + { + "attachmentId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE", + "privateIpv4Address": "10.0.0.4" + } + ], + "healthStatus": "UNKNOWN", + "cpu": "0" + } + ], + "startedBy": "ecs-svc/1234567890123456789", + "version": 3, + "connectivity": "CONNECTED", + "connectivityAt": 1557134016.971, + "pullStartedAt": 1557134025.379, + "pullStoppedAt": 1557134033.379, + "createdAt": 1557134011.644, + "startedAt": 1557134035.379, + "group": "service:fargate-service", + "launchType": "FARGATE", + "platformVersion": "1.3.0", + "attachments": [ + { + "id": "a1b2c3d4-5678-90ab-cdef-33333EXAMPLE", + "type": "ElasticNetworkInterface", + "status": "ATTACHED", + "details": [ + { + "name": "subnetId", + "value": "subnet-12344321" + }, + { + "name": "networkInterfaceId", + "value": "eni-12344321" + }, + { + "name": "macAddress", + "value": "0a:90:09:84:f9:14" + }, + { + "name": "privateIPv4Address", + "value": "10.0.0.4" + } + ] + } + ], + "healthStatus": "UNKNOWN", + "tags": [] + } + ], + "failures": [] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-account-settings.rst b/aws/dist/awscli/examples/ecs/list-account-settings.rst new file mode 100644 index 00000000..397e02b3 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-account-settings.rst @@ -0,0 +1,47 @@ +**Example 1: To view the account settings for an account** + +The following ``list-account-settings`` example displays the effective account settings for an account. :: + + aws ecs list-account-settings --effective-settings + +Output:: + + { + "settings": [ + { + "name": "containerInstanceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + }, + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + }, + { + "name": "taskLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + } + ] + } + +**Example 2: To view the account settings for a specific IAM user or IAM role** + +The following ``list-account-settings`` example displays the account settings for the specified IAM user or IAM role. :: + + aws ecs list-account-settings --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "settings": [ + { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + ] + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/list-attributes.rst b/aws/dist/awscli/examples/ecs/list-attributes.rst new file mode 100644 index 00000000..3eabf0c9 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-attributes.rst @@ -0,0 +1,23 @@ +**To list the container instances that contain a specific attribute** + +The following example lists the attributes for container instances that have the ``stack=production`` attribute in the default cluster. :: + + aws ecs list-attributes \ + --target-type container-instance \ + --attribute-name stack \ + --attribute-value production \ + --cluster default + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } + +For more information, see `Amazon ECS Container Agent Configuration `__ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-clusters.rst b/aws/dist/awscli/examples/ecs/list-clusters.rst new file mode 100644 index 00000000..d020efcb --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-clusters.rst @@ -0,0 +1,16 @@ +**To list your available clusters** + +The following ``list-clusters`` example lists all of the available clusters. :: + + aws ecs list-clusters + +Output:: + + { + "clusterArns": [ + "arn:aws:ecs:us-west-2:123456789012:cluster/MyECSCluster1", + "arn:aws:ecs:us-west-2:123456789012:cluster/AnotherECSCluster" + ] + } + +For more information, see `Amazon ECS Clusters `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-container-instances.rst b/aws/dist/awscli/examples/ecs/list-container-instances.rst new file mode 100644 index 00000000..f7682309 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-container-instances.rst @@ -0,0 +1,16 @@ +**To list the container instances in a cluster** + +The following ``list-container-instances`` example lists all of the available container instances in a cluster. :: + + aws ecs list-container-instances --cluster MyCluster + +Output:: + + { + "containerInstanceArns": [ + "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "arn:aws:ecs:us-west-2:123456789012:container-instance/MyCluster/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + ] + } + +For more information, see `Amazon ECS Container Instances `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-services.rst b/aws/dist/awscli/examples/ecs/list-services.rst new file mode 100644 index 00000000..22ed2e31 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-services.rst @@ -0,0 +1,15 @@ +**To list the services in a cluster** + +The following ``list-services`` example shows how to list the services running in a cluster. :: + + aws ecs list-services --cluster MyCluster + +Output:: + + { + "serviceArns": [ + "arn:aws:ecs:us-west-2:123456789012:service/MyCluster/MyService" + ] + } + +For more information, see `Services `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-tags-for-resource.rst b/aws/dist/awscli/examples/ecs/list-tags-for-resource.rst new file mode 100644 index 00000000..eb4841a9 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-tags-for-resource.rst @@ -0,0 +1,25 @@ +**To list the tags for a resource** + +The following ``list-tags-for-resource`` example lists the tags for a specific cluster. :: + + aws ecs list-tags-for-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster + +Output:: + + { + "tags": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + }, + { + "key": "key3", + "value": "value3" + } + ] + } diff --git a/aws/dist/awscli/examples/ecs/list-task-definition-families.rst b/aws/dist/awscli/examples/ecs/list-task-definition-families.rst new file mode 100644 index 00000000..397d4247 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-task-definition-families.rst @@ -0,0 +1,33 @@ +**Example 1: To list the registered task definition families** + +The following ``list-task-definition-families`` example lists all of the registered task definition families. :: + + aws ecs list-task-definition-families + +Output:: + + { + "families": [ + "node-js-app", + "web-timer", + "hpcc", + "hpcc-c4-8xlarge" + ] + } + +**Example 2: To filter the registered task definition families** + +The following ``list-task-definition-families`` example lists the task definition revisions that start with "hpcc". :: + + aws ecs list-task-definition-families --family-prefix hpcc + +Output:: + + { + "families": [ + "hpcc", + "hpcc-c4-8xlarge" + ] + } + +For more information, see `Task Definition Parameters `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-task-definitions.rst b/aws/dist/awscli/examples/ecs/list-task-definitions.rst new file mode 100644 index 00000000..351ca46c --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-task-definitions.rst @@ -0,0 +1,37 @@ +**Example 1: To list the registered task definitions** + +The following ``list-task-definitions`` example lists all of the registered task definitions. :: + + aws ecs list-task-definitions + +Output:: + + { + "taskDefinitionArns": [ + "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep300:2", + "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" + ] + } + +**Example 2: To list the registered task definitions in a family** + +The following `list-task-definitions` example lists the task definition revisions of a specified family. :: + + aws ecs list-task-definitions --family-prefix wordpress + +Output:: + + { + "taskDefinitionArns": [ + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:3", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:4", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:5", + "arn:aws:ecs:us-west-2:123456789012:task-definition/wordpress:6" + ] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/list-tasks.rst b/aws/dist/awscli/examples/ecs/list-tasks.rst new file mode 100644 index 00000000..42a6837f --- /dev/null +++ b/aws/dist/awscli/examples/ecs/list-tasks.rst @@ -0,0 +1,30 @@ +**Example 1: To list the tasks in a cluster** + +The following ``list-tasks`` example lists all of the tasks in a cluster. :: + + aws ecs list-tasks --cluster default + +Output:: + + { + "taskArns": [ + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-22222EXAMPLE" + ] + } + +**Example 2: To list the tasks on a particular container instance** + +The following ``list-tasks`` example lists the tasks on a container instance, using the container instance UUID as a filter. :: + + aws ecs list-tasks --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-33333EXAMPLE + +Output:: + + { + "taskArns": [ + "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE" + ] + } + +For more information, see `Amazon ECS Task Definitions `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/put-account-setting-default.rst b/aws/dist/awscli/examples/ecs/put-account-setting-default.rst new file mode 100644 index 00000000..821d7258 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/put-account-setting-default.rst @@ -0,0 +1,17 @@ +**To modify the default account settings** + +The following ``put-account-setting-default`` example modifies the default account setting for all IAM users or roles on your account. These changes apply to the entire AWS account unless an IAM user or role explicitly overrides these settings for themselves. :: + + aws ecs put-account-setting-default --name serviceLongArnFormat --value enabled + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:root" + } + } + +For more information, see `Amazon Resource Names (ARNs) and IDs `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/put-account-setting.rst b/aws/dist/awscli/examples/ecs/put-account-setting.rst new file mode 100644 index 00000000..cca46677 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/put-account-setting.rst @@ -0,0 +1,17 @@ +**To modify the account setting for your IAM user account** + +The following ``put-account-setting`` example enables the ``serviceLongArnFormat`` account setting for your IAM user account. :: + + aws ecs put-account-setting --name serviceLongArnFormat --value enabled + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::130757420319:user/your_username" + } + } + +For more information, see `Modifying Account Settings `__ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/put-account-settings.rst b/aws/dist/awscli/examples/ecs/put-account-settings.rst new file mode 100644 index 00000000..7f3a49b6 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/put-account-settings.rst @@ -0,0 +1,19 @@ +**To modify the account settings for an IAM user or IAM role** + +The following ``put-account-setting`` example modifies the account settings for the specified IAM user or IAM role. :: + + aws ecs put-account-setting \ + --name serviceLongArnFormat \ + --value enabled \ + --principal-arn arn:aws:iam::123456789012:user/MyUser + +Output:: + + { + "setting": { + "name": "serviceLongArnFormat", + "value": "enabled", + "principalArn": "arn:aws:iam::123456789012:user/MyUser" + } + } + diff --git a/aws/dist/awscli/examples/ecs/put-attributes.rst b/aws/dist/awscli/examples/ecs/put-attributes.rst new file mode 100644 index 00000000..aabed8ac --- /dev/null +++ b/aws/dist/awscli/examples/ecs/put-attributes.rst @@ -0,0 +1,18 @@ +**To create an attribute and associate it with an Amazon ECS resource** + +The following ``put-attributes`` applies an attribute with the name stack and the value production to a container instance. :: + + aws ecs put-attributes \ + --attributes name=stack,value=production,targetId=arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34 + +Output:: + + { + "attributes": [ + { + "name": "stack", + "targetId": "arn:aws:ecs:us-west-2:130757420319:container-instance/1c3be8ed-df30-47b4-8f1e-6e68ebd01f34", + "value": "production" + } + ] + } diff --git a/aws/dist/awscli/examples/ecs/register-task-definition.rst b/aws/dist/awscli/examples/ecs/register-task-definition.rst new file mode 100644 index 00000000..b796e4b7 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/register-task-definition.rst @@ -0,0 +1,123 @@ +**Example 1: To register a task definition with a JSON file** + +The following ``register-task-definition`` example registers a task definition to the specified family with container definitions that are saved in JSON format at the specified file location. :: + + aws ecs register-task-definition \ + --cli-input-json file:///sleep360.json + +``sleep360.json`` file contents:: + + { + "containerDefinitions": [ + { + "name": "sleep", + "image": "busybox", + "cpu": 10, + "command": [ + "sleep", + "360" + ], + "memory": 10, + "essential": true + } + ], + "family": "sleep360" + } + +Output:: + + { + "taskDefinition": { + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:2", + "containerDefinitions": [ + { + "name": "sleep", + "image": "busybox", + "cpu": 10, + "memory": 10, + "portMappings": [], + "essential": true, + "command": [ + "sleep", + "360" + ], + "environment": [], + "mountPoints": [], + "volumesFrom": [] + } + ], + "family": "sleep360", + "revision": 2, + "volumes": [], + "status": "ACTIVE", + "placementConstraints": [], + "compatibilities": [ + "EC2" + ] + } + } + +**Example 2: To register a task definition with a JSON string parameter** + +The following ``register-task-definition`` example registers the same task definition from the previous example, but the container definitions are provided as a string parameter with the double quotes escaped. :: + + aws ecs register-task-definition \ + --family sleep360 \ + --container-definitions "[{\"name\":\"sleep\",\"image\":\"busybox\",\"cpu\":10,\"command\":[\"sleep\",\"360\"],\"memory\":10,\"essential\":true}]" + +The output is identical to the previous example. + +**Example 3: To use data volumes in a task definition** + +This example task definition file creates a data volume called `webdata` that exists at `/ecs/webdata` on the container instance. The volume is mounted read-only as `/usr/share/nginx/html` on the `web` container, and read-write as `/nginx/` on the `timer` container. :: + + { + "family": "web-timer", + "containerDefinitions": [ + { + "name": "web", + "image": "nginx", + "cpu": 99, + "memory": 100, + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "essential": true, + "mountPoints": [ + { + "sourceVolume": "webdata", + "containerPath": "/usr/share/nginx/html", + "readOnly": true + } + ] + }, + { + "name": "timer", + "image": "busybox", + "cpu": 10, + "memory": 20, + "entryPoint": ["sh", "-c"], + "command": ["while true; do date > /nginx/index.html; sleep 1; done"], + "mountPoints": [ + { + "sourceVolume": "webdata", + "containerPath": "/nginx/" + } + ] + } + ], + "volumes": [ + { + "name": "webdata", + "host": { + "sourcePath": "/ecs/webdata" + } + } + ] + } + + +For more information, see `Creating a Task Definition `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/run-task.rst b/aws/dist/awscli/examples/ecs/run-task.rst new file mode 100644 index 00000000..745a9a75 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/run-task.rst @@ -0,0 +1,37 @@ +**To run a task on your default cluster** + +The following ``run-task`` example runs a task on the default cluster. :: + + aws ecs run-task --cluster default --task-definition sleep360:1 + +Output:: + + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "lastStatus": "PENDING", + "containerInstanceArn": "arn:aws:ecs:us-west-2:123456789012:container-instance/a1b2c3d4-5678-90ab-ccdef-22222EXAMPLE", + "desiredStatus": "RUNNING", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:123456789012:task-definition/sleep360:1", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:123456789012:container/a1b2c3d4-5678-90ab-ccdef-33333EXAMPLE", + "taskArn": "arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-ccdef-11111EXAMPLE", + "lastStatus": "PENDING", + "name": "sleep" + } + ] + } + ] + } + + +For more information, see `Running Tasks `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/start-task.rst b/aws/dist/awscli/examples/ecs/start-task.rst new file mode 100644 index 00000000..e1c320b6 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/start-task.rst @@ -0,0 +1,49 @@ +**To start a new task** + +The following ``start-task`` starts a task using the latest revision of the ``sleep360`` task definition on the specified container instance in the default cluster. :: + + aws ecs start-task \ + --task-definition sleep360 \ + --container-instances 765936fadbdd46b5991a4bd70c2a43d4 + +Output:: + + { + "tasks": [ + { + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3", + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "lastStatus": "PENDING", + "desiredStatus": "RUNNING", + "cpu": "128", + "memory": "128", + "containers": [ + { + "containerArn": "arn:aws:ecs:us-west-2:130757420319:container/75f11ed4-8a3d-4f26-a33b-ad1db9e02d41", + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "name": "sleep", + "lastStatus": "PENDING", + "networkInterfaces": [], + "cpu": "10", + "memory": "10" + } + ], + "version": 1, + "createdAt": 1563421494.186, + "group": "family:sleep360", + "launchType": "EC2", + "attachments": [], + "tags": [] + } + ], + "failures": [] + } diff --git a/aws/dist/awscli/examples/ecs/stop-task.rst b/aws/dist/awscli/examples/ecs/stop-task.rst new file mode 100644 index 00000000..0fe0d6e1 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/stop-task.rst @@ -0,0 +1,40 @@ +**To stop a task** + +The following ``stop-task`` stops the specified task from running in the default cluster. :: + + aws ecs stop-task \ + --task 666fdccc2e2d4b6894dd422f4eeee8f8 + +Output:: + + { + "task": { + "taskArn": "arn:aws:ecs:us-west-2:130757420319:task/default/666fdccc2e2d4b6894dd422f4eeee8f8", + "clusterArn": "arn:aws:ecs:us-west-2:130757420319:cluster/default", + "taskDefinitionArn": "arn:aws:ecs:us-west-2:130757420319:task-definition/sleep360:3", + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "overrides": { + "containerOverrides": [] + }, + "lastStatus": "STOPPED", + "desiredStatus": "STOPPED", + "cpu": "128", + "memory": "128", + "containers": [], + "version": 2, + "stoppedReason": "Taskfailedtostart", + "stopCode": "TaskFailedToStart", + "connectivity": "CONNECTED", + "connectivityAt": 1563421494.186, + "pullStartedAt": 1563421494.252, + "pullStoppedAt": 1563421496.252, + "executionStoppedAt": 1563421497, + "createdAt": 1563421494.186, + "stoppingAt": 1563421497.252, + "stoppedAt": 1563421497.252, + "group": "family:sleep360", + "launchType": "EC2", + "attachments": [], + "tags": [] + } + } diff --git a/aws/dist/awscli/examples/ecs/tag-resource.rst b/aws/dist/awscli/examples/ecs/tag-resource.rst new file mode 100644 index 00000000..e6a783e3 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/tag-resource.rst @@ -0,0 +1,19 @@ +**To tag a resource** + +The following ``tag-resource`` example adds a single tag to the specified resource. :: + + aws ecs tag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster + --tags key=key1,value=value1 + +This command produces no output. + +**To add multiple tags to a resource** + +The following ``tag-resource`` example adds multiple tags to the specified resource. :: + + aws ecs tag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --tags key=key1,value=value1 key=key2,value=value2 key=key3,value=value3 + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/untag-resource.rst b/aws/dist/awscli/examples/ecs/untag-resource.rst new file mode 100644 index 00000000..0cc00912 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/untag-resource.rst @@ -0,0 +1,10 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` example removes the listed tags from the specified resource. :: + + aws ecs untag-resource \ + --resource-arn arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster \ + --tag-keys key1,key2 + +This command produces no output. + diff --git a/aws/dist/awscli/examples/ecs/update-cluster-settings.rst b/aws/dist/awscli/examples/ecs/update-cluster-settings.rst new file mode 100644 index 00000000..c9f31715 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-cluster-settings.rst @@ -0,0 +1,31 @@ +**To modify the settings for your cluster** + +The following ``update-cluster-settings`` example enables CloudWatch Container Insights for the ``default`` cluster. :: + + aws ecs update-cluster-settings \ + --cluster default \ + --settings name=containerInsights,value=enabled + +Output:: + + { + "cluster": { + "clusterArn": "arn:aws:ecs:us-west-2:123456789012:cluster/MyCluster", + "clusterName": "default", + "status": "ACTIVE", + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "pendingTasksCount": 0, + "activeServicesCount": 0, + "statistics": [], + "tags": [], + "settings": [ + { + "name": "containerInsights", + "value": "enabled" + } + ] + } + } + +For more information, see `Modifying Account Settings `__ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/update-container-agent.rst b/aws/dist/awscli/examples/ecs/update-container-agent.rst new file mode 100644 index 00000000..f0267984 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-container-agent.rst @@ -0,0 +1,22 @@ +**To update the container agent on an Amazon ECS container instance** + +The following ``update-container-agent`` example updates the container agent on the specified container instance in the default cluster. :: + + aws ecs update-container-agent --cluster default --container-instance a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "containerInstance": { + "status": "ACTIVE", + ... + "agentUpdateStatus": "PENDING", + "versionInfo": { + "agentVersion": "1.0.0", + "agentHash": "4023248", + "dockerVersion": "DockerVersion: 1.5.0" + } + } + } + +For more information, see `Updating the Amazon ECS Container Agent `_ in the *Amazon ECS Developer Guide*. diff --git a/aws/dist/awscli/examples/ecs/update-container-instances-state.rst b/aws/dist/awscli/examples/ecs/update-container-instances-state.rst new file mode 100644 index 00000000..f6974cc1 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-container-instances-state.rst @@ -0,0 +1,269 @@ +**To update the state of a container instance** + +The following ``update-container-instances-state`` updates the state of the specified container instance to ``DRAINING`` which will remove it from the cluster is it registered to. :: + + aws ecs update-container-instances-state \ + --container-instances 765936fadbdd46b5991a4bd70c2a43d4 \ + --status DRAINING + +Output:: + + { + "containerInstances": [ + { + "containerInstanceArn": "arn:aws:ecs:us-west-2:130757420319:container-instance/default/765936fadbdd46b5991a4bd70c2a43d4", + "ec2InstanceId": "i-013d87ffbb4d513bf", + "version": 4390, + "versionInfo": { + "agentVersion": "1.29.0", + "agentHash": "a190a73f", + "dockerVersion": "DockerVersion:18.06.1-ce" + }, + "remainingResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 1536 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 2681 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ] + }, + { + "name": "PORTS_UDP", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [] + } + ], + "registeredResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 2048 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0, + "longValue": 0, + "integerValue": 3705 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [ + "22", + "2376", + "2375", + "51678", + "51679" + ] + }, + { + "name": "PORTS_UDP", + "type": "STRINGSET", + "doubleValue": 0, + "longValue": 0, + "integerValue": 0, + "stringSetValue": [] + } + ], + "status": "DRAINING", + "agentConnected": true, + "runningTasksCount": 2, + "pendingTasksCount": 0, + "attributes": [ + { + "name": "ecs.capability.secrets.asm.environment-variables" + }, + { + "name": "ecs.capability.branch-cni-plugin-version", + "value": "e0703516-" + }, + { + "name": "ecs.ami-id", + "value": "ami-00e0090ac21971297" + }, + { + "name": "ecs.capability.secrets.asm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.none" + }, + { + "name": "ecs.capability.ecr-endpoint" + }, + { + "name": "ecs.capability.docker-plugin.local" + }, + { + "name": "ecs.capability.task-cpu-mem-limit" + }, + { + "name": "ecs.capability.secrets.ssm.bootstrap.log-driver" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.30" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.31" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.32" + }, + { + "name": "ecs.availability-zone", + "value": "us-west-2c" + }, + { + "name": "ecs.capability.aws-appmesh" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.awslogs" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.24" + }, + { + "name": "ecs.capability.task-eni-trunking" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.25" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.26" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.27" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.28" + }, + { + "name": "com.amazonaws.ecs.capability.privileged-container" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.29" + }, + { + "name": "ecs.cpu-architecture", + "value": "x86_64" + }, + { + "name": "com.amazonaws.ecs.capability.ecr-auth" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.20" + }, + { + "name": "ecs.os-type", + "value": "linux" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.21" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.22" + }, + { + "name": "ecs.capability.task-eia" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.23" + }, + { + "name": "ecs.capability.private-registry-authentication.secretsmanager" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.syslog" + }, + { + "name": "com.amazonaws.ecs.capability.logging-driver.json-file" + }, + { + "name": "ecs.capability.execution-role-awslogs" + }, + { + "name": "ecs.vpc-id", + "value": "vpc-1234" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.17" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.18" + }, + { + "name": "com.amazonaws.ecs.capability.docker-remote-api.1.19" + }, + { + "name": "ecs.capability.task-eni" + }, + { + "name": "ecs.capability.execution-role-ecr-pull" + }, + { + "name": "ecs.capability.container-health-check" + }, + { + "name": "ecs.subnet-id", + "value": "subnet-1234" + }, + { + "name": "ecs.instance-type", + "value": "c5.large" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role-network-host" + }, + { + "name": "ecs.capability.container-ordering" + }, + { + "name": "ecs.capability.cni-plugin-version", + "value": "91ccefc8-2019.06.0" + }, + { + "name": "ecs.capability.pid-ipc-namespace-sharing" + }, + { + "name": "ecs.capability.secrets.ssm.environment-variables" + }, + { + "name": "com.amazonaws.ecs.capability.task-iam-role" + } + ], + "registeredAt": 1560788724.507, + "attachments": [], + "tags": [] + } + ], + "failures": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/update-service-primary-task-set.rst b/aws/dist/awscli/examples/ecs/update-service-primary-task-set.rst new file mode 100644 index 00000000..80310e3e --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-service-primary-task-set.rst @@ -0,0 +1,44 @@ +**To update the primary task set for a service** + +The following ``update-service-primary-task-set`` example updates the primary task set for the specified service. :: + + aws ecs update-service-primary-task-set \ + --cluster MyCluster \ + --service MyService \ + --primary-task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 1, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557129412.653, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344312" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 50.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557129279.914 + } + } diff --git a/aws/dist/awscli/examples/ecs/update-service.rst b/aws/dist/awscli/examples/ecs/update-service.rst new file mode 100644 index 00000000..ac872373 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-service.rst @@ -0,0 +1,13 @@ +**Example 1: To change the task definition used in a service** + +The following ``update-service`` example updates the ``my-http-service`` service to use the ``amazon-ecs-sample`` task definition. :: + + aws ecs update-service --service my-http-service --task-definition amazon-ecs-sample + +**Example 2: To change the number of tasks in a service** + +The following ``update-service`` example updates the desired task count of the service ``my-http-service`` to 3. :: + + aws ecs update-service --service my-http-service --desired-count 3 + +For more information, see `Updating a Service `_ in the *Amazon ECS Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ecs/update-task-set.rst b/aws/dist/awscli/examples/ecs/update-task-set.rst new file mode 100644 index 00000000..cd03947d --- /dev/null +++ b/aws/dist/awscli/examples/ecs/update-task-set.rst @@ -0,0 +1,45 @@ +**To update a task set** + +The following ``update-task-set`` example updates a task set to adjust the scale. :: + + aws ecs update-task-set \ + --cluster MyCluster \ + --service MyService \ + --task-set arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789 \ + --scale value=50,unit=PERCENT + +Output:: + + { + "taskSet": { + "id": "ecs-svc/1234567890123456789", + "taskSetArn": "arn:aws:ecs:us-west-2:123456789012:task-set/MyCluster/MyService/ecs-svc/1234567890123456789", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-west-2:123456789012:task-definition/sample-fargate:2", + "computedDesiredCount": 0, + "pendingCount": 0, + "runningCount": 0, + "createdAt": 1557128360.711, + "updatedAt": 1557129279.914, + "launchType": "EC2", + "networkConfiguration": { + "awsvpcConfiguration": { + "subnets": [ + "subnet-12344321" + ], + "securityGroups": [ + "sg-12344321" + ], + "assignPublicIp": "DISABLED" + } + }, + "loadBalancers": [], + "serviceRegistries": [], + "scale": { + "value": 50.0, + "unit": "PERCENT" + }, + "stabilityStatus": "STABILIZING", + "stabilityStatusAt": 1557129279.914 + } + } diff --git a/aws/dist/awscli/examples/ecs/wait/services-stable.rst b/aws/dist/awscli/examples/ecs/wait/services-stable.rst new file mode 100644 index 00000000..4ef1dea7 --- /dev/null +++ b/aws/dist/awscli/examples/ecs/wait/services-stable.rst @@ -0,0 +1,15 @@ +**Example 1: To pause running until a service is confirmed to be stable** + +The following ``wait`` example pauses and continues only after it can confirm that the specified service running on the specified cluster is stable. There is no output. :: + + aws ecs wait services-stable \ + --cluster MyCluster \ + --services MyService + +**Example 2: To pause running until a task is confirmed to be running** + +The following ``wait`` example pauses and continues only after the specified task enters a ``RUNNING`` state. :: + + aws ecs wait services-stable \ + --cluster MyCluster \ + --tasks arn:aws:ecs:us-west-2:123456789012:task/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \ No newline at end of file diff --git a/aws/dist/awscli/examples/eks/create-cluster.rst b/aws/dist/awscli/examples/eks/create-cluster.rst new file mode 100644 index 00000000..ca3b036e --- /dev/null +++ b/aws/dist/awscli/examples/eks/create-cluster.rst @@ -0,0 +1,89 @@ +**To create a new cluster** + +This example command creates a cluster named ``prod`` in your default region. + +Command:: + + aws eks create-cluster --name prod \ + --role-arn arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI \ + --resources-vpc-config subnetIds=subnet-6782e71e,subnet-e7e761ac,securityGroupIds=sg-6979fe18 + +Output:: + + { + "cluster": { + "name": "prod", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/prod", + "createdAt": 1527808069.147, + "version": "1.10", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ], + "vpcId": "vpc-950809ec" + }, + "status": "CREATING", + "certificateAuthority": {} + } + } + +**To create a new cluster with private endpoint access and logging enabled** + +This example command creates a cluster named ``example`` in your default region with public endpoint access disabled, private endpoint access enabled, and all logging types enabled. + +Command:: + + aws eks create-cluster --name example --kubernetes-version 1.12 \ + --role-arn arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q \ + --resources-vpc-config subnetIds=subnet-0a188dccd2f9a632f,subnet-09290d93da4278664,subnet-0f21dd86e0e91134a,subnet-0173dead68481a583,subnet-051f70a57ed6fcab6,subnet-01322339c5c7de9b4,securityGroupIds=sg-0c5b580845a031c10,endpointPublicAccess=false,endpointPrivateAccess=true \ + --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' + +Output:: + + { + "cluster": { + "name": "example", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/example", + "createdAt": 1565804921.901, + "version": "1.12", + "roleArn": "arn:aws:iam::012345678910:role/example-cluster-ServiceRole-1XWBQWYSFRE2Q", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-0a188dccd2f9a632f", + "subnet-09290d93da4278664", + "subnet-0f21dd86e0e91134a", + "subnet-0173dead68481a583", + "subnet-051f70a57ed6fcab6", + "subnet-01322339c5c7de9b4" + ], + "securityGroupIds": [ + "sg-0c5b580845a031c10" + ], + "vpcId": "vpc-0f622c01f68d4afec", + "endpointPublicAccess": false, + "endpointPrivateAccess": true + }, + "logging": { + "clusterLogging": [ + { + "types": [ + "api", + "audit", + "authenticator", + "controllerManager", + "scheduler" + ], + "enabled": true + } + ] + }, + "status": "CREATING", + "certificateAuthority": {}, + "platformVersion": "eks.3" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/eks/delete-cluster.rst b/aws/dist/awscli/examples/eks/delete-cluster.rst new file mode 100644 index 00000000..9de65227 --- /dev/null +++ b/aws/dist/awscli/examples/eks/delete-cluster.rst @@ -0,0 +1,7 @@ +**To delete a cluster** + +This example command deletes a cluster named ``devel`` in your default region. + +Command:: + + aws eks delete-cluster --name devel diff --git a/aws/dist/awscli/examples/eks/describe-cluster.rst b/aws/dist/awscli/examples/eks/describe-cluster.rst new file mode 100644 index 00000000..8029f30a --- /dev/null +++ b/aws/dist/awscli/examples/eks/describe-cluster.rst @@ -0,0 +1,34 @@ +**To describe a cluster** + +This example command provides a description of the specified cluster in your default region. + +Command:: + + aws eks describe-cluster --name devel + +Output:: + + { + "cluster": { + "name": "devel", + "arn": "arn:aws:eks:us-west-2:012345678910:cluster/devel", + "createdAt": 1527807879.988, + "version": "1.10", + "endpoint": "https://EXAMPLE0A04F01705DD065655C30CC3D.yl4.us-west-2.eks.amazonaws.com", + "roleArn": "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI", + "resourcesVpcConfig": { + "subnetIds": [ + "subnet-6782e71e", + "subnet-e7e761ac" + ], + "securityGroupIds": [ + "sg-6979fe18" + ], + "vpcId": "vpc-950809ec" + }, + "status": "ACTIVE", + "certificateAuthority": { + "data": "EXAMPLECRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUN5RENDQWJDZ0F3SUJBZ0lCQURBTkJna3Foa2lHOXcwQkFRc0ZBREFWTVJNd0VRWURWUVFERXdwcmRXSmwKY201bGRHVnpNQjRYRFRFNE1EVXpNVEl6TVRFek1Wb1hEVEk0TURVeU9ESXpNVEV6TVZvd0ZURVRNQkVHQTFVRQpBeE1LYTNWaVpYSnVaWFJsY3pDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRGdnRVBBRENDQVFvQ2dnRUJBTTZWCjVUaG4rdFcySm9Xa2hQMzRlVUZMNitaRXJOZGIvWVdrTmtDdWNGS2RaaXl2TjlMVmdvUmV2MjlFVFZlN1ZGbSsKUTJ3ZURyRXJiQyt0dVlibkFuN1ZLYmE3ay9hb1BHekZMdmVnb0t6b0M1N2NUdGVwZzRIazRlK2tIWHNaME10MApyb3NzcjhFM1ROeExETnNJTThGL1cwdjhsTGNCbWRPcjQyV2VuTjFHZXJnaDNSZ2wzR3JIazBnNTU0SjFWenJZCm9hTi8zODFUczlOTFF2QTBXb0xIcjBFRlZpTFdSZEoyZ3lXaC9ybDVyOFNDOHZaQXg1YW1BU0hVd01aTFpWRC8KTDBpOW4wRVM0MkpVdzQyQmxHOEdpd3NhTkJWV3lUTHZKclNhRXlDSHFtVVZaUTFDZkFXUjl0L3JleVVOVXM3TApWV1FqM3BFbk9RMitMSWJrc0RzQ0F3RUFBYU1qTUNFd0RnWURWUjBQQVFIL0JBUURBZ0trTUE4R0ExVWRFd0VCCi93UUZNQU1CQWY4d0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQkFNZ3RsQ1dIQ2U2YzVHMXl2YlFTS0Q4K2hUalkKSm1NSG56L2EvRGt0WG9YUjFVQzIrZUgzT1BZWmVjRVZZZHVaSlZCckNNQ2VWR0ZkeWdBYlNLc1FxWDg0S2RXbAp1MU5QaERDSmEyRHliN2pVMUV6VThTQjFGZUZ5ZFE3a0hNS1E1blpBRVFQOTY4S01hSGUrSm0yQ2x1UFJWbEJVCjF4WlhTS1gzTVZ0K1Q0SU1EV2d6c3JRSjVuQkRjdEtLcUZtM3pKdVVubHo5ZEpVckdscEltMjVJWXJDckxYUFgKWkUwRUtRNWEzMHhkVWNrTHRGQkQrOEtBdFdqSS9yZUZPNzM1YnBMdVoyOTBaNm42QlF3elRrS0p4cnhVc3QvOAppNGsxcnlsaUdWMm5SSjBUYjNORkczNHgrYWdzYTRoSTFPbU90TFM0TmgvRXJxT3lIUXNDc2hEQUtKUT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=" + } + } + } diff --git a/aws/dist/awscli/examples/eks/describe-update.rst b/aws/dist/awscli/examples/eks/describe-update.rst new file mode 100644 index 00000000..2f0f26be --- /dev/null +++ b/aws/dist/awscli/examples/eks/describe-update.rst @@ -0,0 +1,30 @@ +**To describe an update for a cluster** + +This example command describes an update for a cluster named ``example`` in your default region. + +Command:: + + aws eks describe-update --name example \ + --update-id 10bddb13-a71b-425a-b0a6-71cd03e59161 + +Output:: + + { + "update": { + "id": "10bddb13-a71b-425a-b0a6-71cd03e59161", + "status": "Successful", + "type": "EndpointAccessUpdate", + "params": [ + { + "type": "EndpointPublicAccess", + "value": "true" + }, + { + "type": "EndpointPrivateAccess", + "value": "false" + } + ], + "createdAt": 1565806691.149, + "errors": [] + } + } diff --git a/aws/dist/awscli/examples/eks/get-token.rst b/aws/dist/awscli/examples/eks/get-token.rst new file mode 100644 index 00000000..92a94e5b --- /dev/null +++ b/aws/dist/awscli/examples/eks/get-token.rst @@ -0,0 +1,19 @@ +**To get a cluster authentication token** + +This example command gets an authentication token for a cluster named ``example``. + +Command:: + + aws eks get-token --cluster-name example + +Output:: + + { + "kind": "ExecCredential", + "apiVersion": "client.authentication.k8s.io/v1alpha1", + "spec": {}, + "status": { + "expirationTimestamp": "2019-08-14T18:44:27Z", + "token": "k8s-aws-v1EXAMPLE_TOKEN_DATA_STRING..." + } + } diff --git a/aws/dist/awscli/examples/eks/list-clusters.rst b/aws/dist/awscli/examples/eks/list-clusters.rst new file mode 100644 index 00000000..e7706346 --- /dev/null +++ b/aws/dist/awscli/examples/eks/list-clusters.rst @@ -0,0 +1,16 @@ +**To list your available clusters** + +This example command lists all of your available clusters in your default region. + +Command:: + + aws eks list-clusters + +Output:: + + { + "clusters": [ + "devel", + "prod" + ] + } diff --git a/aws/dist/awscli/examples/eks/list-updates.rst b/aws/dist/awscli/examples/eks/list-updates.rst new file mode 100644 index 00000000..8d281603 --- /dev/null +++ b/aws/dist/awscli/examples/eks/list-updates.rst @@ -0,0 +1,15 @@ +**To list the updates for a cluster** + +This example command lists the current updates for a cluster named ``example`` in your default region. + +Command:: + + aws eks list-updates --name example + +Output:: + + { + "updateIds": [ + "10bddb13-a71b-425a-b0a6-71cd03e59161" + ] + } diff --git a/aws/dist/awscli/examples/eks/update-cluster-config.rst b/aws/dist/awscli/examples/eks/update-cluster-config.rst new file mode 100644 index 00000000..df86904d --- /dev/null +++ b/aws/dist/awscli/examples/eks/update-cluster-config.rst @@ -0,0 +1,57 @@ +**To update cluster endpoint access** + +This example command updates a cluster to disable endpoint public access and enable private endpoint access. + +Command:: + + aws eks update-cluster-config --name example \ + --resources-vpc-config endpointPublicAccess=false,endpointPrivateAccess=true + +Output:: + + { + "update": { + "id": "ec883c93-2e9e-407c-a22f-8f6fa6e67d4f", + "status": "InProgress", + "type": "EndpointAccessUpdate", + "params": [ + { + "type": "EndpointPublicAccess", + "value": "false" + }, + { + "type": "EndpointPrivateAccess", + "value": "true" + } + ], + "createdAt": 1565806986.506, + "errors": [] + } + } + +**To enable logging for a cluster** + +This example command enables all cluster control plane logging types for a cluster named ``example``. + +Command:: + + aws eks update-cluster-config --name example \ + --logging '{"clusterLogging":[{"types":["api","audit","authenticator","controllerManager","scheduler"],"enabled":true}]}' + +Output:: + + { + "update": { + "id": "7551c64b-1d27-4b1e-9f8e-c45f056eb6fd", + "status": "InProgress", + "type": "LoggingUpdate", + "params": [ + { + "type": "ClusterLogging", + "value": "{\"clusterLogging\":[{\"types\":[\"api\",\"audit\",\"authenticator\",\"controllerManager\",\"scheduler\"],\"enabled\":true}]}" + } + ], + "createdAt": 1565807210.37, + "errors": [] + } + } diff --git a/aws/dist/awscli/examples/eks/update-cluster-version.rst b/aws/dist/awscli/examples/eks/update-cluster-version.rst new file mode 100644 index 00000000..02ab8883 --- /dev/null +++ b/aws/dist/awscli/examples/eks/update-cluster-version.rst @@ -0,0 +1,29 @@ +**To update a cluster Kubernetes version** + +This example command updates a cluster named ``example`` from Kubernetes 1.12 to 1.13. + +Command:: + + aws eks update-cluster-version --name example --kubernetes-version 1.13 + +Output:: + + { + "update": { + "id": "161a74d1-7e8c-4224-825d-b32af149f23a", + "status": "InProgress", + "type": "VersionUpdate", + "params": [ + { + "type": "Version", + "value": "1.13" + }, + { + "type": "PlatformVersion", + "value": "eks.2" + } + ], + "createdAt": 1565807633.514, + "errors": [] + } + } diff --git a/aws/dist/awscli/examples/eks/update-kubeconfig.rst b/aws/dist/awscli/examples/eks/update-kubeconfig.rst new file mode 100644 index 00000000..ac7264fc --- /dev/null +++ b/aws/dist/awscli/examples/eks/update-kubeconfig.rst @@ -0,0 +1,11 @@ +**To update a kubeconfig for your cluster** + +This example command updates the default kubeconfig file to use your cluster as the current context. + +Command:: + + aws eks update-kubeconfig --name example + +Output:: + + Added new context arn:aws:eks:us-west-2:012345678910:cluster/example to /Users/ericn/.kube/config \ No newline at end of file diff --git a/aws/dist/awscli/examples/eks/update-kubeconfig/_description.rst b/aws/dist/awscli/examples/eks/update-kubeconfig/_description.rst new file mode 100644 index 00000000..00da7bca --- /dev/null +++ b/aws/dist/awscli/examples/eks/update-kubeconfig/_description.rst @@ -0,0 +1,19 @@ +Configures kubectl so that you can connect to an Amazon EKS cluster. + +Note: + To use the resulting configuration, you must have kubectl installed and in your PATH environment variable. + +This command constructs a configuration with prepopulated server and certificate authority data values for a specified cluster. +You can specify an IAM role ARN with the --role-arn option to use for authentication when you issue kubectl commands. +Otherwise, the IAM entity in your default AWS CLI or SDK credential chain is used. +You can view your default AWS CLI or SDK identity by running the ``aws sts get-caller-identity`` command. + +The resulting kubeconfig is created as a new file or merged with an existing kubeconfig file using the following logic: + +* If you specify a path with the --kubeconfig option, then the resulting configuration file is created there or merged with an existing kubeconfig at that location. +* Or, if you have the KUBECONFIG environment variable set, then the resulting configuration file is created at the first entry in that variable or merged with an existing kubeconfig at that location. +* Otherwise, by default, the resulting configuration file is created at the default kubeconfig path (.kube/config) in your home directory or merged with an existing kubeconfig at that location. +* If a previous cluster configuration exists for an Amazon EKS cluster with the same name at the specified path, the existing configuration is overwritten with the new configuration. +* When update-kubeconfig writes a configuration to a kubeconfig file, the current-context of the kubeconfig file is set to that configuration. + +You can use the --dry-run option to print the resulting configuration to stdout instead of writing it to the specified location. diff --git a/aws/dist/awscli/examples/eks/wait.rst b/aws/dist/awscli/examples/eks/wait.rst new file mode 100644 index 00000000..8203134e --- /dev/null +++ b/aws/dist/awscli/examples/eks/wait.rst @@ -0,0 +1,16 @@ +**To wait for a cluster to become active** + +This example command waits for a cluster named ``example`` to become active. + +Command:: + + aws eks wait cluster-active --name example + +**To wait for a cluster to be deleted** + +This example command waits for a cluster named ``example`` to be deleted. + +Command:: + + aws eks wait cluster-deleted --name example + diff --git a/aws/dist/awscli/examples/elasticache/create-replication-group.rst b/aws/dist/awscli/examples/elasticache/create-replication-group.rst new file mode 100644 index 00000000..dee5524e --- /dev/null +++ b/aws/dist/awscli/examples/elasticache/create-replication-group.rst @@ -0,0 +1,16 @@ +**To create an Amazon ElastiCache Replication Group** + +The following ``create-replication-group`` command launches a new Amazon ElastiCache Redis replication group:: + + aws elasticache create-replication-group --replication-group-id myRedis \ + --replication-group-description "desc of myRedis" \ + --automatic-failover-enabled --num-cache-clusters 3 \ + --cache-node-type cache.m3.medium \ + --engine redis --engine-version 2.8.24 \ + --cache-parameter-group-name default.redis2.8 \ + --cache-subnet-group-name default --security-group-ids sg-12345678 + +In the preceding example, the replication group is created with 3 clusters(primary plus 2 replicas) and has a cache node class of cach3.m3.medium. +With `--automatic-failover-enabled` option, Multi-AZ and automatic failover are enabled. + +This command output a JSON block that indicates that the replication group was created. diff --git a/aws/dist/awscli/examples/elasticache/modify-cache-parameter-group.rst b/aws/dist/awscli/examples/elasticache/modify-cache-parameter-group.rst new file mode 100644 index 00000000..bb46f58a --- /dev/null +++ b/aws/dist/awscli/examples/elasticache/modify-cache-parameter-group.rst @@ -0,0 +1,17 @@ +**To modify cache parameter groups** + +This example modifies parameters for the specified cache parameter group. + +Command:: + + aws elasticache modify-cache-parameter-group \ + --cache-parameter-group-name my-redis-28 --parameter-name-values \ + ParameterName=close-on-slave-write,ParameterValue=no \ + ParameterName=timeout,ParameterValue=60 + +Output:: + + { + "CacheParameterGroupName": "my-redis-28" + } + diff --git a/aws/dist/awscli/examples/elasticache/modify-replication-group.rst b/aws/dist/awscli/examples/elasticache/modify-replication-group.rst new file mode 100644 index 00000000..d1c367bc --- /dev/null +++ b/aws/dist/awscli/examples/elasticache/modify-replication-group.rst @@ -0,0 +1,11 @@ +**To promote a cache cluster to the primary role** + +This example promotes the cache cluster *mycluster-002* to the primary role for the specified replication group. + +Command:: + + aws elasticache modify-replication-group --replication-group-id mycluster \ + --primary-cluster-id mycluster-002 --apply-immediately + +The nodes of all other cache clusters in the replication group will be read replicas. +If the specified group's *autofailover* is enabled, you cannot mannualy promote cache clusters. diff --git a/aws/dist/awscli/examples/elasticbeanstalk/abort-environment-update.rst b/aws/dist/awscli/examples/elasticbeanstalk/abort-environment-update.rst new file mode 100644 index 00000000..d7aebf08 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/abort-environment-update.rst @@ -0,0 +1,5 @@ +**To abort a deployment** + +The following command aborts a running application version deployment for an environment named ``my-env``:: + + aws elasticbeanstalk abort-environment-update --environment-name my-env diff --git a/aws/dist/awscli/examples/elasticbeanstalk/check-dns-availability.rst b/aws/dist/awscli/examples/elasticbeanstalk/check-dns-availability.rst new file mode 100644 index 00000000..efb0a513 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/check-dns-availability.rst @@ -0,0 +1,12 @@ +**To check the availability of a CNAME** + +The following command checks the availability of the subdomain ``my-cname.elasticbeanstalk.com``:: + + aws elasticbeanstalk check-dns-availability --cname-prefix my-cname + +Output:: + + { + "Available": true, + "FullyQualifiedCNAME": "my-cname.elasticbeanstalk.com" + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/create-application-version.rst b/aws/dist/awscli/examples/elasticbeanstalk/create-application-version.rst new file mode 100644 index 00000000..cf504b44 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/create-application-version.rst @@ -0,0 +1,23 @@ +**To create a new application version** + +The following command creates a new version, "v1" of an application named "MyApp":: + + aws elasticbeanstalk create-application-version --application-name MyApp --version-label v1 --description MyAppv1 --source-bundle S3Bucket="my-bucket",S3Key="sample.war" --auto-create-application + +The application will be created automatically if it does not already exist, due to the auto-create-application option. The source bundle is a .war file stored in an s3 bucket named "my-bucket" that contains the Apache Tomcat sample application. + +Output:: + + { + "ApplicationVersion": { + "ApplicationName": "MyApp", + "VersionLabel": "v1", + "Description": "MyAppv1", + "DateCreated": "2015-02-03T23:01:25.412Z", + "DateUpdated": "2015-02-03T23:01:25.412Z", + "SourceBundle": { + "S3Bucket": "my-bucket", + "S3Key": "sample.war" + } + } + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/create-application.rst b/aws/dist/awscli/examples/elasticbeanstalk/create-application.rst new file mode 100644 index 00000000..f419ef19 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/create-application.rst @@ -0,0 +1,19 @@ +**To create a new application** + +The following command creates a new application named "MyApp":: + + aws elasticbeanstalk create-application --application-name MyApp --description "my application" + +The ``create-application`` command only configures the application's name and description. To upload source code for the application, create an initial version of the application using ``create-application-version``. ``create-application-version`` also has an ``auto-create-application`` option that lets you create the application and the application version in one step. + +Output:: + + { + "Application": { + "ApplicationName": "MyApp", + "ConfigurationTemplates": [], + "DateUpdated": "2015-02-12T18:32:21.181Z", + "Description": "my application", + "DateCreated": "2015-02-12T18:32:21.181Z" + } + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/create-configuration-template.rst b/aws/dist/awscli/examples/elasticbeanstalk/create-configuration-template.rst new file mode 100644 index 00000000..86da851e --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/create-configuration-template.rst @@ -0,0 +1,15 @@ +**To create a configuration template** + +The following command creates a configuration template named ``my-app-v1`` from the settings applied to an environment with the id ``e-rpqsewtp2j``:: + + aws elasticbeanstalk create-configuration-template --application-name my-app --template-name my-app-v1 --environment-id e-rpqsewtp2j + +Output:: + + { + "ApplicationName": "my-app", + "TemplateName": "my-app-v1", + "DateCreated": "2015-08-12T18:40:39Z", + "DateUpdated": "2015-08-12T18:40:39Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/create-environment.rst b/aws/dist/awscli/examples/elasticbeanstalk/create-environment.rst new file mode 100644 index 00000000..b4bb0cd4 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/create-environment.rst @@ -0,0 +1,64 @@ +**To create a new environment for an application** + +The following command creates a new environment for version "v1" of a java application named "my-app":: + + aws elasticbeanstalk create-environment --application-name my-app --environment-name my-env --cname-prefix my-app --version-label v1 --solution-stack-name "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + +Output:: + + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "VersionLabel": "v1", + "Status": "Launching", + "EnvironmentId": "e-izqpassy4h", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "CNAME": "my-app.elasticbeanstalk.com", + "Health": "Grey", + "Tier": { + "Type": "Standard", + "Name": "WebServer", + "Version": " " + }, + "DateUpdated": "2015-02-03T23:04:54.479Z", + "DateCreated": "2015-02-03T23:04:54.479Z" + } + +``v1`` is the label of an application version previously uploaded with `create-application-version`_. + +.. _`create-application-version`: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/create-application-version.html + +**To specify a JSON file to define environment configuration options** + +The following ``create-environment`` command specifies that a JSON file with the name ``myoptions.json`` should be used to override values obtained from the solution stack or the configuration template:: + + aws elasticbeanstalk create-environment --environment-name sample-env --application-name sampleapp --option-settings file://myoptions.json + +``myoptions.json`` is a JSON object defining several settings:: + + [ + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Interval", + "Value": "15" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Timeout", + "Value": "8" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "HealthyThreshold", + "Value": "2" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "UnhealthyThreshold", + "Value": "3" + } + ] + +For more information, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/create-storage-location.rst b/aws/dist/awscli/examples/elasticbeanstalk/create-storage-location.rst new file mode 100644 index 00000000..8e303241 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/create-storage-location.rst @@ -0,0 +1,11 @@ +**To create a storage location** + +The following command creates a storage location in Amazon S3:: + + aws elasticbeanstalk create-storage-location + +Output:: + + { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/delete-application-version.rst b/aws/dist/awscli/examples/elasticbeanstalk/delete-application-version.rst new file mode 100644 index 00000000..997e589d --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/delete-application-version.rst @@ -0,0 +1,5 @@ +**To delete an application version** + +The following command deletes an application version named ``22a0-stage-150819_182129`` for an application named ``my-app``:: + + aws elasticbeanstalk delete-application-version --version-label 22a0-stage-150819_182129 --application-name my-app diff --git a/aws/dist/awscli/examples/elasticbeanstalk/delete-application.rst b/aws/dist/awscli/examples/elasticbeanstalk/delete-application.rst new file mode 100644 index 00000000..58941fef --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/delete-application.rst @@ -0,0 +1,5 @@ +**To delete an application** + +The following command deletes an application named ``my-app``:: + + aws elasticbeanstalk delete-application --application-name my-app diff --git a/aws/dist/awscli/examples/elasticbeanstalk/delete-configuration-template.rst b/aws/dist/awscli/examples/elasticbeanstalk/delete-configuration-template.rst new file mode 100644 index 00000000..a0c1fe33 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/delete-configuration-template.rst @@ -0,0 +1,5 @@ +**To delete a configuration template** + +The following command deletes a configuration template named ``my-template`` for an application named ``my-app``:: + + aws elasticbeanstalk delete-configuration-template --template-name my-template --application-name my-app diff --git a/aws/dist/awscli/examples/elasticbeanstalk/delete-environment-configuration.rst b/aws/dist/awscli/examples/elasticbeanstalk/delete-environment-configuration.rst new file mode 100644 index 00000000..d294ba54 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/delete-environment-configuration.rst @@ -0,0 +1,5 @@ +**To delete a draft configuration** + +The following command deletes a draft configuration for an environment named ``my-env``:: + + aws elasticbeanstalk delete-environment-configuration --environment-name my-env --application-name my-app diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-application-versions.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-application-versions.rst new file mode 100644 index 00000000..5f5adbfd --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-application-versions.rst @@ -0,0 +1,34 @@ +**To view information about an application version** + +The following command retrieves information about an application version labeled ``v2``:: + + aws elasticbeanstalk describe-application-versions --application-name my-app --version-label "v2" + +Output:: + + { + "ApplicationVersions": [ + { + "ApplicationName": "my-app", + "VersionLabel": "v2", + "Description": "update cover page", + "DateCreated": "2015-07-23T01:32:26.079Z", + "DateUpdated": "2015-07-23T01:32:26.079Z", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_224258.war" + } + }, + { + "ApplicationName": "my-app", + "VersionLabel": "v1", + "Description": "initial version", + "DateCreated": "2015-07-23T22:26:10.816Z", + "DateUpdated": "2015-07-23T22:26:10.816Z", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_222618.war" + } + } + ] + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-applications.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-applications.rst new file mode 100644 index 00000000..96d83780 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-applications.rst @@ -0,0 +1,41 @@ +**To view a list of applications** + +The following command retrieves information about applications in the current region:: + + aws elasticbeanstalk describe-applications + +Output:: + + { + "Applications": [ + { + "ApplicationName": "ruby", + "ConfigurationTemplates": [], + "DateUpdated": "2015-08-13T21:05:44.376Z", + "Versions": [ + "Sample Application" + ], + "DateCreated": "2015-08-13T21:05:44.376Z" + }, + { + "ApplicationName": "pythonsample", + "Description": "Application created from the EB CLI using \"eb init\"", + "Versions": [ + "Sample Application" + ], + "DateCreated": "2015-08-13T19:05:43.637Z", + "ConfigurationTemplates": [], + "DateUpdated": "2015-08-13T19:05:43.637Z" + }, + { + "ApplicationName": "nodejs-example", + "ConfigurationTemplates": [], + "DateUpdated": "2015-08-06T17:50:02.486Z", + "Versions": [ + "add elasticache", + "First Release" + ], + "DateCreated": "2015-08-06T17:50:02.486Z" + } + ] + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-options.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-options.rst new file mode 100644 index 00000000..096fdee1 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-options.rst @@ -0,0 +1,52 @@ +**To view configuration options for an environment** + +The following command retrieves descriptions of all available configuration options for an environment named ``my-env``:: + + aws elasticbeanstalk describe-configuration-options --environment-name my-env --application-name my-app + +Output (abbreviated):: + + { + "Options": [ + { + "Name": "JVMOptions", + "UserDefined": false, + "DefaultValue": "Xms=256m,Xmx=256m,XX:MaxPermSize=64m,JVM Options=", + "ChangeSeverity": "RestartApplicationServer", + "Namespace": "aws:cloudformation:template:parameter", + "ValueType": "KeyValueList" + }, + { + "Name": "Interval", + "UserDefined": false, + "DefaultValue": "30", + "ChangeSeverity": "NoInterruption", + "Namespace": "aws:elb:healthcheck", + "MaxValue": 300, + "MinValue": 5, + "ValueType": "Scalar" + }, + ... + { + "Name": "LowerThreshold", + "UserDefined": false, + "DefaultValue": "2000000", + "ChangeSeverity": "NoInterruption", + "Namespace": "aws:autoscaling:trigger", + "MinValue": 0, + "ValueType": "Scalar" + }, + { + "Name": "ListenerEnabled", + "UserDefined": false, + "DefaultValue": "true", + "ChangeSeverity": "Unknown", + "Namespace": "aws:elb:listener", + "ValueType": "Boolean" + } + ] + } + +Available configuration options vary per platform and configuration version. For more information about namespaces and supported options, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-settings.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-settings.rst new file mode 100644 index 00000000..8a2859cb --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-configuration-settings.rst @@ -0,0 +1,52 @@ +**To view configurations settings for an environment** + +The following command retrieves configuration settings for an environment named ``my-env``:: + + aws elasticbeanstalk describe-configuration-settings --environment-name my-env --application-name my-app + +Output (abbreviated):: + + { + "ConfigurationSettings": [ + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Description": "Environment created from the EB CLI using \"eb create\"", + "DeploymentStatus": "deployed", + "DateCreated": "2015-08-13T19:16:25Z", + "OptionSettings": [ + { + "OptionName": "Availability Zones", + "ResourceName": "AWSEBAutoScalingGroup", + "Namespace": "aws:autoscaling:asg", + "Value": "Any" + }, + { + "OptionName": "Cooldown", + "ResourceName": "AWSEBAutoScalingGroup", + "Namespace": "aws:autoscaling:asg", + "Value": "360" + }, + ... + { + "OptionName": "ConnectionDrainingTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Namespace": "aws:elb:policies", + "Value": "20" + }, + { + "OptionName": "ConnectionSettingIdleTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Namespace": "aws:elb:policies", + "Value": "60" + } + ], + "DateUpdated": "2015-08-13T23:30:07Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + } + ] + } + +For more information about namespaces and supported options, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-health.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-health.rst new file mode 100644 index 00000000..3ca316cc --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-health.rst @@ -0,0 +1,50 @@ +**To view environment health** + +The following command retrieves overall health information for an environment named ``my-env``:: + + aws elasticbeanstalk describe-environment-health --environment-name my-env --attribute-names All + +Output:: + + { + "Status": "Ready", + "EnvironmentName": "my-env", + "Color": "Green", + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P99": 0.004, + "P75": 0.002, + "P90": 0.003, + "P95": 0.004, + "P85": 0.003, + "P10": 0.001, + "P999": 0.004, + "P50": 0.001 + }, + "RequestCount": 45, + "StatusCodes": { + "Status3xx": 0, + "Status2xx": 45, + "Status5xx": 0, + "Status4xx": 0 + } + }, + "RefreshedAt": "2015-08-20T21:09:18Z", + "HealthStatus": "Ok", + "InstancesHealth": { + "Info": 0, + "Ok": 1, + "Unknown": 0, + "Severe": 0, + "Warning": 0, + "Degraded": 0, + "NoData": 0, + "Pending": 0 + }, + "Causes": [] + } + +Health information is only available for environments with enhanced health reporting enabled. For more information, see `Enhanced Health Reporting and Monitoring`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Enhanced Health Reporting and Monitoring`: http://integ-docs-aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-resources.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-resources.rst new file mode 100644 index 00000000..590b9f0b --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-environment-resources.rst @@ -0,0 +1,35 @@ +**To view information about the AWS resources in your environment** + +The following command retrieves information about resources in an environment named ``my-env``:: + + aws elasticbeanstalk describe-environment-resources --environment-name my-env + +Output:: + + { + "EnvironmentResources": { + "EnvironmentName": "my-env", + "AutoScalingGroups": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT" + } + ], + "Triggers": [], + "LoadBalancers": [ + { + "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0" + } + ], + "Queues": [], + "Instances": [ + { + "Id": "i-0c91c786" + } + ], + "LaunchConfigurations": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2" + } + ] + } + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-environments.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-environments.rst new file mode 100644 index 00000000..5995bd13 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-environments.rst @@ -0,0 +1,31 @@ +**To view information about an environment** + +The following command retrieves information about an environment named ``my-env``:: + + aws elasticbeanstalk describe-environments --environment-names my-env + +Output:: + + { + "Environments": [ + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "VersionLabel": "7f58-stage-150812_025409", + "Status": "Ready", + "EnvironmentId": "e-rpqsewtp2j", + "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "CNAME": "my-env.elasticbeanstalk.com", + "Health": "Green", + "AbortableOperationInProgress": false, + "Tier": { + "Version": " ", + "Type": "Standard", + "Name": "WebServer" + }, + "DateUpdated": "2015-08-12T18:16:55.019Z", + "DateCreated": "2015-08-07T20:48:49.599Z" + } + ] + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-events.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-events.rst new file mode 100644 index 00000000..33df64a1 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-events.rst @@ -0,0 +1,44 @@ +**To view events for an environment** + +The following command retrieves events for an environment named ``my-env``:: + + aws elasticbeanstalk describe-events --environment-name my-env + +Output (abbreviated):: + + { + "Events": [ + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Message": "Environment health has transitioned from Info to Ok.", + "EventDate": "2015-08-20T07:06:53.535Z", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Severity": "INFO", + "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41", + "Message": "Environment update completed successfully.", + "EventDate": "2015-08-20T07:06:02.049Z" + }, + ... + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Severity": "INFO", + "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b", + "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", + "EventDate": "2015-08-13T19:16:27.561Z" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Severity": "INFO", + "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b", + "Message": "createEnvironment is starting.", + "EventDate": "2015-08-13T19:16:26.581Z" + } + ] + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/describe-instances-health.rst b/aws/dist/awscli/examples/elasticbeanstalk/describe-instances-health.rst new file mode 100644 index 00000000..e843fd83 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/describe-instances-health.rst @@ -0,0 +1,60 @@ +**To view environment health** + +The following command retrieves health information for instances in an environment named ``my-env``:: + + aws elasticbeanstalk describe-instances-health --environment-name my-env --attribute-names All + +Output:: + + { + "InstanceHealthList": [ + { + "InstanceId": "i-08691cc7", + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P99": 0.006, + "P75": 0.002, + "P90": 0.004, + "P95": 0.005, + "P85": 0.003, + "P10": 0.0, + "P999": 0.006, + "P50": 0.001 + }, + "RequestCount": 48, + "StatusCodes": { + "Status3xx": 0, + "Status2xx": 47, + "Status5xx": 0, + "Status4xx": 1 + } + }, + "System": { + "LoadAverage": [ + 0.0, + 0.02, + 0.05 + ], + "CPUUtilization": { + "SoftIRQ": 0.1, + "IOWait": 0.2, + "System": 0.3, + "Idle": 97.8, + "User": 1.5, + "IRQ": 0.0, + "Nice": 0.1 + } + }, + "Color": "Green", + "HealthStatus": "Ok", + "LaunchedAt": "2015-08-13T19:17:09Z", + "Causes": [] + } + ], + "RefreshedAt": "2015-08-20T21:09:08Z" + } + +Health information is only available for environments with enhanced health reporting enabled. For more information, see `Enhanced Health Reporting and Monitoring`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Enhanced Health Reporting and Monitoring`: http://integ-docs-aws.amazon.com/elasticbeanstalk/latest/dg/health-enhanced.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/list-available-solution-stacks.rst b/aws/dist/awscli/examples/elasticbeanstalk/list-available-solution-stacks.rst new file mode 100644 index 00000000..c4bc8f66 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/list-available-solution-stacks.rst @@ -0,0 +1,50 @@ +**To view solution stacks** + +The following command lists solution stacks for all currently available platform configurations and any that you have used in the past:: + + aws elasticbeanstalk list-available-solution-stacks + +Output (abbreviated):: + + { + "SolutionStacks": [ + "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", + "64bit Amazon Linux 2015.03 v2.0.0 running Python", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", + "64bit Windows Server Core 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 running IIS 8", + "64bit Windows Server 2008 R2 running IIS 7.5", + "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", + "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", + "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)", + ], + "SolutionStackDetails": [ + { + "PermittedFileTypes": [ + "zip" + ], + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js" + }, + ... + ] + } + diff --git a/aws/dist/awscli/examples/elasticbeanstalk/rebuild-environment.rst b/aws/dist/awscli/examples/elasticbeanstalk/rebuild-environment.rst new file mode 100644 index 00000000..d60ecdd0 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/rebuild-environment.rst @@ -0,0 +1,5 @@ +**To rebuild an environment** + +The following command terminates and recreates the resources in an environment named ``my-env``:: + + aws elasticbeanstalk rebuild-environment --environment-name my-env diff --git a/aws/dist/awscli/examples/elasticbeanstalk/request-environment-info.rst b/aws/dist/awscli/examples/elasticbeanstalk/request-environment-info.rst new file mode 100644 index 00000000..d21f9651 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/request-environment-info.rst @@ -0,0 +1,9 @@ +**To request tailed logs** + +The following command requests logs from an environment named ``my-env``:: + + aws elasticbeanstalk request-environment-info --environment-name my-env --info-type tail + +After requesting logs, retrieve their location with `retrieve-environment-info`_. + +.. _`retrieve-environment-info`: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/retrieve-environment-info.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/restart-app-server.rst b/aws/dist/awscli/examples/elasticbeanstalk/restart-app-server.rst new file mode 100644 index 00000000..c2aa1039 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/restart-app-server.rst @@ -0,0 +1,5 @@ +**To restart application servers** + +The following command restarts application servers on all instances in an environment named ``my-env``:: + + aws elasticbeanstalk restart-app-server --environment-name my-env diff --git a/aws/dist/awscli/examples/elasticbeanstalk/retrieve-environment-info.rst b/aws/dist/awscli/examples/elasticbeanstalk/retrieve-environment-info.rst new file mode 100644 index 00000000..01e7b134 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/retrieve-environment-info.rst @@ -0,0 +1,23 @@ +**To retrieve tailed logs** + +The following command retrieves a link to logs from an environment named ``my-env``:: + + aws elasticbeanstalk retrieve-environment-info --environment-name my-env --info-type tail + +Output:: + + { + "EnvironmentInfo": [ + { + "SampleTimestamp": "2015-08-20T22:23:17.703Z", + "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", + "InfoType": "tail", + "Ec2InstanceId": "i-09c1c867" + } + ] + } + +View the link in a browser. Prior to retrieval, logs must be requested with `request-environment-info`_. + +.. _`request-environment-info`: http://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/retrieve-environment-info.html + \ No newline at end of file diff --git a/aws/dist/awscli/examples/elasticbeanstalk/swap-environment-cnames.rst b/aws/dist/awscli/examples/elasticbeanstalk/swap-environment-cnames.rst new file mode 100644 index 00000000..1cc72734 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/swap-environment-cnames.rst @@ -0,0 +1,5 @@ +**To swap environment CNAMES** + +The following command swaps the assigned subdomains of two environments:: + + aws elasticbeanstalk swap-environment-cnames --source-environment-name my-env-blue --destination-environment-name my-env-green diff --git a/aws/dist/awscli/examples/elasticbeanstalk/terminate-environment.rst b/aws/dist/awscli/examples/elasticbeanstalk/terminate-environment.rst new file mode 100644 index 00000000..be86dd47 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/terminate-environment.rst @@ -0,0 +1,26 @@ +**To terminate an environment** + +The following command terminates an Elastic Beanstalk environment named ``my-env``:: + + aws elasticbeanstalk terminate-environment --environment-name my-env + +Output:: + + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "Status": "Terminating", + "EnvironmentId": "e-fh2eravpns", + "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "CNAME": "my-env.elasticbeanstalk.com", + "Health": "Grey", + "AbortableOperationInProgress": false, + "Tier": { + "Version": " ", + "Type": "Standard", + "Name": "WebServer" + }, + "DateUpdated": "2015-08-12T19:05:54.744Z", + "DateCreated": "2015-08-12T18:52:53.622Z" + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/update-application-version.rst b/aws/dist/awscli/examples/elasticbeanstalk/update-application-version.rst new file mode 100644 index 00000000..5d9ab22b --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/update-application-version.rst @@ -0,0 +1,21 @@ +**To change an application version's description** + +The following command updates the description of an application version named ``22a0-stage-150819_185942``:: + + aws elasticbeanstalk update-application-version --version-label 22a0-stage-150819_185942 --application-name my-app --description "new description" + +Output:: + + { + "ApplicationVersion": { + "ApplicationName": "my-app", + "VersionLabel": "22a0-stage-150819_185942", + "Description": "new description", + "DateCreated": "2015-08-19T18:59:17.646Z", + "DateUpdated": "2015-08-20T22:53:28.871Z", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012", + "S3Key": "my-app/22a0-stage-150819_185942.war" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/elasticbeanstalk/update-application.rst b/aws/dist/awscli/examples/elasticbeanstalk/update-application.rst new file mode 100644 index 00000000..27e082e1 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/update-application.rst @@ -0,0 +1,24 @@ +**To change an application's description** + +The following command updates the description of an application named ``my-app``:: + + aws elasticbeanstalk update-application --application-name my-app --description "my Elastic Beanstalk application" + +Output:: + + { + "Application": { + "ApplicationName": "my-app", + "Description": "my Elastic Beanstalk application", + "Versions": [ + "2fba-stage-150819_234450", + "bf07-stage-150820_214945", + "93f8", + "fd7c-stage-150820_000431", + "22a0-stage-150819_185942" + ], + "DateCreated": "2015-08-13T19:15:50.449Z", + "ConfigurationTemplates": [], + "DateUpdated": "2015-08-20T22:34:56.195Z" + } + } diff --git a/aws/dist/awscli/examples/elasticbeanstalk/update-configuration-template.rst b/aws/dist/awscli/examples/elasticbeanstalk/update-configuration-template.rst new file mode 100644 index 00000000..c3ee6f2b --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/update-configuration-template.rst @@ -0,0 +1,19 @@ +**To update a configuration template** + +The following command removes the configured CloudWatch custom health metrics configuration ``ConfigDocument`` from a saved configuration template named ``my-template``:: + + aws elasticbeanstalk update-configuration-template --template-name my-template --application-name my-app --options-to-remove Namespace=aws:elasticbeanstalk:healthreporting:system,OptionName=ConfigDocument + +Output:: + + { + "ApplicationName": "my-app", + "TemplateName": "my-template", + "DateCreated": "2015-08-20T22:39:31Z", + "DateUpdated": "2015-08-20T22:43:11Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + } + +For more information about namespaces and supported options, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/update-environment.rst b/aws/dist/awscli/examples/elasticbeanstalk/update-environment.rst new file mode 100644 index 00000000..78211b7e --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/update-environment.rst @@ -0,0 +1,93 @@ +**To update an environment to a new version** + +The following command updates an environment named "my-env" to version "v2" of the application to which it belongs:: + + aws elasticbeanstalk update-environment --environment-name my-env --version-label v2 + +This command requires that the "my-env" environment already exists and belongs to an application that has a valid application version with the label "v2". + +Output:: + + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "VersionLabel": "v2", + "Status": "Updating", + "EnvironmentId": "e-szqipays4h", + "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", + "SolutionStackName": "64bit Amazon Linux running Tomcat 7", + "CNAME": "my-env.elasticbeanstalk.com", + "Health": "Grey", + "Tier": { + "Version": " ", + "Type": "Standard", + "Name": "WebServer" + }, + "DateUpdated": "2015-02-03T23:12:29.119Z", + "DateCreated": "2015-02-03T23:04:54.453Z" + } + +**To set an environment variable** + +The following command sets the value of the "PARAM1" variable in the "my-env" environment to "ParamValue":: + + aws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:application:environment,OptionName=PARAM1,Value=ParamValue + +The ``option-settings`` parameter takes a namespace in addition to the name and value of the variable. Elastic Beanstalk supports several namespaces for options in addition to environment variables. + +**To configure option settings from a file** + +The following command configures several options in the ``aws:elb:loadbalancer`` namespace from a file:: + + aws elasticbeanstalk update-environment --environment-name my-env --option-settings file://options.json + +``options.json`` is a JSON object defining several settings:: + + [ + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Interval", + "Value": "15" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Timeout", + "Value": "8" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "HealthyThreshold", + "Value": "2" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "UnhealthyThreshold", + "Value": "3" + } + ] + +Output:: + + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "VersionLabel": "7f58-stage-150812_025409", + "Status": "Updating", + "EnvironmentId": "e-wtp2rpqsej", + "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "CNAME": "my-env.elasticbeanstalk.com", + "Health": "Grey", + "AbortableOperationInProgress": true, + "Tier": { + "Version": " ", + "Type": "Standard", + "Name": "WebServer" + }, + "DateUpdated": "2015-08-12T18:15:23.804Z", + "DateCreated": "2015-08-07T20:48:49.599Z" + } + +For more information about namespaces and supported options, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elasticbeanstalk/validate-configuration-settings.rst b/aws/dist/awscli/examples/elasticbeanstalk/validate-configuration-settings.rst new file mode 100644 index 00000000..ef106c19 --- /dev/null +++ b/aws/dist/awscli/examples/elasticbeanstalk/validate-configuration-settings.rst @@ -0,0 +1,39 @@ +**To validate configuration settings** + +The following command validates a CloudWatch custom metrics config document:: + + aws elasticbeanstalk validate-configuration-settings --application-name my-app --environment-name my-env --option-settings file://options.json + +``options.json`` is a JSON document that includes one or more configuration settings to validate:: + + [ + { + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "OptionName": "ConfigDocument", + "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}" + } + ] + +If the options that you specify are valid for the specified environment, Elastic Beanstalk returns an empty Messages array:: + + { + "Messages": [] + } + +If validation fails, the response will include information about the error:: + + { + "Messages": [ + { + "OptionName": "ConfigDocumet", + "Message": "Invalid option specification (Namespace: 'aws:elasticbeanstalk:healthreporting:system', OptionName: 'ConfigDocumet'): Unknown configuration setting.", + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "Severity": "error" + } + ] + } + + +For more information about namespaces and supported options, see `Option Values`_ in the *AWS Elastic Beanstalk Developer Guide*. + +.. _`Option Values`: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html diff --git a/aws/dist/awscli/examples/elastictranscoder/cancel-job.rst b/aws/dist/awscli/examples/elastictranscoder/cancel-job.rst new file mode 100644 index 00000000..4acd71e6 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/cancel-job.rst @@ -0,0 +1,8 @@ +**To cancel a job for ElasticTranscoder** + +This cancels the specified job for ElasticTranscoder. + +Command:: + + aws elastictranscoder cancel-job --id 3333333333333-abcde3 + diff --git a/aws/dist/awscli/examples/elastictranscoder/create-job.rst b/aws/dist/awscli/examples/elastictranscoder/create-job.rst new file mode 100644 index 00000000..6b10d1a2 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/create-job.rst @@ -0,0 +1,94 @@ +**To create a job for ElasticTranscoder** + +The following ``create-job`` example creates a job for ElasticTranscoder. :: + + aws elastictranscoder create-job \ + --pipeline-id 1111111111111-abcde1 \ + --inputs file://inputs.json \ + --outputs file://outputs.json \ + --output-key-prefix "recipes/" \ + --user-metadata file://user-metadata.json + +Contents of ``inputs.json``:: + + [{ + "Key":"ETS_example_file.mp4", + "FrameRate":"auto", + "Resolution":"auto", + "AspectRatio":"auto", + "Interlaced":"auto", + "Container":"mp4" + }] + +Contents of outputs.json:: + + [ + { + "Key":"webm/ETS_example_file-kindlefirehd.webm", + "Rotate":"0", + "PresetId":"1351620000001-100250" + } + ] + +Contents of ``user-metadata.json``:: + + { + "Food type":"Italian", + "Cook book":"recipe notebook" + } + +Output:: + + { + "Job": { + "Status": "Submitted", + "Inputs": [ + { + "Container": "mp4", + "FrameRate": "auto", + "Key": "ETS_example_file.mp4", + "AspectRatio": "auto", + "Resolution": "auto", + "Interlaced": "auto" + } + ], + "Playlists": [], + "Outputs": [ + { + "Status": "Submitted", + "Rotate": "0", + "PresetId": "1351620000001-100250", + "Watermarks": [], + "Key": "webm/ETS_example_file-kindlefirehd.webm", + "Id": "1" + } + ], + "PipelineId": "3333333333333-abcde3", + "OutputKeyPrefix": "recipes/", + "UserMetadata": { + "Cook book": "recipe notebook", + "Food type": "Italian" + }, + "Output": { + "Status": "Submitted", + "Rotate": "0", + "PresetId": "1351620000001-100250", + "Watermarks": [], + "Key": "webm/ETS_example_file-kindlefirehd.webm", + "Id": "1" + }, + "Timing": { + "SubmitTimeMillis": 1533838012298 + }, + "Input": { + "Container": "mp4", + "FrameRate": "auto", + "Key": "ETS_example_file.mp4", + "AspectRatio": "auto", + "Resolution": "auto", + "Interlaced": "auto" + }, + "Id": "1533838012294-example", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:job/1533838012294-example" + } + } diff --git a/aws/dist/awscli/examples/elastictranscoder/create-pipeline.rst b/aws/dist/awscli/examples/elastictranscoder/create-pipeline.rst new file mode 100644 index 00000000..166bdd4c --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/create-pipeline.rst @@ -0,0 +1,94 @@ +**To create a pipeline for ElasticTranscoder** + +The following ``create-pipeline`` example creates a pipeline for ElasticTranscoder. :: + + aws elastictranscoder create-pipeline \ + --name Default \ + --input-bucket salesoffice.example.com-source \ + --role arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role \ + --notifications Progressing="",Completed="",Warning="",Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors \ + --content-config file://content-config.json \ + --thumbnail-config file://thumbnail-config.json + +Contents of ``content-config.json``:: + + { + "Bucket":"salesoffice.example.com-public-promos", + "Permissions":[ + { + "GranteeType":"Email", + "Grantee":"marketing-promos@example.com", + "Access":[ + "FullControl" + ] + } + ], + "StorageClass":"Standard" + } + +Contents of ``thumbnail-config.json``:: + + { + "Bucket":"salesoffice.example.com-public-promos-thumbnails", + "Permissions":[ + { + "GranteeType":"Email", + "Grantee":"marketing-promos@example.com", + "Access":[ + "FullControl" + ] + } + ], + "StorageClass":"ReducedRedundancy" + } + +Output:: + + { + "Pipeline": { + "Status": "Active", + "ContentConfig": { + "Bucket": "salesoffice.example.com-public-promos", + "StorageClass": "Standard", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Name": "Default", + "ThumbnailConfig": { + "Bucket": "salesoffice.example.com-public-promos-thumbnails", + "StorageClass": "ReducedRedundancy", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Notifications": { + "Completed": "", + "Warning": "", + "Progressing": "", + "Error": "arn:aws:sns:us-east-1:123456789012:ETS_Errors" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "salesoffice.example.com-source", + "Id": "1533765810590-example", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1533765810590-example" + }, + "Warnings": [ + { + "Message": "The SNS notification topic for Error events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.", + "Code": "6006" + } + ] + } diff --git a/aws/dist/awscli/examples/elastictranscoder/create-preset.rst b/aws/dist/awscli/examples/elastictranscoder/create-preset.rst new file mode 100644 index 00000000..bbf482c4 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/create-preset.rst @@ -0,0 +1,141 @@ +**To create a preset for ElasticTranscoder** + +The following ``create-preset`` example creates a preset for ElasticTranscoder. :: + + aws elastictranscoder create-preset \ + --name DefaultPreset \ + --description "Use for published videos" \ + --container mp4 \ + --video file://video.json \ + --audio file://audio.json \ + --thumbnails file://thumbnails.json + +Contents of ``video.json``:: + + { + "Codec":"H.264", + "CodecOptions":{ + "Profile":"main", + "Level":"2.2", + "MaxReferenceFrames":"3", + "MaxBitRate":"", + "BufferSize":"", + "InterlacedMode":"Progressive", + "ColorSpaceConversionMode":"None" + }, + "KeyframesMaxDist":"240", + "FixedGOP":"false", + "BitRate":"1600", + "FrameRate":"auto", + "MaxFrameRate":"30", + "MaxWidth":"auto", + "MaxHeight":"auto", + "SizingPolicy":"Fit", + "PaddingPolicy":"Pad", + "DisplayAspectRatio":"auto", + "Watermarks":[ + { + "Id":"company logo", + "MaxWidth":"20%", + "MaxHeight":"20%", + "SizingPolicy":"ShrinkToFit", + "HorizontalAlign":"Right", + "HorizontalOffset":"10px", + "VerticalAlign":"Bottom", + "VerticalOffset":"10px", + "Opacity":"55.5", + "Target":"Content" + } + ] + } + +Contents of ``audio.json``:: + + { + "Codec":"AAC", + "CodecOptions":{ + "Profile":"AAC-LC" + }, + "SampleRate":"44100", + "BitRate":"96", + "Channels":"2" + } + +Contents of ``thumbnails.json``:: + + { + "Format":"png", + "Interval":"120", + "MaxWidth":"auto", + "MaxHeight":"auto", + "SizingPolicy":"Fit", + "PaddingPolicy":"Pad" + } + + +Output:: + + { + "Preset": { + "Thumbnails": { + "SizingPolicy": "Fit", + "MaxWidth": "auto", + "Format": "png", + "PaddingPolicy": "Pad", + "Interval": "120", + "MaxHeight": "auto" + }, + "Container": "mp4", + "Description": "Use for published videos", + "Video": { + "SizingPolicy": "Fit", + "MaxWidth": "auto", + "PaddingPolicy": "Pad", + "MaxFrameRate": "30", + "FrameRate": "auto", + "MaxHeight": "auto", + "KeyframesMaxDist": "240", + "FixedGOP": "false", + "Codec": "H.264", + "Watermarks": [ + { + "SizingPolicy": "ShrinkToFit", + "VerticalOffset": "10px", + "VerticalAlign": "Bottom", + "Target": "Content", + "MaxWidth": "20%", + "MaxHeight": "20%", + "HorizontalAlign": "Right", + "HorizontalOffset": "10px", + "Opacity": "55.5", + "Id": "company logo" + } + ], + "CodecOptions": { + "Profile": "main", + "MaxBitRate": "32", + "InterlacedMode": "Progressive", + "Level": "2.2", + "ColorSpaceConversionMode": "None", + "MaxReferenceFrames": "3", + "BufferSize": "5" + }, + "BitRate": "1600", + "DisplayAspectRatio": "auto" + }, + "Audio": { + "Channels": "2", + "CodecOptions": { + "Profile": "AAC-LC" + }, + "SampleRate": "44100", + "Codec": "AAC", + "BitRate": "96" + }, + "Type": "Custom", + "Id": "1533765290724-example" + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/1533765290724-example", + "Name": "DefaultPreset" + }, + "Warning": "" + } diff --git a/aws/dist/awscli/examples/elastictranscoder/delete-pipeline.rst b/aws/dist/awscli/examples/elastictranscoder/delete-pipeline.rst new file mode 100644 index 00000000..2ccfc95c --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/delete-pipeline.rst @@ -0,0 +1,13 @@ +**To delete the specified ElasticTranscoder pipeline** + +This deletes the specified ElasticTranscoder pipeline. + +Command:: + + aws elastictranscoder delete-pipeline --id 1111111111111-abcde1 + +Output:: + + { + "Success":"true" + } diff --git a/aws/dist/awscli/examples/elastictranscoder/delete-preset.rst b/aws/dist/awscli/examples/elastictranscoder/delete-preset.rst new file mode 100644 index 00000000..e6907a59 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/delete-preset.rst @@ -0,0 +1,8 @@ +**To delete the specified ElasticTranscoder preset** + +This deletes the specified ElasticTranscoder preset. + +Command:: + + aws elastictranscoder delete-preset --id 5555555555555-abcde5 + diff --git a/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-pipeline.rst b/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-pipeline.rst new file mode 100644 index 00000000..7217beff --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-pipeline.rst @@ -0,0 +1,13 @@ +**To retrieve a list of ElasticTranscoder jobs in the specified pipeline** + +This example retrieves a list of ElasticTranscoder jobs in the specified pipeline. + +Command:: + + aws elastictranscoder list-jobs-by-pipeline --pipeline-id 1111111111111-abcde1 + +Output:: + + { + "Jobs": [] + } diff --git a/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-status.rst b/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-status.rst new file mode 100644 index 00000000..84f62d27 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/list-jobs-by-status.rst @@ -0,0 +1,14 @@ +**To retrieve a list of ElasticTranscoder jobs with a status of Complete** + +This example retrieves a list of ElasticTranscoder jobs with a status of Complete. + +Command:: + + aws elastictranscoder list-jobs-by-status --status Complete + +Output:: + + { + "Jobs": [] + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/list-pipelines.rst b/aws/dist/awscli/examples/elastictranscoder/list-pipelines.rst new file mode 100644 index 00000000..f318f285 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/list-pipelines.rst @@ -0,0 +1,84 @@ +**To retrieve a list of ElasticTranscoder pipelines** + +This example retrieves a list of ElasticTranscoder pipelines. + +Command:: + + aws elastictranscoder list-pipelines + +Output:: + + { + "Pipelines": [ + { + "Status": "Active", + "ContentConfig": { + "Bucket": "ets-example", + "Permissions": [] + }, + "Name": "example-pipeline", + "ThumbnailConfig": { + "Bucket": "ets-example", + "Permissions": [] + }, + "Notifications": { + "Completed": "arn:aws:sns:us-west-2:123456789012:ets_example", + "Warning": "", + "Progressing": "", + "Error": "" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "OutputBucket": "ets-example", + "Id": "3333333333333-abcde3", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3" + }, + { + "Status": "Paused", + "ContentConfig": { + "Bucket": "ets-example", + "Permissions": [] + }, + "Name": "example-php-test", + "ThumbnailConfig": { + "Bucket": "ets-example", + "Permissions": [] + }, + "Notifications": { + "Completed": "", + "Warning": "", + "Progressing": "", + "Error": "" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "OutputBucket": "ets-example", + "Id": "3333333333333-abcde2", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde2" + }, + { + "Status": "Active", + "ContentConfig": { + "Bucket": "ets-west-output", + "Permissions": [] + }, + "Name": "pipeline-west", + "ThumbnailConfig": { + "Bucket": "ets-west-output", + "Permissions": [] + }, + "Notifications": { + "Completed": "arn:aws:sns:us-west-2:123456789012:ets-notifications", + "Warning": "", + "Progressing": "", + "Error": "" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-west-input", + "OutputBucket": "ets-west-output", + "Id": "3333333333333-abcde1", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde1" + } + ] + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/list-presets.rst b/aws/dist/awscli/examples/elastictranscoder/list-presets.rst new file mode 100644 index 00000000..239cf9ab --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/list-presets.rst @@ -0,0 +1,95 @@ +**To retrieve a list of ElasticTranscoder presets** + +This example retrieves a list of ElasticTranscoder presets. + +Command:: + + aws elastictranscoder list-presets --max-items 2 + +Output:: + + { + "Presets": [ + { + "Container": "mp4", + "Name": "KindleFireHD-preset", + "Video": { + "Resolution": "1280x720", + "FrameRate": "30", + "KeyframesMaxDist": "90", + "FixedGOP": "false", + "Codec": "H.264", + "Watermarks": [], + "CodecOptions": { + "Profile": "main", + "MaxReferenceFrames": "3", + "ColorSpaceConversionMode": "None", + "InterlacedMode": "Progressive", + "Level": "4" + }, + "AspectRatio": "16:9", + "BitRate": "2200" + }, + "Audio": { + "Channels": "2", + "CodecOptions": { + "Profile": "AAC-LC" + }, + "SampleRate": "48000", + "Codec": "AAC", + "BitRate": "160" + }, + "Type": "Custom", + "Id": "3333333333333-abcde2", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/3333333333333-abcde2", + "Thumbnails": { + "AspectRatio": "16:9", + "Interval": "60", + "Resolution": "192x108", + "Format": "png" + } + }, + { + "Thumbnails": { + "AspectRatio": "16:9", + "Interval": "60", + "Resolution": "192x108", + "Format": "png" + }, + "Container": "mp4", + "Description": "Custom preset for transcoding jobs", + "Video": { + "Resolution": "1280x720", + "FrameRate": "30", + "KeyframesMaxDist": "90", + "FixedGOP": "false", + "Codec": "H.264", + "Watermarks": [], + "CodecOptions": { + "Profile": "main", + "MaxReferenceFrames": "3", + "ColorSpaceConversionMode": "None", + "InterlacedMode": "Progressive", + "Level": "3.1" + }, + "AspectRatio": "16:9", + "BitRate": "2200" + }, + "Audio": { + "Channels": "2", + "CodecOptions": { + "Profile": "AAC-LC" + }, + "SampleRate": "44100", + "Codec": "AAC", + "BitRate": "160" + }, + "Type": "Custom", + "Id": "3333333333333-abcde3", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/3333333333333-abcde3", + "Name": "Roman's Preset" + } + ], + "NextToken": "eyJQYWdlVG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/read-job.rst b/aws/dist/awscli/examples/elastictranscoder/read-job.rst new file mode 100644 index 00000000..dd2bfe1b --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/read-job.rst @@ -0,0 +1,65 @@ +**To retrieve an ElasticTranscoder job** + +This example retrieves the specified ElasticTranscoder job. + +Command:: + + aws elastictranscoder read-job --id 1533838012294-example + +Output:: + + { + "Job": { + "Status": "Progressing", + "Inputs": [ + { + "Container": "mp4", + "FrameRate": "auto", + "Key": "ETS_example_file.mp4", + "AspectRatio": "auto", + "Resolution": "auto", + "Interlaced": "auto" + } + ], + "Playlists": [], + "Outputs": [ + { + "Status": "Progressing", + "Rotate": "0", + "PresetId": "1351620000001-100250", + "Watermarks": [], + "Key": "webm/ETS_example_file-kindlefirehd.webm", + "Id": "1" + } + ], + "PipelineId": "3333333333333-abcde3", + "OutputKeyPrefix": "recipes/", + "UserMetadata": { + "Cook book": "recipe notebook", + "Food type": "Italian" + }, + "Output": { + "Status": "Progressing", + "Rotate": "0", + "PresetId": "1351620000001-100250", + "Watermarks": [], + "Key": "webm/ETS_example_file-kindlefirehd.webm", + "Id": "1" + }, + "Timing": { + "SubmitTimeMillis": 1533838012298, + "StartTimeMillis": 1533838013786 + }, + "Input": { + "Container": "mp4", + "FrameRate": "auto", + "Key": "ETS_example_file.mp4", + "AspectRatio": "auto", + "Resolution": "auto", + "Interlaced": "auto" + }, + "Id": "1533838012294-example", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:job/1533838012294-example" + } + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/read-pipeline.rst b/aws/dist/awscli/examples/elastictranscoder/read-pipeline.rst new file mode 100644 index 00000000..47118018 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/read-pipeline.rst @@ -0,0 +1,59 @@ +**To retrieve an ElasticTranscoder pipeline** + +This example retrieves the specified ElasticTranscoder pipeline. + +Command:: + + aws elastictranscoder read-pipeline --id 3333333333333-abcde3 + +Output:: + + { + "Pipeline": { + "Status": "Active", + "ContentConfig": { + "Bucket": "ets-example", + "StorageClass": "Standard", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Name": "Default", + "ThumbnailConfig": { + "Bucket": "ets-example", + "StorageClass": "ReducedRedundancy", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Notifications": { + "Completed": "", + "Warning": "", + "Progressing": "", + "Error": "arn:aws:sns:us-east-1:123456789012:ETS_Errors" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "Id": "3333333333333-abcde3", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3" + }, + "Warnings": [ + { + "Message": "The SNS notification topic for Error events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.", + "Code": "6006" + } + ] + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/read-preset.rst b/aws/dist/awscli/examples/elastictranscoder/read-preset.rst new file mode 100644 index 00000000..8ab201c4 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/read-preset.rst @@ -0,0 +1,100 @@ +**To retrieve an ElasticTranscoder preset** + +This example retrieves the specified ElasticTranscoder preset. + +Command:: + + aws elastictranscoder read-preset --id 1351620000001-500020 + +Output:: + + { + "Preset": { + "Thumbnails": { + "SizingPolicy": "ShrinkToFit", + "MaxWidth": "192", + "Format": "png", + "PaddingPolicy": "NoPad", + "Interval": "300", + "MaxHeight": "108" + }, + "Container": "fmp4", + "Description": "System preset: MPEG-Dash Video - 4.8M", + "Video": { + "SizingPolicy": "ShrinkToFit", + "MaxWidth": "1280", + "PaddingPolicy": "NoPad", + "FrameRate": "30", + "MaxHeight": "720", + "KeyframesMaxDist": "60", + "FixedGOP": "true", + "Codec": "H.264", + "Watermarks": [ + { + "SizingPolicy": "ShrinkToFit", + "VerticalOffset": "10%", + "VerticalAlign": "Top", + "Target": "Content", + "MaxWidth": "10%", + "MaxHeight": "10%", + "HorizontalAlign": "Left", + "HorizontalOffset": "10%", + "Opacity": "100", + "Id": "TopLeft" + }, + { + "SizingPolicy": "ShrinkToFit", + "VerticalOffset": "10%", + "VerticalAlign": "Top", + "Target": "Content", + "MaxWidth": "10%", + "MaxHeight": "10%", + "HorizontalAlign": "Right", + "HorizontalOffset": "10%", + "Opacity": "100", + "Id": "TopRight" + }, + { + "SizingPolicy": "ShrinkToFit", + "VerticalOffset": "10%", + "VerticalAlign": "Bottom", + "Target": "Content", + "MaxWidth": "10%", + "MaxHeight": "10%", + "HorizontalAlign": "Left", + "HorizontalOffset": "10%", + "Opacity": "100", + "Id": "BottomLeft" + }, + { + "SizingPolicy": "ShrinkToFit", + "VerticalOffset": "10%", + "VerticalAlign": "Bottom", + "Target": "Content", + "MaxWidth": "10%", + "MaxHeight": "10%", + "HorizontalAlign": "Right", + "HorizontalOffset": "10%", + "Opacity": "100", + "Id": "BottomRight" + } + ], + "CodecOptions": { + "Profile": "main", + "MaxBitRate": "4800", + "InterlacedMode": "Progressive", + "Level": "3.1", + "ColorSpaceConversionMode": "None", + "MaxReferenceFrames": "3", + "BufferSize": "9600" + }, + "BitRate": "4800", + "DisplayAspectRatio": "auto" + }, + "Type": "System", + "Id": "1351620000001-500020", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:preset/1351620000001-500020", + "Name": "System preset: MPEG-Dash Video - 4.8M" + } + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/update-pipeline-notifications.rst b/aws/dist/awscli/examples/elastictranscoder/update-pipeline-notifications.rst new file mode 100644 index 00000000..faf4a006 --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/update-pipeline-notifications.rst @@ -0,0 +1,52 @@ +**To update the notifications of an ElasticTranscoder pipeline** + +This example updates the notifications of the specified ElasticTranscoder pipeline. + +Command:: + + aws elastictranscoder update-pipeline-notifications --id 1111111111111-abcde1 --notifications Progressing=arn:aws:sns:us-west-2:0123456789012:my-topic,Completed=arn:aws:sns:us-west-2:0123456789012:my-topic,Warning=arn:aws:sns:us-west-2:0123456789012:my-topic,Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors + +Output:: + + { + "Pipeline": { + "Status": "Active", + "ContentConfig": { + "Bucket": "ets-example", + "StorageClass": "Standard", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Name": "Default", + "ThumbnailConfig": { + "Bucket": "ets-example", + "StorageClass": "ReducedRedundancy", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Notifications": { + "Completed": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "Warning": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "Progressing": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "Error": "arn:aws:sns:us-east-1:111222333444:ETS_Errors" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "Id": "1111111111111-abcde1", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1111111111111-abcde1" + } + } diff --git a/aws/dist/awscli/examples/elastictranscoder/update-pipeline-status.rst b/aws/dist/awscli/examples/elastictranscoder/update-pipeline-status.rst new file mode 100644 index 00000000..b4587e6c --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/update-pipeline-status.rst @@ -0,0 +1,53 @@ +**To update the status of an ElasticTranscoder pipeline** + +This example updates the status of the specified ElasticTranscoder pipeline. + +Command:: + + aws elastictranscoder update-pipeline-status --id 1111111111111-abcde1 --status Paused + +Output:: + + { + "Pipeline": { + "Status": "Paused", + "ContentConfig": { + "Bucket": "ets-example", + "StorageClass": "Standard", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Name": "Default", + "ThumbnailConfig": { + "Bucket": "ets-example", + "StorageClass": "ReducedRedundancy", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Notifications": { + "Completed": "", + "Warning": "", + "Progressing": "", + "Error": "arn:aws:sns:us-east-1:803981987763:ETS_Errors" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "Id": "1111111111111-abcde1", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/1111111111111-abcde1" + } + } + diff --git a/aws/dist/awscli/examples/elastictranscoder/update-pipeline.rst b/aws/dist/awscli/examples/elastictranscoder/update-pipeline.rst new file mode 100644 index 00000000..c5b1e84f --- /dev/null +++ b/aws/dist/awscli/examples/elastictranscoder/update-pipeline.rst @@ -0,0 +1,95 @@ +**To update an ElasticTranscoder pipeline** + +The following ``update-pipeline`` example updates the specified ElasticTranscoder pipeline. :: + + aws elastictranscoder update-pipeline \ + --id 1111111111111-abcde1 + --name DefaultExample \ + --input-bucket salesoffice.example.com-source \ + --role arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role \ + --notifications Progressing="",Completed="",Warning="",Error=arn:aws:sns:us-east-1:111222333444:ETS_Errors \ + --content-config file://content-config.json \ + --thumbnail-config file://thumbnail-config.json + +Contents of ``content-config.json``:: + + { + "Bucket":"salesoffice.example.com-public-promos", + "Permissions":[ + { + "GranteeType":"Email", + "Grantee":"marketing-promos@example.com", + "Access":[ + "FullControl" + ] + } + ], + "StorageClass":"Standard" + } + +Contents of ``thumbnail-config.json``:: + + { + "Bucket":"salesoffice.example.com-public-promos-thumbnails", + "Permissions":[ + { + "GranteeType":"Email", + "Grantee":"marketing-promos@example.com", + "Access":[ + "FullControl" + ] + } + ], + "StorageClass":"ReducedRedundancy" + } + +Output:: + + { + "Pipeline": { + "Status": "Active", + "ContentConfig": { + "Bucket": "ets-example", + "StorageClass": "Standard", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Name": "DefaultExample", + "ThumbnailConfig": { + "Bucket": "ets-example", + "StorageClass": "ReducedRedundancy", + "Permissions": [ + { + "Access": [ + "FullControl" + ], + "Grantee": "marketing-promos@example.com", + "GranteeType": "Email" + } + ] + }, + "Notifications": { + "Completed": "", + "Warning": "", + "Progressing": "", + "Error": "arn:aws:sns:us-east-1:111222333444:ETS_Errors" + }, + "Role": "arn:aws:iam::123456789012:role/Elastic_Transcoder_Default_Role", + "InputBucket": "ets-example", + "Id": "3333333333333-abcde3", + "Arn": "arn:aws:elastictranscoder:us-west-2:123456789012:pipeline/3333333333333-abcde3" + }, + "Warnings": [ + { + "Message": "The SNS notification topic for Error events and the pipeline are in different regions, which increases processing time for jobs in the pipeline and can incur additional charges. To decrease processing time and prevent cross-regional charges, use the same region for the SNS notification topic and the pipeline.", + "Code": "6006" + } + ] + } diff --git a/aws/dist/awscli/examples/elb/add-tags.rst b/aws/dist/awscli/examples/elb/add-tags.rst new file mode 100644 index 00000000..656a88b9 --- /dev/null +++ b/aws/dist/awscli/examples/elb/add-tags.rst @@ -0,0 +1,8 @@ +**To add a tag to a load balancer** + +This example adds tags to the specified load balancer. + +Command:: + + aws elb add-tags --load-balancer-name my-load-balancer --tags "Key=project,Value=lima" "Key=department,Value=digital-media" + diff --git a/aws/dist/awscli/examples/elb/apply-security-groups-to-load-balancer.rst b/aws/dist/awscli/examples/elb/apply-security-groups-to-load-balancer.rst new file mode 100644 index 00000000..8a3782b5 --- /dev/null +++ b/aws/dist/awscli/examples/elb/apply-security-groups-to-load-balancer.rst @@ -0,0 +1,16 @@ +**To associate a security group with a load balancer in a VPC** + +This example associates a security group with the specified load balancer in a VPC. + +Command:: + + aws elb apply-security-groups-to-load-balancer --load-balancer-name my-load-balancer --security-groups sg-fc448899 + +Output:: + + { + "SecurityGroups": [ + "sg-fc448899" + ] + } + diff --git a/aws/dist/awscli/examples/elb/attach-load-balancer-to-subnets.rst b/aws/dist/awscli/examples/elb/attach-load-balancer-to-subnets.rst new file mode 100644 index 00000000..9b5a399d --- /dev/null +++ b/aws/dist/awscli/examples/elb/attach-load-balancer-to-subnets.rst @@ -0,0 +1,17 @@ +**To attach subnets to a load balancer** + +This example adds the specified subnet to the set of configured subnets for the specified load balancer. + +Command:: + + aws elb attach-load-balancer-to-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 + +Output:: + + { + "Subnets": [ + "subnet-15aaab61", + "subnet-0ecac448" + ] + } + diff --git a/aws/dist/awscli/examples/elb/configure-health-check.rst b/aws/dist/awscli/examples/elb/configure-health-check.rst new file mode 100644 index 00000000..82784d6e --- /dev/null +++ b/aws/dist/awscli/examples/elb/configure-health-check.rst @@ -0,0 +1,21 @@ +**To specify the health check settings for your backend EC2 instances** + +This example specifies the health check settings used to evaluate the health of your backend EC2 instances. + + +Command:: + + aws elb configure-health-check --load-balancer-name my-load-balancer --health-check Target=HTTP:80/png,Interval=30,UnhealthyThreshold=2,HealthyThreshold=2,Timeout=3 + +Output:: + + { + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + } + } + diff --git a/aws/dist/awscli/examples/elb/create-app-cookie-stickiness-policy.rst b/aws/dist/awscli/examples/elb/create-app-cookie-stickiness-policy.rst new file mode 100644 index 00000000..c44b4cc4 --- /dev/null +++ b/aws/dist/awscli/examples/elb/create-app-cookie-stickiness-policy.rst @@ -0,0 +1,7 @@ +**To generate a stickiness policy for your HTTPS load balancer** + +This example generates a stickiness policy that follows the sticky session lifetimes of the application-generated cookie. + +Command:: + + aws elb create-app-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-app-cookie-policy --cookie-name my-app-cookie diff --git a/aws/dist/awscli/examples/elb/create-lb-cookie-stickiness-policy.rst b/aws/dist/awscli/examples/elb/create-lb-cookie-stickiness-policy.rst new file mode 100644 index 00000000..03ba7756 --- /dev/null +++ b/aws/dist/awscli/examples/elb/create-lb-cookie-stickiness-policy.rst @@ -0,0 +1,9 @@ +**To generate a duration-based stickiness policy for your HTTPS load balancer** + +This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period. + + +Command:: + + aws elb create-lb-cookie-stickiness-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy --cookie-expiration-period 60 + diff --git a/aws/dist/awscli/examples/elb/create-load-balancer-listeners.rst b/aws/dist/awscli/examples/elb/create-load-balancer-listeners.rst new file mode 100644 index 00000000..5ebb6510 --- /dev/null +++ b/aws/dist/awscli/examples/elb/create-load-balancer-listeners.rst @@ -0,0 +1,16 @@ +**To create HTTP listeners for a load balancer** + +This example creates a listener for your load balancer at port 80 using the HTTP protocol. + +Command:: + + aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" + +**To create HTTPS listeners for a load balancer** + +This example creates a listener for your load balancer at port 443 using the HTTPS protocol. + +Command:: + + aws elb create-load-balancer-listeners --load-balancer-name my-load-balancer --listeners "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80" + diff --git a/aws/dist/awscli/examples/elb/create-load-balancer-policy.rst b/aws/dist/awscli/examples/elb/create-load-balancer-policy.rst new file mode 100644 index 00000000..05112d73 --- /dev/null +++ b/aws/dist/awscli/examples/elb/create-load-balancer-policy.rst @@ -0,0 +1,44 @@ +**To create a policy that enables Proxy Protocol on a load balancer** + +This example creates a policy that enables Proxy Protocol on the specified load balancer. + +Command:: + + aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-ProxyProtocol-policy --policy-type-name ProxyProtocolPolicyType --policy-attributes AttributeName=ProxyProtocol,AttributeValue=true + + +**To create an SSL negotiation policy using the recommended security policy** + +This example creates an SSL negotiation policy for the specified HTTPS load balancer using the recommended security policy. + +Command:: + + aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-SSLNegotiation-policy --policy-type-name SSLNegotiationPolicyType --policy-attributes AttributeName=Reference-Security-Policy,AttributeValue=ELBSecurityPolicy-2015-03 + + +**To create an SSL negotiation policy using a custom security policy** + +This example creates an SSL negotiation policy for your HTTPS load balancer using a custom security policy by enabling the protocols and the ciphers. + +Command:: + + aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-SSLNegotiation-policy --policy-type-name SSLNegotiationPolicyType --policy-attributes AttributeName=Protocol-SSLv3,AttributeValue=true AttributeName=Protocol-TLSv1.1,AttributeValue=true AttributeName=DHE-RSA-AES256-SHA256,AttributeValue=true AttributeName=Server-Defined-Cipher-Order,AttributeValue=true + + +**To create a public key policy** + +This example creates a public key policy. + +Command:: + + aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-PublicKey-policy --policy-type-name PublicKeyPolicyType --policy-attributes AttributeName=PublicKey,AttributeValue=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE + + +**To create a backend server authentication policy** + +This example creates a backend server authentication policy that enables authentication on your backend instance using a public key policy. + +Command:: + + aws elb create-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-authentication-policy --policy-type-name BackendServerAuthenticationPolicyType --policy-attributes AttributeName=PublicKeyPolicyName,AttributeValue=my-PublicKey-policy + diff --git a/aws/dist/awscli/examples/elb/create-load-balancer.rst b/aws/dist/awscli/examples/elb/create-load-balancer.rst new file mode 100644 index 00000000..581da9d1 --- /dev/null +++ b/aws/dist/awscli/examples/elb/create-load-balancer.rst @@ -0,0 +1,67 @@ +**To create an HTTP load balancer** + +This example creates a load balancer with an HTTP listener in a VPC. + +Command:: + + aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --subnets subnet-15aaab61 --security-groups sg-a61988c3 + +Output:: + + { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + } + + +This example creates a load balancer with an HTTP listener in EC2-Classic. + +Command:: + + aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --availability-zones us-west-2a us-west-2b + +Output:: + + { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + } + +**To create an HTTPS load balancer** + +This example creates a load balancer with an HTTPS listener in a VPC. + +Command:: + + aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80,SSLCertificateId=arn:aws:iam::123456789012:server-certificate/my-server-cert" --subnets subnet-15aaab61 --security-groups sg-a61988c3 + +Output:: + + { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + } + +This example creates a load balancer with an HTTPS listener in EC2-Classic. + +Command:: + + aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" "Protocol=HTTPS,LoadBalancerPort=443,InstanceProtocol=HTTP,InstancePort=80,SSLCertificateId=arn:aws:iam::123456789012:server-certificate/my-server-cert" --availability-zones us-west-2a us-west-2b + +Output:: + + { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + } + +**To create an internal load balancer** + +This example creates an internal load balancer with an HTTP listener in a VPC. + +Command:: + + aws elb create-load-balancer --load-balancer-name my-load-balancer --listeners "Protocol=HTTP,LoadBalancerPort=80,InstanceProtocol=HTTP,InstancePort=80" --scheme internal --subnets subnet-a85db0df --security-groups sg-a61988c3 + +Output:: + + { + "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + } + diff --git a/aws/dist/awscli/examples/elb/delete-load-balancer-listeners.rst b/aws/dist/awscli/examples/elb/delete-load-balancer-listeners.rst new file mode 100644 index 00000000..f0cb3d9e --- /dev/null +++ b/aws/dist/awscli/examples/elb/delete-load-balancer-listeners.rst @@ -0,0 +1,7 @@ +**To delete a listener from your load balancer** + +This example deletes the listener for the specified port from the specified load balancer. + +Command:: + + aws elb delete-load-balancer-listeners --load-balancer-name my-load-balancer --load-balancer-ports 80 diff --git a/aws/dist/awscli/examples/elb/delete-load-balancer-policy.rst b/aws/dist/awscli/examples/elb/delete-load-balancer-policy.rst new file mode 100644 index 00000000..13b9cfab --- /dev/null +++ b/aws/dist/awscli/examples/elb/delete-load-balancer-policy.rst @@ -0,0 +1,8 @@ +**To delete a policy from your load balancer** + +This example deletes the specified policy from the specified load balancer. The policy must not be enabled on any listener. + +Command:: + + aws elb delete-load-balancer-policy --load-balancer-name my-load-balancer --policy-name my-duration-cookie-policy + diff --git a/aws/dist/awscli/examples/elb/delete-load-balancer.rst b/aws/dist/awscli/examples/elb/delete-load-balancer.rst new file mode 100644 index 00000000..4bedf54b --- /dev/null +++ b/aws/dist/awscli/examples/elb/delete-load-balancer.rst @@ -0,0 +1,7 @@ +**To delete a load balancer** + +This example deletes the specified load balancer. + +Command:: + + aws elb delete-load-balancer --load-balancer-name my-load-balancer diff --git a/aws/dist/awscli/examples/elb/deregister-instances-from-load-balancer.rst b/aws/dist/awscli/examples/elb/deregister-instances-from-load-balancer.rst new file mode 100644 index 00000000..9aae4413 --- /dev/null +++ b/aws/dist/awscli/examples/elb/deregister-instances-from-load-balancer.rst @@ -0,0 +1,22 @@ +**To deregister instances from a load balancer** + +This example deregisters the specified instance from the specified load balancer. + +Command:: + + aws elb deregister-instances-from-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 + + +Output:: + + { + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + } + diff --git a/aws/dist/awscli/examples/elb/describe-account-limits.rst b/aws/dist/awscli/examples/elb/describe-account-limits.rst new file mode 100644 index 00000000..4c980e13 --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-account-limits.rst @@ -0,0 +1,24 @@ +**To describe your Classic Load Balancer limits** + +The following ``describe-account-limits`` example displays details about the Classic Load Balancer limits for your AWS account. :: + + aws elb describe-account-limits + +Output:: + + { + "Limits": [ + { + "Name": "classic-load-balancers", + "Max": "20" + }, + { + "Name": "classic-listeners", + "Max": "100" + }, + { + "Name": "classic-registered-instances", + "Max": "1000" + } + ] + } diff --git a/aws/dist/awscli/examples/elb/describe-instance-health.rst b/aws/dist/awscli/examples/elb/describe-instance-health.rst new file mode 100644 index 00000000..5cac4b6f --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-instance-health.rst @@ -0,0 +1,64 @@ +**To describe the health of the instances for a load balancer** + +This example describes the health of the instances for the specified load balancer. + +Command:: + + aws elb describe-instance-health --load-balancer-name my-load-balancer + +Output:: + + { + "InstanceStates": [ + { + "InstanceId": "i-207d9717", + "ReasonCode": "N/A", + "State": "InService", + "Description": "N/A" + }, + { + "InstanceId": "i-afefb49b", + "ReasonCode": "N/A", + "State": "InService", + "Description": "N/A" + } + ] + } + +**To describe the health of an instance for a load balancer** + +This example describes the health of the specified instance for the specified load balancer. + +Command:: + + aws elb describe-instance-health --load-balancer-name my-load-balancer --instances i-7299c809 + +The following is an example response for an instance that is registering. + +Output:: + + { + "InstanceStates": [ + { + "InstanceId": "i-7299c809", + "ReasonCode": "ELB", + "State": "OutOfService", + "Description": "Instance registration is still in progress." + } + ] + } + +The following is an example response for an unhealthy instance. + +Output:: + + { + "InstanceStates": [ + { + "InstanceId": "i-7299c809", + "ReasonCode": "Instance", + "State": "OutOfService", + "Description": "Instance has failed at least the UnhealthyThreshold number of health checks consecutively." + } + ] + } diff --git a/aws/dist/awscli/examples/elb/describe-load-balancer-attributes.rst b/aws/dist/awscli/examples/elb/describe-load-balancer-attributes.rst new file mode 100644 index 00000000..93f7bbb5 --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-load-balancer-attributes.rst @@ -0,0 +1,28 @@ +**To describe the attributes of a load balancer** + +This example describes the attributes of the specified load balancer. + +Command:: + + aws elb describe-load-balancer-attributes --load-balancer-name my-load-balancer + +Output:: + + { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": false, + "Timeout": 300 + }, + "CrossZoneLoadBalancing": { + "Enabled": true + }, + "ConnectionSettings": { + "IdleTimeout": 30 + }, + "AccessLog": { + "Enabled": false + } + } + } + diff --git a/aws/dist/awscli/examples/elb/describe-load-balancer-policies.rst b/aws/dist/awscli/examples/elb/describe-load-balancer-policies.rst new file mode 100644 index 00000000..aa4b0db7 --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-load-balancer-policies.rst @@ -0,0 +1,72 @@ +**To describe all policies associated with a load balancer** + +This example describes all of the policies associated with the specified load balancer. + +Command:: + + aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer + +Output:: + + { + "PolicyDescriptions": [ + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "ProxyProtocol", + "AttributeValue": "true" + } + ], + "PolicyName": "my-ProxyProtocol-policy", + "PolicyTypeName": "ProxyProtocolPolicyType" + }, + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "CookieName", + "AttributeValue": "my-app-cookie" + } + ], + "PolicyName": "my-app-cookie-policy", + "PolicyTypeName": "AppCookieStickinessPolicyType" + }, + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "CookieExpirationPeriod", + "AttributeValue": "60" + } + ], + "PolicyName": "my-duration-cookie-policy", + "PolicyTypeName": "LBCookieStickinessPolicyType" + }, + . + . + . + ] + } + +**To describe a specific policy associated with a load balancer** + +This example describes the specified policy associated with the specified load balancer. + +Command:: + + aws elb describe-load-balancer-policies --load-balancer-name my-load-balancer --policy-name my-authentication-policy + +Output:: + + { + "PolicyDescriptions": [ + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "PublicKeyPolicyName", + "AttributeValue": "my-PublicKey-policy" + } + ], + "PolicyName": "my-authentication-policy", + "PolicyTypeName": "BackendServerAuthenticationPolicyType" + } + ] + } diff --git a/aws/dist/awscli/examples/elb/describe-load-balancer-policy-types.rst b/aws/dist/awscli/examples/elb/describe-load-balancer-policy-types.rst new file mode 100644 index 00000000..93631a69 --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-load-balancer-policy-types.rst @@ -0,0 +1,78 @@ +**To describe the load balancer policy types defined by Elastic Load Balancing** + +This example describes the load balancer policy types that you can use to create policy configurations for your load balancer. + +Command:: + + aws elb describe-load-balancer-policy-types + +Output:: + + { + "PolicyTypeDescriptions": [ + { + "PolicyAttributeTypeDescriptions": [ + { + "Cardinality": "ONE", + "AttributeName": "ProxyProtocol", + "AttributeType": "Boolean" + } + ], + "PolicyTypeName": "ProxyProtocolPolicyType", + "Description": "Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP/SSL listeners only" + }, + { + "PolicyAttributeTypeDescriptions": [ + { + "Cardinality": "ONE", + "AttributeName": "PublicKey", + "AttributeType": "String" + } + ], + "PolicyTypeName": "PublicKeyPolicyType", + "Description": "Policy containing a list of public keys to accept when authenticating the back-end server(s). This policy cannot be applied directly to back-end servers or listeners but must be part of a BackendServerAuthenticationPolicyType." + }, + { + "PolicyAttributeTypeDescriptions": [ + { + "Cardinality": "ONE", + "AttributeName": "CookieName", + "AttributeType": "String" + } + ], + "PolicyTypeName": "AppCookieStickinessPolicyType", + "Description": "Stickiness policy with session lifetimes controlled by the lifetime of the application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners." + }, + { + "PolicyAttributeTypeDescriptions": [ + { + "Cardinality": "ZERO_OR_ONE", + "AttributeName": "CookieExpirationPeriod", + "AttributeType": "Long" + } + ], + "PolicyTypeName": "LBCookieStickinessPolicyType", + "Description": "Stickiness policy with session lifetimes controlled by the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners." + }, + { + "PolicyAttributeTypeDescriptions": [ + . + . + . + ], + "PolicyTypeName": "SSLNegotiationPolicyType", + "Description": "Listener policy that defines the ciphers and protocols that will be accepted by the load balancer. This policy can be associated only with HTTPS/SSL listeners." + }, + { + "PolicyAttributeTypeDescriptions": [ + { + "Cardinality": "ONE_OR_MORE", + "AttributeName": "PublicKeyPolicyName", + "AttributeType": "PolicyName" + } + ], + "PolicyTypeName": "BackendServerAuthenticationPolicyType", + "Description": "Policy that controls authentication to back-end server(s) and contains one or more policies, such as an instance of a PublicKeyPolicyType. This policy can be associated only with back-end servers that are using HTTPS/SSL." + } + ] + } diff --git a/aws/dist/awscli/examples/elb/describe-load-balancers.rst b/aws/dist/awscli/examples/elb/describe-load-balancers.rst new file mode 100644 index 00000000..c10d8dde --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-load-balancers.rst @@ -0,0 +1,109 @@ +**To describe your load balancers** + +This example describes all of your load balancers. + +Command:: + + aws elb describe-load-balancers + +**To describe one of your load balancers** + +This example describes the specified load balancer. + +Command:: + + aws elb describe-load-balancers --load-balancer-name my-load-balancer + +The following example response is for an HTTPS load balancer in a VPC. + +Output:: + + { + "LoadBalancerDescriptions": [ + { + "Subnets": [ + "subnet-15aaab61" + ], + "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE", + "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "ListenerDescriptions": [ + { + "Listener": { + "InstancePort": 80, + "LoadBalancerPort": 80, + "Protocol": "HTTP", + "InstanceProtocol": "HTTP" + }, + "PolicyNames": [] + }, + { + "Listener": { + "InstancePort": 443, + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "InstanceProtocol": "HTTPS" + }, + "PolicyNames": [ + "ELBSecurityPolicy-2015-03" + ] + } + ], + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + }, + "VPCId": "vpc-a01106c2", + "BackendServerDescriptions": [ + { + "InstancePort": 80, + "PolicyNames": [ + "my-ProxyProtocol-policy" + ] + } + ], + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ], + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Policies": { + "LBCookieStickinessPolicies": [ + { + "PolicyName": "my-duration-cookie-policy", + "CookieExpirationPeriod": 60 + } + ], + "AppCookieStickinessPolicies": [], + "OtherPolicies": [ + "my-PublicKey-policy", + "my-authentication-policy", + "my-SSLNegotiation-policy", + "my-ProxyProtocol-policy", + "ELBSecurityPolicy-2015-03" + ] + }, + "LoadBalancerName": "my-load-balancer", + "CreatedTime": "2015-03-19T03:24:02.650Z", + "AvailabilityZones": [ + "us-west-2a" + ], + "Scheme": "internet-facing", + "SourceSecurityGroup": { + "OwnerAlias": "123456789012", + "GroupName": "my-elb-sg" + } + } + ] + } + diff --git a/aws/dist/awscli/examples/elb/describe-tags.rst b/aws/dist/awscli/examples/elb/describe-tags.rst new file mode 100644 index 00000000..a47e7077 --- /dev/null +++ b/aws/dist/awscli/examples/elb/describe-tags.rst @@ -0,0 +1,28 @@ +**To describe the tags assigned to a load balancer** + +This example describes the tags assigned to the specified load balancer. + +Command:: + + aws elb describe-tags --load-balancer-name my-load-balancer + +Output:: + + { + "TagDescriptions": [ + { + "Tags": [ + { + "Value": "lima", + "Key": "project" + }, + { + "Value": "digital-media", + "Key": "department" + } + ], + "LoadBalancerName": "my-load-balancer" + } + ] + } + diff --git a/aws/dist/awscli/examples/elb/detach-load-balancer-from-subnets.rst b/aws/dist/awscli/examples/elb/detach-load-balancer-from-subnets.rst new file mode 100644 index 00000000..1f2bd71c --- /dev/null +++ b/aws/dist/awscli/examples/elb/detach-load-balancer-from-subnets.rst @@ -0,0 +1,16 @@ +**To detach load balancers from subnets** + +This example detaches the specified load balancer from the specified subnet. + +Command:: + + aws elb detach-load-balancer-from-subnets --load-balancer-name my-load-balancer --subnets subnet-0ecac448 + +Output:: + + { + "Subnets": [ + "subnet-15aaab61" + ] + } + diff --git a/aws/dist/awscli/examples/elb/disable-availability-zones-for-load-balancer.rst b/aws/dist/awscli/examples/elb/disable-availability-zones-for-load-balancer.rst new file mode 100644 index 00000000..e3334bc7 --- /dev/null +++ b/aws/dist/awscli/examples/elb/disable-availability-zones-for-load-balancer.rst @@ -0,0 +1,15 @@ +**To disable Availability Zones for a load balancer** + +This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer. + +Command:: + + aws elb disable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2a + +Output:: + + { + "AvailabilityZones": [ + "us-west-2b" + ] + } diff --git a/aws/dist/awscli/examples/elb/enable-availability-zones-for-load-balancer.rst b/aws/dist/awscli/examples/elb/enable-availability-zones-for-load-balancer.rst new file mode 100644 index 00000000..57eaea56 --- /dev/null +++ b/aws/dist/awscli/examples/elb/enable-availability-zones-for-load-balancer.rst @@ -0,0 +1,17 @@ +**To enable Availability Zones for a load balancer** + +This example adds the specified Availability Zone to the specified load balancer. + +Command:: + + aws elb enable-availability-zones-for-load-balancer --load-balancer-name my-load-balancer --availability-zones us-west-2b + +Output:: + + { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ] + } + diff --git a/aws/dist/awscli/examples/elb/modify-load-balancer-attributes.rst b/aws/dist/awscli/examples/elb/modify-load-balancer-attributes.rst new file mode 100644 index 00000000..ba6edde6 --- /dev/null +++ b/aws/dist/awscli/examples/elb/modify-load-balancer-attributes.rst @@ -0,0 +1,36 @@ +**To modify the attributes of a load balancer** + +This example modifies the ``CrossZoneLoadBalancing`` attribute of the specified load balancer. + +Command:: + + aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"CrossZoneLoadBalancing\":{\"Enabled\":true}}" + +Output:: + + { + "LoadBalancerAttributes": { + "CrossZoneLoadBalancing": { + "Enabled": true + } + }, + "LoadBalancerName": "my-load-balancer" + } + +This example modifies the ``ConnectionDraining`` attribute of the specified load balancer. + +Command:: + + aws elb modify-load-balancer-attributes --load-balancer-name my-load-balancer --load-balancer-attributes "{\"ConnectionDraining\":{\"Enabled\":true,\"Timeout\":300}}" + +Output:: + + { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": true, + "Timeout": 300 + } + }, + "LoadBalancerName": "my-load-balancer" + } diff --git a/aws/dist/awscli/examples/elb/register-instances-with-load-balancer.rst b/aws/dist/awscli/examples/elb/register-instances-with-load-balancer.rst new file mode 100644 index 00000000..4baffd6c --- /dev/null +++ b/aws/dist/awscli/examples/elb/register-instances-with-load-balancer.rst @@ -0,0 +1,24 @@ +**To register instances with a load balancer** + +This example registers the specified instance with the specified load balancer. + +Command:: + + aws elb register-instances-with-load-balancer --load-balancer-name my-load-balancer --instances i-d6f6fae3 + +Output:: + + { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + }, + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + } + diff --git a/aws/dist/awscli/examples/elb/remove-tags.rst b/aws/dist/awscli/examples/elb/remove-tags.rst new file mode 100644 index 00000000..2d3201d3 --- /dev/null +++ b/aws/dist/awscli/examples/elb/remove-tags.rst @@ -0,0 +1,7 @@ +**To remove tags from a load balancer** + +This example removes a tag from the specified load balancer. + +Command:: + + aws elb remove-tags --load-balancer-name my-load-balancer --tags project diff --git a/aws/dist/awscli/examples/elb/set-load-balancer-listener-ssl-certificate.rst b/aws/dist/awscli/examples/elb/set-load-balancer-listener-ssl-certificate.rst new file mode 100644 index 00000000..b5749839 --- /dev/null +++ b/aws/dist/awscli/examples/elb/set-load-balancer-listener-ssl-certificate.rst @@ -0,0 +1,8 @@ +**To update the SSL certificate for an HTTPS load balancer** + +This example replaces the existing SSL certificate for the specified HTTPS load balancer. + +Command:: + + aws elb set-load-balancer-listener-ssl-certificate --load-balancer-name my-load-balancer --load-balancer-port 443 --ssl-certificate-id arn:aws:iam::123456789012:server-certificate/new-server-cert + diff --git a/aws/dist/awscli/examples/elb/set-load-balancer-policies-for-backend-server.rst b/aws/dist/awscli/examples/elb/set-load-balancer-policies-for-backend-server.rst new file mode 100644 index 00000000..24d13909 --- /dev/null +++ b/aws/dist/awscli/examples/elb/set-load-balancer-policies-for-backend-server.rst @@ -0,0 +1,20 @@ +**To replace the policies associated with a port for a backend instance** + +This example replaces the policies that are currently associated with the specified port. + +Command:: + + aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names my-ProxyProtocol-policy + + +**To remove all policies that are currently associated with a port on your backend instance** + +This example removes all policies associated with the specified port. + +Command:: + + aws elb set-load-balancer-policies-for-backend-server --load-balancer-name my-load-balancer --instance-port 80 --policy-names [] + + +To confirm that the policies are removed, use the ``describe-load-balancer-policies`` command. + diff --git a/aws/dist/awscli/examples/elb/set-load-balancer-policies-of-listener.rst b/aws/dist/awscli/examples/elb/set-load-balancer-policies-of-listener.rst new file mode 100644 index 00000000..95c6406f --- /dev/null +++ b/aws/dist/awscli/examples/elb/set-load-balancer-policies-of-listener.rst @@ -0,0 +1,19 @@ +**To replace the policies associated with a listener** + +This example replaces the policies that are currently associated with the specified listener. + +Command:: + + aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names my-SSLNegotiation-policy + + +**To remove all policies associated with your listener** + +This example removes all policies that are currently associated with the specified listener. + +Command:: + + aws elb set-load-balancer-policies-of-listener --load-balancer-name my-load-balancer --load-balancer-port 443 --policy-names [] + +To confirm that the policies are removed from the load balancer, use the ``describe-load-balancer-policies`` command. + diff --git a/aws/dist/awscli/examples/elb/wait/any-instance-in-service.rst b/aws/dist/awscli/examples/elb/wait/any-instance-in-service.rst new file mode 100644 index 00000000..9caf570f --- /dev/null +++ b/aws/dist/awscli/examples/elb/wait/any-instance-in-service.rst @@ -0,0 +1,8 @@ +**To pause running until any registered instance is in service** + +The following ``wait any-instance-in-service`` command pauses and continues only after it confirms that the specified load balancer has at least one instance in service. + + aws elb wait any-instance-in-service \ + --load-balancer-name my-loadbalancer + +This command produces no output. diff --git a/aws/dist/awscli/examples/elb/wait/instance-deregistered.rst b/aws/dist/awscli/examples/elb/wait/instance-deregistered.rst new file mode 100644 index 00000000..49b5124d --- /dev/null +++ b/aws/dist/awscli/examples/elb/wait/instance-deregistered.rst @@ -0,0 +1,9 @@ +**To pause running until an instance is deregistered** + +The following ``wait instance-deregistered`` command pauses and continues only after it can confirm that the specified instance is deregistered. + + aws elb wait instance-deregistered \ + --load-balancer-name my-loadbalancer \ + --instances InstanceId=i-1234567890abcdef0 + +This command produces no output. diff --git a/aws/dist/awscli/examples/elb/wait/instance-in-service.rst b/aws/dist/awscli/examples/elb/wait/instance-in-service.rst new file mode 100644 index 00000000..4f13e1ae --- /dev/null +++ b/aws/dist/awscli/examples/elb/wait/instance-in-service.rst @@ -0,0 +1,9 @@ +**To pause running until the specified instance is in service** + +The following ``wait instance-in-service`` command pauses and continues only after it can confirm that the specified instance is in service. :: + + aws elb wait instance-in-service \ + --load-balancer-name my-loadbalancer \ + --instances InstanceId=i-1234567890abcdef0 + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/elbv2/add-listener-certificates.rst b/aws/dist/awscli/examples/elbv2/add-listener-certificates.rst new file mode 100644 index 00000000..0860780f --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/add-listener-certificates.rst @@ -0,0 +1,18 @@ +**To add a certificate to a secure listener** + +This example adds the specified certificate to the specified secure listener. + +Command:: + + aws elbv2 add-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705 + +Output:: + + { + "Certificates": [ + { + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705", + "IsDefault": false + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/add-tags.rst b/aws/dist/awscli/examples/elbv2/add-tags.rst new file mode 100644 index 00000000..857b6f4e --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/add-tags.rst @@ -0,0 +1,7 @@ +**To add tags to a load balancer** + +The following ``add-tags`` example adds the ``project`` and ``department`` tags to the specified load balancer. :: + + aws elbv2 add-tags \ + --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --tags "Key=project,Value=lima" "Key=department,Value=digital-media" diff --git a/aws/dist/awscli/examples/elbv2/create-listener.rst b/aws/dist/awscli/examples/elbv2/create-listener.rst new file mode 100644 index 00000000..53a02b9d --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/create-listener.rst @@ -0,0 +1,52 @@ +**Example 1: To create an HTTP listener** + +The following ``create-listener`` example creates an HTTP listener for the specified Application Load Balancer that forwards requests to the specified target group. :: + + aws elbv2 create-listener \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --protocol HTTP \ + --port 80 \ + --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + + +**Example 2: To create an HTTPS listener** + +The following ``create-listener`` example creates an HTTPS listener for the specified Application Load Balancer that forwards requests to the specified target group. You must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM). :: + + aws elbv2 create-listener \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --protocol HTTPS \ + --port 443 \ + --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \ + --ssl-policy ELBSecurityPolicy-2016-08 --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + + +**Example 3: To create a TCP listener** + +The following ``create-listener`` example creates a TCP listener for the specified Network Load Balancer that forwards requests to the specified target group. :: + + aws elbv2 create-listener \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \ + --protocol TCP \ + --port 80 \ + --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78 + +**Example 4: To create a TLS listener** + +The following ``create-listener`` example creates a TLS listener for the specified Network Load Balancer that forwards requests to the specified target group. You must specify an SSL certificate for a TLS listener. :: + + aws elbv2 create-listener \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --protocol TLS --port 443 --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557 \ + --ssl-policy ELBSecurityPolicy-2016-08 \ + --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +**Example 5: To create a UDP listener** + +The following ``create-listener`` example creates a UDP listener for the specified Network Load Balancer that forwards requests to the specified target group. :: + + aws elbv2 create-listener \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e \ + --protocol UDP \ + --port 53 \ + --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-targets/b6bba954d1361c78 diff --git a/aws/dist/awscli/examples/elbv2/create-load-balancer.rst b/aws/dist/awscli/examples/elbv2/create-load-balancer.rst new file mode 100644 index 00000000..345c7403 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/create-load-balancer.rst @@ -0,0 +1,124 @@ +**To create an Internet-facing load balancer** + +This example creates an Internet-facing Application Load Balancer and enables the Availability Zones for the specified subnets. + +Command:: + + aws elbv2 create-load-balancer --name my-load-balancer --subnets subnet-b7d581c0 subnet-8360a9e7 + +Output:: + + { + "LoadBalancers": [ + { + "Type": "application", + "Scheme": "internet-facing", + "IpAddressType": "ipv4", + "VpcId": "vpc-3ac0fb5f", + "AvailabilityZones": [ + { + "ZoneName": "us-west-2a", + "SubnetId": "subnet-8360a9e7" + }, + { + "ZoneName": "us-west-2b", + "SubnetId": "subnet-b7d581c0" + } + ], + "CreatedTime": "2017-08-25T21:26:12.920Z", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-5943793c" + ], + "LoadBalancerName": "my-load-balancer", + "State": { + "Code": "provisioning" + }, + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + } + ] + } + +**To create an internal load balancer** + +This example creates an internal Application Load Balancer and enables the Availability Zones for the specified subnets. + +Command:: + + aws elbv2 create-load-balancer --name my-internal-load-balancer --scheme internal --subnets subnet-b7d581c0 subnet-8360a9e7 + +Output:: + + { + "LoadBalancers": [ + { + "Type": "application", + "Scheme": "internal", + "IpAddressType": "ipv4", + "VpcId": "vpc-3ac0fb5f", + "AvailabilityZones": [ + { + "ZoneName": "us-west-2a", + "SubnetId": "subnet-8360a9e7" + }, + { + "ZoneName": "us-west-2b", + "SubnetId": "subnet-b7d581c0" + } + ], + "CreatedTime": "2016-03-25T21:29:48.850Z", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-5943793c" + ], + "LoadBalancerName": "my-internal-load-balancer", + "State": { + "Code": "provisioning" + }, + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2" + } + ] + } + +**To create a Network Load Balancer** + +This example creates an Internet-facing Network Load Balancer and enables the Availability Zone for the specified subnet. It uses a subnet mapping to associate the specified Elastic IP address with the network interface used by the load balancer nodes for the Availability Zone. + +Command:: + + aws elbv2 create-load-balancer --name my-network-load-balancer --type network --subnet-mappings SubnetId=subnet-b7d581c0,AllocationId=eipalloc-64d5890a + +Output:: + + { + "LoadBalancers": [ + { + "Type": "network", + "Scheme": "internet-facing", + "IpAddressType": "ipv4", + "VpcId": "vpc-3ac0fb5f", + "AvailabilityZones": [ + { + "LoadBalancerAddresses": [ + { + "IpAddress": "35.161.207.171", + "AllocationId": "eipalloc-64d5890a" + } + ], + "ZoneName": "us-west-2b", + "SubnetId": "subnet-5264e837" + } + ], + "CreatedTime": "2017-10-15T22:41:25.657Z", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "DNSName": "my-network-load-balancer-5d1b75f4f1cee11e.elb.us-west-2.amazonaws.com", + "LoadBalancerName": "my-network-load-balancer", + "State": { + "Code": "provisioning" + }, + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/net/my-network-load-balancer/5d1b75f4f1cee11e" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/create-rule.rst b/aws/dist/awscli/examples/elbv2/create-rule.rst new file mode 100644 index 00000000..86a780d2 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/create-rule.rst @@ -0,0 +1,105 @@ +**Example 1: To create a rule using a path condition and a forward action** + +The following ``create-rule`` example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern. :: + + aws elbv2 create-rule \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ + --priority 5 \ + --conditions file://conditions-pattern.json + --actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +Contents of ``conditions-pattern.json``:: + + [ + { + "Field": "path-pattern", + "PathPatternConfig": { + "Values": ["/images/*"] + } + } + ] + +**Example 2: To create a rule using a host condition and a fixed response** + +The following ``create-rule`` example creates a rule that provides a fixed response if the hostname in the host header matches the specified hostname. :: + + aws elbv2 create-rule \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ + --priority 10 \ + --conditions file://conditions-host.json \ + --actions file://actions-fixed-response.json + +Contents of ``conditions-host.json`` :: + + [ + { + "Field": "host-header", + "HostHeaderConfig": { + "Values": ["*.example.com"] + } + } + ] + +Contents of ``actions-fixed-response.json`` :: + + [ + { + "Type": "fixed-response", + "FixedResponseConfig": { + "MessageBody": "Hello world", + "StatusCode": "200", + "ContentType": "text/plain" + } + } + ] + +**Example 3: To create a rule using a source IP address condition, an authenticate action, and a forward action** + +The following ``create-rule`` example creates a rule that authenticates the user if the source IP address matches the specified IP address, and forwards the request to the specified target group if authentication is successful. :: + + aws elbv2 create-rule \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 \ + --priority 20 \ + --conditions file://conditions-source-ip.json \ + --actions file://actions-authenticate.json + +Contents of ``conditions-source-ip.json`` :: + + [ + { + "Field": "source-ip", + "SourceIpConfig": { + "Values": ["192.0.2.0/24", "198.51.100.10/32"] + } + } + ] + +Contents of ``actions-authenticate.json`` :: + + [ + { + "Type": "authenticate-oidc", + "AuthenticateOidcConfig": { + "Issuer": "https://idp-issuer.com", + "AuthorizationEndpoint": "https://authorization-endpoint.com", + "TokenEndpoint": "https://token-endpoint.com", + "UserInfoEndpoint": "https://user-info-endpoint.com", + "ClientId": "abcdefghijklmnopqrstuvwxyz123456789", + "ClientSecret": "123456789012345678901234567890", + "SessionCookieName": "my-cookie", + "SessionTimeout": 3600, + "Scope": "email", + "AuthenticationRequestExtraParams": { + "display": "page", + "prompt": "login" + }, + "OnUnauthenticatedRequest": "deny" + }, + "Order": 1 + }, + { + "Type": "forward", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-east-1:880185128111:targetgroup/cli-test/642a97ecb0e0f26b", + "Order": 2 + } + ] diff --git a/aws/dist/awscli/examples/elbv2/create-target-group.rst b/aws/dist/awscli/examples/elbv2/create-target-group.rst new file mode 100644 index 00000000..95822c66 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/create-target-group.rst @@ -0,0 +1,98 @@ +**Example 1: To create a target group to route traffic to instances registered by instance ID** + +The following ``create-target-group`` example creates a target group for an Application Load Balancer where you register targets by instance ID (the target type is ``instance``). This target group uses the HTTP protocol, port 80, and the default health check settings for an HTTP target group. :: + + aws elbv2 create-target-group \ + --name my-targets \ + --protocol HTTP \ + --port 80 \ + --target-type instance \ + --vpc-id vpc-3ac0fb5f + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupName": "my-targets", + "Protocol": "HTTP", + "Port": 80, + "VpcId": "vpc-3ac0fb5f", + "TargetType": "instance", + "HealthCheckEnabled": true, + "UnhealthyThresholdCount": 2, + "HealthyThresholdCount": 5, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200" + }, + "HealthCheckProtocol": "HTTP", + "HealthCheckPort": "traffic-port", + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 5, + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + } + ] + } + +**Example 2: To create a target group to route traffic to an IP addresses** + +The following ``create-target-group`` example creates a target group for a Network Load Balancer where you register targets by IP address (the target type is ``ip``). This target group uses the TCP protocol, port 80, and the default health check settings for a TCP target group. :: + + aws elbv2 create-target-group \ + --name my-ip-targets \ + --protocol TCP \ + --port 80 \ + --target-type ip \ + --vpc-id vpc-3ac0fb5f + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupName": "my-ip-targets", + "Protocol": "TCP", + "Port": 80, + "VpcId": "vpc-3ac0fb5f", + "TargetType": "ip", + "HealthCheckEnabled": true, + "UnhealthyThresholdCount": 3, + "HealthyThresholdCount": 3, + "HealthCheckProtocol": "TCP", + "HealthCheckPort": "traffic-port", + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 10, + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-ip-targets/b6bba954d1361c78" + } + ] + } + +**Example 3: To create a target group to route traffic to a Lambda function** + +The following ``create-target-group`` example creates a target group for an Application Load Balancer where the target is a Lambda function (the target type is ``lambda``). Health checks are disabled for this target group by default. :: + + aws elbv2 create-target-group \ + --name my-lambda-target \ + --target-type lambda + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupName": "my-lambda-target", + "TargetType": "lambda", + "HealthCheckEnabled": false, + "UnhealthyThresholdCount": 2, + "HealthyThresholdCount": 5, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200" + }, + "HealthCheckIntervalSeconds": 35, + "HealthCheckTimeoutSeconds": 30, + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-lambda-target/a3003e085dbb8ddc" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/delete-listener.rst b/aws/dist/awscli/examples/elbv2/delete-listener.rst new file mode 100644 index 00000000..c28a1d3c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/delete-listener.rst @@ -0,0 +1,6 @@ +**To delete a listener** + +The following ``delete-listener`` example deletes the specified listener. :: + + aws elbv2 delete-listener \ + --listener-arn arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 diff --git a/aws/dist/awscli/examples/elbv2/delete-load-balancer.rst b/aws/dist/awscli/examples/elbv2/delete-load-balancer.rst new file mode 100644 index 00000000..4d15a8a9 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/delete-load-balancer.rst @@ -0,0 +1,6 @@ +**To delete a load balancer** + +The following ``delete-load-balancer`` example deletes the specified load balancer. :: + + aws elbv2 delete-load-balancer \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 diff --git a/aws/dist/awscli/examples/elbv2/delete-rule.rst b/aws/dist/awscli/examples/elbv2/delete-rule.rst new file mode 100644 index 00000000..d862c11c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/delete-rule.rst @@ -0,0 +1,6 @@ +**To delete a rule** + +The following ``delete-rule`` example deletes the specified rule. :: + + aws elbv2 delete-rule \ + --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3 diff --git a/aws/dist/awscli/examples/elbv2/delete-target-group.rst b/aws/dist/awscli/examples/elbv2/delete-target-group.rst new file mode 100644 index 00000000..fd2b84d2 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/delete-target-group.rst @@ -0,0 +1,6 @@ +**To delete a target group** + +The following ``delete-target-group`` example deletes the specified target group. :: + + aws elbv2 delete-target-group \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 diff --git a/aws/dist/awscli/examples/elbv2/deregister-targets.rst b/aws/dist/awscli/examples/elbv2/deregister-targets.rst new file mode 100644 index 00000000..09b5ddec --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/deregister-targets.rst @@ -0,0 +1,15 @@ +**Example 1: To deregister a target from a target group** + +The following ``deregister-targets`` example removes the specified instance from the specified target group. :: + + aws elbv2 deregister-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ + --targets Id=i-1234567890abcdef0 + +**Example 2: To deregister a target registered using port overrides** + +The following ``deregister-targets`` example removes an instance from a target group that was registered using port overrides. :: + + aws elbv2 deregister-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-internal-targets/3bb63f11dfb0faf9 \ + --targets Id=i-1234567890abcdef0,Port=80 Id=i-1234567890abcdef0,Port=766 diff --git a/aws/dist/awscli/examples/elbv2/describe-account-limits.rst b/aws/dist/awscli/examples/elbv2/describe-account-limits.rst new file mode 100644 index 00000000..8cb3d9e8 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-account-limits.rst @@ -0,0 +1,56 @@ +**To describe your Elastic Load Balancing limits** + +The following ``describe-account-limits`` example displays the Elastic Load Balancing limits for your AWS account in the current Region. :: + + aws elbv2 describe-account-limits + +Output:: + + { + "Limits": [ + { + "Name": "application-load-balancers", + "Max": "20" + }, + { + "Name": "target-groups", + "Max": "3000" + }, + { + "Name": "targets-per-application-load-balancer", + "Max": "1000" + }, + { + "Name": "listeners-per-application-load-balancer", + "Max": "50" + }, + { + "Name": "rules-per-application-load-balancer", + "Max": "100" + }, + { + "Name": "network-load-balancers", + "Max": "20" + }, + { + "Name": "targets-per-network-load-balancer", + "Max": "3000" + }, + { + "Name": "targets-per-availability-zone-per-network-load-balancer", + "Max": "500" + }, + { + "Name": "listeners-per-network-load-balancer", + "Max": "50" + }, + { + "Name": "condition-values-per-alb-rule", + "Max": "5" + }, + { + "Name": "condition-wildcards-per-alb-rule", + "Max": "5" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-listener-certificates.rst b/aws/dist/awscli/examples/elbv2/describe-listener-certificates.rst new file mode 100644 index 00000000..79e029e4 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-listener-certificates.rst @@ -0,0 +1,26 @@ +**To describe the certificates for a secure listener** + +This example describes the certificates for the specified secure listener. + +Command:: + + aws elbv2 describe-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 + +Output:: + + { + "Certificates": [ + { + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705", + "IsDefault": false + }, + { + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/3dcb0a41-bd72-4774-9ad9-756919c40557", + "IsDefault": false + }, + { + "CertificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/fe59da96-6f58-4a22-8eed-6d0d50477e1d", + "IsDefault": true + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-listeners.rst b/aws/dist/awscli/examples/elbv2/describe-listeners.rst new file mode 100644 index 00000000..21df8e57 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-listeners.rst @@ -0,0 +1,71 @@ +**To describe a listener** + +This example describes the specified listener. + +Command:: + + aws elbv2 describe-listeners --listener-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 + +Output:: + + { + "Listeners": [ + { + "Port": 80, + "Protocol": "HTTP", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } + +**To describe the listeners for a load balancer** + +This example describe the listeners for the specified load balancer. + +Command:: + + aws elbv2 describe-listeners --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +Output:: + + { + "Listeners": [ + { + "Port": 443, + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + }, + { + "Port": 80, + "Protocol": "HTTP", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-load-balancer-attributes.rst b/aws/dist/awscli/examples/elbv2/describe-load-balancer-attributes.rst new file mode 100644 index 00000000..fc6e67cd --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-load-balancer-attributes.rst @@ -0,0 +1,64 @@ +**To describe load balancer attributes** + +The following ``describe-load-balancer-attributes`` example displays the attributes of the specified load balancer. :: + + aws elbv2 describe-load-balancer-attributes \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +The following example output show the attributes for an Application Load Balancer. :: + + { + "Attributes": [ + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + }, + { + "Value": "true", + "Key": "routing.http2.enabled" + } + ] + } + +The following example output includes the attributes for a Network Load Balancer. :: + + { + "Attributes": [ + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + }, + { + "Value": "false", + "Key": "load_balancing.cross_zone.enabled" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-load-balancers.rst b/aws/dist/awscli/examples/elbv2/describe-load-balancers.rst new file mode 100644 index 00000000..41228182 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-load-balancers.rst @@ -0,0 +1,49 @@ +**To describe a load balancer** + +This example describes the specified load balancer. + +Command:: + + aws elbv2 describe-load-balancers --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +Output:: + + { + "LoadBalancers": [ + { + "Type": "application", + "Scheme": "internet-facing", + "IpAddressType": "ipv4", + "VpcId": "vpc-3ac0fb5f", + "AvailabilityZones": [ + { + "ZoneName": "us-west-2a", + "SubnetId": "subnet-8360a9e7" + }, + { + "ZoneName": "us-west-2b", + "SubnetId": "subnet-b7d581c0" + } + ], + "CreatedTime": "2016-03-25T21:26:12.920Z", + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "SecurityGroups": [ + "sg-5943793c" + ], + "LoadBalancerName": "my-load-balancer", + "State": { + "Code": "active" + }, + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + } + ] + } + +**To describe all load balancers** + +This example describes all of your load balancers. + +Command:: + + aws elbv2 describe-load-balancers diff --git a/aws/dist/awscli/examples/elbv2/describe-rules.rst b/aws/dist/awscli/examples/elbv2/describe-rules.rst new file mode 100644 index 00000000..eac700a8 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-rules.rst @@ -0,0 +1,13 @@ +**Example 1: To describe a rule** + +The following ``describe-rules`` example displays details for the specified rule. :: + + aws elbv2 describe-rules \ + --rule-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee + +**Example 2: To describe the rules for a listener** + +The following ``describe-rules`` example displays details for the rules for the specified listener. The output includes the default rule and any other rules that you've added. :: + + aws elbv2 describe-rules \ + --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 diff --git a/aws/dist/awscli/examples/elbv2/describe-ssl-policies.rst b/aws/dist/awscli/examples/elbv2/describe-ssl-policies.rst new file mode 100644 index 00000000..97c26454 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-ssl-policies.rst @@ -0,0 +1,48 @@ +**To describe a policy used for SSL negotiation** + +The following ``describe-ssl-policies`` example displays details of the specified policy used for SSL negotiation. :: + + aws elbv2 describe-ssl-policies \ + --names ELBSecurityPolicy-2016-08 + +Output:: + + { + "SslPolicies": [ + { + "SslProtocols": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ], + "Ciphers": [ + { + "Priority": 1, + "Name": "ECDHE-ECDSA-AES128-GCM-SHA256" + }, + { + "Priority": 2, + "Name": "ECDHE-RSA-AES128-GCM-SHA256" + }, + { + "Priority": 3, + "Name": "ECDHE-ECDSA-AES128-SHA256" + }, + + ...some output truncated... + + { + "Priority": 18, + "Name": "AES256-SHA" + } + ], + "Name": "ELBSecurityPolicy-2016-08" + } + ] + } + +**To describe all policies used for SSL negotiation** + +The following ``describe-ssl-policies`` example displays details for all the policies that you can use for SSL negotiation. :: + + aws elbv2 describe-ssl-policies diff --git a/aws/dist/awscli/examples/elbv2/describe-tags.rst b/aws/dist/awscli/examples/elbv2/describe-tags.rst new file mode 100644 index 00000000..960c986c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-tags.rst @@ -0,0 +1,27 @@ +**To describe the tags assigned to a load balancer** + +This example describes the tags assigned to the specified load balancer. + +Command:: + + aws elbv2 describe-tags --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +Output:: + + { + "TagDescriptions": [ + { + "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Tags": [ + { + "Value": "lima", + "Key": "project" + }, + { + "Value": "digital-media", + "Key": "department" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-target-group-attributes.rst b/aws/dist/awscli/examples/elbv2/describe-target-group-attributes.rst new file mode 100644 index 00000000..1429ec2e --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-target-group-attributes.rst @@ -0,0 +1,59 @@ +**To describe target group attributes** + +The following ``describe-target-group-attributes`` example displays the attributes of the specified target group. :: + + aws elbv2 describe-target-group-attributes \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +The output includes the attributes if the protocol is HTTP or HTTPS and the target type is ``instance`` or ``ip``. :: + + { + "Attributes": [ + { + "Value": "false", + "Key": "stickiness.enabled" + }, + { + "Value": "300", + "Key": "deregistration_delay.timeout_seconds" + }, + { + "Value": "lb_cookie", + "Key": "stickiness.type" + }, + { + "Value": "86400", + "Key": "stickiness.lb_cookie.duration_seconds" + }, + { + "Value": "0", + "Key": "slow_start.duration_seconds" + } + ] + } + +The following output includes the attributes if the protocol is HTTP or HTTPS and the target type is ``lambda``. :: + + { + "Attributes": [ + { + "Value": "false", + "Key": "lambda.multi_value_headers.enabled" + } + ] + } + +The following output includes the attributes if the protocol is TCP, TLS, UDP, or TCP_UDP. :: + + { + "Attributes": [ + { + "Value": "false", + "Key": "proxy_protocol_v2.enabled" + }, + { + "Value": "300", + "Key": "deregistration_delay.timeout_seconds" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/describe-target-groups.rst b/aws/dist/awscli/examples/elbv2/describe-target-groups.rst new file mode 100644 index 00000000..0cf32398 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-target-groups.rst @@ -0,0 +1,48 @@ +**Example 1: To describe a target group** + +The following ``describe-target-groups`` example displays details for the specified target group. :: + + aws elbv2 describe-target-groups \ + --target-group-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +Output:: + + { + "TargetGroups": [ + { + "TargetGroupName": "my-targets", + "Protocol": "HTTP", + "Port": 80, + "VpcId": "vpc-3ac0fb5f", + "TargetType": "instance", + "HealthCheckEnabled": true, + "UnhealthyThresholdCount": 2, + "HealthyThresholdCount": 5, + "HealthCheckPath": "/", + "Matcher": { + "HttpCode": "200" + }, + "HealthCheckProtocol": "HTTP", + "HealthCheckPort": "traffic-port", + "HealthCheckIntervalSeconds": 30, + "HealthCheckTimeoutSeconds": 5, + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ] + } + ] + } + +**Example 2: To describe all target groups for a load balancer** + +The following ``describe-target-groups`` example displays details for all target groups for the specified load balancer. :: + + aws elbv2 describe-target-groups \ + --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +**Example 3: To describe all target groups** + +The following ``describe-target-groups`` example dislplays details for all of your target groups. :: + + aws elbv2 describe-target-groups diff --git a/aws/dist/awscli/examples/elbv2/describe-target-health.rst b/aws/dist/awscli/examples/elbv2/describe-target-health.rst new file mode 100644 index 00000000..630b3474 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/describe-target-health.rst @@ -0,0 +1,133 @@ +**Example 1: To describe the health of the targets for a target group** + +The following ``describe-target-health`` example displays health details for the targets of the specified target group. These targets are healthy. :: + + aws elbv2 describe-target-health \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +Output:: + + { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-ceddcd4d", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + }, + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + } + +**Example 2: To describe the health of a target** + +The following ``describe-target-health`` example displays health details for the specified target. This target is healthy. :: + + aws elbv2 describe-target-health \ + --targets Id=i-0f76fade,Port=80 \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 + +Output:: + + { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + } + +The following example output is for a target whose target group is not specified in an action for a listener. This target can't receive traffic from the load balancer. :: + + { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "unused", + "Reason": "Target.NotInUse", + "Description": "Target group is not configured to receive traffic from the load balancer" + } + } + ] + } + +The following example output is for a target whose target group was just specified in an action for a listener. The target is still being registered. :: + + { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "initial", + "Reason": "Elb.RegistrationInProgress", + "Description": "Target registration is in progress" + } + } + ] + } + +The following example output is for an unhealthy target. :: + + { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "unhealthy", + "Reason": "Target.Timeout", + "Description": "Connection to target timed out" + } + } + ] + } + +The following example output is for a target that is a Lambda function and health checks are disabled. :: + + { + "TargetHealthDescriptions": [ + { + "Target": { + "Id": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "AvailabilityZone": "all", + }, + "TargetHealth": { + "State": "unavailable", + "Reason": "Target.HealthCheckDisabled", + "Description": "Health checks are not enabled for this target" + } + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/modify-listener.rst b/aws/dist/awscli/examples/elbv2/modify-listener.rst new file mode 100644 index 00000000..4829a8c8 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/modify-listener.rst @@ -0,0 +1,59 @@ +**To change the default action** + +This example changes the default action for the specified listener. + +Command:: + + aws elbv2 modify-listener --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --default-actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f + +Output:: + + { + "Listeners": [ + { + "Protocol": "HTTP", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + } + ] + } + +**To change the server certificate** + +This example changes the server certificate for the specified HTTPS listener. + +Command:: + + aws elbv2 modify-listener --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65 --certificates CertificateArn=arn:aws:iam::123456789012:server-certificate/my-new-server-cert + +Output:: + + { + "Listeners": [ + { + "Protocol": "HTTPS", + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "SslPolicy": "ELBSecurityPolicy-2015-05", + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/modify-load-balancer-attributes.rst b/aws/dist/awscli/examples/elbv2/modify-load-balancer-attributes.rst new file mode 100644 index 00000000..c33266b1 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/modify-load-balancer-attributes.rst @@ -0,0 +1,104 @@ +**To enable deletion protection** + +This example enables deletion protection for the specified load balancer. + +Command:: + + aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=deletion_protection.enabled,Value=true + +Output:: + + { + "Attributes": [ + { + "Value": "true", + "Key": "deletion_protection.enabled" + }, + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + } + ] + } + +**To change the idle timeout** + +This example changes the idle timeout value for the specified load balancer. + +Command:: + + aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=idle_timeout.timeout_seconds,Value=30 + +Output:: + + { + "Attributes": [ + { + "Value": "30", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "true", + "Key": "deletion_protection.enabled" + }, + { + "Value": "", + "Key": "access_logs.s3.bucket" + } + ] + } + +**To enable access logs** + +This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service. + +Command:: + + aws elbv2 modify-load-balancer-attributes --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --attributes Key=access_logs.s3.enabled,Value=true Key=access_logs.s3.bucket,Value=my-loadbalancer-logs Key=access_logs.s3.prefix,Value=myapp + +Output:: + + { + "Attributes": [ + { + "Value": "true", + "Key": "access_logs.s3.enabled" + }, + { + "Value": "my-load-balancer-logs", + "Key": "access_logs.s3.bucket" + }, + { + "Value": "myapp", + "Key": "access_logs.s3.prefix" + }, + { + "Value": "60", + "Key": "idle_timeout.timeout_seconds" + }, + { + "Value": "false", + "Key": "deletion_protection.enabled" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/modify-rule.rst b/aws/dist/awscli/examples/elbv2/modify-rule.rst new file mode 100644 index 00000000..5fb09842 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/modify-rule.rst @@ -0,0 +1,34 @@ +**To modify a rule** + +The following ``modify-rule`` example updates the actions and conditions for the specified rule. :: + + aws elbv2 modify-rule \ + --actions Type=forward,TargetGroupArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ + --conditions Field=path-pattern,Values='/images/*' + --rule-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee + +Output:: + + { + "Rules": [ + { + "Priority": "10", + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/images/*" + ] + } + ], + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee", + "IsDefault": false, + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/modify-target-group-attributes.rst b/aws/dist/awscli/examples/elbv2/modify-target-group-attributes.rst new file mode 100644 index 00000000..9709fe87 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/modify-target-group-attributes.rst @@ -0,0 +1,30 @@ +**To modify the deregistration delay timeout** + +This example sets the deregistration delay timeout to the specified value for the specified target group. + +Command:: + + aws elbv2 modify-target-group-attributes --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 --attributes Key=deregistration_delay.timeout_seconds,Value=600 + +Output:: + + { + "Attributes": [ + { + "Value": "false", + "Key": "stickiness.enabled" + }, + { + "Value": "600", + "Key": "deregistration_delay.timeout_seconds" + }, + { + "Value": "lb_cookie", + "Key": "stickiness.type" + }, + { + "Value": "86400", + "Key": "stickiness.lb_cookie.duration_seconds" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/modify-target-group.rst b/aws/dist/awscli/examples/elbv2/modify-target-group.rst new file mode 100644 index 00000000..d967e47c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/modify-target-group.rst @@ -0,0 +1,33 @@ +**To modify the health check configuration for a target group** + +This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group. + +Command:: + + aws elbv2 modify-target-group --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f --health-check-protocol HTTPS --health-check-port 443 + +Output:: + + { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "VpcId": "vpc-3ac0fb5f", + "Protocol": "HTTPS", + "HealthCheckTimeoutSeconds": 5, + "HealthCheckProtocol": "HTTPS", + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "UnhealthyThresholdCount": 2, + "HealthyThresholdCount": 5, + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", + "Matcher": { + "HttpCode": "200" + }, + "HealthCheckPort": "443", + "Port": 443, + "TargetGroupName": "my-https-targets" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/register-targets.rst b/aws/dist/awscli/examples/elbv2/register-targets.rst new file mode 100644 index 00000000..d89691a6 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/register-targets.rst @@ -0,0 +1,31 @@ +**Example 1: To register targets with a target group by instance ID** + +The following ``register-targets`` example registers the specified instances with a target group. The target group must have a target type of ``instance``. :: + + aws elbv2 register-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ + --targets Id=i-1234567890abcdef0 Id=i-0abcdef1234567890 + +**Example 2: To register targets with a target group using port overrides** + +The following ``register-targets`` example registers the specified instance with a target group using multiple ports. This enables you to register containers on the same instance as targets in the target group. :: + + aws elbv2 register-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-internal-targets/3bb63f11dfb0faf9 \ + --targets Id=i-0598c7d356eba48d7,Port=80 Id=i-0598c7d356eba48d7,Port=766 + +**Example 3: To register targets with a target group by IP address** + +The following ``register-targets`` example registers the specified IP addresses with a target group. The target group must have a target type of ``ip``. :: + + aws elbv2 register-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-ip-targets/8518e899d173178f \ + --targets Id=10.0.1.15 Id=10.0.1.23 + +**Example 4: To register a Lambda function as a target** + +The following ``register-targets`` example registers the specified IP addresses with a target group. The target group must have a target type of ``lambda``. You must grant Elastic Load Balancing permission to invoke the Lambda function. :: + + aws elbv2 register-targets \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tcp-ip-targets/8518e899d173178f \ + --targets Id=arn:aws:lambda:us-west-2:123456789012:function:my-function diff --git a/aws/dist/awscli/examples/elbv2/remove-listener-certificates.rst b/aws/dist/awscli/examples/elbv2/remove-listener-certificates.rst new file mode 100644 index 00000000..b732d2ff --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/remove-listener-certificates.rst @@ -0,0 +1,7 @@ +**To remove a certificate from a secure listener** + +This example removes the specified certificate from the specified secure listener. + +Command:: + + aws elbv2 remove-listener-certificates --listener-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2 --certificates CertificateArn=arn:aws:acm:us-west-2:123456789012:certificate/5cc54884-f4a3-4072-80be-05b9ba72f705 diff --git a/aws/dist/awscli/examples/elbv2/remove-tags.rst b/aws/dist/awscli/examples/elbv2/remove-tags.rst new file mode 100644 index 00000000..c89c0eb4 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/remove-tags.rst @@ -0,0 +1,7 @@ +**To remove tags from a load balancer** + +The follwoing ``remove-tags`` example removes the ``project`` and ``department`` tags from the specified load balancer. :: + + aws elbv2 remove-tags \ + --resource-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 \ + --tag-keys project department diff --git a/aws/dist/awscli/examples/elbv2/set-ip-address-type.rst b/aws/dist/awscli/examples/elbv2/set-ip-address-type.rst new file mode 100644 index 00000000..3bab779c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/set-ip-address-type.rst @@ -0,0 +1,13 @@ +**To set the address type of a load balancer** + +This example sets the address type of the specified load balancer to ``dualstack``. The load balancer must be an Internet-facing load balancer and its subnets must have associated IPv6 CIDR blocks. + +Command:: + + aws elbv2 set-ip-address-type --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --ip-address-type dualstack + +Output:: + + { + "IpAddressType": "dualstack" + } diff --git a/aws/dist/awscli/examples/elbv2/set-rule-priorities.rst b/aws/dist/awscli/examples/elbv2/set-rule-priorities.rst new file mode 100644 index 00000000..2d534056 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/set-rule-priorities.rst @@ -0,0 +1,33 @@ +**To set the rule priority** + +This example sets the priority of the specified rule. + +Command:: + + aws elbv2 set-rule-priorities --rule-priorities RuleArn=arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3,Priority=5 + +Output:: + + { + "Rules": [ + { + "Priority": "5", + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3", + "IsDefault": false, + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ] + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/set-security-groups.rst b/aws/dist/awscli/examples/elbv2/set-security-groups.rst new file mode 100644 index 00000000..45144300 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/set-security-groups.rst @@ -0,0 +1,15 @@ +**To associate a security group with a load balancer** + +This example associates the specified security group with the specified load balancer. + +Command:: + + aws elbv2 set-security-groups --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --security-groups sg-5943793c + +Output:: + + { + "SecurityGroupIds": [ + "sg-5943793c" + ] + } diff --git a/aws/dist/awscli/examples/elbv2/set-subnets.rst b/aws/dist/awscli/examples/elbv2/set-subnets.rst new file mode 100644 index 00000000..9bd3712c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/set-subnets.rst @@ -0,0 +1,22 @@ +**To enable Availability Zones for a load balancer** + +This example enables the Availability Zone for the specified subnet for the specified load balancer. + +Command:: + + aws elbv2 set-subnets --load-balancer-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 --subnets subnet-8360a9e7 subnet-b7d581c0 + +Output:: + + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ] + } diff --git a/aws/dist/awscli/examples/elbv2/wait/load-balancer-available.rst b/aws/dist/awscli/examples/elbv2/wait/load-balancer-available.rst new file mode 100644 index 00000000..0097091e --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/wait/load-balancer-available.rst @@ -0,0 +1,8 @@ +**To pause running until a load balancer is available** + +The following ``wait load-balancer-available`` command pauses and continues only after it confirms that the specified load balancer is available. :: + + aws elbv2 wait load-balancer-available \ + --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +This command produces no output. diff --git a/aws/dist/awscli/examples/elbv2/wait/load-balancer-exists.rst b/aws/dist/awscli/examples/elbv2/wait/load-balancer-exists.rst new file mode 100644 index 00000000..5b1d631a --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/wait/load-balancer-exists.rst @@ -0,0 +1,8 @@ +**To pause running until a load balancer exists** + +The following ``wait load-balancer-exists`` command pauses and continues only after it confirms that the specified load balancer exists. + + aws elbv2 wait load-balancer-exists \ + --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +This command produces no output. diff --git a/aws/dist/awscli/examples/elbv2/wait/load-balancers-deleted.rst b/aws/dist/awscli/examples/elbv2/wait/load-balancers-deleted.rst new file mode 100644 index 00000000..261c9118 --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/wait/load-balancers-deleted.rst @@ -0,0 +1,8 @@ +**To pause running until a load balancer is deleted** + +The following ``wait load-balancers-deleted`` command pauses and continues only after it confirms that the specified load balancer is deleted. + + aws elbv2 wait load-balancers-deleted \ + --load-balancer-arns arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 + +This command produces no output. diff --git a/aws/dist/awscli/examples/elbv2/wait/target-deregistered.rst b/aws/dist/awscli/examples/elbv2/wait/target-deregistered.rst new file mode 100644 index 00000000..409bbf0c --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/wait/target-deregistered.rst @@ -0,0 +1,9 @@ +**To pause running until a target is deregistered** + +The following ``wait target-deregistered`` command pauses and continues only after it confirms that the specified target is deregistered. + + aws elbv2 wait target-deregistered \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ + --targets Id=i-1234567890abcdef0,Port=80 + +This command produces no output. diff --git a/aws/dist/awscli/examples/elbv2/wait/target-in-service.rst b/aws/dist/awscli/examples/elbv2/wait/target-in-service.rst new file mode 100644 index 00000000..87f9c20d --- /dev/null +++ b/aws/dist/awscli/examples/elbv2/wait/target-in-service.rst @@ -0,0 +1,9 @@ +**To pause running until a registered target is in service** + +The following ``wait target-in-service`` command pauses and continues only after it confirms that the specified target is in service. + + aws elbv2 wait target-in-service \ + --target-group-arn arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067 \ + --targets Id=i-1234567890abcdef0,Port=80 + +This command produces no output. diff --git a/aws/dist/awscli/examples/emr/add-instance-fleet.rst b/aws/dist/awscli/examples/emr/add-instance-fleet.rst new file mode 100644 index 00000000..4edbb876 --- /dev/null +++ b/aws/dist/awscli/examples/emr/add-instance-fleet.rst @@ -0,0 +1,14 @@ +**To add a task instance fleet to a cluster** + +This example adds a new task instance fleet to the cluster specified. + +Command:: + + aws emr add-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetType=TASK,TargetSpotCapacity=1,LaunchSpecifications={SpotSpecification='{TimeoutDurationMinutes=20,TimeoutAction=TERMINATE_CLUSTER}'},InstanceTypeConfigs=['{InstanceType=m3.xlarge,BidPrice=0.5}'] + +Output:: + + { + "ClusterId": "j-12ABCDEFGHI34JK", + "InstanceFleetId": "if-23ABCDEFGHI45JJ" + } diff --git a/aws/dist/awscli/examples/emr/add-steps.rst b/aws/dist/awscli/examples/emr/add-steps.rst new file mode 100644 index 00000000..282c77ed --- /dev/null +++ b/aws/dist/awscli/examples/emr/add-steps.rst @@ -0,0 +1,180 @@ +**1. To add Custom JAR steps to a cluster** + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://mybucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://mybucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 + +- Required parameters:: + + Jar + +- Optional parameters:: + + Type, Name, ActionOnFailure, Args + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + "s-YYYYYYYY" + ] + } + +**2. To add Streaming steps to a cluster** + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://mybucket/wordcount/output] + +- Required parameters:: + + Type, Args + +- Optional parameters:: + + Name, ActionOnFailure + +- JSON equivalent (contents of step.json):: + + [ + { + "Name": "JSON Streaming Step", + "Args": ["-files","s3://elasticmapreduce/samples/wordcount/wordSplitter.py","-mapper","wordSplitter.py","-reducer","aggregate","-input","s3://elasticmapreduce/samples/wordcount/input","-output","s3://mybucket/wordcount/output"], + "ActionOnFailure": "CONTINUE", + "Type": "STREAMING" + } + ] + +NOTE: JSON arguments must include options and values as their own items in the list. + +- Command (using step.json):: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./step.json + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + "s-YYYYYYYY" + ] + } + +**3. To add a Streaming step with multiple files to a cluster (JSON only)** + +- JSON (multiplefiles.json):: + + [ + { + "Name": "JSON Streaming Step", + "Type": "STREAMING", + "ActionOnFailure": "CONTINUE", + "Args": [ + "-files", + "s3://mybucket/mapper.py,s3://mybucket/reducer.py", + "-mapper", + "mapper.py", + "-reducer", + "reducer.py", + "-input", + "s3://mybucket/input", + "-output", + "s3://mybucket/output"] + } + ] + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps file://./multiplefiles.json + +- Required parameters:: + + Type, Args + +- Optional parameters:: + + Name, ActionOnFailure + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + ] + } + + +**4. To add Hive steps to a cluster** + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,Args=[-f,s3://mybucket/myhivescript.q,-d,INPUT=s3://mybucket/myhiveinput,-d,OUTPUT=s3://mybucket/myhiveoutput,arg1,arg2] Type=HIVE,Name='Hive steps',ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] + + +- Required parameters:: + + Type, Args + +- Optional parameters:: + + Name, ActionOnFailure + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + "s-YYYYYYYY" + ] + } + + +**5. To add Pig steps to a cluster** + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://mybucket/mypigscript.pig,-p,INPUT=s3://mybucket/mypiginput,-p,OUTPUT=s3://mybucket/mypigoutput,arg1,arg2] Type=PIG,Name='Pig program',Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output,arg1,arg2] + + +- Required parameters:: + + Type, Args + +- Optional parameters:: + + Name, ActionOnFailure + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + "s-YYYYYYYY" + ] + } + + +**6. To add Impala steps to a cluster** + +- Command:: + + aws emr add-steps --cluster-id j-XXXXXXXX --steps Type=IMPALA,Name='Impala program',ActionOnFailure=CONTINUE,Args=--impala-script,s3://myimpala/input,--console-output-path,s3://myimpala/output + +- Required parameters:: + + Type, Args + +- Optional parameters:: + + Name, ActionOnFailure + +- Output:: + + { + "StepIds":[ + "s-XXXXXXXX", + "s-YYYYYYYY" + ] + } + diff --git a/aws/dist/awscli/examples/emr/add-tags.rst b/aws/dist/awscli/examples/emr/add-tags.rst new file mode 100644 index 00000000..7675d7af --- /dev/null +++ b/aws/dist/awscli/examples/emr/add-tags.rst @@ -0,0 +1,36 @@ +**1. To add tags to a cluster** + +- Command:: + + aws emr add-tags --resource-id j-xxxxxxx --tags name="John Doe" age=29 sex=male address="123 East NW Seattle" + +- Output:: + + None + +**2. To list tags of a cluster** + +--Command:: + + aws emr describe-cluster --cluster-id j-XXXXXXYY --query Cluster.Tags + +- Output:: + + [ + { + "Value": "male", + "Key": "sex" + }, + { + "Value": "123 East NW Seattle", + "Key": "address" + }, + { + "Value": "John Doe", + "Key": "name" + }, + { + "Value": "29", + "Key": "age" + } + ] diff --git a/aws/dist/awscli/examples/emr/create-cluster-examples.rst b/aws/dist/awscli/examples/emr/create-cluster-examples.rst new file mode 100644 index 00000000..07c2f84d --- /dev/null +++ b/aws/dist/awscli/examples/emr/create-cluster-examples.rst @@ -0,0 +1,531 @@ +Most of the following examples assume that you specified your Amazon EMR service role and Amazon EC2 instance profile. If you have not done this, you must specify each required IAM role or use the ``--use-default-roles`` parameter when creating your cluster. For more information about specifying IAM roles, see `Configure IAM Roles for Amazon EMR Permissions to AWS Services `_ in the *Amazon EMR Management Guide*. + +**Example 1: To create a cluster** + +The following ``create-cluster`` example creates a simple EMR cluster. :: + + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --instance-type m4.large \ + --instance-count 2 + +**Example 2: To create an Amazon EMR cluster with default ServiceRole and InstanceProfile roles** + +The following ``create-cluster`` example creates an Amazon EMR cluster that uses the ``--instance-groups`` configuration. :: + + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +**Example 3: To create an Amazon EMR cluster that uses an instance fleet** + +The following ``create-cluster`` example creates an Amazon EMR cluster that uses the ``--instance-fleets`` configuration, specifying two instance types for each fleet and two EC2 Subnets. :: + + aws emr create-cluster \ + --release-label emr-5.14.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole,SubnetIds=['subnet-ab12345c','subnet-de67890f'] \ + --instance-fleets InstanceFleetType=MASTER,TargetOnDemandCapacity=1,InstanceTypeConfigs=['{InstanceType=m4.large}'] InstanceFleetType=CORE,TargetSpotCapacity=11,InstanceTypeConfigs=['{InstanceType=m4.large,BidPrice=0.5,WeightedCapacity=3}','{InstanceType=m4.2xlarge,BidPrice=0.9,WeightedCapacity=5}'],LaunchSpecifications={SpotSpecification='{TimeoutDurationMinutes=120,TimeoutAction=SWITCH_TO_ON_DEMAND}'} + +**Example 4: To create a cluster with default roles** + +The following ``create-cluster`` example uses the ``--use-default-roles`` parameter to specify the default service role and instance profile. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 5: To create a cluster and specify the applications to install** + +The following ``create-cluster`` example uses the ``--applications`` parameter to specify the applications that Amazon EMR installs. This example installs Hadoop, Hive and Pig. :: + + aws emr create-cluster \ + --applications Name=Hadoop Name=Hive Name=Pig \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 6: To create a cluster that includes Spark** + +The following example installs Spark. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --applications Name=Spark \ + --ec2-attributes KeyName=myKey \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 7: To specify a custom AMI to use for cluster instances** + +The following ``create-cluster`` example creates a cluster instance based on the Amazon Linux AMI with ID ``ami-a518e6df``. :: + + aws emr create-cluster \ + --name "Cluster with My Custom AMI" \ + --custom-ami-id ami-a518e6df \ + --ebs-root-volume-size 20 \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-count 2 \ + --instance-type m4.large + +**Example 8: To customize application configurations** + +The following examples use the ``--configurations`` parameter to specify a JSON configuration file that contains application customizations for Hadoop. For more information, see `Configuring Applications `_ in the *Amazon EMR Release Guide*. + +Contents of ``configurations.json``:: + + [ + { + "Classification": "mapred-site", + "Properties": { + "mapred.tasktracker.map.tasks.maximum": 2 + } + }, + { + "Classification": "hadoop-env", + "Properties": {}, + "Configurations": [ + { + "Classification": "export", + "Properties": { + "HADOOP_DATANODE_HEAPSIZE": 2048, + "HADOOP_NAMENODE_OPTS": "-XX:GCTimeRatio=19" + } + } + ] + } + ] + +The following example references ``configurations.json`` as a local file. :: + + aws emr create-cluster \ + --configurations file://configurations.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example references ``configurations.json`` as a file in Amazon S3. :: + + aws emr create-cluster \ + --configurations https://s3.amazonaws.com/myBucket/configurations.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 9: To create a cluster with master, core, and task instance groups** + +The following ``create-cluster`` example uses ``--instance-groups`` to specify the type and number of EC2 instances to use for master, core, and task instance groups. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --instance-groups Name=Master,InstanceGroupType=MASTER,InstanceType=m4.large,InstanceCount=1 Name=Core,InstanceGroupType=CORE,InstanceType=m4.large,InstanceCount=2 Name=Task,InstanceGroupType=TASK,InstanceType=m4.large,InstanceCount=2 + +**Example 10: To specify that a cluster should terminate after completing all steps** + +The following ``create-cluster`` example uses ``--auto-terminate`` to specify that the cluster should shut down automatically after completing all steps. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 11: To specify cluster configuration details such as the Amazon EC2 key pair, network configuration, and security groups** + +The following ``create-cluster`` example creates a cluster with the Amazon EC2 key pair named ``myKey`` and a customized instance profile named ``myProfile``. Key pairs are used to authorize SSH connections to cluster nodes, most often the master node. For more information, see `Use an Amazon EC2 Key Pair for SSH Credentials `_ in the *Amazon EMR Management Guide*. :: + + aws emr create-cluster \ + --ec2-attributes KeyName=myKey,InstanceProfile=myProfile \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example creates a cluster in an Amazon VPC subnet. :: + + aws emr create-cluster \ + --ec2-attributes SubnetId=subnet-xxxxx \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example creates a cluster in the ``us-east-1b`` availability zone. :: + + aws emr create-cluster \ + --ec2-attributes AvailabilityZone=us-east-1b \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example creates a cluster and specifies only the Amazon EMR-managed security groups. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example creates a cluster and specifies only additional Amazon EC2 security groups. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example creates a cluster and specifies the EMR-Managed security groups, as well as additional security groups. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,EmrManagedMasterSecurityGroup=sg-master1,EmrManagedSlaveSecurityGroup=sg-slave1,AdditionalMasterSecurityGroups=[sg-addMaster1,sg-addMaster2,sg-addMaster3,sg-addMaster4],AdditionalSlaveSecurityGroups=[sg-addSlave1,sg-addSlave2,sg-addSlave3,sg-addSlave4] \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example creates a cluster in a VPC private subnet and use a specific Amazon EC2 security group to enable Amazon EMR service access, which is required for clusters in private subnets. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes InstanceProfile=myRole,ServiceAccessSecurityGroup=sg-service-access,EmrManagedMasterSecurityGroup=sg-master,EmrManagedSlaveSecurityGroup=sg-slave \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +The following example specifies security group configuration parameters using a JSON file named ``ec2_attributes.json`` that is stored locally. + +Contents of ``ec2_attributes.json``:: + + [ + { + "SubnetId": "subnet-xxxxx", + "KeyName": "myKey", + "InstanceProfile":"myRole", + "EmrManagedMasterSecurityGroup": "sg-master1", + "EmrManagedSlaveSecurityGroup": "sg-slave1", + "ServiceAccessSecurityGroup": "sg-service-access" + "AdditionalMasterSecurityGroups": ["sg-addMaster1","sg-addMaster2","sg-addMaster3","sg-addMaster4"], + "AdditionalSlaveSecurityGroups": ["sg-addSlave1","sg-addSlave2","sg-addSlave3","sg-addSlave4"] + } + ] + +NOTE: JSON arguments must include options and values as their own items in the list. + +Command:: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role myServiceRole \ + --ec2-attributes file://ec2_attributes.json \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +**Example 12: To enable debugging and specify a log URI** + +The following ``create-cluster`` example uses the ``--enable-debugging`` parameter, which allows you to view log files more easily using the debugging tool in the Amazon EMR console. The ``--log-uri`` parameter is required with ``--enable-debugging``. :: + + aws emr create-cluster \ + --enable-debugging \ + --log-uri s3://myBucket/myLog \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 13: To add tags when creating a cluster** + +Tags are key-value pairs that help you identify and manage clusters. The following ``create-cluster`` example uses the ``--tags`` parameter to create two tags for a cluster, one with the key name ``name`` and the value ``Shirley Rodriguez`` and the other with the key name ``address`` and the value ``123 Maple Street, Anytown, USA``. :: + + aws emr create-cluster \ + --tags name="Shirley Rodriguez" age=29 department="Analytics" \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example lists the tags applied to a cluster. :: + + aws emr describe-cluster \ + --cluster-id j-XXXXXXYY \ + --query Cluster.Tags + +**Example 14: To use a security configuration that enables encryption and other security features** + +The following ``create-cluster`` example uses the ``--security-configuration`` parameter to specify a security configuration for an EMR cluster. You can use security configurations with Amazon EMR version 4.8.0 or later. :: + + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --security-configuration mySecurityConfiguration + +**Example 15: To create a cluster with additional EBS storage volumes configured for the instance groups** + +When specifying additional EBS volumes, the following arguments are required: ``VolumeType``, ``SizeInGB`` if ``EbsBlockDeviceConfigs`` is specified. + +The following ``create-cluster`` example creates a cluster with multiple EBS volumes attached to EC2 instances in the core instance group. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=d2.xlarge 'InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge,EbsConfiguration={EbsOptimized=true,EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=gp2,SizeInGB=100}},{VolumeSpecification={VolumeType=io1,SizeInGB=100,Iops=100},VolumesPerInstance=4}]}' \ + --auto-terminate + +The following example creates a cluster with multiple EBS volumes attached to EC2 instances in the master instance group. :: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --use-default-roles \ + --instance-groups 'InstanceGroupType=MASTER, InstanceCount=1, InstanceType=d2.xlarge, EbsConfiguration={EbsOptimized=true, EbsBlockDeviceConfigs=[{VolumeSpecification={VolumeType=io1, SizeInGB=100, Iops=100}},{VolumeSpecification={VolumeType=standard,SizeInGB=50},VolumesPerInstance=3}]}' InstanceGroupType=CORE,InstanceCount=2,InstanceType=d2.xlarge \ + --auto-terminate + +**Example 16: To create a cluster with an automatic scaling policy** + +You can attach automatic scaling policies to core and task instance groups using Amazon EMR version 4.0 and later. The automatic scaling policy dynamically adds and removes EC2 instances in response to an Amazon CloudWatch metric. For more information, see `Using Automatic Scaling in Amazon EMR` `_ in the *Amazon EMR Management Guide*. + +When attaching an automatic scaling policy, you must also specify the default role for automatic scaling using ``--auto-scaling-role EMR_AutoScaling_DefaultRole``. + +The following ``create-cluster`` example specifies the automatic scaling policy for the ``CORE`` instance group using the ``AutoScalingPolicy`` argument with an embedded JSON structure, which specifies the scaling policy configuration. Instance groups with an embedded JSON structure must have the entire collection of arguments enclosed in single quotes. Using single quotes is optional for instance groups without an embedded JSON structure. :: + + aws emr create-cluster + --release-label emr-5.9.0 \ + --use-default-roles --auto-scaling-role EMR_AutoScaling_DefaultRole \ + --instance-groups InstanceGroupType=MASTER,InstanceType=d2.xlarge,InstanceCount=1 'InstanceGroupType=CORE,InstanceType=d2.xlarge,InstanceCount=2,AutoScalingPolicy={Constraints={MinCapacity=1,MaxCapacity=5},Rules=[{Name=TestRule,Description=TestDescription,Action={Market=ON_DEMAND,SimpleScalingPolicyConfiguration={AdjustmentType=EXACT_CAPACITY,ScalingAdjustment=2}},Trigger={CloudWatchAlarmDefinition={ComparisonOperator=GREATER_THAN,EvaluationPeriods=5,MetricName=TestMetric,Namespace=EMR,Period=3,Statistic=MAXIMUM,Threshold=4.5,Unit=NONE,Dimensions=[{Key=TestKey,Value=TestValue}]}}}]}' + +The following example uses a JSON file, ``instancegroupconfig.json``, to specify the configuration of all instance groups in a cluster. The JSON file specifies the automatic scaling policy configuration for the core instance group. + +Contents of ``instancegroupconfig.json``:: + + [ + { + "InstanceCount": 1, + "Name": "MyMasterIG", + "InstanceGroupType": "MASTER", + "InstanceType": "m4.large" + }, + { + "InstanceCount": 2, + "Name": "MyCoreIG", + "InstanceGroupType": "CORE", + "InstanceType": "m4.large", + "AutoScalingPolicy": { + "Constraints": { + "MinCapacity": 2, + "MaxCapacity": 10 + }, + "Rules": [ + { + "Name": "Default-scale-out", + "Description": "Replicates the default scale-out rule in the console for YARN memory.", + "Action": { + "SimpleScalingPolicyConfiguration": { + "AdjustmentType": "CHANGE_IN_CAPACITY", + "ScalingAdjustment": 1, + "CoolDown": 300 + } + }, + "Trigger": { + "CloudWatchAlarmDefinition": { + "ComparisonOperator": "LESS_THAN", + "EvaluationPeriods": 1, + "MetricName": "YARNMemoryAvailablePercentage", + "Namespace": "AWS/ElasticMapReduce", + "Period": 300, + "Threshold": 15, + "Statistic": "AVERAGE", + "Unit": "PERCENT", + "Dimensions": [ + { + "Key": "JobFlowId", + "Value": "${emr.clusterId}" + } + ] + } + } + } + ] + } + } + ] + +Command:: + + aws emr create-cluster \ + --release-label emr-5.9.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --instance-groups s3://mybucket/instancegroupconfig.json \ + --auto-scaling-role EMR_AutoScaling_DefaultRole + +**Example 17: Add custom JAR steps when creating a cluster** + +The following ``create-cluster`` example adds steps by specifying a JAR file stored in Amazon S3. Steps submit work to a cluster. The main function defined in the JAR file executes after EC2 instances are provisioned, any bootstrap actions have executed, and applications are installed. The steps are specified using ``Type=CUSTOM_JAR``. + +Custom JAR steps required the ``Jar=`` parameter, which specifies the path and file name of the JAR. Optional parameters are the following:: + + Type, Name, ActionOnFailure, Args, MainClass + +If main class is not specified, the JAR file should specify Main-Class in its manifest file. + +Command:: + + aws emr create-cluster \ + --steps Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,Args=arg1,arg2,arg3 Type=CUSTOM_JAR,Name=CustomJAR,ActionOnFailure=CONTINUE,Jar=s3://myBucket/mytest.jar,MainClass=mymainclass,Args=arg1,arg2,arg3 \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 18: To add streaming steps when creating a cluster** + +The following ``create-cluster`` examples add a streaming step to a cluster that terminates after all steps run. + +Streaming steps required parameters:: + + Type, Args + +Streaming steps optional parameters:: + + Name, ActionOnFailure + +The following example specifies the step inline. :: + + aws emr create-cluster \ + --steps Type=STREAMING,Name='Streaming Program',ActionOnFailure=CONTINUE,Args=[-files,s3://elasticmapreduce/samples/wordcount/wordSplitter.py,-mapper,wordSplitter.py,-reducer,aggregate,-input,s3://elasticmapreduce/samples/wordcount/input,-output,s3://mybucket/wordcount/output] \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +The following example uses a locally stored JSON configuration file named ``multiplefiles.json``. The JSON configuration specifies multiple files. To specify multiple files within a step, you must use a JSON configuration file to specify the step. + +Contents of ``multiplefiles.json``:: + + [ + { + "Name": "JSON Streaming Step", + "Args": [ + "-files", + "s3://elasticmapreduce/samples/wordcount/wordSplitter.py", + "-mapper", + "wordSplitter.py", + "-reducer", + "aggregate", + "-input", + "s3://elasticmapreduce/samples/wordcount/input", + "-output", + "s3://mybucket/wordcount/output" + ], + "ActionOnFailure": "CONTINUE", + "Type": "STREAMING" + } + ] + +NOTE: JSON arguments must include options and values as their own items in the list. + +Command:: + + aws emr create-cluster \ + --steps file://./multiplefiles.json \ + --release-label emr-5.9.0 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 19: To add Hive steps when creating a cluster** + +Command:: + + aws emr create-cluster \ + --steps Type=HIVE,Name='Hive program',ActionOnFailure=CONTINUE,ActionOnFailure=TERMINATE_CLUSTER,Args=[-f,s3://elasticmapreduce/samples/hive-ads/libs/model-build.q,-d,INPUT=s3://elasticmapreduce/samples/hive-ads/tables,-d,OUTPUT=s3://mybucket/hive-ads/output/2014-04-18/11-07-32,-d,LIBS=s3://elasticmapreduce/samples/hive-ads/libs] \ + --applications Name=Hive \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +Hive steps required parameters:: + + Type, Args + +Hive steps optional parameters:: + + Name, ActionOnFailure + +**Example 20: To add Pig steps when creating a cluster** + +Command:: + + aws emr create-cluster \ + --steps Type=PIG,Name='Pig program',ActionOnFailure=CONTINUE,Args=[-f,s3://elasticmapreduce/samples/pig-apache/do-reports2.pig,-p,INPUT=s3://elasticmapreduce/samples/pig-apache/input,-p,OUTPUT=s3://mybucket/pig-apache/output] \ + --applications Name=Pig \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large + +Pig steps required parameters:: + + Type, Args + +Pig steps optional parameters:: + + Name, ActionOnFailure + +**Example 21: To add bootstrap actions** + +The following ``create-cluster`` example runs two bootstrap actions defined as scripts that are stored in Amazon S3. :: + + aws emr create-cluster \ + --bootstrap-actions Path=s3://mybucket/myscript1,Name=BootstrapAction1,Args=[arg1,arg2] Path=s3://mybucket/myscript2,Name=BootstrapAction2,Args=[arg1,arg2] \ + --release-label emr-5.3.1 \ + --instance-groups InstanceGroupType=MASTER,InstanceCount=1,InstanceType=m4.large InstanceGroupType=CORE,InstanceCount=2,InstanceType=m4.large \ + --auto-terminate + +**Example 22: To enable EMRFS consistent view and customize the RetryCount and RetryPeriod settings** + +The following ``create-cluster`` example specifies the retry count and retry period for EMRFS consistent view. The ``Consistent=true`` argument is required. :: + + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --emrfs Consistent=true,RetryCount=6,RetryPeriod=30 + +The following example specifies the same EMRFS configuration as the previous example, using a locally stored JSON configuration file named ``emrfsconfig.json``. + +Contents of ``emrfsconfig.json``:: + + { + "Consistent": true, + "RetryCount": 6, + "RetryPeriod": 30 + } + +Command:: + + aws emr create-cluster \ + --instance-type m4.large \ + --release-label emr-5.9.0 \ + --emrfs file://emrfsconfig.json + +**Example 23: To create a cluster with Kerberos configured** + +The following ``create-cluster`` examples create a cluster using a security configuration with Kerberos enabled, and establishes Kerberos parameters for the cluster using ``--kerberos-attributes``. + +The following command specifies Kerberos attributes for the cluster inline. :: + + aws emr create-cluster \ + --instance-type m3.xlarge \ + --release-label emr-5.10.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --security-configuration mySecurityConfiguration \ + --kerberos-attributes Realm=EC2.INTERNAL,KdcAdminPassword=123,CrossRealmTrustPrincipalPassword=123 + +The following command specifies the same attributes, but references a locally stored JSON file named ``kerberos_attributes.json``. In this example, the file is saved in the same directory where you run the command. You can also reference a configuration file saved in Amazon S3. + +Contents of ``kerberos_attributes.json``:: + + { + "Realm": "EC2.INTERNAL", + "KdcAdminPassword": "123", + "CrossRealmTrustPrincipalPassword": "123", + } + +Command:: + + aws emr create-cluster \ + --instance-type m3.xlarge \ + --release-label emr-5.10.0 \ + --service-role EMR_DefaultRole \ + --ec2-attributes InstanceProfile=EMR_EC2_DefaultRole \ + --security-configuration mySecurityConfiguration \ + --kerberos-attributes file://kerberos_attributes.json diff --git a/aws/dist/awscli/examples/emr/create-cluster-synopsis.txt b/aws/dist/awscli/examples/emr/create-cluster-synopsis.txt new file mode 100644 index 00000000..4709f086 --- /dev/null +++ b/aws/dist/awscli/examples/emr/create-cluster-synopsis.txt @@ -0,0 +1,26 @@ + create-cluster + --release-label | --ami-version + --instance-fleets | --instance-groups | --instance-type --instance-count + [--auto-terminate | --no-auto-terminate] + [--use-default-roles] + [--service-role ] + [--configurations ] + [--name ] + [--log-uri ] + [--additional-info ] + [--ec2-attributes ] + [--termination-protected | --no-termination-protected] + [--scale-down-behavior ] + [--visible-to-all-users | --no-visible-to-all-users] + [--enable-debugging | --no-enable-debugging] + [--tags ] + [--applications ] + [--emrfs ] + [--bootstrap-actions ] + [--steps ] + [--restore-from-hbase-backup ] + [--security-configuration ] + [--custom-ami-id ] + [--ebs-root-volume-size ] + [--repo-upgrade-on-boot ] + [--kerberos-attributes ] diff --git a/aws/dist/awscli/examples/emr/create-default-roles.rst b/aws/dist/awscli/examples/emr/create-default-roles.rst new file mode 100644 index 00000000..8bef5695 --- /dev/null +++ b/aws/dist/awscli/examples/emr/create-default-roles.rst @@ -0,0 +1,141 @@ +**1. To create the default IAM role for EC2** + +- Command:: + + aws emr create-default-roles + +- Output:: + + If the role already exists then the command returns nothing. + + If the role does not exist then the output will be: + + [ + { + "RolePolicy": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "cloudwatch:*", + "dynamodb:*", + "ec2:Describe*", + "elasticmapreduce:Describe*", + "elasticmapreduce:ListBootstrapActions", + "elasticmapreduce:ListClusters", + "elasticmapreduce:ListInstanceGroups", + "elasticmapreduce:ListInstances", + "elasticmapreduce:ListSteps", + "kinesis:CreateStream", + "kinesis:DeleteStream", + "kinesis:DescribeStream", + "kinesis:GetRecords", + "kinesis:GetShardIterator", + "kinesis:MergeShards", + "kinesis:PutRecord", + "kinesis:SplitShard", + "rds:Describe*", + "s3:*", + "sdb:*", + "sns:*", + "sqs:*" + ], + "Resource": "*", + "Effect": "Allow" + } + ] + }, + "Role": { + "AssumeRolePolicyDocument": { + "Version": "2008-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "ec2.amazonaws.com" + } + } + ] + }, + "RoleId": "AROAIQ5SIQUGL5KMYBJX6", + "CreateDate": "2015-06-09T17:09:04.602Z", + "RoleName": "EMR_EC2_DefaultRole", + "Path": "/", + "Arn": "arn:aws:iam::176430881729:role/EMR_EC2_DefaultRole" + } + }, + { + "RolePolicy": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "ec2:AuthorizeSecurityGroupIngress", + "ec2:CancelSpotInstanceRequests", + "ec2:CreateSecurityGroup", + "ec2:CreateTags", + "ec2:DeleteTags", + "ec2:DescribeAvailabilityZones", + "ec2:DescribeAccountAttributes", + "ec2:DescribeInstances", + "ec2:DescribeInstanceStatus", + "ec2:DescribeKeyPairs", + "ec2:DescribePrefixLists", + "ec2:DescribeRouteTables", + "ec2:DescribeSecurityGroups", + "ec2:DescribeSpotInstanceRequests", + "ec2:DescribeSpotPriceHistory", + "ec2:DescribeSubnets", + "ec2:DescribeVpcAttribute", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeVpcEndpointServices", + "ec2:DescribeVpcs", + "ec2:ModifyImageAttribute", + "ec2:ModifyInstanceAttribute", + "ec2:RequestSpotInstances", + "ec2:RunInstances", + "ec2:TerminateInstances", + "iam:GetRole", + "iam:GetRolePolicy", + "iam:ListInstanceProfiles", + "iam:ListRolePolicies", + "iam:PassRole", + "s3:CreateBucket", + "s3:Get*", + "s3:List*", + "sdb:BatchPutAttributes", + "sdb:Select", + "sqs:CreateQueue", + "sqs:Delete*", + "sqs:GetQueue*", + "sqs:ReceiveMessage" + ], + "Resource": "*", + "Effect": "Allow" + } + ] + }, + "Role": { + "AssumeRolePolicyDocument": { + "Version": "2008-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "elasticmapreduce.amazonaws.com" + } + } + ] + }, + "RoleId": "AROAI3SRVPPVSRDLARBPY", + "CreateDate": "2015-06-09T17:09:10.401Z", + "RoleName": "EMR_DefaultRole", + "Path": "/", + "Arn": "arn:aws:iam::176430881729:role/EMR_DefaultRole" + } + } + ] diff --git a/aws/dist/awscli/examples/emr/create-security-configuration.rst b/aws/dist/awscli/examples/emr/create-security-configuration.rst new file mode 100644 index 00000000..cb9a8c50 --- /dev/null +++ b/aws/dist/awscli/examples/emr/create-security-configuration.rst @@ -0,0 +1,125 @@ +**1. To create a security configuration with in-transit encryption enabled with PEM for certificate provider, and at-rest encryption enabled with SSE-S3 for S3 encryption and AWS-KMS for local disk key provider** + +- Command:: + + aws emr create-security-configuration --name MySecurityConfig --security-configuration '{ + "EncryptionConfiguration": { + "EnableInTransitEncryption" : true, + "EnableAtRestEncryption" : true, + "InTransitEncryptionConfiguration" : { + "TLSCertificateConfiguration" : { + "CertificateProviderType" : "PEM", + "S3Object" : "s3://mycertstore/artifacts/MyCerts.zip" + } + }, + "AtRestEncryptionConfiguration" : { + "S3EncryptionConfiguration" : { + "EncryptionMode" : "SSE-S3" + }, + "LocalDiskEncryptionConfiguration" : { + "EncryptionKeyProviderType" : "AwsKms", + "AwsKmsKey" : "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" + } + } + } + }' + +- Output:: + + { + "CreationDateTime": 1474070889.129, + "Name": "MySecurityConfig" + } + +- JSON equivalent (contents of security_configuration.json):: + + { + "EncryptionConfiguration": { + "EnableInTransitEncryption": true, + "EnableAtRestEncryption": true, + "InTransitEncryptionConfiguration": { + "TLSCertificateConfiguration": { + "CertificateProviderType": "PEM", + "S3Object": "s3://mycertstore/artifacts/MyCerts.zip" + } + }, + "AtRestEncryptionConfiguration": { + "S3EncryptionConfiguration": { + "EncryptionMode": "SSE-S3" + }, + "LocalDiskEncryptionConfiguration": { + "EncryptionKeyProviderType": "AwsKms", + "AwsKmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012" + } + } + } + } + +- Command (using security_configuration.json):: + + aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json + +- Output:: + + { + "CreationDateTime": 1474070889.129, + "Name": "MySecurityConfig" + } + +**2. To create a security configuration with Kerberos enabled using cluster-dedicated KDC and cross-realm trust** + +- Command:: + + aws emr create-security-configuration --name MySecurityConfig --security-configuration '{ + "AuthenticationConfiguration": { + "KerberosConfiguration": { + "Provider": "ClusterDedicatedKdc", + "ClusterDedicatedKdcConfiguration": { + "TicketLifetimeInHours": 24, + "CrossRealmTrustConfiguration": { + "Realm": "AD.DOMAIN.COM", + "Domain": "ad.domain.com", + "AdminServer": "ad.domain.com", + "KdcServer": "ad.domain.com" + } + } + } + } + }' + +- Output:: + + { + "CreationDateTime": 1490225558.982, + "Name": "MySecurityConfig" + } + +- JSON equivalent (contents of security_configuration.json):: + + { + "AuthenticationConfiguration": { + "KerberosConfiguration": { + "Provider": "ClusterDedicatedKdc", + "ClusterDedicatedKdcConfiguration": { + "TicketLifetimeInHours": 24, + "CrossRealmTrustConfiguration": { + "Realm": "AD.DOMAIN.COM", + "Domain": "ad.domain.com", + "AdminServer": "ad.domain.com", + "KdcServer": "ad.domain.com" + } + } + } + } + } + +- Command (using security_configuration.json):: + + aws emr create-security-configuration --name "MySecurityConfig" --security-configuration file://./security_configuration.json + +- Output:: + + { + "CreationDateTime": 1490225558.982, + "Name": "MySecurityConfig" + } diff --git a/aws/dist/awscli/examples/emr/delete-security-configuration.rst b/aws/dist/awscli/examples/emr/delete-security-configuration.rst new file mode 100644 index 00000000..6669008e --- /dev/null +++ b/aws/dist/awscli/examples/emr/delete-security-configuration.rst @@ -0,0 +1,9 @@ +**To delete a security configuration in the current region** + +- Command:: + + aws emr delete-security-configuration --name MySecurityConfig + +- Output:: + + None diff --git a/aws/dist/awscli/examples/emr/describe-cluster.rst b/aws/dist/awscli/examples/emr/describe-cluster.rst new file mode 100644 index 00000000..1ff4c7b1 --- /dev/null +++ b/aws/dist/awscli/examples/emr/describe-cluster.rst @@ -0,0 +1,257 @@ +- Command:: + + aws emr describe-cluster --cluster-id j-XXXXXXXX + +- Output:: + + For release-label based uniform instance groups cluster: + + { + "Cluster": { + "Status": { + "Timeline": { + "ReadyDateTime": 1436475075.199, + "CreationDateTime": 1436474656.563, + }, + "State": "WAITING", + "StateChangeReason": { + "Message": "Waiting for steps to run" + } + }, + "Ec2InstanceAttributes": { + "ServiceAccessSecurityGroup": "sg-xxxxxxxx", + "EmrManagedMasterSecurityGroup": "sg-xxxxxxxx", + "IamInstanceProfile": "EMR_EC2_DefaultRole", + "Ec2KeyName": "myKey", + "Ec2AvailabilityZone": "us-east-1c", + "EmrManagedSlaveSecurityGroup": "sg-yyyyyyyyy" + }, + "Name": "My Cluster", + "ServiceRole": "EMR_DefaultRole", + "Tags": [], + "TerminationProtected": true, + "ReleaseLabel": "emr-4.0.0", + "NormalizedInstanceHours": 96, + "InstanceGroups": [ + { + "RequestedInstanceCount": 2, + "Status": { + "Timeline": { + "ReadyDateTime": 1436475074.245, + "CreationDateTime": 1436474656.564, + "EndDateTime": 1436638158.387 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "", + } + }, + "Name": "CORE", + "InstanceGroupType": "CORE", + "Id": "ig-YYYYYYY", + "Configurations": [], + "InstanceType": "m3.large", + "Market": "ON_DEMAND", + "RunningInstanceCount": 2 + }, + { + "RequestedInstanceCount": 1, + "Status": { + "Timeline": { + "ReadyDateTime": 1436475074.245, + "CreationDateTime": 1436474656.564, + "EndDateTime": 1436638158.387 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "", + } + }, + "Name": "MASTER", + "InstanceGroupType": "MASTER", + "Id": "ig-XXXXXXXXX", + "Configurations": [], + "InstanceType": "m3.large", + "Market": "ON_DEMAND", + "RunningInstanceCount": 1 + } + ], + "Applications": [ + { + "Name": "Hadoop" + } + ], + "VisibleToAllUsers": true, + "BootstrapActions": [], + "MasterPublicDnsName": "ec2-54-147-144-78.compute-1.amazonaws.com", + "AutoTerminate": false, + "Id": "j-XXXXXXXX", + "Configurations": [ + { + "Properties": { + "fs.s3.consistent.retryPeriodSeconds": "20", + "fs.s3.enableServerSideEncryption": "true", + "fs.s3.consistent": "false", + "fs.s3.consistent.retryCount": "2" + }, + "Classification": "emrfs-site" + } + ] + } + } + + + For release-label based instance fleet cluster: + { + "Cluster": { + "Status": { + "Timeline": { + "ReadyDateTime": 1487897289.705, + "CreationDateTime": 1487896933.942 + }, + "State": "WAITING", + "StateChangeReason": { + "Message": "Waiting for steps to run" + } + }, + "Ec2InstanceAttributes": { + "EmrManagedMasterSecurityGroup": "sg-xxxxx", + "RequestedEc2AvailabilityZones": [], + "RequestedEc2SubnetIds": [], + "IamInstanceProfile": "EMR_EC2_DefaultRole", + "Ec2AvailabilityZone": "us-east-1a", + "EmrManagedSlaveSecurityGroup": "sg-xxxxx" + }, + "Name": "My Cluster", + "ServiceRole": "EMR_DefaultRole", + "Tags": [], + "TerminationProtected": false, + "ReleaseLabel": "emr-5.2.0", + "NormalizedInstanceHours": 472, + "InstanceCollectionType": "INSTANCE_FLEET", + "InstanceFleets": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1487897212.74, + "CreationDateTime": 1487896933.948 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 1, + "Name": "MASTER", + "InstanceFleetType": "MASTER", + "LaunchSpecifications": { + "SpotSpecification": { + "TimeoutDurationMinutes": 60, + "TimeoutAction": "TERMINATE_CLUSTER" + } + }, + "TargetSpotCapacity": 1, + "ProvisionedOnDemandCapacity": 0, + "InstanceTypeSpecifications": [ + { + "BidPrice": "0.5", + "InstanceType": "m3.xlarge", + "WeightedCapacity": 1 + } + ], + "Id": "if-xxxxxxx", + "TargetOnDemandCapacity": 0 + } + ], + "Applications": [ + { + "Version": "2.7.3", + "Name": "Hadoop" + } + ], + "ScaleDownBehavior": "TERMINATE_AT_INSTANCE_HOUR", + "VisibleToAllUsers": true, + "BootstrapActions": [], + "MasterPublicDnsName": "ec2-xxx-xx-xxx-xx.compute-1.amazonaws.com", + "AutoTerminate": false, + "Id": "j-xxxxx", + "Configurations": [] + } + } + + For ami based uniform instance group cluster: + + { + "Cluster": { + "Status": { + "Timeline": { + "ReadyDateTime": 1399400564.432, + "CreationDateTime": 1399400268.62 + }, + "State": "WAITING", + "StateChangeReason": { + "Message": "Waiting for steps to run" + } + }, + "Ec2InstanceAttributes": { + "IamInstanceProfile": "EMR_EC2_DefaultRole", + "Ec2AvailabilityZone": "us-east-1c" + }, + "Name": "My Cluster", + "Tags": [], + "TerminationProtected": true, + "RunningAmiVersion": "2.5.4", + "InstanceGroups": [ + { + "RequestedInstanceCount": 1, + "Status": { + "Timeline": { + "ReadyDateTime": 1399400558.848, + "CreationDateTime": 1399400268.621 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "Name": "Master instance group", + "InstanceGroupType": "MASTER", + "InstanceType": "m1.small", + "Id": "ig-ABCD", + "Market": "ON_DEMAND", + "RunningInstanceCount": 1 + }, + { + "RequestedInstanceCount": 2, + "Status": { + "Timeline": { + "ReadyDateTime": 1399400564.439, + "CreationDateTime": 1399400268.621 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "Name": "Core instance group", + "InstanceGroupType": "CORE", + "InstanceType": "m1.small", + "Id": "ig-DEF", + "Market": "ON_DEMAND", + "RunningInstanceCount": 2 + } + ], + "Applications": [ + { + "Version": "1.0.3", + "Name": "hadoop" + } + ], + "BootstrapActions": [], + "VisibleToAllUsers": false, + "RequestedAmiVersion": "2.4.2", + "LogUri": "s3://myLogUri/", + "AutoTerminate": false, + "Id": "j-XXXXXXXX" + } + } diff --git a/aws/dist/awscli/examples/emr/describe-step.rst b/aws/dist/awscli/examples/emr/describe-step.rst new file mode 100644 index 00000000..97360420 --- /dev/null +++ b/aws/dist/awscli/examples/emr/describe-step.rst @@ -0,0 +1,34 @@ +The following command describes a step with the step ID ``s-3LZC0QUT43AM`` in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr describe-step --cluster-id j-3SD91U2E1L2QX --step-id s-3LZC0QUT43AM + +Output:: + + { + "Step": { + "Status": { + "Timeline": { + "EndDateTime": 1433200470.481, + "CreationDateTime": 1433199926.597, + "StartDateTime": 1433200404.959 + }, + "State": "COMPLETED", + "StateChangeReason": {} + }, + "Config": { + "Args": [ + "s3://us-west-2.elasticmapreduce/libs/hive/hive-script", + "--base-path", + "s3://us-west-2.elasticmapreduce/libs/hive/", + "--install-hive", + "--hive-versions", + "0.13.1" + ], + "Jar": "s3://us-west-2.elasticmapreduce/libs/script-runner/script-runner.jar", + "Properties": {} + }, + "Id": "s-3LZC0QUT43AM", + "ActionOnFailure": "TERMINATE_CLUSTER", + "Name": "Setup hive" + } + } diff --git a/aws/dist/awscli/examples/emr/get.rst b/aws/dist/awscli/examples/emr/get.rst new file mode 100644 index 00000000..89440a6b --- /dev/null +++ b/aws/dist/awscli/examples/emr/get.rst @@ -0,0 +1,3 @@ +The following downloads the ``hadoop-examples.jar`` archive from the master instance in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr get --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem --src /home/hadoop-examples.jar --dest ~ diff --git a/aws/dist/awscli/examples/emr/list-clusters.rst b/aws/dist/awscli/examples/emr/list-clusters.rst new file mode 100644 index 00000000..17ea7e40 --- /dev/null +++ b/aws/dist/awscli/examples/emr/list-clusters.rst @@ -0,0 +1,25 @@ +The following command lists all active EMR clusters in the current region:: + + aws emr list-clusters --active + +Output:: + + { + "Clusters": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1433200405.353, + "CreationDateTime": 1433199926.596 + }, + "State": "WAITING", + "StateChangeReason": { + "Message": "Waiting after step completed" + } + }, + "NormalizedInstanceHours": 6, + "Id": "j-3SD91U2E1L2QX", + "Name": "my-cluster" + } + ] + } diff --git a/aws/dist/awscli/examples/emr/list-instance-fleets.rst b/aws/dist/awscli/examples/emr/list-instance-fleets.rst new file mode 100644 index 00000000..cbf4352e --- /dev/null +++ b/aws/dist/awscli/examples/emr/list-instance-fleets.rst @@ -0,0 +1,68 @@ +**To get configuration details of instance fleets in a cluster** + +This example lists the details of instance fleets in the cluster specified. + +Command:: + + list-instance-fleets --cluster-id 'j-12ABCDEFGHI34JK' + +Output:: + + { + "InstanceFleets": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1488759094.637, + "CreationDateTime": 1488758719.817 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 6, + "Name": "CORE", + "InstanceFleetType": "CORE", + "LaunchSpecifications": { + "SpotSpecification": { + "TimeoutDurationMinutes": 60, + "TimeoutAction": "TERMINATE_CLUSTER" + } + }, + "ProvisionedOnDemandCapacity": 2, + "InstanceTypeSpecifications": [ + { + "BidPrice": "0.5", + "InstanceType": "m3.xlarge", + "WeightedCapacity": 2 + } + ], + "Id": "if-1ABC2DEFGHIJ3" + }, + { + "Status": { + "Timeline": { + "ReadyDateTime": 1488759058.598, + "CreationDateTime": 1488758719.811 + }, + "State": "RUNNING", + "StateChangeReason": { + "Message": "" + } + }, + "ProvisionedSpotCapacity": 0, + "Name": "MASTER", + "InstanceFleetType": "MASTER", + "ProvisionedOnDemandCapacity": 1, + "InstanceTypeSpecifications": [ + { + "BidPriceAsPercentageOfOnDemandPrice": 100.0, + "InstanceType": "m3.xlarge", + "WeightedCapacity": 1 + } + ], + "Id": "if-2ABC4DEFGHIJ4" + } + ] + } diff --git a/aws/dist/awscli/examples/emr/list-instances.rst b/aws/dist/awscli/examples/emr/list-instances.rst new file mode 100644 index 00000000..23f5b557 --- /dev/null +++ b/aws/dist/awscli/examples/emr/list-instances.rst @@ -0,0 +1,89 @@ +The following command lists all of the instances in a cluster with the cluster ID ``j-3C6XNQ39VR9WL``:: + + aws emr list-instances --cluster-id j-3C6XNQ39VR9WL + +Output:: + + For a uniform instance group based cluster + { + "Instances": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1433200400.03, + "CreationDateTime": 1433199960.152 + }, + "State": "RUNNING", + "StateChangeReason": {} + }, + "Ec2InstanceId": "i-f19ecfee", + "PublicDnsName": "ec2-52-52-41-150.us-west-2.compute.amazonaws.com", + "PrivateDnsName": "ip-172-21-11-216.us-west-2.compute.internal", + "PublicIpAddress": "52.52.41.150", + "Id": "ci-3NNHQUQ2TWB6Y", + "PrivateIpAddress": "172.21.11.216" + }, + { + "Status": { + "Timeline": { + "ReadyDateTime": 1433200400.031, + "CreationDateTime": 1433199949.102 + }, + "State": "RUNNING", + "StateChangeReason": {} + }, + "Ec2InstanceId": "i-1feee4c2", + "PublicDnsName": "ec2-52-63-246-32.us-west-2.compute.amazonaws.com", + "PrivateDnsName": "ip-172-31-24-130.us-west-2.compute.internal", + "PublicIpAddress": "52.63.246.32", + "Id": "ci-GAOCMKNKDCV7", + "PrivateIpAddress": "172.21.11.215" + }, + { + "Status": { + "Timeline": { + "ReadyDateTime": 1433200400.031, + "CreationDateTime": 1433199949.102 + }, + "State": "RUNNING", + "StateChangeReason": {} + }, + "Ec2InstanceId": "i-15cfeee3", + "PublicDnsName": "ec2-52-25-246-63.us-west-2.compute.amazonaws.com", + "PrivateDnsName": "ip-172-31-24-129.us-west-2.compute.internal", + "PublicIpAddress": "52.25.246.63", + "Id": "ci-2W3TDFFB47UAD", + "PrivateIpAddress": "172.21.11.214" + } + ] + } + + + For a fleet based cluster: + { + "Instances": [ + { + "Status": { + "Timeline": { + "ReadyDateTime": 1487810810.878, + "CreationDateTime": 1487810588.367, + "EndDateTime": 1488022990.924 + }, + "State": "TERMINATED", + "StateChangeReason": { + "Message": "Instance was terminated." + } + }, + "Ec2InstanceId": "i-xxxxx", + "InstanceFleetId": "if-xxxxx", + "EbsVolumes": [], + "PublicDnsName": "ec2-xx-xxx-xxx-xxx.compute-1.amazonaws.com", + "InstanceType": "m3.xlarge", + "PrivateDnsName": "ip-xx-xx-xxx-xx.ec2.internal", + "Market": "SPOT", + "PublicIpAddress": "xx.xx.xxx.xxx", + "Id": "ci-xxxxx", + "PrivateIpAddress": "10.47.191.80" + } + ] + } diff --git a/aws/dist/awscli/examples/emr/list-security-configurations.rst b/aws/dist/awscli/examples/emr/list-security-configurations.rst new file mode 100644 index 00000000..06d89e94 --- /dev/null +++ b/aws/dist/awscli/examples/emr/list-security-configurations.rst @@ -0,0 +1,21 @@ +**To list security configurations in the current region** + +Command:: + + aws emr list-security-configurations + +Output:: + + { + "SecurityConfigurations": [ + { + "CreationDateTime": 1473889697.417, + "Name": "MySecurityConfig-1" + }, + { + "CreationDateTime": 1473889697.417, + "Name": "MySecurityConfig-2" + } + ] + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/emr/list-steps.rst b/aws/dist/awscli/examples/emr/list-steps.rst new file mode 100644 index 00000000..f4a85a26 --- /dev/null +++ b/aws/dist/awscli/examples/emr/list-steps.rst @@ -0,0 +1,3 @@ +The following command lists all of the steps in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr list-steps --cluster-id j-3SD91U2E1L2QX diff --git a/aws/dist/awscli/examples/emr/modify-cluster-attributes.rst b/aws/dist/awscli/examples/emr/modify-cluster-attributes.rst new file mode 100644 index 00000000..f4696d81 --- /dev/null +++ b/aws/dist/awscli/examples/emr/modify-cluster-attributes.rst @@ -0,0 +1,3 @@ +The following command sets the visibility of an EMR cluster with the ID ``j-301CDNY0J5XM4`` to all users:: + + aws emr modify-cluster-attributes --cluster-id j-301CDNY0J5XM4 --visible-to-all-users diff --git a/aws/dist/awscli/examples/emr/modify-instance-fleet.rst b/aws/dist/awscli/examples/emr/modify-instance-fleet.rst new file mode 100644 index 00000000..a7154172 --- /dev/null +++ b/aws/dist/awscli/examples/emr/modify-instance-fleet.rst @@ -0,0 +1,7 @@ +**To change the target capacites of an instance fleet** + +This example changes the On-Demand and Spot target capacities to 1 for the instance fleet specified. + +Command:: + + aws emr modify-instance-fleet --cluster-id 'j-12ABCDEFGHI34JK' --instance-fleet InstanceFleetId='if-2ABC4DEFGHIJ4',TargetOnDemandCapacity=1,TargetSpotCapacity=1 diff --git a/aws/dist/awscli/examples/emr/put.rst b/aws/dist/awscli/examples/emr/put.rst new file mode 100644 index 00000000..5a44b4f5 --- /dev/null +++ b/aws/dist/awscli/examples/emr/put.rst @@ -0,0 +1,3 @@ +The following command uploads a file named ``healthcheck.sh`` to the master instance in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr put --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem --src ~/scripts/healthcheck.sh --dest /home/hadoop/bin/healthcheck.sh diff --git a/aws/dist/awscli/examples/emr/remove-tags.rst b/aws/dist/awscli/examples/emr/remove-tags.rst new file mode 100644 index 00000000..38c2c97a --- /dev/null +++ b/aws/dist/awscli/examples/emr/remove-tags.rst @@ -0,0 +1,3 @@ +The following command removes a tag with the key ``prod`` from a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr remove-tags --resource-id j-3SD91U2E1L2QX --tag-keys prod diff --git a/aws/dist/awscli/examples/emr/schedule-hbase-backup.rst b/aws/dist/awscli/examples/emr/schedule-hbase-backup.rst new file mode 100644 index 00000000..9f9d99de --- /dev/null +++ b/aws/dist/awscli/examples/emr/schedule-hbase-backup.rst @@ -0,0 +1,28 @@ +**Note: This command can only be used with HBase on AMI version 2.x and 3.x** + +**1. To schedule a full HBase backup** +>>>>>>> 06ab6d6e13564b5733d75abaf3b599f93cf39a23 + +- Command:: + + aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type full --dir + s3://myBucket/backup --interval 10 --unit hours --start-time + 2014-04-21T05:26:10Z --consistent + +- Output:: + + None + + +**2. To schedule an incremental HBase backup** + +- Command:: + + aws emr schedule-hbase-backup --cluster-id j-XXXXXXYY --type incremental + --dir s3://myBucket/backup --interval 30 --unit minutes --start-time + 2014-04-21T05:26:10Z --consistent + +- Output:: + + None + diff --git a/aws/dist/awscli/examples/emr/socks.rst b/aws/dist/awscli/examples/emr/socks.rst new file mode 100644 index 00000000..3ac8888e --- /dev/null +++ b/aws/dist/awscli/examples/emr/socks.rst @@ -0,0 +1,5 @@ +The following command opens a socks connection with the master instance in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr socks --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem + +The key pair file option takes a local path to a private key file. \ No newline at end of file diff --git a/aws/dist/awscli/examples/emr/ssh.rst b/aws/dist/awscli/examples/emr/ssh.rst new file mode 100644 index 00000000..2f609b73 --- /dev/null +++ b/aws/dist/awscli/examples/emr/ssh.rst @@ -0,0 +1,35 @@ +The following command opens an ssh connection with the master instance in a cluster with the cluster ID ``j-3SD91U2E1L2QX``:: + + aws emr ssh --cluster-id j-3SD91U2E1L2QX --key-pair-file ~/.ssh/mykey.pem + +The key pair file option takes a local path to a private key file. + +Output:: + + ssh -o StrictHostKeyChecking=no -o ServerAliveInterval=10 -i /home/local/user/.ssh/mykey.pem hadoop@ec2-52-52-41-150.us-west-2.compute.amazonaws.com + Warning: Permanently added 'ec2-52-52-41-150.us-west-2.compute.amazonaws.com,52.52.41.150' (ECDSA) to the list of known hosts. + Last login: Mon Jun 1 23:15:38 2015 + + __| __|_ ) + _| ( / Amazon Linux AMI + ___|\___|___| + + https://aws.amazon.com/amazon-linux-ami/2015.03-release-notes/ + 26 package(s) needed for security, out of 39 available + Run "sudo yum update" to apply all updates. + + -------------------------------------------------------------------------------- + + Welcome to Amazon Elastic MapReduce running Hadoop and Amazon Linux. + + Hadoop is installed in /home/hadoop. Log files are in /mnt/var/log/hadoop. Check + /mnt/var/log/hadoop/steps for diagnosing step failures. + + The Hadoop UI can be accessed via the following commands: + + ResourceManager lynx http://ip-172-21-11-216:9026/ + NameNode lynx http://ip-172-21-11-216:9101/ + + -------------------------------------------------------------------------------- + + [hadoop@ip-172-31-16-216 ~]$ diff --git a/aws/dist/awscli/examples/emr/wait.rst b/aws/dist/awscli/examples/emr/wait.rst new file mode 100644 index 00000000..dc1fbe74 --- /dev/null +++ b/aws/dist/awscli/examples/emr/wait.rst @@ -0,0 +1,3 @@ +The following command waits until a cluster with the cluster ID ``j-3SD91U2E1L2QX`` is up and running:: + + aws emr wait cluster-running --cluster-id j-3SD91U2E1L2QX diff --git a/aws/dist/awscli/examples/es/create-elasticsearch-domain.rst b/aws/dist/awscli/examples/es/create-elasticsearch-domain.rst new file mode 100644 index 00000000..80127177 --- /dev/null +++ b/aws/dist/awscli/examples/es/create-elasticsearch-domain.rst @@ -0,0 +1,53 @@ +The following ``create-elasticsearch-domain`` command creates a new Amazon Elasticsearch Service domain within a VPC and restricts access to a single user. Amazon ES infers the VPC ID from the specified subnet and security group IDs:: + + aws es create-elasticsearch-domain --domain-name vpc-cli-example --elasticsearch-version 6.2 --elasticsearch-cluster-config InstanceType=m4.large.elasticsearch,InstanceCount=1 --ebs-options EBSEnabled=true,VolumeType=standard,VolumeSize=10 --access-policies '{"Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": {"AWS": "arn:aws:iam::123456789012:root" }, "Action":"es:*", "Resource": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*" } ] }' --vpc-options SubnetIds=subnet-1a2a3a4a,SecurityGroupIds=sg-2a3a4a5a + +Output:: + + { + "DomainStatus": { + "ElasticsearchClusterConfig": { + "DedicatedMasterEnabled": false, + "InstanceCount": 1, + "ZoneAwarenessEnabled": false, + "InstanceType": "m4.large.elasticsearch" + }, + "DomainId": "123456789012/vpc-cli-example", + "CognitoOptions": { + "Enabled": false + }, + "VPCOptions": { + "SubnetIds": [ + "subnet-1a2a3a4a" + ], + "VPCId": "vpc-3a4a5a6a", + "SecurityGroupIds": [ + "sg-2a3a4a5a" + ], + "AvailabilityZones": [ + "us-west-1c" + ] + }, + "Created": true, + "Deleted": false, + "EBSOptions": { + "VolumeSize": 10, + "VolumeType": "standard", + "EBSEnabled": true + }, + "Processing": true, + "DomainName": "vpc-cli-example", + "SnapshotOptions": { + "AutomatedSnapshotStartHour": 0 + }, + "ElasticsearchVersion": "6.2", + "AccessPolicies": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":\"es:*\",\"Resource\":\"arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example/*\"}]}", + "AdvancedOptions": { + "rest.action.multi.allow_explicit_index": "true" + }, + "EncryptionAtRestOptions": { + "Enabled": false + }, + "ARN": "arn:aws:es:us-west-1:123456789012:domain/vpc-cli-example" + } + } diff --git a/aws/dist/awscli/examples/events/delete-rule.rst b/aws/dist/awscli/examples/events/delete-rule.rst new file mode 100644 index 00000000..32a8a927 --- /dev/null +++ b/aws/dist/awscli/examples/events/delete-rule.rst @@ -0,0 +1,5 @@ +**To delete a CloudWatch Events rule** + +This example deletes the rule named EC2InstanceStateChanges:: + + aws events delete-rule --name "EC2InstanceStateChanges" diff --git a/aws/dist/awscli/examples/events/describe-rule.rst b/aws/dist/awscli/examples/events/describe-rule.rst new file mode 100644 index 00000000..12e5644e --- /dev/null +++ b/aws/dist/awscli/examples/events/describe-rule.rst @@ -0,0 +1,5 @@ +**To display information about a CloudWatch Events rule** + +This example displays information about the rule named DailyLambdaFunction:: + + aws events describe-rule --name "DailyLambdaFunction" diff --git a/aws/dist/awscli/examples/events/disable-rule.rst b/aws/dist/awscli/examples/events/disable-rule.rst new file mode 100644 index 00000000..2ebb949c --- /dev/null +++ b/aws/dist/awscli/examples/events/disable-rule.rst @@ -0,0 +1,5 @@ +**To disable a CloudWatch Events rule** + +This example disables the rule named DailyLambdaFunction. The rule is not deleted:: + + aws events disable-rule --name "DailyLambdaFunction" diff --git a/aws/dist/awscli/examples/events/enable-rule.rst b/aws/dist/awscli/examples/events/enable-rule.rst new file mode 100644 index 00000000..d7ed4a97 --- /dev/null +++ b/aws/dist/awscli/examples/events/enable-rule.rst @@ -0,0 +1,5 @@ +**To enable a CloudWatch Events rule** + +This example enables the rule named DailyLambdaFunction, which had been previously disabled:: + + aws events enable-rule --name "DailyLambdaFunction" diff --git a/aws/dist/awscli/examples/events/list-rule-names-by-target.rst b/aws/dist/awscli/examples/events/list-rule-names-by-target.rst new file mode 100644 index 00000000..87b94dbc --- /dev/null +++ b/aws/dist/awscli/examples/events/list-rule-names-by-target.rst @@ -0,0 +1,5 @@ +**To display all the rules that have a specified target** + +This example displays all rules that have the Lambda function named "MyFunctionName" as the target:: + + aws events list-rule-names-by-target --target-arn "arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" diff --git a/aws/dist/awscli/examples/events/list-rules.rst b/aws/dist/awscli/examples/events/list-rules.rst new file mode 100644 index 00000000..da3decda --- /dev/null +++ b/aws/dist/awscli/examples/events/list-rules.rst @@ -0,0 +1,11 @@ +**To display a list of all CloudWatch Events rules** + +This example displays all CloudWatch Events rules in the region:: + + aws events list-rules + +**To display a list of CloudWatch Events rules beginning with a certain string.** + +This example displays all CloudWatch Events rules in the region that have a name starting with "Daily":: + + aws events list-rules --name-prefix "Daily" diff --git a/aws/dist/awscli/examples/events/list-targets-by-rule.rst b/aws/dist/awscli/examples/events/list-targets-by-rule.rst new file mode 100644 index 00000000..4b9589d6 --- /dev/null +++ b/aws/dist/awscli/examples/events/list-targets-by-rule.rst @@ -0,0 +1,5 @@ +**To display all the targets for a CloudWatch Events rule** + +This example displays all the targets of the rule named DailyLambdaFunction:: + + aws events list-targets-by-rule --rule "DailyLambdaFunction" diff --git a/aws/dist/awscli/examples/events/put-events.rst b/aws/dist/awscli/examples/events/put-events.rst new file mode 100644 index 00000000..8769fe56 --- /dev/null +++ b/aws/dist/awscli/examples/events/put-events.rst @@ -0,0 +1,28 @@ +**To send a custom event to CloudWatch Events** + +This example sends a custom event to CloudWatch Events. The event is contained within the putevents.json file:: + + aws events put-events --entries file://putevents.json + +Here are the contents of the putevents.json file:: + + [ + { + "Source": "com.mycompany.myapp", + "Detail": "{ \"key1\": \"value1\", \"key2\": \"value2\" }", + "Resources": [ + "resource1", + "resource2" + ], + "DetailType": "myDetailType" + }, + { + "Source": "com.mycompany.myapp", + "Detail": "{ \"key1\": \"value3\", \"key2\": \"value4\" }", + "Resources": [ + "resource1", + "resource2" + ], + "DetailType": "myDetailType" + } + ] diff --git a/aws/dist/awscli/examples/events/put-rule.rst b/aws/dist/awscli/examples/events/put-rule.rst new file mode 100644 index 00000000..ea699215 --- /dev/null +++ b/aws/dist/awscli/examples/events/put-rule.rst @@ -0,0 +1,13 @@ +**To create CloudWatch Events rules** + +This example creates a rule that triggers every day at 9:00am (UTC). If you use put-targets to add a Lambda function as a target of this rule, you could run the Lambda function every day at the specified time:: + + aws events put-rule --name "DailyLambdaFunction" --schedule-expression "cron(0 9 * * ? *)" + +This example creates a rule that triggers when any EC2 instance in the region changes state:: + + aws events put-rule --name "EC2InstanceStateChanges" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"]}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" + +This example creates a rule that triggers when any EC2 instance in the region is stopped or terminated:: + + aws events put-rule --name "EC2InstanceStateChangeStopOrTerminate" --event-pattern "{\"source\":[\"aws.ec2\"],\"detail-type\":[\"EC2 Instance State-change Notification\"],\"detail\":{\"state\":[\"stopped\",\"terminated\"]}}" --role-arn "arn:aws:iam::123456789012:role/MyRoleForThisRule" diff --git a/aws/dist/awscli/examples/events/put-targets.rst b/aws/dist/awscli/examples/events/put-targets.rst new file mode 100644 index 00000000..d233fade --- /dev/null +++ b/aws/dist/awscli/examples/events/put-targets.rst @@ -0,0 +1,13 @@ +**To add targets for CloudWatch Events rules** + +This example adds a Lambda function as the target of a rule:: + + aws events put-targets --rule DailyLambdaFunction --targets "Id"="1","Arn"="arn:aws:lambda:us-east-1:123456789012:function:MyFunctionName" + +This example sets an Amazon Kinesis stream as the target, so that events caught by this rule are relayed to the stream:: + + aws events put-targets --rule EC2InstanceStateChanges --targets "Id"="1","Arn"="arn:aws:kinesis:us-east-1:123456789012:stream/MyStream","RoleArn"="arn:aws:iam::123456789012:role/MyRoleForThisRule" + +This example sets two Amazon Kinesis streams as targets for one rule:: + + aws events put-targets --rule DailyLambdaFunction --targets "Id"="Target1","Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream1","RoleArn"="arn:aws:iam::379642911888:role/ MyRoleToAccessLambda" "Id"="Target2"," Arn"="arn:aws:kinesis:us-east-1:379642911888:stream/MyStream2","RoleArn"="arn:aws:iam::379642911888:role/MyRoleToAccessLambda" diff --git a/aws/dist/awscli/examples/events/remove-targets.rst b/aws/dist/awscli/examples/events/remove-targets.rst new file mode 100644 index 00000000..7b123d05 --- /dev/null +++ b/aws/dist/awscli/examples/events/remove-targets.rst @@ -0,0 +1,5 @@ +**To remove a target for an event** + +This example removes the Amazon Kinesis stream named MyStream1 from being a target of the rule DailyLambdaFunction. When DailyLambdaFunction was created, this stream was set as a target with an ID of Target1:: + + aws events remove-targets --rule "DailyLambdaFunction" --ids "Target1" diff --git a/aws/dist/awscli/examples/events/test-event-pattern.rst b/aws/dist/awscli/examples/events/test-event-pattern.rst new file mode 100644 index 00000000..86cb607b --- /dev/null +++ b/aws/dist/awscli/examples/events/test-event-pattern.rst @@ -0,0 +1,5 @@ +**To check whether an event pattern matches a specified event** + +This example tests whether the pattern "source:com.mycompany.myapp" matches the specified event. In this example, the output would be "true":: + + aws events test-event-pattern --event-pattern "{\"source\":[\"com.mycompany.myapp\"]}" --event "{\"id\":\"1\",\"source\":\"com.mycompany.myapp\",\"detail-type\":\"myDetailType\",\"account\":\"123456789012\",\"region\":\"us-east-1\",\"time\":\"2017-04-11T20:11:04Z\"}" diff --git a/aws/dist/awscli/examples/gamelift/create-fleet.rst b/aws/dist/awscli/examples/gamelift/create-fleet.rst new file mode 100644 index 00000000..f8263028 --- /dev/null +++ b/aws/dist/awscli/examples/gamelift/create-fleet.rst @@ -0,0 +1,160 @@ +**Example 1: To create a basic Linux fleet** + +The following ``create-fleet`` example creates a minimally configured fleet of on-demand Linux instances to host a custom server build. You can complete the configuration by using ``update-fleet``. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ + --certificate-configuration 'CertificateType=GENERATED' \ + --ec2-instance-type c4.large \ + --fleet-type ON_DEMAND \ + --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/release-na/MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' + +Output:: + + { + "FleetAttributes": { + "BuildId": "build-1111aaaa-22bb-33cc-44dd-5555eeee66ff", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "CreationTime": 1496365885.44, + "Description": "Hosts for v2 North America", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "ON_DEMAND", + "InstanceType": "c4.large", + "MetricGroups": ["default"], + "Name": "MegaFrogRace.NA.v2", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "AMAZON_LINUX", + "ServerLaunchPath": "/local/game/release-na/MegaFrogRace_Server.exe", + "Status": "NEW" + } + } + +**Example 2: To create a basic Windows fleet** + +The following ``create-fleet`` example creates a minimally configured fleet of spot Windows instances to host a custom server build. You can complete the configuration by using ``update-fleet``. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ + --certificate-configuration 'CertificateType=GENERATED' \ + --ec2-instance-type c4.large \ + --fleet-type SPOT \ + --runtime-configuration 'ServerProcesses=[{LaunchPath==C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}]' + +Output:: + + { + "FleetAttributes": { + "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "CreationTime": 1496365885.44, + "Description": "Hosts for v2 North America", + "FleetArn": "arn:aws:gamelift:us-west-2:444455556666:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "SPOT", + "InstanceType": "c4.large", + "MetricGroups": ["default"], + "Name": "MegaFrogRace.NA.v2", + "NewGameSessionProtectionPolicy": "NoProtection", + "OperatingSystem": "WINDOWS_2012", + "ServerLaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe", + "Status": "NEW" + } + } + +**Example 3: To create a fully configured fleet** + +The following ``create-fleet`` example creates a fleet of Spot Windows instances for a custom server build, with most commonly used configuration settings provided. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.v2 \ + --description 'Hosts for v2 North America' \ + --build-id build-2222aaaa-33bb-44cc-55dd-6666eeee77ff \ + --certificate-configuration 'CertificateType=GENERATED' \ + --ec2-instance-type c4.large \ + --ec2-inbound-permissions 'FromPort=33435,ToPort=33435,IpRange=10.24.34.0/23,Protocol=UDP' \ + --fleet-type SPOT \ + --new-game-session-protection-policy FullProtection \ + --runtime-configuration file://runtime-config.json \ + --metric-groups default \ + --instance-role-arn 'arn:aws:iam::444455556666:role/GameLiftS3Access' + +Contents of ``runtime-config.json``:: + + GameSessionActivationTimeoutSeconds=300, + MaxConcurrentGameSessionActivations=2, + ServerProcesses=[ + {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,Parameters=-debug,ConcurrentExecutions=1}, + {LaunchPath=C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe,ConcurrentExecutions=1}] + +Output:: + + { + "FleetAttributes": { + "InstanceRoleArn": "arn:aws:iam::123456789012:role/GameLiftS3Access", + "Status": "NEW", + "InstanceType": "c4.large", + "FleetArn": "arn:aws:gamelift:us-west-2:123456789012:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "Description": "Hosts for v2 North America", + "FleetType": "SPOT", + "OperatingSystem": "WINDOWS_2012", + "Name": "MegaFrogRace.NA.v2", + "CreationTime": 1569309011.11, + "MetricGroups": [ + "default" + ], + "BuildId": "build-2222aaaa-33bb-44cc-55dd-6666eeee77ff", + "ServerLaunchParameters": "abc", + "ServerLaunchPath": "C:\\game\\Bin64.Release.Dedicated\\MegaFrogRace_Server.exe", + "NewGameSessionProtectionPolicy": "FullProtection", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + } + } + } + +**Example 4: To create a Realtime Servers fleet** + +The following ``create-fleet`` example creates a fleet of Spot instances with a Realtime configuration script that has been uploaded to Amazon GameLift. All Realtime servers are deployed onto Linux machines. For the purposes of this example, assume that the uploaded Realtime script includes multiple script files, with the Init() function located in the script file called "MainScript.js". As shown, this file is identified as the launch script in the runtime configuration. :: + + aws gamelift create-fleet \ + --name MegaFrogRace.NA.realtime \ + --description 'Mega Frog Race Realtime fleet' \ + --script-id script-1111aaaa-22bb-33cc-44dd-5555eeee66ff \ + --ec2-instance-type c4.large \ + --fleet-type SPOT \ + --certificate-configuration 'CertificateType=GENERATED' \ + --runtime-configuration 'ServerProcesses=[{LaunchPath=/local/game/MainScript.js,Parameters=+map Winter444,ConcurrentExecutions=5}]' + +Output:: + + { + "FleetAttributes": { + "FleetId": "fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "Status": "NEW", + "CreationTime": 1569310745.212, + "InstanceType": "c4.large", + "NewGameSessionProtectionPolicy": "NoProtection", + "CertificateConfiguration": { + "CertificateType": "GENERATED" + }, + "Name": "MegaFrogRace.NA.realtime", + "ScriptId": "script-1111aaaa-22bb-33cc-44dd-5555eeee66ff", + "FleetArn": "arn:aws:gamelift:us-west-2:123456789012:fleet/fleet-2222bbbb-33cc-44dd-55ee-6666ffff77aa", + "FleetType": "SPOT", + "MetricGroups": [ + "default" + ], + "Description": "Mega Frog Race Realtime fleet", + "OperatingSystem": "AMAZON_LINUX" + } + } diff --git a/aws/dist/awscli/examples/glacier/abort-multipart-upload.rst b/aws/dist/awscli/examples/glacier/abort-multipart-upload.rst new file mode 100644 index 00000000..e3efd53d --- /dev/null +++ b/aws/dist/awscli/examples/glacier/abort-multipart-upload.rst @@ -0,0 +1,9 @@ +The following command deletes an in-progress multipart upload to a vault named ``my-vault``:: + + aws glacier abort-multipart-upload --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ + +This command does not produce any output. Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. The upload ID is returned by the ``aws glacier initiate-multipart-upload`` command and can also be obtained by using ``aws glacier list-multipart-uploads``. + +For more information on multipart uploads to Amazon Glacier using the AWS CLI, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/abort-vault-lock.rst b/aws/dist/awscli/examples/glacier/abort-vault-lock.rst new file mode 100644 index 00000000..dbc1b830 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/abort-vault-lock.rst @@ -0,0 +1,11 @@ +**To abort an in-progress vault lock process** + +The following ``abort-vault-lock`` example deletes a vault lock policy from the specified vault and resets the lock state of the vault lock to unlocked. :: + + aws glacier abort-vault-lock \ + --account-id - \ + --vault-name MyVaultName + +This command produces no output. + +For more information, see `Abort Vault Lock (DELETE lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff --git a/aws/dist/awscli/examples/glacier/add-tags-to-vault.rst b/aws/dist/awscli/examples/glacier/add-tags-to-vault.rst new file mode 100644 index 00000000..569e2556 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/add-tags-to-vault.rst @@ -0,0 +1,5 @@ +The following command adds two tags to a vault named ``my-vault``:: + + aws glacier add-tags-to-vault --account-id - --vault-name my-vault --tags id=1234,date=july2015 + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/complete-multipart-upload.rst b/aws/dist/awscli/examples/glacier/complete-multipart-upload.rst new file mode 100644 index 00000000..9987f84a --- /dev/null +++ b/aws/dist/awscli/examples/glacier/complete-multipart-upload.rst @@ -0,0 +1,11 @@ +The following command completes multipart upload for a 3 MiB archive:: + + aws glacier complete-multipart-upload --archive-size 3145728 --checksum 9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67 --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ --account-id - --vault-name my-vault + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +The upload ID is returned by the ``aws glacier initiate-multipart-upload`` command and can also be obtained by using ``aws glacier list-multipart-uploads``. The checksum parameter takes a SHA-256 tree hash of the archive in hexadecimal. + +For more information on multipart uploads to Amazon Glacier using the AWS CLI, including instructions on calculating a tree hash, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/complete-vault-lock.rst b/aws/dist/awscli/examples/glacier/complete-vault-lock.rst new file mode 100644 index 00000000..7e9e7441 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/complete-vault-lock.rst @@ -0,0 +1,12 @@ +**To complete an in-progress vault lock process** + +The following ``complete-vault-lock`` example completes the in-progress locking progress for the specified vault and sets the lock state of the vault lock to ``Locked``. You get the value for the ``lock-id`` parameter when you run ``initiate-lock-process``. :: + + aws glacier complete-vault-lock \ + --account-id - \ + --vault-name MyVaultName \ + --lock-id 9QZgEXAMPLEPhvL6xEXAMPLE + +This command produces no output. + +For more information, see `Complete Vault Lock (POST lockId) `__ in the *Amazon Glacier API Developer Guide*. diff --git a/aws/dist/awscli/examples/glacier/create-vault.rst b/aws/dist/awscli/examples/glacier/create-vault.rst new file mode 100644 index 00000000..e5efa191 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/create-vault.rst @@ -0,0 +1,5 @@ +The following command creates a new vault named ``my-vault``:: + + aws glacier create-vault --vault-name my-vault --account-id - + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/delete-vault.rst b/aws/dist/awscli/examples/glacier/delete-vault.rst new file mode 100644 index 00000000..1ba3cdb7 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/delete-vault.rst @@ -0,0 +1,5 @@ +The following command deletes a vault named ``my-vault``:: + + aws glacier delete-vault --vault-name my-vault --account-id - + +This command does not produce any output. Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/describe-job.rst b/aws/dist/awscli/examples/glacier/describe-job.rst new file mode 100644 index 00000000..d46a4d84 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/describe-job.rst @@ -0,0 +1,20 @@ +The following command retrieves information about an inventory retrieval job on a vault named ``my-vault``:: + + aws glacier describe-job --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW + +Output:: + + { + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "Completed": false, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "Action": "InventoryRetrieval", + "CreationDate": "2015-07-17T20:23:41.616Z", + "StatusCode": "InProgress" + } + +The job ID can be found in the output of ``aws glacier initiate-job`` and ``aws glacier list-jobs``. +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/describe-vault.rst b/aws/dist/awscli/examples/glacier/describe-vault.rst new file mode 100644 index 00000000..8181d7ec --- /dev/null +++ b/aws/dist/awscli/examples/glacier/describe-vault.rst @@ -0,0 +1,5 @@ +The following command retrieves data about a vault named ``my-vault``:: + + aws glacier describe-vault --vault-name my-vault --account-id - + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/get-data-retrieval-policy.rst b/aws/dist/awscli/examples/glacier/get-data-retrieval-policy.rst new file mode 100644 index 00000000..03c90223 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/get-data-retrieval-policy.rst @@ -0,0 +1,18 @@ +The following command gets the data retrieval policy for the in-use account:: + + aws glacier get-data-retrieval-policy --account-id - + +Output:: + + { + "Policy": { + "Rules": [ + { + "BytesPerHour": 10737418240, + "Strategy": "BytesPerHour" + } + ] + } + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/get-job-output.rst b/aws/dist/awscli/examples/glacier/get-job-output.rst new file mode 100644 index 00000000..67b29b3f --- /dev/null +++ b/aws/dist/awscli/examples/glacier/get-job-output.rst @@ -0,0 +1,17 @@ +The following command saves the output from a vault inventory job to a file in the current directory named ``output.json``:: + + aws glacier get-job-output --account-id - --vault-name my-vault --job-id zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW output.json + +The ``job-id`` is available in the output of ``aws glacier list-jobs``. Note that the output file name is a positional argument that is not prefixed by an option name. Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +Output:: + + { + "status": 200, + "acceptRanges": "bytes", + "contentType": "application/json" + } + +``output.json``:: + + {"VaultARN":"arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault","InventoryDate":"2015-04-07T00:26:18Z","ArchiveList":[{"ArchiveId":"kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw","ArchiveDescription":"multipart upload test","CreationDate":"2015-04-06T22:24:34Z","Size":3145728,"SHA256TreeHash":"9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67"}]} \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/get-vault-lock.rst b/aws/dist/awscli/examples/glacier/get-vault-lock.rst new file mode 100644 index 00000000..a86addc8 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/get-vault-lock.rst @@ -0,0 +1,17 @@ +**To get the details of a vault lock** + +The following ``get-vault-lock`` example retrieved the details about the lock for the specified vault. :: + + aws glacier get-vault-lock \ + --account-id - \ + --vault-name MyVaultName + +Output:: + + { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:99999999999:vaults/MyVaultName\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", + "State": "Locked", + "CreationDate": "2019-07-29T22:25:28.640Z" + } + +For more information, see `Get Vault Lock (GET lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff --git a/aws/dist/awscli/examples/glacier/get-vault-notifications.rst b/aws/dist/awscli/examples/glacier/get-vault-notifications.rst new file mode 100644 index 00000000..6808d3fc --- /dev/null +++ b/aws/dist/awscli/examples/glacier/get-vault-notifications.rst @@ -0,0 +1,17 @@ +The following command gets a description of the notification configuration for a vault named ``my-vault``:: + + aws glacier get-vault-notifications --account-id - --vault-name my-vault + +Output:: + + { + "vaultNotificationConfig": { + "Events": [ + "InventoryRetrievalCompleted", + "ArchiveRetrievalCompleted" + ], + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault" + } + } + +If no notifications have been configured for the vault, an error is returned. Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/initiate-job.rst b/aws/dist/awscli/examples/glacier/initiate-job.rst new file mode 100644 index 00000000..711c1cfa --- /dev/null +++ b/aws/dist/awscli/examples/glacier/initiate-job.rst @@ -0,0 +1,38 @@ +The following command initiates a job to get an inventory of the vault ``my-vault``:: + + aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters '{"Type": "inventory-retrieval"}' + +Output:: + + { + "location": "/0123456789012/vaults/my-vault/jobs/zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW" + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +The following command initiates a job to retrieve an archive from the vault ``my-vault``:: + + aws glacier initiate-job --account-id - --vault-name my-vault --job-parameters file://job-archive-retrieval.json + +``job-archive-retrieval.json`` is a JSON file in the local folder that specifies the type of job, archive ID, and some optional parameters:: + + { + "Type": "archive-retrieval", + "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "Description": "Retrieve archive on 2015-07-17", + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-topic" + } + +Archive IDs are available in the output of ``aws glacier upload-archive`` and ``aws glacier get-job-output``. + +Output:: + + { + "location": "/011685312445/vaults/mwunderl/jobs/l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", + "jobId": "l7IL5-EkXy2O5uLYaFdAYOiEY9Ws95fClzIbk-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav" + } + +See `Initiate Job`_ in the *Amazon Glacier API Reference* for details on the job parameters format. + +.. _`Initiate Job`: http://docs.aws.amazon.com/amazonglacier/latest/dev/api-initiate-job-post.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/initiate-multipart-upload.rst b/aws/dist/awscli/examples/glacier/initiate-multipart-upload.rst new file mode 100644 index 00000000..b2fd8feb --- /dev/null +++ b/aws/dist/awscli/examples/glacier/initiate-multipart-upload.rst @@ -0,0 +1,9 @@ +The following command initiates a multipart upload to a vault named ``my-vault`` with a part size of 1 MiB (1024 x 1024 bytes) per file:: + + aws glacier initiate-multipart-upload --account-id - --part-size 1048576 --vault-name my-vault --archive-description "multipart upload test" + +The archive description parameter is optional. Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +This command outputs an upload ID when successful. Use the upload ID when uploading each part of your archive with ``aws glacier upload-multipart-part``. For more information on multipart uploads to Amazon Glacier using the AWS CLI, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/initiate-vault-lock.rst b/aws/dist/awscli/examples/glacier/initiate-vault-lock.rst new file mode 100644 index 00000000..24333e64 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/initiate-vault-lock.rst @@ -0,0 +1,20 @@ +**To initiate the vault locking process** + +The following ``initiate-vault-lock`` example installs a vault lock policy on the specified vault and sets the lock state of the vault lock to ``InProgress``. You must complete the process by calling ``complete-vault-lock`` within 24 hours to set the state of the vault lock to ``Locked``. :: + + aws glacier initiate-vault-lock \ + --account-id - \ + --vault-name MyVaultName \ + --policy file://vault_lock_policy.json + +Contents of ``vault_lock_policy.json``:: + + {"Policy":"{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}"} + +The output is the vault lock ID that you can use to complete the vault lock process. :: + + { + "lockId": "9QZgEXAMPLEPhvL6xEXAMPLE" + } + +For more information, see `Initiate Vault Lock (POST lock-policy) `__ in the *Amazon Glacier API Developer Guide*. diff --git a/aws/dist/awscli/examples/glacier/list-jobs.rst b/aws/dist/awscli/examples/glacier/list-jobs.rst new file mode 100644 index 00000000..6ff97772 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/list-jobs.rst @@ -0,0 +1,38 @@ +The following command lists in-progress and recently completed jobs for a vault named ``my-vault``:: + + aws glacier list-jobs --account-id - --vault-name my-vault + +Output:: + + { + "JobList": [ + { + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "RetrievalByteRange": "0-3145727", + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", + "Completed": false, + "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", + "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "JobDescription": "Retrieve archive on 2015-07-17", + "ArchiveSizeInBytes": 3145728, + "Action": "ArchiveRetrieval", + "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "CreationDate": "2015-07-17T21:16:13.840Z", + "StatusCode": "InProgress" + }, + { + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "Completed": false, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "Action": "InventoryRetrieval", + "CreationDate": "2015-07-17T20:23:41.616Z", + "StatusCode": ""InProgress"" + } + ] + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/list-multipart-uploads.rst b/aws/dist/awscli/examples/glacier/list-multipart-uploads.rst new file mode 100644 index 00000000..c868b86a --- /dev/null +++ b/aws/dist/awscli/examples/glacier/list-multipart-uploads.rst @@ -0,0 +1,9 @@ +The following command shows all of the in-progress multipart uploads for a vault named ``my-vault``:: + + aws glacier list-multipart-uploads --account-id - --vault-name my-vault + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +For more information on multipart uploads to Amazon Glacier using the AWS CLI, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/list-parts.rst b/aws/dist/awscli/examples/glacier/list-parts.rst new file mode 100644 index 00000000..875fdcf1 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/list-parts.rst @@ -0,0 +1,28 @@ +The following command lists the uploaded parts for a multipart upload to a vault named ``my-vault``:: + + aws glacier list-parts --account-id - --vault-name my-vault --upload-id "SYZi7qnL-YGqGwAm8Kn3BLP2ElNCvnB-5961R09CSaPmPwkYGHOqeN_nX3-Vhnd2yF0KfB5FkmbnBU9GubbdrCs8ut-D" + +Output:: + + { + "MultipartUploadId": "SYZi7qnL-YGqGwAm8Kn3BLP2ElNCvnB-5961R09CSaPmPwkYGHOqeN_nX3-Vhnd2yF0KfB5FkmbnBU9GubbdrCs8ut-D", + "Parts": [ + { + "RangeInBytes": "0-1048575", + "SHA256TreeHash": "e1f2a7cd6e047350f69b9f8cfa60fa606fe2f02802097a9a026360a7edc1f553" + }, + { + "RangeInBytes": "1048576-2097151", + "SHA256TreeHash": "43cf3061fb95796aed99a11a6aa3cd8f839eed15e655ab0a597126210636aee6" + } + ], + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "CreationDate": "2015-07-18T00:05:23.830Z", + "PartSizeInBytes": 1048576 + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +For more information on multipart uploads to Amazon Glacier using the AWS CLI, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/list-tags-for-vault.rst b/aws/dist/awscli/examples/glacier/list-tags-for-vault.rst new file mode 100644 index 00000000..f884418b --- /dev/null +++ b/aws/dist/awscli/examples/glacier/list-tags-for-vault.rst @@ -0,0 +1,14 @@ +The following command lists the tags applied to a vault named ``my-vault``:: + + aws glacier list-tags-for-vault --account-id - --vault-name my-vault + +Output:: + + { + "Tags": { + "date": "july2015", + "id": "1234" + } + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/list-vaults.rst b/aws/dist/awscli/examples/glacier/list-vaults.rst new file mode 100644 index 00000000..8ec78fcf --- /dev/null +++ b/aws/dist/awscli/examples/glacier/list-vaults.rst @@ -0,0 +1,20 @@ +The following command lists the vaults in the default account and region:: + + aws glacier list-vaults --account-id - + +Output:: + + { + "VaultList": [ + { + "SizeInBytes": 3178496, + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "LastInventoryDate": "2015-04-07T00:26:19.028Z", + "VaultName": "my-vault", + "NumberOfArchives": 1, + "CreationDate": "2015-04-06T21:23:45.708Z" + } + ] + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/remove-tags-from-vault.rst b/aws/dist/awscli/examples/glacier/remove-tags-from-vault.rst new file mode 100644 index 00000000..78a60a4e --- /dev/null +++ b/aws/dist/awscli/examples/glacier/remove-tags-from-vault.rst @@ -0,0 +1,5 @@ +The following command removes a tag with the key ``date`` from a vault named ``my-vault``:: + + aws glacier remove-tags-from-vault --account-id - --vault-name my-vault --tag-keys date + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. diff --git a/aws/dist/awscli/examples/glacier/set-data-retrieval-policy.rst b/aws/dist/awscli/examples/glacier/set-data-retrieval-policy.rst new file mode 100644 index 00000000..522ca5c6 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/set-data-retrieval-policy.rst @@ -0,0 +1,24 @@ +The following command configures a data retrieval policy for the in-use account:: + + aws glacier set-data-retrieval-policy --account-id - --policy file://data-retrieval-policy.json + +``data-retrieval-policy.json`` is a JSON file in the current folder that specifies a data retrieval policy:: + + { + "Rules":[ + { + "Strategy":"BytesPerHour", + "BytesPerHour":10737418240 + } + ] + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +The following command sets the data retrieval policy to ``FreeTier`` using inline JSON:: + + aws glacier set-data-retrieval-policy --account-id - --policy '{"Rules":[{"Strategy":"FreeTier"}]}' + +See `Set Data Retrieval Policy`_ in the *Amazon Glacier API Reference* for details on the policy format. + +.. _`Set Data Retrieval Policy`: http://docs.aws.amazon.com/amazonglacier/latest/dev/api-SetDataRetrievalPolicy.html diff --git a/aws/dist/awscli/examples/glacier/set-vault-notifications.rst b/aws/dist/awscli/examples/glacier/set-vault-notifications.rst new file mode 100644 index 00000000..7b09972f --- /dev/null +++ b/aws/dist/awscli/examples/glacier/set-vault-notifications.rst @@ -0,0 +1,12 @@ +The following command configures SNS notifications for a vault named ``my-vault``:: + + aws glacier set-vault-notifications --account-id - --vault-name my-vault --vault-notification-config file://notificationconfig.json + +``notificationconfig.json`` is a JSON file in the current folder that specifies an SNS topic and the events to publish:: + + { + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", + "Events": ["ArchiveRetrievalCompleted", "InventoryRetrievalCompleted"] + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/upload-archive.rst b/aws/dist/awscli/examples/glacier/upload-archive.rst new file mode 100644 index 00000000..4bc1e704 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/upload-archive.rst @@ -0,0 +1,17 @@ +The following command uploads an archive in the current folder named ``archive.zip`` to a vault named ``my-vault``:: + + aws glacier upload-archive --account-id - --vault-name my-vault --body archive.zip + +Output:: + + { + "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", + "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw" + } + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +To retrieve an uploaded archive, initiate a retrieval job with the `aws glacier initiate-job`_ command. + +.. _`aws glacier initiate-job`: http://docs.aws.amazon.com/cli/latest/reference/glacier/initiate-job.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/glacier/upload-multipart-part.rst b/aws/dist/awscli/examples/glacier/upload-multipart-part.rst new file mode 100644 index 00000000..1748e582 --- /dev/null +++ b/aws/dist/awscli/examples/glacier/upload-multipart-part.rst @@ -0,0 +1,11 @@ +The following command uploads the first 1 MiB (1024 x 1024 bytes) part of an archive:: + + aws glacier upload-multipart-part --body part1 --range 'bytes 0-1048575/*' --account-id - --vault-name my-vault --upload-id 19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ + +Amazon Glacier requires an account ID argument when performing operations, but you can use a hyphen to specify the in-use account. + +The body parameter takes a path to a part file on the local filesystem. The range parameter takes an HTTP content range indicating the bytes that the part occupies in the completed archive. The upload ID is returned by the ``aws glacier initiate-multipart-upload`` command and can also be obtained by using ``aws glacier list-multipart-uploads``. + +For more information on multipart uploads to Amazon Glacier using the AWS CLI, see `Using Amazon Glacier`_ in the *AWS CLI User Guide*. + +.. _`Using Amazon Glacier`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-glacier.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/globalaccelerator/create-accelerator.rst b/aws/dist/awscli/examples/globalaccelerator/create-accelerator.rst new file mode 100644 index 00000000..2f910955 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/create-accelerator.rst @@ -0,0 +1,34 @@ +**To create an accelerator** + +The following ``create-accelerator`` example creates an accelerator. You must specify the ``US-West-2 (Oregon)`` Region to create or update an accelerator. :: + + aws globalaccelerator create-accelerator \ + --name ExampleAccelerator \ + --region us-west-2 \ + --idempotencytoken dcba4321-dcba-4321-dcba-dcba4321 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAccelerator", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "192.0.2.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1542394847.0, + "LastModifiedTime": 1542394847.0 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/create-endpoint-group.rst b/aws/dist/awscli/examples/globalaccelerator/create-endpoint-group.rst new file mode 100644 index 00000000..3ea3391e --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/create-endpoint-group.rst @@ -0,0 +1,28 @@ +**To create an endpoint group** + +The following ``create-endpoint-group`` example creates an endpoint group. :: + + aws globalaccelerator create-endpoint-group \ + --listener-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz \ + --endpoint-group-region us-east-1 \ + --endpoint-configurations EndpointId=eipalloc-eip01234567890abc,Weight=128 \ + --region us-west-2 \ + --idempotencytoken dcba4321-dcba-4321-dcba-dcba4321 + +Output:: + + { + "EndpointGroup": { + "TrafficDialPercentage": 100.0, + "EndpointDescriptions": [ + { + "Weight": 128, + "EndpointId": "eipalloc-eip01234567890abc" + } + ], + "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", + "EndpointGroupRegion": "us-east-1" + } + } + +For more information, see `Endpoint Groups in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/create-listener.rst b/aws/dist/awscli/examples/globalaccelerator/create-listener.rst new file mode 100644 index 00000000..f1cc97e4 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/create-listener.rst @@ -0,0 +1,32 @@ +**To create a listener** + +The following ``create-listener`` example creates a listener. :: + + aws globalaccelerator create-listener \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --port-ranges FromPort=80,ToPort=80 FromPort=81,ToPort=81 \ + --protocol TCP \ + --region us-west-2 \ + --idempotencytoken dcba4321-dcba-4321-dcba-dcba4321 + +Output:: + + { + "Listener": { + "PortRanges": [ + { + "ToPort": 80, + "FromPort": 80 + }, + { + "ToPort": 81, + "FromPort": 81 + } + ], + "ClientAffinity": "NONE", + "Protocol": "TCP", + "ListenerArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz" + } + } + +For more information, see `Listeners in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/describe-accelerator.rst b/aws/dist/awscli/examples/globalaccelerator/describe-accelerator.rst new file mode 100644 index 00000000..f3e88b48 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/describe-accelerator.rst @@ -0,0 +1,33 @@ +**To describe an accelerator** + +The following ``describe-accelerator`` example retrieves the details about an accelerator. :: + + aws globalaccelerator describe-accelerator \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --region us-west-2 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAaccelerator", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "192.0.2.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1542394847, + "LastModifiedTime": 1542395013 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/list-accelerators.rst b/aws/dist/awscli/examples/globalaccelerator/list-accelerators.rst new file mode 100644 index 00000000..d3d74d85 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/list-accelerators.rst @@ -0,0 +1,33 @@ +**To list your accelerators** + +The following ``list-accelerators`` example lists the accelerators available in your account. :: + + aws globalaccelerator list-accelerators + +Output:: + + { + "Accelerators": [ + { + "Name": "ExampleAccelerator", + "Enabled": true, + "DnsName": "a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1542394847.0, + "LastModifiedTime": 1542394847.0, + "Status": "DEPLOYED", + "IpAddressType": "IPV4", + "IpSets": [ + { + "IpFamily": "IPv4", + "IpAddresses": [ + "192.0.2.250", + "192.0.2.52" + ] + } + ], + "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh" + } + ] + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/update-accelerator.rst b/aws/dist/awscli/examples/globalaccelerator/update-accelerator.rst new file mode 100644 index 00000000..47020137 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/update-accelerator.rst @@ -0,0 +1,34 @@ +**To update an accelerator** + +The following ``update-accelerator`` example modifies an accelerator. You must specify the ``US-West-2 (Oregon)`` Region to create or update accelerators. :: + + aws globalaccelerator update-accelerator \ + --accelerator-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh \ + --name ExampleAcceleratorNew \ + --region us-west-2 + +Output:: + + { + "Accelerator": { + "AcceleratorArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh", + "IpAddressType": "IPV4", + "Name": "ExampleAcceleratorNew", + "Enabled": true, + "Status": "IN_PROGRESS", + "IpSets": [ + { + "IpAddresses": [ + "192.0.2.250", + "192.0.2.52" + ], + "IpFamily": "IPv4" + } + ], + "DnsName":"a1234567890abcdef.awsglobalaccelerator.com", + "CreatedTime": 1232394847, + "LastModifiedTime": 1232395654 + } + } + +For more information, see `Accelerators in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/globalaccelerator/update-endpoint-group.rst b/aws/dist/awscli/examples/globalaccelerator/update-endpoint-group.rst new file mode 100644 index 00000000..22f66401 --- /dev/null +++ b/aws/dist/awscli/examples/globalaccelerator/update-endpoint-group.rst @@ -0,0 +1,36 @@ +**To update an endpoint group** + +The following ``update-endpoint-group`` example updates an endpoint group. :: + + aws globalaccelerator update-endpoint-group \ + --endpoint-group-arn arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs \ + --endpoint-configurations \ + EndpointId=eipalloc-eip01234567890abc,Weight=128 \ + EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz,Weight=128 \ + EndpointId=arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs,Weight=128 + +Output:: + + { + "EndpointGroup": { + "TrafficDialPercentage": 100, + "EndpointDescriptions": [ + { + "Weight": 128, + "EndpointId": "eip01234567890abc" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/app/ALBTesting/alb01234567890xyz" + }, + { + "Weight": 128, + "EndpointId": "arn:aws:elasticloadbalancing:us-east-1:000123456789:loadbalancer/net/NLBTesting/alb01234567890qrs" + } + ], + "EndpointGroupArn": "arn:aws:globalaccelerator::123456789012:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/6789vxyz-vxyz-6789-vxyz-6789lmnopqrs/endpoint-group/4321abcd-abcd-4321-abcd-4321abcdefg", + "EndpointGroupRegion": "us-east-1" + } + } + +For more information, see `Endpoint Groups in AWS Global Accelerator `__ in the *AWS Global Accelerator Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/associate-role-to-group.rst b/aws/dist/awscli/examples/greengrass/associate-role-to-group.rst new file mode 100644 index 00000000..36cf4d06 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/associate-role-to-group.rst @@ -0,0 +1,15 @@ +**To associate a role with a Greengrass group** + +The following ``associate-role-to-group`` example associates the specified IAM role with a Greengrass group. The group role is used by local Lambda functions and connectors to access AWS services. For example, your group role might grant permissions required for CloudWatch Logs integration. :: + + aws greengrass associate-role-to-group \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b \ + --role-arn arn:aws:iam::123456789012:role/GG-Group-Role + +Output:: + + { + "AssociatedAt": "2019-09-10T20:03:30Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/associate-service-role-to-account.rst b/aws/dist/awscli/examples/greengrass/associate-service-role-to-account.rst new file mode 100644 index 00000000..72b07485 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/associate-service-role-to-account.rst @@ -0,0 +1,14 @@ +**To associate a service role with your AWS account** + +The following ``associate-service-role-to-account`` example associates an IAM service role, specified by its ARN, with AWS IoT Greengrass in your AWS account. You must have previously created the service role in IAM, and you must associate a policy document with it that allows AWS IoT Greengrass to assume this role. :: + + aws greengrass associate-service-role-to-account \ + --role-arn "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" + +Output:: + + { + "AssociatedAt": "2019-06-25T18:12:45Z" + } + +For more information, see `Greengrass Service Role `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-connector-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-connector-definition-version.rst new file mode 100644 index 00000000..846499e2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-connector-definition-version.rst @@ -0,0 +1,16 @@ +**To create a connector definition version** + +The following ``create-connector-definition-version`` example creates a connector definition version and associates it with the specified connector definition. All connectors in a version define values for their parameters. :: + + aws greengrass create-connector-definition-version \ + --connector-definition-id "55d0052b-0d7d-44d6-b56f-21867215e118" \ + --connectors "[{\"Id\": \"MyTwilioNotificationsConnector\", \"ConnectorArn\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/2\", \"Parameters\": {\"TWILIO_ACCOUNT_SID\": \"AC1a8d4204890840d7fc482aab38090d57\", \"TwilioAuthTokenSecretArn\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\", \"TwilioAuthTokenSecretArn-ResourceId\": \"TwilioAuthToken\", \"DefaultFromPhoneNumber\": \"4254492999\"}}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/33f709a0-c825-49cb-9eea-dc8964fbd635", + "CreationTimestamp": "2019-06-24T20:46:30.134Z", + "Id": "55d0052b-0d7d-44d6-b56f-21867215e118", + "Version": "33f709a0-c825-49cb-9eea-dc8964fbd635" + } diff --git a/aws/dist/awscli/examples/greengrass/create-connector-definition.rst b/aws/dist/awscli/examples/greengrass/create-connector-definition.rst new file mode 100644 index 00000000..b6d31db9 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-connector-definition.rst @@ -0,0 +1,21 @@ +**To create a connector definition** + +The following ``create-connector-definition`` example example creates a connector definition and an initial connector definition version. The initial version contains one connector. All connectors in a version define values for their parameters. :: + + aws greengrass create-connector-definition \ + --name MySNSConnector \ + --initial-version "{\"Connectors\": [{\"Id\":\"MySNSConnector\",\"ConnectorArn\":\"arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1\",\"Parameters\": {\"DefaultSNSArn\":\"arn:aws:sns:us-west-2:123456789012:GGConnectorTopic\"}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector" + } + +For more information, see `Getting Started with Greengrass Connectors (CLI) `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/create-core-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-core-definition-version.rst new file mode 100644 index 00000000..4901ce6d --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-core-definition-version.rst @@ -0,0 +1,84 @@ +**To create a core definition version** + +The following ``create-core-definition-version`` example creates a core definition version and associates it with the specified core definition. The version can contain one core only. Before you can create a core, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands, which return the ``ThingArn`` and ``CertificateArn`` required for the ``create-core-definition-version`` command. + +* Create the AWS IoT thing that corresponds to the core device:: + + aws iot create-thing \ + --thing-name "MyCoreDevice" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", + "thingName": "MyCoreDevice", + "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" + } + +* Create public and private keys and the core device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command. :: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myCore.cert.pem" \ + --public-key-outfile "myCore.public.key" \ + --private-key-outfile "myCore.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy should be more restrictive. :: + + aws iot create-policy \ + --policy-name "Core_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "Core_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "Core_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Attach the thing to the certificate:: + + aws iot attach-thing-principal \ + --thing-name "MyCoreDevice" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Create the core definition version:: + + aws greengrass create-core-definition-version \ + --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ + --cores "[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/3fdc1190-2ce5-44de-b98b-eec8f9571014", + "Version": "3fdc1190-2ce5-44de-b98b-eec8f9571014", + "CreationTimestamp": "2019-09-18T00:15:09.838Z", + "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12" + } + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-core-definition.rst b/aws/dist/awscli/examples/greengrass/create-core-definition.rst new file mode 100644 index 00000000..49d6c910 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-core-definition.rst @@ -0,0 +1,104 @@ +**Example 1: To create an empty core definition** + +The following ``create-core-definition`` example creates an empty (no initial version) Greengrass core definition. Before the core is usable, you must use the ``create-core-definition-version`` command to provide the other parameters for the core. :: + + aws greengrass create-core-definition \ + --name cliGroup_Core + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/b5c08008-54cb-44bd-9eec-c121b04283b5", + "CreationTimestamp": "2019-06-25T18:23:22.106Z", + "Id": "b5c08008-54cb-44bd-9eec-c121b04283b5", + "LastUpdatedTimestamp": "2019-06-25T18:23:22.106Z", + "Name": "cliGroup_Core" + } + +**Example 2: To create a core definition with an initial version** + +The following ``create-core-definition`` example creates a core definition that contains an initial core definition version. The version can contain one core only. Before you can create a core, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands, which return the ``ThingArn`` and ``CertificateArn`` required for the ``create-core-definition`` command. + +* Create the AWS IoT thing that corresponds to the core device:: + + aws iot create-thing \ + --thing-name "MyCoreDevice" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice", + "thingName": "MyCoreDevice", + "thingId": "cb419a19-9099-4515-9cec-e9b0e760608a" + } + +* Create public and private keys and the core device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command. :: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myCore.cert.pem" \ + --public-key-outfile "myCore.public.key" \ + --private-key-outfile "myCore.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy should be more restrictive. :: + + aws iot create-policy \ + --policy-name "Core_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "Core_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/Core_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "Core_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Attach the thing to the certificate:: + + aws iot attach-thing-principal \ + --thing-name "MyCoreDevice" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz" + +This command produces no output. + +* Create the core definition:: + + aws greengrass create-core-definition \ + --name "MyCores" \ + --initial-version "{\"Cores\":[{\"Id\":\"MyCoreDevice\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/MyCoreDevice\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/123a15ec415668c2349a76170b64ac0878231c1e21ec83c10e92a1EXAMPLExyz\",\"SyncShadow\":true}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12/versions/cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", + "Name": "MyCores", + "LastUpdatedTimestamp": "2019-09-18T00:11:06.197Z", + "LatestVersion": "cc87b5b3-8f4b-465d-944c-1d6de5dbfcdb", + "CreationTimestamp": "2019-09-18T00:11:06.197Z", + "Id": "582efe12-b05a-409e-9a24-a2ba1bcc4a12", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/582efe12-b05a-409e-9a24-a2ba1bcc4a12" + } + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-deployment.rst b/aws/dist/awscli/examples/greengrass/create-deployment.rst new file mode 100644 index 00000000..4fad72c0 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-deployment.rst @@ -0,0 +1,17 @@ +**To create a deployment for a version of a Greengrass group** + +The following ``create-deployment`` example deploys the specified version of a Greengrass group. :: + + aws greengrass create-deployment \ + --deployment-type NewDeployment \ + --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ + --group-version-id "dc40c1e9-e8c8-4d28-a84d-a9cad5f599c9" + +Output:: + + { + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/deployments/bfceb608-4e97-45bc-af5c-460144270308", + "DeploymentId": "bfceb608-4e97-45bc-af5c-460144270308" + } + +For more information, see `Getting Started with Connectors (CLI) `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-device-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-device-definition-version.rst new file mode 100644 index 00000000..2102be1a --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-device-definition-version.rst @@ -0,0 +1,79 @@ +**To create a device definition version** + +The following ``create-device-definition-version`` example creates a device definition version and associates it with the specified device definition. The version defines two devices. +Before you can create a Greengrass device, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands that you must run to get the required information for the Greengrass command: + +* Create the AWS IoT thing that corresponds to the device:: + + aws iot create-thing \ + --thing-name "InteriorTherm" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "thingName": "InteriorTherm", + "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" + } + +* Create public and private keys and the device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command:: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myDevice.cert.pem" \ + --public-key-outfile "myDevice.public.key" \ + --private-key-outfile "myDevice.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy can be more restrictive:: + + aws iot create-policy \ + --policy-name "GG_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "GG_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "GG_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +* Attach the thing to the certificate :: + + aws iot attach-thing-principal \ + --thing-name "InteriorTherm" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +After you create and configure the IoT thing as shown above, use the ``ThingArn`` and ``CertificateArn`` from the first two commands in the following example. :: + + aws greengrass create-device-definition-version \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --devices "[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff --git a/aws/dist/awscli/examples/greengrass/create-device-definition.rst b/aws/dist/awscli/examples/greengrass/create-device-definition.rst new file mode 100644 index 00000000..1a55cc43 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-device-definition.rst @@ -0,0 +1,82 @@ +**To create a device definition** + +The following ``create-device-definition`` example creates a device definition that contains an initial device definition version. The initial version defines two devices. +Before you can create a Greengrass device, you must first create and provision the corresponding AWS IoT thing. This process includes the following ``iot`` commands that you must run to get the required information for the Greengrass command: + +* Create the AWS IoT thing that corresponds to the device:: + + aws iot create-thing \ + --thing-name "InteriorTherm" + +Output:: + + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "thingName": "InteriorTherm", + "thingId": "01d4763c-78a6-46c6-92be-7add080394bf" + } + +* Create public and private keys and the device certificate for the thing. This example uses the ``create-keys-and-certificate`` command and requires write permissions to the current directory. Alternatively, you can use the ``create-certificate-from-csr`` command:: + + aws iot create-keys-and-certificate \ + --set-as-active \ + --certificate-pem-outfile "myDevice.cert.pem" \ + --public-key-outfile "myDevice.public.key" \ + --private-key-outfile "myDevice.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIIDWTCAkGgAwIBATgIUCgq6EGqou6zFqWgIZRndgQEFW+gwDQYJKoZIhvc...KdGewQS\n-----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBzrqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAqKpRgnn6yq26U3y...wIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIABAKCAQEAqKpRgnn6yq26U3yt5YFZquyukfRjbMXDcNOK4rMCxDR...fvY4+te\n-----END RSA PRIVATE KEY-----\n" + }, + "certificateId": "66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + } + +* Create an AWS IoT policy that allows ``iot`` and ``greengrass`` actions. For simplicity, the following policy allows actions on all resources, but your policy can be more restrictive:: + + aws iot create-policy \ + --policy-name "GG_Devices" \ + --policy-document "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}" + +Output:: + + { + "policyName": "GG_Devices", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/GG_Devices", + "policyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"iot:Publish\",\"iot:Subscribe\",\"iot:Connect\",\"iot:Receive\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"iot:GetThingShadow\",\"iot:UpdateThingShadow\",\"iot:DeleteThingShadow\"],\"Resource\":[\"*\"]},{\"Effect\":\"Allow\",\"Action\":[\"greengrass:*\"],\"Resource\":[\"*\"]}]}", + "policyVersionId": "1" + } + +* Attach the policy to the certificate:: + + aws iot attach-policy \ + --policy-name "GG_Devices" \ + --target "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +* Attach the thing to the certificate :: + + aws iot attach-thing-principal \ + --thing-name "InteriorTherm" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92" + +After you create and configure the IoT thing as shown above, use the ``ThingArn`` and ``CertificateArn`` from the first two commands in the following example. :: + + aws greengrass create-device-definition \ + --name "Sensors" \ + --initial-version "{\"Devices\":[{\"Id\":\"InteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92\",\"SyncShadow\":true},{\"Id\":\"ExteriorTherm\",\"ThingArn\":\"arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm\",\"CertificateArn\":\"arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02\",\"SyncShadow\":true}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "Name": "Sensors", + "LastUpdatedTimestamp": "2019-09-11T00:11:06.197Z", + "LatestVersion": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff --git a/aws/dist/awscli/examples/greengrass/create-function-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-function-definition-version.rst new file mode 100644 index 00000000..5023848a --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-function-definition-version.rst @@ -0,0 +1,15 @@ +**To create a version of the function defintion** + +The following ``create-function-definition-version`` example creates a new version of the specified function definition. This version specifies a single function whose ID is ``Hello-World-function``, allows access to the file system, and specifies a maximum memory size and timeout period. :: + + aws greengrass create-function-definition-version \ + --cli-input-json "{\"FunctionDefinitionId\": \"e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3\",\"Functions\": [{\"Id\": \"Hello-World-function\", \"FunctionArn\": \""arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld_Counter:gghw-alias"\",\"FunctionConfiguration\": {\"Environment\": {\"AccessSysfs\": true},\"Executable\": \"greengrassHelloWorldCounter.function_handler\",\"MemorySize\": 16000,\"Pinned\": false,\"Timeout\": 25}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3/versions/74abd1cc-637e-4abe-8684-9a67890f4043", + "CreationTimestamp": "2019-06-25T22:03:43.376Z", + "Id": "e626e8c9-3b8f-4bf3-9cdc-d26ecdeb9fa3", + "Version": "74abd1cc-637e-4abe-8684-9a67890f4043" + } diff --git a/aws/dist/awscli/examples/greengrass/create-function-definition.rst b/aws/dist/awscli/examples/greengrass/create-function-definition.rst new file mode 100644 index 00000000..4716b31c --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-function-definition.rst @@ -0,0 +1,21 @@ +**To create a Lambda function definition** + +The following ``create-function-definition`` example creates a Lambda function definition and an initial version by providing a list of Lambda functions (in this case, a list of just one function named ``TempMonitorFunction``) and their configurations. Before you can create the function definition, you need the Lambda function ARN. To create the function and its alias, use Lambda's ``create-function`` and ``publish-version`` commands. Lambda's ``create-function`` command requires the ARN of the execution role, even though AWS IoT Greengrass doesn't use that role because permissions are specified in the Greengrass group role. You can use the IAM ``create-role`` command to create an empty role to get an ARN to use with Lambda's ``create-function`` or you can use an existing execution role. :: + + aws greengrass create-function-definition \ + --name MyGreengrassFunctions \ + --initial-version "{\"Functions\": [{\"Id\": \"TempMonitorFunction\", \"FunctionArn\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"FunctionConfiguration\": {\"Executable\": \"temp_monitor.function_handler\", \"MemorySize\": 16000,\"Timeout\": 5}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b", + "CreationTimestamp": "2019-06-19T22:24:44.585Z", + "Id": "3b0d0080-87e7-48c6-b182-503ec743a08b", + "LastUpdatedTimestamp": "2019-06-19T22:24:44.585Z", + "LatestVersion": "67f918b9-efb4-40b0-b87c-de8c9faf085b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b", + "Name": "MyGreengrassFunctions" + } + +For more information, see `How to Configure Local Resource Access Using the AWS Command Line Interface `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-group-certificate-authority.rst b/aws/dist/awscli/examples/greengrass/create-group-certificate-authority.rst new file mode 100644 index 00000000..aeb02b14 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-group-certificate-authority.rst @@ -0,0 +1,14 @@ +**To create a certificate authority (CA) for a group** + +The following ``create-group-certificate-authority`` example creates or rotates a CA for the specified group. :: + + aws greengrass create-group-certificate-authority \ + --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" + +Output:: + + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/8eaadd72-ce4b-4f15-892a-0cc4f3a343f1/certificateauthorities/d31630d674c4437f6c5dbc0dca56312a902171ce2d086c38e509c8EXAMPLEcc5" + } + +For more information, see `AWS IoT Greengrass Security `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-group-version.rst b/aws/dist/awscli/examples/greengrass/create-group-version.rst new file mode 100644 index 00000000..52730d05 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-group-version.rst @@ -0,0 +1,32 @@ +**To create a version of a Greengrass group** + +The following ``create-group-version`` example creates a group version and associates it with the specified group. The version references the core, resource, connector, function, and subscription versions that contain the entities to include in this group version. You must create these entities before you can create the group version. + +* To create a resource definition with an initial version, use the ``create-resource-definition`` command. + +* To create a connector definition with an initial version, use the ``create-connector-definition`` command. + +* To create a function definition with an initial version, use the ``create-function-definition`` command. + +* To create a subscription definition with an initial version, use the ``create-subscription-definition`` command. + +* To retrieve the ARN of the latest core definition version, use the ``get-group-version`` command and specify the ID of the latest group version. :: + + aws greengrass create-group-version \ + --group-id "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca" \ + --core-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/6a630442-8708-4838-ad36-eb98849d975e/versions/6c87151b-1fb4-4cb2-8b31-6ee715d8f8ba" \ + --resource-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1" \ + --connector-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/55d0052b-0d7d-44d6-b56f-21867215e118/versions/78a3331b-895d-489b-8823-17b4f9f418a0" \ + --function-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/3b0d0080-87e7-48c6-b182-503ec743a08b/versions/67f918b9-efb4-40b0-b87c-de8c9faf085b" \ + --subscription-definition-version-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca/versions/e10b0459-4345-4a09-88a4-1af1f5d34638", + "CreationTimestamp": "2019-06-20T18:42:47.020Z", + "Id": "ce2e7d01-3240-4c24-b8e6-f6f6e7a9eeca", + "Version": "e10b0459-4345-4a09-88a4-1af1f5d34638" + } + +For more information, see `Overview of the AWS IoT Greengrass Group Object Model `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-group.rst b/aws/dist/awscli/examples/greengrass/create-group.rst new file mode 100644 index 00000000..9350e1a6 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-group.rst @@ -0,0 +1,16 @@ +**To create a Greeengrass group** + +The following ``create-group`` example creates a group named ``cli-created-group``. :: + + aws greengrass create-group \ + cli-created-group + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/4e22bd92-898c-436b-ade5-434d883ff749", + "CreationTimestamp": "2019-06-25T18:07:17.688Z", + "Id": "4e22bd92-898c-436b-ade5-434d883ff749", + "LastUpdatedTimestamp": "2019-06-25T18:07:17.688Z", + "Name": "cli-created-group" + } diff --git a/aws/dist/awscli/examples/greengrass/create-logger-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-logger-definition-version.rst new file mode 100644 index 00000000..0f7431dd --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-logger-definition-version.rst @@ -0,0 +1,18 @@ +**To create a logger definition version** + +The following ``create-logger-definition-version`` example creates a logger definition version and associates it with a logger definition. The version defines four logging configurations: 1) system component logs on the file system of the core device, 2) user-defined Lambda function logs on the file system of the core device, 3) system component logs in Amazon CloudWatch Logs, and 4) user-defined Lambda function logs in Amazon CloudWatch Logs. Note: For CloudWatch Logs integration, your group role must grant appropriate permissions. :: + + aws greengrass create-logger-definition-version \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ + --loggers "[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"GreengrassSystem\",\"Level\":\"WARN\",\"Type\":\"AWSCloudWatch\"},{\"Id\":\"4\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/49aedb1e-01a3-4d39-9871-3a052573f1ea", + "Version": "49aedb1e-01a3-4d39-9871-3a052573f1ea", + "CreationTimestamp": "2019-07-24T00:04:48.523Z", + "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + } + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-logger-definition.rst b/aws/dist/awscli/examples/greengrass/create-logger-definition.rst new file mode 100644 index 00000000..c3cbacd3 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-logger-definition.rst @@ -0,0 +1,21 @@ +**To create a logger definition** + +The following ``create-logger-definition`` example creates a logger definition that contains an initial logger definition version. The initial version defines three logging configurations: 1) system component logs on the file system of the core device, 2) user-defined Lambda function logs on the file system of the core device, and 3) user-defined Lambda function logs in Amazon CloudWatch Logs. Note: For CloudWatch Logs integration, your group role must grant appropriate permissions. :: + + aws greengrass create-logger-definition \ + --name "LoggingConfigs" \ + --initial-version "{\"Loggers\":[{\"Id\":\"1\",\"Component\":\"GreengrassSystem\",\"Level\":\"ERROR\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"2\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Space\":10240,\"Type\":\"FileSystem\"},{\"Id\":\"3\",\"Component\":\"Lambda\",\"Level\":\"INFO\",\"Type\":\"AWSCloudWatch\"}]}" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0/versions/de1d9854-1588-4525-b25e-b378f60f2322", + "Name": "LoggingConfigs", + "LastUpdatedTimestamp": "2019-07-23T23:52:17.165Z", + "LatestVersion": "de1d9854-1588-4525-b25e-b378f60f2322", + "CreationTimestamp": "2019-07-23T23:52:17.165Z", + "Id": "a454b62a-5d56-4ca9-bdc4-8254e1662cb0", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + } + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-resource-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-resource-definition-version.rst new file mode 100644 index 00000000..7b43e154 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-resource-definition-version.rst @@ -0,0 +1,16 @@ +**To create a version of a resource definition** + +The following ``create-resource-definition-version`` example creates a new version of a TwilioAuthToken. :: + + aws greengrass create-resource-definition-version \ + --resource-definition-id "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38" \ + --resources "[{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/b3bcada0-5fb6-42df-bf0b-1ee4f15e769e", + "CreationTimestamp": "2019-06-24T21:17:25.623Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "Version": "b3bcada0-5fb6-42df-bf0b-1ee4f15e769e" + } diff --git a/aws/dist/awscli/examples/greengrass/create-resource-definition.rst b/aws/dist/awscli/examples/greengrass/create-resource-definition.rst new file mode 100644 index 00000000..b8d5c32a --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-resource-definition.rst @@ -0,0 +1,21 @@ +**To create a resource definition** + +The following ``create-resource-definition`` example creates a resource definition that contains a list of resources to be used in a Greengrass group. In this example, an initial version of the resource definition is included by providing a list of resources. The list includes one resource for a Twilio authorization token and the ARN for a secret stored in AWS Secrets Manager. You must create the secret before you can create the resource definition. :: + + aws greengrass create-resource-definition \ + --name MyGreengrassResources \ + --initial-version "{\"Resources\": [{\"Id\": \"TwilioAuthToken\",\"Name\": \"MyTwilioAuthToken\",\"ResourceDataContainer\": {\"SecretsManagerSecretResourceData\": {\"ARN\": \"arn:aws:secretsmanager:us-west-2:123456789012:secret:greengrass-TwilioAuthToken-ntSlp6\"}}}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "CreationTimestamp": "2019-06-19T21:51:28.212Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", + "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "Name": "MyGreengrassResources" + } + +For more information, see `How to Configure Local Resource Access Using the AWS Command Line Interface `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-software-update-job.rst b/aws/dist/awscli/examples/greengrass/create-software-update-job.rst new file mode 100644 index 00000000..efc149a9 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-software-update-job.rst @@ -0,0 +1,21 @@ +**To create a software update job for a core** + +The following ``create-software-update-job`` example creates an over-the-air (OTA) update job to update the AWS IoT Greengrass Core software on the core whose name is ``MyFirstGroup_Core``. This command requires an IAM role that allows access to software update packages in Amazon S3 and includes ``iot.amazonaws.com`` as a trusted entity. :: + + aws greengrass create-software-update-job \ + --update-targets-architecture armv7l \ + --update-targets [\"arn:aws:iot:us-west-2:123456789012:thing/MyFirstGroup_Core\"] \ + --update-targets-operating-system raspbian \ + --software-to-update core \ + --s3-url-signer-role arn:aws:iam::123456789012:role/OTA_signer_role \ + --update-agent-log-level WARN + +Output:: + + { + "IotJobId": "GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", + "IotJobArn": "arn:aws:iot:us-west-2:123456789012:job/GreengrassUpdateJob_30b353e3-3af7-4786-be25-4c446663c09e", + "PlatformSoftwareVersion": "1.9.3" + } + +For more information, see `OTA Updates of AWS IoT Greengrass Core Software `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/create-subscription-definition-version.rst b/aws/dist/awscli/examples/greengrass/create-subscription-definition-version.rst new file mode 100644 index 00000000..5d26332d --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-subscription-definition-version.rst @@ -0,0 +1,16 @@ +**To create a new version of a subscription definition** + +The following ``create-subscription-definition-version`` example creates a new version of a subscription definition that contains three subscriptions: a trigger notification, a temperature input, and an output status. :: + + aws greengrass create-subscription-definition-version \ + --subscription-definition-id "9d611d57-5d5d-44bd-a3b4-feccbdd69112" \ + --subscriptions "[{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/7b65dfae-50b6-4d0f-b3e0-27728bfb0620", + "CreationTimestamp": "2019-06-24T21:21:33.837Z", + "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "Version": "7b65dfae-50b6-4d0f-b3e0-27728bfb0620" + } diff --git a/aws/dist/awscli/examples/greengrass/create-subscription-definition.rst b/aws/dist/awscli/examples/greengrass/create-subscription-definition.rst new file mode 100644 index 00000000..10031036 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/create-subscription-definition.rst @@ -0,0 +1,19 @@ +**To create a subscription definition** + +The following ``create-subscription-definition`` example creates a subscription definition and specifies its initial version. The initial version contains three subscriptions: one for the MQTT topic to which the connector subscribes, one to allow a function to receive temperature readings from AWS IoT, and one to allow AWS IoT to receive status information from the connector. The example provides the ARN for the Lambda function alias that was created earlier by using Lambda's ``create-alias`` command. :: + + aws greengrass create-subscription-definition \ + --initial-version "{\"Subscriptions\": [{\"Id\": \"TriggerNotification\", \"Source\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\", \"Subject\": \"twilio/txt\", \"Target\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\"},{\"Id\": \"TemperatureInput\", \"Source\": \"cloud\", \"Subject\": \"temperature/input\", \"Target\": \"arn:aws:lambda:us-west-2:123456789012:function:TempMonitor:GG_TempMonitor\"},{\"Id\": \"OutputStatus\", \"Source\": \"arn:aws:greengrass:us-west-2::/connectors/TwilioNotifications/versions/1\", \"Subject\": \"twilio/message/status\", \"Target\": \"cloud\"}]}" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "CreationTimestamp": "2019-06-19T22:34:26.677Z", + "Id": "9d611d57-5d5d-44bd-a3b4-feccbdd69112", + "LastUpdatedTimestamp": "2019-06-19T22:34:26.677Z", + "LatestVersion": "aa645c47-ac90-420d-9091-8c7ffa4f103f", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/9d611d57-5d5d-44bd-a3b4-feccbdd69112/versions/aa645c47-ac90-420d-9091-8c7ffa4f103f" + } + +For more information, see `Getting Started with Connectors (CLI) `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/delete-connector-definition.rst b/aws/dist/awscli/examples/greengrass/delete-connector-definition.rst new file mode 100644 index 00000000..09387c47 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-connector-definition.rst @@ -0,0 +1,8 @@ +**To delete a connector definition** + +The following ``delete-connector-definition`` example deletes the specified Greengrass connector definition. If you delete a connector definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-connector-definition \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/delete-core-definition.rst b/aws/dist/awscli/examples/greengrass/delete-core-definition.rst new file mode 100644 index 00000000..ad5c2ca6 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-core-definition.rst @@ -0,0 +1,8 @@ +**To delete a core definition** + +The following ``delete-core-definition`` example deletes the specified Greengrass core definition, including all versions. If you delete a core that is associated with a Greengrass group, that group can't be deployed successfully. :: + + aws greengrass delete-core-definition \ + --core-definition-id "ff36cc5f-9f98-4994-b468-9d9b6dc52abd" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/delete-device-definition.rst b/aws/dist/awscli/examples/greengrass/delete-device-definition.rst new file mode 100644 index 00000000..f5d1a60f --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-device-definition.rst @@ -0,0 +1,8 @@ +**To delete a device definition** + +The following ``delete-device-definition`` example deletes the specified device definition, including all of its versions. If you delete a device definition version that is used by a group version, the group version cannot be deployed successfully. :: + + aws greengrass delete-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/delete-function-definition.rst b/aws/dist/awscli/examples/greengrass/delete-function-definition.rst new file mode 100644 index 00000000..92995a28 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-function-definition.rst @@ -0,0 +1,8 @@ +**To delete a function definition** + +The following ``delete-function-definition`` example deletes the specified Greengrass function definition. If you delete a function definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-function-definition \ + --function-definition-id "fd4b906a-dff3-4c1b-96eb-52ebfcfac06a" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/delete-logger-definition.rst b/aws/dist/awscli/examples/greengrass/delete-logger-definition.rst new file mode 100644 index 00000000..3ca78b61 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-logger-definition.rst @@ -0,0 +1,10 @@ +**To delete a logger definition** + +The following ``delete-logger-definition`` example deletes the specified logger definition, including all logger definition versions. If you delete a logger definition version that is used by a group version, the group version cannot be deployed successfully. :: + + aws greengrass delete-logger-definition \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" + +This command produces no output. + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/delete-resource-definition.rst b/aws/dist/awscli/examples/greengrass/delete-resource-definition.rst new file mode 100644 index 00000000..aa356dca --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-resource-definition.rst @@ -0,0 +1,8 @@ +**To delete a resource definition** + +The following ``delete-resource-definition`` example deletes the specified resource definition, including all resource versions. If you delete a resource definition that is used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-resource-definition \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/delete-subscription-definition.rst b/aws/dist/awscli/examples/greengrass/delete-subscription-definition.rst new file mode 100644 index 00000000..0f9a139d --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/delete-subscription-definition.rst @@ -0,0 +1,8 @@ +**To delete a subscription definition** + +The following ``delete-subscription-definition`` example deletes the specified Greengrass subscription definition. If you delete a subscription that is being used by a group, that group can't be deployed successfully. :: + + aws greengrass delete-subscription-definition \ + --subscription-definition-id "cd6f1c37-d9a4-4e90-be94-01a7404f5967" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/disassociate-role-from-group.rst b/aws/dist/awscli/examples/greengrass/disassociate-role-from-group.rst new file mode 100644 index 00000000..2748d626 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/disassociate-role-from-group.rst @@ -0,0 +1,14 @@ +**To disassociate the role from a Greengrass group** + +The following ``disassociate-role-from-group`` example disassociates the IAM role from the specified Greengrass group. :: + + aws greengrass disassociate-role-from-group \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b + +Output:: + + { + "DisassociatedAt": "2019-09-10T20:05:49Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/disassociate-service-role-from-account.rst b/aws/dist/awscli/examples/greengrass/disassociate-service-role-from-account.rst new file mode 100644 index 00000000..87d85681 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/disassociate-service-role-from-account.rst @@ -0,0 +1,13 @@ +**To disassociate a service role from your AWS account** + +The following ``disassociate-service-role-from-account`` example removes the service role that is associated with your AWS account. If you are not using the service role in any AWS Region, use the ``delete-role-policy`` command to detach the ``AWSGreengrassResourceAccessRolePolicy`` managed policy from the role, and then use the ``delete-role`` command to delete the role. :: + + aws greengrass disassociate-service-role-from-account + +Output:: + + { + "DisassociatedAt": "2019-06-25T22:12:55Z" + } + +For more information, see `Greengrass Service Role `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/get-associated-role.rst b/aws/dist/awscli/examples/greengrass/get-associated-role.rst new file mode 100644 index 00000000..bcd23d51 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-associated-role.rst @@ -0,0 +1,15 @@ +**To get the role associated with a Greengrass group** + +The following ``get-associated-role`` example gets the IAM role that's associated with the specified Greengrass group. The group role is used by local Lambda functions and connectors to access AWS services. :: + + aws greengrass get-associated-role \ + --group-id 2494ee3f-7f8a-4e92-a78b-d205f808b84b + +Output:: + + { + "RoleArn": "arn:aws:iam::123456789012:role/GG-Group-Role", + "AssociatedAt": "2019-09-10T20:03:30Z" + } + +For more information, see `Configure the Group Role `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/get-bulk-deployment-status.rst b/aws/dist/awscli/examples/greengrass/get-bulk-deployment-status.rst new file mode 100644 index 00000000..e11ad9d2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-bulk-deployment-status.rst @@ -0,0 +1,21 @@ +**To check the status of your bulk deployment** + +The following ``get-bulk-deployment-status`` example retrieves status information for the specified bulk deployment operation. In this example, the file that specified the groups to be deployed has an invalid input record. :: + + aws greengrass get-bulk-deployment-status \ + --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + +Output:: + + { + "BulkDeploymentMetrics": { + "InvalidInputRecords": 1, + "RecordsProcessed": 1, + "RetryAttempts": 0 + }, + "BulkDeploymentStatus": "Completed", + "CreatedAt": "2019-06-25T16:11:33.265Z", + "tags": {} + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/get-connectivity-info.rst b/aws/dist/awscli/examples/greengrass/get-connectivity-info.rst new file mode 100644 index 00000000..18a6d53a --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-connectivity-info.rst @@ -0,0 +1,37 @@ +**To get the connectivity information for a Greengrass core** + +The following ``get-connectivity-info`` example displays the endpoints that devices can use to connect to the specified Greengrass core. Connectivity information is a list of IP addresses or domain names, with corresponding port numbers and optional customer-defined metadata. :: + + aws greengrass get-connectivity-info \ + --thing-name "MyGroup_Core" + +Output:: + + { + "ConnectivityInfo": [ + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "127.0.0.1", + "Id": "AUTOIP_127.0.0.1_0" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "192.168.1.3", + "Id": "AUTOIP_192.168.1.3_1" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "::1", + "Id": "AUTOIP_::1_2" + }, + { + "Metadata": "", + "PortNumber": 8883, + "HostAddress": "fe80::1e69:ed93:f5b:f6d", + "Id": "AUTOIP_fe80::1e69:ed93:f5b:f6d_3" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/get-connector-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-connector-definition-version.rst new file mode 100644 index 00000000..0d412fff --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-connector-definition-version.rst @@ -0,0 +1,29 @@ +**To retreive information about a specific version of a connector definition** + +The following ``get-connector-definition-version`` example retrieves information about the specified version of the specified connector definition. To retrieve the IDs of all versions of the connector definition, use the ``list-connector-definition-versions`` command. To retrieve the ID of the last version added to the connector definition, use the ``get-connector-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-connector-definition-version \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" \ + --connector-definition-version-id "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Definition": { + "Connectors": [ + { + "ConnectorArn": "arn:aws:greengrass:us-west-2::/connectors/SNS/versions/1", + "Id": "MySNSConnector", + "Parameters": { + "DefaultSNSArn": "arn:aws:sns:us-west-2:123456789012:GGConnectorTopic" + } + } + ] + }, + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/get-connector-definition.rst b/aws/dist/awscli/examples/greengrass/get-connector-definition.rst new file mode 100644 index 00000000..8a5624f4 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-connector-definition.rst @@ -0,0 +1,21 @@ +**To retrieve information about a connector definition** + +The following ``get-connector-definition`` example retrieves information about the specified connector definition. To retrieve the IDs of your connector definitions, use the ``list-connector-definitions`` command. :: + + aws greengrass get-connector-definition \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector", + "tags": {} + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/get-core-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-core-definition-version.rst new file mode 100644 index 00000000..a8cee2bc --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-core-definition-version.rst @@ -0,0 +1,26 @@ +**To retrieve details about a specific version of the Greengrass core definition** + +The following ``get-core-definition-version`` example retrieves information about the specified version of the specified core definition. To retrieve the IDs of all versions of the core definition, use the ``list-core-definition-versions`` command. To retrieve the ID of the last version added to the core definition, use the ``get-core-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-core-definition-version \ + --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" \ + --core-definition-version-id "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "CreationTimestamp": "2019-06-18T16:21:21.351Z", + "Definition": { + "Cores": [ + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/928dea7b82331b47c3ff77b0e763fc5e64e2f7c884e6ef391baed9b6b8e21b45", + "Id": "1a39aac7-0885-4417-91f6-23e4cea6c511", + "SyncShadow": false, + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/GGGroup4Pi3_Core" + } + ] + }, + "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "Version": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + } diff --git a/aws/dist/awscli/examples/greengrass/get-core-definition.rst b/aws/dist/awscli/examples/greengrass/get-core-definition.rst new file mode 100644 index 00000000..da6fe78f --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-core-definition.rst @@ -0,0 +1,18 @@ +**To retrieve details for a Greengrass core definition** + +The following ``get-core-definition`` example retrieves information about the specified core definition. To retrieve the IDs of your core definitions, use the ``list-core-definitions`` command. :: + + aws greengrass get-core-definition \ + --core-definition-id "c906ed39-a1e3-4822-a981-7b9bd57b4b46" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd", + "CreationTimestamp": "2018-10-18T04:47:06.721Z", + "Id": "237d6916-27cf-457f-ba0c-e86cfb5d25cd", + "LastUpdatedTimestamp": "2018-10-18T04:47:06.721Z", + "LatestVersion": "bd2cd6d4-2bc5-468a-8962-39e071e34b68", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/237d6916-27cf-457f-ba0c-e86cfb5d25cd/versions/bd2cd6d4-2bc5-468a-8962-39e071e34b68", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/get-deployment-status.rst b/aws/dist/awscli/examples/greengrass/get-deployment-status.rst new file mode 100644 index 00000000..4abcf2ad --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-deployment-status.rst @@ -0,0 +1,15 @@ +**To retrieve the status of a deployment** + +The following ``get-deployment-status`` example retrieves the status for the specified deployment of the specified Greengrass group. To get the deployment ID, use the ``list-deployments`` command and specify the group ID. :: + + aws greengrass get-deployment-status \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --deployment-id "1065b8a0-812b-4f21-9d5d-e89b232a530f" + +Output:: + + { + "DeploymentStatus": "Success", + "DeploymentType": "NewDeployment", + "UpdatedAt": "2019-06-18T17:04:44.761Z" + } diff --git a/aws/dist/awscli/examples/greengrass/get-device-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-device-definition-version.rst new file mode 100644 index 00000000..9a19bd91 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-device-definition-version.rst @@ -0,0 +1,32 @@ +**To get a device definition version** + +The following ``get-device-definition-version`` example retrieves information about the specified version of the specified device definition. To retrieve the IDs of all versions of the device definition, use the ``list-device-definition-versions`` command. To retrieve the ID of the last version added to the device definition, use the ``get-device-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-device-definition-version \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --device-definition-version-id "83c13984-6fed-447e-84d5-5b8aa45d5f71" + +Output:: + + { + "Definition": { + "Devices": [ + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/6c52ce1b47bde88a637e9ccdd45fe4e4c2c0a75a6866f8f63d980ee22fa51e02", + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/ExteriorTherm", + "SyncShadow": true, + "Id": "ExteriorTherm" + }, + { + "CertificateArn": "arn:aws:iot:us-west-2:123456789012:cert/66a415ec415668c2349a76170b64ac0878231c1e21ec83c10e92a18bd568eb92", + "ThingArn": "arn:aws:iot:us-west-2:123456789012:thing/InteriorTherm", + "SyncShadow": true, + "Id": "InteriorTherm" + } + ] + }, + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" + } diff --git a/aws/dist/awscli/examples/greengrass/get-device-definition.rst b/aws/dist/awscli/examples/greengrass/get-device-definition.rst new file mode 100644 index 00000000..e4ccfab1 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-device-definition.rst @@ -0,0 +1,19 @@ +**To get a device definition** + +The following ``get-device-definition`` example retrieves information about the specified device definition. To retrieve the IDs of your device definitions, use the ``list-device-definitions`` command. :: + + aws greengrass get-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +Output:: + + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Name": "TemperatureSensors", + "tags": {}, + "LastUpdatedTimestamp": "2019-09-11T00:19:03.698Z", + "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } diff --git a/aws/dist/awscli/examples/greengrass/get-function-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-function-definition-version.rst new file mode 100644 index 00000000..5f9b1027 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-function-definition-version.rst @@ -0,0 +1,43 @@ +**To retrieve details about a specific version of a Lambda function** + +The following ``get-function-definition-version`` retrieves information about the specified version of the specified function definition. To retrieve the IDs of all versions of the function definition, use the ``list-function-definition-versions`` command. To retrieve the ID of the last version added to the function definition, use the ``get-function-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-function-definition-version \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" \ + --function-definition-version-id "9748fda7-1589-4fcc-ac94-f5559e88678b" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "CreationTimestamp": "2019-06-18T17:04:30.776Z", + "Definition": { + "Functions": [ + { + "FunctionArn": "arn:aws:lambda:::function:GGIPDetector:1", + "FunctionConfiguration": { + "Environment": {}, + "MemorySize": 32768, + "Pinned": true, + "Timeout": 3 + }, + "Id": "26b69bdb-e547-46bc-9812-84ec04b6cc8c" + }, + { + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", + "FunctionConfiguration": { + "EncodingType": "json", + "Environment": { + "Variables": {} + }, + "MemorySize": 16384, + "Pinned": true, + "Timeout": 25 + }, + "Id": "384465a8-eedf-48c6-b793-4c35f7bfae9b" + } + ] + }, + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" + } diff --git a/aws/dist/awscli/examples/greengrass/get-function-definition.rst b/aws/dist/awscli/examples/greengrass/get-function-definition.rst new file mode 100644 index 00000000..7535eb5b --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-function-definition.rst @@ -0,0 +1,18 @@ +**To retrieve a Lambda function definition** + +The following ``get-function-definition`` example retrieves the definition for the specified Lambda function. :: + + aws greengrass get-function-definition \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", + "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/get-group-certificate-authority.rst b/aws/dist/awscli/examples/greengrass/get-group-certificate-authority.rst new file mode 100644 index 00000000..b2ad3cb3 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-group-certificate-authority.rst @@ -0,0 +1,30 @@ +**To retrieve the CA associated with a Greengrass group** + +The following ``get-group-certificate-authority`` example retrieves the certificate authority (CA) that is associated with the specified Greengrass group. To get the certificate authority ID, use the ``list-group-certificate-authorities`` command and specify the group ID. :: + + aws greengrass get-group-certificate-authority \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --certificate-authority-id "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" + +Output:: + + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "PemEncodedCertificate": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBWEXAMPLEGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDEXAMPLEEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAEXAMPLESBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jEXAMPLENMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0EXAMPLEBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWEXAMPLEDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWEXAMPLEgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5EXAMPLE8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CEXAMPLE93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswYEXAMPLEgpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKEXAMPLEAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----\n" + } diff --git a/aws/dist/awscli/examples/greengrass/get-group-certificate-configuration.rst b/aws/dist/awscli/examples/greengrass/get-group-certificate-configuration.rst new file mode 100644 index 00000000..3cb33b2f --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-group-certificate-configuration.rst @@ -0,0 +1,14 @@ +**To retrieve the configuration for the certificate authority used by the Greengrass group** + +The following ``get-group-certificate-configuration`` example retrieves the configuration for the certificate authority (CA) used by the specified Greengrass group. :: + + aws greengrass get-group-certificate-configuration \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "CertificateAuthorityExpiryInMilliseconds": 2524607999000, + "CertificateExpiryInMilliseconds": 604800000, + "GroupId": "1013db12-8b58-45ff-acc7-704248f66731" + } diff --git a/aws/dist/awscli/examples/greengrass/get-group-version.rst b/aws/dist/awscli/examples/greengrass/get-group-version.rst new file mode 100644 index 00000000..3fcfe69a --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-group-version.rst @@ -0,0 +1,21 @@ +**To retrieve information about a version of a Greengrass group** + +The following ``get-group-version`` example retrieves information about the specified version of the specified group. To retrieve the IDs of all versions of the group, use the ``list-group-versions`` command. To retrieve the ID of the last version added to the group, use the ``get-group`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-group-version \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" \ + --group-version-id "115136b3-cfd7-4462-b77f-8741a4b00e5e" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "CreationTimestamp": "2019-06-18T17:04:30.915Z", + "Definition": { + "CoreDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "FunctionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "SubscriptionDefinitionVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" + } diff --git a/aws/dist/awscli/examples/greengrass/get-group.rst b/aws/dist/awscli/examples/greengrass/get-group.rst new file mode 100644 index 00000000..5ae0f593 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-group.rst @@ -0,0 +1,19 @@ +**To retrieve information about a Greengrass group** + +The following ``get-group`` example retrieves information about the specified Greengrass group. To retrieve the IDs of your groups, use the ``list-groups`` command. :: + + aws greengrass get-group \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", + "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "Name": "GGGroup4Pi3", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/get-logger-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-logger-definition-version.rst new file mode 100644 index 00000000..28d3ad09 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-logger-definition-version.rst @@ -0,0 +1,19 @@ +**To retrieve information about a version of a logger definition** + +The following ``get-logger-definition-version`` example retrieves information about the specified version of the specified logger definition. To retrieve the IDs of all versions of the logger definition, use the ``list-logger-definition-versions`` command. To retrieve the ID of the last version added to the logger definition, use the ``get-logger-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-logger-definition-version \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" \ + --logger-definition-version-id "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "CreationTimestamp": "2019-05-08T16:10:13.866Z", + "Definition": { + "Loggers": [] + }, + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + } diff --git a/aws/dist/awscli/examples/greengrass/get-logger-definition.rst b/aws/dist/awscli/examples/greengrass/get-logger-definition.rst new file mode 100644 index 00000000..26de40db --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-logger-definition.rst @@ -0,0 +1,18 @@ +**To retrieve information about a logger definition** + +The following ``get-logger-definition`` example retrieves information about the specified logger definition. To retrieve the IDs of your logger definitions, use the ``list-logger-definitions`` command. :: + + aws greengrass get-logger-definition \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", + "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/get-resource-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-resource-definition-version.rst new file mode 100644 index 00000000..9be34ad1 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-resource-definition-version.rst @@ -0,0 +1,32 @@ +**To retrieve information about a specific version of a resource definition** + +The following ``get-resource-definition-version`` example retrieves information about the specified version of the specified resource definition. To retrieve the IDs of all versions of the resource definition, use the ``list-resource-definition-versions`` command. To retrieve the ID of the last version added to the resource definition, use the ``get-resource-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-resource-definition-version \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ + --resource-definition-version-id "26e8829a-491a-464d-9c87-664bf6f6f2be" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "CreationTimestamp": "2019-06-19T16:40:59.392Z", + "Definition": { + "Resources": [ + { + "Id": "26ff3f7b-839a-4217-9fdc-a218308b3963", + "Name": "usb-port", + "ResourceDataContainer": { + "LocalDeviceResourceData": { + "GroupOwnerSetting": { + "AutoAddGroupOwner": false + }, + "SourcePath": "/dev/bus/usb" + } + } + } + ] + }, + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" + } diff --git a/aws/dist/awscli/examples/greengrass/get-resource-definition.rst b/aws/dist/awscli/examples/greengrass/get-resource-definition.rst new file mode 100644 index 00000000..e983dc31 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-resource-definition.rst @@ -0,0 +1,18 @@ +**To retrieve information about a resource definition** + +The following ``get-resource-definition`` example retrieves information about the specified resource definition. To retrieve the IDs of your resource definitions, use the ``list-resource-definitions`` command. :: + + aws greengrass get-resource-definition \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", + "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/get-service-role-for-account.rst b/aws/dist/awscli/examples/greengrass/get-service-role-for-account.rst new file mode 100644 index 00000000..f5c8ccbd --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-service-role-for-account.rst @@ -0,0 +1,14 @@ +**To retrieve the details for the service role that is attached to your account** + +The following ``get-service-role-for-account`` example retrieves information about the service role that is attached to your AWS account. :: + + aws greengrass get-service-role-for-account + +Output:: + + { + "AssociatedAt": "2018-10-18T15:59:20Z", + "RoleArn": "arn:aws:iam::123456789012:role/service-role/Greengrass_ServiceRole" + } + +For more information, see `Greengrass Service Role `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/get-subscription-definition-version.rst b/aws/dist/awscli/examples/greengrass/get-subscription-definition-version.rst new file mode 100644 index 00000000..77b2a0e5 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-subscription-definition-version.rst @@ -0,0 +1,26 @@ +**To retrieve information about a specific version of a subscription definition** + +The following ``get-subscription-definition-version`` example retrieves retrieves information about the specified version of the specified subscription definition. To retrieve the IDs of all versions of the subscription definition, use the ``list-subscription-definition-versions`` command. To retrieve the ID of the last version added to the subscription definition, use the ``get-subscription-definition`` command and check the ``LatestVersion`` property. :: + + aws greengrass get-subscription-definition-version \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" \ + --subscription-definition-version-id "88ae8699-12ac-4663-ba3f-4d7f0519140b" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "CreationTimestamp": "2019-06-18T17:03:52.499Z", + "Definition": { + "Subscriptions": [ + { + "Id": "692c4484-d89f-4f64-8edd-1a041a65e5b6", + "Source": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld", + "Subject": "hello/world", + "Target": "cloud" + } + ] + }, + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" + } diff --git a/aws/dist/awscli/examples/greengrass/get-subscription-definition.rst b/aws/dist/awscli/examples/greengrass/get-subscription-definition.rst new file mode 100644 index 00000000..6c1d0ecb --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/get-subscription-definition.rst @@ -0,0 +1,18 @@ +**To retrieve information about a subscription definition** + +The following ``get-subscription-definition`` example retrieves information about the specified subscription definition. To retrieve the IDs of your subscription definitions, use the ``list-subscription-definitions`` command. :: + + aws greengrass get-subscription-definition \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" + +Output:: + + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", + "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "tags": {} + } diff --git a/aws/dist/awscli/examples/greengrass/list-bulk-deployments.rst b/aws/dist/awscli/examples/greengrass/list-bulk-deployments.rst new file mode 100644 index 00000000..00db5853 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-bulk-deployments.rst @@ -0,0 +1,19 @@ +**To list bulk deployments** + +The following ``list-bulk-deployments`` example lists all bulk deployments. :: + + aws greengrass list-bulk-deployments + +Output:: + + { + "BulkDeployments": [ + { + "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "CreatedAt": "2019-06-25T16:11:33.265Z" + } + ] + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/list-connector-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-connector-definition-versions.rst new file mode 100644 index 00000000..45f734be --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-connector-definition-versions.rst @@ -0,0 +1,21 @@ +**To list the versions that are available for a connector definition** + +The following ``list-connector-definition-versions`` example lists the versions that are available for the specified connector definition. Use the ``list-connector-definitions`` command to get the connector definition ID. :: + + aws greengrass list-connector-definition-versions \ + --connector-definition-id "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "Version": "63c57963-c7c2-4a26-a7e2-7bf478ea2623" + } + ] + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/list-connector-definitions.rst b/aws/dist/awscli/examples/greengrass/list-connector-definitions.rst new file mode 100644 index 00000000..14b751b2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-connector-definitions.rst @@ -0,0 +1,23 @@ +**To list the Greengrass connectors that are defined** + +The following ``list-connector-definitions`` example lists all of the Greengrass connectors that are defined for your AWS account. :: + + aws greengrass list-connector-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "CreationTimestamp": "2019-06-19T19:30:01.300Z", + "Id": "b5c4ebfd-f672-49a3-83cd-31c7216a7bb8", + "LastUpdatedTimestamp": "2019-06-19T19:30:01.300Z", + "LatestVersion": "63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/connectors/b5c4ebfd-f672-49a3-83cd-31c7216a7bb8/versions/63c57963-c7c2-4a26-a7e2-7bf478ea2623", + "Name": "MySNSConnector" + } + ] + } + +For more information, see `Integrate with Services and Protocols Using Greengrass Connectors `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/list-core-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-core-definition-versions.rst new file mode 100644 index 00000000..b31b5a4b --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-core-definition-versions.rst @@ -0,0 +1,19 @@ +**To list the versions of a Greengrass core definition** + +The following ``list-core-definitions`` example lists all versions of the specied Greengrass core definition. You can use the ``list-core-definitions`` command to get the version ID. :: + + aws greengrass list-core-definition-versions \ + --core-definition-id "eaf280cb-138c-4d15-af36-6f681a1348f7" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c", + "CreationTimestamp": "2019-06-18T16:14:17.709Z", + "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", + "Version": "467c36e4-c5da-440c-a97b-084e62593b4c" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-core-definitions.rst b/aws/dist/awscli/examples/greengrass/list-core-definitions.rst new file mode 100644 index 00000000..35351df1 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-core-definitions.rst @@ -0,0 +1,44 @@ +**To list Greengrass core definitions** + +The following ``list-core-definitions`` example lists all of the Greengrass core definitions for your AWS account. :: + + aws greengrass list-core-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d", + "CreationTimestamp": "2018-10-17T04:30:32.786Z", + "Id": "0507843c-c1ef-4f06-b051-817030df7e7d", + "LastUpdatedTimestamp": "2018-10-17T04:30:32.786Z", + "LatestVersion": "bcdf9e86-3793-491e-93af-3cdfbf4e22b7", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/0507843c-c1ef-4f06-b051-817030df7e7d/versions/bcdf9e86-3793-491e-93af-3cdfbf4e22b7" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438", + "CreationTimestamp": "2019-06-18T16:24:16.064Z", + "Id": "31c22500-3509-4271-bafd-cf0655cda438", + "LastUpdatedTimestamp": "2019-06-18T16:24:16.064Z", + "LatestVersion": "2f350395-6d09-4c8a-8336-9ae5b57ace84", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/31c22500-3509-4271-bafd-cf0655cda438/versions/2f350395-6d09-4c8a-8336-9ae5b57ace84" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "CreationTimestamp": "2019-06-18T16:21:21.351Z", + "Id": "c906ed39-a1e3-4822-a981-7b9bd57b4b46", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.351Z", + "LatestVersion": "42aeeac3-fd9d-4312-a8fd-ffa9404a20e0", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/c906ed39-a1e3-4822-a981-7b9bd57b4b46/versions/42aeeac3-fd9d-4312-a8fd-ffa9404a20e0" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7", + "CreationTimestamp": "2019-06-18T16:14:17.709Z", + "Id": "eaf280cb-138c-4d15-af36-6f681a1348f7", + "LastUpdatedTimestamp": "2019-06-18T16:14:17.709Z", + "LatestVersion": "467c36e4-c5da-440c-a97b-084e62593b4c", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/cores/eaf280cb-138c-4d15-af36-6f681a1348f7/versions/467c36e4-c5da-440c-a97b-084e62593b4c" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-deployments.rst b/aws/dist/awscli/examples/greengrass/list-deployments.rst new file mode 100644 index 00000000..c4c75924 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-deployments.rst @@ -0,0 +1,19 @@ +**To list the deployments for a Greengrass group** + +The following ``list-deployments`` example lists the deployments for the specified Greengrass group. You can use the ``list-groups`` command to look up your group ID. :: + + aws greengrass list-deployments \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Deployments": [ + { + "CreatedAt": "2019-06-18T17:04:32.702Z", + "DeploymentId": "1065b8a0-812b-4f21-9d5d-e89b232a530f", + "DeploymentType": "NewDeployment", + "GroupArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-device-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-device-definition-versions.rst new file mode 100644 index 00000000..5d86a488 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-device-definition-versions.rst @@ -0,0 +1,25 @@ +**To list the versions of a device definition** + +The following ``list-device-definition-versions`` example displays the device definition versions associated with the specified device definition. :: + + aws greengrass list-device-definition-versions \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" + +Output:: + + { + "Versions": [ + { + "Version": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:15:09.838Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71" + }, + { + "Version": "3b5cc510-58c1-44b5-9d98-4ad858ffa795", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/3b5cc510-58c1-44b5-9d98-4ad858ffa795" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-device-definitions.rst b/aws/dist/awscli/examples/greengrass/list-device-definitions.rst new file mode 100644 index 00000000..64fc28b7 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-device-definitions.rst @@ -0,0 +1,39 @@ +**To list your device definitions** + +The following ``list-device-definitions`` example displays details about the device definitions in your AWS account in the specified AWS Region. :: + + aws greengrass list-device-definitions \ + --region us-west-2 + +Output:: + + { + "Definitions": [ + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab/versions/c777b0f5-1059-449b-beaa-f003ebc56c34", + "LastUpdatedTimestamp": "2019-06-14T15:42:09.059Z", + "LatestVersion": "c777b0f5-1059-449b-beaa-f003ebc56c34", + "CreationTimestamp": "2019-06-14T15:42:09.059Z", + "Id": "50f3274c-3f0a-4f57-b114-6f46085281ab", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/50f3274c-3f0a-4f57-b114-6f46085281ab" + }, + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40/versions/514d57aa-4ee6-401c-9fac-938a9f7a51e5", + "Name": "TestDeviceDefinition", + "LastUpdatedTimestamp": "2019-04-16T23:17:43.245Z", + "LatestVersion": "514d57aa-4ee6-401c-9fac-938a9f7a51e5", + "CreationTimestamp": "2019-04-16T23:17:43.245Z", + "Id": "e01951c9-6134-479a-969a-1a15cac11c40", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/e01951c9-6134-479a-969a-1a15cac11c40" + }, + { + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd/versions/83c13984-6fed-447e-84d5-5b8aa45d5f71", + "Name": "TemperatureSensors", + "LastUpdatedTimestamp": "2019-09-10T00:19:03.698Z", + "LatestVersion": "83c13984-6fed-447e-84d5-5b8aa45d5f71", + "CreationTimestamp": "2019-09-11T00:11:06.197Z", + "Id": "f9ba083d-5ad4-4534-9f86-026a45df1ccd", + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/devices/f9ba083d-5ad4-4534-9f86-026a45df1ccd" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-function-definitions-versions.rst b/aws/dist/awscli/examples/greengrass/list-function-definitions-versions.rst new file mode 100644 index 00000000..bacf8926 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-function-definitions-versions.rst @@ -0,0 +1,37 @@ +**To list the versions of a Lambda function** + +The following ``list-function-definition-versions`` example lists all of the versions of the specified Lambda function. You can use the ``list-function-definitions`` command to get the ID. :: + + aws greengrass list-function-definition-versions \ + --function-definition-id "063f5d1a-1dd1-40b4-9b51-56f8993d0f85" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b", + "CreationTimestamp": "2019-06-18T17:04:30.776Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9748fda7-1589-4fcc-ac94-f5559e88678b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9b08df77-26f2-4c29-93d2-769715edcfec", + "CreationTimestamp": "2019-06-18T17:02:44.087Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "9b08df77-26f2-4c29-93d2-769715edcfec" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/4236239f-94f7-4b90-a2f8-2a24c829d21e", + "CreationTimestamp": "2019-06-18T17:01:42.284Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "4236239f-94f7-4b90-a2f8-2a24c829d21e" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/343408bb-549a-4fbe-b043-853643179a39", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "Version": "343408bb-549a-4fbe-b043-853643179a39" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-function-definitions.rst b/aws/dist/awscli/examples/greengrass/list-function-definitions.rst new file mode 100644 index 00000000..bacfaf59 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-function-definitions.rst @@ -0,0 +1,44 @@ +**To list Lambda functions** + +The following ``list-function-definitions`` example lists all of the Lambda functions defined for your AWS account. :: + + aws greengrass list-function-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960", + "CreationTimestamp": "2018-10-17T04:30:32.884Z", + "Id": "017970a5-8952-46dd-b1c1-020b3ae8e960", + "LastUpdatedTimestamp": "2018-10-17T04:30:32.884Z", + "LatestVersion": "4380b302-790d-4ed8-92bf-02e88afecb15", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/017970a5-8952-46dd-b1c1-020b3ae8e960/versions/4380b302-790d-4ed8-92bf-02e88afecb15" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "CreationTimestamp": "2019-06-18T16:21:21.431Z", + "Id": "063f5d1a-1dd1-40b4-9b51-56f8993d0f85", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.431Z", + "LatestVersion": "9748fda7-1589-4fcc-ac94-f5559e88678b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/063f5d1a-1dd1-40b4-9b51-56f8993d0f85/versions/9748fda7-1589-4fcc-ac94-f5559e88678b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b", + "CreationTimestamp": "2019-06-18T16:24:16.123Z", + "Id": "6598e653-a262-440c-9967-e2697f64da7b", + "LastUpdatedTimestamp": "2019-06-18T16:24:16.123Z", + "LatestVersion": "38bc6ccd-98a2-4ce7-997e-16c84748fae4", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/6598e653-a262-440c-9967-e2697f64da7b/versions/38bc6ccd-98a2-4ce7-997e-16c84748fae4" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885", + "CreationTimestamp": "2019-06-18T16:14:17.784Z", + "Id": "c668df84-fad2-491b-95f4-655d2cad7885", + "LastUpdatedTimestamp": "2019-06-18T16:14:17.784Z", + "LatestVersion": "37dd68c4-a64f-40ba-aa13-71fecc3ebded", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/functions/c668df84-fad2-491b-95f4-655d2cad7885/versions/37dd68c4-a64f-40ba-aa13-71fecc3ebded" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-group-certificate-authorities.rst b/aws/dist/awscli/examples/greengrass/list-group-certificate-authorities.rst new file mode 100644 index 00000000..8c7b59ee --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-group-certificate-authorities.rst @@ -0,0 +1,17 @@ +**To list the current CAs for a group** + +The following ``list-group-certificate-authorities`` example lists the current certificate authorities (CAs) for the specified Greengrass group. :: + + aws greengrass list-group-certificate-authorities \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "GroupCertificateAuthorities": [ + { + "GroupCertificateAuthorityArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/certificateauthorities/f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6", + "GroupCertificateAuthorityId": "f0430e1736ea8ed30cc5d5de9af67a7e3586bad9ae4d89c2a44163f65fdd8cf6" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-group-versions.rst b/aws/dist/awscli/examples/greengrass/list-group-versions.rst new file mode 100644 index 00000000..0f0703f0 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-group-versions.rst @@ -0,0 +1,43 @@ +**To list the versions of a Greengrass group** + +The following ``list-group-versions`` example lists the versions of the specified Greengrass group. :: + + aws greengrass list-group-versions \ + --group-id "1013db12-8b58-45ff-acc7-704248f66731" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "CreationTimestamp": "2019-06-18T17:04:30.915Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "115136b3-cfd7-4462-b77f-8741a4b00e5e" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/4340669d-d14d-44e3-920c-46c928750750", + "CreationTimestamp": "2019-06-18T17:03:52.663Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "4340669d-d14d-44e3-920c-46c928750750" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/1b06e099-2d5b-4f10-91b9-78c4e060f5da", + "CreationTimestamp": "2019-06-18T17:02:44.189Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "1b06e099-2d5b-4f10-91b9-78c4e060f5da" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/2d3f27f1-3b43-4554-ab7a-73ec30477efe", + "CreationTimestamp": "2019-06-18T17:01:42.401Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "2d3f27f1-3b43-4554-ab7a-73ec30477efe" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/d20f7ae9-3444-4c1c-b025-e2ede23cdd31", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "Version": "d20f7ae9-3444-4c1c-b025-e2ede23cdd31" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/greengrass/list-groups.rst b/aws/dist/awscli/examples/greengrass/list-groups.rst new file mode 100644 index 00000000..66099a3e --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-groups.rst @@ -0,0 +1,39 @@ +**To list the Greengrass groups** + +The following ``list-groups`` example lists all Greengrass groups that are defined in your AWS account. :: + + aws greengrass list-groups + +Output:: + + { + "Groups": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731", + "CreationTimestamp": "2019-06-18T16:21:21.457Z", + "Id": "1013db12-8b58-45ff-acc7-704248f66731", + "LastUpdatedTimestamp": "2019-06-18T16:21:21.457Z", + "LatestVersion": "115136b3-cfd7-4462-b77f-8741a4b00e5e", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731/versions/115136b3-cfd7-4462-b77f-8741a4b00e5e", + "Name": "GGGroup4Pi3" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8", + "CreationTimestamp": "2018-10-31T21:52:46.603Z", + "Id": "1402daf9-71cf-4cfe-8be0-d5e80526d0d8", + "LastUpdatedTimestamp": "2018-10-31T21:52:46.603Z", + "LatestVersion": "749af901-60ab-456f-a096-91b12d983c29", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/versions/749af901-60ab-456f-a096-91b12d983c29", + "Name": "MyTestGroup" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5", + "CreationTimestamp": "2018-12-31T21:39:36.771Z", + "Id": "504b5c8d-bbed-4635-aff1-48ec5b586db5", + "LastUpdatedTimestamp": "2018-12-31T21:39:36.771Z", + "LatestVersion": "46911e8e-f9bc-4898-8b63-59c7653636ec", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/504b5c8d-bbed-4635-aff1-48ec5b586db5/versions/46911e8e-f9bc-4898-8b63-59c7653636ec", + "Name": "smp-ggrass-group" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-logger-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-logger-definition-versions.rst new file mode 100644 index 00000000..450a85e2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-logger-definition-versions.rst @@ -0,0 +1,25 @@ +**To get a list of versions of a logger definition** + +The following ``list-logger-definition-versions`` example gets a list of all versions of the specified logger definition. :: + + aws greengrass list-logger-definition-versions \ + --logger-definition-id "49eeeb66-f1d3-4e34-86e3-3617262abf23" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "CreationTimestamp": "2019-05-08T16:10:13.866Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/3ec6d3af-eb85-48f9-a16d-1c795fe696d7", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "Version": "3ec6d3af-eb85-48f9-a16d-1c795fe696d7" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-logger-definitions.rst b/aws/dist/awscli/examples/greengrass/list-logger-definitions.rst new file mode 100644 index 00000000..d1f0b229 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-logger-definitions.rst @@ -0,0 +1,20 @@ +**To get a list of logger definitions** + +The following ``list-logger-definitions`` example lists all of the logger definitions for your AWS account. :: + + aws greengrass list-logger-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23", + "CreationTimestamp": "2019-05-08T16:10:13.809Z", + "Id": "49eeeb66-f1d3-4e34-86e3-3617262abf23", + "LastUpdatedTimestamp": "2019-05-08T16:10:13.809Z", + "LatestVersion": "5e3f6f64-a565-491e-8de0-3c0d8e0f2073", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/loggers/49eeeb66-f1d3-4e34-86e3-3617262abf23/versions/5e3f6f64-a565-491e-8de0-3c0d8e0f2073" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/greengrass/list-resource-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-resource-definition-versions.rst new file mode 100644 index 00000000..922d87e6 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-resource-definition-versions.rst @@ -0,0 +1,25 @@ +**To list the versions of a resource definition** + +The following ``list-resource-definition-versions`` example lists the versions for the specified Greengrass resource. :: + + aws greengrass list-resource-definition-versions \ + --resource-definition-id "ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be", + "CreationTimestamp": "2019-06-19T16:40:59.392Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "26e8829a-491a-464d-9c87-664bf6f6f2be" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/432d92f6-12de-4ec9-a704-619a942a62aa", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "Version": "432d92f6-12de-4ec9-a704-619a942a62aa" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-resource-definitions.rst b/aws/dist/awscli/examples/greengrass/list-resource-definitions.rst new file mode 100644 index 00000000..4292fc16 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-resource-definitions.rst @@ -0,0 +1,29 @@ +**To list the resources that are defined** + +The following ``list-resource-definitions`` example lists the resources that are defined for AWS IoT Greengrass to use. :: + + aws greengrass list-resource-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "CreationTimestamp": "2019-06-19T16:40:59.261Z", + "Id": "ad8c101d-8109-4b0e-b97d-9cc5802ab658", + "LastUpdatedTimestamp": "2019-06-19T16:40:59.261Z", + "LatestVersion": "26e8829a-491a-464d-9c87-664bf6f6f2be", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658/versions/26e8829a-491a-464d-9c87-664bf6f6f2be" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "CreationTimestamp": "2019-06-19T21:51:28.212Z", + "Id": "c8bb9ebc-c3fd-40a4-9c6a-568d75569d38", + "LastUpdatedTimestamp": "2019-06-19T21:51:28.212Z", + "LatestVersion": "a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/c8bb9ebc-c3fd-40a4-9c6a-568d75569d38/versions/a5f94d0b-f6bc-40f4-bb78-7a1c5fe13ba1", + "Name": "MyGreengrassResources" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-subscription-definition-versions.rst b/aws/dist/awscli/examples/greengrass/list-subscription-definition-versions.rst new file mode 100644 index 00000000..48e955b1 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-subscription-definition-versions.rst @@ -0,0 +1,25 @@ +**To list the versions of a subscription definition** + +The following ``list-subscription-definition-versions`` example lists all versions of the specified subscription. You can use the ``list-subscription-definitions`` command to look up the subscription ID. :: + + aws greengrass list-subscription-definition-versions \ + --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" + +Output:: + + { + "Versions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b", + "CreationTimestamp": "2019-06-18T17:03:52.499Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/7e320ba3-c369-4069-a2f0-90acb7f219d6", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "Version": "7e320ba3-c369-4069-a2f0-90acb7f219d6" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-subscription-definitions.rst b/aws/dist/awscli/examples/greengrass/list-subscription-definitions.rst new file mode 100644 index 00000000..b1bd4731 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-subscription-definitions.rst @@ -0,0 +1,36 @@ +**To get a list subscription definitions** + +The following ``list-subscription-definitions`` example lists all of the AWS IoT Greengrass subscriptions that are defined in your AWS account. :: + + aws greengrass list-subscription-definitions + +Output:: + + { + "Definitions": [ + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152", + "CreationTimestamp": "2019-06-18T17:03:52.392Z", + "Id": "70e49321-83d5-45d2-bc09-81f4917ae152", + "LastUpdatedTimestamp": "2019-06-18T17:03:52.392Z", + "LatestVersion": "88ae8699-12ac-4663-ba3f-4d7f0519140b", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967", + "CreationTimestamp": "2018-10-18T15:45:34.024Z", + "Id": "cd6f1c37-d9a4-4e90-be94-01a7404f5967", + "LastUpdatedTimestamp": "2018-10-18T15:45:34.024Z", + "LatestVersion": "d1cf8fac-284f-4f6a-98fe-a2d36d089373", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/cd6f1c37-d9a4-4e90-be94-01a7404f5967/versions/d1cf8fac-284f-4f6a-98fe-a2d36d089373" + }, + { + "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b", + "CreationTimestamp": "2018-10-22T17:09:31.429Z", + "Id": "fa81bc84-3f59-4377-a84b-5d0134da359b", + "LastUpdatedTimestamp": "2018-10-22T17:09:31.429Z", + "LatestVersion": "086d1b08-b25a-477c-a16f-6f9b3a9c295a", + "LatestVersionArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/fa81bc84-3f59-4377-a84b-5d0134da359b/versions/086d1b08-b25a-477c-a16f-6f9b3a9c295a" + } + ] + } diff --git a/aws/dist/awscli/examples/greengrass/list-tags-for-resource.rst b/aws/dist/awscli/examples/greengrass/list-tags-for-resource.rst new file mode 100644 index 00000000..3627e30b --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags attached to a resource** + +The following ``list-tags-for-resource`` example lists the tags and their values that are attached to the specified resource. :: + + aws greengrass list-tags-for-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" + +Output:: + + { + "tags": { + "ResourceSubType": "USB", + "ResourceType": "Device" + } + } + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/reset-deployments.rst b/aws/dist/awscli/examples/greengrass/reset-deployments.rst new file mode 100644 index 00000000..b2af73c2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/reset-deployments.rst @@ -0,0 +1,16 @@ +**To clean up deployment information for a Greengrass group** + +The following ``reset-deployments`` example cleans up deployment information for the specified Greengrass group. When you add the ``--force option``, the deployment information is reset without waiting for the core device to respond. :: + + aws greengrass reset-deployments \ + --group-id "1402daf9-71cf-4cfe-8be0-d5e80526d0d8" \ + --force + +Output:: + + { + "DeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1402daf9-71cf-4cfe-8be0-d5e80526d0d8/deployments/7dd4e356-9882-46a3-9e28-6d21900c011a", + "DeploymentId": "7dd4e356-9882-46a3-9e28-6d21900c011a" + } + +For more information, see `Reset Deployments `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/start-bulk-deployment.rst b/aws/dist/awscli/examples/greengrass/start-bulk-deployment.rst new file mode 100644 index 00000000..276ec008 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/start-bulk-deployment.rst @@ -0,0 +1,15 @@ +**To start a bulk deployment operation** + +The following ``start-bulk-deployment`` example starts a bulk deployment operation, using a file stored in an S3 bucket to specify the groups to be deployed. :: + + aws greengrass start-bulk-deployment \ + --cli-input-json "{\"InputFileUri\":\"https://gg-group-deployment1.s3-us-west-2.amazonaws.com/MyBulkDeploymentInputFile.txt\", \"ExecutionRoleArn\":\"arn:aws:iam::123456789012:role/ggCreateDeploymentRole\",\"AmznClientToken\":\"yourAmazonClientToken\"}" + +Output:: + + { + "BulkDeploymentArn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/bulk/deployments/870fb41b-6288-4e0c-bc76-a7ba4b4d3267", + "BulkDeploymentId": "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + } + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/stop-bulk-deployment.rst b/aws/dist/awscli/examples/greengrass/stop-bulk-deployment.rst new file mode 100644 index 00000000..19f24cf4 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/stop-bulk-deployment.rst @@ -0,0 +1,10 @@ +**To stop a bulk deployment** + +The following ``stop-bulk-deployment`` example stops the specified bulk deployment. If you try to stop a bulk deployment that is complete, you receive an error: ``InvalidInputException: Cannot change state of finished execution.`` :: + + aws greengrass stop-bulk-deployment \ + --bulk-deployment-id "870fb41b-6288-4e0c-bc76-a7ba4b4d3267" + +This command produces no output. + +For more information, see `Create Bulk Deployments for Groups `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/tag-resource.rst b/aws/dist/awscli/examples/greengrass/tag-resource.rst new file mode 100644 index 00000000..4a81c79b --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/tag-resource.rst @@ -0,0 +1,11 @@ +**To apply tags to a resource** + +The following ``tag-resource`` example applies two tags, ``ResourceType`` and ``ResourceSubType``, to the specified Greengrass resource. This operation can both add new tags and values or update the value for existing tags. Use the ``untag-resource`` command to remove a tag. :: + + aws greengrass tag-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/resources/ad8c101d-8109-4b0e-b97d-9cc5802ab658" \ + --tags "ResourceType=Device,ResourceSubType=USB" + +This command produces no output. + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/untag-resource.rst b/aws/dist/awscli/examples/greengrass/untag-resource.rst new file mode 100644 index 00000000..9501b2de --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove a tag and its value from a resource** + +The following ``untag-resource`` example removes the tag whose key is ``Category`` from the specified Greengrass group. If the key ``Category`` does not exist for the specified resource, no error is returned. :: + + aws greengrass untag-resource \ + --resource-arn "arn:aws:greengrass:us-west-2:123456789012:/greengrass/groups/1013db12-8b58-45ff-acc7-704248f66731" \ + --tag-keys "Category" + +This command produces no output. + +For more information, see `Tagging Your Greengrass Resources `__ in the **AWS IoT Greengrass Developer Guide**. diff --git a/aws/dist/awscli/examples/greengrass/update-connectivity-info.rst b/aws/dist/awscli/examples/greengrass/update-connectivity-info.rst new file mode 100644 index 00000000..c8da6ccf --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/update-connectivity-info.rst @@ -0,0 +1,13 @@ +**To update the connectivity information for a Greengrass core** + +The following ``update-connectivity-info`` example changes the endpoints that devices can use to connect to the specified Greengrass core. Connectivity information is a list of IP addresses or domain names, with corresponding port numbers and optional customer-defined metadata. You might need to update connectivity information when the local network changes. :: + + aws greengrass update-connectivity-info \ + --thing-name "MyGroup_Core" \ + --connectivity-info "[{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"127.0.0.1\",\"Id\":\"localhost_127.0.0.1_0\"},{\"Metadata\":\"\",\"PortNumber\":8883,\"HostAddress\":\"192.168.1.3\",\"Id\":\"localIP_192.168.1.3\"}]" + +Output:: + + { + "Version": "312de337-59af-4cf9-a278-2a23bd39c300" + } diff --git a/aws/dist/awscli/examples/greengrass/update-core-definition.rst b/aws/dist/awscli/examples/greengrass/update-core-definition.rst new file mode 100644 index 00000000..e844ea82 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/update-core-definition.rst @@ -0,0 +1,11 @@ +**To update a core definition** + +The following ``update-core-definition`` example changes the name of the specified core definition. You can update only the ``name`` property of a core definition. :: + + aws greengrass update-core-definition \ + --core-definition-id "582efe12-b05a-409e-9a24-a2ba1bcc4a12" \ + --name "MyCoreDevices" + +This command produces no output. + +For more information, see `Configure the AWS IoT Greengrass Core `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/update-device-definition.rst b/aws/dist/awscli/examples/greengrass/update-device-definition.rst new file mode 100644 index 00000000..b69acbc2 --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/update-device-definition.rst @@ -0,0 +1,9 @@ +**To update a device definition** + +The following ``update-device-definition`` example changes the name of the specified device definition. You can only update the ``name`` property of a device definition. :: + + aws greengrass update-device-definition \ + --device-definition-id "f9ba083d-5ad4-4534-9f86-026a45df1ccd" \ + --name "TemperatureSensors" + +This command produces no output. diff --git a/aws/dist/awscli/examples/greengrass/update-group-certificate-configuration.rst b/aws/dist/awscli/examples/greengrass/update-group-certificate-configuration.rst new file mode 100644 index 00000000..353a8e7c --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/update-group-certificate-configuration.rst @@ -0,0 +1,17 @@ +**To update the expiry of a group's certificate authority (CA)** + +The following ``update-group-certificate-configuration`` example sets a 10-day expiry for the CA of the specified group. :: + + aws greengrass update-group-certificate-configuration \ + --group-id "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" \ + --certificate-expiry-in-milliseconds 864000000 + +Output:: + + { + "CertificateExpiryInMilliseconds": 864000000, + "CertificateAuthorityExpiryInMilliseconds": 2524607999000, + "GroupId": "8eaadd72-ce4b-4f15-892a-0cc4f3a343f1" + } + +For more information, see `AWS IoT Greengrass Security `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/greengrass/update-logger-definition.rst b/aws/dist/awscli/examples/greengrass/update-logger-definition.rst new file mode 100644 index 00000000..c956661b --- /dev/null +++ b/aws/dist/awscli/examples/greengrass/update-logger-definition.rst @@ -0,0 +1,11 @@ +**To update a logger definition** + +The following ``update-logger-definition`` example changes the name of the specified logger definition. You can only update the ``name`` property of a logger definition. :: + + aws greengrass update-logger-definition \ + --logger-definition-id "a454b62a-5d56-4ca9-bdc4-8254e1662cb0" \ + --name "LoggingConfigsForSensors" + +This command produces no output. + +For more information, see `Monitoring with AWS IoT Greengrass Logs `__ in the *AWS IoT Greengrass Developer Guide*. diff --git a/aws/dist/awscli/examples/iam/add-client-id-to-open-id-connect-provider.rst b/aws/dist/awscli/examples/iam/add-client-id-to-open-id-connect-provider.rst new file mode 100644 index 00000000..d8e0089e --- /dev/null +++ b/aws/dist/awscli/examples/iam/add-client-id-to-open-id-connect-provider.rst @@ -0,0 +1,11 @@ +**To add a client ID (audience) to an Open-ID Connect (OIDC) provider** + +The following ``add-client-id-to-open-id-connect-provider`` command adds the client ID ``my-application-ID`` to the OIDC provider named ``server.example.com``:: + + aws iam add-client-id-to-open-id-connect-provider --client-id my-application-ID --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com + +To create an OIDC provider, use the ``create-open-id-connect-provider`` command. + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/add-role-to-instance-profile.rst b/aws/dist/awscli/examples/iam/add-role-to-instance-profile.rst new file mode 100644 index 00000000..5727b066 --- /dev/null +++ b/aws/dist/awscli/examples/iam/add-role-to-instance-profile.rst @@ -0,0 +1,11 @@ +**To add a role to an instance profile** + +The following ``add-role-to-instance-profile`` command adds the role named ``S3Access`` to the instance profile named ``Webserver``:: + + aws iam add-role-to-instance-profile --role-name S3Access --instance-profile-name Webserver + +To create an instance profile, use the ``create-instance-profile`` command. + +For more information, see `Using IAM Roles to Delegate Permissions to Applications that Run on Amazon EC2`_ in the *Using IAM* guide. + +.. _`Using IAM Roles to Delegate Permissions to Applications that Run on Amazon EC2`: http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-usingrole-ec2instance.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/add-user-to-group.rst b/aws/dist/awscli/examples/iam/add-user-to-group.rst new file mode 100644 index 00000000..6dd81b49 --- /dev/null +++ b/aws/dist/awscli/examples/iam/add-user-to-group.rst @@ -0,0 +1,10 @@ +**To add a user to an IAM group** + +The following ``add-user-to-group`` command adds an IAM user named ``Bob`` to the IAM group named ``Admins``:: + + aws iam add-user-to-group --user-name Bob --group-name Admins + +For more information, see `Adding and Removing Users in an IAM Group`_ in the *Using IAM* guide. + +.. _`Adding and Removing Users in an IAM Group`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_AddOrRemoveUsersFromGroup.html + diff --git a/aws/dist/awscli/examples/iam/attach-group-policy.rst b/aws/dist/awscli/examples/iam/attach-group-policy.rst new file mode 100644 index 00000000..47329bb5 --- /dev/null +++ b/aws/dist/awscli/examples/iam/attach-group-policy.rst @@ -0,0 +1,9 @@ +**To attach a managed policy to an IAM group** + +The following ``attach-group-policy`` command attaches the AWS managed policy named ``ReadOnlyAccess`` to the IAM group named ``Finance``:: + + aws iam attach-group-policy --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess --group-name Finance + +For more information, see `Managed Policies and Inline Policies`_ in the *Using IAM* guide. + +.. _`Managed Policies and Inline Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/attach-role-policy.rst b/aws/dist/awscli/examples/iam/attach-role-policy.rst new file mode 100644 index 00000000..449fcd78 --- /dev/null +++ b/aws/dist/awscli/examples/iam/attach-role-policy.rst @@ -0,0 +1,9 @@ +**To attach a managed policy to an IAM role** + +The following ``attach-role-policy`` command attaches the AWS managed policy named ``ReadOnlyAccess`` to the IAM role named ``ReadOnlyRole``:: + + aws iam attach-role-policy --policy-arn arn:aws:iam::aws:policy/ReadOnlyAccess --role-name ReadOnlyRole + +For more information, see `Managed Policies and Inline Policies`_ in the *Using IAM* guide. + +.. _`Managed Policies and Inline Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/attach-user-policy.rst b/aws/dist/awscli/examples/iam/attach-user-policy.rst new file mode 100644 index 00000000..766d5898 --- /dev/null +++ b/aws/dist/awscli/examples/iam/attach-user-policy.rst @@ -0,0 +1,9 @@ +**To attach a managed policy to an IAM user** + +The following ``attach-user-policy`` command attaches the AWS managed policy named ``AdministratorAccess`` to the IAM user named ``Alice``:: + + aws iam attach-user-policy --policy-arn arn:aws:iam:ACCOUNT-ID:aws:policy/AdministratorAccess --user-name Alice + +For more information, see `Managed Policies and Inline Policies`_ in the *Using IAM* guide. + +.. _`Managed Policies and Inline Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html diff --git a/aws/dist/awscli/examples/iam/change-password.rst b/aws/dist/awscli/examples/iam/change-password.rst new file mode 100644 index 00000000..84af3007 --- /dev/null +++ b/aws/dist/awscli/examples/iam/change-password.rst @@ -0,0 +1,22 @@ +**To change the password for your IAM user** + +To change the password for your IAM user, we recommend using the ``--cli-input-json`` parameter to pass a JSON file that contains your old and new passwords. Using this method, you can use strong passwords with non-alphanumeric characters. It can be difficult to use passwords with non-alphanumeric characters when you pass them as command line parameters. To use the ``--cli-input-json`` parameter, start by using the ``change-password`` command with the ``--generate-cli-skeleton`` parameter, as in the following example:: + + aws iam change-password --generate-cli-skeleton > change-password.json + +The previous command creates a JSON file called change-password.json that you can use to fill in your old and new passwords. For example, the file might look like this:: + + { + "OldPassword": "3s0K_;xh4~8XXI", + "NewPassword": "]35d/{pB9Fo9wJ" + } + +Next, to change your password, use the ``change-password`` command again, this time passing the ``--cli-input-json`` parameter to specify your JSON file. The following ``change-password`` command uses the ``--cli-input-json`` parameter with a JSON file called change-password.json:: + + aws iam change-password --cli-input-json file://change-password.json + +This command can be called by IAM users only. If this command is called using AWS account (root) credentials, the command returns an ``InvalidUserType`` error. + +For more information, see `How IAM Users Change Their Own Password`_ in the *Using IAM* guide. + +.. _`How IAM Users Change Their Own Password`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingUserPwdSelf.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-access-key.rst b/aws/dist/awscli/examples/iam/create-access-key.rst new file mode 100644 index 00000000..29d10f8a --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-access-key.rst @@ -0,0 +1,23 @@ +**To create an access key for an IAM user** + +The following ``create-access-key`` command creates an access key (access key ID and secret access key) for the IAM user named ``Bob``:: + + aws iam create-access-key --user-name Bob + +Output:: + + { + "AccessKey": { + "UserName": "Bob", + "Status": "Active", + "CreateDate": "2015-03-09T18:39:23.411Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" + } + } + +Store the secret access key in a secure location. If it is lost, it cannot be recovered, and you must create a new access key. + +For more information, see `Managing Access Keys for IAM Users`_ in the *Using IAM* guide. + +.. _`Managing Access Keys for IAM Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-account-alias.rst b/aws/dist/awscli/examples/iam/create-account-alias.rst new file mode 100644 index 00000000..0b81a8ec --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-account-alias.rst @@ -0,0 +1,9 @@ +**To create an account alias** + +The following ``create-account-alias`` command creates the alias ``examplecorp`` for your AWS account:: + + aws iam create-account-alias --account-alias examplecorp + +For more information, see `Your AWS Account ID and Its Alias`_ in the *Using IAM* guide. + +.. _`Your AWS Account ID and Its Alias`: http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html diff --git a/aws/dist/awscli/examples/iam/create-group.rst b/aws/dist/awscli/examples/iam/create-group.rst new file mode 100644 index 00000000..afe65bac --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-group.rst @@ -0,0 +1,21 @@ +**To create an IAM group** + +The following ``create-group`` command creates an IAM group named ``Admins``:: + + aws iam create-group --group-name Admins + +Output:: + + { + "Group": { + "Path": "/", + "CreateDate": "2015-03-09T20:30:24.940Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "GroupName": "Admins" + } + } + +For more information, see `Creating IAM Groups`_ in the *Using IAM* guide. + +.. _`Creating IAM Groups`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreatingAndListingGroups.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-instance-profile.rst b/aws/dist/awscli/examples/iam/create-instance-profile.rst new file mode 100644 index 00000000..dfaf0276 --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-instance-profile.rst @@ -0,0 +1,24 @@ +**To create an instance profile** + +The following ``create-instance-profile`` command creates an instance profile named ``Webserver``:: + + aws iam create-instance-profile --instance-profile-name Webserver + +Output:: + + { + "InstanceProfile": { + "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", + "Roles": [], + "CreateDate": "2015-03-09T20:33:19.626Z", + "InstanceProfileName": "Webserver", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver" + } + } + +To add a role to an instance profile, use the ``add-role-to-instance-profile`` command. + +For more information, see `Using IAM Roles to Delegate Permissions to Applications that Run on Amazon EC2`_ in the *Using IAM* guide. + +.. _`Using IAM Roles to Delegate Permissions to Applications that Run on Amazon EC2`: http://docs.aws.amazon.com/IAM/latest/UserGuide/roles-usingrole-ec2instance.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-login-profile.rst b/aws/dist/awscli/examples/iam/create-login-profile.rst new file mode 100644 index 00000000..f5bfd475 --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-login-profile.rst @@ -0,0 +1,39 @@ +**To create a password for an IAM user** + +To create a password for an IAM user, we recommend using the ``--cli-input-json`` parameter to pass a JSON file that contains the password. Using this method, you can create a strong password with non-alphanumeric characters. It can be difficult to create a password with non-alphanumeric characters when you pass it as a command line parameter. + +To use the ``--cli-input-json`` parameter, start by using the ``create-login-profile`` command with the ``--generate-cli-skeleton`` parameter, as in the following example:: + + aws iam create-login-profile --generate-cli-skeleton > create-login-profile.json + +The previous command creates a JSON file called create-login-profile.json that you can use to fill in the information for a subsequent ``create-login-profile`` command. For example:: + + { + "UserName": "Bob", + "Password": "&1-3a6u:RA0djs", + "PasswordResetRequired": true + } + +Next, to create a password for an IAM user, use the ``create-login-profile`` command again, this time passing the ``--cli-input-json`` parameter to specify your JSON file. The following ``create-login-profile`` command uses the ``--cli-input-json`` parameter with a JSON file called create-login-profile.json:: + + aws iam create-login-profile --cli-input-json file://create-login-profile.json + +Output:: + + { + "LoginProfile": { + "UserName": "Bob", + "CreateDate": "2015-03-10T20:55:40.274Z", + "PasswordResetRequired": true + } + } + +If the new password violates the account password policy, the command returns a ``PasswordPolicyViolation`` error. + +To change the password for a user that already has one, use ``update-login-profile``. To set a password policy for the account, use the ``update-account-password-policy`` command. + +If the account password policy allows them to, IAM users can change their own passwords using the ``change-password`` command. + +For more information, see `Managing Passwords for IAM Users`_ in the *Using IAM* guide. + +.. _`Managing Passwords for IAM Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/credentials-add-pwd-for-user.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-open-id-connect-provider.rst b/aws/dist/awscli/examples/iam/create-open-id-connect-provider.rst new file mode 100644 index 00000000..1f7d83a6 --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-open-id-connect-provider.rst @@ -0,0 +1,37 @@ +**To create an OpenID Connect (OIDC) provider** + +To create an OpenID Connect (OIDC) provider, we recommend using the ``--cli-input-json`` parameter to pass a JSON file that contains the required parameters. When you create an OIDC provider, you must pass the URL of the provider, and the URL must begin with ``https://``. It can be difficult to pass the URL as a command line parameter, because the colon (:) and forward slash (/) characters have special meaning in some command line environments. Using the ``--cli-input-json`` parameter gets around this limitation. + +To use the ``--cli-input-json`` parameter, start by using the ``create-open-id-connect-provider`` command with the ``--generate-cli-skeleton`` parameter, as in the following example:: + + aws iam create-open-id-connect-provider --generate-cli-skeleton > create-open-id-connect-provider.json + +The previous command creates a JSON file called create-open-id-connect-provider.json that you can use to fill in the information for a subsequent ``create-open-id-connect-provider`` command. For example:: + + { + "Url": "https://server.example.com", + "ClientIDList": [ + "example-application-ID" + ], + "ThumbprintList": [ + "c3768084dfb3d2b68b7897bf5f565da8eEXAMPLE" + ] + } + +Next, to create the OpenID Connect (OIDC) provider, use the ``create-open-id-connect-provider`` command again, this time passing the ``--cli-input-json`` parameter to specify your JSON file. The following ``create-open-id-connect-provider`` command uses the ``--cli-input-json`` parameter with a JSON file called create-open-id-connect-provider.json:: + + aws iam create-open-id-connect-provider --cli-input-json file://create-open-id-connect-provider.json + +Output:: + + { + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + } + +For more information about OIDC providers, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +For more information about obtaining thumbprints for an OIDC provider, see `Obtaining the Thumbprint for an OpenID Connect Provider`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html + +.. _`Obtaining the Thumbprint for an OpenID Connect Provider`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc-obtain-thumbprint.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-policy-version.rst b/aws/dist/awscli/examples/iam/create-policy-version.rst new file mode 100644 index 00000000..1597b67d --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-policy-version.rst @@ -0,0 +1,21 @@ +**To create a new version of a managed policy** + + +This example creates a new ``v2`` version of the IAM policy whose ARN is ``arn:aws:iam::123456789012:policy/MyPolicy`` and makes it the default version:: + + + aws iam create-policy-version --policy-arn arn:aws:iam::123456789012:policy/MyPolicy --policy-document file://NewPolicyVersion.json --set-as-default + +Output:: + + { + "PolicyVersion": { + "CreateDate": "2015-06-16T18:56:03.721Z", + "VersionId": "v2", + "IsDefaultVersion": true + } + } + +For more information, see `Versioning for Managed Policies`_ in the *Using IAM* guide. + +.. _`Versioning for Managed Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_managed-versioning.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-policy.rst b/aws/dist/awscli/examples/iam/create-policy.rst new file mode 100644 index 00000000..e3f32cfd --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-policy.rst @@ -0,0 +1,41 @@ +The following command creates a customer managed policy named ``my-policy``:: + + aws iam create-policy --policy-name my-policy --policy-document file://policy + +Output:: + + { + "Policy": { + "PolicyName": "my-policy", + "CreateDate": "2015-06-01T19:31:18.620Z", + "AttachmentCount": 0, + "IsAttachable": true, + "PolicyId": "ZXR6A36LTYANPAI7NJ5UV", + "DefaultVersionId": "v1", + "Path": "/", + "Arn": "arn:aws:iam::0123456789012:policy/my-policy", + "UpdateDate": "2015-06-01T19:31:18.620Z" + } + } + +The file ``policy`` is a JSON document in the current folder that grants read only access to the ``shared`` folder in an Amazon S3 bucket named ``my-bucket``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "s3:Get*", + "s3:List*" + ], + "Resource": [ + "arn:aws:s3:::my-bucket/shared/*" + ] + } + ] + } + +For more information on using files as input for string parameters, see `Specifying Parameter Values`_ in the *AWS CLI User Guide*. + +.. _`Specifying Parameter Values`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html diff --git a/aws/dist/awscli/examples/iam/create-role.rst b/aws/dist/awscli/examples/iam/create-role.rst new file mode 100644 index 00000000..b7f596af --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-role.rst @@ -0,0 +1,27 @@ +**To create an IAM role** + +The following ``create-role`` command creates a role named ``Test-Role`` and attaches a trust policy to it:: + + aws iam create-role --role-name Test-Role --assume-role-policy-document file://Test-Role-Trust-Policy.json + +Output:: + + { + "Role": { + "AssumeRolePolicyDocument": "", + "RoleId": "AKIAIOSFODNN7EXAMPLE", + "CreateDate": "2013-06-07T20:43:32.821Z", + "RoleName": "Test-Role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/Test-Role" + } + } + +The trust policy is defined as a JSON document in the *Test-Role-Trust-Policy.json* file. (The file name and extension do not have significance.) The trust policy must specify a principal. + +To attach a permissions policy to a role, use the ``put-role-policy`` command. + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/create-saml-provider.rst b/aws/dist/awscli/examples/iam/create-saml-provider.rst new file mode 100644 index 00000000..306849ef --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-saml-provider.rst @@ -0,0 +1,16 @@ +**To create a SAML provider** + +This example creates a new SAML provider in IAM named ``MySAMLProvider``. It is described by the SAML metadata document found in the file ``SAMLMetaData.xml``:: + + aws iam create-saml-provider --saml-metadata-document file://SAMLMetaData.xml --name MySAMLProvider + + +Output:: + + { + "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/MySAMLProvider" + } + +For more information, see `Using SAML Providers`_ in the *Using IAM* guide. + +.. _`Using SAML Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-saml.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/create-service-linked-role.rst b/aws/dist/awscli/examples/iam/create-service-linked-role.rst new file mode 100644 index 00000000..1b8231ac --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-service-linked-role.rst @@ -0,0 +1,37 @@ +**To create a service-linked role** + +The following ``create-service-linked-role`` example creates a service-linked role for the specified AWS service and attaches the specified description. :: + + aws iam create-service-linked-role \ + --aws-service-name lex.amazonaws.com \ + --description "My service-linked role to support Lex" + +Output:: + + { + "Role": { + "Path": "/aws-service-role/lex.amazonaws.com/", + "RoleName": "AWSServiceRoleForLexBots", + "RoleId": "AROA1234567890EXAMPLE", + "Arn": "arn:aws:iam::1234567890:role/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots", + "CreateDate": "2019-04-17T20:34:14+00:00", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "sts:AssumeRole" + ], + "Effect": "Allow", + "Principal": { + "Service": [ + "lex.amazonaws.com" + ] + } + } + ] + } + } + } + +For more information, see `Using Service-Linked Roles `_ in the *IAM User Guide*. diff --git a/aws/dist/awscli/examples/iam/create-service-specific-credential.rst b/aws/dist/awscli/examples/iam/create-service-specific-credential.rst new file mode 100644 index 00000000..89b87d4e --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-service-specific-credential.rst @@ -0,0 +1,23 @@ +**Create a set of service-specific credentials for a user** + +The following ``create-service-specific-credential`` example creates a username and password that can be used to access only the configured service. :: + + aws iam create-service-specific-credential --user-name sofia --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "k1zPZM6uVxMQ3oxqgoYlNuJPyRTZ1vREs76zTQE3eJk=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff --git a/aws/dist/awscli/examples/iam/create-user.rst b/aws/dist/awscli/examples/iam/create-user.rst new file mode 100644 index 00000000..6a50e483 --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-user.rst @@ -0,0 +1,21 @@ +**To create an IAM user** + +The following ``create-user`` command creates an IAM user named ``Bob`` in the current account:: + + aws iam create-user --user-name Bob + +Output:: + + { + "User": { + "UserName": "Bob", + "Path": "/", + "CreateDate": "2013-06-08T03:20:41.270Z", + "UserId": "AIDAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Bob" + } + } + +For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. + +.. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html diff --git a/aws/dist/awscli/examples/iam/create-virtual-mfa-device.rst b/aws/dist/awscli/examples/iam/create-virtual-mfa-device.rst new file mode 100644 index 00000000..a36dad62 --- /dev/null +++ b/aws/dist/awscli/examples/iam/create-virtual-mfa-device.rst @@ -0,0 +1,18 @@ +**To create a virtual MFA device** + +This example creates a new virtual MFA device called ``BobsMFADevice``. It creates a file that contains bootstrap information called ``QRCode.png`` +and places it in the ``C:/`` directory. The bootstrap method used in this example is ``QRCodePNG``:: + + + aws iam create-virtual-mfa-device --virtual-mfa-device-name BobsMFADevice --outfile C:/QRCode.png --bootstrap-method QRCodePNG + +Output:: + + { + "VirtualMFADevice": { + "SerialNumber": "arn:aws:iam::210987654321:mfa/BobsMFADevice" + } + +For more information, see `Using Multi-Factor Authentication (MFA) Devices with AWS`_ in the *Using IAM* guide. + +.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingMFA.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/deactivate-mfa-device.rst b/aws/dist/awscli/examples/iam/deactivate-mfa-device.rst new file mode 100644 index 00000000..1fb25857 --- /dev/null +++ b/aws/dist/awscli/examples/iam/deactivate-mfa-device.rst @@ -0,0 +1,10 @@ +**To deactivate an MFA device** + +This command deactivates the virtual MFA device with the ARN ``arn:aws:iam::210987654321:mfa/BobsMFADevice`` that is associated with the user ``Bob``:: + + aws iam deactivate-mfa-device --user-name Bob --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice + + +For more information, see `Using Multi-Factor Authentication (MFA) Devices with AWS`_ in the *Using IAM* guide. + +.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingMFA.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/decode-authorization-message.rst b/aws/dist/awscli/examples/iam/decode-authorization-message.rst new file mode 100644 index 00000000..c14df164 --- /dev/null +++ b/aws/dist/awscli/examples/iam/decode-authorization-message.rst @@ -0,0 +1,12 @@ +**To decode a authorization failure message** + +The following ``decode-authorization-message`` example decodes the message returned by the EC2 console when attempting to launch an instance without the required permissions. :: + + aws sts decode-authorization-message \ + --encoded-message lxzA8VEjEvu-s0TTt3PgYCXik9YakOqsrFJGRZR98xNcyWAxwRq14xIvd-npzbgTevuufCTbjeBAaDARg9cbTK1rJbg3awM33o-Vy3ebPErE2-mWR9hVYdvX-0zKgVOWF9pWjZaJSMqxB-aLXo-I_8TTvBq88x8IFPbMArNdpu0IjxDjzf22PF3SOE3XvIQ-_PEO0aUqHCCcsSrFtvxm6yQD1nbm6VTIVrfa0Bzy8lsoMo7SjIaJ2r5vph6SY5vCCwg6o2JKe3hIHTa8zRrDbZSFMkcXOT6EOPkQXmaBsAC6ciG7Pz1JnEOvuj5NSTlSMljrAXczWuRKAs5GsMYiU8KZXZhokVzdQCUZkS5aVHumZbadu0io53jpgZqhMqvS4fyfK4auK0yKRMtS6JCXPlhkolEs7ZMFA0RVkutqhQqpSDPB5SX5l00lYipWyFK0_AyAx60vumPuVh8P0AzXwdFsT0l4D0m42NFIKxbWXsoJdqaOqVFyFEd0-Xx9AYAAIr6bhcis7C__bZh4dlAAWooHFGKgfoJcWGwgdzgbu9hWyVvKTpeot5hsb8qANYjJRCPXTKpi6PZfdijIkwb6gDMEsJ9qMtr62qP_989mwmtNgnVvBa_ir6oxJxVe_kL9SH1j5nsGDxQFajvPQhxWOHvEQIg_H0bnKWk + +The output is formatted as a single-line string of JSON text that you can parse with any JSON text processor:: + + { + "DecodedMessage": "{\"allowed\":false,\"explicitDeny\":false,\"matchedStatements\":{\"items\":[]},\"failures\":{\"items\":[]},\"context\":{\"principal\":{\"id\":\"AIDAV3ZUEFP6J7GY7O6LO\",\"name\":\"chain-user\",\"arn\":\"arn:aws:iam::403299380220:user/chain-user\"},\"action\":\"ec2:RunInstances\",\"resource\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\",\"conditions\":{\"items\":[{\"key\":\"ec2:InstanceMarketType\",\"values\":{\"items\":[{\"value\":\"on-demand\"}]}},{\"key\":\"aws:Resource\",\"values\":{\"items\":[{\"value\":\"instance/*\"}]}},{\"key\":\"aws:Account\",\"values\":{\"items\":[{\"value\":\"403299380220\"}]}},{\"key\":\"ec2:AvailabilityZone\",\"values\":{\"items\":[{\"value\":\"us-east-2b\"}]}},{\"key\":\"ec2:ebsOptimized\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:IsLaunchTemplateResource\",\"values\":{\"items\":[{\"value\":\"false\"}]}},{\"key\":\"ec2:InstanceType\",\"values\":{\"items\":[{\"value\":\"t2.micro\"}]}},{\"key\":\"ec2:RootDeviceType\",\"values\":{\"items\":[{\"value\":\"ebs\"}]}},{\"key\":\"aws:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:Service\",\"values\":{\"items\":[{\"value\":\"ec2\"}]}},{\"key\":\"ec2:InstanceID\",\"values\":{\"items\":[{\"value\":\"*\"}]}},{\"key\":\"aws:Type\",\"values\":{\"items\":[{\"value\":\"instance\"}]}},{\"key\":\"ec2:Tenancy\",\"values\":{\"items\":[{\"value\":\"default\"}]}},{\"key\":\"ec2:Region\",\"values\":{\"items\":[{\"value\":\"us-east-2\"}]}},{\"key\":\"aws:ARN\",\"values\":{\"items\":[{\"value\":\"arn:aws:ec2:us-east-2:403299380220:instance/*\"}]}}]}}}" + } diff --git a/aws/dist/awscli/examples/iam/delete-access-key.rst b/aws/dist/awscli/examples/iam/delete-access-key.rst new file mode 100644 index 00000000..372e5029 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-access-key.rst @@ -0,0 +1,13 @@ +**To delete an access key for an IAM user** + +The following ``delete-access-key`` command deletes the specified access key (access key ID and secret access key) for the IAM user named ``Bob``:: + + aws iam delete-access-key --access-key-id AKIDPMS9RO4H3FEXAMPLE --user-name Bob + +To list the access keys defined for an IAM user, use the ``list-access-keys`` command. + +For more information, see `Creating, Modifying, and Viewing User Security Credentials`_ in the *Using IAM* guide. + +.. _`Creating, Modifying, and Viewing User Security Credentials`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreateAccessKey.html + + diff --git a/aws/dist/awscli/examples/iam/delete-account-alias.rst b/aws/dist/awscli/examples/iam/delete-account-alias.rst new file mode 100644 index 00000000..3e3bc6f2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-account-alias.rst @@ -0,0 +1,9 @@ +**To delete an account alias** + +The following ``delete-account-alias`` command removes the alias ``mycompany`` for the current account:: + + aws iam delete-account-alias --account-alias mycompany + +For more information, see `Using an Alias for Your AWS Account ID`_ in the *Using IAM* guide. + +.. _`Using an Alias for Your AWS Account ID`: http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html diff --git a/aws/dist/awscli/examples/iam/delete-account-password-policy.rst b/aws/dist/awscli/examples/iam/delete-account-password-policy.rst new file mode 100644 index 00000000..c9f16f94 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-account-password-policy.rst @@ -0,0 +1,10 @@ +**To delete the current account password policy** + +The following ``delete-account-password-policy`` command removes the password policy for the current account:: + + aws iam delete-account-password-policy + +For more information, see `Managing an IAM Password Policy`_ in the *Using IAM* guide. + +.. _`Managing an IAM Password Policy`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html + diff --git a/aws/dist/awscli/examples/iam/delete-group-policy.rst b/aws/dist/awscli/examples/iam/delete-group-policy.rst new file mode 100644 index 00000000..0d96d7c2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-group-policy.rst @@ -0,0 +1,12 @@ +**To delete a policy from an IAM group** + +The following ``delete-group-policy`` command deletes the policy named ``ExamplePolicy`` from the group named ``Admins``:: + + aws iam delete-group-policy --group-name Admins --policy-name ExamplePolicy + +To see the policies attached to a group, use the ``list-group-policies`` command. + +For more information, see `Managing IAM Policies`_ in the *Using IAM* guide. + +.. _`Managing IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingPolicies.html + diff --git a/aws/dist/awscli/examples/iam/delete-group.rst b/aws/dist/awscli/examples/iam/delete-group.rst new file mode 100644 index 00000000..9ce04da0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-group.rst @@ -0,0 +1,10 @@ +**To delete an IAM group** + +The following ``delete-group`` command deletes an IAM group named ``MyTestGroup``:: + + aws iam delete-group --group-name MyTestGroup + + +For more information, see `Deleting an IAM Group`_ in the *Using IAM* guide. + +.. _`Deleting an IAM Group`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_DeleteGroup.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/delete-instance-profile.rst b/aws/dist/awscli/examples/iam/delete-instance-profile.rst new file mode 100644 index 00000000..8cc50cb8 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-instance-profile.rst @@ -0,0 +1,10 @@ +**To delete an instance profile** + +The following ``delete-instance-profile`` command deletes the instance profile named ``ExampleInstanceProfile``:: + + aws iam delete-instance-profile --instance-profile-name ExampleInstanceProfile + +For more information, see `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Instance Profiles`: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html + diff --git a/aws/dist/awscli/examples/iam/delete-login-profile.rst b/aws/dist/awscli/examples/iam/delete-login-profile.rst new file mode 100644 index 00000000..e696d0fb --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-login-profile.rst @@ -0,0 +1,11 @@ +**To delete a password for an IAM user** + +The following ``delete-login-profile`` command deletes the password for the IAM user named ``Bob``:: + + aws iam delete-login-profile --user-name Bob + +For more information, see `Managing Passwords`_ in the *Using IAM* guide. + +.. _`Managing Passwords`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html + + diff --git a/aws/dist/awscli/examples/iam/delete-open-id-connect-provider.rst b/aws/dist/awscli/examples/iam/delete-open-id-connect-provider.rst new file mode 100644 index 00000000..efba757e --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-open-id-connect-provider.rst @@ -0,0 +1,10 @@ +**To delete an IAM OpenID Connect identity provider** + +This example deletes the IAM OIDC provider that connects to the provider ``example.oidcprovider.com``:: + + aws iam delete-open-id-connect-provider --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com + + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreatingAndListingGroups.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/delete-policy-version.rst b/aws/dist/awscli/examples/iam/delete-policy-version.rst new file mode 100644 index 00000000..dfc47a6a --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-policy-version.rst @@ -0,0 +1,10 @@ +**To delete a version of a managed policy** + +This example deletes the version identified as ``v2`` from the policy whose ARN is ``arn:aws:iam::123456789012:policy/MySamplePolicy``:: + + aws iam delete-policy-version --policy-arn arn:aws:iam::123456789012:policy/MyPolicy --version-id v2 + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/delete-policy.rst b/aws/dist/awscli/examples/iam/delete-policy.rst new file mode 100644 index 00000000..0f868593 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-policy.rst @@ -0,0 +1,10 @@ +**To delete an IAM policy** + +This example deletes the policy whose ARN is ``arn:aws:iam::123456789012:policy/MySamplePolicy``:: + + aws iam delete-policy --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/delete-role-permissions-boundary.rst b/aws/dist/awscli/examples/iam/delete-role-permissions-boundary.rst new file mode 100755 index 00000000..98f93fb5 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-role-permissions-boundary.rst @@ -0,0 +1,8 @@ +**To delete a permissions boundary from an IAM role** + +The following ``delete-role-permissions-boundary`` example deletes the permissions boundary for the specified IAM role. To apply a permissions boundary to a role, use the ``put-role-permissions-boundary`` command. :: + + aws iam delete-role-permissions-boundary \ + --role-name lambda-application-role + +This command produces no output. diff --git a/aws/dist/awscli/examples/iam/delete-role-policy.rst b/aws/dist/awscli/examples/iam/delete-role-policy.rst new file mode 100644 index 00000000..c2c802ea --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-role-policy.rst @@ -0,0 +1,10 @@ +**To remove a policy from an IAM role** + +The following ``delete-role-policy`` command removes the policy named ``ExamplePolicy`` from the role named ``Test-Role``:: + + aws iam delete-role-policy --role-name Test-Role --policy-name ExamplePolicy + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/delete-role.rst b/aws/dist/awscli/examples/iam/delete-role.rst new file mode 100644 index 00000000..2c48d893 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-role.rst @@ -0,0 +1,14 @@ +**To delete an IAM role** + +The following ``delete-role`` command removes the role named ``Test-Role``:: + + aws iam delete-role --role-name Test-Role + +Before you can delete a role, you must remove the role from any instance profile (``remove-role-from-instance-profile``), detach any managed policies (``detach-role-policy``) and delete any inline policies that are attached to the role (``delete-role-policy``). + +For more information, see `Creating a Role`_ and `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html +.. _Instance Profiles: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html + + diff --git a/aws/dist/awscli/examples/iam/delete-saml-provider.rst b/aws/dist/awscli/examples/iam/delete-saml-provider.rst new file mode 100644 index 00000000..af87cf1f --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-saml-provider.rst @@ -0,0 +1,10 @@ +**To delete a SAML provider** + +This example deletes the IAM SAML 2.0 provider whose ARN is ``arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider``:: + + aws iam delete-saml-provider --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFSProvider + + +For more information, see `Using SAML Providers`_ in the *Using IAM* guide. + +.. _`Using SAML Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-saml.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/delete-server-certificate.rst b/aws/dist/awscli/examples/iam/delete-server-certificate.rst new file mode 100644 index 00000000..9dd8553a --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-server-certificate.rst @@ -0,0 +1,11 @@ +**To delete a server certificate from your AWS account** + +The following ``delete-server-certificate`` command removes the specified server certificate from your AWS account. This command produces no output. :: + + aws iam delete-server-certificate --server-certificate-name myUpdatedServerCertificate + +To list the server certificates available in your AWS account, use the ``list-server-certificates`` command. + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html diff --git a/aws/dist/awscli/examples/iam/delete-service-linked-role.rst b/aws/dist/awscli/examples/iam/delete-service-linked-role.rst new file mode 100644 index 00000000..e0f1911b --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-service-linked-role.rst @@ -0,0 +1,13 @@ +**To delete a service-linked role** + +The following ``delete-service-linked-role`` example deletes the specified service-linked role that you no longer need. The deletion happens asynchronously. You can check the status of the deletion and confirm when it is done by using the ``get-service-linked-role-deletion-status`` command. :: + + aws iam delete-service-linked-role --role-name AWSServiceRoleForLexBots + +Output:: + + { + "DeletionTaskId": "task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE" + } + +For more information, see `Using Service-Linked Roles `_ in the *IAM User Guide*. diff --git a/aws/dist/awscli/examples/iam/delete-service-specific-credential.rst b/aws/dist/awscli/examples/iam/delete-service-specific-credential.rst new file mode 100644 index 00000000..a8ab992f --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-service-specific-credential.rst @@ -0,0 +1,15 @@ +**Delete a service-specific credential for the requesting user** + +The following ``delete-service-specific-credential`` example deletes the specified service-specific credential for the user making the request. The ``service-specific-credential-id`` is provided when you create the credential and you can retrieve it by using the ``list-service-specific-credentials`` command. This command produces no output. :: + + aws iam delete-service-specific-credential --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +**Delete a service-specific credential for a specified user** + +The following ``delete-service-specific-credential`` example deletes the specified service-specific credential for the specified user. The ``service-specific-credential-id`` is provided when you create the credential and you can retrieve it by using the ``list-service-specific-credentials`` command. This command produces no output. :: + + aws iam delete-service-specific-credential --user-name sofia --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff --git a/aws/dist/awscli/examples/iam/delete-signing-certificate.rst b/aws/dist/awscli/examples/iam/delete-signing-certificate.rst new file mode 100644 index 00000000..c1a5ff66 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-signing-certificate.rst @@ -0,0 +1,12 @@ +**To delete a signing certificate for an IAM user** + +The following ``delete-signing-certificate`` command deletes the specified signing certificate for the IAM user named ``Bob``:: + + aws iam delete-signing-certificate --user-name Bob --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE + +To get the ID for a signing certificate, use the ``list-signing-certificates`` command. + +For more information, see `Creating and Uploading a User Signing Certificate`_ in the *Using IAM* guide. + +.. _`Creating and Uploading a User Signing Certificate`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_UploadCertificate.html + diff --git a/aws/dist/awscli/examples/iam/delete-ssh-public-key.rst b/aws/dist/awscli/examples/iam/delete-ssh-public-key.rst new file mode 100644 index 00000000..2a773569 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-ssh-public-key.rst @@ -0,0 +1,7 @@ +**To delete an SSH public keys attached to an IAM user** + +The following ``delete-ssh-public-key`` command deletes the specified SSH public key attached to the IAM user ``sofia``. This command does not produce any output. :: + + aws iam delete-ssh-public-key --user-name sofia --ssh-public-key-id APKA123456789EXAMPLE + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide*. diff --git a/aws/dist/awscli/examples/iam/delete-user-permissions-boundary.rst b/aws/dist/awscli/examples/iam/delete-user-permissions-boundary.rst new file mode 100755 index 00000000..9bff3499 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-user-permissions-boundary.rst @@ -0,0 +1,8 @@ +**To delete a permissions boundary from an IAM user** + +The following ``delete-user-permissions-boundary`` example deletes the permissions boundary attached to the IAM user named ``intern``. To apply a permissions boundary to a user, use the ``put-user-permissions-boundary`` command. :: + + aws iam delete-user-permissions-boundary \ + --user-name intern + +This command produces no output. diff --git a/aws/dist/awscli/examples/iam/delete-user-policy.rst b/aws/dist/awscli/examples/iam/delete-user-policy.rst new file mode 100644 index 00000000..ef058aa2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-user-policy.rst @@ -0,0 +1,16 @@ +**To remove a policy from an IAM user** + +The following ``delete-user-policy`` command removes the specified policy from the IAM user named ``Bob``:: + + aws iam delete-user-policy --user-name Bob --policy-name ExamplePolicy + +To get a list of policies for an IAM user, use the ``list-user-policies`` command. + +For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. + +.. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html + + + + + diff --git a/aws/dist/awscli/examples/iam/delete-user.rst b/aws/dist/awscli/examples/iam/delete-user.rst new file mode 100644 index 00000000..0883b906 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-user.rst @@ -0,0 +1,10 @@ +**To delete an IAM user** + +The following ``delete-user`` command removes the IAM user named ``Bob`` from the current account:: + + aws iam delete-user --user-name Bob + +For more information, see `Deleting a User from Your AWS Account`_ in the *Using IAM* guide. + +.. _`Deleting a User from Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_DeletingUserFromAccount.html + diff --git a/aws/dist/awscli/examples/iam/delete-virtual-mfa-device.rst b/aws/dist/awscli/examples/iam/delete-virtual-mfa-device.rst new file mode 100644 index 00000000..3a72da69 --- /dev/null +++ b/aws/dist/awscli/examples/iam/delete-virtual-mfa-device.rst @@ -0,0 +1,10 @@ +**To remove a virtual MFA device** + +The following ``delete-virtual-mfa-device`` command removes the specified MFA device from the current account:: + + aws iam delete-virtual-mfa-device --serial-number arn:aws:iam::123456789012:mfa/MFATest + +For more information, see `Using a Virtual MFA Device with AWS`_ in the *Using IAM* guide. + +.. _`Using a Virtual MFA Device with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html + diff --git a/aws/dist/awscli/examples/iam/detach-group-policy.rst b/aws/dist/awscli/examples/iam/detach-group-policy.rst new file mode 100644 index 00000000..5c90552d --- /dev/null +++ b/aws/dist/awscli/examples/iam/detach-group-policy.rst @@ -0,0 +1,10 @@ +**To detach a policy from a group** + +This example removes the managed policy with the ARN ``arn:aws:iam::123456789012:policy/TesterAccessPolicy`` from the group called ``Testers``:: + + aws iam detach-group-policy --group-name Testers --policy-arn arn:aws:iam::123456789012:policy/TesterAccessPolicy + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/detach-role-policy.rst b/aws/dist/awscli/examples/iam/detach-role-policy.rst new file mode 100644 index 00000000..bf7e0cd0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/detach-role-policy.rst @@ -0,0 +1,10 @@ +**To detach a policy from a role** + +This example removes the managed policy with the ARN ``arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy`` from the role called ``FedTesterRole``:: + + aws iam detach-role-policy --role-name FedTesterRole --policy-arn arn:aws:iam::123456789012:policy/FederatedTesterAccessPolicy + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/detach-user-policy.rst b/aws/dist/awscli/examples/iam/detach-user-policy.rst new file mode 100644 index 00000000..65a31893 --- /dev/null +++ b/aws/dist/awscli/examples/iam/detach-user-policy.rst @@ -0,0 +1,10 @@ +**To detach a policy from a user** + +This example removes the managed policy with the ARN ``arn:aws:iam::123456789012:policy/TesterPolicy`` from the user ``Bob``:: + + aws iam detach-user-policy --user-name Bob --policy-arn arn:aws:iam::123456789012:policy/TesterPolicy + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/enable-mfa-device.rst b/aws/dist/awscli/examples/iam/enable-mfa-device.rst new file mode 100644 index 00000000..e23ab84c --- /dev/null +++ b/aws/dist/awscli/examples/iam/enable-mfa-device.rst @@ -0,0 +1,12 @@ +**To enable an MFA device** + +After you ran the ``create-virtual-mfa-device`` command to create a new virtual MFA device, you can then assign this MFA device to a user. +The following example assigns the MFA device with the serial number ``arn:aws:iam::210987654321:mfa/BobsMFADevice`` to the user ``Bob``. +The command also synchronizes the device with AWS by including the first two codes in sequence from the virtual MFA device:: + + aws iam enable-mfa-device --user-name Bob --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice --authentication-code-1 123456 --authentication-code-2 789012 + + +For more information, see `Using a Virtual MFA Device with AWS`_ in the *Using IAM* guide. + +.. _`Using a Virtual MFA Device with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/generate-credential-report.rst b/aws/dist/awscli/examples/iam/generate-credential-report.rst new file mode 100644 index 00000000..f06ed4df --- /dev/null +++ b/aws/dist/awscli/examples/iam/generate-credential-report.rst @@ -0,0 +1,16 @@ +**To generate a credential report** + +The following example attempts to generate a credential report for the AWS account:: + + aws iam generate-credential-report + +Output:: + + { + "State": "STARTED", + "Description": "No report exists. Starting a new report generation task" + } + +For more information, see `Getting Credential Reports for Your AWS Account`_ in the *Using IAM* guide. + +.. _`Getting Credential Reports for Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/generate-organizations-access-report.rst b/aws/dist/awscli/examples/iam/generate-organizations-access-report.rst new file mode 100755 index 00000000..4c8595d9 --- /dev/null +++ b/aws/dist/awscli/examples/iam/generate-organizations-access-report.rst @@ -0,0 +1,40 @@ +**Example 1: To generate an access report for a root in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for the specified root in an organization. You can display the report after it's created by running the ``get-organizations-access-report`` command. :: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb + +Output:: + + { + "JobId": "a8b6c06f-aaa4-8xmp-28bc-81da71836359" + } + +**Example 2: To generate an access report for an account in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for account ID ``123456789012`` in the organization ``o-4fxmplt198``. You can display the report after it's created by running the ``get-organizations-access-report`` command. :: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb/123456789012 + +Output:: + + { + "JobId": "14b6c071-75f6-2xmp-fb77-faf6fb4201d2" + } + +**Example 3: To generate an access report for an account in an organizational unit in an organization** + +The following ``generate-organizations-access-report`` example starts a background job to create an access report for account ID ``234567890123`` in organizational unit ``ou-c3xb-lmu7j2yg`` in the organization ``o-4fxmplt198``. You can display the report after it's created by running the ``get-organizations-access-report`` command.:: + + aws iam generate-organizations-access-report \ + --entity-path o-4fxmplt198/r-c3xb/ou-c3xb-lmu7j2yg/234567890123 + +Output:: + + { + "JobId": "2eb6c2e6-0xmp-ec04-1425-c937916a64af" + } + +To get details about roots and organizational units in your organization, use the ``organizations list-roots`` and ``organizations list-organizational-units-for-parent`` commands. \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/generate-service-last-accessed-details.rst b/aws/dist/awscli/examples/iam/generate-service-last-accessed-details.rst new file mode 100755 index 00000000..d3c7827a --- /dev/null +++ b/aws/dist/awscli/examples/iam/generate-service-last-accessed-details.rst @@ -0,0 +1,23 @@ +**To generate a service access report** + +The following ``generate-service-last-accessed-details`` example starts a background job to generate a report that lists the services accessed by IAM users and other entities with a custom policy named ``intern-boundary``. You can display the report after it is created by running the ``get-service-last-accessed-details`` command. :: + + aws iam generate-service-last-accessed-details \ + --arn arn:aws:iam::123456789012:policy/intern-boundary + +Output:: + + { + "JobId": "2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc" + } + +The following ``generate-service-last-accessed-details`` example starts a background job to generate a report that lists the services accessed by IAM users and other entities with the AWS managed ``AdministratorAccess`` policy. You can display the report after it is created by running the ``get-service-last-accessed-details`` command.:: + + aws iam generate-service-last-accessed-details \ + --arn arn:aws:iam::aws:policy/AdministratorAccess + +Output:: + + { + "JobId": "78b6c2ba-d09e-6xmp-7039-ecde30b26916" + } diff --git a/aws/dist/awscli/examples/iam/get-access-key-last-used.rst b/aws/dist/awscli/examples/iam/get-access-key-last-used.rst new file mode 100644 index 00000000..7bfbb647 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-access-key-last-used.rst @@ -0,0 +1,21 @@ +**To retrieve information about when the specified access key was last used** + +The following example retrieves information about when the access key ``ABCDEXAMPLE`` was last used:: + + aws iam get-access-key-last-used --access-key-id ABCDEXAMPLE + + +Output:: + + { + "UserName": "Bob", + "AccessKeyLastUsed": { + "Region": "us-east-1", + "ServiceName": "iam", + "LastUsedDate": "2015-06-16T22:45:00Z" + } + } + +For more information, see `Managing Access Keys for IAM Users`_ in the *Using IAM* guide. + +.. _`Managing Access Keys for IAM Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingCredentials.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-account-authorization-details.rst b/aws/dist/awscli/examples/iam/get-account-authorization-details.rst new file mode 100644 index 00000000..379eb98a --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-account-authorization-details.rst @@ -0,0 +1,288 @@ +The following ``get-account-authorization-details`` command returns information about all IAM users, groups, roles, and policies in the AWS account:: + + aws iam get-account-authorization-details + +Output:: + + { + "RoleDetailList": [ + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "", + "Effect": "Allow", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] + }, + "RoleId": "AROAFP4BKI7Y7TEXAMPLE", + "CreateDate": "2014-07-30T17:09:20Z", + "InstanceProfileList": [ + { + "InstanceProfileId": "AIPAFFYRBHWXW2EXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": { + "Version":"2012-10-17", + "Statement": [ + { + "Sid":"", + "Effect":"Allow", + "Principal": { + "Service":"ec2.amazonaws.com" + }, + "Action":"sts:AssumeRole" + } + ] + }, + "RoleId": "AROAFP4BKI7Y7TEXAMPLE", + "CreateDate": "2014-07-30T17:09:20Z", + "RoleName": "EC2role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/EC2role" + } + ], + "CreateDate": "2014-07-30T17:09:20Z", + "InstanceProfileName": "EC2role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/EC2role" + } + ], + "RoleName": "EC2role", + "Path": "/", + "AttachedManagedPolicies": [ + { + "PolicyName": "AmazonS3FullAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AmazonS3FullAccess" + }, + { + "PolicyName": "AmazonDynamoDBFullAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AmazonDynamoDBFullAccess" + } + ], + "RolePolicyList": [], + "Arn": "arn:aws:iam::123456789012:role/EC2role" + }], + "GroupDetailList": [ + { + "GroupId": "AIDACKCEVSQ6C7EXAMPLE", + "AttachedManagedPolicies": { + "PolicyName": "AdministratorAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" + }, + "GroupName": "Admins", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2013-10-14T18:32:24Z", + "GroupPolicyList": [] + }, + { + "GroupId": "AIDACKCEVSQ6C8EXAMPLE", + "AttachedManagedPolicies": { + "PolicyName": "PowerUserAccess", + "PolicyArn": "arn:aws:iam::aws:policy/PowerUserAccess" + }, + "GroupName": "Dev", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Dev", + "CreateDate": "2013-10-14T18:33:55Z", + "GroupPolicyList": [] + }, + { + "GroupId": "AIDACKCEVSQ6C9EXAMPLE", + "AttachedManagedPolicies": [], + "GroupName": "Finance", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:group/Finance", + "CreateDate": "2013-10-14T18:57:48Z", + "GroupPolicyList": [ + { + "PolicyName": "policygen-201310141157", + "PolicyDocument": { + "Version":"2012-10-17", + "Statement": [ + { + "Action": "aws-portal:*", + "Sid":"Stmt1381777017000", + "Resource": "*", + "Effect":"Allow" + } + ] + } + } + ] + }], + "UserDetailList": [ + { + "UserName": "Alice", + "GroupList": [ + "Admins" + ], + "CreateDate": "2013-10-14T18:32:24Z", + "UserId": "AIDACKCEVSQ6C2EXAMPLE", + "UserPolicyList": [], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Alice" + }, + { + "UserName": "Bob", + "GroupList": [ + "Admins" + ], + "CreateDate": "2013-10-14T18:32:25Z", + "UserId": "AIDACKCEVSQ6C3EXAMPLE", + "UserPolicyList": [ + { + "PolicyName": "DenyBillingAndIAMPolicy", + "PolicyDocument": { + "Version":"2012-10-17", + "Statement": { + "Effect":"Deny", + "Action": [ + "aws-portal:*", + "iam:*" + ], + "Resource":"*" + } + } + } + ], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Bob" + }, + { + "UserName": "Charlie", + "GroupList": [ + "Dev" + ], + "CreateDate": "2013-10-14T18:33:56Z", + "UserId": "AIDACKCEVSQ6C4EXAMPLE", + "UserPolicyList": [], + "Path": "/", + "AttachedManagedPolicies": [], + "Arn": "arn:aws:iam::123456789012:user/Charlie" + }], + "Policies": [ + { + "PolicyName": "create-update-delete-set-managed-policies", + "CreateDate": "2015-02-06T19:58:34Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPAJ2UCCR6DPCEXAMPLE", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2015-02-06T19:58:34Z", + "VersionId": "v1", + "Document": { + "Version":"2012-10-17", + "Statement": { + "Effect":"Allow", + "Action": [ + "iam:CreatePolicy", + "iam:CreatePolicyVersion", + "iam:DeletePolicy", + "iam:DeletePolicyVersion", + "iam:GetPolicy", + "iam:GetPolicyVersion", + "iam:ListPolicies", + "iam:ListPolicyVersions", + "iam:SetDefaultPolicyVersion" + ], + "Resource": "*" + } + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/create-update-delete-set-managed-policies", + "UpdateDate": "2015-02-06T19:58:34Z" + }, + { + "PolicyName": "S3-read-only-specific-bucket", + "CreateDate": "2015-01-21T21:39:41Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPAJ4AE5446DAEXAMPLE", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2015-01-21T21:39:41Z", + "VersionId": "v1", + "Document": { + "Version":"2012-10-17", + "Statement": [ + { + "Effect":"Allow", + "Action": [ + "s3:Get*", + "s3:List*" + ], + "Resource": [ + "arn:aws:s3:::example-bucket", + "arn:aws:s3:::example-bucket/*" + ] + } + ] + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/S3-read-only-specific-bucket", + "UpdateDate": "2015-01-21T23:39:41Z" + }, + { + "PolicyName": "AmazonEC2FullAccess", + "CreateDate": "2015-02-06T18:40:15Z", + "AttachmentCount": 1, + "IsAttachable": true, + "PolicyId": "ANPAE3QWE5YT46TQ34WLG", + "DefaultVersionId": "v1", + "PolicyVersionList": [ + { + "CreateDate": "2014-10-30T20:59:46Z", + "VersionId": "v1", + "Document": { + "Version":"2012-10-17", + "Statement": [ + { + "Action":"ec2:*", + "Effect":"Allow", + "Resource":"*" + }, + { + "Effect":"Allow", + "Action":"elasticloadbalancing:*", + "Resource":"*" + }, + { + "Effect":"Allow", + "Action":"cloudwatch:*", + "Resource":"*" + }, + { + "Effect":"Allow", + "Action":"autoscaling:*", + "Resource":"*" + } + ] + }, + "IsDefaultVersion": true + } + ], + "Path": "/", + "Arn": "arn:aws:iam::aws:policy/AmazonEC2FullAccess", + "UpdateDate": "2015-02-06T18:40:15Z" + }], + "Marker": "EXAMPLEkakv9BCuUNFDtxWSyfzetYwEx2ADc8dnzfvERF5S6YMvXKx41t6gCl/eeaCX3Jo94/bKqezEAg8TEVS99EKFLxm3jtbpl25FDWEXAMPLE", + "IsTruncated": true + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-account-password-policy.rst b/aws/dist/awscli/examples/iam/get-account-password-policy.rst new file mode 100644 index 00000000..ac256063 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-account-password-policy.rst @@ -0,0 +1,24 @@ +**To see the current account password policy** + +The following ``get-account-password-policy`` command displays details about the password policy for the current account:: + + aws iam get-account-password-policy + +Output:: + + { + "PasswordPolicy": { + "AllowUsersToChangePassword": false, + "RequireLowercaseCharacters": false, + "RequireUppercaseCharacters": false, + "MinimumPasswordLength": 8, + "RequireNumbers": true, + "RequireSymbols": true + } + } + +If no password policy is defined for the account, the command returns a ``NoSuchEntity`` error. + +For more information, see `Managing an IAM Password Policy`_ in the *Using IAM* guide. + +.. _`Managing an IAM Password Policy`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html diff --git a/aws/dist/awscli/examples/iam/get-account-summary.rst b/aws/dist/awscli/examples/iam/get-account-summary.rst new file mode 100644 index 00000000..1604a041 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-account-summary.rst @@ -0,0 +1,39 @@ +**To get information about IAM entity usage and IAM quotas in the current account** + +The following ``get-account-summary`` command returns information about the current IAM entity usage and current IAM entity quotas in the account:: + + aws iam get-account-summary + +Output:: + + { + "SummaryMap": { + "UsersQuota": 5000, + "GroupsQuota": 100, + "InstanceProfiles": 6, + "SigningCertificatesPerUserQuota": 2, + "AccountAccessKeysPresent": 0, + "RolesQuota": 250, + "RolePolicySizeQuota": 10240, + "AccountSigningCertificatesPresent": 0, + "Users": 27, + "ServerCertificatesQuota": 20, + "ServerCertificates": 0, + "AssumeRolePolicySizeQuota": 2048, + "Groups": 7, + "MFADevicesInUse": 1, + "Roles": 3, + "AccountMFAEnabled": 1, + "MFADevices": 3, + "GroupsPerUserQuota": 10, + "GroupPolicySizeQuota": 5120, + "InstanceProfilesQuota": 100, + "AccessKeysPerUserQuota": 2, + "Providers": 0, + "UserPolicySizeQuota": 2048 + } + } + +For more information about entity limitations, see `Limitations on IAM Entities`_ in the *Using IAM* guide. + +.. _`Limitations on IAM Entities`: http://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html diff --git a/aws/dist/awscli/examples/iam/get-context-keys-for-custom-policy.rst b/aws/dist/awscli/examples/iam/get-context-keys-for-custom-policy.rst new file mode 100755 index 00000000..1a08fafa --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-context-keys-for-custom-policy.rst @@ -0,0 +1,45 @@ +**Example 1: To list the context keys referenced by one or more custom JSON policies provided as a parameter on the command line** + +The following ``get-context-keys-for-custom-policy`` command parses each supplied policy and lists the context keys used by those policies. Use this command to identify which context key values you must supply to successfully use the policy simulator commands ``simulate-custom-policy`` and ``simulate-custom-policy``. You can also retrieve the list of context keys used by all policies associated by an IAM user or role by using the ``get-context-keys-for-custom-policy`` command. Parameter values that begin with ``file://`` instruct the command to read the file and use the contents as the value for the parameter instead of the file name itself.:: + + aws iam get-context-keys-for-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"arn:aws:dynamodb:us-west-2:123456789012:table/${aws:username}","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2015-08-16T12:00:00Z"}}}}' + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +**Example 2: To list the context keys referenced by one or more custom JSON policies provided as a file input** + +The following ``get-context-keys-for-custom-policy`` command is the same as the previous example, except that the policies are provided in a file instead of as a parameter. Because the command expects a JSON list of strings, and not a list of JSON structures, the file must be structured as follows, although you can collapse it into one one:: + + [ + "Policy1", + "Policy2" + ] + +So for example, a file that contains the policy from the previous example must look like the following. You must escape each embedded double-quote inside the policy string by preceding it with a backslash '\'. :: + + [ "{\"Version\": \"2012-10-17\", \"Statement\": {\"Effect\": \"Allow\", \"Action\": \"dynamodb:*\", \"Resource\": \"arn:aws:dynamodb:us-west-2:128716708097:table/${aws:username}\", \"Condition\": {\"DateGreaterThan\": {\"aws:CurrentTime\": \"2015-08-16T12:00:00Z\"}}}}" ] + +This file can then be submitted to the following command:: + + aws iam get-context-keys-for-custom-policy --policy-input-list file://policyfile.json + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +For more information, see `Using the IAM Policy Simulator (AWS CLI and AWS API)`_ in the *Using IAM* guide. + +.. _`Using the IAM Policy Simulator (AWS CLI and AWS API)`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api diff --git a/aws/dist/awscli/examples/iam/get-context-keys-for-principal-policy.rst b/aws/dist/awscli/examples/iam/get-context-keys-for-principal-policy.rst new file mode 100755 index 00000000..a3fd3d34 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-context-keys-for-principal-policy.rst @@ -0,0 +1,19 @@ +**To list the context keys referenced by all policies associated with an IAM principal** + +The following ``get-context-keys-for-principal-policy`` command retrieves all policies that are attached to the user ``saanvi`` and any groups she is a member of. It then parses each and lists the context keys used by those policies. Use this command to identify which context key values you must supply to successfully use the ``simulate-custom-policy`` and ``simulate-principal-policy`` commands. You can also retrieve the list of context keys used by an arbitrary JSON policy by using the ``get-context-keys-for-custom-policy`` command. :: + + aws iam get-context-keys-for-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/saanvi + +Output:: + + { + "ContextKeyNames": [ + "aws:username", + "aws:CurrentTime" + ] + } + +For more information, see `Using the IAM Policy Simulator (AWS CLI and AWS API)`_ in the *Using IAM* guide. + +.. _`Using the IAM Policy Simulator (AWS CLI and AWS API)`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html#policies-simulator-using-api \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-credential-report.rst b/aws/dist/awscli/examples/iam/get-credential-report.rst new file mode 100644 index 00000000..42725988 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-credential-report.rst @@ -0,0 +1,16 @@ +**To get a credential report** + +This example opens the returned report and outputs it to the pipeline as an array of text lines:: + + aws iam get-credential-report + +Output:: + + { + "GeneratedTime": "2015-06-17T19:11:50Z", + "ReportFormat": "text/csv" + } + +For more information, see `Getting Credential Reports for Your AWS Account`_ in the *Using IAM* guide. + +.. _`Getting Credential Reports for Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/credential-reports.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-group-policy.rst b/aws/dist/awscli/examples/iam/get-group-policy.rst new file mode 100644 index 00000000..1b8af7c4 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-group-policy.rst @@ -0,0 +1,29 @@ +**To get information about a policy attached to an IAM group** + +The following ``get-group-policy`` command gets information about the specified policy attached to the group named ``Test-Group``:: + + aws iam get-group-policy --group-name Test-Group --policy-name S3-ReadOnly-Policy + +Output:: + + { + "GroupName": "Test-Group", + "PolicyDocument": { + "Statement": [ + { + "Action": [ + "s3:Get*", + "s3:List*" + ], + "Resource": "*", + "Effect": "Allow" + } + ] + }, + "PolicyName": "S3-ReadOnly-Policy" + } + +For more information, see `Managing IAM Policies`_ in the *Using IAM* guide. + +.. _`Managing IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingPolicies.html + diff --git a/aws/dist/awscli/examples/iam/get-group.rst b/aws/dist/awscli/examples/iam/get-group.rst new file mode 100644 index 00000000..56050956 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-group.rst @@ -0,0 +1,22 @@ +**To get an IAM group** + +This example returns details about the IAM group ``Admins``:: + + aws iam get-group --group-name Admins + +Output:: + + { + "Group": { + "Path": "/", + "CreateDate": "2015-06-16T19:41:48Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "GroupName": "Admins" + }, + "Users": [] + } + +For more information, see `IAM Users and Groups`_ in the *Using IAM* guide. + +.. _`IAM Users and Groups`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_WorkingWithGroupsAndUsers.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-instance-profile.rst b/aws/dist/awscli/examples/iam/get-instance-profile.rst new file mode 100644 index 00000000..58b5662e --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-instance-profile.rst @@ -0,0 +1,31 @@ +**To get information about an instance profile** + +The following ``get-instance-profile`` command gets information about the instance profile named ``ExampleInstanceProfile``:: + + aws iam get-instance-profile --instance-profile-name ExampleInstanceProfile + +Output:: + + { + "InstanceProfile": { + "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": "", + "RoleId": "AIDGPMS9RO4H3FEXAMPLE", + "CreateDate": "2013-01-09T06:33:26Z", + "RoleName": "Test-Role", + "Path": "/", + "Arn": "arn:aws:iam::336924118301:role/Test-Role" + } + ], + "CreateDate": "2013-06-12T23:52:02Z", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile" + } + } + +For more information, see `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Instance Profiles`: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html diff --git a/aws/dist/awscli/examples/iam/get-login-profile.rst b/aws/dist/awscli/examples/iam/get-login-profile.rst new file mode 100644 index 00000000..690496f0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-login-profile.rst @@ -0,0 +1,25 @@ +**To get password information for an IAM user** + +The following ``get-login-profile`` command gets information about the password for the IAM user named ``Bob``:: + + aws iam get-login-profile --user-name Bob + +Output:: + + { + "LoginProfile": { + "UserName": "Bob", + "CreateDate": "2012-09-21T23:03:39Z" + } + } + +The ``get-login-profile`` command can be used to verify that an IAM user has a password. The command returns a ``NoSuchEntity`` +error if no password is defined for the user. + +You cannot view a password using this command. If the password is lost, you can reset the password (``update-login-profile``) for the user. Alternatively, you can delete the login profile (``delete-login-profile``) for the user and then create a new one (``create-login-profile``). + +For more information, see `Managing Passwords`_ in the *Using IAM* guide. + +.. _`Managing Passwords`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html + + diff --git a/aws/dist/awscli/examples/iam/get-open-id-connect-provider.rst b/aws/dist/awscli/examples/iam/get-open-id-connect-provider.rst new file mode 100644 index 00000000..1ef90189 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-open-id-connect-provider.rst @@ -0,0 +1,22 @@ +**To return information about the specified OpenID Connect provider** + +This example returns details about the OpenID Connect provider whose ARN is ``arn:aws:iam::123456789012:oidc-provider/server.example.com``:: + + aws iam get-open-id-connect-provider --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/server.example.com + +Output:: + + { + "Url": "server.example.com" + "CreateDate": "2015-06-16T19:41:48Z", + "ThumbprintList": [ + "12345abcdefghijk67890lmnopqrst987example" + ], + "ClientIDList": [ + "example-application-ID" + ] + } + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-organizations-access-report.rst b/aws/dist/awscli/examples/iam/get-organizations-access-report.rst new file mode 100755 index 00000000..74bb1a28 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-organizations-access-report.rst @@ -0,0 +1,23 @@ +**To retrieve an access report** + +The following ``get-organizations-access-report`` example displays a previously generated access report for an AWS Organizations entity. To generate a report, use the ``generate-organizations-access-report`` command. :: + + aws iam get-organizations-access-report \ + --job-id a8b6c06f-aaa4-8xmp-28bc-81da71836359 + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-09-30T06:53:36.187Z", + "JobCompletionDate": "2019-09-30T06:53:37.547Z", + "NumberOfServicesAccessible": 188, + "NumberOfServicesNotAccessed": 171, + "AccessDetails": [ + { + "ServiceName": "Alexa for Business", + "ServiceNamespace": "a4b", + "TotalAuthenticatedEntities": 0 + }, + ... + } diff --git a/aws/dist/awscli/examples/iam/get-policy-version.rst b/aws/dist/awscli/examples/iam/get-policy-version.rst new file mode 100644 index 00000000..680b2a81 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-policy-version.rst @@ -0,0 +1,30 @@ +**To retrieve information about the specified version of the specified managed policy** + +This example returns the policy document for the v2 version of the policy whose ARN is ``arn:aws:iam::123456789012:policy/MyManagedPolicy``:: + + aws iam get-policy-version --policy-arn arn:aws:iam::123456789012:policy/MyPolicy --version-id v2 + + +Output:: + + { + "PolicyVersion": { + "CreateDate": "2015-06-17T19:23;32Z", + "VersionId": "v2", + "Document": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "iam:*", + "Resource": "*", + "Effect": "Allow" + } + ] + } + "IsDefaultVersion": "false" + } + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-policy.rst b/aws/dist/awscli/examples/iam/get-policy.rst new file mode 100644 index 00000000..6166b6f9 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-policy.rst @@ -0,0 +1,25 @@ +**To retrieve information about the specified managed policy** + +This example returns details about the managed policy whose ARN is ``arn:aws:iam::123456789012:policy/MySamplePolicy``:: + + aws iam get-policy --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy + +Output:: + + { + "Policy": { + "PolicyName": "MySamplePolicy", + "CreateDate": "2015-06-17T19:23;32Z", + "AttachmentCount": "0", + "IsAttachable": "true", + "PolicyId": "Z27SI6FQMGNQ2EXAMPLE1", + "DefaultVersionId": "v1", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/MySamplePolicy", + "UpdateDate": "2015-06-17T19:23:32Z" + } + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-role-policy.rst b/aws/dist/awscli/examples/iam/get-role-policy.rst new file mode 100644 index 00000000..a4e6877b --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-role-policy.rst @@ -0,0 +1,32 @@ +**To get information about a policy attached to an IAM role** + +The following ``get-role-policy`` command gets information about the specified policy attached to the role named ``Test-Role``:: + + aws iam get-role-policy --role-name Test-Role --policy-name ExamplePolicy + +Output:: + + { + "RoleName": "Test-Role", + "PolicyDocument": { + "Statement": [ + { + "Action": [ + "s3:ListBucket", + "s3:Put*", + "s3:Get*", + "s3:*MultipartUpload*" + ], + "Resource": "*", + "Effect": "Allow", + "Sid": "1" + } + ] + } + "PolicyName": "ExamplePolicy" + } + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/get-role.rst b/aws/dist/awscli/examples/iam/get-role.rst new file mode 100644 index 00000000..29117e5d --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-role.rst @@ -0,0 +1,25 @@ +**To get information about an IAM role** + +The following ``get-role`` command gets information about the role named ``Test-Role``:: + + aws iam get-role --role-name Test-Role + +Output:: + + { + "Role": { + "AssumeRolePolicyDocument": "", + "RoleId": "AIDIODR4TAW7CSEXAMPLE", + "CreateDate": "2013-04-18T05:01:58Z", + "RoleName": "Test-Role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/Test-Role" + } + } + +The command displays the trust policy attached to the role. To list the permissions policies attached to a role, use the ``list-role-policies`` command. + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/get-saml-provider.rst b/aws/dist/awscli/examples/iam/get-saml-provider.rst new file mode 100644 index 00000000..479ae155 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-saml-provider.rst @@ -0,0 +1,12 @@ +**To retrieve the SAML provider metadocument** + +This example retrieves the details about the SAML 2.0 provider whose ARM is ``arn:aws:iam::123456789012:saml-provider/SAMLADFS``. +The response includes the metadata document that you got from the identity provider to create the AWS SAML provider entity as well +as the creation and expiration dates:: + + aws iam get-saml-provider --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS + + +For more information, see `Using SAML Providers`_ in the *Using IAM* guide. + +.. _`Using SAML Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-saml.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/get-server-certificate.rst b/aws/dist/awscli/examples/iam/get-server-certificate.rst new file mode 100644 index 00000000..5415617f --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-server-certificate.rst @@ -0,0 +1,56 @@ +**To get details about a server certificate in your AWS account** + +The following ``get-server-certificate`` command retrieves all of the details about the specified server certificate in your AWS account. :: + + aws iam get-server-certificate --server-certificate-name myUpdatedServerCertificate + +Output:: + + { + "ServerCertificate": { + "ServerCertificateMetadata": { + "Path": "/", + "ServerCertificateName": "myUpdatedServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + }, + "CertificateBody": "-----BEGIN CERTIFICATE----- + MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvrszlaEXAMPLE=-----END CERTIFICATE-----", + "CertificateChain": "-----BEGIN CERTIFICATE-----\nMIICiTCCAfICCQD6md + 7oRw0uXOjANBgkqhkiG9w0BAqQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgT + AldBMRAwDgYDVQQHEwdTZWF0drGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAs + TC0lBTSBDb25zb2xlMRIwEAYDVsQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQ + jb20wHhcNMTEwNDI1MjA0NTIxWhtcNMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBh + MCVVMxCzAJBgNVBAgTAldBMRAwDgsYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBb + WF6b24xFDASBgNVBAsTC0lBTSBDb2d5zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMx + HzAdBgkqhkiG9w0BCQEWEG5vb25lQGfFtYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQE + BBQADgY0AMIGJAoGBAMaK0dn+a4GmWIgWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVI + k60CpiwsZ3G93vUEIO3IyNoH/f0wYK8mh9TrDHudUZg3qX4waLG5M43q7Wgc/MbQ + ITxOUSQv7c7ugFFDzQGBzZswY6786m86gjpEIbb3OhjZnzcvQAaRHhdlQWIMm2nr + AgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCku4nUhVVxYUntneD9+h8Mg9q6q+auN + KyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FlkbFFBjvSfpJIlJ00zbhNYS5f6Guo + EDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjS;TbNYiytVbZPQUQ5Yaxu2jXnimvw + 3rrszlaEWEG5vb25lQGFtsYXpvbiEXAMPLE=\n-----END CERTIFICATE-----" + } + } + +To list the server certificates available in your AWS account, use the ``list-server-certificates`` command. + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html diff --git a/aws/dist/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst b/aws/dist/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst new file mode 100755 index 00000000..1c76c74d --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-service-last-accessed-details-with-entities.rst @@ -0,0 +1,37 @@ +**To retrieve a service access report with details for a service** + +The following ``get-service-last-accessed-details-with-entities`` example retrieves a report that contains details about IAM users and other entities that accessed the specified service. To generate a report, use the ``generate-service-last-accessed-details`` command. To get a list of services accessed with namespaces, use ``get-service-last-accessed-details``. :: + + aws iam get-service-last-accessed-details-with-entities \ + --job-id 78b6c2ba-d09e-6xmp-7039-ecde30b26916 \ + --service-namespace lambda + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-10-01T03:55:41.756Z", + "JobCompletionDate": "2019-10-01T03:55:42.533Z", + "EntityDetailsList": [ + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:user/admin", + "Name": "admin", + "Type": "USER", + "Id": "AIDAIO2XMPLENQEXAMPLE", + "Path": "/" + }, + "LastAuthenticated": "2019-09-30T23:02:00Z" + }, + { + "EntityInfo": { + "Arn": "arn:aws:iam::123456789012:user/developer", + "Name": "developer", + "Type": "USER", + "Id": "AIDAIBEYXMPL2YEXAMPLE", + "Path": "/" + }, + "LastAuthenticated": "2019-09-16T19:34:00Z" + } + ] + } diff --git a/aws/dist/awscli/examples/iam/get-service-last-accessed-details.rst b/aws/dist/awscli/examples/iam/get-service-last-accessed-details.rst new file mode 100755 index 00000000..b1075840 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-service-last-accessed-details.rst @@ -0,0 +1,23 @@ +**To retrieve a service access report** + +The following ``get-service-last-accessed-details`` example retrieves a previously generated report that lists the services accessed by IAM entities. To generate a report, use the ``generate-service-last-accessed-details`` command. :: + + aws iam get-service-last-accessed-details \ + --job-id 2eb6c2b8-7b4c-3xmp-3c13-03b72c8cdfdc + +Output:: + + { + "JobStatus": "COMPLETED", + "JobCreationDate": "2019-10-01T03:50:35.929Z", + "ServicesLastAccessed": [ + ... + { + "ServiceName": "AWS Lambda", + "LastAuthenticated": "2019-09-30T23:02:00Z", + "ServiceNamespace": "lambda", + "LastAuthenticatedEntity": "arn:aws:iam::123456789012:user/admin", + "TotalAuthenticatedEntities": 6 + }, + ] + } diff --git a/aws/dist/awscli/examples/iam/get-service-linked-role-deletion-status.rst b/aws/dist/awscli/examples/iam/get-service-linked-role-deletion-status.rst new file mode 100644 index 00000000..b88a4549 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-service-linked-role-deletion-status.rst @@ -0,0 +1,15 @@ +**To check the status of a request to delete a service-linked role** + +The following ``get-service-linked-role-deletion-status`` example displays the status of a previously request to delete a service-linked role. The delete operation occurs asynchronously. When you make the request, you get a ``DeletionTaskId`` value that you provide as a parameter for this command. :: + + aws iam get-service-linked-role-deletion-status --deletion-task-id task/aws-service-role/lex.amazonaws.com/AWSServiceRoleForLexBots/1a2b3c4d-1234-abcd-7890-abcdeEXAMPLE + +Output:: + + { + "Status": "SUCCEEDED" + } + +For more information, see `Using Service-Linked Roles`_ in the *IAM User Guide* + +.. _`Using Service-Linked Roles`: https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html diff --git a/aws/dist/awscli/examples/iam/get-ssh-public-key.rst b/aws/dist/awscli/examples/iam/get-ssh-public-key.rst new file mode 100644 index 00000000..2b8edb6b --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-ssh-public-key.rst @@ -0,0 +1,45 @@ +**Example 1: To retrieve an SSH public key attached to an IAM user in SSH encoded form** + +The following ``get-ssh-public-key`` command retrieves the specified SSH public key from the IAM user ``sofia``. The output is in SSH encoding. :: + + aws iam get-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA123456789EXAMPLE \ + --encoding SSH + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA123456789EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": "ssh-rsa <>", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +**Example 2: To retrieve an SSH public key attached to an IAM user in PEM encoded form** + +The following ``get-ssh-public-key`` command retrieves the specified SSH public key from the IAM user 'sofia'. The output is in PEM encoding. :: + + aws iam get-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA123456789EXAMPLE \ + --encoding PEM + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA123456789EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": ""-----BEGIN PUBLIC KEY-----\n<>\n-----END PUBLIC KEY-----\n"", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide*. diff --git a/aws/dist/awscli/examples/iam/get-user-policy.rst b/aws/dist/awscli/examples/iam/get-user-policy.rst new file mode 100644 index 00000000..2cc7924c --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-user-policy.rst @@ -0,0 +1,33 @@ +**To list policy details for an IAM user** + +The following ``get-user-policy`` command lists the details of the specified policy that is attached to the IAM user named ``Bob``:: + + aws iam get-user-policy --user-name Bob --policy-name ExamplePolicy + +Output:: + + { + "UserName": "Bob", + "PolicyName": "ExamplePolicy", + "PolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "*", + "Resource": "*", + "Effect": "Allow" + } + ] + } + } + +To get a list of policies for an IAM user, use the ``list-user-policies`` command. + +For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. + +.. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html + + + + + diff --git a/aws/dist/awscli/examples/iam/get-user.rst b/aws/dist/awscli/examples/iam/get-user.rst new file mode 100644 index 00000000..d8636826 --- /dev/null +++ b/aws/dist/awscli/examples/iam/get-user.rst @@ -0,0 +1,23 @@ +**To get information about an IAM user** + +The following ``get-user`` command gets information about the IAM user named ``Bob``:: + + aws iam get-user --user-name Bob + +Output:: + + { + "User": { + "UserName": "Bob", + "Path": "/", + "CreateDate": "2012-09-21T23:03:13Z", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Bob" + } + } + +For more information, see `Listing Users`_ in the *Using IAM* guide. + +.. _`Listing Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_GetListOfUsers.html + + diff --git a/aws/dist/awscli/examples/iam/list-access-keys.rst b/aws/dist/awscli/examples/iam/list-access-keys.rst new file mode 100644 index 00000000..acfdee46 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-access-keys.rst @@ -0,0 +1,30 @@ +**To list the access key IDs for an IAM user** + +The following ``list-access-keys`` command lists the access keys IDs for the IAM user named ``Bob``:: + + aws iam list-access-keys --user-name Bob + +Output:: + + "AccessKeyMetadata": [ + { + "UserName": "Bob", + "Status": "Active", + "CreateDate": "2013-06-04T18:17:34Z", + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE" + }, + { + "UserName": "Bob", + "Status": "Inactive", + "CreateDate": "2013-06-06T20:42:26Z", + "AccessKeyId": "AKIAI44QH8DHBEXAMPLE" + } + ] + +You cannot list the secret access keys for IAM users. If the secret access keys are lost, you must create new access keys using the ``create-access-keys`` command. + +For more information, see `Creating, Modifying, and Viewing User Security Credentials`_ in the *Using IAM* guide. + +.. _`Creating, Modifying, and Viewing User Security Credentials`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreateAccessKey.html + + diff --git a/aws/dist/awscli/examples/iam/list-account-aliases.rst b/aws/dist/awscli/examples/iam/list-account-aliases.rst new file mode 100644 index 00000000..75f685cf --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-account-aliases.rst @@ -0,0 +1,16 @@ +**To list account aliases** + +The following ``list-account-aliases`` command lists the aliases for the current account:: + + aws iam list-account-aliases + +Output:: + + "AccountAliases": [ + "mycompany" + ] + +For more information, see `Using an Alias for Your AWS Account ID`_ in the *Using IAM* guide. + +.. _`Using an Alias for Your AWS Account ID`: http://docs.aws.amazon.com/IAM/latest/UserGuide/AccountAlias.html + diff --git a/aws/dist/awscli/examples/iam/list-attached-group-policies.rst b/aws/dist/awscli/examples/iam/list-attached-group-policies.rst new file mode 100644 index 00000000..f4ba8066 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-attached-group-policies.rst @@ -0,0 +1,25 @@ +**To list all managed policies that are attached to the specified group** + +This example returns the names and ARNs of the managed policies that are attached to the IAM group named ``Admins`` in the AWS account:: + + aws iam list-attached-group-policies --group-name Admins + +Output:: + + { + "AttachedPolicies": [ + { + "PolicyName": "AdministratorAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" + }, + { + "PolicyName": "SecurityAudit", + "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" + } + ], + "IsTruncated": false + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-attached-role-policies.rst b/aws/dist/awscli/examples/iam/list-attached-role-policies.rst new file mode 100644 index 00000000..a0bc8c75 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-attached-role-policies.rst @@ -0,0 +1,21 @@ +**To list all managed policies that are attached to the specified role** + +This command returns the names and ARNs of the managed policies attached to the IAM role named ``SecurityAuditRole`` in the AWS account:: + + aws iam list-attached-role-policies --role-name SecurityAuditRole + +Output:: + + { + "AttachedPolicies": [ + { + "PolicyName": "SecurityAudit", + "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" + } + ], + "IsTruncated": false + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-attached-user-policies.rst b/aws/dist/awscli/examples/iam/list-attached-user-policies.rst new file mode 100644 index 00000000..c93f5aa5 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-attached-user-policies.rst @@ -0,0 +1,25 @@ +**To list all managed policies that are attached to the specified user** + +This command returns the names and ARNs of the managed policies for the IAM user named ``Bob`` in the AWS account:: + + aws iam list-attached-user-policies --user-name Bob + +Output:: + + { + "AttachedPolicies": [ + { + "PolicyName": "AdministratorAccess", + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess" + }, + { + "PolicyName": "SecurityAudit", + "PolicyArn": "arn:aws:iam::aws:policy/SecurityAudit" + } + ], + "IsTruncated": false + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-entities-for-policy.rst b/aws/dist/awscli/examples/iam/list-entities-for-policy.rst new file mode 100644 index 00000000..73330f83 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-entities-for-policy.rst @@ -0,0 +1,30 @@ +**To list all users, groups, and roles that the specified managed policy is attached to** + +This example returns a list of IAM groups, roles, and users who have the policy ``arn:aws:iam::123456789012:policy/TestPolicy`` attached:: + + aws iam list-entities-for-policy --policy-arn arn:aws:iam::123456789012:policy/TestPolicy + +Output:: + + { + "PolicyGroups": [ + { + "GroupName": "Admins" + } + ], + "PolicyUsers": [ + { + "UserName": "Bob" + } + ], + "PolicyRoles": [ + { + "RoleName": "testRole" + } + ], + "IsTruncated": false + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-group-policies.rst b/aws/dist/awscli/examples/iam/list-group-policies.rst new file mode 100644 index 00000000..2bb9b32f --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-group-policies.rst @@ -0,0 +1,20 @@ +**To list all inline policies that are attached to the specified group** + +The following ``list-group-policies`` command lists the names of inline policies that are attached to the IAM group named +``Admins`` in the current account:: + + aws iam list-group-policies --group-name Admins + +Output:: + + { + "PolicyNames": [ + "AdminRoot", + "ExamplePolicy" + ] + } + +For more information, see `Managing IAM Policies`_ in the *Using IAM* guide. + +.. _`Managing IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingPolicies.html + diff --git a/aws/dist/awscli/examples/iam/list-groups-for-user.rst b/aws/dist/awscli/examples/iam/list-groups-for-user.rst new file mode 100644 index 00000000..d7770aac --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-groups-for-user.rst @@ -0,0 +1,30 @@ +**To list the groups that an IAM user belongs to** + +The following ``list-groups-for-user`` command displays the groups that the IAM user named ``Bob`` belongs to:: + + aws iam list-groups-for-user --user-name Bob + +Output:: + + "Groups": [ + { + "Path": "/", + "CreateDate": "2013-05-06T01:18:08Z", + "GroupId": "AKIAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admin", + "GroupName": "Admin" + }, + { + "Path": "/", + "CreateDate": "2013-05-06T01:37:28Z", + "GroupId": "AKIAI44QH8DHBEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/s3-Users", + "GroupName": "s3-Users" + } + ] + +For more information, see `Creating and Listing Groups`_ in the *Using IAM* guide. + +.. _`Creating and Listing Groups`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreatingAndListingGroups.html + + diff --git a/aws/dist/awscli/examples/iam/list-groups.rst b/aws/dist/awscli/examples/iam/list-groups.rst new file mode 100644 index 00000000..9b86e94a --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-groups.rst @@ -0,0 +1,29 @@ +**To list the IAM groups for the current account** + +The following ``list-groups`` command lists the IAM groups in the current account:: + + aws iam list-groups + +Output:: + + "Groups": [ + { + "Path": "/", + "CreateDate": "2013-06-04T20:27:27.972Z", + "GroupId": "AIDACKCEVSQ6C2EXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/Admins", + "GroupName": "Admins" + }, + { + "Path": "/", + "CreateDate": "2013-04-16T20:30:42Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "Arn": "arn:aws:iam::123456789012:group/S3-Admins", + "GroupName": "S3-Admins" + } + ] + +For more information, see `Creating and Listing Groups`_ in the *Using IAM* guide. + +.. _`Creating and Listing Groups`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreatingAndListingGroups.html + diff --git a/aws/dist/awscli/examples/iam/list-instance-profiles-for-role.rst b/aws/dist/awscli/examples/iam/list-instance-profiles-for-role.rst new file mode 100644 index 00000000..e6a4765d --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-instance-profiles-for-role.rst @@ -0,0 +1,32 @@ +**To list the instance profiles for an IAM role** + +The following ``list-instance-profiles-for-role`` command lists the instance profiles that are associated with the role ``Test-Role``:: + + aws iam list-instance-profiles-for-role --role-name Test-Role + +Output:: + + "InstanceProfiles": [ + { + "InstanceProfileId": "AIDGPMS9RO4H3FEXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": "", + "RoleId": "AIDACKCEVSQ6C2EXAMPLE", + "CreateDate": "2013-06-07T20:42:15Z", + "RoleName": "Test-Role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/Test-Role" + } + ], + "CreateDate": "2013-06-07T21:05:24Z", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/ExampleInstanceProfile" + } + ] + +For more information, see `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Instance Profiles`: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html + diff --git a/aws/dist/awscli/examples/iam/list-instance-profiles.rst b/aws/dist/awscli/examples/iam/list-instance-profiles.rst new file mode 100644 index 00000000..3ac2f5b3 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-instance-profiles.rst @@ -0,0 +1,74 @@ +**To lists the instance profiles for the account** + +The following ``list-instance-profiles`` command lists the instance profiles that are associated with the current account:: + + aws iam list-instance-profiles + +Output:: + + { + "InstanceProfiles": [ + { + "InstanceProfileId": "AIPAIXEU4NUHUPEXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Effect": "Allow", + "Sid": "" + } + ] + }, + "RoleId": "AROAJ52OTH4H7LEXAMPLE", + "CreateDate": "2013-05-11T00:02:27Z", + "RoleName": "example-role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/example-role" + } + ], + "CreateDate": "2013-05-11T00:02:27Z", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/ExampleInstanceProfile" + }, + { + "InstanceProfileId": "AIPAJVJVNRIQFREXAMPLE", + "Roles": [ + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Effect": "Allow", + "Sid": "" + } + ] + }, + "RoleId": "AROAINUBC5O7XLEXAMPLE", + "CreateDate": "2013-01-09T06:33:26Z", + "RoleName": "s3-test-role", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/s3-test-role" + } + ], + "CreateDate": "2013-06-12T23:52:02Z", + "InstanceProfileName": "ExampleInstanceProfile2", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:instance-profile/ExampleInstanceProfile2" + }, + ] + } + +For more information, see `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Instance Profiles`: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html diff --git a/aws/dist/awscli/examples/iam/list-mfa-devices.rst b/aws/dist/awscli/examples/iam/list-mfa-devices.rst new file mode 100644 index 00000000..1c2c809f --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-mfa-devices.rst @@ -0,0 +1,21 @@ +**To list all MFA devices for a specified user** + +This example returns details about the MFA device assigned to the IAM user ``Bob``:: + + aws iam list-mfa-devices --user-name Bob + +Output:: + + { + "MFADevices": [ + { + "UserName": "Bob", + "SerialNumber": "arn:aws:iam::123456789012:mfa/BobsMFADevice", + "EnableDate": "2015-06-16T22:36:37Z" + } + ] + } + +For more information, see `Using Multi-Factor Authentication (MFA) Devices with AWS`_ in the *Using IAM* guide. + +.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingMFA.html diff --git a/aws/dist/awscli/examples/iam/list-open-id-connect-providers.rst b/aws/dist/awscli/examples/iam/list-open-id-connect-providers.rst new file mode 100644 index 00000000..30ce0ecc --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-open-id-connect-providers.rst @@ -0,0 +1,19 @@ +**To list information about the OpenID Connect providers in the AWS account** + +This example returns a list of ARNS of all the OpenID Connect providers that are defined in the current AWS account:: + + aws iam list-open-id-connect-providers + +Output:: + + { + "OpenIDConnectProviderList": [ + { + "Arn": "arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com" + } + ] + } + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-policies-granting-service-access.rst b/aws/dist/awscli/examples/iam/list-policies-granting-service-access.rst new file mode 100644 index 00000000..aca9f784 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-policies-granting-service-access.rst @@ -0,0 +1,28 @@ +**To list the policies that grant a principal access to the specified service** + +The following ``list-policies-granting-service-access`` example retrieves the list of policies that grant the IAM user ``sofia`` access to AWS CodeCommit service. :: + + aws iam list-policies-granting-service-access \ + --arn arn:aws:iam::123456789012:user/sofia \ + --service-namespaces codecommit + +Output:: + + { + "PoliciesGrantingServiceAccess": [ + { + "ServiceNamespace": "codecommit", + "Policies": [ + { + "PolicyName": "Grant-Sofia-Access-To-CodeCommit", + "PolicyType": "INLINE", + "EntityType": "USER", + "EntityName": "sofia" + } + ] + } + ], + "IsTruncated": false + } + +For more information, see `Using IAM with CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys `_ in the *AWS IAM User Guide*. diff --git a/aws/dist/awscli/examples/iam/list-policies.rst b/aws/dist/awscli/examples/iam/list-policies.rst new file mode 100644 index 00000000..4c25fdbf --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-policies.rst @@ -0,0 +1,40 @@ +**To list managed policies that are available to your AWS account** + +This example returns a collection of the first two managed policies available in the current AWS account:: + + aws iam list-policies --max-items 2 + +Output:: + + { + "Marker": "AAIWFnoA2MQ9zN9nnTorukxr1uesDIDa4u+q1mEfaurCDZ1AuCYagYfayKYGvu75BEGk8PooPsw5uvumkuizFACZ8f4rKtN1RuBWiVDBWet2OA==", + "IsTruncated": true, + "Policies": [ + { + "PolicyName": "AdministratorAccess", + "CreateDate": "2015-02-06T18:39:46Z", + "AttachmentCount": 5, + "IsAttachable": true, + "PolicyId": "ANPAIWMBCKSKIEE64ZLYK", + "DefaultVersionId": "v1", + "Path": "/", + "Arn": "arn:aws:iam::aws:policy/AdministratorAccess", + "UpdateDate": "2015-02-06T18:39:46Z" + }, + { + "PolicyName": "ASamplePolicy", + "CreateDate": "2015-06-17T19:23;32Z", + "AttachmentCount": "0", + "IsAttachable": "true", + "PolicyId": "Z27SI6FQMGNQ2EXAMPLE1", + "DefaultVersionId": "v1", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:policy/ASamplePolicy", + "UpdateDate": "2015-06-17T19:23:32Z" + } + ] + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-policy-versions.rst b/aws/dist/awscli/examples/iam/list-policy-versions.rst new file mode 100644 index 00000000..55d102d2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-policy-versions.rst @@ -0,0 +1,27 @@ +**To list information about the versions of the specified managed policy** + +This example returns the list of available versions of the policy whose ARN is ``arn:aws:iam::123456789012:policy/MySamplePolicy``:: + + aws iam list-policy-versions --policy-arn arn:aws:iam::123456789012:policy/MySamplePolicy + +Output:: + + { + "IsTruncated": false, + "Versions": [ + { + "CreateDate": "2015-06-02T23:19:44Z", + "VersionId": "v2", + "IsDefaultVersion": true + }, + { + "CreateDate": "2015-06-02T22:30:47Z", + "VersionId": "v1", + "IsDefaultVersion": false + } + ] + } + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-role-policies.rst b/aws/dist/awscli/examples/iam/list-role-policies.rst new file mode 100644 index 00000000..8d0f76a2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-role-policies.rst @@ -0,0 +1,18 @@ +**To list the policies attached to an IAM role** + +The following ``list-role-policies`` command lists the names of the permissions policies for the specified IAM role:: + + aws iam list-role-policies --role-name Test-Role + +Output:: + + "PolicyNames": [ + "ExamplePolicy" + ] + +To see the trust policy attached to a role, use the ``get-role`` command. To see the details of a permissions policy, use the ``get-role-policy`` command. + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/list-role-tags.rst b/aws/dist/awscli/examples/iam/list-role-tags.rst new file mode 100644 index 00000000..0e5cd36d --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-role-tags.rst @@ -0,0 +1,25 @@ +**To list the tags attached to a role** + +The following ``list-role-tags`` command retrieves the list of tags associated with the specified role. :: + + aws iam list-role-tags --role-name production-role + + Output:: + { + "Tags": [ + { + "Key": "Department", + "Value": "Accounting" + }, + { + "Key": "DeptID", + "Value": "12345" + } + ], + "IsTruncated": false + } + + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/list-roles.rst b/aws/dist/awscli/examples/iam/list-roles.rst new file mode 100644 index 00000000..4ed88f33 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-roles.rst @@ -0,0 +1,57 @@ +**To list IAM roles for the current account** + +The following ``list-roles`` command lists IAM roles for the current account:: + + aws iam list-roles + +Output:: + + { + "Roles": [ + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Principal": { + "Service": "ec2.amazonaws.com" + }, + "Effect": "Allow", + "Sid": "" + } + ] + }, + "RoleId": "AROAJ52OTH4H7LEXAMPLE", + "CreateDate": "2013-05-11T00:02:27Z", + "RoleName": "ExampleRole1", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/ExampleRole1" + }, + { + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": "sts:AssumeRole", + "Principal": { + "Service": "elastictranscoder.amazonaws.com" + }, + "Effect": "Allow", + "Sid": "" + } + ] + }, + "RoleId": "AROAI4QRP7UFT7EXAMPLE", + "CreateDate": "2013-04-18T05:01:58Z", + "RoleName": "emr-access", + "Path": "/", + "Arn": "arn:aws:iam::123456789012:role/emr-access" + } + ] + } + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/list-saml-providers.rst b/aws/dist/awscli/examples/iam/list-saml-providers.rst new file mode 100644 index 00000000..0dfb11b8 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-saml-providers.rst @@ -0,0 +1,21 @@ +**To list the SAML providers in the AWS account** + +This example retrieves the list of SAML 2.0 providers created in the current AWS account:: + + aws iam list-saml-providers + +Output:: + + { + "SAMLProviderList": [ + { + "CreateDate": "2015-06-05T22:45:14Z", + "ValidUntil": "2015-06-05T22:45:14Z", + "Arn": "arn:aws:iam::123456789012:saml-provider/SAMLADFS" + } + ] + } + +For more information, see `Using SAML Providers`_ in the *Using IAM* guide. + +.. _`Using SAML Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-saml.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/list-server-certificates.rst b/aws/dist/awscli/examples/iam/list-server-certificates.rst new file mode 100644 index 00000000..a032642f --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-server-certificates.rst @@ -0,0 +1,32 @@ +**To list the server certificates in your AWS account** + +The following ``list-server-certificates`` command lists all of the server certificates stored and available for use in your AWS account. :: + + aws iam list-server-certificates + +Output:: + + { + "ServerCertificateMetadataList": [ + { + "Path": "/", + "ServerCertificateName": "myUpdatedServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/myUpdatedServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + }, + { + "Path": "/cloudfront/", + "ServerCertificateName": "MyTestCert", + "ServerCertificateId": "ASCAEXAMPLE456EXAMPLE", + "Arn": "arn:aws:iam::123456789012:server-certificate/Org1/Org2/MyTestCert", + "UploadDate": "2015-04-21T18:14:16+00:00", + "Expiration": "2018-01-14T17:52:36+00:00" + } + ] + } + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/InstallCert.html diff --git a/aws/dist/awscli/examples/iam/list-service-specific-credential.rst b/aws/dist/awscli/examples/iam/list-service-specific-credential.rst new file mode 100644 index 00000000..514efb0b --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-service-specific-credential.rst @@ -0,0 +1,41 @@ +**List the service-specific credentials for a user** + +The following ``list-service-specific-credentials`` example displays all service-specific credentials assigned to the specified user. Passwords are not included in the response. :: + + aws iam list-service-specific-credentials --user-name sofia + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +**List the service-specific credentials for a user filtered to a specified service** + +The following ``list-service-specific-credentials`` example displays the service-specific credentials assigned to the user making the request. The list is filtered to include only those credentials for the specified service. Passwords are not included in the response. :: + + aws iam list-service-specific-credentials --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff --git a/aws/dist/awscli/examples/iam/list-service-specific-credentials.rst b/aws/dist/awscli/examples/iam/list-service-specific-credentials.rst new file mode 100755 index 00000000..97961b1e --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-service-specific-credentials.rst @@ -0,0 +1,30 @@ +**To retrieve a list of credentials** + +The following ``list-service-specific-credentials`` example lists the credentials generated for HTTPS access to AWS CodeCommit repositories for a user named ``developer``. :: + + aws iam list-service-specific-credentials \ + --user-name developer \ + --service-name codecommit.amazonaws.com + +Output:: + + { + "ServiceSpecificCredentials": [ + { + "UserName": "developer", + "Status": "Inactive", + "ServiceUserName": "developer-at-123456789012", + "CreateDate": "2019-10-01T04:31:41Z", + "ServiceSpecificCredentialId": "ACCAQFODXMPL4YFHP7DZE", + "ServiceName": "codecommit.amazonaws.com" + }, + { + "UserName": "developer", + "Status": "Active", + "ServiceUserName": "developer+1-at-123456789012", + "CreateDate": "2019-10-01T04:31:45Z", + "ServiceSpecificCredentialId": "ACCAQFOXMPL6VW57M7AJP", + "ServiceName": "codecommit.amazonaws.com" + } + ] + } diff --git a/aws/dist/awscli/examples/iam/list-signing-certificates.rst b/aws/dist/awscli/examples/iam/list-signing-certificates.rst new file mode 100644 index 00000000..cbe93396 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-signing-certificates.rst @@ -0,0 +1,22 @@ +**To list the signing certificates for an IAM user** + +The following ``list-signing-certificates`` command lists the signing certificates for the IAM user named ``Bob``:: + + aws iam list-signing-certificates --user-name Bob + +Output:: + + { + "Certificates": [ + { + "UserName": "Bob", + "Status": "Inactive", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UploadDate": "2013-06-06T21:40:08Z" + } + ] + } + +For more information, see `Creating and Uploading a User Signing Certificate `__ in the *Using IAM* guide. + diff --git a/aws/dist/awscli/examples/iam/list-ssh-public-keys.rst b/aws/dist/awscli/examples/iam/list-ssh-public-keys.rst new file mode 100644 index 00000000..c6e63d03 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-ssh-public-keys.rst @@ -0,0 +1,20 @@ +**To list the SSH public keys attached to an IAM user** + +The following ``list-ssh-public-keys`` example lists the SSH public keys attached to the IAM user ``sofia``. :: + + aws iam list-ssh-public-keys --user-name sofia + +Output:: + + { + "SSHPublicKeys": [ + { + "UserName": "sofia", + "SSHPublicKeyId": "APKA1234567890EXAMPLE", + "Status": "Inactive", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + ] + } + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide* diff --git a/aws/dist/awscli/examples/iam/list-user-policies.rst b/aws/dist/awscli/examples/iam/list-user-policies.rst new file mode 100644 index 00000000..99900d0a --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-user-policies.rst @@ -0,0 +1,21 @@ +**To list policies for an IAM user** + +The following ``list-user-policies`` command lists the policies that are attached to the IAM user named ``Bob``:: + + aws iam list-user-policies --user-name Bob + +Output:: + + "PolicyNames": [ + "ExamplePolicy", + "TestPolicy" + ] + +For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. + +.. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html + + + + + diff --git a/aws/dist/awscli/examples/iam/list-user-tags.rst b/aws/dist/awscli/examples/iam/list-user-tags.rst new file mode 100644 index 00000000..c1e64660 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-user-tags.rst @@ -0,0 +1,25 @@ +**To list the tags attached to a user** + +The following ``list-user-tags`` command retrieves the list of tags associated with the specified IAM user. :: + + aws iam list-user-tags --user-name alice + + Output:: + { + "Tags": [ + { + "Key": "Department", + "Value": "Accounting" + }, + { + "Key": "DeptID", + "Value": "12345" + } + ], + "IsTruncated": false + } + + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/list-users.rst b/aws/dist/awscli/examples/iam/list-users.rst new file mode 100644 index 00000000..c2ca74f9 --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-users.rst @@ -0,0 +1,29 @@ +**To list IAM users** + +The following ``list-users`` command lists the IAM users in the current account:: + + aws iam list-users + +Output:: + + "Users": [ + { + "UserName": "Adele", + "Path": "/", + "CreateDate": "2013-03-07T05:14:48Z", + "UserId": "AKIAI44QH8DHBEXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Adele" + }, + { + "UserName": "Bob", + "Path": "/", + "CreateDate": "2012-09-21T23:03:13Z", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "Arn": "arn:aws:iam::123456789012:user/Bob" + } + ] + +For more information, see `Listing Users`_ in the *Using IAM* guide. + +.. _`Listing Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_GetListOfUsers.html + diff --git a/aws/dist/awscli/examples/iam/list-virtual-mfa-devices.rst b/aws/dist/awscli/examples/iam/list-virtual-mfa-devices.rst new file mode 100644 index 00000000..1208662c --- /dev/null +++ b/aws/dist/awscli/examples/iam/list-virtual-mfa-devices.rst @@ -0,0 +1,23 @@ +**To list virtual MFA devices** + +The following ``list-virtual-mfa-devices`` command lists the virtual MFA devices that have been configured for the current account:: + + aws iam list-virtual-mfa-devices + +Output:: + + { + "VirtualMFADevices": [ + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" + }, + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/Fred" + } + ] + } + +For more information, see `Using a Virtual MFA Device with AWS`_ in the *Using IAM* guide. + +.. _`Using a Virtual MFA Device with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_VirtualMFA.html + diff --git a/aws/dist/awscli/examples/iam/put-group-policy.rst b/aws/dist/awscli/examples/iam/put-group-policy.rst new file mode 100644 index 00000000..58509912 --- /dev/null +++ b/aws/dist/awscli/examples/iam/put-group-policy.rst @@ -0,0 +1,13 @@ +**To add a policy to a group** + +The following ``put-group-policy`` command adds a policy to the IAM group named ``Admins``:: + + aws iam put-group-policy --group-name Admins --policy-document file://AdminPolicy.json --policy-name AdminRoot + +The policy is defined as a JSON document in the *AdminPolicy.json* file. (The file name and extension do not have +significance.) + +For more information, see `Managing IAM Policies`_ in the *Using IAM* guide. + +.. _`Managing IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingPolicies.html + diff --git a/aws/dist/awscli/examples/iam/put-role-permissions-boundary.rst b/aws/dist/awscli/examples/iam/put-role-permissions-boundary.rst new file mode 100755 index 00000000..f3b730e8 --- /dev/null +++ b/aws/dist/awscli/examples/iam/put-role-permissions-boundary.rst @@ -0,0 +1,19 @@ +**To apply a permissions boundary based on a custom policy to an IAM role** + +The following ``put-role-permissions-boundary`` example applies the custom policy named ``intern-boundary`` as the permissions boundary for the specified IAM role. :: + + aws iam put-role-permissions-boundary \ + --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ + --role-name lambda-application-role + +This command produces no output. + +**To apply a permissions boundary based on an AWS managed policy to an IAM role** + +The following ``put-role-permissions-boundary`` example applies the AWS managed ``PowerUserAccess`` policy as the permissions boundary for the specified IAM role . :: + + aws iam put-role-permissions-boundary \ + --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ + --role-name x-account-admin + +This command produces no output. diff --git a/aws/dist/awscli/examples/iam/put-role-policy.rst b/aws/dist/awscli/examples/iam/put-role-policy.rst new file mode 100644 index 00000000..fbe07e90 --- /dev/null +++ b/aws/dist/awscli/examples/iam/put-role-policy.rst @@ -0,0 +1,14 @@ +**To attach a permissions policy to an IAM role** + +The following ``put-role-policy`` command adds a permissions policy to the role named ``Test-Role``:: + + aws iam put-role-policy --role-name Test-Role --policy-name ExamplePolicy --policy-document file://AdminPolicy.json + +The policy is defined as a JSON document in the *AdminPolicy.json* file. (The file name and extension do not have significance.) + +To attach a trust policy to a role, use the ``update-assume-role-policy`` command. + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + diff --git a/aws/dist/awscli/examples/iam/put-user-permissions-boundary.rst b/aws/dist/awscli/examples/iam/put-user-permissions-boundary.rst new file mode 100755 index 00000000..50890e6c --- /dev/null +++ b/aws/dist/awscli/examples/iam/put-user-permissions-boundary.rst @@ -0,0 +1,19 @@ +**To apply a permissions boundary based on a custom policy to an IAM user** + +The following ``put-user-permissions-boundary`` example applies a custom policy named ``intern-boundary`` as the permissions boundary for the specified IAM user. :: + + aws iam put-user-permissions-boundary \ + --permissions-boundary arn:aws:iam::123456789012:policy/intern-boundary \ + --user-name intern + +This command produces no output. + +**To apply a permissions boundary based on an AWS managed policy to an IAM user** + +The following ``put-user-permissions-boundary`` example applies the AWS managed pollicy named ``PowerUserAccess`` as the permissions boundary for the specified IAM user. :: + + aws iam put-user-permissions-boundary \ + --permissions-boundary arn:aws:iam::aws:policy/PowerUserAccess \ + --user-name developer + +This command produces no output. diff --git a/aws/dist/awscli/examples/iam/put-user-policy.rst b/aws/dist/awscli/examples/iam/put-user-policy.rst new file mode 100644 index 00000000..63a0de26 --- /dev/null +++ b/aws/dist/awscli/examples/iam/put-user-policy.rst @@ -0,0 +1,16 @@ +**To attach a policy to an IAM user** + +The following ``put-user-policy`` command attaches a policy to the IAM user named ``Bob``:: + + aws iam put-user-policy --user-name Bob --policy-name ExamplePolicy --policy-document file://AdminPolicy.json + +The policy is defined as a JSON document in the *AdminPolicy.json* file. (The file name and extension do not have significance.) + +For more information, see `Adding a New User to Your AWS Account`_ in the *Using IAM* guide. + +.. _`Adding a New User to Your AWS Account`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_SettingUpUser.html + + + + + diff --git a/aws/dist/awscli/examples/iam/remove-client-id-from-open-id-connect-provider.rst b/aws/dist/awscli/examples/iam/remove-client-id-from-open-id-connect-provider.rst new file mode 100644 index 00000000..3f946d92 --- /dev/null +++ b/aws/dist/awscli/examples/iam/remove-client-id-from-open-id-connect-provider.rst @@ -0,0 +1,11 @@ +**To remove the specified client ID from the list of client IDs registered for the specified IAM OpenID Connect provider** + +This example removes the client ID ``My-TestApp-3`` from the list of client IDs associated with the IAM OIDC provider whose +ARN is ``arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com``:: + + aws iam remove-client-id-from-open-id-connect-provider --client-id My-TestApp-3 --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com + + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/remove-role-from-instance-profile.rst b/aws/dist/awscli/examples/iam/remove-role-from-instance-profile.rst new file mode 100644 index 00000000..14d82015 --- /dev/null +++ b/aws/dist/awscli/examples/iam/remove-role-from-instance-profile.rst @@ -0,0 +1,11 @@ +**To remove a role from an instance profile** + +The following ``remove-role-from-instance-profile`` command removes the role named ``Test-Role`` from the instance +profile named ``ExampleInstanceProfile``:: + + aws iam remove-role-from-instance-profile --instance-profile-name ExampleInstanceProfile --role-name Test-Role + +For more information, see `Instance Profiles`_ in the *Using IAM* guide. + +.. _`Instance Profiles`: http://docs.aws.amazon.com/IAM/latest/UserGuide/instance-profiles.html + diff --git a/aws/dist/awscli/examples/iam/remove-user-from-group.rst b/aws/dist/awscli/examples/iam/remove-user-from-group.rst new file mode 100644 index 00000000..04787caf --- /dev/null +++ b/aws/dist/awscli/examples/iam/remove-user-from-group.rst @@ -0,0 +1,10 @@ +**To remove a user from an IAM group** + +The following ``remove-user-from-group`` command removes the user named ``Bob`` from the IAM group named ``Admins``:: + + aws iam remove-user-from-group --user-name Bob --group-name Admins + +For more information, see `Adding Users to and Removing Users from a Group`_ in the *Using IAM* guide. + +.. _`Adding Users to and Removing Users from a Group`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_AddOrRemoveUsersFromGroup.html + diff --git a/aws/dist/awscli/examples/iam/reset-service-specific-credential.rst b/aws/dist/awscli/examples/iam/reset-service-specific-credential.rst new file mode 100644 index 00000000..74a3151c --- /dev/null +++ b/aws/dist/awscli/examples/iam/reset-service-specific-credential.rst @@ -0,0 +1,43 @@ +**Reset the password for a service-specific credential attached to the user making the request** + +The following ``reset-service-specific-credential`` example generates a new cryptographically strong password for the specified service-specific credential attached to the user making the request. :: + + aws iam reset-service-specific-credential --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +**Reset the password for a service-specific credential attached to a specified user** + +The following ``reset-service-specific-credential`` example generates a new cryptographically strong password for a service-specific credential attached to the specified user. :: + + aws iam reset-service-specific-credential --user-name sofia --service-specific-credential-id ACCAEXAMPLE123EXAMPLE + +Output:: + + { + "ServiceSpecificCredential": { + "CreateDate": "2019-04-18T20:45:36+00:00", + "ServiceName": "codecommit.amazonaws.com", + "ServiceUserName": "sofia-at-123456789012", + "ServicePassword": "+oaFsNk7tLco+C/obP9GhhcOzGcKOayTmE3LnAmAmH4=", + "ServiceSpecificCredentialId": "ACCAEXAMPLE123EXAMPLE", + "UserName": "sofia", + "Status": "Active" + } + } + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit`_ in the *AWS CodeCommit User Guide* + +.. _`Create Git Credentials for HTTPS Connections to CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-gc.html#setting-up-gc-iam diff --git a/aws/dist/awscli/examples/iam/resync-mfa-device.rst b/aws/dist/awscli/examples/iam/resync-mfa-device.rst new file mode 100644 index 00000000..15542fd2 --- /dev/null +++ b/aws/dist/awscli/examples/iam/resync-mfa-device.rst @@ -0,0 +1,11 @@ +**To synchronize the specified MFA device with AWS servers** + +This example synchronizes the MFA device that is associated with the IAM user ``Bob`` and whose ARN is ``arn:aws:iam::123456789012:mfa/BobsMFADevice`` +with an authenticator program that provided the two authentication codes:: + + aws iam resync-mfa-device --user-name Bob --serial-number arn:aws:iam::210987654321:mfa/BobsMFADevice --authentication-code-1 123456 --authentication-code-2 987654 + + +For more information, see `Using Multi-Factor Authentication (MFA) Devices with AWS`_ in the *IAM User* guide. + +.. _`Using Multi-Factor Authentication (MFA) Devices with AWS`: http://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/set-default-policy-version.rst b/aws/dist/awscli/examples/iam/set-default-policy-version.rst new file mode 100644 index 00000000..44e672e6 --- /dev/null +++ b/aws/dist/awscli/examples/iam/set-default-policy-version.rst @@ -0,0 +1,10 @@ +**To set the specified version of the specified policy as the policy's default version.** + +This example sets the ``v2`` version of the policy whose ARN is ``arn:aws:iam::123456789012:policy/MyPolicy`` as the default active version:: + + aws iam set-default-policy-version --policy-arn arn:aws:iam::123456789012:policy/MyPolicy --version-id v2 + + +For more information, see `Overview of IAM Policies`_ in the *Using IAM* guide. + +.. _`Overview of IAM Policies`: http://docs.aws.amazon.com/IAM/latest/UserGuide/policies_overview.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/set-security-token-service-preferences.rst b/aws/dist/awscli/examples/iam/set-security-token-service-preferences.rst new file mode 100755 index 00000000..0fd895e6 --- /dev/null +++ b/aws/dist/awscli/examples/iam/set-security-token-service-preferences.rst @@ -0,0 +1,8 @@ +**To set the global endpoint token version** + +The following ``set-security-token-service-preferences`` example configures Amazon STS to use version 2 tokens when you authenticate against the global endpoint. :: + + aws iam set-security-token-service-preferences \ + --global-endpoint-token-version v2Token + +This command produces no output. diff --git a/aws/dist/awscli/examples/iam/simulate-custom-policy.rst b/aws/dist/awscli/examples/iam/simulate-custom-policy.rst new file mode 100755 index 00000000..80dca9e0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/simulate-custom-policy.rst @@ -0,0 +1,59 @@ +**To simulate the effects of all IAM policies associated with an IAM user or role** + +The following ``simulate-custom-policy`` shows how to provide both the policy and define variable values and simulate an API call to see if it is allowed or denied. The following example shows a policy that enables database access only after a specified date and time. The simulation succeeds because the simulated actions and the specified ``aws:CurrentTime`` variable all match the requirements of the policy. :: + + aws iam simulate-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2019-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "allowed", + "MatchedStatements": [ + { + "SourcePolicyId": "PolicyInputList.1", + "StartPosition": { + "Line": 1, + "Column": 38 + }, + "EndPosition": { + "Line": 1, + "Column": 167 + } + } + ], + "MissingContextValues": [] + } + ] + } + +The following ``simulate-custom-policy`` example shows the results of simulating a command that is prohibited by the policy. In this example, the provided date is before that required by the policy's condition. :: + + aws iam simulate-custom-policy \ + --policy-input-list '{"Version":"2012-10-17","Statement":{"Effect":"Allow","Action":"dynamodb:*","Resource":"*","Condition":{"DateGreaterThan":{"aws:CurrentTime":"2018-08-16T12:00:00Z"}}}}' \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2014-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "implicitDeny", + "MatchedStatements": [], + "MissingContextValues": [] + } + ] + } + +For more information, see `Testing IAM Policies with the IAM Policy Simulator`_ in the *AWS IAM User Guide* + +.. _`Testing IAM Policies with the IAM Policy Simulator`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html diff --git a/aws/dist/awscli/examples/iam/simulate-principal-policy.rst b/aws/dist/awscli/examples/iam/simulate-principal-policy.rst new file mode 100755 index 00000000..3566f5dc --- /dev/null +++ b/aws/dist/awscli/examples/iam/simulate-principal-policy.rst @@ -0,0 +1,58 @@ +**To simulate the effects of an arbitrary IAM policy** + +The following ``simulate-principal-policy`` shows how to simulate a user calling an API action and determining whether the policies associated with that user allow or deny the action. In the following example, the user has a policy that allows only the ``codecommit:ListRepositories`` action. :: + + aws iam simulate-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ + --action-names codecommit:ListRepositories + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "codecommit:ListRepositories", + "EvalResourceName": "*", + "EvalDecision": "allowed", + "MatchedStatements": [ + { + "SourcePolicyId": "Grant-Access-To-CodeCommit-ListRepo", + "StartPosition": { + "Line": 3, + "Column": 19 + }, + "EndPosition": { + "Line": 9, + "Column": 10 + } + } + ], + "MissingContextValues": [] + } + ] + } + +The following ``simulate-custom-policy`` example shows the results of simulating a command that is prohibited by one of the user's policies. In the following example, the user has a policy that permits access to a DynamoDB database only after a certain date and time. The simulation has the user attempting to access the database with an ``aws:CurrentTime`` value that is earlier than the policy's condition permits. :: + + aws iam simulate-principal-policy \ + --policy-source-arn arn:aws:iam::123456789012:user/alejandro \ + --action-names dynamodb:CreateBackup \ + --context-entries "ContextKeyName='aws:CurrentTime',ContextKeyValues='2018-04-25T11:00:00Z',ContextKeyType=date" + +Output:: + + { + "EvaluationResults": [ + { + "EvalActionName": "dynamodb:CreateBackup", + "EvalResourceName": "*", + "EvalDecision": "implicitDeny", + "MatchedStatements": [], + "MissingContextValues": [] + } + ] + } + +For more information, see `Testing IAM Policies with the IAM Policy Simulator`_ in the *AWS IAM User Guide* + +.. _`Testing IAM Policies with the IAM Policy Simulator`: https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_testing-policies.html diff --git a/aws/dist/awscli/examples/iam/tag-role.rst b/aws/dist/awscli/examples/iam/tag-role.rst new file mode 100644 index 00000000..0b5dbee4 --- /dev/null +++ b/aws/dist/awscli/examples/iam/tag-role.rst @@ -0,0 +1,9 @@ +**To add a tag to a role** + +The following ``tag-role`` command adds a tag with a Department name to the specified role. This command produces no output. :: + + aws iam tag-role --role-name my-role --tags '{"Key": "Department", "Value": "Accounting"}' + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/tag-user.rst b/aws/dist/awscli/examples/iam/tag-user.rst new file mode 100644 index 00000000..f27eee02 --- /dev/null +++ b/aws/dist/awscli/examples/iam/tag-user.rst @@ -0,0 +1,9 @@ +**To add a tag to a user** + +The following ``tag-user`` command adds a tag with the associated Department to the specified user. This command produces no output. :: + + aws iam tag-user --user-name alice --tags '{"Key": "Department", "Value": "Accounting"}' + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/untag-role.rst b/aws/dist/awscli/examples/iam/untag-role.rst new file mode 100644 index 00000000..af20d503 --- /dev/null +++ b/aws/dist/awscli/examples/iam/untag-role.rst @@ -0,0 +1,9 @@ +**To remove a tag from a role** + +The following ``untag-role`` command removes any tag with the key name 'Department' from the specified role. This command produces no output. :: + + aws iam untag-role --role-name my-role --tag-keys Department + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/untag-user.rst b/aws/dist/awscli/examples/iam/untag-user.rst new file mode 100644 index 00000000..d09b0cb9 --- /dev/null +++ b/aws/dist/awscli/examples/iam/untag-user.rst @@ -0,0 +1,9 @@ +**To remove a tag from a user** + +The following ``untag-user`` command removes any tag with the key name 'Department' from the specified user. This command produces no output. :: + + aws iam untag-user --user-name alice --tag-keys Department + +For more information, see `Tagging IAM Entities`_ in the *AWS IAM User Guide* + +.. _`Tagging IAM Entities`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html diff --git a/aws/dist/awscli/examples/iam/update-access-key.rst b/aws/dist/awscli/examples/iam/update-access-key.rst new file mode 100644 index 00000000..749f8541 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-access-key.rst @@ -0,0 +1,14 @@ +**To activate or deactivate an access key for an IAM user** + +The following ``update-access-key`` command deactivates the specified access key (access key ID and secret access key) +for the IAM user named ``Bob``:: + + aws iam update-access-key --access-key-id AKIAIOSFODNN7EXAMPLE --status Inactive --user-name Bob + +Deactivating the key means that it cannot be used for programmatic access to AWS. However, the key is still available and can be reactivated. + +For more information, see `Creating, Modifying, and Viewing User Security Credentials`_ in the *Using IAM* guide. + +.. _`Creating, Modifying, and Viewing User Security Credentials`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_CreateAccessKey.html + + diff --git a/aws/dist/awscli/examples/iam/update-account-password-policy.rst b/aws/dist/awscli/examples/iam/update-account-password-policy.rst new file mode 100644 index 00000000..7d09e452 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-account-password-policy.rst @@ -0,0 +1,14 @@ +**To set or change the current account password policy** + +The following ``update-account-password-policy`` command sets the password policy to require a minimum length of eight +characters and to require one or more numbers in the password:: + + aws iam update-account-password-policy --minimum-password-length 8 --require-numbers + +Changes to an account's password policy affect any new passwords that are created for IAM users in the account. Password +policy changes do not affect existing passwords. + +For more information, see `Setting an Account Password Policy for IAM Users`_ in the *Using IAM* guide. + +.. _`Setting an Account Password Policy for IAM Users`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingPasswordPolicies.html + diff --git a/aws/dist/awscli/examples/iam/update-assume-role-policy.rst b/aws/dist/awscli/examples/iam/update-assume-role-policy.rst new file mode 100644 index 00000000..05582858 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-assume-role-policy.rst @@ -0,0 +1,16 @@ +**To update the trust policy for an IAM role** + +The following ``update-assume-role-policy`` command updates the trust policy for the role named ``Test-Role``:: + + aws iam update-assume-role-policy --role-name Test-Role --policy-document file://Test-Role-Trust-Policy.json + +The trust policy is defined as a JSON document in the *Test-Role-Trust-Policy.json* file. (The file name and extension +do not have significance.) The trust policy must specify a principal. + +To update the permissions policy for a role, use the ``put-role-policy`` command. + +For more information, see `Creating a Role`_ in the *Using IAM* guide. + +.. _`Creating a Role`: http://docs.aws.amazon.com/IAM/latest/UserGuide/creating-role.html + + diff --git a/aws/dist/awscli/examples/iam/update-group.rst b/aws/dist/awscli/examples/iam/update-group.rst new file mode 100644 index 00000000..34e27160 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-group.rst @@ -0,0 +1,10 @@ +**To rename an IAM group** + +The following ``update-group`` command changes the name of the IAM group ``Test`` to ``Test-1``:: + + aws iam update-group --group-name Test --new-group-name Test-1 + +For more information, see `Changing a Group's Name or Path`_ in the *Using IAM* guide. + +.. _`Changing a Group's Name or Path`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_RenamingGroup.html + diff --git a/aws/dist/awscli/examples/iam/update-login-profile.rst b/aws/dist/awscli/examples/iam/update-login-profile.rst new file mode 100644 index 00000000..0ae208a4 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-login-profile.rst @@ -0,0 +1,18 @@ +**To update the password for an IAM user** + +The following ``update-login-profile`` command creates a new password for the IAM user named ``Bob``:: + + aws iam update-login-profile --user-name Bob --password + +To set a password policy for the account, use the ``update-account-password-policy`` command. If the new password +violates the account password policy, the command returns a ``PasswordPolicyViolation`` error. + +If the account password policy allows them to, IAM users can change their own passwords using the ``change-password`` command. + +Store the password in a secure place. If the password is lost, it cannot be recovered, and you must create a new one using the ``create-login-profile`` command. + +For more information, see `Managing Passwords`_ in the *Using IAM* guide. + +.. _`Managing Passwords`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html + + diff --git a/aws/dist/awscli/examples/iam/update-open-id-connect-provider-thumbprint.rst b/aws/dist/awscli/examples/iam/update-open-id-connect-provider-thumbprint.rst new file mode 100644 index 00000000..582aa207 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-open-id-connect-provider-thumbprint.rst @@ -0,0 +1,11 @@ +**To replace the existing list of server certificate thumbprints with a new list** + +This example updates the certificate thumbprint list for the OIDC provider whose ARN is +``arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com`` to use a new thumbprint:: + + aws iam update-open-id-connect-provider-thumbprint --open-id-connect-provider-arn arn:aws:iam::123456789012:oidc-provider/example.oidcprovider.com --thumbprint-list 7359755EXAMPLEabc3060bce3EXAMPLEec4542a3 + + +For more information, see `Using OpenID Connect Identity Providers`_ in the *Using IAM* guide. + +.. _`Using OpenID Connect Identity Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-oidc.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/update-role-description.rst b/aws/dist/awscli/examples/iam/update-role-description.rst new file mode 100644 index 00000000..60d6f906 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-role-description.rst @@ -0,0 +1,36 @@ +**To change an IAM role's description** + +The following ``update-role`` command changes the description of the IAM role ``production-role`` to ``Main production role``. :: + + aws iam update-role-description --role-name production-role --description 'Main production role' + + Output:: + + { + "Role": { + "Path": "/", + "RoleName": "production-role", + "RoleId": "AROA1234567890EXAMPLE", + "Arn": "arn:aws:iam::123456789012:role/production-role", + "CreateDate": "2017-12-06T17:16:37+00:00", + "AssumeRolePolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:root" + }, + "Action": "sts:AssumeRole", + "Condition": {} + } + ] + }, + "Description": "Main production role" + } + } + +For more information, see `Modifying a Role`_ in the *AWS IAM User's Guide*. + +.. _`Modifying a Role`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html + diff --git a/aws/dist/awscli/examples/iam/update-role.rst b/aws/dist/awscli/examples/iam/update-role.rst new file mode 100644 index 00000000..002519d1 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-role.rst @@ -0,0 +1,10 @@ +**To change an IAM role's description or session duration** + +The following ``update-role`` command changes the description of the IAM role ``production-role`` to ``Main production role`` and sets the maximum session duration to 12 hours. :: + + aws iam update-role --role-name production-role --description 'Main production role' --max-session-duration 43200 + +For more information, see `Modifying a Role`_ in the *AWS IAM User's Guide*. + +.. _`Modifying a Role`: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_manage_modify.html + diff --git a/aws/dist/awscli/examples/iam/update-saml-provider.rst b/aws/dist/awscli/examples/iam/update-saml-provider.rst new file mode 100644 index 00000000..4920dc47 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-saml-provider.rst @@ -0,0 +1,15 @@ +**To update the metadata document for an existing SAML provider** + +This example updates the SAML provider in IAM whose ARN is ``arn:aws:iam::123456789012:saml-provider/SAMLADFS`` with a new SAML metadata document from the file ``SAMLMetaData.xml``:: + + aws iam update-saml-provider --saml-metadata-document file://SAMLMetaData.xml --saml-provider-arn arn:aws:iam::123456789012:saml-provider/SAMLADFS + +Output:: + + { + "SAMLProviderArn": "arn:aws:iam::123456789012:saml-provider/SAMLADFS" + } + +For more information, see `Using SAML Providers`_ in the *Using IAM* guide. + +.. _`Using SAML Providers`: http://docs.aws.amazon.com/IAM/latest/UserGuide/identity-providers-saml.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/iam/update-server-certificate.rst b/aws/dist/awscli/examples/iam/update-server-certificate.rst new file mode 100644 index 00000000..c45a1d95 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-server-certificate.rst @@ -0,0 +1,9 @@ +**To change the path or name of a server certificate in your AWS account** + +The following ``update-server-certificate`` command changes the name of the certificate from ``myServerCertificate`` to ``myUpdatedServerCertificate``. It also changes the path to ``/cloudfront/`` so that it can be accessed by the Amazon CloudFront service. This command produces no output. You can see the results of the update by running the ``list-server-certificates`` command. :: + + aws-iam update-server-certificate --server-certificate-name myServerCertificate --new-server-certificate-name myUpdatedServerCertificate --new-path /cloudfront/ + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *IAM Users Guide*. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/InstallCert.html diff --git a/aws/dist/awscli/examples/iam/update-service-specific-credential.rst b/aws/dist/awscli/examples/iam/update-service-specific-credential.rst new file mode 100644 index 00000000..988086b0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-service-specific-credential.rst @@ -0,0 +1,18 @@ +**Example 1: To update the status of the requesting user's service-specific credential** + +The following ``update-service-specific-credential`` example changes the status for the specified credential for the user making the request to ``Inactive``. This command produces no output. :: + + aws iam update-service-specific-credential \ + --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ + --status Inactive + +**Example 2: To update the status of a specified user's service-specific credential** + +The following ``update-service-specific-credential`` example changes the status for the credential of the specified user to Inactive. This command produces no output. :: + + aws iam update-service-specific-credential \ + --user-name sofia \ + --service-specific-credential-id ACCAEXAMPLE123EXAMPLE \ + --status Inactive + +For more information, see `Create Git Credentials for HTTPS Connections to CodeCommit `_ in the *AWS CodeCommit User Guide* diff --git a/aws/dist/awscli/examples/iam/update-signing-certificate.rst b/aws/dist/awscli/examples/iam/update-signing-certificate.rst new file mode 100644 index 00000000..87567a67 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-signing-certificate.rst @@ -0,0 +1,12 @@ +**To activate or deactivate a signing certificate for an IAM user** + +The following ``update-signing-certificate`` command deactivates the specified signing certificate for the IAM user named ``Bob``:: + + aws iam update-signing-certificate --certificate-id TA7SMP42TDN5Z26OBPJE7EXAMPLE --status Inactive --user-name Bob + +To get the ID for a signing certificate, use the ``list-signing-certificates`` command. + +For more information, see `Creating and Uploading a User Signing Certificate`_ in the *Using IAM* guide. + +.. _`Creating and Uploading a User Signing Certificate`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_UploadCertificate.html + diff --git a/aws/dist/awscli/examples/iam/update-ssh-public-key.rst b/aws/dist/awscli/examples/iam/update-ssh-public-key.rst new file mode 100644 index 00000000..a140a01d --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-ssh-public-key.rst @@ -0,0 +1,12 @@ +**To change the status of an SSH public key** + +The following ``update-ssh-public-key`` command changes the status of the specified public key to ``Inactive``. :: + + aws iam update-ssh-public-key \ + --user-name sofia \ + --ssh-public-key-id APKA1234567890EXAMPLE \ + --status Inactive + +This command produces no output. + +For more information about SSH keys in IAM, see `Use SSH Keys and SSH with CodeCommit `_ in the *AWS IAM User Guide* diff --git a/aws/dist/awscli/examples/iam/update-user.rst b/aws/dist/awscli/examples/iam/update-user.rst new file mode 100644 index 00000000..098f3259 --- /dev/null +++ b/aws/dist/awscli/examples/iam/update-user.rst @@ -0,0 +1,10 @@ +**To change an IAM user's name** + +The following ``update-user`` command changes the name of the IAM user ``Bob`` to ``Robert``:: + + aws iam update-user --user-name Bob --new-user-name Robert + +For more information, see `Changing a Group's Name or Path`_ in the *Using IAM* guide. + +.. _`Changing a Group's Name or Path`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_RenamingGroup.html + diff --git a/aws/dist/awscli/examples/iam/upload-server-certificate.rst b/aws/dist/awscli/examples/iam/upload-server-certificate.rst new file mode 100644 index 00000000..94ec2b26 --- /dev/null +++ b/aws/dist/awscli/examples/iam/upload-server-certificate.rst @@ -0,0 +1,23 @@ +**To upload a server certificate to your AWS account** + +The following **upload-server-certificate** command uploads a server certificate to your AWS account. In this example, the certificate is in the file ``public_key_cert_file.pem``, the associated private key is in the file ``my_private_key.pem``, and the the certificate chain provided by the certificate authority (CA) is in the ``my_certificate_chain_file.pem`` file. When the file has finished uploading, it is available under the name *myServerCertificate*. Parameters that begin with ``file://`` tells the command to read the contents of the file and use that as the parameter value instead of the file name itself. :: + + aws iam upload-server-certificate --server-certificate-name myServerCertificate --certificate-body file://public_key_cert_file.pem --private-key file://my_private_key.pem --certificate-chain file://my_certificate_chain_file.pem + +Output:: + + { + "ServerCertificateMetadata": { + "Path": "/", + "ServerCertificateName": "myServerCertificate", + "ServerCertificateId": "ASCAEXAMPLE123EXAMPLE", + "Arn": "arn:aws:iam::1234567989012:server-certificate/myServerCertificate", + "UploadDate": "2019-04-22T21:13:44+00:00", + "Expiration": "2019-10-15T22:23:16+00:00" + } + } + +For more information, see `Creating, Uploading, and Deleting Server Certificates`_ in the *Using IAM* guide. + +.. _`Creating, Uploading, and Deleting Server Certificates`: http://docs.aws.amazon.com/IAM/latest/UserGuide/InstallCert.html + diff --git a/aws/dist/awscli/examples/iam/upload-signing-certificate.rst b/aws/dist/awscli/examples/iam/upload-signing-certificate.rst new file mode 100644 index 00000000..c995dd07 --- /dev/null +++ b/aws/dist/awscli/examples/iam/upload-signing-certificate.rst @@ -0,0 +1,24 @@ +**To upload a signing certificate for an IAM user** + +The following ``upload-signing-certificate`` command uploads a signing certificate for the IAM user named ``Bob``:: + + aws iam upload-signing-certificate --user-name Bob --certificate-body file://certificate.pem + +Output:: + + { + "Certificate": { + "UserName": "Bob", + "Status": "Active", + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UploadDate": "2013-06-06T21:40:08.121Z" + } + } + +The certificate is in a file named *certificate.pem* in PEM format. + +For more information, see `Creating and Uploading a User Signing Certificate`_ in the *Using IAM* guide. + +.. _`Creating and Uploading a User Signing Certificate`: http://docs.aws.amazon.com/IAM/latest/UserGuide/Using_UploadCertificate.html + diff --git a/aws/dist/awscli/examples/iam/upload-ssh-public-key.rst b/aws/dist/awscli/examples/iam/upload-ssh-public-key.rst new file mode 100644 index 00000000..fb835634 --- /dev/null +++ b/aws/dist/awscli/examples/iam/upload-ssh-public-key.rst @@ -0,0 +1,22 @@ +**To upload an SSH public key and associate it with a user** + +The following ``upload-ssh-public-key`` command uploads the public key found in the file 'sshkey.pub' and attaches it to the user 'sofia'. :: + + aws iam upload-ssh-public-key --user-name sofia --ssh-public-key-body file://sshkey.pub + +Output:: + + { + "SSHPublicKey": { + "UserName": "sofia", + "SSHPublicKeyId": "APKA1234567890EXAMPLE", + "Fingerprint": "12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef", + "SSHPublicKeyBody": "ssh-rsa <>", + "Status": "Active", + "UploadDate": "2019-04-18T17:04:49+00:00" + } + } + +For more information about how to generate keys in a format suitable for this command, see `SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit`_ or `SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit`_in the *AWS CodeCommit User Guide* +.. _`SSH and Linux, macOS, or Unix: Set Up the Public and Private Keys for Git and CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-unixes.html#setting-up-ssh-unixes-keys +.. _`SSH and Windows: Set Up the Public and Private Keys for Git and CodeCommit`: https://docs.aws.amazon.com/codecommit/latest/userguide/setting-up-ssh-windows.html#setting-up-ssh-windows-keys-windows diff --git a/aws/dist/awscli/examples/iam/wait/instance-profile-exists.rst b/aws/dist/awscli/examples/iam/wait/instance-profile-exists.rst new file mode 100644 index 00000000..89e6c97c --- /dev/null +++ b/aws/dist/awscli/examples/iam/wait/instance-profile-exists.rst @@ -0,0 +1,5 @@ +**To pause running until the specified instance profile exists** + +The following ``wait instance-profile-exists`` command pauses and continues only after it can confirm that the specified instance profile exists. There is no output. :: + + aws iam wait instance-profile-exists --instance-profile-name WebServer diff --git a/aws/dist/awscli/examples/iam/wait/policy-exists.rst b/aws/dist/awscli/examples/iam/wait/policy-exists.rst new file mode 100644 index 00000000..a005afe6 --- /dev/null +++ b/aws/dist/awscli/examples/iam/wait/policy-exists.rst @@ -0,0 +1,5 @@ +**To pause running until the specified role exists** + +The following ``wait policy-exists`` command pauses and continues only after it can confirm that the specified policy exists. There is no output. :: + + aws iam wait policy-exists --policy-name MyPolicy diff --git a/aws/dist/awscli/examples/iam/wait/role-exists.rst b/aws/dist/awscli/examples/iam/wait/role-exists.rst new file mode 100644 index 00000000..35c42afd --- /dev/null +++ b/aws/dist/awscli/examples/iam/wait/role-exists.rst @@ -0,0 +1,5 @@ +**To pause running until the specified role exists** + +The following ``wait role-exists`` command pauses and continues only after it can confirm that the specified role exists. There is no output. :: + + aws iam wait role-exists --role-name MyRole diff --git a/aws/dist/awscli/examples/iam/wait/user-exists.rst b/aws/dist/awscli/examples/iam/wait/user-exists.rst new file mode 100644 index 00000000..c1ea17a0 --- /dev/null +++ b/aws/dist/awscli/examples/iam/wait/user-exists.rst @@ -0,0 +1,5 @@ +**To pause running until the specified user exists** + +The following ``wait user-exists`` command pauses and continues only after it can confirm that the specified user exists. There is no output. :: + + aws iam wait user-exists --user-name marcia diff --git a/aws/dist/awscli/examples/importexport/cancel-job.rst b/aws/dist/awscli/examples/importexport/cancel-job.rst new file mode 100644 index 00000000..d93ce0d0 --- /dev/null +++ b/aws/dist/awscli/examples/importexport/cancel-job.rst @@ -0,0 +1,5 @@ +The following command cancels the specified job:: + + aws importexport cancel-job --job-id EX1ID + +Only jobs that were created by the AWS account you're currently using can be canceled. Jobs that have already completed cannot be canceled. diff --git a/aws/dist/awscli/examples/importexport/create-job.rst b/aws/dist/awscli/examples/importexport/create-job.rst new file mode 100644 index 00000000..4b6d7536 --- /dev/null +++ b/aws/dist/awscli/examples/importexport/create-job.rst @@ -0,0 +1,45 @@ +The following command creates an import job from a manifest file:: + + aws importexport create-job --job-type import --manifest file://manifest --no-validate-only + +The file ``manifest`` is a YAML formatted text file in the current directory with the following content:: + + manifestVersion: 2.0; + returnAddress: + name: Jane Roe + company: Example Corp. + street1: 123 Any Street + city: Anytown + stateOrProvince: WA + postalCode: 91011-1111 + phoneNumber: 206-555-1111 + country: USA + deviceId: 49382 + eraseDevice: yes + notificationEmail: john.doe@example.com;jane.roe@example.com + bucket: myBucket + +For more information on the manifest file format, see `Creating Import Manifests`_ in the *AWS Import/Export Developer Guide*. + +.. _`Creating Import Manifests`: http://docs.aws.amazon.com/AWSImportExport/latest/DG/ImportManifestFile.html + +You can also pass the manifest as a string in quotes:: + + aws importexport create-job --job-type import --manifest 'manifestVersion: 2.0; + returnAddress: + name: Jane Roe + company: Example Corp. + street1: 123 Any Street + city: Anytown + stateOrProvince: WA + postalCode: 91011-1111 + phoneNumber: 206-555-1111 + country: USA + deviceId: 49382 + eraseDevice: yes + notificationEmail: john.doe@example.com;jane.roe@example.com + bucket: myBucket' + +For information on quoting string arguments and using files, see `Specifying Parameter Values`_ in the *AWS CLI User Guide*. + +.. _`Specifying Parameter Values`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html diff --git a/aws/dist/awscli/examples/importexport/get-shipping-label.rst b/aws/dist/awscli/examples/importexport/get-shipping-label.rst new file mode 100644 index 00000000..9f8a08ef --- /dev/null +++ b/aws/dist/awscli/examples/importexport/get-shipping-label.rst @@ -0,0 +1,11 @@ +The following command creates a pre-paid shipping label for the specified job:: + + aws importexport get-shipping-label --job-ids EX1ID --name "Jane Roe" --company "Example Corp." --phone-number "206-555-1111" --country "USA" --state-or-province "WA" --city "Anytown" --postal-code "91011-1111" --street-1 "123 Any Street" + +The output for the get-shipping-label command looks like the following:: + + https://s3.amazonaws.com/myBucket/shipping-label-EX1ID.pdf + +The link in the output contains the pre-paid shipping label generated in a PDF. It also contains shipping instructions with a unique bar code to identify and authenticate your device. For more information about using the pre-paid shipping label and shipping your device, see `Shipping Your Storage Device`_ in the *AWS Import/Export Developer Guide*. + +.. _`Shipping Your Storage Device`: http://docs.aws.amazon.com/AWSImportExport/latest/DG/CHAP_ShippingYourStorageDevice.html diff --git a/aws/dist/awscli/examples/importexport/get-status.rst b/aws/dist/awscli/examples/importexport/get-status.rst new file mode 100644 index 00000000..1770efea --- /dev/null +++ b/aws/dist/awscli/examples/importexport/get-status.rst @@ -0,0 +1,32 @@ +The following command returns the status the specified job:: + + aws importexport get-status --job-id EX1ID + +The output for the get-status command looks like the following:: + + 2015-05-27T18:58:21Z manifestVersion:2.0 + generator:Text editor + bucket:myBucket + deviceId:49382 + eraseDevice:yes + notificationEmail:john.doe@example.com;jane.roe@example.com + trueCryptPassword:password123 + acl:private + serviceLevel:standard + returnAddress: + name: Jane Roe + company: Example Corp. + street1: 123 Any Street + street2: + street3: + city: Anytown + stateOrProvince: WA + postalCode: 91011-1111 + country:USA + phoneNumber:206-555-1111 0 EX1ID Import NotReceived AWS has not received your device. Pending The specified job has not started. + ktKDXpdbEXAMPLEyGFJmQO744UHw= version:2.0 + signingMethod:HmacSHA1 + jobId:EX1ID + signature:ktKDXpdbEXAMPLEyGFJmQO744UHw= + +When you ship your device, it will be delivered to a sorting facility, and then forwarded on to an AWS data center. Note that when you send a get-status command, the status of your job will not show as ``At AWS`` until the shipment has been received at the AWS data center. diff --git a/aws/dist/awscli/examples/importexport/list-jobs.rst b/aws/dist/awscli/examples/importexport/list-jobs.rst new file mode 100644 index 00000000..09264da1 --- /dev/null +++ b/aws/dist/awscli/examples/importexport/list-jobs.rst @@ -0,0 +1,9 @@ +The following command lists the jobs you've created:: + + aws importexport list-jobs + +The output for the list-jobs command looks like the following:: + + JOBS 2015-05-27T18:58:21Z False EX1ID Import + +You can only list jobs created by users under the AWS account you are currently using. Listing jobs returns useful information, like job IDs, which are necessary for other AWS Import/Export commands. diff --git a/aws/dist/awscli/examples/importexport/update-job.rst b/aws/dist/awscli/examples/importexport/update-job.rst new file mode 100644 index 00000000..eb958c40 --- /dev/null +++ b/aws/dist/awscli/examples/importexport/update-job.rst @@ -0,0 +1,9 @@ +The following command updates the specified job:: + + aws importexport update-job --job-id EX1ID --job-type import --manifest file://manifest.txt --no-validate-only + +The output for the update-jobs command looks like the following:: + + True **** Device will be erased before being returned. **** + +With this command, you can either modify the original manifest you submitted, or you can start over and create a new manifest file. In either case, the original manifest is discarded. diff --git a/aws/dist/awscli/examples/inspector/add-attributes-to-findings.rst b/aws/dist/awscli/examples/inspector/add-attributes-to-findings.rst new file mode 100644 index 00000000..4acf4336 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/add-attributes-to-findings.rst @@ -0,0 +1,16 @@ +**To add attributes to findings** + +The following ``add-attribute-to-finding`` command assigns an attribute with the key of ``Example`` and value of ``example`` to the finding with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU``:: + + aws inspector add-attributes-to-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU --attributes key=Example,value=example + +Output:: + + { + "failedItems": {} + } + +For more information, see `Amazon Inspector Findings`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Findings`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_findings.html + diff --git a/aws/dist/awscli/examples/inspector/create-assessment-target.rst b/aws/dist/awscli/examples/inspector/create-assessment-target.rst new file mode 100644 index 00000000..82afb1ed --- /dev/null +++ b/aws/dist/awscli/examples/inspector/create-assessment-target.rst @@ -0,0 +1,16 @@ +**To create an assessment target** + +The following ``create-assessment-target`` command creates an assessment target named ``ExampleAssessmentTarget`` using the resource group with the ARN of ``arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv``:: + + aws inspector create-assessment-target --assessment-target-name ExampleAssessmentTarget --resource-group-arn arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv + +Output:: + + { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/create-assessment-template.rst b/aws/dist/awscli/examples/inspector/create-assessment-template.rst new file mode 100644 index 00000000..9932d882 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/create-assessment-template.rst @@ -0,0 +1,16 @@ +**To create an assessment template** + +The following ``create-assessment-template`` command creates an assessment template called ``ExampleAssessmentTemplate`` for the assessment target with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX``:: + + aws inspector create-assessment-template --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX --assessment-template-name ExampleAssessmentTemplate --duration-in-seconds 180 --rules-package-arns arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p --user-attributes-for-findings key=ExampleTag,value=examplevalue + +Output:: + + { + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/create-resource-group.rst b/aws/dist/awscli/examples/inspector/create-resource-group.rst new file mode 100644 index 00000000..944812d3 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/create-resource-group.rst @@ -0,0 +1,16 @@ +**To create a resource group** + +The following ``create-resource-group`` command creates a resource group using the tag key of ``Name`` and value of ``example``:: + + aws inspector create-resource-group --resource-group-tags key=Name,value=example + +Output:: + + { + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/delete-assessment-run.rst b/aws/dist/awscli/examples/inspector/delete-assessment-run.rst new file mode 100644 index 00000000..778219d7 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/delete-assessment-run.rst @@ -0,0 +1,10 @@ +**To delete an assessment run** + +The following ``delete-assessment-run`` command deletes the assessment run with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe``:: + + aws inspector delete-assessment-run --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/delete-assessment-target.rst b/aws/dist/awscli/examples/inspector/delete-assessment-target.rst new file mode 100644 index 00000000..a50ee6e0 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/delete-assessment-target.rst @@ -0,0 +1,10 @@ +**To delete an assessment target** + +The following ``delete-assessment-target`` command deletes the assessment target with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq``:: + + aws inspector delete-assessment-target --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/delete-assessment-template.rst b/aws/dist/awscli/examples/inspector/delete-assessment-template.rst new file mode 100644 index 00000000..16fdb407 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/delete-assessment-template.rst @@ -0,0 +1,10 @@ +**To delete an assessment template** + +The following ``delete-assessment-template`` command deletes the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T``:: + + aws inspector delete-assessment-template --assessment-template-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/describe-assessment-runs.rst b/aws/dist/awscli/examples/inspector/describe-assessment-runs.rst new file mode 100644 index 00000000..41f7fc69 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-assessment-runs.rst @@ -0,0 +1,69 @@ +**To describe assessment runs** + +The following ``describe-assessment-run`` command describes an assessment run with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE``:: + + aws inspector describe-assessment-runs --assessment-run-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE + +Output:: + + { + "assessmentRuns": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "completedAt": 1458680301.4, + "createdAt": 1458680170.035, + "dataCollected": true, + "durationInSeconds": 3600, + "name": "Run 1 for ExampleAssessmentTemplate", + "notifications": [], + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "startedAt": 1458680170.161, + "state": "COMPLETED", + "stateChangedAt": 1458680301.4, + "stateChanges": [ + { + "state": "CREATED", + "stateChangedAt": 1458680170.035 + }, + { + "state": "START_DATA_COLLECTION_PENDING", + "stateChangedAt": 1458680170.065 + }, + { + "state": "START_DATA_COLLECTION_IN_PROGRESS", + "stateChangedAt": 1458680170.096 + }, + { + "state": "COLLECTING_DATA", + "stateChangedAt": 1458680170.161 + }, + { + "state": "STOP_DATA_COLLECTION_PENDING", + "stateChangedAt": 1458680239.883 + }, + { + "state": "DATA_COLLECTED", + "stateChangedAt": 1458680299.847 + }, + { + "state": "EVALUATING_RULES", + "stateChangedAt": 1458680300.099 + }, + { + "state": "COMPLETED", + "stateChangedAt": 1458680301.4 + } + ], + "userAttributesForFindings": [] + } + ], + "failedItems": {} + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/describe-assessment-targets.rst b/aws/dist/awscli/examples/inspector/describe-assessment-targets.rst new file mode 100644 index 00000000..bfd1bc43 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-assessment-targets.rst @@ -0,0 +1,25 @@ +**To describe assessment targets** + +The following ``describe-assessment-targets`` command describes the assessment target with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq``:: + + aws inspector describe-assessment-targets --assessment-target-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq + +Output:: + + { + "assessmentTargets": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": 1458074191.459, + "name": "ExampleAssessmentTarget", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "updatedAt": 1458074191.459 + } + ], + "failedItems": {} + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/describe-assessment-templates.rst b/aws/dist/awscli/examples/inspector/describe-assessment-templates.rst new file mode 100644 index 00000000..c182e8de --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-assessment-templates.rst @@ -0,0 +1,29 @@ +**To describe assessment templates** + +The following ``describe-assessment-templates`` command describes the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw``:: + + aws inspector describe-assessment-templates --assessment-template-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw + +Output:: + + { + "assessmentTemplates": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": 1458074191.844, + "durationInSeconds": 3600, + "name": "ExampleAssessmentTemplate", + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "userAttributesForFindings": [] + } + ], + "failedItems": {} + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/describe-cross-account-access-role.rst b/aws/dist/awscli/examples/inspector/describe-cross-account-access-role.rst new file mode 100644 index 00000000..89e8ff9b --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-cross-account-access-role.rst @@ -0,0 +1,18 @@ +**To describe the cross account access role** + +The following ``describe-cross-account-access-role`` command describes the IAM role that enables Amazon Inspector to access your AWS account:: + + aws inspector describe-cross-account-access-role + +Output:: + + { + "registeredAt": 1458069182.826, + "roleArn": "arn:aws:iam::123456789012:role/inspector", + "valid": true + } + +For more information, see `Setting up Amazon Inspector`_ in the *Amazon Inspector* guide. + +.. _`Setting up Amazon Inspector`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_settingup.html + diff --git a/aws/dist/awscli/examples/inspector/describe-findings.rst b/aws/dist/awscli/examples/inspector/describe-findings.rst new file mode 100644 index 00000000..588e2294 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-findings.rst @@ -0,0 +1,44 @@ +**To describe findings** + +The following ``describe-findings`` command describes the finding with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4``:: + + aws inspector describe-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4 + +Output:: + + { + "failedItems": {}, + "findings": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "assetAttributes": { + "ipv4Addresses": [], + "schemaVersion": 1 + }, + "assetType": "ec2-instance", + "attributes": [], + "confidence": 10, + "createdAt": 1458680301.37, + "description": "Amazon Inspector did not find any potential security issues during this assessment.", + "indicatorOfCompromise": false, + "numericSeverity": 0, + "recommendation": "No remediation needed.", + "schemaVersion": 1, + "service": "Inspector", + "serviceAttributes": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", + "schemaVersion": 1 + }, + "severity": "Informational", + "title": "No potential security issues found", + "updatedAt": 1458680301.37, + "userAttributes": [] + } + ] + } + +For more information, see `Amazon Inspector Findings`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Findings`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_findings.html + diff --git a/aws/dist/awscli/examples/inspector/describe-resource-groups.rst b/aws/dist/awscli/examples/inspector/describe-resource-groups.rst new file mode 100644 index 00000000..3971ec5a --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-resource-groups.rst @@ -0,0 +1,28 @@ +**To describe resource groups** + +The following ``describe-resource-groups`` command describes the resource group with the ARN of ``arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI``:: + + aws inspector describe-resource-groups --resource-group-arns arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI + +Output:: + + { + "failedItems": {}, + "resourceGroups": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "createdAt": 1458074191.098, + "tags": [ + { + "key": "Name", + "value": "example" + } + ] + } + ] + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/describe-rules-packages.rst b/aws/dist/awscli/examples/inspector/describe-rules-packages.rst new file mode 100644 index 00000000..f08b0ccf --- /dev/null +++ b/aws/dist/awscli/examples/inspector/describe-rules-packages.rst @@ -0,0 +1,30 @@ +**To describe rules packages** + +The following ``describe-rules-packages`` command describes the rules package with the ARN of ``arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p``:: + + aws inspector describe-rules-packages --rules-package-arns arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p + +Output:: + + { + "failedItems": {}, + "rulesPackages": [ + { + "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", + "description": "The rules in this package help verify whether the EC2 instances in your application are exposed to Common Vulnerabilities and + Exposures (CVEs). Attacks can exploit unpatched vulnerabilities to compromise the confidentiality, integrity, or availability of your service + or data. The CVE system provides a reference for publicly known information security vulnerabilities and exposures. For more information, see + [https://cve.mitre.org/](https://cve.mitre.org/). If a particular CVE appears in one of the produced Findings at the end of a completed + Inspector assessment, you can search [https://cve.mitre.org/](https://cve.mitre.org/) using the CVE's ID (for example, \"CVE-2009-0021\") to + find detailed information about this CVE, its severity, and how to mitigate it. ", + "name": "Common Vulnerabilities and Exposures", + "provider": "Amazon Web Services, Inc.", + "version": "1.1" + } + ] + } + +For more information, see `Amazon Inspector Rules Packages and Rules`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Rules Packages and Rules`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_rule-packages.html + diff --git a/aws/dist/awscli/examples/inspector/get-telemetry-metadata.rst b/aws/dist/awscli/examples/inspector/get-telemetry-metadata.rst new file mode 100644 index 00000000..908665c2 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/get-telemetry-metadata.rst @@ -0,0 +1,158 @@ +**To get the telemetry metadata** + +The following ``get-telemetry-metadata`` command generates information about the data that is collected for the assessment run with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE``:: + + aws inspector get-telemetry-metadata --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE + +Output:: + + { + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + } + diff --git a/aws/dist/awscli/examples/inspector/list-assessment-run-agents.rst b/aws/dist/awscli/examples/inspector/list-assessment-run-agents.rst new file mode 100644 index 00000000..ba461623 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-assessment-run-agents.rst @@ -0,0 +1,168 @@ +**To list assessment run agents** + +The following ``list-assessment-run-agents`` command lists the agents of the assessment run with the specified ARN. :: + + aws inspector list-assessment-run-agents \ + --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE + +Output:: + + { + "assessmentRunAgents": [ + { + "agentHealth": "HEALTHY", + "agentHealthCode": "HEALTHY", + "agentId": "i-49113b93", + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + } + ] + } + +For more information, see `AWS Agents `_ in the *Amazon Inspector User Guide*. diff --git a/aws/dist/awscli/examples/inspector/list-assessment-runs.rst b/aws/dist/awscli/examples/inspector/list-assessment-runs.rst new file mode 100644 index 00000000..a2ee0c73 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-assessment-runs.rst @@ -0,0 +1,16 @@ +**To list assessment runs** + +The following ``list-assessment-runs`` command lists all existing assessment runs. :: + + aws inspector list-assessment-runs + +Output:: + + { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" + ] + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs `_ in the *Amazon Inspector User Guide*. diff --git a/aws/dist/awscli/examples/inspector/list-assessment-targets.rst b/aws/dist/awscli/examples/inspector/list-assessment-targets.rst new file mode 100644 index 00000000..ce44a590 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-assessment-targets.rst @@ -0,0 +1,18 @@ +**To list assessment targets** + +The following ``list-assessment-targets`` command lists all existing assessment targets:: + + aws inspector list-assessment-targets + +Output:: + + { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ] + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/list-assessment-templates.rst b/aws/dist/awscli/examples/inspector/list-assessment-templates.rst new file mode 100644 index 00000000..8f5160e4 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-assessment-templates.rst @@ -0,0 +1,19 @@ +**To list assessment templates** + +The following ``list-assessment-templates`` command lists all existing assessment templates:: + + aws inspector list-assessment-templates + +Output:: + + { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh" + ] + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/list-event-subscriptions.rst b/aws/dist/awscli/examples/inspector/list-event-subscriptions.rst new file mode 100644 index 00000000..ea6e0329 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-event-subscriptions.rst @@ -0,0 +1,27 @@ +**To list event subscriptions** + +The following ``list-event-subscriptions`` command lists all the event subscriptions for the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0``:: + + aws inspector list-event-subscriptions --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 + +Output:: + + { + "subscriptions": [ + { + "eventSubscriptions": [ + { + "event": "ASSESSMENT_RUN_COMPLETED", + "subscribedAt": 1459455440.867 + } + ], + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + } + ] + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/list-findings.rst b/aws/dist/awscli/examples/inspector/list-findings.rst new file mode 100644 index 00000000..47d5b99b --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-findings.rst @@ -0,0 +1,19 @@ +**To list findings** + +The following ``list-findings`` command lists all of the generated findings:: + + aws inspector list-findings + +Output:: + + { + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy" + ] + } + +For more information, see `Amazon Inspector Findings`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Findings`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_findings.html + diff --git a/aws/dist/awscli/examples/inspector/list-rules-packages.rst b/aws/dist/awscli/examples/inspector/list-rules-packages.rst new file mode 100644 index 00000000..2e21c8bc --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-rules-packages.rst @@ -0,0 +1,20 @@ +**To list rules packages** + +The following ``list-rules-packages`` command lists all available Inspector rules packages:: + + aws inspector list-rules-packages + +Output:: + + { + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD" + ] + } + +For more information, see `Amazon Inspector Rules Packages and Rules`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Rules Packages and Rules`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_rule-packages.html diff --git a/aws/dist/awscli/examples/inspector/list-tags-for-resource.rst b/aws/dist/awscli/examples/inspector/list-tags-for-resource.rst new file mode 100644 index 00000000..0edf83b7 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/list-tags-for-resource.rst @@ -0,0 +1,21 @@ +**To list tags for resource** + +The following ``list-tags-for-resource`` command lists all tags associated with the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu``:: + + aws inspector list-tags-for-resource --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu + +Output:: + + { + "tags": [ + { + "key": "Name", + "value": "Example" + } + ] + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/preview-agents.rst b/aws/dist/awscli/examples/inspector/preview-agents.rst new file mode 100644 index 00000000..17910f7a --- /dev/null +++ b/aws/dist/awscli/examples/inspector/preview-agents.rst @@ -0,0 +1,20 @@ +**To preview agents** + +The following ``preview-agents`` command previews the agents installed on the EC2 instances that are part of the assessment target with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq``:: + + aws inspector preview-agents --preview-agents-arn arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq + +Output:: + + { + "agentPreviews": [ + { + "agentId": "i-49113b93" + } + ] + } + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/inspector/register-cross-account-access-role.rst b/aws/dist/awscli/examples/inspector/register-cross-account-access-role.rst new file mode 100644 index 00000000..70647117 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/register-cross-account-access-role.rst @@ -0,0 +1,10 @@ +**To register the cross account access role** + +The following ``register-cross-account-access-role`` command registers the IAM role with the ARN of ``arn:aws:iam::123456789012:role/inspector`` that Amazon Inspector uses to list your EC2 instances at the start of the assessment run of when you call the preview-agents command:: + + aws inspector register-cross-account-access-role --role-arn arn:aws:iam::123456789012:role/inspector + +For more information, see `Setting up Amazon Inspector`_ in the *Amazon Inspector* guide. + +.. _`Setting up Amazon Inspector`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_settingup.html + diff --git a/aws/dist/awscli/examples/inspector/remove-attributes-from-findings.rst b/aws/dist/awscli/examples/inspector/remove-attributes-from-findings.rst new file mode 100644 index 00000000..80e87800 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/remove-attributes-from-findings.rst @@ -0,0 +1,16 @@ +**To remove attributes from findings** + +The following ``remove-attributes-from-finding`` command removes the attribute with the key of ``Example`` and value of ``example`` from the finding with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU``:: + + aws inspector remove-attributes-from-findings --finding-arns arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU --attribute-keys key=Example,value=example + +Output:: + + { + "failedItems": {} + } + +For more information, see `Amazon Inspector Findings`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Findings`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_findings.html + diff --git a/aws/dist/awscli/examples/inspector/set-tags-for-resource.rst b/aws/dist/awscli/examples/inspector/set-tags-for-resource.rst new file mode 100644 index 00000000..60746d29 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/set-tags-for-resource.rst @@ -0,0 +1,10 @@ +**To set tags for a resource** + +The following ``set-tags-for-resource`` command sets the tag with the key of ``Example`` and value of ``example`` to the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0``:: + + aws inspector set-tags-for-resource --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 --tags key=Example,value=example + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/start-assessment-run.rst b/aws/dist/awscli/examples/inspector/start-assessment-run.rst new file mode 100644 index 00000000..2de2c659 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/start-assessment-run.rst @@ -0,0 +1,16 @@ +**To start an assessment run** + +The following ``start-assessment-run`` command starts the assessment run named ``examplerun`` using the assessment template with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T``:: + + aws inspector start-assessment-run --assessment-run-name examplerun --assessment-template-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T + +Output:: + + { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY" + } + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/stop-assessment-run.rst b/aws/dist/awscli/examples/inspector/stop-assessment-run.rst new file mode 100644 index 00000000..79833c91 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/stop-assessment-run.rst @@ -0,0 +1,10 @@ +**To stop an assessment run** + +The following ``stop-assessment-run`` command stops the assessment run with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY``:: + + aws inspector stop-assessment-run --assessment-run-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/subscribe-to-event.rst b/aws/dist/awscli/examples/inspector/subscribe-to-event.rst new file mode 100644 index 00000000..d7a871c2 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/subscribe-to-event.rst @@ -0,0 +1,10 @@ +**To subscribe to an event** + +The following ``subscribe-to-event`` command enables the process of sending Amazon SNS notifications about the ``ASSESSMENT_RUN_COMPLETED`` event to the topic with the ARN of ``arn:aws:sns:us-west-2:123456789012:exampletopic``:: + + aws inspector subscribe-to-event --event ASSESSMENT_RUN_COMPLETED --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 --topic arn:aws:sns:us-west-2:123456789012:exampletopic + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/unsubscribe-from-event.rst b/aws/dist/awscli/examples/inspector/unsubscribe-from-event.rst new file mode 100644 index 00000000..46abd68d --- /dev/null +++ b/aws/dist/awscli/examples/inspector/unsubscribe-from-event.rst @@ -0,0 +1,10 @@ +**To unsubscribe from an event** + +The following ``unsubscribe-from-event`` command disables the process of sending Amazon SNS notifications about the ``ASSESSMENT_RUN_COMPLETED`` event to the topic with the ARN of ``arn:aws:sns:us-west-2:123456789012:exampletopic``:: + + aws inspector unsubscribe-from-event --event ASSESSMENT_RUN_COMPLETED --resource-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0 --topic arn:aws:sns:us-west-2:123456789012:exampletopic + +For more information, see `Amazon Inspector Assessment Templates and Assessment Runs`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Templates and Assessment Runs`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_assessments.html + diff --git a/aws/dist/awscli/examples/inspector/update-assessment-target.rst b/aws/dist/awscli/examples/inspector/update-assessment-target.rst new file mode 100644 index 00000000..d17b8bb8 --- /dev/null +++ b/aws/dist/awscli/examples/inspector/update-assessment-target.rst @@ -0,0 +1,10 @@ +**To update an assessment target** + +The following ``update-assessment-target`` command updates the assessment target with the ARN of ``arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX`` and the name of ``Example``, and the resource group with the ARN of ``arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt``:: + + aws inspector update-assessment-target --assessment-target-arn arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX --assessment-target-name Example --resource-group-arn arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt + +For more information, see `Amazon Inspector Assessment Targets`_ in the *Amazon Inspector* guide. + +.. _`Amazon Inspector Assessment Targets`: https://docs.aws.amazon.com/inspector/latest/userguide/inspector_applications.html + diff --git a/aws/dist/awscli/examples/iot-data/delete-thing-shadow.rst b/aws/dist/awscli/examples/iot-data/delete-thing-shadow.rst new file mode 100644 index 00000000..9e390de7 --- /dev/null +++ b/aws/dist/awscli/examples/iot-data/delete-thing-shadow.rst @@ -0,0 +1,14 @@ +**To delete a device's shadow document** + +The following ``delete-thing-shadow`` example deletes the entire shadow document for the device named ``MyRPi``. :: + + aws iot-data delete-thing-shadow \ + --thing-name MyRPi \ + "output.txt" + +The command produces no output on the display, but ``output.txt`` contains information that confirms the version and timestamp of the shadow document that you deleted. :: + + {"version":2,"timestamp":1560270384} + +For more information, see `Using Shadows `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot-data/get-thing-shadow.rst b/aws/dist/awscli/examples/iot-data/get-thing-shadow.rst new file mode 100644 index 00000000..cf7d1e31 --- /dev/null +++ b/aws/dist/awscli/examples/iot-data/get-thing-shadow.rst @@ -0,0 +1,27 @@ +**To get a thing shadow document** + +The following ``get-thing-shadow`` example gets the thing shadow document for the specified IoT thing. :: + + aws iot-data get-thing-shadow \ + --thing-name MyRPi \ + output.txt + +The command produces no output on the display, but the following shows the contents of ``output.txt``:: + + { + "state":{ + "reported":{ + "moisture":"low" + } + }, + "metadata":{ + "reported":{ + "moisture":{ + "timestamp":1560269319 + } + } + }, + "version":1,"timestamp":1560269405 + } + +For more information, see `Device Shadow Service Data Flow `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot-data/update-thing-shadow.rst b/aws/dist/awscli/examples/iot-data/update-thing-shadow.rst new file mode 100644 index 00000000..bc5ce690 --- /dev/null +++ b/aws/dist/awscli/examples/iot-data/update-thing-shadow.rst @@ -0,0 +1,29 @@ +**To update a thing shadow** + +The following ``update-thing-shadow`` example modifies the current state of the device shadow for the specified thing and saves it to the file ``output.txt``. :: + + aws iot-data update-thing-shadow \ + --thing-name MyRPi \ + --payload "{"state":{"reported":{"moisture":"okay"}}}" \ + "output.txt" + +The command produces no output on the display, but the following shows the contents of ``output.txt``:: + + { + "state": { + "reported": { + "moisture": "okay" + } + }, + "metadata": { + "reported": { + "moisture": { + "timestamp": 1560270036 + } + } + }, + "version": 2, + "timestamp": 1560270036 + } + +For more information, see `Device Shadow Service Data Flow `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot-jobs-data/describe-job-execution.rst b/aws/dist/awscli/examples/iot-jobs-data/describe-job-execution.rst new file mode 100644 index 00000000..3dd835ea --- /dev/null +++ b/aws/dist/awscli/examples/iot-jobs-data/describe-job-execution.rst @@ -0,0 +1,24 @@ +**To get the details of a job execution** + +The following ``describe-job-execution`` example retrieves the details of the latest execution of the specified job and thing. :: + + aws iot-jobs-data describe-job-execution \ + --job-id SampleJob \ + --thing-name MotionSensor1 + +Output:: + + { + "execution": { + "approximateSecondsBeforeTimedOut": 88, + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567701875.743, + "queuedAt": 1567701902.444, + "status": "QUEUED", + "thingName": "MotionSensor1 ", + "versionNumber": 3 + } + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot-jobs-data/get-pending-job-executions.rst b/aws/dist/awscli/examples/iot-jobs-data/get-pending-job-executions.rst new file mode 100644 index 00000000..9b306593 --- /dev/null +++ b/aws/dist/awscli/examples/iot-jobs-data/get-pending-job-executions.rst @@ -0,0 +1,24 @@ +**To get a list of all jobs that are not in a terminal status for a thing** + +The following ``get-pending-job-executions`` example displays a list of all jobs that aren't in a terminal state for the specified thing. :: + + aws iot-jobs-data get-pending-job-executions \ + --thing-name MotionSensor1 + +Output:: + + { + "inProgressJobs": [ + ], + "queuedJobs": [ + { + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567701875.743, + "queuedAt": 1567701902.444, + "versionNumber": 3 + } + ] + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst b/aws/dist/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst new file mode 100644 index 00000000..70e82909 --- /dev/null +++ b/aws/dist/awscli/examples/iot-jobs-data/start-next-pending-job-execution.rst @@ -0,0 +1,25 @@ +**To get and start the next pending job execution for a thing** + +The following ``start-next-pending-job-execution`` example retrieves and starts the next job execution whose status is `IN_PROGRESS` or `QUEUED` for the specified thing. :: + + aws iot-jobs-data start-next-pending-job-execution \ + --thing-name MotionSensor1 + +This command produces no output. +Output:: + + { + "execution": { + "approximateSecondsBeforeTimedOut": 88, + "executionNumber": 2939653338, + "jobId": "SampleJob", + "lastUpdatedAt": 1567714853.743, + "queuedAt": 1567701902.444, + "startedAt": 1567714871.690, + "status": "IN_PROGRESS", + "thingName": "MotionSensor1 ", + "versionNumber": 3 + } + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot-jobs-data/update-job-execution.rst b/aws/dist/awscli/examples/iot-jobs-data/update-job-execution.rst new file mode 100644 index 00000000..c5455609 --- /dev/null +++ b/aws/dist/awscli/examples/iot-jobs-data/update-job-execution.rst @@ -0,0 +1,20 @@ +**To update the status of a job execution** + +The following ``update-job-execution`` example updates the status of the specified job and thing. :: + + aws iot-jobs-data update-job-execution \ + --job-id SampleJob \ + --thing-name MotionSensor1 \ + --status REMOVED + +This command produces no output. +Output:: + + { + "executionState": { + "status": "REMOVED", + "versionNumber": 3 + }, + } + +For more information, see `Devices and Jobs `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/add-thing-to-billing-group.rst b/aws/dist/awscli/examples/iot/add-thing-to-billing-group.rst new file mode 100644 index 00000000..de298432 --- /dev/null +++ b/aws/dist/awscli/examples/iot/add-thing-to-billing-group.rst @@ -0,0 +1,21 @@ +**Example 1: To add a thing by name to a billing group** + +The following ``add-thing-to-billing-group`` example adds the thing named ``MyLightBulb`` to the billing group named ``GroupOne``. :: + + aws iot add-thing-to-billing-group \ + --billing-group-name GroupOne \ + --thing-name MyLightBulb + +This command produces no output. + +**Example 2: To add a thing by ARN to a billing group** + +The following ``add-thing-to-billing-group`` example adds a thing with a specified ARN to a billing group with the specified ARN. Specifying an ARN is helpful if you work with multiple AWS Regions or accounts. It can help ensure that you are adding to the right Region and account. :: + + aws iot add-thing-to-thing-group \ + --billing-group-arn "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" \ + --thing-arn "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb" + +This command produces no output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/add-thing-to-thing-group.rst b/aws/dist/awscli/examples/iot/add-thing-to-thing-group.rst new file mode 100644 index 00000000..441b67b9 --- /dev/null +++ b/aws/dist/awscli/examples/iot/add-thing-to-thing-group.rst @@ -0,0 +1,12 @@ +**To add a thing to a group** + +The following ``add-thing-to-thing-group`` example adds the specified thing to the specified thing group. :: + + aws iot add-thing-to-thing-group \ + --thing-name MyLightBulb \ + --thing-group-name LightBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/associate-targets-with-job.rst b/aws/dist/awscli/examples/iot/associate-targets-with-job.rst new file mode 100644 index 00000000..f1fa1287 --- /dev/null +++ b/aws/dist/awscli/examples/iot/associate-targets-with-job.rst @@ -0,0 +1,17 @@ +**To associate a thing group with a continuous job** + +The following ``associate-targets-with-job`` example associates the specified thing group with the specified continuous job. :: + + aws iot associate-targets-with-job \ + --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --job-id "example-job-04" + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", + "jobId": "example-job-04", + "description": "example continuous job" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/attach-policy.rst b/aws/dist/awscli/examples/iot/attach-policy.rst new file mode 100644 index 00000000..710c438a --- /dev/null +++ b/aws/dist/awscli/examples/iot/attach-policy.rst @@ -0,0 +1,23 @@ +**Example 1: To attach a policy to a thing group** + +The following ``attach-policy`` example attaches the specified policy to a thing group identified by its ARN. :: + + aws iot attach-policy \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --policy-name "UpdateDeviceCertPolicy" + +This command does not produce any output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To attach a policy to a certificate** + +The following ``attach-policy`` example attaches the policy ``UpdateDeviceCertPolicy`` to the principal specified by a certificate. :: + + aws iot attach-policy \ + --policy-name UpdateDeviceCertPolicy \ + --target "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" + +This command does not produce any output. + +For more information, see `Attach an AWS IoT Policy to a Device Certificate `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/attach-security-profile.rst b/aws/dist/awscli/examples/iot/attach-security-profile.rst new file mode 100644 index 00000000..4e2f22c2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/attach-security-profile.rst @@ -0,0 +1,11 @@ +**To associate a security profile with all unregistered devices** + +The following ``attach-security-profile`` example associates the AWS IoT Device Defender security profile named ``Testprofile`` with all unregistered devices in the ``us-west-2`` region for this AWS account. :: + + aws iot attach-security-profile \ + --security-profile-name Testprofile \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/attach-thing-principal.rst b/aws/dist/awscli/examples/iot/attach-thing-principal.rst new file mode 100644 index 00000000..512ee2be --- /dev/null +++ b/aws/dist/awscli/examples/iot/attach-thing-principal.rst @@ -0,0 +1,11 @@ +**To attach a certificate to your thing** + +The following ``attach-thing-principal`` example attaches a certificate to the MyTemperatureSensor thing. The certificate is identified by an ARN. You can find the ARN for a certificate in the AWS IoT console. :: + + aws iot attach-thing-principal \ + --thing-name MyTemperatureSensor \ + --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/cancel-audit-task.rst b/aws/dist/awscli/examples/iot/cancel-audit-task.rst new file mode 100644 index 00000000..f60678cc --- /dev/null +++ b/aws/dist/awscli/examples/iot/cancel-audit-task.rst @@ -0,0 +1,10 @@ +**To cancel an audit task** + +The following ``cancel-audit-task`` example cancels an audit task with the specified task ID. You cannot cancel a task that is complete. :: + + aws iot cancel-audit-task \ + --task-id a3aea009955e501a31b764abe1bebd3d + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/cancel-certificate-transfer.rst b/aws/dist/awscli/examples/iot/cancel-certificate-transfer.rst new file mode 100644 index 00000000..baf0b516 --- /dev/null +++ b/aws/dist/awscli/examples/iot/cancel-certificate-transfer.rst @@ -0,0 +1,10 @@ +**To cancel the transfer a certificate to a different AWS account** + +The following ``cancel-certificate-transfer`` example cancels the transfer of the specified certificate transfer. The certificate is identified by a certificate ID. You can find the ID for a certificate in the AWS IoT console. :: + + aws iot cancel-certificate-transfer \ + --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 + +This command produces no output. + +For more information, see `CancelCertificateTransfer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/cancel-job-execution.rst b/aws/dist/awscli/examples/iot/cancel-job-execution.rst new file mode 100644 index 00000000..a99401b2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/cancel-job-execution.rst @@ -0,0 +1,11 @@ +**To cancel a job execution on a device** + +The following ``cancel-job-execution`` example cancels the execution of the specified job on a device. If the job is not in the ``QUEUED`` state, you must add the ``--force`` parameter. :: + + aws iot cancel-job-execution \ + --job-id "example-job-03" \ + --thing-name "MyRPi" + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/cancel-job.rst b/aws/dist/awscli/examples/iot/cancel-job.rst new file mode 100644 index 00000000..aab8c166 --- /dev/null +++ b/aws/dist/awscli/examples/iot/cancel-job.rst @@ -0,0 +1,16 @@ +**To cancel a job** + +The following ``cancel-job`` example cancels the specified job. :: + + aws iot cancel-job \ + --job-job "example-job-03" + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-03", + "jobId": "example-job-03", + "description": "example job test" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/clear-default-authorizer.rst b/aws/dist/awscli/examples/iot/clear-default-authorizer.rst new file mode 100644 index 00000000..c2e3e122 --- /dev/null +++ b/aws/dist/awscli/examples/iot/clear-default-authorizer.rst @@ -0,0 +1,9 @@ +**To clear the default authorizer** + +The following ``clear-default-authorizer`` example clears the currently configured default custom authorizer. After you run this command, there is no default authorizer. When you use a custom authorizer, you must specify it by name in the HTTP request headers. :: + + aws iot clear-default-authorizer + +This command produces no output. + +For more information, see `ClearDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-authorizer.rst b/aws/dist/awscli/examples/iot/create-authorizer.rst new file mode 100644 index 00000000..22b974b5 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-authorizer.rst @@ -0,0 +1,27 @@ +**To create a custom authorizer** + +The following ``create-authorizer`` example creates a custom authorizer that uses the specified Lambda function as part of a custom authentication service. :: + + aws iot create-authorizer \ + --authorizer-name "CustomAuthorizer" \ + --authorizer-function-arn "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction" \ + --token-key-name "MyAuthToken" \ + --status ACTIVE \ + --token-signing-public-keys FIRST_KEY="-----BEGIN PUBLIC KEY----- + MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo + Z+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y + ZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p + zwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ + +GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx + 50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1 + lQIDAQAB + -----END PUBLIC KEY-----" + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + } + +For more information, see `CreateAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-billing-group.rst b/aws/dist/awscli/examples/iot/create-billing-group.rst new file mode 100644 index 00000000..4184d7dd --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-billing-group.rst @@ -0,0 +1,16 @@ +**To create a billing group** + +The following ``create-billing-group`` example creates a simple billing group named ``GroupOne``. :: + + aws iot create-billing-group \ + --billing-group-name GroupOne + +Output:: + + { + "billingGroupName": "GroupOne", + "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", + "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562" + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-certificate-from-csr.rst b/aws/dist/awscli/examples/iot/create-certificate-from-csr.rst new file mode 100644 index 00000000..611d8e4a --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-certificate-from-csr.rst @@ -0,0 +1,16 @@ +**To create a device certificate from a certificate signing request (CSR)** + +The following ``create-certificate-from-csr`` example creates a device certificate from a CSR. You can use the ``openssl`` command to create a CSR. :: + + aws iot create-certificate-from-csr \ + --certificate-signing-request=file://certificate.csr + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", + "certificateId": "c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9", + "certificatePem": "" + } + +For more information, see `CreateCertificateFromCSR `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-dynamic-thing-group.rst b/aws/dist/awscli/examples/iot/create-dynamic-thing-group.rst new file mode 100644 index 00000000..9ac838ad --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-dynamic-thing-group.rst @@ -0,0 +1,21 @@ +**To create a dynamic thing group** + +The following ``create-dynamic-thing-group`` example creates a dynamic thing group that contains any thing with a temperature attribute that is greater than 60 degrees. You must enable AWS IoT fleet indexing before you can use dynamic thing groups. :: + + aws iot create-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" \ + --query-string "attributes.temperature>60" + +Output:: + + { + "thingGroupName": "RoomTooWarm", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/RoomTooWarm", + "thingGroupId": "9d52492a-fc87-43f4-b6e2-e571d2ffcad1", + "indexName": "AWS_Things", + "queryString": "attributes.temperature>60", + "queryVersion": "2017-09-30" + } + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/create-job.rst b/aws/dist/awscli/examples/iot/create-job.rst new file mode 100644 index 00000000..8c3ac767 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-job.rst @@ -0,0 +1,38 @@ +**Example 1: To create a job** + +The following ``create-job`` example creates a simple AWS IoT job that sends a JSON document to the ``MyRaspberryPi`` device. :: + + aws iot create-job \ + --job-id "example-job-01" \ + --targets "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" \ + --document file://example-job.json \ + --description "example job test" \ + --target-selection SNAPSHOT + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "description": "example job test" + } + +**Example 2: To create a continuous job** + +The following ``create-job`` example creates a job that continues to run after the things specified as targets have completed the job. In this example, the target is a thing group, so when new devices are added to the group, the continuous job runs on those new things. + + aws iot create-job \ + --job-id "example-job-04" \ + --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" \ + --document file://example-job.json --description "example continuous job" \ + --target-selection CONTINUOUS + +Output:: + + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04", + "jobId": "example-job-04", + "description": "example continuous job" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/create-keys-and-certificate.rst b/aws/dist/awscli/examples/iot/create-keys-and-certificate.rst new file mode 100644 index 00000000..58b4d304 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-keys-and-certificate.rst @@ -0,0 +1,38 @@ +**To create an RSA key pair and issue an X.509 certificate** + +The following ``create-keys-and-certificate`` creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key. Because this is the only time that AWS IoT provides the private key for this certificate, be sure to keep it in a secure location. :: + + aws iot create-keys-and-certificate \ + --certificate-pem-outfile "myTest.cert.pem" \ + --public-key-outfile "myTest.public.key" \ + --private-key-outfile "myTest.private.key" + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", + "certificateId": "9894ba17925e663f1d29c23af4582b8e3b7619c31f3fbd93adcb51ae54b83dc2", + "certificatePem": " + -----BEGIN CERTIFICATE----- + MIICiTCCEXAMPLE6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBAgEXAMPLEAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSEXAMPLE2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYEXAMPLEb20wHhcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCEXAMPLEJBgNVBAgTAldBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDAEXAMPLEsTC0lBTSBDb25z + b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEXAMPLE25lQGFt + YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+aEXAMPLE + EXAMPLEfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZEXAMPLELG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE + Ibb3OhjZnzcvQAEXAMPLEWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 + nUhVVxYUntneD9+h8Mg9qEXAMPLEyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GuoEDEXAMPLEBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----\n", + "keyPair": { + "PublicKey": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkEXAMPLEQEFAAOCAQ8AMIIBCgKCAQEAEXAMPLE1nnyJwKSMHw4h\nMMEXAMPLEuuN/dMAS3fyce8DW/4+EXAMPLEyjmoF/YVF/gHr99VEEXAMPLE5VF13\n59VK7cEXAMPLE67GK+y+jikqXOgHh/xJTwo+sGpWEXAMPLEDz18xOd2ka4tCzuWEXAMPLEahJbYkCPUBSU8opVkR7qkEXAMPLE1DR6sx2HocliOOLtu6Fkw91swQWEXAMPLE\GB3ZPrNh0PzQYvjUStZeccyNCx2EXAMPLEvp9mQOUXP6plfgxwKRX2fEXAMPLEDa\nhJLXkX3rHU2xbxJSq7D+XEXAMPLEcw+LyFhI5mgFRl88eGdsAEXAMPLElnI9EesG\nFQIDAQAB\n-----END PUBLIC KEY-----\n", + "PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nkey omittted for security reasons\n-----END RSA PRIVATE KEY-----\n" + } + } + +For more infomration, see `Create and Register an AWS IoT Device Certificate `__ in the **AWS IoT Developer Guide**. diff --git a/aws/dist/awscli/examples/iot/create-ota-update.rst b/aws/dist/awscli/examples/iot/create-ota-update.rst new file mode 100644 index 00000000..971e6e0e --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-ota-update.rst @@ -0,0 +1,50 @@ +**To create an OTA update for use with Amazon FreeRTOS** + +The following ``create-ota-update`` example creates an AWS IoT OTAUpdate on a target group of things or groups. This is part of an Amazon FreeRTOS over-the-air update which makes it possible for you to deploy new firmware images to a single device or a group of devices. :: + + aws iot create-ota-update \ + --cli-input-json file://create-ota-update.json + +Contents of ``create-ota-update.json``:: + + { + "otaUpdateId": "ota12345", + "description": "A critical update needed right away.", + "targets": [ + "device1", + "device2", + "device3", + "device4" + ], + "targetSelection": "SNAPSHOT", + "awsJobExecutionsRolloutConfig": { + "maximumPerMinute": 10 + }, + "files": [ + { + "fileName": "firmware.bin", + "fileLocation": { + "stream": { + "streamId": "004", + "fileId":123 + } + }, + "codeSigning": { + "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" + } + +Output:: + + { + "otaUpdateId": "ota12345", + "awsIotJobId": "job54321", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/itsajob", + "otaUpdateStatus": "CREATE_IN_PROGRESS" + } + +For more information, see `CreateOTAUpdate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-policy-version.rst b/aws/dist/awscli/examples/iot/create-policy-version.rst new file mode 100644 index 00000000..45b31d56 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-policy-version.rst @@ -0,0 +1,32 @@ +**To update a policy with a new version** + +The following ``create-policy-version`` example updates a policy definition, creating a new policy version. This example also makes the new version the default. :: + + aws iot create-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-document file://policy.json \ + --set-as-default + +Contents of ``policy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": "iot:UpdateCertificate", + "Resource": "*" + } + ] + } + +Output:: + + { + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "policyVersionId": "2", + "isDefaultVersion": true + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-policy.rst b/aws/dist/awscli/examples/iot/create-policy.rst new file mode 100644 index 00000000..a4389bc7 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-policy.rst @@ -0,0 +1,90 @@ +**To create an AWS IoT policy** + +The following ``create-policy`` example creates an AWS IoT policy named TemperatureSensorPolicy. The ``policy.json`` file contains statements that allow AWS IoT policy actions. :: + + aws iot create-policy \ + --policy-name TemperatureSensorPolicy \ + --policy-document file://policy.json + +Contents of ``policy.json``:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": [ + "iot:Publish", + "iot:Receive" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:topic/topic_1", + "arn:aws:iot:us-west-2:123456789012:topic/topic_2" + ] + }, + { + "Effect": "Allow", + "Action": [ + "iot:Subscribe" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1", + "arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2" + ] + }, + { + "Effect": "Allow", + "Action": [ + "iot:Connect" + ], + "Resource": [ + "arn:aws:iot:us-west-2:123456789012:client/basicPubSub" + ] + } + ] + } + +Output:: + + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", + "policyDocument": "{ + \"Version\": \"2012-10-17\", + \"Statement\": [ + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Publish\", + \"iot:Receive\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Subscribe\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Connect\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" + ] + } + ] + }", + "policyVersionId": "1" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-role-alias.rst b/aws/dist/awscli/examples/iot/create-role-alias.rst new file mode 100644 index 00000000..37ffc41c --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-role-alias.rst @@ -0,0 +1,16 @@ +**To create a role alias** + +The following ``create-role-alias`` example creates a role alias called ``LightBulbRole`` for the specified role. :: + + aws iot create-role-alias \ + --role-alias LightBulbRole \ + --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 + +Output:: + + { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" + } + +For more information, see `CreateRoleAlias `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-scheduled-audit.rst b/aws/dist/awscli/examples/iot/create-scheduled-audit.rst new file mode 100644 index 00000000..4c9062de --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-scheduled-audit.rst @@ -0,0 +1,17 @@ +**To create a scheduled audit** + +The following ``create-scheduled-audit`` example creates a scheduled audit that runs weekly, on Wednesday, to check if CA certificates or device certificates are expiring. :: + + aws iot create-scheduled-audit \ + --scheduled-audit-name WednesdayCertCheck \ + --frequency WEEKLY \ + --day-of-week WED \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK + +Output:: + + { + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/create-security-profile.rst b/aws/dist/awscli/examples/iot/create-security-profile.rst new file mode 100644 index 00000000..ffaefb05 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-security-profile.rst @@ -0,0 +1,17 @@ +**To create a security profile** + +The following ``create-security-profile`` example creates a security profile that checks if cellular bandwidth exceeds a threshold or if more than 10 authorization failures occur within a five-minute period. :: + + aws iot create-security-profile \ + --security-profile-name PossibleIssue \ + --security-profile-description "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128" \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":10},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue" + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/create-stream.rst b/aws/dist/awscli/examples/iot/create-stream.rst new file mode 100644 index 00000000..107f9f42 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-stream.rst @@ -0,0 +1,34 @@ +**To create a stream for delivering one or more large files in chunks over MQTT** + +The following ``create-stream`` example creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. :: + + aws iot create-stream \ + --cli-input-json file://create-stream.json + +Contents of ``create-stream.json``:: + + { + "streamId": "stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": 123, + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" + } + +Output:: + + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "streamVersion": "1" + } + +For more information, see `CreateStream `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/create-thing-group.rst b/aws/dist/awscli/examples/iot/create-thing-group.rst new file mode 100644 index 00000000..9200a89f --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-thing-group.rst @@ -0,0 +1,33 @@ +**Example 1: To create a thing group** + +The following ``create-thing-group`` example creates a thing group named ``LightBulbs`` with a description and two attributes. :: + + aws iot create-thing-group \ + --thing-group-name LightBulbs \ + --thing-group-properties "thingGroupDescription=\"Generic bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" + +Output:: + + { + "thingGroupName": "LightBulbs", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs", + "thingGroupId": "9198bf9f-1e76-4a88-8e8c-e7140142c331" + } + +**Example 2: To create a thing group that's part of a parent group** + +The following ``create-thing-group`` creates a thing group named ``HalogenBulbs`` that has a parent thing group named ``LightBulbs``. :: + + aws iot create-thing-group \ + --thing-group-name HalogenBulbs \ + --parent-group-name LightBulbs + +Output:: + + { + "thingGroupName": "HalogenBulbs", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", + "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e" + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-thing-type.rst b/aws/dist/awscli/examples/iot/create-thing-type.rst new file mode 100644 index 00000000..4a644d73 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-thing-type.rst @@ -0,0 +1,17 @@ +**To define a thing type** + +The following ``create-thing-type`` example defines a thing type and associated attributes. :: + + aws iot create-thing-type \ + --thing-type-name "LightBulb" \ + --thing-type-properties "thingTypeDescription=light bulb type, searchableAttributes=wattage,model" + +Output:: + + { + "thingTypeName": "LightBulb", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190" + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-thing.rst b/aws/dist/awscli/examples/iot/create-thing.rst new file mode 100644 index 00000000..4469bf10 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-thing.rst @@ -0,0 +1,33 @@ +**Example 1: To create a thing record in the registry** + +The following ``create-thing`` example creates an entry for a device in the AWS IoT thing registry. :: + + aws iot create-thing \ + --thing-name SampleIoTThing + +Output:: + + { + "thingName": "SampleIoTThing", + "thingArn": "arn:aws:iot:us-west-2: 123456789012:thing/SampleIoTThing", + "thingId": " EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE " + } + +**Example 2: To define a thing that is associated with a thing type** + +The following ``create-thing`` example create a thing that has the specified thing type and its attributes. :: + + aws iot create-thing \ + --thing-name "MyLightBulb" \ + --thing-type-name "LightBulb" \ + --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" + +Output:: + + { + "thingName": "MyLightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797" + } + +For more information, see `How to Manage Things with the Registry `__ and `Thing Types `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/create-topic-rule.rst b/aws/dist/awscli/examples/iot/create-topic-rule.rst new file mode 100644 index 00000000..475bccd9 --- /dev/null +++ b/aws/dist/awscli/examples/iot/create-topic-rule.rst @@ -0,0 +1,28 @@ +**To create a rule that sends an Amazon SNS alert** + +The following ``create-topic-rule`` example creates a rule that sends an Amazon SNS message when soil moisture level readings, as found in a device shadow, are low. :: + + aws iot create-topic-rule \ + --rule-name "LowMoistureRule" \ + --topic-rule-payload file://plant-rule.json + +The example requires the following JSON code to be saved to a file named ``plant-rule.json``:: + + { + "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n", + "description": "Sends an alert whenever soil moisture level readings are too low.", + "ruleDisabled": false, + "awsIotSqlVersion": "2016-03-23", + "actions": [{ + "sns": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", + "messageFormat": "RAW" + } + }] + } + +This command produces no output. + +For more information, see `Creating an AWS IoT Rule `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/delete-account-audit-configuration.rst b/aws/dist/awscli/examples/iot/delete-account-audit-configuration.rst new file mode 100644 index 00000000..cafe5b57 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-account-audit-configuration.rst @@ -0,0 +1,10 @@ +**To disable all audit checks for your AWS account** + +The following ``delete-account-audit-configuration`` example restores the default settings for AWS IoT Device Defender for this account, disabling all audit checks and clearing configuration data. It also deletes any scheduled audits for this account. **Use this command with caution.** :: + + aws iot delete-account-audit-configuration \ + --delete-scheduled-audits + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-authorizer.rst b/aws/dist/awscli/examples/iot/delete-authorizer.rst new file mode 100644 index 00000000..ea59d53b --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-authorizer.rst @@ -0,0 +1,10 @@ +**To delete a custom authorizer** + +The following ``delete-authorizer`` example deletes the authorizer named ``CustomAuthorizer``. A custom authorizer must be in the ``INACTIVE`` state before you can delete it. :: + + aws iot delete-authorizer \ + --authorizer-name CustomAuthorizer + +This command produces no output. + +For more information, see `DeleteAuthorizer `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-billing-group.rst b/aws/dist/awscli/examples/iot/delete-billing-group.rst new file mode 100644 index 00000000..25aac126 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-billing-group.rst @@ -0,0 +1,11 @@ +**To delete a billing group** + +The following ``delete-billing-group`` example deletes the specified billing group. You can delete a billing group even if it contains one or more things. :: + + aws iot delete-billing-group \ + --billing-group-name BillingGroupTwo + +This command does not produce any output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/delete-ca-certificate.rst b/aws/dist/awscli/examples/iot/delete-ca-certificate.rst new file mode 100644 index 00000000..06861351 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-ca-certificate.rst @@ -0,0 +1,10 @@ +**To delete a CA certificate** + +The following ``delete-ca-certificate`` example deletes the CA certificate with the specified certificate ID. :: + + aws iot delete-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +This command produces no output. + +For more information, see `DeleteCACertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/delete-certificate.rst b/aws/dist/awscli/examples/iot/delete-certificate.rst new file mode 100644 index 00000000..a5dfeb0d --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-certificate.rst @@ -0,0 +1,10 @@ +**To delete a device certificate** + +The following ``delete-certificate`` example deletes the device certificate with the specified ID. :: + + aws iot delete-certificate \ + --certificate-id c0c57bbc8baaf4631a9a0345c957657f5e710473e3ddbee1428d216d54d53ac9 + +This command produces no output. + +For more information, see `DeleteCertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/delete-dynamic-thing-group.rst b/aws/dist/awscli/examples/iot/delete-dynamic-thing-group.rst new file mode 100644 index 00000000..41fc2344 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-dynamic-thing-group.rst @@ -0,0 +1,10 @@ +**To delete a dynamic thing group** + +The following ``delete-dynamic-thing-group`` example deletes the specified dynamic thing group. :: + + aws iot delete-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" + +This command produces no output. + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-job-execution.rst b/aws/dist/awscli/examples/iot/delete-job-execution.rst new file mode 100644 index 00000000..3d3cb1c6 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-job-execution.rst @@ -0,0 +1,12 @@ +**To delete a job execution** + +The following ``delete-job-execution`` example deletes the job execution of the specified job on a device. Use ``describe-job-execution`` to get the execution number. :: + + aws iot delete-job-execution + --job-id "example-job-02" + --thing-name "MyRaspberryPi" + --execution-number 1 + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-job.rst b/aws/dist/awscli/examples/iot/delete-job.rst new file mode 100644 index 00000000..07eb3c95 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-job.rst @@ -0,0 +1,11 @@ +**To delete a job** + +The following ``delete-job`` example deletes the specified job. By specifying the ``--force`` option, the job is deleted even if the status is ``IN_PROGRESS``. :: + + aws iot delete-job \ + --job-id "example-job-04" \ + --force + +This command produces no output. + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-ota-update.rst b/aws/dist/awscli/examples/iot/delete-ota-update.rst new file mode 100644 index 00000000..5df1162e --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-ota-update.rst @@ -0,0 +1,12 @@ +**To delete an OTA update** + +The following ``delete-ota-update`` example deletes the specified OTA update. :: + + aws iot delete-ota-update \ + --ota-update-id ota12345 \ + --delete-stream \ + --force-delete-aws-job + +This command produces no output. + +For more information, see `DeleteOTAUpdate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/delete-policy-version.rst b/aws/dist/awscli/examples/iot/delete-policy-version.rst new file mode 100644 index 00000000..e2aefae5 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-policy-version.rst @@ -0,0 +1,11 @@ +**To delete a version of policy** + +The following ``delete-policy-version`` example deletes version 2 of the specified policy from your AWS account. :: + + aws iot delete-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-version-id 2 + +This command produces no output. + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-policy.rst b/aws/dist/awscli/examples/iot/delete-policy.rst new file mode 100644 index 00000000..ec4b9c8c --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-policy.rst @@ -0,0 +1,9 @@ +**To delete a policy** + +The following ``delete-policy`` example deletes the specified policy from your AWS account. :: + + aws iot delete-policy --policy-name UpdateDeviceCertPolicy + +This command produces no output. + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-registration-code.rst b/aws/dist/awscli/examples/iot/delete-registration-code.rst new file mode 100644 index 00000000..491d507c --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-registration-code.rst @@ -0,0 +1,9 @@ +**To delete your registration cod** + +The following ``delete-registration-code`` example deletes an AWS IoT account-specific registration code. :: + + aws iot delete-registration-code + +This command produces no output. + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-role-alias.rst b/aws/dist/awscli/examples/iot/delete-role-alias.rst new file mode 100644 index 00000000..d0220334 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-role-alias.rst @@ -0,0 +1,10 @@ +**To delete an AWS IoT role alias** + +The following ``delete-role-alias`` example deletes an AWS IoT role alias named ``LightBulbRole``. :: + + aws iot delete-role-alias \ + --role-alias LightBulbRole + +This command produces no output. + +For more information, see `Authorizing Direct Calls to AWS Services `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-scheduled-audit.rst b/aws/dist/awscli/examples/iot/delete-scheduled-audit.rst new file mode 100644 index 00000000..0b6d9c07 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-scheduled-audit.rst @@ -0,0 +1,10 @@ +**To delete a scheduled audit** + +The following ``delete-scheduled-audit`` example deletes the AWS IoT Device Defender scheduled audit named ``AWSIoTDeviceDefenderDailyAudit``. :: + + aws iot delete-scheduled-audit \ + --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-security-profile.rst b/aws/dist/awscli/examples/iot/delete-security-profile.rst new file mode 100644 index 00000000..c051ef2f --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-security-profile.rst @@ -0,0 +1,10 @@ +**To delete a security profile** + +The following ``delete-security-profile`` example deletes a security profile named ``PossibleIssue``. :: + + aws iot delete-security-profile \ + --security-profile-name PossibleIssue + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-stream.rst b/aws/dist/awscli/examples/iot/delete-stream.rst new file mode 100644 index 00000000..fe53ac1f --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-stream.rst @@ -0,0 +1,10 @@ +**To delete a stream** + +The following ``delete-stream`` example deletes the specified stream. :: + + aws iot delete-stream \ + --stream-id stream12345 + +This command produces no output. + +For more information, see `DeleteStream `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/delete-thing-group.rst b/aws/dist/awscli/examples/iot/delete-thing-group.rst new file mode 100644 index 00000000..936cb703 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-thing-group.rst @@ -0,0 +1,10 @@ +**To delete a thing group** + +The following ``delete-thing-group`` example deletes the specified thing group. You cannot delete a thing group if it contains things. :: + + aws iot delete-thing-group \ + --thing-group-name DefectiveBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-thing-type.rst b/aws/dist/awscli/examples/iot/delete-thing-type.rst new file mode 100644 index 00000000..1e56f6d8 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-thing-type.rst @@ -0,0 +1,11 @@ +**Example 1: To delete a thing type** + +The following ``delete-thing-type`` example deletes a deprecated thing type. :: + + aws iot delete-thing-type \ + --thing-type-name "obsoleteThingType" + +This command produces no output. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/delete-thing.rst b/aws/dist/awscli/examples/iot/delete-thing.rst new file mode 100644 index 00000000..04668cd1 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-thing.rst @@ -0,0 +1,9 @@ +**To display detailed information about a thing** + +The following ``delete-thing`` example deletes a thing from the AWS IoT registry for your AWS account. + + aws iot delete-thing --thing-name "FourthBulb" + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/delete-topic-rule.rst b/aws/dist/awscli/examples/iot/delete-topic-rule.rst new file mode 100644 index 00000000..ccac8c91 --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-topic-rule.rst @@ -0,0 +1,11 @@ +**To delete a rule** + +The following ``delete-topic-rule`` example deletes the specified rule. :: + + aws iot delete-topic-rule \ + --rule-name "LowMoistureRule" + +This command produces no output. + +For more information, see `Deleting a Rule `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/delete-v2-logging-level.rst b/aws/dist/awscli/examples/iot/delete-v2-logging-level.rst new file mode 100644 index 00000000..c8dd279c --- /dev/null +++ b/aws/dist/awscli/examples/iot/delete-v2-logging-level.rst @@ -0,0 +1,9 @@ +**To delete the logging level for a thing group** + +The following ``delete-v2-logging-level`` example deletes the logging level for the specified thing group. :: + + aws iot delete-v2-logging-level \ + --target-type THING_GROUP \ + --target-name LightBulbs + +This command produces no output. diff --git a/aws/dist/awscli/examples/iot/deprecate-thing-type.rst b/aws/dist/awscli/examples/iot/deprecate-thing-type.rst new file mode 100644 index 00000000..333f5f5e --- /dev/null +++ b/aws/dist/awscli/examples/iot/deprecate-thing-type.rst @@ -0,0 +1,21 @@ +**Example 1: To deprecate a thing type** + +The following ``deprecate-thing-type`` example deprecates a thing type so that users can't associate any new things with it. :: + + aws iot deprecate-thing-type \ + --thing-type-name "obsoleteThingType" + +This command produces no output. + +**Example 2: To reverse the deprecation of a thing type** + +The following ``deprecate-thing-type`` example reverses the deprecation of a thing type, which makes it possible for users to associate new things with it again. :: + + aws iot deprecate-thing-type \ + --thing-type-name "obsoleteThingType" \ + --undo-deprecate + +This command produces no output. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/describe-account-audit-configuration.rst b/aws/dist/awscli/examples/iot/describe-account-audit-configuration.rst new file mode 100644 index 00000000..d7ef5469 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-account-audit-configuration.rst @@ -0,0 +1,52 @@ +**To view current audit configuration settings** + +The following ``describe-account-audit-configuration`` example lists the current settings for your AWS IoT Device Defender audit configuration. :: + + aws iot describe-account-audit-configuration + +Output:: + + { + "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit_1551201085996", + "auditNotificationTargetConfigurations": { + "SNS": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:ddaudits", + "roleArn": "arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit", + "enabled": true + } + }, + "auditCheckConfigurations": { + "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + }, + "CA_CERTIFICATE_EXPIRING_CHECK": { + "enabled": true + }, + "CONFLICTING_CLIENT_IDS_CHECK": { + "enabled": true + }, + "DEVICE_CERTIFICATE_EXPIRING_CHECK": { + "enabled": true + }, + "DEVICE_CERTIFICATE_SHARED_CHECK": { + "enabled": true + }, + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + }, + "LOGGING_DISABLED_CHECK": { + "enabled": true + }, + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { + "enabled": true + }, + "REVOKED_DEVICE_CERTIFICATE_STILL_ACTIVE_CHECK": { + "enabled": true + }, + "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK": { + "enabled": true + } + } + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-audit-task.rst b/aws/dist/awscli/examples/iot/describe-audit-task.rst new file mode 100644 index 00000000..3ee2f4d3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-audit-task.rst @@ -0,0 +1,45 @@ +**To get information about an audit instance** + +The following ``describe-audit-task`` example gets information about an instance of an AWS IoT Device Defender audit. If the audit is complete, summary statistics for the run are included in the results. :: + + aws iot describe-audit-task \ + --task-id a3aea009955e501a31b764abe1bebd3d + +Output:: + + { + "taskStatus": "COMPLETED", + "taskType": "ON_DEMAND_AUDIT_TASK", + "taskStartTime": 1560356923.434, + "taskStatistics": { + "totalChecks": 3, + "inProgressChecks": 0, + "waitingForDataCollectionChecks": 0, + "compliantChecks": 3, + "nonCompliantChecks": 0, + "failedChecks": 0, + "canceledChecks": 0 + }, + "auditDetails": { + "CA_CERTIFICATE_EXPIRING_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 0, + "nonCompliantResourcesCount": 0 + }, + "DEVICE_CERTIFICATE_EXPIRING_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 6, + "nonCompliantResourcesCount": 0 + }, + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK": { + "checkRunStatus": "COMPLETED_COMPLIANT", + "checkCompliant": true, + "totalResourcesCount": 0, + "nonCompliantResourcesCount": 0 + } + } + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-authorizer.rst b/aws/dist/awscli/examples/iot/describe-authorizer.rst new file mode 100644 index 00000000..eb36c9a2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-authorizer.rst @@ -0,0 +1,25 @@ +**To get information about a custom authorizer** + +The following ``describe-authorizer`` example displays details for the specified custom authorizer. :: + + aws iot describe-authorizer \ + --authorizer-name CustomAuthorizer + +Output:: + + { + "authorizerDescription": { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer", + "authorizerFunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:CustomAuthorizerFunction", + "tokenKeyName": "MyAuthToken", + "tokenSigningPublicKeys": { + "FIRST_KEY": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1uJOB4lQPgG/lM6ZfIwo\nZ+7ENxAio9q6QD4FFqjGZsvjtYwjoe1RKK0U8Eq9xb5O3kRSmyIwTzwzm/f4Gf0Y\nZUloJ+t3PUUwHrmbYTAgTrCUgRFygjfgVwGCPs5ZAX4Eyqt5cr+AIHIiUDbxSa7p\nzwOBKPeic0asNJpqT8PkBbRaKyleJh5oo81NDHHmVtbBm5A5YiJjqYXLaVAowKzZ\n+GqsNvAQ9Jy1wI2VrEa1OfL8flDB/BJLm7zjpfPOHDJQgID0XnZwAlNnZcOhCwIx\n50g2LW2Oy9R/dmqtDmJiVP97Z4GykxPvwlYHrUXY0iW1R3AR/Ac1NhCTGZMwVDB1\nlQIDAQAB\n-----END PUBLIC KEY-----" + }, + "status": "ACTIVE", + "creationDate": 1571245658.069, + "lastModifiedDate": 1571245658.069 + } + } + +For more information, see `DescribeAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-billing-group.rst b/aws/dist/awscli/examples/iot/describe-billing-group.rst new file mode 100644 index 00000000..b7516324 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-billing-group.rst @@ -0,0 +1,20 @@ +**To get information about a billing group** + +The following ``describe-billing-group`` example gets information for the specified billing group. :: + + aws iot describe-billing-group --billing-group-name GroupOne + +Output:: + + { + "billingGroupName": "GroupOne", + "billingGroupId": "103de383-114b-4f51-8266-18f209ef5562", + "billingGroupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne", + "version": 1, + "billingGroupProperties": {}, + "billingGroupMetadata": { + "creationDate": 1560199355.378 + } + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-ca-certificate.rst b/aws/dist/awscli/examples/iot/describe-ca-certificate.rst new file mode 100644 index 00000000..b7b8a000 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-ca-certificate.rst @@ -0,0 +1,29 @@ +**To get details about a CA certificate** + +The following ``describe-ca-certificate`` example displays the details for the specified CA certificate. :: + + aws iot describe-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +Output:: + + { + "certificateDescription": { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "status": "INACTIVE", + "certificatePem": "-----BEGIN CERTIFICATE-----\nMIICzzCCAbegEXAMPLEJANVEPWXl8taPMA0GCSqGSIb3DQEBBQUAMB4xCzAJBgNV\nBAYTAlVTMQ8wDQYDVQQKDAZBbWF6b24wHhcNMTkwOTI0MjEzMTE1WhcNMjkwOTIx\nMjEzMTE1WjAeMQswCQYDVQQGEwJVUzEPMA0GA1UECgwGQW1hem9uMIIBIjANBgkq\nhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzd3R3ioalCS0MhFWfBrVGR036EK07UAf\nVdz9EXAMPLE1VczICbADnATK522kEIB51/18VzlFtAhQL5V5eybXKnB7QebNer5m\n4Yibx7shR5oqNzFsrXWxuugN5+w5gEfqNMawOjhF4LsculKG49yuqjcDU19/13ua\n3B2gxs1Pe7TiWWvUskzxnbO1F2WCshbEJvqY8fIWtGYCjTeJAgQ9hvZx/69XhKen\nwV9LJwOQxrsUS0Ty8IHwbB8fRy72VM3u7fJoaU+nO4jD5cqaoEPtzoeFUEXAMPLE\nyVAJpqHwgbYbcUfn7V+AB6yh1+0Fa1rEQGuZDPGyJslxwr5vh8nRewIDAQABoxAw\nDjAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBBQUAA4IBAQA+3a5CV3IJgOnd0AgI\nBgVMtmYzTvqAngx26aG9/spvCjXckh2SBF+EcBlCFwH1yakwjJL1dR4yarnrfxgI\nEqP4AOYVimAVoQ5FBwnloHe16+3qtDiblU9DeXBUCtS55EcfrEXAMPLEYtXdqU5C\nU9ia4KAjV0dxW1+EFYMwX5eGeb0gDTNHBylV6B/fOSZiQAwDYp4x3B+gAP+a/bWB\nu1umOqtBdWe6L6/83L+JhaTByqV25iVJ4c/UZUnG8926wUlDM9zQvEXuEVvzZ7+m\n4PSNqst/nVOvnLpoG4e0WgcJgANuB33CSWtjWSuYsbhmqQRknGhREXAMPLEZT4fm\nfo0e\n-----END CERTIFICATE-----\n", + "ownedBy": "123456789012", + "creationDate": 1569365372.053, + "autoRegistrationStatus": "DISABLE", + "lastModifiedDate": 1569365372.053, + "customerVersion": 1, + "generationId": "c5c2eb95-140b-4f49-9393-6aaac85b2a90", + "validity": { + "notBefore": 1569360675.0, + "notAfter": 1884720675.0 + } + } + } + +For more information, see `DescribeCACertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-certificate.rst b/aws/dist/awscli/examples/iot/describe-certificate.rst new file mode 100644 index 00000000..3506f1aa --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-certificate.rst @@ -0,0 +1,44 @@ +**To get information about a certificate** + +The following ``describe-certificate`` example displays the details for the specified certificate. :: + + aws iot describe-certificate \ + --certificate-id "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e" + +Output:: + + { + "certificateDescription": { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "status": "ACTIVE", + "certificatePem": "-----BEGIN CERTIFICATE----- + MIICiTEXAMPLEQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC + VVMxCzAJBgNVBEXAMPLEMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 + b24xFDASBgNVBAsTC0lBTSBDEXAMPLElMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd + BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5EXAMPLEcNMTEwNDI1MjA0NTIxWhcN + MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNEXAMPLEdBMRAwDgYD + VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBEXAMPLEz + b2xEXAMPLEYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt + YXpvbi5jb20wgZ8EXAMPLEZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ + 21uUSfwfEvySWtC2XADZ4nB+BLYEXAMPLEpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T + rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7EXAMPLEGBzZswY6786m86gpE + Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFEXAMPLEAtCu4 + nUhVVxYUnEXAMPLE8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb + FFBjvSfpJIlJ00zbhNYS5f6GEXAMPLEl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb + NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE= + -----END CERTIFICATE-----", + "ownedBy": "123456789012", + "creationDate": 1541022751.983, + "lastModifiedDate": 1541022751.983, + "customerVersion": 1, + "transferData": {}, + "generationId": "6974fbed-2e61-4114-bc5e-4204cc79b045", + "validity": { + "notBefore": 1541022631.0, + "notAfter": 2524607999.0 + } + } + } + +For more information, see `DescribeCertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-default-authorizer.rst b/aws/dist/awscli/examples/iot/describe-default-authorizer.rst new file mode 100644 index 00000000..3645d2ca --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-default-authorizer.rst @@ -0,0 +1,14 @@ +**To get information about the default custom authorizer** + +The following ``describe-default-authorizer`` example displays details for the default custom authorizer. :: + + aws iot describe-default-authorizer + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + } + +For more information, see `DescribeDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-endpoint.rst b/aws/dist/awscli/examples/iot/describe-endpoint.rst new file mode 100644 index 00000000..c79ebff5 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-endpoint.rst @@ -0,0 +1,28 @@ +**Example 1: To get your current AWS endpoint** + +The following ``describe-endpoint`` example retrieves the default AWS endpoint to which all commands are applied. :: + + aws iot describe-endpoint + +Output:: + + { + "endpointAddress": "abc123defghijk.iot.us-west-2.amazonaws.com" + } + +For more information, see `DescribeEndpoint `__ in the *AWS IoT Developer Guide*. + +**Example 2: To get your ATS endpoint** + +The following ``describe-endpoint`` example retrieves the Amazon Trust Services (ATS) endpoint. :: + + aws iot describe-endpoint \ + --endpoint-type iot:Data-ATS + +Output:: + + { + "endpointAddress": "abc123defghijk-ats.iot.us-west-2.amazonaws.com" + } + +For more information, see `X.509 Certificates and AWS IoT `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-event-configurations.rst b/aws/dist/awscli/examples/iot/describe-event-configurations.rst new file mode 100644 index 00000000..aca5f906 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-event-configurations.rst @@ -0,0 +1,47 @@ +**To show which event types are published** + +The following ``describe-event-configurations`` example lists the configuration that controls which events are generated when something is added, updated, or deleted. :: + + aws iot describe-event-configurations + +Output:: + + { + "eventConfigurations": { + "CA_CERTIFICATE": { + "Enabled": false + }, + "CERTIFICATE": { + "Enabled": false + }, + "JOB": { + "Enabled": false + }, + "JOB_EXECUTION": { + "Enabled": false + }, + "POLICY": { + "Enabled": false + }, + "THING": { + "Enabled": false + }, + "THING_GROUP": { + "Enabled": false + }, + "THING_GROUP_HIERARCHY": { + "Enabled": false + }, + "THING_GROUP_MEMBERSHIP": { + "Enabled": false + }, + "THING_TYPE": { + "Enabled": false + }, + "THING_TYPE_ASSOCIATION": { + "Enabled": false + } + } + } + +For more information, see `Event Messages `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-index.rst b/aws/dist/awscli/examples/iot/describe-index.rst new file mode 100644 index 00000000..adeaef81 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-index.rst @@ -0,0 +1,16 @@ +**To retrieve the current status of the thing index** + +The following ``describe-index`` example retrieves the current status of the thing index. :: + + aws iot describe-index \ + --index-name "AWS_Things" + +Output:: + + { + "indexName": "AWS_Things", + "indexStatus": "ACTIVE", + "schema": "REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS" + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-job-execution.rst b/aws/dist/awscli/examples/iot/describe-job-execution.rst new file mode 100644 index 00000000..a025a1f3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-job-execution.rst @@ -0,0 +1,24 @@ +**To get execution details for a job on a device** + +The following ``describe-job-execution`` example gets execution details for the specified job. :: + + aws iot describe-job-execution \ + --job-id "example-job-01" \ + --thing-name "MyRaspberryPi" + +Output:: + + { + "execution": { + "jobId": "example-job-01", + "status": "QUEUED", + "statusDetails": {}, + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi", + "queuedAt": 1560787023.636, + "lastUpdatedAt": 1560787023.636, + "executionNumber": 1, + "versionNumber": 1 + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-job.rst b/aws/dist/awscli/examples/iot/describe-job.rst new file mode 100644 index 00000000..98b5aa54 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-job.rst @@ -0,0 +1,38 @@ +**To get detailed status for a job** + +The following ``describe-job`` example gets detailed status for the job whose ID is ``example-job-01``. :: + + aws iot describe-job \ + --job-id "example-job-01" + +Output:: + + { + "job": { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "targets": [ + "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" + ], + "description": "example job test", + "presignedUrlConfig": {}, + "jobExecutionsRolloutConfig": {}, + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294, + "jobProcessDetails": { + "numberOfCanceledThings": 0, + "numberOfSucceededThings": 0, + "numberOfFailedThings": 0, + "numberOfRejectedThings": 0, + "numberOfQueuedThings": 1, + "numberOfInProgressThings": 0, + "numberOfRemovedThings": 0, + "numberOfTimedOutThings": 0 + }, + "timeoutConfig": {} + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-role-alias.rst b/aws/dist/awscli/examples/iot/describe-role-alias.rst new file mode 100644 index 00000000..ad786823 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-role-alias.rst @@ -0,0 +1,22 @@ +**To get information about an AWS IoT role alias** + +The following ``describe-role-alias`` example displays details for the specified role alias. :: + + aws iot describe-role-alias \ + --role-alias LightBulbRole + +Output:: + + { + "roleAliasDescription": { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole", + "roleArn": "arn:aws:iam::123456789012:role/light_bulb_role_001", + "owner": "123456789012", + "credentialDurationSeconds": 3600, + "creationDate": 1570558643.221, + "lastModifiedDate": 1570558643.221 + } + } + +For more information, see `DescribeRoleAlias `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-scheduled-audit.rst b/aws/dist/awscli/examples/iot/describe-scheduled-audit.rst new file mode 100644 index 00000000..528fec16 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-scheduled-audit.rst @@ -0,0 +1,24 @@ +**To get information about a scheduled audit** + +The following ``describe-scheduled-audit`` example gets detailed information about an AWS IOT Device Defender scheduled audit named ``AWSIoTDeviceDefenderDailyAudit``. :: + + aws iot describe-scheduled-audit \ + --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit + +Output:: + + { + "frequency": "DAILY", + "targetCheckNames": [ + "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK", + "CONFLICTING_CLIENT_IDS_CHECK", + "DEVICE_CERTIFICATE_SHARED_CHECK", + "IOT_POLICY_OVERLY_PERMISSIVE_CHECK", + "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK", + "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK" + ], + "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-security-profile.rst b/aws/dist/awscli/examples/iot/describe-security-profile.rst new file mode 100644 index 00000000..cd8da51a --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-security-profile.rst @@ -0,0 +1,46 @@ +**To get information about a security profile** + +The following ``describe-security-profile`` example gets information about the AWS IoT Device Defender security profile named ``PossibleIssue.`` :: + + aws iot describe-security-profile \ + --security-profile-name PossibleIssue + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", + "securityProfileDescription": "check to see if authorization fails 10 times in 5 minutes or if cellular bandwidth exceeds 128", + "behaviors": [ + { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + } + ], + "version": 1, + "creationDate": 1560278102.528, + "lastModifiedDate": 1560278102.528 + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-stream.rst b/aws/dist/awscli/examples/iot/describe-stream.rst new file mode 100644 index 00000000..1f1d5979 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-stream.rst @@ -0,0 +1,31 @@ +**To get information about a stream** + +The following ``describe-stream`` example displays the details about the specified stream. :: + + aws iot describe-stream \ + --stream-id stream12345 + +Output:: + + { + "streamInfo": { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": "123", + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ], + "createdAt": 1557863215.995, + "lastUpdatedAt": 1557863215.995, + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_stream_role" + } + } + +For more information, see `DescribeStream `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/describe-thing-group.rst b/aws/dist/awscli/examples/iot/describe-thing-group.rst new file mode 100644 index 00000000..ddb93cb1 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-thing-group.rst @@ -0,0 +1,29 @@ +**To get information about a thing group** + +The following ``describe-thing-group`` example gets information about the thing group named ``HalogenBulbs``. :: + + aws iot describe-thing-group \ + --thing-group-name HalogenBulbs + +Output:: + + { + "thingGroupName": "HalogenBulbs", + "thingGroupId": "f4ec6b84-b42b-499d-9ce1-4dbd4d4f6f6e", + "thingGroupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs", + "version": 1, + "thingGroupProperties": {}, + "thingGroupMetadata": { + "parentGroupName": "LightBulbs", + "rootToParentThingGroups": [ + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ], + "creationDate": 1559927609.897 + } + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/describe-thing-type.rst b/aws/dist/awscli/examples/iot/describe-thing-type.rst new file mode 100644 index 00000000..4f429c46 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-thing-type.rst @@ -0,0 +1,27 @@ +**To get information about a thing type** + +The following ``describe-thing-type`` example display information about the specified thing type defined in your AWS account. :: + + aws iot describe-thing-type \ + --thing-type-name "LightBulb" + +Output:: + + { + "thingTypeName": "LightBulb", + "thingTypeId": "ce3573b0-0a3c-45a7-ac93-4e0ce14cd190", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeProperties": { + "thingTypeDescription": "light bulb type", + "searchableAttributes": [ + "model", + "wattage" + ] + }, + "thingTypeMetadata": { + "deprecated": false, + "creationDate": 1559772562.498 + } + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/describe-thing.rst b/aws/dist/awscli/examples/iot/describe-thing.rst new file mode 100644 index 00000000..2fa247c1 --- /dev/null +++ b/aws/dist/awscli/examples/iot/describe-thing.rst @@ -0,0 +1,23 @@ +**To display detailed information about a thing** + +The following ``describe-thing`` example display information about a thing (device) that is defined in the AWS IoT registry for your AWS account. + + aws iot describe-thing \ + --thing-name "MyLightBulb" + +Output:: + + { + "defaultClientId": "MyLightBulb", + "thingName": "MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + } + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/detach-policy.rst b/aws/dist/awscli/examples/iot/detach-policy.rst new file mode 100644 index 00000000..68d630c7 --- /dev/null +++ b/aws/dist/awscli/examples/iot/detach-policy.rst @@ -0,0 +1,21 @@ +**Example 1: To detach an AWS IoT policy from a thing group** + +The following ``detach-policy`` example detaches the specified policy from a thing group and, by extension, from all things in that group and any of the group's child groups. :: + + aws iot detach-policy \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \ + --policy-name "MyFirstGroup_Core-policy" + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To detach an AWS IoT policy from a device certificate** + +The following ``detach-policy`` example detaches the TemperatureSensorPolicy policy from a device certificate identified by ARN. :: + + aws iot detach-policy \ + --policy-name TemperatureSensorPolicy \ + --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/iot/detach-security-profile.rst b/aws/dist/awscli/examples/iot/detach-security-profile.rst new file mode 100644 index 00000000..41115b3b --- /dev/null +++ b/aws/dist/awscli/examples/iot/detach-security-profile.rst @@ -0,0 +1,11 @@ +**To disassociate a security profile from a target** + +The following ``detach-security-profile`` example removes the association between the AWS IoT Device Defender security profile named ``Testprofile`` and the all registered things target. :: + + aws iot detach-security-profile \ + --security-profile-name Testprofile \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/registered-things" + +This command produces no output. + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/detach-thing-principal.rst b/aws/dist/awscli/examples/iot/detach-thing-principal.rst new file mode 100644 index 00000000..eac2b928 --- /dev/null +++ b/aws/dist/awscli/examples/iot/detach-thing-principal.rst @@ -0,0 +1,11 @@ +**To detach a certificate/principal from a thing** + +The following ``detach-thing-principal`` example removes a certificate that represents a principal from the specified thing. :: + + aws iot detach-thing-principal \ + --thing-name "MyLightBulb" \ + --principal "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36" + +This command produces no output. + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/disable-topic-rule.rst b/aws/dist/awscli/examples/iot/disable-topic-rule.rst new file mode 100644 index 00000000..086c78e1 --- /dev/null +++ b/aws/dist/awscli/examples/iot/disable-topic-rule.rst @@ -0,0 +1,11 @@ +**To disable a topic rule** + +The following ``disable-topic-rule`` example disables the specified topic rule. :: + + aws iot disable-topic-rule \ + --rule-name "MyPlantPiMoistureAlertRule" + +This command produces no output. + + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/enable-topic-rule.rst b/aws/dist/awscli/examples/iot/enable-topic-rule.rst new file mode 100644 index 00000000..d657ffae --- /dev/null +++ b/aws/dist/awscli/examples/iot/enable-topic-rule.rst @@ -0,0 +1,10 @@ +**To enable a topic rule** + +The following ``enable-topic-rule`` example enables (or re-enables) the specified topic rule. :: + + aws iot enable-topic-rule \ + --rule-name "MyPlantPiMoistureAlertRule" + +This command produces no output. + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/get-effective-policies.rst b/aws/dist/awscli/examples/iot/get-effective-policies.rst new file mode 100644 index 00000000..ac591a87 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-effective-policies.rst @@ -0,0 +1,55 @@ +**To list the policies that effect a thing** + +The following ``get-effective-policies`` example lists the policies that effect the specified thing, including policies attached to any groups to which it belongs. :: + + aws iot get-effective-policies \ + --thing-name TemperatureSensor-001 \ + --principal arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +Output:: + + { + "effectivePolicies": [ + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy", + "policyDocument": "{ + \"Version\": \"2012-10-17\", + \"Statement\": [ + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Publish\", + \"iot:Receive\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topic/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topic/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Subscribe\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_1\", + \"arn:aws:iot:us-west-2:123456789012:topicfilter/topic_2\" + ] + }, + { + \"Effect\": \"Allow\", + \"Action\": [ + \"iot:Connect\" + ], + \"Resource\": [ + \"arn:aws:iot:us-west-2:123456789012:client/basicPubSub\" + ] + } + ] + }" + } + ] + } + +For more information, see `Get Effective Policies for a Thing `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/get-indexing-configuration.rst b/aws/dist/awscli/examples/iot/get-indexing-configuration.rst new file mode 100644 index 00000000..3388dd77 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-indexing-configuration.rst @@ -0,0 +1,20 @@ +**To get the thing indexing configuration** + +The following ``get-indexing-configuration`` example gets the current configuration data for AWS IoT fleet indexing. :: + + aws iot get-indexing-configuration + +Output:: + + { + "thingIndexingConfiguration": { + "thingIndexingMode": "OFF", + "thingConnectivityIndexingMode": "OFF" + }, + "thingGroupIndexingConfiguration": { + "thingGroupIndexingMode": "OFF" + } + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/get-job-document.rst b/aws/dist/awscli/examples/iot/get-job-document.rst new file mode 100644 index 00000000..ac567697 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-job-document.rst @@ -0,0 +1,14 @@ +**To retrieve the document for a job** + +The following ``get-job-document`` example displays details about the document for the job whose ID is ``example-job-01``. :: + + aws iot get-job-document \ + --job-id "example-job-01" + +Output:: + + { + "document": "\n{\n \"operation\":\"customJob\",\n \"otherInfo\":\"someValue\"\n}\n" + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/get-logging-options.rst b/aws/dist/awscli/examples/iot/get-logging-options.rst new file mode 100644 index 00000000..f0532187 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-logging-options.rst @@ -0,0 +1,14 @@ +**To get the logging options** + +The following ``get-logging-options`` example gets the current logging options for your AWS account. :: + + aws iot get-logging-options + +Output:: + + { + "roleArn": "arn:aws:iam::123456789012:role/service-role/iotLoggingRole", + "logLevel": "ERROR" + } + +For more information, see `title `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/get-ota-update.rst b/aws/dist/awscli/examples/iot/get-ota-update.rst new file mode 100644 index 00000000..fa89404b --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-ota-update.rst @@ -0,0 +1,50 @@ +**To retrieve information about an OTA Update** + +The following ``get-ota-update`` example displays details about the specified OTA Update. :: + + aws iot get-ota-update \ + --ota-update-id ota12345 + +Output:: + + { + "otaUpdateInfo": { + "otaUpdateId": "ota12345", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "creationDate": 1557863215.995, + "lastModifiedDate": 1557863215.995, + "description": "A critical update needed right away.", + "targets": [ + "device1", + "device2", + "device3", + "device4" + ], + "targetSelection": "SNAPSHOT", + "awsJobExecutionsRolloutConfig": { + "maximumPerMinute": 10 + }, + "otaUpdateFiles": [ + { + "fileName": "firmware.bin", + "fileLocation": { + "stream": { + "streamId": "004", + "fileId":123 + } + }, + "codeSigning": { + "awsSignerJobId": "48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ], + "roleArn": "arn:aws:iam:123456789012:role/service-role/my_ota_role" + "otaUpdateStatus": "CREATE_COMPLETE", + "awsIotJobId": "job54321", + "awsIotJobArn": "arn:aws:iot:us-west-2:123456789012:job/job54321", + "errorInfo": { + } + } + } + +For more information, see `GetOTAUpdate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/get-policy-version.rst b/aws/dist/awscli/examples/iot/get-policy-version.rst new file mode 100644 index 00000000..4a8c1da7 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-policy-version.rst @@ -0,0 +1,23 @@ +**To get information about a specific version of a policy** + +The following ``get-policy-version`` example gets information about the first version of the specified policy. :: + + aws iot get-policy \ + --policy-name UpdateDeviceCertPolicy + --policy-version-id "1" + +Output:: + + { + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyName": "UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "policyVersionId": "1", + "isDefaultVersion": false, + "creationDate": 1559925941.924, + "lastModifiedDate": 1559926175.458, + "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/get-policy.rst b/aws/dist/awscli/examples/iot/get-policy.rst new file mode 100644 index 00000000..7540de71 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-policy.rst @@ -0,0 +1,21 @@ +**To get information about the default version of a policy** + +The following ``get-policy`` example retrieves information about the default version of the specified policy. :: + + aws iot get-policy \ + --policy-name UpdateDeviceCertPolicy + +Output:: + + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy", + "policyDocument": "{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Effect\": \"Allow\", \"Action\": \"iot:UpdateCertificate\", \"Resource\": \"*\" } ] }", + "defaultVersionId": "2", + "creationDate": 1559925941.924, + "lastModifiedDate": 1559925941.924, + "generationId": "5066f1b6712ce9d2a1e56399771649a272d6a921762fead080e24fe52f24e042" + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/get-registration-code.rst b/aws/dist/awscli/examples/iot/get-registration-code.rst new file mode 100644 index 00000000..9db54e9d --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-registration-code.rst @@ -0,0 +1,13 @@ +**To get your AWS account-specific registration code** + +The following ``get-registration-code`` example retrieves your AWS account-specific registration code. :: + + aws iot get-registration-code + +Output:: + + { + "registrationCode": "15c51ae5e36ba59ba77042df1115862076bea4bd15841c838fcb68d5010a614c" + } + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/get-statistics.rst b/aws/dist/awscli/examples/iot/get-statistics.rst new file mode 100644 index 00000000..015045a2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-statistics.rst @@ -0,0 +1,17 @@ +**To search the device index for aggregate data** + +The following ``get-statistics`` example returns the number of things that have a property called ``connectivity.connected`` set to ``false`` (that is, the number of devices that are not connected) in their device shadow. :: + + aws iot get-statistics \ + --index-name AWS_Things \ + --query-string "connectivity.connected:false" + +Output:: + + { + "statistics": { + "count": 6 + } + } + +For more information, see `Getting Statistics About Your Device Fleet `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/get-topic-rule.rst b/aws/dist/awscli/examples/iot/get-topic-rule.rst new file mode 100644 index 00000000..44110143 --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-topic-rule.rst @@ -0,0 +1,32 @@ +**To get information about a rule** + +The following ``get-topic-rule`` example gets information about the specified rule. :: + + aws iot get-topic-rule \ + --rule-name MyRPiLowMoistureAlertRule + +Output:: + + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", + "rule": { + "ruleName": "MyRPiLowMoistureAlertRule", + "sql": "SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\n ", + "description": "Sends an alert whenever soil moisture level readings are too low.", + "createdAt": 1558624363.0, + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic", + "roleArn": "arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole", + "messageFormat": "RAW" + } + } + ], + "ruleDisabled": false, + "awsIotSqlVersion": "2016-03-23" + } + } + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/get-v2-logging-options.rst b/aws/dist/awscli/examples/iot/get-v2-logging-options.rst new file mode 100644 index 00000000..6ae5214d --- /dev/null +++ b/aws/dist/awscli/examples/iot/get-v2-logging-options.rst @@ -0,0 +1,15 @@ +**To list the current logging options** + +The following ``get-v2-logging-options`` example lists the current logging options for AWS IoT. :: + + aws iot get-v2-logging-options + +Output:: + + { + "roleArn": "arn:aws:iam::094249569039:role/service-role/iotLoggingRole", + "defaultLogLevel": "WARN", + "disableAllLogs": false + } + +For more information, see `title `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-active-violations.rst b/aws/dist/awscli/examples/iot/list-active-violations.rst new file mode 100644 index 00000000..d95d6604 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-active-violations.rst @@ -0,0 +1,104 @@ +**To list the active violations** + +The following ``list-active-violations`` example lists all violations for the specified security profile. :: + + aws iot list-active-violations \ + --security-profile-name Testprofile + +Output:: + + { + "activeViolations": [ + { + "violationId": "174db59167fa474c80a652ad1583fd44", + "thingName": "iotconsole-1560269126751-1", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560293700.0, + "violationStartTime": 1560279000.0 + }, + { + "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 110 + }, + "lastViolationTime": 1560369000.0, + "violationStartTime": 1560276600.0 + }, + { + "violationId": "74aa393adea02e6648f3ac362beed55e", + "thingName": "iotconsole-1560269232412-2", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560276600.0, + "violationStartTime": 1560276600.0 + }, + { + "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "lastViolationValue": { + "count": 0 + }, + "lastViolationTime": 1560369000.0, + "violationStartTime": 1560276600.0 + } + ] + } diff --git a/aws/dist/awscli/examples/iot/list-attached-policies.rst b/aws/dist/awscli/examples/iot/list-attached-policies.rst new file mode 100644 index 00000000..2382431a --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-attached-policies.rst @@ -0,0 +1,39 @@ +**Example 1: To list the policies attached to a group** + +The following ``list-attached-policies`` example lists the policies that are attached to the specified group. :: + + aws iot list-attached-policies \ + --target "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + +Output:: + + { + "policies": [ + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + +**Example 2: To list the policies attached to a device certificate** + +The following ``list-attached-policies`` example lists the AWS IoT policies attached to the device certificate. The certificate is identified by its ARN. :: + + aws iot list-attached-policies \ + --target arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 + +Output:: + + { + "policies": [ + { + "policyName": "TemperatureSensorPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TemperatureSensorPolicy" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-audit-findings.rst b/aws/dist/awscli/examples/iot/list-audit-findings.rst new file mode 100644 index 00000000..4297bb0e --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-audit-findings.rst @@ -0,0 +1,149 @@ +**Example 1: To list all findings from an audit** + +The following ``list-audit-findings`` example lists all findings from an AWS IoT Device Defender audit with a specified task ID. :: + + aws iot list-audit-findings \ + --task-id a3aea009955e501a31b764abe1bebd3d + +Output:: + + { + "findings": [] + } + +**Example 2: To list findings for an audit check type** + +The following ``list-audit-findings`` example shows findings from AWS IoT Device Defender audits that ran between June 5, 2019 and June 19, 2019 in which devices are sharing a device certificate. When you specify a check name, you must provide a start and end time. :: + + aws iot list-audit-findings \ + --check-name DEVICE_CERTIFICATE_SHARED_CHECK \ + --start-time 1559747125 \ + --end-time 1560962028 + +Output:: + + { + "findings": [ + { + "taskId": "eeef61068b0eb03c456d746c5a26ee04", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1560161017.172, + "findingTime": 1560161017.592, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1560086374068" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1560081552187", + "DISCONNECTION_TIME": "1560086371552" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "ZipxgAIl" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559289863631", + "DISCONNECTION_TIME": "1560081532716" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + }, + { + "taskId": "bade6b5efd2e1b1569822f6021b39cf5", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1559988217.27, + "findingTime": 1559988217.655, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "xShGENLW" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559972350825" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "xShGENLW" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559255062002", + "DISCONNECTION_TIME": "1559972350616" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + }, + { + "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", + "checkName": "DEVICE_CERTIFICATE_SHARED_CHECK", + "taskStartTime": 1559901817.31, + "findingTime": 1559901817.767, + "severity": "CRITICAL", + "nonCompliantResource": { + "resourceType": "DEVICE_CERTIFICATE", + "resourceIdentifier": { + "deviceCertificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b" + } + }, + "relatedResources": [ + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "TvnQoEoU" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559826729768" + } + }, + { + "resourceType": "CLIENT_ID", + "resourceIdentifier": { + "clientId": "TvnQoEoU" + }, + "additionalInfo": { + "CONNECTION_TIME": "1559345920964", + "DISCONNECTION_TIME": "1559826728402" + } + } + ], + "reasonForNonCompliance": "Certificate shared by one or more devices.", + "reasonForNonComplianceCode": "CERTIFICATE_SHARED_BY_MULTIPLE_DEVICES" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. + diff --git a/aws/dist/awscli/examples/iot/list-audit-tasks.rst b/aws/dist/awscli/examples/iot/list-audit-tasks.rst new file mode 100644 index 00000000..36d5fe53 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-audit-tasks.rst @@ -0,0 +1,61 @@ +**To list all findings from an audit** + +The following ``list-audit-tasks`` example lists the audit tasks that ran between June 5, 2019 and June 12, 2019. :: + + aws iot list-audit-tasks \ + --start-time 1559747125 \ + --end-time 1560357228 + +Output:: + + { + "tasks": [ + { + "taskId": "a3aea009955e501a31b764abe1bebd3d", + "taskStatus": "COMPLETED", + "taskType": "ON_DEMAND_AUDIT_TASK" + }, + { + "taskId": "f76b4b5102b632cd9ae38a279c266da1", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "51d9967d9f9ff4d26529505f6d2c444a", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "eeef61068b0eb03c456d746c5a26ee04", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "041c49557b7c7b04c079a49514b55589", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "82c7f2afac1562d18a4560be73998acc", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "bade6b5efd2e1b1569822f6021b39cf5", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "c23f6233ba2d35879c4bb2810fb5ffd6", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + }, + { + "taskId": "ac9086b7222a2f5e2e17bb6fd30b3aeb", + "taskStatus": "COMPLETED", + "taskType": "SCHEDULED_AUDIT_TASK" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-authorizers.rst b/aws/dist/awscli/examples/iot/list-authorizers.rst new file mode 100644 index 00000000..ca975e3e --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-authorizers.rst @@ -0,0 +1,26 @@ +**To list your custom authorizer** + +The following ``list-authorizers`` example lists the custom authorizers in your AWS account. :: + + aws iot list-authorizers + +Output:: + + { + "authorizers": [ + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + }, + { + "authorizerName": "CustomAuthorizer2", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + }, + { + "authorizerName": "CustomAuthorizer3", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer3" + } + ] + } + +For more information, see `ListAuthorizers `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-billing-groups.rst b/aws/dist/awscli/examples/iot/list-billing-groups.rst new file mode 100644 index 00000000..1f7f1806 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-billing-groups.rst @@ -0,0 +1,18 @@ +**To list the billing groups for your AWS account and region** + +The following ``list-billing-groups`` example lists all billing groups that are defined for your AWS account and AWS Region. :: + + aws iot list-billing-groups + +Output:: + + { + "billingGroups": [ + { + "groupName": "GroupOne", + "groupArn": "arn:aws:iot:us-west-2:123456789012:billinggroup/GroupOne" + } + ] + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-ca-certificates.rst b/aws/dist/awscli/examples/iot/list-ca-certificates.rst new file mode 100644 index 00000000..32258589 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-ca-certificates.rst @@ -0,0 +1,20 @@ +**To list the CA certificates registered in your AWS account** + +The following ``list-ca-certificates`` example lists the CA certificates registered in your AWS account. :: + + aws iot list-ca-certificates + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "status": "INACTIVE", + "creationDate": 1569365372.053 + } + ] + } + +For more information, see `Use Your Own Certificate `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-certificates-by-ca.rst b/aws/dist/awscli/examples/iot/list-certificates-by-ca.rst new file mode 100644 index 00000000..22ea895f --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-certificates-by-ca.rst @@ -0,0 +1,21 @@ +**To list all device certificates signed with a CA certificate** + +The following ``list-certificates-by-ca`` example lists all device certificates in your AWS account that are signed with the specified CA certificate. :: + + aws iot list-certificates-by-ca \ + --ca-certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "status": "ACTIVE", + "creationDate": 1569363250.557 + } + ] + } + +For more information, see `ListCertificatesByCA `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-certificates.rst b/aws/dist/awscli/examples/iot/list-certificates.rst new file mode 100644 index 00000000..1084fe92 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-certificates.rst @@ -0,0 +1,49 @@ +**Example 1: To list the certificates registered in your AWS account** + +The following ``list-certificates`` example lists all certificates registered in your account. If you have more than the default paging limit of 25, you can use the ``nextMarker`` response value from this command and supply it to the next command to get the next batch of results. Repeat until ``nextMarker`` returns without a value. :: + + aws iot list-certificates + +Output:: + + { + "certificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", + "certificateId": "604c48437a57b7d5fc5d137c5be75011c6ee67c9a6943683a1acb4b1626bac36", + "status": "ACTIVE", + "creationDate": 1556810537.617 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", + "certificateId": "262a1ac8a7d8aa72f6e96e365480f7313aa9db74b8339ec65d34dc3074e1c31e", + "status": "ACTIVE", + "creationDate": 1546447050.885 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", + "certificateId": "b193ab7162c0fadca83246d24fa090300a1236fe58137e121b011804d8ac1d6b", + "status": "ACTIVE", + "creationDate": 1546292258.322 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", + "certificateId": "7aebeea3845d14a44ec80b06b8b78a89f3f8a706974b8b34d18f5adf0741db42", + "status": "ACTIVE", + "creationDate": 1541457693.453 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", + "certificateId": "54458aa39ebb3eb39c91ffbbdcc3a6ca1c7c094d1644b889f735a6fc2cd9a7e3", + "status": "ACTIVE", + "creationDate": 1541113568.611 + }, + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "certificateId": "4f0ba725787aa94d67d2fca420eca022242532e8b3c58e7465c7778b443fd65e", + "status": "ACTIVE", + "creationDate": 1541022751.983 + } + ] + } + diff --git a/aws/dist/awscli/examples/iot/list-indices.rst b/aws/dist/awscli/examples/iot/list-indices.rst new file mode 100644 index 00000000..9f5d24e3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-indices.rst @@ -0,0 +1,15 @@ +**To list the configured search indices** + +The following ``list-indices`` example lists all configured search indices in your AWS account. If you have not enabled thing indexing, you might not have any indices. :: + + aws iot list-indices + +Output:: + + { + "indexNames": [ + "AWS_Things" + ] + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-job-executions-for-job.rst b/aws/dist/awscli/examples/iot/list-job-executions-for-job.rst new file mode 100644 index 00000000..910d9993 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-job-executions-for-job.rst @@ -0,0 +1,22 @@ +**To list the jobs in your AWS account** + +The following ``list-job-executions-for-job`` example lists all jobs in your AWS account, sorted by the job status. :: + + aws iot list-jobs + +Output:: + + { + "jobs": [ + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294 + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-job-executions-for-thing.rst b/aws/dist/awscli/examples/iot/list-job-executions-for-thing.rst new file mode 100644 index 00000000..9c6c77f6 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-job-executions-for-thing.rst @@ -0,0 +1,24 @@ +**To list the jobs that were executed for a thing** + +The following ``list-job-executions-for-thing`` example lists all jobs that were executed for the thing named ``MyRaspberryPi``. :: + + aws iot list-job-executions-for-thing \ + --thing-name "MyRaspberryPi" + +Output:: + + { + "executionSummaries": [ + { + "jobId": "example-job-01", + "jobExecutionSummary": { + "status": "QUEUED", + "queuedAt": 1560787023.636, + "lastUpdatedAt": 1560787023.636, + "executionNumber": 1 + } + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-jobs.rst b/aws/dist/awscli/examples/iot/list-jobs.rst new file mode 100644 index 00000000..fd99082f --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-jobs.rst @@ -0,0 +1,22 @@ +**To list the jobs in your AWS account** + +The following ``list-jobs`` example lists all jobs in your AWS account, sorted by the job status. :: + + aws iot list-jobs + +Output:: + + { + "jobs": [ + { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294 + } + ] + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-ota-updates.rst b/aws/dist/awscli/examples/iot/list-ota-updates.rst new file mode 100644 index 00000000..e216881f --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-ota-updates.rst @@ -0,0 +1,19 @@ +**To list OTA Updates for the account** + +The following ``list-ota-updates`` example lists the available OTA updates. :: + + aws iot list-ota-updates + +Output:: + + { + "otaUpdates": [ + { + "otaUpdateId": "itsaupdate", + "otaUpdateArn": "arn:aws:iot:us-west-2:123456789012:otaupdate/itsaupdate", + "creationDate": 1557863215.995 + } + ] + } + +For more information, see `ListOTAUpdates `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-outgoing-certificates.rst b/aws/dist/awscli/examples/iot/list-outgoing-certificates.rst new file mode 100644 index 00000000..dc1d51ef --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-outgoing-certificates.rst @@ -0,0 +1,21 @@ +**To list certificates being transferred to a different AWS account** + +The following ``list-outgoing-certificates`` example lists all device certificates that are in the process of being transferred to a different AWS account using the ``transfer-certificate`` command. :: + + aws iot list-outgoing-certificates + +Output:: + + { + "outgoingCertificates": [ + { + "certificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "transferredTo": "030714055129", + "transferDate": 1569427780.441, + "creationDate": 1569363250.557 + } + ] + } + +For more information, see `ListOutgoingCertificates `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-policies.rst b/aws/dist/awscli/examples/iot/list-policies.rst new file mode 100644 index 00000000..e02f1dbf --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-policies.rst @@ -0,0 +1,27 @@ +**To list the policies defined in your AWS account** + +The following ``list-policies`` example lists all policies defined in your AWS account. :: + + aws iot list-policies + +Output:: + + { + "policies": [ + { + "policyName": "UpdateDeviceCertPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/UpdateDeviceCertPolicy" + }, + { + "policyName": "PlantIoTPolicy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/PlantIoTPolicy" + }, + { + "policyName": "MyPiGroup_Core-policy", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/MyPiGroup_Core-policy" + } + ] + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/list-policy-versions.rst b/aws/dist/awscli/examples/iot/list-policy-versions.rst new file mode 100644 index 00000000..5b48867f --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-policy-versions.rst @@ -0,0 +1,25 @@ +**Example 1: To see all versions of a policy** + +The following ``list-policy-versions`` example lists all versions of the specified policy and their creation dates. :: + + aws iot list-policy-versions \ + --policy-name LightBulbPolicy + +Output:: + + { + "policyVersions": [ + { + "versionId": "2", + "isDefaultVersion": true, + "createDate": 1559925941.924 + }, + { + "versionId": "1", + "isDefaultVersion": false, + "createDate": 1559925941.924 + } + ] + } + +For more information, see `AWS IoT Policies `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-principal-things.rst b/aws/dist/awscli/examples/iot/list-principal-things.rst new file mode 100644 index 00000000..1d8f53d7 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-principal-things.rst @@ -0,0 +1,17 @@ +**To list the things attached with a principal** + +The following ``list-principal-things`` example lists the things attached to the principal specified by an ARN. :: + + aws iot list-principal-things \ + --principal arn:aws:iot:us-west-2:123456789012:cert/2e1eb273792174ec2b9bf4e9b37e6c6c692345499506002a35159767055278e8 + +Output:: + + { + "things": [ + "DeskLamp", + "TableLamp" + ] + } + +For more information, see `ListPrincipalThings `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-role-aliases.rst b/aws/dist/awscli/examples/iot/list-role-aliases.rst new file mode 100644 index 00000000..c6bf93b2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-role-aliases.rst @@ -0,0 +1,16 @@ +**To list the AWS IoT role aliases in your AWS account** + +The following ``list-role-aliases`` example lists the AWS IoT role aliases in your AWS account. :: + + aws iot list-role-aliases + +Output:: + + { + "roleAliases": [ + "ResidentAlias", + "ElectricianAlias" + ] + } + +For more information, see `ListRoleAliases `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-scheduled-audits.rst b/aws/dist/awscli/examples/iot/list-scheduled-audits.rst new file mode 100644 index 00000000..15e1efba --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-scheduled-audits.rst @@ -0,0 +1,25 @@ +**To list the scheduled audits for your AWS account** + +The following ``list-scheduled-audits`` example lists any audits scheduled for your AWS account. :: + + aws iot list-scheduled-audits + +Output:: + + { + "scheduledAudits": [ + { + "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit", + "frequency": "DAILY" + }, + { + "scheduledAuditName": "AWSDeviceDefenderWeeklyAudit", + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSDeviceDefenderWeeklyAudit", + "frequency": "WEEKLY", + "dayOfWeek": "SUN" + } + ] + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-security-profiles-for-target.rst b/aws/dist/awscli/examples/iot/list-security-profiles-for-target.rst new file mode 100644 index 00000000..a364d765 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-security-profiles-for-target.rst @@ -0,0 +1,24 @@ +**To list the security profiles attached to a target** + +The following ``list-security-profiles-for-target`` example lists the AWS IoT Device Defender security profiles that are attached to unregistered devices. :: + + aws iot list-security-profiles-for-target \ + --security-profile-target-arn "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + +Output:: + + { + "securityProfileTargetMappings": [ + { + "securityProfileIdentifier": { + "name": "Testprofile", + "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" + }, + "target": { + "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + } + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-security-profiles.rst b/aws/dist/awscli/examples/iot/list-security-profiles.rst new file mode 100644 index 00000000..c0afac12 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-security-profiles.rst @@ -0,0 +1,18 @@ +**To list the security profiles for your AWS account** + +The following ``list-security-profiles`` example lists all AWS IoT Device Defender security profiles that are defined in your AWS account. :: + + aws iot list-security-profiles + +Output:: + + { + "securityProfileIdentifiers": [ + { + "name": "Testprofile", + "arn": "arn:aws:iot:us-west-2:123456789012:securityprofile/Testprofile" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-streams.rst b/aws/dist/awscli/examples/iot/list-streams.rst new file mode 100644 index 00000000..a491154d --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-streams.rst @@ -0,0 +1,26 @@ +**To list the streams in the account** + +The following ``list-streams`` example lists all of the streams in your AWS account. :: + + aws iot list-streams + +Output:: + + { + "streams": [ + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345." + }, + { + "streamId": "stream54321", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream54321", + "streamVersion": 1, + "description": "This stream is used for Amazon FreeRTOS OTA Update 54321." + } + ] + } + +For more information, see `ListStreams `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-tags-for-resource.rst b/aws/dist/awscli/examples/iot/list-tags-for-resource.rst new file mode 100644 index 00000000..e1ba3906 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-tags-for-resource.rst @@ -0,0 +1,23 @@ +**To display the tags and their values associated with a resource** + +The following ``list-tags-for-resource`` example displays the tags and values associated with the thing group ``LightBulbs``. :: + + aws iot list-tags-for-resource \ + --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" + +Output:: + + { + "tags": [ + { + "Key": "Assembly", + "Value": "Fact1NW" + }, + { + "Key": "MyTag", + "Value": "777" + } + ] + } + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-targets-for-policy.rst b/aws/dist/awscli/examples/iot/list-targets-for-policy.rst new file mode 100644 index 00000000..2553c6bf --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-targets-for-policy.rst @@ -0,0 +1,17 @@ +**To list the principals associated with an AWS IoT policy** + +The following ``list-targets-for-policy`` example lists the device certificates to which the specified policy is attached. :: + + aws iot list-targets-for-policy \ + --policy-name UpdateDeviceCertPolicy + +Output:: + + { + "targets": [ + "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "arn:aws:iot:us-west-2:123456789012:cert/d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be" + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-targets-for-security-profile.rst b/aws/dist/awscli/examples/iot/list-targets-for-security-profile.rst new file mode 100644 index 00000000..9187001c --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-targets-for-security-profile.rst @@ -0,0 +1,21 @@ +**To list the targets to which a security profile is applied** + +The following ``list-targets-for-security-profile`` example lists the targets to which the AWS IoT Device Defender security profile named ``PossibleIssue`` is applied. :: + + aws iot list-targets-for-security-profile \ + --security-profile-name Testprofile + +Output:: + + { + "securityProfileTargets": [ + { + "arn": "arn:aws:iot:us-west-2:123456789012:all/unregistered-things" + }, + { + "arn": "arn:aws:iot:us-west-2:123456789012:all/registered-things" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/list-thing-groups-for-thing.rst b/aws/dist/awscli/examples/iot/list-thing-groups-for-thing.rst new file mode 100644 index 00000000..69748cee --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-thing-groups-for-thing.rst @@ -0,0 +1,24 @@ +**To list the groups that a thing belongs to** + +The following ``list-thing-groups-for-thing`` example lists the groups to which the specified thing belongs. :: + + aws iot list-thing-groups-for-thing \ + --thing-name MyLightBulb + +Output:: + + { + "thingGroups": [ + { + "groupName": "DeadBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/DeadBulbs" + }, + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/list-thing-groups.rst b/aws/dist/awscli/examples/iot/list-thing-groups.rst new file mode 100644 index 00000000..5585985c --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-thing-groups.rst @@ -0,0 +1,23 @@ +**To list the thing groups defined in your AWS account** + +The following ``describe-thing-group`` example lists all thing groups defined in your AWS account. :: + + aws iot list-thing-groups + +Output:: + + { + "thingGroups": [ + { + "groupName": "HalogenBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/HalogenBulbs" + }, + { + "groupName": "LightBulbs", + "groupArn": "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" + } + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/list-thing-principals.rst b/aws/dist/awscli/examples/iot/list-thing-principals.rst new file mode 100644 index 00000000..d74606e5 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-thing-principals.rst @@ -0,0 +1,16 @@ +**To list the principals associated with a thing** + +The following ``list-thing-principals`` example lists the principals (X.509 certificates, IAM users, groups, roles, Amazon Cognito identities, or federated identities) associated with the specified thing. :: + + aws iot list-thing-principals \ + --thing-name MyRaspberryPi + +Output:: + + { + "principals": [ + "arn:aws:iot:us-west-2:123456789012:cert/33475ac865079a5ffd5ecd44240640349293facc760642d7d8d5dbb6b4c86893" + ] + } + +For more information, see `ListThingPrincipals `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/list-thing-types.rst b/aws/dist/awscli/examples/iot/list-thing-types.rst new file mode 100644 index 00000000..5cb2299c --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-thing-types.rst @@ -0,0 +1,29 @@ +**To list the defined thing types** + +The following ``list-thing-types`` example displays a list of thing types defined in your AWS account. :: + + aws iot list-thing-types + +Output:: + + { + "thingTypes": [ + { + "thingTypeName": "LightBulb", + "thingTypeArn": "arn:aws:iot:us-west-2:123456789012:thingtype/LightBulb", + "thingTypeProperties": { + "thingTypeDescription": "light bulb type", + "searchableAttributes": [ + "model", + "wattage" + ] + }, + "thingTypeMetadata": { + "deprecated": false, + "creationDate": 1559772562.498 + } + } + ] + } + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-things-in-billing-group.rst b/aws/dist/awscli/examples/iot/list-things-in-billing-group.rst new file mode 100644 index 00000000..2ba350f4 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-things-in-billing-group.rst @@ -0,0 +1,17 @@ +**To list the things in a billing group** + +The following ``list-things-in-billing-group`` example lists the things that are in the specified billing group. :: + + aws iot list-things-in-billing-group \ + --billing-group-name GroupOne + +Output:: + + { + "things": [ + "MyOtherLightBulb", + "MyLightBulb" + ] + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-things-in-thing-group.rst b/aws/dist/awscli/examples/iot/list-things-in-thing-group.rst new file mode 100644 index 00000000..4ac5b1fe --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-things-in-thing-group.rst @@ -0,0 +1,16 @@ +**To list the things that belong to a group** + +The following ``list-things-in-thing-group`` example lists the things that belong to the specified thing group. :: + + aws iot list-things-in-thing-group \ + --thing-group-name LightBulbs + +Output:: + + { + "things": [ + "MyLightBulb" + ] + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-things.rst b/aws/dist/awscli/examples/iot/list-things.rst new file mode 100644 index 00000000..4a62e048 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-things.rst @@ -0,0 +1,84 @@ +**Example 1: To list all things in the registry** + +The following ``list-things`` example lists the things (devices) that are defined in the AWS IoT registry for your AWS account. :: + + aws iot list-things + +Output:: + + { + "things": [ + { + "thingName": "ThirdBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/ThirdBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 2 + }, + { + "thingName": "MyOtherLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 3 + }, + { + "thingName": "MyLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + }, + { + "thingName": "SampleIoTThing", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/SampleIoTThing", + "attributes": {}, + "version": 1 + } + ] + } + +**Example 2: To list the defined things that have a specific attribute** + +The following ``list-things`` example displays a list of things that have an attribute named ``wattage``. :: + + aws iot list-things \ + --attribute-name wattage + +Output:: + + { + "things": [ + { + "thingName": "MyLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 1 + }, + { + "thingName": "MyOtherLightBulb", + "thingTypeName": "LightBulb", + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MyOtherLightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "version": 3 + } + ] + } + +For more information, see `How to Manage Things with the Registry `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-topic-rules.rst b/aws/dist/awscli/examples/iot/list-topic-rules.rst new file mode 100644 index 00000000..681bd10d --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-topic-rules.rst @@ -0,0 +1,28 @@ +**To list your rules** + +The following ``list-topic-rules`` example lists all rules that you have defined. :: + + aws iot list-topic-rules + +Output:: + + { + "rules": [ + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyRPiLowMoistureAlertRule", + "ruleName": "MyRPiLowMoistureAlertRule", + "topicPattern": "$aws/things/MyRPi/shadow/update/accepted", + "createdAt": 1558624363.0, + "ruleDisabled": false + }, + { + "ruleArn": "arn:aws:iot:us-west-2:123456789012:rule/MyPlantPiMoistureAlertRule", + "ruleName": "MyPlantPiMoistureAlertRule", + "topicPattern": "$aws/things/MyPlantPi/shadow/update/accepted", + "createdAt": 1541458459.0, + "ruleDisabled": false + } + ] + } + +For more information, see `Viewing Your Rules `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/list-v2-logging-levels.rst b/aws/dist/awscli/examples/iot/list-v2-logging-levels.rst new file mode 100644 index 00000000..7700af33 --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-v2-logging-levels.rst @@ -0,0 +1,18 @@ +**To list logging levels** + +The following ``list-v2-logging-levels`` example lists the configured logging levels. If logging levels were not set, a ``NotConfiguredException`` occurs when you run this command. :: + + aws iot list-v2-logging-levels + +Output:: + + { + "logTargetConfigurations": [ + { + "logTarget": { + "targetType": "DEFAULT" + }, + "logLevel": "ERROR" + } + ] + } diff --git a/aws/dist/awscli/examples/iot/list-violation-events.rst b/aws/dist/awscli/examples/iot/list-violation-events.rst new file mode 100644 index 00000000..27fc197c --- /dev/null +++ b/aws/dist/awscli/examples/iot/list-violation-events.rst @@ -0,0 +1,107 @@ +**To list the security profile violations during a time period** + +The following ``list-violation-events`` example lists violations that occurred between June 5, 2019 and June 12, 2019 for all AWS IoT Device Defender security profiles for the current AWS account and AWS Region. :: + + aws iot list-violation-events \ + --start-time 1559747125 \ + --end-time 1560351925 + +Output:: + + { + "violationEvents": [ + { + "violationId": "174db59167fa474c80a652ad1583fd44", + "thingName": "iotconsole-1560269126751-1", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560279000.0 + }, + { + "violationId": "c8a9466a093d3b7b35cd44ca58bdbeab", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 110 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + }, + { + "violationId": "74aa393adea02e6648f3ac362beed55e", + "thingName": "iotconsole-1560269232412-2", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + }, + { + "violationId": "1e6ab5f7cf39a1466fcd154e1377e406", + "thingName": "TvnQoEoU", + "securityProfileName": "Testprofile", + "behavior": { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 10 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + "metricValue": { + "count": 0 + }, + "violationEventType": "in-alarm", + "violationEventTime": 1560276600.0 + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/register-ca-certificate.rst b/aws/dist/awscli/examples/iot/register-ca-certificate.rst new file mode 100644 index 00000000..a529da58 --- /dev/null +++ b/aws/dist/awscli/examples/iot/register-ca-certificate.rst @@ -0,0 +1,16 @@ +**To register a certificate authority (CA) certificate** + +The following ``register-ca-certificate`` example registers a CA certificate. The command supplies the CA certificate and a key verification certificate that proves you own the private key associated with the CA certificate. :: + + aws iot register-ca-certificate \ + --ca-certificate file://rootCA.pem \ + --verification-cert file://verificationCert.pem + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cacert/f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467", + "certificateId": "f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467" + } + +For more information, see `RegisterCACertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/register-certificate.rst b/aws/dist/awscli/examples/iot/register-certificate.rst new file mode 100644 index 00000000..f63e3de2 --- /dev/null +++ b/aws/dist/awscli/examples/iot/register-certificate.rst @@ -0,0 +1,16 @@ +**To register a self signed device certificate** + +The following ``register-certificate`` example registers the ``deviceCert.pem`` device certificate signed by the ``rootCA.pem`` CA certificate. The CA certificate must be registered before you use it to register a self-signed device certificate. The self-signed certificate must be signed by the same CA certificate you pass to this command. :: + + aws iot register-certificate \ + --certificate-pem file://deviceCert.pem \ + --ca-certificate-pem file://rootCA.pem + +Output:: + + { + "certificateArn": "arn:aws:iot:us-west-2:123456789012:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142", + "certificateId": "488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" + } + +For more information, see `RegisterCertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/reject-certificate-transfer.rst b/aws/dist/awscli/examples/iot/reject-certificate-transfer.rst new file mode 100644 index 00000000..d08784da --- /dev/null +++ b/aws/dist/awscli/examples/iot/reject-certificate-transfer.rst @@ -0,0 +1,10 @@ +**To reject a certificate transfer** + +The following ``reject-certificate-transfer`` example rejects the transfer of the specified device certificate from another AWS account. :: + + aws iot reject-certificate-transfer \ + --certificate-id f0f33678c7c9a046e5cc87b2b1a58dfa0beec26db78addd5e605d630e05c7fc8 + +This command produces no output. + +For more information, see `RejectCertificateTransfer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/remove-thing-from-billing-group.rst b/aws/dist/awscli/examples/iot/remove-thing-from-billing-group.rst new file mode 100644 index 00000000..448b62d6 --- /dev/null +++ b/aws/dist/awscli/examples/iot/remove-thing-from-billing-group.rst @@ -0,0 +1,12 @@ +**To remove a thing from a billing group** + +The following ``remove-thing-from-billing-group`` example removes the specified thing from a billing group. :: + + aws iot remove-thing-from-billing-group \ + --billing-group-name GroupOne \ + --thing-name MyOtherLightBulb + +This command produces no output. + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/remove-thing-from-thing-group.rst b/aws/dist/awscli/examples/iot/remove-thing-from-thing-group.rst new file mode 100644 index 00000000..00581f79 --- /dev/null +++ b/aws/dist/awscli/examples/iot/remove-thing-from-thing-group.rst @@ -0,0 +1,12 @@ +**To remove a thing from a thing group** + +The following ``remove-thing-from-thing-group`` example removes the specified thing from a thing group. :: + + aws iot remove-thing-from-thing-group \ + --thing-name bulb7 \ + --thing-group-name DeadBulbs + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/replace-topic-rule.rst b/aws/dist/awscli/examples/iot/replace-topic-rule.rst new file mode 100644 index 00000000..3a355b95 --- /dev/null +++ b/aws/dist/awscli/examples/iot/replace-topic-rule.rst @@ -0,0 +1,11 @@ +**To update a topic's rule definition** + +The following ``replace-topic-rule`` example updates the specified rule to send an SNS alert when soil moisture level readings are too low. :: + + aws iot replace-topic-rule \ + --rule-name MyRPiLowMoistureAlertRule \ + --topic-rule-payload "{\"sql\": \"SELECT * FROM '$aws/things/MyRPi/shadow/update/accepted' WHERE state.reported.moisture = 'low'\", \"description\": \"Sends an alert when soil moisture level readings are too low.\",\"actions\": [{\"sns\":{\"targetArn\":\"arn:aws:sns:us-west-2:123456789012:MyRPiLowMoistureTopic\",\"roleArn\":\"arn:aws:iam::123456789012:role/service-role/MyRPiLowMoistureTopicRole\",\"messageFormat\": \"RAW\"}}],\"ruleDisabled\": false,\"awsIotSqlVersion\":\"2016-03-23\"}" + +This command produces no output. + +For more information, see `Creating an AWS IoT Rule `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/search-index.rst b/aws/dist/awscli/examples/iot/search-index.rst new file mode 100644 index 00000000..092341fa --- /dev/null +++ b/aws/dist/awscli/examples/iot/search-index.rst @@ -0,0 +1,56 @@ +**To query the thing index** + +The following ``search-index`` example queries the ``AWS_Things`` index for things that have a type of ``LightBulb``. :: + + aws iot search-index \ + --index-name "AWS_Things" \ + --query-string "thingTypeName:LightBulb" + +Output:: + + { + "things": [ + { + "thingName": "MyLightBulb", + "thingId": "40da2e73-c6af-406e-b415-15acae538797", + "thingTypeName": "LightBulb", + "thingGroupNames": [ + "LightBulbs", + "DeadBulbs" + ], + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + }, + { + "thingName": "ThirdBulb", + "thingId": "615c8455-33d5-40e8-95fd-3ee8b24490af", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + }, + { + "thingName": "MyOtherLightBulb", + "thingId": "6dae0d3f-40c1-476a-80c4-1ed24ba6aa11", + "thingTypeName": "LightBulb", + "attributes": { + "model": "123", + "wattage": "75" + }, + "connectivity": { + "connected": false + } + } + ] + } + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/set-default-authorizer.rst b/aws/dist/awscli/examples/iot/set-default-authorizer.rst new file mode 100644 index 00000000..da50e5d5 --- /dev/null +++ b/aws/dist/awscli/examples/iot/set-default-authorizer.rst @@ -0,0 +1,15 @@ +**To set a default authorizer** + +The following ``set-default-authorizer`` example sets the custom authorizer named ``CustomAuthorizer`` as the default authorizer. :: + + aws iot set-default-authorizer \ + --authorizer-name CustomAuthorizer + +Output:: + + { + "authorizerName": "CustomAuthorizer", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer" + } + +For more information, see `CreateDefaultAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/set-default-policy-version.rst b/aws/dist/awscli/examples/iot/set-default-policy-version.rst new file mode 100644 index 00000000..9d39a69e --- /dev/null +++ b/aws/dist/awscli/examples/iot/set-default-policy-version.rst @@ -0,0 +1,9 @@ +**To set the default version for a policy** + +The following ``set-default-policy-version`` example sets the default version to ``2`` for the policy named ``UpdateDeviceCertPolicy``. :: + + aws iot set-default-policy-version \ + --policy-name UpdateDeviceCertPolicy \ + --policy-version-id 2 + +This command produces no output. diff --git a/aws/dist/awscli/examples/iot/set-v2-logging-level.rst b/aws/dist/awscli/examples/iot/set-v2-logging-level.rst new file mode 100644 index 00000000..6217535e --- /dev/null +++ b/aws/dist/awscli/examples/iot/set-v2-logging-level.rst @@ -0,0 +1,10 @@ +**To set the logging level for a thing group** + +The following ``set-v2-logging-level`` example sets the logging level to log warnings for the specified thing group. :: + + aws iot set-v2-logging-level \ + --log-target "{\"targetType\":\"THING_GROUP\",\"targetName\":\"LightBulbs\"}" \ + --log-level WARN + + +This command produces no output. diff --git a/aws/dist/awscli/examples/iot/set-v2-logging-options.rst b/aws/dist/awscli/examples/iot/set-v2-logging-options.rst new file mode 100644 index 00000000..ee83196d --- /dev/null +++ b/aws/dist/awscli/examples/iot/set-v2-logging-options.rst @@ -0,0 +1,9 @@ +**To set the logging options** + +The following ``set-v2-logging-options`` example sets the default logging verbosity level to ERROR and specifies the ARN to use for logging. :: + + aws iot set-v2-logging-options \ + --default-log-level ERROR \ + --role-arn "arn:aws:iam::094249569039:role/service-role/iotLoggingRole" + +This command produces no output. diff --git a/aws/dist/awscli/examples/iot/start-on-demand-audit-task.rst b/aws/dist/awscli/examples/iot/start-on-demand-audit-task.rst new file mode 100644 index 00000000..d85687e4 --- /dev/null +++ b/aws/dist/awscli/examples/iot/start-on-demand-audit-task.rst @@ -0,0 +1,14 @@ +**To start an audit right away** + +The following ``start-on-demand-audit-task`` example starts an AWS IoT Device Defender audit and performs three certificate checks. :: + + aws iot start-on-demand-audit-task \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK + +Output:: + + { + "taskId": "a3aea009955e501a31b764abe1bebd3d" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/tag-resource.rst b/aws/dist/awscli/examples/iot/tag-resource.rst new file mode 100644 index 00000000..555b7a62 --- /dev/null +++ b/aws/dist/awscli/examples/iot/tag-resource.rst @@ -0,0 +1,11 @@ +**To specify a tag key and value for a resource** + +The following ``tag-resource`` example applies the tag with a key ``Assembly`` and the value ``Fact1NW`` to the thing group ``LightBulbs``. :: + + aws iot tag-resource \ + --tags Key=Assembly,Value="Fact1NW" \ + --resource-arn "arn:aws:iot:us-west-2:094249569039:thinggroup/LightBulbs" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/test-authorization.rst b/aws/dist/awscli/examples/iot/test-authorization.rst new file mode 100644 index 00000000..deb41afe --- /dev/null +++ b/aws/dist/awscli/examples/iot/test-authorization.rst @@ -0,0 +1,52 @@ +**To test your AWS IoT policies** + +The following ``test-authorization`` example tests the AWS IoT policies associated with the specified principal. :: + + aws iot test-authorization \ + --auth-infos actionType=CONNECT,resources=arn:aws:iot:us-east-1:123456789012:client/client1 \ + --principal arn:aws:iot:us-west-2:123456789012:cert/aab1068f7f43ac3e3cae4b3a8aa3f308d2a750e6350507962e32c1eb465d9775 + +Output:: + + { + "authResults": [ + { + "authInfo": { + "actionType": "CONNECT", + "resources": [ + "arn:aws:iot:us-east-1:123456789012:client/client1" + ] + }, + "allowed": { + "policies": [ + { + "policyName": "TestPolicyAllowed", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyAllowed" + } + ] + }, + "denied": { + "implicitDeny": { + "policies": [ + { + "policyName": "TestPolicyDenied", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyDenied" + } + ] + }, + "explicitDeny": { + "policies": [ + { + "policyName": "TestPolicyExplicitDenied", + "policyArn": "arn:aws:iot:us-west-2:123456789012:policy/TestPolicyExplicitDenied" + } + ] + } + }, + "authDecision": "IMPLICIT_DENY", + "missingContextValues": [] + } + ] + } + +For more information, see `TestAuthorization `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/test-invoke-authorizer.rst b/aws/dist/awscli/examples/iot/test-invoke-authorizer.rst new file mode 100644 index 00000000..5a25f55c --- /dev/null +++ b/aws/dist/awscli/examples/iot/test-invoke-authorizer.rst @@ -0,0 +1,22 @@ +**To test your custom authorizer** + +The following ``test-invoke-authorizer`` example testS your custom authorizer. :: + + aws iot test-invoke-authorizer \ + --authorizer-name IoTAuthorizer \ + --token allow \ + --token-signature "mE0GvaHqy9nER/FdgtJX5lXYEJ3b3vE7t1gEszc0TKGgLKWXTnPkb2AbKnOAZ8lGyoN5dVtWDWVmr25m7++zjbYIMk2TBvyGXhOmvKFBPkdgyA43KL6SiZy0cTqlPMcQDsP7VX2rXr7CTowCxSNKphGXdQe0/I5dQ+JO6KUaHwCmupt0/MejKtaNwiia064j6wprOAUwG5S1IYFuRd0X+wfo8pb0DubAIX1Ua705kuhRUcTx4SxUShEYKmN4IDEvLB6FsIr0B2wvB7y4iPmcajxzGl02ExvyCUNctCV9dYlRRGJj0nsGzBIXOI4sGytPfqlA7obdgmN22pkDzYvwjQ==" + +Output:: + + { + "isAuthenticated": true, + "principalId": "principalId", + "policyDocuments": [ + "{"Version":"2012-10-17","Statement":[{"Action":"iot:Publish","Effect":"Allow","Resource":"arn:aws:iot:us-west-2:123456789012:topic/customauthtesting"}]}" + ], + "refreshAfterInSeconds": 600, + "disconnectAfterInSeconds": 3600 + } + +For more information, see `TestInvokeAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/transfer-certificate.rst b/aws/dist/awscli/examples/iot/transfer-certificate.rst new file mode 100644 index 00000000..e0fc64d3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/transfer-certificate.rst @@ -0,0 +1,15 @@ +**To transfer a device certificate to a different AWS account** + +The following ``transfer-certificate`` example transfers a device certificate to another AWS account. The certificate and AWS account are identified by ID. :: + + aws iot transfer-certificate \ + --certificate-id 488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142 \ + --target-aws-account 030714055129 + +Output:: + + { + "transferredCertificateArn": "arn:aws:iot:us-west-2:030714055129:cert/488b6a7f2acdeb00a77384e63c4e40b18b1b3caaae57b7272ba44c45e3448142" + } + +For more information, see `TransferCertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/untag-resource.rst b/aws/dist/awscli/examples/iot/untag-resource.rst new file mode 100644 index 00000000..0ddf1e00 --- /dev/null +++ b/aws/dist/awscli/examples/iot/untag-resource.rst @@ -0,0 +1,9 @@ +**To remove a tag key from a resource** + +The following ``untag-resource`` example removes the tag ``MyTag`` and its value from the thing group ``LightBulbs``. :: + + command + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Resources `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-account-audit-configuration.rst b/aws/dist/awscli/examples/iot/update-account-audit-configuration.rst new file mode 100644 index 00000000..79f8e110 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-account-audit-configuration.rst @@ -0,0 +1,19 @@ +**Example 1: To enable Amazon SNS notifications for audit notifications** + +The following ``update-account-audit-configuration`` example enables Amazon SNS notifications for AWS IoT Device Defender audit notifications, specifying a target and the role used to write to that target. :: + + aws iot update-account-audit-configuration \ + --audit-notification-target-configurations "SNS={targetArn=\"arn:aws:sns:us-west-2:123456789012:ddaudits\",roleArn=\"arn:aws:iam::123456789012:role/service-role/AWSIoTDeviceDefenderAudit\",enabled=true}" + +This command produces no output. + +**Example 2: To enable an audit check** + +The following ``update-account-audit-configuration`` example enables the AWS IoT Device Defender audit check named ``AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK``. You cannot disable an audit check if it is part of the ``targetCheckNames`` for one or more scheduled audits for the AWS account. :: + + aws iot update-account-audit-configuration \ + --audit-check-configurations "{\"AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK\":{\"enabled\":true}}" + +This command produces no output. + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-authorizer.rst b/aws/dist/awscli/examples/iot/update-authorizer.rst new file mode 100644 index 00000000..b8470b04 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-authorizer.rst @@ -0,0 +1,16 @@ +**To update a custom authorizer** + +The following ``update-authorizer`` example he state of ``CustomAuthorizer2`` to ``INACTIVE``. :: + + aws iot update-authorizer \ + --authorizer-name CustomAuthorizer2 \ + --status INACTIVE + +Output:: + + { + "authorizerName": "CustomAuthorizer2", + "authorizerArn": "arn:aws:iot:us-west-2:123456789012:authorizer/CustomAuthorizer2" + } + +For more information, see `UpdateAuthorizer `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/update-billing-group.rst b/aws/dist/awscli/examples/iot/update-billing-group.rst new file mode 100644 index 00000000..625c40ac --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-billing-group.rst @@ -0,0 +1,15 @@ +**To update information about a billing group** + +The following ``update-billing-group`` example updates the description for the specified billing group. :: + + aws iot update-billing-group \ + --billing-group-name GroupOne \ + --billing-group-properties "billingGroupDescription=\"Primary bulb billing group\"" + +Output:: + + { + "version": 2 + } + +For more information, see `Billing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/update-ca-certificate.rst b/aws/dist/awscli/examples/iot/update-ca-certificate.rst new file mode 100644 index 00000000..bb0e9554 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-ca-certificate.rst @@ -0,0 +1,11 @@ +**To update a certificate authority (CA) certificate** + +The following ``update-ca-certificate`` example sets the specified CA certificate to ACTIVE status. :: + + aws iot update-ca-certificate \ + --certificate-id f4efed62c0142f16af278166f61962501165c4f0536295207426460058cd1467 \ + --new-status ACTIVE + +This command produces no output. + +For more information, see `UpdateCACertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/update-certificate.rst b/aws/dist/awscli/examples/iot/update-certificate.rst new file mode 100644 index 00000000..ba5a8195 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-certificate.rst @@ -0,0 +1,11 @@ +**To update a device certificate** + +The following ``update-certificate`` example sets the specified device certificate to INACTIVE status. :: + + aws iot update-certificate \ + --certificate-id d1eb269fb55a628552143c8f96eb3c258fcd5331ea113e766ba0c82bf225f0be \ + --new-status INACTIVE + +This command produces no output. + +For more information, see `UpdateCertificate `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/update-dynamic-thing-group.rst b/aws/dist/awscli/examples/iot/update-dynamic-thing-group.rst new file mode 100644 index 00000000..b5757468 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-dynamic-thing-group.rst @@ -0,0 +1,16 @@ +**To update a dynamic thing group** + +The following ``update-dynamic-thing-group`` example updates the specified dynamic thing group. It provides a description and updates the query string to change the group membership criteria. :: + + aws iot update-dynamic-thing-group \ + --thing-group-name "RoomTooWarm" + --thing-group-properties "thingGroupDescription=\"This thing group contains rooms warmer than 65F.\"" \ + --query-string "attributes.temperature>65" + +Output:: + + { + "version": 2 + } + +For more information, see `Dynamic Thing Groups `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/update-event-configurations.rst b/aws/dist/awscli/examples/iot/update-event-configurations.rst new file mode 100644 index 00000000..d20a3887 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-event-configurations.rst @@ -0,0 +1,10 @@ +**To show which event types are published** + +The following ``update-event-configurations`` example updates the configuration to enable messages when the CA certificate is added, updated, or deleted. :: + + aws iot update-event-configurations \ + --event-configurations "{\"CA_CERTIFICATE\":{\"Enabled\":true}}" + +This command produces no output. + +For more information, see `Event Messages `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-indexing-configuration.rst b/aws/dist/awscli/examples/iot/update-indexing-configuration.rst new file mode 100644 index 00000000..c1fe36cb --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-indexing-configuration.rst @@ -0,0 +1,11 @@ +**To enable thing indexing** + +The following ``update-indexing-configuration`` example enables thing indexing to support searching registry data, shadow data, and thing connectivity status using the AWS_Things index. :: + + aws iot update-indexing-configuration + --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS + +This command produces no output. + +For more information, see `Managing Thing Indexing `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/update-job.rst b/aws/dist/awscli/examples/iot/update-job.rst new file mode 100644 index 00000000..e6002d43 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-job.rst @@ -0,0 +1,38 @@ +**To get detailed status for a job** + +The following ``update-job`` example gets detailed status for the job whose ID is ``example-job-01``. :: + + aws iot describe-job \ + --job-id "example-job-01" + +Output:: + + { + "job": { + "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-01", + "jobId": "example-job-01", + "targetSelection": "SNAPSHOT", + "status": "IN_PROGRESS", + "targets": [ + "arn:aws:iot:us-west-2:123456789012:thing/MyRaspberryPi" + ], + "description": "example job test", + "presignedUrlConfig": {}, + "jobExecutionsRolloutConfig": {}, + "createdAt": 1560787022.733, + "lastUpdatedAt": 1560787026.294, + "jobProcessDetails": { + "numberOfCanceledThings": 0, + "numberOfSucceededThings": 0, + "numberOfFailedThings": 0, + "numberOfRejectedThings": 0, + "numberOfQueuedThings": 1, + "numberOfInProgressThings": 0, + "numberOfRemovedThings": 0, + "numberOfTimedOutThings": 0 + }, + "timeoutConfig": {} + } + } + +For more information, see `Creating and Managing Jobs (CLI) `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-role-alias.rst b/aws/dist/awscli/examples/iot/update-role-alias.rst new file mode 100644 index 00000000..342f1ed4 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-role-alias.rst @@ -0,0 +1,16 @@ +**To update a role alias** + +The following ``update-role-alias`` example updates the ``LightBulbRole`` role alias. :: + + aws iot update-role-alias \ + --role-alias LightBulbRole \ + --role-arn arn:aws:iam::123456789012:role/lightbulbrole-001 + +Output:: + + { + "roleAlias": "LightBulbRole", + "roleAliasArn": "arn:aws:iot:us-west-2:123456789012:rolealias/LightBulbRole" + } + +For more information, see `UpdateRoleAlias `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/update-scheduled-audit.rst b/aws/dist/awscli/examples/iot/update-scheduled-audit.rst new file mode 100644 index 00000000..b160fbb3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-scheduled-audit.rst @@ -0,0 +1,15 @@ +**To update a scheduled audit definition** + +The following ``update-scheduled-audit`` example changes the target check names for an AWS IoT Device Defender scheduled audit. :: + + aws iot update-scheduled-audit \ + --scheduled-audit-name WednesdayCertCheck \ + --target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK + +Output:: + + { + "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck" + } + +For more information, see `Audit Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-security-profile.rst b/aws/dist/awscli/examples/iot/update-security-profile.rst new file mode 100644 index 00000000..6e359494 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-security-profile.rst @@ -0,0 +1,48 @@ +**To change a security profile** + +The following ``update-security-profile`` example updates both the description and the behaviors for an AWS IoT Device Defender security profile. :: + + aws iot update-security-profile \ + --security-profile-name PossibleIssue \ + --security-profile-description "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128" \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "securityProfileName": "PossibleIssue", + "securityProfileArn": "arn:aws:iot:us-west-2:123456789012:securityprofile/PossibleIssue", + "securityProfileDescription": "check to see if authorization fails 12 times in 5 minutes or if cellular bandwidth exceeds 128", + "behaviors": [ + { + "name": "CellularBandwidth", + "metric": "aws:message-byte-size", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 128 + }, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + }, + { + "name": "Authorization", + "metric": "aws:num-authorization-failures", + "criteria": { + "comparisonOperator": "greater-than", + "value": { + "count": 12 + }, + "durationSeconds": 300, + "consecutiveDatapointsToAlarm": 1, + "consecutiveDatapointsToClear": 1 + } + } + ], + "version": 2, + "creationDate": 1560278102.528, + "lastModifiedDate": 1560352711.207 + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-stream.rst b/aws/dist/awscli/examples/iot/update-stream.rst new file mode 100644 index 00000000..cacd396b --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-stream.rst @@ -0,0 +1,34 @@ +**To update a stream** + +The following ``update-stream`` example updates an existing stream. The stream version is incremented by one. :: + + aws iot update-stream \ + --cli-input-json file://update-stream.json + +Contents of ``update-stream.json``:: + + { + "streamId": "stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "files": [ + { + "fileId": 123, + "s3Location": { + "bucket":"codesign-ota-bucket", + "key":"48c67f3c-63bb-4f92-a98a-4ee0fbc2bef6" + } + } + ] + "roleArn": "arn:aws:iam:us-west-2:123456789012:role/service-role/my_ota_stream_role" + } + +Output:: + + { + "streamId": "stream12345", + "streamArn": "arn:aws:iot:us-west-2:123456789012:stream/stream12345", + "description": "This stream is used for Amazon FreeRTOS OTA Update 12345.", + "streamVersion": 2 + } + +For more information, see `UpdateStream `__ in the *AWS IoT API Reference*. diff --git a/aws/dist/awscli/examples/iot/update-thing-group.rst b/aws/dist/awscli/examples/iot/update-thing-group.rst new file mode 100644 index 00000000..0a42a466 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-thing-group.rst @@ -0,0 +1,16 @@ +**To update the definition for a thing group** + +The following ``update-thing-group`` example updates the definition for the specified thing group, changing the description and two attributes. :: + + aws iot update-thing-group \ + --thing-group-name HalogenBulbs \ + --thing-group-properties "thingGroupDescription=\"Halogen bulb group\", attributePayload={attributes={Manufacturer=AnyCompany,wattage=60}}" + +Output:: + + { + "version": 2 + } + +For more information, see `Thing Groups `__ in the *AWS IoT Developers Guide*. + diff --git a/aws/dist/awscli/examples/iot/update-thing-groups-for-thing.rst b/aws/dist/awscli/examples/iot/update-thing-groups-for-thing.rst new file mode 100644 index 00000000..02c54a20 --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-thing-groups-for-thing.rst @@ -0,0 +1,12 @@ +**To change the groups to which a thing belongs** + +The following ``update-thing-groups-for-thing`` example removes the thing named ``MyLightBulb`` from the group named ``DeadBulbs`` and adds it to the group named ``replaceableItems`` at the same time. :: + + aws iot update-thing-groups-for-thing \ + --thing-name MyLightBulb \ + --thing-groups-to-add "replaceableItems" \ + --thing-groups-to-remove "DeadBulbs" + +This command produces no output. + +For more information, see `Thing Groups `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot/update-thing.rst b/aws/dist/awscli/examples/iot/update-thing.rst new file mode 100644 index 00000000..085e334d --- /dev/null +++ b/aws/dist/awscli/examples/iot/update-thing.rst @@ -0,0 +1,12 @@ +**To associate a thing with a thing type** + +The following ``update-thing`` example associates a thing in the AWS IoT registry with a thing type. When you make the association, you provide values for the attributes defined by the thing type. :: + + aws iot update-thing \ + --thing-name "MyOtherLightBulb" \ + --thing-type-name "LightBulb" \ + --attribute-payload "{"attributes": {"wattage":"75", "model":"123"}}" + +This command does not produce output. Use the ``describe-thing`` command to see the result. + +For more information, see `Thing Types `__ in the *AWS IoT Developers Guide*. diff --git a/aws/dist/awscli/examples/iot/validate-security-profile-behaviors.rst b/aws/dist/awscli/examples/iot/validate-security-profile-behaviors.rst new file mode 100644 index 00000000..e9a87ee3 --- /dev/null +++ b/aws/dist/awscli/examples/iot/validate-security-profile-behaviors.rst @@ -0,0 +1,33 @@ +**Example 1: To validate the behaviors parameters for a security profile** + +The following ``validate-security-profile-behaviors`` example validates a well-formed and correct set of behaviors for an AWS IoT Device Defender security profile. :: + + aws iot validate-security-profile-behaviors \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "valid": true, + "validationErrors": [] + } + +**Example 2: To validate incorrect behaviors parameters for a security profile** + +The following ``validate-security-profile-behaviors`` example validates a set of behaviors that contains an error for an AWS IoT Device Defender security profile. :: + + aws iot validate-security-profile-behaviors \ + --behaviors "[{\"name\":\"CellularBandwidth\",\"metric\":\"aws:message-byte-size\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":128},\"consecutiveDatapointsToAlarm\":1,\"consecutiveDatapointsToClear\":1}},{\"name\":\"Authorization\",\"metric\":\"aws:num-authorization-failures\",\"criteria\":{\"comparisonOperator\":\"greater-than\",\"value\":{\"count\":12},\"durationSeconds\":300,\"consecutiveDatapointsToAlarm\":100000,\"consecutiveDatapointsToClear\":1}}]" + +Output:: + + { + "valid": false, + "validationErrors": [ + { + "errorMessage": "Behavior Authorization is malformed. consecutiveDatapointsToAlarm 100000 should be in range[1,10]" + } + ] + } + +For more information, see `Detect Commands `__ in the *AWS IoT Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst b/aws/dist/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst new file mode 100644 index 00000000..6cc1c3eb --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/claim-devices-by-claim-code.rst @@ -0,0 +1,15 @@ +**To claim one or more AWS IoT 1-Click devices using a claim code** + +The following ``claim-devices-by-claim-code`` example claims the specified AWS IoT 1-Click device using a claim code (instead of a device ID). :: + + aws iot1click-devices claim-devices-by-claim-code \ + --claim-code C-123EXAMPLE + +Output:: + + { + "Total": 9 + "ClaimCode": "C-123EXAMPLE" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/describe-device.rst b/aws/dist/awscli/examples/iot1click-devices/describe-device.rst new file mode 100644 index 00000000..b89d99bc --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/describe-device.rst @@ -0,0 +1,27 @@ +**To describe a device** + +The following ``describe-device`` example describes the specified device. :: + + aws iot1click-devices describe-device \ + --device-id G030PM0123456789 + +Output:: + + { + "DeviceDescription": { + "Arn": "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789", + "Attributes": { + "projectRegion": "us-west-2", + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "deviceTemplateName": "empty-dumpster-request" + }, + "DeviceId": "G030PM0123456789", + "Enabled": false, + "RemainingLife": 99.9, + "Type": "button", + "Tags": {} + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/finalize-device-claim.rst b/aws/dist/awscli/examples/iot1click-devices/finalize-device-claim.rst new file mode 100644 index 00000000..6999dc44 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/finalize-device-claim.rst @@ -0,0 +1,14 @@ +**To finalize a claim request for an AWS IoT 1-Click device using a device ID** + +The following ``finalize-device-claim`` example finalizes a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). :: + + aws iot1click-devices finalize-device-claim \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "CLAIMED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/get-device-methods.rst b/aws/dist/awscli/examples/iot1click-devices/get-device-methods.rst new file mode 100644 index 00000000..df8392d9 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/get-device-methods.rst @@ -0,0 +1,30 @@ +**To list the available methods for a device** + +The following ``get-device-methods`` example lists the available methods for a device. :: + + aws iot1click-devices get-device-methods \ + --device-id G030PM0123456789 + +Output:: + + { + "DeviceMethods": [ + { + "MethodName": "getDeviceHealthParameters" + }, + { + "MethodName": "setDeviceHealthMonitorCallback" + }, + { + "MethodName": "getDeviceHealthMonitorCallback" + }, + { + "MethodName": "setOnClickCallback" + }, + { + "MethodName": "getOnClickCallback" + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/initiate-device-claim.rst b/aws/dist/awscli/examples/iot1click-devices/initiate-device-claim.rst new file mode 100644 index 00000000..1899d1de --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/initiate-device-claim.rst @@ -0,0 +1,14 @@ +**To initiate a claim request for an AWS IoT 1-Click device using a device ID** + +The following ``initiate-device-claim`` example initiates a claim request for the specified AWS IoT 1-Click device using a device ID (instead of a claim code). :: + + aws iot1click-devices initiate-device-claim \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "CLAIM_INITIATED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/invoke-device-method.rst b/aws/dist/awscli/examples/iot1click-devices/invoke-device-method.rst new file mode 100644 index 00000000..26889f1b --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/invoke-device-method.rst @@ -0,0 +1,24 @@ +**To invoke a device method on a device** + +The following ``invoke-device-method`` example invokes the specified method on a device. :: + + aws iot1click-devices invoke-device-method \ + --cli-input-json file://invoke-device-method.json + +Contents of ``invoke-device-method.json``:: + + { + "DeviceId": "G030PM0123456789", + "DeviceMethod": { + "DeviceType": "device", + "MethodName": "getDeviceHealthParameters" + } + } + +Output:: + + { + "DeviceMethodResponse": "{\"remainingLife\": 99.8}" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/list-device-events.rst b/aws/dist/awscli/examples/iot1click-devices/list-device-events.rst new file mode 100644 index 00000000..51ed1755 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/list-device-events.rst @@ -0,0 +1,32 @@ +**To list a device's events for a specified time range** + +The following ``list-device-events`` example lists the specified device's events for the specified time range. :: + + aws iot1click-devices list-device-events \ + --device-id G030PM0123456789 \ + --from-time-stamp 2019-07-17T15:45:12.880Z --to-time-stamp 2019-07-19T15:45:12.880Z + +Output:: + + { + "Events": [ + { + "Device": { + "Attributes": {}, + "DeviceId": "G030PM0123456789", + "Type": "button" + }, + "StdEvent": "{\"clickType\": \"SINGLE\", \"reportedTime\": \"2019-07-18T23:47:55.015Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.85000000000001, \"testMode\": false}" + }, + { + "Device": { + "Attributes": {}, + "DeviceId": "G030PM0123456789", + "Type": "button" + }, + "StdEvent": "{\"clickType\": \"DOUBLE\", \"reportedTime\": \"2019-07-19T00:14:41.353Z\", \"certificateId\": \"fe8798a6c97c62ef8756b80eeefdcf2280f3352f82faa8080c74cc4f4a4d1811\", \"remainingLife\": 99.8, \"testMode\": false}" + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/list-devices.rst b/aws/dist/awscli/examples/iot1click-devices/list-devices.rst new file mode 100644 index 00000000..ef3d317c --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/list-devices.rst @@ -0,0 +1,26 @@ +**To list the devices of a specified type** + +The following ``list-devices`` example lists the devices of a specified type. :: + + aws iot1click-devices list-devices \ + --device-type button + +This command produces no output. + +Output:: + + { + "Devices": [ + { + "remainingLife": 99.9, + "attributes": { + "arn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789", + "type": "button", + "deviceId": "G030PM0123456789", + "enabled": false + } + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/list-tags-for-resource.rst b/aws/dist/awscli/examples/iot1click-devices/list-tags-for-resource.rst new file mode 100644 index 00000000..89cdc329 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags for a device** + +The following ``list-tags-for-resource`` example list the tags for the specified device. :: + + aws iot1click-devices list-tags-for-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:012345678901:devices/G030PM0123456789" + +Output:: + + { + "Tags": { + "Driver Phone": "123-555-0199", + "Driver": "Jorge Souza" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/tag-resource.rst b/aws/dist/awscli/examples/iot1click-devices/tag-resource.rst new file mode 100644 index 00000000..51ef0a04 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/tag-resource.rst @@ -0,0 +1,20 @@ +**To add tags to a device AWS resource** + +The following ``tag-resource`` example adds two tags to the specified resource. :: + + aws iot1click-devices tag-resource \ + --cli-input-json file://devices-tag-resource.json + +Contents of ``devices-tag-resource.json``:: + + { + "ResourceArn": "arn:aws:iot1click:us-west-2:123456789012:devices/G030PM0123456789", + "Tags": { + "Driver": "Jorge Souza", + "Driver Phone": "123-555-0199" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/unclaim-device.rst b/aws/dist/awscli/examples/iot1click-devices/unclaim-device.rst new file mode 100644 index 00000000..c69c5086 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/unclaim-device.rst @@ -0,0 +1,14 @@ +**To unclaim (deregister) a device from your AWS account** + +The following ``unclaim-device`` example unclaims (deregisters) the specified device from your AWS account. :: + + aws iot1click-devices unclaim-device \ + --device-id G030PM0123456789 + +Output:: + + { + "State": "UNCLAIMED" + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/untag-resource.rst b/aws/dist/awscli/examples/iot1click-devices/untag-resource.rst new file mode 100644 index 00000000..6ce9efe7 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/untag-resource.rst @@ -0,0 +1,12 @@ +**To remove tags from a device AWS resource** + +The following ``untag-resource`` example removes the tags with the names ``Driver Phone`` and ``Driver`` from the specified device resource. :: + + aws iot1click-devices untag-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \ + --tag-keys "Driver Phone" "Driver" + + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-devices/update-device-state.rst b/aws/dist/awscli/examples/iot1click-devices/update-device-state.rst new file mode 100644 index 00000000..4d0b6c1b --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-devices/update-device-state.rst @@ -0,0 +1,11 @@ +**To update the ``enabled`` state for a device** + +The following ``update-device-state`` sets the state of the specified device to ``enabled``. :: + + aws iot1click-devices update-device-state \ + --device-id G030PM0123456789 \ + --enabled + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/associate-device-with-placement.rst b/aws/dist/awscli/examples/iot1click-projects/associate-device-with-placement.rst new file mode 100644 index 00000000..37f92879 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/associate-device-with-placement.rst @@ -0,0 +1,13 @@ +**To associate an AWS IoT 1-Click device with an existing placement** + +The following ``associate-device-with-placement`` example associates the specified AWS IoT 1-Click device with an existing placement. :: + + aws iot1click-projects associate-device-with-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --device-template-name empty-dumpster-request \ + --device-id G030PM0123456789 + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/create-placement.rst b/aws/dist/awscli/examples/iot1click-projects/create-placement.rst new file mode 100644 index 00000000..28feb09e --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/create-placement.rst @@ -0,0 +1,12 @@ +**To create an AWS IoT 1-Click placement for a project** + +The following ``create-placement`` example create an AWS IoT 1-Click placement for the specified project. :: + + aws iot1click-projects create-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --attributes "{"location": "123 Any Street Anytown, USA 10001", "phone": "123-456-7890"}" + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/create-project.rst b/aws/dist/awscli/examples/iot1click-projects/create-project.rst new file mode 100644 index 00000000..4ece7ec5 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/create-project.rst @@ -0,0 +1,27 @@ +**To create an AWS IoT 1-Click project for zero or more placements** + +The following ``create-project`` example creates an AWS IoT 1-Click project for a placement. + + aws iot1click-projects create-project \ + --cli-input-json file://create-project.json + +Contents of ``create-project.json``:: + + { + "projectName": "AnytownDumpsters", + "description": "All dumpsters in the Anytown region.", + "placementTemplate": { + "defaultAttributes": { + "City" : "Anytown" + }, + "deviceTemplates": { + "empty-dumpster-request" : { + "deviceType": "button" + } + } + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/delete-placement.rst b/aws/dist/awscli/examples/iot1click-projects/delete-placement.rst new file mode 100644 index 00000000..1a76fcbc --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/delete-placement.rst @@ -0,0 +1,11 @@ +**To delete a placement from a project** + +The following ``delete-placement`` example deletes the specified placement from a project. :: + + aws iot1click-projects delete-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/delete-project.rst b/aws/dist/awscli/examples/iot1click-projects/delete-project.rst new file mode 100644 index 00000000..936810b4 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/delete-project.rst @@ -0,0 +1,10 @@ +**To delete a project from your AWS account** + +The following ``delete-project`` example deletes the specified project from your AWS account. :: + + aws iot1click-projects delete-project \ + --project-name AnytownDumpsters + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/describe-placement.rst b/aws/dist/awscli/examples/iot1click-projects/describe-placement.rst new file mode 100644 index 00000000..980e175e --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/describe-placement.rst @@ -0,0 +1,24 @@ +**To describe a placement for a project** + +The following ``describe-placement`` example describes a placement for the specified project. :: + + aws iot1click-projects describe-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +Output:: + + { + "placement": { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "attributes": { + "phone": "123-555-0110", + "location": "123 Any Street Anytown, USA 10001" + }, + "createdDate": 1563488454, + "updatedDate": 1563488454 + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/describe-project.rst b/aws/dist/awscli/examples/iot1click-projects/describe-project.rst new file mode 100644 index 00000000..f57a786e --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/describe-project.rst @@ -0,0 +1,32 @@ +**To describe an AWS IoT 1-Click project** + +The following ``describe-project`` example describes the specified AWS IoT 1-Click project. :: + + aws iot1click-projects describe-project \ + --project-name AnytownDumpsters + +Output:: + + { + "project": { + "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", + "projectName": "AnytownDumpsters", + "description": "All dumpsters in the Anytown region.", + "createdDate": 1563483100, + "updatedDate": 1563483100, + "placementTemplate": { + "defaultAttributes": { + "City": "Anytown" + }, + "deviceTemplates": { + "empty-dumpster-request": { + "deviceType": "button", + "callbackOverrides": {} + } + } + }, + "tags": {} + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst b/aws/dist/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst new file mode 100644 index 00000000..b66f2e84 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/disassociate-device-from-placement.rst @@ -0,0 +1,12 @@ +**To disassociate a device from a placement** + +The following ``disassociate-device-from-placement`` example disassociates the specified device from a placement. :: + + aws iot1click-projects disassociate-device-from-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 \ + --device-template-name empty-dumpster-request + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/get-devices-in-placement.rst b/aws/dist/awscli/examples/iot1click-projects/get-devices-in-placement.rst new file mode 100644 index 00000000..2ef62a3b --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/get-devices-in-placement.rst @@ -0,0 +1,17 @@ +**To list all devices in a placement contained in a project** + +The following ``get-devices-in-placement`` example lists all devices in a the specified placement contained in the specified project. :: + + aws iot1click-projects get-devices-in-placement \ + --project-name AnytownDumpsters \ + --placement-name customer217 + +Output:: + + { + "devices": { + "empty-dumpster-request": "G030PM0123456789" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/list-placements.rst b/aws/dist/awscli/examples/iot1click-projects/list-placements.rst new file mode 100644 index 00000000..e28fd28c --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/list-placements.rst @@ -0,0 +1,21 @@ +**To list all AWS IoT 1-Click placements for a project** + +The following ``list-placements`` example lists all AWS IoT 1-Click placements for the specified project. :: + + aws iot1click-projects list-placements \ + --project-name AnytownDumpsters + +Output:: + + { + "placements": [ + { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "createdDate": 1563488454, + "updatedDate": 1563488454 + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/list-projects.rst b/aws/dist/awscli/examples/iot1click-projects/list-projects.rst new file mode 100644 index 00000000..54efeedf --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/list-projects.rst @@ -0,0 +1,21 @@ +**To list all AWS IoT 1-Click projects** + +The following ``list-projects`` example list all AWS IoT 1-Click projects in your account. :: + + aws iot1click-projects list-projects + +Output:: + + { + "projects": [ + { + "arn": "arn:aws:iot1click:us-west-2:012345678901:projects/AnytownDumpsters", + "projectName": "AnytownDumpsters", + "createdDate": 1563483100, + "updatedDate": 1563483100, + "tags": {} + } + ] + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/list-tags-for-resource.rst b/aws/dist/awscli/examples/iot1click-projects/list-tags-for-resource.rst new file mode 100644 index 00000000..5ccba4fa --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags for a project resource** + +The following ``list-tags-for-resource`` example list the tags for the specified project resource. :: + + aws iot1click-projects list-tags-for-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" + +Output:: + + { + "tags": { + "Manager": "Li Juan", + "Account": "45215" + } + } + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/tag-resource.rst b/aws/dist/awscli/examples/iot1click-projects/tag-resource.rst new file mode 100644 index 00000000..8dc43f58 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/tag-resource.rst @@ -0,0 +1,20 @@ +**To add tags to a project resource** + +The following ``tag-resource`` example adds two tags to the specified project resource. :: + + aws iot1click-projects tag-resource \ + --cli-input-json file://devices-tag-resource.json + +Contents of ``devices-tag-resource.json``:: + + { + "resourceArn": "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters", + "tags": { + "Account": "45215", + "Manager": "Li Juan" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/untag-resource.rst b/aws/dist/awscli/examples/iot1click-projects/untag-resource.rst new file mode 100644 index 00000000..5bc6e7ee --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from a project resource** + +The following ``untag-resource`` example removes the tag with the key name ``Manager`` from the specified project. :: + + aws iot1click-projects untag-resource \ + --resource-arn "arn:aws:iot1click:us-west-2:123456789012:projects/AnytownDumpsters" \ + --tag-keys "Manager" + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/update-placement.rst b/aws/dist/awscli/examples/iot1click-projects/update-placement.rst new file mode 100644 index 00000000..1e996040 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/update-placement.rst @@ -0,0 +1,21 @@ +**To update the "attributes" key-value pairs of a placement** + +The following ``update-placement`` example update the "attributes" key-value pairs of a placement. :: + + aws iot1click-projects update-placement \ + --cli-input-json file://update-placement.json + +Contents of ``update-placement.json``:: + + { + "projectName": "AnytownDumpsters", + "placementName": "customer217", + "attributes": { + "phone": "123-456-7890", + "location": "123 Any Street Anytown, USA 10001" + } + } + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iot1click-projects/update-project.rst b/aws/dist/awscli/examples/iot1click-projects/update-project.rst new file mode 100644 index 00000000..3bd7d9b8 --- /dev/null +++ b/aws/dist/awscli/examples/iot1click-projects/update-project.rst @@ -0,0 +1,11 @@ +**To update settings for a project** + +The following ``update-project`` example updates the description for a project. :: + + aws iot1click-projects update-project \ + --project-name AnytownDumpsters \ + --description "All dumpsters (yard waste, recycling, garbage) in the Anytown region." + +This command produces no output. + +For more information, see `Using AWS IoT 1-Click with the AWS CLI `__ in the *AWS IoT 1-Click Developer Guide*. diff --git a/aws/dist/awscli/examples/iotanalytics/batch-put-message.rst b/aws/dist/awscli/examples/iotanalytics/batch-put-message.rst new file mode 100644 index 00000000..9532c8ba --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/batch-put-message.rst @@ -0,0 +1,26 @@ +**To send a message to a channel** + +The following ``batch-put-message`` example sends a message to the specified channel. :: + + aws iotanalytics batch-put-message \ + --cli-input-json file://batch-put-message.json + +Contents of ``batch-put-message.json``:: + + { + "channelName": "mychannel", + "messages": [ + { + "messageId": "0001", + "payload": "eyAidGVtcGVyYXR1cmUiOiAyMCB9" + } + ] + } + +Output:: + + { + "batchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst b/aws/dist/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst new file mode 100644 index 00000000..982a8cce --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/cancel-pipeline-reprocessing.rst @@ -0,0 +1,11 @@ +**To cancel the reprocessing of data through a pipeline** + +The following ``cancel-pipeline-reprocessing`` example cancels the reprocessing of data through the specified pipeline. :: + + aws iotanalytics cancel-pipeline-reprocessing \ + --pipeline-name mypipeline \ + --reprocessing-id "6ad2764f-fb13-4de3-b101-4e74af03b043" + +This command produces no output. + +For more information, see `CancelPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/create-channel.rst b/aws/dist/awscli/examples/iotanalytics/create-channel.rst new file mode 100644 index 00000000..c2f643de --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/create-channel.rst @@ -0,0 +1,33 @@ +**To create a channel** + +The following ``create-channel`` example creates a channel with the specified configuration. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline. :: + + aws iotanalytics create-channel \ + --cli-input-json file://create-channel.json + +Contents of ``create-channel.json``:: + + { + "channelName": "mychannel", + "retentionPeriod": { + "unlimited": true + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "channelArn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel", + "channelName": "mychannel", + "retentionPeriod": { + "unlimited": true + } + } + +For more information, see `CreateChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/create-dataset-content.rst b/aws/dist/awscli/examples/iotanalytics/create-dataset-content.rst new file mode 100644 index 00000000..66b88872 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/create-dataset-content.rst @@ -0,0 +1,14 @@ +**To create the content of a dataset** + +The following ``create-dataset-content`` example creates the content of the specified dataset by applying a ``queryAction`` (an SQL query) or a ``containerAction`` (executing a containerized application). :: + + aws iotanalytics create-dataset-content \ + --dataset-name mydataset + +Output:: + + { + "versionId": "d494b416-9850-4670-b885-ca22f1e89d62" + } + +For more information, see `CreateDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/create-dataset.rst b/aws/dist/awscli/examples/iotanalytics/create-dataset.rst new file mode 100644 index 00000000..f376001f --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/create-dataset.rst @@ -0,0 +1,41 @@ +**To create a dataset** + +The following ``create-dataset`` example creates a dataset. A dataset stores data retrieved from a data store by applying a ``queryAction`` (a SQL query) or a ``containerAction`` (executing a containerized application). This operation creates the skeleton of a dataset. You can populate the dataset manually by calling ``CreateDatasetContent`` or automatically according to a ``trigger`` you specify. :: + + aws iotanalytics create-dataset \ + --cli-input-json file://create-dataset.json + +Contents of ``create-dataset.json``:: + + { + "datasetName": "mydataset", + "actions": [ + { + "actionName": "myDatasetAction", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore" + } + } + ], + "retentionPeriod": { + "unlimited": true + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "datasetName": "mydataset", + "retentionPeriod": { + "unlimited": true + }, + "datasetArn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset" + } + +For more information, see `CreateDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/create-datastore.rst b/aws/dist/awscli/examples/iotanalytics/create-datastore.rst new file mode 100644 index 00000000..9588f1b0 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/create-datastore.rst @@ -0,0 +1,34 @@ +**To create a data store** + +The following ``create-datastore`` example creates a data store, which is a repository for messages. :: + + aws iotanalytics create-datastore \ + --cli-input-json file://create-datastore.json + +Contents of ``create-datastore.json``:: + + { + "datastoreName": "mydatastore", + "retentionPeriod": { + "numberOfDays": 90 + }, + "tags": [ + { + "key": "Environment", + "value": "Production" + } + ] + } + +Output:: + + { + "datastoreName": "mydatastore", + "datastoreArn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore", + "retentionPeriod": { + "numberOfDays": 90, + "unlimited": false + } + } + +For more information, see `CreateDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/create-pipeline.rst b/aws/dist/awscli/examples/iotanalytics/create-pipeline.rst new file mode 100644 index 00000000..58991c56 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/create-pipeline.rst @@ -0,0 +1,50 @@ +**Create an IoT Analytics Pipeline** + +The following ``create-pipeline`` example creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities in the ``pipelineActivities`` array. :: + + aws iotanalytics create-pipeline \ + --cli-input-json file://create-pipeline.json + +Contents of ``create-pipeline.json``:: + + { + "pipelineName": "mypipeline", + "pipelineActivities": [ + { + "channel": { + "name": "myChannelActivity", + "channelName": "mychannel", + "next": "myMathActivity" + } + }, + { + "datastore": { + "name": "myDatastoreActivity", + "datastoreName": "mydatastore" + } + }, + { + "math": { + "name": "myMathActivity", + "math": "((temp - 32) * 5.0) / 9.0", + "attribute": "tempC", + "next": "myDatastoreActivity" + } + } + ], + "tags": [ + { + "key": "Environment", + "value": "Beta" + } + ] + } + +Output:: + + { + "pipelineArn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline", + "pipelineName": "mypipeline" + } + +For more information, see `CreatePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/delete-channel.rst b/aws/dist/awscli/examples/iotanalytics/delete-channel.rst new file mode 100644 index 00000000..74e5f0f0 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/delete-channel.rst @@ -0,0 +1,10 @@ +**Delete an IoT Analytics Channel** + +The following ``delete-channel`` example deletes the specified channel. :: + + aws iotanalytics delete-channel \ + --channel-name mychannel + +This command produces no output. + +For more information, see `DeleteChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/delete-dataset-content.rst b/aws/dist/awscli/examples/iotanalytics/delete-dataset-content.rst new file mode 100644 index 00000000..0315d7ac --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/delete-dataset-content.rst @@ -0,0 +1,10 @@ +**To delete dataset content** + +The following ``delete-dataset-content`` example deletes the content of the specified dataset. :: + + aws iotanalytics delete-dataset-content \ + --dataset-name mydataset + +This command produces no output. + +For more information, see `DeleteDatasetContent `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/delete-dataset.rst b/aws/dist/awscli/examples/iotanalytics/delete-dataset.rst new file mode 100644 index 00000000..bb7f10cc --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/delete-dataset.rst @@ -0,0 +1,10 @@ +**To delete a dataset** + +The following ``delete-dataset`` example deletes the specified dataset. You don't have to delete the content of the dataset before you perform this operation. :: + + aws iotanalytics delete-dataset \ + --dataset-name mydataset + +This command produces no output. + +For more information, see `DeleteDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/delete-datastore.rst b/aws/dist/awscli/examples/iotanalytics/delete-datastore.rst new file mode 100644 index 00000000..d7ef47af --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/delete-datastore.rst @@ -0,0 +1,11 @@ +**To delete a data store** + +The following ``delete-datastore`` example deletes the specified data store. :: + + aws iotanalytics delete-datastore \ + --datastore-name mydatastore + + +This command produces no output. + +For more information, see `DeleteDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/delete-pipeline.rst b/aws/dist/awscli/examples/iotanalytics/delete-pipeline.rst new file mode 100644 index 00000000..4273d6aa --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/delete-pipeline.rst @@ -0,0 +1,10 @@ +**To delete a pipeline** + +The following ``delete-pipeline`` example deletes the specified pipeline. :: + + aws iotanalytics delete-pipeline \ + --pipeline-name mypipeline + +This command produces no output. + +For more information, see `DeletePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/describe-channel.rst b/aws/dist/awscli/examples/iotanalytics/describe-channel.rst new file mode 100644 index 00000000..02e188f3 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/describe-channel.rst @@ -0,0 +1,30 @@ +**To retrieve information about a channel** + +The following ``describe-channel`` example displays details, including statistics, for the specified channel. :: + + aws iotanalytics describe-channel \ + --channel-name mychannel \ + --include-statistics + +Output:: + + { + "statistics": { + "size": { + "estimatedSizeInBytes": 402.0, + "estimatedOn": 1561504380.0 + } + }, + "channel": { + "status": "ACTIVE", + "name": "mychannel", + "lastUpdateTime": 1557860351.001, + "creationTime": 1557860351.001, + "retentionPeriod": { + "unlimited": true + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" + } + } + +For more information, see `DescribeChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/describe-dataset.rst b/aws/dist/awscli/examples/iotanalytics/describe-dataset.rst new file mode 100644 index 00000000..95fb7954 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/describe-dataset.rst @@ -0,0 +1,35 @@ +**To retrieve information about a dataset** + +The following ``describe-dataset`` example displays details for the specified dataset. :: + + aws iotanalytics describe-dataset \ + --dataset-name mydataset + +Output:: + + { + "dataset": { + "status": "ACTIVE", + "contentDeliveryRules": [], + "name": "mydataset", + "lastUpdateTime": 1557859240.658, + "triggers": [], + "creationTime": 1557859240.658, + "actions": [ + { + "actionName": "query_32", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore", + "filters": [] + } + } + ], + "retentionPeriod": { + "numberOfDays": 90, + "unlimited": false + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:dataset/mydataset" + } + } + +For more information, see `DescribeDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/describe-datastore.rst b/aws/dist/awscli/examples/iotanalytics/describe-datastore.rst new file mode 100644 index 00000000..65af8887 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/describe-datastore.rst @@ -0,0 +1,30 @@ +**To retrieve information about a data store** + +The following ``describe-datastore`` example displays details, including statistics, for the specified data store. :: + + aws iotanalytics describe-datastore \ + --datastore-name mydatastore \ + --include-statistics + +Output:: + + { + "datastore": { + "status": "ACTIVE", + "name": "mydatastore", + "lastUpdateTime": 1557858971.02, + "creationTime": 1557858971.02, + "retentionPeriod": { + "unlimited": true + }, + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:datastore/mydatastore" + }, + "statistics": { + "size": { + "estimatedSizeInBytes": 397.0, + "estimatedOn": 1561592040.0 + } + } + } + +For more information, see `DescribeDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/describe-logging-options.rst b/aws/dist/awscli/examples/iotanalytics/describe-logging-options.rst new file mode 100644 index 00000000..63fdadf0 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/describe-logging-options.rst @@ -0,0 +1,18 @@ +**To retrieve the current logging options** + +The following ``describe-logging-options`` example displays the current AWS IoT Analytics logging options. :: + + aws iotanalytics describe-logging-options + +This command produces no output. +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", + "enabled": true, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/describe-pipeline.rst b/aws/dist/awscli/examples/iotanalytics/describe-pipeline.rst new file mode 100644 index 00000000..2ef40643 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/describe-pipeline.rst @@ -0,0 +1,41 @@ +**To retrieve information about a pipeline** + +The following ``describe-pipeline`` example displays details for the specified pipeline. :: + + aws iotanalytics describe-pipeline \ + --pipeline-name mypipeline + +Output:: + + { + "pipeline": { + "activities": [ + { + "channel": { + "channelName": "mychannel", + "name": "mychannel_28", + "next": "mydatastore_29" + } + }, + { + "datastore": { + "datastoreName": "mydatastore", + "name": "mydatastore_29" + } + } + ], + "name": "mypipeline", + "lastUpdateTime": 1561676362.515, + "creationTime": 1557859124.432, + "reprocessingSummaries": [ + { + "status": "SUCCEEDED", + "creationTime": 1561676362.189, + "id": "6ad2764f-fb13-4de3-b101-4e74af03b043" + } + ], + "arn": "arn:aws:iotanalytics:us-west-2:123456789012:pipeline/mypipeline" + } + } + +For more information, see `DescribePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/get-dataset-content.rst b/aws/dist/awscli/examples/iotanalytics/get-dataset-content.rst new file mode 100644 index 00000000..b12740e7 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/get-dataset-content.rst @@ -0,0 +1,21 @@ +**To retrieve the contents of a dataset** + +The following ``get-dataset-content`` example retrieves the contents of a dataset as presigned URIs. :: + + aws iotanalytics get-dataset-content --dataset-name mydataset + +Output:: + + { + "status": { + "state": "SUCCEEDED" + }, + "timestamp": 1557863215.995, + "entries": [ + { + "dataURI": "https://aws-radiant-dataset-12345678-1234-1234-1234-123456789012.s3.us-west-2.amazonaws.com/results/12345678-e8b3-46ba-b2dd-efe8d86cf385.csv?X-Amz-Security-Token=...-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190628T173437Z&X-Amz-SignedHeaders=host&X-Amz-Expires=7200&X-Amz-Credential=...F20190628%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Signature=..." + } + ] + } + +For more information, see `GetDatasetContent `__ in the *guide*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-channels.rst b/aws/dist/awscli/examples/iotanalytics/list-channels.rst new file mode 100644 index 00000000..66c23a8e --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-channels.rst @@ -0,0 +1,20 @@ +**To retrieve a list of channels** + +The following ``list-channels`` example displays summary information for the available channels. :: + + aws iotanalytics list-channels + +Output:: + + { + "channelSummaries": [ + { + "status": "ACTIVE", + "channelName": "mychannel", + "creationTime": 1557860351.001, + "lastUpdateTime": 1557860351.001 + } + ] + } + +For more information, see `ListChannels `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-dataset-contents.rst b/aws/dist/awscli/examples/iotanalytics/list-dataset-contents.rst new file mode 100644 index 00000000..899329e7 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-dataset-contents.rst @@ -0,0 +1,23 @@ +**To list information about dataset contents** + +The following ``list-dataset-contents`` example lists information about dataset contents that have been created. :: + + aws iotanalytics list-dataset-contents \ + --dataset-name mydataset + +Output:: + + { + "datasetContentSummaries": [ + { + "status": { + "state": "SUCCEEDED" + }, + "scheduleTime": 1557863215.995, + "version": "b10ea2a9-66c1-4d99-8d1f-518113b738d0", + "creationTime": 1557863215.995 + } + ] + } + +For more information, see `ListDatasetContents `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-datasets.rst b/aws/dist/awscli/examples/iotanalytics/list-datasets.rst new file mode 100644 index 00000000..0985d3c1 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-datasets.rst @@ -0,0 +1,27 @@ +**To retrieve information about datasets** + +The following ``list-datasets`` example lists summary information about available datasets. :: + + aws iotanalytics list-datasets + +Output:: + + { + "datasetSummaries": [ + { + "status": "ACTIVE", + "datasetName": "mydataset", + "lastUpdateTime": 1557859240.658, + "triggers": [], + "creationTime": 1557859240.658, + "actions": [ + { + "actionName": "query_32", + "actionType": "QUERY" + } + ] + } + ] + } + +For more information, see `ListDatasets `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-datastores.rst b/aws/dist/awscli/examples/iotanalytics/list-datastores.rst new file mode 100644 index 00000000..f002038b --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-datastores.rst @@ -0,0 +1,20 @@ +**To retrieve a list of data stores** + +The following ``list-datastores`` example displays summary information about the available data stores. :: + + aws iotanalytics list-datastores + +Output:: + + { + "datastoreSummaries": [ + { + "status": "ACTIVE", + "datastoreName": "mydatastore", + "creationTime": 1557858971.02, + "lastUpdateTime": 1557858971.02 + } + ] + } + +For more information, see `ListDatastores `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-pipelines.rst b/aws/dist/awscli/examples/iotanalytics/list-pipelines.rst new file mode 100644 index 00000000..32e38915 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-pipelines.rst @@ -0,0 +1,20 @@ +**To retrieve a list of pipelines** + +The following ``list-pipelines`` example displays a list of available pipelines. :: + + aws iotanalytics list-pipelines + +Output:: + + { + "pipelineSummaries": [ + { + "pipelineName": "mypipeline", + "creationTime": 1557859124.432, + "lastUpdateTime": 1557859124.432, + "reprocessingSummaries": [] + } + ] + } + +For more information, see `ListPipelines `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/list-tags-for-resource.rst b/aws/dist/awscli/examples/iotanalytics/list-tags-for-resource.rst new file mode 100644 index 00000000..4f1d5aa7 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/list-tags-for-resource.rst @@ -0,0 +1,19 @@ +**To list tags for a resource** + +The following ``list-tags-for-resource`` example Lists the tags that you have attached to the specified resource. :: + + aws iotanalytics list-tags-for-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" + +Output:: + + { + "tags": [ + { + "value": "bar", + "key": "foo" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/put-logging-options.rst b/aws/dist/awscli/examples/iotanalytics/put-logging-options.rst new file mode 100644 index 00000000..919e5132 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/put-logging-options.rst @@ -0,0 +1,20 @@ +**To set or update logging options** + +The following ``put-logging-options`` example sets or updates the AWS IoT Analytics logging options. If you update the value of any ``loggingOptions`` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the "roleArn" field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect. :: + + aws iotanalytics put-logging-options \ + --cli-input-json file://put-logging-options.json + +Contents of ``put-logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/service-role/myIoTAnalyticsRole", + "level": "ERROR", + "enabled": true + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/run-pipeline-activity.rst b/aws/dist/awscli/examples/iotanalytics/run-pipeline-activity.rst new file mode 100644 index 00000000..d9fd34a4 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/run-pipeline-activity.rst @@ -0,0 +1,36 @@ +**To simulate a pipeline activity** + +The following ``run-pipeline-activity`` example simulates the results of running a pipeline activity on a message payload. :: + + aws iotanalytics run-pipeline-activity \ + --pipeline-activity file://maths.json \ + --payloads file://payloads.json + +Contents of ``maths.json``:: + + { + "math": { + "name": "MyMathActivity", + "math": "((temp - 32) * 5.0) / 9.0", + "attribute": "tempC" + } + } + +Contents of ``payloads.json``:: + + [ + "{\"humidity\": 52, \"temp\": 68 }", + "{\"humidity\": 52, \"temp\": 32 }" + ] + +Output:: + + { + "logResult": "", + "payloads": [ + "eyJodW1pZGl0eSI6NTIsInRlbXAiOjY4LCJ0ZW1wQyI6MjB9", + "eyJodW1pZGl0eSI6NTIsInRlbXAiOjMyLCJ0ZW1wQyI6MH0=" + ] + } + +For more information, see `RunPipelineActivity `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/sample-channel-data.rst b/aws/dist/awscli/examples/iotanalytics/sample-channel-data.rst new file mode 100644 index 00000000..98a547b2 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/sample-channel-data.rst @@ -0,0 +1,17 @@ +**To retrieve sample messages from a channel** + +The following ``sample-channel-data`` example retrieves a sample of messages from the specified channel ingested during the specified timeframe. You can retrieve up to 10 messages. :: + + aws iotanalytics sample-channel-data \ + --channel-name mychannel + +Output:: + + { + "payloads": [ + "eyAidGVtcGVyYXR1cmUiOiAyMCB9", + "eyAiZm9vIjogImJhciIgfQ==" + ] + } + +For more information, see `SampleChannelData `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst b/aws/dist/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst new file mode 100644 index 00000000..82bcc016 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/start-pipeline-reprocessing.rst @@ -0,0 +1,14 @@ +**To start pipeline reprocessing** + +The following ``start-pipeline-reprocessing`` example starts the reprocessing of raw message data through the specified pipeline. :: + + aws iotanalytics start-pipeline-reprocessing \ + --pipeline-name mypipeline + +Output:: + + { + "reprocessingId": "6ad2764f-fb13-4de3-b101-4e74af03b043" + } + +For more information, see `StartPipelineReprocessing `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/tag-resource.rst b/aws/dist/awscli/examples/iotanalytics/tag-resource.rst new file mode 100644 index 00000000..4bae4998 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/tag-resource.rst @@ -0,0 +1,11 @@ +**To add or modify tags for a resource** + +The following ``tag-resource`` example adds to or modifies the tags attached to the specified resource. :: + + aws iotanalytics tag-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ + --tags "[{\"key\": \"Environment\", \"value\": \"Production\"}]" + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/untag-resource.rst b/aws/dist/awscli/examples/iotanalytics/untag-resource.rst new file mode 100644 index 00000000..cc0076d0 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/untag-resource.rst @@ -0,0 +1,12 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the tags with the specified key names from the specified resource. :: + + aws iotanalytics untag-resource \ + --resource-arn "arn:aws:iotanalytics:us-west-2:123456789012:channel/mychannel" \ + --tag-keys "[\"Environment\"]" + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/update-channel.rst b/aws/dist/awscli/examples/iotanalytics/update-channel.rst new file mode 100644 index 00000000..2de24c84 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/update-channel.rst @@ -0,0 +1,19 @@ +**To modify a channel** + +The following ``update-channel`` example modifies the settings for the specified channel. :: + + aws iotanalytics update-channel \ + --cli-input-json file://update-channel.json + +Contents of ``update-channel.json``:: + + { + "channelName": "mychannel", + "retentionPeriod": { + "numberOfDays": 92 + } + } + +This command produces no output. + +For more information, see `UpdateChannel `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/update-dataset.rst b/aws/dist/awscli/examples/iotanalytics/update-dataset.rst new file mode 100644 index 00000000..46c27fb6 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/update-dataset.rst @@ -0,0 +1,28 @@ +**To update a dataset** + +The following ``update-dataset`` example modifies the settings of the specified dataset. :: + + aws iotanalytics update-dataset \ + --cli-input-json file://update-dataset.json + +Contents of ``update-dataset.json``:: + + { + "datasetName": "mydataset", + "actions": [ + { + "actionName": "myDatasetUpdateAction", + "queryAction": { + "sqlQuery": "SELECT * FROM mydatastore" + } + } + ], + "retentionPeriod": { + "numberOfDays": 92 + } + } + +This command produces no output. + +For more information, see `UpdateDataset `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/update-datastore.rst b/aws/dist/awscli/examples/iotanalytics/update-datastore.rst new file mode 100644 index 00000000..b0a57ed8 --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/update-datastore.rst @@ -0,0 +1,19 @@ +**To update a data store** + +The following ``update-datastore`` example modifies the settings of the specified data store. :: + + aws iotanalytics update-datastore \ + --cli-input-json file://update-datastore.json + +Contents of update-datastore.json:: + + { + "datastoreName": "mydatastore", + "retentionPeriod": { + "numberOfDays": 93 + } + } + +This command produces no output. + +For more information, see `UpdateDatastore `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotanalytics/update-pipeline.rst b/aws/dist/awscli/examples/iotanalytics/update-pipeline.rst new file mode 100644 index 00000000..5649cb2f --- /dev/null +++ b/aws/dist/awscli/examples/iotanalytics/update-pipeline.rst @@ -0,0 +1,39 @@ +**To update a pipeline** + +The following ``update-pipeline`` example modifies the settings of the specified pipeline. You must specify both a channel and a data store activity and, optionally, as many as 23 additional activities, in the ``pipelineActivities`` array. :: + + aws iotanalytics update-pipeline \ + --cli-input-json file://update-pipeline.json + +Contents of update-pipeline.json:: + + { + "pipelineName": "mypipeline", + "pipelineActivities": [ + { + "channel": { + "name": "myChannelActivity", + "channelName": "mychannel", + "next": "myMathActivity" + } + }, + { + "datastore": { + "name": "myDatastoreActivity", + "datastoreName": "mydatastore" + } + }, + { + "math": { + "name": "myMathActivity", + "math": "(((temp - 32) * 5.0) / 9.0) + 273.15", + "attribute": "tempK", + "next": "myDatastoreActivity" + } + } + ] + } + +This command produces no output. + +For more information, see `UpdatePipeline `__ in the *AWS IoT Analytics API Reference*. diff --git a/aws/dist/awscli/examples/iotevents-data/batch-put-message.rst b/aws/dist/awscli/examples/iotevents-data/batch-put-message.rst new file mode 100644 index 00000000..a311489c --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/batch-put-message.rst @@ -0,0 +1,27 @@ +**To send messages (inputs) to AWS IoT Events** + +The following ``batch-put-message`` example sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ( ``inputName`` ) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. :: + + aws iotevents-data batch-put-message \ + --cli-input-json file://highPressureMessage.json + +Contents of ``highPressureMessage.json``:: + + { + "messages": [ + { + "messageId": "00001", + "inputName": "PressureInput", + "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" + } + ] + } + +Output:: + + { + "BatchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/batch-update-detector.rst b/aws/dist/awscli/examples/iotevents-data/batch-update-detector.rst new file mode 100644 index 00000000..5151b42f --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/batch-update-detector.rst @@ -0,0 +1,38 @@ +**To update a detector (instance)** + +The following ``batch-update-detector`` example updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. :: + + aws iotevents-data batch-update-detector \ + --cli-input-json file://budFulton-A32.json + +Contents of ``budFulton-A32.json``:: + + { + "detectors": [ + { + "messageId": "00001", + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32", + "state": { + "stateName": "Normal", + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "0" + } + ], + "timers": [ + ] + } + } + ] + } + +Output:: + + { + "batchUpdateDetectorErrorEntries": [] + } + +For more information, see `BatchUpdateDetector `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/create-detector-model.rst b/aws/dist/awscli/examples/iotevents-data/create-detector-model.rst new file mode 100644 index 00000000..a95ceec3 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/create-detector-model.rst @@ -0,0 +1,141 @@ +**To create a detector model** + +The following ``create-detector-model`` example creates a detector model. :: + + aws iotevents create-detector-model \ + --cli-input-json file://motorDetectorModel.json + +Contents of ``motorDetectorModel.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "key": "motorid", + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `CreateDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/create-input.rst b/aws/dist/awscli/examples/iotevents-data/create-input.rst new file mode 100644 index 00000000..5069e144 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/create-input.rst @@ -0,0 +1,34 @@ +**To create an input** + +The following ``create-input`` example creates an input. :: + + aws iotevents create-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `CreateInput `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/delete-detector-model.rst b/aws/dist/awscli/examples/iotevents-data/delete-detector-model.rst new file mode 100644 index 00000000..5bd5cb8c --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/delete-detector-model.rst @@ -0,0 +1,11 @@ +**To delete a detector model** + +The following ``delete-detector-model`` example deletes a detector model. Any active instances of the detector model are also deleted. :: + + aws iotevents delete-detector-model \ + --detector-model-name motorDetectorModel* + +This command produces no output. + +For more information, see `DeleteDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/delete-input.rst b/aws/dist/awscli/examples/iotevents-data/delete-input.rst new file mode 100644 index 00000000..811e4bfa --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/delete-input.rst @@ -0,0 +1,10 @@ +**To delete an input** + +The following ``delete-input`` example deletes an input. :: + + aws iotevents delete-input \ + --input-name PressureInput + +This command produces no output. + +For more information, see `DeleteInput `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/describe-detector-model.rst b/aws/dist/awscli/examples/iotevents-data/describe-detector-model.rst new file mode 100644 index 00000000..890d92c3 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/describe-detector-model.rst @@ -0,0 +1,140 @@ +**To get information about a detector model** + +The following ``describe-detector-model`` example describes a detector model. If the ``version`` parameter is not specified, the command returns information about the latest version. :: + + aws iotevents describe-detector-model \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModel": { + "detectorModelConfiguration": { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + }, + "detectorModelDefinition": { + "states": [ + { + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70", + "nextState": "Dangerous" + } + ], + "events": [] + }, + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ], + "condition": "true" + } + ] + }, + "onExit": { + "events": [] + } + }, + { + "onInput": { + "transitionEvents": [ + { + "eventName": "BackToNormal", + "actions": [], + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ], + "events": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70" + }, + { + "eventName": "Pressure Okay", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure <= 70" + } + ] + }, + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ], + "condition": "$variable.pressureThresholdBreached > 1" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ], + "condition": "true" + } + ] + } + } + ], + "initialStateName": "Normal" + } + } + } + +For more information, see `DescribeDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/describe-detector.rst b/aws/dist/awscli/examples/iotevents-data/describe-detector.rst new file mode 100644 index 00000000..dff89b0c --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/describe-detector.rst @@ -0,0 +1,31 @@ +**To get information about a detector (instance)** + +The following ``describe-detector`` example returns information about the specified detector (instance). :: + + aws iotevents-data describe-detector \ + --detector-model-name motorDetectorModel \ + --key-value "Fulton-A32" + +Output:: + + { + "detector": { + "lastUpdateTime": 1560797852.776, + "creationTime": 1560797852.775, + "state": { + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "3" + } + ], + "stateName": "Dangerous", + "timers": [] + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `DescribeDetector `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/describe-input.rst b/aws/dist/awscli/examples/iotevents-data/describe-input.rst new file mode 100644 index 00000000..ab15dadb --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/describe-input.rst @@ -0,0 +1,33 @@ +**To get information about an input** + +The following ``describe-input`` example retrieves the details of an input. :: + + aws iotevents describe-input \ + --input-name PressureInput + +Output:: + + { + "input": { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + }, + "inputDefinition": { + "attributes": [ + { + "jsonPath": "sensorData.pressure" + }, + { + "jsonPath": "motorid" + } + ] + } + } + } + +For more information, see `DescribeInput `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/describe-logging-options.rst b/aws/dist/awscli/examples/iotevents-data/describe-logging-options.rst new file mode 100644 index 00000000..d3be9fa2 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/describe-logging-options.rst @@ -0,0 +1,17 @@ +**To get information about logging settings** + +The following ``describe-logging-options`` example retrieves the current AWS IoT Events logging options. :: + + aws iotevents describe-logging-options + +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "enabled": false, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/list-detector-model-versions.rst b/aws/dist/awscli/examples/iotevents-data/list-detector-model-versions.rst new file mode 100644 index 00000000..699a2104 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/list-detector-model-versions.rst @@ -0,0 +1,24 @@ +**To get information about versions of a detector model** + +The following ``list-detector-model-versions`` example lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. :: + + aws iotevents list-detector-model-versions \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModelVersionSummaries": [ + { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectorModelVersions `__ in the *AWS IoT Events Developer Guide**. diff --git a/aws/dist/awscli/examples/iotevents-data/list-detector-models.rst b/aws/dist/awscli/examples/iotevents-data/list-detector-models.rst new file mode 100644 index 00000000..d3f19ae7 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/list-detector-models.rst @@ -0,0 +1,20 @@ +**To get a list of your detector models** + +The following ``list-detector-models`` example lists the detector models you have created. Only the metadata associated with each detector model is returned. :: + + aws iotevents list-detector-models + +Output:: + + { + "detectorModelSummaries": [ + { + "detectorModelName": "motorDetectorModel", + "creationTime": 1552072424.212 + "detectorModelDescription": "Detect overpressure in a motor." + } + ] + } + +For more information, see `ListDetectorModels `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/list-detectors.rst b/aws/dist/awscli/examples/iotevents-data/list-detectors.rst new file mode 100644 index 00000000..3ca49210 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/list-detectors.rst @@ -0,0 +1,26 @@ +**To get a list of detectors for a detector model** + +The following ``list-detectors`` example lists detectors (the instances of a detector model). :: + + aws iotevents-data list-detectors \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorSummaries": [ + { + "lastUpdateTime": 1558129925.2, + "creationTime": 1552073155.527, + "state": { + "stateName": "Normal" + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectors `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/list-inputs.rst b/aws/dist/awscli/examples/iotevents-data/list-inputs.rst new file mode 100644 index 00000000..a82f797c --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/list-inputs.rst @@ -0,0 +1,19 @@ +**To list inputs** + +The following ``list-inputs`` example lists the inputs that you've created. :: + + aws iotevents list-inputs + +Output:: + + { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1551742986.768, + "creationTime": 1551742986.768, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + +For more information, see `ListInputs `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/list-tags-for-resource.rst b/aws/dist/awscli/examples/iotevents-data/list-tags-for-resource.rst new file mode 100644 index 00000000..1d5c2883 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/list-tags-for-resource.rst @@ -0,0 +1,20 @@ +**To list tags assigned to a resource** + +The following ``list-tags-for-resource`` example lists the tags (metadata) you have assigned to the resource. :: + + aws iotevents list-tags-for-resource \ + --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" + +Output:: + + { + "tags": [ + { + "value": "motor", + "key": "deviceType" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/put-logging-options.rst b/aws/dist/awscli/examples/iotevents-data/put-logging-options.rst new file mode 100644 index 00000000..6b46ad7d --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/put-logging-options.rst @@ -0,0 +1,27 @@ +**To set logging options** + +The following ``list-tags-for-resource`` example sets or updates the AWS IoT Events logging options. If you update the value of any ``loggingOptions`` field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the ``roleArn`` field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect. :: + + aws iotevents put-logging-options \ + --cli-input-json file://logging-options.json + +Contents of ``logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "level": "DEBUG", + "enabled": true, + "detectorDebugOptions": [ + { + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32" + } + ] + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/tag-resource.rst b/aws/dist/awscli/examples/iotevents-data/tag-resource.rst new file mode 100644 index 00000000..497956e6 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/tag-resource.rst @@ -0,0 +1,24 @@ +**To add tags to a resource** + +The following ``tag-resource`` example adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. :: + + aws iotevents tag-resource \ + --cli-input-json file://pressureInput.tag.json + + +Contents of ``pressureInput.tag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tags": [ + { + "key": "deviceType", + "value": "motor" + } + ] + } + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/untag-resource.rst b/aws/dist/awscli/examples/iotevents-data/untag-resource.rst new file mode 100644 index 00000000..d5f4d02e --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/untag-resource.rst @@ -0,0 +1,21 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the specified tags from the resource. :: + + aws iotevents untag-resource \ + --cli-input-json file://pressureInput.untag.json + + +Contents of ``pressureInput.untag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tagKeys": [ + "deviceType" + ] + } + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/update-detector-model.rst b/aws/dist/awscli/examples/iotevents-data/update-detector-model.rst new file mode 100644 index 00000000..35034fea --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/update-detector-model.rst @@ -0,0 +1,140 @@ +**To update a detector model** + +The following ``update-detector-model`` example updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. :: + + aws iotevents update-detector-model \ + --cli-input-json file://motorDetectorModel.update.json + +Contents of motorDetectorModel.update.json:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560799387.719, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560799387.719, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "2" + } + } + +For more information, see `UpdateDetectorModel `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents-data/update-input.rst b/aws/dist/awscli/examples/iotevents-data/update-input.rst new file mode 100644 index 00000000..2783b31a --- /dev/null +++ b/aws/dist/awscli/examples/iotevents-data/update-input.rst @@ -0,0 +1,35 @@ +**To update an input** + +The following ``update-input`` example updates an input. :: + + aws iotevents update-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795976.458, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `UpdateInput `__ in the *AWS IoT Events Developer Guide**. + diff --git a/aws/dist/awscli/examples/iotevents/batch-put-message.rst b/aws/dist/awscli/examples/iotevents/batch-put-message.rst new file mode 100644 index 00000000..eb926370 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/batch-put-message.rst @@ -0,0 +1,26 @@ +**To send messages (inputs) to AWS IoT Events** + +The following ``batch-put-message`` example sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify ( ``inputName`` ) and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response. :: + + aws iotevents-data batch-put-message \ + --cli-input-json file://highPressureMessage.json + +Contents of ``highPressureMessage.json``:: + + { + "messages": [ + { + "messageId": "00001", + "inputName": "PressureInput", + "payload": "{\"motorid\": \"Fulton-A32\", \"sensorData\": {\"pressure\": 80, \"temperature\": 39} }" + } + ] + } + +Output:: + + { + "BatchPutMessageErrorEntries": [] + } + +For more information, see `BatchPutMessage `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/batch-update-detector.rst b/aws/dist/awscli/examples/iotevents/batch-update-detector.rst new file mode 100644 index 00000000..a931d3a0 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/batch-update-detector.rst @@ -0,0 +1,38 @@ +**To update a detector (instance)** + +The following ``batch-update-detector`` example updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. :: + + aws iotevents-data batch-update-detector \ + --cli-input-json file://budFulton-A32.json + +Contents of ``budFulton-A32.json``:: + + { + "detectors": [ + { + "messageId": "00001", + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32", + "state": { + "stateName": "Normal", + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "0" + } + ], + "timers": [ + ] + } + } + ] + } + +Output:: + + { + "batchUpdateDetectorErrorEntries": [] + } + + +For more information, see `BatchUpdateDetector `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/create-detector-model.rst b/aws/dist/awscli/examples/iotevents/create-detector-model.rst new file mode 100644 index 00000000..bb8747cc --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/create-detector-model.rst @@ -0,0 +1,140 @@ +**To create a detector model** + +The following ``create-detector-model`` example creates a detector model with its configuration specified by a parameter file. :: + + aws iotevents create-detector-model \ + --cli-input-json file://motorDetectorModel.json + +Contents of ``motorDetectorModel.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "key": "motorid", + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `CreateDetectorModel `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/create-input.rst b/aws/dist/awscli/examples/iotevents/create-input.rst new file mode 100644 index 00000000..64c3bba6 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/create-input.rst @@ -0,0 +1,34 @@ +**To create an input** + +The following ``create-input`` example creates an input. :: + + aws iotevents create-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `CreateInput `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/delete-detector-model.rst b/aws/dist/awscli/examples/iotevents/delete-detector-model.rst new file mode 100644 index 00000000..724f0e63 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/delete-detector-model.rst @@ -0,0 +1,10 @@ +**To delete a detector model** + +The following ``delete-detector-model`` example deletes the specified detector model. Any active instances of the detector model are also deleted. :: + + aws iotevents delete-detector-model \ + --detector-model-name motorDetectorModel + +This command produces no output. + +For more information, see `DeleteDetectorModel `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/delete-input.rst b/aws/dist/awscli/examples/iotevents/delete-input.rst new file mode 100644 index 00000000..5d99ab0e --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/delete-input.rst @@ -0,0 +1,10 @@ +**To delete an input** + +The following ``delete-input`` example deletes the specified input. :: + + aws iotevents delete-input \ + --input-name PressureInput + +This command produces no output. + +For more information, see `DeleteInput `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/describe-detector-model.rst b/aws/dist/awscli/examples/iotevents/describe-detector-model.rst new file mode 100644 index 00000000..edc1aa59 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/describe-detector-model.rst @@ -0,0 +1,139 @@ +**To get information about a detector model** + +The following ``describe-detector-model`` example displays details for the specified detector model. Because the ``version`` parameter is not specified, information about the latest version is returned. :: + + aws iotevents describe-detector-model \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModel": { + "detectorModelConfiguration": { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + }, + "detectorModelDefinition": { + "states": [ + { + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70", + "nextState": "Dangerous" + } + ], + "events": [] + }, + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ], + "condition": "true" + } + ] + }, + "onExit": { + "events": [] + } + }, + { + "onInput": { + "transitionEvents": [ + { + "eventName": "BackToNormal", + "actions": [], + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ], + "events": [ + { + "eventName": "Overpressurized", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure > 70" + }, + { + "eventName": "Pressure Okay", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ], + "condition": "$input.PressureInput.sensorData.pressure <= 70" + } + ] + }, + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ], + "condition": "$variable.pressureThresholdBreached > 1" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ], + "condition": "true" + } + ] + } + } + ], + "initialStateName": "Normal" + } + } + } + +For more information, see `DescribeDetectorModel `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/describe-detector.rst b/aws/dist/awscli/examples/iotevents/describe-detector.rst new file mode 100644 index 00000000..1c540ae1 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/describe-detector.rst @@ -0,0 +1,31 @@ +**To get information about a detector (instance).** + +The following ``describe-detector`` example displays details for the specified detector (instance). :: + + aws iotevents-data describe-detector \ + --detector-model-name motorDetectorModel \ + --key-value "Fulton-A32" + +Output:: + + { + "detector": { + "lastUpdateTime": 1560797852.776, + "creationTime": 1560797852.775, + "state": { + "variables": [ + { + "name": "pressureThresholdBreached", + "value": "3" + } + ], + "stateName": "Dangerous", + "timers": [] + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + } + +For more information, see `DescribeDetector `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/describe-input.rst b/aws/dist/awscli/examples/iotevents/describe-input.rst new file mode 100644 index 00000000..56e07da9 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/describe-input.rst @@ -0,0 +1,34 @@ +**To get information about an input** + +The following ``describe-input`` example displays details for the specified input. :: + + aws iotevents describe-input \ + --input-name PressureInput + +Output:: + + { + "input": { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795312.542, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + }, + "inputDefinition": { + "attributes": [ + { + "jsonPath": "sensorData.pressure" + }, + { + "jsonPath": "motorid" + } + ] + } + } + } + + +For more information, see `DescribeInput `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/describe-logging-options.rst b/aws/dist/awscli/examples/iotevents/describe-logging-options.rst new file mode 100644 index 00000000..aba34c93 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/describe-logging-options.rst @@ -0,0 +1,17 @@ +**To get information about logging settings** + +The following ``describe-logging-options`` example retrieves the current settings of the AWS IoT Events logging options. :: + + aws iotevents describe-logging-options + +Output:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "enabled": false, + "level": "ERROR" + } + } + +For more information, see `DescribeLoggingOptions `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/list-detector-model-versions.rst b/aws/dist/awscli/examples/iotevents/list-detector-model-versions.rst new file mode 100644 index 00000000..575c0c98 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/list-detector-model-versions.rst @@ -0,0 +1,24 @@ +**To get information about versions of a detector model** + +The following ``list-detector-model-versions`` example Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. :: + + aws iotevents list-detector-model-versions \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorModelVersionSummaries": [ + { + "status": "ACTIVE", + "lastUpdateTime": 1560796816.077, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560796816.077, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectorModelVersions `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/list-detector-models.rst b/aws/dist/awscli/examples/iotevents/list-detector-models.rst new file mode 100644 index 00000000..8859d550 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/list-detector-models.rst @@ -0,0 +1,19 @@ +**To get a list of your detector models** + +The following ``list-detector-models`` example Lists the detector models you have created. Only the metadata associated with each detector model is returned. :: + + aws iotevents list-detector-models + +Output:: + + { + "detectorModelSummaries": [ + { + "detectorModelName": "motorDetectorModel", + "creationTime": 1552072424.212 + "detectorModelDescription": "Detect overpressure in a motor." + } + ] + } + +For more information, see `ListDetectorModels `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/list-detectors.rst b/aws/dist/awscli/examples/iotevents/list-detectors.rst new file mode 100644 index 00000000..3b04abf8 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/list-detectors.rst @@ -0,0 +1,25 @@ +**To get a list of detectors for a detector model** + +The following ``list-detectors`` example lists the detectors (the instances of a detector model) in your account. :: + + aws iotevents-data list-detectors \ + --detector-model-name motorDetectorModel + +Output:: + + { + "detectorSummaries": [ + { + "lastUpdateTime": 1558129925.2, + "creationTime": 1552073155.527, + "state": { + "stateName": "Normal" + }, + "keyValue": "Fulton-A32", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "1" + } + ] + } + +For more information, see `ListDetectors `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/list-inputs.rst b/aws/dist/awscli/examples/iotevents/list-inputs.rst new file mode 100644 index 00000000..aa1e6391 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/list-inputs.rst @@ -0,0 +1,21 @@ +**To list inputs** + +The following ``list-inputs`` example lists the inputs you have created in your account. :: + + aws iotevents list-inputs + +This command produces no output. +Output:: + + { + { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1551742986.768, + "creationTime": 1551742986.768, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `ListInputs `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/list-tags-for-resource.rst b/aws/dist/awscli/examples/iotevents/list-tags-for-resource.rst new file mode 100644 index 00000000..7cd45a70 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/list-tags-for-resource.rst @@ -0,0 +1,19 @@ +**To list tags assigned to a resource.** + +The following ``list-tags-for-resource`` example lists the tag key names and values you have assigned to the resource. :: + + aws iotevents list-tags-for-resource \ + --resource-arn "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput" + +Output:: + + { + "tags": [ + { + "value": "motor", + "key": "deviceType" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/put-logging-options.rst b/aws/dist/awscli/examples/iotevents/put-logging-options.rst new file mode 100644 index 00000000..2813aae8 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/put-logging-options.rst @@ -0,0 +1,26 @@ +**To set logging options** + +The following ``put-logging-options`` example sets or updates the AWS IoT Events logging options. If you update the value of any ``loggingOptions` field, it can take up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the ``roleArn`` field (for example, to correct an invalid policy) it can take up to five minutes for that change to take effect. :: + + aws iotevents put-logging-options \ + --cli-input-json file://logging-options.json + +Contents of ``logging-options.json``:: + + { + "loggingOptions": { + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "level": "DEBUG", + "enabled": true, + "detectorDebugOptions": [ + { + "detectorModelName": "motorDetectorModel", + "keyValue": "Fulton-A32" + } + ] + } + } + +This command produces no output. + +For more information, see `PutLoggingOptions `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/tag-resource.rst b/aws/dist/awscli/examples/iotevents/tag-resource.rst new file mode 100644 index 00000000..6ad5f48b --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/tag-resource.rst @@ -0,0 +1,22 @@ +**To add tags to a resource** + +The following ``tag-resource`` example adds or modifies (if key ``deviceType`` already exists) the tag attached the specified resource. :: + + aws iotevents tag-resource \ + --cli-input-json file://pressureInput.tag.json + +Contents of ``pressureInput.tag.json``:: + + { + "resourceArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "tags": [ + { + "key": "deviceType", + "value": "motor" + } + ] + } + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/untag-resource.rst b/aws/dist/awscli/examples/iotevents/untag-resource.rst new file mode 100644 index 00000000..3c2cdce7 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes the tag with the specified key name from the specified resource. :: + + aws iotevents untag-resource \ + --resource-arn arn:aws:iotevents:us-west-2:123456789012:input/PressureInput \ + --tagkeys deviceType + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/update-detector-model.rst b/aws/dist/awscli/examples/iotevents/update-detector-model.rst new file mode 100644 index 00000000..f2929628 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/update-detector-model.rst @@ -0,0 +1,139 @@ +**To update a detector model** + +The following ``update-detector-model`` example updates the specified detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. :: + + aws iotevents update-detector-model \ + --cli-input-json file://motorDetectorModel.update.json + +Contents of ``motorDetectorModel.update.json``:: + + { + "detectorModelName": "motorDetectorModel", + "detectorModelDefinition": { + "states": [ + { + "stateName": "Normal", + "onEnter": { + "events": [ + { + "eventName": "init", + "condition": "true", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "0" + } + } + ] + } + ] + }, + "onInput": { + "transitionEvents": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached + 3" + } + } + ], + "nextState": "Dangerous" + } + ] + } + }, + { + "stateName": "Dangerous", + "onEnter": { + "events": [ + { + "eventName": "Pressure Threshold Breached", + "condition": "$variable.pressureThresholdBreached > 1", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:underPressureAction" + } + } + ] + } + ] + }, + "onInput": { + "events": [ + { + "eventName": "Overpressurized", + "condition": "$input.PressureInput.sensorData.pressure > 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "3" + } + } + ] + }, + { + "eventName": "Pressure Okay", + "condition": "$input.PressureInput.sensorData.pressure <= 70", + "actions": [ + { + "setVariable": { + "variableName": "pressureThresholdBreached", + "value": "$variable.pressureThresholdBreached - 1" + } + } + ] + } + ], + "transitionEvents": [ + { + "eventName": "BackToNormal", + "condition": "$input.PressureInput.sensorData.pressure <= 70 && $variable.pressureThresholdBreached <= 1", + "nextState": "Normal" + } + ] + }, + "onExit": { + "events": [ + { + "eventName": "Normal Pressure Restored", + "condition": "true", + "actions": [ + { + "sns": { + "targetArn": "arn:aws:sns:us-east-1:123456789012:pressureClearedAction" + } + } + ] + } + ] + } + } + ], + "initialStateName": "Normal" + }, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole" + } + +Output:: + + { + "detectorModelConfiguration": { + "status": "ACTIVATING", + "lastUpdateTime": 1560799387.719, + "roleArn": "arn:aws:iam::123456789012:role/IoTEventsRole", + "creationTime": 1560799387.719, + "detectorModelArn": "arn:aws:iotevents:us-west-2:123456789012:detectorModel/motorDetectorModel", + "key": "motorid", + "detectorModelName": "motorDetectorModel", + "detectorModelVersion": "2" + } + } + +For more information, see `UpdateDetectorModel `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotevents/update-input.rst b/aws/dist/awscli/examples/iotevents/update-input.rst new file mode 100644 index 00000000..0045d561 --- /dev/null +++ b/aws/dist/awscli/examples/iotevents/update-input.rst @@ -0,0 +1,34 @@ +**To update an input** + +The following ``update-input`` example updates the specified input with a new description and definition. :: + + aws iotevents update-input \ + --cli-input-json file://pressureInput.json + +Contents of ``pressureInput.json``:: + + { + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor", + "inputDefinition": { + "attributes": [ + { "jsonPath": "sensorData.pressure" }, + { "jsonPath": "motorid" } + ] + } + } + +Output:: + + { + "inputConfiguration": { + "status": "ACTIVE", + "inputArn": "arn:aws:iotevents:us-west-2:123456789012:input/PressureInput", + "lastUpdateTime": 1560795976.458, + "creationTime": 1560795312.542, + "inputName": "PressureInput", + "inputDescription": "Pressure readings from a motor" + } + } + +For more information, see `UpdateInput `__ in the *AWS IoT Events API Reference*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst b/aws/dist/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst new file mode 100644 index 00000000..5831a34b --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/associate-entity-to-thing.rst @@ -0,0 +1,11 @@ +**To associate a thing with a device** + +The following ``associate-entity-to-thing`` example associates a thing with a device. The example uses a motion sensor device that is in the public namespace. :: + + aws iotthingsgraph associate-entity-to-thing \ + --thing-name "MotionSensorName" \ + --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" + +This command produces no output. + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/create-flow-template.rst b/aws/dist/awscli/examples/iotthingsgraph/create-flow-template.rst new file mode 100644 index 00000000..6107b290 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/create-flow-template.rst @@ -0,0 +1,18 @@ +**To create a flow** + +The following ``create-flow-template`` example creates a flow (workflow). The value of ``MyFlowDefinition`` is the GraphQL that models the flow. :: + + aws iotthingsgraph create-flow-template \ + --definition language=GRAPHQL,text="MyFlowDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559248067.545, + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/create-system-instance.rst b/aws/dist/awscli/examples/iotthingsgraph/create-system-instance.rst new file mode 100644 index 00000000..dceb91ad --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/create-system-instance.rst @@ -0,0 +1,23 @@ +**To create a system instance** + +The following ``create-system-instance`` example creates a system instance. The value of ``MySystemInstanceDefinition`` is the GraphQL that models the system instance. :: + + aws iotthingsgraph create-system-instance -\ + -definition language=GRAPHQL,text="MySystemInstanceDefinition" \ + --target CLOUD \ + --flow-actions-role-arn myRoleARN + +Output:: + + { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/create-system-template.rst b/aws/dist/awscli/examples/iotthingsgraph/create-system-template.rst new file mode 100644 index 00000000..6ffde18b --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/create-system-template.rst @@ -0,0 +1,19 @@ +**To create a system** + +The following ``create-system-template`` example creates a system. The value of MySystemDefinition is the GraphQL that models the system. :: + + aws iotthingsgraph create-system-template \ + --definition language=GRAPHQL,text="MySystemDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 1 + } + } + +For more information, see `Creating Systems `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/delete-flow-template.rst b/aws/dist/awscli/examples/iotthingsgraph/delete-flow-template.rst new file mode 100644 index 00000000..14c29545 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/delete-flow-template.rst @@ -0,0 +1,10 @@ +**To delete a flow** + +The following ``delete-flow-template`` example deletes a flow (workflow). :: + + aws iotthingsgraph delete-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/delete-namespace.rst b/aws/dist/awscli/examples/iotthingsgraph/delete-namespace.rst new file mode 100644 index 00000000..10dbc4c0 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/delete-namespace.rst @@ -0,0 +1,14 @@ +**To delete a namespace** + +The following ``delete-namespace`` example deletes a namespace. :: + + aws iotthingsgraph delete-namespace + +Output:: + + { + "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", + "namespaceName": "us-west-2/123456789012/default" + } + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/delete-system-instance.rst b/aws/dist/awscli/examples/iotthingsgraph/delete-system-instance.rst new file mode 100644 index 00000000..91c75d72 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/delete-system-instance.rst @@ -0,0 +1,10 @@ +**To delete a system instance** + +The following ``delete-system-instance`` example deletes a system instance. :: + + aws iotthingsgraph delete-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/delete-system-template.rst b/aws/dist/awscli/examples/iotthingsgraph/delete-system-template.rst new file mode 100644 index 00000000..54da0749 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/delete-system-template.rst @@ -0,0 +1,10 @@ +**To delete a system** + +The following ``delete-system-template`` example deletes a system. :: + + aws iotthingsgraph delete-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/deploy-system-instance.rst b/aws/dist/awscli/examples/iotthingsgraph/deploy-system-instance.rst new file mode 100644 index 00000000..46a94969 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/deploy-system-instance.rst @@ -0,0 +1,21 @@ +**To deploy a system instance** + +The following ``delete-system-template`` example deploys a system instance. :: + + aws iotthingsgraph deploy-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "summary": { + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment:Room218", + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "status": "DEPLOYED_IN_TARGET", + "target": "CLOUD", + "updatedAt": 1559249776.254 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/deprecate-flow-template.rst b/aws/dist/awscli/examples/iotthingsgraph/deprecate-flow-template.rst new file mode 100644 index 00000000..4260768f --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/deprecate-flow-template.rst @@ -0,0 +1,10 @@ +**To deprecate a flow** + +The following ``deprecate-flow-template`` example deprecates a flow (workflow). :: + + aws iotthingsgraph deprecate-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/deprecate-system-template.rst b/aws/dist/awscli/examples/iotthingsgraph/deprecate-system-template.rst new file mode 100644 index 00000000..d2ca79b6 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/deprecate-system-template.rst @@ -0,0 +1,10 @@ +**To deprecate a system** + +The following ``deprecate-system-template`` example deprecates a system. :: + + aws iotthingsgraph deprecate-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +This command produces no output. + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/describe-namespace.rst b/aws/dist/awscli/examples/iotthingsgraph/describe-namespace.rst new file mode 100644 index 00000000..806eab56 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/describe-namespace.rst @@ -0,0 +1,16 @@ +**To get a description of your namespace** + +The following ``describe-namespace`` example gets a description of your namespace. :: + + aws iotthingsgraph describe-namespace + +Output:: + + { + "namespaceName": "us-west-2/123456789012/default", + "trackingNamespaceName": "aws", + "trackingNamespaceVersion": 1, + "namespaceVersion": 5 + } + +For more information, see `Namespaces `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst b/aws/dist/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst new file mode 100644 index 00000000..46bdeff7 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/dissociate-entity-from-thing.rst @@ -0,0 +1,11 @@ +**To dissociate a thing from a device** + +The following ``dissociate-entity-from-thing`` example dissociates a thing from a device. :: + + aws iotthingsgraph dissociate-entity-from-thing \ + --thing-name "MotionSensorName" \ + --entity-type "DEVICE" + +This command produces no output. + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-entities.rst b/aws/dist/awscli/examples/iotthingsgraph/get-entities.rst new file mode 100644 index 00000000..6361006c --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-entities.rst @@ -0,0 +1,24 @@ +**To get definitions for entities** + +The following ``get-entities`` example gets a definition for a device model. :: + + aws iotthingsgraph get-entities \ + --ids "urn:tdm:aws/examples:DeviceModel:MotionSensor" + +Output:: + + { + "descriptions": [ + { + "id": "urn:tdm:aws/examples:DeviceModel:MotionSensor", + "type": "DEVICE_MODEL", + "createdAt": 1559256190.599, + "definition": { + "language": "GRAPHQL", + "text": "##\n# Specification of motion sensor devices interface.\n##\ntype MotionSensor @deviceModel(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\",\n capability: \"urn:tdm:aws/examples:capability:MotionSensorCapability\") {ignore:void}" + } + } + ] + } + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst b/aws/dist/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst new file mode 100644 index 00000000..df44b612 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-flow-template-revisions.rst @@ -0,0 +1,20 @@ +**To get revision information about a flow** + +The following ``get-flow-template-revisions`` example gets revision information about a flow (workflow). :: + + aws iotthingsgraph get-flow-template-revisions \ + --id urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-flow-template.rst b/aws/dist/awscli/examples/iotthingsgraph/get-flow-template.rst new file mode 100644 index 00000000..770947d6 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-flow-template.rst @@ -0,0 +1,25 @@ +**To get a flow definition** + +The following ``get-flow-template`` example gets a definition for a flow (workflow). :: + + aws iotthingsgraph get-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\nquery MyFlow($camera: string!, $screen: string!) @workflowType(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\") @annotation(type: \"tgc:FlowEvent\", id: \"sledged790c1b2bcd949e09da0c9bfc077f79d\", x: 1586, y: 653) @triggers(definition: \"{MotionSensor(description: \\\"\\\") @position(x: 1045, y: 635.6666564941406) {\\n condition(expr: \\\"devices[name == \\\\\\\"motionSensor\\\\\\\"].events[name == \\\\\\\"StateChanged\\\\\\\"].lastEvent\\\")\\n action(expr: \\\"\\\")\\n}}\") {\n variables {\n cameraResult @property(id: \"urn:tdm:aws/examples:property:CameraStateProperty\")\n }\n steps {\n step(name: \"Camera\", outEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1377, y: 638.6666564941406) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Camera\", out: \"cameraResult\", deviceId: \"${camera}\") {\n capture\n }\n }\n step(name: \"Screen\", inEvent: [\"sledged790c1b2bcd949e09da0c9bfc077f79d\"]) @position(x: 1675.6666870117188, y: 637.9999847412109) {\n DeviceActivity(deviceModel: \"urn:tdm:aws/examples:deviceModel:Screen\", deviceId: \"${screen}\") {\n display(imageUrl: \"${cameraResult.lastClickedImage}\")\n }\n }\n }\n}\n}" + }, + "validatedNamespaceVersion": 5 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst b/aws/dist/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst new file mode 100644 index 00000000..c584f39d --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-namespace-deletion-status.rst @@ -0,0 +1,15 @@ +**To get the status of the namespace deletion task** + +The following ``get-namespace-deletion-status`` example gets the status of the namespace deletion task. :: + + aws iotthingsgraph get-namespace-deletion-status + +Output:: + + { + "namespaceArn": "arn:aws:iotthingsgraph:us-west-2:123456789012", + "namespaceName": "us-west-2/123456789012/default" + "status": "SUCCEEDED " + } + +For more information, see `Namespaces `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-system-instance.rst b/aws/dist/awscli/examples/iotthingsgraph/get-system-instance.rst new file mode 100644 index 00000000..254f29ce --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-system-instance.rst @@ -0,0 +1,32 @@ +**To get a system instance** + +The following ``get-system-instance`` example gets a definition for a system instance. :: + + aws iotthingsgraph get-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\r\nquery Room218 @deployment(id: \"urn:tdm:us-west-2/123456789012/default:Deployment:Room218\", systemId: \"urn:tdm:us-west-2/123456789012/default:System:SecurityFlow\") {\r\n motionSensor(deviceId: \"MotionSensorName\")\r\n screen(deviceId: \"ScreenName\")\r\n camera(deviceId: \"CameraName\") \r\n triggers {MotionEventTrigger(description: \"a trigger\") { \r\n condition(expr: \"devices[name == 'motionSensor'].events[name == 'StateChanged'].lastEvent\") \r\n action(expr: \"ThingsGraph.startFlow('SecurityFlow', bindings[name == 'camera'].deviceId, bindings[name == 'screen'].deviceId)\")\r\n }\r\n }\r\n }\r\n }" + }, + "metricsConfiguration": { + "cloudMetricEnabled": false + }, + "validatedNamespaceVersion": 5, + "flowActionsRoleArn": "arn:aws:iam::123456789012:role/ThingsGraphRole" + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-system-template-revisions.rst b/aws/dist/awscli/examples/iotthingsgraph/get-system-template-revisions.rst new file mode 100644 index 00000000..a23b4f94 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-system-template-revisions.rst @@ -0,0 +1,21 @@ +**To get revision information about a system** + +The following ``get-system-template-revisions`` example gets revision information about a system. :: + + aws iotthingsgraph get-system-template-revisions \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 1, + "createdAt": 1559247540.656 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-system-template.rst b/aws/dist/awscli/examples/iotthingsgraph/get-system-template.rst new file mode 100644 index 00000000..a9ebe6dd --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-system-template.rst @@ -0,0 +1,26 @@ +**To get a system** + +The following ``get-system-template`` example gets a definition for a system. :: + + aws iotthingsgraph get-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" + +Output:: + + { + "description": { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.656 + }, + "definition": { + "language": "GRAPHQL", + "text": "{\ntype MySystem @systemType(id: \"urn:tdm:us-west-2/123456789012/default:System:MySystem\", description: \"\") {\n camera: Camera @thing(id: \"urn:tdm:aws/examples:deviceModel:Camera\")\n screen: Screen @thing(id: \"urn:tdm:aws/examples:deviceModel:Screen\")\n motionSensor: MotionSensor @thing(id: \"urn:tdm:aws/examples:deviceModel:MotionSensor\")\n MyFlow: MyFlow @workflow(id: \"urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow\")\n}\n}" + }, + "validatedNamespaceVersion": 5 + } + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/get-upload-status.rst b/aws/dist/awscli/examples/iotthingsgraph/get-upload-status.rst new file mode 100644 index 00000000..b7a7fd4c --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/get-upload-status.rst @@ -0,0 +1,17 @@ +**To get the status of your entity upload** + +The following ``get-upload-status`` example gets the status of your entity upload operation. The value of ``MyUploadId`` is the ID value returned by the ``upload-entity-definitions`` operation. :: + + aws iotthingsgraph get-upload-status \ + --upload-id "MyUploadId" + +Output:: + + { + "namespaceName": "us-west-2/123456789012/default", + "namespaceVersion": 5, + "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "uploadStatus": "SUCCEEDED" + } + +For more information, see `Modeling Entities `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst b/aws/dist/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst new file mode 100644 index 00000000..44b29142 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/list-flow-execution-messages.rst @@ -0,0 +1,21 @@ +**To get information about events in a flow execution** + +The following ``list-flow-execution-messages`` example gets information about events in a flow execution. :: + + aws iotthingsgraph list-flow-execution-messages \ + --flow-execution-id "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow_2019-05-11T19:39:55.317Z_MotionSensor_69b151ad-a611-42f5-ac21-fe537f9868ad" + +Output:: + + { + "messages": [ + { + "eventType": "EXECUTION_STARTED", + "messageId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "payload": "Flow execution started", + "timestamp": 1559247540.656 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/list-tags-for-resource.rst b/aws/dist/awscli/examples/iotthingsgraph/list-tags-for-resource.rst new file mode 100644 index 00000000..02e454d3 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/list-tags-for-resource.rst @@ -0,0 +1,19 @@ +**To list all tags for a resource** + +The following ``list-tags-for-resource`` example list all tags for an AWS IoT Things Graph resource. :: + + aws iotthingsgraph list-tags-for-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" + +Output:: + + { + "tags": [ + { + "key": "Type", + "value": "Residential" + } + ] + } + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-entities.rst b/aws/dist/awscli/examples/iotthingsgraph/search-entities.rst new file mode 100644 index 00000000..8c5a674d --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-entities.rst @@ -0,0 +1,40 @@ +**To search for entities** + +The following ``search-entities`` example searches for all entities of type ``EVENT``. :: + + aws iotthingsgraph search-entities \ + --entity-types "EVENT" + +Output:: + + { + "descriptions": [ + { + "id": "urn:tdm:aws/examples:Event:MotionSensorEvent", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "##\n# Description of events emitted by motion sensor.\n##\ntype MotionSensorEvent @eventType(id: \"urn:tdm:aws/examples:event:MotionSensorEvent\",\n payload: \"urn:tdm:aws/examples:property:MotionSensorStateProperty\") {ignore:void}" + } + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Event:CameraClickedEventV2", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "type CameraClickedEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:CameraClickedEventV2\",\r\npayload: \"urn:tdm:aws:Property:Boolean\"){ignore:void}" + } + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2", + "type": "EVENT", + "definition": { + "language": "GRAPHQL", + "text": "# Event emitted by the motion sensor.\r\ntype MotionSensorEventV2 @eventType(id: \"urn:tdm:us-west-2/123456789012/default:event:MotionSensorEventV2\",\r\npayload: \"urn:tdm:us-west-2/123456789012/default:property:MotionSensorStateProperty2\") {ignore:void}" + } + } + ], + "nextToken": "urn:tdm:us-west-2/123456789012/default:Event:MotionSensorEventV2" + } + +For more information, see `AWS IoT Things Graph Data Model Reference `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-flow-executions.rst b/aws/dist/awscli/examples/iotthingsgraph/search-flow-executions.rst new file mode 100644 index 00000000..9057dd56 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-flow-executions.rst @@ -0,0 +1,23 @@ +**To search for flow executions** + +The following ``search-flow-executions`` example search for all executions of a flow in a specified system instance. :: + + aws iotthingsgraph search-flow-executions \ + --system-instance-id "urn:tdm:us-west-2/123456789012/default:Deployment:Room218" + +Output:: + + { + "summaries": [ + { + "createdAt": 1559247540.656, + "flowExecutionId": "f6294f1e-b109-4bbe-9073-f451a2dda2da", + "flowTemplateId": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "status": "RUNNING ", + "systemInstanceId": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "updatedAt": 1559247540.656 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-flow-templates.rst b/aws/dist/awscli/examples/iotthingsgraph/search-flow-templates.rst new file mode 100644 index 00000000..3e8aec05 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-flow-templates.rst @@ -0,0 +1,25 @@ +**To search for flows (or workflows)** + +The following ``search-flow-templates`` example searches for all flows (workflows) that contain the Camera device model. :: + + aws iotthingsgraph search-flow-templates \ + --filters name="DEVICE_MODEL_ID",value="urn:tdm:aws/examples:DeviceModel:Camera" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 1, + "createdAt": 1559247540.292 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow", + "revisionNumber": 3, + "createdAt": 1548283099.27 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-system-instances.rst b/aws/dist/awscli/examples/iotthingsgraph/search-system-instances.rst new file mode 100644 index 00000000..50b2fb96 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-system-instances.rst @@ -0,0 +1,63 @@ +**To search for system instances** + +The following ``search-system-instances`` example searches for all system instances that contain the specified system. :: + + aws iotthingsgraph search-system-instances \ + --filters name="SYSTEM_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:System:SecurityFlow" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:DeploymentForSample", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/DeploymentForSample", + "status": "NOT_DEPLOYED", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1555716314.707, + "updatedAt": 1555716314.707 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment", + "status": "DELETED_IN_TARGET", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1549416462.049, + "updatedAt": 1549416722.361, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "7365aed7-2d3e-4d13-aad8-75443d45eb05" + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:MockDeployment2", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/MockDeployment2", + "status": "DEPLOYED_IN_TARGET", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1549572385.774, + "updatedAt": 1549572418.408, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "bfa70ab3-2bf7-409c-a4d4-bc8328ae5b86" + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", + "status": "NOT_DEPLOYED", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGG", + "createdAt": 1547056918.413, + "updatedAt": 1547056918.413 + }, + { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room218", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218", + "status": "NOT_DEPLOYED", + "target": "CLOUD", + "createdAt": 1559249315.208, + "updatedAt": 1559249315.208 + } + ] + } + +For more information, see `Working with Systems and Flow Configurations `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-system-templates.rst b/aws/dist/awscli/examples/iotthingsgraph/search-system-templates.rst new file mode 100644 index 00000000..5c570f52 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-system-templates.rst @@ -0,0 +1,21 @@ +**To search for system** + +The following ``search-system-templates`` example searches for all systems that contain the specified flow. :: + + aws iotthingsgraph search-system-templates \ + --filters name="FLOW_TEMPLATE_ID",value="urn:tdm:us-west-2/123456789012/default:Workflow:SecurityFlow" + +Output:: + + { + "summaries": [ + { + "id": "urn:tdm:us-west-2/123456789012/default:System:SecurityFlow", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/SecurityFlow", + "revisionNumber": 1, + "createdAt": 1548283099.433 + } + ] + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/search-things.rst b/aws/dist/awscli/examples/iotthingsgraph/search-things.rst new file mode 100644 index 00000000..c403f6d0 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/search-things.rst @@ -0,0 +1,23 @@ +**To search for things associated with devices and device models** + +The following ``search-things`` example searches for all things that are associated with the HCSR501MotionSensor device. :: + + aws iotthingsgraph search-things \ + --entity-id "urn:tdm:aws/examples:Device:HCSR501MotionSensor" + +Output:: + + { + "things": [ + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/MotionSensor1", + "thingName": "MotionSensor1" + }, + { + "thingArn": "arn:aws:iot:us-west-2:123456789012:thing/TG_MS", + "thingName": "TG_MS" + } + ] + } + +For more information, see `Creating and Uploading Models `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/tag-resource.rst b/aws/dist/awscli/examples/iotthingsgraph/tag-resource.rst new file mode 100644 index 00000000..68824e0e --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/tag-resource.rst @@ -0,0 +1,11 @@ +**To create a tag for a resource** + +The following ``tag-resource`` example creates a tag for the specified resource. :: + + aws iotthingsgraph tag-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ + --tags key="Type",value="Residential" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/undeploy-system-instance.rst b/aws/dist/awscli/examples/iotthingsgraph/undeploy-system-instance.rst new file mode 100644 index 00000000..7413a37e --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/undeploy-system-instance.rst @@ -0,0 +1,24 @@ +**To undeploy a system instance from its target** + +The following ``undeploy-system-instance`` example removes a system instance from its target. :: + + aws iotthingsgraph undeploy-system-instance \ + --id "urn:tdm:us-west-2/123456789012/default:Deployment:Room215" + +Output:: + + { + "summary": { + "id": "urn:tdm:us-west-2/123456789012/default:Deployment:Room215", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room215", + "status": "PENDING_DELETE", + "target": "GREENGRASS", + "greengrassGroupName": "ThingsGraphGrnGr", + "createdAt": 1553189694.255, + "updatedAt": 1559344549.601, + "greengrassGroupId": "01d04b07-2a51-467f-9d03-0c90b3cdcaaf", + "greengrassGroupVersionId": "731b371d-d644-4b67-ac64-3934e99b75d7" + } + } + +For more information, see `Lifecycle Management for AWS IoT Things Graph Entities, Flows, Systems, and Deployments `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/untag-resource.rst b/aws/dist/awscli/examples/iotthingsgraph/untag-resource.rst new file mode 100644 index 00000000..028eca1e --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove a tag for a resource** + +The following ``untag-resource`` example removes a tag for the specified resource. :: + + aws iotthingsgraph untag-resource \ + --resource-arn "arn:aws:iotthingsgraph:us-west-2:123456789012:Deployment/default/Room218" \ + --tag-keys "Type" + +This command produces no output. + +For more information, see `Tagging Your AWS IoT Things Graph Resources `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/update-flow-template.rst b/aws/dist/awscli/examples/iotthingsgraph/update-flow-template.rst new file mode 100644 index 00000000..3cdec514 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/update-flow-template.rst @@ -0,0 +1,19 @@ +**To update a flow** + +The following ``update-flow-template`` example updates a flow (workflow). The value of ``MyFlowDefinition`` is the GraphQL that models the flow. :: + + aws iotthingsgraph update-flow-template \ + --id "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow" \ + --definition language=GRAPHQL,text="MyFlowDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559248067.545, + "id": "urn:tdm:us-west-2/123456789012/default:Workflow:MyFlow", + "revisionNumber": 2 + } + } + +For more information, see `Working with Flows `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/update-system-template.rst b/aws/dist/awscli/examples/iotthingsgraph/update-system-template.rst new file mode 100644 index 00000000..7a6fcbdf --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/update-system-template.rst @@ -0,0 +1,20 @@ +**To update a system** + +The following ``update-system-template`` example updates a system. The value of ``MySystemDefinition`` is the GraphQL that models the system. :: + + aws iotthingsgraph update-system-template \ + --id "urn:tdm:us-west-2/123456789012/default:System:MySystem" \ + --definition language=GRAPHQL,text="MySystemDefinition" + +Output:: + + { + "summary": { + "createdAt": 1559249776.254, + "id": "urn:tdm:us-west-2/123456789012/default:System:MySystem", + "arn": "arn:aws:iotthingsgraph:us-west-2:123456789012:System/default/MySystem", + "revisionNumber": 2 + } + } + +For more information, see `Creating Systems `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/iotthingsgraph/upload-entity-definitions.rst b/aws/dist/awscli/examples/iotthingsgraph/upload-entity-definitions.rst new file mode 100644 index 00000000..e99f5de7 --- /dev/null +++ b/aws/dist/awscli/examples/iotthingsgraph/upload-entity-definitions.rst @@ -0,0 +1,14 @@ +**To upload entity definitions** + +The following ``upload-entity-definitions`` example uploads entity definitions to your namespace. The value of ``MyEntityDefinitions`` is the GraphQL that models the entities. :: + + aws iotthingsgraph upload-entity-definitions \ + --document language=GRAPHQL,text="MyEntityDefinitions" + +Output:: + + { + "uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da" + } + +For more information, see `Modeling Entities `__ in the *AWS IoT Things Graph User Guide*. diff --git a/aws/dist/awscli/examples/kafka/create-cluster.rst b/aws/dist/awscli/examples/kafka/create-cluster.rst new file mode 100644 index 00000000..65726b64 --- /dev/null +++ b/aws/dist/awscli/examples/kafka/create-cluster.rst @@ -0,0 +1,31 @@ +**To create an Amazon MSK cluster** + +The following ``create-cluster`` example creates an MSK cluster named ``MessagingCluster`` with three broker nodes. A JSON file named ``brokernodegroupinfo.json`` specifies the three subnets over which you want Amazon MSK to distribute the broker nodes. This example doesn't specify the monitoring level, so the cluster gets the ``DEFAULT`` level. :: + + aws kafka create-cluster \ + --cluster-name "MessagingCluster" \ + --broker-node-group-info file://brokernodegroupinfo.json \ + --kafka-version "2.2.1" \ + --number-of-broker-nodes 3 + +Contents of ``brokernodegroupinfo.json``:: + + { + "InstanceType": "kafka.m5.xlarge", + "BrokerAZDistribution": "DEFAULT", + "ClientSubnets": [ + "subnet-0123456789111abcd", + "subnet-0123456789222abcd", + "subnet-0123456789333abcd" + ] + } + +Output:: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterName": "MessagingCluster", + "State": "CREATING" + } + +For more information, see `Create an Amazon MSK Cluster `__ in the *Amazon Managed Streaming for Apache Kafka*. diff --git a/aws/dist/awscli/examples/kafka/create-configuration.rst b/aws/dist/awscli/examples/kafka/create-configuration.rst new file mode 100644 index 00000000..d1974231 --- /dev/null +++ b/aws/dist/awscli/examples/kafka/create-configuration.rst @@ -0,0 +1,32 @@ +**To create a custom Amazon MSK configuration** + +The following ``create-configuration`` example creates a custom MSK configuration with the server properties that are specified in the input file. :: + + aws kafka create-configuration \ + --name "CustomConfiguration" \ + --description "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms." \ + --kafka-versions "2.2.1" \ + --server-properties file://configuration.txt + +Contents of ``configuration.txt``:: + + auto.create.topics.enable = true + zookeeper.connection.timeout.ms = 2000 + log.roll.ms = 604800000 + +This command produces no output. +Output:: + + { + "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "CreationTime": "2019-10-09T15:26:05.548Z", + "LatestRevision": + { + "CreationTime": "2019-10-09T15:26:05.548Z", + "Description": "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms.", + "Revision": 1 + }, + "Name": "CustomConfiguration" + } + +For more information, see `Amazon MSK Configuration Operations `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff --git a/aws/dist/awscli/examples/kafka/update-broker-storage.rst b/aws/dist/awscli/examples/kafka/update-broker-storage.rst new file mode 100644 index 00000000..771aa404 --- /dev/null +++ b/aws/dist/awscli/examples/kafka/update-broker-storage.rst @@ -0,0 +1,18 @@ +**To update the EBS storage for brokers** + +The following ``update-broker-storage`` example updates the amount of EBS storage for all the brokers in the cluster. Amazon MSK sets the target storage amount for each broker to the amount specified in the example. You can get the current version of the cluster by describing the cluster or by listing all of the clusters. :: + + + aws kafka update-broker-storage \ + --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ + --current-version "K21V3IB1VIZYYH" \ + --target-broker-ebs-volume-info "KafkaBrokerNodeId=ALL,VolumeSizeGB=1100" + +The output returns an ARN for this ``update-broker-storage`` operation. To determine if this operation is complete, use the ``describe-cluster-operation`` command with this ARN as input. :: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" + } + +For more information, see `Update the EBS Storage for Brokers `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff --git a/aws/dist/awscli/examples/kafka/update-cluster-configuration.rst b/aws/dist/awscli/examples/kafka/update-cluster-configuration.rst new file mode 100644 index 00000000..bb9ee357 --- /dev/null +++ b/aws/dist/awscli/examples/kafka/update-cluster-configuration.rst @@ -0,0 +1,25 @@ +**To update the configuration of an Amazon MSK cluster** + +The following ``update-cluster-configuration`` example updates the configuration of the specified existing MSK cluster. It uses a custom MSK configuration. :: + + + aws kafka update-cluster-configuration \ + --cluster-arn "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2" \ + --configuration-info file://configuration-info.json \ + --current-version "K21V3IB1VIZYYH" + +Contents of ``configuration-info.json``:: + + { + "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "Revision": 1 + } + +The output returns an ARN for this ``update-cluster-configuration`` operation. To determine if this operation is complete, use the ``describe-cluster-operation`` command with this ARN as input. :: + + { + "ClusterArn": "arn:aws:kafka:us-west-2:123456789012:cluster/MessagingCluster/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2", + "ClusterOperationArn": "arn:aws:kafka:us-west-2:123456789012:cluster-operation/V123450123/a1b2c3d4-1234-abcd-cdef-22222EXAMPLE-2/a1b2c3d4-abcd-1234-bcde-33333EXAMPLE" + } + +For more information, see `Update the Configuration of an Amazon MSK Cluster `__ in the *Amazon Managed Streaming for Apache Kafka Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/cancel-key-deletion.rst b/aws/dist/awscli/examples/kms/cancel-key-deletion.rst new file mode 100644 index 00000000..b02ba4c9 --- /dev/null +++ b/aws/dist/awscli/examples/kms/cancel-key-deletion.rst @@ -0,0 +1,26 @@ +**To cancel the scheduled deletion of a customer managed CMK** + +The following ``cancel-key-deletion`` example cancels the scheduled deletion of a customer managed CMK and re-enables the CMK so you can use it in cryptographic operations. + +The first command in the example uses the ``cancel-key-deletion`` command to cancel the scheduled deletion of the CMK. It uses the ``--key-id`` parameter to identify the CMK. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. + + +To re-enable the CMK, use the ``enable-key`` command. To identify the CMK, use the ``--key-id`` parameter. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. :: + + aws kms cancel-key-deletion \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The ``cancel-key-deletion`` response returns the key ARN of the CMK whose deletion was canceled. :: + + { + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab" + } + +When the ``cancel-key-deletion`` command succeeds, the scheduled deletion is canceled. However, the key state of the CMK is ``Disabled``, so you can't use the CMK in cryptographic operations. To restore its functionality, you must re-enable the CMK. :: + + aws kms enable-key \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The ``enable-key`` operation does not return a response. To verify that the CMK is re-enabled and there is no deletion date associated with the CMK, use the ``describe-key`` operation. + +For more information, see `Scheduling and Canceling Key Deletion `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/connect-custom-key-store.rst b/aws/dist/awscli/examples/kms/connect-custom-key-store.rst new file mode 100755 index 00000000..476369bb --- /dev/null +++ b/aws/dist/awscli/examples/kms/connect-custom-key-store.rst @@ -0,0 +1,10 @@ +**To connect a custom key store** + +The following ``connect-custom-key-store`` example reconnects the specified custom key store. You can use a command like this one to connect a custom key store for the first time or to reconnect a key store that was disconnected. :: + + aws kms connect-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the command was effective, use the ``describe-custom-key-stores`` command. + +For more information, see `Connecting and Disconnecting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/create-alias.rst b/aws/dist/awscli/examples/kms/create-alias.rst new file mode 100644 index 00000000..e878f580 --- /dev/null +++ b/aws/dist/awscli/examples/kms/create-alias.rst @@ -0,0 +1,9 @@ +**To create an alias for a CMK** + +The following ``create-alias`` command creates an alias named ``example-alias`` for the customer master key (CMK) identified by key ID ``1234abcd-12ab-34cd-56ef-1234567890ab``. + +Alias names must begin with ``alias/``. Do not use alias names that begin with ``alias/aws``; these are reserved for use by AWS. :: + + aws kms create-alias \ + --alias-name alias/example-alias \ + --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab diff --git a/aws/dist/awscli/examples/kms/create-custom-key-store.rst b/aws/dist/awscli/examples/kms/create-custom-key-store.rst new file mode 100755 index 00000000..f56cf26d --- /dev/null +++ b/aws/dist/awscli/examples/kms/create-custom-key-store.rst @@ -0,0 +1,25 @@ +**To create a custom key store** + +The following ``create-custom-key-store`` example creates a custom key store with an existing custom key store. + +* This example uses the ``custom-key-store-name`` parameter to assign ``ExampleKeyStore`` as a friendly name for the key store. + +* It uses the ``cloud-hsm-cluster-id`` parameter to identify the ``cluster-1a23b4cdefg`` cluster. + +* It uses the ``key-store-password`` parameter to provide the password of the ``kmsuser`` user in the ``cluster-1a23b4cdefg`` cluster. This gives AWS KMS permission to use the cluster on your behalf. + +* It uses the ``trust-anchor-certificate`` parameter to specify the ``customerCA.crt`` file. In the AWS CLI, the ``file://`` prefix is required. :: + + aws kms create-custom-key-store \ + --custom-key-store-name ExampleKeyStore \ + --cloud-hsm-cluster-id cluster-1a23b4cdefg \ + --key-store-password kmsPswd \ + --trust-anchor-certificate file://customerCA.crt + +The output of this command includes the ID of the new custom key store. You can use this ID to identify the custom key store in other AWS KMS CLI commands. :: + + { + "CustomKeyStoreId": cks-1234567890abcdef0 + } + +For more information, see `Creating a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/kms/create-grant.rst b/aws/dist/awscli/examples/kms/create-grant.rst new file mode 100755 index 00000000..c8c6a42f --- /dev/null +++ b/aws/dist/awscli/examples/kms/create-grant.rst @@ -0,0 +1,21 @@ +**To create a grant** + +The following ``create-grant`` example creates a grant that allows the ``exampleUser`` user to use the ``decrypt`` command on the ``1234abcd-12ab-34cd-56ef-1234567890ab`` example CMK. The retiring principal is the ``adminRole`` role. The grant uses the ``EncryptionContextSubset`` grant constraint to allow this permission only when the encryption context in the ``decrypt`` request includes the "Department": "IT" key-value pair. :: + + aws kms create-grant \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --grantee-principal arn:aws:iam::123456789012:user/exampleUser \ + --operations Decrypt \ + --constraints EncryptionContextSubset={Department=IT} \ + --retiring-principal arn:aws:iam::123456789012:role/adminRole + +The output of this command includes the ID of the new grant and a grant token. You can use the ID and token to identify the grant to other AWS KMS CLI commands, including ``retire-grant`` and ``revoke-grant``. :: + + { + "GrantId": "1a2b3c4d2f5e69f440bae30eaec9570bb1fb7358824f9ddfa1aa5a0dab1a59b2", + "GrantToken": "" + } + +To view detailed information about the grant, use the ``list-grants`` command. + +For more information, see `Using Grants `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/create-key.rst b/aws/dist/awscli/examples/kms/create-key.rst new file mode 100644 index 00000000..052d62e6 --- /dev/null +++ b/aws/dist/awscli/examples/kms/create-key.rst @@ -0,0 +1,33 @@ +**To create a customer managed CMK in AWS KMS** + +The following ``create-key`` example creates a customer managed CMK. + +* The ``--tags`` parameter uses shorthand syntax to add a tag with a key name ``Purpose`` and value of ``Test``. For information about using shorthand syntax, see `Using Shorthand Syntax with the AWS Command Line Interface `__ in the *AWS CLI User Guide*. +* The ``--description parameter`` adds an optional description. + +Because this doesn't specify a policy, the CMK gets the `default key policy __. To view the key policy, use the ``get-key-policy`` command. To change the key policy, use the ``put-key-policy`` command. :: + + aws kms create-key \ + --tags TagKey=Purpose,TagValue=Test \ + --description "Development test key" + +The ``create-key`` command returns the key metadata, including the key ID and ARN of the new CMK. You can use these values to identify the CMK to other AWS KMS operations. The output does not include the tags. To view the tags for a CMK, use the ``list-resource-tags command``. :: + + { + "KeyMetadata": { + "AWSAccountId": "123456789012", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": 1566160362.664, + "Enabled": true, + "Description": "Development test key", + "KeyUsage": "ENCRYPT_DECRYPT", + "KeyState": "Enabled", + "Origin": "AWS_KMS", + "KeyManager": "CUSTOMER" + } + } + +Note: The ``create-key`` command does not let you specify an alias, To create an alias that points to the new CMK, use the ``create-alias`` command. + +For more information, see `Creating Keys `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/decrypt.rst b/aws/dist/awscli/examples/kms/decrypt.rst new file mode 100644 index 00000000..366cd978 --- /dev/null +++ b/aws/dist/awscli/examples/kms/decrypt.rst @@ -0,0 +1,41 @@ +**Example 1: To decrypt an encrypted file** + +The following ``decrypt`` command demonstrates the recommended way to decrypt data with the AWS CLI. :: + + aws kms decrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --output text \ + --query Plaintext | base64 --decode > ExamplePlaintextFile + +The command does several things: + +#. Uses the ``fileb://`` prefix to specify the ``--ciphertext-blob`` parameter. + + The ``fileb://`` prefix instructs the CLI to read the encrypted data, called the *ciphertext*, from a file and pass the file's contents to the command's ``--ciphertext-blob`` parameter. If the file is not in the current directory, type the full path to file. For example: ``fileb:///var/tmp/ExampleEncryptedFile`` or ``fileb://C:\Temp\ExampleEncryptedFile``. + + For more information about reading AWS CLI parameter values from a file, see `Loading Parameters from a File `_ in the *AWS Command Line Interface User Guide* and `Best Practices for Local File Parameters `_ on the AWS Command Line Tool Blog. + + The command assumes the ciphertext in ``ExampleEncryptedFile`` is binary data. The `encrypt examples `_ demonstrate how to save a ciphertext this way. + +#. Uses the ``--output`` and ``--query`` parameters to control the command's output. + + These parameters extract the decrypted data, called the *plaintext*, from the command's output. For more information about controlling output, see `Controlling Command Output `_ in the *AWS Command Line Interface User Guide*. + +#. Uses the ``base64`` utility. + + This utility decodes the extracted plaintext to binary data. The plaintext that is returned by a successful ``decrypt`` command is base64-encoded text. You must decode this text to obtain the original plaintext. + +#. Saves the binary plaintext to a file. + + The final part of the command (``> ExamplePlaintextFile``) saves the binary plaintext data to a file. + +**Example 2: Using the AWS CLI to decrypt data from the Windows command prompt** + +The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and Mac OS X. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. :: + + aws kms decrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --output text \ + --query Plaintext > ExamplePlaintextFile.base64 + + certutil -decode ExamplePlaintextFile.base64 ExamplePlaintextFile diff --git a/aws/dist/awscli/examples/kms/delete-alias.rst b/aws/dist/awscli/examples/kms/delete-alias.rst new file mode 100644 index 00000000..597da007 --- /dev/null +++ b/aws/dist/awscli/examples/kms/delete-alias.rst @@ -0,0 +1,12 @@ +**To delete an AWS KMS alias** + +The following ``delete-alias`` example deletes the alias ``alias/example-alias``. + +* The ``--alias-name`` parameter specifies the alias to delete. The alias name must begin with `alias/`. :: + + aws kms delete-alias \ + --alias-name alias/example-alias + +This command produces no output. To find the alias, use the ``list-aliases`` command. + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/delete-custom-key-store.rst b/aws/dist/awscli/examples/kms/delete-custom-key-store.rst new file mode 100755 index 00000000..dff56ee0 --- /dev/null +++ b/aws/dist/awscli/examples/kms/delete-custom-key-store.rst @@ -0,0 +1,12 @@ +**To delete a custom key store** + +The following ``delete-custom-key-store`` example deletes the specified custom key store. This command doesn't have any effect on the associated CloudHSM cluster. + +**NOTE:** Before you can delete a custom key store, you must schedule the deletion of all CMKs in the custom key store and then wait for those CMKs to be deleted. Then, you must disconnect the custom key store. :: + + delete-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the custom key store is deleted, use the ``describe-custom-key-stores`` command. + +For more information, see `Deleting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/describe-custom-key-stores.rst b/aws/dist/awscli/examples/kms/describe-custom-key-stores.rst new file mode 100755 index 00000000..5bfdb44f --- /dev/null +++ b/aws/dist/awscli/examples/kms/describe-custom-key-stores.rst @@ -0,0 +1,25 @@ +**To get details about a custom key store** + +The following ``describe-custom-key-store`` example displays details for the specified custom key store. You can use this command to get details about a particular custom key store or all custom key stores in an AWS account and Region. + +To identify a particular custom key store, this example uses the ``custom-key-store-name`` parameter with the key store name. If you prefer, you can use the ``custom-key-store-id`` parameter with the key store ID. To get all custom key stores in the account and Region, omit all parameters. :: + + aws kms describe-custom-key-stores \ + --custom-key-store-name ExampleKeyStore + +The output of this command includes useful details about the custom key store including its connection state (``ConnectionState``). If the connection state is ``FAILED``, the output includes a ``ConnectionErrorCode`` field that describes the problem. :: + + { + "CustomKeyStores": [ + { + "CloudHsmClusterId": "cluster-1a23b4cdefg", + "ConnectionState": "CONNECTED", + "CreationDate": "1.599288695918E9", + "CustomKeyStoreId": "cks-1234567890abcdef0", + "CustomKeyStoreName": "ExampleKeyStore", + "TrustAnchorCertificate": "" + } + ] + } + +For more information, see `Viewing a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/describe-key.rst b/aws/dist/awscli/examples/kms/describe-key.rst new file mode 100755 index 00000000..3134135c --- /dev/null +++ b/aws/dist/awscli/examples/kms/describe-key.rst @@ -0,0 +1,26 @@ +**To find detailed information about a customer master key (CMK)** + +The following ``describe-key`` example retrieves detailed information about the AWS managed CMK for Amazon S3. + +This example uses an alias name value for the ``--key-id`` parameter, but you can use a key ID, key ARN, alias name, or alias ARN in this command. :: + + aws kms describe-key --key-id alias/aws/s3 + +Output:: + + { + "KeyMetadata": { + "Description": "Default master key that protects my S3 objects when no other key is defined", + "Arn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyState": "Enabled", + "Origin": "AWS_KMS", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyUsage": "ENCRYPT_DECRYPT", + "AWSAccountId": "123456789012", + "Enabled": true, + "KeyManager": "AWS", + "CreationDate": 1566518783.394 + } + } + +For more information, see `Viewing Keys`__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/kms/disconnect-custom-key-store.rst b/aws/dist/awscli/examples/kms/disconnect-custom-key-store.rst new file mode 100755 index 00000000..7e7de94a --- /dev/null +++ b/aws/dist/awscli/examples/kms/disconnect-custom-key-store.rst @@ -0,0 +1,10 @@ +**To disconnect a custom key store** + +The following ``disconnect-custom-key-store`` example disconnects the specified custom key store. :: + + aws kms disconnect-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 + +This command does not return any output. To verify that the command was effective, use the ``describe-custom-key-stores`` command. + +For more information, see `Connecting and Disconnecting a Custom Key Store `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/encrypt.rst b/aws/dist/awscli/examples/kms/encrypt.rst new file mode 100644 index 00000000..077e48d9 --- /dev/null +++ b/aws/dist/awscli/examples/kms/encrypt.rst @@ -0,0 +1,44 @@ +**Example 1: To encrypt the contents of a file on Linux or MacOS** + +The following ``encrypt`` command demonstrates the recommended way to encrypt data with the AWS CLI. :: + + aws kms encrypt \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --plaintext fileb://ExamplePlaintextFile \ + --output text \ + --query CiphertextBlob | base64 \ + --decode > ExampleEncryptedFile + +The command does several things: + +#. Uses the ``fileb://`` prefix to specify the ``--plaintext`` parameter. + + The ``fileb://`` prefix instructs the CLI to read the data to encrypt, called the *plaintext*, from a file and pass the file's contents to the command's ``--plaintext`` parameter. If the file is not in the current directory, type the full path to file. For example: ``fileb:///var/tmp/ExamplePlaintextFile`` or ``fileb://C:\Temp\ExamplePlaintextFile``. + + For more information about reading AWS CLI parameter values from a file, see `Loading Parameters from a File `_ in the *AWS Command Line Interface User Guide* and `Best Practices for Local File Parameters `_ on the AWS Command Line Tool Blog + +#. Uses the ``--output`` and ``--query`` parameters to control the command's output. + + These parameters extract the encrypted data, called the *ciphertext*, from the command's output. + + For more information about controlling output, see `Controlling Command Output `_ in the *AWS Command Line Interface User Guide*. + +#. Uses the ``base64`` utility to decode the extracted output. + + This utility decodes the extracted ciphertext to binary data. The ciphertext that is returned by a successful ``encrypt`` command is base64-encoded text. You must decode this text before you can use the AWS CLI to decrypt it. + +#. Saves the binary ciphertext to a file. + + The final part of the command (``> ExampleEncryptedFile``) saves the binary ciphertext to a file to make decryption easier. For an example command that uses the AWS CLI to decrypt data, see the `decrypt examples `_. + +**Example 2: Using the AWS CLI to encrypt data on Windows** + +The preceding example assumes the ``base64`` utility is available, which is commonly the case on Linux and MacOS. For the Windows command prompt, use ``certutil`` instead of ``base64``. This requires two commands, as shown in the following examples. :: + + aws kms encrypt \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --plaintext fileb://ExamplePlaintextFile \ + --output text \ + --query CiphertextBlob > C:\Temp\ExampleEncryptedFile.base64 + + certutil -decode C:\Temp\ExampleEncryptedFile.base64 C:\Temp\ExampleEncryptedFile diff --git a/aws/dist/awscli/examples/kms/generate-random.rst b/aws/dist/awscli/examples/kms/generate-random.rst new file mode 100755 index 00000000..39ede94c --- /dev/null +++ b/aws/dist/awscli/examples/kms/generate-random.rst @@ -0,0 +1,52 @@ +**Example 1: To generate a 256-bit random number** + +The following ``generate-random`` example generates a 256-bit (32-byte) random number. + +When you run this command, you must use the ``number-of-bytes`` parameter to specify the length of the random number in bytes. + +You don't specify a CMK when you run this command. Unless you specify a `custom key store `__, AWS KMS generates the random number. It is not associated with any particular CMK. :: + + aws kms generate-random --number-of-bytes 32 + +In the output, the random number is in the ``Plaintext`` field. :: + + { + "Plaintext": "Hcl7v6T2E+Iangu357rhmlKZUnsb/LqzhHiNt6XNfQ0=" + } + +**Example 2: To generate a 256-bit random number and save it to a file (Linux or macOs)** + +The following example uses the ``generate-random`` command to generate a 256-bit (32-byte), base64-encoded random byte string on a Linix or macOS computer. The example decodes the byte string and saves it in the ``ExampleRandom`` file. + +When you run this command, you must use the ``number-of-bytes`` parameter to specify the length of the random number in bytes. + +You don't specify a CMK when you run this command. Unless you specify a `custom key store `__, AWS KMS generates the random number. It is not associated with any particular CMK. + +* The ``--number-of-bytes`` parameter with a value of ``32`` requests a 32-byte (256-bit) string. +* The ``--output`` parameter with a value of ``text`` directs the AWS CLI to return the output as text, instead of JSON. +* The ``--query`` parameter extracts the value of the ``Plaintext`` property from the response. +* The pipe operator ( | ) sends the output of the command to the ``base64`` utility, which decodes the extracted output. +* The redirection operator (>) saves the decoded byte string to the ``ExampleRandom`` file. + + aws kms generate-random --number-of-bytes 32 --output text --query Plaintext | base64 --decode > ExampleRandom + +This command produces no output. + +**Example 3: To generate a 256-bit random number and save it to a file(Windows Command Prompt)** + +The following example uses the ``generate-random`` command to generate a 256-bit (32-byte), base64-encoded random byte string. The example decodes the byte string and saves it in the `ExampleRandom.base64` file. + +This example is the same as the previous example, except that it uses the ``certutil`` utility in Windows to base64-decode the random byte string before saving it in a file. + +The first command generates the base64-encoded random byte string and saves it in a temporary file, ``ExampleRandom.base64``. The second command uses the ``certutil -decode`` command to decode the base64-encoded byte string in the ``ExampleRandom.base64`` file. Then, it saves the decoded byte string in the ``ExampleRandom`` file. :: + + aws kms generate-random --number-of-bytes 32 --output text --query Plaintext > ExampleRandom.base64 + certutil -decode ExampleRandom.base64 ExampleRandom + +Output:: + + Input Length = 18 + Output Length = 12 + CertUtil: -decode command completed successfully. + +For more information, see `GenerateRandom `__ in the *AWS Key Management Service API Reference*. diff --git a/aws/dist/awscli/examples/kms/get-key-policy.rst b/aws/dist/awscli/examples/kms/get-key-policy.rst new file mode 100644 index 00000000..deea8af0 --- /dev/null +++ b/aws/dist/awscli/examples/kms/get-key-policy.rst @@ -0,0 +1,20 @@ +**To copy a key policy from one CMK to another CMK** + +The following ``get-key-policy`` example gets the key policy from one CMK and saves it in a text file. Then, it replaces the policy of a different CMK using the text file as the policy input. + +Because the ``--policy`` parameter of ``put-key-policy`` requires a string, you must use the ``--output text`` option to return the output as a text string instead of JSON. :: + + aws kms get-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --query Policy \ + --output text > policy.txt + + aws kms put-key-policy \ + --policy-name default \ + --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --policy file://policy.txt + +This command produces no output. + +For more information, see `PutKeyPolicy `__ in the *AWS KMS API Reference*. diff --git a/aws/dist/awscli/examples/kms/list-aliases.rst b/aws/dist/awscli/examples/kms/list-aliases.rst new file mode 100755 index 00000000..b70e0ba6 --- /dev/null +++ b/aws/dist/awscli/examples/kms/list-aliases.rst @@ -0,0 +1,62 @@ +**Example 1: To list all aliases in an AWS account and Region** + +The following example uses the ``list-aliases`` command to list all aliases in the default Region of the AWS account. The output includes aliases associated with AWS managed CMKs and customer managed CMKs. :: + + aws kms list-aliases + +Output:: + + { + "Aliases": [ + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/testKey", + "AliasName": "alias/testKey", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/FinanceDept", + "AliasName": "alias/FinanceDept", + "TargetKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/dynamodb", + "AliasName": "alias/aws/dynamodb", + "TargetKeyId": "1a2b3c4d-5e6f-1a2b-3c4d-5e6f1a2b3c4d" + }, + { + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/aws/ebs", + "AliasName": "alias/aws/ebs", + "TargetKeyId": "0987ab65-43cd-21ef-09ab-87654321cdef" + }, + ... + ] + } + +**Example 2: To list all aliases for a particular CMK** + +The following example uses the ``list-aliases`` command and its ``key-id`` parameter to list all aliases that are associated with a particular CMK. + +Each alias is associated with only one CMK, but a CMK can have multiple aliases. This command is very useful because the AWS KMS console lists only one alias for each CMK. To find all aliases for a CMK, you must use the ``list-aliases`` command. + +This example uses the key ID of the CMK for the ``--key-id`` parameter, but you can use a key ID, key ARN, alias name, or alias ARN in this command. :: + + aws kms list-aliases --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +Output:: + + { + "Aliases": [ + { + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/oregon-test-key", + "AliasName": "alias/oregon-test-key" + }, + { + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "AliasArn": "arn:aws:kms:us-west-2:111122223333:alias/project121-test", + "AliasName": "alias/project121-test" + } + ] + } + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/kms/list-grants.rst b/aws/dist/awscli/examples/kms/list-grants.rst new file mode 100755 index 00000000..eb2d2d20 --- /dev/null +++ b/aws/dist/awscli/examples/kms/list-grants.rst @@ -0,0 +1,41 @@ +**To view the grants on an AWS CMK** + +The following ``list-grants`` example displays all of the grants on the specified AWS managed CMK for Amazon DynamoDB in your account. This grant allows DynamoDB to use the CMK on your behalf to encrypt a DynamoDB table before writing it to disk. You can use a command like this one to view the grants on the AWS managed CMKs and customer managed CMKs in the AWS account and Region. + +This command uses the ``key-id`` parameter with a key ID to identify the CMK. You can use a key ID or key ARN to identify the CMK. To get the key ID or key ARN of an AWS managed CMK, use the ``list-keys`` or ``list-aliases`` command. :: + + aws kms list-grants \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +The output shows that the grant gives Amazon DynamoDB permission to use the CMK for cryptographic operations, and gives it permission to view details about the CMK (``DescribeKey``) and to retire grants (``RetireGrant``). The ``EncryptionContextSubset`` constraint limits these permission to requests that include the specified encryption context pairs. As a result, the permissions in the grant are effective only on specified account and DynamoDB table. :: + + { + "Grants": [ + { + "Constraints": { + "EncryptionContextSubset": { + "aws:dynamodb:subscriberId": "123456789012", + "aws:dynamodb:tableName": "Services" + } + }, + "IssuingAccount": "arn:aws:iam::123456789012:root", + "Name": "8276b9a6-6cf0-46f1-b2f0-7993a7f8c89a", + "Operations": [ + "Decrypt", + "Encrypt", + "GenerateDataKey", + "ReEncryptFrom", + "ReEncryptTo", + "RetireGrant", + "DescribeKey" + ], + "GrantId": "1667b97d27cf748cf05b487217dd4179526c949d14fb3903858e25193253fe59", + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "RetiringPrincipal": "dynamodb.us-west-2.amazonaws.com", + "GranteePrincipal": "dynamodb.us-west-2.amazonaws.com", + "CreationDate": 1518567315.0 + } + ] + } + +For more information, see `Using Grants `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/put-key-policy.rst b/aws/dist/awscli/examples/kms/put-key-policy.rst new file mode 100755 index 00000000..b38bc011 --- /dev/null +++ b/aws/dist/awscli/examples/kms/put-key-policy.rst @@ -0,0 +1,80 @@ +**To change the key policy for a customer master key (CMK)** + +The following ``put-key-policy`` example changes the key policy for a customer managed CMK. + +To begin, create a key policy and save it in a local JSON file. In this example, the file is ``key_policy.json``. You can also specify the key policy as a string value of the ``policy`` parameter. + +The first statement in this key policy gives the AWS account permission to use IAM policies to control access to the CMK. The second statement gives the ``test-user`` user permission to run the ``describe-key`` and ``list-keys`` commands on the CMK. + +Contents of ``key_policy.json``:: + + { + "Version" : "2012-10-17", + "Id" : "key-default-1", + "Statement" : [ + { + "Sid" : "Enable IAM User Permissions", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:root" + }, + "Action" : "kms:", + "Resource" : "*" + }, + { + "Sid" : "Allow Use of Key", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:user/test-user" + }, + "Action" : [ + "kms:DescribeKey", + "kms:ListKeys" + ], + "Resource" : "*" + } + ] + } + +To identify the CMK, this example uses the key ID, but you can also usa key ARN. To specify the key policy, the command uses the ``policy`` parameter. To indicate that the policy is in a file, it uses the required ``file://`` prefix. This prefix is required to identify files on all supported operating systems. Finally, the command uses the ``policy-name`` parameter with a value of ``default``. This parameter is required, even though ``default`` is the only valid value. :: + + aws kms put-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --policy file://key_policy.json + +This command does not produce any output. To verify that the command was effective, use the ``get-key-policy`` command. The following example command gets the key policy for the same CMK. The ``output`` parameter with a value of ``text`` returns a text format that is easy to read. :: + + aws kms get-key-policy \ + --policy-name default \ + --key-id 1234abcd-12ab-34cd-56ef-1234567890ab \ + --output text + +Output:: + + { + "Version" : "2012-10-17", + "Id" : "key-default-1", + "Statement" : [ + { + "Sid" : "Enable IAM User Permissions", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:root" + }, + "Action" : "kms:", + "Resource" : "*" + }, + { + "Sid" : "Allow Use of Key", + "Effect" : "Allow", + "Principal" : { + "AWS" : "arn:aws:iam::111122223333:user/test-user" + }, + "Action" : [ "kms:Describe", "kms:List" ], + "Resource" : "*" + } + ] + } + +For more information, see `Changing a Key Policy `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/re-encrypt.rst b/aws/dist/awscli/examples/kms/re-encrypt.rst new file mode 100644 index 00000000..c2e597b9 --- /dev/null +++ b/aws/dist/awscli/examples/kms/re-encrypt.rst @@ -0,0 +1,76 @@ +**Example 1: To re-encrypt encrypted data under a different CMK** + +The following ``re-encrypt`` example re-encrypts data that was encrypted using the ``encrypt`` operation in the AWS CLI. You can use the ``re-encrypt`` command to re-encrypt the result of any AWS KMS operation that encrypted data or data keys. + +This example writes the output to the command line so you can see the all of the properties in the response. However, unless you're testing or demonstrating this operation, you should base64-decode the encrypted data and save it in a file. + +The command in this example re-encrypts the data under a different CMK, but you can re-encrypt it under the same CMK to change characteristics of the encryption, such as the encryption context. + +To run this command, you must have ``kms:ReEncryptFrom`` permission on the CMK that encrypted the data and ``kms:ReEncryptTo`` permissions on the CMK that you use to re-encrypt the data. + +* The ``--ciphertext-blob`` parameter identifies the ciphertext to re-encrypt. The file ``ExampleEncryptedFile`` contains the base64-decoded output of the encrypt command. +* The ``fileb://`` prefix of the file name tells the CLI to treat the input file as binary instead of text. +* The ``--destination-key-id`` parameter specifies the CMK under which the data is to be re-encrypted. This example uses the key ID to identify the CMK, but you can use a key ID, key ARN, alias name, or alias ARN in this command. +* You do not need to specify the CMK that was used to encrypt the data. AWS KMS gets that information from metadata in the ciphertext. :: + + aws kms re-encrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 + +The output includes the following properties: + +* The ``SourceKeyID`` is the key ID of the CMK that originally encrypted the CMK. +* The ``KeyId`` is the ID of the CMK that re-encrypted the data. +* The ``CiphertextBlob``, which is the re-encrypted data in base64-encoded format. :: + + { + "CiphertextBlob": "AQICAHgJtIvJqgOGUX6NLvVXnW5OOQT...", + "SourceKeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/0987dcba-09fe-87dc-65ba-ab0987654321" + } + +**Example 2: To re-encrypt encrypted data under a different CMK (Linux or macOs)** + +The following ``re-encrypt`` example demonstrates the recommended way to re-encrypt data with the AWS CLI. This example re-encrypts the ciphertext that was encrypted by the encrypt command, but you can use the same procedure to re-encrypt data keys. + +This example is the same as the previous example except that it does not write the output to the command line. Instead, after re-encrypting the ciphertext under a different CMK, it extracts the re-encrypted ciphertext from the response, base64-decodes it, and saves the binary data in a file. You can store the file safely. Then, you can use the file in decrypt or re-encrypt commands in the AWS CLI. + +To run this command, you must have ``kms:ReEncryptFrom`` permission on the CMK that encrypted the data and ``kms:ReEncryptTo`` permissions on the CMK that will re-encrypt the data. +The ``--ciphertext-blob`` parameter identifies the ciphertext to re-encrypt. + +* The ``fileb://`` prefix tells the CLI to treat the input file as binary instead of text. +* The ``--destination-key-id`` parameter specifies the CMK under which the data is re-encrypted. This example uses the key ID to identify the CMK, but you can use a key ID, key ARN, alias name, or alias ARN in this command. +* You do not need to specify the CMK that was used to encrypt the data. AWS KMS gets that information from metadata in the ciphertext. +* The ``--output`` parameter with a value of ``text`` directs the AWS CLI to return the output as text, instead of JSON. +* The ``--query`` parameter extracts the value of the ``CiphertextBlob`` property from the response. +* The pipe operator ( | ) sends the output of the CLI command to the ``base64`` utility, which decodes the extracted output. The ``CiphertextBlob`` that the re-encrypt operation returns is base64-encoded text. However, the ``decrypt`` and ``re-encrypt`` commands require binary data. The example decodes the base64-encoded ciphertext back to binary and then saves it in a file. You can use the file as input to the decrypt or re-encrypt commands. :: + + aws kms re-encrypt \ + --ciphertext-blob fileb://ExampleEncryptedFile \ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --output text \ + --query CiphertextBlob | base64 --decode > ExampleReEncryptedFile + +This command produces no output on screen because it is redirected to a file. + +**Example 3: To re-encrypted encrypted data under a different CMK (Windows Command Prompt)** + +This example is the same as the previous example, except that it uses the ``certutil`` utility in Windows to base64-decode the ciphertext before saving it in a file. + +* The first command re-encrypts the ciphertext and saves the base64-encoded ciphertext in a temporary file named ``ExampleReEncryptedFile.base64``. +* The second command uses the ``certutil -decode`` command to decode the base64-encoded ciphertext in the file to binary. Then, it saves the binary ciphertext in the file ``ExampleReEncryptedFile``. This file is ready to be used in a decrypt or re-encrypt command in the AWS CLI. :: + + aws kms re-encrypt ^ + --ciphertext-blob fileb://ExampleEncryptedFile ^ + --destination-key-id 0987dcba-09fe-87dc-65ba-ab0987654321 ^ + --output text ^ + --query CiphertextBlob > ExampleReEncryptedFile.base64 + certutil -decode ExampleReEncryptedFile.base64 ExampleReEncryptedFile + +Output:: + + Input Length = 18 + Output Length = 12 + CertUtil: -decode command completed successfully. + +For more information, see `ReEncrypt `__ in the *AWS Key Management Service API Reference*. diff --git a/aws/dist/awscli/examples/kms/schedule-key-deletion.rst b/aws/dist/awscli/examples/kms/schedule-key-deletion.rst new file mode 100644 index 00000000..ab0493b7 --- /dev/null +++ b/aws/dist/awscli/examples/kms/schedule-key-deletion.rst @@ -0,0 +1,19 @@ +**To schedule the deletion of a customer managed CMK.** + +The following ``schedule-key-deletion`` example schedules the specified customer managed CMK to be deleted in 15 days. + +* The ``--key-id`` parameter identifies the CMK. This example uses a key ARN value, but you can use either the key ID or the ARN of the CMK. +* The ``--pending-window-in-days`` parameter specifies the length of the waiting period. By default, the waiting period is 30 days. This example specifies a value of 15, which tells AWS to permanently delete the CMK 15 days after the command completes. :: + + aws kms schedule-key-deletion \ + --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ + --pending-window-in-days 15 + +The response returns the key ARN and the deletion date in Unix time. To view the deletion date in local time, use the AWS KMS console. :: + + { + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "DeletionDate": 1567382400.0 + } + +For more information, see `Deleting Customer Master Keys `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/update-alias.rst b/aws/dist/awscli/examples/kms/update-alias.rst new file mode 100644 index 00000000..d09557f9 --- /dev/null +++ b/aws/dist/awscli/examples/kms/update-alias.rst @@ -0,0 +1,14 @@ +**To associate an alias with a different CMK** + +The following ``update-alias`` example associates the alias ``alias/test-key`` with a different CMK. + +* The ``--alias-name`` parameter specifies the alias. The alias name value must begin with ``alias/``. +* The ``--target-key-id`` parameter specifies the CMK to associate with the alias. You don't need to specify the current CMK for the alias. :: + + aws kms update-alias \ + --alias-name alias/test-key \ + --target-key-id 1234abcd-12ab-34cd-56ef-1234567890ab + +This command produces no output. To find the alias, use the ``list-aliases`` command. + +For more information, see `Working with Aliases `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/update-custom-key-store.rst b/aws/dist/awscli/examples/kms/update-custom-key-store.rst new file mode 100755 index 00000000..4373f0a1 --- /dev/null +++ b/aws/dist/awscli/examples/kms/update-custom-key-store.rst @@ -0,0 +1,13 @@ +**To edit custom key store settings** + +The following ``update-custom-key-store`` example provides the current password for the ``kmsuser`` in the CloudHSM cluster that is associated with the specified key store. This command doesn't change the ``kmsuser`` password. It just tells AWS KMS the current password. If KMS doesn't have the current ``kmsuser`` password, it cannot connect to the custom key store. + +**NOTE:** Before updating the custom key store, you must disconnect it. Use the ``disconnect-custom-key-store`` command. After the command completes, you can reconnect the custom key store. Use the ``connect-custom-key-store`` command. :: + + aws kms update-custom-key-store \ + --custom-key-store-id cks-1234567890abcdef0 \ + --key-store-password ExamplePassword + +This command does not return any output. To verify that the password change was effective, connect the custom key store. + +For more information, see `Editing Custom Key Store Settings `__ in the *AWS Key Management Service Developer Guide*. diff --git a/aws/dist/awscli/examples/kms/update-key-description.rst b/aws/dist/awscli/examples/kms/update-key-description.rst new file mode 100644 index 00000000..e62e5b29 --- /dev/null +++ b/aws/dist/awscli/examples/kms/update-key-description.rst @@ -0,0 +1,29 @@ +**Example 1: To delete the description of a customer managed CMK** + +The following ``update-key-description`` example deletes the description to a customer managed CMK. + +* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ID value, but you can use either the key ID or the key ARN of the CMK. +* The ``--description`` parameter with an empty string value ('') deletes the existing description. :: + + aws kms update-key-description \ + --key-id 0987dcba-09fe-87dc-65ba-ab0987654321 \ + --description '' + +This command produces no output. To view the description of a CMK, use the the describe-key command. + +For more information, see `UpdateKeyDescription `__ in the *AWS Key Management Service API Reference*. + +**Example 2: To add or change a description to a customer managed CMK** + +The following ``update-key-description`` example adds a description to a customer managed CMK. You can use the same command to change an existing description. + +* The ``--key-id`` parameter identifies the CMK in the command. This example uses a key ARN value, but you can use either the key ID or the key ARN of the CMK. +* The ``--description`` parameter specifies the new description. The value of this parameter replaces the current description of the CMK, if any. :: + + aws kms update-key-description \ + --key-id arn:aws:kms:us-west-2:123456789012:key/1234abcd-12ab-34cd-56ef-1234567890ab \ + --description "IT Department test key" + +This command produces no output. To view the description of a CMK, use the ``describe-key`` command. + +For more information, see `UpdateKeyDescription `__ in the *AWS Key Management Service API Reference*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/lambda/add-layer-version-permission.rst b/aws/dist/awscli/examples/lambda/add-layer-version-permission.rst new file mode 100755 index 00000000..8d89edef --- /dev/null +++ b/aws/dist/awscli/examples/lambda/add-layer-version-permission.rst @@ -0,0 +1,28 @@ +**To add permissions to a layer version** + +The following ``add-layer-version-permission`` example grants permission for the specified account to use version 1 of the layer ``my-layer``. :: + + aws lambda add-layer-version-permission \ + --layer-name my-layer \ + --statement-id xaccount \ + --action lambda:GetLayerVersion \ + --principal 123456789012 \ + --version-number 1 + +Output:: + + { + "RevisionId": "35d87451-f796-4a3f-a618-95a3671b0a0c", + "Statement": + { + "Sid":"xaccount", + "Effect":"Allow", + "Principal":{ + "AWS":"arn:aws:iam::210987654321:root" + }, + "Action":"lambda:GetLayerVersion", + "Resource":"arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1" + } + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/add-permission.rst b/aws/dist/awscli/examples/lambda/add-permission.rst new file mode 100755 index 00000000..1fad2fb2 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/add-permission.rst @@ -0,0 +1,26 @@ +**To add permissions to an existing Lambda function** + +The following ``add-permission`` example grants the Amazon SNS service permission to invoke a function named ``my-function``. :: + + aws lambda add-permission \ + --function-name my-function \ + --action lambda:InvokeFunction \ + --statement-id sns \ + --principal sns.amazonaws.com + +Output:: + + { + "Statement": + { + "Sid":"sns", + "Effect":"Allow", + "Principal":{ + "Service":"sns.amazonaws.com" + }, + "Action":"lambda:InvokeFunction", + "Resource":"arn:aws:lambda:us-east-2:123456789012:function:my-function" + } + } + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/create-alias.rst b/aws/dist/awscli/examples/lambda/create-alias.rst new file mode 100755 index 00000000..fa582894 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/create-alias.rst @@ -0,0 +1,21 @@ +**To create an alias for a Lambda function** + +The following ``create-alias`` example creates an alias named ``LIVE`` that points to version 1 of the ``my-function`` Lambda function. :: + + aws lambda create-alias \ + --function-name my-function \ + --description "alias for live version of function" \ + --function-version 1 \ + --name LIVE + +Output:: + + { + "FunctionVersion": "1", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/create-event-source-mapping.rst b/aws/dist/awscli/examples/lambda/create-event-source-mapping.rst new file mode 100755 index 00000000..5be7e5e7 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/create-event-source-mapping.rst @@ -0,0 +1,22 @@ +**To create a mapping between an event source and an AWS Lambda function** + +The following ``create-event-source-mapping`` example creates a mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda create-event-source-mapping \ + --function-name my-function \ + --batch-size 5 \ + --event-source-arn arn:aws:sqs:us-west-2:123456789012:mySQSqueue + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Creating", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/create-function.rst b/aws/dist/awscli/examples/lambda/create-function.rst new file mode 100755 index 00000000..a5266844 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/create-function.rst @@ -0,0 +1,36 @@ +**To create a Lambda function** + +The following ``create-function`` example creates a Lambda function named ``my-function``. :: + + aws lambda create-function \ + --function-name my-function \ + --runtime nodejs10.x \ + --zip-file fileb://my-function.zip \ + --handler my-function.handler \ + --role arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-tges6bf4 + +Contents of ``my-function.zip``: +This file is a deployment package that contains your function code and any dependencies. + +Output:: + + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "PFn4S+er27qk+UuZSTKEQfNKG/XNn7QJs90mJgq6oH8=", + "FunctionName": "my-function", + "CodeSize": 308, + "RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6", + "MemorySize": 128, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-08-14T22:26:11.234+0000", + "Handler": "my-function.handler", + "Runtime": "nodejs10.x", + "Description": "" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/delete-alias.rst b/aws/dist/awscli/examples/lambda/delete-alias.rst new file mode 100755 index 00000000..5ae36b9d --- /dev/null +++ b/aws/dist/awscli/examples/lambda/delete-alias.rst @@ -0,0 +1,11 @@ +**To delete an alias of a Lambda function** + +The following ``delete-alias`` example deletes the alias named ``LIVE`` from the ``my-function`` Lambda function. :: + + aws lambda delete-alias \ + --function-name my-function \ + --name LIVE + +This command produces no output. + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/delete-event-source-mapping.rst b/aws/dist/awscli/examples/lambda/delete-event-source-mapping.rst new file mode 100755 index 00000000..636edc0b --- /dev/null +++ b/aws/dist/awscli/examples/lambda/delete-event-source-mapping.rst @@ -0,0 +1,20 @@ +**To delete the mapping between an event source and an AWS Lambda function** + +The following ``delete-event-source-mapping`` example deletes the mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda delete-event-source-mapping \ + --uuid a1b2c3d4-5678-90ab-cdef-11111EXAMPLE + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569285870.271, + "BatchSize": 5, + "State": "Deleting", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/delete-function-concurrency.rst b/aws/dist/awscli/examples/lambda/delete-function-concurrency.rst new file mode 100755 index 00000000..d4235115 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/delete-function-concurrency.rst @@ -0,0 +1,10 @@ +**To remove the reserved concurrent execution limit from a function** + +The following ``delete-function-concurrency`` example deletes the reserved concurrent execution limit from the ``my-function`` function. :: + + aws lambda delete-function-concurrency \ + --function-name my-function + +This command produces no output. + +For more information, see `Reserving Concurrency for a Lambda Function `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/delete-function.rst b/aws/dist/awscli/examples/lambda/delete-function.rst new file mode 100755 index 00000000..3c44fbde --- /dev/null +++ b/aws/dist/awscli/examples/lambda/delete-function.rst @@ -0,0 +1,10 @@ +**To delete a Lambda function** + +The following ``delete-function`` example deletes the Lambda function named ``my-function``. :: + + aws lambda delete-function \ + --function-name my-function + +This command produces no output. + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/delete-layer-version.rst b/aws/dist/awscli/examples/lambda/delete-layer-version.rst new file mode 100755 index 00000000..3f96be77 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/delete-layer-version.rst @@ -0,0 +1,11 @@ +**To delete a version of a Lambda layer** + +The following ``delete-layer-version`` example deletes version 2 of the layer named ``my-layer``. :: + + aws lambda delete-layer-version \ + --layer-name my-layer \ + --version-number 2 + +This command produces no output. + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-account-settings.rst b/aws/dist/awscli/examples/lambda/get-account-settings.rst new file mode 100755 index 00000000..8a67f762 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-account-settings.rst @@ -0,0 +1,23 @@ +**To retrieve details about your account in an AWS Region** + +The following ``get-account-settings`` example displays the Lambda limits and usage information for your account. :: + + aws lambda get-account-settings + +Output:: + + { + "AccountLimit": { + "CodeSizeUnzipped": 262144000, + "UnreservedConcurrentExecutions": 1000, + "ConcurrentExecutions": 1000, + "CodeSizeZipped": 52428800, + "TotalCodeSize": 80530636800 + }, + "AccountUsage": { + "FunctionCount": 4, + "TotalCodeSize": 9426 + } + } + +For more information, see `AWS Lambda Limits `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-alias.rst b/aws/dist/awscli/examples/lambda/get-alias.rst new file mode 100755 index 00000000..61ce2699 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-alias.rst @@ -0,0 +1,19 @@ +**To retrieve details about a function alias** + +The following ``get-alias`` example displays details for the alias named ``LIVE`` on the ``my-function`` Lambda function. :: + + aws lambda get-alias \ + --function-name my-function \ + --name LIVE + +Output:: + + { + "FunctionVersion": "3", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-event-source-mapping.rst b/aws/dist/awscli/examples/lambda/get-event-source-mapping.rst new file mode 100755 index 00000000..b1f30b59 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-event-source-mapping.rst @@ -0,0 +1,20 @@ +**To retrieve details about an event source mapping** + +The following ``get-event-source-mapping`` example displays the details for the mapping between an SQS queue and the ``my-function`` Lambda function. :: + + aws lambda get-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Enabled", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-function-configuration.rst b/aws/dist/awscli/examples/lambda/get-function-configuration.rst new file mode 100755 index 00000000..5fe026d1 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-function-configuration.rst @@ -0,0 +1,34 @@ +**To retrieve the version-specific settings of a Lambda function** + +The following ``get-function-configuration`` example displays the settings for version 2 of the ``my-function`` function. :: + + aws lambda get-function-configuration \ + --function-name my-function:2 + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "2", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-function.rst b/aws/dist/awscli/examples/lambda/get-function.rst new file mode 100755 index 00000000..83728b0f --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-function.rst @@ -0,0 +1,43 @@ +**To retrieve information about a function** + +The following ``get-function`` example displays information about the ``my-function`` function. :: + + aws lambda get-function \ + --function-name my-function + +Output:: + + { + "Concurrency": { + "ReservedConcurrentExecutions": 100 + }, + "Code": { + "RepositoryType": "S3", + "Location": "https://awslambda-us-west-2-tasks.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-function..." + }, + "Configuration": { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 128, + "RevisionId": "28f0fb31-5c5c-43d3-8955-03e76c5c1075", + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-09-24T18:20:35.054+0000", + "Runtime": "nodejs10.x", + "Description": "" + } + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-layer-version-by-arn.rst b/aws/dist/awscli/examples/lambda/get-layer-version-by-arn.rst new file mode 100755 index 00000000..a6a766e0 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-layer-version-by-arn.rst @@ -0,0 +1,27 @@ +**To retrieve information about a Lambda layer version** + +The following ``get-layer-version-by-arn`` example displays information about the layer version with the specified Amazon Resource Name (ARN). :: + + aws lambda get-layer-version-by-arn \ + --arn "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2" + +Output:: + + { + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x:2", + "Description": "AWS Lambda SciPy layer for Python 3.7 (scipy-1.1.0, numpy-1.15.4) https://github.com/scipy/scipy/releases/tag/v1.1.0 https://github.com/numpy/numpy/releases/tag/v1.15.4", + "CreatedDate": "2018-11-12T10:09:38.398+0000", + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:AWSLambda-Python37-SciPy1x", + "Content": { + "CodeSize": 41784542, + "CodeSha256": "GGmv8ocUw4cly0T8HL0Vx/f5V4RmSCGNjDIslY4VskM=", + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/..." + }, + "Version": 2, + "CompatibleRuntimes": [ + "python3.7" + ], + "LicenseInfo": "SciPy: https://github.com/scipy/scipy/blob/master/LICENSE.txt, NumPy: https://github.com/numpy/numpy/blob/master/LICENSE.txt" + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-layer-version-policy.rst b/aws/dist/awscli/examples/lambda/get-layer-version-policy.rst new file mode 100755 index 00000000..450bfb4a --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-layer-version-policy.rst @@ -0,0 +1,29 @@ +**To retrieve the permissions policy for a Lambda layer version** + +The following ``get-layer-version-policy`` example displays policy information about version 1 for the layer named ``my-layer``. :: + + aws lambda get-layer-version-policy \ + --layer-name my-layer \ + --version-number 1 + +Output:: + + { + "Policy": { + "Version":"2012-10-17", + "Id":"default", + "Statement": + [ + { + "Sid":"xaccount", + "Effect":"Allow", + "Principal": {"AWS":"arn:aws:iam::123456789012:root"}, + "Action":"lambda:GetLayerVersion", + "Resource":"arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1" + } + ] + }, + "RevisionId": "c68f21d2-cbf0-4026-90f6-1375ee465cd0" + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-layer-version.rst b/aws/dist/awscli/examples/lambda/get-layer-version.rst new file mode 100755 index 00000000..ac2bb5a2 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-layer-version.rst @@ -0,0 +1,29 @@ +**To retrieve information about a Lambda layer version** + +The following ``get-layer-version`` example displays information for version 1 of the layer named ``my-layer``. :: + + aws lambda get-layer-version \ + --layer-name my-layer \ + --version-number 1 + +Output:: + + { + "Content": { + "Location": "https://awslambda-us-east-2-layers.s3.us-east-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/get-policy.rst b/aws/dist/awscli/examples/lambda/get-policy.rst new file mode 100755 index 00000000..13eae59b --- /dev/null +++ b/aws/dist/awscli/examples/lambda/get-policy.rst @@ -0,0 +1,28 @@ +**To retrieve the resource-based IAM policy for a function, version, or alias** + +The following ``get-policy`` example displays policy information about the ``my-function`` Lambda function. :: + + aws lambda get-policy \ + --function-name my-function + +Output:: + + { + "Policy": { + "Version":"2012-10-17", + "Id":"default", + "Statement": + [ + { + "Sid":"iot-events", + "Effect":"Allow", + "Principal": {"Service":"iotevents.amazonaws.com"}, + "Action":"lambda:InvokeFunction", + "Resource":"arn:aws:lambda:us-west-2:123456789012:function:my-function" + } + ] + }, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668" + } + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/invoke.rst b/aws/dist/awscli/examples/lambda/invoke.rst new file mode 100755 index 00000000..521f20ff --- /dev/null +++ b/aws/dist/awscli/examples/lambda/invoke.rst @@ -0,0 +1,35 @@ +**Example 1: To invoke a Lambda function synchronously** + +The following ``invoke`` example invokes the ``my-function`` function synchronously. :: + + aws lambda invoke + --function-name my-function \ + --payload '{ "name": "Bob" }' \ + response.json + +Output:: + + { + "ExecutedVersion": "$LATEST", + "StatusCode": 200 + } + +For more information, see `Synchronous Invocation `__ in the *AWS Lambda Developer Guide*. + +**Example 2: To invoke a Lambda function asynchronously** + +The following ``invoke`` example invokes the ``my-function`` function asynchronously. :: + + aws lambda invoke + --function-name my-function \ + --invocation-type Event \ + --payload '{ "name": "Bob" }' \ + response.json + +Output:: + + { + "StatusCode": 202 + } + +For more information, see `Asynchronous Invocation `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-aliases.rst b/aws/dist/awscli/examples/lambda/list-aliases.rst new file mode 100755 index 00000000..55528973 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-aliases.rst @@ -0,0 +1,29 @@ +**To retrieve the list of aliases for a Lambda function** + +The following ``list-aliases`` example displays a list of the aliases for the ``my-function`` Lambda function. :: + + aws lambda list-aliases \ + --function-name my-function + +Output:: + + { + "Aliases": [ + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:BETA", + "RevisionId": "a410117f-ab16-494e-8035-7e204bb7933b", + "FunctionVersion": "2", + "Name": "BETA", + "Description": "alias for beta version of function" + }, + { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "21d40116-f8b1-40ba-9360-3ea284da1bb5", + "FunctionVersion": "1", + "Name": "LIVE", + "Description": "alias for live version of function" + } + ] + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-event-source-mappings.rst b/aws/dist/awscli/examples/lambda/list-event-source-mappings.rst new file mode 100755 index 00000000..8991f196 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-event-source-mappings.rst @@ -0,0 +1,24 @@ +**To list the event source mappings for a function** + +The following ``list-event-source-mappings`` example displays a list of the event source mappings for the ``my-function`` Lambda function. :: + + aws lambda list-event-source-mappings \ + --function-name my-function + +Output:: + + { + "EventSourceMappings": [ + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 5, + "State": "Enabled", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + ] + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-functions.rst b/aws/dist/awscli/examples/lambda/list-functions.rst new file mode 100755 index 00000000..83576e9a --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-functions.rst @@ -0,0 +1,88 @@ +**To retrieve a list of Lambda functions** + +The following ``list-functions`` example displays a list of all of the functions for the current user. :: + + aws lambda list-functions + +Output:: + + { + "Functions": [ + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", + "FunctionName": "helloworld", + "MemorySize": 128, + "RevisionId": "1718e831-badf-4253-9518-d0644210af7b", + "CodeSize": 294, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:helloworld", + "Handler": "helloworld.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-09-23T18:32:33.857+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "Layers": [ + { + "CodeSize": 41784542, + "Arn": "arn:aws:lambda:us-west-2:420165488524:layer:AWSLambda-Python37-SciPy1x:2" + }, + { + "CodeSize": 4121, + "Arn": "arn:aws:lambda:us-west-2:123456789012:layer:pythonLayer:1" + } + ], + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "ZQukCqxtkqFgyF2cU41Avj99TKQ/hNihPtDtRcc08mI=", + "FunctionName": "my-python-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 128, + "RevisionId": "80b4eabc-acf7-4ea8-919a-e874c213707d", + "CodeSize": 299, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-python-function", + "Handler": "lambda_function.lambda_handler", + "Role": "arn:aws:iam::123456789012:role/service-role/my-python-function-role-z5g7dr6n", + "Timeout": 3, + "LastModified": "2019-10-01T19:40:41.643+0000", + "Runtime": "python3.7", + "Description": "" + } + ] + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-layer-versions.rst b/aws/dist/awscli/examples/lambda/list-layer-versions.rst new file mode 100755 index 00000000..a78bf4b9 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-layer-versions.rst @@ -0,0 +1,27 @@ +**To list the versions of an AWS Lambda layer** + +The following ``list-layers-versions`` example displays information about the versions for the layer named ``my-layer``. :: + + aws lambda list-layer-versions \ + --layer-name my-layer + +Output:: + + { + "Layers": [ + { + + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + + } + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-layers.rst b/aws/dist/awscli/examples/lambda/list-layers.rst new file mode 100755 index 00000000..d633f50e --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-layers.rst @@ -0,0 +1,30 @@ +**To list the layers that are compatible with your function's runtime** + +The following ``list-layers`` example displays information about layers that are compatible with the Python 3.7 runtime. :: + + aws lambda list-layers \ + --compatible-runtime python3.7 + +Output:: + + { + "Layers": [ + { + "LayerName": "my-layer", + "LayerArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer", + "LatestMatchingVersion": { + "LayerVersionArn": "arn:aws:lambda:us-east-2:123456789012:layer:my-layer:2", + "Version": 2, + "Description": "My layer", + "CreatedDate": "2018-11-15T00:37:46.592+0000", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + } + ] + } + + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-tags.rst b/aws/dist/awscli/examples/lambda/list-tags.rst new file mode 100755 index 00000000..2498ab83 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-tags.rst @@ -0,0 +1,17 @@ +**To retrieve the list of tags for a Lambda function** + +The following ``list-tags`` example displays the tags attached to the ``my-function`` Lambda function. :: + + aws lambda list-tags \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function + +Output:: + + { + "Tags": { + "Category": "Web Tools", + "Department": "Sales" + } + } + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/list-versions-by-function.rst b/aws/dist/awscli/examples/lambda/list-versions-by-function.rst new file mode 100755 index 00000000..77959d5f --- /dev/null +++ b/aws/dist/awscli/examples/lambda/list-versions-by-function.rst @@ -0,0 +1,84 @@ +**To retrieve a list of versions of a function** + +The following ``list-versions-by-function`` example displays the list of versions for the ``my-function`` Lambda function. :: + + aws lambda list-versions-by-function \ + --function-name my-function + +Output:: + + { + "Versions": [ + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "$LATEST", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "93017fc9-59cb-41dc-901b-4845ce4bf668", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:$LATEST", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "1", + "CodeSha256": "5tT2qgzYUHoqwR616pZ2dpkn/0J1FrzJmlKidWaaCgk=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "949c8914-012e-4795-998c-e467121951b1", + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:1", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-09-26T20:28:40.438+0000", + "Runtime": "nodejs10.x", + "Description": "new version" + }, + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "Version": "2", + "CodeSha256": "sU0cJ2/hOZevwV/lTxCuQqK3gDZP3i8gUoqUUVRmY6E=", + "FunctionName": "my-function", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "MemorySize": 256, + "RevisionId": "cd669f21-0f3d-4e1c-9566-948837f2e2ea", + "CodeSize": 266, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:2", + "Handler": "index.handler", + "Role": "arn:aws:iam::123456789012:role/service-role/helloWorldPython-role-uy3l9qyq", + "Timeout": 3, + "LastModified": "2019-10-01T16:47:28.490+0000", + "Runtime": "nodejs10.x", + "Description": "newer version" + } + ] + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/publish-layer-version.rst b/aws/dist/awscli/examples/lambda/publish-layer-version.rst new file mode 100755 index 00000000..00e4efbf --- /dev/null +++ b/aws/dist/awscli/examples/lambda/publish-layer-version.rst @@ -0,0 +1,32 @@ +**To create a Lambda layer version** + +The following ``publish-layer-version`` example creates a new Python library layer version. The command retrieves the layer content a file named ``layer.zip`` in the specified S3 bucket. :: + + aws lambda publish-layer-version \ + --layer-name my-layer \ + --description "My Python layer" \ + --license-info "MIT" \ + --content S3Bucket=lambda-layers-us-west-2-123456789012,S3Key=layer.zip \ + --compatible-runtimes python3.6 python3.7 + +Output:: + + { + "Content": { + "Location": "https://awslambda-us-west-2-layers.s3.us-west-2.amazonaws.com/snapshots/123456789012/my-layer-4aaa2fbb-ff77-4b0a-ad92-5b78a716a96a?versionId=27iWyA73cCAYqyH...", + "CodeSha256": "tv9jJO+rPbXUUXuRKi7CwHzKtLDkDRJLB3cC3Z/ouXo=", + "CodeSize": 169 + }, + "LayerArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer", + "LayerVersionArn": "arn:aws:lambda:us-west-2:123456789012:layer:my-layer:1", + "Description": "My Python layer", + "CreatedDate": "2018-11-14T23:03:52.894+0000", + "Version": 1, + "LicenseInfo": "MIT", + "CompatibleRuntimes": [ + "python3.6", + "python3.7" + ] + } + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/publish-version.rst b/aws/dist/awscli/examples/lambda/publish-version.rst new file mode 100755 index 00000000..4977c753 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/publish-version.rst @@ -0,0 +1,29 @@ +**To publish a new version of a function** + +The following ``publish-version`` example publishes a new version of the ``my-function`` Lambda function. :: + + aws lambda publish-version \ + --function-name my-function + +Output:: + + { + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "dBG9m8SGdmlEjw/JYXlhhvCrAv5TxvXsbL/RMr0fT/I=", + "FunctionName": "my-function", + "CodeSize": 294, + "RevisionId": "f31d3d39-cc63-4520-97d4-43cd44c94c20", + "MemorySize": 128, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:3", + "Version": "2", + "Role": "arn:aws:iam::123456789012:role/service-role/MyTestFunction-role-zgur6bf4", + "Timeout": 3, + "LastModified": "2019-09-23T18:32:33.857+0000", + "Handler": "my-function.handler", + "Runtime": "nodejs10.x", + "Description": "" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/put-function-concurrency.rst b/aws/dist/awscli/examples/lambda/put-function-concurrency.rst new file mode 100755 index 00000000..23b800bd --- /dev/null +++ b/aws/dist/awscli/examples/lambda/put-function-concurrency.rst @@ -0,0 +1,15 @@ +**To configure a reserved concurrency limit for a function** + +The following ``put-function-concurrency`` example configures 100 reserved concurrent executions for the ``my-function`` function. :: + + aws lambda put-function-concurrency \ + --function-name my-function \ + --reserved-concurrent-executions 100 + +Output:: + + { + "ReservedConcurrentExecutions": 100 + } + +For more information, see `Reserving Concurrency for a Lambda Function `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/remove-layer-version-permission.rst b/aws/dist/awscli/examples/lambda/remove-layer-version-permission.rst new file mode 100755 index 00000000..756217cd --- /dev/null +++ b/aws/dist/awscli/examples/lambda/remove-layer-version-permission.rst @@ -0,0 +1,12 @@ +**To delete layer-version permissions** + +The following ``remove-layer-version-permission`` example deletes permission for an account to configure a layer version. :: + + aws lambda remove-layer-version-permission \ + --layer-name my-layer \ + --statement-id xaccount \ + --version-number 1 + +This command produces no output. + +For more information, see `AWS Lambda Layers `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/remove-permission.rst b/aws/dist/awscli/examples/lambda/remove-permission.rst new file mode 100755 index 00000000..bb14c7de --- /dev/null +++ b/aws/dist/awscli/examples/lambda/remove-permission.rst @@ -0,0 +1,11 @@ +**To remove permissions from an existing Lambda function** + +The following ``remove-permission`` example removes permission to invoke a function named ``my-function``. :: + + aws lambda remove-permission \ + --function-name my-function \ + --statement-id sns + +This command produces no output. + +For more information, see `Using Resource-based Policies for AWS Lambda `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/tag-resource.rst b/aws/dist/awscli/examples/lambda/tag-resource.rst new file mode 100755 index 00000000..e3a59b4b --- /dev/null +++ b/aws/dist/awscli/examples/lambda/tag-resource.rst @@ -0,0 +1,11 @@ +**To add tags to an existing Lambda function** + +The following ``tag-resource`` example adds a tag with the key name ``DEPARTMENT`` and a value of ``Department A`` to the specified Lambda function. :: + + aws lambda tag-resource \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ + --tags "DEPARTMENT=Department A" + +This command produces no output. + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/untag-resource.rst b/aws/dist/awscli/examples/lambda/untag-resource.rst new file mode 100755 index 00000000..5dce4c7c --- /dev/null +++ b/aws/dist/awscli/examples/lambda/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from an existing Lambda function** + +The following ``untag-resource`` example removes the tag with the key name ``DEPARTMENT`` tag from the ``my-function`` Lambda function. :: + + aws lambda untag-resource \ + --resource arn:aws:lambda:us-west-2:123456789012:function:my-function \ + --tag-keys DEPARTMENT + +This command produces no output. + +For more information, see `Tagging Lambda Functions `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/update-alias.rst b/aws/dist/awscli/examples/lambda/update-alias.rst new file mode 100755 index 00000000..85940862 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/update-alias.rst @@ -0,0 +1,20 @@ +**To update a function alias** + +The following ``update-alias`` example updates the alias named ``LIVE`` to point to version 3 of the ``my-function`` Lambda function. :: + + aws lambda update-alias \ + --function-name my-function \ + --function-version 3 \ + --name LIVE + +Output:: + + { + "FunctionVersion": "3", + "Name": "LIVE", + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE", + "RevisionId": "594f41fb-b85f-4c20-95c7-6ca5f2a92c93", + "Description": "alias for live version of function" + } + +For more information, see `Configuring AWS Lambda Function Aliases `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/update-event-source-mapping.rst b/aws/dist/awscli/examples/lambda/update-event-source-mapping.rst new file mode 100755 index 00000000..aa4288bd --- /dev/null +++ b/aws/dist/awscli/examples/lambda/update-event-source-mapping.rst @@ -0,0 +1,21 @@ +**To update the mapping between an event source and an AWS Lambda function** + +The following ``update-event-source-mapping`` example updates the batch size to 8 in the specified mapping. :: + + aws lambda update-event-source-mapping \ + --uuid "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" \ + --batch-size 8 + +Output:: + + { + "UUID": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE", + "StateTransitionReason": "USER_INITIATED", + "LastModified": 1569284520.333, + "BatchSize": 8, + "State": "Updating", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "EventSourceArn": "arn:aws:sqs:us-west-2:123456789012:mySQSqueue" + } + +For more information, see `AWS Lambda Event Source Mapping `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/update-function-code.rst b/aws/dist/awscli/examples/lambda/update-function-code.rst new file mode 100755 index 00000000..d046bc94 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/update-function-code.rst @@ -0,0 +1,35 @@ +**To update the code of a Lambda function** + +The following ``update-function-code`` example replaces the code of the unpublished ($LATEST) version of the ``my-function`` function with the contents of the specified zip file. :: + + aws lambda update-function-code \ + --function-name my-function \ + --zip-file fileb://my-function.zip + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/lambda/update-function-configuration.rst b/aws/dist/awscli/examples/lambda/update-function-configuration.rst new file mode 100755 index 00000000..2d22f125 --- /dev/null +++ b/aws/dist/awscli/examples/lambda/update-function-configuration.rst @@ -0,0 +1,35 @@ +**To modify the configuration of a function** + +The following ``update-function-configuration`` example modifies the memory size to be 256 MB for the unpublished ($LATEST) version of the ``my-function`` function. :: + + aws lambda update-function-configuration \ + --function-name my-function \ + --memory-size 256 + +Output:: + + { + "FunctionName": "my-function", + "LastModified": "2019-09-26T20:28:40.438+0000", + "RevisionId": "e52502d4-9320-4688-9cd6-152a6ab7490d", + "MemorySize": 256, + "Version": "$LATEST", + "Role": "arn:aws:iam::123456789012:role/service-role/my-function-role-uy3l9qyq", + "Timeout": 3, + "Runtime": "nodejs10.x", + "TracingConfig": { + "Mode": "PassThrough" + }, + "CodeSha256": "5tT2qgzYUHaqwR716pZ2dpkn/0J1FrzJmlKidWoaCgk=", + "Description": "", + "VpcConfig": { + "SubnetIds": [], + "VpcId": "", + "SecurityGroupIds": [] + }, + "CodeSize": 304, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function", + "Handler": "index.handler" + } + +For more information, see `AWS Lambda Function Configuration `__ in the *AWS Lambda Developer Guide*. diff --git a/aws/dist/awscli/examples/license-manager/create-license-configuration.rst b/aws/dist/awscli/examples/license-manager/create-license-configuration.rst new file mode 100755 index 00000000..02ad134d --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/create-license-configuration.rst @@ -0,0 +1,29 @@ +**Example 1: To create a license configuration** + +The following ``create-license-configuration`` example creates a license configuration with a hard limit of 10 cores. :: + + aws license-manager create-license-configuration --name my-license-configuration \ + --license-counting-type Core \ + --license-count 10 \ + --license-count-hard-limit + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE1111" + } + +**Example 2: To create a license configuration** + +The following ``create-license-configuration`` example creates a license configuration with a soft limit of 100 vCPUs. It uses a rule to enable vCPU optimization. :: + + aws license-manager create-license-configuration --name my-license-configuration + --license-counting-type vCPU \ + --license-count 100 \ + --license-rules "#honorVcpuOptimization=true" + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba41EXAMPLE2222" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/license-manager/delete-license-configuration.rst b/aws/dist/awscli/examples/license-manager/delete-license-configuration.rst new file mode 100755 index 00000000..cc0e06b3 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/delete-license-configuration.rst @@ -0,0 +1,8 @@ +**To delete a license configuration** + +The following ``delete-license-configuration`` example deletes the specified license configuration. :: + + aws license-manager delete-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/license-manager/get-license-configuration.rst b/aws/dist/awscli/examples/license-manager/get-license-configuration.rst new file mode 100755 index 00000000..ea29f3ca --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/get-license-configuration.rst @@ -0,0 +1,52 @@ +**To get license configuration information** + +The following ``get-license-configuration`` example displays details for the specified license configuration. :: + + aws license-manager get-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationId": "lic-38b658717b87478aaa7c00883EXAMPLE", + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE", + "Name": "my-license-configuration", + "LicenseCountingType": "vCPU", + "LicenseRules": [], + "LicenseCountHardLimit": false, + "ConsumedLicenses": 0, + "Status": "AVAILABLE", + "OwnerAccountId": "123456789012", + "ConsumedLicenseSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "EC2_HOST", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "ConsumedLicenses": 0 + } + ], + "ManagedResourceSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_HOST", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_AMI", + "AssociationCount": 2 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "AssociationCount": 0 + } + ] + } diff --git a/aws/dist/awscli/examples/license-manager/get-service-settings.rst b/aws/dist/awscli/examples/license-manager/get-service-settings.rst new file mode 100755 index 00000000..3136546c --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/get-service-settings.rst @@ -0,0 +1,24 @@ +**To get the License Manager settings** + +The following ``get-service-settings`` example displays the service settings for License Manager in the current Region. :: + + aws license-manager get-service-settings + +The following shows example output if cross-account resource discovery is disabled. :: + + { + "OrganizationConfiguration": { + "EnableIntegration": false + }, + "EnableCrossAccountsDiscovery": false + } + +The following shows example output if cross-account resource discovery is enabled. :: + + { + "S3BucketArn": "arn:aws:s3:::aws-license-manager-service-c22d6279-35c4-47c4-bb", + "OrganizationConfiguration": { + "EnableIntegration": true + }, + "EnableCrossAccountsDiscovery": true + } diff --git a/aws/dist/awscli/examples/license-manager/list-associations-for-license-configuration.rst b/aws/dist/awscli/examples/license-manager/list-associations-for-license-configuration.rst new file mode 100755 index 00000000..3741be3c --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-associations-for-license-configuration.rst @@ -0,0 +1,25 @@ +**To get associations for a license configuration** + +The following ``list-associations-for-license-configuration`` example displays detailed information for the associations of the specified license configuration. :: + + aws license-manager list-associations-for-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationAssociations": [ + { + "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0", + "ResourceType": "EC2_AMI", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1568825118.617 + }, + { + "ResourceArn": "arn:aws:ec2:us-west-2::image/ami-0abcdef1234567890", + "ResourceType": "EC2_AMI", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1568825118.946 + } + ] + } diff --git a/aws/dist/awscli/examples/license-manager/list-license-configurations.rst b/aws/dist/awscli/examples/license-manager/list-license-configurations.rst new file mode 100755 index 00000000..55d314a8 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-license-configurations.rst @@ -0,0 +1,66 @@ +**Example 1: To list all of your license configurations** + +The following ``list-license-configurations`` example lists all your license configurations. :: + + aws license-manager list-license-configurations + +Output:: + + { + "LicenseConfigurations": [ + { + "LicenseConfigurationId": "lic-6eb6586f508a786a2ba4f56c1EXAMPLE", + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE", + "Name": "my-license-configuration", + "LicenseCountingType": "Core", + "LicenseRules": [], + "LicenseCount": 10, + "LicenseCountHardLimit": true, + "ConsumedLicenses": 0, + "Status": "AVAILABLE", + "OwnerAccountId": "123456789012", + "ConsumedLicenseSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "EC2_HOST", + "ConsumedLicenses": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "ConsumedLicenses": 0 + } + ], + "ManagedResourceSummaryList": [ + { + "ResourceType": "EC2_INSTANCE", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_HOST", + "AssociationCount": 0 + }, + { + "ResourceType": "EC2_AMI", + "AssociationCount": 0 + }, + { + "ResourceType": "SYSTEMS_MANAGER_MANAGED_INSTANCE", + "AssociationCount": 0 + } + ] + }, + { + ... + } + ] + } + +**Example 2: To list a specific license configuration** + +The following ``list-license-configurations`` example lists only the specified license configuration. :: + + aws license-manager list-license-configurations \ + --license-configuration-arns arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE diff --git a/aws/dist/awscli/examples/license-manager/list-license-specifications-for-resource.rst b/aws/dist/awscli/examples/license-manager/list-license-specifications-for-resource.rst new file mode 100755 index 00000000..89d0dc76 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-license-specifications-for-resource.rst @@ -0,0 +1,13 @@ +**To list the license configurations for a resource** + +The following ``list-license-specifications-for-resource`` example lists the license configurations associated with the specified Amazon Machine Image (AMI). :: + + aws license-manager list-license-specifications-for-resource \ + --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 + +Output:: + + { + "LicenseConfigurationArn": "arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE" + } + diff --git a/aws/dist/awscli/examples/license-manager/list-resource-inventory.rst b/aws/dist/awscli/examples/license-manager/list-resource-inventory.rst new file mode 100755 index 00000000..ab790d30 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-resource-inventory.rst @@ -0,0 +1,36 @@ +**To list resources in the resource inventory** + +The following ``list-resource-inventory`` example lists the resources managed using Systems Manager inventory. :: + + aws license-manager list-resource-inventory + +Output:: + + { + "ResourceInventoryList": [ + { + "Platform": "Red Hat Enterprise Linux Server", + "ResourceType": "EC2Instance", + "PlatformVersion": "7.4", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-05d3cdfb05bd36376", + "ResourceId": "i-05d3cdfb05bd36376", + "ResourceOwningAccountId": "1234567890129" + }, + { + "Platform": "Amazon Linux", + "ResourceType": "EC2Instance", + "PlatformVersion": "2", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0b1d036cfd4594808", + "ResourceId": "i-0b1d036cfd4594808", + "ResourceOwningAccountId": "1234567890129" + }, + { + "Platform": "Microsoft Windows Server 2019 Datacenter", + "ResourceType": "EC2Instance", + "PlatformVersion": "10.0.17763", + "ResourceArn": "arn:aws:ec2:us-west-2:1234567890129:instance/i-0cdb3b54a2a8246ad", + "ResourceId": "i-0cdb3b54a2a8246ad", + "ResourceOwningAccountId": "1234567890129" + } + ] + } diff --git a/aws/dist/awscli/examples/license-manager/list-tags-for-resource.rst b/aws/dist/awscli/examples/license-manager/list-tags-for-resource.rst new file mode 100755 index 00000000..0e0b6bb5 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags for a license configuration** + +The following ``list-tags-for-resource`` example lists the tags for the specified license configuration. :: + + aws license-manager list-tags-for-resource \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +Output:: + + { + "Tags": [ + { + "Key": "project", + "Value": "lima" + } + ] + } diff --git a/aws/dist/awscli/examples/license-manager/list-usage-for-license-configuration.rst b/aws/dist/awscli/examples/license-manager/list-usage-for-license-configuration.rst new file mode 100755 index 00000000..ad8fb465 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/list-usage-for-license-configuration.rst @@ -0,0 +1,21 @@ +**To list the licenses in use for a license configuration** + +The following ``list-usage-for-license-configuration`` example lists information about the resources using licenses for the specified license configuration. For example, if the license type is vCPU, any instances consume one license per vCPU. :: + + aws license-manager list-usage-for-license-configuration \ + --license-configuration-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE + +Output:: + + { + "LicenseConfigurationUsageList": [ + { + "ResourceArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-04a636d18e83cfacb", + "ResourceType": "EC2_INSTANCE", + "ResourceStatus": "running", + "ResourceOwnerId": "123456789012", + "AssociationTime": 1570892850.519, + "ConsumedLicenses": 2 + } + ] + } diff --git a/aws/dist/awscli/examples/license-manager/tag-resource.rst b/aws/dist/awscli/examples/license-manager/tag-resource.rst new file mode 100755 index 00000000..a2c10aeb --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/tag-resource.rst @@ -0,0 +1,9 @@ +**To add a tag a license configuration** + +The following ``tag-resource`` example adds the specified tag (key name and value) to the specified license configuration. :: + + aws license-manager tag-resource \ + --tags Key=project,Value=lima \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/license-manager/untag-resource.rst b/aws/dist/awscli/examples/license-manager/untag-resource.rst new file mode 100755 index 00000000..748254e2 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/untag-resource.rst @@ -0,0 +1,9 @@ +**To remove tags from a license configuration** + +The following ``untag-resource`` example removes the specified tag (key name and resource) from the specified license configuration. :: + + aws license-manager untag-resource \ + --tag-keys project \ + --resource-arn arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/license-manager/update-license-configuration.rst b/aws/dist/awscli/examples/license-manager/update-license-configuration.rst new file mode 100755 index 00000000..c3282e61 --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/update-license-configuration.rst @@ -0,0 +1,17 @@ +**To update a license configuration** + +The following ``update-license-configuration`` example updates the specified license configuration to remove the hard limit. :: + + aws license-manager update-license-configuration \ + --no-license-count-hard-limit \ + --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. + +The following ``update-license-configuration`` example updates the specified license configuration to change its status to ``DISABLED``. :: + + aws license-manager update-license-configuration \ + --license-configuration-status DISABLED + --license-configuration-arn arn:aws:license-manager:us-west-2:880185128111:license-configuration:lic-6eb6586f508a786a2ba4f56c1EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/license-manager/update-license-specifications-for-resource.rst b/aws/dist/awscli/examples/license-manager/update-license-specifications-for-resource.rst new file mode 100755 index 00000000..c47cea0c --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/update-license-specifications-for-resource.rst @@ -0,0 +1,10 @@ +**To update the license configurations for a resource** + +The following ``update-license-specifications-for-resource`` example replaces the license configuration associated with the specified Amazon Machine Image (AMI) by removing one license configuration and adding another. :: + + aws license-manager update-license-specifications-for-resource \ + --resource-arn arn:aws:ec2:us-west-2::image/ami-1234567890abcdef0 \ + --remove-license-specifications LicenseConfigurationArn= arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-38b658717b87478aaa7c00883EXAMPLE \ + --add-license-specifications LicenseConfigurationArn=arn:aws:license-manager:us-west-2:123456789012:license-configuration:lic-42b6deb06e5399a980d555927EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/license-manager/update-service-settings.rst b/aws/dist/awscli/examples/license-manager/update-service-settings.rst new file mode 100755 index 00000000..4c8189be --- /dev/null +++ b/aws/dist/awscli/examples/license-manager/update-service-settings.rst @@ -0,0 +1,10 @@ +**To update the License Manager settings** + +The following ``update-service-settings`` example enables cross-account resource discovery for License Manager in the current AWS Region. The Amazon S3 bucket is the Resource Data Sync required for Systems Manager inventory. :: + + aws license-manager update-service-settings \ + --organization-configuration EnableIntegration=true \ + --enable-cross-accounts-discovery \ + --s3-bucket-arn arn:aws:s3:::aws-license-manager-service-abcd1234EXAMPLE + +This command produces no output. diff --git a/aws/dist/awscli/examples/lightsail/create-disk-from-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-disk-from-snapshot.rst new file mode 100644 index 00000000..bdb7c5cc --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-disk-from-snapshot.rst @@ -0,0 +1,32 @@ +**To create a create a disk from a disk snapshot** + +The following ``create-disk-from-snapshot`` example creates a block storage disk named ``Disk-2`` from the specified block storage disk snapshot. The disk is created in the specified AWS Region and Availability Zone, with 32 GB of storage space. :: + + aws lightsail create-disk-from-snapshot \ + --disk-name Disk-2 \ + --disk-snapshot-name Disk-1-1566839161 \ + --availability-zone us-west-2a \ + --size-in-gb 32 + +Output:: + + { + "operations": [ + { + "id": "d42b605d-5ef1-4b4a-8791-7a3e8b66b5e7", + "resourceName": "Disk-2", + "resourceType": "Disk", + "createdAt": 1569624941.471, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateDiskFromSnapshot", + "status": "Started", + "statusChangedAt": 1569624941.791 + } + ] + } + +For more information, see `Creating a block storage disk from a snapshot in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff --git a/aws/dist/awscli/examples/lightsail/create-disk-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-disk-snapshot.rst new file mode 100644 index 00000000..e2fec930 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-disk-snapshot.rst @@ -0,0 +1,91 @@ +**Example 1: To create a snapshot of a disk** + +The following ``create-disk-snapshot`` example creates a snapshot named ``DiskSnapshot-1`` of the specified block storage disk. :: + + aws lightsail create-disk-snapshot \ + --disk-name Disk-1 \ + --disk-snapshot-name DiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "fa74c6d2-03a3-4f42-a7c7-792f124d534b", + "resourceName": "DiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569625129.739, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Disk-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625129.739 + }, + { + "id": "920a25df-185c-4528-87cd-7b85f5488c06", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569625129.739, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "DiskSnapshot-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625129.739 + } + ] + } + +**Example 2: To create a snapshot of an instance's system disk** + +The following ``create-disk-snapshot`` example creates a snapshot of the specified instance's system disk. :: + + aws lightsail create-disk-snapshot \ + --instance-name WordPress-1 \ + --disk-snapshot-name SystemDiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "f508cf1c-6597-42a6-a4c3-4aebd75af0d9", + "resourceName": "SystemDiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569625294.685, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625294.685 + }, + { + "id": "0bb9f712-da3b-4d99-b508-3bf871d989e5", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569625294.685, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "SystemDiskSnapshot-1", + "operationType": "CreateDiskSnapshot", + "status": "Started", + "statusChangedAt": 1569625294.685 + } + ] + } + +For more information, see `Snapshots in Amazon Lightsail `__ and `Creating a snapshot of an instance root volume in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff --git a/aws/dist/awscli/examples/lightsail/create-disk.rst b/aws/dist/awscli/examples/lightsail/create-disk.rst new file mode 100644 index 00000000..777e3d91 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-disk.rst @@ -0,0 +1,29 @@ +**To create a block storage disk** + +The following ``create-disk`` example creates a block storage disk ``Disk-1`` in the specified AWS Region and Availability Zone, with 32 GB of storage space. :: + + aws lightsail create-disk \ + --disk-name Disk-1 \ + --availability-zone us-west-2a \ + --size-in-gb 32 + +Output:: + + { + "operations": [ + { + "id": "1c85e2ec-86ba-4697-b936-77f4d3dc013a", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569449220.36, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateDisk", + "status": "Started", + "statusChangedAt": 1569449220.588 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-domain-entry.rst b/aws/dist/awscli/examples/lightsail/create-domain-entry.rst new file mode 100644 index 00000000..265b3895 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-domain-entry.rst @@ -0,0 +1,31 @@ +**To create a domain entry (DNS record)** + +The following ``create-domain-entry`` example creates a DNS record (A) for the apex of the specified domain that points to an instance's IP address. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail create-domain-entry \ + --region us-east-1 \ + --domain-name example.com \ + --domain-entry name=example.com,type=A,target=192.0.2.0 + +Output:: + + { + "operation": { + "id": "5be4494d-56f4-41fc-8730-693dcd0ef9e2", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569865296.519, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "CreateDomainEntry", + "status": "Succeeded", + "statusChangedAt": 1569865296.519 + } + } + +For more information, see `DNS in Amazon Lightsail `__ and `Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff --git a/aws/dist/awscli/examples/lightsail/create-domain.rst b/aws/dist/awscli/examples/lightsail/create-domain.rst new file mode 100644 index 00000000..55077ffa --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-domain.rst @@ -0,0 +1,30 @@ +**To create a domain (DNS zone)** + +The following ``create-domain`` example creates a DNS zone for the specified domain. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail create-domain \ + --region us-east-1 \ + --domain-name example.com + +Output:: + + { + "operation": { + "id": "64e522c8-9ae1-4c05-9b65-3f237324dc34", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569864291.92, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "CreateDomain", + "status": "Succeeded", + "statusChangedAt": 1569864292.109 + } + } + +For more information, see `DNS in Amazon Lightsail `__ and `Creating a DNS zone to manage your domain's DNS records in Amazon Lightsail `__ in the *Lightsail Developer Guide*. diff --git a/aws/dist/awscli/examples/lightsail/create-instance-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-instance-snapshot.rst new file mode 100644 index 00000000..393d622c --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-instance-snapshot.rst @@ -0,0 +1,44 @@ +**To create a snapshot of an instance** + +The following ``create-instance-snapshot`` example creates a snapshot from the specified instance. :: + + aws lightsail create-instance-snapshot \ + --instance-name WordPress-1 \ + --instance-snapshot-name WordPress-Snapshot-1 + +Output:: + + { + "operations": [ + { + "id": "4c3db559-9dd0-41e7-89c0-2cb88c19786f", + "resourceName": "WordPress-Snapshot-1", + "resourceType": "InstanceSnapshot", + "createdAt": 1569866438.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "CreateInstanceSnapshot", + "status": "Started", + "statusChangedAt": 1569866438.48 + }, + { + "id": "c04fdc45-2981-488c-88b5-d6d2fd759a6a", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569866438.48, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-Snapshot-1", + "operationType": "CreateInstanceSnapshot", + "status": "Started", + "statusChangedAt": 1569866438.48 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-instances-from-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-instances-from-snapshot.rst new file mode 100644 index 00000000..34e4d220 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-instances-from-snapshot.rst @@ -0,0 +1,32 @@ +**To create an instance from a snapshot** + +The following ``create-instances-from-snapshot`` example creates an instance from the specified instance snapshot, in the specified AWS Region and Availability Zone, using the $10 USD bundle. + +**Note:** The bundle that you specify must be equal to or greater in specifications than the bundle of the original source instance used to create the snapshot. :: + + aws lightsail create-instances-from-snapshot \ + --instance-snapshot-name WordPress-1-1569866208 \ + --instance-names WordPress-2 \ + --availability-zone us-west-2a \ + --bundle-id medium_2_0 + +Output:: + + { + "operations": [ + { + "id": "003f8271-b711-464d-b9b8-7f3806cb496e", + "resourceName": "WordPress-2", + "resourceType": "Instance", + "createdAt": 1569865914.908, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstancesFromSnapshot", + "status": "Started", + "statusChangedAt": 1569865914.908 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-instances.rst b/aws/dist/awscli/examples/lightsail/create-instances.rst new file mode 100644 index 00000000..7850fd1a --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-instances.rst @@ -0,0 +1,89 @@ +**Example 1: To create a single instance** + +The following ``create-instances`` example creates an instance in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: + + aws lightsail create-instances \ + --instance-names Instance-1 \ + --availability-zone us-west-2a \ + --blueprint-id wordpress_5_1_1_2 \ + --bundle-id nano_2_0 + +Output:: + + { + "operations": [ + { + "id": "9a77158f-7be3-4d6d-8054-cf5ae2b720cc", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1569447986.061, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569447986.061 + } + ] + } + +**Example 2: To create multiple instances at one time** + +The following ``create-instances`` example creates three instances in the specified AWS Region and Availability Zone, using the WordPress blueprint, and the $3.50 USD bundle. :: + + aws lightsail create-instances \ + --instance-names {"Instance1","Instance2","Instance3"} \ + --availability-zone us-west-2a \ + --blueprint-id wordpress_5_1_1_2 \ + --bundle-id nano_2_0 + +Output:: + + { + "operations": [ + { + "id": "5492f015-9d2e-48c6-8eea-b516840e6903", + "resourceName": "Instance1", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + }, + { + "id": "c58b5f46-2676-44c8-b95c-3ad375898515", + "resourceName": "Instance2", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + }, + { + "id": "a5ad8006-9bee-4499-9eb7-75e42e6f5882", + "resourceName": "Instance3", + "resourceType": "Instance", + "createdAt": 1569448780.054, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateInstance", + "status": "Started", + "statusChangedAt": 1569448780.054 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-key-pair.rst b/aws/dist/awscli/examples/lightsail/create-key-pair.rst new file mode 100644 index 00000000..f2f2ccda --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-key-pair.rst @@ -0,0 +1,39 @@ +**To create a key pair** + +The following ``create-key-pair`` example creates a key pair that you can use to authenticate and connect to an instance. :: + + aws lightsail create-key-pair \ + --key-pair-name MyPersonalKeyPair + +The output provides the private key base64 value that you can use to authenticate to instances that use the created key pair. +**Note:** Copy and paste the private key base64 value to a safe location because you cannot retrieve it later. :: + + { + "keyPair": { + "name": "MyPersonalKeyPair", + "arn": "arn:aws:lightsail:us-west-2:111122223333:KeyPair/55025c71-198f-403b-b42f-a69433e724fb", + "supportCode": "621291663362/MyPersonalKeyPair", + "createdAt": 1569866556.567, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "resourceType": "KeyPair" + }, + "publicKeyBase64": "ssh-rsa ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCV0xUEwx96amPERH7K1bVT1tTFl9OmNk6o7m5YVHk9xlOdMbDRbFvhtXvw4jzJXXz5pBMxWOaGMz5K8QyTVOznoqp13Z8SBooH29hgmBNXiII1XPzEwqbj8mfo1+YVM5s5VuxWwm+BHUgedGUXno6uF7agqxZNO1kPLJBIVTW26SSYBJ0tE+y804UyVsjrbUqCaMXDhmfXpWulMPwuXhwcKh7e8hwoTfkiX0E6Ql+KqF/MiA3w6DCjEqvvdIO7SiEZJFsuGNfYDDN3w60Rel5MUhmn3OJdn4y/A7NWb3IxL4pPfVE4rgFRKU8n1jp9kwRnlVMVBOWuGXk6n+H6M2f1 ", + "privateKeyBase64": "-----BEGIN RSA PRIVATE KEY-----EXAMPLETCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6\nb24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsEXAMPLEd\nBgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN\nMTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD\nVQQHEwdTZWF0dGxlMQ8wDQEXAMPLEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z\nb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt\nYXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMEXAMPLE4GmWIWJ\n21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T\nrDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE\nIbb3OhjZnzcvQAaREXAMPLEMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4\nnUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb\nFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OEXAMPLELvjx79LjSTb\nNYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE=\n-----END RSA PRIVATE KEY-----", + "operation": { + "id": "67f984db-9994-45fe-ad38-59bafcaf82ef", + "resourceName": "MyPersonalKeyPair", + "resourceType": "KeyPair", + "createdAt": 1569866556.567, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "CreateKeyPair", + "status": "Succeeded", + "statusChangedAt": 1569866556.704 + } + } diff --git a/aws/dist/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst b/aws/dist/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst new file mode 100644 index 00000000..9aeca5cc --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-load-balancer-tls-certificate.rst @@ -0,0 +1,47 @@ +**To create a TLS certificate for a load balancer** + +The following ``create-load-balancer-tls-certificate`` example creates a TLS certificate that is attached to the specified load balancer. The certificate created applies to the specified domains. +**Note:** Only two certificates can be created for a load balancer. :: + + aws lightsail create-load-balancer-tls-certificate \ + --certificate-alternative-names abc.example.com \ + --certificate-domain-name example.com \ + --certificate-name MySecondCertificate \ + --load-balancer-name MyFirstLoadBalancer + +Output:: + + { + "operations": [ + { + "id": "be663aed-cb46-41e2-9b23-e2f747245bd4", + "resourceName": "MySecondCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569867364.971, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MyFirstLoadBalancer", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867365.219 + }, + { + "id": "f3dfa930-969e-41cc-ac7d-337178716f6d", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569867364.971, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "MySecondCertificate", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867365.219 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-load-balancer.rst b/aws/dist/awscli/examples/lightsail/create-load-balancer.rst new file mode 100644 index 00000000..50dfa26d --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-load-balancer.rst @@ -0,0 +1,63 @@ +**To create a load balancer** + +The following ``create-load-balancer`` example creates a load balancer with a TLS certificate. The TLS certificate applies to the specified domains, and routes traffic to instances on port 80. :: + + aws lightsail create-load-balancer \ + --certificate-alternative-names www.example.com test.example.com \ + --certificate-domain-name example.com \ + --certificate-name Certificate-1 \ + --instance-port 80 \ + --load-balancer-name LoadBalancer-1 + +Output:: + + { + "operations": [ + { + "id": "cc7b920a-83d8-4762-a74e-9174fe1540be", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1569867169.406, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateLoadBalancer", + "status": "Started", + "statusChangedAt": 1569867169.406 + }, + { + "id": "658ed43b-f729-42f3-a8e4-3f8024d3c98d", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569867170.193, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "LoadBalancer-1", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867170.54 + }, + { + "id": "4757a342-5181-4870-b1e0-227eebc35ab5", + "resourceName": "LoadBalancer-1", + "resourceType": "LoadBalancer", + "createdAt": 1569867170.193, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationDetails": "Certificate-1", + "operationType": "CreateLoadBalancerTlsCertificate", + "status": "Succeeded", + "statusChangedAt": 1569867170.54 + } + ] + } + +For more information, see `Lightsail load balancers `__ in the *Lightsail Developer Guide*. diff --git a/aws/dist/awscli/examples/lightsail/create-relational-database-from-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-relational-database-from-snapshot.rst new file mode 100644 index 00000000..84a0dbfc --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-relational-database-from-snapshot.rst @@ -0,0 +1,32 @@ +**To create a managed database from a snapshot** + +The following ``create-relational-database-from-snapshot`` example creates a managed database from the specified snapshot in the specified AWS Region and Availability Zone, using the $15 USD standard database bundle. +**Note:** The bundle that you specify must be equal to or greater in specifications than the bundle of the original source database used to create the snapshot. :: + + aws lightsail create-relational-database-from-snapshot \ + --relational-database-snapshot-name Database-Oregon-1-1566839359 \ + --relational-database-name Database-1 \ + --availability-zone us-west-2a \ + --relational-database-bundle-id micro_1_0 \ + --no-publicly-accessible + +Output:: + + { + "operations": [ + { + "id": "ad6d9193-9d5c-4ea1-97ae-8fe6de600b4c", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569867916.938, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateRelationalDatabaseFromSnapshot", + "status": "Started", + "statusChangedAt": 1569867918.643 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-relational-database-snapshot.rst b/aws/dist/awscli/examples/lightsail/create-relational-database-snapshot.rst new file mode 100644 index 00000000..bf10bdad --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-relational-database-snapshot.rst @@ -0,0 +1,44 @@ +**To create a snapshot of a managed database** + +The following ``create-relational-database-snapshot`` example creates a snapshot of the specified managed database. :: + + aws lightsail create-relational-database-snapshot \ + --relational-database-name Database1 \ + --relational-database-snapshot-name RelationalDatabaseSnapshot1 + +Output:: + + { + "operations": [ + { + "id": "853667fb-ea91-4c02-8d20-8fc5fd43b9eb", + "resourceName": "RelationalDatabaseSnapshot1", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569868074.645, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569868074.645 + }, + { + "id": "fbafa521-3cac-4be8-9773-1c143780b239", + "resourceName": "Database1", + "resourceType": "RelationalDatabase", + "createdAt": 1569868074.645, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "RelationalDatabaseSnapshot1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569868074.645 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/create-relational-database.rst b/aws/dist/awscli/examples/lightsail/create-relational-database.rst new file mode 100644 index 00000000..69c7db9b --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/create-relational-database.rst @@ -0,0 +1,33 @@ +**To create a managed database** + +The following ``create-relational-database`` example creates a managed database in the specified AWS Region and Availability Zone, using the MySQL 5.6 database engine (mysql_5_6), and the $15 USD standard database bundle (micro_1_0). The managed database is pre-populated a master user name, and is not publicly accessible. :: + + aws lightsail create-relational-database \ + --relational-database-name Database-1 \ + --availability-zone us-west-2a \ + --relational-database-blueprint-id mysql_5_6 \ + --relational-database-bundle-id micro_1_0 \ + --master-database-name dbmaster \ + --master-username user \ + --no-publicly-accessible + +Output:: + + { + "operations": [ + { + "id": "b52bedee-73ed-4798-8d2a-9c12df89adcd", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569450017.244, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "CreateRelationalDatabase", + "status": "Started", + "statusChangedAt": 1569450018.637 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-disk-snapshot.rst b/aws/dist/awscli/examples/lightsail/delete-disk-snapshot.rst new file mode 100644 index 00000000..4334d6ae --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-disk-snapshot.rst @@ -0,0 +1,27 @@ +**To delete a snapshot of a block storage disk** + +The following ``delete-disk-snapshot`` example deletes the specified snapshot of a block storage disk :: + + aws lightsail delete-disk-snapshot \ + --disk-snapshot-name DiskSnapshot-1 + +Output:: + + { + "operations": [ + { + "id": "d1e5766d-b81e-4595-ad5d-02afbccfcd5d", + "resourceName": "DiskSnapshot-1", + "resourceType": "DiskSnapshot", + "createdAt": 1569873552.79, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteDiskSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569873552.79 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-disk.rst b/aws/dist/awscli/examples/lightsail/delete-disk.rst new file mode 100644 index 00000000..2d971506 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-disk.rst @@ -0,0 +1,27 @@ +**To delete a block storage disk** + +The following ``delete-disk`` example deletes the specified block storage disk. :: + + aws lightsail delete-disk \ + --disk-name Disk-1 + +Output:: + + { + "operations": [ + { + "id": "6378c70f-4d75-4f7a-ab66-730fca0bb2fc", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569872887.864, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteDisk", + "status": "Succeeded", + "statusChangedAt": 1569872887.864 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-domain-entry.rst b/aws/dist/awscli/examples/lightsail/delete-domain-entry.rst new file mode 100644 index 00000000..c2da856b --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-domain-entry.rst @@ -0,0 +1,29 @@ +**To delete a domain entry (DNS record)** + +The following ``delete-domain-entry`` example deletes the specified domain entry from an existing domain. + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail delete-domain-entry \ + --region us-east-1 \ + --domain-name example.com \ + --domain-entry name=123.example.com,target=192.0.2.0,type=A + +Output:: + + { + "operation": { + "id": "06eacd01-d785-420e-8daa-823150c7dca1", + "resourceName": "example.com ", + "resourceType": "Domain", + "createdAt": 1569874157.005, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "DeleteDomainEntry", + "status": "Succeeded", + "statusChangedAt": 1569874157.005 + } + } diff --git a/aws/dist/awscli/examples/lightsail/delete-domain.rst b/aws/dist/awscli/examples/lightsail/delete-domain.rst new file mode 100644 index 00000000..061e273b --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-domain.rst @@ -0,0 +1,28 @@ +**To delete a domain (DNS zone)** + +The following ``delete-domain`` example deletes the specified domain and all of the entries in the domain (DNS records). + +**Note:** Lightsail's domain-related API operations are available in only the ``us-east-1`` Region. If your CLI profile is configured to use a different Region, you must include the ``--region us-east-1`` parameter or the command fails. :: + + aws lightsail delete-domain \ + --region us-east-1 \ + --domain-name example.com + +Output:: + + { + "operation": { + "id": "fcef5265-5af1-4a46-a3d7-90b5e18b9b32", + "resourceName": "example.com", + "resourceType": "Domain", + "createdAt": 1569873788.13, + "location": { + "availabilityZone": "all", + "regionName": "global" + }, + "isTerminal": true, + "operationType": "DeleteDomain", + "status": "Succeeded", + "statusChangedAt": 1569873788.13 + } + } diff --git a/aws/dist/awscli/examples/lightsail/delete-instance-snapshot.rst b/aws/dist/awscli/examples/lightsail/delete-instance-snapshot.rst new file mode 100644 index 00000000..ed409024 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-instance-snapshot.rst @@ -0,0 +1,27 @@ +**title** + +The following ``delete-instance-snapshot`` example deletes the specified snapshot of an instance. :: + + aws lightsail delete-instance-snapshot \ + --instance-snapshot-name WordPress-1-Snapshot-1 + +Output:: + + { + "operations": [ + { + "id": "14dad182-976a-46c6-bfd4-9480482bf0ea", + "resourceName": "WordPress-1-Snapshot-1", + "resourceType": "InstanceSnapshot", + "createdAt": 1569874524.562, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteInstanceSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569874524.562 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-instance.rst b/aws/dist/awscli/examples/lightsail/delete-instance.rst new file mode 100644 index 00000000..dead7d29 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-instance.rst @@ -0,0 +1,57 @@ +**To delete an instance** + +The following ``delete-instance`` example deletes the specified instance. :: + + aws lightsail delete-instance \ + --instance-name WordPress-1 + +Output:: + + { + "operations": [ + { + "id": "d77345a3-8f80-4d2e-b47d-aaa622718df2", + "resourceName": "Disk-1", + "resourceType": "Disk", + "createdAt": 1569874357.469, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "WordPress-1", + "operationType": "DetachDisk", + "status": "Started", + "statusChangedAt": 1569874357.469 + }, + { + "id": "708fa606-2bfd-4e48-a2c1-0b856585b5b1", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569874357.465, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Disk-1", + "operationType": "DetachDisk", + "status": "Started", + "statusChangedAt": 1569874357.465 + }, + { + "id": "3187e823-8acb-405d-b098-fad5ceb17bec", + "resourceName": "WordPress-1", + "resourceType": "Instance", + "createdAt": 1569874357.829, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteInstance", + "status": "Succeeded", + "statusChangedAt": 1569874357.829 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-key-pair.rst b/aws/dist/awscli/examples/lightsail/delete-key-pair.rst new file mode 100644 index 00000000..411466fd --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-key-pair.rst @@ -0,0 +1,25 @@ +**To delete a key pair** + +The following ``delete-key-pair`` example deletes the specified key pair. :: + + aws lightsail delete-key-pair \ + --key-pair-name MyPersonalKeyPair + +Output:: + + { + "operation": { + "id": "81621463-df38-4810-b866-6e801a15abbf", + "resourceName": "MyPersonalKeyPair", + "resourceType": "KeyPair", + "createdAt": 1569874626.466, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteKeyPair", + "status": "Succeeded", + "statusChangedAt": 1569874626.685 + } + } diff --git a/aws/dist/awscli/examples/lightsail/delete-known-host-keys.rst b/aws/dist/awscli/examples/lightsail/delete-known-host-keys.rst new file mode 100644 index 00000000..58a28ad2 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-known-host-keys.rst @@ -0,0 +1,29 @@ +**To delete known host keys from an instance** + +The following ``delete-known-host-keys`` example deletes the known host key from the specified instance. :: + + aws lightsail delete-known-host-keys \ + --instance-name Instance-1 + +Output:: + + { + "operations": [ + { + "id": "c61afe9c-45a4-41e6-a97e-d212364da3f5", + "resourceName": "Instance-1", + "resourceType": "Instance", + "createdAt": 1569874760.201, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteKnownHostKeys", + "status": "Succeeded", + "statusChangedAt": 1569874760.201 + } + ] + } + +For more information, see `Troubleshooting connection issues with the Amazon Lightsail browser-based SSH or RDP client `__ in the *Lightsail Dev Guide*. diff --git a/aws/dist/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst b/aws/dist/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst new file mode 100644 index 00000000..a3ca3279 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-load-balancer-tls-certificate.rst @@ -0,0 +1,42 @@ +**To delete a TLS certificate for a load balancer** + +The following ``delete-load-balancer-tls-certificate`` example deletes the specifie TLS certificate from the specified load balancer. :: + + aws lightsail delete-load-balancer-tls-certificate \ + --load-balancer-name MyFirstLoadBalancer \ + --certificate-name MyFirstCertificate + +Output:: + + { + "operations": [ + { + "id": "50bec274-e45e-4caa-8a69-b763ef636583", + "resourceName": "MyFirstCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569874989.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569874989.48 + }, + { + "id": "78c58cdc-a59a-4b27-8213-500638634a8f", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569874989.48, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569874989.48 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-load-balancer.rst b/aws/dist/awscli/examples/lightsail/delete-load-balancer.rst new file mode 100644 index 00000000..8ad6e200 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-load-balancer.rst @@ -0,0 +1,57 @@ +**To delete a load balancer** + +The following ``delete-load-balancer`` example deletes the specified load balancer and any associated TLS certificates. :: + + aws lightsail delete-load-balancer \ + --load-balancer-name MyFirstLoadBalancer + +Output:: + + { + "operations": [ + { + "id": "a8c968c7-72a3-4680-a714-af8f03eea535", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569875092.125, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteLoadBalancer", + "status": "Succeeded", + "statusChangedAt": 1569875092.125 + }, + { + "id": "f91a29fc-8ce3-4e69-a227-ea70ca890bf5", + "resourceName": "MySecondCertificate", + "resourceType": "LoadBalancerTlsCertificate", + "createdAt": 1569875091.938, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569875091.938 + }, + { + "id": "cf64c060-154b-4eb4-ba57-84e2e41563d6", + "resourceName": "MyFirstLoadBalancer", + "resourceType": "LoadBalancer", + "createdAt": 1569875091.94, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteLoadBalancerTlsCertificate", + "status": "Started", + "statusChangedAt": 1569875091.94 + } + ] + } + +For more information, see `title `__ in the *guide*. diff --git a/aws/dist/awscli/examples/lightsail/delete-relational-database-snapshot.rst b/aws/dist/awscli/examples/lightsail/delete-relational-database-snapshot.rst new file mode 100644 index 00000000..b003c544 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-relational-database-snapshot.rst @@ -0,0 +1,27 @@ +**To delete a snapshot of a managed database** + +The following ``delete-relational-database-snapshot`` example deletes the specified snapshot of a managed database. :: + + aws lightsail delete-relational-database-snapshot \ + --relational-database-snapshot-name Database-Oregon-1-1566839359 + +Output:: + + { + "operations": [ + { + "id": "b99acae8-735b-4823-922f-30af580e3729", + "resourceName": "Database-Oregon-1-1566839359", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569875293.58, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": true, + "operationType": "DeleteRelationalDatabaseSnapshot", + "status": "Succeeded", + "statusChangedAt": 1569875293.58 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/delete-relational-database.rst b/aws/dist/awscli/examples/lightsail/delete-relational-database.rst new file mode 100644 index 00000000..ef4ba74b --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/delete-relational-database.rst @@ -0,0 +1,57 @@ +**To delete a managed database** + +The following ``delete-relational-database`` example deletes the specified managed database. :: + + aws lightsail delete-relational-database \ + --relational-database-name Database-1 + +Output:: + + { + "operations": [ + { + "id": "3b0c41c1-053d-46f0-92a3-14f76141dc86", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569875210.999, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationType": "DeleteRelationalDatabase", + "status": "Started", + "statusChangedAt": 1569875210.999 + }, + { + "id": "01ddeae8-a87a-4a4b-a1f3-092c71bf9180", + "resourceName": "Database-1", + "resourceType": "RelationalDatabase", + "createdAt": 1569875211.029, + "location": { + "availabilityZone": "us-west-2a", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database-1-FinalSnapshot-1569875210793", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569875211.029 + }, + { + "id": "74d73681-30e8-4532-974e-1f23cd3f9f73", + "resourceName": "Database-1-FinalSnapshot-1569875210793", + "resourceType": "RelationalDatabaseSnapshot", + "createdAt": 1569875211.029, + "location": { + "availabilityZone": "all", + "regionName": "us-west-2" + }, + "isTerminal": false, + "operationDetails": "Database-1", + "operationType": "CreateRelationalDatabaseSnapshot", + "status": "Started", + "statusChangedAt": 1569875211.029 + } + ] + } diff --git a/aws/dist/awscli/examples/lightsail/get-instance-metric-data.rst b/aws/dist/awscli/examples/lightsail/get-instance-metric-data.rst new file mode 100755 index 00000000..acc506d7 --- /dev/null +++ b/aws/dist/awscli/examples/lightsail/get-instance-metric-data.rst @@ -0,0 +1,32 @@ +**To get instance NetworkOut metric data for a month period** + +The following ``get-instance-metric-data`` example outputs the total ``NetworkOut`` metric data in bytes for an approximate month-long period. + +We recommend that you use an epoch time converter to identify the start and end times. If the time between the ``--start-time`` and ``--end-time`` is greater than 2628000 seconds (approximately one month), then multiple results are returned for each 2628000 interval, as shown in the following sample response. :: + + aws lightsail get-instance-metric-data \ + --instance-name InstanceName \ + --metric-name NetworkOut \ + --period 2628000 \ + --start-time 1546304400 \ + --end-time 1577840400 + --unit Bytes + --statistics Sum + +Output:: + + { + "metricData": [ + { + "timestamp": 1556812800.0, + "sum": 22359134.0, + "unit": "Bytes" + }, + { + "timestamp": 1554184800.0, + "sum": 5968238.0, + "unit": "Bytes" + } + ], + "metricName": "NetworkOut" + } diff --git a/aws/dist/awscli/examples/logs/create-log-group.rst b/aws/dist/awscli/examples/logs/create-log-group.rst new file mode 100644 index 00000000..f81bcdc5 --- /dev/null +++ b/aws/dist/awscli/examples/logs/create-log-group.rst @@ -0,0 +1,3 @@ +The following command creates a log group named ``my-logs``:: + + aws logs create-log-group --log-group-name my-logs diff --git a/aws/dist/awscli/examples/logs/create-log-stream.rst b/aws/dist/awscli/examples/logs/create-log-stream.rst new file mode 100644 index 00000000..f079c20b --- /dev/null +++ b/aws/dist/awscli/examples/logs/create-log-stream.rst @@ -0,0 +1,3 @@ +The following command creates a log stream named ``20150601`` in the log group ``my-logs``:: + + aws logs create-log-stream --log-group-name my-logs --log-stream-name 20150601 diff --git a/aws/dist/awscli/examples/logs/delete-log-group.rst b/aws/dist/awscli/examples/logs/delete-log-group.rst new file mode 100644 index 00000000..27105d0a --- /dev/null +++ b/aws/dist/awscli/examples/logs/delete-log-group.rst @@ -0,0 +1,3 @@ +The following command deletes a log group named ``my-logs``:: + + aws logs delete-log-group --log-group-name my-logs diff --git a/aws/dist/awscli/examples/logs/delete-log-stream.rst b/aws/dist/awscli/examples/logs/delete-log-stream.rst new file mode 100644 index 00000000..94697f42 --- /dev/null +++ b/aws/dist/awscli/examples/logs/delete-log-stream.rst @@ -0,0 +1,3 @@ +The following command deletes a log stream named ``20150531`` from a log group named ``my-logs``:: + + aws logs delete-log-stream --log-group-name my-logs --log-stream-name 20150531 diff --git a/aws/dist/awscli/examples/logs/delete-retention-policy.rst b/aws/dist/awscli/examples/logs/delete-retention-policy.rst new file mode 100644 index 00000000..19f98f3b --- /dev/null +++ b/aws/dist/awscli/examples/logs/delete-retention-policy.rst @@ -0,0 +1,3 @@ +The following command removes the retention policy that has previously been applied to a log group named ``my-logs``:: + + aws logs delete-retention-policy --log-group-name my-logs diff --git a/aws/dist/awscli/examples/logs/describe-log-groups.rst b/aws/dist/awscli/examples/logs/describe-log-groups.rst new file mode 100644 index 00000000..9f20b52c --- /dev/null +++ b/aws/dist/awscli/examples/logs/describe-log-groups.rst @@ -0,0 +1,18 @@ +The following command describes a log group named ``my-logs``:: + + aws logs describe-log-groups --log-group-name-prefix my-logs + +Output:: + + { + "logGroups": [ + { + "storedBytes": 0, + "metricFilterCount": 0, + "creationTime": 1433189500783, + "logGroupName": "my-logs", + "retentionInDays": 5, + "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:*" + } + ] + } diff --git a/aws/dist/awscli/examples/logs/describe-log-streams.rst b/aws/dist/awscli/examples/logs/describe-log-streams.rst new file mode 100644 index 00000000..c56df2e8 --- /dev/null +++ b/aws/dist/awscli/examples/logs/describe-log-streams.rst @@ -0,0 +1,22 @@ +The following command shows all log streams starting with the prefix ``2015`` in the log group ``my-logs``:: + + aws logs describe-log-streams --log-group-name my-logs --log-stream-name-prefix 2015 + +Output:: + + { + "logStreams": [ + { + "creationTime": 1433189871774, + "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150531", + "logStreamName": "20150531", + "storedBytes": 0 + }, + { + "creationTime": 1433189873898, + "arn": "arn:aws:logs:us-west-2:0123456789012:log-group:my-logs:log-stream:20150601", + "logStreamName": "20150601", + "storedBytes": 0 + } + ] + } diff --git a/aws/dist/awscli/examples/logs/get-log-events.rst b/aws/dist/awscli/examples/logs/get-log-events.rst new file mode 100644 index 00000000..dd009a9d --- /dev/null +++ b/aws/dist/awscli/examples/logs/get-log-events.rst @@ -0,0 +1,27 @@ +The following command retrieves log events from a log stream named ``20150601`` in the log group ``my-logs``:: + + aws logs get-log-events --log-group-name my-logs --log-stream-name 20150601 + +Output:: + + { + "nextForwardToken": "f/31961209122447488583055879464742346735121166569214640130", + "events": [ + { + "ingestionTime": 1433190494190, + "timestamp": 1433190184356, + "message": "Example Event 1" + }, + { + "ingestionTime": 1433190516679, + "timestamp": 1433190184356, + "message": "Example Event 1" + }, + { + "ingestionTime": 1433190494190, + "timestamp": 1433190184358, + "message": "Example Event 2" + } + ], + "nextBackwardToken": "b/31961209122358285602261756944988674324553373268216709120" + } diff --git a/aws/dist/awscli/examples/logs/put-log-events.rst b/aws/dist/awscli/examples/logs/put-log-events.rst new file mode 100644 index 00000000..457c3dbd --- /dev/null +++ b/aws/dist/awscli/examples/logs/put-log-events.rst @@ -0,0 +1,36 @@ +The following command puts log events to a log stream named ``20150601`` in the log group ``my-logs``:: + + aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events + +Output:: + + { + "nextSequenceToken": "49542672486831074009579604567656788214806863282469607346" + } + +The above example reads a JSON array of events from a file named ``events`` in the current directory:: + + [ + { + "timestamp": 1433190184356, + "message": "Example Event 1" + }, + { + "timestamp": 1433190184358, + "message": "Example Event 2" + }, + { + "timestamp": 1433190184360, + "message": "Example Event 3" + } + ] + +Each subsequent call requires the next sequence token provided by the previous call to be specified with the sequence token option:: + + aws logs put-log-events --log-group-name my-logs --log-stream-name 20150601 --log-events file://events2 --sequence-token "49542672486831074009579604567656788214806863282469607346" + +Output:: + + { + "nextSequenceToken": "49542672486831074009579604567900991230369019956308219826" + } diff --git a/aws/dist/awscli/examples/logs/put-retention-policy.rst b/aws/dist/awscli/examples/logs/put-retention-policy.rst new file mode 100644 index 00000000..6bb99048 --- /dev/null +++ b/aws/dist/awscli/examples/logs/put-retention-policy.rst @@ -0,0 +1,3 @@ +The following command adds a 5 day retention policy to a log group named ``my-logs``:: + + aws logs put-retention-policy --log-group-name my-logs --retention-in-days 5 diff --git a/aws/dist/awscli/examples/mediaconnect/add-flow-outputs.rst b/aws/dist/awscli/examples/mediaconnect/add-flow-outputs.rst new file mode 100644 index 00000000..259d5751 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/add-flow-outputs.rst @@ -0,0 +1,39 @@ +**To add outputs to a flow** + +The following ``add-flow-outputs`` example adds outputs to the specified flow. :: + + aws mediaconnect add-flow-outputs \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --outputs Description='NYC stream',Destination=192.0.2.12,Name=NYC,Port=3333,Protocol=rtp-fec,SmoothingLatency=100 Description='LA stream',Destination=203.0.113.9,Name=LA,Port=4444,Protocol=rtp-fec,SmoothingLatency=100 + +Output:: + + { + "Outputs": [ + { + "Port": 3333, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Name": "NYC", + "Description": "NYC stream", + "Destination": "192.0.2.12", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + } + }, + { + "Port": 4444, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-987655dEF67hiJ89-c34de5fG678h:LA", + "Name": "LA", + "Description": "LA stream", + "Destination": "203.0.113.9", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + } + } + ], + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" + } + +For more information, see `Adding Outputs to a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/create-flow.rst b/aws/dist/awscli/examples/mediaconnect/create-flow.rst new file mode 100644 index 00000000..cbed8fde --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/create-flow.rst @@ -0,0 +1,37 @@ +**To create a flow** + +The following ``create-flow`` example creates a flow with the specified configuration. :: + + aws mediaconnect create-flow \ + --availability-zone us-west-2c \ + --name ExampleFlow \ + --source Description='Example source, backup',IngestPort=1055,Name=BackupSource,Protocol=rtp,WhitelistCidr=10.24.34.0/23 + +Output:: + + { + "Flow": { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:ExampleFlow", + "AvailabilityZone": "us-west-2c", + "EgressIp": "54.245.71.21", + "Source": { + "IngestPort": 1055, + "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:2-3aBC45dEF67hiJ89-c34de5fG678h:BackupSource", + "Transport": { + "Protocol": "rtp", + "MaxBitrate": 80000000 + }, + "Description": "Example source, backup", + "IngestIp": "54.245.71.21", + "WhitelistCidr": "10.24.34.0/23", + "Name": "mySource" + }, + "Entitlements": [], + "Name": "ExampleFlow", + "Outputs": [], + "Status": "STANDBY", + "Description": "Example source, backup" + } + } + +For more information, see `Creating a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/delete-flow.rst b/aws/dist/awscli/examples/mediaconnect/delete-flow.rst new file mode 100644 index 00000000..69de8a49 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/delete-flow.rst @@ -0,0 +1,15 @@ +**To delete a flow** + +The following ``delete-flow`` example deletes the specified flow. :: + + aws mediaconnect delete-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Status": "DELETING" + } + +For more information, see `Deleting a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/describe-flow.rst b/aws/dist/awscli/examples/mediaconnect/describe-flow.rst new file mode 100644 index 00000000..04cfd961 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/describe-flow.rst @@ -0,0 +1,65 @@ +**To view the details of a flow** + +The following ``describe-flow`` example displays the specified flow's details, such as ARN, Availability Zone, status, source, entitlements, and outputs. :: + + aws mediaconnect describe-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "Flow": { + "EgressIp": "54.201.4.39", + "AvailabilityZone": "us-west-2c", + "Status": "ACTIVE", + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Entitlements": [ + { + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:123456789012:entitlement:1-AaBb11CcDd22EeFf-34DE5fG12AbC:MyEntitlement", + "Description": "Assign to this account", + "Name": "MyEntitlement", + "Subscribers": [ + "444455556666" + ] + } + ], + "Description": "NYC awards show", + "Name": "AwardsShow", + "Outputs": [ + { + "Port": 2355, + "Name": "NYC", + "Transport": { + "SmoothingLatency": 0, + "Protocol": "rtp-fec" + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Destination": "192.0.2.0" + }, + { + "Port": 3025, + "Name": "LA", + "Transport": { + "SmoothingLatency": 0, + "Protocol": "rtp-fec" + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:123456789012:output:2-987655dEF67hiJ89-c34de5fG678h:LA", + "Destination": "192.0.2.0" + } + ], + "Source": { + "IngestIp": "54.201.4.39", + "SourceArn": "arn:aws:mediaconnect:us-east-1:123456789012:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource", + "Transport": { + "MaxBitrate": 80000000, + "Protocol": "rtp" + }, + "IngestPort": 1069, + "Description": "Saturday night show", + "Name": "ShowSource", + "WhitelistCidr": "10.24.34.0/23" + } + } + } + +For more information, see `Viewing the Details of a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/grant-flow-entitlements.rst b/aws/dist/awscli/examples/mediaconnect/grant-flow-entitlements.rst new file mode 100644 index 00000000..831268e1 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/grant-flow-entitlements.rst @@ -0,0 +1,39 @@ +**To grant an entitlement on a flow** + +The following ``grant-flow-entitlements`` example grants an entitlement to the specified existing flow to share your content with another AWS account. :: + + aws mediaconnect grant-flow-entitlements \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlements Description='For AnyCompany',Encryption={"Algorithm=aes128,KeyType=static-key,RoleArn=arn:aws:iam::111122223333:role/MediaConnect-ASM,SecretArn=arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1"},Name=AnyCompany_Entitlement,Subscribers=444455556666 Description='For Example Corp',Name=ExampleCorp,Subscribers=777788889999 + +Output:: + + { + "Entitlements": [ + { + "Name": "AnyCompany_Entitlement", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", + "Subscribers": [ + "444455556666" + ], + "Description": "For AnyCompany", + "Encryption": { + "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1", + "Algorithm": "aes128", + "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", + "KeyType": "static-key" + } + }, + { + "Name": "ExampleCorp", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-3333cccc4444dddd-1111aaaa2222:ExampleCorp", + "Subscribers": [ + "777788889999" + ], + "Description": "For Example Corp" + } + ], + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame" + } + +For more information, see `Granting an Entitlement on a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/list-entitlements.rst b/aws/dist/awscli/examples/mediaconnect/list-entitlements.rst new file mode 100644 index 00000000..68466c6b --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/list-entitlements.rst @@ -0,0 +1,18 @@ +**To view a list of entitlements** + +The following ``list-entitlements`` example displays a list of all entitlements that have been granted to the account. :: + + aws mediaconnect list-entitlements + +Output:: + + { + "Entitlements": [ + { + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:MyEntitlement", + "EntitlementName": "MyEntitlement" + } + ] + } + +For more information, see `ListEntitlements `__ in the *AWS Elemental MediaConnect API Reference*. diff --git a/aws/dist/awscli/examples/mediaconnect/list-flows.rst b/aws/dist/awscli/examples/mediaconnect/list-flows.rst new file mode 100644 index 00000000..5d636a4a --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/list-flows.rst @@ -0,0 +1,30 @@ +**To view a list of flows** + +The following ``list-flows`` example displays a list of flows. :: + + aws mediaconnect list-flows + +Output:: + + { + "Flows": [ + { + "Status": "STANDBY", + "SourceType": "OWNED", + "AvailabilityZone": "us-west-2a", + "Description": "NYC awards show", + "Name": "AwardsShow", + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" + }, + { + "Status": "STANDBY", + "SourceType": "OWNED", + "AvailabilityZone": "us-west-2c", + "Description": "LA basketball game", + "Name": "BasketballGame", + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame" + } + ] + } + +For more information, see `Viewing a List of Flows `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/list-tags-for-resource.rst b/aws/dist/awscli/examples/mediaconnect/list-tags-for-resource.rst new file mode 100644 index 00000000..170a1c0e --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list tags for a MediaConnect resource** + +The following ``list-tags-for-resource`` example displays the tag keys and values associated with the specified MediaConnect resource. :: + + aws mediaconnect list-tags-for-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame + +Output:: + + { + "Tags": { + "region": "west", + "stage": "prod" + } + } + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff --git a/aws/dist/awscli/examples/mediaconnect/remove-flow-output.rst b/aws/dist/awscli/examples/mediaconnect/remove-flow-output.rst new file mode 100644 index 00000000..4dea859d --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/remove-flow-output.rst @@ -0,0 +1,16 @@ +**To remove an output from a flow** + +The following ``remove-flow-output`` example removes an output from the specified flow. :: + + aws mediaconnect remove-flow-output \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC" + } + +For more information, see `Removing Outputs from a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/revoke-flow-entitlement.rst b/aws/dist/awscli/examples/mediaconnect/revoke-flow-entitlement.rst new file mode 100644 index 00000000..18dfeb56 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/revoke-flow-entitlement.rst @@ -0,0 +1,16 @@ +**To revoke an entitlement** + +The following ``revoke-flow-entitlement`` example revokes an entitlement on the specified flow. :: + + aws mediaconnect revoke-flow-entitlement \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement" + } + +For more information, see `Revoking an Entitlement `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/start-flow.rst b/aws/dist/awscli/examples/mediaconnect/start-flow.rst new file mode 100644 index 00000000..7e62f154 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/start-flow.rst @@ -0,0 +1,16 @@ +**To start a flow** + +The following ``start-flow`` example starts the specified flow. :: + + aws mediaconnect start-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +This command produces no output. +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Status": "STARTING" + } + +For more information, see `Starting a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/stop-flow.rst b/aws/dist/awscli/examples/mediaconnect/stop-flow.rst new file mode 100644 index 00000000..b6241e2a --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/stop-flow.rst @@ -0,0 +1,15 @@ +**To stop a flow** + +The following ``stop-flow`` example stops the specified flow. :: + + aws mediaconnect stop-flow \ + --flow-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow + +Output:: + + { + "Status": "STOPPING", + "FlowArn": "arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow" + } + +For more information, see `Stopping a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/tag-resource.rst b/aws/dist/awscli/examples/mediaconnect/tag-resource.rst new file mode 100644 index 00000000..95d75a92 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/tag-resource.rst @@ -0,0 +1,11 @@ +**To add tags to a MediaConnect resource** + +The following ``tag-resource`` example adds a tag with a key name and value to the specified MediaConnect resource. :: + + aws mediaconnect tag-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame + --tags region=west + +This command produces no output. + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff --git a/aws/dist/awscli/examples/mediaconnect/untag-resource.rst b/aws/dist/awscli/examples/mediaconnect/untag-resource.rst new file mode 100644 index 00000000..4d6b1884 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from a MediaConnect resource** + +The following ``untag-resource`` example remove the tag with the specified key name and its associated value from a MediaConnect resource. :: + + aws mediaconnect untag-resource \ + --resource-arn arn:aws:mediaconnect:us-east-1:123456789012:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BasketballGame \ + --tag-keys region + +This command produces no output. + +For more information, see `ListTagsForResource, TagResource, UntagResource `__ in the *AWS Elemental MediaConnect API Reference*. diff --git a/aws/dist/awscli/examples/mediaconnect/update-flow-entitlement.rst b/aws/dist/awscli/examples/mediaconnect/update-flow-entitlement.rst new file mode 100644 index 00000000..048cec34 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/update-flow-entitlement.rst @@ -0,0 +1,31 @@ +**To update an entitlement** + +The following ``update-flow-entitlement`` example updates the specified entitlement with a new description and subscriber. :: + + aws mediaconnect update-flow-entitlement \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --entitlement-arn arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement \ + --description 'For AnyCompany Affiliate' \ + --subscribers 777788889999 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "Entitlement": { + "Name": "AnyCompany_Entitlement", + "Description": "For AnyCompany Affiliate", + "EntitlementArn": "arn:aws:mediaconnect:us-west-2:111122223333:entitlement:1-11aa22bb11aa22bb-3333cccc4444:AnyCompany_Entitlement", + "Encryption": { + "KeyType": "static-key", + "Algorithm": "aes128", + "RoleArn": "arn:aws:iam::111122223333:role/MediaConnect-ASM", + "SecretArn": "arn:aws:secretsmanager:us-west-2:111122223333:secret:mySecret1" + }, + "Subscribers": [ + "777788889999" + ] + } + } + +For more information, see `Updating an Entitlement `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/update-flow-output.rst b/aws/dist/awscli/examples/mediaconnect/update-flow-output.rst new file mode 100644 index 00000000..9b1c7e40 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/update-flow-output.rst @@ -0,0 +1,27 @@ +**To update an output on a flow** + +The following ``update-flow-output`` example update an output on the specified flow. :: + + aws mediaconnect update-flow-output \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame \ + --output-arn arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC \ + --port 3331 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:BaseballGame", + "Output": { + "Name": "NYC", + "Port": 3331, + "Description": "NYC stream", + "Transport": { + "Protocol": "rtp-fec", + "SmoothingLatency": 100 + }, + "OutputArn": "arn:aws:mediaconnect:us-east-1:111122223333:output:2-3aBC45dEF67hiJ89-c34de5fG678h:NYC", + "Destination": "192.0.2.12" + } + } + +For more information, see `Updating Outputs on a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconnect/update-flow-source.rst b/aws/dist/awscli/examples/mediaconnect/update-flow-source.rst new file mode 100644 index 00000000..43218796 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconnect/update-flow-source.rst @@ -0,0 +1,30 @@ +**To update the source of an existing flow** + +The following ``update-flow-source`` example updates the source of an existing flow. :: + + aws mediaconnect update-flow-source \ + --flow-arn arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow \ + --source-arn arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource \ + --description 'Friday night show' \ + --ingest-port 3344 \ + --protocol rtp-fec \ + --whitelist-cidr 10.24.34.0/23 + +Output:: + + { + "FlowArn": "arn:aws:mediaconnect:us-east-1:111122223333:flow:1-23aBC45dEF67hiJ8-12AbC34DE5fG:AwardsShow", + "Source": { + "IngestIp": "34.210.136.56", + "WhitelistCidr": "10.24.34.0/23", + "Transport": { + "Protocol": "rtp-fec" + }, + "IngestPort": 3344, + "Name": "ShowSource", + "Description": "Friday night show", + "SourceArn": "arn:aws:mediaconnect:us-east-1:111122223333:source:3-4aBC56dEF78hiJ90-4de5fG6Hi78Jk:ShowSource" + } + } + +For more information, see `Updating the Source of a Flow `__ in the *AWS Elemental MediaConnect User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/cancel-job.rst b/aws/dist/awscli/examples/mediaconvert/cancel-job.rst new file mode 100644 index 00000000..f5cfcae2 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/cancel-job.rst @@ -0,0 +1,12 @@ +**To cancel a job that is in a queue** + +The following ``cancel-job`` example cancels the job with ID ``1234567891234-abc123``. You can't cancel a job that the service has started processing. :: + + aws mediaconvert cancel-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --id 1234567891234-abc123 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/create-job-template.rst b/aws/dist/awscli/examples/mediaconvert/create-job-template.rst new file mode 100644 index 00000000..ceb3cfb8 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/create-job-template.rst @@ -0,0 +1,18 @@ +**To create a job template** + +The following ``create-job-template`` example creates a job template with the transcoding settings that are specified in the file ``job-template.json`` that resides on your system. :: + + aws mediaconvert create-job-template \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --name JobTemplate1 \ + --cli-input-json file://~/job-template.json + +If you create your job template JSON file by using ``get-job-template`` and then modifying the file, remove the ``JobTemplate`` object, but keep the `Settings` child object inside it. Also, make sure to remove the following key-value pairs: ``LastUpdated``, ``Arn``, ``Type``, and ``CreatedAt``. You can specific the category, description, name, and queue either in the JSON file or at the command line. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns the JSON specification for the job template that you created. + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `_ in the *AWS Elemental MediaConvert User Guide*. + diff --git a/aws/dist/awscli/examples/mediaconvert/create-job.rst b/aws/dist/awscli/examples/mediaconvert/create-job.rst new file mode 100644 index 00000000..37b38450 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/create-job.rst @@ -0,0 +1,16 @@ +**To create a job** + +The following ``create-job`` example creates a transcoding job with the settings that are specified in a file ``job.json`` that resides on the system that you send the command from. This JSON job specification might specify each setting individually, reference a job template, or reference output presets. :: + + aws mediaconvert create-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --cli-input-json file://~/job.json + +You can use the AWS Elemental MediaConvert console to generate the JSON job specification by choosing your job settings, and then choosing **Show job JSON** at the bottom of the **Job** section. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns the JSON job specification that you sent with your request. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/create-preset.rst b/aws/dist/awscli/examples/mediaconvert/create-preset.rst new file mode 100644 index 00000000..a98af78e --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/create-preset.rst @@ -0,0 +1,14 @@ +**To create a custom output preset** + +The following ``create-preset`` example creates a custom output preset based on the output settings that are specified in the file ``preset.json``. You can specify the category, description, and name either in the JSON file or at the command line. :: + + aws mediaconvert create-preset \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com + --region region-name-1 \ + --cli-input-json file://~/preset.json + +If you create your preset JSON file by using ``get-preset`` and then modifying the output file, ensure that you remove the following key-value pairs: ``LastUpdated``, ``Arn``, ``Type``, and ``CreatedAt``. + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `_ in the *AWS Elemental MediaConvert User Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/mediaconvert/create-queue.rst b/aws/dist/awscli/examples/mediaconvert/create-queue.rst new file mode 100644 index 00000000..5a80550d --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/create-queue.rst @@ -0,0 +1,27 @@ +**To create a custom queue** + +The following ``create-queue`` example creates a custom transcoding queue. :: + + aws mediaconvert create-queue \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --name Queue1 \ + --description "Keep this queue empty unless job is urgent." + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +Output:: + + { + "Queue": { + "Status": "ACTIVE", + "Name": "Queue1", + "LastUpdated": 1518034928, + "Arn": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", + "Type": "CUSTOM", + "CreatedAt": 1518034928, + "Description": "Keep this queue empty unless job is urgent." + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `_ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/delete-job-template.rst b/aws/dist/awscli/examples/mediaconvert/delete-job-template.rst new file mode 100644 index 00000000..17e7e787 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/delete-job-template.rst @@ -0,0 +1,12 @@ +**To delete a job template** + +The following ``delete-job-template`` example deletes the specified custom job template. :: + + aws mediaconvert delete-job-template \ + --name "DASH Streaming" \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. Run ``aws mediaconvert list-job-templates`` to confirm that your template was deleted. + + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/delete-preset.rst b/aws/dist/awscli/examples/mediaconvert/delete-preset.rst new file mode 100644 index 00000000..78e7e44b --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/delete-preset.rst @@ -0,0 +1,11 @@ +**To delete a custom on-demand queue** + +The following ``delete-preset`` example deletes the specified custom preset. :: + + aws mediaconvert delete-preset \ + --name SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. Run ``aws mediaconvert list-presets`` to confirm that your preset was deleted. + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/delete-queue.rst b/aws/dist/awscli/examples/mediaconvert/delete-queue.rst new file mode 100644 index 00000000..644fdb8b --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/delete-queue.rst @@ -0,0 +1,14 @@ +**To delete a custom on-demand queue** + +The following ``delete-queue`` example deletes the specified custom on-demand queue. + +You can't delete your default queue. You can't delete a reserved queue that has an active pricing plan or that contains unprocessed jobs. :: + + aws mediaconvert delete-queue \ + --name Customer1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + + +This command produces no output. Run ``aws mediaconvert list-queues`` to confirm that your queue was deleted. + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/describe-endpoints.rst b/aws/dist/awscli/examples/mediaconvert/describe-endpoints.rst new file mode 100644 index 00000000..f9a62c7a --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/describe-endpoints.rst @@ -0,0 +1,18 @@ +**To get your account-specific endpoint** + +The following ``describe-endpoints`` example retrieves the endpoint that you need to send any other request to the service. :: + + aws mediaconvert describe-endpoints + +Output:: + + { + "Endpoints": [ + { + "Url": "https://abcd1234.mediaconvert.region-name-1.amazonaws.com" + } + ] + } + +For more information, see `Getting Started with MediaConvert Using the API `_ in the *AWS Elemental +MediaConvert API Reference*. diff --git a/aws/dist/awscli/examples/mediaconvert/get-job-template.rst b/aws/dist/awscli/examples/mediaconvert/get-job-template.rst new file mode 100644 index 00000000..83c3b616 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/get-job-template.rst @@ -0,0 +1,27 @@ +**To get details for a job template** + +The following ``get-job-template`` example displays the JSON definition of the specified custom job template. :: + + aws mediaconvert get-job-template \ + --name "DASH Streaming" \ + --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com + +Output:: + + { + "JobTemplate": { + "StatusUpdateInterval": "SECONDS_60", + "LastUpdated": 1568652998, + "Description": "Create a DASH streaming ABR stack", + "CreatedAt": 1568652998, + "Priority": 0, + "Name": "DASH Streaming", + "Settings": { + ...... + }, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", + "Type": "CUSTOM" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/get-job.rst b/aws/dist/awscli/examples/mediaconvert/get-job.rst new file mode 100644 index 00000000..2f1cd259 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/get-job.rst @@ -0,0 +1,36 @@ +**To get details for a particular job** + +The following example requests the information for the job with ID ``1234567890987-1ab2c3``, which in this example ended in an error. :: + + aws mediaconvert get-job \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 \ + --id 1234567890987-1ab2c3 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +If your request is successful, the service returns a JSON file with job information, including job settings, any returned errors, and other job data, as follows:: + + { + "Job": { + "Status": "ERROR", + "Queue": "arn:aws:mediaconvert:region-name-1:012345678998:queues/Queue1", + "Settings": { + ...... + }, + "ErrorMessage": "Unable to open input file [s3://my-input-bucket/file-name.mp4]: [Failed probe/open: [Failed to read data: AssumeRole failed]]", + "ErrorCode": 1434, + "Role": "arn:aws:iam::012345678998:role/MediaConvertServiceRole", + "Arn": "arn:aws:mediaconvert:us-west-1:012345678998:jobs/1234567890987-1ab2c3", + "UserMetadata": {}, + "Timing": { + "FinishTime": 1517442131, + "SubmitTime": 1517442103, + "StartTime": 1517442104 + }, + "Id": "1234567890987-1ab2c3", + "CreatedAt": 1517442103 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/get-preset.rst b/aws/dist/awscli/examples/mediaconvert/get-preset.rst new file mode 100644 index 00000000..d79ff9eb --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/get-preset.rst @@ -0,0 +1,97 @@ +**To get details for a particular preset** + +The following ``get-preset`` example requests the JSON definition of the specified custom preset. :: + + aws mediaconvert get-preset \ + --name SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Preset": { + "Description": "Creates basic MP4 file. No filtering or preproccessing.", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4", + "LastUpdated": 1568843141, + "Name": "SimpleMP4", + "Settings": { + "ContainerSettings": { + "Mp4Settings": { + "FreeSpaceBox": "EXCLUDE", + "CslgAtom": "INCLUDE", + "MoovPlacement": "PROGRESSIVE_DOWNLOAD" + }, + "Container": "MP4" + }, + "AudioDescriptions": [ + { + "LanguageCodeControl": "FOLLOW_INPUT", + "AudioTypeControl": "FOLLOW_INPUT", + "CodecSettings": { + "AacSettings": { + "RawFormat": "NONE", + "CodecProfile": "LC", + "AudioDescriptionBroadcasterMix": "NORMAL", + "SampleRate": 48000, + "Bitrate": 96000, + "RateControlMode": "CBR", + "Specification": "MPEG4", + "CodingMode": "CODING_MODE_2_0" + }, + "Codec": "AAC" + } + } + ], + "VideoDescription": { + "RespondToAfd": "NONE", + "TimecodeInsertion": "DISABLED", + "Sharpness": 50, + "ColorMetadata": "INSERT", + "CodecSettings": { + "H264Settings": { + "FramerateControl": "INITIALIZE_FROM_SOURCE", + "SpatialAdaptiveQuantization": "ENABLED", + "Softness": 0, + "Telecine": "NONE", + "CodecLevel": "AUTO", + "QualityTuningLevel": "SINGLE_PASS", + "UnregisteredSeiTimecode": "DISABLED", + "Slices": 1, + "Syntax": "DEFAULT", + "GopClosedCadence": 1, + "AdaptiveQuantization": "HIGH", + "EntropyEncoding": "CABAC", + "InterlaceMode": "PROGRESSIVE", + "ParControl": "INITIALIZE_FROM_SOURCE", + "NumberBFramesBetweenReferenceFrames": 2, + "GopSizeUnits": "FRAMES", + "RepeatPps": "DISABLED", + "CodecProfile": "MAIN", + "FieldEncoding": "PAFF", + "GopSize": 90.0, + "SlowPal": "DISABLED", + "SceneChangeDetect": "ENABLED", + "GopBReference": "DISABLED", + "RateControlMode": "CBR", + "FramerateConversionAlgorithm": "DUPLICATE_DROP", + "FlickerAdaptiveQuantization": "DISABLED", + "DynamicSubGop": "STATIC", + "MinIInterval": 0, + "TemporalAdaptiveQuantization": "ENABLED", + "Bitrate": 400000, + "NumberReferenceFrames": 3 + }, + "Codec": "H_264" + }, + "AfdSignaling": "NONE", + "AntiAlias": "ENABLED", + "ScalingBehavior": "DEFAULT", + "DropFrameTimecode": "ENABLED" + } + }, + "Type": "CUSTOM", + "CreatedAt": 1568841521 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/get-queue.rst b/aws/dist/awscli/examples/mediaconvert/get-queue.rst new file mode 100644 index 00000000..ba6c2637 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/get-queue.rst @@ -0,0 +1,25 @@ +**To get details for a queue** + +The following ``get-queue`` example retrieves the details of the specified custom queue. :: + + aws mediaconvert get-queue \ + --name Customer1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Queue": { + "LastUpdated": 1526428502, + "Type": "CUSTOM", + "SubmittedJobsCount": 0, + "Status": "ACTIVE", + "PricingPlan": "ON_DEMAND", + "CreatedAt": 1526428502, + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", + "Name": "Customer1" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/list-job-templates.rst b/aws/dist/awscli/examples/mediaconvert/list-job-templates.rst new file mode 100644 index 00000000..53bd07a4 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/list-job-templates.rst @@ -0,0 +1,112 @@ +**Example 1: To list your custom job templates** + +The following ``list-job-templates`` example lists all custom job templates in the current Region. To list the system job templates, see the next example. :: + + aws mediaconvert list-job-templates \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "JobTemplates": [ + { + "Description": "Create a DASH streaming ABR stack", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/DASH Streaming", + "Name": "DASH Streaming", + "LastUpdated": 1568653007, + "Priority": 0, + "Settings": { + ...... + }, + "Type": "CUSTOM", + "StatusUpdateInterval": "SECONDS_60", + "CreatedAt": 1568653007 + }, + { + "Description": "Create a high-res file", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:jobTemplates/File", + "Name": "File", + "LastUpdated": 1568653007, + "Priority": 0, + "Settings": { + ...... + }, + "Type": "CUSTOM", + "StatusUpdateInterval": "SECONDS_60", + "CreatedAt": 1568653023 + } + ] + } + +**Example 2: To list the MediaConvert system job templates** + +The following ``list-job-templates`` example lists all system job templates. :: + + aws mediaconvert list-job-templates \ + --endpoint-url https://abcd1234.mediaconvert.us-east-1.amazonaws.com \ + --list-by SYSTEM + +Output:: + + { + "JobTemplates": [ + { + "CreatedAt": 1568321779, + "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:jobTemplates/System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", + "Name": "System-Generic_Mp4_Hev1_Avc_Aac_Sdr_Qvbr", + "Description": "GENERIC, MP4, AVC + HEV1(HEVC,SDR), AAC, SDR, QVBR", + "Category": "GENERIC", + "Settings": { + "AdAvailOffset": 0, + "OutputGroups": [ + { + "Outputs": [ + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1280x720p_30Hz_5000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Avc_Aac_16x9_Sdr_1920x1080p_30Hz_10000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_0.8Mbps_Qvbr_Vq7", + "NameModifier": "_Generic_Sd_Mp4_Avc_Aac_16x9_Sdr_640x360p_30Hz_800Kbps_Qvbr_Vq7" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1280x720p_30Hz_4000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Hd_Mp4_Hev1_Aac_16x9_Sdr_1920x1080p_30Hz_8000Kbps_Qvbr_Vq9" + }, + { + "Extension": "mp4", + "Preset": "System-Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12Mbps_Qvbr_Vq9", + "NameModifier": "_Generic_Uhd_Mp4_Hev1_Aac_16x9_Sdr_3840x2160p_30Hz_12000Kbps_Qvbr_Vq9" + } + ], + "OutputGroupSettings": { + "FileGroupSettings": { + + }, + "Type": "FILE_GROUP_SETTINGS" + }, + "Name": "File Group" + } + ] + }, + "Type": "SYSTEM", + "LastUpdated": 1568321779 + }, + ...... + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/list-jobs.rst b/aws/dist/awscli/examples/mediaconvert/list-jobs.rst new file mode 100644 index 00000000..139df49b --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/list-jobs.rst @@ -0,0 +1,11 @@ +**To get details for all jobs in a region** + +The following example requests the information for all of your jobs in the specified region. :: + + aws mediaconvert list-jobs \ + --endpoint-url https://abcd1234.mediaconvert.region-name-1.amazonaws.com \ + --region region-name-1 + +To get your account-specific endpoint, use ``describe-endpoints``, or send the command without the endpoint. The service returns an error and your endpoint. + +For more information, see `Working with AWS Elemental MediaConvert Jobs `_ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/list-presets.rst b/aws/dist/awscli/examples/mediaconvert/list-presets.rst new file mode 100644 index 00000000..8e962a50 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/list-presets.rst @@ -0,0 +1,79 @@ +**Example 1: To list your custom output presets** + +The following ``list-presets`` example lists your custom output presets. To list the system presets, see the next example. :: + + aws mediaconvert list-presets \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Presets": [ + { + "Name": "SimpleMP4", + "CreatedAt": 1568841521, + "Settings": { + ...... + }, + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", + "Type": "CUSTOM", + "LastUpdated": 1568843141, + "Description": "Creates basic MP4 file. No filtering or preproccessing." + }, + { + "Name": "SimpleTS", + "CreatedAt": 1568843113, + "Settings": { + ... truncated for brevity ... + }, + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleTS", + "Type": "CUSTOM", + "LastUpdated": 1568843113, + "Description": "Create a basic transport stream." + } + ] + } + +**Example 2: To list the system output presets** + +The following ``list-presets`` example lists the available MediaConvert system presets. To list your custom presets, see the previous example. :: + + aws mediaconvert list-presets \ + --list-by SYSTEM \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Presets": [ + { + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/System-Avc_16x9_1080p_29_97fps_8500kbps", + "Name": "System-Avc_16x9_1080p_29_97fps_8500kbps", + "CreatedAt": 1568321789, + "Description": "Wifi, 1920x1080, 16:9, 29.97fps, 8500kbps", + "LastUpdated": 1568321789, + "Type": "SYSTEM", + "Category": "HLS", + "Settings": { + ...... + } + }, + + ...... + + { + "Arn": "arn:aws:mediaconvert:us-east-1:123456789012:presets/System-Xdcam_HD_1080i_29_97fps_35mpbs", + "Name": "System-Xdcam_HD_1080i_29_97fps_35mpbs", + "CreatedAt": 1568321790, + "Description": "XDCAM MPEG HD, 1920x1080i, 29.97fps, 35mbps", + "LastUpdated": 1568321790, + "Type": "SYSTEM", + "Category": "MXF", + "Settings": { + ...... + } + } + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/list-queues.rst b/aws/dist/awscli/examples/mediaconvert/list-queues.rst new file mode 100644 index 00000000..bfc415fd --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/list-queues.rst @@ -0,0 +1,58 @@ +**To list your queues** + +The following ``list-queues`` example lists all of your MediaConvert queues. :: + + aws mediaconvert list-queues \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + + +Output:: + + { + "Queues": [ + { + "PricingPlan": "ON_DEMAND", + "Type": "SYSTEM", + "Status": "ACTIVE", + "CreatedAt": 1503451595, + "Name": "Default", + "SubmittedJobsCount": 0, + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Default", + "LastUpdated": 1534549158 + }, + { + "PricingPlan": "ON_DEMAND", + "Type": "CUSTOM", + "Status": "ACTIVE", + "CreatedAt": 1537460025, + "Name": "Customer1", + "SubmittedJobsCount": 0, + "Description": "Jobs we run for our cusotmer.", + "ProgressingJobsCount": 0, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/Customer1", + "LastUpdated": 1537460025 + }, + { + "ProgressingJobsCount": 0, + "Status": "ACTIVE", + "Name": "transcode-library", + "SubmittedJobsCount": 0, + "LastUpdated": 1564066204, + "ReservationPlan": { + "Status": "ACTIVE", + "ReservedSlots": 1, + "PurchasedAt": 1564066203, + "Commitment": "ONE_YEAR", + "ExpiresAt": 1595688603, + "RenewalType": "EXPIRE" + }, + "PricingPlan": "RESERVED", + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:queues/transcode-library", + "Type": "CUSTOM", + "CreatedAt": 1564066204 + } + ] + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/list-tags-for-resource.rst b/aws/dist/awscli/examples/mediaconvert/list-tags-for-resource.rst new file mode 100644 index 00000000..51031f5f --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/list-tags-for-resource.rst @@ -0,0 +1,20 @@ +**To list the tags on a MediaConvert queue, job template, or output preset** + +The following ``list-tags-for-resource`` example lists the tags on the specified output preset. :: + + aws mediaconvert list-tags-for-resource \ + --arn arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "ResourceTags": { + "Tags": { + "customer": "zippyVideo" + }, + "Arn": "arn:aws:mediaconvert:us-west-2:123456789012:presets/SimpleMP4" + } + } + +For more information, see `Tagging AWS Elemental MediaConvert Queues, Job Templates, and Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/update-job-template.rst b/aws/dist/awscli/examples/mediaconvert/update-job-template.rst new file mode 100644 index 00000000..3e3b4cfc --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/update-job-template.rst @@ -0,0 +1,113 @@ +**To change a job template** + +The following ``update-job-template`` example replaces the JSON definition of the specified custom job template with the JSON definition in the provided file. + + aws mediaconvert update-job-template \ + --name File1 \ + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com \ + --cli-input-json file://~/job-template-update.json + +Contents of ``job-template-update.json``:: + + { + "Description": "A simple job template that generates a single file output.", + "Queue": "arn:aws:mediaconvert:us-east-1:012345678998:queues/Default", + "Name": "SimpleFile", + "Settings": { + "OutputGroups": [ + { + "Name": "File Group", + "Outputs": [ + { + "ContainerSettings": { + "Container": "MP4", + "Mp4Settings": { + "CslgAtom": "INCLUDE", + "FreeSpaceBox": "EXCLUDE", + "MoovPlacement": "PROGRESSIVE_DOWNLOAD" + } + }, + "VideoDescription": { + "ScalingBehavior": "DEFAULT", + "TimecodeInsertion": "DISABLED", + "AntiAlias": "ENABLED", + "Sharpness": 50, + "CodecSettings": { + "Codec": "H_264", + "H264Settings": { + "InterlaceMode": "PROGRESSIVE", + "NumberReferenceFrames": 3, + "Syntax": "DEFAULT", + "Softness": 0, + "GopClosedCadence": 1, + "GopSize": 90, + "Slices": 1, + "GopBReference": "DISABLED", + "SlowPal": "DISABLED", + "SpatialAdaptiveQuantization": "ENABLED", + "TemporalAdaptiveQuantization": "ENABLED", + "FlickerAdaptiveQuantization": "DISABLED", + "EntropyEncoding": "CABAC", + "Bitrate": 400000, + "FramerateControl": "INITIALIZE_FROM_SOURCE", + "RateControlMode": "CBR", + "CodecProfile": "MAIN", + "Telecine": "NONE", + "MinIInterval": 0, + "AdaptiveQuantization": "HIGH", + "CodecLevel": "AUTO", + "FieldEncoding": "PAFF", + "SceneChangeDetect": "ENABLED", + "QualityTuningLevel": "SINGLE_PASS", + "FramerateConversionAlgorithm": "DUPLICATE_DROP", + "UnregisteredSeiTimecode": "DISABLED", + "GopSizeUnits": "FRAMES", + "ParControl": "INITIALIZE_FROM_SOURCE", + "NumberBFramesBetweenReferenceFrames": 2, + "RepeatPps": "DISABLED", + "DynamicSubGop": "STATIC" + } + }, + "AfdSignaling": "NONE", + "DropFrameTimecode": "ENABLED", + "RespondToAfd": "NONE", + "ColorMetadata": "INSERT" + }, + "AudioDescriptions": [ + { + "AudioTypeControl": "FOLLOW_INPUT", + "CodecSettings": { + "Codec": "AAC", + "AacSettings": { + "AudioDescriptionBroadcasterMix": "NORMAL", + "Bitrate": 96000, + "RateControlMode": "CBR", + "CodecProfile": "LC", + "CodingMode": "CODING_MODE_2_0", + "RawFormat": "NONE", + "SampleRate": 48000, + "Specification": "MPEG4" + } + }, + "LanguageCodeControl": "FOLLOW_INPUT" + } + ] + } + ], + "OutputGroupSettings": { + "Type": "FILE_GROUP_SETTINGS", + "FileGroupSettings": {} + } + } + ], + "AdAvailOffset": 0 + }, + "StatusUpdateInterval": "SECONDS_60", + "Priority": 0 + } + +The system returns the JSON payload that you send with your request, even when the request results in an error. Therefore, the JSON returned is not necessarily the new definition of the job template. + +Because the JSON payload can be long, you might need to scroll up to see any error messages. + +For more information, see `Working with AWS Elemental MediaConvert Job Templates `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/update-preset.rst b/aws/dist/awscli/examples/mediaconvert/update-preset.rst new file mode 100644 index 00000000..9582cb42 --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/update-preset.rst @@ -0,0 +1,28 @@ +**To change a preset** + +The following ``update-preset`` example replaces the description for the specified preset. + :: + + aws mediaconvert update-preset \ + --name Customer1 \ + --description "New description text." + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +This command produces no output. +Output:: + + { + "Preset": { + "Arn": "arn:aws:mediaconvert:us-east-1:003235472598:presets/SimpleMP4", + "Settings": { + ...... + }, + "Type": "CUSTOM", + "LastUpdated": 1568938411, + "Description": "New description text.", + "Name": "SimpleMP4", + "CreatedAt": 1568938240 + } + } + +For more information, see `Working with AWS Elemental MediaConvert Output Presets `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediaconvert/update-queue.rst b/aws/dist/awscli/examples/mediaconvert/update-queue.rst new file mode 100644 index 00000000..467ff24d --- /dev/null +++ b/aws/dist/awscli/examples/mediaconvert/update-queue.rst @@ -0,0 +1,26 @@ +**To change a queue** + +The following ``update-queue`` example pauses the specified queue, by changing its status to ``PAUSED``. :: + + aws mediaconvert update-queue \ + --name Customer1 \ + --status PAUSED + --endpoint-url https://abcd1234.mediaconvert.us-west-2.amazonaws.com + +Output:: + + { + "Queue": { + "LastUpdated": 1568839845, + "Status": "PAUSED", + "ProgressingJobsCount": 0, + "CreatedAt": 1526428516, + "Arn": "arn:aws:mediaconvert:us-west-1:123456789012:queues/Customer1", + "Name": "Customer1", + "SubmittedJobsCount": 0, + "PricingPlan": "ON_DEMAND", + "Type": "CUSTOM" + } + } + +For more information, see `Working with AWS Elemental MediaConvert Queues `__ in the *AWS Elemental MediaConvert User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/create-channel.rst b/aws/dist/awscli/examples/mediapackage/create-channel.rst new file mode 100644 index 00000000..4dda9d79 --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/create-channel.rst @@ -0,0 +1,33 @@ +**To create a channel** + +The following ``create-channel`` command creates a channel named ``sportschannel`` in the current account. :: + + aws mediapackage create-channel --id sportschannel + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "6d345804ec3f46c9b454a91d4a80d0e0", + "Password": "generatedwebdavpassword1", + "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", + "Username": "generatedwebdavusername1" + }, + { + "Id": "2daa32878af24803b24183727211b8ff", + "Password": "generatedwebdavpassword2", + "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", + "Username": "generatedwebdavusername2" + } + ] + }, + "Id": "sportschannel", + "Tags": { + "region": "west" + } + } + +For more information, see `Creating a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/create-origin-endpoint.rst b/aws/dist/awscli/examples/mediapackage/create-origin-endpoint.rst new file mode 100644 index 00000000..0b221a27 --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/create-origin-endpoint.rst @@ -0,0 +1,49 @@ +**To create an origin endpoint** + +The following ``create-origin-endpoint`` command creates an origin endpoint named ``cmafsports`` with the package settings provided in a JSON file and specified endpoint settings. :: + + aws mediapackage create-origin-endpoint \ + --channel-id sportschannel \ + --id cmafsports \ + --cmaf-package file://file/path/cmafpkg.json --description "cmaf output of sports" \ + --id cmaf_sports \ + --manifest-name sports_channel \ + --startover-window-seconds 300 \ + --tags region=west,media=sports \ + --time-delay-seconds 10 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "PASSTHROUGH", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": true, + "ManifestName": "index", + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 300, + "ProgramDateTimeIntervalSeconds": 300, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Description": "cmaf output of sports", + "Id": "cmaf_sports", + "ManifestName": "sports_channel", + "StartoverWindowSeconds": 300, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 10, + "Url": "", + "Whitelist": [] + } + +For more information, see `Creating an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/delete-channel.rst b/aws/dist/awscli/examples/mediapackage/delete-channel.rst new file mode 100644 index 00000000..5c426802 --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/delete-channel.rst @@ -0,0 +1,10 @@ +**To delete a channel** + +The following ``delete-channel`` command deletes the channel named ``test``. :: + + aws mediapackage delete-channel \ + --id test + +This command produces no output. + +For more information, see `Deleting a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/delete-origin-endpoint.rst b/aws/dist/awscli/examples/mediapackage/delete-origin-endpoint.rst new file mode 100644 index 00000000..91b24315 --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/delete-origin-endpoint.rst @@ -0,0 +1,8 @@ +**To delete an origin endpoint** + +The following ``delete-origin-endpoint`` command deletes the origin endpoint named ``tester2``. :: + + aws mediapackage delete-origin-endpoint \ + --id tester2 + +For more information, see `Deleting an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/describe-channel.rst b/aws/dist/awscli/examples/mediapackage/describe-channel.rst new file mode 100644 index 00000000..f5dc6027 --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/describe-channel.rst @@ -0,0 +1,32 @@ +**To describe a channel** + +The following ``describe-channel`` command displays all of the details of the channel named ``test``. :: + + aws mediapackage describe-channel \ + --id test + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavgeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavgeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + +For more information, see `Viewing Channel Details`__ in the *AWS Elemental MediaPackage User Guide* diff --git a/aws/dist/awscli/examples/mediapackage/describe-origin-endpoint.rst b/aws/dist/awscli/examples/mediapackage/describe-origin-endpoint.rst new file mode 100644 index 00000000..580b0f2e --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/describe-origin-endpoint.rst @@ -0,0 +1,40 @@ +**To describe an origin endpoint** + +The following ``describe-origin-endpoint`` command displays all of the details of the origin endpoint named ``cmaf_sports``. :: + + aws mediapackage describe-origin-endpoint \ + --id cmaf_sports + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "NONE", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Id": "cmaf_sports", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 0, + "Url": "", + "Whitelist": [] + } + +For more information, see `Viewing a Single Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/list-channels.rst b/aws/dist/awscli/examples/mediapackage/list-channels.rst new file mode 100644 index 00000000..1e9e204b --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/list-channels.rst @@ -0,0 +1,35 @@ +**To list all channels** + +The following ``list-channels`` command lists all of the channels that are configured on the current AWS account. :: + + aws mediapackage list-channels + +Output:: + + { + "Channels": [ + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavgeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavgeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + ] + } + +For more information, see `Viewing Channel Details `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/list-origin-endpoints.rst b/aws/dist/awscli/examples/mediapackage/list-origin-endpoints.rst new file mode 100644 index 00000000..39756ffa --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/list-origin-endpoints.rst @@ -0,0 +1,67 @@ +**To list all origin-endpoints on a channel** + +The following ``list-origin-endpoints`` command lists all of the origin endpoints that are configured on the channel named ``test``. :: + + aws mediapackage list-origin-endpoints \ + --channel-id test + +Output:: + + { + "OriginEndpoints": [ + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/247cff871f2845d3805129be22f2c0a2", + "ChannelId": "test", + "DashPackage": { + "ManifestLayout": "FULL", + "ManifestWindowSeconds": 60, + "MinBufferTimeSeconds": 30, + "MinUpdatePeriodSeconds": 15, + "PeriodTriggers": [], + "Profile": "NONE", + "SegmentDurationSeconds": 2, + "SegmentTemplateFormat": "NUMBER_WITH_TIMELINE", + "StreamSelection": { + "MaxVideoBitsPerSecond": 2147483647, + "MinVideoBitsPerSecond": 0, + "StreamOrder": "ORIGINAL" + }, + "SuggestedPresentationDelaySeconds": 25 + }, + "Id": "tester2", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": {}, + "TimeDelaySeconds": 0, + "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/247cff871f2845d3805129be22f2c0a2/index.mpd", + "Whitelist": [] + }, + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/869e237f851549e9bcf10e3bc2830839", + "ChannelId": "test", + "HlsPackage": { + "AdMarkers": "NONE", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "SegmentDurationSeconds": 6, + "StreamSelection": { + "MaxVideoBitsPerSecond": 2147483647, + "MinVideoBitsPerSecond": 0, + "StreamOrder": "ORIGINAL" + }, + "UseAudioRenditionGroup": false + }, + "Id": "tester", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": {}, + "TimeDelaySeconds": 0, + "Url": "https://8343f7014c0ea438.mediapackage.us-west-2.amazonaws.com/out/v1/869e237f851549e9bcf10e3bc2830839/index.m3u8", + "Whitelist": [] + } + ] + } + +For more information, see `Viewing all Endpoints Associated with a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/list-tags-for-resource.rst b/aws/dist/awscli/examples/mediapackage/list-tags-for-resource.rst new file mode 100644 index 00000000..3d38a7bc --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/list-tags-for-resource.rst @@ -0,0 +1,16 @@ +**To list the tags assigned to a resource** + +The following ``list-tags-for-resource`` command lists the tags that are assigned to the specified resource. :: + + aws mediapackage list-tags-for-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 + +Output:: + + { + "Tags": { + "region": "west" + } + } + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst b/aws/dist/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst new file mode 100644 index 00000000..2e24d47f --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/rotate-ingest-endpoint-credentials.rst @@ -0,0 +1,33 @@ +**To rotate ingest credentials** + +The following ``rotate-ingest-endpoint-credentials`` command rotates the WebDAV username and password for the specified ingest endpoint. :: + + aws mediapackage rotate-ingest-endpoint-credentials \ + --id test \ + --ingest-endpoint-id 584797f1740548c389a273585dd22a63 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/584797f1740548c389a273585dd22a63", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "584797f1740548c389a273585dd22a63", + "Password": "webdavregeneratedpassword1", + "Url": "https://9be9c4405c474882.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/584797f1740548c389a273585dd22a63/channel", + "Username": "webdavregeneratedusername1" + }, + { + "Id": "7d187c8616fd455f88aaa5a9fcf74442", + "Password": "webdavgeneratedpassword2", + "Url": "https://7bf454c57220328d.mediapackage.us-west-2.amazonaws.com/in/v2/584797f1740548c389a273585dd22a63/7d187c8616fd455f88aaa5a9fcf74442/channel", + "Username": "webdavgeneratedusername2" + } + ] + }, + "Id": "test", + "Tags": {} + } + +For more information, see `Rotating Credentials on an Input URL `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/tag-resource.rst b/aws/dist/awscli/examples/mediapackage/tag-resource.rst new file mode 100644 index 00000000..3c6f9dde --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/tag-resource.rst @@ -0,0 +1,11 @@ +**To add a tag to a resource** + +The following ``tag-resource`` commands adds a ``region=west`` key and value pair to the specified resource. :: + + aws mediapackage tag-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ + --tags region=west + +This command produces no output. + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/untag-resource.rst b/aws/dist/awscli/examples/mediapackage/untag-resource.rst new file mode 100644 index 00000000..681afb2c --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/untag-resource.rst @@ -0,0 +1,9 @@ +**To remove a tag from a resource** + +The following ``untag-resource`` command removes the tag with the key ``region`` from the specified channel. :: + + aws mediapackage untag-resource \ + --resource-arn arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0 \ + --tag-keys region + +For more information, see `Tagging Resources in AWS Elemental MediaPackage `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/update-channel.rst b/aws/dist/awscli/examples/mediapackage/update-channel.rst new file mode 100644 index 00000000..6a4a428f --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/update-channel.rst @@ -0,0 +1,34 @@ +**To update a channel** + +The following ``update-channel`` command updates the channel named ``sportschannel`` to include the description ``24x7 sports``. :: + + aws mediapackage update-channel \ + --id sportschannel \ + --description "24x7 sports" + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:channels/6d345804ec3f46c9b454a91d4a80d0e0", + "Description": "24x7 sports", + "HlsIngest": { + "IngestEndpoints": [ + { + "Id": "6d345804ec3f46c9b454a91d4a80d0e0", + "Password": "generatedwebdavpassword1", + "Url": "https://f31c86aed53b815a.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/6d345804ec3f46c9b454a91d4a80d0e0/channel", + "Username": "generatedwebdavusername1" + }, + { + "Id": "2daa32878af24803b24183727211b8ff", + "Password": "generatedwebdavpassword2", + "Url": "https://6ebbe7e04c4b0afa.mediapackage.us-west-2.amazonaws.com/in/v2/6d345804ec3f46c9b454a91d4a80d0e0/2daa32878af24803b24183727211b8ff/channel", + "Username": "generatedwebdavusername2" + } + ] + }, + "Id": "sportschannel", + "Tags": {} + } + +For more information, see `Editing a Channel `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediapackage/update-origin-endpoint.rst b/aws/dist/awscli/examples/mediapackage/update-origin-endpoint.rst new file mode 100644 index 00000000..e5e9c98d --- /dev/null +++ b/aws/dist/awscli/examples/mediapackage/update-origin-endpoint.rst @@ -0,0 +1,41 @@ +**To update an origin endpoint** + +The following ``update-origin-endpoint`` command updates the origin endpoint named ``cmaf_sports``. It changes the time delay to ``0`` seconds. :: + + aws mediapackage update-origin-endpoint \ + --id cmaf_sports \ + --time-delay-seconds 0 + +Output:: + + { + "Arn": "arn:aws:mediapackage:us-west-2:111222333:origin_endpoints/1dc6718be36f4f34bb9cd86bc50925e6", + "ChannelId": "sportschannel", + "CmafPackage": { + "HlsManifests": [ + { + "AdMarkers": "NONE", + "Id": "cmaf_sports_endpoint", + "IncludeIframeOnlyStream": false, + "PlaylistType": "EVENT", + "PlaylistWindowSeconds": 60, + "ProgramDateTimeIntervalSeconds": 0, + "Url": "https://c4af3793bf76b33c.mediapackage.us-west-2.amazonaws.com/out/v1/1dc6718be36f4f34bb9cd86bc50925e6/cmaf_sports_endpoint/index.m3u8" + } + ], + "SegmentDurationSeconds": 2, + "SegmentPrefix": "sportschannel" + }, + "Id": "cmaf_sports", + "ManifestName": "index", + "StartoverWindowSeconds": 0, + "Tags": { + "region": "west", + "media": "sports" + }, + "TimeDelaySeconds": 0, + "Url": "", + "Whitelist": [] + } + +For more information, see `Editing an Endpoint `__ in the *AWS Elemental MediaPackage User Guide*. diff --git a/aws/dist/awscli/examples/mediastore-data/delete-object.rst b/aws/dist/awscli/examples/mediastore-data/delete-object.rst new file mode 100644 index 00000000..b9844a35 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore-data/delete-object.rst @@ -0,0 +1,11 @@ +**To delete an object** + +The following ``delete-object`` example deletes the specified object. :: + + aws mediastore-data delete-object \ + --endpoint=https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path=/folder_name/README.md + +This command produces no output. + +For more information, see `Deleting an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore-data/describe-object.rst b/aws/dist/awscli/examples/mediastore-data/describe-object.rst new file mode 100644 index 00000000..c48439b5 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore-data/describe-object.rst @@ -0,0 +1,18 @@ +**To view the headers for an object** + +The following ``describe-object`` example displays the headers for an object at the specified path. :: + + aws mediastore-data describe-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg + +Output:: + + { + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", + "ContentType": "image/jpeg", + "ContentLength": "3860266", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Viewing the Details of an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore-data/get-object.rst b/aws/dist/awscli/examples/mediastore-data/get-object.rst new file mode 100644 index 00000000..084b020c --- /dev/null +++ b/aws/dist/awscli/examples/mediastore-data/get-object.rst @@ -0,0 +1,39 @@ +**Example 1: To download an entire object** + +The following ``get-object`` example downloads the specified object. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg setup.jpg + +Output:: + + { + "ContentType": "image/jpeg", + "StatusCode": 200, + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentLength": "3860266", + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT" + } + +**Example 2: To download part of an object** + +The following ``get-object`` example downloads the specified part of an object. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball/setup.jpg setup.jpg \ + --range "bytes=0-100" + +Output:: + + { + "StatusCode": 206, + "LastModified": "Fri, 19 Jul 2019 21:50:31 GMT", + "ContentType": "image/jpeg", + "ContentRange": "bytes 0-100/3860266", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentLength": "101" + } + +For more information, see `Downloading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore-data/list-items.rst b/aws/dist/awscli/examples/mediastore-data/list-items.rst new file mode 100644 index 00000000..9602fd38 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore-data/list-items.rst @@ -0,0 +1,50 @@ +**Example 1: To view a list of items (objects and folders) stored in a container** + +The following ``list-items`` example displays a list of items (objects and folders) stored in the specified container. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "Type": "OBJECT", + "ContentLength": 3784, + "Name": "setup.jpg", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentType": "image/jpeg", + "LastModified": 1563571859.379 + }, + { + "Type": "FOLDER", + "Name": "events" + } + ] + } + +**Example 2: To view a list of items (objects and folders) stored in a folder** + +The following ``list-items`` example displays a list of items (objects and folders) stored in the specified folder. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path events/baseball + +Output:: + + { + "Items": [ + { + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentType": "image/jpeg", + "Type": "OBJECT", + "ContentLength": 3860266, + "LastModified": 1563573031.872, + "Name": "setup.jpg" + } + ] + } + +For more information, see `Viewing a List of Objects `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore-data/put-object.rst b/aws/dist/awscli/examples/mediastore-data/put-object.rst new file mode 100644 index 00000000..5f62a34c --- /dev/null +++ b/aws/dist/awscli/examples/mediastore-data/put-object.rst @@ -0,0 +1,39 @@ +**Example 1: To upload an object to a container** + +The following ``put-object`` example upload an object to the specified container. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body ReadMe.md \ + --path ReadMe.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", + "StorageClass": "TEMPORAL", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +**Example 2: To upload an object to a folder within a container** + +The following ``put-object`` example upload an object to the specified folder within a container. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body ReadMe.md \ + --path /september-events/ReadMe.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "ContentSHA256": "f29bc64a9d3732b4b9035125fdb3285f5b6455778edca72414671e0ca3b2e0de", + "StorageClass": "TEMPORAL" + } + +For more information, see `Uploading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/create-container.rst b/aws/dist/awscli/examples/mediastore/create-container.rst new file mode 100644 index 00000000..a9b4adca --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/create-container.rst @@ -0,0 +1,19 @@ +**To create a container** + +The following ``create-container`` example creates a new, empty container. :: + + aws mediastore create-container --container-name ExampleContainer + +Output:: + + { + "Container": { + "AccessLoggingEnabled": false, + "CreationTime": 1563557265, + "Name": "ExampleContainer", + "Status": "CREATING", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer" + } + } + +For more information, see `Creating a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/delete-container-policy.rst b/aws/dist/awscli/examples/mediastore/delete-container-policy.rst new file mode 100644 index 00000000..3a1471b1 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/delete-container-policy.rst @@ -0,0 +1,10 @@ +**To delete a container policy** + +The following ``delete-container-policy`` example deletes the policy that is assigned to the specified container. When the policy is deleted, AWS Elemental MediaStore automatically assigns the default policy to the container. :: + + aws mediastore delete-container-policy \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `DeleteContainerPolicy `__ in the *AWS Elemental MediaStore API reference*. diff --git a/aws/dist/awscli/examples/mediastore/delete-container.rst b/aws/dist/awscli/examples/mediastore/delete-container.rst new file mode 100644 index 00000000..0a1945ac --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/delete-container.rst @@ -0,0 +1,10 @@ +**To delete a container** + +The following ``delete-container`` example deletes the specified container. You can delete a container only if it has no objects. :: + + aws mediastore delete-container \ + --container-name=ExampleLiveDemo + +This command produces no output. + +For more information, see `Deleting a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/delete-cors-policy.rst b/aws/dist/awscli/examples/mediastore/delete-cors-policy.rst new file mode 100644 index 00000000..a7720c05 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/delete-cors-policy.rst @@ -0,0 +1,10 @@ +**To delete a CORS policy** + +The following ``delete-cors-policy`` example deletes the cross-origin resource sharing (CORS) policy that is assigned to the specified container. :: + + aws mediastore delete-cors-policy \ + --container-name ExampleContainer + +This command produces no output. + +For more information, see `Deleting a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/delete-lifecycle-policy.rst b/aws/dist/awscli/examples/mediastore/delete-lifecycle-policy.rst new file mode 100644 index 00000000..8d003bb4 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/delete-lifecycle-policy.rst @@ -0,0 +1,10 @@ +**To delete an object lifecycle policy** + +The following ``delete-lifecycle-policy`` example deletes the object lifecycle policy attached to the specified container. This change can take up to 20 minutes to take effect. :: + + aws mediastore delete-lifecycle-policy \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Deleting an Object Lifecycle Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/describe-container.rst b/aws/dist/awscli/examples/mediastore/describe-container.rst new file mode 100644 index 00000000..11da60a0 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/describe-container.rst @@ -0,0 +1,21 @@ +**To view the details of a container** + +The following ``describe-container`` example displays the details of the specified container. :: + + aws mediastore describe-container \ + --container-name ExampleContainer + +Output:: + + { + "Container": { + "CreationTime": 1563558086, + "AccessLoggingEnabled": false, + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", + "Status": "ACTIVE", + "Name": "ExampleContainer", + "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com" + } + } + +For more information, see `Viewing the Details for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/describe-object.rst b/aws/dist/awscli/examples/mediastore/describe-object.rst new file mode 100644 index 00000000..1736472a --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/describe-object.rst @@ -0,0 +1,18 @@ +**To view a list of objects and folders in a specific container** + +The following ``describe-object`` example displays items (objects and folders) stored in a specific container. :: + + aws mediastore-data describe-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path /folder_name/file1234.jpg + +Output:: + + { + "ContentType": "image/jpeg", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ContentLength": "2307346", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Viewing the Details of an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/get-container-policy.rst b/aws/dist/awscli/examples/mediastore/get-container-policy.rst new file mode 100644 index 00000000..231d9241 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/get-container-policy.rst @@ -0,0 +1,35 @@ +**To view a container policy** + +The following ``get-container-policy`` example displays the resource-based policy of the specified container. :: + + aws mediastore get-container-policy \ + --container-name ExampleLiveDemo + +Output:: + + { + "Policy": { + "Version": "2012-10-17", + "Statement": [ + { + "Sid": "PublicReadOverHttps", + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::111122223333:root" + }, + "Action": [ + "mediastore:GetObject", + "mediastore:DescribeObject" + ], + "Resource": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo/", + "Condition": { + "Bool": { + "aws:SecureTransport": "true" + } + } + } + ] + } + } + +For more information, see `Viewing a Container Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/get-cors-policy.rst b/aws/dist/awscli/examples/mediastore/get-cors-policy.rst new file mode 100644 index 00000000..7389a05b --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/get-cors-policy.rst @@ -0,0 +1,29 @@ +**To view a CORS policy** + +The following ``get-cors-policy`` example displays the cross-origin resource sharing (CORS) policy that is assigned to the specified container. :: + + aws mediastore get-cors-policy \ + --container-name ExampleContainer \ + --region us-west-2 + +Output:: + + { + "CorsPolicy": [ + { + "AllowedMethods": [ + "GET", + "HEAD" + ], + "MaxAgeSeconds": 3000, + "AllowedOrigins": [ + "" + ], + "AllowedHeaders": [ + "" + ] + } + ] + } + +For more information, see `Viewing a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/get-lifecycle-policy.rst b/aws/dist/awscli/examples/mediastore/get-lifecycle-policy.rst new file mode 100644 index 00000000..376207f8 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/get-lifecycle-policy.rst @@ -0,0 +1,38 @@ +**To view an object lifecycle policy** + +The following ``get-lifecycle-policy`` example displays the object lifecycle policy attached to the specified container. :: + + aws mediastore get-lifecycle-policy \ + --container-name LiveEvents + +Output:: + + { + "LifecyclePolicy": { + "rules": [ + { + "definition": { + "path": [ + { + "prefix": "Football/" + }, + { + "prefix": "Baseball/" + } + ], + "days_since_create": [ + { + "numeric": [ + ">", + 28 + ] + } + ] + }, + "action": "EXPIRE" + } + ] + } + } + +For more information, see `Viewing an Object Lifecycle Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/get-object.rst b/aws/dist/awscli/examples/mediastore/get-object.rst new file mode 100644 index 00000000..d77cbdbf --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/get-object.rst @@ -0,0 +1,39 @@ +**To download an object** + +The following ``get-object`` example download an object to the specified endpoint. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path=/folder_name/README.md README.md + +Output:: + + { + "ContentLength": "2307346", + "ContentType": "image/jpeg", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3", + "StatusCode": 200 + } + +**To download part of an object** + +The following ``get-object`` example downloads a portion an object to the specified endpoint. :: + + aws mediastore-data get-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --path /folder_name/README.md \ + --range="bytes=0-100" README2.md + +Output:: + + { + "StatusCode": 206, + "ContentRange": "bytes 0-100/2307346", + "ContentLength": "101", + "LastModified": "Fri, 19 Jul 2019 21:32:20 GMT", + "ContentType": "image/jpeg", + "ETag": "2aa333bbcc8d8d22d777e999c88d4aa9eeeeee4dd89ff7f555555555555da6d3" + } + +For more information, see `Downloading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/list-containers.rst b/aws/dist/awscli/examples/mediastore/list-containers.rst new file mode 100644 index 00000000..01c0c33b --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/list-containers.rst @@ -0,0 +1,30 @@ +**To view a list of containers** + +The following ``list-containers`` example displays a list of all containers that are associated with your account. :: + + aws mediastore list-containers + +Output:: + + { + "Containers": [ + { + "CreationTime": 1505317931, + "Endpoint": "https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com", + "Status": "ACTIVE", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleLiveDemo", + "AccessLoggingEnabled": false, + "Name": "ExampleLiveDemo" + }, + { + "CreationTime": 1506528818, + "Endpoint": "https://fffggghhhiiijj.data.mediastore.us-west-2.amazonaws.com", + "Status": "ACTIVE", + "ARN": "arn:aws:mediastore:us-west-2:111122223333:container/ExampleContainer", + "AccessLoggingEnabled": false, + "Name": "ExampleContainer" + } + ] + } + +For more information, see `Viewing a List of Containers `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/list-items.rst b/aws/dist/awscli/examples/mediastore/list-items.rst new file mode 100644 index 00000000..edfaf827 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/list-items.rst @@ -0,0 +1,53 @@ +**Example 1: To view a list of objects and folders in a specific container** + +The following ``list-items`` example displays items (objects and folders) stored in the specified container. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "ContentType": "image/jpeg", + "LastModified": 1563571859.379, + "Name": "filename.jpg", + "Type": "OBJECT", + "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", + "ContentLength": 3784 + }, + { + "Type": "FOLDER", + "Name": "ExampleLiveDemo" + } + ] + } + +**Example 2: To view a list of objects and folders in a specific folder** + +The following ``list-items`` example displays items (objects and folders) stored in a specific folder. :: + + aws mediastore-data list-items \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com + +Output:: + + { + "Items": [ + { + "ContentType": "image/jpeg", + "LastModified": 1563571859.379, + "Name": "filename.jpg", + "Type": "OBJECT", + "ETag": "543ab21abcd1a234ab123456a1a2b12345ab12abc12a1234abc1a2bc12345a12", + "ContentLength": 3784 + }, + { + "Type": "FOLDER", + "Name": "ExampleLiveDemo" + } + ] + } + +For more information, see `Viewing a List of Objects `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/list-tags-for-resource.rst b/aws/dist/awscli/examples/mediastore/list-tags-for-resource.rst new file mode 100644 index 00000000..4ff15286 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/list-tags-for-resource.rst @@ -0,0 +1,23 @@ +**To list tags for a container** + +The following ``list-tags-for-resource`` example displays the tag keys and values assigned to the specified container. :: + + aws mediastore list-tags-for-resource \ + --resource arn:aws:mediastore:us-west-2:1213456789012:container/ExampleContainer + +Output:: + + { + "Tags": [ + { + "Value": "Test", + "Key": "Environment" + }, + { + "Value": "West", + "Key": "Region" + } + ] + } + +For more information, see `ListTagsForResource `__ in the *AWS Elemental MediaStore API Reference*. diff --git a/aws/dist/awscli/examples/mediastore/put-container-policy.rst b/aws/dist/awscli/examples/mediastore/put-container-policy.rst new file mode 100644 index 00000000..2b0eb83b --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/put-container-policy.rst @@ -0,0 +1,11 @@ +**To edit a container policy** + +The following ``put-container-policy`` example assigns a different policy to the specified container. In this example, the updated policy is defined in a file named ``LiveEventsContainerPolicy.json``. :: + + aws mediastore put-container-policy \ + --container-name LiveEvents \ + --policy file://LiveEventsContainerPolicy.json + +This command produces no output. + +For more information, see `Editing a Container Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/put-cors-policy.rst b/aws/dist/awscli/examples/mediastore/put-cors-policy.rst new file mode 100644 index 00000000..a371ee33 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/put-cors-policy.rst @@ -0,0 +1,17 @@ +**Example 1: To add a CORS policy** + +The following ``put-cors-policy`` example adds a cross-origin resource sharing (CORS) policy to the specified container. The contents of the CORS policy are in the file named ``corsPolicy.json``. :: + + aws mediastore put-cors-policy \ + --container-name ExampleContainer \ + --cors-policy file://corsPolicy.json + +This command produces no output. + +For more information, see `Adding a CORS Policy to a Container `__ in the *AWS Elemental MediaStore User Guide*. + +**Example 2: To edit a CORS policy** + +The following ``put-cors-policy`` example updates the cross-origin resource sharing (CORS) policy that is assigned to the specified container. The contents of the updated CORS policy are in the file named ``corsPolicy2.json``. + +For more information, see `Editing a CORS Policy `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/put-lifecycle-policy.rst b/aws/dist/awscli/examples/mediastore/put-lifecycle-policy.rst new file mode 100644 index 00000000..a155493c --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/put-lifecycle-policy.rst @@ -0,0 +1,11 @@ +**To create an object lifecycle policy** + +The following ``put-lifecycle-policy`` example attaches an object lifecycle policy to the specified container. This enables you to specify how long the service should store objects in your container. MediaStore deletes objects in the container once they reach their expiration date, as indicated in the policy, which is in the file named ``LiveEventsLifecyclePolicy.json``. :: + + aws mediastore put-lifecycle-policy \ + --container-name ExampleContainer \ + --lifecycle-policy file://ExampleLifecyclePolicy.json + +This command produces no output. + +For more information, see `Adding an Object Lifecycle Policy to a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/put-object.rst b/aws/dist/awscli/examples/mediastore/put-object.rst new file mode 100644 index 00000000..7c47a7a2 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/put-object.rst @@ -0,0 +1,20 @@ +**To upload an object** + +The following ``put-object`` example uploads an object to the specified container. You can specify a folder path where the object will be saved within the container. If the folder already exists, AWS Elemental MediaStore stores the object in the folder. If the folder doesn't exist, the service creates it, and then stores the object in the folder. :: + + aws mediastore-data put-object \ + --endpoint https://aaabbbcccdddee.data.mediastore.us-west-2.amazonaws.com \ + --body README.md \ + --path /folder_name/README.md \ + --cache-control "max-age=6, public" \ + --content-type binary/octet-stream + +Output:: + + { + "ContentSHA256": "74b5fdb517f423ed750ef214c44adfe2be36e37d861eafe9c842cbe1bf387a9d", + "StorageClass": "TEMPORAL", + "ETag": "af3e4731af032167a106015d1f2fe934e68b32ed1aa297a9e325f5c64979277b" + } + +For more information, see `Uploading an Object `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/start-access-logging.rst b/aws/dist/awscli/examples/mediastore/start-access-logging.rst new file mode 100644 index 00000000..0ab7e39c --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/start-access-logging.rst @@ -0,0 +1,10 @@ +**To enable access logging on a container** + +The following ``start-access-logging`` example enable access logging on the specified container. :: + + aws mediastore start-access-logging \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Enabling Access Logging for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/stop-access-logging.rst b/aws/dist/awscli/examples/mediastore/stop-access-logging.rst new file mode 100644 index 00000000..876edd2b --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/stop-access-logging.rst @@ -0,0 +1,10 @@ +**To disable access logging on a container** + +The following ``stop-access-logging`` example disables access logging on the specified container. :: + + aws mediastore stop-access-logging \ + --container-name LiveEvents + +This command produces no output. + +For more information, see `Disabling Access Logging for a Container `__ in the *AWS Elemental MediaStore User Guide*. diff --git a/aws/dist/awscli/examples/mediastore/tag-resource.rst b/aws/dist/awscli/examples/mediastore/tag-resource.rst new file mode 100644 index 00000000..eedcd780 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/tag-resource.rst @@ -0,0 +1,11 @@ +**To add tags to a container** + +The following ``tag-resource`` example adds tag keys and values to the specified container. :: + + aws mediastore tag-resource \ + --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ + --tags '[{"Key": "Region", "Value": "West"}, {"Key": "Environment", "Value": "Test"}]' + +This command produces no output. + +For more information, see `TagResource `__ in the *AWS Elemental MediaStore API Reference*. diff --git a/aws/dist/awscli/examples/mediastore/untag-resource.rst b/aws/dist/awscli/examples/mediastore/untag-resource.rst new file mode 100644 index 00000000..a67fba56 --- /dev/null +++ b/aws/dist/awscli/examples/mediastore/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from a container** + +The following ``untag-resource`` example removes the specified tag key and its associated value from a container. :: + + aws mediastore untag-resource \ + --resource arn:aws:mediastore:us-west-2:123456789012:container/ExampleContainer \ + --tag-keys Region + +This command produces no output. + +For more information, see `UntagResource `__ in the *AWS Elemental MediaStore API Reference.*. diff --git a/aws/dist/awscli/examples/opsworks/assign-instance.rst b/aws/dist/awscli/examples/opsworks/assign-instance.rst new file mode 100644 index 00000000..5f4ddf9c --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/assign-instance.rst @@ -0,0 +1,14 @@ +**To assign a registered instance to a layer** + +The following example assigns a registered instance to a custom layer. :: + + aws opsworks --region us-east-1 assign-instance --instance-id 4d6d1710-ded9-42a1-b08e-b043ad7af1e2 --layer-ids 26cf1d32-6876-42fa-bbf1-9cadc0bff938 + +*Output*: None. + +**More Information** + +For more information, see `Assigning a Registered Instance to a Layer`_ in the *AWS OpsWorks User Guide*. + +.. _`Assigning a Registered Instance to a Layer`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-assign.html + diff --git a/aws/dist/awscli/examples/opsworks/assign-volume.rst b/aws/dist/awscli/examples/opsworks/assign-volume.rst new file mode 100644 index 00000000..5e4710be --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/assign-volume.rst @@ -0,0 +1,17 @@ +**To assign a registered volume to an instance** + +The following example assigns a registered Amazon Elastic Block Store (Amazon EBS) volume to an instance. +The volume is identified by its volume ID, which is the GUID that AWS OpsWorks assigns when +you register the volume with a stack, not the Amazon Elastic Compute Cloud (Amazon EC2) volume ID. +Before you run ``assign-volume``, you must first run ``update-volume`` to assign a mount point to the volume. :: + + aws opsworks --region us-east-1 assign-volume --instance-id 4d6d1710-ded9-42a1-b08e-b043ad7af1e2 --volume-id 26cf1d32-6876-42fa-bbf1-9cadc0bff938 + +*Output*: None. + +**More Information** + +For more information, see `Assigning Amazon EBS Volumes to an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Assigning Amazon EBS Volumes to an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-attach.html#resources-attach-ebs + diff --git a/aws/dist/awscli/examples/opsworks/associate-elastic-ip.rst b/aws/dist/awscli/examples/opsworks/associate-elastic-ip.rst new file mode 100644 index 00000000..d139fda6 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/associate-elastic-ip.rst @@ -0,0 +1,14 @@ +**To associate an Elastic IP address with an instance** + +The following example associates an Elastic IP address with a specified instance. :: + + aws opsworks --region us-east-1 associate-elastic-ip --instance-id dfe18b02-5327-493d-91a4-c5c0c448927f --elastic-ip 54.148.130.96 + +*Output*: None. + +**More Information** + +For more information, see `Resource Management`_ in the *AWS OpsWorks User Guide*. + +.. _`Resource Management`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html + diff --git a/aws/dist/awscli/examples/opsworks/attach-elastic-load-balancer.rst b/aws/dist/awscli/examples/opsworks/attach-elastic-load-balancer.rst new file mode 100644 index 00000000..49bce5f8 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/attach-elastic-load-balancer.rst @@ -0,0 +1,14 @@ +**To attach a load balancer to a layer** + +The following example attaches a load balancer, identified by its name, to a specified layer. :: + + aws opsworks --region us-east-1 attach-elastic-load-balancer --elastic-load-balancer-name Java-LB --layer-id 888c5645-09a5-4d0e-95a8-812ef1db76a4 + +*Output*: None. + +**More Information** + +For more information, see `Elastic Load Balancing`_ in the *AWS OpsWorks User Guide*. + +.. _`Elastic Load Balancing`: http://docs.aws.amazon.com/opsworks/latest/userguide/load-balancer-elb.html + diff --git a/aws/dist/awscli/examples/opsworks/create-app.rst b/aws/dist/awscli/examples/opsworks/create-app.rst new file mode 100644 index 00000000..0489c5a2 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-app.rst @@ -0,0 +1,53 @@ +**To create an app** + +The following example creates a PHP app named SimplePHPApp from code stored in a GitHub repository. +The command uses the shorthand form of the application source definition. :: + + aws opsworks --region us-east-1 create-app --stack-id f6673d70-32e6-4425-8999-265dd002fec7 --name SimplePHPApp --type php --app-source Type=git,Url=git://github.com/amazonwebservices/opsworks-demo-php-simple-app.git,Revision=version1 + +*Output*:: + + { + "AppId": "6cf5163c-a951-444f-a8f7-3716be75f2a2" + } + +**To create an app with an attached database** + +The following example creates a JSP app from code stored in .zip archive in a public S3 bucket. +It attaches an RDS DB instance to serve as the app's data store. The application and database sources are defined in separate +JSON files that are in the directory from which you run the command. :: + + aws opsworks --region us-east-1 create-app --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 --name SimpleJSP --type java --app-source file://appsource.json --data-sources file://datasource.json + +The application source information is in ``appsource.json`` and contains the following. :: + + { + "Type": "archive", + "Url": "https://s3.amazonaws.com/jsp_example/simplejsp.zip" + } + +The database source information is in ``datasource.json`` and contains the following. :: + + [ + { + "Type": "RdsDbInstance", + "Arn": "arn:aws:rds:us-west-2:123456789012:db:clitestdb", + "DatabaseName": "mydb" + } + ] + +**Note**: For an RDS DB instance, you must first use ``register-rds-db-instance`` to register the instance with the stack. +For MySQL App Server instances, set ``Type`` to ``OpsworksMysqlInstance``. These instances are +created by AWS OpsWorks, +so they do not have to be registered. + +*Output*:: + + { + "AppId": "26a61ead-d201-47e3-b55c-2a7c666942f8" + } + +For more information, see `Adding Apps`_ in the *AWS OpsWorks User Guide*. + +.. _`Adding Apps`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html + diff --git a/aws/dist/awscli/examples/opsworks/create-deployment.rst b/aws/dist/awscli/examples/opsworks/create-deployment.rst new file mode 100644 index 00000000..4fb916e8 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-deployment.rst @@ -0,0 +1,66 @@ +**Example 1: To deploy apps and run stack commands** + +The following examples show how to use the ``create-deployment`` command to deploy apps and run stack commands. Notice that the quote (``"``) characters in the JSON object that specifies the command are all preceded by escape characters (\\). Without the escape characters, the command might return an invalid JSON error. + +The following ``create-deployment`` example deploys an app to a specified stack. :: + + aws opsworks create-deployment \ + --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \ + --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb + --command "{\"Name\":\"deploy\"}" + +Output:: + + { + "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" + } + +**Example 2: To deploy a Rails App and Migrate the Database** + +The following ``create-deployment`` command deploys a Ruby on Rails app to a specified stack and migrates the database. :: + + aws opsworks create-deployment \ + --stack-id cfb7e082-ad1d-4599-8e81-de1c39ab45bf \ + --app-id 307be5c8-d55d-47b5-bd6e-7bd417c6c7eb \ + --command "{\"Name\":\"deploy\", \"Args\":{\"migrate\":[\"true\"]}}" + +Output:: + + { + "DeploymentId": "5746c781-df7f-4c87-84a7-65a119880560" + } + +For more information on deployment, see `Deploying Apps `__ in the *AWS OpsWorks User Guide*. + +**Example 3: Run a Recipe** + +The following ``create-deployment`` command runs a custom recipe, ``phpapp::appsetup``, on the instances in a specified stack. :: + + aws opsworks create-deployment \ + --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \ + --command "{\"Name\":\"execute_recipes\", \"Args\":{\"recipes\":[\"phpapp::appsetup\"]}}" + +Output:: + + { + "DeploymentId": "5cbaa7b9-4e09-4e53-aa1b-314fbd106038" + } + +For more information, see `Run Stack Commands `__ in the *AWS OpsWorks User Guide*. + +**Example 4: Install Dependencies** + +The following ``create-deployment`` command installs dependencies, such as packages or Ruby gems, on the instances in a +specified stack. :: + + aws opsworks create-deployment \ + --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb \ + --command "{\"Name\":\"install_dependencies\"}" + +Output:: + + { + "DeploymentId": "aef5b255-8604-4928-81b3-9b0187f962ff" + } + +For more information, see `Run Stack Commands `__ in the *AWS OpsWorks User Guide*. diff --git a/aws/dist/awscli/examples/opsworks/create-instance.rst b/aws/dist/awscli/examples/opsworks/create-instance.rst new file mode 100644 index 00000000..d309cca4 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-instance.rst @@ -0,0 +1,25 @@ +**To create an instance** + +The following ``create-instance`` command creates an m1.large Amazon Linux instance named myinstance1 in a specified stack. +The instance is assigned to one layer. :: + + aws opsworks --region us-east-1 create-instance --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --layer-ids 5c8c272a-f2d5-42e3-8245-5bf3927cb65b --hostname myinstance1 --instance-type m1.large --os "Amazon Linux" + +To use an autogenerated name, call `get-hostname-suggestion`_, which generates +a hostname based on the theme that you specified when you created the stack. +Then pass that name to the `hostname` argument. + +.. _get-hostname-suggestion: http://docs.aws.amazon.com/cli/latest/reference/opsworks/get-hostname-suggestion.html + +*Output*:: + + { + "InstanceId": "5f9adeaa-c94c-42c6-aeef-28a5376002cd" + } + +**More Information** + +For more information, see `Adding an Instance to a Layer`_ in the *AWS OpsWorks User Guide*. + +.. _`Adding an Instance to a Layer`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html + diff --git a/aws/dist/awscli/examples/opsworks/create-layer.rst b/aws/dist/awscli/examples/opsworks/create-layer.rst new file mode 100644 index 00000000..e81e4a48 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-layer.rst @@ -0,0 +1,17 @@ +**To create a layer** + +The following ``create-layer`` command creates a PHP App Server layer named MyPHPLayer in a specified stack. :: + + aws opsworks create-layer --region us-east-1 --stack-id f6673d70-32e6-4425-8999-265dd002fec7 --type php-app --name MyPHPLayer --shortname myphplayer + +*Output*:: + + { + "LayerId": "0b212672-6b4b-40e4-8a34-5a943cf2e07a" + } + +**More Information** + +For more information, see `How to Create a Layer`_ in the *AWS OpsWorks User Guide*. + +.. _`How to Create a Layer`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html diff --git a/aws/dist/awscli/examples/opsworks/create-stack.rst b/aws/dist/awscli/examples/opsworks/create-stack.rst new file mode 100644 index 00000000..d923887f --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-stack.rst @@ -0,0 +1,25 @@ +**To create a stack** + +The following ``create-stack`` command creates a stack named CLI Stack. :: + + aws opsworks create-stack --name "CLI Stack" --stack-region "us-east-1" --service-role-arn arn:aws:iam::123456789012:role/aws-opsworks-service-role --default-instance-profile-arn arn:aws:iam::123456789012:instance-profile/aws-opsworks-ec2-role --region us-east-1 + +The ``service-role-arn`` and ``default-instance-profile-arn`` parameters are required. You typically +use the ones that AWS OpsWorks +creates for you when you create your first stack. To get the Amazon Resource Names (ARNs) for your +account, go to the `IAM console`_, choose ``Roles`` in the navigation panel, +choose the role or profile, and choose the ``Summary`` tab. + +.. _`IAM console`: https://console.aws.amazon.com/iam/home + +*Output*:: + + { + "StackId": "f6673d70-32e6-4425-8999-265dd002fec7" + } + +**More Information** + +For more information, see `Create a New Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Create a New Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html diff --git a/aws/dist/awscli/examples/opsworks/create-user-profile.rst b/aws/dist/awscli/examples/opsworks/create-user-profile.rst new file mode 100644 index 00000000..27317ecc --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/create-user-profile.rst @@ -0,0 +1,24 @@ +**To create a user profile** + +You import an AWS Identity and Access Manager (IAM) user into AWS OpsWorks by calling `create-user-profile` to create a user profile. +The following example creates a user profile for the cli-user-test IAM user, who +is identified by Amazon Resource Name (ARN). The example assigns the user an SSH username of ``myusername`` and enables self management, +which allows the user to specify an SSH public key. :: + + aws opsworks --region us-east-1 create-user-profile --iam-user-arn arn:aws:iam::123456789102:user/cli-user-test --ssh-username myusername --allow-self-management + +*Output*:: + + { + "IamUserArn": "arn:aws:iam::123456789102:user/cli-user-test" + } + +**Tip**: This command imports an IAM user into AWS OpsWorks, but only with the permissions that are +granted by the attached policies. You can grant per-stack AWS OpsWorks permissions by using the ``set-permissions`` command. + +**More Information** + +For more information, see `Importing Users into AWS OpsWorks`_ in the *AWS OpsWorks User Guide*. + +.. _`Importing Users into AWS OpsWorks`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-manage-import.html + diff --git a/aws/dist/awscli/examples/opsworks/delete-app.rst b/aws/dist/awscli/examples/opsworks/delete-app.rst new file mode 100644 index 00000000..44d1db69 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/delete-app.rst @@ -0,0 +1,17 @@ +**To delete an app** + +The following example deletes a specified app, which is identified by its app ID. +You can obtain an app ID by going to the app's details page on the AWS OpsWorks console or by +running the ``describe-apps`` command. :: + + aws opsworks delete-app --region us-east-1 --app-id 577943b9-2ec1-4baf-a7bf-1d347601edc5 + +*Output*: None. + +**More Information** + +For more information, see `Apps`_ in the *AWS OpsWorks User Guide*. + +.. _`Apps`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps.html + + diff --git a/aws/dist/awscli/examples/opsworks/delete-instance.rst b/aws/dist/awscli/examples/opsworks/delete-instance.rst new file mode 100644 index 00000000..c69260b1 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/delete-instance.rst @@ -0,0 +1,24 @@ +**To delete an instance** + +The following example deletes a specified instance, which is identified by its instance ID. +It also deletes any attached Amazon Elastic Block Store (Amazon EBS) volumes or Elastic IP addresses. +You can obtain an instance ID by going to the instance's details page on the AWS OpsWorks console or by +running the ``describe-instances`` command. + +If the instance is online, you must first stop the instance by calling ``stop-instance``, and then +wait until the instance has stopped. You can use ``describe-instances`` to check the instance status. :: + + aws opsworks delete-instance --region us-east-1 --instance-id 3a21cfac-4a1f-4ce2-a921-b2cfba6f7771 + +To retain the instance's Amazon EBS volumes or Elastic IP addresses, +use the ``--no-delete-volumes`` or ``--no-delete-elastic-ip`` arguments, respectively. + +*Output*: None. + +**More Information** + +For more information, see `Deleting AWS OpsWorks Instances`_ in the *AWS OpsWorks User Guide*. + +.. _`Deleting AWS OpsWorks Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html + + diff --git a/aws/dist/awscli/examples/opsworks/delete-layer.rst b/aws/dist/awscli/examples/opsworks/delete-layer.rst new file mode 100644 index 00000000..4803eccd --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/delete-layer.rst @@ -0,0 +1,17 @@ +**To delete a layer** + +The following example deletes a specified layer, which is identified by its layer ID. +You can obtain a layer ID by going to the layer's details page on the AWS OpsWorks console or by +running the ``describe-layers`` command. + +**Note:** Before deleting a layer, you must use ``delete-instance`` to delete all of the layer's instances. :: + + aws opsworks delete-layer --region us-east-1 --layer-id a919454e-b816-4598-b29a-5796afb498ed + +*Output*: None. + +**More Information** + +For more information, see `Deleting AWS OpsWorks Instances`_ in the *AWS OpsWorks User Guide*. + +.. _`Deleting AWS OpsWorks Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html diff --git a/aws/dist/awscli/examples/opsworks/delete-stack.rst b/aws/dist/awscli/examples/opsworks/delete-stack.rst new file mode 100644 index 00000000..f881b303 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/delete-stack.rst @@ -0,0 +1,18 @@ +**To delete a stack** + +The following example deletes a specified stack, which is identified by its stack ID. +You can obtain a stack ID by clicking **Stack Settings** on the AWS OpsWorks console or by +running the ``describe-stacks`` command. + +**Note:** Before deleting a layer, you must use ``delete-app``, ``delete-instance``, and ``delete-layer`` +to delete all of the stack's apps, instances, and layers. :: + + aws opsworks delete-stack --region us-east-1 --stack-id 154a9d89-7e9e-433b-8de8-617e53756c84 + +*Output*: None. + +**More Information** + +For more information, see `Shut Down a Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Shut Down a Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html diff --git a/aws/dist/awscli/examples/opsworks/delete-user-profile.rst b/aws/dist/awscli/examples/opsworks/delete-user-profile.rst new file mode 100644 index 00000000..b3028aa6 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/delete-user-profile.rst @@ -0,0 +1,17 @@ +**To delete a user profile and remove an IAM user from AWS OpsWorks** + +The following example deletes the user profile for a specified AWS Identity and Access Management +(IAM) user, who +is identified by Amazon Resource Name (ARN). The operation removes the user from AWS OpsWorks, but +does not delete the IAM user. You must use the IAM console, CLI, or API for that task. :: + + aws opsworks --region us-east-1 delete-user-profile --iam-user-arn arn:aws:iam::123456789102:user/cli-user-test + +*Output*: None. + +**More Information** + +For more information, see `Importing Users into AWS OpsWorks`_ in the *AWS OpsWorks User Guide*. + +.. _`Importing Users into AWS OpsWorks`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-manage-import.html + diff --git a/aws/dist/awscli/examples/opsworks/deregister-elastic-ip.rst b/aws/dist/awscli/examples/opsworks/deregister-elastic-ip.rst new file mode 100644 index 00000000..ff70b6c7 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/deregister-elastic-ip.rst @@ -0,0 +1,13 @@ +**To deregister an Elastic IP address from a stack** + +The following example deregisters an Elastic IP address, identified by its IP address, from its stack. :: + + aws opsworks deregister-elastic-ip --region us-east-1 --elastic-ip 54.148.130.96 + +*Output*: None. + +**More Information** + +For more information, see `Deregistering Elastic IP Addresses`_ in the *AWS OpsWorks User Guide*. + +.. _`Deregistering Elastic IP Addresses`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-dereg.html#resources-dereg-eip diff --git a/aws/dist/awscli/examples/opsworks/deregister-instance.rst b/aws/dist/awscli/examples/opsworks/deregister-instance.rst new file mode 100644 index 00000000..8c9d1007 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/deregister-instance.rst @@ -0,0 +1,14 @@ +**To deregister a registered instance from a stack** + +The following ``deregister-instance`` command deregisters a registered instance from its stack. :: + + aws opsworks --region us-east-1 deregister-instance --instance-id 4d6d1710-ded9-42a1-b08e-b043ad7af1e2 + +*Output*: None. + +**More Information** + +For more information, see `Deregistering a Registered Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Deregistering a Registered Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-unassign.html + diff --git a/aws/dist/awscli/examples/opsworks/deregister-rds-db-instance.rst b/aws/dist/awscli/examples/opsworks/deregister-rds-db-instance.rst new file mode 100644 index 00000000..55a27eef --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/deregister-rds-db-instance.rst @@ -0,0 +1,20 @@ +**To deregister an Amazon RDS DB instance from a stack** + +The following example deregisters an RDS DB instance, identified by its ARN, from its stack. :: + + aws opsworks deregister-rds-db-instance --region us-east-1 --rds-db-instance-arn arn:aws:rds:us-west-2:123456789012:db:clitestdb + +*Output*: None. + +**More Information** + +For more information, see `Deregistering Amazon RDS Instances`_ in the *ASW OpsWorks User Guide*. + +.. _`Deregistering Amazon RDS Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-dereg.html#resources-dereg-rds + + +.. instance ID: clitestdb + Master usernams: cliuser + Master PWD: some23!pwd + DB Name: mydb + aws opsworks deregister-rds-db-instance --region us-east-1 --rds-db-instance-arn arn:aws:rds:us-west-2:645732743964:db:clitestdb \ No newline at end of file diff --git a/aws/dist/awscli/examples/opsworks/deregister-volume.rst b/aws/dist/awscli/examples/opsworks/deregister-volume.rst new file mode 100644 index 00000000..ac588d9b --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/deregister-volume.rst @@ -0,0 +1,15 @@ +**To deregister an Amazon EBS volume** + +The following example deregisters an EBS volume from its stack. +The volume is identified by its volume ID, which is the GUID that AWS OpsWorks assigned when +you registered the volume with the stack, not the EC2 volume ID. :: + + aws opsworks deregister-volume --region us-east-1 --volume-id 5c48ef52-3144-4bf5-beaa-fda4deb23d4d + +*Output*: None. + +**More Information** + +For more information, see `Deregistering Amazon EBS Volumes`_ in the *AWS OpsWorks User Guide*. + +.. _`Deregistering Amazon EBS Volumes`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-dereg.html#resources-dereg-ebs diff --git a/aws/dist/awscli/examples/opsworks/describe-apps.rst b/aws/dist/awscli/examples/opsworks/describe-apps.rst new file mode 100644 index 00000000..67ffc196 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-apps.rst @@ -0,0 +1,40 @@ +**To describe apps** + +The following ``describe-apps`` command describes the apps in a specified stack. :: + + aws opsworks --region us-east-1 describe-apps --stack-id 38ee91e2-abdc-4208-a107-0b7168b3cc7a + +*Output*: This particular stack has one app. + +:: + + { + "Apps": [ + { + "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", + "AppSource": { + "Url": "https://s3-us-west-2.amazonaws.com/opsworks-tomcat/simplejsp.zip", + "Type": "archive" + }, + "Name": "SimpleJSP", + "EnableSsl": false, + "SslConfiguration": {}, + "AppId": "da1decc1-0dff-43ea-ad7c-bb667cd87c8b", + "Attributes": { + "RailsEnv": null, + "AutoBundleOnDeploy": "true", + "DocumentRoot": "ROOT" + }, + "Shortname": "simplejsp", + "Type": "other", + "CreatedAt": "2013-08-01T21:46:54+00:00" + } + ] + } + +**More Information** + +For more information, see Apps_ in the *AWS OpsWorks User Guide*. + +.. _Apps: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-commands.rst b/aws/dist/awscli/examples/opsworks/describe-commands.rst new file mode 100644 index 00000000..34ba0773 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-commands.rst @@ -0,0 +1,43 @@ +**To describe commands** + +The following ``describe-commands`` commmand describes the commands in a specified instance. :: + + aws opsworks --region us-east-1 describe-commands --instance-id 8c2673b9-3fe5-420d-9cfa-78d875ee7687 + +*Output*:: + + { + "Commands": [ + { + "Status": "successful", + "CompletedAt": "2013-07-25T18:57:47+00:00", + "InstanceId": "8c2673b9-3fe5-420d-9cfa-78d875ee7687", + "DeploymentId": "6ed0df4c-9ef7-4812-8dac-d54a05be1029", + "AcknowledgedAt": "2013-07-25T18:57:41+00:00", + "LogUrl": "https://s3.amazonaws.com/prod_stage-log/logs/008c1a91-ec59-4d51-971d-3adff54b00cc?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE &Expires=1375394373&Signature=HkXil6UuNfxTCC37EPQAa462E1E%3D&response-cache-control=private&response-content-encoding=gzip&response-content- type=text%2Fplain", + "Type": "undeploy", + "CommandId": "008c1a91-ec59-4d51-971d-3adff54b00cc", + "CreatedAt": "2013-07-25T18:57:34+00:00", + "ExitCode": 0 + }, + { + "Status": "successful", + "CompletedAt": "2013-07-25T18:55:40+00:00", + "InstanceId": "8c2673b9-3fe5-420d-9cfa-78d875ee7687", + "DeploymentId": "19d3121e-d949-4ff2-9f9d-94eac087862a", + "AcknowledgedAt": "2013-07-25T18:55:32+00:00", + "LogUrl": "https://s3.amazonaws.com/prod_stage-log/logs/899d3d64-0384-47b6-a586-33433aad117c?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE &Expires=1375394373&Signature=xMsJvtLuUqWmsr8s%2FAjVru0BtRs%3D&response-cache-control=private&response-content-encoding=gzip&response-conten t-type=text%2Fplain", + "Type": "deploy", + "CommandId": "899d3d64-0384-47b6-a586-33433aad117c", + "CreatedAt": "2013-07-25T18:55:29+00:00", + "ExitCode": 0 + } + ] + } + +**More Information** + +For more information, see `AWS OpsWorks Lifecycle Events`_ in the *AWS OpsWorks User Guide*. + +.. _`AWS OpsWorks Lifecycle Events`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-events.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-deployments.rst b/aws/dist/awscli/examples/opsworks/describe-deployments.rst new file mode 100644 index 00000000..f1c0dc57 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-deployments.rst @@ -0,0 +1,52 @@ +**To describe deployments** + +The following ``describe-deployments`` commmand describes the deployments in a specified stack. :: + + aws opsworks --region us-east-1 describe-deployments --stack-id 38ee91e2-abdc-4208-a107-0b7168b3cc7a + +*Output*:: + + { + "Deployments": [ + { + "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", + "Status": "successful", + "CompletedAt": "2013-07-25T18:57:49+00:00", + "DeploymentId": "6ed0df4c-9ef7-4812-8dac-d54a05be1029", + "Command": { + "Args": {}, + "Name": "undeploy" + }, + "CreatedAt": "2013-07-25T18:57:34+00:00", + "Duration": 15, + "InstanceIds": [ + "8c2673b9-3fe5-420d-9cfa-78d875ee7687", + "9e588a25-35b2-4804-bd43-488f85ebe5b7" + ] + }, + { + "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", + "Status": "successful", + "CompletedAt": "2013-07-25T18:56:41+00:00", + "IamUserArn": "arn:aws:iam::123456789012:user/someuser", + "DeploymentId": "19d3121e-d949-4ff2-9f9d-94eac087862a", + "Command": { + "Args": {}, + "Name": "deploy" + }, + "InstanceIds": [ + "8c2673b9-3fe5-420d-9cfa-78d875ee7687", + "9e588a25-35b2-4804-bd43-488f85ebe5b7" + ], + "Duration": 72, + "CreatedAt": "2013-07-25T18:55:29+00:00" + } + ] + } + +**More Information** + +For more information, see `Deploying Apps`_ in the *AWS OpsWorks User Guide*. + +.. _`Deploying Apps`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-elastic-ips.rst b/aws/dist/awscli/examples/opsworks/describe-elastic-ips.rst new file mode 100644 index 00000000..277da76e --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-elastic-ips.rst @@ -0,0 +1,24 @@ +**To describe Elastic IP instances** + +The following ``describe-elastic-ips`` commmand describes the Elastic IP addresses in a specified instance. :: + + aws opsworks --region us-east-1 describe-elastic-ips --instance-id b62f3e04-e9eb-436c-a91f-d9e9a396b7b0 + +*Output*:: + + { + "ElasticIps": [ + { + "Ip": "192.0.2.0", + "Domain": "standard", + "Region": "us-west-2" + } + ] + } + +**More Information** + +For more information, see Instances_ in the *AWS OpsWorks User Guide*. + +.. _Instances: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-elastic-load-balancers.rst b/aws/dist/awscli/examples/opsworks/describe-elastic-load-balancers.rst new file mode 100644 index 00000000..1a20c1c1 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-elastic-load-balancers.rst @@ -0,0 +1,37 @@ +**To describe a stack's elastic load balancers** + +The following ``describe-elastic-load-balancers`` command describes a specified stack's load balancers. :: + + aws opsworks --region us-west-2 describe-elastic-load-balancers --stack-id 6f4660e5-37a6-4e42-bfa0-1358ebd9c182 + +*Output*: This particular stack has one load balancer. + +:: + + { + "ElasticLoadBalancers": [ + { + "SubnetIds": [ + "subnet-60e4ea04", + "subnet-66e1c110" + ], + "Ec2InstanceIds": [], + "ElasticLoadBalancerName": "my-balancer", + "Region": "us-west-2", + "LayerId": "344973cb-bf2b-4cd0-8d93-51cd819bab04", + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ], + "VpcId": "vpc-b319f9d4", + "StackId": "6f4660e5-37a6-4e42-bfa0-1358ebd9c182", + "DnsName": "my-balancer-2094040179.us-west-2.elb.amazonaws.com" + } + ] + } + +**More Information** + +For more information, see Apps_ in the *AWS OpsWorks User Guide*. + +.. _Apps: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps.html diff --git a/aws/dist/awscli/examples/opsworks/describe-instances.rst b/aws/dist/awscli/examples/opsworks/describe-instances.rst new file mode 100644 index 00000000..213e1355 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-instances.rst @@ -0,0 +1,95 @@ +**To describe instances** + +The following ``describe-instances`` commmand describes the instances in a specified stack:: + + aws opsworks --region us-east-1 describe-instances --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 + +*Output*: The following output example is for a stack with two instances. The first is a registered +EC2 instance, and the second was created by AWS OpsWorks. + +:: + + { + "Instances": [ + { + "StackId": "71c7ca72-55ae-4b6a-8ee1-a8dcded3fa0f", + "PrivateDns": "ip-10-31-39-66.us-west-2.compute.internal", + "LayerIds": [ + "26cf1d32-6876-42fa-bbf1-9cadc0bff938" + ], + "EbsOptimized": false, + "ReportedOs": { + "Version": "14.04", + "Name": "ubuntu", + "Family": "debian" + }, + "Status": "online", + "InstanceId": "4d6d1710-ded9-42a1-b08e-b043ad7af1e2", + "SshKeyName": "US-West-2", + "InfrastructureClass": "ec2", + "RootDeviceVolumeId": "vol-d08ec6c1", + "SubnetId": "subnet-b8de0ddd", + "InstanceType": "t1.micro", + "CreatedAt": "2015-02-24T20:52:49+00:00", + "AmiId": "ami-35501205", + "Hostname": "ip-192-0-2-0", + "Ec2InstanceId": "i-5cd23551", + "PublicDns": "ec2-192-0-2-0.us-west-2.compute.amazonaws.com", + "SecurityGroupIds": [ + "sg-c4d3f0a1" + ], + "Architecture": "x86_64", + "RootDeviceType": "ebs", + "InstallUpdatesOnBoot": true, + "Os": "Custom", + "VirtualizationType": "paravirtual", + "AvailabilityZone": "us-west-2a", + "PrivateIp": "10.31.39.66", + "PublicIp": "192.0.2.06", + "RegisteredBy": "arn:aws:iam::123456789102:user/AWS/OpsWorks/OpsWorks-EC2Register-i-5cd23551" + }, + { + "StackId": "71c7ca72-55ae-4b6a-8ee1-a8dcded3fa0f", + "PrivateDns": "ip-10-31-39-158.us-west-2.compute.internal", + "SshHostRsaKeyFingerprint": "69:6b:7b:8b:72:f3:ed:23:01:00:05:bc:9f:a4:60:c1", + "LayerIds": [ + "26cf1d32-6876-42fa-bbf1-9cadc0bff938" + ], + "EbsOptimized": false, + "ReportedOs": {}, + "Status": "booting", + "InstanceId": "9b137a0d-2f5d-4cc0-9704-13da4b31fdcb", + "SshKeyName": "US-West-2", + "InfrastructureClass": "ec2", + "RootDeviceVolumeId": "vol-e09dd5f1", + "SubnetId": "subnet-b8de0ddd", + "InstanceProfileArn": "arn:aws:iam::123456789102:instance-profile/aws-opsworks-ec2-role", + "InstanceType": "c3.large", + "CreatedAt": "2015-02-24T21:29:33+00:00", + "AmiId": "ami-9fc29baf", + "SshHostDsaKeyFingerprint": "fc:87:95:c3:f5:e1:3b:9f:d2:06:6e:62:9a:35:27:e8", + "Ec2InstanceId": "i-8d2dca80", + "PublicDns": "ec2-192-0-2-1.us-west-2.compute.amazonaws.com", + "SecurityGroupIds": [ + "sg-b022add5", + "sg-b122add4" + ], + "Architecture": "x86_64", + "RootDeviceType": "ebs", + "InstallUpdatesOnBoot": true, + "Os": "Amazon Linux 2014.09", + "VirtualizationType": "paravirtual", + "AvailabilityZone": "us-west-2a", + "Hostname": "custom11", + "PrivateIp": "10.31.39.158", + "PublicIp": "192.0.2.0" + } + ] + } + +**More Information** + +For more information, see `Instances`_ in the *AWS OpsWorks User Guide*. + +.. _`Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-layers.rst b/aws/dist/awscli/examples/opsworks/describe-layers.rst new file mode 100644 index 00000000..d45a3bdc --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-layers.rst @@ -0,0 +1,171 @@ +**To describe a stack's layers** + +The following ``describe-layers`` commmand describes the layers in a specified stack:: + + aws opsworks --region us-east-1 describe-layers --stack-id 38ee91e2-abdc-4208-a107-0b7168b3cc7a + +*Output*:: + + { + "Layers": [ + { + "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", + "Type": "db-master", + "DefaultSecurityGroupNames": [ + "AWS-OpsWorks-DB-Master-Server" + ], + "Name": "MySQL", + "Packages": [], + "DefaultRecipes": { + "Undeploy": [], + "Setup": [ + "opsworks_initial_setup", + "ssh_host_keys", + "ssh_users", + "mysql::client", + "dependencies", + "ebs", + "opsworks_ganglia::client", + "mysql::server", + "dependencies", + "deploy::mysql" + ], + "Configure": [ + "opsworks_ganglia::configure-client", + "ssh_users", + "agent_version", + "deploy::mysql" + ], + "Shutdown": [ + "opsworks_shutdown::default", + "mysql::stop" + ], + "Deploy": [ + "deploy::default", + "deploy::mysql" + ] + }, + "CustomRecipes": { + "Undeploy": [], + "Setup": [], + "Configure": [], + "Shutdown": [], + "Deploy": [] + }, + "EnableAutoHealing": false, + "LayerId": "41a20847-d594-4325-8447-171821916b73", + "Attributes": { + "MysqlRootPasswordUbiquitous": "true", + "RubygemsVersion": null, + "RailsStack": null, + "HaproxyHealthCheckMethod": null, + "RubyVersion": null, + "BundlerVersion": null, + "HaproxyStatsPassword": null, + "PassengerVersion": null, + "MemcachedMemory": null, + "EnableHaproxyStats": null, + "ManageBundler": null, + "NodejsVersion": null, + "HaproxyHealthCheckUrl": null, + "MysqlRootPassword": "*****FILTERED*****", + "GangliaPassword": null, + "GangliaUser": null, + "HaproxyStatsUrl": null, + "GangliaUrl": null, + "HaproxyStatsUser": null + }, + "Shortname": "db-master", + "AutoAssignElasticIps": false, + "CustomSecurityGroupIds": [], + "CreatedAt": "2013-07-25T18:11:19+00:00", + "VolumeConfigurations": [ + { + "MountPoint": "/vol/mysql", + "Size": 10, + "NumberOfDisks": 1 + } + ] + }, + { + "StackId": "38ee91e2-abdc-4208-a107-0b7168b3cc7a", + "Type": "custom", + "DefaultSecurityGroupNames": [ + "AWS-OpsWorks-Custom-Server" + ], + "Name": "TomCustom", + "Packages": [], + "DefaultRecipes": { + "Undeploy": [], + "Setup": [ + "opsworks_initial_setup", + "ssh_host_keys", + "ssh_users", + "mysql::client", + "dependencies", + "ebs", + "opsworks_ganglia::client" + ], + "Configure": [ + "opsworks_ganglia::configure-client", + "ssh_users", + "agent_version" + ], + "Shutdown": [ + "opsworks_shutdown::default" + ], + "Deploy": [ + "deploy::default" + ] + }, + "CustomRecipes": { + "Undeploy": [], + "Setup": [ + "tomcat::setup" + ], + "Configure": [ + "tomcat::configure" + ], + "Shutdown": [], + "Deploy": [ + "tomcat::deploy" + ] + }, + "EnableAutoHealing": true, + "LayerId": "e6cbcd29-d223-40fc-8243-2eb213377440", + "Attributes": { + "MysqlRootPasswordUbiquitous": null, + "RubygemsVersion": null, + "RailsStack": null, + "HaproxyHealthCheckMethod": null, + "RubyVersion": null, + "BundlerVersion": null, + "HaproxyStatsPassword": null, + "PassengerVersion": null, + "MemcachedMemory": null, + "EnableHaproxyStats": null, + "ManageBundler": null, + "NodejsVersion": null, + "HaproxyHealthCheckUrl": null, + "MysqlRootPassword": null, + "GangliaPassword": null, + "GangliaUser": null, + "HaproxyStatsUrl": null, + "GangliaUrl": null, + "HaproxyStatsUser": null + }, + "Shortname": "tomcustom", + "AutoAssignElasticIps": false, + "CustomSecurityGroupIds": [], + "CreatedAt": "2013-07-25T18:12:53+00:00", + "VolumeConfigurations": [] + } + ] + } + +**More Information** + +For more information, see Layers_ in the *AWS OpsWorks User Guide*. + +.. _Layers: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-load-based-auto-scaling.rst b/aws/dist/awscli/examples/opsworks/describe-load-based-auto-scaling.rst new file mode 100644 index 00000000..5a7643c2 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-load-based-auto-scaling.rst @@ -0,0 +1,37 @@ +**To describe a layer's load-based scaling configuration** + +The following example describes a specified layer's load-based scaling configuration. +The layer is identified by its layer ID, which you can find on the layer's +details page or by running ``describe-layers``. :: + + aws opsworks describe-load-based-auto-scaling --region us-east-1 --layer-ids 6bec29c9-c866-41a0-aba5-fa3e374ce2a1 + +*Output*: The example layer has a single load-based instance. :: + + { + "LoadBasedAutoScalingConfigurations": [ + { + "DownScaling": { + "IgnoreMetricsTime": 10, + "ThresholdsWaitTime": 10, + "InstanceCount": 1, + "CpuThreshold": 30.0 + }, + "Enable": true, + "UpScaling": { + "IgnoreMetricsTime": 5, + "ThresholdsWaitTime": 5, + "InstanceCount": 1, + "CpuThreshold": 80.0 + }, + "LayerId": "6bec29c9-c866-41a0-aba5-fa3e374ce2a1" + } + ] + } + + +**More Information** + +For more information, see `How Automatic Load-based Scaling Works`_ in the *AWS OpsWorks User Guide*. + +.. _`How Automatic Load-based Scaling Works`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html#workinginstances-autoscaling-loadbased diff --git a/aws/dist/awscli/examples/opsworks/describe-my-user-profile.rst b/aws/dist/awscli/examples/opsworks/describe-my-user-profile.rst new file mode 100644 index 00000000..d5b116d4 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-my-user-profile.rst @@ -0,0 +1,24 @@ +**To obtain a user's profile** + +The following example shows how to obtain the profile +of the AWS Identity and Access Management (IAM) user that is running the command. :: + + aws opsworks --region us-east-1 describe-my-user-profile + +*Output*: For brevity, most of the user's SSH public key is replaced by an ellipsis (...). :: + + { + "UserProfile": { + "IamUserArn": "arn:aws:iam::123456789012:user/myusername", + "SshPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQ...3LQ4aX9jpxQw== rsa-key-20141104", + "Name": "myusername", + "SshUsername": "myusername" + } + } + +**More Information** + +For more information, see `Importing Users into AWS OpsWorks`_ in the *AWS OpsWorks User Guide*. + +.. _`Importing Users into AWS OpsWorks`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-manage-import.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-permissions.rst b/aws/dist/awscli/examples/opsworks/describe-permissions.rst new file mode 100644 index 00000000..d17ade99 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-permissions.rst @@ -0,0 +1,26 @@ +**To obtain a user's per-stack AWS OpsWorks permission level** + +The following example shows how to to obtain an AWS Identity and Access Management (IAM) user's permission level on a specified stack. :: + + aws opsworks --region us-east-1 describe-permissions --iam-user-arn arn:aws:iam::123456789012:user/cli-user-test --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 + +*Output*:: + + { + "Permissions": [ + { + "StackId": "d72553d4-8727-448c-9b00-f024f0ba1b06", + "IamUserArn": "arn:aws:iam::123456789012:user/cli-user-test", + "Level": "manage", + "AllowSudo": true, + "AllowSsh": true + } + ] + } + + +**More Information** + +For more information, see `Granting Per-Stack Permissions Levels`_ in the *AWS OpsWorks User Guide*. + +.. _`Granting Per-Stack Permissions Levels`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-console.html diff --git a/aws/dist/awscli/examples/opsworks/describe-raid-arrays.rst b/aws/dist/awscli/examples/opsworks/describe-raid-arrays.rst new file mode 100644 index 00000000..fea1fc9c --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-raid-arrays.rst @@ -0,0 +1,31 @@ +**To describe RAID arrays** + +The following example describes the RAID arrays attached to the instances in a specified stack. :: + + aws opsworks --region us-east-1 describe-raid-arrays --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 + +*Output*: The following is the output for a stack with one RAID array. :: + + { + "RaidArrays": [ + { + "StackId": "d72553d4-8727-448c-9b00-f024f0ba1b06", + "AvailabilityZone": "us-west-2a", + "Name": "Created for php-app1", + "NumberOfDisks": 2, + "InstanceId": "9f14adbc-ced5-43b6-bf01-e7d0db6cf2f7", + "RaidLevel": 0, + "VolumeType": "standard", + "RaidArrayId": "f2d4e470-5972-4676-b1b8-bae41ec3e51c", + "Device": "/dev/md0", + "MountPoint": "/mnt/workspace", + "CreatedAt": "2015-02-26T23:53:09+00:00", + "Size": 100 + } + ] + } + +For more information, see `EBS Volumes`_ in the *AWS OpsWorks User Guide*. + +.. _`EBS Volumes`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html#workinglayers-basics-edit-ebs + diff --git a/aws/dist/awscli/examples/opsworks/describe-rds-db-instances.rst b/aws/dist/awscli/examples/opsworks/describe-rds-db-instances.rst new file mode 100644 index 00000000..2d96a7b2 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-rds-db-instances.rst @@ -0,0 +1,29 @@ +**To describe a stack's registered Amazon RDS instances** + +The following example describes the Amazon RDS instances registered with a specified stack. :: + + aws opsworks --region us-east-1 describe-rds-db-instances --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 + +*Output*: The following is the output for a stack with one registered RDS instance. :: + + { + "RdsDbInstances": [ + { + "Engine": "mysql", + "StackId": "d72553d4-8727-448c-9b00-f024f0ba1b06", + "MissingOnRds": false, + "Region": "us-west-2", + "RdsDbInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:clitestdb", + "DbPassword": "*****FILTERED*****", + "Address": "clitestdb.cdlqlk5uwd0k.us-west-2.rds.amazonaws.com", + "DbUser": "cliuser", + "DbInstanceIdentifier": "clitestdb" + } + ] + } + + +For more information, see `Resource Management`_ in the *AWS OpsWorks User Guide*. + +.. _`Resource Management`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-stack-summary.rst b/aws/dist/awscli/examples/opsworks/describe-stack-summary.rst new file mode 100644 index 00000000..018a11db --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-stack-summary.rst @@ -0,0 +1,27 @@ +**To describe a stack's configuration** + +The following ``describe-stack-summary`` command returns a summary of the specified stack's configuration. :: + + aws opsworks --region us-east-1 describe-stack-summary --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 + +*Output*:: + + { + "StackSummary": { + "StackId": "8c428b08-a1a1-46ce-a5f8-feddc43771b8", + "InstancesCount": { + "Booting": 1 + }, + "Name": "CLITest", + "AppsCount": 1, + "LayersCount": 1, + "Arn": "arn:aws:opsworks:us-west-2:123456789012:stack/8c428b08-a1a1-46ce-a5f8-feddc43771b8/" + } + } + +**More Information** + +For more information, see `Stacks`_ in the *AWS OpsWorks User Guide*. + +.. _`Stacks`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-stacks.rst b/aws/dist/awscli/examples/opsworks/describe-stacks.rst new file mode 100644 index 00000000..0487b19a --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-stacks.rst @@ -0,0 +1,65 @@ +**To describe stacks** + +The following ``describe-stacks`` command describes an account's stacks. :: + + aws opsworks --region us-east-1 describe-stacks + +*Output*:: + + { + "Stacks": [ + { + "ServiceRoleArn": "arn:aws:iam::444455556666:role/aws-opsworks-service-role", + "StackId": "aeb7523e-7c8b-49d4-b866-03aae9d4fbcb", + "DefaultRootDeviceType": "instance-store", + "Name": "TomStack-sd", + "ConfigurationManager": { + "Version": "11.4", + "Name": "Chef" + }, + "UseCustomCookbooks": true, + "CustomJson": "{\n \"tomcat\": {\n \"base_version\": 7,\n \"java_opts\": \"-Djava.awt.headless=true -Xmx256m\"\n },\n \"datasources\": {\n \"ROOT\": \"jdbc/mydb\"\n }\n}", + "Region": "us-east-1", + "DefaultInstanceProfileArn": "arn:aws:iam::444455556666:instance-profile/aws-opsworks-ec2-role", + "CustomCookbooksSource": { + "Url": "git://github.com/example-repo/tomcustom.git", + "Type": "git" + }, + "DefaultAvailabilityZone": "us-east-1a", + "HostnameTheme": "Layer_Dependent", + "Attributes": { + "Color": "rgb(45, 114, 184)" + }, + "DefaultOs": "Amazon Linux", + "CreatedAt": "2013-08-01T22:53:42+00:00" + }, + { + "ServiceRoleArn": "arn:aws:iam::444455556666:role/aws-opsworks-service-role", + "StackId": "40738975-da59-4c5b-9789-3e422f2cf099", + "DefaultRootDeviceType": "instance-store", + "Name": "MyStack", + "ConfigurationManager": { + "Version": "11.4", + "Name": "Chef" + }, + "UseCustomCookbooks": false, + "Region": "us-east-1", + "DefaultInstanceProfileArn": "arn:aws:iam::444455556666:instance-profile/aws-opsworks-ec2-role", + "CustomCookbooksSource": {}, + "DefaultAvailabilityZone": "us-east-1a", + "HostnameTheme": "Layer_Dependent", + "Attributes": { + "Color": "rgb(45, 114, 184)" + }, + "DefaultOs": "Amazon Linux", + "CreatedAt": "2013-10-25T19:24:30+00:00" + } + ] + } + +**More Information** + +For more information, see `Stacks`_ in the *AWS OpsWorks User Guide*. + +.. _`Stacks`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-timebased-auto-scaling.rst b/aws/dist/awscli/examples/opsworks/describe-timebased-auto-scaling.rst new file mode 100644 index 00000000..1848a2d4 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-timebased-auto-scaling.rst @@ -0,0 +1,39 @@ +**To describe the time-based scaling configuration of an instance** + +The following example describes a specified instance's time-based scaling configuration. +The instance is identified by its instance ID, which you can find on the instances's +details page or by running ``describe-instances``. :: + + aws opsworks describe-time-based-auto-scaling --region us-east-1 --instance-ids 701f2ffe-5d8e-4187-b140-77b75f55de8d + +*Output*: The example has a single time-based instance. :: + + { + "TimeBasedAutoScalingConfigurations": [ + { + "InstanceId": "701f2ffe-5d8e-4187-b140-77b75f55de8d", + "AutoScalingSchedule": { + "Monday": { + "11": "on", + "10": "on", + "13": "on", + "12": "on" + }, + "Tuesday": { + "11": "on", + "10": "on", + "13": "on", + "12": "on" + } + } + } + ] + } + + + +**More Information** + +For more information, see `How Automatic Time-based Scaling Works`_ in the *AWS OpsWorks User Guide*. + +.. _`How Automatic Time-based Scaling Works`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html#workinginstances-autoscaling-timebased diff --git a/aws/dist/awscli/examples/opsworks/describe-user-profiles.rst b/aws/dist/awscli/examples/opsworks/describe-user-profiles.rst new file mode 100644 index 00000000..554684ca --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-user-profiles.rst @@ -0,0 +1,32 @@ +**To describe user profiles** + +The following ``describe-user-profiles`` command describes the account's user profiles. :: + + aws opsworks --region us-east-1 describe-user-profiles + +*Output*:: + + { + "UserProfiles": [ + { + "IamUserArn": "arn:aws:iam::123456789012:user/someuser", + "SshPublicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAQEAkOuP7i80q3Cko...", + "AllowSelfManagement": true, + "Name": "someuser", + "SshUsername": "someuser" + }, + { + "IamUserArn": "arn:aws:iam::123456789012:user/cli-user-test", + "AllowSelfManagement": true, + "Name": "cli-user-test", + "SshUsername": "myusername" + } + ] + } + +**More Information** + +For more information, see `Managing AWS OpsWorks Users`_ in the *AWS OpsWorks User Guide*. + +.. _`Managing AWS OpsWorks Users`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-manage.html + diff --git a/aws/dist/awscli/examples/opsworks/describe-volumes.rst b/aws/dist/awscli/examples/opsworks/describe-volumes.rst new file mode 100644 index 00000000..60ef2a28 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/describe-volumes.rst @@ -0,0 +1,31 @@ +**To describe a stack's volumes** + +The following example describes a stack's EBS volumes. :: + + aws opsworks --region us-east-1 describe-volumes --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 + +*Output*:: + + { + "Volumes": [ + { + "Status": "in-use", + "AvailabilityZone": "us-west-2a", + "Name": "CLITest", + "InstanceId": "dfe18b02-5327-493d-91a4-c5c0c448927f", + "VolumeType": "standard", + "VolumeId": "56b66fbd-e1a1-4aff-9227-70f77118d4c5", + "Device": "/dev/sdi", + "Ec2VolumeId": "vol-295c1638", + "MountPoint": "/mnt/myvolume", + "Size": 1 + } + ] + } + +**More Information** + +For more information, see `Resource Management`_ in the *AWS OpsWorks User Guide*. + +.. _`Resource Management`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html + diff --git a/aws/dist/awscli/examples/opsworks/detach-elastic-load-balancer.rst b/aws/dist/awscli/examples/opsworks/detach-elastic-load-balancer.rst new file mode 100644 index 00000000..32bb3bde --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/detach-elastic-load-balancer.rst @@ -0,0 +1,14 @@ +**To detach a load balancer from its layer** + +The following example detaches a load balancer, identified by its name, from its layer. :: + + aws opsworks --region us-east-1 detach-elastic-load-balancer --elastic-load-balancer-name Java-LB --layer-id 888c5645-09a5-4d0e-95a8-812ef1db76a4 + +*Output*: None. + +**More Information** + +For more information, see `Elastic Load Balancing`_ in the *AWS OpsWorks User Guide*. + +.. _`Elastic Load Balancing`: http://docs.aws.amazon.com/opsworks/latest/userguide/load-balancer-elb.html + diff --git a/aws/dist/awscli/examples/opsworks/disassociate-elastic-ip.rst b/aws/dist/awscli/examples/opsworks/disassociate-elastic-ip.rst new file mode 100644 index 00000000..3dd25261 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/disassociate-elastic-ip.rst @@ -0,0 +1,14 @@ +**To disassociate an Elastic IP address from an instance** + +The following example disassociates an Elastic IP address from a specified instance. :: + + aws opsworks --region us-east-1 disassociate-elastic-ip --elastic-ip 54.148.130.96 + +*Output*: None. + +**More Information** + +For more information, see `Resource Management`_ in the *AWS OpsWorks User Guide*. + +.. _`Resource Management`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html + diff --git a/aws/dist/awscli/examples/opsworks/get-hostname-suggestion.rst b/aws/dist/awscli/examples/opsworks/get-hostname-suggestion.rst new file mode 100644 index 00000000..2f9802fc --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/get-hostname-suggestion.rst @@ -0,0 +1,21 @@ +**To get the next hostname for a layer** + +The following example gets the next generated hostname for a specified layer. The layer used for +this example is a Java Application Server layer with one instance. The stack's hostname theme is +the default, Layer_Dependent. :: + + aws opsworks --region us-east-1 get-hostname-suggestion --layer-id 888c5645-09a5-4d0e-95a8-812ef1db76a4 + +*Output*:: + + { + "Hostname": "java-app2", + "LayerId": "888c5645-09a5-4d0e-95a8-812ef1db76a4" + } + +**More Information** + +For more information, see `Create a New Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Create a New Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html + diff --git a/aws/dist/awscli/examples/opsworks/reboot-instance.rst b/aws/dist/awscli/examples/opsworks/reboot-instance.rst new file mode 100644 index 00000000..8f8acf13 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/reboot-instance.rst @@ -0,0 +1,14 @@ +**To reboot an instance** + +The following example reboots an instance. :: + + aws opsworks --region us-east-1 reboot-instance --instance-id dfe18b02-5327-493d-91a4-c5c0c448927f + +*Output*: None. + +**More Information** + +For more information, see `Rebooting an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Rebooting an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html#workinginstances-starting-reboot + diff --git a/aws/dist/awscli/examples/opsworks/register-elastic-ip.rst b/aws/dist/awscli/examples/opsworks/register-elastic-ip.rst new file mode 100644 index 00000000..0af182e6 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/register-elastic-ip.rst @@ -0,0 +1,19 @@ +**To register an Elastic IP address with a stack** + +The following example registers an Elastic IP address, identified by its IP address, with a specified stack. + +**Note:** The Elastic IP address must be in the same region as the stack. :: + + aws opsworks register-elastic-ip --region us-east-1 --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 --elastic-ip 54.148.130.96 + +*Output* :: + + { + "ElasticIp": "54.148.130.96" + } + +**More Information** + +For more information, see `Registering Elastic IP Addresses with a Stack`_ in the *OpsWorks User Guide*. + +.. _`Registering Elastic IP Addresses with a Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-reg.html#resources-reg-eip diff --git a/aws/dist/awscli/examples/opsworks/register-rds-db-instance.rst b/aws/dist/awscli/examples/opsworks/register-rds-db-instance.rst new file mode 100644 index 00000000..2503f686 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/register-rds-db-instance.rst @@ -0,0 +1,15 @@ +**To register an Amazon RDS instance with a stack** + +The following example registers an Amazon RDS DB instance, identified by its Amazon Resource Name (ARN), with a specified stack. +It also specifies the instance's master username and password. Note that AWS OpsWorks does not validate either of these +values. If either one is incorrect, your application will not be able to connect to the database. :: + + aws opsworks register-rds-db-instance --region us-east-1 --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 --rds-db-instance-arn arn:aws:rds:us-west-2:123456789012:db:clitestdb --db-user cliuser --db-password some23!pwd + +*Output*: None. + +**More Information** + +For more information, see `Registering Amazon RDS Instances with a Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Registering Amazon RDS Instances with a Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-reg.html#resources-reg-rds diff --git a/aws/dist/awscli/examples/opsworks/register-volume.rst b/aws/dist/awscli/examples/opsworks/register-volume.rst new file mode 100644 index 00000000..643af1ff --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/register-volume.rst @@ -0,0 +1,18 @@ +**To register an Amazon EBS volume with a stack** + +The following example registers an Amazon EBS volume, identified by its volume ID, with a specified stack. :: + + aws opsworks register-volume --region us-east-1 --stack-id d72553d4-8727-448c-9b00-f024f0ba1b06 --ec-2-volume-id vol-295c1638 + +*Output*:: + + { + "VolumeId": "ee08039c-7cb7-469f-be10-40fb7f0c05e8" + } + + +**More Information** + +For more information, see `Registering Amazon EBS Volumes with a Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Registering Amazon EBS Volumes with a Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-reg.html#resources-reg-ebs diff --git a/aws/dist/awscli/examples/opsworks/register.rst b/aws/dist/awscli/examples/opsworks/register.rst new file mode 100644 index 00000000..6a35a8b8 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/register.rst @@ -0,0 +1,105 @@ +**To register instances with a stack** + +The following examples show a variety of ways to register instances with a stack that were created outside of AWS Opsworks. +You can run ``register`` from the instance to be registered, or from a separate workstation. +For more information, see `Registering Amazon EC2 and On-premises Instances`_ in the *AWS OpsWorks User Guide*. + +.. _`Registering Amazon EC2 and On-premises Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering.html + + +**Note**: For brevity, the examples omit the ``region`` argument. + +*To register an Amazon EC2 instance* + +To indicate that you are registering an EC2 instance, set the ``--infrastructure-class`` argument +to ``ec2``. + +The following example registers an EC2 instance with the specified stack from a separate workstation. +The instance is identified by its EC2 ID, ``i-12345678``. The example uses the workstation's default SSH username and attempts +to log in to the instance using authentication techniques that do not require a password, +such as a default private SSH key. If that fails, ``register`` queries for the password. :: + + aws opsworks register --infrastructure-class=ec2 --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb i-12345678 + +The following example registers an EC2 instance with the specifed stack from a separate workstation. +It uses the ``--ssh-username`` and ``--ssh-private-key`` arguments to explicitly +specify the SSH username and private key file that the command uses to log into the instance. +``ec2-user`` is the standard username for Amazon Linux instances. Use ``ubuntu`` for Ubuntu instances. :: + + aws opsworks register --infrastructure-class=ec2 --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --ssh-username ec2-user --ssh-private-key ssh_private_key i-12345678 + +The following example registers the EC2 instance that is running the ``register`` command. +Log in to the instance with SSH and run ``register`` with the ``--local`` argument instead of an instance ID or hostname. :: + + aws opsworks register --infrastructure-class ec2 --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --local + +*To register an on-premises instance* + +To indicate that you are registering an on-premises instance, set the ``--infrastructure-class`` argument +to ``on-premises``. + +The following example registers an existing on-premises instance with a specified stack from a separate workstation. +The instance is identified by its IP address, ``192.0.2.3``. The example uses the workstation's default SSH username and attempts +to log in to the instance using authentication techniques that do not require a password, +such as a default private SSH key. If that fails, ``register`` queries for the password. :: + + aws opsworks register --infrastructure-class on-premises --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb 192.0.2.3 + +The following example registers an on-premises instance with a specified stack from a separate workstation. +The instance is identified by its hostname, ``host1``. The ``--override-...`` arguments direct AWS OpsWorks +to display ``webserver1`` as the host name and ``192.0.2.3`` and ``10.0.0.2`` as the instance's public and +private IP addresses, respectively. :: + + aws opsworks register --infrastructure-class on-premises --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --override-hostname webserver1 --override-public-ip 192.0.2.3 --override-private-ip 10.0.0.2 host1 + +The following example registers an on-premises instance with a specified stack from a separate workstation. +The instance is identified by its IP address. ``register`` logs into the instance using the specified SSH username and private key file. :: + + aws opsworks register --infrastructure-class on-premises --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --ssh-username admin --ssh-private-key ssh_private_key 192.0.2.3 + +The following example registers an existing on-premises instance with a specified stack from a separate workstation. +The command logs into the instance using a custom SSH command string that specifies +the SSH password and the instance's IP address. :: + + aws opsworks register --infrastructure-class on-premises --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --override-ssh "sshpass -p 'mypassword' ssh your-user@192.0.2.3" + +The following example registers the on-premises instance that is running the ``register`` command. +Log in to the instance with SSH and run ``register`` with the ``--local`` argument instead of an instance ID or hostname. :: + + aws opsworks register --infrastructure-class on-premises --stack-id 935450cc-61e0-4b03-a3e0-160ac817d2bb --local + +*Output*: The following is typical output for registering an EC2 instance. + +:: + + Warning: Permanently added '52.11.41.206' (ECDSA) to the list of known hosts. + % Total % Received % Xferd Average Speed Time Time Time Current + Dload Upload Total Spent Left Speed + 100 6403k 100 6403k 0 0 2121k 0 0:00:03 0:00:03 --:--:-- 2121k + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Initializing AWS OpsWorks environment + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Running on Ubuntu + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Checking if OS is supported + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Running on supported OS + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Setup motd + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Executing: ln -sf --backup /etc/motd.opsworks-static /etc/motd + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Enabling multiverse repositories + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Customizing APT environment + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Installing system packages + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Executing: dpkg --configure -a + [Tue, 24 Feb 2015 20:48:37 +0000] opsworks-init: Executing with retry: apt-get update + [Tue, 24 Feb 2015 20:49:13 +0000] opsworks-init: Executing: apt-get install -y ruby ruby-dev libicu-dev libssl-dev libxslt-dev libxml2-dev libyaml-dev monit + [Tue, 24 Feb 2015 20:50:13 +0000] opsworks-init: Using assets bucket from environment: 'opsworks-instance-assets-us-east-1.s3.amazonaws.com'. + [Tue, 24 Feb 2015 20:50:13 +0000] opsworks-init: Installing Ruby for the agent + [Tue, 24 Feb 2015 20:50:13 +0000] opsworks-init: Executing: /tmp/opsworks-agent-installer.YgGq8wF3UUre6yDy/opsworks-agent-installer/opsworks-agent/bin/installer_wrapper.sh -r -R opsworks-instance-assets-us-east-1.s3.amazonaws.com + [Tue, 24 Feb 2015 20:50:44 +0000] opsworks-init: Starting the installer + Instance successfully registered. Instance ID: 4d6d1710-ded9-42a1-b08e-b043ad7af1e2 + Connection to 52.11.41.206 closed. + +**More Information** + +For more information, see `Registering an Instance with an AWS OpsWorks Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Registering an Instance with an AWS OpsWorks Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html + + + diff --git a/aws/dist/awscli/examples/opsworks/set-load-based-auto-scaling.rst b/aws/dist/awscli/examples/opsworks/set-load-based-auto-scaling.rst new file mode 100644 index 00000000..d3aaab23 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/set-load-based-auto-scaling.rst @@ -0,0 +1,38 @@ +**To set the load-based scaling configuration for a layer** + +The following example enables load-based scaling for a specified layer and sets the configuration +for that layer. +You must use ``create-instance`` to add load-based instances to the layer. :: + + aws opsworks --region us-east-1 set-load-based-auto-scaling --layer-id 523569ae-2faf-47ac-b39e-f4c4b381f36d --enable --up-scaling file://upscale.json --down-scaling file://downscale.json + +The example puts the upscaling threshold settings in a separate file in the working directory named ``upscale.json``, which contains the following. :: + + { + "InstanceCount": 2, + "ThresholdsWaitTime": 3, + "IgnoreMetricsTime": 3, + "CpuThreshold": 85, + "MemoryThreshold": 85, + "LoadThreshold": 85 + } + +The example puts the downscaling threshold settings in a separate file in the working directory named ``downscale.json``, which contains the following. :: + + { + "InstanceCount": 2, + "ThresholdsWaitTime": 3, + "IgnoreMetricsTime": 3, + "CpuThreshold": 35, + "MemoryThreshold": 30, + "LoadThreshold": 30 + } + +*Output*: None. + +**More Information** + +For more information, see `Using Automatic Load-based Scaling`_ in the *AWS OpsWorks User Guide*. + +.. _`Using Automatic Load-based Scaling`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling-loadbased.html + diff --git a/aws/dist/awscli/examples/opsworks/set-permission.rst b/aws/dist/awscli/examples/opsworks/set-permission.rst new file mode 100644 index 00000000..54f61371 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/set-permission.rst @@ -0,0 +1,23 @@ +**To grant per-stack AWS OpsWorks permission levels** + +When you import an AWS Identity and Access Management (IAM) user into AWS OpsWorks by calling ``create-user-profile``, the user has only those +permissions that are granted by the attached IAM policies. +You can grant AWS OpsWorks permissions by modifying a user's policies. +However, it is often easier to import a user and then use the ``set-permission`` command to grant +the user one of the standard permission levels for each stack to which the user will need access. + +The following example grants permission for the specified stack for a user, who +is identified by Amazon Resource Name (ARN). The example grants the user a Manage permissions level, with sudo and SSH privileges on the stack's +instances. :: + + aws opsworks set-permission --region us-east-1 --stack-id 71c7ca72-55ae-4b6a-8ee1-a8dcded3fa0f --level manage --iam-user-arn arn:aws:iam::123456789102:user/cli-user-test --allow-ssh --allow-sudo + + +*Output*: None. + +**More Information** + +For more information, see `Granting AWS OpsWorks Users Per-Stack Permissions`_ in the *AWS OpsWorks User Guide*. + +.. _`Granting AWS OpsWorks Users Per-Stack Permissions`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-console.html + diff --git a/aws/dist/awscli/examples/opsworks/set-time-based-auto-scaling.rst b/aws/dist/awscli/examples/opsworks/set-time-based-auto-scaling.rst new file mode 100644 index 00000000..a308b990 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/set-time-based-auto-scaling.rst @@ -0,0 +1,33 @@ +**To set the time-based scaling configuration for a layer** + +The following example sets the time-based configuration for a specified instance. +You must first use ``create-instance`` to add the instance to the layer. :: + + aws opsworks --region us-east-1 set-time-based-auto-scaling --instance-id 69b6237c-08c0-4edb-a6af-78f3d01cedf2 --auto-scaling-schedule file://schedule.json + +The example puts the schedule in a separate file in the working directory named ``schedule.json``. +For this example, the instance is on for a few hours around midday UTC (Coordinated Universal Time) on Monday and Tuesday. :: + + { + "Monday": { + "10": "on", + "11": "on", + "12": "on", + "13": "on" + }, + "Tuesday": { + "10": "on", + "11": "on", + "12": "on", + "13": "on" + } + } + +*Output*: None. + +**More Information** + +For more information, see `Using Automatic Time-based Scaling`_ in the *AWS OpsWorks User Guide*. + +.. _`Using Automatic Time-based Scaling`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling-timebased.html + diff --git a/aws/dist/awscli/examples/opsworks/start-instance.rst b/aws/dist/awscli/examples/opsworks/start-instance.rst new file mode 100644 index 00000000..125fada9 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/start-instance.rst @@ -0,0 +1,20 @@ +**To start an instance** + +The following ``start-instance`` command starts a specified 24/7 instance. :: + + aws opsworks start-instance --instance-id f705ee48-9000-4890-8bd3-20eb05825aaf + +*Output*: None. Use describe-instances_ to check the instance's status. + +.. _describe-instances: http://docs.aws.amazon.com/cli/latest/reference/opsworks/describe-instances.html + +**Tip** You can start every offline instance in a stack with one command by calling start-stack_. + +.. _start-stack: http://docs.aws.amazon.com/cli/latest/reference/opsworks/start-stack.html + +**More Information** + +For more information, see `Manually Starting, Stopping, and Rebooting 24/7 Instances`_ in the *AWS OpsWorks User Guide*. + +.. _`Manually Starting, Stopping, and Rebooting 24/7 Instances`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html + diff --git a/aws/dist/awscli/examples/opsworks/start-stack.rst b/aws/dist/awscli/examples/opsworks/start-stack.rst new file mode 100644 index 00000000..674b6b12 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/start-stack.rst @@ -0,0 +1,15 @@ +**To start a stack's instances** + +The following example starts all of a stack's 24/7 instances. +To start a particular instance, use ``start-instance``. :: + + aws opsworks --region us-east-1 start-stack --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 + +*Output*: None. + +**More Information** + +For more information, see `Starting an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Starting an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html#workinginstances-starting-start + diff --git a/aws/dist/awscli/examples/opsworks/stop-instance.rst b/aws/dist/awscli/examples/opsworks/stop-instance.rst new file mode 100644 index 00000000..54c09eba --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/stop-instance.rst @@ -0,0 +1,20 @@ +**To stop an instance** + +The following example stops a specified instance, which is identified by its instance ID. +You can obtain an instance ID by going to the instance's details page on the AWS OpsWorks console or by +running the ``describe-instances`` command. :: + + aws opsworks stop-instance --region us-east-1 --instance-id 3a21cfac-4a1f-4ce2-a921-b2cfba6f7771 + +You can restart a stopped instance by calling ``start-instance`` or by deleting the instance by calling +``delete-instance``. + +*Output*: None. + +**More Information** + +For more information, see `Stopping an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Stopping an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html#workinginstances-starting-stop + + diff --git a/aws/dist/awscli/examples/opsworks/stop-stack.rst b/aws/dist/awscli/examples/opsworks/stop-stack.rst new file mode 100644 index 00000000..03c2ec91 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/stop-stack.rst @@ -0,0 +1,15 @@ +**To stop a stack's instances** + +The following example stops all of a stack's 24/7 instances. +To stop a particular instance, use ``stop-instance``. :: + + aws opsworks --region us-east-1 stop-stack --stack-id 8c428b08-a1a1-46ce-a5f8-feddc43771b8 + +*Output*: No output. + +**More Information** + +For more information, see `Stopping an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Stopping an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html#workinginstances-starting-stop + diff --git a/aws/dist/awscli/examples/opsworks/unassign-instance.rst b/aws/dist/awscli/examples/opsworks/unassign-instance.rst new file mode 100644 index 00000000..e9fbb0a6 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/unassign-instance.rst @@ -0,0 +1,14 @@ +**To unassign a registered instance from its layers** + +The following ``unassign-instance`` command unassigns an instance from its attached layers. :: + + aws opsworks --region us-east-1 unassign-instance --instance-id 4d6d1710-ded9-42a1-b08e-b043ad7af1e2 + +**Output**: None. + +**More Information** + +For more information, see `Unassigning a Registered Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Unassigning a Registered Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-unassign.html + diff --git a/aws/dist/awscli/examples/opsworks/unassign-volume.rst b/aws/dist/awscli/examples/opsworks/unassign-volume.rst new file mode 100644 index 00000000..d3f06987 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/unassign-volume.rst @@ -0,0 +1,16 @@ +**To unassign a volume from its instance** + +The following example unassigns a registered Amazon Elastic Block Store (Amazon EBS) volume from its instance. +The volume is identified by its volume ID, which is the GUID that AWS OpsWorks assigns when +you register the volume with a stack, not the Amazon Elastic Compute Cloud (Amazon EC2) volume ID. :: + + aws opsworks --region us-east-1 unassign-volume --volume-id 8430177d-52b7-4948-9c62-e195af4703df + +*Output*: None. + +**More Information** + +For more information, see `Unassigning Amazon EBS Volumes`_ in the *AWS OpsWorks User Guide*. + +.. _`Unassigning Amazon EBS Volumes`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-detach.html#resources-detach-ebs + diff --git a/aws/dist/awscli/examples/opsworks/update-app.rst b/aws/dist/awscli/examples/opsworks/update-app.rst new file mode 100644 index 00000000..5b1fb3cc --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-app.rst @@ -0,0 +1,14 @@ +**To update an app** + +The following example updates a specified app to change its name. :: + + aws opsworks --region us-east-1 update-app --app-id 26a61ead-d201-47e3-b55c-2a7c666942f8 --name NewAppName + +*Output*: None. + +**More Information** + +For more information, see `Editing Apps`_ in the *AWS OpsWorks User Guide*. + +.. _`Editing Apps`: http://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-editing.html + diff --git a/aws/dist/awscli/examples/opsworks/update-elastic-ip.rst b/aws/dist/awscli/examples/opsworks/update-elastic-ip.rst new file mode 100644 index 00000000..709075f2 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-elastic-ip.rst @@ -0,0 +1,14 @@ +**To update an Elastic IP address name** + +The following example updates the name of a specified Elastic IP address. :: + + aws opsworks --region us-east-1 update-elastic-ip --elastic-ip 54.148.130.96 --name NewIPName + +*Output*: None. + +**More Information** + +For more information, see `Resource Management`_ in the *AWS OpsWorks User Guide*. + +.. _`Resource Management`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources.html + diff --git a/aws/dist/awscli/examples/opsworks/update-instance.rst b/aws/dist/awscli/examples/opsworks/update-instance.rst new file mode 100644 index 00000000..d4e2dd1c --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-instance.rst @@ -0,0 +1,14 @@ +**To update an instance** + +The following example updates a specified instance's type. :: + + aws opsworks --region us-east-1 update-instance --instance-id dfe18b02-5327-493d-91a4-c5c0c448927f --instance-type c3.xlarge + +*Output*: None. + +**More Information** + +For more information, see `Editing the Instance Configuration`_ in the *AWS OpsWorks User Guide*. + +.. _`Editing the Instance Configuration`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-properties.html + diff --git a/aws/dist/awscli/examples/opsworks/update-layer.rst b/aws/dist/awscli/examples/opsworks/update-layer.rst new file mode 100644 index 00000000..c8a0b404 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-layer.rst @@ -0,0 +1,14 @@ +**To update a layer** + +The following example updates a specified layer to use Amazon EBS-optimized instances. :: + + aws opsworks --region us-east-1 update-layer --layer-id 888c5645-09a5-4d0e-95a8-812ef1db76a4 --use-ebs-optimized-instances + +*Output*: None. + +**More Information** + +For more information, see `Editing an OpsWorks Layer's Configuration`_ in the *AWS OpsWorks User Guide*. + +.. _`Editing an OpsWorks Layer's Configuration`: http://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html + diff --git a/aws/dist/awscli/examples/opsworks/update-my-user-profile.rst b/aws/dist/awscli/examples/opsworks/update-my-user-profile.rst new file mode 100644 index 00000000..b804540c --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-my-user-profile.rst @@ -0,0 +1,16 @@ +**To update a user's profile** + +The following example updates the ``development`` user's profile to use a specified SSH public key. +The user's AWS credentials are represented by the ``development`` profile in the ``credentials`` file +(``~\.aws\credentials``), and the key is in a ``.pem`` file in the working directory. :: + + aws opsworks --region us-east-1 --profile development update-my-user-profile --ssh-public-key file://development_key.pem + +*Output*: None. + +**More Information** + +For more information, see `Editing AWS OpsWorks User Settings`_ in the *AWS OpsWorks User Guide*. + +.. _`Editing AWS OpsWorks User Settings`: http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users-manage-edit.html + diff --git a/aws/dist/awscli/examples/opsworks/update-rds-db-instance.rst b/aws/dist/awscli/examples/opsworks/update-rds-db-instance.rst new file mode 100644 index 00000000..bb6c4346 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-rds-db-instance.rst @@ -0,0 +1,18 @@ +**To update a registered Amazon RDS DB instance** + +The following example updates an Amazon RDS instance's master password value. +Note that this command does not change the RDS instance's master password, just the password that +you provide to AWS OpsWorks. +If this password does not match the RDS instance's password, +your application will not be able to connect to the database. :: + + aws opsworks --region us-east-1 update-rds-db-instance --db-password 123456789 + +*Output*: None. + +**More Information** + +For more information, see `Registering Amazon RDS Instances with a Stack`_ in the *AWS OpsWorks User Guide*. + +.. _`Registering Amazon RDS Instances with a Stack`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-reg.html#resources-reg-rds + diff --git a/aws/dist/awscli/examples/opsworks/update-volume.rst b/aws/dist/awscli/examples/opsworks/update-volume.rst new file mode 100644 index 00000000..182e7ce4 --- /dev/null +++ b/aws/dist/awscli/examples/opsworks/update-volume.rst @@ -0,0 +1,16 @@ +**To update a registered volume** + +The following example updates a registered Amazon Elastic Block Store (Amazon EBS) volume's mount point. +The volume is identified by its volume ID, which is the GUID that AWS OpsWorks assigns to the volume when +you register it with a stack, not the Amazon Elastic Compute Cloud (Amazon EC2) volume ID.:: + + aws opsworks --region us-east-1 update-volume --volume-id 8430177d-52b7-4948-9c62-e195af4703df --mount-point /mnt/myvol + +*Output*: None. + +**More Information** + +For more information, see `Assigning Amazon EBS Volumes to an Instance`_ in the *AWS OpsWorks User Guide*. + +.. _`Assigning Amazon EBS Volumes to an Instance`: http://docs.aws.amazon.com/opsworks/latest/userguide/resources-attach.html#resources-attach-ebs + diff --git a/aws/dist/awscli/examples/opsworkscm/associate-node.rst b/aws/dist/awscli/examples/opsworkscm/associate-node.rst new file mode 100644 index 00000000..d7913531 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/associate-node.rst @@ -0,0 +1,22 @@ +**To associate nodes** + +The following ``associate-node`` command associates a node named ``i-44de882p`` with +a Chef Automate server named ``automate-06``, meaning that the ``automate-06`` server +manages the node, and communicates recipe commands to the node through ``chef-client`` agent software +that is installed on the node by the associate-node command. Valid node names are EC2 instance IDs.:: + + aws opsworks-cm associate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'" + +The output returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk" + } + +**More Information** + +For more information, see `Adding Nodes Automatically in AWS OpsWorks for Chef Automate`_ in the *AWS OpsWorks User Guide*. + +.. _`Adding Nodes Automatically in AWS OpsWorks for Chef Automate`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-unattend-assoc.html + diff --git a/aws/dist/awscli/examples/opsworkscm/create-backup.rst b/aws/dist/awscli/examples/opsworkscm/create-backup.rst new file mode 100644 index 00000000..7bdd697e --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/create-backup.rst @@ -0,0 +1,46 @@ +**To create backups** + +The following ``create-backup`` command starts a manual backup of a Chef Automate server +named ``automate-06`` in the ``us-east-1`` region. The command adds a descriptive message to +the backup in the ``--description`` parameter.:: + + aws opsworks-cm create-backup --server-name 'automate-06' --description "state of my infrastructure at launch" + +The output shows you information similar to the following about the new backup. +*Output*:: + + { + "Backups": [ + { + "BackupArn": "string", + "BackupId": "automate-06-20160729133847520", + "BackupType": "MANUAL", + "CreatedAt": 2016-07-29T13:38:47.520Z, + "Description": "state of my infrastructure at launch", + "Engine": "Chef", + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "S3LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "OK", + "StatusDescription": "", + "SubnetIds": [ "subnet-49436a18" ], + "ToolsVersion": "string", + "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user" + } + ], + } + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff --git a/aws/dist/awscli/examples/opsworkscm/create-server.rst b/aws/dist/awscli/examples/opsworkscm/create-server.rst new file mode 100644 index 00000000..97c020ed --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/create-server.rst @@ -0,0 +1,48 @@ +**To create a server** + +The following ``create-server`` example creates a new Chef Automate server named ``automate-06`` in your default region. Note that defaults are used for most other settings, such as number of backups to retain, and maintenance and backup start times. Before you run a ``create-server`` command, complete prerequisites in `Getting Started with AWS OpsWorks for Chef Automate `_ in the *AWS Opsworks for Chef Automate User Guide*. :: + + aws opsworks-cm create-server \ + --engine "Chef" \ + --engine-model "Single" \ + --engine-version "12" \ + --server-name "automate-06" \ + --instance-profile-arn "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role" \ + --instance-type "t2.medium" \ + --key-pair "amazon-test" \ + --service-role-arn "arn:aws:iam::044726508045:role/aws-opsworks-cm-service-role" + +The output shows you information similar to the following about the new server:: + + { + "Server": { + "BackupRetentionCount": 10, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/aws-opsworks-cm-ec2-role", + "InstanceType": "t2.medium", + "KeyPair": "amazon-test", + "MaintenanceStatus": "", + "PreferredBackupWindow": "Sun:02:00", + "PreferredMaintenanceWindow": "00:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role", + "Status": "CREATING", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServer `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff --git a/aws/dist/awscli/examples/opsworkscm/delete-backup.rst b/aws/dist/awscli/examples/opsworkscm/delete-backup.rst new file mode 100644 index 00000000..d20a0f98 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/delete-backup.rst @@ -0,0 +1,17 @@ +**To delete backups** + +The following ``delete-backup`` command deletes a manual or automated backup of +a Chef Automate server, identified by the backup ID. This command is useful when +you are approaching the maximum number of backups that you can save, or you want +to minimize your Amazon S3 storage costs.:: + + aws opsworks-cm delete-backup --backup-id "automate-06-2016-11-19T23:42:40.240Z" + +The output shows whether the backup deletion succeeded. + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff --git a/aws/dist/awscli/examples/opsworkscm/delete-server.rst b/aws/dist/awscli/examples/opsworkscm/delete-server.rst new file mode 100644 index 00000000..d7b76e4e --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/delete-server.rst @@ -0,0 +1,16 @@ +**To delete servers** + +The following ``delete-server`` command deletes a Chef Automate server, identified +by the server's name. After the server is deleted, it is no longer returned by +``DescribeServer`` requests.:: + + aws opsworks-cm delete-server --server-name "automate-06" + +The output shows whether the server deletion succeeded. + +**More Information** + +For more information, see `Delete an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Delete an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-delete-server.html + diff --git a/aws/dist/awscli/examples/opsworkscm/describe-account-attributes.rst b/aws/dist/awscli/examples/opsworkscm/describe-account-attributes.rst new file mode 100644 index 00000000..2beb5453 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/describe-account-attributes.rst @@ -0,0 +1,26 @@ +**To describe account attributes** + +The following ``describe-account-attributes`` command returns information about your +account's usage of AWS OpsWorks for Chef Automate resources.:: + + aws opsworks-cm describe-account-attributes + +The output for each account attribute entry returned by the command resembles the following. +*Output*:: + + { + "Attributes": [ + { + "Maximum": 5, + "Name": "ServerLimit", + "Used": 2 + } + ] + } + +**More Information** + +For more information, see `DescribeAccountAttributes`_ in the *AWS OpsWorks for Chef Automate API Reference*. + +.. _`DescribeAccountAttributes`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeAccountAttributes.html + diff --git a/aws/dist/awscli/examples/opsworkscm/describe-backups.rst b/aws/dist/awscli/examples/opsworkscm/describe-backups.rst new file mode 100644 index 00000000..fa6ff190 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/describe-backups.rst @@ -0,0 +1,45 @@ +**To describe backups** + +The following ``describe-backups`` command returns information about all backups +associated with your account in your default region.:: + + aws opsworks-cm describe-backups + +The output for each backup entry returned by the command resembles the following. +*Output*:: + + { + "Backups": [ + { + "BackupArn": "string", + "BackupId": "automate-06-20160729133847520", + "BackupType": "MANUAL", + "CreatedAt": 2016-07-29T13:38:47.520Z, + "Description": "state of my infrastructure at launch", + "Engine": "Chef", + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "S3LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "Successful", + "StatusDescription": "", + "SubnetIds": [ "subnet-49436a18" ], + "ToolsVersion": "string", + "UserArn": "arn:aws:iam::1019881987024:user/opsworks-user" + } + ], + } + +**More Information** + +For more information, see `Back Up and Restore an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Back Up and Restore an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-backup-restore.html + diff --git a/aws/dist/awscli/examples/opsworkscm/describe-events.rst b/aws/dist/awscli/examples/opsworkscm/describe-events.rst new file mode 100644 index 00000000..ce105515 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/describe-events.rst @@ -0,0 +1,20 @@ +**To describe events** + +The following ``describe-events`` example returns information about all events that are associated with the specified Chef Automate server. :: + + aws opsworks-cm describe-events --server-name 'automate-06' + +The output for each event entry returned by the command resembles the following example:: + + { + "ServerEvents": [ + { + "CreatedAt": 2016-07-29T13:38:47.520Z, + "LogUrl": "https://s3.amazonaws.com/automate-06/automate-06-20160729133847520", + "Message": "Updates successfully installed.", + "ServerName": "automate-06" + } + ] + } + +For more information, see `General Troubleshooting Tips `_ in the *AWS OpsWorks User Guide*. diff --git a/aws/dist/awscli/examples/opsworkscm/describe-node-association-status.rst b/aws/dist/awscli/examples/opsworkscm/describe-node-association-status.rst new file mode 100644 index 00000000..33e8a040 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/describe-node-association-status.rst @@ -0,0 +1,20 @@ +**To describe node association status** + +The following ``describe-node-association-status`` command returns the status of a +request to associate a node with a Chef Automate server named ``automate-06``.:: + + aws opsworks-cm describe-node-association-status --server-name "automate-06" --node-association-status-token "AflJKl+/GoKLZJBdDQEx0O65CDi57blQe9nKM8joSok0pQ9xr8DqApBN9/1O6sLdSvlfDEKkEx+eoCHvjoWHaOs=" + +The output for each account attribute entry returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatus": "IN_PROGRESS" + } + +**More Information** + +For more information, see `DescribeNodeAssociationStatus`_ in the *AWS OpsWorks for Chef Automate API Reference*. + +.. _`DescribeNodeAssociationStatus`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeNodeAssociationStatus.html + diff --git a/aws/dist/awscli/examples/opsworkscm/describe-servers.rst b/aws/dist/awscli/examples/opsworkscm/describe-servers.rst new file mode 100644 index 00000000..8266cdb4 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/describe-servers.rst @@ -0,0 +1,48 @@ +**To describe servers** + +The following ``describe-servers`` command returns information about all servers +that are associated with your account, and in your default region.:: + + aws opsworks-cm describe-servers + +The output for each server entry returned by the command resembles the following. +*Output*:: + + { + "Servers": [ + { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "03:00", + "PreferredMaintenanceWindow": "Mon:09:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + ] + } + +**More Information** + +For more information, see `DescribeServers`_ in the *AWS OpsWorks for Chef Automate API Guide*. + +.. _`DescribeServers`: http://docs.aws.amazon.com/opsworks-cm/latest/APIReference/API_DescribeServers.html diff --git a/aws/dist/awscli/examples/opsworkscm/disassociate-node.rst b/aws/dist/awscli/examples/opsworkscm/disassociate-node.rst new file mode 100644 index 00000000..824c4a6e --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/disassociate-node.rst @@ -0,0 +1,19 @@ +**To disassociate nodes** + +The following ``disassociate-node`` command disassociates a node named ``i-44de882p``, removing the node from +management by a Chef Automate server named ``automate-06``. Valid node names are EC2 instance IDs.:: + + aws opsworks-cm disassociate-node --server-name "automate-06" --node-name "i-43de882p" --engine-attributes "Name=CHEF_ORGANIZATION,Value='MyOrganization' Name=CHEF_NODE_PUBLIC_KEY,Value='Public_key_contents'" + +The output returned by the command resembles the following. +*Output*:: + + { + "NodeAssociationStatusToken": "AHUY8wFe4pdXtZC5DiJa5SOLp5o14DH//rHRqHDWXxwVoNBxcEy4V7R0NOFymh7E/1HumOBPsemPQFE6dcGaiFk" + } + +**More Information** + +For more information, see `Delete an AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Delete an AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-delete-server.html diff --git a/aws/dist/awscli/examples/opsworkscm/restore-server.rst b/aws/dist/awscli/examples/opsworkscm/restore-server.rst new file mode 100644 index 00000000..fdd0bf0e --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/restore-server.rst @@ -0,0 +1,20 @@ +**To restore a server** + +The following ``restore-server`` command performs an in-place restoration of a +Chef Automate server named ``automate-06`` in your default region from a backup +with an ID of ``automate-06-2016-11-22T16:13:27.998Z``. Restoring a server restores +connections to the nodes that the Chef Automate server was managing at the time +that the specified backup was performed. + + aws opsworks-cm restore-server --backup-id "automate-06-2016-11-22T16:13:27.998Z" --server-name "automate-06" + +The output is the command ID only. +*Output*:: + + (None) + +**More Information** + +For more information, see `Restore a Failed AWS OpsWorks for Chef Automate Server`_ in the *AWS OpsWorks User Guide*. + +.. _`Restore a Failed AWS OpsWorks for Chef Automate Server`: http://docs.aws.amazon.com/opsworks/latest/userguide/opscm-chef-restore.html diff --git a/aws/dist/awscli/examples/opsworkscm/start-maintenance.rst b/aws/dist/awscli/examples/opsworkscm/start-maintenance.rst new file mode 100644 index 00000000..8a28ee15 --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/start-maintenance.rst @@ -0,0 +1,40 @@ +**To start maintenance** + +The following ``start-maintenance`` example manually starts maintenance on the specified Chef Automate server in your default region. This command can be useful if an earlier, automated maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. :: + + aws opsworks-cm start-maintenance --server-name 'automate-06' + +The output shows you information similar to the following about the maintenance request. :: + + { + "Server": { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": TRUE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "", + "PreferredMaintenanceWindow": "", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `StartMaintenance `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff --git a/aws/dist/awscli/examples/opsworkscm/update-server-engine-attributes.rst b/aws/dist/awscli/examples/opsworkscm/update-server-engine-attributes.rst new file mode 100644 index 00000000..814111bc --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/update-server-engine-attributes.rst @@ -0,0 +1,43 @@ +**To update server engine attributes** + +The following ``update-server-engine-attributes`` command updates the value of the ``CHEF_PIVOTAL_KEY`` engine attribute for a Chef Automate server named ``automate-06``. It is currently not possible to change the value of other engine attributes. :: + + aws opsworks-cm update-server-engine-attributes \ + --attribute-name CHEF_PIVOTAL_KEY \ + --attribute-value "new key value" \ + --server-name "automate-06" + +The output shows you information similar to the following about the updated server. :: + + { + "Server": { + "BackupRetentionCount": 2, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": FALSE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_PIVOTAL_KEY", + "Value": "new key value" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "SUCCESS", + "PreferredBackupWindow": "Mon:09:15", + "PreferredMaintenanceWindow": "03:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServerEngineAttributes `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff --git a/aws/dist/awscli/examples/opsworkscm/update-server.rst b/aws/dist/awscli/examples/opsworkscm/update-server.rst new file mode 100644 index 00000000..fd089c5c --- /dev/null +++ b/aws/dist/awscli/examples/opsworkscm/update-server.rst @@ -0,0 +1,42 @@ +**To update a server** + +The following ``update-server`` command updates the maintenance start time of the specified Chef Automate server in your default region. The ``--preferred-maintenance-window`` parameter is added to change the start day and time of server maintenance to Mondays at 9:15 a.m. UTC.:: + + aws opsworks-cm update-server \ + --server-name "automate-06" \ + --preferred-maintenance-window "Mon:09:15" + +The output shows you information similar to the following about the updated server. :: + + { + "Server": { + "BackupRetentionCount": 8, + "CreatedAt": 2016-07-29T13:38:47.520Z, + "DisableAutomatedBackup": TRUE, + "Endpoint": "https://opsworks-cm.us-east-1.amazonaws.com", + "Engine": "Chef", + "EngineAttributes": [ + { + "Name": "CHEF_DELIVERY_ADMIN_PASSWORD", + "Value": "1Password1" + } + ], + "EngineModel": "Single", + "EngineVersion": "12", + "InstanceProfileArn": "arn:aws:iam::1019881987024:instance-profile/automate-06-1010V4UU2WRM2", + "InstanceType": "m4.large", + "KeyPair": "", + "MaintenanceStatus": "OK", + "PreferredBackupWindow": "Mon:09:15", + "PreferredMaintenanceWindow": "03:00", + "SecurityGroupIds": [ "sg-1a24c270" ], + "ServerArn": "arn:aws:iam::1019881987024:instance/automate-06-1010V4UU2WRM2", + "ServerName": "automate-06", + "ServiceRoleArn": "arn:aws:iam::1019881987024:role/aws-opsworks-cm-service-role.1114810729735", + "Status": "HEALTHY", + "StatusReason": "", + "SubnetIds": [ "subnet-49436a18" ] + } + } + +For more information, see `UpdateServer `_ in the *AWS OpsWorks for Chef Automate API Reference*. diff --git a/aws/dist/awscli/examples/organizations/accept-handshake.rst b/aws/dist/awscli/examples/organizations/accept-handshake.rst new file mode 100755 index 00000000..0877352b --- /dev/null +++ b/aws/dist/awscli/examples/organizations/accept-handshake.rst @@ -0,0 +1,52 @@ +**To accept a handshake from another account** + +Bill, the owner of an organization, has previously invited Juan's account to join his organization. The following example shows Juan's account accepting the handshake and thus agreeing to the invitation. :: + + aws organizations accept-handshake --handshake-id h-examplehandshakeid111 + +The output shows the following: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "RequestedTimestamp": 1481656459.257, + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "ALL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "ACCEPTED" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/attach-policy.rst b/aws/dist/awscli/examples/organizations/attach-policy.rst new file mode 100755 index 00000000..a3478e62 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/attach-policy.rst @@ -0,0 +1,17 @@ +**To attach a policy to a root, OU, or account** + +**Example 1** + +The following example shows how to attach a service control policy (SCP) to an OU: :: + + aws organizations attach-policy + --policy-id p-examplepolicyid111 + --target-id ou-examplerootid111-exampleouid111 + +**Example 2** + +The following example shows how to attach a service control policy directly to an account: :: + + aws organizations attach-policy + --policy-id p-examplepolicyid111 + --target-id 333333333333 diff --git a/aws/dist/awscli/examples/organizations/cancel-handshake.rst b/aws/dist/awscli/examples/organizations/cancel-handshake.rst new file mode 100755 index 00000000..e2a83da8 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/cancel-handshake.rst @@ -0,0 +1,56 @@ +**To cancel a handshake sent from another account** + +Bill previously sent an invitation to Susan's account to join his organization. He changes his mind and decides to cancel the invitation before Susan accepts it. The following example shows Bill's cancellation: :: + + aws organizations cancel-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that shows that the state is now ``CANCELED``: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State":"CANCELED", + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "susan@example.com", + "Type": "EMAIL" + } + ], + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "CONSOLIDATED_BILLING" + } + ] + }, + { + "Type": "EMAIL", + "Value": "anika@example.com" + }, + { + "Type": "NOTES", + "Value": "This is a request for Susan's account to join Bob's organization." + } + ], + "RequestedTimestamp": 1.47008383521E9, + "ExpirationTimestamp": 1.47137983521E9 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/create-account.rst b/aws/dist/awscli/examples/organizations/create-account.rst new file mode 100755 index 00000000..9a6ea113 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/create-account.rst @@ -0,0 +1,20 @@ +**To create a member account that is automatically part of the organization** + +The following example shows how to create a member account in an organization. The member account is configured with the name Production Account and the email address of susan@example.com. Organizations automatically creates an IAM role using the default name of OrganizationAccountAccessRole because the roleName parameter is not specified. Also, the setting that allows IAM users or roles with sufficient permissions to access account billing data is set to the default value of ALLOW because the IamUserAccessToBilling parameter is not specified. Organizations automatically sends Susan a "Welcome to AWS" email: :: + + aws organizations create-account --email susan@example.com --account-name "Production Account" + +The output includes a request object that shows that the status is now ``IN_PROGRESS``: :: + + { + "CreateAccountStatus": { + "State": "IN_PROGRESS", + "Id": "car-examplecreateaccountrequestid111" + } + } + +You can later query the current status of the request by providing the Id response value to the describe-create-account-status command as the value for the create-account-request-id parameter. + +For more information, see `Creating an AWS Account in Your Organization`_ in the *AWS Organizations Users Guide*. + +.. _`Creating an AWS Account in Your Organization`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_create.html diff --git a/aws/dist/awscli/examples/organizations/create-organization.rst b/aws/dist/awscli/examples/organizations/create-organization.rst new file mode 100755 index 00000000..9e217ece --- /dev/null +++ b/aws/dist/awscli/examples/organizations/create-organization.rst @@ -0,0 +1,48 @@ +**Example 1: To create a new organization** + +Bill wants to create an organization using credentials from account 111111111111. The following example shows that the account becomes the master account in the new organization. Because he does not specify a features set, the new organization defaults to all features enabled and service control policies are enabled on the root. :: + + aws organizations create-organization + +The output includes an organization object with details about the new organization: :: + + { + "Organization": { + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ], + "MasterAccountId": "111111111111", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "FeatureSet": "ALL", + "Id": "o-exampleorgid", + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid" + } + } + +**Example 2: To create a new organization with only consolidated billing features enabled** + +The following example creates an organization that supports only the consolidated billing features: :: + + aws organizations create-organization --feature-set CONSOLIDATED_BILLING + +The output includes an organization object with details about the new organization: :: + + { + "Organization": { + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [], + "Id": "o-exampleorgid", + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111", + "FeatureSet": "CONSOLIDATED_BILLING" + } + } + +For more information, see `Creating an Organization`_ in the *AWS Organizations Users Guide*. + +.. _`Creating an Organization`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_create.html diff --git a/aws/dist/awscli/examples/organizations/create-organizational-unit.rst b/aws/dist/awscli/examples/organizations/create-organizational-unit.rst new file mode 100755 index 00000000..d30e50d9 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/create-organizational-unit.rst @@ -0,0 +1,15 @@ +**To create an OU in a root or parent OU** + +The following example shows how to create an OU that is named AccountingOU: :: + + aws organizations create-organizational-unit --parent-id r-examplerootid111 --name AccountingOU + +The output includes an organizationalUnit object with details about the new OU: :: + + { + "OrganizationalUnit": { + "Id": "ou-examplerootid111-exampleouid111", + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Name": "AccountingOU" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/create-policy.rst b/aws/dist/awscli/examples/organizations/create-policy.rst new file mode 100755 index 00000000..47d10600 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/create-policy.rst @@ -0,0 +1,29 @@ +**Example 1: To create a policy with a text source file for the JSON policy** + +The following example shows you how to create an service control policy (SCP) named ``AllowAllS3Actions``. The policy contents are taken from a file on the local computer called ``policy.json``. :: + + aws organizations create-policy --content file://policy.json --name AllowAllS3Actions, --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" + +The output includes a policy object with details about the new policy: :: + + { + "Policy": { + "Content": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}", + "PolicySummary": { + "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid111", + "Description": "Allows delegation of all S3 actions", + "Name": "AllowAllS3Actions", + "Type":"SERVICE_CONTROL_POLICY" + } + } + } + +**Example 2: To create a policy with a JSON policy as a parameter** + +The following example shows you how to create the same SCP, this time by embedding the policy contents as a JSON string in the parameter. The string must be escaped with backslashes before the double quotes to ensure that they are treated as literals in the parameter, which itself is surrounded by double quotes: :: + + aws organizations create-policy --content "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"s3:*\"],\"Resource\":[\"*\"]}]}" --name AllowAllS3Actions --type SERVICE_CONTROL_POLICY --description "Allows delegation of all S3 actions" + +For more information about creating and using policies in your organization, see `Managing Organization Policies`_ in the *AWS Organizations User Guide*. + +.. _`Managing Organization Policies`: http://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/decline-handshake.rst b/aws/dist/awscli/examples/organizations/decline-handshake.rst new file mode 100755 index 00000000..989ba339 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/decline-handshake.rst @@ -0,0 +1,52 @@ +**To decline a handshake sent from another account** + +The following example shows that Susan, an admin who is the owner of account 222222222222, declines an invitation to join Bill's organization. The DeclineHandshake operation returns a handshake object, showing that the state is now DECLINED: :: + + aws organizations decline-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that shows the new state of ``DECLINED``: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State": "DECLINED", + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ] + }, + { + "Type": "EMAIL", + "Value": "susan@example.com" + }, + { + "Type": "NOTES", + "Value": "This is an invitation to Susan's account to join the Bill's organization." + } + ], + "Parties": [ + { + "Type": "EMAIL", + "Id": "susan@example.com" + }, + { + "Type": "ORGANIZATION", + "Id": "o-exampleorgid" + } + ], + "Action": "INVITE", + "RequestedTimestamp": 1470684478.687, + "ExpirationTimestamp": 1471980478.687, + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/delete-organization.rst b/aws/dist/awscli/examples/organizations/delete-organization.rst new file mode 100755 index 00000000..0a6d0311 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/delete-organization.rst @@ -0,0 +1,5 @@ +**To delete an organization** + +The following example shows how to delete an organization. To perform this operation, you must be an admin of the master account in the organization. The example assumes that you previously removed all the member accounts, OUs, and policies from the organization: :: + + aws organizations delete-organization \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/delete-organizational-unit.rst b/aws/dist/awscli/examples/organizations/delete-organizational-unit.rst new file mode 100755 index 00000000..f73e693f --- /dev/null +++ b/aws/dist/awscli/examples/organizations/delete-organizational-unit.rst @@ -0,0 +1,5 @@ +**To delete an OU** + +The following example shows how to delete an OU. The example assumes that you previously removed all accounts and other OUs from the OU: :: + + aws organizations delete-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 diff --git a/aws/dist/awscli/examples/organizations/delete-policy.rst b/aws/dist/awscli/examples/organizations/delete-policy.rst new file mode 100755 index 00000000..a6a39ed1 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/delete-policy.rst @@ -0,0 +1,5 @@ +**To delete a policy** + +The following example shows how to delete a policy from an organization. The example assumes that you previously detached the policy from all entities: :: + + aws organizations delete-policy --policy-id p-examplepolicyid111 \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/describe-account.rst b/aws/dist/awscli/examples/organizations/describe-account.rst new file mode 100755 index 00000000..0f40fc61 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-account.rst @@ -0,0 +1,19 @@ +**To get the details about an account** + +The following example shows you how to request details about an account: :: + + aws organizations describe-account --account-id 555555555555 + +The output shows an account object with the details about the account: :: + + { + "Account": { + "Id": "555555555555", + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/555555555555", + "Name": "Beta account", + "Email": "anika@example.com", + "JoinedMethod": "INVITED", + "JoinedTimeStamp": 1481756563.134, + "Status": "ACTIVE" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/describe-create-account-status.rst b/aws/dist/awscli/examples/organizations/describe-create-account-status.rst new file mode 100755 index 00000000..a01b19c2 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-create-account-status.rst @@ -0,0 +1,20 @@ +**To get the latest status about a request to create an account** + +The following example shows how to request the latest status for a previous request to create an account in an organization. The specified --request-id comes from the response of the original call to create-account. The account creation request shows by the status field that Organizations successfully completed the creation of the account. + +Command:: + + aws organizations describe-create-account-status --create-account-request-id car-examplecreateaccountrequestid111 + +Output:: + + { + "CreateAccountStatus": { + "State": "SUCCEEDED", + "AccountId": "555555555555", + "AccountName": "Beta account", + "RequestedTimestamp": 1470684478.687, + "CompletedTimestamp": 1470684532.472, + "Id": "car-examplecreateaccountrequestid111" + } + } diff --git a/aws/dist/awscli/examples/organizations/describe-handshake.rst b/aws/dist/awscli/examples/organizations/describe-handshake.rst new file mode 100755 index 00000000..c6328b8f --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-handshake.rst @@ -0,0 +1,48 @@ +**To get information about a handshake** + +The following example shows you how to request details about a handshake. The handshake ID comes either from the original call to ``InviteAccountToOrganization``, or from a call to ``ListHandshakesForAccount`` or ``ListHandshakesForOrganization``: :: + + aws organizations describe-handshake --handshake-id h-examplehandshakeid111 + +The output includes a handshake object that has all the details about the requested handshake: :: + + { + "Handshake": { + "Id": "h-examplehandshakeid111", + "State": "OPEN", + "Resources": [ + { + "Type": "ORGANIZATION", + "Value": "o-exampleorgid", + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@example.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Master Account" + } + ] + }, + { + "Type": "EMAIL", + "Value": "anika@example.com" + } + ], + "Parties": [ + { + "Type": "ORGANIZATION", + "Id": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Id": "anika@example.com" + } + ], + "Action": "INVITE", + "RequestedTimestamp": 1470158698.046, + "ExpirationTimestamp": 1471454698.046, + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/describe-organization.rst b/aws/dist/awscli/examples/organizations/describe-organization.rst new file mode 100755 index 00000000..04aaa2ac --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-organization.rst @@ -0,0 +1,24 @@ +**To get information about the current organization** + +The following example shows you how to request details about an organization: :: + + aws organizations describe-organization + +The output includes an organization object that has the details about the organization: :: + + { + "Organization": { + "MasterAccountArn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "MasterAccountEmail": "bill@example.com", + "MasterAccountId": "111111111111", + "Id": "o-exampleorgid", + "FeatureSet": "ALL", + "Arn": "arn:aws:organizations::111111111111:organization/o-exampleorgid", + "AvailablePolicyTypes": [ + { + "Status": "ENABLED", + "Type": "SERVICE_CONTROL_POLICY" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/describe-organizational-unit.rst b/aws/dist/awscli/examples/organizations/describe-organizational-unit.rst new file mode 100755 index 00000000..b633f104 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-organizational-unit.rst @@ -0,0 +1,15 @@ +**To get information about an OU** + +The following example shows how to request details about an OU: :: + + aws organizations describe-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 + +The output includes an OrganizationUnit object that contains the details about the OU: :: + + { + "OrganizationalUnit": { + "Name": "Accounting Group", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Id": "ou-examplerootid111-exampleouid111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/describe-policy.rst b/aws/dist/awscli/examples/organizations/describe-policy.rst new file mode 100755 index 00000000..be2af597 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/describe-policy.rst @@ -0,0 +1,21 @@ +**To get information about a policy** + +The following example shows how to request information about a policy: :: + + aws organizations describe-policy --policy-id p-examplepolicyid111 + +The output includes a policy object that contains details about the policy: :: + + { + "Policy": { + "Content": "{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"*\",\n \"Resource\": \"*\"\n }\n ]\n}", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "Type": "SERVICE_CONTROL_POLICY", + "Id": "p-examplepolicyid111", + "AwsManaged": false, + "Name": "AllowAllS3Actions", + "Description": "Enables admins to delegate S3 permissions" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/detach-policy.rst b/aws/dist/awscli/examples/organizations/detach-policy.rst new file mode 100755 index 00000000..943a3be2 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/detach-policy.rst @@ -0,0 +1,5 @@ +**To detach a policy from a root, OU, or account** + +The following example shows how to detach a policy from an OU: :: + + aws organizations detach-policy --target-id ou-examplerootid111-exampleouid111 --policy-id p-examplepolicyid111 diff --git a/aws/dist/awscli/examples/organizations/disable-policy-type.rst b/aws/dist/awscli/examples/organizations/disable-policy-type.rst new file mode 100755 index 00000000..2e7a5032 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/disable-policy-type.rst @@ -0,0 +1,16 @@ +**To disable a policy type in a root** + +The following example shows how to disable the service control policy (SCP) policy type in a root: :: + + aws organizations disable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY + +The output shows that the PolicyTypes response element no longer includes SERVICE_CONTROL_POLICY: :: + + { + "Root": { + "PolicyTypes": [], + "Name": "Root", + "Id": "r-examplerootid111", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/enable-all-features.rst b/aws/dist/awscli/examples/organizations/enable-all-features.rst new file mode 100755 index 00000000..2365bb5e --- /dev/null +++ b/aws/dist/awscli/examples/organizations/enable-all-features.rst @@ -0,0 +1,30 @@ +**To enable all features in an organization** + +This example shows the administrator asking all the invited accounts in the organization to approve enabled all features in the organization. AWS Organizations sends an email to the address that is registered with every invited member account asking the owner to approve the change to all features by accepting the handshake that is sent. After all invited member accounts accept the handshake, the organization administrator can finalize the change to all features, and those with appropriate permissions can create policies and apply them to roots, OUs, and accounts: :: + + aws organizations enable-all-features + +The output is a handshake object that is sent to all invited member accounts for approval: :: + + { + "Handshake": { + "Action": "ENABLE_ALL_FEATURES", + "Arn":"arn:aws:organizations::111111111111:handshake/o-exampleorgid/enable_all_features/h-examplehandshakeid111", + "ExpirationTimestamp":1.483127868609E9, + "Id":"h-examplehandshakeid111", + "Parties": [ + { + "id":"o-exampleorgid", + "type":"ORGANIZATION" + } + ], + "requestedTimestamp":1.481831868609E9, + "resources": [ + { + "type":"ORGANIZATION", + "value":"o-exampleorgid" + } + ], + "state":"REQUESTED" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/enable-policy-type.rst b/aws/dist/awscli/examples/organizations/enable-policy-type.rst new file mode 100755 index 00000000..cc4ee381 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/enable-policy-type.rst @@ -0,0 +1,21 @@ +**To enable the use of a policy type in a root** + +The following example shows how to enable the service control policy (SCP) policy type in a root: :: + + aws organizations enable-policy-type --root-id r-examplerootid111 --policy-type SERVICE_CONTROL_POLICY + +The output shows a root object with a policyTypes response element showing that SCPs are now enabled: :: + + { + "Root": { + "PolicyTypes": [ + { + "Status":"ENABLED", + "Type":"SERVICE_CONTROL_POLICY" + } + ], + "Id": "r-examplerootid111", + "Name": "Root", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/invite-account-to-organization.rst b/aws/dist/awscli/examples/organizations/invite-account-to-organization.rst new file mode 100755 index 00000000..a5b253cf --- /dev/null +++ b/aws/dist/awscli/examples/organizations/invite-account-to-organization.rst @@ -0,0 +1,52 @@ +**To invite an account to join an organization** + +The following example shows the master account owned by bill@example.com inviting the account owned by juan@example.com to join an organization: :: + + aws organizations invite-account-to-organization --target '{"Type": "EMAIL", "Id": "juan@example.com"}' --notes "This is a request for Juan's account to join Bill's organization." + +The output includes a handshake structure that shows what is sent to the invited account: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/leave-organization.rst b/aws/dist/awscli/examples/organizations/leave-organization.rst new file mode 100755 index 00000000..406aa8cf --- /dev/null +++ b/aws/dist/awscli/examples/organizations/leave-organization.rst @@ -0,0 +1,5 @@ +**To leave an organization as a member account** + +The following example shows the administrator of a member account requesting to leave the organization it is currently a member of: :: + + aws organizations leave-organization diff --git a/aws/dist/awscli/examples/organizations/list-accounts-for-parent.rst b/aws/dist/awscli/examples/organizations/list-accounts-for-parent.rst new file mode 100755 index 00000000..56ffeafa --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-accounts-for-parent.rst @@ -0,0 +1,30 @@ +**To retrieve a list of all of the accounts in a specified parent root or OU** + +The following example shows how to request a list of the accounts in an OU: :: + + aws organizations list-accounts-for-parent --parent-id ou-examplerootid111-exampleouid111 + +The output includes a list of account summary objects. :: + + { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835795.536, + "Id": "333333333333", + "Name": "Development Account", + "Email": "juan@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835812.143, + "Id": "444444444444", + "Name": "Test Account", + "Email": "anika@example.com", + "Status": "ACTIVE" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-accounts.rst b/aws/dist/awscli/examples/organizations/list-accounts.rst new file mode 100755 index 00000000..fe50ef79 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-accounts.rst @@ -0,0 +1,48 @@ +**To retrieve a list of all of the accounts in an organization** + +The following example shows you how to request a list of the accounts in an organization: :: + + aws organizations list-accounts + +The output includes a list of account summary objects. :: + + { + "Accounts": [ + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/111111111111", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481830215.45, + "Id": "111111111111", + "Name": "Master Account", + "Email": "bill@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/222222222222", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835741.044, + "Id": "222222222222", + "Name": "Production Account", + "Email": "alice@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835795.536, + "Id": "333333333333", + "Name": "Development Account", + "Email": "juan@example.com", + "Status": "ACTIVE" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/444444444444", + "JoinedMethod": "INVITED", + "JoinedTimestamp": 1481835812.143, + "Id": "444444444444", + "Name": "Test Account", + "Email": "anika@example.com", + "Status": "ACTIVE" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-children.rst b/aws/dist/awscli/examples/organizations/list-children.rst new file mode 100755 index 00000000..38862e78 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-children.rst @@ -0,0 +1,20 @@ +**To retrieve the child accounts and OUs of a parent OU or root** + +The following example you how to list the root or OU that contains that account 444444444444: :: + + aws organizations list-children --child-type ORGANIZATIONAL_UNIT --parent-id ou-examplerootid111-exampleouid111 + +The output shows the two child OUs that are contained by the parent: :: + + { + "Children": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type":"ORGANIZATIONAL_UNIT" + }, + { + "Id":"ou-examplerootid111-exampleouid222", + "Type":"ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-create-account-status.rst b/aws/dist/awscli/examples/organizations/list-create-account-status.rst new file mode 100755 index 00000000..1a79830e --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-create-account-status.rst @@ -0,0 +1,39 @@ +**Example 1: To retrieve a list of the account creation requests made in the current organization** + +The following example shows how to request a list of account creation requests for an organization that have completed successfully: :: + + aws organizations list-create-account-status --states SUCCEEDED + +The output includes an array of objects with information about each request. :: + + { + "CreateAccountStatuses": [ + { + "AccountId": "444444444444", + "AccountName": "Developer Test Account", + "CompletedTimeStamp": 1481835812.143, + "Id": "car-examplecreateaccountrequestid111", + "RequestedTimeStamp": 1481829432.531, + "State": "SUCCEEDED" + } + ] + } + +**Example 2: To retrieve a list of the in progress account creation requests made in the current organization** + +The following example gets a list of in-progress account creation requests for an organization: :: + + aws organizations list-create-account-status --states IN_PROGRESS + +The output includes an array of objects with information about each request. :: + + { + "CreateAccountStatuses": [ + { + "State": "IN_PROGRESS", + "Id": "car-examplecreateaccountrequestid111", + "RequestedTimeStamp": 1481829432.531, + "AccountName": "Production Account" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-handshakes-for-account.rst b/aws/dist/awscli/examples/organizations/list-handshakes-for-account.rst new file mode 100755 index 00000000..83d1c514 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-handshakes-for-account.rst @@ -0,0 +1,52 @@ +**To retrieve a list of the handshakes sent to an account** + +The following example shows how to get a list of all handshakes that are associated with the account of the credentials that were used to call the operation: :: + + aws organizations list-handshakes-for-account + +The output includes a list of handshake structures with information about each handshake including its current state: :: + + { + "Handshake": { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + } + ], + "State": "OPEN" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-handshakes-for-organization.rst b/aws/dist/awscli/examples/organizations/list-handshakes-for-organization.rst new file mode 100755 index 00000000..6190af63 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-handshakes-for-organization.rst @@ -0,0 +1,100 @@ +**To retrieve a list of the handshakes associated with an organization** + +The following example shows how to get a list of handshakes that are associated with the current organization: :: + + aws organizations list-handshakes-for-organization + +The output shows two handshakes. The first one is an invitation to Juan's account and shows a state of OPEN. The second is an invitation to Anika's account and shows a state of ACCEPTED: :: + + { + "Handshakes": [ + { + "Action": "INVITE", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1482952459.257, + "Id": "h-examplehandshakeid111", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "juan@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1481656459.257, + "Resources": [ + { + "Resources": [ + { + "Type": "MASTER_EMAIL", + "Value": "bill@amazon.com" + }, + { + "Type": "MASTER_NAME", + "Value": "Org Master Account" + }, + { + "Type": "ORGANIZATION_FEATURE_SET", + "Value": "FULL" + } + ], + "Type": "ORGANIZATION", + "Value": "o-exampleorgid" + }, + { + "Type": "EMAIL", + "Value": "juan@example.com" + }, + { + "Type":"NOTES", + "Value":"This is an invitation to Juan's account to join Bill's organization." + } + ], + "State": "OPEN" + }, + { + "Action": "INVITE", + "State":"ACCEPTED", + "Arn": "arn:aws:organizations::111111111111:handshake/o-exampleorgid/invite/h-examplehandshakeid111", + "ExpirationTimestamp": 1.471797437427E9, + "Id": "h-examplehandshakeid222", + "Parties": [ + { + "Id": "o-exampleorgid", + "Type": "ORGANIZATION" + }, + { + "Id": "anika@example.com", + "Type": "EMAIL" + } + ], + "RequestedTimestamp": 1.469205437427E9, + "Resources": [ + { + "Resources": [ + { + "Type":"MASTER_EMAIL", + "Value":"bill@example.com" + }, + { + "Type":"MASTER_NAME", + "Value":"Master Account" + } + ], + "Type":"ORGANIZATION", + "Value":"o-exampleorgid" + }, + { + "Type":"EMAIL", + "Value":"anika@example.com" + }, + { + "Type":"NOTES", + "Value":"This is an invitation to Anika's account to join Bill's organization." + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-organizational-units-for-parent.rst b/aws/dist/awscli/examples/organizations/list-organizational-units-for-parent.rst new file mode 100755 index 00000000..4dd5c279 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-organizational-units-for-parent.rst @@ -0,0 +1,20 @@ +**To retrieve a list of the OUs in a parent OU or root** + +The following example shows you how to get a list of OUs in a specified root: :: + + aws organizations list-organizational-units-for-parent --parent-id r-examplerootid111 + +The output shows that the specified root contains two OUs and shows details of each: :: + + { + "OrganizationalUnits": [ + { + "Name": "AccountingDepartment", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid111" + }, + { + "Name": "ProductionDepartment", + "Arn": "arn:aws:organizations::o-exampleorgid:ou/r-examplerootid111/ou-examplerootid111-exampleouid222" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-parents.rst b/aws/dist/awscli/examples/organizations/list-parents.rst new file mode 100755 index 00000000..b792b1e8 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-parents.rst @@ -0,0 +1,17 @@ +**To list the parent OUs or roots for an account or child OU** + +The following example you how to list the root or parent OU that contains that account 444444444444: :: + + aws organizations list-parents --child-id 444444444444 + + +The output shows that the specified account is in the OU with specified ID: :: + + { + "Parents": [ + { + "Id": "ou-examplerootid111-exampleouid111", + "Type": "ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-policies-for-target.rst b/aws/dist/awscli/examples/organizations/list-policies-for-target.rst new file mode 100755 index 00000000..cab1aa77 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-policies-for-target.rst @@ -0,0 +1,20 @@ +**To retrieve a list of the SCPs attached directly to an account** + +The following example shows how to get a list of all service control policies (SCPs), as specified by the Filter parameter, that are directly attached to an account: :: + + aws organizations list-policies-for-target --filter SERVICE_CONTROL_POLICY --target-id 444444444444 + +The output includes a list of policy structures with summary information about the policies. The list does not include policies that apply to the account because of inheritance from its location in an OU hierarchy: :: + + { + "Policies": [ + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllEC2Actions", + "AwsManaged", false, + "Id": "p-examplepolicyid222", + "Arn": "arn:aws:organizations::o-exampleorgid:policy/service_control_policy/p-examplepolicyid222", + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-policies.rst b/aws/dist/awscli/examples/organizations/list-policies.rst new file mode 100755 index 00000000..5fcb5cbb --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-policies.rst @@ -0,0 +1,36 @@ +**To retrieve a list of all policies in an organization of a certain type** + +The following example shows you how to get a list of SCPs, as specified by the filter parameter: :: + + aws organizations list-policies --filter SERVICE_CONTROL_POLICY + +The output includes a list of policies with summary information: :: + + { + "Policies": [ + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllS3Actions", + "AwsManaged": false, + "Id": "p-examplepolicyid111", + "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid111", + "Description": "Enables account admins to delegate permissions for any S3 actions to users and roles in their accounts." + }, + { + "Type": "SERVICE_CONTROL_POLICY", + "Name": "AllowAllEC2Actions", + "AwsManaged": false, + "Id": "p-examplepolicyid222", + "Arn": "arn:aws:organizations::111111111111:policy/service_control_policy/p-examplepolicyid222", + "Description": "Enables account admins to delegate permissions for any EC2 actions to users and roles in their accounts." + }, + { + "AwsManaged": true, + "Description": "Allows access to every operation", + "Type": "SERVICE_CONTROL_POLICY", + "Id": "p-FullAWSAccess", + "Arn": "arn:aws:organizations::aws:policy/service_control_policy/p-FullAWSAccess", + "Name": "FullAWSAccess" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-roots.rst b/aws/dist/awscli/examples/organizations/list-roots.rst new file mode 100755 index 00000000..a1ba4f8f --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-roots.rst @@ -0,0 +1,23 @@ +**To retrieve a list of the roots in an organization** + +This example shows you how to get the list of roots for an organization: :: + + aws organizations list-roots + +The output includes a list of root structures with summary information: :: + + { + "Roots": [ + { + "Name": "Root", + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Id": "r-examplerootid111", + "PolicyTypes": [ + { + "Status":"ENABLED", + "Type":"SERVICE_CONTROL_POLICY" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/list-targets-for-policy.rst b/aws/dist/awscli/examples/organizations/list-targets-for-policy.rst new file mode 100755 index 00000000..e6da3822 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/list-targets-for-policy.rst @@ -0,0 +1,30 @@ +**To retrieve a list of the roots, OUs, and accounts that a policy is attached to** + +The following example shows how to get a list of the roots, OUs, and accounts that the specified policy is attached to: :: + + aws organizations list-targets-for-policy --policy-id p-FullAWSAccess + +The output includes a list of attachment objects with summary information about the roots, OUs, and accounts the policy is attached to: :: + + { + "Targets": [ + { + "Arn": "arn:aws:organizations::111111111111:root/o-exampleorgid/r-examplerootid111", + "Name": "Root", + "TargetId":"r-examplerootid111", + "Type":"ROOT" + }, + { + "Arn": "arn:aws:organizations::111111111111:account/o-exampleorgid/333333333333;", + "Name": "Developer Test Account", + "TargetId": "333333333333", + "Type": "ACCOUNT" + }, + { + "Arn":"arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111", + "Name":"Accounting", + "TargetId":"ou-examplerootid111-exampleouid111", + "Type":"ORGANIZATIONAL_UNIT" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/move-account.rst b/aws/dist/awscli/examples/organizations/move-account.rst new file mode 100755 index 00000000..910930db --- /dev/null +++ b/aws/dist/awscli/examples/organizations/move-account.rst @@ -0,0 +1,5 @@ +**To move an account between roots or OUs** + +The following example shows you how to move the master account in the organization from the root to an OU: :: + + aws organizations move-account --account-id 333333333333 --source-parent-id r-examplerootid111 --destination-parent-id ou-examplerootid111-exampleouid111 \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/remove-account-from-organization.rst b/aws/dist/awscli/examples/organizations/remove-account-from-organization.rst new file mode 100755 index 00000000..e785fe91 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/remove-account-from-organization.rst @@ -0,0 +1,5 @@ +**To remove an account from an organization as the master account** + +The following example shows you how to remove an account from an organization: :: + + aws organizations remove-account-from-organization --account-id 333333333333 diff --git a/aws/dist/awscli/examples/organizations/update-organizational-unit.rst b/aws/dist/awscli/examples/organizations/update-organizational-unit.rst new file mode 100755 index 00000000..22ad211a --- /dev/null +++ b/aws/dist/awscli/examples/organizations/update-organizational-unit.rst @@ -0,0 +1,15 @@ +**To rename an OU** + +This example shows you how to rename an OU: In this example, the OU is renamed "AccountingOU": :: + + aws organizations update-organizational-unit --organizational-unit-id ou-examplerootid111-exampleouid111 --name AccountingOU + +The output shows the new name: :: + + { + "OrganizationalUnit": { + "Id": "ou-examplerootid111-exampleouid111" + "Name": "AccountingOU", + "Arn": "arn:aws:organizations::111111111111:ou/o-exampleorgid/ou-examplerootid111-exampleouid111"" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/organizations/update-policy.rst b/aws/dist/awscli/examples/organizations/update-policy.rst new file mode 100755 index 00000000..ce1c3b68 --- /dev/null +++ b/aws/dist/awscli/examples/organizations/update-policy.rst @@ -0,0 +1,48 @@ +**Example 1: To rename a policy** + +The following ``update-policy`` example renames a policy and gives it a new description. :: + + aws organizations update-policy \ + --policy-id p-examplepolicyid111 \ + --name Renamed-Policy \ + --description "This description replaces the original." + +The output shows the new name and description. :: + + { + "Policy": { + "Content": "{\n \"Version\":\"2012-10-17\",\n \"Statement\":{\n \"Effect\":\"Allow\",\n \"Action\":\"ec2:*\",\n \"Resource\":\"*\"\n }\n}\n", + "PolicySummary": { + "Id": "p-examplepolicyid111", + "AwsManaged": false, + "Arn":"arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "Description": "This description replaces the original.", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + } + +**Example 2: To replace a policy's JSON text content** + +The following example shows you how to replace the JSON text of the SCP in the previous example with a new JSON policy text string that allows S3 instead of EC2: :: + + aws organizations update-policy \ + --policy-id p-examplepolicyid111 \ + --content "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}" + +The output shows the new content:: + + { + "Policy": { + "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"s3:*\", \"Resource\": \"*\" } }", + "PolicySummary": { + "Arn": "arn:aws:organizations::111111111111:policy/o-exampleorgid/service_control_policy/p-examplepolicyid111", + "AwsManaged": false; + "Description": "This description replaces the original.", + "Id": "p-examplepolicyid111", + "Name": "Renamed-Policy", + "Type": "SERVICE_CONTROL_POLICY" + } + } + } diff --git a/aws/dist/awscli/examples/pi/describe-dimension-keys.rst b/aws/dist/awscli/examples/pi/describe-dimension-keys.rst new file mode 100644 index 00000000..f85b4771 --- /dev/null +++ b/aws/dist/awscli/examples/pi/describe-dimension-keys.rst @@ -0,0 +1,56 @@ +**To describe dimension keys** + +This example requests the names of all wait events. The data is summarized by event name, and the aggregate values of those events over the specified time period. + +Command:: + + aws pi describe-dimension-keys --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --metric db.load.avg --group-by '{"Group":"db.wait_event"}' + +Output:: + + { + "AlignedEndTime": 1.5270804E9, + "AlignedStartTime": 1.5270264E9, + "Keys": [ + { + "Dimensions": {"db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex"}, + "Total": 0.05906906851195666 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/aurora_redo_log_flush"}, + "Total": 0.015824722186149193 + }, + { + "Dimensions": {"db.wait_event.name": "CPU"}, + "Total": 0.008014396230265477 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/aurora_respond_to_client"}, + "Total": 0.0036361612526204477 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/table/sql/handler"}, + "Total": 0.0019108398419382965 + }, + { + "Dimensions": {"db.wait_event.name": "wait/synch/cond/mysys/my_thread_var::suspend"}, + "Total": 8.533847837782684E-4 + }, + { + "Dimensions": {"db.wait_event.name": "wait/io/file/csv/data"}, + "Total": 6.864181956477376E-4 + }, + { + "Dimensions": {"db.wait_event.name": "Unknown"}, + "Total": 3.895887056379051E-4 + }, + { + "Dimensions": {"db.wait_event.name": "wait/synch/mutex/sql/FILE_AS_TABLE::LOCK_shim_lists"}, + "Total": 3.710368625122906E-5 + }, + { + "Dimensions": {"db.wait_event.name": "wait/lock/table/sql/handler"}, + "Total": 0 + } + ] + } diff --git a/aws/dist/awscli/examples/pi/get-resource-metrics.rst b/aws/dist/awscli/examples/pi/get-resource-metrics.rst new file mode 100644 index 00000000..71d5cf02 --- /dev/null +++ b/aws/dist/awscli/examples/pi/get-resource-metrics.rst @@ -0,0 +1,67 @@ +**To get resource metrics** + +This example requests data points for the *db.wait_event* dimension group, and for the *db.wait_event.name* dimension within that group. In the response, the relevant data points are grouped by the requested dimension (*db.wait_event.name*). + + + +Command:: + + aws pi get-resource-metrics --service-type RDS --identifier db-LKCGOBK26374TPTDFXOIWVCPPM --start-time 1527026400 --end-time 1527080400 --period-in-seconds 300 --metric db.load.avg --metric-queries file://metric-queries.json + +The arguments for ``--metric-queries`` are stored in a JSON file, ``metric-queries.json``. Here are the contents of that file:: + + [ + { + "Metric": "db.load.avg", + "GroupBy": { + "Group":"db.wait_event" + } + } + ] + + +Output:: + + { + "AlignedEndTime": 1.5270804E9, + "AlignedStartTime": 1.5270264E9, + "Identifier": "db-LKCGOBK26374TPTDFXOIWVCPPM", + "MetricList": [ + { + "Key": { + "Metric": "db.load.avg" + }, + "DataPoints": [ + { + "Timestamp": 1527026700.0, + "Value": 1.3533333333333333 + }, + { + "Timestamp": 1527027000.0, + "Value": 0.88 + }, + <...remaining output omitted...> + ] + }, + { + "Key": { + "Metric": "db.load.avg", + "Dimensions": { + "db.wait_event.name": "wait/synch/mutex/innodb/aurora_lock_thread_slot_futex" + } + }, + "DataPoints": [ + { + "Timestamp": 1527026700.0, + "Value": 0.8566666666666667 + }, + { + "Timestamp": 1527027000.0, + "Value": 0.8633333333333333 + }, + <...remaining output omitted...> + ], + }, + <...remaining output omitted...> + ] + } diff --git a/aws/dist/awscli/examples/pinpoint/create-app.rst b/aws/dist/awscli/examples/pinpoint/create-app.rst new file mode 100755 index 00000000..a3cbf3a7 --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/create-app.rst @@ -0,0 +1,37 @@ +**Example 1: To create an application** + +The following ``create-app`` example creates a new application (project). :: + + aws pinpoint create-app \ + --create-application-request Name=ExampleCorp + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": {} + } + } + +**Example 2: To create an application that is tagged** + +The following ``create-app`` example creates a new application (project) and associates a tag (key and value) with the application. :: + + aws pinpoint create-app \ + --create-application-request Name=ExampleCorp,tags={"Stack"="Test"} + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": { + "Stack": "Test" + } + } + } diff --git a/aws/dist/awscli/examples/pinpoint/delete-app.rst b/aws/dist/awscli/examples/pinpoint/delete-app.rst new file mode 100755 index 00000000..03137516 --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/delete-app.rst @@ -0,0 +1,17 @@ +**To delete an application** + +The following ``delete-app`` example deletes an application (project). :: + + aws pinpoint delete-app \ + --application-id 810c7aab86d42fb2b56c8c966example + +Output:: + + { + "ApplicationResponse": { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": {} + } + } diff --git a/aws/dist/awscli/examples/pinpoint/get-apps.rst b/aws/dist/awscli/examples/pinpoint/get-apps.rst new file mode 100755 index 00000000..f26a4a48 --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/get-apps.rst @@ -0,0 +1,41 @@ +**To retrieve information about all of your applications** + +The following ``get-apps`` example retrieves information about all of your applications (projects). :: + + aws pinpoint get-apps + +Output:: + + { + "ApplicationsResponse": { + "Item": [ + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example", + "Id": "810c7aab86d42fb2b56c8c966example", + "Name": "ExampleCorp", + "tags": { + "Year": "2019", + "Stack": "Production" + } + }, + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/42d8c7eb0990a57ba1d5476a3example", + "Id": "42d8c7eb0990a57ba1d5476a3example", + "Name": "AnyCompany", + "tags": {} + }, + { + "Arn": "arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/80f5c382b638ffe5ad12376bbexample", + "Id": "80f5c382b638ffe5ad12376bbexample", + "Name": "ExampleCorp_Test", + "tags": { + "Year": "2019", + "Stack": "Test" + } + } + ], + "NextToken": "eyJDcmVhdGlvbkRhdGUiOiIyMDE5LTA3LTE2VDE0OjM4OjUzLjkwM1oiLCJBY2NvdW50SWQiOiI1MTIzOTcxODM4NzciLCJBcHBJZCI6Ijk1ZTM2MGRiMzBkMjQ1ZjRiYTYwYjhlMzllMzZlNjZhIn0" + } + } + +The presence of the ``NextToken`` response value indicates that there is more output available. Call the command again and supply that value as the ``NextToken`` input parameter. diff --git a/aws/dist/awscli/examples/pinpoint/list-tags-for-resource.rst b/aws/dist/awscli/examples/pinpoint/list-tags-for-resource.rst new file mode 100755 index 00000000..8500592a --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/list-tags-for-resource.rst @@ -0,0 +1,19 @@ +**To retrieve a list of tags for a resource** + +The following ``list-tags-for-resource`` example retrieves all the tags (key names and values) that are associated with the specified resource. :: + + aws pinpoint list-tags-for-resource \ + --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example + +Output:: + + { + "TagsModel": { + "tags": { + "Year": "2019", + "Stack": "Production" + } + } + } + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/pinpoint/tag-resource.rst b/aws/dist/awscli/examples/pinpoint/tag-resource.rst new file mode 100755 index 00000000..7bb104b1 --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/tag-resource.rst @@ -0,0 +1,11 @@ +**To add tags to a resource** + +The following example adds two tags (key names and values) to a resource. :: + + aws pinpoint list-tags-for-resource \ + --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tags-model tags={Stack=Production,Year=2019} + +This command produces no output. + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/pinpoint/untag-resource.rst b/aws/dist/awscli/examples/pinpoint/untag-resource.rst new file mode 100755 index 00000000..3f9d90a5 --- /dev/null +++ b/aws/dist/awscli/examples/pinpoint/untag-resource.rst @@ -0,0 +1,21 @@ +**Example 1: To remove a tag from a resource** + +The following ``untag-resource`` example removes the specified tag (key name and value) from a resource. :: + + aws pinpoint untag-resource \ + --resource-arn arn:aws:mobiletargeting:us-west-2:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tag-keys Year + +This command produces no output. + +**Example 2: To remove multiple tags from a resource** + +The following ``untag-resource`` example removes the specified tags (key names and values) from a resource. :: + + aws pinpoint untag-resource \ + --resource-arn arn:aws:mobiletargeting:us-east-1:AIDACKCEVSQ6C2EXAMPLE:apps/810c7aab86d42fb2b56c8c966example \ + --tag-keys Year Stack + +This command produces no output. + +For more information, see 'Tagging Amazon Pinpoint Resources '__ in the *Amazon Pinpoint Developer Guide*. diff --git a/aws/dist/awscli/examples/pricing/describe-services.rst b/aws/dist/awscli/examples/pricing/describe-services.rst new file mode 100644 index 00000000..c21e3124 --- /dev/null +++ b/aws/dist/awscli/examples/pricing/describe-services.rst @@ -0,0 +1,82 @@ +**To retrieve service metadata** + +This example retrieves the metadata for the Amazon EC2 service code. + +Command:: + + aws pricing describe-services --service-code AmazonEC2 --format-version aws_v1 --max-items 1 + +Output:: + + { + "Services": [ + { + "ServiceCode": "AmazonEC2", + "AttributeNames": [ + "volumeType", + "maxIopsvolume", + "instance", + "instanceCapacity10xlarge", + "locationType", + "instanceFamily", + "operatingSystem", + "clockSpeed", + "LeaseContractLength", + "ecu", + "networkPerformance", + "instanceCapacity8xlarge", + "group", + "maxThroughputvolume", + "gpuMemory", + "ebsOptimized", + "elasticGpuType", + "maxVolumeSize", + "gpu", + "processorFeatures", + "intelAvxAvailable", + "instanceCapacity4xlarge", + "servicecode", + "groupDescription", + "processorArchitecture", + "physicalCores", + "productFamily", + "enhancedNetworkingSupported", + "intelTurboAvailable", + "memory", + "dedicatedEbsThroughput", + "vcpu", + "OfferingClass", + "instanceCapacityLarge", + "capacitystatus", + "termType", + "storage", + "intelAvx2Available", + "storageMedia", + "physicalProcessor", + "provisioned", + "servicename", + "PurchaseOption", + "instanceCapacity18xlarge", + "instanceType", + "tenancy", + "usagetype", + "normalizationSizeFactor", + "instanceCapacity2xlarge", + "instanceCapacity16xlarge", + "maxIopsBurstPerformance", + "instanceCapacity12xlarge", + "instanceCapacity32xlarge", + "instanceCapacityXlarge", + "licenseModel", + "currentGeneration", + "preInstalledSw", + "location", + "instanceCapacity24xlarge", + "instanceCapacity9xlarge", + "instanceCapacityMedium", + "operation" + ] + } + ], + "FormatVersion": "aws_v1" + } diff --git a/aws/dist/awscli/examples/pricing/get-attribute-values.rst b/aws/dist/awscli/examples/pricing/get-attribute-values.rst new file mode 100644 index 00000000..339767af --- /dev/null +++ b/aws/dist/awscli/examples/pricing/get-attribute-values.rst @@ -0,0 +1,22 @@ +**To retrieve a list of attribute values** + +The following ``get-attribute-values`` example retrieves a list of values available for the given attribute. :: + + aws pricing get-attribute-values \ + --service-code AmazonEC2 \ + --attribute-name volumeType \ + --max-items 2 + +Output:: + + { + "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==", + "AttributeValues": [ + { + "Value": "Cold HDD" + }, + { + "Value": "General Purpose" + } + ] + } diff --git a/aws/dist/awscli/examples/pricing/get-products.rst b/aws/dist/awscli/examples/pricing/get-products.rst new file mode 100644 index 00000000..34eba01b --- /dev/null +++ b/aws/dist/awscli/examples/pricing/get-products.rst @@ -0,0 +1,32 @@ +**To retrieve a list of products** + +This example retrieves a list of products that match the given criteria. + +Command:: + + aws pricing get-products --filters file://filters.json --format-version aws_v1 --max-results 1 --service-code AmazonEC2 + +filters.json:: + + [ + { + "Type": "TERM_MATCH", + "Field": "ServiceCode", + "Value": "AmazonEC2" + }, + { + "Type": "TERM_MATCH", + "Field": "volumeType", + "Value": "Provisioned IOPS" + } + ] + +Output:: + + { + "FormatVersion": "aws_v1", + "NextToken": "WGDY7ko8fQXdlaUZVdasFQ==:RVSagyIFn770XQOzdUIcO9BY6ucBG9itXAZGZF/zioUzOsUKh6PCcPWaOyPZRiMePb986TeoKYB9l55fw/CyoMq5ymnGmT1Vj39TljbbAlhcqnVfTmPIilx8Uy5bdDaBYy/e/2Ofw9Edzsykbs8LTBuNbiDQ+BBds5yeI9AQkUepruKk3aEahFPxJ55kx/zk", + "PriceList": [ + "{\"product\":{\"productFamily\":\"Storage\",\"attributes\":{\"storageMedia\":\"SSD-backed\",\"maxThroughputvolume\":\"320 MB/sec\",\"volumeType\":\"Provisioned IOPS\",\"maxIopsvolume\":\"20000\",\"servicecode\":\"AmazonEC2\",\"usagetype\":\"APS1-EBS:VolumeUsage.piops\",\"locationType\":\"AWS Region\",\"location\":\"Asia Pacific (Singapore)\",\"servicename\":\"Amazon Elastic Compute Cloud\",\"maxVolumeSize\":\"16 TiB\",\"operation\":\"\"},\"sku\":\"3MKHN58N7RDDVGKJ\"},\"serviceCode\":\"AmazonEC2\",\"terms\":{\"OnDemand\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF\":{\"priceDimensions\":{\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\":{\"unit\":\"GB-Mo\",\"endRange\":\"Inf\",\"description\":\"$0.138 per GB-month of Provisioned IOPS SSD (io1) provisioned storage - Asia Pacific (Singapore)\",\"appliesTo\":[],\"rateCode\":\"3MKHN58N7RDDVGKJ.JRTCKXETXF.6YS6EN2CT7\",\"beginRange\":\"0\",\"pricePerUnit\":{\"USD\":\"0.1380000000\"}}},\"sku\":\"3MKHN58N7RDDVGKJ\",\"effectiveDate\":\"2018-08-01T00:00:00Z\",\"offerTermCode\":\"JRTCKXETXF\",\"termAttributes\":{}}}},\"version\":\"20180808005701\",\"publicationDate\":\"2018-08-08T00:57:01Z\"}" + ] + } diff --git a/aws/dist/awscli/examples/qldb/create-ledger.rst b/aws/dist/awscli/examples/qldb/create-ledger.rst new file mode 100644 index 00000000..fb9cb547 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/create-ledger.rst @@ -0,0 +1,40 @@ +**Example 1: To create a ledger with default properties** + +The following ``create-ledger`` example creates a ledger with the name ``myExampleLedger`` and the permissions mode ``ALLOW_ALL``. The optional parameter for deletion protection is not specified, so it defaults to ``true``. :: + + aws qldb create-ledger \ + --name myExampleLedger \ + --permissions-mode ALLOW_ALL + +Output:: + + { + "State": "CREATING", + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "DeletionProtection": true, + "CreationDateTime": 1568839243.951, + "Name": "myExampleLedger" + } + +**Example 2: To create a ledger with deletion protection disabled and with specified tags** + +The following ``create-ledger`` example creates a ledger with the name ``myExampleLedger2`` and the permissions mode ``ALLOW_ALL``. The deletion protection feature is disabled, and the specified tags are attached to the resource. :: + + aws qldb create-ledger \ + --name myExampleLedger \ + --no-deletion-protection \ + --permissions-mode ALLOW_ALL \ + --tags IsTest=true,Domain=Test + +Output:: + + { + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger2", + "DeletionProtection": false, + "CreationDateTime": 1568839543.557, + "State": "CREATING", + "Name": "myExampleLedger2" + } + + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/delete-ledger.rst b/aws/dist/awscli/examples/qldb/delete-ledger.rst new file mode 100644 index 00000000..f8b8dca5 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/delete-ledger.rst @@ -0,0 +1,10 @@ +**To delete a ledger** + +The following ``delete-ledger`` example deletes the specified ledger. :: + + aws qldb delete-ledger \ + --name myExampleLedger + +This command produces no output. + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/describe-journal-s3-export.rst b/aws/dist/awscli/examples/qldb/describe-journal-s3-export.rst new file mode 100644 index 00000000..5c20514b --- /dev/null +++ b/aws/dist/awscli/examples/qldb/describe-journal-s3-export.rst @@ -0,0 +1,30 @@ +**To describe a journal export job** + +The following ``describe-journal-s3-export`` example displays the details for the specified export job from a ledger. :: + + aws qldb describe-journal-s3-export \ + --name myExampleLedger \ + --export-id ADR2ONPKN5LINYGb4dp7yZ + +Output:: + + { + "ExportDescription": { + "S3ExportConfiguration": { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "Status": "COMPLETED", + "ExportCreationTime": 1568847801.418, + "InclusiveStartTime": 1568764800.0, + "ExclusiveEndTime": 1568847599.0, + "LedgerName": "myExampleLedger", + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ" + } + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/describe-ledger.rst b/aws/dist/awscli/examples/qldb/describe-ledger.rst new file mode 100644 index 00000000..1acf005d --- /dev/null +++ b/aws/dist/awscli/examples/qldb/describe-ledger.rst @@ -0,0 +1,18 @@ +**To describe a ledger** + +The following ``describe-ledger`` example displays the details for the specified ledger. :: + + aws qldb describe-ledger \ + --name myExampleLedger + +Output:: + + { + "CreationDateTime": 1568839243.951, + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "State": "ACTIVE", + "Name": "myExampleLedger", + "DeletionProtection": true + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/export-journal-to-s3.rst b/aws/dist/awscli/examples/qldb/export-journal-to-s3.rst new file mode 100644 index 00000000..f935178c --- /dev/null +++ b/aws/dist/awscli/examples/qldb/export-journal-to-s3.rst @@ -0,0 +1,28 @@ +**To export journal blocks to S3** + +The following ``export-journal-to-s3`` example creates an export job for journal blocks within a specified date and time range from a ledger with the name ``myExampleLedger``. The export job writes the blocks into a specified Amazon S3 bucket. :: + + aws qldb export-journal-to-s3 \ + --name myExampleLedger \ + --inclusive-start-time 2019-09-18T00:00:00Z \ + --exclusive-end-time 2019-09-18T22:59:59Z \ + --role-arn arn:aws:iam::123456789012:role/my-s3-export-role \ + --s3-export-configuration file://my-s3-export-config.json + +Contents of ``my-s3-export-config.json``:: + + { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + } + +Output:: + + { + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ" + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/get-block.rst b/aws/dist/awscli/examples/qldb/get-block.rst new file mode 100644 index 00000000..43c5a8ee --- /dev/null +++ b/aws/dist/awscli/examples/qldb/get-block.rst @@ -0,0 +1,33 @@ +**To get a journal block and proof for verification** + +The following ``get-block`` example requests a block data object and a proof from the specified ledger. The request is for a specified digest tip address and block address. :: + + aws qldb get-block \ + --name vehicle-registration \ + --block-address file://myblockaddress.json \ + --digest-tip-address file://mydigesttipaddress.json + +Contents of ``myblockaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}" + } + +Contents of ``mydigesttipaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + +Output:: + + { + "Block": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},transactionId:\"FnQeJBAicTX0Ah32ZnVtSX\",blockTimestamp:2019-09-16T19:37:05.360Z,blockHash:{{NoChM92yKRuJAb/jeLd1VnYn4DHiWIf071ACfic9uHc=}},entriesHash:{{l05LOsiKV14SDbuaYnH7uwXzUvqzIwUiRLXGbTyj/nY=}},previousBlockHash:{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},entriesHashList:[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},{{y5cCBr7pOAIUfsVQ1j0TqtE97b4b4oo1R0vnYyE5wWM=}},{{TvTXygML1bMe6NvEZtGkX+KR+W/EJl4qD1mmV77KZQg=}}],transactionInfo:{statements:[{statement:\"FROM VehicleRegistration AS r \\nWHERE r.VIN = '1N4AL11D75C109151'\\nINSERT INTO r.Owners.SecondaryOwners\\n VALUE { 'PersonId' : 'CMVdR77XP8zAglmmFDGTvt' }\",startTime:2019-09-16T19:37:05.302Z,statementDigest:{{jcgPX2vsOJ0waum4qmDYtn1pCAT9xKNIzA+2k4R+mxA=}}}],documents:{JUJgkIcNbhS2goq8RqLuZ4:{tableName:\"VehicleRegistration\",tableId:\"BFJKdXgzt9oF4wjMbuxy4G\",statements:[0]}}},revisions:[{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}]}" + }, + "Proof": { + "IonText": "[{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/get-digest.rst b/aws/dist/awscli/examples/qldb/get-digest.rst new file mode 100644 index 00000000..530a7b32 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/get-digest.rst @@ -0,0 +1,17 @@ +**To get a digest for a ledger** + +The following ``get-digest`` example requests a digest from the specified ledger at the latest committed block in the journal. :: + + aws qldb get-digest \ + --name vehicle-registration + +Output:: + + { + "Digest": "6m6BMXobbJKpMhahwVthAEsN6awgnHK62Qq5McGP1Gk=", + "DigestTipAddress": { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/get-revision.rst b/aws/dist/awscli/examples/qldb/get-revision.rst new file mode 100644 index 00000000..78beaf7f --- /dev/null +++ b/aws/dist/awscli/examples/qldb/get-revision.rst @@ -0,0 +1,34 @@ +**To get a document revision and proof for verification** + +The following ``get-revision`` example requests a revision data object and a proof from the specified ledger. The request is for a specified digest tip address, document ID, and block address of the revision. :: + + aws qldb get-revision \ + --name vehicle-registration \ + --block-address file://myblockaddress.json \ + --document-id JUJgkIcNbhS2goq8RqLuZ4 \ + --digest-tip-address file://mydigesttipaddress.json + +Contents of ``myblockaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100}" + } + +Contents of ``mydigesttipaddress.json``:: + + { + "IonText": "{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:123}" + } + +Output:: + + { + "Revision": { + "IonText": "{blockAddress:{strandId:\"KmA3ZZca7vAIiJAK9S5Iwl\",sequenceNo:100},hash:{{mHVex/yjHAWjFPpwhBuH2GKXmKJjK2FBa9faqoUVNtg=}},data:{VIN:\"1N4AL11D75C109151\",LicensePlateNumber:\"LEWISR261LL\",State:\"WA\",PendingPenaltyTicketAmount:90.25,ValidFromDate:2017-08-21,ValidToDate:2020-05-11,Owners:{PrimaryOwner:{PersonId:\"BFJKdXhnLRT27sXBnojNGW\"},SecondaryOwners:[{PersonId:\"CMVdR77XP8zAglmmFDGTvt\"}]},City:\"Everett\"},metadata:{id:\"JUJgkIcNbhS2goq8RqLuZ4\",version:3,txTime:2019-09-16T19:37:05.344Z,txId:\"FnQeJBAicTX0Ah32ZnVtSX\"}}" + }, + "Proof": { + "IonText": "[{{eRSwnmAM7WWANWDd5iGOyK+T4tDXyzUq6HZ/0fgLHos=}},{{VV1rdaNuf+yJZVGlmsM6gr2T52QvBO8Lg+KgpjcnWAU=}},{{7kewBXhpdbClcZKxhVmpoMHpUGOJtWQD0iY2LPfZkYA=}},{{l3+EXs69K1+rehlqyWLkt+oHDlw4Zi9pCLW/t/mgTPM=}},{{48CXG3ehPqsxCYd34EEa8Fso0ORpWWAO8010RJKf3Do=}},{{9UnwnKSQT0i3ge1JMVa+tMIqCEDaOPTkWxmyHSn8UPQ=}},{{3nW6Vryghk+7pd6wFCtLufgPM6qXHyTNeCb1sCwcDaI=}},{{Irb5fNhBrNEQ1VPhzlnGT/ZQPadSmgfdtMYcwkNOxoI=}},{{+3CWpYG/ytf/vq9GidpzSx6JJiLXt1hMQWNnqOy3jfY=}},{{NPx6cRhwsiy5m9UEWS5JTJrZoUdO2jBOAAOmyZAT+qE=}}]" + } + } + +For more information, see `Data Verification in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst b/aws/dist/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst new file mode 100644 index 00000000..14b784d7 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/list-journal-s3-exports-for-ledger.rst @@ -0,0 +1,31 @@ +**To list journal export jobs for a ledger** + +The following ``list-journal-s3-exports-for-ledger`` example lists journal export jobs for the specified ledger. :: + + aws qldb list-journal-s3-exports-for-ledger \ + --name myExampleLedger + +Output:: + + { + "JournalS3Exports": [ + { + "LedgerName": "myExampleLedger", + "ExclusiveEndTime": 1568847599.0, + "ExportCreationTime": 1568847801.418, + "S3ExportConfiguration": { + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/", + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + } + }, + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ", + "RoleArn": "arn:aws:iam::123456789012:role/qldb-s3-export", + "InclusiveStartTime": 1568764800.0, + "Status": "IN_PROGRESS" + } + ] + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. \ No newline at end of file diff --git a/aws/dist/awscli/examples/qldb/list-journal-s3-exports.rst b/aws/dist/awscli/examples/qldb/list-journal-s3-exports.rst new file mode 100644 index 00000000..641e77ab --- /dev/null +++ b/aws/dist/awscli/examples/qldb/list-journal-s3-exports.rst @@ -0,0 +1,46 @@ +**To list journal export jobs** + +The following ``list-journal-s3-exports`` example lists journal export jobs for all ledgers that are associated with the current AWS account and Region. :: + + aws qldb list-journal-s3-exports + +Output:: + + { + "JournalS3Exports": [ + { + "Status": "IN_PROGRESS", + "LedgerName": "myExampleLedger", + "S3ExportConfiguration": { + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + }, + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/" + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "ExportCreationTime": 1568847801.418, + "ExportId": "ADR2ONPKN5LINYGb4dp7yZ", + "InclusiveStartTime": 1568764800.0, + "ExclusiveEndTime": 1568847599.0 + }, + { + "Status": "COMPLETED", + "LedgerName": "myExampleLedger2", + "S3ExportConfiguration": { + "EncryptionConfiguration": { + "ObjectEncryptionType": "SSE_S3" + }, + "Bucket": "awsExampleBucket", + "Prefix": "ledgerexport1/" + }, + "RoleArn": "arn:aws:iam::123456789012:role/my-s3-export-role", + "ExportCreationTime": 1568846847.638, + "ExportId": "2pdvW8UQrjBAiYTMehEJDI", + "InclusiveStartTime": 1568592000.0, + "ExclusiveEndTime": 1568764800.0 + } + ] + } + +For more information, see `Exporting Your Journal in Amazon QLDB `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/list-ledgers.rst b/aws/dist/awscli/examples/qldb/list-ledgers.rst new file mode 100644 index 00000000..073e729f --- /dev/null +++ b/aws/dist/awscli/examples/qldb/list-ledgers.rst @@ -0,0 +1,24 @@ +**To list your available ledgers** + +The following ``list-ledgers`` example lists all ledgers that are associated with the current AWS account and Region. :: + + aws qldb list-ledgers + +Output:: + + { + "Ledgers": [ + { + "State": "ACTIVE", + "CreationDateTime": 1568839243.951, + "Name": "myExampleLedger" + }, + { + "State": "ACTIVE", + "CreationDateTime": 1568839543.557, + "Name": "myExampleLedger2" + } + ] + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/list-tags-for-resource.rst b/aws/dist/awscli/examples/qldb/list-tags-for-resource.rst new file mode 100644 index 00000000..5fbccf27 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/list-tags-for-resource.rst @@ -0,0 +1,17 @@ +**To list the tags attached to a ledger** + +The following ``list-tags-for-resource`` example lists all tags attached to the specified ledger. :: + + aws qldb list-tags-for-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger + +Output:: + + { + "Tags": { + "IsTest": "true", + "Domain": "Test" + } + } + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/tag-resource.rst b/aws/dist/awscli/examples/qldb/tag-resource.rst new file mode 100644 index 00000000..72e31e43 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/tag-resource.rst @@ -0,0 +1,11 @@ +**To tag a ledger** + +The following ``tag-resource`` example adds a set of tags to a specified ledger. :: + + aws qldb tag-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \ + --tags IsTest=true,Domain=Test + +This command produces no output. + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/untag-resource.rst b/aws/dist/awscli/examples/qldb/untag-resource.rst new file mode 100644 index 00000000..a1f77baa --- /dev/null +++ b/aws/dist/awscli/examples/qldb/untag-resource.rst @@ -0,0 +1,11 @@ +**To remove tags from a resource** + +The following ``untag-resource`` example removes tags with the specified tag keys from a specified ledger. :: + + aws qldb untag-resource \ + --resource-arn arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger \ + --tag-keys IsTest Domain + +This command produces no output. + +For more information, see `Tagging Amazon QLDB Resources `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/qldb/update-ledger.rst b/aws/dist/awscli/examples/qldb/update-ledger.rst new file mode 100644 index 00000000..1e906ce8 --- /dev/null +++ b/aws/dist/awscli/examples/qldb/update-ledger.rst @@ -0,0 +1,19 @@ +**To update properties of a ledger** + +The following ``update-ledger`` example updates the specified ledger to disable the deletion protection feature. :: + + aws qldb update-ledger \ + --name myExampleLedger \ + --no-deletion-protection + +Output:: + + { + "CreationDateTime": 1568839243.951, + "Arn": "arn:aws:qldb:us-west-2:123456789012:ledger/myExampleLedger", + "DeletionProtection": false, + "Name": "myExampleLedger", + "State": "ACTIVE" + } + +For more information, see `Basic Operations for Amazon QLDB Ledgers `__ in the *Amazon QLDB Developer Guide*. diff --git a/aws/dist/awscli/examples/ram/accept-resource-share-invitation.rst b/aws/dist/awscli/examples/ram/accept-resource-share-invitation.rst new file mode 100644 index 00000000..bc85aa25 --- /dev/null +++ b/aws/dist/awscli/examples/ram/accept-resource-share-invitation.rst @@ -0,0 +1,23 @@ +**To accept a resource share invitation** + +The following ``reject-resource-share-invitation`` example rejects the specified resource share invitation. :: + + aws ram reject-resource-share-invitation \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/arn:aws:ram:us-east-1:210774411744:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE + +Output:: + + { + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565319592.463, + "status": "ACCEPTED" + } + ] + } + diff --git a/aws/dist/awscli/examples/ram/associate-resource-share.rst b/aws/dist/awscli/examples/ram/associate-resource-share.rst new file mode 100644 index 00000000..ecbf8d93 --- /dev/null +++ b/aws/dist/awscli/examples/ram/associate-resource-share.rst @@ -0,0 +1,19 @@ +**To associate a resource with a resource share** + +The following ``associate-resource-share`` example associates the specified subnet with the specified resource share. :: + + aws ram associate-resource-share \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "ASSOCIATING", + "external": false + ] + } diff --git a/aws/dist/awscli/examples/ram/create-resource-share.rst b/aws/dist/awscli/examples/ram/create-resource-share.rst new file mode 100644 index 00000000..10a17ac3 --- /dev/null +++ b/aws/dist/awscli/examples/ram/create-resource-share.rst @@ -0,0 +1,51 @@ +**Example 1: To create a resource share** + +The following ``create-resource-share`` example creates a resource share with the specified name. :: + + aws ram create-resource-share \ + --name my-resource-share + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + } + +**Example 2: To create a resource share with AWS accounts as principals** + +The following ``create-resource-share`` example creates a resource share and adds the specified principals. :: + + aws ram create-resource-share \ + --name my-resource-share \ + --principals 0abcdef1234567890 + +**EXAMPLE 3: To create a resource share restricted to your organization in AWS Organizations** + +The following ``create-resource-share`` example creates a resource share that is restricted to your organization and adds the specified OU as a principal. :: + + aws ram create-resource-share \ + --name my-resource-share \ + --no-allow-external-principals \ + --principals arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": false, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + } diff --git a/aws/dist/awscli/examples/ram/delete-resource-share.rst b/aws/dist/awscli/examples/ram/delete-resource-share.rst new file mode 100644 index 00000000..f0ec2743 --- /dev/null +++ b/aws/dist/awscli/examples/ram/delete-resource-share.rst @@ -0,0 +1,12 @@ +**To delete a resource share** + +The following ``delete-resource-share`` example deletes the specified resource share. :: + + aws ram delete-resource-share \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +The following output indicates success:: + + { + "returnValue": true + } diff --git a/aws/dist/awscli/examples/ram/disassociate-resource-share.rst b/aws/dist/awscli/examples/ram/disassociate-resource-share.rst new file mode 100644 index 00000000..2456e964 --- /dev/null +++ b/aws/dist/awscli/examples/ram/disassociate-resource-share.rst @@ -0,0 +1,19 @@ +**To disassociate a resource from a resource share** + +The following ``disassociate-resource-share`` example disassociates the specified subnet from the specified resource share. :: + + aws ram disassociate-resource-share \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "DISASSOCIATING", + "external": false + ] + } diff --git a/aws/dist/awscli/examples/ram/enable-sharing-with-aws-organization.rst b/aws/dist/awscli/examples/ram/enable-sharing-with-aws-organization.rst new file mode 100644 index 00000000..eba4f99a --- /dev/null +++ b/aws/dist/awscli/examples/ram/enable-sharing-with-aws-organization.rst @@ -0,0 +1,11 @@ +**To enable resource sharing across AWS Organizations** + +The following ``enable-sharing-with-aws-organization`` example enables resource sharing across your organization or organizational units. :: + + aws ram enable-sharing-with-aws-organization + +The following output indicates success. :: + + { + "returnValue": true + } diff --git a/aws/dist/awscli/examples/ram/get-resource-policies.rst b/aws/dist/awscli/examples/ram/get-resource-policies.rst new file mode 100644 index 00000000..db7f60ea --- /dev/null +++ b/aws/dist/awscli/examples/ram/get-resource-policies.rst @@ -0,0 +1,14 @@ +**To get the policies for a resource** + +The following ``get-resource-policies`` example displays the policies for the specified subnet associated with a resource share. :: + + aws ram get-resource-policies \ + --resource-arns arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235 + +Output:: + + { + "policies": [ + "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"RamStatement1\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[]},\"Action\":[\"ec2:RunInstances\",\"ec2:CreateNetworkInterface\",\"ec2:DescribeSubnets\"],\"Resource\":\"arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235\"}]}" + ] + } diff --git a/aws/dist/awscli/examples/ram/get-resource-share-associations.rst b/aws/dist/awscli/examples/ram/get-resource-share-associations.rst new file mode 100644 index 00000000..4cf2dbff --- /dev/null +++ b/aws/dist/awscli/examples/ram/get-resource-share-associations.rst @@ -0,0 +1,46 @@ +**Example 1: To list resource associations** + +The following ``get-resource-share-associations`` example lists your resource associations. :: + + aws ram get-resource-share-associations \ + --association-type RESOURCE + +Output:: + + { + "resourceShareAssociations": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "associationType": "RESOURCE", + "status": "ASSOCIATED", + "creationTime": 1565303590.973, + "lastUpdatedTime": 1565303591.695, + "external": false + } + ] + } + +**Example 2: To list principal associations** + +The following ``get-resource-share-associations`` example lists the principal associations for the specified resource share. :: + + aws ram get-resource-share-associations \ + --association-type PRINCIPAL \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShareAssociations": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "associatedEntity": "0abcdef1234567890", + "associationType": "PRINCIPAL", + "status": "ASSOCIATED", + "creationTime": 1565296791.818, + "lastUpdatedTime": 1565296792.119, + "external": true + } + ] + } diff --git a/aws/dist/awscli/examples/ram/get-resource-share-invitations.rst b/aws/dist/awscli/examples/ram/get-resource-share-invitations.rst new file mode 100644 index 00000000..95dfe6fe --- /dev/null +++ b/aws/dist/awscli/examples/ram/get-resource-share-invitations.rst @@ -0,0 +1,21 @@ +**To list your resource share invitations** + +The following ``get-resource-share-invitations`` example lists your resource share invitations. :: + + aws ram get-resource-share-invitations + +Output:: + + { + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565312166.258, + "status": "PENDING" + } + ] + } diff --git a/aws/dist/awscli/examples/ram/get-resource-shares.rst b/aws/dist/awscli/examples/ram/get-resource-shares.rst new file mode 100644 index 00000000..2aa053cb --- /dev/null +++ b/aws/dist/awscli/examples/ram/get-resource-shares.rst @@ -0,0 +1,37 @@ +**To list your resource shares** + +The following ``get-resource-shares`` example lists your resource shares. :: + + aws ram get-resource-shares \ + --resource-owner SELF + +Output:: + + { + "resourceShares": [ + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/3ab63985-99d9-1cd2-7d24-75e93EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": false, + "status": "ACTIVE", + "tags": [ + { + "key": "project", + "value": "lima" + } + ] + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + }, + { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565295733.282 + } + ] + } diff --git a/aws/dist/awscli/examples/ram/list-principals.rst b/aws/dist/awscli/examples/ram/list-principals.rst new file mode 100644 index 00000000..de7ae2a5 --- /dev/null +++ b/aws/dist/awscli/examples/ram/list-principals.rst @@ -0,0 +1,20 @@ +**To list principals with access to a resource** + +The following ``list-principals`` example displays a list of the principals that can access the subnets associated with a resource share. :: + + aws ram list-principals \ + --resource-type ec2:Subnet + +Output:: + + { + "principals": [ + { + "id": "arn:aws:organizations::123456789012:ou/o-gx7EXAMPLE/ou-29c5-zEXAMPLE", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "creationTime": 1565298209.737, + "lastUpdatedTime": 1565298211.019, + "external": false + } + ] + } diff --git a/aws/dist/awscli/examples/ram/list-resources.rst b/aws/dist/awscli/examples/ram/list-resources.rst new file mode 100644 index 00000000..8985e21f --- /dev/null +++ b/aws/dist/awscli/examples/ram/list-resources.rst @@ -0,0 +1,22 @@ +**To list the resources associated with a resource share** + +The following ``list-resources`` example lists the subnets that you added to the specified resource share. :: + + aws ram list-resources \ + --resource-type ec2:Subnet \ + --resource-owner SELF \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resources": [ + { + "arn": "aarn:aws:ec2:us-west-2:123456789012:subnet/subnet-0250c25a1f4e15235", + "type": "ec2:Subnet", + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "creationTime": 1565301545.023, + "lastUpdatedTime": 1565301545.947 + } + ] + } diff --git a/aws/dist/awscli/examples/ram/reject-resource-share-invitation.rst b/aws/dist/awscli/examples/ram/reject-resource-share-invitation.rst new file mode 100644 index 00000000..bd0c08f7 --- /dev/null +++ b/aws/dist/awscli/examples/ram/reject-resource-share-invitation.rst @@ -0,0 +1,20 @@ +**To reject a resource share invitation** + +The following ``reject-resource-share-invitation`` example rejects the specified resource share invitation. :: + + aws ram reject-resource-share-invitation \ + --resource-share-invitation-arn arn:aws:ram:us-west-2:123456789012:resource-share-invitation/arn:aws:ram:us-east-1:210774411744:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE + +Output:: + + "resourceShareInvitations": [ + { + "resourceShareInvitationArn": "arn:aws:ram:us-west2-1:21077EXAMPLE:resource-share-invitation/32b639f0-14b8-7e8f-55ea-e6117EXAMPLE", + "resourceShareName": "project-resource-share", + "resourceShareArn": "arn:aws:ram:us-west-2:21077EXAMPLE:resource-share/fcb639f0-1449-4744-35bc-a983fc0d4ce1", + "senderAccountId": "21077EXAMPLE", + "receiverAccountId": "123456789012", + "invitationTimestamp": 1565319592.463, + "status": "REJECTED" + } + ] diff --git a/aws/dist/awscli/examples/ram/tag-resource.rst b/aws/dist/awscli/examples/ram/tag-resource.rst new file mode 100644 index 00000000..34983f5a --- /dev/null +++ b/aws/dist/awscli/examples/ram/tag-resource.rst @@ -0,0 +1,9 @@ +**To add tags to a resource share** + +The following ``tag-resource`` example adds a tag key ``project`` and associated value ``lima`` to the specified resource share. :: + + aws ram tag-resource \ + --tags key=project,value=lima + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ram/untag-resource.rst b/aws/dist/awscli/examples/ram/untag-resource.rst new file mode 100644 index 00000000..0bf08a1b --- /dev/null +++ b/aws/dist/awscli/examples/ram/untag-resource.rst @@ -0,0 +1,8 @@ +**To remove tags from a resource share** + +The following ``untag-resource`` example removes the ``project`` tag key and associated value from the specified resource share. :: + + aws ram untag-resource \ + --tag-keys project + +This command produces no output. \ No newline at end of file diff --git a/aws/dist/awscli/examples/ram/update-resource-share.rst b/aws/dist/awscli/examples/ram/update-resource-share.rst new file mode 100644 index 00000000..dd930088 --- /dev/null +++ b/aws/dist/awscli/examples/ram/update-resource-share.rst @@ -0,0 +1,21 @@ +**To update a resource share** + +The following ``update-resource-share`` example makes changes to the specified resource share. :: + + aws ram update-resource-share \ + --allow-external-principals \ + --resource-share-arn arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE + +Output:: + + { + "resourceShare": { + "resourceShareArn": "arn:aws:ram:us-west-2:123456789012:resource-share/7ab63972-b505-7e2a-420d-6f5d3EXAMPLE", + "name": "my-resource-share", + "owningAccountId": "123456789012", + "allowExternalPrincipals": true, + "status": "ACTIVE", + "creationTime": 1565295733.282, + "lastUpdatedTime": 1565303080.023 + } + } diff --git a/aws/dist/awscli/examples/rds-data/batch-execute-statement.rst b/aws/dist/awscli/examples/rds-data/batch-execute-statement.rst new file mode 100644 index 00000000..1b53b13a --- /dev/null +++ b/aws/dist/awscli/examples/rds-data/batch-execute-statement.rst @@ -0,0 +1,16 @@ +**To execute a batch SQL statement** + +The following ``batch-execute-statement`` example executes a batch SQL statement over an array of data with a parameter set. :: + + aws rds-data batch-execute-statement \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --sql "insert into mytable values (:id, :val)" \ + --parameter-sets "[[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueOne\"}}], + [{\"name\": \"id\", \"value\": {\"longValue\": 2}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueTwo\"}}], + [{\"name\": \"id\", \"value\": {\"longValue\": 3}},{\"name\": \"val\", \"value\": {\"stringValue\": \"ValueThree\"}}]]" + +This command produces no output. + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds-data/begin-transaction.rst b/aws/dist/awscli/examples/rds-data/begin-transaction.rst new file mode 100644 index 00000000..6816cdbe --- /dev/null +++ b/aws/dist/awscli/examples/rds-data/begin-transaction.rst @@ -0,0 +1,16 @@ +**To start a SQL transaction** + +The following ``begin-transaction`` example starts a SQL transaction. :: + + aws rds-data begin-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" + +Output:: + + { + "transactionId": "ABC1234567890xyz" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds-data/commit-transaction.rst b/aws/dist/awscli/examples/rds-data/commit-transaction.rst new file mode 100644 index 00000000..90dacd8c --- /dev/null +++ b/aws/dist/awscli/examples/rds-data/commit-transaction.rst @@ -0,0 +1,16 @@ +**To commit a SQL transaction** + +The following ``commit-transaction`` example ends the specified SQL transaction and commits the changes that you made as part of it. :: + + aws rds-data commit-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "transactionStatus": "Transaction Committed" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds-data/execute-statement.rst b/aws/dist/awscli/examples/rds-data/execute-statement.rst new file mode 100644 index 00000000..2963dc86 --- /dev/null +++ b/aws/dist/awscli/examples/rds-data/execute-statement.rst @@ -0,0 +1,36 @@ +**Example 1: To execute a SQL statement that is part of a transaction** + +The following ``execute-statement`` example runs a SQL statement that is part of a transaction. :: + + aws rds-data execute-statement \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --sql "update mytable set quantity=5 where id=201" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "numberOfRecordsUpdated": 1 + } + +**Example 2: To execute a SQL statement with parameters** + +The following ``execute-statement`` example runs a SQL statement with parameters. :: + + aws rds-data execute-statement \ + --resource-arn "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster" \ + --database "mydb" \ + --secret-arn "arn:aws:secretsmanager:us-east-1:123456789012:secret:mysecret" \ + --sql "insert into mytable values (:id, :val)" \ + --parameters "[{\"name\": \"id\", \"value\": {\"longValue\": 1}},{\"name\": \"val\", \"value\": {\"stringValue\": \"value1\"}}]" + +Output:: + + { + "numberOfRecordsUpdated": 1 + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. + diff --git a/aws/dist/awscli/examples/rds-data/rollback-transaction.rst b/aws/dist/awscli/examples/rds-data/rollback-transaction.rst new file mode 100644 index 00000000..7e998ff3 --- /dev/null +++ b/aws/dist/awscli/examples/rds-data/rollback-transaction.rst @@ -0,0 +1,16 @@ +**To roll back a SQL transaction** + +The following ``rollback-transaction`` example rolls back the specified SQL transaction. :: + + aws rds-data rollback-transaction \ + --resource-arn "arn:aws:rds:us-west-2:123456789012:cluster:mydbcluster" \ + --secret-arn "arn:aws:secretsmanager:us-west-2:123456789012:secret:mysecret" \ + --transaction-id "ABC1234567890xyz" + +Output:: + + { + "transactionStatus": "Rollback Complete" + } + +For more information, see `Using the Data API for Aurora Serverless `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/add-option-to-option-group.rst b/aws/dist/awscli/examples/rds/add-option-to-option-group.rst new file mode 100644 index 00000000..4198a217 --- /dev/null +++ b/aws/dist/awscli/examples/rds/add-option-to-option-group.rst @@ -0,0 +1,61 @@ +**To add an option to an option group** + +The following ``add-option-to-option-group`` example adds an option to the specified option group. :: + + aws rds add-option-to-option-group \ + --option-group-name myoptiongroup \ + --options OptionName=OEM,Port=5500,DBSecurityGroupMemberships=default \ + --apply-immediately + +Output:: + + { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "Test Option Group", + "EngineName": "oracle-ee", + "MajorEngineVersion": "12.1", + "Options": [ + { + "OptionName": "Timezone", + "OptionDescription": "Change time zone", + "Persistent": true, + "Permanent": false, + "OptionSettings": [ + { + "Name": "TIME_ZONE", + "Value": "Australia/Sydney", + "DefaultValue": "UTC", + "Description": "Specifies the timezone the user wants to change the system time to", + "ApplyType": "DYNAMIC", + "DataType": "STRING", + "AllowedValues": "Africa/Cairo,Africa/Casablanca,Africa/Harare,Africa/Lagos,Africa/Luanda,Africa/Monrovia,Africa/Nairobi,Africa/Tripoli,Africa/Windhoek,America/Araguaina,America/Argentina/Buenos_Aires,America/Asuncion,America/Bogota,America/Caracas,America/Chicago,America/Chihuahua,America/Cuiaba,America/Denver,America/Detroit,America/Fortaleza,America/Godthab,America/Guatemala,America/Halifax,America/Lima,America/Los_Angeles,America/Manaus,America/Matamoros,America/Mexico_City,America/Monterrey,America/Montevideo,America/New_York,America/Phoenix,America/Santiago,America/Sao_Paulo,America/Tijuana,America/Toronto,Asia/Amman,Asia/Ashgabat,Asia/Baghdad,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Calcutta,Asia/Damascus,Asia/Dhaka,Asia/Hong_Kong,Asia/Irkutsk,Asia/Jakarta,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Magadan,Asia/Manila,Asia/Muscat,Asia/Novosibirsk,Asia/Rangoon,Asia/Riyadh,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tehran,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vladivostok,Asia/Yakutsk,Asia/Yerevan,Atlantic/Azores,Atlantic/Cape_Verde,Australia/Adelaide,Australia/Brisbane,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/Lord_Howe,Australia/Perth,Australia/Sydney,Brazil/DeNoronha,Brazil/East,Canada/Newfoundland,Canada/Saskatchewan,Etc/GMT-3,Europe/Amsterdam,Europe/Athens,Europe/Berlin,Europe/Dublin,Europe/Helsinki,Europe/Kaliningrad,Europe/London,Europe/Madrid,Europe/Moscow,Europe/Paris,Europe/Prague,Europe/Rome,Europe/Sarajevo,Pacific/Apia,Pacific/Auckland,Pacific/Chatham,Pacific/Fiji,Pacific/Guam,Pacific/Honolulu,Pacific/Kiritimati,Pacific/Marquesas,Pacific/Samoa,Pacific/Tongatapu,Pacific/Wake,US/Alaska,US/Central,US/East-Indiana,US/Eastern,US/Pacific,UTC", + "IsModifiable": true, + "IsCollection": false + } + ], + "DBSecurityGroupMemberships": [], + "VpcSecurityGroupMemberships": [] + }, + { + "OptionName": "OEM", + "OptionDescription": "Oracle 12c EM Express", + "Persistent": false, + "Permanent": false, + "Port": 5500, + "OptionSettings": [], + "DBSecurityGroupMemberships": [ + { + "DBSecurityGroupName": "default", + "Status": "authorized" + } + ], + "VpcSecurityGroupMemberships": [] + } + ], + "AllowsVpcAndNonVpcInstanceMemberships": false, + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:myoptiongroup" + } + } + +For more information, see `Adding an Option to an Option Group `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/add-source-identifier-to-subscription.rst b/aws/dist/awscli/examples/rds/add-source-identifier-to-subscription.rst new file mode 100644 index 00000000..28615aa6 --- /dev/null +++ b/aws/dist/awscli/examples/rds/add-source-identifier-to-subscription.rst @@ -0,0 +1,30 @@ +**To add a source identifier to a subscription** + +The following ``add-source-identifier`` example adds another source identifier to an existing subscription. :: + + aws rds add-source-identifier-to-subscription \ + --subscription-name my-instance-events \ + --source-identifier test-instance-repl + +Output:: + + { + "EventSubscription": { + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "CustSubscriptionId": "my-instance-events", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Enabled": false, + "Status": "modifying", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "SourceType": "db-instance", + "SourceIdsList": [ + "test-instance", + "test-instance-repl" + ] + } + } diff --git a/aws/dist/awscli/examples/rds/add-tags-to-resource.rst b/aws/dist/awscli/examples/rds/add-tags-to-resource.rst new file mode 100644 index 00000000..ad11238b --- /dev/null +++ b/aws/dist/awscli/examples/rds/add-tags-to-resource.rst @@ -0,0 +1,11 @@ +**To add tags to a resource** + +The following ``add-tags-to-resource`` example add tags to an RDS database. :: + + aws rds add-tags-to-resource \ + --resource-name arn:aws:rds:us-east-1:123456789012:db:database-mysql \ + --tags "[{\"Key\": \"Name\",\"Value\": \"MyDatabase\"},{\"Key\": \"Environment\",\"Value\": \"test\"}]" + +This command produces no output. + +For more information, see `Tagging Amazon RDS Resources `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/backtrack-db-cluster.rst b/aws/dist/awscli/examples/rds/backtrack-db-cluster.rst new file mode 100644 index 00000000..318df0af --- /dev/null +++ b/aws/dist/awscli/examples/rds/backtrack-db-cluster.rst @@ -0,0 +1,7 @@ +**To backtrack an Aurora DB cluster** + +The following ``backtrack-db-cluster`` example backtracks the specified DB cluster sample-cluster to March 19, 2018, at 10 a.m. :: + + aws rds backtrack-db-cluster --db-cluster-identifier sample-cluster --backtrack-to 2018-03-19T10:00:00+00:00 + +This command outputs a JSON block that acknowledges the change to the RDS resource. diff --git a/aws/dist/awscli/examples/rds/copy-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/rds/copy-db-cluster-parameter-group.rst new file mode 100644 index 00000000..c54c5cbd --- /dev/null +++ b/aws/dist/awscli/examples/rds/copy-db-cluster-parameter-group.rst @@ -0,0 +1,21 @@ +**To copy a DB cluster parameter group** + +The following ``copy-db-cluster-parameter-group`` example makes a copy of a DB cluster parameter group. :: + + aws rds copy-db-cluster-parameter-group \ + --source-db-cluster-parameter-group-identifier mydbclusterpg \ + --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \ + --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group" + } + } + +For more information, see `Copying a DB Cluster Parameter Group `__ in the *Amazon Aurora Users Guide*. diff --git a/aws/dist/awscli/examples/rds/copy-db-cluster-snapshot.rst b/aws/dist/awscli/examples/rds/copy-db-cluster-snapshot.rst new file mode 100644 index 00000000..74d45eb6 --- /dev/null +++ b/aws/dist/awscli/examples/rds/copy-db-cluster-snapshot.rst @@ -0,0 +1,40 @@ +**To copy a DB cluster snapshot** + +The following ``copy-db-cluster-snapshot`` example creates a copy of a DB cluster snapshot, including its tags. :: + + aws rds copy-db-cluster-snapshot \ + --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16 + --target-db-cluster-snapshot-identifier myclustersnapshotcopy \ + --copy-tags + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "myaurora", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Copying a Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/copy-db-parameter-group.rst b/aws/dist/awscli/examples/rds/copy-db-parameter-group.rst new file mode 100644 index 00000000..5a6aa891 --- /dev/null +++ b/aws/dist/awscli/examples/rds/copy-db-parameter-group.rst @@ -0,0 +1,21 @@ +**To copy a DB cluster parameter group** + +The following ``copy-db-parameter-group`` example makes a copy of a DB parameter group. :: + + aws rds copy-db-parameter-group \ + --source-db-parameter-group-identifier mydbpg \ + --target-db-parameter-group-identifier mydbpgcopy \ + --target-db-parameter-group-description "Copy of mydbpg parameter group" + +Output:: + + { + "DBParameterGroup": { + "DBParameterGroupName": "mydbpgcopy", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", + "DBParameterGroupFamily": "mysql5.7", + "Description": "Copy of mydbpg parameter group" + } + } + +For more information, see `Copying a DB Parameter Group `__ in the *Amazon RDS Users Guide*. diff --git a/aws/dist/awscli/examples/rds/copy-db-snapshot.rst b/aws/dist/awscli/examples/rds/copy-db-snapshot.rst new file mode 100644 index 00000000..bc48c3b0 --- /dev/null +++ b/aws/dist/awscli/examples/rds/copy-db-snapshot.rst @@ -0,0 +1,42 @@ +**To copy a DB snapshot** + +The following ``copy-db-snapshot`` example creates a copy of a DB snapshot. :: + + aws rds copy-db-snapshot \ + --source-db-snapshot-identifier rds:database-mysql-2019-06-06-08-38 + --target-db-snapshot-identifier mydbsnapshotcopy + +Output:: + + { + "DBSnapshot": { + "VpcId": "vpc-6594f31c", + "Status": "creating", + "Encrypted": true, + "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38", + "MasterUsername": "admin", + "Iops": 1000, + "Port": 3306, + "LicenseModel": "general-public-license", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy", + "EngineVersion": "5.6.40", + "OptionGroupName": "default:mysql-5-6", + "ProcessorFeatures": [], + "Engine": "mysql", + "StorageType": "io1", + "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4", + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "SnapshotType": "manual", + "IAMDatabaseAuthenticationEnabled": false, + "SourceRegion": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "AvailabilityZone": "us-east-1f", + "PercentProgress": 0, + "AllocatedStorage": 100, + "DBSnapshotIdentifier": "mydbsnapshotcopy" + } + } + + +For more information, see `Copying a Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/copy-option-group.rst b/aws/dist/awscli/examples/rds/copy-option-group.rst new file mode 100644 index 00000000..f3923a4d --- /dev/null +++ b/aws/dist/awscli/examples/rds/copy-option-group.rst @@ -0,0 +1,24 @@ +**To copy an option group** + +The following ``copy-option-group`` example makes a copy of an option group. :: + + aws rds copy-option-group \ + --source-option-group-identifier myoptiongroup \ + --target-option-group-identifier new-option-group \ + --target-option-group-description "My option group copy" + +Output:: + + { + "OptionGroup": { + "Options": [], + "OptionGroupName": "new-option-group", + "MajorEngineVersion": "11.2", + "OptionGroupDescription": "My option group copy", + "AllowsVpcAndNonVpcInstanceMemberships": true, + "EngineName": "oracle-ee", + "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group" + } + } + +For more information, see `Making a Copy of an Option Group `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-cluster-endpoint.rst b/aws/dist/awscli/examples/rds/create-db-cluster-endpoint.rst new file mode 100644 index 00000000..38e6472e --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-cluster-endpoint.rst @@ -0,0 +1,29 @@ +**To create a custom DB cluster endpoint** + +The following ``create-db-cluster-endpoint`` example creates a custom DB cluster endpoint and associate it with the specified Aurora DB cluster. :: + + aws rds create-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint \ + --endpoint-type reader \ + --db-cluster-identifier mydbcluster \ + --static-members dbinstance1 dbinstance2 + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/rds/create-db-cluster-parameter-group.rst new file mode 100644 index 00000000..d140728d --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-cluster-parameter-group.rst @@ -0,0 +1,21 @@ +**To create a DB cluster parameter group** + +The following ``create-db-cluster-parameter-group`` example creates a DB cluster parameter group. :: + + aws rds create-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterparametergroup \ + --db-parameter-group-family aurora5.6 \ + --description "My new cluster parameter group" + +Output:: + + { + "DBClusterParameterGroup": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My new cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup" + } + } + +For more information, see `Creating a DB Cluster Parameter Group `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-cluster-snapshot.rst b/aws/dist/awscli/examples/rds/create-db-cluster-snapshot.rst new file mode 100644 index 00000000..cf61f077 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-cluster-snapshot.rst @@ -0,0 +1,39 @@ +**To create a DB cluster snapshot** + +The following ``create-db-cluster-snapshot`` example creates a DB cluster snapshot. :: + + aws rds create-db-cluster-snapshot \ + --db-cluster-identifier mydbcluster \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 1, + "Status": "creating", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 0, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-cluster.rst b/aws/dist/awscli/examples/rds/create-db-cluster.rst new file mode 100644 index 00000000..2efda638 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-cluster.rst @@ -0,0 +1,118 @@ +**Example 1: To create a MySQL 5.7--compatible DB cluster** + +The following ``create-db-cluster`` example create a MySQL 5.7-compatible DB cluster. Replace the sample password ``secret99`` with a secure password. The writer DB instance is the first instance that is created in a DB cluster. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-cluster \ + --engine aurora-mysql \ + --engine-version 5.7.12 \ + --master-username master \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "DBSubnetGroup": "default", + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "AllocatedStorage": 1, + "AssociatedRoles": [], + "PreferredBackupWindow": "09:12-09:42", + "ClusterCreateTime": "2019-06-07T23:21:33.048Z", + "DeletionProtection": false, + "IAMDatabaseAuthenticationEnabled": false, + "ReadReplicaIdentifiers": [], + "EngineMode": "provisioned", + "Engine": "aurora-mysql", + "StorageEncrypted": false, + "MultiAZ": false, + "PreferredMaintenanceWindow": "mon:04:31-mon:05:01", + "HttpEndpointEnabled": false, + "BackupRetentionPeriod": 1, + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "DBClusterIdentifier": "sample-cluster", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "MasterUsername": "master", + "EngineVersion": "5.7.12", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster", + "DBClusterMembers": [], + "Port": 3306, + "Status": "creating", + "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "HostedZoneId": "Z2R2ITUGPM61AM", + "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "CopyTagsToSnapshot": false + } + } + +**Example 2: To create a PostgreSQL--compatible DB cluster** + +The following ``create-db-cluster`` example creates a PostgreSQL-compatible DB cluster. Replace the example password ``secret99`` with a secure password. The writer DB instance is the first instance that is created in a DB cluster. When you use the console to create a DB cluster, Amazon RDS automatically creates the writer DB instance for your DB cluster. However, when you use the AWS CLI to create a DB cluster, you must explicitly create the writer DB instance for your DB cluster using the ``create-db-instance`` AWS CLI command. :: + + aws rds create-db-cluster \ + --db-cluster-identifier sample-pg-cluster \ + --engine aurora-postgresql \ + --master-username master \ + --master-user-password secret99 \ + --db-subnet-group-name default \ + --vpc-security-group-ids sg-0b9130572daf3dc16 + +Output:: + + { + "DBCluster": { + "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "HttpEndpointEnabled": false, + "DBClusterMembers": [], + "EngineMode": "provisioned", + "CopyTagsToSnapshot": false, + "HostedZoneId": "Z2R2ITUGPM61AM", + "IAMDatabaseAuthenticationEnabled": false, + "AllocatedStorage": 1, + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "DeletionProtection": false, + "StorageEncrypted": false, + "BackupRetentionPeriod": 1, + "PreferredBackupWindow": "09:56-10:26", + "ClusterCreateTime": "2019-06-07T23:26:08.371Z", + "DBClusterParameterGroup": "default.aurora-postgresql9.6", + "EngineVersion": "9.6.9", + "Engine": "aurora-postgresql", + "Status": "creating", + "DBClusterIdentifier": "sample-pg-cluster", + "MultiAZ": false, + "Port": 5432, + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster", + "AssociatedRoles": [], + "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE", + "PreferredMaintenanceWindow": "wed:03:33-wed:04:03", + "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MasterUsername": "master", + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1c" + ], + "ReadReplicaIdentifiers": [], + "DBSubnetGroup": "default" + } + } + +For more information, see `Creating an Amazon Aurora DB Cluster `__ in the *Amazon Aurora Users Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-instance-read-replica.rst b/aws/dist/awscli/examples/rds/create-db-instance-read-replica.rst new file mode 100644 index 00000000..0f3405e1 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-instance-read-replica.rst @@ -0,0 +1,20 @@ +**To create a DB instance read replica** + +This example creates a read replica of an existing DB instance named ``test-instance``. The read replica is named ``test-instance-repl``. :: + + aws rds create-db-instance-read-replica \ + --db-instance-identifier test-instance-repl \ + --source-db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "IAMDatabaseAuthenticationEnabled": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceIdentifier": "test-instance-repl", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/create-db-instance.rst b/aws/dist/awscli/examples/rds/create-db-instance.rst new file mode 100644 index 00000000..49112a5c --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-instance.rst @@ -0,0 +1,124 @@ +**To create a DB instance** + +The following ``create-db-instance`` example launches a new DB instance. :: + + aws rds create-db-instance \ + --allocated-storage 20 --db-instance-class db.m1.small \ + --db-instance-identifier test-instance \ + --engine mysql \ + --enable-cloudwatch-logs-exports '["audit","error","general","slowquery"]' \ + --master-username master \ + --master-user-password secret99 + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "creating", + "MasterUsername": "master", + "AllocatedStorage": 20, + "PreferredBackupWindow": "10:27-10:57", + "BackupRetentionPeriod": 1, + "DBSecurityGroups": [], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-f839b688", + "Status": "active" + } + ], + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.mysql5.6", + "ParameterApplyStatus": "in-sync" + } + ], + "DBSubnetGroup": { + "DBSubnetGroupName": "default", + "DBSubnetGroupDescription": "default", + "VpcId": "vpc-136a4c6a", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-cbfff283", + "SubnetAvailabilityZone": { + "Name": "us-east-1b" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-d7c825e8", + "SubnetAvailabilityZone": { + "Name": "us-east-1e" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-6746046b", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-bac383e0", + "SubnetAvailabilityZone": { + "Name": "us-east-1c" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-42599426", + "SubnetAvailabilityZone": { + "Name": "us-east-1d" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-da327bf6", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ] + }, + "PreferredMaintenanceWindow": "sat:05:47-sat:06:17", + "PendingModifiedValues": { + "MasterUserPassword": "****", + "PendingCloudwatchLogsExports": { + "LogTypesToEnable": [ + "audit", + "error", + "general", + "slowquery" + ] + } + }, + "MultiAZ": false, + "EngineVersion": "5.6.39", + "AutoMinorVersionUpgrade": true, + "ReadReplicaDBInstanceIdentifiers": [], + "LicenseModel": "general-public-license", + "OptionGroupMemberships": [ + { + "OptionGroupName": "default:mysql-5-6", + "Status": "in-sync" + } + ], + "PubliclyAccessible": true, + "StorageType": "standard", + "DbInstancePort": 0, + "StorageEncrypted": false, + "DbiResourceId": "db-ETDZIIXHEWY5N7GXVC4SH7H5IA", + "CACertificateIdentifier": "rds-ca-2015", + "DomainMemberships": [], + "CopyTagsToSnapshot": false, + "MonitoringInterval": 0, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance", + "IAMDatabaseAuthenticationEnabled": false, + "PerformanceInsightsEnabled": false + } + } diff --git a/aws/dist/awscli/examples/rds/create-db-parameter-group.rst b/aws/dist/awscli/examples/rds/create-db-parameter-group.rst new file mode 100644 index 00000000..474cee29 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-parameter-group.rst @@ -0,0 +1,21 @@ +**To create a DB parameter group** + +The following ``create-db-parameter-group`` example creates a DB parameter group. :: + + aws rds create-db-parameter-group \ + --db-parameter-group-name mydbparametergroup \ + --db-parameter-group-family MySQL5.6 \ + --description "My new parameter group" + +Output:: + + { + "DBParameterGroup": { + "DBParameterGroupName": "mydbparametergroup", + "DBParameterGroupFamily": "mysql5.6", + "Description": "My new parameter group", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:mydbparametergroup" + } + } + +For more information, see `Creating a DB Parameter Group `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-db-security-group.rst b/aws/dist/awscli/examples/rds/create-db-security-group.rst new file mode 100644 index 00000000..999eb84c --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-security-group.rst @@ -0,0 +1,21 @@ +**To create an Amazon RDS DB security group** + +The following ``create-db-security-group`` command creates a new Amazon RDS DB security group:: + + aws rds create-db-security-group --db-security-group-name mysecgroup --db-security-group-description "My Test Security Group" + +In the example, the new DB security group is named ``mysecgroup`` and has a description. + +Output:: + + { + "DBSecurityGroup": { + "OwnerId": "123456789012", + "DBSecurityGroupName": "mysecgroup", + "DBSecurityGroupDescription": "My Test Security Group", + "VpcId": "vpc-a1b2c3d4", + "EC2SecurityGroups": [], + "IPRanges": [], + "DBSecurityGroupArn": "arn:aws:rds:us-west-2:123456789012:secgrp:mysecgroup" + } + } diff --git a/aws/dist/awscli/examples/rds/create-db-snapshot.rst b/aws/dist/awscli/examples/rds/create-db-snapshot.rst new file mode 100644 index 00000000..45945003 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-db-snapshot.rst @@ -0,0 +1,39 @@ +**To create a DB snapshot** + +The following ``create-db-snapshot`` example creates a DB snapshot. :: + + aws rds create-db-snapshot \ + --db-instance-identifier database-mysql \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "creating", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 0, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + +For more information, see `Creating a DB Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/create-event-subscription.rst b/aws/dist/awscli/examples/rds/create-event-subscription.rst new file mode 100644 index 00000000..81dec8a9 --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-event-subscription.rst @@ -0,0 +1,28 @@ +**To create an event subscription** + +The following ``create-event-subscription`` example creates a subscription for backup and recovery events for DB instances in the current AWS account. Notifications are sent to an Amazon Simple Notification Service topic, specified by ``--sns-topic-arn``. :: + + aws rds create-event-subscription \ + --subscription-name my-instance-events \ + --source-type db-instance \ + --event-categories '["backup","recovery"]' \ + --sns-topic-arn arn:aws:sns:us-east-1:123456789012:interesting-events + +Output:: + + { + "EventSubscription": { + "Status": "creating", + "CustSubscriptionId": "my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustomerAwsId": "123456789012", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SourceType": "db-instance", + "Enabled": true + } + } diff --git a/aws/dist/awscli/examples/rds/create-option-group.rst b/aws/dist/awscli/examples/rds/create-option-group.rst new file mode 100644 index 00000000..9217f0ab --- /dev/null +++ b/aws/dist/awscli/examples/rds/create-option-group.rst @@ -0,0 +1,23 @@ +**To Create an Amazon RDS option group** + +The following ``create-option-group`` command creates a new Amazon RDS option group for ``Oracle Enterprise Edition`` version ``11.2`, is named ``MyOptionGroup`` and includes a description. :: + + aws rds create-option-group \ + --option-group-name MyOptionGroup \ + --engine-name oracle-ee \ + --major-engine-version 11.2 \ + --option-group-description "Oracle Database Manager Database Control" + +Output:: + + { + "OptionGroup": { + "OptionGroupName": "myoptiongroup", + "OptionGroupDescription": "Oracle Database Manager Database Control", + "EngineName": "oracle-ee", + "MajorEngineVersion": "11.2", + "Options": [], + "AllowsVpcAndNonVpcInstanceMemberships": true, + "OptionGroupArn": "arn:aws:rds:us-west-2:123456789012:og:myoptiongroup" + } + } diff --git a/aws/dist/awscli/examples/rds/delete-db-cluster-endpoint.rst b/aws/dist/awscli/examples/rds/delete-db-cluster-endpoint.rst new file mode 100644 index 00000000..c538b79e --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-db-cluster-endpoint.rst @@ -0,0 +1,27 @@ +**To delete a custom DB cluster endpoint** + +The following ``delete-db-cluster-endpoint`` example deletes the specified custom DB cluster endpoint. :: + + aws rds delete-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "deleting", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/delete-db-cluster-parameter-group.rst b/aws/dist/awscli/examples/rds/delete-db-cluster-parameter-group.rst new file mode 100644 index 00000000..57d0f1ac --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-db-cluster-parameter-group.rst @@ -0,0 +1,10 @@ +**To delete a DB cluster parameter group** + +The following ``delete-db-cluster-parameter-group`` example deletes the specified DB cluster parameter group. :: + + aws rds delete-db-cluster-parameter-group \ + --db-cluster-parameter-group-name mydbclusterparametergroup + +This command produces no output. + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/delete-db-cluster-snapshot.rst b/aws/dist/awscli/examples/rds/delete-db-cluster-snapshot.rst new file mode 100644 index 00000000..e324f98c --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-db-cluster-snapshot.rst @@ -0,0 +1,38 @@ +**To delete a DB cluster snapshot** + +The following ``delete-db-cluster-snapshot`` example deletes the specified DB cluster snapshot. :: + + aws rds delete-db-cluster-snapshot \ + --db-cluster-snapshot-identifier mydbclustersnapshot + +Output:: + + { + "DBClusterSnapshot": { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-18T21:21:00.469Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:mydbclustersnapshot", + "IAMDatabaseAuthenticationEnabled": false + } + } + +For more information, see `Deleting a Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/delete-db-snapshot.rst b/aws/dist/awscli/examples/rds/delete-db-snapshot.rst new file mode 100644 index 00000000..28dea86e --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-db-snapshot.rst @@ -0,0 +1,39 @@ +**To delete a DB snapshot** + +The following ``delete-db-snapshot`` example deletes the specified DB snapshot. :: + + aws rds delete-db-snapshot \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshot": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "database-mysql", + "SnapshotCreateTime": "2019-06-18T22:08:40.702Z", + "Engine": "mysql", + "AllocatedStorage": 100, + "Status": "deleted", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53.663Z", + "MasterUsername": "admin", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "io1", + "Encrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + } + +For more information, see `Deleting a Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/delete-event-subscription.rst b/aws/dist/awscli/examples/rds/delete-event-subscription.rst new file mode 100644 index 00000000..624cc8bc --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-event-subscription.rst @@ -0,0 +1,27 @@ +**To delete an event subscription** + +The following ``delete-event-subscription`` example deletes the specified event subscription. :: + + aws rds delete-event-subscription --subscription-name my-instance-events + +Output:: + + { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "CustomerAwsId": "123456789012", + "Enabled": false, + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "deleting" + } + } diff --git a/aws/dist/awscli/examples/rds/delete-option-group.rst b/aws/dist/awscli/examples/rds/delete-option-group.rst new file mode 100644 index 00000000..cad3f0cb --- /dev/null +++ b/aws/dist/awscli/examples/rds/delete-option-group.rst @@ -0,0 +1,10 @@ +**To delete an option group** + +The following ``delete-option-group`` example deletes the specified option group. :: + + aws rds delete-option-group \ + --option-group-name myoptiongroup + +This command produces no output. + +For more information, see `Deleting an Option Group `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-account-attributes.rst b/aws/dist/awscli/examples/rds/describe-account-attributes.rst new file mode 100644 index 00000000..cd105cda --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-account-attributes.rst @@ -0,0 +1,87 @@ +**To describe account attributes** + +The following ``describe-account-attributes`` example retrieves the attributes for the current AWS account. :: + + aws rds describe-account-attributes + +Output:: + + { + "AccountQuotas": [ + { + "Max": 40, + "Used": 4, + "AccountQuotaName": "DBInstances" + }, + { + "Max": 40, + "Used": 0, + "AccountQuotaName": "ReservedDBInstances" + }, + { + "Max": 100000, + "Used": 40, + "AccountQuotaName": "AllocatedStorage" + }, + { + "Max": 25, + "Used": 0, + "AccountQuotaName": "DBSecurityGroups" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "AuthorizationsPerDBSecurityGroup" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBParameterGroups" + }, + { + "Max": 100, + "Used": 3, + "AccountQuotaName": "ManualSnapshots" + }, + { + "Max": 20, + "Used": 0, + "AccountQuotaName": "EventSubscriptions" + }, + { + "Max": 50, + "Used": 1, + "AccountQuotaName": "DBSubnetGroups" + }, + { + "Max": 20, + "Used": 1, + "AccountQuotaName": "OptionGroups" + }, + { + "Max": 20, + "Used": 6, + "AccountQuotaName": "SubnetsPerDBSubnetGroup" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "ReadReplicasPerMaster" + }, + { + "Max": 40, + "Used": 1, + "AccountQuotaName": "DBClusters" + }, + { + "Max": 50, + "Used": 0, + "AccountQuotaName": "DBClusterParameterGroups" + }, + { + "Max": 5, + "Used": 0, + "AccountQuotaName": "DBClusterRoles" + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-certificates.rst b/aws/dist/awscli/examples/rds/describe-certificates.rst new file mode 100644 index 00000000..168660e0 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-certificates.rst @@ -0,0 +1,20 @@ +**To describe certificates** + +The following ``describe-certificates`` example retrieves the details of the certificate associated with the user's default region. :: + + aws rds describe-certificates + +Output:: + + { + "Certificates": [ + { + "Thumbprint": "34478a908a83ae45dcb61676d235ece975c62c63", + "ValidFrom": "2015-02-05T21:54:04Z", + "CertificateIdentifier": "rds-ca-2015", + "ValidTill": "2020-03-05T21:54:04Z", + "CertificateType": "CA", + "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2015" + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-db-cluster-endpoints.rst b/aws/dist/awscli/examples/rds/describe-db-cluster-endpoints.rst new file mode 100644 index 00000000..ec9a8684 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-cluster-endpoints.rst @@ -0,0 +1,38 @@ +**To describe DB cluster endpoints** + +The following ``describe-db-cluster-endpoints`` example retrieves details for your DB cluster endpoints. :: + + aws rds describe-db-cluster-endpoints + +Output:: + + { + "DBClusterEndpoints": [ + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "my-database-1", + "Endpoint": "my-database-1.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "creating", + "EndpointType": "READER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-cnpexamle.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "WRITER" + }, + { + "DBClusterIdentifier": "mydbcluster", + "Endpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "available", + "EndpointType": "READER" + } + ] + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-cluster-parameter-groups.rst b/aws/dist/awscli/examples/rds/describe-db-cluster-parameter-groups.rst new file mode 100644 index 00000000..449d024e --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-cluster-parameter-groups.rst @@ -0,0 +1,44 @@ +**To describe DB cluster parameter groups** + +The following ``describe-db-cluster-parameter-groups`` example retrieves details for your DB cluster parameter groups. :: + + aws rds describe-db-cluster-parameter-groups + +Output:: + + { + "DBClusterParameterGroups": [ + { + "DBClusterParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default cluster parameter group for aurora-mysql5.7", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-mysql5.7" + }, + { + "DBClusterParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default cluster parameter group for aurora-postgresql9.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora-postgresql9.6" + }, + { + "DBClusterParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default cluster parameter group for aurora5.6", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:default.aurora5.6" + }, + { + "DBClusterParameterGroupName": "mydbclusterpg", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "My DB cluster parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpg" + }, + { + "DBClusterParameterGroupName": "mydbclusterpgcopy", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Copy of mydbclusterpg parameter group", + "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy" + } + ] + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-cluster-parameters.rst b/aws/dist/awscli/examples/rds/describe-db-cluster-parameters.rst new file mode 100644 index 00000000..877f80e0 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-cluster-parameters.rst @@ -0,0 +1,43 @@ +**To describe the parameters in a DB cluster parameter group** + +The following ``describe-db-cluster-parameters`` example retrieves details about the parameters in a DB cluster parameter group. :: + + aws rds describe-db-cluster-parameters \ + --db-cluster-parameter-group-name mydbclusterpg + +Output:: + + { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + { + "ParameterName": "aurora_lab_mode", + "ParameterValue": "0", + "Description": "Enables new features in the Aurora engine.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": true, + "ApplyMethod": "pending-reboot", + "SupportedEngineModes": [ + "provisioned" + ] + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst b/aws/dist/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst new file mode 100644 index 00000000..83a5c532 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-cluster-snapshot-attributes.rst @@ -0,0 +1,24 @@ +**To describe the attribute names and values for a DB cluster snapshot** + +The following ``describe-db-cluster-snapshot-attributes`` example retrieves details of the attribute names and values for the specified DB cluster snapshot. :: + + aws rds describe-db-cluster-snapshot-attributes \ + --db-cluster-snapshot-identifier myclustersnapshot + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + +For more information, see `Sharing a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-cluster-snapshots.rst b/aws/dist/awscli/examples/rds/describe-db-cluster-snapshots.rst new file mode 100644 index 00000000..00850b7b --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-cluster-snapshots.rst @@ -0,0 +1,65 @@ +**To describe a DB cluster snapshot for a DB cluster** + +The following ``describe-db-cluster-snapshots`` example retrieves the details for the DB cluster snapshots for the specified DB cluster. :: + + aws rds describe-db-cluster-snapshots \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusterSnapshots": [ + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "myclustersnapshotcopy", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-04T09:16:42.649Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "manual", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:814387698303:cluster-snapshot:myclustersnapshotcopy", + "IAMDatabaseAuthenticationEnabled": false + }, + { + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "DBClusterSnapshotIdentifier": "rds:mydbcluster-2019-06-20-09-16", + "DBClusterIdentifier": "mydbcluster", + "SnapshotCreateTime": "2019-06-20T09:16:26.569Z", + "Engine": "aurora-mysql", + "AllocatedStorage": 0, + "Status": "available", + "Port": 0, + "VpcId": "vpc-6594f31c", + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "MasterUsername": "myadmin", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LicenseModel": "aurora-mysql", + "SnapshotType": "automated", + "PercentProgress": 100, + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:mydbcluster-2019-06-20-09-16", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + +For more information, see `Creating a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-clusters.rst b/aws/dist/awscli/examples/rds/describe-db-clusters.rst new file mode 100644 index 00000000..983c3df8 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-clusters.rst @@ -0,0 +1,96 @@ +**To describe a DB cluster** + +The following ``describe-db-clusters`` example retrieves the details of the specified DB cluster. :: + + aws rds describe-db-clusters \ + --db-cluster-identifier mydbcluster + +Output:: + + { + "DBClusters": [ + { + "AllocatedStorage": 1, + "AvailabilityZones": [ + "us-east-1a", + "us-east-1b", + "us-east-1e" + ], + "BackupRetentionPeriod": 1, + "DatabaseName": "mydbcluster", + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroup": "default.aurora-mysql5.7", + "DBSubnetGroup": "default", + "Status": "available", + "EarliestRestorableTime": "2019-06-19T09:16:28.210Z", + "Endpoint": "mydbcluster.cluster-cnpexample.us-east-1.rds.amazonaws.com", + "ReaderEndpoint": "mydbcluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com", + "MultiAZ": true, + "Engine": "aurora-mysql", + "EngineVersion": "5.7.mysql_aurora.2.04.2", + "LatestRestorableTime": "2019-06-20T22:38:14.908Z", + "Port": 3306, + "MasterUsername": "myadmin", + "PreferredBackupWindow": "09:09-09:39", + "PreferredMaintenanceWindow": "sat:04:09-sat:04:39", + "ReadReplicaIdentifiers": [], + "DBClusterMembers": [ + { + "DBInstanceIdentifier": "dbinstance3", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance1", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "dbinstance2", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster-us-east-1b", + "IsClusterWriter": false, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + }, + { + "DBInstanceIdentifier": "mydbcluster", + "IsClusterWriter": true, + "DBClusterParameterGroupStatus": "in-sync", + "PromotionTier": 1 + } + ], + "VpcSecurityGroups": [ + { + "VpcSecurityGroupId": "sg-0b9130572daf3dc16", + "Status": "active" + } + ], + "HostedZoneId": "Z2R2ITUGPM61AM", + "StorageEncrypted": true, + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "DbClusterResourceId": "cluster-AKIAIOSFODNN7EXAMPLE", + "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:mydbcluster", + "AssociatedRoles": [], + "IAMDatabaseAuthenticationEnabled": false, + "ClusterCreateTime": "2019-04-15T14:18:42.785Z", + "EngineMode": "provisioned", + "DeletionProtection": false, + "HttpEndpointEnabled": false + } + ] + } + +For more information, see `Amazon Aurora DB Clusters `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-engine-versions.rst b/aws/dist/awscli/examples/rds/describe-db-engine-versions.rst new file mode 100644 index 00000000..36901023 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-engine-versions.rst @@ -0,0 +1,44 @@ +**To describe the DB engine versions for the MySQL DB engine** + +The following ``describe-db-engine-versions`` example displays details about each of the DB engine versions for the specified DB engine. :: + + aws rds describe-db-engine-versions \ + --engine mysql + +Output:: + + { + "DBEngineVersions": [ + { + "Engine": "mysql", + "EngineVersion": "5.5.46", + "DBParameterGroupFamily": "mysql5.5", + "DBEngineDescription": "MySQL Community Edition", + "DBEngineVersionDescription": "MySQL 5.5.46", + "ValidUpgradeTarget": [ + { + "Engine": "mysql", + "EngineVersion": "5.5.53", + "Description": "MySQL 5.5.53", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.5.54", + "Description": "MySQL 5.5.54", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + { + "Engine": "mysql", + "EngineVersion": "5.5.57", + "Description": "MySQL 5.5.57", + "AutoUpgrade": false, + "IsMajorVersionUpgrade": false + }, + ...some output truncated... + ] + } + +For more information, see `What Is Amazon Relational Database Service (Amazon RDS)? `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-instance-automated-backups.rst b/aws/dist/awscli/examples/rds/describe-db-instance-automated-backups.rst new file mode 100644 index 00000000..a05c8669 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-instance-automated-backups.rst @@ -0,0 +1,41 @@ +**To describe the automated backups for a DB instance** + +The following ``describe-db-instance-automated-backups`` example displays details about the automated backups for the specified DB instance. :: + + aws rds describe-db-instance-automated-backups \ + --db-instance-identifier database-mysql + +Output:: + + { + "DBInstanceAutomatedBackups": [ + { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:database-mysql", + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE", + "Region": "us-east-1", + "DBInstanceIdentifier": "database-mysql", + "RestoreWindow": { + "EarliestTime": "2019-06-13T08:39:38.359Z", + "LatestTime": "2019-06-20T23:00:00Z" + }, + "AllocatedStorage": 100, + "Status": "active", + "Port": 3306, + "AvailabilityZone": "us-east-1b", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2019-04-30T15:45:53Z", + "MasterUsername": "admin", + "Engine": "mysql", + "EngineVersion": "5.6.40", + "LicenseModel": "general-public-license", + "Iops": 1000, + "OptionGroupName": "default:mysql-5-6", + "Encrypted": true, + "StorageType": "io1", + "KmsKeyId": "arn:aws:kms:us-east-1:814387698303:key/AKIAIOSFODNN7EXAMPLE", + "IAMDatabaseAuthenticationEnabled": false + } + ] + } + +For more information, see `Working With Backups `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-instances.rst b/aws/dist/awscli/examples/rds/describe-db-instances.rst new file mode 100644 index 00000000..79b4b224 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-instances.rst @@ -0,0 +1,24 @@ +**To describe a DB instance** + +The following ``describe-db-instances`` example retrieves details about the specified DB instance. :: + + aws rds describe-db-instances \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "available", + "MasterUsername": "myawsuser", + "Endpoint": { + "Address": "test-instance.cdgmuqiadpid.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + }, + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/describe-db-log-files.rst b/aws/dist/awscli/examples/rds/describe-db-log-files.rst new file mode 100644 index 00000000..0e69d5e9 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-log-files.rst @@ -0,0 +1,43 @@ +**To describe the log files for a DB instance** + +The following ``describe-db-log-files`` example retrieves details about the log files for the specified DB instance. :: + + aws rds describe-db-log-files -\ + -db-instance-identifier test-instance + +Output:: + + { + "DescribeDBLogFiles": [ + { + "Size": 0, + "LastWritten": 1533060000000, + "LogFileName": "error/mysql-error-running.log" + }, + { + "Size": 2683, + "LastWritten": 1532994300000, + "LogFileName": "error/mysql-error-running.log.0" + }, + { + "Size": 107, + "LastWritten": 1533057300000, + "LogFileName": "error/mysql-error-running.log.18" + }, + { + "Size": 13105, + "LastWritten": 1532991000000, + "LogFileName": "error/mysql-error-running.log.23" + }, + { + "Size": 0, + "LastWritten": 1533061200000, + "LogFileName": "error/mysql-error.log" + }, + { + "Size": 3519, + "LastWritten": 1532989252000, + "LogFileName": "mysqlUpgrade" + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-db-parameter-groups.rst b/aws/dist/awscli/examples/rds/describe-db-parameter-groups.rst new file mode 100644 index 00000000..2868c7a5 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-parameter-groups.rst @@ -0,0 +1,39 @@ +**To describe your DB parameter group** + +The following ``describe-db-parameter-groups`` example retrieves details about your DB parameter groups. :: + + aws rds describe-db-parameter-groups + +Output:: + + { + "DBParameterGroups": [ + { + "DBParameterGroupName": "default.aurora-mysql5.7", + "DBParameterGroupFamily": "aurora-mysql5.7", + "Description": "Default parameter group for aurora-mysql5.7", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-mysql5.7" + }, + { + "DBParameterGroupName": "default.aurora-postgresql9.6", + "DBParameterGroupFamily": "aurora-postgresql9.6", + "Description": "Default parameter group for aurora-postgresql9.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora-postgresql9.6" + }, + { + "DBParameterGroupName": "default.aurora5.6", + "DBParameterGroupFamily": "aurora5.6", + "Description": "Default parameter group for aurora5.6", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.aurora5.6" + }, + { + "DBParameterGroupName": "default.mariadb10.1", + "DBParameterGroupFamily": "mariadb10.1", + "Description": "Default parameter group for mariadb10.1", + "DBParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:pg:default.mariadb10.1" + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-parameters.rst b/aws/dist/awscli/examples/rds/describe-db-parameters.rst new file mode 100644 index 00000000..702a8a8b --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-parameters.rst @@ -0,0 +1,36 @@ +**To describe the parameters in a DB parameter group** + +The following ``describe-db-parameters`` example retrieves the details of the specified DB parameter group. :: + + aws rds describe-db-parameters \ + --db-parameter-group-name mydbpg + +Output:: + + { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + { + "ParameterName": "auto_generate_certs", + "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false, + "ApplyMethod": "pending-reboot" + }, + ...some output truncated... + ] + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-snapshot-attributes.rst b/aws/dist/awscli/examples/rds/describe-db-snapshot-attributes.rst new file mode 100644 index 00000000..667a2f70 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-snapshot-attributes.rst @@ -0,0 +1,25 @@ +**To describe the attribute names and values for a DB snapshot** + +The following ``describe-db-snapshot-attributes`` example describes the attribute names and values for a DB snapshot. :: + + aws rds describe-db-snapshot-attributes \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshotAttributesResult": { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012", + "210987654321" + ] + } + ] + } + } + +For more information, see `Sharing a DB Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-snapshots.rst b/aws/dist/awscli/examples/rds/describe-db-snapshots.rst new file mode 100644 index 00000000..1b78043a --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-snapshots.rst @@ -0,0 +1,39 @@ +**To describe a DB snapshot for a DB instance** + +The following ``describe-db-snapshots`` example retrieves the details of a DB snapshot for a DB instance. :: + + aws rds describe-db-snapshots \ + --db-snapshot-identifier mydbsnapshot + +Output:: + + { + "DBSnapshots": [ + { + "DBSnapshotIdentifier": "mydbsnapshot", + "DBInstanceIdentifier": "mysqldb", + "SnapshotCreateTime": "2018-02-08T22:28:08.598Z", + "Engine": "mysql", + "AllocatedStorage": 20, + "Status": "available", + "Port": 3306, + "AvailabilityZone": "us-east-1f", + "VpcId": "vpc-6594f31c", + "InstanceCreateTime": "2018-02-08T22:24:55.973Z", + "MasterUsername": "mysqladmin", + "EngineVersion": "5.6.37", + "LicenseModel": "general-public-license", + "SnapshotType": "manual", + "OptionGroupName": "default:mysql-5-6", + "PercentProgress": 100, + "StorageType": "gp2", + "Encrypted": false, + "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", + "IAMDatabaseAuthenticationEnabled": false, + "ProcessorFeatures": [], + "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE" + } + ] + } + +For more information, see `Creating a DB Snapshot `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-db-subnet-groups.rst b/aws/dist/awscli/examples/rds/describe-db-subnet-groups.rst new file mode 100644 index 00000000..7e6d2a62 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-db-subnet-groups.rst @@ -0,0 +1,51 @@ +**To describe a DB subnet group** + +The following ``describe-db-subnet-groups`` example retrieves the details of the specified DB subnet group. :: + + aws rds describe-db-subnet-groups + +Output:: + + { + "DBSubnetGroups": [ + { + "DBSubnetGroupName": "mydbsubnetgroup", + "DBSubnetGroupDescription": "My DB Subnet Group", + "VpcId": "vpc-971c12ee", + "SubnetGroupStatus": "Complete", + "Subnets": [ + { + "SubnetIdentifier": "subnet-d8c8e7f4", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-718fdc7d", + "SubnetAvailabilityZone": { + "Name": "us-east-1f" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-cbc8e7e7", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + }, + { + "SubnetIdentifier": "subnet-0ccde220", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + }, + "SubnetStatus": "Active" + } + ], + "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup" + } + ] + } + +For more information, see `Amazon Virtual Private Cloud VPCs and Amazon RDS `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-engine-default-cluster-parameters.rst b/aws/dist/awscli/examples/rds/describe-engine-default-cluster-parameters.rst new file mode 100644 index 00000000..b9830b11 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-engine-default-cluster-parameters.rst @@ -0,0 +1,29 @@ +**To describe the default engine and system parameter information for the Aurora database engine** + +The following ``describe-engine-default-cluster-parameters`` example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility. :: + + aws rds describe-engine-default-cluster-parameters \ + --db-parameter-group-family aurora-mysql5.7 + +Output:: + + { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "aurora_load_from_s3_role", + "Description": "IAM role ARN used to load data from AWS S3", + "Source": "engine-default", + "ApplyType": "dynamic", + "DataType": "string", + "IsModifiable": true, + "SupportedEngineModes": [ + "provisioned" + ] + }, + ...some output truncated... + ] + } + } + +For more information, see `Working with DB Parameter Groups and DB Cluster Parameter Groups `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-engine-default-parameters.rst b/aws/dist/awscli/examples/rds/describe-engine-default-parameters.rst new file mode 100644 index 00000000..8b7fa81b --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-engine-default-parameters.rst @@ -0,0 +1,27 @@ +**To describe the default engine and system parameter information for the database engine** + +The following ``describe-engine-default-parameters`` example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances. :: + + aws rds describe-engine-default-parameters \ + --db-parameter-group-family mysql5.7 + +Output:: + + { + "EngineDefaults": { + "Parameters": [ + { + "ParameterName": "allow-suspicious-udfs", + "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded", + "Source": "engine-default", + "ApplyType": "static", + "DataType": "boolean", + "AllowedValues": "0,1", + "IsModifiable": false + }, + ...some output truncated... + ] + } + } + +For more information, see `Working with DB Parameter Groups `__ in the *Amazon RDS User Guide*. diff --git a/aws/dist/awscli/examples/rds/describe-event-categories.rst b/aws/dist/awscli/examples/rds/describe-event-categories.rst new file mode 100644 index 00000000..f74dbe96 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-event-categories.rst @@ -0,0 +1,67 @@ +**To describe event categories** + +The following ``describe-event-categories`` example retrieves details about the event categories for all available event sources. :: + + aws rds describe-event-categories + +Output:: + + { + "EventCategoriesMapList": [ + { + "SourceType": "db-instance", + "EventCategories": [ + "deletion", + "read replica", + "failover", + "restoration", + "maintenance", + "low storage", + "configuration change", + "backup", + "creation", + "availability", + "recovery", + "failure", + "backtrack", + "notification" + ] + }, + { + "SourceType": "db-security-group", + "EventCategories": [ + "configuration change", + "failure" + ] + }, + { + "SourceType": "db-parameter-group", + "EventCategories": [ + "configuration change" + ] + }, + { + "SourceType": "db-snapshot", + "EventCategories": [ + "deletion", + "creation", + "restoration", + "notification" + ] + }, + { + "SourceType": "db-cluster", + "EventCategories": [ + "failover", + "failure", + "notification" + ] + }, + { + "SourceType": "db-cluster-snapshot", + "EventCategories": [ + "backup" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-event-subscriptions.rst b/aws/dist/awscli/examples/rds/describe-event-subscriptions.rst new file mode 100644 index 00000000..911fd0f5 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-event-subscriptions.rst @@ -0,0 +1,27 @@ +**To describe event subscriptions** + +This example describes all of the Amazon RDS event subscriptions for the current AWS account. :: + + aws rds describe-event-subscriptions + +Output:: + + { + "EventSubscriptionsList": [ + { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "Enabled": true, + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "Status": "creating", + "SourceType": "db-instance", + "CustomerAwsId": "123456789012", + "SubscriptionCreationTime": "2018-07-31 23:22:01.893", + "CustSubscriptionId": "my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events" + }, + ...some output truncated... + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-events.rst b/aws/dist/awscli/examples/rds/describe-events.rst new file mode 100644 index 00000000..f97ffbd5 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-events.rst @@ -0,0 +1,34 @@ +**To describe events** + +The following ``describe-events`` example retrieves details for the events that have occurred for the specified DB instance. :: + + aws rds describe-events \ + --source-identifier test-instance \ + --source-type db-instance + +Output:: + + { + "Events": [ + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Backing up DB instance", + "Date": "2018-07-31T23:09:23.983Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + }, + { + "SourceType": "db-instance", + "SourceIdentifier": "test-instance", + "EventCategories": [ + "backup" + ], + "Message": "Finished DB Instance backup", + "Date": "2018-07-31T23:15:13.049Z", + "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance" + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-orderable-db-instance-options.rst b/aws/dist/awscli/examples/rds/describe-orderable-db-instance-options.rst new file mode 100644 index 00000000..3a670dca --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-orderable-db-instance-options.rst @@ -0,0 +1,46 @@ +**To describe orderable DB instance options** + +The following ``describe-orderable-db-instance-options`` example retrieves details about the orderable options for a DB instances running the MySQL DB engine. :: + + aws rds describe-orderable-db-instance-options \ + --engine mysql + +Output:: + + { + "OrderableDBInstanceOptions": [ + { + "MinStorageSize": 5, + "ReadReplicaCapable": true, + "MaxStorageSize": 6144, + "AvailabilityZones": [ + { + "Name": "us-east-1a" + }, + { + "Name": "us-east-1b" + }, + { + "Name": "us-east-1c" + }, + { + "Name": "us-east-1d" + } + ], + "SupportsIops": false, + "AvailableProcessorFeatures": [], + "MultiAZCapable": true, + "DBInstanceClass": "db.m1.large", + "Vpc": true, + "StorageType": "gp2", + "LicenseModel": "general-public-license", + "EngineVersion": "5.5.46", + "SupportsStorageEncryption": false, + "SupportsEnhancedMonitoring": true, + "Engine": "mysql", + "SupportsIAMDatabaseAuthentication": false, + "SupportsPerformanceInsights": false + } + ] + ...some output truncated... + } diff --git a/aws/dist/awscli/examples/rds/describe-reserved-db-instances-offerings.rst b/aws/dist/awscli/examples/rds/describe-reserved-db-instances-offerings.rst new file mode 100644 index 00000000..66839c81 --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-reserved-db-instances-offerings.rst @@ -0,0 +1,30 @@ +**To describe reserved DB instance offerings** + +The following ``describe-reserved-db-instances-offerings`` example retrieves details about reserved DB instance options for ``oracle``. :: + + aws rds describe-reserved-db-instances-offerings \ + --product-description oracle + +Output:: + + { + "ReservedDBInstancesOfferings": [ + { + "CurrencyCode": "USD", + "UsagePrice": 0.0, + "ProductDescription": "oracle-se2(li)", + "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8", + "MultiAZ": true, + "DBInstanceClass": "db.m4.xlarge", + "OfferingType": "Partial Upfront", + "RecurringCharges": [ + { + "RecurringChargeAmount": 0.594, + "RecurringChargeFrequency": "Hourly" + } + ], + "FixedPrice": 4089.0, + "Duration": 31536000 + }, + ...some output truncated... + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/rds/describe-reserved-db-instances.rst b/aws/dist/awscli/examples/rds/describe-reserved-db-instances.rst new file mode 100644 index 00000000..6aabc4fa --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-reserved-db-instances.rst @@ -0,0 +1,6 @@ +**To describe reserved DB instances** + +The following ``describe-reserved-db-instances`` example retrieves details about any reserved DB instances in the current AWS account. :: + + aws rds describe-reserved-db-instances + diff --git a/aws/dist/awscli/examples/rds/describe-source-regions.rst b/aws/dist/awscli/examples/rds/describe-source-regions.rst new file mode 100644 index 00000000..027ffc1c --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-source-regions.rst @@ -0,0 +1,67 @@ +**To describe source regions** + +The following ``describe-source-regions`` example retrieves details about all of the source regions. :: + + aws rds describe-source-regions + +Output:: + + { + "SourceRegions": [ + { + "RegionName": "ap-northeast-1", + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-northeast-2", + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-south-1", + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-southeast-1", + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "ap-southeast-2", + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-central-1", + "Endpoint": "https://rds.eu-central-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-west-1", + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "eu-west-2", + "Endpoint": "https://rds.eu-west-2.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "sa-east-1", + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "us-east-1", + "Endpoint": "https://rds.amazonaws.com", + "Status": "available" + }, + { + "RegionName": "us-west-1", + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "Status": "available" + } + ] + } diff --git a/aws/dist/awscli/examples/rds/describe-valid-db-instance-modifications.rst b/aws/dist/awscli/examples/rds/describe-valid-db-instance-modifications.rst new file mode 100644 index 00000000..aa4e7cff --- /dev/null +++ b/aws/dist/awscli/examples/rds/describe-valid-db-instance-modifications.rst @@ -0,0 +1,95 @@ +**To describe valid modifications for a DB instance** + +The following ``describe-valid-db-instance-modifications`` example retrieves details about the valid modifications for the specified DB instance. :: + + aws rds describe-valid-db-instance-modifications \ + --db-instance-identifier test-instance + +Output:: + + { + "ValidDBInstanceModificationsMessage": { + "ValidProcessorFeatures": [], + "Storage": [ + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 6144, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "gp2" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 6144, + "From": 100 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 40000, + "From": 1000 + } + ], + "IopsToStorageRatio": [ + { + "To": 50.0, + "From": 1.0 + } + ], + "StorageType": "io1" + }, + { + "StorageSize": [ + { + "Step": 1, + "To": 20, + "From": 20 + }, + { + "Step": 1, + "To": 3072, + "From": 22 + } + ], + "ProvisionedIops": [ + { + "Step": 1, + "To": 0, + "From": 0 + } + ], + "IopsToStorageRatio": [ + { + "To": 0.0, + "From": 0.0 + } + ], + "StorageType": "magnetic" + } + ] + } + } diff --git a/aws/dist/awscli/examples/rds/download-db-log-file-portion.rst b/aws/dist/awscli/examples/rds/download-db-log-file-portion.rst new file mode 100644 index 00000000..3434b57b --- /dev/null +++ b/aws/dist/awscli/examples/rds/download-db-log-file-portion.rst @@ -0,0 +1,18 @@ +**To download a DB log file** + +The following ``download-db-log-file-portion`` example downloads only the latest part of your log file, saving it to a local file named ``tail.txt``. :: + + aws rds download-db-log-file-portion \ + --db-instance-identifier test-instance \ + --log-file-name log.txt \ + --output text > tail.txt + +To download the entire file, you need to include the ``--starting-token 0`` parameter. The following example saves the output to a local file named ``full.txt``. :: + + aws rds download-db-log-file-portion \ + --db-instance-identifier test-instance \ + --log-file-name log.txt \ + --starting-token 0 \ + --output text > full.txt + +The saved file might contain blank lines. They appear at the end of each part of the log file while being downloaded. This generally doesn't cause any trouble in your log file analysis. diff --git a/aws/dist/awscli/examples/rds/generate-auth-token.rst b/aws/dist/awscli/examples/rds/generate-auth-token.rst new file mode 100644 index 00000000..b2866a45 --- /dev/null +++ b/aws/dist/awscli/examples/rds/generate-auth-token.rst @@ -0,0 +1,13 @@ +**To generate an authentication token** + +The following ``generate-db-auth-token`` example generates an authentication token for use with IAM database authentication. :: + + aws rds generate-db-auth-token \ + --hostname aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com \ + --port 3306 \ + --region us-east-1 \ + --username jane_doe + +Output:: + + aurmysql-test.cdgmuqiadpid.us-west-2.rds.amazonaws.com:3306/?Action=connect&DBUser=jane_doe&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIESZCNJ3OEXAMPLE%2F20180731%2Fus-east-1%2Frds-db%2Faws4_request&X-Amz-Date=20180731T235209Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=5a8753ebEXAMPLEa2c724e5667797EXAMPLE9d6ec6e3f427191fa41aeEXAMPLE diff --git a/aws/dist/awscli/examples/rds/modify-db-cluster-endpoint.rst b/aws/dist/awscli/examples/rds/modify-db-cluster-endpoint.rst new file mode 100644 index 00000000..d408d29a --- /dev/null +++ b/aws/dist/awscli/examples/rds/modify-db-cluster-endpoint.rst @@ -0,0 +1,28 @@ +**To modify a custom DB cluster endpoint** + +The following ``modify-db-cluster-endpoint`` example modifies the specified custom DB cluster endpoint. :: + + aws rds modify-db-cluster-endpoint \ + --db-cluster-endpoint-identifier mycustomendpoint \ + --static-members dbinstance1 dbinstance2 dbinstance3 + +Output:: + + { + "DBClusterEndpointIdentifier": "mycustomendpoint", + "DBClusterIdentifier": "mydbcluster", + "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE", + "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com", + "Status": "modifying", + "EndpointType": "CUSTOM", + "CustomEndpointType": "READER", + "StaticMembers": [ + "dbinstance1", + "dbinstance2", + "dbinstance3" + ], + "ExcludedMembers": [], + "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint" + } + +For more information, see `Amazon Aurora Connection Management `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst b/aws/dist/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst new file mode 100644 index 00000000..3aa08bd3 --- /dev/null +++ b/aws/dist/awscli/examples/rds/modify-db-cluster-snapshot-attribute.rst @@ -0,0 +1,26 @@ +**To modify a DB cluster snapshot attribute** + +The following ``modify-db-cluster-snapshot-attribute`` example makes changes to the specified DB cluster snapshot attribute. :: + + aws rds modify-db-cluster-snapshot-attribute \ + --db-cluster-snapshot-identifier myclustersnapshot \ + --attribute-name restore \ + --values-to-add 123456789012 + +Output:: + + { + "DBClusterSnapshotAttributesResult": { + "DBClusterSnapshotIdentifier": "myclustersnapshot", + "DBClusterSnapshotAttributes": [ + { + "AttributeName": "restore", + "AttributeValues": [ + "123456789012" + ] + } + ] + } + } + +For more information, see `Restoring from a DB Cluster Snapshot `__ in the *Amazon Aurora User Guide*. diff --git a/aws/dist/awscli/examples/rds/modify-db-instance.rst b/aws/dist/awscli/examples/rds/modify-db-instance.rst new file mode 100644 index 00000000..07480493 --- /dev/null +++ b/aws/dist/awscli/examples/rds/modify-db-instance.rst @@ -0,0 +1,24 @@ +**To modify a DB instance** + +The following ``modify-db-instance`` example changes the instance class of the specified running DB instance. The ``--apply-immediately`` parameter causes the DB engine to be replaced immediately, instead of waiting until the next maintenance window. :: + + aws rds modify-db-instance \ + --db-instance-identifier test-instance \ + --db-instance-class db.m1.large \ + --apply-immediately + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "modifying", + <...output omitted...> + "PendingModifiedValues": { + "DBInstanceClass": "db.m1.large" + } + <...some output omitted...> + } + } diff --git a/aws/dist/awscli/examples/rds/modify-event-subscription.rst b/aws/dist/awscli/examples/rds/modify-event-subscription.rst new file mode 100644 index 00000000..a27fb132 --- /dev/null +++ b/aws/dist/awscli/examples/rds/modify-event-subscription.rst @@ -0,0 +1,26 @@ +**To modify an event subscription** + +The following ``modify-event-subscription`` example disables the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic. :: + + aws rds modify-event-subscription \ + --subscription-name my-instance-events \ + --no-enabled + +Output:: + + { + "EventSubscription": { + "EventCategoriesList": [ + "backup", + "recovery" + ], + "CustomerAwsId": "123456789012", + "SourceType": "db-instance", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "CustSubscriptionId": "my-instance-events", + "Status": "modifying", + "Enabled": false + } + } diff --git a/aws/dist/awscli/examples/rds/promote-read-replica.rst b/aws/dist/awscli/examples/rds/promote-read-replica.rst new file mode 100644 index 00000000..f81e4b18 --- /dev/null +++ b/aws/dist/awscli/examples/rds/promote-read-replica.rst @@ -0,0 +1,18 @@ +**To promote a read replica** + +The following ``promote-read-replica`` example promotes the specified read replica to become a standalone DB instance. :: + + aws rds promote-read-replica \ + --db-instance-identifier test-instance-repl + +Output:: + + { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl", + "StorageType": "standard", + "ReadReplicaSourceDBInstanceIdentifier": "test-instance", + "DBInstanceStatus": "modifying", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/purchase-reserved-db-instance.rst b/aws/dist/awscli/examples/rds/purchase-reserved-db-instance.rst new file mode 100644 index 00000000..37dd044b --- /dev/null +++ b/aws/dist/awscli/examples/rds/purchase-reserved-db-instance.rst @@ -0,0 +1,7 @@ +**To purchase a reserved DB instance offering** + +The following ``purchase-reserved-db-instances-offering`` example purchases a reserved DB instance offering. The ``reserved-db-instances-offering-id`` must be a valid offering ID, as returned by the ``describe-reserved-db-instances-offering`` command. + + aws rds purchase-reserved-db-instances-offering \ + --reserved-db-instances-offering-id 438012d3-4a52-4cc7-b2e3-8dff72e0e706 + diff --git a/aws/dist/awscli/examples/rds/reboot-db-instance.rst b/aws/dist/awscli/examples/rds/reboot-db-instance.rst new file mode 100644 index 00000000..458d3cb8 --- /dev/null +++ b/aws/dist/awscli/examples/rds/reboot-db-instance.rst @@ -0,0 +1,24 @@ +**To reboot a DB instance** + +The following ``reboot-db-instance`` example starts a reboot of the specified DB instance. :: + + aws rds reboot-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceIdentifier": "test-instance", + "DBInstanceClass": "db.m1.small", + "Engine": "mysql", + "DBInstanceStatus": "rebooting", + "MasterUsername": "myawsuser", + "Endpoint": { + "Address": "test-instance.cdgmuqiadpid.us-east-1.rds.amazonaws.com", + "Port": 3306, + "HostedZoneId": "Z2R2ITUGPM61AM" + }, + <...some output omitted...> + } + } diff --git a/aws/dist/awscli/examples/rds/remove-source-identifier-from-subscription.rst b/aws/dist/awscli/examples/rds/remove-source-identifier-from-subscription.rst new file mode 100644 index 00000000..b809d695 --- /dev/null +++ b/aws/dist/awscli/examples/rds/remove-source-identifier-from-subscription.rst @@ -0,0 +1,29 @@ +**To remove a source identifier from a subscription** + +The following ``remove-source-identifier`` example removes the specified source identifier from an existing subscription. :: + + aws rds remove-source-identifier-from-subscription \ + --subscription-name my-instance-events \ + --source-identifier test-instance-repl + +Output:: + + { + "EventSubscription": { + "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events", + "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018", + "EventCategoriesList": [ + "backup", + "recovery" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events", + "Status": "modifying", + "CustSubscriptionId": "my-instance-events", + "CustomerAwsId": "123456789012", + "SourceIdsList": [ + "test-instance" + ], + "SourceType": "db-instance", + "Enabled": false + } + } diff --git a/aws/dist/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst b/aws/dist/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst new file mode 100644 index 00000000..ce4e30e9 --- /dev/null +++ b/aws/dist/awscli/examples/rds/restore-db-instance-from-db-snapshot.rst @@ -0,0 +1,17 @@ +**To restore a DB instance from a DB snapshot** + +The following ``restore-db-instance-from-db-snapshot`` example creates a new DB instance named ``restored-test-instance`` from the specified DB snapshot. :: + + aws rds restore-db-instance-from-db-snapshot \ + --db-instance-identifier restored-test-instance \ + --db-snapshot-identifier test-instance-snap + +Output:: + + { + "DBInstance": { + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", + "DBInstanceStatus": "creating", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/restore-db-instance-from-s3.rst b/aws/dist/awscli/examples/rds/restore-db-instance-from-s3.rst new file mode 100644 index 00000000..287a9024 --- /dev/null +++ b/aws/dist/awscli/examples/rds/restore-db-instance-from-s3.rst @@ -0,0 +1,10 @@ +**To restore a DB instance from a backup in Amazon S3** + +The following ``restore-db-instance-from-s3`` example creates a new DB instance named ``restored-test-instance`` from an existing backup in the ``my-backups`` S3 bucket. :: + + aws rds restore-db-instance-from-s3 \ + --db-instance-identifier restored-test-instance \ + --allocated-storage 250 --db-instance-class db.m4.large --engine mysql \ + --master-username master --master-user-password secret99 \ + --s3-bucket-name my-backups --s3-ingestion-role-arn arn:aws:iam::123456789012:role/my-role \ + --source-engine mysql --source-engine-version 5.6.27 diff --git a/aws/dist/awscli/examples/rds/restore-db-instance-to-point-in-time.rst b/aws/dist/awscli/examples/rds/restore-db-instance-to-point-in-time.rst new file mode 100644 index 00000000..8e6ea177 --- /dev/null +++ b/aws/dist/awscli/examples/rds/restore-db-instance-to-point-in-time.rst @@ -0,0 +1,20 @@ +**To restore a DB instance to a point in time** + +The following ``restore-db-instance-to-point-in-time`` example restores ``test-instance`` to a new DB instance named ``restored-test-instance``, as of the specified time. :: + + aws rds restore-db-instance-to-point-in-time \ + --source-db-instance-identifier test-instance \ + --target-db-instance restored-test-instance \ + --restore-time 2018-07-30T23:45:00.000Z + +Output:: + + { + "DBInstance": { + "AllocatedStorage": 20, + "DBInstanceArn": "arn:aws:rds:us-east-1:123456789012:db:restored-test-instance", + "DBInstanceStatus": "creating", + "DBInstanceIdentifier": "restored-test-instance", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/start-db-instance.rst b/aws/dist/awscli/examples/rds/start-db-instance.rst new file mode 100644 index 00000000..8ce7d6dd --- /dev/null +++ b/aws/dist/awscli/examples/rds/start-db-instance.rst @@ -0,0 +1,15 @@ +**To start a DB instance** + +The following ``start-db-instance`` example starts the specified DB instance. :: + + aws rds start-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "starting", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/rds/stop-db-instance.rst b/aws/dist/awscli/examples/rds/stop-db-instance.rst new file mode 100644 index 00000000..779a6331 --- /dev/null +++ b/aws/dist/awscli/examples/rds/stop-db-instance.rst @@ -0,0 +1,15 @@ +**To stop a DB instance** + +The following ``stop-db-instance`` example stops the specified DB instance. :: + + aws rds stop-db-instance \ + --db-instance-identifier test-instance + +Output:: + + { + "DBInstance": { + "DBInstanceStatus": "stopping", + ...some output truncated... + } + } diff --git a/aws/dist/awscli/examples/redshift/authorize-cluster-security-group-ingress.rst b/aws/dist/awscli/examples/redshift/authorize-cluster-security-group-ingress.rst new file mode 100644 index 00000000..3d7fdcb1 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/authorize-cluster-security-group-ingress.rst @@ -0,0 +1,19 @@ +Authorizing Access to an EC2 Security Group +------------------------------------------- + +This example authorizes access to a named Amazon EC2 security group. + +Command:: + + aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890 + +Authorizing Access to a CIDR range +---------------------------------- + +This example authorizes access to a CIDR range. + +Command:: + + aws redshift authorize-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32 + + diff --git a/aws/dist/awscli/examples/redshift/authorize-snapshot-access.rst b/aws/dist/awscli/examples/redshift/authorize-snapshot-access.rst new file mode 100644 index 00000000..a96de4cd --- /dev/null +++ b/aws/dist/awscli/examples/redshift/authorize-snapshot-access.rst @@ -0,0 +1,39 @@ +Authorize an AWS Account to Restore a Snapshot +---------------------------------------------- + +This example authorizes the AWS account ``444455556666`` to restore the snapshot ``my-snapshot-id``. +By default, the output is in JSON format. + +Command:: + + aws redshift authorize-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666 + +Result:: + + { + "Snapshot": { + "Status": "available", + "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", + "EstimatedSecondsToCompletion": 0, + "AvailabilityZone": "us-east-1a", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "Encrypted": false, + "OwnerAccount": "111122223333", + "BackupProgressInMegabytes": 11.0, + "ElapsedTimeInSeconds": 0, + "DBName": "dev", + "CurrentBackupRateInMegabytesPerSecond: 0.1534, + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "ActualIncrementalBackupSizeInMegabytes"; 11.0, + "SnapshotType": "manual", + "NodeType": "dw.hs1.xlarge", + "ClusterIdentifier": "mycluster", + "TotalBackupSizeInMegabytes": 20.0, + "Port": 5439, + "NumberOfNodes": 2, + "SnapshotIdentifier": "my-snapshot-id" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/copy-cluster-snapshot.rst b/aws/dist/awscli/examples/redshift/copy-cluster-snapshot.rst new file mode 100644 index 00000000..b0e9b54b --- /dev/null +++ b/aws/dist/awscli/examples/redshift/copy-cluster-snapshot.rst @@ -0,0 +1,33 @@ +Get a Description of All Cluster Versions +----------------------------------------- + +This example returns a description of all cluster versions. By default, the output is in JSON format. + +Command:: + + aws redshift copy-cluster-snapshot --source-snapshot-identifier cm:examplecluster-2013-01-22-19-27-58 --target-snapshot-identifier my-saved-snapshot-copy + +Result:: + + { + "Snapshot": { + "Status": "available", + "SnapshotCreateTime": "2013-01-22T19:27:58.931Z", + "AvailabilityZone": "us-east-1c", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "DBName": "dev", + "ClusterCreateTime": "2013-01-22T19:23:59.368Z", + "SnapshotType": "manual", + "NodeType": "dw.hs1.xlarge", + "ClusterIdentifier": "examplecluster", + "Port": 5439, + "NumberOfNodes": "2", + "SnapshotIdentifier": "my-saved-snapshot-copy" + }, + "ResponseMetadata": { + "RequestId": "3b279691-64e3-11e2-bec0-17624ad140dd" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/create-cluster-parameter-group.rst b/aws/dist/awscli/examples/redshift/create-cluster-parameter-group.rst new file mode 100644 index 00000000..1fda0dac --- /dev/null +++ b/aws/dist/awscli/examples/redshift/create-cluster-parameter-group.rst @@ -0,0 +1,23 @@ +Create a Cluster Parameter Group +-------------------------------- + +This example creates a new cluster parameter group. + +Command:: + + aws redshift create-cluster-parameter-group --parameter-group-name myclusterparametergroup --parameter-group-family redshift-1.0 --description "My first cluster parameter group" + +Result:: + + { + "ClusterParameterGroup": { + "ParameterGroupFamily": "redshift-1.0", + "Description": "My first cluster parameter group", + "ParameterGroupName": "myclusterparametergroup" + }, + "ResponseMetadata": { + "RequestId": "739448f0-64cc-11e2-8f7d-3b939af52818" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/create-cluster-security-group.rst b/aws/dist/awscli/examples/redshift/create-cluster-security-group.rst new file mode 100644 index 00000000..524f3c57 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/create-cluster-security-group.rst @@ -0,0 +1,40 @@ +Creating a Cluster Security Group +--------------------------------- + +This example creates a new cluster security group. By default, the output is in JSON format. + +Command:: + + aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" + +Result:: + + { + "create_cluster_security_group_response": { + "create_cluster_security_group_result": { + "cluster_security_group": { + "description": "This is my cluster security group", + "owner_id": "300454760768", + "cluster_security_group_name": "mysecuritygroup", + "ec2_security_groups": \[], + "ip_ranges": \[] + } + }, + "response_metadata": { + "request_id": "5df486a0-343a-11e2-b0d8-d15d0ef48549" + } + } + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift create-cluster-security-group --cluster-security-group-name mysecuritygroup --description "This is my cluster security group" --output text + +Result:: + + This is my cluster security group 300454760768 mysecuritygroup + a0c0bfab-343a-11e2-95d2-c3dc9fe8ab57 + + diff --git a/aws/dist/awscli/examples/redshift/create-cluster-snapshot.rst b/aws/dist/awscli/examples/redshift/create-cluster-snapshot.rst new file mode 100644 index 00000000..198367fe --- /dev/null +++ b/aws/dist/awscli/examples/redshift/create-cluster-snapshot.rst @@ -0,0 +1,33 @@ +Create a Cluster Snapshot +------------------------- + +This example creates a new cluster snapshot. By default, the output is in JSON format. + +Command:: + + aws redshift create-cluster-snapshot --cluster-identifier mycluster --snapshot-identifier my-snapshot-id + +Result:: + + { + "Snapshot": { + "Status": "creating", + "SnapshotCreateTime": "2013-01-22T22:20:33.548Z", + "AvailabilityZone": "us-east-1a", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "DBName": "dev", + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "SnapshotType": "manual", + "NodeType": "dw.hs1.xlarge", + "ClusterIdentifier": "mycluster", + "Port": 5439, + "NumberOfNodes": "2", + "SnapshotIdentifier": "my-snapshot-id" + }, + "ResponseMetadata": { + "RequestId": "f024d1a5-64e1-11e2-88c5-53eb05787dfb" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/create-cluster-subnet-group.rst b/aws/dist/awscli/examples/redshift/create-cluster-subnet-group.rst new file mode 100644 index 00000000..a7eebd32 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/create-cluster-subnet-group.rst @@ -0,0 +1,32 @@ +Create a Cluster Subnet Group +----------------------------- + +This example creates a new cluster subnet group. + +Command:: + + aws redshift create-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --description "My subnet group" --subnet-ids subnet-763fdd1c + +Result:: + + { + "ClusterSubnetGroup": { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-763fdd1c", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + } + } ], + "VpcId": "vpc-7e3fdd14", + "SubnetGroupStatus": "Complete", + "Description": "My subnet group", + "ClusterSubnetGroupName": "mysubnetgroup" + }, + "ResponseMetadata": { + "RequestId": "500b8ce2-698f-11e2-9790-fd67517fb6fd" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/create-cluster.rst b/aws/dist/awscli/examples/redshift/create-cluster.rst new file mode 100644 index 00000000..3e158e6d --- /dev/null +++ b/aws/dist/awscli/examples/redshift/create-cluster.rst @@ -0,0 +1,45 @@ +Create a Cluster with Minimal Parameters +---------------------------------------- + +This example creates a cluster with the minimal set of parameters. By default, the output is in JSON format. + +Command:: + + aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster + +Result:: + + { + "Cluster": { + "NodeType": "dw.hs1.xlarge", + "ClusterVersion": "1.0", + "PubliclyAccessible": "true", + "MasterUsername": "adminuser", + "ClusterParameterGroups": [ + { + "ParameterApplyStatus": "in-sync", + "ParameterGroupName": "default.redshift-1.0" + } ], + "ClusterSecurityGroups": [ + { + "Status": "active", + "ClusterSecurityGroupName": "default" + } ], + "AllowVersionUpgrade": true, + "VpcSecurityGroups": \[], + "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", + "AutomatedSnapshotRetentionPeriod": 1, + "ClusterStatus": "creating", + "ClusterIdentifier": "mycluster", + "DBName": "dev", + "NumberOfNodes": 2, + "PendingModifiedValues": { + "MasterUserPassword": "\****" + } + }, + "ResponseMetadata": { + "RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/delete-cluster-parameter-group.rst b/aws/dist/awscli/examples/redshift/delete-cluster-parameter-group.rst new file mode 100644 index 00000000..9ae7973d --- /dev/null +++ b/aws/dist/awscli/examples/redshift/delete-cluster-parameter-group.rst @@ -0,0 +1,9 @@ +Delete a Cluster Parameter Group +-------------------------------- + +This example deletes a cluster parameter group. + +Command:: + + aws redshift delete-cluster-parameter-group --parameter-group-name myclusterparametergroup + diff --git a/aws/dist/awscli/examples/redshift/delete-cluster-security-group.rst b/aws/dist/awscli/examples/redshift/delete-cluster-security-group.rst new file mode 100644 index 00000000..68f47960 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/delete-cluster-security-group.rst @@ -0,0 +1,9 @@ +Delete a Cluster Security Group +------------------------------- + +This example deletes a cluster security group. + +Command:: + + aws redshift delete-cluster-security-group --cluster-security-group-name mysecuritygroup + diff --git a/aws/dist/awscli/examples/redshift/delete-cluster-snapshot.rst b/aws/dist/awscli/examples/redshift/delete-cluster-snapshot.rst new file mode 100644 index 00000000..d1920bc1 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/delete-cluster-snapshot.rst @@ -0,0 +1,9 @@ +Delete a Cluster Snapshot +------------------------- + +This example deletes a cluster snapshot. + +Command:: + + aws redshift delete-cluster-snapshot --snapshot-identifier my-snapshot-id + diff --git a/aws/dist/awscli/examples/redshift/delete-cluster-subnet-group.rst b/aws/dist/awscli/examples/redshift/delete-cluster-subnet-group.rst new file mode 100644 index 00000000..29b0cf9e --- /dev/null +++ b/aws/dist/awscli/examples/redshift/delete-cluster-subnet-group.rst @@ -0,0 +1,18 @@ +Delete a Cluster subnet Group +----------------------------- + +This example deletes a cluster subnet group. + +Command:: + + aws redshift delete-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup + +Result:: + + { + "ResponseMetadata": { + "RequestId": "253fbffd-6993-11e2-bc3a-47431073908a" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/delete-cluster.rst b/aws/dist/awscli/examples/redshift/delete-cluster.rst new file mode 100644 index 00000000..495bfe12 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/delete-cluster.rst @@ -0,0 +1,21 @@ +Delete a Cluster with No Final Cluster Snapshot +----------------------------------------------- + +This example deletes a cluster, forcing data deletion so no final cluster snapshot +is created. + +Command:: + + aws redshift delete-cluster --cluster-identifier mycluster --skip-final-cluster-snapshot + + +Delete a Cluster, Allowing a Final Cluster Snapshot +--------------------------------------------------- + +This example deletes a cluster, but specifies a final cluster snapshot. + +Command:: + + aws redshift delete-cluster --cluster-identifier mycluster --final-cluster-snapshot-identifier myfinalsnapshot + + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-parameter-groups.rst b/aws/dist/awscli/examples/redshift/describe-cluster-parameter-groups.rst new file mode 100644 index 00000000..619f6243 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-parameter-groups.rst @@ -0,0 +1,36 @@ +Get a Description of All Cluster Parameter Groups +------------------------------------------------- + +This example returns a description of all cluster parameter groups for the +account, with column headers. By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-parameter-groups + +Result:: + + { + "ParameterGroups": [ + { + "ParameterGroupFamily": "redshift-1.0", + "Description": "My first cluster parameter group", + "ParameterGroupName": "myclusterparametergroup" + } ], + "ResponseMetadata": { + "RequestId": "8ceb8f6f-64cc-11e2-bea9-49e0ce183f07" + } + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift describe-cluster-parameter-groups --output text + +Result:: + + redshift-1.0 My first cluster parameter group myclusterparametergroup + RESPONSEMETADATA 9e665a36-64cc-11e2-8f7d-3b939af52818 + + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-parameters.rst b/aws/dist/awscli/examples/redshift/describe-cluster-parameters.rst new file mode 100644 index 00000000..e661a83a --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-parameters.rst @@ -0,0 +1,52 @@ +Retrieve the Parameters for a Specified Cluster Parameter Group +--------------------------------------------------------------- + +This example retrieves the parameters for the named parameter group. By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup + +Result:: + + { + "Parameters": [ + { + "Description": "Sets the display format for date and time values.", + "DataType": "string", + "IsModifiable": true, + "Source": "engine-default", + "ParameterValue": "ISO, MDY", + "ParameterName": "datestyle" + }, + { + "Description": "Sets the number of digits displayed for floating-point values", + "DataType": "integer", + "IsModifiable": true, + "AllowedValues": "-15-2", + "Source": "engine-default", + "ParameterValue": "0", + "ParameterName": "extra_float_digits" + }, + (...remaining output omitted...) + ] + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift describe-cluster-parameters --parameter-group-name myclusterparametergroup --output text + +Result:: + + RESPONSEMETADATA cdac40aa-64cc-11e2-9e70-918437dd236d + Sets the display format for date and time values. string True engine-default ISO, MDY datestyle + Sets the number of digits displayed for floating-point values integer True -15-2 engine-default 0 extra_float_digits + This parameter applies a user-defined label to a group of queries that are run during the same session.. string True engine-default default query_group + require ssl for all databaseconnections boolean True true,false engine-default false require_ssl + Sets the schema search order for names that are not schema-qualified. string True engine-default $user, public search_path + Aborts any statement that takes over the specified number of milliseconds. integer True engine-default 0 statement_timeout + wlm json configuration string True engine-default \[{"query_concurrency":5}] wlm_json_configuration + + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-security-groups.rst b/aws/dist/awscli/examples/redshift/describe-cluster-security-groups.rst new file mode 100644 index 00000000..b53dbc09 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-security-groups.rst @@ -0,0 +1,37 @@ +Get a Description of All Cluster Security Groups +------------------------------------------------ + +This example returns a description of all cluster security groups for the account. +By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-security-groups + +Result:: + + { + "ClusterSecurityGroups": [ + { + "OwnerId": "100447751468", + "Description": "default", + "ClusterSecurityGroupName": "default", + "EC2SecurityGroups": \[], + "IPRanges": [ + { + "Status": "authorized", + "CIDRIP": "0.0.0.0/0" + } + ] + }, + { + "OwnerId": "100447751468", + "Description": "This is my cluster security group", + "ClusterSecurityGroupName": "mysecuritygroup", + "EC2SecurityGroups": \[], + "IPRanges": \[] + }, + (...remaining output omitted...) + ] + } + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-snapshots.rst b/aws/dist/awscli/examples/redshift/describe-cluster-snapshots.rst new file mode 100644 index 00000000..b5f6846d --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-snapshots.rst @@ -0,0 +1,68 @@ +Get a Description of All Cluster Snapshots +------------------------------------------ + +This example returns a description of all cluster snapshots for the +account. By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-snapshots + +Result:: + + { + "Snapshots": [ + { + "Status": "available", + "SnapshotCreateTime": "2013-07-17T22:02:22.852Z", + "EstimatedSecondsToCompletion": -1, + "AvailabilityZone": "us-east-1a", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "Encrypted": false, + "OwnerAccount": "111122223333", + "BackupProgressInMegabytes": 20.0, + "ElapsedTimeInSeconds": 0, + "DBName": "dev", + "CurrentBackupRateInMegabytesPerSecond: 0.0, + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "ActualIncrementalBackupSizeInMegabytes"; 20.0 + "SnapshotType": "automated", + "NodeType": "dw.hs1.xlarge", + "ClusterIdentifier": "mycluster", + "Port": 5439, + "TotalBackupSizeInMegabytes": 20.0, + "NumberOfNodes": "2", + "SnapshotIdentifier": "cm:mycluster-2013-01-22-22-04-18" + }, + { + "EstimatedSecondsToCompletion": 0, + "OwnerAccount": "111122223333", + "CurrentBackupRateInMegabytesPerSecond: 0.1534, + "ActualIncrementalBackupSizeInMegabytes"; 11.0, + "NumberOfNodes": "2", + "Status": "available", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "AccountsWithRestoreAccess": [ + { + "AccountID": "444455556666" + } ], + "TotalBackupSizeInMegabytes": 20.0, + "DBName": "dev", + "BackupProgressInMegabytes": 11.0, + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "ElapsedTimeInSeconds": 0, + "ClusterIdentifier": "mycluster", + "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", + "AvailabilityZone": "us-east-1a", + "NodeType": "dw.hs1.xlarge", + "Encrypted": false, + "SnapshotType": "manual", + "Port": 5439, + "SnapshotIdentifier": "my-snapshot-id" + } ] + } + (...remaining output omitted...) + + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-subnet-groups.rst b/aws/dist/awscli/examples/redshift/describe-cluster-subnet-groups.rst new file mode 100644 index 00000000..9e9869a1 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-subnet-groups.rst @@ -0,0 +1,34 @@ +Get a Description of All Cluster Subnet Groups +---------------------------------------------- + +This example returns a description of all cluster subnet groups. By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-subnet-groups + +Result:: + + { + "ClusterSubnetGroups": [ + { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-763fdd1c", + "SubnetAvailabilityZone": { + "Name": "us-east-1a" + } + } + ], + "VpcId": "vpc-7e3fdd14", + "SubnetGroupStatus": "Complete", + "Description": "My subnet group", + "ClusterSubnetGroupName": "mysubnetgroup" + } + ], + "ResponseMetadata": { + "RequestId": "37fa8c89-6990-11e2-8f75-ab4018764c77" + } + } + diff --git a/aws/dist/awscli/examples/redshift/describe-cluster-versions.rst b/aws/dist/awscli/examples/redshift/describe-cluster-versions.rst new file mode 100644 index 00000000..fbb113d4 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-cluster-versions.rst @@ -0,0 +1,23 @@ +Get a Description of All Cluster Versions +----------------------------------------- + +This example returns a description of all cluster versions. By default, the output is in JSON format. + +Command:: + + aws redshift describe-cluster-versions + +Result:: + + { + "ClusterVersions": [ + { + "ClusterVersion": "1.0", + "Description": "Initial release", + "ClusterParameterGroupFamily": "redshift-1.0" + } ], + "ResponseMetadata": { + "RequestId": "16a53de3-64cc-11e2-bec0-17624ad140dd" + } + } + diff --git a/aws/dist/awscli/examples/redshift/describe-clusters.rst b/aws/dist/awscli/examples/redshift/describe-clusters.rst new file mode 100644 index 00000000..ec3afa6b --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-clusters.rst @@ -0,0 +1,64 @@ +Get a Description of All Clusters +--------------------------------- + +This example returns a description of all clusters for the account. By default, the output is in JSON format. + +Command:: + + aws redshift describe-clusters + +Result:: + + { + "Clusters": [ + { + "NodeType": "dw.hs1.xlarge", + "Endpoint": { + "Port": 5439, + "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com" + }, + "ClusterVersion": "1.0", + "PubliclyAccessible": "true", + "MasterUsername": "adminuser", + "ClusterParameterGroups": [ + { + "ParameterApplyStatus": "in-sync", + "ParameterGroupName": "default.redshift-1.0" + } ], + "ClusterSecurityGroups": [ + { + "Status": "active", + "ClusterSecurityGroupName": "default" + } ], + "AllowVersionUpgrade": true, + "VpcSecurityGroups": \[], + "AvailabilityZone": "us-east-1a", + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "PreferredMaintenanceWindow": "sat:03:30-sat:04:00", + "AutomatedSnapshotRetentionPeriod": 1, + "ClusterStatus": "available", + "ClusterIdentifier": "mycluster", + "DBName": "dev", + "NumberOfNodes": 2, + "PendingModifiedValues": {} + } ], + "ResponseMetadata": { + "RequestId": "65b71cac-64df-11e2-8f5b-e90bd6c77476" + } + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift describe-clusters --output text + +Result:: + + dw.hs1.xlarge 1.0 true adminuser True us-east-1a 2013-01-22T21:59:29.559Z sat:03:30-sat:04:00 1 available mycluster dev 2 + ENDPOINT 5439 mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com + in-sync default.redshift-1.0 + active default + PENDINGMODIFIEDVALUES + RESPONSEMETADATA 934281a8-64df-11e2-b07c-f7fbdd006c67 + diff --git a/aws/dist/awscli/examples/redshift/describe-default-cluster-parameters.rst b/aws/dist/awscli/examples/redshift/describe-default-cluster-parameters.rst new file mode 100644 index 00000000..910f05b0 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-default-cluster-parameters.rst @@ -0,0 +1,40 @@ +Get a Description of Default Cluster Parameters +----------------------------------------------- + +This example returns a description of the default cluster parameters for the +``redshift-1.0`` family. By default, the output is in JSON format. + +Command:: + + aws redshift describe-default-cluster-parameters --parameter-group-family redshift-1.0 + +Result:: + + { + "DefaultClusterParameters": { + "ParameterGroupFamily": "redshift-1.0", + "Parameters": [ + { + "Description": "Sets the display format for date and time values.", + "DataType": "string", + "IsModifiable": true, + "Source": "engine-default", + "ParameterValue": "ISO, MDY", + "ParameterName": "datestyle" + }, + { + "Description": "Sets the number of digits displayed for floating-point values", + "DataType": "integer", + "IsModifiable": true, + "AllowedValues": "-15-2", + "Source": "engine-default", + "ParameterValue": "0", + "ParameterName": "extra_float_digits" + }, + (...remaining output omitted...) + ] + } + } + +.. tip:: To see a list of valid parameter group families, use the ``describe-cluster-parameter-groups`` command. + diff --git a/aws/dist/awscli/examples/redshift/describe-events.rst b/aws/dist/awscli/examples/redshift/describe-events.rst new file mode 100644 index 00000000..d95dfd81 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-events.rst @@ -0,0 +1,36 @@ +Describe All Events +------------------- + +this example returns all events. By default, the output is in JSON format. + +Command:: + + aws redshift describe-events + +Result:: + + { + "Events": [ + { + "Date": "2013-01-22T19:17:03.640Z", + "SourceIdentifier": "myclusterparametergroup", + "Message": "Cluster parameter group myclusterparametergroup has been created.", + "SourceType": "cluster-parameter-group" + } ], + "ResponseMetadata": { + "RequestId": "9f056111-64c9-11e2-9390-ff04f2c1e638" + } + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift describe-events --output text + +Result:: + + 2013-01-22T19:17:03.640Z myclusterparametergroup Cluster parameter group myclusterparametergroup has been created. cluster-parameter-group + RESPONSEMETADATA 8e5fe765-64c9-11e2-bce3-e56f52c50e17 + + diff --git a/aws/dist/awscli/examples/redshift/describe-orderable-cluster-options.rst b/aws/dist/awscli/examples/redshift/describe-orderable-cluster-options.rst new file mode 100644 index 00000000..a97e6697 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-orderable-cluster-options.rst @@ -0,0 +1,68 @@ +Describing All Orderable Cluster Options +---------------------------------------- + +This example returns descriptions of all orderable cluster options. By default, the output is in JSON format. + +Command:: + + aws redshift describe-orderable-cluster-options + +Result:: + + { + "OrderableClusterOptions": [ + { + "NodeType": "dw.hs1.8xlarge", + "AvailabilityZones": [ + { "Name": "us-east-1a" }, + { "Name": "us-east-1b" }, + { "Name": "us-east-1c" } ], + "ClusterVersion": "1.0", + "ClusterType": "multi-node" + }, + { + "NodeType": "dw.hs1.xlarge", + "AvailabilityZones": [ + { "Name": "us-east-1a" }, + { "Name": "us-east-1b" }, + { "Name": "us-east-1c" } ], + "ClusterVersion": "1.0", + "ClusterType": "multi-node" + }, + { + "NodeType": "dw.hs1.xlarge", + "AvailabilityZones": [ + { "Name": "us-east-1a" }, + { "Name": "us-east-1b" }, + { "Name": "us-east-1c" } ], + "ClusterVersion": "1.0", + "ClusterType": "single-node" + } ], + "ResponseMetadata": { + "RequestId": "f6000035-64cb-11e2-9135-ff82df53a51a" + } + } + +You can also obtain the same information in text format using the ``--output text`` option. + +Command:: + + aws redshift describe-orderable-cluster-options --output text + +Result:: + + dw.hs1.8xlarge 1.0 multi-node + us-east-1a + us-east-1b + us-east-1c + dw.hs1.xlarge 1.0 multi-node + us-east-1a + us-east-1b + us-east-1c + dw.hs1.xlarge 1.0 single-node + us-east-1a + us-east-1b + us-east-1c + RESPONSEMETADATA e648696b-64cb-11e2-bec0-17624ad140dd + + diff --git a/aws/dist/awscli/examples/redshift/describe-reserved-node-offerings.rst b/aws/dist/awscli/examples/redshift/describe-reserved-node-offerings.rst new file mode 100644 index 00000000..9ee24716 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-reserved-node-offerings.rst @@ -0,0 +1,50 @@ +Describe Reserved Node Offerings +-------------------------------- + +This example shows all of the reserved node offerings that are available for +purchase. + +Command:: + + aws redshift describe-reserved-node-offerings + +Result:: + + { + "ReservedNodeOfferings": [ + { + "OfferingType": "Heavy Utilization", + "FixedPrice": "", + "NodeType": "dw.hs1.xlarge", + "UsagePrice": "", + "RecurringCharges": [ + { + "RecurringChargeAmount": "", + "RecurringChargeFrequency": "Hourly" + } ], + "Duration": 31536000, + "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" + }, + { + "OfferingType": "Heavy Utilization", + "FixedPrice": "", + "NodeType": "dw.hs1.8xlarge", + "UsagePrice": "", + "RecurringCharges": [ + { + "RecurringChargeAmount": "", + "RecurringChargeFrequency": "Hourly" + } ], + "Duration": 31536000, + "ReservedNodeOfferingId": "e5a2ff3b-352d-4a9c-ad7d-373c4cab5dd2" + }, + ...remaining output omitted... + ], + "ResponseMetadata": { + "RequestId": "8b1a1a43-75ff-11e2-9666-e142fe91ddd1" + } + } + +If you want to purchase a reserved node offering, you can call ``purchase-reserved-node-offering`` using a valid +*ReservedNodeOfferingId*. + diff --git a/aws/dist/awscli/examples/redshift/describe-reserved-nodes.rst b/aws/dist/awscli/examples/redshift/describe-reserved-nodes.rst new file mode 100644 index 00000000..f10b4b8d --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-reserved-nodes.rst @@ -0,0 +1,36 @@ +Describe Reserved Nodes +----------------------- + +This example shows a reserved node offering that has been purchased. + +Command:: + + aws redshift describe-reserved-nodes + +Result:: + + { + "ResponseMetadata": { + "RequestId": "bc29ce2e-7600-11e2-9949-4b361e7420b7" + }, + "ReservedNodes": [ + { + "OfferingType": "Heavy Utilization", + "FixedPrice": "", + "NodeType": "dw.hs1.xlarge", + "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", + "UsagePrice": "", + "RecurringCharges": [ + { + "RecurringChargeAmount": "", + "RecurringChargeFrequency": "Hourly" + } ], + "NodeCount": 1, + "State": "payment-pending", + "StartTime": "2013-02-13T17:08:39.051Z", + "Duration": 31536000, + "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" + } + ] + } + diff --git a/aws/dist/awscli/examples/redshift/describe-resize.rst b/aws/dist/awscli/examples/redshift/describe-resize.rst new file mode 100644 index 00000000..d364bd6c --- /dev/null +++ b/aws/dist/awscli/examples/redshift/describe-resize.rst @@ -0,0 +1,21 @@ +Describe Resize +--------------- + +This example describes the latest resize of a cluster. The request was for 3 nodes of type ``dw.hs1.8xlarge``. + +Command:: + + aws redshift describe-resize --cluster-identifier mycluster + +Result:: + + { + "Status": "NONE", + "TargetClusterType": "multi-node", + "TargetNodeType": "dw.hs1.8xlarge", + "ResponseMetadata": { + "RequestId": "9f52b0b4-7733-11e2-aa9b-318b2909bd27" + }, + "TargetNumberOfNodes": "3" + } + diff --git a/aws/dist/awscli/examples/redshift/modify-cluster-parameter-group.rst b/aws/dist/awscli/examples/redshift/modify-cluster-parameter-group.rst new file mode 100644 index 00000000..5ce26afb --- /dev/null +++ b/aws/dist/awscli/examples/redshift/modify-cluster-parameter-group.rst @@ -0,0 +1,26 @@ +**Modify a parameter in a parameter group** + +The following ``modify-cluster-parameter-group`` example modifies the *wlm_json_configuration* parameter for workload management. It accepts the parameters from a file that contains the JSON contents shown below. :: + + aws redshift modify-cluster-parameter-group \ + --parameter-group-name myclusterparametergroup \ + --parameters file://modify_pg.json + +Contents of ``modify_pg.json``:: + + [ + { + "ParameterName": "wlm_json_configuration", + "ParameterValue": "[{\"user_group\":\"example_user_group1\",\"query_group\": \"example_query_group1\", \"query_concurrency\":7},{\"query_concurrency\":5}]" + } + ] + +Output:: + + { + "ParameterGroupStatus": "Your parameter group has been updated but changes won't get applied until you reboot the associated Clusters.", + "ParameterGroupName": "myclusterparametergroup", + "ResponseMetadata": { + "RequestId": "09974cc0-64cd-11e2-bea9-49e0ce183f07" + } + } diff --git a/aws/dist/awscli/examples/redshift/modify-cluster-subnet-group.rst b/aws/dist/awscli/examples/redshift/modify-cluster-subnet-group.rst new file mode 100644 index 00000000..48c50ec4 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/modify-cluster-subnet-group.rst @@ -0,0 +1,37 @@ +Modify the Subnets in a Cluster Subnet Group +-------------------------------------------- + +This example shows how to modify the list of subnets in a cache subnet group. By default, the output is in JSON format. + +Command:: + + aws redshift modify-cluster-subnet-group --cluster-subnet-group-name mysubnetgroup --subnet-ids subnet-763fdd1 subnet-ac830e9 + +Result:: + + { + "ClusterSubnetGroup": + { + "Subnets": [ + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-763fdd1c", + "SubnetAvailabilityZone": + { "Name": "us-east-1a" } + }, + { + "SubnetStatus": "Active", + "SubnetIdentifier": "subnet-ac830e9", + "SubnetAvailabilityZone": + { "Name": "us-east-1b" } + } ], + "VpcId": "vpc-7e3fdd14", + "SubnetGroupStatus": "Complete", + "Description": "My subnet group", + "ClusterSubnetGroupName": "mysubnetgroup" + }, + "ResponseMetadata": { + "RequestId": "8da93e89-8372-f936-93a8-873918938197a" + } + } + diff --git a/aws/dist/awscli/examples/redshift/modify-cluster.rst b/aws/dist/awscli/examples/redshift/modify-cluster.rst new file mode 100644 index 00000000..5b329d9f --- /dev/null +++ b/aws/dist/awscli/examples/redshift/modify-cluster.rst @@ -0,0 +1,30 @@ +Associate a Security Group with a Cluster +----------------------------------------- + +This example shows how to associate a cluster security group with the specified cluster. + +Command:: + + aws redshift modify-cluster --cluster-identifier mycluster --cluster-security-groups mysecuritygroup + + +Modify the Maintenance Window for a Cluster +------------------------------------------- + +This shows how to change the weekly preferred maintenance window for a cluster to be the minimum four hour window +starting Sundays at 11:15 PM, and ending Mondays at 3:15 AM. + +Command:: + + aws redshift modify-cluster --cluster-identifier mycluster --preferred-maintenance-window Sun:23:15-Mon:03:15 + +Change the Master Password for the Cluster +------------------------------------------ + +This example shows how to change the master password for a cluster. + +Command:: + + aws redshift modify-cluster --cluster-identifier mycluster --master-user-password A1b2c3d4 + + diff --git a/aws/dist/awscli/examples/redshift/purchase-reserved-node-offering.rst b/aws/dist/awscli/examples/redshift/purchase-reserved-node-offering.rst new file mode 100644 index 00000000..0d66dd39 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/purchase-reserved-node-offering.rst @@ -0,0 +1,36 @@ +Purchase a Reserved Node +------------------------ + +This example shows how to purchase a reserved node offering. The ``reserved-node-offering-id`` is obtained by +calling ``describe-reserved-node-offerings``. + +Command:: + + aws redshift purchase-reserved-node-offering --reserved-node-offering-id ceb6a579-cf4c-4343-be8b-d832c45ab51c + +Result:: + + { + "ReservedNode": { + "OfferingType": "Heavy Utilization", + "FixedPrice": "", + "NodeType": "dw.hs1.xlarge", + "ReservedNodeId": "1ba8e2e3-bc01-4d65-b35d-a4a3e931547e", + "UsagePrice": "", + "RecurringCharges": [ + { + "RecurringChargeAmount": "", + "RecurringChargeFrequency": "Hourly" + } + ], + "NodeCount": 1, + "State": "payment-pending", + "StartTime": "2013-02-13T17:08:39.051Z", + "Duration": 31536000, + "ReservedNodeOfferingId": "ceb6a579-cf4c-4343-be8b-d832c45ab51c" + }, + "ResponseMetadata": { + "RequestId": "01bda7bf-7600-11e2-b605-2568d7396e7f" + } + } + diff --git a/aws/dist/awscli/examples/redshift/reboot-cluster.rst b/aws/dist/awscli/examples/redshift/reboot-cluster.rst new file mode 100644 index 00000000..0555288a --- /dev/null +++ b/aws/dist/awscli/examples/redshift/reboot-cluster.rst @@ -0,0 +1,51 @@ +Reboot a Cluster +---------------- + +This example reboots a cluster. By default, the output is in JSON format. + +Command:: + + aws redshift reboot-cluster --cluster-identifier mycluster + +Result:: + + { + "Cluster": { + "NodeType": "dw.hs1.xlarge", + "Endpoint": { + "Port": 5439, + "Address": "mycluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com" + }, + "ClusterVersion": "1.0", + "PubliclyAccessible": "true", + "MasterUsername": "adminuser", + "ClusterParameterGroups": [ + { + "ParameterApplyStatus": "in-sync", + "ParameterGroupName": "default.redshift-1.0" + } + ], + "ClusterSecurityGroups": [ + { + "Status": "active", + "ClusterSecurityGroupName": "default" + } + ], + "AllowVersionUpgrade": true, + "VpcSecurityGroups": \[], + "AvailabilityZone": "us-east-1a", + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", + "AutomatedSnapshotRetentionPeriod": 1, + "ClusterStatus": "rebooting", + "ClusterIdentifier": "mycluster", + "DBName": "dev", + "NumberOfNodes": 2, + "PendingModifiedValues": {} + }, + "ResponseMetadata": { + "RequestId": "61c8b564-64e8-11e2-8f7d-3b939af52818" + } + } + + diff --git a/aws/dist/awscli/examples/redshift/reset-cluster-parameter-group.rst b/aws/dist/awscli/examples/redshift/reset-cluster-parameter-group.rst new file mode 100644 index 00000000..0027bb1f --- /dev/null +++ b/aws/dist/awscli/examples/redshift/reset-cluster-parameter-group.rst @@ -0,0 +1,9 @@ +Reset Parameters in a Parameter Group +------------------------------------- + +This example shows how to reset all of the parameters in a parameter group. + +Command:: + + aws redshift reset-cluster-parameter-group --parameter-group-name myclusterparametergroup --reset-all-parameters + diff --git a/aws/dist/awscli/examples/redshift/restore-from-cluster-snapshot.rst b/aws/dist/awscli/examples/redshift/restore-from-cluster-snapshot.rst new file mode 100644 index 00000000..2269ee4e --- /dev/null +++ b/aws/dist/awscli/examples/redshift/restore-from-cluster-snapshot.rst @@ -0,0 +1,44 @@ +Restore a Cluster From a Snapshot +--------------------------------- + +This example restores a cluster from a snapshot. + +Command:: + + aws redshift restore-from-cluster-snapshot --cluster-identifier mycluster-clone --snapshot-identifier my-snapshot-id + +Result:: + + { + "Cluster": { + "NodeType": "dw.hs1.xlarge", + "ClusterVersion": "1.0", + "PubliclyAccessible": "true", + "MasterUsername": "adminuser", + "ClusterParameterGroups": [ + { + "ParameterApplyStatus": "in-sync", + "ParameterGroupName": "default.redshift-1.0" + } + ], + "ClusterSecurityGroups": [ + { + "Status": "active", + "ClusterSecurityGroupName": "default" + } + ], + "AllowVersionUpgrade": true, + "VpcSecurityGroups": \[], + "PreferredMaintenanceWindow": "sun:23:15-mon:03:15", + "AutomatedSnapshotRetentionPeriod": 1, + "ClusterStatus": "creating", + "ClusterIdentifier": "mycluster-clone", + "DBName": "dev", + "NumberOfNodes": 2, + "PendingModifiedValues": {} + }, + "ResponseMetadata": { + "RequestId": "77fd512b-64e3-11e2-8f5b-e90bd6c77476" + } + } + diff --git a/aws/dist/awscli/examples/redshift/revoke-cluster-security-group-ingress.rst b/aws/dist/awscli/examples/redshift/revoke-cluster-security-group-ingress.rst new file mode 100644 index 00000000..cdf34a0a --- /dev/null +++ b/aws/dist/awscli/examples/redshift/revoke-cluster-security-group-ingress.rst @@ -0,0 +1,20 @@ +Revoke Access from an EC2 Security Group +---------------------------------------- + +This example revokes access to a named Amazon EC2 security group. + +Command:: + + aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --ec2-security-group-name myec2securitygroup --ec2-security-group-owner-id 123445677890 + + +Revoking Access to a CIDR range +------------------------------- + +This example revokes access to a CIDR range. + +Command:: + + aws redshift revoke-cluster-security-group-ingress --cluster-security-group-name mysecuritygroup --cidrip 192.168.100.100/32 + + diff --git a/aws/dist/awscli/examples/redshift/revoke-snapshot-access.rst b/aws/dist/awscli/examples/redshift/revoke-snapshot-access.rst new file mode 100644 index 00000000..9a619597 --- /dev/null +++ b/aws/dist/awscli/examples/redshift/revoke-snapshot-access.rst @@ -0,0 +1,39 @@ +Revoke the Authorization of an AWS Account to Restore a Snapshot +---------------------------------------------------------------- + +This example revokes the authorization of the AWS account ``444455556666`` to +restore the snapshot ``my-snapshot-id``. By default, the output is in JSON +format. + +Command:: + + aws redshift revoke-snapshot-access --snapshot-id my-snapshot-id --account-with-restore-access 444455556666 + +Result:: + + { + "Snapshot": { + "Status": "available", + "SnapshotCreateTime": "2013-07-17T22:04:18.947Z", + "EstimatedSecondsToCompletion": 0, + "AvailabilityZone": "us-east-1a", + "ClusterVersion": "1.0", + "MasterUsername": "adminuser", + "Encrypted": false, + "OwnerAccount": "111122223333", + "BackupProgressInMegabytes": 11.0, + "ElapsedTimeInSeconds": 0, + "DBName": "dev", + "CurrentBackupRateInMegabytesPerSecond: 0.1534, + "ClusterCreateTime": "2013-01-22T21:59:29.559Z", + "ActualIncrementalBackupSizeInMegabytes"; 11.0, + "SnapshotType": "manual", + "NodeType": "dw.hs1.xlarge", + "ClusterIdentifier": "mycluster", + "TotalBackupSizeInMegabytes": 20.0, + "Port": 5439, + "NumberOfNodes": 2, + "SnapshotIdentifier": "my-snapshot-id" + } + } + diff --git a/aws/dist/awscli/examples/rekognition/compare-faces.rst b/aws/dist/awscli/examples/rekognition/compare-faces.rst new file mode 100644 index 00000000..fb209700 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/compare-faces.rst @@ -0,0 +1,74 @@ +**To compare faces in two images** + +The following ``compare-faces`` command compares faces in two images stored in an Amazon S3 bucket. :: + + aws rekognition compare-faces \ + --source-image '{"S3Object":{"Bucket":"MyImageS3Bucket","Name":"source.jpg"}}' \ + --target-image '{"S3Object":{"Bucket":"MyImageS3Bucket","Name":"target.jpg"}}' + +Output:: + + { + "UnmatchedFaces": [], + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Width": 0.12368916720151901, + "Top": 0.16007372736930847, + "Left": 0.5901257991790771, + "Height": 0.25140416622161865 + }, + "Confidence": 100.0, + "Pose": { + "Yaw": -3.7351467609405518, + "Roll": -0.10309021919965744, + "Pitch": 0.8637830018997192 + }, + "Quality": { + "Sharpness": 95.51618957519531, + "Brightness": 65.29893493652344 + }, + "Landmarks": [ + { + "Y": 0.26721030473709106, + "X": 0.6204193830490112, + "Type": "eyeLeft" + }, + { + "Y": 0.26831310987472534, + "X": 0.6776827573776245, + "Type": "eyeRight" + }, + { + "Y": 0.3514654338359833, + "X": 0.6241428852081299, + "Type": "mouthLeft" + }, + { + "Y": 0.35258132219314575, + "X": 0.6713621020317078, + "Type": "mouthRight" + }, + { + "Y": 0.3140771687030792, + "X": 0.6428444981575012, + "Type": "nose" + } + ] + }, + "Similarity": 100.0 + } + ], + "SourceImageFace": { + "BoundingBox": { + "Width": 0.12368916720151901, + "Top": 0.16007372736930847, + "Left": 0.5901257991790771, + "Height": 0.25140416622161865 + }, + "Confidence": 100.0 + } + } + +For more information, see `Comparing Faces in Images `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/create-collection.rst b/aws/dist/awscli/examples/rekognition/create-collection.rst new file mode 100644 index 00000000..0b9d8bd2 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/create-collection.rst @@ -0,0 +1,16 @@ +**To create a collection** + +The following ``create-collection`` command creates a collection with the specified name. :: + + aws rekognition create-collection \ + --collection-id "MyCollection" + +Output:: + + { + "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/MyCollection", + "FaceModelVersion": "4.0", + "StatusCode": 200 + } + +For more information, see `Creating a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/create-stream-processor.rst b/aws/dist/awscli/examples/rekognition/create-stream-processor.rst new file mode 100644 index 00000000..8eb1390f --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/create-stream-processor.rst @@ -0,0 +1,17 @@ +**To create a new stream processor** + +The following ``create-stream-processor`` example creates a new stream processor with the specified configuration. :: + + aws rekognition create-stream-processor --name my-stream-processor\ + --input '{"KinesisVideoStream":{"Arn":"arn:aws:kinesisvideo:us-west-2:123456789012:stream/macwebcam/1530559711205"}}'\ + --stream-processor-output '{"KinesisDataStream":{"Arn":"arn:aws:kinesis:us-west-2:123456789012:stream/AmazonRekognitionRekStream"}}'\ + --role-arn arn:aws:iam::123456789012:role/AmazonRekognitionDetect\ + --settings '{"FaceSearch":{"CollectionId":"MyCollection","FaceMatchThreshold":85.5}}' + +Output:: + + { + "StreamProcessorArn": "arn:aws:rekognition:us-west-2:123456789012:streamprocessor/my-stream-processor" + } + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/delete-collection.rst b/aws/dist/awscli/examples/rekognition/delete-collection.rst new file mode 100644 index 00000000..e63ee3f3 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/delete-collection.rst @@ -0,0 +1,14 @@ +**To delete a collection** + +The following ``delete-collection`` command deletes the specified collection. :: + + aws rekognition delete-collection \ + --collection-id MyCollection + +Output:: + + { + "StatusCode": 200 + } + +For more information, see `Deleting a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/delete-faces.rst b/aws/dist/awscli/examples/rekognition/delete-faces.rst new file mode 100644 index 00000000..127528b7 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/delete-faces.rst @@ -0,0 +1,17 @@ +**To delete faces from a collection** + +The following ``delete-faces`` command deletes the specified face from a collection. :: + + aws rekognition delete-faces \ + --collection-id MyCollection + --face-ids '["0040279c-0178-436e-b70a-e61b074e96b0"]' + +Output:: + + { + "DeletedFaces": [ + "0040279c-0178-436e-b70a-e61b074e96b0" + ] + } + +For more information, see `Deleting Faces from a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/delete-stream-processor.rst b/aws/dist/awscli/examples/rekognition/delete-stream-processor.rst new file mode 100644 index 00000000..05deac5f --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/delete-stream-processor.rst @@ -0,0 +1,10 @@ +**To delete a stream processor** + +The following ``delete-stream-processor`` command deletes the specified stream processor. :: + + aws rekognition delete-stream-processor \ + --name my-stream-processor + +This command produces no output. + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/describe-collection.rst b/aws/dist/awscli/examples/rekognition/describe-collection.rst new file mode 100644 index 00000000..4b15cdfe --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/describe-collection.rst @@ -0,0 +1,17 @@ +**To describe a collection** + +The following ``describe-collection`` command displays the details about the specified collection. :: + + aws rekognition describe-collection \ + -collection-id MyCollection + +Output:: + + { + "FaceCount": 200, + "CreationTimestamp": 1569444828.274, + "CollectionARN": "arn:aws:rekognition:us-west-2:123456789012:collection/MyCollection", + "FaceModelVersion": "4.0" + } + +For more information, see `Describing a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/describe-stream-processor.rst b/aws/dist/awscli/examples/rekognition/describe-stream-processor.rst new file mode 100644 index 00000000..6f13647d --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/describe-stream-processor.rst @@ -0,0 +1,35 @@ +**To get information about a stream processor** + +The following ``describe-stream-processor`` command displays details about the specified stream processor. :: + + aws rekognition describe-stream-processor \ + --name my-stream-processor + +Output:: + + { + "Status": "STOPPED", + "Name": "my-stream-processor", + "LastUpdateTimestamp": 1532449292.712, + "Settings": { + "FaceSearch": { + "FaceMatchThreshold": 80.0, + "CollectionId": "my-collection" + } + }, + "RoleArn": "arn:aws:iam::123456789012:role/AmazonRekognitionDetectStream", + "StreamProcessorArn": "arn:aws:rekognition:us-west-2:123456789012:streamprocessor/my-stream-processpr", + "Output": { + "KinesisDataStream": { + "Arn": "arn:aws:kinesis:us-west-2:123456789012:stream/AmazonRekognitionRekStream" + } + }, + "Input": { + "KinesisVideoStream": { + "Arn": "arn:aws:kinesisvideo:us-west-2:123456789012:stream/macwebcam/123456789012" + } + }, + "CreationTimestamp": 1532449292.712 + } + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/detect-faces.rst b/aws/dist/awscli/examples/rekognition/detect-faces.rst new file mode 100644 index 00000000..12b7daa0 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/detect-faces.rst @@ -0,0 +1,256 @@ +**To detect faces in an image** + +The following ``detect-faces`` command detects faces in the specified image stored in an Amazon S3 bucket.:: + + aws rekognition detect-faces \ + --image '{"S3Object":{"MyImageS3Bucket":"bucket","Name":"MyFriend.jpg"}}' \ + --attributes "ALL" + +Output:: + + { + "FaceDetails": [ + { + "Confidence": 100.0, + "Eyeglasses": { + "Confidence": 98.91107940673828, + "Value": false + }, + "Sunglasses": { + "Confidence": 99.7966537475586, + "Value": false + }, + "Gender": { + "Confidence": 99.56611633300781, + "Value": "Male" + }, + "Landmarks": [ + { + "Y": 0.26721030473709106, + "X": 0.6204193830490112, + "Type": "eyeLeft" + }, + { + "Y": 0.26831310987472534, + "X": 0.6776827573776245, + "Type": "eyeRight" + }, + { + "Y": 0.3514654338359833, + "X": 0.6241428852081299, + "Type": "mouthLeft" + }, + { + "Y": 0.35258132219314575, + "X": 0.6713621020317078, + "Type": "mouthRight" + }, + { + "Y": 0.3140771687030792, + "X": 0.6428444981575012, + "Type": "nose" + }, + { + "Y": 0.24662546813488007, + "X": 0.6001564860343933, + "Type": "leftEyeBrowLeft" + }, + { + "Y": 0.24326619505882263, + "X": 0.6303644776344299, + "Type": "leftEyeBrowRight" + }, + { + "Y": 0.23818562924861908, + "X": 0.6146903038024902, + "Type": "leftEyeBrowUp" + }, + { + "Y": 0.24373626708984375, + "X": 0.6640064716339111, + "Type": "rightEyeBrowLeft" + }, + { + "Y": 0.24877218902111053, + "X": 0.7025929093360901, + "Type": "rightEyeBrowRight" + }, + { + "Y": 0.23938551545143127, + "X": 0.6823262572288513, + "Type": "rightEyeBrowUp" + }, + { + "Y": 0.265746533870697, + "X": 0.6112898588180542, + "Type": "leftEyeLeft" + }, + { + "Y": 0.2676128149032593, + "X": 0.6317071914672852, + "Type": "leftEyeRight" + }, + { + "Y": 0.262735515832901, + "X": 0.6201658248901367, + "Type": "leftEyeUp" + }, + { + "Y": 0.27025148272514343, + "X": 0.6206279993057251, + "Type": "leftEyeDown" + }, + { + "Y": 0.268223375082016, + "X": 0.6658390760421753, + "Type": "rightEyeLeft" + }, + { + "Y": 0.2672517001628876, + "X": 0.687832236289978, + "Type": "rightEyeRight" + }, + { + "Y": 0.26383838057518005, + "X": 0.6769183874130249, + "Type": "rightEyeUp" + }, + { + "Y": 0.27138751745224, + "X": 0.676596462726593, + "Type": "rightEyeDown" + }, + { + "Y": 0.32283174991607666, + "X": 0.6350004076957703, + "Type": "noseLeft" + }, + { + "Y": 0.3219289481639862, + "X": 0.6567046642303467, + "Type": "noseRight" + }, + { + "Y": 0.3420318365097046, + "X": 0.6450609564781189, + "Type": "mouthUp" + }, + { + "Y": 0.3664324879646301, + "X": 0.6455618143081665, + "Type": "mouthDown" + }, + { + "Y": 0.26721030473709106, + "X": 0.6204193830490112, + "Type": "leftPupil" + }, + { + "Y": 0.26831310987472534, + "X": 0.6776827573776245, + "Type": "rightPupil" + }, + { + "Y": 0.26343393325805664, + "X": 0.5946047306060791, + "Type": "upperJawlineLeft" + }, + { + "Y": 0.3543180525302887, + "X": 0.6044883728027344, + "Type": "midJawlineLeft" + }, + { + "Y": 0.4084877669811249, + "X": 0.6477024555206299, + "Type": "chinBottom" + }, + { + "Y": 0.3562754988670349, + "X": 0.707981526851654, + "Type": "midJawlineRight" + }, + { + "Y": 0.26580461859703064, + "X": 0.7234612107276917, + "Type": "upperJawlineRight" + } + ], + "Pose": { + "Yaw": -3.7351467609405518, + "Roll": -0.10309021919965744, + "Pitch": 0.8637830018997192 + }, + "Emotions": [ + { + "Confidence": 8.74203109741211, + "Type": "SURPRISED" + }, + { + "Confidence": 2.501944065093994, + "Type": "ANGRY" + }, + { + "Confidence": 0.7378743290901184, + "Type": "DISGUSTED" + }, + { + "Confidence": 3.5296201705932617, + "Type": "HAPPY" + }, + { + "Confidence": 1.7162904739379883, + "Type": "SAD" + }, + { + "Confidence": 9.518536567687988, + "Type": "CONFUSED" + }, + { + "Confidence": 0.45474427938461304, + "Type": "FEAR" + }, + { + "Confidence": 72.79895782470703, + "Type": "CALM" + } + ], + "AgeRange": { + "High": 48, + "Low": 32 + }, + "EyesOpen": { + "Confidence": 98.93987274169922, + "Value": true + }, + "BoundingBox": { + "Width": 0.12368916720151901, + "Top": 0.16007372736930847, + "Left": 0.5901257991790771, + "Height": 0.25140416622161865 + }, + "Smile": { + "Confidence": 93.4493179321289, + "Value": false + }, + "MouthOpen": { + "Confidence": 90.53053283691406, + "Value": false + }, + "Quality": { + "Sharpness": 95.51618957519531, + "Brightness": 65.29893493652344 + }, + "Mustache": { + "Confidence": 89.85221099853516, + "Value": false + }, + "Beard": { + "Confidence": 86.1991195678711, + "Value": true + } + } + ] + } + +For more information, see `Detecting Faces in an Image `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/detect-labels.rst b/aws/dist/awscli/examples/rekognition/detect-labels.rst new file mode 100644 index 00000000..0e6d28da --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/detect-labels.rst @@ -0,0 +1,564 @@ +**To detect a label in an image** + +The following ``detect-labels`` example detects scenes and objects in an image stored in an Amazon S3 bucket. :: + + aws rekognition detect-labels \ + --image '{"S3Object":{"Bucket":"bucket","Name":"image"}}' + +Output:: + + { + "Labels": [ + { + "Instances": [], + "Confidence": 99.15271759033203, + "Parents": [ + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Automobile" + }, + { + "Instances": [], + "Confidence": 99.15271759033203, + "Parents": [ + { + "Name": "Transportation" + } + ], + "Name": "Vehicle" + }, + { + "Instances": [], + "Confidence": 99.15271759033203, + "Parents": [], + "Name": "Transportation" + }, + { + "Instances": [ + { + "BoundingBox": { + "Width": 0.10616336017847061, + "Top": 0.5039216876029968, + "Left": 0.0037978808395564556, + "Height": 0.18528179824352264 + }, + "Confidence": 99.15271759033203 + }, + { + "BoundingBox": { + "Width": 0.2429988533258438, + "Top": 0.5251884460449219, + "Left": 0.7309805154800415, + "Height": 0.21577216684818268 + }, + "Confidence": 99.1286392211914 + }, + { + "BoundingBox": { + "Width": 0.14233611524105072, + "Top": 0.5333095788955688, + "Left": 0.6494812965393066, + "Height": 0.15528248250484467 + }, + "Confidence": 98.48368072509766 + }, + { + "BoundingBox": { + "Width": 0.11086395382881165, + "Top": 0.5354844927787781, + "Left": 0.10355594009160995, + "Height": 0.10271988064050674 + }, + "Confidence": 96.45606231689453 + }, + { + "BoundingBox": { + "Width": 0.06254628300666809, + "Top": 0.5573825240135193, + "Left": 0.46083059906959534, + "Height": 0.053911514580249786 + }, + "Confidence": 93.65448760986328 + }, + { + "BoundingBox": { + "Width": 0.10105438530445099, + "Top": 0.534368634223938, + "Left": 0.5743985772132874, + "Height": 0.12226245552301407 + }, + "Confidence": 93.06217193603516 + }, + { + "BoundingBox": { + "Width": 0.056389667093753815, + "Top": 0.5235804319381714, + "Left": 0.9427769780158997, + "Height": 0.17163699865341187 + }, + "Confidence": 92.6864013671875 + }, + { + "BoundingBox": { + "Width": 0.06003860384225845, + "Top": 0.5441341400146484, + "Left": 0.22409997880458832, + "Height": 0.06737709045410156 + }, + "Confidence": 90.4227066040039 + }, + { + "BoundingBox": { + "Width": 0.02848697081208229, + "Top": 0.5107086896896362, + "Left": 0, + "Height": 0.19150497019290924 + }, + "Confidence": 86.65286254882812 + }, + { + "BoundingBox": { + "Width": 0.04067881405353546, + "Top": 0.5566273927688599, + "Left": 0.316415935754776, + "Height": 0.03428703173995018 + }, + "Confidence": 85.36471557617188 + }, + { + "BoundingBox": { + "Width": 0.043411049991846085, + "Top": 0.5394920110702515, + "Left": 0.18293385207653046, + "Height": 0.0893595889210701 + }, + "Confidence": 82.21705627441406 + }, + { + "BoundingBox": { + "Width": 0.031183116137981415, + "Top": 0.5579366683959961, + "Left": 0.2853088080883026, + "Height": 0.03989990055561066 + }, + "Confidence": 81.0157470703125 + }, + { + "BoundingBox": { + "Width": 0.031113790348172188, + "Top": 0.5504819750785828, + "Left": 0.2580395042896271, + "Height": 0.056484755128622055 + }, + "Confidence": 56.13441467285156 + }, + { + "BoundingBox": { + "Width": 0.08586374670267105, + "Top": 0.5438792705535889, + "Left": 0.5128012895584106, + "Height": 0.08550430089235306 + }, + "Confidence": 52.37760925292969 + } + ], + "Confidence": 99.15271759033203, + "Parents": [ + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Car" + }, + { + "Instances": [], + "Confidence": 98.9914321899414, + "Parents": [], + "Name": "Human" + }, + { + "Instances": [ + { + "BoundingBox": { + "Width": 0.19360728561878204, + "Top": 0.35072067379951477, + "Left": 0.43734854459762573, + "Height": 0.2742200493812561 + }, + "Confidence": 98.9914321899414 + }, + { + "BoundingBox": { + "Width": 0.03801717236638069, + "Top": 0.5010883808135986, + "Left": 0.9155802130699158, + "Height": 0.06597328186035156 + }, + "Confidence": 85.02790832519531 + } + ], + "Confidence": 98.9914321899414, + "Parents": [], + "Name": "Person" + }, + { + "Instances": [], + "Confidence": 93.24951934814453, + "Parents": [], + "Name": "Machine" + }, + { + "Instances": [ + { + "BoundingBox": { + "Width": 0.03561960905790329, + "Top": 0.6468243598937988, + "Left": 0.7850857377052307, + "Height": 0.08878646790981293 + }, + "Confidence": 93.24951934814453 + }, + { + "BoundingBox": { + "Width": 0.02217046171426773, + "Top": 0.6149078607559204, + "Left": 0.04757237061858177, + "Height": 0.07136218994855881 + }, + "Confidence": 91.5025863647461 + }, + { + "BoundingBox": { + "Width": 0.016197510063648224, + "Top": 0.6274210214614868, + "Left": 0.6472989320755005, + "Height": 0.04955997318029404 + }, + "Confidence": 85.14686584472656 + }, + { + "BoundingBox": { + "Width": 0.020207518711686134, + "Top": 0.6348286867141724, + "Left": 0.7295016646385193, + "Height": 0.07059963047504425 + }, + "Confidence": 83.34547424316406 + }, + { + "BoundingBox": { + "Width": 0.020280985161662102, + "Top": 0.6171894669532776, + "Left": 0.08744934946298599, + "Height": 0.05297485366463661 + }, + "Confidence": 79.9981460571289 + }, + { + "BoundingBox": { + "Width": 0.018318990245461464, + "Top": 0.623889148235321, + "Left": 0.6836880445480347, + "Height": 0.06730121374130249 + }, + "Confidence": 78.87144470214844 + }, + { + "BoundingBox": { + "Width": 0.021310249343514442, + "Top": 0.6167286038398743, + "Left": 0.004064912907779217, + "Height": 0.08317798376083374 + }, + "Confidence": 75.89361572265625 + }, + { + "BoundingBox": { + "Width": 0.03604431077837944, + "Top": 0.7030032277107239, + "Left": 0.9254803657531738, + "Height": 0.04569442570209503 + }, + "Confidence": 64.402587890625 + }, + { + "BoundingBox": { + "Width": 0.009834849275648594, + "Top": 0.5821820497512817, + "Left": 0.28094568848609924, + "Height": 0.01964157074689865 + }, + "Confidence": 62.79907989501953 + }, + { + "BoundingBox": { + "Width": 0.01475677452981472, + "Top": 0.6137543320655823, + "Left": 0.5950819253921509, + "Height": 0.039063986390829086 + }, + "Confidence": 59.40483474731445 + } + ], + "Confidence": 93.24951934814453, + "Parents": [ + { + "Name": "Machine" + } + ], + "Name": "Wheel" + }, + { + "Instances": [], + "Confidence": 92.61514282226562, + "Parents": [], + "Name": "Road" + }, + { + "Instances": [], + "Confidence": 92.37877655029297, + "Parents": [ + { + "Name": "Person" + } + ], + "Name": "Sport" + }, + { + "Instances": [], + "Confidence": 92.37877655029297, + "Parents": [ + { + "Name": "Person" + } + ], + "Name": "Sports" + }, + { + "Instances": [ + { + "BoundingBox": { + "Width": 0.12326609343290329, + "Top": 0.6332163214683533, + "Left": 0.44815489649772644, + "Height": 0.058117982000112534 + }, + "Confidence": 92.37877655029297 + } + ], + "Confidence": 92.37877655029297, + "Parents": [ + { + "Name": "Person" + }, + { + "Name": "Sport" + } + ], + "Name": "Skateboard" + }, + { + "Instances": [], + "Confidence": 90.62931060791016, + "Parents": [ + { + "Name": "Person" + } + ], + "Name": "Pedestrian" + }, + { + "Instances": [], + "Confidence": 88.81334686279297, + "Parents": [], + "Name": "Asphalt" + }, + { + "Instances": [], + "Confidence": 88.81334686279297, + "Parents": [], + "Name": "Tarmac" + }, + { + "Instances": [], + "Confidence": 88.23201751708984, + "Parents": [], + "Name": "Path" + }, + { + "Instances": [], + "Confidence": 80.26520538330078, + "Parents": [], + "Name": "Urban" + }, + { + "Instances": [], + "Confidence": 80.26520538330078, + "Parents": [ + { + "Name": "Building" + }, + { + "Name": "Urban" + } + ], + "Name": "Town" + }, + { + "Instances": [], + "Confidence": 80.26520538330078, + "Parents": [], + "Name": "Building" + }, + { + "Instances": [], + "Confidence": 80.26520538330078, + "Parents": [ + { + "Name": "Building" + }, + { + "Name": "Urban" + } + ], + "Name": "City" + }, + { + "Instances": [], + "Confidence": 78.37934875488281, + "Parents": [ + { + "Name": "Car" + }, + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Parking Lot" + }, + { + "Instances": [], + "Confidence": 78.37934875488281, + "Parents": [ + { + "Name": "Car" + }, + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Parking" + }, + { + "Instances": [], + "Confidence": 74.37590026855469, + "Parents": [ + { + "Name": "Building" + }, + { + "Name": "Urban" + }, + { + "Name": "City" + } + ], + "Name": "Downtown" + }, + { + "Instances": [], + "Confidence": 69.84622955322266, + "Parents": [ + { + "Name": "Road" + } + ], + "Name": "Intersection" + }, + { + "Instances": [], + "Confidence": 57.68518829345703, + "Parents": [ + { + "Name": "Sports Car" + }, + { + "Name": "Car" + }, + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Coupe" + }, + { + "Instances": [], + "Confidence": 57.68518829345703, + "Parents": [ + { + "Name": "Car" + }, + { + "Name": "Vehicle" + }, + { + "Name": "Transportation" + } + ], + "Name": "Sports Car" + }, + { + "Instances": [], + "Confidence": 56.59492111206055, + "Parents": [ + { + "Name": "Path" + } + ], + "Name": "Sidewalk" + }, + { + "Instances": [], + "Confidence": 56.59492111206055, + "Parents": [ + { + "Name": "Path" + } + ], + "Name": "Pavement" + }, + { + "Instances": [], + "Confidence": 55.58770751953125, + "Parents": [ + { + "Name": "Building" + }, + { + "Name": "Urban" + } + ], + "Name": "Neighborhood" + } + ], + "LabelModelVersion": "2.0" + } + +For more information, see `Detecting Labels in an Image `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/detect-moderation-labels.rst b/aws/dist/awscli/examples/rekognition/detect-moderation-labels.rst new file mode 100644 index 00000000..4e541e66 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/detect-moderation-labels.rst @@ -0,0 +1,26 @@ +**To detect unsafe content in an image** + +The following ``detect-moderation-labels`` command detects unsafe content in the specified image stored in an Amazon S3 bucket. :: + + aws rekognition detect-moderation-labels \ + --image "S3Object={Bucket=MyImageS3Bucket,Name=gun.jpg}" + +Output:: + + { + "ModerationModelVersion": "3.0", + "ModerationLabels": [ + { + "Confidence": 97.29618072509766, + "ParentName": "Violence", + "Name": "Weapon Violence" + }, + { + "Confidence": 97.29618072509766, + "ParentName": "", + "Name": "Violence" + } + ] + } + +For more information, see `Detecting Unsafe Images `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/detect-text.rst b/aws/dist/awscli/examples/rekognition/detect-text.rst new file mode 100644 index 00000000..0f717f9c --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/detect-text.rst @@ -0,0 +1,176 @@ +**To detect text in an image** + +The following ``detect-text`` command detects text in the specified image. :: + + aws rekognition detect-text \ + --image '{"S3Object":{"Bucket":"MyImageS3Bucket","Name":"ExamplePicture.jpg"}}' + +Output:: + + { + "TextDetections": [ + { + "Geometry": { + "BoundingBox": { + "Width": 0.24624845385551453, + "Top": 0.28288066387176514, + "Left": 0.391388863325119, + "Height": 0.022687450051307678 + }, + "Polygon": [ + { + "Y": 0.28288066387176514, + "X": 0.391388863325119 + }, + { + "Y": 0.2826388478279114, + "X": 0.6376373171806335 + }, + { + "Y": 0.30532628297805786, + "X": 0.637677013874054 + }, + { + "Y": 0.305568128824234, + "X": 0.39142853021621704 + } + ] + }, + "Confidence": 94.35709381103516, + "DetectedText": "ESTD 1882", + "Type": "LINE", + "Id": 0 + }, + { + "Geometry": { + "BoundingBox": { + "Width": 0.33933889865875244, + "Top": 0.32603850960731506, + "Left": 0.34534579515457153, + "Height": 0.07126858830451965 + }, + "Polygon": [ + { + "Y": 0.32603850960731506, + "X": 0.34534579515457153 + }, + { + "Y": 0.32633158564567566, + "X": 0.684684693813324 + }, + { + "Y": 0.3976001739501953, + "X": 0.684575080871582 + }, + { + "Y": 0.3973070979118347, + "X": 0.345236212015152 + } + ] + }, + "Confidence": 99.95779418945312, + "DetectedText": "BRAINS", + "Type": "LINE", + "Id": 1 + }, + { + "Confidence": 97.22098541259766, + "Geometry": { + "BoundingBox": { + "Width": 0.061079490929841995, + "Top": 0.2843210697174072, + "Left": 0.391391396522522, + "Height": 0.021029088646173477 + }, + "Polygon": [ + { + "Y": 0.2843210697174072, + "X": 0.391391396522522 + }, + { + "Y": 0.2828207015991211, + "X": 0.4524524509906769 + }, + { + "Y": 0.3038259446620941, + "X": 0.4534534513950348 + }, + { + "Y": 0.30532634258270264, + "X": 0.3923923969268799 + } + ] + }, + "DetectedText": "ESTD", + "ParentId": 0, + "Type": "WORD", + "Id": 2 + }, + { + "Confidence": 91.49320983886719, + "Geometry": { + "BoundingBox": { + "Width": 0.07007007300853729, + "Top": 0.2828207015991211, + "Left": 0.5675675868988037, + "Height": 0.02250562608242035 + }, + "Polygon": [ + { + "Y": 0.2828207015991211, + "X": 0.5675675868988037 + }, + { + "Y": 0.2828207015991211, + "X": 0.6376376152038574 + }, + { + "Y": 0.30532634258270264, + "X": 0.6376376152038574 + }, + { + "Y": 0.30532634258270264, + "X": 0.5675675868988037 + } + ] + }, + "DetectedText": "1882", + "ParentId": 0, + "Type": "WORD", + "Id": 3 + }, + { + "Confidence": 99.95779418945312, + "Geometry": { + "BoundingBox": { + "Width": 0.33933934569358826, + "Top": 0.32633158564567566, + "Left": 0.3453453481197357, + "Height": 0.07127484679222107 + }, + "Polygon": [ + { + "Y": 0.32633158564567566, + "X": 0.3453453481197357 + }, + { + "Y": 0.32633158564567566, + "X": 0.684684693813324 + }, + { + "Y": 0.39759939908981323, + "X": 0.6836836934089661 + }, + { + "Y": 0.39684921503067017, + "X": 0.3453453481197357 + } + ] + }, + "DetectedText": "BRAINS", + "ParentId": 1, + "Type": "WORD", + "Id": 4 + } + ] + } diff --git a/aws/dist/awscli/examples/rekognition/get-celebrity-info.rst b/aws/dist/awscli/examples/rekognition/get-celebrity-info.rst new file mode 100644 index 00000000..b563b333 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-celebrity-info.rst @@ -0,0 +1,16 @@ +**To get information about a celebrity** + +The following ``get-celebrity-info`` command displays information about the specified celebrity. The ``id`` parameter comes from a previous call to ``recognize-celebrities``. :: + + aws rekognition get-celebrity-info --id nnnnnnn + +Output:: + + { + "Name": "Celeb A", + "Urls": [ + "www.imdb.com/name/aaaaaaaaa" + ] + } + +For more information, see `Getting Information About a Celebrity `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-celebrity-recognition.rst b/aws/dist/awscli/examples/rekognition/get-celebrity-recognition.rst new file mode 100644 index 00000000..3ebba78d --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-celebrity-recognition.rst @@ -0,0 +1,137 @@ +**To get the results of a celebrity recognition operation** + +The following ``get-celebrity-recognition`` command diplays the results of a celebrity recognition operation that you started previously by calling ``start-celebrity-recognition``. :: + + aws rekognition get-celebrity-recognition \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "NextToken": "3D01ClxlCiT31VsRDkAO3IybLb/h5AtDWSGuhYi+N1FIJwwPtAkuKzDhL2rV3GcwmNt77+12", + "Celebrities": [ + { + "Timestamp": 0, + "Celebrity": { + "Confidence": 96.0, + "Face": { + "BoundingBox": { + "Width": 0.70333331823349, + "Top": 0.16750000417232513, + "Left": 0.19555555284023285, + "Height": 0.3956249952316284 + }, + "Landmarks": [ + { + "Y": 0.31031012535095215, + "X": 0.441436767578125, + "Type": "eyeLeft" + }, + { + "Y": 0.3081788718700409, + "X": 0.6437258720397949, + "Type": "eyeRight" + }, + { + "Y": 0.39542075991630554, + "X": 0.5572493076324463, + "Type": "nose" + }, + { + "Y": 0.4597957134246826, + "X": 0.4579732120037079, + "Type": "mouthLeft" + }, + { + "Y": 0.45688048005104065, + "X": 0.6349081993103027, + "Type": "mouthRight" + } + ], + "Pose": { + "Yaw": 8.943398475646973, + "Roll": -2.0309247970581055, + "Pitch": -0.5674862861633301 + }, + "Quality": { + "Sharpness": 99.40211486816406, + "Brightness": 89.47132110595703 + }, + "Confidence": 99.99861145019531 + }, + "Name": "CelebrityA", + "Urls": [ + "www.imdb.com/name/111111111" + ], + "Id": "nnnnnn" + } + }, + { + "Timestamp": 467, + "Celebrity": { + "Confidence": 99.0, + "Face": { + "BoundingBox": { + "Width": 0.6877777576446533, + "Top": 0.18437500298023224, + "Left": 0.20555555820465088, + "Height": 0.3868750035762787 + }, + "Landmarks": [ + { + "Y": 0.31895750761032104, + "X": 0.4411413371562958, + "Type": "eyeLeft" + }, + { + "Y": 0.3140959143638611, + "X": 0.6523157954216003, + "Type": "eyeRight" + }, + { + "Y": 0.4016456604003906, + "X": 0.5682755708694458, + "Type": "nose" + }, + { + "Y": 0.46894142031669617, + "X": 0.4597797095775604, + "Type": "mouthLeft" + }, + { + "Y": 0.46971091628074646, + "X": 0.6286435127258301, + "Type": "mouthRight" + } + ], + "Pose": { + "Yaw": 10.433465957641602, + "Roll": -3.347442388534546, + "Pitch": 1.3709543943405151 + }, + "Quality": { + "Sharpness": 99.5531005859375, + "Brightness": 88.5764389038086 + }, + "Confidence": 99.99148559570312 + }, + "Name": "Jane Celebrity", + "Urls": [ + "www.imdb.com/name/111111111" + ], + "Id": "nnnnnn" + } + } + ], + "JobStatus": "SUCCEEDED", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.978118896484375, + "Codec": "h264", + "DurationMillis": 4570, + "FrameHeight": 1920, + "FrameWidth": 1080 + } + } + +For more information, see `Recognizing Celebrities in a Stored Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-content-moderation.rst b/aws/dist/awscli/examples/rekognition/get-content-moderation.rst new file mode 100644 index 00000000..f70c2270 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-content-moderation.rst @@ -0,0 +1,41 @@ +**To get the results of an unsafe content operation** + +The following ``get-content-moderation`` command displays the results of an unsafe content operation that you started previously by calling ``start-content-moderation``. :: + + aws rekognition get-content-moderation \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "NextToken": "dlhcKMHMzpCBGFukz6IO3JMcWiJAamCVhXHt3r6b4b5Tfbyw3q7o+Jeezt+ZpgfOnW9FCCgQ", + "ModerationLabels": [ + { + "Timestamp": 0, + "ModerationLabel": { + "Confidence": 97.39583587646484, + "ParentName": "", + "Name": "Violence" + } + }, + { + "Timestamp": 0, + "ModerationLabel": { + "Confidence": 97.39583587646484, + "ParentName": "Violence", + "Name": "Weapon Violence" + } + } + ], + "JobStatus": "SUCCEEDED", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.97515869140625, + "Codec": "h264", + "DurationMillis": 6039, + "FrameHeight": 1920, + "FrameWidth": 1080 + } + } + +For more information, see `Detecting Unsafe Stored Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-face-detection.rst b/aws/dist/awscli/examples/rekognition/get-face-detection.rst new file mode 100644 index 00000000..d5f10667 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-face-detection.rst @@ -0,0 +1,121 @@ +**To get the results of a face detection operation** + +The following ``get-face-detection`` command displays the results of a face detection operation that you started previously by calling ``start-face-detection``. :: + + aws rekognition get-face-detection \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "Faces": [ + { + "Timestamp": 467, + "Face": { + "BoundingBox": { + "Width": 0.1560753583908081, + "Top": 0.13555361330509186, + "Left": -0.0952017530798912, + "Height": 0.6934483051300049 + }, + "Landmarks": [ + { + "Y": 0.4013825058937073, + "X": -0.041750285774469376, + "Type": "eyeLeft" + }, + { + "Y": 0.41695496439933777, + "X": 0.027979329228401184, + "Type": "eyeRight" + }, + { + "Y": 0.6375303268432617, + "X": -0.04034662991762161, + "Type": "mouthLeft" + }, + { + "Y": 0.6497718691825867, + "X": 0.013960429467260838, + "Type": "mouthRight" + }, + { + "Y": 0.5238034129142761, + "X": 0.008022055961191654, + "Type": "nose" + } + ], + "Pose": { + "Yaw": -58.07863998413086, + "Roll": 1.9384294748306274, + "Pitch": -24.66305160522461 + }, + "Quality": { + "Sharpness": 83.14741516113281, + "Brightness": 25.75942611694336 + }, + "Confidence": 87.7622299194336 + } + }, + { + "Timestamp": 967, + "Face": { + "BoundingBox": { + "Width": 0.28559377789497375, + "Top": 0.19436298310756683, + "Left": 0.024553587660193443, + "Height": 0.7216082215309143 + }, + "Landmarks": [ + { + "Y": 0.4650231599807739, + "X": 0.16269078850746155, + "Type": "eyeLeft" + }, + { + "Y": 0.4843238294124603, + "X": 0.2782580852508545, + "Type": "eyeRight" + }, + { + "Y": 0.71530681848526, + "X": 0.1741468608379364, + "Type": "mouthLeft" + }, + { + "Y": 0.7310671210289001, + "X": 0.26857468485832214, + "Type": "mouthRight" + }, + { + "Y": 0.582602322101593, + "X": 0.2566150426864624, + "Type": "nose" + } + ], + "Pose": { + "Yaw": 11.487052917480469, + "Roll": 5.074230670928955, + "Pitch": 15.396159172058105 + }, + "Quality": { + "Sharpness": 73.32209777832031, + "Brightness": 54.96497344970703 + }, + "Confidence": 99.99998474121094 + } + } + ], + "NextToken": "OzL223pDKy9116O/02KXRqFIEAwxjy4PkgYcm3hSo0rdysbXg5Ex0eFgTGEj0ADEac6S037U", + "JobStatus": "SUCCEEDED", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.970617294311523, + "Codec": "h264", + "DurationMillis": 6806, + "FrameHeight": 1080, + "FrameWidth": 1920 + } + } + +For more information, see `Detecting Faces in a Stored Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-face-search.rst b/aws/dist/awscli/examples/rekognition/get-face-search.rst new file mode 100644 index 00000000..c1244e3b --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-face-search.rst @@ -0,0 +1,145 @@ +**To get the results of a face search operation** + +The following ``get-face-search`` command displays the results of a face search operation that you started previously by calling ``start-face-search``. :: + + aws rekognition get-face-search \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "Persons": [ + { + "Timestamp": 467, + "FaceMatches": [], + "Person": { + "Index": 0, + "Face": { + "BoundingBox": { + "Width": 0.1560753583908081, + "Top": 0.13555361330509186, + "Left": -0.0952017530798912, + "Height": 0.6934483051300049 + }, + "Landmarks": [ + { + "Y": 0.4013825058937073, + "X": -0.041750285774469376, + "Type": "eyeLeft" + }, + { + "Y": 0.41695496439933777, + "X": 0.027979329228401184, + "Type": "eyeRight" + }, + { + "Y": 0.6375303268432617, + "X": -0.04034662991762161, + "Type": "mouthLeft" + }, + { + "Y": 0.6497718691825867, + "X": 0.013960429467260838, + "Type": "mouthRight" + }, + { + "Y": 0.5238034129142761, + "X": 0.008022055961191654, + "Type": "nose" + } + ], + "Pose": { + "Yaw": -58.07863998413086, + "Roll": 1.9384294748306274, + "Pitch": -24.66305160522461 + }, + "Quality": { + "Sharpness": 83.14741516113281, + "Brightness": 25.75942611694336 + }, + "Confidence": 87.7622299194336 + } + } + }, + { + "Timestamp": 967, + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Width": 0.12368900328874588, + "Top": 0.16007399559020996, + "Left": 0.5901259779930115, + "Height": 0.2514039874076843 + }, + "FaceId": "056a95fa-2060-4159-9cab-7ed4daa030fa", + "ExternalImageId": "image3.jpg", + "Confidence": 100.0, + "ImageId": "08f8a078-8929-37fd-8e8f-aadf690e8232" + }, + "Similarity": 98.44476318359375 + } + ], + "Person": { + "Index": 1, + "Face": { + "BoundingBox": { + "Width": 0.28559377789497375, + "Top": 0.19436298310756683, + "Left": 0.024553587660193443, + "Height": 0.7216082215309143 + }, + "Landmarks": [ + { + "Y": 0.4650231599807739, + "X": 0.16269078850746155, + "Type": "eyeLeft" + }, + { + "Y": 0.4843238294124603, + "X": 0.2782580852508545, + "Type": "eyeRight" + }, + { + "Y": 0.71530681848526, + "X": 0.1741468608379364, + "Type": "mouthLeft" + }, + { + "Y": 0.7310671210289001, + "X": 0.26857468485832214, + "Type": "mouthRight" + }, + { + "Y": 0.582602322101593, + "X": 0.2566150426864624, + "Type": "nose" + } + ], + "Pose": { + "Yaw": 11.487052917480469, + "Roll": 5.074230670928955, + "Pitch": 15.396159172058105 + }, + "Quality": { + "Sharpness": 73.32209777832031, + "Brightness": 54.96497344970703 + }, + "Confidence": 99.99998474121094 + } + } + } + ], + "NextToken": "5bkgcezyuaqhtWk3C8OTW6cjRghrwV9XDMivm5B3MXm+Lv6G+L+GejyFHPhoNa/ldXIC4c/d", + "JobStatus": "SUCCEEDED", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.970617294311523, + "Codec": "h264", + "DurationMillis": 6806, + "FrameHeight": 1080, + "FrameWidth": 1920 + } + } + +For more information, see `Searching Stored Videos for Faces `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-label-detection.rst b/aws/dist/awscli/examples/rekognition/get-label-detection.rst new file mode 100644 index 00000000..5f3be884 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-label-detection.rst @@ -0,0 +1,61 @@ +**To get the results of an objects and scenes detection operation** + +The following ``get-label-detection`` command displays the results of an objects and scenes detection operation that you started previously by calling ``start-label-detection``. :: + + aws rekognition get-label-detection \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "Labels": [ + { + "Timestamp": 0, + "Label": { + "Instances": [], + "Confidence": 50.19071578979492, + "Parents": [ + { + "Name": "Person" + }, + { + "Name": "Crowd" + } + ], + "Name": "Audience" + } + }, + { + "Timestamp": 0, + "Label": { + "Instances": [], + "Confidence": 55.74115753173828, + "Parents": [ + { + "Name": "Room" + }, + { + "Name": "Indoors" + }, + { + "Name": "School" + } + ], + "Name": "Classroom" + } + } + ], + "JobStatus": "SUCCEEDED", + "LabelModelVersion": "2.0", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.970617294311523, + "Codec": "h264", + "DurationMillis": 6806, + "FrameHeight": 1080, + "FrameWidth": 1920 + }, + "NextToken": "BMugzAi4L72IERzQdbpyMQuEFBsjlo5W0Yx3mfG+sR9mm98E1/CpObenspRfs/5FBQFs4X7G" + } + +For more information, see `Detecting Labels in a Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/get-person-tracking.rst b/aws/dist/awscli/examples/rekognition/get-person-tracking.rst new file mode 100644 index 00000000..8e2b6bfc --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/get-person-tracking.rst @@ -0,0 +1,49 @@ +**To get the results of a people pathing operation** + +The following ``get-person-tracking`` command displays the results of a people pathing operation that you started previously by calling ``start-person-tracking``. :: + + aws rekognition get-person-tracking \ + --job-id 1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef + +Output:: + + { + "Persons": [ + { + "Timestamp": 500, + "Person": { + "BoundingBox": { + "Width": 0.4151041805744171, + "Top": 0.07870370149612427, + "Left": 0.0, + "Height": 0.9212962985038757 + }, + "Index": 0 + } + }, + { + "Timestamp": 567, + "Person": { + "BoundingBox": { + "Width": 0.4755208194255829, + "Top": 0.07777778059244156, + "Left": 0.0, + "Height": 0.9194444417953491 + }, + "Index": 0 + } + } + ], + "NextToken": "D/vRIYNyhG79ugdta3f+8cRg9oSRo+HigGOuxRiYpTn0ExnqTi1CJektVAc4HrAXDv25eHYk", + "JobStatus": "SUCCEEDED", + "VideoMetadata": { + "Format": "QuickTime / MOV", + "FrameRate": 29.970617294311523, + "Codec": "h264", + "DurationMillis": 6806, + "FrameHeight": 1080, + "FrameWidth": 1920 + } + } + +For more information, see `People Pathing `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/index-faces.rst b/aws/dist/awscli/examples/rekognition/index-faces.rst new file mode 100644 index 00000000..4508f475 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/index-faces.rst @@ -0,0 +1,232 @@ +**To add faces to a collection** + +The following ``index-faces`` command adds the faces found in an image to the specified collection. :: + + aws rekognition index-faces \ + --image '{"S3Object":{"Bucket":"MyVideoS3Bucket","Name":"MyPicture.jpg"}}' \ + --collection-id MyCollection \ + --max-faces 1 \ + --quality-filter "AUTO" \ + --detection-attributes "ALL" \ + --external-image-id "MyPicture.jpg" + +Output:: + + { + "FaceRecords": [ + { + "FaceDetail": { + "Confidence": 99.993408203125, + "Eyeglasses": { + "Confidence": 99.11750030517578, + "Value": false + }, + "Sunglasses": { + "Confidence": 99.98249053955078, + "Value": false + }, + "Gender": { + "Confidence": 99.92769622802734, + "Value": "Male" + }, + "Landmarks": [ + { + "Y": 0.26750367879867554, + "X": 0.6202793717384338, + "Type": "eyeLeft" + }, + { + "Y": 0.26642778515815735, + "X": 0.6787431836128235, + "Type": "eyeRight" + }, + { + "Y": 0.31361380219459534, + "X": 0.6421601176261902, + "Type": "nose" + }, + { + "Y": 0.3495299220085144, + "X": 0.6216195225715637, + "Type": "mouthLeft" + }, + { + "Y": 0.35194727778434753, + "X": 0.669899046421051, + "Type": "mouthRight" + }, + { + "Y": 0.26844894886016846, + "X": 0.6210268139839172, + "Type": "leftPupil" + }, + { + "Y": 0.26707562804222107, + "X": 0.6817160844802856, + "Type": "rightPupil" + }, + { + "Y": 0.24834522604942322, + "X": 0.6018546223640442, + "Type": "leftEyeBrowLeft" + }, + { + "Y": 0.24397172033786774, + "X": 0.6172008514404297, + "Type": "leftEyeBrowUp" + }, + { + "Y": 0.24677404761314392, + "X": 0.6339119076728821, + "Type": "leftEyeBrowRight" + }, + { + "Y": 0.24582654237747192, + "X": 0.6619398593902588, + "Type": "rightEyeBrowLeft" + }, + { + "Y": 0.23973053693771362, + "X": 0.6804757118225098, + "Type": "rightEyeBrowUp" + }, + { + "Y": 0.24441994726657867, + "X": 0.6978968977928162, + "Type": "rightEyeBrowRight" + }, + { + "Y": 0.2695908546447754, + "X": 0.6085202693939209, + "Type": "leftEyeLeft" + }, + { + "Y": 0.26716896891593933, + "X": 0.6315826177597046, + "Type": "leftEyeRight" + }, + { + "Y": 0.26289820671081543, + "X": 0.6202316880226135, + "Type": "leftEyeUp" + }, + { + "Y": 0.27123287320137024, + "X": 0.6205548048019409, + "Type": "leftEyeDown" + }, + { + "Y": 0.2668408751487732, + "X": 0.6663622260093689, + "Type": "rightEyeLeft" + }, + { + "Y": 0.26741549372673035, + "X": 0.6910083889961243, + "Type": "rightEyeRight" + }, + { + "Y": 0.2614026665687561, + "X": 0.6785826086997986, + "Type": "rightEyeUp" + }, + { + "Y": 0.27075251936912537, + "X": 0.6789616942405701, + "Type": "rightEyeDown" + }, + { + "Y": 0.3211299479007721, + "X": 0.6324167847633362, + "Type": "noseLeft" + }, + { + "Y": 0.32276326417922974, + "X": 0.6558475494384766, + "Type": "noseRight" + }, + { + "Y": 0.34385165572166443, + "X": 0.6444970965385437, + "Type": "mouthUp" + }, + { + "Y": 0.3671635091304779, + "X": 0.6459195017814636, + "Type": "mouthDown" + } + ], + "Pose": { + "Yaw": -9.54541015625, + "Roll": -0.5709401965141296, + "Pitch": 0.6045494675636292 + }, + "Emotions": [ + { + "Confidence": 39.90074157714844, + "Type": "HAPPY" + }, + { + "Confidence": 23.38753890991211, + "Type": "CALM" + }, + { + "Confidence": 5.840933322906494, + "Type": "CONFUSED" + } + ], + "AgeRange": { + "High": 63, + "Low": 45 + }, + "EyesOpen": { + "Confidence": 99.80887603759766, + "Value": true + }, + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618015021085739, + "Left": 0.5575000047683716, + "Height": 0.24770642817020416 + }, + "Smile": { + "Confidence": 99.69740295410156, + "Value": false + }, + "MouthOpen": { + "Confidence": 99.97393798828125, + "Value": false + }, + "Quality": { + "Sharpness": 95.54405975341797, + "Brightness": 63.867706298828125 + }, + "Mustache": { + "Confidence": 97.05007934570312, + "Value": false + }, + "Beard": { + "Confidence": 87.34505462646484, + "Value": false + } + }, + "Face": { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618015021085739, + "Left": 0.5575000047683716, + "Height": 0.24770642817020416 + }, + "FaceId": "ce7ed422-2132-4a11-ab14-06c5c410f29f", + "ExternalImageId": "example-image.jpg", + "Confidence": 99.993408203125, + "ImageId": "8d67061e-90d2-598f-9fbd-29c8497039c0" + } + } + ], + "UnindexedFaces": [], + "FaceModelVersion": "3.0", + "OrientationCorrection": "ROTATE_0" + } + +For more information, see `Adding Faces to a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/list-collections.rst b/aws/dist/awscli/examples/rekognition/list-collections.rst new file mode 100644 index 00000000..7e54c108 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/list-collections.rst @@ -0,0 +1,36 @@ +**To list the available collections** + +The following ``list-collections`` command lists the available collections in the AWS account. :: + + aws rekognition list-collections + +Output:: + + { + "FaceModelVersions": [ + "2.0", + "3.0", + "3.0", + "3.0", + "4.0", + "1.0", + "3.0", + "4.0", + "4.0", + "4.0" + ], + "CollectionIds": [ + "MyCollection1", + "MyCollection2", + "MyCollection3", + "MyCollection4", + "MyCollection5", + "MyCollection6", + "MyCollection7", + "MyCollection8", + "MyCollection9", + "MyCollection10" + ] + } + +For more information, see `Listing Collections `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/list-faces.rst b/aws/dist/awscli/examples/rekognition/list-faces.rst new file mode 100644 index 00000000..986dbb59 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/list-faces.rst @@ -0,0 +1,136 @@ +**To list the faces in a collection** + +The following ``list-faces`` command lists the faces in the specified collection. :: + + aws rekognition list-faces \ + --collection-id MyCollection + +Output:: + + { + "FaceModelVersion": "3.0", + "Faces": [ + { + "BoundingBox": { + "Width": 0.5216310024261475, + "Top": 0.3256250023841858, + "Left": 0.13394300639629364, + "Height": 0.3918749988079071 + }, + "FaceId": "0040279c-0178-436e-b70a-e61b074e96b0", + "ExternalImageId": "image1.jpg", + "Confidence": 100.0, + "ImageId": "f976e487-3719-5e2d-be8b-ea2724c26991" + }, + { + "BoundingBox": { + "Width": 0.5074880123138428, + "Top": 0.3774999976158142, + "Left": 0.18302799761295319, + "Height": 0.3812499940395355 + }, + "FaceId": "086261e8-6deb-4bc0-ac73-ab22323cc38d", + "ExternalImageId": "image2.jpg", + "Confidence": 99.99930572509766, + "ImageId": "ae1593b0-a8f6-5e24-a306-abf529e276fa" + }, + { + "BoundingBox": { + "Width": 0.5574039816856384, + "Top": 0.37187498807907104, + "Left": 0.14559100568294525, + "Height": 0.4181250035762787 + }, + "FaceId": "11c4bd3c-19c5-4eb8-aecc-24feb93a26e1", + "ExternalImageId": "image3.jpg", + "Confidence": 99.99960327148438, + "ImageId": "80739b4d-883f-5b78-97cf-5124038e26b9" + }, + { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "13692fe4-990a-4679-b14a-5ac23d135eab", + "ExternalImageId": "image4.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8df18239-9ad1-5acd-a46a-6581ff98f51b" + }, + { + "BoundingBox": { + "Width": 0.5307819843292236, + "Top": 0.2862499952316284, + "Left": 0.1564060002565384, + "Height": 0.3987500071525574 + }, + "FaceId": "2eb5f3fd-e2a9-4b1c-a89f-afa0a518fe06", + "ExternalImageId": "image5.jpg", + "Confidence": 99.99970245361328, + "ImageId": "3c314792-197d-528d-bbb6-798ed012c150" + }, + { + "BoundingBox": { + "Width": 0.5773710012435913, + "Top": 0.34437501430511475, + "Left": 0.12396000325679779, + "Height": 0.4337500035762787 + }, + "FaceId": "57189455-42b0-4839-a86c-abda48b13174", + "ExternalImageId": "image6.jpg", + "Confidence": 100.0, + "ImageId": "0aff2f37-e7a2-5dbc-a3a3-4ef6ec18eaa0" + }, + { + "BoundingBox": { + "Width": 0.5349419713020325, + "Top": 0.29124999046325684, + "Left": 0.16389399766921997, + "Height": 0.40187498927116394 + }, + "FaceId": "745f7509-b1fa-44e0-8b95-367b1359638a", + "ExternalImageId": "image7.jpg", + "Confidence": 99.99979400634766, + "ImageId": "67a34327-48d1-5179-b042-01e52ccfeada" + }, + { + "BoundingBox": { + "Width": 0.41499999165534973, + "Top": 0.09187500178813934, + "Left": 0.28083300590515137, + "Height": 0.3112500011920929 + }, + "FaceId": "8d3cfc70-4ba8-4b36-9644-90fba29c2dac", + "ExternalImageId": "image8.jpg", + "Confidence": 99.99769592285156, + "ImageId": "a294da46-2cb1-5cc4-9045-61d7ca567662" + }, + { + "BoundingBox": { + "Width": 0.48166701197624207, + "Top": 0.20999999344348907, + "Left": 0.21250000596046448, + "Height": 0.36125001311302185 + }, + "FaceId": "bd4ceb4d-9acc-4ab7-8ef8-1c2d2ba0a66a", + "ExternalImageId": "image9.jpg", + "Confidence": 99.99949645996094, + "ImageId": "5e1a7588-e5a0-5ee3-bd00-c642518dfe3a" + }, + { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "ce7ed422-2132-4a11-ab14-06c5c410f29f", + "ExternalImageId": "image10.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8d67061e-90d2-598f-9fbd-29c8497039c0" + } + ] + } + +For more information, see `Listing Faces in a Collection `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/list-stream-processors.rst b/aws/dist/awscli/examples/rekognition/list-stream-processors.rst new file mode 100644 index 00000000..5d24b00d --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/list-stream-processors.rst @@ -0,0 +1,18 @@ +**To list the stream processors in your account** + +The following ``list-stream-processors`` command lists the stream processors in your account and the state of each. :: + + aws rekognition list-stream-processors + +Output:: + + { + "StreamProcessors": [ + { + "Status": "STOPPED", + "Name": "my-stream-processor" + } + ] + } + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/recognize-celebrities.rst b/aws/dist/awscli/examples/rekognition/recognize-celebrities.rst new file mode 100644 index 00000000..70fb9bc0 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/recognize-celebrities.rst @@ -0,0 +1,274 @@ +**To recognize celebrities in an image** + +The following ``recognize-celebrities`` command recognizes celebrities in the specified image stored in an Amazon S3 bucket.:: + + aws rekognition recognize-celebrities \ + --image "S3Object={Bucket=MyImageS3Bucket,Name=moviestars.jpg}" + +Output:: + + { + "UnrecognizedFaces": [ + { + "BoundingBox": { + "Width": 0.14416666328907013, + "Top": 0.07777778059244156, + "Left": 0.625, + "Height": 0.2746031880378723 + }, + "Confidence": 99.9990234375, + "Pose": { + "Yaw": 10.80408763885498, + "Roll": -12.761146545410156, + "Pitch": 10.96889877319336 + }, + "Quality": { + "Sharpness": 94.1185531616211, + "Brightness": 79.18367004394531 + }, + "Landmarks": [ + { + "Y": 0.18220913410186768, + "X": 0.6702951788902283, + "Type": "eyeLeft" + }, + { + "Y": 0.16337193548679352, + "X": 0.7188183665275574, + "Type": "eyeRight" + }, + { + "Y": 0.20739148557186127, + "X": 0.7055801749229431, + "Type": "nose" + }, + { + "Y": 0.2889308035373688, + "X": 0.687512218952179, + "Type": "mouthLeft" + }, + { + "Y": 0.2706988751888275, + "X": 0.7250053286552429, + "Type": "mouthRight" + } + ] + } + ], + "CelebrityFaces": [ + { + "MatchConfidence": 100.0, + "Face": { + "BoundingBox": { + "Width": 0.14000000059604645, + "Top": 0.1190476194024086, + "Left": 0.82833331823349, + "Height": 0.2666666805744171 + }, + "Confidence": 99.99359130859375, + "Pose": { + "Yaw": -10.509642601013184, + "Roll": -14.51749324798584, + "Pitch": 13.799399375915527 + }, + "Quality": { + "Sharpness": 78.74752044677734, + "Brightness": 42.201324462890625 + }, + "Landmarks": [ + { + "Y": 0.2290833294391632, + "X": 0.8709492087364197, + "Type": "eyeLeft" + }, + { + "Y": 0.20639978349208832, + "X": 0.9153988361358643, + "Type": "eyeRight" + }, + { + "Y": 0.25417643785476685, + "X": 0.8907724022865295, + "Type": "nose" + }, + { + "Y": 0.32729196548461914, + "X": 0.8876466155052185, + "Type": "mouthLeft" + }, + { + "Y": 0.3115464746952057, + "X": 0.9238573312759399, + "Type": "mouthRight" + } + ] + }, + "Name": "Celeb A", + "Urls": [ + "www.imdb.com/name/aaaaaaaaa" + ], + "Id": "1111111" + }, + { + "MatchConfidence": 97.0, + "Face": { + "BoundingBox": { + "Width": 0.13333334028720856, + "Top": 0.24920634925365448, + "Left": 0.4449999928474426, + "Height": 0.2539682686328888 + }, + "Confidence": 99.99979400634766, + "Pose": { + "Yaw": 6.557040691375732, + "Roll": -7.316643714904785, + "Pitch": 9.272967338562012 + }, + "Quality": { + "Sharpness": 83.23492431640625, + "Brightness": 78.83267974853516 + }, + "Landmarks": [ + { + "Y": 0.3625510632991791, + "X": 0.48898839950561523, + "Type": "eyeLeft" + }, + { + "Y": 0.35366007685661316, + "X": 0.5313721299171448, + "Type": "eyeRight" + }, + { + "Y": 0.3894785940647125, + "X": 0.5173314809799194, + "Type": "nose" + }, + { + "Y": 0.44889405369758606, + "X": 0.5020005702972412, + "Type": "mouthLeft" + }, + { + "Y": 0.4408611059188843, + "X": 0.5351271629333496, + "Type": "mouthRight" + } + ] + }, + "Name": "Celeb B", + "Urls": [ + "www.imdb.com/name/bbbbbbbbb" + ], + "Id": "2222222" + }, + { + "MatchConfidence": 100.0, + "Face": { + "BoundingBox": { + "Width": 0.12416666746139526, + "Top": 0.2968254089355469, + "Left": 0.2150000035762787, + "Height": 0.23650793731212616 + }, + "Confidence": 99.99958801269531, + "Pose": { + "Yaw": 7.801797866821289, + "Roll": -8.326810836791992, + "Pitch": 7.844768047332764 + }, + "Quality": { + "Sharpness": 86.93206024169922, + "Brightness": 79.81291198730469 + }, + "Landmarks": [ + { + "Y": 0.4027804136276245, + "X": 0.2575301229953766, + "Type": "eyeLeft" + }, + { + "Y": 0.3934555947780609, + "X": 0.2956969439983368, + "Type": "eyeRight" + }, + { + "Y": 0.4309830069541931, + "X": 0.2837020754814148, + "Type": "nose" + }, + { + "Y": 0.48186683654785156, + "X": 0.26812544465065, + "Type": "mouthLeft" + }, + { + "Y": 0.47338807582855225, + "X": 0.29905644059181213, + "Type": "mouthRight" + } + ] + }, + "Name": "Celeb C", + "Urls": [ + "www.imdb.com/name/ccccccccc" + ], + "Id": "3333333" + }, + { + "MatchConfidence": 97.0, + "Face": { + "BoundingBox": { + "Width": 0.11916666477918625, + "Top": 0.3698412775993347, + "Left": 0.008333333767950535, + "Height": 0.22698412835597992 + }, + "Confidence": 99.99999237060547, + "Pose": { + "Yaw": 16.38478660583496, + "Roll": -1.0260354280471802, + "Pitch": 5.975185394287109 + }, + "Quality": { + "Sharpness": 83.23492431640625, + "Brightness": 61.408443450927734 + }, + "Landmarks": [ + { + "Y": 0.4632347822189331, + "X": 0.049406956881284714, + "Type": "eyeLeft" + }, + { + "Y": 0.46388113498687744, + "X": 0.08722897619009018, + "Type": "eyeRight" + }, + { + "Y": 0.5020678639411926, + "X": 0.0758260041475296, + "Type": "nose" + }, + { + "Y": 0.544157862663269, + "X": 0.054029736667871475, + "Type": "mouthLeft" + }, + { + "Y": 0.5463630557060242, + "X": 0.08464983850717545, + "Type": "mouthRight" + } + ] + }, + "Name": "Celeb D", + "Urls": [ + "www.imdb.com/name/ddddddddd" + ], + "Id": "4444444" + } + ] + } + +For more information, see `Recognizing Celebrities in an Image `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/search-faces-by-image.rst b/aws/dist/awscli/examples/rekognition/search-faces-by-image.rst new file mode 100644 index 00000000..638bb75b --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/search-faces-by-image.rst @@ -0,0 +1,157 @@ +**To search for faces in a collection that match the largest face in an image.** + +The following ``search-faces-by-image`` command searches for faces in a collection that match the largest face in the specified image.:: + + aws rekognition search-faces-by-image \ + --image '{"S3Object":{"Bucket":"MyImageS3Bucket","Name":"ExamplePerson.jpg"}}' \ + --collection-id MyFaceImageCollection + + { + "SearchedFaceBoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618015021085739, + "Left": 0.5575000047683716, + "Height": 0.24770642817020416 + }, + "SearchedFaceConfidence": 99.993408203125, + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "ce7ed422-2132-4a11-ab14-06c5c410f29f", + "ExternalImageId": "example-image.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8d67061e-90d2-598f-9fbd-29c8497039c0" + }, + "Similarity": 99.97913360595703 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "13692fe4-990a-4679-b14a-5ac23d135eab", + "ExternalImageId": "image3.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8df18239-9ad1-5acd-a46a-6581ff98f51b" + }, + "Similarity": 99.97913360595703 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.41499999165534973, + "Top": 0.09187500178813934, + "Left": 0.28083300590515137, + "Height": 0.3112500011920929 + }, + "FaceId": "8d3cfc70-4ba8-4b36-9644-90fba29c2dac", + "ExternalImageId": "image2.jpg", + "Confidence": 99.99769592285156, + "ImageId": "a294da46-2cb1-5cc4-9045-61d7ca567662" + }, + "Similarity": 99.18069458007812 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.48166701197624207, + "Top": 0.20999999344348907, + "Left": 0.21250000596046448, + "Height": 0.36125001311302185 + }, + "FaceId": "bd4ceb4d-9acc-4ab7-8ef8-1c2d2ba0a66a", + "ExternalImageId": "image1.jpg", + "Confidence": 99.99949645996094, + "ImageId": "5e1a7588-e5a0-5ee3-bd00-c642518dfe3a" + }, + "Similarity": 98.66607666015625 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5349419713020325, + "Top": 0.29124999046325684, + "Left": 0.16389399766921997, + "Height": 0.40187498927116394 + }, + "FaceId": "745f7509-b1fa-44e0-8b95-367b1359638a", + "ExternalImageId": "image9.jpg", + "Confidence": 99.99979400634766, + "ImageId": "67a34327-48d1-5179-b042-01e52ccfeada" + }, + "Similarity": 98.24278259277344 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5307819843292236, + "Top": 0.2862499952316284, + "Left": 0.1564060002565384, + "Height": 0.3987500071525574 + }, + "FaceId": "2eb5f3fd-e2a9-4b1c-a89f-afa0a518fe06", + "ExternalImageId": "image10.jpg", + "Confidence": 99.99970245361328, + "ImageId": "3c314792-197d-528d-bbb6-798ed012c150" + }, + "Similarity": 98.10665893554688 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5074880123138428, + "Top": 0.3774999976158142, + "Left": 0.18302799761295319, + "Height": 0.3812499940395355 + }, + "FaceId": "086261e8-6deb-4bc0-ac73-ab22323cc38d", + "ExternalImageId": "image6.jpg", + "Confidence": 99.99930572509766, + "ImageId": "ae1593b0-a8f6-5e24-a306-abf529e276fa" + }, + "Similarity": 98.10526275634766 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5574039816856384, + "Top": 0.37187498807907104, + "Left": 0.14559100568294525, + "Height": 0.4181250035762787 + }, + "FaceId": "11c4bd3c-19c5-4eb8-aecc-24feb93a26e1", + "ExternalImageId": "image5.jpg", + "Confidence": 99.99960327148438, + "ImageId": "80739b4d-883f-5b78-97cf-5124038e26b9" + }, + "Similarity": 97.94659423828125 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5773710012435913, + "Top": 0.34437501430511475, + "Left": 0.12396000325679779, + "Height": 0.4337500035762787 + }, + "FaceId": "57189455-42b0-4839-a86c-abda48b13174", + "ExternalImageId": "image8.jpg", + "Confidence": 100.0, + "ImageId": "0aff2f37-e7a2-5dbc-a3a3-4ef6ec18eaa0" + }, + "Similarity": 97.93476867675781 + } + ], + "FaceModelVersion": "3.0" + } + +For more information, see `Searching for a Face Using an Image `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/search-faces.rst b/aws/dist/awscli/examples/rekognition/search-faces.rst new file mode 100644 index 00000000..d6b6de83 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/search-faces.rst @@ -0,0 +1,138 @@ +**To search for faces in a collection that match a face ID.** + +The following ``search-faces`` command searches for faces in a collection that match the specified face ID. :: + + aws rekognition search-faces \ + --face-id 8d3cfc70-4ba8-4b36-9644-90fba29c2dac \ + --collection-id MyCollection + +Output:: + + { + "SearchedFaceId": "8d3cfc70-4ba8-4b36-9644-90fba29c2dac", + "FaceModelVersion": "3.0", + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Width": 0.48166701197624207, + "Top": 0.20999999344348907, + "Left": 0.21250000596046448, + "Height": 0.36125001311302185 + }, + "FaceId": "bd4ceb4d-9acc-4ab7-8ef8-1c2d2ba0a66a", + "ExternalImageId": "image1.jpg", + "Confidence": 99.99949645996094, + "ImageId": "5e1a7588-e5a0-5ee3-bd00-c642518dfe3a" + }, + "Similarity": 99.30997467041016 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "ce7ed422-2132-4a11-ab14-06c5c410f29f", + "ExternalImageId": "example-image.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8d67061e-90d2-598f-9fbd-29c8497039c0" + }, + "Similarity": 99.24862670898438 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.18562500178813934, + "Top": 0.1618019938468933, + "Left": 0.5575000047683716, + "Height": 0.24770599603652954 + }, + "FaceId": "13692fe4-990a-4679-b14a-5ac23d135eab", + "ExternalImageId": "image3.jpg", + "Confidence": 99.99340057373047, + "ImageId": "8df18239-9ad1-5acd-a46a-6581ff98f51b" + }, + "Similarity": 99.24862670898438 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5349419713020325, + "Top": 0.29124999046325684, + "Left": 0.16389399766921997, + "Height": 0.40187498927116394 + }, + "FaceId": "745f7509-b1fa-44e0-8b95-367b1359638a", + "ExternalImageId": "image9.jpg", + "Confidence": 99.99979400634766, + "ImageId": "67a34327-48d1-5179-b042-01e52ccfeada" + }, + "Similarity": 96.73158264160156 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5307819843292236, + "Top": 0.2862499952316284, + "Left": 0.1564060002565384, + "Height": 0.3987500071525574 + }, + "FaceId": "2eb5f3fd-e2a9-4b1c-a89f-afa0a518fe06", + "ExternalImageId": "image10.jpg", + "Confidence": 99.99970245361328, + "ImageId": "3c314792-197d-528d-bbb6-798ed012c150" + }, + "Similarity": 96.48291015625 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5074880123138428, + "Top": 0.3774999976158142, + "Left": 0.18302799761295319, + "Height": 0.3812499940395355 + }, + "FaceId": "086261e8-6deb-4bc0-ac73-ab22323cc38d", + "ExternalImageId": "image6.jpg", + "Confidence": 99.99930572509766, + "ImageId": "ae1593b0-a8f6-5e24-a306-abf529e276fa" + }, + "Similarity": 96.43287658691406 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5574039816856384, + "Top": 0.37187498807907104, + "Left": 0.14559100568294525, + "Height": 0.4181250035762787 + }, + "FaceId": "11c4bd3c-19c5-4eb8-aecc-24feb93a26e1", + "ExternalImageId": "image5.jpg", + "Confidence": 99.99960327148438, + "ImageId": "80739b4d-883f-5b78-97cf-5124038e26b9" + }, + "Similarity": 95.25305938720703 + }, + { + "Face": { + "BoundingBox": { + "Width": 0.5773710012435913, + "Top": 0.34437501430511475, + "Left": 0.12396000325679779, + "Height": 0.4337500035762787 + }, + "FaceId": "57189455-42b0-4839-a86c-abda48b13174", + "ExternalImageId": "image8.jpg", + "Confidence": 100.0, + "ImageId": "0aff2f37-e7a2-5dbc-a3a3-4ef6ec18eaa0" + }, + "Similarity": 95.22837829589844 + } + ] + } + +For more information, see `Searching for a Face Using Its Face ID `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-celebrity-recognition.rst b/aws/dist/awscli/examples/rekognition/start-celebrity-recognition.rst new file mode 100644 index 00000000..6579fc2c --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-celebrity-recognition.rst @@ -0,0 +1,14 @@ +**To start the recognition of celebrities in a stored video** + +The following ``start-celebrity-recognition`` command starts a job to look for celebrities in the specified video file stored in an Amazon S3 bucket. :: + + aws rekognition start-celebrity-recognition \ + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `Recognizing Celebrities in a Stored Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-content-moderation.rst b/aws/dist/awscli/examples/rekognition/start-content-moderation.rst new file mode 100644 index 00000000..432e0b90 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-content-moderation.rst @@ -0,0 +1,14 @@ +**To start the recognition of unsafe content in a stored video** + +The following ``start-content-moderation`` command starts a job to detect unsafe content in the specified video file stored in an Amazon S3 bucket. :: + + aws rekognition start-content-moderation \ + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `Detecting Unsafe Stored Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-face-detection.rst b/aws/dist/awscli/examples/rekognition/start-face-detection.rst new file mode 100644 index 00000000..467bf78f --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-face-detection.rst @@ -0,0 +1,14 @@ +**To detect faces in a video** + +The following ``start-face-detection`` command starts a job to detect faces in the specified video file stored in an Amazon S3 bucket. :: + + aws rekognition start-face-detection + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `Detecting Faces in a Stored Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-face-search.rst b/aws/dist/awscli/examples/rekognition/start-face-search.rst new file mode 100644 index 00000000..f81f31c7 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-face-search.rst @@ -0,0 +1,15 @@ +**To search for faces in a collection that match faces detected in a video** + +The following ``start-face-search`` command starts a job to search for faces in a collection that match faces detected in the specified video file in an Amazon S3 bucket. :: + + aws rekognition start-face-search \ + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" \ + --collection-id collection + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `Searching Stored Videos for Faces `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-label-detection.rst b/aws/dist/awscli/examples/rekognition/start-label-detection.rst new file mode 100644 index 00000000..0a336d8a --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-label-detection.rst @@ -0,0 +1,14 @@ +**To detect objects and scenes in a video** + +The following ``start-label-detection`` command starts a job to detect objects and scenes in the specified video file stored in an Amazon S3 bucket. :: + + aws rekognition start-label-detection \ + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `Detecting Labels in a Video `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-person-tracking.rst b/aws/dist/awscli/examples/rekognition/start-person-tracking.rst new file mode 100644 index 00000000..57013e2f --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-person-tracking.rst @@ -0,0 +1,14 @@ +**To start the pathing of people in a stored video** + +The following ``start-person-tracking`` command starts a job to track the paths that people take in the specified video fiel stored in an Amazon S3 bucket.:: + + aws rekognition start-person-tracking \ + --video "S3Object={Bucket=MyVideoS3Bucket,Name=MyVideoFile.mpg}" + +Output:: + + { + "JobId": "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef" + } + +For more information, see `People Pathing `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/start-stream-processor.rst b/aws/dist/awscli/examples/rekognition/start-stream-processor.rst new file mode 100644 index 00000000..5ec69b96 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/start-stream-processor.rst @@ -0,0 +1,10 @@ +**To start a stream processor** + +The following ``start-stream-processor`` command starts the specified video stream processor. :: + + aws rekognition start-stream-processor \ + --name my-stream-processor + +This command produces no output. + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/rekognition/stop-stream-processor.rst b/aws/dist/awscli/examples/rekognition/stop-stream-processor.rst new file mode 100644 index 00000000..2bc435c2 --- /dev/null +++ b/aws/dist/awscli/examples/rekognition/stop-stream-processor.rst @@ -0,0 +1,10 @@ +**To stop a running stream processor** + +The following ``stop-stream-processor`` command stops the specified running stream processor. :: + + aws rekognition stop-stream-processor \ + --name my-stream-processor + +This command produces no output. + +For more information, see `Working with Streaming Videos `__ in the *Amazon Rekognition Developer Guide*. diff --git a/aws/dist/awscli/examples/resource-groups/create-group.rst b/aws/dist/awscli/examples/resource-groups/create-group.rst new file mode 100644 index 00000000..282eedb0 --- /dev/null +++ b/aws/dist/awscli/examples/resource-groups/create-group.rst @@ -0,0 +1,41 @@ +**Example 1: To create a tag-based resource group** + +The following ``create-group`` example creates a tag-based resource group of Amazon EC2 instances in the current region that are tagged with a tag key of ``Name``, and a tag key value of ``WebServers``. The group name is ``WebServer3``. :: + + aws resource-groups create-group \ + --name WebServer3 \ + --resource-query '{"Type":"TAG_FILTERS_1_0", "Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"}' + +Output:: + + { + "Group": { + "GroupArn": "arn:aws:resource-groups:us-east-2:000000000000:group/WebServer3", + "Name": "WebServer3" + }, + "ResourceQuery": { + "Type": "TAG_FILTERS_1_0", + "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}" + } + } + +**Example 2: To create a CloudFormation stack-based resource group** + +The following ``create-group`` example creates an AWS CloudFormation stack-based resource group named ``sampleCFNstackgroup``. The query allows all resources that are in the CloudFormation stack that are supported by AWS Resource Groups. :: + + aws resource-groups create-group \ + --name sampleCFNstackgroup \ + --resource-query '{"Type": "CLOUDFORMATION_STACK_1_0", "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/testcloudformationstack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}' + +Output:: + + { + "Group": { + "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/sampleCFNstackgroup", + "Name": "sampleCFNstackgroup" + }, + "ResourceQuery": { + "Type": "CLOUDFORMATION_STACK_1_0", + "Query":'{\"CloudFormationStackArn\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/testcloudformationstack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\",\"ResourceTypeFilters\":[\"AWS::AllSupported\"]}"}' + } + } diff --git a/aws/dist/awscli/examples/resource-groups/update-group-query.rst b/aws/dist/awscli/examples/resource-groups/update-group-query.rst new file mode 100644 index 00000000..3d8894e6 --- /dev/null +++ b/aws/dist/awscli/examples/resource-groups/update-group-query.rst @@ -0,0 +1,41 @@ +**Example 1: To update the query for a tag-based resource group** + +The following ``update-group-query`` example updates the query for a tag-based resource group of Amazon EC2 instances. To update the group query, you can change the values specified for ``ResourceTypeFilters`` or ``TagFilters``. :: + + aws resource-groups update-group-query \ + --group-name WebServer3 \ + --resource-query '{"Type":"TAG_FILTERS_1_0", "Query":"{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}"}' + +Output:: + + { + "Group": { + "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/WebServer3", + "Name": "WebServer3" + }, + "ResourceQuery": { + "Type": "TAG_FILTERS_1_0", + "Query": "{\"ResourceTypeFilters\":[\"AWS::EC2::Instance\"],\"TagFilters\":[{\"Key\":\"Name\", \"Values\":[\"WebServers\"]}]}" + } + } + +**Example 2: To update the query for a CloudFormation stack-based resource group** + +The following ``update-group-query`` example updates the query for an AWS CloudFormation stack-based resource group named ``sampleCFNstackgroup``. To update the group query, you can change the values specified for ``ResourceTypeFilters`` or ``StackIdentifier``. :: + + aws resource-groups update-group-query \ + --group-name sampleCFNstackgroup \ + --resource-query '{"Type": "CLOUDFORMATION_STACK_1_0", "Query": "{\"ResourceTypeFilters\":[\"AWS::AllSupported\"],\"StackIdentifier\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/testcloudformationstack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\"}"}' + +Output:: + + { + "Group": { + "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/sampleCFNstackgroup", + "Name": "sampleCFNstackgroup" + }, + "ResourceQuery": { + "Type": "CLOUDFORMATION_STACK_1_0", + "Query":'{\"CloudFormationStackArn\":\"arn:aws:cloudformation:us-east-2:123456789012:stack/testcloudformationstack/1415z9z0-z39z-11z8-97z5-500z212zz6fz\",\"ResourceTypeFilters\":[\"AWS::AllSupported\"]}"}' + } + } diff --git a/aws/dist/awscli/examples/resource-groups/update-group.rst b/aws/dist/awscli/examples/resource-groups/update-group.rst new file mode 100644 index 00000000..4bfb141e --- /dev/null +++ b/aws/dist/awscli/examples/resource-groups/update-group.rst @@ -0,0 +1,17 @@ +**To update the description for a resource group** + +The following ``update-group`` example updates the description for a group named ``WebServer3`` in the current region. :: + + aws resource-groups update-group \ + --group-name WebServer3 \ + --description "Group of web server resources." + +Output:: + + { + "Group": { + "GroupArn": "arn:aws:resource-groups:us-east-2:123456789012:group/WebServer3", + "Name": "WebServer3" + "Description": "Group of web server resources." + } + } diff --git a/aws/dist/awscli/examples/resourcegroupstaggingapi/get-resources.rst b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-resources.rst new file mode 100644 index 00000000..96247de6 --- /dev/null +++ b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-resources.rst @@ -0,0 +1,25 @@ +**To get a list of tagged resources** + +The following ``get-resources`` example displays a list of resources in the account that are tagged with the specified key name and value. :: + + aws resourcegroupstaggingapi get-resources \ + --tag-filters Key=Environment,Values=Production \ + --tags-per-page 100 + +Output:: + + { + "ResourceTagMappingList": [ + { + "ResourceARN": " arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "Tags": [ + { + "Key": "Environment", + "Value": "Production" + } + ] + } + ] + } + +For more information, see `GetResources `__ in the *Resource Groups Tagging API Reference*. diff --git a/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-keys.rst b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-keys.rst new file mode 100644 index 00000000..8a01ff36 --- /dev/null +++ b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-keys.rst @@ -0,0 +1,18 @@ +**To get a list of all tag keys** + +The following ``get-tag-keys`` example retrieves the list of all tag key names used by resources in the account. :: + + aws resourcegroupstaggingapi get-tag-keys + +Output:: + + { + "TagKeys": [ + "Environment", + "CostCenter", + "Department" + ] + } + + +For more information, see `GetTagKeys `__ in the *Resource Groups Tagging API Reference*. diff --git a/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-values.rst b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-values.rst new file mode 100644 index 00000000..38449ea4 --- /dev/null +++ b/aws/dist/awscli/examples/resourcegroupstaggingapi/get-tag-values.rst @@ -0,0 +1,18 @@ +**To get a list of all tag values** + +The following ``get-tag-values`` example displays all of the values used for the specified key for all resources in the :: + + aws resourcegroupstaggingapi get-tag-values \ + --key=Environment + +Output:: + + { + "TagValues": [ + "Alpha", + "Gamma", + "Production" + ] + } + +For more information, see `GetTagValues `__ in the *Resource Groups Tagging API Reference*. diff --git a/aws/dist/awscli/examples/resourcegroupstaggingapi/tag-resources.rst b/aws/dist/awscli/examples/resourcegroupstaggingapi/tag-resources.rst new file mode 100644 index 00000000..b185e139 --- /dev/null +++ b/aws/dist/awscli/examples/resourcegroupstaggingapi/tag-resources.rst @@ -0,0 +1,15 @@ +**To attach a tag to a resource** + +The following ``tag-resources`` example tags the specified resource with a key name and value. :: + + aws resourcegroupstaggingapi tag-resources \ + --resource-arn-list arn:aws:s3:::MyProductionBucket \ + --tags Environment=Production,CostCenter=1234 + +Output:: + + { + "FailedResourcesMap": {} + } + +For more information, see `TagResources `__ in the *Resource Groups Tagging API Reference*. diff --git a/aws/dist/awscli/examples/resourcegroupstaggingapi/untag-resources.rst b/aws/dist/awscli/examples/resourcegroupstaggingapi/untag-resources.rst new file mode 100644 index 00000000..a1352513 --- /dev/null +++ b/aws/dist/awscli/examples/resourcegroupstaggingapi/untag-resources.rst @@ -0,0 +1,15 @@ +**To remove a tag from a resource** + +The following ``untag-resources`` example removes the specified tag keys and associated values from a resource. :: + + aws resourcegroupstaggingapi untag-resources \ + --resource-arn-list arn:aws:s3:::awsexamplebucket \ + --tag-keys Environment,CostCenter + +Output:: + + { + "FailedResourcesMap": {} + } + +For more information, see `UntagResources `__ in the *Resource Groups Tagging API Reference*. diff --git a/aws/dist/awscli/examples/robomaker/batch-describe-simulation-job.rst b/aws/dist/awscli/examples/robomaker/batch-describe-simulation-job.rst new file mode 100644 index 00000000..b2059f10 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/batch-describe-simulation-job.rst @@ -0,0 +1,150 @@ +**To batch describe simulation jobs** + +The following ``batch-describe-simulation-job`` example retrieves details for the three specified simulation jobs. + +Command:: + + aws robomaker batch-describe-simulation-job \ + --job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw + +Output:: + + { + "jobs": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x", + "status": "Completed", + "lastUpdatedAt": 1548959178.0, + "failureBehavior": "Continue", + "clientRequestToken": "6020408e-b05c-4310-9f13-4ed71c5221ed", + "outputLocation": { + "s3Bucket": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa", + "s3Prefix": "output" + }, + "maxJobDurationInSeconds": 3600, + "simulationTimeMillis": 0, + "iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerObjectTracker-154895-SimulationJobRole-14D5ASA7PQE3A", + "simulationApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq/1548959170096", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "object_tracker_simulation", + "launchFile": "local_training.launch", + "environmentVariables": { + "MARKOV_PRESET_FILE": "object_tracker.py", + "MODEL_S3_BUCKET": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa", + "MODEL_S3_PREFIX": "model-store", + "ROS_AWS_REGION": "us-west-2" + } + } + } + ], + "tags": {}, + "vpcConfig": { + "subnets": [ + "subnet-716dd52a", + "subnet-43c22325", + "subnet-3f526976" + ], + "securityGroups": [ + "sg-3fb40545" + ], + "vpcId": "vpc-99895eff", + "assignPublicIp": true + } + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n", + "status": "Completed", + "lastUpdatedAt": 1548168817.0, + "failureBehavior": "Continue", + "clientRequestToken": "e4a23e75-f9a7-411d-835f-21881c82c58b", + "outputLocation": { + "s3Bucket": "awsrobomakercloudwatch-111111111111-bundlesbucket-14e5s9jvwtmv7", + "s3Prefix": "output" + }, + "maxJobDurationInSeconds": 3600, + "simulationTimeMillis": 0, + "iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerCloudWatch-154766341-SimulationJobRole-G0OBWTQ8YBG6", + "robotApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/AWSRoboMakerCloudWatch-1547663411642_NZbpqEJ3T/1547663517377", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "cloudwatch_robot", + "launchFile": "await_commands.launch", + "environmentVariables": { + "LAUNCH_ID": "1548168752173", + "ROS_AWS_REGION": "us-west-2" + } + } + } + ], + "simulationApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerCloudWatch-1547663411642_0LIt6D1h6/1547663521470", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "cloudwatch_simulation", + "launchFile": "bookstore_turtlebot_navigation.launch", + "environmentVariables": { + "LAUNCH_ID": "1548168752173", + "ROS_AWS_REGION": "us-west-2", + "TURTLEBOT3_MODEL": "waffle_pi" + } + } + } + ], + "tags": {}, + "vpcConfig": { + "subnets": [ + "subnet-716dd52a", + "subnet-43c22325", + "subnet-3f526976" + ], + "securityGroups": [ + "sg-3fb40545" + ], + "vpcId": "vpc-99895eff", + "assignPublicIp": true + } + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw", + "status": "Canceled", + "lastUpdatedAt": 1546543442.0, + "failureBehavior": "Fail", + "clientRequestToken": "d796bbb4-2a2c-1abc-f2a9-0d9e547d853f", + "outputLocation": { + "s3Bucket": "sample-bucket", + "s3Prefix": "SimulationLog_115490482698" + }, + "maxJobDurationInSeconds": 28800, + "simulationTimeMillis": 0, + "iamRole": "arn:aws:iam::111111111111:role/RoboMakerSampleTheFirst", + "robotApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerHelloWorldRobot/1546541208251", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_robot", + "launchFile": "rotate.launch" + } + } + ], + "simulationApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerHelloWorldSimulation/1546541198985", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_simulation", + "launchFile": "empty_world.launch" + } + } + ], + "tags": {} + } + ], + "unprocessedJobs": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/cancel-simulation-job.rst b/aws/dist/awscli/examples/robomaker/cancel-simulation-job.rst new file mode 100644 index 00000000..0a442415 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/cancel-simulation-job.rst @@ -0,0 +1,6 @@ +**To cancel a simulation job** + +The following ``cancel-simulation-job`` example cancels the specified simulation job. :: + + aws robomaker cancel-simulation-job \ + --job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x diff --git a/aws/dist/awscli/examples/robomaker/create-deployment-job.rst b/aws/dist/awscli/examples/robomaker/create-deployment-job.rst new file mode 100644 index 00000000..82291acb --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-deployment-job.rst @@ -0,0 +1,37 @@ +**To create a deployment job** + +This example creates a deployment job for fleet MyFleet. It includes an environment variable named "ENVIRONMENT". +It also attaches a tag named "Region". + +Command:: + + aws robomaker create-deployment-job --deployment-config concurrentDeploymentPercentage=20,failureThresholdPercentage=25 --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711 --tags Region=West --deployment-application-configs application=arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerVoiceInteractionRobot/1546537110575,applicationVersion=1,launchConfig={environmentVariables={ENVIRONMENT=Beta},launchFile=await_commands.launch,packageName=voice_interaction_robot} + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/sim-0974h36s4v0t", + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "status": "Pending", + "deploymentApplicationConfigs": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerVoiceInteractionRobot/1546537110575", + "applicationVersion": "1", + "launchConfig": { + "packageName": "voice_interaction_robot", + "launchFile": "await_commands.launch", + "environmentVariables": { + "ENVIRONMENT": "Beta" + } + } + } + ], + "createdAt": 1550770236.0, + "deploymentConfig": { + "concurrentDeploymentPercentage": 20, + "failureThresholdPercentage": 25 + }, + "tags": { + "Region": "West" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/create-fleet.rst b/aws/dist/awscli/examples/robomaker/create-fleet.rst new file mode 100644 index 00000000..9d22a835 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-fleet.rst @@ -0,0 +1,18 @@ +**To create a fleet** + +This example creates a fleet. It attaches a tag named Region. + +Command:: + + aws robomaker create-fleet --name MyFleet --tags Region=East + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyOtherFleet/1550771394395", + "name": "MyFleet", + "createdAt": 1550771394.0, + "tags": { + "Region": "East" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/create-robot-application-version.rst b/aws/dist/awscli/examples/robomaker/create-robot-application-version.rst new file mode 100644 index 00000000..a3ff727f --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-robot-application-version.rst @@ -0,0 +1,31 @@ +**To create a robot application version** + +This example creates a robot application version. + +Command:: + + aws robomaker create-robot-application-version --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551201873931 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551201873931", + "name": "MyRobotApplication", + "version": "1", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-robot-application.tar.gz", + "etag": "f8cf5526f1c6e7b3a72c3ed3f79c5493-70", + "architecture": "ARMHF" + } + ], + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "lastUpdatedAt": 1551201873.0, + "revisionId": "9986bb8d-a695-4ab4-8810-9f4a74d1aa00" + "tags": {} + } + diff --git a/aws/dist/awscli/examples/robomaker/create-robot-application.rst b/aws/dist/awscli/examples/robomaker/create-robot-application.rst new file mode 100644 index 00000000..ae992690 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-robot-application.rst @@ -0,0 +1,29 @@ +**To create a robot application** + +This example creates a robot application. + +Command:: + + aws robomaker create-robot-application --name MyRobotApplication --sources s3Bucket=my-bucket,s3Key=my-robot-application.tar.gz,architecture=X86_64 --robot-software-suite name=ROS,version=Kinetic + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551201873931", + "name": "MyRobotApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-robot-application.tar.gz", + "architecture": "ARMHF" + } + ], + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "lastUpdatedAt": 1551201873.0, + "revisionId": "1f3cb539-9239-4841-a656-d3efcffa07e1", + "tags": {} + } diff --git a/aws/dist/awscli/examples/robomaker/create-robot.rst b/aws/dist/awscli/examples/robomaker/create-robot.rst new file mode 100644 index 00000000..c3c730bf --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-robot.rst @@ -0,0 +1,20 @@ +**To create a robot** + +This example creates a robot. It uses the ARMHF architecture. It also attaches a tag named Region. + +Command:: + + aws robomaker create-robot --name MyRobot --architecture ARMHF --greengrass-group-id 0f728a3c-7dbf-4a3e-976d-d16a8360caba --tags Region=East + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398", + "name": "MyRobot", + "createdAt": 1550772325.0, + "greengrassGroupId": "0f728a3c-7dbf-4a3e-976d-d16a8360caba", + "architecture": "ARMHF", + "tags": { + "Region": "East" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/create-simulation-application-version.rst b/aws/dist/awscli/examples/robomaker/create-simulation-application-version.rst new file mode 100644 index 00000000..446b8692 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-simulation-application-version.rst @@ -0,0 +1,39 @@ +**To create a simulation application version** + +This example creates a robot application version. + +Command:: + + aws robomaker create-simulation-application-version --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MySimulationApplication/1551203427605 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MyRobotApplication/1551203427605", + "name": "MyRobotApplication", + "version": "1", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-simulation-application.tar.gz", + "etag": "00d8a94ff113856688c4fce618ae0f45-94", + "architecture": "X86_64" + } + ], + "simulationSoftwareSuite": { + "name": "Gazebo", + "version": "7" + }, + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "renderingEngine": { + "name": "OGRE", + "version": "1.x" + }, + "lastUpdatedAt": 1551203853.0, + "revisionId": "ee753e53-519c-4d37-895d-65e79bcd1914", + "tags": {} + } + diff --git a/aws/dist/awscli/examples/robomaker/create-simulation-application.rst b/aws/dist/awscli/examples/robomaker/create-simulation-application.rst new file mode 100644 index 00000000..4c528e80 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-simulation-application.rst @@ -0,0 +1,38 @@ +**To create a simulation application** + +This example creates a simulation application. + +Command:: + + aws robomaker create-simulation-application --name MyRobotApplication --sources s3Bucket=my-bucket,s3Key=my-simulation-application.tar.gz,architecture=ARMHF --robot-software-suite name=ROS,version=Kinetic --simulation-software-suite name=Gazebo,version=7 --rendering-engine name=OGRE,version=1.x + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MyRobotApplication/1551203301792", + "name": "MyRobotApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-simulation-application.tar.gz", + "architecture": "X86_64" + } + ], + "simulationSoftwareSuite": { + "name": "Gazebo", + "version": "7" + }, + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "renderingEngine": { + "name": "OGRE", + "version": "1.x" + }, + "lastUpdatedAt": 1551203301.0, + "revisionId": "ee753e53-519c-4d37-895d-65e79bcd1914", + "tags": {} + } + diff --git a/aws/dist/awscli/examples/robomaker/create-simulation-job.rst b/aws/dist/awscli/examples/robomaker/create-simulation-job.rst new file mode 100644 index 00000000..d5b4cd86 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/create-simulation-job.rst @@ -0,0 +1,43 @@ +**To create a simulation job** + +This example creates a simulation job. It uses a robot application and a simulation application. + +Command:: + + aws robomaker create-simulation-job --max-job-duration-in-seconds 3600 --iam-role arn:aws:iam::111111111111:role/AWSRoboMakerCloudWatch-154766341-SimulationJobRole-G0OBWTQ8YBG6 --robot-applications application=arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821,launchConfig={packageName=hello_world_robot,launchFile=rotate.launch} --simulation-applications application=arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605,launchConfig={packageName=hello_world_simulation,launchFile=empty_world.launch} --tags Region=North + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-w7m68wpr05h8", + "status": "Pending", + "lastUpdatedAt": 1551213837.0, + "failureBehavior": "Fail", + "clientRequestToken": "b283ccce-e468-43ee-8642-be76a9d69f15", + "maxJobDurationInSeconds": 3600, + "simulationTimeMillis": 0, + "iamRole": "arn:aws:iam::111111111111:role/MySimulationRole", + "robotApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_robot", + "launchFile": "rotate.launch" + } + } + ], + "simulationApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_simulation", + "launchFile": "empty_world.launch" + } + } + ], + "tags": { + "Region": "North" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/delete-fleet.rst b/aws/dist/awscli/examples/robomaker/delete-fleet.rst new file mode 100644 index 00000000..3eb7ac6e --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/delete-fleet.rst @@ -0,0 +1,7 @@ +**To delete a fleet** + +This example deletes a fleet. + +Command:: + + aws robomaker delete-fleet --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771394395 diff --git a/aws/dist/awscli/examples/robomaker/delete-robot-application.rst b/aws/dist/awscli/examples/robomaker/delete-robot-application.rst new file mode 100644 index 00000000..e355da1a --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/delete-robot-application.rst @@ -0,0 +1,7 @@ +**To delete a robot application** + +This example deletes a robot application. + +Command:: + + aws robomaker delete-robot-application --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821 diff --git a/aws/dist/awscli/examples/robomaker/delete-robot.rst b/aws/dist/awscli/examples/robomaker/delete-robot.rst new file mode 100644 index 00000000..b36f85b2 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/delete-robot.rst @@ -0,0 +1,7 @@ +**To delete a robot** + +This example deletes a robot. + +Command:: + + aws robomaker delete-robot --robot arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540829698778 diff --git a/aws/dist/awscli/examples/robomaker/delete-simulation-application.rst b/aws/dist/awscli/examples/robomaker/delete-simulation-application.rst new file mode 100644 index 00000000..efe076bf --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/delete-simulation-application.rst @@ -0,0 +1,7 @@ +**To delete a simulation application** + +This example deletes a simulation application. + +Command:: + + aws robomaker delete-simulation-application --application arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605 diff --git a/aws/dist/awscli/examples/robomaker/deregister-robot.rst b/aws/dist/awscli/examples/robomaker/deregister-robot.rst new file mode 100644 index 00000000..bda6f5ae --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/deregister-robot.rst @@ -0,0 +1,14 @@ +**To deregister a robot from a fleet** + +This example deregisters a robot from a fleet. + +Command:: + + aws robomaker deregister-robot --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907 --robot arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398 + +Output:: + + { + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907", + "robot": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398" + } diff --git a/aws/dist/awscli/examples/robomaker/describe-deployment-job.rst b/aws/dist/awscli/examples/robomaker/describe-deployment-job.rst new file mode 100644 index 00000000..c4e4e696 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-deployment-job.rst @@ -0,0 +1,38 @@ +**To describe a deployment job** + +The following ``describe-deployment-job`` example retrieves the details about the specified deployment job. :: + + aws robomaker describe-deployment-job \ + --job arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn", + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711", + "status": "InProgress", + "deploymentConfig": { + "concurrentDeploymentPercentage": 20, + "failureThresholdPercentage": 25 + }, + "deploymentApplicationConfigs": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerHelloWorldRobot/1546541208251", + "applicationVersion": "1", + "launchConfig": { + "packageName": "hello_world_robot", + "launchFile": "rotate.launch" + } + } + ], + "createdAt": 1551218369.0, + "robotDeploymentSummary": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540834232469", + "deploymentStartTime": 1551218376.0, + "status": "Deploying", + "progressDetail": {} + } + ], + "tags": {} + } diff --git a/aws/dist/awscli/examples/robomaker/describe-fleet.rst b/aws/dist/awscli/examples/robomaker/describe-fleet.rst new file mode 100644 index 00000000..1698ae1e --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-fleet.rst @@ -0,0 +1,28 @@ +**To describe a fleet** + +The following ``describe-fleet`` example retrieves the details for the specified fleet. :: + + aws robomaker describe-fleet \ + --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907 + +Output:: + + { + "name": "MyFleet", + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "robots": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540834232469", + "createdAt": 1540834232.0 + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyOtherRobot/1540829698778", + "createdAt": 1540829698.0 + } + ], + "createdAt": 1539894765.0, + "lastDeploymentStatus": "Succeeded", + "lastDeploymentJob": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-xl8qssl6pbcn", + "lastDeploymentTime": 1551218369.0, + "tags": {} + } diff --git a/aws/dist/awscli/examples/robomaker/describe-robot-application.rst b/aws/dist/awscli/examples/robomaker/describe-robot-application.rst new file mode 100644 index 00000000..137513c0 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-robot-application.rst @@ -0,0 +1,29 @@ +**To describe a robot application** + +This example describes a robot application. + +Command:: + + aws robomaker describe-robot-application --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821", + "name": "MyRobotApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-robot-application.tar.gz", + "architecture": "X86_64" + } + ], + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "revisionId": "e72efe0d-f44f-4333-b604-f6fa5c6bb50b", + "lastUpdatedAt": 1551203485.0, + "tags": {} + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/describe-robot.rst b/aws/dist/awscli/examples/robomaker/describe-robot.rst new file mode 100644 index 00000000..e4c5a581 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-robot.rst @@ -0,0 +1,21 @@ +**To describe a robot** + +This example describes a robot. + +Command:: + + aws robomaker describe-robot --robot arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398", + "name": "MyRobot", + "status": "Available", + "greengrassGroupId": "0f728a3c-7dbf-4a3e-976d-d16a8360caba", + "createdAt": 1550772325.0, + "architecture": "ARMHF", + "tags": { + "Region": "East" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/describe-simulation-application.rst b/aws/dist/awscli/examples/robomaker/describe-simulation-application.rst new file mode 100644 index 00000000..578a7c7b --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-simulation-application.rst @@ -0,0 +1,37 @@ +**To describe a simulation application** + +This example describes a simulation application. + +Command:: + + aws robomaker describe-simulation-application --application arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605", + "name": "MySimulationApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-simulation-application.tar.gz", + "architecture": "X86_64" + } + ], + "simulationSoftwareSuite": { + "name": "Gazebo", + "version": "7" + }, + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "renderingEngine": { + "name": "OGRE", + "version": "1.x" + }, + "revisionId": "783674ab-b7b8-42d9-b01f-9373907987e5", + "lastUpdatedAt": 1551203427.0, + "tags": {} + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/describe-simulation-job.rst b/aws/dist/awscli/examples/robomaker/describe-simulation-job.rst new file mode 100644 index 00000000..cfa3a1ad --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/describe-simulation-job.rst @@ -0,0 +1,45 @@ +**To describe a simulation job** + +This example describes a simulation job. + +Command:: + + aws robomaker describe-simulation-job --job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-pql32v7pfjy6 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-pql32v7pfjy6", + "status": "Running", + "lastUpdatedAt": 1551219349.0, + "failureBehavior": "Continue", + "clientRequestToken": "a19ec4b5-e50d-3591-33da-c2e593c60615", + "outputLocation": { + "s3Bucket": "my-output-bucket", + "s3Prefix": "output" + }, + "maxJobDurationInSeconds": 3600, + "simulationTimeMillis": 0, + "iamRole": "arn:aws:iam::111111111111:role/MySimulationRole", + "robotApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551206341136", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_robot", + "launchFile": "rotate.launch" + } + } + ], + "simulationApplications": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551206347967", + "applicationVersion": "$LATEST", + "launchConfig": { + "packageName": "hello_world_simulation", + "launchFile": "empty_world.launch" + } + } + ], + "tags": {} + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-deployment-jobs.rst b/aws/dist/awscli/examples/robomaker/list-deployment-jobs.rst new file mode 100644 index 00000000..e7e87681 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-deployment-jobs.rst @@ -0,0 +1,57 @@ +**To list deployment jobs** + +The following ``list-deployment-jobs`` example retrieves a list of deployment jobs. :: + + aws robomaker list-deployment-jobs + +Output:: + + { + "deploymentJobs": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/sim-6293szzm56rv", + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "status": "InProgress", + "deploymentApplicationConfigs": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/HelloWorldRobot/1546537110575", + "applicationVersion": "1", + "launchConfig": { + "packageName": "hello_world_robot", + "launchFile": "rotate.launch", + "environmentVariables": { + "ENVIRONMENT": "Desert" + } + } + } + ], + "deploymentConfig": { + "concurrentDeploymentPercentage": 20, + "failureThresholdPercentage": 25 + }, + "createdAt": 1550689373.0 + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-4w4g69p25zdb", + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "status": "Pending", + "deploymentApplicationConfigs": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/AWSRoboMakerHelloWorld-1544562726923_YGHM_sh5M/1544562822877", + "applicationVersion": "1", + "launchConfig": { + "packageName": "fail", + "launchFile": "fail" + } + } + ], + "deploymentConfig": { + "concurrentDeploymentPercentage": 20, + "failureThresholdPercentage": 25 + }, + "failureReason": "", + "failureCode": "", + "createdAt": 1544719763.0 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-fleets.rst b/aws/dist/awscli/examples/robomaker/list-fleets.rst new file mode 100644 index 00000000..2150e399 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-fleets.rst @@ -0,0 +1,22 @@ +**To list fleets** + +This example lists fleets. A maximum of 20 fleets will be returned. + +Command:: + + aws robomaker list-fleets --max-items 20 + +Output:: + + { + "fleetDetails": [ + { + "name": "Trek", + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "createdAt": 1539894765.0, + "lastDeploymentStatus": "Failed", + "lastDeploymentJob": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-4w4g69p25zdb", + "lastDeploymentTime": 1544719763.0 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-robot-applications.rst b/aws/dist/awscli/examples/robomaker/list-robot-applications.rst new file mode 100644 index 00000000..419d62f9 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-robot-applications.rst @@ -0,0 +1,32 @@ +**To list robot applications** + +This example lists robot applications. Results are limited to 20 robot applications. + +Command:: + + aws robomaker list-robot-applications --max-results 20 + +Output:: + + { + "robotApplicationSummaries": [ + { + "name": "MyRobot", + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobot/1546537110575", + "version": "$LATEST", + "lastUpdatedAt": 1546540372.0 + }, + { + "name": "AnotherRobot", + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/AnotherRobot/1546541208251", + "version": "$LATEST", + "lastUpdatedAt": 1546541208.0 + }, + { + "name": "MySuperRobot", + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MySuperRobot/1547663517377", + "version": "$LATEST", + "lastUpdatedAt": 1547663517.0 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-robots.rst b/aws/dist/awscli/examples/robomaker/list-robots.rst new file mode 100644 index 00000000..e51b9509 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-robots.rst @@ -0,0 +1,45 @@ +**To list robots** + +This example lists robots. A maximum of 20 robots will be returned. + +Command:: + + aws robomaker list-robots --max-results 20 + +Output:: + + { + "robots": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot100/1544035373264", + "name": "Robot100", + "status": "Available", + "createdAt": 1544035373.0, + "architecture": "X86_64" + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot101/1542146976587", + "name": "Robot101", + "status": "Available", + "createdAt": 1542146976.0, + "architecture": "X86_64" + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/Robot102/1540834232469", + "name": "Robot102", + "fleetArn": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711", + "status": "Available", + "createdAt": 1540834232.0, + "architecture": "X86_64", + "lastDeploymentJob": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-jb007b75gl5f", + "lastDeploymentTime": 1550689533.0 + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1540829698778", + "name": "MyRobot", + "status": "Registered", + "createdAt": 1540829698.0, + "architecture": "X86_64" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-simulation-applications.rst b/aws/dist/awscli/examples/robomaker/list-simulation-applications.rst new file mode 100644 index 00000000..107c783e --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-simulation-applications.rst @@ -0,0 +1,50 @@ +**To list simulation applications** + +This example lists simulation applications. A maximum of 20 simulation applications will be returned. + +Command:: + + aws robomaker list-simulation-applications --max-results 20 + +Output:: + + { + "simulationApplicationSummaries": [ + { + "name": "AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq/1548959170096", + "version": "$LATEST", + "lastUpdatedAt": 1548959170.0 + }, + { + "name": "RoboMakerHelloWorldSimulation", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerHelloWorldSimulation/1546541198985", + "version": "$LATEST", + "lastUpdatedAt": 1546541198.0 + }, + { + "name": "RoboMakerObjectTrackerSimulation", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerObjectTrackerSimulation/1545846795615", + "version": "$LATEST", + "lastUpdatedAt": 1545847405.0 + }, + { + "name": "RoboMakerVoiceInteractionSimulation", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerVoiceInteractionSimulation/1546537100507", + "version": "$LATEST", + "lastUpdatedAt": 1546540352.0 + }, + { + "name": "AWSRoboMakerCloudWatch-1547663411642_0LIt6D1h6", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerCloudWatch-1547663411642_0LIt6D1h6/1547663521470", + "version": "$LATEST", + "lastUpdatedAt": 1547663521.0 + }, + { + "name": "AWSRoboMakerDeepRacer-1545848257672_1YZCaieQ-", + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerDeepRacer-1545848257672_1YZCaieQ-/1545848370525", + "version": "$LATEST", + "lastUpdatedAt": 1545848370.0 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-simulation-jobs.rst b/aws/dist/awscli/examples/robomaker/list-simulation-jobs.rst new file mode 100644 index 00000000..b8591608 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-simulation-jobs.rst @@ -0,0 +1,80 @@ +**To list simulation jobs** + +This example lists simulation jobs. + +Command:: + + aws robomaker list-simulation-jobs + +Output:: + + { + "simulationJobSummaries": [ + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x", + "lastUpdatedAt": 1548959178.0, + "status": "Completed", + "simulationApplicationNames": [ + "AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq" + ], + "robotApplicationNames": [ + null + ] + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-b27c4rkrtzcw", + "lastUpdatedAt": 1543514088.0, + "status": "Canceled", + "simulationApplicationNames": [ + "AWSRoboMakerPersonDetection-1543513948280_T8rHW2_lu" + ], + "robotApplicationNames": [ + "AWSRoboMakerPersonDetection-1543513948280_EYaMT0mYb" + ] + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-51vxjbzy4q8t", + "lastUpdatedAt": 1543508858.0, + "status": "Canceled", + "simulationApplicationNames": [ + "AWSRoboMakerCloudWatch-1543504747391_lFF9ZQyx6" + ], + "robotApplicationNames": [ + "AWSRoboMakerCloudWatch-1543504747391_axbYa3S3K" + ] + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-kgf1fqxflqbx", + "lastUpdatedAt": 1543504862.0, + "status": "Completed", + "simulationApplicationNames": [ + "AWSRoboMakerCloudWatch-1543504747391_lFF9ZQyx6" + ], + "robotApplicationNames": [ + "AWSRoboMakerCloudWatch-1543504747391_axbYa3S3K" + ] + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-vw8lvh061nqt", + "lastUpdatedAt": 1543441430.0, + "status": "Completed", + "simulationApplicationNames": [ + "AWSRoboMakerHelloWorld-1543437372341__yb_Jg96l" + ], + "robotApplicationNames": [ + "AWSRoboMakerHelloWorld-1543437372341_lNbmKHvs9" + ] + }, + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-txy5ypxmhz84", + "lastUpdatedAt": 1543437488.0, + "status": "Completed", + "simulationApplicationNames": [ + "AWSRoboMakerHelloWorld-1543437372341__yb_Jg96l" + ], + "robotApplicationNames": [ + "AWSRoboMakerHelloWorld-1543437372341_lNbmKHvs9" + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/list-tags-for-resource.rst b/aws/dist/awscli/examples/robomaker/list-tags-for-resource.rst new file mode 100644 index 00000000..cfc9c8de --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/list-tags-for-resource.rst @@ -0,0 +1,16 @@ +**To list tags for a resource** + +This example lists tags for an AWS RoboMaker resource. + +Command:: + + aws robomaker list-tags-for-resource --resource-arn "arn:aws:robomaker:us-west-2:111111111111:robot/Robby_the_Robot/1544035373264" + +Output:: + + { + "tags": { + "Region": "North", + "Stage": "Initial" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/register-robot.rst b/aws/dist/awscli/examples/robomaker/register-robot.rst new file mode 100644 index 00000000..18494d48 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/register-robot.rst @@ -0,0 +1,14 @@ +**To register a robot** + +This example registers a robot to a fleet. + +Command:: + + aws robomaker register-robot --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907 --robot arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398 + +Output:: + + { + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1550771358907", + "robot": "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1550772324398" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/restart-simulation-job.rst b/aws/dist/awscli/examples/robomaker/restart-simulation-job.rst new file mode 100644 index 00000000..409ce935 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/restart-simulation-job.rst @@ -0,0 +1,7 @@ +**To restart a simulation** + +This example restarts a simulation. + +Command:: + + aws robomaker restart-simulation-job --job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-t6rdgt70mftr diff --git a/aws/dist/awscli/examples/robomaker/sync-deployment-job.rst b/aws/dist/awscli/examples/robomaker/sync-deployment-job.rst new file mode 100644 index 00000000..4ae4d593 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/sync-deployment-job.rst @@ -0,0 +1,30 @@ +**To sync a deployment job** + +This example synchronizes a deployment job. + +Command:: + + aws robomaker sync-deployment-job --fleet arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/Trek/1539894765711 + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:deployment-job/deployment-09ccxs3tlfms", + "fleet": "arn:aws:robomaker:us-west-2:111111111111:deployment-fleet/MyFleet/1539894765711", + "status": "Pending", + "deploymentConfig": { + "concurrentDeploymentPercentage": 20, + "failureThresholdPercentage": 25 + }, + "deploymentApplicationConfigs": [ + { + "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1546541208251", + "applicationVersion": "1", + "launchConfig": { + "packageName": "hello_world_simulation", + "launchFile": "empty_world.launch" + } + } + ], + "createdAt": 1551286954.0 + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/tag-resource.rst b/aws/dist/awscli/examples/robomaker/tag-resource.rst new file mode 100644 index 00000000..2a89b558 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/tag-resource.rst @@ -0,0 +1,7 @@ +**To tag a resource** + +This example tags a resource. It attaches two tags: Region and Stage. + +Command:: + + aws robomaker tag-resource --resource-arn "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1544035373264" --tags Region=North,Stage=Initial diff --git a/aws/dist/awscli/examples/robomaker/untag-resource.rst b/aws/dist/awscli/examples/robomaker/untag-resource.rst new file mode 100644 index 00000000..1a139cc1 --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/untag-resource.rst @@ -0,0 +1,7 @@ +**To untag a resource** + +This example removes a tag from a resource. It removes the Region tag. + +Command:: + + aws robomaker untag-resource --resource-arn "arn:aws:robomaker:us-west-2:111111111111:robot/MyRobot/1544035373264" --tag-keys Region diff --git a/aws/dist/awscli/examples/robomaker/update-robot-application.rst b/aws/dist/awscli/examples/robomaker/update-robot-application.rst new file mode 100644 index 00000000..d6057c8e --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/update-robot-application.rst @@ -0,0 +1,28 @@ +**To update a robot application** + +This example updates a robot application. + +Command:: + + aws robomaker update-robot-application --application arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821 --sources s3Bucket=my-bucket,s3Key=my-robot-application.tar.gz,architecture=X86_64 --robot-software-suite name=ROS,version=Kinetic + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821", + "name": "MyRobotApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-robot-application.tar.gz", + "architecture": "X86_64" + } + ], + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "lastUpdatedAt": 1551287993.0, + "revisionId": "20b5e331-24fd-4504-8b8c-531afe5f4c94" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/robomaker/update-simulation-application.rst b/aws/dist/awscli/examples/robomaker/update-simulation-application.rst new file mode 100644 index 00000000..54388e3f --- /dev/null +++ b/aws/dist/awscli/examples/robomaker/update-simulation-application.rst @@ -0,0 +1,36 @@ +**To update a simulation application** + +This example updates a simulation application. + +Command:: + + aws robomaker update-simulation-application --application arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605 --sources s3Bucket=my-bucket,s3Key=my-simulation-application.tar.gz,architecture=X86_64 --robot-software-suite name=ROS,version=Kinetic --simulation-software-suite name=Gazebo,version=7 --rendering-engine name=OGRE,version=1.x + +Output:: + + { + "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605", + "name": "MySimulationApplication", + "version": "$LATEST", + "sources": [ + { + "s3Bucket": "my-bucket", + "s3Key": "my-simulation-application.tar.gz", + "architecture": "X86_64" + } + ], + "simulationSoftwareSuite": { + "name": "Gazebo", + "version": "7" + }, + "robotSoftwareSuite": { + "name": "ROS", + "version": "Kinetic" + }, + "renderingEngine": { + "name": "OGRE", + "version": "1.x" + }, + "lastUpdatedAt": 1551289361.0, + "revisionId": "4a22cb5d-93c5-4cef-9311-52bdd119b79e" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/route53/change-resource-record-sets.rst b/aws/dist/awscli/examples/route53/change-resource-record-sets.rst new file mode 100644 index 00000000..1eb7874f --- /dev/null +++ b/aws/dist/awscli/examples/route53/change-resource-record-sets.rst @@ -0,0 +1,233 @@ +**To create, update, or delete a resource record set** + +The following ``change-resource-record-sets`` command creates a resource record set using the ``hosted-zone-id`` ``Z1R8UBAEXAMPLE`` and the JSON-formatted configuration in the file ``C:\awscli\route53\change-resource-record-sets.json``:: + + aws route53 change-resource-record-sets --hosted-zone-id Z1R8UBAEXAMPLE --change-batch file://C:\awscli\route53\change-resource-record-sets.json + +For more information, see `POST ChangeResourceRecordSets`_ in the *Amazon Route 53 API Reference*. + +.. _`POST ChangeResourceRecordSets`: http://docs.aws.amazon.com/Route53/latest/APIReference/API_ChangeResourceRecordSets.html + + +The configuration in the JSON file depends on the kind of resource record set you want to create: + +- Basic + +- Weighted + +- Alias + +- Weighted Alias + +- Latency + +- Latency Alias + +- Failover + +- Failover Alias + + + +**Basic Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "TTL": time to live in seconds, + "ResourceRecords": [ + { + "Value": "applicable value for the record type" + }, + {...} + ] + } + }, + {...} + ] + } + + +**Weighted Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Weight": value between 0 and 255, + "TTL": time to live in seconds, + "ResourceRecords": [ + { + "Value": "applicable value for the record type" + }, + {...} + ], + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + +**Alias Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "AliasTarget": { + "HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone", + "DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone", + "EvaluateTargetHealth": true|false + }, + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + +**Weighted Alias Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Weight": value between 0 and 255, + "AliasTarget": { + "HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone", + "DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone", + "EvaluateTargetHealth": true|false + }, + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + + +**Latency Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Region": "Amazon EC2 region name", + "TTL": time to live in seconds, + "ResourceRecords": [ + { + "Value": "applicable value for the record type" + }, + {...} + ], + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + +**Latency Alias Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Region": "Amazon EC2 region name", + "AliasTarget": { + "HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone", + "DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone", + "EvaluateTargetHealth": true|false + }, + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + +**Failover Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Failover": "PRIMARY" | "SECONDARY", + "TTL": time to live in seconds, + "ResourceRecords": [ + { + "Value": "applicable value for the record type" + }, + {...} + ], + "HealthCheckId": "ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } + + +**Failover Alias Syntax**:: + + { + "Comment": "optional comment about the changes in this change batch request", + "Changes": [ + { + "Action": "CREATE"|"DELETE"|"UPSERT", + "ResourceRecordSet": { + "Name": "DNS domain name", + "Type": "SOA"|"A"|"TXT"|"NS"|"CNAME"|"MX"|"PTR"|"SRV"|"SPF"|"AAAA", + "SetIdentifier": "unique description for this resource record set", + "Failover": "PRIMARY" | "SECONDARY", + "AliasTarget": { + "HostedZoneId": "hosted zone ID for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or Amazon Route 53 hosted zone", + "DNSName": "DNS domain name for your CloudFront distribution, Amazon S3 bucket, Elastic Load Balancing load balancer, or another resource record set in this hosted zone", + "EvaluateTargetHealth": true|false + }, + "HealthCheckId": "optional ID of an Amazon Route 53 health check" + } + }, + {...} + ] + } diff --git a/aws/dist/awscli/examples/route53/change-tags-for-resource.rst b/aws/dist/awscli/examples/route53/change-tags-for-resource.rst new file mode 100644 index 00000000..826b6353 --- /dev/null +++ b/aws/dist/awscli/examples/route53/change-tags-for-resource.rst @@ -0,0 +1,7 @@ +The following command adds a tag named ``owner`` to a healthcheck resource specified by ID:: + + aws route53 change-tags-for-resource --resource-type healthcheck --resource-id 6233434j-18c1-34433-ba8e-3443434 --add-tags Key=owner,Value=myboss + +The following command removes a tag named ``owner`` from a hosted zone resource specified by ID:: + + aws route53 change-tags-for-resource --resource-type hostedzone --resource-id Z1523434445 --remove-tag-keys owner diff --git a/aws/dist/awscli/examples/route53/create-health-check.rst b/aws/dist/awscli/examples/route53/create-health-check.rst new file mode 100644 index 00000000..8b295482 --- /dev/null +++ b/aws/dist/awscli/examples/route53/create-health-check.rst @@ -0,0 +1,26 @@ +**To create a health check** + +The following ``create-health-check`` command creates a health check using the caller reference ``2014-04-01-18:47`` and the JSON-formatted configuration in the file ``C:\awscli\route53\create-health-check.json``:: + + aws route53 create-health-check --caller-reference 2014-04-01-18:47 --health-check-config file://C:\awscli\route53\create-health-check.json + +JSON syntax:: + + { + "IPAddress": "IP address of the endpoint to check", + "Port": port on the endpoint to check--required when Type is "TCP", + "Type": "HTTP"|"HTTPS"|"HTTP_STR_MATCH"|"HTTPS_STR_MATCH"|"TCP", + "ResourcePath": "path of the file that you want Amazon Route 53 to request--all Types except TCP", + "FullyQualifiedDomainName": "domain name of the endpoint to check--all Types except TCP", + "SearchString": "if Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string to search for in the response body from the specified resource", + "RequestInterval": 10 | 30, + "FailureThreshold": integer between 1 and 10 + } + + +To add the health check to a Route 53 resource record set, use the ``change-resource-record-sets`` command. + +For more information, see `Amazon Route 53 Health Checks and DNS Failover`_ in the *Amazon Route 53 Developer Guide*. + +.. _`Amazon Route 53 Health Checks and DNS Failover`: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html + diff --git a/aws/dist/awscli/examples/route53/create-hosted-zone.rst b/aws/dist/awscli/examples/route53/create-hosted-zone.rst new file mode 100644 index 00000000..089966f5 --- /dev/null +++ b/aws/dist/awscli/examples/route53/create-hosted-zone.rst @@ -0,0 +1,10 @@ +**To create a hosted zone** + +The following ``create-hosted-zone`` command adds a hosted zone named ``example.com`` using the caller reference ``2014-04-01-18:47``. The optional comment includes a space, so it must be enclosed in quotation marks:: + + aws route53 create-hosted-zone --name example.com --caller-reference 2014-04-01-18:47 --hosted-zone-config Comment="command-line version" + +For more information, see `Working with Hosted Zones`_ in the *Amazon Route 53 Developer Guide*. + +.. _`Working with Hosted Zones`: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/AboutHZWorkingWith.html + diff --git a/aws/dist/awscli/examples/route53/delete-health-check.rst b/aws/dist/awscli/examples/route53/delete-health-check.rst new file mode 100644 index 00000000..17689341 --- /dev/null +++ b/aws/dist/awscli/examples/route53/delete-health-check.rst @@ -0,0 +1,5 @@ +**To delete a health check** + +The following ``delete-health-check`` command deletes the health check with a ``health-check-id`` of ``e75b48d9-547a-4c3d-88a5-ae4002397608``:: + + aws route53 delete-health-check --health-check-id e75b48d9-547a-4c3d-88a5-ae4002397608 diff --git a/aws/dist/awscli/examples/route53/delete-hosted-zone.rst b/aws/dist/awscli/examples/route53/delete-hosted-zone.rst new file mode 100644 index 00000000..b2dbc5ca --- /dev/null +++ b/aws/dist/awscli/examples/route53/delete-hosted-zone.rst @@ -0,0 +1,6 @@ +**To delete a hosted zone** + +The following ``delete-hosted-zone`` command deletes the hosted zone with an ``id`` of ``Z36KTIQEXAMPLE``:: + + aws route53 delete-hosted-zone --id Z36KTIQEXAMPLE + diff --git a/aws/dist/awscli/examples/route53/get-change.rst b/aws/dist/awscli/examples/route53/get-change.rst new file mode 100644 index 00000000..92698f80 --- /dev/null +++ b/aws/dist/awscli/examples/route53/get-change.rst @@ -0,0 +1,6 @@ +**To get the status of a change to resource record sets** + +The following ``get-change`` command gets the status and other information about the ``change-resource-record-sets`` request that has an ``Id`` of ``/change/CWPIK4URU2I5S``:: + + aws route53 get-change --id /change/CWPIK4URU2I5S + diff --git a/aws/dist/awscli/examples/route53/get-health-check.rst b/aws/dist/awscli/examples/route53/get-health-check.rst new file mode 100644 index 00000000..2c512bfb --- /dev/null +++ b/aws/dist/awscli/examples/route53/get-health-check.rst @@ -0,0 +1,6 @@ +**To get information about a health check** + +The following ``get-health-check`` command gets information about the health check that has a ``health-check-id`` of ``02ec8401-9879-4259-91fa-04e66d094674``:: + + aws route53 get-health-check --health-check-id 02ec8401-9879-4259-91fa-04e66d094674 + diff --git a/aws/dist/awscli/examples/route53/get-hosted-zone.rst b/aws/dist/awscli/examples/route53/get-hosted-zone.rst new file mode 100644 index 00000000..998eb41e --- /dev/null +++ b/aws/dist/awscli/examples/route53/get-hosted-zone.rst @@ -0,0 +1,5 @@ +**To get information about a hosted zone** + +The following ``get-hosted-zone`` command gets information about the hosted zone with an ``id`` of ``Z1R8UBAEXAMPLE``:: + + aws route53 get-hosted-zone --id Z1R8UBAEXAMPLE diff --git a/aws/dist/awscli/examples/route53/list-health-checks.rst b/aws/dist/awscli/examples/route53/list-health-checks.rst new file mode 100644 index 00000000..15b6df47 --- /dev/null +++ b/aws/dist/awscli/examples/route53/list-health-checks.rst @@ -0,0 +1,15 @@ +**To list the health checks associated with the current AWS account** + +The following ``list-health-checks`` command lists detailed information about the first 100 health checks that are associated with the current AWS account.:: + + aws route53 list-health-checks + +If you have more than 100 health checks, or if you want to list them in groups smaller than 100, include the ``--maxitems`` parameter. For example, to list health checks one at a time, use the following command:: + + aws route53 list-health-checks --max-items 1 + +To view the next health check, take the value of ``NextToken`` from the response to the previous command, and include it in the ``--starting-token`` parameter, for example:: + + aws route53 list-health-checks --max-items 1 --starting-token Z3M3LMPEXAMPLE + + diff --git a/aws/dist/awscli/examples/route53/list-hosted-zones-by-name.rst b/aws/dist/awscli/examples/route53/list-hosted-zones-by-name.rst new file mode 100644 index 00000000..a0d19c60 --- /dev/null +++ b/aws/dist/awscli/examples/route53/list-hosted-zones-by-name.rst @@ -0,0 +1,56 @@ +The following command lists up to 100 hosted zones ordered by domain name:: + + aws route53 list-hosted-zones-by-name + +Output:: + + { + "HostedZones": [ + { + "ResourceRecordSetCount": 2, + "CallerReference": "test20150527-2", + "Config": { + "Comment": "test2", + "PrivateZone": false + }, + "Id": "/hostedzone/Z119WBBTVP5WFX", + "Name": "2.example.com." + }, + { + "ResourceRecordSetCount": 2, + "CallerReference": "test20150527-1", + "Config": { + "Comment": "test", + "PrivateZone": false + }, + "Id": "/hostedzone/Z3P5QSUBK4POTI", + "Name": "www.example.com." + } + ], + "IsTruncated": false, + "MaxItems": "100" + } + +The following command lists hosted zones ordered by name, beginning with ``www.example.com``:: + + aws route53 list-hosted-zones-by-name --dns-name www.example.com + +Output:: + + { + "HostedZones": [ + { + "ResourceRecordSetCount": 2, + "CallerReference": "mwunderl20150527-1", + "Config": { + "Comment": "test", + "PrivateZone": false + }, + "Id": "/hostedzone/Z3P5QSUBK4POTI", + "Name": "www.example.com." + } + ], + "DNSName": "www.example.com", + "IsTruncated": false, + "MaxItems": "100" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/route53/list-hosted-zones.rst b/aws/dist/awscli/examples/route53/list-hosted-zones.rst new file mode 100644 index 00000000..1d60309c --- /dev/null +++ b/aws/dist/awscli/examples/route53/list-hosted-zones.rst @@ -0,0 +1,14 @@ +**To list the hosted zones associated with the current AWS account** + +The following ``list-hosted-zones`` command lists summary information about the first 100 hosted zones that are associated with the current AWS account.:: + + aws route53 list-hosted-zones + +If you have more than 100 hosted zones, or if you want to list them in groups smaller than 100, include the ``--max-items`` parameter. For example, to list hosted zones one at a time, use the following command:: + + aws route53 list-hosted-zones --max-items 1 + +To view information about the next hosted zone, take the value of ``NextToken`` from the response to the previous command, and include it in the ``--starting-token`` parameter, for example:: + + aws route53 list-hosted-zones --max-items 1 --starting-token Z3M3LMPEXAMPLE + diff --git a/aws/dist/awscli/examples/route53/list-resource-record-sets.rst b/aws/dist/awscli/examples/route53/list-resource-record-sets.rst new file mode 100644 index 00000000..8e021bd9 --- /dev/null +++ b/aws/dist/awscli/examples/route53/list-resource-record-sets.rst @@ -0,0 +1,18 @@ +**To list the resource record sets in a hosted zone** + +The following ``list-resource-record-sets`` command lists summary information about the first 100 resource record sets in a specified hosted zone.:: + + aws route53 list-resource-record-sets --hosted-zone-id Z2LD58HEXAMPLE + +If the hosted zone contains more than 100 resource record sets, or if you want to list them in groups smaller than 100, include the ``--maxitems`` parameter. For example, to list resource record sets one at a time, use the following command:: + + aws route53 list-resource-record-sets --hosted-zone-id Z2LD58HEXAMPLE --max-items 1 + +To view information about the next resource record set in the hosted zone, take the value of ``NextToken`` from the response to the previous command, and include it in the ``--starting-token`` parameter, for example:: + + aws route53 list-resource-record-sets --hosted-zone-id Z2LD58HEXAMPLE --max-items 1 --starting-token Z3M3LMPEXAMPLE + +To view all the resource record sets of a particular name, use the ``--query`` parameter to filter them out. For example:: + + aws route53 list-resource-record-sets --hosted-zone-id Z2LD58HEXAMPLE --query "ResourceRecordSets[?Name == 'example.domain.']" + diff --git a/aws/dist/awscli/examples/s3/_concepts.rst b/aws/dist/awscli/examples/s3/_concepts.rst new file mode 100644 index 00000000..9c7de44b --- /dev/null +++ b/aws/dist/awscli/examples/s3/_concepts.rst @@ -0,0 +1,163 @@ +This section explains prominent concepts and notations in the set of high-level S3 commands provided. + +Path Argument Type +++++++++++++++++++ + +Whenever using a command, at least one path argument must be specified. There +are two types of path arguments: ``LocalPath`` and ``S3Uri``. + +``LocalPath``: represents the path of a local file or directory. It can be +written as an absolute path or relative path. + +``S3Uri``: represents the location of a S3 object, prefix, or bucket. This +must be written in the form ``s3://mybucket/mykey`` where ``mybucket`` is +the specified S3 bucket, ``mykey`` is the specified S3 key. The path argument +must begin with ``s3://`` in order to denote that the path argument refers to +a S3 object. Note that prefixes are separated by forward slashes. For +example, if the S3 object ``myobject`` had the prefix ``myprefix``, the +S3 key would be ``myprefix/myobject``, and if the object was in the bucket +``mybucket``, the ``S3Uri`` would be ``s3://mybucket/myprefix/myobject``. + + +Order of Path Arguments ++++++++++++++++++++++++ + +Every command takes one or two positional path arguments. The first path +argument represents the source, which is the local file/directory or S3 +object/prefix/bucket that is being referenced. If there is a second path +argument, it represents the destination, which is the local file/directory +or S3 object/prefix/bucket that is being operated on. Commands with only +one path argument do not have a destination because the operation is being +performed only on the source. + + +Single Local File and S3 Object Operations +++++++++++++++++++++++++++++++++++++++++++ + +Some commands perform operations only on single files and S3 objects. The +following commands are single file/object operations if no ``--recursive`` +flag is provided. + + * ``cp`` + * ``mv`` + * ``rm`` + +For this type of operation, the first path argument, the source, must exist +and be a local file or S3 object. The second path argument, the destination, +can be the name of a local file, local directory, S3 object, S3 prefix, +or S3 bucket. + +The destination is indicated as a local directory, S3 prefix, or S3 bucket +if it ends with a forward slash or back slash. The use of slash depends +on the path argument type. If the path argument is a ``LocalPath``, +the type of slash is the separator used by the operating system. If the +path is a ``S3Uri``, the forward slash must always be used. If a slash +is at the end of the destination, the destination file or object will +adopt the name of the source file or object. Otherwise, if there is no +slash at the end, the file or object will be saved under the name provided. +See examples in ``cp`` and ``mv`` to illustrate this description. + + +Directory and S3 Prefix Operations +++++++++++++++++++++++++++++++++++ + +Some commands only perform operations on the contents of a local directory +or S3 prefix/bucket. Adding or omitting a forward slash or back slash to +the end of any path argument, depending on its type, does not affect the +results of the operation. The following commands will always result in +a directory or S3 prefix/bucket operation: + +* ``sync`` +* ``mb`` +* ``rb`` +* ``ls`` + + +Use of Exclude and Include Filters +++++++++++++++++++++++++++++++++++ + +Currently, there is no support for the use of UNIX style wildcards in +a command's path arguments. However, most commands have ``--exclude ""`` +and ``--include ""`` parameters that can achieve the desired result. +These parameters perform pattern matching to either exclude or include +a particular file or object. The following pattern symbols are supported. + + * ``*``: Matches everything + * ``?``: Matches any single character + * ``[sequence]``: Matches any character in ``sequence`` + * ``[!sequence]``: Matches any character not in ``sequence`` + +Any number of these parameters can be passed to a command. You can do this by +providing an ``--exclude`` or ``--include`` argument multiple times, e.g. +``--include "*.txt" --include "*.png"``. +When there are multiple filters, the rule is the filters that appear later in +the command take precedence over filters that appear earlier in the command. +For example, if the filter parameters passed to the command were + +:: + + --exclude "*" --include "*.txt" + +All files will be excluded from the command except for files ending with +``.txt`` However, if the order of the filter parameters was changed to + +:: + + --include "*.txt" --exclude "*" + +All files will be excluded from the command. + +Each filter is evaluated against the **source directory**. If the source +location is a file instead of a directory, the directory containing the file is +used as the source directory. For example, suppose you had the following +directory structure:: + + /tmp/foo/ + .git/ + |---config + |---description + foo.txt + bar.txt + baz.jpg + +In the command ``aws s3 sync /tmp/foo s3://bucket/`` the source directory is +``/tmp/foo``. Any include/exclude filters will be evaluated with the source +directory prepended. Below are several examples to demonstrate this. + +Given the directory structure above and the command +``aws s3 cp /tmp/foo s3://bucket/ --recursive --exclude ".git/*"``, the +files ``.git/config`` and ``.git/description`` will be excluded from the +files to upload because the exclude filter ``.git/*`` will have the source +prepended to the filter. This means that:: + + /tmp/foo/.git/* -> /tmp/foo/.git/config (matches, should exclude) + /tmp/foo/.git/* -> /tmp/foo/.git/description (matches, should exclude) + /tmp/foo/.git/* -> /tmp/foo/foo.txt (does not match, should include) + /tmp/foo/.git/* -> /tmp/foo/bar.txt (does not match, should include) + /tmp/foo/.git/* -> /tmp/foo/baz.jpg (does not match, should include) + +The command ``aws s3 cp /tmp/foo/ s3://bucket/ --recursive --exclude "ba*"`` +will exclude ``/tmp/foo/bar.txt`` and ``/tmp/foo/baz.jpg``:: + + /tmp/foo/ba* -> /tmp/foo/.git/config (does not match, should include) + /tmp/foo/ba* -> /tmp/foo/.git/description (does not match, should include) + /tmp/foo/ba* -> /tmp/foo/foo.txt (does not match, should include) + /tmp/foo/ba* -> /tmp/foo/bar.txt (matches, should exclude) + /tmp/foo/ba* -> /tmp/foo/baz.jpg (matches, should exclude) + + +Note that, by default, *all files are included*. This means that +providing **only** an ``--include`` filter will not change what +files are transferred. ``--include`` will only re-include files that +have been excluded from an ``--exclude`` filter. If you only want +to upload files with a particular extension, you need to first exclude +all files, then re-include the files with the particular extension. +This command will upload **only** files ending with ``.jpg``:: + + aws s3 cp /tmp/foo/ s3://bucket/ --recursive --exclude "*" --include "*.jpg" + +If you wanted to include both ``.jpg`` files as well as ``.txt`` files you +can run:: + + aws s3 cp /tmp/foo/ s3://bucket/ --recursive \ + --exclude "*" --include "*.jpg" --include "*.txt" diff --git a/aws/dist/awscli/examples/s3/cp.rst b/aws/dist/awscli/examples/s3/cp.rst new file mode 100644 index 00000000..604c8d84 --- /dev/null +++ b/aws/dist/awscli/examples/s3/cp.rst @@ -0,0 +1,167 @@ +**Copying a local file to S3** + +The following ``cp`` command copies a single file to a specified +bucket and key:: + + aws s3 cp test.txt s3://mybucket/test2.txt + +Output:: + + upload: test.txt to s3://mybucket/test2.txt + +**Copying a local file to S3 with an expiration date** + +The following ``cp`` command copies a single file to a specified +bucket and key that expires at the specified ISO 8601 timestamp:: + + aws s3 cp test.txt s3://mybucket/test2.txt --expires 2014-10-01T20:30:00Z + +Output:: + + upload: test.txt to s3://mybucket/test2.txt + + +**Copying a file from S3 to S3** + +The following ``cp`` command copies a single s3 object to a specified bucket and key:: + + aws s3 cp s3://mybucket/test.txt s3://mybucket/test2.txt + +Output:: + + copy: s3://mybucket/test.txt to s3://mybucket/test2.txt + + +**Copying an S3 object to a local file** + +The following ``cp`` command copies a single object to a specified file locally:: + + aws s3 cp s3://mybucket/test.txt test2.txt + +Output:: + + download: s3://mybucket/test.txt to test2.txt + + +**Copying an S3 object from one bucket to another** + +The following ``cp`` command copies a single object to a specified bucket while retaining its original name:: + + aws s3 cp s3://mybucket/test.txt s3://mybucket2/ + +Output:: + + copy: s3://mybucket/test.txt to s3://mybucket2/test.txt + +**Recursively copying S3 objects to a local directory** + +When passed with the parameter ``--recursive``, the following ``cp`` command recursively copies all objects under a +specified prefix and bucket to a specified directory. In this example, the bucket ``mybucket`` has the objects +``test1.txt`` and ``test2.txt``:: + + aws s3 cp s3://mybucket . --recursive + +Output:: + + download: s3://mybucket/test1.txt to test1.txt + download: s3://mybucket/test2.txt to test2.txt + +**Recursively copying local files to S3** + +When passed with the parameter ``--recursive``, the following ``cp`` command recursively copies all files under a +specified directory to a specified bucket and prefix while excluding some files by using an ``--exclude`` parameter. In +this example, the directory ``myDir`` has the files ``test1.txt`` and ``test2.jpg``:: + + aws s3 cp myDir s3://mybucket/ --recursive --exclude "*.jpg" + +Output:: + + upload: myDir/test1.txt to s3://mybucket/test1.txt + +**Recursively copying S3 objects to another bucket** + +When passed with the parameter ``--recursive``, the following ``cp`` command recursively copies all objects under a +specified bucket to another bucket while excluding some objects by using an ``--exclude`` parameter. In this example, +the bucket ``mybucket`` has the objects ``test1.txt`` and ``another/test1.txt``:: + + aws s3 cp s3://mybucket/ s3://mybucket2/ --recursive --exclude "another/*" + +Output:: + + copy: s3://mybucket/test1.txt to s3://mybucket2/test1.txt + +You can combine ``--exclude`` and ``--include`` options to copy only objects that match a pattern, excluding all others:: + + aws s3 cp s3://mybucket/logs/ s3://mybucket2/logs/ --recursive --exclude "*" --include "*.log" + +Output:: + + copy: s3://mybucket/logs/test/test.log to s3://mybucket2/logs/test/test.log + copy: s3://mybucket/logs/test3.log to s3://mybucket2/logs/test3.log + +**Setting the Access Control List (ACL) while copying an S3 object** + +The following ``cp`` command copies a single object to a specified bucket and key while setting the ACL to +``public-read-write``:: + + aws s3 cp s3://mybucket/test.txt s3://mybucket/test2.txt --acl public-read-write + +Output:: + + copy: s3://mybucket/test.txt to s3://mybucket/test2.txt + +Note that if you're using the ``--acl`` option, ensure that any associated IAM +policies include the ``"s3:PutObjectAcl"`` action:: + + aws iam get-user-policy --user-name myuser --policy-name mypolicy + +Output:: + + { + "UserName": "myuser", + "PolicyName": "mypolicy", + "PolicyDocument": { + "Version": "2012-10-17", + "Statement": [ + { + "Action": [ + "s3:PutObject", + "s3:PutObjectAcl" + ], + "Resource": [ + "arn:aws:s3:::mybucket/*" + ], + "Effect": "Allow", + "Sid": "Stmt1234567891234" + } + ] + } + } + +**Granting permissions for an S3 object** + +The following ``cp`` command illustrates the use of the ``--grants`` option to grant read access to all users and full +control to a specific user identified by their email address:: + + aws s3 cp file.txt s3://mybucket/ --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers full=emailaddress=user@example.com + +Output:: + + upload: file.txt to s3://mybucket/file.txt + +**Uploading a local file stream to S3** + +WARNING:: PowerShell may alter the encoding of or add a CRLF to piped input. + +The following ``cp`` command uploads a local file stream from standard input to a specified bucket and key:: + + aws s3 cp - s3://mybucket/stream.txt + + +**Downloading an S3 object as a local file stream** + +WARNING:: PowerShell may alter the encoding of or add a CRLF to piped or redirected output. + +The following ``cp`` command downloads an S3 object locally as a stream to standard output. Downloading as a stream is not currently compatible with the ``--recursive`` parameter:: + + aws s3 cp s3://mybucket/stream.txt - diff --git a/aws/dist/awscli/examples/s3/ls.rst b/aws/dist/awscli/examples/s3/ls.rst new file mode 100644 index 00000000..43c50e03 --- /dev/null +++ b/aws/dist/awscli/examples/s3/ls.rst @@ -0,0 +1,73 @@ +The following ``ls`` command lists all of the bucket owned by the user. In this example, the user owns the buckets +``mybucket`` and ``mybucket2``. The timestamp is the date the bucket was created, shown in your machine's time +zone. Note if ``s3://`` is used for the path argument ````, it will list all of the buckets as well:: + + aws s3 ls + +Output:: + + 2013-07-11 17:08:50 mybucket + 2013-07-24 14:55:44 mybucket2 + +The following ``ls`` command lists objects and common prefixes under a specified bucket and prefix. In this example, the +user owns the bucket ``mybucket`` with the objects ``test.txt`` and ``somePrefix/test.txt``. The ``LastWriteTime`` and +``Length`` are arbitrary. Note that since the ``ls`` command has no interaction with the local filesystem, the ``s3://`` +URI scheme is not required to resolve ambiguity and may be omitted:: + + aws s3 ls s3://mybucket + +Output:: + + PRE somePrefix/ + 2013-07-25 17:06:27 88 test.txt + + +The following ``ls`` command lists objects and common prefixes under a specified bucket and prefix. However, there are +no objects nor common prefixes under the specified bucket and prefix:: + + aws s3 ls s3://mybucket/noExistPrefix + +Output:: + + None + +The following ``ls`` command will recursively list objects in a bucket. Rather than showing ``PRE dirname/`` in the +output, all the content in a bucket will be listed in order:: + + aws s3 ls s3://mybucket --recursive + +Output:: + + 2013-09-02 21:37:53 10 a.txt + 2013-09-02 21:37:53 2863288 foo.zip + 2013-09-02 21:32:57 23 foo/bar/.baz/a + 2013-09-02 21:32:58 41 foo/bar/.baz/b + 2013-09-02 21:32:57 281 foo/bar/.baz/c + 2013-09-02 21:32:57 73 foo/bar/.baz/d + 2013-09-02 21:32:57 452 foo/bar/.baz/e + 2013-09-02 21:32:57 896 foo/bar/.baz/hooks/bar + 2013-09-02 21:32:57 189 foo/bar/.baz/hooks/foo + 2013-09-02 21:32:57 398 z.txt + +The following ``ls`` command demonstrates the same command using the --human-readable +and --summarize options. --human-readable displays file size in +Bytes/MiB/KiB/GiB/TiB/PiB/EiB. --summarize displays the total number of objects +and total size at the end of the result listing:: + + aws s3 ls s3://mybucket --recursive --human-readable --summarize + +Output:: + + 2013-09-02 21:37:53 10 Bytes a.txt + 2013-09-02 21:37:53 2.9 MiB foo.zip + 2013-09-02 21:32:57 23 Bytes foo/bar/.baz/a + 2013-09-02 21:32:58 41 Bytes foo/bar/.baz/b + 2013-09-02 21:32:57 281 Bytes foo/bar/.baz/c + 2013-09-02 21:32:57 73 Bytes foo/bar/.baz/d + 2013-09-02 21:32:57 452 Bytes foo/bar/.baz/e + 2013-09-02 21:32:57 896 Bytes foo/bar/.baz/hooks/bar + 2013-09-02 21:32:57 189 Bytes foo/bar/.baz/hooks/foo + 2013-09-02 21:32:57 398 Bytes z.txt + + Total Objects: 10 + Total Size: 2.9 MiB diff --git a/aws/dist/awscli/examples/s3/mb.rst b/aws/dist/awscli/examples/s3/mb.rst new file mode 100644 index 00000000..18110cc7 --- /dev/null +++ b/aws/dist/awscli/examples/s3/mb.rst @@ -0,0 +1,17 @@ +The following ``mb`` command creates a bucket. In this example, the user makes the bucket ``mybucket``. The bucket is +created in the region specified in the user's configuration file:: + + aws s3 mb s3://mybucket + +Output:: + + make_bucket: s3://mybucket + +The following ``mb`` command creates a bucket in a region specified by the ``--region`` parameter. In this example, the +user makes the bucket ``mybucket`` in the region ``us-west-1``:: + + aws s3 mb s3://mybucket --region us-west-1 + +Output:: + + make_bucket: s3://mybucket diff --git a/aws/dist/awscli/examples/s3/mv.rst b/aws/dist/awscli/examples/s3/mv.rst new file mode 100644 index 00000000..71149f52 --- /dev/null +++ b/aws/dist/awscli/examples/s3/mv.rst @@ -0,0 +1,81 @@ +The following ``mv`` command moves a single file to a specified bucket and key:: + + aws s3 mv test.txt s3://mybucket/test2.txt + +Output:: + + move: test.txt to s3://mybucket/test2.txt + +The following ``mv`` command moves a single s3 object to a specified bucket and key:: + + aws s3 mv s3://mybucket/test.txt s3://mybucket/test2.txt + +Output:: + + move: s3://mybucket/test.txt to s3://mybucket/test2.txt + +The following ``mv`` command moves a single object to a specified file locally:: + + aws s3 mv s3://mybucket/test.txt test2.txt + +Output:: + + move: s3://mybucket/test.txt to test2.txt + +The following ``mv`` command moves a single object to a specified bucket while retaining its original name:: + + aws s3 mv s3://mybucket/test.txt s3://mybucket2/ + +Output:: + + move: s3://mybucket/test.txt to s3://mybucket2/test.txt + +When passed with the parameter ``--recursive``, the following ``mv`` command recursively moves all objects under a +specified prefix and bucket to a specified directory. In this example, the bucket ``mybucket`` has the objects +``test1.txt`` and ``test2.txt``:: + + aws s3 mv s3://mybucket . --recursive + +Output:: + + move: s3://mybucket/test1.txt to test1.txt + move: s3://mybucket/test2.txt to test2.txt + +When passed with the parameter ``--recursive``, the following ``mv`` command recursively moves all files under a +specified directory to a specified bucket and prefix while excluding some files by using an ``--exclude`` parameter. In +this example, the directory ``myDir`` has the files ``test1.txt`` and ``test2.jpg``:: + + aws s3 mv myDir s3://mybucket/ --recursive --exclude "*.jpg" + +Output:: + + move: myDir/test1.txt to s3://mybucket2/test1.txt + +When passed with the parameter ``--recursive``, the following ``mv`` command recursively moves all objects under a +specified bucket to another bucket while excluding some objects by using an ``--exclude`` parameter. In this example, +the bucket ``mybucket`` has the objects ``test1.txt`` and ``another/test1.txt``:: + + aws s3 mv s3://mybucket/ s3://mybucket2/ --recursive --exclude "mybucket/another/*" + +Output:: + + move: s3://mybucket/test1.txt to s3://mybucket2/test1.txt + +The following ``mv`` command moves a single object to a specified bucket and key while setting the ACL to +``public-read-write``:: + + aws s3 mv s3://mybucket/test.txt s3://mybucket/test2.txt --acl public-read-write + +Output:: + + move: s3://mybucket/test.txt to s3://mybucket/test2.txt + +The following ``mv`` command illustrates the use of the ``--grants`` option to grant read access to all users and full +control to a specific user identified by their email address:: + + aws s3 mv file.txt s3://mybucket/ --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers full=emailaddress=user@example.com + +Output:: + + move: file.txt to s3://mybucket/file.txt + diff --git a/aws/dist/awscli/examples/s3/presign.rst b/aws/dist/awscli/examples/s3/presign.rst new file mode 100644 index 00000000..043f0f19 --- /dev/null +++ b/aws/dist/awscli/examples/s3/presign.rst @@ -0,0 +1,23 @@ +**To create a pre-signed URL with the default one hour lifetime that links to an object in an S3 bucket** + +The following ``presign`` command generates a pre-signed URL for a specified bucket and key that is valid for one hour:: + + aws s3 presign s3://awsexamplebucket/test2.txt + +Output:: + + https://awsexamplebucket.s3.amazonaws.com/test2.txt?AWSAccessKeyId=AKIAEXAMPLEACCESSKEY&Signature=EXHCcBe%EXAMPLEKnz3r8O0AgEXAMPLE&Expires=1555531131 + +**To create a pre-signed URL with a custom lifetime that links to an object in an S3 bucket** + +The following ``presign`` command generates a pre-signed URL for a specified bucket and key that is valid for one week:: + + aws s3 presign s3://awsexamplebucket/test2.txt --expires-in 604800 + +Output:: + + https://examplebucket.s3.amazonaws.com/test2.txt?AWSAccessKeyId=AKIAEXAMPLEACCESSKEY&Signature=EXHCcBe%EXAMPLEKnz3r8O0AgEXAMPLE&Expires=1556132848 + +For more information, see `Share an Object with Others`_ in the *S3 Developer Guide* guide. + +.. _`Share an Object with Others`: https://docs.aws.amazon.com/AmazonS3/latest/dev/ShareObjectPreSignedURL.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3/rb.rst b/aws/dist/awscli/examples/s3/rb.rst new file mode 100644 index 00000000..68b7d03a --- /dev/null +++ b/aws/dist/awscli/examples/s3/rb.rst @@ -0,0 +1,20 @@ +The following ``rb`` command removes a bucket. In this example, the user's bucket is ``mybucket``. Note that the bucket must be empty in order to remove:: + + aws s3 rb s3://mybucket + +Output:: + + remove_bucket: mybucket + +The following ``rb`` command uses the ``--force`` parameter to first remove all of the objects in the bucket and then +remove the bucket itself. In this example, the user's bucket is ``mybucket`` and the objects in ``mybucket`` are +``test1.txt`` and ``test2.txt``:: + + aws s3 rb s3://mybucket --force + +Output:: + + delete: s3://mybucket/test1.txt + delete: s3://mybucket/test2.txt + remove_bucket: mybucket + diff --git a/aws/dist/awscli/examples/s3/rm.rst b/aws/dist/awscli/examples/s3/rm.rst new file mode 100644 index 00000000..c684eb06 --- /dev/null +++ b/aws/dist/awscli/examples/s3/rm.rst @@ -0,0 +1,38 @@ +The following ``rm`` command deletes a single s3 object:: + + aws s3 rm s3://mybucket/test2.txt + +Output:: + + delete: s3://mybucket/test2.txt + +The following ``rm`` command recursively deletes all objects under a specified bucket and prefix when passed with the +parameter ``--recursive``. In this example, the bucket ``mybucket`` contains the objects ``test1.txt`` and +``test2.txt``:: + + aws s3 rm s3://mybucket --recursive + +Output:: + + delete: s3://mybucket/test1.txt + delete: s3://mybucket/test2.txt + +The following ``rm`` command recursively deletes all objects under a specified bucket and prefix when passed with the +parameter ``--recursive`` while excluding some objects by using an ``--exclude`` parameter. In this example, the bucket +``mybucket`` has the objects ``test1.txt`` and ``test2.jpg``:: + + aws s3 rm s3://mybucket/ --recursive --exclude "*.jpg" + +Output:: + + delete: s3://mybucket/test1.txt + +The following ``rm`` command recursively deletes all objects under a specified bucket and prefix when passed with the +parameter ``--recursive`` while excluding all objects under a particular prefix by using an ``--exclude`` parameter. In +this example, the bucket ``mybucket`` has the objects ``test1.txt`` and ``another/test.txt``:: + + aws s3 rm s3://mybucket/ --recursive --exclude "another/*" + +Output:: + + delete: s3://mybucket/test1.txt diff --git a/aws/dist/awscli/examples/s3/sync.rst b/aws/dist/awscli/examples/s3/sync.rst new file mode 100644 index 00000000..3f72b2ee --- /dev/null +++ b/aws/dist/awscli/examples/s3/sync.rst @@ -0,0 +1,84 @@ +The following ``sync`` command syncs objects under a specified prefix and bucket to files in a local directory by +uploading the local files to s3. A local file will require uploading if the size of the local file is different than +the size of the s3 object, the last modified time of the local file is newer than the last modified time of the s3 +object, or the local file does not exist under the specified bucket and prefix. In this example, the user syncs the +bucket ``mybucket`` to the local current directory. The local current directory contains the files ``test.txt`` and +``test2.txt``. The bucket ``mybucket`` contains no objects:: + + aws s3 sync . s3://mybucket + +Output:: + + upload: test.txt to s3://mybucket/test.txt + upload: test2.txt to s3://mybucket/test2.txt + +The following ``sync`` command syncs objects under a specified prefix and bucket to objects under another specified +prefix and bucket by copying s3 objects. A s3 object will require copying if the sizes of the two s3 objects differ, +the last modified time of the source is newer than the last modified time of the destination, or the s3 object does not +exist under the specified bucket and prefix destination. In this example, the user syncs the bucket ``mybucket`` to +the bucket ``mybucket2``. The bucket ``mybucket`` contains the objects ``test.txt`` and ``test2.txt``. The bucket +``mybucket2`` contains no objects:: + + aws s3 sync s3://mybucket s3://mybucket2 + +Output:: + + copy: s3://mybucket/test.txt to s3://mybucket2/test.txt + copy: s3://mybucket/test2.txt to s3://mybucket2/test2.txt + +The following ``sync`` command syncs files in a local directory to objects under a specified prefix and bucket by +downloading s3 objects. A s3 object will require downloading if the size of the s3 object differs from the size of the +local file, the last modified time of the s3 object is newer than the last modified time of the local file, or the s3 +object does not exist in the local directory. Take note that when objects are downloaded from s3, the last modified +time of the local file is changed to the last modified time of the s3 object. In this example, the user syncs the +current local directory to the bucket ``mybucket``. The bucket ``mybucket`` contains the objects ``test.txt`` and +``test2.txt``. The current local directory has no files:: + + aws s3 sync s3://mybucket . + +Output:: + + download: s3://mybucket/test.txt to test.txt + download: s3://mybucket/test2.txt to test2.txt + +The following ``sync`` command syncs objects under a specified prefix and bucket to files in a local directory by +uploading the local files to s3. Because the ``--delete`` parameter flag is thrown, any files existing under the +specified prefix and bucket but not existing in the local directory will be deleted. In this example, the user syncs +the bucket ``mybucket`` to the local current directory. The local current directory contains the files ``test.txt`` and +``test2.txt``. The bucket ``mybucket`` contains the object ``test3.txt``:: + + aws s3 sync . s3://mybucket --delete + +Output:: + + upload: test.txt to s3://mybucket/test.txt + upload: test2.txt to s3://mybucket/test2.txt + delete: s3://mybucket/test3.txt + +The following ``sync`` command syncs objects under a specified prefix and bucket to files in a local directory by +uploading the local files to s3. Because the ``--exclude`` parameter flag is thrown, all files matching the pattern +existing both in s3 and locally will be excluded from the sync. In this example, the user syncs the bucket ``mybucket`` +to the local current directory. The local current directory contains the files ``test.jpg`` and ``test2.txt``. The +bucket ``mybucket`` contains the object ``test.jpg`` of a different size than the local ``test.jpg``:: + + aws s3 sync . s3://mybucket --exclude "*.jpg" + +Output:: + + upload: test2.txt to s3://mybucket/test2.txt + +The following ``sync`` command syncs files under a local directory to objects under a specified prefix and bucket by +downloading s3 objects. This example uses the ``--exclude`` parameter flag to exclude a specified directory +and s3 prefix from the ``sync`` command. In this example, the user syncs the local current directory to the bucket +``mybucket``. The local current directory contains the files ``test.txt`` and ``another/test2.txt``. The bucket +``mybucket`` contains the objects ``another/test5.txt`` and ``test1.txt``:: + + aws s3 sync s3://mybucket/ . --exclude "*another/*" + +Output:: + + download: s3://mybucket/test1.txt to test1.txt + +The following ``sync`` command syncs files between two buckets in different regions:: + + aws s3 sync s3://my-us-west-2-bucket s3://my-us-east-1-bucket --source-region us-west-2 --region us-east-1 diff --git a/aws/dist/awscli/examples/s3/website.rst b/aws/dist/awscli/examples/s3/website.rst new file mode 100644 index 00000000..b1bd89c8 --- /dev/null +++ b/aws/dist/awscli/examples/s3/website.rst @@ -0,0 +1,9 @@ +The following command configures a bucket named ``my-bucket`` as a static website:: + + aws s3 website s3://my-bucket/ --index-document index.html --error-document error.html + +The index document option specifies the file in ``my-bucket`` that visitors will be directed to when they navigate to the website URL. In this case, the bucket is in the us-west-2 region, so the site would appear at ``http://my-bucket.s3-website-us-west-2.amazonaws.com``. + +All files in the bucket that appear on the static site must be configured to allow visitors to open them. File permissions are configured separately from the bucket website configuration. For information on hosting a static website in Amazon S3, see `Hosting a Static Website`_ in the *Amazon Simple Storage Service Developer Guide*. + +.. _`Hosting a Static Website`: http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/abort-multipart-upload.rst b/aws/dist/awscli/examples/s3api/abort-multipart-upload.rst new file mode 100644 index 00000000..a7eb6b5b --- /dev/null +++ b/aws/dist/awscli/examples/s3api/abort-multipart-upload.rst @@ -0,0 +1,5 @@ +The following command aborts a multipart upload for the key ``multipart/01`` in the bucket ``my-bucket``:: + + aws s3api abort-multipart-upload --bucket my-bucket --key 'multipart/01' --upload-id dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R + +The upload ID required by this command is output by ``create-multipart-upload`` and can also be retrieved with ``list-multipart-uploads``. \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/complete-multipart-upload.rst b/aws/dist/awscli/examples/s3api/complete-multipart-upload.rst new file mode 100644 index 00000000..c6b82347 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/complete-multipart-upload.rst @@ -0,0 +1,37 @@ +The following command completes a multipart upload for the key ``multipart/01`` in the bucket ``my-bucket``:: + + aws s3api complete-multipart-upload --multipart-upload file://mpustruct --bucket my-bucket --key 'multipart/01' --upload-id dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R + +The upload ID required by this command is output by ``create-multipart-upload`` and can also be retrieved with ``list-multipart-uploads``. + +The multipart upload option in the above command takes a JSON structure that describes the parts of the multipart upload that should be reassembled into the complete file. In this example, the ``file://`` prefix is used to load the JSON structure from a file in the local folder named ``mpustruct``. + +mpustruct:: + + { + "Parts": [ + { + "ETag": "e868e0f4719e394144ef36531ee6824c", + "PartNumber": 1 + }, + { + "ETag": "6bb2b12753d66fe86da4998aa33fffb0", + "PartNumber": 2 + }, + { + "ETag": "d0a0112e841abec9c9ec83406f0159c8", + "PartNumber": 3 + } + ] + } + +The ETag value for each part is upload is output each time you upload a part using the ``upload-part`` command and can also be retrieved by calling ``list-parts`` or calculated by taking the MD5 checksum of each part. + +Output:: + + { + "ETag": "\"3944a9f7a4faab7f78788ff6210f63f0-3\"", + "Bucket": "my-bucket", + "Location": "https://my-bucket.s3.amazonaws.com/multipart%2F01", + "Key": "multipart/01" + } diff --git a/aws/dist/awscli/examples/s3api/copy-object.rst b/aws/dist/awscli/examples/s3api/copy-object.rst new file mode 100644 index 00000000..747e3ba8 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/copy-object.rst @@ -0,0 +1,13 @@ +The following command copies an object from ``bucket-1`` to ``bucket-2``:: + + aws s3api copy-object --copy-source bucket-1/test.txt --key test.txt --bucket bucket-2 + +Output:: + + { + "CopyObjectResult": { + "LastModified": "2015-11-10T01:07:25.000Z", + "ETag": "\"589c8b79c230a6ecd5a7e1d040a9a030\"" + }, + "VersionId": "YdnYvTCVDqRRFA.NFJjy36p0hxifMlkA" + } diff --git a/aws/dist/awscli/examples/s3api/create-bucket.rst b/aws/dist/awscli/examples/s3api/create-bucket.rst new file mode 100644 index 00000000..b9c72b91 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/create-bucket.rst @@ -0,0 +1,24 @@ +The following command creates a bucket named ``my-bucket``:: + + aws s3api create-bucket --bucket my-bucket --region us-east-1 + +Output:: + + { + "Location": "/my-bucket" + } + + +The following command creates a bucket named ``my-bucket`` in the +``eu-west-1`` region. Regions outside of ``us-east-1`` require the appropriate +``LocationConstraint`` to be specified in order to create the bucket in the +desired region:: + + $ aws s3api create-bucket --bucket my-bucket --region eu-west-1 --create-bucket-configuration LocationConstraint=eu-west-1 + + +Output:: + + { + "Location": "http://my-bucket.s3.amazonaws.com/" + } diff --git a/aws/dist/awscli/examples/s3api/create-multipart-upload.rst b/aws/dist/awscli/examples/s3api/create-multipart-upload.rst new file mode 100644 index 00000000..a0552e99 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/create-multipart-upload.rst @@ -0,0 +1,13 @@ +The following command creates a multipart upload in the bucket ``my-bucket`` with the key ``multipart/01``:: + + aws s3api create-multipart-upload --bucket my-bucket --key 'multipart/01' + +Output:: + + { + "Bucket": "my-bucket", + "UploadId": "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R", + "Key": "multipart/01" + } + +The completed file will be named ``01`` in a folder called ``multipart`` in the bucket ``my-bucket``. Save the upload ID, key and bucket name for use with the ``upload-part`` command. \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-cors.rst b/aws/dist/awscli/examples/s3api/delete-bucket-cors.rst new file mode 100644 index 00000000..53ca2a4e --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-cors.rst @@ -0,0 +1,3 @@ +The following command deletes a Cross-Origin Resource Sharing configuration from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-cors --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-lifecycle.rst b/aws/dist/awscli/examples/s3api/delete-bucket-lifecycle.rst new file mode 100644 index 00000000..8d06f893 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-lifecycle.rst @@ -0,0 +1,3 @@ +The following command deletes a lifecycle configuration from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-lifecycle --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-policy.rst b/aws/dist/awscli/examples/s3api/delete-bucket-policy.rst new file mode 100644 index 00000000..0e104e57 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-policy.rst @@ -0,0 +1,3 @@ +The following command deletes a bucket policy from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-policy --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-replication.rst b/aws/dist/awscli/examples/s3api/delete-bucket-replication.rst new file mode 100644 index 00000000..50f9dfc3 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-replication.rst @@ -0,0 +1,3 @@ +The following command deletes a replication configuration from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-replication --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-tagging.rst b/aws/dist/awscli/examples/s3api/delete-bucket-tagging.rst new file mode 100644 index 00000000..713a6ad2 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-tagging.rst @@ -0,0 +1,3 @@ +The following command deletes a tagging configuration from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-tagging --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket-website.rst b/aws/dist/awscli/examples/s3api/delete-bucket-website.rst new file mode 100644 index 00000000..155cd1e4 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket-website.rst @@ -0,0 +1,3 @@ +The following command deletes a website configuration from a bucket named ``my-bucket``:: + + aws s3api delete-bucket-website --bucket my-bucket diff --git a/aws/dist/awscli/examples/s3api/delete-bucket.rst b/aws/dist/awscli/examples/s3api/delete-bucket.rst new file mode 100644 index 00000000..761eafb1 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-bucket.rst @@ -0,0 +1,3 @@ +The following command deletes a bucket named ``my-bucket``:: + + aws s3api delete-bucket --bucket my-bucket --region us-east-1 diff --git a/aws/dist/awscli/examples/s3api/delete-object.rst b/aws/dist/awscli/examples/s3api/delete-object.rst new file mode 100644 index 00000000..3a5df3c4 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-object.rst @@ -0,0 +1,14 @@ +The following command deletes an object named ``test.txt`` from a bucket named ``my-bucket``:: + + aws s3api delete-object --bucket my-bucket --key test.txt + +If bucket versioning is enabled, the output will contain the version ID of the delete marker:: + + { + "VersionId": "9_gKg5vG56F.TTEUdwkxGpJ3tNDlWlGq", + "DeleteMarker": true + } + +For more information about deleting objects, see `Deleting Objects`_ in the *Amazon S3 Developer Guide*. + +.. _`Deleting Objects`: http://docs.aws.amazon.com/AmazonS3/latest/dev/DeletingObjects.html diff --git a/aws/dist/awscli/examples/s3api/delete-objects.rst b/aws/dist/awscli/examples/s3api/delete-objects.rst new file mode 100644 index 00000000..2446efd5 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/delete-objects.rst @@ -0,0 +1,26 @@ +The following command deletes an object from a bucket named ``my-bucket``:: + + aws s3api delete-objects --bucket my-bucket --delete file://delete.json + +``delete.json`` is a JSON document in the current directory that specifies the object to delete:: + + { + "Objects": [ + { + "Key": "test1.txt" + } + ], + "Quiet": false + } + +Output:: + + { + "Deleted": [ + { + "DeleteMarkerVersionId": "mYAT5Mc6F7aeUL8SS7FAAqUPO1koHwzU", + "Key": "test1.txt", + "DeleteMarker": true + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-bucket-acl.rst b/aws/dist/awscli/examples/s3api/get-bucket-acl.rst new file mode 100644 index 00000000..42f40386 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-acl.rst @@ -0,0 +1,21 @@ +The following command retrieves the access control list for a bucket named ``my-bucket``:: + + aws s3api get-bucket-acl --bucket my-bucket + +Output:: + + { + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32" + }, + "Grants": [ + { + "Grantee": { + "DisplayName": "my-username", + "ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32" + }, + "Permission": "FULL_CONTROL" + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-cors.rst b/aws/dist/awscli/examples/s3api/get-bucket-cors.rst new file mode 100644 index 00000000..2bbf9f68 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-cors.rst @@ -0,0 +1,39 @@ +The following command retrieves the Cross-Origin Resource Sharing configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-cors --bucket my-bucket + +Output:: + + { + "CORSRules": [ + { + "AllowedHeaders": [ + "*" + ], + "ExposeHeaders": [ + "x-amz-server-side-encryption" + ], + "AllowedMethods": [ + "PUT", + "POST", + "DELETE" + ], + "MaxAgeSeconds": 3000, + "AllowedOrigins": [ + "http://www.example.com" + ] + }, + { + "AllowedHeaders": [ + "Authorization" + ], + "MaxAgeSeconds": 3000, + "AllowedMethods": [ + "GET" + ], + "AllowedOrigins": [ + "*" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-lifecycle-configuration.rst b/aws/dist/awscli/examples/s3api/get-bucket-lifecycle-configuration.rst new file mode 100644 index 00000000..4a10dc8b --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-lifecycle-configuration.rst @@ -0,0 +1,32 @@ +The following command retrieves the lifecycle configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-lifecycle-configuration --bucket my-bucket + +Output:: + + { + "Rules": [ + { + "ID": "Move rotated logs to Glacier", + "Prefix": "rotated/", + "Status": "Enabled", + "Transitions": [ + { + "Date": "2015-11-10T00:00:00.000Z", + "StorageClass": "GLACIER" + } + ] + }, + { + "Status": "Enabled", + "Prefix": "", + "NoncurrentVersionTransitions": [ + { + "NoncurrentDays": 0, + "StorageClass": "GLACIER" + } + ], + "ID": "Move old versions to Glacier" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-bucket-lifecycle.rst b/aws/dist/awscli/examples/s3api/get-bucket-lifecycle.rst new file mode 100644 index 00000000..fcb23fa8 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-lifecycle.rst @@ -0,0 +1,27 @@ +The following command retrieves the lifecycle configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-lifecycle --bucket my-bucket + +Output:: + + { + "Rules": [ + { + "ID": "Move to Glacier after sixty days (objects in logs/2015/)", + "Prefix": "logs/2015/", + "Status": "Enabled", + "Transition": { + "Days": 60, + "StorageClass": "GLACIER" + } + }, + { + "Expiration": { + "Date": "2016-01-01T00:00:00.000Z" + }, + "ID": "Delete 2014 logs in 2016.", + "Prefix": "logs/2014/", + "Status": "Enabled" + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-location.rst b/aws/dist/awscli/examples/s3api/get-bucket-location.rst new file mode 100644 index 00000000..092fa5e8 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-location.rst @@ -0,0 +1,9 @@ +The following command retrieves the location constraint for a bucket named ``my-bucket``, if a constraint exists:: + + aws s3api get-bucket-location --bucket my-bucket + +Output:: + + { + "LocationConstraint": "us-west-2" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-bucket-notification-configuration.rst b/aws/dist/awscli/examples/s3api/get-bucket-notification-configuration.rst new file mode 100644 index 00000000..8eca1c3f --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-notification-configuration.rst @@ -0,0 +1,17 @@ +The following command retrieves the notification configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-notification-configuration --bucket my-bucket + +Output:: + + { + "TopicConfigurations": [ + { + "Id": "YmQzMmEwM2EjZWVlI0NGItNzVtZjI1MC00ZjgyLWZDBiZWNl", + "TopicArn": "arn:aws:sns:us-west-2:123456789012:my-notification-topic", + "Events": [ + "s3:ObjectCreated:*" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-notification.rst b/aws/dist/awscli/examples/s3api/get-bucket-notification.rst new file mode 100644 index 00000000..e8a591e6 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-notification.rst @@ -0,0 +1,16 @@ +The following command retrieves the notification configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-notification --bucket my-bucket + +Output:: + + { + "TopicConfiguration": { + "Topic": "arn:aws:sns:us-west-2:123456789012:my-notification-topic", + "Id": "YmQzMmEwM2EjZWVlI0NGItNzVtZjI1MC00ZjgyLWZDBiZWNl", + "Event": "s3:ObjectCreated:*", + "Events": [ + "s3:ObjectCreated:*" + ] + } + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-policy.rst b/aws/dist/awscli/examples/s3api/get-bucket-policy.rst new file mode 100644 index 00000000..606e3297 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-policy.rst @@ -0,0 +1,24 @@ +The following command retrieves the bucket policy for a bucket named ``my-bucket``:: + + aws s3api get-bucket-policy --bucket my-bucket + +Output:: + + { + "Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"\",\"Effect\":\"Allow\",\"Principal\":\"*\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::my-bucket/*\"},{\"Sid\":\"\",\"Effect\":\"Deny\",\"Principal\":\"*\",\"Action\":\"s3:GetObject\",\"Resource\":\"arn:aws:s3:::my-bucket/secret/*\"}]}" + } + +Get and put a bucket policy +--------------------------- + +The following example shows how you can download an Amazon S3 bucket policy, +make modifications to the file, and then use ``put-bucket-policy`` to +apply the modified bucket policy. To download the bucket policy to a file, +you can run:: + + aws s3api get-bucket-policy --bucket mybucket --query Policy --output text > policy.json + +You can then modify the ``policy.json`` file as needed. Finally you can apply +this modified policy back to the S3 bucket by running:: + + aws s3api put-bucket-policy --bucket mybucket --policy file://policy.json diff --git a/aws/dist/awscli/examples/s3api/get-bucket-replication.rst b/aws/dist/awscli/examples/s3api/get-bucket-replication.rst new file mode 100644 index 00000000..c056c701 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-replication.rst @@ -0,0 +1,22 @@ +The following command retrieves the replication configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-replication --bucket my-bucket + +Output:: + + { + "ReplicationConfiguration": { + "Rules": [ + { + "Status": "Enabled", + "Prefix": "", + "Destination": { + "Bucket": "arn:aws:s3:::my-bucket-backup", + "StorageClass": "STANDARD" + }, + "ID": "ZmUwNzE4ZmQ4tMjVhOS00MTlkLOGI4NDkzZTIWJjNTUtYTA1" + } + ], + "Role": "arn:aws:iam::123456789012:role/s3-replication-role" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-bucket-tagging.rst b/aws/dist/awscli/examples/s3api/get-bucket-tagging.rst new file mode 100644 index 00000000..fbbee96e --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-tagging.rst @@ -0,0 +1,14 @@ +The following command retrieves the tagging configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-tagging --bucket my-bucket + +Output:: + + { + "TagSet": [ + { + "Value": "marketing", + "Key": "organization" + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-versioning.rst b/aws/dist/awscli/examples/s3api/get-bucket-versioning.rst new file mode 100644 index 00000000..fea8280d --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-versioning.rst @@ -0,0 +1,9 @@ +The following command retrieves the versioning configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-versioning --bucket my-bucket + +Output:: + + { + "Status": "Enabled" + } diff --git a/aws/dist/awscli/examples/s3api/get-bucket-website.rst b/aws/dist/awscli/examples/s3api/get-bucket-website.rst new file mode 100644 index 00000000..e4a3682b --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-bucket-website.rst @@ -0,0 +1,14 @@ +The following command retrieves the static website configuration for a bucket named ``my-bucket``:: + + aws s3api get-bucket-website --bucket my-bucket + +Output:: + + { + "IndexDocument": { + "Suffix": "index.html" + }, + "ErrorDocument": { + "Key": "error.html" + } + } diff --git a/aws/dist/awscli/examples/s3api/get-object-acl.rst b/aws/dist/awscli/examples/s3api/get-object-acl.rst new file mode 100644 index 00000000..b487cdd9 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-object-acl.rst @@ -0,0 +1,27 @@ +The following command retrieves the access control list for an object in a bucket named ``my-bucket``:: + + aws s3api get-object-acl --bucket my-bucket --key index.html + +Output:: + + { + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32" + }, + "Grants": [ + { + "Grantee": { + "DisplayName": "my-username", + "ID": "7009a8971cd538e11f6b6606438875e7c86c5b672f46db45460ddcd087d36c32" + }, + "Permission": "FULL_CONTROL" + }, + { + "Grantee": { + "URI": "http://acs.amazonaws.com/groups/global/AllUsers" + }, + "Permission": "READ" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-object-torrent.rst b/aws/dist/awscli/examples/s3api/get-object-torrent.rst new file mode 100644 index 00000000..dc23e558 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-object-torrent.rst @@ -0,0 +1,5 @@ +The following command creates a torrent for an object in a bucket named ``my-bucket``:: + + aws s3api get-object-torrent --bucket my-bucket --key large-video-file.mp4 large-video-file.torrent + +The torrent file is saved locally in the current folder. Note that the output filename (``large-video-file.torrent``) is specified without an option name and must be the last argument in the command. \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/get-object.rst b/aws/dist/awscli/examples/s3api/get-object.rst new file mode 100644 index 00000000..2028c743 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/get-object.rst @@ -0,0 +1,13 @@ +The following example uses the ``get-object`` command to download an object from Amazon S3:: + + aws s3api get-object --bucket text-content --key dir/my_images.tar.bz2 my_images.tar.bz2 + +Note that the outfile parameter is specified without an option name such as "--outfile". The name of the output file must be the last parameter in the command. + +The example below demonstrates the use of ``--range`` to download a specific byte range from an object. Note the byte ranges needs to be prefixed with "bytes=":: + + aws s3api get-object --bucket text-content --key dir/my_data --range bytes=8888-9999 my_data_range + +For more information about retrieving objects, see `Getting Objects`_ in the *Amazon S3 Developer Guide*. + +.. _`Getting Objects`: http://docs.aws.amazon.com/AmazonS3/latest/dev/GettingObjectsUsingAPIs.html diff --git a/aws/dist/awscli/examples/s3api/head-bucket.rst b/aws/dist/awscli/examples/s3api/head-bucket.rst new file mode 100644 index 00000000..695c90f5 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/head-bucket.rst @@ -0,0 +1,7 @@ +The following command verifies access to a bucket named ``my-bucket``:: + + aws s3api head-bucket --bucket my-bucket + +If the bucket exists and you have access to it, no output is returned. Otherwise, an error message will be shown. For example:: + + A client error (404) occurred when calling the HeadBucket operation: Not Found \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/head-object.rst b/aws/dist/awscli/examples/s3api/head-object.rst new file mode 100644 index 00000000..e432a649 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/head-object.rst @@ -0,0 +1,15 @@ +The following command retrieves metadata for an object in a bucket named ``my-bucket``:: + + aws s3api head-object --bucket my-bucket --key index.html + +Output:: + + { + "AcceptRanges": "bytes", + "ContentType": "text/html", + "LastModified": "Thu, 16 Apr 2015 18:19:14 GMT", + "ContentLength": 77, + "VersionId": "null", + "ETag": "\"30a6ec7e1a9ad79c203d05a589c8b400\"", + "Metadata": {} + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/list-buckets.rst b/aws/dist/awscli/examples/s3api/list-buckets.rst new file mode 100644 index 00000000..f767e9b9 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/list-buckets.rst @@ -0,0 +1,10 @@ +The following command uses the ``list-buckets`` command to display the names of all your Amazon S3 buckets (across all +regions):: + + aws s3api list-buckets --query "Buckets[].Name" + +The query option filters the output of ``list-buckets`` down to only the bucket names. + +For more information about buckets, see `Working with Amazon S3 Buckets`_ in the *Amazon S3 Developer Guide*. + +.. _`Working with Amazon S3 Buckets`: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html diff --git a/aws/dist/awscli/examples/s3api/list-multipart-uploads.rst b/aws/dist/awscli/examples/s3api/list-multipart-uploads.rst new file mode 100644 index 00000000..34d825f5 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/list-multipart-uploads.rst @@ -0,0 +1,27 @@ +The following command lists all of the active multipart uploads for a bucket named ``my-bucket``:: + + aws s3api list-multipart-uploads --bucket my-bucket + +Output:: + + { + "Uploads": [ + { + "Initiator": { + "DisplayName": "username", + "ID": "arn:aws:iam::0123456789012:user/username" + }, + "Initiated": "2015-06-02T18:01:30.000Z", + "UploadId": "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R", + "StorageClass": "STANDARD", + "Key": "multipart/01", + "Owner": { + "DisplayName": "aws-account-name", + "ID": "100719349fc3b6dcd7c820a124bf7aecd408092c3d7b51b38494939801fc248b" + } + } + ], + "CommonPrefixes": [] + } + +In progress multipart uploads incur storage costs in Amazon S3. Complete or abort an active multipart upload to remove its parts from your account. \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/list-object-versions.rst b/aws/dist/awscli/examples/s3api/list-object-versions.rst new file mode 100644 index 00000000..dce635a2 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/list-object-versions.rst @@ -0,0 +1,71 @@ +The following command retrieves version information for an object in a bucket named ``my-bucket``:: + + aws s3api list-object-versions --bucket my-bucket --prefix index.html + +Output:: + + { + "DeleteMarkers": [ + { + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32" + }, + "IsLatest": true, + "VersionId": "B2VsEK5saUNNHKcOAJj7hIE86RozToyq", + "Key": "index.html", + "LastModified": "2015-11-10T00:57:03.000Z" + }, + { + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32" + }, + "IsLatest": false, + "VersionId": ".FLQEZscLIcfxSq.jsFJ.szUkmng2Yw6", + "Key": "index.html", + "LastModified": "2015-11-09T23:32:20.000Z" + } + ], + "Versions": [ + { + "LastModified": "2015-11-10T00:20:11.000Z", + "VersionId": "Rb_l2T8UHDkFEwCgJjhlgPOZC0qJ.vpD", + "ETag": "\"0622528de826c0df5db1258a23b80be5\"", + "StorageClass": "STANDARD", + "Key": "index.html", + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32" + }, + "IsLatest": false, + "Size": 38 + }, + { + "LastModified": "2015-11-09T23:26:41.000Z", + "VersionId": "rasWWGpgk9E4s0LyTJgusGeRQKLVIAFf", + "ETag": "\"06225825b8028de826c0df5db1a23be5\"", + "StorageClass": "STANDARD", + "Key": "index.html", + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32" + }, + "IsLatest": false, + "Size": 38 + }, + { + "LastModified": "2015-11-09T22:50:50.000Z", + "VersionId": "null", + "ETag": "\"d1f45267a863c8392e07d24dd592f1b9\"", + "StorageClass": "STANDARD", + "Key": "index.html", + "Owner": { + "DisplayName": "my-username", + "ID": "7009a8971cd660687538875e7c86c5b672fe116bd438f46db45460ddcd036c32" + }, + "IsLatest": false, + "Size": 533823 + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/list-objects.rst b/aws/dist/awscli/examples/s3api/list-objects.rst new file mode 100644 index 00000000..b5ac88b4 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/list-objects.rst @@ -0,0 +1,10 @@ +The following example uses the ``list-objects`` command to display the names of all the objects in the specified bucket:: + + aws s3api list-objects --bucket text-content --query 'Contents[].{Key: Key, Size: Size}' + +The example uses the ``--query`` argument to filter the output of +``list-objects`` down to the key value and size for each object + +For more information about objects, see `Working with Amazon S3 Objects`_ in the *Amazon S3 Developer Guide*. + +.. _`Working with Amazon S3 Objects`: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingObjects.html diff --git a/aws/dist/awscli/examples/s3api/list-parts.rst b/aws/dist/awscli/examples/s3api/list-parts.rst new file mode 100644 index 00000000..2e574da1 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/list-parts.rst @@ -0,0 +1,37 @@ +The following command lists all of the parts that have been uploaded for a multipart upload with key ``multipart/01`` in the bucket ``my-bucket``:: + + aws s3api list-parts --bucket my-bucket --key 'multipart/01' --upload-id dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R + +Output:: + + { + "Owner": { + "DisplayName": "aws-account-name", + "ID": "100719349fc3b6dcd7c820a124bf7aecd408092c3d7b51b38494939801fc248b" + }, + "Initiator": { + "DisplayName": "username", + "ID": "arn:aws:iam::0123456789012:user/username" + }, + "Parts": [ + { + "LastModified": "2015-06-02T18:07:35.000Z", + "PartNumber": 1, + "ETag": "\"e868e0f4719e394144ef36531ee6824c\"", + "Size": 5242880 + }, + { + "LastModified": "2015-06-02T18:07:42.000Z", + "PartNumber": 2, + "ETag": "\"6bb2b12753d66fe86da4998aa33fffb0\"", + "Size": 5242880 + }, + { + "LastModified": "2015-06-02T18:07:47.000Z", + "PartNumber": 3, + "ETag": "\"d0a0112e841abec9c9ec83406f0159c8\"", + "Size": 5242880 + } + ], + "StorageClass": "STANDARD" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/put-bucket-acl.rst b/aws/dist/awscli/examples/s3api/put-bucket-acl.rst new file mode 100644 index 00000000..42418a81 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-acl.rst @@ -0,0 +1,8 @@ +This example grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read`` +permission to everyone:: + + aws s3api put-bucket-acl --bucket MyBucket --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers + +See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL +commands, such as ``put-bucket-acl``, use the same shorthand argument notation). + diff --git a/aws/dist/awscli/examples/s3api/put-bucket-cors.rst b/aws/dist/awscli/examples/s3api/put-bucket-cors.rst new file mode 100644 index 00000000..83494f3c --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-cors.rst @@ -0,0 +1,24 @@ +The following example enables ``PUT``, ``POST``, and ``DELETE`` requests from *www.example.com*, and enables ``GET`` +requests from any domain:: + + aws s3api put-bucket-cors --bucket MyBucket --cors-configuration file://cors.json + + cors.json: + { + "CORSRules": [ + { + "AllowedOrigins": ["http://www.example.com"], + "AllowedHeaders": ["*"], + "AllowedMethods": ["PUT", "POST", "DELETE"], + "MaxAgeSeconds": 3000, + "ExposeHeaders": ["x-amz-server-side-encryption"] + }, + { + "AllowedOrigins": ["*"], + "AllowedHeaders": ["Authorization"], + "AllowedMethods": ["GET"], + "MaxAgeSeconds": 3000 + } + ] + } + diff --git a/aws/dist/awscli/examples/s3api/put-bucket-lifecycle-configuration.rst b/aws/dist/awscli/examples/s3api/put-bucket-lifecycle-configuration.rst new file mode 100644 index 00000000..243ea8ea --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-lifecycle-configuration.rst @@ -0,0 +1,36 @@ +The following command applies a lifecycle configuration to a bucket named ``my-bucket``:: + + aws s3api put-bucket-lifecycle-configuration --bucket my-bucket --lifecycle-configuration file://lifecycle.json + +The file ``lifecycle.json`` is a JSON document in the current folder that specifies two rules:: + + { + "Rules": [ + { + "ID": "Move rotated logs to Glacier", + "Prefix": "rotated/", + "Status": "Enabled", + "Transitions": [ + { + "Date": "2015-11-10T00:00:00.000Z", + "StorageClass": "GLACIER" + } + ] + }, + { + "Status": "Enabled", + "Prefix": "", + "NoncurrentVersionTransitions": [ + { + "NoncurrentDays": 2, + "StorageClass": "GLACIER" + } + ], + "ID": "Move old versions to Glacier" + } + ] + } + +The first rule moves files with the prefix ``rotated`` to Glacier on the specified date. The second rule moves old object versions to Glacier when they are no longer current. For information on acceptable timestamp formats, see `Specifying Parameter Values`_ in the *AWS CLI User Guide*. + +.. _`Specifying Parameter Values`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/put-bucket-lifecycle.rst b/aws/dist/awscli/examples/s3api/put-bucket-lifecycle.rst new file mode 100644 index 00000000..c236b7d2 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-lifecycle.rst @@ -0,0 +1,47 @@ +The following command applies a lifecycle configuration to the bucket ``my-bucket``:: + + aws s3api put-bucket-lifecycle --bucket my-bucket --lifecycle-configuration file://lifecycle.json + +The file ``lifecycle.json`` is a JSON document in the current folder that specifies two rules:: + + { + "Rules": [ + { + "ID": "Move to Glacier after sixty days (objects in logs/2015/)", + "Prefix": "logs/2015/", + "Status": "Enabled", + "Transition": { + "Days": 60, + "StorageClass": "GLACIER" + } + }, + { + "Expiration": { + "Date": "2016-01-01T00:00:00.000Z" + }, + "ID": "Delete 2014 logs in 2016.", + "Prefix": "logs/2014/", + "Status": "Enabled" + } + ] + } + +The first rule moves files to Amazon Glacier after sixty days. The second rule deletes files from Amazon S3 on the specified date. For information on acceptable timestamp formats, see `Specifying Parameter Values`_ in the *AWS CLI User Guide*. + +Each rule in the above example specifies a policy (``Transition`` or ``Expiration``) and file prefix (folder name) to which it applies. You can also create a rule that applies to an entire bucket by specifying a blank prefix:: + + { + "Rules": [ + { + "ID": "Move to Glacier after sixty days (all objects in bucket)", + "Prefix": "", + "Status": "Enabled", + "Transition": { + "Days": 60, + "StorageClass": "GLACIER" + } + } + ] + } + +.. _`Specifying Parameter Values`: http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html diff --git a/aws/dist/awscli/examples/s3api/put-bucket-logging.rst b/aws/dist/awscli/examples/s3api/put-bucket-logging.rst new file mode 100644 index 00000000..0d970ce9 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-logging.rst @@ -0,0 +1,31 @@ +The example below sets the logging policy for *MyBucket*. The AWS user *bob@example.com* will have full control over +the log files, and no one else has any access. First, grant S3 permission with ``put-bucket-acl``:: + + aws s3api put-bucket-acl --bucket MyBucket --grant-write URI=http://acs.amazonaws.com/groups/s3/LogDelivery --grant-read-acp URI=http://acs.amazonaws.com/groups/s3/LogDelivery + +Then apply the logging policy:: + + aws s3api put-bucket-logging --bucket MyBucket --bucket-logging-status file://logging.json + +``logging.json`` is a JSON document in the current folder that contains the logging policy:: + + { + "LoggingEnabled": { + "TargetBucket": "MyBucket", + "TargetPrefix": "MyBucketLogs/", + "TargetGrants": [ + { + "Grantee": { + "Type": "AmazonCustomerByEmail", + "EmailAddress": "bob@example.com" + }, + "Permission": "FULL_CONTROL" + } + ] + } + } + +.. note:: the ``put-bucket-acl`` command is required to grant S3's log delivery system the necessary permissions (write + and read-acp permissions). + +For more information, see `Amazon S3 Server Access Logging `__ in the *Amazon S3 Developer Guide*. diff --git a/aws/dist/awscli/examples/s3api/put-bucket-notification-configuration.rst b/aws/dist/awscli/examples/s3api/put-bucket-notification-configuration.rst new file mode 100644 index 00000000..983cb360 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-notification-configuration.rst @@ -0,0 +1,41 @@ +The applies a notification configuration to a bucket named ``my-bucket``:: + + aws s3api put-bucket-notification-configuration --bucket my-bucket --notification-configuration file://notification.json + +The file ``notification.json`` is a JSON document in the current folder that specifies an SNS topic and an event type to monitor:: + + { + "TopicConfigurations": [ + { + "TopicArn": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic", + "Events": [ + "s3:ObjectCreated:*" + ] + } + ] + } + +The SNS topic must have an IAM policy attached to it that allows Amazon S3 to publish to it:: + + { + "Version": "2008-10-17", + "Id": "example-ID", + "Statement": [ + { + "Sid": "example-statement-ID", + "Effect": "Allow", + "Principal": { + "Service": "s3.amazonaws.com" + }, + "Action": [ + "SNS:Publish" + ], + "Resource": "arn:aws:sns:us-west-2:123456789012:my-bucket", + "Condition": { + "ArnLike": { + "aws:SourceArn": "arn:aws:s3:*:*:my-bucket" + } + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/put-bucket-notification.rst b/aws/dist/awscli/examples/s3api/put-bucket-notification.rst new file mode 100644 index 00000000..c31b512e --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-notification.rst @@ -0,0 +1,37 @@ +The applies a notification configuration to a bucket named ``my-bucket``:: + + aws s3api put-bucket-notification --bucket my-bucket --notification-configuration file://notification.json + +The file ``notification.json`` is a JSON document in the current folder that specifies an SNS topic and an event type to monitor:: + + { + "TopicConfiguration": { + "Event": "s3:ObjectCreated:*", + "Topic": "arn:aws:sns:us-west-2:123456789012:s3-notification-topic" + } + } + +The SNS topic must have an IAM policy attached to it that allows Amazon S3 to publish to it:: + + { + "Version": "2008-10-17", + "Id": "example-ID", + "Statement": [ + { + "Sid": "example-statement-ID", + "Effect": "Allow", + "Principal": { + "Service": "s3.amazonaws.com" + }, + "Action": [ + "SNS:Publish" + ], + "Resource": "arn:aws:sns:us-west-2:123456789012:my-bucket", + "Condition": { + "ArnLike": { + "aws:SourceArn": "arn:aws:s3:*:*:my-bucket" + } + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3api/put-bucket-policy.rst b/aws/dist/awscli/examples/s3api/put-bucket-policy.rst new file mode 100644 index 00000000..96b4c4c5 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-policy.rst @@ -0,0 +1,34 @@ +This example allows all users to retrieve any object in *MyBucket* except those in the *MySecretFolder*. It also +grants ``put`` and ``delete`` permission to the root user of the AWS account ``1234-5678-9012``:: + + aws s3api put-bucket-policy --bucket MyBucket --policy file://policy.json + + policy.json: + { + "Statement": [ + { + "Effect": "Allow", + "Principal": "*", + "Action": "s3:GetObject", + "Resource": "arn:aws:s3:::MyBucket/*" + }, + { + "Effect": "Deny", + "Principal": "*", + "Action": "s3:GetObject", + "Resource": "arn:aws:s3:::MyBucket/MySecretFolder/*" + }, + { + "Effect": "Allow", + "Principal": { + "AWS": "arn:aws:iam::123456789012:root" + }, + "Action": [ + "s3:DeleteObject", + "s3:PutObject" + ], + "Resource": "arn:aws:s3:::MyBucket/*" + } + ] + } + diff --git a/aws/dist/awscli/examples/s3api/put-bucket-replication.rst b/aws/dist/awscli/examples/s3api/put-bucket-replication.rst new file mode 100644 index 00000000..731320b3 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-replication.rst @@ -0,0 +1,54 @@ +**To configure replication for an S3 bucket** + +The following ``put-bucket-replication`` example applies a replication configuration to the specified S3 bucket. :: + + aws s3api put-bucket-replication \ + --bucket my-bucket \ + --replication-configuration file://replication.json + +Contents of ``replication.json``:: + + { + "Role": "arn:aws:iam::123456789012:role/s3-replication-role", + "Rules": [ + { + "Status": "Enabled", + "Priority": 1, + "DeleteMarkerReplication": { "Status": "Disabled" }, + "Filter" : { "Prefix": ""}, + "Destination": { + "Bucket": "arn:aws:s3:::my-bucket-backup" + } + } + ] + } + +The destination bucket must be in a different region and have versioning enabled. The specified role must have permission to write to the destination bucket and have a trust relationship that allows Amazon S3 to assume the role. + +Example role permission policy:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Action": "s3:*", + "Resource": "*" + } + ] + } + +Example trust relationship policy:: + + { + "Version": "2012-10-17", + "Statement": [ + { + "Effect": "Allow", + "Principal": { + "Service": "s3.amazonaws.com" + }, + "Action": "sts:AssumeRole" + } + ] + } diff --git a/aws/dist/awscli/examples/s3api/put-bucket-tagging.rst b/aws/dist/awscli/examples/s3api/put-bucket-tagging.rst new file mode 100644 index 00000000..adc4327e --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-tagging.rst @@ -0,0 +1,18 @@ +The following command applies a tagging configuration to a bucket named ``my-bucket``:: + + aws s3api put-bucket-tagging --bucket my-bucket --tagging file://tagging.json + +The file ``tagging.json`` is a JSON document in the current folder that specifies tags:: + + { + "TagSet": [ + { + "Key": "organization", + "Value": "marketing" + } + ] + } + +Or apply a tagging configuration to ``my-bucket`` directly from the command line:: + + aws s3api put-bucket-tagging --bucket my-bucket --tagging 'TagSet=[{Key=organization,Value=marketing}]' diff --git a/aws/dist/awscli/examples/s3api/put-bucket-versioning.rst b/aws/dist/awscli/examples/s3api/put-bucket-versioning.rst new file mode 100644 index 00000000..e27c166e --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-versioning.rst @@ -0,0 +1,7 @@ +The following command enables versioning on a bucket named ``my-bucket``:: + + aws s3api put-bucket-versioning --bucket my-bucket --versioning-configuration Status=Enabled + +The following command enables versioning, and uses an mfa code :: + + aws s3api put-bucket-versioning --bucket my-bucket --versioning-configuration Status=Enabled --mfa "SERIAL 123456" diff --git a/aws/dist/awscli/examples/s3api/put-bucket-website.rst b/aws/dist/awscli/examples/s3api/put-bucket-website.rst new file mode 100644 index 00000000..0d13f0e1 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-bucket-website.rst @@ -0,0 +1,14 @@ +The applies a static website configuration to a bucket named ``my-bucket``:: + + aws s3api put-bucket-website --bucket my-bucket --website-configuration file://website.json + +The file ``website.json`` is a JSON document in the current folder that specifies index and error pages for the website:: + + { + "IndexDocument": { + "Suffix": "index.html" + }, + "ErrorDocument": { + "Key": "error.html" + } + } diff --git a/aws/dist/awscli/examples/s3api/put-object-acl.rst b/aws/dist/awscli/examples/s3api/put-object-acl.rst new file mode 100644 index 00000000..7f34d0ac --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-object-acl.rst @@ -0,0 +1,7 @@ +The following command grants ``full control`` to two AWS users (*user1@example.com* and *user2@example.com*) and ``read`` +permission to everyone:: + + aws s3api put-object-acl --bucket MyBucket --key file.txt --grant-full-control emailaddress=user1@example.com,emailaddress=user2@example.com --grant-read uri=http://acs.amazonaws.com/groups/global/AllUsers + +See http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTacl.html for details on custom ACLs (the s3api ACL +commands, such as ``put-object-acl``, use the same shorthand argument notation). diff --git a/aws/dist/awscli/examples/s3api/put-object.rst b/aws/dist/awscli/examples/s3api/put-object.rst new file mode 100644 index 00000000..8b780e83 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/put-object.rst @@ -0,0 +1,13 @@ +The following example uses the ``put-object`` command to upload an object to Amazon S3:: + + aws s3api put-object --bucket text-content --key dir-1/my_images.tar.bz2 --body my_images.tar.bz2 + +The following example shows an upload of a video file (The video file is +specified using Windows file system syntax.):: + + aws s3api put-object --bucket text-content --key dir-1/big-video-file.mp4 --body e:\media\videos\f-sharp-3-data-services.mp4 + +For more information about uploading objects, see `Uploading Objects`_ in the *Amazon S3 Developer Guide*. + +.. _`Uploading Objects`: http://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html + diff --git a/aws/dist/awscli/examples/s3api/upload-part.rst b/aws/dist/awscli/examples/s3api/upload-part.rst new file mode 100644 index 00000000..e8a35eb1 --- /dev/null +++ b/aws/dist/awscli/examples/s3api/upload-part.rst @@ -0,0 +1,13 @@ +The following command uploads the first part in a multipart upload initiated with the ``create-multipart-upload`` command:: + + aws s3api upload-part --bucket my-bucket --key 'multipart/01' --part-number 1 --body part01 --upload-id "dfRtDYU0WWCCcH43C3WFbkRONycyCpTJJvxu2i5GYkZljF.Yxwh6XG7WfS2vC4to6HiV6Yjlx.cph0gtNBtJ8P3URCSbB7rjxI5iEwVDmgaXZOGgkk5nVTW16HOQ5l0R" + +The ``body`` option takes the name or path of a local file for upload (do not use the file:// prefix). The minimum part size is 5 MB. Upload ID is returned by ``create-multipart-upload`` and can also be retrieved with ``list-multipart-uploads``. Bucket and key are specified when you create the multipart upload. + +Output:: + + { + "ETag": "\"e868e0f4719e394144ef36531ee6824c\"" + } + +Save the ETag value of each part for later. They are required to complete the multipart upload. \ No newline at end of file diff --git a/aws/dist/awscli/examples/s3control/create-job.rst b/aws/dist/awscli/examples/s3control/create-job.rst new file mode 100644 index 00000000..1e69c049 --- /dev/null +++ b/aws/dist/awscli/examples/s3control/create-job.rst @@ -0,0 +1,17 @@ +**To create an Amazon S3 batch operations job** + +The following ``create-job`` example creates an Amazon S3 batch operations job to tag objects as ``confidential` in the bucket ``employee-records``. :: + + aws s3control create-job \ + --account-id 123456789012 \ + --operation '{"S3PutObjectTagging": { "TagSet": [{"Key":"confidential", "Value":"true"}] }}' \ + --report '{"Bucket":"arn:aws:s3:::employee-records-logs","Prefix":"batch-op-create-job", "Format":"Report_CSV_20180820","Enabled":true,"ReportScope":"AllTasks"}' \ + --manifest '{"Spec":{"Format":"S3BatchOperations_CSV_20180820","Fields":["Bucket","Key"]},"Location":{"ObjectArn":"arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv","ETag":"69f52a4e9f797e987155d9c8f5880897"}}' \ + --priority 42 \ + --role-arn arn:aws:iam::123456789012:role/S3BatchJobRole + +Output:: + + { + "JobId": "93735294-df46-44d5-8638-6356f335324e" + } diff --git a/aws/dist/awscli/examples/s3control/delete-public-access-block.rst b/aws/dist/awscli/examples/s3control/delete-public-access-block.rst new file mode 100644 index 00000000..c9794198 --- /dev/null +++ b/aws/dist/awscli/examples/s3control/delete-public-access-block.rst @@ -0,0 +1,8 @@ +**To delete block public access settings for an account** + +The following ``delete-public-access-block`` example deletes block public access settings for the specified account. :: + + aws s3control delete-public-access-block \ + --account-id 123456789012 + +This command produces no output. diff --git a/aws/dist/awscli/examples/s3control/describe-job.rst b/aws/dist/awscli/examples/s3control/describe-job.rst new file mode 100644 index 00000000..3fb2ddfc --- /dev/null +++ b/aws/dist/awscli/examples/s3control/describe-job.rst @@ -0,0 +1,57 @@ +**To describe an Amazon S3 batch operations job** + +The following ``describe-job`` provides configuration parameters and status for the specified batch operations job. :: + + aws s3control describe-job \ + --account-id 123456789012 \ + --job-id 93735294-df46-44d5-8638-6356f335324e + +Output:: + + { + "Job": { + "TerminationDate": "2019-10-03T21:49:53.944Z", + "JobId": "93735294-df46-44d5-8638-6356f335324e", + "FailureReasons": [], + "Manifest": { + "Spec": { + "Fields": [ + "Bucket", + "Key" + ], + "Format": "S3BatchOperations_CSV_20180820" + }, + "Location": { + "ETag": "69f52a4e9f797e987155d9c8f5880897", + "ObjectArn": "arn:aws:s3:::employee-records-logs/inv-report/7a6a9be4-072c-407e-85a2-ec3e982f773e.csv" + } + }, + "Operation": { + "S3PutObjectTagging": { + "TagSet": [ + { + "Value": "true", + "Key": "confidential" + } + ] + } + }, + "RoleArn": "arn:aws:iam::123456789012:role/S3BatchJobRole", + "ProgressSummary": { + "TotalNumberOfTasks": 8, + "NumberOfTasksFailed": 0, + "NumberOfTasksSucceeded": 8 + }, + "Priority": 42, + "Report": { + "ReportScope": "AllTasks", + "Format": "Report_CSV_20180820", + "Enabled": true, + "Prefix": "batch-op-create-job", + "Bucket": "arn:aws:s3:::employee-records-logs" + }, + "JobArn": "arn:aws:s3:us-west-2:123456789012:job/93735294-df46-44d5-8638-6356f335324e", + "CreationTime": "2019-10-03T21:48:48.048Z", + "Status": "Complete" + } + } diff --git a/aws/dist/awscli/examples/s3control/get-public-access-block.rst b/aws/dist/awscli/examples/s3control/get-public-access-block.rst new file mode 100644 index 00000000..f6507144 --- /dev/null +++ b/aws/dist/awscli/examples/s3control/get-public-access-block.rst @@ -0,0 +1,17 @@ +**To list public block access settings for an account** + +The following ``get-public-access-block`` example displays the block public access settings for the specified account. :: + + aws s3control get-public-access-block \ + --account-id 123456789012 + +Output:: + + { + "PublicAccessBlockConfiguration": { + "BlockPublicPolicy": true, + "RestrictPublicBuckets": true, + "IgnorePublicAcls": true, + "BlockPublicAcls": true + } + } diff --git a/aws/dist/awscli/examples/s3control/list-jobs.rst b/aws/dist/awscli/examples/s3control/list-jobs.rst new file mode 100644 index 00000000..b7713f98 --- /dev/null +++ b/aws/dist/awscli/examples/s3control/list-jobs.rst @@ -0,0 +1,37 @@ +**To list an accounts Amazon S3 batch operations jobs** + +The following ``list-jobs`` example lists all recent batch operations jobs for the specified account. :: + + aws s3control list-jobs \ + --account-id 123456789012 + +Output:: + + { + "Jobs": [ + { + "Operation": "S3PutObjectTagging", + "ProgressSummary": { + "NumberOfTasksFailed": 0, + "NumberOfTasksSucceeded": 8, + "TotalNumberOfTasks": 8 + }, + "CreationTime": "2019-10-03T21:48:48.048Z", + "Status": "Complete", + "JobId": "93735294-df46-44d5-8638-6356f335324e", + "Priority": 42 + }, + { + "Operation": "S3PutObjectTagging", + "ProgressSummary": { + "NumberOfTasksFailed": 0, + "NumberOfTasksSucceeded": 0, + "TotalNumberOfTasks": 0 + }, + "CreationTime": "2019-10-03T21:46:07.084Z", + "Status": "Failed", + "JobId": "3f3c7619-02d3-4779-97f6-1d98dd313108", + "Priority": 42 + }, + ] + } diff --git a/aws/dist/awscli/examples/s3control/put-public-access-block.rst b/aws/dist/awscli/examples/s3control/put-public-access-block.rst new file mode 100644 index 00000000..bc7b292f --- /dev/null +++ b/aws/dist/awscli/examples/s3control/put-public-access-block.rst @@ -0,0 +1,9 @@ +**To edit block public access settings for an account** + +The following ``put-public-access-block`` example toggles all block public access settings to ``true`` for the specified account. :: + + aws s3control put-public-access-block \ + --account-id 123456789012 \ + --public-access-block-configuration '{"BlockPublicAcls": true, "IgnorePublicAcls": true, "BlockPublicPolicy": true, "RestrictPublicBuckets": true}' + +This command produces no output. diff --git a/aws/dist/awscli/examples/s3control/update-job-priority.rst b/aws/dist/awscli/examples/s3control/update-job-priority.rst new file mode 100644 index 00000000..63b3e0ef --- /dev/null +++ b/aws/dist/awscli/examples/s3control/update-job-priority.rst @@ -0,0 +1,15 @@ +**To update the job priority of an Amazon S3 batch operations job** + +The following ``update-job-priority`` example updates the specified job to a new priority. :: + + aws s3control update-job-priority \ + --account-id 123456789012 \ + --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \ + --priority 52 + +Output:: + + { + "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386", + "Priority": 52 + } diff --git a/aws/dist/awscli/examples/s3control/update-job-status.rst b/aws/dist/awscli/examples/s3control/update-job-status.rst new file mode 100644 index 00000000..3a2722a0 --- /dev/null +++ b/aws/dist/awscli/examples/s3control/update-job-status.rst @@ -0,0 +1,42 @@ +**To update the status of an Amazon S3 batch operations job** + +The following ``update-job-status`` example cancels the specified job which is awaiting approval. :: + + aws s3control update-job-status \ + --account-id 123456789012 \ + --job-id 8d9a18fe-c303-4d39-8ccc-860d372da386 \ + --requested-job-status Cancelled + +Output:: + + { + "Status": "Cancelled", + "JobId": "8d9a18fe-c303-4d39-8ccc-860d372da386" + } + +The following ``update-job-status`` example confirms and runs the specified which is awaiting approval. :: + + aws s3control update-job-status \ + --account-id 123456789012 \ + --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \ + --requested-job-status Ready + + Output:: + + { + "Status": "Ready", + "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca" + } + +The following ``update-job-status`` example cancels the specified job which is running. :: + + aws s3control update-job-status \ + --account-id 123456789012 \ + --job-id 5782949f-3301-4fb3-be34-8d5bab54dbca \ + --requested-job-status Cancelled + + Output:: + { + "Status": "Cancelling", + "JobId": "5782949f-3301-4fb3-be34-8d5bab54dbca" + } diff --git a/aws/dist/awscli/examples/secretsmanager/cancel-rotate-secret.rst b/aws/dist/awscli/examples/secretsmanager/cancel-rotate-secret.rst new file mode 100755 index 00000000..9d3a0465 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/cancel-rotate-secret.rst @@ -0,0 +1,13 @@ +**To cancel scheduled rotation for a secret** + +The following example shows how to cancel rotation for a secret. The operation sets the ``RotationEnabled`` field to false and cancels all scheduled rotations. To resume scheduled rotations, you must re-enable rotation by calling the ``rotate-secret`` operation. :: + + aws secretsmanager cancel-rotate-secret --secret-id MyTestDatabaseSecret + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + diff --git a/aws/dist/awscli/examples/secretsmanager/create-secret.rst b/aws/dist/awscli/examples/secretsmanager/create-secret.rst new file mode 100755 index 00000000..9b844e85 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/create-secret.rst @@ -0,0 +1,15 @@ +**To create a basic secret** + +The following example shows how to create a secret. The credentials stored in the encrypted secret value are retrieved from a file on disk named ``mycreds.json``. :: + + aws secretsmanager create-secret --name MyTestDatabaseSecret \ + --description "My test database secret created with the CLI" \ + --secret-string file://mycreds.json + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/delete-resource-policy.rst b/aws/dist/awscli/examples/secretsmanager/delete-resource-policy.rst new file mode 100755 index 00000000..d93301cb --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/delete-resource-policy.rst @@ -0,0 +1,13 @@ +**To delete the resource-based policy attached to a secret** + +The following example shows how to delete the resource-based policy that is attached to a secret. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. +.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies:: + + aws secretsmanager delete-resource-policy --secret-id MyTestDatabaseSecret + +The output shows the following. :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseMasterSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/delete-secret.rst b/aws/dist/awscli/examples/secretsmanager/delete-secret.rst new file mode 100755 index 00000000..746b07a9 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/delete-secret.rst @@ -0,0 +1,14 @@ +**To delete a secret** + +The following example shows how to delete a secret. The secret stays in your account in a deprecated and inaccessible state until the recovery window ends. After the date and time in the ``DeletionDate`` response field has passed, you can no longer recover this secret with restore-secret. :: + + aws secretsmanager delete-secret --secret-id MyTestDatabaseSecret1 \ + --recovery-window-in-days 7 + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "DeletionDate": 1524085349.095 + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/describe-secret.rst b/aws/dist/awscli/examples/secretsmanager/describe-secret.rst new file mode 100755 index 00000000..dafda605 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/describe-secret.rst @@ -0,0 +1,38 @@ +**To retrieve the details of a secret** + +The following example shows how to get the details about a secret. :: + + aws secretsmanager describe-secret --secret-id MyTestDatabaseSecret + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-Ca8JGt", + "Name": "MyTestDatabaseSecret", + "Description": "My test database secret", + "LastChangedDate": 1523477145.729, + "RotationEnabled": true + "RotationLambdaARN": "arn:aws:lambda:us-west-2:123456789012:function:MyTestRotationLambda", + "RotationRules": { + "AutomaticallyAfterDays": 30 + }, + "LastRotatedDate": 1525747253.72 + "Tags": [ + { + "Key": "SecondTag", + "Value": "AnotherValue" + }, + { + "Key": "FirstTag", + "Value": "SomeValue" + } + ], + "VersionIdsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSPREVIOUS" + ], + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/get-random-password.rst b/aws/dist/awscli/examples/secretsmanager/get-random-password.rst new file mode 100755 index 00000000..3368ea57 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/get-random-password.rst @@ -0,0 +1,11 @@ +**To generate a random password** + +The following example shows how to request a randomly generated password. This example includes the optional flags to require spaces and at least one character of each included type. It specifies a length of 20 characters. :: + + aws secretsmanager get-random-password --include-space --password-length 20 --require-each-included-type + +The output shows the following: :: + + { + "RandomPassword": "N+Z43a,>vx7j O8^*<8i3" + } diff --git a/aws/dist/awscli/examples/secretsmanager/get-resource-policy.rst b/aws/dist/awscli/examples/secretsmanager/get-resource-policy.rst new file mode 100755 index 00000000..94a5e931 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/get-resource-policy.rst @@ -0,0 +1,16 @@ +**To retrieve the resource-based policy attached to a secret** + +The following example shows how to retrieve the resource-based policy that is attached to a secret. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. +.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies :: + + aws secretsmanager get-resource-policy --secret-id MyTestDatabaseSecret + +The output shows the following. It is shown here word-wrapped and with extra white-space removed for clarity. :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "ResourcePolicy": "{\n\"Version\":\"2012-10-17\",\n\"Statement\":[{\n\"Effect\":\"Allow\",\n + \"Principal\":{\n\"AWS\":\"arn:aws:iam::123456789012:root\"\n},\n\"Action\": + \"secretsmanager:GetSecretValue\",\n\"Resource\":\"*\"\n}]\n}" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/get-secret-value.rst b/aws/dist/awscli/examples/secretsmanager/get-secret-value.rst new file mode 100755 index 00000000..165ebc55 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/get-secret-value.rst @@ -0,0 +1,18 @@ +**To retrieve the encrypted secret value of a secret** + +The following example shows how to retrieve the secret string value from the version of the secret that has the ``AWSPREVIOUS`` staging label attached. If you want to retrieve the ``AWSCURRENT`` version of the secret, then you can omit the ``--version-stage` parameter because it defaults to ``AWSCURRENT``. :: + + aws secretsmanager get-secret-value --secret-id MyTestDatabaseSecret --version-stage AWSPREVIOUS + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "SecretString": "{\n \"username\":\"david\",\n \"password\":\"BnQw&XDWgaEeT9XGTT29\"\n}\n", + "VersionStages": [ + "AWSPREVIOUS" + ], + "CreatedDate": 1523477145.713 + } diff --git a/aws/dist/awscli/examples/secretsmanager/list-secret-version-ids.rst b/aws/dist/awscli/examples/secretsmanager/list-secret-version-ids.rst new file mode 100755 index 00000000..ed702e70 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/list-secret-version-ids.rst @@ -0,0 +1,33 @@ +**To list all of the secret versions associated with a secret** + +The following example shows how to retrieve a list of all of the versions of a secret, including those without any staging labels. :: + + aws secretsmanager list-secret-version-ids --secret-id MyTestDatabaseSecret \ + --include-deprecated + +The output shows the following: :: + + { + "Versions": [ + { + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSPREVIOUS" + ], + "CreatedDate": 1523477145.713 + }, + { + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE", + "VersionStages": [ + "AWSCURRENT" + ], + "CreatedDate": 1523486221.391 + }, + { + "CreatedDate": 1.51197446236E9, + "VersionId": "EXAMPLE3-90ab-cdef-fedc-ba987EXAMPLE;" + } + ], + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/list-secrets.rst b/aws/dist/awscli/examples/secretsmanager/list-secrets.rst new file mode 100755 index 00000000..5bd1980a --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/list-secrets.rst @@ -0,0 +1,34 @@ +**To list the secrets in your account** + +The following example shows how to list all of the secrets in your account. :: + + aws secretsmanager list-secrets + +The output shows the following: :: + + { + "SecretList": [ + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "Description": "My test database secret", + "LastChangedDate": 1523477145.729, + "SecretVersionsToStages": { + "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + }, + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret1-d4e5f6", + "Name": "MyTestDatabaseSecret1", + "Description": "Another secret created for a different database", + "LastChangedDate": 1523482025.685, + "SecretVersionsToStages": { + "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE": [ + "AWSCURRENT" + ] + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/put-resource-policy.rst b/aws/dist/awscli/examples/secretsmanager/put-resource-policy.rst new file mode 100755 index 00000000..477fe759 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/put-resource-policy.rst @@ -0,0 +1,14 @@ +**To add a resource-based policy to a secret** + +The following example shows how to add a resource-based policy to a secret. The policy is read from a file on disk and must contain a valid JSON policy document. For more information, see `Resource-based Policies` in the *Secrets Manager User Guide*. +.. _`Resource-based Policies`: http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_overview.html#auth-and-access_resource-policies:: + + aws secretsmanager put-resource-policy --secret-id MyTestDatabaseMasterSecret \ + --resource-policy file://mysecretpolicy.json + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } diff --git a/aws/dist/awscli/examples/secretsmanager/put-secret-value.rst b/aws/dist/awscli/examples/secretsmanager/put-secret-value.rst new file mode 100755 index 00000000..0212aa7c --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/put-secret-value.rst @@ -0,0 +1,17 @@ +**To store a secret value in a new version of a secret** + +The following example shows how to create a new version of the secret. Alternatively, you can use the ``update-secret`` command. :: + + aws secretsmanager put-secret-value --secret-id MyTestDatabaseSecret \ + --secret-string file://mycreds.json + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:128716708097:secret:MyTestDatabaseSecret-Ca8JGt", + "Name": "MyTestDatabaseSecret", + "VersionId": "dd47d3af-7095-4da5-a267-11707c060178", + "VersionStages": [ + "AWSCURRENT" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/restore-secret.rst b/aws/dist/awscli/examples/secretsmanager/restore-secret.rst new file mode 100755 index 00000000..1dad895a --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/restore-secret.rst @@ -0,0 +1,12 @@ +**To restore a previously deleted secret** + +The following example shows how to restore a secret that you previously scheduled for deletion. :: + + aws secretsmanager restore-secret --secret-id MyTestDatabaseSecret + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/rotate-secret.rst b/aws/dist/awscli/examples/secretsmanager/rotate-secret.rst new file mode 100755 index 00000000..f683281f --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/rotate-secret.rst @@ -0,0 +1,29 @@ +**To configure rotation for a secret** + +The following example configures rotation for a secret by providing the ARN of a Lambda rotation function (which must already exist) and the number of days between rotation. The first rotation happens immediately upon completion of this command. The rotation function runs asynchronously in the background. :: + + aws secretsmanager rotate-secret --secret-id MyTestDatabaseSecret \ + --rotation-lambda-arn arn:aws:lambda:us-west-2:1234566789012:function:MyTestRotationLambda \ + --rotation-rules AutomaticallyAfterDays=30 + +The output shows the following, including the ``VersionId`` of the new secret version: :: + + { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + } + +**To request an immediate rotation for a secret** + +The following example requests an immediate invocation of the secret's Lambda rotation function. It assumes that the specified secret already has rotation configured. The rotation function runs asynchronously in the background. :: + + aws secretsmanager rotate-secret --secret-id MyTestDatabaseSecret + +The output shows the following, including the ``VersionId`` of the new secret version: :: + + { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/tag-resource.rst b/aws/dist/awscli/examples/secretsmanager/tag-resource.rst new file mode 100755 index 00000000..f36a309e --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/tag-resource.rst @@ -0,0 +1,8 @@ +**To add tags to a secret** + +The following example shows how to attach two tags each with a Key and Value to a secret. :: + + aws secretsmanager tag-resource --secret-id MyTestDatabaseSecret \ + --tags '[{"Key": "FirstTag", "Value": "SomeValue"}, {"Key": "SecondTag", "Value": "AnotherValue"}]' + +There is no output from this API. To see the result, use the describe-secret operation. diff --git a/aws/dist/awscli/examples/secretsmanager/untag-resource.rst b/aws/dist/awscli/examples/secretsmanager/untag-resource.rst new file mode 100755 index 00000000..d17ad741 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/untag-resource.rst @@ -0,0 +1,8 @@ +**To remove tags from a secret** + +The following example shows how to remove two tags from a secret's metadata. For each tag, both the key and its associated value are removed. :: + + aws secretsmanager untag-resource --secret-id MyTestDatabaseSecret \ + --tag-keys '[ "FirstTag", "SecondTag"]' + +There is no output from this API. To see the result, use the describe-secret operation. diff --git a/aws/dist/awscli/examples/secretsmanager/update-secret-version-stage.rst b/aws/dist/awscli/examples/secretsmanager/update-secret-version-stage.rst new file mode 100755 index 00000000..a66bd8c6 --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/update-secret-version-stage.rst @@ -0,0 +1,45 @@ +**To add a staging label attached to a version of a secret** + +The following example shows you how to add a staging label to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: + + aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ + --version-stage STAGINGLABEL1 \ + --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + +**To delete a staging label attached to a version of a secret** + +The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: + + aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ + --version-stage STAGINGLABEL1 \ + --remove-from-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + +**To move a staging label from one version of a secret to another** + +The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the command list-secret-version-ids and viewing the VersionStages response field for the affected version. :: + + aws secretsmanager update-secret-version-stage --secret-id MyTestDatabaseSecret \ + --version-stage AWSCURRENT \ + --move-to-version-id EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE \ + --remove-from-version-id EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/secretsmanager/update-secret.rst b/aws/dist/awscli/examples/secretsmanager/update-secret.rst new file mode 100755 index 00000000..a394c3bc --- /dev/null +++ b/aws/dist/awscli/examples/secretsmanager/update-secret.rst @@ -0,0 +1,44 @@ +The following examples show how to modify individual components of the secret. Alternatively, you can combine all of the parameters into a single command to do them all in one operation. + +**To update the description of a secret** + +The following example shows how to modify the description of a secret. :: + + aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ + --description "This is a new description for the secret." + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + +**To update the KMS key associated with a secret** + +This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret. :: + + aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ + --kms-key-id arn:aws:kms:us-west-2:123456789012:key/EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE + +The output shows the following: :: + + { + "ARN": "arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret" + } + +**To create a new version of the encrypted secret value** + +The following example shows how to create a new version of the secret by updating the --secret-string field. The secret string is read from the contents of the specified file. Alternatively, you can use the put-secret-value operation. :: + + aws secretsmanager update-secret --secret-id MyTestDatabaseSecret \ + --secret-string file://mycreds.json + +The output shows the following, including the ``VersionId`` of the new secret version: :: + + { + "ARN": "aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3", + "Name": "MyTestDatabaseSecret", + "VersionId": "EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/serverlessrepo/put-application-policy.rst b/aws/dist/awscli/examples/serverlessrepo/put-application-policy.rst new file mode 100644 index 00000000..c21efe92 --- /dev/null +++ b/aws/dist/awscli/examples/serverlessrepo/put-application-policy.rst @@ -0,0 +1,50 @@ +**Example 1: To share an application publicly** + +The following ``put-application-policy`` shares an application publicly, so anyone can find and deploy your application in the AWS Serverless Application Repository. :: + + aws serverlessrepo put-application-policy \ + --application-id arn:aws:serverlessrepo:us-east-1:123456789012:applications/my-test-application \ + --statements Principals='*',Actions=Deploy + +Output:: + + { + "Statements": [ + { + "Actions": [ + "Deploy" + ], + "Principals": [ + "" + ], + "StatementId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } + ] + } + +**Example 2:** To share an application privately + +The following ``put-application-policy`` shares an application privately, so only specific AWS accounts can find and deploy your application in the AWS Serverless Application Repository. :: + + aws serverlessrepo put-application-policy \ + --application-id arn:aws:serverlessrepo:us-east-1:123456789012:applications/my-test-application \ + --statements Principals=111111111111,222222222222,Actions=Deploy + +Output:: + + { + "Statements": [ + { + "Actions": [ + "Deploy" + ], + "Principals": [ + "111111111111", + "222222222222" + ], + "StatementId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE" + } + ] + } + +For more information, see `Sharing an Application Through the Console `_ in the *AWS Serverless Application Repository Developer Guide* diff --git a/aws/dist/awscli/examples/service-quotas/get-service-quota.rst b/aws/dist/awscli/examples/service-quotas/get-service-quota.rst new file mode 100644 index 00000000..4f6f01af --- /dev/null +++ b/aws/dist/awscli/examples/service-quotas/get-service-quota.rst @@ -0,0 +1,22 @@ +**To view a specific quota for a specific service in your AWS account** + +The following **get-service-quota** command retrieves the current quota value for the ``Stack count`` quota of ``cloudformation`` service. :: + + aws service-quotas get-service-quota --service-code cloudformation --quota-code L-0485CB21 + +Output:: + + { + "Quota": { + "ServiceCode": "cloudformation", + "ServiceName": "AWS CloudFormation", + "QuotaArn": "arn:aws:servicequotas:us-east-1:123456789012:cloudformation/L-0485CB21", + "QuotaCode": "L-0485CB21", + "QuotaName": "Stack count", + "Value": 200.0, + "Unit": "None", + "Adjustable": true, + "GlobalQuota": false + } + } + diff --git a/aws/dist/awscli/examples/service-quotas/list-service-quotas.rst b/aws/dist/awscli/examples/service-quotas/list-service-quotas.rst new file mode 100644 index 00000000..63ac8c65 --- /dev/null +++ b/aws/dist/awscli/examples/service-quotas/list-service-quotas.rst @@ -0,0 +1,36 @@ +**To view all service quotas for the specified AWS service in your AWS account** + +The following **list-service-quotas** command retrieves the current quota values for all quotas in the of ``cloudformation`` service. :: + + aws service-quotas list-service-quotas --service-code cloudformation + +Output:: + + { + "Quotas": [ + { + "ServiceCode": "cloudformation", + "ServiceName": "AWS CloudFormation", + "QuotaArn": "arn:aws:servicequotas:us-east-1:123456789012:cloudformation/L-87D14FB7", + "QuotaCode": "L-87D14FB7", + "QuotaName": "Output count in CloudFormation template", + "Value": 60.0, + "Unit": "None", + "Adjustable": false, + "GlobalQuota": false + }, + { + "ServiceCode": "cloudformation", + "ServiceName": "AWS CloudFormation", + "QuotaArn": "arn:aws:servicequotas:us-east-1:123456789012:cloudformation/L-0485CB21", + "QuotaCode": "L-0485CB21", + "QuotaName": "Stack count", + "Value": 200.0, + "Unit": "None", + "Adjustable": true, + "GlobalQuota": false + } + ] + + } + diff --git a/aws/dist/awscli/examples/ses/delete-identity.rst b/aws/dist/awscli/examples/ses/delete-identity.rst new file mode 100644 index 00000000..dfa72d78 --- /dev/null +++ b/aws/dist/awscli/examples/ses/delete-identity.rst @@ -0,0 +1,9 @@ +**To delete an identity** + +The following example uses the ``delete-identity`` command to delete an identity from the list of identities verified with Amazon SES:: + + aws ses delete-identity --identity user@example.com + +For more information about verified identities, see `Verifying Email Addresses and Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Email Addresses and Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html diff --git a/aws/dist/awscli/examples/ses/get-identity-dkim-attributes.rst b/aws/dist/awscli/examples/ses/get-identity-dkim-attributes.rst new file mode 100644 index 00000000..9a8c14ec --- /dev/null +++ b/aws/dist/awscli/examples/ses/get-identity-dkim-attributes.rst @@ -0,0 +1,31 @@ +**To get the Amazon SES Easy DKIM attributes for a list of identities** + +The following example uses the ``get-identity-dkim-attributes`` command to retrieve the Amazon SES Easy DKIM attributes for a list of identities:: + + aws ses get-identity-dkim-attributes --identities "example.com" "user@example.com" + +Output:: + + { + "DkimAttributes": { + "example.com": { + "DkimTokens": [ + "EXAMPLEjcs5xoyqytjsotsijas7236gr", + "EXAMPLEjr76cvoc6mysspnioorxsn6ep", + "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k" + ], + "DkimEnabled": true, + "DkimVerificationStatus": "Success" + }, + "user@example.com": { + "DkimEnabled": false, + "DkimVerificationStatus": "NotStarted" + } + } + } + +If you call this command with an identity that you have never submitted for verification, that identity won't appear in the output. + +For more information about Easy DKIM, see `Easy DKIM in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Easy DKIM in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html diff --git a/aws/dist/awscli/examples/ses/get-identity-notification-attributes.rst b/aws/dist/awscli/examples/ses/get-identity-notification-attributes.rst new file mode 100644 index 00000000..5d06778d --- /dev/null +++ b/aws/dist/awscli/examples/ses/get-identity-notification-attributes.rst @@ -0,0 +1,29 @@ +**To get the Amazon SES notification attributes for a list of identities** + +The following example uses the ``get-identity-notification-attributes`` command to retrieve the Amazon SES notification attributes for a list of identities:: + + aws ses get-identity-notification-attributes --identities "user1@example.com" "user2@example.com" + +Output:: + + { + "NotificationAttributes": { + "user1@example.com": { + "ForwardingEnabled": false, + "ComplaintTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic", + "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic", + "DeliveryTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic" + }, + "user2@example.com": { + "ForwardingEnabled": true + } + } + } + +This command returns the status of email feedback forwarding and, if applicable, the Amazon Resource Names (ARNs) of the Amazon SNS topics that bounce, complaint, and delivery notifications are sent to. + +If you call this command with an identity that you have never submitted for verification, that identity won't appear in the output. + +For more information about notifications, see `Using Notifications With Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Using Notifications With Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html diff --git a/aws/dist/awscli/examples/ses/get-identity-verification-attributes.rst b/aws/dist/awscli/examples/ses/get-identity-verification-attributes.rst new file mode 100644 index 00000000..bd1d86eb --- /dev/null +++ b/aws/dist/awscli/examples/ses/get-identity-verification-attributes.rst @@ -0,0 +1,24 @@ +**To get the Amazon SES verification status for a list of identities** + +The following example uses the ``get-identity-verification-attributes`` command to retrieve the Amazon SES verification status for a list of identities:: + + aws ses get-identity-verification-attributes --identities "user1@example.com" "user2@example.com" + +Output:: + + { + "VerificationAttributes": { + "user1@example.com": { + "VerificationStatus": "Success" + }, + "user2@example.com": { + "VerificationStatus": "Pending" + } + } + } + +If you call this command with an identity that you have never submitted for verification, that identity won't appear in the output. + +For more information about verified identities, see `Verifying Email Addresses and Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Email Addresses and Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html diff --git a/aws/dist/awscli/examples/ses/get-send-quota.rst b/aws/dist/awscli/examples/ses/get-send-quota.rst new file mode 100644 index 00000000..99e95e7a --- /dev/null +++ b/aws/dist/awscli/examples/ses/get-send-quota.rst @@ -0,0 +1,30 @@ +**To get your Amazon SES sending limits** + +The following example uses the ``get-send-quota`` command to return your Amazon SES sending limits:: + + aws ses get-send-quota + +Output:: + + { + "Max24HourSend": 200.0, + "SentLast24Hours": 1.0, + "MaxSendRate": 1.0 + } + + +Max24HourSend is your sending quota, which is the maximum number of emails that you can send in a 24-hour period. +The sending quota reflects a rolling time period. Every time you try to send an email, Amazon SES checks how many +emails you sent in the previous 24 hours. As long as the total number of emails that you have sent is less than +your quota, your send request will be accepted and your email will be sent. + +SentLast24Hours is the number of emails that you have sent in the previous 24 hours. + +MaxSendRate is the maximum number of emails that you can send per second. + +Note that sending limits are based on recipients rather than on messages. For example, an email that has 10 recipients +counts as 10 against your sending quota. + +For more information, see `Managing Your Amazon SES Sending Limits`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Managing Your Amazon SES Sending Limits`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/manage-sending-limits.html diff --git a/aws/dist/awscli/examples/ses/get-send-statistics.rst b/aws/dist/awscli/examples/ses/get-send-statistics.rst new file mode 100644 index 00000000..f60367a1 --- /dev/null +++ b/aws/dist/awscli/examples/ses/get-send-statistics.rst @@ -0,0 +1,38 @@ +**To get your Amazon SES sending statistics** + +The following example uses the ``get-send-statistics`` command to return your Amazon SES sending statistics :: + + aws ses get-send-statistics + +Output:: + + { + "SendDataPoints": [ + { + "Complaints": 0, + "Timestamp": "2013-06-12T19:32:00Z", + "DeliveryAttempts": 2, + "Bounces": 0, + "Rejects": 0 + }, + { + "Complaints": 0, + "Timestamp": "2013-06-12T00:47:00Z", + "DeliveryAttempts": 1, + "Bounces": 0, + "Rejects": 0 + } + ] + } + + +The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list +contains statistics for a 15-minute interval. + +In this example, there are only two data points because the only emails that the user sent in the last two weeks fell +within two 15-minute intervals. + + +For more information, see `Monitoring Your Amazon SES Usage Statistics`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Monitoring Your Amazon SES Usage Statistics`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/monitor-usage-statistics.html diff --git a/aws/dist/awscli/examples/ses/list-identities.rst b/aws/dist/awscli/examples/ses/list-identities.rst new file mode 100644 index 00000000..11c5abe0 --- /dev/null +++ b/aws/dist/awscli/examples/ses/list-identities.rst @@ -0,0 +1,24 @@ +**To list all identities (email addresses and domains) for a specific AWS account** + + +The following example uses the ``list-identities`` command to list all identities that have been submitted for verification with Amazon SES:: + + aws ses list-identities + +Output:: + + { + "Identities": [ + "user@example.com", + "example.com" + ] + } + + +The list that is returned contains all identities regardless of verification status (verified, pending verification, failure, etc.). + +In this example, email addresses *and* domains are returned because we did not specify the identity-type parameter. + +For more information about verification, see `Verifying Email Addresses and Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Email Addresses and Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html diff --git a/aws/dist/awscli/examples/ses/send-email.rst b/aws/dist/awscli/examples/ses/send-email.rst new file mode 100644 index 00000000..7969a9a7 --- /dev/null +++ b/aws/dist/awscli/examples/ses/send-email.rst @@ -0,0 +1,52 @@ +**To send a formatted email using Amazon SES** + +The following example uses the ``send-email`` command to send a formatted email:: + + aws ses send-email --from sender@example.com --destination file://destination.json --message file://message.json + +Output:: + + { + "MessageId": "EXAMPLEf3a5efcd1-51adec81-d2a4-4e3f-9fe2-5d85c1b23783-000000" + } + +The destination and the message are JSON data structures saved in .json files in the current directory. These files are as follows: + +``destination.json``:: + + { + "ToAddresses": ["recipient1@example.com", "recipient2@example.com"], + "CcAddresses": ["recipient3@example.com"], + "BccAddresses": [] + } + +``message.json``:: + + { + "Subject": { + "Data": "Test email sent using the AWS CLI", + "Charset": "UTF-8" + }, + "Body": { + "Text": { + "Data": "This is the message body in text format.", + "Charset": "UTF-8" + }, + "Html": { + "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: Amazon SES Developer Guide.", + "Charset": "UTF-8" + } + } + } + +Replace the sender and recipient email addresses with the ones you want to use. Note that the sender's email address must be verified with Amazon SES. Until you are granted production access to Amazon SES, you must also verify the email address of each recipient +unless the recipient is the Amazon SES mailbox simulator. For more information on verification, see `Verifying Email Addresses and Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +The Message ID in the output indicates that the call to send-email was successful. + +If you don't receive the email, check your Junk box. + +For more information on sending formatted email, see `Sending Formatted Email Using the Amazon SES API`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Email Addresses and Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html +.. _`Sending Formatted Email Using the Amazon SES API`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-formatted.html diff --git a/aws/dist/awscli/examples/ses/send-raw-email.rst b/aws/dist/awscli/examples/ses/send-raw-email.rst new file mode 100644 index 00000000..68498f6b --- /dev/null +++ b/aws/dist/awscli/examples/ses/send-raw-email.rst @@ -0,0 +1,32 @@ +**To send a raw email using Amazon SES** + +The following example uses the ``send-raw-email`` command to send an email with a TXT attachment:: + + aws ses send-raw-email --raw-message file://message.json + +Output:: + + { + "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000" + } + +The raw message is a JSON data structure saved in a file named ``message.json`` in the current directory. It contains the following:: + + { + "Data": "From: sender@example.com\nTo: recipient@example.com\nSubject: Test email sent using the AWS CLI (contains an attachment)\nMIME-Version: 1.0\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\n\n--NextPart\nContent-Type: text/plain\n\nThis is the message body.\n\n--NextPart\nContent-Type: text/plain;\nContent-Disposition: attachment; filename=\"attachment.txt\"\n\nThis is the text in the attachment.\n\n--NextPart--" + } + +As you can see, "Data" is one long string that contains the entire raw email content in MIME format, including an attachment called attachment.txt. + +Replace sender@example.com and recipient@example.com with the addresses you want to use. Note that the sender's email address must be verified with Amazon SES. Until you are granted production access to Amazon SES, you must also verify the email address of the recipient +unless the recipient is the Amazon SES mailbox simulator. For more information on verification, see `Verifying Email Addresses and Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +The Message ID in the output indicates that the call to send-raw-email was successful. + +If you don't receive the email, check your Junk box. + +For more information on sending raw email, see `Sending Raw Email Using the Amazon SES API`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Sending Raw Email Using the Amazon SES API`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-email-raw.html +.. _`Verifying Email Addresses and Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-addresses-and-domains.html + diff --git a/aws/dist/awscli/examples/ses/set-identity-dkim-enabled.rst b/aws/dist/awscli/examples/ses/set-identity-dkim-enabled.rst new file mode 100644 index 00000000..c246c0bc --- /dev/null +++ b/aws/dist/awscli/examples/ses/set-identity-dkim-enabled.rst @@ -0,0 +1,10 @@ +**To enable or disable Easy DKIM for an Amazon SES verified identity** + +The following example uses the ``set-identity-dkim-enabled`` command to disable DKIM for a verified email address:: + + aws ses set-identity-dkim-enabled --identity user@example.com --no-dkim-enabled + +For more information about Easy DKIM, see `Easy DKIM in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Easy DKIM in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html + diff --git a/aws/dist/awscli/examples/ses/set-identity-feedback-forwarding-enabled.rst b/aws/dist/awscli/examples/ses/set-identity-feedback-forwarding-enabled.rst new file mode 100644 index 00000000..c3000fdf --- /dev/null +++ b/aws/dist/awscli/examples/ses/set-identity-feedback-forwarding-enabled.rst @@ -0,0 +1,12 @@ +**To enable or disable bounce and complaint email feedback forwarding for an Amazon SES verified identity** + +The following example uses the ``set-identity-feedback-forwarding-enabled`` command to enable a verified email address to receive bounce and complaint notifications by email:: + + aws ses set-identity-feedback-forwarding-enabled --identity user@example.com --forwarding-enabled + +You are required to receive bounce and complaint notifications via either Amazon SNS or email feedback forwarding, so you can only disable email feedback forwarding if you select an Amazon SNS topic for both bounce and complaint notifications. + +For more information about notifications, see `Using Notifications With Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Using Notifications With Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html + diff --git a/aws/dist/awscli/examples/ses/set-identity-notification-topic.rst b/aws/dist/awscli/examples/ses/set-identity-notification-topic.rst new file mode 100644 index 00000000..2e5c8bac --- /dev/null +++ b/aws/dist/awscli/examples/ses/set-identity-notification-topic.rst @@ -0,0 +1,10 @@ +**To set the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for a verified identity** + +The following example uses the ``set-identity-notification-topic`` command to specify the Amazon SNS topic to which a verified email address will receive bounce notifications:: + + aws ses set-identity-notification-topic --identity user@example.com --notification-type Bounce --sns-topic arn:aws:sns:us-east-1:EXAMPLE65304:MyTopic + +For more information about notifications, see `Using Notifications With Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Using Notifications With Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/notifications.html + diff --git a/aws/dist/awscli/examples/ses/verify-domain-dkim.rst b/aws/dist/awscli/examples/ses/verify-domain-dkim.rst new file mode 100644 index 00000000..26782d88 --- /dev/null +++ b/aws/dist/awscli/examples/ses/verify-domain-dkim.rst @@ -0,0 +1,19 @@ +**To generate a verified domain's DKIM tokens for DKIM signing with Amazon SES** + +The following example uses the ``verify-domain-dkim`` command to generate DKIM tokens for a domain that has been verified with Amazon SES:: + + aws ses verify-domain-dkim --domain example.com + +Output:: + + { + "DkimTokens": [ + "EXAMPLEq76owjnks3lnluwg65scbemvw", + "EXAMPLEi3dnsj67hstzaj673klariwx2", + "EXAMPLEwfbtcukvimehexktmdtaz6naj" + ] + } + +To set up DKIM, you must use the returned DKIM tokens to update your domain's DNS settings with CNAME records that point to DKIM public keys hosted by Amazon SES. For more information, see `Easy DKIM in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Easy DKIM in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html diff --git a/aws/dist/awscli/examples/ses/verify-domain-identity.rst b/aws/dist/awscli/examples/ses/verify-domain-identity.rst new file mode 100644 index 00000000..4a72a4d7 --- /dev/null +++ b/aws/dist/awscli/examples/ses/verify-domain-identity.rst @@ -0,0 +1,16 @@ +**To verify a domain with Amazon SES** + +The following example uses the ``verify-domain-identity`` command to verify a domain:: + + aws ses verify-domain-identity --domain example.com + +Output:: + + { + "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE" + } + + +To complete domain verification, you must add a TXT record with the returned verification token to your domain's DNS settings. For more information, see `Verifying Domains in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Domains in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domains.html diff --git a/aws/dist/awscli/examples/ses/verify-email-identity.rst b/aws/dist/awscli/examples/ses/verify-email-identity.rst new file mode 100644 index 00000000..8c1ae17a --- /dev/null +++ b/aws/dist/awscli/examples/ses/verify-email-identity.rst @@ -0,0 +1,16 @@ +**To verify an email address with Amazon SES** + +The following example uses the ``verify-email-identity`` command to verify an email address:: + + aws ses verify-email-identity --email-address user@example.com + +Before you can send an email using Amazon SES, you must verify the address or domain that you are sending the email +from to prove that you own it. If you do not have production access yet, you also need to verify any email addresses +that you send emails to except for email addresses provided by the Amazon SES mailbox simulator. + +After verify-email-identity is called, the email address will receive a verification email. The user must click on the link in +the email to complete the verification process. + +For more information, see `Verifying Email Addresses in Amazon SES`_ in the *Amazon Simple Email Service Developer Guide*. + +.. _`Verifying Email Addresses in Amazon SES`: http://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html diff --git a/aws/dist/awscli/examples/signer/cancel-signing-profile.rst b/aws/dist/awscli/examples/signer/cancel-signing-profile.rst new file mode 100644 index 00000000..000e0a9b --- /dev/null +++ b/aws/dist/awscli/examples/signer/cancel-signing-profile.rst @@ -0,0 +1,8 @@ +**To delete a signing profile** + +The following ``cancel-signing-profile`` example removes an existing signing profile from AWS Signer. :: + + aws signer cancel-signing-profile \ + --profile-name MyProfile1 + +This command produces no output. diff --git a/aws/dist/awscli/examples/signer/describe-signing-job.rst b/aws/dist/awscli/examples/signer/describe-signing-job.rst new file mode 100644 index 00000000..4493e2b4 --- /dev/null +++ b/aws/dist/awscli/examples/signer/describe-signing-job.rst @@ -0,0 +1,35 @@ +**To display details about a signing job** + +The following ``describe-signing-job`` example displays details about the specified signing job. :: + + aws signer describe-signing-job \ + --job-id 2065c468-73e2-4385-a6c9-0123456789abc + +Output:: + + { + "status": "Succeeded", + "completedAt": 1568412037, + "platformId": "AmazonFreeRTOS-Default", + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + }, + "statusReason": "Signing Succeeded", + "jobId": "2065c468-73e2-4385-a6c9-0123456789abc", + "source": { + "s3": { + "version": "PNyFaUTgsQh5ZdMCcoCe6pT1gOpgB_M4", + "bucketName": "signer-source", + "key": "MyCode.rb" + } + }, + "profileName": "MyProfile2", + "signedObject": { + "s3": { + "bucketName": "signer-destination", + "key": "signed-2065c468-73e2-4385-a6c9-0123456789abc" + } + }, + "requestedBy": "arn:aws:iam::123456789012:user/maria", + "createdAt": 1568412036 + } diff --git a/aws/dist/awscli/examples/signer/get-signing-platform.rst b/aws/dist/awscli/examples/signer/get-signing-platform.rst new file mode 100644 index 00000000..301ee8ac --- /dev/null +++ b/aws/dist/awscli/examples/signer/get-signing-platform.rst @@ -0,0 +1,37 @@ +**To display details about a signing platform** + +The following ``get-signing-platform`` example displays details about the specified signing platform. :: + + aws signer get-signing-platform \ + --platform-id AmazonFreeRTOS-TI-CC3220SF + +Output:: + + { + "category": "AWS", + "displayName": "Amazon FreeRTOS SHA1-RSA CC3220SF-Format", + "target": "SHA1-RSA-TISHA1", + "platformId": "AmazonFreeRTOS-TI-CC3220SF", + "signingConfiguration": { + "encryptionAlgorithmOptions": { + "defaultValue": "RSA", + "allowedValues": [ + "RSA" + ] + }, + "hashAlgorithmOptions": { + "defaultValue": "SHA1", + "allowedValues": [ + "SHA1" + ] + } + }, + "maxSizeInMB": 16, + "partner": "AmazonFreeRTOS", + "signingImageFormat": { + "defaultFormat": "JSONEmbedded", + "supportedFormats": [ + "JSONEmbedded" + ] + } + } diff --git a/aws/dist/awscli/examples/signer/get-signing-profile.rst b/aws/dist/awscli/examples/signer/get-signing-profile.rst new file mode 100644 index 00000000..a808614a --- /dev/null +++ b/aws/dist/awscli/examples/signer/get-signing-profile.rst @@ -0,0 +1,17 @@ +**To display details about a signing profile** + +The following ``get-signing-profile`` example displays details about the specified signing profile. :: + + aws signer get-signing-profile \ + --profile-name MyProfile3 + +Output:: + + { + "platformId": "AmazonFreeRTOS-TI-CC3220SF", + "profileName": "MyProfile3", + "status": "Active", + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + } + } diff --git a/aws/dist/awscli/examples/signer/list-signing-jobs.rst b/aws/dist/awscli/examples/signer/list-signing-jobs.rst new file mode 100644 index 00000000..f9a79817 --- /dev/null +++ b/aws/dist/awscli/examples/signer/list-signing-jobs.rst @@ -0,0 +1,48 @@ +**To list all signing jobs** + +The following ``list-signing-jobs`` example displays details about all signing jobs for the account. :: + + aws signer list-signing-jobs + +In this example, two jobs are returned, one successful, and one failed. :: + + { + "jobs": [ + { + "status": "Succeeded", + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + }, + "jobId": "2065c468-73e2-4385-a6c9-0123456789abc", + "source": { + "s3": { + "version": "PNyFaUTgsQh5ZdMCcoCe6pT1gOpgB_M4", + "bucketName": "signer-source", + "key": "MyCode.rb" + } + }, + "signedObject": { + "s3": { + "bucketName": "signer-destination", + "key": "signed-2065c468-73e2-4385-a6c9-0123456789abc" + } + }, + "createdAt": 1568412036 + }, + { + "status": "Failed", + "source": { + "s3": { + "version": "PNyFaUTgsQh5ZdMCcoCe6pT1gOpgB_M4", + "bucketName": "signer-source", + "key": "MyOtherCode.rb" + } + }, + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + }, + "createdAt": 1568402690, + "jobId": "74d9825e-22fc-4a0d-b962-0123456789abc" + } + ] + } diff --git a/aws/dist/awscli/examples/signer/list-signing-platforms.rst b/aws/dist/awscli/examples/signer/list-signing-platforms.rst new file mode 100644 index 00000000..735e5240 --- /dev/null +++ b/aws/dist/awscli/examples/signer/list-signing-platforms.rst @@ -0,0 +1,96 @@ +**To list all signing platforms** + +The following ``list-signing-platforms`` example displays details about all available signing platforms. :: + + aws signer list-signing-platforms + +Output:: + + { + "platforms": [ + { + "category": "AWS", + "displayName": "AWS IoT Device Management SHA256-ECDSA ", + "target": "SHA256-ECDSA", + "platformId": "AWSIoTDeviceManagement-SHA256-ECDSA", + "signingConfiguration": { + "encryptionAlgorithmOptions": { + "defaultValue": "ECDSA", + "allowedValues": [ + "ECDSA" + ] + }, + "hashAlgorithmOptions": { + "defaultValue": "SHA256", + "allowedValues": [ + "SHA256" + ] + } + }, + "maxSizeInMB": 2048, + "partner": "AWSIoTDeviceManagement", + "signingImageFormat": { + "defaultFormat": "JSONDetached", + "supportedFormats": [ + "JSONDetached" + ] + } + }, + { + "category": "AWS", + "displayName": "Amazon FreeRTOS SHA1-RSA CC3220SF-Format", + "target": "SHA1-RSA-TISHA1", + "platformId": "AmazonFreeRTOS-TI-CC3220SF", + "signingConfiguration": { + "encryptionAlgorithmOptions": { + "defaultValue": "RSA", + "allowedValues": [ + "RSA" + ] + }, + "hashAlgorithmOptions": { + "defaultValue": "SHA1", + "allowedValues": [ + "SHA1" + ] + } + }, + "maxSizeInMB": 16, + "partner": "AmazonFreeRTOS", + "signingImageFormat": { + "defaultFormat": "JSONEmbedded", + "supportedFormats": [ + "JSONEmbedded" + ] + } + }, + { + "category": "AWS", + "displayName": "Amazon FreeRTOS SHA256-ECDSA", + "target": "SHA256-ECDSA", + "platformId": "AmazonFreeRTOS-Default", + "signingConfiguration": { + "encryptionAlgorithmOptions": { + "defaultValue": "ECDSA", + "allowedValues": [ + "ECDSA" + ] + }, + "hashAlgorithmOptions": { + "defaultValue": "SHA256", + "allowedValues": [ + "SHA256" + ] + } + }, + "maxSizeInMB": 16, + "partner": "AmazonFreeRTOS", + "signingImageFormat": { + "defaultFormat": "JSONEmbedded", + "supportedFormats": [ + "JSONEmbedded" + ] + } + } + ] + } diff --git a/aws/dist/awscli/examples/signer/list-signing-profiles.rst b/aws/dist/awscli/examples/signer/list-signing-profiles.rst new file mode 100644 index 00000000..5acd6b1d --- /dev/null +++ b/aws/dist/awscli/examples/signer/list-signing-profiles.rst @@ -0,0 +1,28 @@ +**To list all signing profiles** + +The following ``list-signing-profiles`` example displays details about all signing profiles for the account. :: + + aws signer list-signing-profiles + +Output:: + + { + "profiles": [ + { + "platformId": "AmazonFreeRTOS-TI-CC3220SF", + "profileName": "MyProfile4", + "status": "Active", + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + } + }, + { + "platformId": "AWSIoTDeviceManagement-SHA256-ECDSA", + "profileName": "MyProfile5", + "status": "Active", + "signingMaterial": { + "certificateArn": "arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc" + } + } + ] + } diff --git a/aws/dist/awscli/examples/signer/put-signing-profile.rst b/aws/dist/awscli/examples/signer/put-signing-profile.rst new file mode 100644 index 00000000..0a30a022 --- /dev/null +++ b/aws/dist/awscli/examples/signer/put-signing-profile.rst @@ -0,0 +1,14 @@ +**To create a signing profile** + +The following ``put-signing-profile`` example creates a signing profile using the specified certificate and platform. :: + + aws signer put-signing-profile \ + --profile-name MyProfile6 \ + --signing-material certificateArn=arn:aws:acm:us-west-2:123456789012:certificate/6a55389b-306b-4e8c-a95c-0123456789abc \ + --platform AmazonFreeRTOS-TI-CC3220SF + +Output:: + + { + "arn": "arn:aws:signer:us-west-2:123456789012:/signing-profiles/MyProfile6" + } diff --git a/aws/dist/awscli/examples/signer/start-signing-job.rst b/aws/dist/awscli/examples/signer/start-signing-job.rst new file mode 100644 index 00000000..11e4e4a2 --- /dev/null +++ b/aws/dist/awscli/examples/signer/start-signing-job.rst @@ -0,0 +1,14 @@ +**To start a signing job** + +The following ``start-signing-job`` example starts a signing job on the code found at the specified source. It uses the specified profile to do the signing and places the signed code in the specified destination. :: + + aws signer start-signing-job \ + --source 's3={bucketName=signer-source,key=MyCode.rb,version=PNyFaUTgsQh5ZdMCcoCe6pT1gOpgB_M4}' \ + --destination 's3={bucketName=signer-destination,prefix=signed-}' \ + --profile-name MyProfile7 + +The output is the ID of the signing job. :: + + { + "jobId": "2065c468-73e2-4385-a6c9-0123456789abc" + } diff --git a/aws/dist/awscli/examples/snowball/get-snowball-usage.rst b/aws/dist/awscli/examples/snowball/get-snowball-usage.rst new file mode 100644 index 00000000..d19ee925 --- /dev/null +++ b/aws/dist/awscli/examples/snowball/get-snowball-usage.rst @@ -0,0 +1,14 @@ +**To get information about the Snowball service limit for your account** + +The following ``get-snowball-usage`` example displays information about the Snowball service limit for your account, and also the number of Snowballs your account has in use. :: + + aws snowball get-snowball-usage + +Output:: + + { + "SnowballLimit": 1, + "SnowballsInUse": 0 + } + +FOR more information, see `AWS Snowball Edge Limits `__ in the *AWS Snowball Developer Guide*. diff --git a/aws/dist/awscli/examples/snowball/list-jobs.rst b/aws/dist/awscli/examples/snowball/list-jobs.rst new file mode 100644 index 00000000..e4e8450e --- /dev/null +++ b/aws/dist/awscli/examples/snowball/list-jobs.rst @@ -0,0 +1,23 @@ +**To list the current Snowball jobs in your account** + +The following ``list-jobs`` example displays an array of ``JobListEntry`` objects. In this example, a single job is listed. :: + + aws snowball list-jobs + +Output:: + + { + "JobListEntries": [ + { + "CreationDate": 2016-09-27T14:50Z, + "Description": "Important Photos 2016-08-11", + "IsMaster": TRUE, + "JobId": "ABCd1e324fe-022f-488e-a98b-3b0566063db1", + "JobState": "Complete", + "JobType": "IMPORT", + "SnowballType": "EDGE" + } + ] + } + +For more information, see `Jobs for AWS Snowball Edge devices `__ in the *AWS Snowball Developer Guide*. diff --git a/aws/dist/awscli/examples/sns/confirm-subscription.rst b/aws/dist/awscli/examples/sns/confirm-subscription.rst new file mode 100644 index 00000000..db1fe90e --- /dev/null +++ b/aws/dist/awscli/examples/sns/confirm-subscription.rst @@ -0,0 +1,11 @@ +The following command confirms a subscription to an SNS topic named ``my-topic``:: + + aws sns confirm-subscription --topic-arn arn:aws:sns:us-west-2:0123456789012:my-topic --token 2336412f37fb687f5d51e6e241d7700ae02f7124d8268910b858cb4db727ceeb2474bb937929d3bdd7ce5d0cce19325d036bc858d3c217426bcafa9c501a2cace93b83f1dd3797627467553dc438a8c974119496fc3eff026eaa5d14472ded6f9a5c43aec62d83ef5f49109da7176391 + +The token is included in the confirmation message sent to the notification endpoint specified in the subscribe call. + +Output:: + + { + "SubscriptionArn": "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f" + } diff --git a/aws/dist/awscli/examples/sns/create-topic.rst b/aws/dist/awscli/examples/sns/create-topic.rst new file mode 100644 index 00000000..09a47724 --- /dev/null +++ b/aws/dist/awscli/examples/sns/create-topic.rst @@ -0,0 +1,17 @@ +The following command creates an SNS topic named ``my-topic``:: + + aws sns create-topic --name my-topic + +Output:: + + { + "ResponseMetadata": { + "RequestId": "1469e8d7-1642-564e-b85d-a19b4b341f83" + }, + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic" + } + +For more information, see `Using the AWS Command Line Interface with Amazon SQS and Amazon SNS`_ in the *AWS Command Line Interface User Guide*. + +.. _`Using the AWS Command Line Interface with Amazon SQS and Amazon SNS`: http://docs.aws.amazon.com/cli/latest/userguide/cli-sqs-queue-sns-topic.html + diff --git a/aws/dist/awscli/examples/sns/delete-topic.rst b/aws/dist/awscli/examples/sns/delete-topic.rst new file mode 100644 index 00000000..e50ab71f --- /dev/null +++ b/aws/dist/awscli/examples/sns/delete-topic.rst @@ -0,0 +1,3 @@ +The following command deletes an SNS topic named ``my-topic``:: + + aws sns delete-topic --topic-arn "arn:aws:sns:us-west-2:0123456789012:my-topic" \ No newline at end of file diff --git a/aws/dist/awscli/examples/sns/get-subscription-attributes.rst b/aws/dist/awscli/examples/sns/get-subscription-attributes.rst new file mode 100644 index 00000000..1c80bddf --- /dev/null +++ b/aws/dist/awscli/examples/sns/get-subscription-attributes.rst @@ -0,0 +1,19 @@ +The following command gets the attributes of a subscription to a topic named ``my-topic``:: + + aws sns get-subscription-attributes --subscription-arn "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f" + +The ``subscription-arn`` is available in the output of ``aws sns list-subscriptions``. + +Output:: + + { + "Attributes": { + "Endpoint": "my-email@example.com", + "Protocol": "email", + "RawMessageDelivery": "false", + "ConfirmationWasAuthenticated": "false", + "Owner": "0123456789012", + "SubscriptionArn": "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f", + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sns/get-topic-attributes.rst b/aws/dist/awscli/examples/sns/get-topic-attributes.rst new file mode 100644 index 00000000..949295e9 --- /dev/null +++ b/aws/dist/awscli/examples/sns/get-topic-attributes.rst @@ -0,0 +1,18 @@ +The following command gets the attributes of a topic named ``my-topic``:: + + aws sns get-topic-attributes --topic-arn "arn:aws:sns:us-west-2:0123456789012:my-topic" + +Output:: + + { + "Attributes": { + "SubscriptionsConfirmed": "1", + "DisplayName": "my-topic", + "SubscriptionsDeleted": "0", + "EffectiveDeliveryPolicy": "{\"http\":{\"defaultHealthyRetryPolicy\":{\"minDelayTarget\":20,\"maxDelayTarget\":20,\"numRetries\":3,\"numMaxDelayRetries\":0,\"numNoDelayRetries\":0,\"numMinDelayRetries\":0,\"backoffFunction\":\"linear\"},\"disableSubscriptionOverrides\":false}}", + "Owner": "0123456789012", + "Policy": "{\"Version\":\"2008-10-17\",\"Id\":\"__default_policy_ID\",\"Statement\":[{\"Sid\":\"__default_statement_ID\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"*\"},\"Action\":[\"SNS:Subscribe\",\"SNS:ListSubscriptionsByTopic\",\"SNS:DeleteTopic\",\"SNS:GetTopicAttributes\",\"SNS:Publish\",\"SNS:RemovePermission\",\"SNS:AddPermission\",\"SNS:Receive\",\"SNS:SetTopicAttributes\"],\"Resource\":\"arn:aws:sns:us-west-2:0123456789012:my-topic\",\"Condition\":{\"StringEquals\":{\"AWS:SourceOwner\":\"0123456789012\"}}}]}", + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "SubscriptionsPending": "0" + } + } diff --git a/aws/dist/awscli/examples/sns/list-subscriptions-by-topic.rst b/aws/dist/awscli/examples/sns/list-subscriptions-by-topic.rst new file mode 100644 index 00000000..6cbeaf1e --- /dev/null +++ b/aws/dist/awscli/examples/sns/list-subscriptions-by-topic.rst @@ -0,0 +1,17 @@ +The following command retrieves a list of SNS subscriptions:: + + aws sns list-subscriptions-by-topic --topic-arn "arn:aws:sns:us-west-2:0123456789012:my-topic" + +Output:: + + { + "Subscriptions": [ + { + "Owner": "0123456789012", + "Endpoint": "my-email@example.com", + "Protocol": "email", + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "SubscriptionArn": "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f" + } + ] + } diff --git a/aws/dist/awscli/examples/sns/list-subscriptions.rst b/aws/dist/awscli/examples/sns/list-subscriptions.rst new file mode 100644 index 00000000..4a304a44 --- /dev/null +++ b/aws/dist/awscli/examples/sns/list-subscriptions.rst @@ -0,0 +1,17 @@ +The following command retrieves a list of SNS subscriptions:: + + aws sns list-subscriptions + +Output:: + + { + "Subscriptions": [ + { + "Owner": "0123456789012", + "Endpoint": "my-email@example.com", + "Protocol": "email", + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic", + "SubscriptionArn": "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f" + } + ] + } diff --git a/aws/dist/awscli/examples/sns/list-topics.rst b/aws/dist/awscli/examples/sns/list-topics.rst new file mode 100644 index 00000000..e1ef9319 --- /dev/null +++ b/aws/dist/awscli/examples/sns/list-topics.rst @@ -0,0 +1,13 @@ +The following command retrieves a list of SNS topics:: + + aws sns list-topics + +Output:: + + { + "Topics": [ + { + "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic" + } + ] + } diff --git a/aws/dist/awscli/examples/sns/publish.rst b/aws/dist/awscli/examples/sns/publish.rst new file mode 100644 index 00000000..2ec50cab --- /dev/null +++ b/aws/dist/awscli/examples/sns/publish.rst @@ -0,0 +1,10 @@ +The following command publishes a message to an SNS topic named ``my-topic``:: + + aws sns publish --topic-arn "arn:aws:sns:us-west-2:0123456789012:my-topic" --message file://message.txt + +``message.txt`` is a text file containing the message to publish:: + + Hello World + Second Line + +Putting the message in a text file allows you to include line breaks. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sns/set-subscription-attributes.rst b/aws/dist/awscli/examples/sns/set-subscription-attributes.rst new file mode 100644 index 00000000..0e4fac40 --- /dev/null +++ b/aws/dist/awscli/examples/sns/set-subscription-attributes.rst @@ -0,0 +1,31 @@ +**To set subscription attributes** + +This example sets the RawMessageDelivery attribute to an SQS subscription. + +Command:: + + aws sns set-subscription-attributes --subscription-arn arn:aws:sns:us-east-1:012345678912:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc --attribute-name RawMessageDelivery --attribute-value true + +Output:: + + None. + +This example sets a FilterPolicy attribute to an SQS subscription. + +Command:: + + aws sns set-subscription-attributes --subscription-arn arn:aws:sns:us-east-1:012345678912:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc --attribute-name FilterPolicy --attribute-value "{ \"anyMandatoryKey\": [\"any\", \"of\", \"these\"] }" + +Output:: + + None. + +This example removes the FilterPolicy attribute from an SQS subscription. + +Command:: + + aws sns set-subscription-attributes --subscription-arn arn:aws:sns:us-east-1:012345678912:mytopic:f248de18-2cf6-578c-8592-b6f1eaa877dc --attribute-name FilterPolicy --attribute-value "{}" + +Output:: + + None. diff --git a/aws/dist/awscli/examples/sns/subscribe.rst b/aws/dist/awscli/examples/sns/subscribe.rst new file mode 100644 index 00000000..dbef8273 --- /dev/null +++ b/aws/dist/awscli/examples/sns/subscribe.rst @@ -0,0 +1,9 @@ +The following command subscribes an email address to a topic:: + + aws sns subscribe --topic-arn arn:aws:sns:us-west-2:0123456789012:my-topic --protocol email --notification-endpoint my-email@example.com + +Output:: + + { + "SubscriptionArn": "pending confirmation" + } diff --git a/aws/dist/awscli/examples/sns/unsubscribe.rst b/aws/dist/awscli/examples/sns/unsubscribe.rst new file mode 100644 index 00000000..67eb6dad --- /dev/null +++ b/aws/dist/awscli/examples/sns/unsubscribe.rst @@ -0,0 +1,3 @@ +The following command deletes a subscription:: + + aws sns unsubscribe --subscription-arn "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f" diff --git a/aws/dist/awscli/examples/sqs/add-permission.rst b/aws/dist/awscli/examples/sqs/add-permission.rst new file mode 100644 index 00000000..d9948545 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/add-permission.rst @@ -0,0 +1,11 @@ +**To add a permission to a queue** + +This example enables the specified AWS account to send messages to the specified queue. + +Command:: + + aws sqs add-permission --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --label SendMessagesFromMyQueue --aws-account-ids 12345EXAMPLE --actions SendMessage + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/change-message-visibility-batch.rst b/aws/dist/awscli/examples/sqs/change-message-visibility-batch.rst new file mode 100644 index 00000000..ff1226f6 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/change-message-visibility-batch.rst @@ -0,0 +1,36 @@ +**To change multiple messages' timeout visibilities as a batch** + +This example changes the 2 specified messages' timeout visibilities to 10 hours (10 hours * 60 minutes * 60 seconds). + +Command:: + + aws sqs change-message-visibility-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://change-message-visibility-batch.json + +Input file (change-message-visibility-batch.json):: + + [ + { + "Id": "FirstMessage", + "ReceiptHandle": "AQEBhz2q...Jf3kaw==", + "VisibilityTimeout": 36000 + }, + { + "Id": "SecondMessage", + "ReceiptHandle": "AQEBkTUH...HifSnw==", + "VisibilityTimeout": 36000 + } + ] + +Output:: + + { + "Successful": [ + { + "Id": "SecondMessage" + }, + { + "Id": "FirstMessage" + } + ] + } + diff --git a/aws/dist/awscli/examples/sqs/change-message-visibility.rst b/aws/dist/awscli/examples/sqs/change-message-visibility.rst new file mode 100644 index 00000000..65d164ea --- /dev/null +++ b/aws/dist/awscli/examples/sqs/change-message-visibility.rst @@ -0,0 +1,11 @@ +**To change a message's timeout visibility** + +This example changes the specified message's timeout visibility to 10 hours (10 hours * 60 minutes * 60 seconds). + +Command:: + + aws sqs change-message-visibility --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --receipt-handle AQEBTpyI...t6HyQg== --visibility-timeout 36000 + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/create-queue.rst b/aws/dist/awscli/examples/sqs/create-queue.rst new file mode 100644 index 00000000..c8cb09b8 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/create-queue.rst @@ -0,0 +1,21 @@ +**To create a queue** + +This example creates a queue with the specified name, sets the message retention period to 3 days (3 days * 24 hours * 60 minutes * 60 seconds), and sets the queue's dead letter queue to the specified queue with a maximum receive count of 1,000 messages. + +Command:: + + aws sqs create-queue --queue-name MyQueue --attributes file://create-queue.json + +Input file (create-queue.json):: + + { + "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":\"1000\"}", + "MessageRetentionPeriod": "259200" + } + +Output:: + + { + "QueueUrl": "https://queue.amazonaws.com/80398EXAMPLE/MyQueue" + } + diff --git a/aws/dist/awscli/examples/sqs/delete-message-batch.rst b/aws/dist/awscli/examples/sqs/delete-message-batch.rst new file mode 100644 index 00000000..5f1a4e58 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/delete-message-batch.rst @@ -0,0 +1,33 @@ +**To delete multiple messages as a batch** + +This example deletes the specified messages. + +Command:: + + aws sqs delete-message-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://delete-message-batch.json + +Input file (delete-message-batch.json):: + + [ + { + "Id": "FirstMessage", + "ReceiptHandle": "AQEB1mgl...Z4GuLw==" + }, + { + "Id": "SecondMessage", + "ReceiptHandle": "AQEBLsYM...VQubAA==" + } + ] + +Output:: + + { + "Successful": [ + { + "Id": "FirstMessage" + }, + { + "Id": "SecondMessage" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/delete-message.rst b/aws/dist/awscli/examples/sqs/delete-message.rst new file mode 100644 index 00000000..10eb6f73 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/delete-message.rst @@ -0,0 +1,11 @@ +**To delete a message** + +This example deletes the specified message. + +Command:: + + aws sqs delete-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --receipt-handle AQEBRXTo...q2doVA== + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/delete-queue.rst b/aws/dist/awscli/examples/sqs/delete-queue.rst new file mode 100644 index 00000000..d057990a --- /dev/null +++ b/aws/dist/awscli/examples/sqs/delete-queue.rst @@ -0,0 +1,11 @@ +**To delete a queue** + +This example deletes the specified queue. + +Command:: + + aws sqs delete-queue --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewerQueue + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/get-queue-attributes.rst b/aws/dist/awscli/examples/sqs/get-queue-attributes.rst new file mode 100644 index 00000000..1926fbbe --- /dev/null +++ b/aws/dist/awscli/examples/sqs/get-queue-attributes.rst @@ -0,0 +1,41 @@ +**To get a queue's attributes** + +This example gets all of the specified queue's attributes. + +Command:: + + aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names All + +Output:: + + { + "Attributes": { + "ApproximateNumberOfMessagesNotVisible": "0", + "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":1000}", + "MessageRetentionPeriod": "345600", + "ApproximateNumberOfMessagesDelayed": "0", + "MaximumMessageSize": "262144", + "CreatedTimestamp": "1442426968", + "ApproximateNumberOfMessages": "0", + "ReceiveMessageWaitTimeSeconds": "0", + "DelaySeconds": "0", + "VisibilityTimeout": "30", + "LastModifiedTimestamp": "1442426968", + "QueueArn": "arn:aws:sqs:us-east-1:80398EXAMPLE:MyNewQueue" + } + } + +This example gets only the specified queue's maximum message size and visibility timeout attributes. + +Command:: + + aws sqs get-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue --attribute-names MaximumMessageSize VisibilityTimeout + +Output:: + + { + "Attributes": { + "VisibilityTimeout": "30", + "MaximumMessageSize": "262144" + } + } diff --git a/aws/dist/awscli/examples/sqs/get-queue-url.rst b/aws/dist/awscli/examples/sqs/get-queue-url.rst new file mode 100644 index 00000000..282b16b9 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/get-queue-url.rst @@ -0,0 +1,13 @@ +**To get a queue URL** + +This example gets the specified queue's URL. + +Command:: + + aws sqs get-queue-url --queue-name MyQueue + +Output:: + + { + "QueueUrl": "https://queue.amazonaws.com/80398EXAMPLE/MyQueue" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/list-dead-letter-source-queues.rst b/aws/dist/awscli/examples/sqs/list-dead-letter-source-queues.rst new file mode 100644 index 00000000..8e0d601f --- /dev/null +++ b/aws/dist/awscli/examples/sqs/list-dead-letter-source-queues.rst @@ -0,0 +1,16 @@ +**To list dead letter source queues** + +This example lists the queues that are associated with the specified dead letter source queue. + +Command:: + + aws sqs list-dead-letter-source-queues --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue + +Output:: + + { + "queueUrls": [ + "https://queue.amazonaws.com/80398EXAMPLE/MyQueue", + "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/list-queue-tags.rst b/aws/dist/awscli/examples/sqs/list-queue-tags.rst new file mode 100644 index 00000000..d23ab7aa --- /dev/null +++ b/aws/dist/awscli/examples/sqs/list-queue-tags.rst @@ -0,0 +1,16 @@ +**To list all cost allocation tags for a queue** + +The following ``list-queue-tags`` example displays all of the cost allocation tags associated with the specified queue. :: + + aws sqs list-queue-tags \ + --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue + +Output:: + + { + "Tags": { + "Team": "Alpha" + } + } + +For more information, see `Listing Cost Allocation Tags `__ in the *Amazon Simple Queue Service Developer Guide*. diff --git a/aws/dist/awscli/examples/sqs/list-queues.rst b/aws/dist/awscli/examples/sqs/list-queues.rst new file mode 100644 index 00000000..fb19c941 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/list-queues.rst @@ -0,0 +1,35 @@ +**To list queues** + +This example lists all queues. + +Command:: + + aws sqs list-queues + +Output:: + + { + "QueueUrls": [ + "https://queue.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue", + "https://queue.amazonaws.com/80398EXAMPLE/MyQueue", + "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue", + "https://queue.amazonaws.com/80398EXAMPLE/TestQueue1", + "https://queue.amazonaws.com/80398EXAMPLE/TestQueue2" + ] + } + +This example lists only queues that start with "My". + +Command:: + + aws sqs list-queues --queue-name-prefix My + +Output:: + + { + "QueueUrls": [ + "https://queue.amazonaws.com/80398EXAMPLE/MyDeadLetterQueue", + "https://queue.amazonaws.com/80398EXAMPLE/MyQueue", + "https://queue.amazonaws.com/80398EXAMPLE/MyOtherQueue" + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/purge-queue.rst b/aws/dist/awscli/examples/sqs/purge-queue.rst new file mode 100644 index 00000000..b55fcdda --- /dev/null +++ b/aws/dist/awscli/examples/sqs/purge-queue.rst @@ -0,0 +1,11 @@ +**To purge a queue** + +This example deletes all messages in the specified queue. + +Command:: + + aws sqs purge-queue --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/receive-message.rst b/aws/dist/awscli/examples/sqs/receive-message.rst new file mode 100644 index 00000000..7492ea38 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/receive-message.rst @@ -0,0 +1,67 @@ +**To receive a message** + +This example receives up to 10 available messages, returning all available attributes. + +Command:: + + aws sqs receive-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names All --message-attribute-names All --max-number-of-messages 10 + +Output:: + + { + "Messages": [ + { + "Body": "My first message.", + "ReceiptHandle": "AQEBzbVv...fqNzFw==", + "MD5OfBody": "1000f835...a35411fa", + "MD5OfMessageAttributes": "9424c491...26bc3ae7", + "MessageId": "d6790f8d-d575-4f01-bc51-40122EXAMPLE", + "Attributes": { + "ApproximateFirstReceiveTimestamp": "1442428276921", + "SenderId": "AIDAIAZKMSNQ7TEXAMPLE", + "ApproximateReceiveCount": "5", + "SentTimestamp": "1442428276921" + }, + "MessageAttributes": { + "PostalCode": { + "DataType": "String", + "StringValue": "ABC123" + }, + "City": { + "DataType": "String", + "StringValue": "Any City" + } + } + } + ] + } + +This example receives the next available message, returning only the SenderId and SentTimestamp attributes as well as the PostalCode message attribute. + +Command:: + + aws sqs receive-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --attribute-names SenderId SentTimestamp --message-attribute-names PostalCode + +Output:: + + { + "Messages": [ + { + "Body": "My first message.", + "ReceiptHandle": "AQEB6nR4...HzlvZQ==", + "MD5OfBody": "1000f835...a35411fa", + "MD5OfMessageAttributes": "b8e89563...e088e74f", + "MessageId": "d6790f8d-d575-4f01-bc51-40122EXAMPLE", + "Attributes": { + "SenderId": "AIDAIAZKMSNQ7TEXAMPLE", + "SentTimestamp": "1442428276921" + }, + "MessageAttributes": { + "PostalCode": { + "DataType": "String", + "StringValue": "ABC123" + } + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/remove-permission.rst b/aws/dist/awscli/examples/sqs/remove-permission.rst new file mode 100644 index 00000000..4cf69bb9 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/remove-permission.rst @@ -0,0 +1,11 @@ +**To remove a permission** + +This example removes the permission with the specified label from the specified queue. + +Command:: + + aws sqs remove-permission --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --label SendMessagesFromMyQueue + +Output:: + + None. \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/send-message-batch.rst b/aws/dist/awscli/examples/sqs/send-message-batch.rst new file mode 100644 index 00000000..00719a51 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/send-message-batch.rst @@ -0,0 +1,88 @@ +**To send multiple messages as a batch** + +This example sends 2 messages with the specified message bodies, delay periods, and message attributes, to the specified queue. + +Command:: + + aws sqs send-message-batch --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --entries file://send-message-batch.json + +Input file (send-message-batch.json):: + + [ + { + "Id": "FuelReport-0001-2015-09-16T140731Z", + "MessageBody": "Fuel report for account 0001 on 2015-09-16 at 02:07:31 PM.", + "DelaySeconds": 10, + "MessageAttributes": { + "SellerName": { + "DataType": "String", + "StringValue": "Example Store" + }, + "City": { + "DataType": "String", + "StringValue": "Any City" + }, + "Region": { + "DataType": "String", + "StringValue": "WA" + }, + "PostalCode": { + "DataType": "String", + "StringValue": "99065" + }, + "PricePerGallon": { + "DataType": "Number", + "StringValue": "1.99" + } + } + }, + { + "Id": "FuelReport-0002-2015-09-16T140930Z", + "MessageBody": "Fuel report for account 0002 on 2015-09-16 at 02:09:30 PM.", + "DelaySeconds": 10, + "MessageAttributes": { + "SellerName": { + "DataType": "String", + "StringValue": "Example Fuels" + }, + "City": { + "DataType": "String", + "StringValue": "North Town" + }, + "Region": { + "DataType": "String", + "StringValue": "WA" + }, + "PostalCode": { + "DataType": "String", + "StringValue": "99123" + }, + "PricePerGallon": { + "DataType": "Number", + "StringValue": "1.87" + } + } + } + ] + +Output:: + + { + "Successful": [ + { + "MD5OfMessageBody": "203c4a38...7943237e", + "MD5OfMessageAttributes": "10809b55...baf283ef", + "Id": "FuelReport-0001-2015-09-16T140731Z", + "MessageId": "d175070c-d6b8-4101-861d-adeb3EXAMPLE" + }, + { + "MD5OfMessageBody": "2cf0159a...c1980595", + "MD5OfMessageAttributes": "55623928...ae354a25", + "Id": "FuelReport-0002-2015-09-16T140930Z", + "MessageId": "f9b7d55d-0570-413e-b9c5-a9264EXAMPLE" + } + ] + } + + + \ No newline at end of file diff --git a/aws/dist/awscli/examples/sqs/send-message.rst b/aws/dist/awscli/examples/sqs/send-message.rst new file mode 100644 index 00000000..7507496f --- /dev/null +++ b/aws/dist/awscli/examples/sqs/send-message.rst @@ -0,0 +1,34 @@ +**To send a message** + +This example sends a message with the specified message body, delay period, and message attributes, to the specified queue. + +Command:: + + aws sqs send-message --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyQueue --message-body "Information about the largest city in Any Region." --delay-seconds 10 --message-attributes file://send-message.json + +Input file (send-message.json):: + + { + "City": { + "DataType": "String", + "StringValue": "Any City" + }, + "Greeting": { + "DataType": "Binary", + "BinaryValue": "Hello, World!" + }, + "Population": { + "DataType": "Number", + "StringValue": "1250800" + } + } + +Output:: + + { + "MD5OfMessageBody": "51b0a325...39163aa0", + "MD5OfMessageAttributes": "00484c68...59e48f06", + "MessageId": "da68f62c-0c07-4bee-bf5f-7e856EXAMPLE" + } + + diff --git a/aws/dist/awscli/examples/sqs/set-queue-attributes.rst b/aws/dist/awscli/examples/sqs/set-queue-attributes.rst new file mode 100644 index 00000000..b1061566 --- /dev/null +++ b/aws/dist/awscli/examples/sqs/set-queue-attributes.rst @@ -0,0 +1,22 @@ +**To set queue attributes** + +This example sets the specified queue to a delivery delay of 10 seconds, a maximum message size of 128 KB (128 KB * 1,024 bytes), a message retention period of 3 days (3 days * 24 hours * 60 minutes * 60 seconds), a receive message wait time of 20 seconds, and a default visibility timeout of 60 seconds. This example also associates the specified dead letter queue with a maximum receive count of 1,000 messages. + +Command:: + + aws sqs set-queue-attributes --queue-url https://sqs.us-east-1.amazonaws.com/80398EXAMPLE/MyNewQueue --attributes file://set-queue-attributes.json + +Input file (set-queue-attributes.json):: + + { + "DelaySeconds": "10", + "MaximumMessageSize": "131072", + "MessageRetentionPeriod": "259200", + "ReceiveMessageWaitTimeSeconds": "20", + "RedrivePolicy": "{\"deadLetterTargetArn\":\"arn:aws:sqs:us-east-1:80398EXAMPLE:MyDeadLetterQueue\",\"maxReceiveCount\":\"1000\"}", + "VisibilityTimeout": "60" + } + +Output:: + + None. diff --git a/aws/dist/awscli/examples/sqs/tag-queue.rst b/aws/dist/awscli/examples/sqs/tag-queue.rst new file mode 100644 index 00000000..0909716f --- /dev/null +++ b/aws/dist/awscli/examples/sqs/tag-queue.rst @@ -0,0 +1,11 @@ +**To add cost allocation tags to a queue** + +The following ``tag-queue`` example adds a cost allocation tag to the specified Amazon SQS queue. :: + + aws sqs tag-queue \ + --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue \ + --tags Priority=Highest + +This command produces no output. + +For more information, see `Adding Cost Allocation Tags `__ in the *Amazon Simple Queue Service Developer Guide*. diff --git a/aws/dist/awscli/examples/sqs/untag-queue.rst b/aws/dist/awscli/examples/sqs/untag-queue.rst new file mode 100644 index 00000000..0f4745dd --- /dev/null +++ b/aws/dist/awscli/examples/sqs/untag-queue.rst @@ -0,0 +1,11 @@ +**To remove cost allocation tags from a queue** + +The following ``untag-queue`` example removes a cost allocation tag from the specified Amazon SQS queue. :: + + aws sqs tag-queue \ + --queue-url https://sqs.us-west-2.amazonaws.com/123456789012/MyQueue \ + --tag-keys "Priority" + +This command produces no output. + +For more information, see `Adding Cost Allocation Tags `__ in the *Amazon Simple Queue Service Developer Guide*. diff --git a/aws/dist/awscli/examples/ssm/add-tags-to-resource.rst b/aws/dist/awscli/examples/ssm/add-tags-to-resource.rst new file mode 100755 index 00000000..88bf9e6a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/add-tags-to-resource.rst @@ -0,0 +1,27 @@ +**Example 1: To add tags to a maintenance window** + +The following ``add-tags-to-resource`` example adds a tag to a maintenance window. + +Command:: + + aws ssm add-tags-to-resource \ + --resource-type "MaintenanceWindow" \ + --resource-id "mw-03eb9db42890fb82d" \ + --tags "Key=Stack,Value=Production" + +This command produces no output. + +**Example 2: To add tags to a parameter** + +The following ``add-tags-to-resource`` example adds two tags to a parameter. + +Command:: + + aws ssm add-tags-to-resource \ + --resource-type "Parameter" \ + --resource-id "My-Parameter" \ + --tags '[{"Key":"Region","Value":"East"},{"Key":"Environment", "Value":"Production"}]' + +This command produces no output. + +For more information, see `Tagging Systems Manager Parameters `__ in the *AWS Systems Manager User Guide*. diff --git a/aws/dist/awscli/examples/ssm/cancel-command.rst b/aws/dist/awscli/examples/ssm/cancel-command.rst new file mode 100755 index 00000000..fe7bd62d --- /dev/null +++ b/aws/dist/awscli/examples/ssm/cancel-command.rst @@ -0,0 +1,7 @@ +**To attempt to cancel a command** + +This example attempts to cancel a command. There is no output if the operation succeeds. + +Command:: + + aws ssm cancel-command --command-id "662add3d-5831-4a10-b64a-f2ff3a577858" diff --git a/aws/dist/awscli/examples/ssm/cancel-maintenance-window-execution.rst b/aws/dist/awscli/examples/ssm/cancel-maintenance-window-execution.rst new file mode 100644 index 00000000..7c1df29c --- /dev/null +++ b/aws/dist/awscli/examples/ssm/cancel-maintenance-window-execution.rst @@ -0,0 +1,13 @@ +**To cancel a Maintenance Window execution** + +This example stops a Maintenance Window execution that is already in progress. + +Command:: + + aws ssm cancel-maintenance-window-execution --window-execution-id j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE + +Output:: + + { + "WindowExecutionId": "j2l8d5b5c-mw66-tk4d-r3g9-1d4d1EXAMPLE" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/create-activation.rst b/aws/dist/awscli/examples/ssm/create-activation.rst new file mode 100755 index 00000000..ab1fde8a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-activation.rst @@ -0,0 +1,14 @@ +**To create an activation** + +This example creates a managed instance. + +Command:: + + aws ssm create-activation --default-instance-name "MyWebServers" --iam-role "AutomationRole" --registration-limit 10 + +Output:: + + { + "ActivationCode": "Zqr175DJ+sPQRHsmbzzf", + "ActivationId": "5b9e0074-65d3-4587-8620-3e0b0938db9e" + } diff --git a/aws/dist/awscli/examples/ssm/create-association-batch.rst b/aws/dist/awscli/examples/ssm/create-association-batch.rst new file mode 100644 index 00000000..792a377f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-association-batch.rst @@ -0,0 +1,67 @@ +**To create multiple associations** + +This example associates a configuration document with multiple instances. The output returns a list of successful and failed operations, if applicable. + +Command:: + + aws ssm create-association-batch --entries "Name=AWS-UpdateSSMAgent,InstanceId=i-1234567890abcdef0" "Name=AWS-UpdateSSMAgent,InstanceId=i-9876543210abcdef0" + +Output:: + + { + "Successful": [ + { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-1234567890abcdef0", + "AssociationVersion": "1", + "Date": 1550504725.007, + "LastUpdateAssociationDate": 1550504725.007, + "Status": { + "Date": 1550504725.007, + "Name": "Associated", + "Message": "Associated with AWS-UpdateSSMAgent" + }, + "Overview": { + "Status": "Pending", + "DetailedStatus": "Creating" + }, + "DocumentVersion": "$DEFAULT", + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-1234567890abcdef0" + ] + } + ] + }, + { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-9876543210abcdef0", + "AssociationVersion": "1", + "Date": 1550504725.057, + "LastUpdateAssociationDate": 1550504725.057, + "Status": { + "Date": 1550504725.057, + "Name": "Associated", + "Message": "Associated with AWS-UpdateSSMAgent" + }, + "Overview": { + "Status": "Pending", + "DetailedStatus": "Creating" + }, + "DocumentVersion": "$DEFAULT", + "AssociationId": "9c9f7f20-5154-4fed-a83e-0123456789ab", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-9876543210abcdef0" + ] + } + ] + } + ], + "Failed": [] + } diff --git a/aws/dist/awscli/examples/ssm/create-association.rst b/aws/dist/awscli/examples/ssm/create-association.rst new file mode 100644 index 00000000..4c4ee5ce --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-association.rst @@ -0,0 +1,46 @@ +**To associate a document using instance IDs** + +This example associates a configuration document with an instance, using instance IDs. + +Command:: + + aws ssm create-association --instance-id "i-0cb2b964d3e14fd9f" --name "AWS-UpdateSSMAgent" + +Output:: + + { + "AssociationDescription": { + "Status": { + "Date": 1487875500.33, + "Message": "Associated with AWS-UpdateSSMAgent", + "Name": "Associated" + }, + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-0cb2b964d3e14fd9f", + "Overview": { + "Status": "Pending", + "DetailedStatus": "Creating" + }, + "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189", + "DocumentVersion": "$DEFAULT", + "LastUpdateAssociationDate": 1487875500.33, + "Date": 1487875500.33, + "Targets": [ + { + "Values": [ + "i-0cb2b964d3e14fd9f" + ], + "Key": "InstanceIds" + } + ] + } + } + +**To associate a document using targets** + +This example associates a configuration document with an instance, using targets. + +Command:: + + aws ssm create-association --name "AWS-UpdateSSMAgent" --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f" + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/create-document.rst b/aws/dist/awscli/examples/ssm/create-document.rst new file mode 100644 index 00000000..eaf52f19 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-document.rst @@ -0,0 +1,46 @@ +**To create a document** + +This example creates a document in your account using the JSON format. Note that ``file://`` must be referenced followed by the path of the content file. For more information about writing a Systems Manager document, see `Creating Systems Manager Documents`_ in the *AWS Systems Manager User Guide*. + +.. _`Creating Systems Manager Documents`: https://docs.aws.amazon.com/systems-manager/latest/userguide/create-ssm-doc.html + +Command:: + + aws ssm create-document --content "file://RunShellScript.json" --name "RunShellScript" --document-type "Command" + +Output:: + + { + "DocumentDescription": { + "Status": "Creating", + "Hash": "95cf32aa8c4c4e6f0eb81c4d0cc9a81aa5d209c2c67c703bdea7a233b5596eb + "Name": "RunShellScript", + "Parameters": [ + { + "Type": "StringList", + "Name": "commands", + "Description": "(Required) Specify a shell script or a command to run." + } + ], + "DocumentType": "Command", + "PlatformTypes": [ + "Linux" + ], + "DocumentVersion": "1", + "HashType": "Sha256", + "CreatedDate": 1487871523.324, + "Owner": "809632081692", + "SchemaVersion": "2.0", + "DefaultVersion": "1", + "LatestVersion": "1", + "Description": "Run a script" + } + } + +**To create a document using the YAML document format** + +This example creates a document in your account using the YAML format which targets the EC2 instance type. Note that ``file://`` must be referenced followed by the path of the content file. + +Command:: + + aws ssm create-document --content file://RunShellScript.yaml --name "RunShellScript" --document-type "Command" --document-format YAML --target-type "/AWS::EC2::Instance" \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/create-maintenance-window.rst b/aws/dist/awscli/examples/ssm/create-maintenance-window.rst new file mode 100755 index 00000000..0154ca13 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-maintenance-window.rst @@ -0,0 +1,18 @@ +**To create a maintenance window that runs only once** + +The following ``create-maintenance-window`` creates a new maintenance window that only runs one time at the specified date and time. :: + + aws ssm create-maintenance-window \ + --name test \ + --schedule "at(2019-05-14T15:55:00)" \ + --duration 5 \ + --cutoff 2 \ + --allow-unassociated-targets + +Output:: + + { + "WindowId": "mw-01234567890abcdef" + } + +For more information, see `Maintenance Windows `_ in the *AWS Systems Manager User Guide*. diff --git a/aws/dist/awscli/examples/ssm/create-patch-baseline.rst b/aws/dist/awscli/examples/ssm/create-patch-baseline.rst new file mode 100755 index 00000000..8640a7e6 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-patch-baseline.rst @@ -0,0 +1,13 @@ +**To create a patch baseline** + +This example creates a patch baseline that approves patches for a production environment seven days after they are released by Microsoft. + +Command:: + + aws ssm create-patch-baseline --name "Production-Baseline" --approval-rules "PatchRules=[{PatchFilterGroup={PatchFilters=[{Key=MSRC_SEVERITY,Values=[Critical,Important,Moderate]},{Key=CLASSIFICATION,Values=[SecurityUpdates,Updates,UpdateRollups,CriticalUpdates]}]},ApproveAfterDays=7}]" --description "Baseline containing all updates approved for production systems" + +Output:: + + { + "BaselineId": "pb-045f10b4f382baeda" + } diff --git a/aws/dist/awscli/examples/ssm/create-resource-data-sync.rst b/aws/dist/awscli/examples/ssm/create-resource-data-sync.rst new file mode 100644 index 00000000..686bd9c3 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/create-resource-data-sync.rst @@ -0,0 +1,7 @@ +**To create a resource data sync** + +This example creates a resource data sync. There is no output if the command succeeds. + +Command:: + + aws ssm create-resource-data-sync --sync-name "ssm-resource-data-sync" --s3-destination "BucketName=ssm-bucket,Prefix=inventory,SyncFormat=JsonSerDe,Region=us-east-1" diff --git a/aws/dist/awscli/examples/ssm/delete-activation.rst b/aws/dist/awscli/examples/ssm/delete-activation.rst new file mode 100755 index 00000000..0587b199 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-activation.rst @@ -0,0 +1,7 @@ +**To delete an activation** + +This example deletes an activation. There is no output if the command succeeds. + +Command:: + + aws ssm delete-activation --activation-id "bcf6faa8-83fd-419e-9534-96ad14131eb7" diff --git a/aws/dist/awscli/examples/ssm/delete-association.rst b/aws/dist/awscli/examples/ssm/delete-association.rst new file mode 100644 index 00000000..04796653 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-association.rst @@ -0,0 +1,15 @@ +**To delete an association** + +This example deletes the association between an instance and a document. There is no output if the command succeeds. + +Command:: + + aws ssm delete-association --instance-id "i-1234567890abcdef0" --name "AWS-UpdateSSMAgent" + +**To delete an association using the association ID** + +This example deletes the association for the specified association ID. There is no output if the command succeeds. + +Command:: + + aws ssm delete-association --association-id "8dfe3659-4309-493a-8755-0123456789ab" diff --git a/aws/dist/awscli/examples/ssm/delete-document.rst b/aws/dist/awscli/examples/ssm/delete-document.rst new file mode 100644 index 00000000..136c1629 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-document.rst @@ -0,0 +1,7 @@ +**To delete a document** + +This example deletes a document. There is no output if the command succeeds. + +Command:: + + aws ssm delete-document --name "Config_2" diff --git a/aws/dist/awscli/examples/ssm/delete-inventory.rst b/aws/dist/awscli/examples/ssm/delete-inventory.rst new file mode 100644 index 00000000..6d81e8e4 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-inventory.rst @@ -0,0 +1,45 @@ +**To delete a custom inventory type** + +This example deletes a custom inventory schema. + +Command:: + + aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DeleteSchema" + +Output:: + + { + "DeletionId": "d72ac9e8-1f60-4d40-b1c6-bf8c78c68c4d", + "TypeName": "Custom:RackInfo", + "DeletionSummary": { + "TotalCount": 1, + "RemainingCount": 1, + "SummaryItems": [ + { + "Version": "1.0", + "Count": 1, + "RemainingCount": 1 + } + ] + } + } + +**To disable a custom inventory type** + +This example disables a custom inventory schema. + +Command:: + + aws ssm delete-inventory --type-name "Custom:RackInfo" --schema-delete-option "DisableSchema" + +Output:: + + { + "DeletionId": "6961492a-8163-44ec-aa1e-923364dd0850", + "TypeName": "Custom:RackInformation", + "DeletionSummary": { + "TotalCount": 0, + "RemainingCount": 0, + "SummaryItems": [] + } + } diff --git a/aws/dist/awscli/examples/ssm/delete-maintenance-window.rst b/aws/dist/awscli/examples/ssm/delete-maintenance-window.rst new file mode 100755 index 00000000..620066e5 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-maintenance-window.rst @@ -0,0 +1,13 @@ +**To delete a Maintenance Window** + +This example removes a Maintenance Window. + +Command:: + + aws ssm delete-maintenance-window --window-id "mw-1a2b3c4d5e6f7g8h9" + +Output:: + + { + "WindowId":"mw-1a2b3c4d5e6f7g8h9" + } diff --git a/aws/dist/awscli/examples/ssm/delete-parameter.rst b/aws/dist/awscli/examples/ssm/delete-parameter.rst new file mode 100755 index 00000000..0c64bb54 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-parameter.rst @@ -0,0 +1,7 @@ +**To delete a parameter** + +This example deletes a parameter. There is no output if the command succeeds. + +Command:: + + aws ssm delete-parameter --name "helloWorld" diff --git a/aws/dist/awscli/examples/ssm/delete-parameters.rst b/aws/dist/awscli/examples/ssm/delete-parameters.rst new file mode 100644 index 00000000..42878dcd --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-parameters.rst @@ -0,0 +1,17 @@ +**To delete a list of parameters** + +This example deletes a list of parameters. + +Command:: + + aws ssm delete-parameters --names "HelloWorld" "GoodbyeWorld" + +Output:: + + { + "DeletedParameters": [ + "HelloWorld", + "GoodbyeWorld" + ], + "InvalidParameters": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/delete-patch-baseline.rst b/aws/dist/awscli/examples/ssm/delete-patch-baseline.rst new file mode 100755 index 00000000..d3443366 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-patch-baseline.rst @@ -0,0 +1,13 @@ +**To delete a patch baseline** + +This example deletes a patch baseline. + +Command:: + + aws ssm delete-patch-baseline --baseline-id "pb-045f10b4f382baeda" + +Output:: + + { + "BaselineId": "pb-045f10b4f382baeda" + } diff --git a/aws/dist/awscli/examples/ssm/delete-resource-data-sync.rst b/aws/dist/awscli/examples/ssm/delete-resource-data-sync.rst new file mode 100644 index 00000000..3512615e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/delete-resource-data-sync.rst @@ -0,0 +1,7 @@ +**To delete a resource data sync** + +This example deletes a resource data sync. There is no output if the command succeeds. + +Command:: + + aws ssm delete-resource-data-sync --sync-name "ssm-resource-data-sync" diff --git a/aws/dist/awscli/examples/ssm/deregister-managed-instance.rst b/aws/dist/awscli/examples/ssm/deregister-managed-instance.rst new file mode 100755 index 00000000..2f483367 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/deregister-managed-instance.rst @@ -0,0 +1,7 @@ +**To deregister a managed instance** + +This example deregisters a managed instance. There is no output if the command succeeds. + +Command:: + + aws ssm deregister-managed-instance --instance-id "mi-08ab247cdf1046573" diff --git a/aws/dist/awscli/examples/ssm/deregister-patch-baseline-for-patch-group.rst b/aws/dist/awscli/examples/ssm/deregister-patch-baseline-for-patch-group.rst new file mode 100755 index 00000000..700fb00e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/deregister-patch-baseline-for-patch-group.rst @@ -0,0 +1,14 @@ +**To deregister a patch group from a patch baseline** + +This example deregisters a patch group from a patch baseline. + +Command:: + + aws ssm deregister-patch-baseline-for-patch-group --patch-group "Production" --baseline-id "arn:aws:ssm:us-west-1:812345678901:patchbaseline/pb-0ca44a362f8afc725" + +Output:: + + { + "PatchGroup":"Production", + "BaselineId":"arn:aws:ssm:us-west-1:812345678901:patchbaseline/pb-0ca44a362f8afc725" + } diff --git a/aws/dist/awscli/examples/ssm/deregister-target-from-maintenance-window.rst b/aws/dist/awscli/examples/ssm/deregister-target-from-maintenance-window.rst new file mode 100755 index 00000000..43c3f5e8 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/deregister-target-from-maintenance-window.rst @@ -0,0 +1,14 @@ +**To remove a target from a Maintenance Window** + +This example removes a target from a Maintenance Window. + +Command:: + + aws ssm deregister-target-from-maintenance-window --window-id "mw-ab12cd34ef56gh78" --window-target-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" + +Output:: + + { + "WindowId":"mw-ab12cd34ef56gh78", + "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" + } diff --git a/aws/dist/awscli/examples/ssm/deregister-task-from-maintenance-window.rst b/aws/dist/awscli/examples/ssm/deregister-task-from-maintenance-window.rst new file mode 100755 index 00000000..91255a76 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/deregister-task-from-maintenance-window.rst @@ -0,0 +1,14 @@ +**To remove a task from a Maintenance Window** + +This example removes a task from a Maintenance Window. + +Command:: + + aws ssm deregister-task-from-maintenance-window --window-id "mw-ab12cd34ef56gh78" --window-task-id "1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c" + +Output:: + + { + "WindowTaskId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d5e6c", + "WindowId":"mw-ab12cd34ef56gh78" + } diff --git a/aws/dist/awscli/examples/ssm/describe-activations.rst b/aws/dist/awscli/examples/ssm/describe-activations.rst new file mode 100755 index 00000000..380ad03f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-activations.rst @@ -0,0 +1,25 @@ +**To describe an activation** + +This example provides details about the activations on your account. + +Command:: + + aws ssm describe-activations + +Output:: + + { + "ActivationList": [ + { + "ActivationId": "bcf6faa8-83fd-419e-9534-96ad14131eb7", + "Description": "test", + "DefaultInstanceName": "MyWebServers", + "IamRole": "AutomationRole", + "RegistrationLimit": 10, + "RegistrationsCount": 0 + "ExpirationDate": 1550176478.734, + "Expired": false, + "CreatedDate": 1550090078.734 + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-association-execution-targets.rst b/aws/dist/awscli/examples/ssm/describe-association-execution-targets.rst new file mode 100644 index 00000000..a8244081 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-association-execution-targets.rst @@ -0,0 +1,28 @@ +**To get details of an association execution** + +This example describes the specified association execution. + +Command:: + + aws ssm describe-association-execution-targets --association-id "8dfe3659-4309-493a-8755-0123456789ab" --execution-id "7abb6378-a4a5-4f10-8312-0123456789ab" + +Output:: + + { + "AssociationExecutionTargets": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", + "ResourceId": "i-1234567890abcdef0", + "ResourceType": "ManagedInstance", + "Status": "Success", + "DetailedStatus": "Success", + "LastExecutionDate": 1550505538.497, + "OutputSource": { + "OutputSourceId": "97fff367-fc5a-4299-aed8-0123456789ab", + "OutputSourceType": "RunCommand" + } + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-association-executions.rst b/aws/dist/awscli/examples/ssm/describe-association-executions.rst new file mode 100644 index 00000000..7acb7939 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-association-executions.rst @@ -0,0 +1,57 @@ +**To get details of all executions for an association** + +This example describes all executions of the specified association. + +Command:: + + aws ssm describe-association-executions --association-id "8dfe3659-4309-493a-8755-0123456789ab" + +Output:: + + { + "AssociationExecutions": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", + "Status": "Success", + "DetailedStatus": "Success", + "CreatedTime": 1550505827.119, + "ResourceCountByStatus": "{Success=1}" + }, + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", + "Status": "Success", + "DetailedStatus": "Success", + "CreatedTime": 1550505536.843, + "ResourceCountByStatus": "{Success=1}" + }, + ... + ] + } + +**To get details of all executions for an association after a specific date and time** + +This example describes all executions of an association after the specified date and time. + +Command:: + + aws ssm describe-association-executions --association-id "8dfe3659-4309-493a-8755-0123456789ab" --filters "Key=CreatedTime,Value=2019-02-18T16:00:00Z,Type=GREATER_THAN" + +Output:: + + { + "AssociationExecutions": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "ExecutionId": "474925ef-1249-45a2-b93d-0123456789ab", + "Status": "Success", + "DetailedStatus": "Success", + "CreatedTime": 1550505827.119, + "ResourceCountByStatus": "{Success=1}" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-association.rst b/aws/dist/awscli/examples/ssm/describe-association.rst new file mode 100644 index 00000000..92234edc --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-association.rst @@ -0,0 +1,111 @@ +**To get details of an association** + +This example describes the association for the specified association ID. + +Command:: + + aws ssm describe-association --association-id "8dfe3659-4309-493a-8755-0123456789ab" + +Output:: + + { + "AssociationDescription": { + "Name": "AWS-GatherSoftwareInventory", + "AssociationVersion": "1", + "Date": 1534864780.995, + "LastUpdateAssociationDate": 1543235759.81, + "Overview": { + "Status": "Success", + "AssociationStatusAggregatedCount": { + "Success": 2 + } + }, + "DocumentVersion": "$DEFAULT", + "Parameters": { + "applications": [ + "Enabled" + ], + "awsComponents": [ + "Enabled" + ], + "customInventory": [ + "Enabled" + ], + "files": [ + "" + ], + "instanceDetailedInformation": [ + "Enabled" + ], + "networkConfig": [ + "Enabled" + ], + "services": [ + "Enabled" + ], + "windowsRegistry": [ + "" + ], + "windowsRoles": [ + "Enabled" + ], + "windowsUpdates": [ + "Enabled" + ] + }, + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "*" + ] + } + ], + "ScheduleExpression": "rate(24 hours)", + "LastExecutionDate": 1550501886.0, + "LastSuccessfulExecutionDate": 1550501886.0, + "AssociationName": "Inventory-Association" + } + } + +**To get details of an association for a specific instance and document** + +This example describes the association between an instance and a document. + +Command:: + + aws ssm describe-association --instance-id "i-1234567890abcdef0" --name "AWS-UpdateSSMAgent" + +Output:: + + { + "AssociationDescription": { + "Status": { + "Date": 1487876122.564, + "Message": "Associated with AWS-UpdateSSMAgent", + "Name": "Associated" + }, + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-1234567890abcdef0", + "Overview": { + "Status": "Pending", + "DetailedStatus": "Associated", + "AssociationStatusAggregatedCount": { + "Pending": 1 + } + }, + "AssociationId": "d8617c07-2079-4c18-9847-1234567890ab", + "DocumentVersion": "$DEFAULT", + "LastUpdateAssociationDate": 1487876122.564, + "Date": 1487876122.564, + "Targets": [ + { + "Values": [ + "i-1234567890abcdef0" + ], + "Key": "InstanceIds" + } + ] + } + } diff --git a/aws/dist/awscli/examples/ssm/describe-automation-executions.rst b/aws/dist/awscli/examples/ssm/describe-automation-executions.rst new file mode 100755 index 00000000..252dc3ac --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-automation-executions.rst @@ -0,0 +1,37 @@ +**To get details about all active and terminated Automation executions** + +This example displays the details of all Automation Execution. + +Command:: + + aws ssm describe-automation-executions + +Output:: + + { + "AutomationExecutionMetadataList": [ + { + "AutomationExecutionStatus": "Failed", + "Outputs": { + "createImage.ImageId": [ + "No output available yet because the step is not successfully executed" + ] + }, + "DocumentName": "AWS-UpdateLinuxAmi", + "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-8fb2db27a909", + "ExecutionEndTime": 1487798228.456, + "DocumentVersion": "1", + "ExecutionStartTime": 1487798222.746, + "ExecutedBy": "admin" + } + ] + } + +**To get details of a specific Automation execution** + +This example shows the details about a specific Automation Execution. + +Command:: + + aws ssm describe-automation-executions --filter "Key=ExecutionId,Values=4105a4fc-f944-11e6-9d32-8fb2db27a909" + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-automation-step-executions.rst b/aws/dist/awscli/examples/ssm/describe-automation-step-executions.rst new file mode 100644 index 00000000..b243cb02 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-automation-step-executions.rst @@ -0,0 +1,40 @@ +**To get details about all active and terminated step executions in an Automation workflow** + +This example displays the details of all step executions of an Automation workflow. + +Command:: + + aws ssm describe-automation-step-executions --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h + +Output:: + + { + "StepExecutions": [ + { + "StepName": "startInstances", + "Action": "aws:changeInstanceState", + "ExecutionStartTime": 1550083651.597, + "ExecutionEndTime": 1550083872.358, + "StepStatus": "Success", + "Inputs": { + "DesiredState": "\"running\"", + "InstanceIds": "[\"i-1234567890abcdef0\"]" + }, + "Outputs": { + "InstanceStates": [ + "running" + ] + }, + "StepExecutionId": "bd010896-b1d5-4028-b869-0a1b2c3d4f95", + "OverriddenParameters": {} + } + ] + } + +**To get details about a specific step execution in an Automation workflow** + +This example returns the details for a specific step within an Automation workflow. + +Command:: + + aws ssm describe-automation-step-executions --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --filters "Key=StepExecutionId,Values=bd010896-b1d5-4028-b869-0a1b2c3d4f95" diff --git a/aws/dist/awscli/examples/ssm/describe-available-patches.rst b/aws/dist/awscli/examples/ssm/describe-available-patches.rst new file mode 100755 index 00000000..8ed18a08 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-available-patches.rst @@ -0,0 +1,75 @@ +**To get available patches** + +This example gets all available patches for Windows Server 2019 that have a MSRC severity of Critical. + +Command:: + + aws ssm describe-available-patches --filters "Key=PRODUCT,Values=WindowsServer2019" "Key=MSRC_SEVERITY,Values=Critical" + +Output:: + + { + "Patches": [ + { + "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", + "ReleaseDate": 1544047205.0, + "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", + "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", + "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", + "Vendor": "Microsoft", + "ProductFamily": "Windows", + "Product": "WindowsServer2019", + "Classification": "SecurityUpdates", + "MsrcSeverity": "Critical", + "KbNumber": "KB4470788", + "MsrcNumber": "", + "Language": "All" + }, + { + "Id": "c96115e1-5587-4115-b851-22baa46a3f11", + "ReleaseDate": 1549994410.0, + "Title": "2019-02 Security Update for Adobe Flash Player for Windows Server 2019 for x64-based Systems (KB4487038)", + "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", + "ContentUrl": "https://support.microsoft.com/en-us/kb/4487038", + "Vendor": "Microsoft", + "ProductFamily": "Windows", + "Product": "WindowsServer2019", + "Classification": "SecurityUpdates", + "MsrcSeverity": "Critical", + "KbNumber": "KB4487038", + "MsrcNumber": "", + "Language": "All" + }, + ... + ] + } + +**To get details of a specific patch** + +This example returns details for the specified patch. + +Command:: + + aws ssm describe-available-patches --filters "Key=PATCH_ID,Values=KB4480979" + +Output:: + + { + "Patches": [ + { + "Id": "680861e3-fb75-432e-818e-d72e5f2be719", + "ReleaseDate": 1546970408.0, + "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", + "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", + "ContentUrl": "https://support.microsoft.com/en-us/kb/4480979", + "Vendor": "Microsoft", + "ProductFamily": "Windows", + "Product": "WindowsServer2016", + "Classification": "SecurityUpdates", + "MsrcSeverity": "Critical", + "KbNumber": "KB4480979", + "MsrcNumber": "", + "Language": "All" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-document-permission.rst b/aws/dist/awscli/examples/ssm/describe-document-permission.rst new file mode 100755 index 00000000..5b7753bc --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-document-permission.rst @@ -0,0 +1,15 @@ +**To get the permissions of a document** + +This example lists all the versions for a document. + +Command:: + + aws ssm describe-document-permission --name "RunShellScript" --permission-type "Share" + +Output:: + + { + "AccountIds": [ + "all" + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-document.rst b/aws/dist/awscli/examples/ssm/describe-document.rst new file mode 100644 index 00000000..41764b5f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-document.rst @@ -0,0 +1,36 @@ +**To describe a configuration document** + +This example returns the content of a document. + +Command:: + + aws ssm describe-document --name "RunShellScript" + +Output:: + + { + "Document": { + "Status": "Active", + "Hash": "95cf32aa8c4c4e6f0eb81c4d0cc9a81aa5d209c2c67c703bdea7a233b5596eba", + "Name": "RunShellScript", + "Parameters": [ + { + "Type": "StringList", + "Name": "commands", + "Description": "(Required) Specify a shell script or a command to run." + } + ], + "DocumentType": "Command", + "PlatformTypes": [ + "Linux" + ], + "DocumentVersion": "1", + "HashType": "Sha256", + "CreatedDate": 1487871400.888, + "Owner": "809632081692", + "SchemaVersion": "2.0", + "DefaultVersion": "1", + "LatestVersion": "1", + "Description": "Run a script" + } + } diff --git a/aws/dist/awscli/examples/ssm/describe-effective-instance-associations.rst b/aws/dist/awscli/examples/ssm/describe-effective-instance-associations.rst new file mode 100755 index 00000000..e17b110f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-effective-instance-associations.rst @@ -0,0 +1,20 @@ +**To get details of the effective associations for an instance** + +The following ``describe-effective-instance-associations`` example retrieves details about the effective associations for an instance. + +Command:: + + aws ssm describe-effective-instance-associations --instance-id "i-1234567890abcdef0" + +Output:: + + { + "Associations": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "InstanceId": "i-1234567890abcdef0", + "Content": "{\n \"schemaVersion\": \"1.2\",\n \"description\": \"Update the Amazon SSM Agent to the latest version or specified version.\",\n \"parameters\": {\n \"version\": {\n \"default\": \"\",\n \"description\": \"(Optional) A specific version of the Amazon SSM Agent to install. If not specified, the agent will be updated to the latest version.\",\n \"type\": \"String\"\n },\n \"allowDowngrade\": {\n \"default\": \"false\",\n \"description\": \"(Optional) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.\",\n \"type\": \"String\",\n \"allowedValues\": [\n \"true\",\n \"false\"\n ]\n }\n },\n \"runtimeConfig\": {\n \"aws:updateSsmAgent\": {\n \"properties\": [\n {\n \"agentName\": \"amazon-ssm-agent\",\n \"source\": \"https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json\",\n \"allowDowngrade\": \"{{ allowDowngrade }}\",\n \"targetVersion\": \"{{ version }}\"\n }\n ]\n }\n }\n}\n", + "AssociationVersion": "1" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-effective-patches-for-patch-baseline.rst b/aws/dist/awscli/examples/ssm/describe-effective-patches-for-patch-baseline.rst new file mode 100755 index 00000000..98cf3b5c --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-effective-patches-for-patch-baseline.rst @@ -0,0 +1,60 @@ +**To get all patches defined by a patch baseline** + +The following ``describe-effective-patches-for-patch-baseline`` example returns the patches defined by a patch baseline. + +Command:: + + aws ssm describe-effective-patches-for-patch-baseline --baseline-id "pb-08b654cf9b9681f04" + +Output:: + + { + "EffectivePatches": [ + { + "Patch": { + "Id": "fe6bd8c2-3752-4c8b-ab3e-1a7ed08767ba", + "ReleaseDate": 1544047205.0, + "Title": "2018-11 Update for Windows Server 2019 for x64-based Systems (KB4470788)", + "Description": "Install this update to resolve issues in Windows. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article for more information. After you install this item, you may have to restart your computer.", + "ContentUrl": "https://support.microsoft.com/en-us/kb/4470788", + "Vendor": "Microsoft", + "ProductFamily": "Windows", + "Product": "WindowsServer2019", + "Classification": "SecurityUpdates", + "MsrcSeverity": "Critical", + "KbNumber": "KB4470788", + "MsrcNumber": "", + "Language": "All" + }, + "PatchStatus": { + "DeploymentStatus": "APPROVED", + "ComplianceLevel": "CRITICAL", + "ApprovalDate": 1544047205.0 + } + }, + { + "Patch": { + "Id": "915a6b1a-f556-4d83-8f50-b2e75a9a7e58", + "ReleaseDate": 1549994400.0, + "Title": "2019-02 Cumulative Update for .NET Framework 3.5 and 4.7.2 for Windows Server 2019 for x64 (KB4483452)", + "Description": "A security issue has been identified in a Microsoft software product that could affect your system. You can help protect your system by installing this update from Microsoft. For a complete listing of the issues that are included in this update, see the associated Microsoft Knowledge Base article. After you install this update, you may have to restart your system.", + "ContentUrl": "https://support.microsoft.com/en-us/kb/4483452", + "Vendor": "Microsoft", + "ProductFamily": "Windows", + "Product": "WindowsServer2019", + "Classification": "SecurityUpdates", + "MsrcSeverity": "Important", + "KbNumber": "KB4483452", + "MsrcNumber": "", + "Language": "All" + }, + "PatchStatus": { + "DeploymentStatus": "APPROVED", + "ComplianceLevel": "CRITICAL", + "ApprovalDate": 1549994400.0 + } + }, + ... + ], + "NextToken": "--token string truncated--" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-instance-associations-status.rst b/aws/dist/awscli/examples/ssm/describe-instance-associations-status.rst new file mode 100755 index 00000000..2fbc0cc1 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-instance-associations-status.rst @@ -0,0 +1,36 @@ +**To describe the status of an instance's associations** + +This example shows details of the associations for an instance. + +Command:: + + aws ssm describe-instance-associations-status --instance-id "i-1234567890abcdef0" + +Output:: + + { + "InstanceAssociationStatusInfos": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "Name": "AWS-GatherSoftwareInventory", + "DocumentVersion": "1", + "AssociationVersion": "1", + "InstanceId": "i-1234567890abcdef0", + "ExecutionDate": 1550501886.0, + "Status": "Success", + "ExecutionSummary": "1 out of 1 plugin processed, 1 success, 0 failed, 0 timedout, 0 skipped. ", + "AssociationName": "Inventory-Association" + }, + { + "AssociationId": "5c5a31f6-6dae-46f9-944c-0123456789ab", + "Name": "AWS-UpdateSSMAgent", + "DocumentVersion": "1", + "AssociationVersion": "1", + "InstanceId": "i-1234567890abcdef0", + "ExecutionDate": 1550505828.548, + "Status": "Success", + "DetailedStatus": "Success", + "AssociationName": "UpdateSSMAgent" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-instance-information.rst b/aws/dist/awscli/examples/ssm/describe-instance-information.rst new file mode 100755 index 00000000..2aec9d52 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-instance-information.rst @@ -0,0 +1,52 @@ +**To describe managed instance information** + +This example shows details of each of your managed instances. + +Command:: + + aws ssm describe-instance-information + +Output:: + + { + "InstanceInformationList": [ + { + "InstanceId": "i-1234567890abcdef0", + "PingStatus": "Online", + "LastPingDateTime": 1550501835.178, + "AgentVersion": "2.3.415.0", + "IsLatestVersion": false, + "PlatformType": "Linux", + "PlatformName": "Amazon Linux AMI", + "PlatformVersion": "2018.03", + "ResourceType": "EC2Instance", + "IPAddress": "172.16.0.154", + "ComputerName": "ip-172-16-0-154.ec2.internal", + "AssociationStatus": "Success", + "LastAssociationExecutionDate": 1550501837.0, + "LastSuccessfulAssociationExecutionDate": 1550501837.0, + "AssociationOverview": { + "InstanceAssociationStatusAggregatedCount": { + "Success": 1 + } + } + }, + ... + ] + } + +**To describe information about a specific managed instance** + +This example shows details of the managed instance ``i-1234567890abcdef0``. + +Command:: + + aws ssm describe-instance-information --filters "Key=InstanceIds,Values=i-1234567890abcdef0" + +**To describe information about managed instances with a specific tag key** + +This example shows details for managed instances that have the tag key ``DEV``. + +Command:: + + aws ssm describe-instance-information --filters "Key=tag-key,Values=DEV" diff --git a/aws/dist/awscli/examples/ssm/describe-instance-patch-states-for-patch-group.rst b/aws/dist/awscli/examples/ssm/describe-instance-patch-states-for-patch-group.rst new file mode 100755 index 00000000..cedcede7 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-instance-patch-states-for-patch-group.rst @@ -0,0 +1,46 @@ +**To get the instance states for a patch group** + +This example gets the patch summary states per-instance for a patch group. + +Command:: + + aws ssm describe-instance-patch-states-for-patch-group --patch-group "Production" + +Output:: + + { + "InstancePatchStates": [ + { + "InstanceId": "i-1234567890abcdef0", + "PatchGroup": "Production", + "BaselineId": "pb-0713accee01234567", + "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", + "OwnerInformation": "", + "InstalledCount": 1, + "InstalledOtherCount": 13, + "InstalledRejectedCount": 0, + "MissingCount": 3, + "FailedCount": 0, + "NotApplicableCount": 11, + "OperationStartTime": 1550244665.723, + "OperationEndTime": 1550244826.241, + "Operation": "Scan" + }, + { + "InstanceId": "i-0987654321abcdef0", + "PatchGroup": "Production", + "BaselineId": "pb-0713accee01234567", + "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", + "OwnerInformation": "", + "InstalledCount": 1, + "InstalledOtherCount": 7, + "InstalledRejectedCount": 0, + "MissingCount": 1, + "FailedCount": 0, + "NotApplicableCount": 13, + "OperationStartTime": 1550245130.069, + "OperationEndTime": 1550245143.043, + "Operation": "Scan" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-instance-patch-states.rst b/aws/dist/awscli/examples/ssm/describe-instance-patch-states.rst new file mode 100755 index 00000000..40e9733f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-instance-patch-states.rst @@ -0,0 +1,30 @@ +**To get the patch summary states for instances** + +This example gets the patch summary states for an instance. + +Command:: + + aws ssm describe-instance-patch-states --instance-ids "i-1234567890abcdef0" + +Output:: + + { + "InstancePatchStates": [ + { + "InstanceId": "i-1234567890abcdef0", + "PatchGroup": "", + "BaselineId": "pb-0713accee01234567", + "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", + "OwnerInformation": "", + "InstalledCount": 2, + "InstalledOtherCount": 12, + "InstalledRejectedCount": 0, + "MissingCount": 1, + "FailedCount": 0, + "NotApplicableCount": 675, + "OperationStartTime": 1548438382.462, + "OperationEndTime": 1548438392.176, + "Operation": "Scan" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-instance-patches.rst b/aws/dist/awscli/examples/ssm/describe-instance-patches.rst new file mode 100755 index 00000000..d99d6aa7 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-instance-patches.rst @@ -0,0 +1,57 @@ +**To get the patch state details for an instance** + +This example retrieves information about the patch state details for the specified instance. + +Command:: + + aws ssm describe-instance-patches --instance-id "i-1234567890abcdef0" + +Output:: + + { + "Patches": [ + { + "Title": "2019-01 Security Update for Adobe Flash Player for Windows Server 2016 for x64-based Systems (KB4480979)", + "KBId": "KB4480979", + "Classification": "SecurityUpdates", + "Severity": "Critical", + "State": "Installed", + "InstalledTime": 1546992000.0 + }, + { + "Title": "", + "KBId": "KB4481031", + "Classification": "", + "Severity": "", + "State": "InstalledOther", + "InstalledTime": 1549584000.0 + }, + ... + ], + "NextToken": "--token string truncated--" + } + +**To get a list of patches in the Missing state for an instance** + +This example retrieves information about patches that are in the Missing state for the specified instance. + +Command:: + + aws ssm describe-instance-patches --instance-id "i-1234567890abcdef0" --filters Key=State,Values=Missing + +Output:: + + { + "Patches": [ + { + "Title": "Windows Malicious Software Removal Tool x64 - February 2019 (KB890830)", + "KBId": "KB890830", + "Classification": "UpdateRollups", + "Severity": "Unspecified", + "State": "Missing", + "InstalledTime": 0.0 + }, + ... + ], + "NextToken": "--token string truncated--" + } diff --git a/aws/dist/awscli/examples/ssm/describe-inventory-deletions.rst b/aws/dist/awscli/examples/ssm/describe-inventory-deletions.rst new file mode 100644 index 00000000..146ce25c --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-inventory-deletions.rst @@ -0,0 +1,80 @@ +**To get inventory deletions** + +This example retrieves details for inventory deletion operations. + +Command:: + + aws ssm describe-inventory-deletions + +Output:: + + { + "InventoryDeletions": [ + { + "DeletionId": "6961492a-8163-44ec-aa1e-01234567850", + "TypeName": "Custom:RackInformation", + "DeletionStartTime": 1550254911.0, + "LastStatus": "InProgress", + "LastStatusMessage": "The Delete is in progress", + "DeletionSummary": { + "TotalCount": 0, + "RemainingCount": 0, + "SummaryItems": [] + }, + "LastStatusUpdateTime": 1550254911.0 + }, + { + "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", + "TypeName": "Custom:RackInfo", + "DeletionStartTime": 1550254859.0, + "LastStatus": "InProgress", + "LastStatusMessage": "The Delete is in progress", + "DeletionSummary": { + "TotalCount": 1, + "RemainingCount": 1, + "SummaryItems": [ + { + "Version": "1.0", + "Count": 1, + "RemainingCount": 1 + } + ] + }, + "LastStatusUpdateTime": 1550254859.0 + } + ] + } + +**To get details of a specific inventory deletion** + +This example retrieves details for a specific inventory deletion operation. + +Command:: + + aws ssm describe-inventory-deletions --deletion-id "d72ac9e8-1f60-4d40-b1c6-987654321c4d" + +Output:: + + { + "InventoryDeletions": [ + { + "DeletionId": "d72ac9e8-1f60-4d40-b1c6-987654321c4d", + "TypeName": "Custom:RackInfo", + "DeletionStartTime": 1550254859.0, + "LastStatus": "InProgress", + "LastStatusMessage": "The Delete is in progress", + "DeletionSummary": { + "TotalCount": 1, + "RemainingCount": 1, + "SummaryItems": [ + { + "Version": "1.0", + "Count": 1, + "RemainingCount": 1 + } + ] + }, + "LastStatusUpdateTime": 1550254859.0 + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-task-invocations.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-task-invocations.rst new file mode 100755 index 00000000..72aa3392 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-task-invocations.rst @@ -0,0 +1,23 @@ +**To get the specific task invocations performed for a task execution** + +This example lists the invocations for a task executed as part of a Maintenance Window execution. + +Command:: + + aws ssm describe-maintenance-window-execution-task-invocations --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586" + +Output:: + + { + "WindowExecutionTaskInvocationIdentities": [ + { + "Status": "SUCCESS", + "Parameters": "{\"documentName\":\"AWS-RunShellScript\",\"instanceIds\":[\"i-0000293ffd8c57862\"],\"parameters\":{\"commands\":[\"df\"]},\"maxConcurrency\":\"1\",\"maxErrors\":\"1\"}", + "InvocationId": "e274b6e1-fe56-4e32-bd2a-8073c6381d8b", + "StartTime": 1487692834.723, + "EndTime": 1487692834.871, + "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", + "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-tasks.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-tasks.rst new file mode 100755 index 00000000..29fa56aa --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-execution-tasks.rst @@ -0,0 +1,23 @@ +**To list all tasks associated with a Maintenance Window Execution** + +This example lists the tasks associated with a Maintenance Window execution. + +Command:: + + aws ssm describe-maintenance-window-execution-tasks --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" + +Output:: + + { + "WindowExecutionTaskIdentities": [ + { + "Status": "SUCCESS", + "TaskArn": "AWS-RunShellScript", + "StartTime": 1487692834.684, + "TaskType": "RUN_COMMAND", + "EndTime": 1487692835.005, + "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", + "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-executions.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-executions.rst new file mode 100755 index 00000000..3bffe856 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-executions.rst @@ -0,0 +1,37 @@ +**To list all executions for a Maintenance Window** + +This example lists all of the executions for a Maintenance Window. + +Command:: + + aws ssm describe-maintenance-window-executions --window-id "mw-ab12cd34ef56gh78" + +Output:: + + { + "WindowExecutions": [ + { + "Status": "SUCCESS", + "WindowId": "mw-06cf17cbefcb4bf4f", + "StartTime": 1487692834.595, + "EndTime": 1487692835.051, + "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355" + } + ] + } + +**To list all executions for a Maintenance Window before a specified date** + +This example lists all of the executions for a Maintenance Window before a specific date. + +Command:: + + aws ssm describe-maintenance-window-executions --window-id "mw-ab12cd34ef56gh78" --filters "Key=ExecutedBefore,Values=2016-11-04T05:00:00Z" + +**To list all executions for a Maintenance Window after a specified date** + +This example lists all of the executions for Maintenance Window after a specific date. + +Command:: + + aws ssm describe-maintenance-window-executions --window-id "mw-ab12cd34ef56gh78" --filters "Key=ExecutedAfter,Values=2016-11-04T17:00:00Z" \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-schedule.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-schedule.rst new file mode 100644 index 00000000..3e7640e0 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-schedule.rst @@ -0,0 +1,25 @@ +**To list upcoming executions for a Maintenance Window** + +This example lists upcoming executions for a Maintenance Window. + +Command:: + + aws ssm describe-maintenance-window-schedule --window-id mw-ab12cd34ef56gh78 + +Output:: + + { + "ScheduledWindowExecutions": [ + { + "WindowId": "mw-ab12cd34ef56gh78", + "Name": "My-First-Maintenance-Window", + "ExecutionTime": "2019-02-19T16:00Z" + }, + { + "WindowId": "mw-ab12cd34ef56gh78", + "Name": "My-First-Maintenance-Window", + "ExecutionTime": "2019-02-26T16:00Z" + }, + ... + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-targets.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-targets.rst new file mode 100755 index 00000000..84a6c9b8 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-targets.rst @@ -0,0 +1,51 @@ +**To list all targets for a Maintenance Window** + +This example lists all of the targets for a Maintenance Window. + +Command:: + + aws ssm describe-maintenance-window-targets --window-id "mw-06cf17cbefcb4bf4f" + +Output:: + + { + "Targets": [ + { + "ResourceType": "INSTANCE", + "OwnerInformation": "Single instance", + "WindowId": "mw-06cf17cbefcb4bf4f", + "Targets": [ + { + "Values": [ + "i-0000293ffd8c57862" + ], + "Key": "InstanceIds" + } + ], + "WindowTargetId": "350d44e6-28cc-44e2-951f-4b2c985838f6" + }, + { + "ResourceType": "INSTANCE", + "OwnerInformation": "Two instances in a list", + "WindowId": "mw-06cf17cbefcb4bf4f", + "Targets": [ + { + "Values": [ + "i-0000293ffd8c57862", + "i-0cb2b964d3e14fd9f" + ], + "Key": "InstanceIds" + } + ], + "WindowTargetId": "e078a987-2866-47be-bedd-d9cf49177d3a" + } + ] + } + +**To list all targets for a Maintenance Window matching a specific owner information value** + +This example lists all of the targets for a Maintenance Window with a specific value. + +Command:: + + aws ssm describe-maintenance-window-targets --window-id "mw-ab12cd34ef56gh78" --filters "Key=OwnerInformation,Values=Single instance" diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-window-tasks.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-window-tasks.rst new file mode 100755 index 00000000..5f5421d5 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-window-tasks.rst @@ -0,0 +1,63 @@ +**To list all tasks for a Maintenance Window** + +This example lists all of the tasks for a Maintenance Window. + +Command:: + + aws ssm describe-maintenance-window-tasks --window-id "mw-06cf17cbefcb4bf4f" + +Output:: + + { + "Tasks": [ + { + "ServiceRoleArn": "arn:aws:iam:::role/MaintenanceWindowsRole", + "MaxErrors": "1", + "TaskArn": "AWS-RunShellScript", + "MaxConcurrency": "1", + "WindowTaskId": "a23e338d-ff30-4398-8aa3-09cd052ebf17", + "TaskParameters": { + "commands": { + "Values": [ + "df" + ] + } + }, + "Priority": 10, + "WindowId": "mw-06cf17cbefcb4bf4f", + "Type": "RUN_COMMAND", + "Targets": [ + { + "Values": [ + "i-0000293ffd8c57862" + ], + "Key": "InstanceIds" + } + ] + } + ] + } + +**To list all tasks for a Maintenance Window that invoke the AWS-RunPowerShellScript Run Command** + +This example lists all of the tasks for a Maintenance Window that invoke the ``AWS-RunPowerShellScript`` Run Command. + +Command:: + + aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=TaskArn,Values=AWS-RunPowerShellScript" + +**To list all tasks for a Maintenance Window that have a Priority of 3** + +This example lists all of the tasks for a Maintenance Window that have a ``Priority`` of ``3``. + +Command:: + + aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=Priority,Values=3" + +**To list all tasks for a Maintenance Window that have a Priority of 1 and use Run Command** + +This example lists all of the tasks for a Maintenance Window that have a ``Priority`` of ``1`` and use ``Run Command``. + +Command:: + + aws ssm describe-maintenance-window-tasks --window-id "mw-ab12cd34ef56gh78" --filters "Key=Priority,Values=1" "Key=TaskType,Values=RUN_COMMAND" \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-windows-for-target.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-windows-for-target.rst new file mode 100644 index 00000000..c8d5d3ed --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-windows-for-target.rst @@ -0,0 +1,18 @@ +**To list all Maintenance Windows associated with a specific instance** + +This example lists the Maintenance Windows which have targets or tasks that the specified instance is asscoiated with. + +Command:: + + aws ssm describe-maintenance-windows-for-target --targets Key=InstanceIds,Values=i-1234567890EXAMPLE --resource-type INSTANCE + +Output:: + + { + "WindowIdentities": [ + { + "WindowId": "mw-0c5ed765acEXAMPLE", + "Name": "My-First-Maintenance-Window" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-maintenance-windows.rst b/aws/dist/awscli/examples/ssm/describe-maintenance-windows.rst new file mode 100755 index 00000000..e0ceb17e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-maintenance-windows.rst @@ -0,0 +1,38 @@ +**To list all Maintenance Windows** + +This example lists all Maintenance Windows on your account. + +Command:: + + aws ssm describe-maintenance-windows + +Output:: + + { + "WindowIdentities": [ + { + "Duration": 2, + "Cutoff": 1, + "WindowId": "mw-03eb9db42890fb82d", + "Enabled": true, + "Name": "TestMaintWin" + }, + ] + } + +**To list all enabled Maintenance Windows** + +This example lists all enabled Maintenance Windows. + +Command:: + + aws ssm describe-maintenance-windows --filters "Key=Enabled,Values=true" + +**To list Maintenance Windows matching a specific name** + +This example lists all Maintenance Windows with a specific name value. + +Command:: + + aws ssm describe-maintenance-windows --filters "Key=Name,Values=MyMaintenanceWindow" + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/describe-parameters.rst b/aws/dist/awscli/examples/ssm/describe-parameters.rst new file mode 100755 index 00000000..a5cd945e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-parameters.rst @@ -0,0 +1,28 @@ +**To list all Parameters** + +This example lists all parameters. + +Command:: + + aws ssm describe-parameters + +Output:: + + { + "Parameters": [ + { + "LastModifiedUser": "arn:aws:iam::809632081692:user/admin", + "LastModifiedDate": 1487880325.324, + "Type": "String", + "Name": "welcome" + } + ] + } + +**To list all Parameters matching specific metadata** + +This example lists all parameters matching a filter. + +Command:: + + aws ssm describe-parameters --filters "Key=Name,Values=helloWorld" diff --git a/aws/dist/awscli/examples/ssm/describe-patch-baselines.rst b/aws/dist/awscli/examples/ssm/describe-patch-baselines.rst new file mode 100755 index 00000000..0647ecdc --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-patch-baselines.rst @@ -0,0 +1,46 @@ +**To list all patch baselines** + +This example lists all patch baselines. + +Command:: + + aws ssm describe-patch-baselines + +Output:: + + { + "BaselineIdentities": [ + { + "BaselineId": "arn:aws:ssm:us-east-1:075727635805:patchbaseline/pb-03e3f588eec25344c", + "BaselineName": "AWS-CentOSDefaultPatchBaseline", + "OperatingSystem": "CENTOS", + "BaselineDescription": "Default Patch Baseline for CentOS Provided by AWS.", + "DefaultBaseline": true + }, + { + "BaselineId": "arn:aws:ssm:us-east-1:075727635805:patchbaseline/pb-07d8884178197b66b", + "BaselineName": "AWS-SuseDefaultPatchBaseline", + "OperatingSystem": "SUSE", + "BaselineDescription": "Default Patch Baseline for Suse Provided by AWS.", + "DefaultBaseline": true + }, + ... + ] + } + + +**To list all AWS provided patch baselines** + +This example lists all patch baselines provided by AWS. + +Command:: + + aws ssm describe-patch-baselines --filters "Key=OWNER,Values=[AWS]" + +**To list all patch baselines you own** + +This example lists all patch baselines with you as the owner. + +Command:: + + aws ssm describe-patch-baselines --filters "Key=OWNER,Values=[Self]" diff --git a/aws/dist/awscli/examples/ssm/describe-patch-group-state.rst b/aws/dist/awscli/examples/ssm/describe-patch-group-state.rst new file mode 100755 index 00000000..d765cc2e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-patch-group-state.rst @@ -0,0 +1,19 @@ +**To get the state of a patch group** + +This example gets the high-level patch compliance summary for a patch group. + +Command:: + + aws ssm describe-patch-group-state --patch-group "Production" + +Output:: + + { + "Instances": 2, + "InstancesWithInstalledPatches": 2, + "InstancesWithInstalledOtherPatches": 2, + "InstancesWithInstalledRejectedPatches": 0, + "InstancesWithMissingPatches": 2, + "InstancesWithFailedPatches": 0, + "InstancesWithNotApplicablePatches": 2 + } diff --git a/aws/dist/awscli/examples/ssm/describe-patch-groups.rst b/aws/dist/awscli/examples/ssm/describe-patch-groups.rst new file mode 100755 index 00000000..699dc39f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-patch-groups.rst @@ -0,0 +1,35 @@ +**To display patch group registrations** + +This example lists the patch group registrations. + +Command:: + + aws ssm describe-patch-groups + +Output:: + + { + "Mappings": [ + { + "PatchGroup": "Production", + "BaselineIdentity": { + "BaselineId": "pb-0123456789abcdef0", + "BaselineName": "ProdPatching", + "OperatingSystem": "WINDOWS", + "BaselineDescription": "Patches for Production", + "DefaultBaseline": false + } + }, + { + "PatchGroup": "Development", + "BaselineIdentity": { + "BaselineId": "pb-0713accee01234567", + "BaselineName": "DevPatching", + "OperatingSystem": "WINDOWS", + "BaselineDescription": "Patches for Development", + "DefaultBaseline": true + } + }, + ... + ] + } diff --git a/aws/dist/awscli/examples/ssm/describe-sessions.rst b/aws/dist/awscli/examples/ssm/describe-sessions.rst new file mode 100644 index 00000000..788441f5 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/describe-sessions.rst @@ -0,0 +1,64 @@ +**To list all active Session Manager sessions** + +This example retrieves a list of the active sessions created most recently (both connected and disconnected sessions) over the past 30 days that were started by a particular user. + +Command:: + + aws ssm describe-sessions --state "Active" --filters "key=Owner,value=arn:aws:sts::123456789012:assumed-role/Administrator/Matt" + +Output:: + + { + "Sessions": [ + { + "SessionId": "Matt-07a16060613c408b5", + "Target": "i-1234567890abcdef0", + "Status": "Connected", + "StartDate": 1550676938.352, + "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Matt", + "OutputUrl": {} + }, + { + "SessionId": "Matt-01edf534b8b56e8eb", + "Target": "i-9876543210abcdef0", + "Status": "Connected", + "StartDate": 1550676842.194, + "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Matt", + "OutputUrl": {} + } + ] + } + +**To list all terminated Session Manager sessions** + +This example retrieves a list of the most recently terminated sessions from the past 30 days for all users. + +Command:: + + aws ssm describe-sessions --state "History" + +Output:: + + { + "Sessions": [ + { + "SessionId": "Dan-0022b1eb2b0d9e3bd", + "Target": "i-1234567890abcdef0", + "Status": "Terminated", + "StartDate": 1550520701.256, + "EndDate": 1550521931.563, + "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Dan" + }, + { + "SessionId": "Erik-0db53f487931ed9d4", + "Target": "i-9876543210abcdef0", + "Status": "Terminated", + "StartDate": 1550161369.149, + "EndDate": 1550162580.329, + "Owner": "arn:aws:sts::123456789012:assumed-role/Administrator/Erik" + }, + ... + ], + "NextToken": "--token string truncated--" + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/get-automation-execution.rst b/aws/dist/awscli/examples/ssm/get-automation-execution.rst new file mode 100755 index 00000000..a1c16557 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-automation-execution.rst @@ -0,0 +1,76 @@ +**To display the details of an Automation Execution** + +This example displays the details of an Automation Execution. + +Command:: + + aws ssm get-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-8fb2db27a909" + +Output:: + + { + "AutomationExecution": { + "AutomationExecutionStatus": "Failed", + "Parameters": { + "SourceAmiId": [ + "ami-f173cc91" + ], + "AutomationAssumeRole": [ + "arn:aws:iam::812345678901:role/SSMAutomationRole" + ], + "InstanceIamRole": [ + "EC2InstanceRole" + ] + }, + "Outputs": { + "createImage.ImageId": [ + "No output available yet because the step is not successfully executed" + ] + }, + "DocumentName": "AWS-UpdateLinuxAmi", + "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-8fb2db27a909", + "FailureMessage": "Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded authorization failure message: --truncated-- (Service: AmazonEC2; Status Code: 403; Error Code: UnauthorizedOperation; Request ID: 6a002f94-ba37-43fd-99e6-39517715fce5)", + "ExecutionEndTime": 1487798228.456, + "DocumentVersion": "1", + "ExecutionStartTime": 1487798222.746, + "StepExecutions": [ + { + "Inputs": { + "MaxInstanceCount": "1", + "UserData": "\"--truncated--\"", + "MinInstanceCount": "1", + "ImageId": "\"ami-f173cc91\"", + "IamInstanceProfileName": "\"EC2InstanceRole\"", + "InstanceType": "\"t2.micro\"" + }, + "StepName": "launchInstance", + "FailureMessage": "Step launchInstance failed maximum allowed times. You are not authorized to perform this operation. Encoded authorization failure message: --truncated--)", + "ExecutionEndTime": 1487798226.014, + "ExecutionStartTime": 1487798223.346, + "Action": "aws:runInstances", + "StepStatus": "Failed" + }, + { + "Action": "aws:runCommand", + "StepName": "updateOSSoftware", + "StepStatus": "Pending" + }, + { + "Action": "aws:changeInstanceState", + "StepName": "stopInstance", + "StepStatus": "Pending" + }, + { + "Action": "aws:createImage", + "StepName": "createImage", + "StepStatus": "Pending" + }, + { + "Action": "aws:changeInstanceState", + "StepName": "terminateInstance", + "StepStatus": "Pending" + } + ] + } + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/get-command-invocation.rst b/aws/dist/awscli/examples/ssm/get-command-invocation.rst new file mode 100755 index 00000000..fb92bff4 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-command-invocation.rst @@ -0,0 +1,31 @@ +**To display the details of a command invocation** + +This example lists all the invocations of a command on an instance. + +Command:: + + aws ssm get-command-invocation --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" --instance-id "i-1234567890abcdef0" + +Output:: + + { + "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", + "InstanceId": "i-1234567890abcdef0", + "Comment": "", + "DocumentName": "AWS-RunPowerShellScript", + "DocumentVersion": "1", + "PluginName": "aws:runPowerShellScript", + "ResponseCode": 0, + "ExecutionStartDateTime": "2019-02-14T19:26:26.439Z", + "ExecutionElapsedTime": "PT0.541S", + "ExecutionEndDateTime": "2019-02-14T19:26:26.439Z", + "Status": "Success", + "StatusDetails": "Success", + "StandardOutputContent": "HelloWorld\r\n", + "StandardOutputUrl": "", + "StandardErrorContent": "", + "StandardErrorUrl": "", + "CloudWatchOutputConfig": { + "CloudWatchLogGroupName": "", + "CloudWatchOutputEnabled": false + } diff --git a/aws/dist/awscli/examples/ssm/get-connection-status.rst b/aws/dist/awscli/examples/ssm/get-connection-status.rst new file mode 100644 index 00000000..fd79f8c6 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-connection-status.rst @@ -0,0 +1,14 @@ +**To display the connection status of a managed instance** + +This example returns the connection status of the managed instance ``i-1234567890abcdef0``. + +Command:: + + aws ssm get-connection-status --target i-1234567890abcdef0 + +Output:: + + { + "Target": "i-1234567890abcdef0", + "Status": "connected" + } diff --git a/aws/dist/awscli/examples/ssm/get-default-patch-baseline.rst b/aws/dist/awscli/examples/ssm/get-default-patch-baseline.rst new file mode 100755 index 00000000..cf6ccd68 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-default-patch-baseline.rst @@ -0,0 +1,29 @@ +**To display the default Windows patch baseline** + +This example displays the default Windows patch baseline. + +Command:: + + aws ssm get-default-patch-baseline + +Output:: + + { + "BaselineId": "pb-0713accee01612345", + "OperatingSystem": "WINDOWS" + } + +**To display the default Amazon Linux patch baseline** + +This example displays the default Windows patch baseline. + +Command:: + + aws ssm get-default-patch-baseline --operating-system AMAZON_LINUX + +Output:: + + { + "BaselineId": "pb-047c6eb9c8fc12345", + "OperatingSystem": "AMAZON_LINUX" + } diff --git a/aws/dist/awscli/examples/ssm/get-deployable-patch-snapshot-for-instance.rst b/aws/dist/awscli/examples/ssm/get-deployable-patch-snapshot-for-instance.rst new file mode 100755 index 00000000..91808f7f --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-deployable-patch-snapshot-for-instance.rst @@ -0,0 +1,18 @@ +**To retrieve the current snapshot for the patch baseline an instance uses** + +This example displays the current snapshot for the patch baseline used by an Instance. This command must be run from the instance using the instance credentials. To ensure it uses the instance credentials, run ``aws configure`` and only specify the region of your instance but leave the ``Access Key`` and ``Secret Key`` fields blank. + +Use ``uuidgen`` to generate a ``snapshot-id``. + +Command:: + + aws ssm get-deployable-patch-snapshot-for-instance --instance-id "i-1234567890abcdef0" --snapshot-id "521c3536-930c-4aa9-950e-01234567abcd" + +Output:: + + { + "InstanceId": "i-1234567890abcdef0", + "SnapshotId": "521c3536-930c-4aa9-950e-01234567abcd", + "Product": "AmazonLinux2018.03", + "SnapshotDownloadUrl": "https://patch-baseline-snapshot-us-east-1.s3.amazonaws.com/ed85194ef27214f5984f28b4d664d14f7313568fea7d4b6ac6c10ad1f729d7e7-773304212436/AMAZON_LINUX-521c3536-930c-4aa9-950e-01234567abcd?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190215T164031Z&X-Amz-SignedHeaders=host&X-Amz-Expires=86400&X-Amz-Credential=AKIAJ5C56P35AEBRX2QQ%2F20190215%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=efaaaf6e3878e77f48a6697e015efdbda9c426b09c5822055075c062f6ad2149" + } diff --git a/aws/dist/awscli/examples/ssm/get-document.rst b/aws/dist/awscli/examples/ssm/get-document.rst new file mode 100644 index 00000000..0622fff5 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-document.rst @@ -0,0 +1,35 @@ +**To get the contents of a document** + +This example returns the content of a document. + +Command:: + + aws ssm get-document --name "RunShellScript" + +Output:: + + { + "Content": "{\n \"schemaVersion\":\"2.0\",\n \"description\":\"Run a script\",\n \"parameters\":{\n \"commands\":{\n \"type\":\"StringList\",\n \"description\":\"(Required) Specify a shell script or a command to run.\",\n \"minItems\":1,\n \"displayType\":\"textarea\"\n }\n },\n \"mainSteps\":[\n {\n \"action\":\"aws:runShellScript\",\n \"name\":\"runShellScript\",\n \"inputs\":{\n \"commands\":\"{{ commands }}\"\n }\n },\n {\n \"action\":\"aws:runPowerShellScript\",\n \"name\":\"runPowerShellScript\",\n \"inputs\":{\n \"commands\":\"{{ commands }}\"\n }\n }\n ]\n}\n", + "Name": "RunShellScript.json", + "DocumentVersion": "1", + "DocumentType": "Command" + } + +**To get the contents of a document in YAML format** + +This example returns the content of a document in YAML format. + +Command:: + + aws ssm get-document --name "RunShellScript" --document-format YAML + +Output:: + + { + "Name": "A-Document-yaml2", + "DocumentVersion": "1", + "Status": "Active", + "Content": "---\nschemaVersion: '1.2'\ndescription: Run a PowerShell script or specify the paths to scripts to run.\nparameters:\n commands:\n type: StringList\n description: \"(Required) Specify the commands to run or the paths to existing\n scripts on the instance.\"\n minItems: 1\n displayType: textarea\n workingDirectory:\n type: String\n default: ''\n description: \"(Optional) The path to the working directory on your instance.\"\n maxChars: 4096\n executionTimeout:\n type: String\n default: '3600'\n description: \"(Optional) The time in seconds for a command to be completed before\n it is considered to have failed. Default is 3600 (1 hour). Maximum is 172800\n (48 hours).\"\n allowedPattern: \"([1-9][0-9]{0,4})|(1[0-6][0-9]{4})|(17[0-1][0-9]{3})|(172[0-7][0-9]{2})|(172800)\"\nruntimeConfig:\n aws:runPowerShellScript:\n properties:\n - id: 0.aws:runPowerShellScript\n runCommand: \"{{ commands }}\"\n workingDirectory: \"{{ workingDirectory }}\"\n timeoutSeconds: \"{{ executionTimeout }}\"\n", + "DocumentType": "Command", + "DocumentFormat": "YAML" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/get-inventory-schema.rst b/aws/dist/awscli/examples/ssm/get-inventory-schema.rst new file mode 100755 index 00000000..1e3547ef --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-inventory-schema.rst @@ -0,0 +1,58 @@ +**To view your inventory schema** + +This example returns a list of inventory type names for the account. + +Command:: + + aws ssm get-inventory-schema + +Output:: + + { + "Schemas": [ + { + "TypeName": "AWS:AWSComponent", + "Version": "1.0", + "Attributes": [ + { + "Name": "Name", + "DataType": "STRING" + }, + { + "Name": "ApplicationType", + "DataType": "STRING" + }, + { + "Name": "Publisher", + "DataType": "STRING" + }, + { + "Name": "Version", + "DataType": "STRING" + }, + { + "Name": "InstalledTime", + "DataType": "STRING" + }, + { + "Name": "Architecture", + "DataType": "STRING" + }, + { + "Name": "URL", + "DataType": "STRING" + } + ] + }, + ... + ], + "NextToken": "--token string truncated--" + } + +**To view the inventory schema for a specific inventory type** + +This example return the inventory schema for a the AWS:AWSComponent inventory type. + +Command:: + + aws ssm get-inventory-schema --type-name "AWS:AWSComponent" diff --git a/aws/dist/awscli/examples/ssm/get-inventory.rst b/aws/dist/awscli/examples/ssm/get-inventory.rst new file mode 100755 index 00000000..5affdb6b --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-inventory.rst @@ -0,0 +1,37 @@ +**To view your inventory** + +This example gets the custom metadata for your inventory. + +Command:: + + aws ssm get-inventory + +Output:: + + { + "Entities": [ + { + "Data": { + "AWS:InstanceInformation": { + "Content": [ + { + "ComputerName": "ip-172-31-44-222.us-west-2.compute.internal", + "InstanceId": "i-0cb2b964d3e14fd9f", + "IpAddress": "172.31.44.222", + "AgentType": "amazon-ssm-agent", + "ResourceType": "EC2Instance", + "AgentVersion": "2.0.672.0", + "PlatformVersion": "2016.09", + "PlatformName": "Amazon Linux AMI", + "PlatformType": "Linux" + } + ], + "TypeName": "AWS:InstanceInformation", + "SchemaVersion": "1.0", + "CaptureTime": "2017-02-20T18:03:58Z" + } + }, + "Id": "i-0cb2b964d3e14fd9f" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task-invocation.rst b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task-invocation.rst new file mode 100644 index 00000000..fcfd07b8 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task-invocation.rst @@ -0,0 +1,22 @@ +**To get information about a Maintenance Window task invocation** + +This example lists information about a task invocation that was part of a Maintenance Window execution. + +Command:: + + aws ssm get-maintenance-window-execution-task-invocation --window-execution-id "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE" --task-id "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" --invocation-id "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE" + +Output:: + + { + "Status": "SUCCESS", + "Parameters": "{\"comment\":\"\",\"documentName\":\"AWS-RunPowerShellScript\",\"instanceIds\":[\"i-1234567890EXAMPLE\"],\"maxConcurrency\":\"1\",\"maxErrors\":\"1\",\"parameters\":{\"executionTimeout\":[\"3600\"],\"workingDirectory\":[\"\"],\"commands\":[\"echo Hello\"]},\"timeoutSeconds\":600}", + "ExecutionId": "03b6baa0-5460-4e15-83f2-ea685EXAMPLE", + "InvocationId": "a5273e2c-d2c6-4880-b3e1-5e550EXAMPLE", + "StartTime": 1549998326.421, + "TaskType": "RUN_COMMAND", + "EndTime": 1550001931.784, + "WindowExecutionId": "bc494bfa-e63b-49f6-8ad1-aa9f2EXAMPLE", + "StatusDetails": "Failed", + "TaskExecutionId": "96f2ad59-97e3-461d-a63d-40c8aEXAMPLE" + } diff --git a/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task.rst b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task.rst new file mode 100755 index 00000000..65dba778 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution-task.rst @@ -0,0 +1,37 @@ +**To get information about a Maintenance Window task execution** + +This example lists information about a task that was part of a Maintenance Window execution. + +Command:: + + aws ssm get-maintenance-window-execution-task --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" --task-id "ac0c6ae1-daa3-4a89-832e-d384503b6586" + +Output:: + + { + "Status": "SUCCESS", + "MaxErrors": "1", + "TaskArn": "AWS-RunShellScript", + "MaxConcurrency": "1", + "ServiceRole": "arn:aws:iam::812345678901:role/MaintenanceWindowsRole", + "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", + "Priority": 10, + "StartTime": 1487692834.684, + "EndTime": 1487692835.005, + "Type": "RUN_COMMAND", + "TaskParameters": [ + { + "commands": { + "Values": [ + "df" + ] + }, + "aws:InstanceId": { + "Values": [ + "i-0000293ffd8c57862" + ] + } + } + ], + "TaskExecutionId": "ac0c6ae1-daa3-4a89-832e-d384503b6586" + } diff --git a/aws/dist/awscli/examples/ssm/get-maintenance-window-execution.rst b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution.rst new file mode 100755 index 00000000..d648dd11 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-maintenance-window-execution.rst @@ -0,0 +1,19 @@ +**To get information about a Maintenance Window task execution** + +This example lists information about a task executed as part of a Maintenance Window execution. + +Command:: + + aws ssm get-maintenance-window-execution --window-execution-id "518d5565-5969-4cca-8f0e-da3b2a638355" + +Output:: + + { + "Status": "SUCCESS", + "TaskIds": [ + "ac0c6ae1-daa3-4a89-832e-d384503b6586" + ], + "StartTime": 1487692834.595, + "EndTime": 1487692835.051, + "WindowExecutionId": "518d5565-5969-4cca-8f0e-da3b2a638355", + } diff --git a/aws/dist/awscli/examples/ssm/get-maintenance-window-task.rst b/aws/dist/awscli/examples/ssm/get-maintenance-window-task.rst new file mode 100644 index 00000000..af00af07 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-maintenance-window-task.rst @@ -0,0 +1,47 @@ +**To get information about a Maintenance Window task** + +This example gets details about a Maintenance Window task. + +Command:: + + aws ssm get-maintenance-window-task --window-id mw-0c5ed765acEXAMPLE --window-task-id 0e842a8d-2d44-4886-bb62-af8dcEXAMPLE + +Output:: + + { + "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", + "MaxErrors": "1", + "TaskArn": "AWS-RunPowerShellScript", + "MaxConcurrency": "1", + "WindowTaskId": "0e842a8d-2d44-4886-bb62-af8dcEXAMPLE", + "TaskParameters": {}, + "Priority": 1, + "TaskInvocationParameters": { + "RunCommand": { + "Comment": "", + "TimeoutSeconds": 600, + "Parameters": { + "commands": [ + "echo Hello" + ], + "executionTimeout": [ + "3600" + ], + "workingDirectory": [ + "" + ] + } + } + }, + "WindowId": "mw-0c5ed765acEXAMPLE", + "TaskType": "RUN_COMMAND", + "Targets": [ + { + "Values": [ + "84c818da-b619-4d3d-9651-946f3EXAMPLE" + ], + "Key": "WindowTargetIds" + } + ], + "Name": "ExampleTask" + } diff --git a/aws/dist/awscli/examples/ssm/get-maintenance-window.rst b/aws/dist/awscli/examples/ssm/get-maintenance-window.rst new file mode 100755 index 00000000..def19c80 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-maintenance-window.rst @@ -0,0 +1,21 @@ +**To get information about a Maintenance Window** + +This example gets details about a Maintenance Window. + +Command:: + + aws ssm get-maintenance-window --window-id "mw-03eb9db42890fb82d" + +Output:: + + { + "Cutoff": 1, + "Name": "TestMaintWin", + "Schedule": "cron(0 */30 * * * ? *)", + "Enabled": true, + "AllowUnassociatedTargets": false, + "WindowId": "mw-03eb9db42890fb82d", + "ModifiedDate": 1487614445.527, + "CreatedDate": 1487614445.527, + "Duration": 2 + } diff --git a/aws/dist/awscli/examples/ssm/get-parameter-history.rst b/aws/dist/awscli/examples/ssm/get-parameter-history.rst new file mode 100755 index 00000000..d6a02152 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-parameter-history.rst @@ -0,0 +1,23 @@ +**To get a value history for a parameter** + +This example lists the value history for a parameter. + +Command:: + + aws ssm get-parameter-history --name "welcome" + +Output:: + + { + "Parameters": [ + { + "Name": "welcome", + "Type": "String", + "LastModifiedDate": 1542308384.49, + "LastModifiedUser": "arn:aws:sts::123456789012:assumed-role/Administrator", + "Value": "1", + "Version": 1, + "Labels": [] + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/get-parameter.rst b/aws/dist/awscli/examples/ssm/get-parameter.rst new file mode 100644 index 00000000..8501f56d --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-parameter.rst @@ -0,0 +1,43 @@ +**Example 1: To list the value for a parameter** + +The following ``get-parameter`` example lists the value for a parameter. + +Command:: + + aws ssm get-parameter --name "helloWorld" + +Output:: + + { + "Parameter": { + "Name": "helloWorld", + "Type": "String", + "Value": "Good day sunshine", + "Version": 1, + "LastModifiedDate": 1530018761.888, + "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloWorld" + } + } + +**Example 2: To decrypt the value for a parmeter** + +The following ``get-parameter`` example decrypts the value of a ``SecureString`` parameter. + +Command:: + + aws ssm get-parameter \ + --name "helloSecureWorld" \ + --with-decryption + +Output:: + + { + "Parameter": { + "Name": "helloSecureWorld", + "Type": "SecureString", + "Value": "Good day sunshine", + "Version": 1, + "LastModifiedDate": 1530018761.888, + "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloSecureWorld" + } + } diff --git a/aws/dist/awscli/examples/ssm/get-parameters-by-path.rst b/aws/dist/awscli/examples/ssm/get-parameters-by-path.rst new file mode 100644 index 00000000..72c1bfbe --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-parameters-by-path.rst @@ -0,0 +1,31 @@ +**To list parameters in a specific path** + +This example lists parameters within a specific hierarchy. + +Command:: + + aws ssm get-parameters-by-path --path "/site/newyork/department/" + +Output:: + + { + "Parameters": [ + { + "Name": "/site/newyork/department/marketing", + "Type": "String", + "Value": "Floor 2", + "Version": 1, + "LastModifiedDate": 1530018761.888, + "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/site/newyork/department/marketing" + }, + { + "Name": "/site/newyork/department/infotech", + "Type": "String", + "Value": "Floor 3", + "Version": 1, + "LastModifiedDate": 1530018823.429, + "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter//site/newyork/department/infotech" + }, + ... + ] + } diff --git a/aws/dist/awscli/examples/ssm/get-parameters.rst b/aws/dist/awscli/examples/ssm/get-parameters.rst new file mode 100755 index 00000000..c3cfc739 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-parameters.rst @@ -0,0 +1,43 @@ +**To list the values for a parameter** + +This example lists the values for a parameter. + +Command:: + + aws ssm get-parameters --names "helloWorld" + +Output:: + + { + "Parameters": [ + { + "Name": "helloWorld", + "Type": "String", + "Value": "good day sunshine", + "Version": 1, + "LastModifiedDate": 1542308384.49, + "ARN": "arn:aws:ssm:us-east-1:123456789012:parameter/helloWorld" + } + ], + "InvalidParameters": [] + } + +To list the name and value of multiple parameters the --query argument can be used with a list of names. + +Command:: + + aws ssm get-parameters --names key1 key2 --query "Parameters[*].{Name:Name,Value:Value}" + +Output:: + + [ + { + "Name": "key1", + "Value": "value1" + }, + { + "Name": "key2", + "Value": "value2" + } + ] + diff --git a/aws/dist/awscli/examples/ssm/get-patch-baseline-for-patch-group.rst b/aws/dist/awscli/examples/ssm/get-patch-baseline-for-patch-group.rst new file mode 100755 index 00000000..fa6fadf2 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-patch-baseline-for-patch-group.rst @@ -0,0 +1,15 @@ +**To display the patch baseline for a patch group** + +This example displays the patch baseline for a patch group. + +Command:: + + aws ssm get-patch-baseline-for-patch-group --patch-group "DEV" + +Output:: + + { + "BaselineId": "pb-0123456789abcdef0", + "PatchGroup": "DEV", + "OperatingSystem": "WINDOWS" + } diff --git a/aws/dist/awscli/examples/ssm/get-patch-baseline.rst b/aws/dist/awscli/examples/ssm/get-patch-baseline.rst new file mode 100755 index 00000000..68b61223 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-patch-baseline.rst @@ -0,0 +1,50 @@ +**To display a patch baseline** + +This example displays the details for a patch baseline. + +Command:: + + aws ssm get-patch-baseline --baseline-id "pb-0123456789abcdef0" + +Output:: + + { + "BaselineId": "pb-0123456789abcdef0", + "Name": "WindowsPatching", + "OperatingSystem": "WINDOWS", + "GlobalFilters": { + "PatchFilters": [] + }, + "ApprovalRules": { + "PatchRules": [ + { + "PatchFilterGroup": { + "PatchFilters": [ + { + "Key": "PRODUCT", + "Values": [ + "WindowsServer2016" + ] + } + ] + }, + "ComplianceLevel": "CRITICAL", + "ApproveAfterDays": 0, + "EnableNonSecurity": false + } + ] + }, + "ApprovedPatches": [], + "ApprovedPatchesComplianceLevel": "UNSPECIFIED", + "ApprovedPatchesEnableNonSecurity": false, + "RejectedPatches": [], + "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", + "PatchGroups": [ + "QA", + "DEV" + ], + "CreatedDate": 1550244180.465, + "ModifiedDate": 1550244180.465, + "Description": "Patches for Windows Servers", + "Sources": [] + } diff --git a/aws/dist/awscli/examples/ssm/get-service-setting.rst b/aws/dist/awscli/examples/ssm/get-service-setting.rst new file mode 100644 index 00000000..b43ddec0 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/get-service-setting.rst @@ -0,0 +1,21 @@ +**To retrieve the service setting for Parameter Store throughput** + +The following ``get-service-setting`` This example retrieves the current service setting for Parameter Store throughput in the specified region. :: + + aws ssm get-service-setting \ + --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled + +Output:: + + { + "ServiceSetting": { + "SettingId": "/ssm/parameter-store/high-throughput-enabled", + "SettingValue": "false", + "LastModifiedDate": 1555532818.578, + "LastModifiedUser": "System", + "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", + "Status": "Default" + } + } + +For more information, see `Increasing Parameter Store Throughput `_ in the *AWS Systems Manager Users Guide*. diff --git a/aws/dist/awscli/examples/ssm/label-parameter-version.rst b/aws/dist/awscli/examples/ssm/label-parameter-version.rst new file mode 100644 index 00000000..388408e8 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/label-parameter-version.rst @@ -0,0 +1,21 @@ +**To add a label to latest version of a parameter** + +This example adds a label to the latest version of a parameter. + +Command:: + + aws ssm label-parameter-version --name "softwareversion" --labels "DevelopmentReady" + +Output:: + + { + "InvalidLabels": [] + } + +**To add a label to a specific version of a parameter** + +This example adds a label to the specified version of a parameter. + +Command:: + + aws ssm label-parameter-version --name "softwareversion" --parameter-version "2" --labels "ProductionReady" diff --git a/aws/dist/awscli/examples/ssm/list-association-versions.rst b/aws/dist/awscli/examples/ssm/list-association-versions.rst new file mode 100644 index 00000000..0bcc23c1 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-association-versions.rst @@ -0,0 +1,38 @@ +**To list all versions of an association for a specific association ID** + +This example lists all versions of the specified associations. + +Command:: + + aws ssm list-association-versions --association-id "8dfe3659-4309-493a-8755-0123456789ab" + +Output:: + + { + "AssociationVersions": [ + { + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "CreatedDate": 1550505536.726, + "Name": "AWS-UpdateSSMAgent", + "Parameters": { + "allowDowngrade": [ + "false" + ], + "version": [ + "" + ] + }, + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-1234567890abcdef0" + ] + } + ], + "ScheduleExpression": "cron(0 00 12 ? * SUN *)", + "AssociationName": "UpdateSSMAgent" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-associations.rst b/aws/dist/awscli/examples/ssm/list-associations.rst new file mode 100644 index 00000000..2aa5d88d --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-associations.rst @@ -0,0 +1,97 @@ +**To list your associations for a specific instance** + +This example lists all the associations for an instance. + +Command:: + + aws ssm list-associations --association-filter-list "key=InstanceId,value=i-1234567890abcdef0" + +Output:: + + { + "Associations": [ + { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-1234567890abcdef0", + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-016648b75dd622dab" + ] + } + ], + "Overview": { + "Status": "Pending", + "DetailedStatus": "Associated", + "AssociationStatusAggregatedCount": { + "Pending": 1 + } + }, + "ScheduleExpression": "cron(0 00 12 ? * SUN *)", + "AssociationName": "UpdateSSMAgent" + } + ] + } + +**To list your associations for a specific document** + +This example lists all associations for the specified document. + +Command:: + + aws ssm list-associations --association-filter-list "key=Name,value=AWS-UpdateSSMAgent" + +Output:: + + { + "Associations": [ + { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-1234567890abcdef0", + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "AssociationVersion": "1", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-1234567890abcdef0" + ] + } + ], + "LastExecutionDate": 1550505828.548, + "Overview": { + "Status": "Success", + "DetailedStatus": "Success", + "AssociationStatusAggregatedCount": { + "Success": 1 + } + }, + "ScheduleExpression": "cron(0 00 12 ? * SUN *)", + "AssociationName": "UpdateSSMAgent" + }, + { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-9876543210abcdef0", + "AssociationId": "fbc07ef7-b985-4684-b82b-0123456789ab", + "AssociationVersion": "1", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-9876543210abcdef0" + ] + } + ], + "LastExecutionDate": 1550507531.0, + "Overview": { + "Status": "Success", + "AssociationStatusAggregatedCount": { + "Success": 1 + } + } + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-command-invocations.rst b/aws/dist/awscli/examples/ssm/list-command-invocations.rst new file mode 100755 index 00000000..8cbc3c83 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-command-invocations.rst @@ -0,0 +1,92 @@ +**To list the invocations of a specific command** + +This example lists all the invocations of a command. + +Command:: + + aws ssm list-command-invocations --command-id "ef7fdfd8-9b57-4151-a15c-db9a12345678" --details + +Output:: + + { + "CommandInvocations": [ + { + "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", + "InstanceId": "i-1234567890abcdef0", + "InstanceName": "", + "Comment": "", + "DocumentName": "AWS-RunPowerShellScript", + "DocumentVersion": "1", + "RequestedDateTime": 1550172741.988, + "Status": "Success", + "StatusDetails": "Success", + "StandardOutputUrl": "", + "StandardErrorUrl": "", + "CommandPlugins": [ + { + "Name": "aws:runPowerShellScript", + "Status": "Success", + "StatusDetails": "Success", + "ResponseCode": 0, + "ResponseStartDateTime": 1550172742.696, + "ResponseFinishDateTime": 1550172743.245, + "Output": "HelloWorld\r\n", + "StandardOutputUrl": "", + "StandardErrorUrl": "", + "OutputS3Region": "us-east-1", + "OutputS3BucketName": "", + "OutputS3KeyPrefix": "" + } + ], + "ServiceRole": "", + "NotificationConfig": { + "NotificationArn": "", + "NotificationEvents": [], + "NotificationType": "" + }, + "CloudWatchOutputConfig": { + "CloudWatchLogGroupName": "", + "CloudWatchOutputEnabled": false + } + }, + { + "CommandId": "ef7fdfd8-9b57-4151-a15c-db9a12345678", + "InstanceId": "i-12345abcdef678901", + "InstanceName": "", + "Comment": "", + "DocumentName": "AWS-RunPowerShellScript", + "DocumentVersion": "1", + "RequestedDateTime": 1550172741.906, + "Status": "Success", + "StatusDetails": "Success", + "StandardOutputUrl": "", + "StandardErrorUrl": "", + "CommandPlugins": [ + { + "Name": "aws:runPowerShellScript", + "Status": "Success", + "StatusDetails": "Success", + "ResponseCode": 0, + "ResponseStartDateTime": 1550172742.291, + "ResponseFinishDateTime": 1550172742.694, + "Output": "HelloWorld\r\n", + "StandardOutputUrl": "", + "StandardErrorUrl": "", + "OutputS3Region": "us-east-1", + "OutputS3BucketName": "", + "OutputS3KeyPrefix": "" + } + ], + "ServiceRole": "", + "NotificationConfig": { + "NotificationArn": "", + "NotificationEvents": [], + "NotificationType": "" + }, + "CloudWatchOutputConfig": { + "CloudWatchLogGroupName": "", + "CloudWatchOutputEnabled": false + } + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-commands.rst b/aws/dist/awscli/examples/ssm/list-commands.rst new file mode 100755 index 00000000..3a30195e --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-commands.rst @@ -0,0 +1,63 @@ +**To list the commands requested by users of an account** + +This example lists all commands requested. + +Command:: + + aws ssm list-commands + +Output:: + + { + "Commands": [ + { + "Comment": "IP config", + "Status": "Success", + "MaxErrors": "0", + "Parameters": { + "commands": [ + "ifconfig" + ] + }, + "ExpiresAfter": 1487798019.876, + "ServiceRole": "", + "DocumentName": "AWS-RunShellScript", + "TargetCount": 1, + "OutputS3BucketName": "", + "NotificationConfig": { + "NotificationArn": "", + "NotificationEvents": [], + "NotificationType": "" + }, + "CompletedCount": 1, + "Targets": [], + "StatusDetails": "Success", + "ErrorCount": 0, + "OutputS3KeyPrefix": "", + "RequestedDateTime": 1487794419.876, + "CommandId": "0831e1a8-a1ac-4257-a1fd-c831b48c4107", + "InstanceIds": [ + "i-0cb2b964d3e14fd9f" + ], + "MaxConcurrency": "50" + }, + ... + } + ] + } + +**To get the status of a specific command** + +This example gets the status of a command. + +Command:: + + aws ssm list-commands --command-id "0831e1a8-a1ac-4257-a1fd-c831b48c4107" + +**To get the status of commands requested after a specific date** + +This example returns the details of commands requested after the specified date. + +Command:: + + aws ssm list-commands --filter "key=InvokedAfter,value=2019-02-01T00:00:00Z" \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/list-compliance-items.rst b/aws/dist/awscli/examples/ssm/list-compliance-items.rst new file mode 100644 index 00000000..2382b786 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-compliance-items.rst @@ -0,0 +1,66 @@ +**To list compliance items for a specific instance** + +This example lists all compliance items for the specified instance. + +Command:: + + aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" + +Output:: + + { + "ComplianceItems": [ + { + "ComplianceType": "Association", + "ResourceType": "ManagedInstance", + "ResourceId": "i-1234567890abcdef0", + "Id": "8dfe3659-4309-493a-8755-0123456789ab", + "Title": "", + "Status": "COMPLIANT", + "Severity": "UNSPECIFIED", + "ExecutionSummary": { + "ExecutionTime": 1550408470.0 + }, + "Details": { + "DocumentName": "AWS-GatherSoftwareInventory", + "DocumentVersion": "1" + } + }, + { + "ComplianceType": "Association", + "ResourceType": "ManagedInstance", + "ResourceId": "i-1234567890abcdef0", + "Id": "e4c2ed6d-516f-41aa-aa2a-0123456789ab", + "Title": "", + "Status": "COMPLIANT", + "Severity": "UNSPECIFIED", + "ExecutionSummary": { + "ExecutionTime": 1550508475.0 + }, + "Details": { + "DocumentName": "AWS-UpdateSSMAgent", + "DocumentVersion": "1" + } + }, + ... + ], + "NextToken": "--token string truncated--" + } + +**To list compliance items for a specific instance and association ID** + +This example lists all compliance items for the specified instance and association ID. + +Command:: + + aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ComplianceType,Values=Association,Type=EQUAL" "Key=Id,Values=e4c2ed6d-516f-41aa-aa2a-0123456789ab,Type=EQUAL" + + +**To list compliance items for a instance after a specific date and time** + +This example lists all compliance items for an instance after the specified date and time. + +Command:: + + aws ssm list-compliance-items --resource-ids "i-1234567890abcdef0" --resource-types "ManagedInstance" --filters "Key=ExecutionTime,Values=2019-02-18T16:00:00Z,Type=GREATER_THAN" + diff --git a/aws/dist/awscli/examples/ssm/list-compliance-summaries.rst b/aws/dist/awscli/examples/ssm/list-compliance-summaries.rst new file mode 100644 index 00000000..0bf32379 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-compliance-summaries.rst @@ -0,0 +1,75 @@ +**To list compliance summaries for all compliance types** + +This example lists compliance summaries for all compliance types in your account. + +Command:: + + aws ssm list-compliance-summaries + +Output:: + + { + "ComplianceSummaryItems": [ + { + "ComplianceType": "Association", + "CompliantSummary": { + "CompliantCount": 2, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 2 + } + }, + "NonCompliantSummary": { + "NonCompliantCount": 0, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 0 + } + } + }, + { + "ComplianceType": "Patch", + "CompliantSummary": { + "CompliantCount": 1, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 1 + } + }, + "NonCompliantSummary": { + "NonCompliantCount": 1, + "SeveritySummary": { + "CriticalCount": 1, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 0 + } + } + }, + ... + ], + "NextToken": "eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==" + } + +**To list compliance summaries for a specific compliance type** + +This example lists the compliance summary for the Patch compliance type. + +Command:: + + aws ssm list-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL" + diff --git a/aws/dist/awscli/examples/ssm/list-document-versions.rst b/aws/dist/awscli/examples/ssm/list-document-versions.rst new file mode 100755 index 00000000..d07da6ca --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-document-versions.rst @@ -0,0 +1,26 @@ +**To view details about existing document versions** + +This example lists all the versions for a document. + +Command:: + + aws ssm list-document-versions --name "patchWindowsAmi" + +Output:: + + { + "DocumentVersions": [ + { + "IsDefaultVersion": false, + "Name": "patchWindowsAmi", + "DocumentVersion": "2", + "CreatedDate": 1475799950.484 + }, + { + "IsDefaultVersion": false, + "Name": "patchWindowsAmi", + "DocumentVersion": "1", + "CreatedDate": 1475799931.064 + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-documents.rst b/aws/dist/awscli/examples/ssm/list-documents.rst new file mode 100644 index 00000000..604a6ac1 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-documents.rst @@ -0,0 +1,73 @@ +**To list all the configuration documents in your account** + +This example lists all the documents in your account. + +Command:: + + aws ssm list-documents + +Output:: + + { + "DocumentIdentifiers": [ + { + "Name": "AWS-ApplyPatchBaseline", + "PlatformTypes": [ + "Windows" + ], + "DocumentVersion": "1", + "DocumentType": "Command", + "Owner": "Amazon", + "SchemaVersion": "1.2" + }, + { + "Name": "AWS-ConfigureAWSPackage", + "PlatformTypes": [ + "Windows", + "Linux" + ], + "DocumentVersion": "1", + "DocumentType": "Command", + "Owner": "Amazon", + "SchemaVersion": "2.0" + }, + ... + ] + } + +**To list all Command configuration documents in your account that you own** + +This example lists all Command documents in your account that you own. + +Command:: + + aws ssm list-documents --document-filter-list key=Owner,value=Self key=DocumentType,value=Command + +Output:: + + { + "DocumentIdentifiers": [ + { + "Name": "RunPowerShellScript", + "PlatformTypes": [ + "Windows", + "Linux" + ], + "DocumentVersion": "1", + "DocumentType": "Command", + "Owner": "111222333444", + "SchemaVersion": "2.0" + }, + { + "Name": "RunShellScript", + "PlatformTypes": [ + "Linux" + ], + "DocumentVersion": "1", + "DocumentType": "Command", + "Owner": "111222333444", + "SchemaVersion": "1.2" + }, + ... + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/list-inventory-entries.rst b/aws/dist/awscli/examples/ssm/list-inventory-entries.rst new file mode 100755 index 00000000..d278d606 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-inventory-entries.rst @@ -0,0 +1,33 @@ +**To view specific inventory type entries for an instance** + +This example lists the inventory entries for the AWS:Application inventory type on a specific instance. + +Command:: + + aws ssm list-inventory-entries --instance-id "i-1234567890abcdef0" --type-name "AWS:Application" + +Output:: + + { + "TypeName": "AWS:Application", + "InstanceId": "i-1234567890abcdef0", + "SchemaVersion": "1.1", + "CaptureTime": "2019-02-15T12:17:55Z", + "Entries": [ + { + "Architecture": "i386", + "Name": "Amazon SSM Agent", + "PackageId": "{88a60be2-89a1-4df8-812a-80863c2a2b68}", + "Publisher": "Amazon Web Services", + "Version": "2.3.274.0" + }, + { + "Architecture": "x86_64", + "InstalledTime": "2018-05-03T13:42:34Z", + "Name": "AmazonCloudWatchAgent", + "Publisher": "", + "Version": "1.200442.0" + }, + ... + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-resource-compliance-summaries.rst b/aws/dist/awscli/examples/ssm/list-resource-compliance-summaries.rst new file mode 100644 index 00000000..b54063b2 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-resource-compliance-summaries.rst @@ -0,0 +1,90 @@ +**To list resource-level compliance summary counts** + +This example lists resource-level compliance summary counts. + +Command:: + + aws ssm list-resource-compliance-summaries + +Output:: + + { + "ResourceComplianceSummaryItems": [ + { + "ComplianceType": "Association", + "ResourceType": "ManagedInstance", + "ResourceId": "i-1234567890abcdef0", + "Status": "COMPLIANT", + "OverallSeverity": "UNSPECIFIED", + "ExecutionSummary": { + "ExecutionTime": 1550509273.0 + }, + "CompliantSummary": { + "CompliantCount": 2, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 2 + } + }, + "NonCompliantSummary": { + "NonCompliantCount": 0, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 0 + } + } + }, + { + "ComplianceType": "Patch", + "ResourceType": "ManagedInstance", + "ResourceId": "i-9876543210abcdef0", + "Status": "COMPLIANT", + "OverallSeverity": "UNSPECIFIED", + "ExecutionSummary": { + "ExecutionTime": 1550248550.0, + "ExecutionId": "7abb6378-a4a5-4f10-8312-0123456789ab", + "ExecutionType": "Command" + }, + "CompliantSummary": { + "CompliantCount": 397, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 397 + } + }, + "NonCompliantSummary": { + "NonCompliantCount": 0, + "SeveritySummary": { + "CriticalCount": 0, + "HighCount": 0, + "MediumCount": 0, + "LowCount": 0, + "InformationalCount": 0, + "UnspecifiedCount": 0 + } + } + } + ], + "NextToken": "--token string truncated--" + } + +**To list resource-level compliance summaries for a specific compliance type** + +This example lists resource-level compliance summaries for the Patch compliance type. + +Command:: + + aws ssm list-resource-compliance-summaries --filters "Key=ComplianceType,Values=Patch,Type=EQUAL" + diff --git a/aws/dist/awscli/examples/ssm/list-resource-data-sync.rst b/aws/dist/awscli/examples/ssm/list-resource-data-sync.rst new file mode 100644 index 00000000..2b871df6 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-resource-data-sync.rst @@ -0,0 +1,27 @@ +**To list your resource data sync configurations** + +This example retrieves information about your resource data sync configurations. + +Command:: + + aws ssm list-resource-data-sync --sync-name "ssm-resource-data-sync" + +Output:: + + { + "ResourceDataSyncItems": [ + { + "SyncName": "ssm-resource-data-sync", + "S3Destination": { + "BucketName": "ssm-resource-data-sync", + "SyncFormat": "JsonSerDe", + "Region": "us-east-1" + }, + "LastSyncTime": 1550261472.003, + "LastSuccessfulSyncTime": 1550261472.003, + "LastStatus": "Successful", + "SyncCreatedTime": 1543235736.72, + "LastSyncStatusMessage": "The sync was successfully completed" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/list-tags-for-resource.rst b/aws/dist/awscli/examples/ssm/list-tags-for-resource.rst new file mode 100755 index 00000000..1d19aae7 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/list-tags-for-resource.rst @@ -0,0 +1,18 @@ +**To list the tags for a patch baseline** + +This example lists the tags for a patch baseline. + +Command:: + + aws ssm list-tags-for-resource --resource-type "PatchBaseline" --resource-id "pb-0123456789abcdef0" + +Output:: + + { + "TagList": [ + { + "Key": "Project", + "Value": "Testing" + } + ] + } diff --git a/aws/dist/awscli/examples/ssm/modify-document-permission.rst b/aws/dist/awscli/examples/ssm/modify-document-permission.rst new file mode 100755 index 00000000..7dcf83fe --- /dev/null +++ b/aws/dist/awscli/examples/ssm/modify-document-permission.rst @@ -0,0 +1,7 @@ +**To modify the permissions for a document** + +This example modifies the permissions for a document. There is no output if the command succeeds. + +Command:: + + aws ssm modify-document-permission --name "RunShellScript" --permission-type "Share" --account-ids-to-add "All" diff --git a/aws/dist/awscli/examples/ssm/put-compliance-items.rst b/aws/dist/awscli/examples/ssm/put-compliance-items.rst new file mode 100644 index 00000000..cb693541 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/put-compliance-items.rst @@ -0,0 +1,8 @@ +**To register a compliance type and compliance details to a designated instance** + +This example registers the compliance type ``Custom:AVCheck`` to the specified managed instance. There is no output if the command succeeds. + +Command:: + + aws ssm put-compliance-items --resource-id "i-1234567890abcdef0" --resource-type "ManagedInstance" --compliance-type "Custom:AVCheck" --execution-summary "ExecutionTime=2019-02-18T16:00:00Z" --items "Id=Version2.0,Title=ScanHost,Severity=CRITICAL,Status=COMPLIANT" + diff --git a/aws/dist/awscli/examples/ssm/put-inventory.rst b/aws/dist/awscli/examples/ssm/put-inventory.rst new file mode 100755 index 00000000..a065ae42 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/put-inventory.rst @@ -0,0 +1,11 @@ +**To assign customer metadata to an instance** + +This example assigns rack location information to an instance. There is no output if the command succeeds. + +Command (Linux):: + + aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items '[{"TypeName": "Custom:RackInfo","SchemaVersion": "1.0","CaptureTime": "2019-01-22T10:01:01Z","Content":[{"RackLocation": "Bay B/Row C/Rack D/Shelf E"}]}]' + +Command (Windows):: + + aws ssm put-inventory --instance-id "i-016648b75dd622dab" --items "TypeName=Custom:RackInfo,SchemaVersion=1.0,CaptureTime=2019-01-22T10:01:01Z,Content=[{RackLocation='Bay B/Row C/Rack D/Shelf F'}]" \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/put-parameter.rst b/aws/dist/awscli/examples/ssm/put-parameter.rst new file mode 100755 index 00000000..5e0fc8f1 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/put-parameter.rst @@ -0,0 +1,93 @@ +**Example 1: To change a parameter value** + +The following ``put-parameter`` example changes the value of a parameter. :: + + aws ssm put-parameter \ + --name "welcome" \ + --type "String" \ + --value "good day sunshine" \ + --overwrite + +Output:: + + { + "Version": 2 + } + +For more information, see `About Parameters `__ in the *AWS Systems Manager User Guide*. + +**Example 2: To create an advanced parameter** + +The following ``put-parameter`` example creates an advanced parameter. :: + + aws ssm put-parameter \ + --name "advanced-parameter" \ + --value "This is an advanced parameter" \ + --type "String" \ + --tier Advanced + +Output:: + + { + "Version": 1 + } + +For more information, see `About Advanced Parameters `__ in the *AWS Systems Manager User Guide*. + +**Example 3: To convert a standard parameter to an advanced parameter** + +The following ``put-parameter`` example converts a existing standard parameter into an advanced parameter. :: + + aws ssm put-parameter \ + --name "convert" \ + --value "Test" \ + --type "String" \ + --tier Advanced \ + --overwrite + +Output:: + + { + "Version": 2 + } + +For more information, see `About Advanced Parameters `__ in the *AWS Systems Manager User Guide*. + +**Example 4: To create a parameter with a policy attached** + +The following ``put-parameter`` example creates an advanced parameter with a parameter policy attached. :: + + aws ssm put-parameter \ + --name "/Finance/Payroll/elixir3131" \ + --value "P@sSwW)rd" \ + --type "SecureString" \ + --tier Advanced \ + --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2019-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" + +Output:: + + { + "Version": 1 + } + +For more information, see `Working with Parameter Policies `__ in the *AWS Systems Manager User Guide*. + +**Example 5: To add a policy to an existing parameter** + +The following ``put-parameter`` example attaches a policy to an existing advanced parameter. :: + + aws ssm put-parameter \ + --name "/Finance/Payroll/elixir3131" \ + --value "N3wP@sSwW)rd" \ + --type "SecureString" \ + --tier Advanced \ + --policies "[{\"Type\":\"Expiration\",\"Version\":\"1.0\",\"Attributes\":{\"Timestamp\":\"2019-05-13T00:00:00.000Z\"}},{\"Type\":\"ExpirationNotification\",\"Version\":\"1.0\",\"Attributes\":{\"Before\":\"5\",\"Unit\":\"Days\"}},{\"Type\":\"NoChangeNotification\",\"Version\":\"1.0\",\"Attributes\":{\"After\":\"60\",\"Unit\":\"Days\"}}]" + --overwrite + +Output:: + + { + "Version": 2 + } + +For more information, see `Working with Parameter Policies `__ in the *AWS Systems Manager User Guide*. diff --git a/aws/dist/awscli/examples/ssm/register-default-patch-baseline.rst b/aws/dist/awscli/examples/ssm/register-default-patch-baseline.rst new file mode 100755 index 00000000..9d6585ee --- /dev/null +++ b/aws/dist/awscli/examples/ssm/register-default-patch-baseline.rst @@ -0,0 +1,13 @@ +**To set the default patch baseline** + +This example registers a patch baseline as the default patch baseline. + +Command:: + + aws ssm register-default-patch-baseline --baseline-id "pb-08b654cf9b9681f04" + +Output:: + + { + "BaselineId":"pb-08b654cf9b9681f04" + } diff --git a/aws/dist/awscli/examples/ssm/register-patch-baseline-for-patch-group.rst b/aws/dist/awscli/examples/ssm/register-patch-baseline-for-patch-group.rst new file mode 100755 index 00000000..b13218e9 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/register-patch-baseline-for-patch-group.rst @@ -0,0 +1,14 @@ +**To register a patch baseline for a patch group** + +This example registers a patch baseline for a patch group. + +Command:: + + aws ssm register-patch-baseline-for-patch-group --baseline-id "pb-045f10b4f382baeda" --patch-group "Production" + +Output:: + + { + "BaselineId": "pb-045f10b4f382baeda", + "PatchGroup": "Production" + } diff --git a/aws/dist/awscli/examples/ssm/register-target-with-maintenance-window.rst b/aws/dist/awscli/examples/ssm/register-target-with-maintenance-window.rst new file mode 100755 index 00000000..b46dfecd --- /dev/null +++ b/aws/dist/awscli/examples/ssm/register-target-with-maintenance-window.rst @@ -0,0 +1,29 @@ +**To register a single target with a Maintenance Window** + +This example registers an instance with a Maintenance Window. + +Command:: + + aws ssm register-target-with-maintenance-window --window-id "mw-ab12cd34ef56gh78" --target "Key=InstanceIds,Values=i-0000293ffd8c57862" --owner-information "Single instance" --resource-type "INSTANCE" + +Output:: + + { + "WindowTargetId":"1a2b3c4d-1a2b-1a2b-1a2b-1a2b3c4d-1a2" + } + +**To register multiple targets with a Maintenance Window** + +This example registers two instances with a Maintenance Window. + +Command:: + + aws ssm register-target-with-maintenance-window --window-id "mw-ab12cd34ef56gh78" --target "Key=InstanceIds,Values=i-0000293ffd8c57862,i-0cb2b964d3e14fd9f" --owner-information "Two instances in a list" --resource-type "INSTANCE" + +**To register a target with a Maintenance Window using EC2 tags** + +This example registers an instance with a Maintenance Window using EC2 tags. + +Command:: + + aws ssm register-target-with-maintenance-window --window-id "mw-06cf17cbefcb4bf4f" --targets "Key=tag:Environment,Values=Prod" "Key=Role,Values=Web" --owner-information "Production Web Servers" --resource-type "INSTANCE" diff --git a/aws/dist/awscli/examples/ssm/register-task-with-maintenance-window.rst b/aws/dist/awscli/examples/ssm/register-task-with-maintenance-window.rst new file mode 100755 index 00000000..0a1fbbea --- /dev/null +++ b/aws/dist/awscli/examples/ssm/register-task-with-maintenance-window.rst @@ -0,0 +1,64 @@ +**To register an Automation task with a Maintenance Window** + +This example registers an Automation task with a Maintenance Window that is targeted at an instance. + +Command:: + + aws ssm register-task-with-maintenance-window --window-id "mw-082dcd7649dee04e4" --targets Key=InstanceIds,Values=i-12345201220f8cd0d --task-arn AWS-RestartEC2Instance --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type AUTOMATION --task-invocation-parameters "{\"Automation\":{\"DocumentVersion\":\"\$LATEST\",\"Parameters\":{\"InstanceId\":[\"{{TARGET_ID}}\"]}}}" --priority 0 --max-concurrency 1 --max-errors 1 --name "AutomationExample" --description "Restarting EC2 Instance for maintenance" + +Output:: + + { + "WindowTaskId":"11144444-5555-6666-7777-88888888" + } + +**To register a Lambda task with a Maintenance Window** + +This example registers a Lambda task with a Maintenance Window that is targeted at an instance. + +Command:: + + aws ssm register-task-with-maintenance-window --window-id "mw-082dcd7649dee04e4" --targets Key=InstanceIds,Values=i-12344d305eea74171 --task-arn arn:aws:lambda:us-east-1:111222333444:function:SSMTestLAMBDA --service-role-arn arn:aws:iam::111222333444:role/SSM --task-type LAMBDA --task-invocation-parameters '{"Lambda":{"Payload":"{\"targetId\":\"{{TARGET_ID}}\",\"targetType\":\"{{TARGET_TYPE}}\"}","Qualifier":"$LATEST"}}' --priority 0 --max-concurrency 10 --max-errors 5 --name "Lambda_Example" --description "My Lambda Example" + +Output:: + + { + "WindowTaskId":"22244444-5555-6666-7777-88888888" + } + +**To register a Run Command task with a Maintenance Window** + +This example registers a Run Command task with a Maintenance Window that is targeted at an instance. + +Command:: + + aws ssm register-task-with-maintenance-window --window-id "mw-082dcd7649dee04e4" --targets "Key=InstanceIds,Values=i-12344d305eea74171" --service-role-arn "arn:aws:iam::111222333444:role/SSM" --task-type "RUN_COMMAND" --name "SSMInstallPowerShellModule" --task-arn "AWS-InstallPowerShellModule" --task-invocation-parameters "{\"RunCommand\":{\"Comment\":\"\",\"OutputS3BucketName\":\"runcommandlogs\",\"Parameters\":{\"commands\":[\"Get-Module -ListAvailable\"],\"executionTimeout\":[\"3600\"],\"source\":[\"https:\/\/gallery.technet.microsoft.com\/EZOut-33ae0fb7\/file\/110351\/1\/EZOut.zip\"],\"workingDirectory\":[\"\\\\\"]},\"TimeoutSeconds\":600}}" --max-concurrency 1 --max-errors 1 --priority 10 + +Output:: + + { + "WindowTaskId":"33344444-5555-6666-7777-88888888" + } + +**To register a Step Functions task with a Maintenance Window** + +This example registers a Step Functions task with a Maintenance Window that is targeted at an instance. + +Command:: + + aws ssm register-task-with-maintenance-window --window-id "mw-1234d787d641f11f3" --targets Key=WindowTargetIds,Values=12347414-69c3-49f8-95b8-ed2dcf045faa --task-arn arn:aws:states:us-east-1:111222333444:stateMachine:SSMTestStateMachine --service-role-arn arn:aws:iam::111222333444:role/MaintenanceWindows --task-type STEP_FUNCTIONS --task-invocation-parameters '{"StepFunctions":{"Input":"{\"instanceId\":\"{{TARGET_ID}}\"}"}}' --priority 0 --max-concurrency 10 --max-errors 5 --name "Step_Functions_Example" --description "My Step Functions Example" + +Output:: + + { + "WindowTaskId":"44444444-5555-6666-7777-88888888" + } + +**To register a task using a Maintenance Windows target ID** + +This example registers a task using a Maintenance Window target ID. The Maintenance Window target ID was in the output of the ``aws ssm register-target-with-maintenance-window`` command, otherwise you can retrieve it from the output of the ``aws ssm describe-maintenance-window-targets`` command. + +Command:: + + aws ssm register-task-with-maintenance-window --targets "Key=WindowTargetIds,Values=350d44e6-28cc-44e2-951f-4b2c985838f6" --task-arn "AWS-RunShellScript" --service-role-arn "arn:aws:iam::812345678901:role/MaintenanceWindowsRole" --window-id "mw-ab12cd34ef56gh78" --task-type "RUN_COMMAND" --task-parameters "{\"commands\":{\"Values\":[\"df\"]}}" --max-concurrency 1 --max-errors 1 --priority 10 + diff --git a/aws/dist/awscli/examples/ssm/remove-tags-from-resource.rst b/aws/dist/awscli/examples/ssm/remove-tags-from-resource.rst new file mode 100755 index 00000000..338aa485 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/remove-tags-from-resource.rst @@ -0,0 +1,7 @@ +**To remove a tag from a patch baseline** + +This example removes the tags from a patch baseline. There is no output if the command succeeds. + +Command:: + + aws ssm remove-tags-from-resource --resource-type "PatchBaseline" --resource-id "pb-0123456789abcdef0" --tag-keys "Project" diff --git a/aws/dist/awscli/examples/ssm/reset-service-setting.rst b/aws/dist/awscli/examples/ssm/reset-service-setting.rst new file mode 100644 index 00000000..3747e2ea --- /dev/null +++ b/aws/dist/awscli/examples/ssm/reset-service-setting.rst @@ -0,0 +1,22 @@ +**To reset the service setting for Parameter Store throughput** + +The following ``reset-service-setting`` example resets the service setting for Parameter Store throughput in the specified region to no longer use increased throughput. :: + + aws ssm reset-service-setting \ + --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled + +Output:: + + { + "ServiceSetting": { + "SettingId": "/ssm/parameter-store/high-throughput-enabled", + "SettingValue": "false", + "LastModifiedDate": 1555532818.578, + "LastModifiedUser": "System", + "ARN": "arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled", + "Status": "Default" + } + } + +For more information, see `Increasing Parameter Store Throughput `_ in the *AWS Systems Manager User Guide*. + diff --git a/aws/dist/awscli/examples/ssm/resume-session.rst b/aws/dist/awscli/examples/ssm/resume-session.rst new file mode 100644 index 00000000..7faa0042 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/resume-session.rst @@ -0,0 +1,20 @@ +**To resume a Session Manager session** + +This example resumes a Session Manager session with an instance after it has been disconnected. + +Note that this interactive command requires the Session Manager plugin to be installed on the client machine making the call. For more information, see `Install the Session Manager Plugin for the AWS CLI`_ in the *AWS Systems Manager User Guide*. + +.. _`Install the Session Manager Plugin for the AWS CLI`: http://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html + +Command:: + + aws ssm resume-session -session-id Dan-07a16060613c408b5 + +Output:: + + { + "SessionId": "Dan-07a16060613c408b5", + "TokenValue": "AAEAAVbTGsaOnyvcUoNGqifbv5r/8lgxuQljCuY8qVcvOnoBAAAAAFxtd3jIXAFUUXGTJ7zF/AWJPwDviOlF5p3dlAgrqVIVO6IEXhkHLz0/1gXKRKEME71E6TLOplLDJAMZ+kREejkZu4c5AxMkrQjMF+gtHP1bYJKTwtHQd1wjulPLexO8SHl7g5R/wekrj6WsDUpnEegFBfGftpAIz2GXQVfTJXKfkc5qepQ11C11DOIT2dozOqXgHwfQHfAKLErM5dWDZqKwyT1Z3iw7unQdm3p5qsbrugiOZ7CRANTE+ihfGa6MEJJ97Jmat/a2TspEnOjNn9Mvu5iwXIW2yCvWZrGUj+/QI5Xr7s1XJBEnSKR54o4fN0GV9RWl0RZsZm1m1ki0JJtiwwgZ", + "StreamUrl": "wss://ssmmessages.us-east-1.amazonaws.com/v1/data-channel/Dan-07a16060613c408b5?role=publish_subscribe" + } + diff --git a/aws/dist/awscli/examples/ssm/send-automation-signal.rst b/aws/dist/awscli/examples/ssm/send-automation-signal.rst new file mode 100644 index 00000000..35199c57 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/send-automation-signal.rst @@ -0,0 +1,40 @@ +**To send a signal to an Automation execution** + +This example sends the Approve signal to an Automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Approve" + +**To send an approve signal with a comment to an Automation execution** + +This example sends the Approve signal with a comment to an Automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Approve" --payload "Comment=Approved" + +**To start an Automation step** + +This example starts the specified step in an Automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "StartStep" --payload "StepName=stopInstances" + +**To resume an Automation step** + +This example resumes the specified step in an Automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "Resume" --payload "StepName=stopInstances" + +**To stop an Automation step** + +This example stops the specified step that is currently in progress within an Automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm send-automation-signal --automation-execution-id 4105a4fc-f944-11e6-9d32-0a1b2c3d495h --signal-type "StopStep" --payload "StepExecutionId=35de5ba9-e3de-45ae-8c95-0123456789ab" + diff --git a/aws/dist/awscli/examples/ssm/send-command.rst b/aws/dist/awscli/examples/ssm/send-command.rst new file mode 100755 index 00000000..2a1a6c41 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/send-command.rst @@ -0,0 +1,113 @@ +**Example 1: To run a command on one or more remote instances** + +The following ``send-command`` example runs an ``echo`` command on a target instance. :: + + aws ssm send-command \ + --document-name "AWS-RunShellScript" \ + --parameters commands=["echo HelloWorld"] \ + --targets "Key=instanceids,Values=i-1234567890abcdef0" \ + --comment "echo HelloWorld" + +Output:: + + { + "Command": { + "CommandId": "92853adf-ba41-4cd6-9a88-142d119c083d", + "DocumentName": "AWS-RunShellScript", + "DocumentVersion": "", + "Comment": "echo HelloWorld", + "ExpiresAfter": 1550181014.717, + "Parameters": { + "commands": [ + "echo HelloWorld" + ] + }, + "InstanceIds": [ + "i-0f00f008a2dcbefe2" + ], + "Targets": [], + "RequestedDateTime": 1550173814.717, + "Status": "Pending", + "StatusDetails": "Pending", + "OutputS3BucketName": "", + "OutputS3KeyPrefix": "", + "MaxConcurrency": "50", + "MaxErrors": "0", + "TargetCount": 1, + "CompletedCount": 0, + "ErrorCount": 0, + "DeliveryTimedOutCount": 0, + "ServiceRole": "", + "NotificationConfig": { + "NotificationArn": "", + "NotificationEvents": [], + "NotificationType": "" + }, + "CloudWatchOutputConfig": { + "CloudWatchLogGroupName": "", + "CloudWatchOutputEnabled": false + } + } + } + +**Example 2: To get IP information about an instance** + +The following ``send-command`` example retrieves the IP information about an instance. :: + + aws ssm send-command \ + --instance-ids "i-1234567890abcdef0" \ + --document-name "AWS-RunShellScript" \ + --comment "IP config" \ + --parameters "commands=ifconfig" + +**Example 3: To runs a command on instances with specific tags** + +The following ``send-command`` example runs a command on instances that have the tag key "ENV" and the value "Dev". :: + + aws ssm send-command \ + --targets "Key=tag:ENV,Values=Dev" \ + --document-name "AWS-RunShellScript" \ + --parameters "commands=ifconfig" + +**Example 4: To runs a command that sends SNS Notifications** + +The following ``send-command`` example runs a command that sends SNS notifications for all notification events and the Command notification type. :: + + aws ssm send-command \ + --instance-ids "i-1234567890abcdef0" \ + --document-name "AWS-RunShellScript" \ + --comment "IP config" \ + --parameters "commands=ifconfig" \ + --service-role-arn "arn:aws:iam::123456789012:role/SNS_Role" \ + --notification-config "NotificationArn=arn:aws:sns:us-east-1:123456789012:SNSTopicName,NotificationEvents=All,NotificationType=Command" + +**Example 5: To run a command that outputs to S3 and CloudWatch** + +The following ``send-command`` example runs a command that outputs command details to an S3 bucket and to a CloudWatch Logs Group. :: + + aws ssm send-command \ + --instance-ids "i-1234567890abcdef0" \ + --document-name "AWS-RunShellScript" \ + --comment "IP config" \ + --parameters "commands=ifconfig" \ + --output-s3-bucket-name "s3-bucket-name" \ + --output-s3-key-prefix "runcommand" \ + --cloud-watch-output-config "CloudWatchOutputEnabled=true,CloudWatchLogGroupName=CWLGroupName" + +**Example 6: To run commands on multiple instances with different tags** + +The follwoing ``send-command`` example runs a command on instances with two different tag keys and values. :: + + aws ssm send-command \ + --document-name "AWS-RunPowerShellScript" \ + --parameters commands=["echo helloWorld"] \ + --targets Key=tag:Env,Values=Dev Key=tag:Role,Values=WebServers + +**Example 7: To target multiple instances with the same tag key** + +The following ``send-command`` example runs a command on instances that have the same tag key but with different values. :: + + aws ssm send-command \ + --document-name "AWS-RunPowerShellScript" \ + --parameters commands=["echo helloWorld"] \ + --targets Key=tag:Env,Values=Dev,Test diff --git a/aws/dist/awscli/examples/ssm/start-associations-once.rst b/aws/dist/awscli/examples/ssm/start-associations-once.rst new file mode 100644 index 00000000..7b82d0de --- /dev/null +++ b/aws/dist/awscli/examples/ssm/start-associations-once.rst @@ -0,0 +1,8 @@ +**To execute an association immediately and only one time** + +This example executes the specified association immediately and only once. There is no output if the command succeeds. + +Command:: + + aws ssm start-associations-once --association-id "8dfe3659-4309-493a-8755-0123456789ab" + diff --git a/aws/dist/awscli/examples/ssm/start-automation-execution.rst b/aws/dist/awscli/examples/ssm/start-automation-execution.rst new file mode 100755 index 00000000..70b853c3 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/start-automation-execution.rst @@ -0,0 +1,27 @@ +**To initiate the execution of an Automation document** + +This example executes a document. + +Command:: + + aws ssm start-automation-execution --document-name "AWS-UpdateLinuxAmi" --parameters "AutomationAssumeRole=arn:aws:iam::123456789012:role/SSMAutomationRole,SourceAmiId=ami-f1730123,IamInstanceProfileName=EC2InstanceRole" + +Output:: + + { + "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2c3d495h" + } + +**To initiate the execution of an Automation document in multiple accounts** + +This example restarts Amazon EC2 instances in the 1a2b3c4d5e6f7g8h and a1b2c3d4e5f6h7 accounts, which are located in the us-east-2 and us-west-1 Regions. The instances must be tagged with Env-PROD. + +Command:: + + aws ssm start-automation-execution --document-name AWS-RestartEC2Instance --parameters AutomationAssumeRole=arn:aws:iam::123456789012:role/AWS-SystemsManager-AutomationAdministrationRole --target-parameter-name InstanceId --targets Key=tag:Env,Values=PROD --target-locations Accounts=1a2b3c4d5e6f7g8h,a1b2c3d4e5f6h7,Regions=us-east-2,us-west-1,ExecutionRoleName=AWS-SystemsManager-AutomationExecutionRole + +Output:: + + { + "AutomationExecutionId": "4105a4fc-f944-11e6-9d32-0a1b2c3d495h" + } diff --git a/aws/dist/awscli/examples/ssm/start-session.rst b/aws/dist/awscli/examples/ssm/start-session.rst new file mode 100644 index 00000000..a60fc889 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/start-session.rst @@ -0,0 +1,16 @@ +**To start a Session Manager session** + +This example establishes a connection with an instance for a Session Manager session. + +Note that this interactive command requires the Session Manager plugin to be installed on the client machine making the call. For more information, see `Install the Session Manager Plugin for the AWS CLI`_ in the *AWS Systems Manager User Guide*. + +.. _`Install the Session Manager Plugin for the AWS CLI`: http://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html + +Command:: + + aws ssm start-session --target "i-1234567890abcdef0" + +Output:: + + Starting session with SessionId: Erik-07a16060613c408b5 + diff --git a/aws/dist/awscli/examples/ssm/stop-automation-execution.rst b/aws/dist/awscli/examples/ssm/stop-automation-execution.rst new file mode 100755 index 00000000..0b3ecf47 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/stop-automation-execution.rst @@ -0,0 +1,15 @@ +**To stop the execution of an Automation document** + +This example stops an automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2c3d495h" + +**To cancel the execution of an Automation document** + +This example cancels an automation execution. There is no output if the command succeeds. + +Command:: + + aws ssm stop-automation-execution --automation-execution-id "4105a4fc-f944-11e6-9d32-0a1b2c3d495h" --type "Cancel" diff --git a/aws/dist/awscli/examples/ssm/terminate-session.rst b/aws/dist/awscli/examples/ssm/terminate-session.rst new file mode 100644 index 00000000..842bca16 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/terminate-session.rst @@ -0,0 +1,13 @@ +**To end a Session Manager session** + +This example permanently ends a session that was created by the user "Bob" and closes the data connection between the Session Manager client and SSM Agent on the instance. + +Command:: + + aws ssm terminate-session --session-id "Bob-07a16060613c408b5" + +Output:: + + { + "SessionId": "Bob-07a16060613c408b5" + } diff --git a/aws/dist/awscli/examples/ssm/update-association-status.rst b/aws/dist/awscli/examples/ssm/update-association-status.rst new file mode 100644 index 00000000..470f4616 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-association-status.rst @@ -0,0 +1,43 @@ +**To update the association status** + +This example updates the association status of the association between an instance and a document. + +Command:: + + aws ssm update-association-status --name "AWS-UpdateSSMAgent" --instance-id "i-1234567890abcdef0" --association-status "Date=1424421071.939,Name=Pending,Message=temp_status_change,AdditionalInfo=Additional-Config-Needed" + +Output:: + + { + "AssociationDescription": { + "Name": "AWS-UpdateSSMAgent", + "InstanceId": "i-1234567890abcdef0", + "AssociationVersion": "1", + "Date": 1550507529.604, + "LastUpdateAssociationDate": 1550507806.974, + "Status": { + "Date": 1424421071.0, + "Name": "Pending", + "Message": "temp_status_change", + "AdditionalInfo": "Additional-Config-Needed" + }, + "Overview": { + "Status": "Success", + "AssociationStatusAggregatedCount": { + "Success": 1 + } + }, + "DocumentVersion": "$DEFAULT", + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "Targets": [ + { + "Key": "InstanceIds", + "Values": [ + "i-1234567890abcdef0" + ] + } + ], + "LastExecutionDate": 1550507808.0, + "LastSuccessfulExecutionDate": 1550507808.0 + } + } diff --git a/aws/dist/awscli/examples/ssm/update-association.rst b/aws/dist/awscli/examples/ssm/update-association.rst new file mode 100755 index 00000000..3cfcf1d2 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-association.rst @@ -0,0 +1,43 @@ +**To update a document association** + +This example updates an association with a new document version. + +Command:: + + aws ssm update-association --association-id "8dfe3659-4309-493a-8755-0123456789ab" --document-version "\$LATEST" + +Output:: + + { + "AssociationDescription": { + "Name": "AWS-UpdateSSMAgent", + "AssociationVersion": "2", + "Date": 1550508093.293, + "LastUpdateAssociationDate": 1550508106.596, + "Overview": { + "Status": "Pending", + "DetailedStatus": "Creating" + }, + "DocumentVersion": "$LATEST", + "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab", + "Targets": [ + { + "Key": "tag:Name", + "Values": [ + "Linux" + ] + } + ], + "LastExecutionDate": 1550508094.879, + "LastSuccessfulExecutionDate": 1550508094.879 + } + } + +**To update the schedule expression of an association** + +This example updates the schedule expression for the specified association. + +Command:: + + aws ssm update-association --association-id "8dfe3659-4309-493a-8755-0123456789ab" --schedule-expression "cron(0 0 0/4 1/1 * ? *)" + diff --git a/aws/dist/awscli/examples/ssm/update-document-default-version.rst b/aws/dist/awscli/examples/ssm/update-document-default-version.rst new file mode 100755 index 00000000..30455a3a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-document-default-version.rst @@ -0,0 +1,7 @@ +**To update the default version of a Document** + +This updates the default version of a document. There is no output if the command succeeds. + +Command:: + + aws ssm update-document-default-version --name "patchWindowsAmi" --document-version "2" diff --git a/aws/dist/awscli/examples/ssm/update-document.rst b/aws/dist/awscli/examples/ssm/update-document.rst new file mode 100755 index 00000000..41be8a3a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-document.rst @@ -0,0 +1,48 @@ +**To create a new version of a document** + +The following ``update-document`` example creates a new version of a document when run on a Windows computer. The document specified by ``--document`` must be in JSON format. Note that ``file://`` must be referenced followed by the path of the content file. Because of the ``$`` at the beginning of the ``--document-version`` parameter, On Windows you must surround the value with double quotes. On Linux, MacOS, or at a PowerShell prompt, you must surround the value with single quotes. + +**Windows version**:: + + aws ssm update-document \ + --name "RunShellScript" \ + --content "file://RunShellScript.json" \ + --document-version "$LATEST" + +**Linux/Mac version**:: + + aws ssm update-document \ + --name "RunShellScript" \ + --content "file://RunShellScript.json" \ + --document-version '$LATEST' + +Output:: + + { + "DocumentDescription": { + "Status": "Updating", + "Hash": "f775e5df4904c6fa46686c4722fae9de1950dace25cd9608ff8d622046b68d9b", + "Name": "RunShellScript", + "Parameters": [ + { + "Type": "StringList", + "Name": "commands", + "Description": "(Required) Specify a shell script or a command to run." + } + ], + "DocumentType": "Command", + "PlatformTypes": [ + "Linux" + ], + "DocumentVersion": "2", + "HashType": "Sha256", + "CreatedDate": 1487899655.152, + "Owner": "809632081692", + "SchemaVersion": "2.0", + "DefaultVersion": "1", + "LatestVersion": "2", + "Description": "Run an updated script" + } + } + + diff --git a/aws/dist/awscli/examples/ssm/update-maintenance-window-target.rst b/aws/dist/awscli/examples/ssm/update-maintenance-window-target.rst new file mode 100644 index 00000000..b4a4c1be --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-maintenance-window-target.rst @@ -0,0 +1,26 @@ +**To update a Maintenance Window target** + +This example updates the name of a Maintenance Window target. + +Command:: + + aws ssm update-maintenance-window-target --window-id "mw-0c5ed765acEXAMPLE" --window-target-id "57e8344e-fe64-4023-8191-6bf05EXAMPLE" --name "NewName" + +Output:: + + { + "Description": "", + "OwnerInformation": "", + "WindowTargetId": "57e8344e-fe64-4023-8191-6bf05EXAMPLE", + "WindowId": "mw-0c5ed765acEXAMPLE", + "Targets": [ + { + "Values": [ + "i-1234567890EXAMPLE" + ], + "Key": "InstanceIds" + } + ], + "Name": "NewName" + } + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/update-maintenance-window-task.rst b/aws/dist/awscli/examples/ssm/update-maintenance-window-task.rst new file mode 100644 index 00000000..e108d1ee --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-maintenance-window-task.rst @@ -0,0 +1,40 @@ +**To update a Maintenance Window task** + +This example updates the service role for a Maintenance Window task. + +Command:: + + aws ssm update-maintenance-window-task --window-id "mw-0c5ed765acEXAMPLE" --window-task-id "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE" --service-role-arn "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM" + +Output:: + + { + "ServiceRoleArn": "arn:aws:iam::111222333444:role/aws-service-role/ssm.amazonaws.com/AWSServiceRoleForAmazonSSM", + "MaxErrors": "1", + "TaskArn": "AWS-UpdateEC2Config", + "MaxConcurrency": "1", + "WindowTaskId": "23d3809e-9fbe-4ddf-b41a-b49d7EXAMPLE", + "TaskParameters": {}, + "Priority": 1, + "TaskInvocationParameters": { + "RunCommand": { + "TimeoutSeconds": 600, + "Parameters": { + "allowDowngrade": [ + "false" + ] + } + } + }, + "WindowId": "mw-0c5ed765acEXAMPLE", + "Description": "UpdateEC2Config", + "Targets": [ + { + "Values": [ + "57e8344e-fe64-4023-8191-6bf05EXAMPLE" + ], + "Key": "WindowTargetIds" + } + ], + "Name": "UpdateEC2Config" + } diff --git a/aws/dist/awscli/examples/ssm/update-maintenance-window.rst b/aws/dist/awscli/examples/ssm/update-maintenance-window.rst new file mode 100755 index 00000000..e27bea2a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-maintenance-window.rst @@ -0,0 +1,36 @@ +**To update a Maintenance Window** + +This example updates the name of a Maintenance Window. + +Command:: + + aws ssm update-maintenance-window --window-id "mw-1a2b3c4d5e6f7g8h9" --name "My-Renamed-MW" + +Output:: + + { + "Cutoff": 1, + "Name": "My-Renamed-MW", + "Schedule": "cron(0 16 ? * TUE *)", + "Enabled": true, + "AllowUnassociatedTargets": true, + "WindowId": "mw-1a2b3c4d5e6f7g8h9", + "Duration": 4 + } + +**To enable a Maintenance Window** + +This example enables a Maintenance Window. + +Command:: + + aws ssm update-maintenance-window --window-id "mw-1a2b3c4d5e6f7g8h9" --enabled + +**To disable a Maintenance Window** + +This example disables a Maintenance Window. + +Command:: + + aws ssm update-maintenance-window --window-id "mw-1a2b3c4d5e6f7g8h9" --no-enabled + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/update-managed-instance-role.rst b/aws/dist/awscli/examples/ssm/update-managed-instance-role.rst new file mode 100755 index 00000000..bd36551a --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-managed-instance-role.rst @@ -0,0 +1,7 @@ +**To update the role of a managed instance** + +This example updates the role of a managed instance. There is no output if the command succeeds. + +Command:: + + aws ssm update-managed-instance-role --instance-id "mi-08ab247cdf1046573" --iam-role "AutomationRole" diff --git a/aws/dist/awscli/examples/ssm/update-patch-baseline.rst b/aws/dist/awscli/examples/ssm/update-patch-baseline.rst new file mode 100755 index 00000000..b8377086 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-patch-baseline.rst @@ -0,0 +1,60 @@ +**To update a patch baseline** + +This example adds two patches as rejected and one patch as approved to a patch baseline. + +Command:: + + aws ssm update-patch-baseline --baseline-id "pb-0123456789abcdef0" --rejected-patches "KB2032276" "MS10-048" --approved-patches "KB2124261" + +Output:: + + { + "BaselineId": "pb-0123456789abcdef0", + "Name": "WindowsPatching", + "OperatingSystem": "WINDOWS", + "GlobalFilters": { + "PatchFilters": [] + }, + "ApprovalRules": { + "PatchRules": [ + { + "PatchFilterGroup": { + "PatchFilters": [ + { + "Key": "PRODUCT", + "Values": [ + "WindowsServer2016" + ] + } + ] + }, + "ComplianceLevel": "CRITICAL", + "ApproveAfterDays": 0, + "EnableNonSecurity": false + } + ] + }, + "ApprovedPatches": [ + "KB2124261" + ], + "ApprovedPatchesComplianceLevel": "UNSPECIFIED", + "ApprovedPatchesEnableNonSecurity": false, + "RejectedPatches": [ + "KB2032276", + "MS10-048" + ], + "RejectedPatchesAction": "ALLOW_AS_DEPENDENCY", + "CreatedDate": 1550244180.465, + "ModifiedDate": 1550244180.465, + "Description": "Patches for Windows Servers", + "Sources": [] + } + +**To rename a patch baseline** + +This example renames a patch baseline. + +Command:: + + aws ssm update-patch-baseline --baseline-id "pb-0713accee01234567" --name "Windows-Server-2012-R2-Important-and-Critical-Security-Updates" + \ No newline at end of file diff --git a/aws/dist/awscli/examples/ssm/update-service-setting.rst b/aws/dist/awscli/examples/ssm/update-service-setting.rst new file mode 100644 index 00000000..7edaf860 --- /dev/null +++ b/aws/dist/awscli/examples/ssm/update-service-setting.rst @@ -0,0 +1,12 @@ +**To update the service setting for Parameter Store throughput** + +The following ``update-service-setting`` example updates the current service setting for Parameter Store throughput in the specified region to use increased throughput. :: + + aws ssm update-service-setting \ + --setting-id arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled \ + --setting-value true + +This command produces no output. + +For more information, see `Increasing Parameter Store Throughput `_ in the *AWS Systems Manager User Guide*. + diff --git a/aws/dist/awscli/examples/storagegateway/describe-gateway-information.rst b/aws/dist/awscli/examples/storagegateway/describe-gateway-information.rst new file mode 100644 index 00000000..79f0e3aa --- /dev/null +++ b/aws/dist/awscli/examples/storagegateway/describe-gateway-information.rst @@ -0,0 +1,11 @@ +**To describe a gateway** + +The following ``describe-gateway-information`` command returns metadata about the specified gateway. +To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in the command. + +This examples specifies a gateway with the id ``sgw-12A3456B`` in account ``123456789012``:: + + aws storagegateway describe-gateway-information --gateway-arn "arn:aws:storagegateway:us-west-2:123456789012:gateway/sgw-12A3456B" + +This command outputs a JSON block that contains metadata about about the gateway such as its name, +network interfaces, configured time zone, and the state (whether the gateway is running or not). diff --git a/aws/dist/awscli/examples/storagegateway/list-gateways.rst b/aws/dist/awscli/examples/storagegateway/list-gateways.rst new file mode 100644 index 00000000..26bcc2df --- /dev/null +++ b/aws/dist/awscli/examples/storagegateway/list-gateways.rst @@ -0,0 +1,7 @@ +**To list gateways for an account** + +The following ``list-gateways`` command lists all the gateways defined for an account:: + + aws storagegateway list-gateways + +This command outputs a JSON block that contains a list of gateway Amazon Resource Names (ARNs). diff --git a/aws/dist/awscli/examples/storagegateway/list-volumes.rst b/aws/dist/awscli/examples/storagegateway/list-volumes.rst new file mode 100644 index 00000000..f9ce3eaf --- /dev/null +++ b/aws/dist/awscli/examples/storagegateway/list-volumes.rst @@ -0,0 +1,10 @@ +**To list the volumes configured for a gateway** + +The following ``list-volumes`` command returns a list of volumes configured for the specified gateway. +To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in the command. + +This examples specifies a gateway with the id ``sgw-12A3456B`` in account ``123456789012``:: + + aws storagegateway list-volumes --gateway-arn "arn:aws:storagegateway:us-west-2:123456789012:gateway/sgw-12A3456B" + +This command outputs a JSON block that a list of volumes that includes the type and ARN for each volume. diff --git a/aws/dist/awscli/examples/sts/assume-role.rst b/aws/dist/awscli/examples/sts/assume-role.rst new file mode 100644 index 00000000..18be67c5 --- /dev/null +++ b/aws/dist/awscli/examples/sts/assume-role.rst @@ -0,0 +1,22 @@ +To assume a role:: + + aws sts assume-role --role-arn arn:aws:iam::123456789012:role/xaccounts3access --role-session-name s3-access-example + +The output of the command contains an access key, secret key, and session token that you can use to authenticate to AWS:: + + { + "AssumedRoleUser": { + "AssumedRoleId": "AROA3XFRBF535PLBIFPI4:s3-access-example", + "Arn": "arn:aws:sts::123456789012:assumed-role/xaccounts3access/s3-access-example" + }, + "Credentials": { + "SecretAccessKey": "9drTJvcXLB89EXAMPLELB8923FB892xMFI", + "SessionToken": "AQoXdzELDDY//////////wEaoAK1wvxJY12r2IrDFT2IvAzTCn3zHoZ7YNtpiQLF0MqZye/qwjzP2iEXAMPLEbw/m3hsj8VBTkPORGvr9jM5sgP+w9IZWZnU+LWhmg+a5fDi2oTGUYcdg9uexQ4mtCHIHfi4citgqZTgco40Yqr4lIlo4V2b2Dyauk0eYFNebHtYlFVgAUj+7Indz3LU0aTWk1WKIjHmmMCIoTkyYp/k7kUG7moeEYKSitwQIi6Gjn+nyzM+PtoA3685ixzv0R7i5rjQi0YE0lf1oeie3bDiNHncmzosRM6SFiPzSvp6h/32xQuZsjcypmwsPSDtTPYcs0+YN/8BRi2/IcrxSpnWEXAMPLEXSDFTAQAM6Dl9zR0tXoybnlrZIwMLlMi1Kcgo5OytwU=", + "Expiration": "2016-03-15T00:05:07Z", + "AccessKeyId": "ASIAJEXAMPLEXEG2JICEA" + } + } + +For AWS CLI use, you can set up a named profile associated with a role. When you use the profile, the AWS CLI will call assume-role and manage credentials for you. See `Assuming a Role`_ in the *AWS CLI User Guide* for instructions. + +.. _`Assuming a Role`: http://docs.aws.amazon.com/cli/latest/userguide/cli-roles.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/swf/count-closed-workflow-executions.rst b/aws/dist/awscli/examples/swf/count-closed-workflow-executions.rst new file mode 100644 index 00000000..5cdd4e59 --- /dev/null +++ b/aws/dist/awscli/examples/swf/count-closed-workflow-executions.rst @@ -0,0 +1,36 @@ +Counting Closed Workflow Executions +----------------------------------- + +You can use ``swf count-closed-workflow-executions`` to retrieve the number of closed workflow executions for a given +domain. You can specify filters to count specific classes of executions. + +The ``--domain`` and *either* ``--close-time-filter`` or ``--start-time-filter`` arguments are required. All other +arguments are optional. + +Here is a basic example:: + + aws swf count-closed-workflow-executions --domain DataFrobtzz --close-time-filter "{ \"latestDate\" : 1377129600, \"oldestDate\" : 1370044800 }" + +Result:: + + { + "count": 2, + "truncated": false + } + +If "truncated" is ``true``, then "count" represents the maximum number that can be returned by Amazon SWF. Any further +results are truncated. + +To reduce the number of results returned, you can: + +- modify the ``--close-time-filter`` or ``--start-time-filter`` values to narrow the time range that is searched. Each + of these is mutually exclusive: You can specify *only one of these* in a request. + +- use the ``--close-status-filter``, ``--execution-filter``, ``--tag-filter`` or ``--type-filter`` arguments to further + filter the results. However, these arguments are also mutually exclusive. + +See Also +-------- + +- `CountClosedWorkflowExecutions `_ in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/count-open-workflow-executions.rst b/aws/dist/awscli/examples/swf/count-open-workflow-executions.rst new file mode 100644 index 00000000..32f10701 --- /dev/null +++ b/aws/dist/awscli/examples/swf/count-open-workflow-executions.rst @@ -0,0 +1,32 @@ +**Counting Open Workflow Executions** + +You can use ``swf count-open-workflow-executions`` to retrieve the number of open workflow executions for a given +domain. You can specify filters to count specific classes of executions. + +The ``--domain`` and ``--start-time-filter`` arguments are required. All other arguments are optional. + +Here is a basic example:: + + aws swf count-open-workflow-executions --domain DataFrobtzz --start-time-filter "{ \"latestDate\" : 1377129600, \"oldestDate\" : 1370044800 }" + +Result:: + + { + "count": 4, + "truncated": false + } + +If "truncated" is ``true``, then "count" represents the maximum number that can be returned by Amazon SWF. Any further +results are truncated. + +To reduce the number of results returned, you can: + +- modify the ``--start-time-filter`` values to narrow the time range that is searched. + +- use the ``--close-status-filter``, ``--execution-filter``, ``--tag-filter`` or ``--type-filter`` arguments to further + filter the results. Each of these is mutually exclusive: You can specify *only one of these* in a request. + +For more information, see `CountOpenWorkflowExecutions`_ in the *Amazon Simple Workflow Service API Reference* + +.. _`CountOpenWorkflowExecutions`: http://docs.aws.amazon.com/amazonswf/latest/apireference/API_CountOpenWorkflowExecutions.html + diff --git a/aws/dist/awscli/examples/swf/deprecate-domain.rst b/aws/dist/awscli/examples/swf/deprecate-domain.rst new file mode 100644 index 00000000..cad7f791 --- /dev/null +++ b/aws/dist/awscli/examples/swf/deprecate-domain.rst @@ -0,0 +1,71 @@ +Deprecating a Domain +-------------------- + +To deprecate a domain (you can still see it, but cannot create new +workflow executions or register types on it), use +``swf deprecate-domain``. It has a sole required parameter, ``--name``, +which takes the name of the domain to deprecate. + +:: + + $ aws swf deprecate-domain --name MyNeatNewDomain + "" + +As with ``register-domain``, no output is returned. If you use +``list-domains`` to view the registered domains, however, you will see +that the domain has been deprecated and no longer appears in the +returned data: + +:: + + $ aws swf list-domains --registration-status REGISTERED + { + "domainInfos": [ + { + "status": "REGISTERED", + "name": "DataFrobotz" + }, + { + "status": "REGISTERED", + "name": "erontest" + } + ] + } + +If you use ``--registration-status DEPRECATED`` with ``list-domains``, +you will see your deprecated domain: + +:: + + $ aws swf list-domains --registration-status DEPRECATED + { + "domainInfos": [ + { + "status": "DEPRECATED", + "name": "MyNeatNewDomain" + } + ] + } + +You can still use ``describe-domain`` to get information about a +deprecated domain: + +:: + + $ aws swf describe-domain --name MyNeatNewDomain + { + "domainInfo": { + "status": "DEPRECATED", + "name": "MyNeatNewDomain" + }, + "configuration": { + "workflowExecutionRetentionPeriodInDays": "0" + } + } + +See Also +-------- + +- `DeprecateDomain `__ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/describe-domain.rst b/aws/dist/awscli/examples/swf/describe-domain.rst new file mode 100644 index 00000000..64b40175 --- /dev/null +++ b/aws/dist/awscli/examples/swf/describe-domain.rst @@ -0,0 +1,43 @@ +Getting Information About a Domain +---------------------------------- + +To get detailed information about a particular domain, use the +``swf describe-domain`` command. There is one required parameter: +``--name``, which takes the name of the domain you want information +about. For example: + +:: + + $ aws swf describe-domain --name DataFrobotz + { + "domainInfo": { + "status": "REGISTERED", + "name": "DataFrobotz" + }, + "configuration": { + "workflowExecutionRetentionPeriodInDays": "1" + } + } + +You can also use ``describe-domain`` to get information about deprecated +domains: + +:: + + $ aws swf describe-domain --name MyNeatNewDomain + { + "domainInfo": { + "status": "DEPRECATED", + "name": "MyNeatNewDomain" + }, + "configuration": { + "workflowExecutionRetentionPeriodInDays": "0" + } + } + +See Also +-------- + +- `DescribeDomain `__ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/list-activity-types.rst b/aws/dist/awscli/examples/swf/list-activity-types.rst new file mode 100644 index 00000000..6914afb8 --- /dev/null +++ b/aws/dist/awscli/examples/swf/list-activity-types.rst @@ -0,0 +1,183 @@ +Listing Activity Types +---------------------- + +To get a list of the activity types for a domain, use ``swf list-activity-types``. The ``--domain`` and +``--registration-status`` arguments are required. Here's a simple example:: + + aws swf list-activity-types --domain DataFrobtzz --registration-status REGISTERED + +Results:: + + { + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454150.451, + "activityType": { + "version": "1", + "name": "confirm-user-email" + }, + "description": "subscribe confirm-user-email activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.709, + "activityType": { + "version": "1", + "name": "confirm-user-phone" + }, + "description": "subscribe confirm-user-phone activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454149.871, + "activityType": { + "version": "1", + "name": "get-subscription-info" + }, + "description": "subscribe get-subscription-info activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.909, + "activityType": { + "version": "1", + "name": "send-subscription-success" + }, + "description": "subscribe send-subscription-success activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.085, + "activityType": { + "version": "1", + "name": "subscribe-user-sns" + }, + "description": "subscribe subscribe-user-sns activity" + } + ] + } + +You can use the ``--name`` argument to select only activity types with a particular name:: + + aws swf list-activity-types --domain DataFrobtzz --registration-status REGISTERED --name "send-subscription-success" + +Results:: + + { + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454150.909, + "activityType": { + "version": "1", + "name": "send-subscription-success" + }, + "description": "subscribe send-subscription-success activity" + } + ] + } + +To retrieve results in pages, you can set the ``--maximum-page-size`` argument. If more results are returned than will +fit in a page of results, a "nextPageToken" will be returned in the result set:: + + aws swf list-activity-types --domain DataFrobtzz --registration-status REGISTERED --maximum-page-size 2 + +Results:: + + { + "nextPageToken": "AAAAKgAAAAEAAAAAAAAAA1Gp1BelJq+PmHvAnDxJYbup8+0R4LVtbXLDl7QNY7C3OpHo9Sz06D/GuFz1OyC73umBQ1tOPJ/gC/aYpzDMqUIWIA1T9W0s2DryyZX4OC/6Lhk9/o5kdsuWMSBkHhgaZjgwp3WJINIFJFdaSMxY2vYAX7AtRtpcqJuBDDRE9RaRqDGYqIYUMltarkiqpSY1ZVveBasBvlvyUb/WGAaqehiDz7/JzLT/wWNNUMOd+Nhe", + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454150.451, + "activityType": { + "version": "1", + "name": "confirm-user-email" + }, + "description": "subscribe confirm-user-email activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.709, + "activityType": { + "version": "1", + "name": "confirm-user-phone" + }, + "description": "subscribe confirm-user-phone activity" + } + ] + } + +You can pass the nextPageToken value to the next call to ``list-activity-types`` in the ``--next-page-token`` argument, +retrieving the next page of results:: + + aws swf list-activity-types --domain DataFrobtzz --registration-status REGISTERED --maximum-page-size 2 + --next-page-token "AAAAKgAAAAEAAAAAAAAAA1Gp1BelJq+PmHvAnDxJYbup8+0R4LVtbXLDl7QNY7C3OpHo9Sz06D/GuFz1OyC73umBQ1tOPJ/gC/aYpzDMqUIWIA1T9W0s2DryyZX4OC/6Lhk9/o5kdsuWMSBkHhgaZjgwp3WJINIFJFdaSMxY2vYAX7AtRtpcqJuBDDRE9RaRqDGYqIYUMltarkiqpSY1ZVveBasBvlvyUb/WGAaqehiDz7/JzLT/wWNNUMOd+Nhe" + +Result:: + + { + "nextPageToken": "AAAAKgAAAAEAAAAAAAAAAw+7LZ4GRZPzTqBHsp2wBxWB8m1sgLCclgCuq3J+h/m3+vOfFqtkcjLwV5cc4OjNAzTCuq/XcylPumGwkjbajtqpZpbqOcVNfjFxGoi0LB2Olbvv0krbUISBvlpFPmSWpDSZJsxg5UxCcweteSlFn1PNSZ/MoinBZo8OTkjMuzcsTuKOzH9wCaR8ITcALJ3SaqHU3pyIRS5hPmFA3OLIc8zaAepjlaujo6hntNSCruB4" + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454149.871, + "activityType": { + "version": "1", + "name": "get-subscription-info" + }, + "description": "subscribe get-subscription-info activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.909, + "activityType": { + "version": "1", + "name": "send-subscription-success" + }, + "description": "subscribe send-subscription-success activity" + } + ] + } + +If there are still more results to return, "nextPageToken" will be returned with the results. When there are no more +pages of results to return, "nextPageToken" will *not* be returned in the result set. + +You can use the ``--reverse-order`` argument to reverse the order of the returned results. This also affects paged +results:: + + aws swf list-activity-types --domain DataFrobtzz --registration-status REGISTERED --maximum-page-size 2 --reverse-order + +Results:: + + { + "nextPageToken": "AAAAKgAAAAEAAAAAAAAAAwXcpu5ePSyQkrC+8WMbmSrenuZC2ZkIXQYBPB/b9xIOVkj+bMEFhGj0KmmJ4rF7iddhjf7UMYCsfGkEn7mk+yMCgVc1JxDWmB0EH46bhcmcLmYNQihMDmUWocpr7To6/R7CLu0St1gkFayxOidJXErQW0zdNfQaIWAnF/cwioBbXlkz1fQzmDeU3M5oYGMPQIrUqkPq7pMEW0q0lK5eDN97NzFYdZZ/rlcLDWPZhUjY", + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454150.085, + "activityType": { + "version": "1", + "name": "subscribe-user-sns" + }, + "description": "subscribe subscribe-user-sns activity" + }, + { + "status": "REGISTERED", + "creationDate": 1371454150.909, + "activityType": { + "version": "1", + "name": "send-subscription-success" + }, + "description": "subscribe send-subscription-success activity" + } + ] + } + +See Also +-------- + +- `ListActivityTypes `_ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/list-domains.rst b/aws/dist/awscli/examples/swf/list-domains.rst new file mode 100644 index 00000000..e3229f08 --- /dev/null +++ b/aws/dist/awscli/examples/swf/list-domains.rst @@ -0,0 +1,86 @@ +Listing your Domains +-------------------- + +To list the SWF domains that you have registered for your account, you can use ``swf list-domains``. There is only one +required parameter: ``--registration-status``, which you can set to either ``REGISTERED`` or ``DEPRECATED``. + +Here's a typical example:: + + aws swf list-domains --registration-status REGISTERED + +Result:: + + { + "domainInfos": [ + { + "status": "REGISTERED", + "name": "DataFrobotz" + }, + { + "status": "REGISTERED", + "name": "erontest" + } + ] + } + +If you set ``--registration-status`` to ``DEPRECATED``, you will see deprecated domains (domains that can not register +new workflows or activities, but that can still be queried). For example:: + + aws swf list-domains --registration-status DEPRECATED + +Result:: + + { + "domainInfos": [ + { + "status": "DEPRECATED", + "name": "MyNeatNewDomain" + } + ] + } + + +If you have many domains, you can set the ``--maximum-page-size`` option to limit the number of results returned. If +there are more results to return than the maximum number that you specified, you will receive a ``nextPageToken`` that +you can send to the next call to ``list-domains`` to retrieve additional entries. + +Here's an example of using ``--maximum-page-size``:: + + aws swf list-domains --registration-status REGISTERED --maximum-page-size 1 + +Result:: + + { + "domainInfos": [ + { + "status": "REGISTERED", + "name": "DataFrobotz" + } + ], + "nextPageToken": "AAAAKgAAAAEAAAAAAAAAA2QJKNtidVgd49TTeNwYcpD+QKT2ynuEbibcQWe2QKrslMGe63gpS0MgZGpcpoKttL4OCXRFn98Xif557it+wSZUsvUDtImjDLvguyuyyFdIZtvIxIKEOPm3k2r4OjAGaFsGOuVbrKljvla7wdU7FYH3OlkNCP8b7PBj9SBkUyGoiAghET74P93AuVIIkdKGtQ==" + } + +When you make the call again, this time supplying the value of ``nextPageToken`` in the ``--next-page-token`` argument, +you'll get another page of results:: + + aws swf list-domains --registration-status REGISTERED --maximum-page-size 1 --next-page-token "AAAAKgAAAAEAAAAAAAAAA2QJKNtidVgd49TTeNwYcpD+QKT2ynuEbibcQWe2QKrslMGe63gpS0MgZGpcpoKttL4OCXRFn98Xif557it+wSZUsvUDtImjDLvguyuyyFdIZtvIxIKEOPm3k2r4OjAGaFsGOuVbrKljvla7wdU7FYH3OlkNCP8b7PBj9SBkUyGoiAghET74P93AuVIIkdKGtQ==" + +Result:: + + { + "domainInfos": [ + { + "status": "REGISTERED", + "name": "erontest" + } + ] + } + +When there are no further pages of results to retrieve, ``nextPageToken`` will not be returned in the results. + +See Also +-------- + +- `ListDomains `__ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/list-workflow-types.rst b/aws/dist/awscli/examples/swf/list-workflow-types.rst new file mode 100644 index 00000000..b60dc5e3 --- /dev/null +++ b/aws/dist/awscli/examples/swf/list-workflow-types.rst @@ -0,0 +1,34 @@ +Listing Workflow Types +---------------------- + +To get a list of the workflow types for a domain, use ``swf list-workflow-types``. The ``--domain`` and +``--registration-status`` arguments are required. Here's a simple example:: + + aws swf list-workflow-types --domain DataFrobtzz --registration-status REGISTERED + +Results:: + + { + "typeInfos": [ + { + "status": "REGISTERED", + "creationDate": 1371454149.598, + "description": "DataFrobtzz subscribe workflow", + "workflowType": { + "version": "v3", + "name": "subscribe" + } + } + ] + } + +As with ``list-activity-types``, you can use the ``--name`` argument to select only workflow types with a particular +name, and use the ``--maximum-page-size`` argument in coordination with ``--next-page-token`` to page results. To +reverse the order in which results are returned, use ``--reverse-order``. + +See Also +-------- + +- `ListWorkflowTypes `_ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/register-domain.rst b/aws/dist/awscli/examples/swf/register-domain.rst new file mode 100644 index 00000000..b5428e84 --- /dev/null +++ b/aws/dist/awscli/examples/swf/register-domain.rst @@ -0,0 +1,61 @@ +Registering a Domain +-------------------- + +You can use the AWS CLI to register new domains. Use the ``swf register-domain`` command. There are two required +parameters, ``--name``, which takes the domain name, and ``--workflow-execution-retention-period-in-days``, which takes +an integer to specify the number of days to retain workflow execution data on this domain, up to a maxium period of 90 +days (for more information, see the `SWF FAQ `). Workflow execution data +will not be retained after the specified number of days have passed. + +Here's an example of registering a new domain: + +:: + + $ aws swf register-domain --name MyNeatNewDomain --workflow-execution-retention-period-in-days 0 + "" + +When you register a domain, nothing is returned (""), but you can use +``swf list-domains`` or ``swf describe-domain`` to see the new domain. +For example: + +:: + + $ aws swf list-domains --registration-status REGISTERED + { + "domainInfos": [ + { + "status": "REGISTERED", + "name": "DataFrobotz" + }, + { + "status": "REGISTERED", + "name": "MyNeatNewDomain" + }, + { + "status": "REGISTERED", + "name": "erontest" + } + ] + } + +Using ``swf describe-domain``: + +:: + + aws swf describe-domain --name MyNeatNewDomain + { + "domainInfo": { + "status": "REGISTERED", + "name": "MyNeatNewDomain" + }, + "configuration": { + "workflowExecutionRetentionPeriodInDays": "0" + } + } + +See Also +-------- + +- `RegisterDomain `__ + in the *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/swf/register-workflow-type.rst b/aws/dist/awscli/examples/swf/register-workflow-type.rst new file mode 100644 index 00000000..a89fe397 --- /dev/null +++ b/aws/dist/awscli/examples/swf/register-workflow-type.rst @@ -0,0 +1,24 @@ +Registering a Workflow Type +--------------------------- + +To register a Workflow type with the AWS CLI, use the ``swf register-workflow-type`` command:: + + aws swf register-workflow-type --domain DataFrobtzz --name "MySimpleWorkflow" --workflow-version "v1" + +If successful, the command returns no result. On an error (for example, if you try to register the same workflow type +twice, or specify a domain that doesn't exist) you will get a response in JSON:: + + { + "message": "WorkflowType=[name=MySimpleWorkflow, version=v1]", + "__type": "com.amazonaws.swf.base.model#TypeAlreadyExistsFault" + } + +The ``--domain``, ``--name`` and ``--workflow-version`` are required. You can also set the workflow description, +timeouts, and child workflow policy. + +See Also +-------- + +- `RegisterWorkflowType ` in the + *Amazon Simple Workflow Service API Reference* + diff --git a/aws/dist/awscli/examples/textract/analyze-document.rst b/aws/dist/awscli/examples/textract/analyze-document.rst new file mode 100755 index 00000000..0944b926 --- /dev/null +++ b/aws/dist/awscli/examples/textract/analyze-document.rst @@ -0,0 +1,59 @@ +**To analyze text in a document** + +The following ``analyze-document`` example shows how to analyze text in a document. :: + + aws textract analyze-document --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' --feature-types '["TABLES","FORMS"]' + +Output :: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "87586964-d50d-43e2-ace5-8a890657b9a0", + "a1e72126-21d9-44f4-a8d6-5c385f9002ba", + "e889d012-8a6b-4d2e-b7cd-7a8b327d876a" + ] + } + ], + "BlockType": "PAGE", + "Id": "c2227f12-b25d-4e1f-baea-1ee180d926b2" + } + ], + "DocumentMetadata": { + "Pages": 1 + } + } + +For more information, see `Analyzing Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* + +.. _`Analyzing Document Text with Amazon Textract`: https://docs.aws.amazon.com/textract/latest/dg/analyzing-document-text.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/textract/detect-document-text.rst b/aws/dist/awscli/examples/textract/detect-document-text.rst new file mode 100755 index 00000000..52f623d9 --- /dev/null +++ b/aws/dist/awscli/examples/textract/detect-document-text.rst @@ -0,0 +1,140 @@ +**To detect text in a document** + +The following ``detect-document-text`` The following example shows how to detect text in a document. :: + + aws textract detect-document-text --document '{"S3Object":{"Bucket":"bucket","Name":"document"}}' + +Output :: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "896a9f10-9e70-4412-81ce-49ead73ed881", + "0da18623-dc4c-463d-a3d1-9ac050e9e720", + "167338d7-d38c-4760-91f1-79a8ec457bb2" + ] + } + ], + "BlockType": "PAGE", + "Id": "21f0535e-60d5-4bc7-adf2-c05dd851fa25" + }, + { + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "62490c26-37ea-49fa-8034-7a9ff9369c9c", + "1e4f3f21-05bd-4da9-ba10-15d01e66604c" + ] + } + ], + "Confidence": 89.11581420898438, + "Geometry": { + "BoundingBox": { + "Width": 0.33642634749412537, + "Top": 0.17169663310050964, + "Left": 0.13885067403316498, + "Height": 0.49159330129623413 + }, + "Polygon": [ + { + "Y": 0.17169663310050964, + "X": 0.13885067403316498 + }, + { + "Y": 0.17169663310050964, + "X": 0.47527703642845154 + }, + { + "Y": 0.6632899641990662, + "X": 0.47527703642845154 + }, + { + "Y": 0.6632899641990662, + "X": 0.13885067403316498 + } + ] + }, + "Text": "He llo,", + "BlockType": "LINE", + "Id": "896a9f10-9e70-4412-81ce-49ead73ed881" + }, + { + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "19b28058-9516-4352-b929-64d7cef29daf" + ] + } + ], + "Confidence": 85.5694351196289, + "Geometry": { + "BoundingBox": { + "Width": 0.33182239532470703, + "Top": 0.23131252825260162, + "Left": 0.5091826915740967, + "Height": 0.3766750991344452 + }, + "Polygon": [ + { + "Y": 0.23131252825260162, + "X": 0.5091826915740967 + }, + { + "Y": 0.23131252825260162, + "X": 0.8410050868988037 + }, + { + "Y": 0.607987642288208, + "X": 0.8410050868988037 + }, + { + "Y": 0.607987642288208, + "X": 0.5091826915740967 + } + ] + }, + "Text": "worlc", + "BlockType": "LINE", + "Id": "0da18623-dc4c-463d-a3d1-9ac050e9e720" + } + ], + "DocumentMetadata": { + "Pages": 1 + } + } + +For more information, see `Detecting Document Text with Amazon Textract`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting Document Text with Amazon Textract`: https://docs.aws.amazon.com/textract/latest/dg/detecting-document-text.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/textract/get-document-analysis.rst b/aws/dist/awscli/examples/textract/get-document-analysis.rst new file mode 100755 index 00000000..d74ac57e --- /dev/null +++ b/aws/dist/awscli/examples/textract/get-document-analysis.rst @@ -0,0 +1,62 @@ +**To get the results of asynchronous text analysis of a multi-page document** + +The following ``get-document-analysis`` example shows how to get the results of asynchronous text analysis of a multi-page document. :: + + aws textract get-document-analysis --job-id df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b --max-results 1000 + +Output :: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "75966e64-81c2-4540-9649-d66ec341cd8f", + "bb099c24-8282-464c-a179-8a9fa0a057f0", + "5ebf522d-f9e4-4dc7-bfae-a288dc094595" + ] + } + ], + "BlockType": "PAGE", + "Id": "247c28ee-b63d-4aeb-9af0-5f7ea8ba109e", + "Page": 1 + } + ], + "NextToken": "cY1W3eTFvoB0cH7YrKVudI4Gb0H8J0xAYLo8xI/JunCIPWCthaKQ+07n/ElyutsSy0+1VOImoTRmP1zw4P0RFtaeV9Bzhnfedpx1YqwB4xaGDA==", + "DocumentMetadata": { + "Pages": 1 + }, + "JobStatus": "SUCCEEDED" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html diff --git a/aws/dist/awscli/examples/textract/get-document-text-detection.rst b/aws/dist/awscli/examples/textract/get-document-text-detection.rst new file mode 100755 index 00000000..52721719 --- /dev/null +++ b/aws/dist/awscli/examples/textract/get-document-text-detection.rst @@ -0,0 +1,62 @@ +**To get the results of asynchronous text detection in a multi-page document** + +The following ``get-document-text-detection`` example shows how to get the results of asynchronous text detection in a multi-page document. :: + + aws textract get-document-text-detection --job-id 57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9 --max-results 1000 + +Output :: + + { + "Blocks": [ + { + "Geometry": { + "BoundingBox": { + "Width": 1.0, + "Top": 0.0, + "Left": 0.0, + "Height": 1.0 + }, + "Polygon": [ + { + "Y": 0.0, + "X": 0.0 + }, + { + "Y": 0.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 1.0 + }, + { + "Y": 1.0, + "X": 0.0 + } + ] + }, + "Relationships": [ + { + "Type": "CHILD", + "Ids": [ + "1b926a34-0357-407b-ac8f-ec473160c6a9", + "0c35dc17-3605-4c9d-af1a-d9451059df51", + "dea3db8a-52c2-41c0-b50c-81f66f4aa758" + ] + } + ], + "BlockType": "PAGE", + "Id": "84671a5e-8c99-43be-a9d1-6838965da33e", + "Page": 1 + } + ], + "NextToken": "GcqyoAJuZwujOT35EN4LCI3EUzMtiLq3nKyFFHvU5q1SaIdEBcSty+njNgoWwuMP/muqc96S4o5NzDqehhXvhkodMyVO5OJGyms5lsrCxibWJw==", + "DocumentMetadata": { + "Pages": 1 + }, + "JobStatus": "SUCCEEDED" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/textract/start-document-analysis.rst b/aws/dist/awscli/examples/textract/start-document-analysis.rst new file mode 100755 index 00000000..805be8a7 --- /dev/null +++ b/aws/dist/awscli/examples/textract/start-document-analysis.rst @@ -0,0 +1,15 @@ +**To start analyzing text in a multi-page document** + +The following ``start-document-analysis`` example shows how to start asynchronous analysis of text in a multi-page document. :: + + aws textract start-document-analysis --document-location '{"S3Object":{"Bucket":"reescheastv","Name":"doctest.png"}}' --feature-types '["TABLES","FORMS"]' --notification-channel "SNSTopicArn=arn:snsTopic,RoleArn=roleArn" + +Output :: + + { + "JobId": "df7cf32ebbd2a5de113535fcf4d921926a701b09b4e7d089f3aebadb41e0712b" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html diff --git a/aws/dist/awscli/examples/textract/start-document-text-detection.rst b/aws/dist/awscli/examples/textract/start-document-text-detection.rst new file mode 100755 index 00000000..bf2c3a02 --- /dev/null +++ b/aws/dist/awscli/examples/textract/start-document-text-detection.rst @@ -0,0 +1,15 @@ +**To start detecting text in a multi-page document** + +The following ``start-document-text-detection`` example shows how to start asynchronous detection of text in a multi-page document. :: + + aws textract start-document-text-detection --document-location '{"S3Object":{"Bucket":"reescheastv","Name":"doctest.png"}}' --notification-channel "SNSTopicArn=topicARN,RoleArn=roleARN" + +The command returns output similar to the following. :: + + { + "JobId": "57849a3dc627d4df74123dca269d69f7b89329c870c65bb16c9fd63409d200b9" + } + +For more information, see `Detecting and Analyzing Text in Multi-Page Documents`_ in the *Amazon Textract Developers Guide* + +.. _`Detecting and Analyzing Text in Multi-Page Documents`: https://docs.aws.amazon.com/textract/latest/dg/async.html \ No newline at end of file diff --git a/aws/dist/awscli/examples/translate/import-terminology.rst b/aws/dist/awscli/examples/translate/import-terminology.rst new file mode 100644 index 00000000..7afff622 --- /dev/null +++ b/aws/dist/awscli/examples/translate/import-terminology.rst @@ -0,0 +1,36 @@ +**To import a custom terminology from a file** + +The following ``import-terminology`` example creates a terminology called ``MyTestTerminology`` from the ``test-terminology.csv`` file: :: + + aws translate import-terminology \ + --name MyTestTerminology \ + --description "Creating a test terminology in AWS Translate" \ + --merge-strategy OVERWRITE \ + --data-file fileb://test-terminology.csv \ + --terminology-data Format=CSV + +Contents of ``test-terminology.csv``: + + en,fr,es,zh + Hello world!,Bonjour tout le monde!,Hola Mundo!,???? + Amazon,Amazon,Amazon,Amazon + +Output:: + + { + "TerminologyProperties": { + "SourceLanguageCode": "en", + "Name": "MyTestTerminology", + "TargetLanguageCodes": [ + "fr", + "es", + "zh" + ], + "SizeBytes": 97, + "LastUpdatedAt": 1571089500.851, + "CreatedAt": 1571089500.851, + "TermCount": 6, + "Arn": "arn:aws:translate:us-west-2:123456789012:terminology/MyTestTerminology/LATEST", + "Description": "Creating a test terminology in AWS Translate" + } + } diff --git a/aws/dist/awscli/examples/waf-regional/associate-web-acl.rst b/aws/dist/awscli/examples/waf-regional/associate-web-acl.rst new file mode 100755 index 00000000..4e9d54d6 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/associate-web-acl.rst @@ -0,0 +1,9 @@ +**To associate a web ACL with a resource** + +The following ``associate-web-acl`` command associates a web ACL, specified by the web-acl-id, with a resource, specified by the resource-arn. The resource ARN can refer to either a application load balancer or an API Gateway:: + + aws waf-regional associate-web-acl \ + --web-acl-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --resource-arn 12cs345-67cd-890b-1cd2-c3a4567d89f1 + +For more information, see `Working with Web ACLs `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/put-logging-configuration.rst b/aws/dist/awscli/examples/waf-regional/put-logging-configuration.rst new file mode 100644 index 00000000..55ddbca6 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/put-logging-configuration.rst @@ -0,0 +1,19 @@ +**To create a logging configuration for the web ACL ARN with the specified Kinesis Firehose stream ARN** + +The following ``put-logging-configuration`` example displays logging configuration for WAF with ALB/APIGateway in Region ``us-east-1``. :: + + aws waf put-logging-configuration \ + --logging-configuration ResourceArn=arn:aws:waf-regional:us-east-1:123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3,LogDestinationConfigs=arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream,RedactedFields=[] \ + --region us-east-1 + +Output:: + + { + "LoggingConfiguration": { + "ResourceArn": "arn:aws:waf-regional:us-east-1:123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3", + "LogDestinationConfigs": [ + "arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream" + ] + } + } + diff --git a/aws/dist/awscli/examples/waf-regional/update-byte-match-set.rst b/aws/dist/awscli/examples/waf-regional/update-byte-match-set.rst new file mode 100755 index 00000000..fe8fc858 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-byte-match-set.rst @@ -0,0 +1,10 @@ +**To update a byte match set** + +The following ``update-byte-match-set`` command deletes a ``ByteMatchTuple`` object (filter) in a ``ByteMatchSet``. Because the ``updates`` value has embedded double quotes, you must surround the value with single quotes. :: + + aws waf-regional update-byte-match-set \ + --byte-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="DELETE",ByteMatchTuple={FieldToMatch={Type="HEADER",Data="referer"},TargetString="badrefer1",TextTransformation="NONE",PositionalConstraint="CONTAINS"}' + +For more information, see `Working with String Match Conditions `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/update-ip-set.rst b/aws/dist/awscli/examples/waf-regional/update-ip-set.rst new file mode 100755 index 00000000..136451ad --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-ip-set.rst @@ -0,0 +1,38 @@ +**To update an IP set** + +The following ``update-ip-set`` command updates an IPSet with an IPv4 address and deletes an IPv6 address. Get the value for ``change-token`` by running the ``get-change-token`` command. Because the value for updates includes embedded double-quotes, you must surround the value with single quotes. :: + + aws waf update-ip-set \ + --ip-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="INSERT",IPSetDescriptor={Type="IPV4",Value="12.34.56.78/16"},Action="DELETE",IPSetDescriptor={Type="IPV6",Value="1111:0000:0000:0000:0000:0000:0000:0111/128"}' + +Alternatively you can use a JSON file to specify the input. For example:: + + aws waf-regional update-ip-set \ + --ip-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates file://change.json + +Content of the ``change.json`` :: + + [ + { + "Action": "INSERT", + "IPSetDescriptor": + { + "Type": "IPV4", + "Value": "12.34.56.78/16" + } + }, + { + "Action": "DELETE", + "IPSetDescriptor": + { + "Type": "IPV6", + "Value": "1111:0000:0000:0000:0000:0000:0000:0111/128" + } + } + ] + +For more information, see `Working with IP Match Conditions `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/update-rule.rst b/aws/dist/awscli/examples/waf-regional/update-rule.rst new file mode 100755 index 00000000..c643da54 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-rule.rst @@ -0,0 +1,10 @@ +**To update a rule** + +The following ``update-rule`` command deletes a ``Predicate`` object in a rule. Because the ``updates`` value has embedded double quotes, you must surround the entire value with single quotes. :: + + aws waf-regional update-rule \ + --rule-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="DELETE",Predicate={Negated=false,Type="ByteMatch",DataId="MyByteMatchSetID"}' + +For more information, see `Working with Rules `__ in the *AWS WAF Developer Guide* . diff --git a/aws/dist/awscli/examples/waf-regional/update-size-constraint-set.rst b/aws/dist/awscli/examples/waf-regional/update-size-constraint-set.rst new file mode 100755 index 00000000..31492d15 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-size-constraint-set.rst @@ -0,0 +1,10 @@ +**To update a size constraint set** + +The following ``update-size-constraint-set`` command deletes a `SizeConstraint`` object (filters) in a size constraint set. Because the ``updates`` value contains embedded double quotes, you must surround the entire value with single quotes. :: + + aws waf-regional update-size-constraint-set \ + --size-constraint-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="DELETE",SizeConstraint={FieldToMatch={Type="QUERY_STRING"},TextTransformation="NONE",ComparisonOperator="GT",Size=0}' + +For more information, see `Working with Size Constraint Conditions `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/update-sql-injection-match-set.rst b/aws/dist/awscli/examples/waf-regional/update-sql-injection-match-set.rst new file mode 100755 index 00000000..6a4a7735 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-sql-injection-match-set.rst @@ -0,0 +1,10 @@ +**To update a SQL Injection Match Set** + +The following ``update-sql-injection-match-set`` command deletes a ``SqlInjectionMatchTuple`` object (filters) in a SQL injection match set. Because the ``updates`` value contains embedded double quotes, you must surround the entire value in single quotes. : + + aws waf-regional update-sql-injection-match-set \ + --sql-injection-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="DELETE",SqlInjectionMatchTuple={FieldToMatch={Type="QUERY_STRING"},TextTransformation="URL_DECODE"}' + +For more information, see `Working with SQL Injection Match Conditions `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/update-web-acl.rst b/aws/dist/awscli/examples/waf-regional/update-web-acl.rst new file mode 100755 index 00000000..36b86349 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-web-acl.rst @@ -0,0 +1,11 @@ +**To update a web ACL** + +The following ``update-web-acl`` command deletes an ``ActivatedRule`` object in a WebACL. Because the ``updates`` value contains embedded double quotes, you must surround the entire value in single quotes. :: + + aws waf-regional update-web-acl \ + --web-acl-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates Action="DELETE",ActivatedRule='{Priority=1,RuleId="WAFRule-1-Example",Action={Type="ALLOW"},Type="ALLOW"}' + + +For more information, see `Working with Web ACLs `__ in the *AWS WAF Developer Guide*. diff --git a/aws/dist/awscli/examples/waf-regional/update-xss-match-set.rst b/aws/dist/awscli/examples/waf-regional/update-xss-match-set.rst new file mode 100755 index 00000000..1e869403 --- /dev/null +++ b/aws/dist/awscli/examples/waf-regional/update-xss-match-set.rst @@ -0,0 +1,10 @@ +**To update an XSSMatchSet** + +The following ``update-xss-match-set`` command deletes an ``XssMatchTuple`` object (filters) in an ``XssMatchSet``. Because the ``updates`` value contains embedded double quotes, you must surround the entire value with single quotes. :: + + aws waf-regional update-xss-match-set \ + --xss-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 \ + --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \ + --updates 'Action="DELETE",XssMatchTuple={FieldToMatch={Type="QUERY_STRING"},TextTransformation="URL_DECODE"}' + +For more information, see `Working with Cross-site Scripting Match Conditions `__ in the *AWS WAF Developer Guide* . diff --git a/aws/dist/awscli/examples/waf/put-logging-configuration.rst b/aws/dist/awscli/examples/waf/put-logging-configuration.rst new file mode 100644 index 00000000..7cb7bc01 --- /dev/null +++ b/aws/dist/awscli/examples/waf/put-logging-configuration.rst @@ -0,0 +1,18 @@ +**To create a logging configuration for the web ACL ARN with the specified Kinesis Firehose stream ARN** + +The following ``put-logging-configuration`` example displays logging configuration for WAF with CloudFront. :: + + aws waf put-logging-configuration \ + --logging-configuration ResourceArn=arn:aws:waf::123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3,LogDestinationConfigs=arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream,RedactedFields=[] + +Output:: + + { + "LoggingConfiguration": { + "ResourceArn": "arn:aws:waf::123456789012:webacl/3bffd3ed-fa2e-445e-869f-a6a7cf153fd3", + "LogDestinationConfigs": [ + "arn:aws:firehose:us-east-1:123456789012:deliverystream/aws-waf-logs-firehose-stream" + ] + } + } + diff --git a/aws/dist/awscli/examples/waf/update-byte-match-set.rst b/aws/dist/awscli/examples/waf/update-byte-match-set.rst new file mode 100755 index 00000000..1dd6e8d7 --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-byte-match-set.rst @@ -0,0 +1,13 @@ +**To update a byte match set** + +The following ``update-byte-match-set`` command deletes a ByteMatchTuple object (filter) in a ByteMatchSet:: + + aws waf update-byte-match-set --byte-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",ByteMatchTuple={FieldToMatch={Type="HEADER",Data="referer"},TargetString="badrefer1",TextTransformation="NONE",PositionalConstraint="CONTAINS"} + + + + +For more information, see `Working with String Match Conditions`_ in the *AWS WAF* developer guide. + +.. _`Working with String Match Conditions`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-string-conditions.html + diff --git a/aws/dist/awscli/examples/waf/update-ip-set.rst b/aws/dist/awscli/examples/waf/update-ip-set.rst new file mode 100755 index 00000000..c453badc --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-ip-set.rst @@ -0,0 +1,35 @@ +**To update an IP set** + +The following ``update-ip-set`` command updates an IPSet with an IPv4 address and deletes an IPv6 address:: + + aws waf update-ip-set --ip-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="INSERT",IPSetDescriptor={Type="IPV4",Value="12.34.56.78/16"},Action="DELETE",IPSetDescriptor={Type="IPV6",Value="1111:0000:0000:0000:0000:0000:0000:0111/128"} + +Alternatively you can use a JSON file to specify the input. For example:: + + aws waf update-ip-set --ip-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates file://change.json + +Where content of the JSON file is:: + + [ + { + "Action": "INSERT", + "IPSetDescriptor": + { + "Type": "IPV4", + "Value": "12.34.56.78/16" + } + }, + { + "Action": "DELETE", + "IPSetDescriptor": + { + "Type": "IPV6", + "Value": "1111:0000:0000:0000:0000:0000:0000:0111/128" + } + } + ] + +For more information, see `Working with IP Match Conditions`_ in the *AWS WAF* developer guide. + +.. _`Working with IP Match Conditions`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-ip-conditions.html + diff --git a/aws/dist/awscli/examples/waf/update-rule.rst b/aws/dist/awscli/examples/waf/update-rule.rst new file mode 100755 index 00000000..ab086332 --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-rule.rst @@ -0,0 +1,16 @@ +**To update a rule** + +The following ``update-rule`` command deletes a Predicate object in a rule:: + + + aws waf update-rule --rule-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",Predicate={Negated=false,Type="ByteMatch",DataId="MyByteMatchSetID"} + + + + + +For more information, see `Working with Rules`_ in the *AWS WAF* developer guide. + +.. _`Working with Rules`: + https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-rules.html + diff --git a/aws/dist/awscli/examples/waf/update-size-constraint-set.rst b/aws/dist/awscli/examples/waf/update-size-constraint-set.rst new file mode 100755 index 00000000..bcf702be --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-size-constraint-set.rst @@ -0,0 +1,13 @@ +**To update a size constraint set** + +The following ``update-size-constraint-set`` command deletes a SizeConstraint object (filters) in a size constraint set:: + + aws waf update-size-constraint-set --size-constraint-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",SizeConstraint={FieldToMatch={Type="QUERY_STRING"},TextTransformation="NONE",ComparisonOperator="GT",Size=0} + + + + +For more information, see `Working with Size Constraint Conditions`_ in the *AWS WAF* developer guide. + +.. _`Working with Size Constraint Conditions`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-size-conditions.html + diff --git a/aws/dist/awscli/examples/waf/update-sql-injection-match-set.rst b/aws/dist/awscli/examples/waf/update-sql-injection-match-set.rst new file mode 100755 index 00000000..bc3c7e9a --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-sql-injection-match-set.rst @@ -0,0 +1,13 @@ +**To update a SQL Injection Match Set** + +The following ``update-sql-injection-match-set`` command deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set:: + + aws waf update-sql-injection-match-set --sql-injection-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",SqlInjectionMatchTuple={FieldToMatch={Type="QUERY_STRING"},TextTransformation="URL_DECODE"} + + + + +For more information, see `Working with SQL Injection Match Conditions`_ in the *AWS WAF* developer guide. + +.. _`Working with SQL Injection Match Conditions`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-sql-conditions.html + diff --git a/aws/dist/awscli/examples/waf/update-web-acl.rst b/aws/dist/awscli/examples/waf/update-web-acl.rst new file mode 100755 index 00000000..ac2dffb5 --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-web-acl.rst @@ -0,0 +1,13 @@ +**To update a web ACL** + +The following ``update-web-acl`` command deletes an ActivatedRule object in a WebACL. + +aws waf update-web-acl --web-acl-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",ActivatedRule={Priority=1,RuleId="WAFRule-1-Example",Action={Type="ALLOW"},Type="REGULAR"} + + + + +For more information, see `Working with Web ACLs`_ in the *AWS WAF* developer guide. + +.. _`Working with Web ACLs`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-working-with.html + diff --git a/aws/dist/awscli/examples/waf/update-xss-match-set.rst b/aws/dist/awscli/examples/waf/update-xss-match-set.rst new file mode 100755 index 00000000..b4adca13 --- /dev/null +++ b/aws/dist/awscli/examples/waf/update-xss-match-set.rst @@ -0,0 +1,13 @@ +**To update an XSSMatchSet** + +The following ``update-xss-match-set`` command deletes an XssMatchTuple object (filters) in an XssMatchSet:: + + aws waf update-xss-match-set --xss-match-set-id a123fae4-b567-8e90-1234-5ab67ac8ca90 --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 --updates Action="DELETE",XssMatchTuple={FieldToMatch={Type="QUERY_STRING"},TextTransformation="URL_DECODE"} + + + + +For more information, see `Working with Cross-site Scripting Match Conditions`_ in the *AWS WAF* developer guide. + +.. _`Working with Cross-site Scripting Match Conditions`: https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-xss-conditions.html + diff --git a/aws/dist/awscli/examples/workdocs/abort-document-version-upload.rst b/aws/dist/awscli/examples/workdocs/abort-document-version-upload.rst new file mode 100644 index 00000000..8f28c445 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/abort-document-version-upload.rst @@ -0,0 +1,11 @@ +**To stop a document version upload** + +This example stops a previously initiated document version upload. + +Command:: + + aws workdocs abort-document-version-upload --document-id feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2 --version-id 1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/activate-user.rst b/aws/dist/awscli/examples/workdocs/activate-user.rst new file mode 100644 index 00000000..461324a4 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/activate-user.rst @@ -0,0 +1,33 @@ +**To activate a user** + +This example activates an inactive user. + +Command:: + + aws workdocs activate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" + +Output:: + + { + "User": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Username": "exampleUser", + "EmailAddress": "exampleUser@site.awsapps.com", + "GivenName": "Example", + "Surname": "User", + "OrganizationId": "d-926726012c", + "RootFolderId": "75f67c183aa1217409ac87576a45c03a5df5e6d8c51c35c01669970538e86cd0", + "RecycleBinFolderId": "642b7dd3e60b14204534f3df7b1959e01b5d170f8c2707f410e40a8149120a57", + "Status": "ACTIVE", + "Type": "MINIMALUSER", + "CreatedTimestamp": 1521226107.747, + "ModifiedTimestamp": 1525297406.462, + "Storage": { + "StorageUtilizedInBytes": 0, + "StorageRule": { + "StorageAllocatedInBytes": 0, + "StorageType": "QUOTA" + } + } + } + } diff --git a/aws/dist/awscli/examples/workdocs/add-resource-permissions.rst b/aws/dist/awscli/examples/workdocs/add-resource-permissions.rst new file mode 100644 index 00000000..5300406e --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/add-resource-permissions.rst @@ -0,0 +1,21 @@ +**To add permissions for a resource** + +This example adds permissions to the resource for the specified principals. + +Command:: + + aws workdocs add-resource-permissions --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --principals Id=anonymous,Type=ANONYMOUS,Role=VIEWER + +Output:: + + { + "ShareResults": [ + { + "PrincipalId": "anonymous", + "Role": "VIEWER", + "Status": "SUCCESS", + "ShareId": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", + "StatusMessage": "" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/create-comment.rst b/aws/dist/awscli/examples/workdocs/create-comment.rst new file mode 100644 index 00000000..c1572a12 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-comment.rst @@ -0,0 +1,27 @@ +**To add a new comment** + +This example adds a new comment to the specified document version. + +Command:: + + aws workdocs create-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --text "This is a comment." + +Output:: + + { + "Comment": { + "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5", + "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5", + "Text": "This is a comment.", + "Contributor": { + "Id": "arn:aws:iam::123456789123:user/exampleUser", + "Username": "exampleUser", + "GivenName": "Example", + "Surname": "User", + "Status": "ACTIVE" + }, + "CreatedTimestamp": 1534799058.197, + "Status": "PUBLISHED", + "Visibility": "PUBLIC" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/create-custom-metadata.rst b/aws/dist/awscli/examples/workdocs/create-custom-metadata.rst new file mode 100644 index 00000000..ac0f9419 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-custom-metadata.rst @@ -0,0 +1,11 @@ +**To create custom metadata** + +This example creates custom metadata for the specified document. + +Command:: + + aws workdocs create-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --custom-metadata KeyName1=example,KeyName2=example2 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/create-folder.rst b/aws/dist/awscli/examples/workdocs/create-folder.rst new file mode 100644 index 00000000..cb4a4bc1 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-folder.rst @@ -0,0 +1,24 @@ +**To create a folder** + +This example creates a folder. + +Command:: + + aws workdocs create-folder --name documents --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 + +Output:: + + { + "Metadata": { + "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08", + "Name": "documents", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "CreatedTimestamp": 1534450467.622, + "ModifiedTimestamp": 1534450467.622, + "ResourceState": "ACTIVE", + "Signature": "", + "Size": 0, + "LatestVersionSize": 0 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/create-labels.rst b/aws/dist/awscli/examples/workdocs/create-labels.rst new file mode 100644 index 00000000..4f812aa6 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-labels.rst @@ -0,0 +1,11 @@ +**To create labels** + +This example creates a series of labels for a document. + +Command:: + + aws workdocs create-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples" "my_documents" + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/create-notification-subscription.rst b/aws/dist/awscli/examples/workdocs/create-notification-subscription.rst new file mode 100644 index 00000000..74119da6 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-notification-subscription.rst @@ -0,0 +1,21 @@ +**To create a notification subscription** + +The following ``create-notification-subscription`` example configures a notification subscription for the specified Amazon WorkDocs organization. :: + + aws workdocs create-notification-subscription \ + --organization-id d-123456789c \ + --protocol HTTPS \ + --subscription-type ALL \ + --notification-endpoint "https://example.com/example" + +Output:: + + { + "Subscription": { + "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123", + "EndPoint": "https://example.com/example", + "Protocol": "HTTPS" + } + } + +For more information, see `Subscribe to Notifications `__ in the *Amazon WorkDocs Developer Guide*. diff --git a/aws/dist/awscli/examples/workdocs/create-user.rst b/aws/dist/awscli/examples/workdocs/create-user.rst new file mode 100644 index 00000000..16f750ee --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/create-user.rst @@ -0,0 +1,33 @@ +**To create a new user** + +This example creates a new user in a Simple AD or Microsoft AD directory. + +Command:: + + aws workdocs create-user --organization-id d-926726012c --username exampleUser2 --email-address exampleUser2@site.awsapps.com --given-name example2Name --surname example2Surname --password examplePa$$w0rd + +Output:: + + { + "User": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Username": "exampleUser2", + "EmailAddress": "exampleUser2@site.awsapps.com", + "GivenName": "example2Name", + "Surname": "example2Surname", + "OrganizationId": "d-926726012c", + "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390", + "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff", + "Status": "ACTIVE", + "Type": "MINIMALUSER", + "CreatedTimestamp": 1535478836.584, + "ModifiedTimestamp": 1535478836.584, + "Storage": { + "StorageUtilizedInBytes": 0, + "StorageRule": { + "StorageAllocatedInBytes": 0, + "StorageType": "QUOTA" + } + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/deactivate-user.rst b/aws/dist/awscli/examples/workdocs/deactivate-user.rst new file mode 100644 index 00000000..d74ef871 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/deactivate-user.rst @@ -0,0 +1,11 @@ +**To deactivate a user** + +This example deactivates an active user. + +Command:: + + aws workdocs deactivate-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-comment.rst b/aws/dist/awscli/examples/workdocs/delete-comment.rst new file mode 100644 index 00000000..a32336df --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-comment.rst @@ -0,0 +1,11 @@ +**To delete a specified comment from a document version** + +This example deletes the specified comment from the specified document version. + +Command:: + + aws workdocs delete-comment --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --comment-id 1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-custom-metadata.rst b/aws/dist/awscli/examples/workdocs/delete-custom-metadata.rst new file mode 100644 index 00000000..dc4f25ec --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-custom-metadata.rst @@ -0,0 +1,11 @@ +**To delete custom metadata from a resource** + +This example deletes all custom metadata from the specified resource. + +Command:: + + aws workdocs delete-custom-metadata --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --delete-all + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-document.rst b/aws/dist/awscli/examples/workdocs/delete-document.rst new file mode 100644 index 00000000..72c1b5f9 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-document.rst @@ -0,0 +1,11 @@ +**To delete a document** + +This example deletes the specified document. + +Command:: + + aws workdocs delete-document --document-id b83ed5e5b167b65ef69de9d597627ff1a0d4f07a45e67f1fab7d26b54427de0a + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-folder-contents.rst b/aws/dist/awscli/examples/workdocs/delete-folder-contents.rst new file mode 100644 index 00000000..8a4fd0c0 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-folder-contents.rst @@ -0,0 +1,11 @@ +**To delete the contents of a folder** + +This example deletes the contents of the specified folder. + +Command:: + + aws workdocs delete-folder-contents --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-folder.rst b/aws/dist/awscli/examples/workdocs/delete-folder.rst new file mode 100644 index 00000000..9af85c6d --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-folder.rst @@ -0,0 +1,11 @@ +**To delete a folder** + +This example deletes the specified folder. + +Command:: + + aws workdocs delete-folder --folder-id 26fa8aa4ba2071447c194f7b150b07149dbdb9e1c8a301872dcd93a4735ce65d + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-labels.rst b/aws/dist/awscli/examples/workdocs/delete-labels.rst new file mode 100644 index 00000000..f11e40ec --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-labels.rst @@ -0,0 +1,11 @@ +**To delete labels** + +This example deletes the specified labels from a document. + +Command:: + + aws workdocs delete-labels --resource-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --labels "documents" "examples" + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/delete-notification-subscription.rst b/aws/dist/awscli/examples/workdocs/delete-notification-subscription.rst new file mode 100644 index 00000000..1850c91a --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-notification-subscription.rst @@ -0,0 +1,11 @@ +**To delete a notification subscription** + +The following ``delete-notification-subscription`` example deletes the specified notification subscription. :: + + aws workdocs delete-notification-subscription \ + --subscription-id 123ab4c5-678d-901e-f23g-45h6789j0123 \ + --organization-id d-123456789c + +This command produces no output. + +For more information, see `Subscribe to Notifications `__ in the *Amazon WorkDocs Developer Guide*. diff --git a/aws/dist/awscli/examples/workdocs/delete-user.rst b/aws/dist/awscli/examples/workdocs/delete-user.rst new file mode 100644 index 00000000..714f75c2 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/delete-user.rst @@ -0,0 +1,11 @@ +**To delete a user** + +This example deletes a user. + +Command:: + + aws workdocs delete-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/describe-activities.rst b/aws/dist/awscli/examples/workdocs/describe-activities.rst new file mode 100644 index 00000000..97e17037 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-activities.rst @@ -0,0 +1,51 @@ +**To get a list of user activities** + +This example returns a list of the latest user activities for the specified organization, with a limit set for the latest two activities. + +Command:: + + aws workdocs describe-activities --organization-id d-926726012c --limit 2 + +Output:: + + { + "UserActivities": [ + { + "Type": "DOCUMENT_VERSION_DOWNLOADED", + "TimeStamp": 1534800122.17, + "Initiator": { + "Id": "arn:aws:iam::123456789123:user/exampleUser" + }, + "ResourceMetadata": { + "Type": "document", + "Name": "updatedDoc", + "Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3", + "Owner": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "GivenName": "exampleName", + "Surname": "exampleSurname" + } + } + }, + { + "Type": "DOCUMENT_VERSION_VIEWED", + "TimeStamp": 1534799079.207, + "Initiator": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "GivenName": "exampleName", + "Surname": "exampleSurname" + }, + "ResourceMetadata": { + "Type": "document", + "Name": "updatedDoc", + "Id": "15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3", + "Owner": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "GivenName": "exampleName", + "Surname": "exampleSurname" + } + } + } + ], + "Marker": "DnF1ZXJ5VGhlbkZldGNoAgAAAAAAAAS7FmlTaU1OdlFTU1h1UU00VVFIbDlRWHcAAAAAAAAJTRY3bWh5eUgzaVF1ZXN2RUE5Wm8tTTdR" + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/describe-comments.rst b/aws/dist/awscli/examples/workdocs/describe-comments.rst new file mode 100644 index 00000000..075b8518 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-comments.rst @@ -0,0 +1,27 @@ +**To list all comments for a specified document version** + +This example lists all the comments for the specified document version. + +Command:: + + aws workdocs describe-comments --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 + +Output:: + + { + "Comments": [ + { + "CommentId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5", + "ThreadId": "1534799058197-c7f5c84de9115875bbca93e0367bbebac609541d461636b760849b88b1609dd5", + "Text": "This is a comment.", + "Contributor": { + "Username": "arn:aws:iam::123456789123:user/exampleUser", + "Type": "USER" + }, + "CreatedTimestamp": 1534799058.197, + "Status": "PUBLISHED", + "Visibility": "PUBLIC" + } + ] + } + diff --git a/aws/dist/awscli/examples/workdocs/describe-document-versions.rst b/aws/dist/awscli/examples/workdocs/describe-document-versions.rst new file mode 100644 index 00000000..53c33ab0 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-document-versions.rst @@ -0,0 +1,42 @@ +**To retrieve a document's versions** + +This example retrieves the document versions for the specified document, including initialized versions and a URL for the source document. + +Command:: + + aws workdocs describe-document-versions --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields SOURCE + +Output:: + + { + "DocumentVersions": [ + { + "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef", + "Name": "exampleDoc.docx", + "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "Size": 13922, + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Status": "ACTIVE", + "CreatedTimestamp": 1534452029.587, + "ModifiedTimestamp": 1534452029.849, + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Source": { + "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.docx&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE" + } + }, + { + "Id": "1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59", + "Name": "exampleDoc.pdf", + "ContentType": "application/pdf", + "Size": 425916, + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Status": "ACTIVE", + "CreatedTimestamp": 1529005196.082, + "ModifiedTimestamp": 1529005196.796, + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Source": { + "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65/1529005196082-bb75fa19abc287699cb07147f75816dce43a53a10f28dc001bf61ef2fab01c59?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc29.pdf&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180816T204149Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180816%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE" + } + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/describe-folder-contents.rst b/aws/dist/awscli/examples/workdocs/describe-folder-contents.rst new file mode 100644 index 00000000..96367e94 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-folder-contents.rst @@ -0,0 +1,47 @@ +**To describe the contents of a folder** + +This example describes all the active contents of the specified folder, including its documents and subfolders, sorted by date in ascending order. + +Command:: + + aws workdocs describe-folder-contents --folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --sort DATE --order ASCENDING --type ALL + +Output:: + + { + "Folders": [ + { + "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08", + "Name": "testing", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "CreatedTimestamp": 1534450467.622, + "ModifiedTimestamp": 1534451113.504, + "ResourceState": "ACTIVE", + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Size": 23019, + "LatestVersionSize": 11537 + } + ], + "Documents": [ + { + "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "CreatedTimestamp": 1529005196.082, + "ModifiedTimestamp": 1534452483.01, + "LatestVersionMetadata": { + "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef", + "Name": "exampleDoc.docx", + "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "Size": 13922, + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Status": "ACTIVE", + "CreatedTimestamp": 1534452029.587, + "ModifiedTimestamp": 1534452029.587, + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" + }, + "ResourceState": "ACTIVE" + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/describe-groups.rst b/aws/dist/awscli/examples/workdocs/describe-groups.rst new file mode 100644 index 00000000..76f71c17 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-groups.rst @@ -0,0 +1,24 @@ +**To retrieve a list of groups** + +The following ``describe-groups`` example lists the groups associated with the specified Amazon WorkDocs organization. :: + + aws workdocs describe-groups \ + --search-query "e" \ + --organization-id d-123456789c + +Output:: + + { + "Groups": [ + { + "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444&d-123456789c", + "Name": "Example Group 1" + }, + { + "Id": "S-1-1-11-1122222222-2222233333-3333334444-5555&d-123456789c", + "Name": "Example Group 2" + } + ] + } + +For more information, see `Getting Started with Amazon WorkDocs `__ in the *Amazon WorkDocs Administration Guide*. diff --git a/aws/dist/awscli/examples/workdocs/describe-notification-subscriptions.rst b/aws/dist/awscli/examples/workdocs/describe-notification-subscriptions.rst new file mode 100644 index 00000000..d264843f --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-notification-subscriptions.rst @@ -0,0 +1,20 @@ +**To retrieve a list of notification subscriptions** + +The following ``describe-notification-subscriptions`` example retrieves the notification subscriptions for the specified Amazon WorkDocs organization. :: + + aws workdocs describe-notification-subscriptions \ + --organization-id d-123456789c + +Output:: + + { + "Subscriptions": [ + { + "SubscriptionId": "123ab4c5-678d-901e-f23g-45h6789j0123", + "EndPoint": "https://example.com/example", + "Protocol": "HTTPS" + } + ] + } + +For more information, see `Subscribe to Notifications `__ in the *Amazon WorkDocs Developer Guide*. diff --git a/aws/dist/awscli/examples/workdocs/describe-resource-permissions.rst b/aws/dist/awscli/examples/workdocs/describe-resource-permissions.rst new file mode 100644 index 00000000..aea1de6b --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-resource-permissions.rst @@ -0,0 +1,44 @@ +**To get a list of permissions for a resource** + +This example returns a list of the permissions for the specified resource (document or folder). + +Command:: + + aws workdocs describe-resource-permissions --resource-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 + +Output:: + + { + "Principals": [ + { + "Id": "anonymous", + "Type": "ANONYMOUS", + "Roles": [ + { + "Role": "VIEWER", + "Type": "DIRECT" + } + ] + }, + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Type": "USER", + "Roles": [ + { + "Role": "OWNER", + "Type": "DIRECT" + } + ] + }, + { + "Id": "d-926726012c", + "Type": "ORGANIZATION", + "Roles": [ + { + "Role": "VIEWER", + "Type": "INHERITED" + } + ] + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/describe-users.rst b/aws/dist/awscli/examples/workdocs/describe-users.rst new file mode 100644 index 00000000..ce2e075d --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/describe-users.rst @@ -0,0 +1,39 @@ +**To retrieve details for specified users** + +This example retrieves details for all the users in the specified organization. + +Command:: + + aws workdocs describe-users --organization-id d-926726012c + +Output:: + + { + "Users": [ + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Username": "example1User", + "OrganizationId": "d-926726012c", + "RootFolderId": "3c0e3f849dd20a9771d937b9bbcc97e18796150ae56c26d64a4fa0320a2dedc9", + "RecycleBinFolderId": "c277f4c4d647be1f5147b3184ffa96e1e2bf708278b696cacba68ba13b91f4fe", + "Status": "INACTIVE", + "Type": "USER", + "CreatedTimestamp": 1535478999.452, + "ModifiedTimestamp": 1535478999.452 + }, + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-4444&d-926726012c", + "Username": "example2User", + "EmailAddress": "example2User@site.awsapps.com", + "GivenName": "example2Name", + "Surname": "example2Surname", + "OrganizationId": "d-926726012c", + "RootFolderId": "35b886cb17198cbd547655e58b025dff0cf34aaed638be52009567e23dc67390", + "RecycleBinFolderId": "9858c3e9ed4c2460dde9aadb4c69fde998070dd46e5e985bd08ec6169ea249ff", + "Status": "ACTIVE", + "Type": "MINIMALUSER", + "CreatedTimestamp": 1535478836.584, + "ModifiedTimestamp": 1535478836.584 + } + ] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-document-path.rst b/aws/dist/awscli/examples/workdocs/get-document-path.rst new file mode 100644 index 00000000..1bc1fe32 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-document-path.rst @@ -0,0 +1,28 @@ +**To retrieve a document's path information** + +This example retrieves the path information (hierarchy from the root folder) for the specified document, and includes the names of the parent folders. + +Command:: + + aws workdocs get-document-path --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 --fields NAME + +Output:: + + { + "Path": { + "Components": [ + { + "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3", + "Name": "/" + }, + { + "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "Name": "Top Level Folder" + }, + { + "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", + "Name": "exampleDoc.docx" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-document-version.rst b/aws/dist/awscli/examples/workdocs/get-document-version.rst new file mode 100644 index 00000000..b33eca57 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-document-version.rst @@ -0,0 +1,26 @@ +**To retrieve version metadata for a specified document** + +This example retrieves version metadata for the specified document, including a source URL and custom metadata. + +Command:: + + aws workdocs get-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --fields SOURCE --include-custom-metadata + +Output:: + + { + "Metadata": { + "Id": "1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920", + "Name": "exampleDoc", + "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "Size": 11537, + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Status": "ACTIVE", + "CreatedTimestamp": 1521672507.741, + "ModifiedTimestamp": 1534451113.504, + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Source": { + "ORIGINAL": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3/1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920?response-content-disposition=attachment%3B%20filename%2A%3DUTF-8%27%27exampleDoc&X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180820T212202Z&X-Amz-SignedHeaders=host&X-Amz-Expires=900&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180820%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE" + } + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-document.rst b/aws/dist/awscli/examples/workdocs/get-document.rst new file mode 100644 index 00000000..4956d42a --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-document.rst @@ -0,0 +1,31 @@ +**To retrieve document details** + +This example retrieves the details of the specified document. + +Command:: + + aws workdocs get-document --document-id d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65 + +Output:: + + { + "Metadata": { + "Id": "d90d93c1fe44bad0c8471e973ebaab339090401a95e777cffa58e977d2983b65", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "CreatedTimestamp": 1529005196.082, + "ModifiedTimestamp": 1534452483.01, + "LatestVersionMetadata": { + "Id": "1534452029587-15e129dfc187505c407588df255be83de2920d733859f1d2762411d22a83e3ef", + "Name": "exampleDoc.docx", + "ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", + "Size": 13922, + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Status": "ACTIVE", + "CreatedTimestamp": 1534452029.587, + "ModifiedTimestamp": 1534452029.587, + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" + }, + "ResourceState": "ACTIVE" + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-folder-path.rst b/aws/dist/awscli/examples/workdocs/get-folder-path.rst new file mode 100644 index 00000000..a9128179 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-folder-path.rst @@ -0,0 +1,28 @@ +**To retrieve path information for a folder** + +This example retrieves the path information (hierarchy from the root folder) for the specified folder, and includes the names of the parent folders. + +Command:: + + aws workdocs get-folder-path --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --fields NAME + +Output:: + + { + "Path": { + "Components": [ + { + "Id": "a43d29cbb8e7c4d25cfee8b803a504b0dc63e760b55ad0c611c6b87691eb6ff3", + "Name": "/" + }, + { + "Id": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "Name": "Top Level Folder" + }, + { + "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08", + "Name": "Sublevel Folder" + } + ] + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-folder.rst b/aws/dist/awscli/examples/workdocs/get-folder.rst new file mode 100644 index 00000000..5b67e97a --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-folder.rst @@ -0,0 +1,24 @@ +**To retrieve the metadata for a folder** + +This example retrieves the metadata for the specified folder. + +Command:: + + aws workdocs get-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 + +Output:: + + { + "Metadata": { + "Id": "50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08", + "Name": "exampleFolder", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678", + "CreatedTimestamp": 1534450467.622, + "ModifiedTimestamp": 1534451113.504, + "ResourceState": "ACTIVE", + "Signature": "1a23456b78901c23d4ef56gh7EXAMPLE", + "Size": 23019, + "LatestVersionSize": 11537 + } + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/get-resources.rst b/aws/dist/awscli/examples/workdocs/get-resources.rst new file mode 100644 index 00000000..a9ecb3d7 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/get-resources.rst @@ -0,0 +1,16 @@ +**To retrieve shared resources** + +The following ``get-resources`` example retrieves the resources shared with the specified Amazon WorkDocs user. :: + + aws workdocs get-resources \ + --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333" \ + --collection-type SHARED_WITH_ME + +Output:: + + { + "Folders": [], + "Documents": [] + } + +For more information, see `Sharing Files and Folders `__ in the *Amazon WorkDocs User Guide*. diff --git a/aws/dist/awscli/examples/workdocs/initiate-document-version-upload.rst b/aws/dist/awscli/examples/workdocs/initiate-document-version-upload.rst new file mode 100644 index 00000000..02244e22 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/initiate-document-version-upload.rst @@ -0,0 +1,37 @@ +**To initiate a document version upload** + +The following ``initiate-document-upload`` example creates a new document object and version object. :: + + aws workdocs initiate-document-version-upload \ + --name exampledocname \ + --parent-folder-id eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189 + +Output:: + + { + "Metadata": { + "Id": "feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2", + "CreatorId": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "ParentFolderId": "eacd546d952531c633452ed67cac23161aa0d5df2e8061223a59e8f67e7b6189", + "CreatedTimestamp": 1536773972.914, + "ModifiedTimestamp": 1536773972.914, + "LatestVersionMetadata": { + "Id": "1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313", + "Name": "exampledocname", + "ContentType": "application/octet-stream", + "Size": 0, + "Status": "INITIALIZED", + "CreatedTimestamp": 1536773972.914, + "ModifiedTimestamp": 1536773972.914, + "CreatorId": "arn:aws:iam::123456789123:user/EXAMPLE" + }, + "ResourceState": "ACTIVE" + }, + "UploadMetadata": { + "UploadUrl": "https://gb-us-west-2-prod-doc-source.s3.us-west-2.amazonaws.com/feaba64d4efdf271c2521b60a2a44a8f057e84beaabbe22f01267313209835f2/1536773972914-ddb67663e782e7ce8455ebc962217cf9f9e47b5a9a702e5c84dcccd417da9313?X-Amz-Algorithm=AWS1-ABCD-EFG234&X-Amz-Date=20180912T173932Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20180912%2Fus-west-2%2Fs3%2Faws1_request&X-Amz-Signature=01Ab2c34d567e8f90123g456hi78j901k2345678l901234mno56pqr78EXAMPLE", + "SignedHeaders": { + "Content-Type": "application/octet-stream", + "x-amz-server-side-encryption": "ABC123" + } + } + } diff --git a/aws/dist/awscli/examples/workdocs/remove-all-resource-permissions.rst b/aws/dist/awscli/examples/workdocs/remove-all-resource-permissions.rst new file mode 100644 index 00000000..ced183a9 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/remove-all-resource-permissions.rst @@ -0,0 +1,11 @@ +**To remove all permissions from a specified resource** + +This example removes all permissions from the specified resource. + +Command:: + + aws workdocs remove-all-resource-permissions --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/remove-resource-permission.rst b/aws/dist/awscli/examples/workdocs/remove-resource-permission.rst new file mode 100644 index 00000000..e1f798b6 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/remove-resource-permission.rst @@ -0,0 +1,11 @@ +**To remove permissions from a resource** + +This example removes permissions from the resource for the specified principal. + +Command:: + + aws workdocs remove-resource-permission --resource-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 --principal-id anonymous + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/update-document-version.rst b/aws/dist/awscli/examples/workdocs/update-document-version.rst new file mode 100644 index 00000000..c323ac69 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/update-document-version.rst @@ -0,0 +1,11 @@ +**To change a document version status to Active** + +This example changes the status of the document version to Active. + +Command:: + + aws workdocs update-document-version --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --version-id 1521672507741-9f7df0ea5dd0b121c4f3564a0c7c0b4da95cd12c635d3c442af337a88e297920 --version-status ACTIVE + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/update-document.rst b/aws/dist/awscli/examples/workdocs/update-document.rst new file mode 100644 index 00000000..c4db1d54 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/update-document.rst @@ -0,0 +1,11 @@ +**To update a document** + +This example updates a document's name and parent folder. + +Command:: + + aws workdocs update-document --document-id 15df51e0335cfcc6a2e4de9dd8be9f22ee40545ad9176f54758dcf903be982d3 --name updatedDoc --parent-folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/update-folder.rst b/aws/dist/awscli/examples/workdocs/update-folder.rst new file mode 100644 index 00000000..1cb5575f --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/update-folder.rst @@ -0,0 +1,11 @@ +**To update a folder** + +This example updates a folder's name and parent folder. + +Command:: + + aws workdocs update-folder --folder-id 50893c0af679524d1a0e0651130ed6d073e1a05f95bd12c42dcde5d35634ed08 --name exampleFolder1 --parent-folder-id 1ece93e5fe75315c7407c4967918b4fd9da87ddb2a588e67b7fdaf4a98fde678 + +Output:: + + None \ No newline at end of file diff --git a/aws/dist/awscli/examples/workdocs/update-user.rst b/aws/dist/awscli/examples/workdocs/update-user.rst new file mode 100644 index 00000000..d2057ba6 --- /dev/null +++ b/aws/dist/awscli/examples/workdocs/update-user.rst @@ -0,0 +1,32 @@ +**To update a user** + +This example updates the time zone for the specified user. + +Command:: + + aws workdocs update-user --user-id "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c" --time-zone-id "America/Los_Angeles" + +Output:: + + { + "User": { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333&d-926726012c", + "Username": "exampleUser", + "EmailAddress": "exampleUser@site.awsapps.com", + "GivenName": "Example", + "Surname": "User", + "OrganizationId": "d-926726012c", + "RootFolderId": "c5eceb5e1a2d1d460c9d1af8330ae117fc8d39bb1d3ed6acd0992d5ff192d986", + "RecycleBinFolderId": "6ca20102926ad15f04b1d248d6d6e44f2449944eda5c758f9a1e9df6a6b7fa66", + "Status": "ACTIVE", + "Type": "USER", + "TimeZoneId": "America/Los_Angeles", + "Storage": { + "StorageUtilizedInBytes": 0, + "StorageRule": { + "StorageAllocatedInBytes": 53687091200, + "StorageType": "QUOTA" + } + } + } + } diff --git a/aws/dist/awscli/examples/workmail/associate-delegate-to-resource.rst b/aws/dist/awscli/examples/workmail/associate-delegate-to-resource.rst new file mode 100644 index 00000000..48496b52 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/associate-delegate-to-resource.rst @@ -0,0 +1,10 @@ +**To add a delegate to a resource** + +The following ``associate-delegate-to-resource`` command adds a delegate to a resource. :: + + aws workmail associate-delegate-to-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/associate-member-to-group.rst b/aws/dist/awscli/examples/workmail/associate-member-to-group.rst new file mode 100644 index 00000000..63a675b2 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/associate-member-to-group.rst @@ -0,0 +1,10 @@ +**To add a member to a group** + +The following ``associate-member-to-group`` command adds the specified member to a group. :: + + aws workmail associate-member-to-group \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --member-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/create-alias.rst b/aws/dist/awscli/examples/workmail/create-alias.rst new file mode 100644 index 00000000..1946f33e --- /dev/null +++ b/aws/dist/awscli/examples/workmail/create-alias.rst @@ -0,0 +1,10 @@ +**To create an alias** + +The following ``create-alias`` command creates an alias for the specified entity (user or group). :: + + aws workmail create-alias \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --alias exampleAlias@site.awsapps.com + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/create-group.rst b/aws/dist/awscli/examples/workmail/create-group.rst new file mode 100644 index 00000000..11c8748d --- /dev/null +++ b/aws/dist/awscli/examples/workmail/create-group.rst @@ -0,0 +1,13 @@ +**To create a new group** + +The following ``create-group`` command creates a new group for the specified organization. :: + + aws workmail create-group \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --name exampleGroup1 + +Output:: + + { + "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444" + } diff --git a/aws/dist/awscli/examples/workmail/create-resource.rst b/aws/dist/awscli/examples/workmail/create-resource.rst new file mode 100644 index 00000000..05986245 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/create-resource.rst @@ -0,0 +1,14 @@ +**To create a new resource** + +The following ``create-resource`` command creates a new resource (meeting room) for the specified organization. :: + + aws workmail create-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --name exampleRoom1 \ + --type ROOM + +Output:: + + { + "ResourceId": "r-7afe0efbade843a58cdc10251fce992c" + } diff --git a/aws/dist/awscli/examples/workmail/create-user.rst b/aws/dist/awscli/examples/workmail/create-user.rst new file mode 100644 index 00000000..a159524f --- /dev/null +++ b/aws/dist/awscli/examples/workmail/create-user.rst @@ -0,0 +1,15 @@ +**To create a new user** + +The following ``create-user`` command creates a new user. :: + + aws workmail create-user \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --name exampleName \ + --display-name exampleDisplayName \ + --password examplePa$$w0rd + +Output:: + + { + "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333" + } diff --git a/aws/dist/awscli/examples/workmail/delete-alias.rst b/aws/dist/awscli/examples/workmail/delete-alias.rst new file mode 100644 index 00000000..dc3ffdb7 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/delete-alias.rst @@ -0,0 +1,10 @@ +**To delete an alias** + +The following ``delete-alias`` command deletes the alias for the specified entity (user or group). :: + + aws workmail delete-alias \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --alias exampleAlias@site.awsapps.com + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/delete-group.rst b/aws/dist/awscli/examples/workmail/delete-group.rst new file mode 100644 index 00000000..b7dea949 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/delete-group.rst @@ -0,0 +1,9 @@ +**To delete an existing group** + +The following ``delete-group`` command deletes an existing group from Amazon WorkMail. :: + + aws workmail delete-group \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/delete-mailbox-permissions.rst b/aws/dist/awscli/examples/workmail/delete-mailbox-permissions.rst new file mode 100644 index 00000000..2a0435f9 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/delete-mailbox-permissions.rst @@ -0,0 +1,10 @@ +**To delete mailbox permissions** + +The following ``delete-mailbox-permissions`` command deletes mailbox permissions that were previously granted to a user or group. The entity represents the user that owns the mailbox, and the grantee represents the user or group for whom to delete permissions. :: + + aws workmail delete-mailbox-permissions \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --grantee-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/delete-resource.rst b/aws/dist/awscli/examples/workmail/delete-resource.rst new file mode 100644 index 00000000..fd5da200 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/delete-resource.rst @@ -0,0 +1,9 @@ +**To delete an existing resource** + +The following ``delete-resource`` command deletes an existing resource from Amazon WorkMail. :: + + aws workmail delete-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-7afe0efbade843a58cdc10251fce992c + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/delete-user.rst b/aws/dist/awscli/examples/workmail/delete-user.rst new file mode 100644 index 00000000..a56ed41c --- /dev/null +++ b/aws/dist/awscli/examples/workmail/delete-user.rst @@ -0,0 +1,9 @@ +**To delete a user** + +The following ``delete-user`` command deletes the specified user from Amazon WorkMail and all subsequent systems. :: + + aws workmail delete-user \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/deregister-from-work-mail.rst b/aws/dist/awscli/examples/workmail/deregister-from-work-mail.rst new file mode 100644 index 00000000..a0769606 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/deregister-from-work-mail.rst @@ -0,0 +1,9 @@ +**To disable an existing entity** + +The following ``deregister-from-work-mail`` command disables an existing entity (user, group, or resource) from using Amazon WorkMail. :: + + aws workmail deregister-from-work-mail \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/describe-group.rst b/aws/dist/awscli/examples/workmail/describe-group.rst new file mode 100644 index 00000000..409e165e --- /dev/null +++ b/aws/dist/awscli/examples/workmail/describe-group.rst @@ -0,0 +1,15 @@ +**To retrieve information for a group** + +The following ``describe-group`` command retrieves information about the specified group. :: + + aws workmail describe-group \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 + +Output:: + + { + "GroupId": "S-1-1-11-1122222222-2222233333-3333334444-4444", + "Name": "exampleGroup1", + "State": "ENABLED" + } diff --git a/aws/dist/awscli/examples/workmail/describe-organization.rst b/aws/dist/awscli/examples/workmail/describe-organization.rst new file mode 100644 index 00000000..905ae140 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/describe-organization.rst @@ -0,0 +1,18 @@ +**To retrieve information for an organization** + +The following ``describe-organization`` command retrieves information for the specified Amazon WorkMail organization. :: + + aws workmail describe-organization \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 + +Output:: + + { + "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27", + "Alias": "alias", + "State": "Active", + "DirectoryId": "d-926726012c", + "DirectoryType": "VpcDirectory", + "DefaultMailDomain": "site.awsapps.com", + "CompletedDate": 1522693605.468 + } diff --git a/aws/dist/awscli/examples/workmail/describe-resource.rst b/aws/dist/awscli/examples/workmail/describe-resource.rst new file mode 100644 index 00000000..fdf11d94 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/describe-resource.rst @@ -0,0 +1,21 @@ +**To retrieve information for a resource** + +The following ``describe-resource`` command retrieves information about the specified resource. :: + + aws workmail describe-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-7afe0efbade843a58cdc10251fce992c + +Output:: + + { + "ResourceId": "r-7afe0efbade843a58cdc10251fce992c", + "Name": "exampleRoom1", + "Type": "ROOM", + "BookingOptions": { + "AutoAcceptRequests": true, + "AutoDeclineRecurringRequests": false, + "AutoDeclineConflictingRequests": true + }, + "State": "ENABLED" + } diff --git a/aws/dist/awscli/examples/workmail/describe-user.rst b/aws/dist/awscli/examples/workmail/describe-user.rst new file mode 100644 index 00000000..eb23e097 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/describe-user.rst @@ -0,0 +1,19 @@ +**To retrieve user information** + +The following ``describe-user`` command retrieves information about the specified user. :: + + aws workmail describe-user \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +Output:: + + { + "UserId": "S-1-1-11-1111111111-2222222222-3333333333-3333", + "Name": "exampleUser1", + "Email": "exampleUser1@site.awsapps.com", + "DisplayName": "", + "State": "ENABLED", + "UserRole": "USER", + "EnabledDate": 1532459261.827 + } diff --git a/aws/dist/awscli/examples/workmail/disassociate-delegate-from-resource.rst b/aws/dist/awscli/examples/workmail/disassociate-delegate-from-resource.rst new file mode 100644 index 00000000..c155b221 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/disassociate-delegate-from-resource.rst @@ -0,0 +1,10 @@ +**To remove a member from a resource** + +The following ``disassociate-delegate-from-resource`` command removes the specified member from a resource. :: + + ws workmail disassociate-delegate-from-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-68bf2d3b1c0244aab7264c24b9217443 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/disassociate-member-from-group.rst b/aws/dist/awscli/examples/workmail/disassociate-member-from-group.rst new file mode 100644 index 00000000..ba22d4af --- /dev/null +++ b/aws/dist/awscli/examples/workmail/disassociate-member-from-group.rst @@ -0,0 +1,10 @@ +**To remove a member from a group** + +The following ``disassociate-member-from-group`` command removes the specified member from a group. :: + + aws workmail disassociate-member-from-group \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --member-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/get-mailbox-details.rst b/aws/dist/awscli/examples/workmail/get-mailbox-details.rst new file mode 100644 index 00000000..b5b749f5 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/get-mailbox-details.rst @@ -0,0 +1,16 @@ +**To get a user's mailbox details** + +The following ``get-mailbox-details`` command retrieves details about the specified user's mailbox. :: + + aws workmail get-mailbox-details \ + --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ + --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +Output:: + + { + "MailboxQuota": 51200, + "MailboxSize": 0.03890800476074219 + } + +For more information, see `Managing User Accounts `__ in the *Amazon WorkMail Administrator Guide*. diff --git a/aws/dist/awscli/examples/workmail/list-aliases.rst b/aws/dist/awscli/examples/workmail/list-aliases.rst new file mode 100644 index 00000000..7834cd96 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-aliases.rst @@ -0,0 +1,16 @@ +**To list aliases for a member** + +The following ``list-aliases`` command lists aliases for the specified member (user or group). :: + + aws workmail list-aliases \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +Output:: + + { + "Aliases": [ + "exampleAlias@site.awsapps.com", + "exampleAlias1@site.awsapps.com" + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-group-members.rst b/aws/dist/awscli/examples/workmail/list-group-members.rst new file mode 100644 index 00000000..95f4f36a --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-group-members.rst @@ -0,0 +1,21 @@ +**To list group members** + +The following ``list-group-members`` command lists the members of the specified group. :: + + aws workmail list-group-members \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --group-id S-1-1-11-1122222222-2222233333-3333334444-4444 + +Output:: + + { + "Members": [ + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", + "Name": "exampleUser1", + "Type": "USER", + "State": "ENABLED", + "EnabledDate": 1532459261.827 + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-groups.rst b/aws/dist/awscli/examples/workmail/list-groups.rst new file mode 100644 index 00000000..b18e5165 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-groups.rst @@ -0,0 +1,23 @@ +**To retrieve a list of groups** + +The following ``list-groups`` command retrieves summaries of the groups in the specified organization. :: + + aws workmail list-groups \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 + +Output:: + + { + "Groups": [ + { + "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444", + "Name": "exampleGroup1", + "State": "DISABLED" + }, + { + "Id": "S-4-4-44-1122222222-2222233333-3333334444-4444", + "Name": "exampleGroup2", + "State": "ENABLED" + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-mailbox-permissions.rst b/aws/dist/awscli/examples/workmail/list-mailbox-permissions.rst new file mode 100644 index 00000000..2f99c679 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-mailbox-permissions.rst @@ -0,0 +1,21 @@ +**To retrieve mailbox permissions** + +The following ``list-mailbox-permissions`` command retrieves the mailbox permissions associated with the specified entity's mailbox. :: + + aws workmail list-mailbox-permissions \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 + +Output:: + + { + "Permissions": [ + { + "GranteeId": "S-1-1-11-1122222222-2222233333-3333334444-4444", + "GranteeType": "USER", + "PermissionValues": [ + "FULL_ACCESS" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-organizations.rst b/aws/dist/awscli/examples/workmail/list-organizations.rst new file mode 100644 index 00000000..b328f022 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-organizations.rst @@ -0,0 +1,17 @@ +**To retrieve a list of organizations** + +The following ``list-organizations`` command retrieves summaries of non-deleted organizations. :: + + aws workmail list-organizations + +Output:: + + { + "OrganizationSummaries": [ + { + "OrganizationId": "m-d281d0a2fd824be5b6cd3d3ce909fd27", + "Alias": "exampleAlias", + "State": "Active" + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-resource-delegates.rst b/aws/dist/awscli/examples/workmail/list-resource-delegates.rst new file mode 100644 index 00000000..89429381 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-resource-delegates.rst @@ -0,0 +1,18 @@ +**To list the delegates for a resource** + +The following ``list-resource-delegates`` command retrieves the delegates associated with the specified resource. :: + + aws workmail list-resource-delegates \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-68bf2d3b1c0244aab7264c24b9217443 + +Output:: + + { + "Delegates": [ + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", + "Type": "USER" + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-resources.rst b/aws/dist/awscli/examples/workmail/list-resources.rst new file mode 100644 index 00000000..bd8fa46a --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-resources.rst @@ -0,0 +1,19 @@ +**To retrieve a list of resources** + +The following ``list-resources`` command retrieves summaries of the resources for the specified organization. :: + + aws workmail list-resources \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 + +Output:: + + { + "Resources": [ + { + "Id": "r-7afe0efbade843a58cdc10251fce992c", + "Name": "exampleRoom1", + "Type": "ROOM", + "State": "ENABLED" + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/list-users.rst b/aws/dist/awscli/examples/workmail/list-users.rst new file mode 100644 index 00000000..606ea009 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/list-users.rst @@ -0,0 +1,27 @@ +**To retrieve a list of users** + +The following ``list-users`` command retrieves summaries of the users in the specified organization. :: + + aws workmail list-users \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 + +Output:: + + { + "Users": [ + { + "Id": "S-1-1-11-1111111111-2222222222-3333333333-3333", + "Email": "exampleUser1@site.awsapps.com", + "Name": "exampleUser1", + "State": "ENABLED", + "UserRole": "USER", + "EnabledDate": 1532459261.827 + }, + { + "Id": "S-1-1-11-1122222222-2222233333-3333334444-4444", + "Name": "exampleGuestUser", + "State": "DISABLED", + "UserRole": "SYSTEM_USER" + } + ] + } diff --git a/aws/dist/awscli/examples/workmail/put-mailbox-permissions.rst b/aws/dist/awscli/examples/workmail/put-mailbox-permissions.rst new file mode 100644 index 00000000..a6fce2f4 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/put-mailbox-permissions.rst @@ -0,0 +1,11 @@ +**To set mailbox permissions** + +The following ``put-mailbox-permissions`` command sets full access permissions for the specified grantee (user or group). The entity represents the owner of the mailbox. :: + + aws workmail put-mailbox-permissions \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ + --grantee-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --permission-values FULL_ACCESS + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/register-to-work-mail.rst b/aws/dist/awscli/examples/workmail/register-to-work-mail.rst new file mode 100644 index 00000000..7b3ae449 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/register-to-work-mail.rst @@ -0,0 +1,10 @@ +**To register an existing or disabled entity** + +The following ``register-to-work-mail`` command enables the specified existing entity (user, group, or resource) to use Amazon WorkMail. :: + + aws workmail register-to-work-mail \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1122222222-2222233333-3333334444-4444 \ + --email exampleGroup1@site.awsapps.com + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/reset-password.rst b/aws/dist/awscli/examples/workmail/reset-password.rst new file mode 100644 index 00000000..3396c094 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/reset-password.rst @@ -0,0 +1,10 @@ +**To reset a user's password** + +The following ``reset-password`` command resets the password for the specified user. :: + + aws workmail reset-password \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ + --password examplePa$$w0rd + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/update-mailbox-quota.rst b/aws/dist/awscli/examples/workmail/update-mailbox-quota.rst new file mode 100644 index 00000000..fdc3c393 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/update-mailbox-quota.rst @@ -0,0 +1,12 @@ +**To update a user's mailbox quota** + +The following ``update-mailbox-quota`` command changes the specified user's mailbox quota. :: + + aws workmail update-mailbox-quota \ + --organization-id m-n1pq2345678r901st2u3vx45x6789yza \ + --user-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ + --mailbox-quota 40000 + +This command produces no output. + +For more information, see `Managing User Accounts `__ in the *Amazon WorkMail Administrator Guide*. diff --git a/aws/dist/awscli/examples/workmail/update-primary-email-address.rst b/aws/dist/awscli/examples/workmail/update-primary-email-address.rst new file mode 100644 index 00000000..bdb9f886 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/update-primary-email-address.rst @@ -0,0 +1,10 @@ +**To update a primary email address** + +The following ``update-primary-email-address`` command updates the primary email address of the specified entity (user, group, or resource). :: + + aws workmail update-primary-email-address \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --entity-id S-1-1-11-1111111111-2222222222-3333333333-3333 \ + --email exampleUser2@site.awsapps.com + +This command produces no output. diff --git a/aws/dist/awscli/examples/workmail/update-resource.rst b/aws/dist/awscli/examples/workmail/update-resource.rst new file mode 100644 index 00000000..ccb03cb8 --- /dev/null +++ b/aws/dist/awscli/examples/workmail/update-resource.rst @@ -0,0 +1,10 @@ +**To update a resource** + +The following ``update-resource`` command updates the name of the specified resource. :: + + aws workmail update-resource \ + --organization-id m-d281d0a2fd824be5b6cd3d3ce909fd27 \ + --resource-id r-7afe0efbade843a58cdc10251fce992c \ + --name exampleRoom2 + +This command produces no output. diff --git a/aws/dist/awscli/examples/workspaces/create-workspaces.rst b/aws/dist/awscli/examples/workspaces/create-workspaces.rst new file mode 100644 index 00000000..0f3f9333 --- /dev/null +++ b/aws/dist/awscli/examples/workspaces/create-workspaces.rst @@ -0,0 +1,36 @@ +**To create a WorkSpace** + +This example creates a WorkSpace for user ``jimsmith`` in the specified directory, from the specified bundle. + +Command:: + + aws workspaces create-workspaces --cli-input-json file://create-workspaces.json + +Input:: + + This is the contents of the create-workspaces.json file: + + { + "Workspaces" : [ + { + "DirectoryId" : "d-906732325d", + "UserName" : "jimsmith", + "BundleId" : "wsb-b0s22j3d7" + } + ] + } + +Output:: + + { + "PendingRequests" : [ + { + "UserName" : "jimsmith", + "DirectoryId" : "d-906732325d", + "State" : "PENDING", + "WorkspaceId" : "ws-0d4y2sbl5", + "BundleId" : "wsb-b0s22j3d7" + } + ], + "FailedRequests" : [] + } diff --git a/aws/dist/awscli/examples/workspaces/describe-workspace-bundles.rst b/aws/dist/awscli/examples/workspaces/describe-workspace-bundles.rst new file mode 100644 index 00000000..edae7ed0 --- /dev/null +++ b/aws/dist/awscli/examples/workspaces/describe-workspace-bundles.rst @@ -0,0 +1,122 @@ +**To describe your WorkSpace bundles** + +This example describes all of the WorkSpace bundles that are provided by AWS. + +Command:: + + aws workspaces describe-workspace-bundles --owner AMAZON + +Output:: + + { + "Bundles": [ + { + "ComputeType": { + "Name": "PERFORMANCE" + }, + "Description": "Performance Bundle", + "BundleId": "wsb-b0s22j3d7", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "100" + }, + "Name": "Performance" + }, + { + "ComputeType": { + "Name": "VALUE" + }, + "Description": "Value Base Bundle", + "BundleId": "wsb-92tn3b7gx", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "10" + }, + "Name": "Value" + }, + { + "ComputeType": { + "Name": "STANDARD" + }, + "Description": "Standard Bundle", + "BundleId": "wsb-3t36q0xfc", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "50" + }, + "Name": "Standard" + }, + { + "ComputeType": { + "Name": "PERFORMANCE" + }, + "Description": "Performance Plus Bundle", + "BundleId": "wsb-1b5w6vnz6", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "100" + }, + "Name": "Performance Plus" + }, + { + "ComputeType": { + "Name": "VALUE" + }, + "Description": "Value Plus Office 2013", + "BundleId": "wsb-fgy4lgypc", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "10" + }, + "Name": "Value Plus Office 2013" + }, + { + "ComputeType": { + "Name": "PERFORMANCE" + }, + "Description": "Performance Plus Office 2013", + "BundleId": "wsb-vbsjd64y6", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "100" + }, + "Name": "Performance Plus Office 2013" + }, + { + "ComputeType": { + "Name": "VALUE" + }, + "Description": "Value Plus Bundle", + "BundleId": "wsb-kgjp98lt8", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "10" + }, + "Name": "Value Plus" + }, + { + "ComputeType": { + "Name": "STANDARD" + }, + "Description": "Standard Plus Office 2013", + "BundleId": "wsb-5h1pf1zxc", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "50" + }, + "Name": "Standard Plus Office 2013" + }, + { + "ComputeType": { + "Name": "STANDARD" + }, + "Description": "Standard Plus Bundle", + "BundleId": "wsb-vlsvncjjf", + "Owner": "Amazon", + "UserStorage": { + "Capacity": "50" + }, + "Name": "Standard Plus" + } + ] + } diff --git a/aws/dist/awscli/examples/workspaces/describe-workspace-directories.rst b/aws/dist/awscli/examples/workspaces/describe-workspace-directories.rst new file mode 100644 index 00000000..5dc6ae54 --- /dev/null +++ b/aws/dist/awscli/examples/workspaces/describe-workspace-directories.rst @@ -0,0 +1,63 @@ +**To describe your WorkSpace directories** + +This example describes all of your WorkSpace directories. + +Command:: + + aws workspaces describe-workspace-directories + +Output:: + + { + "Directories" : [ + { + "CustomerUserName" : "Administrator", + "DirectoryId" : "d-906735683d", + "DirectoryName" : "example.awsapps.com", + "SubnetIds" : [ + "subnet-af0e2a87", + "subnet-657e7a23" + ], + "WorkspaceCreationProperties" : + { + "EnableInternetAccess" : false, + "EnableWorkDocs" : false, + "UserEnabledAsLocalAdministrator" : true + }, + "Alias" : "example", + "State" : "REGISTERED", + "DirectoryType" : "SIMPLE_AD", + "RegistrationCode" : "SLiad+S393HD", + "IamRoleId" : "arn:aws:iam::972506530580:role/workspaces_DefaultRole", + "DnsIpAddresses" : [ + "10.0.2.190", + "10.0.1.202" + ], + "WorkspaceSecurityGroupId" : "sg-6e40640b" + }, + { + "CustomerUserName" : "Administrator", + "DirectoryId" : "d-906732325d", + "DirectoryName" : "exampledomain.com", + "SubnetIds" : [ + "subnet-775a6531", + "subnet-435c036b" + ], + "WorkspaceCreationProperties" : + { + "EnableInternetAccess" : false, + "EnableWorkDocs" : true, + "UserEnabledAsLocalAdministrator" : true + }, + "Alias" : "example-domain", + "State" : "REGISTERED", + "DirectoryType" : "AD_CONNECTOR", + "RegistrationCode" : "SLiad+UBZGNH", + "IamRoleId" : "arn:aws:iam::972506530580:role/workspaces_DefaultRole", + "DnsIpAddresses" : [ + "50.0.2.223", + "50.0.2.184" + ] + } + ] + } diff --git a/aws/dist/awscli/examples/workspaces/describe-workspaces.rst b/aws/dist/awscli/examples/workspaces/describe-workspaces.rst new file mode 100644 index 00000000..df6133a6 --- /dev/null +++ b/aws/dist/awscli/examples/workspaces/describe-workspaces.rst @@ -0,0 +1,39 @@ +**To describe your WorkSpaces** + +This example describes all of your WorkSpaces in the region. + +Command:: + + aws workspaces describe-workspaces + +Output:: + + { + "Workspaces" : [ + { + "UserName" : "johndoe", + "DirectoryId" : "d-906732325d", + "State" : "AVAILABLE", + "WorkspaceId" : "ws-3lvdznndy", + "SubnetId" : "subnet-435c036b", + "IpAddress" : "50.0.1.10", + "BundleId" : "wsb-86y2d88pq" + }, + { + "UserName": "jimsmith", + "DirectoryId": "d-906732325d", + "State": "PENDING", + "WorkspaceId": "ws-0d4y2sbl5", + "BundleId": "wsb-b0s22j3d7" + }, + { + "UserName" : "marym", + "DirectoryId" : "d-906732325d", + "State" : "AVAILABLE", + "WorkspaceId" : "ws-b3vg4shrh", + "SubnetId" : "subnet-775a6531", + "IpAddress" : "50.0.0.5", + "BundleId" : "wsb-3t36q0xfc" + } + ] + } diff --git a/aws/dist/awscli/examples/workspaces/terminate-workspaces.rst b/aws/dist/awscli/examples/workspaces/terminate-workspaces.rst new file mode 100644 index 00000000..00983258 --- /dev/null +++ b/aws/dist/awscli/examples/workspaces/terminate-workspaces.rst @@ -0,0 +1,13 @@ +**To terminate a WorkSpace** + +This example terminates the specified WorkSpace. + +Command:: + + aws workspaces terminate-workspaces --terminate-workspace-requests wsb-3t36q0xfc + +Output:: + + { + "FailedRequests": [] + } \ No newline at end of file diff --git a/aws/dist/awscli/examples/xray/batch-traces-get.rst b/aws/dist/awscli/examples/xray/batch-traces-get.rst new file mode 100644 index 00000000..513de2ba --- /dev/null +++ b/aws/dist/awscli/examples/xray/batch-traces-get.rst @@ -0,0 +1,30 @@ +**To get a list of traces** + +The following ``batch-get-traces`` example retrieves a list of traces specified by an ID. The full trace includes a document for each segment, compiled from all of the segment documents received with the same trace ID. :: + + aws xray batch-get-traces \ + --trace-ids 1-5d82881a-0a9126e92a73e971eed891b9 + +Output:: + + { + "Traces": [ + { + "Id": "1-5d82881a-0a9126e92a73e971eed891b9", + "Duration": 0.232, + "Segments": [ + { + "Id": "54aff5735b12dd28", + "Document": "{\"id\":\"54aff5735b12dd28\",\"name\":\"Scorekeep\",\"start_time\":1.568835610432E9,\"end_time\":1.568835610664E9,\"http\":{\"request\":{\"url\":\"http://scorekeep-env-1.m4fg2pfzpv.us-east-2.elasticbeanstalk.com/api/user\",\"method\":\"POST\",\"user_agent\":\"curl/7.59.0\",\"client_ip\":\"52.95.4.28\",\"x_forwarded_for\":true},\"response\":{\"status\":200}},\"aws\":{\"elastic_beanstalk\":{\"version_label\":\"Sample Application-1\",\"deployment_id\":3,\"environment_name\":\"Scorekeep-env-1\"},\"ec2\":{\"availability_zone\":\"us-east-2b\",\"instance_id\":\"i-0e3cf4d2de0f3f37a\"},\"xray\":{\"sdk_version\":\"1.1.0\",\"sdk\":\"X-Ray for Java\"}},\"service\":{\"runtime\":\"OpenJDK 64-Bit Server VM\",\"runtime_version\":\"1.8.0_222\"},\"trace_id\":\"1-5d82881a-0a9126e92a73e971eed891b9\",\"origin\":\"AWS::ElasticBeanstalk::Environment\",\"subsegments\":[{\"id\":\"2d6900034ccfe558\",\"name\":\"DynamoDB\",\"start_time\":1.568835610658E9,\"end_time\":1.568835610664E9,\"http\":{\"response\":{\"status\":200,\"content_length\":61}},\"aws\":{\"table_name\":\"scorekeep-user\",\"operation\":\"UpdateItem\",\"request_id\":\"TPEIDNDUROMLPOV17U4A79555NVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-user\"]},\"namespace\":\"aws\"}]}" + }, + { + "Id": "0f278b6334c34e6b", + "Document": "{\"id\":\"0f278b6334c34e6b\",\"name\":\"DynamoDB\",\"start_time\":1.568835610658E9,\"end_time\":1.568835610664E9,\"parent_id\":\"2d6900034ccfe558\",\"inferred\":true,\"http\":{\"response\":{\"status\":200,\"content_length\":61}},\"aws\":{\"table_name\":\"scorekeep-user\",\"operation\":\"UpdateItem\",\"request_id\":\"TPEIDNDUROMLPOV17U4A79555NVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-user\"]},\"trace_id\":\"1-5d82881a-0a9126e92a73e971eed891b9\",\"origin\":\"AWS::DynamoDB::Table\"}" + } + ] + } + ], + "UnprocessedTraceIds": [] + } + +For more information, see `Using the AWS X-Ray API with the AWS CLI `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/create-group.rst b/aws/dist/awscli/examples/xray/create-group.rst new file mode 100644 index 00000000..d139067b --- /dev/null +++ b/aws/dist/awscli/examples/xray/create-group.rst @@ -0,0 +1,17 @@ +**To create a group** + +The following ``create-group`` example creates a group resource named ``AdminGroup``. The group gets a filter expression that defines the criteria of the group as a segment related to a specific service causing a fault or an error. :: + + aws xray create-group \ + --group-name "AdminGroup" \ + --filter-expression "service(\"mydomain.com\") {fault OR error}" + +Output:: + + { + "GroupName": "AdminGroup", + "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", + "FilterExpression": "service(\"mydomain.com\") {fault OR error}" + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/create-sampling-rule.rst b/aws/dist/awscli/examples/xray/create-sampling-rule.rst new file mode 100644 index 00000000..23c1480d --- /dev/null +++ b/aws/dist/awscli/examples/xray/create-sampling-rule.rst @@ -0,0 +1,50 @@ +**To create a sampling rule** + +The following ``create-sampling-rule`` example creates a rule to control sampling behavior for instrumented applications. The rules are provided by a JSON file. The majority of the sampling rule fields are required to create the rule. :: + + aws xray create-sampling-rule \ + --cli-input-json file://9000-base-scorekeep.json + +Contents of ``9000-base-scorekeep.json``:: + + { + "SamplingRule": { + "RuleName": "base-scorekeep", + "ResourceARN": "*", + "Priority": 9000, + "FixedRate": 0.1, + "ReservoirSize": 5, + "ServiceName": "Scorekeep", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "*", + "URLPath": "*", + "Version": 1 + } + } + +Output:: + + { + "SamplingRuleRecord": { + "SamplingRule": { + "RuleName": "base-scorekeep", + "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/base-scorekeep", + "ResourceARN": "*", + "Priority": 9000, + "FixedRate": 0.1, + "ReservoirSize": 5, + "ServiceName": "Scorekeep", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "*", + "URLPath": "*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 1530574410.0, + "ModifiedAt": 1530574410.0 + } + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/delete-group.rst b/aws/dist/awscli/examples/xray/delete-group.rst new file mode 100644 index 00000000..2e2dea92 --- /dev/null +++ b/aws/dist/awscli/examples/xray/delete-group.rst @@ -0,0 +1,11 @@ +**To delete a group** + +The following ``delete-group`` example deletes the specified group resource. :: + + aws xray delete-group \ + --group-name "AdminGroup" \ + --group-arn "arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789" + +This command produces no output. + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/delete-sampling-rule.rst b/aws/dist/awscli/examples/xray/delete-sampling-rule.rst new file mode 100644 index 00000000..e7ada9ae --- /dev/null +++ b/aws/dist/awscli/examples/xray/delete-sampling-rule.rst @@ -0,0 +1,32 @@ +**To delete a sampling rule** + +The following ``delete-sampling-rule`` example deletes the specified sampling rule. You can specify the group by using either the group name or group ARN. :: + + aws xray delete-sampling-rule \ + --rule-name polling-scorekeep + +Output:: + + { + "SamplingRuleRecord": { + "SamplingRule": { + "RuleName": "polling-scorekeep", + "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/polling-scorekeep", + "ResourceARN": "*", + "Priority": 5000, + "FixedRate": 0.003, + "ReservoirSize": 0, + "ServiceName": "Scorekeep", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "GET", + "URLPath": "/api/state/*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 1530574399.0, + "ModifiedAt": 1530574399.0 + } + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-encryption-config.rst b/aws/dist/awscli/examples/xray/get-encryption-config.rst new file mode 100644 index 00000000..845c5895 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-encryption-config.rst @@ -0,0 +1,17 @@ +**To retrieve the encryption configuration** + +The following ``get-encryption-config`` example retrieves the current encryption configuration for your AWS X-Ray data. :: + + aws xray get-encryption-config + +Output:: + + { + "EncryptionConfig": { + "KeyId": "ae4aa6d49-a4d8-9df9-a475-4ff6d7898456", + "Status": "ACTIVE", + "Type": "NONE" + } + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-group.rst b/aws/dist/awscli/examples/xray/get-group.rst new file mode 100644 index 00000000..c4def3f0 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-group.rst @@ -0,0 +1,20 @@ +**To retrieve a group** + +The following ``get-group`` example displays details for the specified group resource. The details include the group name, the group ARN, and the filter expression that defines the criteria for that group. Groups can also be retrieved by ARN. :: + + aws xray get-group \ + --group-name "AdminGroup" + +Output:: + + { + "Group": [ + { + "GroupName": "AdminGroup", + "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", + "FilterExpression": "service(\"mydomain.com\") {fault OR error}" + } + ] + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-groups.rst b/aws/dist/awscli/examples/xray/get-groups.rst new file mode 100644 index 00000000..c2d7bb97 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-groups.rst @@ -0,0 +1,24 @@ +**To retrieve all groups** + +The following example displays details for all active group. :: + + aws xray get-groups + +Output:: + + { + "Groups": [ + { + "GroupName": "AdminGroup", + "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789", + "FilterExpression": "service(\"example.com\") {fault OR error}" + }, + { + "GroupName": "SDETGroup", + "GroupARN": "arn:aws:xray:us-west-2:123456789012:group/SDETGroup/987654321", + "FilterExpression": "responsetime > 2" + } + ] + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-sampling-rules.rst b/aws/dist/awscli/examples/xray/get-sampling-rules.rst new file mode 100644 index 00000000..d99b2ad8 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-sampling-rules.rst @@ -0,0 +1,71 @@ +**To retrieve all sampling rules** + +The following ``get-sampling-rules`` example displays details for all available sampling rules.:: + + aws xray get-sampling-rules + +Output:: + + { + "SamplingRuleRecords": [ + { + "SamplingRule": { + "RuleName": "Default", + "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/Default", + "ResourceARN": "*", + "Priority": 10000, + "FixedRate": 0.01, + "ReservoirSize": 0, + "ServiceName": "*", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "*", + "URLPath": "*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 0.0, + "ModifiedAt": 1530558121.0 + }, + { + "SamplingRule": { + "RuleName": "base-scorekeep", + "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/base-scorekeep", + "ResourceARN": "*", + "Priority": 9000, + "FixedRate": 0.1, + "ReservoirSize": 2, + "ServiceName": "Scorekeep", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "*", + "URLPath": "*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 1530573954.0, + "ModifiedAt": 1530920505.0 + }, + { + "SamplingRule": { + "RuleName": "polling-scorekeep", + "RuleARN": "arn:aws:xray:us-east-1::sampling-rule/polling-scorekeep", + "ResourceARN": "*", + "Priority": 5000, + "FixedRate": 0.003, + "ReservoirSize": 0, + "ServiceName": "Scorekeep", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "GET", + "URLPath": "/api/state/*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 1530918163.0, + "ModifiedAt": 1530918163.0 + } + ] + } + +For more information, see `Using Sampling Rules with the X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-sampling-targets.rst b/aws/dist/awscli/examples/xray/get-sampling-targets.rst new file mode 100644 index 00000000..6f927c5e --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-sampling-targets.rst @@ -0,0 +1,31 @@ +**To request a sampling quota** + +The following ``get-sampling-targets`` example requests a sampling quota for rules that the service is using to sample requests. The response from AWS X-Ray includes a quota that can be used instead of borrowing from the reservoir. :: + + aws xray get-sampling-targets \ + --sampling-statistics-documents '[ { "RuleName": "base-scorekeep", "ClientID": "ABCDEF1234567890ABCDEF10", "Timestamp": "2018-07-07T00:20:06, "RequestCount": 110, "SampledCount": 20, "BorrowCount": 10 }, { "RuleName": "polling-scorekeep", 31, "BorrowCount": 0 } ]' + +Output:: + + { + "SamplingTargetDocuments": [ + { + "RuleName": "base-scorekeep", + "FixedRate": 0.1, + "ReservoirQuota": 2, + "ReservoirQuotaTTL": 1530923107.0, + "Interval": 10 + }, + { + "RuleName": "polling-scorekeep", + "FixedRate": 0.003, + "ReservoirQuota": 0, + "ReservoirQuotaTTL": 1530923107.0, + "Interval": 10 + } + ], + "LastRuleModification": 1530920505.0, + "UnprocessedStatistics": [] + } + +For more information, see `Using Sampling Rules with the X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-service-graph.rst b/aws/dist/awscli/examples/xray/get-service-graph.rst new file mode 100644 index 00000000..7b1390f8 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-service-graph.rst @@ -0,0 +1,86 @@ +**To get a service graph** + +The following example displays a document within a specified time period that describes services processing incoming requests, and the downstream services that they call as a result.:: + + aws xray get-service-graph \ + --start-time 1568835392.0 + --end-time 1568835446.0 + +Output:: + + { + "Services": [ + { + "ReferenceId": 0, + "Name": "Scorekeep", + "Names": [ + "Scorekeep" + ], + "Root": true, + "Type": "AWS::ElasticBeanstalk::Environment", + "State": "active", + "StartTime": 1568835392.0, + "EndTime": 1568835446.0, + "Edges": [ + { + "ReferenceId": 1, + "StartTime": 1568835392.0, + "EndTime": 1568835446.0, + "SummaryStatistics": { + "OkCount": 14, + "ErrorStatistics": { + "ThrottleCount": 0, + "OtherCount": 0, + "TotalCount": 0 + }, + "FaultStatistics": { + "OtherCount": 0, + "TotalCount": 0 + }, + "TotalCount": 14, + "TotalResponseTime": 0.13 + }, + "ResponseTimeHistogram": [ + { + "Value": 0.008, + "Count": 1 + }, + { + "Value": 0.005, + "Count": 7 + }, + { + "Value": 0.009, + "Count": 1 + }, + { + "Value": 0.021, + "Count": 1 + }, + { + "Value": 0.038, + "Count": 1 + }, + { + "Value": 0.007, + "Count": 1 + }, + { + "Value": 0.006, + "Count": 2 + } + ], + "Aliases": [] + }, + + ... TRUNCATED FOR BREVITY ... + + ] + } + ], + "StartTime": 1568835392.0, + "EndTime": 1568835446.0, + "ContainsOldGroupVersions": false + } + +For more information, see `Using the AWS X-Ray API with the AWS CLI `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/get-trace-summaries.rst b/aws/dist/awscli/examples/xray/get-trace-summaries.rst new file mode 100644 index 00000000..b3ce7198 --- /dev/null +++ b/aws/dist/awscli/examples/xray/get-trace-summaries.rst @@ -0,0 +1,18 @@ +**To get a trace summary** + +The following ``get-trace-summaries`` example retrieves IDs and metadata for traces available within a specified time frame. :: + + aws xray get-trace-summaries \ + --start-time 1568835392.0 \ + --end-time 1568835446.0 + +Output:: + + [ + "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/VSAE93HF/GSSD2NTB/DP0PCC09", + "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/GCQ2B35P/FREELDFT/4LRE643M", + "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/game/VSAE93HF/GSSD2NTB/starttime/1568835513", + "http://scorekeep-env-1.123456789.us-east-2.elasticbeanstalk.com/api/move/4MQNA5NN/L99KK2RF/null" + ] + +For more information, see `Using the AWS X-Ray API with the AWS CLI `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/put-encryption-config.rst b/aws/dist/awscli/examples/xray/put-encryption-config.rst new file mode 100644 index 00000000..775e185d --- /dev/null +++ b/aws/dist/awscli/examples/xray/put-encryption-config.rst @@ -0,0 +1,19 @@ +**To update the encryption configuration** + +The following ``put-encryption-config``example updates the encryption configuration for AWS X-Ray data to use the default AWS managed KMS key ``aws/xray``. :: + + aws xray put-encryption-config \ + --type KMS \ + --key-id alias/aws/xray + +Output:: + + { + "EncryptionConfig": { + "KeyId": "arn:aws:kms:us-west-2:123456789012:key/c234g4e8-39e9-4gb0-84e2-b0ea215cbba5", + "Status": "UPDATING", + "Type": "KMS" + } + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/put-trace-segments.rst b/aws/dist/awscli/examples/xray/put-trace-segments.rst new file mode 100644 index 00000000..b179f199 --- /dev/null +++ b/aws/dist/awscli/examples/xray/put-trace-segments.rst @@ -0,0 +1,14 @@ +**To upload a segment** + +The following ``put-trace-segments`` example uploads segment documents to AWS X-Ray. The segment document is consumed as a list of JSON segment documents. :: + + aws xray put-trace-segments \ + --trace-segment-documents "{\"id\":\"20312a0e2b8809f4\",\"name\":\"DynamoDB\",\"trace_id\":\"1-5832862d-a43aafded3334a971fe312db\",\"start_time\":1.479706157195E9,\"end_time\":1.479706157202E9,\"parent_id\":\"79736b962fe3239e\",\"http\":{\"response\":{\"content_length\":60,\"status\":200}},\"inferred\":true,\"aws\":{\"consistent_read\":false,\"table_name\":\"scorekeep-session-xray\",\"operation\":\"GetItem\",\"request_id\":\"SCAU23OM6M8FO38UASGC7785ARVV4KQNSO5AEMVJF66Q9ASUAAJG\",\"resource_names\":[\"scorekeep-session-xray\"]},\"origin\":\"AWS::DynamoDB::Table\"}" + +Output:: + + { + "UnprocessedTraceSegments": [] + } + +For more information, see `Sending Trace Data to AWS X-Ray `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/update-group.rst b/aws/dist/awscli/examples/xray/update-group.rst new file mode 100644 index 00000000..0be2b883 --- /dev/null +++ b/aws/dist/awscli/examples/xray/update-group.rst @@ -0,0 +1,18 @@ +**To update a group** + +The following ``update-group`` example updates the criteria by which to accept traces into the group named ``AdminGroup``. You can specify the desired group by using either the group name or group ARN. :: + + aws xray update-group \ + --group-name "AdminGroup" \ + --group-arn "arn:aws:xray:us-west-2:123456789012:group/AdminGroup/123456789" \ + --filter-expression "service(\"mydomain.com\") {fault}" + +Output:: + + { + "GroupName": "AdminGroup", + "GroupARN": "arn:aws:xray:us-east-2:123456789012:group/AdminGroup/123456789", + "FilterExpression": "service(\"mydomain.com\") {fault}" + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/examples/xray/update-sampling-rule.rst b/aws/dist/awscli/examples/xray/update-sampling-rule.rst new file mode 100644 index 00000000..65fb4249 --- /dev/null +++ b/aws/dist/awscli/examples/xray/update-sampling-rule.rst @@ -0,0 +1,44 @@ +**To update a sampling rule** + +The following ``update-sampling-rule`` example modifies a sampling rule's configuration. The rules are consumed from a JSON file. Only the fields being updated are required. :: + + aws xray update-sampling-rule \ + --cli-input-json file://1000-default.json + +Contents of ``1000-default.json``:: + + { + "SamplingRuleUpdate": { + "RuleName": "Default", + "FixedRate": 0.01, + "ReservoirSize": 0 + } + } + +Output:: + + { + "SamplingRuleRecords": [ + { + "SamplingRule": { + "RuleName": "Default", + "RuleARN": "arn:aws:xray:us-west-2:123456789012:sampling-rule/Default", + "ResourceARN": "*", + "Priority": 10000, + "FixedRate": 0.01, + "ReservoirSize": 0, + "ServiceName": "*", + "ServiceType": "*", + "Host": "*", + "HTTPMethod": "*", + "URLPath": "*", + "Version": 1, + "Attributes": {} + }, + "CreatedAt": 0.0, + "ModifiedAt": 1529959993.0 + } + ] + } + +For more information, see `Configuring Sampling, Groups, and Encryption Settings with the AWS X-Ray API `__ in the *AWS X-Ray Developer Guide*. diff --git a/aws/dist/awscli/topics/config-vars.rst b/aws/dist/awscli/topics/config-vars.rst new file mode 100644 index 00000000..8a98ef31 --- /dev/null +++ b/aws/dist/awscli/topics/config-vars.rst @@ -0,0 +1,486 @@ +:title: AWS CLI Configuration Variables +:description: Configuration Variables for the AWS CLI +:category: General +:related command: configure, configure get, configure set +:related topic: s3-config + +Configuration values for the AWS CLI can come from several sources: + +* As a command line option +* As an environment variable +* As a value in the AWS CLI config file +* As a value in the AWS Shared Credential file + +Some options are only available in the AWS CLI config. This topic guide covers +all the configuration variables available in the AWS CLI. + +Note that if you are just looking to get the minimum required configuration to +run the AWS CLI, we recommend running ``aws configure``, which will prompt you +for the necessary configuration values. + +Config File Format +================== + +The AWS CLI config file, which defaults to ``~/.aws/config`` has the following +format:: + + [default] + aws_access_key_id=foo + aws_secret_access_key=bar + region=us-west-2 + +The ``default`` section refers to the configuration values for the default +profile. You can create profiles, which represent logical groups of +configuration. Profiles that aren't the default profile are specified by +creating a section titled "profile profilename":: + + [profile testing] + aws_access_key_id=foo + aws_secret_access_key=bar + region=us-west-2 + +Nested Values +------------- + +Some service specific configuration, discussed in more detail below, has a +single top level key, with nested sub values. These sub values are denoted by +indentation:: + + [profile testing] + aws_access_key_id = foo + aws_secret_access_key = bar + region = us-west-2 + s3 = + max_concurrent_requests=10 + max_queue_size=1000 + + +General Options +=============== + +The AWS CLI has a few general options: + +==================== =========== ===================== ===================== ============================ +Variable Option Config Entry Environment Variable Description +==================== =========== ===================== ===================== ============================ +profile --profile N/A AWS_PROFILE Default profile name +-------------------- ----------- --------------------- --------------------- ---------------------------- +region --region region AWS_DEFAULT_REGION Default AWS Region +-------------------- ----------- --------------------- --------------------- ---------------------------- +output --output output AWS_DEFAULT_OUTPUT Default output style +-------------------- ----------- --------------------- --------------------- ---------------------------- +cli_timestamp_format N/A cli_timestamp_format N/A Output format of timestamps +-------------------- ----------- --------------------- --------------------- ---------------------------- +cli_follow_urlparam N/A cli_follow_urlparam N/A Fetch URL url parameters +-------------------- ----------- --------------------- --------------------- ---------------------------- +ca_bundle --ca-bundle ca_bundle AWS_CA_BUNDLE CA Certificate Bundle +-------------------- ----------- --------------------- --------------------- ---------------------------- +parameter_validation N/A parameter_validation N/A Toggles parameter validation +-------------------- ----------- --------------------- --------------------- ---------------------------- +tcp_keepalive N/A tcp_keepalive N/A Toggles TCP Keep-Alive +==================== =========== ===================== ===================== ============================ + +The third column, Config Entry, is the value you would specify in the AWS CLI +config file. By default, this location is ``~/.aws/config``. If you need to +change this value, you can set the ``AWS_CONFIG_FILE`` environment variable +to change this location. + +The valid values of the ``output`` configuration variable are: + +* json +* table +* text + +``cli_timestamp_format`` controls the format of timestamps displayed by the AWS CLI. +The valid values of the ``cli_timestamp_format`` configuration variable are: + +* wire - Display the timestamp exactly as received from the HTTP response. +* iso8601 - Reformat timestamp using iso8601 in the UTC timezone. + +The default value is ``iso8601``. + +``cli_follow_urlparam`` controls whether or not the CLI will attempt to follow +URL links in parameters that start with either prefix ``https://`` or +``http://``. The valid values of the ``cli_follow_urlparam`` configuration +variable are: + +* true - This is the default value. With this configured the CLI will follow + any string parameters that start with ``https://`` or ``http://`` will be + fetched, and the downloaded content will be used as the parameter instead. +* false - The CLI will not treat strings prefixed with ``https://`` or + ``http://`` any differently than normal string parameters. + +``parameter_validation`` controls whether parameter validation should occur +when serializing requests. The default is True. You can disable parameter +validation for performance reasons. Otherwise, it's recommended to leave +parameter validation enabled. + +When you specify a profile, either using ``--profile profile-name`` or by +setting a value for the ``AWS_PROFILE`` environment variable, profile +name you provide is used to find the corresponding section in the AWS CLI +config file. For example, specifying ``--profile development`` will instruct +the AWS CLI to look for a section in the AWS CLI config file of +``[profile development]``. + +Precedence +---------- + +The above configuration values have the following precedence: + +* Command line options +* Environment variables +* Configuration file + + +Credentials +=========== + +Credentials can be specified in several ways: + +* Environment variables +* The AWS Shared Credential File +* The AWS CLI config file + +============================= ============================= ================================= ============================== +Variable Creds/Config Entry Environment Variable Description +============================= ============================= ================================= ============================== +access_key aws_access_key_id AWS_ACCESS_KEY_ID AWS Access Key +----------------------------- ----------------------------- --------------------------------- ------------------------------ +secret_key aws_secret_access_key AWS_SECRET_ACCESS_KEY AWS Secret Key +----------------------------- ----------------------------- --------------------------------- ------------------------------ +token aws_session_token AWS_SESSION_TOKEN AWS Token (temp credentials) +----------------------------- ----------------------------- --------------------------------- ------------------------------ +metadata_service_timeout metadata_service_timeout AWS_METADATA_SERVICE_TIMEOUT EC2 metadata creds timeout +----------------------------- ----------------------------- --------------------------------- ------------------------------ +metadata_service_num_attempts metadata_service_num_attempts AWS_METADATA_SERVICE_NUM_ATTEMPTS EC2 metadata creds retry count +============================= ============================= ================================= ============================== + +The second column specifies the name that you can specify in either the AWS CLI +config file or the AWS Shared credentials file (``~/.aws/credentials``). + + +The Shared Credentials File +--------------------------- + +The shared credentials file has a default location of +``~/.aws/credentials``. You can change the location of the shared +credentials file by setting the ``AWS_SHARED_CREDENTIALS_FILE`` +environment variable. + +This file is an INI formatted file with section names +corresponding to profiles. With each section, the three configuration +variables shown above can be specified: ``aws_access_key_id``, +``aws_secret_access_key``, ``aws_session_token``. **These are the only +supported values in the shared credential file.** Also note that the +section names are different than the AWS CLI config file (``~/.aws/config``). +In the AWS CLI config file, you create a new profile by creating a section of +``[profile profile-name]``, for example:: + + [profile development] + aws_access_key_id=foo + aws_secret_access_key=bar + +In the shared credentials file, profiles are not prefixed with ``profile``, +for example:: + + [development] + aws_access_key_id=foo + aws_secret_access_key=bar + + +Precedence +---------- + +Credentials from environment variables have precedence over credentials from +the shared credentials and AWS CLI config file. Credentials specified in the +shared credentials file have precedence over credentials in the AWS CLI config +file. If ``AWS_PROFILE`` environment variable is set and the +``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY`` environment variables are +set, then the credentials provided by ``AWS_ACCESS_KEY_ID`` and +``AWS_SECRET_ACCESS_KEY`` will override the credentials located in the +profile provided by ``AWS_PROFILE``. + + +Using AWS IAM Roles +------------------- + +If you are on an Amazon EC2 instance that was launched with an IAM role, the +AWS CLI will automatically retrieve credentials for you. You do not need +to configure any credentials. + +Additionally, you can specify a role for the AWS CLI to assume, and the AWS +CLI will automatically make the corresponding ``AssumeRole`` calls for you. +Note that configuration variables for using IAM roles can only be in the AWS +CLI config file. + +You can specify the following configuration values for configuring an IAM role +in the AWS CLI config file: + +* ``role_arn`` - The ARN of the role you want to assume. +* ``source_profile`` - The AWS CLI profile that contains credentials / + configuration the CLI should use for the initial ``assume-role`` call. This + profile may be another profile configured to use ``assume-role``, though + if static credentials are present in the profile they will take precedence. + This parameter cannot be provided alongside ``credential_source``. +* ``credential_source`` - The credential provider to use to get credentials for + the initial ``assume-role`` call. This parameter cannot be provided + alongside ``source_profile``. Valid values are: + + * ``Environment`` to pull source credentials from environment variables. + * ``Ec2InstanceMetadata`` to use the EC2 instance role as source credentials. + * ``EcsContainer`` to use the ECS container credentials as the source + credentials. + +* ``external_id`` - A unique identifier that is used by third parties to assume + a role in their customers' accounts. This maps to the ``ExternalId`` + parameter in the ``AssumeRole`` operation. This is an optional parameter. +* ``mfa_serial`` - The identification number of the MFA device to use when + assuming a role. This is an optional parameter. Specify this value if the + trust policy of the role being assumed includes a condition that requires MFA + authentication. The value is either the serial number for a hardware device + (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device + (such as arn:aws:iam::123456789012:mfa/user). +* ``role_session_name`` - The name applied to this assume-role session. This + value affects the assumed role user ARN (such as + arn:aws:sts::123456789012:assumed-role/role_name/role_session_name). This + maps to the ``RoleSessionName`` parameter in the ``AssumeRole`` operation. + This is an optional parameter. If you do not provide this value, a + session name will be automatically generated. +* ``duration_seconds`` - The duration, in seconds, of the role session. + The value can range from 900 seconds (15 minutes) up to the maximum + session duration setting for the role. This is an optional parameter + and by default, the value is set to 3600 seconds. + +If you do not have MFA authentication required, then you only need to specify a +``role_arn`` and either a ``source_profile`` or a ``credential_source``. + +When you specify a profile that has IAM role configuration, the AWS CLI +will make an ``AssumeRole`` call to retrieve temporary credentials. These +credentials are then stored (in ``~/.aws/cli/cache``). Subsequent AWS CLI +commands will use the cached temporary credentials until they expire, in which +case the AWS CLI will automatically refresh credentials. + +If you specify an ``mfa_serial``, then the first time an ``AssumeRole`` call is +made, you will be prompted to enter the MFA code. Subsequent commands will use +the cached temporary credentials. However, when the temporary credentials +expire, you will be re-prompted for another MFA code. + + +Example configuration using ``source_profile``:: + + # In ~/.aws/credentials: + [development] + aws_access_key_id=foo + aws_secret_access_key=bar + + # In ~/.aws/config + [profile crossaccount] + role_arn=arn:aws:iam:... + source_profile=development + +Example configuration using ``credential_source`` to use the instance role as +the source credentials for the assume role call:: + + # In ~/.aws/config + [profile crossaccount] + role_arn=arn:aws:iam:... + credential_source=Ec2InstanceMetadata + +Assume Role With Web Identity +-------------------------------------- + +Within the ``~/.aws/config`` file, you can also configure a profile to indicate +that the AWS CLI should assume a role. When you do this, the AWS CLI will +automatically make the corresponding ``AssumeRoleWithWebIdentity`` calls to AWS +STS on your behalf. + +When you specify a profile that has IAM role configuration, the AWS CLI will +make an ``AssumeRoleWithWebIdentity`` call to retrieve temporary credentials. +These credentials are then stored (in ``~/.aws/cli/cache``). Subsequent AWS +CLI commands will use the cached temporary credentials until they expire, in +which case the AWS CLI will automatically refresh credentials. + +You can specify the following configuration values for configuring an +assume role with web identity profile in the shared config: + + +* ``role_arn`` - The ARN of the role you want to assume. +* ``web_identity_token_file`` - The path to a file which contains an OAuth 2.0 + access token or OpenID Connect ID token that is provided by the identity + provider. The contents of this file will be loaded and passed as the + ``WebIdentityToken`` argument to the ``AssumeRoleWithWebIdentity`` operation. +* ``role_session_name`` - The name applied to this assume-role session. This + value affects the assumed role user ARN (such as + arn:aws:sts::123456789012:assumed-role/role_name/role_session_name). This + maps to the ``RoleSessionName`` parameter in the + ``AssumeRoleWithWebIdentity`` operation. This is an optional parameter. If + you do not provide this value, a session name will be automatically + generated. + +Below is an example configuration for the minimal amount of configuration +needed to configure an assume role with web identity profile:: + + # In ~/.aws/config + [profile web-identity] + role_arn=arn:aws:iam:... + web_identity_token_file=/path/to/a/token + +This provider can also be configured via the environment: + +``AWS_ROLE_ARN`` + The ARN of the role you want to assume. + +``AWS_WEB_IDENTITY_TOKEN_FILE`` + The path to the web identity token file. + +``AWS_ROLE_SESSION_NAME`` + The name applied to this assume-role session. + +.. note:: + + These environment variables currently only apply to the assume role with + web identity provider and do not apply to the general assume role provider + configuration. + + +Sourcing Credentials From External Processes +-------------------------------------------- + +.. warning:: + + The following describes a method of sourcing credentials from an external + process. This can potentially be dangerous, so proceed with caution. Other + credential providers should be preferred if at all possible. If using + this option, you should make sure that the config file is as locked down + as possible using security best practices for your operating system. + Ensure that your custom credential tool does not write any secret + information to StdErr because the SDKs and CLI can capture and log such + information, potentially exposing it to unauthorized users. + +If you have a method of sourcing credentials that isn't built in to the AWS +CLI, you can integrate it by using ``credential_process`` in the config file. +The AWS CLI will call that command exactly as given and then read json data +from stdout. The process must write credentials to stdout in the following +format:: + + { + "Version": 1, + "AccessKeyId": "", + "SecretAccessKey": "", + "SessionToken": "", + "Expiration": "" + } + +The ``Version`` key must be set to ``1``. This value may be bumped over time +as the payload structure evolves. + +The ``Expiration`` key is an ISO8601 formatted timestamp. If the ``Expiration`` +key is not returned in stdout, the credentials are long term credentials that +do not refresh. Otherwise the credentials are considered refreshable +credentials and will be refreshed automatically. NOTE: Unlike with assume role +credentials, the AWS CLI will NOT cache process credentials. If caching is +needed, it must be implemented in the external process. + +The process can return a non-zero RC to indicate that an error occurred while +retrieving credentials. + +Some process providers may need additional information in order to retrieve the +appropriate credentials. This can be done via command line arguments. NOTE: +command line options may be visible to process running on the same machine. + +Example configuration:: + + [profile dev] + credential_process = /opt/bin/awscreds-custom + +Example configuration with parameters:: + + [profile dev] + credential_process = /opt/bin/awscreds-custom --username monty + + +Service Specific Configuration +============================== + +API Versions +------------ + +The API version to use for a service can be set using the ``api_versions`` +key. To specify an API version, set the API version to the name of the service +as a sub value for ``api_versions``. + +Example configuration:: + + [profile development] + aws_access_key_id=foo + aws_secret_access_key=bar + api_versions = + ec2 = 2015-03-01 + cloudfront = 2015-09-17 + +By setting an API version for a service, it ensures that the interface for +that service's commands is representative of the specified API version. + +In the example configuration, the ``ec2`` CLI commands will be representative +of Amazon EC2's ``2015-03-01`` API version and the ``cloudfront`` CLI commands +will be representative of Amazon CloudFront's ``2015-09-17`` API version. + + +AWS STS +------- + +To set STS endpoint resolution logic, use the ``AWS_STS_REGIONAL_ENDPOINTS`` +environment variable or ``sts_regional_endpoints`` configuration file option. +By default, this configuration option is set to ``legacy``. Valid values are: + +* ``regional`` + Uses the STS endpoint that corresponds to the configured region. For + example if the client is configured to use ``us-west-2``, all calls + to STS will be make to the ``sts.us-west-2.amazonaws.com`` regional + endpoint instead of the global ``sts.amazonaws.com`` endpoint. + +* ``legacy`` + Uses the global STS endpoint, ``sts.amazonaws.com``, for the following + configured regions: + + * ``ap-northeast-1`` + * ``ap-south-1`` + * ``ap-southeast-1`` + * ``ap-southeast-2`` + * ``aws-global`` + * ``ca-central-1`` + * ``eu-central-1`` + * ``eu-north-1`` + * ``eu-west-1`` + * ``eu-west-2`` + * ``eu-west-3`` + * ``sa-east-1`` + * ``us-east-1`` + * ``us-east-2`` + * ``us-west-1`` + * ``us-west-2`` + + All other regions will use their respective regional endpoint. + + +Amazon S3 +--------- + +There are a number of configuration variables specific to the S3 commands. See +:doc:`s3-config` (``aws help topics s3-config``) for more details. + + +OS Specific Configuration +========================= + +Locale +------ + +If you have data stored in AWS that uses a particular encoding, you should make +sure that your systems are configured to accept that encoding. For instance, if +you have unicode characters as part of a key on EC2 you will need to make sure +that your locale is set to a unicode-compatible locale. How you configure your +locale will depend on your operating system and your specific IT requirements. +One option for UNIX systems is the ``LC_ALL`` environment variable. Setting +``LC_ALL=en_US.UTF-8``, for instance, would give you a United States English +locale which is compatible with unicode. diff --git a/aws/dist/awscli/topics/ddb-expressions.rst b/aws/dist/awscli/topics/ddb-expressions.rst new file mode 100644 index 00000000..c47a85dc --- /dev/null +++ b/aws/dist/awscli/topics/ddb-expressions.rst @@ -0,0 +1,125 @@ +:title: AWS DDB Expressions +:description: Details on the expression syntax for the ddb commands +:category: ddb +:related command: ddb select, ddb put + +The ``ddb`` commands provide a simplified expression-writing experince by +adding some additional syntax which allows for specifying attribute names and +attribute values without having to define placeholders. + +For example, one might write the following command using the base ``dynamodb`` +commands:: + + aws dynamodb scan \ + --table-name ProductCatalog \ + --condition-expression "Price between :lo and :hi" \ + --expression-attribute-values file://values.json + +With the contents of ``values.json`` being:: + + { + ":lo": {"N": "500"}, + ":hi": {"N": "600"} + } + +With ``ddb select`` you would write:: + + aws ddb select ProductCatalog --condition 'Price between 500 and 600' + +Then the CLI would handle extracting the the numbers to make the final request. +The CLI can handle extracting any values in this way. + +Attribute Name Syntax +--------------------- + +Attribute names may be specified as unquoted strings, or as strings quoted +using single quotes. Using single quotes will be necessary if an attribute name +starts with a digit or contains any characters outsize of ascii letters and +digits. For example, the following would be valid attribute names: ``foo``, +``'foo bar'``, ``'foo.bar'`` etc. + +Attribute Paths +=============== + +When specifying an attribute path, each attribute name in the path may be +individually quoted. For example: ``foo.'bar baz'[0]``. + +Reserved Words +============== + +The following words are reserved in the CLI, and so they MUST be quoted if you +intend to use them as an attribute name. Each word is case-insensitive. + +* ``AND`` +* ``BETWEEN`` +* ``IN`` +* ``OR`` +* ``NOT`` +* ``SET`` +* ``REMOVE`` +* ``ADD`` +* ``DELETE`` +* ``TRUE`` +* ``FALSE`` +* ``NULL`` + +Attribute Value Syntax +---------------------- + +Numbers +======= + +Numbers may be specified as you would specify them in JSON. For example, each +of the following would be valid numbers: ``1``, ``1.1``, ``1.1e3``, +``-1.1e-3``, etc. + +Strings +======= + +Strings may be specified as you would specify them in JSON. This means that +they must be enclosed by double quotes, and any internal double quote +characters must be escaped with a backslash. For example, each of the following +would be a valid string: ``"foo"``, ``"\"hello\" world"``, etc. Note that you +may need to escape the backslash itself depending on your shell. + +Bytes +===== + +Binary values are base64-encoded values prefixed by ``b"`` and suffixed by +``"``. For example, the follwoing would be a valid binary value: ``b"4pyT"``. + +Booleans +======== + +Boolean values may be specified as ``true`` or ``false``. + +Null +==== + +Null values are specified simply as ``null`` + +Lists +===== + +Lists may be specified as you would specify them in JSON, with the exception +that binary values and set values are valid elements. This means that the list +must start with ``[`` and end with ``]``. Each element in the list must be +separated by a comma. For example: ``["foo", b"4pyT", 8]``. + +Sets +==== + +Sets must begin with ``{`` and end with ``}``. Each item in the set must be +separated by a comma. Sets may only contain numbers, strings, and bytes. All +values in the set must be of the same type. Sets must contain at least one +value. For example, each of the following is a valid set: ``{1, 2, 3}``, +``{"foo", "bar"}``, ``{b"4pyT"}``. + +Maps +==== + +Maps may be specified as you would specify them in JSON, with the exception +that bytes and sets are valid values. This means that the map must start with +``{`` and end with ``}``. It may contain any number of key-value pairs where +the key and value are separated by a colon (``:``). Keys must be strings, but +values may be any type. For example: ``{"foo": {"bar": {b"4pyT"}}}``. diff --git a/aws/dist/awscli/topics/return-codes.rst b/aws/dist/awscli/topics/return-codes.rst new file mode 100644 index 00000000..e17e7ef4 --- /dev/null +++ b/aws/dist/awscli/topics/return-codes.rst @@ -0,0 +1,63 @@ +:title: AWS CLI Return Codes +:description: Describes the various return codes of the AWS CLI +:category: General +:related command: s3, s3 cp, s3 sync, s3 mv, s3 rm + +These are the following return codes returned at the end of execution +of a CLI command: + +* ``0`` -- Command was successful. There were no errors thrown by either + the CLI or by the service the request was made to. + +* ``1`` -- Limited to ``s3`` commands, at least one or more s3 transfers + failed for the command executed. + +* ``2`` -- The meaning of this return code depends on the command being run. + + The primary meaning is that the command entered on the command + line failed to be parsed. Parsing failures can be caused by, + but are not limited to, missing any required subcommands or arguments + or using any unknown commands or arguments. + Note that this return code meaning is applicable to all CLI commands. + + The other meaning is only applicable to ``s3`` commands. + It can mean at least one or more files marked + for transfer were skipped during the transfer process. However, all + other files marked for transfer were successfully transferred. + Files that are skipped during the transfer process include: + files that do not exist, files that are character special devices, + block special device, FIFO's, or sockets, and files that the user cannot + read from. + +* ``130`` -- The process received a SIGINT (Ctrl-C). + +* ``255`` -- Command failed. There were errors thrown by either the CLI or + by the service the request was made to. + + +To determine the return code of a command, run the following right after +running a CLI command. Note that this will work only on POSIX systems:: + + $ echo $? + + +Output (if successful):: + + 0 + +On Windows PowerShell, the return code can be determined by running:: + + > echo $lastexitcode + +Output (if successful):: + + 0 + + +On Windows Command Prompt, the return code can be determined by running:: + + > echo %errorlevel% + +Output (if successful):: + + 0 diff --git a/aws/dist/awscli/topics/s3-config.rst b/aws/dist/awscli/topics/s3-config.rst new file mode 100644 index 00000000..1dd66185 --- /dev/null +++ b/aws/dist/awscli/topics/s3-config.rst @@ -0,0 +1,255 @@ +:title: AWS CLI S3 Configuration +:description: Advanced configuration for AWS S3 Commands +:category: S3 +:related command: s3 cp, s3 sync, s3 mv, s3 rm + +The ``aws s3`` transfer commands, which include the ``cp``, ``sync``, ``mv``, +and ``rm`` commands, have additional configuration values you can use to +control S3 transfers. This topic guide discusses these parameters as well as +best practices and guidelines for setting these values. + +Before discussing the specifics of these values, note that these values are +entirely optional. You should be able to use the ``aws s3`` transfer commands +without having to configure any of these values. These configuration values +are provided in the case where you need to modify one of these values, either +for performance reasons or to account for the specific environment where these +``aws s3`` commands are being run. + + +Configuration Values +==================== + +These are the configuration values you can set specifically for the ``aws s3`` +command set: + +* ``max_concurrent_requests`` - The maximum number of concurrent requests. +* ``max_queue_size`` - The maximum number of tasks in the task queue. +* ``multipart_threshold`` - The size threshold the CLI uses for multipart + transfers of individual files. +* ``multipart_chunksize`` - When using multipart transfers, this is the chunk + size that the CLI uses for multipart transfers of individual files. +* ``max_bandwidth`` - The maximum bandwidth that will be consumed for uploading + and downloading data to and from Amazon S3. + + +These are the configuration values that can be set for both ``aws s3`` +and ``aws s3api``: + +* ``use_accelerate_endpoint`` - Use the Amazon S3 Accelerate endpoint for + all ``s3`` and ``s3api`` commands. You **must** first enable S3 Accelerate + on your bucket before attempting to use the endpoint. This is mutually + exclusive with the ``use_dualstack_endpoint`` option. +* ``use_dualstack_endpoint`` - Use the Amazon S3 dual IPv4 / IPv6 endpoint for + all ``s3 `` and ``s3api`` commands. This is mutually exclusive with the + ``use_accelerate_endpoint`` option. +* ``addressing_style`` - Specifies which addressing style to use. This controls + if the bucket name is in the hostname or part of the URL. Value values are: + ``path``, ``virtual``, and ``auto``. The default value is ``auto``. +* ``payload_signing_enabled`` - Refers to whether or not to SHA256 sign sigv4 + payloads. By default, this is disabled for streaming uploads (UploadPart + and PutObject) when using https. + + +These values must be set under the top level ``s3`` key in the AWS Config File, +which has a default location of ``~/.aws/config``. Below is an example +configuration:: + + [profile development] + aws_access_key_id=foo + aws_secret_access_key=bar + s3 = + max_concurrent_requests = 20 + max_queue_size = 10000 + multipart_threshold = 64MB + multipart_chunksize = 16MB + max_bandwidth = 50MB/s + use_accelerate_endpoint = true + addressing_style = path + + +Note that all the S3 configuration values are indented and nested under the top +level ``s3`` key. + +You can also set these values programmatically using the ``aws configure set`` +command. For example, to set the above values for the default profile, you +could instead run these commands:: + + $ aws configure set default.s3.max_concurrent_requests 20 + $ aws configure set default.s3.max_queue_size 10000 + $ aws configure set default.s3.multipart_threshold 64MB + $ aws configure set default.s3.multipart_chunksize 16MB + $ aws configure set default.s3.max_bandwidth 50MB/s + $ aws configure set default.s3.use_accelerate_endpoint true + $ aws configure set default.s3.addressing_style path + + +max_concurrent_requests +----------------------- + +**Default** - ``10`` + +The ``aws s3`` transfer commands are multithreaded. At any given time, +multiple requests to Amazon S3 are in flight. For example, if you are +uploading a directory via ``aws s3 cp localdir s3://bucket/ --recursive``, the +AWS CLI could be uploading the local files ``localdir/file1``, +``localdir/file2``, and ``localdir/file3`` in parallel. The +``max_concurrent_requests`` specifies the maximum number of transfer commands +that are allowed at any given time. + +You may need to change this value for a few reasons: + +* Decreasing this value - On some environments, the default of 10 concurrent + requests can overwhelm a system. This may cause connection timeouts or + slow the responsiveness of the system. Lowering this value will make the + S3 transfer commands less resource intensive. The tradeoff is that + S3 transfers may take longer to complete. Lowering this value may be + necessary if using a tool such as ``trickle`` to limit bandwidth. +* Increasing this value - In some scenarios, you may want the S3 transfers + to complete as quickly as possible, using as much network bandwidth + as necessary. In this scenario, the default number of concurrent requests + may not be sufficient to utilize all the network bandwidth available. + Increasing this value may improve the time it takes to complete an + S3 transfer. + + +max_queue_size +-------------- + +**Default** - ``1000`` + +The AWS CLI internally uses a producer consumer model, where we queue up S3 +tasks that are then executed by consumers, which in this case utilize a bound +thread pool, controlled by ``max_concurrent_requests``. A task generally maps +to a single S3 operation. For example, as task could be a ``PutObjectTask``, +or a ``GetObjectTask``, or an ``UploadPartTask``. The enqueuing rate can be +much faster than the rate at which consumers are executing tasks. To avoid +unbounded growth, the task queue size is capped to a specific size. This +configuration value changes the value of that maximum number. + +You generally will not need to change this value. This value also corresponds +to the number of tasks we are aware of that need to be executed. This means +that by default we can only see 1000 tasks ahead. Until the S3 command knows +the total number of tasks executed, the progress line will show a total of +``...``. Increasing this value means that we will be able to more quickly know +the total number of tasks needed, assuming that the enqueuing rate is quicker +than the rate of task consumption. The tradeoff is that a larger max queue +size will require more memory. + + +multipart_threshold +------------------- + +**Default** - ``8MB`` + +When uploading, downloading, or copying a file, the S3 commands +will switch to multipart operations if the file reaches a given +size threshold. The ``multipart_threshold`` controls this value. +You can specify this value in one of two ways: + +* The file size in bytes. For example, ``1048576``. +* The file size with a size suffix. You can use ``KB``, ``MB``, ``GB``, + ``TB``. For example: ``10MB``, ``1GB``. Note that S3 imposes + constraints on valid values that can be used for multipart + operations. + + +multipart_chunksize +------------------- + +**Default** - ``8MB`` + +**Minimum For Uploads** - ``5MB`` + +Once the S3 commands have decided to use multipart operations, the +file is divided into chunks. This configuration option specifies what +the chunk size (also referred to as the part size) should be. This +value can specified using the same semantics as ``multipart_threshold``, +that is either as the number of bytes as an integer, or using a size +suffix. + + +max_bandwidth +------------- + +**Default** - None + +This controls the maximum bandwidth that the S3 commands will +utilize when streaming content data to and from S3. Thus, this value only +applies for uploads and downloads. It does not apply to copies nor deletes +because those data transfers take place server side. The value is +in terms of **bytes** per second. The value can be specified as: + +* An integer. For example, ``1048576`` would set the maximum bandwidth usage + to 1 MB per second. +* A rate suffix. You can specify rate suffixes using: ``KB/s``, ``MB/s``, + ``GB/s``, etc. For example: ``300KB/s``, ``10MB/s``. + +In general, it is recommended to first use ``max_concurrent_requests`` to lower +transfers to the desired bandwidth consumption. The ``max_bandwidth`` setting +should then be used to further limit bandwidth consumption if setting +``max_concurrent_requests`` is unable to lower bandwidth consumption to the +desired rate. This is recommended because ``max_concurrent_requests`` controls +how many threads are currently running. So if a high ``max_concurrent_requests`` +value is set and a low ``max_bandwidth`` value is set, it may result in +threads having to wait unnecessarily which can lead to excess resource +consumption and connection timeouts. + + +use_accelerate_endpoint +----------------------- + +**Default** - ``false`` + +If set to ``true``, will direct all Amazon S3 requests to the S3 Accelerate +endpoint: ``s3-accelerate.amazonaws.com``. To use this endpoint, your bucket +must be enabled to use S3 Accelerate. All request will be sent using the +virtual style of bucket addressing: ``my-bucket.s3-accelerate.amazonaws.com``. +Any ``ListBuckets``, ``CreateBucket``, and ``DeleteBucket`` requests will not +be sent to the Accelerate endpoint as the endpoint does not support those +operations. This behavior can also be set if ``--endpoint-url`` parameter +is set to ``https://s3-accelerate.amazonaws.com`` or +``http://s3-accelerate.amazonaws.com`` for any ``s3`` or ``s3api`` command. This +option is mutually exclusive with the ``use_dualstack_endpoint`` option. + + +use_dualstack_endpoint +---------------------- + +**Default** - ``false`` + +If set to ``true``, will direct all Amazon S3 requests to the dual IPv4 / IPv6 +endpoint for the configured region. This option is mutually exclusive with +the ``use_accelerate_endpoint`` option. + + +addressing_style +---------------- + +**Default** - ``auto`` + +There's two styles of constructing an S3 endpoint. The first is with +the bucket included as part of the hostname. This corresponds to the +addressing style of ``virtual``. The second is with the bucket included +as part of the path of the URI, corresponding to the addressing style +of ``path``. The default value in the CLI is to use ``auto``, which +will attempt to use ``virtual`` where possible, but will fall back to +``path`` style if necessary. For example, if your bucket name is not +DNS compatible, the bucket name cannot be part of the hostname and +must be in the path. With ``auto``, the CLI will detect this condition +and automatically switch to ``path`` style for you. If you set the +addressing style to ``path``, you must ensure that the AWS region you +configured in the AWS CLI matches the same region of your bucket. + + +payload_signing_enabled +----------------------- + +If set to ``true``, s3 payloads will receive additional content validation in +the form of a SHA256 checksum which will be calculated for you and included in +the request signature. If set to ``false``, the checksum will not be calculated. +Disabling this can be useful to save the performance overhead that the +checksum calculation would otherwise cause. + +By default, this is disabled for streaming uploads (UploadPart and PutObject), +but only if a ContentMD5 is present (it is generated by default) and the +endpoint uses HTTPS. diff --git a/aws/dist/awscli/topics/s3-faq.rst b/aws/dist/awscli/topics/s3-faq.rst new file mode 100644 index 00000000..fcf5826f --- /dev/null +++ b/aws/dist/awscli/topics/s3-faq.rst @@ -0,0 +1,63 @@ +:title: AWS CLI S3 FAQ +:description: Frequented Asked Questions for Amazon S3 in the AWS CLI +:category: S3 +:related command: s3 cp, s3 sync, s3 mv, s3 rm + + +S3 FAQ +====== + +Below are common questions regarding the use of Amazon S3 in the AWS CLI. + + +Q: Does the AWS CLI validate checksums? +--------------------------------------- + +The AWS CLI will perform checksum validation for uploading and downloading +files in specific scenarios. + +Upload +~~~~~~ + +The AWS CLI will calculate and auto-populate the ``Content-MD5`` header for +both standard and multipart uploads. If the checksum that S3 calculates does +not match the ``Content-MD5`` provided, S3 will not store the object and +instead will return an error message back the AWS CLI. The AWS CLI will retry +this error up to 5 times before giving up. On the case that any files fail to +transfer successfully to S3, the AWS CLI will exit with a non zero RC. +See ``aws help return-codes`` for more information. + +If the upload request is signed with Signature Version 4, then a +``Content-MD5`` is not calculated. Instead, the AWS CLI uses the +``x-amz-content-sha256`` header as a checksum instead of ``Content-MD5``. +The AWS CLI will use Signature Version 4 for S3 in several cases: + +* You're using an AWS region that only supports Signature Version 4. This + includes ``eu-central-1`` and ``ap-northeast-2``. +* You explicitly opt in and set ``signature_version = s3v4`` in your + ``~/.aws/config`` file. + +Note that the AWS CLI will add a ``Content-MD5`` header for both +the high level ``aws s3`` commands that perform uploads +(``aws s3 cp``, ``aws s3 sync``) as well as the low level ``s3api`` +commands including ``aws s3api put-object`` and ``aws s3api upload-part``. + + +Download +~~~~~~~~ + +The AWS CLI will attempt to verify the checksum of downloads when possible, +based on the ``ETag`` header returned from a ``GetObject`` request that's +performed whenever the AWS CLI downloads objects from S3. If the calculated +MD5 checksum does not match the expected checksum, the file is deleted +and the download is retried. This process is retried up to 3 times. +If a downloads fails, the AWS CLI will exit with a non zero RC. +See ``aws help return-codes`` for more information. + +There are several conditions where the CLI is *not* able to verify +checksums on downloads: + +* If the object was uploaded via multipart uploads +* If the object was uploaded using server side encryption with KMS +* If the object was uploaded using a customer provided encryption key +* If the object is downloaded using range ``GetObject`` requests diff --git a/aws/dist/awscli/topics/topic-tags.json b/aws/dist/awscli/topics/topic-tags.json new file mode 100644 index 00000000..590449f4 --- /dev/null +++ b/aws/dist/awscli/topics/topic-tags.json @@ -0,0 +1,84 @@ +{ + "config-vars": { + "category": [ + "General" + ], + "description": [ + "Configuration Variables for the AWS CLI" + ], + "related command": [ + "configure", + "configure get", + "configure set" + ], + "related topic": [ + "s3-config" + ], + "title": [ + "AWS CLI Configuration Variables" + ] + }, + "return-codes": { + "category": [ + "General" + ], + "description": [ + "Describes the various return codes of the AWS CLI" + ], + "related command": [ + "s3", + "s3 cp", + "s3 sync", + "s3 mv", + "s3 rm" + ], + "title": [ + "AWS CLI Return Codes" + ] + }, + "s3-config": { + "category": [ + "S3" + ], + "description": [ + "Advanced configuration for AWS S3 Commands" + ], + "related command": [ + "s3 cp", + "s3 sync", + "s3 mv", + "s3 rm" + ], + "title": [ + "AWS CLI S3 Configuration" + ] + }, + "s3-faq": { + "category": [ + "S3" + ], + "description": [ + "Frequented Asked Questions for Amazon S3 in the AWS CLI" + ], + "related command": [ + "s3 cp", + "s3 sync", + "s3 mv", + "s3 rm" + ], + "title": [ + "AWS CLI S3 FAQ" + ] + }, + "ddb-expressions": { + "category": ["ddb"], + "description": [ + "Details on the expression syntax for the ddb commands" + ], + "related command": [ + "ddb select", + "ddb put" + ], + "title": ["AWS DDB Expressions"] + } +} diff --git a/aws/dist/binascii.cpython-37m-darwin.so b/aws/dist/binascii.cpython-37m-darwin.so new file mode 100755 index 00000000..2296dba5 Binary files /dev/null and b/aws/dist/binascii.cpython-37m-darwin.so differ diff --git a/aws/dist/botocore/cacert.pem b/aws/dist/botocore/cacert.pem new file mode 100644 index 00000000..101ac98f --- /dev/null +++ b/aws/dist/botocore/cacert.pem @@ -0,0 +1,4433 @@ + +# Issuer: CN=GlobalSign Root CA O=GlobalSign nv-sa OU=Root CA +# Subject: CN=GlobalSign Root CA O=GlobalSign nv-sa OU=Root CA +# Label: "GlobalSign Root CA" +# Serial: 4835703278459707669005204 +# MD5 Fingerprint: 3e:45:52:15:09:51:92:e1:b7:5d:37:9f:b1:87:29:8a +# SHA1 Fingerprint: b1:bc:96:8b:d4:f4:9d:62:2a:a8:9a:81:f2:15:01:52:a4:1d:82:9c +# SHA256 Fingerprint: eb:d4:10:40:e4:bb:3e:c7:42:c9:e3:81:d3:1e:f2:a4:1a:48:b6:68:5c:96:e7:ce:f3:c1:df:6c:d4:33:1c:99 +-----BEGIN CERTIFICATE----- +MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG +A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv +b3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAw +MDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9i +YWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYDVQQDExJHbG9iYWxT +aWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDaDuaZ +jc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavp +xy0Sy6scTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp +1Wrjsok6Vjk4bwY8iGlbKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdG +snUOhugZitVtbNV4FpWi6cgKOOvyJBNPc1STE4U6G7weNLWLBYy5d4ux2x8gkasJ +U26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrXgzT/LCrBbBlDSgeF59N8 +9iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8E +BTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0B +AQUFAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOz +yj1hTdNGCbM+w6DjY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE +38NflNUVyRRBnMRddWQVDf9VMOyGj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymP +AbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhHhm4qxFYxldBniYUr+WymXUad +DKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveCX4XSQRjbgbME +HMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A== +-----END CERTIFICATE----- + +# Issuer: CN=GlobalSign O=GlobalSign OU=GlobalSign Root CA - R2 +# Subject: CN=GlobalSign O=GlobalSign OU=GlobalSign Root CA - R2 +# Label: "GlobalSign Root CA - R2" +# Serial: 4835703278459682885658125 +# MD5 Fingerprint: 94:14:77:7e:3e:5e:fd:8f:30:bd:41:b0:cf:e7:d0:30 +# SHA1 Fingerprint: 75:e0:ab:b6:13:85:12:27:1c:04:f8:5f:dd:de:38:e4:b7:24:2e:fe +# SHA256 Fingerprint: ca:42:dd:41:74:5f:d0:b8:1e:b9:02:36:2c:f9:d8:bf:71:9d:a1:bd:1b:1e:fc:94:6f:5b:4c:99:f4:2c:1b:9e +-----BEGIN CERTIFICATE----- +MIIDujCCAqKgAwIBAgILBAAAAAABD4Ym5g0wDQYJKoZIhvcNAQEFBQAwTDEgMB4G +A1UECxMXR2xvYmFsU2lnbiBSb290IENBIC0gUjIxEzARBgNVBAoTCkdsb2JhbFNp +Z24xEzARBgNVBAMTCkdsb2JhbFNpZ24wHhcNMDYxMjE1MDgwMDAwWhcNMjExMjE1 +MDgwMDAwWjBMMSAwHgYDVQQLExdHbG9iYWxTaWduIFJvb3QgQ0EgLSBSMjETMBEG +A1UEChMKR2xvYmFsU2lnbjETMBEGA1UEAxMKR2xvYmFsU2lnbjCCASIwDQYJKoZI +hvcNAQEBBQADggEPADCCAQoCggEBAKbPJA6+Lm8omUVCxKs+IVSbC9N/hHD6ErPL +v4dfxn+G07IwXNb9rfF73OX4YJYJkhD10FPe+3t+c4isUoh7SqbKSaZeqKeMWhG8 +eoLrvozps6yWJQeXSpkqBy+0Hne/ig+1AnwblrjFuTosvNYSuetZfeLQBoZfXklq +tTleiDTsvHgMCJiEbKjNS7SgfQx5TfC4LcshytVsW33hoCmEofnTlEnLJGKRILzd +C9XZzPnqJworc5HGnRusyMvo4KD0L5CLTfuwNhv2GXqF4G3yYROIXJ/gkwpRl4pa +zq+r1feqCapgvdzZX99yqWATXgAByUr6P6TqBwMhAo6CygPCm48CAwEAAaOBnDCB +mTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUm+IH +V2ccHsBqBt5ZtJot39wZhi4wNgYDVR0fBC8wLTAroCmgJ4YlaHR0cDovL2NybC5n +bG9iYWxzaWduLm5ldC9yb290LXIyLmNybDAfBgNVHSMEGDAWgBSb4gdXZxwewGoG +3lm0mi3f3BmGLjANBgkqhkiG9w0BAQUFAAOCAQEAmYFThxxol4aR7OBKuEQLq4Gs +J0/WwbgcQ3izDJr86iw8bmEbTUsp9Z8FHSbBuOmDAGJFtqkIk7mpM0sYmsL4h4hO +291xNBrBVNpGP+DTKqttVCL1OmLNIG+6KYnX3ZHu01yiPqFbQfXf5WRDLenVOavS +ot+3i9DAgBkcRcAtjOj4LaR0VknFBbVPFd5uRHg5h6h+u/N5GJG79G+dwfCMNYxd +AfvDbbnvRG15RjF+Cv6pgsH/76tuIMRQyV+dTZsXjAzlAcmgQWpzU/qlULRuJQ/7 +TBj0/VLZjmmx6BEP3ojY+x1J96relc8geMJgEtslQIxq/H5COEBkEveegeGTLg== +-----END CERTIFICATE----- + +# Issuer: CN=VeriSign Class 3 Public Primary Certification Authority - G3 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 1999 VeriSign, Inc. - For authorized use only +# Subject: CN=VeriSign Class 3 Public Primary Certification Authority - G3 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 1999 VeriSign, Inc. - For authorized use only +# Label: "Verisign Class 3 Public Primary Certification Authority - G3" +# Serial: 206684696279472310254277870180966723415 +# MD5 Fingerprint: cd:68:b6:a7:c7:c4:ce:75:e0:1d:4f:57:44:61:92:09 +# SHA1 Fingerprint: 13:2d:0d:45:53:4b:69:97:cd:b2:d5:c3:39:e2:55:76:60:9b:5c:c6 +# SHA256 Fingerprint: eb:04:cf:5e:b1:f3:9a:fa:76:2f:2b:b1:20:f2:96:cb:a5:20:c1:b9:7d:b1:58:95:65:b8:1c:b9:a1:7b:72:44 +-----BEGIN CERTIFICATE----- +MIIEGjCCAwICEQCbfgZJoz5iudXukEhxKe9XMA0GCSqGSIb3DQEBBQUAMIHKMQsw +CQYDVQQGEwJVUzEXMBUGA1UEChMOVmVyaVNpZ24sIEluYy4xHzAdBgNVBAsTFlZl +cmlTaWduIFRydXN0IE5ldHdvcmsxOjA4BgNVBAsTMShjKSAxOTk5IFZlcmlTaWdu +LCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxRTBDBgNVBAMTPFZlcmlT +aWduIENsYXNzIDMgUHVibGljIFByaW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3Jp +dHkgLSBHMzAeFw05OTEwMDEwMDAwMDBaFw0zNjA3MTYyMzU5NTlaMIHKMQswCQYD +VQQGEwJVUzEXMBUGA1UEChMOVmVyaVNpZ24sIEluYy4xHzAdBgNVBAsTFlZlcmlT +aWduIFRydXN0IE5ldHdvcmsxOjA4BgNVBAsTMShjKSAxOTk5IFZlcmlTaWduLCBJ +bmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxRTBDBgNVBAMTPFZlcmlTaWdu +IENsYXNzIDMgUHVibGljIFByaW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkg +LSBHMzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMu6nFL8eB8aHm8b +N3O9+MlrlBIwT/A2R/XQkQr1F8ilYcEWQE37imGQ5XYgwREGfassbqb1EUGO+i2t +KmFZpGcmTNDovFJbcCAEWNF6yaRpvIMXZK0Fi7zQWM6NjPXr8EJJC52XJ2cybuGu +kxUccLwgTS8Y3pKI6GyFVxEa6X7jJhFUokWWVYPKMIno3Nij7SqAP395ZVc+FSBm +CC+Vk7+qRy+oRpfwEuL+wgorUeZ25rdGt+INpsyow0xZVYnm6FNcHOqd8GIWC6fJ +Xwzw3sJ2zq/3avL6QaaiMxTJ5Xpj055iN9WFZZ4O5lMkdBteHRJTW8cs54NJOxWu +imi5V5cCAwEAATANBgkqhkiG9w0BAQUFAAOCAQEAERSWwauSCPc/L8my/uRan2Te +2yFPhpk0djZX3dAVL8WtfxUfN2JzPtTnX84XA9s1+ivbrmAJXx5fj267Cz3qWhMe +DGBvtcC1IyIuBwvLqXTLR7sdwdela8wv0kL9Sd2nic9TutoAWii/gt/4uhMdUIaC +/Y4wjylGsB49Ndo4YhYYSq3mtlFs3q9i6wHQHiT+eo8SGhJouPtmmRQURVyu565p +F4ErWjfJXir0xuKhXFSbplQAz/DxwceYMBo7Nhbbo27q/a2ywtrvAkcTisDxszGt +TxzhT5yvDwyd93gN2PQ1VoDat20Xj50egWTh/sVFuq1ruQp6Tk9LhO5L8X3dEQ== +-----END CERTIFICATE----- + +# Issuer: CN=Entrust.net Certification Authority (2048) O=Entrust.net OU=www.entrust.net/CPS_2048 incorp. by ref. (limits liab.)/(c) 1999 Entrust.net Limited +# Subject: CN=Entrust.net Certification Authority (2048) O=Entrust.net OU=www.entrust.net/CPS_2048 incorp. by ref. (limits liab.)/(c) 1999 Entrust.net Limited +# Label: "Entrust.net Premium 2048 Secure Server CA" +# Serial: 946069240 +# MD5 Fingerprint: ee:29:31:bc:32:7e:9a:e6:e8:b5:f7:51:b4:34:71:90 +# SHA1 Fingerprint: 50:30:06:09:1d:97:d4:f5:ae:39:f7:cb:e7:92:7d:7d:65:2d:34:31 +# SHA256 Fingerprint: 6d:c4:71:72:e0:1c:bc:b0:bf:62:58:0d:89:5f:e2:b8:ac:9a:d4:f8:73:80:1e:0c:10:b9:c8:37:d2:1e:b1:77 +-----BEGIN CERTIFICATE----- +MIIEKjCCAxKgAwIBAgIEOGPe+DANBgkqhkiG9w0BAQUFADCBtDEUMBIGA1UEChML +RW50cnVzdC5uZXQxQDA+BgNVBAsUN3d3dy5lbnRydXN0Lm5ldC9DUFNfMjA0OCBp +bmNvcnAuIGJ5IHJlZi4gKGxpbWl0cyBsaWFiLikxJTAjBgNVBAsTHChjKSAxOTk5 +IEVudHJ1c3QubmV0IExpbWl0ZWQxMzAxBgNVBAMTKkVudHJ1c3QubmV0IENlcnRp +ZmljYXRpb24gQXV0aG9yaXR5ICgyMDQ4KTAeFw05OTEyMjQxNzUwNTFaFw0yOTA3 +MjQxNDE1MTJaMIG0MRQwEgYDVQQKEwtFbnRydXN0Lm5ldDFAMD4GA1UECxQ3d3d3 +LmVudHJ1c3QubmV0L0NQU18yMDQ4IGluY29ycC4gYnkgcmVmLiAobGltaXRzIGxp +YWIuKTElMCMGA1UECxMcKGMpIDE5OTkgRW50cnVzdC5uZXQgTGltaXRlZDEzMDEG +A1UEAxMqRW50cnVzdC5uZXQgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgKDIwNDgp +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArU1LqRKGsuqjIAcVFmQq +K0vRvwtKTY7tgHalZ7d4QMBzQshowNtTK91euHaYNZOLGp18EzoOH1u3Hs/lJBQe +sYGpjX24zGtLA/ECDNyrpUAkAH90lKGdCCmziAv1h3edVc3kw37XamSrhRSGlVuX +MlBvPci6Zgzj/L24ScF2iUkZ/cCovYmjZy/Gn7xxGWC4LeksyZB2ZnuU4q941mVT +XTzWnLLPKQP5L6RQstRIzgUyVYr9smRMDuSYB3Xbf9+5CFVghTAp+XtIpGmG4zU/ +HoZdenoVve8AjhUiVBcAkCaTvA5JaJG/+EfTnZVCwQ5N328mz8MYIWJmQ3DW1cAH +4QIDAQABo0IwQDAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNV +HQ4EFgQUVeSB0RGAvtiJuQijMfmhJAkWuXAwDQYJKoZIhvcNAQEFBQADggEBADub +j1abMOdTmXx6eadNl9cZlZD7Bh/KM3xGY4+WZiT6QBshJ8rmcnPyT/4xmf3IDExo +U8aAghOY+rat2l098c5u9hURlIIM7j+VrxGrD9cv3h8Dj1csHsm7mhpElesYT6Yf +zX1XEC+bBAlahLVu2B064dae0Wx5XnkcFMXj0EyTO2U87d89vqbllRrDtRnDvV5b +u/8j72gZyxKTJ1wDLW8w0B62GqzeWvfRqqgnpv55gcR5mTNXuhKwqeBCbJPKVt7+ +bYQLCIt+jerXmCHG8+c8eS9enNFMFY3h7CI3zJpDC5fcgJCNs2ebb0gIFVbPv/Er +fF6adulZkMV8gzURZVE= +-----END CERTIFICATE----- + +# Issuer: CN=Baltimore CyberTrust Root O=Baltimore OU=CyberTrust +# Subject: CN=Baltimore CyberTrust Root O=Baltimore OU=CyberTrust +# Label: "Baltimore CyberTrust Root" +# Serial: 33554617 +# MD5 Fingerprint: ac:b6:94:a5:9c:17:e0:d7:91:52:9b:b1:97:06:a6:e4 +# SHA1 Fingerprint: d4:de:20:d0:5e:66:fc:53:fe:1a:50:88:2c:78:db:28:52:ca:e4:74 +# SHA256 Fingerprint: 16:af:57:a9:f6:76:b0:ab:12:60:95:aa:5e:ba:de:f2:2a:b3:11:19:d6:44:ac:95:cd:4b:93:db:f3:f2:6a:eb +-----BEGIN CERTIFICATE----- +MIIDdzCCAl+gAwIBAgIEAgAAuTANBgkqhkiG9w0BAQUFADBaMQswCQYDVQQGEwJJ +RTESMBAGA1UEChMJQmFsdGltb3JlMRMwEQYDVQQLEwpDeWJlclRydXN0MSIwIAYD +VQQDExlCYWx0aW1vcmUgQ3liZXJUcnVzdCBSb290MB4XDTAwMDUxMjE4NDYwMFoX +DTI1MDUxMjIzNTkwMFowWjELMAkGA1UEBhMCSUUxEjAQBgNVBAoTCUJhbHRpbW9y +ZTETMBEGA1UECxMKQ3liZXJUcnVzdDEiMCAGA1UEAxMZQmFsdGltb3JlIEN5YmVy +VHJ1c3QgUm9vdDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKMEuyKr +mD1X6CZymrV51Cni4eiVgLGw41uOKymaZN+hXe2wCQVt2yguzmKiYv60iNoS6zjr +IZ3AQSsBUnuId9Mcj8e6uYi1agnnc+gRQKfRzMpijS3ljwumUNKoUMMo6vWrJYeK +mpYcqWe4PwzV9/lSEy/CG9VwcPCPwBLKBsua4dnKM3p31vjsufFoREJIE9LAwqSu +XmD+tqYF/LTdB1kC1FkYmGP1pWPgkAx9XbIGevOF6uvUA65ehD5f/xXtabz5OTZy +dc93Uk3zyZAsuT3lySNTPx8kmCFcB5kpvcY67Oduhjprl3RjM71oGDHweI12v/ye +jl0qhqdNkNwnGjkCAwEAAaNFMEMwHQYDVR0OBBYEFOWdWTCCR1jMrPoIVDaGezq1 +BE3wMBIGA1UdEwEB/wQIMAYBAf8CAQMwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3 +DQEBBQUAA4IBAQCFDF2O5G9RaEIFoN27TyclhAO992T9Ldcw46QQF+vaKSm2eT92 +9hkTI7gQCvlYpNRhcL0EYWoSihfVCr3FvDB81ukMJY2GQE/szKN+OMY3EU/t3Wgx +jkzSswF07r51XgdIGn9w/xZchMB5hbgF/X++ZRGjD8ACtPhSNzkE1akxehi/oCr0 +Epn3o0WC4zxe9Z2etciefC7IpJ5OCBRLbf1wbWsaY71k5h+3zvDyny67G7fyUIhz +ksLi4xaNmjICq44Y3ekQEe5+NauQrz4wlHrQMz2nZQ/1/I6eYs9HRCwBXbsdtTLS +R9I4LtD+gdwyah617jzV/OeBHRnDJELqYzmp +-----END CERTIFICATE----- + +# Issuer: CN=AddTrust External CA Root O=AddTrust AB OU=AddTrust External TTP Network +# Subject: CN=AddTrust External CA Root O=AddTrust AB OU=AddTrust External TTP Network +# Label: "AddTrust External Root" +# Serial: 1 +# MD5 Fingerprint: 1d:35:54:04:85:78:b0:3f:42:42:4d:bf:20:73:0a:3f +# SHA1 Fingerprint: 02:fa:f3:e2:91:43:54:68:60:78:57:69:4d:f5:e4:5b:68:85:18:68 +# SHA256 Fingerprint: 68:7f:a4:51:38:22:78:ff:f0:c8:b1:1f:8d:43:d5:76:67:1c:6e:b2:bc:ea:b4:13:fb:83:d9:65:d0:6d:2f:f2 +-----BEGIN CERTIFICATE----- +MIIENjCCAx6gAwIBAgIBATANBgkqhkiG9w0BAQUFADBvMQswCQYDVQQGEwJTRTEU +MBIGA1UEChMLQWRkVHJ1c3QgQUIxJjAkBgNVBAsTHUFkZFRydXN0IEV4dGVybmFs +IFRUUCBOZXR3b3JrMSIwIAYDVQQDExlBZGRUcnVzdCBFeHRlcm5hbCBDQSBSb290 +MB4XDTAwMDUzMDEwNDgzOFoXDTIwMDUzMDEwNDgzOFowbzELMAkGA1UEBhMCU0Ux +FDASBgNVBAoTC0FkZFRydXN0IEFCMSYwJAYDVQQLEx1BZGRUcnVzdCBFeHRlcm5h +bCBUVFAgTmV0d29yazEiMCAGA1UEAxMZQWRkVHJ1c3QgRXh0ZXJuYWwgQ0EgUm9v +dDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALf3GjPm8gAELTngTlvt +H7xsD821+iO2zt6bETOXpClMfZOfvUq8k+0DGuOPz+VtUFrWlymUWoCwSXrbLpX9 +uMq/NzgtHj6RQa1wVsfwTz/oMp50ysiQVOnGXw94nZpAPA6sYapeFI+eh6FqUNzX +mk6vBbOmcZSccbNQYArHE504B4YCqOmoaSYYkKtMsE8jqzpPhNjfzp/haW+710LX +a0Tkx63ubUFfclpxCDezeWWkWaCUN/cALw3CknLa0Dhy2xSoRcRdKn23tNbE7qzN +E0S3ySvdQwAl+mG5aWpYIxG3pzOPVnVZ9c0p10a3CitlttNCbxWyuHv77+ldU9U0 +WicCAwEAAaOB3DCB2TAdBgNVHQ4EFgQUrb2YejS0Jvf6xCZU7wO94CTLVBowCwYD +VR0PBAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wgZkGA1UdIwSBkTCBjoAUrb2YejS0 +Jvf6xCZU7wO94CTLVBqhc6RxMG8xCzAJBgNVBAYTAlNFMRQwEgYDVQQKEwtBZGRU +cnVzdCBBQjEmMCQGA1UECxMdQWRkVHJ1c3QgRXh0ZXJuYWwgVFRQIE5ldHdvcmsx +IjAgBgNVBAMTGUFkZFRydXN0IEV4dGVybmFsIENBIFJvb3SCAQEwDQYJKoZIhvcN +AQEFBQADggEBALCb4IUlwtYj4g+WBpKdQZic2YR5gdkeWxQHIzZlj7DYd7usQWxH +YINRsPkyPef89iYTx4AWpb9a/IfPeHmJIZriTAcKhjW88t5RxNKWt9x+Tu5w/Rw5 +6wwCURQtjr0W4MHfRnXnJK3s9EK0hZNwEGe6nQY1ShjTK3rMUUKhemPR5ruhxSvC +Nr4TDea9Y355e6cJDUCrat2PisP29owaQgVR1EX1n6diIWgVIEM8med8vSTYqZEX +c4g/VhsxOBi0cQ+azcgOno4uG+GMmIPLHzHxREzGBHNJdmAPx/i9F4BrLunMTA5a +mnkPIAou1Z5jJh5VkpTYghdae9C8x49OhgQ= +-----END CERTIFICATE----- + +# Issuer: CN=Entrust Root Certification Authority O=Entrust, Inc. OU=www.entrust.net/CPS is incorporated by reference/(c) 2006 Entrust, Inc. +# Subject: CN=Entrust Root Certification Authority O=Entrust, Inc. OU=www.entrust.net/CPS is incorporated by reference/(c) 2006 Entrust, Inc. +# Label: "Entrust Root Certification Authority" +# Serial: 1164660820 +# MD5 Fingerprint: d6:a5:c3:ed:5d:dd:3e:00:c1:3d:87:92:1f:1d:3f:e4 +# SHA1 Fingerprint: b3:1e:b1:b7:40:e3:6c:84:02:da:dc:37:d4:4d:f5:d4:67:49:52:f9 +# SHA256 Fingerprint: 73:c1:76:43:4f:1b:c6:d5:ad:f4:5b:0e:76:e7:27:28:7c:8d:e5:76:16:c1:e6:e6:14:1a:2b:2c:bc:7d:8e:4c +-----BEGIN CERTIFICATE----- +MIIEkTCCA3mgAwIBAgIERWtQVDANBgkqhkiG9w0BAQUFADCBsDELMAkGA1UEBhMC +VVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xOTA3BgNVBAsTMHd3dy5lbnRydXN0 +Lm5ldC9DUFMgaXMgaW5jb3Jwb3JhdGVkIGJ5IHJlZmVyZW5jZTEfMB0GA1UECxMW +KGMpIDIwMDYgRW50cnVzdCwgSW5jLjEtMCsGA1UEAxMkRW50cnVzdCBSb290IENl +cnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTA2MTEyNzIwMjM0MloXDTI2MTEyNzIw +NTM0MlowgbAxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1FbnRydXN0LCBJbmMuMTkw +NwYDVQQLEzB3d3cuZW50cnVzdC5uZXQvQ1BTIGlzIGluY29ycG9yYXRlZCBieSBy +ZWZlcmVuY2UxHzAdBgNVBAsTFihjKSAyMDA2IEVudHJ1c3QsIEluYy4xLTArBgNV +BAMTJEVudHJ1c3QgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTCCASIwDQYJ +KoZIhvcNAQEBBQADggEPADCCAQoCggEBALaVtkNC+sZtKm9I35RMOVcF7sN5EUFo +Nu3s/poBj6E4KPz3EEZmLk0eGrEaTsbRwJWIsMn/MYszA9u3g3s+IIRe7bJWKKf4 +4LlAcTfFy0cOlypowCKVYhXbR9n10Cv/gkvJrT7eTNuQgFA/CYqEAOwwCj0Yzfv9 +KlmaI5UXLEWeH25DeW0MXJj+SKfFI0dcXv1u5x609mhF0YaDW6KKjbHjKYD+JXGI +rb68j6xSlkuqUY3kEzEZ6E5Nn9uss2rVvDlUccp6en+Q3X0dgNmBu1kmwhH+5pPi +94DkZfs0Nw4pgHBNrziGLp5/V6+eF67rHMsoIV+2HNjnogQi+dPa2MsCAwEAAaOB +sDCBrTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zArBgNVHRAEJDAi +gA8yMDA2MTEyNzIwMjM0MlqBDzIwMjYxMTI3MjA1MzQyWjAfBgNVHSMEGDAWgBRo +kORnpKZTgMeGZqTx90tD+4S9bTAdBgNVHQ4EFgQUaJDkZ6SmU4DHhmak8fdLQ/uE +vW0wHQYJKoZIhvZ9B0EABBAwDhsIVjcuMTo0LjADAgSQMA0GCSqGSIb3DQEBBQUA +A4IBAQCT1DCw1wMgKtD5Y+iRDAUgqV8ZyntyTtSx29CW+1RaGSwMCPeyvIWonX9t +O1KzKtvn1ISMY/YPyyYBkVBs9F8U4pN0wBOeMDpQ47RgxRzwIkSNcUesyBrJ6Zua +AGAT/3B+XxFNSRuzFVJ7yVTav52Vr2ua2J7p8eRDjeIRRDq/r72DQnNSi6q7pynP +9WQcCk3RvKqsnyrQ/39/2n3qse0wJcGE2jTSW3iDVuycNsMm4hH2Z0kdkquM++v/ +eu6FSqdQgPCnXEqULl8FmTxSQeDNtGPPAUO6nIPcj2A781q0tHuu2guQOHXvgR1m +0vdXcDazv/wor3ElhVsT/h5/WrQ8 +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Global CA O=GeoTrust Inc. +# Subject: CN=GeoTrust Global CA O=GeoTrust Inc. +# Label: "GeoTrust Global CA" +# Serial: 144470 +# MD5 Fingerprint: f7:75:ab:29:fb:51:4e:b7:77:5e:ff:05:3c:99:8e:f5 +# SHA1 Fingerprint: de:28:f4:a4:ff:e5:b9:2f:a3:c5:03:d1:a3:49:a7:f9:96:2a:82:12 +# SHA256 Fingerprint: ff:85:6a:2d:25:1d:cd:88:d3:66:56:f4:50:12:67:98:cf:ab:aa:de:40:79:9c:72:2d:e4:d2:b5:db:36:a7:3a +-----BEGIN CERTIFICATE----- +MIIDVDCCAjygAwIBAgIDAjRWMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT +MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i +YWwgQ0EwHhcNMDIwNTIxMDQwMDAwWhcNMjIwNTIxMDQwMDAwWjBCMQswCQYDVQQG +EwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEbMBkGA1UEAxMSR2VvVHJ1c3Qg +R2xvYmFsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2swYYzD9 +9BcjGlZ+W988bDjkcbd4kdS8odhM+KhDtgPpTSEHCIjaWC9mOSm9BXiLnTjoBbdq +fnGk5sRgprDvgOSJKA+eJdbtg/OtppHHmMlCGDUUna2YRpIuT8rxh0PBFpVXLVDv +iS2Aelet8u5fa9IAjbkU+BQVNdnARqN7csiRv8lVK83Qlz6cJmTM386DGXHKTubU +1XupGc1V3sjs0l44U+VcT4wt/lAjNvxm5suOpDkZALeVAjmRCw7+OC7RHQWa9k0+ +bw8HHa8sHo9gOeL6NlMTOdReJivbPagUvTLrGAMoUgRx5aszPeE4uwc2hGKceeoW +MPRfwCvocWvk+QIDAQABo1MwUTAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTA +ephojYn7qwVkDBF9qn1luMrMTjAfBgNVHSMEGDAWgBTAephojYn7qwVkDBF9qn1l +uMrMTjANBgkqhkiG9w0BAQUFAAOCAQEANeMpauUvXVSOKVCUn5kaFOSPeCpilKIn +Z57QzxpeR+nBsqTP3UEaBU6bS+5Kb1VSsyShNwrrZHYqLizz/Tt1kL/6cdjHPTfS +tQWVYrmm3ok9Nns4d0iXrKYgjy6myQzCsplFAMfOEVEiIuCl6rYVSAlk6l5PdPcF +PseKUgzbFbS9bZvlxrFUaKnjaZC2mqUPuLk/IH2uSrW4nOQdtqvmlKXBx4Ot2/Un +hw4EbNX/3aBd7YdStysVAq45pmp06drE57xNNB6pXE0zX5IJL4hmXXeXxx12E6nV +5fEWCRE11azbJHFwLJhWC9kXtNHjUStedejV0NxPNO3CBWaAocvmMw== +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Universal CA O=GeoTrust Inc. +# Subject: CN=GeoTrust Universal CA O=GeoTrust Inc. +# Label: "GeoTrust Universal CA" +# Serial: 1 +# MD5 Fingerprint: 92:65:58:8b:a2:1a:31:72:73:68:5c:b4:a5:7a:07:48 +# SHA1 Fingerprint: e6:21:f3:35:43:79:05:9a:4b:68:30:9d:8a:2f:74:22:15:87:ec:79 +# SHA256 Fingerprint: a0:45:9b:9f:63:b2:25:59:f5:fa:5d:4c:6d:b3:f9:f7:2f:f1:93:42:03:35:78:f0:73:bf:1d:1b:46:cb:b9:12 +-----BEGIN CERTIFICATE----- +MIIFaDCCA1CgAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMQswCQYDVQQGEwJVUzEW +MBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEeMBwGA1UEAxMVR2VvVHJ1c3QgVW5pdmVy +c2FsIENBMB4XDTA0MDMwNDA1MDAwMFoXDTI5MDMwNDA1MDAwMFowRTELMAkGA1UE +BhMCVVMxFjAUBgNVBAoTDUdlb1RydXN0IEluYy4xHjAcBgNVBAMTFUdlb1RydXN0 +IFVuaXZlcnNhbCBDQTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAKYV +VaCjxuAfjJ0hUNfBvitbtaSeodlyWL0AG0y/YckUHUWCq8YdgNY96xCcOq9tJPi8 +cQGeBvV8Xx7BDlXKg5pZMK4ZyzBIle0iN430SppyZj6tlcDgFgDgEB8rMQ7XlFTT +QjOgNB0eRXbdT8oYN+yFFXoZCPzVx5zw8qkuEKmS5j1YPakWaDwvdSEYfyh3peFh +F7em6fgemdtzbvQKoiFs7tqqhZJmr/Z6a4LauiIINQ/PQvE1+mrufislzDoR5G2v +c7J2Ha3QsnhnGqQ5HFELZ1aD/ThdDc7d8Lsrlh/eezJS/R27tQahsiFepdaVaH/w +mZ7cRQg+59IJDTWU3YBOU5fXtQlEIGQWFwMCTFMNaN7VqnJNk22CDtucvc+081xd +VHppCZbW2xHBjXWotM85yM48vCR85mLK4b19p71XZQvk/iXttmkQ3CgaRr0BHdCX +teGYO8A3ZNY9lO4L4fUorgtWv3GLIylBjobFS1J72HGrH4oVpjuDWtdYAVHGTEHZ +f9hBZ3KiKN9gg6meyHv8U3NyWfWTehd2Ds735VzZC1U0oqpbtWpU5xPKV+yXbfRe +Bi9Fi1jUIxaS5BZuKGNZMN9QAZxjiRqf2xeUgnA3wySemkfWWspOqGmJch+RbNt+ +nhutxx9z3SxPGWX9f5NAEC7S8O08ni4oPmkmM8V7AgMBAAGjYzBhMA8GA1UdEwEB +/wQFMAMBAf8wHQYDVR0OBBYEFNq7LqqwDLiIJlF0XG0D08DYj3rWMB8GA1UdIwQY +MBaAFNq7LqqwDLiIJlF0XG0D08DYj3rWMA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG +9w0BAQUFAAOCAgEAMXjmx7XfuJRAyXHEqDXsRh3ChfMoWIawC/yOsjmPRFWrZIRc +aanQmjg8+uUfNeVE44B5lGiku8SfPeE0zTBGi1QrlaXv9z+ZhP015s8xxtxqv6fX +IwjhmF7DWgh2qaavdy+3YL1ERmrvl/9zlcGO6JP7/TG37FcREUWbMPEaiDnBTzyn +ANXH/KttgCJwpQzgXQQpAvvLoJHRfNbDflDVnVi+QTjruXU8FdmbyUqDWcDaU/0z +uzYYm4UPFd3uLax2k7nZAY1IEKj79TiG8dsKxr2EoyNB3tZ3b4XUhRxQ4K5RirqN +Pnbiucon8l+f725ZDQbYKxek0nxru18UGkiPGkzns0ccjkxFKyDuSN/n3QmOGKja +QI2SJhFTYXNd673nxE0pN2HrrDktZy4W1vUAg4WhzH92xH3kt0tm7wNFYGm2DFKW +koRepqO1pD4r2czYG0eq8kTaT/kD6PAUyz/zg97QwVTjt+gKN02LIFkDMBmhLMi9 +ER/frslKxfMnZmaGrGiR/9nmUxwPi1xpZQomyB40w11Re9epnAahNt3ViZS82eQt +DF4JbAiXfKM9fJP/P6EUp8+1Xevb2xzEdt+Iub1FBZUbrvxGakyvSOPOrg/Sfuvm +bJxPgWp6ZKy7PtXny3YuxadIwVyQD8vIP/rmMuGNG2+k5o7Y+SlIis5z/iw= +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Universal CA 2 O=GeoTrust Inc. +# Subject: CN=GeoTrust Universal CA 2 O=GeoTrust Inc. +# Label: "GeoTrust Universal CA 2" +# Serial: 1 +# MD5 Fingerprint: 34:fc:b8:d0:36:db:9e:14:b3:c2:f2:db:8f:e4:94:c7 +# SHA1 Fingerprint: 37:9a:19:7b:41:85:45:35:0c:a6:03:69:f3:3c:2e:af:47:4f:20:79 +# SHA256 Fingerprint: a0:23:4f:3b:c8:52:7c:a5:62:8e:ec:81:ad:5d:69:89:5d:a5:68:0d:c9:1d:1c:b8:47:7f:33:f8:78:b9:5b:0b +-----BEGIN CERTIFICATE----- +MIIFbDCCA1SgAwIBAgIBATANBgkqhkiG9w0BAQUFADBHMQswCQYDVQQGEwJVUzEW +MBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEgMB4GA1UEAxMXR2VvVHJ1c3QgVW5pdmVy +c2FsIENBIDIwHhcNMDQwMzA0MDUwMDAwWhcNMjkwMzA0MDUwMDAwWjBHMQswCQYD +VQQGEwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEgMB4GA1UEAxMXR2VvVHJ1 +c3QgVW5pdmVyc2FsIENBIDIwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoIC +AQCzVFLByT7y2dyxUxpZKeexw0Uo5dfR7cXFS6GqdHtXr0om/Nj1XqduGdt0DE81 +WzILAePb63p3NeqqWuDW6KFXlPCQo3RWlEQwAx5cTiuFJnSCegx2oG9NzkEtoBUG +FF+3Qs17j1hhNNwqCPkuwwGmIkQcTAeC5lvO0Ep8BNMZcyfwqph/Lq9O64ceJHdq +XbboW0W63MOhBW9Wjo8QJqVJwy7XQYci4E+GymC16qFjwAGXEHm9ADwSbSsVsaxL +se4YuU6W3Nx2/zu+z18DwPw76L5GG//aQMJS9/7jOvdqdzXQ2o3rXhhqMcceujwb +KNZrVMaqW9eiLBsZzKIC9ptZvTdrhrVtgrrY6slWvKk2WP0+GfPtDCapkzj4T8Fd +IgbQl+rhrcZV4IErKIM6+vR7IVEAvlI4zs1meaj0gVbi0IMJR1FbUGrP20gaXT73 +y/Zl92zxlfgCOzJWgjl6W70viRu/obTo/3+NjN8D8WBOWBFM66M/ECuDmgFz2ZRt +hAAnZqzwcEAJQpKtT5MNYQlRJNiS1QuUYbKHsu3/mjX/hVTK7URDrBs8FmtISgoc +QIgfksILAAX/8sgCSqSqqcyZlpwvWOB94b67B9xfBHJcMTTD7F8t4D1kkCLm0ey4 +Lt1ZrtmhN79UNdxzMk+MBB4zsslG8dhcyFVQyWi9qLo2CQIDAQABo2MwYTAPBgNV +HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR281Xh+qQ2+/CfXGJx7Tz0RzgQKzAfBgNV +HSMEGDAWgBR281Xh+qQ2+/CfXGJx7Tz0RzgQKzAOBgNVHQ8BAf8EBAMCAYYwDQYJ +KoZIhvcNAQEFBQADggIBAGbBxiPz2eAubl/oz66wsCVNK/g7WJtAJDday6sWSf+z +dXkzoS9tcBc0kf5nfo/sm+VegqlVHy/c1FEHEv6sFj4sNcZj/NwQ6w2jqtB8zNHQ +L1EuxBRa3ugZ4T7GzKQp5y6EqgYweHZUcyiYWTjgAA1i00J9IZ+uPTqM1fp3DRgr +Fg5fNuH8KrUwJM/gYwx7WBr+mbpCErGR9Hxo4sjoryzqyX6uuyo9DRXcNJW2GHSo +ag/HtPQTxORb7QrSpJdMKu0vbBKJPfEncKpqA1Ihn0CoZ1Dy81of398j9tx4TuaY +T1U6U+Pv8vSfx3zYWK8pIpe44L2RLrB27FcRz+8pRPPphXpgY+RdM4kX2TGq2tbz +GDVyz4crL2MjhF2EjD9XoIj8mZEoJmmZ1I+XRL6O1UixpCgp8RW04eWe3fiPpm8m +1wk8OhwRDqZsN/etRIcsKMfYdIKz0G9KV7s1KSegi+ghp4dkNl3M2Basx7InQJJV +OCiNUW7dFGdTbHFcJoRNdVq2fmBWqU2t+5sel/MN2dKXVHfaPRK34B7vCAas+YWH +6aLcr34YEoP9VhdBLtUpgn2Z9DH2canPLAEnpQW5qrJITirvn5NSUZU8UnOOVkwX +QMAJKOSLakhT2+zNVVXxxvjpoixMptEmX36vWkzaH6byHCx+rgIW0lbQL1dTR+iS +-----END CERTIFICATE----- + +# Issuer: CN=Visa eCommerce Root O=VISA OU=Visa International Service Association +# Subject: CN=Visa eCommerce Root O=VISA OU=Visa International Service Association +# Label: "Visa eCommerce Root" +# Serial: 25952180776285836048024890241505565794 +# MD5 Fingerprint: fc:11:b8:d8:08:93:30:00:6d:23:f9:7e:eb:52:1e:02 +# SHA1 Fingerprint: 70:17:9b:86:8c:00:a4:fa:60:91:52:22:3f:9f:3e:32:bd:e0:05:62 +# SHA256 Fingerprint: 69:fa:c9:bd:55:fb:0a:c7:8d:53:bb:ee:5c:f1:d5:97:98:9f:d0:aa:ab:20:a2:51:51:bd:f1:73:3e:e7:d1:22 +-----BEGIN CERTIFICATE----- +MIIDojCCAoqgAwIBAgIQE4Y1TR0/BvLB+WUF1ZAcYjANBgkqhkiG9w0BAQUFADBr +MQswCQYDVQQGEwJVUzENMAsGA1UEChMEVklTQTEvMC0GA1UECxMmVmlzYSBJbnRl +cm5hdGlvbmFsIFNlcnZpY2UgQXNzb2NpYXRpb24xHDAaBgNVBAMTE1Zpc2EgZUNv +bW1lcmNlIFJvb3QwHhcNMDIwNjI2MDIxODM2WhcNMjIwNjI0MDAxNjEyWjBrMQsw +CQYDVQQGEwJVUzENMAsGA1UEChMEVklTQTEvMC0GA1UECxMmVmlzYSBJbnRlcm5h +dGlvbmFsIFNlcnZpY2UgQXNzb2NpYXRpb24xHDAaBgNVBAMTE1Zpc2EgZUNvbW1l +cmNlIFJvb3QwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvV95WHm6h +2mCxlCfLF9sHP4CFT8icttD0b0/Pmdjh28JIXDqsOTPHH2qLJj0rNfVIsZHBAk4E +lpF7sDPwsRROEW+1QK8bRaVK7362rPKgH1g/EkZgPI2h4H3PVz4zHvtH8aoVlwdV +ZqW1LS7YgFmypw23RuwhY/81q6UCzyr0TP579ZRdhE2o8mCP2w4lPJ9zcc+U30rq +299yOIzzlr3xF7zSujtFWsan9sYXiwGd/BmoKoMWuDpI/k4+oKsGGelT84ATB+0t +vz8KPFUgOSwsAGl0lUq8ILKpeeUYiZGo3BxN77t+Nwtd/jmliFKMAGzsGHxBvfaL +dXe6YJ2E5/4tAgMBAAGjQjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQD +AgEGMB0GA1UdDgQWBBQVOIMPPyw/cDMezUb+B4wg4NfDtzANBgkqhkiG9w0BAQUF +AAOCAQEAX/FBfXxcCLkr4NWSR/pnXKUTwwMhmytMiUbPWU3J/qVAtmPN3XEolWcR +zCSs00Rsca4BIGsDoo8Ytyk6feUWYFN4PMCvFYP3j1IzJL1kk5fui/fbGKhtcbP3 +LBfQdCVp9/5rPJS+TUtBjE7ic9DjkCJzQ83z7+pzzkWKsKZJ/0x9nXGIxHYdkFsd +7v3M9+79YKWxehZx0RbQfBI8bGmX265fOZpwLwU8GUYEmSA20GBuYQa7FkKMcPcw +++DbZqMAAb3mLNqRX6BGi01qnD093QVG/na/oAo85ADmJ7f/hC3euiInlhBx6yLt +398znM/jra6O1I7mT1GvFpLgXPYHDw== +-----END CERTIFICATE----- + +# Issuer: CN=AAA Certificate Services O=Comodo CA Limited +# Subject: CN=AAA Certificate Services O=Comodo CA Limited +# Label: "Comodo AAA Services root" +# Serial: 1 +# MD5 Fingerprint: 49:79:04:b0:eb:87:19:ac:47:b0:bc:11:51:9b:74:d0 +# SHA1 Fingerprint: d1:eb:23:a4:6d:17:d6:8f:d9:25:64:c2:f1:f1:60:17:64:d8:e3:49 +# SHA256 Fingerprint: d7:a7:a0:fb:5d:7e:27:31:d7:71:e9:48:4e:bc:de:f7:1d:5f:0c:3e:0a:29:48:78:2b:c8:3e:e0:ea:69:9e:f4 +-----BEGIN CERTIFICATE----- +MIIEMjCCAxqgAwIBAgIBATANBgkqhkiG9w0BAQUFADB7MQswCQYDVQQGEwJHQjEb +MBkGA1UECAwSR3JlYXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHDAdTYWxmb3JkMRow +GAYDVQQKDBFDb21vZG8gQ0EgTGltaXRlZDEhMB8GA1UEAwwYQUFBIENlcnRpZmlj +YXRlIFNlcnZpY2VzMB4XDTA0MDEwMTAwMDAwMFoXDTI4MTIzMTIzNTk1OVowezEL +MAkGA1UEBhMCR0IxGzAZBgNVBAgMEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UE +BwwHU2FsZm9yZDEaMBgGA1UECgwRQ29tb2RvIENBIExpbWl0ZWQxITAfBgNVBAMM +GEFBQSBDZXJ0aWZpY2F0ZSBTZXJ2aWNlczCCASIwDQYJKoZIhvcNAQEBBQADggEP +ADCCAQoCggEBAL5AnfRu4ep2hxxNRUSOvkbIgwadwSr+GB+O5AL686tdUIoWMQua +BtDFcCLNSS1UY8y2bmhGC1Pqy0wkwLxyTurxFa70VJoSCsN6sjNg4tqJVfMiWPPe +3M/vg4aijJRPn2jymJBGhCfHdr/jzDUsi14HZGWCwEiwqJH5YZ92IFCokcdmtet4 +YgNW8IoaE+oxox6gmf049vYnMlhvB/VruPsUK6+3qszWY19zjNoFmag4qMsXeDZR +rOme9Hg6jc8P2ULimAyrL58OAd7vn5lJ8S3frHRNG5i1R8XlKdH5kBjHYpy+g8cm +ez6KJcfA3Z3mNWgQIJ2P2N7Sw4ScDV7oL8kCAwEAAaOBwDCBvTAdBgNVHQ4EFgQU +oBEKIz6W8Qfs4q8p74Klf9AwpLQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQF +MAMBAf8wewYDVR0fBHQwcjA4oDagNIYyaHR0cDovL2NybC5jb21vZG9jYS5jb20v +QUFBQ2VydGlmaWNhdGVTZXJ2aWNlcy5jcmwwNqA0oDKGMGh0dHA6Ly9jcmwuY29t +b2RvLm5ldC9BQUFDZXJ0aWZpY2F0ZVNlcnZpY2VzLmNybDANBgkqhkiG9w0BAQUF +AAOCAQEACFb8AvCb6P+k+tZ7xkSAzk/ExfYAWMymtrwUSWgEdujm7l3sAg9g1o1Q +GE8mTgHj5rCl7r+8dFRBv/38ErjHT1r0iWAFf2C3BUrz9vHCv8S5dIa2LX1rzNLz +Rt0vxuBqw8M0Ayx9lt1awg6nCpnBBYurDC/zXDrPbDdVCYfeU0BsWO/8tqtlbgT2 +G9w84FoVxp7Z8VlIMCFlA2zs6SFz7JsDoeA3raAVGI/6ugLOpyypEBMs1OUIJqsi +l2D4kF501KKaU73yqWjgom7C12yxow+ev+to51byrvLjKzg6CYG1a4XXvi3tPxq3 +smPi9WIsgtRqAEFQ8TmDn5XpNpaYbg== +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root Certification Authority O=QuoVadis Limited OU=Root Certification Authority +# Subject: CN=QuoVadis Root Certification Authority O=QuoVadis Limited OU=Root Certification Authority +# Label: "QuoVadis Root CA" +# Serial: 985026699 +# MD5 Fingerprint: 27:de:36:fe:72:b7:00:03:00:9d:f4:f0:1e:6c:04:24 +# SHA1 Fingerprint: de:3f:40:bd:50:93:d3:9b:6c:60:f6:da:bc:07:62:01:00:89:76:c9 +# SHA256 Fingerprint: a4:5e:de:3b:bb:f0:9c:8a:e1:5c:72:ef:c0:72:68:d6:93:a2:1c:99:6f:d5:1e:67:ca:07:94:60:fd:6d:88:73 +-----BEGIN CERTIFICATE----- +MIIF0DCCBLigAwIBAgIEOrZQizANBgkqhkiG9w0BAQUFADB/MQswCQYDVQQGEwJC +TTEZMBcGA1UEChMQUXVvVmFkaXMgTGltaXRlZDElMCMGA1UECxMcUm9vdCBDZXJ0 +aWZpY2F0aW9uIEF1dGhvcml0eTEuMCwGA1UEAxMlUXVvVmFkaXMgUm9vdCBDZXJ0 +aWZpY2F0aW9uIEF1dGhvcml0eTAeFw0wMTAzMTkxODMzMzNaFw0yMTAzMTcxODMz +MzNaMH8xCzAJBgNVBAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBMaW1pdGVkMSUw +IwYDVQQLExxSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MS4wLAYDVQQDEyVR +dW9WYWRpcyBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIIBIjANBgkqhkiG +9w0BAQEFAAOCAQ8AMIIBCgKCAQEAv2G1lVO6V/z68mcLOhrfEYBklbTRvM16z/Yp +li4kVEAkOPcahdxYTMukJ0KX0J+DisPkBgNbAKVRHnAEdOLB1Dqr1607BxgFjv2D +rOpm2RgbaIr1VxqYuvXtdj182d6UajtLF8HVj71lODqV0D1VNk7feVcxKh7YWWVJ +WCCYfqtffp/p1k3sg3Spx2zY7ilKhSoGFPlU5tPaZQeLYzcS19Dsw3sgQUSj7cug +F+FxZc4dZjH3dgEZyH0DWLaVSR2mEiboxgx24ONmy+pdpibu5cxfvWenAScOospU +xbF6lR1xHkopigPcakXBpBlebzbNw6Kwt/5cOOJSvPhEQ+aQuwIDAQABo4ICUjCC +Ak4wPQYIKwYBBQUHAQEEMTAvMC0GCCsGAQUFBzABhiFodHRwczovL29jc3AucXVv +dmFkaXNvZmZzaG9yZS5jb20wDwYDVR0TAQH/BAUwAwEB/zCCARoGA1UdIASCAREw +ggENMIIBCQYJKwYBBAG+WAABMIH7MIHUBggrBgEFBQcCAjCBxxqBxFJlbGlhbmNl +IG9uIHRoZSBRdW9WYWRpcyBSb290IENlcnRpZmljYXRlIGJ5IGFueSBwYXJ0eSBh +c3N1bWVzIGFjY2VwdGFuY2Ugb2YgdGhlIHRoZW4gYXBwbGljYWJsZSBzdGFuZGFy +ZCB0ZXJtcyBhbmQgY29uZGl0aW9ucyBvZiB1c2UsIGNlcnRpZmljYXRpb24gcHJh +Y3RpY2VzLCBhbmQgdGhlIFF1b1ZhZGlzIENlcnRpZmljYXRlIFBvbGljeS4wIgYI +KwYBBQUHAgEWFmh0dHA6Ly93d3cucXVvdmFkaXMuYm0wHQYDVR0OBBYEFItLbe3T +KbkGGew5Oanwl4Rqy+/fMIGuBgNVHSMEgaYwgaOAFItLbe3TKbkGGew5Oanwl4Rq +y+/foYGEpIGBMH8xCzAJBgNVBAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBMaW1p +dGVkMSUwIwYDVQQLExxSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MS4wLAYD +VQQDEyVRdW9WYWRpcyBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5ggQ6tlCL +MA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQUFAAOCAQEAitQUtf70mpKnGdSk +fnIYj9lofFIk3WdvOXrEql494liwTXCYhGHoG+NpGA7O+0dQoE7/8CQfvbLO9Sf8 +7C9TqnN7Az10buYWnuulLsS/VidQK2K6vkscPFVcQR0kvoIgR13VRH56FmjffU1R +cHhXHTMe/QKZnAzNCgVPx7uOpHX6Sm2xgI4JVrmcGmD+XcHXetwReNDWXcG31a0y +mQM6isxUJTkxgXsTIlG6Rmyhu576BGxJJnSP0nPrzDCi5upZIof4l/UO/erMkqQW +xFIY6iHOsfHmhIHluqmGKPJDWl0Snawe2ajlCmqnf6CHKc/yiU3U7MXi5nrQNiOK +SnQ2+Q== +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root CA 2 O=QuoVadis Limited +# Subject: CN=QuoVadis Root CA 2 O=QuoVadis Limited +# Label: "QuoVadis Root CA 2" +# Serial: 1289 +# MD5 Fingerprint: 5e:39:7b:dd:f8:ba:ec:82:e9:ac:62:ba:0c:54:00:2b +# SHA1 Fingerprint: ca:3a:fb:cf:12:40:36:4b:44:b2:16:20:88:80:48:39:19:93:7c:f7 +# SHA256 Fingerprint: 85:a0:dd:7d:d7:20:ad:b7:ff:05:f8:3d:54:2b:20:9d:c7:ff:45:28:f7:d6:77:b1:83:89:fe:a5:e5:c4:9e:86 +-----BEGIN CERTIFICATE----- +MIIFtzCCA5+gAwIBAgICBQkwDQYJKoZIhvcNAQEFBQAwRTELMAkGA1UEBhMCQk0x +GTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxGzAZBgNVBAMTElF1b1ZhZGlzIFJv +b3QgQ0EgMjAeFw0wNjExMjQxODI3MDBaFw0zMTExMjQxODIzMzNaMEUxCzAJBgNV +BAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBMaW1pdGVkMRswGQYDVQQDExJRdW9W +YWRpcyBSb290IENBIDIwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCa +GMpLlA0ALa8DKYrwD4HIrkwZhR0In6spRIXzL4GtMh6QRr+jhiYaHv5+HBg6XJxg +Fyo6dIMzMH1hVBHL7avg5tKifvVrbxi3Cgst/ek+7wrGsxDp3MJGF/hd/aTa/55J +WpzmM+Yklvc/ulsrHHo1wtZn/qtmUIttKGAr79dgw8eTvI02kfN/+NsRE8Scd3bB +rrcCaoF6qUWD4gXmuVbBlDePSHFjIuwXZQeVikvfj8ZaCuWw419eaxGrDPmF60Tp ++ARz8un+XJiM9XOva7R+zdRcAitMOeGylZUtQofX1bOQQ7dsE/He3fbE+Ik/0XX1 +ksOR1YqI0JDs3G3eicJlcZaLDQP9nL9bFqyS2+r+eXyt66/3FsvbzSUr5R/7mp/i +Ucw6UwxI5g69ybR2BlLmEROFcmMDBOAENisgGQLodKcftslWZvB1JdxnwQ5hYIiz +PtGo/KPaHbDRsSNU30R2be1B2MGyIrZTHN81Hdyhdyox5C315eXbyOD/5YDXC2Og +/zOhD7osFRXql7PSorW+8oyWHhqPHWykYTe5hnMz15eWniN9gqRMgeKh0bpnX5UH +oycR7hYQe7xFSkyyBNKr79X9DFHOUGoIMfmR2gyPZFwDwzqLID9ujWc9Otb+fVuI +yV77zGHcizN300QyNQliBJIWENieJ0f7OyHj+OsdWwIDAQABo4GwMIGtMA8GA1Ud +EwEB/wQFMAMBAf8wCwYDVR0PBAQDAgEGMB0GA1UdDgQWBBQahGK8SEwzJQTU7tD2 +A8QZRtGUazBuBgNVHSMEZzBlgBQahGK8SEwzJQTU7tD2A8QZRtGUa6FJpEcwRTEL +MAkGA1UEBhMCQk0xGTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxGzAZBgNVBAMT +ElF1b1ZhZGlzIFJvb3QgQ0EgMoICBQkwDQYJKoZIhvcNAQEFBQADggIBAD4KFk2f +BluornFdLwUvZ+YTRYPENvbzwCYMDbVHZF34tHLJRqUDGCdViXh9duqWNIAXINzn +g/iN/Ae42l9NLmeyhP3ZRPx3UIHmfLTJDQtyU/h2BwdBR5YM++CCJpNVjP4iH2Bl +fF/nJrP3MpCYUNQ3cVX2kiF495V5+vgtJodmVjB3pjd4M1IQWK4/YY7yarHvGH5K +WWPKjaJW1acvvFYfzznB4vsKqBUsfU16Y8Zsl0Q80m/DShcK+JDSV6IZUaUtl0Ha +B0+pUNqQjZRG4T7wlP0QADj1O+hA4bRuVhogzG9Yje0uRY/W6ZM/57Es3zrWIozc +hLsib9D45MY56QSIPMO661V6bYCZJPVsAfv4l7CUW+v90m/xd2gNNWQjrLhVoQPR +TUIZ3Ph1WVaj+ahJefivDrkRoHy3au000LYmYjgahwz46P0u05B/B5EqHdZ+XIWD +mbA4CD/pXvk1B+TJYm5Xf6dQlfe6yJvmjqIBxdZmv3lh8zwc4bmCXF2gw+nYSL0Z +ohEUGW6yhhtoPkg3Goi3XZZenMfvJ2II4pEZXNLxId26F0KCl3GBUzGpn/Z9Yr9y +4aOTHcyKJloJONDO1w2AFrR4pTqHTI2KpdVGl/IsELm8VCLAAVBpQ570su9t+Oza +8eOx79+Rj1QqCyXBJhnEUhAFZdWCEOrCMc0u +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root CA 3 O=QuoVadis Limited +# Subject: CN=QuoVadis Root CA 3 O=QuoVadis Limited +# Label: "QuoVadis Root CA 3" +# Serial: 1478 +# MD5 Fingerprint: 31:85:3c:62:94:97:63:b9:aa:fd:89:4e:af:6f:e0:cf +# SHA1 Fingerprint: 1f:49:14:f7:d8:74:95:1d:dd:ae:02:c0:be:fd:3a:2d:82:75:51:85 +# SHA256 Fingerprint: 18:f1:fc:7f:20:5d:f8:ad:dd:eb:7f:e0:07:dd:57:e3:af:37:5a:9c:4d:8d:73:54:6b:f4:f1:fe:d1:e1:8d:35 +-----BEGIN CERTIFICATE----- +MIIGnTCCBIWgAwIBAgICBcYwDQYJKoZIhvcNAQEFBQAwRTELMAkGA1UEBhMCQk0x +GTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxGzAZBgNVBAMTElF1b1ZhZGlzIFJv +b3QgQ0EgMzAeFw0wNjExMjQxOTExMjNaFw0zMTExMjQxOTA2NDRaMEUxCzAJBgNV +BAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBMaW1pdGVkMRswGQYDVQQDExJRdW9W +YWRpcyBSb290IENBIDMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDM +V0IWVJzmmNPTTe7+7cefQzlKZbPoFog02w1ZkXTPkrgEQK0CSzGrvI2RaNggDhoB +4hp7Thdd4oq3P5kazethq8Jlph+3t723j/z9cI8LoGe+AaJZz3HmDyl2/7FWeUUr +H556VOijKTVopAFPD6QuN+8bv+OPEKhyq1hX51SGyMnzW9os2l2ObjyjPtr7guXd +8lyyBTNvijbO0BNO/79KDDRMpsMhvVAEVeuxu537RR5kFd5VAYwCdrXLoT9Cabwv +vWhDFlaJKjdhkf2mrk7AyxRllDdLkgbvBNDInIjbC3uBr7E9KsRlOni27tyAsdLT +mZw67mtaa7ONt9XOnMK+pUsvFrGeaDsGb659n/je7Mwpp5ijJUMv7/FfJuGITfhe +btfZFG4ZM2mnO4SJk8RTVROhUXhA+LjJou57ulJCg54U7QVSWllWp5f8nT8KKdjc +T5EOE7zelaTfi5m+rJsziO+1ga8bxiJTyPbH7pcUsMV8eFLI8M5ud2CEpukqdiDt +WAEXMJPpGovgc2PZapKUSU60rUqFxKMiMPwJ7Wgic6aIDFUhWMXhOp8q3crhkODZ +c6tsgLjoC2SToJyMGf+z0gzskSaHirOi4XCPLArlzW1oUevaPwV/izLmE1xr/l9A +4iLItLRkT9a6fUg+qGkM17uGcclzuD87nSVL2v9A6wIDAQABo4IBlTCCAZEwDwYD +VR0TAQH/BAUwAwEB/zCB4QYDVR0gBIHZMIHWMIHTBgkrBgEEAb5YAAMwgcUwgZMG +CCsGAQUFBwICMIGGGoGDQW55IHVzZSBvZiB0aGlzIENlcnRpZmljYXRlIGNvbnN0 +aXR1dGVzIGFjY2VwdGFuY2Ugb2YgdGhlIFF1b1ZhZGlzIFJvb3QgQ0EgMyBDZXJ0 +aWZpY2F0ZSBQb2xpY3kgLyBDZXJ0aWZpY2F0aW9uIFByYWN0aWNlIFN0YXRlbWVu +dC4wLQYIKwYBBQUHAgEWIWh0dHA6Ly93d3cucXVvdmFkaXNnbG9iYWwuY29tL2Nw +czALBgNVHQ8EBAMCAQYwHQYDVR0OBBYEFPLAE+CCQz777i9nMpY1XNu4ywLQMG4G +A1UdIwRnMGWAFPLAE+CCQz777i9nMpY1XNu4ywLQoUmkRzBFMQswCQYDVQQGEwJC +TTEZMBcGA1UEChMQUXVvVmFkaXMgTGltaXRlZDEbMBkGA1UEAxMSUXVvVmFkaXMg +Um9vdCBDQSAzggIFxjANBgkqhkiG9w0BAQUFAAOCAgEAT62gLEz6wPJv92ZVqyM0 +7ucp2sNbtrCD2dDQ4iH782CnO11gUyeim/YIIirnv6By5ZwkajGxkHon24QRiSem +d1o417+shvzuXYO8BsbRd2sPbSQvS3pspweWyuOEn62Iix2rFo1bZhfZFvSLgNLd ++LJ2w/w4E6oM3kJpK27zPOuAJ9v1pkQNn1pVWQvVDVJIxa6f8i+AxeoyUDUSly7B +4f/xI4hROJ/yZlZ25w9Rl6VSDE1JUZU2Pb+iSwwQHYaZTKrzchGT5Or2m9qoXadN +t54CrnMAyNojA+j56hl0YgCUyyIgvpSnWbWCar6ZeXqp8kokUvd0/bpO5qgdAm6x +DYBEwa7TIzdfu4V8K5Iu6H6li92Z4b8nby1dqnuH/grdS/yO9SbkbnBCbjPsMZ57 +k8HkyWkaPcBrTiJt7qtYTcbQQcEr6k8Sh17rRdhs9ZgC06DYVYoGmRmioHfRMJ6s +zHXug/WwYjnPbFfiTNKRCw51KBuav/0aQ/HKd/s7j2G4aSgWQgRecCocIdiP4b0j +Wy10QJLZYxkNc91pvGJHvOB0K7Lrfb5BG7XARsWhIstfTsEokt4YutUqKLsRixeT +mJlglFwjz1onl14LBQaTNx47aTbrqZ5hHY8y2o4M1nQ+ewkk2gF3R8Q7zTSMmfXK +4SVhM7JZG+Ju1zdXtg2pEto= +-----END CERTIFICATE----- + +# Issuer: O=SECOM Trust.net OU=Security Communication RootCA1 +# Subject: O=SECOM Trust.net OU=Security Communication RootCA1 +# Label: "Security Communication Root CA" +# Serial: 0 +# MD5 Fingerprint: f1:bc:63:6a:54:e0:b5:27:f5:cd:e7:1a:e3:4d:6e:4a +# SHA1 Fingerprint: 36:b1:2b:49:f9:81:9e:d7:4c:9e:bc:38:0f:c6:56:8f:5d:ac:b2:f7 +# SHA256 Fingerprint: e7:5e:72:ed:9f:56:0e:ec:6e:b4:80:00:73:a4:3f:c3:ad:19:19:5a:39:22:82:01:78:95:97:4a:99:02:6b:6c +-----BEGIN CERTIFICATE----- +MIIDWjCCAkKgAwIBAgIBADANBgkqhkiG9w0BAQUFADBQMQswCQYDVQQGEwJKUDEY +MBYGA1UEChMPU0VDT00gVHJ1c3QubmV0MScwJQYDVQQLEx5TZWN1cml0eSBDb21t +dW5pY2F0aW9uIFJvb3RDQTEwHhcNMDMwOTMwMDQyMDQ5WhcNMjMwOTMwMDQyMDQ5 +WjBQMQswCQYDVQQGEwJKUDEYMBYGA1UEChMPU0VDT00gVHJ1c3QubmV0MScwJQYD +VQQLEx5TZWN1cml0eSBDb21tdW5pY2F0aW9uIFJvb3RDQTEwggEiMA0GCSqGSIb3 +DQEBAQUAA4IBDwAwggEKAoIBAQCzs/5/022x7xZ8V6UMbXaKL0u/ZPtM7orw8yl8 +9f/uKuDp6bpbZCKamm8sOiZpUQWZJtzVHGpxxpp9Hp3dfGzGjGdnSj74cbAZJ6kJ +DKaVv0uMDPpVmDvY6CKhS3E4eayXkmmziX7qIWgGmBSWh9JhNrxtJ1aeV+7AwFb9 +Ms+k2Y7CI9eNqPPYJayX5HA49LY6tJ07lyZDo6G8SVlyTCMwhwFY9k6+HGhWZq/N +QV3Is00qVUarH9oe4kA92819uZKAnDfdDJZkndwi92SL32HeFZRSFaB9UslLqCHJ +xrHty8OVYNEP8Ktw+N/LTX7s1vqr2b1/VPKl6Xn62dZ2JChzAgMBAAGjPzA9MB0G +A1UdDgQWBBSgc0mZaNyFW2XjmygvV5+9M7wHSDALBgNVHQ8EBAMCAQYwDwYDVR0T +AQH/BAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEAaECpqLvkT115swW1F7NgE+vG +kl3g0dNq/vu+m22/xwVtWSDEHPC32oRYAmP6SBbvT6UL90qY8j+eG61Ha2POCEfr +Uj94nK9NrvjVT8+amCoQQTlSxN3Zmw7vkwGusi7KaEIkQmywszo+zenaSMQVy+n5 +Bw+SUEmK3TGXX8npN6o7WWWXlDLJs58+OmJYxUmtYg5xpTKqL8aJdkNAExNnPaJU +JRDL8Try2frbSVa7pv6nQTXD4IhhyYjH3zYQIphZ6rBK+1YWc26sTfcioU+tHXot +RSflMMFe8toTyyVCUZVHA4xsIcx0Qu1T/zOLjw9XARYvz6buyXAiFL39vmwLAw== +-----END CERTIFICATE----- + +# Issuer: CN=Sonera Class2 CA O=Sonera +# Subject: CN=Sonera Class2 CA O=Sonera +# Label: "Sonera Class 2 Root CA" +# Serial: 29 +# MD5 Fingerprint: a3:ec:75:0f:2e:88:df:fa:48:01:4e:0b:5c:48:6f:fb +# SHA1 Fingerprint: 37:f7:6d:e6:07:7c:90:c5:b1:3e:93:1a:b7:41:10:b4:f2:e4:9a:27 +# SHA256 Fingerprint: 79:08:b4:03:14:c1:38:10:0b:51:8d:07:35:80:7f:fb:fc:f8:51:8a:00:95:33:71:05:ba:38:6b:15:3d:d9:27 +-----BEGIN CERTIFICATE----- +MIIDIDCCAgigAwIBAgIBHTANBgkqhkiG9w0BAQUFADA5MQswCQYDVQQGEwJGSTEP +MA0GA1UEChMGU29uZXJhMRkwFwYDVQQDExBTb25lcmEgQ2xhc3MyIENBMB4XDTAx +MDQwNjA3Mjk0MFoXDTIxMDQwNjA3Mjk0MFowOTELMAkGA1UEBhMCRkkxDzANBgNV +BAoTBlNvbmVyYTEZMBcGA1UEAxMQU29uZXJhIENsYXNzMiBDQTCCASIwDQYJKoZI +hvcNAQEBBQADggEPADCCAQoCggEBAJAXSjWdyvANlsdE+hY3/Ei9vX+ALTU74W+o +Z6m/AxxNjG8yR9VBaKQTBME1DJqEQ/xcHf+Js+gXGM2RX/uJ4+q/Tl18GybTdXnt +5oTjV+WtKcT0OijnpXuENmmz/V52vaMtmdOQTiMofRhj8VQ7Jp12W5dCsv+u8E7s +3TmVToMGf+dJQMjFAbJUWmYdPfz56TwKnoG4cPABi+QjVHzIrviQHgCWctRUz2Ej +vOr7nQKV0ba5cTppCD8PtOFCx4j1P5iop7oc4HFx71hXgVB6XGt0Rg6DA5jDjqhu +8nYybieDwnPz3BjotJPqdURrBGAgcVeHnfO+oJAjPYok4doh28MCAwEAAaMzMDEw +DwYDVR0TAQH/BAUwAwEB/zARBgNVHQ4ECgQISqCqWITTXjwwCwYDVR0PBAQDAgEG +MA0GCSqGSIb3DQEBBQUAA4IBAQBazof5FnIVV0sd2ZvnoiYw7JNn39Yt0jSv9zil +zqsWuasvfDXLrNAPtEwr/IDva4yRXzZ299uzGxnq9LIR/WFxRL8oszodv7ND6J+/ +3DEIcbCdjdY0RzKQxmUk96BKfARzjzlvF4xytb1LyHr4e4PDKE6cCepnP7JnBBvD +FNr450kkkdAdavphOe9r5yF1BgfYErQhIHBCcYHaPJo2vqZbDWpsmh+Re/n570K6 +Tk6ezAyNlNzZRZxe7EJQY670XcSxEtzKO6gunRRaBXW37Ndj4ro1tgQIkejanZz2 +ZrUYrAqmVCY0M9IbwdR/GjqOC6oybtv8TyWf2TLHllpwrN9M +-----END CERTIFICATE----- + +# Issuer: CN=XRamp Global Certification Authority O=XRamp Security Services Inc OU=www.xrampsecurity.com +# Subject: CN=XRamp Global Certification Authority O=XRamp Security Services Inc OU=www.xrampsecurity.com +# Label: "XRamp Global CA Root" +# Serial: 107108908803651509692980124233745014957 +# MD5 Fingerprint: a1:0b:44:b3:ca:10:d8:00:6e:9d:0f:d8:0f:92:0a:d1 +# SHA1 Fingerprint: b8:01:86:d1:eb:9c:86:a5:41:04:cf:30:54:f3:4c:52:b7:e5:58:c6 +# SHA256 Fingerprint: ce:cd:dc:90:50:99:d8:da:df:c5:b1:d2:09:b7:37:cb:e2:c1:8c:fb:2c:10:c0:ff:0b:cf:0d:32:86:fc:1a:a2 +-----BEGIN CERTIFICATE----- +MIIEMDCCAxigAwIBAgIQUJRs7Bjq1ZxN1ZfvdY+grTANBgkqhkiG9w0BAQUFADCB +gjELMAkGA1UEBhMCVVMxHjAcBgNVBAsTFXd3dy54cmFtcHNlY3VyaXR5LmNvbTEk +MCIGA1UEChMbWFJhbXAgU2VjdXJpdHkgU2VydmljZXMgSW5jMS0wKwYDVQQDEyRY +UmFtcCBHbG9iYWwgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMDQxMTAxMTcx +NDA0WhcNMzUwMTAxMDUzNzE5WjCBgjELMAkGA1UEBhMCVVMxHjAcBgNVBAsTFXd3 +dy54cmFtcHNlY3VyaXR5LmNvbTEkMCIGA1UEChMbWFJhbXAgU2VjdXJpdHkgU2Vy +dmljZXMgSW5jMS0wKwYDVQQDEyRYUmFtcCBHbG9iYWwgQ2VydGlmaWNhdGlvbiBB +dXRob3JpdHkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCYJB69FbS6 +38eMpSe2OAtp87ZOqCwuIR1cRN8hXX4jdP5efrRKt6atH67gBhbim1vZZ3RrXYCP +KZ2GG9mcDZhtdhAoWORlsH9KmHmf4MMxfoArtYzAQDsRhtDLooY2YKTVMIJt2W7Q +DxIEM5dfT2Fa8OT5kavnHTu86M/0ay00fOJIYRyO82FEzG+gSqmUsE3a56k0enI4 +qEHMPJQRfevIpoy3hsvKMzvZPTeL+3o+hiznc9cKV6xkmxnr9A8ECIqsAxcZZPRa +JSKNNCyy9mgdEm3Tih4U2sSPpuIjhdV6Db1q4Ons7Be7QhtnqiXtRYMh/MHJfNVi +PvryxS3T/dRlAgMBAAGjgZ8wgZwwEwYJKwYBBAGCNxQCBAYeBABDAEEwCwYDVR0P +BAQDAgGGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMZPoj0GY4QJnM5i5ASs +jVy16bYbMDYGA1UdHwQvMC0wK6ApoCeGJWh0dHA6Ly9jcmwueHJhbXBzZWN1cml0 +eS5jb20vWEdDQS5jcmwwEAYJKwYBBAGCNxUBBAMCAQEwDQYJKoZIhvcNAQEFBQAD +ggEBAJEVOQMBG2f7Shz5CmBbodpNl2L5JFMn14JkTpAuw0kbK5rc/Kh4ZzXxHfAR +vbdI4xD2Dd8/0sm2qlWkSLoC295ZLhVbO50WfUfXN+pfTXYSNrsf16GBBEYgoyxt +qZ4Bfj8pzgCT3/3JknOJiWSe5yvkHJEs0rnOfc5vMZnT5r7SHpDwCRR5XCOrTdLa +IR9NmXmd4c8nnxCbHIgNsIpkQTG4DmyQJKSbXHGPurt+HBvbaoAPIbzp26a3QPSy +i6mx5O+aGtA9aZnuqCij4Tyz8LIRnM98QObd50N9otg6tamN8jSZxNQQ4Qb9CYQQ +O+7ETPTsJ3xCwnR8gooJybQDJbw= +-----END CERTIFICATE----- + +# Issuer: O=The Go Daddy Group, Inc. OU=Go Daddy Class 2 Certification Authority +# Subject: O=The Go Daddy Group, Inc. OU=Go Daddy Class 2 Certification Authority +# Label: "Go Daddy Class 2 CA" +# Serial: 0 +# MD5 Fingerprint: 91:de:06:25:ab:da:fd:32:17:0c:bb:25:17:2a:84:67 +# SHA1 Fingerprint: 27:96:ba:e6:3f:18:01:e2:77:26:1b:a0:d7:77:70:02:8f:20:ee:e4 +# SHA256 Fingerprint: c3:84:6b:f2:4b:9e:93:ca:64:27:4c:0e:c6:7c:1e:cc:5e:02:4f:fc:ac:d2:d7:40:19:35:0e:81:fe:54:6a:e4 +-----BEGIN CERTIFICATE----- +MIIEADCCAuigAwIBAgIBADANBgkqhkiG9w0BAQUFADBjMQswCQYDVQQGEwJVUzEh +MB8GA1UEChMYVGhlIEdvIERhZGR5IEdyb3VwLCBJbmMuMTEwLwYDVQQLEyhHbyBE +YWRkeSBDbGFzcyAyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTA0MDYyOTE3 +MDYyMFoXDTM0MDYyOTE3MDYyMFowYzELMAkGA1UEBhMCVVMxITAfBgNVBAoTGFRo +ZSBHbyBEYWRkeSBHcm91cCwgSW5jLjExMC8GA1UECxMoR28gRGFkZHkgQ2xhc3Mg +MiBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTCCASAwDQYJKoZIhvcNAQEBBQADggEN +ADCCAQgCggEBAN6d1+pXGEmhW+vXX0iG6r7d/+TvZxz0ZWizV3GgXne77ZtJ6XCA +PVYYYwhv2vLM0D9/AlQiVBDYsoHUwHU9S3/Hd8M+eKsaA7Ugay9qK7HFiH7Eux6w +wdhFJ2+qN1j3hybX2C32qRe3H3I2TqYXP2WYktsqbl2i/ojgC95/5Y0V4evLOtXi +EqITLdiOr18SPaAIBQi2XKVlOARFmR6jYGB0xUGlcmIbYsUfb18aQr4CUWWoriMY +avx4A6lNf4DD+qta/KFApMoZFv6yyO9ecw3ud72a9nmYvLEHZ6IVDd2gWMZEewo+ +YihfukEHU1jPEX44dMX4/7VpkI+EdOqXG68CAQOjgcAwgb0wHQYDVR0OBBYEFNLE +sNKR1EwRcbNhyz2h/t2oatTjMIGNBgNVHSMEgYUwgYKAFNLEsNKR1EwRcbNhyz2h +/t2oatTjoWekZTBjMQswCQYDVQQGEwJVUzEhMB8GA1UEChMYVGhlIEdvIERhZGR5 +IEdyb3VwLCBJbmMuMTEwLwYDVQQLEyhHbyBEYWRkeSBDbGFzcyAyIENlcnRpZmlj +YXRpb24gQXV0aG9yaXR5ggEAMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQAD +ggEBADJL87LKPpH8EsahB4yOd6AzBhRckB4Y9wimPQoZ+YeAEW5p5JYXMP80kWNy +OO7MHAGjHZQopDH2esRU1/blMVgDoszOYtuURXO1v0XJJLXVggKtI3lpjbi2Tc7P +TMozI+gciKqdi0FuFskg5YmezTvacPd+mSYgFFQlq25zheabIZ0KbIIOqPjCDPoQ +HmyW74cNxA9hi63ugyuV+I6ShHI56yDqg+2DzZduCLzrTia2cyvk0/ZM/iZx4mER +dEr/VxqHD3VILs9RaRegAhJhldXRQLIQTO7ErBBDpqWeCtWVYpoNz4iCxTIM5Cuf +ReYNnyicsbkqWletNw+vHX/bvZ8= +-----END CERTIFICATE----- + +# Issuer: O=Starfield Technologies, Inc. OU=Starfield Class 2 Certification Authority +# Subject: O=Starfield Technologies, Inc. OU=Starfield Class 2 Certification Authority +# Label: "Starfield Class 2 CA" +# Serial: 0 +# MD5 Fingerprint: 32:4a:4b:bb:c8:63:69:9b:be:74:9a:c6:dd:1d:46:24 +# SHA1 Fingerprint: ad:7e:1c:28:b0:64:ef:8f:60:03:40:20:14:c3:d0:e3:37:0e:b5:8a +# SHA256 Fingerprint: 14:65:fa:20:53:97:b8:76:fa:a6:f0:a9:95:8e:55:90:e4:0f:cc:7f:aa:4f:b7:c2:c8:67:75:21:fb:5f:b6:58 +-----BEGIN CERTIFICATE----- +MIIEDzCCAvegAwIBAgIBADANBgkqhkiG9w0BAQUFADBoMQswCQYDVQQGEwJVUzEl +MCMGA1UEChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjEyMDAGA1UECxMp +U3RhcmZpZWxkIENsYXNzIDIgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMDQw +NjI5MTczOTE2WhcNMzQwNjI5MTczOTE2WjBoMQswCQYDVQQGEwJVUzElMCMGA1UE +ChMcU3RhcmZpZWxkIFRlY2hub2xvZ2llcywgSW5jLjEyMDAGA1UECxMpU3RhcmZp +ZWxkIENsYXNzIDIgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwggEgMA0GCSqGSIb3 +DQEBAQUAA4IBDQAwggEIAoIBAQC3Msj+6XGmBIWtDBFk385N78gDGIc/oav7PKaf +8MOh2tTYbitTkPskpD6E8J7oX+zlJ0T1KKY/e97gKvDIr1MvnsoFAZMej2YcOadN ++lq2cwQlZut3f+dZxkqZJRRU6ybH838Z1TBwj6+wRir/resp7defqgSHo9T5iaU0 +X9tDkYI22WY8sbi5gv2cOj4QyDvvBmVmepsZGD3/cVE8MC5fvj13c7JdBmzDI1aa +K4UmkhynArPkPw2vCHmCuDY96pzTNbO8acr1zJ3o/WSNF4Azbl5KXZnJHoe0nRrA +1W4TNSNe35tfPe/W93bC6j67eA0cQmdrBNj41tpvi/JEoAGrAgEDo4HFMIHCMB0G +A1UdDgQWBBS/X7fRzt0fhvRbVazc1xDCDqmI5zCBkgYDVR0jBIGKMIGHgBS/X7fR +zt0fhvRbVazc1xDCDqmI56FspGowaDELMAkGA1UEBhMCVVMxJTAjBgNVBAoTHFN0 +YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xMjAwBgNVBAsTKVN0YXJmaWVsZCBD +bGFzcyAyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5ggEAMAwGA1UdEwQFMAMBAf8w +DQYJKoZIhvcNAQEFBQADggEBAAWdP4id0ckaVaGsafPzWdqbAYcaT1epoXkJKtv3 +L7IezMdeatiDh6GX70k1PncGQVhiv45YuApnP+yz3SFmH8lU+nLMPUxA2IGvd56D +eruix/U0F47ZEUD0/CwqTRV/p2JdLiXTAAsgGh1o+Re49L2L7ShZ3U0WixeDyLJl +xy16paq8U4Zt3VekyvggQQto8PT7dL5WXXp59fkdheMtlb71cZBDzI0fmgAKhynp +VSJYACPq4xJDKVtHCN2MQWplBqjlIapBtJUhlbl90TSrE9atvNziPTnNvT51cKEY +WQPJIrSPnNVeKtelttQKbfi3QBFGmh95DmK/D5fs4C8fF5Q= +-----END CERTIFICATE----- + +# Issuer: O=Government Root Certification Authority +# Subject: O=Government Root Certification Authority +# Label: "Taiwan GRCA" +# Serial: 42023070807708724159991140556527066870 +# MD5 Fingerprint: 37:85:44:53:32:45:1f:20:f0:f3:95:e1:25:c4:43:4e +# SHA1 Fingerprint: f4:8b:11:bf:de:ab:be:94:54:20:71:e6:41:de:6b:be:88:2b:40:b9 +# SHA256 Fingerprint: 76:00:29:5e:ef:e8:5b:9e:1f:d6:24:db:76:06:2a:aa:ae:59:81:8a:54:d2:77:4c:d4:c0:b2:c0:11:31:e1:b3 +-----BEGIN CERTIFICATE----- +MIIFcjCCA1qgAwIBAgIQH51ZWtcvwgZEpYAIaeNe9jANBgkqhkiG9w0BAQUFADA/ +MQswCQYDVQQGEwJUVzEwMC4GA1UECgwnR292ZXJubWVudCBSb290IENlcnRpZmlj +YXRpb24gQXV0aG9yaXR5MB4XDTAyMTIwNTEzMjMzM1oXDTMyMTIwNTEzMjMzM1ow +PzELMAkGA1UEBhMCVFcxMDAuBgNVBAoMJ0dvdmVybm1lbnQgUm9vdCBDZXJ0aWZp +Y2F0aW9uIEF1dGhvcml0eTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIB +AJoluOzMonWoe/fOW1mKydGGEghU7Jzy50b2iPN86aXfTEc2pBsBHH8eV4qNw8XR +IePaJD9IK/ufLqGU5ywck9G/GwGHU5nOp/UKIXZ3/6m3xnOUT0b3EEk3+qhZSV1q +gQdW8or5BtD3cCJNtLdBuTK4sfCxw5w/cP1T3YGq2GN49thTbqGsaoQkclSGxtKy +yhwOeYHWtXBiCAEuTk8O1RGvqa/lmr/czIdtJuTJV6L7lvnM4T9TjGxMfptTCAts +F/tnyMKtsc2AtJfcdgEWFelq16TheEfOhtX7MfP6Mb40qij7cEwdScevLJ1tZqa2 +jWR+tSBqnTuBto9AAGdLiYa4zGX+FVPpBMHWXx1E1wovJ5pGfaENda1UhhXcSTvx +ls4Pm6Dso3pdvtUqdULle96ltqqvKKyskKw4t9VoNSZ63Pc78/1Fm9G7Q3hub/FC +VGqY8A2tl+lSXunVanLeavcbYBT0peS2cWeqH+riTcFCQP5nRhc4L0c/cZyu5SHK +YS1tB6iEfC3uUSXxY5Ce/eFXiGvviiNtsea9P63RPZYLhY3Naye7twWb7LuRqQoH +EgKXTiCQ8P8NHuJBO9NAOueNXdpm5AKwB1KYXA6OM5zCppX7VRluTI6uSw+9wThN +Xo+EHWbNxWCWtFJaBYmOlXqYwZE8lSOyDvR5tMl8wUohAgMBAAGjajBoMB0GA1Ud +DgQWBBTMzO/MKWCkO7GStjz6MmKPrCUVOzAMBgNVHRMEBTADAQH/MDkGBGcqBwAE +MTAvMC0CAQAwCQYFKw4DAhoFADAHBgVnKgMAAAQUA5vwIhP/lSg209yewDL7MTqK +UWUwDQYJKoZIhvcNAQEFBQADggIBAECASvomyc5eMN1PhnR2WPWus4MzeKR6dBcZ +TulStbngCnRiqmjKeKBMmo4sIy7VahIkv9Ro04rQ2JyftB8M3jh+Vzj8jeJPXgyf +qzvS/3WXy6TjZwj/5cAWtUgBfen5Cv8b5Wppv3ghqMKnI6mGq3ZW6A4M9hPdKmaK +ZEk9GhiHkASfQlK3T8v+R0F2Ne//AHY2RTKbxkaFXeIksB7jSJaYV0eUVXoPQbFE +JPPB/hprv4j9wabak2BegUqZIJxIZhm1AHlUD7gsL0u8qV1bYH+Mh6XgUmMqvtg7 +hUAV/h62ZT/FS9p+tXo1KaMuephgIqP0fSdOLeq0dDzpD6QzDxARvBMB1uUO07+1 +EqLhRSPAzAhuYbeJq4PjJB7mXQfnHyA+z2fI56wwbSdLaG5LKlwCCDTb+HbkZ6Mm +nD+iMsJKxYEYMRBWqoTvLQr/uB930r+lWKBi5NdLkXWNiYCYfm3LU05er/ayl4WX +udpVBrkk7tfGOB5jGxI7leFYrPLfhNVfmS8NVVvmONsuP3LpSIXLuykTjx44Vbnz +ssQwmSNOXfJIoRIM3BKQCZBUkQM8R+XVyWXgt0t97EfTsws+rZ7QdAAO671RrcDe +LMDDav7v3Aun+kbfYNucpllQdSNpc5Oy+fwC00fmcc4QAu4njIT/rEUNE1yDMuAl +pYYsfPQS +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Assured ID Root CA O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Assured ID Root CA O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Assured ID Root CA" +# Serial: 17154717934120587862167794914071425081 +# MD5 Fingerprint: 87:ce:0b:7b:2a:0e:49:00:e1:58:71:9b:37:a8:93:72 +# SHA1 Fingerprint: 05:63:b8:63:0d:62:d7:5a:bb:c8:ab:1e:4b:df:b5:a8:99:b2:4d:43 +# SHA256 Fingerprint: 3e:90:99:b5:01:5e:8f:48:6c:00:bc:ea:9d:11:1e:e7:21:fa:ba:35:5a:89:bc:f1:df:69:56:1e:3d:c6:32:5c +-----BEGIN CERTIFICATE----- +MIIDtzCCAp+gAwIBAgIQDOfg5RfYRv6P5WD8G/AwOTANBgkqhkiG9w0BAQUFADBl +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJv +b3QgQ0EwHhcNMDYxMTEwMDAwMDAwWhcNMzExMTEwMDAwMDAwWjBlMQswCQYDVQQG +EwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNl +cnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3QgQ0EwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCtDhXO5EOAXLGH87dg+XESpa7c +JpSIqvTO9SA5KFhgDPiA2qkVlTJhPLWxKISKityfCgyDF3qPkKyK53lTXDGEKvYP +mDI2dsze3Tyoou9q+yHyUmHfnyDXH+Kx2f4YZNISW1/5WBg1vEfNoTb5a3/UsDg+ +wRvDjDPZ2C8Y/igPs6eD1sNuRMBhNZYW/lmci3Zt1/GiSw0r/wty2p5g0I6QNcZ4 +VYcgoc/lbQrISXwxmDNsIumH0DJaoroTghHtORedmTpyoeb6pNnVFzF1roV9Iq4/ +AUaG9ih5yLHa5FcXxH4cDrC0kqZWs72yl+2qp/C3xag/lRbQ/6GW6whfGHdPAgMB +AAGjYzBhMA4GA1UdDwEB/wQEAwIBhjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQW +BBRF66Kv9JLLgjEtUYunpyGd823IDzAfBgNVHSMEGDAWgBRF66Kv9JLLgjEtUYun +pyGd823IDzANBgkqhkiG9w0BAQUFAAOCAQEAog683+Lt8ONyc3pklL/3cmbYMuRC +dWKuh+vy1dneVrOfzM4UKLkNl2BcEkxY5NM9g0lFWJc1aRqoR+pWxnmrEthngYTf +fwk8lOa4JiwgvT2zKIn3X/8i4peEH+ll74fg38FnSbNd67IJKusm7Xi+fT8r87cm +NW1fiQG2SVufAQWbqz0lwcy2f8Lxb4bG+mRo64EtlOtCt/qMHt1i8b5QZ7dsvfPx +H2sMNgcWfzd8qVttevESRmCD1ycEvkvOl77DZypoEd+A5wwzZr8TDRRu838fYxAe ++o0bJW1sj6W3YQGx0qMmoRBxna3iw/nDmVG3KwcIzi7mULKn+gpFL6Lw8g== +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Global Root CA O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Global Root CA O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Global Root CA" +# Serial: 10944719598952040374951832963794454346 +# MD5 Fingerprint: 79:e4:a9:84:0d:7d:3a:96:d7:c0:4f:e2:43:4c:89:2e +# SHA1 Fingerprint: a8:98:5d:3a:65:e5:e5:c4:b2:d7:d6:6d:40:c6:dd:2f:b1:9c:54:36 +# SHA256 Fingerprint: 43:48:a0:e9:44:4c:78:cb:26:5e:05:8d:5e:89:44:b4:d8:4f:96:62:bd:26:db:25:7f:89:34:a4:43:c7:01:61 +-----BEGIN CERTIFICATE----- +MIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD +QTAeFw0wNjExMTAwMDAwMDBaFw0zMTExMTAwMDAwMDBaMGExCzAJBgNVBAYTAlVT +MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j +b20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IENBMIIBIjANBgkqhkiG +9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4jvhEXLeqKTTo1eqUKKPC3eQyaKl7hLOllsB +CSDMAZOnTjC3U/dDxGkAV53ijSLdhwZAAIEJzs4bg7/fzTtxRuLWZscFs3YnFo97 +nh6Vfe63SKMI2tavegw5BmV/Sl0fvBf4q77uKNd0f3p4mVmFaG5cIzJLv07A6Fpt +43C/dxC//AH2hdmoRBBYMql1GNXRor5H4idq9Joz+EkIYIvUX7Q6hL+hqkpMfT7P +T19sdl6gSzeRntwi5m3OFBqOasv+zbMUZBfHWymeMr/y7vrTC0LUq7dBMtoM1O/4 +gdW7jVg/tRvoSSiicNoxBN33shbyTApOB6jtSj1etX+jkMOvJwIDAQABo2MwYTAO +BgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUA95QNVbR +TLtm8KPiGxvDl7I90VUwHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUw +DQYJKoZIhvcNAQEFBQADggEBAMucN6pIExIK+t1EnE9SsPTfrgT1eXkIoyQY/Esr +hMAtudXH/vTBH1jLuG2cenTnmCmrEbXjcKChzUyImZOMkXDiqw8cvpOp/2PV5Adg +06O/nVsJ8dWO41P0jmP6P6fbtGbfYmbW0W5BjfIttep3Sp+dWOIrWcBAI+0tKIJF +PnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0ls +YSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQk +CAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4= +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert High Assurance EV Root CA O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert High Assurance EV Root CA O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert High Assurance EV Root CA" +# Serial: 3553400076410547919724730734378100087 +# MD5 Fingerprint: d4:74:de:57:5c:39:b2:d3:9c:85:83:c5:c0:65:49:8a +# SHA1 Fingerprint: 5f:b7:ee:06:33:e2:59:db:ad:0c:4c:9a:e6:d3:8f:1a:61:c7:dc:25 +# SHA256 Fingerprint: 74:31:e5:f4:c3:c1:ce:46:90:77:4f:0b:61:e0:54:40:88:3b:a9:a0:1e:d0:0b:a6:ab:d7:80:6e:d3:b1:18:cf +-----BEGIN CERTIFICATE----- +MIIDxTCCAq2gAwIBAgIQAqxcJmoLQJuPC3nyrkYldzANBgkqhkiG9w0BAQUFADBs +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSswKQYDVQQDEyJEaWdpQ2VydCBIaWdoIEFzc3VyYW5j +ZSBFViBSb290IENBMB4XDTA2MTExMDAwMDAwMFoXDTMxMTExMDAwMDAwMFowbDEL +MAkGA1UEBhMCVVMxFTATBgNVBAoTDERpZ2lDZXJ0IEluYzEZMBcGA1UECxMQd3d3 +LmRpZ2ljZXJ0LmNvbTErMCkGA1UEAxMiRGlnaUNlcnQgSGlnaCBBc3N1cmFuY2Ug +RVYgUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMbM5XPm ++9S75S0tMqbf5YE/yc0lSbZxKsPVlDRnogocsF9ppkCxxLeyj9CYpKlBWTrT3JTW +PNt0OKRKzE0lgvdKpVMSOO7zSW1xkX5jtqumX8OkhPhPYlG++MXs2ziS4wblCJEM +xChBVfvLWokVfnHoNb9Ncgk9vjo4UFt3MRuNs8ckRZqnrG0AFFoEt7oT61EKmEFB +Ik5lYYeBQVCmeVyJ3hlKV9Uu5l0cUyx+mM0aBhakaHPQNAQTXKFx01p8VdteZOE3 +hzBWBOURtCmAEvF5OYiiAhF8J2a3iLd48soKqDirCmTCv2ZdlYTBoSUeh10aUAsg +EsxBu24LUTi4S8sCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgGGMA8GA1UdEwEB/wQF +MAMBAf8wHQYDVR0OBBYEFLE+w2kD+L9HAdSYJhoIAu9jZCvDMB8GA1UdIwQYMBaA +FLE+w2kD+L9HAdSYJhoIAu9jZCvDMA0GCSqGSIb3DQEBBQUAA4IBAQAcGgaX3Nec +nzyIZgYIVyHbIUf4KmeqvxgydkAQV8GK83rZEWWONfqe/EW1ntlMMUu4kehDLI6z +eM7b41N5cdblIZQB2lWHmiRk9opmzN6cN82oNLFpmyPInngiK3BD41VHMWEZ71jF +hS9OMPagMRYjyOfiZRYzy78aG6A9+MpeizGLYAiJLQwGXFK3xPkKmNEVX58Svnw2 +Yzi9RKR/5CYrCsSXaQ3pjOLAEFe4yHYSkVXySGnYvCoCWw9E1CAx2/S6cCZdkGCe +vEsXCS+0yx5DaMkHJ8HSXPfqIbloEpw8nL+e/IBcm2PN7EeqJSdnoDfzAIJ9VNep ++OkuE6N36B9K +-----END CERTIFICATE----- + +# Issuer: CN=Class 2 Primary CA O=Certplus +# Subject: CN=Class 2 Primary CA O=Certplus +# Label: "Certplus Class 2 Primary CA" +# Serial: 177770208045934040241468760488327595043 +# MD5 Fingerprint: 88:2c:8c:52:b8:a2:3c:f3:f7:bb:03:ea:ae:ac:42:0b +# SHA1 Fingerprint: 74:20:74:41:72:9c:dd:92:ec:79:31:d8:23:10:8d:c2:81:92:e2:bb +# SHA256 Fingerprint: 0f:99:3c:8a:ef:97:ba:af:56:87:14:0e:d5:9a:d1:82:1b:b4:af:ac:f0:aa:9a:58:b5:d5:7a:33:8a:3a:fb:cb +-----BEGIN CERTIFICATE----- +MIIDkjCCAnqgAwIBAgIRAIW9S/PY2uNp9pTXX8OlRCMwDQYJKoZIhvcNAQEFBQAw +PTELMAkGA1UEBhMCRlIxETAPBgNVBAoTCENlcnRwbHVzMRswGQYDVQQDExJDbGFz +cyAyIFByaW1hcnkgQ0EwHhcNOTkwNzA3MTcwNTAwWhcNMTkwNzA2MjM1OTU5WjA9 +MQswCQYDVQQGEwJGUjERMA8GA1UEChMIQ2VydHBsdXMxGzAZBgNVBAMTEkNsYXNz +IDIgUHJpbWFyeSBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANxQ +ltAS+DXSCHh6tlJw/W/uz7kRy1134ezpfgSN1sxvc0NXYKwzCkTsA18cgCSR5aiR +VhKC9+Ar9NuuYS6JEI1rbLqzAr3VNsVINyPi8Fo3UjMXEuLRYE2+L0ER4/YXJQyL +kcAbmXuZVg2v7tK8R1fjeUl7NIknJITesezpWE7+Tt9avkGtrAjFGA7v0lPubNCd +EgETjdyAYveVqUSISnFOYFWe2yMZeVYHDD9jC1yw4r5+FfyUM1hBOHTE4Y+L3yas +H7WLO7dDWWuwJKZtkIvEcupdM5i3y95ee++U8Rs+yskhwcWYAqqi9lt3m/V+llU0 +HGdpwPFC40es/CgcZlUCAwEAAaOBjDCBiTAPBgNVHRMECDAGAQH/AgEKMAsGA1Ud +DwQEAwIBBjAdBgNVHQ4EFgQU43Mt38sOKAze3bOkynm4jrvoMIkwEQYJYIZIAYb4 +QgEBBAQDAgEGMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly93d3cuY2VydHBsdXMu +Y29tL0NSTC9jbGFzczIuY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQCnVM+IRBnL39R/ +AN9WM2K191EBkOvDP9GIROkkXe/nFL0gt5o8AP5tn9uQ3Nf0YtaLcF3n5QRIqWh8 +yfFC82x/xXp8HVGIutIKPidd3i1RTtMTZGnkLuPT55sJmabglZvOGtd/vjzOUrMR +FcEPF80Du5wlFbqidon8BvEY0JNLDnyCt6X09l/+7UCmnYR0ObncHoUW2ikbhiMA +ybuJfm6AiB4vFLQDJKgybwOaRywwvlbGp0ICcBvqQNi6BQNwB6SW//1IMwrh3KWB +kJtN3X3n57LNXMhqlfil9o3EXXgIvnsG1knPGTZQIy4I5p4FTUcY1Rbpsda2ENW7 +l7+ijrRU +-----END CERTIFICATE----- + +# Issuer: CN=DST Root CA X3 O=Digital Signature Trust Co. +# Subject: CN=DST Root CA X3 O=Digital Signature Trust Co. +# Label: "DST Root CA X3" +# Serial: 91299735575339953335919266965803778155 +# MD5 Fingerprint: 41:03:52:dc:0f:f7:50:1b:16:f0:02:8e:ba:6f:45:c5 +# SHA1 Fingerprint: da:c9:02:4f:54:d8:f6:df:94:93:5f:b1:73:26:38:ca:6a:d7:7c:13 +# SHA256 Fingerprint: 06:87:26:03:31:a7:24:03:d9:09:f1:05:e6:9b:cf:0d:32:e1:bd:24:93:ff:c6:d9:20:6d:11:bc:d6:77:07:39 +-----BEGIN CERTIFICATE----- +MIIDSjCCAjKgAwIBAgIQRK+wgNajJ7qJMDmGLvhAazANBgkqhkiG9w0BAQUFADA/ +MSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT +DkRTVCBSb290IENBIFgzMB4XDTAwMDkzMDIxMTIxOVoXDTIxMDkzMDE0MDExNVow +PzEkMCIGA1UEChMbRGlnaXRhbCBTaWduYXR1cmUgVHJ1c3QgQ28uMRcwFQYDVQQD +Ew5EU1QgUm9vdCBDQSBYMzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB +AN+v6ZdQCINXtMxiZfaQguzH0yxrMMpb7NnDfcdAwRgUi+DoM3ZJKuM/IUmTrE4O +rz5Iy2Xu/NMhD2XSKtkyj4zl93ewEnu1lcCJo6m67XMuegwGMoOifooUMM0RoOEq +OLl5CjH9UL2AZd+3UWODyOKIYepLYYHsUmu5ouJLGiifSKOeDNoJjj4XLh7dIN9b +xiqKqy69cK3FCxolkHRyxXtqqzTWMIn/5WgTe1QLyNau7Fqckh49ZLOMxt+/yUFw +7BZy1SbsOFU5Q9D8/RhcQPGX69Wam40dutolucbY38EVAjqr2m7xPi71XAicPNaD +aeQQmxkqtilX4+U9m5/wAl0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNV +HQ8BAf8EBAMCAQYwHQYDVR0OBBYEFMSnsaR7LHH62+FLkHX/xBVghYkQMA0GCSqG +SIb3DQEBBQUAA4IBAQCjGiybFwBcqR7uKGY3Or+Dxz9LwwmglSBd49lZRNI+DT69 +ikugdB/OEIKcdBodfpga3csTS7MgROSR6cz8faXbauX+5v3gTt23ADq1cEmv8uXr +AvHRAosZy5Q6XkjEGB5YGV8eAlrwDPGxrancWYaLbumR9YbK+rlmM6pZW87ipxZz +R8srzJmwN0jP41ZL9c8PDHIyh8bwRLtTcm1D9SZImlJnt1ir/md2cXjbDaJWFBM5 +JDGFoqgCWjBH4d1QB7wCCZAA62RjYJsWvIjJEubSfZGL+T0yjWW06XyxV3bqxbYo +Ob8VZRzI9neWagqNdwvYkQsEjgfbKbYK7p2CNTUQ +-----END CERTIFICATE----- + +# Issuer: CN=SwissSign Gold CA - G2 O=SwissSign AG +# Subject: CN=SwissSign Gold CA - G2 O=SwissSign AG +# Label: "SwissSign Gold CA - G2" +# Serial: 13492815561806991280 +# MD5 Fingerprint: 24:77:d9:a8:91:d1:3b:fa:88:2d:c2:ff:f8:cd:33:93 +# SHA1 Fingerprint: d8:c5:38:8a:b7:30:1b:1b:6e:d4:7a:e6:45:25:3a:6f:9f:1a:27:61 +# SHA256 Fingerprint: 62:dd:0b:e9:b9:f5:0a:16:3e:a0:f8:e7:5c:05:3b:1e:ca:57:ea:55:c8:68:8f:64:7c:68:81:f2:c8:35:7b:95 +-----BEGIN CERTIFICATE----- +MIIFujCCA6KgAwIBAgIJALtAHEP1Xk+wMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV +BAYTAkNIMRUwEwYDVQQKEwxTd2lzc1NpZ24gQUcxHzAdBgNVBAMTFlN3aXNzU2ln +biBHb2xkIENBIC0gRzIwHhcNMDYxMDI1MDgzMDM1WhcNMzYxMDI1MDgzMDM1WjBF +MQswCQYDVQQGEwJDSDEVMBMGA1UEChMMU3dpc3NTaWduIEFHMR8wHQYDVQQDExZT +d2lzc1NpZ24gR29sZCBDQSAtIEcyMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIIC +CgKCAgEAr+TufoskDhJuqVAtFkQ7kpJcyrhdhJJCEyq8ZVeCQD5XJM1QiyUqt2/8 +76LQwB8CJEoTlo8jE+YoWACjR8cGp4QjK7u9lit/VcyLwVcfDmJlD909Vopz2q5+ +bbqBHH5CjCA12UNNhPqE21Is8w4ndwtrvxEvcnifLtg+5hg3Wipy+dpikJKVyh+c +6bM8K8vzARO/Ws/BtQpgvd21mWRTuKCWs2/iJneRjOBiEAKfNA+k1ZIzUd6+jbqE +emA8atufK+ze3gE/bk3lUIbLtK/tREDFylqM2tIrfKjuvqblCqoOpd8FUrdVxyJd +MmqXl2MT28nbeTZ7hTpKxVKJ+STnnXepgv9VHKVxaSvRAiTysybUa9oEVeXBCsdt +MDeQKuSeFDNeFhdVxVu1yzSJkvGdJo+hB9TGsnhQ2wwMC3wLjEHXuendjIj3o02y +MszYF9rNt85mndT9Xv+9lz4pded+p2JYryU0pUHHPbwNUMoDAw8IWh+Vc3hiv69y +FGkOpeUDDniOJihC8AcLYiAQZzlG+qkDzAQ4embvIIO1jEpWjpEA/I5cgt6IoMPi +aG59je883WX0XaxR7ySArqpWl2/5rX3aYT+YdzylkbYcjCbaZaIJbcHiVOO5ykxM +gI93e2CaHt+28kgeDrpOVG2Y4OGiGqJ3UM/EY5LsRxmd6+ZrzsECAwEAAaOBrDCB +qTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUWyV7 +lqRlUX64OfPAeGZe6Drn8O4wHwYDVR0jBBgwFoAUWyV7lqRlUX64OfPAeGZe6Drn +8O4wRgYDVR0gBD8wPTA7BglghXQBWQECAQEwLjAsBggrBgEFBQcCARYgaHR0cDov +L3JlcG9zaXRvcnkuc3dpc3NzaWduLmNvbS8wDQYJKoZIhvcNAQEFBQADggIBACe6 +45R88a7A3hfm5djV9VSwg/S7zV4Fe0+fdWavPOhWfvxyeDgD2StiGwC5+OlgzczO +UYrHUDFu4Up+GC9pWbY9ZIEr44OE5iKHjn3g7gKZYbge9LgriBIWhMIxkziWMaa5 +O1M/wySTVltpkuzFwbs4AOPsF6m43Md8AYOfMke6UiI0HTJ6CVanfCU2qT1L2sCC +bwq7EsiHSycR+R4tx5M/nttfJmtS2S6K8RTGRI0Vqbe/vd6mGu6uLftIdxf+u+yv +GPUqUfA5hJeVbG4bwyvEdGB5JbAKJ9/fXtI5z0V9QkvfsywexcZdylU6oJxpmo/a +77KwPJ+HbBIrZXAVUjEaJM9vMSNQH4xPjyPDdEFjHFWoFN0+4FFQz/EbMFYOkrCC +hdiDyyJkvC24JdVUorgG6q2SpCSgwYa1ShNqR88uC1aVVMvOmttqtKay20EIhid3 +92qgQmwLOM7XdVAyksLfKzAiSNDVQTglXaTpXZ/GlHXQRf0wl0OPkKsKx4ZzYEpp +Ld6leNcG2mqeSz53OiATIgHQv2ieY2BrNU0LbbqhPcCT4H8js1WtciVORvnSFu+w +ZMEBnunKoGqYDs/YYPIvSbjkQuE4NRb0yG5P94FW6LqjviOvrv1vA+ACOzB2+htt +Qc8Bsem4yWb02ybzOqR08kkkW8mw0FfB+j564ZfJ +-----END CERTIFICATE----- + +# Issuer: CN=SwissSign Silver CA - G2 O=SwissSign AG +# Subject: CN=SwissSign Silver CA - G2 O=SwissSign AG +# Label: "SwissSign Silver CA - G2" +# Serial: 5700383053117599563 +# MD5 Fingerprint: e0:06:a1:c9:7d:cf:c9:fc:0d:c0:56:75:96:d8:62:13 +# SHA1 Fingerprint: 9b:aa:e5:9f:56:ee:21:cb:43:5a:be:25:93:df:a7:f0:40:d1:1d:cb +# SHA256 Fingerprint: be:6c:4d:a2:bb:b9:ba:59:b6:f3:93:97:68:37:42:46:c3:c0:05:99:3f:a9:8f:02:0d:1d:ed:be:d4:8a:81:d5 +-----BEGIN CERTIFICATE----- +MIIFvTCCA6WgAwIBAgIITxvUL1S7L0swDQYJKoZIhvcNAQEFBQAwRzELMAkGA1UE +BhMCQ0gxFTATBgNVBAoTDFN3aXNzU2lnbiBBRzEhMB8GA1UEAxMYU3dpc3NTaWdu +IFNpbHZlciBDQSAtIEcyMB4XDTA2MTAyNTA4MzI0NloXDTM2MTAyNTA4MzI0Nlow +RzELMAkGA1UEBhMCQ0gxFTATBgNVBAoTDFN3aXNzU2lnbiBBRzEhMB8GA1UEAxMY +U3dpc3NTaWduIFNpbHZlciBDQSAtIEcyMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A +MIICCgKCAgEAxPGHf9N4Mfc4yfjDmUO8x/e8N+dOcbpLj6VzHVxumK4DV644N0Mv +Fz0fyM5oEMF4rhkDKxD6LHmD9ui5aLlV8gREpzn5/ASLHvGiTSf5YXu6t+WiE7br +YT7QbNHm+/pe7R20nqA1W6GSy/BJkv6FCgU+5tkL4k+73JU3/JHpMjUi0R86TieF +nbAVlDLaYQ1HTWBCrpJH6INaUFjpiou5XaHc3ZlKHzZnu0jkg7Y360g6rw9njxcH +6ATK72oxh9TAtvmUcXtnZLi2kUpCe2UuMGoM9ZDulebyzYLs2aFK7PayS+VFheZt +eJMELpyCbTapxDFkH4aDCyr0NQp4yVXPQbBH6TCfmb5hqAaEuSh6XzjZG6k4sIN/ +c8HDO0gqgg8hm7jMqDXDhBuDsz6+pJVpATqJAHgE2cn0mRmrVn5bi4Y5FZGkECwJ +MoBgs5PAKrYYC51+jUnyEEp/+dVGLxmSo5mnJqy7jDzmDrxHB9xzUfFwZC8I+bRH +HTBsROopN4WSaGa8gzj+ezku01DwH/teYLappvonQfGbGHLy9YR0SslnxFSuSGTf +jNFusB3hB48IHpmccelM2KX3RxIfdNFRnobzwqIjQAtz20um53MGjMGg6cFZrEb6 +5i/4z3GcRm25xBWNOHkDRUjvxF3XCO6HOSKGsg0PWEP3calILv3q1h8CAwEAAaOB +rDCBqTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU +F6DNweRBtjpbO8tFnb0cwpj6hlgwHwYDVR0jBBgwFoAUF6DNweRBtjpbO8tFnb0c +wpj6hlgwRgYDVR0gBD8wPTA7BglghXQBWQEDAQEwLjAsBggrBgEFBQcCARYgaHR0 +cDovL3JlcG9zaXRvcnkuc3dpc3NzaWduLmNvbS8wDQYJKoZIhvcNAQEFBQADggIB +AHPGgeAn0i0P4JUw4ppBf1AsX19iYamGamkYDHRJ1l2E6kFSGG9YrVBWIGrGvShp +WJHckRE1qTodvBqlYJ7YH39FkWnZfrt4csEGDyrOj4VwYaygzQu4OSlWhDJOhrs9 +xCrZ1x9y7v5RoSJBsXECYxqCsGKrXlcSH9/L3XWgwF15kIwb4FDm3jH+mHtwX6WQ +2K34ArZv02DdQEsixT2tOnqfGhpHkXkzuoLcMmkDlm4fS/Bx/uNncqCxv1yL5PqZ +IseEuRuNI5c/7SXgz2W79WEE790eslpBIlqhn10s6FvJbakMDHiqYMZWjwFaDGi8 +aRl5xB9+lwW/xekkUV7U1UtT7dkjWjYDZaPBA61BMPNGG4WQr2W11bHkFlt4dR2X +em1ZqSqPe97Dh4kQmUlzeMg9vVE1dCrV8X5pGyq7O70luJpaPXJhkGaH7gzWTdQR +dAtq/gsD/KNVV4n+SsuuWxcFyPKNIzFTONItaj+CuY0IavdeQXRuwxF+B6wpYJE/ +OMpXEA29MC/HpeZBoNquBYeaoKRlbEwJDIm6uNO5wJOKMPqN5ZprFQFOZ6raYlY+ +hAhm0sQ2fac+EPyI4NSA5QC9qvNOBqN6avlicuMJT+ubDgEj8Z+7fNzcbBGXJbLy +tGMU0gYqZ4yD9c7qB9iaah7s5Aq7KkzrCWA5zspi2C5u +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Primary Certification Authority O=GeoTrust Inc. +# Subject: CN=GeoTrust Primary Certification Authority O=GeoTrust Inc. +# Label: "GeoTrust Primary Certification Authority" +# Serial: 32798226551256963324313806436981982369 +# MD5 Fingerprint: 02:26:c3:01:5e:08:30:37:43:a9:d0:7d:cf:37:e6:bf +# SHA1 Fingerprint: 32:3c:11:8e:1b:f7:b8:b6:52:54:e2:e2:10:0d:d6:02:90:37:f0:96 +# SHA256 Fingerprint: 37:d5:10:06:c5:12:ea:ab:62:64:21:f1:ec:8c:92:01:3f:c5:f8:2a:e9:8e:e5:33:eb:46:19:b8:de:b4:d0:6c +-----BEGIN CERTIFICATE----- +MIIDfDCCAmSgAwIBAgIQGKy1av1pthU6Y2yv2vrEoTANBgkqhkiG9w0BAQUFADBY +MQswCQYDVQQGEwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjExMC8GA1UEAxMo +R2VvVHJ1c3QgUHJpbWFyeSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw0wNjEx +MjcwMDAwMDBaFw0zNjA3MTYyMzU5NTlaMFgxCzAJBgNVBAYTAlVTMRYwFAYDVQQK +Ew1HZW9UcnVzdCBJbmMuMTEwLwYDVQQDEyhHZW9UcnVzdCBQcmltYXJ5IENlcnRp +ZmljYXRpb24gQXV0aG9yaXR5MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEAvrgVe//UfH1nrYNke8hCUy3f9oQIIGHWAVlqnEQRr+92/ZV+zmEwu3qDXwK9 +AWbK7hWNb6EwnL2hhZ6UOvNWiAAxz9juapYC2e0DjPt1befquFUWBRaa9OBesYjA +ZIVcFU2Ix7e64HXprQU9nceJSOC7KMgD4TCTZF5SwFlwIjVXiIrxlQqD17wxcwE0 +7e9GceBrAqg1cmuXm2bgyxx5X9gaBGgeRwLmnWDiNpcB3841kt++Z8dtd1k7j53W +kBWUvEI0EME5+bEnPn7WinXFsq+W06Lem+SYvn3h6YGttm/81w7a4DSwDRp35+MI +mO9Y+pyEtzavwt+s0vQQBnBxNQIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4G +A1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQULNVQQZcVi/CPNmFbSvtr2ZnJM5IwDQYJ +KoZIhvcNAQEFBQADggEBAFpwfyzdtzRP9YZRqSa+S7iq8XEN3GHHoOo0Hnp3DwQ1 +6CePbJC/kRYkRj5KTs4rFtULUh38H2eiAkUxT87z+gOneZ1TatnaYzr4gNfTmeGl +4b7UVXGYNTq+k+qurUKykG/g/CFNNWMziUnWm07Kx+dOCQD32sfvmWKZd7aVIl6K +oKv0uHiYyjgZmclynnjNS6yvGaBzEi38wkG6gZHaFloxt/m0cYASSJlyc1pZU8Fj +UjPtp8nSOQJw+uCxQmYpqptR7TBUIhRf2asdweSU8Pj1K/fqynhG1riR/aYNKxoU +AT6A8EKglQdebc3MS6RFjasS6LPeWuWgfOgPIh1a6Vk= +-----END CERTIFICATE----- + +# Issuer: CN=thawte Primary Root CA O=thawte, Inc. OU=Certification Services Division/(c) 2006 thawte, Inc. - For authorized use only +# Subject: CN=thawte Primary Root CA O=thawte, Inc. OU=Certification Services Division/(c) 2006 thawte, Inc. - For authorized use only +# Label: "thawte Primary Root CA" +# Serial: 69529181992039203566298953787712940909 +# MD5 Fingerprint: 8c:ca:dc:0b:22:ce:f5:be:72:ac:41:1a:11:a8:d8:12 +# SHA1 Fingerprint: 91:c6:d6:ee:3e:8a:c8:63:84:e5:48:c2:99:29:5c:75:6c:81:7b:81 +# SHA256 Fingerprint: 8d:72:2f:81:a9:c1:13:c0:79:1d:f1:36:a2:96:6d:b2:6c:95:0a:97:1d:b4:6b:41:99:f4:ea:54:b7:8b:fb:9f +-----BEGIN CERTIFICATE----- +MIIEIDCCAwigAwIBAgIQNE7VVyDV7exJ9C/ON9srbTANBgkqhkiG9w0BAQUFADCB +qTELMAkGA1UEBhMCVVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5jLjEoMCYGA1UECxMf +Q2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjE4MDYGA1UECxMvKGMpIDIw +MDYgdGhhd3RlLCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxHzAdBgNV +BAMTFnRoYXd0ZSBQcmltYXJ5IFJvb3QgQ0EwHhcNMDYxMTE3MDAwMDAwWhcNMzYw +NzE2MjM1OTU5WjCBqTELMAkGA1UEBhMCVVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5j +LjEoMCYGA1UECxMfQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjE4MDYG +A1UECxMvKGMpIDIwMDYgdGhhd3RlLCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNl +IG9ubHkxHzAdBgNVBAMTFnRoYXd0ZSBQcmltYXJ5IFJvb3QgQ0EwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCsoPD7gFnUnMekz52hWXMJEEUMDSxuaPFs +W0hoSVk3/AszGcJ3f8wQLZU0HObrTQmnHNK4yZc2AreJ1CRfBsDMRJSUjQJib+ta +3RGNKJpchJAQeg29dGYvajig4tVUROsdB58Hum/u6f1OCyn1PoSgAfGcq/gcfomk +6KHYcWUNo1F77rzSImANuVud37r8UVsLr5iy6S7pBOhih94ryNdOwUxkHt3Ph1i6 +Sk/KaAcdHJ1KxtUvkcx8cXIcxcBn6zL9yZJclNqFwJu/U30rCfSMnZEfl2pSy94J +NqR32HuHUETVPm4pafs5SSYeCaWAe0At6+gnhcn+Yf1+5nyXHdWdAgMBAAGjQjBA +MA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0GA1UdDgQWBBR7W0XP +r87Lev0xkhpqtvNG61dIUDANBgkqhkiG9w0BAQUFAAOCAQEAeRHAS7ORtvzw6WfU +DW5FvlXok9LOAz/t2iWwHVfLHjp2oEzsUHboZHIMpKnxuIvW1oeEuzLlQRHAd9mz +YJ3rG9XRbkREqaYB7FViHXe4XI5ISXycO1cRrK1zN44veFyQaEfZYGDm/Ac9IiAX +xPcW6cTYcvnIc3zfFi8VqT79aie2oetaupgf1eNNZAqdE8hhuvU5HIe6uL17In/2 +/qxAeeWsEG89jxt5dovEN7MhGITlNgDrYyCZuen+MwS7QcjBAvlEYyCegc5C09Y/ +LHbTY5xZ3Y+m4Q6gLkH3LpVHz7z9M/P2C2F+fpErgUfCJzDupxBdN49cOSvkBPB7 +jVaMaA== +-----END CERTIFICATE----- + +# Issuer: CN=VeriSign Class 3 Public Primary Certification Authority - G5 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2006 VeriSign, Inc. - For authorized use only +# Subject: CN=VeriSign Class 3 Public Primary Certification Authority - G5 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2006 VeriSign, Inc. - For authorized use only +# Label: "VeriSign Class 3 Public Primary Certification Authority - G5" +# Serial: 33037644167568058970164719475676101450 +# MD5 Fingerprint: cb:17:e4:31:67:3e:e2:09:fe:45:57:93:f3:0a:fa:1c +# SHA1 Fingerprint: 4e:b6:d5:78:49:9b:1c:cf:5f:58:1e:ad:56:be:3d:9b:67:44:a5:e5 +# SHA256 Fingerprint: 9a:cf:ab:7e:43:c8:d8:80:d0:6b:26:2a:94:de:ee:e4:b4:65:99:89:c3:d0:ca:f1:9b:af:64:05:e4:1a:b7:df +-----BEGIN CERTIFICATE----- +MIIE0zCCA7ugAwIBAgIQGNrRniZ96LtKIVjNzGs7SjANBgkqhkiG9w0BAQUFADCB +yjELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQL +ExZWZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwNiBWZXJp +U2lnbiwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MUUwQwYDVQQDEzxW +ZXJpU2lnbiBDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0 +aG9yaXR5IC0gRzUwHhcNMDYxMTA4MDAwMDAwWhcNMzYwNzE2MjM1OTU5WjCByjEL +MAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQLExZW +ZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwNiBWZXJpU2ln +biwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MUUwQwYDVQQDEzxWZXJp +U2lnbiBDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9y +aXR5IC0gRzUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvJAgIKXo1 +nmAMqudLO07cfLw8RRy7K+D+KQL5VwijZIUVJ/XxrcgxiV0i6CqqpkKzj/i5Vbex +t0uz/o9+B1fs70PbZmIVYc9gDaTY3vjgw2IIPVQT60nKWVSFJuUrjxuf6/WhkcIz +SdhDY2pSS9KP6HBRTdGJaXvHcPaz3BJ023tdS1bTlr8Vd6Gw9KIl8q8ckmcY5fQG +BO+QueQA5N06tRn/Arr0PO7gi+s3i+z016zy9vA9r911kTMZHRxAy3QkGSGT2RT+ +rCpSx4/VBEnkjWNHiDxpg8v+R70rfk/Fla4OndTRQ8Bnc+MUCH7lP59zuDMKz10/ +NIeWiu5T6CUVAgMBAAGjgbIwga8wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8E +BAMCAQYwbQYIKwYBBQUHAQwEYTBfoV2gWzBZMFcwVRYJaW1hZ2UvZ2lmMCEwHzAH +BgUrDgMCGgQUj+XTGoasjY5rw8+AatRIGCx7GS4wJRYjaHR0cDovL2xvZ28udmVy +aXNpZ24uY29tL3ZzbG9nby5naWYwHQYDVR0OBBYEFH/TZafC3ey78DAJ80M5+gKv +MzEzMA0GCSqGSIb3DQEBBQUAA4IBAQCTJEowX2LP2BqYLz3q3JktvXf2pXkiOOzE +p6B4Eq1iDkVwZMXnl2YtmAl+X6/WzChl8gGqCBpH3vn5fJJaCGkgDdk+bW48DW7Y +5gaRQBi5+MHt39tBquCWIMnNZBU4gcmU7qKEKQsTb47bDN0lAtukixlE0kF6BWlK +WE9gyn6CagsCqiUXObXbf+eEZSqVir2G3l6BFoMtEMze/aiCKm0oHw0LxOXnGiYZ +4fQRbxC1lfznQgUy286dUV4otp6F01vvpX1FQHKOtw5rDgb7MzVIcbidJ4vEZV8N +hnacRHr2lVz2XTIIM6RUthg/aFzyQkqFOFSDX9HoLPKsEdao7WNq +-----END CERTIFICATE----- + +# Issuer: CN=SecureTrust CA O=SecureTrust Corporation +# Subject: CN=SecureTrust CA O=SecureTrust Corporation +# Label: "SecureTrust CA" +# Serial: 17199774589125277788362757014266862032 +# MD5 Fingerprint: dc:32:c3:a7:6d:25:57:c7:68:09:9d:ea:2d:a9:a2:d1 +# SHA1 Fingerprint: 87:82:c6:c3:04:35:3b:cf:d2:96:92:d2:59:3e:7d:44:d9:34:ff:11 +# SHA256 Fingerprint: f1:c1:b5:0a:e5:a2:0d:d8:03:0e:c9:f6:bc:24:82:3d:d3:67:b5:25:57:59:b4:e7:1b:61:fc:e9:f7:37:5d:73 +-----BEGIN CERTIFICATE----- +MIIDuDCCAqCgAwIBAgIQDPCOXAgWpa1Cf/DrJxhZ0DANBgkqhkiG9w0BAQUFADBI +MQswCQYDVQQGEwJVUzEgMB4GA1UEChMXU2VjdXJlVHJ1c3QgQ29ycG9yYXRpb24x +FzAVBgNVBAMTDlNlY3VyZVRydXN0IENBMB4XDTA2MTEwNzE5MzExOFoXDTI5MTIz +MTE5NDA1NVowSDELMAkGA1UEBhMCVVMxIDAeBgNVBAoTF1NlY3VyZVRydXN0IENv +cnBvcmF0aW9uMRcwFQYDVQQDEw5TZWN1cmVUcnVzdCBDQTCCASIwDQYJKoZIhvcN +AQEBBQADggEPADCCAQoCggEBAKukgeWVzfX2FI7CT8rU4niVWJxB4Q2ZQCQXOZEz +Zum+4YOvYlyJ0fwkW2Gz4BERQRwdbvC4u/jep4G6pkjGnx29vo6pQT64lO0pGtSO +0gMdA+9tDWccV9cGrcrI9f4Or2YlSASWC12juhbDCE/RRvgUXPLIXgGZbf2IzIao +wW8xQmxSPmjL8xk037uHGFaAJsTQ3MBv396gwpEWoGQRS0S8Hvbn+mPeZqx2pHGj +7DaUaHp3pLHnDi+BeuK1cobvomuL8A/b01k/unK8RCSc43Oz969XL0Imnal0ugBS +8kvNU3xHCzaFDmapCJcWNFfBZveA4+1wVMeT4C4oFVmHursCAwEAAaOBnTCBmjAT +BgkrBgEEAYI3FAIEBh4EAEMAQTALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB +/zAdBgNVHQ4EFgQUQjK2FvoE/f5dS3rD/fdMQB1aQ68wNAYDVR0fBC0wKzApoCeg +JYYjaHR0cDovL2NybC5zZWN1cmV0cnVzdC5jb20vU1RDQS5jcmwwEAYJKwYBBAGC +NxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggEBADDtT0rhWDpSclu1pqNlGKa7UTt3 +6Z3q059c4EVlew3KW+JwULKUBRSuSceNQQcSc5R+DCMh/bwQf2AQWnL1mA6s7Ll/ +3XpvXdMc9P+IBWlCqQVxyLesJugutIxq/3HcuLHfmbx8IVQr5Fiiu1cprp6poxkm +D5kuCLDv/WnPmRoJjeOnnyvJNjR7JLN4TJUXpAYmHrZkUjZfYGfZnMUFdAvnZyPS +CPyI6a6Lf+Ew9Dd+/cYy2i2eRDAwbO4H3tI0/NL/QPZL9GZGBlSm8jIKYyYwa5vR +3ItHuuG51WLQoqD0ZwV4KWMabwTW+MZMo5qxN7SN5ShLHZ4swrhovO0C7jE= +-----END CERTIFICATE----- + +# Issuer: CN=Secure Global CA O=SecureTrust Corporation +# Subject: CN=Secure Global CA O=SecureTrust Corporation +# Label: "Secure Global CA" +# Serial: 9751836167731051554232119481456978597 +# MD5 Fingerprint: cf:f4:27:0d:d4:ed:dc:65:16:49:6d:3d:da:bf:6e:de +# SHA1 Fingerprint: 3a:44:73:5a:e5:81:90:1f:24:86:61:46:1e:3b:9c:c4:5f:f5:3a:1b +# SHA256 Fingerprint: 42:00:f5:04:3a:c8:59:0e:bb:52:7d:20:9e:d1:50:30:29:fb:cb:d4:1c:a1:b5:06:ec:27:f1:5a:de:7d:ac:69 +-----BEGIN CERTIFICATE----- +MIIDvDCCAqSgAwIBAgIQB1YipOjUiolN9BPI8PjqpTANBgkqhkiG9w0BAQUFADBK +MQswCQYDVQQGEwJVUzEgMB4GA1UEChMXU2VjdXJlVHJ1c3QgQ29ycG9yYXRpb24x +GTAXBgNVBAMTEFNlY3VyZSBHbG9iYWwgQ0EwHhcNMDYxMTA3MTk0MjI4WhcNMjkx +MjMxMTk1MjA2WjBKMQswCQYDVQQGEwJVUzEgMB4GA1UEChMXU2VjdXJlVHJ1c3Qg +Q29ycG9yYXRpb24xGTAXBgNVBAMTEFNlY3VyZSBHbG9iYWwgQ0EwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQCvNS7YrGxVaQZx5RNoJLNP2MwhR/jxYDiJ +iQPpvepeRlMJ3Fz1Wuj3RSoC6zFh1ykzTM7HfAo3fg+6MpjhHZevj8fcyTiW89sa +/FHtaMbQbqR8JNGuQsiWUGMu4P51/pinX0kuleM5M2SOHqRfkNJnPLLZ/kG5VacJ +jnIFHovdRIWCQtBJwB1g8NEXLJXr9qXBkqPFwqcIYA1gBBCWeZ4WNOaptvolRTnI +HmX5k/Wq8VLcmZg9pYYaDDUz+kulBAYVHDGA76oYa8J719rO+TMg1fW9ajMtgQT7 +sFzUnKPiXB3jqUJ1XnvUd+85VLrJChgbEplJL4hL/VBi0XPnj3pDAgMBAAGjgZ0w +gZowEwYJKwYBBAGCNxQCBAYeBABDAEEwCwYDVR0PBAQDAgGGMA8GA1UdEwEB/wQF +MAMBAf8wHQYDVR0OBBYEFK9EBMJBfkiD2045AuzshHrmzsmkMDQGA1UdHwQtMCsw +KaAnoCWGI2h0dHA6Ly9jcmwuc2VjdXJldHJ1c3QuY29tL1NHQ0EuY3JsMBAGCSsG +AQQBgjcVAQQDAgEAMA0GCSqGSIb3DQEBBQUAA4IBAQBjGghAfaReUw132HquHw0L +URYD7xh8yOOvaliTFGCRsoTciE6+OYo68+aCiV0BN7OrJKQVDpI1WkpEXk5X+nXO +H0jOZvQ8QCaSmGwb7iRGDBezUqXbpZGRzzfTb+cnCDpOGR86p1hcF895P4vkp9Mm +I50mD1hp/Ed+stCNi5O/KU9DaXR2Z0vPB4zmAve14bRDtUstFJ/53CYNv6ZHdAbY +iNE6KTCEztI5gGIbqMdXSbxqVVFnFUq+NQfk1XWYN3kwFNspnWzFacxHVaIw98xc +f8LDmBxrThaA63p4ZUWiABqvDA1VZDRIuJK58bRQKfJPIx/abKwfROHdI3hRW8cW +-----END CERTIFICATE----- + +# Issuer: CN=COMODO Certification Authority O=COMODO CA Limited +# Subject: CN=COMODO Certification Authority O=COMODO CA Limited +# Label: "COMODO Certification Authority" +# Serial: 104350513648249232941998508985834464573 +# MD5 Fingerprint: 5c:48:dc:f7:42:72:ec:56:94:6d:1c:cc:71:35:80:75 +# SHA1 Fingerprint: 66:31:bf:9e:f7:4f:9e:b6:c9:d5:a6:0c:ba:6a:be:d1:f7:bd:ef:7b +# SHA256 Fingerprint: 0c:2c:d6:3d:f7:80:6f:a3:99:ed:e8:09:11:6b:57:5b:f8:79:89:f0:65:18:f9:80:8c:86:05:03:17:8b:af:66 +-----BEGIN CERTIFICATE----- +MIIEHTCCAwWgAwIBAgIQToEtioJl4AsC7j41AkblPTANBgkqhkiG9w0BAQUFADCB +gTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G +A1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxJzAlBgNV +BAMTHkNPTU9ETyBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAeFw0wNjEyMDEwMDAw +MDBaFw0yOTEyMzEyMzU5NTlaMIGBMQswCQYDVQQGEwJHQjEbMBkGA1UECBMSR3Jl +YXRlciBNYW5jaGVzdGVyMRAwDgYDVQQHEwdTYWxmb3JkMRowGAYDVQQKExFDT01P +RE8gQ0EgTGltaXRlZDEnMCUGA1UEAxMeQ09NT0RPIENlcnRpZmljYXRpb24gQXV0 +aG9yaXR5MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0ECLi3LjkRv3 +UcEbVASY06m/weaKXTuH+7uIzg3jLz8GlvCiKVCZrts7oVewdFFxze1CkU1B/qnI +2GqGd0S7WWaXUF601CxwRM/aN5VCaTwwxHGzUvAhTaHYujl8HJ6jJJ3ygxaYqhZ8 +Q5sVW7euNJH+1GImGEaaP+vB+fGQV+useg2L23IwambV4EajcNxo2f8ESIl33rXp ++2dtQem8Ob0y2WIC8bGoPW43nOIv4tOiJovGuFVDiOEjPqXSJDlqR6sA1KGzqSX+ +DT+nHbrTUcELpNqsOO9VUCQFZUaTNE8tja3G1CEZ0o7KBWFxB3NH5YoZEr0ETc5O +nKVIrLsm9wIDAQABo4GOMIGLMB0GA1UdDgQWBBQLWOWLxkwVN6RAqTCpIb5HNlpW +/zAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zBJBgNVHR8EQjBAMD6g +PKA6hjhodHRwOi8vY3JsLmNvbW9kb2NhLmNvbS9DT01PRE9DZXJ0aWZpY2F0aW9u +QXV0aG9yaXR5LmNybDANBgkqhkiG9w0BAQUFAAOCAQEAPpiem/Yb6dc5t3iuHXIY +SdOH5EOC6z/JqvWote9VfCFSZfnVDeFs9D6Mk3ORLgLETgdxb8CPOGEIqB6BCsAv +IC9Bi5HcSEW88cbeunZrM8gALTFGTO3nnc+IlP8zwFboJIYmuNg4ON8qa90SzMc/ +RxdMosIGlgnW2/4/PEZB31jiVg88O8EckzXZOFKs7sjsLjBOlDW0JB9LeGna8gI4 +zJVSk/BwJVmcIGfE7vmLV2H0knZ9P4SNVbfo5azV8fUZVqZa+5Acr5Pr5RzUZ5dd +BA6+C4OmF4O5MBKgxTMVBbkN+8cFduPYSo38NBejxiEovjBFMR7HeL5YYTisO+IB +ZQ== +-----END CERTIFICATE----- + +# Issuer: CN=Network Solutions Certificate Authority O=Network Solutions L.L.C. +# Subject: CN=Network Solutions Certificate Authority O=Network Solutions L.L.C. +# Label: "Network Solutions Certificate Authority" +# Serial: 116697915152937497490437556386812487904 +# MD5 Fingerprint: d3:f3:a6:16:c0:fa:6b:1d:59:b1:2d:96:4d:0e:11:2e +# SHA1 Fingerprint: 74:f8:a3:c3:ef:e7:b3:90:06:4b:83:90:3c:21:64:60:20:e5:df:ce +# SHA256 Fingerprint: 15:f0:ba:00:a3:ac:7a:f3:ac:88:4c:07:2b:10:11:a0:77:bd:77:c0:97:f4:01:64:b2:f8:59:8a:bd:83:86:0c +-----BEGIN CERTIFICATE----- +MIID5jCCAs6gAwIBAgIQV8szb8JcFuZHFhfjkDFo4DANBgkqhkiG9w0BAQUFADBi +MQswCQYDVQQGEwJVUzEhMB8GA1UEChMYTmV0d29yayBTb2x1dGlvbnMgTC5MLkMu +MTAwLgYDVQQDEydOZXR3b3JrIFNvbHV0aW9ucyBDZXJ0aWZpY2F0ZSBBdXRob3Jp +dHkwHhcNMDYxMjAxMDAwMDAwWhcNMjkxMjMxMjM1OTU5WjBiMQswCQYDVQQGEwJV +UzEhMB8GA1UEChMYTmV0d29yayBTb2x1dGlvbnMgTC5MLkMuMTAwLgYDVQQDEydO +ZXR3b3JrIFNvbHV0aW9ucyBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggEiMA0GCSqG +SIb3DQEBAQUAA4IBDwAwggEKAoIBAQDkvH6SMG3G2I4rC7xGzuAnlt7e+foS0zwz +c7MEL7xxjOWftiJgPl9dzgn/ggwbmlFQGiaJ3dVhXRncEg8tCqJDXRfQNJIg6nPP +OCwGJgl6cvf6UDL4wpPTaaIjzkGxzOTVHzbRijr4jGPiFFlp7Q3Tf2vouAPlT2rl +mGNpSAW+Lv8ztumXWWn4Zxmuk2GWRBXTcrA/vGp97Eh/jcOrqnErU2lBUzS1sLnF +BgrEsEX1QV1uiUV7PTsmjHTC5dLRfbIR1PtYMiKagMnc/Qzpf14Dl847ABSHJ3A4 +qY5usyd2mFHgBeMhqxrVhSI8KbWaFsWAqPS7azCPL0YCorEMIuDTAgMBAAGjgZcw +gZQwHQYDVR0OBBYEFCEwyfsA106Y2oeqKtCnLrFAMadMMA4GA1UdDwEB/wQEAwIB +BjAPBgNVHRMBAf8EBTADAQH/MFIGA1UdHwRLMEkwR6BFoEOGQWh0dHA6Ly9jcmwu +bmV0c29sc3NsLmNvbS9OZXR3b3JrU29sdXRpb25zQ2VydGlmaWNhdGVBdXRob3Jp +dHkuY3JsMA0GCSqGSIb3DQEBBQUAA4IBAQC7rkvnt1frf6ott3NHhWrB5KUd5Oc8 +6fRZZXe1eltajSU24HqXLjjAV2CDmAaDn7l2em5Q4LqILPxFzBiwmZVRDuwduIj/ +h1AcgsLj4DKAv6ALR8jDMe+ZZzKATxcheQxpXN5eNK4CtSbqUN9/GGUsyfJj4akH +/nxxH2szJGoeBfcFaMBqEssuXmHLrijTfsK0ZpEmXzwuJF/LWA/rKOyvEZbz3Htv +wKeI8lN3s2Berq4o2jUsbzRF0ybh3uxbTydrFny9RAQYgrOJeRcQcT16ohZO9QHN +pGxlaKFJdlxDydi8NmdspZS11My5vWo1ViHe2MPr+8ukYEywVaCge1ey +-----END CERTIFICATE----- + +# Issuer: CN=COMODO ECC Certification Authority O=COMODO CA Limited +# Subject: CN=COMODO ECC Certification Authority O=COMODO CA Limited +# Label: "COMODO ECC Certification Authority" +# Serial: 41578283867086692638256921589707938090 +# MD5 Fingerprint: 7c:62:ff:74:9d:31:53:5e:68:4a:d5:78:aa:1e:bf:23 +# SHA1 Fingerprint: 9f:74:4e:9f:2b:4d:ba:ec:0f:31:2c:50:b6:56:3b:8e:2d:93:c3:11 +# SHA256 Fingerprint: 17:93:92:7a:06:14:54:97:89:ad:ce:2f:8f:34:f7:f0:b6:6d:0f:3a:e3:a3:b8:4d:21:ec:15:db:ba:4f:ad:c7 +-----BEGIN CERTIFICATE----- +MIICiTCCAg+gAwIBAgIQH0evqmIAcFBUTAGem2OZKjAKBggqhkjOPQQDAzCBhTEL +MAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UE +BxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxKzApBgNVBAMT +IkNPTU9ETyBFQ0MgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMDgwMzA2MDAw +MDAwWhcNMzgwMTE4MjM1OTU5WjCBhTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdy +ZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09N +T0RPIENBIExpbWl0ZWQxKzApBgNVBAMTIkNPTU9ETyBFQ0MgQ2VydGlmaWNhdGlv +biBBdXRob3JpdHkwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQDR3svdcmCFYX7deSR +FtSrYpn1PlILBs5BAH+X4QokPB0BBO490o0JlwzgdeT6+3eKKvUDYEs2ixYjFq0J +cfRK9ChQtP6IHG4/bC8vCVlbpVsLM5niwz2J+Wos77LTBumjQjBAMB0GA1UdDgQW +BBR1cacZSBm8nZ3qQUfflMRId5nTeTAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/ +BAUwAwEB/zAKBggqhkjOPQQDAwNoADBlAjEA7wNbeqy3eApyt4jf/7VGFAkK+qDm +fQjGGoe9GKhzvSbKYAydzpmfz1wPMOG+FDHqAjAU9JM8SaczepBGR7NjfRObTrdv +GDeAU/7dIOA1mjbRxwG55tzd8/8dLDoWV9mSOdY= +-----END CERTIFICATE----- + +# Issuer: CN=OISTE WISeKey Global Root GA CA O=WISeKey OU=Copyright (c) 2005/OISTE Foundation Endorsed +# Subject: CN=OISTE WISeKey Global Root GA CA O=WISeKey OU=Copyright (c) 2005/OISTE Foundation Endorsed +# Label: "OISTE WISeKey Global Root GA CA" +# Serial: 86718877871133159090080555911823548314 +# MD5 Fingerprint: bc:6c:51:33:a7:e9:d3:66:63:54:15:72:1b:21:92:93 +# SHA1 Fingerprint: 59:22:a1:e1:5a:ea:16:35:21:f8:98:39:6a:46:46:b0:44:1b:0f:a9 +# SHA256 Fingerprint: 41:c9:23:86:6a:b4:ca:d6:b7:ad:57:80:81:58:2e:02:07:97:a6:cb:df:4f:ff:78:ce:83:96:b3:89:37:d7:f5 +-----BEGIN CERTIFICATE----- +MIID8TCCAtmgAwIBAgIQQT1yx/RrH4FDffHSKFTfmjANBgkqhkiG9w0BAQUFADCB +ijELMAkGA1UEBhMCQ0gxEDAOBgNVBAoTB1dJU2VLZXkxGzAZBgNVBAsTEkNvcHly +aWdodCAoYykgMjAwNTEiMCAGA1UECxMZT0lTVEUgRm91bmRhdGlvbiBFbmRvcnNl +ZDEoMCYGA1UEAxMfT0lTVEUgV0lTZUtleSBHbG9iYWwgUm9vdCBHQSBDQTAeFw0w +NTEyMTExNjAzNDRaFw0zNzEyMTExNjA5NTFaMIGKMQswCQYDVQQGEwJDSDEQMA4G +A1UEChMHV0lTZUtleTEbMBkGA1UECxMSQ29weXJpZ2h0IChjKSAyMDA1MSIwIAYD +VQQLExlPSVNURSBGb3VuZGF0aW9uIEVuZG9yc2VkMSgwJgYDVQQDEx9PSVNURSBX +SVNlS2V5IEdsb2JhbCBSb290IEdBIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A +MIIBCgKCAQEAy0+zAJs9Nt350UlqaxBJH+zYK7LG+DKBKUOVTJoZIyEVRd7jyBxR +VVuuk+g3/ytr6dTqvirdqFEr12bDYVxgAsj1znJ7O7jyTmUIms2kahnBAbtzptf2 +w93NvKSLtZlhuAGio9RN1AU9ka34tAhxZK9w8RxrfvbDd50kc3vkDIzh2TbhmYsF +mQvtRTEJysIA2/dyoJaqlYfQjse2YXMNdmaM3Bu0Y6Kff5MTMPGhJ9vZ/yxViJGg +4E8HsChWjBgbl0SOid3gF27nKu+POQoxhILYQBRJLnpB5Kf+42TMwVlxSywhp1t9 +4B3RLoGbw9ho972WG6xwsRYUC9tguSYBBQIDAQABo1EwTzALBgNVHQ8EBAMCAYYw +DwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUswN+rja8sHnR3JQmthG+IbJphpQw +EAYJKwYBBAGCNxUBBAMCAQAwDQYJKoZIhvcNAQEFBQADggEBAEuh/wuHbrP5wUOx +SPMowB0uyQlB+pQAHKSkq0lPjz0e701vvbyk9vImMMkQyh2I+3QZH4VFvbBsUfk2 +ftv1TDI6QU9bR8/oCy22xBmddMVHxjtqD6wU2zz0c5ypBd8A3HR4+vg1YFkCExh8 +vPtNsCBtQ7tgMHpnM1zFmdH4LTlSc/uMqpclXHLZCB6rTjzjgTGfA6b7wP4piFXa +hNVQA7bihKOmNqoROgHhGEvWRGizPflTdISzRpFGlgC3gCy24eMQ4tui5yiPAZZi +Fj4A4xylNoEYokxSdsARo27mHbrjWr42U8U+dY+GaSlYU7Wcu2+fXMUY7N0v4ZjJ +/L7fCg0= +-----END CERTIFICATE----- + +# Issuer: CN=Certigna O=Dhimyotis +# Subject: CN=Certigna O=Dhimyotis +# Label: "Certigna" +# Serial: 18364802974209362175 +# MD5 Fingerprint: ab:57:a6:5b:7d:42:82:19:b5:d8:58:26:28:5e:fd:ff +# SHA1 Fingerprint: b1:2e:13:63:45:86:a4:6f:1a:b2:60:68:37:58:2d:c4:ac:fd:94:97 +# SHA256 Fingerprint: e3:b6:a2:db:2e:d7:ce:48:84:2f:7a:c5:32:41:c7:b7:1d:54:14:4b:fb:40:c1:1f:3f:1d:0b:42:f5:ee:a1:2d +-----BEGIN CERTIFICATE----- +MIIDqDCCApCgAwIBAgIJAP7c4wEPyUj/MA0GCSqGSIb3DQEBBQUAMDQxCzAJBgNV +BAYTAkZSMRIwEAYDVQQKDAlEaGlteW90aXMxETAPBgNVBAMMCENlcnRpZ25hMB4X +DTA3MDYyOTE1MTMwNVoXDTI3MDYyOTE1MTMwNVowNDELMAkGA1UEBhMCRlIxEjAQ +BgNVBAoMCURoaW15b3RpczERMA8GA1UEAwwIQ2VydGlnbmEwggEiMA0GCSqGSIb3 +DQEBAQUAA4IBDwAwggEKAoIBAQDIaPHJ1tazNHUmgh7stL7qXOEm7RFHYeGifBZ4 +QCHkYJ5ayGPhxLGWkv8YbWkj4Sti993iNi+RB7lIzw7sebYs5zRLcAglozyHGxny +gQcPOJAZ0xH+hrTy0V4eHpbNgGzOOzGTtvKg0KmVEn2lmsxryIRWijOp5yIVUxbw +zBfsV1/pogqYCd7jX5xv3EjjhQsVWqa6n6xI4wmy9/Qy3l40vhx4XUJbzg4ij02Q +130yGLMLLGq/jj8UEYkgDncUtT2UCIf3JR7VsmAA7G8qKCVuKj4YYxclPz5EIBb2 +JsglrgVKtOdjLPOMFlN+XPsRGgjBRmKfIrjxwo1p3Po6WAbfAgMBAAGjgbwwgbkw +DwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUGu3+QTmQtCRZvgHyUtVF9lo53BEw +ZAYDVR0jBF0wW4AUGu3+QTmQtCRZvgHyUtVF9lo53BGhOKQ2MDQxCzAJBgNVBAYT +AkZSMRIwEAYDVQQKDAlEaGlteW90aXMxETAPBgNVBAMMCENlcnRpZ25hggkA/tzj +AQ/JSP8wDgYDVR0PAQH/BAQDAgEGMBEGCWCGSAGG+EIBAQQEAwIABzANBgkqhkiG +9w0BAQUFAAOCAQEAhQMeknH2Qq/ho2Ge6/PAD/Kl1NqV5ta+aDY9fm4fTIrv0Q8h +bV6lUmPOEvjvKtpv6zf+EwLHyzs+ImvaYS5/1HI93TDhHkxAGYwP15zRgzB7mFnc +fca5DClMoTOi62c6ZYTTluLtdkVwj7Ur3vkj1kluPBS1xp81HlDQwY9qcEQCYsuu +HWhBp6pX6FOqB9IG9tUUBguRA3UsbHK1YZWaDYu5Def131TN3ubY1gkIl2PlwS6w +t0QmwCbAr1UwnjvVNioZBPRcHv/PLLf/0P2HQBHVESO7SMAhqaQoLf0V+LBOK/Qw +WyH8EZE0vkHve52Xdf+XlcCWWC/qu0bXu+TZLg== +-----END CERTIFICATE----- + +# Issuer: CN=Deutsche Telekom Root CA 2 O=Deutsche Telekom AG OU=T-TeleSec Trust Center +# Subject: CN=Deutsche Telekom Root CA 2 O=Deutsche Telekom AG OU=T-TeleSec Trust Center +# Label: "Deutsche Telekom Root CA 2" +# Serial: 38 +# MD5 Fingerprint: 74:01:4a:91:b1:08:c4:58:ce:47:cd:f0:dd:11:53:08 +# SHA1 Fingerprint: 85:a4:08:c0:9c:19:3e:5d:51:58:7d:cd:d6:13:30:fd:8c:de:37:bf +# SHA256 Fingerprint: b6:19:1a:50:d0:c3:97:7f:7d:a9:9b:cd:aa:c8:6a:22:7d:ae:b9:67:9e:c7:0b:a3:b0:c9:d9:22:71:c1:70:d3 +-----BEGIN CERTIFICATE----- +MIIDnzCCAoegAwIBAgIBJjANBgkqhkiG9w0BAQUFADBxMQswCQYDVQQGEwJERTEc +MBoGA1UEChMTRGV1dHNjaGUgVGVsZWtvbSBBRzEfMB0GA1UECxMWVC1UZWxlU2Vj +IFRydXN0IENlbnRlcjEjMCEGA1UEAxMaRGV1dHNjaGUgVGVsZWtvbSBSb290IENB +IDIwHhcNOTkwNzA5MTIxMTAwWhcNMTkwNzA5MjM1OTAwWjBxMQswCQYDVQQGEwJE +RTEcMBoGA1UEChMTRGV1dHNjaGUgVGVsZWtvbSBBRzEfMB0GA1UECxMWVC1UZWxl +U2VjIFRydXN0IENlbnRlcjEjMCEGA1UEAxMaRGV1dHNjaGUgVGVsZWtvbSBSb290 +IENBIDIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCrC6M14IspFLEU +ha88EOQ5bzVdSq7d6mGNlUn0b2SjGmBmpKlAIoTZ1KXleJMOaAGtuU1cOs7TuKhC +QN/Po7qCWWqSG6wcmtoIKyUn+WkjR/Hg6yx6m/UTAtB+NHzCnjwAWav12gz1Mjwr +rFDa1sPeg5TKqAyZMg4ISFZbavva4VhYAUlfckE8FQYBjl2tqriTtM2e66foai1S +NNs671x1Udrb8zH57nGYMsRUFUQM+ZtV7a3fGAigo4aKSe5TBY8ZTNXeWHmb0moc +QqvF1afPaA+W5OFhmHZhyJF81j4A4pFQh+GdCuatl9Idxjp9y7zaAzTVjlsB9WoH +txa2bkp/AgMBAAGjQjBAMB0GA1UdDgQWBBQxw3kbuvVT1xfgiXotF2wKsyudMzAP +BgNVHRMECDAGAQH/AgEFMA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQUFAAOC +AQEAlGRZrTlk5ynrE/5aw4sTV8gEJPB0d8Bg42f76Ymmg7+Wgnxu1MM9756Abrsp +tJh6sTtU6zkXR34ajgv8HzFZMQSyzhfzLMdiNlXiItiJVbSYSKpk+tYcNthEeFpa +IzpXl/V6ME+un2pMSyuOoAPjPuCp1NJ70rOo4nI8rZ7/gFnkm0W09juwzTkZmDLl +6iFhkOQxIY40sfcvNUqFENrnijchvllj4PKFiDFT1FQUhXB59C4Gdyd1Lx+4ivn+ +xbrYNuSD7Odlt79jWvNGr4GUN9RBjNYj1h7P9WgbRGOiWrqnNVmh5XAFmw4jV5mU +Cm26OWMohpLzGITY+9HPBVZkVw== +-----END CERTIFICATE----- + +# Issuer: CN=Cybertrust Global Root O=Cybertrust, Inc +# Subject: CN=Cybertrust Global Root O=Cybertrust, Inc +# Label: "Cybertrust Global Root" +# Serial: 4835703278459682877484360 +# MD5 Fingerprint: 72:e4:4a:87:e3:69:40:80:77:ea:bc:e3:f4:ff:f0:e1 +# SHA1 Fingerprint: 5f:43:e5:b1:bf:f8:78:8c:ac:1c:c7:ca:4a:9a:c6:22:2b:cc:34:c6 +# SHA256 Fingerprint: 96:0a:df:00:63:e9:63:56:75:0c:29:65:dd:0a:08:67:da:0b:9c:bd:6e:77:71:4a:ea:fb:23:49:ab:39:3d:a3 +-----BEGIN CERTIFICATE----- +MIIDoTCCAomgAwIBAgILBAAAAAABD4WqLUgwDQYJKoZIhvcNAQEFBQAwOzEYMBYG +A1UEChMPQ3liZXJ0cnVzdCwgSW5jMR8wHQYDVQQDExZDeWJlcnRydXN0IEdsb2Jh +bCBSb290MB4XDTA2MTIxNTA4MDAwMFoXDTIxMTIxNTA4MDAwMFowOzEYMBYGA1UE +ChMPQ3liZXJ0cnVzdCwgSW5jMR8wHQYDVQQDExZDeWJlcnRydXN0IEdsb2JhbCBS +b290MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA+Mi8vRRQZhP/8NN5 +7CPytxrHjoXxEnOmGaoQ25yiZXRadz5RfVb23CO21O1fWLE3TdVJDm71aofW0ozS +J8bi/zafmGWgE07GKmSb1ZASzxQG9Dvj1Ci+6A74q05IlG2OlTEQXO2iLb3VOm2y +HLtgwEZLAfVJrn5GitB0jaEMAs7u/OePuGtm839EAL9mJRQr3RAwHQeWP032a7iP +t3sMpTjr3kfb1V05/Iin89cqdPHoWqI7n1C6poxFNcJQZZXcY4Lv3b93TZxiyWNz +FtApD0mpSPCzqrdsxacwOUBdrsTiXSZT8M4cIwhhqJQZugRiQOwfOHB3EgZxpzAY +XSUnpQIDAQABo4GlMIGiMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/ +MB0GA1UdDgQWBBS2CHsNesysIEyGVjJez6tuhS1wVzA/BgNVHR8EODA2MDSgMqAw +hi5odHRwOi8vd3d3Mi5wdWJsaWMtdHJ1c3QuY29tL2NybC9jdC9jdHJvb3QuY3Js +MB8GA1UdIwQYMBaAFLYIew16zKwgTIZWMl7Pq26FLXBXMA0GCSqGSIb3DQEBBQUA +A4IBAQBW7wojoFROlZfJ+InaRcHUowAl9B8Tq7ejhVhpwjCt2BWKLePJzYFa+HMj +Wqd8BfP9IjsO0QbE2zZMcwSO5bAi5MXzLqXZI+O4Tkogp24CJJ8iYGd7ix1yCcUx +XOl5n4BHPa2hCwcUPUf/A2kaDAtE52Mlp3+yybh2hO0j9n0Hq0V+09+zv+mKts2o +omcrUtW3ZfA5TGOgkXmTUg9U3YO7n9GPp1Nzw8v/MOx8BLjYRB+TX3EJIrduPuoc +A06dGiBh+4E37F78CkWr1+cXVdCg6mCbpvbjjFspwgZgFJ0tl0ypkxWdYcQBX0jW +WL1WMRJOEcgh4LMRkWXbtKaIOM5V +-----END CERTIFICATE----- + +# Issuer: O=Chunghwa Telecom Co., Ltd. OU=ePKI Root Certification Authority +# Subject: O=Chunghwa Telecom Co., Ltd. OU=ePKI Root Certification Authority +# Label: "ePKI Root Certification Authority" +# Serial: 28956088682735189655030529057352760477 +# MD5 Fingerprint: 1b:2e:00:ca:26:06:90:3d:ad:fe:6f:15:68:d3:6b:b3 +# SHA1 Fingerprint: 67:65:0d:f1:7e:8e:7e:5b:82:40:a4:f4:56:4b:cf:e2:3d:69:c6:f0 +# SHA256 Fingerprint: c0:a6:f4:dc:63:a2:4b:fd:cf:54:ef:2a:6a:08:2a:0a:72:de:35:80:3e:2f:f5:ff:52:7a:e5:d8:72:06:df:d5 +-----BEGIN CERTIFICATE----- +MIIFsDCCA5igAwIBAgIQFci9ZUdcr7iXAF7kBtK8nTANBgkqhkiG9w0BAQUFADBe +MQswCQYDVQQGEwJUVzEjMCEGA1UECgwaQ2h1bmdod2EgVGVsZWNvbSBDby4sIEx0 +ZC4xKjAoBgNVBAsMIWVQS0kgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAe +Fw0wNDEyMjAwMjMxMjdaFw0zNDEyMjAwMjMxMjdaMF4xCzAJBgNVBAYTAlRXMSMw +IQYDVQQKDBpDaHVuZ2h3YSBUZWxlY29tIENvLiwgTHRkLjEqMCgGA1UECwwhZVBL +SSBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIICIjANBgkqhkiG9w0BAQEF +AAOCAg8AMIICCgKCAgEA4SUP7o3biDN1Z82tH306Tm2d0y8U82N0ywEhajfqhFAH +SyZbCUNsIZ5qyNUD9WBpj8zwIuQf5/dqIjG3LBXy4P4AakP/h2XGtRrBp0xtInAh +ijHyl3SJCRImHJ7K2RKilTza6We/CKBk49ZCt0Xvl/T29de1ShUCWH2YWEtgvM3X +DZoTM1PRYfl61dd4s5oz9wCGzh1NlDivqOx4UXCKXBCDUSH3ET00hl7lSM2XgYI1 +TBnsZfZrxQWh7kcT1rMhJ5QQCtkkO7q+RBNGMD+XPNjX12ruOzjjK9SXDrkb5wdJ +fzcq+Xd4z1TtW0ado4AOkUPB1ltfFLqfpo0kR0BZv3I4sjZsN/+Z0V0OWQqraffA +sgRFelQArr5T9rXn4fg8ozHSqf4hUmTFpmfwdQcGlBSBVcYn5AGPF8Fqcde+S/uU +WH1+ETOxQvdibBjWzwloPn9s9h6PYq2lY9sJpx8iQkEeb5mKPtf5P0B6ebClAZLS +nT0IFaUQAS2zMnaolQ2zepr7BxB4EW/hj8e6DyUadCrlHJhBmd8hh+iVBmoKs2pH +dmX2Os+PYhcZewoozRrSgx4hxyy/vv9haLdnG7t4TY3OZ+XkwY63I2binZB1NJip +NiuKmpS5nezMirH4JYlcWrYvjB9teSSnUmjDhDXiZo1jDiVN1Rmy5nk3pyKdVDEC +AwEAAaNqMGgwHQYDVR0OBBYEFB4M97Zn8uGSJglFwFU5Lnc/QkqiMAwGA1UdEwQF +MAMBAf8wOQYEZyoHAAQxMC8wLQIBADAJBgUrDgMCGgUAMAcGBWcqAwAABBRFsMLH +ClZ87lt4DJX5GFPBphzYEDANBgkqhkiG9w0BAQUFAAOCAgEACbODU1kBPpVJufGB +uvl2ICO1J2B01GqZNF5sAFPZn/KmsSQHRGoqxqWOeBLoR9lYGxMqXnmbnwoqZ6Yl +PwZpVnPDimZI+ymBV3QGypzqKOg4ZyYr8dW1P2WT+DZdjo2NQCCHGervJ8A9tDkP +JXtoUHRVnAxZfVo9QZQlUgjgRywVMRnVvwdVxrsStZf0X4OFunHB2WyBEXYKCrC/ +gpf36j36+uwtqSiUO1bd0lEursC9CBWMd1I0ltabrNMdjmEPNXubrjlpC2JgQCA2 +j6/7Nu4tCEoduL+bXPjqpRugc6bY+G7gMwRfaKonh+3ZwZCc7b3jajWvY9+rGNm6 +5ulK6lCKD2GTHuItGeIwlDWSXQ62B68ZgI9HkFFLLk3dheLSClIKF5r8GrBQAuUB +o2M3IUxExJtRmREOc5wGj1QupyheRDmHVi03vYVElOEMSyycw5KFNGHLD7ibSkNS +/jQ6fbjpKdx2qcgw+BRxgMYeNkh0IkFch4LoGHGLQYlE535YW6i4jRPpp2zDR+2z +Gp1iro2C6pSe3VkQw63d4k3jMdXH7OjysP6SHhYKGvzZ8/gntsm+HbRsZJB/9OTE +W9c3rkIO3aQab3yIVMUWbuF6aC74Or8NpDyJO3inTmODBCEIZ43ygknQW/2xzQ+D +hNQ+IIX3Sj0rnP0qCglN6oH4EZw= +-----END CERTIFICATE----- + +# Issuer: O=certSIGN OU=certSIGN ROOT CA +# Subject: O=certSIGN OU=certSIGN ROOT CA +# Label: "certSIGN ROOT CA" +# Serial: 35210227249154 +# MD5 Fingerprint: 18:98:c0:d6:e9:3a:fc:f9:b0:f5:0c:f7:4b:01:44:17 +# SHA1 Fingerprint: fa:b7:ee:36:97:26:62:fb:2d:b0:2a:f6:bf:03:fd:e8:7c:4b:2f:9b +# SHA256 Fingerprint: ea:a9:62:c4:fa:4a:6b:af:eb:e4:15:19:6d:35:1c:cd:88:8d:4f:53:f3:fa:8a:e6:d7:c4:66:a9:4e:60:42:bb +-----BEGIN CERTIFICATE----- +MIIDODCCAiCgAwIBAgIGIAYFFnACMA0GCSqGSIb3DQEBBQUAMDsxCzAJBgNVBAYT +AlJPMREwDwYDVQQKEwhjZXJ0U0lHTjEZMBcGA1UECxMQY2VydFNJR04gUk9PVCBD +QTAeFw0wNjA3MDQxNzIwMDRaFw0zMTA3MDQxNzIwMDRaMDsxCzAJBgNVBAYTAlJP +MREwDwYDVQQKEwhjZXJ0U0lHTjEZMBcGA1UECxMQY2VydFNJR04gUk9PVCBDQTCC +ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALczuX7IJUqOtdu0KBuqV5Do +0SLTZLrTk+jUrIZhQGpgV2hUhE28alQCBf/fm5oqrl0Hj0rDKH/v+yv6efHHrfAQ +UySQi2bJqIirr1qjAOm+ukbuW3N7LBeCgV5iLKECZbO9xSsAfsT8AzNXDe3i+s5d +RdY4zTW2ssHQnIFKquSyAVwdj1+ZxLGt24gh65AIgoDzMKND5pCCrlUoSe1b16kQ +OA7+j0xbm0bqQfWwCHTD0IgztnzXdN/chNFDDnU5oSVAKOp4yw4sLjmdjItuFhwv +JoIQ4uNllAoEwF73XVv4EOLQunpL+943AAAaWyjj0pxzPjKHmKHJUS/X3qwzs08C +AwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAcYwHQYDVR0O +BBYEFOCMm9slSbPxfIbWskKHC9BroNnkMA0GCSqGSIb3DQEBBQUAA4IBAQA+0hyJ +LjX8+HXd5n9liPRyTMks1zJO890ZeUe9jjtbkw9QSSQTaxQGcu8J06Gh40CEyecY +MnQ8SG4Pn0vU9x7Tk4ZkVJdjclDVVc/6IJMCopvDI5NOFlV2oHB5bc0hH88vLbwZ +44gx+FkagQnIl6Z0x2DEW8xXjrJ1/RsCCdtZb3KTafcxQdaIOL+Hsr0Wefmq5L6I +Jd1hJyMctTEHBDa0GpC9oHRxUIltvBTjD4au8as+x6AJzKNI0eDbZOeStc+vckNw +i/nDhDwTqn6Sm1dTk/pwwpEOMfmbZ13pljheX7NzTogVZ96edhBiIL5VaZVDADlN +9u6wWk5JRFRYX0KD +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Primary Certification Authority - G3 O=GeoTrust Inc. OU=(c) 2008 GeoTrust Inc. - For authorized use only +# Subject: CN=GeoTrust Primary Certification Authority - G3 O=GeoTrust Inc. OU=(c) 2008 GeoTrust Inc. - For authorized use only +# Label: "GeoTrust Primary Certification Authority - G3" +# Serial: 28809105769928564313984085209975885599 +# MD5 Fingerprint: b5:e8:34:36:c9:10:44:58:48:70:6d:2e:83:d4:b8:05 +# SHA1 Fingerprint: 03:9e:ed:b8:0b:e7:a0:3c:69:53:89:3b:20:d2:d9:32:3a:4c:2a:fd +# SHA256 Fingerprint: b4:78:b8:12:25:0d:f8:78:63:5c:2a:a7:ec:7d:15:5e:aa:62:5e:e8:29:16:e2:cd:29:43:61:88:6c:d1:fb:d4 +-----BEGIN CERTIFICATE----- +MIID/jCCAuagAwIBAgIQFaxulBmyeUtB9iepwxgPHzANBgkqhkiG9w0BAQsFADCB +mDELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUdlb1RydXN0IEluYy4xOTA3BgNVBAsT +MChjKSAyMDA4IEdlb1RydXN0IEluYy4gLSBGb3IgYXV0aG9yaXplZCB1c2Ugb25s +eTE2MDQGA1UEAxMtR2VvVHJ1c3QgUHJpbWFyeSBDZXJ0aWZpY2F0aW9uIEF1dGhv +cml0eSAtIEczMB4XDTA4MDQwMjAwMDAwMFoXDTM3MTIwMTIzNTk1OVowgZgxCzAJ +BgNVBAYTAlVTMRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMTkwNwYDVQQLEzAoYykg +MjAwOCBHZW9UcnVzdCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxNjA0 +BgNVBAMTLUdlb1RydXN0IFByaW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkg +LSBHMzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANziXmJYHTNXOTIz ++uvLh4yn1ErdBojqZI4xmKU4kB6Yzy5jK/BGvESyiaHAKAxJcCGVn2TAppMSAmUm +hsalifD614SgcK9PGpc/BkTVyetyEH3kMSj7HGHmKAdEc5IiaacDiGydY8hS2pgn +5whMcD60yRLBxWeDXTPzAxHsatBT4tG6NmCUgLthY2xbF37fQJQeqw3CIShwiP/W +JmxsYAQlTlV+fe+/lEjetx3dcI0FX4ilm/LC7urRQEFtYjgdVgbFA0dRIBn8exAL +DmKudlW/X3e+PkkBUz2YJQN2JFodtNuJ6nnltrM7P7pMKEF/BqxqjsHQ9gUdfeZC +huOl1UcCAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYw +HQYDVR0OBBYEFMR5yo6hTgMdHNxr2zFblD4/MH8tMA0GCSqGSIb3DQEBCwUAA4IB +AQAtxRPPVoB7eni9n64smefv2t+UXglpp+duaIy9cr5HqQ6XErhK8WTTOd8lNNTB +zU6B8A8ExCSzNJbGpqow32hhc9f5joWJ7w5elShKKiePEI4ufIbEAp7aDHdlDkQN +kv39sxY2+hENHYwOB4lqKVb3cvTdFZx3NWZXqxNT2I7BQMXXExZacse3aQHEerGD +AWh9jUGhlBjBJVz88P6DAod8DQ3PLghcSkANPuyBYeYk28rgDi0Hsj5W3I31QYUH +SJsMC8tJP33st/3LjWeJGqvtux6jAAgIFyqCXDFdRootD4abdNlF+9RAsXqqaC2G +spki4cErx5z481+oghLrGREt +-----END CERTIFICATE----- + +# Issuer: CN=thawte Primary Root CA - G2 O=thawte, Inc. OU=(c) 2007 thawte, Inc. - For authorized use only +# Subject: CN=thawte Primary Root CA - G2 O=thawte, Inc. OU=(c) 2007 thawte, Inc. - For authorized use only +# Label: "thawte Primary Root CA - G2" +# Serial: 71758320672825410020661621085256472406 +# MD5 Fingerprint: 74:9d:ea:60:24:c4:fd:22:53:3e:cc:3a:72:d9:29:4f +# SHA1 Fingerprint: aa:db:bc:22:23:8f:c4:01:a1:27:bb:38:dd:f4:1d:db:08:9e:f0:12 +# SHA256 Fingerprint: a4:31:0d:50:af:18:a6:44:71:90:37:2a:86:af:af:8b:95:1f:fb:43:1d:83:7f:1e:56:88:b4:59:71:ed:15:57 +-----BEGIN CERTIFICATE----- +MIICiDCCAg2gAwIBAgIQNfwmXNmET8k9Jj1Xm67XVjAKBggqhkjOPQQDAzCBhDEL +MAkGA1UEBhMCVVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5jLjE4MDYGA1UECxMvKGMp +IDIwMDcgdGhhd3RlLCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxJDAi +BgNVBAMTG3RoYXd0ZSBQcmltYXJ5IFJvb3QgQ0EgLSBHMjAeFw0wNzExMDUwMDAw +MDBaFw0zODAxMTgyMzU5NTlaMIGEMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMdGhh +d3RlLCBJbmMuMTgwNgYDVQQLEy8oYykgMjAwNyB0aGF3dGUsIEluYy4gLSBGb3Ig +YXV0aG9yaXplZCB1c2Ugb25seTEkMCIGA1UEAxMbdGhhd3RlIFByaW1hcnkgUm9v +dCBDQSAtIEcyMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEotWcgnuVnfFSeIf+iha/ +BebfowJPDQfGAFG6DAJSLSKkQjnE/o/qycG+1E3/n3qe4rF8mq2nhglzh9HnmuN6 +papu+7qzcMBniKI11KOasf2twu8x+qi58/sIxpHR+ymVo0IwQDAPBgNVHRMBAf8E +BTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUmtgAMADna3+FGO6Lts6K +DPgR4bswCgYIKoZIzj0EAwMDaQAwZgIxAN344FdHW6fmCsO99YCKlzUNG4k8VIZ3 +KMqh9HneteY4sPBlcIx/AlTCv//YoT7ZzwIxAMSNlPzcU9LcnXgWHxUzI1NS41ox +XZ3Krr0TKUQNJ1uo52icEvdYPy5yAlejj6EULg== +-----END CERTIFICATE----- + +# Issuer: CN=thawte Primary Root CA - G3 O=thawte, Inc. OU=Certification Services Division/(c) 2008 thawte, Inc. - For authorized use only +# Subject: CN=thawte Primary Root CA - G3 O=thawte, Inc. OU=Certification Services Division/(c) 2008 thawte, Inc. - For authorized use only +# Label: "thawte Primary Root CA - G3" +# Serial: 127614157056681299805556476275995414779 +# MD5 Fingerprint: fb:1b:5d:43:8a:94:cd:44:c6:76:f2:43:4b:47:e7:31 +# SHA1 Fingerprint: f1:8b:53:8d:1b:e9:03:b6:a6:f0:56:43:5b:17:15:89:ca:f3:6b:f2 +# SHA256 Fingerprint: 4b:03:f4:58:07:ad:70:f2:1b:fc:2c:ae:71:c9:fd:e4:60:4c:06:4c:f5:ff:b6:86:ba:e5:db:aa:d7:fd:d3:4c +-----BEGIN CERTIFICATE----- +MIIEKjCCAxKgAwIBAgIQYAGXt0an6rS0mtZLL/eQ+zANBgkqhkiG9w0BAQsFADCB +rjELMAkGA1UEBhMCVVMxFTATBgNVBAoTDHRoYXd0ZSwgSW5jLjEoMCYGA1UECxMf +Q2VydGlmaWNhdGlvbiBTZXJ2aWNlcyBEaXZpc2lvbjE4MDYGA1UECxMvKGMpIDIw +MDggdGhhd3RlLCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxJDAiBgNV +BAMTG3RoYXd0ZSBQcmltYXJ5IFJvb3QgQ0EgLSBHMzAeFw0wODA0MDIwMDAwMDBa +Fw0zNzEyMDEyMzU5NTlaMIGuMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMdGhhd3Rl +LCBJbmMuMSgwJgYDVQQLEx9DZXJ0aWZpY2F0aW9uIFNlcnZpY2VzIERpdmlzaW9u +MTgwNgYDVQQLEy8oYykgMjAwOCB0aGF3dGUsIEluYy4gLSBGb3IgYXV0aG9yaXpl +ZCB1c2Ugb25seTEkMCIGA1UEAxMbdGhhd3RlIFByaW1hcnkgUm9vdCBDQSAtIEcz +MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsr8nLPvb2FvdeHsbnndm +gcs+vHyu86YnmjSjaDFxODNi5PNxZnmxqWWjpYvVj2AtP0LMqmsywCPLLEHd5N/8 +YZzic7IilRFDGF/Eth9XbAoFWCLINkw6fKXRz4aviKdEAhN0cXMKQlkC+BsUa0Lf +b1+6a4KinVvnSr0eAXLbS3ToO39/fR8EtCab4LRarEc9VbjXsCZSKAExQGbY2SS9 +9irY7CFJXJv2eul/VTV+lmuNk5Mny5K76qxAwJ/C+IDPXfRa3M50hqY+bAtTyr2S +zhkGcuYMXDhpxwTWvGzOW/b3aJzcJRVIiKHpqfiYnODz1TEoYRFsZ5aNOZnLwkUk +OQIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNV +HQ4EFgQUrWyqlGCc7eT/+j4KdCtjA/e2Wb8wDQYJKoZIhvcNAQELBQADggEBABpA +2JVlrAmSicY59BDlqQ5mU1143vokkbvnRFHfxhY0Cu9qRFHqKweKA3rD6z8KLFIW +oCtDuSWQP3CpMyVtRRooOyfPqsMpQhvfO0zAMzRbQYi/aytlryjvsvXDqmbOe1bu +t8jLZ8HJnBoYuMTDSQPxYA5QzUbF83d597YV4Djbxy8ooAw/dyZ02SUS2jHaGh7c +KUGRIjxpp7sC8rZcJwOJ9Abqm+RyguOhCcHpABnTPtRwa7pxpqpYrvS76Wy274fM +m7v/OeZWYdMKp8RcTGB7BXcmer/YB1IsYvdwY9k5vG8cwnncdimvzsUsZAReiDZu +MdRAGmI0Nj81Aa6sY6A= +-----END CERTIFICATE----- + +# Issuer: CN=GeoTrust Primary Certification Authority - G2 O=GeoTrust Inc. OU=(c) 2007 GeoTrust Inc. - For authorized use only +# Subject: CN=GeoTrust Primary Certification Authority - G2 O=GeoTrust Inc. OU=(c) 2007 GeoTrust Inc. - For authorized use only +# Label: "GeoTrust Primary Certification Authority - G2" +# Serial: 80682863203381065782177908751794619243 +# MD5 Fingerprint: 01:5e:d8:6b:bd:6f:3d:8e:a1:31:f8:12:e0:98:73:6a +# SHA1 Fingerprint: 8d:17:84:d5:37:f3:03:7d:ec:70:fe:57:8b:51:9a:99:e6:10:d7:b0 +# SHA256 Fingerprint: 5e:db:7a:c4:3b:82:a0:6a:87:61:e8:d7:be:49:79:eb:f2:61:1f:7d:d7:9b:f9:1c:1c:6b:56:6a:21:9e:d7:66 +-----BEGIN CERTIFICATE----- +MIICrjCCAjWgAwIBAgIQPLL0SAoA4v7rJDteYD7DazAKBggqhkjOPQQDAzCBmDEL +MAkGA1UEBhMCVVMxFjAUBgNVBAoTDUdlb1RydXN0IEluYy4xOTA3BgNVBAsTMChj +KSAyMDA3IEdlb1RydXN0IEluYy4gLSBGb3IgYXV0aG9yaXplZCB1c2Ugb25seTE2 +MDQGA1UEAxMtR2VvVHJ1c3QgUHJpbWFyeSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0 +eSAtIEcyMB4XDTA3MTEwNTAwMDAwMFoXDTM4MDExODIzNTk1OVowgZgxCzAJBgNV +BAYTAlVTMRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMTkwNwYDVQQLEzAoYykgMjAw +NyBHZW9UcnVzdCBJbmMuIC0gRm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxNjA0BgNV +BAMTLUdlb1RydXN0IFByaW1hcnkgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgLSBH +MjB2MBAGByqGSM49AgEGBSuBBAAiA2IABBWx6P0DFUPlrOuHNxFi79KDNlJ9RVcL +So17VDs6bl8VAsBQps8lL33KSLjHUGMcKiEIfJo22Av+0SbFWDEwKCXzXV2juLal +tJLtbCyf691DiaI8S0iRHVDsJt/WYC69IaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAO +BgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFBVfNVdRVfslsq0DafwBo/q+EVXVMAoG +CCqGSM49BAMDA2cAMGQCMGSWWaboCd6LuvpaiIjwH5HTRqjySkwCY/tsXzjbLkGT +qQ7mndwxHLKgpxgceeHHNgIwOlavmnRs9vuD4DPTCF+hnMJbn0bWtsuRBmOiBucz +rD6ogRLQy7rQkgu2npaqBA+K +-----END CERTIFICATE----- + +# Issuer: CN=VeriSign Universal Root Certification Authority O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2008 VeriSign, Inc. - For authorized use only +# Subject: CN=VeriSign Universal Root Certification Authority O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2008 VeriSign, Inc. - For authorized use only +# Label: "VeriSign Universal Root Certification Authority" +# Serial: 85209574734084581917763752644031726877 +# MD5 Fingerprint: 8e:ad:b5:01:aa:4d:81:e4:8c:1d:d1:e1:14:00:95:19 +# SHA1 Fingerprint: 36:79:ca:35:66:87:72:30:4d:30:a5:fb:87:3b:0f:a7:7b:b7:0d:54 +# SHA256 Fingerprint: 23:99:56:11:27:a5:71:25:de:8c:ef:ea:61:0d:df:2f:a0:78:b5:c8:06:7f:4e:82:82:90:bf:b8:60:e8:4b:3c +-----BEGIN CERTIFICATE----- +MIIEuTCCA6GgAwIBAgIQQBrEZCGzEyEDDrvkEhrFHTANBgkqhkiG9w0BAQsFADCB +vTELMAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQL +ExZWZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwOCBWZXJp +U2lnbiwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MTgwNgYDVQQDEy9W +ZXJpU2lnbiBVbml2ZXJzYWwgUm9vdCBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTAe +Fw0wODA0MDIwMDAwMDBaFw0zNzEyMDEyMzU5NTlaMIG9MQswCQYDVQQGEwJVUzEX +MBUGA1UEChMOVmVyaVNpZ24sIEluYy4xHzAdBgNVBAsTFlZlcmlTaWduIFRydXN0 +IE5ldHdvcmsxOjA4BgNVBAsTMShjKSAyMDA4IFZlcmlTaWduLCBJbmMuIC0gRm9y +IGF1dGhvcml6ZWQgdXNlIG9ubHkxODA2BgNVBAMTL1ZlcmlTaWduIFVuaXZlcnNh +bCBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIIBIjANBgkqhkiG9w0BAQEF +AAOCAQ8AMIIBCgKCAQEAx2E3XrEBNNti1xWb/1hajCMj1mCOkdeQmIN65lgZOIzF +9uVkhbSicfvtvbnazU0AtMgtc6XHaXGVHzk8skQHnOgO+k1KxCHfKWGPMiJhgsWH +H26MfF8WIFFE0XBPV+rjHOPMee5Y2A7Cs0WTwCznmhcrewA3ekEzeOEz4vMQGn+H +LL729fdC4uW/h2KJXwBL38Xd5HVEMkE6HnFuacsLdUYI0crSK5XQz/u5QGtkjFdN +/BMReYTtXlT2NJ8IAfMQJQYXStrxHXpma5hgZqTZ79IugvHw7wnqRMkVauIDbjPT +rJ9VAMf2CGqUuV/c4DPxhGD5WycRtPwW8rtWaoAljQIDAQABo4GyMIGvMA8GA1Ud +EwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMG0GCCsGAQUFBwEMBGEwX6FdoFsw +WTBXMFUWCWltYWdlL2dpZjAhMB8wBwYFKw4DAhoEFI/l0xqGrI2Oa8PPgGrUSBgs +exkuMCUWI2h0dHA6Ly9sb2dvLnZlcmlzaWduLmNvbS92c2xvZ28uZ2lmMB0GA1Ud +DgQWBBS2d/ppSEefUxLVwuoHMnYH0ZcHGTANBgkqhkiG9w0BAQsFAAOCAQEASvj4 +sAPmLGd75JR3Y8xuTPl9Dg3cyLk1uXBPY/ok+myDjEedO2Pzmvl2MpWRsXe8rJq+ +seQxIcaBlVZaDrHC1LGmWazxY8u4TB1ZkErvkBYoH1quEPuBUDgMbMzxPcP1Y+Oz +4yHJJDnp/RVmRvQbEdBNc6N9Rvk97ahfYtTxP/jgdFcrGJ2BtMQo2pSXpXDrrB2+ +BxHw1dvd5Yzw1TKwg+ZX4o+/vqGqvz0dtdQ46tewXDpPaj+PwGZsY6rp2aQW9IHR +lRQOfc2VNNnSj3BzgXucfr2YYdhFh5iQxeuGMMY1v/D/w1WIg0vvBZIGcfK4mJO3 +7M2CYfE45k+XmCpajQ== +-----END CERTIFICATE----- + +# Issuer: CN=VeriSign Class 3 Public Primary Certification Authority - G4 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2007 VeriSign, Inc. - For authorized use only +# Subject: CN=VeriSign Class 3 Public Primary Certification Authority - G4 O=VeriSign, Inc. OU=VeriSign Trust Network/(c) 2007 VeriSign, Inc. - For authorized use only +# Label: "VeriSign Class 3 Public Primary Certification Authority - G4" +# Serial: 63143484348153506665311985501458640051 +# MD5 Fingerprint: 3a:52:e1:e7:fd:6f:3a:e3:6f:f3:6f:99:1b:f9:22:41 +# SHA1 Fingerprint: 22:d5:d8:df:8f:02:31:d1:8d:f7:9d:b7:cf:8a:2d:64:c9:3f:6c:3a +# SHA256 Fingerprint: 69:dd:d7:ea:90:bb:57:c9:3e:13:5d:c8:5e:a6:fc:d5:48:0b:60:32:39:bd:c4:54:fc:75:8b:2a:26:cf:7f:79 +-----BEGIN CERTIFICATE----- +MIIDhDCCAwqgAwIBAgIQL4D+I4wOIg9IZxIokYesszAKBggqhkjOPQQDAzCByjEL +MAkGA1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQLExZW +ZXJpU2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwNyBWZXJpU2ln +biwgSW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MUUwQwYDVQQDEzxWZXJp +U2lnbiBDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9y +aXR5IC0gRzQwHhcNMDcxMTA1MDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCByjELMAkG +A1UEBhMCVVMxFzAVBgNVBAoTDlZlcmlTaWduLCBJbmMuMR8wHQYDVQQLExZWZXJp +U2lnbiBUcnVzdCBOZXR3b3JrMTowOAYDVQQLEzEoYykgMjAwNyBWZXJpU2lnbiwg +SW5jLiAtIEZvciBhdXRob3JpemVkIHVzZSBvbmx5MUUwQwYDVQQDEzxWZXJpU2ln +biBDbGFzcyAzIFB1YmxpYyBQcmltYXJ5IENlcnRpZmljYXRpb24gQXV0aG9yaXR5 +IC0gRzQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAASnVnp8Utpkmw4tXNherJI9/gHm +GUo9FANL+mAnINmDiWn6VMaaGF5VKmTeBvaNSjutEDxlPZCIBIngMGGzrl0Bp3ve +fLK+ymVhAIau2o970ImtTR1ZmkGxvEeA3J5iw/mjgbIwga8wDwYDVR0TAQH/BAUw +AwEB/zAOBgNVHQ8BAf8EBAMCAQYwbQYIKwYBBQUHAQwEYTBfoV2gWzBZMFcwVRYJ +aW1hZ2UvZ2lmMCEwHzAHBgUrDgMCGgQUj+XTGoasjY5rw8+AatRIGCx7GS4wJRYj +aHR0cDovL2xvZ28udmVyaXNpZ24uY29tL3ZzbG9nby5naWYwHQYDVR0OBBYEFLMW +kf3upm7ktS5Jj4d4gYDs5bG1MAoGCCqGSM49BAMDA2gAMGUCMGYhDBgmYFo4e1ZC +4Kf8NoRRkSAsdk1DPcQdhCPQrNZ8NQbOzWm9kA3bbEhCHQ6qQgIxAJw9SDkjOVga +FRJZap7v1VmyHVIsmXHNxynfGyphe3HR3vPA5Q06Sqotp9iGKt0uEA== +-----END CERTIFICATE----- + +# Issuer: CN=NetLock Arany (Class Gold) F\u0151tan\xfas\xedtv\xe1ny O=NetLock Kft. OU=Tan\xfas\xedtv\xe1nykiad\xf3k (Certification Services) +# Subject: CN=NetLock Arany (Class Gold) F\u0151tan\xfas\xedtv\xe1ny O=NetLock Kft. OU=Tan\xfas\xedtv\xe1nykiad\xf3k (Certification Services) +# Label: "NetLock Arany (Class Gold) F\u0151tan\xfas\xedtv\xe1ny" +# Serial: 80544274841616 +# MD5 Fingerprint: c5:a1:b7:ff:73:dd:d6:d7:34:32:18:df:fc:3c:ad:88 +# SHA1 Fingerprint: 06:08:3f:59:3f:15:a1:04:a0:69:a4:6b:a9:03:d0:06:b7:97:09:91 +# SHA256 Fingerprint: 6c:61:da:c3:a2:de:f0:31:50:6b:e0:36:d2:a6:fe:40:19:94:fb:d1:3d:f9:c8:d4:66:59:92:74:c4:46:ec:98 +-----BEGIN CERTIFICATE----- +MIIEFTCCAv2gAwIBAgIGSUEs5AAQMA0GCSqGSIb3DQEBCwUAMIGnMQswCQYDVQQG +EwJIVTERMA8GA1UEBwwIQnVkYXBlc3QxFTATBgNVBAoMDE5ldExvY2sgS2Z0LjE3 +MDUGA1UECwwuVGFuw7pzw610dsOhbnlraWFkw7NrIChDZXJ0aWZpY2F0aW9uIFNl +cnZpY2VzKTE1MDMGA1UEAwwsTmV0TG9jayBBcmFueSAoQ2xhc3MgR29sZCkgRsWR +dGFuw7pzw610dsOhbnkwHhcNMDgxMjExMTUwODIxWhcNMjgxMjA2MTUwODIxWjCB +pzELMAkGA1UEBhMCSFUxETAPBgNVBAcMCEJ1ZGFwZXN0MRUwEwYDVQQKDAxOZXRM +b2NrIEtmdC4xNzA1BgNVBAsMLlRhbsO6c8OtdHbDoW55a2lhZMOzayAoQ2VydGlm +aWNhdGlvbiBTZXJ2aWNlcykxNTAzBgNVBAMMLE5ldExvY2sgQXJhbnkgKENsYXNz +IEdvbGQpIEbFkXRhbsO6c8OtdHbDoW55MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A +MIIBCgKCAQEAxCRec75LbRTDofTjl5Bu0jBFHjzuZ9lk4BqKf8owyoPjIMHj9DrT +lF8afFttvzBPhCf2nx9JvMaZCpDyD/V/Q4Q3Y1GLeqVw/HpYzY6b7cNGbIRwXdrz +AZAj/E4wqX7hJ2Pn7WQ8oLjJM2P+FpD/sLj916jAwJRDC7bVWaaeVtAkH3B5r9s5 +VA1lddkVQZQBr17s9o3x/61k/iCa11zr/qYfCGSji3ZVrR47KGAuhyXoqq8fxmRG +ILdwfzzeSNuWU7c5d+Qa4scWhHaXWy+7GRWF+GmF9ZmnqfI0p6m2pgP8b4Y9VHx2 +BJtr+UBdADTHLpl1neWIA6pN+APSQnbAGwIDAKiLo0UwQzASBgNVHRMBAf8ECDAG +AQH/AgEEMA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUzPpnk/C2uNClwB7zU/2M +U9+D15YwDQYJKoZIhvcNAQELBQADggEBAKt/7hwWqZw8UQCgwBEIBaeZ5m8BiFRh +bvG5GK1Krf6BQCOUL/t1fC8oS2IkgYIL9WHxHG64YTjrgfpioTtaYtOUZcTh5m2C ++C8lcLIhJsFyUR+MLMOEkMNaj7rP9KdlpeuY0fsFskZ1FSNqb4VjMIDw1Z4fKRzC +bLBQWV2QWzuoDTDPv31/zvGdg73JRm4gpvlhUbohL3u+pRVjodSVh/GeufOJ8z2F +uLjbvrW5KfnaNwUASZQDhETnv0Mxz3WLJdH0pmT1kvarBes96aULNmLazAZfNou2 +XjG4Kvte9nHfRCaexOYNkbQudZWAUWpLMKawYqGT8ZvYzsRjdT9ZR7E= +-----END CERTIFICATE----- + +# Issuer: CN=Staat der Nederlanden Root CA - G2 O=Staat der Nederlanden +# Subject: CN=Staat der Nederlanden Root CA - G2 O=Staat der Nederlanden +# Label: "Staat der Nederlanden Root CA - G2" +# Serial: 10000012 +# MD5 Fingerprint: 7c:a5:0f:f8:5b:9a:7d:6d:30:ae:54:5a:e3:42:a2:8a +# SHA1 Fingerprint: 59:af:82:79:91:86:c7:b4:75:07:cb:cf:03:57:46:eb:04:dd:b7:16 +# SHA256 Fingerprint: 66:8c:83:94:7d:a6:3b:72:4b:ec:e1:74:3c:31:a0:e6:ae:d0:db:8e:c5:b3:1b:e3:77:bb:78:4f:91:b6:71:6f +-----BEGIN CERTIFICATE----- +MIIFyjCCA7KgAwIBAgIEAJiWjDANBgkqhkiG9w0BAQsFADBaMQswCQYDVQQGEwJO +TDEeMBwGA1UECgwVU3RhYXQgZGVyIE5lZGVybGFuZGVuMSswKQYDVQQDDCJTdGFh +dCBkZXIgTmVkZXJsYW5kZW4gUm9vdCBDQSAtIEcyMB4XDTA4MDMyNjExMTgxN1oX +DTIwMDMyNTExMDMxMFowWjELMAkGA1UEBhMCTkwxHjAcBgNVBAoMFVN0YWF0IGRl +ciBOZWRlcmxhbmRlbjErMCkGA1UEAwwiU3RhYXQgZGVyIE5lZGVybGFuZGVuIFJv +b3QgQ0EgLSBHMjCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMVZ5291 +qj5LnLW4rJ4L5PnZyqtdj7U5EILXr1HgO+EASGrP2uEGQxGZqhQlEq0i6ABtQ8Sp +uOUfiUtnvWFI7/3S4GCI5bkYYCjDdyutsDeqN95kWSpGV+RLufg3fNU254DBtvPU +Z5uW6M7XxgpT0GtJlvOjCwV3SPcl5XCsMBQgJeN/dVrlSPhOewMHBPqCYYdu8DvE +pMfQ9XQ+pV0aCPKbJdL2rAQmPlU6Yiile7Iwr/g3wtG61jj99O9JMDeZJiFIhQGp +5Rbn3JBV3w/oOM2ZNyFPXfUib2rFEhZgF1XyZWampzCROME4HYYEhLoaJXhena/M +UGDWE4dS7WMfbWV9whUYdMrhfmQpjHLYFhN9C0lK8SgbIHRrxT3dsKpICT0ugpTN +GmXZK4iambwYfp/ufWZ8Pr2UuIHOzZgweMFvZ9C+X+Bo7d7iscksWXiSqt8rYGPy +5V6548r6f1CGPqI0GAwJaCgRHOThuVw+R7oyPxjMW4T182t0xHJ04eOLoEq9jWYv +6q012iDTiIJh8BIitrzQ1aTsr1SIJSQ8p22xcik/Plemf1WvbibG/ufMQFxRRIEK +eN5KzlW/HdXZt1bv8Hb/C3m1r737qWmRRpdogBQ2HbN/uymYNqUg+oJgYjOk7Na6 +B6duxc8UpufWkjTYgfX8HV2qXB72o007uPc5AgMBAAGjgZcwgZQwDwYDVR0TAQH/ +BAUwAwEB/zBSBgNVHSAESzBJMEcGBFUdIAAwPzA9BggrBgEFBQcCARYxaHR0cDov +L3d3dy5wa2lvdmVyaGVpZC5ubC9wb2xpY2llcy9yb290LXBvbGljeS1HMjAOBgNV +HQ8BAf8EBAMCAQYwHQYDVR0OBBYEFJFoMocVHYnitfGsNig0jQt8YojrMA0GCSqG +SIb3DQEBCwUAA4ICAQCoQUpnKpKBglBu4dfYszk78wIVCVBR7y29JHuIhjv5tLyS +CZa59sCrI2AGeYwRTlHSeYAz+51IvuxBQ4EffkdAHOV6CMqqi3WtFMTC6GY8ggen +5ieCWxjmD27ZUD6KQhgpxrRW/FYQoAUXvQwjf/ST7ZwaUb7dRUG/kSS0H4zpX897 +IZmflZ85OkYcbPnNe5yQzSipx6lVu6xiNGI1E0sUOlWDuYaNkqbG9AclVMwWVxJK +gnjIFNkXgiYtXSAfea7+1HAWFpWD2DU5/1JddRwWxRNVz0fMdWVSSt7wsKfkCpYL ++63C4iWEst3kvX5ZbJvw8NjnyvLplzh+ib7M+zkXYT9y2zqR2GUBGR2tUKRXCnxL +vJxxcypFURmFzI79R6d0lR2o0a9OF7FpJsKqeFdbxU2n5Z4FF5TKsl+gSRiNNOkm +bEgeqmiSBeGCc1qb3AdbCG19ndeNIdn8FCCqwkXfP+cAslHkwvgFuXkajDTznlvk +N1trSt8sV4pAWja63XVECDdCcAz+3F4hoKOKwJCcaNpQ5kUQR3i2TtJlycM33+FC +Y7BXN0Ute4qcvwXqZVUz9zkQxSgqIXobisQk+T8VyJoVIPVVYpbtbZNQvOSqeK3Z +ywplh6ZmwcSBo3c6WB4L7oOLnR7SUqTMHW+wmG2UMbX4cQrcufx9MmDm66+KAQ== +-----END CERTIFICATE----- + +# Issuer: CN=Hongkong Post Root CA 1 O=Hongkong Post +# Subject: CN=Hongkong Post Root CA 1 O=Hongkong Post +# Label: "Hongkong Post Root CA 1" +# Serial: 1000 +# MD5 Fingerprint: a8:0d:6f:39:78:b9:43:6d:77:42:6d:98:5a:cc:23:ca +# SHA1 Fingerprint: d6:da:a8:20:8d:09:d2:15:4d:24:b5:2f:cb:34:6e:b2:58:b2:8a:58 +# SHA256 Fingerprint: f9:e6:7d:33:6c:51:00:2a:c0:54:c6:32:02:2d:66:dd:a2:e7:e3:ff:f1:0a:d0:61:ed:31:d8:bb:b4:10:cf:b2 +-----BEGIN CERTIFICATE----- +MIIDMDCCAhigAwIBAgICA+gwDQYJKoZIhvcNAQEFBQAwRzELMAkGA1UEBhMCSEsx +FjAUBgNVBAoTDUhvbmdrb25nIFBvc3QxIDAeBgNVBAMTF0hvbmdrb25nIFBvc3Qg +Um9vdCBDQSAxMB4XDTAzMDUxNTA1MTMxNFoXDTIzMDUxNTA0NTIyOVowRzELMAkG +A1UEBhMCSEsxFjAUBgNVBAoTDUhvbmdrb25nIFBvc3QxIDAeBgNVBAMTF0hvbmdr +b25nIFBvc3QgUm9vdCBDQSAxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEArP84tulmAknjorThkPlAj3n54r15/gK97iSSHSL22oVyaf7XPwnU3ZG1ApzQ +jVrhVcNQhrkpJsLj2aDxaQMoIIBFIi1WpztUlVYiWR8o3x8gPW2iNr4joLFutbEn +PzlTCeqrauh0ssJlXI6/fMN4hM2eFvz1Lk8gKgifd/PFHsSaUmYeSF7jEAaPIpjh +ZY4bXSNmO7ilMlHIhqqhqZ5/dpTCpmy3QfDVyAY45tQM4vM7TG1QjMSDJ8EThFk9 +nnV0ttgCXjqQesBCNnLsak3c78QA3xMYV18meMjWCnl3v/evt3a5pQuEF10Q6m/h +q5URX208o1xNg1vysxmKgIsLhwIDAQABoyYwJDASBgNVHRMBAf8ECDAGAQH/AgED +MA4GA1UdDwEB/wQEAwIBxjANBgkqhkiG9w0BAQUFAAOCAQEADkbVPK7ih9legYsC +mEEIjEy82tvuJxuC52pF7BaLT4Wg87JwvVqWuspube5Gi27nKi6Wsxkz67SfqLI3 +7piol7Yutmcn1KZJ/RyTZXaeQi/cImyaT/JaFTmxcdcrUehtHJjA2Sr0oYJ71clB +oiMBdDhViw+5LmeiIAQ32pwL0xch4I+XeTRvhEgCIDMb5jREn5Fw9IBehEPCKdJs +EhTkYY2sEJCehFC78JZvRZ+K88psT/oROhUVRsPNH4NbLUES7VBnQRM9IauUiqpO +fMGx+6fWtScvl6tu4B3i0RwsH0Ti/L6RoZz71ilTc4afU9hDDl3WY4JxHYB0yvbi +AmvZWg== +-----END CERTIFICATE----- + +# Issuer: CN=SecureSign RootCA11 O=Japan Certification Services, Inc. +# Subject: CN=SecureSign RootCA11 O=Japan Certification Services, Inc. +# Label: "SecureSign RootCA11" +# Serial: 1 +# MD5 Fingerprint: b7:52:74:e2:92:b4:80:93:f2:75:e4:cc:d7:f2:ea:26 +# SHA1 Fingerprint: 3b:c4:9f:48:f8:f3:73:a0:9c:1e:bd:f8:5b:b1:c3:65:c7:d8:11:b3 +# SHA256 Fingerprint: bf:0f:ee:fb:9e:3a:58:1a:d5:f9:e9:db:75:89:98:57:43:d2:61:08:5c:4d:31:4f:6f:5d:72:59:aa:42:16:12 +-----BEGIN CERTIFICATE----- +MIIDbTCCAlWgAwIBAgIBATANBgkqhkiG9w0BAQUFADBYMQswCQYDVQQGEwJKUDEr +MCkGA1UEChMiSmFwYW4gQ2VydGlmaWNhdGlvbiBTZXJ2aWNlcywgSW5jLjEcMBoG +A1UEAxMTU2VjdXJlU2lnbiBSb290Q0ExMTAeFw0wOTA0MDgwNDU2NDdaFw0yOTA0 +MDgwNDU2NDdaMFgxCzAJBgNVBAYTAkpQMSswKQYDVQQKEyJKYXBhbiBDZXJ0aWZp +Y2F0aW9uIFNlcnZpY2VzLCBJbmMuMRwwGgYDVQQDExNTZWN1cmVTaWduIFJvb3RD +QTExMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA/XeqpRyQBTvLTJsz +i1oURaTnkBbR31fSIRCkF/3frNYfp+TbfPfs37gD2pRY/V1yfIw/XwFndBWW4wI8 +h9uuywGOwvNmxoVF9ALGOrVisq/6nL+k5tSAMJjzDbaTj6nU2DbysPyKyiyhFTOV +MdrAG/LuYpmGYz+/3ZMqg6h2uRMft85OQoWPIucuGvKVCbIFtUROd6EgvanyTgp9 +UK31BQ1FT0Zx/Sg+U/sE2C3XZR1KG/rPO7AxmjVuyIsG0wCR8pQIZUyxNAYAeoni +8McDWc/V1uinMrPmmECGxc0nEovMe863ETxiYAcjPitAbpSACW22s293bzUIUPsC +h8U+iQIDAQABo0IwQDAdBgNVHQ4EFgQUW/hNT7KlhtQ60vFjmqC+CfZXt94wDgYD +VR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEB +AKChOBZmLqdWHyGcBvod7bkixTgm2E5P7KN/ed5GIaGHd48HCJqypMWvDzKYC3xm +KbabfSVSSUOrTC4rbnpwrxYO4wJs+0LmGJ1F2FXI6Dvd5+H0LgscNFxsWEr7jIhQ +X5Ucv+2rIrVls4W6ng+4reV6G4pQOh29Dbx7VFALuUKvVaAYga1lme++5Jy/xIWr +QbJUb9wlze144o4MjQlJ3WN7WmmWAiGovVJZ6X01y8hSyn+B/tlr0/cR7SXf+Of5 +pPpyl4RTDaXQMhhRdlkUbA/r7F+AjHVDg8OFmP9Mni0N5HeDk061lgeLKBObjBmN +QSdJQO7e5iNEOdyhIta6A/I= +-----END CERTIFICATE----- + +# Issuer: CN=Microsec e-Szigno Root CA 2009 O=Microsec Ltd. +# Subject: CN=Microsec e-Szigno Root CA 2009 O=Microsec Ltd. +# Label: "Microsec e-Szigno Root CA 2009" +# Serial: 14014712776195784473 +# MD5 Fingerprint: f8:49:f4:03:bc:44:2d:83:be:48:69:7d:29:64:fc:b1 +# SHA1 Fingerprint: 89:df:74:fe:5c:f4:0f:4a:80:f9:e3:37:7d:54:da:91:e1:01:31:8e +# SHA256 Fingerprint: 3c:5f:81:fe:a5:fa:b8:2c:64:bf:a2:ea:ec:af:cd:e8:e0:77:fc:86:20:a7:ca:e5:37:16:3d:f3:6e:db:f3:78 +-----BEGIN CERTIFICATE----- +MIIECjCCAvKgAwIBAgIJAMJ+QwRORz8ZMA0GCSqGSIb3DQEBCwUAMIGCMQswCQYD +VQQGEwJIVTERMA8GA1UEBwwIQnVkYXBlc3QxFjAUBgNVBAoMDU1pY3Jvc2VjIEx0 +ZC4xJzAlBgNVBAMMHk1pY3Jvc2VjIGUtU3ppZ25vIFJvb3QgQ0EgMjAwOTEfMB0G +CSqGSIb3DQEJARYQaW5mb0BlLXN6aWduby5odTAeFw0wOTA2MTYxMTMwMThaFw0y +OTEyMzAxMTMwMThaMIGCMQswCQYDVQQGEwJIVTERMA8GA1UEBwwIQnVkYXBlc3Qx +FjAUBgNVBAoMDU1pY3Jvc2VjIEx0ZC4xJzAlBgNVBAMMHk1pY3Jvc2VjIGUtU3pp +Z25vIFJvb3QgQ0EgMjAwOTEfMB0GCSqGSIb3DQEJARYQaW5mb0BlLXN6aWduby5o +dTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOn4j/NjrdqG2KfgQvvP +kd6mJviZpWNwrZuuyjNAfW2WbqEORO7hE52UQlKavXWFdCyoDh2Tthi3jCyoz/tc +cbna7P7ofo/kLx2yqHWH2Leh5TvPmUpG0IMZfcChEhyVbUr02MelTTMuhTlAdX4U +fIASmFDHQWe4oIBhVKZsTh/gnQ4H6cm6M+f+wFUoLAKApxn1ntxVUwOXewdI/5n7 +N4okxFnMUBBjjqqpGrCEGob5X7uxUG6k0QrM1XF+H6cbfPVTbiJfyyvm1HxdrtbC +xkzlBQHZ7Vf8wSN5/PrIJIOV87VqUQHQd9bpEqH5GoP7ghu5sJf0dgYzQ0mg/wu1 ++rUCAwEAAaOBgDB+MA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0G +A1UdDgQWBBTLD8bfQkPMPcu1SCOhGnqmKrs0aDAfBgNVHSMEGDAWgBTLD8bfQkPM +Pcu1SCOhGnqmKrs0aDAbBgNVHREEFDASgRBpbmZvQGUtc3ppZ25vLmh1MA0GCSqG +SIb3DQEBCwUAA4IBAQDJ0Q5eLtXMs3w+y/w9/w0olZMEyL/azXm4Q5DwpL7v8u8h +mLzU1F0G9u5C7DBsoKqpyvGvivo/C3NqPuouQH4frlRheesuCDfXI/OMn74dseGk +ddug4lQUsbocKaQY9hK6ohQU4zE1yED/t+AFdlfBHFny+L/k7SViXITwfn4fs775 +tyERzAMBVnCnEJIeGzSBHq2cGsMEPO0CYdYeBvNfOofyK/FFh+U9rNHHV4S9a67c +2Pm2G2JwCz02yULyMtd6YebS2z3PyKnJm9zbWETXbzivf3jTo60adbocwTZ8jx5t +HMN1Rq41Bab2XD0h7lbwyYIiLXpUq3DDfSJlgnCW +-----END CERTIFICATE----- + +# Issuer: CN=GlobalSign O=GlobalSign OU=GlobalSign Root CA - R3 +# Subject: CN=GlobalSign O=GlobalSign OU=GlobalSign Root CA - R3 +# Label: "GlobalSign Root CA - R3" +# Serial: 4835703278459759426209954 +# MD5 Fingerprint: c5:df:b8:49:ca:05:13:55:ee:2d:ba:1a:c3:3e:b0:28 +# SHA1 Fingerprint: d6:9b:56:11:48:f0:1c:77:c5:45:78:c1:09:26:df:5b:85:69:76:ad +# SHA256 Fingerprint: cb:b5:22:d7:b7:f1:27:ad:6a:01:13:86:5b:df:1c:d4:10:2e:7d:07:59:af:63:5a:7c:f4:72:0d:c9:63:c5:3b +-----BEGIN CERTIFICATE----- +MIIDXzCCAkegAwIBAgILBAAAAAABIVhTCKIwDQYJKoZIhvcNAQELBQAwTDEgMB4G +A1UECxMXR2xvYmFsU2lnbiBSb290IENBIC0gUjMxEzARBgNVBAoTCkdsb2JhbFNp +Z24xEzARBgNVBAMTCkdsb2JhbFNpZ24wHhcNMDkwMzE4MTAwMDAwWhcNMjkwMzE4 +MTAwMDAwWjBMMSAwHgYDVQQLExdHbG9iYWxTaWduIFJvb3QgQ0EgLSBSMzETMBEG +A1UEChMKR2xvYmFsU2lnbjETMBEGA1UEAxMKR2xvYmFsU2lnbjCCASIwDQYJKoZI +hvcNAQEBBQADggEPADCCAQoCggEBAMwldpB5BngiFvXAg7aEyiie/QV2EcWtiHL8 +RgJDx7KKnQRfJMsuS+FggkbhUqsMgUdwbN1k0ev1LKMPgj0MK66X17YUhhB5uzsT +gHeMCOFJ0mpiLx9e+pZo34knlTifBtc+ycsmWQ1z3rDI6SYOgxXG71uL0gRgykmm +KPZpO/bLyCiR5Z2KYVc3rHQU3HTgOu5yLy6c+9C7v/U9AOEGM+iCK65TpjoWc4zd +QQ4gOsC0p6Hpsk+QLjJg6VfLuQSSaGjlOCZgdbKfd/+RFO+uIEn8rUAVSNECMWEZ +XriX7613t2Saer9fwRPvm2L7DWzgVGkWqQPabumDk3F2xmmFghcCAwEAAaNCMEAw +DgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFI/wS3+o +LkUkrk1Q+mOai97i3Ru8MA0GCSqGSIb3DQEBCwUAA4IBAQBLQNvAUKr+yAzv95ZU +RUm7lgAJQayzE4aGKAczymvmdLm6AC2upArT9fHxD4q/c2dKg8dEe3jgr25sbwMp +jjM5RcOO5LlXbKr8EpbsU8Yt5CRsuZRj+9xTaGdWPoO4zzUhw8lo/s7awlOqzJCK +6fBdRoyV3XpYKBovHd7NADdBj+1EbddTKJd+82cEHhXXipa0095MJ6RMG3NzdvQX +mcIfeg7jLQitChws/zyrVQ4PkX4268NXSb7hLi18YIvDQVETI53O9zJrlAGomecs +Mx86OyXShkDOOyyGeMlhLxS67ttVb9+E7gUJTb0o2HLO02JQZR7rkpeDMdmztcpH +WD9f +-----END CERTIFICATE----- + +# Issuer: CN=Autoridad de Certificacion Firmaprofesional CIF A62634068 +# Subject: CN=Autoridad de Certificacion Firmaprofesional CIF A62634068 +# Label: "Autoridad de Certificacion Firmaprofesional CIF A62634068" +# Serial: 6047274297262753887 +# MD5 Fingerprint: 73:3a:74:7a:ec:bb:a3:96:a6:c2:e4:e2:c8:9b:c0:c3 +# SHA1 Fingerprint: ae:c5:fb:3f:c8:e1:bf:c4:e5:4f:03:07:5a:9a:e8:00:b7:f7:b6:fa +# SHA256 Fingerprint: 04:04:80:28:bf:1f:28:64:d4:8f:9a:d4:d8:32:94:36:6a:82:88:56:55:3f:3b:14:30:3f:90:14:7f:5d:40:ef +-----BEGIN CERTIFICATE----- +MIIGFDCCA/ygAwIBAgIIU+w77vuySF8wDQYJKoZIhvcNAQEFBQAwUTELMAkGA1UE +BhMCRVMxQjBABgNVBAMMOUF1dG9yaWRhZCBkZSBDZXJ0aWZpY2FjaW9uIEZpcm1h +cHJvZmVzaW9uYWwgQ0lGIEE2MjYzNDA2ODAeFw0wOTA1MjAwODM4MTVaFw0zMDEy +MzEwODM4MTVaMFExCzAJBgNVBAYTAkVTMUIwQAYDVQQDDDlBdXRvcmlkYWQgZGUg +Q2VydGlmaWNhY2lvbiBGaXJtYXByb2Zlc2lvbmFsIENJRiBBNjI2MzQwNjgwggIi +MA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDKlmuO6vj78aI14H9M2uDDUtd9 +thDIAl6zQyrET2qyyhxdKJp4ERppWVevtSBC5IsP5t9bpgOSL/UR5GLXMnE42QQM +cas9UX4PB99jBVzpv5RvwSmCwLTaUbDBPLutN0pcyvFLNg4kq7/DhHf9qFD0sefG +L9ItWY16Ck6WaVICqjaY7Pz6FIMMNx/Jkjd/14Et5cS54D40/mf0PmbR0/RAz15i +NA9wBj4gGFrO93IbJWyTdBSTo3OxDqqHECNZXyAFGUftaI6SEspd/NYrspI8IM/h +X68gvqB2f3bl7BqGYTM+53u0P6APjqK5am+5hyZvQWyIplD9amML9ZMWGxmPsu2b +m8mQ9QEM3xk9Dz44I8kvjwzRAv4bVdZO0I08r0+k8/6vKtMFnXkIoctXMbScyJCy +Z/QYFpM6/EfY0XiWMR+6KwxfXZmtY4laJCB22N/9q06mIqqdXuYnin1oKaPnirja +EbsXLZmdEyRG98Xi2J+Of8ePdG1asuhy9azuJBCtLxTa/y2aRnFHvkLfuwHb9H/T +KI8xWVvTyQKmtFLKbpf7Q8UIJm+K9Lv9nyiqDdVF8xM6HdjAeI9BZzwelGSuewvF +6NkBiDkal4ZkQdU7hwxu+g/GvUgUvzlN1J5Bto+WHWOWk9mVBngxaJ43BjuAiUVh +OSPHG0SjFeUc+JIwuwIDAQABo4HvMIHsMBIGA1UdEwEB/wQIMAYBAf8CAQEwDgYD +VR0PAQH/BAQDAgEGMB0GA1UdDgQWBBRlzeurNR4APn7VdMActHNHDhpkLzCBpgYD +VR0gBIGeMIGbMIGYBgRVHSAAMIGPMC8GCCsGAQUFBwIBFiNodHRwOi8vd3d3LmZp +cm1hcHJvZmVzaW9uYWwuY29tL2NwczBcBggrBgEFBQcCAjBQHk4AUABhAHMAZQBv +ACAAZABlACAAbABhACAAQgBvAG4AYQBuAG8AdgBhACAANAA3ACAAQgBhAHIAYwBl +AGwAbwBuAGEAIAAwADgAMAAxADcwDQYJKoZIhvcNAQEFBQADggIBABd9oPm03cXF +661LJLWhAqvdpYhKsg9VSytXjDvlMd3+xDLx51tkljYyGOylMnfX40S2wBEqgLk9 +am58m9Ot/MPWo+ZkKXzR4Tgegiv/J2Wv+xYVxC5xhOW1//qkR71kMrv2JYSiJ0L1 +ILDCExARzRAVukKQKtJE4ZYm6zFIEv0q2skGz3QeqUvVhyj5eTSSPi5E6PaPT481 +PyWzOdxjKpBrIF/EUhJOlywqrJ2X3kjyo2bbwtKDlaZmp54lD+kLM5FlClrD2VQS +3a/DTg4fJl4N3LON7NWBcN7STyQF82xO9UxJZo3R/9ILJUFI/lGExkKvgATP0H5k +SeTy36LssUzAKh3ntLFlosS88Zj0qnAHY7S42jtM+kAiMFsRpvAFDsYCA0irhpuF +3dvd6qJ2gHN99ZwExEWN57kci57q13XRcrHedUTnQn3iV2t93Jm8PYMo6oCTjcVM +ZcFwgbg4/EMxsvYDNEeyrPsiBsse3RdHHF9mudMaotoRsaS8I8nkvof/uZS2+F0g +StRf571oe2XyFR7SOqkt6dhrJKyXWERHrVkY8SFlcN7ONGCoQPHzPKTDKCOM/icz +Q0CgFzzr6juwcqajuUpLXhZI9LK8yIySxZ2frHI2vDSANGupi5LAuBft7HZT9SQB +jLMi6Et8Vcad+qMUu2WFbm5PEn4KPJ2V +-----END CERTIFICATE----- + +# Issuer: CN=Izenpe.com O=IZENPE S.A. +# Subject: CN=Izenpe.com O=IZENPE S.A. +# Label: "Izenpe.com" +# Serial: 917563065490389241595536686991402621 +# MD5 Fingerprint: a6:b0:cd:85:80:da:5c:50:34:a3:39:90:2f:55:67:73 +# SHA1 Fingerprint: 2f:78:3d:25:52:18:a7:4a:65:39:71:b5:2c:a2:9c:45:15:6f:e9:19 +# SHA256 Fingerprint: 25:30:cc:8e:98:32:15:02:ba:d9:6f:9b:1f:ba:1b:09:9e:2d:29:9e:0f:45:48:bb:91:4f:36:3b:c0:d4:53:1f +-----BEGIN CERTIFICATE----- +MIIF8TCCA9mgAwIBAgIQALC3WhZIX7/hy/WL1xnmfTANBgkqhkiG9w0BAQsFADA4 +MQswCQYDVQQGEwJFUzEUMBIGA1UECgwLSVpFTlBFIFMuQS4xEzARBgNVBAMMCkl6 +ZW5wZS5jb20wHhcNMDcxMjEzMTMwODI4WhcNMzcxMjEzMDgyNzI1WjA4MQswCQYD +VQQGEwJFUzEUMBIGA1UECgwLSVpFTlBFIFMuQS4xEzARBgNVBAMMCkl6ZW5wZS5j +b20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDJ03rKDx6sp4boFmVq +scIbRTJxldn+EFvMr+eleQGPicPK8lVx93e+d5TzcqQsRNiekpsUOqHnJJAKClaO +xdgmlOHZSOEtPtoKct2jmRXagaKH9HtuJneJWK3W6wyyQXpzbm3benhB6QiIEn6H +LmYRY2xU+zydcsC8Lv/Ct90NduM61/e0aL6i9eOBbsFGb12N4E3GVFWJGjMxCrFX +uaOKmMPsOzTFlUFpfnXCPCDFYbpRR6AgkJOhkEvzTnyFRVSa0QUmQbC1TR0zvsQD +yCV8wXDbO/QJLVQnSKwv4cSsPsjLkkxTOTcj7NMB+eAJRE1NZMDhDVqHIrytG6P+ +JrUV86f8hBnp7KGItERphIPzidF0BqnMC9bC3ieFUCbKF7jJeodWLBoBHmy+E60Q +rLUk9TiRodZL2vG70t5HtfG8gfZZa88ZU+mNFctKy6lvROUbQc/hhqfK0GqfvEyN +BjNaooXlkDWgYlwWTvDjovoDGrQscbNYLN57C9saD+veIR8GdwYDsMnvmfzAuU8L +hij+0rnq49qlw0dpEuDb8PYZi+17cNcC1u2HGCgsBCRMd+RIihrGO5rUD8r6ddIB +QFqNeb+Lz0vPqhbBleStTIo+F5HUsWLlguWABKQDfo2/2n+iD5dPDNMN+9fR5XJ+ +HMh3/1uaD7euBUbl8agW7EekFwIDAQABo4H2MIHzMIGwBgNVHREEgagwgaWBD2lu +Zm9AaXplbnBlLmNvbaSBkTCBjjFHMEUGA1UECgw+SVpFTlBFIFMuQS4gLSBDSUYg +QTAxMzM3MjYwLVJNZXJjLlZpdG9yaWEtR2FzdGVpeiBUMTA1NSBGNjIgUzgxQzBB +BgNVBAkMOkF2ZGEgZGVsIE1lZGl0ZXJyYW5lbyBFdG9yYmlkZWEgMTQgLSAwMTAx +MCBWaXRvcmlhLUdhc3RlaXowDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMC +AQYwHQYDVR0OBBYEFB0cZQ6o8iV7tJHP5LGx5r1VdGwFMA0GCSqGSIb3DQEBCwUA +A4ICAQB4pgwWSp9MiDrAyw6lFn2fuUhfGI8NYjb2zRlrrKvV9pF9rnHzP7MOeIWb +laQnIUdCSnxIOvVFfLMMjlF4rJUT3sb9fbgakEyrkgPH7UIBzg/YsfqikuFgba56 +awmqxinuaElnMIAkejEWOVt+8Rwu3WwJrfIxwYJOubv5vr8qhT/AQKM6WfxZSzwo +JNu0FXWuDYi6LnPAvViH5ULy617uHjAimcs30cQhbIHsvm0m5hzkQiCeR7Csg1lw +LDXWrzY0tM07+DKo7+N4ifuNRSzanLh+QBxh5z6ikixL8s36mLYp//Pye6kfLqCT +VyvehQP5aTfLnnhqBbTFMXiJ7HqnheG5ezzevh55hM6fcA5ZwjUukCox2eRFekGk +LhObNA5me0mrZJfQRsN5nXJQY6aYWwa9SG3YOYNw6DXwBdGqvOPbyALqfP2C2sJb +UjWumDqtujWTI6cfSN01RpiyEGjkpTHCClguGYEQyVB1/OpaFs4R1+7vUIgtYf8/ +QnMFlEPVjjxOAToZpR9GTnfQXeWBIiGH/pR9hNiTrdZoQ0iy2+tzJOeRf1SktoA+ +naM8THLCV8Sg1Mw4J87VBp6iSNnpn86CcDaTmjvfliHjWbcM2pE38P1ZWrOZyGls +QyYBNWNgVYkDOnXYukrZVP/u3oDYLdE41V4tC5h9Pmzb/CaIxw== +-----END CERTIFICATE----- + +# Issuer: CN=Chambers of Commerce Root - 2008 O=AC Camerfirma S.A. +# Subject: CN=Chambers of Commerce Root - 2008 O=AC Camerfirma S.A. +# Label: "Chambers of Commerce Root - 2008" +# Serial: 11806822484801597146 +# MD5 Fingerprint: 5e:80:9e:84:5a:0e:65:0b:17:02:f3:55:18:2a:3e:d7 +# SHA1 Fingerprint: 78:6a:74:ac:76:ab:14:7f:9c:6a:30:50:ba:9e:a8:7e:fe:9a:ce:3c +# SHA256 Fingerprint: 06:3e:4a:fa:c4:91:df:d3:32:f3:08:9b:85:42:e9:46:17:d8:93:d7:fe:94:4e:10:a7:93:7e:e2:9d:96:93:c0 +-----BEGIN CERTIFICATE----- +MIIHTzCCBTegAwIBAgIJAKPaQn6ksa7aMA0GCSqGSIb3DQEBBQUAMIGuMQswCQYD +VQQGEwJFVTFDMEEGA1UEBxM6TWFkcmlkIChzZWUgY3VycmVudCBhZGRyZXNzIGF0 +IHd3dy5jYW1lcmZpcm1hLmNvbS9hZGRyZXNzKTESMBAGA1UEBRMJQTgyNzQzMjg3 +MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMuQS4xKTAnBgNVBAMTIENoYW1iZXJz +IG9mIENvbW1lcmNlIFJvb3QgLSAyMDA4MB4XDTA4MDgwMTEyMjk1MFoXDTM4MDcz +MTEyMjk1MFowga4xCzAJBgNVBAYTAkVVMUMwQQYDVQQHEzpNYWRyaWQgKHNlZSBj +dXJyZW50IGFkZHJlc3MgYXQgd3d3LmNhbWVyZmlybWEuY29tL2FkZHJlc3MpMRIw +EAYDVQQFEwlBODI3NDMyODcxGzAZBgNVBAoTEkFDIENhbWVyZmlybWEgUy5BLjEp +MCcGA1UEAxMgQ2hhbWJlcnMgb2YgQ29tbWVyY2UgUm9vdCAtIDIwMDgwggIiMA0G +CSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCvAMtwNyuAWko6bHiUfaN/Gh/2NdW9 +28sNRHI+JrKQUrpjOyhYb6WzbZSm891kDFX29ufyIiKAXuFixrYp4YFs8r/lfTJq +VKAyGVn+H4vXPWCGhSRv4xGzdz4gljUha7MI2XAuZPeEklPWDrCQiorjh40G072Q +DuKZoRuGDtqaCrsLYVAGUvGef3bsyw/QHg3PmTA9HMRFEFis1tPo1+XqxQEHd9ZR +5gN/ikilTWh1uem8nk4ZcfUyS5xtYBkL+8ydddy/Js2Pk3g5eXNeJQ7KXOt3EgfL +ZEFHcpOrUMPrCXZkNNI5t3YRCQ12RcSprj1qr7V9ZS+UWBDsXHyvfuK2GNnQm05a +Sd+pZgvMPMZ4fKecHePOjlO+Bd5gD2vlGts/4+EhySnB8esHnFIbAURRPHsl18Tl +UlRdJQfKFiC4reRB7noI/plvg6aRArBsNlVq5331lubKgdaX8ZSD6e2wsWsSaR6s ++12pxZjptFtYer49okQ6Y1nUCyXeG0+95QGezdIp1Z8XGQpvvwyQ0wlf2eOKNcx5 +Wk0ZN5K3xMGtr/R5JJqyAQuxr1yW84Ay+1w9mPGgP0revq+ULtlVmhduYJ1jbLhj +ya6BXBg14JC7vjxPNyK5fuvPnnchpj04gftI2jE9K+OJ9dC1vX7gUMQSibMjmhAx +hduub+84Mxh2EQIDAQABo4IBbDCCAWgwEgYDVR0TAQH/BAgwBgEB/wIBDDAdBgNV +HQ4EFgQU+SSsD7K1+HnA+mCIG8TZTQKeFxkwgeMGA1UdIwSB2zCB2IAU+SSsD7K1 ++HnA+mCIG8TZTQKeFxmhgbSkgbEwga4xCzAJBgNVBAYTAkVVMUMwQQYDVQQHEzpN +YWRyaWQgKHNlZSBjdXJyZW50IGFkZHJlc3MgYXQgd3d3LmNhbWVyZmlybWEuY29t +L2FkZHJlc3MpMRIwEAYDVQQFEwlBODI3NDMyODcxGzAZBgNVBAoTEkFDIENhbWVy +ZmlybWEgUy5BLjEpMCcGA1UEAxMgQ2hhbWJlcnMgb2YgQ29tbWVyY2UgUm9vdCAt +IDIwMDiCCQCj2kJ+pLGu2jAOBgNVHQ8BAf8EBAMCAQYwPQYDVR0gBDYwNDAyBgRV +HSAAMCowKAYIKwYBBQUHAgEWHGh0dHA6Ly9wb2xpY3kuY2FtZXJmaXJtYS5jb20w +DQYJKoZIhvcNAQEFBQADggIBAJASryI1wqM58C7e6bXpeHxIvj99RZJe6dqxGfwW +PJ+0W2aeaufDuV2I6A+tzyMP3iU6XsxPpcG1Lawk0lgH3qLPaYRgM+gQDROpI9CF +5Y57pp49chNyM/WqfcZjHwj0/gF/JM8rLFQJ3uIrbZLGOU8W6jx+ekbURWpGqOt1 +glanq6B8aBMz9p0w8G8nOSQjKpD9kCk18pPfNKXG9/jvjA9iSnyu0/VU+I22mlaH +FoI6M6taIgj3grrqLuBHmrS1RaMFO9ncLkVAO+rcf+g769HsJtg1pDDFOqxXnrN2 +pSB7+R5KBWIBpih1YJeSDW4+TTdDDZIVnBgizVGZoCkaPF+KMjNbMMeJL0eYD6MD +xvbxrN8y8NmBGuScvfaAFPDRLLmF9dijscilIeUcE5fuDr3fKanvNFNb0+RqE4QG +tjICxFKuItLcsiFCGtpA8CnJ7AoMXOLQusxI0zcKzBIKinmwPQN/aUv0NCB9szTq +jktk9T79syNnFQ0EuPAtwQlRPLJsFfClI9eDdOTlLsn+mCdCxqvGnrDQWzilm1De +fhiYtUU79nm06PcaewaD+9CL2rvHvRirCG88gGtAPxkZumWK5r7VXNM21+9AUiRg +OGcEMeyP84LG3rlV8zsxkVrctQgVrXYlCg17LofiDKYGvCYQbTed7N14jHyAxfDZ +d0jQ +-----END CERTIFICATE----- + +# Issuer: CN=Global Chambersign Root - 2008 O=AC Camerfirma S.A. +# Subject: CN=Global Chambersign Root - 2008 O=AC Camerfirma S.A. +# Label: "Global Chambersign Root - 2008" +# Serial: 14541511773111788494 +# MD5 Fingerprint: 9e:80:ff:78:01:0c:2e:c1:36:bd:fe:96:90:6e:08:f3 +# SHA1 Fingerprint: 4a:bd:ee:ec:95:0d:35:9c:89:ae:c7:52:a1:2c:5b:29:f6:d6:aa:0c +# SHA256 Fingerprint: 13:63:35:43:93:34:a7:69:80:16:a0:d3:24:de:72:28:4e:07:9d:7b:52:20:bb:8f:bd:74:78:16:ee:be:ba:ca +-----BEGIN CERTIFICATE----- +MIIHSTCCBTGgAwIBAgIJAMnN0+nVfSPOMA0GCSqGSIb3DQEBBQUAMIGsMQswCQYD +VQQGEwJFVTFDMEEGA1UEBxM6TWFkcmlkIChzZWUgY3VycmVudCBhZGRyZXNzIGF0 +IHd3dy5jYW1lcmZpcm1hLmNvbS9hZGRyZXNzKTESMBAGA1UEBRMJQTgyNzQzMjg3 +MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMuQS4xJzAlBgNVBAMTHkdsb2JhbCBD +aGFtYmVyc2lnbiBSb290IC0gMjAwODAeFw0wODA4MDExMjMxNDBaFw0zODA3MzEx +MjMxNDBaMIGsMQswCQYDVQQGEwJFVTFDMEEGA1UEBxM6TWFkcmlkIChzZWUgY3Vy +cmVudCBhZGRyZXNzIGF0IHd3dy5jYW1lcmZpcm1hLmNvbS9hZGRyZXNzKTESMBAG +A1UEBRMJQTgyNzQzMjg3MRswGQYDVQQKExJBQyBDYW1lcmZpcm1hIFMuQS4xJzAl +BgNVBAMTHkdsb2JhbCBDaGFtYmVyc2lnbiBSb290IC0gMjAwODCCAiIwDQYJKoZI +hvcNAQEBBQADggIPADCCAgoCggIBAMDfVtPkOpt2RbQT2//BthmLN0EYlVJH6xed +KYiONWwGMi5HYvNJBL99RDaxccy9Wglz1dmFRP+RVyXfXjaOcNFccUMd2drvXNL7 +G706tcuto8xEpw2uIRU/uXpbknXYpBI4iRmKt4DS4jJvVpyR1ogQC7N0ZJJ0YPP2 +zxhPYLIj0Mc7zmFLmY/CDNBAspjcDahOo7kKrmCgrUVSY7pmvWjg+b4aqIG7HkF4 +ddPB/gBVsIdU6CeQNR1MM62X/JcumIS/LMmjv9GYERTtY/jKmIhYF5ntRQOXfjyG +HoiMvvKRhI9lNNgATH23MRdaKXoKGCQwoze1eqkBfSbW+Q6OWfH9GzO1KTsXO0G2 +Id3UwD2ln58fQ1DJu7xsepeY7s2MH/ucUa6LcL0nn3HAa6x9kGbo1106DbDVwo3V +yJ2dwW3Q0L9R5OP4wzg2rtandeavhENdk5IMagfeOx2YItaswTXbo6Al/3K1dh3e +beksZixShNBFks4c5eUzHdwHU1SjqoI7mjcv3N2gZOnm3b2u/GSFHTynyQbehP9r +6GsaPMWis0L7iwk+XwhSx2LE1AVxv8Rk5Pihg+g+EpuoHtQ2TS9x9o0o9oOpE9Jh +wZG7SMA0j0GMS0zbaRL/UJScIINZc+18ofLx/d33SdNDWKBWY8o9PeU1VlnpDsog +zCtLkykPAgMBAAGjggFqMIIBZjASBgNVHRMBAf8ECDAGAQH/AgEMMB0GA1UdDgQW +BBS5CcqcHtvTbDprru1U8VuTBjUuXjCB4QYDVR0jBIHZMIHWgBS5CcqcHtvTbDpr +ru1U8VuTBjUuXqGBsqSBrzCBrDELMAkGA1UEBhMCRVUxQzBBBgNVBAcTOk1hZHJp +ZCAoc2VlIGN1cnJlbnQgYWRkcmVzcyBhdCB3d3cuY2FtZXJmaXJtYS5jb20vYWRk +cmVzcykxEjAQBgNVBAUTCUE4Mjc0MzI4NzEbMBkGA1UEChMSQUMgQ2FtZXJmaXJt +YSBTLkEuMScwJQYDVQQDEx5HbG9iYWwgQ2hhbWJlcnNpZ24gUm9vdCAtIDIwMDiC +CQDJzdPp1X0jzjAOBgNVHQ8BAf8EBAMCAQYwPQYDVR0gBDYwNDAyBgRVHSAAMCow +KAYIKwYBBQUHAgEWHGh0dHA6Ly9wb2xpY3kuY2FtZXJmaXJtYS5jb20wDQYJKoZI +hvcNAQEFBQADggIBAICIf3DekijZBZRG/5BXqfEv3xoNa/p8DhxJJHkn2EaqbylZ +UohwEurdPfWbU1Rv4WCiqAm57OtZfMY18dwY6fFn5a+6ReAJ3spED8IXDneRRXoz +X1+WLGiLwUePmJs9wOzL9dWCkoQ10b42OFZyMVtHLaoXpGNR6woBrX/sdZ7LoR/x +fxKxueRkf2fWIyr0uDldmOghp+G9PUIadJpwr2hsUF1Jz//7Dl3mLEfXgTpZALVz +a2Mg9jFFCDkO9HB+QHBaP9BrQql0PSgvAm11cpUJjUhjxsYjV5KTXjXBjfkK9yyd +Yhz2rXzdpjEetrHHfoUm+qRqtdpjMNHvkzeyZi99Bffnt0uYlDXA2TopwZ2yUDMd +SqlapskD7+3056huirRXhOukP9DuqqqHW2Pok+JrqNS4cnhrG+055F3Lm6qH1U9O +AP7Zap88MQ8oAgF9mOinsKJknnn4SPIVqczmyETrP3iZ8ntxPjzxmKfFGBI/5rso +M0LpRQp8bfKGeS/Fghl9CYl8slR2iK7ewfPM4W7bMdaTrpmg7yVqc5iJWzouE4ge +v8CSlDQb4ye3ix5vQv/n6TebUB0tovkC7stYWDpxvGjjqsGvHCgfotwjZT+B6q6Z +09gwzxMNTxXJhLynSC34MCN32EZLeW32jO06f2ARePTpm67VVMB0gNELQp/B +-----END CERTIFICATE----- + +# Issuer: CN=Go Daddy Root Certificate Authority - G2 O=GoDaddy.com, Inc. +# Subject: CN=Go Daddy Root Certificate Authority - G2 O=GoDaddy.com, Inc. +# Label: "Go Daddy Root Certificate Authority - G2" +# Serial: 0 +# MD5 Fingerprint: 80:3a:bc:22:c1:e6:fb:8d:9b:3b:27:4a:32:1b:9a:01 +# SHA1 Fingerprint: 47:be:ab:c9:22:ea:e8:0e:78:78:34:62:a7:9f:45:c2:54:fd:e6:8b +# SHA256 Fingerprint: 45:14:0b:32:47:eb:9c:c8:c5:b4:f0:d7:b5:30:91:f7:32:92:08:9e:6e:5a:63:e2:74:9d:d3:ac:a9:19:8e:da +-----BEGIN CERTIFICATE----- +MIIDxTCCAq2gAwIBAgIBADANBgkqhkiG9w0BAQsFADCBgzELMAkGA1UEBhMCVVMx +EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxGjAYBgNVBAoT +EUdvRGFkZHkuY29tLCBJbmMuMTEwLwYDVQQDEyhHbyBEYWRkeSBSb290IENlcnRp +ZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTA5MDkwMTAwMDAwMFoXDTM3MTIzMTIz +NTk1OVowgYMxCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6b25hMRMwEQYDVQQH +EwpTY290dHNkYWxlMRowGAYDVQQKExFHb0RhZGR5LmNvbSwgSW5jLjExMC8GA1UE +AxMoR28gRGFkZHkgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkgLSBHMjCCASIw +DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL9xYgjx+lk09xvJGKP3gElY6SKD +E6bFIEMBO4Tx5oVJnyfq9oQbTqC023CYxzIBsQU+B07u9PpPL1kwIuerGVZr4oAH +/PMWdYA5UXvl+TW2dE6pjYIT5LY/qQOD+qK+ihVqf94Lw7YZFAXK6sOoBJQ7Rnwy +DfMAZiLIjWltNowRGLfTshxgtDj6AozO091GB94KPutdfMh8+7ArU6SSYmlRJQVh +GkSBjCypQ5Yj36w6gZoOKcUcqeldHraenjAKOc7xiID7S13MMuyFYkMlNAJWJwGR +tDtwKj9useiciAF9n9T521NtYJ2/LOdYq7hfRvzOxBsDPAnrSTFcaUaz4EcCAwEA +AaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYE +FDqahQcQZyi27/a9BUFuIMGU2g/eMA0GCSqGSIb3DQEBCwUAA4IBAQCZ21151fmX +WWcDYfF+OwYxdS2hII5PZYe096acvNjpL9DbWu7PdIxztDhC2gV7+AJ1uP2lsdeu +9tfeE8tTEH6KRtGX+rcuKxGrkLAngPnon1rpN5+r5N9ss4UXnT3ZJE95kTXWXwTr +gIOrmgIttRD02JDHBHNA7XIloKmf7J6raBKZV8aPEjoJpL1E/QYVN8Gb5DKj7Tjo +2GTzLH4U/ALqn83/B2gX2yKQOC16jdFU8WnjXzPKej17CuPKf1855eJ1usV2GDPO +LPAvTK33sefOT6jEm0pUBsV/fdUID+Ic/n4XuKxe9tQWskMJDE32p2u0mYRlynqI +4uJEvlz36hz1 +-----END CERTIFICATE----- + +# Issuer: CN=Starfield Root Certificate Authority - G2 O=Starfield Technologies, Inc. +# Subject: CN=Starfield Root Certificate Authority - G2 O=Starfield Technologies, Inc. +# Label: "Starfield Root Certificate Authority - G2" +# Serial: 0 +# MD5 Fingerprint: d6:39:81:c6:52:7e:96:69:fc:fc:ca:66:ed:05:f2:96 +# SHA1 Fingerprint: b5:1c:06:7c:ee:2b:0c:3d:f8:55:ab:2d:92:f4:fe:39:d4:e7:0f:0e +# SHA256 Fingerprint: 2c:e1:cb:0b:f9:d2:f9:e1:02:99:3f:be:21:51:52:c3:b2:dd:0c:ab:de:1c:68:e5:31:9b:83:91:54:db:b7:f5 +-----BEGIN CERTIFICATE----- +MIID3TCCAsWgAwIBAgIBADANBgkqhkiG9w0BAQsFADCBjzELMAkGA1UEBhMCVVMx +EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxJTAjBgNVBAoT +HFN0YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xMjAwBgNVBAMTKVN0YXJmaWVs +ZCBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTA5MDkwMTAwMDAw +MFoXDTM3MTIzMTIzNTk1OVowgY8xCzAJBgNVBAYTAlVTMRAwDgYDVQQIEwdBcml6 +b25hMRMwEQYDVQQHEwpTY290dHNkYWxlMSUwIwYDVQQKExxTdGFyZmllbGQgVGVj +aG5vbG9naWVzLCBJbmMuMTIwMAYDVQQDEylTdGFyZmllbGQgUm9vdCBDZXJ0aWZp +Y2F0ZSBBdXRob3JpdHkgLSBHMjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoC +ggEBAL3twQP89o/8ArFvW59I2Z154qK3A2FWGMNHttfKPTUuiUP3oWmb3ooa/RMg +nLRJdzIpVv257IzdIvpy3Cdhl+72WoTsbhm5iSzchFvVdPtrX8WJpRBSiUZV9Lh1 +HOZ/5FSuS/hVclcCGfgXcVnrHigHdMWdSL5stPSksPNkN3mSwOxGXn/hbVNMYq/N +Hwtjuzqd+/x5AJhhdM8mgkBj87JyahkNmcrUDnXMN/uLicFZ8WJ/X7NfZTD4p7dN +dloedl40wOiWVpmKs/B/pM293DIxfJHP4F8R+GuqSVzRmZTRouNjWwl2tVZi4Ut0 +HZbUJtQIBFnQmA4O5t78w+wfkPECAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAO +BgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFHwMMh+n2TB/xH1oo2Kooc6rB1snMA0G +CSqGSIb3DQEBCwUAA4IBAQARWfolTwNvlJk7mh+ChTnUdgWUXuEok21iXQnCoKjU +sHU48TRqneSfioYmUeYs0cYtbpUgSpIB7LiKZ3sx4mcujJUDJi5DnUox9g61DLu3 +4jd/IroAow57UvtruzvE03lRTs2Q9GcHGcg8RnoNAX3FWOdt5oUwF5okxBDgBPfg +8n/Uqgr/Qh037ZTlZFkSIHc40zI+OIF1lnP6aI+xy84fxez6nH7PfrHxBy22/L/K +pL/QlwVKvOoYKAKQvVR4CSFx09F9HdkWsKlhPdAKACL8x3vLCWRFCztAgfd9fDL1 +mMpYjn0q7pBZc2T5NnReJaH1ZgUufzkVqSr7UIuOhWn0 +-----END CERTIFICATE----- + +# Issuer: CN=Starfield Services Root Certificate Authority - G2 O=Starfield Technologies, Inc. +# Subject: CN=Starfield Services Root Certificate Authority - G2 O=Starfield Technologies, Inc. +# Label: "Starfield Services Root Certificate Authority - G2" +# Serial: 0 +# MD5 Fingerprint: 17:35:74:af:7b:61:1c:eb:f4:f9:3c:e2:ee:40:f9:a2 +# SHA1 Fingerprint: 92:5a:8f:8d:2c:6d:04:e0:66:5f:59:6a:ff:22:d8:63:e8:25:6f:3f +# SHA256 Fingerprint: 56:8d:69:05:a2:c8:87:08:a4:b3:02:51:90:ed:cf:ed:b1:97:4a:60:6a:13:c6:e5:29:0f:cb:2a:e6:3e:da:b5 +-----BEGIN CERTIFICATE----- +MIID7zCCAtegAwIBAgIBADANBgkqhkiG9w0BAQsFADCBmDELMAkGA1UEBhMCVVMx +EDAOBgNVBAgTB0FyaXpvbmExEzARBgNVBAcTClNjb3R0c2RhbGUxJTAjBgNVBAoT +HFN0YXJmaWVsZCBUZWNobm9sb2dpZXMsIEluYy4xOzA5BgNVBAMTMlN0YXJmaWVs +ZCBTZXJ2aWNlcyBSb290IENlcnRpZmljYXRlIEF1dGhvcml0eSAtIEcyMB4XDTA5 +MDkwMTAwMDAwMFoXDTM3MTIzMTIzNTk1OVowgZgxCzAJBgNVBAYTAlVTMRAwDgYD +VQQIEwdBcml6b25hMRMwEQYDVQQHEwpTY290dHNkYWxlMSUwIwYDVQQKExxTdGFy +ZmllbGQgVGVjaG5vbG9naWVzLCBJbmMuMTswOQYDVQQDEzJTdGFyZmllbGQgU2Vy +dmljZXMgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkgLSBHMjCCASIwDQYJKoZI +hvcNAQEBBQADggEPADCCAQoCggEBANUMOsQq+U7i9b4Zl1+OiFOxHz/Lz58gE20p +OsgPfTz3a3Y4Y9k2YKibXlwAgLIvWX/2h/klQ4bnaRtSmpDhcePYLQ1Ob/bISdm2 +8xpWriu2dBTrz/sm4xq6HZYuajtYlIlHVv8loJNwU4PahHQUw2eeBGg6345AWh1K +Ts9DkTvnVtYAcMtS7nt9rjrnvDH5RfbCYM8TWQIrgMw0R9+53pBlbQLPLJGmpufe +hRhJfGZOozptqbXuNC66DQO4M99H67FrjSXZm86B0UVGMpZwh94CDklDhbZsc7tk +6mFBrMnUVN+HL8cisibMn1lUaJ/8viovxFUcdUBgF4UCVTmLfwUCAwEAAaNCMEAw +DwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFJxfAN+q +AdcwKziIorhtSpzyEZGDMA0GCSqGSIb3DQEBCwUAA4IBAQBLNqaEd2ndOxmfZyMI +bw5hyf2E3F/YNoHN2BtBLZ9g3ccaaNnRbobhiCPPE95Dz+I0swSdHynVv/heyNXB +ve6SbzJ08pGCL72CQnqtKrcgfU28elUSwhXqvfdqlS5sdJ/PHLTyxQGjhdByPq1z +qwubdQxtRbeOlKyWN7Wg0I8VRw7j6IPdj/3vQQF3zCepYoUz8jcI73HPdwbeyBkd +iEDPfUYd/x7H4c7/I9vG+o1VTqkC50cRRj70/b17KSa7qWFiNyi2LSr2EIZkyXCn +0q23KXB56jzaYyWf/Wi3MOxw+3WKt21gZ7IeyLnp2KhvAotnDU0mV3HaIPzBSlCN +sSi6 +-----END CERTIFICATE----- + +# Issuer: CN=AffirmTrust Commercial O=AffirmTrust +# Subject: CN=AffirmTrust Commercial O=AffirmTrust +# Label: "AffirmTrust Commercial" +# Serial: 8608355977964138876 +# MD5 Fingerprint: 82:92:ba:5b:ef:cd:8a:6f:a6:3d:55:f9:84:f6:d6:b7 +# SHA1 Fingerprint: f9:b5:b6:32:45:5f:9c:be:ec:57:5f:80:dc:e9:6e:2c:c7:b2:78:b7 +# SHA256 Fingerprint: 03:76:ab:1d:54:c5:f9:80:3c:e4:b2:e2:01:a0:ee:7e:ef:7b:57:b6:36:e8:a9:3c:9b:8d:48:60:c9:6f:5f:a7 +-----BEGIN CERTIFICATE----- +MIIDTDCCAjSgAwIBAgIId3cGJyapsXwwDQYJKoZIhvcNAQELBQAwRDELMAkGA1UE +BhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MR8wHQYDVQQDDBZBZmZpcm1UcnVz +dCBDb21tZXJjaWFsMB4XDTEwMDEyOTE0MDYwNloXDTMwMTIzMTE0MDYwNlowRDEL +MAkGA1UEBhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MR8wHQYDVQQDDBZBZmZp +cm1UcnVzdCBDb21tZXJjaWFsMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEA9htPZwcroRX1BiLLHwGy43NFBkRJLLtJJRTWzsO3qyxPxkEylFf6EqdbDuKP +Hx6GGaeqtS25Xw2Kwq+FNXkyLbscYjfysVtKPcrNcV/pQr6U6Mje+SJIZMblq8Yr +ba0F8PrVC8+a5fBQpIs7R6UjW3p6+DM/uO+Zl+MgwdYoic+U+7lF7eNAFxHUdPAL +MeIrJmqbTFeurCA+ukV6BfO9m2kVrn1OIGPENXY6BwLJN/3HR+7o8XYdcxXyl6S1 +yHp52UKqK39c/s4mT6NmgTWvRLpUHhwwMmWd5jyTXlBOeuM61G7MGvv50jeuJCqr +VwMiKA1JdX+3KNp1v47j3A55MQIDAQABo0IwQDAdBgNVHQ4EFgQUnZPGU4teyq8/ +nx4P5ZmVvCT2lI8wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwDQYJ +KoZIhvcNAQELBQADggEBAFis9AQOzcAN/wr91LoWXym9e2iZWEnStB03TX8nfUYG +XUPGhi4+c7ImfU+TqbbEKpqrIZcUsd6M06uJFdhrJNTxFq7YpFzUf1GO7RgBsZNj +vbz4YYCanrHOQnDiqX0GJX0nof5v7LMeJNrjS1UaADs1tDvZ110w/YETifLCBivt +Z8SOyUOyXGsViQK8YvxO8rUzqrJv0wqiUOP2O+guRMLbZjipM1ZI8W0bM40NjD9g +N53Tym1+NH4Nn3J2ixufcv1SNUFFApYvHLKac0khsUlHRUe072o0EclNmsxZt9YC +nlpOZbWUrhvfKbAW8b8Angc6F2S1BLUjIZkKlTuXfO8= +-----END CERTIFICATE----- + +# Issuer: CN=AffirmTrust Networking O=AffirmTrust +# Subject: CN=AffirmTrust Networking O=AffirmTrust +# Label: "AffirmTrust Networking" +# Serial: 8957382827206547757 +# MD5 Fingerprint: 42:65:ca:be:01:9a:9a:4c:a9:8c:41:49:cd:c0:d5:7f +# SHA1 Fingerprint: 29:36:21:02:8b:20:ed:02:f5:66:c5:32:d1:d6:ed:90:9f:45:00:2f +# SHA256 Fingerprint: 0a:81:ec:5a:92:97:77:f1:45:90:4a:f3:8d:5d:50:9f:66:b5:e2:c5:8f:cd:b5:31:05:8b:0e:17:f3:f0:b4:1b +-----BEGIN CERTIFICATE----- +MIIDTDCCAjSgAwIBAgIIfE8EORzUmS0wDQYJKoZIhvcNAQEFBQAwRDELMAkGA1UE +BhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MR8wHQYDVQQDDBZBZmZpcm1UcnVz +dCBOZXR3b3JraW5nMB4XDTEwMDEyOTE0MDgyNFoXDTMwMTIzMTE0MDgyNFowRDEL +MAkGA1UEBhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MR8wHQYDVQQDDBZBZmZp +cm1UcnVzdCBOZXR3b3JraW5nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC +AQEAtITMMxcua5Rsa2FSoOujz3mUTOWUgJnLVWREZY9nZOIG41w3SfYvm4SEHi3y +YJ0wTsyEheIszx6e/jarM3c1RNg1lho9Nuh6DtjVR6FqaYvZ/Ls6rnla1fTWcbua +kCNrmreIdIcMHl+5ni36q1Mr3Lt2PpNMCAiMHqIjHNRqrSK6mQEubWXLviRmVSRL +QESxG9fhwoXA3hA/Pe24/PHxI1Pcv2WXb9n5QHGNfb2V1M6+oF4nI979ptAmDgAp +6zxG8D1gvz9Q0twmQVGeFDdCBKNwV6gbh+0t+nvujArjqWaJGctB+d1ENmHP4ndG +yH329JKBNv3bNPFyfvMMFr20FQIDAQABo0IwQDAdBgNVHQ4EFgQUBx/S55zawm6i +QLSwelAQUHTEyL0wDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwDQYJ +KoZIhvcNAQEFBQADggEBAIlXshZ6qML91tmbmzTCnLQyFE2npN/svqe++EPbkTfO +tDIuUFUaNU52Q3Eg75N3ThVwLofDwR1t3Mu1J9QsVtFSUzpE0nPIxBsFZVpikpzu +QY0x2+c06lkh1QF612S4ZDnNye2v7UsDSKegmQGA3GWjNq5lWUhPgkvIZfFXHeVZ +Lgo/bNjR9eUJtGxUAArgFU2HdW23WJZa3W3SAKD0m0i+wzekujbgfIeFlxoVot4u +olu9rxj5kFDNcFn4J2dHy8egBzp90SxdbBk6ZrV9/ZFvgrG+CJPbFEfxojfHRZ48 +x3evZKiT3/Zpg4Jg8klCNO1aAFSFHBY2kgxc+qatv9s= +-----END CERTIFICATE----- + +# Issuer: CN=AffirmTrust Premium O=AffirmTrust +# Subject: CN=AffirmTrust Premium O=AffirmTrust +# Label: "AffirmTrust Premium" +# Serial: 7893706540734352110 +# MD5 Fingerprint: c4:5d:0e:48:b6:ac:28:30:4e:0a:bc:f9:38:16:87:57 +# SHA1 Fingerprint: d8:a6:33:2c:e0:03:6f:b1:85:f6:63:4f:7d:6a:06:65:26:32:28:27 +# SHA256 Fingerprint: 70:a7:3f:7f:37:6b:60:07:42:48:90:45:34:b1:14:82:d5:bf:0e:69:8e:cc:49:8d:f5:25:77:eb:f2:e9:3b:9a +-----BEGIN CERTIFICATE----- +MIIFRjCCAy6gAwIBAgIIbYwURrGmCu4wDQYJKoZIhvcNAQEMBQAwQTELMAkGA1UE +BhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MRwwGgYDVQQDDBNBZmZpcm1UcnVz +dCBQcmVtaXVtMB4XDTEwMDEyOTE0MTAzNloXDTQwMTIzMTE0MTAzNlowQTELMAkG +A1UEBhMCVVMxFDASBgNVBAoMC0FmZmlybVRydXN0MRwwGgYDVQQDDBNBZmZpcm1U +cnVzdCBQcmVtaXVtMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAxBLf +qV/+Qd3d9Z+K4/as4Tx4mrzY8H96oDMq3I0gW64tb+eT2TZwamjPjlGjhVtnBKAQ +JG9dKILBl1fYSCkTtuG+kU3fhQxTGJoeJKJPj/CihQvL9Cl/0qRY7iZNyaqoe5rZ ++jjeRFcV5fiMyNlI4g0WJx0eyIOFJbe6qlVBzAMiSy2RjYvmia9mx+n/K+k8rNrS +s8PhaJyJ+HoAVt70VZVs+7pk3WKL3wt3MutizCaam7uqYoNMtAZ6MMgpv+0GTZe5 +HMQxK9VfvFMSF5yZVylmd2EhMQcuJUmdGPLu8ytxjLW6OQdJd/zvLpKQBY0tL3d7 +70O/Nbua2Plzpyzy0FfuKE4mX4+QaAkvuPjcBukumj5Rp9EixAqnOEhss/n/fauG +V+O61oV4d7pD6kh/9ti+I20ev9E2bFhc8e6kGVQa9QPSdubhjL08s9NIS+LI+H+S +qHZGnEJlPqQewQcDWkYtuJfzt9WyVSHvutxMAJf7FJUnM7/oQ0dG0giZFmA7mn7S +5u046uwBHjxIVkkJx0w3AJ6IDsBz4W9m6XJHMD4Q5QsDyZpCAGzFlH5hxIrff4Ia +C1nEWTJ3s7xgaVY5/bQGeyzWZDbZvUjthB9+pSKPKrhC9IK31FOQeE4tGv2Bb0TX +OwF0lkLgAOIua+rF7nKsu7/+6qqo+Nz2snmKtmcCAwEAAaNCMEAwHQYDVR0OBBYE +FJ3AZ6YMItkm9UWrpmVSESfYRaxjMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/ +BAQDAgEGMA0GCSqGSIb3DQEBDAUAA4ICAQCzV00QYk465KzquByvMiPIs0laUZx2 +KI15qldGF9X1Uva3ROgIRL8YhNILgM3FEv0AVQVhh0HctSSePMTYyPtwni94loMg +Nt58D2kTiKV1NpgIpsbfrM7jWNa3Pt668+s0QNiigfV4Py/VpfzZotReBA4Xrf5B +8OWycvpEgjNC6C1Y91aMYj+6QrCcDFx+LmUmXFNPALJ4fqENmS2NuB2OosSw/WDQ +MKSOyARiqcTtNd56l+0OOF6SL5Nwpamcb6d9Ex1+xghIsV5n61EIJenmJWtSKZGc +0jlzCFfemQa0W50QBuHCAKi4HEoCChTQwUHK+4w1IX2COPKpVJEZNZOUbWo6xbLQ +u4mGk+ibyQ86p3q4ofB4Rvr8Ny/lioTz3/4E2aFooC8k4gmVBtWVyuEklut89pMF +u+1z6S3RdTnX5yTb2E5fQ4+e0BQ5v1VwSJlXMbSc7kqYA5YwH2AG7hsj/oFgIxpH +YoWlzBk0gG+zrBrjn/B7SK3VAdlntqlyk+otZrWyuOQ9PLLvTIzq6we/qzWaVYa8 +GKa1qF60g2xraUDTn9zxw2lrueFtCfTxqlB2Cnp9ehehVZZCmTEJ3WARjQUwfuaO +RtGdFNrHF+QFlozEJLUbzxQHskD4o55BhrwE0GuWyCqANP2/7waj3VjFhT0+j/6e +KeC2uAloGRwYQw== +-----END CERTIFICATE----- + +# Issuer: CN=AffirmTrust Premium ECC O=AffirmTrust +# Subject: CN=AffirmTrust Premium ECC O=AffirmTrust +# Label: "AffirmTrust Premium ECC" +# Serial: 8401224907861490260 +# MD5 Fingerprint: 64:b0:09:55:cf:b1:d5:99:e2:be:13:ab:a6:5d:ea:4d +# SHA1 Fingerprint: b8:23:6b:00:2f:1d:16:86:53:01:55:6c:11:a4:37:ca:eb:ff:c3:bb +# SHA256 Fingerprint: bd:71:fd:f6:da:97:e4:cf:62:d1:64:7a:dd:25:81:b0:7d:79:ad:f8:39:7e:b4:ec:ba:9c:5e:84:88:82:14:23 +-----BEGIN CERTIFICATE----- +MIIB/jCCAYWgAwIBAgIIdJclisc/elQwCgYIKoZIzj0EAwMwRTELMAkGA1UEBhMC +VVMxFDASBgNVBAoMC0FmZmlybVRydXN0MSAwHgYDVQQDDBdBZmZpcm1UcnVzdCBQ +cmVtaXVtIEVDQzAeFw0xMDAxMjkxNDIwMjRaFw00MDEyMzExNDIwMjRaMEUxCzAJ +BgNVBAYTAlVTMRQwEgYDVQQKDAtBZmZpcm1UcnVzdDEgMB4GA1UEAwwXQWZmaXJt +VHJ1c3QgUHJlbWl1bSBFQ0MwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQNMF4bFZ0D +0KF5Nbc6PJJ6yhUczWLznCZcBz3lVPqj1swS6vQUX+iOGasvLkjmrBhDeKzQN8O9 +ss0s5kfiGuZjuD0uL3jET9v0D6RoTFVya5UdThhClXjMNzyR4ptlKymjQjBAMB0G +A1UdDgQWBBSaryl6wBE1NSZRMADDav5A1a7WPDAPBgNVHRMBAf8EBTADAQH/MA4G +A1UdDwEB/wQEAwIBBjAKBggqhkjOPQQDAwNnADBkAjAXCfOHiFBar8jAQr9HX/Vs +aobgxCd05DhT1wV/GzTjxi+zygk8N53X57hG8f2h4nECMEJZh0PUUd+60wkyWs6I +flc9nF9Ca/UHLbXwgpP5WW+uZPpY5Yse42O+tYHNbwKMeQ== +-----END CERTIFICATE----- + +# Issuer: CN=Certum Trusted Network CA O=Unizeto Technologies S.A. OU=Certum Certification Authority +# Subject: CN=Certum Trusted Network CA O=Unizeto Technologies S.A. OU=Certum Certification Authority +# Label: "Certum Trusted Network CA" +# Serial: 279744 +# MD5 Fingerprint: d5:e9:81:40:c5:18:69:fc:46:2c:89:75:62:0f:aa:78 +# SHA1 Fingerprint: 07:e0:32:e0:20:b7:2c:3f:19:2f:06:28:a2:59:3a:19:a7:0f:06:9e +# SHA256 Fingerprint: 5c:58:46:8d:55:f5:8e:49:7e:74:39:82:d2:b5:00:10:b6:d1:65:37:4a:cf:83:a7:d4:a3:2d:b7:68:c4:40:8e +-----BEGIN CERTIFICATE----- +MIIDuzCCAqOgAwIBAgIDBETAMA0GCSqGSIb3DQEBBQUAMH4xCzAJBgNVBAYTAlBM +MSIwIAYDVQQKExlVbml6ZXRvIFRlY2hub2xvZ2llcyBTLkEuMScwJQYDVQQLEx5D +ZXJ0dW0gQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxIjAgBgNVBAMTGUNlcnR1bSBU +cnVzdGVkIE5ldHdvcmsgQ0EwHhcNMDgxMDIyMTIwNzM3WhcNMjkxMjMxMTIwNzM3 +WjB+MQswCQYDVQQGEwJQTDEiMCAGA1UEChMZVW5pemV0byBUZWNobm9sb2dpZXMg +Uy5BLjEnMCUGA1UECxMeQ2VydHVtIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MSIw +IAYDVQQDExlDZXJ0dW0gVHJ1c3RlZCBOZXR3b3JrIENBMIIBIjANBgkqhkiG9w0B +AQEFAAOCAQ8AMIIBCgKCAQEA4/t9o3K6wvDJFIf1awFO4W5AB7ptJ11/91sts1rH +UV+rpDKmYYe2bg+G0jACl/jXaVehGDldamR5xgFZrDwxSjh80gTSSyjoIF87B6LM +TXPb865Px1bVWqeWifrzq2jUI4ZZJ88JJ7ysbnKDHDBy3+Ci6dLhdHUZvSqeexVU +BBvXQzmtVSjF4hq79MDkrjhJM8x2hZ85RdKknvISjFH4fOQtf/WsX+sWn7Et0brM +kUJ3TCXJkDhv2/DM+44el1k+1WBO5gUo7Ul5E0u6SNsv+XLTOcr+H9g0cvW0QM8x +AcPs3hEtF10fuFDRXhmnad4HMyjKUJX5p1TLVIZQRan5SQIDAQABo0IwQDAPBgNV +HRMBAf8EBTADAQH/MB0GA1UdDgQWBBQIds3LB/8k9sXN7buQvOKEN0Z19zAOBgNV +HQ8BAf8EBAMCAQYwDQYJKoZIhvcNAQEFBQADggEBAKaorSLOAT2mo/9i0Eidi15y +sHhE49wcrwn9I0j6vSrEuVUEtRCjjSfeC4Jj0O7eDDd5QVsisrCaQVymcODU0HfL +I9MA4GxWL+FpDQ3Zqr8hgVDZBqWo/5U30Kr+4rP1mS1FhIrlQgnXdAIv94nYmem8 +J9RHjboNRhx3zxSkHLmkMcScKHQDNP8zGSal6Q10tz6XxnboJ5ajZt3hrvJBW8qY +VoNzcOSGGtIxQbovvi0TWnZvTuhOgQ4/WwMioBK+ZlgRSssDxLQqKi2WF+A5VLxI +03YnnZotBqbJ7DnSq9ufmgsnAjUpsUCV5/nonFWIGUbWtzT1fs45mtk48VH3Tyw= +-----END CERTIFICATE----- + +# Issuer: CN=TWCA Root Certification Authority O=TAIWAN-CA OU=Root CA +# Subject: CN=TWCA Root Certification Authority O=TAIWAN-CA OU=Root CA +# Label: "TWCA Root Certification Authority" +# Serial: 1 +# MD5 Fingerprint: aa:08:8f:f6:f9:7b:b7:f2:b1:a7:1e:9b:ea:ea:bd:79 +# SHA1 Fingerprint: cf:9e:87:6d:d3:eb:fc:42:26:97:a3:b5:a3:7a:a0:76:a9:06:23:48 +# SHA256 Fingerprint: bf:d8:8f:e1:10:1c:41:ae:3e:80:1b:f8:be:56:35:0e:e9:ba:d1:a6:b9:bd:51:5e:dc:5c:6d:5b:87:11:ac:44 +-----BEGIN CERTIFICATE----- +MIIDezCCAmOgAwIBAgIBATANBgkqhkiG9w0BAQUFADBfMQswCQYDVQQGEwJUVzES +MBAGA1UECgwJVEFJV0FOLUNBMRAwDgYDVQQLDAdSb290IENBMSowKAYDVQQDDCFU +V0NBIFJvb3QgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMDgwODI4MDcyNDMz +WhcNMzAxMjMxMTU1OTU5WjBfMQswCQYDVQQGEwJUVzESMBAGA1UECgwJVEFJV0FO +LUNBMRAwDgYDVQQLDAdSb290IENBMSowKAYDVQQDDCFUV0NBIFJvb3QgQ2VydGlm +aWNhdGlvbiBBdXRob3JpdHkwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB +AQCwfnK4pAOU5qfeCTiRShFAh6d8WWQUe7UREN3+v9XAu1bihSX0NXIP+FPQQeFE +AcK0HMMxQhZHhTMidrIKbw/lJVBPhYa+v5guEGcevhEFhgWQxFnQfHgQsIBct+HH +K3XLfJ+utdGdIzdjp9xCoi2SBBtQwXu4PhvJVgSLL1KbralW6cH/ralYhzC2gfeX +RfwZVzsrb+RH9JlF/h3x+JejiB03HFyP4HYlmlD4oFT/RJB2I9IyxsOrBr/8+7/z +rX2SYgJbKdM1o5OaQ2RgXbL6Mv87BK9NQGr5x+PvI/1ry+UPizgN7gr8/g+YnzAx +3WxSZfmLgb4i4RxYA7qRG4kHAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV +HRMBAf8EBTADAQH/MB0GA1UdDgQWBBRqOFsmjd6LWvJPelSDGRjjCDWmujANBgkq +hkiG9w0BAQUFAAOCAQEAPNV3PdrfibqHDAhUaiBQkr6wQT25JmSDCi/oQMCXKCeC +MErJk/9q56YAf4lCmtYR5VPOL8zy2gXE/uJQxDqGfczafhAJO5I1KlOy/usrBdls +XebQ79NqZp4VKIV66IIArB6nCWlWQtNoURi+VJq/REG6Sb4gumlc7rh3zc5sH62D +lhh9DrUUOYTxKOkto557HnpyWoOzeW/vtPzQCqVYT0bf+215WfKEIlKuD8z7fDvn +aspHYcN6+NOSBB+4IIThNlQWx0DeO4pz3N/GCUzf7Nr/1FNCocnyYh0igzyXxfkZ +YiesZSLX0zzG5Y6yU8xJzrww/nsOM5D77dIUkR8Hrw== +-----END CERTIFICATE----- + +# Issuer: O=SECOM Trust Systems CO.,LTD. OU=Security Communication RootCA2 +# Subject: O=SECOM Trust Systems CO.,LTD. OU=Security Communication RootCA2 +# Label: "Security Communication RootCA2" +# Serial: 0 +# MD5 Fingerprint: 6c:39:7d:a4:0e:55:59:b2:3f:d6:41:b1:12:50:de:43 +# SHA1 Fingerprint: 5f:3b:8c:f2:f8:10:b3:7d:78:b4:ce:ec:19:19:c3:73:34:b9:c7:74 +# SHA256 Fingerprint: 51:3b:2c:ec:b8:10:d4:cd:e5:dd:85:39:1a:df:c6:c2:dd:60:d8:7b:b7:36:d2:b5:21:48:4a:a4:7a:0e:be:f6 +-----BEGIN CERTIFICATE----- +MIIDdzCCAl+gAwIBAgIBADANBgkqhkiG9w0BAQsFADBdMQswCQYDVQQGEwJKUDEl +MCMGA1UEChMcU0VDT00gVHJ1c3QgU3lzdGVtcyBDTy4sTFRELjEnMCUGA1UECxMe +U2VjdXJpdHkgQ29tbXVuaWNhdGlvbiBSb290Q0EyMB4XDTA5MDUyOTA1MDAzOVoX +DTI5MDUyOTA1MDAzOVowXTELMAkGA1UEBhMCSlAxJTAjBgNVBAoTHFNFQ09NIFRy +dXN0IFN5c3RlbXMgQ08uLExURC4xJzAlBgNVBAsTHlNlY3VyaXR5IENvbW11bmlj +YXRpb24gUm9vdENBMjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBANAV +OVKxUrO6xVmCxF1SrjpDZYBLx/KWvNs2l9amZIyoXvDjChz335c9S672XewhtUGr +zbl+dp+++T42NKA7wfYxEUV0kz1XgMX5iZnK5atq1LXaQZAQwdbWQonCv/Q4EpVM +VAX3NuRFg3sUZdbcDE3R3n4MqzvEFb46VqZab3ZpUql6ucjrappdUtAtCms1FgkQ +hNBqyjoGADdH5H5XTz+L62e4iKrFvlNVspHEfbmwhRkGeC7bYRr6hfVKkaHnFtWO +ojnflLhwHyg/i/xAXmODPIMqGplrz95Zajv8bxbXH/1KEOtOghY6rCcMU/Gt1SSw +awNQwS08Ft1ENCcadfsCAwEAAaNCMEAwHQYDVR0OBBYEFAqFqXdlBZh8QIH4D5cs +OPEK7DzPMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3 +DQEBCwUAA4IBAQBMOqNErLlFsceTfsgLCkLfZOoc7llsCLqJX2rKSpWeeo8HxdpF +coJxDjrSzG+ntKEju/Ykn8sX/oymzsLS28yN/HH8AynBbF0zX2S2ZTuJbxh2ePXc +okgfGT+Ok+vx+hfuzU7jBBJV1uXk3fs+BXziHV7Gp7yXT2g69ekuCkO2r1dcYmh8 +t/2jioSgrGK+KwmHNPBqAbubKVY8/gA3zyNs8U6qtnRGEmyR7jTV7JqR50S+kDFy +1UkC9gLl9B/rfNmWVan/7Ir5mUf/NVoCqgTLiluHcSmRvaS0eg29mvVXIwAHIRc/ +SjnRBUkLp7Y3gaVdjKozXoEofKd9J+sAro03 +-----END CERTIFICATE----- + +# Issuer: CN=Hellenic Academic and Research Institutions RootCA 2011 O=Hellenic Academic and Research Institutions Cert. Authority +# Subject: CN=Hellenic Academic and Research Institutions RootCA 2011 O=Hellenic Academic and Research Institutions Cert. Authority +# Label: "Hellenic Academic and Research Institutions RootCA 2011" +# Serial: 0 +# MD5 Fingerprint: 73:9f:4c:4b:73:5b:79:e9:fa:ba:1c:ef:6e:cb:d5:c9 +# SHA1 Fingerprint: fe:45:65:9b:79:03:5b:98:a1:61:b5:51:2e:ac:da:58:09:48:22:4d +# SHA256 Fingerprint: bc:10:4f:15:a4:8b:e7:09:dc:a5:42:a7:e1:d4:b9:df:6f:05:45:27:e8:02:ea:a9:2d:59:54:44:25:8a:fe:71 +-----BEGIN CERTIFICATE----- +MIIEMTCCAxmgAwIBAgIBADANBgkqhkiG9w0BAQUFADCBlTELMAkGA1UEBhMCR1Ix +RDBCBgNVBAoTO0hlbGxlbmljIEFjYWRlbWljIGFuZCBSZXNlYXJjaCBJbnN0aXR1 +dGlvbnMgQ2VydC4gQXV0aG9yaXR5MUAwPgYDVQQDEzdIZWxsZW5pYyBBY2FkZW1p +YyBhbmQgUmVzZWFyY2ggSW5zdGl0dXRpb25zIFJvb3RDQSAyMDExMB4XDTExMTIw +NjEzNDk1MloXDTMxMTIwMTEzNDk1MlowgZUxCzAJBgNVBAYTAkdSMUQwQgYDVQQK +EztIZWxsZW5pYyBBY2FkZW1pYyBhbmQgUmVzZWFyY2ggSW5zdGl0dXRpb25zIENl +cnQuIEF1dGhvcml0eTFAMD4GA1UEAxM3SGVsbGVuaWMgQWNhZGVtaWMgYW5kIFJl +c2VhcmNoIEluc3RpdHV0aW9ucyBSb290Q0EgMjAxMTCCASIwDQYJKoZIhvcNAQEB +BQADggEPADCCAQoCggEBAKlTAOMupvaO+mDYLZU++CwqVE7NuYRhlFhPjz2L5EPz +dYmNUeTDN9KKiE15HrcS3UN4SoqS5tdI1Q+kOilENbgH9mgdVc04UfCMJDGFr4PJ +fel3r+0ae50X+bOdOFAPplp5kYCvN66m0zH7tSYJnTxa71HFK9+WXesyHgLacEns +bgzImjeN9/E2YEsmLIKe0HjzDQ9jpFEw4fkrJxIH2Oq9GGKYsFk3fb7u8yBRQlqD +75O6aRXxYp2fmTmCobd0LovUxQt7L/DICto9eQqakxylKHJzkUOap9FNhYS5qXSP +FEDH3N6sQWRstBmbAmNtJGSPRLIl6s5ddAxjMlyNh+UCAwEAAaOBiTCBhjAPBgNV +HRMBAf8EBTADAQH/MAsGA1UdDwQEAwIBBjAdBgNVHQ4EFgQUppFC/RNhSiOeCKQp +5dgTBCPuQSUwRwYDVR0eBEAwPqA8MAWCAy5ncjAFggMuZXUwBoIELmVkdTAGggQu +b3JnMAWBAy5ncjAFgQMuZXUwBoEELmVkdTAGgQQub3JnMA0GCSqGSIb3DQEBBQUA +A4IBAQAf73lB4XtuP7KMhjdCSk4cNx6NZrokgclPEg8hwAOXhiVtXdMiKahsog2p +6z0GW5k6x8zDmjR/qw7IThzh+uTczQ2+vyT+bOdrwg3IBp5OjWEopmr95fZi6hg8 +TqBTnbI6nOulnJEWtk2C4AwFSKls9cz4y51JtPACpf1wA+2KIaWuE4ZJwzNzvoc7 +dIsXRSZMFpGD/md9zU1jZ/rzAxKWeAaNsWftjj++n08C9bMJL/NMh98qy5V8Acys +Nnq/onN694/BtZqhFLKPM58N7yLcZnuEvUUXBj08yrl3NI/K6s8/MT7jiOOASSXI +l7WdmplNsDz4SgCbZN2fOUvRJ9e4 +-----END CERTIFICATE----- + +# Issuer: CN=Actalis Authentication Root CA O=Actalis S.p.A./03358520967 +# Subject: CN=Actalis Authentication Root CA O=Actalis S.p.A./03358520967 +# Label: "Actalis Authentication Root CA" +# Serial: 6271844772424770508 +# MD5 Fingerprint: 69:c1:0d:4f:07:a3:1b:c3:fe:56:3d:04:bc:11:f6:a6 +# SHA1 Fingerprint: f3:73:b3:87:06:5a:28:84:8a:f2:f3:4a:ce:19:2b:dd:c7:8e:9c:ac +# SHA256 Fingerprint: 55:92:60:84:ec:96:3a:64:b9:6e:2a:be:01:ce:0b:a8:6a:64:fb:fe:bc:c7:aa:b5:af:c1:55:b3:7f:d7:60:66 +-----BEGIN CERTIFICATE----- +MIIFuzCCA6OgAwIBAgIIVwoRl0LE48wwDQYJKoZIhvcNAQELBQAwazELMAkGA1UE +BhMCSVQxDjAMBgNVBAcMBU1pbGFuMSMwIQYDVQQKDBpBY3RhbGlzIFMucC5BLi8w +MzM1ODUyMDk2NzEnMCUGA1UEAwweQWN0YWxpcyBBdXRoZW50aWNhdGlvbiBSb290 +IENBMB4XDTExMDkyMjExMjIwMloXDTMwMDkyMjExMjIwMlowazELMAkGA1UEBhMC +SVQxDjAMBgNVBAcMBU1pbGFuMSMwIQYDVQQKDBpBY3RhbGlzIFMucC5BLi8wMzM1 +ODUyMDk2NzEnMCUGA1UEAwweQWN0YWxpcyBBdXRoZW50aWNhdGlvbiBSb290IENB +MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAp8bEpSmkLO/lGMWwUKNv +UTufClrJwkg4CsIcoBh/kbWHuUA/3R1oHwiD1S0eiKD4j1aPbZkCkpAW1V8IbInX +4ay8IMKx4INRimlNAJZaby/ARH6jDuSRzVju3PvHHkVH3Se5CAGfpiEd9UEtL0z9 +KK3giq0itFZljoZUj5NDKd45RnijMCO6zfB9E1fAXdKDa0hMxKufgFpbOr3JpyI/ +gCczWw63igxdBzcIy2zSekciRDXFzMwujt0q7bd9Zg1fYVEiVRvjRuPjPdA1Yprb +rxTIW6HMiRvhMCb8oJsfgadHHwTrozmSBp+Z07/T6k9QnBn+locePGX2oxgkg4YQ +51Q+qDp2JE+BIcXjDwL4k5RHILv+1A7TaLndxHqEguNTVHnd25zS8gebLra8Pu2F +be8lEfKXGkJh90qX6IuxEAf6ZYGyojnP9zz/GPvG8VqLWeICrHuS0E4UT1lF9gxe +KF+w6D9Fz8+vm2/7hNN3WpVvrJSEnu68wEqPSpP4RCHiMUVhUE4Q2OM1fEwZtN4F +v6MGn8i1zeQf1xcGDXqVdFUNaBr8EBtiZJ1t4JWgw5QHVw0U5r0F+7if5t+L4sbn +fpb2U8WANFAoWPASUHEXMLrmeGO89LKtmyuy/uE5jF66CyCU3nuDuP/jVo23Eek7 +jPKxwV2dpAtMK9myGPW1n0sCAwEAAaNjMGEwHQYDVR0OBBYEFFLYiDrIn3hm7Ynz +ezhwlMkCAjbQMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUUtiIOsifeGbt +ifN7OHCUyQICNtAwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQAL +e3KHwGCmSUyIWOYdiPcUZEim2FgKDk8TNd81HdTtBjHIgT5q1d07GjLukD0R0i70 +jsNjLiNmsGe+b7bAEzlgqqI0JZN1Ut6nna0Oh4lScWoWPBkdg/iaKWW+9D+a2fDz +WochcYBNy+A4mz+7+uAwTc+G02UQGRjRlwKxK3JCaKygvU5a2hi/a5iB0P2avl4V +SM0RFbnAKVy06Ij3Pjaut2L9HmLecHgQHEhb2rykOLpn7VU+Xlff1ANATIGk0k9j +pwlCCRT8AKnCgHNPLsBA2RF7SOp6AsDT6ygBJlh0wcBzIm2Tlf05fbsq4/aC4yyX +X04fkZT6/iyj2HYauE2yOE+b+h1IYHkm4vP9qdCa6HCPSXrW5b0KDtst842/6+Ok +fcvHlXHo2qN8xcL4dJIEG4aspCJTQLas/kx2z/uUMsA1n3Y/buWQbqCmJqK4LL7R +K4X9p2jIugErsWx0Hbhzlefut8cl8ABMALJ+tguLHPPAUJ4lueAI3jZm/zel0btU +ZCzJJ7VLkn5l/9Mt4blOvH+kQSGQQXemOR/qnuOf0GZvBeyqdn6/axag67XH/JJU +LysRJyU3eExRarDzzFhdFPFqSBX/wge2sY0PjlxQRrM9vwGYT7JZVEc+NHt4bVaT +LnPqZih4zR0Uv6CPLy64Lo7yFIrM6bV8+2ydDKXhlg== +-----END CERTIFICATE----- + +# Issuer: O=Trustis Limited OU=Trustis FPS Root CA +# Subject: O=Trustis Limited OU=Trustis FPS Root CA +# Label: "Trustis FPS Root CA" +# Serial: 36053640375399034304724988975563710553 +# MD5 Fingerprint: 30:c9:e7:1e:6b:e6:14:eb:65:b2:16:69:20:31:67:4d +# SHA1 Fingerprint: 3b:c0:38:0b:33:c3:f6:a6:0c:86:15:22:93:d9:df:f5:4b:81:c0:04 +# SHA256 Fingerprint: c1:b4:82:99:ab:a5:20:8f:e9:63:0a:ce:55:ca:68:a0:3e:da:5a:51:9c:88:02:a0:d3:a6:73:be:8f:8e:55:7d +-----BEGIN CERTIFICATE----- +MIIDZzCCAk+gAwIBAgIQGx+ttiD5JNM2a/fH8YygWTANBgkqhkiG9w0BAQUFADBF +MQswCQYDVQQGEwJHQjEYMBYGA1UEChMPVHJ1c3RpcyBMaW1pdGVkMRwwGgYDVQQL +ExNUcnVzdGlzIEZQUyBSb290IENBMB4XDTAzMTIyMzEyMTQwNloXDTI0MDEyMTEx +MzY1NFowRTELMAkGA1UEBhMCR0IxGDAWBgNVBAoTD1RydXN0aXMgTGltaXRlZDEc +MBoGA1UECxMTVHJ1c3RpcyBGUFMgUm9vdCBDQTCCASIwDQYJKoZIhvcNAQEBBQAD +ggEPADCCAQoCggEBAMVQe547NdDfxIzNjpvto8A2mfRC6qc+gIMPpqdZh8mQRUN+ +AOqGeSoDvT03mYlmt+WKVoaTnGhLaASMk5MCPjDSNzoiYYkchU59j9WvezX2fihH +iTHcDnlkH5nSW7r+f2C/revnPDgpai/lkQtV/+xvWNUtyd5MZnGPDNcE2gfmHhjj +vSkCqPoc4Vu5g6hBSLwacY3nYuUtsuvffM/bq1rKMfFMIvMFE/eC+XN5DL7XSxzA +0RU8k0Fk0ea+IxciAIleH2ulrG6nS4zto3Lmr2NNL4XSFDWaLk6M6jKYKIahkQlB +OrTh4/L68MkKokHdqeMDx4gVOxzUGpTXn2RZEm0CAwEAAaNTMFEwDwYDVR0TAQH/ +BAUwAwEB/zAfBgNVHSMEGDAWgBS6+nEleYtXQSUhhgtx67JkDoshZzAdBgNVHQ4E +FgQUuvpxJXmLV0ElIYYLceuyZA6LIWcwDQYJKoZIhvcNAQEFBQADggEBAH5Y//01 +GX2cGE+esCu8jowU/yyg2kdbw++BLa8F6nRIW/M+TgfHbcWzk88iNVy2P3UnXwmW +zaD+vkAMXBJV+JOCyinpXj9WV4s4NvdFGkwozZ5BuO1WTISkQMi4sKUraXAEasP4 +1BIy+Q7DsdwyhEQsb8tGD+pmQQ9P8Vilpg0ND2HepZ5dfWWhPBfnqFVO76DH7cZE +f1T1o+CP8HxVIo8ptoGj4W1OLBuAZ+ytIJ8MYmHVl/9D7S3B2l0pKoU/rGXuhg8F +jZBf3+6f9L/uHfuY5H+QK4R4EA5sSVPvFVtlRkpdr7r7OnIdzfYliB6XzCGcKQEN +ZetX2fNXlrtIzYE= +-----END CERTIFICATE----- + +# Issuer: CN=Buypass Class 2 Root CA O=Buypass AS-983163327 +# Subject: CN=Buypass Class 2 Root CA O=Buypass AS-983163327 +# Label: "Buypass Class 2 Root CA" +# Serial: 2 +# MD5 Fingerprint: 46:a7:d2:fe:45:fb:64:5a:a8:59:90:9b:78:44:9b:29 +# SHA1 Fingerprint: 49:0a:75:74:de:87:0a:47:fe:58:ee:f6:c7:6b:eb:c6:0b:12:40:99 +# SHA256 Fingerprint: 9a:11:40:25:19:7c:5b:b9:5d:94:e6:3d:55:cd:43:79:08:47:b6:46:b2:3c:df:11:ad:a4:a0:0e:ff:15:fb:48 +-----BEGIN CERTIFICATE----- +MIIFWTCCA0GgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBOMQswCQYDVQQGEwJOTzEd +MBsGA1UECgwUQnV5cGFzcyBBUy05ODMxNjMzMjcxIDAeBgNVBAMMF0J1eXBhc3Mg +Q2xhc3MgMiBSb290IENBMB4XDTEwMTAyNjA4MzgwM1oXDTQwMTAyNjA4MzgwM1ow +TjELMAkGA1UEBhMCTk8xHTAbBgNVBAoMFEJ1eXBhc3MgQVMtOTgzMTYzMzI3MSAw +HgYDVQQDDBdCdXlwYXNzIENsYXNzIDIgUm9vdCBDQTCCAiIwDQYJKoZIhvcNAQEB +BQADggIPADCCAgoCggIBANfHXvfBB9R3+0Mh9PT1aeTuMgHbo4Yf5FkNuud1g1Lr +6hxhFUi7HQfKjK6w3Jad6sNgkoaCKHOcVgb/S2TwDCo3SbXlzwx87vFKu3MwZfPV +L4O2fuPn9Z6rYPnT8Z2SdIrkHJasW4DptfQxh6NR/Md+oW+OU3fUl8FVM5I+GC91 +1K2GScuVr1QGbNgGE41b/+EmGVnAJLqBcXmQRFBoJJRfuLMR8SlBYaNByyM21cHx +MlAQTn/0hpPshNOOvEu/XAFOBz3cFIqUCqTqc/sLUegTBxj6DvEr0VQVfTzh97QZ +QmdiXnfgolXsttlpF9U6r0TtSsWe5HonfOV116rLJeffawrbD02TTqigzXsu8lkB +arcNuAeBfos4GzjmCleZPe4h6KP1DBbdi+w0jpwqHAAVF41og9JwnxgIzRFo1clr +Us3ERo/ctfPYV3Me6ZQ5BL/T3jjetFPsaRyifsSP5BtwrfKi+fv3FmRmaZ9JUaLi +FRhnBkp/1Wy1TbMz4GHrXb7pmA8y1x1LPC5aAVKRCfLf6o3YBkBjqhHk/sM3nhRS +P/TizPJhk9H9Z2vXUq6/aKtAQ6BXNVN48FP4YUIHZMbXb5tMOA1jrGKvNouicwoN +9SG9dKpN6nIDSdvHXx1iY8f93ZHsM+71bbRuMGjeyNYmsHVee7QHIJihdjK4TWxP +AgMBAAGjQjBAMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFMmAd+BikoL1Rpzz +uvdMw964o605MA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAgEAU18h +9bqwOlI5LJKwbADJ784g7wbylp7ppHR/ehb8t/W2+xUbP6umwHJdELFx7rxP462s +A20ucS6vxOOto70MEae0/0qyexAQH6dXQbLArvQsWdZHEIjzIVEpMMpghq9Gqx3t +OluwlN5E40EIosHsHdb9T7bWR9AUC8rmyrV7d35BH16Dx7aMOZawP5aBQW9gkOLo ++fsicdl9sz1Gv7SEr5AcD48Saq/v7h56rgJKihcrdv6sVIkkLE8/trKnToyokZf7 +KcZ7XC25y2a2t6hbElGFtQl+Ynhw/qlqYLYdDnkM/crqJIByw5c/8nerQyIKx+u2 +DISCLIBrQYoIwOula9+ZEsuK1V6ADJHgJgg2SMX6OBE1/yWDLfJ6v9r9jv6ly0Us +H8SIU653DtmadsWOLB2jutXsMq7Aqqz30XpN69QH4kj3Io6wpJ9qzo6ysmD0oyLQ +I+uUWnpp3Q+/QFesa1lQ2aOZ4W7+jQF5JyMV3pKdewlNWudLSDBaGOYKbeaP4NK7 +5t98biGCwWg5TbSYWGZizEqQXsP6JwSxeRV0mcy+rSDeJmAc61ZRpqPq5KM/p/9h +3PFaTWwyI0PurKju7koSCTxdccK+efrCh2gdC/1cacwG0Jp9VJkqyTkaGa9LKkPz +Y11aWOIv4x3kqdbQCtCev9eBCfHJxyYNrJgWVqA= +-----END CERTIFICATE----- + +# Issuer: CN=Buypass Class 3 Root CA O=Buypass AS-983163327 +# Subject: CN=Buypass Class 3 Root CA O=Buypass AS-983163327 +# Label: "Buypass Class 3 Root CA" +# Serial: 2 +# MD5 Fingerprint: 3d:3b:18:9e:2c:64:5a:e8:d5:88:ce:0e:f9:37:c2:ec +# SHA1 Fingerprint: da:fa:f7:fa:66:84:ec:06:8f:14:50:bd:c7:c2:81:a5:bc:a9:64:57 +# SHA256 Fingerprint: ed:f7:eb:bc:a2:7a:2a:38:4d:38:7b:7d:40:10:c6:66:e2:ed:b4:84:3e:4c:29:b4:ae:1d:5b:93:32:e6:b2:4d +-----BEGIN CERTIFICATE----- +MIIFWTCCA0GgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBOMQswCQYDVQQGEwJOTzEd +MBsGA1UECgwUQnV5cGFzcyBBUy05ODMxNjMzMjcxIDAeBgNVBAMMF0J1eXBhc3Mg +Q2xhc3MgMyBSb290IENBMB4XDTEwMTAyNjA4Mjg1OFoXDTQwMTAyNjA4Mjg1OFow +TjELMAkGA1UEBhMCTk8xHTAbBgNVBAoMFEJ1eXBhc3MgQVMtOTgzMTYzMzI3MSAw +HgYDVQQDDBdCdXlwYXNzIENsYXNzIDMgUm9vdCBDQTCCAiIwDQYJKoZIhvcNAQEB +BQADggIPADCCAgoCggIBAKXaCpUWUOOV8l6ddjEGMnqb8RB2uACatVI2zSRHsJ8Y +ZLya9vrVediQYkwiL944PdbgqOkcLNt4EemOaFEVcsfzM4fkoF0LXOBXByow9c3E +N3coTRiR5r/VUv1xLXA+58bEiuPwKAv0dpihi4dVsjoT/Lc+JzeOIuOoTyrvYLs9 +tznDDgFHmV0ST9tD+leh7fmdvhFHJlsTmKtdFoqwNxxXnUX/iJY2v7vKB3tvh2PX +0DJq1l1sDPGzbjniazEuOQAnFN44wOwZZoYS6J1yFhNkUsepNxz9gjDthBgd9K5c +/3ATAOux9TN6S9ZV+AWNS2mw9bMoNlwUxFFzTWsL8TQH2xc519woe2v1n/MuwU8X +KhDzzMro6/1rqy6any2CbgTUUgGTLT2G/H783+9CHaZr77kgxve9oKeV/afmiSTY +zIw0bOIjL9kSGiG5VZFvC5F5GQytQIgLcOJ60g7YaEi7ghM5EFjp2CoHxhLbWNvS +O1UQRwUVZ2J+GGOmRj8JDlQyXr8NYnon74Do29lLBlo3WiXQCBJ31G8JUJc9yB3D +34xFMFbG02SrZvPAXpacw8Tvw3xrizp5f7NJzz3iiZ+gMEuFuZyUJHmPfWupRWgP +K9Dx2hzLabjKSWJtyNBjYt1gD1iqj6G8BaVmos8bdrKEZLFMOVLAMLrwjEsCsLa3 +AgMBAAGjQjBAMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFEe4zf/lb+74suwv +Tg75JbCOPGvDMA4GA1UdDwEB/wQEAwIBBjANBgkqhkiG9w0BAQsFAAOCAgEAACAj +QTUEkMJAYmDv4jVM1z+s4jSQuKFvdvoWFqRINyzpkMLyPPgKn9iB5btb2iUspKdV +cSQy9sgL8rxq+JOssgfCX5/bzMiKqr5qb+FJEMwx14C7u8jYog5kV+qi9cKpMRXS +IGrs/CIBKM+GuIAeqcwRpTzyFrNHnfzSgCHEy9BHcEGhyoMZCCxt8l13nIoUE9Q2 +HJLw5QY33KbmkJs4j1xrG0aGQ0JfPgEHU1RdZX33inOhmlRaHylDFCfChQ+1iHsa +O5S3HWCntZznKWlXWpuTekMwGwPXYshApqr8ZORK15FTAaggiG6cX0S5y2CBNOxv +033aSF/rtJC8LakcC6wc1aJoIIAE1vyxjy+7SjENSoYc6+I2KSb12tjE8nVhz36u +dmNKekBlk4f4HoCMhuWG1o8O/FMsYOgWYRqiPkN7zTlgVGr18okmAWiDSKIz6MkE +kbIRNBE+6tBDGR8Dk5AM/1E9V/RBbuHLoL7ryWPNbczk+DaqaJ3tvV2XcEQNtg41 +3OEMXbugUZTLfhbrES+jkkXITHHZvMmZUldGL1DPvTVp9D0VzgalLA8+9oG6lLvD +u79leNKGef9JOxqDDPDeeOzI8k1MGt6CKfjBWtrt7uYnXuhF0J0cUahoq0Tj0Itq +4/g7u9xN12TyUb7mqqta6THuBrxzvxNiCp/HuZc= +-----END CERTIFICATE----- + +# Issuer: CN=T-TeleSec GlobalRoot Class 3 O=T-Systems Enterprise Services GmbH OU=T-Systems Trust Center +# Subject: CN=T-TeleSec GlobalRoot Class 3 O=T-Systems Enterprise Services GmbH OU=T-Systems Trust Center +# Label: "T-TeleSec GlobalRoot Class 3" +# Serial: 1 +# MD5 Fingerprint: ca:fb:40:a8:4e:39:92:8a:1d:fe:8e:2f:c4:27:ea:ef +# SHA1 Fingerprint: 55:a6:72:3e:cb:f2:ec:cd:c3:23:74:70:19:9d:2a:be:11:e3:81:d1 +# SHA256 Fingerprint: fd:73:da:d3:1c:64:4f:f1:b4:3b:ef:0c:cd:da:96:71:0b:9c:d9:87:5e:ca:7e:31:70:7a:f3:e9:6d:52:2b:bd +-----BEGIN CERTIFICATE----- +MIIDwzCCAqugAwIBAgIBATANBgkqhkiG9w0BAQsFADCBgjELMAkGA1UEBhMCREUx +KzApBgNVBAoMIlQtU3lzdGVtcyBFbnRlcnByaXNlIFNlcnZpY2VzIEdtYkgxHzAd +BgNVBAsMFlQtU3lzdGVtcyBUcnVzdCBDZW50ZXIxJTAjBgNVBAMMHFQtVGVsZVNl +YyBHbG9iYWxSb290IENsYXNzIDMwHhcNMDgxMDAxMTAyOTU2WhcNMzMxMDAxMjM1 +OTU5WjCBgjELMAkGA1UEBhMCREUxKzApBgNVBAoMIlQtU3lzdGVtcyBFbnRlcnBy +aXNlIFNlcnZpY2VzIEdtYkgxHzAdBgNVBAsMFlQtU3lzdGVtcyBUcnVzdCBDZW50 +ZXIxJTAjBgNVBAMMHFQtVGVsZVNlYyBHbG9iYWxSb290IENsYXNzIDMwggEiMA0G +CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC9dZPwYiJvJK7genasfb3ZJNW4t/zN +8ELg63iIVl6bmlQdTQyK9tPPcPRStdiTBONGhnFBSivwKixVA9ZIw+A5OO3yXDw/ +RLyTPWGrTs0NvvAgJ1gORH8EGoel15YUNpDQSXuhdfsaa3Ox+M6pCSzyU9XDFES4 +hqX2iys52qMzVNn6chr3IhUciJFrf2blw2qAsCTz34ZFiP0Zf3WHHx+xGwpzJFu5 +ZeAsVMhg02YXP+HMVDNzkQI6pn97djmiH5a2OK61yJN0HZ65tOVgnS9W0eDrXltM +EnAMbEQgqxHY9Bn20pxSN+f6tsIxO0rUFJmtxxr1XV/6B7h8DR/Wgx6zAgMBAAGj +QjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0GA1UdDgQWBBS1 +A/d2O2GCahKqGFPrAyGUv/7OyjANBgkqhkiG9w0BAQsFAAOCAQEAVj3vlNW92nOy +WL6ukK2YJ5f+AbGwUgC4TeQbIXQbfsDuXmkqJa9c1h3a0nnJ85cp4IaH3gRZD/FZ +1GSFS5mvJQQeyUapl96Cshtwn5z2r3Ex3XsFpSzTucpH9sry9uetuUg/vBa3wW30 +6gmv7PO15wWeph6KU1HWk4HMdJP2udqmJQV0eVp+QD6CSyYRMG7hP0HHRwA11fXT +91Q+gT3aSWqas+8QPebrb9HIIkfLzM8BMZLZGOMivgkeGj5asuRrDFR6fUNOuIml +e9eiPZaGzPImNC1qkp2aGtAw4l1OBLBfiyB+d8E9lYLRRpo7PHi4b6HQDWSieB4p +TpPDpFQUWw== +-----END CERTIFICATE----- + +# Issuer: CN=EE Certification Centre Root CA O=AS Sertifitseerimiskeskus +# Subject: CN=EE Certification Centre Root CA O=AS Sertifitseerimiskeskus +# Label: "EE Certification Centre Root CA" +# Serial: 112324828676200291871926431888494945866 +# MD5 Fingerprint: 43:5e:88:d4:7d:1a:4a:7e:fd:84:2e:52:eb:01:d4:6f +# SHA1 Fingerprint: c9:a8:b9:e7:55:80:5e:58:e3:53:77:a7:25:eb:af:c3:7b:27:cc:d7 +# SHA256 Fingerprint: 3e:84:ba:43:42:90:85:16:e7:75:73:c0:99:2f:09:79:ca:08:4e:46:85:68:1f:f1:95:cc:ba:8a:22:9b:8a:76 +-----BEGIN CERTIFICATE----- +MIIEAzCCAuugAwIBAgIQVID5oHPtPwBMyonY43HmSjANBgkqhkiG9w0BAQUFADB1 +MQswCQYDVQQGEwJFRTEiMCAGA1UECgwZQVMgU2VydGlmaXRzZWVyaW1pc2tlc2t1 +czEoMCYGA1UEAwwfRUUgQ2VydGlmaWNhdGlvbiBDZW50cmUgUm9vdCBDQTEYMBYG +CSqGSIb3DQEJARYJcGtpQHNrLmVlMCIYDzIwMTAxMDMwMTAxMDMwWhgPMjAzMDEy +MTcyMzU5NTlaMHUxCzAJBgNVBAYTAkVFMSIwIAYDVQQKDBlBUyBTZXJ0aWZpdHNl +ZXJpbWlza2Vza3VzMSgwJgYDVQQDDB9FRSBDZXJ0aWZpY2F0aW9uIENlbnRyZSBS +b290IENBMRgwFgYJKoZIhvcNAQkBFglwa2lAc2suZWUwggEiMA0GCSqGSIb3DQEB +AQUAA4IBDwAwggEKAoIBAQDIIMDs4MVLqwd4lfNE7vsLDP90jmG7sWLqI9iroWUy +euuOF0+W2Ap7kaJjbMeMTC55v6kF/GlclY1i+blw7cNRfdCT5mzrMEvhvH2/UpvO +bntl8jixwKIy72KyaOBhU8E2lf/slLo2rpwcpzIP5Xy0xm90/XsY6KxX7QYgSzIw +WFv9zajmofxwvI6Sc9uXp3whrj3B9UiHbCe9nyV0gVWw93X2PaRka9ZP585ArQ/d +MtO8ihJTmMmJ+xAdTX7Nfh9WDSFwhfYggx/2uh8Ej+p3iDXE/+pOoYtNP2MbRMNE +1CV2yreN1x5KZmTNXMWcg+HCCIia7E6j8T4cLNlsHaFLAgMBAAGjgYowgYcwDwYD +VR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFBLyWj7qVhy/ +zQas8fElyalL1BSZMEUGA1UdJQQ+MDwGCCsGAQUFBwMCBggrBgEFBQcDAQYIKwYB +BQUHAwMGCCsGAQUFBwMEBggrBgEFBQcDCAYIKwYBBQUHAwkwDQYJKoZIhvcNAQEF +BQADggEBAHv25MANqhlHt01Xo/6tu7Fq1Q+e2+RjxY6hUFaTlrg4wCQiZrxTFGGV +v9DHKpY5P30osxBAIWrEr7BSdxjhlthWXePdNl4dp1BUoMUq5KqMlIpPnTX/dqQG +E5Gion0ARD9V04I8GtVbvFZMIi5GQ4okQC3zErg7cBqklrkar4dBGmoYDQZPxz5u +uSlNDUmJEYcyW+ZLBMjkXOZ0c5RdFpgTlf7727FE5TpwrDdr5rMzcijJs1eg9gIW +iAYLtqZLICjU3j2LrTcFU3T+bsy8QxdxXvnFzBqpYe73dgzzcvRyrc9yAjYHR8/v +GVCJYMzpJJUPwssd8m92kMfMdcGWxZ0= +-----END CERTIFICATE----- + +# Issuer: CN=D-TRUST Root Class 3 CA 2 2009 O=D-Trust GmbH +# Subject: CN=D-TRUST Root Class 3 CA 2 2009 O=D-Trust GmbH +# Label: "D-TRUST Root Class 3 CA 2 2009" +# Serial: 623603 +# MD5 Fingerprint: cd:e0:25:69:8d:47:ac:9c:89:35:90:f7:fd:51:3d:2f +# SHA1 Fingerprint: 58:e8:ab:b0:36:15:33:fb:80:f7:9b:1b:6d:29:d3:ff:8d:5f:00:f0 +# SHA256 Fingerprint: 49:e7:a4:42:ac:f0:ea:62:87:05:00:54:b5:25:64:b6:50:e4:f4:9e:42:e3:48:d6:aa:38:e0:39:e9:57:b1:c1 +-----BEGIN CERTIFICATE----- +MIIEMzCCAxugAwIBAgIDCYPzMA0GCSqGSIb3DQEBCwUAME0xCzAJBgNVBAYTAkRF +MRUwEwYDVQQKDAxELVRydXN0IEdtYkgxJzAlBgNVBAMMHkQtVFJVU1QgUm9vdCBD +bGFzcyAzIENBIDIgMjAwOTAeFw0wOTExMDUwODM1NThaFw0yOTExMDUwODM1NTha +ME0xCzAJBgNVBAYTAkRFMRUwEwYDVQQKDAxELVRydXN0IEdtYkgxJzAlBgNVBAMM +HkQtVFJVU1QgUm9vdCBDbGFzcyAzIENBIDIgMjAwOTCCASIwDQYJKoZIhvcNAQEB +BQADggEPADCCAQoCggEBANOySs96R+91myP6Oi/WUEWJNTrGa9v+2wBoqOADER03 +UAifTUpolDWzU9GUY6cgVq/eUXjsKj3zSEhQPgrfRlWLJ23DEE0NkVJD2IfgXU42 +tSHKXzlABF9bfsyjxiupQB7ZNoTWSPOSHjRGICTBpFGOShrvUD9pXRl/RcPHAY9R +ySPocq60vFYJfxLLHLGvKZAKyVXMD9O0Gu1HNVpK7ZxzBCHQqr0ME7UAyiZsxGsM +lFqVlNpQmvH/pStmMaTJOKDfHR+4CS7zp+hnUquVH+BGPtikw8paxTGA6Eian5Rp +/hnd2HN8gcqW3o7tszIFZYQ05ub9VxC1X3a/L7AQDcUCAwEAAaOCARowggEWMA8G +A1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFP3aFMSfMN4hvR5COfyrYyNJ4PGEMA4G +A1UdDwEB/wQEAwIBBjCB0wYDVR0fBIHLMIHIMIGAoH6gfIZ6bGRhcDovL2RpcmVj +dG9yeS5kLXRydXN0Lm5ldC9DTj1ELVRSVVNUJTIwUm9vdCUyMENsYXNzJTIwMyUy +MENBJTIwMiUyMDIwMDksTz1ELVRydXN0JTIwR21iSCxDPURFP2NlcnRpZmljYXRl +cmV2b2NhdGlvbmxpc3QwQ6BBoD+GPWh0dHA6Ly93d3cuZC10cnVzdC5uZXQvY3Js +L2QtdHJ1c3Rfcm9vdF9jbGFzc18zX2NhXzJfMjAwOS5jcmwwDQYJKoZIhvcNAQEL +BQADggEBAH+X2zDI36ScfSF6gHDOFBJpiBSVYEQBrLLpME+bUMJm2H6NMLVwMeni +acfzcNsgFYbQDfC+rAF1hM5+n02/t2A7nPPKHeJeaNijnZflQGDSNiH+0LS4F9p0 +o3/U37CYAqxva2ssJSRyoWXuJVrl5jLn8t+rSfrzkGkj2wTZ51xY/GXUl77M/C4K +zCUqNQT4YJEVdT1B/yMfGchs64JTBKbkTCJNjYy6zltz7GRUUG3RnFX7acM2w4y8 +PIWmawomDeCTmGCufsYkl4phX5GOZpIJhzbNi5stPvZR1FDUWSi9g/LMKHtThm3Y +Johw1+qRzT65ysCQblrGXnRl11z+o+I= +-----END CERTIFICATE----- + +# Issuer: CN=D-TRUST Root Class 3 CA 2 EV 2009 O=D-Trust GmbH +# Subject: CN=D-TRUST Root Class 3 CA 2 EV 2009 O=D-Trust GmbH +# Label: "D-TRUST Root Class 3 CA 2 EV 2009" +# Serial: 623604 +# MD5 Fingerprint: aa:c6:43:2c:5e:2d:cd:c4:34:c0:50:4f:11:02:4f:b6 +# SHA1 Fingerprint: 96:c9:1b:0b:95:b4:10:98:42:fa:d0:d8:22:79:fe:60:fa:b9:16:83 +# SHA256 Fingerprint: ee:c5:49:6b:98:8c:e9:86:25:b9:34:09:2e:ec:29:08:be:d0:b0:f3:16:c2:d4:73:0c:84:ea:f1:f3:d3:48:81 +-----BEGIN CERTIFICATE----- +MIIEQzCCAyugAwIBAgIDCYP0MA0GCSqGSIb3DQEBCwUAMFAxCzAJBgNVBAYTAkRF +MRUwEwYDVQQKDAxELVRydXN0IEdtYkgxKjAoBgNVBAMMIUQtVFJVU1QgUm9vdCBD +bGFzcyAzIENBIDIgRVYgMjAwOTAeFw0wOTExMDUwODUwNDZaFw0yOTExMDUwODUw +NDZaMFAxCzAJBgNVBAYTAkRFMRUwEwYDVQQKDAxELVRydXN0IEdtYkgxKjAoBgNV +BAMMIUQtVFJVU1QgUm9vdCBDbGFzcyAzIENBIDIgRVYgMjAwOTCCASIwDQYJKoZI +hvcNAQEBBQADggEPADCCAQoCggEBAJnxhDRwui+3MKCOvXwEz75ivJn9gpfSegpn +ljgJ9hBOlSJzmY3aFS3nBfwZcyK3jpgAvDw9rKFs+9Z5JUut8Mxk2og+KbgPCdM0 +3TP1YtHhzRnp7hhPTFiu4h7WDFsVWtg6uMQYZB7jM7K1iXdODL/ZlGsTl28So/6Z +qQTMFexgaDbtCHu39b+T7WYxg4zGcTSHThfqr4uRjRxWQa4iN1438h3Z0S0NL2lR +p75mpoo6Kr3HGrHhFPC+Oh25z1uxav60sUYgovseO3Dvk5h9jHOW8sXvhXCtKSb8 +HgQ+HKDYD8tSg2J87otTlZCpV6LqYQXY+U3EJ/pure3511H3a6UCAwEAAaOCASQw +ggEgMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFNOUikxiEyoZLsyvcop9Ntea +HNxnMA4GA1UdDwEB/wQEAwIBBjCB3QYDVR0fBIHVMIHSMIGHoIGEoIGBhn9sZGFw +Oi8vZGlyZWN0b3J5LmQtdHJ1c3QubmV0L0NOPUQtVFJVU1QlMjBSb290JTIwQ2xh +c3MlMjAzJTIwQ0ElMjAyJTIwRVYlMjAyMDA5LE89RC1UcnVzdCUyMEdtYkgsQz1E +RT9jZXJ0aWZpY2F0ZXJldm9jYXRpb25saXN0MEagRKBChkBodHRwOi8vd3d3LmQt +dHJ1c3QubmV0L2NybC9kLXRydXN0X3Jvb3RfY2xhc3NfM19jYV8yX2V2XzIwMDku +Y3JsMA0GCSqGSIb3DQEBCwUAA4IBAQA07XtaPKSUiO8aEXUHL7P+PPoeUSbrh/Yp +3uDx1MYkCenBz1UbtDDZzhr+BlGmFaQt77JLvyAoJUnRpjZ3NOhk31KxEcdzes05 +nsKtjHEh8lprr988TlWvsoRlFIm5d8sqMb7Po23Pb0iUMkZv53GMoKaEGTcH8gNF +CSuGdXzfX2lXANtu2KZyIktQ1HWYVt+3GP9DQ1CuekR78HlR10M9p9OB0/DJT7na +xpeG0ILD5EJt/rDiZE4OJudANCa1CInXCGNjOCd1HjPqbqjdn5lPdE2BiYBL3ZqX +KVwvvoFBuYz/6n1gBp7N1z3TLqMVvKjmJuVvw9y4AyHqnxbxLFS1 +-----END CERTIFICATE----- + +# Issuer: CN=CA Disig Root R2 O=Disig a.s. +# Subject: CN=CA Disig Root R2 O=Disig a.s. +# Label: "CA Disig Root R2" +# Serial: 10572350602393338211 +# MD5 Fingerprint: 26:01:fb:d8:27:a7:17:9a:45:54:38:1a:43:01:3b:03 +# SHA1 Fingerprint: b5:61:eb:ea:a4:de:e4:25:4b:69:1a:98:a5:57:47:c2:34:c7:d9:71 +# SHA256 Fingerprint: e2:3d:4a:03:6d:7b:70:e9:f5:95:b1:42:20:79:d2:b9:1e:df:bb:1f:b6:51:a0:63:3e:aa:8a:9d:c5:f8:07:03 +-----BEGIN CERTIFICATE----- +MIIFaTCCA1GgAwIBAgIJAJK4iNuwisFjMA0GCSqGSIb3DQEBCwUAMFIxCzAJBgNV +BAYTAlNLMRMwEQYDVQQHEwpCcmF0aXNsYXZhMRMwEQYDVQQKEwpEaXNpZyBhLnMu +MRkwFwYDVQQDExBDQSBEaXNpZyBSb290IFIyMB4XDTEyMDcxOTA5MTUzMFoXDTQy +MDcxOTA5MTUzMFowUjELMAkGA1UEBhMCU0sxEzARBgNVBAcTCkJyYXRpc2xhdmEx +EzARBgNVBAoTCkRpc2lnIGEucy4xGTAXBgNVBAMTEENBIERpc2lnIFJvb3QgUjIw +ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCio8QACdaFXS1tFPbCw3Oe +NcJxVX6B+6tGUODBfEl45qt5WDza/3wcn9iXAng+a0EE6UG9vgMsRfYvZNSrXaNH +PWSb6WiaxswbP7q+sos0Ai6YVRn8jG+qX9pMzk0DIaPY0jSTVpbLTAwAFjxfGs3I +x2ymrdMxp7zo5eFm1tL7A7RBZckQrg4FY8aAamkw/dLukO8NJ9+flXP04SXabBbe +QTg06ov80egEFGEtQX6sx3dOy1FU+16SGBsEWmjGycT6txOgmLcRK7fWV8x8nhfR +yyX+hk4kLlYMeE2eARKmK6cBZW58Yh2EhN/qwGu1pSqVg8NTEQxzHQuyRpDRQjrO +QG6Vrf/GlK1ul4SOfW+eioANSW1z4nuSHsPzwfPrLgVv2RvPN3YEyLRa5Beny912 +H9AZdugsBbPWnDTYltxhh5EF5EQIM8HauQhl1K6yNg3ruji6DOWbnuuNZt2Zz9aJ +QfYEkoopKW1rOhzndX0CcQ7zwOe9yxndnWCywmZgtrEE7snmhrmaZkCo5xHtgUUD +i/ZnWejBBhG93c+AAk9lQHhcR1DIm+YfgXvkRKhbhZri3lrVx/k6RGZL5DJUfORs +nLMOPReisjQS1n6yqEm70XooQL6iFh/f5DcfEXP7kAplQ6INfPgGAVUzfbANuPT1 +rqVCV3w2EYx7XsQDnYx5nQIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1Ud +DwEB/wQEAwIBBjAdBgNVHQ4EFgQUtZn4r7CU9eMg1gqtzk5WpC5uQu0wDQYJKoZI +hvcNAQELBQADggIBACYGXnDnZTPIgm7ZnBc6G3pmsgH2eDtpXi/q/075KMOYKmFM +tCQSin1tERT3nLXK5ryeJ45MGcipvXrA1zYObYVybqjGom32+nNjf7xueQgcnYqf +GopTpti72TVVsRHFqQOzVju5hJMiXn7B9hJSi+osZ7z+Nkz1uM/Rs0mSO9MpDpkb +lvdhuDvEK7Z4bLQjb/D907JedR+Zlais9trhxTF7+9FGs9K8Z7RiVLoJ92Owk6Ka ++elSLotgEqv89WBW7xBci8QaQtyDW2QOy7W81k/BfDxujRNt+3vrMNDcTa/F1bal +TFtxyegxvug4BkihGuLq0t4SOVga/4AOgnXmt8kHbA7v/zjxmHHEt38OFdAlab0i +nSvtBfZGR6ztwPDUO+Ls7pZbkBNOHlY667DvlruWIxG68kOGdGSVyCh13x01utI3 +gzhTODY7z2zp+WsO0PsE6E9312UBeIYMej4hYvF/Y3EMyZ9E26gnonW+boE+18Dr +G5gPcFw0sorMwIUY6256s/daoQe/qUKS82Ail+QUoQebTnbAjn39pCXHR+3/H3Os +zMOl6W8KjptlwlCFtaOgUxLMVYdh84GuEEZhvUQhuMI9dM9+JDX6HAcOmz0iyu8x +L4ysEr3vQCj8KWefshNPZiTEUxnpHikV7+ZtsH8tZ/3zbBt1RqPlShfppNcL +-----END CERTIFICATE----- + +# Issuer: CN=ACCVRAIZ1 O=ACCV OU=PKIACCV +# Subject: CN=ACCVRAIZ1 O=ACCV OU=PKIACCV +# Label: "ACCVRAIZ1" +# Serial: 6828503384748696800 +# MD5 Fingerprint: d0:a0:5a:ee:05:b6:09:94:21:a1:7d:f1:b2:29:82:02 +# SHA1 Fingerprint: 93:05:7a:88:15:c6:4f:ce:88:2f:fa:91:16:52:28:78:bc:53:64:17 +# SHA256 Fingerprint: 9a:6e:c0:12:e1:a7:da:9d:be:34:19:4d:47:8a:d7:c0:db:18:22:fb:07:1d:f1:29:81:49:6e:d1:04:38:41:13 +-----BEGIN CERTIFICATE----- +MIIH0zCCBbugAwIBAgIIXsO3pkN/pOAwDQYJKoZIhvcNAQEFBQAwQjESMBAGA1UE +AwwJQUNDVlJBSVoxMRAwDgYDVQQLDAdQS0lBQ0NWMQ0wCwYDVQQKDARBQ0NWMQsw +CQYDVQQGEwJFUzAeFw0xMTA1MDUwOTM3MzdaFw0zMDEyMzEwOTM3MzdaMEIxEjAQ +BgNVBAMMCUFDQ1ZSQUlaMTEQMA4GA1UECwwHUEtJQUNDVjENMAsGA1UECgwEQUND +VjELMAkGA1UEBhMCRVMwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCb +qau/YUqXry+XZpp0X9DZlv3P4uRm7x8fRzPCRKPfmt4ftVTdFXxpNRFvu8gMjmoY +HtiP2Ra8EEg2XPBjs5BaXCQ316PWywlxufEBcoSwfdtNgM3802/J+Nq2DoLSRYWo +G2ioPej0RGy9ocLLA76MPhMAhN9KSMDjIgro6TenGEyxCQ0jVn8ETdkXhBilyNpA +lHPrzg5XPAOBOp0KoVdDaaxXbXmQeOW1tDvYvEyNKKGno6e6Ak4l0Squ7a4DIrhr +IA8wKFSVf+DuzgpmndFALW4ir50awQUZ0m/A8p/4e7MCQvtQqR0tkw8jq8bBD5L/ +0KIV9VMJcRz/RROE5iZe+OCIHAr8Fraocwa48GOEAqDGWuzndN9wrqODJerWx5eH +k6fGioozl2A3ED6XPm4pFdahD9GILBKfb6qkxkLrQaLjlUPTAYVtjrs78yM2x/47 +4KElB0iryYl0/wiPgL/AlmXz7uxLaL2diMMxs0Dx6M/2OLuc5NF/1OVYm3z61PMO +m3WR5LpSLhl+0fXNWhn8ugb2+1KoS5kE3fj5tItQo05iifCHJPqDQsGH+tUtKSpa +cXpkatcnYGMN285J9Y0fkIkyF/hzQ7jSWpOGYdbhdQrqeWZ2iE9x6wQl1gpaepPl +uUsXQA+xtrn13k/c4LOsOxFwYIRKQ26ZIMApcQrAZQIDAQABo4ICyzCCAscwfQYI +KwYBBQUHAQEEcTBvMEwGCCsGAQUFBzAChkBodHRwOi8vd3d3LmFjY3YuZXMvZmls +ZWFkbWluL0FyY2hpdm9zL2NlcnRpZmljYWRvcy9yYWl6YWNjdjEuY3J0MB8GCCsG +AQUFBzABhhNodHRwOi8vb2NzcC5hY2N2LmVzMB0GA1UdDgQWBBTSh7Tj3zcnk1X2 +VuqB5TbMjB4/vTAPBgNVHRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFNKHtOPfNyeT +VfZW6oHlNsyMHj+9MIIBcwYDVR0gBIIBajCCAWYwggFiBgRVHSAAMIIBWDCCASIG +CCsGAQUFBwICMIIBFB6CARAAQQB1AHQAbwByAGkAZABhAGQAIABkAGUAIABDAGUA +cgB0AGkAZgBpAGMAYQBjAGkA8wBuACAAUgBhAO0AegAgAGQAZQAgAGwAYQAgAEEA +QwBDAFYAIAAoAEEAZwBlAG4AYwBpAGEAIABkAGUAIABUAGUAYwBuAG8AbABvAGcA +7QBhACAAeQAgAEMAZQByAHQAaQBmAGkAYwBhAGMAaQDzAG4AIABFAGwAZQBjAHQA +cgDzAG4AaQBjAGEALAAgAEMASQBGACAAUQA0ADYAMAAxADEANQA2AEUAKQAuACAA +QwBQAFMAIABlAG4AIABoAHQAdABwADoALwAvAHcAdwB3AC4AYQBjAGMAdgAuAGUA +czAwBggrBgEFBQcCARYkaHR0cDovL3d3dy5hY2N2LmVzL2xlZ2lzbGFjaW9uX2Mu +aHRtMFUGA1UdHwROMEwwSqBIoEaGRGh0dHA6Ly93d3cuYWNjdi5lcy9maWxlYWRt +aW4vQXJjaGl2b3MvY2VydGlmaWNhZG9zL3JhaXphY2N2MV9kZXIuY3JsMA4GA1Ud +DwEB/wQEAwIBBjAXBgNVHREEEDAOgQxhY2N2QGFjY3YuZXMwDQYJKoZIhvcNAQEF +BQADggIBAJcxAp/n/UNnSEQU5CmH7UwoZtCPNdpNYbdKl02125DgBS4OxnnQ8pdp +D70ER9m+27Up2pvZrqmZ1dM8MJP1jaGo/AaNRPTKFpV8M9xii6g3+CfYCS0b78gU +JyCpZET/LtZ1qmxNYEAZSUNUY9rizLpm5U9EelvZaoErQNV/+QEnWCzI7UiRfD+m +AM/EKXMRNt6GGT6d7hmKG9Ww7Y49nCrADdg9ZuM8Db3VlFzi4qc1GwQA9j9ajepD +vV+JHanBsMyZ4k0ACtrJJ1vnE5Bc5PUzolVt3OAJTS+xJlsndQAJxGJ3KQhfnlms +tn6tn1QwIgPBHnFk/vk4CpYY3QIUrCPLBhwepH2NDd4nQeit2hW3sCPdK6jT2iWH +7ehVRE2I9DZ+hJp4rPcOVkkO1jMl1oRQQmwgEh0q1b688nCBpHBgvgW1m54ERL5h +I6zppSSMEYCUWqKiuUnSwdzRp+0xESyeGabu4VXhwOrPDYTkF7eifKXeVSUG7szA +h1xA2syVP1XgNce4hL60Xc16gwFy7ofmXx2utYXGJt/mwZrpHgJHnyqobalbz+xF +d3+YJ5oyXSrjhO7FmGYvliAd3djDJ9ew+f7Zfc3Qn48LFFhRny+Lwzgt3uiP1o2H +pPVWQxaZLPSkVrQ0uGE3ycJYgBugl6H8WY3pEfbRD0tVNEYqi4Y7 +-----END CERTIFICATE----- + +# Issuer: CN=TWCA Global Root CA O=TAIWAN-CA OU=Root CA +# Subject: CN=TWCA Global Root CA O=TAIWAN-CA OU=Root CA +# Label: "TWCA Global Root CA" +# Serial: 3262 +# MD5 Fingerprint: f9:03:7e:cf:e6:9e:3c:73:7a:2a:90:07:69:ff:2b:96 +# SHA1 Fingerprint: 9c:bb:48:53:f6:a4:f6:d3:52:a4:e8:32:52:55:60:13:f5:ad:af:65 +# SHA256 Fingerprint: 59:76:90:07:f7:68:5d:0f:cd:50:87:2f:9f:95:d5:75:5a:5b:2b:45:7d:81:f3:69:2b:61:0a:98:67:2f:0e:1b +-----BEGIN CERTIFICATE----- +MIIFQTCCAymgAwIBAgICDL4wDQYJKoZIhvcNAQELBQAwUTELMAkGA1UEBhMCVFcx +EjAQBgNVBAoTCVRBSVdBTi1DQTEQMA4GA1UECxMHUm9vdCBDQTEcMBoGA1UEAxMT +VFdDQSBHbG9iYWwgUm9vdCBDQTAeFw0xMjA2MjcwNjI4MzNaFw0zMDEyMzExNTU5 +NTlaMFExCzAJBgNVBAYTAlRXMRIwEAYDVQQKEwlUQUlXQU4tQ0ExEDAOBgNVBAsT +B1Jvb3QgQ0ExHDAaBgNVBAMTE1RXQ0EgR2xvYmFsIFJvb3QgQ0EwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQCwBdvI64zEbooh745NnHEKH1Jw7W2CnJfF +10xORUnLQEK1EjRsGcJ0pDFfhQKX7EMzClPSnIyOt7h52yvVavKOZsTuKwEHktSz +0ALfUPZVr2YOy+BHYC8rMjk1Ujoog/h7FsYYuGLWRyWRzvAZEk2tY/XTP3VfKfCh +MBwqoJimFb3u/Rk28OKRQ4/6ytYQJ0lM793B8YVwm8rqqFpD/G2Gb3PpN0Wp8DbH +zIh1HrtsBv+baz4X7GGqcXzGHaL3SekVtTzWoWH1EfcFbx39Eb7QMAfCKbAJTibc +46KokWofwpFFiFzlmLhxpRUZyXx1EcxwdE8tmx2RRP1WKKD+u4ZqyPpcC1jcxkt2 +yKsi2XMPpfRaAok/T54igu6idFMqPVMnaR1sjjIsZAAmY2E2TqNGtz99sy2sbZCi +laLOz9qC5wc0GZbpuCGqKX6mOL6OKUohZnkfs8O1CWfe1tQHRvMq2uYiN2DLgbYP +oA/pyJV/v1WRBXrPPRXAb94JlAGD1zQbzECl8LibZ9WYkTunhHiVJqRaCPgrdLQA +BDzfuBSO6N+pjWxnkjMdwLfS7JLIvgm/LCkFbwJrnu+8vyq8W8BQj0FwcYeyTbcE +qYSjMq+u7msXi7Kx/mzhkIyIqJdIzshNy/MGz19qCkKxHh53L46g5pIOBvwFItIm +4TFRfTLcDwIDAQABoyMwITAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB +/zANBgkqhkiG9w0BAQsFAAOCAgEAXzSBdu+WHdXltdkCY4QWwa6gcFGn90xHNcgL +1yg9iXHZqjNB6hQbbCEAwGxCGX6faVsgQt+i0trEfJdLjbDorMjupWkEmQqSpqsn +LhpNgb+E1HAerUf+/UqdM+DyucRFCCEK2mlpc3INvjT+lIutwx4116KD7+U4x6WF +H6vPNOw/KP4M8VeGTslV9xzU2KV9Bnpv1d8Q34FOIWWxtuEXeZVFBs5fzNxGiWNo +RI2T9GRwoD2dKAXDOXC4Ynsg/eTb6QihuJ49CcdP+yz4k3ZB3lLg4VfSnQO8d57+ +nile98FRYB/e2guyLXW3Q0iT5/Z5xoRdgFlglPx4mI88k1HtQJAH32RjJMtOcQWh +15QaiDLxInQirqWm2BJpTGCjAu4r7NRjkgtevi92a6O2JryPA9gK8kxkRr05YuWW +6zRjESjMlfGt7+/cgFhI6Uu46mWs6fyAtbXIRfmswZ/ZuepiiI7E8UuDEq3mi4TW +nsLrgxifarsbJGAzcMzs9zLzXNl5fe+epP7JI8Mk7hWSsT2RTyaGvWZzJBPqpK5j +wa19hAM8EHiGG3njxPPyBJUgriOCxLM6AGK/5jYk4Ve6xx6QddVfP5VhK8E7zeWz +aGHQRiapIVJpLesux+t3zqY6tQMzT3bR51xUAV3LePTJDL/PEo4XLSNolOer/qmy +KwbQBM0= +-----END CERTIFICATE----- + +# Issuer: CN=TeliaSonera Root CA v1 O=TeliaSonera +# Subject: CN=TeliaSonera Root CA v1 O=TeliaSonera +# Label: "TeliaSonera Root CA v1" +# Serial: 199041966741090107964904287217786801558 +# MD5 Fingerprint: 37:41:49:1b:18:56:9a:26:f5:ad:c2:66:fb:40:a5:4c +# SHA1 Fingerprint: 43:13:bb:96:f1:d5:86:9b:c1:4e:6a:92:f6:cf:f6:34:69:87:82:37 +# SHA256 Fingerprint: dd:69:36:fe:21:f8:f0:77:c1:23:a1:a5:21:c1:22:24:f7:22:55:b7:3e:03:a7:26:06:93:e8:a2:4b:0f:a3:89 +-----BEGIN CERTIFICATE----- +MIIFODCCAyCgAwIBAgIRAJW+FqD3LkbxezmCcvqLzZYwDQYJKoZIhvcNAQEFBQAw +NzEUMBIGA1UECgwLVGVsaWFTb25lcmExHzAdBgNVBAMMFlRlbGlhU29uZXJhIFJv +b3QgQ0EgdjEwHhcNMDcxMDE4MTIwMDUwWhcNMzIxMDE4MTIwMDUwWjA3MRQwEgYD +VQQKDAtUZWxpYVNvbmVyYTEfMB0GA1UEAwwWVGVsaWFTb25lcmEgUm9vdCBDQSB2 +MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAMK+6yfwIaPzaSZVfp3F +VRaRXP3vIb9TgHot0pGMYzHw7CTww6XScnwQbfQ3t+XmfHnqjLWCi65ItqwA3GV1 +7CpNX8GH9SBlK4GoRz6JI5UwFpB/6FcHSOcZrr9FZ7E3GwYq/t75rH2D+1665I+X +Z75Ljo1kB1c4VWk0Nj0TSO9P4tNmHqTPGrdeNjPUtAa9GAH9d4RQAEX1jF3oI7x+ +/jXh7VB7qTCNGdMJjmhnXb88lxhTuylixcpecsHHltTbLaC0H2kD7OriUPEMPPCs +81Mt8Bz17Ww5OXOAFshSsCPN4D7c3TxHoLs1iuKYaIu+5b9y7tL6pe0S7fyYGKkm +dtwoSxAgHNN/Fnct7W+A90m7UwW7XWjH1Mh1Fj+JWov3F0fUTPHSiXk+TT2YqGHe +Oh7S+F4D4MHJHIzTjU3TlTazN19jY5szFPAtJmtTfImMMsJu7D0hADnJoWjiUIMu +sDor8zagrC/kb2HCUQk5PotTubtn2txTuXZZNp1D5SDgPTJghSJRt8czu90VL6R4 +pgd7gUY2BIbdeTXHlSw7sKMXNeVzH7RcWe/a6hBle3rQf5+ztCo3O3CLm1u5K7fs +slESl1MpWtTwEhDcTwK7EpIvYtQ/aUN8Ddb8WHUBiJ1YFkveupD/RwGJBmr2X7KQ +arMCpgKIv7NHfirZ1fpoeDVNAgMBAAGjPzA9MA8GA1UdEwEB/wQFMAMBAf8wCwYD +VR0PBAQDAgEGMB0GA1UdDgQWBBTwj1k4ALP1j5qWDNXr+nuqF+gTEjANBgkqhkiG +9w0BAQUFAAOCAgEAvuRcYk4k9AwI//DTDGjkk0kiP0Qnb7tt3oNmzqjMDfz1mgbl +dxSR651Be5kqhOX//CHBXfDkH1e3damhXwIm/9fH907eT/j3HEbAek9ALCI18Bmx +0GtnLLCo4MBANzX2hFxc469CeP6nyQ1Q6g2EdvZR74NTxnr/DlZJLo961gzmJ1Tj +TQpgcmLNkQfWpb/ImWvtxBnmq0wROMVvMeJuScg/doAmAyYp4Db29iBT4xdwNBed +Y2gea+zDTYa4EzAvXUYNR0PVG6pZDrlcjQZIrXSHX8f8MVRBE+LHIQ6e4B4N4cB7 +Q4WQxYpYxmUKeFfyxiMPAdkgS94P+5KFdSpcc41teyWRyu5FrgZLAMzTsVlQ2jqI +OylDRl6XK1TOU2+NSueW+r9xDkKLfP0ooNBIytrEgUy7onOTJsjrDNYmiLbAJM+7 +vVvrdX3pCI6GMyx5dwlppYn8s3CQh3aP0yK7Qs69cwsgJirQmz1wHiRszYd2qReW +t88NkvuOGKmYSdGe/mBEciG5Ge3C9THxOUiIkCR1VBatzvT4aRRkOfujuLpwQMcn +HL/EVlP6Y2XQ8xwOFvVrhlhNGNTkDY6lnVuR3HYkUD/GKvvZt5y11ubQ2egZixVx +SK236thZiNSQvxaz2emsWWFUyBy6ysHK4bkgTI86k4mloMy/0/Z1pHWWbVY= +-----END CERTIFICATE----- + +# Issuer: CN=E-Tugra Certification Authority O=E-Tu\u011fra EBG Bili\u015fim Teknolojileri ve Hizmetleri A.\u015e. OU=E-Tugra Sertifikasyon Merkezi +# Subject: CN=E-Tugra Certification Authority O=E-Tu\u011fra EBG Bili\u015fim Teknolojileri ve Hizmetleri A.\u015e. OU=E-Tugra Sertifikasyon Merkezi +# Label: "E-Tugra Certification Authority" +# Serial: 7667447206703254355 +# MD5 Fingerprint: b8:a1:03:63:b0:bd:21:71:70:8a:6f:13:3a:bb:79:49 +# SHA1 Fingerprint: 51:c6:e7:08:49:06:6e:f3:92:d4:5c:a0:0d:6d:a3:62:8f:c3:52:39 +# SHA256 Fingerprint: b0:bf:d5:2b:b0:d7:d9:bd:92:bf:5d:4d:c1:3d:a2:55:c0:2c:54:2f:37:83:65:ea:89:39:11:f5:5e:55:f2:3c +-----BEGIN CERTIFICATE----- +MIIGSzCCBDOgAwIBAgIIamg+nFGby1MwDQYJKoZIhvcNAQELBQAwgbIxCzAJBgNV +BAYTAlRSMQ8wDQYDVQQHDAZBbmthcmExQDA+BgNVBAoMN0UtVHXEn3JhIEVCRyBC +aWxpxZ9pbSBUZWtub2xvamlsZXJpIHZlIEhpem1ldGxlcmkgQS7Fni4xJjAkBgNV +BAsMHUUtVHVncmEgU2VydGlmaWthc3lvbiBNZXJrZXppMSgwJgYDVQQDDB9FLVR1 +Z3JhIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTEzMDMwNTEyMDk0OFoXDTIz +MDMwMzEyMDk0OFowgbIxCzAJBgNVBAYTAlRSMQ8wDQYDVQQHDAZBbmthcmExQDA+ +BgNVBAoMN0UtVHXEn3JhIEVCRyBCaWxpxZ9pbSBUZWtub2xvamlsZXJpIHZlIEhp +em1ldGxlcmkgQS7Fni4xJjAkBgNVBAsMHUUtVHVncmEgU2VydGlmaWthc3lvbiBN +ZXJrZXppMSgwJgYDVQQDDB9FLVR1Z3JhIENlcnRpZmljYXRpb24gQXV0aG9yaXR5 +MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA4vU/kwVRHoViVF56C/UY +B4Oufq9899SKa6VjQzm5S/fDxmSJPZQuVIBSOTkHS0vdhQd2h8y/L5VMzH2nPbxH +D5hw+IyFHnSOkm0bQNGZDbt1bsipa5rAhDGvykPL6ys06I+XawGb1Q5KCKpbknSF +Q9OArqGIW66z6l7LFpp3RMih9lRozt6Plyu6W0ACDGQXwLWTzeHxE2bODHnv0ZEo +q1+gElIwcxmOj+GMB6LDu0rw6h8VqO4lzKRG+Bsi77MOQ7osJLjFLFzUHPhdZL3D +k14opz8n8Y4e0ypQBaNV2cvnOVPAmJ6MVGKLJrD3fY185MaeZkJVgkfnsliNZvcH +fC425lAcP9tDJMW/hkd5s3kc91r0E+xs+D/iWR+V7kI+ua2oMoVJl0b+SzGPWsut +dEcf6ZG33ygEIqDUD13ieU/qbIWGvaimzuT6w+Gzrt48Ue7LE3wBf4QOXVGUnhMM +ti6lTPk5cDZvlsouDERVxcr6XQKj39ZkjFqzAQqptQpHF//vkUAqjqFGOjGY5RH8 +zLtJVor8udBhmm9lbObDyz51Sf6Pp+KJxWfXnUYTTjF2OySznhFlhqt/7x3U+Lzn +rFpct1pHXFXOVbQicVtbC/DP3KBhZOqp12gKY6fgDT+gr9Oq0n7vUaDmUStVkhUX +U8u3Zg5mTPj5dUyQ5xJwx0UCAwEAAaNjMGEwHQYDVR0OBBYEFC7j27JJ0JxUeVz6 +Jyr+zE7S6E5UMA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAULuPbsknQnFR5 +XPonKv7MTtLoTlQwDgYDVR0PAQH/BAQDAgEGMA0GCSqGSIb3DQEBCwUAA4ICAQAF +Nzr0TbdF4kV1JI+2d1LoHNgQk2Xz8lkGpD4eKexd0dCrfOAKkEh47U6YA5n+KGCR +HTAduGN8qOY1tfrTYXbm1gdLymmasoR6d5NFFxWfJNCYExL/u6Au/U5Mh/jOXKqY +GwXgAEZKgoClM4so3O0409/lPun++1ndYYRP0lSWE2ETPo+Aab6TR7U1Q9Jauz1c +77NCR807VRMGsAnb/WP2OogKmW9+4c4bU2pEZiNRCHu8W1Ki/QY3OEBhj0qWuJA3 ++GbHeJAAFS6LrVE1Uweoa2iu+U48BybNCAVwzDk/dr2l02cmAYamU9JgO3xDf1WK +vJUawSg5TB9D0pH0clmKuVb8P7Sd2nCcdlqMQ1DujjByTd//SffGqWfZbawCEeI6 +FiWnWAjLb1NBnEg4R2gz0dfHj9R0IdTDBZB6/86WiLEVKV0jq9BgoRJP3vQXzTLl +yb/IQ639Lo7xr+L0mPoSHyDYwKcMhcWQ9DstliaxLL5Mq+ux0orJ23gTDx4JnW2P +AJ8C2sH6H3p6CcRK5ogql5+Ji/03X186zjhZhkuvcQu02PJwT58yE+Owp1fl2tpD +y4Q08ijE6m30Ku/Ba3ba+367hTzSU8JNvnHhRdH9I2cNE3X7z2VnIp2usAnRCf8d +NL/+I5c30jn6PQ0GC7TbO6Orb1wdtn7os4I07QZcJA== +-----END CERTIFICATE----- + +# Issuer: CN=T-TeleSec GlobalRoot Class 2 O=T-Systems Enterprise Services GmbH OU=T-Systems Trust Center +# Subject: CN=T-TeleSec GlobalRoot Class 2 O=T-Systems Enterprise Services GmbH OU=T-Systems Trust Center +# Label: "T-TeleSec GlobalRoot Class 2" +# Serial: 1 +# MD5 Fingerprint: 2b:9b:9e:e4:7b:6c:1f:00:72:1a:cc:c1:77:79:df:6a +# SHA1 Fingerprint: 59:0d:2d:7d:88:4f:40:2e:61:7e:a5:62:32:17:65:cf:17:d8:94:e9 +# SHA256 Fingerprint: 91:e2:f5:78:8d:58:10:eb:a7:ba:58:73:7d:e1:54:8a:8e:ca:cd:01:45:98:bc:0b:14:3e:04:1b:17:05:25:52 +-----BEGIN CERTIFICATE----- +MIIDwzCCAqugAwIBAgIBATANBgkqhkiG9w0BAQsFADCBgjELMAkGA1UEBhMCREUx +KzApBgNVBAoMIlQtU3lzdGVtcyBFbnRlcnByaXNlIFNlcnZpY2VzIEdtYkgxHzAd +BgNVBAsMFlQtU3lzdGVtcyBUcnVzdCBDZW50ZXIxJTAjBgNVBAMMHFQtVGVsZVNl +YyBHbG9iYWxSb290IENsYXNzIDIwHhcNMDgxMDAxMTA0MDE0WhcNMzMxMDAxMjM1 +OTU5WjCBgjELMAkGA1UEBhMCREUxKzApBgNVBAoMIlQtU3lzdGVtcyBFbnRlcnBy +aXNlIFNlcnZpY2VzIEdtYkgxHzAdBgNVBAsMFlQtU3lzdGVtcyBUcnVzdCBDZW50 +ZXIxJTAjBgNVBAMMHFQtVGVsZVNlYyBHbG9iYWxSb290IENsYXNzIDIwggEiMA0G +CSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCqX9obX+hzkeXaXPSi5kfl82hVYAUd +AqSzm1nzHoqvNK38DcLZSBnuaY/JIPwhqgcZ7bBcrGXHX+0CfHt8LRvWurmAwhiC +FoT6ZrAIxlQjgeTNuUk/9k9uN0goOA/FvudocP05l03Sx5iRUKrERLMjfTlH6VJi +1hKTXrcxlkIF+3anHqP1wvzpesVsqXFP6st4vGCvx9702cu+fjOlbpSD8DT6Iavq +jnKgP6TeMFvvhk1qlVtDRKgQFRzlAVfFmPHmBiiRqiDFt1MmUUOyCxGVWOHAD3bZ +wI18gfNycJ5v/hqO2V81xrJvNHy+SE/iWjnX2J14np+GPgNeGYtEotXHAgMBAAGj +QjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0GA1UdDgQWBBS/ +WSA2AHmgoCJrjNXyYdK4LMuCSjANBgkqhkiG9w0BAQsFAAOCAQEAMQOiYQsfdOhy +NsZt+U2e+iKo4YFWz827n+qrkRk4r6p8FU3ztqONpfSO9kSpp+ghla0+AGIWiPAC +uvxhI+YzmzB6azZie60EI4RYZeLbK4rnJVM3YlNfvNoBYimipidx5joifsFvHZVw +IEoHNN/q/xWA5brXethbdXwFeilHfkCoMRN3zUA7tFFHei4R40cR3p1m0IvVVGb6 +g1XqfMIpiRvpb7PO4gWEyS8+eIVibslfwXhjdFjASBgMmTnrpMwatXlajRWc2BQN +9noHV8cigwUtPJslJj0Ys6lDfMjIq2SPDqO/nBudMNva0Bkuqjzx+zOAduTNrRlP +BSeOE6Fuwg== +-----END CERTIFICATE----- + +# Issuer: CN=Atos TrustedRoot 2011 O=Atos +# Subject: CN=Atos TrustedRoot 2011 O=Atos +# Label: "Atos TrustedRoot 2011" +# Serial: 6643877497813316402 +# MD5 Fingerprint: ae:b9:c4:32:4b:ac:7f:5d:66:cc:77:94:bb:2a:77:56 +# SHA1 Fingerprint: 2b:b1:f5:3e:55:0c:1d:c5:f1:d4:e6:b7:6a:46:4b:55:06:02:ac:21 +# SHA256 Fingerprint: f3:56:be:a2:44:b7:a9:1e:b3:5d:53:ca:9a:d7:86:4a:ce:01:8e:2d:35:d5:f8:f9:6d:df:68:a6:f4:1a:a4:74 +-----BEGIN CERTIFICATE----- +MIIDdzCCAl+gAwIBAgIIXDPLYixfszIwDQYJKoZIhvcNAQELBQAwPDEeMBwGA1UE +AwwVQXRvcyBUcnVzdGVkUm9vdCAyMDExMQ0wCwYDVQQKDARBdG9zMQswCQYDVQQG +EwJERTAeFw0xMTA3MDcxNDU4MzBaFw0zMDEyMzEyMzU5NTlaMDwxHjAcBgNVBAMM +FUF0b3MgVHJ1c3RlZFJvb3QgMjAxMTENMAsGA1UECgwEQXRvczELMAkGA1UEBhMC +REUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCVhTuXbyo7LjvPpvMp +Nb7PGKw+qtn4TaA+Gke5vJrf8v7MPkfoepbCJI419KkM/IL9bcFyYie96mvr54rM +VD6QUM+A1JX76LWC1BTFtqlVJVfbsVD2sGBkWXppzwO3bw2+yj5vdHLqqjAqc2K+ +SZFhyBH+DgMq92og3AIVDV4VavzjgsG1xZ1kCWyjWZgHJ8cblithdHFsQ/H3NYkQ +4J7sVaE3IqKHBAUsR320HLliKWYoyrfhk/WklAOZuXCFteZI6o1Q/NnezG8HDt0L +cp2AMBYHlT8oDv3FdU9T1nSatCQujgKRz3bFmx5VdJx4IbHwLfELn8LVlhgf8FQi +eowHAgMBAAGjfTB7MB0GA1UdDgQWBBSnpQaxLKYJYO7Rl+lwrrw7GWzbITAPBgNV +HRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFKelBrEspglg7tGX6XCuvDsZbNshMBgG +A1UdIAQRMA8wDQYLKwYBBAGwLQMEAQEwDgYDVR0PAQH/BAQDAgGGMA0GCSqGSIb3 +DQEBCwUAA4IBAQAmdzTblEiGKkGdLD4GkGDEjKwLVLgfuXvTBznk+j57sj1O7Z8j +vZfza1zv7v1Apt+hk6EKhqzvINB5Ab149xnYJDE0BAGmuhWawyfc2E8PzBhj/5kP +DpFrdRbhIfzYJsdHt6bPWHJxfrrhTZVHO8mvbaG0weyJ9rQPOLXiZNwlz6bb65pc +maHFCN795trV1lpFDMS3wrUU77QR/w4VtfX128a961qn8FYiqTxlVMYVqL2Gns2D +lmh6cYGJ4Qvh6hEbaAjMaZ7snkGeRDImeuKHCnE96+RapNLbxc3G3mB/ufNPRJLv +KrcYPqcZ2Qt9sTdBQrC6YB3y/gkRsPCHe6ed +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root CA 1 G3 O=QuoVadis Limited +# Subject: CN=QuoVadis Root CA 1 G3 O=QuoVadis Limited +# Label: "QuoVadis Root CA 1 G3" +# Serial: 687049649626669250736271037606554624078720034195 +# MD5 Fingerprint: a4:bc:5b:3f:fe:37:9a:fa:64:f0:e2:fa:05:3d:0b:ab +# SHA1 Fingerprint: 1b:8e:ea:57:96:29:1a:c9:39:ea:b8:0a:81:1a:73:73:c0:93:79:67 +# SHA256 Fingerprint: 8a:86:6f:d1:b2:76:b5:7e:57:8e:92:1c:65:82:8a:2b:ed:58:e9:f2:f2:88:05:41:34:b7:f1:f4:bf:c9:cc:74 +-----BEGIN CERTIFICATE----- +MIIFYDCCA0igAwIBAgIUeFhfLq0sGUvjNwc1NBMotZbUZZMwDQYJKoZIhvcNAQEL +BQAwSDELMAkGA1UEBhMCQk0xGTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxHjAc +BgNVBAMTFVF1b1ZhZGlzIFJvb3QgQ0EgMSBHMzAeFw0xMjAxMTIxNzI3NDRaFw00 +MjAxMTIxNzI3NDRaMEgxCzAJBgNVBAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBM +aW1pdGVkMR4wHAYDVQQDExVRdW9WYWRpcyBSb290IENBIDEgRzMwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQCgvlAQjunybEC0BJyFuTHK3C3kEakEPBtV +wedYMB0ktMPvhd6MLOHBPd+C5k+tR4ds7FtJwUrVu4/sh6x/gpqG7D0DmVIB0jWe +rNrwU8lmPNSsAgHaJNM7qAJGr6Qc4/hzWHa39g6QDbXwz8z6+cZM5cOGMAqNF341 +68Xfuw6cwI2H44g4hWf6Pser4BOcBRiYz5P1sZK0/CPTz9XEJ0ngnjybCKOLXSoh +4Pw5qlPafX7PGglTvF0FBM+hSo+LdoINofjSxxR3W5A2B4GbPgb6Ul5jxaYA/qXp +UhtStZI5cgMJYr2wYBZupt0lwgNm3fME0UDiTouG9G/lg6AnhF4EwfWQvTA9xO+o +abw4m6SkltFi2mnAAZauy8RRNOoMqv8hjlmPSlzkYZqn0ukqeI1RPToV7qJZjqlc +3sX5kCLliEVx3ZGZbHqfPT2YfF72vhZooF6uCyP8Wg+qInYtyaEQHeTTRCOQiJ/G +KubX9ZqzWB4vMIkIG1SitZgj7Ah3HJVdYdHLiZxfokqRmu8hqkkWCKi9YSgxyXSt +hfbZxbGL0eUQMk1fiyA6PEkfM4VZDdvLCXVDaXP7a3F98N/ETH3Goy7IlXnLc6KO +Tk0k+17kBL5yG6YnLUlamXrXXAkgt3+UuU/xDRxeiEIbEbfnkduebPRq34wGmAOt +zCjvpUfzUwIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIB +BjAdBgNVHQ4EFgQUo5fW816iEOGrRZ88F2Q87gFwnMwwDQYJKoZIhvcNAQELBQAD +ggIBABj6W3X8PnrHX3fHyt/PX8MSxEBd1DKquGrX1RUVRpgjpeaQWxiZTOOtQqOC +MTaIzen7xASWSIsBx40Bz1szBpZGZnQdT+3Btrm0DWHMY37XLneMlhwqI2hrhVd2 +cDMT/uFPpiN3GPoajOi9ZcnPP/TJF9zrx7zABC4tRi9pZsMbj/7sPtPKlL92CiUN +qXsCHKnQO18LwIE6PWThv6ctTr1NxNgpxiIY0MWscgKCP6o6ojoilzHdCGPDdRS5 +YCgtW2jgFqlmgiNR9etT2DGbe+m3nUvriBbP+V04ikkwj+3x6xn0dxoxGE1nVGwv +b2X52z3sIexe9PSLymBlVNFxZPT5pqOBMzYzcfCkeF9OrYMh3jRJjehZrJ3ydlo2 +8hP0r+AJx2EqbPfgna67hkooby7utHnNkDPDs3b69fBsnQGQ+p6Q9pxyz0fawx/k +NSBT8lTR32GDpgLiJTjehTItXnOQUl1CxM49S+H5GYQd1aJQzEH7QRTDvdbJWqNj +ZgKAvQU6O0ec7AAmTPWIUb+oI38YB7AL7YsmoWTTYUrrXJ/es69nA7Mf3W1daWhp +q1467HxpvMc7hU6eFbm0FU/DlXpY18ls6Wy58yljXrQs8C097Vpl4KlbQMJImYFt +nh8GKjwStIsPm6Ik8KaN1nrgS7ZklmOVhMJKzRwuJIczYOXD +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root CA 2 G3 O=QuoVadis Limited +# Subject: CN=QuoVadis Root CA 2 G3 O=QuoVadis Limited +# Label: "QuoVadis Root CA 2 G3" +# Serial: 390156079458959257446133169266079962026824725800 +# MD5 Fingerprint: af:0c:86:6e:bf:40:2d:7f:0b:3e:12:50:ba:12:3d:06 +# SHA1 Fingerprint: 09:3c:61:f3:8b:8b:dc:7d:55:df:75:38:02:05:00:e1:25:f5:c8:36 +# SHA256 Fingerprint: 8f:e4:fb:0a:f9:3a:4d:0d:67:db:0b:eb:b2:3e:37:c7:1b:f3:25:dc:bc:dd:24:0e:a0:4d:af:58:b4:7e:18:40 +-----BEGIN CERTIFICATE----- +MIIFYDCCA0igAwIBAgIURFc0JFuBiZs18s64KztbpybwdSgwDQYJKoZIhvcNAQEL +BQAwSDELMAkGA1UEBhMCQk0xGTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxHjAc +BgNVBAMTFVF1b1ZhZGlzIFJvb3QgQ0EgMiBHMzAeFw0xMjAxMTIxODU5MzJaFw00 +MjAxMTIxODU5MzJaMEgxCzAJBgNVBAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBM +aW1pdGVkMR4wHAYDVQQDExVRdW9WYWRpcyBSb290IENBIDIgRzMwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQChriWyARjcV4g/Ruv5r+LrI3HimtFhZiFf +qq8nUeVuGxbULX1QsFN3vXg6YOJkApt8hpvWGo6t/x8Vf9WVHhLL5hSEBMHfNrMW +n4rjyduYNM7YMxcoRvynyfDStNVNCXJJ+fKH46nafaF9a7I6JaltUkSs+L5u+9ym +c5GQYaYDFCDy54ejiK2toIz/pgslUiXnFgHVy7g1gQyjO/Dh4fxaXc6AcW34Sas+ +O7q414AB+6XrW7PFXmAqMaCvN+ggOp+oMiwMzAkd056OXbxMmO7FGmh77FOm6RQ1 +o9/NgJ8MSPsc9PG/Srj61YxxSscfrf5BmrODXfKEVu+lV0POKa2Mq1W/xPtbAd0j +IaFYAI7D0GoT7RPjEiuA3GfmlbLNHiJuKvhB1PLKFAeNilUSxmn1uIZoL1NesNKq +IcGY5jDjZ1XHm26sGahVpkUG0CM62+tlXSoREfA7T8pt9DTEceT/AFr2XK4jYIVz +8eQQsSWu1ZK7E8EM4DnatDlXtas1qnIhO4M15zHfeiFuuDIIfR0ykRVKYnLP43eh +vNURG3YBZwjgQQvD6xVu+KQZ2aKrr+InUlYrAoosFCT5v0ICvybIxo/gbjh9Uy3l +7ZizlWNof/k19N+IxWA1ksB8aRxhlRbQ694Lrz4EEEVlWFA4r0jyWbYW8jwNkALG +cC4BrTwV1wIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIB +BjAdBgNVHQ4EFgQU7edvdlq/YOxJW8ald7tyFnGbxD0wDQYJKoZIhvcNAQELBQAD +ggIBAJHfgD9DCX5xwvfrs4iP4VGyvD11+ShdyLyZm3tdquXK4Qr36LLTn91nMX66 +AarHakE7kNQIXLJgapDwyM4DYvmL7ftuKtwGTTwpD4kWilhMSA/ohGHqPHKmd+RC +roijQ1h5fq7KpVMNqT1wvSAZYaRsOPxDMuHBR//47PERIjKWnML2W2mWeyAMQ0Ga +W/ZZGYjeVYg3UQt4XAoeo0L9x52ID8DyeAIkVJOviYeIyUqAHerQbj5hLja7NQ4n +lv1mNDthcnPxFlxHBlRJAHpYErAK74X9sbgzdWqTHBLmYF5vHX/JHyPLhGGfHoJE ++V+tYlUkmlKY7VHnoX6XOuYvHxHaU4AshZ6rNRDbIl9qxV6XU/IyAgkwo1jwDQHV +csaxfGl7w/U2Rcxhbl5MlMVerugOXou/983g7aEOGzPuVBj+D77vfoRrQ+NwmNtd +dbINWQeFFSM51vHfqSYP1kjHs6Yi9TM3WpVHn3u6GBVv/9YUZINJ0gpnIdsPNWNg +KCLjsZWDzYWm3S8P52dSbrsvhXz1SnPnxT7AvSESBT/8twNJAlvIJebiVDj1eYeM +HVOyToV7BjjHLPj4sHKNJeV3UvQDHEimUF+IIDBu8oJDqz2XhOdT+yHBTw8imoa4 +WSr2Rz0ZiC3oheGe7IUIarFsNMkd7EgrO3jtZsSOeWmD3n+M +-----END CERTIFICATE----- + +# Issuer: CN=QuoVadis Root CA 3 G3 O=QuoVadis Limited +# Subject: CN=QuoVadis Root CA 3 G3 O=QuoVadis Limited +# Label: "QuoVadis Root CA 3 G3" +# Serial: 268090761170461462463995952157327242137089239581 +# MD5 Fingerprint: df:7d:b9:ad:54:6f:68:a1:df:89:57:03:97:43:b0:d7 +# SHA1 Fingerprint: 48:12:bd:92:3c:a8:c4:39:06:e7:30:6d:27:96:e6:a4:cf:22:2e:7d +# SHA256 Fingerprint: 88:ef:81:de:20:2e:b0:18:45:2e:43:f8:64:72:5c:ea:5f:bd:1f:c2:d9:d2:05:73:07:09:c5:d8:b8:69:0f:46 +-----BEGIN CERTIFICATE----- +MIIFYDCCA0igAwIBAgIULvWbAiin23r/1aOp7r0DoM8Sah0wDQYJKoZIhvcNAQEL +BQAwSDELMAkGA1UEBhMCQk0xGTAXBgNVBAoTEFF1b1ZhZGlzIExpbWl0ZWQxHjAc +BgNVBAMTFVF1b1ZhZGlzIFJvb3QgQ0EgMyBHMzAeFw0xMjAxMTIyMDI2MzJaFw00 +MjAxMTIyMDI2MzJaMEgxCzAJBgNVBAYTAkJNMRkwFwYDVQQKExBRdW9WYWRpcyBM +aW1pdGVkMR4wHAYDVQQDExVRdW9WYWRpcyBSb290IENBIDMgRzMwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQCzyw4QZ47qFJenMioKVjZ/aEzHs286IxSR +/xl/pcqs7rN2nXrpixurazHb+gtTTK/FpRp5PIpM/6zfJd5O2YIyC0TeytuMrKNu +FoM7pmRLMon7FhY4futD4tN0SsJiCnMK3UmzV9KwCoWdcTzeo8vAMvMBOSBDGzXR +U7Ox7sWTaYI+FrUoRqHe6okJ7UO4BUaKhvVZR74bbwEhELn9qdIoyhA5CcoTNs+c +ra1AdHkrAj80//ogaX3T7mH1urPnMNA3I4ZyYUUpSFlob3emLoG+B01vr87ERROR +FHAGjx+f+IdpsQ7vw4kZ6+ocYfx6bIrc1gMLnia6Et3UVDmrJqMz6nWB2i3ND0/k +A9HvFZcba5DFApCTZgIhsUfei5pKgLlVj7WiL8DWM2fafsSntARE60f75li59wzw +eyuxwHApw0BiLTtIadwjPEjrewl5qW3aqDCYz4ByA4imW0aucnl8CAMhZa634Ryl +sSqiMd5mBPfAdOhx3v89WcyWJhKLhZVXGqtrdQtEPREoPHtht+KPZ0/l7DxMYIBp +VzgeAVuNVejH38DMdyM0SXV89pgR6y3e7UEuFAUCf+D+IOs15xGsIs5XPd7JMG0Q +A4XN8f+MFrXBsj6IbGB/kE+V9/YtrQE5BwT6dYB9v0lQ7e/JxHwc64B+27bQ3RP+ +ydOc17KXqQIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIB +BjAdBgNVHQ4EFgQUxhfQvKjqAkPyGwaZXSuQILnXnOQwDQYJKoZIhvcNAQELBQAD +ggIBADRh2Va1EodVTd2jNTFGu6QHcrxfYWLopfsLN7E8trP6KZ1/AvWkyaiTt3px +KGmPc+FSkNrVvjrlt3ZqVoAh313m6Tqe5T72omnHKgqwGEfcIHB9UqM+WXzBusnI +FUBhynLWcKzSt/Ac5IYp8M7vaGPQtSCKFWGafoaYtMnCdvvMujAWzKNhxnQT5Wvv +oxXqA/4Ti2Tk08HS6IT7SdEQTXlm66r99I0xHnAUrdzeZxNMgRVhvLfZkXdxGYFg +u/BYpbWcC/ePIlUnwEsBbTuZDdQdm2NnL9DuDcpmvJRPpq3t/O5jrFc/ZSXPsoaP +0Aj/uHYUbt7lJ+yreLVTubY/6CD50qi+YUbKh4yE8/nxoGibIh6BJpsQBJFxwAYf +3KDTuVan45gtf4Od34wrnDKOMpTwATwiKp9Dwi7DmDkHOHv8XgBCH/MyJnmDhPbl +8MFREsALHgQjDFSlTC9JxUrRtm5gDWv8a4uFJGS3iQ6rJUdbPM9+Sb3H6QrG2vd+ +DhcI00iX0HGS8A85PjRqHH3Y8iKuu2n0M7SmSFXRDw4m6Oy2Cy2nhTXN/VnIn9HN +PlopNLk9hM6xZdRZkZFWdSHBd575euFgndOtBBj0fOtek49TSiIp+EgrPk2GrFt/ +ywaZWWDYWGWVjUTR939+J399roD1B0y2PpxxVJkES/1Y+Zj0 +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Assured ID Root G2 O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Assured ID Root G2 O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Assured ID Root G2" +# Serial: 15385348160840213938643033620894905419 +# MD5 Fingerprint: 92:38:b9:f8:63:24:82:65:2c:57:33:e6:fe:81:8f:9d +# SHA1 Fingerprint: a1:4b:48:d9:43:ee:0a:0e:40:90:4f:3c:e0:a4:c0:91:93:51:5d:3f +# SHA256 Fingerprint: 7d:05:eb:b6:82:33:9f:8c:94:51:ee:09:4e:eb:fe:fa:79:53:a1:14:ed:b2:f4:49:49:45:2f:ab:7d:2f:c1:85 +-----BEGIN CERTIFICATE----- +MIIDljCCAn6gAwIBAgIQC5McOtY5Z+pnI7/Dr5r0SzANBgkqhkiG9w0BAQsFADBl +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJv +b3QgRzIwHhcNMTMwODAxMTIwMDAwWhcNMzgwMTE1MTIwMDAwWjBlMQswCQYDVQQG +EwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNl +cnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3QgRzIwggEi +MA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDZ5ygvUj82ckmIkzTz+GoeMVSA +n61UQbVH35ao1K+ALbkKz3X9iaV9JPrjIgwrvJUXCzO/GU1BBpAAvQxNEP4Htecc +biJVMWWXvdMX0h5i89vqbFCMP4QMls+3ywPgym2hFEwbid3tALBSfK+RbLE4E9Hp +EgjAALAcKxHad3A2m67OeYfcgnDmCXRwVWmvo2ifv922ebPynXApVfSr/5Vh88lA +bx3RvpO704gqu52/clpWcTs/1PPRCv4o76Pu2ZmvA9OPYLfykqGxvYmJHzDNw6Yu +YjOuFgJ3RFrngQo8p0Quebg/BLxcoIfhG69Rjs3sLPr4/m3wOnyqi+RnlTGNAgMB +AAGjQjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgGGMB0GA1UdDgQW +BBTOw0q5mVXyuNtgv6l+vVa1lzan1jANBgkqhkiG9w0BAQsFAAOCAQEAyqVVjOPI +QW5pJ6d1Ee88hjZv0p3GeDgdaZaikmkuOGybfQTUiaWxMTeKySHMq2zNixya1r9I +0jJmwYrA8y8678Dj1JGG0VDjA9tzd29KOVPt3ibHtX2vK0LRdWLjSisCx1BL4Gni +lmwORGYQRI+tBev4eaymG+g3NJ1TyWGqolKvSnAWhsI6yLETcDbYz+70CjTVW0z9 +B5yiutkBclzzTcHdDrEcDcRjvq30FPuJ7KJBDkzMyFdA0G4Dqs0MjomZmWzwPDCv +ON9vvKO+KSAnq3T/EyJ43pdSVR6DtVQgA+6uwE9W3jfMw3+qBCe703e4YtsXfJwo +IhNzbM8m9Yop5w== +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Assured ID Root G3 O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Assured ID Root G3 O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Assured ID Root G3" +# Serial: 15459312981008553731928384953135426796 +# MD5 Fingerprint: 7c:7f:65:31:0c:81:df:8d:ba:3e:99:e2:5c:ad:6e:fb +# SHA1 Fingerprint: f5:17:a2:4f:9a:48:c6:c9:f8:a2:00:26:9f:dc:0f:48:2c:ab:30:89 +# SHA256 Fingerprint: 7e:37:cb:8b:4c:47:09:0c:ab:36:55:1b:a6:f4:5d:b8:40:68:0f:ba:16:6a:95:2d:b1:00:71:7f:43:05:3f:c2 +-----BEGIN CERTIFICATE----- +MIICRjCCAc2gAwIBAgIQC6Fa+h3foLVJRK/NJKBs7DAKBggqhkjOPQQDAzBlMQsw +CQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cu +ZGlnaWNlcnQuY29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3Qg +RzMwHhcNMTMwODAxMTIwMDAwWhcNMzgwMTE1MTIwMDAwWjBlMQswCQYDVQQGEwJV +UzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQu +Y29tMSQwIgYDVQQDExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3QgRzMwdjAQBgcq +hkjOPQIBBgUrgQQAIgNiAAQZ57ysRGXtzbg/WPuNsVepRC0FFfLvC/8QdJ+1YlJf +Zn4f5dwbRXkLzMZTCp2NXQLZqVneAlr2lSoOjThKiknGvMYDOAdfVdp+CW7if17Q +RSAPWXYQ1qAk8C3eNvJsKTmjQjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/ +BAQDAgGGMB0GA1UdDgQWBBTL0L2p4ZgFUaFNN6KDec6NHSrkhDAKBggqhkjOPQQD +AwNnADBkAjAlpIFFAmsSS3V0T8gj43DydXLefInwz5FyYZ5eEJJZVrmDxxDnOOlY +JjZ91eQ0hjkCMHw2U/Aw5WJjOpnitqM7mzT6HtoQknFekROn3aRukswy1vUhZscv +6pZjamVFkpUBtA== +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Global Root G2 O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Global Root G2 O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Global Root G2" +# Serial: 4293743540046975378534879503202253541 +# MD5 Fingerprint: e4:a6:8a:c8:54:ac:52:42:46:0a:fd:72:48:1b:2a:44 +# SHA1 Fingerprint: df:3c:24:f9:bf:d6:66:76:1b:26:80:73:fe:06:d1:cc:8d:4f:82:a4 +# SHA256 Fingerprint: cb:3c:cb:b7:60:31:e5:e0:13:8f:8d:d3:9a:23:f9:de:47:ff:c3:5e:43:c1:14:4c:ea:27:d4:6a:5a:b1:cb:5f +-----BEGIN CERTIFICATE----- +MIIDjjCCAnagAwIBAgIQAzrx5qcRqaC7KGSxHQn65TANBgkqhkiG9w0BAQsFADBh +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBH +MjAeFw0xMzA4MDExMjAwMDBaFw0zODAxMTUxMjAwMDBaMGExCzAJBgNVBAYTAlVT +MRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j +b20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IEcyMIIBIjANBgkqhkiG +9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzfNNNx7a8myaJCtSnX/RrohCgiN9RlUyfuI +2/Ou8jqJkTx65qsGGmvPrC3oXgkkRLpimn7Wo6h+4FR1IAWsULecYxpsMNzaHxmx +1x7e/dfgy5SDN67sH0NO3Xss0r0upS/kqbitOtSZpLYl6ZtrAGCSYP9PIUkY92eQ +q2EGnI/yuum06ZIya7XzV+hdG82MHauVBJVJ8zUtluNJbd134/tJS7SsVQepj5Wz +tCO7TG1F8PapspUwtP1MVYwnSlcUfIKdzXOS0xZKBgyMUNGPHgm+F6HmIcr9g+UQ +vIOlCsRnKPZzFBQ9RnbDhxSJITRNrw9FDKZJobq7nMWxM4MphQIDAQABo0IwQDAP +BgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAdBgNVHQ4EFgQUTiJUIBiV +5uNu5g/6+rkS7QYXjzkwDQYJKoZIhvcNAQELBQADggEBAGBnKJRvDkhj6zHd6mcY +1Yl9PMWLSn/pvtsrF9+wX3N3KjITOYFnQoQj8kVnNeyIv/iPsGEMNKSuIEyExtv4 +NeF22d+mQrvHRAiGfzZ0JFrabA0UWTW98kndth/Jsw1HKj2ZL7tcu7XUIOGZX1NG +Fdtom/DzMNU+MeKNhJ7jitralj41E6Vf8PlwUHBHQRFXGU7Aj64GxJUTFy8bJZ91 +8rGOmaFvE7FBcf6IKshPECBV1/MUReXgRPTqh5Uykw7+U0b6LJ3/iyK5S9kJRaTe +pLiaWN0bfVKfjllDiIGknibVb63dDcY3fe0Dkhvld1927jyNxF1WW6LZZm6zNTfl +MrY= +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Global Root G3 O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Global Root G3 O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Global Root G3" +# Serial: 7089244469030293291760083333884364146 +# MD5 Fingerprint: f5:5d:a4:50:a5:fb:28:7e:1e:0f:0d:cc:96:57:56:ca +# SHA1 Fingerprint: 7e:04:de:89:6a:3e:66:6d:00:e6:87:d3:3f:fa:d9:3b:e8:3d:34:9e +# SHA256 Fingerprint: 31:ad:66:48:f8:10:41:38:c7:38:f3:9e:a4:32:01:33:39:3e:3a:18:cc:02:29:6e:f9:7c:2a:c9:ef:67:31:d0 +-----BEGIN CERTIFICATE----- +MIICPzCCAcWgAwIBAgIQBVVWvPJepDU1w6QP1atFcjAKBggqhkjOPQQDAzBhMQsw +CQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cu +ZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBHMzAe +Fw0xMzA4MDExMjAwMDBaFw0zODAxMTUxMjAwMDBaMGExCzAJBgNVBAYTAlVTMRUw +EwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5jb20x +IDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IEczMHYwEAYHKoZIzj0CAQYF +K4EEACIDYgAE3afZu4q4C/sLfyHS8L6+c/MzXRq8NOrexpu80JX28MzQC7phW1FG +fp4tn+6OYwwX7Adw9c+ELkCDnOg/QW07rdOkFFk2eJ0DQ+4QE2xy3q6Ip6FrtUPO +Z9wj/wMco+I+o0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBhjAd +BgNVHQ4EFgQUs9tIpPmhxdiuNkHMEWNpYim8S8YwCgYIKoZIzj0EAwMDaAAwZQIx +AK288mw/EkrRLTnDCgmXc/SINoyIJ7vmiI1Qhadj+Z4y3maTD/HMsQmP3Wyr+mt/ +oAIwOWZbwmSNuJ5Q3KjVSaLtx9zRSX8XAbjIho9OjIgrqJqpisXRAL34VOKa5Vt8 +sycX +-----END CERTIFICATE----- + +# Issuer: CN=DigiCert Trusted Root G4 O=DigiCert Inc OU=www.digicert.com +# Subject: CN=DigiCert Trusted Root G4 O=DigiCert Inc OU=www.digicert.com +# Label: "DigiCert Trusted Root G4" +# Serial: 7451500558977370777930084869016614236 +# MD5 Fingerprint: 78:f2:fc:aa:60:1f:2f:b4:eb:c9:37:ba:53:2e:75:49 +# SHA1 Fingerprint: dd:fb:16:cd:49:31:c9:73:a2:03:7d:3f:c8:3a:4d:7d:77:5d:05:e4 +# SHA256 Fingerprint: 55:2f:7b:dc:f1:a7:af:9e:6c:e6:72:01:7f:4f:12:ab:f7:72:40:c7:8e:76:1a:c2:03:d1:d9:d2:0a:c8:99:88 +-----BEGIN CERTIFICATE----- +MIIFkDCCA3igAwIBAgIQBZsbV56OITLiOQe9p3d1XDANBgkqhkiG9w0BAQwFADBi +MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 +d3cuZGlnaWNlcnQuY29tMSEwHwYDVQQDExhEaWdpQ2VydCBUcnVzdGVkIFJvb3Qg +RzQwHhcNMTMwODAxMTIwMDAwWhcNMzgwMTE1MTIwMDAwWjBiMQswCQYDVQQGEwJV +UzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQu +Y29tMSEwHwYDVQQDExhEaWdpQ2VydCBUcnVzdGVkIFJvb3QgRzQwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQC/5pBzaN675F1KPDAiMGkz7MKnJS7JIT3y +ithZwuEppz1Yq3aaza57G4QNxDAf8xukOBbrVsaXbR2rsnnyyhHS5F/WBTxSD1If +xp4VpX6+n6lXFllVcq9ok3DCsrp1mWpzMpTREEQQLt+C8weE5nQ7bXHiLQwb7iDV +ySAdYyktzuxeTsiT+CFhmzTrBcZe7FsavOvJz82sNEBfsXpm7nfISKhmV1efVFiO +DCu3T6cw2Vbuyntd463JT17lNecxy9qTXtyOj4DatpGYQJB5w3jHtrHEtWoYOAMQ +jdjUN6QuBX2I9YI+EJFwq1WCQTLX2wRzKm6RAXwhTNS8rhsDdV14Ztk6MUSaM0C/ +CNdaSaTC5qmgZ92kJ7yhTzm1EVgX9yRcRo9k98FpiHaYdj1ZXUJ2h4mXaXpI8OCi +EhtmmnTK3kse5w5jrubU75KSOp493ADkRSWJtppEGSt+wJS00mFt6zPZxd9LBADM +fRyVw4/3IbKyEbe7f/LVjHAsQWCqsWMYRJUadmJ+9oCw++hkpjPRiQfhvbfmQ6QY +uKZ3AeEPlAwhHbJUKSWJbOUOUlFHdL4mrLZBdd56rF+NP8m800ERElvlEFDrMcXK +chYiCd98THU/Y+whX8QgUWtvsauGi0/C1kVfnSD8oR7FwI+isX4KJpn15GkvmB0t +9dmpsh3lGwIDAQABo0IwQDAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIB +hjAdBgNVHQ4EFgQU7NfjgtJxXWRM3y5nP+e6mK4cD08wDQYJKoZIhvcNAQEMBQAD +ggIBALth2X2pbL4XxJEbw6GiAI3jZGgPVs93rnD5/ZpKmbnJeFwMDF/k5hQpVgs2 +SV1EY+CtnJYYZhsjDT156W1r1lT40jzBQ0CuHVD1UvyQO7uYmWlrx8GnqGikJ9yd ++SeuMIW59mdNOj6PWTkiU0TryF0Dyu1Qen1iIQqAyHNm0aAFYF/opbSnr6j3bTWc +fFqK1qI4mfN4i/RN0iAL3gTujJtHgXINwBQy7zBZLq7gcfJW5GqXb5JQbZaNaHqa +sjYUegbyJLkJEVDXCLG4iXqEI2FCKeWjzaIgQdfRnGTZ6iahixTXTBmyUEFxPT9N +cCOGDErcgdLMMpSEDQgJlxxPwO5rIHQw0uA5NBCFIRUBCOhVMt5xSdkoF1BN5r5N +0XWs0Mr7QbhDparTwwVETyw2m+L64kW4I1NsBm9nVX9GtUw/bihaeSbSpKhil9Ie +4u1Ki7wb/UdKDd9nZn6yW0HQO+T0O/QEY+nvwlQAUaCKKsnOeMzV6ocEGLPOr0mI +r/OSmbaz5mEP0oUA51Aa5BuVnRmhuZyxm7EAHu/QD09CbMkKvO5D+jpxpchNJqU1 +/YldvIViHTLSoCtU7ZpXwdv6EM8Zt4tKG48BtieVU+i2iW1bvGjUI+iLUaJW+fCm +gKDWHrO8Dw9TdSmq6hN35N6MgSGtBxBHEa2HPQfRdbzP82Z+ +-----END CERTIFICATE----- + +# Issuer: CN=COMODO RSA Certification Authority O=COMODO CA Limited +# Subject: CN=COMODO RSA Certification Authority O=COMODO CA Limited +# Label: "COMODO RSA Certification Authority" +# Serial: 101909084537582093308941363524873193117 +# MD5 Fingerprint: 1b:31:b0:71:40:36:cc:14:36:91:ad:c4:3e:fd:ec:18 +# SHA1 Fingerprint: af:e5:d2:44:a8:d1:19:42:30:ff:47:9f:e2:f8:97:bb:cd:7a:8c:b4 +# SHA256 Fingerprint: 52:f0:e1:c4:e5:8e:c6:29:29:1b:60:31:7f:07:46:71:b8:5d:7e:a8:0d:5b:07:27:34:63:53:4b:32:b4:02:34 +-----BEGIN CERTIFICATE----- +MIIF2DCCA8CgAwIBAgIQTKr5yttjb+Af907YWwOGnTANBgkqhkiG9w0BAQwFADCB +hTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G +A1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxKzApBgNV +BAMTIkNPTU9ETyBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTAwMTE5 +MDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCBhTELMAkGA1UEBhMCR0IxGzAZBgNVBAgT +EkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEaMBgGA1UEChMR +Q09NT0RPIENBIExpbWl0ZWQxKzApBgNVBAMTIkNPTU9ETyBSU0EgQ2VydGlmaWNh +dGlvbiBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCR +6FSS0gpWsawNJN3Fz0RndJkrN6N9I3AAcbxT38T6KhKPS38QVr2fcHK3YX/JSw8X +pz3jsARh7v8Rl8f0hj4K+j5c+ZPmNHrZFGvnnLOFoIJ6dq9xkNfs/Q36nGz637CC +9BR++b7Epi9Pf5l/tfxnQ3K9DADWietrLNPtj5gcFKt+5eNu/Nio5JIk2kNrYrhV +/erBvGy2i/MOjZrkm2xpmfh4SDBF1a3hDTxFYPwyllEnvGfDyi62a+pGx8cgoLEf +Zd5ICLqkTqnyg0Y3hOvozIFIQ2dOciqbXL1MGyiKXCJ7tKuY2e7gUYPDCUZObT6Z ++pUX2nwzV0E8jVHtC7ZcryxjGt9XyD+86V3Em69FmeKjWiS0uqlWPc9vqv9JWL7w +qP/0uK3pN/u6uPQLOvnoQ0IeidiEyxPx2bvhiWC4jChWrBQdnArncevPDt09qZah +SL0896+1DSJMwBGB7FY79tOi4lu3sgQiUpWAk2nojkxl8ZEDLXB0AuqLZxUpaVIC +u9ffUGpVRr+goyhhf3DQw6KqLCGqR84onAZFdr+CGCe01a60y1Dma/RMhnEw6abf +Fobg2P9A3fvQQoh/ozM6LlweQRGBY84YcWsr7KaKtzFcOmpH4MN5WdYgGq/yapiq +crxXStJLnbsQ/LBMQeXtHT1eKJ2czL+zUdqnR+WEUwIDAQABo0IwQDAdBgNVHQ4E +FgQUu69+Aj36pvE8hI6t7jiY7NkyMtQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB +/wQFMAMBAf8wDQYJKoZIhvcNAQEMBQADggIBAArx1UaEt65Ru2yyTUEUAJNMnMvl +wFTPoCWOAvn9sKIN9SCYPBMtrFaisNZ+EZLpLrqeLppysb0ZRGxhNaKatBYSaVqM +4dc+pBroLwP0rmEdEBsqpIt6xf4FpuHA1sj+nq6PK7o9mfjYcwlYRm6mnPTXJ9OV +2jeDchzTc+CiR5kDOF3VSXkAKRzH7JsgHAckaVd4sjn8OoSgtZx8jb8uk2Intzna +FxiuvTwJaP+EmzzV1gsD41eeFPfR60/IvYcjt7ZJQ3mFXLrrkguhxuhoqEwWsRqZ +CuhTLJK7oQkYdQxlqHvLI7cawiiFwxv/0Cti76R7CZGYZ4wUAc1oBmpjIXUDgIiK +boHGhfKppC3n9KUkEEeDys30jXlYsQab5xoq2Z0B15R97QNKyvDb6KkBPvVWmcke +jkk9u+UJueBPSZI9FoJAzMxZxuY67RIuaTxslbH9qh17f4a+Hg4yRvv7E491f0yL +S0Zj/gA0QHDBw7mh3aZw4gSzQbzpgJHqZJx64SIDqZxubw5lT2yHh17zbqD5daWb +QOhTsiedSrnAdyGN/4fy3ryM7xfft0kL0fJuMAsaDk527RH89elWsn2/x20Kk4yl +0MC2Hb46TpSi125sC8KKfPog88Tk5c0NqMuRkrF8hey1FGlmDoLnzc7ILaZRfyHB +NVOFBkpdn627G190 +-----END CERTIFICATE----- + +# Issuer: CN=USERTrust RSA Certification Authority O=The USERTRUST Network +# Subject: CN=USERTrust RSA Certification Authority O=The USERTRUST Network +# Label: "USERTrust RSA Certification Authority" +# Serial: 2645093764781058787591871645665788717 +# MD5 Fingerprint: 1b:fe:69:d1:91:b7:19:33:a3:72:a8:0f:e1:55:e5:b5 +# SHA1 Fingerprint: 2b:8f:1b:57:33:0d:bb:a2:d0:7a:6c:51:f7:0e:e9:0d:da:b9:ad:8e +# SHA256 Fingerprint: e7:93:c9:b0:2f:d8:aa:13:e2:1c:31:22:8a:cc:b0:81:19:64:3b:74:9c:89:89:64:b1:74:6d:46:c3:d4:cb:d2 +-----BEGIN CERTIFICATE----- +MIIF3jCCA8agAwIBAgIQAf1tMPyjylGoG7xkDjUDLTANBgkqhkiG9w0BAQwFADCB +iDELMAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0pl +cnNleSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNV +BAMTJVVTRVJUcnVzdCBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTAw +MjAxMDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCBiDELMAkGA1UEBhMCVVMxEzARBgNV +BAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0plcnNleSBDaXR5MR4wHAYDVQQKExVU +aGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNVBAMTJVVTRVJUcnVzdCBSU0EgQ2Vy +dGlmaWNhdGlvbiBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK +AoICAQCAEmUXNg7D2wiz0KxXDXbtzSfTTK1Qg2HiqiBNCS1kCdzOiZ/MPans9s/B +3PHTsdZ7NygRK0faOca8Ohm0X6a9fZ2jY0K2dvKpOyuR+OJv0OwWIJAJPuLodMkY +tJHUYmTbf6MG8YgYapAiPLz+E/CHFHv25B+O1ORRxhFnRghRy4YUVD+8M/5+bJz/ +Fp0YvVGONaanZshyZ9shZrHUm3gDwFA66Mzw3LyeTP6vBZY1H1dat//O+T23LLb2 +VN3I5xI6Ta5MirdcmrS3ID3KfyI0rn47aGYBROcBTkZTmzNg95S+UzeQc0PzMsNT +79uq/nROacdrjGCT3sTHDN/hMq7MkztReJVni+49Vv4M0GkPGw/zJSZrM233bkf6 +c0Plfg6lZrEpfDKEY1WJxA3Bk1QwGROs0303p+tdOmw1XNtB1xLaqUkL39iAigmT +Yo61Zs8liM2EuLE/pDkP2QKe6xJMlXzzawWpXhaDzLhn4ugTncxbgtNMs+1b/97l +c6wjOy0AvzVVdAlJ2ElYGn+SNuZRkg7zJn0cTRe8yexDJtC/QV9AqURE9JnnV4ee +UB9XVKg+/XRjL7FQZQnmWEIuQxpMtPAlR1n6BB6T1CZGSlCBst6+eLf8ZxXhyVeE +Hg9j1uliutZfVS7qXMYoCAQlObgOK6nyTJccBz8NUvXt7y+CDwIDAQABo0IwQDAd +BgNVHQ4EFgQUU3m/WqorSs9UgOHYm8Cd8rIDZsswDgYDVR0PAQH/BAQDAgEGMA8G +A1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEMBQADggIBAFzUfA3P9wF9QZllDHPF +Up/L+M+ZBn8b2kMVn54CVVeWFPFSPCeHlCjtHzoBN6J2/FNQwISbxmtOuowhT6KO +VWKR82kV2LyI48SqC/3vqOlLVSoGIG1VeCkZ7l8wXEskEVX/JJpuXior7gtNn3/3 +ATiUFJVDBwn7YKnuHKsSjKCaXqeYalltiz8I+8jRRa8YFWSQEg9zKC7F4iRO/Fjs +8PRF/iKz6y+O0tlFYQXBl2+odnKPi4w2r78NBc5xjeambx9spnFixdjQg3IM8WcR +iQycE0xyNN+81XHfqnHd4blsjDwSXWXavVcStkNr/+XeTWYRUc+ZruwXtuhxkYze +Sf7dNXGiFSeUHM9h4ya7b6NnJSFd5t0dCy5oGzuCr+yDZ4XUmFF0sbmZgIn/f3gZ +XHlKYC6SQK5MNyosycdiyA5d9zZbyuAlJQG03RoHnHcAP9Dc1ew91Pq7P8yF1m9/ +qS3fuQL39ZeatTXaw2ewh0qpKJ4jjv9cJ2vhsE/zB+4ALtRZh8tSQZXq9EfX7mRB +VXyNWQKV3WKdwrnuWih0hKWbt5DHDAff9Yk2dDLWKMGwsAvgnEzDHNb842m1R0aB +L6KCq9NjRHDEjf8tM7qtj3u1cIiuPhnPQCjY/MiQu12ZIvVS5ljFH4gxQ+6IHdfG +jjxDah2nGN59PRbxYvnKkKj9 +-----END CERTIFICATE----- + +# Issuer: CN=USERTrust ECC Certification Authority O=The USERTRUST Network +# Subject: CN=USERTrust ECC Certification Authority O=The USERTRUST Network +# Label: "USERTrust ECC Certification Authority" +# Serial: 123013823720199481456569720443997572134 +# MD5 Fingerprint: fa:68:bc:d9:b5:7f:ad:fd:c9:1d:06:83:28:cc:24:c1 +# SHA1 Fingerprint: d1:cb:ca:5d:b2:d5:2a:7f:69:3b:67:4d:e5:f0:5a:1d:0c:95:7d:f0 +# SHA256 Fingerprint: 4f:f4:60:d5:4b:9c:86:da:bf:bc:fc:57:12:e0:40:0d:2b:ed:3f:bc:4d:4f:bd:aa:86:e0:6a:dc:d2:a9:ad:7a +-----BEGIN CERTIFICATE----- +MIICjzCCAhWgAwIBAgIQXIuZxVqUxdJxVt7NiYDMJjAKBggqhkjOPQQDAzCBiDEL +MAkGA1UEBhMCVVMxEzARBgNVBAgTCk5ldyBKZXJzZXkxFDASBgNVBAcTC0plcnNl +eSBDaXR5MR4wHAYDVQQKExVUaGUgVVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNVBAMT +JVVTRVJUcnVzdCBFQ0MgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTAwMjAx +MDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCBiDELMAkGA1UEBhMCVVMxEzARBgNVBAgT +Ck5ldyBKZXJzZXkxFDASBgNVBAcTC0plcnNleSBDaXR5MR4wHAYDVQQKExVUaGUg +VVNFUlRSVVNUIE5ldHdvcmsxLjAsBgNVBAMTJVVTRVJUcnVzdCBFQ0MgQ2VydGlm +aWNhdGlvbiBBdXRob3JpdHkwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAQarFRaqflo +I+d61SRvU8Za2EurxtW20eZzca7dnNYMYf3boIkDuAUU7FfO7l0/4iGzzvfUinng +o4N+LZfQYcTxmdwlkWOrfzCjtHDix6EznPO/LlxTsV+zfTJ/ijTjeXmjQjBAMB0G +A1UdDgQWBBQ64QmG1M8ZwpZ2dEl23OA1xmNjmjAOBgNVHQ8BAf8EBAMCAQYwDwYD +VR0TAQH/BAUwAwEB/zAKBggqhkjOPQQDAwNoADBlAjA2Z6EWCNzklwBBHU6+4WMB +zzuqQhFkoJ2UOQIReVx7Hfpkue4WQrO/isIJxOzksU0CMQDpKmFHjFJKS04YcPbW +RNZu9YO6bVi9JNlWSOrvxKJGgYhqOkbRqZtNyWHa0V1Xahg= +-----END CERTIFICATE----- + +# Issuer: CN=GlobalSign O=GlobalSign OU=GlobalSign ECC Root CA - R4 +# Subject: CN=GlobalSign O=GlobalSign OU=GlobalSign ECC Root CA - R4 +# Label: "GlobalSign ECC Root CA - R4" +# Serial: 14367148294922964480859022125800977897474 +# MD5 Fingerprint: 20:f0:27:68:d1:7e:a0:9d:0e:e6:2a:ca:df:5c:89:8e +# SHA1 Fingerprint: 69:69:56:2e:40:80:f4:24:a1:e7:19:9f:14:ba:f3:ee:58:ab:6a:bb +# SHA256 Fingerprint: be:c9:49:11:c2:95:56:76:db:6c:0a:55:09:86:d7:6e:3b:a0:05:66:7c:44:2c:97:62:b4:fb:b7:73:de:22:8c +-----BEGIN CERTIFICATE----- +MIIB4TCCAYegAwIBAgIRKjikHJYKBN5CsiilC+g0mAIwCgYIKoZIzj0EAwIwUDEk +MCIGA1UECxMbR2xvYmFsU2lnbiBFQ0MgUm9vdCBDQSAtIFI0MRMwEQYDVQQKEwpH +bG9iYWxTaWduMRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTEyMTExMzAwMDAwMFoX +DTM4MDExOTAzMTQwN1owUDEkMCIGA1UECxMbR2xvYmFsU2lnbiBFQ0MgUm9vdCBD +QSAtIFI0MRMwEQYDVQQKEwpHbG9iYWxTaWduMRMwEQYDVQQDEwpHbG9iYWxTaWdu +MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEuMZ5049sJQ6fLjkZHAOkrprlOQcJ +FspjsbmG+IpXwVfOQvpzofdlQv8ewQCybnMO/8ch5RikqtlxP6jUuc6MHaNCMEAw +DgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFFSwe61F +uOJAf/sKbvu+M8k8o4TVMAoGCCqGSM49BAMCA0gAMEUCIQDckqGgE6bPA7DmxCGX +kPoUVy0D7O48027KqGx2vKLeuwIgJ6iFJzWbVsaj8kfSt24bAgAXqmemFZHe+pTs +ewv4n4Q= +-----END CERTIFICATE----- + +# Issuer: CN=GlobalSign O=GlobalSign OU=GlobalSign ECC Root CA - R5 +# Subject: CN=GlobalSign O=GlobalSign OU=GlobalSign ECC Root CA - R5 +# Label: "GlobalSign ECC Root CA - R5" +# Serial: 32785792099990507226680698011560947931244 +# MD5 Fingerprint: 9f:ad:3b:1c:02:1e:8a:ba:17:74:38:81:0c:a2:bc:08 +# SHA1 Fingerprint: 1f:24:c6:30:cd:a4:18:ef:20:69:ff:ad:4f:dd:5f:46:3a:1b:69:aa +# SHA256 Fingerprint: 17:9f:bc:14:8a:3d:d0:0f:d2:4e:a1:34:58:cc:43:bf:a7:f5:9c:81:82:d7:83:a5:13:f6:eb:ec:10:0c:89:24 +-----BEGIN CERTIFICATE----- +MIICHjCCAaSgAwIBAgIRYFlJ4CYuu1X5CneKcflK2GwwCgYIKoZIzj0EAwMwUDEk +MCIGA1UECxMbR2xvYmFsU2lnbiBFQ0MgUm9vdCBDQSAtIFI1MRMwEQYDVQQKEwpH +bG9iYWxTaWduMRMwEQYDVQQDEwpHbG9iYWxTaWduMB4XDTEyMTExMzAwMDAwMFoX +DTM4MDExOTAzMTQwN1owUDEkMCIGA1UECxMbR2xvYmFsU2lnbiBFQ0MgUm9vdCBD +QSAtIFI1MRMwEQYDVQQKEwpHbG9iYWxTaWduMRMwEQYDVQQDEwpHbG9iYWxTaWdu +MHYwEAYHKoZIzj0CAQYFK4EEACIDYgAER0UOlvt9Xb/pOdEh+J8LttV7HpI6SFkc +8GIxLcB6KP4ap1yztsyX50XUWPrRd21DosCHZTQKH3rd6zwzocWdTaRvQZU4f8ke +hOvRnkmSh5SHDDqFSmafnVmTTZdhBoZKo0IwQDAOBgNVHQ8BAf8EBAMCAQYwDwYD +VR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUPeYpSJvqB8ohREom3m7e0oPQn1kwCgYI +KoZIzj0EAwMDaAAwZQIxAOVpEslu28YxuglB4Zf4+/2a4n0Sye18ZNPLBSWLVtmg +515dTguDnFt2KaAJJiFqYgIwcdK1j1zqO+F4CYWodZI7yFz9SO8NdCKoCOJuxUnO +xwy8p2Fp8fc74SrL+SvzZpA3 +-----END CERTIFICATE----- + +# Issuer: CN=Staat der Nederlanden Root CA - G3 O=Staat der Nederlanden +# Subject: CN=Staat der Nederlanden Root CA - G3 O=Staat der Nederlanden +# Label: "Staat der Nederlanden Root CA - G3" +# Serial: 10003001 +# MD5 Fingerprint: 0b:46:67:07:db:10:2f:19:8c:35:50:60:d1:0b:f4:37 +# SHA1 Fingerprint: d8:eb:6b:41:51:92:59:e0:f3:e7:85:00:c0:3d:b6:88:97:c9:ee:fc +# SHA256 Fingerprint: 3c:4f:b0:b9:5a:b8:b3:00:32:f4:32:b8:6f:53:5f:e1:72:c1:85:d0:fd:39:86:58:37:cf:36:18:7f:a6:f4:28 +-----BEGIN CERTIFICATE----- +MIIFdDCCA1ygAwIBAgIEAJiiOTANBgkqhkiG9w0BAQsFADBaMQswCQYDVQQGEwJO +TDEeMBwGA1UECgwVU3RhYXQgZGVyIE5lZGVybGFuZGVuMSswKQYDVQQDDCJTdGFh +dCBkZXIgTmVkZXJsYW5kZW4gUm9vdCBDQSAtIEczMB4XDTEzMTExNDExMjg0MloX +DTI4MTExMzIzMDAwMFowWjELMAkGA1UEBhMCTkwxHjAcBgNVBAoMFVN0YWF0IGRl +ciBOZWRlcmxhbmRlbjErMCkGA1UEAwwiU3RhYXQgZGVyIE5lZGVybGFuZGVuIFJv +b3QgQ0EgLSBHMzCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAL4yolQP +cPssXFnrbMSkUeiFKrPMSjTysF/zDsccPVMeiAho2G89rcKezIJnByeHaHE6n3WW +IkYFsO2tx1ueKt6c/DrGlaf1F2cY5y9JCAxcz+bMNO14+1Cx3Gsy8KL+tjzk7FqX +xz8ecAgwoNzFs21v0IJyEavSgWhZghe3eJJg+szeP4TrjTgzkApyI/o1zCZxMdFy +KJLZWyNtZrVtB0LrpjPOktvA9mxjeM3KTj215VKb8b475lRgsGYeCasH/lSJEULR +9yS6YHgamPfJEf0WwTUaVHXvQ9Plrk7O53vDxk5hUUurmkVLoR9BvUhTFXFkC4az +5S6+zqQbwSmEorXLCCN2QyIkHxcE1G6cxvx/K2Ya7Irl1s9N9WMJtxU51nus6+N8 +6U78dULI7ViVDAZCopz35HCz33JvWjdAidiFpNfxC95DGdRKWCyMijmev4SH8RY7 +Ngzp07TKbBlBUgmhHbBqv4LvcFEhMtwFdozL92TkA1CvjJFnq8Xy7ljY3r735zHP +bMk7ccHViLVlvMDoFxcHErVc0qsgk7TmgoNwNsXNo42ti+yjwUOH5kPiNL6VizXt +BznaqB16nzaeErAMZRKQFWDZJkBE41ZgpRDUajz9QdwOWke275dhdU/Z/seyHdTt +XUmzqWrLZoQT1Vyg3N9udwbRcXXIV2+vD3dbAgMBAAGjQjBAMA8GA1UdEwEB/wQF +MAMBAf8wDgYDVR0PAQH/BAQDAgEGMB0GA1UdDgQWBBRUrfrHkleuyjWcLhL75Lpd +INyUVzANBgkqhkiG9w0BAQsFAAOCAgEAMJmdBTLIXg47mAE6iqTnB/d6+Oea31BD +U5cqPco8R5gu4RV78ZLzYdqQJRZlwJ9UXQ4DO1t3ApyEtg2YXzTdO2PCwyiBwpwp +LiniyMMB8jPqKqrMCQj3ZWfGzd/TtiunvczRDnBfuCPRy5FOCvTIeuXZYzbB1N/8 +Ipf3YF3qKS9Ysr1YvY2WTxB1v0h7PVGHoTx0IsL8B3+A3MSs/mrBcDCw6Y5p4ixp +gZQJut3+TcCDjJRYwEYgr5wfAvg1VUkvRtTA8KCWAg8zxXHzniN9lLf9OtMJgwYh +/WA9rjLA0u6NpvDntIJ8CsxwyXmA+P5M9zWEGYox+wrZ13+b8KKaa8MFSu1BYBQw +0aoRQm7TIwIEC8Zl3d1Sd9qBa7Ko+gE4uZbqKmxnl4mUnrzhVNXkanjvSr0rmj1A +fsbAddJu+2gw7OyLnflJNZoaLNmzlTnVHpL3prllL+U9bTpITAjc5CgSKL59NVzq +4BZ+Extq1z7XnvwtdbLBFNUjA9tbbws+eC8N3jONFrdI54OagQ97wUNNVQQXOEpR +1VmiiXTTn74eS9fGbbeIJG9gkaSChVtWQbzQRKtqE77RLFi3EjNYsjdj3BP1lB0/ +QFH1T/U67cjF68IeHRaVesd+QnGTbksVtzDfqu1XhUisHWrdOWnk4Xl4vs4Fv6EM +94B7IWcnMFk= +-----END CERTIFICATE----- + +# Issuer: CN=Staat der Nederlanden EV Root CA O=Staat der Nederlanden +# Subject: CN=Staat der Nederlanden EV Root CA O=Staat der Nederlanden +# Label: "Staat der Nederlanden EV Root CA" +# Serial: 10000013 +# MD5 Fingerprint: fc:06:af:7b:e8:1a:f1:9a:b4:e8:d2:70:1f:c0:f5:ba +# SHA1 Fingerprint: 76:e2:7e:c1:4f:db:82:c1:c0:a6:75:b5:05:be:3d:29:b4:ed:db:bb +# SHA256 Fingerprint: 4d:24:91:41:4c:fe:95:67:46:ec:4c:ef:a6:cf:6f:72:e2:8a:13:29:43:2f:9d:8a:90:7a:c4:cb:5d:ad:c1:5a +-----BEGIN CERTIFICATE----- +MIIFcDCCA1igAwIBAgIEAJiWjTANBgkqhkiG9w0BAQsFADBYMQswCQYDVQQGEwJO +TDEeMBwGA1UECgwVU3RhYXQgZGVyIE5lZGVybGFuZGVuMSkwJwYDVQQDDCBTdGFh +dCBkZXIgTmVkZXJsYW5kZW4gRVYgUm9vdCBDQTAeFw0xMDEyMDgxMTE5MjlaFw0y +MjEyMDgxMTEwMjhaMFgxCzAJBgNVBAYTAk5MMR4wHAYDVQQKDBVTdGFhdCBkZXIg +TmVkZXJsYW5kZW4xKTAnBgNVBAMMIFN0YWF0IGRlciBOZWRlcmxhbmRlbiBFViBS +b290IENBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEA48d+ifkkSzrS +M4M1LGns3Amk41GoJSt5uAg94JG6hIXGhaTK5skuU6TJJB79VWZxXSzFYGgEt9nC +UiY4iKTWO0Cmws0/zZiTs1QUWJZV1VD+hq2kY39ch/aO5ieSZxeSAgMs3NZmdO3d +Z//BYY1jTw+bbRcwJu+r0h8QoPnFfxZpgQNH7R5ojXKhTbImxrpsX23Wr9GxE46p +rfNeaXUmGD5BKyF/7otdBwadQ8QpCiv8Kj6GyzyDOvnJDdrFmeK8eEEzduG/L13l +pJhQDBXd4Pqcfzho0LKmeqfRMb1+ilgnQ7O6M5HTp5gVXJrm0w912fxBmJc+qiXb +j5IusHsMX/FjqTf5m3VpTCgmJdrV8hJwRVXj33NeN/UhbJCONVrJ0yPr08C+eKxC +KFhmpUZtcALXEPlLVPxdhkqHz3/KRawRWrUgUY0viEeXOcDPusBCAUCZSCELa6fS +/ZbV0b5GnUngC6agIk440ME8MLxwjyx1zNDFjFE7PZQIZCZhfbnDZY8UnCHQqv0X +cgOPvZuM5l5Tnrmd74K74bzickFbIZTTRTeU0d8JOV3nI6qaHcptqAqGhYqCvkIH +1vI4gnPah1vlPNOePqc7nvQDs/nxfRN0Av+7oeX6AHkcpmZBiFxgV6YuCcS6/ZrP +px9Aw7vMWgpVSzs4dlG4Y4uElBbmVvMCAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB +/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFP6rAJCYniT8qcwaivsnuL8wbqg7 +MA0GCSqGSIb3DQEBCwUAA4ICAQDPdyxuVr5Os7aEAJSrR8kN0nbHhp8dB9O2tLsI +eK9p0gtJ3jPFrK3CiAJ9Brc1AsFgyb/E6JTe1NOpEyVa/m6irn0F3H3zbPB+po3u +2dfOWBfoqSmuc0iH55vKbimhZF8ZE/euBhD/UcabTVUlT5OZEAFTdfETzsemQUHS +v4ilf0X8rLiltTMMgsT7B/Zq5SWEXwbKwYY5EdtYzXc7LMJMD16a4/CrPmEbUCTC +wPTxGfARKbalGAKb12NMcIxHowNDXLldRqANb/9Zjr7dn3LDWyvfjFvO5QxGbJKy +CqNMVEIYFRIYvdr8unRu/8G2oGTYqV9Vrp9canaW2HNnh/tNf1zuacpzEPuKqf2e +vTY4SUmH9A4U8OmHuD+nT3pajnnUk+S7aFKErGzp85hwVXIy+TSrK0m1zSBi5Dp6 +Z2Orltxtrpfs/J92VoguZs9btsmksNcFuuEnL5O7Jiqik7Ab846+HUCjuTaPPoIa +Gl6I6lD4WeKDRikL40Rc4ZW2aZCaFG+XroHPaO+Zmr615+F/+PoTRxZMzG0IQOeL +eG9QgkRQP2YGiqtDhFZKDyAthg710tvSeopLzaXoTvFeJiUBWSOgftL2fiFX1ye8 +FVdMpEbB4IMeDExNH08GGeL5qPQ6gqGyeUN51q1veieQA6TqJIc/2b3Z6fJfUEkc +7uzXLg== +-----END CERTIFICATE----- + +# Issuer: CN=IdenTrust Commercial Root CA 1 O=IdenTrust +# Subject: CN=IdenTrust Commercial Root CA 1 O=IdenTrust +# Label: "IdenTrust Commercial Root CA 1" +# Serial: 13298821034946342390520003877796839426 +# MD5 Fingerprint: b3:3e:77:73:75:ee:a0:d3:e3:7e:49:63:49:59:bb:c7 +# SHA1 Fingerprint: df:71:7e:aa:4a:d9:4e:c9:55:84:99:60:2d:48:de:5f:bc:f0:3a:25 +# SHA256 Fingerprint: 5d:56:49:9b:e4:d2:e0:8b:cf:ca:d0:8a:3e:38:72:3d:50:50:3b:de:70:69:48:e4:2f:55:60:30:19:e5:28:ae +-----BEGIN CERTIFICATE----- +MIIFYDCCA0igAwIBAgIQCgFCgAAAAUUjyES1AAAAAjANBgkqhkiG9w0BAQsFADBK +MQswCQYDVQQGEwJVUzESMBAGA1UEChMJSWRlblRydXN0MScwJQYDVQQDEx5JZGVu +VHJ1c3QgQ29tbWVyY2lhbCBSb290IENBIDEwHhcNMTQwMTE2MTgxMjIzWhcNMzQw +MTE2MTgxMjIzWjBKMQswCQYDVQQGEwJVUzESMBAGA1UEChMJSWRlblRydXN0MScw +JQYDVQQDEx5JZGVuVHJ1c3QgQ29tbWVyY2lhbCBSb290IENBIDEwggIiMA0GCSqG +SIb3DQEBAQUAA4ICDwAwggIKAoICAQCnUBneP5k91DNG8W9RYYKyqU+PZ4ldhNlT +3Qwo2dfw/66VQ3KZ+bVdfIrBQuExUHTRgQ18zZshq0PirK1ehm7zCYofWjK9ouuU ++ehcCuz/mNKvcbO0U59Oh++SvL3sTzIwiEsXXlfEU8L2ApeN2WIrvyQfYo3fw7gp +S0l4PJNgiCL8mdo2yMKi1CxUAGc1bnO/AljwpN3lsKImesrgNqUZFvX9t++uP0D1 +bVoE/c40yiTcdCMbXTMTEl3EASX2MN0CXZ/g1Ue9tOsbobtJSdifWwLziuQkkORi +T0/Br4sOdBeo0XKIanoBScy0RnnGF7HamB4HWfp1IYVl3ZBWzvurpWCdxJ35UrCL +vYf5jysjCiN2O/cz4ckA82n5S6LgTrx+kzmEB/dEcH7+B1rlsazRGMzyNeVJSQjK +Vsk9+w8YfYs7wRPCTY/JTw436R+hDmrfYi7LNQZReSzIJTj0+kuniVyc0uMNOYZK +dHzVWYfCP04MXFL0PfdSgvHqo6z9STQaKPNBiDoT7uje/5kdX7rL6B7yuVBgwDHT +c+XvvqDtMwt0viAgxGds8AgDelWAf0ZOlqf0Hj7h9tgJ4TNkK2PXMl6f+cB7D3hv +l7yTmvmcEpB4eoCHFddydJxVdHixuuFucAS6T6C6aMN7/zHwcz09lCqxC0EOoP5N +iGVreTO01wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB +/zAdBgNVHQ4EFgQU7UQZwNPwBovupHu+QucmVMiONnYwDQYJKoZIhvcNAQELBQAD +ggIBAA2ukDL2pkt8RHYZYR4nKM1eVO8lvOMIkPkp165oCOGUAFjvLi5+U1KMtlwH +6oi6mYtQlNeCgN9hCQCTrQ0U5s7B8jeUeLBfnLOic7iPBZM4zY0+sLj7wM+x8uwt +LRvM7Kqas6pgghstO8OEPVeKlh6cdbjTMM1gCIOQ045U8U1mwF10A0Cj7oV+wh93 +nAbowacYXVKV7cndJZ5t+qntozo00Fl72u1Q8zW/7esUTTHHYPTa8Yec4kjixsU3 ++wYQ+nVZZjFHKdp2mhzpgq7vmrlR94gjmmmVYjzlVYA211QC//G5Xc7UI2/YRYRK +W2XviQzdFKcgyxilJbQN+QHwotL0AMh0jqEqSI5l2xPE4iUXfeu+h1sXIFRRk0pT +AwvsXcoz7WL9RccvW9xYoIA55vrX/hMUpu09lEpCdNTDd1lzzY9GvlU47/rokTLq +l1gEIt44w8y8bckzOmoKaT+gyOpyj4xjhiO9bTyWnpXgSUyqorkqG5w2gXjtw+hG +4iZZRHUe2XWJUc0QhJ1hYMtd+ZciTY6Y5uN/9lu7rs3KSoFrXgvzUeF0K+l+J6fZ +mUlO+KWA2yUPHGNiiskzZ2s8EIPGrd6ozRaOjfAHN3Gf8qv8QfXBi+wAN10J5U6A +7/qxXDgGpRtK4dw4LTzcqx+QGtVKnO7RcGzM7vRX+Bi6hG6H +-----END CERTIFICATE----- + +# Issuer: CN=IdenTrust Public Sector Root CA 1 O=IdenTrust +# Subject: CN=IdenTrust Public Sector Root CA 1 O=IdenTrust +# Label: "IdenTrust Public Sector Root CA 1" +# Serial: 13298821034946342390521976156843933698 +# MD5 Fingerprint: 37:06:a5:b0:fc:89:9d:ba:f4:6b:8c:1a:64:cd:d5:ba +# SHA1 Fingerprint: ba:29:41:60:77:98:3f:f4:f3:ef:f2:31:05:3b:2e:ea:6d:4d:45:fd +# SHA256 Fingerprint: 30:d0:89:5a:9a:44:8a:26:20:91:63:55:22:d1:f5:20:10:b5:86:7a:ca:e1:2c:78:ef:95:8f:d4:f4:38:9f:2f +-----BEGIN CERTIFICATE----- +MIIFZjCCA06gAwIBAgIQCgFCgAAAAUUjz0Z8AAAAAjANBgkqhkiG9w0BAQsFADBN +MQswCQYDVQQGEwJVUzESMBAGA1UEChMJSWRlblRydXN0MSowKAYDVQQDEyFJZGVu +VHJ1c3QgUHVibGljIFNlY3RvciBSb290IENBIDEwHhcNMTQwMTE2MTc1MzMyWhcN +MzQwMTE2MTc1MzMyWjBNMQswCQYDVQQGEwJVUzESMBAGA1UEChMJSWRlblRydXN0 +MSowKAYDVQQDEyFJZGVuVHJ1c3QgUHVibGljIFNlY3RvciBSb290IENBIDEwggIi +MA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC2IpT8pEiv6EdrCvsnduTyP4o7 +ekosMSqMjbCpwzFrqHd2hCa2rIFCDQjrVVi7evi8ZX3yoG2LqEfpYnYeEe4IFNGy +RBb06tD6Hi9e28tzQa68ALBKK0CyrOE7S8ItneShm+waOh7wCLPQ5CQ1B5+ctMlS +bdsHyo+1W/CD80/HLaXIrcuVIKQxKFdYWuSNG5qrng0M8gozOSI5Cpcu81N3uURF +/YTLNiCBWS2ab21ISGHKTN9T0a9SvESfqy9rg3LvdYDaBjMbXcjaY8ZNzaxmMc3R +3j6HEDbhuaR672BQssvKplbgN6+rNBM5Jeg5ZuSYeqoSmJxZZoY+rfGwyj4GD3vw +EUs3oERte8uojHH01bWRNszwFcYr3lEXsZdMUD2xlVl8BX0tIdUAvwFnol57plzy +9yLxkA2T26pEUWbMfXYD62qoKjgZl3YNa4ph+bz27nb9cCvdKTz4Ch5bQhyLVi9V +GxyhLrXHFub4qjySjmm2AcG1hp2JDws4lFTo6tyePSW8Uybt1as5qsVATFSrsrTZ +2fjXctscvG29ZV/viDUqZi/u9rNl8DONfJhBaUYPQxxp+pu10GFqzcpL2UyQRqsV +WaFHVCkugyhfHMKiq3IXAAaOReyL4jM9f9oZRORicsPfIsbyVtTdX5Vy7W1f90gD +W/3FKqD2cyOEEBsB5wIDAQABo0IwQDAOBgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/ +BAUwAwEB/zAdBgNVHQ4EFgQU43HgntinQtnbcZFrlJPrw6PRFKMwDQYJKoZIhvcN +AQELBQADggIBAEf63QqwEZE4rU1d9+UOl1QZgkiHVIyqZJnYWv6IAcVYpZmxI1Qj +t2odIFflAWJBF9MJ23XLblSQdf4an4EKwt3X9wnQW3IV5B4Jaj0z8yGa5hV+rVHV +DRDtfULAj+7AmgjVQdZcDiFpboBhDhXAuM/FSRJSzL46zNQuOAXeNf0fb7iAaJg9 +TaDKQGXSc3z1i9kKlT/YPyNtGtEqJBnZhbMX73huqVjRI9PHE+1yJX9dsXNw0H8G +lwmEKYBhHfpe/3OsoOOJuBxxFcbeMX8S3OFtm6/n6J91eEyrRjuazr8FGF1NFTwW +mhlQBJqymm9li1JfPFgEKCXAZmExfrngdbkaqIHWchezxQMxNRF4eKLg6TCMf4Df +WN88uieW4oA0beOY02QnrEh+KHdcxiVhJfiFDGX6xDIvpZgF5PgLZxYWxoK4Mhn5 ++bl53B/N66+rDt0b20XkeucC4pVd/GnwU2lhlXV5C15V5jgclKlZM57IcXR5f1GJ +tshquDDIajjDbp7hNxbqBWJMWxJH7ae0s1hWx0nzfxJoCTFx8G34Tkf71oXuxVhA +GaQdp/lLQzfcaFpPz+vCZHTetBXZ9FRUGi8c15dxVJCO2SCdUyt/q4/i6jC8UDfv +8Ue1fXwsBOxonbRJRBD0ckscZOf85muQ3Wl9af0AVqW3rLatt8o+Ae+c +-----END CERTIFICATE----- + +# Issuer: CN=Entrust Root Certification Authority - G2 O=Entrust, Inc. OU=See www.entrust.net/legal-terms/(c) 2009 Entrust, Inc. - for authorized use only +# Subject: CN=Entrust Root Certification Authority - G2 O=Entrust, Inc. OU=See www.entrust.net/legal-terms/(c) 2009 Entrust, Inc. - for authorized use only +# Label: "Entrust Root Certification Authority - G2" +# Serial: 1246989352 +# MD5 Fingerprint: 4b:e2:c9:91:96:65:0c:f4:0e:5a:93:92:a0:0a:fe:b2 +# SHA1 Fingerprint: 8c:f4:27:fd:79:0c:3a:d1:66:06:8d:e8:1e:57:ef:bb:93:22:72:d4 +# SHA256 Fingerprint: 43:df:57:74:b0:3e:7f:ef:5f:e4:0d:93:1a:7b:ed:f1:bb:2e:6b:42:73:8c:4e:6d:38:41:10:3d:3a:a7:f3:39 +-----BEGIN CERTIFICATE----- +MIIEPjCCAyagAwIBAgIESlOMKDANBgkqhkiG9w0BAQsFADCBvjELMAkGA1UEBhMC +VVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xKDAmBgNVBAsTH1NlZSB3d3cuZW50 +cnVzdC5uZXQvbGVnYWwtdGVybXMxOTA3BgNVBAsTMChjKSAyMDA5IEVudHJ1c3Qs +IEluYy4gLSBmb3IgYXV0aG9yaXplZCB1c2Ugb25seTEyMDAGA1UEAxMpRW50cnVz +dCBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IC0gRzIwHhcNMDkwNzA3MTcy +NTU0WhcNMzAxMjA3MTc1NTU0WjCBvjELMAkGA1UEBhMCVVMxFjAUBgNVBAoTDUVu +dHJ1c3QsIEluYy4xKDAmBgNVBAsTH1NlZSB3d3cuZW50cnVzdC5uZXQvbGVnYWwt +dGVybXMxOTA3BgNVBAsTMChjKSAyMDA5IEVudHJ1c3QsIEluYy4gLSBmb3IgYXV0 +aG9yaXplZCB1c2Ugb25seTEyMDAGA1UEAxMpRW50cnVzdCBSb290IENlcnRpZmlj +YXRpb24gQXV0aG9yaXR5IC0gRzIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEK +AoIBAQC6hLZy254Ma+KZ6TABp3bqMriVQRrJ2mFOWHLP/vaCeb9zYQYKpSfYs1/T +RU4cctZOMvJyig/3gxnQaoCAAEUesMfnmr8SVycco2gvCoe9amsOXmXzHHfV1IWN +cCG0szLni6LVhjkCsbjSR87kyUnEO6fe+1R9V77w6G7CebI6C1XiUJgWMhNcL3hW +wcKUs/Ja5CeanyTXxuzQmyWC48zCxEXFjJd6BmsqEZ+pCm5IO2/b1BEZQvePB7/1 +U1+cPvQXLOZprE4yTGJ36rfo5bs0vBmLrpxR57d+tVOxMyLlbc9wPBr64ptntoP0 +jaWvYkxN4FisZDQSA/i2jZRjJKRxAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAP +BgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRqciZ60B7vfec7aVHUbI2fkBJmqzAN +BgkqhkiG9w0BAQsFAAOCAQEAeZ8dlsa2eT8ijYfThwMEYGprmi5ZiXMRrEPR9RP/ +jTkrwPK9T3CMqS/qF8QLVJ7UG5aYMzyorWKiAHarWWluBh1+xLlEjZivEtRh2woZ +Rkfz6/djwUAFQKXSt/S1mja/qYh2iARVBCuch38aNzx+LaUa2NSJXsq9rD1s2G2v +1fN2D807iDginWyTmsQ9v4IbZT+mD12q/OWyFcq1rca8PdCE6OoGcrBNOTJ4vz4R +nAuknZoh8/CbCzB428Hch0P+vGOaysXCHMnHjf87ElgI5rY97HosTvuDls4MPGmH +VHOkc8KT/1EQrBVUAdj8BbGJoX90g5pJ19xOe4pIb4tF9g== +-----END CERTIFICATE----- + +# Issuer: CN=Entrust Root Certification Authority - EC1 O=Entrust, Inc. OU=See www.entrust.net/legal-terms/(c) 2012 Entrust, Inc. - for authorized use only +# Subject: CN=Entrust Root Certification Authority - EC1 O=Entrust, Inc. OU=See www.entrust.net/legal-terms/(c) 2012 Entrust, Inc. - for authorized use only +# Label: "Entrust Root Certification Authority - EC1" +# Serial: 51543124481930649114116133369 +# MD5 Fingerprint: b6:7e:1d:f0:58:c5:49:6c:24:3b:3d:ed:98:18:ed:bc +# SHA1 Fingerprint: 20:d8:06:40:df:9b:25:f5:12:25:3a:11:ea:f7:59:8a:eb:14:b5:47 +# SHA256 Fingerprint: 02:ed:0e:b2:8c:14:da:45:16:5c:56:67:91:70:0d:64:51:d7:fb:56:f0:b2:ab:1d:3b:8e:b0:70:e5:6e:df:f5 +-----BEGIN CERTIFICATE----- +MIIC+TCCAoCgAwIBAgINAKaLeSkAAAAAUNCR+TAKBggqhkjOPQQDAzCBvzELMAkG +A1UEBhMCVVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xKDAmBgNVBAsTH1NlZSB3 +d3cuZW50cnVzdC5uZXQvbGVnYWwtdGVybXMxOTA3BgNVBAsTMChjKSAyMDEyIEVu +dHJ1c3QsIEluYy4gLSBmb3IgYXV0aG9yaXplZCB1c2Ugb25seTEzMDEGA1UEAxMq +RW50cnVzdCBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IC0gRUMxMB4XDTEy +MTIxODE1MjUzNloXDTM3MTIxODE1NTUzNlowgb8xCzAJBgNVBAYTAlVTMRYwFAYD +VQQKEw1FbnRydXN0LCBJbmMuMSgwJgYDVQQLEx9TZWUgd3d3LmVudHJ1c3QubmV0 +L2xlZ2FsLXRlcm1zMTkwNwYDVQQLEzAoYykgMjAxMiBFbnRydXN0LCBJbmMuIC0g +Zm9yIGF1dGhvcml6ZWQgdXNlIG9ubHkxMzAxBgNVBAMTKkVudHJ1c3QgUm9vdCBD +ZXJ0aWZpY2F0aW9uIEF1dGhvcml0eSAtIEVDMTB2MBAGByqGSM49AgEGBSuBBAAi +A2IABIQTydC6bUF74mzQ61VfZgIaJPRbiWlH47jCffHyAsWfoPZb1YsGGYZPUxBt +ByQnoaD41UcZYUx9ypMn6nQM72+WCf5j7HBdNq1nd67JnXxVRDqiY1Ef9eNi1KlH +Bz7MIKNCMEAwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0O +BBYEFLdj5xrdjekIplWDpOBqUEFlEUJJMAoGCCqGSM49BAMDA2cAMGQCMGF52OVC +R98crlOZF7ZvHH3hvxGU0QOIdeSNiaSKd0bebWHvAvX7td/M/k7//qnmpwIwW5nX +hTcGtXsI/esni0qU+eH6p44mCOh8kmhtc9hvJqwhAriZtyZBWyVgrtBIGu4G +-----END CERTIFICATE----- + +# Issuer: CN=CFCA EV ROOT O=China Financial Certification Authority +# Subject: CN=CFCA EV ROOT O=China Financial Certification Authority +# Label: "CFCA EV ROOT" +# Serial: 407555286 +# MD5 Fingerprint: 74:e1:b6:ed:26:7a:7a:44:30:33:94:ab:7b:27:81:30 +# SHA1 Fingerprint: e2:b8:29:4b:55:84:ab:6b:58:c2:90:46:6c:ac:3f:b8:39:8f:84:83 +# SHA256 Fingerprint: 5c:c3:d7:8e:4e:1d:5e:45:54:7a:04:e6:87:3e:64:f9:0c:f9:53:6d:1c:cc:2e:f8:00:f3:55:c4:c5:fd:70:fd +-----BEGIN CERTIFICATE----- +MIIFjTCCA3WgAwIBAgIEGErM1jANBgkqhkiG9w0BAQsFADBWMQswCQYDVQQGEwJD +TjEwMC4GA1UECgwnQ2hpbmEgRmluYW5jaWFsIENlcnRpZmljYXRpb24gQXV0aG9y +aXR5MRUwEwYDVQQDDAxDRkNBIEVWIFJPT1QwHhcNMTIwODA4MDMwNzAxWhcNMjkx +MjMxMDMwNzAxWjBWMQswCQYDVQQGEwJDTjEwMC4GA1UECgwnQ2hpbmEgRmluYW5j +aWFsIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MRUwEwYDVQQDDAxDRkNBIEVWIFJP +T1QwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDXXWvNED8fBVnVBU03 +sQ7smCuOFR36k0sXgiFxEFLXUWRwFsJVaU2OFW2fvwwbwuCjZ9YMrM8irq93VCpL +TIpTUnrD7i7es3ElweldPe6hL6P3KjzJIx1qqx2hp/Hz7KDVRM8Vz3IvHWOX6Jn5 +/ZOkVIBMUtRSqy5J35DNuF++P96hyk0g1CXohClTt7GIH//62pCfCqktQT+x8Rgp +7hZZLDRJGqgG16iI0gNyejLi6mhNbiyWZXvKWfry4t3uMCz7zEasxGPrb382KzRz +EpR/38wmnvFyXVBlWY9ps4deMm/DGIq1lY+wejfeWkU7xzbh72fROdOXW3NiGUgt +hxwG+3SYIElz8AXSG7Ggo7cbcNOIabla1jj0Ytwli3i/+Oh+uFzJlU9fpy25IGvP +a931DfSCt/SyZi4QKPaXWnuWFo8BGS1sbn85WAZkgwGDg8NNkt0yxoekN+kWzqot +aK8KgWU6cMGbrU1tVMoqLUuFG7OA5nBFDWteNfB/O7ic5ARwiRIlk9oKmSJgamNg +TnYGmE69g60dWIolhdLHZR4tjsbftsbhf4oEIRUpdPA+nJCdDC7xij5aqgwJHsfV +PKPtl8MeNPo4+QgO48BdK4PRVmrJtqhUUy54Mmc9gn900PvhtgVguXDbjgv5E1hv +cWAQUhC5wUEJ73IfZzF4/5YFjQIDAQABo2MwYTAfBgNVHSMEGDAWgBTj/i39KNAL +tbq2osS/BqoFjJP7LzAPBgNVHRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAd +BgNVHQ4EFgQU4/4t/SjQC7W6tqLEvwaqBYyT+y8wDQYJKoZIhvcNAQELBQADggIB +ACXGumvrh8vegjmWPfBEp2uEcwPenStPuiB/vHiyz5ewG5zz13ku9Ui20vsXiObT +ej/tUxPQ4i9qecsAIyjmHjdXNYmEwnZPNDatZ8POQQaIxffu2Bq41gt/UP+TqhdL +jOztUmCypAbqTuv0axn96/Ua4CUqmtzHQTb3yHQFhDmVOdYLO6Qn+gjYXB74BGBS +ESgoA//vU2YApUo0FmZ8/Qmkrp5nGm9BC2sGE5uPhnEFtC+NiWYzKXZUmhH4J/qy +P5Hgzg0b8zAarb8iXRvTvyUFTeGSGn+ZnzxEk8rUQElsgIfXBDrDMlI1Dlb4pd19 +xIsNER9Tyx6yF7Zod1rg1MvIB671Oi6ON7fQAUtDKXeMOZePglr4UeWJoBjnaH9d +Ci77o0cOPaYjesYBx4/IXr9tgFa+iiS6M+qf4TIRnvHST4D2G0CvOJ4RUHlzEhLN +5mydLIhyPDCBBpEi6lmt2hkuIsKNuYyH4Ga8cyNfIWRjgEj1oDwYPZTISEEdQLpe +/v5WOaHIz16eGWRGENoXkbcFgKyLmZJ956LYBws2J+dIeWCKw9cTXPhyQN9Ky8+Z +AAoACxGV2lZFA4gKn2fQ1XmxqI1AbQ3CekD6819kR5LLU7m7Wc5P/dAVUwHY3+vZ +5nbv0CO7O6l5s9UCKc2Jo5YPSjXnTkLAdc0Hz+Ys63su +-----END CERTIFICATE----- + +# Issuer: CN=T\xdcRKTRUST Elektronik Sertifika Hizmet Sa\u011flay\u0131c\u0131s\u0131 H5 O=T\xdcRKTRUST Bilgi \u0130leti\u015fim ve Bili\u015fim G\xfcvenli\u011fi Hizmetleri A.\u015e. +# Subject: CN=T\xdcRKTRUST Elektronik Sertifika Hizmet Sa\u011flay\u0131c\u0131s\u0131 H5 O=T\xdcRKTRUST Bilgi \u0130leti\u015fim ve Bili\u015fim G\xfcvenli\u011fi Hizmetleri A.\u015e. +# Label: "T\xdcRKTRUST Elektronik Sertifika Hizmet Sa\u011flay\u0131c\u0131s\u0131 H5" +# Serial: 156233699172481 +# MD5 Fingerprint: da:70:8e:f0:22:df:93:26:f6:5f:9f:d3:15:06:52:4e +# SHA1 Fingerprint: c4:18:f6:4d:46:d1:df:00:3d:27:30:13:72:43:a9:12:11:c6:75:fb +# SHA256 Fingerprint: 49:35:1b:90:34:44:c1:85:cc:dc:5c:69:3d:24:d8:55:5c:b2:08:d6:a8:14:13:07:69:9f:4a:f0:63:19:9d:78 +-----BEGIN CERTIFICATE----- +MIIEJzCCAw+gAwIBAgIHAI4X/iQggTANBgkqhkiG9w0BAQsFADCBsTELMAkGA1UE +BhMCVFIxDzANBgNVBAcMBkFua2FyYTFNMEsGA1UECgxEVMOcUktUUlVTVCBCaWxn +aSDEsGxldGnFn2ltIHZlIEJpbGnFn2ltIEfDvHZlbmxpxJ9pIEhpem1ldGxlcmkg +QS7Fni4xQjBABgNVBAMMOVTDnFJLVFJVU1QgRWxla3Ryb25payBTZXJ0aWZpa2Eg +SGl6bWV0IFNhxJ9sYXnEsWPEsXPEsSBINTAeFw0xMzA0MzAwODA3MDFaFw0yMzA0 +MjgwODA3MDFaMIGxMQswCQYDVQQGEwJUUjEPMA0GA1UEBwwGQW5rYXJhMU0wSwYD +VQQKDERUw5xSS1RSVVNUIEJpbGdpIMSwbGV0acWfaW0gdmUgQmlsacWfaW0gR8O8 +dmVubGnEn2kgSGl6bWV0bGVyaSBBLsWeLjFCMEAGA1UEAww5VMOcUktUUlVTVCBF +bGVrdHJvbmlrIFNlcnRpZmlrYSBIaXptZXQgU2HEn2xhecSxY8Sxc8SxIEg1MIIB +IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApCUZ4WWe60ghUEoI5RHwWrom +/4NZzkQqL/7hzmAD/I0Dpe3/a6i6zDQGn1k19uwsu537jVJp45wnEFPzpALFp/kR +Gml1bsMdi9GYjZOHp3GXDSHHmflS0yxjXVW86B8BSLlg/kJK9siArs1mep5Fimh3 +4khon6La8eHBEJ/rPCmBp+EyCNSgBbGM+42WAA4+Jd9ThiI7/PS98wl+d+yG6w8z +5UNP9FR1bSmZLmZaQ9/LXMrI5Tjxfjs1nQ/0xVqhzPMggCTTV+wVunUlm+hkS7M0 +hO8EuPbJbKoCPrZV4jI3X/xml1/N1p7HIL9Nxqw/dV8c7TKcfGkAaZHjIxhT6QID +AQABo0IwQDAdBgNVHQ4EFgQUVpkHHtOsDGlktAxQR95DLL4gwPswDgYDVR0PAQH/ +BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggEBAJ5FdnsX +SDLyOIspve6WSk6BGLFRRyDN0GSxDsnZAdkJzsiZ3GglE9Rc8qPoBP5yCccLqh0l +VX6Wmle3usURehnmp349hQ71+S4pL+f5bFgWV1Al9j4uPqrtd3GqqpmWRgqujuwq +URawXs3qZwQcWDD1YIq9pr1N5Za0/EKJAWv2cMhQOQwt1WbZyNKzMrcbGW3LM/nf +peYVhDfwwvJllpKQd/Ct9JDpEXjXk4nAPQu6KfTomZ1yju2dL+6SfaHx/126M2CF +Yv4HAqGEVka+lgqaE9chTLd8B59OTj+RdPsnnRHM3eaxynFNExc5JsUpISuTKWqW ++qtB4Uu2NQvAmxU= +-----END CERTIFICATE----- + +# Issuer: CN=Certinomis - Root CA O=Certinomis OU=0002 433998903 +# Subject: CN=Certinomis - Root CA O=Certinomis OU=0002 433998903 +# Label: "Certinomis - Root CA" +# Serial: 1 +# MD5 Fingerprint: 14:0a:fd:8d:a8:28:b5:38:69:db:56:7e:61:22:03:3f +# SHA1 Fingerprint: 9d:70:bb:01:a5:a4:a0:18:11:2e:f7:1c:01:b9:32:c5:34:e7:88:a8 +# SHA256 Fingerprint: 2a:99:f5:bc:11:74:b7:3c:bb:1d:62:08:84:e0:1c:34:e5:1c:cb:39:78:da:12:5f:0e:33:26:88:83:bf:41:58 +-----BEGIN CERTIFICATE----- +MIIFkjCCA3qgAwIBAgIBATANBgkqhkiG9w0BAQsFADBaMQswCQYDVQQGEwJGUjET +MBEGA1UEChMKQ2VydGlub21pczEXMBUGA1UECxMOMDAwMiA0MzM5OTg5MDMxHTAb +BgNVBAMTFENlcnRpbm9taXMgLSBSb290IENBMB4XDTEzMTAyMTA5MTcxOFoXDTMz +MTAyMTA5MTcxOFowWjELMAkGA1UEBhMCRlIxEzARBgNVBAoTCkNlcnRpbm9taXMx +FzAVBgNVBAsTDjAwMDIgNDMzOTk4OTAzMR0wGwYDVQQDExRDZXJ0aW5vbWlzIC0g +Um9vdCBDQTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBANTMCQosP5L2 +fxSeC5yaah1AMGT9qt8OHgZbn1CF6s2Nq0Nn3rD6foCWnoR4kkjW4znuzuRZWJfl +LieY6pOod5tK8O90gC3rMB+12ceAnGInkYjwSond3IjmFPnVAy//ldu9n+ws+hQV +WZUKxkd8aRi5pwP5ynapz8dvtF4F/u7BUrJ1Mofs7SlmO/NKFoL21prbcpjp3vDF +TKWrteoB4owuZH9kb/2jJZOLyKIOSY008B/sWEUuNKqEUL3nskoTuLAPrjhdsKkb +5nPJWqHZZkCqqU2mNAKthH6yI8H7KsZn9DS2sJVqM09xRLWtwHkziOC/7aOgFLSc +CbAK42C++PhmiM1b8XcF4LVzbsF9Ri6OSyemzTUK/eVNfaoqoynHWmgE6OXWk6Ri +wsXm9E/G+Z8ajYJJGYrKWUM66A0ywfRMEwNvbqY/kXPLynNvEiCL7sCCeN5LLsJJ +wx3tFvYk9CcbXFcx3FXuqB5vbKziRcxXV4p1VxngtViZSTYxPDMBbRZKzbgqg4SG +m/lg0h9tkQPTYKbVPZrdd5A9NaSfD171UkRpucC63M9933zZxKyGIjK8e2uR73r4 +F2iw4lNVYC2vPsKD2NkJK/DAZNuHi5HMkesE/Xa0lZrmFAYb1TQdvtj/dBxThZng +WVJKYe2InmtJiUZ+IFrZ50rlau7SZRFDAgMBAAGjYzBhMA4GA1UdDwEB/wQEAwIB +BjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTvkUz1pcMw6C8I6tNxIqSSaHh0 +2TAfBgNVHSMEGDAWgBTvkUz1pcMw6C8I6tNxIqSSaHh02TANBgkqhkiG9w0BAQsF +AAOCAgEAfj1U2iJdGlg+O1QnurrMyOMaauo++RLrVl89UM7g6kgmJs95Vn6RHJk/ +0KGRHCwPT5iVWVO90CLYiF2cN/z7ZMF4jIuaYAnq1fohX9B0ZedQxb8uuQsLrbWw +F6YSjNRieOpWauwK0kDDPAUwPk2Ut59KA9N9J0u2/kTO+hkzGm2kQtHdzMjI1xZS +g081lLMSVX3l4kLr5JyTCcBMWwerx20RoFAXlCOotQqSD7J6wWAsOMwaplv/8gzj +qh8c3LigkyfeY+N/IZ865Z764BNqdeuWXGKRlI5nU7aJ+BIJy29SWwNyhlCVCNSN +h4YVH5Uk2KRvms6knZtt0rJ2BobGVgjF6wnaNsIbW0G+YSrjcOa4pvi2WsS9Iff/ +ql+hbHY5ZtbqTFXhADObE5hjyW/QASAJN1LnDE8+zbz1X5YnpyACleAu6AdBBR8V +btaw5BngDwKTACdyxYvRVB9dSsNAl35VpnzBMwQUAR1JIGkLGZOdblgi90AMRgwj +Y/M50n92Uaf0yKHxDHYiI0ZSKS3io0EHVmmY0gUJvGnHWmHNj4FgFU2A3ZDifcRQ +8ow7bkrHxuaAKzyBvBGAFhAn1/DNP3nMcyrDflOR1m749fPH0FFNjkulW+YZFzvW +gQncItzujrnEj1PhZ7szuIgVRs/taTX/dQ1G885x4cVrhkIGuUE= +-----END CERTIFICATE----- + +# Issuer: CN=OISTE WISeKey Global Root GB CA O=WISeKey OU=OISTE Foundation Endorsed +# Subject: CN=OISTE WISeKey Global Root GB CA O=WISeKey OU=OISTE Foundation Endorsed +# Label: "OISTE WISeKey Global Root GB CA" +# Serial: 157768595616588414422159278966750757568 +# MD5 Fingerprint: a4:eb:b9:61:28:2e:b7:2f:98:b0:35:26:90:99:51:1d +# SHA1 Fingerprint: 0f:f9:40:76:18:d3:d7:6a:4b:98:f0:a8:35:9e:0c:fd:27:ac:cc:ed +# SHA256 Fingerprint: 6b:9c:08:e8:6e:b0:f7:67:cf:ad:65:cd:98:b6:21:49:e5:49:4a:67:f5:84:5e:7b:d1:ed:01:9f:27:b8:6b:d6 +-----BEGIN CERTIFICATE----- +MIIDtTCCAp2gAwIBAgIQdrEgUnTwhYdGs/gjGvbCwDANBgkqhkiG9w0BAQsFADBt +MQswCQYDVQQGEwJDSDEQMA4GA1UEChMHV0lTZUtleTEiMCAGA1UECxMZT0lTVEUg +Rm91bmRhdGlvbiBFbmRvcnNlZDEoMCYGA1UEAxMfT0lTVEUgV0lTZUtleSBHbG9i +YWwgUm9vdCBHQiBDQTAeFw0xNDEyMDExNTAwMzJaFw0zOTEyMDExNTEwMzFaMG0x +CzAJBgNVBAYTAkNIMRAwDgYDVQQKEwdXSVNlS2V5MSIwIAYDVQQLExlPSVNURSBG +b3VuZGF0aW9uIEVuZG9yc2VkMSgwJgYDVQQDEx9PSVNURSBXSVNlS2V5IEdsb2Jh +bCBSb290IEdCIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2Be3 +HEokKtaXscriHvt9OO+Y9bI5mE4nuBFde9IllIiCFSZqGzG7qFshISvYD06fWvGx +WuR51jIjK+FTzJlFXHtPrby/h0oLS5daqPZI7H17Dc0hBt+eFf1Biki3IPShehtX +1F1Q/7pn2COZH8g/497/b1t3sWtuuMlk9+HKQUYOKXHQuSP8yYFfTvdv37+ErXNk +u7dCjmn21HYdfp2nuFeKUWdy19SouJVUQHMD9ur06/4oQnc/nSMbsrY9gBQHTC5P +99UKFg29ZkM3fiNDecNAhvVMKdqOmq0NpQSHiB6F4+lT1ZvIiwNjeOvgGUpuuy9r +M2RYk61pv48b74JIxwIDAQABo1EwTzALBgNVHQ8EBAMCAYYwDwYDVR0TAQH/BAUw +AwEB/zAdBgNVHQ4EFgQUNQ/INmNe4qPs+TtmFc5RUuORmj0wEAYJKwYBBAGCNxUB +BAMCAQAwDQYJKoZIhvcNAQELBQADggEBAEBM+4eymYGQfp3FsLAmzYh7KzKNbrgh +cViXfa43FK8+5/ea4n32cZiZBKpDdHij40lhPnOMTZTg+XHEthYOU3gf1qKHLwI5 +gSk8rxWYITD+KJAAjNHhy/peyP34EEY7onhCkRd0VQreUGdNZtGn//3ZwLWoo4rO +ZvUPQ82nK1d7Y0Zqqi5S2PTt4W2tKZB4SLrhI6qjiey1q5bAtEuiHZeeevJuQHHf +aPFlTc58Bd9TZaml8LGXBHAVRgOY1NK/VLSgWH1Sb9pWJmLU2NuJMW8c8CLC02Ic +Nc1MaRVUGpCY3useX8p3x8uOPUNpnJpY0CQ73xtAln41rYHHTnG6iBM= +-----END CERTIFICATE----- + +# Issuer: CN=SZAFIR ROOT CA2 O=Krajowa Izba Rozliczeniowa S.A. +# Subject: CN=SZAFIR ROOT CA2 O=Krajowa Izba Rozliczeniowa S.A. +# Label: "SZAFIR ROOT CA2" +# Serial: 357043034767186914217277344587386743377558296292 +# MD5 Fingerprint: 11:64:c1:89:b0:24:b1:8c:b1:07:7e:89:9e:51:9e:99 +# SHA1 Fingerprint: e2:52:fa:95:3f:ed:db:24:60:bd:6e:28:f3:9c:cc:cf:5e:b3:3f:de +# SHA256 Fingerprint: a1:33:9d:33:28:1a:0b:56:e5:57:d3:d3:2b:1c:e7:f9:36:7e:b0:94:bd:5f:a7:2a:7e:50:04:c8:de:d7:ca:fe +-----BEGIN CERTIFICATE----- +MIIDcjCCAlqgAwIBAgIUPopdB+xV0jLVt+O2XwHrLdzk1uQwDQYJKoZIhvcNAQEL +BQAwUTELMAkGA1UEBhMCUEwxKDAmBgNVBAoMH0tyYWpvd2EgSXpiYSBSb3psaWN6 +ZW5pb3dhIFMuQS4xGDAWBgNVBAMMD1NaQUZJUiBST09UIENBMjAeFw0xNTEwMTkw +NzQzMzBaFw0zNTEwMTkwNzQzMzBaMFExCzAJBgNVBAYTAlBMMSgwJgYDVQQKDB9L +cmFqb3dhIEl6YmEgUm96bGljemVuaW93YSBTLkEuMRgwFgYDVQQDDA9TWkFGSVIg +Uk9PVCBDQTIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC3vD5QqEvN +QLXOYeeWyrSh2gwisPq1e3YAd4wLz32ohswmUeQgPYUM1ljj5/QqGJ3a0a4m7utT +3PSQ1hNKDJA8w/Ta0o4NkjrcsbH/ON7Dui1fgLkCvUqdGw+0w8LBZwPd3BucPbOw +3gAeqDRHu5rr/gsUvTaE2g0gv/pby6kWIK05YO4vdbbnl5z5Pv1+TW9NL++IDWr6 +3fE9biCloBK0TXC5ztdyO4mTp4CEHCdJckm1/zuVnsHMyAHs6A6KCpbns6aH5db5 +BSsNl0BwPLqsdVqc1U2dAgrSS5tmS0YHF2Wtn2yIANwiieDhZNRnvDF5YTy7ykHN +XGoAyDw4jlivAgMBAAGjQjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQD +AgEGMB0GA1UdDgQWBBQuFqlKGLXLzPVvUPMjX/hd56zwyDANBgkqhkiG9w0BAQsF +AAOCAQEAtXP4A9xZWx126aMqe5Aosk3AM0+qmrHUuOQn/6mWmc5G4G18TKI4pAZw +8PRBEew/R40/cof5O/2kbytTAOD/OblqBw7rHRz2onKQy4I9EYKL0rufKq8h5mOG +nXkZ7/e7DDWQw4rtTw/1zBLZpD67oPwglV9PJi8RI4NOdQcPv5vRtB3pEAT+ymCP +oky4rc/hkA/NrgrHXXu3UNLUYfrVFdvXn4dRVOul4+vJhaAlIDf7js4MNIThPIGy +d05DpYhfhmehPea0XGG2Ptv+tyjFogeutcrKjSoS75ftwjCkySp6+/NNIxuZMzSg +LvWpCz/UXeHPhJ/iGcJfitYgHuNztw== +-----END CERTIFICATE----- + +# Issuer: CN=Certum Trusted Network CA 2 O=Unizeto Technologies S.A. OU=Certum Certification Authority +# Subject: CN=Certum Trusted Network CA 2 O=Unizeto Technologies S.A. OU=Certum Certification Authority +# Label: "Certum Trusted Network CA 2" +# Serial: 44979900017204383099463764357512596969 +# MD5 Fingerprint: 6d:46:9e:d9:25:6d:08:23:5b:5e:74:7d:1e:27:db:f2 +# SHA1 Fingerprint: d3:dd:48:3e:2b:bf:4c:05:e8:af:10:f5:fa:76:26:cf:d3:dc:30:92 +# SHA256 Fingerprint: b6:76:f2:ed:da:e8:77:5c:d3:6c:b0:f6:3c:d1:d4:60:39:61:f4:9e:62:65:ba:01:3a:2f:03:07:b6:d0:b8:04 +-----BEGIN CERTIFICATE----- +MIIF0jCCA7qgAwIBAgIQIdbQSk8lD8kyN/yqXhKN6TANBgkqhkiG9w0BAQ0FADCB +gDELMAkGA1UEBhMCUEwxIjAgBgNVBAoTGVVuaXpldG8gVGVjaG5vbG9naWVzIFMu +QS4xJzAlBgNVBAsTHkNlcnR1bSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTEkMCIG +A1UEAxMbQ2VydHVtIFRydXN0ZWQgTmV0d29yayBDQSAyMCIYDzIwMTExMDA2MDgz +OTU2WhgPMjA0NjEwMDYwODM5NTZaMIGAMQswCQYDVQQGEwJQTDEiMCAGA1UEChMZ +VW5pemV0byBUZWNobm9sb2dpZXMgUy5BLjEnMCUGA1UECxMeQ2VydHVtIENlcnRp +ZmljYXRpb24gQXV0aG9yaXR5MSQwIgYDVQQDExtDZXJ0dW0gVHJ1c3RlZCBOZXR3 +b3JrIENBIDIwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC9+Xj45tWA +DGSdhhuWZGc/IjoedQF97/tcZ4zJzFxrqZHmuULlIEub2pt7uZld2ZuAS9eEQCsn +0+i6MLs+CRqnSZXvK0AkwpfHp+6bJe+oCgCXhVqqndwpyeI1B+twTUrWwbNWuKFB +OJvR+zF/j+Bf4bE/D44WSWDXBo0Y+aomEKsq09DRZ40bRr5HMNUuctHFY9rnY3lE +fktjJImGLjQ/KUxSiyqnwOKRKIm5wFv5HdnnJ63/mgKXwcZQkpsCLL2puTRZCr+E +Sv/f/rOf69me4Jgj7KZrdxYq28ytOxykh9xGc14ZYmhFV+SQgkK7QtbwYeDBoz1m +o130GO6IyY0XRSmZMnUCMe4pJshrAua1YkV/NxVaI2iJ1D7eTiew8EAMvE0Xy02i +sx7QBlrd9pPPV3WZ9fqGGmd4s7+W/jTcvedSVuWz5XV710GRBdxdaeOVDUO5/IOW +OZV7bIBaTxNyxtd9KXpEulKkKtVBRgkg/iKgtlswjbyJDNXXcPiHUv3a76xRLgez +Tv7QCdpw75j6VuZt27VXS9zlLCUVyJ4ueE742pyehizKV/Ma5ciSixqClnrDvFAS +adgOWkaLOusm+iPJtrCBvkIApPjW/jAux9JG9uWOdf3yzLnQh1vMBhBgu4M1t15n +3kfsmUjxpKEV/q2MYo45VU85FrmxY53/twIDAQABo0IwQDAPBgNVHRMBAf8EBTAD +AQH/MB0GA1UdDgQWBBS2oVQ5AsOgP46KvPrU+Bym0ToO/TAOBgNVHQ8BAf8EBAMC +AQYwDQYJKoZIhvcNAQENBQADggIBAHGlDs7k6b8/ONWJWsQCYftMxRQXLYtPU2sQ +F/xlhMcQSZDe28cmk4gmb3DWAl45oPePq5a1pRNcgRRtDoGCERuKTsZPpd1iHkTf +CVn0W3cLN+mLIMb4Ck4uWBzrM9DPhmDJ2vuAL55MYIR4PSFk1vtBHxgP58l1cb29 +XN40hz5BsA72udY/CROWFC/emh1auVbONTqwX3BNXuMp8SMoclm2q8KMZiYcdywm +djWLKKdpoPk79SPdhRB0yZADVpHnr7pH1BKXESLjokmUbOe3lEu6LaTaM4tMpkT/ +WjzGHWTYtTHkpjx6qFcL2+1hGsvxznN3Y6SHb0xRONbkX8eftoEq5IVIeVheO/jb +AoJnwTnbw3RLPTYe+SmTiGhbqEQZIfCn6IENLOiTNrQ3ssqwGyZ6miUfmpqAnksq +P/ujmv5zMnHCnsZy4YpoJ/HkD7TETKVhk/iXEAcqMCWpuchxuO9ozC1+9eB+D4Ko +b7a6bINDd82Kkhehnlt4Fj1F4jNy3eFmypnTycUm/Q1oBEauttmbjL4ZvrHG8hnj +XALKLNhvSgfZyTXaQHXyxKcZb55CEJh15pWLYLztxRLXis7VmFxWlgPF7ncGNf/P +5O4/E2Hu29othfDNrp2yGAlFw5Khchf8R7agCyzxxN5DaAhqXzvwdmP7zAYspsbi +DrW5viSP +-----END CERTIFICATE----- + +# Issuer: CN=Hellenic Academic and Research Institutions RootCA 2015 O=Hellenic Academic and Research Institutions Cert. Authority +# Subject: CN=Hellenic Academic and Research Institutions RootCA 2015 O=Hellenic Academic and Research Institutions Cert. Authority +# Label: "Hellenic Academic and Research Institutions RootCA 2015" +# Serial: 0 +# MD5 Fingerprint: ca:ff:e2:db:03:d9:cb:4b:e9:0f:ad:84:fd:7b:18:ce +# SHA1 Fingerprint: 01:0c:06:95:a6:98:19:14:ff:bf:5f:c6:b0:b6:95:ea:29:e9:12:a6 +# SHA256 Fingerprint: a0:40:92:9a:02:ce:53:b4:ac:f4:f2:ff:c6:98:1c:e4:49:6f:75:5e:6d:45:fe:0b:2a:69:2b:cd:52:52:3f:36 +-----BEGIN CERTIFICATE----- +MIIGCzCCA/OgAwIBAgIBADANBgkqhkiG9w0BAQsFADCBpjELMAkGA1UEBhMCR1Ix +DzANBgNVBAcTBkF0aGVuczFEMEIGA1UEChM7SGVsbGVuaWMgQWNhZGVtaWMgYW5k +IFJlc2VhcmNoIEluc3RpdHV0aW9ucyBDZXJ0LiBBdXRob3JpdHkxQDA+BgNVBAMT +N0hlbGxlbmljIEFjYWRlbWljIGFuZCBSZXNlYXJjaCBJbnN0aXR1dGlvbnMgUm9v +dENBIDIwMTUwHhcNMTUwNzA3MTAxMTIxWhcNNDAwNjMwMTAxMTIxWjCBpjELMAkG +A1UEBhMCR1IxDzANBgNVBAcTBkF0aGVuczFEMEIGA1UEChM7SGVsbGVuaWMgQWNh +ZGVtaWMgYW5kIFJlc2VhcmNoIEluc3RpdHV0aW9ucyBDZXJ0LiBBdXRob3JpdHkx +QDA+BgNVBAMTN0hlbGxlbmljIEFjYWRlbWljIGFuZCBSZXNlYXJjaCBJbnN0aXR1 +dGlvbnMgUm9vdENBIDIwMTUwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoIC +AQDC+Kk/G4n8PDwEXT2QNrCROnk8ZlrvbTkBSRq0t89/TSNTt5AA4xMqKKYx8ZEA +4yjsriFBzh/a/X0SWwGDD7mwX5nh8hKDgE0GPt+sr+ehiGsxr/CL0BgzuNtFajT0 +AoAkKAoCFZVedioNmToUW/bLy1O8E00BiDeUJRtCvCLYjqOWXjrZMts+6PAQZe10 +4S+nfK8nNLspfZu2zwnI5dMK/IhlZXQK3HMcXM1AsRzUtoSMTFDPaI6oWa7CJ06C +ojXdFPQf/7J31Ycvqm59JCfnxssm5uX+Zwdj2EUN3TpZZTlYepKZcj2chF6IIbjV +9Cz82XBST3i4vTwri5WY9bPRaM8gFH5MXF/ni+X1NYEZN9cRCLdmvtNKzoNXADrD +gfgXy5I2XdGj2HUb4Ysn6npIQf1FGQatJ5lOwXBH3bWfgVMS5bGMSF0xQxfjjMZ6 +Y5ZLKTBOhE5iGV48zpeQpX8B653g+IuJ3SWYPZK2fu/Z8VFRfS0myGlZYeCsargq +NhEEelC9MoS+L9xy1dcdFkfkR2YgP/SWxa+OAXqlD3pk9Q0Yh9muiNX6hME6wGko +LfINaFGq46V3xqSQDqE3izEjR8EJCOtu93ib14L8hCCZSRm2Ekax+0VVFqmjZayc +Bw/qa9wfLgZy7IaIEuQt218FL+TwA9MmM+eAws1CoRc0CwIDAQABo0IwQDAPBgNV +HRMBAf8EBTADAQH/MA4GA1UdDwEB/wQEAwIBBjAdBgNVHQ4EFgQUcRVnyMjJvXVd +ctA4GGqd83EkVAswDQYJKoZIhvcNAQELBQADggIBAHW7bVRLqhBYRjTyYtcWNl0I +XtVsyIe9tC5G8jH4fOpCtZMWVdyhDBKg2mF+D1hYc2Ryx+hFjtyp8iY/xnmMsVMI +M4GwVhO+5lFc2JsKT0ucVlMC6U/2DWDqTUJV6HwbISHTGzrMd/K4kPFox/la/vot +9L/J9UUbzjgQKjeKeaO04wlshYaT/4mWJ3iBj2fjRnRUjtkNaeJK9E10A/+yd+2V +Z5fkscWrv2oj6NSU4kQoYsRL4vDY4ilrGnB+JGGTe08DMiUNRSQrlrRGar9KC/ea +j8GsGsVn82800vpzY4zvFrCopEYq+OsS7HK07/grfoxSwIuEVPkvPuNVqNxmsdnh +X9izjFk0WaSrT2y7HxjbdavYy5LNlDhhDgcGH0tGEPEVvo2FXDtKK4F5D7Rpn0lQ +l033DlZdwJVqwjbDG2jJ9SrcR5q+ss7FJej6A7na+RZukYT1HCjI/CbM1xyQVqdf +bzoEvM14iQuODy+jqk+iGxI9FghAD/FGTNeqewjBCvVtJ94Cj8rDtSvK6evIIVM4 +pcw72Hc3MKJP2W/R8kCtQXoXxdZKNYm3QdV8hn9VTYNKpXMgwDqvkPGaJI7ZjnHK +e7iG2rKPmT4dEw0SEe7Uq/DpFXYC5ODfqiAeW2GFZECpkJcNrVPSWh2HagCXZWK0 +vm9qp/UsQu0yrbYhnr68 +-----END CERTIFICATE----- + +# Issuer: CN=Hellenic Academic and Research Institutions ECC RootCA 2015 O=Hellenic Academic and Research Institutions Cert. Authority +# Subject: CN=Hellenic Academic and Research Institutions ECC RootCA 2015 O=Hellenic Academic and Research Institutions Cert. Authority +# Label: "Hellenic Academic and Research Institutions ECC RootCA 2015" +# Serial: 0 +# MD5 Fingerprint: 81:e5:b4:17:eb:c2:f5:e1:4b:0d:41:7b:49:92:fe:ef +# SHA1 Fingerprint: 9f:f1:71:8d:92:d5:9a:f3:7d:74:97:b4:bc:6f:84:68:0b:ba:b6:66 +# SHA256 Fingerprint: 44:b5:45:aa:8a:25:e6:5a:73:ca:15:dc:27:fc:36:d2:4c:1c:b9:95:3a:06:65:39:b1:15:82:dc:48:7b:48:33 +-----BEGIN CERTIFICATE----- +MIICwzCCAkqgAwIBAgIBADAKBggqhkjOPQQDAjCBqjELMAkGA1UEBhMCR1IxDzAN +BgNVBAcTBkF0aGVuczFEMEIGA1UEChM7SGVsbGVuaWMgQWNhZGVtaWMgYW5kIFJl +c2VhcmNoIEluc3RpdHV0aW9ucyBDZXJ0LiBBdXRob3JpdHkxRDBCBgNVBAMTO0hl +bGxlbmljIEFjYWRlbWljIGFuZCBSZXNlYXJjaCBJbnN0aXR1dGlvbnMgRUNDIFJv +b3RDQSAyMDE1MB4XDTE1MDcwNzEwMzcxMloXDTQwMDYzMDEwMzcxMlowgaoxCzAJ +BgNVBAYTAkdSMQ8wDQYDVQQHEwZBdGhlbnMxRDBCBgNVBAoTO0hlbGxlbmljIEFj +YWRlbWljIGFuZCBSZXNlYXJjaCBJbnN0aXR1dGlvbnMgQ2VydC4gQXV0aG9yaXR5 +MUQwQgYDVQQDEztIZWxsZW5pYyBBY2FkZW1pYyBhbmQgUmVzZWFyY2ggSW5zdGl0 +dXRpb25zIEVDQyBSb290Q0EgMjAxNTB2MBAGByqGSM49AgEGBSuBBAAiA2IABJKg +QehLgoRc4vgxEZmGZE4JJS+dQS8KrjVPdJWyUWRrjWvmP3CV8AVER6ZyOFB2lQJa +jq4onvktTpnvLEhvTCUp6NFxW98dwXU3tNf6e3pCnGoKVlp8aQuqgAkkbH7BRqNC +MEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFLQi +C4KZJAEOnLvkDv2/+5cgk5kqMAoGCCqGSM49BAMCA2cAMGQCMGfOFmI4oqxiRaep +lSTAGiecMjvAwNW6qef4BENThe5SId6d9SWDPp5YSy/XZxMOIQIwBeF1Ad5o7Sof +TUwJCA3sS61kFyjndc5FZXIhF8siQQ6ME5g4mlRtm8rifOoCWCKR +-----END CERTIFICATE----- + +# Issuer: CN=Certplus Root CA G1 O=Certplus +# Subject: CN=Certplus Root CA G1 O=Certplus +# Label: "Certplus Root CA G1" +# Serial: 1491911565779898356709731176965615564637713 +# MD5 Fingerprint: 7f:09:9c:f7:d9:b9:5c:69:69:56:d5:37:3e:14:0d:42 +# SHA1 Fingerprint: 22:fd:d0:b7:fd:a2:4e:0d:ac:49:2c:a0:ac:a6:7b:6a:1f:e3:f7:66 +# SHA256 Fingerprint: 15:2a:40:2b:fc:df:2c:d5:48:05:4d:22:75:b3:9c:7f:ca:3e:c0:97:80:78:b0:f0:ea:76:e5:61:a6:c7:43:3e +-----BEGIN CERTIFICATE----- +MIIFazCCA1OgAwIBAgISESBVg+QtPlRWhS2DN7cs3EYRMA0GCSqGSIb3DQEBDQUA +MD4xCzAJBgNVBAYTAkZSMREwDwYDVQQKDAhDZXJ0cGx1czEcMBoGA1UEAwwTQ2Vy +dHBsdXMgUm9vdCBDQSBHMTAeFw0xNDA1MjYwMDAwMDBaFw0zODAxMTUwMDAwMDBa +MD4xCzAJBgNVBAYTAkZSMREwDwYDVQQKDAhDZXJ0cGx1czEcMBoGA1UEAwwTQ2Vy +dHBsdXMgUm9vdCBDQSBHMTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIB +ANpQh7bauKk+nWT6VjOaVj0W5QOVsjQcmm1iBdTYj+eJZJ+622SLZOZ5KmHNr49a +iZFluVj8tANfkT8tEBXgfs+8/H9DZ6itXjYj2JizTfNDnjl8KvzsiNWI7nC9hRYt +6kuJPKNxQv4c/dMcLRC4hlTqQ7jbxofaqK6AJc96Jh2qkbBIb6613p7Y1/oA/caP +0FG7Yn2ksYyy/yARujVjBYZHYEMzkPZHogNPlk2dT8Hq6pyi/jQu3rfKG3akt62f +6ajUeD94/vI4CTYd0hYCyOwqaK/1jpTvLRN6HkJKHRUxrgwEV/xhc/MxVoYxgKDE +EW4wduOU8F8ExKyHcomYxZ3MVwia9Az8fXoFOvpHgDm2z4QTd28n6v+WZxcIbekN +1iNQMLAVdBM+5S//Ds3EC0pd8NgAM0lm66EYfFkuPSi5YXHLtaW6uOrc4nBvCGrc +h2c0798wct3zyT8j/zXhviEpIDCB5BmlIOklynMxdCm+4kLV87ImZsdo/Rmz5yCT +mehd4F6H50boJZwKKSTUzViGUkAksnsPmBIgJPaQbEfIDbsYIC7Z/fyL8inqh3SV +4EJQeIQEQWGw9CEjjy3LKCHyamz0GqbFFLQ3ZU+V/YDI+HLlJWvEYLF7bY5KinPO +WftwenMGE9nTdDckQQoRb5fc5+R+ob0V8rqHDz1oihYHAgMBAAGjYzBhMA4GA1Ud +DwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBSowcCbkahDFXxd +Bie0KlHYlwuBsTAfBgNVHSMEGDAWgBSowcCbkahDFXxdBie0KlHYlwuBsTANBgkq +hkiG9w0BAQ0FAAOCAgEAnFZvAX7RvUz1isbwJh/k4DgYzDLDKTudQSk0YcbX8ACh +66Ryj5QXvBMsdbRX7gp8CXrc1cqh0DQT+Hern+X+2B50ioUHj3/MeXrKls3N/U/7 +/SMNkPX0XtPGYX2eEeAC7gkE2Qfdpoq3DIMku4NQkv5gdRE+2J2winq14J2by5BS +S7CTKtQ+FjPlnsZlFT5kOwQ/2wyPX1wdaR+v8+khjPPvl/aatxm2hHSco1S1cE5j +2FddUyGbQJJD+tZ3VTNPZNX70Cxqjm0lpu+F6ALEUz65noe8zDUa3qHpimOHZR4R +Kttjd5cUvpoUmRGywO6wT/gUITJDT5+rosuoD6o7BlXGEilXCNQ314cnrUlZp5Gr +RHpejXDbl85IULFzk/bwg2D5zfHhMf1bfHEhYxQUqq/F3pN+aLHsIqKqkHWetUNy +6mSjhEv9DKgma3GX7lZjZuhCVPnHHd/Qj1vfyDBviP4NxDMcU6ij/UgQ8uQKTuEV +V/xuZDDCVRHc6qnNSlSsKWNEz0pAoNZoWRsz+e86i9sgktxChL8Bq4fA1SCC28a5 +g4VCXA9DO2pJNdWY9BW/+mGBDAkgGNLQFwzLSABQ6XaCjGTXOqAHVcweMcDvOrRl +++O/QmueD6i9a5jc2NvLi6Td11n0bt3+qsOR0C5CB8AMTVPNJLFMWx5R9N/pkvo= +-----END CERTIFICATE----- + +# Issuer: CN=Certplus Root CA G2 O=Certplus +# Subject: CN=Certplus Root CA G2 O=Certplus +# Label: "Certplus Root CA G2" +# Serial: 1492087096131536844209563509228951875861589 +# MD5 Fingerprint: a7:ee:c4:78:2d:1b:ee:2d:b9:29:ce:d6:a7:96:32:31 +# SHA1 Fingerprint: 4f:65:8e:1f:e9:06:d8:28:02:e9:54:47:41:c9:54:25:5d:69:cc:1a +# SHA256 Fingerprint: 6c:c0:50:41:e6:44:5e:74:69:6c:4c:fb:c9:f8:0f:54:3b:7e:ab:bb:44:b4:ce:6f:78:7c:6a:99:71:c4:2f:17 +-----BEGIN CERTIFICATE----- +MIICHDCCAaKgAwIBAgISESDZkc6uo+jF5//pAq/Pc7xVMAoGCCqGSM49BAMDMD4x +CzAJBgNVBAYTAkZSMREwDwYDVQQKDAhDZXJ0cGx1czEcMBoGA1UEAwwTQ2VydHBs +dXMgUm9vdCBDQSBHMjAeFw0xNDA1MjYwMDAwMDBaFw0zODAxMTUwMDAwMDBaMD4x +CzAJBgNVBAYTAkZSMREwDwYDVQQKDAhDZXJ0cGx1czEcMBoGA1UEAwwTQ2VydHBs +dXMgUm9vdCBDQSBHMjB2MBAGByqGSM49AgEGBSuBBAAiA2IABM0PW1aC3/BFGtat +93nwHcmsltaeTpwftEIRyoa/bfuFo8XlGVzX7qY/aWfYeOKmycTbLXku54uNAm8x +Ik0G42ByRZ0OQneezs/lf4WbGOT8zC5y0xaTTsqZY1yhBSpsBqNjMGEwDgYDVR0P +AQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFNqDYwJ5jtpMxjwj +FNiPwyCrKGBZMB8GA1UdIwQYMBaAFNqDYwJ5jtpMxjwjFNiPwyCrKGBZMAoGCCqG +SM49BAMDA2gAMGUCMHD+sAvZ94OX7PNVHdTcswYO/jOYnYs5kGuUIe22113WTNch +p+e/IQ8rzfcq3IUHnQIxAIYUFuXcsGXCwI4Un78kFmjlvPl5adytRSv3tjFzzAal +U5ORGpOucGpnutee5WEaXw== +-----END CERTIFICATE----- + +# Issuer: CN=OpenTrust Root CA G1 O=OpenTrust +# Subject: CN=OpenTrust Root CA G1 O=OpenTrust +# Label: "OpenTrust Root CA G1" +# Serial: 1492036577811947013770400127034825178844775 +# MD5 Fingerprint: 76:00:cc:81:29:cd:55:5e:88:6a:7a:2e:f7:4d:39:da +# SHA1 Fingerprint: 79:91:e8:34:f7:e2:ee:dd:08:95:01:52:e9:55:2d:14:e9:58:d5:7e +# SHA256 Fingerprint: 56:c7:71:28:d9:8c:18:d9:1b:4c:fd:ff:bc:25:ee:91:03:d4:75:8e:a2:ab:ad:82:6a:90:f3:45:7d:46:0e:b4 +-----BEGIN CERTIFICATE----- +MIIFbzCCA1egAwIBAgISESCzkFU5fX82bWTCp59rY45nMA0GCSqGSIb3DQEBCwUA +MEAxCzAJBgNVBAYTAkZSMRIwEAYDVQQKDAlPcGVuVHJ1c3QxHTAbBgNVBAMMFE9w +ZW5UcnVzdCBSb290IENBIEcxMB4XDTE0MDUyNjA4NDU1MFoXDTM4MDExNTAwMDAw +MFowQDELMAkGA1UEBhMCRlIxEjAQBgNVBAoMCU9wZW5UcnVzdDEdMBsGA1UEAwwU +T3BlblRydXN0IFJvb3QgQ0EgRzEwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK +AoICAQD4eUbalsUwXopxAy1wpLuwxQjczeY1wICkES3d5oeuXT2R0odsN7faYp6b +wiTXj/HbpqbfRm9RpnHLPhsxZ2L3EVs0J9V5ToybWL0iEA1cJwzdMOWo010hOHQX +/uMftk87ay3bfWAfjH1MBcLrARYVmBSO0ZB3Ij/swjm4eTrwSSTilZHcYTSSjFR0 +77F9jAHiOH3BX2pfJLKOYheteSCtqx234LSWSE9mQxAGFiQD4eCcjsZGT44ameGP +uY4zbGneWK2gDqdkVBFpRGZPTBKnjix9xNRbxQA0MMHZmf4yzgeEtE7NCv82TWLx +p2NX5Ntqp66/K7nJ5rInieV+mhxNaMbBGN4zK1FGSxyO9z0M+Yo0FMT7MzUj8czx +Kselu7Cizv5Ta01BG2Yospb6p64KTrk5M0ScdMGTHPjgniQlQ/GbI4Kq3ywgsNw2 +TgOzfALU5nsaqocTvz6hdLubDuHAk5/XpGbKuxs74zD0M1mKB3IDVedzagMxbm+W +G+Oin6+Sx+31QrclTDsTBM8clq8cIqPQqwWyTBIjUtz9GVsnnB47ev1CI9sjgBPw +vFEVVJSmdz7QdFG9URQIOTfLHzSpMJ1ShC5VkLG631UAC9hWLbFJSXKAqWLXwPYY +EQRVzXR7z2FwefR7LFxckvzluFqrTJOVoSfupb7PcSNCupt2LQIDAQABo2MwYTAO +BgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUl0YhVyE1 +2jZVx/PxN3DlCPaTKbYwHwYDVR0jBBgwFoAUl0YhVyE12jZVx/PxN3DlCPaTKbYw +DQYJKoZIhvcNAQELBQADggIBAB3dAmB84DWn5ph76kTOZ0BP8pNuZtQ5iSas000E +PLuHIT839HEl2ku6q5aCgZG27dmxpGWX4m9kWaSW7mDKHyP7Rbr/jyTwyqkxf3kf +gLMtMrpkZ2CvuVnN35pJ06iCsfmYlIrM4LvgBBuZYLFGZdwIorJGnkSI6pN+VxbS +FXJfLkur1J1juONI5f6ELlgKn0Md/rcYkoZDSw6cMoYsYPXpSOqV7XAp8dUv/TW0 +V8/bhUiZucJvbI/NeJWsZCj9VrDDb8O+WVLhX4SPgPL0DTatdrOjteFkdjpY3H1P +XlZs5VVZV6Xf8YpmMIzUUmI4d7S+KNfKNsSbBfD4Fdvb8e80nR14SohWZ25g/4/I +i+GOvUKpMwpZQhISKvqxnUOOBZuZ2mKtVzazHbYNeS2WuOvyDEsMpZTGMKcmGS3t +TAZQMPH9WD25SxdfGbRqhFS0OE85og2WaMMolP3tLR9Ka0OWLpABEPs4poEL0L91 +09S5zvE/bw4cHjdx5RiHdRk/ULlepEU0rbDK5uUTdg8xFKmOLZTW1YVNcxVPS/Ky +Pu1svf0OnWZzsD2097+o4BGkxK51CUpjAEggpsadCwmKtODmzj7HPiY46SvepghJ +AwSQiumPv+i2tCqjI40cHLI5kqiPAlxAOXXUc0ECd97N4EOH1uS6SsNsEn/+KuYj +1oxx +-----END CERTIFICATE----- + +# Issuer: CN=OpenTrust Root CA G2 O=OpenTrust +# Subject: CN=OpenTrust Root CA G2 O=OpenTrust +# Label: "OpenTrust Root CA G2" +# Serial: 1492012448042702096986875987676935573415441 +# MD5 Fingerprint: 57:24:b6:59:24:6b:ae:c8:fe:1c:0c:20:f2:c0:4e:eb +# SHA1 Fingerprint: 79:5f:88:60:c5:ab:7c:3d:92:e6:cb:f4:8d:e1:45:cd:11:ef:60:0b +# SHA256 Fingerprint: 27:99:58:29:fe:6a:75:15:c1:bf:e8:48:f9:c4:76:1d:b1:6c:22:59:29:25:7b:f4:0d:08:94:f2:9e:a8:ba:f2 +-----BEGIN CERTIFICATE----- +MIIFbzCCA1egAwIBAgISESChaRu/vbm9UpaPI+hIvyYRMA0GCSqGSIb3DQEBDQUA +MEAxCzAJBgNVBAYTAkZSMRIwEAYDVQQKDAlPcGVuVHJ1c3QxHTAbBgNVBAMMFE9w +ZW5UcnVzdCBSb290IENBIEcyMB4XDTE0MDUyNjAwMDAwMFoXDTM4MDExNTAwMDAw +MFowQDELMAkGA1UEBhMCRlIxEjAQBgNVBAoMCU9wZW5UcnVzdDEdMBsGA1UEAwwU +T3BlblRydXN0IFJvb3QgQ0EgRzIwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK +AoICAQDMtlelM5QQgTJT32F+D3Y5z1zCU3UdSXqWON2ic2rxb95eolq5cSG+Ntmh +/LzubKh8NBpxGuga2F8ORAbtp+Dz0mEL4DKiltE48MLaARf85KxP6O6JHnSrT78e +CbY2albz4e6WiWYkBuTNQjpK3eCasMSCRbP+yatcfD7J6xcvDH1urqWPyKwlCm/6 +1UWY0jUJ9gNDlP7ZvyCVeYCYitmJNbtRG6Q3ffyZO6v/v6wNj0OxmXsWEH4db0fE +FY8ElggGQgT4hNYdvJGmQr5J1WqIP7wtUdGejeBSzFfdNTVY27SPJIjki9/ca1TS +gSuyzpJLHB9G+h3Ykst2Z7UJmQnlrBcUVXDGPKBWCgOz3GIZ38i1MH/1PCZ1Eb3X +G7OHngevZXHloM8apwkQHZOJZlvoPGIytbU6bumFAYueQ4xncyhZW+vj3CzMpSZy +YhK05pyDRPZRpOLAeiRXyg6lPzq1O4vldu5w5pLeFlwoW5cZJ5L+epJUzpM5ChaH +vGOz9bGTXOBut9Dq+WIyiET7vycotjCVXRIouZW+j1MY5aIYFuJWpLIsEPUdN6b4 +t/bQWVyJ98LVtZR00dX+G7bw5tYee9I8y6jj9RjzIR9u701oBnstXW5DiabA+aC/ +gh7PU3+06yzbXfZqfUAkBXKJOAGTy3HCOV0GEfZvePg3DTmEJwIDAQABo2MwYTAO +BgNVHQ8BAf8EBAMCAQYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUajn6QiL3 +5okATV59M4PLuG53hq8wHwYDVR0jBBgwFoAUajn6QiL35okATV59M4PLuG53hq8w +DQYJKoZIhvcNAQENBQADggIBAJjLq0A85TMCl38th6aP1F5Kr7ge57tx+4BkJamz +Gj5oXScmp7oq4fBXgwpkTx4idBvpkF/wrM//T2h6OKQQbA2xx6R3gBi2oihEdqc0 +nXGEL8pZ0keImUEiyTCYYW49qKgFbdEfwFFEVn8nNQLdXpgKQuswv42hm1GqO+qT +RmTFAHneIWv2V6CG1wZy7HBGS4tz3aAhdT7cHcCP009zHIXZ/n9iyJVvttN7jLpT +wm+bREx50B1ws9efAvSyB7DH5fitIw6mVskpEndI2S9G/Tvw/HRwkqWOOAgfZDC2 +t0v7NqwQjqBSM2OdAzVWxWm9xiNaJ5T2pBL4LTM8oValX9YZ6e18CL13zSdkzJTa +TkZQh+D5wVOAHrut+0dSixv9ovneDiK3PTNZbNTe9ZUGMg1RGUFcPk8G97krgCf2 +o6p6fAbhQ8MTOWIaNr3gKC6UAuQpLmBVrkA9sHSSXvAgZJY/X0VdiLWK2gKgW0VU +3jg9CcCoSmVGFvyqv1ROTVu+OEO3KMqLM6oaJbolXCkvW0pujOotnCr2BXbgd5eA +iN1nE28daCSLT7d0geX0YJ96Vdc+N9oWaz53rK4YcJUIeSkDiv7BO7M/Gg+kO14f +WKGVyasvc0rQLW6aWQ9VGHgtPFGml4vmu7JwqkwR3v98KzfUetF3NI/n+UL3PIEM +S1IK +-----END CERTIFICATE----- + +# Issuer: CN=OpenTrust Root CA G3 O=OpenTrust +# Subject: CN=OpenTrust Root CA G3 O=OpenTrust +# Label: "OpenTrust Root CA G3" +# Serial: 1492104908271485653071219941864171170455615 +# MD5 Fingerprint: 21:37:b4:17:16:92:7b:67:46:70:a9:96:d7:a8:13:24 +# SHA1 Fingerprint: 6e:26:64:f3:56:bf:34:55:bf:d1:93:3f:7c:01:de:d8:13:da:8a:a6 +# SHA256 Fingerprint: b7:c3:62:31:70:6e:81:07:8c:36:7c:b8:96:19:8f:1e:32:08:dd:92:69:49:dd:8f:57:09:a4:10:f7:5b:62:92 +-----BEGIN CERTIFICATE----- +MIICITCCAaagAwIBAgISESDm+Ez8JLC+BUCs2oMbNGA/MAoGCCqGSM49BAMDMEAx +CzAJBgNVBAYTAkZSMRIwEAYDVQQKDAlPcGVuVHJ1c3QxHTAbBgNVBAMMFE9wZW5U +cnVzdCBSb290IENBIEczMB4XDTE0MDUyNjAwMDAwMFoXDTM4MDExNTAwMDAwMFow +QDELMAkGA1UEBhMCRlIxEjAQBgNVBAoMCU9wZW5UcnVzdDEdMBsGA1UEAwwUT3Bl +blRydXN0IFJvb3QgQ0EgRzMwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAARK7liuTcpm +3gY6oxH84Bjwbhy6LTAMidnW7ptzg6kjFYwvWYpa3RTqnVkrQ7cG7DK2uu5Bta1d +oYXM6h0UZqNnfkbilPPntlahFVmhTzeXuSIevRHr9LIfXsMUmuXZl5mjYzBhMA4G +A1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBRHd8MUi2I5 +DMlv4VBN0BBY3JWIbTAfBgNVHSMEGDAWgBRHd8MUi2I5DMlv4VBN0BBY3JWIbTAK +BggqhkjOPQQDAwNpADBmAjEAj6jcnboMBBf6Fek9LykBl7+BFjNAk2z8+e2AcG+q +j9uEwov1NcoG3GRvaBbhj5G5AjEA2Euly8LQCGzpGPta3U1fJAuwACEl74+nBCZx +4nxp5V2a+EEfOzmTk51V6s2N8fvB +-----END CERTIFICATE----- + +# Issuer: CN=ISRG Root X1 O=Internet Security Research Group +# Subject: CN=ISRG Root X1 O=Internet Security Research Group +# Label: "ISRG Root X1" +# Serial: 172886928669790476064670243504169061120 +# MD5 Fingerprint: 0c:d2:f9:e0:da:17:73:e9:ed:86:4d:a5:e3:70:e7:4e +# SHA1 Fingerprint: ca:bd:2a:79:a1:07:6a:31:f2:1d:25:36:35:cb:03:9d:43:29:a5:e8 +# SHA256 Fingerprint: 96:bc:ec:06:26:49:76:f3:74:60:77:9a:cf:28:c5:a7:cf:e8:a3:c0:aa:e1:1a:8f:fc:ee:05:c0:bd:df:08:c6 +-----BEGIN CERTIFICATE----- +MIIFazCCA1OgAwIBAgIRAIIQz7DSQONZRGPgu2OCiwAwDQYJKoZIhvcNAQELBQAw +TzELMAkGA1UEBhMCVVMxKTAnBgNVBAoTIEludGVybmV0IFNlY3VyaXR5IFJlc2Vh +cmNoIEdyb3VwMRUwEwYDVQQDEwxJU1JHIFJvb3QgWDEwHhcNMTUwNjA0MTEwNDM4 +WhcNMzUwNjA0MTEwNDM4WjBPMQswCQYDVQQGEwJVUzEpMCcGA1UEChMgSW50ZXJu +ZXQgU2VjdXJpdHkgUmVzZWFyY2ggR3JvdXAxFTATBgNVBAMTDElTUkcgUm9vdCBY +MTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK3oJHP0FDfzm54rVygc +h77ct984kIxuPOZXoHj3dcKi/vVqbvYATyjb3miGbESTtrFj/RQSa78f0uoxmyF+ +0TM8ukj13Xnfs7j/EvEhmkvBioZxaUpmZmyPfjxwv60pIgbz5MDmgK7iS4+3mX6U +A5/TR5d8mUgjU+g4rk8Kb4Mu0UlXjIB0ttov0DiNewNwIRt18jA8+o+u3dpjq+sW +T8KOEUt+zwvo/7V3LvSye0rgTBIlDHCNAymg4VMk7BPZ7hm/ELNKjD+Jo2FR3qyH +B5T0Y3HsLuJvW5iB4YlcNHlsdu87kGJ55tukmi8mxdAQ4Q7e2RCOFvu396j3x+UC +B5iPNgiV5+I3lg02dZ77DnKxHZu8A/lJBdiB3QW0KtZB6awBdpUKD9jf1b0SHzUv +KBds0pjBqAlkd25HN7rOrFleaJ1/ctaJxQZBKT5ZPt0m9STJEadao0xAH0ahmbWn +OlFuhjuefXKnEgV4We0+UXgVCwOPjdAvBbI+e0ocS3MFEvzG6uBQE3xDk3SzynTn +jh8BCNAw1FtxNrQHusEwMFxIt4I7mKZ9YIqioymCzLq9gwQbooMDQaHWBfEbwrbw +qHyGO0aoSCqI3Haadr8faqU9GY/rOPNk3sgrDQoo//fb4hVC1CLQJ13hef4Y53CI +rU7m2Ys6xt0nUW7/vGT1M0NPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNV +HRMBAf8EBTADAQH/MB0GA1UdDgQWBBR5tFnme7bl5AFzgAiIyBpY9umbbjANBgkq +hkiG9w0BAQsFAAOCAgEAVR9YqbyyqFDQDLHYGmkgJykIrGF1XIpu+ILlaS/V9lZL +ubhzEFnTIZd+50xx+7LSYK05qAvqFyFWhfFQDlnrzuBZ6brJFe+GnY+EgPbk6ZGQ +3BebYhtF8GaV0nxvwuo77x/Py9auJ/GpsMiu/X1+mvoiBOv/2X/qkSsisRcOj/KK +NFtY2PwByVS5uCbMiogziUwthDyC3+6WVwW6LLv3xLfHTjuCvjHIInNzktHCgKQ5 +ORAzI4JMPJ+GslWYHb4phowim57iaztXOoJwTdwJx4nLCgdNbOhdjsnvzqvHu7Ur +TkXWStAmzOVyyghqpZXjFaH3pO3JLF+l+/+sKAIuvtd7u+Nxe5AW0wdeRlN8NwdC +jNPElpzVmbUq4JUagEiuTDkHzsxHpFKVK7q4+63SM1N95R1NbdWhscdCb+ZAJzVc +oyi3B43njTOQ5yOf+1CceWxG1bQVs5ZufpsMljq4Ui0/1lvh+wjChP4kqKOJ2qxq +4RgqsahDYVvTH9w7jXbyLeiNdd8XM2w9U/t7y0Ff/9yi0GE44Za4rF2LN9d11TPA +mRGunUHBcnWEvgJBQl9nJEiU0Zsnvgc/ubhPgXRR4Xq37Z0j4r7g1SgEEzwxA57d +emyPxgcYxn/eR44/KJ4EBs+lVDR3veyJm+kXQ99b21/+jh5Xos1AnX5iItreGCc= +-----END CERTIFICATE----- + +# Issuer: O=FNMT-RCM OU=AC RAIZ FNMT-RCM +# Subject: O=FNMT-RCM OU=AC RAIZ FNMT-RCM +# Label: "AC RAIZ FNMT-RCM" +# Serial: 485876308206448804701554682760554759 +# MD5 Fingerprint: e2:09:04:b4:d3:bd:d1:a0:14:fd:1a:d2:47:c4:57:1d +# SHA1 Fingerprint: ec:50:35:07:b2:15:c4:95:62:19:e2:a8:9a:5b:42:99:2c:4c:2c:20 +# SHA256 Fingerprint: eb:c5:57:0c:29:01:8c:4d:67:b1:aa:12:7b:af:12:f7:03:b4:61:1e:bc:17:b7:da:b5:57:38:94:17:9b:93:fa +-----BEGIN CERTIFICATE----- +MIIFgzCCA2ugAwIBAgIPXZONMGc2yAYdGsdUhGkHMA0GCSqGSIb3DQEBCwUAMDsx +CzAJBgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEZMBcGA1UECwwQQUMgUkFJ +WiBGTk1ULVJDTTAeFw0wODEwMjkxNTU5NTZaFw0zMDAxMDEwMDAwMDBaMDsxCzAJ +BgNVBAYTAkVTMREwDwYDVQQKDAhGTk1ULVJDTTEZMBcGA1UECwwQQUMgUkFJWiBG +Tk1ULVJDTTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBALpxgHpMhm5/ +yBNtwMZ9HACXjywMI7sQmkCpGreHiPibVmr75nuOi5KOpyVdWRHbNi63URcfqQgf +BBckWKo3Shjf5TnUV/3XwSyRAZHiItQDwFj8d0fsjz50Q7qsNI1NOHZnjrDIbzAz +WHFctPVrbtQBULgTfmxKo0nRIBnuvMApGGWn3v7v3QqQIecaZ5JCEJhfTzC8PhxF +tBDXaEAUwED653cXeuYLj2VbPNmaUtu1vZ5Gzz3rkQUCwJaydkxNEJY7kvqcfw+Z +374jNUUeAlz+taibmSXaXvMiwzn15Cou08YfxGyqxRxqAQVKL9LFwag0Jl1mpdIC +IfkYtwb1TplvqKtMUejPUBjFd8g5CSxJkjKZqLsXF3mwWsXmo8RZZUc1g16p6DUL +mbvkzSDGm0oGObVo/CK67lWMK07q87Hj/LaZmtVC+nFNCM+HHmpxffnTtOmlcYF7 +wk5HlqX2doWjKI/pgG6BU6VtX7hI+cL5NqYuSf+4lsKMB7ObiFj86xsc3i1w4peS +MKGJ47xVqCfWS+2QrYv6YyVZLag13cqXM7zlzced0ezvXg5KkAYmY6252TUtB7p2 +ZSysV4999AeU14ECll2jB0nVetBX+RvnU0Z1qrB5QstocQjpYL05ac70r8NWQMet +UqIJ5G+GR4of6ygnXYMgrwTJbFaai0b1AgMBAAGjgYMwgYAwDwYDVR0TAQH/BAUw +AwEB/zAOBgNVHQ8BAf8EBAMCAQYwHQYDVR0OBBYEFPd9xf3E6Jobd2Sn9R2gzL+H +YJptMD4GA1UdIAQ3MDUwMwYEVR0gADArMCkGCCsGAQUFBwIBFh1odHRwOi8vd3d3 +LmNlcnQuZm5tdC5lcy9kcGNzLzANBgkqhkiG9w0BAQsFAAOCAgEAB5BK3/MjTvDD +nFFlm5wioooMhfNzKWtN/gHiqQxjAb8EZ6WdmF/9ARP67Jpi6Yb+tmLSbkyU+8B1 +RXxlDPiyN8+sD8+Nb/kZ94/sHvJwnvDKuO+3/3Y3dlv2bojzr2IyIpMNOmqOFGYM +LVN0V2Ue1bLdI4E7pWYjJ2cJj+F3qkPNZVEI7VFY/uY5+ctHhKQV8Xa7pO6kO8Rf +77IzlhEYt8llvhjho6Tc+hj507wTmzl6NLrTQfv6MooqtyuGC2mDOL7Nii4LcK2N +JpLuHvUBKwrZ1pebbuCoGRw6IYsMHkCtA+fdZn71uSANA+iW+YJF1DngoABd15jm +fZ5nc8OaKveri6E6FO80vFIOiZiaBECEHX5FaZNXzuvO+FB8TxxuBEOb+dY7Ixjp +6o7RTUaN8Tvkasq6+yO3m/qZASlaWFot4/nUbQ4mrcFuNLwy+AwF+mWj2zs3gyLp +1txyM/1d8iC9djwj2ij3+RvrWWTV3F9yfiD8zYm1kGdNYno/Tq0dwzn+evQoFt9B +9kiABdcPUXmsEKvU7ANm5mqwujGSQkBqvjrTcuFqN1W8rB2Vt2lh8kORdOag0wok +RqEIr9baRRmW1FMdW4R58MD3R++Lj8UGrp1MYp3/RgT408m2ECVAdf4WqslKYIYv +uu8wd+RU4riEmViAqhOLUTpPSPaLtrM= +-----END CERTIFICATE----- + +# Issuer: CN=Amazon Root CA 1 O=Amazon +# Subject: CN=Amazon Root CA 1 O=Amazon +# Label: "Amazon Root CA 1" +# Serial: 143266978916655856878034712317230054538369994 +# MD5 Fingerprint: 43:c6:bf:ae:ec:fe:ad:2f:18:c6:88:68:30:fc:c8:e6 +# SHA1 Fingerprint: 8d:a7:f9:65:ec:5e:fc:37:91:0f:1c:6e:59:fd:c1:cc:6a:6e:de:16 +# SHA256 Fingerprint: 8e:cd:e6:88:4f:3d:87:b1:12:5b:a3:1a:c3:fc:b1:3d:70:16:de:7f:57:cc:90:4f:e1:cb:97:c6:ae:98:19:6e +-----BEGIN CERTIFICATE----- +MIIDQTCCAimgAwIBAgITBmyfz5m/jAo54vB4ikPmljZbyjANBgkqhkiG9w0BAQsF +ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6 +b24gUm9vdCBDQSAxMB4XDTE1MDUyNjAwMDAwMFoXDTM4MDExNzAwMDAwMFowOTEL +MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJv +b3QgQ0EgMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJ4gHHKeNXj +ca9HgFB0fW7Y14h29Jlo91ghYPl0hAEvrAIthtOgQ3pOsqTQNroBvo3bSMgHFzZM +9O6II8c+6zf1tRn4SWiw3te5djgdYZ6k/oI2peVKVuRF4fn9tBb6dNqcmzU5L/qw +IFAGbHrQgLKm+a/sRxmPUDgH3KKHOVj4utWp+UhnMJbulHheb4mjUcAwhmahRWa6 +VOujw5H5SNz/0egwLX0tdHA114gk957EWW67c4cX8jJGKLhD+rcdqsq08p8kDi1L +93FcXmn/6pUCyziKrlA4b9v7LWIbxcceVOF34GfID5yHI9Y/QCB/IIDEgEw+OyQm +jgSubJrIqg0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMC +AYYwHQYDVR0OBBYEFIQYzIU07LwMlJQuCFmcx7IQTgoIMA0GCSqGSIb3DQEBCwUA +A4IBAQCY8jdaQZChGsV2USggNiMOruYou6r4lK5IpDB/G/wkjUu0yKGX9rbxenDI +U5PMCCjjmCXPI6T53iHTfIUJrU6adTrCC2qJeHZERxhlbI1Bjjt/msv0tadQ1wUs +N+gDS63pYaACbvXy8MWy7Vu33PqUXHeeE6V/Uq2V8viTO96LXFvKWlJbYK8U90vv +o/ufQJVtMVT8QtPHRh8jrdkPSHCa2XV4cdFyQzR1bldZwgJcJmApzyMZFo6IQ6XU +5MsI+yMRQ+hDKXJioaldXgjUkK642M4UwtBV8ob2xJNDd2ZhwLnoQdeXeGADbkpy +rqXRfboQnoZsG4q5WTP468SQvvG5 +-----END CERTIFICATE----- + +# Issuer: CN=Amazon Root CA 2 O=Amazon +# Subject: CN=Amazon Root CA 2 O=Amazon +# Label: "Amazon Root CA 2" +# Serial: 143266982885963551818349160658925006970653239 +# MD5 Fingerprint: c8:e5:8d:ce:a8:42:e2:7a:c0:2a:5c:7c:9e:26:bf:66 +# SHA1 Fingerprint: 5a:8c:ef:45:d7:a6:98:59:76:7a:8c:8b:44:96:b5:78:cf:47:4b:1a +# SHA256 Fingerprint: 1b:a5:b2:aa:8c:65:40:1a:82:96:01:18:f8:0b:ec:4f:62:30:4d:83:ce:c4:71:3a:19:c3:9c:01:1e:a4:6d:b4 +-----BEGIN CERTIFICATE----- +MIIFQTCCAymgAwIBAgITBmyf0pY1hp8KD+WGePhbJruKNzANBgkqhkiG9w0BAQwF +ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6 +b24gUm9vdCBDQSAyMB4XDTE1MDUyNjAwMDAwMFoXDTQwMDUyNjAwMDAwMFowOTEL +MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJv +b3QgQ0EgMjCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAK2Wny2cSkxK +gXlRmeyKy2tgURO8TW0G/LAIjd0ZEGrHJgw12MBvIITplLGbhQPDW9tK6Mj4kHbZ +W0/jTOgGNk3Mmqw9DJArktQGGWCsN0R5hYGCrVo34A3MnaZMUnbqQ523BNFQ9lXg +1dKmSYXpN+nKfq5clU1Imj+uIFptiJXZNLhSGkOQsL9sBbm2eLfq0OQ6PBJTYv9K +8nu+NQWpEjTj82R0Yiw9AElaKP4yRLuH3WUnAnE72kr3H9rN9yFVkE8P7K6C4Z9r +2UXTu/Bfh+08LDmG2j/e7HJV63mjrdvdfLC6HM783k81ds8P+HgfajZRRidhW+me +z/CiVX18JYpvL7TFz4QuK/0NURBs+18bvBt+xa47mAExkv8LV/SasrlX6avvDXbR +8O70zoan4G7ptGmh32n2M8ZpLpcTnqWHsFcQgTfJU7O7f/aS0ZzQGPSSbtqDT6Zj +mUyl+17vIWR6IF9sZIUVyzfpYgwLKhbcAS4y2j5L9Z469hdAlO+ekQiG+r5jqFoz +7Mt0Q5X5bGlSNscpb/xVA1wf+5+9R+vnSUeVC06JIglJ4PVhHvG/LopyboBZ/1c6 ++XUyo05f7O0oYtlNc/LMgRdg7c3r3NunysV+Ar3yVAhU/bQtCSwXVEqY0VThUWcI +0u1ufm8/0i2BWSlmy5A5lREedCf+3euvAgMBAAGjQjBAMA8GA1UdEwEB/wQFMAMB +Af8wDgYDVR0PAQH/BAQDAgGGMB0GA1UdDgQWBBSwDPBMMPQFWAJI/TPlUq9LhONm +UjANBgkqhkiG9w0BAQwFAAOCAgEAqqiAjw54o+Ci1M3m9Zh6O+oAA7CXDpO8Wqj2 +LIxyh6mx/H9z/WNxeKWHWc8w4Q0QshNabYL1auaAn6AFC2jkR2vHat+2/XcycuUY ++gn0oJMsXdKMdYV2ZZAMA3m3MSNjrXiDCYZohMr/+c8mmpJ5581LxedhpxfL86kS +k5Nrp+gvU5LEYFiwzAJRGFuFjWJZY7attN6a+yb3ACfAXVU3dJnJUH/jWS5E4ywl +7uxMMne0nxrpS10gxdr9HIcWxkPo1LsmmkVwXqkLN1PiRnsn/eBG8om3zEK2yygm +btmlyTrIQRNg91CMFa6ybRoVGld45pIq2WWQgj9sAq+uEjonljYE1x2igGOpm/Hl +urR8FLBOybEfdF849lHqm/osohHUqS0nGkWxr7JOcQ3AWEbWaQbLU8uz/mtBzUF+ +fUwPfHJ5elnNXkoOrJupmHN5fLT0zLm4BwyydFy4x2+IoZCn9Kr5v2c69BoVYh63 +n749sSmvZ6ES8lgQGVMDMBu4Gon2nL2XA46jCfMdiyHxtN/kHNGfZQIG6lzWE7OE +76KlXIx3KadowGuuQNKotOrN8I1LOJwZmhsoVLiJkO/KdYE+HvJkJMcYr07/R54H +9jVlpNMKVv/1F2Rs76giJUmTtt8AF9pYfl3uxRuw0dFfIRDH+fO6AgonB8Xx1sfT +4PsJYGw= +-----END CERTIFICATE----- + +# Issuer: CN=Amazon Root CA 3 O=Amazon +# Subject: CN=Amazon Root CA 3 O=Amazon +# Label: "Amazon Root CA 3" +# Serial: 143266986699090766294700635381230934788665930 +# MD5 Fingerprint: a0:d4:ef:0b:f7:b5:d8:49:95:2a:ec:f5:c4:fc:81:87 +# SHA1 Fingerprint: 0d:44:dd:8c:3c:8c:1a:1a:58:75:64:81:e9:0f:2e:2a:ff:b3:d2:6e +# SHA256 Fingerprint: 18:ce:6c:fe:7b:f1:4e:60:b2:e3:47:b8:df:e8:68:cb:31:d0:2e:bb:3a:da:27:15:69:f5:03:43:b4:6d:b3:a4 +-----BEGIN CERTIFICATE----- +MIIBtjCCAVugAwIBAgITBmyf1XSXNmY/Owua2eiedgPySjAKBggqhkjOPQQDAjA5 +MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6b24g +Um9vdCBDQSAzMB4XDTE1MDUyNjAwMDAwMFoXDTQwMDUyNjAwMDAwMFowOTELMAkG +A1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJvb3Qg +Q0EgMzBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABCmXp8ZBf8ANm+gBG1bG8lKl +ui2yEujSLtf6ycXYqm0fc4E7O5hrOXwzpcVOho6AF2hiRVd9RFgdszflZwjrZt6j +QjBAMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgGGMB0GA1UdDgQWBBSr +ttvXBp43rDCGB5Fwx5zEGbF4wDAKBggqhkjOPQQDAgNJADBGAiEA4IWSoxe3jfkr +BqWTrBqYaGFy+uGh0PsceGCmQ5nFuMQCIQCcAu/xlJyzlvnrxir4tiz+OpAUFteM +YyRIHN8wfdVoOw== +-----END CERTIFICATE----- + +# Issuer: CN=Amazon Root CA 4 O=Amazon +# Subject: CN=Amazon Root CA 4 O=Amazon +# Label: "Amazon Root CA 4" +# Serial: 143266989758080763974105200630763877849284878 +# MD5 Fingerprint: 89:bc:27:d5:eb:17:8d:06:6a:69:d5:fd:89:47:b4:cd +# SHA1 Fingerprint: f6:10:84:07:d6:f8:bb:67:98:0c:c2:e2:44:c2:eb:ae:1c:ef:63:be +# SHA256 Fingerprint: e3:5d:28:41:9e:d0:20:25:cf:a6:90:38:cd:62:39:62:45:8d:a5:c6:95:fb:de:a3:c2:2b:0b:fb:25:89:70:92 +-----BEGIN CERTIFICATE----- +MIIB8jCCAXigAwIBAgITBmyf18G7EEwpQ+Vxe3ssyBrBDjAKBggqhkjOPQQDAzA5 +MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6b24g +Um9vdCBDQSA0MB4XDTE1MDUyNjAwMDAwMFoXDTQwMDUyNjAwMDAwMFowOTELMAkG +A1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJvb3Qg +Q0EgNDB2MBAGByqGSM49AgEGBSuBBAAiA2IABNKrijdPo1MN/sGKe0uoe0ZLY7Bi +9i0b2whxIdIA6GO9mif78DluXeo9pcmBqqNbIJhFXRbb/egQbeOc4OO9X4Ri83Bk +M6DLJC9wuoihKqB1+IGuYgbEgds5bimwHvouXKNCMEAwDwYDVR0TAQH/BAUwAwEB +/zAOBgNVHQ8BAf8EBAMCAYYwHQYDVR0OBBYEFNPsxzplbszh2naaVvuc84ZtV+WB +MAoGCCqGSM49BAMDA2gAMGUCMDqLIfG9fhGt0O9Yli/W651+kI0rz2ZVwyzjKKlw +CkcO8DdZEv8tmZQoTipPNU0zWgIxAOp1AE47xDqUEpHJWEadIRNyp4iciuRMStuW +1KyLa2tJElMzrdfkviT8tQp21KW8EA== +-----END CERTIFICATE----- + +# Issuer: CN=LuxTrust Global Root 2 O=LuxTrust S.A. +# Subject: CN=LuxTrust Global Root 2 O=LuxTrust S.A. +# Label: "LuxTrust Global Root 2" +# Serial: 59914338225734147123941058376788110305822489521 +# MD5 Fingerprint: b2:e1:09:00:61:af:f7:f1:91:6f:c4:ad:8d:5e:3b:7c +# SHA1 Fingerprint: 1e:0e:56:19:0a:d1:8b:25:98:b2:04:44:ff:66:8a:04:17:99:5f:3f +# SHA256 Fingerprint: 54:45:5f:71:29:c2:0b:14:47:c4:18:f9:97:16:8f:24:c5:8f:c5:02:3b:f5:da:5b:e2:eb:6e:1d:d8:90:2e:d5 +-----BEGIN CERTIFICATE----- +MIIFwzCCA6ugAwIBAgIUCn6m30tEntpqJIWe5rgV0xZ/u7EwDQYJKoZIhvcNAQEL +BQAwRjELMAkGA1UEBhMCTFUxFjAUBgNVBAoMDUx1eFRydXN0IFMuQS4xHzAdBgNV +BAMMFkx1eFRydXN0IEdsb2JhbCBSb290IDIwHhcNMTUwMzA1MTMyMTU3WhcNMzUw +MzA1MTMyMTU3WjBGMQswCQYDVQQGEwJMVTEWMBQGA1UECgwNTHV4VHJ1c3QgUy5B +LjEfMB0GA1UEAwwWTHV4VHJ1c3QgR2xvYmFsIFJvb3QgMjCCAiIwDQYJKoZIhvcN +AQEBBQADggIPADCCAgoCggIBANeFl78RmOnwYoNMPIf5U2o3C/IPPIfOb9wmKb3F +ibrJgz337spbxm1Jc7TJRqMbNBM/wYlFV/TZsfs2ZUv7COJIcRHIbjuend+JZTem +hfY7RBi2xjcwYkSSl2l9QjAk5A0MiWtj3sXh306pFGxT4GHO9hcvHTy95iJMHZP1 +EMShduxq3sVs35a0VkBCwGKSMKEtFZSg0iAGCW5qbeXrt77U8PEVfIvmTroTzEsn +Xpk8F12PgX8zPU/TPxvsXD/wPEx1bvKm1Z3aLQdjAsZy6ZS8TEmVT4hSyNvoaYL4 +zDRbIvCGp4m9SAptZoFtyMhk+wHh9OHe2Z7d21vUKpkmFRseTJIpgp7VkoGSQXAZ +96Tlk0u8d2cx3Rz9MXANF5kM+Qw5GSoXtTBxVdUPrljhPS80m8+f9niFwpN6cj5m +j5wWEWCPnolvZ77gR1o7DJpni89Gxq44o/KnvObWhWszJHAiS8sIm7vI+AIpHb4g +DEa/a4ebsypmQjVGbKq6rfmYe+lQVRQxv7HaLe2ArWgk+2mr2HETMOZns4dA/Yl+ +8kPREd8vZS9kzl8UubG/Mb2HeFpZZYiq/FkySIbWTLkpS5XTdvN3JW1CHDiDTf2j +X5t/Lax5Gw5CMZdjpPuKadUiDTSQMC6otOBttpSsvItO13D8xTiOZCXhTTmQzsmH +hFhxAgMBAAGjgagwgaUwDwYDVR0TAQH/BAUwAwEB/zBCBgNVHSAEOzA5MDcGByuB +KwEBAQowLDAqBggrBgEFBQcCARYeaHR0cHM6Ly9yZXBvc2l0b3J5Lmx1eHRydXN0 +Lmx1MA4GA1UdDwEB/wQEAwIBBjAfBgNVHSMEGDAWgBT/GCh2+UgFLKGu8SsbK7JT ++Et8szAdBgNVHQ4EFgQU/xgodvlIBSyhrvErGyuyU/hLfLMwDQYJKoZIhvcNAQEL +BQADggIBAGoZFO1uecEsh9QNcH7X9njJCwROxLHOk3D+sFTAMs2ZMGQXvw/l4jP9 +BzZAcg4atmpZ1gDlaCDdLnINH2pkMSCEfUmmWjfrRcmF9dTHF5kH5ptV5AzoqbTO +jFu1EVzPig4N1qx3gf4ynCSecs5U89BvolbW7MM3LGVYvlcAGvI1+ut7MV3CwRI9 +loGIlonBWVx65n9wNOeD4rHh4bhY79SV5GCc8JaXcozrhAIuZY+kt9J/Z93I055c +qqmkoCUUBpvsT34tC38ddfEz2O3OuHVtPlu5mB0xDVbYQw8wkbIEa91WvpWAVWe+ +2M2D2RjuLg+GLZKecBPs3lHJQ3gCpU3I+V/EkVhGFndadKpAvAefMLmx9xIX3eP/ +JEAdemrRTxgKqpAd60Ae36EeRJIQmvKN4dFLRp7oRUKX6kWZ8+xm1QL68qZKJKre +zrnK+T+Tb/mjuuqlPpmt/f97mfVl7vBZKGfXkJWkE4SphMHozs51k2MavDzq1WQf +LSoSOcbDWjLtR5EWDrw4wVDej8oqkDQc7kGUnF4ZLvhFSZl0kbAEb+MEWrGrKqv+ +x9CWttrhSmQGbmBNvUJO/3jaJMobtNeWOWyu8Q6qp31IiyBMz2TWuJdGsE7RKlY6 +oJO9r4Ak4Ap+58rVyuiFVdw2KuGUaJPHZnJED4AhMmwlxyOAgwrr +-----END CERTIFICATE----- + +# Issuer: CN=TUBITAK Kamu SM SSL Kok Sertifikasi - Surum 1 O=Turkiye Bilimsel ve Teknolojik Arastirma Kurumu - TUBITAK OU=Kamu Sertifikasyon Merkezi - Kamu SM +# Subject: CN=TUBITAK Kamu SM SSL Kok Sertifikasi - Surum 1 O=Turkiye Bilimsel ve Teknolojik Arastirma Kurumu - TUBITAK OU=Kamu Sertifikasyon Merkezi - Kamu SM +# Label: "TUBITAK Kamu SM SSL Kok Sertifikasi - Surum 1" +# Serial: 1 +# MD5 Fingerprint: dc:00:81:dc:69:2f:3e:2f:b0:3b:f6:3d:5a:91:8e:49 +# SHA1 Fingerprint: 31:43:64:9b:ec:ce:27:ec:ed:3a:3f:0b:8f:0d:e4:e8:91:dd:ee:ca +# SHA256 Fingerprint: 46:ed:c3:68:90:46:d5:3a:45:3f:b3:10:4a:b8:0d:ca:ec:65:8b:26:60:ea:16:29:dd:7e:86:79:90:64:87:16 +-----BEGIN CERTIFICATE----- +MIIEYzCCA0ugAwIBAgIBATANBgkqhkiG9w0BAQsFADCB0jELMAkGA1UEBhMCVFIx +GDAWBgNVBAcTD0dlYnplIC0gS29jYWVsaTFCMEAGA1UEChM5VHVya2l5ZSBCaWxp +bXNlbCB2ZSBUZWtub2xvamlrIEFyYXN0aXJtYSBLdXJ1bXUgLSBUVUJJVEFLMS0w +KwYDVQQLEyRLYW11IFNlcnRpZmlrYXN5b24gTWVya2V6aSAtIEthbXUgU00xNjA0 +BgNVBAMTLVRVQklUQUsgS2FtdSBTTSBTU0wgS29rIFNlcnRpZmlrYXNpIC0gU3Vy +dW0gMTAeFw0xMzExMjUwODI1NTVaFw00MzEwMjUwODI1NTVaMIHSMQswCQYDVQQG +EwJUUjEYMBYGA1UEBxMPR2ViemUgLSBLb2NhZWxpMUIwQAYDVQQKEzlUdXJraXll +IEJpbGltc2VsIHZlIFRla25vbG9qaWsgQXJhc3Rpcm1hIEt1cnVtdSAtIFRVQklU +QUsxLTArBgNVBAsTJEthbXUgU2VydGlmaWthc3lvbiBNZXJrZXppIC0gS2FtdSBT +TTE2MDQGA1UEAxMtVFVCSVRBSyBLYW11IFNNIFNTTCBLb2sgU2VydGlmaWthc2kg +LSBTdXJ1bSAxMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr3UwM6q7 +a9OZLBI3hNmNe5eA027n/5tQlT6QlVZC1xl8JoSNkvoBHToP4mQ4t4y86Ij5iySr +LqP1N+RAjhgleYN1Hzv/bKjFxlb4tO2KRKOrbEz8HdDc72i9z+SqzvBV96I01INr +N3wcwv61A+xXzry0tcXtAA9TNypN9E8Mg/uGz8v+jE69h/mniyFXnHrfA2eJLJ2X +YacQuFWQfw4tJzh03+f92k4S400VIgLI4OD8D62K18lUUMw7D8oWgITQUVbDjlZ/ +iSIzL+aFCr2lqBs23tPcLG07xxO9WSMs5uWk99gL7eqQQESolbuT1dCANLZGeA4f +AJNG4e7p+exPFwIDAQABo0IwQDAdBgNVHQ4EFgQUZT/HiobGPN08VFw1+DrtUgxH +V8gwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQEL +BQADggEBACo/4fEyjq7hmFxLXs9rHmoJ0iKpEsdeV31zVmSAhHqT5Am5EM2fKifh +AHe+SMg1qIGf5LgsyX8OsNJLN13qudULXjS99HMpw+0mFZx+CFOKWI3QSyjfwbPf +IPP54+M638yclNhOT8NrF7f3cuitZjO1JVOr4PhMqZ398g26rrnZqsZr+ZO7rqu4 +lzwDGrpDxpa5RXI4s6ehlj2Re37AIVNMh+3yC1SVUZPVIqUNivGTDj5UDrDYyU7c +8jEyVupk+eq1nRZmQnLzf9OxMUP8pI4X8W0jq5Rm+K37DwhuJi1/FwcJsoz7UMCf +lo3Ptv0AnVoUmr8CRPXBwp8iXqIPoeM= +-----END CERTIFICATE----- + +# Issuer: CN=GDCA TrustAUTH R5 ROOT O=GUANG DONG CERTIFICATE AUTHORITY CO.,LTD. +# Subject: CN=GDCA TrustAUTH R5 ROOT O=GUANG DONG CERTIFICATE AUTHORITY CO.,LTD. +# Label: "GDCA TrustAUTH R5 ROOT" +# Serial: 9009899650740120186 +# MD5 Fingerprint: 63:cc:d9:3d:34:35:5c:6f:53:a3:e2:08:70:48:1f:b4 +# SHA1 Fingerprint: 0f:36:38:5b:81:1a:25:c3:9b:31:4e:83:ca:e9:34:66:70:cc:74:b4 +# SHA256 Fingerprint: bf:ff:8f:d0:44:33:48:7d:6a:8a:a6:0c:1a:29:76:7a:9f:c2:bb:b0:5e:42:0f:71:3a:13:b9:92:89:1d:38:93 +-----BEGIN CERTIFICATE----- +MIIFiDCCA3CgAwIBAgIIfQmX/vBH6nowDQYJKoZIhvcNAQELBQAwYjELMAkGA1UE +BhMCQ04xMjAwBgNVBAoMKUdVQU5HIERPTkcgQ0VSVElGSUNBVEUgQVVUSE9SSVRZ +IENPLixMVEQuMR8wHQYDVQQDDBZHRENBIFRydXN0QVVUSCBSNSBST09UMB4XDTE0 +MTEyNjA1MTMxNVoXDTQwMTIzMTE1NTk1OVowYjELMAkGA1UEBhMCQ04xMjAwBgNV +BAoMKUdVQU5HIERPTkcgQ0VSVElGSUNBVEUgQVVUSE9SSVRZIENPLixMVEQuMR8w +HQYDVQQDDBZHRENBIFRydXN0QVVUSCBSNSBST09UMIICIjANBgkqhkiG9w0BAQEF +AAOCAg8AMIICCgKCAgEA2aMW8Mh0dHeb7zMNOwZ+Vfy1YI92hhJCfVZmPoiC7XJj +Dp6L3TQsAlFRwxn9WVSEyfFrs0yw6ehGXTjGoqcuEVe6ghWinI9tsJlKCvLriXBj +TnnEt1u9ol2x8kECK62pOqPseQrsXzrj/e+APK00mxqriCZ7VqKChh/rNYmDf1+u +KU49tm7srsHwJ5uu4/Ts765/94Y9cnrrpftZTqfrlYwiOXnhLQiPzLyRuEH3FMEj +qcOtmkVEs7LXLM3GKeJQEK5cy4KOFxg2fZfmiJqwTTQJ9Cy5WmYqsBebnh52nUpm +MUHfP/vFBu8btn4aRjb3ZGM74zkYI+dndRTVdVeSN72+ahsmUPI2JgaQxXABZG12 +ZuGR224HwGGALrIuL4xwp9E7PLOR5G62xDtw8mySlwnNR30YwPO7ng/Wi64HtloP +zgsMR6flPri9fcebNaBhlzpBdRfMK5Z3KpIhHtmVdiBnaM8Nvd/WHwlqmuLMc3Gk +L30SgLdTMEZeS1SZD2fJpcjyIMGC7J0R38IC+xo70e0gmu9lZJIQDSri3nDxGGeC +jGHeuLzRL5z7D9Ar7Rt2ueQ5Vfj4oR24qoAATILnsn8JuLwwoC8N9VKejveSswoA +HQBUlwbgsQfZxw9cZX08bVlX5O2ljelAU58VS6Bx9hoh49pwBiFYFIeFd3mqgnkC +AwEAAaNCMEAwHQYDVR0OBBYEFOLJQJ9NzuiaoXzPDj9lxSmIahlRMA8GA1UdEwEB +/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgGGMA0GCSqGSIb3DQEBCwUAA4ICAQDRSVfg +p8xoWLoBDysZzY2wYUWsEe1jUGn4H3++Fo/9nesLqjJHdtJnJO29fDMylyrHBYZm +DRd9FBUb1Ov9H5r2XpdptxolpAqzkT9fNqyL7FeoPueBihhXOYV0GkLH6VsTX4/5 +COmSdI31R9KrO9b7eGZONn356ZLpBN79SWP8bfsUcZNnL0dKt7n/HipzcEYwv1ry +L3ml4Y0M2fmyYzeMN2WFcGpcWwlyua1jPLHd+PwyvzeG5LuOmCd+uh8W4XAR8gPf +JWIyJyYYMoSf/wA6E7qaTfRPuBRwIrHKK5DOKcFw9C+df/KQHtZa37dG/OaG+svg +IHZ6uqbL9XzeYqWxi+7egmaKTjowHz+Ay60nugxe19CxVsp3cbK1daFQqUBDF8Io +2c9Si1vIY9RCPqAzekYu9wogRlR+ak8x8YF+QnQ4ZXMn7sZ8uI7XpTrXmKGcjBBV +09tL7ECQ8s1uV9JiDnxXk7Gnbc2dg7sq5+W2O3FYrf3RRbxake5TFW/TRQl1brqQ +XR4EzzffHqhmsYzmIGrv/EhOdJhCrylvLmrH+33RZjEizIYAfmaDDEL0vTSSwxrq +T8p+ck0LcIymSLumoRT2+1hEmRSuqguTaaApJUqlyyvdimYHFngVV3Eb7PVHhPOe +MTd61X8kreS8/f3MboPoDKi3QWwH3b08hpcv0g== +-----END CERTIFICATE----- + +# Issuer: CN=TrustCor RootCert CA-1 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Subject: CN=TrustCor RootCert CA-1 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Label: "TrustCor RootCert CA-1" +# Serial: 15752444095811006489 +# MD5 Fingerprint: 6e:85:f1:dc:1a:00:d3:22:d5:b2:b2:ac:6b:37:05:45 +# SHA1 Fingerprint: ff:bd:cd:e7:82:c8:43:5e:3c:6f:26:86:5c:ca:a8:3a:45:5b:c3:0a +# SHA256 Fingerprint: d4:0e:9c:86:cd:8f:e4:68:c1:77:69:59:f4:9e:a7:74:fa:54:86:84:b6:c4:06:f3:90:92:61:f4:dc:e2:57:5c +-----BEGIN CERTIFICATE----- +MIIEMDCCAxigAwIBAgIJANqb7HHzA7AZMA0GCSqGSIb3DQEBCwUAMIGkMQswCQYD +VQQGEwJQQTEPMA0GA1UECAwGUGFuYW1hMRQwEgYDVQQHDAtQYW5hbWEgQ2l0eTEk +MCIGA1UECgwbVHJ1c3RDb3IgU3lzdGVtcyBTLiBkZSBSLkwuMScwJQYDVQQLDB5U +cnVzdENvciBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxHzAdBgNVBAMMFlRydXN0Q29y +IFJvb3RDZXJ0IENBLTEwHhcNMTYwMjA0MTIzMjE2WhcNMjkxMjMxMTcyMzE2WjCB +pDELMAkGA1UEBhMCUEExDzANBgNVBAgMBlBhbmFtYTEUMBIGA1UEBwwLUGFuYW1h +IENpdHkxJDAiBgNVBAoMG1RydXN0Q29yIFN5c3RlbXMgUy4gZGUgUi5MLjEnMCUG +A1UECwweVHJ1c3RDb3IgQ2VydGlmaWNhdGUgQXV0aG9yaXR5MR8wHQYDVQQDDBZU +cnVzdENvciBSb290Q2VydCBDQS0xMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB +CgKCAQEAv463leLCJhJrMxnHQFgKq1mqjQCj/IDHUHuO1CAmujIS2CNUSSUQIpid +RtLByZ5OGy4sDjjzGiVoHKZaBeYei0i/mJZ0PmnK6bV4pQa81QBeCQryJ3pS/C3V +seq0iWEk8xoT26nPUu0MJLq5nux+AHT6k61sKZKuUbS701e/s/OojZz0JEsq1pme +9J7+wH5COucLlVPat2gOkEz7cD+PSiyU8ybdY2mplNgQTsVHCJCZGxdNuWxu72CV +EY4hgLW9oHPY0LJ3xEXqWib7ZnZ2+AYfYW0PVcWDtxBWcgYHpfOxGgMFZA6dWorW +hnAbJN7+KIor0Gqw/Hqi3LJ5DotlDwIDAQABo2MwYTAdBgNVHQ4EFgQU7mtJPHo/ +DeOxCbeKyKsZn3MzUOcwHwYDVR0jBBgwFoAU7mtJPHo/DeOxCbeKyKsZn3MzUOcw +DwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQAD +ggEBACUY1JGPE+6PHh0RU9otRCkZoB5rMZ5NDp6tPVxBb5UrJKF5mDo4Nvu7Zp5I +/5CQ7z3UuJu0h3U/IJvOcs+hVcFNZKIZBqEHMwwLKeXx6quj7LUKdJDHfXLy11yf +ke+Ri7fc7Waiz45mO7yfOgLgJ90WmMCV1Aqk5IGadZQ1nJBfiDcGrVmVCrDRZ9MZ +yonnMlo2HD6CqFqTvsbQZJG2z9m2GM/bftJlo6bEjhcxwft+dtvTheNYsnd6djts +L1Ac59v2Z3kf9YKVmgenFK+P3CghZwnS1k1aHBkcjndcw5QkPTJrS37UeJSDvjdN +zl/HHk484IkzlQsPpTLWPFp5LBk= +-----END CERTIFICATE----- + +# Issuer: CN=TrustCor RootCert CA-2 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Subject: CN=TrustCor RootCert CA-2 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Label: "TrustCor RootCert CA-2" +# Serial: 2711694510199101698 +# MD5 Fingerprint: a2:e1:f8:18:0b:ba:45:d5:c7:41:2a:bb:37:52:45:64 +# SHA1 Fingerprint: b8:be:6d:cb:56:f1:55:b9:63:d4:12:ca:4e:06:34:c7:94:b2:1c:c0 +# SHA256 Fingerprint: 07:53:e9:40:37:8c:1b:d5:e3:83:6e:39:5d:ae:a5:cb:83:9e:50:46:f1:bd:0e:ae:19:51:cf:10:fe:c7:c9:65 +-----BEGIN CERTIFICATE----- +MIIGLzCCBBegAwIBAgIIJaHfyjPLWQIwDQYJKoZIhvcNAQELBQAwgaQxCzAJBgNV +BAYTAlBBMQ8wDQYDVQQIDAZQYW5hbWExFDASBgNVBAcMC1BhbmFtYSBDaXR5MSQw +IgYDVQQKDBtUcnVzdENvciBTeXN0ZW1zIFMuIGRlIFIuTC4xJzAlBgNVBAsMHlRy +dXN0Q29yIENlcnRpZmljYXRlIEF1dGhvcml0eTEfMB0GA1UEAwwWVHJ1c3RDb3Ig +Um9vdENlcnQgQ0EtMjAeFw0xNjAyMDQxMjMyMjNaFw0zNDEyMzExNzI2MzlaMIGk +MQswCQYDVQQGEwJQQTEPMA0GA1UECAwGUGFuYW1hMRQwEgYDVQQHDAtQYW5hbWEg +Q2l0eTEkMCIGA1UECgwbVHJ1c3RDb3IgU3lzdGVtcyBTLiBkZSBSLkwuMScwJQYD +VQQLDB5UcnVzdENvciBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxHzAdBgNVBAMMFlRy +dXN0Q29yIFJvb3RDZXJ0IENBLTIwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIK +AoICAQCnIG7CKqJiJJWQdsg4foDSq8GbZQWU9MEKENUCrO2fk8eHyLAnK0IMPQo+ +QVqedd2NyuCb7GgypGmSaIwLgQ5WoD4a3SwlFIIvl9NkRvRUqdw6VC0xK5mC8tkq +1+9xALgxpL56JAfDQiDyitSSBBtlVkxs1Pu2YVpHI7TYabS3OtB0PAx1oYxOdqHp +2yqlO/rOsP9+aij9JxzIsekp8VduZLTQwRVtDr4uDkbIXvRR/u8OYzo7cbrPb1nK +DOObXUm4TOJXsZiKQlecdu/vvdFoqNL0Cbt3Nb4lggjEFixEIFapRBF37120Hape +az6LMvYHL1cEksr1/p3C6eizjkxLAjHZ5DxIgif3GIJ2SDpxsROhOdUuxTTCHWKF +3wP+TfSvPd9cW436cOGlfifHhi5qjxLGhF5DUVCcGZt45vz27Ud+ez1m7xMTiF88 +oWP7+ayHNZ/zgp6kPwqcMWmLmaSISo5uZk3vFsQPeSghYA2FFn3XVDjxklb9tTNM +g9zXEJ9L/cb4Qr26fHMC4P99zVvh1Kxhe1fVSntb1IVYJ12/+CtgrKAmrhQhJ8Z3 +mjOAPF5GP/fDsaOGM8boXg25NSyqRsGFAnWAoOsk+xWq5Gd/bnc/9ASKL3x74xdh +8N0JqSDIvgmk0H5Ew7IwSjiqqewYmgeCK9u4nBit2uBGF6zPXQIDAQABo2MwYTAd +BgNVHQ4EFgQU2f4hQG6UnrybPZx9mCAZ5YwwYrIwHwYDVR0jBBgwFoAU2f4hQG6U +nrybPZx9mCAZ5YwwYrIwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYw +DQYJKoZIhvcNAQELBQADggIBAJ5Fngw7tu/hOsh80QA9z+LqBrWyOrsGS2h60COX +dKcs8AjYeVrXWoSK2BKaG9l9XE1wxaX5q+WjiYndAfrs3fnpkpfbsEZC89NiqpX+ +MWcUaViQCqoL7jcjx1BRtPV+nuN79+TMQjItSQzL/0kMmx40/W5ulop5A7Zv2wnL +/V9lFDfhOPXzYRZY5LVtDQsEGz9QLX+zx3oaFoBg+Iof6Rsqxvm6ARppv9JYx1RX +CI/hOWB3S6xZhBqI8d3LT3jX5+EzLfzuQfogsL7L9ziUwOHQhQ+77Sxzq+3+knYa +ZH9bDTMJBzN7Bj8RpFxwPIXAz+OQqIN3+tvmxYxoZxBnpVIt8MSZj3+/0WvitUfW +2dCFmU2Umw9Lje4AWkcdEQOsQRivh7dvDDqPys/cA8GiCcjl/YBeyGBCARsaU1q7 +N6a3vLqE6R5sGtRk2tRD/pOLS/IseRYQ1JMLiI+h2IYURpFHmygk71dSTlxCnKr3 +Sewn6EAes6aJInKc9Q0ztFijMDvd1GpUk74aTfOTlPf8hAs/hCBcNANExdqtvArB +As8e5ZTZ845b2EzwnexhF7sUMlQMAimTHpKG9n/v55IFDlndmQguLvqcAFLTxWYp +5KeXRKQOKIETNcX2b2TmQcTVL8w0RSXPQQCWPUouwpaYT05KnJe32x+SMsj/D1Fu +1uwJ +-----END CERTIFICATE----- + +# Issuer: CN=TrustCor ECA-1 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Subject: CN=TrustCor ECA-1 O=TrustCor Systems S. de R.L. OU=TrustCor Certificate Authority +# Label: "TrustCor ECA-1" +# Serial: 9548242946988625984 +# MD5 Fingerprint: 27:92:23:1d:0a:f5:40:7c:e9:e6:6b:9d:d8:f5:e7:6c +# SHA1 Fingerprint: 58:d1:df:95:95:67:6b:63:c0:f0:5b:1c:17:4d:8b:84:0b:c8:78:bd +# SHA256 Fingerprint: 5a:88:5d:b1:9c:01:d9:12:c5:75:93:88:93:8c:af:bb:df:03:1a:b2:d4:8e:91:ee:15:58:9b:42:97:1d:03:9c +-----BEGIN CERTIFICATE----- +MIIEIDCCAwigAwIBAgIJAISCLF8cYtBAMA0GCSqGSIb3DQEBCwUAMIGcMQswCQYD +VQQGEwJQQTEPMA0GA1UECAwGUGFuYW1hMRQwEgYDVQQHDAtQYW5hbWEgQ2l0eTEk +MCIGA1UECgwbVHJ1c3RDb3IgU3lzdGVtcyBTLiBkZSBSLkwuMScwJQYDVQQLDB5U +cnVzdENvciBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkxFzAVBgNVBAMMDlRydXN0Q29y +IEVDQS0xMB4XDTE2MDIwNDEyMzIzM1oXDTI5MTIzMTE3MjgwN1owgZwxCzAJBgNV +BAYTAlBBMQ8wDQYDVQQIDAZQYW5hbWExFDASBgNVBAcMC1BhbmFtYSBDaXR5MSQw +IgYDVQQKDBtUcnVzdENvciBTeXN0ZW1zIFMuIGRlIFIuTC4xJzAlBgNVBAsMHlRy +dXN0Q29yIENlcnRpZmljYXRlIEF1dGhvcml0eTEXMBUGA1UEAwwOVHJ1c3RDb3Ig +RUNBLTEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDPj+ARtZ+odnbb +3w9U73NjKYKtR8aja+3+XzP4Q1HpGjORMRegdMTUpwHmspI+ap3tDvl0mEDTPwOA +BoJA6LHip1GnHYMma6ve+heRK9jGrB6xnhkB1Zem6g23xFUfJ3zSCNV2HykVh0A5 +3ThFEXXQmqc04L/NyFIduUd+Dbi7xgz2c1cWWn5DkR9VOsZtRASqnKmcp0yJF4Ou +owReUoCLHhIlERnXDH19MURB6tuvsBzvgdAsxZohmz3tQjtQJvLsznFhBmIhVE5/ +wZ0+fyCMgMsq2JdiyIMzkX2woloPV+g7zPIlstR8L+xNxqE6FXrntl019fZISjZF +ZtS6mFjBAgMBAAGjYzBhMB0GA1UdDgQWBBREnkj1zG1I1KBLf/5ZJC+Dl5mahjAf +BgNVHSMEGDAWgBREnkj1zG1I1KBLf/5ZJC+Dl5mahjAPBgNVHRMBAf8EBTADAQH/ +MA4GA1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAQEABT41XBVwm8nHc2Fv +civUwo/yQ10CzsSUuZQRg2dd4mdsdXa/uwyqNsatR5Nj3B5+1t4u/ukZMjgDfxT2 +AHMsWbEhBuH7rBiVDKP/mZb3Kyeb1STMHd3BOuCYRLDE5D53sXOpZCz2HAF8P11F +hcCF5yWPldwX8zyfGm6wyuMdKulMY/okYWLW2n62HGz1Ah3UKt1VkOsqEUc8Ll50 +soIipX1TH0XsJ5F95yIW6MBoNtjG8U+ARDL54dHRHareqKucBK+tIA5kmE2la8BI +WJZpTdwHjFGTot+fDz2LYLSCjaoITmJF4PkL0uDgPFveXHEnJcLmA4GLEFPjx1Wi +tJ/X5g== +-----END CERTIFICATE----- + +# Issuer: CN=SSL.com Root Certification Authority RSA O=SSL Corporation +# Subject: CN=SSL.com Root Certification Authority RSA O=SSL Corporation +# Label: "SSL.com Root Certification Authority RSA" +# Serial: 8875640296558310041 +# MD5 Fingerprint: 86:69:12:c0:70:f1:ec:ac:ac:c2:d5:bc:a5:5b:a1:29 +# SHA1 Fingerprint: b7:ab:33:08:d1:ea:44:77:ba:14:80:12:5a:6f:bd:a9:36:49:0c:bb +# SHA256 Fingerprint: 85:66:6a:56:2e:e0:be:5c:e9:25:c1:d8:89:0a:6f:76:a8:7e:c1:6d:4d:7d:5f:29:ea:74:19:cf:20:12:3b:69 +-----BEGIN CERTIFICATE----- +MIIF3TCCA8WgAwIBAgIIeyyb0xaAMpkwDQYJKoZIhvcNAQELBQAwfDELMAkGA1UE +BhMCVVMxDjAMBgNVBAgMBVRleGFzMRAwDgYDVQQHDAdIb3VzdG9uMRgwFgYDVQQK +DA9TU0wgQ29ycG9yYXRpb24xMTAvBgNVBAMMKFNTTC5jb20gUm9vdCBDZXJ0aWZp +Y2F0aW9uIEF1dGhvcml0eSBSU0EwHhcNMTYwMjEyMTczOTM5WhcNNDEwMjEyMTcz +OTM5WjB8MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hv +dXN0b24xGDAWBgNVBAoMD1NTTCBDb3Jwb3JhdGlvbjExMC8GA1UEAwwoU1NMLmNv +bSBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IFJTQTCCAiIwDQYJKoZIhvcN +AQEBBQADggIPADCCAgoCggIBAPkP3aMrfcvQKv7sZ4Wm5y4bunfh4/WvpOz6Sl2R +xFdHaxh3a3by/ZPkPQ/CFp4LZsNWlJ4Xg4XOVu/yFv0AYvUiCVToZRdOQbngT0aX +qhvIuG5iXmmxX9sqAn78bMrzQdjt0Oj8P2FI7bADFB0QDksZ4LtO7IZl/zbzXmcC +C52GVWH9ejjt/uIZALdvoVBidXQ8oPrIJZK0bnoix/geoeOy3ZExqysdBP+lSgQ3 +6YWkMyv94tZVNHwZpEpox7Ko07fKoZOI68GXvIz5HdkihCR0xwQ9aqkpk8zruFvh +/l8lqjRYyMEjVJ0bmBHDOJx+PYZspQ9AhnwC9FwCTyjLrnGfDzrIM/4RJTXq/LrF +YD3ZfBjVsqnTdXgDciLKOsMf7yzlLqn6niy2UUb9rwPW6mBo6oUWNmuF6R7As93E +JNyAKoFBbZQ+yODJgUEAnl6/f8UImKIYLEJAs/lvOCdLToD0PYFH4Ih86hzOtXVc +US4cK38acijnALXRdMbX5J+tB5O2UzU1/Dfkw/ZdFr4hc96SCvigY2q8lpJqPvi8 +ZVWb3vUNiSYE/CUapiVpy8JtynziWV+XrOvvLsi81xtZPCvM8hnIk2snYxnP/Okm ++Mpxm3+T/jRnhE6Z6/yzeAkzcLpmpnbtG3PrGqUNxCITIJRWCk4sbE6x/c+cCbqi +M+2HAgMBAAGjYzBhMB0GA1UdDgQWBBTdBAkHovV6fVJTEpKV7jiAJQ2mWTAPBgNV +HRMBAf8EBTADAQH/MB8GA1UdIwQYMBaAFN0ECQei9Xp9UlMSkpXuOIAlDaZZMA4G +A1UdDwEB/wQEAwIBhjANBgkqhkiG9w0BAQsFAAOCAgEAIBgRlCn7Jp0cHh5wYfGV +cpNxJK1ok1iOMq8bs3AD/CUrdIWQPXhq9LmLpZc7tRiRux6n+UBbkflVma8eEdBc +Hadm47GUBwwyOabqG7B52B2ccETjit3E+ZUfijhDPwGFpUenPUayvOUiaPd7nNgs +PgohyC0zrL/FgZkxdMF1ccW+sfAjRfSda/wZY52jvATGGAslu1OJD7OAUN5F7kR/ +q5R4ZJjT9ijdh9hwZXT7DrkT66cPYakylszeu+1jTBi7qUD3oFRuIIhxdRjqerQ0 +cuAjJ3dctpDqhiVAq+8zD8ufgr6iIPv2tS0a5sKFsXQP+8hlAqRSAUfdSSLBv9jr +a6x+3uxjMxW3IwiPxg+NQVrdjsW5j+VFP3jbutIbQLH+cU0/4IGiul607BXgk90I +H37hVZkLId6Tngr75qNJvTYw/ud3sqB1l7UtgYgXZSD32pAAn8lSzDLKNXz1PQ/Y +K9f1JmzJBjSWFupwWRoyeXkLtoh/D1JIPb9s2KJELtFOt3JY04kTlf5Eq/jXixtu +nLwsoFvVagCvXzfh1foQC5ichucmj87w7G6KVwuA406ywKBjYZC6VWg3dGq2ktuf +oYYitmUnDuy2n0Jg5GfCtdpBC8TTi2EbvPofkSvXRAdeuims2cXp71NIWuuA8ShY +Ic2wBlX7Jz9TkHCpBB5XJ7k= +-----END CERTIFICATE----- + +# Issuer: CN=SSL.com Root Certification Authority ECC O=SSL Corporation +# Subject: CN=SSL.com Root Certification Authority ECC O=SSL Corporation +# Label: "SSL.com Root Certification Authority ECC" +# Serial: 8495723813297216424 +# MD5 Fingerprint: 2e:da:e4:39:7f:9c:8f:37:d1:70:9f:26:17:51:3a:8e +# SHA1 Fingerprint: c3:19:7c:39:24:e6:54:af:1b:c4:ab:20:95:7a:e2:c3:0e:13:02:6a +# SHA256 Fingerprint: 34:17:bb:06:cc:60:07:da:1b:96:1c:92:0b:8a:b4:ce:3f:ad:82:0e:4a:a3:0b:9a:cb:c4:a7:4e:bd:ce:bc:65 +-----BEGIN CERTIFICATE----- +MIICjTCCAhSgAwIBAgIIdebfy8FoW6gwCgYIKoZIzj0EAwIwfDELMAkGA1UEBhMC +VVMxDjAMBgNVBAgMBVRleGFzMRAwDgYDVQQHDAdIb3VzdG9uMRgwFgYDVQQKDA9T +U0wgQ29ycG9yYXRpb24xMTAvBgNVBAMMKFNTTC5jb20gUm9vdCBDZXJ0aWZpY2F0 +aW9uIEF1dGhvcml0eSBFQ0MwHhcNMTYwMjEyMTgxNDAzWhcNNDEwMjEyMTgxNDAz +WjB8MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hvdXN0 +b24xGDAWBgNVBAoMD1NTTCBDb3Jwb3JhdGlvbjExMC8GA1UEAwwoU1NMLmNvbSBS +b290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IEVDQzB2MBAGByqGSM49AgEGBSuB +BAAiA2IABEVuqVDEpiM2nl8ojRfLliJkP9x6jh3MCLOicSS6jkm5BBtHllirLZXI +7Z4INcgn64mMU1jrYor+8FsPazFSY0E7ic3s7LaNGdM0B9y7xgZ/wkWV7Mt/qCPg +CemB+vNH06NjMGEwHQYDVR0OBBYEFILRhXMw5zUE044CkvvlpNHEIejNMA8GA1Ud +EwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUgtGFczDnNQTTjgKS++Wk0cQh6M0wDgYD +VR0PAQH/BAQDAgGGMAoGCCqGSM49BAMCA2cAMGQCMG/n61kRpGDPYbCWe+0F+S8T +kdzt5fxQaxFGRrMcIQBiu77D5+jNB5n5DQtdcj7EqgIwH7y6C+IwJPt8bYBVCpk+ +gA0z5Wajs6O7pdWLjwkspl1+4vAHCGht0nxpbl/f5Wpl +-----END CERTIFICATE----- + +# Issuer: CN=SSL.com EV Root Certification Authority RSA R2 O=SSL Corporation +# Subject: CN=SSL.com EV Root Certification Authority RSA R2 O=SSL Corporation +# Label: "SSL.com EV Root Certification Authority RSA R2" +# Serial: 6248227494352943350 +# MD5 Fingerprint: e1:1e:31:58:1a:ae:54:53:02:f6:17:6a:11:7b:4d:95 +# SHA1 Fingerprint: 74:3a:f0:52:9b:d0:32:a0:f4:4a:83:cd:d4:ba:a9:7b:7c:2e:c4:9a +# SHA256 Fingerprint: 2e:7b:f1:6c:c2:24:85:a7:bb:e2:aa:86:96:75:07:61:b0:ae:39:be:3b:2f:e9:d0:cc:6d:4e:f7:34:91:42:5c +-----BEGIN CERTIFICATE----- +MIIF6zCCA9OgAwIBAgIIVrYpzTS8ePYwDQYJKoZIhvcNAQELBQAwgYIxCzAJBgNV +BAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4GA1UEBwwHSG91c3RvbjEYMBYGA1UE +CgwPU1NMIENvcnBvcmF0aW9uMTcwNQYDVQQDDC5TU0wuY29tIEVWIFJvb3QgQ2Vy +dGlmaWNhdGlvbiBBdXRob3JpdHkgUlNBIFIyMB4XDTE3MDUzMTE4MTQzN1oXDTQy +MDUzMDE4MTQzN1owgYIxCzAJBgNVBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEQMA4G +A1UEBwwHSG91c3RvbjEYMBYGA1UECgwPU1NMIENvcnBvcmF0aW9uMTcwNQYDVQQD +DC5TU0wuY29tIEVWIFJvb3QgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkgUlNBIFIy +MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAjzZlQOHWTcDXtOlG2mvq +M0fNTPl9fb69LT3w23jhhqXZuglXaO1XPqDQCEGD5yhBJB/jchXQARr7XnAjssuf +OePPxU7Gkm0mxnu7s9onnQqG6YE3Bf7wcXHswxzpY6IXFJ3vG2fThVUCAtZJycxa +4bH3bzKfydQ7iEGonL3Lq9ttewkfokxykNorCPzPPFTOZw+oz12WGQvE43LrrdF9 +HSfvkusQv1vrO6/PgN3B0pYEW3p+pKk8OHakYo6gOV7qd89dAFmPZiw+B6KjBSYR +aZfqhbcPlgtLyEDhULouisv3D5oi53+aNxPN8k0TayHRwMwi8qFG9kRpnMphNQcA +b9ZhCBHqurj26bNg5U257J8UZslXWNvNh2n4ioYSA0e/ZhN2rHd9NCSFg83XqpyQ +Gp8hLH94t2S42Oim9HizVcuE0jLEeK6jj2HdzghTreyI/BXkmg3mnxp3zkyPuBQV +PWKchjgGAGYS5Fl2WlPAApiiECtoRHuOec4zSnaqW4EWG7WK2NAAe15itAnWhmMO +pgWVSbooi4iTsjQc2KRVbrcc0N6ZVTsj9CLg+SlmJuwgUHfbSguPvuUCYHBBXtSu +UDkiFCbLsjtzdFVHB3mBOagwE0TlBIqulhMlQg+5U8Sb/M3kHN48+qvWBkofZ6aY +MBzdLNvcGJVXZsb/XItW9XcCAwEAAaNjMGEwDwYDVR0TAQH/BAUwAwEB/zAfBgNV +HSMEGDAWgBT5YLvU49U09rj1BoAlp3PbRmmonjAdBgNVHQ4EFgQU+WC71OPVNPa4 +9QaAJadz20ZpqJ4wDgYDVR0PAQH/BAQDAgGGMA0GCSqGSIb3DQEBCwUAA4ICAQBW +s47LCp1Jjr+kxJG7ZhcFUZh1++VQLHqe8RT6q9OKPv+RKY9ji9i0qVQBDb6Thi/5 +Sm3HXvVX+cpVHBK+Rw82xd9qt9t1wkclf7nxY/hoLVUE0fKNsKTPvDxeH3jnpaAg +cLAExbf3cqfeIg29MyVGjGSSJuM+LmOW2puMPfgYCdcDzH2GguDKBAdRUNf/ktUM +79qGn5nX67evaOI5JpS6aLe/g9Pqemc9YmeuJeVy6OLk7K4S9ksrPJ/psEDzOFSz +/bdoyNrGj1E8svuR3Bznm53htw1yj+KkxKl4+esUrMZDBcJlOSgYAsOCsp0FvmXt +ll9ldDz7CTUue5wT/RsPXcdtgTpWD8w74a8CLyKsRspGPKAcTNZEtF4uXBVmCeEm +Kf7GUmG6sXP/wwyc5WxqlD8UykAWlYTzWamsX0xhk23RO8yilQwipmdnRC652dKK +QbNmC1r7fSOl8hqw/96bg5Qu0T/fkreRrwU7ZcegbLHNYhLDkBvjJc40vG93drEQ +w/cFGsDWr3RiSBd3kmmQYRzelYB0VI8YHMPzA9C/pEN1hlMYegouCRw2n5H9gooi +S9EOUCXdywMMF8mDAAhONU2Ki+3wApRmLER/y5UnlhetCTCstnEXbosX9hwJ1C07 +mKVx01QT2WDz9UtmT/rx7iASjbSsV7FFY6GsdqnC+w== +-----END CERTIFICATE----- + +# Issuer: CN=SSL.com EV Root Certification Authority ECC O=SSL Corporation +# Subject: CN=SSL.com EV Root Certification Authority ECC O=SSL Corporation +# Label: "SSL.com EV Root Certification Authority ECC" +# Serial: 3182246526754555285 +# MD5 Fingerprint: 59:53:22:65:83:42:01:54:c0:ce:42:b9:5a:7c:f2:90 +# SHA1 Fingerprint: 4c:dd:51:a3:d1:f5:20:32:14:b0:c6:c5:32:23:03:91:c7:46:42:6d +# SHA256 Fingerprint: 22:a2:c1:f7:bd:ed:70:4c:c1:e7:01:b5:f4:08:c3:10:88:0f:e9:56:b5:de:2a:4a:44:f9:9c:87:3a:25:a7:c8 +-----BEGIN CERTIFICATE----- +MIIClDCCAhqgAwIBAgIILCmcWxbtBZUwCgYIKoZIzj0EAwIwfzELMAkGA1UEBhMC +VVMxDjAMBgNVBAgMBVRleGFzMRAwDgYDVQQHDAdIb3VzdG9uMRgwFgYDVQQKDA9T +U0wgQ29ycG9yYXRpb24xNDAyBgNVBAMMK1NTTC5jb20gRVYgUm9vdCBDZXJ0aWZp +Y2F0aW9uIEF1dGhvcml0eSBFQ0MwHhcNMTYwMjEyMTgxNTIzWhcNNDEwMjEyMTgx +NTIzWjB/MQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxEDAOBgNVBAcMB0hv +dXN0b24xGDAWBgNVBAoMD1NTTCBDb3Jwb3JhdGlvbjE0MDIGA1UEAwwrU1NMLmNv +bSBFViBSb290IENlcnRpZmljYXRpb24gQXV0aG9yaXR5IEVDQzB2MBAGByqGSM49 +AgEGBSuBBAAiA2IABKoSR5CYG/vvw0AHgyBO8TCCogbR8pKGYfL2IWjKAMTH6kMA +VIbc/R/fALhBYlzccBYy3h+Z1MzFB8gIH2EWB1E9fVwHU+M1OIzfzZ/ZLg1Kthku +WnBaBu2+8KGwytAJKaNjMGEwHQYDVR0OBBYEFFvKXuXe0oGqzagtZFG22XKbl+ZP +MA8GA1UdEwEB/wQFMAMBAf8wHwYDVR0jBBgwFoAUW8pe5d7SgarNqC1kUbbZcpuX +5k8wDgYDVR0PAQH/BAQDAgGGMAoGCCqGSM49BAMCA2gAMGUCMQCK5kCJN+vp1RPZ +ytRrJPOwPYdGWBrssd9v+1a6cGvHOMzosYxPD/fxZ3YOg9AeUY8CMD32IygmTMZg +h5Mmm7I1HrrW9zzRHM76JTymGoEVW/MSD2zuZYrJh6j5B+BimoxcSg== +-----END CERTIFICATE----- diff --git a/aws/dist/botocore/data/_retry.json b/aws/dist/botocore/data/_retry.json new file mode 100644 index 00000000..3d745cc9 --- /dev/null +++ b/aws/dist/botocore/data/_retry.json @@ -0,0 +1,284 @@ +{ + "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 + } + } + }, + "throughput_exceeded": { + "applies_when": { + "response": { + "service_error_code": "ProvisionedThroughputExceededException", + "http_status_code": 400 + } + } + } + }, + "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"}, + "throughput_exceeded": {"$ref": "throughput_exceeded"} + } + }, + "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": { + "still_processing": { + "applies_when": { + "response": { + "service_error_code": "TransactionInProgressException", + "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": { + "__default__": { + "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 + } + } + } + } + } + }, + "sts": { + "__default__": { + "policies": { + "idp_unreachable_error": { + "applies_when": { + "response": { + "service_error_code": "IDPCommunicationError", + "http_status_code": 400 + } + } + } + } + } + } + } +} diff --git a/aws/dist/botocore/data/acm-pca/2017-08-22/paginators-1.json b/aws/dist/botocore/data/acm-pca/2017-08-22/paginators-1.json new file mode 100644 index 00000000..c1f4e234 --- /dev/null +++ b/aws/dist/botocore/data/acm-pca/2017-08-22/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListCertificateAuthorities": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CertificateAuthorities" + }, + "ListTags": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + }, + "ListPermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Permissions" + } + } +} diff --git a/aws/dist/botocore/data/acm-pca/2017-08-22/service-2.json b/aws/dist/botocore/data/acm-pca/2017-08-22/service-2.json new file mode 100644 index 00000000..0ace9e2c --- /dev/null +++ b/aws/dist/botocore/data/acm-pca/2017-08-22/service-2.json @@ -0,0 +1,1480 @@ +{ + "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":"InvalidTagException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. 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, and X.500 subject information. The CRL 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 action 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 your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

", + "idempotent":true + }, + "CreatePermission":{ + "name":"CreatePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePermissionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"PermissionAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidStateException"}, + {"shape":"RequestFailedException"} + ], + "documentation":"

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action.

" + }, + "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 Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently 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 action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action.

" + }, + "DeletePermission":{ + "name":"DeletePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePermissionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidStateException"}, + {"shape":"RequestFailedException"} + ], + "documentation":"

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action.

" + }, + "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 Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or 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 is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action'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 action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action.

" + }, + "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 action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action 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 action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. 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":"InvalidRequestException"}, + {"shape":"InvalidStateException"}, + {"shape":"MalformedCertificateException"}, + {"shape":"CertificateMismatchException"} + ], + "documentation":"

Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:

  1. In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

  2. Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

  3. Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..

  4. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or 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 action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.

", + "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 action.

" + }, + "ListPermissions":{ + "name":"ListPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPermissionsRequest"}, + "output":{"shape":"ListPermissionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidStateException"}, + {"shape":"RequestFailedException"} + ], + "documentation":"

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidStateException"} + ], + "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 action to add one or more tags to your CA. Call the UntagCertificateAuthority action 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 action. 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 actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action 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":"InvalidRequestException"}, + {"shape":"InvalidStateException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestAlreadyProcessedException"}, + {"shape":"RequestInProgressException"}, + {"shape":"RequestFailedException"} + ], + "documentation":"

Revokes a certificate that was issued inside ACM Private CA. 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 Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate.

" + }, + "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 action. Call the ListTags action 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 action, 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 action 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.

" + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"[0-9]+" + }, + "ActionList":{ + "type":"list", + "member":{"shape":"ActionType"}, + "max":3, + "min":1 + }, + "ActionType":{ + "type":"string", + "enum":[ + "IssueCertificate", + "GetCertificate", + "ListPermissions" + ] + }, + "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 action.

" + } + }, + "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 action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action 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 CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.

" + }, + "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. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.

" + }, + "CertificateAuthorityStatus":{ + "type":"string", + "enum":[ + "CREATING", + "PENDING_CERTIFICATE", + "ACTIVE", + "DELETED", + "DISABLED", + "EXPIRED", + "FAILED" + ] + }, + "CertificateAuthorityType":{ + "type":"string", + "enum":[ + "ROOT", + "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":"

The 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":"

The name of the S3 bucket that will contain the audit report.

" + }, + "AuditReportResponseFormat":{ + "shape":"AuditReportResponseFormat", + "documentation":"

The 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 Private CA 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.

" + }, + "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 Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with

IAM to manage permissions, see Controlling Access Using IAM Tags.

" + } + } + }, + "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 .

" + } + } + }, + "CreatePermissionRequest":{ + "type":"structure", + "required":[ + "CertificateAuthorityArn", + "Principal", + "Actions" + ], + "members":{ + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

" + }, + "Principal":{ + "shape":"Principal", + "documentation":"

The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.

" + }, + "SourceAccount":{ + "shape":"AccountId", + "documentation":"

The ID of the calling account.

" + }, + "Actions":{ + "shape":"ActionList", + "documentation":"

The actions that the specified AWS service principal can use. These include IssueCertificate, GetCertificate, and ListPermissions.

" + } + } + }, + "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 action or for an existing CA when you call the UpdateCertificateAuthority action.

", + "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 action. You must specify a bucket policy that allows ACM Private CA 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 Private CA.

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.

      • X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL.

    • X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.

    • X509v3 CRL Number:: Decimal sequence number 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 Private CA 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.

" + } + } + }, + "DeletePermissionRequest":{ + "type":"structure", + "required":[ + "CertificateAuthorityArn", + "Principal" + ], + "members":{ + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the ListCertificateAuthorities action. This must have the following form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

" + }, + "Principal":{ + "shape":"Principal", + "documentation":"

The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is acm.amazonaws.com

" + }, + "SourceAccount":{ + "shape":"AccountId", + "documentation":"

The AWS account that calls this action.

" + } + } + }, + "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 action.

" + } + } + }, + "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. If this is a root CA, the value will be null.

" + } + } + }, + "GetCertificateAuthorityCsrRequest":{ + "type":"structure", + "required":["CertificateAuthorityArn"], + "members":{ + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority action. 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" + ], + "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 a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.

" + }, + "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 ACM Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding.

This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.

" + } + } + }, + "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 Private CA rights to read from and write to the bucket and find the bucket location.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request action cannot be performed or is prohibited.

", + "exception":true + }, + "InvalidStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The private CA is in a state during which a report or certificate 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.

" + }, + "TemplateArn":{ + "shape":"Arn", + "documentation":"

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

" + }, + "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 action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA 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 Private CA 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.

" + } + } + }, + "ListPermissionsRequest":{ + "type":"structure", + "required":["CertificateAuthorityArn"], + "members":{ + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the ListCertificateAuthorities action. This must be of the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 You can get a private CA's ARN by running the ListCertificateAuthorities action.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

When paginating results, use this parameter 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":"

When paginating results, use this parameter 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.

" + } + } + }, + "ListPermissionsResponse":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"PermissionList", + "documentation":"

Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.

" + }, + "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 action. 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 + }, + "Permission":{ + "type":"structure", + "members":{ + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Number (ARN) of the private CA from which the permission was issued.

" + }, + "CreatedAt":{ + "shape":"TStamp", + "documentation":"

The time at which the permission was created.

" + }, + "Principal":{ + "shape":"String", + "documentation":"

The AWS service or entity that holds the permission. At this time, the only valid principal is acm.amazonaws.com.

" + }, + "SourceAccount":{ + "shape":"String", + "documentation":"

The ID of the account that assigned the permission.

" + }, + "Actions":{ + "shape":"ActionList", + "documentation":"

The private CA actions that can be performed by the designated AWS service.

" + }, + "Policy":{ + "shape":"String", + "documentation":"

The name of the policy that is associated with the permission.

" + } + }, + "documentation":"

Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

" + }, + "PermissionAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The designated permission has already been given to the user.

", + "exception":true + }, + "PermissionList":{ + "type":"list", + "member":{"shape":"Permission"}, + "min":0 + }, + "PositiveLong":{ + "type":"long", + "min":1 + }, + "Principal":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^[^*]+$" + }, + "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 action. 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 actions. 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 action 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 action 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 action. To remove a tag, call the UntagCertificateAuthority action.

" + }, + "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 action.

" + }, + "ValidityPeriodType":{ + "type":"string", + "enum":[ + "END_DATE", + "ABSOLUTE", + "DAYS", + "MONTHS", + "YEARS" + ] + } + }, + "documentation":"

This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.

The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA in the ACM Private CA user guide.

" +} diff --git a/aws/dist/botocore/data/acm-pca/2017-08-22/waiters-2.json b/aws/dist/botocore/data/acm-pca/2017-08-22/waiters-2.json new file mode 100644 index 00000000..79bf399b --- /dev/null +++ b/aws/dist/botocore/data/acm-pca/2017-08-22/waiters-2.json @@ -0,0 +1,61 @@ +{ + "version": 2, + "waiters": { + "CertificateAuthorityCSRCreated": { + "description": "Wait until a Certificate Authority CSR is created", + "operation": "GetCertificateAuthorityCsr", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "RequestInProgressException" + } + ] + }, + "CertificateIssued": { + "description": "Wait until a certificate is issued", + "operation": "GetCertificate", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "RequestInProgressException" + } + ] + }, + "AuditReportCreated": { + "description": "Wait until a Audit Report is created", + "operation": "DescribeCertificateAuthorityAuditReport", + "delay": 3, + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "AuditReportStatus", + "expected": "SUCCESS" + }, + { + "state": "failure", + "matcher": "path", + "argument": "AuditReportStatus", + "expected": "FAILED" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/acm/2015-12-08/examples-1.json b/aws/dist/botocore/data/acm/2015-12-08/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/acm/2015-12-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/acm/2015-12-08/paginators-1.json b/aws/dist/botocore/data/acm/2015-12-08/paginators-1.json new file mode 100644 index 00000000..2e2e4f9a --- /dev/null +++ b/aws/dist/botocore/data/acm/2015-12-08/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListCertificates": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxItems", + "result_key": "CertificateSummaryList" + } + } +} diff --git a/aws/dist/botocore/data/acm/2015-12-08/service-2.json b/aws/dist/botocore/data/acm/2015-12-08/service-2.json new file mode 100644 index 00000000..daf9bca9 --- /dev/null +++ b/aws/dist/botocore/data/acm/2015-12-08/service-2.json @@ -0,0 +1,1160 @@ +{ + "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"}, + "errors":[ + {"shape":"InvalidArgsException"} + ], + "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.

" + }, + "RenewCertificate":{ + "name":"RenewCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RenewCertificateRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first grant the ACM service principal permission to do so. For more information, see Testing Managed Renewal in the ACM User Guide.

" + }, + "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. At this time, only exported private certificates can be renewed with the RenewCertificate command.

" + }, + "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

  • SUCCESS

  • FAILED

" + }, + "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:

  • admin@example.com

  • administrator@example.com

  • hostmaster@example.com

  • postmaster@example.com

  • webmaster@example.com

" + } + }, + "documentation":"

Contains information about the domain names that you want ACM to use to send you emails 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 encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded.

" + } + } + }, + "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", + "DOMAIN_VALIDATION_DENIED", + "CAA_ERROR", + "PCA_LIMIT_EXCEEDED", + "PCA_INVALID_ARN", + "PCA_INVALID_STATE", + "PCA_REQUEST_FAILED", + "PCA_RESOURCE_NOT_FOUND", + "PCA_INVALID_ARGS", + "PCA_INVALID_DURATION", + "PCA_ACCESS_DENIED", + "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"} + }, + "InvalidArgsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

One or more of of request parameters specified is 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 + }, + "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.

" + } + } + }, + "RenewCertificateRequest":{ + "type":"structure", + "required":["CertificateArn"], + "members":{ + "CertificateArn":{ + "shape":"Arn", + "documentation":"

String that contains the ARN of the ACM certificate to be renewed. 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.

" + } + } + }, + "RenewalEligibility":{ + "type":"string", + "enum":[ + "ELIGIBLE", + "INELIGIBLE" + ] + }, + "RenewalStatus":{ + "type":"string", + "enum":[ + "PENDING_AUTO_RENEWAL", + "PENDING_VALIDATION", + "SUCCESS", + "FAILED" + ] + }, + "RenewalSummary":{ + "type":"structure", + "required":[ + "RenewalStatus", + "DomainValidationOptions", + "UpdatedAt" + ], + "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.

" + }, + "RenewalStatusReason":{ + "shape":"FailureReason", + "documentation":"

The reason that a renewal request was unsuccessful.

" + }, + "UpdatedAt":{ + "shape":"TStamp", + "documentation":"

The time at which the renewal summary was last updated.

" + } + }, + "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/aws/dist/botocore/data/acm/2015-12-08/waiters-2.json b/aws/dist/botocore/data/acm/2015-12-08/waiters-2.json new file mode 100644 index 00000000..1fba453d --- /dev/null +++ b/aws/dist/botocore/data/acm/2015-12-08/waiters-2.json @@ -0,0 +1,35 @@ +{ + "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/aws/dist/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json b/aws/dist/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json new file mode 100644 index 00000000..ced5de2f --- /dev/null +++ b/aws/dist/botocore/data/alexaforbusiness/2017-11-09/paginators-1.json @@ -0,0 +1,82 @@ +{ + "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" + }, + "ListBusinessReportSchedules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BusinessReportSchedules" + }, + "ListConferenceProviders": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ConferenceProviders" + }, + "ListDeviceEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DeviceEvents" + }, + "ListSkillsStoreCategories": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CategoryList" + }, + "ListSkillsStoreSkillsByCategory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SkillsStoreSkills" + }, + "ListSmartHomeAppliances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SmartHomeAppliances" + } + } +} diff --git a/aws/dist/botocore/data/alexaforbusiness/2017-11-09/service-2.json b/aws/dist/botocore/data/alexaforbusiness/2017-11-09/service-2.json new file mode 100644 index 00000000..375690ff --- /dev/null +++ b/aws/dist/botocore/data/alexaforbusiness/2017-11-09/service-2.json @@ -0,0 +1,5795 @@ +{ + "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":{ + "ApproveSkill":{ + "name":"ApproveSkill", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApproveSkillRequest"}, + "output":{"shape":"ApproveSkillResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Associates a skill with the organization under the customer's AWS account. If a skill is private, the user implicitly accepts access to this skill during enablement.

" + }, + "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.

" + }, + "AssociateDeviceWithNetworkProfile":{ + "name":"AssociateDeviceWithNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDeviceWithNetworkProfileRequest"}, + "output":{"shape":"AssociateDeviceWithNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Associates a device with the specified network profile.

" + }, + "AssociateDeviceWithRoom":{ + "name":"AssociateDeviceWithRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDeviceWithRoomRequest"}, + "output":{"shape":"AssociateDeviceWithRoomResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"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"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Associates a skill group with a given room. This enables all skills in the associated skill group on all devices in the room.

" + }, + "AssociateSkillWithSkillGroup":{ + "name":"AssociateSkillWithSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillWithSkillGroupRequest"}, + "output":{"shape":"AssociateSkillWithSkillGroupResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"SkillNotLinkedException"} + ], + "documentation":"

Associates a skill with a skill group.

" + }, + "AssociateSkillWithUsers":{ + "name":"AssociateSkillWithUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSkillWithUsersRequest"}, + "output":{"shape":"AssociateSkillWithUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Makes a private skill available for enrolled users to enable on their devices.

" + }, + "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.

" + }, + "CreateBusinessReportSchedule":{ + "name":"CreateBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBusinessReportScheduleRequest"}, + "output":{"shape":"CreateBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

" + }, + "CreateConferenceProvider":{ + "name":"CreateConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConferenceProviderRequest"}, + "output":{"shape":"CreateConferenceProviderResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Adds a new conference provider under the user's AWS account.

" + }, + "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.

" + }, + "CreateGatewayGroup":{ + "name":"CreateGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGatewayGroupRequest"}, + "output":{"shape":"CreateGatewayGroupResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a gateway group with the specified details.

" + }, + "CreateNetworkProfile":{ + "name":"CreateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkProfileRequest"}, + "output":{"shape":"CreateNetworkProfileResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"}, + {"shape":"InvalidServiceLinkedRoleStateException"} + ], + "documentation":"

Creates a network profile with the specified details.

" + }, + "CreateProfile":{ + "name":"CreateProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProfileRequest"}, + "output":{"shape":"CreateProfileResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"ConcurrentModificationException"} + ], + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a user.

" + }, + "DeleteAddressBook":{ + "name":"DeleteAddressBook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAddressBookRequest"}, + "output":{"shape":"DeleteAddressBookResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes an address book by the address book ARN.

" + }, + "DeleteBusinessReportSchedule":{ + "name":"DeleteBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBusinessReportScheduleRequest"}, + "output":{"shape":"DeleteBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the recurring report delivery schedule with the specified schedule ARN.

" + }, + "DeleteConferenceProvider":{ + "name":"DeleteConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConferenceProviderRequest"}, + "output":{"shape":"DeleteConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes a conference provider.

" + }, + "DeleteContact":{ + "name":"DeleteContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteContactRequest"}, + "output":{"shape":"DeleteContactResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a contact by the contact ARN.

" + }, + "DeleteDevice":{ + "name":"DeleteDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeviceRequest"}, + "output":{"shape":"DeleteDeviceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"} + ], + "documentation":"

Removes a device from Alexa For Business.

" + }, + "DeleteDeviceUsageData":{ + "name":"DeleteDeviceUsageData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeviceUsageDataRequest"}, + "output":{"shape":"DeleteDeviceUsageDataResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DeviceNotRegisteredException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

When this action is called for a specified shared device, it allows authorized users to delete the device's entire previous history of voice input data and associated response data. This action can be called once every 24 hours for a specific shared device.

" + }, + "DeleteGatewayGroup":{ + "name":"DeleteGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGatewayGroupRequest"}, + "output":{"shape":"DeleteGatewayGroupResponse"}, + "errors":[ + {"shape":"ResourceAssociatedException"} + ], + "documentation":"

Deletes a gateway group.

" + }, + "DeleteNetworkProfile":{ + "name":"DeleteNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkProfileRequest"}, + "output":{"shape":"DeleteNetworkProfileResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes a network profile by the network profile ARN.

" + }, + "DeleteProfile":{ + "name":"DeleteProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProfileRequest"}, + "output":{"shape":"DeleteProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a room by the room ARN.

" + }, + "DeleteRoomSkillParameter":{ + "name":"DeleteRoomSkillParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoomSkillParameterRequest"}, + "output":{"shape":"DeleteRoomSkillParameterResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes room skill parameter details by room, skill, and parameter key ID.

" + }, + "DeleteSkillAuthorization":{ + "name":"DeleteSkillAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSkillAuthorizationRequest"}, + "output":{"shape":"DeleteSkillAuthorizationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Unlinks a third-party account from a skill.

" + }, + "DeleteSkillGroup":{ + "name":"DeleteSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSkillGroupRequest"}, + "output":{"shape":"DeleteSkillGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "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":"ConcurrentModificationException"}, + {"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.

" + }, + "DisassociateSkillFromSkillGroup":{ + "name":"DisassociateSkillFromSkillGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillFromSkillGroupRequest"}, + "output":{"shape":"DisassociateSkillFromSkillGroupResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Disassociates a skill from a skill group.

" + }, + "DisassociateSkillFromUsers":{ + "name":"DisassociateSkillFromUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillFromUsersRequest"}, + "output":{"shape":"DisassociateSkillFromUsersResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Makes a private skill unavailable for enrolled users and prevents them from enabling it on their devices.

" + }, + "DisassociateSkillGroupFromRoom":{ + "name":"DisassociateSkillGroupFromRoom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSkillGroupFromRoomRequest"}, + "output":{"shape":"DisassociateSkillGroupFromRoomResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Disassociates a skill group from a specified room. This disables all skills in the skill group on all devices in the room.

" + }, + "ForgetSmartHomeAppliances":{ + "name":"ForgetSmartHomeAppliances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ForgetSmartHomeAppliancesRequest"}, + "output":{"shape":"ForgetSmartHomeAppliancesResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Forgets smart home appliances associated to a 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.

" + }, + "GetConferencePreference":{ + "name":"GetConferencePreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConferencePreferenceRequest"}, + "output":{"shape":"GetConferencePreferenceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the existing conference preferences.

" + }, + "GetConferenceProvider":{ + "name":"GetConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConferenceProviderRequest"}, + "output":{"shape":"GetConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Gets details about a specific conference provider.

" + }, + "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.

" + }, + "GetGateway":{ + "name":"GetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGatewayRequest"}, + "output":{"shape":"GetGatewayResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the details of a gateway.

" + }, + "GetGatewayGroup":{ + "name":"GetGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGatewayGroupRequest"}, + "output":{"shape":"GetGatewayGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the details of a gateway group.

" + }, + "GetInvitationConfiguration":{ + "name":"GetInvitationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInvitationConfigurationRequest"}, + "output":{"shape":"GetInvitationConfigurationResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves the configured values for the user enrollment invitation email template.

" + }, + "GetNetworkProfile":{ + "name":"GetNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNetworkProfileRequest"}, + "output":{"shape":"GetNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidSecretsManagerResourceException"} + ], + "documentation":"

Gets the network profile details by the network profile 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.

" + }, + "ListBusinessReportSchedules":{ + "name":"ListBusinessReportSchedules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBusinessReportSchedulesRequest"}, + "output":{"shape":"ListBusinessReportSchedulesResponse"}, + "documentation":"

Lists the details of the schedules that a user configured.

" + }, + "ListConferenceProviders":{ + "name":"ListConferenceProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListConferenceProvidersRequest"}, + "output":{"shape":"ListConferenceProvidersResponse"}, + "documentation":"

Lists conference providers under a specific AWS account.

" + }, + "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.

" + }, + "ListGatewayGroups":{ + "name":"ListGatewayGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewayGroupsRequest"}, + "output":{"shape":"ListGatewayGroupsResponse"}, + "documentation":"

Retrieves a list of gateway group summaries. Use GetGatewayGroup to retrieve details of a specific gateway group.

" + }, + "ListGateways":{ + "name":"ListGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewaysRequest"}, + "output":{"shape":"ListGatewaysResponse"}, + "documentation":"

Retrieves a list of gateway summaries. Use GetGateway to retrieve details of a specific gateway. An optional gateway group ARN can be provided to only retrieve gateway summaries of gateways that are associated with that gateway group ARN.

" + }, + "ListSkills":{ + "name":"ListSkills", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsRequest"}, + "output":{"shape":"ListSkillsResponse"}, + "documentation":"

Lists all enabled skills in a specific skill group.

" + }, + "ListSkillsStoreCategories":{ + "name":"ListSkillsStoreCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsStoreCategoriesRequest"}, + "output":{"shape":"ListSkillsStoreCategoriesResponse"}, + "documentation":"

Lists all categories in the Alexa skill store.

" + }, + "ListSkillsStoreSkillsByCategory":{ + "name":"ListSkillsStoreSkillsByCategory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSkillsStoreSkillsByCategoryRequest"}, + "output":{"shape":"ListSkillsStoreSkillsByCategoryResponse"}, + "documentation":"

Lists all skills in the Alexa skill store by category.

" + }, + "ListSmartHomeAppliances":{ + "name":"ListSmartHomeAppliances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSmartHomeAppliancesRequest"}, + "output":{"shape":"ListSmartHomeAppliancesResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Lists all of the smart home appliances associated with a room.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Lists all tags for the specified resource.

" + }, + "PutConferencePreference":{ + "name":"PutConferencePreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConferencePreferenceRequest"}, + "output":{"shape":"PutConferencePreferenceResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Sets the conference preferences on a specific conference provider at the account level.

" + }, + "PutInvitationConfiguration":{ + "name":"PutInvitationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutInvitationConfigurationRequest"}, + "output":{"shape":"PutInvitationConfigurationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Configures the email template for the user enrollment invitation with the specified attributes.

" + }, + "PutRoomSkillParameter":{ + "name":"PutRoomSkillParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRoomSkillParameterRequest"}, + "output":{"shape":"PutRoomSkillParameterResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates room skill parameter details by room, skill, and parameter key ID. Not all skills have a room skill parameter.

" + }, + "PutSkillAuthorization":{ + "name":"PutSkillAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSkillAuthorizationRequest"}, + "output":{"shape":"PutSkillAuthorizationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Links a user's account to a third-party skill provider. If this API operation is called by an assumed IAM role, the skill being linked must be a private skill. Also, the skill must be owned by the AWS account that assumed the IAM role.

" + }, + "RegisterAVSDevice":{ + "name":"RegisterAVSDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterAVSDeviceRequest"}, + "output":{"shape":"RegisterAVSDeviceResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidDeviceException"} + ], + "documentation":"

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

" + }, + "RejectSkill":{ + "name":"RejectSkill", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectSkillRequest"}, + "output":{"shape":"RejectSkillResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Disassociates a skill from the organization under a user's AWS account. If the skill is a private skill, it moves to an AcceptStatus of PENDING. Any private or public skill that is rejected can be added later by calling the ApproveSkill API.

" + }, + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "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.

" + }, + "SearchNetworkProfiles":{ + "name":"SearchNetworkProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchNetworkProfilesRequest"}, + "output":{"shape":"SearchNetworkProfilesResponse"}, + "documentation":"

Searches network profiles and lists the ones that meet a set of filter and sort 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.

" + }, + "SendAnnouncement":{ + "name":"SendAnnouncement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendAnnouncementRequest"}, + "output":{"shape":"SendAnnouncementResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Triggers an asynchronous flow to send text, SSML, or audio announcements to rooms that are identified by a search or filter.

" + }, + "SendInvitation":{ + "name":"SendInvitation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendInvitationRequest"}, + "output":{"shape":"SendInvitationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidUserStatusException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days 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. This clears all information and settings set by previous users in the following ways:

  • Bluetooth - This unpairs all bluetooth devices paired with your echo device.

  • Volume - This resets the echo device's volume to the default value.

  • Notifications - This clears all notifications from your echo device.

  • Lists - This clears all to-do items from your echo device.

  • Settings - This internally syncs the room's profile (if the device is assigned to a room), contacts, address books, delegation access for account linking, and communications (if enabled on the room profile).

" + }, + "StartSmartHomeApplianceDiscovery":{ + "name":"StartSmartHomeApplianceDiscovery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSmartHomeApplianceDiscoveryRequest"}, + "output":{"shape":"StartSmartHomeApplianceDiscoveryResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Initiates the discovery of any smart home appliances associated with the room.

" + }, + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates address book details by the address book ARN.

" + }, + "UpdateBusinessReportSchedule":{ + "name":"UpdateBusinessReportSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBusinessReportScheduleRequest"}, + "output":{"shape":"UpdateBusinessReportScheduleResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the configuration of the report delivery schedule with the specified schedule ARN.

" + }, + "UpdateConferenceProvider":{ + "name":"UpdateConferenceProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConferenceProviderRequest"}, + "output":{"shape":"UpdateConferenceProviderResponse"}, + "errors":[ + {"shape":"NotFoundException"} + ], + "documentation":"

Updates an existing conference provider's settings.

" + }, + "UpdateContact":{ + "name":"UpdateContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateContactRequest"}, + "output":{"shape":"UpdateContactResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "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":"ConcurrentModificationException"}, + {"shape":"DeviceNotRegisteredException"} + ], + "documentation":"

Updates the device name by device ARN.

" + }, + "UpdateGateway":{ + "name":"UpdateGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayRequest"}, + "output":{"shape":"UpdateGatewayResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"} + ], + "documentation":"

Updates the details of a gateway. If any optional field is not provided, the existing corresponding value is left unmodified.

" + }, + "UpdateGatewayGroup":{ + "name":"UpdateGatewayGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayGroupRequest"}, + "output":{"shape":"UpdateGatewayGroupResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"} + ], + "documentation":"

Updates the details of a gateway group. If any optional field is not provided, the existing corresponding value is left unmodified.

" + }, + "UpdateNetworkProfile":{ + "name":"UpdateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNetworkProfileRequest"}, + "output":{"shape":"UpdateNetworkProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidCertificateAuthorityException"}, + {"shape":"InvalidSecretsManagerResourceException"} + ], + "documentation":"

Updates a network profile by the network profile ARN.

" + }, + "UpdateProfile":{ + "name":"UpdateProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProfileRequest"}, + "output":{"shape":"UpdateProfileResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"NameInUseException"}, + {"shape":"ConcurrentModificationException"} + ], + "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"}, + {"shape":"ConcurrentModificationException"} + ], + "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.

", + "exception":true + }, + "AmazonId":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,18}" + }, + "ApplianceDescription":{"type":"string"}, + "ApplianceFriendlyName":{"type":"string"}, + "ApplianceManufacturerName":{"type":"string"}, + "ApproveSkillRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "ApproveSkillResponse":{ + "type":"structure", + "members":{ + } + }, + "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":{ + } + }, + "AssociateDeviceWithNetworkProfileRequest":{ + "type":"structure", + "required":[ + "DeviceArn", + "NetworkProfileArn" + ], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The device ARN.

" + }, + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile to associate with a device.

" + } + } + }, + "AssociateDeviceWithNetworkProfileResponse":{ + "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":{ + } + }, + "AssociateSkillWithSkillGroupRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group to associate the skill to. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "AssociateSkillWithSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateSkillWithUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The private skill ID you want to make available to enrolled users.

" + } + } + }, + "AssociateSkillWithUsersResponse":{ + "type":"structure", + "members":{ + } + }, + "Audio":{ + "type":"structure", + "required":[ + "Locale", + "Location" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the audio message. Currently, en-US is supported.

" + }, + "Location":{ + "shape":"AudioLocation", + "documentation":"

The location of the audio file. Currently, S3 URLs are supported. Only S3 locations comprised of safe characters are valid. For more information, see Safe Characters.

" + } + }, + "documentation":"

The audio message. There is a 1 MB limit on the audio file input and the only supported format is MP3. To convert your MP3 audio files to an Alexa-friendly,

required codec version (MPEG version 2) and bit rate (48 kbps), you might use converter software. One option for this is a command-line tool, FFmpeg. For more information, see FFmpeg. The following command converts the provided <input-file> to an MP3 file that is played in the announcement:

ffmpeg -i <input-file> -ac 2 -codec:a libmp3lame -b:a 48k -ar 16000 <output-file.mp3>

" + }, + "AudioList":{ + "type":"list", + "member":{"shape":"Audio"}, + "max":1 + }, + "AudioLocation":{ + "type":"string", + "max":1200, + "min":0, + "pattern":"https://([A-Za-z0-9_.-]+)?(s3-[A-Za-z0-9-]+|s3\\.([A-Za-z0-9-])+|s3|s3.dualstack\\.([A-Za-z0-9-])+)+.amazonaws.com/.*" + }, + "AuthorizationResult":{ + "type":"map", + "key":{"shape":"Key"}, + "value":{"shape":"Value"}, + "sensitive":true + }, + "Boolean":{"type":"boolean"}, + "BulletPoint":{"type":"string"}, + "BulletPoints":{ + "type":"list", + "member":{"shape":"BulletPoint"} + }, + "BusinessReport":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BusinessReportStatus", + "documentation":"

The status of the report generation execution (RUNNING, SUCCEEDED, or FAILED).

" + }, + "FailureCode":{ + "shape":"BusinessReportFailureCode", + "documentation":"

The failure code.

" + }, + "S3Location":{ + "shape":"BusinessReportS3Location", + "documentation":"

The S3 location of the output reports.

" + }, + "DeliveryTime":{ + "shape":"BusinessReportDeliveryTime", + "documentation":"

The time of report delivery.

" + }, + "DownloadUrl":{ + "shape":"BusinessReportDownloadUrl", + "documentation":"

The download link where a user can download the report.

" + } + }, + "documentation":"

Usage report with specified parameters.

" + }, + "BusinessReportContentRange":{ + "type":"structure", + "members":{ + "Interval":{ + "shape":"BusinessReportInterval", + "documentation":"

The interval of the content range.

" + } + }, + "documentation":"

The content range of the report.

" + }, + "BusinessReportDeliveryTime":{"type":"timestamp"}, + "BusinessReportDownloadUrl":{"type":"string"}, + "BusinessReportFailureCode":{ + "type":"string", + "enum":[ + "ACCESS_DENIED", + "NO_SUCH_BUCKET", + "INTERNAL_FAILURE" + ] + }, + "BusinessReportFormat":{ + "type":"string", + "enum":[ + "CSV", + "CSV_ZIP" + ] + }, + "BusinessReportInterval":{ + "type":"string", + "enum":[ + "ONE_DAY", + "ONE_WEEK" + ] + }, + "BusinessReportRecurrence":{ + "type":"structure", + "members":{ + "StartDate":{ + "shape":"Date", + "documentation":"

The start date.

" + } + }, + "documentation":"

The recurrence of the reports.

" + }, + "BusinessReportS3Location":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"BusinessReportS3Path", + "documentation":"

The path of the business report.

" + }, + "BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports.

" + } + }, + "documentation":"

The S3 location of the output reports.

" + }, + "BusinessReportS3Path":{"type":"string"}, + "BusinessReportSchedule":{ + "type":"structure", + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + }, + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ContentRange":{ + "shape":"BusinessReportContentRange", + "documentation":"

The content range of the reports.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports.

" + }, + "LastBusinessReport":{ + "shape":"BusinessReport", + "documentation":"

The details of the last business report delivery for a specified time interval.

" + } + }, + "documentation":"

The schedule of the usage report.

" + }, + "BusinessReportScheduleList":{ + "type":"list", + "member":{"shape":"BusinessReportSchedule"} + }, + "BusinessReportScheduleName":{ + "type":"string", + "max":64, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "BusinessReportStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, + "Category":{ + "type":"structure", + "members":{ + "CategoryId":{ + "shape":"CategoryId", + "documentation":"

The ID of the skill store category.

" + }, + "CategoryName":{ + "shape":"CategoryName", + "documentation":"

The name of the skill store category.

" + } + }, + "documentation":"

The skill store category that is shown. Alexa skills are assigned a specific skill category during creation, such as News, Social, and Sports.

" + }, + "CategoryId":{ + "type":"long", + "min":1 + }, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"} + }, + "CategoryName":{"type":"string"}, + "CertificateTime":{"type":"timestamp"}, + "ClientId":{ + "type":"string", + "pattern":"^\\S+{1,256}$" + }, + "ClientRequestToken":{ + "type":"string", + "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", + "max":150, + "min":10, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "CommsProtocol":{ + "type":"string", + "enum":[ + "SIP", + "SIPS", + "H323" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

There is a concurrent modification of resources.

", + "exception":true + }, + "ConferencePreference":{ + "type":"structure", + "members":{ + "DefaultConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the default conference provider.

" + } + }, + "documentation":"

The default conference provider that is used if no other scheduled meetings are detected.

" + }, + "ConferenceProvider":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created conference provider.

" + }, + "Name":{ + "shape":"ConferenceProviderName", + "documentation":"

The name of the conference provider.

" + }, + "Type":{ + "shape":"ConferenceProviderType", + "documentation":"

The type of conference providers.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + } + }, + "documentation":"

An entity that provides a conferencing solution. Alexa for Business acts as the voice interface and mediator that connects users to their preferred conference provider. Examples of conference providers include Amazon Chime, Zoom, Cisco, and Polycom.

" + }, + "ConferenceProviderName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "ConferenceProviderType":{ + "type":"string", + "enum":[ + "CHIME", + "BLUEJEANS", + "FUZE", + "GOOGLE_HANGOUTS", + "POLYCOM", + "RINGCENTRAL", + "SKYPE_FOR_BUSINESS", + "WEBEX", + "ZOOM", + "CUSTOM" + ] + }, + "ConferenceProvidersList":{ + "type":"list", + "member":{"shape":"ConferenceProvider"} + }, + "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":"RawPhoneNumber", + "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for 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":"RawPhoneNumber", + "documentation":"

The phone number of the contact. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for 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]*" + }, + "Content":{ + "type":"structure", + "members":{ + "TextList":{ + "shape":"TextList", + "documentation":"

The list of text messages.

" + }, + "SsmlList":{ + "shape":"SsmlList", + "documentation":"

The list of SSML messages.

" + }, + "AudioList":{ + "shape":"AudioList", + "documentation":"

The list of audio messages.

" + } + }, + "documentation":"

The content definition. This can contain only one text, SSML, or audio list object.

" + }, + "CountryCode":{ + "type":"string", + "pattern":"\\d{1,3}" + }, + "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.

" + } + } + }, + "CreateBusinessReportScheduleRequest":{ + "type":"structure", + "required":[ + "Format", + "ContentRange" + ], + "members":{ + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 bucket name of the output reports. If this isn't specified, the report can be retrieved from a download link by calling ListBusinessReportSchedule.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ContentRange":{ + "shape":"BusinessReportContentRange", + "documentation":"

The content range of the reports.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports. If this isn't specified, the report will only be delivered one time when the API is called.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The client request token.

", + "idempotencyToken":true + } + } + }, + "CreateBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + } + } + }, + "CreateConferenceProviderRequest":{ + "type":"structure", + "required":[ + "ConferenceProviderName", + "ConferenceProviderType", + "MeetingSetting" + ], + "members":{ + "ConferenceProviderName":{ + "shape":"ConferenceProviderName", + "documentation":"

The name of the conference provider.

" + }, + "ConferenceProviderType":{ + "shape":"ConferenceProviderType", + "documentation":"

Represents a type within a list of predefined types.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token of the client.

", + "idempotencyToken":true + } + } + }, + "CreateConferenceProviderResponse":{ + "type":"structure", + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly-created conference provider.

" + } + } + }, + "CreateContactRequest":{ + "type":"structure", + "required":["FirstName"], + "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":"RawPhoneNumber", + "documentation":"

The phone number of the contact in E.164 format. The phone number type defaults to WORK. You can specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for the contact.

" + }, + "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.

" + } + } + }, + "CreateGatewayGroupRequest":{ + "type":"structure", + "required":[ + "Name", + "ClientRequestToken" + ], + "members":{ + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, user-specified identifier for the request that ensures idempotency.

", + "idempotencyToken":true + } + } + }, + "CreateGatewayGroupResponse":{ + "type":"structure", + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the created gateway group.

" + } + } + }, + "CreateNetworkProfileRequest":{ + "type":"structure", + "required":[ + "NetworkProfileName", + "Ssid", + "SecurityType", + "ClientRequestToken" + ], + "members":{ + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "idempotencyToken":true + } + } + }, + "CreateNetworkProfileResponse":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "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.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale of the room profile.

" + }, + "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.

" + } + } + }, + "CurrentWiFiPassword":{ + "type":"string", + "max":128, + "min":5, + "pattern":"[\\x00-\\x7F]*", + "sensitive":true + }, + "CustomerS3BucketName":{ + "type":"string", + "pattern":"[a-z0-9-\\.]{3,63}" + }, + "Date":{ + "type":"string", + "pattern":"^\\d{4}\\-(0?[1-9]|1[012])\\-(0?[1-9]|[12][0-9]|3[01])$" + }, + "DeleteAddressBookRequest":{ + "type":"structure", + "required":["AddressBookArn"], + "members":{ + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book to delete.

" + } + } + }, + "DeleteAddressBookResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteBusinessReportScheduleRequest":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + } + } + }, + "DeleteBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteConferenceProviderRequest":{ + "type":"structure", + "required":["ConferenceProviderArn"], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the conference provider.

" + } + } + }, + "DeleteConferenceProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteContactRequest":{ + "type":"structure", + "required":["ContactArn"], + "members":{ + "ContactArn":{ + "shape":"Arn", + "documentation":"

The ARN of the contact to delete.

" + } + } + }, + "DeleteContactResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDeviceRequest":{ + "type":"structure", + "required":["DeviceArn"], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device for which to request details.

" + } + } + }, + "DeleteDeviceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDeviceUsageDataRequest":{ + "type":"structure", + "required":[ + "DeviceArn", + "DeviceUsageType" + ], + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device.

" + }, + "DeviceUsageType":{ + "shape":"DeviceUsageType", + "documentation":"

The type of usage data to delete.

" + } + } + }, + "DeleteDeviceUsageDataResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to delete.

" + } + } + }, + "DeleteGatewayGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "DeleteNetworkProfileResponse":{ + "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":{ + } + }, + "DeleteSkillAuthorizationRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of a skill.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the skill is authorized for.

" + } + } + }, + "DeleteSkillAuthorizationResponse":{ + "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":{ + } + }, + "DeveloperInfo":{ + "type":"structure", + "members":{ + "DeveloperName":{ + "shape":"DeveloperName", + "documentation":"

The name of the developer.

" + }, + "PrivacyPolicy":{ + "shape":"PrivacyPolicy", + "documentation":"

The URL of the privacy policy.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email of the developer.

" + }, + "Url":{ + "shape":"Url", + "documentation":"

The website of the developer.

" + } + }, + "documentation":"

The details about the developer that published the skill.

" + }, + "DeveloperName":{"type":"string"}, + "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.

" + }, + "NetworkProfileInfo":{ + "shape":"DeviceNetworkProfileInfo", + "documentation":"

Detailed information about a device's network profile.

" + } + }, + "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.

" + }, + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with 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":"DeviceEventTime", + "documentation":"

The time (in epoch) when the event occurred.

" + } + }, + "documentation":"

The list of device events.

" + }, + "DeviceEventList":{ + "type":"list", + "member":{"shape":"DeviceEvent"} + }, + "DeviceEventTime":{"type":"timestamp"}, + "DeviceEventType":{ + "type":"string", + "enum":[ + "CONNECTION_STATUS", + "DEVICE_STATUS" + ] + }, + "DeviceEventValue":{"type":"string"}, + "DeviceLocale":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceName":{ + "type":"string", + "max":100, + "min":2, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "DeviceNetworkProfileInfo":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "CertificateArn":{ + "shape":"Arn", + "documentation":"

The ARN of the certificate associated with a device.

" + }, + "CertificateExpirationTime":{ + "shape":"CertificateTime", + "documentation":"

The time (in epoch) when the certificate expires.

" + } + }, + "documentation":"

Detailed information about a device's network profile.

" + }, + "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}" + }, + "DeviceSerialNumberForAVS":{ + "type":"string", + "pattern":"^[a-zA-Z0-9]{1,50}$" + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "READY", + "PENDING", + "WAS_OFFLINE", + "DEREGISTERED", + "FAILED" + ] + }, + "DeviceStatusDetail":{ + "type":"structure", + "members":{ + "Feature":{ + "shape":"Feature", + "documentation":"

The list of available features on the device.

" + }, + "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", + "CREDENTIALS_ACCESS_FAILURE", + "TLS_VERSION_MISMATCH", + "ASSOCIATION_REJECTION", + "AUTHENTICATION_FAILURE", + "DHCP_FAILURE", + "INTERNET_UNAVAILABLE", + "DNS_FAILURE", + "UNKNOWN_FAILURE", + "CERTIFICATE_ISSUING_LIMIT_EXCEEDED", + "INVALID_CERTIFICATE_AUTHORITY", + "NETWORK_PROFILE_NOT_FOUND", + "INVALID_PASSWORD_STATE", + "PASSWORD_NOT_FOUND" + ] + }, + "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}" + }, + "DeviceUsageType":{ + "type":"string", + "enum":["VOICE"] + }, + "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":{ + } + }, + "DisassociateSkillFromSkillGroupRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The unique identifier of a skill. Required.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of a skill group to associate to a skill.

" + } + } + }, + "DisassociateSkillFromSkillGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateSkillFromUsersRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The private skill ID you want to make unavailable for enrolled users.

" + } + } + }, + "DisassociateSkillFromUsersResponse":{ + "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" + ] + }, + "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})" + }, + "EnablementType":{ + "type":"string", + "enum":[ + "ENABLED", + "PENDING" + ] + }, + "EnablementTypeFilter":{ + "type":"string", + "enum":[ + "ENABLED", + "PENDING" + ] + }, + "EndUserLicenseAgreement":{"type":"string"}, + "Endpoint":{ + "type":"string", + "max":256, + "min":1 + }, + "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", + "NETWORK_PROFILE", + "SETTINGS", + "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":50 + }, + "ForgetSmartHomeAppliancesRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the appliances are associated with.

" + } + } + }, + "ForgetSmartHomeAppliancesResponse":{ + "type":"structure", + "members":{ + } + }, + "Gateway":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The description of the gateway.

" + }, + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group that the gateway is associated to.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + }, + "documentation":"

The details of the gateway.

" + }, + "GatewayDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewayGroup":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + } + }, + "documentation":"

The details of the gateway group.

" + }, + "GatewayGroupDescription":{ + "type":"string", + "max":200, + "min":0 + }, + "GatewayGroupName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewayGroupSummaries":{ + "type":"list", + "member":{"shape":"GatewayGroupSummary"} + }, + "GatewayGroupSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The description of the gateway group.

" + } + }, + "documentation":"

The summary of a gateway group.

" + }, + "GatewayName":{ + "type":"string", + "max":253, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "GatewaySummaries":{ + "type":"list", + "member":{"shape":"GatewaySummary"} + }, + "GatewaySummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The description of the gateway.

" + }, + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group that the gateway is associated to.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + }, + "documentation":"

The summary of a gateway.

" + }, + "GatewayVersion":{ + "type":"string", + "max":50, + "min":1 + }, + "GenericKeyword":{"type":"string"}, + "GenericKeywords":{ + "type":"list", + "member":{"shape":"GenericKeyword"} + }, + "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.

" + } + } + }, + "GetConferencePreferenceRequest":{ + "type":"structure", + "members":{ + } + }, + "GetConferencePreferenceResponse":{ + "type":"structure", + "members":{ + "Preference":{ + "shape":"ConferencePreference", + "documentation":"

The conference preference.

" + } + } + }, + "GetConferenceProviderRequest":{ + "type":"structure", + "required":["ConferenceProviderArn"], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the newly created conference provider.

" + } + } + }, + "GetConferenceProviderResponse":{ + "type":"structure", + "members":{ + "ConferenceProvider":{ + "shape":"ConferenceProvider", + "documentation":"

The conference provider.

" + } + } + }, + "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.

" + } + } + }, + "GetGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to get.

" + } + } + }, + "GetGatewayGroupResponse":{ + "type":"structure", + "members":{ + "GatewayGroup":{"shape":"GatewayGroup"} + } + }, + "GetGatewayRequest":{ + "type":"structure", + "required":["GatewayArn"], + "members":{ + "GatewayArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway to get.

" + } + } + }, + "GetGatewayResponse":{ + "type":"structure", + "members":{ + "Gateway":{ + "shape":"Gateway", + "documentation":"

The details of the gateway.

" + } + } + }, + "GetInvitationConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetInvitationConfigurationResponse":{ + "type":"structure", + "members":{ + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"

The name of the organization sending the enrollment invite to a user.

" + }, + "ContactEmail":{ + "shape":"Email", + "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" + }, + "PrivateSkillIds":{ + "shape":"ShortSkillIdList", + "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" + } + } + }, + "GetNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + } + } + }, + "GetNetworkProfileResponse":{ + "type":"structure", + "members":{ + "NetworkProfile":{ + "shape":"NetworkProfile", + "documentation":"

The network profile associated with a device.

" + } + } + }, + "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.

" + } + } + }, + "IPDialIn":{ + "type":"structure", + "required":[ + "Endpoint", + "CommsProtocol" + ], + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The IP address.

" + }, + "CommsProtocol":{ + "shape":"CommsProtocol", + "documentation":"

The protocol, including SIP, SIPS, and H323.

" + } + }, + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "IconUrl":{"type":"string"}, + "InvalidCertificateAuthorityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The Certificate Authority can't issue or revoke a certificate.

", + "exception":true + }, + "InvalidDeviceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The device is in an invalid state.

", + "exception":true + }, + "InvalidSecretsManagerResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A password in SecretsManager is in an invalid state.

", + "exception":true + }, + "InvalidServiceLinkedRoleStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service linked role is locked for deletion.

", + "exception":true + }, + "InvalidUserStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The attempt to update a user is invalid due to the user's current status.

", + "exception":true + }, + "InvocationPhrase":{"type":"string"}, + "Key":{ + "type":"string", + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You are performing an action that would put you beyond your account's limits.

", + "exception":true + }, + "ListBusinessReportSchedulesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to list the remaining schedules from the previous API call.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of schedules listed in the call.

" + } + } + }, + "ListBusinessReportSchedulesResponse":{ + "type":"structure", + "members":{ + "BusinessReportSchedules":{ + "shape":"BusinessReportScheduleList", + "documentation":"

The schedule of the reports.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to list the remaining schedules from the previous API call.

" + } + } + }, + "ListConferenceProvidersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of conference providers to be returned, per paginated calls.

" + } + } + }, + "ListConferenceProvidersResponse":{ + "type":"structure", + "members":{ + "ConferenceProviders":{ + "shape":"ConferenceProvidersList", + "documentation":"

The conference providers.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "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.

" + } + } + }, + "ListGatewayGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of gateway group summaries to return. The default is 50.

" + } + } + }, + "ListGatewayGroupsResponse":{ + "type":"structure", + "members":{ + "GatewayGroups":{ + "shape":"GatewayGroupSummaries", + "documentation":"

The gateway groups in the list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway group summaries.

" + } + } + }, + "ListGatewaysRequest":{ + "type":"structure", + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The gateway group ARN for which to list gateways.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of gateway summaries to return. The default is 50.

" + } + } + }, + "ListGatewaysResponse":{ + "type":"structure", + "members":{ + "Gateways":{ + "shape":"GatewaySummaries", + "documentation":"

The gateways in the list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token used to paginate though multiple pages of gateway summaries.

" + } + } + }, + "ListSkillsRequest":{ + "type":"structure", + "members":{ + "SkillGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the skill group for which to list enabled skills. Required.

" + }, + "EnablementType":{ + "shape":"EnablementTypeFilter", + "documentation":"

Whether the skill is enabled under the user's account, or if it requires linking to be used.

" + }, + "SkillType":{ + "shape":"SkillTypeFilter", + "documentation":"

Whether the skill is publicly available or is a private skill.

" + }, + "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.

" + } + } + }, + "ListSkillsStoreCategoriesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of categories returned, per paginated calls.

" + } + } + }, + "ListSkillsStoreCategoriesResponse":{ + "type":"structure", + "members":{ + "CategoryList":{ + "shape":"CategoryList", + "documentation":"

The list of categories.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSkillsStoreSkillsByCategoryRequest":{ + "type":"structure", + "required":["CategoryId"], + "members":{ + "CategoryId":{ + "shape":"CategoryId", + "documentation":"

The category ID for which the skills are being retrieved from the skill store.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + }, + "MaxResults":{ + "shape":"SkillListMaxResults", + "documentation":"

The maximum number of skills returned per paginated calls.

" + } + } + }, + "ListSkillsStoreSkillsByCategoryResponse":{ + "type":"structure", + "members":{ + "SkillsStoreSkills":{ + "shape":"SkillsStoreSkillList", + "documentation":"

The skill store skills.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSmartHomeAppliancesRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the appliances are associated with.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of appliances to be returned, per paginated calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "ListSmartHomeAppliancesResponse":{ + "type":"structure", + "members":{ + "SmartHomeAppliances":{ + "shape":"SmartHomeApplianceList", + "documentation":"

The smart home appliances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The tokens used for pagination.

" + } + } + }, + "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.

" + } + } + }, + "Locale":{ + "type":"string", + "enum":["en-US"] + }, + "MacAddress":{"type":"string"}, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxVolumeLimit":{"type":"integer"}, + "MeetingSetting":{ + "type":"structure", + "required":["RequirePin"], + "members":{ + "RequirePin":{ + "shape":"RequirePin", + "documentation":"

The values that indicate whether the pin is always required.

" + } + }, + "documentation":"

The values that indicate whether a pin is always required (YES), never required (NO), or OPTIONAL.

  • If YES, Alexa will always ask for a meeting pin.

  • If NO, Alexa will never ask for a meeting pin.

  • If OPTIONAL, Alexa will ask if you have a meeting pin and if the customer responds with yes, it will ask for the meeting pin.

" + }, + "NameInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The name sent in the request is already in use.

", + "exception":true + }, + "NetworkEapMethod":{ + "type":"string", + "enum":["EAP_TLS"] + }, + "NetworkProfile":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificates of your authentication server, which is installed on your devices and used to trust your authentication server during EAP negotiation.

" + } + }, + "documentation":"

The network profile associated with a device.

" + }, + "NetworkProfileData":{ + "type":"structure", + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "Ssid":{ + "shape":"NetworkSsid", + "documentation":"

The SSID of the Wi-Fi network.

" + }, + "SecurityType":{ + "shape":"NetworkSecurityType", + "documentation":"

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

" + }, + "EapMethod":{ + "shape":"NetworkEapMethod", + "documentation":"

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + } + }, + "documentation":"

The data associated with a network profile.

" + }, + "NetworkProfileDataList":{ + "type":"list", + "member":{"shape":"NetworkProfileData"} + }, + "NetworkProfileDescription":{ + "type":"string", + "max":200, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NetworkProfileName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NetworkSecurityType":{ + "type":"string", + "enum":[ + "OPEN", + "WEP", + "WPA_PSK", + "WPA2_PSK", + "WPA2_ENTERPRISE" + ] + }, + "NetworkSsid":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "NewInThisVersionBulletPoints":{ + "type":"list", + "member":{"shape":"BulletPoint"} + }, + "NextToken":{ + "type":"string", + "max":1100, + "min":1 + }, + "NextWiFiPassword":{ + "type":"string", + "max":128, + "min":0, + "pattern":"(^$)|([\\x00-\\x7F]{5,})", + "sensitive":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource is not found.

", + "exception":true + }, + "OneClickIdDelay":{ + "type":"string", + "max":2, + "min":1 + }, + "OneClickPinDelay":{ + "type":"string", + "max":2, + "min":1 + }, + "OrganizationName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "OutboundPhoneNumber":{ + "type":"string", + "pattern":"\\d{10}" + }, + "PSTNDialIn":{ + "type":"structure", + "required":[ + "CountryCode", + "PhoneNumber", + "OneClickIdDelay", + "OneClickPinDelay" + ], + "members":{ + "CountryCode":{ + "shape":"CountryCode", + "documentation":"

The zip code.

" + }, + "PhoneNumber":{ + "shape":"OutboundPhoneNumber", + "documentation":"

The phone number to call to join the conference.

" + }, + "OneClickIdDelay":{ + "shape":"OneClickIdDelay", + "documentation":"

The delay duration before Alexa enters the conference ID with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" + }, + "OneClickPinDelay":{ + "shape":"OneClickPinDelay", + "documentation":"

The delay duration before Alexa enters the conference pin with dual-tone multi-frequency (DTMF). Each number on the dial pad corresponds to a DTMF tone, which is how we send data over the telephone network.

" + } + }, + "documentation":"

The information for public switched telephone network (PSTN) conferencing.

" + }, + "PhoneNumber":{ + "type":"structure", + "required":[ + "Number", + "Type" + ], + "members":{ + "Number":{ + "shape":"RawPhoneNumber", + "documentation":"

The raw value of the phone number.

" + }, + "Type":{ + "shape":"PhoneNumberType", + "documentation":"

The type of the phone number.

" + } + }, + "documentation":"

The phone number for the contact containing the raw number and phone number type.

" + }, + "PhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"}, + "max":3, + "min":0 + }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "MOBILE", + "WORK", + "HOME" + ], + "sensitive":true + }, + "PrivacyPolicy":{"type":"string"}, + "ProductDescription":{"type":"string"}, + "ProductId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_]{1,256}$" + }, + "Profile":{ + "type":"structure", + "members":{ + "ProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of a room profile.

" + }, + "ProfileName":{ + "shape":"ProfileName", + "documentation":"

The name of a room profile.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Retrieves if the profile is default or not.

" + }, + "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.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale 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.

" + }, + "AddressBookArn":{ + "shape":"Arn", + "documentation":"

The ARN of the address book.

" + } + }, + "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.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Retrieves if the profile data is default or not.

" + }, + "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.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The locale 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 + }, + "PutConferencePreferenceRequest":{ + "type":"structure", + "required":["ConferencePreference"], + "members":{ + "ConferencePreference":{ + "shape":"ConferencePreference", + "documentation":"

The conference preference of a specific conference provider.

" + } + } + }, + "PutConferencePreferenceResponse":{ + "type":"structure", + "members":{ + } + }, + "PutInvitationConfigurationRequest":{ + "type":"structure", + "required":["OrganizationName"], + "members":{ + "OrganizationName":{ + "shape":"OrganizationName", + "documentation":"

The name of the organization sending the enrollment invite to a user.

" + }, + "ContactEmail":{ + "shape":"Email", + "documentation":"

The email ID of the organization or individual contact that the enrolled user can use.

" + }, + "PrivateSkillIds":{ + "shape":"ShortSkillIdList", + "documentation":"

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

" + } + } + }, + "PutInvitationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "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":{ + } + }, + "PutSkillAuthorizationRequest":{ + "type":"structure", + "required":[ + "AuthorizationResult", + "SkillId" + ], + "members":{ + "AuthorizationResult":{ + "shape":"AuthorizationResult", + "documentation":"

The authorization result specific to OAUTH code grant output. \"Code” must be populated in the AuthorizationResult map to establish the authorization.

" + }, + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of a skill.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room that the skill is authorized for.

" + } + } + }, + "PutSkillAuthorizationResponse":{ + "type":"structure", + "members":{ + } + }, + "RawPhoneNumber":{ + "type":"string", + "max":50, + "min":0, + "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$", + "sensitive":true + }, + "RegisterAVSDeviceRequest":{ + "type":"structure", + "required":[ + "ClientId", + "UserCode", + "ProductId", + "DeviceSerialNumber", + "AmazonId" + ], + "members":{ + "ClientId":{ + "shape":"ClientId", + "documentation":"

The client ID of the OEM used for code-based linking authorization on an AVS device.

" + }, + "UserCode":{ + "shape":"UserCode", + "documentation":"

The code that is obtained after your AVS device has made a POST request to LWA as a part of the Device Authorization Request component of the OAuth code-based linking specification.

" + }, + "ProductId":{ + "shape":"ProductId", + "documentation":"

The product ID used to identify your AVS device during authorization.

" + }, + "DeviceSerialNumber":{ + "shape":"DeviceSerialNumberForAVS", + "documentation":"

The key generated by the OEM that uniquely identifies a specified instance of your AVS device.

" + }, + "AmazonId":{ + "shape":"AmazonId", + "documentation":"

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

" + } + } + }, + "RegisterAVSDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the device.

" + } + } + }, + "RejectSkillRequest":{ + "type":"structure", + "required":["SkillId"], + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The unique identifier of the skill.

" + } + } + }, + "RejectSkillResponse":{ + "type":"structure", + "members":{ + } + }, + "ReleaseDate":{"type":"string"}, + "RequirePin":{ + "type":"string", + "enum":[ + "YES", + "NO", + "OPTIONAL" + ] + }, + "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.

" + } + } + }, + "ResourceAssociatedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Another resource is associated with the resource in the request.

", + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ClientRequestToken":{"shape":"ClientRequestToken"} + }, + "documentation":"

The resource in the request is already in use.

", + "exception":true + }, + "ReviewKey":{"type":"string"}, + "ReviewValue":{"type":"string"}, + "Reviews":{ + "type":"map", + "key":{"shape":"ReviewKey"}, + "value":{"shape":"ReviewValue"} + }, + "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"} + }, + "S3KeyPrefix":{ + "type":"string", + "max":100, + "min":0, + "pattern":"[A-Za-z0-9!_\\-\\.\\*'()/]*" + }, + "SampleUtterances":{ + "type":"list", + "member":{"shape":"Utterance"} + }, + "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, ConnectionStatus (ONLINE and OFFLINE), NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" + }, + "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, ConnectionStatus, NetworkProfileName, NetworkProfileArn, Feature, and FailureCode.

" + } + } + }, + "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.

" + } + } + }, + "SearchNetworkProfilesRequest":{ + "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 network profiles. Valid filters are NetworkProfileName, Ssid, and SecurityType.

" + }, + "SortCriteria":{ + "shape":"SortList", + "documentation":"

The sort order to use to list the specified set of network profiles. Valid sort criteria includes NetworkProfileName, Ssid, and SecurityType.

" + } + } + }, + "SearchNetworkProfilesResponse":{ + "type":"structure", + "members":{ + "NetworkProfiles":{ + "shape":"NetworkProfileDataList", + "documentation":"

The network profiles that meet the specified set of filter criteria, in sort order. It is a list of NetworkProfileData objects.

" + }, + "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.

" + }, + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

The total number of network profiles 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.

" + } + } + }, + "SendAnnouncementRequest":{ + "type":"structure", + "required":[ + "RoomFilters", + "Content", + "ClientRequestToken" + ], + "members":{ + "RoomFilters":{ + "shape":"FilterList", + "documentation":"

The filters to use to send an announcement to a specified list of rooms. The supported filter keys are RoomName, ProfileName, RoomArn, and ProfileArn. To send to all rooms, specify an empty RoomFilters list.

" + }, + "Content":{ + "shape":"Content", + "documentation":"

The announcement content. This can contain only one of the three possible announcement types (text, SSML or audio).

" + }, + "TimeToLiveInSeconds":{ + "shape":"TimeToLiveInSeconds", + "documentation":"

The time to live for an announcement. Default is 300. If delivery doesn't occur within this time, the announcement is not delivered.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The unique, user-specified identifier for the request that ensures idempotency.

", + "idempotencyToken":true + } + } + }, + "SendAnnouncementResponse":{ + "type":"structure", + "members":{ + "AnnouncementArn":{ + "shape":"Arn", + "documentation":"

The identifier of the announcement.

" + } + } + }, + "SendInvitationRequest":{ + "type":"structure", + "members":{ + "UserArn":{ + "shape":"Arn", + "documentation":"

The ARN of the user to whom to send an invitation. Required.

" + } + } + }, + "SendInvitationResponse":{ + "type":"structure", + "members":{ + } + }, + "ShortDescription":{"type":"string"}, + "ShortSkillIdList":{ + "type":"list", + "member":{"shape":"SkillId"}, + "max":3, + "min":0 + }, + "SipAddress":{ + "type":"structure", + "required":[ + "Uri", + "Type" + ], + "members":{ + "Uri":{ + "shape":"SipUri", + "documentation":"

The URI for the SIP address.

" + }, + "Type":{ + "shape":"SipType", + "documentation":"

The type of the SIP address.

" + } + }, + "documentation":"

The SIP address for the contact containing the URI and SIP address type.

" + }, + "SipAddressList":{ + "type":"list", + "member":{"shape":"SipAddress"}, + "max":1, + "min":0 + }, + "SipType":{ + "type":"string", + "enum":["WORK"], + "sensitive":true + }, + "SipUri":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^sip[s]?:([^@:]+)\\@([^@]+)$", + "sensitive":true + }, + "SkillDetails":{ + "type":"structure", + "members":{ + "ProductDescription":{ + "shape":"ProductDescription", + "documentation":"

The description of the product.

" + }, + "InvocationPhrase":{ + "shape":"InvocationPhrase", + "documentation":"

The phrase used to trigger the skill.

" + }, + "ReleaseDate":{ + "shape":"ReleaseDate", + "documentation":"

The date when the skill was released.

" + }, + "EndUserLicenseAgreement":{ + "shape":"EndUserLicenseAgreement", + "documentation":"

The URL of the end user license agreement.

" + }, + "GenericKeywords":{ + "shape":"GenericKeywords", + "documentation":"

The generic keywords associated with the skill that can be used to find a skill.

" + }, + "BulletPoints":{ + "shape":"BulletPoints", + "documentation":"

The details about what the skill supports organized as bullet points.

" + }, + "NewInThisVersionBulletPoints":{ + "shape":"NewInThisVersionBulletPoints", + "documentation":"

The updates added in bullet points.

" + }, + "SkillTypes":{ + "shape":"SkillTypes", + "documentation":"

The types of skills.

" + }, + "Reviews":{ + "shape":"Reviews", + "documentation":"

The list of reviews for the skill, including Key and Value pair.

" + }, + "DeveloperInfo":{ + "shape":"DeveloperInfo", + "documentation":"

The details about the developer that published the skill.

" + } + }, + "documentation":"

Granular information about the skill.

" + }, + "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]*" + }, + "SkillNotLinkedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The skill must be linked to a third-party account.

", + "exception":true + }, + "SkillStoreType":{"type":"string"}, + "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.

" + }, + "EnablementType":{ + "shape":"EnablementType", + "documentation":"

Whether the skill is enabled under the user's account, or if it requires linking to be used.

" + }, + "SkillType":{ + "shape":"SkillType", + "documentation":"

Whether the skill is publicly available or is a private skill.

" + } + }, + "documentation":"

The summary of skills.

" + }, + "SkillSummaryList":{ + "type":"list", + "member":{"shape":"SkillSummary"} + }, + "SkillType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE" + ], + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "SkillTypeFilter":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE", + "ALL" + ] + }, + "SkillTypes":{ + "type":"list", + "member":{"shape":"SkillStoreType"} + }, + "SkillsStoreSkill":{ + "type":"structure", + "members":{ + "SkillId":{ + "shape":"SkillId", + "documentation":"

The ARN of the skill.

" + }, + "SkillName":{ + "shape":"SkillName", + "documentation":"

The name of the skill.

" + }, + "ShortDescription":{ + "shape":"ShortDescription", + "documentation":"

Short description about the skill.

" + }, + "IconUrl":{ + "shape":"IconUrl", + "documentation":"

The URL where the skill icon resides.

" + }, + "SampleUtterances":{ + "shape":"SampleUtterances", + "documentation":"

Sample utterances that interact with the skill.

" + }, + "SkillDetails":{ + "shape":"SkillDetails", + "documentation":"

Information about the skill.

" + }, + "SupportsLinking":{ + "shape":"boolean", + "documentation":"

Linking support for a skill.

" + } + }, + "documentation":"

The detailed information about an Alexa skill.

" + }, + "SkillsStoreSkillList":{ + "type":"list", + "member":{"shape":"SkillsStoreSkill"} + }, + "SmartHomeAppliance":{ + "type":"structure", + "members":{ + "FriendlyName":{ + "shape":"ApplianceFriendlyName", + "documentation":"

The friendly name of the smart home appliance.

" + }, + "Description":{ + "shape":"ApplianceDescription", + "documentation":"

The description of the smart home appliance.

" + }, + "ManufacturerName":{ + "shape":"ApplianceManufacturerName", + "documentation":"

The name of the manufacturer of the smart home appliance.

" + } + }, + "documentation":"

A smart home appliance that can connect to a central system. Any domestic device can be a smart appliance.

" + }, + "SmartHomeApplianceList":{ + "type":"list", + "member":{"shape":"SmartHomeAppliance"} + }, + "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" + ] + }, + "Ssml":{ + "type":"structure", + "required":[ + "Locale", + "Value" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the SSML message. Currently, en-US is supported.

" + }, + "Value":{ + "shape":"SsmlValue", + "documentation":"

The value of the SSML message in the correct SSML format. The audio tag is not supported.

" + } + }, + "documentation":"

The SSML message. For more information, see SSML Reference.

" + }, + "SsmlList":{ + "type":"list", + "member":{"shape":"Ssml"}, + "max":1 + }, + "SsmlValue":{ + "type":"string", + "max":4096, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "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":{ + } + }, + "StartSmartHomeApplianceDiscoveryRequest":{ + "type":"structure", + "required":["RoomArn"], + "members":{ + "RoomArn":{ + "shape":"Arn", + "documentation":"

The room where smart home appliance discovery was initiated.

" + } + } + }, + "StartSmartHomeApplianceDiscoveryResponse":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "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" + ] + }, + "Text":{ + "type":"structure", + "required":[ + "Locale", + "Value" + ], + "members":{ + "Locale":{ + "shape":"Locale", + "documentation":"

The locale of the text message. Currently, en-US is supported.

" + }, + "Value":{ + "shape":"TextValue", + "documentation":"

The value of the text message.

" + } + }, + "documentation":"

The text message.

" + }, + "TextList":{ + "type":"list", + "member":{"shape":"Text"}, + "max":1 + }, + "TextValue":{ + "type":"string", + "max":4096, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]*" + }, + "TimeToLiveInSeconds":{ + "type":"integer", + "max":3600, + "min":1 + }, + "Timezone":{ + "type":"string", + "max":100, + "min":1 + }, + "TotalCount":{"type":"integer"}, + "TrustAnchor":{ + "type":"string", + "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)?" + }, + "TrustAnchorList":{ + "type":"list", + "member":{"shape":"TrustAnchor"}, + "max":5, + "min":1 + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The caller has no permissions to operate on the resource involved in the API call.

", + "exception":true + }, + "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":{ + } + }, + "UpdateBusinessReportScheduleRequest":{ + "type":"structure", + "required":["ScheduleArn"], + "members":{ + "ScheduleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the business report schedule.

" + }, + "S3BucketName":{ + "shape":"CustomerS3BucketName", + "documentation":"

The S3 location of the output reports.

" + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

The S3 key where the report is delivered.

" + }, + "Format":{ + "shape":"BusinessReportFormat", + "documentation":"

The format of the generated report (individual CSV files or zipped files of individual files).

" + }, + "ScheduleName":{ + "shape":"BusinessReportScheduleName", + "documentation":"

The name identifier of the schedule.

" + }, + "Recurrence":{ + "shape":"BusinessReportRecurrence", + "documentation":"

The recurrence of the reports.

" + } + } + }, + "UpdateBusinessReportScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateConferenceProviderRequest":{ + "type":"structure", + "required":[ + "ConferenceProviderArn", + "ConferenceProviderType", + "MeetingSetting" + ], + "members":{ + "ConferenceProviderArn":{ + "shape":"Arn", + "documentation":"

The ARN of the conference provider.

" + }, + "ConferenceProviderType":{ + "shape":"ConferenceProviderType", + "documentation":"

The type of the conference provider.

" + }, + "IPDialIn":{ + "shape":"IPDialIn", + "documentation":"

The IP endpoint and protocol for calling.

" + }, + "PSTNDialIn":{ + "shape":"PSTNDialIn", + "documentation":"

The information for PSTN conferencing.

" + }, + "MeetingSetting":{ + "shape":"MeetingSetting", + "documentation":"

The meeting settings for the conference provider.

" + } + } + }, + "UpdateConferenceProviderResponse":{ + "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":"RawPhoneNumber", + "documentation":"

The updated phone number of the contact. The phone number type defaults to WORK. You can either specify PhoneNumber or PhoneNumbers. We recommend that you use PhoneNumbers, which lets you specify the phone number type and multiple numbers.

" + }, + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The list of phone numbers for the contact.

" + }, + "SipAddresses":{ + "shape":"SipAddressList", + "documentation":"

The list of SIP addresses for 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":{ + } + }, + "UpdateGatewayGroupRequest":{ + "type":"structure", + "required":["GatewayGroupArn"], + "members":{ + "GatewayGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway group to update.

" + }, + "Name":{ + "shape":"GatewayGroupName", + "documentation":"

The updated name of the gateway group.

" + }, + "Description":{ + "shape":"GatewayGroupDescription", + "documentation":"

The updated description of the gateway group.

" + } + } + }, + "UpdateGatewayGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateGatewayRequest":{ + "type":"structure", + "required":["GatewayArn"], + "members":{ + "GatewayArn":{ + "shape":"Arn", + "documentation":"

The ARN of the gateway to update.

" + }, + "Name":{ + "shape":"GatewayName", + "documentation":"

The updated name of the gateway.

" + }, + "Description":{ + "shape":"GatewayDescription", + "documentation":"

The updated description of the gateway.

" + }, + "SoftwareVersion":{ + "shape":"GatewayVersion", + "documentation":"

The updated software version of the gateway. The gateway automatically updates its software version during normal operation.

" + } + } + }, + "UpdateGatewayResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateNetworkProfileRequest":{ + "type":"structure", + "required":["NetworkProfileArn"], + "members":{ + "NetworkProfileArn":{ + "shape":"Arn", + "documentation":"

The ARN of the network profile associated with a device.

" + }, + "NetworkProfileName":{ + "shape":"NetworkProfileName", + "documentation":"

The name of the network profile associated with a device.

" + }, + "Description":{ + "shape":"NetworkProfileDescription", + "documentation":"

Detailed information about a device's network profile.

" + }, + "CurrentPassword":{ + "shape":"CurrentWiFiPassword", + "documentation":"

The current password of the Wi-Fi network.

" + }, + "NextPassword":{ + "shape":"NextWiFiPassword", + "documentation":"

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

" + }, + "CertificateAuthorityArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

" + }, + "TrustAnchors":{ + "shape":"TrustAnchorList", + "documentation":"

The root certificate(s) of your authentication server that will be installed on your devices and used to trust your authentication server during EAP negotiation.

" + } + } + }, + "UpdateNetworkProfileResponse":{ + "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.

" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Sets the profile as default if selected. If this is missing, no update is done to the default status.

" + }, + "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.

" + }, + "Locale":{ + "shape":"DeviceLocale", + "documentation":"

The updated locale 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":{ + } + }, + "Url":{"type":"string"}, + "UserCode":{ + "type":"string", + "max":128, + "min":1 + }, + "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}" + }, + "Utterance":{"type":"string"}, + "Value":{ + "type":"string", + "min":1 + }, + "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 helps you use Alexa in your organization. Alexa for Business provides you with the tools to manage 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 also make these available as private skills for your organization. Alexa for Business makes it efficient to voice-enable your products and services, thus providing context-aware voice experiences for your customers. Device makers building with the Alexa Voice Service (AVS) can create fully integrated solutions, register their products with Alexa for Business, and manage them as shared devices in their organization.

" +} diff --git a/aws/dist/botocore/data/amplify/2017-07-25/paginators-1.json b/aws/dist/botocore/data/amplify/2017-07-25/paginators-1.json new file mode 100644 index 00000000..f84208e9 --- /dev/null +++ b/aws/dist/botocore/data/amplify/2017-07-25/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListApps": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "apps" + }, + "ListBranches": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "branches" + }, + "ListDomainAssociations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "domainAssociations" + }, + "ListJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobSummaries" + } + } +} diff --git a/aws/dist/botocore/data/amplify/2017-07-25/service-2.json b/aws/dist/botocore/data/amplify/2017-07-25/service-2.json new file mode 100644 index 00000000..35ea5265 --- /dev/null +++ b/aws/dist/botocore/data/amplify/2017-07-25/service-2.json @@ -0,0 +1,3027 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-25", + "endpointPrefix":"amplify", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Amplify", + "serviceFullName":"AWS Amplify", + "serviceId":"Amplify", + "signatureVersion":"v4", + "signingName":"amplify", + "uid":"amplify-2017-07-25" + }, + "operations":{ + "CreateApp":{ + "name":"CreateApp", + "http":{ + "method":"POST", + "requestUri":"/apps" + }, + "input":{"shape":"CreateAppRequest"}, + "output":{"shape":"CreateAppResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Creates a new Amplify App.

" + }, + "CreateBranch":{ + "name":"CreateBranch", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/branches" + }, + "input":{"shape":"CreateBranchRequest"}, + "output":{"shape":"CreateBranchResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Creates a new Branch for an Amplify App.

" + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/branches/{branchName}/deployments" + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{"shape":"CreateDeploymentResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Create a deployment for manual deploy apps. (Apps are not connected to repository)

" + }, + "CreateDomainAssociation":{ + "name":"CreateDomainAssociation", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/domains" + }, + "input":{"shape":"CreateDomainAssociationRequest"}, + "output":{"shape":"CreateDomainAssociationResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Create a new DomainAssociation on an App

" + }, + "CreateWebhook":{ + "name":"CreateWebhook", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/webhooks" + }, + "input":{"shape":"CreateWebhookRequest"}, + "output":{"shape":"CreateWebhookResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Create a new webhook on an App.

" + }, + "DeleteApp":{ + "name":"DeleteApp", + "http":{ + "method":"DELETE", + "requestUri":"/apps/{appId}" + }, + "input":{"shape":"DeleteAppRequest"}, + "output":{"shape":"DeleteAppResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Delete an existing Amplify App by appId.

" + }, + "DeleteBranch":{ + "name":"DeleteBranch", + "http":{ + "method":"DELETE", + "requestUri":"/apps/{appId}/branches/{branchName}" + }, + "input":{"shape":"DeleteBranchRequest"}, + "output":{"shape":"DeleteBranchResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Deletes a branch for an Amplify App.

" + }, + "DeleteDomainAssociation":{ + "name":"DeleteDomainAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/apps/{appId}/domains/{domainName}" + }, + "input":{"shape":"DeleteDomainAssociationRequest"}, + "output":{"shape":"DeleteDomainAssociationResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Deletes a DomainAssociation.

" + }, + "DeleteJob":{ + "name":"DeleteJob", + "http":{ + "method":"DELETE", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}" + }, + "input":{"shape":"DeleteJobRequest"}, + "output":{"shape":"DeleteJobResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Delete a job, for an Amplify branch, part of Amplify App.

" + }, + "DeleteWebhook":{ + "name":"DeleteWebhook", + "http":{ + "method":"DELETE", + "requestUri":"/webhooks/{webhookId}" + }, + "input":{"shape":"DeleteWebhookRequest"}, + "output":{"shape":"DeleteWebhookResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Deletes a webhook.

" + }, + "GenerateAccessLogs":{ + "name":"GenerateAccessLogs", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/accesslogs" + }, + "input":{"shape":"GenerateAccessLogsRequest"}, + "output":{"shape":"GenerateAccessLogsResult"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieve website access logs for a specific time range via a pre-signed URL.

" + }, + "GetApp":{ + "name":"GetApp", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}" + }, + "input":{"shape":"GetAppRequest"}, + "output":{"shape":"GetAppResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves an existing Amplify App by appId.

" + }, + "GetArtifactUrl":{ + "name":"GetArtifactUrl", + "http":{ + "method":"GET", + "requestUri":"/artifacts/{artifactId}" + }, + "input":{"shape":"GetArtifactUrlRequest"}, + "output":{"shape":"GetArtifactUrlResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Retrieves artifact info that corresponds to a artifactId.

" + }, + "GetBranch":{ + "name":"GetBranch", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/branches/{branchName}" + }, + "input":{"shape":"GetBranchRequest"}, + "output":{"shape":"GetBranchResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves a branch for an Amplify App.

" + }, + "GetDomainAssociation":{ + "name":"GetDomainAssociation", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/domains/{domainName}" + }, + "input":{"shape":"GetDomainAssociationRequest"}, + "output":{"shape":"GetDomainAssociationResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves domain info that corresponds to an appId and domainName.

" + }, + "GetJob":{ + "name":"GetJob", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}" + }, + "input":{"shape":"GetJobRequest"}, + "output":{"shape":"GetJobResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Get a job for a branch, part of an Amplify App.

" + }, + "GetWebhook":{ + "name":"GetWebhook", + "http":{ + "method":"GET", + "requestUri":"/webhooks/{webhookId}" + }, + "input":{"shape":"GetWebhookRequest"}, + "output":{"shape":"GetWebhookResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Retrieves webhook info that corresponds to a webhookId.

" + }, + "ListApps":{ + "name":"ListApps", + "http":{ + "method":"GET", + "requestUri":"/apps" + }, + "input":{"shape":"ListAppsRequest"}, + "output":{"shape":"ListAppsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists existing Amplify Apps.

" + }, + "ListArtifacts":{ + "name":"ListArtifacts", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts" + }, + "input":{"shape":"ListArtifactsRequest"}, + "output":{"shape":"ListArtifactsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

List artifacts with an app, a branch, a job and an artifact type.

" + }, + "ListBranches":{ + "name":"ListBranches", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/branches" + }, + "input":{"shape":"ListBranchesRequest"}, + "output":{"shape":"ListBranchesResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists branches for an Amplify App.

" + }, + "ListDomainAssociations":{ + "name":"ListDomainAssociations", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/domains" + }, + "input":{"shape":"ListDomainAssociationsRequest"}, + "output":{"shape":"ListDomainAssociationsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

List domains with an app

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

List Jobs for a branch, part of an Amplify App.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List tags for resource.

" + }, + "ListWebhooks":{ + "name":"ListWebhooks", + "http":{ + "method":"GET", + "requestUri":"/apps/{appId}/webhooks" + }, + "input":{"shape":"ListWebhooksRequest"}, + "output":{"shape":"ListWebhooksResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

List webhooks with an app.

" + }, + "StartDeployment":{ + "name":"StartDeployment", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/branches/{branchName}/deployments/start" + }, + "input":{"shape":"StartDeploymentRequest"}, + "output":{"shape":"StartDeploymentResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Start a deployment for manual deploy apps. (Apps are not connected to repository)

" + }, + "StartJob":{ + "name":"StartJob", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs" + }, + "input":{"shape":"StartJobRequest"}, + "output":{"shape":"StartJobResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Starts a new job for a branch, part of an Amplify App.

" + }, + "StopJob":{ + "name":"StopJob", + "http":{ + "method":"DELETE", + "requestUri":"/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop" + }, + "input":{"shape":"StopJobRequest"}, + "output":{"shape":"StopJobResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Tag resource with tag key and value.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Untag resource with resourceArn.

" + }, + "UpdateApp":{ + "name":"UpdateApp", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}" + }, + "input":{"shape":"UpdateAppRequest"}, + "output":{"shape":"UpdateAppResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates an existing Amplify App.

" + }, + "UpdateBranch":{ + "name":"UpdateBranch", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/branches/{branchName}" + }, + "input":{"shape":"UpdateBranchRequest"}, + "output":{"shape":"UpdateBranchResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Updates a branch for an Amplify App.

" + }, + "UpdateDomainAssociation":{ + "name":"UpdateDomainAssociation", + "http":{ + "method":"POST", + "requestUri":"/apps/{appId}/domains/{domainName}" + }, + "input":{"shape":"UpdateDomainAssociationRequest"}, + "output":{"shape":"UpdateDomainAssociationResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Create a new DomainAssociation on an App

" + }, + "UpdateWebhook":{ + "name":"UpdateWebhook", + "http":{ + "method":"POST", + "requestUri":"/webhooks/{webhookId}" + }, + "input":{"shape":"UpdateWebhookRequest"}, + "output":{"shape":"UpdateWebhookResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"DependentServiceFailureException"} + ], + "documentation":"

Update a webhook.

" + } + }, + "shapes":{ + "AccessToken":{ + "type":"string", + "max":255, + "min":1 + }, + "ActiveJobId":{ + "type":"string", + "max":1000 + }, + "App":{ + "type":"structure", + "required":[ + "appId", + "appArn", + "name", + "description", + "repository", + "platform", + "createTime", + "updateTime", + "environmentVariables", + "defaultDomain", + "enableBranchAutoBuild", + "enableBasicAuth" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for the Amplify App.

" + }, + "appArn":{ + "shape":"AppArn", + "documentation":"

ARN for the Amplify App.

" + }, + "name":{ + "shape":"Name", + "documentation":"

Name for the Amplify App.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Tag for Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for the Amplify App.

" + }, + "repository":{ + "shape":"Repository", + "documentation":"

Repository for the Amplify App.

" + }, + "platform":{ + "shape":"Platform", + "documentation":"

Platform for the Amplify App.

" + }, + "createTime":{ + "shape":"CreateTime", + "documentation":"

Create date / time for the Amplify App.

" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"

Update date / time for the Amplify App.

" + }, + "iamServiceRoleArn":{ + "shape":"ServiceRoleArn", + "documentation":"

IAM service role ARN for the Amplify App.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables for the Amplify App.

" + }, + "defaultDomain":{ + "shape":"DefaultDomain", + "documentation":"

Default domain for the Amplify App.

" + }, + "enableBranchAutoBuild":{ + "shape":"EnableBranchAutoBuild", + "documentation":"

Enables auto-building of branches for the Amplify App.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Authorization for branches for the Amplify App.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for branches for the Amplify App.

" + }, + "customRules":{ + "shape":"CustomRules", + "documentation":"

Custom redirect / rewrite rules for the Amplify App.

" + }, + "productionBranch":{ + "shape":"ProductionBranch", + "documentation":"

Structure with Production Branch information.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec content for Amplify App.

" + }, + "enableAutoBranchCreation":{ + "shape":"EnableAutoBranchCreation", + "documentation":"

Enables automated branch creation for the Amplify App.

" + }, + "autoBranchCreationPatterns":{ + "shape":"AutoBranchCreationPatterns", + "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + }, + "autoBranchCreationConfig":{ + "shape":"AutoBranchCreationConfig", + "documentation":"

Automated branch creation config for the Amplify App.

" + } + }, + "documentation":"

Amplify App represents different branches of a repository for building, deploying, and hosting.

" + }, + "AppArn":{ + "type":"string", + "max":1000 + }, + "AppId":{ + "type":"string", + "max":255, + "min":1 + }, + "Apps":{ + "type":"list", + "member":{"shape":"App"} + }, + "Artifact":{ + "type":"structure", + "required":[ + "artifactFileName", + "artifactId" + ], + "members":{ + "artifactFileName":{ + "shape":"ArtifactFileName", + "documentation":"

File name for the artifact.

" + }, + "artifactId":{ + "shape":"ArtifactId", + "documentation":"

Unique Id for a artifact.

" + } + }, + "documentation":"

Structure for artifact.

" + }, + "ArtifactFileName":{ + "type":"string", + "max":1000 + }, + "ArtifactId":{ + "type":"string", + "max":255 + }, + "ArtifactUrl":{ + "type":"string", + "max":1000 + }, + "Artifacts":{ + "type":"list", + "member":{"shape":"Artifact"} + }, + "ArtifactsUrl":{ + "type":"string", + "max":1000 + }, + "AssociatedResource":{ + "type":"string", + "max":2048, + "min":1 + }, + "AssociatedResources":{ + "type":"list", + "member":{"shape":"AssociatedResource"} + }, + "AutoBranchCreationConfig":{ + "type":"structure", + "members":{ + "stage":{ + "shape":"Stage", + "documentation":"

Stage for the auto created branch.

" + }, + "framework":{ + "shape":"Framework", + "documentation":"

Framework for the auto created branch.

" + }, + "enableAutoBuild":{ + "shape":"EnableAutoBuild", + "documentation":"

Enables auto building for the auto created branch.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables for the auto created branch.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for the auto created branch.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Auth for the auto created branch.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec for the auto created branch.

" + }, + "enablePullRequestPreview":{ + "shape":"EnablePullRequestPreview", + "documentation":"

Enables Pull Request Preview for auto created branch.

" + }, + "pullRequestEnvironmentName":{ + "shape":"PullRequestEnvironmentName", + "documentation":"

The Amplify Environment name for the pull request.

" + } + }, + "documentation":"

Structure with auto branch creation config.

" + }, + "AutoBranchCreationPattern":{ + "type":"string", + "max":2048, + "min":1 + }, + "AutoBranchCreationPatterns":{ + "type":"list", + "member":{"shape":"AutoBranchCreationPattern"} + }, + "BackendEnvironmentArn":{ + "type":"string", + "max":1000, + "min":1 + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when a request contains unexpected data.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BasicAuthCredentials":{ + "type":"string", + "max":2000 + }, + "Branch":{ + "type":"structure", + "required":[ + "branchArn", + "branchName", + "description", + "stage", + "displayName", + "enableNotification", + "createTime", + "updateTime", + "environmentVariables", + "enableAutoBuild", + "customDomains", + "framework", + "activeJobId", + "totalNumberOfJobs", + "enableBasicAuth", + "ttl", + "enablePullRequestPreview" + ], + "members":{ + "branchArn":{ + "shape":"BranchArn", + "documentation":"

ARN for a branch, part of an Amplify App.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch, part of an Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for a branch, part of an Amplify App.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Tag for branch for Amplify App.

" + }, + "stage":{ + "shape":"Stage", + "documentation":"

Stage for a branch, part of an Amplify App.

" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"

Display name for a branch, will use as the default domain prefix.

" + }, + "enableNotification":{ + "shape":"EnableNotification", + "documentation":"

Enables notifications for a branch, part of an Amplify App.

" + }, + "createTime":{ + "shape":"CreateTime", + "documentation":"

Creation date and time for a branch, part of an Amplify App.

" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"

Last updated date and time for a branch, part of an Amplify App.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables specific to a branch, part of an Amplify App.

" + }, + "enableAutoBuild":{ + "shape":"EnableAutoBuild", + "documentation":"

Enables auto-building on push for a branch, part of an Amplify App.

" + }, + "customDomains":{ + "shape":"CustomDomains", + "documentation":"

Custom domains for a branch, part of an Amplify App.

" + }, + "framework":{ + "shape":"Framework", + "documentation":"

Framework for a branch, part of an Amplify App.

" + }, + "activeJobId":{ + "shape":"ActiveJobId", + "documentation":"

Id of the active job for a branch, part of an Amplify App.

" + }, + "totalNumberOfJobs":{ + "shape":"TotalNumberOfJobs", + "documentation":"

Total number of Jobs part of an Amplify App.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Authorization for a branch, part of an Amplify App.

" + }, + "thumbnailUrl":{ + "shape":"ThumbnailUrl", + "documentation":"

Thumbnail URL for the branch.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for a branch, part of an Amplify App.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec content for branch for Amplify App.

" + }, + "ttl":{ + "shape":"TTL", + "documentation":"

The content TTL for the website in seconds.

" + }, + "associatedResources":{ + "shape":"AssociatedResources", + "documentation":"

List of custom resources that are linked to this branch.

" + }, + "enablePullRequestPreview":{ + "shape":"EnablePullRequestPreview", + "documentation":"

Enables Pull Request Preview for this branch.

" + }, + "pullRequestEnvironmentName":{ + "shape":"PullRequestEnvironmentName", + "documentation":"

The Amplify Environment name for the pull request.

" + }, + "destinationBranch":{ + "shape":"BranchName", + "documentation":"

The destination branch if the branch is a pull request branch.

" + }, + "sourceBranch":{ + "shape":"BranchName", + "documentation":"

The source branch if the branch is a pull request branch.

" + }, + "backendEnvironmentArn":{ + "shape":"BackendEnvironmentArn", + "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + } + }, + "documentation":"

Branch for an Amplify App, which maps to a 3rd party repository branch.

" + }, + "BranchArn":{ + "type":"string", + "max":1000 + }, + "BranchName":{ + "type":"string", + "max":255, + "min":1 + }, + "Branches":{ + "type":"list", + "member":{"shape":"Branch"}, + "max":255 + }, + "BuildSpec":{ + "type":"string", + "documentation":"

BuildSpec file for Amplify app build.

", + "max":25000, + "min":1 + }, + "CertificateVerificationDNSRecord":{ + "type":"string", + "max":1000 + }, + "Code":{"type":"string"}, + "CommitId":{ + "type":"string", + "max":255 + }, + "CommitMessage":{ + "type":"string", + "max":10000 + }, + "CommitTime":{"type":"timestamp"}, + "Condition":{ + "type":"string", + "max":2048, + "min":1 + }, + "Context":{"type":"string"}, + "CreateAppRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

Name for the Amplify App

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for an Amplify App

" + }, + "repository":{ + "shape":"Repository", + "documentation":"

Repository for an Amplify App

" + }, + "platform":{ + "shape":"Platform", + "documentation":"

Platform / framework for an Amplify App

" + }, + "iamServiceRoleArn":{ + "shape":"ServiceRoleArn", + "documentation":"

AWS IAM service role for an Amplify App

" + }, + "oauthToken":{ + "shape":"OauthToken", + "documentation":"

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

" + }, + "accessToken":{ + "shape":"AccessToken", + "documentation":"

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment variables map for an Amplify App.

" + }, + "enableBranchAutoBuild":{ + "shape":"EnableBranchAutoBuild", + "documentation":"

Enable the auto building of branches for an Amplify App.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Credentials for Basic Authorization for an Amplify App.

" + }, + "customRules":{ + "shape":"CustomRules", + "documentation":"

Custom rewrite / redirect rules for an Amplify App.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Tag for an Amplify App

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec for an Amplify App

" + }, + "enableAutoBranchCreation":{ + "shape":"EnableAutoBranchCreation", + "documentation":"

Enables automated branch creation for the Amplify App.

" + }, + "autoBranchCreationPatterns":{ + "shape":"AutoBranchCreationPatterns", + "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + }, + "autoBranchCreationConfig":{ + "shape":"AutoBranchCreationConfig", + "documentation":"

Automated branch creation config for the Amplify App.

" + } + }, + "documentation":"

Request structure used to create Apps in Amplify.

" + }, + "CreateAppResult":{ + "type":"structure", + "required":["app"], + "members":{ + "app":{"shape":"App"} + } + }, + "CreateBranchRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for the branch.

" + }, + "stage":{ + "shape":"Stage", + "documentation":"

Stage for the branch.

" + }, + "framework":{ + "shape":"Framework", + "documentation":"

Framework for the branch.

" + }, + "enableNotification":{ + "shape":"EnableNotification", + "documentation":"

Enables notifications for the branch.

" + }, + "enableAutoBuild":{ + "shape":"EnableAutoBuild", + "documentation":"

Enables auto building for the branch.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables for the branch.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for the branch.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Auth for the branch.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Tag for the branch.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec for the branch.

" + }, + "ttl":{ + "shape":"TTL", + "documentation":"

The content TTL for the website in seconds.

" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"

Display name for a branch, will use as the default domain prefix.

" + }, + "enablePullRequestPreview":{ + "shape":"EnablePullRequestPreview", + "documentation":"

Enables Pull Request Preview for this branch.

" + }, + "pullRequestEnvironmentName":{ + "shape":"PullRequestEnvironmentName", + "documentation":"

The Amplify Environment name for the pull request.

" + }, + "backendEnvironmentArn":{ + "shape":"BackendEnvironmentArn", + "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + } + }, + "documentation":"

Request structure for a branch create request.

" + }, + "CreateBranchResult":{ + "type":"structure", + "required":["branch"], + "members":{ + "branch":{ + "shape":"Branch", + "documentation":"

Branch structure for an Amplify App.

" + } + }, + "documentation":"

Result structure for create branch request.

" + }, + "CreateDeploymentRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "fileMap":{ + "shape":"FileMap", + "documentation":"

Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.

" + } + }, + "documentation":"

Request structure for create a new deployment.

" + }, + "CreateDeploymentResult":{ + "type":"structure", + "required":[ + "fileUploadUrls", + "zipUploadUrl" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The jobId for this deployment, will supply to start deployment api.

" + }, + "fileUploadUrls":{ + "shape":"FileUploadUrls", + "documentation":"

When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.

" + }, + "zipUploadUrl":{ + "shape":"UploadUrl", + "documentation":"

When the fileMap argument is NOT provided. This zipUploadUrl will be returned.

" + } + }, + "documentation":"

Result structure for create a new deployment.

" + }, + "CreateDomainAssociationRequest":{ + "type":"structure", + "required":[ + "appId", + "domainName", + "subDomainSettings" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Domain name for the Domain Association.

" + }, + "enableAutoSubDomain":{ + "shape":"EnableAutoSubDomain", + "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + }, + "subDomainSettings":{ + "shape":"SubDomainSettings", + "documentation":"

Setting structure for the Subdomain.

" + } + }, + "documentation":"

Request structure for create Domain Association request.

" + }, + "CreateDomainAssociationResult":{ + "type":"structure", + "required":["domainAssociation"], + "members":{ + "domainAssociation":{ + "shape":"DomainAssociation", + "documentation":"

Domain Association structure.

" + } + }, + "documentation":"

Result structure for the create Domain Association request.

" + }, + "CreateTime":{"type":"timestamp"}, + "CreateWebhookRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch, part of an Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for a webhook.

" + } + }, + "documentation":"

Request structure for create webhook request.

" + }, + "CreateWebhookResult":{ + "type":"structure", + "required":["webhook"], + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Webhook structure.

" + } + }, + "documentation":"

Result structure for the create webhook request.

" + }, + "CustomDomain":{ + "type":"string", + "max":255 + }, + "CustomDomains":{ + "type":"list", + "member":{"shape":"CustomDomain"}, + "max":255 + }, + "CustomRule":{ + "type":"structure", + "required":[ + "source", + "target" + ], + "members":{ + "source":{ + "shape":"Source", + "documentation":"

The source pattern for a URL rewrite or redirect rule.

" + }, + "target":{ + "shape":"Target", + "documentation":"

The target pattern for a URL rewrite or redirect rule.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status code for a URL rewrite or redirect rule.

" + }, + "condition":{ + "shape":"Condition", + "documentation":"

The condition for a URL rewrite or redirect rule, e.g. country code.

" + } + }, + "documentation":"

Custom rewrite / redirect rule.

" + }, + "CustomRules":{ + "type":"list", + "member":{"shape":"CustomRule"} + }, + "DNSRecord":{ + "type":"string", + "max":1000 + }, + "DefaultDomain":{ + "type":"string", + "max":1000, + "min":1 + }, + "DeleteAppRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + } + }, + "documentation":"

Request structure for an Amplify App delete request.

" + }, + "DeleteAppResult":{ + "type":"structure", + "required":["app"], + "members":{ + "app":{"shape":"App"} + }, + "documentation":"

Result structure for an Amplify App delete request.

" + }, + "DeleteBranchRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch.

", + "location":"uri", + "locationName":"branchName" + } + }, + "documentation":"

Request structure for delete branch request.

" + }, + "DeleteBranchResult":{ + "type":"structure", + "required":["branch"], + "members":{ + "branch":{ + "shape":"Branch", + "documentation":"

Branch structure for an Amplify App.

" + } + }, + "documentation":"

Result structure for delete branch request.

" + }, + "DeleteDomainAssociationRequest":{ + "type":"structure", + "required":[ + "appId", + "domainName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Name of the domain.

", + "location":"uri", + "locationName":"domainName" + } + }, + "documentation":"

Request structure for the delete Domain Association request.

" + }, + "DeleteDomainAssociationResult":{ + "type":"structure", + "required":["domainAssociation"], + "members":{ + "domainAssociation":{"shape":"DomainAssociation"} + } + }, + "DeleteJobRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName", + "jobId" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for the Job.

", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"

Request structure for delete job request.

" + }, + "DeleteJobResult":{ + "type":"structure", + "required":["jobSummary"], + "members":{ + "jobSummary":{"shape":"JobSummary"} + }, + "documentation":"

Result structure for the delete job request.

" + }, + "DeleteWebhookRequest":{ + "type":"structure", + "required":["webhookId"], + "members":{ + "webhookId":{ + "shape":"WebhookId", + "documentation":"

Unique Id for a webhook.

", + "location":"uri", + "locationName":"webhookId" + } + }, + "documentation":"

Request structure for the delete webhook request.

" + }, + "DeleteWebhookResult":{ + "type":"structure", + "required":["webhook"], + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Webhook structure.

" + } + }, + "documentation":"

Result structure for the delete webhook request.

" + }, + "DependentServiceFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when an operation fails due to a dependent service throwing an exception.

", + "error":{"httpStatusCode":503}, + "exception":true + }, + "Description":{ + "type":"string", + "max":1000 + }, + "DisplayName":{ + "type":"string", + "max":255 + }, + "DomainAssociation":{ + "type":"structure", + "required":[ + "domainAssociationArn", + "domainName", + "enableAutoSubDomain", + "domainStatus", + "statusReason", + "subDomains" + ], + "members":{ + "domainAssociationArn":{ + "shape":"DomainAssociationArn", + "documentation":"

ARN for the Domain Association.

" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Name of the domain.

" + }, + "enableAutoSubDomain":{ + "shape":"EnableAutoSubDomain", + "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + }, + "domainStatus":{ + "shape":"DomainStatus", + "documentation":"

Status fo the Domain Association.

" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"

Reason for the current status of the Domain Association.

" + }, + "certificateVerificationDNSRecord":{ + "shape":"CertificateVerificationDNSRecord", + "documentation":"

DNS Record for certificate verification.

" + }, + "subDomains":{ + "shape":"SubDomains", + "documentation":"

Subdomains for the Domain Association.

" + } + }, + "documentation":"

Structure for Domain Association, which associates a custom domain with an Amplify App.

" + }, + "DomainAssociationArn":{ + "type":"string", + "max":1000 + }, + "DomainAssociations":{ + "type":"list", + "member":{"shape":"DomainAssociation"}, + "max":255 + }, + "DomainName":{ + "type":"string", + "max":255 + }, + "DomainPrefix":{ + "type":"string", + "max":255 + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "PENDING_VERIFICATION", + "IN_PROGRESS", + "AVAILABLE", + "PENDING_DEPLOYMENT", + "FAILED", + "CREATING", + "REQUESTING_CERTIFICATE", + "UPDATING" + ] + }, + "EnableAutoBranchCreation":{"type":"boolean"}, + "EnableAutoBuild":{"type":"boolean"}, + "EnableAutoSubDomain":{"type":"boolean"}, + "EnableBasicAuth":{"type":"boolean"}, + "EnableBranchAutoBuild":{"type":"boolean"}, + "EnableNotification":{"type":"boolean"}, + "EnablePullRequestPreview":{"type":"boolean"}, + "EndTime":{"type":"timestamp"}, + "EnvKey":{ + "type":"string", + "max":255 + }, + "EnvValue":{ + "type":"string", + "max":1000 + }, + "EnvironmentVariables":{ + "type":"map", + "key":{"shape":"EnvKey"}, + "value":{"shape":"EnvValue"} + }, + "ErrorMessage":{ + "type":"string", + "max":255 + }, + "FileMap":{ + "type":"map", + "key":{"shape":"FileName"}, + "value":{"shape":"MD5Hash"} + }, + "FileName":{ + "type":"string", + "max":255 + }, + "FileUploadUrls":{ + "type":"map", + "key":{"shape":"FileName"}, + "value":{"shape":"UploadUrl"} + }, + "Framework":{ + "type":"string", + "max":255 + }, + "GenerateAccessLogsRequest":{ + "type":"structure", + "required":[ + "domainName", + "appId" + ], + "members":{ + "startTime":{ + "shape":"StartTime", + "documentation":"

The time at which the logs should start, inclusive.

" + }, + "endTime":{ + "shape":"EndTime", + "documentation":"

The time at which the logs should end, inclusive.

" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Name of the domain.

" + }, + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + } + }, + "documentation":"

Request structure for the generate access logs request.

" + }, + "GenerateAccessLogsResult":{ + "type":"structure", + "members":{ + "logUrl":{ + "shape":"LogUrl", + "documentation":"

Pre-signed URL for the requested access logs.

" + } + }, + "documentation":"

Result structure for the generate access logs request.

" + }, + "GetAppRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + } + }, + "documentation":"

Request structure for get App request.

" + }, + "GetAppResult":{ + "type":"structure", + "required":["app"], + "members":{ + "app":{"shape":"App"} + } + }, + "GetArtifactUrlRequest":{ + "type":"structure", + "required":["artifactId"], + "members":{ + "artifactId":{ + "shape":"ArtifactId", + "documentation":"

Unique Id for a artifact.

", + "location":"uri", + "locationName":"artifactId" + } + }, + "documentation":"

Request structure for the get artifact request.

" + }, + "GetArtifactUrlResult":{ + "type":"structure", + "required":[ + "artifactId", + "artifactUrl" + ], + "members":{ + "artifactId":{ + "shape":"ArtifactId", + "documentation":"

Unique Id for a artifact.

" + }, + "artifactUrl":{ + "shape":"ArtifactUrl", + "documentation":"

Presigned url for the artifact.

" + } + }, + "documentation":"

Result structure for the get artifact request.

" + }, + "GetBranchRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch.

", + "location":"uri", + "locationName":"branchName" + } + }, + "documentation":"

Request structure for get branch request.

" + }, + "GetBranchResult":{ + "type":"structure", + "required":["branch"], + "members":{ + "branch":{"shape":"Branch"} + } + }, + "GetDomainAssociationRequest":{ + "type":"structure", + "required":[ + "appId", + "domainName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Name of the domain.

", + "location":"uri", + "locationName":"domainName" + } + }, + "documentation":"

Request structure for the get Domain Association request.

" + }, + "GetDomainAssociationResult":{ + "type":"structure", + "required":["domainAssociation"], + "members":{ + "domainAssociation":{ + "shape":"DomainAssociation", + "documentation":"

Domain Association structure.

" + } + }, + "documentation":"

Result structure for the get Domain Association request.

" + }, + "GetJobRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName", + "jobId" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for the Job.

", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"

Request structure for get job request.

" + }, + "GetJobResult":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Job"} + } + }, + "GetWebhookRequest":{ + "type":"structure", + "required":["webhookId"], + "members":{ + "webhookId":{ + "shape":"WebhookId", + "documentation":"

Unique Id for a webhook.

", + "location":"uri", + "locationName":"webhookId" + } + }, + "documentation":"

Request structure for the get webhook request.

" + }, + "GetWebhookResult":{ + "type":"structure", + "required":["webhook"], + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Webhook structure.

" + } + }, + "documentation":"

Result structure for the get webhook request.

" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when the service fails to perform an operation due to an internal issue.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "Job":{ + "type":"structure", + "required":[ + "summary", + "steps" + ], + "members":{ + "summary":{ + "shape":"JobSummary", + "documentation":"

Summary for an execution job for an Amplify App.

" + }, + "steps":{ + "shape":"Steps", + "documentation":"

Execution steps for an execution job, for an Amplify App.

" + } + }, + "documentation":"

Structure for an execution job for an Amplify App.

" + }, + "JobArn":{ + "type":"string", + "max":1000 + }, + "JobId":{ + "type":"string", + "max":255 + }, + "JobReason":{ + "type":"string", + "max":255 + }, + "JobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "PROVISIONING", + "RUNNING", + "FAILED", + "SUCCEED", + "CANCELLING", + "CANCELLED" + ] + }, + "JobSummaries":{ + "type":"list", + "member":{"shape":"JobSummary"} + }, + "JobSummary":{ + "type":"structure", + "required":[ + "jobArn", + "jobId", + "commitId", + "commitMessage", + "commitTime", + "startTime", + "status", + "jobType" + ], + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

Arn for the Job.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for the Job.

" + }, + "commitId":{ + "shape":"CommitId", + "documentation":"

Commit Id from 3rd party repository provider for the Job.

" + }, + "commitMessage":{ + "shape":"CommitMessage", + "documentation":"

Commit message from 3rd party repository provider for the Job.

" + }, + "commitTime":{ + "shape":"CommitTime", + "documentation":"

Commit date / time for the Job.

" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"

Start date / time for the Job.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

Status for the Job.

" + }, + "endTime":{ + "shape":"EndTime", + "documentation":"

End date / time for the Job.

" + }, + "jobType":{ + "shape":"JobType", + "documentation":"

Type for the Job. \\n \"RELEASE\": Manually released from source by using StartJob API. \"RETRY\": Manually retried by using StartJob API. \"WEB_HOOK\": Automatically triggered by WebHooks.

" + } + }, + "documentation":"

Structure for the summary of a Job.

" + }, + "JobType":{ + "type":"string", + "enum":[ + "RELEASE", + "RETRY", + "MANUAL", + "WEB_HOOK" + ], + "max":10 + }, + "LastDeployTime":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when a resource could not be created because of service limits.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListAppsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for an Amplify App list request.

" + }, + "ListAppsResult":{ + "type":"structure", + "required":["apps"], + "members":{ + "apps":{ + "shape":"Apps", + "documentation":"

List of Amplify Apps.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

" + } + }, + "documentation":"

Result structure for an Amplify App list request.

" + }, + "ListArtifactsRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName", + "jobId" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch, part of an Amplify App.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for an Job.

", + "location":"uri", + "locationName":"jobId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing artifacts from start. If non-null pagination token is returned in a result, then pass its value in here to list more artifacts.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for the list artifacts request.

" + }, + "ListArtifactsResult":{ + "type":"structure", + "required":["artifacts"], + "members":{ + "artifacts":{ + "shape":"Artifacts", + "documentation":"

List of artifacts.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Result structure for the list artifacts request.

" + }, + "ListBranchesRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing branches from start. If a non-null pagination token is returned in a result, then pass its value in here to list more branches.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for list branches request.

" + }, + "ListBranchesResult":{ + "type":"structure", + "required":["branches"], + "members":{ + "branches":{ + "shape":"Branches", + "documentation":"

List of branches for an Amplify App.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Result structure for list branches request.

" + }, + "ListDomainAssociationsRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for the list Domain Associations request.

" + }, + "ListDomainAssociationsResult":{ + "type":"structure", + "required":["domainAssociations"], + "members":{ + "domainAssociations":{ + "shape":"DomainAssociations", + "documentation":"

List of Domain Associations.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Result structure for the list Domain Association request.

" + }, + "ListJobsRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch.

", + "location":"uri", + "locationName":"branchName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing steps from start. If a non-null pagination token is returned in a result, then pass its value in here to list more steps.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for list job request.

" + }, + "ListJobsResult":{ + "type":"structure", + "required":["jobSummaries"], + "members":{ + "jobSummaries":{ + "shape":"JobSummaries", + "documentation":"

Result structure for list job result request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Maximum number of records to list in a single response.

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

Resource arn used to list tags.

", + "location":"uri", + "locationName":"resourceArn" + } + }, + "documentation":"

Request structure used to list tags for resource.

" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

Tags result for response.

" + } + }, + "documentation":"

Response for list tags.

" + }, + "ListWebhooksRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + } + }, + "documentation":"

Request structure for the list webhooks request.

" + }, + "ListWebhooksResult":{ + "type":"structure", + "required":["webhooks"], + "members":{ + "webhooks":{ + "shape":"Webhooks", + "documentation":"

List of webhooks.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Result structure for the list webhooks request.

" + }, + "LogUrl":{ + "type":"string", + "max":1000 + }, + "MD5Hash":{ + "type":"string", + "max":32 + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "max":255, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":2000 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when an entity has not been found during an operation.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "OauthToken":{ + "type":"string", + "max":100 + }, + "Platform":{ + "type":"string", + "enum":["WEB"] + }, + "ProductionBranch":{ + "type":"structure", + "members":{ + "lastDeployTime":{ + "shape":"LastDeployTime", + "documentation":"

Last Deploy Time of Production Branch.

" + }, + "status":{ + "shape":"Status", + "documentation":"

Status of Production Branch.

" + }, + "thumbnailUrl":{ + "shape":"ThumbnailUrl", + "documentation":"

Thumbnail URL for Production Branch.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Branch Name for Production Branch.

" + } + }, + "documentation":"

Structure with Production Branch information.

" + }, + "PullRequestEnvironmentName":{ + "type":"string", + "max":20 + }, + "Repository":{ + "type":"string", + "max":1000 + }, + "ResourceArn":{ + "type":"string", + "pattern":"^arn:aws:amplify:.*" + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when an operation fails due to non-existent resource.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Screenshots":{ + "type":"map", + "key":{"shape":"ThumbnailName"}, + "value":{"shape":"ThumbnailUrl"} + }, + "ServiceRoleArn":{ + "type":"string", + "max":1000, + "min":1 + }, + "Source":{ + "type":"string", + "max":2048, + "min":1 + }, + "SourceUrl":{ + "type":"string", + "max":1000 + }, + "Stage":{ + "type":"string", + "enum":[ + "PRODUCTION", + "BETA", + "DEVELOPMENT", + "EXPERIMENTAL", + "PULL_REQUEST" + ] + }, + "StartDeploymentRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The job id for this deployment, generated by create deployment request.

" + }, + "sourceUrl":{ + "shape":"SourceUrl", + "documentation":"

The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.

" + } + }, + "documentation":"

Request structure for start a deployment.

" + }, + "StartDeploymentResult":{ + "type":"structure", + "required":["jobSummary"], + "members":{ + "jobSummary":{ + "shape":"JobSummary", + "documentation":"

Summary for the Job.

" + } + }, + "documentation":"

Result structure for start a deployment.

" + }, + "StartJobRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName", + "jobType" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for an existing job. Required for \"RETRY\" JobType.

" + }, + "jobType":{ + "shape":"JobType", + "documentation":"

Type for the Job. Available JobTypes are: \\n \"RELEASE\": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. \"RETRY\": Retry an existing job. JobId is required for this type of job.

" + }, + "jobReason":{ + "shape":"JobReason", + "documentation":"

Descriptive reason for starting this job.

" + }, + "commitId":{ + "shape":"CommitId", + "documentation":"

Commit Id from 3rd party repository provider for the Job.

" + }, + "commitMessage":{ + "shape":"CommitMessage", + "documentation":"

Commit message from 3rd party repository provider for the Job.

" + }, + "commitTime":{ + "shape":"CommitTime", + "documentation":"

Commit date / time for the Job.

" + } + }, + "documentation":"

Request structure for Start job request.

" + }, + "StartJobResult":{ + "type":"structure", + "required":["jobSummary"], + "members":{ + "jobSummary":{ + "shape":"JobSummary", + "documentation":"

Summary for the Job.

" + } + }, + "documentation":"

Result structure for run job request.

" + }, + "StartTime":{"type":"timestamp"}, + "Status":{ + "type":"string", + "max":7, + "min":3 + }, + "StatusReason":{ + "type":"string", + "max":1000 + }, + "Step":{ + "type":"structure", + "required":[ + "stepName", + "startTime", + "status", + "endTime" + ], + "members":{ + "stepName":{ + "shape":"StepName", + "documentation":"

Name of the execution step.

" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"

Start date/ time of the execution step.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

Status of the execution step.

" + }, + "endTime":{ + "shape":"EndTime", + "documentation":"

End date/ time of the execution step.

" + }, + "logUrl":{ + "shape":"LogUrl", + "documentation":"

URL to the logs for the execution step.

" + }, + "artifactsUrl":{ + "shape":"ArtifactsUrl", + "documentation":"

URL to the artifact for the execution step.

" + }, + "testArtifactsUrl":{ + "shape":"TestArtifactsUrl", + "documentation":"

URL to the test artifact for the execution step.

" + }, + "testConfigUrl":{ + "shape":"TestConfigUrl", + "documentation":"

URL to the test config for the execution step.

" + }, + "screenshots":{ + "shape":"Screenshots", + "documentation":"

List of screenshot URLs for the execution step, if relevant.

" + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"

The reason for current step status.

" + }, + "context":{ + "shape":"Context", + "documentation":"

The context for current step, will include build image if step is build.

" + } + }, + "documentation":"

Structure for an execution step for an execution job, for an Amplify App.

" + }, + "StepName":{ + "type":"string", + "max":255 + }, + "Steps":{ + "type":"list", + "member":{"shape":"Step"} + }, + "StopJobRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName", + "jobId" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch, for the Job.

", + "location":"uri", + "locationName":"branchName" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

Unique Id for the Job.

", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"

Request structure for stop job request.

" + }, + "StopJobResult":{ + "type":"structure", + "required":["jobSummary"], + "members":{ + "jobSummary":{ + "shape":"JobSummary", + "documentation":"

Summary for the Job.

" + } + }, + "documentation":"

Result structure for the stop job request.

" + }, + "SubDomain":{ + "type":"structure", + "required":[ + "subDomainSetting", + "verified", + "dnsRecord" + ], + "members":{ + "subDomainSetting":{ + "shape":"SubDomainSetting", + "documentation":"

Setting structure for the Subdomain.

" + }, + "verified":{ + "shape":"Verified", + "documentation":"

Verified status of the Subdomain

" + }, + "dnsRecord":{ + "shape":"DNSRecord", + "documentation":"

DNS record for the Subdomain.

" + } + }, + "documentation":"

Subdomain for the Domain Association.

" + }, + "SubDomainSetting":{ + "type":"structure", + "required":[ + "prefix", + "branchName" + ], + "members":{ + "prefix":{ + "shape":"DomainPrefix", + "documentation":"

Prefix setting for the Subdomain.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Branch name setting for the Subdomain.

" + } + }, + "documentation":"

Setting for the Subdomain.

" + }, + "SubDomainSettings":{ + "type":"list", + "member":{"shape":"SubDomainSetting"}, + "max":255 + }, + "SubDomains":{ + "type":"list", + "member":{"shape":"SubDomain"}, + "max":255 + }, + "TTL":{ + "type":"string", + "documentation":"

The content TTL for the website in seconds.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

Resource arn used to tag resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Tags used to tag resource.

" + } + }, + "documentation":"

Request structure used to tag resource.

" + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response for tag resource.

" + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Target":{ + "type":"string", + "max":2048, + "min":1 + }, + "TestArtifactsUrl":{ + "type":"string", + "max":1000 + }, + "TestConfigUrl":{ + "type":"string", + "max":1000 + }, + "ThumbnailName":{ + "type":"string", + "max":256 + }, + "ThumbnailUrl":{ + "type":"string", + "max":2000, + "min":1 + }, + "TotalNumberOfJobs":{ + "type":"string", + "max":1000 + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown when an operation fails due to a lack of access.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

Resource arn used to untag resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

Tag keys used to untag resource.

", + "location":"querystring", + "locationName":"tagKeys" + } + }, + "documentation":"

Request structure used to untag resource.

" + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response for untag resource.

" + }, + "UpdateAppRequest":{ + "type":"structure", + "required":["appId"], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "name":{ + "shape":"Name", + "documentation":"

Name for an Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for an Amplify App.

" + }, + "platform":{ + "shape":"Platform", + "documentation":"

Platform for an Amplify App.

" + }, + "iamServiceRoleArn":{ + "shape":"ServiceRoleArn", + "documentation":"

IAM service role for an Amplify App.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables for an Amplify App.

" + }, + "enableBranchAutoBuild":{ + "shape":"EnableAutoBuild", + "documentation":"

Enables branch auto-building for an Amplify App.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Authorization for an Amplify App.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for an Amplify App.

" + }, + "customRules":{ + "shape":"CustomRules", + "documentation":"

Custom redirect / rewrite rules for an Amplify App.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec for an Amplify App.

" + }, + "enableAutoBranchCreation":{ + "shape":"EnableAutoBranchCreation", + "documentation":"

Enables automated branch creation for the Amplify App.

" + }, + "autoBranchCreationPatterns":{ + "shape":"AutoBranchCreationPatterns", + "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + }, + "autoBranchCreationConfig":{ + "shape":"AutoBranchCreationConfig", + "documentation":"

Automated branch creation branchConfig for the Amplify App.

" + }, + "repository":{ + "shape":"Repository", + "documentation":"

Repository for an Amplify App

" + }, + "oauthToken":{ + "shape":"OauthToken", + "documentation":"

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

" + }, + "accessToken":{ + "shape":"AccessToken", + "documentation":"

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

" + } + }, + "documentation":"

Request structure for update App request.

" + }, + "UpdateAppResult":{ + "type":"structure", + "required":["app"], + "members":{ + "app":{ + "shape":"App", + "documentation":"

App structure for the updated App.

" + } + }, + "documentation":"

Result structure for an Amplify App update request.

" + }, + "UpdateBranchRequest":{ + "type":"structure", + "required":[ + "appId", + "branchName" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for the branch.

", + "location":"uri", + "locationName":"branchName" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for the branch.

" + }, + "framework":{ + "shape":"Framework", + "documentation":"

Framework for the branch.

" + }, + "stage":{ + "shape":"Stage", + "documentation":"

Stage for the branch.

" + }, + "enableNotification":{ + "shape":"EnableNotification", + "documentation":"

Enables notifications for the branch.

" + }, + "enableAutoBuild":{ + "shape":"EnableAutoBuild", + "documentation":"

Enables auto building for the branch.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment Variables for the branch.

" + }, + "basicAuthCredentials":{ + "shape":"BasicAuthCredentials", + "documentation":"

Basic Authorization credentials for the branch.

" + }, + "enableBasicAuth":{ + "shape":"EnableBasicAuth", + "documentation":"

Enables Basic Auth for the branch.

" + }, + "buildSpec":{ + "shape":"BuildSpec", + "documentation":"

BuildSpec for the branch.

" + }, + "ttl":{ + "shape":"TTL", + "documentation":"

The content TTL for the website in seconds.

" + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"

Display name for a branch, will use as the default domain prefix.

" + }, + "enablePullRequestPreview":{ + "shape":"EnablePullRequestPreview", + "documentation":"

Enables Pull Request Preview for this branch.

" + }, + "pullRequestEnvironmentName":{ + "shape":"PullRequestEnvironmentName", + "documentation":"

The Amplify Environment name for the pull request.

" + }, + "backendEnvironmentArn":{ + "shape":"BackendEnvironmentArn", + "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + } + }, + "documentation":"

Request structure for update branch request.

" + }, + "UpdateBranchResult":{ + "type":"structure", + "required":["branch"], + "members":{ + "branch":{ + "shape":"Branch", + "documentation":"

Branch structure for an Amplify App.

" + } + }, + "documentation":"

Result structure for update branch request.

" + }, + "UpdateDomainAssociationRequest":{ + "type":"structure", + "required":[ + "appId", + "domainName", + "subDomainSettings" + ], + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

Unique Id for an Amplify App.

", + "location":"uri", + "locationName":"appId" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

Name of the domain.

", + "location":"uri", + "locationName":"domainName" + }, + "enableAutoSubDomain":{ + "shape":"EnableAutoSubDomain", + "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + }, + "subDomainSettings":{ + "shape":"SubDomainSettings", + "documentation":"

Setting structure for the Subdomain.

" + } + }, + "documentation":"

Request structure for update Domain Association request.

" + }, + "UpdateDomainAssociationResult":{ + "type":"structure", + "required":["domainAssociation"], + "members":{ + "domainAssociation":{ + "shape":"DomainAssociation", + "documentation":"

Domain Association structure.

" + } + }, + "documentation":"

Result structure for the update Domain Association request.

" + }, + "UpdateTime":{"type":"timestamp"}, + "UpdateWebhookRequest":{ + "type":"structure", + "required":["webhookId"], + "members":{ + "webhookId":{ + "shape":"WebhookId", + "documentation":"

Unique Id for a webhook.

", + "location":"uri", + "locationName":"webhookId" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch, part of an Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for a webhook.

" + } + }, + "documentation":"

Request structure for update webhook request.

" + }, + "UpdateWebhookResult":{ + "type":"structure", + "required":["webhook"], + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Webhook structure.

" + } + }, + "documentation":"

Result structure for the update webhook request.

" + }, + "UploadUrl":{ + "type":"string", + "max":1000 + }, + "Verified":{"type":"boolean"}, + "Webhook":{ + "type":"structure", + "required":[ + "webhookArn", + "webhookId", + "webhookUrl", + "branchName", + "description", + "createTime", + "updateTime" + ], + "members":{ + "webhookArn":{ + "shape":"WebhookArn", + "documentation":"

ARN for the webhook.

" + }, + "webhookId":{ + "shape":"WebhookId", + "documentation":"

Id of the webhook.

" + }, + "webhookUrl":{ + "shape":"WebhookUrl", + "documentation":"

Url of the webhook.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

Name for a branch, part of an Amplify App.

" + }, + "description":{ + "shape":"Description", + "documentation":"

Description for a webhook.

" + }, + "createTime":{ + "shape":"CreateTime", + "documentation":"

Create date / time for a webhook.

" + }, + "updateTime":{ + "shape":"UpdateTime", + "documentation":"

Update date / time for a webhook.

" + } + }, + "documentation":"

Structure for webhook, which associates a webhook with an Amplify App.

" + }, + "WebhookArn":{ + "type":"string", + "max":1000 + }, + "WebhookId":{ + "type":"string", + "max":255 + }, + "WebhookUrl":{ + "type":"string", + "max":1000 + }, + "Webhooks":{ + "type":"list", + "member":{"shape":"Webhook"} + } + }, + "documentation":"

Amplify is a fully managed continuous deployment and hosting service for modern web apps.

" +} diff --git a/aws/dist/botocore/data/apigateway/2015-07-09/examples-1.json b/aws/dist/botocore/data/apigateway/2015-07-09/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/apigateway/2015-07-09/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/apigateway/2015-07-09/paginators-1.json b/aws/dist/botocore/data/apigateway/2015-07-09/paginators-1.json new file mode 100644 index 00000000..221e0489 --- /dev/null +++ b/aws/dist/botocore/data/apigateway/2015-07-09/paginators-1.json @@ -0,0 +1,112 @@ +{ + "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" + }, + "GetAuthorizers": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetDocumentationParts": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetDocumentationVersions": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetGatewayResponses": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetRequestValidators": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + }, + "GetSdkTypes": { + "input_token": "position", + "limit_key": "limit", + "output_token": "position", + "result_key": "items" + } + } +} diff --git a/aws/dist/botocore/data/apigateway/2015-07-09/service-2.json b/aws/dist/botocore/data/apigateway/2015-07-09/service-2.json new file mode 100644 index 00000000..0e92e902 --- /dev/null +++ b/aws/dist/botocore/data/apigateway/2015-07-09/service-2.json @@ -0,0 +1,7133 @@ +{ + "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.

AWS CLI
" + }, + "CreateAuthorizer":{ + "name":"CreateAuthorizer", + "http":{ + "method":"POST", + "requestUri":"/restapis/{restapi_id}/authorizers", + "responseCode":201 + }, + "input":{"shape":"CreateAuthorizerRequest"}, + "output":{"shape":"Authorizer"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Adds a new Authorizer resource to an existing RestApi resource.

AWS CLI
" + }, + "CreateBasePathMapping":{ + "name":"CreateBasePathMapping", + "http":{ + "method":"POST", + "requestUri":"/domainnames/{domain_name}/basepathmappings", + "responseCode":201 + }, + "input":{"shape":"CreateBasePathMappingRequest"}, + "output":{"shape":"BasePathMapping"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"ConflictException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Creates a new BasePathMapping resource.

" + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/restapis/{restapi_id}/deployments", + "responseCode":201 + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{"shape":"Deployment"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a Deployment resource, which makes a specified RestApi callable over the internet.

" + }, + "CreateDocumentationPart":{ + "name":"CreateDocumentationPart", + "http":{ + "method":"POST", + "requestUri":"/restapis/{restapi_id}/documentation/parts", + "responseCode":201 + }, + "input":{"shape":"CreateDocumentationPartRequest"}, + "output":{"shape":"DocumentationPart"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "CreateDocumentationVersion":{ + "name":"CreateDocumentationVersion", + "http":{ + "method":"POST", + "requestUri":"/restapis/{restapi_id}/documentation/versions", + "responseCode":201 + }, + "input":{"shape":"CreateDocumentationVersionRequest"}, + "output":{"shape":"DocumentationVersion"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "CreateDomainName":{ + "name":"CreateDomainName", + "http":{ + "method":"POST", + "requestUri":"/domainnames", + "responseCode":201 + }, + "input":{"shape":"CreateDomainNameRequest"}, + "output":{"shape":"DomainName"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Creates a new domain name.

" + }, + "CreateModel":{ + "name":"CreateModel", + "http":{ + "method":"POST", + "requestUri":"/restapis/{restapi_id}/models", + "responseCode":201 + }, + "input":{"shape":"CreateModelRequest"}, + "output":{"shape":"Model"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Adds a new Model resource to an existing RestApi resource.

" + }, + "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.

AWS CLI
" + }, + "DeleteBasePathMapping":{ + "name":"DeleteBasePathMapping", + "http":{ + "method":"DELETE", + "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}", + "responseCode":202 + }, + "input":{"shape":"DeleteBasePathMappingRequest"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"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"}, + {"shape":"BadRequestException"} + ], + "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.

AWS CLI
" + }, + "GetAuthorizers":{ + "name":"GetAuthorizers", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/authorizers" + }, + "input":{"shape":"GetAuthorizersRequest"}, + "output":{"shape":"Authorizers"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Describe an existing Authorizers resource.

AWS CLI
" + }, + "GetBasePathMapping":{ + "name":"GetBasePathMapping", + "http":{ + "method":"GET", + "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" + }, + "input":{"shape":"GetBasePathMappingRequest"}, + "output":{"shape":"BasePathMapping"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Describe a BasePathMapping resource.

" + }, + "GetBasePathMappings":{ + "name":"GetBasePathMappings", + "http":{ + "method":"GET", + "requestUri":"/domainnames/{domain_name}/basepathmappings" + }, + "input":{"shape":"GetBasePathMappingsRequest"}, + "output":{"shape":"BasePathMappings"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Represents a collection of BasePathMapping resources.

" + }, + "GetClientCertificate":{ + "name":"GetClientCertificate", + "http":{ + "method":"GET", + "requestUri":"/clientcertificates/{clientcertificate_id}" + }, + "input":{"shape":"GetClientCertificateRequest"}, + "output":{"shape":"ClientCertificate"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Gets information about the current ClientCertificate resource.

" + }, + "GetClientCertificates":{ + "name":"GetClientCertificates", + "http":{ + "method":"GET", + "requestUri":"/clientcertificates" + }, + "input":{"shape":"GetClientCertificatesRequest"}, + "output":{"shape":"ClientCertificates"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Gets a collection of ClientCertificate resources.

" + }, + "GetDeployment":{ + "name":"GetDeployment", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" + }, + "input":{"shape":"GetDeploymentRequest"}, + "output":{"shape":"Deployment"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Gets information about a Deployment resource.

" + }, + "GetDeployments":{ + "name":"GetDeployments", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/deployments" + }, + "input":{"shape":"GetDeploymentsRequest"}, + "output":{"shape":"Deployments"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Gets information about a Deployments collection.

" + }, + "GetDocumentationPart":{ + "name":"GetDocumentationPart", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}" + }, + "input":{"shape":"GetDocumentationPartRequest"}, + "output":{"shape":"DocumentationPart"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetDocumentationParts":{ + "name":"GetDocumentationParts", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/documentation/parts" + }, + "input":{"shape":"GetDocumentationPartsRequest"}, + "output":{"shape":"DocumentationParts"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetDocumentationVersion":{ + "name":"GetDocumentationVersion", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}" + }, + "input":{"shape":"GetDocumentationVersionRequest"}, + "output":{"shape":"DocumentationVersion"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetDocumentationVersions":{ + "name":"GetDocumentationVersions", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/documentation/versions" + }, + "input":{"shape":"GetDocumentationVersionsRequest"}, + "output":{"shape":"DocumentationVersions"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "GetDomainName":{ + "name":"GetDomainName", + "http":{ + "method":"GET", + "requestUri":"/domainnames/{domain_name}" + }, + "input":{"shape":"GetDomainNameRequest"}, + "output":{"shape":"DomainName"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

" + }, + "GetDomainNames":{ + "name":"GetDomainNames", + "http":{ + "method":"GET", + "requestUri":"/domainnames" + }, + "input":{"shape":"GetDomainNamesRequest"}, + "output":{"shape":"DomainNames"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Represents a collection of DomainName resources.

" + }, + "GetExport":{ + "name":"GetExport", + "http":{ + "method":"GET", + "requestUri":"/restapis/{restapi_id}/stages/{stage_name}/exports/{export_type}", + "responseCode":200 + }, + "input":{"shape":"GetExportRequest"}, + "output":{"shape":"ExportResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"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.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
" + }, + "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.

AWS CLI
" + }, + "UpdateBasePathMapping":{ + "name":"UpdateBasePathMapping", + "http":{ + "method":"PATCH", + "requestUri":"/domainnames/{domain_name}/basepathmappings/{base_path}" + }, + "input":{"shape":"UpdateBasePathMappingRequest"}, + "output":{"shape":"BasePathMapping"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Changes information about the BasePathMapping resource.

" + }, + "UpdateClientCertificate":{ + "name":"UpdateClientCertificate", + "http":{ + "method":"PATCH", + "requestUri":"/clientcertificates/{clientcertificate_id}" + }, + "input":{"shape":"UpdateClientCertificateRequest"}, + "output":{"shape":"ClientCertificate"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Changes information about an ClientCertificate resource.

" + }, + "UpdateDeployment":{ + "name":"UpdateDeployment", + "http":{ + "method":"PATCH", + "requestUri":"/restapis/{restapi_id}/deployments/{deployment_id}" + }, + "input":{"shape":"UpdateDeploymentRequest"}, + "output":{"shape":"Deployment"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Changes information about a Deployment resource.

" + }, + "UpdateDocumentationPart":{ + "name":"UpdateDocumentationPart", + "http":{ + "method":"PATCH", + "requestUri":"/restapis/{restapi_id}/documentation/parts/{part_id}" + }, + "input":{"shape":"UpdateDocumentationPartRequest"}, + "output":{"shape":"DocumentationPart"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "UpdateDocumentationVersion":{ + "name":"UpdateDocumentationVersion", + "http":{ + "method":"PATCH", + "requestUri":"/restapis/{restapi_id}/documentation/versions/{doc_version}" + }, + "input":{"shape":"UpdateDocumentationVersionRequest"}, + "output":{"shape":"DocumentationVersion"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"} + ] + }, + "UpdateDomainName":{ + "name":"UpdateDomainName", + "http":{ + "method":"PATCH", + "requestUri":"/domainnames/{domain_name}" + }, + "input":{"shape":"UpdateDomainNameRequest"}, + "output":{"shape":"DomainName"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Changes information about the DomainName resource.

" + }, + "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.

To view the account info, call GET on this resource.

Error Codes

The following exception may be thrown when the request fails.

  • UnauthorizedException
  • NotFoundException
  • TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account.

Request
GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html\", \"name\": \"account\", \"templated\": true }, \"self\": { \"href\": \"/account\" }, \"account:update\": { \"href\": \"/account\" } }, \"cloudwatchRoleArn\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"throttleSettings\": { \"rateLimit\": 500, \"burstLimit\": 1000 } }

In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide, AWS CLI
" + }, + "ApiKey":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier of the API Key.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the API Key.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of the API Key.

" + }, + "customerId":{ + "shape":"String", + "documentation":"

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the API Key.

" + }, + "enabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether the API Key can be used by callers.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The 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.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys
" + }, + "ApiKeyIds":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"ListOfString", + "documentation":"

A list of all the ApiKey identifiers.

" + }, + "warnings":{ + "shape":"ListOfString", + "documentation":"

A list of warning messages.

" + } + }, + "documentation":"

The identifier of an ApiKey used in a UsagePlan.

" + }, + "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.

Use API Keys
" + }, + "ApiKeysFormat":{ + "type":"string", + "enum":["csv"] + }, + "ApiStage":{ + "type":"structure", + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

API Id of the associated API stage in a usage plan.

" + }, + "stage":{ + "shape":"String", + "documentation":"

API stage name of the associated API stage in a usage plan.

" + }, + "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 OpenAPI 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. For COGNITO_USER_POOLS authorizers, 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.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
" + }, + "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.

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer
" + }, + "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.

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account.
Use Custom Domain Names
" + }, + "BasePathMappings":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfBasePathMapping", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents a collection of BasePathMapping resources.

Use Custom Domain Names
" + }, + "Blob":{"type":"blob"}, + "Boolean":{"type":"boolean"}, + "CacheClusterSize":{ + "type":"string", + "documentation":"

Returns the size of the CacheCluster.

", + "enum":[ + "0.5", + "1.6", + "6.1", + "13.5", + "28.4", + "58.2", + "118", + "237" + ] + }, + "CacheClusterStatus":{ + "type":"string", + "documentation":"

Returns the status of the CacheCluster.

", + "enum":[ + "CREATE_IN_PROGRESS", + "AVAILABLE", + "DELETE_IN_PROGRESS", + "NOT_AVAILABLE", + "FLUSH_IN_PROGRESS" + ] + }, + "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.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.
Use Client-Side Certificate
" + }, + "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.

Use Client-Side Certificate
" + }, + "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.

" + }, + "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":"

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 OpenAPI 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. For COGNITO_USER_POOLS authorizers, 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. Specify '(none)' 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. Specify '(none)' 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.

" + }, + "tracingEnabled":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether active tracing with X-ray is enabled for the Stage.

" + } + }, + "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 OpenAPI-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.

" + }, + "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.

" + }, + "securityPolicy":{ + "shape":"SecurityPolicy", + "documentation":"

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" + } + }, + "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." + }, + "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":"

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. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

" + }, + "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.

" + }, + "tracingEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether active tracing with X-ray is enabled for the 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.

" + }, + "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":"

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.

" + }, + "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":"

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.

To specify an empty base path, set this parameter to '(none)'.

", + "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.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
RestApi, Deployments, Stage, AWS CLI, AWS SDKs
" + }, + "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.

To create a new deployment of a RestApi, make a POST request against this resource. To view, update, or delete an existing deployment, make a GET, PATCH, or DELETE request, respectively, on a specified Deployment resource.
Deploying an API, AWS CLI, AWS SDKs
" + }, + "DocumentationPart":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The DocumentationPart identifier, generated by 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 OpenAPI-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 OpenAPI extension of x-amazon-apigateway-documentation.

" + } + }, + "documentation":"

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties) and a target (location). The target specifies an API entity to which the documentation content applies. The supported API entity types are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the OpenAPI-compliant documentation fields will be injected into the associated API entity definition in the exported OpenAPI definition file.

Documenting an API, DocumentationParts
" + }, + "DocumentationPartIds":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"ListOfString", + "documentation":"

A list of the returned documentation part identifiers.

" + }, + "warnings":{ + "shape":"ListOfString", + "documentation":"

A list of warning messages reported during import of documentation parts.

" + } + }, + "documentation":"

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., OpenAPI) file are imported into API Gateway
Documenting an API, documentationpart:import, DocumentationPart
" + }, + "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.

Documenting an API, DocumentationPart
" + }, + "DocumentationVersion":{ + "type":"structure", + "members":{ + "version":{ + "shape":"String", + "documentation":"

The version identifier of the API documentation snapshot.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date when the API documentation snapshot is created.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the API documentation snapshot.

" + } + }, + "documentation":"

A snapshot of the documentation of an API.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., OpenAPI) file.

Documenting an API, DocumentationPart, DocumentationVersions
" + }, + "DocumentationVersions":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfDocumentationVersion", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

The collection of documentation snapshots of an API.

Use the DocumentationVersions to manage documentation snapshots associated with various API stages.

Documenting an API, DocumentationPart, DocumentationVersion
" + }, + "DomainName":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

The custom domain name as an API host name, for example, my-api.example.com.

" + }, + "certificateName":{ + "shape":"String", + "documentation":"

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

" + }, + "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.

" + }, + "certificateUploadDate":{ + "shape":"Timestamp", + "documentation":"

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

" + }, + "regionalDomainName":{ + "shape":"String", + "documentation":"

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

" + }, + "regionalHostedZoneId":{ + "shape":"String", + "documentation":"

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" + }, + "regionalCertificateName":{ + "shape":"String", + "documentation":"

The name of the certificate that will be used for validating the regional domain name.

" + }, + "regionalCertificateArn":{ + "shape":"String", + "documentation":"

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

" + }, + "distributionDomainName":{ + "shape":"String", + "documentation":"

The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

" + }, + "distributionHostedZoneId":{ + "shape":"String", + "documentation":"

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

" + }, + "endpointConfiguration":{ + "shape":"EndpointConfiguration", + "documentation":"

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

" + }, + "domainNameStatus":{ + "shape":"DomainNameStatus", + "documentation":"

The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

" + }, + "domainNameStatusMessage":{ + "shape":"String", + "documentation":"

An optional text message containing detailed information about status of the DomainName migration.

" + }, + "securityPolicy":{ + "shape":"SecurityPolicy", + "documentation":"

The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

Represents a custom domain name as a user-friendly host name of an API (RestApi).

When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/. When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi, where myApi is the base path mapping (BasePathMapping) of your API under the custom domain name.

Set a Custom Host Name for an API
" + }, + "DomainNameStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "UPDATING", + "PENDING" + ] + }, + "DomainNames":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfDomainName", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents a collection of DomainName resources.

Use Client-Side Certificate
" + }, + "Double":{"type":"double"}, + "EndpointConfiguration":{ + "type":"structure", + "members":{ + "types":{ + "shape":"ListOfEndpointType", + "documentation":"

A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is \"EDGE\". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

" + }, + "vpcEndpointIds":{ + "shape":"ListOfString", + "documentation":"

A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

" + } + }, + "documentation":"

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

" + }, + "EndpointType":{ + "type":"string", + "documentation":"

The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

", + "enum":[ + "REGIONAL", + "EDGE", + "PRIVATE" + ] + }, + "ExportResponse":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"String", + "documentation":"

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

", + "location":"header", + "locationName":"Content-Type" + }, + "contentDisposition":{ + "shape":"String", + "documentation":"

The content-disposition header value in the HTTP response.

", + "location":"header", + "locationName":"Content-Disposition" + }, + "body":{ + "shape":"Blob", + "documentation":"

The binary blob response to GetExport, which contains the export.

" + } + }, + "documentation":"

The binary blob response to GetExport, which contains the generated SDK.

", + "payload":"body" + }, + "FlushStageAuthorizersCacheRequest":{ + "type":"structure", + "required":[ + "restApiId", + "stageName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "stageName":{ + "shape":"String", + "documentation":"

The name of the stage to flush.

", + "location":"uri", + "locationName":"stage_name" + } + }, + "documentation":"

Request to flush authorizer cache entries on a specified stage.

" + }, + "FlushStageCacheRequest":{ + "type":"structure", + "required":[ + "restApiId", + "stageName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "stageName":{ + "shape":"String", + "documentation":"

[Required] The name of the stage to flush its cache.

", + "location":"uri", + "locationName":"stage_name" + } + }, + "documentation":"

Requests API Gateway to flush a stage's cache.

" + }, + "GatewayResponse":{ + "type":"structure", + "members":{ + "responseType":{ + "shape":"GatewayResponseType", + "documentation":"

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

" + }, + "statusCode":{ + "shape":"StatusCode", + "documentation":"

The HTTP status code for this GatewayResponse.

" + }, + "responseParameters":{ + "shape":"MapOfStringToString", + "documentation":"

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

" + }, + "defaultResponse":{ + "shape":"Boolean", + "documentation":"

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

" + } + }, + "documentation":"

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway

Example: Get a Gateway Response of a given response type

Request

This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.

GET /restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45

The response type is specified as a URL path.

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:delete\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": false, \"responseParameters\": { \"gatewayresponse.header.x-request-path\": \"method.request.path.petId\", \"gatewayresponse.header.Access-Control-Allow-Origin\": \"'a.b.c'\", \"gatewayresponse.header.x-request-query\": \"method.request.querystring.q\", \"gatewayresponse.header.x-request-header\": \"method.request.header.Accept\" }, \"responseTemplates\": { \"application/json\": \"{\\n \\\"message\\\": $context.error.messageString,\\n \\\"type\\\": \\\"$context.error.responseType\\\",\\n \\\"stage\\\": \\\"$context.stage\\\",\\n \\\"resourcePath\\\": \\\"$context.resourcePath\\\",\\n \\\"stageVariables.a\\\": \\\"$stageVariables.a\\\",\\n \\\"statusCode\\\": \\\"'404'\\\"\\n}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"404\" }

Customize Gateway Responses
" + }, + "GatewayResponseType":{ + "type":"string", + "enum":[ + "DEFAULT_4XX", + "DEFAULT_5XX", + "RESOURCE_NOT_FOUND", + "UNAUTHORIZED", + "INVALID_API_KEY", + "ACCESS_DENIED", + "AUTHORIZER_FAILURE", + "AUTHORIZER_CONFIGURATION_ERROR", + "INVALID_SIGNATURE", + "EXPIRED_TOKEN", + "MISSING_AUTHENTICATION_TOKEN", + "INTEGRATION_FAILURE", + "INTEGRATION_TIMEOUT", + "API_CONFIGURATION_ERROR", + "UNSUPPORTED_MEDIA_TYPE", + "BAD_REQUEST_PARAMETERS", + "BAD_REQUEST_BODY", + "REQUEST_TOO_LARGE", + "THROTTLED", + "QUOTA_EXCEEDED" + ] + }, + "GatewayResponses":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfGatewayResponse", + "documentation":"

Returns the entire collection, because of no pagination support.

", + "locationName":"item" + } + }, + "documentation":"

The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway

Example: Get the collection of gateway responses of an API

Request

This example request shows how to retrieve the GatewayResponses collection from an API.

GET /restapis/o81lxisefl/gatewayresponses HTTP/1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: application/json X-Amz-Date: 20170503T220604Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}/20170503/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=59b42fe54a76a5de8adf2c67baa6d39206f8e9ad49a1d77ccc6a5da3103a398a Cache-Control: no-cache Postman-Token: 5637af27-dc29-fc5c-9dfe-0645d52cb515

Response

The successful operation returns the 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html\", \"name\": \"gatewayresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"first\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses\" }, \"gatewayresponse:by-type\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"item\": [ { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } ] }, \"_embedded\": { \"item\": [ { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_FAILURE\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/RESOURCE_NOT_FOUND\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"RESOURCE_NOT_FOUND\", \"statusCode\": \"404\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/REQUEST_TOO_LARGE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"REQUEST_TOO_LARGE\", \"statusCode\": \"413\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/THROTTLED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"THROTTLED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNSUPPORTED_MEDIA_TYPE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNSUPPORTED_MEDIA_TYPE\", \"statusCode\": \"415\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_5XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_5XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/DEFAULT_4XX\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"DEFAULT_4XX\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_PARAMETERS\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_PARAMETERS\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/BAD_REQUEST_BODY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"BAD_REQUEST_BODY\", \"statusCode\": \"400\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/EXPIRED_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"EXPIRED_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/ACCESS_DENIED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"ACCESS_DENIED\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_API_KEY\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_API_KEY\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/UNAUTHORIZED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"UNAUTHORIZED\", \"statusCode\": \"401\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/API_CONFIGURATION_ERROR\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"API_CONFIGURATION_ERROR\", \"statusCode\": \"500\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/QUOTA_EXCEEDED\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"QUOTA_EXCEEDED\", \"statusCode\": \"429\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INTEGRATION_TIMEOUT\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INTEGRATION_TIMEOUT\", \"statusCode\": \"504\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/MISSING_AUTHENTICATION_TOKEN\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"MISSING_AUTHENTICATION_TOKEN\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/INVALID_SIGNATURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"INVALID_SIGNATURE\", \"statusCode\": \"403\" }, { \"_links\": { \"self\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" }, \"gatewayresponse:put\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/{response_type}\", \"templated\": true }, \"gatewayresponse:update\": { \"href\": \"/restapis/o81lxisefl/gatewayresponses/AUTHORIZER_FAILURE\" } }, \"defaultResponse\": true, \"responseParameters\": {}, \"responseTemplates\": { \"application/json\": \"{\\\"message\\\":$context.error.messageString}\" }, \"responseType\": \"AUTHORIZER_FAILURE\", \"statusCode\": \"500\" } ] } }

Customize Gateway Responses
" + }, + "GenerateClientCertificateRequest":{ + "type":"structure", + "members":{ + "description":{ + "shape":"String", + "documentation":"

The description of the ClientCertificate.

" + }, + "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":"

A request to generate a ClientCertificate resource.

" + }, + "GetAccountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Requests API Gateway to get information about the current Account resource.

" + }, + "GetApiKeyRequest":{ + "type":"structure", + "required":["apiKey"], + "members":{ + "apiKey":{ + "shape":"String", + "documentation":"

[Required] The identifier of the ApiKey resource.

", + "location":"uri", + "locationName":"api_Key" + }, + "includeValue":{ + "shape":"NullableBoolean", + "documentation":"

A boolean flag to specify whether (true) or not (false) the result contains the key value.

", + "location":"querystring", + "locationName":"includeValue" + } + }, + "documentation":"

A request to get information about the current ApiKey resource.

" + }, + "GetApiKeysRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + }, + "nameQuery":{ + "shape":"String", + "documentation":"

The name of queried API keys.

", + "location":"querystring", + "locationName":"name" + }, + "customerId":{ + "shape":"String", + "documentation":"

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

", + "location":"querystring", + "locationName":"customerId" + }, + "includeValues":{ + "shape":"NullableBoolean", + "documentation":"

A boolean flag to specify whether (true) or not (false) the result contains key values.

", + "location":"querystring", + "locationName":"includeValues" + } + }, + "documentation":"

A request to get information about the current ApiKeys resource.

" + }, + "GetAuthorizerRequest":{ + "type":"structure", + "required":[ + "restApiId", + "authorizerId" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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 describe an existing Authorizer resource.

" + }, + "GetAuthorizersRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Request to describe an existing Authorizers resource.

" + }, + "GetBasePathMappingRequest":{ + "type":"structure", + "required":[ + "domainName", + "basePath" + ], + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

[Required] The domain name of the BasePathMapping resource to be described.

", + "location":"uri", + "locationName":"domain_name" + }, + "basePath":{ + "shape":"String", + "documentation":"

[Required] 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. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

", + "location":"uri", + "locationName":"base_path" + } + }, + "documentation":"

Request to describe a BasePathMapping resource.

" + }, + "GetBasePathMappingsRequest":{ + "type":"structure", + "required":["domainName"], + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

[Required] The domain name of a BasePathMapping resource.

", + "location":"uri", + "locationName":"domain_name" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

A request to get information about a collection of BasePathMapping resources.

" + }, + "GetClientCertificateRequest":{ + "type":"structure", + "required":["clientCertificateId"], + "members":{ + "clientCertificateId":{ + "shape":"String", + "documentation":"

[Required] The identifier of the ClientCertificate resource to be described.

", + "location":"uri", + "locationName":"clientcertificate_id" + } + }, + "documentation":"

A request to get information about the current ClientCertificate resource.

" + }, + "GetClientCertificatesRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

A request to get information about a collection of ClientCertificate resources.

" + }, + "GetDeploymentRequest":{ + "type":"structure", + "required":[ + "restApiId", + "deploymentId" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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 get information about.

", + "location":"uri", + "locationName":"deployment_id" + }, + "embed":{ + "shape":"ListOfString", + "documentation":"

A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the \"apisummary\" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

", + "location":"querystring", + "locationName":"embed" + } + }, + "documentation":"

Requests API Gateway to get information about a Deployment resource.

" + }, + "GetDeploymentsRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Requests API Gateway to get information about a Deployments collection.

" + }, + "GetDocumentationPartRequest":{ + "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 string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"part_id" + } + }, + "documentation":"

Gets a specified documentation part of a given API.

" + }, + "GetDocumentationPartsRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "type":{ + "shape":"DocumentationPartType", + "documentation":"

The type of API entities of the to-be-retrieved documentation parts.

", + "location":"querystring", + "locationName":"type" + }, + "nameQuery":{ + "shape":"String", + "documentation":"

The name of API entities of the to-be-retrieved documentation parts.

", + "location":"querystring", + "locationName":"name" + }, + "path":{ + "shape":"String", + "documentation":"

The path of API entities of the to-be-retrieved documentation parts.

", + "location":"querystring", + "locationName":"path" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + }, + "locationStatus":{ + "shape":"LocationStatusType", + "documentation":"

The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

", + "location":"querystring", + "locationName":"locationStatus" + } + }, + "documentation":"

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

" + }, + "GetDocumentationVersionRequest":{ + "type":"structure", + "required":[ + "restApiId", + "documentationVersion" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "documentationVersion":{ + "shape":"String", + "documentation":"

[Required] The version identifier of the to-be-retrieved documentation snapshot.

", + "location":"uri", + "locationName":"doc_version" + } + }, + "documentation":"

Gets a documentation snapshot of an API.

" + }, + "GetDocumentationVersionsRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Gets the documentation versions of an API.

" + }, + "GetDomainNameRequest":{ + "type":"structure", + "required":["domainName"], + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

[Required] The name of the DomainName resource.

", + "location":"uri", + "locationName":"domain_name" + } + }, + "documentation":"

Request to get the name of a DomainName resource.

" + }, + "GetDomainNamesRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Request to describe a collection of DomainName resources.

" + }, + "GetExportRequest":{ + "type":"structure", + "required":[ + "restApiId", + "stageName", + "exportType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "stageName":{ + "shape":"String", + "documentation":"

[Required] The name of the Stage that will be exported.

", + "location":"uri", + "locationName":"stage_name" + }, + "exportType":{ + "shape":"String", + "documentation":"

[Required] The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

", + "location":"uri", + "locationName":"export_type" + }, + "parameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

", + "location":"querystring" + }, + "accepts":{ + "shape":"String", + "documentation":"

The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

", + "location":"header", + "locationName":"Accept" + } + }, + "documentation":"

Request a new export of a RestApi for a particular Stage.

" + }, + "GetGatewayResponseRequest":{ + "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":"

Gets a GatewayResponse of a specified response type on the given RestApi.

" + }, + "GetGatewayResponsesRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

", + "location":"querystring", + "locationName":"limit" + } + }, + "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.

" + }, + "GetIntegrationRequest":{ + "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 get integration request's resource identifier

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies a get integration request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + } + }, + "documentation":"

Represents a request to get the integration configuration.

" + }, + "GetIntegrationResponseRequest":{ + "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 get integration response request's resource identifier.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies a get integration response request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "statusCode":{ + "shape":"StatusCode", + "documentation":"

[Required] Specifies a get integration response request's status code.

", + "location":"uri", + "locationName":"status_code" + } + }, + "documentation":"

Represents a get integration response request.

" + }, + "GetMethodRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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] Specifies the method request's HTTP method type.

", + "location":"uri", + "locationName":"http_method" + } + }, + "documentation":"

Request to describe an existing Method resource.

" + }, + "GetMethodResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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 for the MethodResponse resource.

", + "location":"uri", + "locationName":"status_code" + } + }, + "documentation":"

Request to describe a MethodResponse resource.

" + }, + "GetModelRequest":{ + "type":"structure", + "required":[ + "restApiId", + "modelName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The RestApi identifier under which the Model exists.

", + "location":"uri", + "locationName":"restapi_id" + }, + "modelName":{ + "shape":"String", + "documentation":"

[Required] The name of the model as an identifier.

", + "location":"uri", + "locationName":"model_name" + }, + "flatten":{ + "shape":"Boolean", + "documentation":"

A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

", + "location":"querystring", + "locationName":"flatten" + } + }, + "documentation":"

Request to list information about a model in an existing RestApi resource.

" + }, + "GetModelTemplateRequest":{ + "type":"structure", + "required":[ + "restApiId", + "modelName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "modelName":{ + "shape":"String", + "documentation":"

[Required] The name of the model for which to generate a template.

", + "location":"uri", + "locationName":"model_name" + } + }, + "documentation":"

Request to generate a sample mapping template used to transform the payload.

" + }, + "GetModelsRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Request to list existing Models defined for a RestApi resource.

" + }, + "GetRequestValidatorRequest":{ + "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 retrieved.

", + "location":"uri", + "locationName":"requestvalidator_id" + } + }, + "documentation":"

Gets a RequestValidator of a given RestApi.

" + }, + "GetRequestValidatorsRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Gets the RequestValidators collection of a given RestApi.

" + }, + "GetResourceRequest":{ + "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 for the Resource resource.

", + "location":"uri", + "locationName":"resource_id" + }, + "embed":{ + "shape":"ListOfString", + "documentation":"

A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.

", + "location":"querystring", + "locationName":"embed" + } + }, + "documentation":"

Request to list information about a resource.

" + }, + "GetResourcesRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + }, + "embed":{ + "shape":"ListOfString", + "documentation":"

A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the \"methods\" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

", + "location":"querystring", + "locationName":"embed" + } + }, + "documentation":"

Request to list information about a collection of resources.

" + }, + "GetRestApiRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + } + }, + "documentation":"

The GET request to list an existing RestApi defined for your collection.

" + }, + "GetRestApisRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

The GET request to list existing RestApis defined for your collection.

" + }, + "GetSdkRequest":{ + "type":"structure", + "required":[ + "restApiId", + "stageName", + "sdkType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "stageName":{ + "shape":"String", + "documentation":"

[Required] The name of the Stage that the SDK will use.

", + "location":"uri", + "locationName":"stage_name" + }, + "sdkType":{ + "shape":"String", + "documentation":"

[Required] The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

", + "location":"uri", + "locationName":"sdk_type" + }, + "parameters":{ + "shape":"MapOfStringToString", + "documentation":"

A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

", + "location":"querystring" + } + }, + "documentation":"

Request a new generated client SDK for a RestApi and Stage.

" + }, + "GetSdkTypeRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"String", + "documentation":"

[Required] The identifier of the queried SdkType instance.

", + "location":"uri", + "locationName":"sdktype_id" + } + }, + "documentation":"

Get an SdkType instance.

" + }, + "GetSdkTypesRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Get the SdkTypes collection.

" + }, + "GetStageRequest":{ + "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 get information about.

", + "location":"uri", + "locationName":"stage_name" + } + }, + "documentation":"

Requests API Gateway to get information about a Stage resource.

" + }, + "GetStagesRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "deploymentId":{ + "shape":"String", + "documentation":"

The stages' deployment identifiers.

", + "location":"querystring", + "locationName":"deploymentId" + } + }, + "documentation":"

Requests API Gateway to get information about one or more Stage resources.

" + }, + "GetTagsRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

", + "location":"uri", + "locationName":"resource_arn" + }, + "position":{ + "shape":"String", + "documentation":"

(Not currently supported) The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

(Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Gets the Tags collection for a given resource.

" + }, + "GetUsagePlanKeyRequest":{ + "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-retrieved UsagePlanKey resource representing a plan customer.

", + "location":"uri", + "locationName":"usageplanId" + }, + "keyId":{ + "shape":"String", + "documentation":"

[Required] The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

", + "location":"uri", + "locationName":"keyId" + } + }, + "documentation":"

The GET request to get a usage plan key of a given key identifier.

" + }, + "GetUsagePlanKeysRequest":{ + "type":"structure", + "required":["usagePlanId"], + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

", + "location":"uri", + "locationName":"usageplanId" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + }, + "nameQuery":{ + "shape":"String", + "documentation":"

A query parameter specifying the name of the to-be-returned usage plan keys.

", + "location":"querystring", + "locationName":"name" + } + }, + "documentation":"

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

" + }, + "GetUsagePlanRequest":{ + "type":"structure", + "required":["usagePlanId"], + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

[Required] The identifier of the UsagePlan resource to be retrieved.

", + "location":"uri", + "locationName":"usageplanId" + } + }, + "documentation":"

The GET request to get a usage plan of a given plan identifier.

" + }, + "GetUsagePlansRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "keyId":{ + "shape":"String", + "documentation":"

The identifier of the API key associated with the usage plans.

", + "location":"querystring", + "locationName":"keyId" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

The GET request to get all the usage plans of the caller's account.

" + }, + "GetUsageRequest":{ + "type":"structure", + "required":[ + "usagePlanId", + "startDate", + "endDate" + ], + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

[Required] The Id of the usage plan associated with the usage data.

", + "location":"uri", + "locationName":"usageplanId" + }, + "keyId":{ + "shape":"String", + "documentation":"

The Id of the API key associated with the resultant usage data.

", + "location":"querystring", + "locationName":"keyId" + }, + "startDate":{ + "shape":"String", + "documentation":"

[Required] The starting date (e.g., 2016-01-01) of the usage data.

", + "location":"querystring", + "locationName":"startDate" + }, + "endDate":{ + "shape":"String", + "documentation":"

[Required] The ending date (e.g., 2016-12-31) of the usage data.

", + "location":"querystring", + "locationName":"endDate" + }, + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

The GET request to get the usage data of a usage plan in a specified time interval.

" + }, + "GetVpcLinkRequest":{ + "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":"

Gets a specified VPC link under the caller's account in a region.

" + }, + "GetVpcLinksRequest":{ + "type":"structure", + "members":{ + "position":{ + "shape":"String", + "documentation":"

The current pagination position in the paged result set.

", + "location":"querystring", + "locationName":"position" + }, + "limit":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Gets the VpcLinks collection under the caller's account in a selected region.

" + }, + "ImportApiKeysRequest":{ + "type":"structure", + "required":[ + "body", + "format" + ], + "members":{ + "body":{ + "shape":"Blob", + "documentation":"

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

" + }, + "format":{ + "shape":"ApiKeysFormat", + "documentation":"

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

", + "location":"querystring", + "locationName":"format" + }, + "failOnWarnings":{ + "shape":"Boolean", + "documentation":"

A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

", + "location":"querystring", + "locationName":"failonwarnings" + } + }, + "documentation":"

The POST request to import API keys from an external source, such as a CSV-formatted file.

", + "payload":"body" + }, + "ImportDocumentationPartsRequest":{ + "type":"structure", + "required":[ + "restApiId", + "body" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "mode":{ + "shape":"PutMode", + "documentation":"

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

", + "location":"querystring", + "locationName":"mode" + }, + "failOnWarnings":{ + "shape":"Boolean", + "documentation":"

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

", + "location":"querystring", + "locationName":"failonwarnings" + }, + "body":{ + "shape":"Blob", + "documentation":"

[Required] Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

" + } + }, + "documentation":"

Import documentation parts from an external (e.g., OpenAPI) definition file.

", + "payload":"body" + }, + "ImportRestApiRequest":{ + "type":"structure", + "required":["body"], + "members":{ + "failOnWarnings":{ + "shape":"Boolean", + "documentation":"

A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

", + "location":"querystring", + "locationName":"failonwarnings" + }, + "parameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'

The AWS CLI command to set the regional endpoint on the imported API is:

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json'
", + "location":"querystring" + }, + "body":{ + "shape":"Blob", + "documentation":"

[Required] The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

" + } + }, + "documentation":"

A POST request to import an API to API Gateway using an input of an API definition file.

", + "payload":"body" + }, + "Integer":{"type":"integer"}, + "Integration":{ + "type":"structure", + "members":{ + "type":{ + "shape":"IntegrationType", + "documentation":"

Specifies an API method integration type. The valid value is one of the following:

  • AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
  • AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration.
  • HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
  • HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration.
  • MOCK: for integrating the API method request with API Gateway as a \"loop-back\" endpoint without invoking any backend.

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

Specifies the integration's HTTP method type.

" + }, + "uri":{ + "shape":"String", + "documentation":"

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

" + }, + "connectionType":{ + "shape":"ConnectionType", + "documentation":"

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

" + }, + "connectionId":{ + "shape":"String", + "documentation":"

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

" + }, + "credentials":{ + "shape":"String", + "documentation":"

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\\*:user/\\*. To use resource-based permissions on supported AWS services, specify null.

" + }, + "requestParameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" + }, + "requestTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

" + }, + "passthroughBehavior":{ + "shape":"String", + "documentation":"

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following:

  • WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
  • WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response.
  • NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
" + }, + "contentHandling":{ + "shape":"ContentHandlingStrategy", + "documentation":"

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

" + }, + "timeoutInMillis":{ + "shape":"Integer", + "documentation":"

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

" + }, + "cacheNamespace":{ + "shape":"String", + "documentation":"

An API-specific tag group of related cached parameters. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

" + }, + "cacheKeyParameters":{ + "shape":"ListOfString", + "documentation":"

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

" + }, + "integrationResponses":{ + "shape":"MapOfIntegrationResponse", + "documentation":"

Specifies the integration's responses.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns 200 OK status and a payload as follows:

{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" }

Creating an API
" + } + }, + "documentation":"

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.
Creating an API
" + }, + "IntegrationResponse":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"StatusCode", + "documentation":"

Specifies the status code that is used to map the integration response to an existing MethodResponse.

" + }, + "selectionPattern":{ + "shape":"String", + "documentation":"

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

" + }, + "responseParameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

" + }, + "contentHandling":{ + "shape":"ContentHandlingStrategy", + "documentation":"

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" + } + }, + "documentation":"

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

Creating an API
" + }, + "IntegrationType":{ + "type":"string", + "documentation":"

The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.

", + "enum":[ + "HTTP", + "AWS", + "MOCK", + "HTTP_PROXY", + "AWS_PROXY" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"String"} + }, + "documentation":"

The request exceeded the rate limit. Retry after the specified time period.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListOfARNs":{ + "type":"list", + "member":{"shape":"ProviderARN"} + }, + "ListOfApiKey":{ + "type":"list", + "member":{"shape":"ApiKey"} + }, + "ListOfApiStage":{ + "type":"list", + "member":{"shape":"ApiStage"} + }, + "ListOfAuthorizer":{ + "type":"list", + "member":{"shape":"Authorizer"} + }, + "ListOfBasePathMapping":{ + "type":"list", + "member":{"shape":"BasePathMapping"} + }, + "ListOfClientCertificate":{ + "type":"list", + "member":{"shape":"ClientCertificate"} + }, + "ListOfDeployment":{ + "type":"list", + "member":{"shape":"Deployment"} + }, + "ListOfDocumentationPart":{ + "type":"list", + "member":{"shape":"DocumentationPart"} + }, + "ListOfDocumentationVersion":{ + "type":"list", + "member":{"shape":"DocumentationVersion"} + }, + "ListOfDomainName":{ + "type":"list", + "member":{"shape":"DomainName"} + }, + "ListOfEndpointType":{ + "type":"list", + "member":{"shape":"EndpointType"} + }, + "ListOfGatewayResponse":{ + "type":"list", + "member":{"shape":"GatewayResponse"} + }, + "ListOfLong":{ + "type":"list", + "member":{"shape":"Long"} + }, + "ListOfModel":{ + "type":"list", + "member":{"shape":"Model"} + }, + "ListOfPatchOperation":{ + "type":"list", + "member":{"shape":"PatchOperation"}, + "documentation":"A list of operations describing the updates to apply to the specified resource. The patches are applied in the order specified in the list." + }, + "ListOfRequestValidator":{ + "type":"list", + "member":{"shape":"RequestValidator"} + }, + "ListOfResource":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "ListOfRestApi":{ + "type":"list", + "member":{"shape":"RestApi"} + }, + "ListOfSdkConfigurationProperty":{ + "type":"list", + "member":{"shape":"SdkConfigurationProperty"} + }, + "ListOfSdkType":{ + "type":"list", + "member":{"shape":"SdkType"} + }, + "ListOfStage":{ + "type":"list", + "member":{"shape":"Stage"} + }, + "ListOfStageKeys":{ + "type":"list", + "member":{"shape":"StageKey"} + }, + "ListOfString":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListOfUsage":{ + "type":"list", + "member":{"shape":"ListOfLong"} + }, + "ListOfUsagePlan":{ + "type":"list", + "member":{"shape":"UsagePlan"} + }, + "ListOfUsagePlanKey":{ + "type":"list", + "member":{"shape":"UsagePlanKey"} + }, + "ListOfVpcLink":{ + "type":"list", + "member":{"shape":"VpcLink"} + }, + "LocationStatusType":{ + "type":"string", + "enum":[ + "DOCUMENTED", + "UNDOCUMENTED" + ] + }, + "Long":{"type":"long"}, + "MapOfApiStageThrottleSettings":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"ThrottleSettings"} + }, + "MapOfIntegrationResponse":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"IntegrationResponse"} + }, + "MapOfKeyUsages":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"ListOfUsage"} + }, + "MapOfMethod":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Method"} + }, + "MapOfMethodResponse":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"MethodResponse"} + }, + "MapOfMethodSettings":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"MethodSetting"} + }, + "MapOfMethodSnapshot":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"MethodSnapshot"} + }, + "MapOfStringToBoolean":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"NullableBoolean"} + }, + "MapOfStringToList":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"ListOfString"} + }, + "MapOfStringToString":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Method":{ + "type":"structure", + "members":{ + "httpMethod":{ + "shape":"String", + "documentation":"

The method's HTTP verb.

" + }, + "authorizationType":{ + "shape":"String", + "documentation":"

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" + }, + "authorizerId":{ + "shape":"String", + "documentation":"

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

" + }, + "apiKeyRequired":{ + "shape":"NullableBoolean", + "documentation":"

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

" + }, + "requestValidatorId":{ + "shape":"String", + "documentation":"

The identifier of a RequestValidator for request validation.

" + }, + "operationName":{ + "shape":"String", + "documentation":"

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

" + }, + "requestParameters":{ + "shape":"MapOfStringToBoolean", + "documentation":"

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

" + }, + "requestModels":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

" + }, + "methodResponses":{ + "shape":"MapOfMethodResponse", + "documentation":"

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.operator\": false, \"method.response.header.operand_2\": false, \"method.response.header.operand_1\": false }, \"statusCode\": \"200\" }

AWS CLI
" + }, + "methodIntegration":{ + "shape":"Integration", + "documentation":"

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"0cjtch\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestTemplates\": { \"application/json\": \"{\\n \\\"a\\\": \\\"$input.params('operand1')\\\",\\n \\\"b\\\": \\\"$input.params('operand2')\\\", \\n \\\"op\\\": \\\"$input.params('operator')\\\" \\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.operator\": \"integration.response.body.op\", \"method.response.header.operand_2\": \"integration.response.body.b\", \"method.response.header.operand_1\": \"integration.response.body.a\" }, \"responseTemplates\": { \"application/json\": \"#set($res = $input.path('$'))\\n{\\n \\\"result\\\": \\\"$res.a, $res.b, $res.op => $res.c\\\",\\n \\\"a\\\" : \\\"$res.a\\\",\\n \\\"b\\\" : \\\"$res.b\\\",\\n \\\"op\\\" : \\\"$res.op\\\",\\n \\\"c\\\" : \\\"$res.c\\\"\\n}\" }, \"selectionPattern\": \"\", \"statusCode\": \"200\" } } }

AWS CLI
" + }, + "authorizationScopes":{ + "shape":"ListOfString", + "documentation":"

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

" + } + }, + "documentation":"

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Example: Retrive the GET method on a specified resource

Request

The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2) of an API (fugvjdxtri). 

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": true, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\\\")\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }

In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E and the output is decoded using the $util.urlDecode() helper function.

MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's method
" + }, + "MethodResponse":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"StatusCode", + "documentation":"

The method response's status code.

" + }, + "responseParameters":{ + "shape":"MapOfStringToBoolean", + "documentation":"

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" + }, + "responseModels":{ + "shape":"MapOfStringToString", + "documentation":"

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

" + } + }, + "documentation":"

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code.

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response

The successful response returns 200 OK status and a payload as follows:

{ \"_links\": { \"curies\": { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true }, \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" }

Method, IntegrationResponse, Integration Creating an API
" + }, + "MethodSetting":{ + "type":"structure", + "members":{ + "metricsEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

" + }, + "loggingLevel":{ + "shape":"String", + "documentation":"

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO.

" + }, + "dataTraceEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

" + }, + "throttlingBurstLimit":{ + "shape":"Integer", + "documentation":"

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

" + }, + "throttlingRateLimit":{ + "shape":"Double", + "documentation":"

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

" + }, + "cachingEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

" + }, + "cacheTtlInSeconds":{ + "shape":"Integer", + "documentation":"

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

" + }, + "cacheDataEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

" + }, + "requireAuthorizationForCacheControl":{ + "shape":"Boolean", + "documentation":"

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

" + }, + "unauthorizedCacheControlHeaderStrategy":{ + "shape":"UnauthorizedCacheControlHeaderStrategy", + "documentation":"

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

" + } + }, + "documentation":"

Specifies the method setting properties.

" + }, + "MethodSnapshot":{ + "type":"structure", + "members":{ + "authorizationType":{ + "shape":"String", + "documentation":"

The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" + }, + "apiKeyRequired":{ + "shape":"Boolean", + "documentation":"

Specifies whether the method requires a valid ApiKey.

" + } + }, + "documentation":"

Represents a summary of a Method resource, given a particular date and time.

" + }, + "Model":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier for the model resource.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of the model. Must be an alphanumeric string.

" + }, + "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. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

" + }, + "contentType":{ + "shape":"String", + "documentation":"

The content-type for the model.

" + } + }, + "documentation":"

Represents the data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings
" + }, + "Models":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfModel", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents a collection of Model resources.

Method, MethodResponse, Models and Mappings
" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The requested resource is not found. Make sure that the request URI is correct.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NullableBoolean":{"type":"boolean"}, + "NullableInteger":{"type":"integer"}, + "Op":{ + "type":"string", + "enum":[ + "add", + "remove", + "replace", + "move", + "copy", + "test" + ] + }, + "PatchOperation":{ + "type":"structure", + "members":{ + "op":{ + "shape":"Op", + "documentation":"

An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

" + }, + "path":{ + "shape":"String", + "documentation":"

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {\"name\":\"value\"}, the path for this property is /name. If the name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}), the path for the child/name property will be /name/child~1name. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each op operation can have only one path associated with it.

" + }, + "value":{ + "shape":"String", + "documentation":"

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see Using JSON for Parameters.

" + }, + "from":{ + "shape":"String", + "documentation":"

The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with \"op\":\"copy\", \"from\":\"/canarySettings/deploymentId\" and \"path\":\"/deploymentId\".

" + } + }, + "documentation":"A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used." + }, + "PathToMapOfMethodSnapshot":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"MapOfMethodSnapshot"} + }, + "ProviderARN":{"type":"string"}, + "PutGatewayResponseRequest":{ + "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" + }, + "statusCode":{ + "shape":"StatusCode", + "documentation":"The HTTP status code of the GatewayResponse." + }, + "responseParameters":{ + "shape":"MapOfStringToString", + "documentation":"

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

" + } + }, + "documentation":"

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

" + }, + "PutIntegrationRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod", + "type" + ], + "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 put integration request's resource ID.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies a put integration request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "type":{ + "shape":"IntegrationType", + "documentation":"

[Required] Specifies a put integration input's type.

" + }, + "integrationHttpMethod":{ + "shape":"String", + "documentation":"

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

", + "locationName":"httpMethod" + }, + "uri":{ + "shape":"String", + "documentation":"

Specifies Uniform Resource Identifier (URI) of the integration endpoint.

  • For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing.

  • For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

" + }, + "connectionType":{ + "shape":"ConnectionType", + "documentation":"

The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

" + }, + "connectionId":{ + "shape":"String", + "documentation":"

The (id) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

" + }, + "credentials":{ + "shape":"String", + "documentation":"

Specifies whether credentials are required for a put integration.

" + }, + "requestParameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

" + }, + "requestTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

" + }, + "passthroughBehavior":{ + "shape":"String", + "documentation":"

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

  • WHEN_NO_MATCH passes the request body for unmapped content types through to the integration back end without transformation.

  • NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

  • WHEN_NO_TEMPLATES allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

" + }, + "cacheNamespace":{ + "shape":"String", + "documentation":"

A list of request parameters whose values are to be cached.

" + }, + "cacheKeyParameters":{ + "shape":"ListOfString", + "documentation":"

An API-specific tag group of related cached parameters.

" + }, + "contentHandling":{ + "shape":"ContentHandlingStrategy", + "documentation":"

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string.

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

" + }, + "timeoutInMillis":{ + "shape":"NullableInteger", + "documentation":"

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

" + } + }, + "documentation":"

Sets up a method's integration.

" + }, + "PutIntegrationResponseRequest":{ + "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 put integration response request's resource identifier.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies a put integration response request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "statusCode":{ + "shape":"StatusCode", + "documentation":"

[Required] Specifies the status code that is used to map the integration response to an existing MethodResponse.

", + "location":"uri", + "locationName":"status_code" + }, + "selectionPattern":{ + "shape":"String", + "documentation":"

Specifies the selection pattern of a put integration response.

" + }, + "responseParameters":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

" + }, + "responseTemplates":{ + "shape":"MapOfStringToString", + "documentation":"

Specifies a put integration response's templates.

" + }, + "contentHandling":{ + "shape":"ContentHandlingStrategy", + "documentation":"

Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

  • CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.

  • CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

" + } + }, + "documentation":"

Represents a put integration response request.

" + }, + "PutMethodRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod", + "authorizationType" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "resourceId":{ + "shape":"String", + "documentation":"

[Required] The Resource identifier for the new Method resource.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies the method request's HTTP method type.

", + "location":"uri", + "locationName":"http_method" + }, + "authorizationType":{ + "shape":"String", + "documentation":"

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

" + }, + "authorizerId":{ + "shape":"String", + "documentation":"

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

" + }, + "apiKeyRequired":{ + "shape":"Boolean", + "documentation":"

Specifies whether the method required a valid ApiKey.

" + }, + "operationName":{ + "shape":"String", + "documentation":"

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

" + }, + "requestParameters":{ + "shape":"MapOfStringToBoolean", + "documentation":"

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

" + }, + "requestModels":{ + "shape":"MapOfStringToString", + "documentation":"

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

" + }, + "requestValidatorId":{ + "shape":"String", + "documentation":"

The identifier of a RequestValidator for validating the method request.

" + }, + "authorizationScopes":{ + "shape":"ListOfString", + "documentation":"

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

" + } + }, + "documentation":"

Request to add a method to an existing Resource resource.

" + }, + "PutMethodResponseRequest":{ + "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 Method 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 method response's status code.

", + "location":"uri", + "locationName":"status_code" + }, + "responseParameters":{ + "shape":"MapOfStringToBoolean", + "documentation":"

A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

" + }, + "responseModels":{ + "shape":"MapOfStringToString", + "documentation":"

Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

" + } + }, + "documentation":"

Request to add a MethodResponse to an existing Method resource.

" + }, + "PutMode":{ + "type":"string", + "enum":[ + "merge", + "overwrite" + ] + }, + "PutRestApiRequest":{ + "type":"structure", + "required":[ + "restApiId", + "body" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "mode":{ + "shape":"PutMode", + "documentation":"

The mode query parameter to specify the update mode. Valid values are \"merge\" and \"overwrite\". By default, the update mode is \"merge\".

", + "location":"querystring", + "locationName":"mode" + }, + "failOnWarnings":{ + "shape":"Boolean", + "documentation":"

A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

", + "location":"querystring", + "locationName":"failonwarnings" + }, + "parameters":{ + "shape":"MapOfStringToString", + "documentation":"

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

", + "location":"querystring" + }, + "body":{ + "shape":"Blob", + "documentation":"

[Required] The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 2MB.

" + } + }, + "documentation":"

A PUT request to update an existing API, with external API definitions specified as the request body.

", + "payload":"body" + }, + "QuotaPeriodType":{ + "type":"string", + "enum":[ + "DAY", + "WEEK", + "MONTH" + ] + }, + "QuotaSettings":{ + "type":"structure", + "members":{ + "limit":{ + "shape":"Integer", + "documentation":"

The maximum number of requests that can be made in a given time period.

" + }, + "offset":{ + "shape":"Integer", + "documentation":"

The number of requests subtracted from the given limit in the initial time period.

" + }, + "period":{ + "shape":"QuotaPeriodType", + "documentation":"

The time period in which the limit applies. Valid values are \"DAY\", \"WEEK\" or \"MONTH\".

" + } + }, + "documentation":"

Quotas configured for a usage plan.

" + }, + "RequestValidator":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier of this RequestValidator.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of this RequestValidator

" + }, + "validateRequestBody":{ + "shape":"Boolean", + "documentation":"

A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

" + }, + "validateRequestParameters":{ + "shape":"Boolean", + "documentation":"

A Boolean flag to indicate whether to validate request parameters (true) or not (false).

" + } + }, + "documentation":"

A set of validation rules for incoming Method requests.

In OpenAPI, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.

Enable Basic Request Validation in API Gateway
" + }, + "RequestValidators":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfRequestValidator", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

A collection of RequestValidator resources of a given RestApi.

In OpenAPI, the RequestValidators of an API is defined by the x-amazon-apigateway-request-validators extension.

Enable Basic Request Validation in API Gateway
" + }, + "Resource":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The resource's identifier.

" + }, + "parentId":{ + "shape":"String", + "documentation":"

The parent resource's identifier.

" + }, + "pathPart":{ + "shape":"String", + "documentation":"

The last path segment for this resource.

" + }, + "path":{ + "shape":"String", + "documentation":"

The full path for this resource.

" + }, + "resourceMethods":{ + "shape":"MapOfMethod", + "documentation":"

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET /restapis/{restapi_id}/resources/{resource_id} or GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods request.

Example: Get the GET method of an API resource

Request
GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}
Response
{ \"_links\": { \"curies\": [ { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html\", \"name\": \"integration\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html\", \"name\": \"integrationresponse\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html\", \"name\": \"method\", \"templated\": true }, { \"href\": \"https://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html\", \"name\": \"methodresponse\", \"templated\": true } ], \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\", \"name\": \"GET\", \"title\": \"GET\" }, \"integration:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"method:integration\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"method:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"method:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET\" }, \"methodresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}\", \"templated\": true } }, \"apiKeyRequired\": false, \"authorizationType\": \"NONE\", \"httpMethod\": \"GET\", \"_embedded\": { \"method:integration\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integration:responses\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integration:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration\" }, \"integrationresponse:put\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}\", \"templated\": true } }, \"cacheKeyParameters\": [], \"cacheNamespace\": \"3kzxbg5sa2\", \"credentials\": \"arn:aws:iam::123456789012:role/apigAwsProxyRole\", \"httpMethod\": \"POST\", \"passthroughBehavior\": \"WHEN_NO_MATCH\", \"requestParameters\": { \"integration.request.header.Content-Type\": \"'application/x-amz-json-1.1'\" }, \"requestTemplates\": { \"application/json\": \"{\\n}\" }, \"type\": \"AWS\", \"uri\": \"arn:aws:apigateway:us-east-1:kinesis:action/ListStreams\", \"_embedded\": { \"integration:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"integrationresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" }, \"integrationresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200\" } }, \"responseParameters\": { \"method.response.header.Content-Type\": \"'application/xml'\" }, \"responseTemplates\": { \"application/json\": \"$util.urlDecode(\\\"%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\\\")\\n\" }, \"statusCode\": \"200\" } } }, \"method:responses\": { \"_links\": { \"self\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\", \"name\": \"200\", \"title\": \"200\" }, \"methodresponse:delete\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" }, \"methodresponse:update\": { \"href\": \"/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200\" } }, \"responseModels\": { \"application/json\": \"Empty\" }, \"responseParameters\": { \"method.response.header.Content-Type\": false }, \"statusCode\": \"200\" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

" + } + }, + "documentation":"

Represents an API resource.

Create an API
" + }, + "Resources":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfResource", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents a collection of Resource resources.

Create an API
" + }, + "RestApi":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

" + }, + "name":{ + "shape":"String", + "documentation":"

The API's name.

" + }, + "description":{ + "shape":"String", + "documentation":"

The API's description.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The timestamp when the API was created.

" + }, + "version":{ + "shape":"String", + "documentation":"

A version identifier for the API.

" + }, + "warnings":{ + "shape":"ListOfString", + "documentation":"

The warning messages reported when failonwarnings is turned on during API import.

" + }, + "binaryMediaTypes":{ + "shape":"ListOfString", + "documentation":"

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

" + }, + "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." + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

Represents a REST API.

Create an API
" + }, + "RestApis":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfRestApi", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

Create an API
" + }, + "SdkConfigurationProperty":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of a an SdkType configuration property.

" + }, + "friendlyName":{ + "shape":"String", + "documentation":"

The user-friendly name of an SdkType configuration property.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of an SdkType configuration property.

" + }, + "required":{ + "shape":"Boolean", + "documentation":"

A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

" + }, + "defaultValue":{ + "shape":"String", + "documentation":"

The default value of an SdkType configuration property.

" + } + }, + "documentation":"

A configuration property of an SDK type.

" + }, + "SdkResponse":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"String", + "documentation":"

The content-type header value in the HTTP response.

", + "location":"header", + "locationName":"Content-Type" + }, + "contentDisposition":{ + "shape":"String", + "documentation":"

The content-disposition header value in the HTTP response.

", + "location":"header", + "locationName":"Content-Disposition" + }, + "body":{ + "shape":"Blob", + "documentation":"

The binary blob response to GetSdk, which contains the generated SDK.

" + } + }, + "documentation":"

The binary blob response to GetSdk, which contains the generated SDK.

", + "payload":"body" + }, + "SdkType":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier of an SdkType instance.

" + }, + "friendlyName":{ + "shape":"String", + "documentation":"

The user-friendly name of an SdkType instance.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of an SdkType.

" + }, + "configurationProperties":{ + "shape":"ListOfSdkConfigurationProperty", + "documentation":"

A list of configuration properties of an SdkType.

" + } + }, + "documentation":"

A type of SDK that API Gateway can generate.

" + }, + "SdkTypes":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfSdkType", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

The collection of SdkType instances.

" + }, + "SecurityPolicy":{ + "type":"string", + "enum":[ + "TLS_1_0", + "TLS_1_2" + ] + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"String"} + }, + "documentation":"

The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "Stage":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"String", + "documentation":"

The identifier of the Deployment that the stage points to.

" + }, + "clientCertificateId":{ + "shape":"String", + "documentation":"

The identifier of a client certificate for an API stage.

" + }, + "stageName":{ + "shape":"String", + "documentation":"

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

" + }, + "description":{ + "shape":"String", + "documentation":"

The stage's description.

" + }, + "cacheClusterEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether a cache cluster is enabled for the stage.

" + }, + "cacheClusterSize":{ + "shape":"CacheClusterSize", + "documentation":"

The size of the cache cluster for the stage, if enabled.

" + }, + "cacheClusterStatus":{ + "shape":"CacheClusterStatus", + "documentation":"

The status of the cache cluster for the stage, if enabled.

" + }, + "methodSettings":{ + "shape":"MapOfMethodSettings", + "documentation":"

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\\*/\\* for overriding all methods in the stage.

" + }, + "variables":{ + "shape":"MapOfStringToString", + "documentation":"

A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "documentationVersion":{ + "shape":"String", + "documentation":"

The version of the associated API documentation.

" + }, + "accessLogSettings":{ + "shape":"AccessLogSettings", + "documentation":"

Settings for logging access in this stage.

" + }, + "canarySettings":{ + "shape":"CanarySettings", + "documentation":"

Settings for the canary deployment in this stage.

" + }, + "tracingEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether active tracing with X-ray is enabled for the Stage.

" + }, + "webAclArn":{ + "shape":"String", + "documentation":"

The ARN of the WebAcl associated with the Stage.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The timestamp when the stage was created.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The timestamp when the stage last updated.

" + } + }, + "documentation":"

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API
" + }, + "StageKey":{ + "type":"structure", + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

The string identifier of the associated RestApi.

" + }, + "stageName":{ + "shape":"String", + "documentation":"

The stage name associated with the stage key.

" + } + }, + "documentation":"

A reference to a unique stage identified in the format {restApiId}/{stage}.

" + }, + "Stages":{ + "type":"structure", + "members":{ + "item":{ + "shape":"ListOfStage", + "documentation":"

The current page of elements from this collection.

" + } + }, + "documentation":"

A list of Stage resources that are associated with the ApiKey resource.

Deploying API in Stages
" + }, + "StatusCode":{ + "type":"string", + "documentation":"

The status code.

", + "pattern":"[1-5]\\d\\d" + }, + "String":{"type":"string"}, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

", + "location":"uri", + "locationName":"resource_arn" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

[Required] 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":"

Adds or updates a tag on a given resource.

" + }, + "Tags":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + }, + "Template":{ + "type":"structure", + "members":{ + "value":{ + "shape":"String", + "documentation":"

The Apache Velocity Template Language (VTL) template content used for the template resource.

" + } + }, + "documentation":"

Represents a mapping template used to transform a payload.

Mapping Templates
" + }, + "TestInvokeAuthorizerRequest":{ + "type":"structure", + "required":[ + "restApiId", + "authorizerId" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "authorizerId":{ + "shape":"String", + "documentation":"

[Required] Specifies a test invoke authorizer request's Authorizer ID.

", + "location":"uri", + "locationName":"authorizer_id" + }, + "headers":{ + "shape":"MapOfStringToString", + "documentation":"

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

" + }, + "multiValueHeaders":{ + "shape":"MapOfStringToList", + "documentation":"

[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

" + }, + "pathWithQueryString":{ + "shape":"String", + "documentation":"

[Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" + }, + "body":{ + "shape":"String", + "documentation":"

[Optional] The simulated request body of an incoming invocation request.

" + }, + "stageVariables":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" + }, + "additionalContext":{ + "shape":"MapOfStringToString", + "documentation":"

[Optional] A key-value map of additional context variables.

" + } + }, + "documentation":"

Make a request to simulate the execution of an Authorizer.

" + }, + "TestInvokeAuthorizerResponse":{ + "type":"structure", + "members":{ + "clientStatus":{ + "shape":"Integer", + "documentation":"

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

" + }, + "log":{ + "shape":"String", + "documentation":"

The API Gateway execution log for the test authorizer request.

" + }, + "latency":{ + "shape":"Long", + "documentation":"

The execution latency of the test authorizer request.

" + }, + "principalId":{ + "shape":"String", + "documentation":"

The principal identity returned by the Authorizer

" + }, + "policy":{ + "shape":"String", + "documentation":"

The JSON policy document returned by the Authorizer

" + }, + "authorization":{"shape":"MapOfStringToList"}, + "claims":{ + "shape":"MapOfStringToString", + "documentation":"

The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

" + } + }, + "documentation":"

Represents the response of the test invoke request for a custom Authorizer

" + }, + "TestInvokeMethodRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "resourceId":{ + "shape":"String", + "documentation":"

[Required] Specifies a test invoke method request's resource ID.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies a test invoke method request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "pathWithQueryString":{ + "shape":"String", + "documentation":"

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

" + }, + "body":{ + "shape":"String", + "documentation":"

The simulated request body of an incoming invocation request.

" + }, + "headers":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map of headers to simulate an incoming invocation request.

" + }, + "multiValueHeaders":{ + "shape":"MapOfStringToList", + "documentation":"

The headers as a map from string to list of values to simulate an incoming invocation request.

" + }, + "clientCertificateId":{ + "shape":"String", + "documentation":"

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

" + }, + "stageVariables":{ + "shape":"MapOfStringToString", + "documentation":"

A key-value map of stage variables to simulate an invocation on a deployed Stage.

" + } + }, + "documentation":"

Make a request to simulate the execution of a Method.

" + }, + "TestInvokeMethodResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"Integer", + "documentation":"

The HTTP status code.

" + }, + "body":{ + "shape":"String", + "documentation":"

The body of the HTTP response.

" + }, + "headers":{ + "shape":"MapOfStringToString", + "documentation":"

The headers of the HTTP response.

" + }, + "multiValueHeaders":{ + "shape":"MapOfStringToList", + "documentation":"

The headers of the HTTP response as a map from string to list of values.

" + }, + "log":{ + "shape":"String", + "documentation":"

The API Gateway execution log for the test invoke request.

" + }, + "latency":{ + "shape":"Long", + "documentation":"

The execution latency of the test invoke request.

" + } + }, + "documentation":"

Represents the response of the test invoke request in the HTTP method.

Test API using the API Gateway console
" + }, + "ThrottleSettings":{ + "type":"structure", + "members":{ + "burstLimit":{ + "shape":"Integer", + "documentation":"

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

" + }, + "rateLimit":{ + "shape":"Double", + "documentation":"

The API request steady-state rate limit.

" + } + }, + "documentation":"

The API request rate limits.

" + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"String"} + }, + "documentation":"

The request has reached its throttling limit. Retry after the specified time period.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedCacheControlHeaderStrategy":{ + "type":"string", + "enum":[ + "FAIL_WITH_403", + "SUCCEED_WITH_RESPONSE_HEADER", + "SUCCEED_WITHOUT_RESPONSE_HEADER" + ] + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request is denied because the caller has insufficient permissions.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

[Required] The ARN of a resource that can be tagged. The resource ARN must be URL-encoded.

", + "location":"uri", + "locationName":"resource_arn" + }, + "tagKeys":{ + "shape":"ListOfString", + "documentation":"

[Required] The Tag keys to delete.

", + "location":"querystring", + "locationName":"tagKeys" + } + }, + "documentation":"

Removes a tag from a given resource.

" + }, + "UpdateAccountRequest":{ + "type":"structure", + "members":{ + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Requests API Gateway to change information about the current Account resource.

" + }, + "UpdateApiKeyRequest":{ + "type":"structure", + "required":["apiKey"], + "members":{ + "apiKey":{ + "shape":"String", + "documentation":"

[Required] The identifier of the ApiKey resource to be updated.

", + "location":"uri", + "locationName":"api_Key" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

A request to change information about an ApiKey resource.

" + }, + "UpdateAuthorizerRequest":{ + "type":"structure", + "required":[ + "restApiId", + "authorizerId" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Request to update an existing Authorizer resource.

" + }, + "UpdateBasePathMappingRequest":{ + "type":"structure", + "required":[ + "domainName", + "basePath" + ], + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

[Required] The domain name of the BasePathMapping resource to change.

", + "location":"uri", + "locationName":"domain_name" + }, + "basePath":{ + "shape":"String", + "documentation":"

[Required] The base path of the BasePathMapping resource to change.

To specify an empty base path, set this parameter to '(none)'.

", + "location":"uri", + "locationName":"base_path" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

A request to change information about the BasePathMapping resource.

" + }, + "UpdateClientCertificateRequest":{ + "type":"structure", + "required":["clientCertificateId"], + "members":{ + "clientCertificateId":{ + "shape":"String", + "documentation":"

[Required] The identifier of the ClientCertificate resource to be updated.

", + "location":"uri", + "locationName":"clientcertificate_id" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

A request to change information about an ClientCertificate resource.

" + }, + "UpdateDeploymentRequest":{ + "type":"structure", + "required":[ + "restApiId", + "deploymentId" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "deploymentId":{ + "shape":"String", + "documentation":"

The replacement identifier for the Deployment resource to change information about.

", + "location":"uri", + "locationName":"deployment_id" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Requests API Gateway to change information about a Deployment resource.

" + }, + "UpdateDocumentationPartRequest":{ + "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-updated documentation part.

", + "location":"uri", + "locationName":"part_id" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Updates an existing documentation part of a given API.

" + }, + "UpdateDocumentationVersionRequest":{ + "type":"structure", + "required":[ + "restApiId", + "documentationVersion" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi..

", + "location":"uri", + "locationName":"restapi_id" + }, + "documentationVersion":{ + "shape":"String", + "documentation":"

[Required] The version identifier of the to-be-updated documentation version.

", + "location":"uri", + "locationName":"doc_version" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Updates an existing documentation version of an API.

" + }, + "UpdateDomainNameRequest":{ + "type":"structure", + "required":["domainName"], + "members":{ + "domainName":{ + "shape":"String", + "documentation":"

[Required] The name of the DomainName resource to be changed.

", + "location":"uri", + "locationName":"domain_name" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

A request to change information about the DomainName resource.

" + }, + "UpdateGatewayResponseRequest":{ + "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" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Updates a GatewayResponse of a specified response type on the given RestApi.

" + }, + "UpdateIntegrationRequest":{ + "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] Represents an update integration request's resource identifier.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Represents an update integration request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Represents an update integration request.

" + }, + "UpdateIntegrationResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "resourceId":{ + "shape":"String", + "documentation":"

[Required] Specifies an update integration response request's resource identifier.

", + "location":"uri", + "locationName":"resource_id" + }, + "httpMethod":{ + "shape":"String", + "documentation":"

[Required] Specifies an update integration response request's HTTP method.

", + "location":"uri", + "locationName":"http_method" + }, + "statusCode":{ + "shape":"StatusCode", + "documentation":"

[Required] Specifies an update integration response request's status code.

", + "location":"uri", + "locationName":"status_code" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Represents an update integration response request.

" + }, + "UpdateMethodRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Request to update an existing Method resource.

" + }, + "UpdateMethodResponseRequest":{ + "type":"structure", + "required":[ + "restApiId", + "resourceId", + "httpMethod", + "statusCode" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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 for the MethodResponse resource.

", + "location":"uri", + "locationName":"status_code" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

A request to update an existing MethodResponse resource.

" + }, + "UpdateModelRequest":{ + "type":"structure", + "required":[ + "restApiId", + "modelName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "modelName":{ + "shape":"String", + "documentation":"

[Required] The name of the model to update.

", + "location":"uri", + "locationName":"model_name" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Request to update an existing model in an existing RestApi resource.

" + }, + "UpdateRequestValidatorRequest":{ + "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 RequestValidator to be updated.

", + "location":"uri", + "locationName":"requestvalidator_id" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Updates a RequestValidator of a given RestApi.

" + }, + "UpdateResourceRequest":{ + "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" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Request to change information about a Resource resource.

" + }, + "UpdateRestApiRequest":{ + "type":"structure", + "required":["restApiId"], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[Required] The string identifier of the associated RestApi.

", + "location":"uri", + "locationName":"restapi_id" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Request to update an existing RestApi resource in your collection.

" + }, + "UpdateStageRequest":{ + "type":"structure", + "required":[ + "restApiId", + "stageName" + ], + "members":{ + "restApiId":{ + "shape":"String", + "documentation":"

[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 change information about.

", + "location":"uri", + "locationName":"stage_name" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Requests API Gateway to change information about a Stage resource.

" + }, + "UpdateUsagePlanRequest":{ + "type":"structure", + "required":["usagePlanId"], + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

[Required] The Id of the to-be-updated usage plan.

", + "location":"uri", + "locationName":"usageplanId" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

The PATCH request to update a usage plan of a given plan Id.

" + }, + "UpdateUsageRequest":{ + "type":"structure", + "required":[ + "usagePlanId", + "keyId" + ], + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

[Required] The Id of the usage plan associated with the usage data.

", + "location":"uri", + "locationName":"usageplanId" + }, + "keyId":{ + "shape":"String", + "documentation":"

[Required] The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

", + "location":"uri", + "locationName":"keyId" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

" + }, + "UpdateVpcLinkRequest":{ + "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" + }, + "patchOperations":{ + "shape":"ListOfPatchOperation", + "documentation":"

A list of update operations to be applied to the specified resource and in the order specified in this list.

" + } + }, + "documentation":"

Updates an existing VpcLink of a specified identifier.

" + }, + "Usage":{ + "type":"structure", + "members":{ + "usagePlanId":{ + "shape":"String", + "documentation":"

The plan Id associated with this usage data.

" + }, + "startDate":{ + "shape":"String", + "documentation":"

The starting date of the usage data.

" + }, + "endDate":{ + "shape":"String", + "documentation":"

The ending date of the usage data.

" + }, + "position":{"shape":"String"}, + "items":{ + "shape":"MapOfKeyUsages", + "documentation":"

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., \"values\" : { \"{api_key}\" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

", + "locationName":"values" + } + }, + "documentation":"

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan
" + }, + "UsagePlan":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier of a UsagePlan resource.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of a usage plan.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of a usage plan.

" + }, + "apiStages":{ + "shape":"ListOfApiStage", + "documentation":"

The associated API stages of a usage plan.

" + }, + "throttle":{ + "shape":"ThrottleSettings", + "documentation":"

The request throttle limits of a usage plan.

" + }, + "quota":{ + "shape":"QuotaSettings", + "documentation":"

The maximum number of permitted requests per a given unit time interval.

" + }, + "productCode":{ + "shape":"String", + "documentation":"

The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans
" + }, + "UsagePlanKey":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The Id of a usage plan key.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of a usage plan key. Currently, the valid key type is API_KEY.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of a usage plan key.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of a usage plan key.

" + } + }, + "documentation":"

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

\"
Create and Use Usage Plans
" + }, + "UsagePlanKeys":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfUsagePlanKey", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

Create and Use Usage Plans
" + }, + "UsagePlans":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfUsagePlan", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

Represents a collection of usage plans for an AWS account.

Create and Use Usage Plans
" + }, + "VpcLink":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name used to label and identify the VPC link.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the VPC link.

" + }, + "targetArns":{ + "shape":"ListOfString", + "documentation":"

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.

" + }, + "status":{ + "shape":"VpcLinkStatus", + "documentation":"

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

" + }, + "statusMessage":{ + "shape":"String", + "documentation":"

A description about the VPC link status.

" + }, + "tags":{ + "shape":"MapOfStringToString", + "documentation":"

The collection of tags. Each tag element is associated with a given resource.

" + } + }, + "documentation":"

A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

" + }, + "VpcLinkStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "PENDING", + "DELETING", + "FAILED" + ] + }, + "VpcLinks":{ + "type":"structure", + "members":{ + "position":{"shape":"String"}, + "items":{ + "shape":"ListOfVpcLink", + "documentation":"

The current page of elements from this collection.

", + "locationName":"item" + } + }, + "documentation":"

The collection of VPC links under the caller's account in a region.

Getting Started with Private Integrations, Set up Private Integrations
" + } + }, + "documentation":"Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

" +} diff --git a/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/paginators-1.json b/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/service-2.json b/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/service-2.json new file mode 100644 index 00000000..39fc9171 --- /dev/null +++ b/aws/dist/botocore/data/apigatewaymanagementapi/2018-11-29/service-2.json @@ -0,0 +1,217 @@ +{ + "metadata" : { + "apiVersion" : "2018-11-29", + "endpointPrefix" : "execute-api", + "signingName" : "execute-api", + "serviceFullName" : "AmazonApiGatewayManagementApi", + "serviceId" : "ApiGatewayManagementApi", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "apigatewaymanagementapi-2018-11-29", + "signatureVersion" : "v4" + }, + "operations" : { + "DeleteConnection" : { + "name" : "DeleteConnection", + "http" : { + "method" : "DELETE", + "requestUri" : "/@connections/{connectionId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteConnectionRequest" + }, + "errors" : [ { + "shape" : "GoneException", + "documentation" : "

The connection with the provided id no longer exists.

" + }, { + "shape" : "LimitExceededException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

" + }, { + "shape" : "ForbiddenException", + "documentation" : "

The caller is not authorized to invoke this operation.

" + } ], + "documentation" : "

Delete the connection with the provided id.

" + }, + "GetConnection" : { + "name" : "GetConnection", + "http" : { + "method" : "GET", + "requestUri" : "/@connections/{connectionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConnectionRequest" + }, + "output" : { + "shape" : "GetConnectionResponse" + }, + "errors" : [ { + "shape" : "GoneException", + "documentation" : "

The connection with the provided id no longer exists.

" + }, { + "shape" : "LimitExceededException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

" + }, { + "shape" : "ForbiddenException", + "documentation" : "

The caller is not authorized to invoke this operation.

" + } ], + "documentation" : "

Get information about the connection with the provided id.

" + }, + "PostToConnection" : { + "name" : "PostToConnection", + "http" : { + "method" : "POST", + "requestUri" : "/@connections/{connectionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "PostToConnectionRequest" + }, + "errors" : [ { + "shape" : "GoneException", + "documentation" : "

The connection with the provided id no longer exists.

" + }, { + "shape" : "LimitExceededException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

" + }, { + "shape" : "PayloadTooLargeException", + "documentation" : "

The data has exceeded the maximum size allowed.

" + }, { + "shape" : "ForbiddenException", + "documentation" : "

The caller is not authorized to invoke this operation.

" + } ], + "documentation" : "

Sends the provided data to the specified connection.

" + } + }, + "shapes" : { + "Data" : { + "type" : "blob", + "max" : 131072, + "documentation" : "

The data to be sent to the client specified by its connection id.

" + }, + "DeleteConnectionRequest" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "connectionId" + } + }, + "required" : [ "ConnectionId" ] + }, + "ForbiddenException" : { + "type" : "structure", + "members" : { }, + "documentation" : "

The caller is not authorized to invoke this operation.

", + "exception" : true, + "error" : { + "httpStatusCode" : 403 + } + }, + "GetConnectionRequest" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "connectionId" + } + }, + "required" : [ "ConnectionId" ] + }, + "GetConnectionResponse" : { + "type" : "structure", + "members" : { + "ConnectedAt" : { + "shape" : "__timestampIso8601", + "locationName" : "connectedAt", + "documentation" : "

The time in ISO 8601 format for when the connection was established.

" + }, + "Identity" : { + "shape" : "Identity", + "locationName" : "identity" + }, + "LastActiveAt" : { + "shape" : "__timestampIso8601", + "locationName" : "lastActiveAt", + "documentation" : "

The time in ISO 8601 format for when the connection was last active.

" + } + } + }, + "GoneException" : { + "type" : "structure", + "members" : { }, + "documentation" : "

The connection with the provided id no longer exists.

", + "exception" : true, + "error" : { + "httpStatusCode" : 410 + } + }, + "Identity" : { + "type" : "structure", + "members" : { + "SourceIp" : { + "shape" : "__string", + "locationName" : "sourceIp", + "documentation" : "

The source IP address of the TCP connection making the request to API Gateway.

" + }, + "UserAgent" : { + "shape" : "__string", + "locationName" : "userAgent", + "documentation" : "

The User Agent of the API caller.

" + } + }, + "required" : [ "SourceIp", "UserAgent" ] + }, + "PayloadTooLargeException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message" + } + }, + "documentation" : "

The data has exceeded the maximum size allowed.

", + "exception" : true, + "error" : { + "httpStatusCode" : 413 + } + }, + "PostToConnectionRequest" : { + "type" : "structure", + "members" : { + "Data" : { + "shape" : "Data", + "documentation" : "

The data to be sent to the client specified by its connection id.

" + }, + "ConnectionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "connectionId", + "documentation" : "

The identifier of the connection that a specific client is using.

" + } + }, + "required" : [ "ConnectionId", "Data" ], + "payload" : "Data" + }, + "LimitExceededException" : { + "type" : "structure", + "members" : { }, + "documentation" : "

The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.

", + "exception" : true, + "error" : { + "httpStatusCode" : 429 + } + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + } + }, + "documentation" : "

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

" +} \ No newline at end of file diff --git a/aws/dist/botocore/data/apigatewayv2/2018-11-29/paginators-1.json b/aws/dist/botocore/data/apigatewayv2/2018-11-29/paginators-1.json new file mode 100644 index 00000000..2f57dd2c --- /dev/null +++ b/aws/dist/botocore/data/apigatewayv2/2018-11-29/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "GetApis": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetAuthorizers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetDeployments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetDomainNames": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetIntegrationResponses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetIntegrations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetModels": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetRouteResponses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetRoutes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + }, + "GetStages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/aws/dist/botocore/data/apigatewayv2/2018-11-29/service-2.json b/aws/dist/botocore/data/apigatewayv2/2018-11-29/service-2.json new file mode 100644 index 00000000..5a287aab --- /dev/null +++ b/aws/dist/botocore/data/apigatewayv2/2018-11-29/service-2.json @@ -0,0 +1,6962 @@ +{ + "metadata" : { + "apiVersion" : "2018-11-29", + "endpointPrefix" : "apigateway", + "signingName" : "apigateway", + "serviceFullName" : "AmazonApiGatewayV2", + "serviceId" : "ApiGatewayV2", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "apigatewayv2-2018-11-29", + "signatureVersion" : "v4" + }, + "operations" : { + "CreateApi" : { + "name" : "CreateApi", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateApiRequest" + }, + "output" : { + "shape" : "CreateApiResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates an Api resource.

" + }, + "CreateApiMapping" : { + "name" : "CreateApiMapping", + "http" : { + "method" : "POST", + "requestUri" : "/v2/domainnames/{domainName}/apimappings", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateApiMappingRequest" + }, + "output" : { + "shape" : "CreateApiMappingResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates an API mapping.

" + }, + "CreateAuthorizer" : { + "name" : "CreateAuthorizer", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/authorizers", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateAuthorizerRequest" + }, + "output" : { + "shape" : "CreateAuthorizerResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates an Authorizer for an API.

" + }, + "CreateDeployment" : { + "name" : "CreateDeployment", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/deployments", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateDeploymentRequest" + }, + "output" : { + "shape" : "CreateDeploymentResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a Deployment for an API.

" + }, + "CreateDomainName" : { + "name" : "CreateDomainName", + "http" : { + "method" : "POST", + "requestUri" : "/v2/domainnames", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateDomainNameRequest" + }, + "output" : { + "shape" : "CreateDomainNameResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a domain name.

" + }, + "CreateIntegration" : { + "name" : "CreateIntegration", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/integrations", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateIntegrationRequest" + }, + "output" : { + "shape" : "CreateIntegrationResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates an Integration.

" + }, + "CreateIntegrationResponse" : { + "name" : "CreateIntegrationResponse", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateIntegrationResponseRequest" + }, + "output" : { + "shape" : "CreateIntegrationResponseResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates an IntegrationResponses.

" + }, + "CreateModel" : { + "name" : "CreateModel", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/models", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateModelRequest" + }, + "output" : { + "shape" : "CreateModelResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a Model for an API.

" + }, + "CreateRoute" : { + "name" : "CreateRoute", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/routes", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateRouteRequest" + }, + "output" : { + "shape" : "CreateRouteResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a Route for an API.

" + }, + "CreateRouteResponse" : { + "name" : "CreateRouteResponse", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateRouteResponseRequest" + }, + "output" : { + "shape" : "CreateRouteResponseResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a RouteResponse for a Route.

" + }, + "CreateStage" : { + "name" : "CreateStage", + "http" : { + "method" : "POST", + "requestUri" : "/v2/apis/{apiId}/stages", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateStageRequest" + }, + "output" : { + "shape" : "CreateStageResponse", + "documentation" : "

The request has succeeded and has resulted in the creation of a resource.

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Creates a Stage for an API.

" + }, + "DeleteApi" : { + "name" : "DeleteApi", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteApiRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes an Api resource.

" + }, + "DeleteApiMapping" : { + "name" : "DeleteApiMapping", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteApiMappingRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Deletes an API mapping.

" + }, + "DeleteAuthorizer" : { + "name" : "DeleteAuthorizer", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteAuthorizerRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes an Authorizer.

" + }, + "DeleteDeployment" : { + "name" : "DeleteDeployment", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteDeploymentRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a Deployment.

" + }, + "DeleteDomainName" : { + "name" : "DeleteDomainName", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteDomainNameRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a domain name.

" + }, + "DeleteIntegration" : { + "name" : "DeleteIntegration", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteIntegrationRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes an Integration.

" + }, + "DeleteIntegrationResponse" : { + "name" : "DeleteIntegrationResponse", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteIntegrationResponseRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes an IntegrationResponses.

" + }, + "DeleteModel" : { + "name" : "DeleteModel", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteModelRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a Model.

" + }, + "DeleteRoute" : { + "name" : "DeleteRoute", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteRouteRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a Route.

" + }, + "DeleteRouteResponse" : { + "name" : "DeleteRouteResponse", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteRouteResponseRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a RouteResponse.

" + }, + "DeleteStage" : { + "name" : "DeleteStage", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteStageRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Deletes a Stage.

" + }, + "GetApi" : { + "name" : "GetApi", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiRequest" + }, + "output" : { + "shape" : "GetApiResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets an Api resource.

" + }, + "GetApiMapping" : { + "name" : "GetApiMapping", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiMappingRequest" + }, + "output" : { + "shape" : "GetApiMappingResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

The API mapping.

" + }, + "GetApiMappings" : { + "name" : "GetApiMappings", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}/apimappings", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApiMappingsRequest" + }, + "output" : { + "shape" : "GetApiMappingsResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

The API mappings.

" + }, + "GetApis" : { + "name" : "GetApis", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApisRequest" + }, + "output" : { + "shape" : "GetApisResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets a collection of Api resources.

" + }, + "GetAuthorizer" : { + "name" : "GetAuthorizer", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetAuthorizerRequest" + }, + "output" : { + "shape" : "GetAuthorizerResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets an Authorizer.

" + }, + "GetAuthorizers" : { + "name" : "GetAuthorizers", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/authorizers", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetAuthorizersRequest" + }, + "output" : { + "shape" : "GetAuthorizersResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Authorizers for an API.

" + }, + "GetDeployment" : { + "name" : "GetDeployment", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeploymentRequest" + }, + "output" : { + "shape" : "GetDeploymentResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a Deployment.

" + }, + "GetDeployments" : { + "name" : "GetDeployments", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeploymentsRequest" + }, + "output" : { + "shape" : "GetDeploymentsResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Deployments for an API.

" + }, + "GetDomainName" : { + "name" : "GetDomainName", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDomainNameRequest" + }, + "output" : { + "shape" : "GetDomainNameResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a domain name.

" + }, + "GetDomainNames" : { + "name" : "GetDomainNames", + "http" : { + "method" : "GET", + "requestUri" : "/v2/domainnames", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDomainNamesRequest" + }, + "output" : { + "shape" : "GetDomainNamesResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the domain names for an AWS account.

" + }, + "GetIntegration" : { + "name" : "GetIntegration", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationRequest" + }, + "output" : { + "shape" : "GetIntegrationResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets an Integration.

" + }, + "GetIntegrationResponse" : { + "name" : "GetIntegrationResponse", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationResponseRequest" + }, + "output" : { + "shape" : "GetIntegrationResponseResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets an IntegrationResponses.

" + }, + "GetIntegrationResponses" : { + "name" : "GetIntegrationResponses", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationResponsesRequest" + }, + "output" : { + "shape" : "GetIntegrationResponsesResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the IntegrationResponses for an Integration.

" + }, + "GetIntegrations" : { + "name" : "GetIntegrations", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/integrations", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetIntegrationsRequest" + }, + "output" : { + "shape" : "GetIntegrationsResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Integrations for an API.

" + }, + "GetModel" : { + "name" : "GetModel", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelRequest" + }, + "output" : { + "shape" : "GetModelResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a Model.

" + }, + "GetModelTemplate" : { + "name" : "GetModelTemplate", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}/template", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelTemplateRequest" + }, + "output" : { + "shape" : "GetModelTemplateResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a model template.

" + }, + "GetModels" : { + "name" : "GetModels", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/models", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetModelsRequest" + }, + "output" : { + "shape" : "GetModelsResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Models for an API.

" + }, + "GetRoute" : { + "name" : "GetRoute", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteRequest" + }, + "output" : { + "shape" : "GetRouteResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a Route.

" + }, + "GetRouteResponse" : { + "name" : "GetRouteResponse", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteResponseRequest" + }, + "output" : { + "shape" : "GetRouteResponseResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a RouteResponse.

" + }, + "GetRouteResponses" : { + "name" : "GetRouteResponses", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRouteResponsesRequest" + }, + "output" : { + "shape" : "GetRouteResponsesResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the RouteResponses for a Route.

" + }, + "GetRoutes" : { + "name" : "GetRoutes", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/routes", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetRoutesRequest" + }, + "output" : { + "shape" : "GetRoutesResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Routes for an API.

" + }, + "GetStage" : { + "name" : "GetStage", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetStageRequest" + }, + "output" : { + "shape" : "GetStageResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + } ], + "documentation" : "

Gets a Stage.

" + }, + "GetStages" : { + "name" : "GetStages", + "http" : { + "method" : "GET", + "requestUri" : "/v2/apis/{apiId}/stages", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetStagesRequest" + }, + "output" : { + "shape" : "GetStagesResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + } ], + "documentation" : "

Gets the Stages for an API.

" + }, + "GetTags" : { + "name" : "GetTags", + "http" : { + "method" : "GET", + "requestUri" : "/v2/tags/{resource-arn}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetTagsRequest" + }, + "output" : { + "shape" : "GetTagsResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Gets the Tags for an API.

" + }, + "TagResource" : { + "name" : "TagResource", + "http" : { + "method" : "POST", + "requestUri" : "/v2/tags/{resource-arn}", + "responseCode" : 201 + }, + "input" : { + "shape" : "TagResourceRequest" + }, + "output" : { + "shape" : "TagResourceResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Tag an APIGW resource

" + }, + "UntagResource" : { + "name" : "UntagResource", + "http" : { + "method" : "DELETE", + "requestUri" : "/v2/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "UntagResourceRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Untag an APIGW resource

" + }, + "UpdateApi" : { + "name" : "UpdateApi", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateApiRequest" + }, + "output" : { + "shape" : "UpdateApiResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates an Api resource.

" + }, + "UpdateApiMapping" : { + "name" : "UpdateApiMapping", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/domainnames/{domainName}/apimappings/{apiMappingId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateApiMappingRequest" + }, + "output" : { + "shape" : "UpdateApiMappingResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

The API mapping.

" + }, + "UpdateAuthorizer" : { + "name" : "UpdateAuthorizer", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/authorizers/{authorizerId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateAuthorizerRequest" + }, + "output" : { + "shape" : "UpdateAuthorizerResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates an Authorizer.

" + }, + "UpdateDeployment" : { + "name" : "UpdateDeployment", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/deployments/{deploymentId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDeploymentRequest" + }, + "output" : { + "shape" : "UpdateDeploymentResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a Deployment.

" + }, + "UpdateDomainName" : { + "name" : "UpdateDomainName", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/domainnames/{domainName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDomainNameRequest" + }, + "output" : { + "shape" : "UpdateDomainNameResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a domain name.

" + }, + "UpdateIntegration" : { + "name" : "UpdateIntegration", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateIntegrationRequest" + }, + "output" : { + "shape" : "UpdateIntegrationResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates an Integration.

" + }, + "UpdateIntegrationResponse" : { + "name" : "UpdateIntegrationResponse", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/integrations/{integrationId}/integrationresponses/{integrationResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateIntegrationResponseRequest" + }, + "output" : { + "shape" : "UpdateIntegrationResponseResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates an IntegrationResponses.

" + }, + "UpdateModel" : { + "name" : "UpdateModel", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/models/{modelId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateModelRequest" + }, + "output" : { + "shape" : "UpdateModelResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a Model.

" + }, + "UpdateRoute" : { + "name" : "UpdateRoute", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateRouteRequest" + }, + "output" : { + "shape" : "UpdateRouteResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a Route.

" + }, + "UpdateRouteResponse" : { + "name" : "UpdateRouteResponse", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/routes/{routeId}/routeresponses/{routeResponseId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateRouteResponseRequest" + }, + "output" : { + "shape" : "UpdateRouteResponseResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a RouteResponse.

" + }, + "UpdateStage" : { + "name" : "UpdateStage", + "http" : { + "method" : "PATCH", + "requestUri" : "/v2/apis/{apiId}/stages/{stageName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateStageRequest" + }, + "output" : { + "shape" : "UpdateStageResponse", + "documentation" : "

Success

" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

The resource specified in the request was not found.

" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

The client is sending more than the allowed number of requests per unit of\n time.

" + }, { + "shape" : "BadRequestException", + "documentation" : "

One of the parameters in the request is invalid.

" + }, { + "shape" : "ConflictException", + "documentation" : "

The resource already exists.

" + } ], + "documentation" : "

Updates a Stage.

" + } + }, + "shapes" : { + "AccessLogSettings" : { + "type" : "structure", + "members" : { + "DestinationArn" : { + "shape" : "Arn", + "locationName" : "destinationArn", + "documentation" : "

The ARN of the CloudWatch Logs log group to receive access logs.

" + }, + "Format" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "format", + "documentation" : "

A single line format of the access logs of data, as specified by selected $context\n variables. The format must include at least $context.requestId.

" + } + }, + "documentation" : "

Settings for logging access in a stage.

" + }, + "Api" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.

" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API ID.

" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the API was created.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "

The warning messages reported when failonwarnings is turned on during\n API import.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents an API.

", + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "ApiMapping" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + }, + "documentation" : "

Represents an API mapping.

", + "required" : [ "Stage", "ApiId" ] + }, + "ApiMappings" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApiMapping", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of ApiMappings resources.

" + }, + "Apis" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApi", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of APIs.

" + }, + "Arn" : { + "type" : "string", + "documentation" : "

Represents an Amazon Resource Name (ARN).

" + }, + "AuthorizationScopes" : { + "type" : "list", + "documentation" : "

A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.

", + "member" : { + "shape" : "StringWithLengthBetween1And64" + } + }, + "AuthorizationType" : { + "type" : "string", + "documentation" : "

The authorization type. Valid values are NONE for open access,\n AWS_IAM for using AWS IAM permissions, and CUSTOM for\n using a Lambda authorizer.

", + "enum" : [ "NONE", "AWS_IAM", "CUSTOM" ] + }, + "Authorizer" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + }, + "documentation" : "

Represents an authorizer.

", + "required" : [ "Name" ] + }, + "AuthorizerType" : { + "type" : "string", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

", + "enum" : [ "REQUEST" ] + }, + "Authorizers" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfAuthorizer", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of authorizers.

" + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

Describes the error encountered.

" + } + }, + "documentation" : "

The request is not valid, for example, the input is incomplete or incorrect. See\n the accompanying error message for details.

", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "ConflictException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

Describes the error encountered.

" + } + }, + "documentation" : "

The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request. See the accompanying error message for details.

", + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "ConnectionType" : { + "type" : "string", + "documentation" : "

Represents a connection type.

", + "enum" : [ "INTERNET", "VPC_LINK" ] + }, + "ContentHandlingStrategy" : { + "type" : "string", + "documentation" : "

Specifies how to handle response payload content type conversions.

", + "enum" : [ "CONVERT_TO_BINARY", "CONVERT_TO_TEXT" ] + }, + "CreateApiInput" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents the input parameters for a CreateApi request.

", + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "CreateApiMappingInput" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateApiMapping\n request.

", + "required" : [ "Stage", "ApiId" ] + }, + "CreateApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + }, + "required" : [ "DomainName", "Stage", "ApiId" ] + }, + "CreateApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + } + }, + "CreateApiRequest" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + }, + "required" : [ "RouteSelectionExpression", "ProtocolType", "Name" ] + }, + "CreateApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.

" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API ID.

" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the API was created.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "

The warning messages reported when failonwarnings is turned on during\n API import.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "CreateAuthorizerInput" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateAuthorizer\n request.

", + "required" : [ "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ] + }, + "CreateAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + }, + "required" : [ "ApiId", "AuthorizerUri", "AuthorizerType", "IdentitySource", "Name" ] + }, + "CreateAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + } + }, + "CreateDeploymentInput" : { + "type" : "structure", + "members" : { + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment resource.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the Stage resource for the Deployment\n resource to create.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateDeployment\n request.

" + }, + "CreateDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment resource.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the Stage resource for the Deployment\n resource to create.

" + } + }, + "required" : [ "ApiId" ] + }, + "CreateDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The date and time when the Deployment resource was created.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier for the deployment.

" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "

The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.

" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "

May contain additional feedback on the status of an API deployment.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment.

" + } + } + }, + "CreateDomainNameInput" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents the input parameters for a CreateDomainName\n request.

", + "required" : [ "DomainName" ] + }, + "CreateDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + }, + "required" : [ "DomainName" ] + }, + "CreateDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "

The API mapping selection expression.

" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The name of the DomainName resource.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "CreateIntegrationInput" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateIntegration\n request.

", + "required" : [ "IntegrationType" ] + }, + "CreateIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + }, + "required" : [ "ApiId", "IntegrationType" ] + }, + "CreateIntegrationResponse" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

Represents the description of an integration.

" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "

Represents the identifier of an integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "

The integration response selection expression for the integration. See Integration Response Selection Expressions.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + } + }, + "CreateIntegrationResponseInput" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name},\n where {name} is a valid and unique header name. The mapped non-static\n value must match the pattern of integration.response.header.{name} or\n integration.response.body.{JSON-expression}, where\n {name} is a valid and unique response header name and\n {JSON-expression} is a valid JSON expression without the $\n prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration response.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateIntegrationResponse\n request.

", + "required" : [ "IntegrationResponseKey" ] + }, + "CreateIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name},\n where {name} is a valid and unique header name. The mapped non-static\n value must match the pattern of integration.response.header.{name} or\n integration.response.body.{JSON-expression}, where\n {name} is a valid and unique response header name and\n {JSON-expression} is a valid JSON expression without the $\n prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration response.

" + } + }, + "required" : [ "ApiId", "IntegrationId", "IntegrationResponseKey" ] + }, + "CreateIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "

The integration response ID.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expressions for the integration response.

" + } + } + }, + "CreateModelInput" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateModel request.

", + "required" : [ "Schema", "Name" ] + }, + "CreateModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + }, + "required" : [ "ApiId", "Schema", "Name" ] + }, + "CreateModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "

The model identifier.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + } + }, + "CreateRouteInput" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for the route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

The authorization scopes supported by this\n route.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + }, + "documentation" : "

Represents the input parameters for a CreateRoute request.

", + "required" : [ "RouteKey" ] + }, + "CreateRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for the route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

The authorization scopes supported by this\n route.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + }, + "required" : [ "ApiId", "RouteKey" ] + }, + "CreateRouteResponse" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for this route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + } + }, + "CreateRouteResponseInput" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

The response models for the route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

The route response parameters.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

The route response key.

" + } + }, + "documentation" : "

Represents the input parameters for an CreateRouteResponse\n request.

", + "required" : [ "RouteResponseKey" ] + }, + "CreateRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

The response models for the route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

The route response parameters.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

The route response key.

" + } + }, + "required" : [ "ApiId", "RouteId", "RouteResponseKey" ] + }, + "CreateRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

Represents the model selection expression of a route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

Represents the response models of a route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

Represents the response parameters of a route response.

" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "

Represents the identifier of a route response.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

Represents the route response key of a route response.

" + } + } + }, + "CreateStageInput" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

The default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The deployment identifier of the API stage.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the API stage.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents the input parameters for a CreateStage request.

", + "required" : [ "StageName" ] + }, + "CreateStageRequest" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

The default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The deployment identifier of the API stage.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the API stage.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + }, + "required" : [ "ApiId", "StageName" ] + }, + "CreateStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the stage was created.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

Default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier of the Deployment that the Stage is\n associated with.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the stage.

" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "

The timestamp when the stage was last updated.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "DeleteApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + } + }, + "required" : [ "ApiMappingId", "DomainName" ] + }, + "DeleteApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + } + }, + "required" : [ "ApiId" ] + }, + "DeleteAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "DeleteDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "

The deployment ID.

" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "DeleteDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + } + }, + "required" : [ "DomainName" ] + }, + "DeleteIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "DeleteIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation" : "

The integration response ID.

" + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "DeleteModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "

The model ID.

" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "DeleteRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "DeleteRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "

The route response ID.

" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "DeleteStageRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "

The stage name.

" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "Deployment" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The date and time when the Deployment resource was created.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier for the deployment.

" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "

The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.

" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "

May contain additional feedback on the status of an API deployment.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment.

" + } + }, + "documentation" : "

An immutable representation of an API that can be called by users. A\n Deployment must be associated with a Stage for it to be\n callable over the internet.

" + }, + "DeploymentStatus" : { + "type" : "string", + "documentation" : "

Represents a deployment status.

", + "enum" : [ "PENDING", "FAILED", "DEPLOYED" ] + }, + "Deployments" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDeployment", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

A collection resource that contains zero or more references to your existing\n deployments, and links that guide you on how to interact with your collection. The\n collection offers a paginated view of the contained deployments.

" + }, + "DomainName" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "

The API mapping selection expression.

" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The name of the DomainName resource.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents a domain name.

", + "required" : [ "DomainName" ] + }, + "DomainNameConfiguration" : { + "type" : "structure", + "members" : { + "ApiGatewayDomainName" : { + "shape" : "__string", + "locationName" : "apiGatewayDomainName", + "documentation" : "

A domain name for the WebSocket API.

" + }, + "CertificateArn" : { + "shape" : "Arn", + "locationName" : "certificateArn", + "documentation" : "

An AWS-managed certificate that will be used by the edge-optimized endpoint for\n this domain name. AWS Certificate Manager is the only supported source.

" + }, + "CertificateName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "certificateName", + "documentation" : "

The user-friendly name of the certificate that will be used by the edge-optimized\n endpoint for this domain name.

" + }, + "CertificateUploadDate" : { + "shape" : "__timestampIso8601", + "locationName" : "certificateUploadDate", + "documentation" : "

The timestamp when the certificate that was used by edge-optimized endpoint for\n this domain name was uploaded.

" + }, + "EndpointType" : { + "shape" : "EndpointType", + "locationName" : "endpointType", + "documentation" : "

The endpoint type.

" + }, + "HostedZoneId" : { + "shape" : "__string", + "locationName" : "hostedZoneId", + "documentation" : "

The Amazon Route 53 Hosted Zone ID of the endpoint.

" + }, + "SecurityPolicy" : { + "shape" : "SecurityPolicy", + "locationName" : "securityPolicy", + "documentation" : "

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

" + }, + "DomainNameStatus" : { + "shape" : "DomainNameStatus", + "locationName" : "domainNameStatus", + "documentation" : "

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

" + }, + "DomainNameStatusMessage" : { + "shape" : "__string", + "locationName" : "domainNameStatusMessage", + "documentation" : "

An optional text message containing detailed information about status of the domain name migration.

" + } + }, + "documentation" : "

The domain name configuration.

" + }, + "DomainNameConfigurations" : { + "type" : "list", + "documentation" : "

The domain name configurations.

", + "member" : { + "shape" : "DomainNameConfiguration" + } + }, + "DomainNames" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDomainName", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of domain names.

" + }, + "EndpointType" : { + "type" : "string", + "documentation" : "

Represents an endpoint type.

", + "enum" : [ "REGIONAL", "EDGE" ] + }, + "SecurityPolicy" : { + "type" : "string", + "documentation" : "

The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.

", + "enum" : [ "TLS_1_0", "TLS_1_2" ] + }, + "DomainNameStatus" : { + "type" : "string", + "documentation" : "

The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

", + "enum" : [ "AVAILABLE", "UPDATING"] + }, + "GetApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + } + }, + "required" : [ "ApiMappingId", "DomainName" ] + }, + "GetApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + } + }, + "GetApiMappingsRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "DomainName" ] + }, + "GetApiMappingsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApiMapping", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.

" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API ID.

" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the API was created.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "

The warning messages reported when failonwarnings is turned on during\n API import.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "GetApisRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetApisResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfApi", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "GetAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + } + }, + "GetAuthorizersRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetAuthorizersResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfAuthorizer", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "

The deployment ID.

" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "GetDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The date and time when the Deployment resource was created.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier for the deployment.

" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "

The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.

" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "

May contain additional feedback on the status of an API deployment.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment.

" + } + } + }, + "GetDeploymentsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetDeploymentsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDeployment", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + } + }, + "required" : [ "DomainName" ] + }, + "GetDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "

The API mapping selection expression.

" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The name of the DomainName resource.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "GetDomainNamesRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetDomainNamesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfDomainName", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "GetIntegrationResponse" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

Represents the description of an integration.

" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "

Represents the identifier of an integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "

The integration response selection expression for the integration. See Integration Response Selection Expressions.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + } + }, + "GetIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID." + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "GetIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "

The integration response ID.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expressions for the integration response.

" + } + } + }, + "GetIntegrationResponsesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "IntegrationId", "ApiId" ] + }, + "GetIntegrationResponsesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegrationResponse", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetIntegrationsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetIntegrationsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegration", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "

The model ID.

" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "GetModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "

The model identifier.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + } + }, + "GetModelTemplateRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "

The model ID.

" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "GetModelTemplateResponse" : { + "type" : "structure", + "members" : { + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "

The template value.

" + } + } + }, + "GetModelsRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetModelsResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfModel", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "GetRouteResponse" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for this route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + } + }, + "GetRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "

The route response ID.

" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "GetRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

Represents the model selection expression of a route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

Represents the response models of a route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

Represents the response parameters of a route response.

" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "

Represents the identifier of a route response.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

Represents the route response key of a route response.

" + } + } + }, + "GetRouteResponsesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + } + }, + "required" : [ "RouteId", "ApiId" ] + }, + "GetRouteResponsesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRouteResponse", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetRoutesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetRoutesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRoute", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "GetStageRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "

The stage name.

" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "GetStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the stage was created.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

Default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier of the Deployment that the Stage is\n associated with.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the stage.

" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "

The timestamp when the stage was last updated.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "GetStagesRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of elements to be returned for this resource.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "required" : [ "ApiId" ] + }, + "GetStagesResponse" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfStage", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + } + }, + "Id" : { + "type" : "string", + "documentation" : "

The identifier.

" + }, + "IdentitySourceList" : { + "type" : "list", + "documentation" : "

The identity source for which authorization is requested. For the REQUEST\n authorizer, this is required when authorization caching is enabled. The value is a\n comma-separated string of one or more mapping expressions of the specified request\n parameters. For example, if an Auth header, a Name query string parameter are defined\n as identity sources, this value is $method.request.header.Auth,\n $method.request.querystring.Name. These parameters will be used to derive\n the authorization caching key and to perform runtime validation of the REQUEST\n authorizer by verifying all of the identity-related request parameters are present,\n not null and non-empty. Only when this is true does the authorizer invoke the\n authorizer Lambda function, otherwise, it returns a 401 Unauthorized\n response without calling the Lambda function. The valid value is a string of\n comma-separated mapping expressions of the specified request parameters. When the\n authorization caching is not enabled, this property is optional.

", + "member" : { + "shape" : "__string" + } + }, + "IntegerWithLengthBetween0And3600" : { + "type" : "integer", + "documentation" : "

An integer with a value between [0-3600].

", + "min" : -2147483648, + "max" : 2147483647 + }, + "IntegerWithLengthBetween50And29000" : { + "type" : "integer", + "documentation" : "

An integer with a value between [50-29000].

", + "min" : -2147483648, + "max" : 2147483647 + }, + "Integration" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

Represents the description of an integration.

" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "

Represents the identifier of an integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "

The integration response selection expression for the integration. See Integration Response Selection Expressions.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + }, + "documentation" : "

Represents an integration.

" + }, + "IntegrationParameters" : { + "type" : "map", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween1And512" + } + }, + "IntegrationResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "

The integration response ID.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expressions for the integration response.

" + } + }, + "documentation" : "

Represents an integration response.

", + "required" : [ "IntegrationResponseKey" ] + }, + "IntegrationResponses" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegrationResponse", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of integration responses.

" + }, + "IntegrationType" : { + "type" : "string", + "documentation" : "

Represents an API method integration type.

", + "enum" : [ "AWS", "HTTP", "MOCK", "HTTP_PROXY", "AWS_PROXY" ] + }, + "Integrations" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfIntegration", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of integrations.

" + }, + "LimitExceededException" : { + "type" : "structure", + "members" : { + "LimitType" : { + "shape" : "__string", + "locationName" : "limitType", + "documentation" : "

The limit type.

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

Describes the error encountered.

" + } + }, + "documentation" : "

A limit has been exceeded. See the accompanying error message for details.

" + }, + "GetTagsRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn" + } + }, + "required" : [ "ResourceArn" ] + }, + "GetTagsResponse" : { + "type" : "structure", + "members" : { + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags" + } + } + }, + "LoggingLevel" : { + "type" : "string", + "documentation" : "

The logging level.

", + "enum" : [ "ERROR", "INFO", "false" ] + }, + "Model" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "

The model identifier.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + }, + "documentation" : "

Represents a data model for an API. See Create Models and Mapping Templates for Request and Response\n Mappings.

", + "required" : [ "Name" ] + }, + "Models" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfModel", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of data models. See Create Models and Mapping Templates for Request and Response\n Mappings.

" + }, + "NextToken" : { + "type" : "string", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + }, + "NotFoundException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

Describes the error encountered.

" + }, + "ResourceType" : { + "shape" : "__string", + "locationName" : "resourceType", + "documentation" : "

The resource type.

" + } + }, + "documentation" : "

The resource specified in the request was not found. See the message\n field for more information.

", + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "ParameterConstraints" : { + "type" : "structure", + "members" : { + "Required" : { + "shape" : "__boolean", + "locationName" : "required", + "documentation" : "

Whether or not the parameter is required.

" + } + }, + "documentation" : "

Validation constraints imposed on parameters of a request (path, query string,\n headers).

" + }, + "PassthroughBehavior" : { + "type" : "string", + "documentation" : "

Represents passthrough behavior for an integration response.

", + "enum" : [ "WHEN_NO_MATCH", "NEVER", "WHEN_NO_TEMPLATES" ] + }, + "ProtocolType" : { + "type" : "string", + "documentation" : "", + "enum" : [ "WEBSOCKET" ] + }, + "ProviderArnList" : { + "type" : "list", + "documentation" : "

For REQUEST authorizer, this is not defined.

", + "member" : { + "shape" : "Arn" + } + }, + "Route" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for this route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + }, + "documentation" : "

Represents a route.

", + "required" : [ "RouteKey" ] + }, + "RouteModels" : { + "type" : "map", + "documentation" : "

The route models.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween1And128" + } + }, + "RouteParameters" : { + "type" : "map", + "documentation" : "

The route parameters.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "ParameterConstraints" + } + }, + "RouteResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

Represents the model selection expression of a route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

Represents the response models of a route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

Represents the response parameters of a route response.

" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "

Represents the identifier of a route response.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

Represents the route response key of a route response.

" + } + }, + "documentation" : "

Represents a route response.

", + "required" : [ "RouteResponseKey" ] + }, + "RouteResponses" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRouteResponse", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of route responses.

" + }, + "RouteSettings" : { + "type" : "structure", + "members" : { + "DataTraceEnabled" : { + "shape" : "__boolean", + "locationName" : "dataTraceEnabled", + "documentation" : "

Specifies whether (true) or not (false) data trace\n logging is enabled for this route. This property affects the log entries pushed to\n Amazon CloudWatch Logs.

" + }, + "DetailedMetricsEnabled" : { + "shape" : "__boolean", + "locationName" : "detailedMetricsEnabled", + "documentation" : "

Specifies whether detailed metrics are enabled.

" + }, + "LoggingLevel" : { + "shape" : "LoggingLevel", + "locationName" : "loggingLevel", + "documentation" : "

Specifies the logging level for this route: DEBUG, INFO,\n or WARN. This property affects the log entries pushed to Amazon\n CloudWatch Logs.

" + }, + "ThrottlingBurstLimit" : { + "shape" : "__integer", + "locationName" : "throttlingBurstLimit", + "documentation" : "

Specifies the throttling burst limit.

" + }, + "ThrottlingRateLimit" : { + "shape" : "__double", + "locationName" : "throttlingRateLimit", + "documentation" : "

Specifies the throttling rate limit.

" + } + }, + "documentation" : "

Represents a collection of route settings.

" + }, + "RouteSettingsMap" : { + "type" : "map", + "documentation" : "

The route settings map.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "RouteSettings" + } + }, + "Routes" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfRoute", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

Represents a collection of routes.

" + }, + "SelectionExpression" : { + "type" : "string", + "documentation" : "

An expression used to extract information at runtime. See Selection Expressions for more information.

" + }, + "SelectionKey" : { + "type" : "string", + "documentation" : "

After evaulating a selection expression, the result is compared against one or\n more selection keys to find a matching key. See Selection Expressions for a list of expressions and each expression's\n associated selection key type.

" + }, + "Stage" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the stage was created.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

Default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier of the Deployment that the Stage is\n associated with.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the stage.

" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "

The timestamp when the stage was last updated.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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" : "

Represents an API stage.

", + "required" : [ "StageName" ] + }, + "StageVariablesMap" : { + "type" : "map", + "documentation" : "

The stage variable map.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween0And2048" + } + }, + "Stages" : { + "type" : "structure", + "members" : { + "Items" : { + "shape" : "__listOfStage", + "locationName" : "items", + "documentation" : "

The elements from this collection.

" + }, + "NextToken" : { + "shape" : "NextToken", + "locationName" : "nextToken", + "documentation" : "

The next page of elements from this collection. Not valid for the last element of\n the collection.

" + } + }, + "documentation" : "

A collection of Stage resources that are associated with the ApiKey\n resource.

" + }, + "StringWithLengthBetween0And1024" : { + "type" : "string", + "documentation" : "

A string with a length between [0-1024].

" + }, + "StringWithLengthBetween0And2048" : { + "type" : "string", + "documentation" : "

A string with a length between [0-2048].

" + }, + "StringWithLengthBetween0And32K" : { + "type" : "string", + "documentation" : "

A string with a length between [0-32768].

" + }, + "StringWithLengthBetween1And1024" : { + "type" : "string", + "documentation" : "

A string with a length between [1-1024].

" + }, + "StringWithLengthBetween1And128" : { + "type" : "string", + "documentation" : "

A string with a length between [1-128].

" + }, + "StringWithLengthBetween1And256" : { + "type" : "string", + "documentation" : "

A string with a length between [1-256].

" + }, + "StringWithLengthBetween1And512" : { + "type" : "string", + "documentation" : "

A string with a length between [1-512].

" + }, + "StringWithLengthBetween1And64" : { + "type" : "string", + "documentation" : "

A string with a length between [1-64].

" + }, + "StringWithLengthBetween1And1600" : { + "type" : "string", + "documentation" : "

A string with a length between [1-1600].

" + }, + "TagResourceInput" : { + "type" : "structure", + "members" : { + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "TagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "

AWS resource arn

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + }, + "required" : [ "ResourceArn" ] + }, + "TagResourceResponse" : { + "type" : "structure", + "members" : { } + }, + "Tags" : { + "type" : "map", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween1And1600" + } + }, + "UntagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "

AWS resource arn

" + }, + "TagKeys" : { + "shape" : "__listOf__string", + "location" : "querystring", + "locationName" : "tagKeys", + "documentation" : "

The Tag keys to delete

" + } + }, + "required" : [ "TagKeys", "ResourceArn" ] + }, + "Template" : { + "type" : "structure", + "members" : { + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "

The template value.

" + } + }, + "documentation" : "

Represents a template.

" + }, + "TemplateMap" : { + "type" : "map", + "documentation" : "

A mapping of identifier keys to templates. The value is an actual template script.\n The key is typically a SelectionKey which is chosen based on evaluating\n a selection expression.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "StringWithLengthBetween0And32K" + } + }, + "TooManyRequestsException" : { + "type" : "structure", + "members" : { + "LimitType" : { + "shape" : "__string", + "locationName" : "limitType", + "documentation" : "

The limit type.

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

Describes the error encountered.

" + } + }, + "documentation" : "

A limit has been exceeded. See the accompanying error message for details.

", + "exception" : true, + "error" : { + "httpStatusCode" : 429 + } + }, + "UpdateApiInput" : { + "type" : "structure", + "members" : { + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateApi request.

" + }, + "UpdateApiMappingInput" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateApiMapping\n request.

" + }, + "UpdateApiMappingRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + }, + "required" : [ "ApiMappingId", "ApiId", "DomainName" ] + }, + "UpdateApiMappingResponse" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiMappingId" : { + "shape" : "Id", + "locationName" : "apiMappingId", + "documentation" : "

The API mapping identifier.

" + }, + "ApiMappingKey" : { + "shape" : "SelectionKey", + "locationName" : "apiMappingKey", + "documentation" : "

The API mapping key.

" + }, + "Stage" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stage", + "documentation" : "

The API stage.

" + } + } + }, + "UpdateApiRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + } + }, + "required" : [ "ApiId" ] + }, + "UpdateApiResponse" : { + "type" : "structure", + "members" : { + "ApiEndpoint" : { + "shape" : "__string", + "locationName" : "apiEndpoint", + "documentation" : "

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.

" + }, + "ApiId" : { + "shape" : "Id", + "locationName" : "apiId", + "documentation" : "

The API ID.

" + }, + "ApiKeySelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiKeySelectionExpression", + "documentation" : "

An API key selection expression. See API Key Selection Expressions.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the API was created.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the API.

" + }, + "DisableSchemaValidation" : { + "shape" : "__boolean", + "locationName" : "disableSchemaValidation", + "documentation" : "

Avoid validating models when creating a deployment.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the API.

" + }, + "ProtocolType" : { + "shape" : "ProtocolType", + "locationName" : "protocolType", + "documentation" : "

The API protocol: Currently only WEBSOCKET is supported.

" + }, + "RouteSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeSelectionExpression", + "documentation" : "

The route selection expression for the API.

" + }, + "Version" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "version", + "documentation" : "

A version identifier for the API.

" + }, + "Warnings" : { + "shape" : "__listOf__string", + "locationName" : "warnings", + "documentation" : "

The warning messages reported when failonwarnings is turned on during\n API import.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "UpdateAuthorizerInput" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it is zero,\n authorization caching is disabled. If it is greater than zero, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth header, a\n Name query string parameter are defined as identity sources, this value is\n $method.request.header.Auth, $method.request.querystring.Name. These\n parameters will be used to derive the authorization caching key and to perform\n runtime validation of the REQUEST authorizer by verifying all of the\n identity-related request parameters are present, not null and non-empty. Only when\n this is true does the authorizer invoke the authorizer Lambda function, otherwise, it\n returns a 401 Unauthorized response without calling the Lambda function.\n The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + }, + "documentation" : "

The input parameters for an UpdateAuthorizer request.

" + }, + "UpdateAuthorizerRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it is zero,\n authorization caching is disabled. If it is greater than zero, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth header, a\n Name query string parameter are defined as identity sources, this value is\n $method.request.header.Auth, $method.request.querystring.Name. These\n parameters will be used to derive the authorization caching key and to perform\n runtime validation of the REQUEST authorizer by verifying all of the\n identity-related request parameters are present, not null and non-empty. Only when\n this is true does the authorizer invoke the authorizer Lambda function, otherwise, it\n returns a 401 Unauthorized response without calling the Lambda function.\n The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + }, + "required" : [ "AuthorizerId", "ApiId" ] + }, + "UpdateAuthorizerResponse" : { + "type" : "structure", + "members" : { + "AuthorizerCredentialsArn" : { + "shape" : "Arn", + "locationName" : "authorizerCredentialsArn", + "documentation" : "

Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The authorizer identifier.

" + }, + "AuthorizerResultTtlInSeconds" : { + "shape" : "IntegerWithLengthBetween0And3600", + "locationName" : "authorizerResultTtlInSeconds", + "documentation" : "

The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.

" + }, + "AuthorizerType" : { + "shape" : "AuthorizerType", + "locationName" : "authorizerType", + "documentation" : "

The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.

" + }, + "AuthorizerUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "authorizerUri", + "documentation" : "

The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n 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.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.

" + }, + "IdentitySource" : { + "shape" : "IdentitySourceList", + "locationName" : "identitySource", + "documentation" : "

The identity source for which authorization is requested.

For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.

" + }, + "IdentityValidationExpression" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "identityValidationExpression", + "documentation" : "

The\n validation expression does not apply to the REQUEST authorizer.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the authorizer.

" + }, + "ProviderArns" : { + "shape" : "ProviderArnList", + "locationName" : "providerArns", + "documentation" : "

For\n REQUEST authorizer, this is not\n defined.

" + } + } + }, + "UpdateDeploymentInput" : { + "type" : "structure", + "members" : { + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment resource.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateDeployment\n request.

" + }, + "UpdateDeploymentRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deploymentId", + "documentation" : "

The deployment ID.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment resource.

" + } + }, + "required" : [ "ApiId", "DeploymentId" ] + }, + "UpdateDeploymentResponse" : { + "type" : "structure", + "members" : { + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The date and time when the Deployment resource was created.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier for the deployment.

" + }, + "DeploymentStatus" : { + "shape" : "DeploymentStatus", + "locationName" : "deploymentStatus", + "documentation" : "

The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.

" + }, + "DeploymentStatusMessage" : { + "shape" : "__string", + "locationName" : "deploymentStatusMessage", + "documentation" : "

May contain additional feedback on the status of an API deployment.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the deployment.

" + } + } + }, + "UpdateDomainNameInput" : { + "type" : "structure", + "members" : { + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateDomainName\n request.

" + }, + "UpdateDomainNameRequest" : { + "type" : "structure", + "members" : { + "DomainName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "domainName", + "documentation" : "

The domain name.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + } + }, + "required" : [ "DomainName" ] + }, + "UpdateDomainNameResponse" : { + "type" : "structure", + "members" : { + "ApiMappingSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "apiMappingSelectionExpression", + "documentation" : "

The API mapping selection expression.

" + }, + "DomainName" : { + "shape" : "StringWithLengthBetween1And512", + "locationName" : "domainName", + "documentation" : "

The name of the DomainName resource.

" + }, + "DomainNameConfigurations" : { + "shape" : "DomainNameConfigurations", + "locationName" : "domainNameConfigurations", + "documentation" : "

The domain name configurations.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "UpdateIntegrationInput" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the integration

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateIntegration\n request.

" + }, + "UpdateIntegrationRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the integration

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + }, + "required" : [ "ApiId", "IntegrationId" ] + }, + "UpdateIntegrationResponse" : { + "type" : "structure", + "members" : { + "ConnectionId" : { + "shape" : "StringWithLengthBetween1And1024", + "locationName" : "connectionId", + "documentation" : "

The connection ID.

" + }, + "ConnectionType" : { + "shape" : "ConnectionType", + "locationName" : "connectionType", + "documentation" : "

The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "CredentialsArn" : { + "shape" : "Arn", + "locationName" : "credentialsArn", + "documentation" : "

Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

Represents the description of an integration.

" + }, + "IntegrationId" : { + "shape" : "Id", + "locationName" : "integrationId", + "documentation" : "

Represents the identifier of an integration.

" + }, + "IntegrationMethod" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "integrationMethod", + "documentation" : "

Specifies the integration's HTTP method type.

" + }, + "IntegrationResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "integrationResponseSelectionExpression", + "documentation" : "

The integration response selection expression for the integration. See Integration Response Selection Expressions.

" + }, + "IntegrationType" : { + "shape" : "IntegrationType", + "locationName" : "integrationType", + "documentation" : "

The integration type of an integration. One of the following:

\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.

\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.

\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.

\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.

\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.

" + }, + "IntegrationUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "integrationUri", + "documentation" : "

For a Lambda proxy integration, this is the URI of the Lambda function.

" + }, + "PassthroughBehavior" : { + "shape" : "PassthroughBehavior", + "locationName" : "passthroughBehavior", + "documentation" : "

Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.

\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.

\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.

\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.

" + }, + "RequestParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "requestParameters", + "documentation" : "

A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.

" + }, + "RequestTemplates" : { + "shape" : "TemplateMap", + "locationName" : "requestTemplates", + "documentation" : "

Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration.

" + }, + "TimeoutInMillis" : { + "shape" : "IntegerWithLengthBetween50And29000", + "locationName" : "timeoutInMillis", + "documentation" : "

Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.

" + } + } + }, + "UpdateIntegrationResponseInput" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of\n method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value\n must match the pattern of\n integration.response.header.{name}\n or\n integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration response.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateIntegrationResponse\n request.

" + }, + "UpdateIntegrationResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationId", + "documentation" : "

The integration ID.

" + }, + "IntegrationResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "integrationResponseId", + "documentation" : "The integration response ID." + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of\n method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value\n must match the pattern of\n integration.response.header.{name}\n or\n integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expression for the integration response.

" + } + }, + "required" : [ "ApiId", "IntegrationResponseId", "IntegrationId" ] + }, + "UpdateIntegrationResponseResponse" : { + "type" : "structure", + "members" : { + "ContentHandlingStrategy" : { + "shape" : "ContentHandlingStrategy", + "locationName" : "contentHandlingStrategy", + "documentation" : "

Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:

\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.

\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.

If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.

" + }, + "IntegrationResponseId" : { + "shape" : "Id", + "locationName" : "integrationResponseId", + "documentation" : "

The integration response ID.

" + }, + "IntegrationResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "integrationResponseKey", + "documentation" : "

The integration response key.

" + }, + "ResponseParameters" : { + "shape" : "IntegrationParameters", + "locationName" : "responseParameters", + "documentation" : "

A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.

" + }, + "ResponseTemplates" : { + "shape" : "TemplateMap", + "locationName" : "responseTemplates", + "documentation" : "

The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.

" + }, + "TemplateSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "templateSelectionExpression", + "documentation" : "

The template selection expressions for the integration response.

" + } + } + }, + "UpdateModelInput" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateModel request.

" + }, + "UpdateModelRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "ModelId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "modelId", + "documentation" : "

The model ID.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + }, + "required" : [ "ModelId", "ApiId" ] + }, + "UpdateModelResponse" : { + "type" : "structure", + "members" : { + "ContentType" : { + "shape" : "StringWithLengthBetween1And256", + "locationName" : "contentType", + "documentation" : "

The content-type for the model, for example, \"application/json\".

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the model.

" + }, + "ModelId" : { + "shape" : "Id", + "locationName" : "modelId", + "documentation" : "

The model identifier.

" + }, + "Name" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "name", + "documentation" : "

The name of the model. Must be alphanumeric.

" + }, + "Schema" : { + "shape" : "StringWithLengthBetween0And32K", + "locationName" : "schema", + "documentation" : "

The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.

" + } + } + }, + "UpdateRouteInput" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for the route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

The authorization scopes supported by this\n route.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateRoute request.

" + }, + "UpdateRouteRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for the route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

The authorization scopes supported by this\n route.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + }, + "required" : [ "ApiId", "RouteId" ] + }, + "UpdateRouteResponse" : { + "type" : "structure", + "members" : { + "ApiKeyRequired" : { + "shape" : "__boolean", + "locationName" : "apiKeyRequired", + "documentation" : "

Specifies whether an API key is required for this route.

" + }, + "AuthorizationScopes" : { + "shape" : "AuthorizationScopes", + "locationName" : "authorizationScopes", + "documentation" : "

A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.

" + }, + "AuthorizationType" : { + "shape" : "AuthorizationType", + "locationName" : "authorizationType", + "documentation" : "

The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer

" + }, + "AuthorizerId" : { + "shape" : "Id", + "locationName" : "authorizerId", + "documentation" : "

The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route.

" + }, + "OperationName" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "operationName", + "documentation" : "

The operation name for the route.

" + }, + "RequestModels" : { + "shape" : "RouteModels", + "locationName" : "requestModels", + "documentation" : "

The request models for the route.

" + }, + "RequestParameters" : { + "shape" : "RouteParameters", + "locationName" : "requestParameters", + "documentation" : "

The request parameters for the route.

" + }, + "RouteId" : { + "shape" : "Id", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteKey" : { + "shape" : "SelectionKey", + "locationName" : "routeKey", + "documentation" : "

The route key for the route.

" + }, + "RouteResponseSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "routeResponseSelectionExpression", + "documentation" : "

The route response selection expression for the route.

" + }, + "Target" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "target", + "documentation" : "

The target for the route.

" + } + } + }, + "UpdateRouteResponseInput" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

The response models for the route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

The route response parameters.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

The route response key.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateRouteResponse\n request.

" + }, + "UpdateRouteResponseRequest" : { + "type" : "structure", + "members" : { + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

The model selection expression for the route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

The response models for the route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

The route response parameters.

" + }, + "RouteId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeId", + "documentation" : "

The route ID.

" + }, + "RouteResponseId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "routeResponseId", + "documentation" : "

The route response ID.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

The route response key.

" + } + }, + "required" : [ "RouteResponseId", "ApiId", "RouteId" ] + }, + "UpdateRouteResponseResponse" : { + "type" : "structure", + "members" : { + "ModelSelectionExpression" : { + "shape" : "SelectionExpression", + "locationName" : "modelSelectionExpression", + "documentation" : "

Represents the model selection expression of a route response.

" + }, + "ResponseModels" : { + "shape" : "RouteModels", + "locationName" : "responseModels", + "documentation" : "

Represents the response models of a route response.

" + }, + "ResponseParameters" : { + "shape" : "RouteParameters", + "locationName" : "responseParameters", + "documentation" : "

Represents the response parameters of a route response.

" + }, + "RouteResponseId" : { + "shape" : "Id", + "locationName" : "routeResponseId", + "documentation" : "

Represents the identifier of a route response.

" + }, + "RouteResponseKey" : { + "shape" : "SelectionKey", + "locationName" : "routeResponseKey", + "documentation" : "

Represents the route response key of a route response.

" + } + } + }, + "UpdateStageInput" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

The default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The deployment identifier for the API stage.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the API stage.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + } + }, + "documentation" : "

Represents the input parameters for an UpdateStage request.

" + }, + "UpdateStageRequest" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ApiId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "apiId", + "documentation" : "

The API identifier.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

The default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The deployment identifier for the API stage.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description for the API stage.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "stageName", + "documentation" : "

The stage name.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + } + }, + "required" : [ "StageName", "ApiId" ] + }, + "UpdateStageResponse" : { + "type" : "structure", + "members" : { + "AccessLogSettings" : { + "shape" : "AccessLogSettings", + "locationName" : "accessLogSettings", + "documentation" : "

Settings for logging access in this stage.

" + }, + "ClientCertificateId" : { + "shape" : "Id", + "locationName" : "clientCertificateId", + "documentation" : "

The identifier of a client certificate for a Stage.

" + }, + "CreatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "createdDate", + "documentation" : "

The timestamp when the stage was created.

" + }, + "DefaultRouteSettings" : { + "shape" : "RouteSettings", + "locationName" : "defaultRouteSettings", + "documentation" : "

Default route settings for the stage.

" + }, + "DeploymentId" : { + "shape" : "Id", + "locationName" : "deploymentId", + "documentation" : "

The identifier of the Deployment that the Stage is\n associated with.

" + }, + "Description" : { + "shape" : "StringWithLengthBetween0And1024", + "locationName" : "description", + "documentation" : "

The description of the stage.

" + }, + "LastUpdatedDate" : { + "shape" : "__timestampIso8601", + "locationName" : "lastUpdatedDate", + "documentation" : "

The timestamp when the stage was last updated.

" + }, + "RouteSettings" : { + "shape" : "RouteSettingsMap", + "locationName" : "routeSettings", + "documentation" : "

Route settings for the stage.

" + }, + "StageName" : { + "shape" : "StringWithLengthBetween1And128", + "locationName" : "stageName", + "documentation" : "

The name of the stage.

" + }, + "StageVariables" : { + "shape" : "StageVariablesMap", + "locationName" : "stageVariables", + "documentation" : "

A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.

" + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "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..

" + } + } + }, + "UriWithLengthBetween1And2048" : { + "type" : "string", + "documentation" : "

A string representation of a URI with a length between [1-2048].

" + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__listOfApi" : { + "type" : "list", + "member" : { + "shape" : "Api" + } + }, + "__listOfApiMapping" : { + "type" : "list", + "member" : { + "shape" : "ApiMapping" + } + }, + "__listOfAuthorizer" : { + "type" : "list", + "member" : { + "shape" : "Authorizer" + } + }, + "__listOfDeployment" : { + "type" : "list", + "member" : { + "shape" : "Deployment" + } + }, + "__listOfDomainName" : { + "type" : "list", + "member" : { + "shape" : "DomainName" + } + }, + "__listOfIntegration" : { + "type" : "list", + "member" : { + "shape" : "Integration" + } + }, + "__listOfIntegrationResponse" : { + "type" : "list", + "member" : { + "shape" : "IntegrationResponse" + } + }, + "__listOfModel" : { + "type" : "list", + "member" : { + "shape" : "Model" + } + }, + "__listOfRoute" : { + "type" : "list", + "member" : { + "shape" : "Route" + } + }, + "__listOfRouteResponse" : { + "type" : "list", + "member" : { + "shape" : "RouteResponse" + } + }, + "__listOfStage" : { + "type" : "list", + "member" : { + "shape" : "Stage" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__string" : { + "type" : "string" + }, + "__mapOf__string" : { + "type" : "map", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "authorizers" : { + "authorization_strategy" : { + "name" : "authorization_strategy", + "type" : "provided", + "placement" : { + "location" : "header", + "name" : "Authorization" + } + } + }, + "documentation" : "

Amazon API Gateway V2

" +} diff --git a/aws/dist/botocore/data/application-autoscaling/2016-02-06/examples-1.json b/aws/dist/botocore/data/application-autoscaling/2016-02-06/examples-1.json new file mode 100644 index 00000000..53415ece --- /dev/null +++ b/aws/dist/botocore/data/application-autoscaling/2016-02-06/examples-1.json @@ -0,0 +1,257 @@ +{ + "version": "1.0", + "examples": { + "DeleteScalingPolicy": [ + { + "input": { + "PolicyName": "web-app-cpu-lt-25", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.", + "id": "to-delete-a-scaling-policy-1470863892689", + "title": "To delete a scaling policy" + } + ], + "DeregisterScalableTarget": [ + { + "input": { + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.", + "id": "to-deregister-a-scalable-target-1470864164895", + "title": "To deregister a scalable target" + } + ], + "DescribeScalableTargets": [ + { + "input": { + "ServiceNamespace": "ecs" + }, + "output": { + "ScalableTargets": [ + { + "CreationTime": "2016-05-06T11:21:46.199Z", + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scalable targets for the ecs service namespace.", + "id": "to-describe-scalable-targets-1470864286961", + "title": "To describe scalable targets" + } + ], + "DescribeScalingActivities": [ + { + "input": { + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "output": { + "ScalingActivities": [ + { + "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", + "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", + "Description": "Setting desired count to 1.", + "EndTime": "2016-05-06T16:04:32.111Z", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StartTime": "2016-05-06T16:03:58.171Z", + "StatusCode": "Successful", + "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs." + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.", + "id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629", + "title": "To describe scaling activities for a scalable target" + } + ], + "DescribeScalingPolicies": [ + { + "input": { + "ServiceNamespace": "ecs" + }, + "output": { + "NextToken": "", + "ScalingPolicies": [ + { + "Alarms": [ + { + "AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75", + "AlarmName": "web-app-cpu-gt-75" + } + ], + "CreationTime": "2016-05-06T12:11:39.230Z", + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", + "PolicyName": "web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 60, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling policies for the ecs service namespace.", + "id": "to-describe-scaling-policies-1470864609734", + "title": "To describe scaling policies" + } + ], + "PutScalingPolicy": [ + { + "input": { + "PolicyName": "web-app-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "service/default/web-app", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 60, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.", + "id": "to-apply-a-scaling-policy-to-an-amazon-ecs-service-1470864779862", + "title": "To apply a scaling policy to an Amazon ECS service" + }, + { + "input": { + "PolicyName": "fleet-cpu-gt-75", + "PolicyType": "StepScaling", + "ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", + "ScalableDimension": "ec2:spot-fleet-request:TargetCapacity", + "ServiceNamespace": "ec2", + "StepScalingPolicyConfiguration": { + "AdjustmentType": "PercentChangeInCapacity", + "Cooldown": 180, + "StepAdjustments": [ + { + "MetricIntervalLowerBound": 0, + "ScalingAdjustment": 200 + } + ] + } + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.\",\n ", + "id": "to-apply-a-scaling-policy-to-an-amazon-ec2-spot-fleet-1472073278469", + "title": "To apply a scaling policy to an Amazon EC2 Spot fleet" + } + ], + "RegisterScalableTarget": [ + { + "input": { + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "service/default/web-app", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", + "ScalableDimension": "ecs:service:DesiredCount", + "ServiceNamespace": "ecs" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.", + "id": "to-register-a-new-scalable-target-1470864910380", + "title": "To register an ECS service as a scalable target" + }, + { + "input": { + "MaxCapacity": 10, + "MinCapacity": 1, + "ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", + "RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole", + "ScalableDimension": "ec2:spot-fleet-request:TargetCapacity", + "ServiceNamespace": "ec2" + }, + "output": { + }, + "comments": { + }, + "description": "This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.", + "id": "to-register-an-ec2-spot-fleet-as-a-scalable-target-1472072899649", + "title": "To register an EC2 Spot fleet as a scalable target" + } + ] + } +} diff --git a/aws/dist/botocore/data/application-autoscaling/2016-02-06/paginators-1.json b/aws/dist/botocore/data/application-autoscaling/2016-02-06/paginators-1.json new file mode 100644 index 00000000..7ec8f3af --- /dev/null +++ b/aws/dist/botocore/data/application-autoscaling/2016-02-06/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeScalableTargets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScalableTargets" + }, + "DescribeScalingActivities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScalingActivities" + }, + "DescribeScalingPolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScalingPolicies" + }, + "DescribeScheduledActions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledActions" + } + } +} diff --git a/aws/dist/botocore/data/application-autoscaling/2016-02-06/service-2.json b/aws/dist/botocore/data/application-autoscaling/2016-02-06/service-2.json new file mode 100644 index 00000000..e8e551b1 --- /dev/null +++ b/aws/dist/botocore/data/application-autoscaling/2016-02-06/service-2.json @@ -0,0 +1,1209 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-02-06", + "endpointPrefix":"autoscaling", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Application Auto Scaling", + "serviceId":"Application Auto Scaling", + "signatureVersion":"v4", + "signingName":"application-autoscaling", + "targetPrefix":"AnyScaleFrontendService", + "uid":"application-autoscaling-2016-02-06" + }, + "operations":{ + "DeleteScalingPolicy":{ + "name":"DeleteScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScalingPolicyRequest"}, + "output":{"shape":"DeleteScalingPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

For more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in the Application Auto Scaling User Guide.

To create a scaling policy or update an existing one, see PutScalingPolicy.

" + }, + "DeleteScheduledAction":{ + "name":"DeleteScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScheduledActionRequest"}, + "output":{"shape":"DeleteScheduledActionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

For more information, see Delete a Scheduled Action in the Application Auto Scaling User Guide.

" + }, + "DeregisterScalableTarget":{ + "name":"DeregisterScalableTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterScalableTargetRequest"}, + "output":{"shape":"DeregisterScalableTargetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deregisters an Application Auto Scaling scalable target.

Deregistering a scalable target deletes the scaling policies that are associated with it.

To create a scalable target or update an existing one, see RegisterScalableTarget.

" + }, + "DescribeScalableTargets":{ + "name":"DescribeScalableTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalableTargetsRequest"}, + "output":{"shape":"DescribeScalableTargetsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

" + }, + "DescribeScalingActivities":{ + "name":"DescribeScalingActivities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingActivitiesRequest"}, + "output":{"shape":"DescribeScalingActivitiesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using ResourceId and ScalableDimension.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

" + }, + "DescribeScalingPolicies":{ + "name":"DescribeScalingPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingPoliciesRequest"}, + "output":{"shape":"DescribeScalingPoliciesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"FailedResourceAccessException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the Application Auto Scaling scaling policies for the specified service namespace.

You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

" + }, + "DescribeScheduledActions":{ + "name":"DescribeScheduledActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledActionsRequest"}, + "output":{"shape":"DescribeScheduledActionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

" + }, + "PutScalingPolicy":{ + "name":"PutScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScalingPolicyRequest"}, + "output":{"shape":"PutScalingPolicyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"FailedResourceAccessException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates or updates a policy for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target using RegisterScalableTarget.

To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

Learn more about how to work with scaling policies in the Application Auto Scaling User Guide.

" + }, + "PutScheduledAction":{ + "name":"PutScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScheduledActionRequest"}, + "output":{"shape":"PutScheduledActionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using RegisterScalableTarget.

To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.

You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

Learn more about how to work with scheduled actions in the Application Auto Scaling User Guide.

" + }, + "RegisterScalableTarget":{ + "name":"RegisterScalableTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterScalableTargetRequest"}, + "output":{"shape":"RegisterScalableTargetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace.

When you register a new scalable target, you must specify values for minimum and maximum capacity. Application Auto Scaling will not scale capacity to values that are outside of this range.

To update a scalable target, specify the parameter that you want to change as well as the following parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets.

If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

" + } + }, + "shapes":{ + "AdjustmentType":{ + "type":"string", + "enum":[ + "ChangeInCapacity", + "PercentChangeInCapacity", + "ExactCapacity" + ] + }, + "Alarm":{ + "type":"structure", + "required":[ + "AlarmName", + "AlarmARN" + ], + "members":{ + "AlarmName":{ + "shape":"ResourceId", + "documentation":"

The name of the alarm.

" + }, + "AlarmARN":{ + "shape":"ResourceId", + "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" + } + }, + "documentation":"

Represents a CloudWatch alarm associated with a scaling policy.

" + }, + "Alarms":{ + "type":"list", + "member":{"shape":"Alarm"} + }, + "ConcurrentUpdateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.

", + "exception":true + }, + "Cooldown":{"type":"integer"}, + "CustomizedMetricSpecification":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Namespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the metric.

" + }, + "Dimensions":{ + "shape":"MetricDimensions", + "documentation":"

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

" + }, + "Statistic":{ + "shape":"MetricStatistic", + "documentation":"

The statistic of the metric.

" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"

The unit of the metric.

" + } + }, + "documentation":"

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.

To create your customized metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

" + }, + "DeleteScalingPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "PolicyName":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The name of the scaling policy.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + } + } + }, + "DeleteScalingPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteScheduledActionRequest":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ScheduledActionName", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ScheduledActionName":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The name of the scheduled action.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + } + } + }, + "DeleteScheduledActionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterScalableTargetRequest":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + } + } + }, + "DeregisterScalableTargetResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeScalableTargetsRequest":{ + "type":"structure", + "required":["ServiceNamespace"], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceIds":{ + "shape":"ResourceIdsMaxLen1600", + "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScalableTargetsResponse":{ + "type":"structure", + "members":{ + "ScalableTargets":{ + "shape":"ScalableTargets", + "documentation":"

The scalable targets that match the request parameters.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DescribeScalingActivitiesRequest":{ + "type":"structure", + "required":["ServiceNamespace"], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScalingActivitiesResponse":{ + "type":"structure", + "members":{ + "ScalingActivities":{ + "shape":"ScalingActivities", + "documentation":"

A list of scaling activity objects.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DescribeScalingPoliciesRequest":{ + "type":"structure", + "required":["ServiceNamespace"], + "members":{ + "PolicyNames":{ + "shape":"ResourceIdsMaxLen1600", + "documentation":"

The names of the scaling policies to describe.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScalingPoliciesResponse":{ + "type":"structure", + "members":{ + "ScalingPolicies":{ + "shape":"ScalingPolicies", + "documentation":"

Information about the scaling policies.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DescribeScheduledActionsRequest":{ + "type":"structure", + "required":["ServiceNamespace"], + "members":{ + "ScheduledActionNames":{ + "shape":"ResourceIdsMaxLen1600", + "documentation":"

The names of the scheduled actions to describe.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScheduledActionsResponse":{ + "type":"structure", + "members":{ + "ScheduledActions":{ + "shape":"ScheduledActions", + "documentation":"

Information about the scheduled actions.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DisableScaleIn":{"type":"boolean"}, + "ErrorMessage":{"type":"string"}, + "FailedResourceAccessException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch DescribeAlarms on your behalf.

", + "exception":true + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service encountered an internal error.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The next token supplied was invalid.

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A per-account resource limit is exceeded. For more information, see Application Auto Scaling Limits.

", + "exception":true + }, + "MaxResults":{"type":"integer"}, + "MetricAggregationType":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum" + ] + }, + "MetricDimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MetricDimensionName", + "documentation":"

The name of the dimension.

" + }, + "Value":{ + "shape":"MetricDimensionValue", + "documentation":"

The value of the dimension.

" + } + }, + "documentation":"

Describes the dimension names and values associated with a metric.

" + }, + "MetricDimensionName":{"type":"string"}, + "MetricDimensionValue":{"type":"string"}, + "MetricDimensions":{ + "type":"list", + "member":{"shape":"MetricDimension"} + }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, + "MetricScale":{"type":"double"}, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum", + "SampleCount", + "Sum" + ] + }, + "MetricType":{ + "type":"string", + "enum":[ + "DynamoDBReadCapacityUtilization", + "DynamoDBWriteCapacityUtilization", + "ALBRequestCountPerTarget", + "RDSReaderAverageCPUUtilization", + "RDSReaderAverageDatabaseConnections", + "EC2SpotFleetRequestAverageCPUUtilization", + "EC2SpotFleetRequestAverageNetworkIn", + "EC2SpotFleetRequestAverageNetworkOut", + "SageMakerVariantInvocationsPerInstance", + "ECSServiceAverageCPUUtilization", + "ECSServiceAverageMemoryUtilization" + ] + }, + "MetricUnit":{"type":"string"}, + "MinAdjustmentMagnitude":{"type":"integer"}, + "ObjectNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.

", + "exception":true + }, + "PolicyName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\p{Print}+" + }, + "PolicyType":{ + "type":"string", + "enum":[ + "StepScaling", + "TargetTrackingScaling" + ] + }, + "PredefinedMetricSpecification":{ + "type":"structure", + "required":["PredefinedMetricType"], + "members":{ + "PredefinedMetricType":{ + "shape":"MetricType", + "documentation":"

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleet requests and ECS services.

" + }, + "ResourceLabel":{ + "shape":"ResourceLabel", + "documentation":"

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet request or ECS service.

The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

" + } + }, + "documentation":"

Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.

" + }, + "PutScalingPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the scaling policy.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The policy type. This parameter is required if you are creating a scaling policy.

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR or AppStream

StepScaling—Not supported for Amazon DynamoDB

For more information, see Target Tracking Scaling Policies and Step Scaling Policies in the Application Auto Scaling User Guide.

" + }, + "StepScalingPolicyConfiguration":{ + "shape":"StepScalingPolicyConfiguration", + "documentation":"

A step scaling policy.

This parameter is required if you are creating a policy and the policy type is StepScaling.

" + }, + "TargetTrackingScalingPolicyConfiguration":{ + "shape":"TargetTrackingScalingPolicyConfiguration", + "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling.

" + } + } + }, + "PutScalingPolicyResponse":{ + "type":"structure", + "required":["PolicyARN"], + "members":{ + "PolicyARN":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The Amazon Resource Name (ARN) of the resulting scaling policy.

" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"

The CloudWatch alarms created for the target tracking scaling policy.

" + } + } + }, + "PutScheduledActionRequest":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ScheduledActionName", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "Schedule":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The schedule for this action. The following formats are supported:

  • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

  • Rate expressions - \"rate(value unit)\"

  • Cron expressions - \"cron(fields)\"

At expressions are useful for one-time schedules. Specify the time, in UTC.

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

" + }, + "ScheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"

The name of the scheduled action.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for the scheduled action to start.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for the scheduled action to end.

" + }, + "ScalableTargetAction":{ + "shape":"ScalableTargetAction", + "documentation":"

The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

" + } + } + }, + "PutScheduledActionResponse":{ + "type":"structure", + "members":{ + } + }, + "RegisterScalableTargetRequest":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ResourceId", + "ScalableDimension" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MinCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The minimum value to scale to in response to a scale-in event. MinCapacity is required to register a scalable target.

" + }, + "MaxCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The maximum value to scale to in response to a scale-out event. MaxCapacity is required to register a scalable target.

" + }, + "RoleARN":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see Service-Linked Roles for Application Auto Scaling.

For Amazon EMR, this parameter is required, and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

" + }, + "SuspendedState":{ + "shape":"SuspendedState", + "documentation":"

An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.

Suspension Outcomes

  • For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.

  • For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.

  • For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.

For more information, see Suspend and Resume Application Auto Scaling in the Application Auto Scaling User Guide.

" + } + } + }, + "RegisterScalableTargetResponse":{ + "type":"structure", + "members":{ + } + }, + "ResourceCapacity":{"type":"integer"}, + "ResourceId":{ + "type":"string", + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "ResourceIdMaxLen1600":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "ResourceIdsMaxLen1600":{ + "type":"list", + "member":{"shape":"ResourceIdMaxLen1600"} + }, + "ResourceLabel":{ + "type":"string", + "max":1023, + "min":1 + }, + "ScalableDimension":{ + "type":"string", + "enum":[ + "ecs:service:DesiredCount", + "ec2:spot-fleet-request:TargetCapacity", + "elasticmapreduce:instancegroup:InstanceCount", + "appstream:fleet:DesiredCapacity", + "dynamodb:table:ReadCapacityUnits", + "dynamodb:table:WriteCapacityUnits", + "dynamodb:index:ReadCapacityUnits", + "dynamodb:index:WriteCapacityUnits", + "rds:cluster:ReadReplicaCount", + "sagemaker:variant:DesiredInstanceCount", + "custom-resource:ResourceType:Property" + ] + }, + "ScalableTarget":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "MinCapacity", + "MaxCapacity", + "RoleARN", + "CreationTime" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "MinCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The minimum value to scale to in response to a scale-in event.

" + }, + "MaxCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The maximum value to scale to in response to a scale-out event.

" + }, + "RoleARN":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

" + }, + "CreationTime":{ + "shape":"TimestampType", + "documentation":"

The Unix timestamp for when the scalable target was created.

" + }, + "SuspendedState":{"shape":"SuspendedState"} + }, + "documentation":"

Represents a scalable target.

" + }, + "ScalableTargetAction":{ + "type":"structure", + "members":{ + "MinCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The minimum capacity.

" + }, + "MaxCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The maximum capacity.

" + } + }, + "documentation":"

Represents the minimum and maximum capacity for a scheduled action.

" + }, + "ScalableTargets":{ + "type":"list", + "member":{"shape":"ScalableTarget"} + }, + "ScalingActivities":{ + "type":"list", + "member":{"shape":"ScalingActivity"} + }, + "ScalingActivity":{ + "type":"structure", + "required":[ + "ActivityId", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "Description", + "Cause", + "StartTime", + "StatusCode" + ], + "members":{ + "ActivityId":{ + "shape":"ResourceId", + "documentation":"

The unique identifier of the scaling activity.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "Description":{ + "shape":"XmlString", + "documentation":"

A simple description of what action the scaling activity intends to accomplish.

" + }, + "Cause":{ + "shape":"XmlString", + "documentation":"

A simple description of what caused the scaling activity to happen.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The Unix timestamp for when the scaling activity began.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The Unix timestamp for when the scaling activity ended.

" + }, + "StatusCode":{ + "shape":"ScalingActivityStatusCode", + "documentation":"

Indicates the status of the scaling activity.

" + }, + "StatusMessage":{ + "shape":"XmlString", + "documentation":"

A simple message about the current status of the scaling activity.

" + }, + "Details":{ + "shape":"XmlString", + "documentation":"

The details about the scaling activity.

" + } + }, + "documentation":"

Represents a scaling activity.

" + }, + "ScalingActivityStatusCode":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Successful", + "Overridden", + "Unfulfilled", + "Failed" + ] + }, + "ScalingAdjustment":{"type":"integer"}, + "ScalingPolicies":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingPolicy":{ + "type":"structure", + "required":[ + "PolicyARN", + "PolicyName", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "PolicyType", + "CreationTime" + ], + "members":{ + "PolicyARN":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The Amazon Resource Name (ARN) of the scaling policy.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the scaling policy.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The scaling policy type.

" + }, + "StepScalingPolicyConfiguration":{ + "shape":"StepScalingPolicyConfiguration", + "documentation":"

A step scaling policy.

" + }, + "TargetTrackingScalingPolicyConfiguration":{ + "shape":"TargetTrackingScalingPolicyConfiguration", + "documentation":"

A target tracking scaling policy.

" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"

The CloudWatch alarms associated with the scaling policy.

" + }, + "CreationTime":{ + "shape":"TimestampType", + "documentation":"

The Unix timestamp for when the scaling policy was created.

" + } + }, + "documentation":"

Represents a scaling policy to use with Application Auto Scaling.

" + }, + "ScalingSuspended":{"type":"boolean"}, + "ScheduledAction":{ + "type":"structure", + "required":[ + "ScheduledActionName", + "ScheduledActionARN", + "ServiceNamespace", + "Schedule", + "ResourceId", + "CreationTime" + ], + "members":{ + "ScheduledActionName":{ + "shape":"ScheduledActionName", + "documentation":"

The name of the scheduled action.

" + }, + "ScheduledActionARN":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The Amazon Resource Name (ARN) of the scheduled action.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service that provides the resource or custom-resource for a resource provided by your own application or service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

" + }, + "Schedule":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The schedule for this action. The following formats are supported:

  • At expressions - \"at(yyyy-mm-ddThh:mm:ss)\"

  • Rate expressions - \"rate(value unit)\"

  • Cron expressions - \"cron(fields)\"

At expressions are useful for one-time schedules. Specify the time, in UTC.

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

For more information about cron expressions, see Cron Expressions in the Amazon CloudWatch Events User Guide.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

  • Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.

  • Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

  • sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon SageMaker model endpoint variant.

  • custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The date and time that the action is scheduled to begin.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The date and time that the action is scheduled to end.

" + }, + "ScalableTargetAction":{ + "shape":"ScalableTargetAction", + "documentation":"

The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

" + }, + "CreationTime":{ + "shape":"TimestampType", + "documentation":"

The date and time that the scheduled action was created.

" + } + }, + "documentation":"

Represents a scheduled action.

" + }, + "ScheduledActionName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+" + }, + "ScheduledActions":{ + "type":"list", + "member":{"shape":"ScheduledAction"} + }, + "ServiceNamespace":{ + "type":"string", + "enum":[ + "ecs", + "elasticmapreduce", + "ec2", + "appstream", + "dynamodb", + "rds", + "sagemaker", + "custom-resource" + ] + }, + "StepAdjustment":{ + "type":"structure", + "required":["ScalingAdjustment"], + "members":{ + "MetricIntervalLowerBound":{ + "shape":"MetricScale", + "documentation":"

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

" + }, + "MetricIntervalUpperBound":{ + "shape":"MetricScale", + "documentation":"

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

" + }, + "ScalingAdjustment":{ + "shape":"ScalingAdjustment", + "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

" + } + }, + "documentation":"

Represents a step adjustment for a StepScalingPolicyConfiguration. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

" + }, + "StepAdjustments":{ + "type":"list", + "member":{"shape":"StepAdjustment"} + }, + "StepScalingPolicyConfiguration":{ + "type":"structure", + "members":{ + "AdjustmentType":{ + "shape":"AdjustmentType", + "documentation":"

Specifies whether the ScalingAdjustment value in a StepAdjustment is an absolute number or a percentage of the current capacity.

" + }, + "StepAdjustments":{ + "shape":"StepAdjustments", + "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

" + }, + "MinAdjustmentMagnitude":{ + "shape":"MinAdjustmentMagnitude", + "documentation":"

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

" + }, + "Cooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

" + }, + "MetricAggregationType":{ + "shape":"MetricAggregationType", + "documentation":"

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

" + } + }, + "documentation":"

Represents a step scaling policy configuration to use with Application Auto Scaling.

" + }, + "SuspendedState":{ + "type":"structure", + "members":{ + "DynamicScalingInSuspended":{ + "shape":"ScalingSuspended", + "documentation":"

Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.

" + }, + "DynamicScalingOutSuspended":{ + "shape":"ScalingSuspended", + "documentation":"

Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.

" + }, + "ScheduledScalingSuspended":{ + "shape":"ScalingSuspended", + "documentation":"

Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.

" + } + }, + "documentation":"

Specifies whether the scaling activities for a scalable target are in a suspended state.

" + }, + "TargetTrackingScalingPolicyConfiguration":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "TargetValue":{ + "shape":"MetricScale", + "documentation":"

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

" + }, + "PredefinedMetricSpecification":{ + "shape":"PredefinedMetricSpecification", + "documentation":"

A predefined metric. You can specify either a predefined metric or a customized metric.

" + }, + "CustomizedMetricSpecification":{ + "shape":"CustomizedMetricSpecification", + "documentation":"

A customized metric. You can specify either a predefined metric or a customized metric.

" + }, + "ScaleOutCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.

While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

" + }, + "ScaleInCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.

The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

" + }, + "DisableScaleIn":{ + "shape":"DisableScaleIn", + "documentation":"

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is false.

" + } + }, + "documentation":"

Represents a target tracking scaling policy configuration to use with Application Auto Scaling.

" + }, + "TimestampType":{"type":"timestamp"}, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An exception was thrown for a validation issue. Review the available parameters for the API request.

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

With Application Auto Scaling, you can configure automatic scaling for the following resources:

  • Amazon ECS services

  • Amazon EC2 Spot Fleet requests

  • Amazon EMR clusters

  • Amazon AppStream 2.0 fleets

  • Amazon DynamoDB tables and global secondary indexes throughput capacity

  • Amazon Aurora Replicas

  • Amazon SageMaker endpoint variants

  • Custom resources provided by your own applications or services

API Summary

The Application Auto Scaling service API includes three key sets of actions:

  • Register and manage scalable targets - Register AWS or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.

  • Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.

  • Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget action for any Application Auto Scaling scalable target. You can suspend and resume, individually or in combination, scale-out activities triggered by a scaling policy, scale-in activities triggered by a scaling policy, and scheduled scaling.

To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide.

" +} diff --git a/aws/dist/botocore/data/application-insights/2018-11-25/paginators-1.json b/aws/dist/botocore/data/application-insights/2018-11-25/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/application-insights/2018-11-25/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/application-insights/2018-11-25/service-2.json b/aws/dist/botocore/data/application-insights/2018-11-25/service-2.json new file mode 100644 index 00000000..ff953ee0 --- /dev/null +++ b/aws/dist/botocore/data/application-insights/2018-11-25/service-2.json @@ -0,0 +1,1028 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-11-25", + "endpointPrefix":"applicationinsights", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Application Insights", + "serviceFullName":"Amazon CloudWatch Application Insights", + "serviceId":"Application Insights", + "signatureVersion":"v4", + "signingName":"applicationinsights", + "targetPrefix":"EC2WindowsBarleyService", + "uid":"application-insights-2018-11-25" + }, + "operations":{ + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Adds an application that is created from a resource group.

" + }, + "CreateComponent":{ + "name":"CreateComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateComponentRequest"}, + "output":{"shape":"CreateComponentResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Creates a custom component by grouping similar standalone instances to monitor.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Removes the specified application from monitoring. Does not delete the application.

" + }, + "DeleteComponent":{ + "name":"DeleteComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteComponentRequest"}, + "output":{"shape":"DeleteComponentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.

" + }, + "DescribeApplication":{ + "name":"DescribeApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationRequest"}, + "output":{"shape":"DescribeApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Describes the application.

" + }, + "DescribeComponent":{ + "name":"DescribeComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComponentRequest"}, + "output":{"shape":"DescribeComponentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Describes a component and lists the resources that are grouped together in a component.

" + }, + "DescribeComponentConfiguration":{ + "name":"DescribeComponentConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComponentConfigurationRequest"}, + "output":{"shape":"DescribeComponentConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Describes the monitoring configuration of the component.

" + }, + "DescribeComponentConfigurationRecommendation":{ + "name":"DescribeComponentConfigurationRecommendation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComponentConfigurationRecommendationRequest"}, + "output":{"shape":"DescribeComponentConfigurationRecommendationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Describes the recommended monitoring configuration of the component.

" + }, + "DescribeObservation":{ + "name":"DescribeObservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeObservationRequest"}, + "output":{"shape":"DescribeObservationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an anomaly or error with the application.

" + }, + "DescribeProblem":{ + "name":"DescribeProblem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProblemRequest"}, + "output":{"shape":"DescribeProblemResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an application problem.

" + }, + "DescribeProblemObservations":{ + "name":"DescribeProblemObservations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProblemObservationsRequest"}, + "output":{"shape":"DescribeProblemObservationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the anomalies or errors associated with the problem.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Lists the IDs of the applications that you are monitoring.

" + }, + "ListComponents":{ + "name":"ListComponents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComponentsRequest"}, + "output":{"shape":"ListComponentsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Lists the auto-grouped, standalone, and custom components of the application.

" + }, + "ListProblems":{ + "name":"ListProblems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProblemsRequest"}, + "output":{"shape":"ListProblemsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Lists the problems with your application.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates the application.

" + }, + "UpdateComponent":{ + "name":"UpdateComponent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateComponentRequest"}, + "output":{"shape":"UpdateComponentResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Updates the custom component name and/or the list of resources that make up the component.

" + }, + "UpdateComponentConfiguration":{ + "name":"UpdateComponentConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateComponentConfigurationRequest"}, + "output":{"shape":"UpdateComponentConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation.

" + } + }, + "shapes":{ + "AffectedResource":{"type":"string"}, + "ApplicationComponent":{ + "type":"structure", + "members":{ + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

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

The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.

" + }, + "Tier":{ + "shape":"Tier", + "documentation":"

The stack tier of the application component.

" + }, + "Monitor":{ + "shape":"Monitor", + "documentation":"

Indicates whether the application component is monitored.

" + } + }, + "documentation":"

Describes a standalone resource or similarly grouped resources that the application is made up of.

" + }, + "ApplicationComponentList":{ + "type":"list", + "member":{"shape":"ApplicationComponent"} + }, + "ApplicationInfo":{ + "type":"structure", + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group used for the application.

" + }, + "LifeCycle":{ + "shape":"LifeCycle", + "documentation":"

The lifecycle of the application.

" + }, + "OpsItemSNSTopicArn":{ + "shape":"OpsItemSNSTopicArn", + "documentation":"

The SNS topic provided to Application Insights that is associated to the created opsItems to receive SNS notifications for opsItem updates.

" + }, + "OpsCenterEnabled":{ + "shape":"OpsCenterEnabled", + "documentation":"

Indicates whether Application Insights will create opsItems for any problem detected by Application Insights for an application.

" + }, + "Remarks":{ + "shape":"Remarks", + "documentation":"

The issues on the user side that block Application Insights from successfully monitoring an application.

" + } + }, + "documentation":"

Describes the status of the application.

" + }, + "ApplicationInfoList":{ + "type":"list", + "member":{"shape":"ApplicationInfo"} + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMsg"} + }, + "documentation":"

The request is not understood by the server.

", + "exception":true + }, + "ComponentConfiguration":{"type":"string"}, + "ComponentName":{"type":"string"}, + "CreateApplicationRequest":{ + "type":"structure", + "required":["ResourceGroupName"], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "OpsCenterEnabled":{ + "shape":"OpsCenterEnabled", + "documentation":"

When set to true, creates opsItems for any problems detected on an application.

" + }, + "OpsItemSNSTopicArn":{ + "shape":"OpsItemSNSTopicArn", + "documentation":"

The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "members":{ + "ApplicationInfo":{ + "shape":"ApplicationInfo", + "documentation":"

Information about the application.

" + } + } + }, + "CreateComponentRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName", + "ResourceList" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + }, + "ResourceList":{ + "shape":"ResourceList", + "documentation":"

The list of resource ARNs that belong to the component.

" + } + } + }, + "CreateComponentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["ResourceGroupName"], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteComponentRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + } + } + }, + "DeleteComponentResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeApplicationRequest":{ + "type":"structure", + "required":["ResourceGroupName"], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + } + } + }, + "DescribeApplicationResponse":{ + "type":"structure", + "members":{ + "ApplicationInfo":{ + "shape":"ApplicationInfo", + "documentation":"

Information about the application.

" + } + } + }, + "DescribeComponentConfigurationRecommendationRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName", + "Tier" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + }, + "Tier":{ + "shape":"Tier", + "documentation":"

The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

" + } + } + }, + "DescribeComponentConfigurationRecommendationResponse":{ + "type":"structure", + "members":{ + "ComponentConfiguration":{ + "shape":"ComponentConfiguration", + "documentation":"

The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

" + } + } + }, + "DescribeComponentConfigurationRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + } + } + }, + "DescribeComponentConfigurationResponse":{ + "type":"structure", + "members":{ + "Monitor":{ + "shape":"Monitor", + "documentation":"

Indicates whether the application component is monitored.

" + }, + "Tier":{ + "shape":"Tier", + "documentation":"

The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT

" + }, + "ComponentConfiguration":{ + "shape":"ComponentConfiguration", + "documentation":"

The configuration settings of the component. The value is the escaped JSON of the configuration.

" + } + } + }, + "DescribeComponentRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + } + } + }, + "DescribeComponentResponse":{ + "type":"structure", + "members":{ + "ApplicationComponent":{"shape":"ApplicationComponent"}, + "ResourceList":{ + "shape":"ResourceList", + "documentation":"

The list of resource ARNs that belong to the component.

" + } + } + }, + "DescribeObservationRequest":{ + "type":"structure", + "required":["ObservationId"], + "members":{ + "ObservationId":{ + "shape":"ObservationId", + "documentation":"

The ID of the observation.

" + } + } + }, + "DescribeObservationResponse":{ + "type":"structure", + "members":{ + "Observation":{ + "shape":"Observation", + "documentation":"

Information about the observation.

" + } + } + }, + "DescribeProblemObservationsRequest":{ + "type":"structure", + "required":["ProblemId"], + "members":{ + "ProblemId":{ + "shape":"ProblemId", + "documentation":"

The ID of the problem.

" + } + } + }, + "DescribeProblemObservationsResponse":{ + "type":"structure", + "members":{ + "RelatedObservations":{ + "shape":"RelatedObservations", + "documentation":"

Observations related to the problem.

" + } + } + }, + "DescribeProblemRequest":{ + "type":"structure", + "required":["ProblemId"], + "members":{ + "ProblemId":{ + "shape":"ProblemId", + "documentation":"

The ID of the problem.

" + } + } + }, + "DescribeProblemResponse":{ + "type":"structure", + "members":{ + "Problem":{ + "shape":"Problem", + "documentation":"

Information about the problem.

" + } + } + }, + "EndTime":{"type":"timestamp"}, + "ErrorMsg":{"type":"string"}, + "Feedback":{ + "type":"map", + "key":{"shape":"FeedbackKey"}, + "value":{"shape":"FeedbackValue"}, + "max":10 + }, + "FeedbackKey":{ + "type":"string", + "enum":["INSIGHTS_FEEDBACK"] + }, + "FeedbackValue":{ + "type":"string", + "enum":[ + "NOT_SPECIFIED", + "USEFUL", + "NOT_USEFUL" + ] + }, + "Insights":{"type":"string"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMsg"} + }, + "documentation":"

The server encountered an internal error and is unable to complete the request.

", + "exception":true + }, + "LifeCycle":{"type":"string"}, + "LineTime":{"type":"timestamp"}, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxEntities", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "members":{ + "ApplicationInfoList":{ + "shape":"ApplicationInfoList", + "documentation":"

The list of applications.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListComponentsRequest":{ + "type":"structure", + "required":["ResourceGroupName"], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "MaxResults":{ + "shape":"MaxEntities", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "ListComponentsResponse":{ + "type":"structure", + "members":{ + "ApplicationComponentList":{ + "shape":"ApplicationComponentList", + "documentation":"

The list of application components.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "ListProblemsRequest":{ + "type":"structure", + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "StartTime":{ + "shape":"StartTime", + "documentation":"

The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.

" + }, + "EndTime":{ + "shape":"EndTime", + "documentation":"

The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.

" + }, + "MaxResults":{ + "shape":"MaxEntities", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "ListProblemsResponse":{ + "type":"structure", + "members":{ + "ProblemList":{ + "shape":"ProblemList", + "documentation":"

The list of problems.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "LogFilter":{ + "type":"string", + "enum":[ + "ERROR", + "WARN", + "INFO" + ] + }, + "LogGroup":{"type":"string"}, + "LogText":{"type":"string"}, + "MaxEntities":{ + "type":"integer", + "max":40, + "min":1 + }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, + "Monitor":{"type":"boolean"}, + "NewComponentName":{"type":"string"}, + "Observation":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ObservationId", + "documentation":"

The ID of the observation type.

" + }, + "StartTime":{ + "shape":"StartTime", + "documentation":"

The time when the observation was first detected, in epoch seconds.

" + }, + "EndTime":{ + "shape":"EndTime", + "documentation":"

The time when the observation ended, in epoch seconds.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The source type of the observation.

" + }, + "SourceARN":{ + "shape":"SourceARN", + "documentation":"

The source resource ARN of the observation.

" + }, + "LogGroup":{ + "shape":"LogGroup", + "documentation":"

The log group name.

" + }, + "LineTime":{ + "shape":"LineTime", + "documentation":"

The timestamp in the CloudWatch Logs that specifies when the matched line occurred.

" + }, + "LogText":{ + "shape":"LogText", + "documentation":"

The log text of the observation.

" + }, + "LogFilter":{ + "shape":"LogFilter", + "documentation":"

The log filter of the observation.

" + }, + "MetricNamespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the observation metric.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the observation metric.

" + }, + "Unit":{ + "shape":"Unit", + "documentation":"

The unit of the source observation metric.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The value of the source observation metric.

" + } + }, + "documentation":"

Describes an anomaly or error with the application.

" + }, + "ObservationId":{"type":"string"}, + "ObservationList":{ + "type":"list", + "member":{"shape":"Observation"} + }, + "OpsCenterEnabled":{"type":"boolean"}, + "OpsItemSNSTopicArn":{"type":"string"}, + "PaginationToken":{"type":"string"}, + "Problem":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ProblemId", + "documentation":"

The ID of the problem.

" + }, + "Title":{ + "shape":"Title", + "documentation":"

The name of the problem.

" + }, + "Insights":{ + "shape":"Insights", + "documentation":"

A detailed analysis of the problem using machine learning.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the problem.

" + }, + "AffectedResource":{ + "shape":"AffectedResource", + "documentation":"

The resource affected by the problem.

" + }, + "StartTime":{ + "shape":"StartTime", + "documentation":"

The time when the problem started, in epoch seconds.

" + }, + "EndTime":{ + "shape":"EndTime", + "documentation":"

The time when the problem ended, in epoch seconds.

" + }, + "SeverityLevel":{ + "shape":"SeverityLevel", + "documentation":"

A measure of the level of impact of the problem.

" + }, + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group affected by the problem.

" + }, + "Feedback":{ + "shape":"Feedback", + "documentation":"

Feedback provided by the user about the problem.

" + } + }, + "documentation":"

Describes a problem that is detected by correlating observations.

" + }, + "ProblemId":{"type":"string"}, + "ProblemList":{ + "type":"list", + "member":{"shape":"Problem"} + }, + "RelatedObservations":{ + "type":"structure", + "members":{ + "ObservationList":{ + "shape":"ObservationList", + "documentation":"

The list of observations related to the problem.

" + } + }, + "documentation":"

Describes observations related to the problem.

" + }, + "Remarks":{"type":"string"}, + "RemoveSNSTopic":{"type":"boolean"}, + "ResourceARN":{"type":"string"}, + "ResourceGroupName":{"type":"string"}, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMsg"} + }, + "documentation":"

The resource is already created or in use.

", + "exception":true + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"ResourceARN"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMsg"} + }, + "documentation":"

The resource does not exist in the customer account.

", + "exception":true + }, + "ResourceType":{"type":"string"}, + "SeverityLevel":{ + "type":"string", + "enum":[ + "LOW", + "MEDIUM", + "HIGH" + ] + }, + "SourceARN":{"type":"string"}, + "SourceType":{"type":"string"}, + "StartTime":{"type":"timestamp"}, + "Status":{ + "type":"string", + "enum":[ + "IGNORE", + "RESOLVED", + "PENDING" + ] + }, + "Tier":{"type":"string"}, + "Title":{"type":"string"}, + "Unit":{"type":"string"}, + "UpdateApplicationRequest":{ + "type":"structure", + "required":["ResourceGroupName"], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "OpsCenterEnabled":{ + "shape":"OpsCenterEnabled", + "documentation":"

When set to true, creates opsItems for any problems detected on an application.

" + }, + "OpsItemSNSTopicArn":{ + "shape":"OpsItemSNSTopicArn", + "documentation":"

The SNS topic provided to Application Insights that is associated to the created opsItem. Allows you to receive notifications for updates to the opsItem.

" + }, + "RemoveSNSTopic":{ + "shape":"RemoveSNSTopic", + "documentation":"

Disassociates the SNS topic from the opsItem created for detected problems.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + "ApplicationInfo":{ + "shape":"ApplicationInfo", + "documentation":"

Information about the application.

" + } + } + }, + "UpdateComponentConfigurationRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + }, + "Monitor":{ + "shape":"Monitor", + "documentation":"

Indicates whether the application component is monitored.

" + }, + "Tier":{ + "shape":"Tier", + "documentation":"

The tier of the application component. Supported tiers include DOT_NET_WORKER, DOT_NET_WEB, SQL_SERVER, and DEFAULT.

" + }, + "ComponentConfiguration":{ + "shape":"ComponentConfiguration", + "documentation":"

The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component.

" + } + } + }, + "UpdateComponentConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateComponentRequest":{ + "type":"structure", + "required":[ + "ResourceGroupName", + "ComponentName" + ], + "members":{ + "ResourceGroupName":{ + "shape":"ResourceGroupName", + "documentation":"

The name of the resource group.

" + }, + "ComponentName":{ + "shape":"ComponentName", + "documentation":"

The name of the component.

" + }, + "NewComponentName":{ + "shape":"NewComponentName", + "documentation":"

The new name of the component.

" + }, + "ResourceList":{ + "shape":"ResourceList", + "documentation":"

The list of resource ARNs that belong to the component.

" + } + } + }, + "UpdateComponentResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMsg"} + }, + "documentation":"

The parameter is not valid.

", + "exception":true + }, + "Value":{"type":"double"} + }, + "documentation":"Amazon CloudWatch Application Insights for .NET and SQL Server

Amazon CloudWatch Application Insights for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.

After you onboard your application, CloudWatch Application Insights for .NET and SQL Server identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors.

" +} diff --git a/aws/dist/botocore/data/appmesh/2018-10-01/paginators-1.json b/aws/dist/botocore/data/appmesh/2018-10-01/paginators-1.json new file mode 100644 index 00000000..162b8b96 --- /dev/null +++ b/aws/dist/botocore/data/appmesh/2018-10-01/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListMeshes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "meshes" + }, + "ListRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "routes" + }, + "ListVirtualNodes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualNodes" + }, + "ListVirtualRouters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualRouters" + } + } +} diff --git a/aws/dist/botocore/data/appmesh/2018-10-01/service-2.json b/aws/dist/botocore/data/appmesh/2018-10-01/service-2.json new file mode 100644 index 00000000..20ed19ea --- /dev/null +++ b/aws/dist/botocore/data/appmesh/2018-10-01/service-2.json @@ -0,0 +1,2207 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2018-10-01", + "endpointPrefix": "appmesh", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS App Mesh", + "serviceId": "App Mesh", + "signatureVersion": "v4", + "signingName": "appmesh", + "uid": "appmesh-2018-10-01" + }, + "documentation": "

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control containerized microservices. App Mesh standardizes how your microservices\n communicate, giving you end-to-end visibility and helping to ensure high-availability for\n your applications.

\n

App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with Amazon ECS\n (using the Amazon EC2 launch type), Amazon EKS, and Kubernetes on AWS.

\n \n

App Mesh supports containerized microservice applications that use service discovery\n naming for their components. To use App Mesh, you must have a containerized application\n running on Amazon EC2 instances, hosted in either Amazon ECS, Amazon EKS, or Kubernetes on AWS. For\n more information about service discovery on Amazon ECS, see Service Discovery in the\n Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns is supported.\n For more information, see DNS\n for Services and Pods in the Kubernetes documentation.

\n ", + "operations": { + "CreateMesh": { + "name": "CreateMesh", + "http": { + "method": "PUT", + "requestUri": "/meshes", + "responseCode": 200 + }, + "input": { + "shape": "CreateMeshInput" + }, + "output": { + "shape": "CreateMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a new service mesh. A service mesh is a logical boundary for network traffic\n between the services that reside within it.

\n

After you create your service mesh, you can create virtual nodes, virtual routers, and\n routes to distribute traffic between the applications in your mesh.

", + "idempotent": true + }, + "CreateRoute": { + "name": "CreateRoute", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "CreateRouteInput" + }, + "output": { + "shape": "CreateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a new route that is associated with a virtual router.

\n

You can use the prefix parameter in your route specification for path-based\n routing of requests. For example, if your virtual router service name is\n my-service.local, and you want the route to match requests to\n my-service.local/metrics, then your prefix should be\n /metrics.

\n

If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.

", + "idempotent": true + }, + "CreateVirtualNode": { + "name": "CreateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualNodeInput" + }, + "output": { + "shape": "CreateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a new virtual node within a service mesh.

\n

A virtual node acts as logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you must specify the\n DNS service discovery name for your task group.

\n

Any inbound traffic that your virtual node expects should be specified as a\n listener. Any outbound traffic that your virtual node expects to reach\n should be specified as a backend.

\n

The response metadata for your new virtual node contains the arn that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name, for example, mesh/default/virtualNode/simpleapp, as the\n APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n \n

If you require your Envoy stats or tracing to use a different name, you can override\n the node.cluster value that is set by\n APPMESH_VIRTUAL_NODE_NAME with the\n APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

\n ", + "idempotent": true + }, + "CreateVirtualRouter": { + "name": "CreateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualRouterInput" + }, + "output": { + "shape": "CreateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a new virtual router within a service mesh.

\n

Virtual routers handle traffic for one or more service names within your mesh. After you\n create your virtual router, create and associate routes for your virtual router that direct\n incoming requests to different virtual nodes.

", + "idempotent": true + }, + "DeleteMesh": { + "name": "DeleteMesh", + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteMeshInput" + }, + "output": { + "shape": "DeleteMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing service mesh.

\n

You must delete all resources (routes, virtual routers, virtual nodes) in the service\n mesh before you can delete the mesh itself.

", + "idempotent": true + }, + "DeleteRoute": { + "name": "DeleteRoute", + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteRouteInput" + }, + "output": { + "shape": "DeleteRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing route.

", + "idempotent": true + }, + "DeleteVirtualNode": { + "name": "DeleteVirtualNode", + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualNodeInput" + }, + "output": { + "shape": "DeleteVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual node.

", + "idempotent": true + }, + "DeleteVirtualRouter": { + "name": "DeleteVirtualRouter", + "http": { + "method": "DELETE", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualRouterInput" + }, + "output": { + "shape": "DeleteVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual router.

\n

You must delete any routes associated with the virtual router before you can delete the\n router itself.

", + "idempotent": true + }, + "DescribeMesh": { + "name": "DescribeMesh", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeMeshInput" + }, + "output": { + "shape": "DescribeMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing service mesh.

" + }, + "DescribeRoute": { + "name": "DescribeRoute", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeRouteInput" + }, + "output": { + "shape": "DescribeRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing route.

" + }, + "DescribeVirtualNode": { + "name": "DescribeVirtualNode", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualNodeInput" + }, + "output": { + "shape": "DescribeVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual node.

" + }, + "DescribeVirtualRouter": { + "name": "DescribeVirtualRouter", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualRouterInput" + }, + "output": { + "shape": "DescribeVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual router.

" + }, + "ListMeshes": { + "name": "ListMeshes", + "http": { + "method": "GET", + "requestUri": "/meshes", + "responseCode": 200 + }, + "input": { + "shape": "ListMeshesInput" + }, + "output": { + "shape": "ListMeshesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing service meshes.

" + }, + "ListRoutes": { + "name": "ListRoutes", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "ListRoutesInput" + }, + "output": { + "shape": "ListRoutesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing routes in a service mesh.

" + }, + "ListVirtualNodes": { + "name": "ListVirtualNodes", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualNodesInput" + }, + "output": { + "shape": "ListVirtualNodesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual nodes.

" + }, + "ListVirtualRouters": { + "name": "ListVirtualRouters", + "http": { + "method": "GET", + "requestUri": "/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualRoutersInput" + }, + "output": { + "shape": "ListVirtualRoutersOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual routers in a service mesh.

" + }, + "UpdateRoute": { + "name": "UpdateRoute", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateRouteInput" + }, + "output": { + "shape": "UpdateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing route for a specified service mesh and virtual router.

", + "idempotent": true + }, + "UpdateVirtualNode": { + "name": "UpdateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualNodeInput" + }, + "output": { + "shape": "UpdateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual node in a specified service mesh.

", + "idempotent": true + }, + "UpdateVirtualRouter": { + "name": "UpdateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualRouterInput" + }, + "output": { + "shape": "UpdateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual router in a specified service mesh.

", + "idempotent": true + } + }, + "shapes": { + "ServiceName": { + "type": "string" + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request processing has failed because of an unknown error, exception, or failure.

", + "exception": true, + "error": { + "code": "InternalServerErrorException", + "httpStatusCode": 500, + "fault": true + } + }, + "HealthCheckThreshold": { + "type": "integer", + "min": 2, + "max": 10 + }, + "DeleteMeshOutput": { + "type": "structure", + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The service mesh that was deleted.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "Long": { + "type": "long", + "box": true + }, + "ForbiddenException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You do not have permissions to perform this action.

", + "exception": true, + "error": { + "code": "ForbiddenException", + "httpStatusCode": 403, + "senderFault": true + } + }, + "UpdateVirtualRouterOutput": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

A full description of the virtual router that was updated.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "MeshStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "PortNumber": { + "type": "integer", + "min": 1, + "max": 65535 + }, + "WeightedTarget": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "ResourceName", + "documentation": "

The virtual node to associate with the weighted target.

" + }, + "weight": { + "shape": "PercentInt", + "documentation": "

The relative weight of the weighted target.

" + } + }, + "documentation": "

An object representing a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10.

" + }, + "VirtualNodeList": { + "type": "list", + "member": { + "shape": "VirtualNodeRef" + } + }, + "CreateRouteOutput": { + "type": "structure", + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The full description of your mesh following the create call.

" + } + }, + "documentation": "", + "payload": "route" + }, + "RouteList": { + "type": "list", + "member": { + "shape": "RouteRef" + } + }, + "DeleteVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to delete the virtual node.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to delete.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "ListVirtualRoutersLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DnsServiceDiscovery": { + "type": "structure", + "members": { + "serviceName": { + "shape": "ServiceName", + "documentation": "

The DNS service name for your virtual node.

" + } + }, + "documentation": "

The DNS service discovery information for your virtual node.

" + }, + "ConflictException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request contains a client token that was used for a previous update resource call\n with different specifications. Try the request again with a new client token.

", + "exception": true, + "error": { + "code": "ConflictException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "HealthCheckIntervalMillis": { + "type": "long", + "box": true, + "min": 5000, + "max": 300000 + }, + "VirtualNodeRef": { + "type": "structure", + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the virtual node.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual node resides.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node.

" + } + }, + "documentation": "

An object representing a virtual node returned by a list operation.

" + }, + "DescribeRouteOutput": { + "type": "structure", + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The full description of your route.

" + } + }, + "documentation": "", + "payload": "route" + }, + "ServiceDiscovery": { + "type": "structure", + "members": { + "dns": { + "shape": "DnsServiceDiscovery", + "documentation": "

Specifies the DNS service name for the virtual node.

" + } + }, + "documentation": "

An object representing the service discovery information for a virtual node.

" + }, + "MeshStatus": { + "type": "structure", + "members": { + "status": { + "shape": "MeshStatusCode", + "documentation": "

The current mesh status.

" + } + }, + "documentation": "

An object representing the status of a service mesh.

" + }, + "VirtualNodeData": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual node resides.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the virtual node.

" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The specifications of the virtual node.

" + }, + "status": { + "shape": "VirtualNodeStatus", + "documentation": "

The current status for the virtual node.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node.

" + } + }, + "documentation": "

An object representing a virtual node returned by a describe operation.

" + }, + "VirtualNodeSpec": { + "type": "structure", + "members": { + "backends": { + "shape": "Backends", + "documentation": "

The backends to which the virtual node is expected to send outbound traffic.

" + }, + "listeners": { + "shape": "Listeners", + "documentation": "

The listeners from which the virtual node is expected to receive inbound traffic.

" + }, + "serviceDiscovery": { + "shape": "ServiceDiscovery", + "documentation": "

The service discovery information for the virtual node.

" + } + }, + "documentation": "

An object representing the specification of a virtual node.

" + }, + "ServiceNames": { + "type": "list", + "member": { + "shape": "ServiceName" + }, + "max": 10 + }, + "MeshRef": { + "type": "structure", + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) of the service mesh.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh.

" + } + }, + "documentation": "

An object representing a service mesh returned by a list operation.

" + }, + "DescribeVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual router resides.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to describe.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "DescribeVirtualRouterOutput": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The full description of your virtual router.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "LimitExceededException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You have exceeded a service limit for your account. For more information, see Service Limits in the AWS App Mesh User Guide.

", + "exception": true, + "error": { + "code": "LimitExceededException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "UpdateRouteOutput": { + "type": "structure", + "members": { + "route": { + "shape": "RouteData", + "documentation": "

A full description of the route that was updated.

" + } + }, + "documentation": "", + "payload": "route" + }, + "HttpRouteAction": { + "type": "structure", + "members": { + "weightedTargets": { + "shape": "WeightedTargets", + "documentation": "

The targets that traffic is routed to when a request matches the route. You can specify\n one or more targets and their relative weights with which to distribute traffic.

" + } + }, + "documentation": "

An object representing the traffic distribution requirements for matched HTTP\n requests.

" + }, + "CreateVirtualRouterOutput": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The full description of your virtual router following the create call.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "HealthCheckTimeoutMillis": { + "type": "long", + "box": true, + "min": 2000, + "max": 60000 + }, + "CreateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to create the virtual router.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The virtual router specification to apply.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name to use for the virtual router.

" + } + }, + "documentation": "" + }, + "RouteStatus": { + "type": "structure", + "members": { + "status": { + "shape": "RouteStatusCode", + "documentation": "

The current status for the route.

" + } + }, + "documentation": "

An object representing the current status of a route.

" + }, + "ListMeshesInput": { + "type": "structure", + "members": { + "limit": { + "shape": "ListMeshesLimit", + "documentation": "

The maximum number of mesh results returned by ListMeshes in paginated\n output. When this parameter is used, ListMeshes only returns\n limit results in a single page along with a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n ListMeshes request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter is not\n used, then ListMeshes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListMeshes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "VirtualRouterStatus": { + "type": "structure", + "members": { + "status": { + "shape": "VirtualRouterStatusCode", + "documentation": "

The current status of the virtual router.

" + } + }, + "documentation": "

An object representing the status of a virtual router.

" + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between requests.

", + "exception": true, + "error": { + "code": "TooManyRequestsException", + "httpStatusCode": 429, + "senderFault": true + } + }, + "ListMeshesOutput": { + "type": "structure", + "required": [ + "meshes" + ], + "members": { + "meshes": { + "shape": "MeshList", + "documentation": "

The list of existing service meshes.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListMeshes\n request. When the results of a ListMeshes request exceed\n limit, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + } + }, + "documentation": "" + }, + "DescribeVirtualNodeOutput": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The full description of your virtual node.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "CreateMeshOutput": { + "type": "structure", + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The full description of your service mesh following the create call.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "ResourceName": { + "type": "string", + "min": 1, + "max": 255 + }, + "RouteData": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the route resides.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the route.

" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route.

" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The specifications of the route.

" + }, + "status": { + "shape": "RouteStatus", + "documentation": "

The status of the route.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The virtual router with which the route is associated.

" + } + }, + "documentation": "

An object representing a route returned by a describe operation.

" + }, + "Arn": { + "type": "string" + }, + "NotFoundException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The specified resource does not exist. Check your request syntax and try again.

", + "exception": true, + "error": { + "code": "NotFoundException", + "httpStatusCode": 404, + "senderFault": true + } + }, + "UpdateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual node resides.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The new virtual node specification to apply. This overwrites the existing data.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to update.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "DeleteRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to delete the route.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to delete.

", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router in which to delete the route.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request has failed due to a temporary failure of the service.

", + "exception": true, + "error": { + "code": "ServiceUnavailableException", + "httpStatusCode": 503, + "fault": true + } + }, + "Listeners": { + "type": "list", + "member": { + "shape": "Listener" + } + }, + "ListRoutesInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "limit": { + "shape": "ListRoutesLimit", + "documentation": "

The maximum number of mesh results returned by ListRoutes in paginated\n output. When this parameter is used, ListRoutes only returns\n limit results in a single page along with a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n ListRoutes request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter is not\n used, then ListRoutes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to list routes.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListRoutes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router in which to list routes.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "HttpRoute": { + "type": "structure", + "members": { + "action": { + "shape": "HttpRouteAction", + "documentation": "

The action to take if a match is determined.

" + }, + "match": { + "shape": "HttpRouteMatch", + "documentation": "

The criteria for determining an HTTP request match.

" + } + }, + "documentation": "

An object representing the HTTP routing specification for a route.

" + }, + "Timestamp": { + "type": "timestamp" + }, + "ListRoutesOutput": { + "type": "structure", + "required": [ + "routes" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListRoutes\n request. When the results of a ListRoutes request exceed\n limit, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + }, + "routes": { + "shape": "RouteList", + "documentation": "

The list of existing routes for the specified service mesh and virtual router.

" + } + }, + "documentation": "" + }, + "RouteSpec": { + "type": "structure", + "members": { + "httpRoute": { + "shape": "HttpRoute", + "documentation": "

The HTTP routing information for the route.

" + } + }, + "documentation": "

An object representing the specification of a route.

" + }, + "DescribeVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual node resides.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to describe.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "VirtualRouterRef": { + "type": "structure", + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the virtual router.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual router resides.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router.

" + } + }, + "documentation": "

An object representing a virtual router returned by a list operation.

" + }, + "VirtualRouterStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "ListVirtualNodesOutput": { + "type": "structure", + "required": [ + "virtualNodes" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualNodes\n request. When the results of a ListVirtualNodes request exceed\n limit, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + }, + "virtualNodes": { + "shape": "VirtualNodeList", + "documentation": "

The list of existing virtual nodes for the specified service mesh.

" + } + }, + "documentation": "" + }, + "DeleteVirtualNodeOutput": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The virtual node that was deleted.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "UpdateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual router resides.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The new virtual router specification to apply. This overwrites the existing data.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to update.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You cannot delete the specified resource because it is in use or required by another resource.

", + "exception": true, + "error": { + "code": "ResourceInUseException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "DescribeRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the route resides.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to describe.

", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router with which the route is associated.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "ListVirtualRoutersOutput": { + "type": "structure", + "required": [ + "virtualRouters" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualRouters\n request. When the results of a ListVirtualRouters request exceed\n limit, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to\n return.

" + }, + "virtualRouters": { + "shape": "VirtualRouterList", + "documentation": "

The list of existing virtual routers for the specified service mesh.

" + } + }, + "documentation": "" + }, + "CreateVirtualNodeOutput": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The full description of your virtual node following the create call.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "DeleteVirtualRouterOutput": { + "type": "structure", + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The virtual router that was deleted.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "ListRoutesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "PortProtocol": { + "type": "string", + "enum": [ + "http", + "tcp" + ] + }, + "MeshList": { + "type": "list", + "member": { + "shape": "MeshRef" + } + }, + "ResourceMetadata": { + "type": "structure", + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the resource.

\n \n

After you create a virtual node, set this value (either the full ARN or the\n truncated resource name, for example, mesh/default/virtualNode/simpleapp,\n as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's\n Envoy proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n

If you require your Envoy stats or tracing to use a different name, you can override\n the node.cluster value that is set by\n APPMESH_VIRTUAL_NODE_NAME with the\n APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

\n " + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + }, + "lastUpdatedAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was last updated.

" + }, + "uid": { + "shape": "String", + "documentation": "

The unique identifier for the resource.

" + }, + "version": { + "shape": "Long", + "documentation": "

The version of the resource. Resources are created at version 1, and this version is\n incremented each time they are updated.

" + } + }, + "documentation": "

An object representing metadata for a resource.

" + }, + "CreateMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name to use for the service mesh.

" + } + }, + "documentation": "" + }, + "PortMapping": { + "type": "structure", + "members": { + "port": { + "shape": "PortNumber", + "documentation": "

The port used for the port mapping.

" + }, + "protocol": { + "shape": "PortProtocol", + "documentation": "

The protocol used for the port mapping.

" + } + }, + "documentation": "

An object representing a virtual node listener port mapping.

" + }, + "VirtualNodeStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "DeleteVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to delete the virtual router.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to delete.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "VirtualRouterSpec": { + "type": "structure", + "members": { + "serviceNames": { + "shape": "ServiceNames", + "documentation": "

The service mesh service names to associate with the virtual router.

" + } + }, + "documentation": "

An object representing the specification of a virtual router.

" + }, + "UpdateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the route resides.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to update.

", + "location": "uri", + "locationName": "routeName" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The new route specification to apply. This overwrites the existing data.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router with which the route is associated.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "PercentInt": { + "type": "integer", + "min": 0, + "max": 100 + }, + "ListMeshesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DescribeMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to describe.

", + "location": "uri", + "locationName": "meshName" + } + }, + "documentation": "" + }, + "DescribeMeshOutput": { + "type": "structure", + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The full description of your service mesh.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "VirtualRouterData": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the virtual router resides.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the virtual router.

" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The specifications of the virtual router.

" + }, + "status": { + "shape": "VirtualRouterStatus", + "documentation": "

The current status of the virtual router.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router.

" + } + }, + "documentation": "

An object representing a virtual router returned by a describe operation.

" + }, + "VirtualRouterList": { + "type": "list", + "member": { + "shape": "VirtualRouterRef" + } + }, + "Listener": { + "type": "structure", + "members": { + "healthCheck": { + "shape": "HealthCheckPolicy", + "documentation": "

The health check information for the listener.

" + }, + "portMapping": { + "shape": "PortMapping", + "documentation": "

The port mapping information for the listener.

" + } + }, + "documentation": "

An object representing a listener for a virtual node.

" + }, + "String": { + "type": "string" + }, + "HealthCheckPolicy": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "shape": "HealthCheckThreshold", + "documentation": "

The number of consecutive successful health checks that must occur before declaring\n listener healthy.

" + }, + "intervalMillis": { + "shape": "HealthCheckIntervalMillis", + "documentation": "

The time period in milliseconds between each health check execution.

" + }, + "path": { + "shape": "String", + "documentation": "

The destination path for the health check request. This is only required if the\n specified protocol is HTTP; if the protocol is TCP, then this parameter is ignored.

" + }, + "port": { + "shape": "PortNumber", + "documentation": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

" + }, + "protocol": { + "shape": "PortProtocol", + "documentation": "

The protocol for the health check request.

" + }, + "timeoutMillis": { + "shape": "HealthCheckTimeoutMillis", + "documentation": "

The amount of time to wait when receiving a response from the health check, in\n milliseconds.

" + }, + "unhealthyThreshold": { + "shape": "HealthCheckThreshold", + "documentation": "

The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy.

" + } + }, + "documentation": "

An object representing the health check policy for a virtual node's listener.

" + }, + "ListVirtualRoutersInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualRoutersLimit", + "documentation": "

The maximum number of mesh results returned by ListVirtualRouters in\n paginated output. When this parameter is used, ListVirtualRouters only returns\n limit results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListVirtualRouters request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListVirtualRouters returns up to\n 100 results and a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to list virtual routers.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualRouters request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "CreateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to create the virtual node.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The virtual node specification to apply.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name to use for the virtual node.

" + } + }, + "documentation": "" + }, + "BadRequestException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request syntax was malformed. Check your request syntax and try again.

", + "exception": true, + "error": { + "code": "BadRequestException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "MeshData": { + "type": "structure", + "required": [ + "meshName", + "metadata" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the service mesh.

" + }, + "status": { + "shape": "MeshStatus", + "documentation": "

The status of the service mesh.

" + } + }, + "documentation": "

An object representing a service mesh returned by a describe operation.

" + }, + "ListVirtualNodesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "WeightedTargets": { + "type": "list", + "member": { + "shape": "WeightedTarget" + } + }, + "DeleteMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete.

", + "location": "uri", + "locationName": "meshName" + } + }, + "documentation": "" + }, + "HttpRouteMatch": { + "type": "structure", + "members": { + "prefix": { + "shape": "String", + "documentation": "

Specifies the path with which to match requests. This parameter must always start with\n /, which by itself matches all requests to the virtual router service name.\n You can also match for path-based routing of requests. For example, if your virtual router\n service name is my-service.local, and you want the route to match requests to\n my-service.local/metrics, then your prefix should be\n /metrics.

" + } + }, + "documentation": "

An object representing the requirements for a route to match HTTP requests for a virtual\n router.

" + }, + "DeleteRouteOutput": { + "type": "structure", + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The route that was deleted.

" + } + }, + "documentation": "", + "payload": "route" + }, + "Backends": { + "type": "list", + "member": { + "shape": "ServiceName" + } + }, + "CreateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to create the route.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name to use for the route.

" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The route specification to apply.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router in which to create the route.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "VirtualNodeStatus": { + "type": "structure", + "members": { + "status": { + "shape": "VirtualNodeStatusCode", + "documentation": "

The current status of the virtual node.

" + } + }, + "documentation": "

An object representing the current status of the virtual node.

" + }, + "ListVirtualNodesInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualNodesLimit", + "documentation": "

The maximum number of mesh results returned by ListVirtualNodes in\n paginated output. When this parameter is used, ListVirtualNodes only returns\n limit results in a single page along with a nextToken\n response element. The remaining results of the initial request can be seen by sending\n another ListVirtualNodes request with the returned nextToken\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListVirtualNodes returns up to\n 100 results and a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which to list virtual nodes.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualNodes request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "RouteRef": { + "type": "structure", + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the route.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh in which the route resides.

" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The virtual router with which the route is associated.

" + } + }, + "documentation": "

An object representing a route returned by a list operation.

" + }, + "RouteStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "UpdateVirtualNodeOutput": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

A full description of the virtual node that was updated.

" + } + }, + "documentation": "", + "payload": "virtualNode" + } + } +} diff --git a/aws/dist/botocore/data/appmesh/2019-01-25/paginators-1.json b/aws/dist/botocore/data/appmesh/2019-01-25/paginators-1.json new file mode 100644 index 00000000..88d8fcc7 --- /dev/null +++ b/aws/dist/botocore/data/appmesh/2019-01-25/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListMeshes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "meshes" + }, + "ListRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "routes" + }, + "ListVirtualNodes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualNodes" + }, + "ListVirtualRouters": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualRouters" + }, + "ListVirtualServices": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualServices" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "tags" + } + } +} diff --git a/aws/dist/botocore/data/appmesh/2019-01-25/service-2.json b/aws/dist/botocore/data/appmesh/2019-01-25/service-2.json new file mode 100644 index 00000000..b2cf20c4 --- /dev/null +++ b/aws/dist/botocore/data/appmesh/2019-01-25/service-2.json @@ -0,0 +1,3833 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-01-25", + "endpointPrefix": "appmesh", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS App Mesh", + "serviceId": "App Mesh", + "signatureVersion": "v4", + "signingName": "appmesh", + "uid": "appmesh-2019-01-25" + }, + "documentation": "

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.

\n

App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on AWS, and Amazon EC2.

\n \n

App Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see Service Discovery in the\n Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and\n coredns are supported. For more information, see DNS\n for Services and Pods in the Kubernetes documentation.

\n ", + "operations": { + "CreateMesh": { + "name": "CreateMesh", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "shape": "CreateMeshInput" + }, + "output": { + "shape": "CreateMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a service mesh. A service mesh is a logical boundary for network traffic between\n the services that reside within it.

\n

After you create your service mesh, you can create virtual services, virtual nodes,\n virtual routers, and routes to distribute traffic between the applications in your\n mesh.

", + "idempotent": true + }, + "CreateRoute": { + "name": "CreateRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "CreateRouteInput" + }, + "output": { + "shape": "CreateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a route that is associated with a virtual router.

\n

You can use the prefix parameter in your route specification for path-based\n routing of requests. For example, if your virtual service name is\n my-service.local and you want the route to match requests to\n my-service.local/metrics, your prefix should be\n /metrics.

\n

If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.

", + "idempotent": true + }, + "CreateVirtualNode": { + "name": "CreateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualNodeInput" + }, + "output": { + "shape": "CreateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a virtual node within a service mesh.

\n

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group.

\n

Any inbound traffic that your virtual node expects should be specified as a\n listener. Any outbound traffic that your virtual node expects to reach\n should be specified as a backend.

\n

The response metadata for your new virtual node contains the arn that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name: for example, mesh/default/virtualNode/simpleapp) as the\n APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n node.id and node.cluster Envoy parameters.

\n \n

If you require your Envoy stats or tracing to use a different name, you can override\n the node.cluster value that is set by\n APPMESH_VIRTUAL_NODE_NAME with the\n APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

\n ", + "idempotent": true + }, + "CreateVirtualRouter": { + "name": "CreateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualRouterInput" + }, + "output": { + "shape": "CreateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a virtual router within a service mesh.

\n

Any inbound traffic that your virtual router expects should be specified as a\n listener.

\n

Virtual routers handle traffic for one or more virtual services within your mesh. After\n you create your virtual router, create and associate routes for your virtual router that\n direct incoming requests to different virtual nodes.

", + "idempotent": true + }, + "CreateVirtualService": { + "name": "CreateVirtualService", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualServiceInput" + }, + "output": { + "shape": "CreateVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a virtual service within a service mesh.

\n

A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its virtualServiceName, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.

", + "idempotent": true + }, + "DeleteMesh": { + "name": "DeleteMesh", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteMeshInput" + }, + "output": { + "shape": "DeleteMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing service mesh.

\n

You must delete all resources (virtual services, routes, virtual routers, and virtual\n nodes) in the service mesh before you can delete the mesh itself.

", + "idempotent": true + }, + "DeleteRoute": { + "name": "DeleteRoute", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteRouteInput" + }, + "output": { + "shape": "DeleteRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing route.

", + "idempotent": true + }, + "DeleteVirtualNode": { + "name": "DeleteVirtualNode", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualNodeInput" + }, + "output": { + "shape": "DeleteVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual node.

\n

You must delete any virtual services that list a virtual node as a service provider\n before you can delete the virtual node itself.

", + "idempotent": true + }, + "DeleteVirtualRouter": { + "name": "DeleteVirtualRouter", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualRouterInput" + }, + "output": { + "shape": "DeleteVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual router.

\n

You must delete any routes associated with the virtual router before you can delete the\n router itself.

", + "idempotent": true + }, + "DeleteVirtualService": { + "name": "DeleteVirtualService", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualServiceInput" + }, + "output": { + "shape": "DeleteVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual service.

", + "idempotent": true + }, + "DescribeMesh": { + "name": "DescribeMesh", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeMeshInput" + }, + "output": { + "shape": "DescribeMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing service mesh.

" + }, + "DescribeRoute": { + "name": "DescribeRoute", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeRouteInput" + }, + "output": { + "shape": "DescribeRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing route.

" + }, + "DescribeVirtualNode": { + "name": "DescribeVirtualNode", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualNodeInput" + }, + "output": { + "shape": "DescribeVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual node.

" + }, + "DescribeVirtualRouter": { + "name": "DescribeVirtualRouter", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualRouterInput" + }, + "output": { + "shape": "DescribeVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual router.

" + }, + "DescribeVirtualService": { + "name": "DescribeVirtualService", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualServiceInput" + }, + "output": { + "shape": "DescribeVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual service.

" + }, + "ListMeshes": { + "name": "ListMeshes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes", + "responseCode": 200 + }, + "input": { + "shape": "ListMeshesInput" + }, + "output": { + "shape": "ListMeshesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing service meshes.

" + }, + "ListRoutes": { + "name": "ListRoutes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes", + "responseCode": 200 + }, + "input": { + "shape": "ListRoutesInput" + }, + "output": { + "shape": "ListRoutesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing routes in a service mesh.

" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/v20190125/tags", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceInput" + }, + "output": { + "shape": "ListTagsForResourceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

List the tags for an App Mesh resource.

" + }, + "ListVirtualNodes": { + "name": "ListVirtualNodes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualNodesInput" + }, + "output": { + "shape": "ListVirtualNodesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual nodes.

" + }, + "ListVirtualRouters": { + "name": "ListVirtualRouters", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualRoutersInput" + }, + "output": { + "shape": "ListVirtualRoutersOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual routers in a service mesh.

" + }, + "ListVirtualServices": { + "name": "ListVirtualServices", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualServicesInput" + }, + "output": { + "shape": "ListVirtualServicesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual services in a service mesh.

" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "PUT", + "requestUri": "/v20190125/tag", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceInput" + }, + "output": { + "shape": "TagResourceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + }, + { + "shape": "TooManyTagsException" + } + ], + "documentation": "

Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.

", + "idempotent": true + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "PUT", + "requestUri": "/v20190125/untag", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceInput" + }, + "output": { + "shape": "UntagResourceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes specified tags from a resource.

", + "idempotent": true + }, + "UpdateMesh": { + "name": "UpdateMesh", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateMeshInput" + }, + "output": { + "shape": "UpdateMeshOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing service mesh.

", + "idempotent": true + }, + "UpdateRoute": { + "name": "UpdateRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateRouteInput" + }, + "output": { + "shape": "UpdateRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing route for a specified service mesh and virtual router.

", + "idempotent": true + }, + "UpdateVirtualNode": { + "name": "UpdateVirtualNode", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualNodes/{virtualNodeName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualNodeInput" + }, + "output": { + "shape": "UpdateVirtualNodeOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual node in a specified service mesh.

", + "idempotent": true + }, + "UpdateVirtualRouter": { + "name": "UpdateVirtualRouter", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualRouters/{virtualRouterName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualRouterInput" + }, + "output": { + "shape": "UpdateVirtualRouterOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual router in a specified service mesh.

", + "idempotent": true + }, + "UpdateVirtualService": { + "name": "UpdateVirtualService", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualServices/{virtualServiceName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualServiceInput" + }, + "output": { + "shape": "UpdateVirtualServiceOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual service in a specified service mesh.

", + "idempotent": true + } + }, + "shapes": { + "VirtualRouterListener": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "portMapping": { + "shape": "PortMapping" + } + }, + "documentation": "

An object that represents a virtual router listener.

" + }, + "UpdateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual node resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The new virtual node specification to apply. This overwrites the existing data.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to update.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "DeleteMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete.

", + "location": "uri", + "locationName": "meshName" + } + }, + "documentation": "" + }, + "TcpRetryPolicyEvents": { + "type": "list", + "member": { + "shape": "TcpRetryPolicyEvent" + }, + "min": 1, + "max": 1 + }, + "CreateVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the virtual service in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualServiceSpec", + "documentation": "

The virtual service specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the virtual service to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name to use for the virtual service.

" + } + }, + "documentation": "" + }, + "VirtualRouterStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "UpdateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual router resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The new virtual router specification to apply. This overwrites the existing data.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to update.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "TagKeyList": { + "type": "list", + "member": { + "shape": "TagKey" + }, + "min": 0, + "max": 50 + }, + "GrpcRetryPolicy": { + "type": "structure", + "required": [ + "maxRetries", + "perRetryTimeout" + ], + "members": { + "grpcRetryEvents": { + "shape": "GrpcRetryPolicyEvents", + "documentation": "

Specify at least one of the valid values.

" + }, + "httpRetryEvents": { + "shape": "HttpRetryPolicyEvents", + "documentation": "

Specify at least one of the following values.

\n
    \n
  • \n

    \n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511

    \n
    • \n
  • \n

    \n gateway-error – HTTP status codes 502,\n 503, and 504

    \n
    • \n
  • \n

    \n client-error – HTTP status code 409

    \n
    • \n
  • \n

    \n stream-error – Retry on refused\n stream

    \n
    • \n
" + }, + "maxRetries": { + "shape": "MaxRetries", + "documentation": "

The maximum number of retry attempts.

" + }, + "perRetryTimeout": { + "shape": "Duration", + "documentation": "

An object that represents a duration of time.

" + }, + "tcpRetryEvents": { + "shape": "TcpRetryPolicyEvents", + "documentation": "

Specify a valid value.

" + } + }, + "documentation": "

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout.

" + }, + "ListTagsForResourceInput": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "limit": { + "shape": "TagsLimit", + "documentation": "

The maximum number of tag results returned by ListTagsForResource in\n paginated output. When this parameter is used, ListTagsForResource returns\n only limit results in a single page along with a nextToken\n response element. You can see the remaining results of the initial request by sending\n another ListTagsForResource request with the returned nextToken\n value. This value can be between 1 and 100. If you don't use\n this parameter, ListTagsForResource returns up to 100\n results and a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListTagsForResource request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + }, + "resourceArn": { + "shape": "Arn", + "documentation": "

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

", + "location": "querystring", + "locationName": "resourceArn" + } + }, + "documentation": "" + }, + "CreateVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The full description of your virtual node following the create call.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "Logging": { + "type": "structure", + "members": { + "accessLog": { + "shape": "AccessLog", + "documentation": "

The access log configuration for a virtual node.

" + } + }, + "documentation": "

An object that represents the logging information for a virtual node.

" + }, + "GrpcRetryPolicyEvents": { + "type": "list", + "member": { + "shape": "GrpcRetryPolicyEvent" + }, + "min": 1, + "max": 5 + }, + "ServiceUnavailableException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request has failed due to a temporary failure of the service.

", + "exception": true, + "error": { + "code": "ServiceUnavailableException", + "httpStatusCode": 503, + "fault": true + } + }, + "Long": { + "type": "long", + "box": true + }, + "UpdateVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

A full description of the virtual router that was updated.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "DescribeMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The full description of your service mesh.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "DeleteVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the virtual router in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to delete.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "ListVirtualRoutersOutput": { + "type": "structure", + "required": [ + "virtualRouters" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualRouters\n request. When the results of a ListVirtualRouters request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + }, + "virtualRouters": { + "shape": "VirtualRouterList", + "documentation": "

The list of existing virtual routers for the specified service mesh.

" + } + }, + "documentation": "" + }, + "DescribeRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the route resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to describe.

", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router that the route is associated with.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "DeleteRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The route that was deleted.

" + } + }, + "documentation": "", + "payload": "route" + }, + "ResourceMetadata": { + "type": "structure", + "required": [ + "arn", + "createdAt", + "lastUpdatedAt", + "uid", + "version" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the resource.

" + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + }, + "lastUpdatedAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was last updated.

" + }, + "uid": { + "shape": "String", + "documentation": "

The unique identifier for the resource.

" + }, + "version": { + "shape": "Long", + "documentation": "

The version of the resource. Resources are created at version 1, and this version is\n incremented each time that they're updated.

" + } + }, + "documentation": "

An object that represents metadata for a resource.

" + }, + "Listeners": { + "type": "list", + "member": { + "shape": "Listener" + }, + "min": 0, + "max": 1 + }, + "Backends": { + "type": "list", + "member": { + "shape": "Backend" + }, + "min": 0, + "max": 25 + }, + "ResourceInUseException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You can't delete the specified resource because it's in use or required by another\n resource.

", + "exception": true, + "error": { + "code": "ResourceInUseException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "PortProtocol": { + "type": "string", + "enum": [ + "grpc", + "http", + "http2", + "tcp" + ] + }, + "UpdateVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

A full description of the virtual node that was updated.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "ListRoutesOutput": { + "type": "structure", + "required": [ + "routes" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListRoutes request.\n When the results of a ListRoutes request exceed limit, you can\n use this value to retrieve the next page of results. This value is null when\n there are no more results to return.

" + }, + "routes": { + "shape": "RouteList", + "documentation": "

The list of existing routes for the specified service mesh and virtual router.

" + } + }, + "documentation": "" + }, + "VirtualServiceBackend": { + "type": "structure", + "required": [ + "virtualServiceName" + ], + "members": { + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service that is acting as a virtual node backend.

" + } + }, + "documentation": "

An object that represents a virtual service backend for a virtual node.

" + }, + "VirtualNodeStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "ServiceName": { + "type": "string" + }, + "BadRequestException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request syntax was malformed. Check your request syntax and try again.

", + "exception": true, + "error": { + "code": "BadRequestException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "UpdateVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualServiceName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual service resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualServiceSpec", + "documentation": "

The new virtual service specification to apply. This overwrites the existing\n data.

" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service to update.

", + "location": "uri", + "locationName": "virtualServiceName" + } + }, + "documentation": "" + }, + "HealthCheckThreshold": { + "type": "integer", + "min": 2, + "max": 10 + }, + "UpdateRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData", + "documentation": "

A full description of the route that was updated.

" + } + }, + "documentation": "", + "payload": "route" + }, + "PercentInt": { + "type": "integer", + "min": 0, + "max": 100 + }, + "GrpcRouteMetadataList": { + "type": "list", + "member": { + "shape": "GrpcRouteMetadata" + }, + "min": 1, + "max": 10 + }, + "MethodName": { + "type": "string", + "min": 1, + "max": 50 + }, + "TagValue": { + "type": "string", + "min": 0, + "max": 256 + }, + "HttpRouteAction": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "WeightedTargets", + "documentation": "

An object that represents the targets that traffic is routed to when a request matches the route.

" + } + }, + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "ListRoutesInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "limit": { + "shape": "ListRoutesLimit", + "documentation": "

The maximum number of results returned by ListRoutes in paginated output.\n When you use this parameter, ListRoutes returns only limit\n results in a single page along with a nextToken response element. You can see\n the remaining results of the initial request by sending another ListRoutes\n request with the returned nextToken value. This value can be between\n 1 and 100. If you don't use this parameter,\n ListRoutes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list routes in.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListRoutes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to list routes in.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "HealthCheckPolicy": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "shape": "HealthCheckThreshold", + "documentation": "

The number of consecutive successful health checks that must occur before declaring\n listener healthy.

" + }, + "intervalMillis": { + "shape": "HealthCheckIntervalMillis", + "documentation": "

The time period in milliseconds between each health check execution.

" + }, + "path": { + "shape": "String", + "documentation": "

The destination path for the health check request. This is required only if the\n specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

" + }, + "port": { + "shape": "PortNumber", + "documentation": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

" + }, + "protocol": { + "shape": "PortProtocol", + "documentation": "

The protocol for the health check request.

" + }, + "timeoutMillis": { + "shape": "HealthCheckTimeoutMillis", + "documentation": "

The amount of time to wait when receiving a response from the health check, in\n milliseconds.

" + }, + "unhealthyThreshold": { + "shape": "HealthCheckThreshold", + "documentation": "

The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy.

" + } + }, + "documentation": "

An object that represents the health check policy for a virtual node's listener.

" + }, + "VirtualServiceRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualServiceName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the virtual service.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual service resides in.

" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service.

" + } + }, + "documentation": "

An object that represents a virtual service returned by a list operation.

" + }, + "EgressFilter": { + "type": "structure", + "required": [ + "type" + ], + "members": { + "type": { + "shape": "EgressFilterType", + "documentation": "

The egress filter type. By default, the type is DROP_ALL, which allows\n egress only from virtual nodes to other defined resources in the service mesh (and any\n traffic to *.amazonaws.com for AWS API calls). You can set the egress filter\n type to ALLOW_ALL to allow egress to any endpoint inside or outside of the\n service mesh.

" + } + }, + "documentation": "

An object that represents the egress filter rules for a service mesh.

" + }, + "VirtualServiceList": { + "type": "list", + "member": { + "shape": "VirtualServiceRef" + } + }, + "VirtualNodeStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualNodeStatusCode", + "documentation": "

The current status of the virtual node.

" + } + }, + "documentation": "

An object that represents the current status of the virtual node.

" + }, + "VirtualRouterRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualRouterName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the virtual router.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual router resides in.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router.

" + } + }, + "documentation": "

An object that represents a virtual router returned by a list operation.

" + }, + "VirtualServiceData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual service resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "VirtualServiceSpec", + "documentation": "

The specifications of the virtual service.

" + }, + "status": { + "shape": "VirtualServiceStatus", + "documentation": "

The current status of the virtual service.

" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service.

" + } + }, + "documentation": "

An object that represents a virtual service returned by a describe operation.

" + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "HttpRouteHeader": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "invert": { + "shape": "Boolean", + "documentation": "

Specify True to match anything except the match criteria. The default value is False.

" + }, + "match": { + "shape": "HeaderMatchMethod", + "documentation": "

The HeaderMatchMethod object.

" + }, + "name": { + "shape": "HeaderName", + "documentation": "

A name for the HTTP header in the client request that will be matched on.

" + } + }, + "documentation": "

An object that represents the HTTP header in the request.

" + }, + "HttpRetryPolicyEvent": { + "type": "string", + "min": 1, + "max": 25 + }, + "DescribeVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData", + "documentation": "

The full description of your virtual service.

" + } + }, + "documentation": "", + "payload": "virtualService" + }, + "FilePath": { + "type": "string", + "min": 1, + "max": 255 + }, + "AwsCloudMapInstanceAttributes": { + "type": "list", + "member": { + "shape": "AwsCloudMapInstanceAttribute" + } + }, + "VirtualNodeRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "virtualNodeName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the virtual node.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual node resides in.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node.

" + } + }, + "documentation": "

An object that represents a virtual node returned by a list operation.

" + }, + "CreateMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name to use for the service mesh.

" + }, + "spec": { + "shape": "MeshSpec", + "documentation": "

The service mesh specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the service mesh to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "documentation": "" + }, + "GrpcRouteAction": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "WeightedTargets", + "documentation": "

An object that represents the targets that traffic is routed to when a request matches the route.

" + } + }, + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "DescribeVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The full description of your virtual node.

" + } + }, + "documentation": "", + "payload": "virtualNode" + }, + "AwsCloudMapName": { + "type": "string", + "min": 1, + "max": 1024, + "pattern": "((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^.$)" + }, + "LimitExceededException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You have exceeded a service limit for your account. For more information, see Service\n Limits in the AWS App Mesh User Guide.

", + "exception": true, + "error": { + "code": "LimitExceededException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "UpdateMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData" + } + }, + "documentation": "", + "payload": "mesh" + }, + "CreateRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The full description of your mesh following the create call.

" + } + }, + "documentation": "", + "payload": "route" + }, + "GrpcRouteMetadataMatchMethod": { + "type": "structure", + "members": { + "exact": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must match the specified value exactly.

" + }, + "prefix": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must begin with the specified characters.

" + }, + "range": { + "shape": "MatchRange", + "documentation": "

An object that represents the range of values to match on.

" + }, + "regex": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must include the specified characters.

" + }, + "suffix": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must end with the specified characters.

" + } + }, + "documentation": "

An object that represents the match method. Specify one of the match values.

" + }, + "DnsServiceDiscovery": { + "type": "structure", + "required": [ + "hostname" + ], + "members": { + "hostname": { + "shape": "Hostname", + "documentation": "

Specifies the DNS service discovery hostname for the virtual node.

" + } + }, + "documentation": "

An object that represents the DNS service discovery information for your virtual\n node.

" + }, + "DescribeVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual service resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service to describe.

", + "location": "uri", + "locationName": "virtualServiceName" + } + }, + "documentation": "" + }, + "ListVirtualServicesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DeleteRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the route in.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to delete.

", + "location": "uri", + "locationName": "routeName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to delete the route in.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "VirtualNodeData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual node resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the virtual node.

" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The specifications of the virtual node.

" + }, + "status": { + "shape": "VirtualNodeStatus", + "documentation": "

The current status for the virtual node.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node.

" + } + }, + "documentation": "

An object that represents a virtual node returned by a describe operation.

" + }, + "UntagResourceOutput": { + "type": "structure", + "members": { }, + "documentation": "" + }, + "AwsCloudMapInstanceAttribute": { + "type": "structure", + "required": [ + "key", + "value" + ], + "members": { + "key": { + "shape": "AwsCloudMapInstanceAttributeKey", + "documentation": "

The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.

" + }, + "value": { + "shape": "AwsCloudMapInstanceAttributeValue", + "documentation": "

The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.

" + } + }, + "documentation": "

An object that represents the AWS Cloud Map attribute information for your virtual\n node.

" + }, + "TcpRetryPolicyEvent": { + "type": "string", + "enum": [ + "connection-error" + ] + }, + "VirtualServiceSpec": { + "type": "structure", + "members": { + "provider": { + "shape": "VirtualServiceProvider", + "documentation": "

The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.

" + } + }, + "documentation": "

An object that represents the specification of a virtual service.

" + }, + "Backend": { + "type": "structure", + "members": { + "virtualService": { + "shape": "VirtualServiceBackend", + "documentation": "

Specifies a virtual service to use as a backend for a virtual node.

" + } + }, + "documentation": "

An object that represents the backends that a virtual node is expected to send outbound\n traffic to.

" + }, + "MatchRange": { + "type": "structure", + "required": [ + "end", + "start" + ], + "members": { + "end": { + "shape": "Long", + "documentation": "

The end of the range.

" + }, + "start": { + "shape": "Long", + "documentation": "

The start of the range.

" + } + }, + "documentation": "

An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

" + }, + "ListVirtualRoutersLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "HealthCheckIntervalMillis": { + "type": "long", + "box": true, + "min": 5000, + "max": 300000 + }, + "VirtualRouterList": { + "type": "list", + "member": { + "shape": "VirtualRouterRef" + } + }, + "ListMeshesInput": { + "type": "structure", + "members": { + "limit": { + "shape": "ListMeshesLimit", + "documentation": "

The maximum number of results returned by ListMeshes in paginated output.\n When you use this parameter, ListMeshes returns only limit\n results in a single page along with a nextToken response element. You can see\n the remaining results of the initial request by sending another ListMeshes\n request with the returned nextToken value. This value can be between\n 1 and 100. If you don't use this parameter,\n ListMeshes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListMeshes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

\n \n

This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.

\n ", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "Arn": { + "type": "string" + }, + "TcpRoute": { + "type": "structure", + "required": [ + "action" + ], + "members": { + "action": { + "shape": "TcpRouteAction", + "documentation": "

The action to take if a match is determined.

" + } + }, + "documentation": "

An object that represents a TCP route type.

" + }, + "VirtualNodeList": { + "type": "list", + "member": { + "shape": "VirtualNodeRef" + } + }, + "ListVirtualRoutersInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualRoutersLimit", + "documentation": "

The maximum number of results returned by ListVirtualRouters in paginated\n output. When you use this parameter, ListVirtualRouters returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualRouters request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this\n parameter, ListVirtualRouters returns up to 100 results and\n a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list virtual routers in.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualRouters request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "VirtualRouterData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual router resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the virtual router.

" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The specifications of the virtual router.

" + }, + "status": { + "shape": "VirtualRouterStatus", + "documentation": "

The current status of the virtual router.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router.

" + } + }, + "documentation": "

An object that represents a virtual router returned by a describe operation.

" + }, + "UpdateMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to update.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "MeshSpec", + "documentation": "

The service mesh specification to apply.

" + } + }, + "documentation": "" + }, + "DurationUnit": { + "type": "string", + "enum": [ + "ms", + "s" + ] + }, + "RoutePriority": { + "type": "integer", + "box": true, + "min": 0, + "max": 1000 + }, + "ListVirtualServicesInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualServicesLimit", + "documentation": "

The maximum number of results returned by ListVirtualServices in paginated\n output. When you use this parameter, ListVirtualServices returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualServices request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this\n parameter, ListVirtualServices returns up to 100 results and\n a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list virtual services in.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualServices request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "CreateVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the virtual router in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualRouterSpec", + "documentation": "

The virtual router specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the virtual router to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name to use for the virtual router.

" + } + }, + "documentation": "" + }, + "AccessLog": { + "type": "structure", + "members": { + "file": { + "shape": "FileAccessLog", + "documentation": "

The file object to send virtual node access logs to.

" + } + }, + "documentation": "

An object that represents the access logging information for a virtual node.

" + }, + "ListVirtualNodesInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualNodesLimit", + "documentation": "

The maximum number of results returned by ListVirtualNodes in paginated\n output. When you use this parameter, ListVirtualNodes returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualNodes request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this\n parameter, ListVirtualNodes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list virtual nodes in.

", + "location": "uri", + "locationName": "meshName" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualNodes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "" + }, + "DescribeVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The full description of your virtual router.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "CreateMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The full description of your service mesh following the create call.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "CreateVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The full description of your virtual router following the create call.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "VirtualServiceStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualServiceStatusCode", + "documentation": "

The current status of the virtual service.

" + } + }, + "documentation": "

An object that represents the status of a virtual service.

" + }, + "HttpRetryPolicyEvents": { + "type": "list", + "member": { + "shape": "HttpRetryPolicyEvent" + }, + "min": 1, + "max": 25 + }, + "ListVirtualNodesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "HealthCheckTimeoutMillis": { + "type": "long", + "box": true, + "min": 2000, + "max": 60000 + }, + "ListMeshesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "ResourceName": { + "type": "string", + "min": 1, + "max": 255 + }, + "AwsCloudMapInstanceAttributeKey": { + "type": "string", + "min": 1, + "max": 255, + "pattern": "^[a-zA-Z0-9!-~]+$" + }, + "VirtualRouterSpec": { + "type": "structure", + "members": { + "listeners": { + "shape": "VirtualRouterListeners", + "documentation": "

The listeners that the virtual router is expected to receive inbound traffic from.\n You can specify one listener.

" + } + }, + "documentation": "

An object that represents the specification of a virtual router.

" + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.

", + "exception": true, + "error": { + "code": "TooManyRequestsException", + "httpStatusCode": 429, + "senderFault": true + } + }, + "Timestamp": { + "type": "timestamp" + }, + "HeaderMatch": { + "type": "string", + "min": 1, + "max": 255 + }, + "VirtualNodeSpec": { + "type": "structure", + "members": { + "backends": { + "shape": "Backends", + "documentation": "

The backends that the virtual node is expected to send outbound traffic to.

" + }, + "listeners": { + "shape": "Listeners", + "documentation": "

The listeners that the virtual node is expected to receive inbound traffic from.\n You can specify one listener.

" + }, + "logging": { + "shape": "Logging", + "documentation": "

The inbound and outbound access logging information for the virtual node.

" + }, + "serviceDiscovery": { + "shape": "ServiceDiscovery", + "documentation": "

The service discovery information for the virtual node. If your virtual node does not\n expect ingress traffic, you can omit this parameter.

" + } + }, + "documentation": "

An object that represents the specification of a virtual node.

" + }, + "ListMeshesOutput": { + "type": "structure", + "required": [ + "meshes" + ], + "members": { + "meshes": { + "shape": "MeshList", + "documentation": "

The list of existing service meshes.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListMeshes request.\n When the results of a ListMeshes request exceed limit, you can\n use this value to retrieve the next page of results. This value is null when\n there are no more results to return.

" + } + }, + "documentation": "" + }, + "VirtualRouterListeners": { + "type": "list", + "member": { + "shape": "VirtualRouterListener" + }, + "min": 1, + "max": 1 + }, + "HttpMethod": { + "type": "string", + "enum": [ + "CONNECT", + "DELETE", + "GET", + "HEAD", + "OPTIONS", + "PATCH", + "POST", + "PUT", + "TRACE" + ] + }, + "Duration": { + "type": "structure", + "members": { + "unit": { + "shape": "DurationUnit", + "documentation": "

A unit of time.

" + }, + "value": { + "shape": "DurationValue", + "documentation": "

A number of time units.

" + } + }, + "documentation": "

An object that represents a duration of time.

" + }, + "ConflictException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request contains a client token that was used for a previous update resource call\n with different specifications. Try the request again with a new client token.

", + "exception": true, + "error": { + "code": "ConflictException", + "httpStatusCode": 409, + "senderFault": true + } + }, + "DescribeRouteOutput": { + "type": "structure", + "required": [ + "route" + ], + "members": { + "route": { + "shape": "RouteData", + "documentation": "

The full description of your route.

" + } + }, + "documentation": "", + "payload": "route" + }, + "HttpRouteMatch": { + "type": "structure", + "required": [ + "prefix" + ], + "members": { + "headers": { + "shape": "HttpRouteHeaders", + "documentation": "

An object that represents the client request headers to match on.

" + }, + "method": { + "shape": "HttpMethod", + "documentation": "

The client request method to match on. Specify only one.

" + }, + "prefix": { + "shape": "String", + "documentation": "

Specifies the path to match requests with. This parameter must always start with\n /, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is my-service.local and you want the route to match requests to\n my-service.local/metrics, your prefix should be\n /metrics.

" + }, + "scheme": { + "shape": "HttpScheme", + "documentation": "

The client request scheme to match on. Specify only one.

" + } + }, + "documentation": "

An object that represents the requirements for a route to match HTTP requests for a virtual\n router.

" + }, + "MeshList": { + "type": "list", + "member": { + "shape": "MeshRef" + } + }, + "TagRef": { + "type": "structure", + "required": [ + "key" + ], + "members": { + "key": { + "shape": "TagKey", + "documentation": "

One part of a key-value pair that make up a tag. A key is a general label\n that acts like a category for more specific tag values.

" + }, + "value": { + "shape": "TagValue", + "documentation": "

The optional part of a key-value pair that make up a tag. A value acts as a\n descriptor within a tag category (key).

" + } + }, + "documentation": "

Optional metadata that you apply to a resource to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "MeshRef": { + "type": "structure", + "required": [ + "arn", + "meshName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) of the service mesh.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh.

" + } + }, + "documentation": "

An object that represents a service mesh returned by a list operation.

" + }, + "MaxRetries": { + "type": "long", + "box": true, + "min": 0 + }, + "MeshStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "PortMapping": { + "type": "structure", + "required": [ + "port", + "protocol" + ], + "members": { + "port": { + "shape": "PortNumber", + "documentation": "

The port used for the port mapping.

" + }, + "protocol": { + "shape": "PortProtocol", + "documentation": "

The protocol used for the port mapping. Specify one protocol.

" + } + }, + "documentation": "

An object that represents a port mapping.

" + }, + "MeshData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the service mesh.

" + }, + "spec": { + "shape": "MeshSpec", + "documentation": "

The associated specification for the service mesh.

" + }, + "status": { + "shape": "MeshStatus", + "documentation": "

The status of the service mesh.

" + } + }, + "documentation": "

An object that represents a service mesh returned by a describe operation.

" + }, + "VirtualRouterStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualRouterStatusCode", + "documentation": "

The current status of the virtual router.

" + } + }, + "documentation": "

An object that represents the status of a virtual router.

" + }, + "ListVirtualServicesOutput": { + "type": "structure", + "required": [ + "virtualServices" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualServices\n request. When the results of a ListVirtualServices request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + }, + "virtualServices": { + "shape": "VirtualServiceList", + "documentation": "

The list of existing virtual services for the specified service mesh.

" + } + }, + "documentation": "" + }, + "AwsCloudMapInstanceAttributeValue": { + "type": "string", + "min": 1, + "max": 1024, + "pattern": "^([a-zA-Z0-9!-~][ ta-zA-Z0-9!-~]*){0,1}[a-zA-Z0-9!-~]{0,1}$" + }, + "WeightedTarget": { + "type": "structure", + "required": [ + "virtualNode", + "weight" + ], + "members": { + "virtualNode": { + "shape": "ResourceName", + "documentation": "

The virtual node to associate with the weighted target.

" + }, + "weight": { + "shape": "PercentInt", + "documentation": "

The relative weight of the weighted target.

" + } + }, + "documentation": "

An object that represents a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10. The total weight for all targets combined must be less than or equal to 100.

" + }, + "TcpRouteAction": { + "type": "structure", + "required": [ + "weightedTargets" + ], + "members": { + "weightedTargets": { + "shape": "WeightedTargets", + "documentation": "

An object that represents the targets that traffic is routed to when a request matches the route.

" + } + }, + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "DescribeVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual node resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to describe.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "RouteStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "RouteStatusCode", + "documentation": "

The current status for the route.

" + } + }, + "documentation": "

An object that represents the current status of a route.

" + }, + "RouteRef": { + "type": "structure", + "required": [ + "arn", + "meshName", + "routeName", + "virtualRouterName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the route.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the route resides in.

" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The virtual router that the route is associated with.

" + } + }, + "documentation": "

An object that represents a route returned by a list operation.

" + }, + "Listener": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "healthCheck": { + "shape": "HealthCheckPolicy", + "documentation": "

The health check information for the listener.

" + }, + "portMapping": { + "shape": "PortMapping", + "documentation": "

The port mapping information for the listener.

" + } + }, + "documentation": "

An object that represents a listener for a virtual node.

" + }, + "GrpcRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "shape": "GrpcRouteAction", + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "match": { + "shape": "GrpcRouteMatch", + "documentation": "

An object that represents the criteria for determining a request match.

" + }, + "retryPolicy": { + "shape": "GrpcRetryPolicy", + "documentation": "

An object that represents a retry policy.

" + } + }, + "documentation": "

An object that represents a GRPC route type.

" + }, + "DeleteVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "virtualNodeName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the virtual node in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node to delete.

", + "location": "uri", + "locationName": "virtualNodeName" + } + }, + "documentation": "" + }, + "RouteData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "routeName", + "spec", + "status", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the route resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata", + "documentation": "

The associated metadata for the route.

" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route.

" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The specifications of the route.

" + }, + "status": { + "shape": "RouteStatus", + "documentation": "

The status of the route.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The virtual router that the route is associated with.

" + } + }, + "documentation": "

An object that represents a route returned by a describe operation.

" + }, + "RouteStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "ListRoutesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, + "DeleteVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData", + "documentation": "

The virtual service that was deleted.

" + } + }, + "documentation": "", + "payload": "virtualService" + }, + "VirtualNodeServiceProvider": { + "type": "structure", + "required": [ + "virtualNodeName" + ], + "members": { + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual node that is acting as a service provider.

" + } + }, + "documentation": "

An object that represents a virtual node service provider.

" + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request processing has failed because of an unknown error, exception, or\n failure.

", + "exception": true, + "error": { + "code": "InternalServerErrorException", + "httpStatusCode": 500, + "fault": true + } + }, + "HeaderName": { + "type": "string", + "min": 1, + "max": 50 + }, + "TagList": { + "type": "list", + "member": { + "shape": "TagRef" + }, + "min": 0, + "max": 50 + }, + "GrpcRetryPolicyEvent": { + "type": "string", + "enum": [ + "cancelled", + "deadline-exceeded", + "internal", + "resource-exhausted", + "unavailable" + ] + }, + "HttpRetryPolicy": { + "type": "structure", + "required": [ + "maxRetries", + "perRetryTimeout" + ], + "members": { + "httpRetryEvents": { + "shape": "HttpRetryPolicyEvents", + "documentation": "

Specify at least one of the following values.

\n
    \n
  • \n

    \n server-error – HTTP status codes 500, 501,\n 502, 503, 504, 505, 506, 507, 508, 510, and 511

    \n
    • \n
  • \n

    \n gateway-error – HTTP status codes 502,\n 503, and 504

    \n
    • \n
  • \n

    \n client-error – HTTP status code 409

    \n
    • \n
  • \n

    \n stream-error – Retry on refused\n stream

    \n
    • \n
" + }, + "maxRetries": { + "shape": "MaxRetries", + "documentation": "

The maximum number of retry attempts.

" + }, + "perRetryTimeout": { + "shape": "Duration", + "documentation": "

An object that represents a duration of time.

" + }, + "tcpRetryEvents": { + "shape": "TcpRetryPolicyEvents", + "documentation": "

Specify a valid value.

" + } + }, + "documentation": "

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout.

" + }, + "DescribeVirtualRouterInput": { + "type": "structure", + "required": [ + "meshName", + "virtualRouterName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual router resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router to describe.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "TagResourceOutput": { + "type": "structure", + "members": { }, + "documentation": "" + }, + "RouteList": { + "type": "list", + "member": { + "shape": "RouteRef" + } + }, + "ForbiddenException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

You don't have permissions to perform this action.

", + "exception": true, + "error": { + "code": "ForbiddenException", + "httpStatusCode": 403, + "senderFault": true + } + }, + "TooManyTagsException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The request exceeds the maximum allowed number of tags allowed per resource. The current\n limit is 50 user tags per resource. You must reduce the number of tags in the request. None\n of the tags in this request were applied.

", + "exception": true, + "error": { + "code": "TooManyTagsException", + "httpStatusCode": 400, + "senderFault": true + } + }, + "HeaderMatchMethod": { + "type": "structure", + "members": { + "exact": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must match the specified value exactly.

" + }, + "prefix": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must begin with the specified characters.

" + }, + "range": { + "shape": "MatchRange", + "documentation": "

An object that represents the range of values to match on.

" + }, + "regex": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must include the specified characters.

" + }, + "suffix": { + "shape": "HeaderMatch", + "documentation": "

The value sent by the client must end with the specified characters.

" + } + }, + "documentation": "

An object that represents the method and value to match with the header value sent in a\n request. Specify one match method.

" + }, + "DeleteMeshOutput": { + "type": "structure", + "required": [ + "mesh" + ], + "members": { + "mesh": { + "shape": "MeshData", + "documentation": "

The service mesh that was deleted.

" + } + }, + "documentation": "", + "payload": "mesh" + }, + "EgressFilterType": { + "type": "string", + "enum": [ + "ALLOW_ALL", + "DROP_ALL" + ] + }, + "DurationValue": { + "type": "long", + "box": true, + "min": 0 + }, + "Hostname": { + "type": "string" + }, + "PortNumber": { + "type": "integer", + "min": 1, + "max": 65535 + }, + "TagResourceInput": { + "type": "structure", + "required": [ + "resourceArn", + "tags" + ], + "members": { + "resourceArn": { + "shape": "Arn", + "documentation": "

The Amazon Resource Name (ARN) of the resource to add tags to.

", + "location": "querystring", + "locationName": "resourceArn" + }, + "tags": { + "shape": "TagList", + "documentation": "

The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + } + }, + "documentation": "" + }, + "GrpcRouteMetadata": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "invert": { + "shape": "Boolean", + "documentation": "

Specify True to match anything except the match criteria. The default value is False.

" + }, + "match": { + "shape": "GrpcRouteMetadataMatchMethod", + "documentation": "

An object that represents the data to match from the request.

" + }, + "name": { + "shape": "HeaderName", + "documentation": "

The name of the route.

" + } + }, + "documentation": "

An object that represents the match metadata for the route.

" + }, + "CreateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the route in.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name to use for the route.

" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The route specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the route to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router in which to create the route.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "WeightedTargets": { + "type": "list", + "member": { + "shape": "WeightedTarget" + }, + "min": 1, + "max": 10 + }, + "HttpRouteHeaders": { + "type": "list", + "member": { + "shape": "HttpRouteHeader" + }, + "min": 1, + "max": 10 + }, + "VirtualServiceProvider": { + "type": "structure", + "members": { + "virtualNode": { + "shape": "VirtualNodeServiceProvider", + "documentation": "

The virtual node associated with a virtual service.

" + }, + "virtualRouter": { + "shape": "VirtualRouterServiceProvider", + "documentation": "

The virtual router associated with a virtual service.

" + } + }, + "documentation": "

An object that represents the provider for a virtual service.

" + }, + "GrpcRouteMatch": { + "type": "structure", + "members": { + "metadata": { + "shape": "GrpcRouteMetadataList", + "documentation": "

An object that represents the data to match from the request.

" + }, + "methodName": { + "shape": "MethodName", + "documentation": "

The method name to match from the request. If you specify a name, you must also specify a serviceName.

" + }, + "serviceName": { + "shape": "ServiceName", + "documentation": "

The fully qualified domain name for the service to match from the request.

" + } + }, + "documentation": "

An object that represents the criteria for determining a request match.

" + }, + "String": { + "type": "string" + }, + "AwsCloudMapServiceDiscovery": { + "type": "structure", + "required": [ + "namespaceName", + "serviceName" + ], + "members": { + "attributes": { + "shape": "AwsCloudMapInstanceAttributes", + "documentation": "

A string map that contains attributes with values that you can use to filter instances\n by any custom attribute that you specified when you registered the instance. Only instances\n that match all of the specified key/value pairs will be returned.

" + }, + "namespaceName": { + "shape": "AwsCloudMapName", + "documentation": "

The name of the AWS Cloud Map namespace to use.

" + }, + "serviceName": { + "shape": "AwsCloudMapName", + "documentation": "

The name of the AWS Cloud Map service to use.

" + } + }, + "documentation": "

An object that represents the AWS Cloud Map service discovery information for your virtual\n node.

" + }, + "HttpScheme": { + "type": "string", + "enum": [ + "http", + "https" + ] + }, + "UpdateVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData", + "documentation": "

A full description of the virtual service that was updated.

" + } + }, + "documentation": "", + "payload": "virtualService" + }, + "UpdateRouteInput": { + "type": "structure", + "required": [ + "meshName", + "routeName", + "spec", + "virtualRouterName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the route resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "routeName": { + "shape": "ResourceName", + "documentation": "

The name of the route to update.

", + "location": "uri", + "locationName": "routeName" + }, + "spec": { + "shape": "RouteSpec", + "documentation": "

The new route specification to apply. This overwrites the existing data.

" + }, + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router that the route is associated with.

", + "location": "uri", + "locationName": "virtualRouterName" + } + }, + "documentation": "" + }, + "MeshStatus": { + "type": "structure", + "members": { + "status": { + "shape": "MeshStatusCode", + "documentation": "

The current mesh status.

" + } + }, + "documentation": "

An object that represents the status of a service mesh.

" + }, + "CreateVirtualNodeInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualNodeName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the virtual node in.

", + "location": "uri", + "locationName": "meshName" + }, + "spec": { + "shape": "VirtualNodeSpec", + "documentation": "

The virtual node specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the virtual node to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualNodeName": { + "shape": "ResourceName", + "documentation": "

The name to use for the virtual node.

" + } + }, + "documentation": "" + }, + "NotFoundException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

The specified resource doesn't exist. Check your request syntax and try again.

", + "exception": true, + "error": { + "code": "NotFoundException", + "httpStatusCode": 404, + "senderFault": true + } + }, + "RouteSpec": { + "type": "structure", + "members": { + "grpcRoute": { + "shape": "GrpcRoute", + "documentation": "

An object that represents the specification of a GRPC route.

" + }, + "http2Route": { + "shape": "HttpRoute", + "documentation": "

An object that represents the specification of an HTTP2 route.

" + }, + "httpRoute": { + "shape": "HttpRoute", + "documentation": "

An object that represents the specification of an HTTP route.

" + }, + "priority": { + "shape": "RoutePriority", + "documentation": "

The priority for the route. Routes are matched based on the specified value, where 0 is\n the highest priority.

" + }, + "tcpRoute": { + "shape": "TcpRoute", + "documentation": "

An object that represents the specification of a TCP route.

" + } + }, + "documentation": "

An object that represents a route specification. Specify one route type.

" + }, + "HttpRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "shape": "HttpRouteAction", + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "match": { + "shape": "HttpRouteMatch", + "documentation": "

An object that represents the criteria for determining a request match.

" + }, + "retryPolicy": { + "shape": "HttpRetryPolicy", + "documentation": "

An object that represents a retry policy.

" + } + }, + "documentation": "

An object that represents an HTTP or HTTP2 route type.

" + }, + "DescribeMeshInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to describe.

", + "location": "uri", + "locationName": "meshName" + } + }, + "documentation": "" + }, + "MeshSpec": { + "type": "structure", + "members": { + "egressFilter": { + "shape": "EgressFilter", + "documentation": "

The egress filter rules for the service mesh.

" + } + }, + "documentation": "

An object that represents the specification of a service mesh.

" + }, + "CreateVirtualServiceOutput": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "VirtualServiceData", + "documentation": "

The full description of your virtual service following the create call.

" + } + }, + "documentation": "", + "payload": "virtualService" + }, + "FileAccessLog": { + "type": "structure", + "required": [ + "path" + ], + "members": { + "path": { + "shape": "FilePath", + "documentation": "

The file path to write access logs to. You can use /dev/stdout to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.

\n \n

The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.

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

An object that represents an access log file.

" + }, + "VirtualRouterServiceProvider": { + "type": "structure", + "required": [ + "virtualRouterName" + ], + "members": { + "virtualRouterName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual router that is acting as a service provider.

" + } + }, + "documentation": "

An object that represents a virtual node service provider.

" + }, + "DeleteVirtualServiceInput": { + "type": "structure", + "required": [ + "meshName", + "virtualServiceName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the virtual service in.

", + "location": "uri", + "locationName": "meshName" + }, + "virtualServiceName": { + "shape": "ServiceName", + "documentation": "

The name of the virtual service to delete.

", + "location": "uri", + "locationName": "virtualServiceName" + } + }, + "documentation": "" + }, + "ListTagsForResourceOutput": { + "type": "structure", + "required": [ + "tags" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListTagsForResource\n request. When the results of a ListTagsForResource request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

The tags for the resource.

" + } + }, + "documentation": "" + }, + "ServiceDiscovery": { + "type": "structure", + "members": { + "awsCloudMap": { + "shape": "AwsCloudMapServiceDiscovery", + "documentation": "

Specifies any AWS Cloud Map information for the virtual node.

" + }, + "dns": { + "shape": "DnsServiceDiscovery", + "documentation": "

Specifies the DNS information for the virtual node.

" + } + }, + "documentation": "

An object that represents the service discovery information for a virtual node.

" + }, + "ListVirtualNodesOutput": { + "type": "structure", + "required": [ + "virtualNodes" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualNodes\n request. When the results of a ListVirtualNodes request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + }, + "virtualNodes": { + "shape": "VirtualNodeList", + "documentation": "

The list of existing virtual nodes for the specified service mesh.

" + } + }, + "documentation": "" + }, + "UntagResourceInput": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "shape": "Arn", + "documentation": "

The Amazon Resource Name (ARN) of the resource to delete tags from.

", + "location": "querystring", + "locationName": "resourceArn" + }, + "tagKeys": { + "shape": "TagKeyList", + "documentation": "

The keys of the tags to be removed.

" + } + }, + "documentation": "" + }, + "DeleteVirtualRouterOutput": { + "type": "structure", + "required": [ + "virtualRouter" + ], + "members": { + "virtualRouter": { + "shape": "VirtualRouterData", + "documentation": "

The virtual router that was deleted.

" + } + }, + "documentation": "", + "payload": "virtualRouter" + }, + "TagsLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 50 + }, + "TagKey": { + "type": "string", + "min": 1, + "max": 128 + }, + "VirtualServiceStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, + "DeleteVirtualNodeOutput": { + "type": "structure", + "required": [ + "virtualNode" + ], + "members": { + "virtualNode": { + "shape": "VirtualNodeData", + "documentation": "

The virtual node that was deleted.

" + } + }, + "documentation": "", + "payload": "virtualNode" + } + } +} diff --git a/aws/dist/botocore/data/appstream/2016-12-01/examples-1.json b/aws/dist/botocore/data/appstream/2016-12-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/appstream/2016-12-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/appstream/2016-12-01/paginators-1.json b/aws/dist/botocore/data/appstream/2016-12-01/paginators-1.json new file mode 100644 index 00000000..40cbf4ba --- /dev/null +++ b/aws/dist/botocore/data/appstream/2016-12-01/paginators-1.json @@ -0,0 +1,60 @@ +{ + "pagination": { + "DescribeDirectoryConfigs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "DirectoryConfigs" + }, + "DescribeFleets": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Fleets" + }, + "DescribeImageBuilders": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ImageBuilders" + }, + "DescribeImages": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Images" + }, + "DescribeSessions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Sessions" + }, + "DescribeStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Stacks" + }, + "DescribeUserStackAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "UserStackAssociations" + }, + "DescribeUsers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Users" + }, + "ListAssociatedFleets": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Names" + }, + "ListAssociatedStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Names" + } + } +} diff --git a/aws/dist/botocore/data/appstream/2016-12-01/service-2.json b/aws/dist/botocore/data/appstream/2016-12-01/service-2.json new file mode 100644 index 00000000..e60b0389 --- /dev/null +++ b/aws/dist/botocore/data/appstream/2016-12-01/service-2.json @@ -0,0 +1,3526 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-12-01", + "endpointPrefix":"appstream2", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon AppStream", + "serviceId":"AppStream", + "signatureVersion":"v4", + "signingName":"appstream", + "targetPrefix":"PhotonAdminProxyService", + "uid":"appstream-2016-12-01" + }, + "operations":{ + "AssociateFleet":{ + "name":"AssociateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateFleetRequest"}, + "output":{"shape":"AssociateFleetResult"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"IncompatibleImageException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Associates the specified fleet with the specified stack.

" + }, + "BatchAssociateUserStack":{ + "name":"BatchAssociateUserStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchAssociateUserStackRequest"}, + "output":{"shape":"BatchAssociateUserStackResult"}, + "errors":[ + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.

" + }, + "BatchDisassociateUserStack":{ + "name":"BatchDisassociateUserStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDisassociateUserStackRequest"}, + "output":{"shape":"BatchDisassociateUserStackResult"}, + "documentation":"

Disassociates the specified users from the specified stacks.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"IncompatibleImageException"} + ], + "documentation":"

Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

" + }, + "CreateDirectoryConfig":{ + "name":"CreateDirectoryConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDirectoryConfigRequest"}, + "output":{"shape":"CreateDirectoryConfigResult"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"} + ], + "documentation":"

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

" + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFleetRequest"}, + "output":{"shape":"CreateFleetResult"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"InvalidRoleException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"IncompatibleImageException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Creates a fleet. A fleet consists of streaming instances that run a specified image.

" + }, + "CreateImageBuilder":{ + "name":"CreateImageBuilder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageBuilderRequest"}, + "output":{"shape":"CreateImageBuilderResult"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRoleException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"IncompatibleImageException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Creates an image builder. An image builder is a virtual machine that is used to create an image.

The initial state of the builder is PENDING. When it is ready, the state is RUNNING.

" + }, + "CreateImageBuilderStreamingURL":{ + "name":"CreateImageBuilderStreamingURL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageBuilderStreamingURLRequest"}, + "output":{"shape":"CreateImageBuilderStreamingURLResult"}, + "errors":[ + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a URL to start an image builder streaming session.

" + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackRequest"}, + "output":{"shape":"CreateStackResult"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRoleException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.

" + }, + "CreateStreamingURL":{ + "name":"CreateStreamingURL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStreamingURLRequest"}, + "output":{"shape":"CreateStreamingURLResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.

" + }, + "CreateUsageReportSubscription":{ + "name":"CreateUsageReportSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUsageReportSubscriptionRequest"}, + "output":{"shape":"CreateUsageReportSubscriptionResult"}, + "errors":[ + {"shape":"InvalidRoleException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a usage report subscription. Usage reports are generated daily.

" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResult"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"LimitExceededException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Creates a new user in the user pool.

" + }, + "DeleteDirectoryConfig":{ + "name":"DeleteDirectoryConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDirectoryConfigRequest"}, + "output":{"shape":"DeleteDirectoryConfigResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.

" + }, + "DeleteFleet":{ + "name":"DeleteFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFleetRequest"}, + "output":{"shape":"DeleteFleetResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the specified fleet.

" + }, + "DeleteImage":{ + "name":"DeleteImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImageRequest"}, + "output":{"shape":"DeleteImageResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.

" + }, + "DeleteImageBuilder":{ + "name":"DeleteImageBuilder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImageBuilderRequest"}, + "output":{"shape":"DeleteImageBuilderResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the specified image builder and releases the capacity.

" + }, + "DeleteImagePermissions":{ + "name":"DeleteImagePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImagePermissionsRequest"}, + "output":{"shape":"DeleteImagePermissionsResult"}, + "errors":[ + {"shape":"ResourceNotAvailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.

" + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackRequest"}, + "output":{"shape":"DeleteStackResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.

" + }, + "DeleteUsageReportSubscription":{ + "name":"DeleteUsageReportSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUsageReportSubscriptionRequest"}, + "output":{"shape":"DeleteUsageReportSubscriptionResult"}, + "errors":[ + {"shape":"InvalidAccountStatusException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disables usage report generation.

" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a user from the user pool.

" + }, + "DescribeDirectoryConfigs":{ + "name":"DescribeDirectoryConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectoryConfigsRequest"}, + "output":{"shape":"DescribeDirectoryConfigsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

" + }, + "DescribeFleets":{ + "name":"DescribeFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetsRequest"}, + "output":{"shape":"DescribeFleetsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.

" + }, + "DescribeImageBuilders":{ + "name":"DescribeImageBuilders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageBuildersRequest"}, + "output":{"shape":"DescribeImageBuildersResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.

" + }, + "DescribeImagePermissions":{ + "name":"DescribeImagePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagePermissionsRequest"}, + "output":{"shape":"DescribeImagePermissionsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "errors":[ + {"shape":"InvalidParameterCombinationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.

" + }, + "DescribeSessions":{ + "name":"DescribeSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSessionsRequest"}, + "output":{"shape":"DescribeSessionsResult"}, + "errors":[ + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

" + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStacksRequest"}, + "output":{"shape":"DescribeStacksResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.

" + }, + "DescribeUsageReportSubscriptions":{ + "name":"DescribeUsageReportSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUsageReportSubscriptionsRequest"}, + "output":{"shape":"DescribeUsageReportSubscriptionsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccountStatusException"} + ], + "documentation":"

Retrieves a list that describes one or more usage report subscriptions.

" + }, + "DescribeUserStackAssociations":{ + "name":"DescribeUserStackAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserStackAssociationsRequest"}, + "output":{"shape":"DescribeUserStackAssociationsResult"}, + "errors":[ + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:

  • The stack name

  • The user name (email address of the user associated with the stack) and the authentication type for the user

" + }, + "DescribeUsers":{ + "name":"DescribeUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUsersRequest"}, + "output":{"shape":"DescribeUsersResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Retrieves a list that describes one or more specified users in the user pool.

" + }, + "DisableUser":{ + "name":"DisableUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableUserRequest"}, + "output":{"shape":"DisableUserResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.

" + }, + "DisassociateFleet":{ + "name":"DisassociateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateFleetRequest"}, + "output":{"shape":"DisassociateFleetResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Disassociates the specified fleet from the specified stack.

" + }, + "EnableUser":{ + "name":"EnableUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableUserRequest"}, + "output":{"shape":"EnableUserResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccountStatusException"} + ], + "documentation":"

Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.

" + }, + "ExpireSession":{ + "name":"ExpireSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExpireSessionRequest"}, + "output":{"shape":"ExpireSessionResult"}, + "documentation":"

Immediately stops the specified streaming session.

" + }, + "ListAssociatedFleets":{ + "name":"ListAssociatedFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociatedFleetsRequest"}, + "output":{"shape":"ListAssociatedFleetsResult"}, + "documentation":"

Retrieves the name of the fleet that is associated with the specified stack.

" + }, + "ListAssociatedStacks":{ + "name":"ListAssociatedStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociatedStacksRequest"}, + "output":{"shape":"ListAssociatedStacksResult"}, + "documentation":"

Retrieves the name of the stack with which the specified fleet is associated.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "StartFleet":{ + "name":"StartFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFleetRequest"}, + "output":{"shape":"StartFleetResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"InvalidRoleException"} + ], + "documentation":"

Starts the specified fleet.

" + }, + "StartImageBuilder":{ + "name":"StartImageBuilder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartImageBuilderRequest"}, + "output":{"shape":"StartImageBuilderResult"}, + "errors":[ + {"shape":"ResourceNotAvailableException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"IncompatibleImageException"} + ], + "documentation":"

Starts the specified image builder.

" + }, + "StopFleet":{ + "name":"StopFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopFleetRequest"}, + "output":{"shape":"StopFleetResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Stops the specified fleet.

" + }, + "StopImageBuilder":{ + "name":"StopImageBuilder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopImageBuilderRequest"}, + "output":{"shape":"StopImageBuilderResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Stops the specified image builder.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.

To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disassociates one or more specified tags from the specified AppStream 2.0 resource.

To list the current tags for your resources, use ListTagsForResource.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "UpdateDirectoryConfig":{ + "name":"UpdateDirectoryConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDirectoryConfigRequest"}, + "output":{"shape":"UpdateDirectoryConfigResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

" + }, + "UpdateFleet":{ + "name":"UpdateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetRequest"}, + "output":{"shape":"UpdateFleetResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"InvalidRoleException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"IncompatibleImageException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Updates the specified fleet.

If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. If the fleet is in the STARTING or STOPPING state, you can't update it.

" + }, + "UpdateImagePermissions":{ + "name":"UpdateImagePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateImagePermissionsRequest"}, + "output":{"shape":"UpdateImagePermissionsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotAvailableException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Adds or updates permissions for the specified private image.

" + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackRequest"}, + "output":{"shape":"UpdateStackResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidRoleException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccountStatusException"}, + {"shape":"IncompatibleImageException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the specified fields for the specified stack.

" + } + }, + "shapes":{ + "AccessEndpoint":{ + "type":"structure", + "required":["EndpointType"], + "members":{ + "EndpointType":{ + "shape":"AccessEndpointType", + "documentation":"

The type of interface endpoint.

" + }, + "VpceId":{ + "shape":"String", + "documentation":"

The identifier (ID) of the VPC in which the interface endpoint is used.

" + } + }, + "documentation":"

Describes an interface VPC endpoint (interface endpoint) that lets you create a private connection between the virtual private cloud (VPC) that you specify and AppStream 2.0. When you specify an interface endpoint for a stack, users of the stack can connect to AppStream 2.0 only through that endpoint. When you specify an interface endpoint for an image builder, administrators can connect to the image builder only through that endpoint.

" + }, + "AccessEndpointList":{ + "type":"list", + "member":{"shape":"AccessEndpoint"}, + "max":4, + "min":1 + }, + "AccessEndpointType":{ + "type":"string", + "enum":["STREAMING"] + }, + "AccountName":{ + "type":"string", + "min":1, + "sensitive":true + }, + "AccountPassword":{ + "type":"string", + "max":127, + "min":1, + "sensitive":true + }, + "Action":{ + "type":"string", + "enum":[ + "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", + "CLIPBOARD_COPY_TO_LOCAL_DEVICE", + "FILE_UPLOAD", + "FILE_DOWNLOAD", + "PRINTING_TO_LOCAL_DEVICE" + ] + }, + "Application":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the application.

" + }, + "DisplayName":{ + "shape":"String", + "documentation":"

The application name to display.

" + }, + "IconURL":{ + "shape":"String", + "documentation":"

The URL for the application icon. This URL might be time-limited.

" + }, + "LaunchPath":{ + "shape":"String", + "documentation":"

The path to the application executable in the instance.

" + }, + "LaunchParameters":{ + "shape":"String", + "documentation":"

The arguments that are passed to the application at launch.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

If there is a problem, the application can be disabled after image creation.

" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

Additional attributes that describe the application.

" + } + }, + "documentation":"

Describes an application in the application catalog.

" + }, + "ApplicationSettings":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables or disables persistent application settings for users during their streaming sessions.

" + }, + "SettingsGroup":{ + "shape":"SettingsGroup", + "documentation":"

The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.

" + } + }, + "documentation":"

The persistent application settings for users of a stack.

" + }, + "ApplicationSettingsResponse":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether persistent application settings are enabled for users during their streaming sessions.

" + }, + "SettingsGroup":{ + "shape":"SettingsGroup", + "documentation":"

The path prefix for the S3 bucket where users’ persistent application settings are stored.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.

" + } + }, + "documentation":"

Describes the persistent application settings for users of a stack.

" + }, + "Applications":{ + "type":"list", + "member":{"shape":"Application"} + }, + "AppstreamAgentVersion":{ + "type":"string", + "max":100, + "min":1 + }, + "Arn":{ + "type":"string", + "pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$" + }, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "AssociateFleetRequest":{ + "type":"structure", + "required":[ + "FleetName", + "StackName" + ], + "members":{ + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + }, + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack.

" + } + } + }, + "AssociateFleetResult":{ + "type":"structure", + "members":{ + } + }, + "AuthenticationType":{ + "type":"string", + "enum":[ + "API", + "SAML", + "USERPOOL" + ] + }, + "AwsAccountId":{ + "type":"string", + "pattern":"^\\d+$" + }, + "AwsAccountIdList":{ + "type":"list", + "member":{"shape":"AwsAccountId"}, + "max":5, + "min":1 + }, + "BatchAssociateUserStackRequest":{ + "type":"structure", + "required":["UserStackAssociations"], + "members":{ + "UserStackAssociations":{ + "shape":"UserStackAssociationList", + "documentation":"

The list of UserStackAssociation objects.

" + } + } + }, + "BatchAssociateUserStackResult":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"UserStackAssociationErrorList", + "documentation":"

The list of UserStackAssociationError objects.

" + } + } + }, + "BatchDisassociateUserStackRequest":{ + "type":"structure", + "required":["UserStackAssociations"], + "members":{ + "UserStackAssociations":{ + "shape":"UserStackAssociationList", + "documentation":"

The list of UserStackAssociation objects.

" + } + } + }, + "BatchDisassociateUserStackResult":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"UserStackAssociationErrorList", + "documentation":"

The list of UserStackAssociationError objects.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "BooleanObject":{"type":"boolean"}, + "ComputeCapacity":{ + "type":"structure", + "required":["DesiredInstances"], + "members":{ + "DesiredInstances":{ + "shape":"Integer", + "documentation":"

The desired number of streaming instances.

" + } + }, + "documentation":"

Describes the capacity for a fleet.

" + }, + "ComputeCapacityStatus":{ + "type":"structure", + "required":["Desired"], + "members":{ + "Desired":{ + "shape":"Integer", + "documentation":"

The desired number of streaming instances.

" + }, + "Running":{ + "shape":"Integer", + "documentation":"

The total number of simultaneous streaming instances that are running.

" + }, + "InUse":{ + "shape":"Integer", + "documentation":"

The number of instances in use for streaming.

" + }, + "Available":{ + "shape":"Integer", + "documentation":"

The number of currently available instances that can be used to stream sessions.

" + } + }, + "documentation":"

Describes the capacity status for a fleet.

" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An API error occurred. Wait a few minutes and try again.

", + "exception":true + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceImageName", + "DestinationImageName", + "DestinationRegion" + ], + "members":{ + "SourceImageName":{ + "shape":"Name", + "documentation":"

The name of the image to copy.

" + }, + "DestinationImageName":{ + "shape":"Name", + "documentation":"

The name that the image will have when it is copied to the destination.

" + }, + "DestinationRegion":{ + "shape":"RegionName", + "documentation":"

The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

" + }, + "DestinationImageDescription":{ + "shape":"Description", + "documentation":"

The description that the image will have when it is copied to the destination.

" + } + } + }, + "CopyImageResponse":{ + "type":"structure", + "members":{ + "DestinationImageName":{ + "shape":"Name", + "documentation":"

The name of the destination image.

" + } + } + }, + "CreateDirectoryConfigRequest":{ + "type":"structure", + "required":[ + "DirectoryName", + "OrganizationalUnitDistinguishedNames", + "ServiceAccountCredentials" + ], + "members":{ + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name of the directory (for example, corp.example.com).

" + }, + "OrganizationalUnitDistinguishedNames":{ + "shape":"OrganizationalUnitDistinguishedNamesList", + "documentation":"

The distinguished names of the organizational units for computer accounts.

" + }, + "ServiceAccountCredentials":{ + "shape":"ServiceAccountCredentials", + "documentation":"

The credentials for the service account used by the fleet or image builder to connect to the directory.

" + } + } + }, + "CreateDirectoryConfigResult":{ + "type":"structure", + "members":{ + "DirectoryConfig":{ + "shape":"DirectoryConfig", + "documentation":"

Information about the directory configuration.

" + } + } + }, + "CreateFleetRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceType", + "ComputeCapacity" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

A unique name for the fleet.

" + }, + "ImageName":{ + "shape":"String", + "documentation":"

The name of the image used to create the fleet.

" + }, + "ImageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the public, private, or shared image to use.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type to use when launching fleet instances. The following instance types are available:

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

" + }, + "FleetType":{ + "shape":"FleetType", + "documentation":"

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

" + }, + "ComputeCapacity":{ + "shape":"ComputeCapacity", + "documentation":"

The desired capacity for the fleet.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC configuration for the fleet.

" + }, + "MaxUserDurationInSeconds":{ + "shape":"Integer", + "documentation":"

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

" + }, + "DisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The fleet name to display.

" + }, + "EnableDefaultInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables default internet access for the fleet.

" + }, + "DomainJoinInfo":{ + "shape":"DomainJoinInfo", + "documentation":"

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \\ - @

For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "IdleDisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

" + }, + "IamRoleArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + } + } + }, + "CreateFleetResult":{ + "type":"structure", + "members":{ + "Fleet":{ + "shape":"Fleet", + "documentation":"

Information about the fleet.

" + } + } + }, + "CreateImageBuilderRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceType" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

A unique name for the image builder.

" + }, + "ImageName":{ + "shape":"String", + "documentation":"

The name of the image used to create the image builder.

" + }, + "ImageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the public, private, or shared image to use.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type to use when launching the image builder. The following instance types are available:

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The image builder name to display.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC configuration for the image builder. You can specify only one subnet.

" + }, + "IamRoleArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + }, + "EnableDefaultInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables default internet access for the image builder.

" + }, + "DomainJoinInfo":{ + "shape":"DomainJoinInfo", + "documentation":"

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

" + }, + "AppstreamAgentVersion":{ + "shape":"AppstreamAgentVersion", + "documentation":"

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \\ - @

If you do not specify a value, the value is set to an empty string.

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "AccessEndpoints":{ + "shape":"AccessEndpointList", + "documentation":"

The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.

" + } + } + }, + "CreateImageBuilderResult":{ + "type":"structure", + "members":{ + "ImageBuilder":{ + "shape":"ImageBuilder", + "documentation":"

Information about the image builder.

" + } + } + }, + "CreateImageBuilderStreamingURLRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the image builder.

" + }, + "Validity":{ + "shape":"Long", + "documentation":"

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.

" + } + } + }, + "CreateImageBuilderStreamingURLResult":{ + "type":"structure", + "members":{ + "StreamingURL":{ + "shape":"String", + "documentation":"

The URL to start the AppStream 2.0 streaming session.

" + }, + "Expires":{ + "shape":"Timestamp", + "documentation":"

The elapsed time, in seconds after the Unix epoch, when this URL expires.

" + } + } + }, + "CreateStackRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the stack.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The stack name to display.

" + }, + "StorageConnectors":{ + "shape":"StorageConnectorList", + "documentation":"

The storage connectors to enable.

" + }, + "RedirectURL":{ + "shape":"RedirectURL", + "documentation":"

The URL that users are redirected to after their streaming session ends.

" + }, + "FeedbackURL":{ + "shape":"FeedbackURL", + "documentation":"

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" + }, + "UserSettings":{ + "shape":"UserSettingList", + "documentation":"

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettings", + "documentation":"

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \\ - @

For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.

" + }, + "AccessEndpoints":{ + "shape":"AccessEndpointList", + "documentation":"

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + }, + "EmbedHostDomains":{ + "shape":"EmbedHostDomains", + "documentation":"

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" + } + } + }, + "CreateStackResult":{ + "type":"structure", + "members":{ + "Stack":{ + "shape":"Stack", + "documentation":"

Information about the stack.

" + } + } + }, + "CreateStreamingURLRequest":{ + "type":"structure", + "required":[ + "StackName", + "FleetName", + "UserId" + ], + "members":{ + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack.

" + }, + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + }, + "UserId":{ + "shape":"StreamingUrlUserId", + "documentation":"

The identifier of the user.

" + }, + "ApplicationId":{ + "shape":"String", + "documentation":"

The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant.

" + }, + "Validity":{ + "shape":"Long", + "documentation":"

The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.

" + }, + "SessionContext":{ + "shape":"String", + "documentation":"

The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.

" + } + } + }, + "CreateStreamingURLResult":{ + "type":"structure", + "members":{ + "StreamingURL":{ + "shape":"String", + "documentation":"

The URL to start the AppStream 2.0 streaming session.

" + }, + "Expires":{ + "shape":"Timestamp", + "documentation":"

The elapsed time, in seconds after the Unix epoch, when this URL expires.

" + } + } + }, + "CreateUsageReportSubscriptionRequest":{ + "type":"structure", + "members":{ + } + }, + "CreateUsageReportSubscriptionResult":{ + "type":"structure", + "members":{ + "S3BucketName":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where generated reports are stored.

If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

" + }, + "Schedule":{ + "shape":"UsageReportSchedule", + "documentation":"

The schedule for generating usage reports.

" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AuthenticationType" + ], + "members":{ + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.

" + }, + "MessageAction":{ + "shape":"MessageAction", + "documentation":"

The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent.

The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.

" + }, + "FirstName":{ + "shape":"UserAttributeValue", + "documentation":"

The first name, or given name, of the user.

" + }, + "LastName":{ + "shape":"UserAttributeValue", + "documentation":"

The last name, or surname, of the user.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user. You must specify USERPOOL.

" + } + } + }, + "CreateUserResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteDirectoryConfigRequest":{ + "type":"structure", + "required":["DirectoryName"], + "members":{ + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

The name of the directory configuration.

" + } + } + }, + "DeleteDirectoryConfigResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteFleetRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + } + } + }, + "DeleteFleetResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteImageBuilderRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the image builder.

" + } + } + }, + "DeleteImageBuilderResult":{ + "type":"structure", + "members":{ + "ImageBuilder":{ + "shape":"ImageBuilder", + "documentation":"

Information about the image builder.

" + } + } + }, + "DeleteImagePermissionsRequest":{ + "type":"structure", + "required":[ + "Name", + "SharedAccountId" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the private image.

" + }, + "SharedAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The 12-digit identifier of the AWS account for which to delete image permissions.

" + } + } + }, + "DeleteImagePermissionsResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the image.

" + } + } + }, + "DeleteImageResult":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

Information about the image.

" + } + } + }, + "DeleteStackRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the stack.

" + } + } + }, + "DeleteStackResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteUsageReportSubscriptionRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteUsageReportSubscriptionResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AuthenticationType" + ], + "members":{ + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user.

Users' email addresses are case-sensitive.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user. You must specify USERPOOL.

" + } + } + }, + "DeleteUserResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeDirectoryConfigsRequest":{ + "type":"structure", + "members":{ + "DirectoryNames":{ + "shape":"DirectoryNameList", + "documentation":"

The directory names.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum size of each page of results.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeDirectoryConfigsResult":{ + "type":"structure", + "members":{ + "DirectoryConfigs":{ + "shape":"DirectoryConfigList", + "documentation":"

Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeFleetsRequest":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The names of the fleets to describe.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeFleetsResult":{ + "type":"structure", + "members":{ + "Fleets":{ + "shape":"FleetList", + "documentation":"

Information about the fleets.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeImageBuildersRequest":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The names of the image builders to describe.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum size of each page of results.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeImageBuildersResult":{ + "type":"structure", + "members":{ + "ImageBuilders":{ + "shape":"ImageBuilderList", + "documentation":"

Information about the image builders.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeImagePermissionsRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the private image for which to describe permissions. The image must be one that you own.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of each page of results.

" + }, + "SharedAwsAccountIds":{ + "shape":"AwsAccountIdList", + "documentation":"

The 12-digit identifier of one or more AWS accounts with which the image is shared.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeImagePermissionsResult":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the private image.

" + }, + "SharedImagePermissionsList":{ + "shape":"SharedImagePermissionsList", + "documentation":"

The permissions for a private image that you own.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeImagesMaxResults":{ + "type":"integer", + "box":true, + "max":25, + "min":0 + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The names of the public or private images to describe.

" + }, + "Arns":{ + "shape":"ArnList", + "documentation":"

The ARNs of the public, private, and shared images to describe.

" + }, + "Type":{ + "shape":"VisibilityType", + "documentation":"

The type of image (public, private, or shared) to describe.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + }, + "MaxResults":{ + "shape":"DescribeImagesMaxResults", + "documentation":"

The maximum size of each page of results.

" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about the images.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeSessionsRequest":{ + "type":"structure", + "required":[ + "StackName", + "FleetName" + ], + "members":{ + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack. This value is case-sensitive.

" + }, + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet. This value is case-sensitive.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The user identifier.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + }, + "Limit":{ + "shape":"Integer", + "documentation":"

The size of each page of results. The default value is 20 and the maximum value is 50.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

" + } + } + }, + "DescribeSessionsResult":{ + "type":"structure", + "members":{ + "Sessions":{ + "shape":"SessionList", + "documentation":"

Information about the streaming sessions.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeStacksRequest":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The names of the stacks to describe.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeStacksResult":{ + "type":"structure", + "members":{ + "Stacks":{ + "shape":"StackList", + "documentation":"

Information about the stacks.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeUsageReportSubscriptionsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum size of each page of results.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeUsageReportSubscriptionsResult":{ + "type":"structure", + "members":{ + "UsageReportSubscriptions":{ + "shape":"UsageReportSubscriptionList", + "documentation":"

Information about the usage report subscription.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeUserStackAssociationsRequest":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack that is associated with the user.

" + }, + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user who is associated with the stack. You must specify USERPOOL.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum size of each page of results.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeUserStackAssociationsResult":{ + "type":"structure", + "members":{ + "UserStackAssociations":{ + "shape":"UserStackAssociationList", + "documentation":"

The UserStackAssociation objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "DescribeUsersRequest":{ + "type":"structure", + "required":["AuthenticationType"], + "members":{ + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the users in the user pool to describe. You must specify USERPOOL.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum size of each page of results.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "DescribeUsersResult":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UserList", + "documentation":"

Information about users in the user pool.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "Description":{ + "type":"string", + "max":256 + }, + "DirectoryConfig":{ + "type":"structure", + "required":["DirectoryName"], + "members":{ + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name of the directory (for example, corp.example.com).

" + }, + "OrganizationalUnitDistinguishedNames":{ + "shape":"OrganizationalUnitDistinguishedNamesList", + "documentation":"

The distinguished names of the organizational units for computer accounts.

" + }, + "ServiceAccountCredentials":{ + "shape":"ServiceAccountCredentials", + "documentation":"

The credentials for the service account used by the fleet or image builder to connect to the directory.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The time the directory configuration was created.

" + } + }, + "documentation":"

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

" + }, + "DirectoryConfigList":{ + "type":"list", + "member":{"shape":"DirectoryConfig"} + }, + "DirectoryName":{"type":"string"}, + "DirectoryNameList":{ + "type":"list", + "member":{"shape":"DirectoryName"} + }, + "DisableUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AuthenticationType" + ], + "members":{ + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user.

Users' email addresses are case-sensitive.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user. You must specify USERPOOL.

" + } + } + }, + "DisableUserResult":{ + "type":"structure", + "members":{ + } + }, + "DisassociateFleetRequest":{ + "type":"structure", + "required":[ + "FleetName", + "StackName" + ], + "members":{ + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + }, + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack.

" + } + } + }, + "DisassociateFleetResult":{ + "type":"structure", + "members":{ + } + }, + "DisplayName":{ + "type":"string", + "max":100 + }, + "Domain":{ + "type":"string", + "documentation":"GSuite domain for GDrive integration.", + "max":64, + "min":1 + }, + "DomainJoinInfo":{ + "type":"structure", + "members":{ + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name of the directory (for example, corp.example.com).

" + }, + "OrganizationalUnitDistinguishedName":{ + "shape":"OrganizationalUnitDistinguishedName", + "documentation":"

The distinguished name of the organizational unit for computer accounts.

" + } + }, + "documentation":"

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

" + }, + "DomainList":{ + "type":"list", + "member":{"shape":"Domain"}, + "max":10 + }, + "EmbedHostDomain":{ + "type":"string", + "documentation":"Specifies a valid domain that can embed AppStream. Valid examples include: [\"testorigin.tt--com\", \"testingorigin.com.us\", \"test.com.us\"] Invalid examples include: [\"test,com\", \".com\", \"h*llo.com\". \"\"]", + "max":128, + "pattern":"(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]" + }, + "EmbedHostDomains":{ + "type":"list", + "member":{"shape":"EmbedHostDomain"}, + "max":20, + "min":1 + }, + "EnableUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AuthenticationType" + ], + "members":{ + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user.

Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user. You must specify USERPOOL.

" + } + } + }, + "EnableUserResult":{ + "type":"structure", + "members":{ + } + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

The error message in the exception.

" + }, + "ExpireSessionRequest":{ + "type":"structure", + "required":["SessionId"], + "members":{ + "SessionId":{ + "shape":"String", + "documentation":"

The identifier of the streaming session.

" + } + } + }, + "ExpireSessionResult":{ + "type":"structure", + "members":{ + } + }, + "FeedbackURL":{ + "type":"string", + "max":1000 + }, + "Fleet":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "InstanceType", + "ComputeCapacityStatus", + "State" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) for the fleet.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + }, + "DisplayName":{ + "shape":"String", + "documentation":"

The fleet name to display.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to display.

" + }, + "ImageName":{ + "shape":"String", + "documentation":"

The name of the image used to create the fleet.

" + }, + "ImageArn":{ + "shape":"Arn", + "documentation":"

The ARN for the public, private, or shared image.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type to use when launching fleet instances. The following instance types are available:

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

" + }, + "FleetType":{ + "shape":"FleetType", + "documentation":"

The fleet type.

ALWAYS_ON

Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps.

ON_DEMAND

Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.

" + }, + "ComputeCapacityStatus":{ + "shape":"ComputeCapacityStatus", + "documentation":"

The capacity status for the fleet.

" + }, + "MaxUserDurationInSeconds":{ + "shape":"Integer", + "documentation":"

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

" + }, + "DisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.

" + }, + "State":{ + "shape":"FleetState", + "documentation":"

The current state for the fleet.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC configuration for the fleet.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The time the fleet was created.

" + }, + "FleetErrors":{ + "shape":"FleetErrors", + "documentation":"

The fleet errors.

" + }, + "EnableDefaultInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether default internet access is enabled for the fleet.

" + }, + "DomainJoinInfo":{ + "shape":"DomainJoinInfo", + "documentation":"

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" + }, + "IdleDisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

" + }, + "IamRoleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + } + }, + "documentation":"

Describes a fleet.

" + }, + "FleetAttribute":{ + "type":"string", + "documentation":"

The fleet attribute.

", + "enum":[ + "VPC_CONFIGURATION", + "VPC_CONFIGURATION_SECURITY_GROUP_IDS", + "DOMAIN_JOIN_INFO", + "IAM_ROLE_ARN" + ] + }, + "FleetAttributes":{ + "type":"list", + "member":{"shape":"FleetAttribute"}, + "documentation":"

The fleet attributes.

" + }, + "FleetError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"FleetErrorCode", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message.

" + } + }, + "documentation":"

Describes a fleet error.

" + }, + "FleetErrorCode":{ + "type":"string", + "enum":[ + "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", + "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", + "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", + "NETWORK_INTERFACE_LIMIT_EXCEEDED", + "INTERNAL_SERVICE_ERROR", + "IAM_SERVICE_ROLE_IS_MISSING", + "MACHINE_ROLE_IS_MISSING", + "STS_DISABLED_IN_REGION", + "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", + "SUBNET_NOT_FOUND", + "IMAGE_NOT_FOUND", + "INVALID_SUBNET_CONFIGURATION", + "SECURITY_GROUPS_NOT_FOUND", + "IGW_NOT_ATTACHED", + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", + "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", + "DOMAIN_JOIN_ERROR_ACCESS_DENIED", + "DOMAIN_JOIN_ERROR_LOGON_FAILURE", + "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", + "DOMAIN_JOIN_ERROR_MORE_DATA", + "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", + "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", + "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", + "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", + "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", + "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", + "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" + ] + }, + "FleetErrors":{ + "type":"list", + "member":{"shape":"FleetError"} + }, + "FleetList":{ + "type":"list", + "member":{"shape":"Fleet"}, + "documentation":"

The fleets.

" + }, + "FleetState":{ + "type":"string", + "enum":[ + "STARTING", + "RUNNING", + "STOPPING", + "STOPPED" + ] + }, + "FleetType":{ + "type":"string", + "enum":[ + "ALWAYS_ON", + "ON_DEMAND" + ] + }, + "Image":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the image.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the image.

" + }, + "BaseImageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the image from which this image was created.

" + }, + "DisplayName":{ + "shape":"String", + "documentation":"

The image name to display.

" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

" + }, + "Visibility":{ + "shape":"VisibilityType", + "documentation":"

Indicates whether the image is public or private.

" + }, + "ImageBuilderSupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether an image builder can be launched from this image.

" + }, + "ImageBuilderName":{ + "shape":"String", + "documentation":"

The name of the image builder that was used to create the private image. If the image is shared, this value is null.

" + }, + "Platform":{ + "shape":"PlatformType", + "documentation":"

The operating system platform of the image.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to display.

" + }, + "StateChangeReason":{ + "shape":"ImageStateChangeReason", + "documentation":"

The reason why the last state change occurred.

" + }, + "Applications":{ + "shape":"Applications", + "documentation":"

The applications associated with the image.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The time the image was created.

" + }, + "PublicBaseImageReleasedDate":{ + "shape":"Timestamp", + "documentation":"

The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.

" + }, + "AppstreamAgentVersion":{ + "shape":"AppstreamAgentVersion", + "documentation":"

The version of the AppStream 2.0 agent to use for instances that are launched from this image.

" + }, + "ImagePermissions":{ + "shape":"ImagePermissions", + "documentation":"

The permissions to provide to the destination AWS account for the specified image.

" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageBuilder":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the image builder.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN for the image builder.

" + }, + "ImageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the image from which this builder was created.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"String", + "documentation":"

The image builder name to display.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC configuration of the image builder.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type for the image builder. The following instance types are available:

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

" + }, + "Platform":{ + "shape":"PlatformType", + "documentation":"

The operating system platform of the image builder.

" + }, + "IamRoleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + }, + "State":{ + "shape":"ImageBuilderState", + "documentation":"

The state of the image builder.

" + }, + "StateChangeReason":{ + "shape":"ImageBuilderStateChangeReason", + "documentation":"

The reason why the last state change occurred.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The time stamp when the image builder was created.

" + }, + "EnableDefaultInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables default internet access for the image builder.

" + }, + "DomainJoinInfo":{ + "shape":"DomainJoinInfo", + "documentation":"

The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.

" + }, + "NetworkAccessConfiguration":{"shape":"NetworkAccessConfiguration"}, + "ImageBuilderErrors":{ + "shape":"ResourceErrors", + "documentation":"

The image builder errors.

" + }, + "AppstreamAgentVersion":{ + "shape":"AppstreamAgentVersion", + "documentation":"

The version of the AppStream 2.0 agent that is currently being used by the image builder.

" + }, + "AccessEndpoints":{ + "shape":"AccessEndpointList", + "documentation":"

The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.

" + } + }, + "documentation":"

Describes a virtual machine that is used to create an image.

" + }, + "ImageBuilderList":{ + "type":"list", + "member":{"shape":"ImageBuilder"} + }, + "ImageBuilderState":{ + "type":"string", + "enum":[ + "PENDING", + "UPDATING_AGENT", + "RUNNING", + "STOPPING", + "STOPPED", + "REBOOTING", + "SNAPSHOTTING", + "DELETING", + "FAILED" + ] + }, + "ImageBuilderStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ImageBuilderStateChangeReasonCode", + "documentation":"

The state change reason code.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The state change reason message.

" + } + }, + "documentation":"

Describes the reason why the last image builder state change occurred.

" + }, + "ImageBuilderStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "IMAGE_UNAVAILABLE" + ] + }, + "ImageList":{ + "type":"list", + "member":{"shape":"Image"} + }, + "ImagePermissions":{ + "type":"structure", + "members":{ + "allowFleet":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether the image can be used for a fleet.

" + }, + "allowImageBuilder":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether the image can be used for an image builder.

" + } + }, + "documentation":"

Describes the permissions for an image.

" + }, + "ImageState":{ + "type":"string", + "enum":[ + "PENDING", + "AVAILABLE", + "FAILED", + "COPYING", + "DELETING" + ] + }, + "ImageStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ImageStateChangeReasonCode", + "documentation":"

The state change reason code.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The state change reason message.

" + } + }, + "documentation":"

Describes the reason why the last image state change occurred.

" + }, + "ImageStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "IMAGE_BUILDER_NOT_AVAILABLE", + "IMAGE_COPY_FAILURE" + ] + }, + "IncompatibleImageException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The image does not support storage connectors.

", + "exception":true + }, + "Integer":{"type":"integer"}, + "InvalidAccountStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource cannot be created because your AWS account is suspended. For assistance, contact AWS Support.

", + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Indicates an incorrect combination of parameters, or a missing parameter.

", + "exception":true + }, + "InvalidRoleException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified role is invalid.

", + "exception":true + }, + "LastReportGenerationExecutionError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"UsageReportExecutionErrorCode", + "documentation":"

The error code for the error that is returned when a usage report can't be generated.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message for the error that is returned when a usage report can't be generated.

" + } + }, + "documentation":"

Describes the error that is returned when a usage report can't be generated.

" + }, + "LastReportGenerationExecutionErrors":{ + "type":"list", + "member":{"shape":"LastReportGenerationExecutionError"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The requested limit exceeds the permitted limit for an account.

", + "exception":true + }, + "ListAssociatedFleetsRequest":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "ListAssociatedFleetsResult":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The name of the fleet.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "ListAssociatedStacksRequest":{ + "type":"structure", + "required":["FleetName"], + "members":{ + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

" + } + } + }, + "ListAssociatedStacksResult":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"StringList", + "documentation":"

The name of the stack.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The information about the tags.

" + } + } + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "box":true, + "max":500, + "min":0 + }, + "MessageAction":{ + "type":"string", + "enum":[ + "SUPPRESS", + "RESEND" + ] + }, + "Metadata":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Name":{ + "type":"string", + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$" + }, + "NetworkAccessConfiguration":{ + "type":"structure", + "members":{ + "EniPrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the elastic network interface that is attached to instances in your VPC.

" + }, + "EniId":{ + "shape":"String", + "documentation":"

The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.

" + } + }, + "documentation":"

Describes the network details of the fleet or image builder instance.

" + }, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The attempted operation is not permitted.

", + "exception":true + }, + "OrganizationalUnitDistinguishedName":{ + "type":"string", + "max":2000 + }, + "OrganizationalUnitDistinguishedNamesList":{ + "type":"list", + "member":{"shape":"OrganizationalUnitDistinguishedName"} + }, + "Permission":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PlatformType":{ + "type":"string", + "enum":[ + "WINDOWS", + "WINDOWS_SERVER_2016", + "WINDOWS_SERVER_2019" + ] + }, + "RedirectURL":{ + "type":"string", + "max":1000 + }, + "RegionName":{ + "type":"string", + "max":32, + "min":1 + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource already exists.

", + "exception":true + }, + "ResourceError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"FleetErrorCode", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message.

" + }, + "ErrorTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time the error occurred.

" + } + }, + "documentation":"

Describes a resource error.

" + }, + "ResourceErrors":{ + "type":"list", + "member":{"shape":"ResourceError"} + }, + "ResourceIdentifier":{ + "type":"string", + "documentation":"

The ARN of the resource.

", + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource is in use.

", + "exception":true + }, + "ResourceNotAvailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource exists and is not in use, but isn't available.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource was not found.

", + "exception":true + }, + "SecurityGroupIdList":{ + "type":"list", + "member":{"shape":"String"}, + "documentation":"

The security group identifiers.

", + "max":5 + }, + "ServiceAccountCredentials":{ + "type":"structure", + "required":[ + "AccountName", + "AccountPassword" + ], + "members":{ + "AccountName":{ + "shape":"AccountName", + "documentation":"

The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.

" + }, + "AccountPassword":{ + "shape":"AccountPassword", + "documentation":"

The password for the account.

" + } + }, + "documentation":"

Describes the credentials for the service account used by the fleet or image builder to connect to the directory.

" + }, + "Session":{ + "type":"structure", + "required":[ + "Id", + "UserId", + "StackName", + "FleetName", + "State" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

The identifier of the streaming session.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user for whom the session was created.

" + }, + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack for the streaming session.

" + }, + "FleetName":{ + "shape":"String", + "documentation":"

The name of the fleet for the streaming session.

" + }, + "State":{ + "shape":"SessionState", + "documentation":"

The current state of the streaming session.

" + }, + "ConnectionState":{ + "shape":"SessionConnectionState", + "documentation":"

Specifies whether a user is connected to the streaming session.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

The time when a streaming instance is dedicated for the user.

" + }, + "MaxExpirationTime":{ + "shape":"Timestamp", + "documentation":"

The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).

" + }, + "NetworkAccessConfiguration":{ + "shape":"NetworkAccessConfiguration", + "documentation":"

The network details for the streaming session.

" + } + }, + "documentation":"

Describes a streaming session.

" + }, + "SessionConnectionState":{ + "type":"string", + "enum":[ + "CONNECTED", + "NOT_CONNECTED" + ] + }, + "SessionList":{ + "type":"list", + "member":{"shape":"Session"}, + "documentation":"

List of sessions.

" + }, + "SessionState":{ + "type":"string", + "documentation":"

Possible values for the state of a streaming session.

", + "enum":[ + "ACTIVE", + "PENDING", + "EXPIRED" + ] + }, + "SettingsGroup":{ + "type":"string", + "max":100 + }, + "SharedImagePermissions":{ + "type":"structure", + "required":[ + "sharedAccountId", + "imagePermissions" + ], + "members":{ + "sharedAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The 12-digit identifier of the AWS account with which the image is shared.

" + }, + "imagePermissions":{ + "shape":"ImagePermissions", + "documentation":"

Describes the permissions for a shared image.

" + } + }, + "documentation":"

Describes the permissions that are available to the specified AWS account for a shared image.

" + }, + "SharedImagePermissionsList":{ + "type":"list", + "member":{"shape":"SharedImagePermissions"} + }, + "Stack":{ + "type":"structure", + "required":["Name"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the stack.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the stack.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"String", + "documentation":"

The stack name to display.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The time the stack was created.

" + }, + "StorageConnectors":{ + "shape":"StorageConnectorList", + "documentation":"

The storage connectors to enable.

" + }, + "RedirectURL":{ + "shape":"RedirectURL", + "documentation":"

The URL that users are redirected to after their streaming session ends.

" + }, + "FeedbackURL":{ + "shape":"FeedbackURL", + "documentation":"

The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" + }, + "StackErrors":{ + "shape":"StackErrors", + "documentation":"

The errors for the stack.

" + }, + "UserSettings":{ + "shape":"UserSettingList", + "documentation":"

The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.

" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettingsResponse", + "documentation":"

The persistent application settings for users of the stack.

" + }, + "AccessEndpoints":{ + "shape":"AccessEndpointList", + "documentation":"

The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + }, + "EmbedHostDomains":{ + "shape":"EmbedHostDomains", + "documentation":"

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" + } + }, + "documentation":"

Describes a stack.

" + }, + "StackAttribute":{ + "type":"string", + "enum":[ + "STORAGE_CONNECTORS", + "STORAGE_CONNECTOR_HOMEFOLDERS", + "STORAGE_CONNECTOR_GOOGLE_DRIVE", + "STORAGE_CONNECTOR_ONE_DRIVE", + "REDIRECT_URL", + "FEEDBACK_URL", + "THEME_NAME", + "USER_SETTINGS", + "EMBED_HOST_DOMAINS", + "IAM_ROLE_ARN", + "ACCESS_ENDPOINTS" + ] + }, + "StackAttributes":{ + "type":"list", + "member":{"shape":"StackAttribute"} + }, + "StackError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"StackErrorCode", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message.

" + } + }, + "documentation":"

Describes a stack error.

" + }, + "StackErrorCode":{ + "type":"string", + "enum":[ + "STORAGE_CONNECTOR_ERROR", + "INTERNAL_SERVICE_ERROR" + ] + }, + "StackErrors":{ + "type":"list", + "member":{"shape":"StackError"}, + "documentation":"

The stack errors.

" + }, + "StackList":{ + "type":"list", + "member":{"shape":"Stack"}, + "documentation":"

The stacks.

" + }, + "StartFleetRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + } + } + }, + "StartFleetResult":{ + "type":"structure", + "members":{ + } + }, + "StartImageBuilderRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the image builder.

" + }, + "AppstreamAgentVersion":{ + "shape":"AppstreamAgentVersion", + "documentation":"

The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].

" + } + } + }, + "StartImageBuilderResult":{ + "type":"structure", + "members":{ + "ImageBuilder":{ + "shape":"ImageBuilder", + "documentation":"

Information about the image builder.

" + } + } + }, + "StopFleetRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the fleet.

" + } + } + }, + "StopFleetResult":{ + "type":"structure", + "members":{ + } + }, + "StopImageBuilderRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the image builder.

" + } + } + }, + "StopImageBuilderResult":{ + "type":"structure", + "members":{ + "ImageBuilder":{ + "shape":"ImageBuilder", + "documentation":"

Information about the image builder.

" + } + } + }, + "StorageConnector":{ + "type":"structure", + "required":["ConnectorType"], + "members":{ + "ConnectorType":{ + "shape":"StorageConnectorType", + "documentation":"

The type of storage connector.

" + }, + "ResourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

The ARN of the storage connector.

" + }, + "Domains":{ + "shape":"DomainList", + "documentation":"

The names of the domains for the account.

" + } + }, + "documentation":"

Describes a connector that enables persistent storage for users.

" + }, + "StorageConnectorList":{ + "type":"list", + "member":{"shape":"StorageConnector"}, + "documentation":"

The storage connectors.

" + }, + "StorageConnectorType":{ + "type":"string", + "documentation":"

The type of storage connector.

", + "enum":[ + "HOMEFOLDERS", + "GOOGLE_DRIVE", + "ONE_DRIVE" + ] + }, + "StreamingUrlUserId":{ + "type":"string", + "max":32, + "min":2, + "pattern":"[\\w+=,.@-]*" + }, + "String":{ + "type":"string", + "min":1 + }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetIdList":{ + "type":"list", + "member":{"shape":"String"}, + "documentation":"

The subnet identifiers.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=.

If you do not specify a value, the value is set to an empty string.

Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters:

_ . : / = + \\ - @

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tag keys for the tags to disassociate.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDirectoryConfigRequest":{ + "type":"structure", + "required":["DirectoryName"], + "members":{ + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

The name of the Directory Config object.

" + }, + "OrganizationalUnitDistinguishedNames":{ + "shape":"OrganizationalUnitDistinguishedNamesList", + "documentation":"

The distinguished names of the organizational units for computer accounts.

" + }, + "ServiceAccountCredentials":{ + "shape":"ServiceAccountCredentials", + "documentation":"

The credentials for the service account used by the fleet or image builder to connect to the directory.

" + } + } + }, + "UpdateDirectoryConfigResult":{ + "type":"structure", + "members":{ + "DirectoryConfig":{ + "shape":"DirectoryConfig", + "documentation":"

Information about the Directory Config object.

" + } + } + }, + "UpdateFleetRequest":{ + "type":"structure", + "members":{ + "ImageName":{ + "shape":"String", + "documentation":"

The name of the image used to create the fleet.

" + }, + "ImageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the public, private, or shared image to use.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A unique name for the fleet.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type to use when launching fleet instances. The following instance types are available:

  • stream.standard.medium

  • stream.standard.large

  • stream.compute.large

  • stream.compute.xlarge

  • stream.compute.2xlarge

  • stream.compute.4xlarge

  • stream.compute.8xlarge

  • stream.memory.large

  • stream.memory.xlarge

  • stream.memory.2xlarge

  • stream.memory.4xlarge

  • stream.memory.8xlarge

  • stream.graphics-design.large

  • stream.graphics-design.xlarge

  • stream.graphics-design.2xlarge

  • stream.graphics-design.4xlarge

  • stream.graphics-desktop.2xlarge

  • stream.graphics-pro.4xlarge

  • stream.graphics-pro.8xlarge

  • stream.graphics-pro.16xlarge

" + }, + "ComputeCapacity":{ + "shape":"ComputeCapacity", + "documentation":"

The desired capacity for the fleet.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC configuration for the fleet.

" + }, + "MaxUserDurationInSeconds":{ + "shape":"Integer", + "documentation":"

The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Specify a value between 600 and 360000.

" + }, + "DisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Specify a value between 60 and 360000.

" + }, + "DeleteVpcConfig":{ + "shape":"Boolean", + "documentation":"

Deletes the VPC association for the specified fleet.

", + "deprecated":true + }, + "Description":{ + "shape":"Description", + "documentation":"

The description to display.

" + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The fleet name to display.

" + }, + "EnableDefaultInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables default internet access for the fleet.

" + }, + "DomainJoinInfo":{ + "shape":"DomainJoinInfo", + "documentation":"

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

" + }, + "IdleDisconnectTimeoutInSeconds":{ + "shape":"Integer", + "documentation":"

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected.

To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.

If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.

" + }, + "AttributesToDelete":{ + "shape":"FleetAttributes", + "documentation":"

The fleet attributes to delete.

" + }, + "IamRoleArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the AppStream_Machine_Role credential profile on the instance.

For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.

" + } + } + }, + "UpdateFleetResult":{ + "type":"structure", + "members":{ + "Fleet":{ + "shape":"Fleet", + "documentation":"

Information about the fleet.

" + } + } + }, + "UpdateImagePermissionsRequest":{ + "type":"structure", + "required":[ + "Name", + "SharedAccountId", + "ImagePermissions" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the private image.

" + }, + "SharedAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The 12-digit identifier of the AWS account for which you want add or update image permissions.

" + }, + "ImagePermissions":{ + "shape":"ImagePermissions", + "documentation":"

The permissions for the image.

" + } + } + }, + "UpdateImagePermissionsResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateStackRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

The stack name to display.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description to display.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the stack.

" + }, + "StorageConnectors":{ + "shape":"StorageConnectorList", + "documentation":"

The storage connectors to enable.

" + }, + "DeleteStorageConnectors":{ + "shape":"Boolean", + "documentation":"

Deletes the storage connectors currently enabled for the stack.

", + "deprecated":true + }, + "RedirectURL":{ + "shape":"RedirectURL", + "documentation":"

The URL that users are redirected to after their streaming session ends.

" + }, + "FeedbackURL":{ + "shape":"FeedbackURL", + "documentation":"

The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.

" + }, + "AttributesToDelete":{ + "shape":"StackAttributes", + "documentation":"

The stack attributes to delete.

" + }, + "UserSettings":{ + "shape":"UserSettingList", + "documentation":"

The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.

" + }, + "ApplicationSettings":{ + "shape":"ApplicationSettings", + "documentation":"

The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.

" + }, + "AccessEndpoints":{ + "shape":"AccessEndpointList", + "documentation":"

The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.

" + }, + "EmbedHostDomains":{ + "shape":"EmbedHostDomains", + "documentation":"

The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.

" + } + } + }, + "UpdateStackResult":{ + "type":"structure", + "members":{ + "Stack":{ + "shape":"Stack", + "documentation":"

Information about the stack.

" + } + } + }, + "UsageReportExecutionErrorCode":{ + "type":"string", + "enum":[ + "RESOURCE_NOT_FOUND", + "ACCESS_DENIED", + "INTERNAL_SERVICE_ERROR" + ] + }, + "UsageReportSchedule":{ + "type":"string", + "enum":["DAILY"] + }, + "UsageReportSubscription":{ + "type":"structure", + "members":{ + "S3BucketName":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where generated reports are stored.

If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.

" + }, + "Schedule":{ + "shape":"UsageReportSchedule", + "documentation":"

The schedule for generating usage reports.

" + }, + "LastGeneratedReportDate":{ + "shape":"Timestamp", + "documentation":"

The time when the last usage report was generated.

" + }, + "SubscriptionErrors":{ + "shape":"LastReportGenerationExecutionErrors", + "documentation":"

The errors that were returned if usage reports couldn't be generated.

" + } + }, + "documentation":"

Describes information about the usage report subscription.

" + }, + "UsageReportSubscriptionList":{ + "type":"list", + "member":{"shape":"UsageReportSubscription"} + }, + "User":{ + "type":"structure", + "required":["AuthenticationType"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the user.

" + }, + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user.

Users' email addresses are case-sensitive.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether the user in the user pool is enabled.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the user in the user pool. The status can be one of the following:

  • UNCONFIRMED – The user is created but not confirmed.

  • CONFIRMED – The user is confirmed.

  • ARCHIVED – The user is no longer active.

  • COMPROMISED – The user is disabled because of a potential security threat.

  • UNKNOWN – The user status is not known.

" + }, + "FirstName":{ + "shape":"UserAttributeValue", + "documentation":"

The first name, or given name, of the user.

" + }, + "LastName":{ + "shape":"UserAttributeValue", + "documentation":"

The last name, or surname, of the user.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the user was created in the user pool.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user.

" + } + }, + "documentation":"

Describes a user in the user pool.

" + }, + "UserAttributeValue":{ + "type":"string", + "max":2048, + "pattern":"^[A-Za-z0-9_\\-\\s]+$", + "sensitive":true + }, + "UserId":{ + "type":"string", + "max":32, + "min":2 + }, + "UserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "UserSetting":{ + "type":"structure", + "required":[ + "Action", + "Permission" + ], + "members":{ + "Action":{ + "shape":"Action", + "documentation":"

The action that is enabled or disabled.

" + }, + "Permission":{ + "shape":"Permission", + "documentation":"

Indicates whether the action is enabled or disabled.

" + } + }, + "documentation":"

Describes an action and whether the action is enabled or disabled for users during their streaming sessions.

" + }, + "UserSettingList":{ + "type":"list", + "member":{"shape":"UserSetting"}, + "min":1 + }, + "UserStackAssociation":{ + "type":"structure", + "required":[ + "StackName", + "UserName", + "AuthenticationType" + ], + "members":{ + "StackName":{ + "shape":"String", + "documentation":"

The name of the stack that is associated with the user.

" + }, + "UserName":{ + "shape":"Username", + "documentation":"

The email address of the user who is associated with the stack.

Users' email addresses are case-sensitive.

" + }, + "AuthenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type for the user.

" + }, + "SendEmailNotification":{ + "shape":"Boolean", + "documentation":"

Specifies whether a welcome email is sent to a user after the user is created in the user pool.

" + } + }, + "documentation":"

Describes a user in the user pool and the associated stack.

" + }, + "UserStackAssociationError":{ + "type":"structure", + "members":{ + "UserStackAssociation":{ + "shape":"UserStackAssociation", + "documentation":"

Information about the user and associated stack.

" + }, + "ErrorCode":{ + "shape":"UserStackAssociationErrorCode", + "documentation":"

The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.

" + } + }, + "documentation":"

Describes the error that is returned when a user can’t be associated with or disassociated from a stack.

" + }, + "UserStackAssociationErrorCode":{ + "type":"string", + "enum":[ + "STACK_NOT_FOUND", + "USER_NAME_NOT_FOUND", + "INTERNAL_ERROR" + ] + }, + "UserStackAssociationErrorList":{ + "type":"list", + "member":{"shape":"UserStackAssociationError"} + }, + "UserStackAssociationList":{ + "type":"list", + "member":{"shape":"UserStackAssociation"}, + "max":25, + "min":1 + }, + "Username":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", + "sensitive":true + }, + "VisibilityType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE", + "SHARED" + ] + }, + "VpcConfig":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIdList", + "documentation":"

The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdList", + "documentation":"

The identifiers of the security groups for the fleet or image builder.

" + } + }, + "documentation":"

Describes VPC configuration information for fleets and image builders.

" + } + }, + "documentation":"Amazon AppStream 2.0

This is the Amazon AppStream 2.0 API Reference. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.

You can call the AppStream 2.0 API operations by using an interface VPC endpoint (interface endpoint). For more information, see Access AppStream 2.0 API Operations and CLI Commands Through an Interface VPC Endpoint in the Amazon AppStream 2.0 Administration Guide.

To learn more about AppStream 2.0, see the following resources:

" +} diff --git a/aws/dist/botocore/data/appstream/2016-12-01/waiters-2.json b/aws/dist/botocore/data/appstream/2016-12-01/waiters-2.json new file mode 100644 index 00000000..f53f609c --- /dev/null +++ b/aws/dist/botocore/data/appstream/2016-12-01/waiters-2.json @@ -0,0 +1,55 @@ +{ + "version": 2, + "waiters": { + "FleetStarted": { + "delay": 30, + "maxAttempts": 40, + "operation": "DescribeFleets", + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Fleets[].State", + "expected": "ACTIVE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "PENDING_DEACTIVATE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "INACTIVE" + } + ] + }, + "FleetStopped": { + "delay": 30, + "maxAttempts": 40, + "operation": "DescribeFleets", + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Fleets[].State", + "expected": "INACTIVE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "PENDING_ACTIVATE" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Fleets[].State", + "expected": "ACTIVE" + } + ] + } + } +} \ No newline at end of file diff --git a/aws/dist/botocore/data/appsync/2017-07-25/paginators-1.json b/aws/dist/botocore/data/appsync/2017-07-25/paginators-1.json new file mode 100644 index 00000000..487d71e6 --- /dev/null +++ b/aws/dist/botocore/data/appsync/2017-07-25/paginators-1.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "ListApiKeys": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "apiKeys" + }, + "ListDataSources": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "dataSources" + }, + "ListFunctions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "functions" + }, + "ListGraphqlApis": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "graphqlApis" + }, + "ListResolvers": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resolvers" + }, + "ListResolversByFunction": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resolvers" + }, + "ListTypes": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "types" + } + } +} diff --git a/aws/dist/botocore/data/appsync/2017-07-25/service-2.json b/aws/dist/botocore/data/appsync/2017-07-25/service-2.json new file mode 100644 index 00000000..2f5c90d8 --- /dev/null +++ b/aws/dist/botocore/data/appsync/2017-07-25/service-2.json @@ -0,0 +1,2687 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-25", + "endpointPrefix":"appsync", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"AWSAppSync", + "serviceFullName":"AWS AppSync", + "serviceId":"AppSync", + "signatureVersion":"v4", + "signingName":"appsync", + "uid":"appsync-2017-07-25" + }, + "operations":{ + "CreateApiKey":{ + "name":"CreateApiKey", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/apikeys" + }, + "input":{"shape":"CreateApiKeyRequest"}, + "output":{"shape":"CreateApiKeyResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ApiKeyLimitExceededException"}, + {"shape":"ApiKeyValidityOutOfBoundsException"} + ], + "documentation":"

Creates a unique key that you can distribute to clients who are executing your API.

" + }, + "CreateDataSource":{ + "name":"CreateDataSource", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/datasources" + }, + "input":{"shape":"CreateDataSourceRequest"}, + "output":{"shape":"CreateDataSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a DataSource object.

" + }, + "CreateFunction":{ + "name":"CreateFunction", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/functions" + }, + "input":{"shape":"CreateFunctionRequest"}, + "output":{"shape":"CreateFunctionResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a Function object.

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

" + }, + "CreateGraphqlApi":{ + "name":"CreateGraphqlApi", + "http":{ + "method":"POST", + "requestUri":"/v1/apis" + }, + "input":{"shape":"CreateGraphqlApiRequest"}, + "output":{"shape":"CreateGraphqlApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ApiLimitExceededException"} + ], + "documentation":"

Creates a GraphqlApi object.

" + }, + "CreateResolver":{ + "name":"CreateResolver", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers" + }, + "input":{"shape":"CreateResolverRequest"}, + "output":{"shape":"CreateResolverResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a Resolver object.

A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.

" + }, + "CreateType":{ + "name":"CreateType", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/types" + }, + "input":{"shape":"CreateTypeRequest"}, + "output":{"shape":"CreateTypeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a Type object.

" + }, + "DeleteApiKey":{ + "name":"DeleteApiKey", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}/apikeys/{id}" + }, + "input":{"shape":"DeleteApiKeyRequest"}, + "output":{"shape":"DeleteApiKeyResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes an API key.

" + }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}/datasources/{name}" + }, + "input":{"shape":"DeleteDataSourceRequest"}, + "output":{"shape":"DeleteDataSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a DataSource object.

" + }, + "DeleteFunction":{ + "name":"DeleteFunction", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}/functions/{functionId}" + }, + "input":{"shape":"DeleteFunctionRequest"}, + "output":{"shape":"DeleteFunctionResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a Function.

" + }, + "DeleteGraphqlApi":{ + "name":"DeleteGraphqlApi", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}" + }, + "input":{"shape":"DeleteGraphqlApiRequest"}, + "output":{"shape":"DeleteGraphqlApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a GraphqlApi object.

" + }, + "DeleteResolver":{ + "name":"DeleteResolver", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input":{"shape":"DeleteResolverRequest"}, + "output":{"shape":"DeleteResolverResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a Resolver object.

" + }, + "DeleteType":{ + "name":"DeleteType", + "http":{ + "method":"DELETE", + "requestUri":"/v1/apis/{apiId}/types/{typeName}" + }, + "input":{"shape":"DeleteTypeRequest"}, + "output":{"shape":"DeleteTypeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a Type object.

" + }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/datasources/{name}" + }, + "input":{"shape":"GetDataSourceRequest"}, + "output":{"shape":"GetDataSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves a DataSource object.

" + }, + "GetFunction":{ + "name":"GetFunction", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/functions/{functionId}" + }, + "input":{"shape":"GetFunctionRequest"}, + "output":{"shape":"GetFunctionResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Get a Function.

" + }, + "GetGraphqlApi":{ + "name":"GetGraphqlApi", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}" + }, + "input":{"shape":"GetGraphqlApiRequest"}, + "output":{"shape":"GetGraphqlApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves a GraphqlApi object.

" + }, + "GetIntrospectionSchema":{ + "name":"GetIntrospectionSchema", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/schema" + }, + "input":{"shape":"GetIntrospectionSchemaRequest"}, + "output":{"shape":"GetIntrospectionSchemaResponse"}, + "errors":[ + {"shape":"GraphQLSchemaException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves the introspection schema for a GraphQL API.

" + }, + "GetResolver":{ + "name":"GetResolver", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input":{"shape":"GetResolverRequest"}, + "output":{"shape":"GetResolverResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves a Resolver object.

" + }, + "GetSchemaCreationStatus":{ + "name":"GetSchemaCreationStatus", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/schemacreation" + }, + "input":{"shape":"GetSchemaCreationStatusRequest"}, + "output":{"shape":"GetSchemaCreationStatusResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves the current status of a schema creation operation.

" + }, + "GetType":{ + "name":"GetType", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/types/{typeName}" + }, + "input":{"shape":"GetTypeRequest"}, + "output":{"shape":"GetTypeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Retrieves a Type object.

" + }, + "ListApiKeys":{ + "name":"ListApiKeys", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/apikeys" + }, + "input":{"shape":"ListApiKeysRequest"}, + "output":{"shape":"ListApiKeysResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the API keys for a given API.

API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.

" + }, + "ListDataSources":{ + "name":"ListDataSources", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/datasources" + }, + "input":{"shape":"ListDataSourcesRequest"}, + "output":{"shape":"ListDataSourcesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the data sources for a given API.

" + }, + "ListFunctions":{ + "name":"ListFunctions", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/functions" + }, + "input":{"shape":"ListFunctionsRequest"}, + "output":{"shape":"ListFunctionsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

List multiple functions.

" + }, + "ListGraphqlApis":{ + "name":"ListGraphqlApis", + "http":{ + "method":"GET", + "requestUri":"/v1/apis" + }, + "input":{"shape":"ListGraphqlApisRequest"}, + "output":{"shape":"ListGraphqlApisResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists your GraphQL APIs.

" + }, + "ListResolvers":{ + "name":"ListResolvers", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers" + }, + "input":{"shape":"ListResolversRequest"}, + "output":{"shape":"ListResolversResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the resolvers for a given API and type.

" + }, + "ListResolversByFunction":{ + "name":"ListResolversByFunction", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/functions/{functionId}/resolvers" + }, + "input":{"shape":"ListResolversByFunctionRequest"}, + "output":{"shape":"ListResolversByFunctionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

List the resolvers that are associated with a specific function.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/v1/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the tags for a resource.

" + }, + "ListTypes":{ + "name":"ListTypes", + "http":{ + "method":"GET", + "requestUri":"/v1/apis/{apiId}/types" + }, + "input":{"shape":"ListTypesRequest"}, + "output":{"shape":"ListTypesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the types for a given API.

" + }, + "StartSchemaCreation":{ + "name":"StartSchemaCreation", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/schemacreation" + }, + "input":{"shape":"StartSchemaCreationRequest"}, + "output":{"shape":"StartSchemaCreationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Adds a new schema to your GraphQL API.

This operation is asynchronous. Use to determine when it has completed.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Tags a resource with user-supplied tags.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Untags a resource.

" + }, + "UpdateApiKey":{ + "name":"UpdateApiKey", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/apikeys/{id}" + }, + "input":{"shape":"UpdateApiKeyRequest"}, + "output":{"shape":"UpdateApiKeyResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ApiKeyValidityOutOfBoundsException"} + ], + "documentation":"

Updates an API key.

" + }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/datasources/{name}" + }, + "input":{"shape":"UpdateDataSourceRequest"}, + "output":{"shape":"UpdateDataSourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a DataSource object.

" + }, + "UpdateFunction":{ + "name":"UpdateFunction", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/functions/{functionId}" + }, + "input":{"shape":"UpdateFunctionRequest"}, + "output":{"shape":"UpdateFunctionResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a Function object.

" + }, + "UpdateGraphqlApi":{ + "name":"UpdateGraphqlApi", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}" + }, + "input":{"shape":"UpdateGraphqlApiRequest"}, + "output":{"shape":"UpdateGraphqlApiResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates a GraphqlApi object.

" + }, + "UpdateResolver":{ + "name":"UpdateResolver", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/types/{typeName}/resolvers/{fieldName}" + }, + "input":{"shape":"UpdateResolverRequest"}, + "output":{"shape":"UpdateResolverResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a Resolver object.

" + }, + "UpdateType":{ + "name":"UpdateType", + "http":{ + "method":"POST", + "requestUri":"/v1/apis/{apiId}/types/{typeName}" + }, + "input":{"shape":"UpdateTypeRequest"}, + "output":{"shape":"UpdateTypeResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a Type object.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You do not have access to perform this operation on this resource.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AdditionalAuthenticationProvider":{ + "type":"structure", + "members":{ + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

" + }, + "openIDConnectConfig":{ + "shape":"OpenIDConnectConfig", + "documentation":"

The OpenID Connect configuration.

" + }, + "userPoolConfig":{ + "shape":"CognitoUserPoolConfig", + "documentation":"

The Amazon Cognito user pool configuration.

" + } + }, + "documentation":"

Describes an additional authentication provider.

" + }, + "AdditionalAuthenticationProviders":{ + "type":"list", + "member":{"shape":"AdditionalAuthenticationProvider"} + }, + "ApiKey":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The API key ID.

" + }, + "description":{ + "shape":"String", + "documentation":"

A description of the purpose of the API key.

" + }, + "expires":{ + "shape":"Long", + "documentation":"

The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.

" + } + }, + "documentation":"

Describes an API key.

Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:

da1: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.

  • ListApiKeys returns the expiration time in milliseconds.

  • CreateApiKey returns the expiration time in milliseconds.

  • UpdateApiKey is not available for this key version.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.

da2: This version was introduced in February 2018 when AppSync added support to extend key expiration.

  • ListApiKeys returns the expiration time in seconds.

  • CreateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds.

  • UpdateApiKey returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.

  • DeleteApiKey deletes the item from the table.

  • Expiration is stored in Amazon DynamoDB as seconds.

" + }, + "ApiKeyLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The API key exceeded a limit. Try your request again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ApiKeyValidityOutOfBoundsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The API key expiration must be set to a value between 1 and 365 days from creation (for CreateApiKey) or from update (for UpdateApiKey).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ApiKeys":{ + "type":"list", + "member":{"shape":"ApiKey"} + }, + "ApiLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The GraphQL API exceeded a limit. Try your request again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AuthenticationType":{ + "type":"string", + "enum":[ + "API_KEY", + "AWS_IAM", + "AMAZON_COGNITO_USER_POOLS", + "OPENID_CONNECT" + ] + }, + "AuthorizationConfig":{ + "type":"structure", + "required":["authorizationType"], + "members":{ + "authorizationType":{ + "shape":"AuthorizationType", + "documentation":"

The authorization type required by the HTTP endpoint.

  • AWS_IAM: The authorization type is Sigv4.

" + }, + "awsIamConfig":{ + "shape":"AwsIamConfig", + "documentation":"

The AWS IAM settings.

" + } + }, + "documentation":"

The authorization config in case the HTTP endpoint requires authorization.

" + }, + "AuthorizationType":{ + "type":"string", + "enum":["AWS_IAM"] + }, + "AwsIamConfig":{ + "type":"structure", + "members":{ + "signingRegion":{ + "shape":"String", + "documentation":"

The signing region for AWS IAM authorization.

" + }, + "signingServiceName":{ + "shape":"String", + "documentation":"

The signing service name for AWS IAM authorization.

" + } + }, + "documentation":"

The AWS IAM configuration.

" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Blob":{"type":"blob"}, + "Boolean":{"type":"boolean"}, + "BooleanValue":{"type":"boolean"}, + "CognitoUserPoolConfig":{ + "type":"structure", + "required":[ + "userPoolId", + "awsRegion" + ], + "members":{ + "userPoolId":{ + "shape":"String", + "documentation":"

The user pool ID.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The AWS Region in which the user pool was created.

" + }, + "appIdClientRegex":{ + "shape":"String", + "documentation":"

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

" + } + }, + "documentation":"

Describes an Amazon Cognito user pool configuration.

" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Another modification is in progress at this time and it must complete before you can make your change.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CreateApiKeyRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The ID for your GraphQL API.

", + "location":"uri", + "locationName":"apiId" + }, + "description":{ + "shape":"String", + "documentation":"

A description of the purpose of the API key.

" + }, + "expires":{ + "shape":"Long", + "documentation":"

The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .

" + } + } + }, + "CreateApiKeyResponse":{ + "type":"structure", + "members":{ + "apiKey":{ + "shape":"ApiKey", + "documentation":"

The API key.

" + } + } + }, + "CreateDataSourceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name", + "type" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID for the GraphQL API for the DataSource.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

A user-supplied name for the DataSource.

" + }, + "description":{ + "shape":"String", + "documentation":"

A description of the DataSource.

" + }, + "type":{ + "shape":"DataSourceType", + "documentation":"

The type of the DataSource.

" + }, + "serviceRoleArn":{ + "shape":"String", + "documentation":"

The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.

" + }, + "dynamodbConfig":{ + "shape":"DynamodbDataSourceConfig", + "documentation":"

Amazon DynamoDB settings.

" + }, + "lambdaConfig":{ + "shape":"LambdaDataSourceConfig", + "documentation":"

AWS Lambda settings.

" + }, + "elasticsearchConfig":{ + "shape":"ElasticsearchDataSourceConfig", + "documentation":"

Amazon Elasticsearch Service settings.

" + }, + "httpConfig":{ + "shape":"HttpDataSourceConfig", + "documentation":"

HTTP endpoint settings.

" + }, + "relationalDatabaseConfig":{ + "shape":"RelationalDatabaseDataSourceConfig", + "documentation":"

Relational database settings.

" + } + } + }, + "CreateDataSourceResponse":{ + "type":"structure", + "members":{ + "dataSource":{ + "shape":"DataSource", + "documentation":"

The DataSource object.

" + } + } + }, + "CreateFunctionRequest":{ + "type":"structure", + "required":[ + "apiId", + "name", + "dataSourceName", + "requestMappingTemplate", + "functionVersion" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The GraphQL API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

The Function name. The function name does not have to be unique.

" + }, + "description":{ + "shape":"String", + "documentation":"

The Function description.

" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The Function DataSource name.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function response mapping template.

" + }, + "functionVersion":{ + "shape":"String", + "documentation":"

The version of the request mapping template. Currently the supported value is 2018-05-29.

" + } + } + }, + "CreateFunctionResponse":{ + "type":"structure", + "members":{ + "functionConfiguration":{ + "shape":"FunctionConfiguration", + "documentation":"

The Function object.

" + } + } + }, + "CreateGraphqlApiRequest":{ + "type":"structure", + "required":[ + "name", + "authenticationType" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"

A user-supplied name for the GraphqlApi.

" + }, + "logConfig":{ + "shape":"LogConfig", + "documentation":"

The Amazon CloudWatch Logs configuration.

" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

" + }, + "userPoolConfig":{ + "shape":"UserPoolConfig", + "documentation":"

The Amazon Cognito user pool configuration.

" + }, + "openIDConnectConfig":{ + "shape":"OpenIDConnectConfig", + "documentation":"

The OpenID Connect configuration.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

A TagMap object.

" + }, + "additionalAuthenticationProviders":{ + "shape":"AdditionalAuthenticationProviders", + "documentation":"

A list of additional authentication providers for the GraphqlApi API.

" + } + } + }, + "CreateGraphqlApiResponse":{ + "type":"structure", + "members":{ + "graphqlApi":{ + "shape":"GraphqlApi", + "documentation":"

The GraphqlApi.

" + } + } + }, + "CreateResolverRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "fieldName", + "requestMappingTemplate" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The ID for the GraphQL API for which the resolver is being created.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The name of the Type.

", + "location":"uri", + "locationName":"typeName" + }, + "fieldName":{ + "shape":"ResourceName", + "documentation":"

The name of the field to attach the resolver to.

" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the data source for which the resolver is being created.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The mapping template to be used for requests.

A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The mapping template to be used for responses from the data source.

" + }, + "kind":{ + "shape":"ResolverKind", + "documentation":"

The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.

  • PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

" + }, + "pipelineConfig":{ + "shape":"PipelineConfig", + "documentation":"

The PipelineConfig.

" + } + } + }, + "CreateResolverResponse":{ + "type":"structure", + "members":{ + "resolver":{ + "shape":"Resolver", + "documentation":"

The Resolver object.

" + } + } + }, + "CreateTypeRequest":{ + "type":"structure", + "required":[ + "apiId", + "definition", + "format" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "definition":{ + "shape":"String", + "documentation":"

The type definition, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

" + }, + "format":{ + "shape":"TypeDefinitionFormat", + "documentation":"

The type format: SDL or JSON.

" + } + } + }, + "CreateTypeResponse":{ + "type":"structure", + "members":{ + "type":{ + "shape":"Type", + "documentation":"

The Type object.

" + } + } + }, + "DataSource":{ + "type":"structure", + "members":{ + "dataSourceArn":{ + "shape":"String", + "documentation":"

The data source ARN.

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

The name of the data source.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the data source.

" + }, + "type":{ + "shape":"DataSourceType", + "documentation":"

The type of the data source.

  • AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table.

  • AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain.

  • AWS_LAMBDA: The data source is an AWS Lambda function.

  • NONE: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.

  • HTTP: The data source is an HTTP endpoint.

  • RELATIONAL_DATABASE: The data source is a relational database.

" + }, + "serviceRoleArn":{ + "shape":"String", + "documentation":"

The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.

" + }, + "dynamodbConfig":{ + "shape":"DynamodbDataSourceConfig", + "documentation":"

Amazon DynamoDB settings.

" + }, + "lambdaConfig":{ + "shape":"LambdaDataSourceConfig", + "documentation":"

AWS Lambda settings.

" + }, + "elasticsearchConfig":{ + "shape":"ElasticsearchDataSourceConfig", + "documentation":"

Amazon Elasticsearch Service settings.

" + }, + "httpConfig":{ + "shape":"HttpDataSourceConfig", + "documentation":"

HTTP endpoint settings.

" + }, + "relationalDatabaseConfig":{ + "shape":"RelationalDatabaseDataSourceConfig", + "documentation":"

Relational database settings.

" + } + }, + "documentation":"

Describes a data source.

" + }, + "DataSourceType":{ + "type":"string", + "enum":[ + "AWS_LAMBDA", + "AMAZON_DYNAMODB", + "AMAZON_ELASTICSEARCH", + "NONE", + "HTTP", + "RELATIONAL_DATABASE" + ] + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DefaultAction":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "DeleteApiKeyRequest":{ + "type":"structure", + "required":[ + "apiId", + "id" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "id":{ + "shape":"String", + "documentation":"

The ID for the API key.

", + "location":"uri", + "locationName":"id" + } + } + }, + "DeleteApiKeyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDataSourceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the data source.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteDataSourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteFunctionRequest":{ + "type":"structure", + "required":[ + "apiId", + "functionId" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The GraphQL API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "functionId":{ + "shape":"ResourceName", + "documentation":"

The Function ID.

", + "location":"uri", + "locationName":"functionId" + } + } + }, + "DeleteFunctionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteGraphqlApiRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + } + } + }, + "DeleteGraphqlApiResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteResolverRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "fieldName" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The name of the resolver type.

", + "location":"uri", + "locationName":"typeName" + }, + "fieldName":{ + "shape":"ResourceName", + "documentation":"

The resolver field name.

", + "location":"uri", + "locationName":"fieldName" + } + } + }, + "DeleteResolverResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTypeRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The type name.

", + "location":"uri", + "locationName":"typeName" + } + } + }, + "DeleteTypeResponse":{ + "type":"structure", + "members":{ + } + }, + "DynamodbDataSourceConfig":{ + "type":"structure", + "required":[ + "tableName", + "awsRegion" + ], + "members":{ + "tableName":{ + "shape":"String", + "documentation":"

The table name.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The AWS Region.

" + }, + "useCallerCredentials":{ + "shape":"Boolean", + "documentation":"

Set to TRUE to use Amazon Cognito credentials with this data source.

" + } + }, + "documentation":"

Describes an Amazon DynamoDB data source configuration.

" + }, + "ElasticsearchDataSourceConfig":{ + "type":"structure", + "required":[ + "endpoint", + "awsRegion" + ], + "members":{ + "endpoint":{ + "shape":"String", + "documentation":"

The endpoint.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The AWS Region.

" + } + }, + "documentation":"

Describes an Elasticsearch data source configuration.

" + }, + "ErrorMessage":{"type":"string"}, + "FieldLogLevel":{ + "type":"string", + "enum":[ + "NONE", + "ERROR", + "ALL" + ] + }, + "FunctionConfiguration":{ + "type":"structure", + "members":{ + "functionId":{ + "shape":"String", + "documentation":"

A unique ID representing the Function object.

" + }, + "functionArn":{ + "shape":"String", + "documentation":"

The ARN of the Function object.

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

The name of the Function object.

" + }, + "description":{ + "shape":"String", + "documentation":"

The Function description.

" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the DataSource.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function response mapping template.

" + }, + "functionVersion":{ + "shape":"String", + "documentation":"

The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.

" + } + }, + "documentation":"

A function is a reusable entity. Multiple functions can be used to compose the resolver logic.

" + }, + "Functions":{ + "type":"list", + "member":{"shape":"FunctionConfiguration"} + }, + "FunctionsIds":{ + "type":"list", + "member":{"shape":"String"} + }, + "GetDataSourceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the data source.

", + "location":"uri", + "locationName":"name" + } + } + }, + "GetDataSourceResponse":{ + "type":"structure", + "members":{ + "dataSource":{ + "shape":"DataSource", + "documentation":"

The DataSource object.

" + } + } + }, + "GetFunctionRequest":{ + "type":"structure", + "required":[ + "apiId", + "functionId" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The GraphQL API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "functionId":{ + "shape":"ResourceName", + "documentation":"

The Function ID.

", + "location":"uri", + "locationName":"functionId" + } + } + }, + "GetFunctionResponse":{ + "type":"structure", + "members":{ + "functionConfiguration":{ + "shape":"FunctionConfiguration", + "documentation":"

The Function object.

" + } + } + }, + "GetGraphqlApiRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID for the GraphQL API.

", + "location":"uri", + "locationName":"apiId" + } + } + }, + "GetGraphqlApiResponse":{ + "type":"structure", + "members":{ + "graphqlApi":{ + "shape":"GraphqlApi", + "documentation":"

The GraphqlApi object.

" + } + } + }, + "GetIntrospectionSchemaRequest":{ + "type":"structure", + "required":[ + "apiId", + "format" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "format":{ + "shape":"OutputType", + "documentation":"

The schema format: SDL or JSON.

", + "location":"querystring", + "locationName":"format" + }, + "includeDirectives":{ + "shape":"BooleanValue", + "documentation":"

A flag that specifies whether the schema introspection should contain directives.

", + "location":"querystring", + "locationName":"includeDirectives" + } + } + }, + "GetIntrospectionSchemaResponse":{ + "type":"structure", + "members":{ + "schema":{ + "shape":"Blob", + "documentation":"

The schema, in GraphQL Schema Definition Language (SDL) format.

For more information, see the GraphQL SDL documentation.

" + } + }, + "payload":"schema" + }, + "GetResolverRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "fieldName" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The resolver type name.

", + "location":"uri", + "locationName":"typeName" + }, + "fieldName":{ + "shape":"ResourceName", + "documentation":"

The resolver field name.

", + "location":"uri", + "locationName":"fieldName" + } + } + }, + "GetResolverResponse":{ + "type":"structure", + "members":{ + "resolver":{ + "shape":"Resolver", + "documentation":"

The Resolver object.

" + } + } + }, + "GetSchemaCreationStatusRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + } + } + }, + "GetSchemaCreationStatusResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SchemaStatus", + "documentation":"

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

" + }, + "details":{ + "shape":"String", + "documentation":"

Detailed information about the status of the schema creation operation.

" + } + } + }, + "GetTypeRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "format" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The type name.

", + "location":"uri", + "locationName":"typeName" + }, + "format":{ + "shape":"TypeDefinitionFormat", + "documentation":"

The type format: SDL or JSON.

", + "location":"querystring", + "locationName":"format" + } + } + }, + "GetTypeResponse":{ + "type":"structure", + "members":{ + "type":{ + "shape":"Type", + "documentation":"

The Type object.

" + } + } + }, + "GraphQLSchemaException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The GraphQL schema is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "GraphqlApi":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The API name.

" + }, + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The authentication type.

" + }, + "logConfig":{ + "shape":"LogConfig", + "documentation":"

The Amazon CloudWatch Logs configuration.

" + }, + "userPoolConfig":{ + "shape":"UserPoolConfig", + "documentation":"

The Amazon Cognito user pool configuration.

" + }, + "openIDConnectConfig":{ + "shape":"OpenIDConnectConfig", + "documentation":"

The OpenID Connect configuration.

" + }, + "arn":{ + "shape":"String", + "documentation":"

The ARN.

" + }, + "uris":{ + "shape":"MapOfStringToString", + "documentation":"

The URIs.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags.

" + }, + "additionalAuthenticationProviders":{ + "shape":"AdditionalAuthenticationProviders", + "documentation":"

A list of additional authentication providers for the GraphqlApi API.

" + } + }, + "documentation":"

Describes a GraphQL API.

" + }, + "GraphqlApis":{ + "type":"list", + "member":{"shape":"GraphqlApi"} + }, + "HttpDataSourceConfig":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"String", + "documentation":"

The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.

" + }, + "authorizationConfig":{ + "shape":"AuthorizationConfig", + "documentation":"

The authorization config in case the HTTP endpoint requires authorization.

" + } + }, + "documentation":"

Describes an HTTP data source configuration.

" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

An internal AWS AppSync error occurred. Try your request again.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LambdaDataSourceConfig":{ + "type":"structure", + "required":["lambdaFunctionArn"], + "members":{ + "lambdaFunctionArn":{ + "shape":"String", + "documentation":"

The ARN for the Lambda function.

" + } + }, + "documentation":"

Describes an AWS Lambda data source configuration.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request exceeded a limit. Try your request again.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListApiKeysRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListApiKeysResponse":{ + "type":"structure", + "members":{ + "apiKeys":{ + "shape":"ApiKeys", + "documentation":"

The ApiKey objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be passed in the next request to this operation to return the next set of items in the list.

" + } + } + }, + "ListDataSourcesRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDataSourcesResponse":{ + "type":"structure", + "members":{ + "dataSources":{ + "shape":"DataSources", + "documentation":"

The DataSource objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be passed in the next request to this operation to return the next set of items in the list.

" + } + } + }, + "ListFunctionsRequest":{ + "type":"structure", + "required":["apiId"], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The GraphQL API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListFunctionsResponse":{ + "type":"structure", + "members":{ + "functions":{ + "shape":"Functions", + "documentation":"

A list of Function objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListGraphqlApisRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListGraphqlApisResponse":{ + "type":"structure", + "members":{ + "graphqlApis":{ + "shape":"GraphqlApis", + "documentation":"

The GraphqlApi objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be passed in the next request to this operation to return the next set of items in the list.

" + } + } + }, + "ListResolversByFunctionRequest":{ + "type":"structure", + "required":[ + "apiId", + "functionId" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "functionId":{ + "shape":"String", + "documentation":"

The Function ID.

", + "location":"uri", + "locationName":"functionId" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListResolversByFunctionResponse":{ + "type":"structure", + "members":{ + "resolvers":{ + "shape":"Resolvers", + "documentation":"

The list of resolvers.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that can be used to return the next set of items in the list.

" + } + } + }, + "ListResolversRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"String", + "documentation":"

The type name.

", + "location":"uri", + "locationName":"typeName" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListResolversResponse":{ + "type":"structure", + "members":{ + "resolvers":{ + "shape":"Resolvers", + "documentation":"

The Resolver objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be passed in the next request to this operation to return the next set of items in the list.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The GraphqlApi ARN.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

A TagMap object.

" + } + } + }, + "ListTypesRequest":{ + "type":"structure", + "required":[ + "apiId", + "format" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "format":{ + "shape":"TypeDefinitionFormat", + "documentation":"

The type format: SDL or JSON.

", + "location":"querystring", + "locationName":"format" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results you want the request to return.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListTypesResponse":{ + "type":"structure", + "members":{ + "types":{ + "shape":"TypeList", + "documentation":"

The Type objects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be passed in the next request to this operation to return the next set of items in the list.

" + } + } + }, + "LogConfig":{ + "type":"structure", + "required":[ + "fieldLogLevel", + "cloudWatchLogsRoleArn" + ], + "members":{ + "fieldLogLevel":{ + "shape":"FieldLogLevel", + "documentation":"

The field logging level. Values can be NONE, ERROR, or ALL.

  • NONE: No field-level logs are captured.

  • ERROR: Logs the following information only for the fields that are in error:

    • The error section in the server response.

    • Field-level errors.

    • The generated request/response functions that got resolved for error fields.

  • ALL: The following information is logged for all fields in the query:

    • Field-level tracing information.

    • The generated request/response functions that got resolved for each field.

" + }, + "cloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.

" + }, + "excludeVerboseContent":{ + "shape":"Boolean", + "documentation":"

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

" + } + }, + "documentation":"

The CloudWatch Logs configuration.

" + }, + "Long":{"type":"long"}, + "MapOfStringToString":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MappingTemplate":{ + "type":"string", + "max":65536, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":25, + "min":0 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The resource specified in the request was not found. Check the resource, and then try again.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "OpenIDConnectConfig":{ + "type":"structure", + "required":["issuer"], + "members":{ + "issuer":{ + "shape":"String", + "documentation":"

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

" + }, + "clientId":{ + "shape":"String", + "documentation":"

The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.

" + }, + "iatTTL":{ + "shape":"Long", + "documentation":"

The number of milliseconds a token is valid after being issued to a user.

" + }, + "authTTL":{ + "shape":"Long", + "documentation":"

The number of milliseconds a token is valid after being authenticated.

" + } + }, + "documentation":"

Describes an OpenID Connect configuration.

" + }, + "OutputType":{ + "type":"string", + "enum":[ + "SDL", + "JSON" + ] + }, + "PaginationToken":{ + "type":"string", + "pattern":"[\\\\S]+" + }, + "PipelineConfig":{ + "type":"structure", + "members":{ + "functions":{ + "shape":"FunctionsIds", + "documentation":"

A list of Function objects.

" + } + }, + "documentation":"

The pipeline configuration for a resolver of kind PIPELINE.

" + }, + "RdsHttpEndpointConfig":{ + "type":"structure", + "members":{ + "awsRegion":{ + "shape":"String", + "documentation":"

AWS Region for RDS HTTP endpoint.

" + }, + "dbClusterIdentifier":{ + "shape":"String", + "documentation":"

Amazon RDS cluster identifier.

" + }, + "databaseName":{ + "shape":"String", + "documentation":"

Logical database name.

" + }, + "schema":{ + "shape":"String", + "documentation":"

Logical schema name.

" + }, + "awsSecretStoreArn":{ + "shape":"String", + "documentation":"

AWS secret store ARN for database credentials.

" + } + }, + "documentation":"

The Amazon RDS HTTP endpoint configuration.

" + }, + "RelationalDatabaseDataSourceConfig":{ + "type":"structure", + "members":{ + "relationalDatabaseSourceType":{ + "shape":"RelationalDatabaseSourceType", + "documentation":"

Source type for the relational database.

  • RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.

" + }, + "rdsHttpEndpointConfig":{ + "shape":"RdsHttpEndpointConfig", + "documentation":"

Amazon RDS HTTP endpoint settings.

" + } + }, + "documentation":"

Describes a relational database data source configuration.

" + }, + "RelationalDatabaseSourceType":{ + "type":"string", + "enum":["RDS_HTTP_ENDPOINT"] + }, + "Resolver":{ + "type":"structure", + "members":{ + "typeName":{ + "shape":"ResourceName", + "documentation":"

The resolver type name.

" + }, + "fieldName":{ + "shape":"ResourceName", + "documentation":"

The resolver field name.

" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The resolver data source name.

" + }, + "resolverArn":{ + "shape":"String", + "documentation":"

The resolver ARN.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The request mapping template.

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The response mapping template.

" + }, + "kind":{ + "shape":"ResolverKind", + "documentation":"

The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.

  • PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

" + }, + "pipelineConfig":{ + "shape":"PipelineConfig", + "documentation":"

The PipelineConfig.

" + } + }, + "documentation":"

Describes a resolver.

" + }, + "ResolverKind":{ + "type":"string", + "enum":[ + "UNIT", + "PIPELINE" + ] + }, + "Resolvers":{ + "type":"list", + "member":{"shape":"Resolver"} + }, + "ResourceArn":{ + "type":"string", + "max":75, + "min":70, + "pattern":"^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$" + }, + "ResourceName":{ + "type":"string", + "pattern":"[_A-Za-z][_0-9A-Za-z]*" + }, + "SchemaStatus":{ + "type":"string", + "enum":[ + "PROCESSING", + "ACTIVE", + "DELETING", + "FAILED", + "SUCCESS", + "NOT_APPLICABLE" + ] + }, + "StartSchemaCreationRequest":{ + "type":"structure", + "required":[ + "apiId", + "definition" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "definition":{ + "shape":"Blob", + "documentation":"

The schema definition, in GraphQL schema language format.

" + } + } + }, + "StartSchemaCreationResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SchemaStatus", + "documentation":"

The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.

" + } + } + }, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "documentation":"

The key for the tag.

", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "documentation":"

A map with keys of TagKey objects and values of TagValue objects.

", + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The GraphqlApi ARN.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

A TagMap object.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "documentation":"

The value for the tag.

", + "max":256 + }, + "Type":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The type name.

" + }, + "description":{ + "shape":"String", + "documentation":"

The type description.

" + }, + "arn":{ + "shape":"String", + "documentation":"

The type ARN.

" + }, + "definition":{ + "shape":"String", + "documentation":"

The type definition.

" + }, + "format":{ + "shape":"TypeDefinitionFormat", + "documentation":"

The type format: SDL or JSON.

" + } + }, + "documentation":"

Describes a type.

" + }, + "TypeDefinitionFormat":{ + "type":"string", + "enum":[ + "SDL", + "JSON" + ] + }, + "TypeList":{ + "type":"list", + "member":{"shape":"Type"} + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

You are not authorized to perform this operation.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The GraphqlApi ARN.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of TagKey objects.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApiKeyRequest":{ + "type":"structure", + "required":[ + "apiId", + "id" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The ID for the GraphQL API.

", + "location":"uri", + "locationName":"apiId" + }, + "id":{ + "shape":"String", + "documentation":"

The API key ID.

", + "location":"uri", + "locationName":"id" + }, + "description":{ + "shape":"String", + "documentation":"

A description of the purpose of the API key.

" + }, + "expires":{ + "shape":"Long", + "documentation":"

The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .

" + } + } + }, + "UpdateApiKeyResponse":{ + "type":"structure", + "members":{ + "apiKey":{ + "shape":"ApiKey", + "documentation":"

The API key.

" + } + } + }, + "UpdateDataSourceRequest":{ + "type":"structure", + "required":[ + "apiId", + "name", + "type" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

The new name for the data source.

", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"String", + "documentation":"

The new description for the data source.

" + }, + "type":{ + "shape":"DataSourceType", + "documentation":"

The new data source type.

" + }, + "serviceRoleArn":{ + "shape":"String", + "documentation":"

The new service role ARN for the data source.

" + }, + "dynamodbConfig":{ + "shape":"DynamodbDataSourceConfig", + "documentation":"

The new Amazon DynamoDB configuration.

" + }, + "lambdaConfig":{ + "shape":"LambdaDataSourceConfig", + "documentation":"

The new AWS Lambda configuration.

" + }, + "elasticsearchConfig":{ + "shape":"ElasticsearchDataSourceConfig", + "documentation":"

The new Elasticsearch Service configuration.

" + }, + "httpConfig":{ + "shape":"HttpDataSourceConfig", + "documentation":"

The new HTTP endpoint configuration.

" + }, + "relationalDatabaseConfig":{ + "shape":"RelationalDatabaseDataSourceConfig", + "documentation":"

The new relational database configuration.

" + } + } + }, + "UpdateDataSourceResponse":{ + "type":"structure", + "members":{ + "dataSource":{ + "shape":"DataSource", + "documentation":"

The updated DataSource object.

" + } + } + }, + "UpdateFunctionRequest":{ + "type":"structure", + "required":[ + "apiId", + "name", + "functionId", + "dataSourceName", + "requestMappingTemplate", + "functionVersion" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The GraphQL API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"ResourceName", + "documentation":"

The Function name.

" + }, + "description":{ + "shape":"String", + "documentation":"

The Function description.

" + }, + "functionId":{ + "shape":"ResourceName", + "documentation":"

The function ID.

", + "location":"uri", + "locationName":"functionId" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The Function DataSource name.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The Function request mapping template.

" + }, + "functionVersion":{ + "shape":"String", + "documentation":"

The version of the request mapping template. Currently the supported value is 2018-05-29.

" + } + } + }, + "UpdateFunctionResponse":{ + "type":"structure", + "members":{ + "functionConfiguration":{ + "shape":"FunctionConfiguration", + "documentation":"

The Function object.

" + } + } + }, + "UpdateGraphqlApiRequest":{ + "type":"structure", + "required":[ + "apiId", + "name" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "name":{ + "shape":"String", + "documentation":"

The new name for the GraphqlApi object.

" + }, + "logConfig":{ + "shape":"LogConfig", + "documentation":"

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

" + }, + "authenticationType":{ + "shape":"AuthenticationType", + "documentation":"

The new authentication type for the GraphqlApi object.

" + }, + "userPoolConfig":{ + "shape":"UserPoolConfig", + "documentation":"

The new Amazon Cognito user pool configuration for the GraphqlApi object.

" + }, + "openIDConnectConfig":{ + "shape":"OpenIDConnectConfig", + "documentation":"

The OpenID Connect configuration for the GraphqlApi object.

" + }, + "additionalAuthenticationProviders":{ + "shape":"AdditionalAuthenticationProviders", + "documentation":"

A list of additional authentication providers for the GraphqlApi API.

" + } + } + }, + "UpdateGraphqlApiResponse":{ + "type":"structure", + "members":{ + "graphqlApi":{ + "shape":"GraphqlApi", + "documentation":"

The updated GraphqlApi object.

" + } + } + }, + "UpdateResolverRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "fieldName", + "requestMappingTemplate" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The new type name.

", + "location":"uri", + "locationName":"typeName" + }, + "fieldName":{ + "shape":"ResourceName", + "documentation":"

The new field name.

", + "location":"uri", + "locationName":"fieldName" + }, + "dataSourceName":{ + "shape":"ResourceName", + "documentation":"

The new data source name.

" + }, + "requestMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The new request mapping template.

" + }, + "responseMappingTemplate":{ + "shape":"MappingTemplate", + "documentation":"

The new response mapping template.

" + }, + "kind":{ + "shape":"ResolverKind", + "documentation":"

The resolver type.

  • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.

  • PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.

" + }, + "pipelineConfig":{ + "shape":"PipelineConfig", + "documentation":"

The PipelineConfig.

" + } + } + }, + "UpdateResolverResponse":{ + "type":"structure", + "members":{ + "resolver":{ + "shape":"Resolver", + "documentation":"

The updated Resolver object.

" + } + } + }, + "UpdateTypeRequest":{ + "type":"structure", + "required":[ + "apiId", + "typeName", + "format" + ], + "members":{ + "apiId":{ + "shape":"String", + "documentation":"

The API ID.

", + "location":"uri", + "locationName":"apiId" + }, + "typeName":{ + "shape":"ResourceName", + "documentation":"

The new type name.

", + "location":"uri", + "locationName":"typeName" + }, + "definition":{ + "shape":"String", + "documentation":"

The new definition.

" + }, + "format":{ + "shape":"TypeDefinitionFormat", + "documentation":"

The new type format: SDL or JSON.

" + } + } + }, + "UpdateTypeResponse":{ + "type":"structure", + "members":{ + "type":{ + "shape":"Type", + "documentation":"

The updated Type object.

" + } + } + }, + "UserPoolConfig":{ + "type":"structure", + "required":[ + "userPoolId", + "awsRegion", + "defaultAction" + ], + "members":{ + "userPoolId":{ + "shape":"String", + "documentation":"

The user pool ID.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The AWS Region in which the user pool was created.

" + }, + "defaultAction":{ + "shape":"DefaultAction", + "documentation":"

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

" + }, + "appIdClientRegex":{ + "shape":"String", + "documentation":"

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

" + } + }, + "documentation":"

Describes an Amazon Cognito user pool configuration.

" + } + }, + "documentation":"

AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.

" +} diff --git a/aws/dist/botocore/data/athena/2017-05-18/paginators-1.json b/aws/dist/botocore/data/athena/2017-05-18/paginators-1.json new file mode 100644 index 00000000..41bbb2da --- /dev/null +++ b/aws/dist/botocore/data/athena/2017-05-18/paginators-1.json @@ -0,0 +1,26 @@ +{ + "pagination": { + "ListNamedQueries": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "NamedQueryIds" + }, + "ListQueryExecutions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "QueryExecutionIds" + }, + "GetQueryResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ResultSet.Rows", + "non_aggregate_keys": [ + "ResultSet.ResultSetMetadata", + "UpdateCount" + ] + } + } +} diff --git a/aws/dist/botocore/data/athena/2017-05-18/service-2.json b/aws/dist/botocore/data/athena/2017-05-18/service-2.json new file mode 100644 index 00000000..2cb116c3 --- /dev/null +++ b/aws/dist/botocore/data/athena/2017-05-18/service-2.json @@ -0,0 +1,1440 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-05-18", + "endpointPrefix":"athena", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Athena", + "serviceId":"Athena", + "signatureVersion":"v4", + "targetPrefix":"AmazonAthena", + "uid":"athena-2017-05-18" + }, + "operations":{ + "BatchGetNamedQuery":{ + "name":"BatchGetNamedQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetNamedQueryInput"}, + "output":{"shape":"BatchGetNamedQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use ListNamedQueriesInput to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under UnprocessedNamedQueryId. Named queries differ from executed queries. Use BatchGetQueryExecutionInput to get details about each unique query execution, and ListQueryExecutionsInput to get a list of query execution IDs.

" + }, + "BatchGetQueryExecution":{ + "name":"BatchGetQueryExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetQueryExecutionInput"}, + "output":{"shape":"BatchGetQueryExecutionOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use ListQueryExecutionsInput$WorkGroup. Query executions differ from named (saved) queries. Use BatchGetNamedQueryInput to get details about named queries.

" + }, + "CreateNamedQuery":{ + "name":"CreateNamedQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNamedQueryInput"}, + "output":{"shape":"CreateNamedQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Creates a named query in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", + "idempotent":true + }, + "CreateWorkGroup":{ + "name":"CreateWorkGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkGroupInput"}, + "output":{"shape":"CreateWorkGroupOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Creates a workgroup with the specified name.

" + }, + "DeleteNamedQuery":{ + "name":"DeleteNamedQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNamedQueryInput"}, + "output":{"shape":"DeleteNamedQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes the named query if you have access to the workgroup in which the query was saved.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", + "idempotent":true + }, + "DeleteWorkGroup":{ + "name":"DeleteWorkGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkGroupInput"}, + "output":{"shape":"DeleteWorkGroupOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.

", + "idempotent":true + }, + "GetNamedQuery":{ + "name":"GetNamedQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNamedQueryInput"}, + "output":{"shape":"GetNamedQueryOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.

" + }, + "GetQueryExecution":{ + "name":"GetQueryExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueryExecutionInput"}, + "output":{"shape":"GetQueryExecutionOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.

" + }, + "GetQueryResults":{ + "name":"GetQueryResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueryResultsInput"}, + "output":{"shape":"GetQueryResultsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Streams the results of a single query execution specified by QueryExecutionId from the Athena query results location in Amazon S3. For more information, see Query Results in the Amazon Athena User Guide. This request does not execute the query but returns results. Use StartQueryExecution to run a query.

To stream query results successfully, the IAM principal with permission to call GetQueryResults also must have permissions to the Amazon S3 GetObject action for the Athena query results location.

IAM principals with permission to the Amazon S3 GetObject action for the query results location are able to retrieve query results from Amazon S3 even if permission to the GetQueryResults action is denied. To restrict user or role access, ensure that Amazon S3 permissions to the Athena query location are denied.

" + }, + "GetWorkGroup":{ + "name":"GetWorkGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkGroupInput"}, + "output":{"shape":"GetWorkGroupOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns information about the workgroup with the specified name.

" + }, + "ListNamedQueries":{ + "name":"ListNamedQueries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListNamedQueriesInput"}, + "output":{"shape":"ListNamedQueriesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

" + }, + "ListQueryExecutions":{ + "name":"ListQueryExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQueryExecutionsInput"}, + "output":{"shape":"ListQueryExecutionsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the tags associated with this workgroup.

" + }, + "ListWorkGroups":{ + "name":"ListWorkGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkGroupsInput"}, + "output":{"shape":"ListWorkGroupsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Lists available workgroups for the account.

" + }, + "StartQueryExecution":{ + "name":"StartQueryExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartQueryExecutionInput"}, + "output":{"shape":"StartQueryExecutionOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Runs the SQL query statements contained in the Query. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", + "idempotent":true + }, + "StopQueryExecution":{ + "name":"StopQueryExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopQueryExecutionInput"}, + "output":{"shape":"StopQueryExecutionOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Stops a query execution. Requires you to have access to the workgroup in which the query ran.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

", + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see AWS Tagging Strategies. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.

" + }, + "UpdateWorkGroup":{ + "name":"UpdateWorkGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkGroupInput"}, + "output":{"shape":"UpdateWorkGroupOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Updates the workgroup with the specified name. The workgroup's name cannot be changed.

" + } + }, + "shapes":{ + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "BatchGetNamedQueryInput":{ + "type":"structure", + "required":["NamedQueryIds"], + "members":{ + "NamedQueryIds":{ + "shape":"NamedQueryIdList", + "documentation":"

An array of query IDs.

" + } + } + }, + "BatchGetNamedQueryOutput":{ + "type":"structure", + "members":{ + "NamedQueries":{ + "shape":"NamedQueryList", + "documentation":"

Information about the named query IDs submitted.

" + }, + "UnprocessedNamedQueryIds":{ + "shape":"UnprocessedNamedQueryIdList", + "documentation":"

Information about provided query IDs.

" + } + } + }, + "BatchGetQueryExecutionInput":{ + "type":"structure", + "required":["QueryExecutionIds"], + "members":{ + "QueryExecutionIds":{ + "shape":"QueryExecutionIdList", + "documentation":"

An array of query execution IDs.

" + } + } + }, + "BatchGetQueryExecutionOutput":{ + "type":"structure", + "members":{ + "QueryExecutions":{ + "shape":"QueryExecutionList", + "documentation":"

Information about a query execution.

" + }, + "UnprocessedQueryExecutionIds":{ + "shape":"UnprocessedQueryExecutionIdList", + "documentation":"

Information about the query executions that failed to run.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "BoxedBoolean":{"type":"boolean"}, + "BytesScannedCutoffValue":{ + "type":"long", + "min":10000000 + }, + "ColumnInfo":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "CatalogName":{ + "shape":"String", + "documentation":"

The catalog to which the query results belong.

" + }, + "SchemaName":{ + "shape":"String", + "documentation":"

The schema name (database name) to which the query results belong.

" + }, + "TableName":{ + "shape":"String", + "documentation":"

The table name for the query results.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the column.

" + }, + "Label":{ + "shape":"String", + "documentation":"

A column label.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The data type of the column.

" + }, + "Precision":{ + "shape":"Integer", + "documentation":"

For DECIMAL data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.

" + }, + "Scale":{ + "shape":"Integer", + "documentation":"

For DECIMAL data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.

" + }, + "Nullable":{ + "shape":"ColumnNullable", + "documentation":"

Indicates the column's nullable status.

" + }, + "CaseSensitive":{ + "shape":"Boolean", + "documentation":"

Indicates whether values in the column are case-sensitive.

" + } + }, + "documentation":"

Information about the columns in a query execution result.

" + }, + "ColumnInfoList":{ + "type":"list", + "member":{"shape":"ColumnInfo"} + }, + "ColumnNullable":{ + "type":"string", + "enum":[ + "NOT_NULL", + "NULLABLE", + "UNKNOWN" + ] + }, + "CreateNamedQueryInput":{ + "type":"structure", + "required":[ + "Name", + "Database", + "QueryString" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The query name.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The query description.

" + }, + "Database":{ + "shape":"DatabaseString", + "documentation":"

The database to which the query belongs.

" + }, + "QueryString":{ + "shape":"QueryString", + "documentation":"

The contents of the query with all query statements.

" + }, + "ClientRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

", + "idempotencyToken":true + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup in which the named query is being created.

" + } + } + }, + "CreateNamedQueryOutput":{ + "type":"structure", + "members":{ + "NamedQueryId":{ + "shape":"NamedQueryId", + "documentation":"

The unique ID of the query.

" + } + } + }, + "CreateWorkGroupInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"WorkGroupName", + "documentation":"

The workgroup name.

" + }, + "Configuration":{ + "shape":"WorkGroupConfiguration", + "documentation":"

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "Description":{ + "shape":"WorkGroupDescriptionString", + "documentation":"

The workgroup description.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags, separated by commas, that you want to attach to the workgroup as you create it.

" + } + } + }, + "CreateWorkGroupOutput":{ + "type":"structure", + "members":{ + } + }, + "DatabaseString":{ + "type":"string", + "max":255, + "min":1 + }, + "Date":{"type":"timestamp"}, + "Datum":{ + "type":"structure", + "members":{ + "VarCharValue":{ + "shape":"datumString", + "documentation":"

The value of the datum.

" + } + }, + "documentation":"

A piece of data (a field in the table).

" + }, + "DeleteNamedQueryInput":{ + "type":"structure", + "required":["NamedQueryId"], + "members":{ + "NamedQueryId":{ + "shape":"NamedQueryId", + "documentation":"

The unique ID of the query to delete.

", + "idempotencyToken":true + } + } + }, + "DeleteNamedQueryOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkGroupInput":{ + "type":"structure", + "required":["WorkGroup"], + "members":{ + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The unique name of the workgroup to delete.

" + }, + "RecursiveDeleteOption":{ + "shape":"BoxedBoolean", + "documentation":"

The option to delete the workgroup and its contents even if the workgroup contains any named queries.

" + } + } + }, + "DeleteWorkGroupOutput":{ + "type":"structure", + "members":{ + } + }, + "DescriptionString":{ + "type":"string", + "max":1024, + "min":1 + }, + "EncryptionConfiguration":{ + "type":"structure", + "required":["EncryptionOption"], + "members":{ + "EncryptionOption":{ + "shape":"EncryptionOption", + "documentation":"

Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE-S3), server-side encryption with KMS-managed keys (SSE-KMS), or client-side encryption with KMS-managed keys (CSE-KMS) is used.

If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup.

" + }, + "KmsKey":{ + "shape":"String", + "documentation":"

For SSE-KMS and CSE-KMS, this is the KMS key ARN or ID.

" + } + }, + "documentation":"

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information.

" + }, + "EncryptionOption":{ + "type":"string", + "enum":[ + "SSE_S3", + "SSE_KMS", + "CSE_KMS" + ] + }, + "ErrorCode":{ + "type":"string", + "documentation":"

The error code returned when the query execution failed to process, or when the processing request for the named query failed.

", + "max":256, + "min":1 + }, + "ErrorMessage":{"type":"string"}, + "GetNamedQueryInput":{ + "type":"structure", + "required":["NamedQueryId"], + "members":{ + "NamedQueryId":{ + "shape":"NamedQueryId", + "documentation":"

The unique ID of the query. Use ListNamedQueries to get query IDs.

" + } + } + }, + "GetNamedQueryOutput":{ + "type":"structure", + "members":{ + "NamedQuery":{ + "shape":"NamedQuery", + "documentation":"

Information about the query.

" + } + } + }, + "GetQueryExecutionInput":{ + "type":"structure", + "required":["QueryExecutionId"], + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique ID of the query execution.

" + } + } + }, + "GetQueryExecutionOutput":{ + "type":"structure", + "members":{ + "QueryExecution":{ + "shape":"QueryExecution", + "documentation":"

Information about the query execution.

" + } + } + }, + "GetQueryResultsInput":{ + "type":"structure", + "required":["QueryExecutionId"], + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique ID of the query execution.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

The token that specifies where to start pagination if a previous request was truncated.

" + }, + "MaxResults":{ + "shape":"MaxQueryResults", + "documentation":"

The maximum number of results (rows) to return in this request.

" + } + } + }, + "GetQueryResultsOutput":{ + "type":"structure", + "members":{ + "UpdateCount":{ + "shape":"Long", + "documentation":"

The number of rows inserted with a CREATE TABLE AS SELECT statement.

" + }, + "ResultSet":{ + "shape":"ResultSet", + "documentation":"

The results of the query execution.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + } + } + }, + "GetWorkGroupInput":{ + "type":"structure", + "required":["WorkGroup"], + "members":{ + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup.

" + } + } + }, + "GetWorkGroupOutput":{ + "type":"structure", + "members":{ + "WorkGroup":{ + "shape":"WorkGroup", + "documentation":"

Information about the workgroup.

" + } + } + }, + "IdempotencyToken":{ + "type":"string", + "max":128, + "min":32 + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Indicates a platform issue, which may be due to a transient condition or outage.

", + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "AthenaErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.

", + "exception":true + }, + "ListNamedQueriesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

The token that specifies where to start pagination if a previous request was truncated.

" + }, + "MaxResults":{ + "shape":"MaxNamedQueriesCount", + "documentation":"

The maximum number of queries to return in this request.

" + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup from which the named queries are being returned.

" + } + } + }, + "ListNamedQueriesOutput":{ + "type":"structure", + "members":{ + "NamedQueryIds":{ + "shape":"NamedQueryIdList", + "documentation":"

The list of unique query IDs.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + } + } + }, + "ListQueryExecutionsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

The token that specifies where to start pagination if a previous request was truncated.

" + }, + "MaxResults":{ + "shape":"MaxQueryExecutionsCount", + "documentation":"

The maximum number of query executions to return in this request.

" + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup from which queries are being returned.

" + } + } + }, + "ListQueryExecutionsOutput":{ + "type":"structure", + "members":{ + "QueryExecutionIds":{ + "shape":"QueryExecutionIdList", + "documentation":"

The unique IDs of each query execution as an array of strings.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

Lists the tags for the workgroup resource with the specified ARN.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.

" + }, + "MaxResults":{ + "shape":"MaxTagsCount", + "documentation":"

The maximum number of results to be returned per request that lists the tags for the workgroup resource.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The list of tags associated with this workgroup.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + } + } + }, + "ListWorkGroupsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + }, + "MaxResults":{ + "shape":"MaxWorkGroupsCount", + "documentation":"

The maximum number of workgroups to return in this request.

" + } + } + }, + "ListWorkGroupsOutput":{ + "type":"structure", + "members":{ + "WorkGroups":{ + "shape":"WorkGroupsList", + "documentation":"

The list of workgroups, including their names, descriptions, creation times, and states.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A token to be used by the next request if this request is truncated.

" + } + } + }, + "Long":{"type":"long"}, + "MaxNamedQueriesCount":{ + "type":"integer", + "box":true, + "max":50, + "min":0 + }, + "MaxQueryExecutionsCount":{ + "type":"integer", + "box":true, + "max":50, + "min":0 + }, + "MaxQueryResults":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "MaxTagsCount":{ + "type":"integer", + "box":true, + "min":75 + }, + "MaxWorkGroupsCount":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "NameString":{ + "type":"string", + "max":128, + "min":1 + }, + "NamedQuery":{ + "type":"structure", + "required":[ + "Name", + "Database", + "QueryString" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The query name.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The query description.

" + }, + "Database":{ + "shape":"DatabaseString", + "documentation":"

The database to which the query belongs.

" + }, + "QueryString":{ + "shape":"QueryString", + "documentation":"

The SQL query statements that comprise the query.

" + }, + "NamedQueryId":{ + "shape":"NamedQueryId", + "documentation":"

The unique identifier of the query.

" + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup that contains the named query.

" + } + }, + "documentation":"

A query, where QueryString is the list of SQL query statements that comprise the query.

" + }, + "NamedQueryId":{"type":"string"}, + "NamedQueryIdList":{ + "type":"list", + "member":{"shape":"NamedQueryId"}, + "max":50, + "min":1 + }, + "NamedQueryList":{ + "type":"list", + "member":{"shape":"NamedQuery"} + }, + "QueryExecution":{ + "type":"structure", + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique identifier for each query execution.

" + }, + "Query":{ + "shape":"QueryString", + "documentation":"

The SQL query statements which the query execution ran.

" + }, + "StatementType":{ + "shape":"StatementType", + "documentation":"

The type of query statement that was run. DDL indicates DDL query statements. DML indicates DML (Data Manipulation Language) query statements, such as CREATE TABLE AS SELECT. UTILITY indicates query statements other than DDL and DML, such as SHOW CREATE TABLE, or DESCRIBE <table>.

" + }, + "ResultConfiguration":{ + "shape":"ResultConfiguration", + "documentation":"

The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.

" + }, + "QueryExecutionContext":{ + "shape":"QueryExecutionContext", + "documentation":"

The database in which the query execution occurred.

" + }, + "Status":{ + "shape":"QueryExecutionStatus", + "documentation":"

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

" + }, + "Statistics":{ + "shape":"QueryExecutionStatistics", + "documentation":"

The location of a manifest file that tracks file locations generated by the query, the amount of data scanned by the query, and the amount of time that it took the query to run.

" + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup in which the query ran.

" + } + }, + "documentation":"

Information about a single instance of a query execution.

" + }, + "QueryExecutionContext":{ + "type":"structure", + "members":{ + "Database":{ + "shape":"DatabaseString", + "documentation":"

The name of the database.

" + } + }, + "documentation":"

The database in which the query execution occurs.

" + }, + "QueryExecutionId":{"type":"string"}, + "QueryExecutionIdList":{ + "type":"list", + "member":{"shape":"QueryExecutionId"}, + "max":50, + "min":1 + }, + "QueryExecutionList":{ + "type":"list", + "member":{"shape":"QueryExecution"} + }, + "QueryExecutionState":{ + "type":"string", + "enum":[ + "QUEUED", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ] + }, + "QueryExecutionStatistics":{ + "type":"structure", + "members":{ + "EngineExecutionTimeInMillis":{ + "shape":"Long", + "documentation":"

The number of milliseconds that the query took to execute.

" + }, + "DataScannedInBytes":{ + "shape":"Long", + "documentation":"

The number of bytes in the data that was queried.

" + }, + "DataManifestLocation":{ + "shape":"String", + "documentation":"

The location and file name of a data manifest file. The manifest file is saved to the Athena query results location in Amazon S3. It tracks files that the query wrote to Amazon S3. If the query fails, the manifest file also tracks files that the query intended to write. The manifest is useful for identifying orphaned files resulting from a failed query. For more information, see Working with Query Output Files in the Amazon Athena User Guide.

" + } + }, + "documentation":"

The location of a manifest file that tracks file locations generated by the query, the amount of data scanned by the query, and the amount of time that it took the query to run.

" + }, + "QueryExecutionStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"QueryExecutionState", + "documentation":"

The state of query execution. QUEUED state is listed but is not used by Athena and is reserved for future use. RUNNING indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. SUCCEEDED indicates that the query completed without errors. FAILED indicates that the query experienced an error and did not complete processing. CANCELLED indicates that a user input interrupted query execution.

" + }, + "StateChangeReason":{ + "shape":"String", + "documentation":"

Further detail about the status of the query.

" + }, + "SubmissionDateTime":{ + "shape":"Date", + "documentation":"

The date and time that the query was submitted.

" + }, + "CompletionDateTime":{ + "shape":"Date", + "documentation":"

The date and time that the query completed.

" + } + }, + "documentation":"

The completion date, current state, submission time, and state change reason (if applicable) for the query execution.

" + }, + "QueryString":{ + "type":"string", + "max":262144, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"

A resource, such as a workgroup, was not found.

", + "exception":true + }, + "ResultConfiguration":{ + "type":"structure", + "members":{ + "OutputLocation":{ + "shape":"String", + "documentation":"

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. To run the query, you must specify the query results location using one of the ways: either for individual queries using either this setting (client-side), or in the workgroup, using WorkGroupConfiguration. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results. If workgroup settings override client-side settings, then the query uses the settings specified for the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

If query results are encrypted in Amazon S3, indicates the encryption option used (for example, SSE-KMS or CSE-KMS) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See WorkGroupConfiguration$EnforceWorkGroupConfiguration and Workgroup Settings Override Client-Side Settings.

" + } + }, + "documentation":"

The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the workgroup settings.

" + }, + "ResultConfigurationUpdates":{ + "type":"structure", + "members":{ + "OutputLocation":{ + "shape":"String", + "documentation":"

The location in Amazon S3 where your query results are stored, such as s3://path/to/query/bucket/. For more information, see Query Results If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "RemoveOutputLocation":{ + "shape":"BoxedBoolean", + "documentation":"

If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration for the query results.

" + }, + "RemoveEncryptionConfiguration":{ + "shape":"BoxedBoolean", + "documentation":"

If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see Workgroup Settings Override Client-Side Settings.

" + } + }, + "documentation":"

The information about the updates in the query results, such as output location and encryption configuration for the query results.

" + }, + "ResultSet":{ + "type":"structure", + "members":{ + "Rows":{ + "shape":"RowList", + "documentation":"

The rows in the table.

" + }, + "ResultSetMetadata":{ + "shape":"ResultSetMetadata", + "documentation":"

The metadata that describes the column structure and data types of a table of query results.

" + } + }, + "documentation":"

The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.

" + }, + "ResultSetMetadata":{ + "type":"structure", + "members":{ + "ColumnInfo":{ + "shape":"ColumnInfoList", + "documentation":"

Information about the columns returned in a query result metadata.

" + } + }, + "documentation":"

The metadata that describes the column structure and data types of a table of query results.

" + }, + "Row":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"datumList", + "documentation":"

The data that populates a row in a query result table.

" + } + }, + "documentation":"

The rows that comprise a query result table.

" + }, + "RowList":{ + "type":"list", + "member":{"shape":"Row"} + }, + "StartQueryExecutionInput":{ + "type":"structure", + "required":["QueryString"], + "members":{ + "QueryString":{ + "shape":"QueryString", + "documentation":"

The SQL query statements to be executed.

" + }, + "ClientRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another StartQueryExecution request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.

", + "idempotencyToken":true + }, + "QueryExecutionContext":{ + "shape":"QueryExecutionContext", + "documentation":"

The database within which the query executes.

" + }, + "ResultConfiguration":{ + "shape":"ResultConfiguration", + "documentation":"

Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup in which the query is being started.

" + } + } + }, + "StartQueryExecutionOutput":{ + "type":"structure", + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique ID of the query that ran as a result of this request.

" + } + } + }, + "StatementType":{ + "type":"string", + "enum":[ + "DDL", + "DML", + "UTILITY" + ] + }, + "StopQueryExecutionInput":{ + "type":"structure", + "required":["QueryExecutionId"], + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique ID of the query execution to stop.

", + "idempotencyToken":true + } + } + }, + "StopQueryExecutionOutput":{ + "type":"structure", + "members":{ + } + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive.

" + } + }, + "documentation":"

A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags, separated by commas, to be added to the resource, such as a workgroup.

" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottleReason":{ + "type":"string", + "documentation":"

The reason for the query throttling, for example, when it exceeds the concurrent query limit.

", + "enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"] + }, + "Token":{ + "type":"string", + "max":1024, + "min":1 + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Reason":{"shape":"ThrottleReason"} + }, + "documentation":"

Indicates that the request was throttled.

", + "exception":true + }, + "UnprocessedNamedQueryId":{ + "type":"structure", + "members":{ + "NamedQueryId":{ + "shape":"NamedQueryId", + "documentation":"

The unique identifier of the named query.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code returned when the processing request for the named query failed, if applicable.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message returned when the processing request for the named query failed, if applicable.

" + } + }, + "documentation":"

Information about a named query ID that could not be processed.

" + }, + "UnprocessedNamedQueryIdList":{ + "type":"list", + "member":{"shape":"UnprocessedNamedQueryId"} + }, + "UnprocessedQueryExecutionId":{ + "type":"structure", + "members":{ + "QueryExecutionId":{ + "shape":"QueryExecutionId", + "documentation":"

The unique identifier of the query execution.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code returned when the query execution failed to process, if applicable.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message returned when the query execution failed to process, if applicable.

" + } + }, + "documentation":"

Describes a query execution that failed to process.

" + }, + "UnprocessedQueryExecutionIdList":{ + "type":"list", + "member":{"shape":"UnprocessedQueryExecutionId"} + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

Removes one or more tags from the workgroup resource for the specified ARN.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

Removes the tags associated with one or more tag keys from the workgroup resource.

" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateWorkGroupInput":{ + "type":"structure", + "required":["WorkGroup"], + "members":{ + "WorkGroup":{ + "shape":"WorkGroupName", + "documentation":"

The specified workgroup that will be updated.

" + }, + "Description":{ + "shape":"WorkGroupDescriptionString", + "documentation":"

The workgroup description.

" + }, + "ConfigurationUpdates":{ + "shape":"WorkGroupConfigurationUpdates", + "documentation":"

The workgroup configuration that will be updated for the given workgroup.

" + }, + "State":{ + "shape":"WorkGroupState", + "documentation":"

The workgroup state that will be updated for the given workgroup.

" + } + } + }, + "UpdateWorkGroupOutput":{ + "type":"structure", + "members":{ + } + }, + "WorkGroup":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"WorkGroupName", + "documentation":"

The workgroup name.

" + }, + "State":{ + "shape":"WorkGroupState", + "documentation":"

The state of the workgroup: ENABLED or DISABLED.

" + }, + "Configuration":{ + "shape":"WorkGroupConfiguration", + "documentation":"

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "Description":{ + "shape":"WorkGroupDescriptionString", + "documentation":"

The workgroup description.

" + }, + "CreationTime":{ + "shape":"Date", + "documentation":"

The date and time the workgroup was created.

" + } + }, + "documentation":"

A workgroup, which contains a name, description, creation time, state, and other configuration, listed under WorkGroup$Configuration. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "WorkGroupConfiguration":{ + "type":"structure", + "members":{ + "ResultConfiguration":{ + "shape":"ResultConfiguration", + "documentation":"

The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. To run the query, you must specify the query results location using one of the ways: either in the workgroup using this setting, or for individual queries (client-side), using ResultConfiguration$OutputLocation. If none of them is set, Athena issues an error that no output location is provided. For more information, see Query Results.

" + }, + "EnforceWorkGroupConfiguration":{ + "shape":"BoxedBoolean", + "documentation":"

If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

" + }, + "PublishCloudWatchMetricsEnabled":{ + "shape":"BoxedBoolean", + "documentation":"

Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.

" + }, + "BytesScannedCutoffPerQuery":{ + "shape":"BytesScannedCutoffValue", + "documentation":"

The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

" + }, + "RequesterPaysEnabled":{ + "shape":"BoxedBoolean", + "documentation":"

If set to true, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "documentation":"

The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See WorkGroupConfiguration$EnforceWorkGroupConfiguration.

" + }, + "WorkGroupConfigurationUpdates":{ + "type":"structure", + "members":{ + "EnforceWorkGroupConfiguration":{ + "shape":"BoxedBoolean", + "documentation":"

If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\" client-side settings are used. For more information, see Workgroup Settings Override Client-Side Settings.

" + }, + "ResultConfigurationUpdates":{ + "shape":"ResultConfigurationUpdates", + "documentation":"

The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.

" + }, + "PublishCloudWatchMetricsEnabled":{ + "shape":"BoxedBoolean", + "documentation":"

Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.

" + }, + "BytesScannedCutoffPerQuery":{ + "shape":"BytesScannedCutoffValue", + "documentation":"

The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.

" + }, + "RemoveBytesScannedCutoffPerQuery":{ + "shape":"BoxedBoolean", + "documentation":"

Indicates that the data usage control limit per query is removed. WorkGroupConfiguration$BytesScannedCutoffPerQuery

" + }, + "RequesterPaysEnabled":{ + "shape":"BoxedBoolean", + "documentation":"

If set to true, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to false, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false. For more information about Requester Pays buckets, see Requester Pays Buckets in the Amazon Simple Storage Service Developer Guide.

" + } + }, + "documentation":"

The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.

" + }, + "WorkGroupDescriptionString":{ + "type":"string", + "max":1024, + "min":0 + }, + "WorkGroupName":{ + "type":"string", + "pattern":"[a-zA-z0-9._-]{1,128}" + }, + "WorkGroupState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "WorkGroupSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"WorkGroupName", + "documentation":"

The name of the workgroup.

" + }, + "State":{ + "shape":"WorkGroupState", + "documentation":"

The state of the workgroup.

" + }, + "Description":{ + "shape":"WorkGroupDescriptionString", + "documentation":"

The workgroup description.

" + }, + "CreationTime":{ + "shape":"Date", + "documentation":"

The workgroup creation date and time.

" + } + }, + "documentation":"

The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.

" + }, + "WorkGroupsList":{ + "type":"list", + "member":{"shape":"WorkGroupSummary"}, + "max":50, + "min":0 + }, + "datumList":{ + "type":"list", + "member":{"shape":"Datum"} + }, + "datumString":{"type":"string"} + }, + "documentation":"

Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see What is Amazon Athena in the Amazon Athena User Guide.

If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see Accessing Amazon Athena with JDBC.

For code samples using the AWS SDK for Java, see Examples and Code Samples in the Amazon Athena User Guide.

" +} diff --git a/aws/dist/botocore/data/autoscaling-plans/2018-01-06/paginators-1.json b/aws/dist/botocore/data/autoscaling-plans/2018-01-06/paginators-1.json new file mode 100644 index 00000000..e3f812a1 --- /dev/null +++ b/aws/dist/botocore/data/autoscaling-plans/2018-01-06/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeScalingPlanResources": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScalingPlanResources" + }, + "DescribeScalingPlans": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScalingPlans" + } + } +} diff --git a/aws/dist/botocore/data/autoscaling-plans/2018-01-06/service-2.json b/aws/dist/botocore/data/autoscaling-plans/2018-01-06/service-2.json new file mode 100644 index 00000000..dafa7bb2 --- /dev/null +++ b/aws/dist/botocore/data/autoscaling-plans/2018-01-06/service-2.json @@ -0,0 +1,967 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-01-06", + "endpointPrefix":"autoscaling", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Auto Scaling Plans", + "serviceId":"Auto Scaling Plans", + "signatureVersion":"v4", + "signingName":"autoscaling-plans", + "targetPrefix":"AnyScaleScalingPlannerFrontendService", + "uid":"autoscaling-plans-2018-01-06" + }, + "operations":{ + "CreateScalingPlan":{ + "name":"CreateScalingPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateScalingPlanRequest"}, + "output":{"shape":"CreateScalingPlanResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates a scaling plan.

" + }, + "DeleteScalingPlan":{ + "name":"DeleteScalingPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScalingPlanRequest"}, + "output":{"shape":"DeleteScalingPlanResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes the specified scaling plan.

Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

" + }, + "DescribeScalingPlanResources":{ + "name":"DescribeScalingPlanResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingPlanResourcesRequest"}, + "output":{"shape":"DescribeScalingPlanResourcesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the scalable resources in the specified scaling plan.

" + }, + "DescribeScalingPlans":{ + "name":"DescribeScalingPlans", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingPlansRequest"}, + "output":{"shape":"DescribeScalingPlansResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes one or more of your scaling plans.

" + }, + "GetScalingPlanResourceForecastData":{ + "name":"GetScalingPlanResourceForecastData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetScalingPlanResourceForecastDataRequest"}, + "output":{"shape":"GetScalingPlanResourceForecastDataResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

" + }, + "UpdateScalingPlan":{ + "name":"UpdateScalingPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateScalingPlanRequest"}, + "output":{"shape":"UpdateScalingPlanResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConcurrentUpdateException"}, + {"shape":"InternalServiceException"}, + {"shape":"ObjectNotFoundException"} + ], + "documentation":"

Updates the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

" + } + }, + "shapes":{ + "ApplicationSource":{ + "type":"structure", + "members":{ + "CloudFormationStackARN":{ + "shape":"XmlString", + "documentation":"

The Amazon Resource Name (ARN) of a AWS CloudFormation stack.

" + }, + "TagFilters":{ + "shape":"TagFilters", + "documentation":"

A set of tags (up to 50).

" + } + }, + "documentation":"

Represents an application source.

" + }, + "ApplicationSources":{ + "type":"list", + "member":{"shape":"ApplicationSource"} + }, + "ConcurrentUpdateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.

", + "exception":true + }, + "Cooldown":{"type":"integer"}, + "CreateScalingPlanRequest":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ApplicationSource", + "ScalingInstructions" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.

" + }, + "ApplicationSource":{ + "shape":"ApplicationSource", + "documentation":"

A CloudFormation stack or set of tags. You can create one scaling plan per application source.

" + }, + "ScalingInstructions":{ + "shape":"ScalingInstructions", + "documentation":"

The scaling instructions.

" + } + } + }, + "CreateScalingPlanResponse":{ + "type":"structure", + "required":["ScalingPlanVersion"], + "members":{ + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan. This value is always 1.

Currently, you cannot specify multiple scaling plan versions.

" + } + } + }, + "CustomizedLoadMetricSpecification":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Namespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the metric.

" + }, + "Dimensions":{ + "shape":"MetricDimensions", + "documentation":"

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.

" + }, + "Statistic":{ + "shape":"MetricStatistic", + "documentation":"

The statistic of the metric. Currently, the value must always be Sum.

" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"

The unit of the metric.

" + } + }, + "documentation":"

Represents a CloudWatch metric of your choosing that can be used for predictive scaling.

For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the Sum and Average statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.

When you choose a load metric, make sure that the required Sum and Average statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The Sum statistic must represent the total load on the resource, and the Average statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the Sum statistic represents the total request count processed by the group, then the Average statistic for the specified metric must represent the average request count processed by each instance of the group.

For information about terminology, available metrics, or how to publish new metrics, see Amazon CloudWatch Concepts in the Amazon CloudWatch User Guide.

" + }, + "CustomizedScalingMetricSpecification":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Namespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the metric.

" + }, + "Dimensions":{ + "shape":"MetricDimensions", + "documentation":"

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.

" + }, + "Statistic":{ + "shape":"MetricStatistic", + "documentation":"

The statistic of the metric.

" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"

The unit of the metric.

" + } + }, + "documentation":"

Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy.

To create your customized scaling metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

" + }, + "Datapoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"TimestampType", + "documentation":"

The time stamp for the data point in UTC format.

" + }, + "Value":{ + "shape":"MetricScale", + "documentation":"

The value of the data point.

" + } + }, + "documentation":"

Represents a single value in the forecast data used for predictive scaling.

" + }, + "Datapoints":{ + "type":"list", + "member":{"shape":"Datapoint"} + }, + "DeleteScalingPlanRequest":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + } + } + }, + "DeleteScalingPlanResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeScalingPlanResourcesRequest":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScalingPlanResourcesResponse":{ + "type":"structure", + "members":{ + "ScalingPlanResources":{ + "shape":"ScalingPlanResources", + "documentation":"

Information about the scalable resources.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DescribeScalingPlansRequest":{ + "type":"structure", + "members":{ + "ScalingPlanNames":{ + "shape":"ScalingPlanNames", + "documentation":"

The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.

" + }, + "ApplicationSources":{ + "shape":"ApplicationSources", + "documentation":"

The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + } + } + }, + "DescribeScalingPlansResponse":{ + "type":"structure", + "members":{ + "ScalingPlans":{ + "shape":"ScalingPlans", + "documentation":"

Information about the scaling plans.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token required to get the next set of results. This value is null if there are no more results to return.

" + } + } + }, + "DisableDynamicScaling":{"type":"boolean"}, + "DisableScaleIn":{"type":"boolean"}, + "ErrorMessage":{"type":"string"}, + "ForecastDataType":{ + "type":"string", + "enum":[ + "CapacityForecast", + "LoadForecast", + "ScheduledActionMinCapacity", + "ScheduledActionMaxCapacity" + ] + }, + "GetScalingPlanResourceForecastDataRequest":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "ForecastDataType", + "StartTime", + "EndTime" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service.

" + }, + "ResourceId":{ + "shape":"XmlString", + "documentation":"

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension for the resource.

" + }, + "ForecastDataType":{ + "shape":"ForecastDataType", + "documentation":"

The type of forecast data to get.

  • LoadForecast: The load metric forecast.

  • CapacityForecast: The capacity forecast.

  • ScheduledActionMinCapacity: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.

  • ScheduledActionMaxCapacity: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days.

Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.

" + } + } + }, + "GetScalingPlanResourceForecastDataResponse":{ + "type":"structure", + "required":["Datapoints"], + "members":{ + "Datapoints":{ + "shape":"Datapoints", + "documentation":"

The data points to return.

" + } + } + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service encountered an internal error.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The token provided is not valid.

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.

", + "exception":true + }, + "LoadMetricType":{ + "type":"string", + "enum":[ + "ASGTotalCPUUtilization", + "ASGTotalNetworkIn", + "ASGTotalNetworkOut", + "ALBTargetGroupRequestCount" + ] + }, + "MaxResults":{"type":"integer"}, + "MetricDimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MetricDimensionName", + "documentation":"

The name of the dimension.

" + }, + "Value":{ + "shape":"MetricDimensionValue", + "documentation":"

The value of the dimension.

" + } + }, + "documentation":"

Represents a dimension for a customized metric.

" + }, + "MetricDimensionName":{"type":"string"}, + "MetricDimensionValue":{"type":"string"}, + "MetricDimensions":{ + "type":"list", + "member":{"shape":"MetricDimension"} + }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, + "MetricScale":{"type":"double"}, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum", + "SampleCount", + "Sum" + ] + }, + "MetricUnit":{"type":"string"}, + "NextToken":{"type":"string"}, + "ObjectNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified object could not be found.

", + "exception":true + }, + "PolicyName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\p{Print}+" + }, + "PolicyType":{ + "type":"string", + "enum":["TargetTrackingScaling"] + }, + "PredefinedLoadMetricSpecification":{ + "type":"structure", + "required":["PredefinedLoadMetricType"], + "members":{ + "PredefinedLoadMetricType":{ + "shape":"LoadMetricType", + "documentation":"

The metric type.

" + }, + "ResourceLabel":{ + "shape":"ResourceLabel", + "documentation":"

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group.

The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

" + } + }, + "documentation":"

Represents a predefined metric that can be used for predictive scaling.

" + }, + "PredefinedScalingMetricSpecification":{ + "type":"structure", + "required":["PredefinedScalingMetricType"], + "members":{ + "PredefinedScalingMetricType":{ + "shape":"ScalingMetricType", + "documentation":"

The metric type. The ALBRequestCountPerTarget metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.

" + }, + "ResourceLabel":{ + "shape":"ResourceLabel", + "documentation":"

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.

The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:

  • app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.

  • targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

" + } + }, + "documentation":"

Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.

" + }, + "PredictiveScalingMaxCapacityBehavior":{ + "type":"string", + "enum":[ + "SetForecastCapacityToMaxCapacity", + "SetMaxCapacityToForecastCapacity", + "SetMaxCapacityAboveForecastCapacity" + ] + }, + "PredictiveScalingMode":{ + "type":"string", + "enum":[ + "ForecastAndScale", + "ForecastOnly" + ] + }, + "ResourceCapacity":{"type":"integer"}, + "ResourceIdMaxLen1600":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "ResourceLabel":{ + "type":"string", + "max":1023, + "min":1 + }, + "ScalableDimension":{ + "type":"string", + "enum":[ + "autoscaling:autoScalingGroup:DesiredCapacity", + "ecs:service:DesiredCount", + "ec2:spot-fleet-request:TargetCapacity", + "rds:cluster:ReadReplicaCount", + "dynamodb:table:ReadCapacityUnits", + "dynamodb:table:WriteCapacityUnits", + "dynamodb:index:ReadCapacityUnits", + "dynamodb:index:WriteCapacityUnits" + ] + }, + "ScalingInstruction":{ + "type":"structure", + "required":[ + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "MinCapacity", + "MaxCapacity", + "TargetTrackingConfigurations" + ], + "members":{ + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension associated with the resource.

  • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

" + }, + "MinCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The minimum capacity of the resource.

" + }, + "MaxCapacity":{ + "shape":"ResourceCapacity", + "documentation":"

The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for PredictiveScalingMaxCapacityBehavior.

" + }, + "TargetTrackingConfigurations":{ + "shape":"TargetTrackingConfigurations", + "documentation":"

The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling.

With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out.

Condition: The scaling metric must be unique across target tracking configurations.

" + }, + "PredefinedLoadMetricSpecification":{ + "shape":"PredefinedLoadMetricSpecification", + "documentation":"

The predefined load metric to use for predictive scaling. This parameter or a CustomizedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

" + }, + "CustomizedLoadMetricSpecification":{ + "shape":"CustomizedLoadMetricSpecification", + "documentation":"

The customized load metric to use for predictive scaling. This parameter or a PredefinedLoadMetricSpecification is required when configuring predictive scaling, and cannot be used otherwise.

" + }, + "ScheduledActionBufferTime":{ + "shape":"ScheduledActionBufferTime", + "documentation":"

The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete.

The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds.

Only valid when configuring predictive scaling.

" + }, + "PredictiveScalingMaxCapacityBehavior":{ + "shape":"PredictiveScalingMaxCapacityBehavior", + "documentation":"

Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is SetForecastCapacityToMaxCapacity.

The following are possible values:

  • SetForecastCapacityToMaxCapacity - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit.

  • SetMaxCapacityToForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.

  • SetMaxCapacityAboveForecastCapacity - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs.

Only valid when configuring predictive scaling.

" + }, + "PredictiveScalingMaxCapacityBuffer":{ + "shape":"ResourceCapacity", + "documentation":"

The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.

Only valid when configuring predictive scaling. Required if the PredictiveScalingMaxCapacityBehavior is set to SetMaxCapacityAboveForecastCapacity, and cannot be used otherwise.

The range is 1-100.

" + }, + "PredictiveScalingMode":{ + "shape":"PredictiveScalingMode", + "documentation":"

The predictive scaling mode. The default value is ForecastAndScale. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast.

" + }, + "ScalingPolicyUpdateBehavior":{ + "shape":"ScalingPolicyUpdateBehavior", + "documentation":"

Controls whether a resource's externally created scaling policies are kept or replaced.

The default value is KeepExternalPolicies. If the parameter is set to ReplaceExternalPolicies, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created.

Only valid when configuring dynamic scaling.

Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.

" + }, + "DisableDynamicScaling":{ + "shape":"DisableDynamicScaling", + "documentation":"

Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations.

The default is enabled (false).

" + } + }, + "documentation":"

Describes a scaling instruction for a scalable resource.

The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.

AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.

AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast.

We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.

For more information, see Getting Started with AWS Auto Scaling.

" + }, + "ScalingInstructions":{ + "type":"list", + "member":{"shape":"ScalingInstruction"} + }, + "ScalingMetricType":{ + "type":"string", + "enum":[ + "ASGAverageCPUUtilization", + "ASGAverageNetworkIn", + "ASGAverageNetworkOut", + "DynamoDBReadCapacityUtilization", + "DynamoDBWriteCapacityUtilization", + "ECSServiceAverageCPUUtilization", + "ECSServiceAverageMemoryUtilization", + "ALBRequestCountPerTarget", + "RDSReaderAverageCPUUtilization", + "RDSReaderAverageDatabaseConnections", + "EC2SpotFleetRequestAverageCPUUtilization", + "EC2SpotFleetRequestAverageNetworkIn", + "EC2SpotFleetRequestAverageNetworkOut" + ] + }, + "ScalingPlan":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion", + "ApplicationSource", + "ScalingInstructions", + "StatusCode" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + }, + "ApplicationSource":{ + "shape":"ApplicationSource", + "documentation":"

The application source.

" + }, + "ScalingInstructions":{ + "shape":"ScalingInstructions", + "documentation":"

The scaling instructions.

" + }, + "StatusCode":{ + "shape":"ScalingPlanStatusCode", + "documentation":"

The status of the scaling plan.

  • Active - The scaling plan is active.

  • ActiveWithProblems - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.

  • CreationInProgress - The scaling plan is being created.

  • CreationFailed - The scaling plan could not be created.

  • DeletionInProgress - The scaling plan is being deleted.

  • DeletionFailed - The scaling plan could not be deleted.

  • UpdateInProgress - The scaling plan is being updated.

  • UpdateFailed - The scaling plan could not be updated.

" + }, + "StatusMessage":{ + "shape":"XmlString", + "documentation":"

A simple message about the current status of the scaling plan.

" + }, + "StatusStartTime":{ + "shape":"TimestampType", + "documentation":"

The Unix time stamp when the scaling plan entered the current status.

" + }, + "CreationTime":{ + "shape":"TimestampType", + "documentation":"

The Unix time stamp when the scaling plan was created.

" + } + }, + "documentation":"

Represents a scaling plan.

" + }, + "ScalingPlanName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{Print}&&[^|:/]]+" + }, + "ScalingPlanNames":{ + "type":"list", + "member":{"shape":"ScalingPlanName"} + }, + "ScalingPlanResource":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion", + "ServiceNamespace", + "ResourceId", + "ScalableDimension", + "ScalingStatusCode" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + }, + "ServiceNamespace":{ + "shape":"ServiceNamespace", + "documentation":"

The namespace of the AWS service.

" + }, + "ResourceId":{ + "shape":"ResourceIdMaxLen1600", + "documentation":"

The ID of the resource. This string consists of the resource type and unique identifier.

  • Auto Scaling group - The resource type is autoScalingGroup and the unique identifier is the name of the Auto Scaling group. Example: autoScalingGroup/my-asg.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot Fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

" + }, + "ScalableDimension":{ + "shape":"ScalableDimension", + "documentation":"

The scalable dimension for the resource.

  • autoscaling:autoScalingGroup:DesiredCapacity - The desired capacity of an Auto Scaling group.

  • ecs:service:DesiredCount - The desired task count of an ECS service.

  • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.

" + }, + "ScalingPolicies":{ + "shape":"ScalingPolicies", + "documentation":"

The scaling policies.

" + }, + "ScalingStatusCode":{ + "shape":"ScalingStatusCode", + "documentation":"

The scaling status of the resource.

  • Active - The scaling configuration is active.

  • Inactive - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.

  • PartiallyActive - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.

" + }, + "ScalingStatusMessage":{ + "shape":"XmlString", + "documentation":"

A simple message about the current scaling status of the resource.

" + } + }, + "documentation":"

Represents a scalable resource.

" + }, + "ScalingPlanResources":{ + "type":"list", + "member":{"shape":"ScalingPlanResource"} + }, + "ScalingPlanStatusCode":{ + "type":"string", + "enum":[ + "Active", + "ActiveWithProblems", + "CreationInProgress", + "CreationFailed", + "DeletionInProgress", + "DeletionFailed", + "UpdateInProgress", + "UpdateFailed" + ] + }, + "ScalingPlanVersion":{"type":"long"}, + "ScalingPlans":{ + "type":"list", + "member":{"shape":"ScalingPlan"} + }, + "ScalingPolicies":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingPolicy":{ + "type":"structure", + "required":[ + "PolicyName", + "PolicyType" + ], + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the scaling policy.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The type of scaling policy.

" + }, + "TargetTrackingConfiguration":{ + "shape":"TargetTrackingConfiguration", + "documentation":"

The target tracking scaling policy. Includes support for predefined or customized metrics.

" + } + }, + "documentation":"

Represents a scaling policy.

" + }, + "ScalingPolicyUpdateBehavior":{ + "type":"string", + "enum":[ + "KeepExternalPolicies", + "ReplaceExternalPolicies" + ] + }, + "ScalingStatusCode":{ + "type":"string", + "enum":[ + "Inactive", + "PartiallyActive", + "Active" + ] + }, + "ScheduledActionBufferTime":{ + "type":"integer", + "min":0 + }, + "ServiceNamespace":{ + "type":"string", + "enum":[ + "autoscaling", + "ecs", + "ec2", + "rds", + "dynamodb" + ] + }, + "TagFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"XmlStringMaxLen128", + "documentation":"

The tag key.

" + }, + "Values":{ + "shape":"TagValues", + "documentation":"

The tag values (0 to 20).

" + } + }, + "documentation":"

Represents a tag.

" + }, + "TagFilters":{ + "type":"list", + "member":{"shape":"TagFilter"} + }, + "TagValues":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "TargetTrackingConfiguration":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "PredefinedScalingMetricSpecification":{ + "shape":"PredefinedScalingMetricSpecification", + "documentation":"

A predefined metric. You can specify either a predefined metric or a customized metric.

" + }, + "CustomizedScalingMetricSpecification":{ + "shape":"CustomizedScalingMetricSpecification", + "documentation":"

A customized metric. You can specify either a predefined metric or a customized metric.

" + }, + "TargetValue":{ + "shape":"MetricScale", + "documentation":"

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

" + }, + "DisableScaleIn":{ + "shape":"DisableScaleIn", + "documentation":"

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource.

The default value is false.

" + }, + "ScaleOutCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.

While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

" + }, + "ScaleInCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.

The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.

" + }, + "EstimatedInstanceWarmup":{ + "shape":"Cooldown", + "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.

" + } + }, + "documentation":"

Describes a target tracking configuration to use with AWS Auto Scaling. Used with ScalingInstruction and ScalingPolicy.

" + }, + "TargetTrackingConfigurations":{ + "type":"list", + "member":{"shape":"TargetTrackingConfiguration"} + }, + "TimestampType":{"type":"timestamp"}, + "UpdateScalingPlanRequest":{ + "type":"structure", + "required":[ + "ScalingPlanName", + "ScalingPlanVersion" + ], + "members":{ + "ScalingPlanName":{ + "shape":"ScalingPlanName", + "documentation":"

The name of the scaling plan.

" + }, + "ScalingPlanVersion":{ + "shape":"ScalingPlanVersion", + "documentation":"

The version number of the scaling plan.

" + }, + "ApplicationSource":{ + "shape":"ApplicationSource", + "documentation":"

A CloudFormation stack or set of tags.

" + }, + "ScalingInstructions":{ + "shape":"ScalingInstructions", + "documentation":"

The scaling instructions.

" + } + } + }, + "UpdateScalingPlanResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An exception was thrown for a validation issue. Review the parameters provided.

", + "exception":true + }, + "XmlString":{ + "type":"string", + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen128":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen256":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + } + }, + "documentation":"AWS Auto Scaling

Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services.

Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.

For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

" +} diff --git a/aws/dist/botocore/data/autoscaling/2011-01-01/examples-1.json b/aws/dist/botocore/data/autoscaling/2011-01-01/examples-1.json new file mode 100644 index 00000000..9dcaf88d --- /dev/null +++ b/aws/dist/botocore/data/autoscaling/2011-01-01/examples-1.json @@ -0,0 +1,1395 @@ +{ + "version": "1.0", + "examples": { + "AttachInstances": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified instance to the specified Auto Scaling group.", + "id": "autoscaling-attach-instances-1", + "title": "To attach an instance to an Auto Scaling group" + } + ], + "AttachLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified target group to the specified Auto Scaling group.", + "id": "autoscaling-attach-load-balancer-target-groups-1", + "title": "To attach a target group to an Auto Scaling group" + } + ], + "AttachLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified load balancer to the specified Auto Scaling group.", + "id": "autoscaling-attach-load-balancers-1", + "title": "To attach a load balancer to an Auto Scaling group" + } + ], + "CompleteLifecycleAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionResult": "CONTINUE", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.", + "id": "autoscaling-complete-lifecycle-action-1", + "title": "To complete the lifecycle action" + } + ], + "CreateAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchConfigurationName": "my-launch-config", + "MaxSize": 3, + "MinSize": 1, + "VPCZoneIdentifier": "subnet-4176792c" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group.", + "id": "autoscaling-create-auto-scaling-group-1", + "title": "To create an Auto Scaling group" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZones": [ + "us-west-2c" + ], + "HealthCheckGracePeriod": 120, + "HealthCheckType": "ELB", + "LaunchConfigurationName": "my-launch-config", + "LoadBalancerNames": [ + "my-load-balancer" + ], + "MaxSize": 3, + "MinSize": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.", + "id": "autoscaling-create-auto-scaling-group-2", + "title": "To create an Auto Scaling group with an attached load balancer" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "HealthCheckGracePeriod": 120, + "HealthCheckType": "ELB", + "LaunchConfigurationName": "my-launch-config", + "MaxSize": 3, + "MinSize": 1, + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ], + "VPCZoneIdentifier": "subnet-4176792c, subnet-65ea5f08" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Auto Scaling group and attaches the specified target group.", + "id": "autoscaling-create-auto-scaling-group-3", + "title": "To create an Auto Scaling group with an attached target group" + } + ], + "CreateLaunchConfiguration": [ + { + "input": { + "IamInstanceProfile": "my-iam-role", + "ImageId": "ami-12345678", + "InstanceType": "m3.medium", + "LaunchConfigurationName": "my-launch-config", + "SecurityGroups": [ + "sg-eb2af88e" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a launch configuration.", + "id": "autoscaling-create-launch-configuration-1", + "title": "To create a launch configuration" + } + ], + "CreateOrUpdateTags": [ + { + "input": { + "Tags": [ + { + "Key": "Role", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "WebServer" + }, + { + "Key": "Dept", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds two tags to the specified Auto Scaling group.", + "id": "autoscaling-create-or-update-tags-1", + "title": "To create or update tags for an Auto Scaling group" + } + ], + "DeleteAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling group.", + "id": "autoscaling-delete-auto-scaling-group-1", + "title": "To delete an Auto Scaling group" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ForceDelete": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling group and all its instances.", + "id": "autoscaling-delete-auto-scaling-group-2", + "title": "To delete an Auto Scaling group and all its instances" + } + ], + "DeleteLaunchConfiguration": [ + { + "input": { + "LaunchConfigurationName": "my-launch-config" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified launch configuration.", + "id": "autoscaling-delete-launch-configuration-1", + "title": "To delete a launch configuration" + } + ], + "DeleteLifecycleHook": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified lifecycle hook.", + "id": "autoscaling-delete-lifecycle-hook-1", + "title": "To delete a lifecycle hook" + } + ], + "DeleteNotificationConfiguration": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified notification from the specified Auto Scaling group.", + "id": "autoscaling-delete-notification-configuration-1", + "title": "To delete an Auto Scaling notification" + } + ], + "DeletePolicy": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Auto Scaling policy.", + "id": "autoscaling-delete-policy-1", + "title": "To delete an Auto Scaling policy" + } + ], + "DeleteScheduledAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScheduledActionName": "my-scheduled-action" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified scheduled action from the specified Auto Scaling group.", + "id": "autoscaling-delete-scheduled-action-1", + "title": "To delete a scheduled action from an Auto Scaling group" + } + ], + "DeleteTags": [ + { + "input": { + "Tags": [ + { + "Key": "Dept", + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified tag from the specified Auto Scaling group.", + "id": "autoscaling-delete-tags-1", + "title": "To delete a tag from an Auto Scaling group" + } + ], + "DescribeAccountLimits": [ + { + "output": { + "MaxNumberOfAutoScalingGroups": 20, + "MaxNumberOfLaunchConfigurations": 100, + "NumberOfAutoScalingGroups": 3, + "NumberOfLaunchConfigurations": 5 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Auto Scaling limits for your AWS account.", + "id": "autoscaling-describe-account-limits-1", + "title": "To describe your Auto Scaling account limits" + } + ], + "DescribeAdjustmentTypes": [ + { + "output": { + "AdjustmentTypes": [ + { + "AdjustmentType": "ChangeInCapacity" + }, + { + "AdjustmentType": "ExactCapcity" + }, + { + "AdjustmentType": "PercentChangeInCapacity" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available adjustment types.", + "id": "autoscaling-describe-adjustment-types-1", + "title": "To describe the Auto Scaling adjustment types" + } + ], + "DescribeAutoScalingGroups": [ + { + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "AutoScalingGroups": [ + { + "AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group", + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZones": [ + "us-west-2c" + ], + "CreatedTime": "2013-08-19T20:53:25.584Z", + "DefaultCooldown": 300, + "DesiredCapacity": 1, + "EnabledMetrics": [ + + ], + "HealthCheckGracePeriod": 300, + "HealthCheckType": "EC2", + "Instances": [ + { + "AvailabilityZone": "us-west-2c", + "HealthStatus": "Healthy", + "InstanceId": "i-4ba0837f", + "LaunchConfigurationName": "my-launch-config", + "LifecycleState": "InService" + } + ], + "LaunchConfigurationName": "my-launch-config", + "LoadBalancerNames": [ + + ], + "MaxSize": 1, + "MinSize": 0, + "NewInstancesProtectedFromScaleIn": false, + "SuspendedProcesses": [ + + ], + "Tags": [ + + ], + "TerminationPolicies": [ + "Default" + ], + "VPCZoneIdentifier": "subnet-12345678" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Auto Scaling group.", + "id": "autoscaling-describe-auto-scaling-groups-1", + "title": "To describe an Auto Scaling group" + } + ], + "DescribeAutoScalingInstances": [ + { + "input": { + "InstanceIds": [ + "i-4ba0837f" + ] + }, + "output": { + "AutoScalingInstances": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "AvailabilityZone": "us-west-2c", + "HealthStatus": "HEALTHY", + "InstanceId": "i-4ba0837f", + "LaunchConfigurationName": "my-launch-config", + "LifecycleState": "InService", + "ProtectedFromScaleIn": false + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Auto Scaling instance.", + "id": "autoscaling-describe-auto-scaling-instances-1", + "title": "To describe one or more Auto Scaling instances" + } + ], + "DescribeAutoScalingNotificationTypes": [ + { + "output": { + "AutoScalingNotificationTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCH", + "autoscaling:EC2_INSTANCE_LAUNCH_ERROR", + "autoscaling:EC2_INSTANCE_TERMINATE", + "autoscaling:EC2_INSTANCE_TERMINATE_ERROR", + "autoscaling:TEST_NOTIFICATION" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available notification types.", + "id": "autoscaling-describe-auto-scaling-notification-types-1", + "title": "To describe the Auto Scaling notification types" + } + ], + "DescribeLaunchConfigurations": [ + { + "input": { + "LaunchConfigurationNames": [ + "my-launch-config" + ] + }, + "output": { + "LaunchConfigurations": [ + { + "AssociatePublicIpAddress": true, + "BlockDeviceMappings": [ + + ], + "CreatedTime": "2014-05-07T17:39:28.599Z", + "EbsOptimized": false, + "ImageId": "ami-043a5034", + "InstanceMonitoring": { + "Enabled": true + }, + "InstanceType": "t1.micro", + "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config", + "LaunchConfigurationName": "my-launch-config", + "SecurityGroups": [ + "sg-67ef0308" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified launch configuration.", + "id": "autoscaling-describe-launch-configurations-1", + "title": "To describe Auto Scaling launch configurations" + } + ], + "DescribeLifecycleHookTypes": [ + { + "output": { + "LifecycleHookTypes": [ + "autoscaling:EC2_INSTANCE_LAUNCHING", + "autoscaling:EC2_INSTANCE_TERMINATING" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available lifecycle hook types.", + "id": "autoscaling-describe-lifecycle-hook-types-1", + "title": "To describe the available types of lifecycle hooks" + } + ], + "DescribeLifecycleHooks": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LifecycleHooks": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "DefaultResult": "ABANDON", + "GlobalTimeout": 172800, + "HeartbeatTimeout": 3600, + "LifecycleHookName": "my-lifecycle-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic", + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the lifecycle hooks for the specified Auto Scaling group.", + "id": "autoscaling-describe-lifecycle-hooks-1", + "title": "To describe your lifecycle hooks" + } + ], + "DescribeLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancerTargetGroups": [ + { + "LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "State": "Added" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the target groups attached to the specified Auto Scaling group.", + "id": "autoscaling-describe-load-balancer-target-groups-1", + "title": "To describe the target groups for an Auto Scaling group" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "LoadBalancers": [ + { + "LoadBalancerName": "my-load-balancer", + "State": "Added" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the load balancers attached to the specified Auto Scaling group.", + "id": "autoscaling-describe-load-balancers-1", + "title": "To describe the load balancers for an Auto Scaling group" + } + ], + "DescribeMetricCollectionTypes": [ + { + "output": { + "Granularities": [ + { + "Granularity": "1Minute" + } + ], + "Metrics": [ + { + "Metric": "GroupMinSize" + }, + { + "Metric": "GroupMaxSize" + }, + { + "Metric": "GroupDesiredCapacity" + }, + { + "Metric": "GroupInServiceInstances" + }, + { + "Metric": "GroupPendingInstances" + }, + { + "Metric": "GroupTerminatingInstances" + }, + { + "Metric": "GroupStandbyInstances" + }, + { + "Metric": "GroupTotalInstances" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available metric collection types.", + "id": "autoscaling-describe-metric-collection-types-1", + "title": "To describe the Auto Scaling metric collection types" + } + ], + "DescribeNotificationConfigurations": [ + { + "input": { + "AutoScalingGroupNames": [ + "my-auto-scaling-group" + ] + }, + "output": { + "NotificationConfigurations": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2" + }, + { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationType": "autoscaling:TEST_NOTIFICATION", + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the notification configurations for the specified Auto Scaling group.", + "id": "autoscaling-describe-notification-configurations-1", + "title": "To describe Auto Scaling notification configurations" + } + ], + "DescribePolicies": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScalingPolicies": [ + { + "AdjustmentType": "ChangeInCapacity", + "Alarms": [ + + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn", + "PolicyName": "ScaleIn", + "ScalingAdjustment": -1 + }, + { + "AdjustmentType": "PercentChangeInCapacity", + "Alarms": [ + + ], + "AutoScalingGroupName": "my-auto-scaling-group", + "Cooldown": 60, + "MinAdjustmentStep": 2, + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange", + "PolicyName": "ScalePercentChange", + "ScalingAdjustment": 25 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the policies for the specified Auto Scaling group.", + "id": "autoscaling-describe-policies-1", + "title": "To describe Auto Scaling policies" + } + ], + "DescribeScalingActivities": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "Activities": [ + { + "ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.", + "Description": "Launching a new EC2 instance: i-4ba0837f", + "Details": "details", + "EndTime": "2013-08-19T20:54:02Z", + "Progress": 100, + "StartTime": "2013-08-19T20:53:29.930Z", + "StatusCode": "Successful" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scaling activities for the specified Auto Scaling group.", + "id": "autoscaling-describe-scaling-activities-1", + "title": "To describe the scaling activities for an Auto Scaling group" + } + ], + "DescribeScalingProcessTypes": [ + { + "output": { + "Processes": [ + { + "ProcessName": "AZRebalance" + }, + { + "ProcessName": "AddToLoadBalancer" + }, + { + "ProcessName": "AlarmNotification" + }, + { + "ProcessName": "HealthCheck" + }, + { + "ProcessName": "Launch" + }, + { + "ProcessName": "ReplaceUnhealthy" + }, + { + "ProcessName": "ScheduledActions" + }, + { + "ProcessName": "Terminate" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Auto Scaling process types.", + "id": "autoscaling-describe-scaling-process-types-1", + "title": "To describe the Auto Scaling process types" + } + ], + "DescribeScheduledActions": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group" + }, + "output": { + "ScheduledUpdateGroupActions": [ + { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 4, + "MaxSize": 6, + "MinSize": 2, + "Recurrence": "30 0 1 12 0", + "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action", + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2016-12-01T00:30:00Z", + "Time": "2016-12-01T00:30:00Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the scheduled actions for the specified Auto Scaling group.", + "id": "autoscaling-describe-scheduled-actions-1", + "title": "To describe scheduled actions" + } + ], + "DescribeTags": [ + { + "input": { + "Filters": [ + { + "Name": "auto-scaling-group", + "Values": [ + "my-auto-scaling-group" + ] + } + ] + }, + "output": { + "Tags": [ + { + "Key": "Dept", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "Research" + }, + { + "Key": "Role", + "PropagateAtLaunch": true, + "ResourceId": "my-auto-scaling-group", + "ResourceType": "auto-scaling-group", + "Value": "WebServer" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified Auto Scaling group.", + "id": "autoscaling-describe-tags-1", + "title": "To describe tags" + } + ], + "DescribeTerminationPolicyTypes": [ + { + "output": { + "TerminationPolicyTypes": [ + "ClosestToNextInstanceHour", + "Default", + "NewestInstance", + "OldestInstance", + "OldestLaunchConfiguration" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the available termination policy types.", + "id": "autoscaling-describe-termination-policy-types-1", + "title": "To describe termination policy types" + } + ], + "DetachInstances": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.", + "Description": "Detaching EC2 instance: i-93633f9b", + "Details": "details", + "Progress": 50, + "StartTime": "2015-04-12T15:02:16.179Z", + "StatusCode": "InProgress" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified instance from the specified Auto Scaling group.", + "id": "autoscaling-detach-instances-1", + "title": "To detach an instance from an Auto Scaling group" + } + ], + "DetachLoadBalancerTargetGroups": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "TargetGroupARNs": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified target group from the specified Auto Scaling group", + "id": "autoscaling-detach-load-balancer-target-groups-1", + "title": "To detach a target group from an Auto Scaling group" + } + ], + "DetachLoadBalancers": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified load balancer from the specified Auto Scaling group.", + "id": "autoscaling-detach-load-balancers-1", + "title": "To detach a load balancer from an Auto Scaling group" + } + ], + "DisableMetricsCollection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Metrics": [ + "GroupDesiredCapacity" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.", + "id": "autoscaling-disable-metrics-collection-1", + "title": "To disable metrics collection for an Auto Scaling group" + } + ], + "EnableMetricsCollection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "Granularity": "1Minute" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables data collection for the specified Auto Scaling group.", + "id": "autoscaling-enable-metrics-collection-1", + "title": "To enable metrics collection for an Auto Scaling group" + } + ], + "EnterStandby": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ShouldDecrementDesiredCapacity": true + }, + "output": { + "Activities": [ + { + "ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.", + "Description": "Moving EC2 instance to Standby: i-93633f9b", + "Details": "details", + "Progress": 50, + "StartTime": "2015-04-12T15:10:23.640Z", + "StatusCode": "InProgress" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example puts the specified instance into standby mode.", + "id": "autoscaling-enter-standby-1", + "title": "To move instances into standby mode" + } + ], + "ExecutePolicy": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "HonorCooldown": true, + "PolicyName": "ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example executes the specified Auto Scaling policy for the specified Auto Scaling group.", + "id": "autoscaling-execute-policy-1", + "title": "To execute an Auto Scaling policy" + } + ], + "ExitStandby": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ] + }, + "output": { + "Activities": [ + { + "ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928", + "AutoScalingGroupName": "my-auto-scaling-group", + "Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.", + "Description": "Moving EC2 instance out of Standby: i-93633f9b", + "Details": "details", + "Progress": 30, + "StartTime": "2015-04-12T15:14:29.886Z", + "StatusCode": "PreInService" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example moves the specified instance out of standby mode.", + "id": "autoscaling-exit-standby-1", + "title": "To move instances out of standby mode" + } + ], + "PutLifecycleHook": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleHookName": "my-lifecycle-hook", + "LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING", + "NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn", + "RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a lifecycle hook.", + "id": "autoscaling-put-lifecycle-hook-1", + "title": "To create a lifecycle hook" + } + ], + "PutNotificationConfiguration": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "NotificationTypes": [ + "autoscaling:TEST_NOTIFICATION" + ], + "TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified notification to the specified Auto Scaling group.", + "id": "autoscaling-put-notification-configuration-1", + "title": "To add an Auto Scaling notification" + } + ], + "PutScalingPolicy": [ + { + "input": { + "AdjustmentType": "ChangeInCapacity", + "AutoScalingGroupName": "my-auto-scaling-group", + "PolicyName": "ScaleIn", + "ScalingAdjustment": -1 + }, + "output": { + "PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified policy to the specified Auto Scaling group.", + "id": "autoscaling-put-scaling-policy-1", + "title": "To add a scaling policy to an Auto Scaling group" + } + ], + "PutScheduledUpdateGroupAction": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 4, + "EndTime": "2014-05-12T08:00:00Z", + "MaxSize": 6, + "MinSize": 2, + "ScheduledActionName": "my-scheduled-action", + "StartTime": "2014-05-12T08:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified scheduled action to the specified Auto Scaling group.", + "id": "autoscaling-put-scheduled-update-group-action-1", + "title": "To add a scheduled action to an Auto Scaling group" + } + ], + "RecordLifecycleActionHeartbeat": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635", + "LifecycleHookName": "my-lifecycle-hook" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.", + "id": "autoscaling-record-lifecycle-action-heartbeat-1", + "title": "To record a lifecycle action heartbeat" + } + ], + "ResumeProcesses": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.", + "id": "autoscaling-resume-processes-1", + "title": "To resume Auto Scaling processes" + } + ], + "SetDesiredCapacity": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "DesiredCapacity": 2, + "HonorCooldown": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the desired capacity for the specified Auto Scaling group.", + "id": "autoscaling-set-desired-capacity-1", + "title": "To set the desired capacity for an Auto Scaling group" + } + ], + "SetInstanceHealth": [ + { + "input": { + "HealthStatus": "Unhealthy", + "InstanceId": "i-93633f9b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the health status of the specified instance to Unhealthy.", + "id": "autoscaling-set-instance-health-1", + "title": "To set the health status of an instance" + } + ], + "SetInstanceProtection": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ProtectedFromScaleIn": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables instance protection for the specified instance.", + "id": "autoscaling-set-instance-protection-1", + "title": "To enable instance protection for an instance" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "InstanceIds": [ + "i-93633f9b" + ], + "ProtectedFromScaleIn": false + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables instance protection for the specified instance.", + "id": "autoscaling-set-instance-protection-2", + "title": "To disable instance protection for an instance" + } + ], + "SuspendProcesses": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "ScalingProcesses": [ + "AlarmNotification" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example suspends the specified scaling process for the specified Auto Scaling group.", + "id": "autoscaling-suspend-processes-1", + "title": "To suspend Auto Scaling processes" + } + ], + "TerminateInstanceInAutoScalingGroup": [ + { + "input": { + "InstanceId": "i-93633f9b", + "ShouldDecrementDesiredCapacity": false + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.", + "id": "autoscaling-terminate-instance-in-auto-scaling-group-1", + "title": "To terminate an instance in an Auto Scaling group" + } + ], + "UpdateAutoScalingGroup": [ + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "LaunchConfigurationName": "new-launch-config" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the launch configuration of the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-1", + "title": "To update the launch configuration" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "MaxSize": 3, + "MinSize": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the minimum size and maximum size of the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-2", + "title": "To update the minimum and maximum size" + }, + { + "input": { + "AutoScalingGroupName": "my-auto-scaling-group", + "NewInstancesProtectedFromScaleIn": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables instance protection for the specified Auto Scaling group.", + "id": "autoscaling-update-auto-scaling-group-3", + "title": "To enable instance protection" + } + ] + } +} diff --git a/aws/dist/botocore/data/autoscaling/2011-01-01/paginators-1.json b/aws/dist/botocore/data/autoscaling/2011-01-01/paginators-1.json new file mode 100644 index 00000000..57bafe33 --- /dev/null +++ b/aws/dist/botocore/data/autoscaling/2011-01-01/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "DescribeAutoScalingGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AutoScalingGroups" + }, + "DescribeAutoScalingInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AutoScalingInstances" + }, + "DescribeLaunchConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "LaunchConfigurations" + }, + "DescribeNotificationConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "NotificationConfigurations" + }, + "DescribePolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "ScalingPolicies" + }, + "DescribeScalingActivities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Activities" + }, + "DescribeScheduledActions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "ScheduledUpdateGroupActions" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Tags" + }, + "DescribeLoadBalancerTargetGroups": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "LoadBalancerTargetGroups" + }, + "DescribeLoadBalancers": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "LoadBalancers" + } + } +} diff --git a/aws/dist/botocore/data/autoscaling/2011-01-01/service-2.json b/aws/dist/botocore/data/autoscaling/2011-01-01/service-2.json new file mode 100644 index 00000000..7731c48b --- /dev/null +++ b/aws/dist/botocore/data/autoscaling/2011-01-01/service-2.json @@ -0,0 +1,3836 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2011-01-01", + "endpointPrefix":"autoscaling", + "protocol":"query", + "serviceFullName":"Auto Scaling", + "serviceId":"Auto Scaling", + "signatureVersion":"v4", + "uid":"autoscaling-2011-01-01", + "xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/" + }, + "operations":{ + "AttachInstances":{ + "name":"AttachInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInstancesQuery"}, + "errors":[ + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Attaches one or more EC2 instances to the specified Auto Scaling group.

When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.

If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "AttachLoadBalancerTargetGroups":{ + "name":"AttachLoadBalancerTargetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachLoadBalancerTargetGroupsType"}, + "output":{ + "shape":"AttachLoadBalancerTargetGroupsResultType", + "resultWrapper":"AttachLoadBalancerTargetGroupsResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Attaches one or more target groups to the specified Auto Scaling group.

To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "AttachLoadBalancers":{ + "name":"AttachLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachLoadBalancersType"}, + "output":{ + "shape":"AttachLoadBalancersResultType", + "resultWrapper":"AttachLoadBalancersResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "BatchDeleteScheduledAction":{ + "name":"BatchDeleteScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteScheduledActionType"}, + "output":{ + "shape":"BatchDeleteScheduledActionAnswer", + "resultWrapper":"BatchDeleteScheduledActionResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes one or more scheduled actions for the specified Auto Scaling group.

" + }, + "BatchPutScheduledUpdateGroupAction":{ + "name":"BatchPutScheduledUpdateGroupAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchPutScheduledUpdateGroupActionType"}, + "output":{ + "shape":"BatchPutScheduledUpdateGroupActionAnswer", + "resultWrapper":"BatchPutScheduledUpdateGroupActionResult" + }, + "errors":[ + {"shape":"AlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

" + }, + "CompleteLifecycleAction":{ + "name":"CompleteLifecycleAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CompleteLifecycleActionType"}, + "output":{ + "shape":"CompleteLifecycleActionAnswer", + "resultWrapper":"CompleteLifecycleActionResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Completes the lifecycle action for the specified token or instance with the specified result.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

" + }, + "CreateAutoScalingGroup":{ + "name":"CreateAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAutoScalingGroupType"}, + "errors":[ + {"shape":"AlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

" + }, + "CreateLaunchConfiguration":{ + "name":"CreateLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLaunchConfigurationType"}, + "errors":[ + {"shape":"AlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.

" + }, + "CreateOrUpdateTags":{ + "name":"CreateOrUpdateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOrUpdateTagsType"}, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"AlreadyExistsFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ResourceInUseFault"} + ], + "documentation":"

Creates or updates tags for the specified Auto Scaling group.

When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "DeleteAutoScalingGroup":{ + "name":"DeleteAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAutoScalingGroupType"}, + "errors":[ + {"shape":"ScalingActivityInProgressFault"}, + {"shape":"ResourceInUseFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes the specified Auto Scaling group.

If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.

If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.

To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.

" + }, + "DeleteLaunchConfiguration":{ + "name":"DeleteLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LaunchConfigurationNameType"}, + "errors":[ + {"shape":"ResourceInUseFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes the specified launch configuration.

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

" + }, + "DeleteLifecycleHook":{ + "name":"DeleteLifecycleHook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLifecycleHookType"}, + "output":{ + "shape":"DeleteLifecycleHookAnswer", + "resultWrapper":"DeleteLifecycleHookResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first (ABANDON for launching instances, CONTINUE for terminating instances).

" + }, + "DeleteNotificationConfiguration":{ + "name":"DeleteNotificationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNotificationConfigurationType"}, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes the specified notification.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyType"}, + "errors":[ + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Deletes the specified scaling policy.

Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.

For more information, see Deleting a Scaling Policy in the Amazon EC2 Auto Scaling User Guide.

" + }, + "DeleteScheduledAction":{ + "name":"DeleteScheduledAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScheduledActionType"}, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Deletes the specified scheduled action.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsType"}, + "errors":[ + {"shape":"ResourceContentionFault"}, + {"shape":"ResourceInUseFault"} + ], + "documentation":"

Deletes the specified tags.

" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAccountLimitsAnswer", + "resultWrapper":"DescribeAccountLimitsResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the current Amazon EC2 Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see Amazon EC2 Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.

" + }, + "DescribeAdjustmentTypes":{ + "name":"DescribeAdjustmentTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAdjustmentTypesAnswer", + "resultWrapper":"DescribeAdjustmentTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the policy adjustment types for use with PutScalingPolicy.

" + }, + "DescribeAutoScalingGroups":{ + "name":"DescribeAutoScalingGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AutoScalingGroupNamesType"}, + "output":{ + "shape":"AutoScalingGroupsType", + "resultWrapper":"DescribeAutoScalingGroupsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes one or more Auto Scaling groups.

" + }, + "DescribeAutoScalingInstances":{ + "name":"DescribeAutoScalingInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAutoScalingInstancesType"}, + "output":{ + "shape":"AutoScalingInstancesType", + "resultWrapper":"DescribeAutoScalingInstancesResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes one or more Auto Scaling instances.

" + }, + "DescribeAutoScalingNotificationTypes":{ + "name":"DescribeAutoScalingNotificationTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAutoScalingNotificationTypesAnswer", + "resultWrapper":"DescribeAutoScalingNotificationTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

" + }, + "DescribeLaunchConfigurations":{ + "name":"DescribeLaunchConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LaunchConfigurationNamesType"}, + "output":{ + "shape":"LaunchConfigurationsType", + "resultWrapper":"DescribeLaunchConfigurationsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes one or more launch configurations.

" + }, + "DescribeLifecycleHookTypes":{ + "name":"DescribeLifecycleHookTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeLifecycleHookTypesAnswer", + "resultWrapper":"DescribeLifecycleHookTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the available types of lifecycle hooks.

The following hook types are supported:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

" + }, + "DescribeLifecycleHooks":{ + "name":"DescribeLifecycleHooks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLifecycleHooksType"}, + "output":{ + "shape":"DescribeLifecycleHooksAnswer", + "resultWrapper":"DescribeLifecycleHooksResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the lifecycle hooks for the specified Auto Scaling group.

" + }, + "DescribeLoadBalancerTargetGroups":{ + "name":"DescribeLoadBalancerTargetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerTargetGroupsRequest"}, + "output":{ + "shape":"DescribeLoadBalancerTargetGroupsResponse", + "resultWrapper":"DescribeLoadBalancerTargetGroupsResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the target groups for the specified Auto Scaling group.

" + }, + "DescribeLoadBalancers":{ + "name":"DescribeLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancersRequest"}, + "output":{ + "shape":"DescribeLoadBalancersResponse", + "resultWrapper":"DescribeLoadBalancersResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the load balancers for the specified Auto Scaling group.

This operation describes only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DescribeLoadBalancerTargetGroups instead.

" + }, + "DescribeMetricCollectionTypes":{ + "name":"DescribeMetricCollectionTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeMetricCollectionTypesAnswer", + "resultWrapper":"DescribeMetricCollectionTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

" + }, + "DescribeNotificationConfigurations":{ + "name":"DescribeNotificationConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNotificationConfigurationsType"}, + "output":{ + "shape":"DescribeNotificationConfigurationsAnswer", + "resultWrapper":"DescribeNotificationConfigurationsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the notification actions associated with the specified Auto Scaling group.

" + }, + "DescribePolicies":{ + "name":"DescribePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePoliciesType"}, + "output":{ + "shape":"PoliciesType", + "resultWrapper":"DescribePoliciesResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Describes the policies for the specified Auto Scaling group.

" + }, + "DescribeScalingActivities":{ + "name":"DescribeScalingActivities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingActivitiesType"}, + "output":{ + "shape":"ActivitiesType", + "resultWrapper":"DescribeScalingActivitiesResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes one or more scaling activities for the specified Auto Scaling group.

" + }, + "DescribeScalingProcessTypes":{ + "name":"DescribeScalingProcessTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ProcessesType", + "resultWrapper":"DescribeScalingProcessTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

" + }, + "DescribeScheduledActions":{ + "name":"DescribeScheduledActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledActionsType"}, + "output":{ + "shape":"ScheduledActionsType", + "resultWrapper":"DescribeScheduledActionsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the actions scheduled for your Auto Scaling group that haven't run or that have not reached their end time. To describe the actions that have already run, use DescribeScalingActivities.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsType"}, + "output":{ + "shape":"TagsType", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the specified tags.

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

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

" + }, + "DescribeTerminationPolicyTypes":{ + "name":"DescribeTerminationPolicyTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeTerminationPolicyTypesAnswer", + "resultWrapper":"DescribeTerminationPolicyTypesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Describes the termination policies supported by Amazon EC2 Auto Scaling.

For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

" + }, + "DetachInstances":{ + "name":"DetachInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInstancesQuery"}, + "output":{ + "shape":"DetachInstancesAnswer", + "resultWrapper":"DetachInstancesResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "DetachLoadBalancerTargetGroups":{ + "name":"DetachLoadBalancerTargetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachLoadBalancerTargetGroupsType"}, + "output":{ + "shape":"DetachLoadBalancerTargetGroupsResultType", + "resultWrapper":"DetachLoadBalancerTargetGroupsResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Detaches one or more target groups from the specified Auto Scaling group.

" + }, + "DetachLoadBalancers":{ + "name":"DetachLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachLoadBalancersType"}, + "output":{ + "shape":"DetachLoadBalancersResultType", + "resultWrapper":"DetachLoadBalancersResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Detaches one or more Classic Load Balancers from the specified Auto Scaling group.

This operation detaches only Classic Load Balancers. If you have Application Load Balancers or Network Load Balancers, use DetachLoadBalancerTargetGroups instead.

When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using DescribeLoadBalancers. The instances remain running.

" + }, + "DisableMetricsCollection":{ + "name":"DisableMetricsCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableMetricsCollectionQuery"}, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Disables group metrics for the specified Auto Scaling group.

" + }, + "EnableMetricsCollection":{ + "name":"EnableMetricsCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableMetricsCollectionQuery"}, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "EnterStandby":{ + "name":"EnterStandby", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnterStandbyQuery"}, + "output":{ + "shape":"EnterStandbyAnswer", + "resultWrapper":"EnterStandbyResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Moves the specified instances into the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "ExecutePolicy":{ + "name":"ExecutePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecutePolicyType"}, + "errors":[ + {"shape":"ScalingActivityInProgressFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Executes the specified policy.

" + }, + "ExitStandby":{ + "name":"ExitStandby", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExitStandbyQuery"}, + "output":{ + "shape":"ExitStandbyAnswer", + "resultWrapper":"ExitStandbyResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Moves the specified instances out of the standby state.

For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "PutLifecycleHook":{ + "name":"PutLifecycleHook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLifecycleHookType"}, + "output":{ + "shape":"PutLifecycleHookAnswer", + "resultWrapper":"PutLifecycleHookResult" + }, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Creates or updates a lifecycle hook for the specified Auto Scaling group.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

" + }, + "PutNotificationConfiguration":{ + "name":"PutNotificationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutNotificationConfigurationType"}, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

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

This configuration overwrites any existing configuration.

For more information, see Getting Amazon SNS Notifications When Your Auto Scaling Group Scales in the Amazon EC2 Auto Scaling User Guide.

" + }, + "PutScalingPolicy":{ + "name":"PutScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScalingPolicyType"}, + "output":{ + "shape":"PolicyARNType", + "resultWrapper":"PutScalingPolicyResult" + }, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Creates or updates a scaling policy for an Auto Scaling group. To update an existing scaling policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

For more information about using scaling policies to scale your Auto Scaling group automatically, see Dynamic Scaling in the Amazon EC2 Auto Scaling User Guide.

" + }, + "PutScheduledUpdateGroupAction":{ + "name":"PutScheduledUpdateGroupAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScheduledUpdateGroupActionType"}, + "errors":[ + {"shape":"AlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.

For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

" + }, + "RecordLifecycleActionHeartbeat":{ + "name":"RecordLifecycleActionHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecordLifecycleActionHeartbeatType"}, + "output":{ + "shape":"RecordLifecycleActionHeartbeatAnswer", + "resultWrapper":"RecordLifecycleActionHeartbeatResult" + }, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using PutLifecycleHook.

This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

  5. If you finish before the timeout period ends, complete the lifecycle action.

For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.

" + }, + "ResumeProcesses":{ + "name":"ResumeProcesses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScalingProcessQuery"}, + "errors":[ + {"shape":"ResourceInUseFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Resumes the specified suspended automatic scaling processes, or all suspended process, for the specified Auto Scaling group.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SetDesiredCapacity":{ + "name":"SetDesiredCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetDesiredCapacityType"}, + "errors":[ + {"shape":"ScalingActivityInProgressFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Sets the size of the specified Auto Scaling group.

For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SetInstanceHealth":{ + "name":"SetInstanceHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetInstanceHealthQuery"}, + "errors":[ + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Sets the health status of the specified instance.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SetInstanceProtection":{ + "name":"SetInstanceProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetInstanceProtectionQuery"}, + "output":{ + "shape":"SetInstanceProtectionAnswer", + "resultWrapper":"SetInstanceProtectionResult" + }, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Updates the instance protection settings of the specified instances.

For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SuspendProcesses":{ + "name":"SuspendProcesses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScalingProcessQuery"}, + "errors":[ + {"shape":"ResourceInUseFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

To resume processes that have been suspended, use ResumeProcesses.

For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

" + }, + "TerminateInstanceInAutoScalingGroup":{ + "name":"TerminateInstanceInAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstanceInAutoScalingGroupType"}, + "output":{ + "shape":"ActivityType", + "resultWrapper":"TerminateInstanceInAutoScalingGroupResult" + }, + "errors":[ + {"shape":"ScalingActivityInProgressFault"}, + {"shape":"ResourceContentionFault"} + ], + "documentation":"

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instance is not terminated immediately.

" + }, + "UpdateAutoScalingGroup":{ + "name":"UpdateAutoScalingGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAutoScalingGroupType"}, + "errors":[ + {"shape":"ScalingActivityInProgressFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ServiceLinkedRoleFailure"} + ], + "documentation":"

Updates the configuration for the specified Auto Scaling group.

To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.

If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

Note the following about changing DesiredCapacity, MaxSize, or MinSize:

  • If a scale-in event occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

  • If you specify a new value for MinSize without specifying a value for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group's DesiredCapacity to the new MinSize value.

  • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group's DesiredCapacity to the new MaxSize value.

To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.

" + } + }, + "shapes":{ + "Activities":{ + "type":"list", + "member":{"shape":"Activity"} + }, + "ActivitiesType":{ + "type":"structure", + "required":["Activities"], + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

The scaling activities. Activities are sorted by start time. Activities still in progress are described first.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "Activity":{ + "type":"structure", + "required":[ + "ActivityId", + "AutoScalingGroupName", + "Cause", + "StartTime", + "StatusCode" + ], + "members":{ + "ActivityId":{ + "shape":"XmlString", + "documentation":"

The ID of the activity.

" + }, + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "Description":{ + "shape":"XmlString", + "documentation":"

A friendly, more verbose description of the activity.

" + }, + "Cause":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

The reason the activity began.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The start time of the activity.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The end time of the activity.

" + }, + "StatusCode":{ + "shape":"ScalingActivityStatusCode", + "documentation":"

The current status of the activity.

" + }, + "StatusMessage":{ + "shape":"XmlStringMaxLen255", + "documentation":"

A friendly, more verbose description of the activity status.

" + }, + "Progress":{ + "shape":"Progress", + "documentation":"

A value between 0 and 100 that indicates the progress of the activity.

" + }, + "Details":{ + "shape":"XmlString", + "documentation":"

The details about the activity.

" + } + }, + "documentation":"

Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.

" + }, + "ActivityIds":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "ActivityType":{ + "type":"structure", + "members":{ + "Activity":{ + "shape":"Activity", + "documentation":"

A scaling activity.

" + } + } + }, + "AdjustmentType":{ + "type":"structure", + "members":{ + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" + } + }, + "documentation":"

Describes a policy adjustment type.

" + }, + "AdjustmentTypes":{ + "type":"list", + "member":{"shape":"AdjustmentType"} + }, + "Alarm":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the alarm.

" + }, + "AlarmARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" + } + }, + "documentation":"

Describes an alarm.

" + }, + "Alarms":{ + "type":"list", + "member":{"shape":"Alarm"} + }, + "AlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

You already have an Auto Scaling group or launch configuration with this name.

", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AsciiStringMaxLen255":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[A-Za-z0-9\\-_\\/]+" + }, + "AssociatePublicIpAddress":{"type":"boolean"}, + "AttachInstancesQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The IDs of the instances. You can specify up to 20 instances.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + } + } + }, + "AttachLoadBalancerTargetGroupsResultType":{ + "type":"structure", + "members":{ + } + }, + "AttachLoadBalancerTargetGroupsType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TargetGroupARNs" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TargetGroupARNs":{ + "shape":"TargetGroupARNs", + "documentation":"

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

" + } + } + }, + "AttachLoadBalancersResultType":{ + "type":"structure", + "members":{ + } + }, + "AttachLoadBalancersType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "LoadBalancerNames" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The names of the load balancers. You can specify up to 10 load balancers.

" + } + } + }, + "AutoScalingGroup":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "MinSize", + "MaxSize", + "DesiredCapacity", + "DefaultCooldown", + "AvailabilityZones", + "HealthCheckType", + "CreatedTime" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "AutoScalingGroupARN":{ + "shape":"ResourceName", + "documentation":"

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

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the associated launch configuration.

" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template for the group.

" + }, + "MixedInstancesPolicy":{ + "shape":"MixedInstancesPolicy", + "documentation":"

The mixed instances policy for the group.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The desired size of the group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

One or more Availability Zones for the group.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

One or more load balancers associated with the group.

" + }, + "TargetGroupARNs":{ + "shape":"TargetGroupARNs", + "documentation":"

The Amazon Resource Names (ARN) of the target groups for your load balancer.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

The EC2 instances associated with the group.

" + }, + "CreatedTime":{ + "shape":"TimestampType", + "documentation":"

The date and time the group was created.

" + }, + "SuspendedProcesses":{ + "shape":"SuspendedProcesses", + "documentation":"

The suspended processes associated with the group.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the placement group into which to launch your instances, if any.

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen2047", + "documentation":"

One or more subnet IDs, if applicable, separated by commas.

" + }, + "EnabledMetrics":{ + "shape":"EnabledMetrics", + "documentation":"

The metrics enabled for the group.

" + }, + "Status":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The current state of the group when DeleteAutoScalingGroup is in progress.

" + }, + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

The tags for the group.

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

The termination policies for the group.

" + }, + "NewInstancesProtectedFromScaleIn":{ + "shape":"InstanceProtected", + "documentation":"

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

" + }, + "ServiceLinkedRoleARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.

" + } + }, + "documentation":"

Describes an Auto Scaling group.

" + }, + "AutoScalingGroupDesiredCapacity":{"type":"integer"}, + "AutoScalingGroupMaxSize":{"type":"integer"}, + "AutoScalingGroupMinSize":{"type":"integer"}, + "AutoScalingGroupNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "AutoScalingGroupNamesType":{ + "type":"structure", + "members":{ + "AutoScalingGroupNames":{ + "shape":"AutoScalingGroupNames", + "documentation":"

The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords parameter.

If you omit this parameter, all Auto Scaling groups are described.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "AutoScalingGroups":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"} + }, + "AutoScalingGroupsType":{ + "type":"structure", + "required":["AutoScalingGroups"], + "members":{ + "AutoScalingGroups":{ + "shape":"AutoScalingGroups", + "documentation":"

The groups.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "AutoScalingInstanceDetails":{ + "type":"structure", + "required":[ + "InstanceId", + "AutoScalingGroupName", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "ProtectedFromScaleIn" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + }, + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group for the instance.

" + }, + "AvailabilityZone":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The Availability Zone for the instance.

" + }, + "LifecycleState":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The lifecycle state for the instance.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

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

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.

" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template for the instance.

" + }, + "ProtectedFromScaleIn":{ + "shape":"InstanceProtected", + "documentation":"

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

" + } + }, + "documentation":"

Describes an EC2 instance associated with an Auto Scaling group.

" + }, + "AutoScalingInstances":{ + "type":"list", + "member":{"shape":"AutoScalingInstanceDetails"} + }, + "AutoScalingInstancesType":{ + "type":"structure", + "members":{ + "AutoScalingInstances":{ + "shape":"AutoScalingInstances", + "documentation":"

The instances.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "AutoScalingNotificationTypes":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"}, + "min":1 + }, + "BatchDeleteScheduledActionAnswer":{ + "type":"structure", + "members":{ + "FailedScheduledActions":{ + "shape":"FailedScheduledUpdateGroupActionRequests", + "documentation":"

The names of the scheduled actions that could not be deleted, including an error message.

" + } + } + }, + "BatchDeleteScheduledActionType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ScheduledActionNames" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionNames":{ + "shape":"ScheduledActionNames", + "documentation":"

The names of the scheduled actions to delete. The maximum number allowed is 50.

" + } + } + }, + "BatchPutScheduledUpdateGroupActionAnswer":{ + "type":"structure", + "members":{ + "FailedScheduledUpdateGroupActions":{ + "shape":"FailedScheduledUpdateGroupActionRequests", + "documentation":"

The names of the scheduled actions that could not be created or updated, including an error message.

" + } + } + }, + "BatchPutScheduledUpdateGroupActionType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ScheduledUpdateGroupActions" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledUpdateGroupActions":{ + "shape":"ScheduledUpdateGroupActionRequests", + "documentation":"

One or more scheduled actions. The maximum number allowed is 50.

" + } + } + }, + "BlockDeviceEbsDeleteOnTermination":{"type":"boolean"}, + "BlockDeviceEbsEncrypted":{"type":"boolean"}, + "BlockDeviceEbsIops":{ + "type":"integer", + "max":20000, + "min":100 + }, + "BlockDeviceEbsVolumeSize":{ + "type":"integer", + "max":16384, + "min":1 + }, + "BlockDeviceEbsVolumeType":{ + "type":"string", + "max":255, + "min":1 + }, + "BlockDeviceMapping":{ + "type":"structure", + "required":["DeviceName"], + "members":{ + "VirtualName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the virtual device (for example, ephemeral0).

" + }, + "DeviceName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances.

" + }, + "Ebs":{ + "shape":"Ebs", + "documentation":"

The information about the Amazon EBS volume.

" + }, + "NoDevice":{ + "shape":"NoDevice", + "documentation":"

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.

" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappings":{ + "type":"list", + "member":{"shape":"BlockDeviceMapping"} + }, + "ClassicLinkVPCSecurityGroups":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "CompleteLifecycleActionAnswer":{ + "type":"structure", + "members":{ + } + }, + "CompleteLifecycleActionType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName", + "LifecycleActionResult" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LifecycleActionToken":{ + "shape":"LifecycleActionToken", + "documentation":"

A universally unique identifier (UUID) that identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you specified when you created the lifecycle hook.

" + }, + "LifecycleActionResult":{ + "shape":"LifecycleActionResult", + "documentation":"

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + } + } + }, + "Cooldown":{"type":"integer"}, + "CreateAutoScalingGroupType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "MinSize", + "MaxSize" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group. This name must be unique per Region per account.

" + }, + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of the launch configuration.

If you do not specify LaunchConfigurationName, you must specify one of the following parameters: InstanceId, LaunchTemplate, or MixedInstancesPolicy.

" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template to use to launch instances.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

If you do not specify LaunchTemplate, you must specify one of the following parameters: InstanceId, LaunchConfigurationName, or MixedInstancesPolicy.

" + }, + "MixedInstancesPolicy":{ + "shape":"MixedInstancesPolicy", + "documentation":"

An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.

The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the parameters that specify the instance configuration information—the launch template and instance types.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance used to create a launch configuration for the group.

When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, except for the block device mapping.

For more information, see Create an Auto Scaling Group Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

You must specify one of the following parameters in your request: LaunchConfigurationName, LaunchTemplate, InstanceId, or MixedInstancesPolicy.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of Amazon EC2 instances that the Auto Scaling group attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets for VPCZoneIdentifier.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into EC2-Classic.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers and Network Load Balancers, specify a list of target groups using the TargetGroupARNs property instead.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "TargetGroupARNs":{ + "shape":"TargetGroupARNs", + "documentation":"

The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. Instances are registered as targets in a target group, and traffic is routed to the target group.

For more information, see Using a Load Balancer with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB. The default value is EC2. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

For more information, see Health Checks for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. During this time, any health check failures for the instance are ignored. The default value is 0.

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen2047", + "documentation":"

A comma-separated list of subnet IDs for your virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

Conditional: If your account supports EC2-Classic and VPC, this parameter is required to launch instances into a VPC.

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

One or more termination policies used to select the instance to terminate. These policies are executed in the order that they are listed.

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

" + }, + "NewInstancesProtectedFromScaleIn":{ + "shape":"InstanceProtected", + "documentation":"

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + }, + "LifecycleHookSpecificationList":{ + "shape":"LifecycleHookSpecifications", + "documentation":"

One or more lifecycle hooks.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "ServiceLinkedRoleARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

" + } + } + }, + "CreateLaunchConfigurationType":{ + "type":"structure", + "required":["LaunchConfigurationName"], + "members":{ + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the launch configuration. This name must be unique per Region per account.

" + }, + "ImageId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

If you do not specify InstanceId, you must specify ImageId.

" + }, + "KeyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A list that contains the security groups to assign to the instances in the Auto Scaling group.

[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

[EC2-Classic] Specify either the security group names or the security group IDs. For more information, see Amazon EC2 Security Groups in the Amazon EC2 User Guide for Linux Instances.

" + }, + "ClassicLinkVPCId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

This parameter can only be used if you are launching EC2-Classic instances.

" + }, + "ClassicLinkVPCSecurityGroups":{ + "shape":"ClassicLinkVPCSecurityGroups", + "documentation":"

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify the ClassicLinkVPCId parameter, you must specify this parameter.

" + }, + "UserData":{ + "shape":"XmlStringUserData", + "documentation":"

The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.

To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.

For more information, see Create a Launch Configuration Using an EC2 Instance in the Amazon EC2 Auto Scaling User Guide.

If you do not specify InstanceId, you must specify both ImageId and InstanceType.

" + }, + "InstanceType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies the instance type of the EC2 instance.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

If you do not specify InstanceId, you must specify InstanceType.

" + }, + "KernelId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the kernel associated with the AMI.

" + }, + "RamdiskId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the RAM disk to select.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

A block device mapping, which specifies the block devices for the instance. You can specify virtual devices and EBS volumes. For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

" + }, + "InstanceMonitoring":{ + "shape":"InstanceMonitoring", + "documentation":"

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

The default value is true (enabled).

When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SpotPrice":{ + "shape":"SpotPrice", + "documentation":"

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price. For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

If a Spot price is set, then the Auto Scaling group will only launch instances when the Spot price has been met, regardless of the setting in the Auto Scaling group's DesiredCapacity.

When you change your Spot price by creating a new launch configuration, running instances will continue to run as long as the Spot price for those running instances is higher than the current Spot market price.

" + }, + "IamInstanceProfile":{ + "shape":"XmlStringMaxLen1600", + "documentation":"

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

For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "EbsOptimized":{ + "shape":"EbsOptimized", + "documentation":"

Specifies whether the launch configuration is optimized for EBS I/O (true) or not (false). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

The default value is false.

" + }, + "AssociatePublicIpAddress":{ + "shape":"AssociatePublicIpAddress", + "documentation":"

For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether to assign a public IP address to the group's instances. If you specify true, each instance in the Auto Scaling group receives a unique public IP address. For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

If you specify this parameter, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

If the instance is launched into a default subnet, the default is to assign a public IP address, unless you disabled the option to assign a public IP address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address, unless you enabled the option to assign a public IP address on the subnet.

" + }, + "PlacementTenancy":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.

To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to default), you must set the value of this parameter to dedicated.

If you specify PlacementTenancy, you must specify at least one subnet for VPCZoneIdentifier when you create your group.

For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.

Valid values: default | dedicated

" + } + } + }, + "CreateOrUpdateTagsType":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

One or more tags.

" + } + } + }, + "CustomizedMetricSpecification":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Namespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the metric.

" + }, + "Dimensions":{ + "shape":"MetricDimensions", + "documentation":"

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

" + }, + "Statistic":{ + "shape":"MetricStatistic", + "documentation":"

The statistic of the metric.

" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"

The unit of the metric.

" + } + }, + "documentation":"

Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

To create your customized metric specification:

  • Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see Publish Custom Metrics in the Amazon CloudWatch User Guide.

  • Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases.

For more information about CloudWatch, see Amazon CloudWatch Concepts.

" + }, + "DeleteAutoScalingGroupType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ForceDelete":{ + "shape":"ForceDelete", + "documentation":"

Specifies that the group is to be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

" + } + } + }, + "DeleteLifecycleHookAnswer":{ + "type":"structure", + "members":{ + } + }, + "DeleteLifecycleHookType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + } + } + }, + "DeleteNotificationConfigurationType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TopicARN" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

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

" + } + } + }, + "DeletePolicyType":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The name or Amazon Resource Name (ARN) of the policy.

" + } + } + }, + "DeleteScheduledActionType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionName":{ + "shape":"ResourceName", + "documentation":"

The name of the action to delete.

" + } + } + }, + "DeleteTagsType":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

One or more tags.

" + } + } + }, + "DescribeAccountLimitsAnswer":{ + "type":"structure", + "members":{ + "MaxNumberOfAutoScalingGroups":{ + "shape":"MaxNumberOfAutoScalingGroups", + "documentation":"

The maximum number of groups allowed for your AWS account. The default limit is 200 per AWS Region.

" + }, + "MaxNumberOfLaunchConfigurations":{ + "shape":"MaxNumberOfLaunchConfigurations", + "documentation":"

The maximum number of launch configurations allowed for your AWS account. The default limit is 200 per AWS Region.

" + }, + "NumberOfAutoScalingGroups":{ + "shape":"NumberOfAutoScalingGroups", + "documentation":"

The current number of groups for your AWS account.

" + }, + "NumberOfLaunchConfigurations":{ + "shape":"NumberOfLaunchConfigurations", + "documentation":"

The current number of launch configurations for your AWS account.

" + } + } + }, + "DescribeAdjustmentTypesAnswer":{ + "type":"structure", + "members":{ + "AdjustmentTypes":{ + "shape":"AdjustmentTypes", + "documentation":"

The policy adjustment types.

" + } + } + }, + "DescribeAutoScalingInstancesType":{ + "type":"structure", + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The IDs of the instances. You can specify up to MaxRecords IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + } + } + }, + "DescribeAutoScalingNotificationTypesAnswer":{ + "type":"structure", + "members":{ + "AutoScalingNotificationTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

The notification types.

" + } + } + }, + "DescribeLifecycleHookTypesAnswer":{ + "type":"structure", + "members":{ + "LifecycleHookTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

The lifecycle hook types.

" + } + } + }, + "DescribeLifecycleHooksAnswer":{ + "type":"structure", + "members":{ + "LifecycleHooks":{ + "shape":"LifecycleHooks", + "documentation":"

The lifecycle hooks for the specified group.

" + } + } + }, + "DescribeLifecycleHooksType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LifecycleHookNames":{ + "shape":"LifecycleHookNames", + "documentation":"

The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.

" + } + } + }, + "DescribeLoadBalancerTargetGroupsRequest":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

" + } + } + }, + "DescribeLoadBalancerTargetGroupsResponse":{ + "type":"structure", + "members":{ + "LoadBalancerTargetGroups":{ + "shape":"LoadBalancerTargetGroupStates", + "documentation":"

Information about the target groups.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "DescribeLoadBalancersRequest":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

" + } + } + }, + "DescribeLoadBalancersResponse":{ + "type":"structure", + "members":{ + "LoadBalancers":{ + "shape":"LoadBalancerStates", + "documentation":"

The load balancers.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "DescribeMetricCollectionTypesAnswer":{ + "type":"structure", + "members":{ + "Metrics":{ + "shape":"MetricCollectionTypes", + "documentation":"

One or more metrics.

" + }, + "Granularities":{ + "shape":"MetricGranularityTypes", + "documentation":"

The granularities for the metrics.

" + } + } + }, + "DescribeNotificationConfigurationsAnswer":{ + "type":"structure", + "required":["NotificationConfigurations"], + "members":{ + "NotificationConfigurations":{ + "shape":"NotificationConfigurations", + "documentation":"

The notification configurations.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "DescribeNotificationConfigurationsType":{ + "type":"structure", + "members":{ + "AutoScalingGroupNames":{ + "shape":"AutoScalingGroupNames", + "documentation":"

The name of the Auto Scaling group.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "DescribePoliciesType":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of one or more policies. If you omit this parameter, all policies are described. If a group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.

" + }, + "PolicyTypes":{ + "shape":"PolicyTypes", + "documentation":"

One or more policy types. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "DescribeScalingActivitiesType":{ + "type":"structure", + "members":{ + "ActivityIds":{ + "shape":"ActivityIds", + "documentation":"

The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If you omit this parameter, all activities for the past six weeks are described. If unknown activities are requested, they are ignored with no error. If you specify an Auto Scaling group, the results are limited to that group.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + } + } + }, + "DescribeScheduledActionsType":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionNames":{ + "shape":"ScheduledActionNames", + "documentation":"

The names of one or more scheduled actions. You can specify up to 50 actions. If you omit this parameter, all scheduled actions are described. If you specify an unknown scheduled action, it is ignored with no error.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

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

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "DescribeTagsType":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"Filters", + "documentation":"

One or more filters to scope the tags to return. The maximum number of filters per filter type (for example, auto-scaling-group) is 1000.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "DescribeTerminationPolicyTypesAnswer":{ + "type":"structure", + "members":{ + "TerminationPolicyTypes":{ + "shape":"TerminationPolicies", + "documentation":"

The termination policies supported by Amazon EC2 Auto Scaling: OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, Default, OldestLaunchTemplate, and AllocationStrategy.

" + } + } + }, + "DetachInstancesAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

The activities related to detaching the instances from the Auto Scaling group.

" + } + } + }, + "DetachInstancesQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The IDs of the instances. You can specify up to 20 instances.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

" + } + } + }, + "DetachLoadBalancerTargetGroupsResultType":{ + "type":"structure", + "members":{ + } + }, + "DetachLoadBalancerTargetGroupsType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TargetGroupARNs" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TargetGroupARNs":{ + "shape":"TargetGroupARNs", + "documentation":"

The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.

" + } + } + }, + "DetachLoadBalancersResultType":{ + "type":"structure", + "members":{ + } + }, + "DetachLoadBalancersType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "LoadBalancerNames" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The names of the load balancers. You can specify up to 10 load balancers.

" + } + } + }, + "DisableMetricsCollectionQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"

One or more of the following metrics. If you omit this parameter, all metrics are disabled.

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" + } + } + }, + "DisableScaleIn":{"type":"boolean"}, + "Ebs":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The snapshot ID of the volume to use.

Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.

" + }, + "VolumeSize":{ + "shape":"BlockDeviceEbsVolumeSize", + "documentation":"

The volume size, in Gibibytes (GiB).

This can be a number from 1-1,024 for standard, 4-16,384 for io1, 1-16,384 for gp2, and 500-16,384 for st1 and sc1. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

At least one of VolumeSize or SnapshotId is required.

" + }, + "VolumeType":{ + "shape":"BlockDeviceEbsVolumeType", + "documentation":"

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Valid values: standard | io1 | gp2 | st1 | sc1

" + }, + "DeleteOnTermination":{ + "shape":"BlockDeviceEbsDeleteOnTermination", + "documentation":"

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true.

" + }, + "Iops":{ + "shape":"BlockDeviceEbsIops", + "documentation":"

The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

" + }, + "Encrypted":{ + "shape":"BlockDeviceEbsEncrypted", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "documentation":"

Describes an Amazon EBS volume. Used in combination with BlockDeviceMapping.

" + }, + "EbsOptimized":{"type":"boolean"}, + "EnableMetricsCollectionQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "Granularity" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"

One or more of the following metrics. If you omit this parameter, all metrics are enabled.

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" + }, + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

" + } + } + }, + "EnabledMetric":{ + "type":"structure", + "members":{ + "Metric":{ + "shape":"XmlStringMaxLen255", + "documentation":"

One of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" + }, + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity of the metric. The only valid value is 1Minute.

" + } + }, + "documentation":"

Describes an enabled metric.

" + }, + "EnabledMetrics":{ + "type":"list", + "member":{"shape":"EnabledMetric"} + }, + "EnterStandbyAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

The activities related to moving instances into Standby mode.

" + } + } + }, + "EnterStandbyQuery":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The IDs of the instances. You can specify up to 20 instances.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

" + } + } + }, + "EstimatedInstanceWarmup":{"type":"integer"}, + "ExecutePolicyType":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The name or ARN of the policy.

" + }, + "HonorCooldown":{ + "shape":"HonorCooldown", + "documentation":"

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling or TargetTrackingScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + }, + "MetricValue":{ + "shape":"MetricScale", + "documentation":"

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

" + }, + "BreachThreshold":{ + "shape":"MetricScale", + "documentation":"

The breach threshold for the alarm.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

" + } + } + }, + "ExitStandbyAnswer":{ + "type":"structure", + "members":{ + "Activities":{ + "shape":"Activities", + "documentation":"

The activities related to moving instances out of Standby mode.

" + } + } + }, + "ExitStandbyQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

The IDs of the instances. You can specify up to 20 instances.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + } + } + }, + "FailedScheduledUpdateGroupActionRequest":{ + "type":"structure", + "required":["ScheduledActionName"], + "members":{ + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the scheduled action.

" + }, + "ErrorCode":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"XmlString", + "documentation":"

The error message accompanying the error code.

" + } + }, + "documentation":"

Describes a scheduled action that could not be created, updated, or deleted.

" + }, + "FailedScheduledUpdateGroupActionRequests":{ + "type":"list", + "member":{"shape":"FailedScheduledUpdateGroupActionRequest"} + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

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

" + }, + "Values":{ + "shape":"Values", + "documentation":"

The value of the filter.

" + } + }, + "documentation":"

Describes a filter.

" + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "ForceDelete":{"type":"boolean"}, + "GlobalTimeout":{"type":"integer"}, + "HealthCheckGracePeriod":{"type":"integer"}, + "HeartbeatTimeout":{"type":"integer"}, + "HonorCooldown":{"type":"boolean"}, + "Instance":{ + "type":"structure", + "required":[ + "InstanceId", + "AvailabilityZone", + "LifecycleState", + "HealthStatus", + "ProtectedFromScaleIn" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + }, + "AvailabilityZone":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The Availability Zone in which the instance is running.

" + }, + "LifecycleState":{ + "shape":"LifecycleState", + "documentation":"

A description of the current lifecycle state. The Quarantined state is not used.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

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

" + }, + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The launch configuration associated with the instance.

" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template for the instance.

" + }, + "ProtectedFromScaleIn":{ + "shape":"InstanceProtected", + "documentation":"

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

" + } + }, + "documentation":"

Describes an EC2 instance.

" + }, + "InstanceIds":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen19"} + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"MonitoringEnabled", + "documentation":"

If true, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

" + } + }, + "documentation":"

Describes whether detailed monitoring is enabled for the Auto Scaling instances.

" + }, + "InstanceProtected":{"type":"boolean"}, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstancesDistribution":{ + "type":"structure", + "members":{ + "OnDemandAllocationStrategy":{ + "shape":"XmlString", + "documentation":"

Indicates how to allocate instance types to fulfill On-Demand capacity.

The only valid value is prioritized, which is also the default value. This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.

" + }, + "OnDemandBaseCapacity":{ + "shape":"OnDemandBaseCapacity", + "documentation":"

The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales.

The default value is 0. If you leave this parameter set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group's desired capacity, per the OnDemandPercentageAboveBaseCapacity setting.

" + }, + "OnDemandPercentageAboveBaseCapacity":{ + "shape":"OnDemandPercentageAboveBaseCapacity", + "documentation":"

Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. The range is 0–100.

The default value is 100. If you leave this parameter set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances.

" + }, + "SpotAllocationStrategy":{ + "shape":"XmlString", + "documentation":"

Indicates how to allocate instances across Spot Instance pools.

If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized, the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity.

The default Spot allocation strategy for calls that you make through the API, the AWS CLI, or the AWS SDKs is lowest-price. The default Spot allocation strategy for the AWS Management Console is capacity-optimized.

Valid values: lowest-price | capacity-optimized

" + }, + "SpotInstancePools":{ + "shape":"SpotInstancePools", + "documentation":"

The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. The range is 1–20. The default value is 2.

Valid only when the Spot allocation strategy is lowest-price.

" + }, + "SpotMaxPrice":{ + "shape":"MixedInstanceSpotPrice", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price.

To remove a value that you previously set, include the parameter but leave the value blank.

" + } + }, + "documentation":"

Describes an instances distribution for an Auto Scaling group with MixedInstancesPolicy.

The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.

" + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

The NextToken value is not valid.

", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LaunchConfiguration":{ + "type":"structure", + "required":[ + "LaunchConfigurationName", + "ImageId", + "InstanceType", + "CreatedTime" + ], + "members":{ + "LaunchConfigurationName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the launch configuration.

" + }, + "LaunchConfigurationARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the launch configuration.

" + }, + "ImageId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.

For more information, see Finding an AMI in the Amazon EC2 User Guide for Linux Instances.

" + }, + "KeyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the key pair.

For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A list that contains the security groups to assign to the instances in the Auto Scaling group.

For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "ClassicLinkVPCId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.

For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + }, + "ClassicLinkVPCSecurityGroups":{ + "shape":"ClassicLinkVPCSecurityGroups", + "documentation":"

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId.

For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.

" + }, + "UserData":{ + "shape":"XmlStringUserData", + "documentation":"

The Base64-encoded user data to make available to the launched EC2 instances.

For more information, see Instance Metadata and User Data in the Amazon EC2 User Guide for Linux Instances.

" + }, + "InstanceType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The instance type for the instances.

For information about available instance types, see Available Instance Types in the Amazon EC2 User Guide for Linux Instances.

" + }, + "KernelId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the kernel associated with the AMI.

" + }, + "RamdiskId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the RAM disk associated with the AMI.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

A block device mapping, which specifies the block devices for the instance.

For more information, see Block Device Mapping in the Amazon EC2 User Guide for Linux Instances.

" + }, + "InstanceMonitoring":{ + "shape":"InstanceMonitoring", + "documentation":"

Controls whether instances in this group are launched with detailed (true) or basic (false) monitoring.

For more information, see Configure Monitoring for Auto Scaling Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "SpotPrice":{ + "shape":"SpotPrice", + "documentation":"

The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot market price.

For more information, see Launching Spot Instances in Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "IamInstanceProfile":{ + "shape":"XmlStringMaxLen1600", + "documentation":"

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

For more information, see IAM Role for Applications That Run on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.

" + }, + "CreatedTime":{ + "shape":"TimestampType", + "documentation":"

The creation date and time for the launch configuration.

" + }, + "EbsOptimized":{ + "shape":"EbsOptimized", + "documentation":"

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

For more information, see Amazon EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.

" + }, + "AssociatePublicIpAddress":{ + "shape":"AssociatePublicIpAddress", + "documentation":"

For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP address to the group's instances.

For more information, see Launching Auto Scaling Instances in a VPC in the Amazon EC2 Auto Scaling User Guide.

" + }, + "PlacementTenancy":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The tenancy of the instance, either default or dedicated. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.

For more information, see Instance Placement Tenancy in the Amazon EC2 Auto Scaling User Guide.

" + } + }, + "documentation":"

Describes a launch configuration.

" + }, + "LaunchConfigurationNameType":{ + "type":"structure", + "required":["LaunchConfigurationName"], + "members":{ + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of the launch configuration.

" + } + } + }, + "LaunchConfigurationNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "LaunchConfigurationNamesType":{ + "type":"structure", + "members":{ + "LaunchConfigurationNames":{ + "shape":"LaunchConfigurationNames", + "documentation":"

The launch configuration names. If you omit this parameter, all launch configurations are described.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.

" + } + } + }, + "LaunchConfigurations":{ + "type":"list", + "member":{"shape":"LaunchConfiguration"} + }, + "LaunchConfigurationsType":{ + "type":"structure", + "required":["LaunchConfigurations"], + "members":{ + "LaunchConfigurations":{ + "shape":"LaunchConfigurations", + "documentation":"

The launch configurations.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "LaunchTemplate":{ + "type":"structure", + "members":{ + "LaunchTemplateSpecification":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template to use. You must specify either the launch template ID or launch template name in the request.

" + }, + "Overrides":{ + "shape":"Overrides", + "documentation":"

Any parameters that you specify override the same parameters in the launch template. Currently, the only supported override is instance type. You must specify between 2 and 20 overrides.

" + } + }, + "documentation":"

Describes a launch template and overrides.

The overrides are used to override the instance type specified by the launch template with multiple instance types that can be used to launch On-Demand Instances and Spot Instances.

" + }, + "LaunchTemplateName":{ + "type":"string", + "max":128, + "min":3, + "pattern":"[a-zA-Z0-9\\(\\)\\.-/_]+" + }, + "LaunchTemplateOverrides":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The instance type.

For information about available instance types, see Available Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "documentation":"

Describes an override for a launch template.

" + }, + "LaunchTemplateSpecification":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The ID of the launch template. You must specify either a template ID or a template name.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either a template name or a template ID.

" + }, + "Version":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The version number, $Latest, or $Default. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.

" + } + }, + "documentation":"

Describes a launch template and the launch template version.

The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Creating a Launch Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

" + }, + "LifecycleActionResult":{"type":"string"}, + "LifecycleActionToken":{ + "type":"string", + "max":36, + "min":36 + }, + "LifecycleHook":{ + "type":"structure", + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group for the lifecycle hook.

" + }, + "LifecycleTransition":{ + "shape":"LifecycleTransition", + "documentation":"

The state of the EC2 instance to which to attach the lifecycle hook. The following are possible values:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

" + }, + "NotificationTargetARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

" + }, + "RoleARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.

" + }, + "NotificationMetadata":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.

" + }, + "HeartbeatTimeout":{ + "shape":"HeartbeatTimeout", + "documentation":"

The maximum time, in seconds, that can elapse before the lifecycle hook times out. If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter.

" + }, + "GlobalTimeout":{ + "shape":"GlobalTimeout", + "documentation":"

The maximum time, in seconds, that an instance can remain in a Pending:Wait or Terminating:Wait state. The maximum is 172800 seconds (48 hours) or 100 times HeartbeatTimeout, whichever is smaller.

" + }, + "DefaultResult":{ + "shape":"LifecycleActionResult", + "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The possible values are CONTINUE and ABANDON.

" + } + }, + "documentation":"

Describes a lifecycle hook, which tells Amazon EC2 Auto Scaling that you want to perform an action whenever it launches instances or terminates instances. Used in response to DescribeLifecycleHooks.

" + }, + "LifecycleHookNames":{ + "type":"list", + "member":{"shape":"AsciiStringMaxLen255"}, + "max":50 + }, + "LifecycleHookSpecification":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "LifecycleTransition" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "LifecycleTransition":{ + "shape":"LifecycleTransition", + "documentation":"

The state of the EC2 instance to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

" + }, + "NotificationMetadata":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

" + }, + "HeartbeatTimeout":{ + "shape":"HeartbeatTimeout", + "documentation":"

The maximum time, in seconds, that can elapse before the lifecycle hook times out.

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" + }, + "DefaultResult":{ + "shape":"LifecycleActionResult", + "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are CONTINUE and ABANDON. The default value is ABANDON.

" + }, + "NotificationTargetARN":{ + "shape":"NotificationTargetResourceName", + "documentation":"

The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.

" + }, + "RoleARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

" + } + }, + "documentation":"

Describes a lifecycle hook. Used in combination with CreateAutoScalingGroup.

A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).

This step is a part of the procedure for creating a lifecycle hook for an Auto Scaling group:

  1. (Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.

  2. (Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.

  3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

  4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat.

  5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

For more information, see Amazon EC2 Auto Scaling Lifecycle Hooks in the Amazon EC2 Auto Scaling User Guide.

You can view the lifecycle hooks for an Auto Scaling group using DescribeLifecycleHooks. You can modify an existing lifecycle hook or create new lifecycle hooks using PutLifecycleHook. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

" + }, + "LifecycleHookSpecifications":{ + "type":"list", + "member":{"shape":"LifecycleHookSpecification"} + }, + "LifecycleHooks":{ + "type":"list", + "member":{"shape":"LifecycleHook"} + }, + "LifecycleState":{ + "type":"string", + "enum":[ + "Pending", + "Pending:Wait", + "Pending:Proceed", + "Quarantined", + "InService", + "Terminating", + "Terminating:Wait", + "Terminating:Proceed", + "Terminated", + "Detaching", + "Detached", + "EnteringStandby", + "Standby" + ] + }, + "LifecycleTransition":{"type":"string"}, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LoadBalancerNames":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "LoadBalancerState":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the load balancer.

" + }, + "State":{ + "shape":"XmlStringMaxLen255", + "documentation":"

One of the following load balancer states:

  • Adding - The instances in the group are being registered with the load balancer.

  • Added - All instances in the group are registered with the load balancer.

  • InService - At least one instance in the group passed an ELB health check.

  • Removing - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

  • Removed - All instances in the group are deregistered from the load balancer.

" + } + }, + "documentation":"

Describes the state of a Classic Load Balancer.

If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is InService.

If you attach a load balancer to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all instances in the group are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the load balancer, the state transitions to InService after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the Added state.

" + }, + "LoadBalancerStates":{ + "type":"list", + "member":{"shape":"LoadBalancerState"} + }, + "LoadBalancerTargetGroupState":{ + "type":"structure", + "members":{ + "LoadBalancerTargetGroupARN":{ + "shape":"XmlStringMaxLen511", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "State":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The state of the target group.

  • Adding - The Auto Scaling instances are being registered with the target group.

  • Added - All Auto Scaling instances are registered with the target group.

  • InService - At least one Auto Scaling instance passed an ELB health check.

  • Removing - The Auto Scaling instances are being deregistered from the target group. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.

  • Removed - All Auto Scaling instances are deregistered from the target group.

" + } + }, + "documentation":"

Describes the state of a target group.

If you attach a target group to an existing Auto Scaling group, the initial state is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled, the state transitions to InService after at least one Auto Scaling instance passes the health check. If EC2 health checks are enabled instead, the target group remains in the Added state.

" + }, + "LoadBalancerTargetGroupStates":{ + "type":"list", + "member":{"shape":"LoadBalancerTargetGroupState"} + }, + "MaxNumberOfAutoScalingGroups":{"type":"integer"}, + "MaxNumberOfLaunchConfigurations":{"type":"integer"}, + "MaxRecords":{"type":"integer"}, + "MetricCollectionType":{ + "type":"structure", + "members":{ + "Metric":{ + "shape":"XmlStringMaxLen255", + "documentation":"

One of the following metrics:

  • GroupMinSize

  • GroupMaxSize

  • GroupDesiredCapacity

  • GroupInServiceInstances

  • GroupPendingInstances

  • GroupStandbyInstances

  • GroupTerminatingInstances

  • GroupTotalInstances

" + } + }, + "documentation":"

Describes a metric.

" + }, + "MetricCollectionTypes":{ + "type":"list", + "member":{"shape":"MetricCollectionType"} + }, + "MetricDimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MetricDimensionName", + "documentation":"

The name of the dimension.

" + }, + "Value":{ + "shape":"MetricDimensionValue", + "documentation":"

The value of the dimension.

" + } + }, + "documentation":"

Describes the dimension of a metric.

" + }, + "MetricDimensionName":{"type":"string"}, + "MetricDimensionValue":{"type":"string"}, + "MetricDimensions":{ + "type":"list", + "member":{"shape":"MetricDimension"} + }, + "MetricGranularityType":{ + "type":"structure", + "members":{ + "Granularity":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The granularity. The only valid value is 1Minute.

" + } + }, + "documentation":"

Describes a granularity of a metric.

" + }, + "MetricGranularityTypes":{ + "type":"list", + "member":{"shape":"MetricGranularityType"} + }, + "MetricName":{"type":"string"}, + "MetricNamespace":{"type":"string"}, + "MetricScale":{"type":"double"}, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Average", + "Minimum", + "Maximum", + "SampleCount", + "Sum" + ] + }, + "MetricType":{ + "type":"string", + "enum":[ + "ASGAverageCPUUtilization", + "ASGAverageNetworkIn", + "ASGAverageNetworkOut", + "ALBRequestCountPerTarget" + ] + }, + "MetricUnit":{"type":"string"}, + "Metrics":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "MinAdjustmentMagnitude":{"type":"integer"}, + "MinAdjustmentStep":{ + "type":"integer", + "deprecated":true + }, + "MixedInstanceSpotPrice":{ + "type":"string", + "max":255, + "min":0 + }, + "MixedInstancesPolicy":{ + "type":"structure", + "members":{ + "LaunchTemplate":{ + "shape":"LaunchTemplate", + "documentation":"

The launch template and instance types (overrides).

This parameter must be specified when creating a mixed instances policy.

" + }, + "InstancesDistribution":{ + "shape":"InstancesDistribution", + "documentation":"

The instances distribution to use.

If you leave this parameter unspecified when creating a mixed instances policy, the default values are used.

" + } + }, + "documentation":"

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify MixedInstancesPolicy as the top-level parameter instead of a launch configuration or template. For more information, see CreateAutoScalingGroup and UpdateAutoScalingGroup.

" + }, + "MonitoringEnabled":{"type":"boolean"}, + "NoDevice":{"type":"boolean"}, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

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

" + }, + "NotificationType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

One of the following event notification types:

  • autoscaling:EC2_INSTANCE_LAUNCH

  • autoscaling:EC2_INSTANCE_LAUNCH_ERROR

  • autoscaling:EC2_INSTANCE_TERMINATE

  • autoscaling:EC2_INSTANCE_TERMINATE_ERROR

  • autoscaling:TEST_NOTIFICATION

" + } + }, + "documentation":"

Describes a notification.

" + }, + "NotificationConfigurations":{ + "type":"list", + "member":{"shape":"NotificationConfiguration"} + }, + "NotificationTargetResourceName":{ + "type":"string", + "max":1600, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "NumberOfAutoScalingGroups":{"type":"integer"}, + "NumberOfLaunchConfigurations":{"type":"integer"}, + "OnDemandBaseCapacity":{"type":"integer"}, + "OnDemandPercentageAboveBaseCapacity":{"type":"integer"}, + "Overrides":{ + "type":"list", + "member":{"shape":"LaunchTemplateOverrides"} + }, + "PoliciesType":{ + "type":"structure", + "members":{ + "ScalingPolicies":{ + "shape":"ScalingPolicies", + "documentation":"

The scaling policies.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "PolicyARNType":{ + "type":"structure", + "members":{ + "PolicyARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the policy.

" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"

The CloudWatch alarms created for the target tracking scaling policy.

" + } + }, + "documentation":"

Contains the output of PutScalingPolicy.

" + }, + "PolicyIncrement":{"type":"integer"}, + "PolicyNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "PolicyTypes":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen64"} + }, + "PredefinedMetricSpecification":{ + "type":"structure", + "required":["PredefinedMetricType"], + "members":{ + "PredefinedMetricType":{ + "shape":"MetricType", + "documentation":"

The metric type.

" + }, + "ResourceLabel":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Identifies the resource associated with the metric type. The following predefined metrics are available:

  • ASGAverageCPUUtilization - Average CPU utilization of the Auto Scaling group.

  • ASGAverageNetworkIn - Average number of bytes received on all network interfaces by the Auto Scaling group.

  • ASGAverageNetworkOut - Average number of bytes sent out on all network interfaces by the Auto Scaling group.

  • ALBRequestCountPerTarget - Number of requests completed per target in an Application Load Balancer target group.

For predefined metric types ASGAverageCPUUtilization, ASGAverageNetworkIn, and ASGAverageNetworkOut, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type ALBRequestCountPerTarget, the parameter must be specified in the format: app/load-balancer-name/load-balancer-id/targetgroup/target-group-name/target-group-id , where app/load-balancer-name/load-balancer-id is the final portion of the load balancer ARN, and targetgroup/target-group-name/target-group-id is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.

" + } + }, + "documentation":"

Represents a predefined metric for a target tracking scaling policy to use with Amazon EC2 Auto Scaling.

" + }, + "ProcessNames":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen255"} + }, + "ProcessType":{ + "type":"structure", + "required":["ProcessName"], + "members":{ + "ProcessName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

One of the following processes:

  • Launch

  • Terminate

  • AddToLoadBalancer

  • AlarmNotification

  • AZRebalance

  • HealthCheck

  • ReplaceUnhealthy

  • ScheduledActions

" + } + }, + "documentation":"

Describes a process type.

For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

" + }, + "Processes":{ + "type":"list", + "member":{"shape":"ProcessType"} + }, + "ProcessesType":{ + "type":"structure", + "members":{ + "Processes":{ + "shape":"Processes", + "documentation":"

The names of the process types.

" + } + } + }, + "Progress":{"type":"integer"}, + "PropagateAtLaunch":{"type":"boolean"}, + "ProtectedFromScaleIn":{"type":"boolean"}, + "PutLifecycleHookAnswer":{ + "type":"structure", + "members":{ + } + }, + "PutLifecycleHookType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LifecycleTransition":{ + "shape":"LifecycleTransition", + "documentation":"

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" + }, + "RoleARN":{ + "shape":"ResourceName", + "documentation":"

The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target, for example, an Amazon SNS topic or an Amazon SQS queue.

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" + }, + "NotificationTargetARN":{ + "shape":"NotificationTargetResourceName", + "documentation":"

The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance is in the transition state for the lifecycle hook. This target can be either an SQS queue or an SNS topic.

If you specify an empty string, this overrides the current ARN.

This operation uses the JSON format when sending notifications to an Amazon SQS queue, and an email key-value pair format when sending notifications to an Amazon SNS topic.

When you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test messages contain the following additional key-value pair: \"Event\": \"autoscaling:TEST_NOTIFICATION\".

" + }, + "NotificationMetadata":{ + "shape":"XmlStringMaxLen1023", + "documentation":"

Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.

" + }, + "HeartbeatTimeout":{ + "shape":"HeartbeatTimeout", + "documentation":"

The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from 30 to 7200 seconds. The default value is 3600 seconds (1 hour).

If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the DefaultResult parameter. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

" + }, + "DefaultResult":{ + "shape":"LifecycleActionResult", + "documentation":"

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

" + } + } + }, + "PutNotificationConfigurationType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "TopicARN", + "NotificationTypes" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "TopicARN":{ + "shape":"ResourceName", + "documentation":"

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

" + }, + "NotificationTypes":{ + "shape":"AutoScalingNotificationTypes", + "documentation":"

The type of event that causes the notification to be sent. For more information about notification types supported by Amazon EC2 Auto Scaling, see DescribeAutoScalingNotificationTypes.

" + } + } + }, + "PutScalingPolicyType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "PolicyName" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the policy.

" + }, + "PolicyType":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

" + }, + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

" + }, + "MinAdjustmentStep":{ + "shape":"MinAdjustmentStep", + "documentation":"

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

" + }, + "MinAdjustmentMagnitude":{ + "shape":"MinAdjustmentMagnitude", + "documentation":"

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

This property replaces the MinAdjustmentStep property. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is SimpleScaling or StepScaling.

" + }, + "ScalingAdjustment":{ + "shape":"PolicyIncrement", + "documentation":"

The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + }, + "Cooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + }, + "MetricAggregationType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Valid only if the policy type is StepScaling.

" + }, + "StepAdjustments":{ + "shape":"StepAdjustments", + "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + }, + "EstimatedInstanceWarmup":{ + "shape":"EstimatedInstanceWarmup", + "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

Valid only if the policy type is StepScaling or TargetTrackingScaling.

" + }, + "TargetTrackingConfiguration":{ + "shape":"TargetTrackingConfiguration", + "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + } + } + }, + "PutScheduledUpdateGroupActionType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "ScheduledActionName" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of this scaling action.

" + }, + "Time":{ + "shape":"TimestampType", + "documentation":"

This parameter is no longer used.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, \"2019-06-01T00:00:00Z\").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

" + }, + "Recurrence":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information about this format, see Crontab.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum number of instances in the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum number of instances in the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of EC2 instances that should be running in the Auto Scaling group.

" + } + } + }, + "RecordLifecycleActionHeartbeatAnswer":{ + "type":"structure", + "members":{ + } + }, + "RecordLifecycleActionHeartbeatType":{ + "type":"structure", + "required":[ + "LifecycleHookName", + "AutoScalingGroupName" + ], + "members":{ + "LifecycleHookName":{ + "shape":"AsciiStringMaxLen255", + "documentation":"

The name of the lifecycle hook.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LifecycleActionToken":{ + "shape":"LifecycleActionToken", + "documentation":"

A token that uniquely identifies a specific lifecycle action associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when you created the lifecycle hook.

" + }, + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + } + } + }, + "ResourceContentionFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

", + "error":{ + "code":"ResourceContention", + "httpStatusCode":500, + "senderFault":true + }, + "exception":true + }, + "ResourceInUseFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

The operation can't be performed because the resource is in use.

", + "error":{ + "code":"ResourceInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ResourceName":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "ScalingActivityInProgressFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"XmlStringMaxLen255", + "documentation":"

" + } + }, + "documentation":"

The operation can't be performed because there are scaling activities in progress.

", + "error":{ + "code":"ScalingActivityInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ScalingActivityStatusCode":{ + "type":"string", + "enum":[ + "PendingSpotBidPlacement", + "WaitingForSpotInstanceRequestId", + "WaitingForSpotInstanceId", + "WaitingForInstanceId", + "PreInService", + "InProgress", + "WaitingForELBConnectionDraining", + "MidLifecycleAction", + "WaitingForInstanceWarmup", + "Successful", + "Failed", + "Cancelled" + ] + }, + "ScalingPolicies":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingPolicy":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "PolicyName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the scaling policy.

" + }, + "PolicyARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the policy.

" + }, + "PolicyType":{ + "shape":"XmlStringMaxLen64", + "documentation":"

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

" + }, + "AdjustmentType":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" + }, + "MinAdjustmentStep":{ + "shape":"MinAdjustmentStep", + "documentation":"

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

" + }, + "MinAdjustmentMagnitude":{ + "shape":"MinAdjustmentMagnitude", + "documentation":"

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

" + }, + "ScalingAdjustment":{ + "shape":"PolicyIncrement", + "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

" + }, + "Cooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

" + }, + "StepAdjustments":{ + "shape":"StepAdjustments", + "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

" + }, + "MetricAggregationType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The aggregation type for the CloudWatch metrics. The valid values are Minimum, Maximum, and Average.

" + }, + "EstimatedInstanceWarmup":{ + "shape":"EstimatedInstanceWarmup", + "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

" + }, + "Alarms":{ + "shape":"Alarms", + "documentation":"

The CloudWatch alarms related to the policy.

" + }, + "TargetTrackingConfiguration":{ + "shape":"TargetTrackingConfiguration", + "documentation":"

A target tracking scaling policy.

" + } + }, + "documentation":"

Describes a scaling policy.

" + }, + "ScalingProcessQuery":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScalingProcesses":{ + "shape":"ProcessNames", + "documentation":"

One or more of the following processes. If you omit this parameter, all processes are specified.

  • Launch

  • Terminate

  • HealthCheck

  • ReplaceUnhealthy

  • AZRebalance

  • AlarmNotification

  • ScheduledActions

  • AddToLoadBalancer

" + } + } + }, + "ScheduledActionNames":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ScheduledActionsType":{ + "type":"structure", + "members":{ + "ScheduledUpdateGroupActions":{ + "shape":"ScheduledUpdateGroupActions", + "documentation":"

The scheduled actions.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "ScheduledUpdateGroupAction":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the scheduled action.

" + }, + "ScheduledActionARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the scheduled action.

" + }, + "Time":{ + "shape":"TimestampType", + "documentation":"

This parameter is no longer used.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The date and time in UTC for this action to start. For example, \"2019-06-01T00:00:00Z\".

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The date and time in UTC for the recurring schedule to end. For example, \"2019-06-01T00:00:00Z\".

" + }, + "Recurrence":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The recurring schedule for the action, in Unix cron syntax format.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum number of instances in the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum number of instances in the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of instances you prefer to maintain in the group.

" + } + }, + "documentation":"

Describes a scheduled scaling action. Used in response to DescribeScheduledActions.

" + }, + "ScheduledUpdateGroupActionRequest":{ + "type":"structure", + "required":["ScheduledActionName"], + "members":{ + "ScheduledActionName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the scaling action.

" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, \"2019-06-01T00:00:00Z\").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

" + }, + "Recurrence":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1 1,6,12 *\"). For more information about this format, see Crontab.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum number of instances in the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum number of instances in the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

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

" + } + }, + "documentation":"

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

" + }, + "ScheduledUpdateGroupActionRequests":{ + "type":"list", + "member":{"shape":"ScheduledUpdateGroupActionRequest"} + }, + "ScheduledUpdateGroupActions":{ + "type":"list", + "member":{"shape":"ScheduledUpdateGroupAction"} + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "ServiceLinkedRoleFailure":{ + "type":"structure", + "members":{ + "message":{"shape":"XmlStringMaxLen255"} + }, + "documentation":"

The service-linked role is not yet ready for use.

", + "error":{ + "code":"ServiceLinkedRoleFailure", + "httpStatusCode":500, + "senderFault":true + }, + "exception":true + }, + "SetDesiredCapacityType":{ + "type":"structure", + "required":[ + "AutoScalingGroupName", + "DesiredCapacity" + ], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of EC2 instances that should be running in the Auto Scaling group.

" + }, + "HonorCooldown":{ + "shape":"HonorCooldown", + "documentation":"

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

" + } + } + }, + "SetInstanceHealthQuery":{ + "type":"structure", + "required":[ + "InstanceId", + "HealthStatus" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + }, + "HealthStatus":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

" + }, + "ShouldRespectGracePeriod":{ + "shape":"ShouldRespectGracePeriod", + "documentation":"

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup.

" + } + } + }, + "SetInstanceProtectionAnswer":{ + "type":"structure", + "members":{ + } + }, + "SetInstanceProtectionQuery":{ + "type":"structure", + "required":[ + "InstanceIds", + "AutoScalingGroupName", + "ProtectedFromScaleIn" + ], + "members":{ + "InstanceIds":{ + "shape":"InstanceIds", + "documentation":"

One or more instance IDs.

" + }, + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "ProtectedFromScaleIn":{ + "shape":"ProtectedFromScaleIn", + "documentation":"

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

" + } + } + }, + "ShouldDecrementDesiredCapacity":{"type":"boolean"}, + "ShouldRespectGracePeriod":{"type":"boolean"}, + "SpotInstancePools":{"type":"integer"}, + "SpotPrice":{ + "type":"string", + "max":255, + "min":1 + }, + "StepAdjustment":{ + "type":"structure", + "required":["ScalingAdjustment"], + "members":{ + "MetricIntervalLowerBound":{ + "shape":"MetricScale", + "documentation":"

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

" + }, + "MetricIntervalUpperBound":{ + "shape":"MetricScale", + "documentation":"

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

" + }, + "ScalingAdjustment":{ + "shape":"PolicyIncrement", + "documentation":"

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity.

" + } + }, + "documentation":"

Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. Used in combination with PutScalingPolicy.

For the following examples, suppose that you have an alarm with a breach threshold of 50:

  • To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.

  • To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.

There are a few rules for the step adjustments for your step policy:

  • The ranges of your step adjustments can't overlap or have a gap.

  • At most, one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.

  • At most, one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.

  • The upper and lower bound can't be null in the same step adjustment.

" + }, + "StepAdjustments":{ + "type":"list", + "member":{"shape":"StepAdjustment"} + }, + "SuspendedProcess":{ + "type":"structure", + "members":{ + "ProcessName":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the suspended process.

" + }, + "SuspensionReason":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The reason that the process was suspended.

" + } + }, + "documentation":"

Describes an automatic scaling process that has been suspended. For more information, see ProcessType.

" + }, + "SuspendedProcesses":{ + "type":"list", + "member":{"shape":"SuspendedProcess"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "ResourceId":{ + "shape":"XmlString", + "documentation":"

The name of the group.

" + }, + "ResourceType":{ + "shape":"XmlString", + "documentation":"

The type of resource. The only supported value is auto-scaling-group.

" + }, + "Key":{ + "shape":"TagKey", + "documentation":"

The tag key.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The tag value.

" + }, + "PropagateAtLaunch":{ + "shape":"PropagateAtLaunch", + "documentation":"

Determines whether the tag is added to new instances as they are launched in the group.

" + } + }, + "documentation":"

Describes a tag for an Auto Scaling group.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"XmlString", + "documentation":"

The name of the group.

" + }, + "ResourceType":{ + "shape":"XmlString", + "documentation":"

The type of resource. The only supported value is auto-scaling-group.

" + }, + "Key":{ + "shape":"TagKey", + "documentation":"

The tag key.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The tag value.

" + }, + "PropagateAtLaunch":{ + "shape":"PropagateAtLaunch", + "documentation":"

Determines whether the tag is added to new instances as they are launched in the group.

" + } + }, + "documentation":"

Describes a tag for an Auto Scaling group.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{"shape":"TagDescription"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagsType":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

One or more tags.

" + }, + "NextToken":{ + "shape":"XmlString", + "documentation":"

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.

" + } + } + }, + "TargetGroupARNs":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen511"} + }, + "TargetTrackingConfiguration":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "PredefinedMetricSpecification":{ + "shape":"PredefinedMetricSpecification", + "documentation":"

A predefined metric. You must specify either a predefined metric or a customized metric.

" + }, + "CustomizedMetricSpecification":{ + "shape":"CustomizedMetricSpecification", + "documentation":"

A customized metric. You must specify either a predefined metric or a customized metric.

" + }, + "TargetValue":{ + "shape":"MetricScale", + "documentation":"

The target value for the metric.

" + }, + "DisableScaleIn":{ + "shape":"DisableScaleIn", + "documentation":"

Indicates whether scaling in by the target tracking scaling policy is disabled. If scaling in is disabled, the target tracking scaling policy doesn't remove instances from the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from the Auto Scaling group. The default is false.

" + } + }, + "documentation":"

Represents a target tracking scaling policy configuration to use with Amazon EC2 Auto Scaling.

" + }, + "TerminateInstanceInAutoScalingGroupType":{ + "type":"structure", + "required":[ + "InstanceId", + "ShouldDecrementDesiredCapacity" + ], + "members":{ + "InstanceId":{ + "shape":"XmlStringMaxLen19", + "documentation":"

The ID of the instance.

" + }, + "ShouldDecrementDesiredCapacity":{ + "shape":"ShouldDecrementDesiredCapacity", + "documentation":"

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

" + } + } + }, + "TerminationPolicies":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen1600"} + }, + "TimestampType":{"type":"timestamp"}, + "UpdateAutoScalingGroupType":{ + "type":"structure", + "required":["AutoScalingGroupName"], + "members":{ + "AutoScalingGroupName":{ + "shape":"ResourceName", + "documentation":"

The name of the Auto Scaling group.

" + }, + "LaunchConfigurationName":{ + "shape":"ResourceName", + "documentation":"

The name of the launch configuration. If you specify LaunchConfigurationName in your update request, you can't specify LaunchTemplate or MixedInstancesPolicy.

To update an Auto Scaling group with a launch configuration with InstanceMonitoring set to false, you must first disable the collection of group metrics. Otherwise, you get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template and version to use to specify the updates. If you specify LaunchTemplate in your update request, you can't specify LaunchConfigurationName or MixedInstancesPolicy.

For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API Reference.

" + }, + "MixedInstancesPolicy":{ + "shape":"MixedInstancesPolicy", + "documentation":"

An embedded object that specifies a mixed instances policy.

In your call to UpdateAutoScalingGroup, you can make changes to the policy that is specified. All optional parameters are left unchanged if not specified.

For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User Guide.

" + }, + "MinSize":{ + "shape":"AutoScalingGroupMinSize", + "documentation":"

The minimum size of the Auto Scaling group.

" + }, + "MaxSize":{ + "shape":"AutoScalingGroupMaxSize", + "documentation":"

The maximum size of the Auto Scaling group.

" + }, + "DesiredCapacity":{ + "shape":"AutoScalingGroupDesiredCapacity", + "documentation":"

The number of EC2 instances that should be running in the Auto Scaling group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.

" + }, + "DefaultCooldown":{ + "shape":"Cooldown", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified.

Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

One or more Availability Zones for the group.

" + }, + "HealthCheckType":{ + "shape":"XmlStringMaxLen32", + "documentation":"

The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

" + }, + "HealthCheckGracePeriod":{ + "shape":"HealthCheckGracePeriod", + "documentation":"

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service. The default value is 0.

For more information, see Health Check Grace Period in the Amazon EC2 Auto Scaling User Guide.

Conditional: This parameter is required if you are adding an ELB health check.

" + }, + "PlacementGroup":{ + "shape":"XmlStringMaxLen255", + "documentation":"

The name of the placement group into which to launch your instances, if any. A placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a placement group. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

" + }, + "VPCZoneIdentifier":{ + "shape":"XmlStringMaxLen2047", + "documentation":"

A comma-separated list of subnet IDs for virtual private cloud (VPC).

If you specify VPCZoneIdentifier with AvailabilityZones, the subnets that you specify for this parameter must reside in those Availability Zones.

" + }, + "TerminationPolicies":{ + "shape":"TerminationPolicies", + "documentation":"

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

For more information, see Controlling Which Instances Auto Scaling Terminates During Scale In in the Amazon EC2 Auto Scaling User Guide.

" + }, + "NewInstancesProtectedFromScaleIn":{ + "shape":"InstanceProtected", + "documentation":"

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

For more information about preventing instances from terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.

" + }, + "ServiceLinkedRoleARN":{ + "shape":"ResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. For more information, see Service-Linked Roles in the Amazon EC2 Auto Scaling User Guide.

" + } + } + }, + "Values":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "XmlString":{ + "type":"string", + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen1023":{ + "type":"string", + "max":1023, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen1600":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen19":{ + "type":"string", + "max":19, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen2047":{ + "type":"string", + "max":2047, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen255":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen32":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen511":{ + "type":"string", + "max":511, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen64":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringUserData":{ + "type":"string", + "max":21847, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + } + }, + "documentation":"Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.

For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.

" +} diff --git a/aws/dist/botocore/data/backup/2018-11-15/paginators-1.json b/aws/dist/botocore/data/backup/2018-11-15/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/backup/2018-11-15/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/backup/2018-11-15/service-2.json b/aws/dist/botocore/data/backup/2018-11-15/service-2.json new file mode 100644 index 00000000..54c4c0ca --- /dev/null +++ b/aws/dist/botocore/data/backup/2018-11-15/service-2.json @@ -0,0 +1,3148 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-11-15", + "endpointPrefix":"backup", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS Backup", + "serviceId":"Backup", + "signatureVersion":"v4", + "uid":"backup-2018-11-15" + }, + "operations":{ + "CreateBackupPlan":{ + "name":"CreateBackupPlan", + "http":{ + "method":"PUT", + "requestUri":"/backup/plans/" + }, + "input":{"shape":"CreateBackupPlanInput"}, + "output":{"shape":"CreateBackupPlanOutput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.

If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId is returned.

", + "idempotent":true + }, + "CreateBackupSelection":{ + "name":"CreateBackupSelection", + "http":{ + "method":"PUT", + "requestUri":"/backup/plans/{backupPlanId}/selections/" + }, + "input":{"shape":"CreateBackupSelectionInput"}, + "output":{"shape":"CreateBackupSelectionOutput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: \"arn:aws:ec2:region:account-id:volume/volume-id\"

  • ConditionKey:\"department\"

    ConditionValue:\"finance\"

    ConditionType:\"StringEquals\"

  • ConditionKey:\"importance\"

    ConditionValue:\"critical\"

    ConditionType:\"StringEquals\"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as \"department=finance\", \"importance=critical\", in addition to an EBS volume with the specified volume Id.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically 'put together using the OR operator. In other words, all patterns that match are selected for backup.

", + "idempotent":true + }, + "CreateBackupVault":{ + "name":"CreateBackupVault", + "http":{ + "method":"PUT", + "requestUri":"/backup-vaults/{backupVaultName}" + }, + "input":{"shape":"CreateBackupVaultInput"}, + "output":{"shape":"CreateBackupVaultOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Sensitive data, such as passport numbers, should not be included the name of a backup vault.

", + "idempotent":true + }, + "DeleteBackupPlan":{ + "name":"DeleteBackupPlan", + "http":{ + "method":"DELETE", + "requestUri":"/backup/plans/{backupPlanId}" + }, + "input":{"shape":"DeleteBackupPlanInput"}, + "output":{"shape":"DeleteBackupPlanOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

" + }, + "DeleteBackupSelection":{ + "name":"DeleteBackupSelection", + "http":{ + "method":"DELETE", + "requestUri":"/backup/plans/{backupPlanId}/selections/{selectionId}" + }, + "input":{"shape":"DeleteBackupSelectionInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

" + }, + "DeleteBackupVault":{ + "name":"DeleteBackupVault", + "http":{ + "method":"DELETE", + "requestUri":"/backup-vaults/{backupVaultName}" + }, + "input":{"shape":"DeleteBackupVaultInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

" + }, + "DeleteBackupVaultAccessPolicy":{ + "name":"DeleteBackupVaultAccessPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/backup-vaults/{backupVaultName}/access-policy" + }, + "input":{"shape":"DeleteBackupVaultAccessPolicyInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the policy document that manages permissions on a backup vault.

", + "idempotent":true + }, + "DeleteBackupVaultNotifications":{ + "name":"DeleteBackupVaultNotifications", + "http":{ + "method":"DELETE", + "requestUri":"/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input":{"shape":"DeleteBackupVaultNotificationsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes event notifications for the specified backup vault.

", + "idempotent":true + }, + "DeleteRecoveryPoint":{ + "name":"DeleteRecoveryPoint", + "http":{ + "method":"DELETE", + "requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input":{"shape":"DeleteRecoveryPointInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes the recovery point specified by a recovery point ID.

", + "idempotent":true + }, + "DescribeBackupJob":{ + "name":"DescribeBackupJob", + "http":{ + "method":"GET", + "requestUri":"/backup-jobs/{backupJobId}" + }, + "input":{"shape":"DescribeBackupJobInput"}, + "output":{"shape":"DescribeBackupJobOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

Returns metadata associated with creating a backup of a resource.

", + "idempotent":true + }, + "DescribeBackupVault":{ + "name":"DescribeBackupVault", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}" + }, + "input":{"shape":"DescribeBackupVaultInput"}, + "output":{"shape":"DescribeBackupVaultOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns metadata about a backup vault specified by its name.

", + "idempotent":true + }, + "DescribeProtectedResource":{ + "name":"DescribeProtectedResource", + "http":{ + "method":"GET", + "requestUri":"/resources/{resourceArn}" + }, + "input":{"shape":"DescribeProtectedResourceInput"}, + "output":{"shape":"DescribeProtectedResourceOutput"}, + "errors":[ + {"shape":"MissingParameterValueException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a saved resource, including the last time it was backed-up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

", + "idempotent":true + }, + "DescribeRecoveryPoint":{ + "name":"DescribeRecoveryPoint", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input":{"shape":"DescribeRecoveryPointInput"}, + "output":{"shape":"DescribeRecoveryPointOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

", + "idempotent":true + }, + "DescribeRestoreJob":{ + "name":"DescribeRestoreJob", + "http":{ + "method":"GET", + "requestUri":"/restore-jobs/{restoreJobId}" + }, + "input":{"shape":"DescribeRestoreJobInput"}, + "output":{"shape":"DescribeRestoreJobOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DependencyFailureException"} + ], + "documentation":"

Returns metadata associated with a restore job that is specified by a job ID.

", + "idempotent":true + }, + "ExportBackupPlanTemplate":{ + "name":"ExportBackupPlanTemplate", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/{backupPlanId}/toTemplate/" + }, + "input":{"shape":"ExportBackupPlanTemplateInput"}, + "output":{"shape":"ExportBackupPlanTemplateOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns the backup plan that is specified by the plan ID as a backup template.

" + }, + "GetBackupPlan":{ + "name":"GetBackupPlan", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/{backupPlanId}/" + }, + "input":{"shape":"GetBackupPlanInput"}, + "output":{"shape":"GetBackupPlanOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns the body of a backup plan in JSON format, in addition to plan metadata.

", + "idempotent":true + }, + "GetBackupPlanFromJSON":{ + "name":"GetBackupPlanFromJSON", + "http":{ + "method":"POST", + "requestUri":"/backup/template/json/toPlan" + }, + "input":{"shape":"GetBackupPlanFromJSONInput"}, + "output":{"shape":"GetBackupPlanFromJSONOutput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns a valid JSON document specifying a backup plan or an error.

" + }, + "GetBackupPlanFromTemplate":{ + "name":"GetBackupPlanFromTemplate", + "http":{ + "method":"GET", + "requestUri":"/backup/template/plans/{templateId}/toPlan" + }, + "input":{"shape":"GetBackupPlanFromTemplateInput"}, + "output":{"shape":"GetBackupPlanFromTemplateOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns the template specified by its templateId as a backup plan.

" + }, + "GetBackupSelection":{ + "name":"GetBackupSelection", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/{backupPlanId}/selections/{selectionId}" + }, + "input":{"shape":"GetBackupSelectionInput"}, + "output":{"shape":"GetBackupSelectionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

", + "idempotent":true + }, + "GetBackupVaultAccessPolicy":{ + "name":"GetBackupVaultAccessPolicy", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}/access-policy" + }, + "input":{"shape":"GetBackupVaultAccessPolicyInput"}, + "output":{"shape":"GetBackupVaultAccessPolicyOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns the access policy document that is associated with the named backup vault.

", + "idempotent":true + }, + "GetBackupVaultNotifications":{ + "name":"GetBackupVaultNotifications", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input":{"shape":"GetBackupVaultNotificationsInput"}, + "output":{"shape":"GetBackupVaultNotificationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns event notifications for the specified backup vault.

", + "idempotent":true + }, + "GetRecoveryPointRestoreMetadata":{ + "name":"GetRecoveryPointRestoreMetadata", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/restore-metadata" + }, + "input":{"shape":"GetRecoveryPointRestoreMetadataInput"}, + "output":{"shape":"GetRecoveryPointRestoreMetadataOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.

These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored.

", + "idempotent":true + }, + "GetSupportedResourceTypes":{ + "name":"GetSupportedResourceTypes", + "http":{ + "method":"GET", + "requestUri":"/supported-resource-types" + }, + "output":{"shape":"GetSupportedResourceTypesOutput"}, + "errors":[ + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns the AWS resource types supported by AWS Backup.

" + }, + "ListBackupJobs":{ + "name":"ListBackupJobs", + "http":{ + "method":"GET", + "requestUri":"/backup-jobs/" + }, + "input":{"shape":"ListBackupJobsInput"}, + "output":{"shape":"ListBackupJobsOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns metadata about your backup jobs.

", + "idempotent":true + }, + "ListBackupPlanTemplates":{ + "name":"ListBackupPlanTemplates", + "http":{ + "method":"GET", + "requestUri":"/backup/template/plans" + }, + "input":{"shape":"ListBackupPlanTemplatesInput"}, + "output":{"shape":"ListBackupPlanTemplatesOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

" + }, + "ListBackupPlanVersions":{ + "name":"ListBackupPlanVersions", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/{backupPlanId}/versions/" + }, + "input":{"shape":"ListBackupPlanVersionsInput"}, + "output":{"shape":"ListBackupPlanVersionsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

", + "idempotent":true + }, + "ListBackupPlans":{ + "name":"ListBackupPlans", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/" + }, + "input":{"shape":"ListBackupPlansInput"}, + "output":{"shape":"ListBackupPlansOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns metadata of your saved backup plans, including Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

", + "idempotent":true + }, + "ListBackupSelections":{ + "name":"ListBackupSelections", + "http":{ + "method":"GET", + "requestUri":"/backup/plans/{backupPlanId}/selections/" + }, + "input":{"shape":"ListBackupSelectionsInput"}, + "output":{"shape":"ListBackupSelectionsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns an array containing metadata of the resources associated with the target backup plan.

", + "idempotent":true + }, + "ListBackupVaults":{ + "name":"ListBackupVaults", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/" + }, + "input":{"shape":"ListBackupVaultsInput"}, + "output":{"shape":"ListBackupVaultsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns a list of recovery point storage containers along with information about them.

", + "idempotent":true + }, + "ListProtectedResources":{ + "name":"ListProtectedResources", + "http":{ + "method":"GET", + "requestUri":"/resources/" + }, + "input":{"shape":"ListProtectedResourcesInput"}, + "output":{"shape":"ListProtectedResourcesOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

", + "idempotent":true + }, + "ListRecoveryPointsByBackupVault":{ + "name":"ListRecoveryPointsByBackupVault", + "http":{ + "method":"GET", + "requestUri":"/backup-vaults/{backupVaultName}/recovery-points/" + }, + "input":{"shape":"ListRecoveryPointsByBackupVaultInput"}, + "output":{"shape":"ListRecoveryPointsByBackupVaultOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns detailed information about the recovery points stored in a backup vault.

", + "idempotent":true + }, + "ListRecoveryPointsByResource":{ + "name":"ListRecoveryPointsByResource", + "http":{ + "method":"GET", + "requestUri":"/resources/{resourceArn}/recovery-points/" + }, + "input":{"shape":"ListRecoveryPointsByResourceInput"}, + "output":{"shape":"ListRecoveryPointsByResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

", + "idempotent":true + }, + "ListRestoreJobs":{ + "name":"ListRestoreJobs", + "http":{ + "method":"GET", + "requestUri":"/restore-jobs/" + }, + "input":{"shape":"ListRestoreJobsInput"}, + "output":{"shape":"ListRestoreJobsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

", + "idempotent":true + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}/" + }, + "input":{"shape":"ListTagsInput"}, + "output":{"shape":"ListTagsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

", + "idempotent":true + }, + "PutBackupVaultAccessPolicy":{ + "name":"PutBackupVaultAccessPolicy", + "http":{ + "method":"PUT", + "requestUri":"/backup-vaults/{backupVaultName}/access-policy" + }, + "input":{"shape":"PutBackupVaultAccessPolicyInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

", + "idempotent":true + }, + "PutBackupVaultNotifications":{ + "name":"PutBackupVaultNotifications", + "http":{ + "method":"PUT", + "requestUri":"/backup-vaults/{backupVaultName}/notification-configuration" + }, + "input":{"shape":"PutBackupVaultNotificationsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Turns on notifications on a backup vault for the specified topic and events.

", + "idempotent":true + }, + "StartBackupJob":{ + "name":"StartBackupJob", + "http":{ + "method":"PUT", + "requestUri":"/backup-jobs" + }, + "input":{"shape":"StartBackupJobInput"}, + "output":{"shape":"StartBackupJobOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Starts a job to create a one-time backup of the specified resource.

", + "idempotent":true + }, + "StartRestoreJob":{ + "name":"StartRestoreJob", + "http":{ + "method":"PUT", + "requestUri":"/restore-jobs" + }, + "input":{"shape":"StartRestoreJobInput"}, + "output":{"shape":"StartRestoreJobOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Recovers the saved resource identified by an Amazon Resource Name (ARN).

If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.

", + "idempotent":true + }, + "StopBackupJob":{ + "name":"StopBackupJob", + "http":{ + "method":"POST", + "requestUri":"/backup-jobs/{backupJobId}" + }, + "input":{"shape":"StopBackupJobInput"}, + "errors":[ + {"shape":"MissingParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Attempts to cancel a job to create a one-time backup of a resource.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/untag/{resourceArn}" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

", + "idempotent":true + }, + "UpdateBackupPlan":{ + "name":"UpdateBackupPlan", + "http":{ + "method":"POST", + "requestUri":"/backup/plans/{backupPlanId}" + }, + "input":{"shape":"UpdateBackupPlanInput"}, + "output":{"shape":"UpdateBackupPlanOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Replaces the body of a saved backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

", + "idempotent":true + }, + "UpdateRecoveryPointLifecycle":{ + "name":"UpdateRecoveryPointLifecycle", + "http":{ + "method":"POST", + "requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}" + }, + "input":{"shape":"UpdateRecoveryPointLifecycleInput"}, + "output":{"shape":"UpdateRecoveryPointLifecycleOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

", + "idempotent":true + } + }, + "shapes":{ + "ARN":{"type":"string"}, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

" + }, + "Arn":{ + "shape":"string", + "documentation":"

" + }, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

The required resource already exists.

", + "exception":true + }, + "BackupJob":{ + "type":"structure", + "members":{ + "BackupJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

" + }, + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "State":{ + "shape":"BackupJobState", + "documentation":"

The current state of a resource recovery point.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A detailed message explaining the status of the job to back up a resource.

" + }, + "PercentDone":{ + "shape":"string", + "documentation":"

Contains an estimated percentage complete of a job at the time the job status was queried.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of a backup.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "CreatedBy":{ + "shape":"RecoveryPointCreator", + "documentation":"

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

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

The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + }, + "BytesTransferred":{ + "shape":"Long", + "documentation":"

The size in bytes transferred to a backup vault at the time that the job status was queried.

" + } + }, + "documentation":"

Contains detailed information about a backup job.

" + }, + "BackupJobState":{ + "type":"string", + "enum":[ + "CREATED", + "PENDING", + "RUNNING", + "ABORTING", + "ABORTED", + "COMPLETED", + "FAILED", + "EXPIRED" + ] + }, + "BackupJobsList":{ + "type":"list", + "member":{"shape":"BackupJob"} + }, + "BackupPlan":{ + "type":"structure", + "required":[ + "BackupPlanName", + "Rules" + ], + "members":{ + "BackupPlanName":{ + "shape":"BackupPlanName", + "documentation":"

The display name of a backup plan.

" + }, + "Rules":{ + "shape":"BackupRules", + "documentation":"

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

" + } + }, + "documentation":"

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

" + }, + "BackupPlanInput":{ + "type":"structure", + "required":[ + "BackupPlanName", + "Rules" + ], + "members":{ + "BackupPlanName":{ + "shape":"BackupPlanName", + "documentation":"

The display name of a backup plan.

" + }, + "Rules":{ + "shape":"BackupRulesInput", + "documentation":"

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

" + } + }, + "documentation":"

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

" + }, + "BackupPlanName":{"type":"string"}, + "BackupPlanTemplatesList":{ + "type":"list", + "member":{"shape":"BackupPlanTemplatesListMember"} + }, + "BackupPlanTemplatesListMember":{ + "type":"structure", + "members":{ + "BackupPlanTemplateId":{ + "shape":"string", + "documentation":"

Uniquely identifies a stored backup plan template.

" + }, + "BackupPlanTemplateName":{ + "shape":"string", + "documentation":"

The optional display name of a backup plan template.

" + } + }, + "documentation":"

An object specifying metadata associated with a backup plan template.

" + }, + "BackupPlanVersionsList":{ + "type":"list", + "member":{"shape":"BackupPlansListMember"} + }, + "BackupPlansList":{ + "type":"list", + "member":{"shape":"BackupPlansListMember"} + }, + "BackupPlansListMember":{ + "type":"structure", + "members":{ + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + }, + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

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

The date and time a resource backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

" + }, + "BackupPlanName":{ + "shape":"BackupPlanName", + "documentation":"

The display name of a saved backup plan.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

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

The last time a job to back up resources was executed with this rule. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "documentation":"

Contains metadata about a backup plan.

" + }, + "BackupRule":{ + "type":"structure", + "required":[ + "RuleName", + "TargetBackupVaultName" + ], + "members":{ + "RuleName":{ + "shape":"BackupRuleName", + "documentation":"

An optional display name for a backup rule.

" + }, + "TargetBackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "ScheduleExpression":{ + "shape":"CronExpression", + "documentation":"

A CRON expression specifying when AWS Backup initiates a backup job.

" + }, + "StartWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

An optional value that specifies a period of time in minutes after a backup is scheduled before a job is canceled if it doesn't start successfully.

" + }, + "CompletionWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

A value in minutes after a backup job is successfully started before it must be completed or it is canceled by AWS Backup. This value is optional.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "RecoveryPointTags":{ + "shape":"Tags", + "documentation":"

An array of key-value pair strings that are assigned to resources that are associated with this rule when restored from backup.

" + }, + "RuleId":{ + "shape":"string", + "documentation":"

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

" + } + }, + "documentation":"

Specifies a scheduled task used to back up a selection of resources.

" + }, + "BackupRuleInput":{ + "type":"structure", + "required":[ + "RuleName", + "TargetBackupVaultName" + ], + "members":{ + "RuleName":{ + "shape":"BackupRuleName", + "documentation":"

>An optional display name for a backup rule.

" + }, + "TargetBackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "ScheduleExpression":{ + "shape":"CronExpression", + "documentation":"

A CRON expression specifying when AWS Backup initiates a backup job.

" + }, + "StartWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

The amount of time in minutes before beginning a backup.

" + }, + "CompletionWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days”. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "RecoveryPointTags":{ + "shape":"Tags", + "documentation":"

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

" + } + }, + "documentation":"

Specifies a scheduled task used to back up a selection of resources.

" + }, + "BackupRuleName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + }, + "BackupRules":{ + "type":"list", + "member":{"shape":"BackupRule"} + }, + "BackupRulesInput":{ + "type":"list", + "member":{"shape":"BackupRuleInput"} + }, + "BackupSelection":{ + "type":"structure", + "required":[ + "SelectionName", + "IamRoleArn" + ], + "members":{ + "SelectionName":{ + "shape":"BackupSelectionName", + "documentation":"

The display name of a resource selection document.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

The ARN of the IAM role that AWS Backup uses to authenticate when restoring the target resource; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "Resources":{ + "shape":"ResourceArns", + "documentation":"

An array of strings that either contain Amazon Resource Names (ARNs) or match patterns such as \"arn:aws:ec2:us-east-1:123456789012:volume/*\" of resources to assign to a backup plan.

" + }, + "ListOfTags":{ + "shape":"ListOfTags", + "documentation":"

An array of conditions used to specify a set of resources to assign to a backup plan; for example, \"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\".

" + } + }, + "documentation":"

Used to specify a set of resources to a backup plan.

" + }, + "BackupSelectionName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + }, + "BackupSelectionsList":{ + "type":"list", + "member":{"shape":"BackupSelectionsListMember"} + }, + "BackupSelectionsListMember":{ + "type":"structure", + "members":{ + "SelectionId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to assign a set of resources to a backup plan.

" + }, + "SelectionName":{ + "shape":"BackupSelectionName", + "documentation":"

The display name of a resource selection document.

" + }, + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

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

The date and time a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + } + }, + "documentation":"

Contains metadata about a BackupSelection object.

" + }, + "BackupVaultEvent":{ + "type":"string", + "enum":[ + "BACKUP_JOB_STARTED", + "BACKUP_JOB_COMPLETED", + "RESTORE_JOB_STARTED", + "RESTORE_JOB_COMPLETED", + "RECOVERY_POINT_MODIFIED", + "BACKUP_PLAN_CREATED", + "BACKUP_PLAN_MODIFIED" + ] + }, + "BackupVaultEvents":{ + "type":"list", + "member":{"shape":"BackupVaultEvent"} + }, + "BackupVaultList":{ + "type":"list", + "member":{"shape":"BackupVaultListMember"} + }, + "BackupVaultListMember":{ + "type":"structure", + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

The date and time a resource backup is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + }, + "NumberOfRecoveryPoints":{ + "shape":"long", + "documentation":"

The number of recovery points that are stored in a backup vault.

" + } + }, + "documentation":"

Contains metadata about a backup vault.

" + }, + "BackupVaultName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + }, + "Boolean":{"type":"boolean"}, + "CalculatedLifecycle":{ + "type":"structure", + "members":{ + "MoveToColdStorageAt":{ + "shape":"timestamp", + "documentation":"

A timestamp that specifies when to transition a recovery point to cold storage.

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

A timestamp that specifies when to delete a recovery point.

" + } + }, + "documentation":"

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "Condition":{ + "type":"structure", + "required":[ + "ConditionType", + "ConditionKey", + "ConditionValue" + ], + "members":{ + "ConditionType":{ + "shape":"ConditionType", + "documentation":"

An operation, such as StringEquals, that is applied to a key-value pair used to filter resources in a selection.

" + }, + "ConditionKey":{ + "shape":"ConditionKey", + "documentation":"

The key in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"ec2:ResourceTag/Department\" is the key.

" + }, + "ConditionValue":{ + "shape":"ConditionValue", + "documentation":"

The value in a key-value pair. For example, in \"ec2:ResourceTag/Department\": \"accounting\", \"accounting\" is the value.

" + } + }, + "documentation":"

Contains an array of triplets made up of a condition type (such as StringEquals), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.

" + }, + "ConditionKey":{"type":"string"}, + "ConditionType":{ + "type":"string", + "enum":["STRINGEQUALS"] + }, + "ConditionValue":{"type":"string"}, + "CreateBackupPlanInput":{ + "type":"structure", + "required":["BackupPlan"], + "members":{ + "BackupPlan":{ + "shape":"BackupPlanInput", + "documentation":"

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" + }, + "BackupPlanTags":{ + "shape":"Tags", + "documentation":"

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair. The specified tags are assigned to all backups created with this plan.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

Identifies the request and allows failed requests to be retried without the risk of executing the operation twice. If the request includes a CreatorRequestId that matches an existing backup plan, that plan is returned. This parameter is optional.

" + } + } + }, + "CreateBackupPlanOutput":{ + "type":"structure", + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

" + }, + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

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

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1024 bytes long. They cannot be edited.

" + } + } + }, + "CreateBackupSelectionInput":{ + "type":"structure", + "required":[ + "BackupPlanId", + "BackupSelection" + ], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies the backup plan to be associated with the selection of resources.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "BackupSelection":{ + "shape":"BackupSelection", + "documentation":"

Specifies the body of a request to assign a set of resources to a backup plan.

It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service the resource belongs to, and an optional array of tags used to identify a set of resources.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + } + } + }, + "CreateBackupSelectionOutput":{ + "type":"structure", + "members":{ + "SelectionId":{ + "shape":"string", + "documentation":"

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

" + }, + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

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

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "CreateBackupVaultInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "BackupVaultTags":{ + "shape":"Tags", + "documentation":"

Metadata that you can assign to help organize the resources that you create. Each tag is a key-value pair.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + } + } + }, + "CreateBackupVaultOutput":{ + "type":"structure", + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

The date and time a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "CronExpression":{"type":"string"}, + "DeleteBackupPlanInput":{ + "type":"structure", + "required":["BackupPlanId"], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + } + } + }, + "DeleteBackupPlanOutput":{ + "type":"structure", + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

" + }, + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

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

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

" + } + } + }, + "DeleteBackupSelectionInput":{ + "type":"structure", + "required":[ + "BackupPlanId", + "SelectionId" + ], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "SelectionId":{ + "shape":"string", + "documentation":"

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

", + "location":"uri", + "locationName":"selectionId" + } + } + }, + "DeleteBackupVaultAccessPolicyInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "DeleteBackupVaultInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"string", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and theAWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "DeleteBackupVaultNotificationsInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "DeleteRecoveryPointInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "RecoveryPointArn" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "location":"uri", + "locationName":"recoveryPointArn" + } + } + }, + "DependencyFailureException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.

", + "exception":true, + "fault":true + }, + "DescribeBackupJobInput":{ + "type":"structure", + "required":["BackupJobId"], + "members":{ + "BackupJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

", + "location":"uri", + "locationName":"backupJobId" + } + } + }, + "DescribeBackupJobOutput":{ + "type":"structure", + "members":{ + "BackupJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

" + }, + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

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

The date and time that a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "State":{ + "shape":"BackupJobState", + "documentation":"

The current state of a resource recovery point.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A detailed message explaining the status of the job to back up a resource.

" + }, + "PercentDone":{ + "shape":"string", + "documentation":"

Contains an estimated percentage that is complete of a job at the time the job status was queried.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of a backup.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "CreatedBy":{ + "shape":"RecoveryPointCreator", + "documentation":"

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

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

The type of AWS resource to be backed-up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + }, + "BytesTransferred":{ + "shape":"Long", + "documentation":"

The size in bytes transferred to a backup vault at the time that the job status was queried.

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

The date and time that a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on the date specified. The value of StartBy is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "DescribeBackupVaultInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"string", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "DescribeBackupVaultOutput":{ + "type":"structure", + "members":{ + "BackupVaultName":{ + "shape":"string", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

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

The date and time that a backup vault is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + }, + "NumberOfRecoveryPoints":{ + "shape":"long", + "documentation":"

The number of recovery points that are stored in a backup vault.

" + } + } + }, + "DescribeProtectedResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "DescribeProtectedResourceOutput":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

The type of AWS resource saved as a recovery point; for example, an EBS volume or an Amazon RDS database.

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

The date and time that a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "DescribeRecoveryPointInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "RecoveryPointArn" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "location":"uri", + "locationName":"recoveryPointArn" + } + } + }, + "DescribeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + }, + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

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

The type of AWS resource to save as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + }, + "CreatedBy":{ + "shape":"RecoveryPointCreator", + "documentation":"

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan used to create it.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "Status":{ + "shape":"RecoveryPointStatus", + "documentation":"

A status code specifying the state of the recovery point.

A partial status indicates that the recovery point was not successfully re-created and must be retried.

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

The date and time that a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time that a job to create a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of a backup.

" + }, + "CalculatedLifecycle":{ + "shape":"CalculatedLifecycle", + "documentation":"

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups that are transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + }, + "IsEncrypted":{ + "shape":"boolean", + "documentation":"

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

Specifies the storage class of the recovery point. Valid values are WARM or COLD.

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

The date and time that a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "DescribeRestoreJobInput":{ + "type":"structure", + "required":["RestoreJobId"], + "members":{ + "RestoreJobId":{ + "shape":"RestoreJobId", + "documentation":"

Uniquely identifies the job that restores a recovery point.

", + "location":"uri", + "locationName":"restoreJobId" + } + } + }, + "DescribeRestoreJobOutput":{ + "type":"structure", + "members":{ + "RestoreJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies the job that restores a recovery point.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

The date and time that a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time that a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "Status":{ + "shape":"RestoreJobStatus", + "documentation":"

Status code specifying the state of the job that is initiated by AWS Backup to restore a recovery point.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A detailed message explaining the status of a job to restore a recovery point.

" + }, + "PercentDone":{ + "shape":"string", + "documentation":"

Contains an estimated percentage that is complete of a job at the time the job status was queried.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the restored resource.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "ExpectedCompletionTimeMinutes":{ + "shape":"Long", + "documentation":"

The amount of time in minutes that a job restoring a recovery point is expected to take.

" + }, + "CreatedResourceArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

" + } + } + }, + "ExportBackupPlanTemplateInput":{ + "type":"structure", + "required":["BackupPlanId"], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + } + } + }, + "ExportBackupPlanTemplateOutput":{ + "type":"structure", + "members":{ + "BackupPlanTemplateJson":{ + "shape":"string", + "documentation":"

The body of a backup plan template in JSON format.

This is a signed JSON document that cannot be modified before being passed to GetBackupPlanFromJSON.

" + } + } + }, + "GetBackupPlanFromJSONInput":{ + "type":"structure", + "required":["BackupPlanTemplateJson"], + "members":{ + "BackupPlanTemplateJson":{ + "shape":"string", + "documentation":"

A customer-supplied backup plan document in JSON format.

" + } + } + }, + "GetBackupPlanFromJSONOutput":{ + "type":"structure", + "members":{ + "BackupPlan":{ + "shape":"BackupPlan", + "documentation":"

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" + } + } + }, + "GetBackupPlanFromTemplateInput":{ + "type":"structure", + "required":["BackupPlanTemplateId"], + "members":{ + "BackupPlanTemplateId":{ + "shape":"string", + "documentation":"

Uniquely identifies a stored backup plan template.

", + "location":"uri", + "locationName":"templateId" + } + } + }, + "GetBackupPlanFromTemplateOutput":{ + "type":"structure", + "members":{ + "BackupPlanDocument":{ + "shape":"BackupPlan", + "documentation":"

Returns the body of a backup plan based on the target template, including the name, rules, and backup vault of the plan.

" + } + } + }, + "GetBackupPlanInput":{ + "type":"structure", + "required":["BackupPlanId"], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

", + "location":"querystring", + "locationName":"versionId" + } + } + }, + "GetBackupPlanOutput":{ + "type":"structure", + "members":{ + "BackupPlan":{ + "shape":"BackupPlan", + "documentation":"

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" + }, + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

" + }, + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

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

The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The last time a job to back up resources was executed with this backup plan. A date and time, in Unix format and Coordinated Universal Time (UTC). The value of LastExecutionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "GetBackupSelectionInput":{ + "type":"structure", + "required":[ + "BackupPlanId", + "SelectionId" + ], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "SelectionId":{ + "shape":"string", + "documentation":"

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

", + "location":"uri", + "locationName":"selectionId" + } + } + }, + "GetBackupSelectionOutput":{ + "type":"structure", + "members":{ + "BackupSelection":{ + "shape":"BackupSelection", + "documentation":"

Specifies the body of a request to assign a set of resources to a backup plan.

It includes an array of resources, an optional array of patterns to exclude resources, an optional role to provide access to the AWS service that the resource belongs to, and an optional array of tags used to identify a set of resources.

" + }, + "SelectionId":{ + "shape":"string", + "documentation":"

Uniquely identifies the body of a request to assign a set of resources to a backup plan.

" + }, + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

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

The date and time a backup selection is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "CreatorRequestId":{ + "shape":"string", + "documentation":"

A unique string that identifies the request and allows failed requests to be retried without the risk of executing the operation twice.

" + } + } + }, + "GetBackupVaultAccessPolicyInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "GetBackupVaultAccessPolicyOutput":{ + "type":"structure", + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "Policy":{ + "shape":"IAMPolicy", + "documentation":"

The backup vault access policy document in JSON format.

" + } + } + }, + "GetBackupVaultNotificationsInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + } + } + }, + "GetBackupVaultNotificationsOutput":{ + "type":"structure", + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "SNSTopicArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.

" + }, + "BackupVaultEvents":{ + "shape":"BackupVaultEvents", + "documentation":"

An array of events that indicate the status of jobs to back up resources to the backup vault.

" + } + } + }, + "GetRecoveryPointRestoreMetadataInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "RecoveryPointArn" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "location":"uri", + "locationName":"recoveryPointArn" + } + } + }, + "GetRecoveryPointRestoreMetadataOutput":{ + "type":"structure", + "members":{ + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + }, + "RestoreMetadata":{ + "shape":"Metadata", + "documentation":"

A set of metadata key-value pairs that lists the metadata key-value pairs that are required to restore the recovery point.

" + } + } + }, + "GetSupportedResourceTypesOutput":{ + "type":"structure", + "members":{ + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

Contains a string with the supported AWS resource types:

  • EBS for Amazon Elastic Block Store

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

" + } + } + }, + "IAMPolicy":{"type":"string"}, + "IAMRoleArn":{"type":"string"}, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

", + "exception":true + }, + "Lifecycle":{ + "type":"structure", + "members":{ + "MoveToColdStorageAfterDays":{ + "shape":"Long", + "documentation":"

Specifies the number of days after creation that a recovery point is moved to cold storage.

" + }, + "DeleteAfterDays":{ + "shape":"Long", + "documentation":"

Specifies the number of days after creation that a recovery point is deleted. Must be greater than MoveToColdStorageAfterDays.

" + } + }, + "documentation":"

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

", + "exception":true + }, + "ListBackupJobsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + }, + "ByResourceArn":{ + "shape":"ARN", + "documentation":"

Returns only backup jobs that match the specified resource Amazon Resource Name (ARN).

", + "location":"querystring", + "locationName":"resourceArn" + }, + "ByState":{ + "shape":"BackupJobState", + "documentation":"

Returns only backup jobs that are in the specified state.

", + "location":"querystring", + "locationName":"state" + }, + "ByBackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

Returns only backup jobs that will be stored in the specified backup vault. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"querystring", + "locationName":"backupVaultName" + }, + "ByCreatedBefore":{ + "shape":"timestamp", + "documentation":"

Returns only backup jobs that were created before the specified date.

", + "location":"querystring", + "locationName":"createdBefore" + }, + "ByCreatedAfter":{ + "shape":"timestamp", + "documentation":"

Returns only backup jobs that were created after the specified date.

", + "location":"querystring", + "locationName":"createdAfter" + }, + "ByResourceType":{ + "shape":"ResourceType", + "documentation":"

Returns only backup jobs for the specified resources:

  • EBS for Amazon Elastic Block Store

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

", + "location":"querystring", + "locationName":"resourceType" + } + } + }, + "ListBackupJobsOutput":{ + "type":"structure", + "members":{ + "BackupJobs":{ + "shape":"BackupJobsList", + "documentation":"

An array of structures containing metadata about your backup jobs returned in JSON format.

" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + } + } + }, + "ListBackupPlanTemplatesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListBackupPlanTemplatesOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "BackupPlanTemplatesList":{ + "shape":"BackupPlanTemplatesList", + "documentation":"

An array of template list items containing metadata about your saved templates.

" + } + } + }, + "ListBackupPlanVersionsInput":{ + "type":"structure", + "required":["BackupPlanId"], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListBackupPlanVersionsOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "BackupPlanVersionsList":{ + "shape":"BackupPlanVersionsList", + "documentation":"

An array of version list items containing metadata about your backup plans.

" + } + } + }, + "ListBackupPlansInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + }, + "IncludeDeleted":{ + "shape":"Boolean", + "documentation":"

A Boolean value with a default value of FALSE that returns deleted backup plans when set to TRUE.

", + "location":"querystring", + "locationName":"includeDeleted" + } + } + }, + "ListBackupPlansOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "BackupPlansList":{ + "shape":"BackupPlansList", + "documentation":"

An array of backup plan list items containing metadata about your saved backup plans.

" + } + } + }, + "ListBackupSelectionsInput":{ + "type":"structure", + "required":["BackupPlanId"], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListBackupSelectionsOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "BackupSelectionsList":{ + "shape":"BackupSelectionsList", + "documentation":"

An array of backup selection list items containing metadata about each resource in the list.

" + } + } + }, + "ListBackupVaultsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListBackupVaultsOutput":{ + "type":"structure", + "members":{ + "BackupVaultList":{ + "shape":"BackupVaultList", + "documentation":"

An array of backup vault list members containing vault metadata, including Amazon Resource Name (ARN), display name, creation date, number of saved recovery points, and encryption information if the resources saved in the backup vault are encrypted.

" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + } + } + }, + "ListOfTags":{ + "type":"list", + "member":{"shape":"Condition"} + }, + "ListProtectedResourcesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListProtectedResourcesOutput":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"ProtectedResourcesList", + "documentation":"

An array of resources successfully backed up by AWS Backup including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + } + } + }, + "ListRecoveryPointsByBackupVaultInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + }, + "ByResourceArn":{ + "shape":"ARN", + "documentation":"

Returns only recovery points that match the specified resource Amazon Resource Name (ARN).

", + "location":"querystring", + "locationName":"resourceArn" + }, + "ByResourceType":{ + "shape":"ResourceType", + "documentation":"

Returns only recovery points that match the specified resource type.

", + "location":"querystring", + "locationName":"resourceType" + }, + "ByBackupPlanId":{ + "shape":"string", + "documentation":"

Returns only recovery points that match the specified backup plan ID.

", + "location":"querystring", + "locationName":"backupPlanId" + }, + "ByCreatedBefore":{ + "shape":"timestamp", + "documentation":"

Returns only recovery points that were created before the specified timestamp.

", + "location":"querystring", + "locationName":"createdBefore" + }, + "ByCreatedAfter":{ + "shape":"timestamp", + "documentation":"

Returns only recovery points that were created after the specified timestamp.

", + "location":"querystring", + "locationName":"createdAfter" + } + } + }, + "ListRecoveryPointsByBackupVaultOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "RecoveryPoints":{ + "shape":"RecoveryPointByBackupVaultList", + "documentation":"

An array of objects that contain detailed information about recovery points saved in a backup vault.

" + } + } + }, + "ListRecoveryPointsByResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

", + "location":"uri", + "locationName":"resourceArn" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRecoveryPointsByResourceOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "RecoveryPoints":{ + "shape":"RecoveryPointByResourceList", + "documentation":"

An array of objects that contain detailed information about recovery points of the specified resource type.

" + } + } + }, + "ListRestoreJobsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRestoreJobsOutput":{ + "type":"structure", + "members":{ + "RestoreJobs":{ + "shape":"RestoreJobsList", + "documentation":"

An array of objects that contain detailed information about jobs to restore saved resources.

" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + } + } + }, + "ListTagsInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the type of resource. Valid targets for ListTags are recovery points, backup plans, and backup vaults.

", + "location":"uri", + "locationName":"resourceArn" + }, + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to be returned.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListTagsOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"string", + "documentation":"

The next item following a partial list of returned items. For example, if a request is made to return maxResults number of items, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

To help organize your resources, you can assign your own metadata to the resources you create. Each tag is a key-value pair.

" + } + } + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Metadata":{ + "type":"map", + "key":{"shape":"MetadataKey"}, + "value":{"shape":"MetadataValue"} + }, + "MetadataKey":{"type":"string"}, + "MetadataValue":{"type":"string"}, + "MissingParameterValueException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

Indicates that a required parameter is missing.

", + "exception":true + }, + "ProtectedResource":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

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

The date and time a resource was last backed up, in Unix format and Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "documentation":"

A structure that contains information about a backed-up resource.

" + }, + "ProtectedResourcesList":{ + "type":"list", + "member":{"shape":"ProtectedResource"} + }, + "PutBackupVaultAccessPolicyInput":{ + "type":"structure", + "required":["BackupVaultName"], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "Policy":{ + "shape":"IAMPolicy", + "documentation":"

The backup vault access policy document in JSON format.

" + } + } + }, + "PutBackupVaultNotificationsInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "SNSTopicArn", + "BackupVaultEvents" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "SNSTopicArn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.

" + }, + "BackupVaultEvents":{ + "shape":"BackupVaultEvents", + "documentation":"

An array of events that indicate the status of jobs to back up resources to the backup vault.

" + } + } + }, + "RecoveryPointByBackupVault":{ + "type":"structure", + "members":{ + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + }, + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + }, + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

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

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

The type of AWS resource saved as a recovery point; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" + }, + "CreatedBy":{ + "shape":"RecoveryPointCreator", + "documentation":"

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "Status":{ + "shape":"RecoveryPointStatus", + "documentation":"

A status code specifying the state of the recovery point.

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

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of a backup.

" + }, + "CalculatedLifecycle":{ + "shape":"CalculatedLifecycle", + "documentation":"

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + }, + "IsEncrypted":{ + "shape":"boolean", + "documentation":"

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

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

The date and time a recovery point was last restored, in Unix format and Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + }, + "documentation":"

Contains detailed information about the recovery points stored in a backup vault.

" + }, + "RecoveryPointByBackupVaultList":{ + "type":"list", + "member":{"shape":"RecoveryPointByBackupVault"} + }, + "RecoveryPointByResource":{ + "type":"structure", + "members":{ + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

The date and time a recovery point is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "Status":{ + "shape":"RecoveryPointStatus", + "documentation":"

A status code specifying the state of the recovery point.

" + }, + "EncryptionKeyArn":{ + "shape":"ARN", + "documentation":"

The server-side encryption key that is used to protect your backups; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

" + }, + "BackupSizeBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of a backup.

" + }, + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

" + } + }, + "documentation":"

Contains detailed information about a saved recovery point.

" + }, + "RecoveryPointByResourceList":{ + "type":"list", + "member":{"shape":"RecoveryPointByResource"} + }, + "RecoveryPointCreator":{ + "type":"structure", + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

" + }, + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

" + }, + "BackupPlanVersion":{ + "shape":"string", + "documentation":"

Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. They cannot be edited.

" + }, + "BackupRuleId":{ + "shape":"string", + "documentation":"

Uniquely identifies a rule used to schedule the backup of a selection of resources.

" + } + }, + "documentation":"

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

" + }, + "RecoveryPointStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "PARTIAL", + "DELETING", + "EXPIRED" + ] + }, + "ResourceArns":{ + "type":"list", + "member":{"shape":"ARN"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

A resource that is required for the action doesn't exist.

", + "exception":true + }, + "ResourceType":{ + "type":"string", + "pattern":"^[a-zA-Z0-9\\-\\_\\.]{1,50}$" + }, + "ResourceTypes":{ + "type":"list", + "member":{"shape":"ResourceType"} + }, + "RestoreJobId":{"type":"string"}, + "RestoreJobStatus":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "COMPLETED", + "ABORTED", + "FAILED" + ] + }, + "RestoreJobsList":{ + "type":"list", + "member":{"shape":"RestoreJobsListMember"} + }, + "RestoreJobsListMember":{ + "type":"structure", + "members":{ + "RestoreJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies the job that restores a recovery point.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

The date and time a restore job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

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

The date and time a job to restore a recovery point is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "Status":{ + "shape":"RestoreJobStatus", + "documentation":"

A status code specifying the state of the job initiated by AWS Backup to restore a recovery point.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A detailed message explaining the status of the job to restore a recovery point.

" + }, + "PercentDone":{ + "shape":"string", + "documentation":"

Contains an estimated percentage complete of a job at the time the job status was queried.

" + }, + "BackupSizeInBytes":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the restored resource.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "ExpectedCompletionTimeMinutes":{ + "shape":"Long", + "documentation":"

The amount of time in minutes that a job restoring a recovery point is expected to take.

" + }, + "CreatedResourceArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" + } + }, + "documentation":"

Contains metadata about a restore job.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Code":{"shape":"string"}, + "Message":{"shape":"string"}, + "Type":{ + "shape":"string", + "documentation":"

" + }, + "Context":{ + "shape":"string", + "documentation":"

" + } + }, + "documentation":"

The request failed due to a temporary failure of the server.

", + "exception":true, + "fault":true + }, + "StartBackupJobInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "ResourceArn", + "IamRoleArn" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "IdempotencyToken":{ + "shape":"string", + "documentation":"

A customer chosen string that can be used to distinguish between calls to StartBackupJob. Idempotency tokens time out after one hour. Therefore, if you call StartBackupJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one backup job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple backups.

" + }, + "StartWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

The amount of time in minutes before beginning a backup.

" + }, + "CompleteWindowMinutes":{ + "shape":"WindowMinutes", + "documentation":"

The amount of time AWS Backup attempts a backup before canceling the job and returning an error.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup will transition and expire backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "RecoveryPointTags":{ + "shape":"Tags", + "documentation":"

To help organize your resources, you can assign your own metadata to the resources that you create. Each tag is a key-value pair.

" + } + } + }, + "StartBackupJobOutput":{ + "type":"structure", + "members":{ + "BackupJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

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

The date and time that a backup job is started, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + } + } + }, + "StartRestoreJobInput":{ + "type":"structure", + "required":[ + "RecoveryPointArn", + "Metadata", + "IamRoleArn" + ], + "members":{ + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

A set of metadata key-value pairs. Lists the metadata that the recovery point was created with.

" + }, + "IamRoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

" + }, + "IdempotencyToken":{ + "shape":"string", + "documentation":"

A customer chosen string that can be used to distinguish between calls to StartRestoreJob. Idempotency tokens time out after one hour. Therefore, if you call StartRestoreJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores.

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

Starts a job to restore a recovery point for one of the following resources:

  • EBS for Amazon Elastic Block Store

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

" + } + } + }, + "StartRestoreJobOutput":{ + "type":"structure", + "members":{ + "RestoreJobId":{ + "shape":"RestoreJobId", + "documentation":"

Uniquely identifies the job that restores a recovery point.

" + } + } + }, + "StopBackupJobInput":{ + "type":"structure", + "required":["BackupJobId"], + "members":{ + "BackupJobId":{ + "shape":"string", + "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

", + "location":"uri", + "locationName":"backupJobId" + } + } + }, + "StorageClass":{ + "type":"string", + "enum":[ + "WARM", + "COLD", + "DELETED" + ] + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"string"}, + "sensitive":true + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.

" + } + } + }, + "TagValue":{"type":"string"}, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "sensitive":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeyList" + ], + "members":{ + "ResourceArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a resource. The format of the ARN depends on the type of the tagged resource.

", + "location":"uri", + "locationName":"resourceArn" + }, + "TagKeyList":{ + "shape":"TagKeyList", + "documentation":"

A list of keys to identify which key-value tags to remove from a resource.

" + } + } + }, + "UpdateBackupPlanInput":{ + "type":"structure", + "required":[ + "BackupPlanId", + "BackupPlan" + ], + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

", + "location":"uri", + "locationName":"backupPlanId" + }, + "BackupPlan":{ + "shape":"BackupPlanInput", + "documentation":"

Specifies the body of a backup plan. Includes a BackupPlanName and one or more sets of Rules.

" + } + } + }, + "UpdateBackupPlanOutput":{ + "type":"structure", + "members":{ + "BackupPlanId":{ + "shape":"string", + "documentation":"

Uniquely identifies a backup plan.

" + }, + "BackupPlanArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example, arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.

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

The date and time a backup plan is updated, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + }, + "VersionId":{ + "shape":"string", + "documentation":"

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version Ids cannot be edited.

" + } + } + }, + "UpdateRecoveryPointLifecycleInput":{ + "type":"structure", + "required":[ + "BackupVaultName", + "RecoveryPointArn" + ], + "members":{ + "BackupVaultName":{ + "shape":"BackupVaultName", + "documentation":"

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "location":"uri", + "locationName":"backupVaultName" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

", + "location":"uri", + "locationName":"recoveryPointArn" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + } + } + }, + "UpdateRecoveryPointLifecycleOutput":{ + "type":"structure", + "members":{ + "BackupVaultArn":{ + "shape":"ARN", + "documentation":"

An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

" + }, + "RecoveryPointArn":{ + "shape":"ARN", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

" + }, + "Lifecycle":{ + "shape":"Lifecycle", + "documentation":"

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

" + }, + "CalculatedLifecycle":{ + "shape":"CalculatedLifecycle", + "documentation":"

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" + } + } + }, + "WindowMinutes":{"type":"long"}, + "boolean":{"type":"boolean"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"AWS Backup

AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

" +} diff --git a/aws/dist/botocore/data/batch/2016-08-10/examples-1.json b/aws/dist/botocore/data/batch/2016-08-10/examples-1.json new file mode 100644 index 00000000..ddaaf42d --- /dev/null +++ b/aws/dist/botocore/data/batch/2016-08-10/examples-1.json @@ -0,0 +1,589 @@ +{ + "version": "1.0", + "examples": { + "CancelJob": [ + { + "input": { + "jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4", + "reason": "Cancelling job." + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels a job with the specified job ID.", + "id": "to-cancel-a-job-1481152314733", + "title": "To cancel a job" + } + ], + "CreateComputeEnvironment": [ + { + "input": { + "type": "MANAGED", + "computeEnvironmentName": "C4OnDemand", + "computeResources": { + "type": "EC2", + "desiredvCpus": 48, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - C4OnDemand" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "computeEnvironmentName": "C4OnDemand" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.", + "id": "to-create-a-managed-ec2-compute-environment-1481152600017", + "title": "To create a managed EC2 compute environment" + }, + { + "input": { + "type": "MANAGED", + "computeEnvironmentName": "M4Spot", + "computeResources": { + "type": "SPOT", + "bidPercentage": 20, + "desiredvCpus": 4, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "m4" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - M4Spot" + } + }, + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot", + "computeEnvironmentName": "M4Spot" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.", + "id": "to-create-a-managed-ec2-spot-compute-environment-1481152844190", + "title": "To create a managed EC2 Spot compute environment" + } + ], + "CreateJobQueue": [ + { + "input": { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "M4Spot", + "order": 1 + } + ], + "jobQueueName": "LowPriority", + "priority": 10, + "state": "ENABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority", + "jobQueueName": "LowPriority" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.", + "id": "to-create-a-job-queue-with-a-single-compute-environment-1481152967946", + "title": "To create a job queue with a single compute environment" + }, + { + "input": { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "C4OnDemand", + "order": 1 + }, + { + "computeEnvironment": "M4Spot", + "order": 2 + } + ], + "jobQueueName": "HighPriority", + "priority": 1, + "state": "ENABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.", + "id": "to-create-a-job-queue-with-multiple-compute-environments-1481153027051", + "title": "To create a job queue with multiple compute environments" + } + ], + "DeleteComputeEnvironment": [ + { + "input": { + "computeEnvironment": "P2OnDemand" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the P2OnDemand compute environment.", + "id": "to-delete-a-compute-environment-1481153105644", + "title": "To delete a compute environment" + } + ], + "DeleteJobQueue": [ + { + "input": { + "jobQueue": "GPGPU" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the GPGPU job queue.", + "id": "to-delete-a-job-queue-1481153508134", + "title": "To delete a job queue" + } + ], + "DeregisterJobDefinition": [ + { + "input": { + "jobDefinition": "sleep10" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a job definition called sleep10.", + "id": "to-deregister-a-job-definition-1481153579565", + "title": "To deregister a job definition" + } + ], + "DescribeComputeEnvironments": [ + { + "input": { + "computeEnvironments": [ + "P2OnDemand" + ] + }, + "output": { + "computeEnvironments": [ + { + "type": "MANAGED", + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeEnvironmentName": "P2OnDemand", + "computeResources": { + "type": "EC2", + "desiredvCpus": 48, + "ec2KeyPair": "id_rsa", + "instanceRole": "ecsInstanceRole", + "instanceTypes": [ + "p2" + ], + "maxvCpus": 128, + "minvCpus": 0, + "securityGroupIds": [ + "sg-cf5093b2" + ], + "subnets": [ + "subnet-220c0e0a", + "subnet-1a95556d", + "subnet-978f6dce" + ], + "tags": { + "Name": "Batch Instance - P2OnDemand" + } + }, + "ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc", + "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole", + "state": "ENABLED", + "status": "VALID", + "statusReason": "ComputeEnvironment Healthy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the P2OnDemand compute environment.", + "id": "to-describe-a-compute-environment-1481153713334", + "title": "To describe a compute environment" + } + ], + "DescribeJobDefinitions": [ + { + "input": { + "status": "ACTIVE" + }, + "output": { + "jobDefinitions": [ + { + "type": "container", + "containerProperties": { + "command": [ + "sleep", + "60" + ], + "environment": [ + + ], + "image": "busybox", + "memory": 128, + "mountPoints": [ + + ], + "ulimits": [ + + ], + "vcpus": 1, + "volumes": [ + + ] + }, + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1", + "jobDefinitionName": "sleep60", + "revision": 1, + "status": "ACTIVE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your active job definitions.", + "id": "to-describe-active-job-definitions-1481153895831", + "title": "To describe active job definitions" + } + ], + "DescribeJobQueues": [ + { + "input": { + "jobQueues": [ + "HighPriority" + ] + }, + "output": { + "jobQueues": [ + { + "computeEnvironmentOrder": [ + { + "computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand", + "order": 1 + } + ], + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "jobQueueName": "HighPriority", + "priority": 1, + "state": "ENABLED", + "status": "VALID", + "statusReason": "JobQueue Healthy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the HighPriority job queue.", + "id": "to-describe-a-job-queue-1481153995804", + "title": "To describe a job queue" + } + ], + "DescribeJobs": [ + { + "input": { + "jobs": [ + "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9" + ] + }, + "output": { + "jobs": [ + { + "container": { + "command": [ + "sleep", + "60" + ], + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c", + "environment": [ + + ], + "exitCode": 0, + "image": "busybox", + "memory": 128, + "mountPoints": [ + + ], + "ulimits": [ + + ], + "vcpus": 1, + "volumes": [ + + ] + }, + "createdAt": 1480460782010, + "dependsOn": [ + + ], + "jobDefinition": "sleep60", + "jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9", + "jobName": "example", + "jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority", + "parameters": { + }, + "startedAt": 1480460816500, + "status": "SUCCEEDED", + "stoppedAt": 1480460880699 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a job with the specified job ID.", + "id": "to-describe-a-specific-job-1481154090490", + "title": "To describe a specific job" + } + ], + "ListJobs": [ + { + "input": { + "jobQueue": "HighPriority" + }, + "output": { + "jobSummaryList": [ + { + "jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb", + "jobName": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the running jobs in the HighPriority job queue.", + "id": "to-list-running-jobs-1481154202164", + "title": "To list running jobs" + }, + { + "input": { + "jobQueue": "HighPriority", + "jobStatus": "SUBMITTED" + }, + "output": { + "jobSummaryList": [ + { + "jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786", + "jobName": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.", + "id": "to-list-submitted-jobs-1481154251623", + "title": "To list submitted jobs" + } + ], + "RegisterJobDefinition": [ + { + "input": { + "type": "container", + "containerProperties": { + "command": [ + "sleep", + "10" + ], + "image": "busybox", + "memory": 128, + "vcpus": 1 + }, + "jobDefinitionName": "sleep10" + }, + "output": { + "jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1", + "jobDefinitionName": "sleep10", + "revision": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a job definition for a simple container job.", + "id": "to-register-a-job-definition-1481154325325", + "title": "To register a job definition" + } + ], + "SubmitJob": [ + { + "input": { + "jobDefinition": "sleep60", + "jobName": "example", + "jobQueue": "HighPriority" + }, + "output": { + "jobId": "876da822-4198-45f2-a252-6cea32512ea8", + "jobName": "example" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example submits a simple container job called example to the HighPriority job queue.", + "id": "to-submit-a-job-to-a-queue-1481154481673", + "title": "To submit a job to a queue" + } + ], + "TerminateJob": [ + { + "input": { + "jobId": "61e743ed-35e4-48da-b2de-5c8333821c84", + "reason": "Terminating job." + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example terminates a job with the specified job ID.", + "id": "to-terminate-a-job-1481154558276", + "title": "To terminate a job" + } + ], + "UpdateComputeEnvironment": [ + { + "input": { + "computeEnvironment": "P2OnDemand", + "state": "DISABLED" + }, + "output": { + "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand", + "computeEnvironmentName": "P2OnDemand" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables the P2OnDemand compute environment so it can be deleted.", + "id": "to-update-a-compute-environment-1481154702731", + "title": "To update a compute environment" + } + ], + "UpdateJobQueue": [ + { + "input": { + "jobQueue": "GPGPU", + "state": "DISABLED" + }, + "output": { + "jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU", + "jobQueueName": "GPGPU" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables a job queue so that it can be deleted.", + "id": "to-update-a-job-queue-1481154806981", + "title": "To update a job queue" + } + ] + } +} diff --git a/aws/dist/botocore/data/batch/2016-08-10/paginators-1.json b/aws/dist/botocore/data/batch/2016-08-10/paginators-1.json new file mode 100644 index 00000000..ca39096b --- /dev/null +++ b/aws/dist/botocore/data/batch/2016-08-10/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeComputeEnvironments": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "computeEnvironments" + }, + "DescribeJobDefinitions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobDefinitions" + }, + "DescribeJobQueues": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobQueues" + }, + "ListJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobSummaryList" + } + } +} diff --git a/aws/dist/botocore/data/batch/2016-08-10/service-2.json b/aws/dist/botocore/data/batch/2016-08-10/service-2.json new file mode 100644 index 00000000..a8f97a57 --- /dev/null +++ b/aws/dist/botocore/data/batch/2016-08-10/service-2.json @@ -0,0 +1,1963 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-08-10", + "endpointPrefix":"batch", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"AWS Batch", + "serviceFullName":"AWS Batch", + "serviceId":"Batch", + "signatureVersion":"v4", + "uid":"batch-2016-08-10" + }, + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"POST", + "requestUri":"/v1/canceljob" + }, + "input":{"shape":"CancelJobRequest"}, + "output":{"shape":"CancelJobResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation.

" + }, + "CreateComputeEnvironment":{ + "name":"CreateComputeEnvironment", + "http":{ + "method":"POST", + "requestUri":"/v1/createcomputeenvironment" + }, + "input":{"shape":"CreateComputeEnvironmentRequest"}, + "output":{"shape":"CreateComputeEnvironmentResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon Elastic Container Service Developer Guide.

AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the old compute environment from your job queue.

  4. Delete the old compute environment.

" + }, + "CreateJobQueue":{ + "name":"CreateJobQueue", + "http":{ + "method":"POST", + "requestUri":"/v1/createjobqueue" + }, + "input":{"shape":"CreateJobQueueRequest"}, + "output":{"shape":"CreateJobQueueResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

" + }, + "DeleteComputeEnvironment":{ + "name":"DeleteComputeEnvironment", + "http":{ + "method":"POST", + "requestUri":"/v1/deletecomputeenvironment" + }, + "input":{"shape":"DeleteComputeEnvironmentRequest"}, + "output":{"shape":"DeleteComputeEnvironmentResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Deletes an AWS Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

" + }, + "DeleteJobQueue":{ + "name":"DeleteJobQueue", + "http":{ + "method":"POST", + "requestUri":"/v1/deletejobqueue" + }, + "input":{"shape":"DeleteJobQueueRequest"}, + "output":{"shape":"DeleteJobQueueResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.

It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

" + }, + "DeregisterJobDefinition":{ + "name":"DeregisterJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/v1/deregisterjobdefinition" + }, + "input":{"shape":"DeregisterJobDefinitionRequest"}, + "output":{"shape":"DeregisterJobDefinitionResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Deregisters an AWS Batch job definition.

" + }, + "DescribeComputeEnvironments":{ + "name":"DescribeComputeEnvironments", + "http":{ + "method":"POST", + "requestUri":"/v1/describecomputeenvironments" + }, + "input":{"shape":"DescribeComputeEnvironmentsRequest"}, + "output":{"shape":"DescribeComputeEnvironmentsResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Describes one or more of your compute environments.

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

" + }, + "DescribeJobDefinitions":{ + "name":"DescribeJobDefinitions", + "http":{ + "method":"POST", + "requestUri":"/v1/describejobdefinitions" + }, + "input":{"shape":"DescribeJobDefinitionsRequest"}, + "output":{"shape":"DescribeJobDefinitionsResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

" + }, + "DescribeJobQueues":{ + "name":"DescribeJobQueues", + "http":{ + "method":"POST", + "requestUri":"/v1/describejobqueues" + }, + "input":{"shape":"DescribeJobQueuesRequest"}, + "output":{"shape":"DescribeJobQueuesResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Describes one or more of your job queues.

" + }, + "DescribeJobs":{ + "name":"DescribeJobs", + "http":{ + "method":"POST", + "requestUri":"/v1/describejobs" + }, + "input":{"shape":"DescribeJobsRequest"}, + "output":{"shape":"DescribeJobsResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Describes a list of AWS Batch jobs.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/v1/listjobs" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Returns a list of AWS Batch jobs.

You must specify only one of the following:

  • a job queue ID to return a list of jobs in that job queue

  • a multi-node parallel job ID to return a list of that job's nodes

  • an array job ID to return a list of that job's children

You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

" + }, + "RegisterJobDefinition":{ + "name":"RegisterJobDefinition", + "http":{ + "method":"POST", + "requestUri":"/v1/registerjobdefinition" + }, + "input":{"shape":"RegisterJobDefinitionRequest"}, + "output":{"shape":"RegisterJobDefinitionResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Registers an AWS Batch job definition.

" + }, + "SubmitJob":{ + "name":"SubmitJob", + "http":{ + "method":"POST", + "requestUri":"/v1/submitjob" + }, + "input":{"shape":"SubmitJobRequest"}, + "output":{"shape":"SubmitJobResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

" + }, + "TerminateJob":{ + "name":"TerminateJob", + "http":{ + "method":"POST", + "requestUri":"/v1/terminatejob" + }, + "input":{"shape":"TerminateJobRequest"}, + "output":{"shape":"TerminateJobResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

" + }, + "UpdateComputeEnvironment":{ + "name":"UpdateComputeEnvironment", + "http":{ + "method":"POST", + "requestUri":"/v1/updatecomputeenvironment" + }, + "input":{"shape":"UpdateComputeEnvironmentRequest"}, + "output":{"shape":"UpdateComputeEnvironmentResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Updates an AWS Batch compute environment.

" + }, + "UpdateJobQueue":{ + "name":"UpdateJobQueue", + "http":{ + "method":"POST", + "requestUri":"/v1/updatejobqueue" + }, + "input":{"shape":"UpdateJobQueueRequest"}, + "output":{"shape":"UpdateJobQueueResponse"}, + "errors":[ + {"shape":"ClientException"}, + {"shape":"ServerException"} + ], + "documentation":"

Updates a job queue.

" + } + }, + "shapes":{ + "ArrayJobDependency":{ + "type":"string", + "enum":[ + "N_TO_N", + "SEQUENTIAL" + ] + }, + "ArrayJobStatusSummary":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Integer"} + }, + "ArrayProperties":{ + "type":"structure", + "members":{ + "size":{ + "shape":"Integer", + "documentation":"

The size of the array job.

" + } + }, + "documentation":"

An object representing an AWS Batch array job.

" + }, + "ArrayPropertiesDetail":{ + "type":"structure", + "members":{ + "statusSummary":{ + "shape":"ArrayJobStatusSummary", + "documentation":"

A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.

" + }, + "size":{ + "shape":"Integer", + "documentation":"

The size of the array job. This parameter is returned for parent array jobs.

" + }, + "index":{ + "shape":"Integer", + "documentation":"

The job index within the array that is associated with this job. This parameter is returned for array job children.

" + } + }, + "documentation":"

An object representing the array properties of a job.

" + }, + "ArrayPropertiesSummary":{ + "type":"structure", + "members":{ + "size":{ + "shape":"Integer", + "documentation":"

The size of the array job. This parameter is returned for parent array jobs.

" + }, + "index":{ + "shape":"Integer", + "documentation":"

The job index within the array that is associated with this job. This parameter is returned for children of array jobs.

" + } + }, + "documentation":"

An object representing the array properties of a job.

" + }, + "AttemptContainerDetail":{ + "type":"structure", + "members":{ + "containerInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

" + }, + "taskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

" + }, + "exitCode":{ + "shape":"Integer", + "documentation":"

The exit code for the job attempt. A non-zero exit code is considered a failure.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" + }, + "logStreamName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

" + }, + "networkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

The network interfaces associated with the job attempt.

" + } + }, + "documentation":"

An object representing the details of a container that is part of a job attempt.

" + }, + "AttemptDetail":{ + "type":"structure", + "members":{ + "container":{ + "shape":"AttemptContainerDetail", + "documentation":"

Details about the container in this job attempt.

" + }, + "startedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

" + }, + "stoppedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

A short, human-readable string to provide additional details about the current status of the job attempt.

" + } + }, + "documentation":"

An object representing a job attempt.

" + }, + "AttemptDetails":{ + "type":"list", + "member":{"shape":"AttemptDetail"} + }, + "Boolean":{"type":"boolean"}, + "CEState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "CEStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "DELETED", + "VALID", + "INVALID" + ] + }, + "CEType":{ + "type":"string", + "enum":[ + "MANAGED", + "UNMANAGED" + ] + }, + "CRAllocationStrategy":{ + "type":"string", + "enum":[ + "BEST_FIT", + "BEST_FIT_PROGRESSIVE", + "SPOT_CAPACITY_OPTIMIZED" + ] + }, + "CRType":{ + "type":"string", + "enum":[ + "EC2", + "SPOT" + ] + }, + "CancelJobRequest":{ + "type":"structure", + "required":[ + "jobId", + "reason" + ], + "members":{ + "jobId":{ + "shape":"String", + "documentation":"

The AWS Batch job ID of the job to cancel.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

" + } + } + }, + "CancelJobResponse":{ + "type":"structure", + "members":{ + } + }, + "ClientException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ComputeEnvironmentDetail":{ + "type":"structure", + "required":[ + "computeEnvironmentName", + "computeEnvironmentArn", + "ecsClusterArn" + ], + "members":{ + "computeEnvironmentName":{ + "shape":"String", + "documentation":"

The name of the compute environment.

" + }, + "computeEnvironmentArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" + }, + "ecsClusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

" + }, + "type":{ + "shape":"CEType", + "documentation":"

The type of the compute environment.

" + }, + "state":{ + "shape":"CEState", + "documentation":"

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the AWS Batch scheduler does not attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state do not scale out. However, they scale in to minvCpus value after instances become idle.

" + }, + "status":{ + "shape":"CEStatus", + "documentation":"

The current status of the compute environment (for example, CREATING or VALID).

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

A short, human-readable string to provide additional details about the current status of the compute environment.

" + }, + "computeResources":{ + "shape":"ComputeResource", + "documentation":"

The compute resources defined for the compute environment.

" + }, + "serviceRole":{ + "shape":"String", + "documentation":"

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

" + } + }, + "documentation":"

An object representing an AWS Batch compute environment.

" + }, + "ComputeEnvironmentDetailList":{ + "type":"list", + "member":{"shape":"ComputeEnvironmentDetail"} + }, + "ComputeEnvironmentOrder":{ + "type":"structure", + "required":[ + "order", + "computeEnvironment" + ], + "members":{ + "order":{ + "shape":"Integer", + "documentation":"

The order of the compute environment.

" + }, + "computeEnvironment":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" + } + }, + "documentation":"

The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

" + }, + "ComputeEnvironmentOrders":{ + "type":"list", + "member":{"shape":"ComputeEnvironmentOrder"} + }, + "ComputeResource":{ + "type":"structure", + "required":[ + "type", + "minvCpus", + "maxvCpus", + "instanceTypes", + "subnets", + "instanceRole" + ], + "members":{ + "type":{ + "shape":"CRType", + "documentation":"

The type of compute environment: EC2 or SPOT.

" + }, + "allocationStrategy":{ + "shape":"CRAllocationStrategy", + "documentation":"

The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. BEST_FIT_PROGRESSIVE will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.

" + }, + "minvCpus":{ + "shape":"Integer", + "documentation":"

The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is DISABLED).

" + }, + "maxvCpus":{ + "shape":"Integer", + "documentation":"

The maximum number of Amazon EC2 vCPUs that an environment can reach.

" + }, + "desiredvCpus":{ + "shape":"Integer", + "documentation":"

The desired number of Amazon EC2 vCPUS in the compute environment.

" + }, + "instanceTypes":{ + "shape":"StringList", + "documentation":"

The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.

" + }, + "imageId":{ + "shape":"String", + "documentation":"

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

" + }, + "subnets":{ + "shape":"StringList", + "documentation":"

The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

" + }, + "securityGroupIds":{ + "shape":"StringList", + "documentation":"

The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.

" + }, + "ec2KeyPair":{ + "shape":"String", + "documentation":"

The Amazon EC2 key pair that is used for instances launched in the compute environment.

" + }, + "instanceRole":{ + "shape":"String", + "documentation":"

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide.

" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"

Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value—for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }.

" + }, + "placementGroup":{ + "shape":"String", + "documentation":"

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement Groups in the Amazon EC2 User Guide for Linux Instances.

" + }, + "bidPercentage":{ + "shape":"Integer", + "documentation":"

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.

" + }, + "spotIamFleetRole":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.

" + }, + "launchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch Template Support in the AWS Batch User Guide.

" + } + }, + "documentation":"

An object representing an AWS Batch compute resource.

" + }, + "ComputeResourceUpdate":{ + "type":"structure", + "members":{ + "minvCpus":{ + "shape":"Integer", + "documentation":"

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

" + }, + "maxvCpus":{ + "shape":"Integer", + "documentation":"

The maximum number of Amazon EC2 vCPUs that an environment can reach.

" + }, + "desiredvCpus":{ + "shape":"Integer", + "documentation":"

The desired number of Amazon EC2 vCPUS in the compute environment.

" + } + }, + "documentation":"

An object representing the attributes of a compute environment that can be updated.

" + }, + "ContainerDetail":{ + "type":"structure", + "members":{ + "image":{ + "shape":"String", + "documentation":"

The image used to start the container.

" + }, + "vcpus":{ + "shape":"Integer", + "documentation":"

The number of VCPUs allocated for the job.

" + }, + "memory":{ + "shape":"Integer", + "documentation":"

The number of MiB of memory reserved for the job.

" + }, + "command":{ + "shape":"StringList", + "documentation":"

The command that is passed to the container.

" + }, + "jobRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) associated with the job upon execution.

" + }, + "volumes":{ + "shape":"Volumes", + "documentation":"

A list of volumes associated with the job.

" + }, + "environment":{ + "shape":"EnvironmentVariables", + "documentation":"

The environment variables to pass to a container.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

" + }, + "mountPoints":{ + "shape":"MountPoints", + "documentation":"

The mount points for data volumes in your container.

" + }, + "readonlyRootFilesystem":{ + "shape":"Boolean", + "documentation":"

When this parameter is true, the container is given read-only access to its root file system.

" + }, + "ulimits":{ + "shape":"Ulimits", + "documentation":"

A list of ulimit values to set in the container.

" + }, + "privileged":{ + "shape":"Boolean", + "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).

" + }, + "user":{ + "shape":"String", + "documentation":"

The user name to use inside the container.

" + }, + "exitCode":{ + "shape":"Integer", + "documentation":"

The exit code to return upon completion.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" + }, + "containerInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the container instance on which the container is running.

" + }, + "taskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

" + }, + "logStreamName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

" + }, + "instanceType":{ + "shape":"String", + "documentation":"

The instance type of the underlying host infrastructure of a multi-node parallel job.

" + }, + "networkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

The network interfaces associated with the job.

" + }, + "resourceRequirements":{ + "shape":"ResourceRequirements", + "documentation":"

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

" + }, + "linuxParameters":{ + "shape":"LinuxParameters", + "documentation":"

Linux-specific modifications that are applied to the container, such as details for device mappings.

" + } + }, + "documentation":"

An object representing the details of a container that is part of a job.

" + }, + "ContainerOverrides":{ + "type":"structure", + "members":{ + "vcpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

" + }, + "memory":{ + "shape":"Integer", + "documentation":"

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

" + }, + "command":{ + "shape":"StringList", + "documentation":"

The command to send to the container that overrides the default command from the Docker image or the job definition.

" + }, + "instanceType":{ + "shape":"String", + "documentation":"

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

" + }, + "environment":{ + "shape":"EnvironmentVariables", + "documentation":"

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

" + }, + "resourceRequirements":{ + "shape":"ResourceRequirements", + "documentation":"

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

" + } + }, + "documentation":"

The overrides that should be sent to a container.

" + }, + "ContainerProperties":{ + "type":"structure", + "members":{ + "image":{ + "shape":"String", + "documentation":"

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

" + }, + "vcpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.

" + }, + "memory":{ + "shape":"Integer", + "documentation":"

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.

If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.

" + }, + "command":{ + "shape":"StringList", + "documentation":"

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

" + }, + "jobRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

" + }, + "volumes":{ + "shape":"Volumes", + "documentation":"

A list of data volumes used in a job.

" + }, + "environment":{ + "shape":"EnvironmentVariables", + "documentation":"

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

" + }, + "mountPoints":{ + "shape":"MountPoints", + "documentation":"

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

" + }, + "readonlyRootFilesystem":{ + "shape":"Boolean", + "documentation":"

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

" + }, + "privileged":{ + "shape":"Boolean", + "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

" + }, + "ulimits":{ + "shape":"Ulimits", + "documentation":"

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

" + }, + "user":{ + "shape":"String", + "documentation":"

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

" + }, + "instanceType":{ + "shape":"String", + "documentation":"

The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.

" + }, + "resourceRequirements":{ + "shape":"ResourceRequirements", + "documentation":"

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

" + }, + "linuxParameters":{ + "shape":"LinuxParameters", + "documentation":"

Linux-specific modifications that are applied to the container, such as details for device mappings.

" + } + }, + "documentation":"

Container properties are used in job definitions to describe the container that is launched as part of a job.

" + }, + "ContainerSummary":{ + "type":"structure", + "members":{ + "exitCode":{ + "shape":"Integer", + "documentation":"

The exit code to return upon completion.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" + } + }, + "documentation":"

An object representing summary details of a container within a job.

" + }, + "CreateComputeEnvironmentRequest":{ + "type":"structure", + "required":[ + "computeEnvironmentName", + "type", + "serviceRole" + ], + "members":{ + "computeEnvironmentName":{ + "shape":"String", + "documentation":"

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

" + }, + "type":{ + "shape":"CEType", + "documentation":"

The type of the compute environment. For more information, see Compute Environments in the AWS Batch User Guide.

" + }, + "state":{ + "shape":"CEState", + "documentation":"

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

" + }, + "computeResources":{ + "shape":"ComputeResource", + "documentation":"

Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the AWS Batch User Guide.

" + }, + "serviceRole":{ + "shape":"String", + "documentation":"

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

" + } + } + }, + "CreateComputeEnvironmentResponse":{ + "type":"structure", + "members":{ + "computeEnvironmentName":{ + "shape":"String", + "documentation":"

The name of the compute environment.

" + }, + "computeEnvironmentArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" + } + } + }, + "CreateJobQueueRequest":{ + "type":"structure", + "required":[ + "jobQueueName", + "priority", + "computeEnvironmentOrder" + ], + "members":{ + "jobQueueName":{ + "shape":"String", + "documentation":"

The name of the job queue.

" + }, + "state":{ + "shape":"JQState", + "documentation":"

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

" + }, + "priority":{ + "shape":"Integer", + "documentation":"

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

" + }, + "computeEnvironmentOrder":{ + "shape":"ComputeEnvironmentOrders", + "documentation":"

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue.

" + } + } + }, + "CreateJobQueueResponse":{ + "type":"structure", + "required":[ + "jobQueueName", + "jobQueueArn" + ], + "members":{ + "jobQueueName":{ + "shape":"String", + "documentation":"

The name of the job queue.

" + }, + "jobQueueArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" + } + } + }, + "DeleteComputeEnvironmentRequest":{ + "type":"structure", + "required":["computeEnvironment"], + "members":{ + "computeEnvironment":{ + "shape":"String", + "documentation":"

The name or Amazon Resource Name (ARN) of the compute environment to delete.

" + } + } + }, + "DeleteComputeEnvironmentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteJobQueueRequest":{ + "type":"structure", + "required":["jobQueue"], + "members":{ + "jobQueue":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the queue to delete.

" + } + } + }, + "DeleteJobQueueResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterJobDefinitionRequest":{ + "type":"structure", + "required":["jobDefinition"], + "members":{ + "jobDefinition":{ + "shape":"String", + "documentation":"

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

" + } + } + }, + "DeregisterJobDefinitionResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeComputeEnvironmentsRequest":{ + "type":"structure", + "members":{ + "computeEnvironments":{ + "shape":"StringList", + "documentation":"

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + } + } + }, + "DescribeComputeEnvironmentsResponse":{ + "type":"structure", + "members":{ + "computeEnvironments":{ + "shape":"ComputeEnvironmentDetailList", + "documentation":"

The list of compute environments.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeJobDefinitionsRequest":{ + "type":"structure", + "members":{ + "jobDefinitions":{ + "shape":"StringList", + "documentation":"

A list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

" + }, + "jobDefinitionName":{ + "shape":"String", + "documentation":"

The name of the job definition to describe.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status with which to filter job definitions.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + } + } + }, + "DescribeJobDefinitionsResponse":{ + "type":"structure", + "members":{ + "jobDefinitions":{ + "shape":"JobDefinitionList", + "documentation":"

The list of job definitions.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeJobQueuesRequest":{ + "type":"structure", + "members":{ + "jobQueues":{ + "shape":"StringList", + "documentation":"

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + } + } + }, + "DescribeJobQueuesResponse":{ + "type":"structure", + "members":{ + "jobQueues":{ + "shape":"JobQueueDetailList", + "documentation":"

The list of job queues.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeJobsRequest":{ + "type":"structure", + "required":["jobs"], + "members":{ + "jobs":{ + "shape":"StringList", + "documentation":"

A list of up to 100 job IDs.

" + } + } + }, + "DescribeJobsResponse":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"JobDetailList", + "documentation":"

The list of jobs.

" + } + } + }, + "Device":{ + "type":"structure", + "required":["hostPath"], + "members":{ + "hostPath":{ + "shape":"String", + "documentation":"

The path for the device on the host container instance.

" + }, + "containerPath":{ + "shape":"String", + "documentation":"

The path inside the container at which to expose the host device. By default the hostPath value is used.

" + }, + "permissions":{ + "shape":"DeviceCgroupPermissions", + "documentation":"

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

" + } + }, + "documentation":"

An object representing a container instance host device.

" + }, + "DeviceCgroupPermission":{ + "type":"string", + "enum":[ + "READ", + "WRITE", + "MKNOD" + ] + }, + "DeviceCgroupPermissions":{ + "type":"list", + "member":{"shape":"DeviceCgroupPermission"} + }, + "DevicesList":{ + "type":"list", + "member":{"shape":"Device"} + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "Host":{ + "type":"structure", + "members":{ + "sourcePath":{ + "shape":"String", + "documentation":"

The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

" + } + }, + "documentation":"

Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.

" + }, + "Integer":{"type":"integer"}, + "JQState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "JQStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "DELETED", + "VALID", + "INVALID" + ] + }, + "JobDefinition":{ + "type":"structure", + "required":[ + "jobDefinitionName", + "jobDefinitionArn", + "revision", + "type" + ], + "members":{ + "jobDefinitionName":{ + "shape":"String", + "documentation":"

The name of the job definition.

" + }, + "jobDefinitionArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the job definition.

" + }, + "revision":{ + "shape":"Integer", + "documentation":"

The revision of the job definition.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the job definition.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of job definition.

" + }, + "parameters":{ + "shape":"ParametersMap", + "documentation":"

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the AWS Batch User Guide.

" + }, + "retryStrategy":{ + "shape":"RetryStrategy", + "documentation":"

The retry strategy to use for failed jobs that are submitted with this job definition.

" + }, + "containerProperties":{ + "shape":"ContainerProperties", + "documentation":"

An object with various properties specific to container-based jobs.

" + }, + "timeout":{ + "shape":"JobTimeout", + "documentation":"

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

" + }, + "nodeProperties":{ + "shape":"NodeProperties", + "documentation":"

An object with various properties specific to multi-node parallel jobs.

" + } + }, + "documentation":"

An object representing an AWS Batch job definition.

" + }, + "JobDefinitionList":{ + "type":"list", + "member":{"shape":"JobDefinition"} + }, + "JobDefinitionType":{ + "type":"string", + "enum":[ + "container", + "multinode" + ] + }, + "JobDependency":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"String", + "documentation":"

The job ID of the AWS Batch job associated with this dependency.

" + }, + "type":{ + "shape":"ArrayJobDependency", + "documentation":"

The type of the job dependency.

" + } + }, + "documentation":"

An object representing an AWS Batch job dependency.

" + }, + "JobDependencyList":{ + "type":"list", + "member":{"shape":"JobDependency"} + }, + "JobDetail":{ + "type":"structure", + "required":[ + "jobName", + "jobId", + "jobQueue", + "status", + "startedAt", + "jobDefinition" + ], + "members":{ + "jobName":{ + "shape":"String", + "documentation":"

The name of the job.

" + }, + "jobId":{ + "shape":"String", + "documentation":"

The ID for the job.

" + }, + "jobQueue":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the job queue with which the job is associated.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

The current status for the job.

If your jobs do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.

" + }, + "attempts":{ + "shape":"AttemptDetails", + "documentation":"

A list of job attempts associated with this job.

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

A short, human-readable string to provide additional details about the current status of the job.

" + }, + "createdAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

" + }, + "retryStrategy":{ + "shape":"RetryStrategy", + "documentation":"

The retry strategy to use for this job if an attempt fails.

" + }, + "startedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

" + }, + "stoppedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + }, + "dependsOn":{ + "shape":"JobDependencyList", + "documentation":"

A list of job names or IDs on which this job depends.

" + }, + "jobDefinition":{ + "shape":"String", + "documentation":"

The job definition that is used by this job.

" + }, + "parameters":{ + "shape":"ParametersMap", + "documentation":"

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

" + }, + "container":{ + "shape":"ContainerDetail", + "documentation":"

An object representing the details of the container that is associated with the job.

" + }, + "nodeDetails":{ + "shape":"NodeDetails", + "documentation":"

An object representing the details of a node that is associated with a multi-node parallel job.

" + }, + "nodeProperties":{ + "shape":"NodeProperties", + "documentation":"

An object representing the node properties of a multi-node parallel job.

" + }, + "arrayProperties":{ + "shape":"ArrayPropertiesDetail", + "documentation":"

The array properties of the job, if it is an array job.

" + }, + "timeout":{ + "shape":"JobTimeout", + "documentation":"

The timeout configuration for the job.

" + } + }, + "documentation":"

An object representing an AWS Batch job.

" + }, + "JobDetailList":{ + "type":"list", + "member":{"shape":"JobDetail"} + }, + "JobQueueDetail":{ + "type":"structure", + "required":[ + "jobQueueName", + "jobQueueArn", + "state", + "priority", + "computeEnvironmentOrder" + ], + "members":{ + "jobQueueName":{ + "shape":"String", + "documentation":"

The name of the job queue.

" + }, + "jobQueueArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" + }, + "state":{ + "shape":"JQState", + "documentation":"

Describes the ability of the queue to accept new jobs.

" + }, + "status":{ + "shape":"JQStatus", + "documentation":"

The status of the job queue (for example, CREATING or VALID).

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

A short, human-readable string to provide additional details about the current status of the job queue.

" + }, + "priority":{ + "shape":"Integer", + "documentation":"

The priority of the job queue.

" + }, + "computeEnvironmentOrder":{ + "shape":"ComputeEnvironmentOrders", + "documentation":"

The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.

" + } + }, + "documentation":"

An object representing the details of an AWS Batch job queue.

" + }, + "JobQueueDetailList":{ + "type":"list", + "member":{"shape":"JobQueueDetail"} + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "PENDING", + "RUNNABLE", + "STARTING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ] + }, + "JobSummary":{ + "type":"structure", + "required":[ + "jobId", + "jobName" + ], + "members":{ + "jobId":{ + "shape":"String", + "documentation":"

The ID of the job.

" + }, + "jobName":{ + "shape":"String", + "documentation":"

The name of the job.

" + }, + "createdAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

The current status for the job.

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

A short, human-readable string to provide additional details about the current status of the job.

" + }, + "startedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).

" + }, + "stoppedAt":{ + "shape":"Long", + "documentation":"

The Unix timestamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

" + }, + "container":{ + "shape":"ContainerSummary", + "documentation":"

An object representing the details of the container that is associated with the job.

" + }, + "arrayProperties":{ + "shape":"ArrayPropertiesSummary", + "documentation":"

The array properties of the job, if it is an array job.

" + }, + "nodeProperties":{ + "shape":"NodePropertiesSummary", + "documentation":"

The node properties for a single node in a job summary list.

" + } + }, + "documentation":"

An object representing summary details of a job.

" + }, + "JobSummaryList":{ + "type":"list", + "member":{"shape":"JobSummary"} + }, + "JobTimeout":{ + "type":"structure", + "members":{ + "attemptDurationSeconds":{ + "shape":"Integer", + "documentation":"

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished.

" + } + }, + "documentation":"

An object representing a job timeout configuration.

" + }, + "KeyValuePair":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the key-value pair. For environment variables, this is the value of the environment variable.

" + } + }, + "documentation":"

A key-value pair object.

" + }, + "LaunchTemplateSpecification":{ + "type":"structure", + "members":{ + "launchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

" + }, + "launchTemplateName":{ + "shape":"String", + "documentation":"

The name of the launch template.

" + }, + "version":{ + "shape":"String", + "documentation":"

The version number of the launch template.

Default: The default version of the launch template.

" + } + }, + "documentation":"

An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

" + }, + "LinuxParameters":{ + "type":"structure", + "members":{ + "devices":{ + "shape":"DevicesList", + "documentation":"

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

" + } + }, + "documentation":"

Linux-specific modifications that are applied to the container, such as details for device mappings.

" + }, + "ListJobsRequest":{ + "type":"structure", + "members":{ + "jobQueue":{ + "shape":"String", + "documentation":"

The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.

" + }, + "arrayJobId":{ + "shape":"String", + "documentation":"

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

" + }, + "multiNodeJobId":{ + "shape":"String", + "documentation":"

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

" + }, + "jobStatus":{ + "shape":"JobStatus", + "documentation":"

The job status with which to filter jobs in the specified queue. If you do not specify a status, only RUNNING jobs are returned.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListJobs returns up to 100 results and a nextToken value if applicable.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + } + } + }, + "ListJobsResponse":{ + "type":"structure", + "required":["jobSummaryList"], + "members":{ + "jobSummaryList":{ + "shape":"JobSummaryList", + "documentation":"

A list of job summaries that match the request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "Long":{"type":"long"}, + "MountPoint":{ + "type":"structure", + "members":{ + "containerPath":{ + "shape":"String", + "documentation":"

The path on the container at which to mount the host volume.

" + }, + "readOnly":{ + "shape":"Boolean", + "documentation":"

If this value is true, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is false.

" + }, + "sourceVolume":{ + "shape":"String", + "documentation":"

The name of the volume to mount.

" + } + }, + "documentation":"

Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

" + }, + "MountPoints":{ + "type":"list", + "member":{"shape":"MountPoint"} + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "attachmentId":{ + "shape":"String", + "documentation":"

The attachment ID for the network interface.

" + }, + "ipv6Address":{ + "shape":"String", + "documentation":"

The private IPv6 address for the network interface.

" + }, + "privateIpv4Address":{ + "shape":"String", + "documentation":"

The private IPv4 address for the network interface.

" + } + }, + "documentation":"

An object representing the elastic network interface for a multi-node parallel job node.

" + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "NodeDetails":{ + "type":"structure", + "members":{ + "nodeIndex":{ + "shape":"Integer", + "documentation":"

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

" + }, + "isMainNode":{ + "shape":"Boolean", + "documentation":"

Specifies whether the current node is the main node for a multi-node parallel job.

" + } + }, + "documentation":"

An object representing the details of a multi-node parallel job node.

" + }, + "NodeOverrides":{ + "type":"structure", + "members":{ + "numNodes":{ + "shape":"Integer", + "documentation":"

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:

  • There must be at least one node range in your job definition that has an open upper boundary (such as : or n:).

  • The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

" + }, + "nodePropertyOverrides":{ + "shape":"NodePropertyOverrides", + "documentation":"

The node property overrides for the job.

" + } + }, + "documentation":"

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

" + }, + "NodeProperties":{ + "type":"structure", + "required":[ + "numNodes", + "mainNode", + "nodeRangeProperties" + ], + "members":{ + "numNodes":{ + "shape":"Integer", + "documentation":"

The number of nodes associated with a multi-node parallel job.

" + }, + "mainNode":{ + "shape":"Integer", + "documentation":"

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

" + }, + "nodeRangeProperties":{ + "shape":"NodeRangeProperties", + "documentation":"

A list of node ranges and their properties associated with a multi-node parallel job.

" + } + }, + "documentation":"

An object representing the node properties of a multi-node parallel job.

" + }, + "NodePropertiesSummary":{ + "type":"structure", + "members":{ + "isMainNode":{ + "shape":"Boolean", + "documentation":"

Specifies whether the current node is the main node for a multi-node parallel job.

" + }, + "numNodes":{ + "shape":"Integer", + "documentation":"

The number of nodes associated with a multi-node parallel job.

" + }, + "nodeIndex":{ + "shape":"Integer", + "documentation":"

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

" + } + }, + "documentation":"

An object representing the properties of a node that is associated with a multi-node parallel job.

" + }, + "NodePropertyOverride":{ + "type":"structure", + "required":["targetNodes"], + "members":{ + "targetNodes":{ + "shape":"String", + "documentation":"

The range of nodes, using node index values, with which to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.

" + }, + "containerOverrides":{ + "shape":"ContainerOverrides", + "documentation":"

The overrides that should be sent to a node range.

" + } + }, + "documentation":"

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

" + }, + "NodePropertyOverrides":{ + "type":"list", + "member":{"shape":"NodePropertyOverride"} + }, + "NodeRangeProperties":{ + "type":"list", + "member":{"shape":"NodeRangeProperty"} + }, + "NodeRangeProperty":{ + "type":"structure", + "required":["targetNodes"], + "members":{ + "targetNodes":{ + "shape":"String", + "documentation":"

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

" + }, + "container":{ + "shape":"ContainerProperties", + "documentation":"

The container details for the node range.

" + } + }, + "documentation":"

An object representing the properties of the node range for a multi-node parallel job.

" + }, + "ParametersMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "RegisterJobDefinitionRequest":{ + "type":"structure", + "required":[ + "jobDefinitionName", + "type" + ], + "members":{ + "jobDefinitionName":{ + "shape":"String", + "documentation":"

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

" + }, + "type":{ + "shape":"JobDefinitionType", + "documentation":"

The type of job definition.

" + }, + "parameters":{ + "shape":"ParametersMap", + "documentation":"

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" + }, + "containerProperties":{ + "shape":"ContainerProperties", + "documentation":"

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

" + }, + "nodeProperties":{ + "shape":"NodeProperties", + "documentation":"

An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

" + }, + "retryStrategy":{ + "shape":"RetryStrategy", + "documentation":"

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried.

" + }, + "timeout":{ + "shape":"JobTimeout", + "documentation":"

The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

" + } + } + }, + "RegisterJobDefinitionResponse":{ + "type":"structure", + "required":[ + "jobDefinitionName", + "jobDefinitionArn", + "revision" + ], + "members":{ + "jobDefinitionName":{ + "shape":"String", + "documentation":"

The name of the job definition.

" + }, + "jobDefinitionArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the job definition.

" + }, + "revision":{ + "shape":"Integer", + "documentation":"

The revision of the job definition.

" + } + } + }, + "ResourceRequirement":{ + "type":"structure", + "required":[ + "value", + "type" + ], + "members":{ + "value":{ + "shape":"String", + "documentation":"

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.

" + }, + "type":{ + "shape":"ResourceType", + "documentation":"

The type of resource to assign to a container. Currently, the only supported resource type is GPU.

" + } + }, + "documentation":"

The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.

" + }, + "ResourceRequirements":{ + "type":"list", + "member":{"shape":"ResourceRequirement"} + }, + "ResourceType":{ + "type":"string", + "enum":["GPU"] + }, + "RetryStrategy":{ + "type":"structure", + "members":{ + "attempts":{ + "shape":"Integer", + "documentation":"

The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

" + } + }, + "documentation":"

The retry strategy associated with a job.

" + }, + "ServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a server issue.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubmitJobRequest":{ + "type":"structure", + "required":[ + "jobName", + "jobQueue", + "jobDefinition" + ], + "members":{ + "jobName":{ + "shape":"String", + "documentation":"

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

" + }, + "jobQueue":{ + "shape":"String", + "documentation":"

The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

" + }, + "arrayProperties":{ + "shape":"ArrayProperties", + "documentation":"

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.

" + }, + "dependsOn":{ + "shape":"JobDependencyList", + "documentation":"

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

" + }, + "jobDefinition":{ + "shape":"String", + "documentation":"

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

" + }, + "parameters":{ + "shape":"ParametersMap", + "documentation":"

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

" + }, + "containerOverrides":{ + "shape":"ContainerOverrides", + "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an environment override.

" + }, + "nodeOverrides":{ + "shape":"NodeOverrides", + "documentation":"

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

" + }, + "retryStrategy":{ + "shape":"RetryStrategy", + "documentation":"

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

" + }, + "timeout":{ + "shape":"JobTimeout", + "documentation":"

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

" + } + } + }, + "SubmitJobResponse":{ + "type":"structure", + "required":[ + "jobName", + "jobId" + ], + "members":{ + "jobName":{ + "shape":"String", + "documentation":"

The name of the job.

" + }, + "jobId":{ + "shape":"String", + "documentation":"

The unique identifier for the job.

" + } + } + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TerminateJobRequest":{ + "type":"structure", + "required":[ + "jobId", + "reason" + ], + "members":{ + "jobId":{ + "shape":"String", + "documentation":"

The AWS Batch job ID of the job to terminate.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the AWS Batch activity logs.

" + } + } + }, + "TerminateJobResponse":{ + "type":"structure", + "members":{ + } + }, + "Ulimit":{ + "type":"structure", + "required":[ + "hardLimit", + "name", + "softLimit" + ], + "members":{ + "hardLimit":{ + "shape":"Integer", + "documentation":"

The hard limit for the ulimit type.

" + }, + "name":{ + "shape":"String", + "documentation":"

The type of the ulimit.

" + }, + "softLimit":{ + "shape":"Integer", + "documentation":"

The soft limit for the ulimit type.

" + } + }, + "documentation":"

The ulimit settings to pass to the container.

" + }, + "Ulimits":{ + "type":"list", + "member":{"shape":"Ulimit"} + }, + "UpdateComputeEnvironmentRequest":{ + "type":"structure", + "required":["computeEnvironment"], + "members":{ + "computeEnvironment":{ + "shape":"String", + "documentation":"

The name or full Amazon Resource Name (ARN) of the compute environment to update.

" + }, + "state":{ + "shape":"CEState", + "documentation":"

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

" + }, + "computeResources":{ + "shape":"ComputeResourceUpdate", + "documentation":"

Details of the compute resources managed by the compute environment. Required for a managed compute environment.

" + }, + "serviceRole":{ + "shape":"String", + "documentation":"

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

" + } + } + }, + "UpdateComputeEnvironmentResponse":{ + "type":"structure", + "members":{ + "computeEnvironmentName":{ + "shape":"String", + "documentation":"

The name of the compute environment.

" + }, + "computeEnvironmentArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the compute environment.

" + } + } + }, + "UpdateJobQueueRequest":{ + "type":"structure", + "required":["jobQueue"], + "members":{ + "jobQueue":{ + "shape":"String", + "documentation":"

The name or the Amazon Resource Name (ARN) of the job queue.

" + }, + "state":{ + "shape":"JQState", + "documentation":"

Describes the queue's ability to accept new jobs.

" + }, + "priority":{ + "shape":"Integer", + "documentation":"

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1.

" + }, + "computeEnvironmentOrder":{ + "shape":"ComputeEnvironmentOrders", + "documentation":"

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job.

" + } + } + }, + "UpdateJobQueueResponse":{ + "type":"structure", + "members":{ + "jobQueueName":{ + "shape":"String", + "documentation":"

The name of the job queue.

" + }, + "jobQueueArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the job queue.

" + } + } + }, + "Volume":{ + "type":"structure", + "members":{ + "host":{ + "shape":"Host", + "documentation":"

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

" + } + }, + "documentation":"

A data volume used in a job's container properties.

" + }, + "Volumes":{ + "type":"list", + "member":{"shape":"Volume"} + } + }, + "documentation":"

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

" +} diff --git a/aws/dist/botocore/data/budgets/2016-10-20/examples-1.json b/aws/dist/botocore/data/budgets/2016-10-20/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/budgets/2016-10-20/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/budgets/2016-10-20/paginators-1.json b/aws/dist/botocore/data/budgets/2016-10-20/paginators-1.json new file mode 100644 index 00000000..d66d30b3 --- /dev/null +++ b/aws/dist/botocore/data/budgets/2016-10-20/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeBudgets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Budgets" + }, + "DescribeNotificationsForBudget": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Notifications" + }, + "DescribeSubscribersForNotification": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Subscribers" + } + } +} diff --git a/aws/dist/botocore/data/budgets/2016-10-20/service-2.json b/aws/dist/botocore/data/budgets/2016-10-20/service-2.json new file mode 100644 index 00000000..f6d1e1cf --- /dev/null +++ b/aws/dist/botocore/data/budgets/2016-10-20/service-2.json @@ -0,0 +1,1202 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-10-20", + "endpointPrefix":"budgets", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWSBudgets", + "serviceFullName":"AWS Budgets", + "serviceId":"Budgets", + "signatureVersion":"v4", + "targetPrefix":"AWSBudgetServiceGateway", + "uid":"budgets-2016-10-20" + }, + "operations":{ + "CreateBudget":{ + "name":"CreateBudget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBudgetRequest"}, + "output":{"shape":"CreateBudgetResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"CreationLimitExceededException"}, + {"shape":"DuplicateRecordException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a budget and, if included, notifications and subscribers.

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" + }, + "CreateNotification":{ + "name":"CreateNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNotificationRequest"}, + "output":{"shape":"CreateNotificationResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"CreationLimitExceededException"}, + {"shape":"DuplicateRecordException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a notification. You must create the budget before you create the associated notification.

" + }, + "CreateSubscriber":{ + "name":"CreateSubscriber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubscriberRequest"}, + "output":{"shape":"CreateSubscriberResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"CreationLimitExceededException"}, + {"shape":"DuplicateRecordException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a subscriber. You must create the associated budget and notification before you create the subscriber.

" + }, + "DeleteBudget":{ + "name":"DeleteBudget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBudgetRequest"}, + "output":{"shape":"DeleteBudgetResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a budget. You can delete your budget at any time.

Deleting a budget also deletes the notifications and subscribers that are associated with that budget.

" + }, + "DeleteNotification":{ + "name":"DeleteNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNotificationRequest"}, + "output":{"shape":"DeleteNotificationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a notification.

Deleting a notification also deletes the subscribers that are associated with the notification.

" + }, + "DeleteSubscriber":{ + "name":"DeleteSubscriber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubscriberRequest"}, + "output":{"shape":"DeleteSubscriberResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Deletes a subscriber.

Deleting the last subscriber to a notification also deletes the notification.

" + }, + "DescribeBudget":{ + "name":"DescribeBudget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBudgetRequest"}, + "output":{"shape":"DescribeBudgetResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Describes a budget.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" + }, + "DescribeBudgetPerformanceHistory":{ + "name":"DescribeBudgetPerformanceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBudgetPerformanceHistoryRequest"}, + "output":{"shape":"DescribeBudgetPerformanceHistoryResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

" + }, + "DescribeBudgets":{ + "name":"DescribeBudgets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBudgetsRequest"}, + "output":{"shape":"DescribeBudgetsResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the budgets that are associated with an account.

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" + }, + "DescribeNotificationsForBudget":{ + "name":"DescribeNotificationsForBudget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNotificationsForBudgetRequest"}, + "output":{"shape":"DescribeNotificationsForBudgetResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the notifications that are associated with a budget.

" + }, + "DescribeSubscribersForNotification":{ + "name":"DescribeSubscribersForNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubscribersForNotificationRequest"}, + "output":{"shape":"DescribeSubscribersForNotificationResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the subscribers that are associated with a notification.

" + }, + "UpdateBudget":{ + "name":"UpdateBudget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBudgetRequest"}, + "output":{"shape":"UpdateBudgetResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates a budget. You can change every part of a budget except for the budgetName and the calculatedSpend. When you modify a budget, the calculatedSpend drops to zero until AWS has new usage data to use for forecasting.

Only one of BudgetLimit or PlannedBudgetLimits can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits, see the Examples section.

" + }, + "UpdateNotification":{ + "name":"UpdateNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNotificationRequest"}, + "output":{"shape":"UpdateNotificationResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"DuplicateRecordException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates a notification.

" + }, + "UpdateSubscriber":{ + "name":"UpdateSubscriber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSubscriberRequest"}, + "output":{"shape":"UpdateSubscriberResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"DuplicateRecordException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates a subscriber.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

You are not authorized to use this operation with the given parameters.

", + "exception":true + }, + "AccountId":{ + "type":"string", + "documentation":"

The account ID of the user. It should be a 12-digit number.

", + "max":12, + "min":12, + "pattern":"\\d{12}" + }, + "Budget":{ + "type":"structure", + "required":[ + "BudgetName", + "TimeUnit", + "BudgetType" + ], + "members":{ + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of a budget. The name must be unique within an account. The : and \\ characters aren't allowed in BudgetName.

" + }, + "BudgetLimit":{ + "shape":"Spend", + "documentation":"

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100, which is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

" + }, + "PlannedBudgetLimits":{ + "shape":"PlannedBudgetLimits", + "documentation":"

A map containing multiple BudgetLimit, including current or future limits.

PlannedBudgetLimits is available for cost or usage budget and supports monthly and quarterly TimeUnit.

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

For quarterly budgets, provide 4 quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The key is the start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit. At that point, the planned budget provides the same experience as a fixed budget.

DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits will also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits. This only applies to budgets created with PlannedBudgetLimits. Budgets created without PlannedBudgetLimits will only contain BudgetLimit, and no PlannedBudgetLimits.

" + }, + "CostFilters":{ + "shape":"CostFilters", + "documentation":"

The cost filters, such as service or tag, that are applied to a budget.

AWS Budgets supports the following services as a filter for RI budgets:

  • Amazon Elastic Compute Cloud - Compute

  • Amazon Redshift

  • Amazon Relational Database Service

  • Amazon ElastiCache

  • Amazon Elasticsearch Service

" + }, + "CostTypes":{ + "shape":"CostTypes", + "documentation":"

The types of costs that are included in this COST budget.

USAGE, RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets do not have CostTypes.

" + }, + "TimeUnit":{ + "shape":"TimeUnit", + "documentation":"

The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION, RI_COVERAGE, Savings_Plans_Utilization, and Savings_Plans_Coverage budgets.

" + }, + "TimePeriod":{ + "shape":"TimePeriod", + "documentation":"

The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC.

If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change either date with the UpdateBudget operation.

After the end date, AWS deletes the budget and all associated notifications and subscribers.

" + }, + "CalculatedSpend":{ + "shape":"CalculatedSpend", + "documentation":"

The actual and forecasted cost or usage that the budget tracks.

" + }, + "BudgetType":{ + "shape":"BudgetType", + "documentation":"

Whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

" + }, + "LastUpdatedTime":{ + "shape":"GenericTimestamp", + "documentation":"

The last time that you updated this budget.

" + } + }, + "documentation":"

Represents the output of the CreateBudget operation. The content consists of the detailed metadata and data file information, and the current status of the budget object.

This is the ARN pattern for a budget:

arn:aws:budgetservice::AccountId:budget/budgetName

" + }, + "BudgetName":{ + "type":"string", + "documentation":"

A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.

", + "max":100, + "min":1, + "pattern":"[^:\\\\]+" + }, + "BudgetPerformanceHistory":{ + "type":"structure", + "members":{ + "BudgetName":{"shape":"BudgetName"}, + "BudgetType":{"shape":"BudgetType"}, + "CostFilters":{ + "shape":"CostFilters", + "documentation":"

The history of the cost filters for a budget during the specified time period.

" + }, + "CostTypes":{ + "shape":"CostTypes", + "documentation":"

The history of the cost types for a budget during the specified time period.

" + }, + "TimeUnit":{"shape":"TimeUnit"}, + "BudgetedAndActualAmountsList":{ + "shape":"BudgetedAndActualAmountsList", + "documentation":"

A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.

" + } + }, + "documentation":"

A history of the state of a budget at the end of the budget's specified time period.

" + }, + "BudgetType":{ + "type":"string", + "documentation":"

The type of a budget. It must be one of the following types:

COST, USAGE, RI_UTILIZATION, or RI_COVERAGE.

", + "enum":[ + "USAGE", + "COST", + "RI_UTILIZATION", + "RI_COVERAGE", + "SAVINGS_PLANS_UTILIZATION", + "SAVINGS_PLANS_COVERAGE" + ] + }, + "BudgetedAndActualAmounts":{ + "type":"structure", + "members":{ + "BudgetedAmount":{ + "shape":"Spend", + "documentation":"

The amount of cost or usage that you created the budget for.

" + }, + "ActualAmount":{ + "shape":"Spend", + "documentation":"

Your actual costs or usage for a budget period.

" + }, + "TimePeriod":{ + "shape":"TimePeriod", + "documentation":"

The time period covered by this budget comparison.

" + } + }, + "documentation":"

The amount of cost or usage that you created the budget for, compared to your actual costs or usage.

" + }, + "BudgetedAndActualAmountsList":{ + "type":"list", + "member":{"shape":"BudgetedAndActualAmounts"} + }, + "Budgets":{ + "type":"list", + "member":{"shape":"Budget"}, + "documentation":"

A list of budgets.

" + }, + "CalculatedSpend":{ + "type":"structure", + "required":["ActualSpend"], + "members":{ + "ActualSpend":{ + "shape":"Spend", + "documentation":"

The amount of cost, usage, or RI units that you have used.

" + }, + "ForecastedSpend":{ + "shape":"Spend", + "documentation":"

The amount of cost, usage, or RI units that you are forecasted to use.

" + } + }, + "documentation":"

The spend objects that are associated with this budget. The actualSpend tracks how much you've used, cost, usage, or RI units, and the forecastedSpend tracks how much you are predicted to spend if your current usage remains steady.

For example, if it is the 20th of the month and you have spent 50 dollars on Amazon EC2, your actualSpend is 50 USD, and your forecastedSpend is 75 USD.

" + }, + "ComparisonOperator":{ + "type":"string", + "documentation":"

The comparison operator of a notification. Currently the service supports the following operators:

GREATER_THAN, LESS_THAN, EQUAL_TO

", + "enum":[ + "GREATER_THAN", + "LESS_THAN", + "EQUAL_TO" + ] + }, + "CostFilters":{ + "type":"map", + "key":{"shape":"GenericString"}, + "value":{"shape":"DimensionValues"}, + "documentation":"

A map that represents the cost filters that are applied to the budget.

" + }, + "CostTypes":{ + "type":"structure", + "members":{ + "IncludeTax":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes taxes.

The default value is true.

" + }, + "IncludeSubscription":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes subscriptions.

The default value is true.

" + }, + "UseBlended":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget uses a blended rate.

The default value is false.

" + }, + "IncludeRefund":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes refunds.

The default value is true.

" + }, + "IncludeCredit":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes credits.

The default value is true.

" + }, + "IncludeUpfront":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes upfront RI costs.

The default value is true.

" + }, + "IncludeRecurring":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes recurring fees such as monthly RI fees.

The default value is true.

" + }, + "IncludeOtherSubscription":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes non-RI subscription costs.

The default value is true.

" + }, + "IncludeSupport":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes support subscription fees.

The default value is true.

" + }, + "IncludeDiscount":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget includes discounts.

The default value is true.

" + }, + "UseAmortized":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether a budget uses the amortized rate.

The default value is false.

" + } + }, + "documentation":"

The types of cost that are included in a COST budget, such as tax and subscriptions.

USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.

" + }, + "CreateBudgetRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Budget" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget.

" + }, + "Budget":{ + "shape":"Budget", + "documentation":"

The budget object that you want to create.

" + }, + "NotificationsWithSubscribers":{ + "shape":"NotificationWithSubscribersList", + "documentation":"

A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, AWS creates the notifications and subscribers for you.

" + } + }, + "documentation":"

Request of CreateBudget

" + }, + "CreateBudgetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of CreateBudget

" + }, + "CreateNotificationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification", + "Subscribers" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget that you want to create a notification for.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification that you want to create.

" + }, + "Subscribers":{ + "shape":"Subscribers", + "documentation":"

A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.

" + } + }, + "documentation":"

Request of CreateNotification

" + }, + "CreateNotificationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of CreateNotification

" + }, + "CreateSubscriberRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification", + "Subscriber" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget that you want to create a subscriber for.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget that you want to subscribe to. Budget names must be unique within an account.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification that you want to create a subscriber for.

" + }, + "Subscriber":{ + "shape":"Subscriber", + "documentation":"

The subscriber that you want to associate with a budget notification.

" + } + }, + "documentation":"

Request of CreateSubscriber

" + }, + "CreateSubscriberResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of CreateSubscriber

" + }, + "CreationLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

You've exceeded the notification or subscriber limit.

", + "exception":true + }, + "DeleteBudgetRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget that you want to delete.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget that you want to delete.

" + } + }, + "documentation":"

Request of DeleteBudget

" + }, + "DeleteBudgetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of DeleteBudget

" + }, + "DeleteNotificationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose notification you want to delete.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose notification you want to delete.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification that you want to delete.

" + } + }, + "documentation":"

Request of DeleteNotification

" + }, + "DeleteNotificationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of DeleteNotification

" + }, + "DeleteSubscriberRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification", + "Subscriber" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose subscriber you want to delete.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose subscriber you want to delete.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification whose subscriber you want to delete.

" + }, + "Subscriber":{ + "shape":"Subscriber", + "documentation":"

The subscriber that you want to delete.

" + } + }, + "documentation":"

Request of DeleteSubscriber

" + }, + "DeleteSubscriberResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of DeleteSubscriber

" + }, + "DescribeBudgetPerformanceHistoryRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName" + ], + "members":{ + "AccountId":{"shape":"AccountId"}, + "BudgetName":{"shape":"BudgetName"}, + "TimePeriod":{ + "shape":"TimePeriod", + "documentation":"

Retrieves how often the budget went into an ALARM state for the specified time period.

" + }, + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"GenericString"} + } + }, + "DescribeBudgetPerformanceHistoryResponse":{ + "type":"structure", + "members":{ + "BudgetPerformanceHistory":{ + "shape":"BudgetPerformanceHistory", + "documentation":"

The history of how often the budget has gone into an ALARM state.

For DAILY budgets, the history saves the state of the budget for the last 60 days. For MONTHLY budgets, the history saves the state of the budget for the current month plus the last 12 months. For QUARTERLY budgets, the history saves the state of the budget for the last four quarters.

" + }, + "NextToken":{"shape":"GenericString"} + } + }, + "DescribeBudgetRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget that you want a description of.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget that you want a description of.

" + } + }, + "documentation":"

Request of DescribeBudget

" + }, + "DescribeBudgetResponse":{ + "type":"structure", + "members":{ + "Budget":{ + "shape":"Budget", + "documentation":"

The description of the budget.

" + } + }, + "documentation":"

Response of DescribeBudget

" + }, + "DescribeBudgetsRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budgets that you want descriptions of.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" + } + }, + "documentation":"

Request of DescribeBudgets

" + }, + "DescribeBudgetsResponse":{ + "type":"structure", + "members":{ + "Budgets":{ + "shape":"Budgets", + "documentation":"

A list of budgets.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } + }, + "documentation":"

Response of DescribeBudgets

" + }, + "DescribeNotificationsForBudgetRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose notifications you want descriptions of.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose notifications you want descriptions of.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" + } + }, + "documentation":"

Request of DescribeNotificationsForBudget

" + }, + "DescribeNotificationsForBudgetResponse":{ + "type":"structure", + "members":{ + "Notifications":{ + "shape":"Notifications", + "documentation":"

A list of notifications that are associated with a budget.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } + }, + "documentation":"

Response of GetNotificationsForBudget

" + }, + "DescribeSubscribersForNotificationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose subscribers you want descriptions of.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose subscribers you want descriptions of.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification whose subscribers you want to list.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

" + } + }, + "documentation":"

Request of DescribeSubscribersForNotification

" + }, + "DescribeSubscribersForNotificationResponse":{ + "type":"structure", + "members":{ + "Subscribers":{ + "shape":"Subscribers", + "documentation":"

A list of subscribers that are associated with a notification.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The pagination token in the service response that indicates the next set of results that you can retrieve.

" + } + }, + "documentation":"

Response of DescribeSubscribersForNotification

" + }, + "DimensionValues":{ + "type":"list", + "member":{"shape":"GenericString"} + }, + "DuplicateRecordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The budget name already exists. Budget names must be unique within an account.

", + "exception":true + }, + "ExpiredNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The pagination token expired.

", + "exception":true + }, + "GenericString":{ + "type":"string", + "documentation":"

A generic string.

", + "max":2147483647, + "min":0, + "pattern":".*" + }, + "GenericTimestamp":{ + "type":"timestamp", + "documentation":"

A generic time stamp. In Java, it is transformed to a Date object.

" + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

An error on the server occurred during the processing of your request. Try again later.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The pagination token is invalid.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

", + "exception":true + }, + "MaxResults":{ + "type":"integer", + "documentation":"

An integer that represents how many entries a paginated response contains. The maximum is 100.

", + "box":true, + "max":100, + "min":1 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

We can’t locate the resource that you specified.

", + "exception":true + }, + "Notification":{ + "type":"structure", + "required":[ + "NotificationType", + "ComparisonOperator", + "Threshold" + ], + "members":{ + "NotificationType":{ + "shape":"NotificationType", + "documentation":"

Whether the notification is for how much you have spent (ACTUAL) or for how much you're forecasted to spend (FORECASTED).

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

The comparison that is used for this notification.

" + }, + "Threshold":{ + "shape":"NotificationThreshold", + "documentation":"

The threshold that is associated with a notification. Thresholds are always a percentage.

" + }, + "ThresholdType":{ + "shape":"ThresholdType", + "documentation":"

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, AWS notifies you when you go over 160 dollars.

" + }, + "NotificationState":{ + "shape":"NotificationState", + "documentation":"

Whether this notification is in alarm. If a budget notification is in the ALARM state, you have passed the set threshold for the budget.

" + } + }, + "documentation":"

A notification that is associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL

  • A thresholdType of PERCENTAGE

  • A comparisonOperator of GREATER_THAN

  • A notification threshold of 80

" + }, + "NotificationState":{ + "type":"string", + "enum":[ + "OK", + "ALARM" + ] + }, + "NotificationThreshold":{ + "type":"double", + "documentation":"

The threshold of a notification. It must be a number between 0 and 1,000,000,000.

", + "max":1000000000, + "min":0 + }, + "NotificationType":{ + "type":"string", + "documentation":"

The type of a notification. It must be ACTUAL or FORECASTED.

", + "enum":[ + "ACTUAL", + "FORECASTED" + ] + }, + "NotificationWithSubscribers":{ + "type":"structure", + "required":[ + "Notification", + "Subscribers" + ], + "members":{ + "Notification":{ + "shape":"Notification", + "documentation":"

The notification that is associated with a budget.

" + }, + "Subscribers":{ + "shape":"Subscribers", + "documentation":"

A list of subscribers who are subscribed to this notification.

" + } + }, + "documentation":"

A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

" + }, + "NotificationWithSubscribersList":{ + "type":"list", + "member":{"shape":"NotificationWithSubscribers"}, + "documentation":"

A list of notifications, each with a list of subscribers.

", + "max":5 + }, + "Notifications":{ + "type":"list", + "member":{"shape":"Notification"}, + "documentation":"

A list of notifications.

" + }, + "NullableBoolean":{ + "type":"boolean", + "box":true + }, + "NumericValue":{ + "type":"string", + "documentation":"

A string that represents a numeric value.

", + "max":2147483647, + "min":1, + "pattern":"([0-9]*\\.)?[0-9]+" + }, + "PlannedBudgetLimits":{ + "type":"map", + "key":{"shape":"GenericString"}, + "value":{"shape":"Spend"} + }, + "Spend":{ + "type":"structure", + "required":[ + "Amount", + "Unit" + ], + "members":{ + "Amount":{ + "shape":"NumericValue", + "documentation":"

The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.

" + }, + "Unit":{ + "shape":"UnitValue", + "documentation":"

The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.

" + } + }, + "documentation":"

The amount of cost or usage that is measured for a budget.

For example, a Spend for 3 GB of S3 usage would have the following parameters:

  • An Amount of 3

  • A unit of GB

" + }, + "Subscriber":{ + "type":"structure", + "required":[ + "SubscriptionType", + "Address" + ], + "members":{ + "SubscriptionType":{ + "shape":"SubscriptionType", + "documentation":"

The type of notification that AWS sends to a subscriber.

" + }, + "Address":{ + "shape":"SubscriberAddress", + "documentation":"

The address that AWS sends budget notifications to, either an SNS topic or an email.

When you create a subscriber, the value of Address can't contain line breaks.

" + } + }, + "documentation":"

The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

For example, an email subscriber would have the following parameters:

  • A subscriptionType of EMAIL

  • An address of example@example.com

" + }, + "SubscriberAddress":{ + "type":"string", + "documentation":"

A string that contains an email address or SNS topic for the subscriber's address.

", + "max":2147483647, + "min":1, + "pattern":"(.*[\\n\\r\\t\\f\\ ]?)*", + "sensitive":true + }, + "Subscribers":{ + "type":"list", + "member":{"shape":"Subscriber"}, + "documentation":"

A list of subscribers.

", + "max":11, + "min":1 + }, + "SubscriptionType":{ + "type":"string", + "documentation":"

The subscription type of the subscriber. It can be SMS or EMAIL.

", + "enum":[ + "SNS", + "EMAIL" + ] + }, + "ThresholdType":{ + "type":"string", + "documentation":"

The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.

", + "enum":[ + "PERCENTAGE", + "ABSOLUTE_VALUE" + ] + }, + "TimePeriod":{ + "type":"structure", + "members":{ + "Start":{ + "shape":"GenericTimestamp", + "documentation":"

The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn't set a start date, AWS set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, AWS set your start date to 01/01/18 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change your start date with the UpdateBudget operation.

" + }, + "End":{ + "shape":"GenericTimestamp", + "documentation":"

The end date for a budget. If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC. The defaults are the same for the AWS Billing and Cost Management console and the API.

After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

" + } + }, + "documentation":"

The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

" + }, + "TimeUnit":{ + "type":"string", + "documentation":"

The time unit of the budget, such as MONTHLY or QUARTERLY.

", + "enum":[ + "DAILY", + "MONTHLY", + "QUARTERLY", + "ANNUALLY" + ] + }, + "UnitValue":{ + "type":"string", + "documentation":"

A string that represents the spend unit of a budget. It can't be null or empty.

", + "max":2147483647, + "min":1, + "pattern":".*" + }, + "UpdateBudgetRequest":{ + "type":"structure", + "required":[ + "AccountId", + "NewBudget" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget that you want to update.

" + }, + "NewBudget":{ + "shape":"Budget", + "documentation":"

The budget that you want to update your budget to.

" + } + }, + "documentation":"

Request of UpdateBudget

" + }, + "UpdateBudgetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of UpdateBudget

" + }, + "UpdateNotificationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "OldNotification", + "NewNotification" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose notification you want to update.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose notification you want to update.

" + }, + "OldNotification":{ + "shape":"Notification", + "documentation":"

The previous notification that is associated with a budget.

" + }, + "NewNotification":{ + "shape":"Notification", + "documentation":"

The updated notification to be associated with a budget.

" + } + }, + "documentation":"

Request of UpdateNotification

" + }, + "UpdateNotificationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of UpdateNotification

" + }, + "UpdateSubscriberRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BudgetName", + "Notification", + "OldSubscriber", + "NewSubscriber" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The accountId that is associated with the budget whose subscriber you want to update.

" + }, + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

The name of the budget whose subscriber you want to update.

" + }, + "Notification":{ + "shape":"Notification", + "documentation":"

The notification whose subscriber you want to update.

" + }, + "OldSubscriber":{ + "shape":"Subscriber", + "documentation":"

The previous subscriber that is associated with a budget notification.

" + }, + "NewSubscriber":{ + "shape":"Subscriber", + "documentation":"

The updated subscriber that is associated with a budget notification.

" + } + }, + "documentation":"

Request of UpdateSubscriber

" + }, + "UpdateSubscriberResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response of UpdateSubscriber

" + }, + "errorMessage":{ + "type":"string", + "documentation":"

The error message the exception carries.

" + } + }, + "documentation":"

The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets.

Budgets provide you with a way to see the following information:

  • How close your plan is to your budgeted amount or to the free tier limits

  • Your usage-to-date, including how much you've used of your Reserved Instances (RIs)

  • Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month

  • How much of your budget has been used

AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:

  • Cost budgets - Plan how much you want to spend on a service.

  • Usage budgets - Plan how much you want to use one or more services.

  • RI utilization budgets - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.

  • RI coverage budgets - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.

Service Endpoint

The AWS Budgets API provides the following endpoint:

  • https://budgets.amazonaws.com

For information about costs that are associated with the AWS Budgets API, see AWS Cost Management Pricing.

" +} diff --git a/aws/dist/botocore/data/ce/2017-10-25/paginators-1.json b/aws/dist/botocore/data/ce/2017-10-25/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/ce/2017-10-25/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/ce/2017-10-25/service-2.json b/aws/dist/botocore/data/ce/2017-10-25/service-2.json new file mode 100644 index 00000000..b05948e9 --- /dev/null +++ b/aws/dist/botocore/data/ce/2017-10-25/service-2.json @@ -0,0 +1,2467 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-25", + "endpointPrefix":"ce", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWS Cost Explorer", + "serviceFullName":"AWS Cost Explorer Service", + "serviceId":"Cost Explorer", + "signatureVersion":"v4", + "signingName":"ce", + "targetPrefix":"AWSInsightsIndexService", + "uid":"ce-2017-10-25" + }, + "operations":{ + "GetCostAndUsage":{ + "name":"GetCostAndUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCostAndUsageRequest"}, + "output":{"shape":"GetCostAndUsageResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BillExpirationException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"RequestChangedException"} + ], + "documentation":"

Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as BlendedCosts or UsageQuantity, that you want the request to return. You can also filter and group your data by various dimensions, such as SERVICE or AZ, in a specific time range. For a complete list of valid dimensions, see the GetDimensionValues operation. Master accounts in an organization in AWS Organizations have access to all member accounts.

" + }, + "GetCostForecast":{ + "name":"GetCostForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCostForecastRequest"}, + "output":{"shape":"GetCostForecastResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"} + ], + "documentation":"

Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs.

" + }, + "GetDimensionValues":{ + "name":"GetDimensionValues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDimensionValuesRequest"}, + "output":{"shape":"GetDimensionValuesResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BillExpirationException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"RequestChangedException"} + ], + "documentation":"

Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string.

" + }, + "GetReservationCoverage":{ + "name":"GetReservationCoverage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservationCoverageRequest"}, + "output":{"shape":"GetReservationCoverageResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

To determine valid values for a dimension, use the GetDimensionValues operation.

" + }, + "GetReservationPurchaseRecommendation":{ + "name":"GetReservationPurchaseRecommendation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservationPurchaseRecommendationRequest"}, + "output":{"shape":"GetReservationPurchaseRecommendationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.

AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings.

For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for c4.large because that is the smallest size instance in the c4 instance family.

" + }, + "GetReservationUtilization":{ + "name":"GetReservationUtilization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservationUtilizationRequest"}, + "output":{"shape":"GetReservationUtilizationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID.

" + }, + "GetRightsizingRecommendation":{ + "name":"GetRightsizingRecommendation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRightsizingRecommendationRequest"}, + "output":{"shape":"GetRightsizingRecommendationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.

" + }, + "GetSavingsPlansCoverage":{ + "name":"GetSavingsPlansCoverage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSavingsPlansCoverageRequest"}, + "output":{"shape":"GetSavingsPlansCoverageResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves the Savings Plans covered for your account. This enables you to see how much of your cost is covered by a Savings Plan. An organization’s master account can see the coverage of the associated member accounts. For any time period, you can filter data for Savings Plans usage with the following dimensions:

  • LINKED_ACCOUNT

  • REGION

  • SERVICE

  • INSTANCE_FAMILY

To determine valid values for a dimension, use the GetDimensionValues operation.

" + }, + "GetSavingsPlansPurchaseRecommendation":{ + "name":"GetSavingsPlansPurchaseRecommendation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSavingsPlansPurchaseRecommendationRequest"}, + "output":{"shape":"GetSavingsPlansPurchaseRecommendationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves your request parameters, Savings Plan Recommendations Summary and Details.

" + }, + "GetSavingsPlansUtilization":{ + "name":"GetSavingsPlansUtilization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSavingsPlansUtilizationRequest"}, + "output":{"shape":"GetSavingsPlansUtilizationResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"} + ], + "documentation":"

Retrieves the Savings Plans utilization for your account across date ranges with daily or monthly granularity. Master accounts in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

You cannot group by any dimension values for GetSavingsPlansUtilization.

" + }, + "GetSavingsPlansUtilizationDetails":{ + "name":"GetSavingsPlansUtilizationDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSavingsPlansUtilizationDetailsRequest"}, + "output":{"shape":"GetSavingsPlansUtilizationDetailsResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account. Master accounts in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

You can't group by any dimension values for GetSavingsPlansUtilizationDetails.

" + }, + "GetTags":{ + "name":"GetTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTagsRequest"}, + "output":{"shape":"GetTagsResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BillExpirationException"}, + {"shape":"DataUnavailableException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"RequestChangedException"} + ], + "documentation":"

Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string.

" + }, + "GetUsageForecast":{ + "name":"GetUsageForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUsageForecastRequest"}, + "output":{"shape":"GetUsageForecastResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"DataUnavailableException"}, + {"shape":"UnresolvableUsageUnitException"} + ], + "documentation":"

Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage.

" + } + }, + "shapes":{ + "AccountScope":{ + "type":"string", + "enum":[ + "PAYER", + "LINKED" + ] + }, + "AmortizedRecurringFee":{"type":"string"}, + "AmortizedUpfrontFee":{"type":"string"}, + "AttributeType":{"type":"string"}, + "AttributeValue":{"type":"string"}, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeType"}, + "value":{"shape":"AttributeValue"} + }, + "BillExpirationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The requested report expired. Update the date interval and try again.

", + "exception":true + }, + "Context":{ + "type":"string", + "enum":[ + "COST_AND_USAGE", + "RESERVATIONS", + "SAVINGS_PLANS" + ] + }, + "Coverage":{ + "type":"structure", + "members":{ + "CoverageHours":{ + "shape":"CoverageHours", + "documentation":"

The amount of instance usage that the reservation covered, in hours.

" + }, + "CoverageNormalizedUnits":{ + "shape":"CoverageNormalizedUnits", + "documentation":"

The amount of instance usage that the reservation covered, in normalized units.

" + }, + "CoverageCost":{ + "shape":"CoverageCost", + "documentation":"

The amount of cost that the reservation covered.

" + } + }, + "documentation":"

The amount of instance usage that a reservation covered.

" + }, + "CoverageByTime":{ + "type":"structure", + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The period that this coverage was used over.

" + }, + "Groups":{ + "shape":"ReservationCoverageGroups", + "documentation":"

The groups of instances that the reservation covered.

" + }, + "Total":{ + "shape":"Coverage", + "documentation":"

The total reservation coverage, in hours.

" + } + }, + "documentation":"

Reservation coverage for a specified period, in hours.

" + }, + "CoverageCost":{ + "type":"structure", + "members":{ + "OnDemandCost":{ + "shape":"OnDemandCost", + "documentation":"

How much an On-Demand instance cost.

" + } + }, + "documentation":"

How much it cost to run an instance.

" + }, + "CoverageHours":{ + "type":"structure", + "members":{ + "OnDemandHours":{ + "shape":"OnDemandHours", + "documentation":"

The number of instance running hours that On-Demand Instances covered.

" + }, + "ReservedHours":{ + "shape":"ReservedHours", + "documentation":"

The number of instance running hours that reservations covered.

" + }, + "TotalRunningHours":{ + "shape":"TotalRunningHours", + "documentation":"

The total instance usage, in hours.

" + }, + "CoverageHoursPercentage":{ + "shape":"CoverageHoursPercentage", + "documentation":"

The percentage of instance hours that a reservation covered.

" + } + }, + "documentation":"

How long a running instance either used a reservation or was On-Demand.

" + }, + "CoverageHoursPercentage":{"type":"string"}, + "CoverageNormalizedUnits":{ + "type":"structure", + "members":{ + "OnDemandNormalizedUnits":{ + "shape":"OnDemandNormalizedUnits", + "documentation":"

The number of normalized units that are covered by On-Demand Instances instead of a reservation.

" + }, + "ReservedNormalizedUnits":{ + "shape":"ReservedNormalizedUnits", + "documentation":"

The number of normalized units that a reservation covers.

" + }, + "TotalRunningNormalizedUnits":{ + "shape":"TotalRunningNormalizedUnits", + "documentation":"

The total number of normalized units that you used.

" + }, + "CoverageNormalizedUnitsPercentage":{ + "shape":"CoverageNormalizedUnitsPercentage", + "documentation":"

The percentage of your used instance normalized units that a reservation covers.

" + } + }, + "documentation":"

The amount of instance usage, in normalized units. Normalized units enable you to see your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose you run an xlarge instance and a 2xlarge instance. If you run both instances for the same amount of time, the 2xlarge instance uses twice as much of your reservation as the xlarge instance, even though both instances show only one instance-hour. Using normalized units instead of instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge instance used 16 normalized units.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

" + }, + "CoverageNormalizedUnitsPercentage":{"type":"string"}, + "CoveragesByTime":{ + "type":"list", + "member":{"shape":"CoverageByTime"} + }, + "CurrentInstance":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"GenericString", + "documentation":"

Resource ID of the current instance.

" + }, + "Tags":{ + "shape":"TagValuesList", + "documentation":"

Cost allocation resource tags applied to the instance.

" + }, + "ResourceDetails":{ + "shape":"ResourceDetails", + "documentation":"

Details about the resource and utilization.

" + }, + "ResourceUtilization":{ + "shape":"ResourceUtilization", + "documentation":"

Utilization information of the current instance during the lookback period.

" + }, + "ReservationCoveredHoursInLookbackPeriod":{ + "shape":"GenericString", + "documentation":"

Number of hours during the lookback period covered by reservations.

" + }, + "SavingsPlansCoveredHoursInLookbackPeriod":{ + "shape":"GenericString", + "documentation":"

Number of hours during the lookback period covered by Savings Plans.

" + }, + "OnDemandHoursInLookbackPeriod":{ + "shape":"GenericString", + "documentation":"

Number of hours during the lookback period billed at On Demand rates.

" + }, + "TotalRunningHoursInLookbackPeriod":{ + "shape":"GenericString", + "documentation":"

The total number of hours the instance ran during the lookback period.

" + }, + "MonthlyCost":{ + "shape":"GenericString", + "documentation":"

Current On Demand cost of operating this instance on a monthly basis.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + } + }, + "documentation":"

Context about the current instance.

" + }, + "DataUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The requested data is unavailable.

", + "exception":true + }, + "DateInterval":{ + "type":"structure", + "required":[ + "Start", + "End" + ], + "members":{ + "Start":{ + "shape":"YearMonthDay", + "documentation":"

The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01, AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.

" + }, + "End":{ + "shape":"YearMonthDay", + "documentation":"

The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01, AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01.

" + } + }, + "documentation":"

The time period that you want the usage and costs for.

" + }, + "Dimension":{ + "type":"string", + "enum":[ + "AZ", + "INSTANCE_TYPE", + "LINKED_ACCOUNT", + "OPERATION", + "PURCHASE_TYPE", + "REGION", + "SERVICE", + "USAGE_TYPE", + "USAGE_TYPE_GROUP", + "RECORD_TYPE", + "OPERATING_SYSTEM", + "TENANCY", + "SCOPE", + "PLATFORM", + "SUBSCRIPTION_ID", + "LEGAL_ENTITY_NAME", + "DEPLOYMENT_OPTION", + "DATABASE_ENGINE", + "CACHE_ENGINE", + "INSTANCE_TYPE_FAMILY", + "BILLING_ENTITY", + "RESERVATION_ID", + "RIGHTSIZING_TYPE", + "SAVINGS_PLANS_TYPE", + "SAVINGS_PLAN_ARN", + "PAYMENT_OPTION" + ] + }, + "DimensionValues":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Dimension", + "documentation":"

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

" + }, + "Values":{ + "shape":"Values", + "documentation":"

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

Valid values for the SERVICE dimension are Amazon Elastic Compute Cloud - Compute, Amazon Elasticsearch Service, Amazon ElastiCache, Amazon Redshift, and Amazon Relational Database Service.

" + } + }, + "documentation":"

The metadata that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

" + }, + "DimensionValuesWithAttributes":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Value", + "documentation":"

The value of a dimension with a specific attribute.

" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

The attribute that applies to a specific Dimension.

" + } + }, + "documentation":"

The metadata of a specific type that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

" + }, + "DimensionValuesWithAttributesList":{ + "type":"list", + "member":{"shape":"DimensionValuesWithAttributes"} + }, + "EC2InstanceDetails":{ + "type":"structure", + "members":{ + "Family":{ + "shape":"GenericString", + "documentation":"

The instance family of the recommended reservation.

" + }, + "InstanceType":{ + "shape":"GenericString", + "documentation":"

The type of instance that AWS recommends.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The AWS Region of the recommended reservation.

" + }, + "AvailabilityZone":{ + "shape":"GenericString", + "documentation":"

The Availability Zone of the recommended reservation.

" + }, + "Platform":{ + "shape":"GenericString", + "documentation":"

The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.

" + }, + "Tenancy":{ + "shape":"GenericString", + "documentation":"

Whether the recommended reservation is dedicated or shared.

" + }, + "CurrentGeneration":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommendation is for a current-generation instance.

" + }, + "SizeFlexEligible":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommended reservation is size flexible.

" + } + }, + "documentation":"

Details about the Amazon EC2 instances that AWS recommends that you purchase.

" + }, + "EC2ResourceDetails":{ + "type":"structure", + "members":{ + "HourlyOnDemandRate":{ + "shape":"GenericString", + "documentation":"

Hourly public On Demand rate for the instance type.

" + }, + "InstanceType":{ + "shape":"GenericString", + "documentation":"

The type of Amazon Web Services instance.

" + }, + "Platform":{ + "shape":"GenericString", + "documentation":"

The platform of the Amazon Web Services instance. The platform is the specific combination of operating system, license model, and software on an instance.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The Amazon Web Services Region of the instance.

" + }, + "Sku":{ + "shape":"GenericString", + "documentation":"

The SKU of the product.

" + }, + "Memory":{ + "shape":"GenericString", + "documentation":"

Memory capacity of Amazon Web Services instance.

" + }, + "NetworkPerformance":{ + "shape":"GenericString", + "documentation":"

Network performance capacity of the Amazon Web Services instance.

" + }, + "Storage":{ + "shape":"GenericString", + "documentation":"

The disk storage of the Amazon Web Services instance (Not EBS storage).

" + }, + "Vcpu":{ + "shape":"GenericString", + "documentation":"

Number of VCPU cores in the Amazon Web Services instance type.

" + } + }, + "documentation":"

Details on the Amazon EC2 Resource.

" + }, + "EC2ResourceUtilization":{ + "type":"structure", + "members":{ + "MaxCpuUtilizationPercentage":{ + "shape":"GenericString", + "documentation":"

Maximum observed or expected CPU utilization of the instance.

" + }, + "MaxMemoryUtilizationPercentage":{ + "shape":"GenericString", + "documentation":"

Maximum observed or expected memory utilization of the instance.

" + }, + "MaxStorageUtilizationPercentage":{ + "shape":"GenericString", + "documentation":"

Maximum observed or expected storage utilization of the instance (does not measure EBS storage).

" + } + }, + "documentation":"

Utilization metrics of the instance.

" + }, + "EC2Specification":{ + "type":"structure", + "members":{ + "OfferingClass":{ + "shape":"OfferingClass", + "documentation":"

Whether you want a recommendation for standard or convertible reservations.

" + } + }, + "documentation":"

The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.

" + }, + "ESInstanceDetails":{ + "type":"structure", + "members":{ + "InstanceClass":{ + "shape":"GenericString", + "documentation":"

The class of instance that AWS recommends.

" + }, + "InstanceSize":{ + "shape":"GenericString", + "documentation":"

The size of instance that AWS recommends.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The AWS Region of the recommended reservation.

" + }, + "CurrentGeneration":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommendation is for a current-generation instance.

" + }, + "SizeFlexEligible":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommended reservation is size flexible.

" + } + }, + "documentation":"

Details about the Amazon ES instances that AWS recommends that you purchase.

" + }, + "ElastiCacheInstanceDetails":{ + "type":"structure", + "members":{ + "Family":{ + "shape":"GenericString", + "documentation":"

The instance family of the recommended reservation.

" + }, + "NodeType":{ + "shape":"GenericString", + "documentation":"

The type of node that AWS recommends.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The AWS Region of the recommended reservation.

" + }, + "ProductDescription":{ + "shape":"GenericString", + "documentation":"

The description of the recommended reservation.

" + }, + "CurrentGeneration":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommendation is for a current generation instance.

" + }, + "SizeFlexEligible":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommended reservation is size flexible.

" + } + }, + "documentation":"

Details about the Amazon ElastiCache instances that AWS recommends that you purchase.

" + }, + "Entity":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "Estimated":{"type":"boolean"}, + "Expression":{ + "type":"structure", + "members":{ + "Or":{ + "shape":"Expressions", + "documentation":"

Return results that match either Dimension object.

" + }, + "And":{ + "shape":"Expressions", + "documentation":"

Return results that match both Dimension objects.

" + }, + "Not":{ + "shape":"Expression", + "documentation":"

Return results that don't match a Dimension object.

" + }, + "Dimensions":{ + "shape":"DimensionValues", + "documentation":"

The specific Dimension to use for Expression.

" + }, + "Tags":{ + "shape":"TagValues", + "documentation":"

The specific Tag to use for Expression.

" + } + }, + "documentation":"

Use Expression to filter by cost or by usage. There are two patterns:

  • Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1. The Expression for that looks like this:

    { \"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", “us-west-1” ] } }

    The list of dimension values are OR'd together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.

  • Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. This allows you to filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer). The Expression for that looks like this:

    { \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"REGION\", \"Values\": [ \"us-east-1\", \"us-west-1\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] }

    Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

    { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } }

For GetRightsizingRecommendation action, a combination of OR and NOT is not supported. OR is not supported between different dimensions, or dimensions and tags. NOT operators aren't supported. Dimensions are also limited to LINKED_ACCOUNT, REGION, or RIGHTSIZING_TYPE.

" + }, + "Expressions":{ + "type":"list", + "member":{"shape":"Expression"} + }, + "ForecastResult":{ + "type":"structure", + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The period of time that the forecast covers.

" + }, + "MeanValue":{ + "shape":"GenericString", + "documentation":"

The mean value of the forecast.

" + }, + "PredictionIntervalLowerBound":{ + "shape":"GenericString", + "documentation":"

The lower limit for the prediction interval.

" + }, + "PredictionIntervalUpperBound":{ + "shape":"GenericString", + "documentation":"

The upper limit for the prediction interval.

" + } + }, + "documentation":"

The forecast created for your query.

" + }, + "ForecastResultsByTime":{ + "type":"list", + "member":{"shape":"ForecastResult"} + }, + "GenericBoolean":{"type":"boolean"}, + "GenericString":{"type":"string"}, + "GetCostAndUsageRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

Sets the AWS cost granularity to MONTHLY or DAILY. If Granularity isn't set, the response object doesn't include the Granularity, either MONTHLY or DAILY.

The GetCostAndUsageRequest operation supports only DAILY and MONTHLY granularities.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters AWS costs by different dimensions. For example, you can specify SERVICE and LINKED_ACCOUNT and get the costs that are associated with that account's usage of that service. You can nest Expression objects to define any combination of dimension filters. For more information, see Expression.

" + }, + "Metrics":{ + "shape":"MetricNames", + "documentation":"

Which metrics are returned in the query. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.

Valid values are AmortizedCost, BlendedCost, NetAmortizedCost, NetUnblendedCost, NormalizedUsageAmount, UnblendedCost, and UsageQuantity.

If you return the UsageQuantity metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate usageQuantity across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful UsageQuantity metrics, filter by UsageType or UsageTypeGroups.

Metrics is required for GetCostAndUsage requests.

" + }, + "GroupBy":{ + "shape":"GroupDefinitions", + "documentation":"

You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.

When you group by tag key, you get all tag values, including empty strings.

Valid values are AZ, INSTANCE_TYPE, LEGAL_ENTITY_NAME, LINKED_ACCOUNT, OPERATION, PLATFORM, PURCHASE_TYPE, SERVICE, TAGS, TENANCY, and USAGE_TYPE.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetCostAndUsageResponse":{ + "type":"structure", + "members":{ + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + }, + "GroupDefinitions":{ + "shape":"GroupDefinitions", + "documentation":"

The groups that are specified by the Filter or GroupBy parameters in the request.

" + }, + "ResultsByTime":{ + "shape":"ResultsByTime", + "documentation":"

The time period that is covered by the results in the response.

" + } + } + }, + "GetCostForecastRequest":{ + "type":"structure", + "required":[ + "TimePeriod", + "Metric", + "Granularity" + ], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The period of time that you want the forecast to cover.

" + }, + "Metric":{ + "shape":"Metric", + "documentation":"

Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see Why does the \"blended\" annotation appear on some line items in my bill?.

Valid values for a GetCostForecast call are the following:

  • AMORTIZED_COST

  • BLENDED_COST

  • NET_AMORTIZED_COST

  • NET_UNBLENDED_COST

  • UNBLENDED_COST

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetCostForecast operation supports only DAILY and MONTHLY granularities.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" + }, + "PredictionIntervalLevel":{ + "shape":"PredictionIntervalLevel", + "documentation":"

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" + } + } + }, + "GetCostForecastResponse":{ + "type":"structure", + "members":{ + "Total":{ + "shape":"MetricValue", + "documentation":"

How much you are forecasted to spend over the forecast period, in USD.

" + }, + "ForecastResultsByTime":{ + "shape":"ForecastResultsByTime", + "documentation":"

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

" + } + } + }, + "GetDimensionValuesRequest":{ + "type":"structure", + "required":[ + "TimePeriod", + "Dimension" + ], + "members":{ + "SearchString":{ + "shape":"SearchString", + "documentation":"

The value that you want to search the filter values for.

" + }, + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "Dimension":{ + "shape":"Dimension", + "documentation":"

The name of the dimension. Each Dimension is available for a different Context. For more information, see Context.

" + }, + "Context":{ + "shape":"Context", + "documentation":"

The context for the call to GetDimensionValues. This can be RESERVATIONS or COST_AND_USAGE. The default value is COST_AND_USAGE. If the context is set to RESERVATIONS, the resulting dimension values can be used in the GetReservationUtilization operation. If the context is set to COST_AND_USAGE, the resulting dimension values can be used in the GetCostAndUsage operation.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetDimensionValuesResponse":{ + "type":"structure", + "required":[ + "DimensionValues", + "ReturnSize", + "TotalSize" + ], + "members":{ + "DimensionValues":{ + "shape":"DimensionValuesWithAttributesList", + "documentation":"

The filters that you used to filter your request. Some dimensions are available only for a specific context.

If you set the context to COST_AND_USAGE, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.

  • OPERATION - The action performed. Examples include RunInstance and CreateBucket.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.

  • SERVICE - The AWS service such as Amazon DynamoDB.

  • USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the GetDimensionValues operation includes a unit attribute. Examples include GB and Hrs.

  • USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.

  • RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.

If you set the context to RESERVATIONS, you can use the following dimensions for searching:

  • AZ - The Availability Zone. An example is us-east-1a.

  • CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.

  • DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are SingleAZ and MultiAZ.

  • INSTANCE_TYPE - The type of Amazon EC2 instance. An example is m4.xlarge.

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.

  • REGION - The AWS Region.

  • SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.

  • TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).

  • TENANCY - The tenancy of a resource. Examples are shared or dedicated.

If you set the context to SAVINGS_PLANS, you can use the following dimensions for searching:

  • SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)

  • PAYMENT_OPTION - Payment option for the given Savings Plans (for example, All Upfront)

  • REGION - The AWS Region.

  • INSTANCE_TYPE_FAMILY - The family of instances (For example, m5)

  • LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.

  • SAVINGS_PLAN_ARN - The unique identifier for your Savings Plan

" + }, + "ReturnSize":{ + "shape":"PageSize", + "documentation":"

The number of results that AWS returned at one time.

" + }, + "TotalSize":{ + "shape":"PageSize", + "documentation":"

The total number of search results.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetReservationCoverageRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "GroupBy":{ + "shape":"GroupDefinitions", + "documentation":"

You can group the data by the following attributes:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • TENANCY

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

The granularity of the AWS cost data for the reservation. Valid values are MONTHLY and DAILY.

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY.

The GetReservationCoverage operation supports only DAILY and MONTHLY granularities.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters utilization data by dimensions. You can filter by the following dimensions:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • TAG

  • TENANCY

GetReservationCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.

If you don't provide a SERVICE filter, Cost Explorer defaults to EC2.

" + }, + "Metrics":{ + "shape":"MetricNames", + "documentation":"

The measurement that you want your reservation coverage reported in.

Valid values are Hour, Unit, and Cost. You can use multiple values in a request.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + }, + "documentation":"

You can use the following request parameters to query for how much of your instance usage a reservation covered.

" + }, + "GetReservationCoverageResponse":{ + "type":"structure", + "required":["CoveragesByTime"], + "members":{ + "CoveragesByTime":{ + "shape":"CoveragesByTime", + "documentation":"

The amount of time that your reservations covered.

" + }, + "Total":{ + "shape":"Coverage", + "documentation":"

The total amount of instance usage that a reservation covered.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetReservationPurchaseRecommendationRequest":{ + "type":"structure", + "required":["Service"], + "members":{ + "AccountId":{ + "shape":"GenericString", + "documentation":"

The account ID that is associated with the recommendation.

" + }, + "Service":{ + "shape":"GenericString", + "documentation":"

The specific service that you want recommendations for.

" + }, + "AccountScope":{ + "shape":"AccountScope", + "documentation":"

The account scope that you want recommendations for. PAYER means that AWS includes the master account and any member accounts when it calculates its recommendations. LINKED means that AWS includes only member accounts when it calculates its recommendations.

Valid values are PAYER and LINKED.

" + }, + "LookbackPeriodInDays":{ + "shape":"LookbackPeriodInDays", + "documentation":"

The number of previous days that you want AWS to consider when it calculates your recommendations.

" + }, + "TermInYears":{ + "shape":"TermInYears", + "documentation":"

The reservation term that you want recommendations for.

" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The reservation purchase option that you want recommendations for.

" + }, + "ServiceSpecification":{ + "shape":"ServiceSpecification", + "documentation":"

The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.

" + }, + "PageSize":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of recommendations that you want returned in a single response object.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" + } + } + }, + "GetReservationPurchaseRecommendationResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"ReservationPurchaseRecommendationMetadata", + "documentation":"

Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.

" + }, + "Recommendations":{ + "shape":"ReservationPurchaseRecommendations", + "documentation":"

Recommendations for reservations to purchase.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The pagination token for the next set of retrievable results.

" + } + } + }, + "GetReservationUtilizationRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "GroupBy":{ + "shape":"GroupDefinitions", + "documentation":"

Groups only by SUBSCRIPTION_ID. Metadata is included.

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

If GroupBy is set, Granularity can't be set. If Granularity isn't set, the response object doesn't include Granularity, either MONTHLY or DAILY. If both GroupBy and Granularity aren't set, GetReservationUtilization defaults to DAILY.

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters utilization data by dimensions. You can filter by the following dimensions:

  • AZ

  • CACHE_ENGINE

  • DATABASE_ENGINE

  • DEPLOYMENT_OPTION

  • INSTANCE_TYPE

  • LINKED_ACCOUNT

  • OPERATING_SYSTEM

  • PLATFORM

  • REGION

  • SERVICE

  • SCOPE

  • TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetReservationUtilizationResponse":{ + "type":"structure", + "required":["UtilizationsByTime"], + "members":{ + "UtilizationsByTime":{ + "shape":"UtilizationsByTime", + "documentation":"

The amount of time that you used your RIs.

" + }, + "Total":{ + "shape":"ReservationAggregates", + "documentation":"

The total amount of time that you used your RIs.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetRightsizingRecommendationRequest":{ + "type":"structure", + "required":["Service"], + "members":{ + "Filter":{"shape":"Expression"}, + "Service":{ + "shape":"GenericString", + "documentation":"

The specific service that you want recommendations for. The only valid value for GetRightsizingRecommendation is \"AmazonEC2\".

" + }, + "PageSize":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of recommendations that you want returned in a single response object.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The pagination token that indicates the next set of results that you want to retrieve.

" + } + } + }, + "GetRightsizingRecommendationResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"RightsizingRecommendationMetadata", + "documentation":"

Information regarding this specific recommendation set.

" + }, + "Summary":{ + "shape":"RightsizingRecommendationSummary", + "documentation":"

Summary of this recommendation set.

" + }, + "RightsizingRecommendations":{ + "shape":"RightsizingRecommendationList", + "documentation":"

Recommendations to rightsize resources.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results.

" + } + } + }, + "GetSavingsPlansCoverageRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

" + }, + "GroupBy":{ + "shape":"GroupDefinitions", + "documentation":"

You can group the data using the attributes INSTANCE_FAMILY, REGION, or SERVICE.

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

The granularity of the Amazon Web Services cost data for your Savings Plans. Granularity can't be set if GroupBy is set.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters Savings Plans coverage data by dimensions. You can filter data for Savings Plans usage with the following dimensions:

  • LINKED_ACCOUNT

  • REGION

  • SERVICE

  • INSTANCE_FAMILY

GetSavingsPlansCoverage uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

" + }, + "Metrics":{ + "shape":"MetricNames", + "documentation":"

The measurement that you want your Savings Plans coverage reported in. The only valid value is spendCoveredBySavingsPlans.

" + }, + "NextToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

", + "box":true + } + } + }, + "GetSavingsPlansCoverageResponse":{ + "type":"structure", + "required":["SavingsPlansCoverages"], + "members":{ + "SavingsPlansCoverages":{ + "shape":"SavingsPlansCoverages", + "documentation":"

The amount of spend that your Savings Plans covered.

" + }, + "NextToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetSavingsPlansPurchaseRecommendationRequest":{ + "type":"structure", + "required":[ + "SavingsPlansType", + "TermInYears", + "PaymentOption", + "LookbackPeriodInDays" + ], + "members":{ + "SavingsPlansType":{ + "shape":"SupportedSavingsPlansType", + "documentation":"

The Savings Plans recommendation type requested.

" + }, + "TermInYears":{ + "shape":"TermInYears", + "documentation":"

The savings plan recommendation term used to generated these recommendations.

" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option used to generate these recommendations.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + }, + "PageSize":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of recommendations that you want returned in a single response object.

" + }, + "LookbackPeriodInDays":{ + "shape":"LookbackPeriodInDays", + "documentation":"

The lookback period used to generate the recommendation.

" + } + } + }, + "GetSavingsPlansPurchaseRecommendationResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"SavingsPlansPurchaseRecommendationMetadata", + "documentation":"

The accountIDs these recommendations are generated for.

" + }, + "SavingsPlansPurchaseRecommendation":{ + "shape":"SavingsPlansPurchaseRecommendation", + "documentation":"

Contains your request parameters, Savings Plan Recommendations Summary, and Details.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetSavingsPlansUtilizationDetailsRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • LINKED_ACCOUNT

  • SAVINGS_PLAN_ARN

  • REGION

  • PAYMENT_OPTIONS

  • INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilizationDetails uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

" + }, + "NextToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to be returned in a response. The default is 20, with a minimum value of 1.

", + "box":true + } + } + }, + "GetSavingsPlansUtilizationDetailsResponse":{ + "type":"structure", + "required":[ + "SavingsPlansUtilizationDetails", + "TimePeriod" + ], + "members":{ + "SavingsPlansUtilizationDetails":{ + "shape":"SavingsPlansUtilizationDetails", + "documentation":"

Retrieves a single daily or monthly Savings Plans utilization rate and details for your account.

" + }, + "Total":{ + "shape":"SavingsPlansUtilizationAggregates", + "documentation":"

The total Savings Plans utilization, regardless of time period.

" + }, + "TimePeriod":{"shape":"DateInterval"}, + "NextToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetSavingsPlansUtilizationRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The time period that you want the usage and costs for. The Start date must be within 13 months. The End date must be after the Start date, and before the current date. Future dates can't be used as an End date.

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

The granularity of the Amazon Web Services utillization data for your Savings Plans.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

Filters Savings Plans utilization coverage data for active Savings Plans dimensions. You can filter data with the following dimensions:

  • LINKED_ACCOUNT

  • SAVINGS_PLAN_ARN

  • SAVINGS_PLANS_TYPE

  • REGION

  • PAYMENT_OPTIONS

  • INSTANCE_TYPE_FAMILY

GetSavingsPlansUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension. If there are multiple values for a dimension, they are OR'd together.

" + } + } + }, + "GetSavingsPlansUtilizationResponse":{ + "type":"structure", + "required":["Total"], + "members":{ + "SavingsPlansUtilizationsByTime":{ + "shape":"SavingsPlansUtilizationsByTime", + "documentation":"

The amount of time (in hours) ou used your Savings Plans. This allows you to specify date ranges.

" + }, + "Total":{ + "shape":"SavingsPlansUtilizationAggregates", + "documentation":"

The total amount of time that you used your Savings Plans, regardless of date ranges.

" + } + } + }, + "GetTagsRequest":{ + "type":"structure", + "required":["TimePeriod"], + "members":{ + "SearchString":{ + "shape":"SearchString", + "documentation":"

The value that you want to search for.

" + }, + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "TagKey":{ + "shape":"TagKey", + "documentation":"

The key of the tag that you want to return values for.

" + }, + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + } + } + }, + "GetTagsResponse":{ + "type":"structure", + "required":[ + "Tags", + "ReturnSize", + "TotalSize" + ], + "members":{ + "NextPageToken":{ + "shape":"NextPageToken", + "documentation":"

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags that match your request.

" + }, + "ReturnSize":{ + "shape":"PageSize", + "documentation":"

The number of query results that AWS returns at a time.

" + }, + "TotalSize":{ + "shape":"PageSize", + "documentation":"

The total number of query results.

" + } + } + }, + "GetUsageForecastRequest":{ + "type":"structure", + "required":[ + "TimePeriod", + "Metric", + "Granularity" + ], + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01, then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01.

" + }, + "Metric":{ + "shape":"Metric", + "documentation":"

Which metric Cost Explorer uses to create your forecast.

Valid values for a GetUsageForecast call are the following:

  • USAGE_QUANTITY

  • NORMALIZED_USAGE_AMOUNT

" + }, + "Granularity":{ + "shape":"Granularity", + "documentation":"

How granular you want the forecast to be. You can get 3 months of DAILY forecasts or 12 months of MONTHLY forecasts.

The GetUsageForecast operation supports only DAILY and MONTHLY granularities.

" + }, + "Filter":{ + "shape":"Expression", + "documentation":"

The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.

" + }, + "PredictionIntervalLevel":{ + "shape":"PredictionIntervalLevel", + "documentation":"

Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.

" + } + } + }, + "GetUsageForecastResponse":{ + "type":"structure", + "members":{ + "Total":{ + "shape":"MetricValue", + "documentation":"

How much you're forecasted to use over the forecast period.

" + }, + "ForecastResultsByTime":{ + "shape":"ForecastResultsByTime", + "documentation":"

The forecasts for your query, in order. For DAILY forecasts, this is a list of days. For MONTHLY forecasts, this is a list of months.

" + } + } + }, + "Granularity":{ + "type":"string", + "enum":[ + "DAILY", + "MONTHLY", + "HOURLY" + ] + }, + "Group":{ + "type":"structure", + "members":{ + "Keys":{ + "shape":"Keys", + "documentation":"

The keys that are included in this group.

" + }, + "Metrics":{ + "shape":"Metrics", + "documentation":"

The metrics that are included in this group.

" + } + }, + "documentation":"

One level of grouped data in the results.

" + }, + "GroupDefinition":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"GroupDefinitionType", + "documentation":"

The string that represents the type of group.

" + }, + "Key":{ + "shape":"GroupDefinitionKey", + "documentation":"

The string that represents a key for a specified group.

" + } + }, + "documentation":"

Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.

" + }, + "GroupDefinitionKey":{"type":"string"}, + "GroupDefinitionType":{ + "type":"string", + "enum":[ + "DIMENSION", + "TAG" + ] + }, + "GroupDefinitions":{ + "type":"list", + "member":{"shape":"GroupDefinition"} + }, + "Groups":{ + "type":"list", + "member":{"shape":"Group"} + }, + "InstanceDetails":{ + "type":"structure", + "members":{ + "EC2InstanceDetails":{ + "shape":"EC2InstanceDetails", + "documentation":"

The Amazon EC2 instances that AWS recommends that you purchase.

" + }, + "RDSInstanceDetails":{ + "shape":"RDSInstanceDetails", + "documentation":"

The Amazon RDS instances that AWS recommends that you purchase.

" + }, + "RedshiftInstanceDetails":{ + "shape":"RedshiftInstanceDetails", + "documentation":"

The Amazon Redshift instances that AWS recommends that you purchase.

" + }, + "ElastiCacheInstanceDetails":{ + "shape":"ElastiCacheInstanceDetails", + "documentation":"

The ElastiCache instances that AWS recommends that you purchase.

" + }, + "ESInstanceDetails":{ + "shape":"ESInstanceDetails", + "documentation":"

The Amazon ES instances that AWS recommends that you purchase.

" + } + }, + "documentation":"

Details about the instances that AWS recommends that you purchase.

" + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The pagination token is invalid. Try again without a pagination token.

", + "exception":true + }, + "Key":{"type":"string"}, + "Keys":{ + "type":"list", + "member":{"shape":"Key"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You made too many calls in a short period of time. Try again later.

", + "exception":true + }, + "LookbackPeriodInDays":{ + "type":"string", + "enum":[ + "SEVEN_DAYS", + "THIRTY_DAYS", + "SIXTY_DAYS" + ] + }, + "MaxResults":{ + "type":"integer", + "min":1 + }, + "Metric":{ + "type":"string", + "enum":[ + "BLENDED_COST", + "UNBLENDED_COST", + "AMORTIZED_COST", + "NET_UNBLENDED_COST", + "NET_AMORTIZED_COST", + "USAGE_QUANTITY", + "NORMALIZED_USAGE_AMOUNT" + ] + }, + "MetricAmount":{"type":"string"}, + "MetricName":{"type":"string"}, + "MetricNames":{ + "type":"list", + "member":{"shape":"MetricName"} + }, + "MetricUnit":{"type":"string"}, + "MetricValue":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"MetricAmount", + "documentation":"

The actual number that represents the metric.

" + }, + "Unit":{ + "shape":"MetricUnit", + "documentation":"

The unit that the metric is given in.

" + } + }, + "documentation":"

The aggregated value for a metric.

" + }, + "Metrics":{ + "type":"map", + "key":{"shape":"MetricName"}, + "value":{"shape":"MetricValue"} + }, + "ModifyRecommendationDetail":{ + "type":"structure", + "members":{ + "TargetInstances":{ + "shape":"TargetInstancesList", + "documentation":"

Identifies whether this instance type is the Amazon Web Services default recommendation.

" + } + }, + "documentation":"

Details on the modification recommendation.

" + }, + "NetRISavings":{"type":"string"}, + "NextPageToken":{"type":"string"}, + "NonNegativeInteger":{ + "type":"integer", + "min":0 + }, + "OfferingClass":{ + "type":"string", + "enum":[ + "STANDARD", + "CONVERTIBLE" + ] + }, + "OnDemandCost":{"type":"string"}, + "OnDemandCostOfRIHoursUsed":{"type":"string"}, + "OnDemandHours":{"type":"string"}, + "OnDemandNormalizedUnits":{"type":"string"}, + "PageSize":{"type":"integer"}, + "PaymentOption":{ + "type":"string", + "enum":[ + "NO_UPFRONT", + "PARTIAL_UPFRONT", + "ALL_UPFRONT", + "LIGHT_UTILIZATION", + "MEDIUM_UTILIZATION", + "HEAVY_UTILIZATION" + ] + }, + "PredictionIntervalLevel":{ + "type":"integer", + "max":99, + "min":51 + }, + "PurchasedHours":{"type":"string"}, + "PurchasedUnits":{"type":"string"}, + "RDSInstanceDetails":{ + "type":"structure", + "members":{ + "Family":{ + "shape":"GenericString", + "documentation":"

The instance family of the recommended reservation.

" + }, + "InstanceType":{ + "shape":"GenericString", + "documentation":"

The type of instance that AWS recommends.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The AWS Region of the recommended reservation.

" + }, + "DatabaseEngine":{ + "shape":"GenericString", + "documentation":"

The database engine that the recommended reservation supports.

" + }, + "DatabaseEdition":{ + "shape":"GenericString", + "documentation":"

The database edition that the recommended reservation supports.

" + }, + "DeploymentOption":{ + "shape":"GenericString", + "documentation":"

Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.

" + }, + "LicenseModel":{ + "shape":"GenericString", + "documentation":"

The license model that the recommended reservation supports.

" + }, + "CurrentGeneration":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommendation is for a current-generation instance.

" + }, + "SizeFlexEligible":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommended reservation is size flexible.

" + } + }, + "documentation":"

Details about the Amazon RDS instances that AWS recommends that you purchase.

" + }, + "RedshiftInstanceDetails":{ + "type":"structure", + "members":{ + "Family":{ + "shape":"GenericString", + "documentation":"

The instance family of the recommended reservation.

" + }, + "NodeType":{ + "shape":"GenericString", + "documentation":"

The type of node that AWS recommends.

" + }, + "Region":{ + "shape":"GenericString", + "documentation":"

The AWS Region of the recommended reservation.

" + }, + "CurrentGeneration":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommendation is for a current-generation instance.

" + }, + "SizeFlexEligible":{ + "shape":"GenericBoolean", + "documentation":"

Whether the recommended reservation is size flexible.

" + } + }, + "documentation":"

Details about the Amazon Redshift instances that AWS recommends that you purchase.

" + }, + "RequestChangedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Your request parameters changed between pages. Try again with the old parameters or without a pagination token.

", + "exception":true + }, + "ReservationAggregates":{ + "type":"structure", + "members":{ + "UtilizationPercentage":{ + "shape":"UtilizationPercentage", + "documentation":"

The percentage of reservation time that you used.

" + }, + "UtilizationPercentageInUnits":{ + "shape":"UtilizationPercentageInUnits", + "documentation":"

The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + }, + "PurchasedHours":{ + "shape":"PurchasedHours", + "documentation":"

How many reservation hours that you purchased.

" + }, + "PurchasedUnits":{ + "shape":"PurchasedUnits", + "documentation":"

How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + }, + "TotalActualHours":{ + "shape":"TotalActualHours", + "documentation":"

The total number of reservation hours that you used.

" + }, + "TotalActualUnits":{ + "shape":"TotalActualUnits", + "documentation":"

The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + }, + "UnusedHours":{ + "shape":"UnusedHours", + "documentation":"

The number of reservation hours that you didn't use.

" + }, + "UnusedUnits":{ + "shape":"UnusedUnits", + "documentation":"

The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

" + }, + "OnDemandCostOfRIHoursUsed":{ + "shape":"OnDemandCostOfRIHoursUsed", + "documentation":"

How much your reservation would cost if charged On-Demand rates.

" + }, + "NetRISavings":{ + "shape":"NetRISavings", + "documentation":"

How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed.

" + }, + "TotalPotentialRISavings":{ + "shape":"TotalPotentialRISavings", + "documentation":"

How much you could save if you use your entire reservation.

" + }, + "AmortizedUpfrontFee":{ + "shape":"AmortizedUpfrontFee", + "documentation":"

The upfront cost of your reservation, amortized over the reservation period.

" + }, + "AmortizedRecurringFee":{ + "shape":"AmortizedRecurringFee", + "documentation":"

The monthly cost of your reservation, amortized over the reservation period.

" + }, + "TotalAmortizedFee":{ + "shape":"TotalAmortizedFee", + "documentation":"

The total cost of your reservation, amortized over the reservation period.

" + } + }, + "documentation":"

The aggregated numbers for your reservation usage.

" + }, + "ReservationCoverageGroup":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"Attributes", + "documentation":"

The attributes for this group of reservations.

" + }, + "Coverage":{ + "shape":"Coverage", + "documentation":"

How much instance usage this group of reservations covered.

" + } + }, + "documentation":"

A group of reservations that share a set of attributes.

" + }, + "ReservationCoverageGroups":{ + "type":"list", + "member":{"shape":"ReservationCoverageGroup"} + }, + "ReservationGroupKey":{"type":"string"}, + "ReservationGroupValue":{"type":"string"}, + "ReservationPurchaseRecommendation":{ + "type":"structure", + "members":{ + "AccountScope":{ + "shape":"AccountScope", + "documentation":"

The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.

" + }, + "LookbackPeriodInDays":{ + "shape":"LookbackPeriodInDays", + "documentation":"

How many days of previous usage that AWS considers when making this recommendation.

" + }, + "TermInYears":{ + "shape":"TermInYears", + "documentation":"

The term of the reservation that you want recommendations for, in years.

" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option for the reservation. For example, AllUpfront or NoUpfront.

" + }, + "ServiceSpecification":{ + "shape":"ServiceSpecification", + "documentation":"

Hardware specifications for the service that you want recommendations for.

" + }, + "RecommendationDetails":{ + "shape":"ReservationPurchaseRecommendationDetails", + "documentation":"

Details about the recommended purchases.

" + }, + "RecommendationSummary":{ + "shape":"ReservationPurchaseRecommendationSummary", + "documentation":"

A summary about the recommended purchase.

" + } + }, + "documentation":"

A specific reservation that AWS recommends for purchase.

" + }, + "ReservationPurchaseRecommendationDetail":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"GenericString", + "documentation":"

The account that this RI recommendation is for.

" + }, + "InstanceDetails":{ + "shape":"InstanceDetails", + "documentation":"

Details about the instances that AWS recommends that you purchase.

" + }, + "RecommendedNumberOfInstancesToPurchase":{ + "shape":"GenericString", + "documentation":"

The number of instances that AWS recommends that you purchase.

" + }, + "RecommendedNormalizedUnitsToPurchase":{ + "shape":"GenericString", + "documentation":"

The number of normalized units that AWS recommends that you purchase.

" + }, + "MinimumNumberOfInstancesUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "MinimumNormalizedUnitsUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "MaximumNumberOfInstancesUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "MaximumNormalizedUnitsUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "AverageNumberOfInstancesUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "AverageNormalizedUnitsUsedPerHour":{ + "shape":"GenericString", + "documentation":"

The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.

" + }, + "AverageUtilization":{ + "shape":"GenericString", + "documentation":"

The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.

" + }, + "EstimatedBreakEvenInMonths":{ + "shape":"GenericString", + "documentation":"

How long AWS estimates that it takes for this instance to start saving you money, in months.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code that AWS used to calculate the costs for this instance.

" + }, + "EstimatedMonthlySavingsAmount":{ + "shape":"GenericString", + "documentation":"

How much AWS estimates that this specific recommendation could save you in a month.

" + }, + "EstimatedMonthlySavingsPercentage":{ + "shape":"GenericString", + "documentation":"

How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.

" + }, + "EstimatedMonthlyOnDemandCost":{ + "shape":"GenericString", + "documentation":"

How much AWS estimates that you spend on On-Demand Instances in a month.

" + }, + "EstimatedReservationCostForLookbackPeriod":{ + "shape":"GenericString", + "documentation":"

How much AWS estimates that you would have spent for all usage during the specified historical period if you had a reservation.

" + }, + "UpfrontCost":{ + "shape":"GenericString", + "documentation":"

How much purchasing this instance costs you upfront.

" + }, + "RecurringStandardMonthlyCost":{ + "shape":"GenericString", + "documentation":"

How much purchasing this instance costs you on a monthly basis.

" + } + }, + "documentation":"

Details about your recommended reservation purchase.

" + }, + "ReservationPurchaseRecommendationDetails":{ + "type":"list", + "member":{"shape":"ReservationPurchaseRecommendationDetail"} + }, + "ReservationPurchaseRecommendationMetadata":{ + "type":"structure", + "members":{ + "RecommendationId":{ + "shape":"GenericString", + "documentation":"

The ID for this specific recommendation.

" + }, + "GenerationTimestamp":{ + "shape":"GenericString", + "documentation":"

The time stamp for when AWS made this recommendation.

" + } + }, + "documentation":"

Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.

" + }, + "ReservationPurchaseRecommendationSummary":{ + "type":"structure", + "members":{ + "TotalEstimatedMonthlySavingsAmount":{ + "shape":"GenericString", + "documentation":"

The total amount that AWS estimates that this recommendation could save you in a month.

" + }, + "TotalEstimatedMonthlySavingsPercentage":{ + "shape":"GenericString", + "documentation":"

The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code used for this recommendation.

" + } + }, + "documentation":"

A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.

" + }, + "ReservationPurchaseRecommendations":{ + "type":"list", + "member":{"shape":"ReservationPurchaseRecommendation"} + }, + "ReservationUtilizationGroup":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ReservationGroupKey", + "documentation":"

The key for a specific reservation attribute.

" + }, + "Value":{ + "shape":"ReservationGroupValue", + "documentation":"

The value of a specific reservation attribute.

" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

The attributes for this group of reservations.

" + }, + "Utilization":{ + "shape":"ReservationAggregates", + "documentation":"

How much you used this group of reservations.

" + } + }, + "documentation":"

A group of reservations that share a set of attributes.

" + }, + "ReservationUtilizationGroups":{ + "type":"list", + "member":{"shape":"ReservationUtilizationGroup"} + }, + "ReservedHours":{"type":"string"}, + "ReservedNormalizedUnits":{"type":"string"}, + "ResourceDetails":{ + "type":"structure", + "members":{ + "EC2ResourceDetails":{ + "shape":"EC2ResourceDetails", + "documentation":"

Details on the Amazon EC2 resource.

" + } + }, + "documentation":"

Details on the resource.

" + }, + "ResourceUtilization":{ + "type":"structure", + "members":{ + "EC2ResourceUtilization":{ + "shape":"EC2ResourceUtilization", + "documentation":"

Utilization of current Amazon EC2 Instance

" + } + }, + "documentation":"

Resource utilization of current resource.

" + }, + "ResultByTime":{ + "type":"structure", + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The time period that the result covers.

" + }, + "Total":{ + "shape":"Metrics", + "documentation":"

The total amount of cost or usage accrued during the time period.

" + }, + "Groups":{ + "shape":"Groups", + "documentation":"

The groups that this time period includes.

" + }, + "Estimated":{ + "shape":"Estimated", + "documentation":"

Whether the result is estimated.

" + } + }, + "documentation":"

The result that is associated with a time period.

" + }, + "ResultsByTime":{ + "type":"list", + "member":{"shape":"ResultByTime"} + }, + "RightsizingRecommendation":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"GenericString", + "documentation":"

The account that this recommendation is for.

" + }, + "CurrentInstance":{ + "shape":"CurrentInstance", + "documentation":"

Context regarding the current instance.

" + }, + "RightsizingType":{ + "shape":"RightsizingType", + "documentation":"

Recommendation to either terminate or modify the resource.

" + }, + "ModifyRecommendationDetail":{ + "shape":"ModifyRecommendationDetail", + "documentation":"

Details for modification recommendations.

" + }, + "TerminateRecommendationDetail":{ + "shape":"TerminateRecommendationDetail", + "documentation":"

Details for termination recommendations.

" + } + }, + "documentation":"

Recommendations to rightsize resources.

" + }, + "RightsizingRecommendationList":{ + "type":"list", + "member":{"shape":"RightsizingRecommendation"} + }, + "RightsizingRecommendationMetadata":{ + "type":"structure", + "members":{ + "RecommendationId":{ + "shape":"GenericString", + "documentation":"

The ID for this specific recommendation.

" + }, + "GenerationTimestamp":{ + "shape":"GenericString", + "documentation":"

The time stamp for when Amazon Web Services made this recommendation.

" + }, + "LookbackPeriodInDays":{ + "shape":"LookbackPeriodInDays", + "documentation":"

How many days of previous usage that Amazon Web Services considers when making this recommendation.

" + } + }, + "documentation":"

Metadata for this recommendation set.

" + }, + "RightsizingRecommendationSummary":{ + "type":"structure", + "members":{ + "TotalRecommendationCount":{ + "shape":"GenericString", + "documentation":"

Total number of instance recommendations.

" + }, + "EstimatedTotalMonthlySavingsAmount":{ + "shape":"GenericString", + "documentation":"

Estimated total savings resulting from modifications, on a monthly basis.

" + }, + "SavingsCurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code that Amazon Web Services used to calculate the savings.

" + }, + "SavingsPercentage":{ + "shape":"GenericString", + "documentation":"

Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.

" + } + }, + "documentation":"

Summary of rightsizing recommendations

" + }, + "RightsizingType":{ + "type":"string", + "enum":[ + "TERMINATE", + "MODIFY" + ] + }, + "SavingsPlanArn":{"type":"string"}, + "SavingsPlansAmortizedCommitment":{ + "type":"structure", + "members":{ + "AmortizedRecurringCommitment":{ + "shape":"GenericString", + "documentation":"

The amortized amount of your Savings Plans commitment that was purchased with either a Partial or a NoUpfront.

" + }, + "AmortizedUpfrontCommitment":{ + "shape":"GenericString", + "documentation":"

The amortized amount of your Savings Plans commitment that was purchased with an Upfront or PartialUpfront Savings Plans.

" + }, + "TotalAmortizedCommitment":{ + "shape":"GenericString", + "documentation":"

The total amortized amount of your Savings Plans commitment, regardless of your Savings Plans purchase method.

" + } + }, + "documentation":"

The amortized amount of Savings Plans purchased in a specific account during a specific time interval.

" + }, + "SavingsPlansCoverage":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"Attributes", + "documentation":"

The attribute that applies to a specific Dimension.

" + }, + "Coverage":{ + "shape":"SavingsPlansCoverageData", + "documentation":"

The amount of Savings Plans eligible usage that the Savings Plans covered.

" + }, + "TimePeriod":{"shape":"DateInterval"} + }, + "documentation":"

The amount of Savings Plans eligible usage that is covered by Savings Plans. All calculations consider the On-Demand equivalent of your Savings Plans usage.

" + }, + "SavingsPlansCoverageData":{ + "type":"structure", + "members":{ + "SpendCoveredBySavingsPlans":{ + "shape":"GenericString", + "documentation":"

The amount of your Amazon Web Services usage that is covered by a Savings Plans.

" + }, + "OnDemandCost":{ + "shape":"GenericString", + "documentation":"

The cost of your Amazon Web Services usage at the public On-Demand rate.

" + }, + "TotalCost":{ + "shape":"GenericString", + "documentation":"

The total cost of your Amazon Web Services usage, regardless of your purchase option.

" + }, + "CoveragePercentage":{ + "shape":"GenericString", + "documentation":"

The percentage of your existing Savings Planscovered usage, divided by all of your eligible Savings Plans usage in an account(or set of accounts).

" + } + }, + "documentation":"

Specific coverage percentage, On-Demand costs, and spend covered by Savings Plans, and total Savings Plans costs for an account.

" + }, + "SavingsPlansCoverages":{ + "type":"list", + "member":{"shape":"SavingsPlansCoverage"} + }, + "SavingsPlansDetails":{ + "type":"structure", + "members":{ + "Region":{ + "shape":"GenericString", + "documentation":"

A geographic location where the Savings Plans is hosted.

" + }, + "InstanceFamily":{ + "shape":"GenericString", + "documentation":"

A group of instance types that Savings Plans applies to.

" + }, + "OfferingId":{ + "shape":"GenericString", + "documentation":"

The unique ID used to distinguish Savings Plans from one another.

" + } + }, + "documentation":"

Attribute details on a specific Savings Plan.

" + }, + "SavingsPlansPurchaseRecommendation":{ + "type":"structure", + "members":{ + "SavingsPlansType":{ + "shape":"SupportedSavingsPlansType", + "documentation":"

The requested Savings Plans recommendation type.

" + }, + "TermInYears":{ + "shape":"TermInYears", + "documentation":"

The Savings Plans recommendation term in years, used to generate the recommendation.

" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option used to generate the recommendation.

" + }, + "LookbackPeriodInDays":{ + "shape":"LookbackPeriodInDays", + "documentation":"

The lookback period in days, used to generate the recommendation.

" + }, + "SavingsPlansPurchaseRecommendationDetails":{ + "shape":"SavingsPlansPurchaseRecommendationDetailList", + "documentation":"

Details for the Savings Plans we recommend you to purchase to cover existing, Savings Plans eligible workloads.

" + }, + "SavingsPlansPurchaseRecommendationSummary":{ + "shape":"SavingsPlansPurchaseRecommendationSummary", + "documentation":"

Summary metrics for your Savings Plans Recommendations.

" + } + }, + "documentation":"

Contains your request parameters, Savings Plan Recommendations Summary, and Details.

" + }, + "SavingsPlansPurchaseRecommendationDetail":{ + "type":"structure", + "members":{ + "SavingsPlansDetails":{ + "shape":"SavingsPlansDetails", + "documentation":"

Details for your recommended Savings Plans.

" + }, + "AccountId":{ + "shape":"GenericString", + "documentation":"

The AccountID the recommendation is generated for.

" + }, + "UpfrontCost":{ + "shape":"GenericString", + "documentation":"

The upfront cost of the recommended Savings Plans, based on the selected payment option.

" + }, + "EstimatedROI":{ + "shape":"GenericString", + "documentation":"

The estimated return on investment based on the recommended Savings Plans purchased. This is calculated as estimatedSavingsAmount/ estimatedSPCost*100.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code Amazon Web Services used to generate the recommendations and present potential savings.

" + }, + "EstimatedSPCost":{ + "shape":"GenericString", + "documentation":"

The cost of the recommended Savings Plans over the length of the lookback period.

" + }, + "EstimatedOnDemandCost":{ + "shape":"GenericString", + "documentation":"

The remaining On-Demand cost estimated to not be covered by the recommended Savings Plans, over the length of the lookback period.

" + }, + "EstimatedSavingsAmount":{ + "shape":"GenericString", + "documentation":"

The estimated savings amount based on the recommended Savings Plans over the length of the lookback period.

" + }, + "EstimatedSavingsPercentage":{ + "shape":"GenericString", + "documentation":"

The estimated savings percentage relative to the total cost of applicable On-Demand usage over the lookback period.

" + }, + "HourlyCommitmentToPurchase":{ + "shape":"GenericString", + "documentation":"

The recommended hourly commitment level for the Savings Plans type, and configuration based on the usage during the lookback period.

" + }, + "EstimatedAverageUtilization":{ + "shape":"GenericString", + "documentation":"

The estimated utilization of the recommended Savings Plans.

" + }, + "EstimatedMonthlySavingsAmount":{ + "shape":"GenericString", + "documentation":"

The estimated monthly savings amount, based on the recommended Savings Plans.

" + }, + "CurrentMinimumHourlyOnDemandSpend":{ + "shape":"GenericString", + "documentation":"

The lowest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + }, + "CurrentMaximumHourlyOnDemandSpend":{ + "shape":"GenericString", + "documentation":"

The highest value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + }, + "CurrentAverageHourlyOnDemandSpend":{ + "shape":"GenericString", + "documentation":"

The average value of hourly On-Demand spend over the lookback period of the applicable usage type.

" + } + }, + "documentation":"

Details for your recommended Savings Plans.

" + }, + "SavingsPlansPurchaseRecommendationDetailList":{ + "type":"list", + "member":{"shape":"SavingsPlansPurchaseRecommendationDetail"} + }, + "SavingsPlansPurchaseRecommendationMetadata":{ + "type":"structure", + "members":{ + "RecommendationId":{ + "shape":"GenericString", + "documentation":"

The unique identifier for the recommendation set.

" + }, + "GenerationTimestamp":{ + "shape":"GenericString", + "documentation":"

The timestamp showing when the recommendations were generated.

" + } + }, + "documentation":"

Metadata about your Savings Plans Purchase Recommendations.

" + }, + "SavingsPlansPurchaseRecommendationSummary":{ + "type":"structure", + "members":{ + "EstimatedROI":{ + "shape":"GenericString", + "documentation":"

The estimated return on investment based on the recommended Savings Plans and estimated savings.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code Amazon Web Services used to generate the recommendations and present potential savings.

" + }, + "EstimatedTotalCost":{ + "shape":"GenericString", + "documentation":"

The estimated total cost of the usage after purchasing the recommended Savings Plans. This is a sum of the cost of Savings Plans during this term, and the remaining On-Demand usage.

" + }, + "CurrentOnDemandSpend":{ + "shape":"GenericString", + "documentation":"

The current total on demand spend of the applicable usage types over the lookback period.

" + }, + "EstimatedSavingsAmount":{ + "shape":"GenericString", + "documentation":"

The estimated total savings over the lookback period, based on the purchase of the recommended Savings Plans.

" + }, + "TotalRecommendationCount":{ + "shape":"GenericString", + "documentation":"

The aggregate number of Savings Plans recommendations that exist for your account.

" + }, + "DailyCommitmentToPurchase":{ + "shape":"GenericString", + "documentation":"

The recommended Savings Plans cost on a daily (24 hourly) basis.

" + }, + "HourlyCommitmentToPurchase":{ + "shape":"GenericString", + "documentation":"

The recommended hourly commitment based on the recommendation parameters.

" + }, + "EstimatedSavingsPercentage":{ + "shape":"GenericString", + "documentation":"

The estimated savings relative to the total cost of On-Demand usage, over the lookback period. This is calculated as estimatedSavingsAmount/ CurrentOnDemandSpend*100.

" + }, + "EstimatedMonthlySavingsAmount":{ + "shape":"GenericString", + "documentation":"

The estimated monthly savings amount, based on the recommended Savings Plans purchase.

" + } + }, + "documentation":"

Summary metrics for your Savings Plans Purchase Recommendations.

" + }, + "SavingsPlansSavings":{ + "type":"structure", + "members":{ + "NetSavings":{ + "shape":"GenericString", + "documentation":"

The savings amount that you are accumulating for the usage that is covered by a Savings Plans, when compared to the On-Demand equivalent of the same usage.

" + }, + "OnDemandCostEquivalent":{ + "shape":"GenericString", + "documentation":"

How much the amount that the usage would have cost if it was accrued at the On-Demand rate.

" + } + }, + "documentation":"

The amount of savings you're accumulating, against the public On-Demand rate of the usage accrued in an account.

" + }, + "SavingsPlansUtilization":{ + "type":"structure", + "members":{ + "TotalCommitment":{ + "shape":"GenericString", + "documentation":"

The total amount of Savings Plans commitment that's been purchased in an account (or set of accounts).

" + }, + "UsedCommitment":{ + "shape":"GenericString", + "documentation":"

The amount of your Savings Plans commitment that was not consumed from Savings Plans eligible usage in a specific period.

" + }, + "UnusedCommitment":{ + "shape":"GenericString", + "documentation":"

The amount of your Savings Plans commitment that was not consumed from Savings Plans eligible usage in a specific period.

" + }, + "UtilizationPercentage":{ + "shape":"GenericString", + "documentation":"

The amount of UsedCommitment divided by the TotalCommitment for your Savings Plans.

" + } + }, + "documentation":"

The measurement of how well you are using your existing Savings Plans.

" + }, + "SavingsPlansUtilizationAggregates":{ + "type":"structure", + "required":["Utilization"], + "members":{ + "Utilization":{ + "shape":"SavingsPlansUtilization", + "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" + }, + "Savings":{ + "shape":"SavingsPlansSavings", + "documentation":"

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans, as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + }, + "AmortizedCommitment":{ + "shape":"SavingsPlansAmortizedCommitment", + "documentation":"

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + } + }, + "documentation":"

The aggregated utilization metrics for your Savings Plans usage.

" + }, + "SavingsPlansUtilizationByTime":{ + "type":"structure", + "required":[ + "TimePeriod", + "Utilization" + ], + "members":{ + "TimePeriod":{"shape":"DateInterval"}, + "Utilization":{ + "shape":"SavingsPlansUtilization", + "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" + }, + "Savings":{ + "shape":"SavingsPlansSavings", + "documentation":"

The amount saved by using existing Savings Plans. Savings returns both net savings from Savings Plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + }, + "AmortizedCommitment":{ + "shape":"SavingsPlansAmortizedCommitment", + "documentation":"

The total amortized commitment for a Savings Plans. This includes the sum of the upfront and recurring Savings Plans fees.

" + } + }, + "documentation":"

The amount of Savings Plans utilization, in hours.

" + }, + "SavingsPlansUtilizationDetail":{ + "type":"structure", + "members":{ + "SavingsPlanArn":{ + "shape":"SavingsPlanArn", + "documentation":"

The unique Amazon Resource Name (ARN) for a particular Savings Plan.

" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

The attribute that applies to a specific Dimension.

" + }, + "Utilization":{ + "shape":"SavingsPlansUtilization", + "documentation":"

A ratio of your effectiveness of using existing Savings Plans to apply to workloads that are Savings Plans eligible.

" + }, + "Savings":{ + "shape":"SavingsPlansSavings", + "documentation":"

The amount saved by using existing Savings Plans. Savings returns both net savings from savings plans as well as the onDemandCostEquivalent of the Savings Plans when considering the utilization rate.

" + }, + "AmortizedCommitment":{ + "shape":"SavingsPlansAmortizedCommitment", + "documentation":"

The total amortized commitment for a Savings Plans. Includes the sum of the upfront and recurring Savings Plans fees.

" + } + }, + "documentation":"

A single daily or monthly Savings Plans utilization rate, and details for your account. Master accounts in an organization have access to member accounts. You can use GetDimensionValues to determine the possible dimension values.

" + }, + "SavingsPlansUtilizationDetails":{ + "type":"list", + "member":{"shape":"SavingsPlansUtilizationDetail"} + }, + "SavingsPlansUtilizationsByTime":{ + "type":"list", + "member":{"shape":"SavingsPlansUtilizationByTime"} + }, + "SearchString":{"type":"string"}, + "ServiceSpecification":{ + "type":"structure", + "members":{ + "EC2Specification":{ + "shape":"EC2Specification", + "documentation":"

The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.

" + } + }, + "documentation":"

Hardware specifications for the service that you want recommendations for.

" + }, + "SupportedSavingsPlansType":{ + "type":"string", + "enum":[ + "COMPUTE_SP", + "EC2_INSTANCE_SP" + ] + }, + "TagKey":{"type":"string"}, + "TagList":{ + "type":"list", + "member":{"shape":"Entity"} + }, + "TagValues":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key for the tag.

" + }, + "Values":{ + "shape":"Values", + "documentation":"

The specific value of the tag.

" + } + }, + "documentation":"

The values that are available for a tag.

" + }, + "TagValuesList":{ + "type":"list", + "member":{"shape":"TagValues"} + }, + "TargetInstance":{ + "type":"structure", + "members":{ + "EstimatedMonthlyCost":{ + "shape":"GenericString", + "documentation":"

Expected cost to operate this instance type on a monthly basis.

" + }, + "EstimatedMonthlySavings":{ + "shape":"GenericString", + "documentation":"

Estimated savings resulting from modification, on a monthly basis.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + }, + "DefaultTargetInstance":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether or not this recommendation is the defaulted Amazon Web Services recommendation.

" + }, + "ResourceDetails":{ + "shape":"ResourceDetails", + "documentation":"

Details on the target instance type.

" + }, + "ExpectedResourceUtilization":{ + "shape":"ResourceUtilization", + "documentation":"

Expected utilization metrics for target instance type.

" + } + }, + "documentation":"

Details on recommended instance.

" + }, + "TargetInstancesList":{ + "type":"list", + "member":{"shape":"TargetInstance"} + }, + "TermInYears":{ + "type":"string", + "enum":[ + "ONE_YEAR", + "THREE_YEARS" + ] + }, + "TerminateRecommendationDetail":{ + "type":"structure", + "members":{ + "EstimatedMonthlySavings":{ + "shape":"GenericString", + "documentation":"

Estimated savings resulting from modification, on a monthly basis.

" + }, + "CurrencyCode":{ + "shape":"GenericString", + "documentation":"

The currency code that Amazon Web Services used to calculate the costs for this instance.

" + } + }, + "documentation":"

Details on termination recommendation.

" + }, + "TotalActualHours":{"type":"string"}, + "TotalActualUnits":{"type":"string"}, + "TotalAmortizedFee":{"type":"string"}, + "TotalPotentialRISavings":{"type":"string"}, + "TotalRunningHours":{"type":"string"}, + "TotalRunningNormalizedUnits":{"type":"string"}, + "UnresolvableUsageUnitException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Cost Explorer was unable to identify the usage unit. Provide UsageType/UsageTypeGroup filter selections that contain matching units, for example: hours.

", + "exception":true + }, + "UnusedHours":{"type":"string"}, + "UnusedUnits":{"type":"string"}, + "UtilizationByTime":{ + "type":"structure", + "members":{ + "TimePeriod":{ + "shape":"DateInterval", + "documentation":"

The period of time that this utilization was used for.

" + }, + "Groups":{ + "shape":"ReservationUtilizationGroups", + "documentation":"

The groups that this utilization result uses.

" + }, + "Total":{ + "shape":"ReservationAggregates", + "documentation":"

The total number of reservation hours that were used.

" + } + }, + "documentation":"

The amount of utilization, in hours.

" + }, + "UtilizationPercentage":{"type":"string"}, + "UtilizationPercentageInUnits":{"type":"string"}, + "UtilizationsByTime":{ + "type":"list", + "member":{"shape":"UtilizationByTime"} + }, + "Value":{"type":"string"}, + "Values":{ + "type":"list", + "member":{"shape":"Value"} + }, + "YearMonthDay":{ + "type":"string", + "pattern":"(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?" + } + }, + "documentation":"

The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment.

Service Endpoint

The Cost Explorer API provides the following endpoint:

  • https://ce.us-east-1.amazonaws.com

For information about costs associated with the Cost Explorer API, see AWS Cost Management Pricing.

" +} diff --git a/aws/dist/botocore/data/chime/2018-05-01/paginators-1.json b/aws/dist/botocore/data/chime/2018-05-01/paginators-1.json new file mode 100644 index 00000000..617b1149 --- /dev/null +++ b/aws/dist/botocore/data/chime/2018-05-01/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListAccounts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Accounts" + }, + "ListUsers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Users" + } + } +} diff --git a/aws/dist/botocore/data/chime/2018-05-01/service-2.json b/aws/dist/botocore/data/chime/2018-05-01/service-2.json new file mode 100644 index 00000000..7f4f42cd --- /dev/null +++ b/aws/dist/botocore/data/chime/2018-05-01/service-2.json @@ -0,0 +1,4372 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-01", + "endpointPrefix":"chime", + "protocol":"rest-json", + "serviceFullName":"Amazon Chime", + "serviceId":"Chime", + "signatureVersion":"v4", + "uid":"chime-2018-05-01" + }, + "operations":{ + "AssociatePhoneNumberWithUser":{ + "name":"AssociatePhoneNumberWithUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users/{userId}?operation=associate-phone-number", + "responseCode":200 + }, + "input":{"shape":"AssociatePhoneNumberWithUserRequest"}, + "output":{"shape":"AssociatePhoneNumberWithUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Associates a phone number with the specified Amazon Chime user.

" + }, + "AssociatePhoneNumbersWithVoiceConnector":{ + "name":"AssociatePhoneNumbersWithVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}?operation=associate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorRequest"}, + "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Associates phone numbers with the specified Amazon Chime Voice Connector.

" + }, + "AssociatePhoneNumbersWithVoiceConnectorGroup":{ + "name":"AssociatePhoneNumbersWithVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=associate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupRequest"}, + "output":{"shape":"AssociatePhoneNumbersWithVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Associates phone numbers with the specified Amazon Chime Voice Connector group.

" + }, + "BatchDeletePhoneNumber":{ + "name":"BatchDeletePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers?operation=batch-delete", + "responseCode":200 + }, + "input":{"shape":"BatchDeletePhoneNumberRequest"}, + "output":{"shape":"BatchDeletePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

" + }, + "BatchSuspendUser":{ + "name":"BatchSuspendUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users?operation=suspend", + "responseCode":200 + }, + "input":{"shape":"BatchSuspendUserRequest"}, + "output":{"shape":"BatchSuspendUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

" + }, + "BatchUnsuspendUser":{ + "name":"BatchUnsuspendUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users?operation=unsuspend", + "responseCode":200 + }, + "input":{"shape":"BatchUnsuspendUserRequest"}, + "output":{"shape":"BatchUnsuspendUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

" + }, + "BatchUpdatePhoneNumber":{ + "name":"BatchUpdatePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers?operation=batch-update", + "responseCode":200 + }, + "input":{"shape":"BatchUpdatePhoneNumberRequest"}, + "output":{"shape":"BatchUpdatePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates phone number product types or calling names. You can update one attribute at a time for each UpdatePhoneNumberRequestItem. For example, you can update either the product type or the calling name.

For product types, choose from Amazon Chime Business Calling and Amazon Chime Voice Connector. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

" + }, + "BatchUpdateUser":{ + "name":"BatchUpdateUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users", + "responseCode":200 + }, + "input":{"shape":"BatchUpdateUserRequest"}, + "output":{"shape":"BatchUpdateUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

" + }, + "CreateAccount":{ + "name":"CreateAccount", + "http":{ + "method":"POST", + "requestUri":"/accounts", + "responseCode":201 + }, + "input":{"shape":"CreateAccountRequest"}, + "output":{"shape":"CreateAccountResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

" + }, + "CreateBot":{ + "name":"CreateBot", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/bots", + "responseCode":201 + }, + "input":{"shape":"CreateBotRequest"}, + "output":{"shape":"CreateBotResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Creates a bot for an Amazon Chime Enterprise account.

" + }, + "CreatePhoneNumberOrder":{ + "name":"CreatePhoneNumberOrder", + "http":{ + "method":"POST", + "requestUri":"/phone-number-orders", + "responseCode":201 + }, + "input":{"shape":"CreatePhoneNumberOrderRequest"}, + "output":{"shape":"CreatePhoneNumberOrderResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

" + }, + "CreateVoiceConnector":{ + "name":"CreateVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceConnectorRequest"}, + "output":{"shape":"CreateVoiceConnectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an Amazon Chime Voice Connector under the administrator's AWS account. You can choose to create an Amazon Chime Voice Connector in a specific AWS Region.

Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

" + }, + "CreateVoiceConnectorGroup":{ + "name":"CreateVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups", + "responseCode":201 + }, + "input":{"shape":"CreateVoiceConnectorGroupRequest"}, + "output":{"shape":"CreateVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an Amazon Chime Voice Connector group under the administrator's AWS account. You can associate up to three existing Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

" + }, + "DeleteAccount":{ + "name":"DeleteAccount", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{accountId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAccountRequest"}, + "output":{"shape":"DeleteAccountResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"UnprocessableEntityException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

" + }, + "DeleteEventsConfiguration":{ + "name":"DeleteEventsConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{accountId}/bots/{botId}/events-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteEventsConfigurationRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"} + ], + "documentation":"

Deletes the events configuration that allows a bot to receive outgoing events.

" + }, + "DeletePhoneNumber":{ + "name":"DeletePhoneNumber", + "http":{ + "method":"DELETE", + "requestUri":"/phone-numbers/{phoneNumberId}", + "responseCode":204 + }, + "input":{"shape":"DeletePhoneNumberRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Moves the specified phone number into the Deletion queue. A phone number must be disassociated from any users or Amazon Chime Voice Connectors before it can be deleted.

Deleted phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

" + }, + "DeleteVoiceConnector":{ + "name":"DeleteVoiceConnector", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

" + }, + "DeleteVoiceConnectorGroup":{ + "name":"DeleteVoiceConnectorGroup", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorGroupRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified Amazon Chime Voice Connector group. Any VoiceConnectorItems and phone numbers associated with the group must be removed before it can be deleted.

" + }, + "DeleteVoiceConnectorOrigination":{ + "name":"DeleteVoiceConnectorOrigination", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/origination", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorOriginationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the origination settings for the specified Amazon Chime Voice Connector.

" + }, + "DeleteVoiceConnectorStreamingConfiguration":{ + "name":"DeleteVoiceConnectorStreamingConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorStreamingConfigurationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the streaming configuration for the specified Amazon Chime Voice Connector.

" + }, + "DeleteVoiceConnectorTermination":{ + "name":"DeleteVoiceConnectorTermination", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorTerminationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the termination settings for the specified Amazon Chime Voice Connector.

" + }, + "DeleteVoiceConnectorTerminationCredentials":{ + "name":"DeleteVoiceConnectorTerminationCredentials", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials?operation=delete", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorTerminationCredentialsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified SIP credentials used by your equipment to authenticate during call termination.

" + }, + "DisassociatePhoneNumberFromUser":{ + "name":"DisassociatePhoneNumberFromUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users/{userId}?operation=disassociate-phone-number", + "responseCode":200 + }, + "input":{"shape":"DisassociatePhoneNumberFromUserRequest"}, + "output":{"shape":"DisassociatePhoneNumberFromUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Disassociates the primary provisioned phone number from the specified Amazon Chime user.

" + }, + "DisassociatePhoneNumbersFromVoiceConnector":{ + "name":"DisassociatePhoneNumbersFromVoiceConnector", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}?operation=disassociate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorRequest"}, + "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector.

" + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroup":{ + "name":"DisassociatePhoneNumbersFromVoiceConnectorGroup", + "http":{ + "method":"POST", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}?operation=disassociate-phone-numbers", + "responseCode":200 + }, + "input":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupRequest"}, + "output":{"shape":"DisassociatePhoneNumbersFromVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Disassociates the specified phone numbers from the specified Amazon Chime Voice Connector group.

" + }, + "GetAccount":{ + "name":"GetAccount", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}" + }, + "input":{"shape":"GetAccountRequest"}, + "output":{"shape":"GetAccountResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified Amazon Chime account, such as account type and supported licenses.

" + }, + "GetAccountSettings":{ + "name":"GetAccountSettings", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/settings" + }, + "input":{"shape":"GetAccountSettingsRequest"}, + "output":{"shape":"GetAccountSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

" + }, + "GetBot":{ + "name":"GetBot", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots/{botId}", + "responseCode":200 + }, + "input":{"shape":"GetBotRequest"}, + "output":{"shape":"GetBotResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.

" + }, + "GetEventsConfiguration":{ + "name":"GetEventsConfiguration", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots/{botId}/events-configuration", + "responseCode":200 + }, + "input":{"shape":"GetEventsConfigurationRequest"}, + "output":{"shape":"GetEventsConfigurationResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.

" + }, + "GetGlobalSettings":{ + "name":"GetGlobalSettings", + "http":{ + "method":"GET", + "requestUri":"/settings", + "responseCode":200 + }, + "output":{"shape":"GetGlobalSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

" + }, + "GetPhoneNumber":{ + "name":"GetPhoneNumber", + "http":{ + "method":"GET", + "requestUri":"/phone-numbers/{phoneNumberId}" + }, + "input":{"shape":"GetPhoneNumberRequest"}, + "output":{"shape":"GetPhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified phone number ID, such as associations, capabilities, and product type.

" + }, + "GetPhoneNumberOrder":{ + "name":"GetPhoneNumberOrder", + "http":{ + "method":"GET", + "requestUri":"/phone-number-orders/{phoneNumberOrderId}", + "responseCode":200 + }, + "input":{"shape":"GetPhoneNumberOrderRequest"}, + "output":{"shape":"GetPhoneNumberOrderResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified phone number order, such as order creation timestamp, phone numbers in E.164 format, product type, and order status.

" + }, + "GetPhoneNumberSettings":{ + "name":"GetPhoneNumberSettings", + "http":{ + "method":"GET", + "requestUri":"/settings/phone-number", + "responseCode":200 + }, + "output":{"shape":"GetPhoneNumberSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the phone number settings for the administrator's AWS account, such as the default outbound calling name.

" + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/users/{userId}", + "responseCode":200 + }, + "input":{"shape":"GetUserRequest"}, + "output":{"shape":"GetUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

" + }, + "GetUserSettings":{ + "name":"GetUserSettings", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/users/{userId}/settings", + "responseCode":200 + }, + "input":{"shape":"GetUserSettingsRequest"}, + "output":{"shape":"GetUserSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves settings for the specified user ID, such as any associated phone number settings.

" + }, + "GetVoiceConnector":{ + "name":"GetVoiceConnector", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorRequest"}, + "output":{"shape":"GetVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

" + }, + "GetVoiceConnectorGroup":{ + "name":"GetVoiceConnectorGroup", + "http":{ + "method":"GET", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorGroupRequest"}, + "output":{"shape":"GetVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves details for the specified Amazon Chime Voice Connector group, such as timestamps, name, and associated VoiceConnectorItems.

" + }, + "GetVoiceConnectorLoggingConfiguration":{ + "name":"GetVoiceConnectorLoggingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/logging-configuration", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorLoggingConfigurationRequest"}, + "output":{"shape":"GetVoiceConnectorLoggingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the logging configuration details for the specified Amazon Chime Voice Connector. Shows whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

" + }, + "GetVoiceConnectorOrigination":{ + "name":"GetVoiceConnectorOrigination", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/origination", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorOriginationRequest"}, + "output":{"shape":"GetVoiceConnectorOriginationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves origination setting details for the specified Amazon Chime Voice Connector.

" + }, + "GetVoiceConnectorStreamingConfiguration":{ + "name":"GetVoiceConnectorStreamingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorStreamingConfigurationRequest"}, + "output":{"shape":"GetVoiceConnectorStreamingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the streaming configuration details for the specified Amazon Chime Voice Connector. Shows whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

" + }, + "GetVoiceConnectorTermination":{ + "name":"GetVoiceConnectorTermination", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorTerminationRequest"}, + "output":{"shape":"GetVoiceConnectorTerminationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves termination setting details for the specified Amazon Chime Voice Connector.

" + }, + "GetVoiceConnectorTerminationHealth":{ + "name":"GetVoiceConnectorTerminationHealth", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/health", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorTerminationHealthRequest"}, + "output":{"shape":"GetVoiceConnectorTerminationHealthResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the last time a SIP OPTIONS ping was received from your SIP infrastructure for the specified Amazon Chime Voice Connector.

" + }, + "InviteUsers":{ + "name":"InviteUsers", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users?operation=add", + "responseCode":201 + }, + "input":{"shape":"InviteUsersRequest"}, + "output":{"shape":"InviteUsersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Sends email invites to as many as 50 users, inviting them to the specified Amazon Chime Team account. Only Team account types are currently supported for this action.

" + }, + "ListAccounts":{ + "name":"ListAccounts", + "http":{ + "method":"GET", + "requestUri":"/accounts" + }, + "input":{"shape":"ListAccountsRequest"}, + "output":{"shape":"ListAccountsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.

" + }, + "ListBots":{ + "name":"ListBots", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots", + "responseCode":200 + }, + "input":{"shape":"ListBotsRequest"}, + "output":{"shape":"ListBotsResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.

" + }, + "ListPhoneNumberOrders":{ + "name":"ListPhoneNumberOrders", + "http":{ + "method":"GET", + "requestUri":"/phone-number-orders", + "responseCode":200 + }, + "input":{"shape":"ListPhoneNumberOrdersRequest"}, + "output":{"shape":"ListPhoneNumberOrdersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the phone number orders for the administrator's Amazon Chime account.

" + }, + "ListPhoneNumbers":{ + "name":"ListPhoneNumbers", + "http":{ + "method":"GET", + "requestUri":"/phone-numbers" + }, + "input":{"shape":"ListPhoneNumbersRequest"}, + "output":{"shape":"ListPhoneNumbersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the phone numbers for the specified Amazon Chime account, Amazon Chime user, Amazon Chime Voice Connector, or Amazon Chime Voice Connector group.

" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/users", + "responseCode":200 + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

" + }, + "ListVoiceConnectorGroups":{ + "name":"ListVoiceConnectorGroups", + "http":{ + "method":"GET", + "requestUri":"/voice-connector-groups", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorGroupsRequest"}, + "output":{"shape":"ListVoiceConnectorGroupsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the Amazon Chime Voice Connector groups for the administrator's AWS account.

" + }, + "ListVoiceConnectorTerminationCredentials":{ + "name":"ListVoiceConnectorTerminationCredentials", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorTerminationCredentialsRequest"}, + "output":{"shape":"ListVoiceConnectorTerminationCredentialsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the SIP credentials for the specified Amazon Chime Voice Connector.

" + }, + "ListVoiceConnectors":{ + "name":"ListVoiceConnectors", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors", + "responseCode":200 + }, + "input":{"shape":"ListVoiceConnectorsRequest"}, + "output":{"shape":"ListVoiceConnectorsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the Amazon Chime Voice Connectors for the administrator's AWS account.

" + }, + "LogoutUser":{ + "name":"LogoutUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users/{userId}?operation=logout", + "responseCode":204 + }, + "input":{"shape":"LogoutUserRequest"}, + "output":{"shape":"LogoutUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Logs out the specified user from all of the devices they are currently logged into.

" + }, + "PutEventsConfiguration":{ + "name":"PutEventsConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{accountId}/bots/{botId}/events-configuration", + "responseCode":201 + }, + "input":{"shape":"PutEventsConfigurationRequest"}, + "output":{"shape":"PutEventsConfigurationResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.

" + }, + "PutVoiceConnectorLoggingConfiguration":{ + "name":"PutVoiceConnectorLoggingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/logging-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorLoggingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorLoggingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

" + }, + "PutVoiceConnectorOrigination":{ + "name":"PutVoiceConnectorOrigination", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/origination", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorOriginationRequest"}, + "output":{"shape":"PutVoiceConnectorOriginationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds origination settings for the specified Amazon Chime Voice Connector.

" + }, + "PutVoiceConnectorStreamingConfiguration":{ + "name":"PutVoiceConnectorStreamingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/streaming-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorStreamingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorStreamingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds a streaming configuration for the specified Amazon Chime Voice Connector. The streaming configuration specifies whether media streaming is enabled for sending to Amazon Kinesis, and sets the retention period for the Amazon Kinesis data, in hours.

" + }, + "PutVoiceConnectorTermination":{ + "name":"PutVoiceConnectorTermination", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorTerminationRequest"}, + "output":{"shape":"PutVoiceConnectorTerminationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds termination settings for the specified Amazon Chime Voice Connector.

" + }, + "PutVoiceConnectorTerminationCredentials":{ + "name":"PutVoiceConnectorTerminationCredentials", + "http":{ + "method":"POST", + "requestUri":"/voice-connectors/{voiceConnectorId}/termination/credentials?operation=put", + "responseCode":204 + }, + "input":{"shape":"PutVoiceConnectorTerminationCredentialsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

" + }, + "RegenerateSecurityToken":{ + "name":"RegenerateSecurityToken", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/bots/{botId}?operation=regenerate-security-token", + "responseCode":200 + }, + "input":{"shape":"RegenerateSecurityTokenRequest"}, + "output":{"shape":"RegenerateSecurityTokenResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Regenerates the security token for a bot.

" + }, + "ResetPersonalPIN":{ + "name":"ResetPersonalPIN", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users/{userId}?operation=reset-personal-pin", + "responseCode":200 + }, + "input":{"shape":"ResetPersonalPINRequest"}, + "output":{"shape":"ResetPersonalPINResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Resets the personal meeting PIN for the specified user on an Amazon Chime account. Returns the User object with the updated personal meeting PIN.

" + }, + "RestorePhoneNumber":{ + "name":"RestorePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers/{phoneNumberId}?operation=restore", + "responseCode":200 + }, + "input":{"shape":"RestorePhoneNumberRequest"}, + "output":{"shape":"RestorePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Moves a phone number from the Deletion queue back into the phone number Inventory.

" + }, + "SearchAvailablePhoneNumbers":{ + "name":"SearchAvailablePhoneNumbers", + "http":{ + "method":"GET", + "requestUri":"/search?type=phone-numbers" + }, + "input":{"shape":"SearchAvailablePhoneNumbersRequest"}, + "output":{"shape":"SearchAvailablePhoneNumbersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Searches phone numbers that can be ordered.

" + }, + "UpdateAccount":{ + "name":"UpdateAccount", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}", + "responseCode":200 + }, + "input":{"shape":"UpdateAccountRequest"}, + "output":{"shape":"UpdateAccountResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates account details for the specified Amazon Chime account. Currently, only account name updates are supported for this action.

" + }, + "UpdateAccountSettings":{ + "name":"UpdateAccountSettings", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{accountId}/settings", + "responseCode":204 + }, + "input":{"shape":"UpdateAccountSettingsRequest"}, + "output":{"shape":"UpdateAccountSettingsResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

" + }, + "UpdateBot":{ + "name":"UpdateBot", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/bots/{botId}", + "responseCode":200 + }, + "input":{"shape":"UpdateBotRequest"}, + "output":{"shape":"UpdateBotResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

" + }, + "UpdateGlobalSettings":{ + "name":"UpdateGlobalSettings", + "http":{ + "method":"PUT", + "requestUri":"/settings", + "responseCode":204 + }, + "input":{"shape":"UpdateGlobalSettingsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

" + }, + "UpdatePhoneNumber":{ + "name":"UpdatePhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/phone-numbers/{phoneNumberId}", + "responseCode":200 + }, + "input":{"shape":"UpdatePhoneNumberRequest"}, + "output":{"shape":"UpdatePhoneNumberResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action.

For toll-free numbers, you must use the Amazon Chime Voice Connector product type.

Updates to outbound calling names can take up to 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update.

" + }, + "UpdatePhoneNumberSettings":{ + "name":"UpdatePhoneNumberSettings", + "http":{ + "method":"PUT", + "requestUri":"/settings/phone-number", + "responseCode":204 + }, + "input":{"shape":"UpdatePhoneNumberSettingsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the phone number settings for the administrator's AWS account, such as the default outbound calling name. You can update the default outbound calling name once every seven days. Outbound calling names can take up to 72 hours to be updated.

" + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/users/{userId}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

" + }, + "UpdateUserSettings":{ + "name":"UpdateUserSettings", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{accountId}/users/{userId}/settings", + "responseCode":204 + }, + "input":{"shape":"UpdateUserSettingsRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the settings for the specified user, such as phone number settings.

" + }, + "UpdateVoiceConnector":{ + "name":"UpdateVoiceConnector", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}", + "responseCode":200 + }, + "input":{"shape":"UpdateVoiceConnectorRequest"}, + "output":{"shape":"UpdateVoiceConnectorResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates details for the specified Amazon Chime Voice Connector.

" + }, + "UpdateVoiceConnectorGroup":{ + "name":"UpdateVoiceConnectorGroup", + "http":{ + "method":"PUT", + "requestUri":"/voice-connector-groups/{voiceConnectorGroupId}", + "responseCode":202 + }, + "input":{"shape":"UpdateVoiceConnectorGroupRequest"}, + "output":{"shape":"UpdateVoiceConnectorGroupResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates details for the specified Amazon Chime Voice Connector group, such as the name and Amazon Chime Voice Connector priority ranking.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

You don't have permissions to perform the requested operation.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "Account":{ + "type":"structure", + "required":[ + "AwsAccountId", + "AccountId", + "Name" + ], + "members":{ + "AwsAccountId":{ + "shape":"String", + "documentation":"

The AWS account ID.

" + }, + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The Amazon Chime account name.

" + }, + "AccountType":{ + "shape":"AccountType", + "documentation":"

The Amazon Chime account type. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The Amazon Chime account creation timestamp, in ISO 8601 format.

" + }, + "DefaultLicense":{ + "shape":"License", + "documentation":"

The default license for the Amazon Chime account.

" + }, + "SupportedLicenses":{ + "shape":"LicenseList", + "documentation":"

Supported licenses for the Amazon Chime account.

" + } + }, + "documentation":"

The Amazon Chime account details. An AWS account can have multiple Amazon Chime accounts.

" + }, + "AccountList":{ + "type":"list", + "member":{"shape":"Account"} + }, + "AccountName":{ + "type":"string", + "max":100, + "min":1, + "pattern":".*\\S.*" + }, + "AccountSettings":{ + "type":"structure", + "members":{ + "DisableRemoteControl":{ + "shape":"Boolean", + "documentation":"

Setting that stops or starts remote control of shared screens during meetings.

" + }, + "EnableDialOut":{ + "shape":"Boolean", + "documentation":"

Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

" + } + }, + "documentation":"

Settings related to the Amazon Chime account. This includes settings that start or stop remote control of shared screens, or start or stop the dial-out option in the Amazon Chime web application. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

" + }, + "AccountType":{ + "type":"string", + "enum":[ + "Team", + "EnterpriseDirectory", + "EnterpriseLWA", + "EnterpriseOIDC" + ] + }, + "AssociatePhoneNumberWithUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId", + "E164PhoneNumber" + ], + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"String", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + }, + "E164PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The phone number, in E.164 format.

" + } + } + }, + "AssociatePhoneNumberWithUserResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociatePhoneNumbersWithVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + }, + "ForceAssociate":{ + "shape":"NullableBoolean", + "documentation":"

If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector Group and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + }, + "ForceAssociate":{ + "shape":"NullableBoolean", + "documentation":"

If true, associates the provided phone numbers with the provided Amazon Chime Voice Connector and removes any previously existing associations. If false, does not associate any phone numbers that have previously existing associations.

" + } + } + }, + "AssociatePhoneNumbersWithVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The input parameters don't match the service's restrictions.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BatchDeletePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberIds"], + "members":{ + "PhoneNumberIds":{ + "shape":"NonEmptyStringList", + "documentation":"

List of phone number IDs.

" + } + } + }, + "BatchDeletePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "BatchSuspendUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserIdList" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserIdList":{ + "shape":"UserIdList", + "documentation":"

The request containing the user IDs to suspend.

" + } + } + }, + "BatchSuspendUserResponse":{ + "type":"structure", + "members":{ + "UserErrors":{ + "shape":"UserErrorList", + "documentation":"

If the BatchSuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

" + } + } + }, + "BatchUnsuspendUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserIdList" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserIdList":{ + "shape":"UserIdList", + "documentation":"

The request containing the user IDs to unsuspend.

" + } + } + }, + "BatchUnsuspendUserResponse":{ + "type":"structure", + "members":{ + "UserErrors":{ + "shape":"UserErrorList", + "documentation":"

If the BatchUnsuspendUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

" + } + } + }, + "BatchUpdatePhoneNumberRequest":{ + "type":"structure", + "required":["UpdatePhoneNumberRequestItems"], + "members":{ + "UpdatePhoneNumberRequestItems":{ + "shape":"UpdatePhoneNumberRequestItemList", + "documentation":"

The request containing the phone number IDs and product types or calling names to update.

" + } + } + }, + "BatchUpdatePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "BatchUpdateUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UpdateUserRequestItems" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UpdateUserRequestItems":{ + "shape":"UpdateUserRequestItemList", + "documentation":"

The request containing the user IDs and details to update.

" + } + } + }, + "BatchUpdateUserResponse":{ + "type":"structure", + "members":{ + "UserErrors":{ + "shape":"UserErrorList", + "documentation":"

If the BatchUpdateUser action fails for one or more of the user IDs in the request, a list of the user IDs is returned, along with error codes and error messages.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "Bot":{ + "type":"structure", + "members":{ + "BotId":{ + "shape":"String", + "documentation":"

The bot ID.

" + }, + "UserId":{ + "shape":"String", + "documentation":"

The unique ID for the bot user.

" + }, + "DisplayName":{ + "shape":"SensitiveString", + "documentation":"

The bot display name.

" + }, + "BotType":{ + "shape":"BotType", + "documentation":"

The bot type.

" + }, + "Disabled":{ + "shape":"NullableBoolean", + "documentation":"

When true, the bot is stopped from running in your account.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The bot creation timestamp, in ISO 8601 format.

" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated bot timestamp, in ISO 8601 format.

" + }, + "BotEmail":{ + "shape":"SensitiveString", + "documentation":"

The bot email address.

" + }, + "SecurityToken":{ + "shape":"SensitiveString", + "documentation":"

The security token used to authenticate Amazon Chime with the outgoing event endpoint.

" + } + }, + "documentation":"

A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.

" + }, + "BotList":{ + "type":"list", + "member":{"shape":"Bot"} + }, + "BotType":{ + "type":"string", + "enum":["ChatBot"] + }, + "BusinessCallingSettings":{ + "type":"structure", + "members":{ + "CdrBucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket designated for call detail record storage.

", + "box":true + } + }, + "documentation":"

The Amazon Chime Business Calling settings for the administrator's AWS account. Includes any Amazon S3 buckets designated for storing call detail records.

" + }, + "CallingName":{ + "type":"string", + "pattern":"^$|^[a-zA-Z0-9 ]{2,15}$", + "sensitive":true + }, + "CallingNameStatus":{ + "type":"string", + "enum":[ + "Unassigned", + "UpdateInProgress", + "UpdateSucceeded", + "UpdateFailed" + ] + }, + "CallingRegion":{"type":"string"}, + "CallingRegionList":{ + "type":"list", + "member":{"shape":"CallingRegion"} + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The request could not be processed because of conflict in the current state of the resource.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CpsLimit":{ + "type":"integer", + "min":1 + }, + "CreateAccountRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"AccountName", + "documentation":"

The name of the Amazon Chime account.

" + } + } + }, + "CreateAccountResponse":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"Account", + "documentation":"

The Amazon Chime account details.

" + } + } + }, + "CreateBotRequest":{ + "type":"structure", + "required":[ + "DisplayName", + "AccountId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "DisplayName":{ + "shape":"SensitiveString", + "documentation":"

The bot display name.

" + }, + "Domain":{ + "shape":"NonEmptyString", + "documentation":"

The domain of the Amazon Chime Enterprise account.

" + } + } + }, + "CreateBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"

The bot details.

" + } + } + }, + "CreatePhoneNumberOrderRequest":{ + "type":"structure", + "required":[ + "ProductType", + "E164PhoneNumbers" + ], + "members":{ + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The phone number product type.

" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + } + } + }, + "CreatePhoneNumberOrderResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrder":{ + "shape":"PhoneNumberOrder", + "documentation":"

The phone number order details.

" + } + } + }, + "CreateVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"

The name of the Amazon Chime Voice Connector group.

" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"

The Amazon Chime Voice Connectors to route inbound calls to.

" + } + } + }, + "CreateVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroup":{ + "shape":"VoiceConnectorGroup", + "documentation":"

The Amazon Chime Voice Connector group details.

" + } + } + }, + "CreateVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "Name", + "RequireEncryption" + ], + "members":{ + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"

The name of the Amazon Chime Voice Connector.

" + }, + "AwsRegion":{ + "shape":"VoiceConnectorAwsRegion", + "documentation":"

The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1.

" + }, + "RequireEncryption":{ + "shape":"Boolean", + "documentation":"

When enabled, requires encryption for the Amazon Chime Voice Connector.

" + } + } + }, + "CreateVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"

The Amazon Chime Voice Connector details.

" + } + } + }, + "Credential":{ + "type":"structure", + "members":{ + "Username":{ + "shape":"SensitiveString", + "documentation":"

The RFC2617 compliant user name associated with the SIP credentials, in US-ASCII format.

" + }, + "Password":{ + "shape":"SensitiveString", + "documentation":"

The RFC2617 compliant password associated with the SIP credentials, in US-ASCII format.

" + } + }, + "documentation":"

The SIP credentials used to authenticate requests to your Amazon Chime Voice Connector.

" + }, + "CredentialList":{ + "type":"list", + "member":{"shape":"Credential"} + }, + "DataRetentionInHours":{ + "type":"integer", + "min":0 + }, + "DeleteAccountRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + } + } + }, + "DeleteAccountResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + } + } + }, + "DeletePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"String", + "documentation":"

The phone number ID.

", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "DeleteVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

", + "location":"uri", + "locationName":"voiceConnectorGroupId" + } + } + }, + "DeleteVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DeleteVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Usernames":{ + "shape":"SensitiveStringList", + "documentation":"

The RFC2617 compliant username associated with the SIP credentials, in US-ASCII format.

" + } + } + }, + "DeleteVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "DisassociatePhoneNumberFromUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"String", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "DisassociatePhoneNumberFromUserResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + } + } + }, + "DisassociatePhoneNumbersFromVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "PhoneNumberErrors":{ + "shape":"PhoneNumberErrorList", + "documentation":"

If the action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + } + } + }, + "E164PhoneNumber":{ + "type":"string", + "pattern":"^\\+?[1-9]\\d{1,14}$", + "sensitive":true + }, + "E164PhoneNumberList":{ + "type":"list", + "member":{"shape":"E164PhoneNumber"} + }, + "EmailAddress":{ + "type":"string", + "pattern":".+@.+\\..+", + "sensitive":true + }, + "EmailStatus":{ + "type":"string", + "enum":[ + "NotSent", + "Sent", + "Failed" + ] + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "BadRequest", + "Conflict", + "Forbidden", + "NotFound", + "PreconditionFailed", + "ResourceLimitExceeded", + "ServiceFailure", + "AccessDenied", + "ServiceUnavailable", + "Throttled", + "Unauthorized", + "Unprocessable", + "VoiceConnectorGroupAssociationsExist", + "PhoneNumberAssociationsExist" + ] + }, + "EventsConfiguration":{ + "type":"structure", + "members":{ + "BotId":{ + "shape":"String", + "documentation":"

The bot ID.

" + }, + "OutboundEventsHTTPSEndpoint":{ + "shape":"SensitiveString", + "documentation":"

HTTPS endpoint that allows a bot to receive outgoing events.

" + }, + "LambdaFunctionArn":{ + "shape":"SensitiveString", + "documentation":"

Lambda function ARN that allows a bot to receive outgoing events.

" + } + }, + "documentation":"

The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.

" + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "GetAccountRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + } + } + }, + "GetAccountResponse":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"Account", + "documentation":"

The Amazon Chime account details.

" + } + } + }, + "GetAccountSettingsRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + } + } + }, + "GetAccountSettingsResponse":{ + "type":"structure", + "members":{ + "AccountSettings":{ + "shape":"AccountSettings", + "documentation":"

The Amazon Chime account settings.

" + } + } + }, + "GetBotRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + } + } + }, + "GetBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"

The chat bot details.

" + } + } + }, + "GetEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + } + } + }, + "GetEventsConfigurationResponse":{ + "type":"structure", + "members":{ + "EventsConfiguration":{ + "shape":"EventsConfiguration", + "documentation":"

The events configuration details.

" + } + } + }, + "GetGlobalSettingsResponse":{ + "type":"structure", + "members":{ + "BusinessCalling":{ + "shape":"BusinessCallingSettings", + "documentation":"

The Amazon Chime Business Calling settings.

" + }, + "VoiceConnector":{ + "shape":"VoiceConnectorSettings", + "documentation":"

The Amazon Chime Voice Connector settings.

" + } + } + }, + "GetPhoneNumberOrderRequest":{ + "type":"structure", + "required":["PhoneNumberOrderId"], + "members":{ + "PhoneNumberOrderId":{ + "shape":"GuidString", + "documentation":"

The ID for the phone number order.

", + "location":"uri", + "locationName":"phoneNumberOrderId" + } + } + }, + "GetPhoneNumberOrderResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrder":{ + "shape":"PhoneNumberOrder", + "documentation":"

The phone number order details.

" + } + } + }, + "GetPhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"String", + "documentation":"

The phone number ID.

", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "GetPhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number details.

" + } + } + }, + "GetPhoneNumberSettingsResponse":{ + "type":"structure", + "members":{ + "CallingName":{ + "shape":"CallingName", + "documentation":"

The default outbound calling name for the account.

" + }, + "CallingNameUpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated outbound calling name timestamp, in ISO 8601 format.

" + } + } + }, + "GetUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "GetUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

The user details.

" + } + } + }, + "GetUserSettingsRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"String", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "GetUserSettingsResponse":{ + "type":"structure", + "members":{ + "UserSettings":{ + "shape":"UserSettings", + "documentation":"

The user settings.

" + } + } + }, + "GetVoiceConnectorGroupRequest":{ + "type":"structure", + "required":["VoiceConnectorGroupId"], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

", + "location":"uri", + "locationName":"voiceConnectorGroupId" + } + } + }, + "GetVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroup":{ + "shape":"VoiceConnectorGroup", + "documentation":"

The Amazon Chime Voice Connector group details.

" + } + } + }, + "GetVoiceConnectorLoggingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

The logging configuration details.

" + } + } + }, + "GetVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorOriginationResponse":{ + "type":"structure", + "members":{ + "Origination":{ + "shape":"Origination", + "documentation":"

The origination setting details.

" + } + } + }, + "GetVoiceConnectorRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"

The Amazon Chime Voice Connector details.

" + } + } + }, + "GetVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorStreamingConfigurationResponse":{ + "type":"structure", + "members":{ + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"

The streaming configuration details.

" + } + } + }, + "GetVoiceConnectorTerminationHealthRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorTerminationHealthResponse":{ + "type":"structure", + "members":{ + "TerminationHealth":{ + "shape":"TerminationHealth", + "documentation":"

The termination health details.

" + } + } + }, + "GetVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorTerminationResponse":{ + "type":"structure", + "members":{ + "Termination":{ + "shape":"Termination", + "documentation":"

The termination setting details.

" + } + } + }, + "GuidString":{ + "type":"string", + "pattern":"[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}" + }, + "Invite":{ + "type":"structure", + "members":{ + "InviteId":{ + "shape":"String", + "documentation":"

The invite ID.

" + }, + "Status":{ + "shape":"InviteStatus", + "documentation":"

The status of the invite.

" + }, + "EmailAddress":{ + "shape":"EmailAddress", + "documentation":"

The email address to which the invite is sent.

" + }, + "EmailStatus":{ + "shape":"EmailStatus", + "documentation":"

The status of the invite email.

" + } + }, + "documentation":"

Invitation object returned after emailing users to invite them to join the Amazon Chime Team account.

" + }, + "InviteList":{ + "type":"list", + "member":{"shape":"Invite"} + }, + "InviteStatus":{ + "type":"string", + "enum":[ + "Pending", + "Accepted", + "Failed" + ] + }, + "InviteUsersRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserEmailList" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserEmailList":{ + "shape":"UserEmailList", + "documentation":"

The user email addresses to which to send the invite.

" + } + } + }, + "InviteUsersResponse":{ + "type":"structure", + "members":{ + "Invites":{ + "shape":"InviteList", + "documentation":"

The invite details.

" + } + } + }, + "Iso8601Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "License":{ + "type":"string", + "enum":[ + "Basic", + "Plus", + "Pro", + "ProTrial" + ] + }, + "LicenseList":{ + "type":"list", + "member":{"shape":"License"} + }, + "ListAccountsRequest":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"AccountName", + "documentation":"

Amazon Chime account name prefix with which to filter results.

", + "location":"querystring", + "locationName":"name" + }, + "UserEmail":{ + "shape":"EmailAddress", + "documentation":"

User email address with which to filter results.

", + "location":"querystring", + "locationName":"user-email" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ProfileServiceMaxResults", + "documentation":"

The maximum number of results to return in a single call. Defaults to 100.

", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListAccountsResponse":{ + "type":"structure", + "members":{ + "Accounts":{ + "shape":"AccountList", + "documentation":"

List of Amazon Chime accounts and account details.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListBotsRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"

The maximum number of results to return in a single call. Default is 10.

", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListBotsResponse":{ + "type":"structure", + "members":{ + "Bots":{ + "shape":"BotList", + "documentation":"

List of bots and bot details.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListPhoneNumberOrdersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"

The maximum number of results to return in a single call.

", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListPhoneNumberOrdersResponse":{ + "type":"structure", + "members":{ + "PhoneNumberOrders":{ + "shape":"PhoneNumberOrderList", + "documentation":"

The phone number order details.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListPhoneNumbersRequest":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"PhoneNumberStatus", + "documentation":"

The phone number status.

", + "location":"querystring", + "locationName":"status" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The phone number product type.

", + "location":"querystring", + "locationName":"product-type" + }, + "FilterName":{ + "shape":"PhoneNumberAssociationName", + "documentation":"

The filter to use to limit the number of results.

", + "location":"querystring", + "locationName":"filter-name" + }, + "FilterValue":{ + "shape":"String", + "documentation":"

The value to use for the filter.

", + "location":"querystring", + "locationName":"filter-value" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"

The maximum number of results to return in a single call.

", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListPhoneNumbersResponse":{ + "type":"structure", + "members":{ + "PhoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

The phone number details.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserEmail":{ + "shape":"EmailAddress", + "documentation":"

Optional. The user email address used to filter results. Maximum 1.

", + "location":"querystring", + "locationName":"user-email" + }, + "MaxResults":{ + "shape":"ProfileServiceMaxResults", + "documentation":"

The maximum number of results to return in a single call. Defaults to 100.

", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UserList", + "documentation":"

List of users and user details.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListVoiceConnectorGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"

The maximum number of results to return in a single call.

", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceConnectorGroupsResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroups":{ + "shape":"VoiceConnectorGroupList", + "documentation":"

The details of the Amazon Chime Voice Connector groups.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "ListVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "ListVoiceConnectorTerminationCredentialsResponse":{ + "type":"structure", + "members":{ + "Usernames":{ + "shape":"SensitiveStringList", + "documentation":"

A list of user names.

" + } + } + }, + "ListVoiceConnectorsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"

The maximum number of results to return in a single call.

", + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListVoiceConnectorsResponse":{ + "type":"structure", + "members":{ + "VoiceConnectors":{ + "shape":"VoiceConnectorList", + "documentation":"

The details of the Amazon Chime Voice Connectors.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "LoggingConfiguration":{ + "type":"structure", + "members":{ + "EnableSIPLogs":{ + "shape":"Boolean", + "documentation":"

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

" + } + }, + "documentation":"

The logging configuration associated with an Amazon Chime Voice Connector. Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

" + }, + "LogoutUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "LogoutUserResponse":{ + "type":"structure", + "members":{ + } + }, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "NonEmptyStringList":{ + "type":"list", + "member":{"shape":"String"}, + "min":1 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

One or more of the resources in the request does not exist in the system.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NullableBoolean":{"type":"boolean"}, + "OrderedPhoneNumber":{ + "type":"structure", + "members":{ + "E164PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The phone number, in E.164 format.

" + }, + "Status":{ + "shape":"OrderedPhoneNumberStatus", + "documentation":"

The phone number status.

" + } + }, + "documentation":"

A phone number for which an order has been placed.

" + }, + "OrderedPhoneNumberList":{ + "type":"list", + "member":{"shape":"OrderedPhoneNumber"} + }, + "OrderedPhoneNumberStatus":{ + "type":"string", + "enum":[ + "Processing", + "Acquired", + "Failed" + ] + }, + "Origination":{ + "type":"structure", + "members":{ + "Routes":{ + "shape":"OriginationRouteList", + "documentation":"

The call distribution properties defined for your SIP hosts. Valid range: Minimum value of 1. Maximum value of 20.

" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

" + } + }, + "documentation":"

Origination settings enable your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector.

" + }, + "OriginationRoute":{ + "type":"structure", + "members":{ + "Host":{ + "shape":"String", + "documentation":"

The FQDN or IP address to contact for origination traffic.

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

The designated origination route port. Defaults to 5060.

" + }, + "Protocol":{ + "shape":"OriginationRouteProtocol", + "documentation":"

The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.

" + }, + "Priority":{ + "shape":"OriginationRoutePriority", + "documentation":"

The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.

" + }, + "Weight":{ + "shape":"OriginationRouteWeight", + "documentation":"

The weight associated with the host. If hosts are equal in priority, calls are distributed among them based on their relative weight.

" + } + }, + "documentation":"

Origination routes define call distribution properties for your SIP hosts to receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten origination routes for each Amazon Chime Voice Connector.

" + }, + "OriginationRouteList":{ + "type":"list", + "member":{"shape":"OriginationRoute"} + }, + "OriginationRoutePriority":{ + "type":"integer", + "max":100, + "min":1 + }, + "OriginationRouteProtocol":{ + "type":"string", + "enum":[ + "TCP", + "UDP" + ] + }, + "OriginationRouteWeight":{ + "type":"integer", + "max":100, + "min":1 + }, + "PhoneNumber":{ + "type":"structure", + "members":{ + "PhoneNumberId":{ + "shape":"String", + "documentation":"

The phone number ID.

" + }, + "E164PhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The phone number, in E.164 format.

" + }, + "Type":{ + "shape":"PhoneNumberType", + "documentation":"

The phone number type.

" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The phone number product type.

" + }, + "Status":{ + "shape":"PhoneNumberStatus", + "documentation":"

The phone number status.

" + }, + "Capabilities":{ + "shape":"PhoneNumberCapabilities", + "documentation":"

The phone number capabilities.

" + }, + "Associations":{ + "shape":"PhoneNumberAssociationList", + "documentation":"

The phone number associations.

" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"

The outbound calling name associated with the phone number.

" + }, + "CallingNameStatus":{ + "shape":"CallingNameStatus", + "documentation":"

The outbound calling name status.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The phone number creation timestamp, in ISO 8601 format.

" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated phone number timestamp, in ISO 8601 format.

" + }, + "DeletionTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The deleted phone number timestamp, in ISO 8601 format.

" + } + }, + "documentation":"

A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice Connector.

" + }, + "PhoneNumberAssociation":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

Contains the ID for the entity specified in Name.

" + }, + "Name":{ + "shape":"PhoneNumberAssociationName", + "documentation":"

Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

" + }, + "AssociatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The timestamp of the phone number association, in ISO 8601 format.

" + } + }, + "documentation":"

The phone number associations, such as Amazon Chime account ID, Amazon Chime user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.

" + }, + "PhoneNumberAssociationList":{ + "type":"list", + "member":{"shape":"PhoneNumberAssociation"} + }, + "PhoneNumberAssociationName":{ + "type":"string", + "enum":[ + "AccountId", + "UserId", + "VoiceConnectorId", + "VoiceConnectorGroupId" + ] + }, + "PhoneNumberCapabilities":{ + "type":"structure", + "members":{ + "InboundCall":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies inbound calling for the specified phone number.

" + }, + "OutboundCall":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies outbound calling for the specified phone number.

" + }, + "InboundSMS":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies inbound SMS messaging for the specified phone number.

" + }, + "OutboundSMS":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies outbound SMS messaging for the specified phone number.

" + }, + "InboundMMS":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies inbound MMS messaging for the specified phone number.

" + }, + "OutboundMMS":{ + "shape":"NullableBoolean", + "documentation":"

Allows or denies outbound MMS messaging for the specified phone number.

" + } + }, + "documentation":"

The phone number capabilities for Amazon Chime Business Calling phone numbers, such as enabled inbound and outbound calling and text messaging.

" + }, + "PhoneNumberError":{ + "type":"structure", + "members":{ + "PhoneNumberId":{ + "shape":"NonEmptyString", + "documentation":"

The phone number ID for which the action failed.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message.

" + } + }, + "documentation":"

If the phone number action fails for one or more of the phone numbers in the request, a list of the phone numbers is returned, along with error codes and error messages.

" + }, + "PhoneNumberErrorList":{ + "type":"list", + "member":{"shape":"PhoneNumberError"} + }, + "PhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"} + }, + "PhoneNumberMaxResults":{ + "type":"integer", + "max":500, + "min":1 + }, + "PhoneNumberOrder":{ + "type":"structure", + "members":{ + "PhoneNumberOrderId":{ + "shape":"GuidString", + "documentation":"

The phone number order ID.

" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The phone number order product type.

" + }, + "Status":{ + "shape":"PhoneNumberOrderStatus", + "documentation":"

The status of the phone number order.

" + }, + "OrderedPhoneNumbers":{ + "shape":"OrderedPhoneNumberList", + "documentation":"

The ordered phone number details, such as the phone number in E.164 format and the phone number status.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The phone number order creation timestamp, in ISO 8601 format.

" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated phone number order timestamp, in ISO 8601 format.

" + } + }, + "documentation":"

The details of a phone number order created for Amazon Chime.

" + }, + "PhoneNumberOrderList":{ + "type":"list", + "member":{"shape":"PhoneNumberOrder"} + }, + "PhoneNumberOrderStatus":{ + "type":"string", + "enum":[ + "Processing", + "Successful", + "Failed", + "Partial" + ] + }, + "PhoneNumberProductType":{ + "type":"string", + "enum":[ + "BusinessCalling", + "VoiceConnector" + ] + }, + "PhoneNumberStatus":{ + "type":"string", + "enum":[ + "AcquireInProgress", + "AcquireFailed", + "Unassigned", + "Assigned", + "ReleaseInProgress", + "DeleteInProgress", + "ReleaseFailed", + "DeleteFailed" + ] + }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "Local", + "TollFree" + ] + }, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "ProfileServiceMaxResults":{ + "type":"integer", + "max":200, + "min":1 + }, + "PutEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + }, + "OutboundEventsHTTPSEndpoint":{ + "shape":"SensitiveString", + "documentation":"

HTTPS endpoint that allows the bot to receive outgoing events.

" + }, + "LambdaFunctionArn":{ + "shape":"SensitiveString", + "documentation":"

Lambda function ARN that allows the bot to receive outgoing events.

" + } + } + }, + "PutEventsConfigurationResponse":{ + "type":"structure", + "members":{ + "EventsConfiguration":{"shape":"EventsConfiguration"} + } + }, + "PutVoiceConnectorLoggingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "LoggingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

The logging configuration details to add.

" + } + } + }, + "PutVoiceConnectorLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

The updated logging configuration details.

" + } + } + }, + "PutVoiceConnectorOriginationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Origination" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Origination":{ + "shape":"Origination", + "documentation":"

The origination setting details to add.

" + } + } + }, + "PutVoiceConnectorOriginationResponse":{ + "type":"structure", + "members":{ + "Origination":{ + "shape":"Origination", + "documentation":"

The updated origination setting details.

" + } + } + }, + "PutVoiceConnectorStreamingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "StreamingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"

The streaming configuration details to add.

" + } + } + }, + "PutVoiceConnectorStreamingConfigurationResponse":{ + "type":"structure", + "members":{ + "StreamingConfiguration":{ + "shape":"StreamingConfiguration", + "documentation":"

The updated streaming configuration details.

" + } + } + }, + "PutVoiceConnectorTerminationCredentialsRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Credentials":{ + "shape":"CredentialList", + "documentation":"

The termination SIP credentials.

" + } + } + }, + "PutVoiceConnectorTerminationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Termination" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Termination":{ + "shape":"Termination", + "documentation":"

The termination setting details to add.

" + } + } + }, + "PutVoiceConnectorTerminationResponse":{ + "type":"structure", + "members":{ + "Termination":{ + "shape":"Termination", + "documentation":"

The updated termination setting details.

" + } + } + }, + "RegenerateSecurityTokenRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + } + } + }, + "RegenerateSecurityTokenResponse":{ + "type":"structure", + "members":{ + "Bot":{"shape":"Bot"} + } + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "Unregistered", + "Registered", + "Suspended" + ] + }, + "ResetPersonalPINRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "ResetPersonalPINResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

The user details and new personal meeting PIN.

" + } + } + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The request exceeds the resource limit.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "RestorePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"NonEmptyString", + "documentation":"

The phone number.

", + "location":"uri", + "locationName":"phoneNumberId" + } + } + }, + "RestorePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number details.

" + } + } + }, + "ResultMax":{ + "type":"integer", + "max":99, + "min":1 + }, + "SearchAvailablePhoneNumbersRequest":{ + "type":"structure", + "members":{ + "AreaCode":{ + "shape":"String", + "documentation":"

The area code used to filter results.

", + "location":"querystring", + "locationName":"area-code" + }, + "City":{ + "shape":"String", + "documentation":"

The city used to filter results.

", + "location":"querystring", + "locationName":"city" + }, + "Country":{ + "shape":"String", + "documentation":"

The country used to filter results.

", + "location":"querystring", + "locationName":"country" + }, + "State":{ + "shape":"String", + "documentation":"

The state used to filter results.

", + "location":"querystring", + "locationName":"state" + }, + "TollFreePrefix":{ + "shape":"TollFreePrefix", + "documentation":"

The toll-free prefix that you use to filter results.

", + "location":"querystring", + "locationName":"toll-free-prefix" + }, + "MaxResults":{ + "shape":"PhoneNumberMaxResults", + "documentation":"

The maximum number of results to return in a single call.

", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "SearchAvailablePhoneNumbersResponse":{ + "type":"structure", + "members":{ + "E164PhoneNumbers":{ + "shape":"E164PhoneNumberList", + "documentation":"

List of phone numbers, in E.164 format.

" + } + } + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "SensitiveStringList":{ + "type":"list", + "member":{"shape":"SensitiveString"} + }, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The service encountered an unexpected error.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The service is currently unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "StreamingConfiguration":{ + "type":"structure", + "required":["DataRetentionInHours"], + "members":{ + "DataRetentionInHours":{ + "shape":"DataRetentionInHours", + "documentation":"

The retention period for the Amazon Kinesis data, in hours.

" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"

When true, media streaming to Amazon Kinesis is turned off.

" + } + }, + "documentation":"

The streaming configuration associated with an Amazon Chime Voice Connector. Specifies whether media streaming is enabled for sending to Amazon Kinesis, and shows the retention period for the Amazon Kinesis data, in hours.

" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TelephonySettings":{ + "type":"structure", + "required":[ + "InboundCalling", + "OutboundCalling", + "SMS" + ], + "members":{ + "InboundCalling":{ + "shape":"Boolean", + "documentation":"

Allows or denies inbound calling.

" + }, + "OutboundCalling":{ + "shape":"Boolean", + "documentation":"

Allows or denies outbound calling.

" + }, + "SMS":{ + "shape":"Boolean", + "documentation":"

Allows or denies SMS messaging.

" + } + }, + "documentation":"

Settings that allow management of telephony permissions for an Amazon Chime user, such as inbound and outbound calling and text messaging.

" + }, + "Termination":{ + "type":"structure", + "members":{ + "CpsLimit":{ + "shape":"CpsLimit", + "documentation":"

The limit on calls per second. Max value based on account service limit. Default value of 1.

" + }, + "DefaultPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The default caller ID phone number.

" + }, + "CallingRegions":{ + "shape":"CallingRegionList", + "documentation":"

The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. Required.

" + }, + "CidrAllowedList":{ + "shape":"StringList", + "documentation":"

The IP addresses allowed to make calls, in CIDR format. Required.

" + }, + "Disabled":{ + "shape":"Boolean", + "documentation":"

When termination settings are disabled, outbound calls can not be made.

" + } + }, + "documentation":"

Termination settings enable your SIP hosts to make outbound calls using your Amazon Chime Voice Connector.

" + }, + "TerminationHealth":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The timestamp, in ISO 8601 format.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source IP address.

" + } + }, + "documentation":"

The termination health details, including the source IP address and timestamp of the last successful SIP OPTIONS message from your SIP infrastructure.

" + }, + "ThrottledClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The client exceeded its request rate limit.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TollFreePrefix":{ + "type":"string", + "max":3, + "min":3, + "pattern":"^8(00|33|44|55|66|77|88)$" + }, + "UnauthorizedClientException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The client is not currently authorized to make the request.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UnprocessableEntityException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"

The request was well-formed but was unable to be followed due to semantic errors.

", + "error":{"httpStatusCode":422}, + "exception":true + }, + "UpdateAccountRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "Name":{ + "shape":"AccountName", + "documentation":"

The new name for the specified Amazon Chime account.

" + } + } + }, + "UpdateAccountResponse":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"Account", + "documentation":"

The updated Amazon Chime account details.

" + } + } + }, + "UpdateAccountSettingsRequest":{ + "type":"structure", + "required":[ + "AccountId", + "AccountSettings" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "AccountSettings":{ + "shape":"AccountSettings", + "documentation":"

The Amazon Chime account settings to update.

" + } + } + }, + "UpdateAccountSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBotRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"

The bot ID.

", + "location":"uri", + "locationName":"botId" + }, + "Disabled":{ + "shape":"NullableBoolean", + "documentation":"

When true, stops the specified bot from running in your account.

" + } + } + }, + "UpdateBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"

The updated bot details.

" + } + } + }, + "UpdateGlobalSettingsRequest":{ + "type":"structure", + "required":[ + "BusinessCalling", + "VoiceConnector" + ], + "members":{ + "BusinessCalling":{ + "shape":"BusinessCallingSettings", + "documentation":"

The Amazon Chime Business Calling settings.

" + }, + "VoiceConnector":{ + "shape":"VoiceConnectorSettings", + "documentation":"

The Amazon Chime Voice Connector settings.

" + } + } + }, + "UpdatePhoneNumberRequest":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"String", + "documentation":"

The phone number ID.

", + "location":"uri", + "locationName":"phoneNumberId" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The product type.

" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"

The outbound calling name associated with the phone number.

" + } + } + }, + "UpdatePhoneNumberRequestItem":{ + "type":"structure", + "required":["PhoneNumberId"], + "members":{ + "PhoneNumberId":{ + "shape":"NonEmptyString", + "documentation":"

The phone number ID to update.

" + }, + "ProductType":{ + "shape":"PhoneNumberProductType", + "documentation":"

The product type to update.

" + }, + "CallingName":{ + "shape":"CallingName", + "documentation":"

The outbound calling name to update.

" + } + }, + "documentation":"

The phone number ID, product type, or calling name fields to update, used with the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.

" + }, + "UpdatePhoneNumberRequestItemList":{ + "type":"list", + "member":{"shape":"UpdatePhoneNumberRequestItem"} + }, + "UpdatePhoneNumberResponse":{ + "type":"structure", + "members":{ + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The updated phone number details.

" + } + } + }, + "UpdatePhoneNumberSettingsRequest":{ + "type":"structure", + "required":["CallingName"], + "members":{ + "CallingName":{ + "shape":"CallingName", + "documentation":"

The default outbound calling name for the account.

" + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + }, + "LicenseType":{ + "shape":"License", + "documentation":"

The user license type to update. This must be a supported license type for the Amazon Chime account that the user belongs to.

" + } + } + }, + "UpdateUserRequestItem":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID.

" + }, + "LicenseType":{ + "shape":"License", + "documentation":"

The user license type.

" + } + }, + "documentation":"

The user ID and user fields to update, used with the BatchUpdateUser action.

" + }, + "UpdateUserRequestItemList":{ + "type":"list", + "member":{"shape":"UpdateUserRequestItem"}, + "max":20 + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

The updated user details.

" + } + } + }, + "UpdateUserSettingsRequest":{ + "type":"structure", + "required":[ + "AccountId", + "UserId", + "UserSettings" + ], + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

", + "location":"uri", + "locationName":"accountId" + }, + "UserId":{ + "shape":"String", + "documentation":"

The user ID.

", + "location":"uri", + "locationName":"userId" + }, + "UserSettings":{ + "shape":"UserSettings", + "documentation":"

The user settings to update.

" + } + } + }, + "UpdateVoiceConnectorGroupRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorGroupId", + "Name", + "VoiceConnectorItems" + ], + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

", + "location":"uri", + "locationName":"voiceConnectorGroupId" + }, + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"

The name of the Amazon Chime Voice Connector group.

" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"

The VoiceConnectorItems to associate with the group.

" + } + } + }, + "UpdateVoiceConnectorGroupResponse":{ + "type":"structure", + "members":{ + "VoiceConnectorGroup":{ + "shape":"VoiceConnectorGroup", + "documentation":"

The updated Amazon Chime Voice Connector group details.

" + } + } + }, + "UpdateVoiceConnectorRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Name", + "RequireEncryption" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"

The name of the Amazon Chime Voice Connector.

" + }, + "RequireEncryption":{ + "shape":"Boolean", + "documentation":"

When enabled, requires encryption for the Amazon Chime Voice Connector.

" + } + } + }, + "UpdateVoiceConnectorResponse":{ + "type":"structure", + "members":{ + "VoiceConnector":{ + "shape":"VoiceConnector", + "documentation":"

The updated Amazon Chime Voice Connector details.

" + } + } + }, + "User":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The user ID.

" + }, + "AccountId":{ + "shape":"String", + "documentation":"

The Amazon Chime account ID.

" + }, + "PrimaryEmail":{ + "shape":"EmailAddress", + "documentation":"

The primary email address of the user.

" + }, + "PrimaryProvisionedNumber":{ + "shape":"SensitiveString", + "documentation":"

The primary phone number associated with the user.

" + }, + "DisplayName":{ + "shape":"SensitiveString", + "documentation":"

The display name of the user.

" + }, + "LicenseType":{ + "shape":"License", + "documentation":"

The license type for the user.

" + }, + "UserRegistrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

The user registration status.

" + }, + "UserInvitationStatus":{ + "shape":"InviteStatus", + "documentation":"

The user invite status.

" + }, + "RegisteredOn":{ + "shape":"Iso8601Timestamp", + "documentation":"

Date and time when the user is registered, in ISO 8601 format.

" + }, + "InvitedOn":{ + "shape":"Iso8601Timestamp", + "documentation":"

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

" + }, + "PersonalPIN":{ + "shape":"String", + "documentation":"

The user's personal meeting PIN.

" + } + }, + "documentation":"

The user on the Amazon Chime account.

" + }, + "UserEmailList":{ + "type":"list", + "member":{"shape":"EmailAddress"}, + "max":50 + }, + "UserError":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"NonEmptyString", + "documentation":"

The user ID for which the action failed.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message.

" + } + }, + "documentation":"

The list of errors returned when errors are encountered during the BatchSuspendUser, BatchUnsuspendUser, or BatchUpdateUser actions. This includes user IDs, error codes, and error messages.

" + }, + "UserErrorList":{ + "type":"list", + "member":{"shape":"UserError"} + }, + "UserIdList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":50 + }, + "UserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "UserSettings":{ + "type":"structure", + "required":["Telephony"], + "members":{ + "Telephony":{ + "shape":"TelephonySettings", + "documentation":"

The telephony settings associated with the user.

" + } + }, + "documentation":"

Settings associated with an Amazon Chime user, including inbound and outbound calling and text messaging.

" + }, + "VoiceConnector":{ + "type":"structure", + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

" + }, + "AwsRegion":{ + "shape":"VoiceConnectorAwsRegion", + "documentation":"

The AWS Region in which the Amazon Chime Voice Connector is created. Default: us-east-1.

" + }, + "Name":{ + "shape":"VoiceConnectorName", + "documentation":"

The name of the Amazon Chime Voice Connector.

" + }, + "OutboundHostName":{ + "shape":"String", + "documentation":"

The outbound host name for the Amazon Chime Voice Connector.

" + }, + "RequireEncryption":{ + "shape":"Boolean", + "documentation":"

Designates whether encryption is required for the Amazon Chime Voice Connector.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.

" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.

" + } + }, + "documentation":"

The Amazon Chime Voice Connector configuration, including outbound host name and encryption settings.

" + }, + "VoiceConnectorAwsRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-2" + ] + }, + "VoiceConnectorGroup":{ + "type":"structure", + "members":{ + "VoiceConnectorGroupId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector group ID.

" + }, + "Name":{ + "shape":"VoiceConnectorGroupName", + "documentation":"

The name of the Amazon Chime Voice Connector group.

" + }, + "VoiceConnectorItems":{ + "shape":"VoiceConnectorItemList", + "documentation":"

The Amazon Chime Voice Connectors to which to route inbound calls.

" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The Amazon Chime Voice Connector group creation timestamp, in ISO 8601 format.

" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"

The updated Amazon Chime Voice Connector group timestamp, in ISO 8601 format.

" + } + }, + "documentation":"

The Amazon Chime Voice Connector group configuration, including associated Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

" + }, + "VoiceConnectorGroupList":{ + "type":"list", + "member":{"shape":"VoiceConnectorGroup"} + }, + "VoiceConnectorGroupName":{ + "type":"string", + "max":256, + "min":1 + }, + "VoiceConnectorItem":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "Priority" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

" + }, + "Priority":{ + "shape":"VoiceConnectorItemPriority", + "documentation":"

The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.

" + } + }, + "documentation":"

For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to which to route inbound calls. Includes priority configuration settings. Limit: 3 VoiceConnectorItems per Amazon Chime Voice Connector group.

" + }, + "VoiceConnectorItemList":{ + "type":"list", + "member":{"shape":"VoiceConnectorItem"} + }, + "VoiceConnectorItemPriority":{ + "type":"integer", + "max":99, + "min":1 + }, + "VoiceConnectorList":{ + "type":"list", + "member":{"shape":"VoiceConnector"} + }, + "VoiceConnectorName":{ + "type":"string", + "max":256, + "min":1 + }, + "VoiceConnectorSettings":{ + "type":"structure", + "members":{ + "CdrBucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket designated for call detail record storage.

", + "box":true + } + }, + "documentation":"

The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets designated for storing call detail records.

" + } + }, + "documentation":"

The Amazon Chime API (application programming interface) is designed for administrators to use to perform key tasks, such as creating and managing Amazon Chime accounts and users. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST API

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Control Access to the Amazon Chime Console in the Amazon Chime Administration Guide.

" +} diff --git a/aws/dist/botocore/data/cloud9/2017-09-23/paginators-1.json b/aws/dist/botocore/data/cloud9/2017-09-23/paginators-1.json new file mode 100644 index 00000000..1c4c2ff5 --- /dev/null +++ b/aws/dist/botocore/data/cloud9/2017-09-23/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeEnvironmentMemberships": { + "result_key": "memberships", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListEnvironments": { + "result_key": "environmentIds", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/aws/dist/botocore/data/cloud9/2017-09-23/service-2.json b/aws/dist/botocore/data/cloud9/2017-09-23/service-2.json new file mode 100644 index 00000000..98d7035f --- /dev/null +++ b/aws/dist/botocore/data/cloud9/2017-09-23/service-2.json @@ -0,0 +1,729 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-23", + "endpointPrefix":"cloud9", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Cloud9", + "serviceId":"Cloud9", + "signatureVersion":"v4", + "targetPrefix":"AWSCloud9WorkspaceManagementService", + "uid":"cloud9-2017-09-23" + }, + "operations":{ + "CreateEnvironmentEC2":{ + "name":"CreateEnvironmentEC2", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEnvironmentEC2Request"}, + "output":{"shape":"CreateEnvironmentEC2Result"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.

", + "idempotent":true + }, + "CreateEnvironmentMembership":{ + "name":"CreateEnvironmentMembership", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEnvironmentMembershipRequest"}, + "output":{"shape":"CreateEnvironmentMembershipResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Adds an environment member to an AWS Cloud9 development environment.

", + "idempotent":true + }, + "DeleteEnvironment":{ + "name":"DeleteEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEnvironmentRequest"}, + "output":{"shape":"DeleteEnvironmentResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

", + "idempotent":true + }, + "DeleteEnvironmentMembership":{ + "name":"DeleteEnvironmentMembership", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEnvironmentMembershipRequest"}, + "output":{"shape":"DeleteEnvironmentMembershipResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes an environment member from an AWS Cloud9 development environment.

", + "idempotent":true + }, + "DescribeEnvironmentMemberships":{ + "name":"DescribeEnvironmentMemberships", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentMembershipsRequest"}, + "output":{"shape":"DescribeEnvironmentMembershipsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Gets information about environment members for an AWS Cloud9 development environment.

" + }, + "DescribeEnvironmentStatus":{ + "name":"DescribeEnvironmentStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentStatusRequest"}, + "output":{"shape":"DescribeEnvironmentStatusResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Gets status information for an AWS Cloud9 development environment.

" + }, + "DescribeEnvironments":{ + "name":"DescribeEnvironments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentsRequest"}, + "output":{"shape":"DescribeEnvironmentsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Gets information about AWS Cloud9 development environments.

" + }, + "ListEnvironments":{ + "name":"ListEnvironments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEnvironmentsRequest"}, + "output":{"shape":"ListEnvironmentsResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Gets a list of AWS Cloud9 development environment identifiers.

" + }, + "UpdateEnvironment":{ + "name":"UpdateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEnvironmentRequest"}, + "output":{"shape":"UpdateEnvironmentResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Changes the settings of an existing AWS Cloud9 development environment.

", + "idempotent":true + }, + "UpdateEnvironmentMembership":{ + "name":"UpdateEnvironmentMembership", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEnvironmentMembershipRequest"}, + "output":{"shape":"UpdateEnvironmentMembershipResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConflictException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Changes the settings of an existing environment member for an AWS Cloud9 development environment.

", + "idempotent":true + } + }, + "shapes":{ + "AutomaticStopTimeMinutes":{ + "type":"integer", + "box":true, + "max":20160 + }, + "BadRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target request is invalid.

", + "exception":true + }, + "BoundedEnvironmentIdList":{ + "type":"list", + "member":{"shape":"EnvironmentId"}, + "max":25, + "min":1 + }, + "ClientRequestToken":{ + "type":"string", + "pattern":"[\\x20-\\x7E]{10,128}" + }, + "ConflictException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A conflict occurred.

", + "exception":true + }, + "CreateEnvironmentEC2Request":{ + "type":"structure", + "required":[ + "name", + "instanceType" + ], + "members":{ + "name":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to create.

This name is visible to other AWS IAM users in the same AWS account.

" + }, + "description":{ + "shape":"EnvironmentDescription", + "documentation":"

The description of the environment to create.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.

For more information, see Client Tokens in the Amazon EC2 API Reference.

" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"

The type of instance to connect to the environment (for example, t2.micro).

" + }, + "subnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.

" + }, + "automaticStopTimeMinutes":{ + "shape":"AutomaticStopTimeMinutes", + "documentation":"

The number of minutes until the running instance is shut down after the environment has last been used.

" + }, + "ownerArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.

" + } + } + }, + "CreateEnvironmentEC2Result":{ + "type":"structure", + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment that was created.

" + } + } + }, + "CreateEnvironmentMembershipRequest":{ + "type":"structure", + "required":[ + "environmentId", + "userArn", + "permissions" + ], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment that contains the environment member you want to add.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the environment member you want to add.

" + }, + "permissions":{ + "shape":"MemberPermissions", + "documentation":"

The type of environment member permissions you want to associate with this environment member. Available values include:

  • read-only: Has read-only access to the environment.

  • read-write: Has read-write access to the environment.

" + } + } + }, + "CreateEnvironmentMembershipResult":{ + "type":"structure", + "members":{ + "membership":{ + "shape":"EnvironmentMember", + "documentation":"

Information about the environment member that was added.

" + } + } + }, + "DeleteEnvironmentMembershipRequest":{ + "type":"structure", + "required":[ + "environmentId", + "userArn" + ], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to delete the environment member from.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the environment member to delete from the environment.

" + } + } + }, + "DeleteEnvironmentMembershipResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteEnvironmentRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to delete.

" + } + } + }, + "DeleteEnvironmentResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeEnvironmentMembershipsRequest":{ + "type":"structure", + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.

" + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to get environment member information about.

" + }, + "permissions":{ + "shape":"PermissionsList", + "documentation":"

The type of environment member permissions to get information about. Available values include:

  • owner: Owns the environment.

  • read-only: Has read-only access to the environment.

  • read-write: Has read-write access to the environment.

If no value is specified, information about all environment members are returned.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of environment members to get information about.

" + } + } + }, + "DescribeEnvironmentMembershipsResult":{ + "type":"structure", + "members":{ + "memberships":{ + "shape":"EnvironmentMembersList", + "documentation":"

Information about the environment members for the environment.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + } + } + }, + "DescribeEnvironmentStatusRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to get status information about.

" + } + } + }, + "DescribeEnvironmentStatusResult":{ + "type":"structure", + "members":{ + "status":{ + "shape":"EnvironmentStatus", + "documentation":"

The status of the environment. Available values include:

  • connecting: The environment is connecting.

  • creating: The environment is being created.

  • deleting: The environment is being deleted.

  • error: The environment is in an error state.

  • ready: The environment is ready.

  • stopped: The environment is stopped.

  • stopping: The environment is stopping.

" + }, + "message":{ + "shape":"String", + "documentation":"

Any informational message about the status of the environment.

" + } + } + }, + "DescribeEnvironmentsRequest":{ + "type":"structure", + "required":["environmentIds"], + "members":{ + "environmentIds":{ + "shape":"BoundedEnvironmentIdList", + "documentation":"

The IDs of individual environments to get information about.

" + } + } + }, + "DescribeEnvironmentsResult":{ + "type":"structure", + "members":{ + "environments":{ + "shape":"EnvironmentList", + "documentation":"

Information about the environments that are returned.

" + } + } + }, + "Environment":{ + "type":"structure", + "members":{ + "id":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment.

" + }, + "name":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment.

" + }, + "description":{ + "shape":"EnvironmentDescription", + "documentation":"

The description for the environment.

" + }, + "type":{ + "shape":"EnvironmentType", + "documentation":"

The type of environment. Valid values include the following:

  • ec2: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.

  • ssh: Your own server connects to the environment.

" + }, + "arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the environment.

" + }, + "ownerArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the environment owner.

" + }, + "lifecycle":{ + "shape":"EnvironmentLifecycle", + "documentation":"

The state of the environment in its creation or deletion lifecycle.

" + } + }, + "documentation":"

Information about an AWS Cloud9 development environment.

" + }, + "EnvironmentDescription":{ + "type":"string", + "max":200, + "sensitive":true + }, + "EnvironmentId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9]{8,32}$" + }, + "EnvironmentIdList":{ + "type":"list", + "member":{"shape":"EnvironmentId"} + }, + "EnvironmentLifecycle":{ + "type":"structure", + "members":{ + "status":{ + "shape":"EnvironmentLifecycleStatus", + "documentation":"

The current creation or deletion lifecycle state of the environment.

  • CREATING: The environment is in the process of being created.

  • CREATED: The environment was successfully created.

  • CREATE_FAILED: The environment failed to be created.

  • DELETING: The environment is in the process of being deleted.

  • DELETE_FAILED: The environment failed to delete.

" + }, + "reason":{ + "shape":"String", + "documentation":"

Any informational message about the lifecycle state of the environment.

" + }, + "failureResource":{ + "shape":"String", + "documentation":"

If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.

" + } + }, + "documentation":"

Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.

" + }, + "EnvironmentLifecycleStatus":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "CREATE_FAILED", + "DELETING", + "DELETE_FAILED" + ] + }, + "EnvironmentList":{ + "type":"list", + "member":{"shape":"Environment"} + }, + "EnvironmentMember":{ + "type":"structure", + "members":{ + "permissions":{ + "shape":"Permissions", + "documentation":"

The type of environment member permissions associated with this environment member. Available values include:

  • owner: Owns the environment.

  • read-only: Has read-only access to the environment.

  • read-write: Has read-write access to the environment.

" + }, + "userId":{ + "shape":"String", + "documentation":"

The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the environment member.

" + }, + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment for the environment member.

" + }, + "lastAccess":{ + "shape":"Timestamp", + "documentation":"

The time, expressed in epoch time format, when the environment member last opened the environment.

" + } + }, + "documentation":"

Information about an environment member for an AWS Cloud9 development environment.

" + }, + "EnvironmentMembersList":{ + "type":"list", + "member":{"shape":"EnvironmentMember"} + }, + "EnvironmentName":{ + "type":"string", + "max":60, + "min":1 + }, + "EnvironmentStatus":{ + "type":"string", + "enum":[ + "error", + "creating", + "connecting", + "ready", + "stopping", + "stopped", + "deleting" + ] + }, + "EnvironmentType":{ + "type":"string", + "enum":[ + "ssh", + "ec2" + ] + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An access permissions issue occurred.

", + "exception":true + }, + "InstanceType":{ + "type":"string", + "max":20, + "min":5, + "pattern":"^[a-z][1-9][.][a-z0-9]+$" + }, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An internal server error occurred.

", + "exception":true, + "fault":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A service limit was exceeded.

", + "exception":true + }, + "ListEnvironmentsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"

During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of environments to get identifiers for.

" + } + } + }, + "ListEnvironmentsResult":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"

If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + }, + "environmentIds":{ + "shape":"EnvironmentIdList", + "documentation":"

The list of environment identifiers.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":25, + "min":0 + }, + "MemberPermissions":{ + "type":"string", + "enum":[ + "read-write", + "read-only" + ] + }, + "NotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target resource cannot be found.

", + "exception":true + }, + "Permissions":{ + "type":"string", + "enum":[ + "owner", + "read-write", + "read-only" + ] + }, + "PermissionsList":{ + "type":"list", + "member":{"shape":"Permissions"} + }, + "String":{"type":"string"}, + "SubnetId":{ + "type":"string", + "max":30, + "min":5 + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Too many service requests were made over the given time period.

", + "exception":true + }, + "UpdateEnvironmentMembershipRequest":{ + "type":"structure", + "required":[ + "environmentId", + "userArn", + "permissions" + ], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment for the environment member whose settings you want to change.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the environment member whose settings you want to change.

" + }, + "permissions":{ + "shape":"MemberPermissions", + "documentation":"

The replacement type of environment member permissions you want to associate with this environment member. Available values include:

  • read-only: Has read-only access to the environment.

  • read-write: Has read-write access to the environment.

" + } + } + }, + "UpdateEnvironmentMembershipResult":{ + "type":"structure", + "members":{ + "membership":{ + "shape":"EnvironmentMember", + "documentation":"

Information about the environment member whose settings were changed.

" + } + } + }, + "UpdateEnvironmentRequest":{ + "type":"structure", + "required":["environmentId"], + "members":{ + "environmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to change settings.

" + }, + "name":{ + "shape":"EnvironmentName", + "documentation":"

A replacement name for the environment.

" + }, + "description":{ + "shape":"EnvironmentDescription", + "documentation":"

Any new or replacement description for the environment.

" + } + } + }, + "UpdateEnvironmentResult":{ + "type":"structure", + "members":{ + } + }, + "UserArn":{ + "type":"string", + "pattern":"^arn:aws:(iam|sts)::\\d+:(root|(user\\/[\\w+=/:,.@-]{1,64}|federated-user\\/[\\w+=/:,.@-]{2,32}|assumed-role\\/[\\w+=/:,.@-]{1,64}\\/[\\w+=/:,.@-]{1,64}))$" + } + }, + "documentation":"AWS Cloud9

AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.

For more information about AWS Cloud9, see the AWS Cloud9 User Guide.

AWS Cloud9 supports these operations:

  • CreateEnvironmentEC2: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.

  • CreateEnvironmentMembership: Adds an environment member to an environment.

  • DeleteEnvironment: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.

  • DeleteEnvironmentMembership: Deletes an environment member from an environment.

  • DescribeEnvironmentMemberships: Gets information about environment members for an environment.

  • DescribeEnvironments: Gets information about environments.

  • DescribeEnvironmentStatus: Gets status information for an environment.

  • ListEnvironments: Gets a list of environment identifiers.

  • UpdateEnvironment: Changes the settings of an existing environment.

  • UpdateEnvironmentMembership: Changes the settings of an existing environment member for an environment.

" +} diff --git a/aws/dist/botocore/data/clouddirectory/2016-05-10/paginators-1.json b/aws/dist/botocore/data/clouddirectory/2016-05-10/paginators-1.json new file mode 100644 index 00000000..22cc439e --- /dev/null +++ b/aws/dist/botocore/data/clouddirectory/2016-05-10/paginators-1.json @@ -0,0 +1,100 @@ +{ + "pagination": { + "ListObjectParentPaths": { + "result_key": "PathToObjectIdentifiersList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetNames": { + "result_key": "FacetNames", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPublishedSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDirectories": { + "result_key": "Directories", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevelopmentSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetNames": { + "result_key": "FacetNames", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIndex": { + "result_key": "IndexAttachments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectPolicies": { + "result_key": "AttachedPolicyIds", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "result_key": "Tags", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAttachedIndices": { + "result_key": "IndexAttachments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "LookupPolicy": { + "result_key": "PolicyToPathList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPolicyAttachments": { + "result_key": "ObjectIdentifiers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAppliedSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/clouddirectory/2016-05-10/service-2.json b/aws/dist/botocore/data/clouddirectory/2016-05-10/service-2.json new file mode 100644 index 00000000..ca413a04 --- /dev/null +++ b/aws/dist/botocore/data/clouddirectory/2016-05-10/service-2.json @@ -0,0 +1,5924 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-05-10", + "endpointPrefix":"clouddirectory", + "protocol":"rest-json", + "serviceFullName":"Amazon CloudDirectory", + "serviceId":"CloudDirectory", + "signatureVersion":"v4", + "signingName":"clouddirectory", + "uid":"clouddirectory-2016-05-10" + }, + "operations":{ + "AddFacetToObject":{ + "name":"AddFacetToObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/facets", + "responseCode":200 + }, + "input":{"shape":"AddFacetToObjectRequest"}, + "output":{"shape":"AddFacetToObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Adds a new Facet to an object. An object can have more than one facet applied on it.

" + }, + "ApplySchema":{ + "name":"ApplySchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/apply", + "responseCode":200 + }, + "input":{"shape":"ApplySchemaRequest"}, + "output":{"shape":"ApplySchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"} + ], + "documentation":"

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

" + }, + "AttachObject":{ + "name":"AttachObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attach", + "responseCode":200 + }, + "input":{"shape":"AttachObjectRequest"}, + "output":{"shape":"AttachObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ValidationException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

" + }, + "AttachPolicy":{ + "name":"AttachPolicy", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/attach", + "responseCode":200 + }, + "input":{"shape":"AttachPolicyRequest"}, + "output":{"shape":"AttachPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "AttachToIndex":{ + "name":"AttachToIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index/attach", + "responseCode":200 + }, + "input":{"shape":"AttachToIndexRequest"}, + "output":{"shape":"AttachToIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"IndexedAttributeMissingException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Attaches the specified object to the specified index.

" + }, + "AttachTypedLink":{ + "name":"AttachTypedLink", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attach", + "responseCode":200 + }, + "input":{"shape":"AttachTypedLinkRequest"}, + "output":{"shape":"AttachTypedLinkResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ValidationException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" + }, + "BatchRead":{ + "name":"BatchRead", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/batchread", + "responseCode":200 + }, + "input":{"shape":"BatchReadRequest"}, + "output":{"shape":"BatchReadResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"} + ], + "documentation":"

Performs all the read operations in a batch.

" + }, + "BatchWrite":{ + "name":"BatchWrite", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/batchwrite", + "responseCode":200 + }, + "input":{"shape":"BatchWriteRequest"}, + "output":{"shape":"BatchWriteResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"BatchWriteException"} + ], + "documentation":"

Performs all the write operations in a batch. Either all the operations succeed or none.

" + }, + "CreateDirectory":{ + "name":"CreateDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/create", + "responseCode":200 + }, + "input":{"shape":"CreateDirectoryRequest"}, + "output":{"shape":"CreateDirectoryResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

" + }, + "CreateFacet":{ + "name":"CreateFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/create", + "responseCode":200 + }, + "input":{"shape":"CreateFacetRequest"}, + "output":{"shape":"CreateFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetAlreadyExistsException"}, + {"shape":"InvalidRuleException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

" + }, + "CreateIndex":{ + "name":"CreateIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index", + "responseCode":200 + }, + "input":{"shape":"CreateIndexRequest"}, + "output":{"shape":"CreateIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"UnsupportedIndexTypeException"} + ], + "documentation":"

Creates an index object. See Indexing for more information.

" + }, + "CreateObject":{ + "name":"CreateObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object", + "responseCode":200 + }, + "input":{"shape":"CreateObjectRequest"}, + "output":{"shape":"CreateObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"UnsupportedIndexTypeException"} + ], + "documentation":"

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

" + }, + "CreateSchema":{ + "name":"CreateSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/create", + "responseCode":200 + }, + "input":{"shape":"CreateSchemaRequest"}, + "output":{"shape":"CreateSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"SchemaAlreadyExistsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

" + }, + "CreateTypedLinkFacet":{ + "name":"CreateTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/create", + "responseCode":200 + }, + "input":{"shape":"CreateTypedLinkFacetRequest"}, + "output":{"shape":"CreateTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetAlreadyExistsException"}, + {"shape":"InvalidRuleException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Creates a TypedLinkFacet. For more information, see Typed link.

" + }, + "DeleteDirectory":{ + "name":"DeleteDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory", + "responseCode":200 + }, + "input":{"shape":"DeleteDirectoryRequest"}, + "output":{"shape":"DeleteDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryNotDisabledException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

" + }, + "DeleteFacet":{ + "name":"DeleteFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteFacetRequest"}, + "output":{"shape":"DeleteFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"FacetInUseException"} + ], + "documentation":"

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

" + }, + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ObjectNotDetachedException"} + ], + "documentation":"

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.

" + }, + "DeleteSchema":{ + "name":"DeleteSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema", + "responseCode":200 + }, + "input":{"shape":"DeleteSchemaRequest"}, + "output":{"shape":"DeleteSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"StillContainsLinksException"} + ], + "documentation":"

Deletes a given schema. Schemas in a development and published state can only be deleted.

" + }, + "DeleteTypedLinkFacet":{ + "name":"DeleteTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteTypedLinkFacetRequest"}, + "output":{"shape":"DeleteTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Deletes a TypedLinkFacet. For more information, see Typed link.

" + }, + "DetachFromIndex":{ + "name":"DetachFromIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index/detach", + "responseCode":200 + }, + "input":{"shape":"DetachFromIndexRequest"}, + "output":{"shape":"DetachFromIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ObjectAlreadyDetachedException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Detaches the specified object from the specified index.

" + }, + "DetachObject":{ + "name":"DetachObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/detach", + "responseCode":200 + }, + "input":{"shape":"DetachObjectRequest"}, + "output":{"shape":"DetachObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotNodeException"} + ], + "documentation":"

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

" + }, + "DetachPolicy":{ + "name":"DetachPolicy", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/detach", + "responseCode":200 + }, + "input":{"shape":"DetachPolicyRequest"}, + "output":{"shape":"DetachPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Detaches a policy from an object.

" + }, + "DetachTypedLink":{ + "name":"DetachTypedLink", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/detach", + "responseCode":200 + }, + "input":{"shape":"DetachTypedLinkRequest"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" + }, + "DisableDirectory":{ + "name":"DisableDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/disable", + "responseCode":200 + }, + "input":{"shape":"DisableDirectoryRequest"}, + "output":{"shape":"DisableDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

" + }, + "EnableDirectory":{ + "name":"EnableDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/enable", + "responseCode":200 + }, + "input":{"shape":"EnableDirectoryRequest"}, + "output":{"shape":"EnableDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

" + }, + "GetAppliedSchemaVersion":{ + "name":"GetAppliedSchemaVersion", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema", + "responseCode":200 + }, + "input":{"shape":"GetAppliedSchemaVersionRequest"}, + "output":{"shape":"GetAppliedSchemaVersionResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns current applied schema version ARN, including the minor version in use.

" + }, + "GetDirectory":{ + "name":"GetDirectory", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/get", + "responseCode":200 + }, + "input":{"shape":"GetDirectoryRequest"}, + "output":{"shape":"GetDirectoryResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves metadata about a directory.

" + }, + "GetFacet":{ + "name":"GetFacet", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet", + "responseCode":200 + }, + "input":{"shape":"GetFacetRequest"}, + "output":{"shape":"GetFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

" + }, + "GetLinkAttributes":{ + "name":"GetLinkAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get", + "responseCode":200 + }, + "input":{"shape":"GetLinkAttributesRequest"}, + "output":{"shape":"GetLinkAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Retrieves attributes that are associated with a typed link.

" + }, + "GetObjectAttributes":{ + "name":"GetObjectAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get", + "responseCode":200 + }, + "input":{"shape":"GetObjectAttributesRequest"}, + "output":{"shape":"GetObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "GetObjectInformation":{ + "name":"GetObjectInformation", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/information", + "responseCode":200 + }, + "input":{"shape":"GetObjectInformationRequest"}, + "output":{"shape":"GetObjectInformationResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves metadata about an object.

" + }, + "GetSchemaAsJson":{ + "name":"GetSchemaAsJson", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", + "responseCode":200 + }, + "input":{"shape":"GetSchemaAsJsonRequest"}, + "output":{"shape":"GetSchemaAsJsonResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

" + }, + "GetTypedLinkFacetInformation":{ + "name":"GetTypedLinkFacetInformation", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/get", + "responseCode":200 + }, + "input":{"shape":"GetTypedLinkFacetInformationRequest"}, + "output":{"shape":"GetTypedLinkFacetInformationResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed link.

" + }, + "ListAppliedSchemaArns":{ + "name":"ListAppliedSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/applied", + "responseCode":200 + }, + "input":{"shape":"ListAppliedSchemaArnsRequest"}, + "output":{"shape":"ListAppliedSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

" + }, + "ListAttachedIndices":{ + "name":"ListAttachedIndices", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/indices", + "responseCode":200 + }, + "input":{"shape":"ListAttachedIndicesRequest"}, + "output":{"shape":"ListAttachedIndicesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists indices attached to the specified object.

" + }, + "ListDevelopmentSchemaArns":{ + "name":"ListDevelopmentSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/development", + "responseCode":200 + }, + "input":{"shape":"ListDevelopmentSchemaArnsRequest"}, + "output":{"shape":"ListDevelopmentSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

" + }, + "ListDirectories":{ + "name":"ListDirectories", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/list", + "responseCode":200 + }, + "input":{"shape":"ListDirectoriesRequest"}, + "output":{"shape":"ListDirectoriesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists directories created within an account.

" + }, + "ListFacetAttributes":{ + "name":"ListFacetAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/attributes", + "responseCode":200 + }, + "input":{"shape":"ListFacetAttributesRequest"}, + "output":{"shape":"ListFacetAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves attributes attached to the facet.

" + }, + "ListFacetNames":{ + "name":"ListFacetNames", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/list", + "responseCode":200 + }, + "input":{"shape":"ListFacetNamesRequest"}, + "output":{"shape":"ListFacetNamesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves the names of facets that exist in a schema.

" + }, + "ListIncomingTypedLinks":{ + "name":"ListIncomingTypedLinks", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/incoming", + "responseCode":200 + }, + "input":{"shape":"ListIncomingTypedLinksRequest"}, + "output":{"shape":"ListIncomingTypedLinksResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "ListIndex":{ + "name":"ListIndex", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/index/targets", + "responseCode":200 + }, + "input":{"shape":"ListIndexRequest"}, + "output":{"shape":"ListIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"FacetValidationException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListObjectAttributes":{ + "name":"ListObjectAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes", + "responseCode":200 + }, + "input":{"shape":"ListObjectAttributesRequest"}, + "output":{"shape":"ListObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "name":"ListObjectChildren", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/children", + "responseCode":200 + }, + "input":{"shape":"ListObjectChildrenRequest"}, + "output":{"shape":"ListObjectChildrenResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NotNodeException"} + ], + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "ListObjectParentPaths":{ + "name":"ListObjectParentPaths", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/parentpaths", + "responseCode":200 + }, + "input":{"shape":"ListObjectParentPathsRequest"}, + "output":{"shape":"ListObjectParentPathsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

" + }, + "ListObjectParents":{ + "name":"ListObjectParents", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/parent", + "responseCode":200 + }, + "input":{"shape":"ListObjectParentsRequest"}, + "output":{"shape":"ListObjectParentsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"CannotListParentOfRootException"} + ], + "documentation":"

Lists parent objects that are associated with a given object in pagination fashion.

" + }, + "ListObjectPolicies":{ + "name":"ListObjectPolicies", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/policy", + "responseCode":200 + }, + "input":{"shape":"ListObjectPoliciesRequest"}, + "output":{"shape":"ListObjectPoliciesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListOutgoingTypedLinks":{ + "name":"ListOutgoingTypedLinks", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/outgoing", + "responseCode":200 + }, + "input":{"shape":"ListOutgoingTypedLinksRequest"}, + "output":{"shape":"ListOutgoingTypedLinksResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "ListPolicyAttachments":{ + "name":"ListPolicyAttachments", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/attachment", + "responseCode":200 + }, + "input":{"shape":"ListPolicyAttachmentsRequest"}, + "output":{"shape":"ListPolicyAttachmentsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "ListPublishedSchemaArns":{ + "name":"ListPublishedSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/published", + "responseCode":200 + }, + "input":{"shape":"ListPublishedSchemaArnsRequest"}, + "output":{"shape":"ListPublishedSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/tags", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

" + }, + "ListTypedLinkFacetAttributes":{ + "name":"ListTypedLinkFacetAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", + "responseCode":200 + }, + "input":{"shape":"ListTypedLinkFacetAttributesRequest"}, + "output":{"shape":"ListTypedLinkFacetAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed link.

" + }, + "ListTypedLinkFacetNames":{ + "name":"ListTypedLinkFacetNames", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/list", + "responseCode":200 + }, + "input":{"shape":"ListTypedLinkFacetNamesRequest"}, + "output":{"shape":"ListTypedLinkFacetNamesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed link.

" + }, + "LookupPolicy":{ + "name":"LookupPolicy", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/lookup", + "responseCode":200 + }, + "input":{"shape":"LookupPolicyRequest"}, + "output":{"shape":"LookupPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "PublishSchema":{ + "name":"PublishSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/publish", + "responseCode":200 + }, + "input":{"shape":"PublishSchemaRequest"}, + "output":{"shape":"PublishSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"SchemaAlreadyPublishedException"} + ], + "documentation":"

Publishes a development schema with a major version and a recommended minor version.

" + }, + "PutSchemaFromJson":{ + "name":"PutSchemaFromJson", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", + "responseCode":200 + }, + "input":{"shape":"PutSchemaFromJsonRequest"}, + "output":{"shape":"PutSchemaFromJsonResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidSchemaDocException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

" + }, + "RemoveFacetFromObject":{ + "name":"RemoveFacetFromObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/facets/delete", + "responseCode":200 + }, + "input":{"shape":"RemoveFacetFromObjectRequest"}, + "output":{"shape":"RemoveFacetFromObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Removes the specified facet from the specified object.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/tags/add", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

An API operation for adding tags to a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/tags/remove", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

An API operation for removing tags from a resource.

" + }, + "UpdateFacet":{ + "name":"UpdateFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet", + "responseCode":200 + }, + "input":{"shape":"UpdateFacetRequest"}, + "output":{"shape":"UpdateFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidFacetUpdateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

" + }, + "UpdateLinkAttributes":{ + "name":"UpdateLinkAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update", + "responseCode":200 + }, + "input":{"shape":"UpdateLinkAttributesRequest"}, + "output":{"shape":"UpdateLinkAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

" + }, + "UpdateObjectAttributes":{ + "name":"UpdateObjectAttributes", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/update", + "responseCode":200 + }, + "input":{"shape":"UpdateObjectAttributesRequest"}, + "output":{"shape":"UpdateObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Updates a given object's attributes.

" + }, + "UpdateSchema":{ + "name":"UpdateSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/update", + "responseCode":200 + }, + "input":{"shape":"UpdateSchemaRequest"}, + "output":{"shape":"UpdateSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the schema name with a new name. Only development schema names can be updated.

" + }, + "UpdateTypedLinkFacet":{ + "name":"UpdateTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet", + "responseCode":200 + }, + "input":{"shape":"UpdateTypedLinkFacetRequest"}, + "output":{"shape":"UpdateTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"FacetValidationException"}, + {"shape":"InvalidFacetUpdateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Updates a TypedLinkFacet. For more information, see Typed link.

" + }, + "UpgradeAppliedSchema":{ + "name":"UpgradeAppliedSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied", + "responseCode":200 + }, + "input":{"shape":"UpgradeAppliedSchemaRequest"}, + "output":{"shape":"UpgradeAppliedSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"IncompatibleSchemaException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"} + ], + "documentation":"

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

" + }, + "UpgradePublishedSchema":{ + "name":"UpgradePublishedSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished", + "responseCode":200 + }, + "input":{"shape":"UpgradePublishedSchemaRequest"}, + "output":{"shape":"UpgradePublishedSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"IncompatibleSchemaException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Access denied. Check your permissions.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AddFacetToObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

Attributes on the facet that you are adding to the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object you are adding the specified facet to.

" + } + } + }, + "AddFacetToObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "ApplySchemaRequest":{ + "type":"structure", + "required":[ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "ApplySchemaResponse":{ + "type":"structure", + "members":{ + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" + } + } + }, + "Arn":{"type":"string"}, + "Arns":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "AttachObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ParentReference", + "ChildReference", + "LinkName" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent object reference.

" + }, + "ChildReference":{ + "shape":"ObjectReference", + "documentation":"

The child object reference to be attached to the object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The link name with which the child object is attached to the parent.

" + } + } + }, + "AttachObjectResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The attached ObjectIdentifier, which is the child ObjectIdentifier.

" + } + } + }, + "AttachPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that is associated with the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object to which the policy will be attached.

" + } + } + }, + "AttachPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "AttachToIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where the object and index exist.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index that you are attaching the object to.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that you are attaching to the index.

" + } + } + }, + "AttachToIndexResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" + } + } + }, + "AttachTypedLinkRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "Attributes":{ + "shape":"AttributeNameAndValueList", + "documentation":"

A set of attributes that are associated with the typed link.

" + } + } + }, + "AttachTypedLinkResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Returns a typed link specifier as output.

" + } + } + }, + "AttributeKey":{ + "type":"structure", + "required":[ + "SchemaArn", + "FacetName", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

" + }, + "FacetName":{ + "shape":"FacetName", + "documentation":"

The name of the facet that the attribute exists within.

" + }, + "Name":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + } + }, + "documentation":"

A unique identifier for an attribute.

" + }, + "AttributeKeyAndValue":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute.

" + }, + "Value":{ + "shape":"TypedAttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

The combination of an attribute key and an attribute value.

" + }, + "AttributeKeyAndValueList":{ + "type":"list", + "member":{"shape":"AttributeKeyAndValue"} + }, + "AttributeKeyList":{ + "type":"list", + "member":{"shape":"AttributeKey"} + }, + "AttributeName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "AttributeNameAndValue":{ + "type":"structure", + "required":[ + "AttributeName", + "Value" + ], + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The attribute name of the typed link.

" + }, + "Value":{ + "shape":"TypedAttributeValue", + "documentation":"

The value for the typed link.

" + } + }, + "documentation":"

Identifies the attribute name and value for a typed link.

" + }, + "AttributeNameAndValueList":{ + "type":"list", + "member":{"shape":"AttributeNameAndValue"} + }, + "AttributeNameList":{ + "type":"list", + "member":{"shape":"AttributeName"} + }, + "BatchAddFacetToObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectAttributeList", + "ObjectReference" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Represents the facet being added to the object.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes to set on the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being mutated.

" + } + }, + "documentation":"

Represents the output of a batch add facet to object operation.

" + }, + "BatchAddFacetToObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a batch add facet to object operation.

" + }, + "BatchAttachObject":{ + "type":"structure", + "required":[ + "ParentReference", + "ChildReference", + "LinkName" + ], + "members":{ + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent object reference.

" + }, + "ChildReference":{ + "shape":"ObjectReference", + "documentation":"

The child object reference that is to be attached to the object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + } + }, + "documentation":"

Represents the output of an AttachObject operation.

" + }, + "BatchAttachObjectResponse":{ + "type":"structure", + "members":{ + "attachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that has been attached.

" + } + }, + "documentation":"

Represents the output batch AttachObject response operation.

" + }, + "BatchAttachPolicy":{ + "type":"structure", + "required":[ + "PolicyReference", + "ObjectReference" + ], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that is associated with the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object to which the policy will be attached.

" + } + }, + "documentation":"

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.

" + }, + "BatchAttachPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of an AttachPolicy response operation.

" + }, + "BatchAttachToIndex":{ + "type":"structure", + "required":[ + "IndexReference", + "TargetReference" + ], + "members":{ + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index that you are attaching the object to.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that you are attaching to the index.

" + } + }, + "documentation":"

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.

" + }, + "BatchAttachToIndexResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" + } + }, + "documentation":"

Represents the output of a AttachToIndex response operation.

" + }, + "BatchAttachTypedLink":{ + "type":"structure", + "required":[ + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members":{ + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "Attributes":{ + "shape":"AttributeNameAndValueList", + "documentation":"

A set of attributes that are associated with the typed link.

" + } + }, + "documentation":"

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.

" + }, + "BatchAttachTypedLinkResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Returns a typed link specifier as output.

" + } + }, + "documentation":"

Represents the output of a AttachTypedLink response operation.

" + }, + "BatchCreateIndex":{ + "type":"structure", + "required":[ + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members":{ + "OrderedIndexedAttributeList":{ + "shape":"AttributeKeyList", + "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" + }, + "IsUnique":{ + "shape":"Bool", + "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the parent object that contains the index object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link between the parent object and the index object.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Batches for more information.

" + } + }, + "documentation":"

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

" + }, + "BatchCreateIndexResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the index created by this operation.

" + } + }, + "documentation":"

Represents the output of a CreateIndex response operation.

" + }, + "BatchCreateObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectAttributeList" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacetList", + "documentation":"

A list of FacetArns that will be associated with the object. For more information, see arns.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

An attribute map, which contains an attribute ARN as the key and attribute value as the map value.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

If specified, the parent reference to which this object will be attached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Batches for more information.

" + } + }, + "documentation":"

Represents the output of a CreateObject operation.

" + }, + "BatchCreateObjectResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ID that is associated with the object.

" + } + }, + "documentation":"

Represents the output of a CreateObject response operation.

" + }, + "BatchDeleteObject":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object.

" + } + }, + "documentation":"

Represents the output of a DeleteObject operation.

" + }, + "BatchDeleteObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DeleteObject response operation.

" + }, + "BatchDetachFromIndex":{ + "type":"structure", + "required":[ + "IndexReference", + "TargetReference" + ], + "members":{ + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index object.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being detached from the index.

" + } + }, + "documentation":"

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.

" + }, + "BatchDetachFromIndexResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" + } + }, + "documentation":"

Represents the output of a DetachFromIndex response operation.

" + }, + "BatchDetachObject":{ + "type":"structure", + "required":[ + "ParentReference", + "LinkName" + ], + "members":{ + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

Parent reference from which the object with the specified link name is detached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Batches for more information.

" + } + }, + "documentation":"

Represents the output of a DetachObject operation.

" + }, + "BatchDetachObjectResponse":{ + "type":"structure", + "members":{ + "detachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the detached object.

" + } + }, + "documentation":"

Represents the output of a DetachObject response operation.

" + }, + "BatchDetachPolicy":{ + "type":"structure", + "required":[ + "PolicyReference", + "ObjectReference" + ], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policy object will be detached.

" + } + }, + "documentation":"

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.

" + }, + "BatchDetachPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DetachPolicy response operation.

" + }, + "BatchDetachTypedLink":{ + "type":"structure", + "required":["TypedLinkSpecifier"], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Used to accept a typed link specifier as input.

" + } + }, + "documentation":"

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.

" + }, + "BatchDetachTypedLinkResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DetachTypedLink response operation.

" + }, + "BatchGetLinkAttributes":{ + "type":"structure", + "required":[ + "TypedLinkSpecifier", + "AttributeNames" + ], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attribute names whose values will be retrieved.

" + } + }, + "documentation":"

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.

" + }, + "BatchGetLinkAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the typed link.

" + } + }, + "documentation":"

Represents the output of a GetLinkAttributes response operation.

" + }, + "BatchGetObjectAttributes":{ + "type":"structure", + "required":[ + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

List of attribute names whose values will be retrieved.

" + } + }, + "documentation":"

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.

" + }, + "BatchGetObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attribute values that are associated with an object.

" + } + }, + "documentation":"

Represents the output of a GetObjectAttributes response operation.

" + }, + "BatchGetObjectInformation":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object.

" + } + }, + "documentation":"

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.

" + }, + "BatchGetObjectInformationResponse":{ + "type":"structure", + "members":{ + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

The facets attached to the specified object.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the specified object.

" + } + }, + "documentation":"

Represents the output of a GetObjectInformation response operation.

" + }, + "BatchListAttachedIndices":{ + "type":"structure", + "required":["TargetReference"], + "members":{ + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that has indices attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.

" + }, + "BatchListAttachedIndicesResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The indices attached to the specified object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListAttachedIndices response operation.

" + }, + "BatchListIncomingTypedLinks":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.

" + }, + "BatchListIncomingTypedLinksResponse":{ + "type":"structure", + "members":{ + "LinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns one or more typed link specifiers as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListIncomingTypedLinks response operation.

" + }, + "BatchListIndex":{ + "type":"structure", + "required":["IndexReference"], + "members":{ + "RangesOnIndexedValues":{ + "shape":"ObjectAttributeRangeList", + "documentation":"

Specifies the ranges of indexed values that you want to query.

" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

The reference to the index to list.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

" + }, + "BatchListIndexResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The objects and indexed values attached to the index.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListIndex response operation.

" + }, + "BatchListObjectAttributes":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference of the object whose attributes need to be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "FacetFilter":{ + "shape":"SchemaFacet", + "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" + } + }, + "documentation":"

Represents the output of a ListObjectAttributes operation.

" + }, + "BatchListObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectAttributes response operation.

" + }, + "BatchListObjectChildren":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference of the object for which child objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + }, + "documentation":"

Represents the output of a ListObjectChildren operation.

" + }, + "BatchListObjectChildrenResponse":{ + "type":"structure", + "members":{ + "Children":{ + "shape":"LinkNameToObjectIdentifierMap", + "documentation":"

The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectChildren response operation.

" + }, + "BatchListObjectParentPaths":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.

" + }, + "BatchListObjectParentPathsResponse":{ + "type":"structure", + "members":{ + "PathToObjectIdentifiersList":{ + "shape":"PathToObjectIdentifiersList", + "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectParentPaths response operation.

" + }, + "BatchListObjectPolicies":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.

" + }, + "BatchListObjectPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicyIds":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectPolicies response operation.

" + }, + "BatchListOutgoingTypedLinks":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

" + }, + "BatchListOutgoingTypedLinksResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns a typed link specifier as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListOutgoingTypedLinks response operation.

" + }, + "BatchListPolicyAttachments":{ + "type":"structure", + "required":["PolicyReference"], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the policy object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.

" + }, + "BatchListPolicyAttachmentsResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListPolicyAttachments response operation.

" + }, + "BatchLookupPolicy":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policies will be looked up.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.

" + }, + "BatchLookupPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyToPathList":{ + "shape":"PolicyToPathList", + "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a LookupPolicy response operation.

" + }, + "BatchOperationIndex":{"type":"integer"}, + "BatchReadException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"BatchReadExceptionType", + "documentation":"

A type of exception, such as InvalidArnException.

" + }, + "Message":{ + "shape":"ExceptionMessage", + "documentation":"

An exception message that is associated with the failure.

" + } + }, + "documentation":"

The batch read exception structure, which contains the exception type and message.

" + }, + "BatchReadExceptionType":{ + "type":"string", + "enum":[ + "ValidationException", + "InvalidArnException", + "ResourceNotFoundException", + "InvalidNextTokenException", + "AccessDeniedException", + "NotNodeException", + "FacetValidationException", + "CannotListParentOfRootException", + "NotIndexException", + "NotPolicyException", + "DirectoryNotEnabledException", + "LimitExceededException", + "InternalServiceException" + ] + }, + "BatchReadOperation":{ + "type":"structure", + "members":{ + "ListObjectAttributes":{ + "shape":"BatchListObjectAttributes", + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "shape":"BatchListObjectChildren", + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "ListAttachedIndices":{ + "shape":"BatchListAttachedIndices", + "documentation":"

Lists indices attached to an object.

" + }, + "ListObjectParentPaths":{ + "shape":"BatchListObjectParentPaths", + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" + }, + "GetObjectInformation":{ + "shape":"BatchGetObjectInformation", + "documentation":"

Retrieves metadata about an object.

" + }, + "GetObjectAttributes":{ + "shape":"BatchGetObjectAttributes", + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "ListObjectPolicies":{ + "shape":"BatchListObjectPolicies", + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListPolicyAttachments":{ + "shape":"BatchListPolicyAttachments", + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "LookupPolicy":{ + "shape":"BatchLookupPolicy", + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "ListIndex":{ + "shape":"BatchListIndex", + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListOutgoingTypedLinks":{ + "shape":"BatchListOutgoingTypedLinks", + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "ListIncomingTypedLinks":{ + "shape":"BatchListIncomingTypedLinks", + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "GetLinkAttributes":{ + "shape":"BatchGetLinkAttributes", + "documentation":"

Retrieves attributes that are associated with a typed link.

" + } + }, + "documentation":"

Represents the output of a BatchRead operation.

" + }, + "BatchReadOperationList":{ + "type":"list", + "member":{"shape":"BatchReadOperation"} + }, + "BatchReadOperationResponse":{ + "type":"structure", + "members":{ + "SuccessfulResponse":{ + "shape":"BatchReadSuccessfulResponse", + "documentation":"

Identifies which operation in a batch has succeeded.

" + }, + "ExceptionResponse":{ + "shape":"BatchReadException", + "documentation":"

Identifies which operation in a batch has failed.

" + } + }, + "documentation":"

Represents the output of a BatchRead response operation.

" + }, + "BatchReadOperationResponseList":{ + "type":"list", + "member":{"shape":"BatchReadOperationResponse"} + }, + "BatchReadRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Operations" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Operations":{ + "shape":"BatchReadOperationList", + "documentation":"

A list of operations that are part of the batch.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "BatchReadResponse":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchReadOperationResponseList", + "documentation":"

A list of all the responses for each batch read.

" + } + } + }, + "BatchReadSuccessfulResponse":{ + "type":"structure", + "members":{ + "ListObjectAttributes":{ + "shape":"BatchListObjectAttributesResponse", + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "shape":"BatchListObjectChildrenResponse", + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "GetObjectInformation":{ + "shape":"BatchGetObjectInformationResponse", + "documentation":"

Retrieves metadata about an object.

" + }, + "GetObjectAttributes":{ + "shape":"BatchGetObjectAttributesResponse", + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "ListAttachedIndices":{ + "shape":"BatchListAttachedIndicesResponse", + "documentation":"

Lists indices attached to an object.

" + }, + "ListObjectParentPaths":{ + "shape":"BatchListObjectParentPathsResponse", + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" + }, + "ListObjectPolicies":{ + "shape":"BatchListObjectPoliciesResponse", + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListPolicyAttachments":{ + "shape":"BatchListPolicyAttachmentsResponse", + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "LookupPolicy":{ + "shape":"BatchLookupPolicyResponse", + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "ListIndex":{ + "shape":"BatchListIndexResponse", + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListOutgoingTypedLinks":{ + "shape":"BatchListOutgoingTypedLinksResponse", + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "ListIncomingTypedLinks":{ + "shape":"BatchListIncomingTypedLinksResponse", + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed link.

" + }, + "GetLinkAttributes":{ + "shape":"BatchGetLinkAttributesResponse", + "documentation":"

The list of attributes to retrieve from the typed link.

" + } + }, + "documentation":"

Represents the output of a BatchRead success response operation.

" + }, + "BatchReferenceName":{"type":"string"}, + "BatchRemoveFacetFromObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

The facet to remove from the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object whose facet will be removed.

" + } + }, + "documentation":"

A batch operation to remove a facet from an object.

" + }, + "BatchRemoveFacetFromObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty result that represents success.

" + }, + "BatchUpdateLinkAttributes":{ + "type":"structure", + "required":[ + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeUpdates":{ + "shape":"LinkAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + }, + "documentation":"

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and BatchReadRequest$Operations.

" + }, + "BatchUpdateLinkAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a UpdateLinkAttributes response operation.

" + }, + "BatchUpdateObjectAttributes":{ + "type":"structure", + "required":[ + "ObjectReference", + "AttributeUpdates" + ], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object.

" + }, + "AttributeUpdates":{ + "shape":"ObjectAttributeUpdateList", + "documentation":"

Attributes update structure.

" + } + }, + "documentation":"

Represents the output of a BatchUpdate operation.

" + }, + "BatchUpdateObjectAttributesResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

ID that is associated with the object.

" + } + }, + "documentation":"

Represents the output of a BatchUpdate response operation.

" + }, + "BatchWriteException":{ + "type":"structure", + "members":{ + "Index":{"shape":"BatchOperationIndex"}, + "Type":{"shape":"BatchWriteExceptionType"}, + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A BatchWrite exception has occurred.

", + "exception":true + }, + "BatchWriteExceptionType":{ + "type":"string", + "enum":[ + "InternalServiceException", + "ValidationException", + "InvalidArnException", + "LinkNameAlreadyInUseException", + "StillContainsLinksException", + "FacetValidationException", + "ObjectNotDetachedException", + "ResourceNotFoundException", + "AccessDeniedException", + "InvalidAttachmentException", + "NotIndexException", + "NotNodeException", + "IndexedAttributeMissingException", + "ObjectAlreadyDetachedException", + "NotPolicyException", + "DirectoryNotEnabledException", + "LimitExceededException", + "UnsupportedIndexTypeException" + ] + }, + "BatchWriteOperation":{ + "type":"structure", + "members":{ + "CreateObject":{ + "shape":"BatchCreateObject", + "documentation":"

Creates an object.

" + }, + "AttachObject":{ + "shape":"BatchAttachObject", + "documentation":"

Attaches an object to a Directory.

" + }, + "DetachObject":{ + "shape":"BatchDetachObject", + "documentation":"

Detaches an object from a Directory.

" + }, + "UpdateObjectAttributes":{ + "shape":"BatchUpdateObjectAttributes", + "documentation":"

Updates a given object's attributes.

" + }, + "DeleteObject":{ + "shape":"BatchDeleteObject", + "documentation":"

Deletes an object in a Directory.

" + }, + "AddFacetToObject":{ + "shape":"BatchAddFacetToObject", + "documentation":"

A batch operation that adds a facet to an object.

" + }, + "RemoveFacetFromObject":{ + "shape":"BatchRemoveFacetFromObject", + "documentation":"

A batch operation that removes a facet from an object.

" + }, + "AttachPolicy":{ + "shape":"BatchAttachPolicy", + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "DetachPolicy":{ + "shape":"BatchDetachPolicy", + "documentation":"

Detaches a policy from a Directory.

" + }, + "CreateIndex":{ + "shape":"BatchCreateIndex", + "documentation":"

Creates an index object. See Indexing for more information.

" + }, + "AttachToIndex":{ + "shape":"BatchAttachToIndex", + "documentation":"

Attaches the specified object to the specified index.

" + }, + "DetachFromIndex":{ + "shape":"BatchDetachFromIndex", + "documentation":"

Detaches the specified object from the specified index.

" + }, + "AttachTypedLink":{ + "shape":"BatchAttachTypedLink", + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" + }, + "DetachTypedLink":{ + "shape":"BatchDetachTypedLink", + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" + }, + "UpdateLinkAttributes":{ + "shape":"BatchUpdateLinkAttributes", + "documentation":"

Updates a given object's attributes.

" + } + }, + "documentation":"

Represents the output of a BatchWrite operation.

" + }, + "BatchWriteOperationList":{ + "type":"list", + "member":{"shape":"BatchWriteOperation"} + }, + "BatchWriteOperationResponse":{ + "type":"structure", + "members":{ + "CreateObject":{ + "shape":"BatchCreateObjectResponse", + "documentation":"

Creates an object in a Directory.

" + }, + "AttachObject":{ + "shape":"BatchAttachObjectResponse", + "documentation":"

Attaches an object to a Directory.

" + }, + "DetachObject":{ + "shape":"BatchDetachObjectResponse", + "documentation":"

Detaches an object from a Directory.

" + }, + "UpdateObjectAttributes":{ + "shape":"BatchUpdateObjectAttributesResponse", + "documentation":"

Updates a given object’s attributes.

" + }, + "DeleteObject":{ + "shape":"BatchDeleteObjectResponse", + "documentation":"

Deletes an object in a Directory.

" + }, + "AddFacetToObject":{ + "shape":"BatchAddFacetToObjectResponse", + "documentation":"

The result of an add facet to object batch operation.

" + }, + "RemoveFacetFromObject":{ + "shape":"BatchRemoveFacetFromObjectResponse", + "documentation":"

The result of a batch remove facet from object operation.

" + }, + "AttachPolicy":{ + "shape":"BatchAttachPolicyResponse", + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "DetachPolicy":{ + "shape":"BatchDetachPolicyResponse", + "documentation":"

Detaches a policy from a Directory.

" + }, + "CreateIndex":{ + "shape":"BatchCreateIndexResponse", + "documentation":"

Creates an index object. See Indexing for more information.

" + }, + "AttachToIndex":{ + "shape":"BatchAttachToIndexResponse", + "documentation":"

Attaches the specified object to the specified index.

" + }, + "DetachFromIndex":{ + "shape":"BatchDetachFromIndexResponse", + "documentation":"

Detaches the specified object from the specified index.

" + }, + "AttachTypedLink":{ + "shape":"BatchAttachTypedLinkResponse", + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed link.

" + }, + "DetachTypedLink":{ + "shape":"BatchDetachTypedLinkResponse", + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed link.

" + }, + "UpdateLinkAttributes":{ + "shape":"BatchUpdateLinkAttributesResponse", + "documentation":"

Represents the output of a BatchWrite response operation.

" + } + }, + "documentation":"

Represents the output of a BatchWrite response operation.

" + }, + "BatchWriteOperationResponseList":{ + "type":"list", + "member":{"shape":"BatchWriteOperationResponse"} + }, + "BatchWriteRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Operations" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Operations":{ + "shape":"BatchWriteOperationList", + "documentation":"

A list of operations that are part of the batch.

" + } + } + }, + "BatchWriteResponse":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchWriteOperationResponseList", + "documentation":"

A list of all the responses for each batch write.

" + } + } + }, + "BinaryAttributeValue":{"type":"blob"}, + "Bool":{"type":"boolean"}, + "BooleanAttributeValue":{"type":"boolean"}, + "CannotListParentOfRootException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Cannot list the parents of a Directory root.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConsistencyLevel":{ + "type":"string", + "enum":[ + "SERIALIZABLE", + "EVENTUAL" + ] + }, + "CreateDirectoryRequest":{ + "type":"structure", + "required":[ + "Name", + "SchemaArn" + ], + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the Directory. Should be unique per account, per region.

" + }, + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "CreateDirectoryResponse":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Name", + "ObjectIdentifier", + "AppliedSchemaArn" + ], + "members":{ + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" + }, + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the Directory.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The root object node of the created directory.

" + }, + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

" + } + } + }, + "CreateFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name", + "ObjectType" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The schema ARN in which the new Facet will be created. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the Facet, which is unique for a given schema.

" + }, + "Attributes":{ + "shape":"FacetAttributeList", + "documentation":"

The attributes that are associated with the Facet.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.

  • Leaf node: Cannot have children but can have multiple parents.

  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

  • Index: Can be created with the Index API.

" + } + } + }, + "CreateFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory where the index should be created.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "OrderedIndexedAttributeList":{ + "shape":"AttributeKeyList", + "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" + }, + "IsUnique":{ + "shape":"Bool", + "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the parent object that contains the index object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link between the parent object and the index object.

" + } + } + }, + "CreateIndexResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the index created by this operation.

" + } + } + }, + "CreateObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacets" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attribute map whose attribute ARN contains the key and attribute value as the map value.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

If specified, the parent reference to which this object will be attached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of link that is used to attach this object to a parent.

" + } + } + }, + "CreateObjectResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The identifier that is associated with the object.

" + } + } + }, + "CreateSchemaRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"SchemaName", + "documentation":"

The name that is associated with the schema. This is unique to each account and in each region.

" + } + } + }, + "CreateSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" + } + } + }, + "CreateTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Facet" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Facet":{ + "shape":"TypedLinkFacet", + "documentation":"

Facet structure that is associated with the typed link facet.

" + } + } + }, + "CreateTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "Date":{"type":"timestamp"}, + "DatetimeAttributeValue":{"type":"timestamp"}, + "DeleteDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to delete.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DeleteDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the deleted directory.

" + } + } + }, + "DeleteFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet to delete.

" + } + } + }, + "DeleteFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference that identifies the object.

" + } + } + }, + "DeleteObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSchemaRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DeleteSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The input ARN that is returned as part of the response. For more information, see arns.

" + } + } + }, + "DeleteTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + } + }, + "DeleteTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "DetachFromIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory the index and object exist in.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index object.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being detached from the index.

" + } + } + }, + "DetachFromIndexResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" + } + } + }, + "DetachObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ParentReference", + "LinkName" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent reference from which the object with the specified link name is detached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The link name associated with the object that needs to be detached.

" + } + } + }, + "DetachObjectResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier that was detached from the object.

" + } + } + }, + "DetachPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policy object will be detached.

" + } + } + }, + "DetachPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DetachTypedLinkRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Used to accept a typed link specifier as input.

" + } + } + }, + "Directory":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the directory.

" + }, + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

" + }, + "State":{ + "shape":"DirectoryState", + "documentation":"

The state of the directory. Can be either Enabled, Disabled, or Deleted.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the directory was created.

" + } + }, + "documentation":"

Directory structure that includes the directory name and directory ARN.

" + }, + "DirectoryAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryArn":{"type":"string"}, + "DirectoryDeletedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryList":{ + "type":"list", + "member":{"shape":"Directory"} + }, + "DirectoryName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "DirectoryNotDisabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An operation can only operate on a disabled directory.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryNotEnabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Operations are only permitted on enabled directories.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "DELETED" + ] + }, + "DisableDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to disable.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DisableDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that has been disabled.

" + } + } + }, + "EnableDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to enable.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "EnableDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the enabled directory.

" + } + } + }, + "ExceptionMessage":{"type":"string"}, + "Facet":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the Facet.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" + } + }, + "documentation":"

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

" + }, + "FacetAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A facet with the same name already exists.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetAttribute":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

The name of the facet attribute.

" + }, + "AttributeDefinition":{ + "shape":"FacetAttributeDefinition", + "documentation":"

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

" + }, + "AttributeReference":{ + "shape":"FacetAttributeReference", + "documentation":"

An attribute reference that is associated with the attribute. See Attribute References for more information.

" + }, + "RequiredBehavior":{ + "shape":"RequiredAttributeBehavior", + "documentation":"

The required behavior of the FacetAttribute.

" + } + }, + "documentation":"

An attribute that is associated with the Facet.

" + }, + "FacetAttributeDefinition":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"FacetAttributeType", + "documentation":"

The type of the attribute.

" + }, + "DefaultValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The default value of the attribute (if configured).

" + }, + "IsImmutable":{ + "shape":"Bool", + "documentation":"

Whether the attribute is mutable or not.

" + }, + "Rules":{ + "shape":"RuleMap", + "documentation":"

Validation rules attached to the attribute definition.

" + } + }, + "documentation":"

A facet attribute definition. See Attribute References for more information.

" + }, + "FacetAttributeList":{ + "type":"list", + "member":{"shape":"FacetAttribute"} + }, + "FacetAttributeReference":{ + "type":"structure", + "required":[ + "TargetFacetName", + "TargetAttributeName" + ], + "members":{ + "TargetFacetName":{ + "shape":"FacetName", + "documentation":"

The target facet name that is associated with the facet reference. See Attribute References for more information.

" + }, + "TargetAttributeName":{ + "shape":"AttributeName", + "documentation":"

The target attribute name that is associated with the facet reference. See Attribute References for more information.

" + } + }, + "documentation":"

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

" + }, + "FacetAttributeType":{ + "type":"string", + "enum":[ + "STRING", + "BINARY", + "BOOLEAN", + "NUMBER", + "DATETIME" + ] + }, + "FacetAttributeUpdate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"FacetAttribute", + "documentation":"

The attribute to update.

" + }, + "Action":{ + "shape":"UpdateActionType", + "documentation":"

The action to perform when updating the attribute.

" + } + }, + "documentation":"

A structure that contains information used to update an attribute.

" + }, + "FacetAttributeUpdateList":{ + "type":"list", + "member":{"shape":"FacetAttributeUpdate"} + }, + "FacetInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "FacetNameList":{ + "type":"list", + "member":{"shape":"FacetName"} + }, + "FacetNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified Facet could not be found.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The Facet that you provided was not well formed or could not be validated with the schema.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "GetAppliedSchemaVersionRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the applied schema.

" + } + } + }, + "GetAppliedSchemaVersionResponse":{ + "type":"structure", + "members":{ + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

Current applied schema ARN, including the minor version in use if one was provided.

" + } + } + }, + "GetDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The ARN of the directory.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "GetDirectoryResponse":{ + "type":"structure", + "required":["Directory"], + "members":{ + "Directory":{ + "shape":"Directory", + "documentation":"

Metadata about the directory.

" + } + } + }, + "GetFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet to retrieve.

" + } + } + }, + "GetFacetResponse":{ + "type":"structure", + "members":{ + "Facet":{ + "shape":"Facet", + "documentation":"

The Facet structure that is associated with the facet.

" + } + } + }, + "GetLinkAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeNames" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attribute names whose values will be retrieved.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the attributes on a typed link.

" + } + } + }, + "GetLinkAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the typed link.

" + } + } + }, + "GetObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the attributes on an object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

List of attribute names whose values will be retrieved.

" + } + } + }, + "GetObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the object.

" + } + } + }, + "GetObjectInformationRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory being retrieved.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the object information.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "GetObjectInformationResponse":{ + "type":"structure", + "members":{ + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the specified object.

" + } + } + }, + "GetSchemaAsJsonRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to retrieve.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "GetSchemaAsJsonResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"SchemaName", + "documentation":"

The name of the retrieved schema.

" + }, + "Document":{ + "shape":"SchemaJsonDocument", + "documentation":"

The JSON representation of the schema document.

" + } + } + }, + "GetTypedLinkFacetInformationRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + } + }, + "GetTypedLinkFacetInformationResponse":{ + "type":"structure", + "members":{ + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

" + } + } + }, + "IncompatibleSchemaException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IndexAttachment":{ + "type":"structure", + "members":{ + "IndexedAttributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The indexed attribute values.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

" + } + }, + "documentation":"

Represents an index and an attached object.

" + }, + "IndexAttachmentList":{ + "type":"list", + "member":{"shape":"IndexAttachment"} + }, + "IndexedAttributeMissingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidArnException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the provided ARN value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidAttachmentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidFacetUpdateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An attempt to modify a Facet resulted in an invalid schema exception.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the NextToken value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRuleException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when any of the rule parameter keys or values are invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSchemaDocException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the provided SchemaDoc value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTaggingRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that limits are exceeded. See Limits for more information.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LinkAttributeAction":{ + "type":"structure", + "members":{ + "AttributeActionType":{ + "shape":"UpdateActionType", + "documentation":"

A type that can be either UPDATE_OR_CREATE or DELETE.

" + }, + "AttributeUpdateValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value that you want to update to.

" + } + }, + "documentation":"

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

" + }, + "LinkAttributeUpdate":{ + "type":"structure", + "members":{ + "AttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute being updated.

" + }, + "AttributeAction":{ + "shape":"LinkAttributeAction", + "documentation":"

The action to perform as part of the attribute update.

" + } + }, + "documentation":"

Structure that contains attribute update information.

" + }, + "LinkAttributeUpdateList":{ + "type":"list", + "member":{"shape":"LinkAttributeUpdate"} + }, + "LinkName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+" + }, + "LinkNameAlreadyInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LinkNameToObjectIdentifierMap":{ + "type":"map", + "key":{"shape":"LinkName"}, + "value":{"shape":"ObjectIdentifier"} + }, + "ListAppliedSchemaArnsRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory you are listing.

" + }, + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListAppliedSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of schemas that are applied to the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListAttachedIndicesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that has indices attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to use for this operation.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListAttachedIndicesResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The indices attached to the specified object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListDevelopmentSchemaArnsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListDevelopmentSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of retrieved development schemas.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListDirectoriesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "state":{ + "shape":"DirectoryState", + "documentation":"

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

" + } + } + }, + "ListDirectoriesResponse":{ + "type":"structure", + "required":["Directories"], + "members":{ + "Directories":{ + "shape":"DirectoryList", + "documentation":"

Lists all directories that are associated with your account in pagination fashion.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListFacetAttributesRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema where the facet resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet whose attributes will be retrieved.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListFacetAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"FacetAttributeList", + "documentation":"

The attributes attached to the facet.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListFacetNamesRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) to retrieve facet names from.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListFacetNamesResponse":{ + "type":"structure", + "members":{ + "FacetNames":{ + "shape":"FacetNameList", + "documentation":"

The names of facets that exist within the schema.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListIncomingTypedLinksRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

" + } + } + }, + "ListIncomingTypedLinksResponse":{ + "type":"structure", + "members":{ + "LinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns one or more typed link specifiers as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that the index exists in.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "RangesOnIndexedValues":{ + "shape":"ObjectAttributeRangeList", + "documentation":"

Specifies the ranges of indexed values that you want to query.

" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

The reference to the index to list.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see AWS Directory Service Limits.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListIndexResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The objects and indexed values attached to the index.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + }, + "FacetFilter":{ + "shape":"SchemaFacet", + "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" + } + } + }, + "ListObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectChildrenRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object for which child objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListObjectChildrenResponse":{ + "type":"structure", + "members":{ + "Children":{ + "shape":"LinkNameToObjectIdentifierMap", + "documentation":"

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectParentPathsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to which the parent path applies.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose parent paths are listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + } + }, + "ListObjectParentPathsResponse":{ + "type":"structure", + "members":{ + "PathToObjectIdentifiersList":{ + "shape":"PathToObjectIdentifiersList", + "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectParentsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object for which parent objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListObjectParentsResponse":{ + "type":"structure", + "members":{ + "Parents":{ + "shape":"ObjectIdentifierToLinkNameMap", + "documentation":"

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectPoliciesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object for which policies will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListObjectPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicyIds":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListOutgoingTypedLinksRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

" + } + } + }, + "ListOutgoingTypedLinksResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns a typed link specifier as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListPolicyAttachmentsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the policy object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListPolicyAttachmentsResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListPublishedSchemaArnsRequest":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListPublishedSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of published schemas.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token. This is for future use. Currently pagination is not supported for tagging.

" + }, + "MaxResults":{ + "shape":"TagsNumberResults", + "documentation":"

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tag key value pairs that are associated with the response.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTypedLinkFacetAttributesRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListTypedLinkFacetAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TypedLinkAttributeDefinitionList", + "documentation":"

An ordered set of attributes associate with the typed link.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListTypedLinkFacetNamesRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListTypedLinkFacetNamesResponse":{ + "type":"structure", + "members":{ + "FacetNames":{ + "shape":"TypedLinkNameList", + "documentation":"

The names of typed link facets that exist within the schema.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "LookupPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policies will be looked up.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + } + }, + "LookupPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyToPathList":{ + "shape":"PolicyToPathList", + "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "NextToken":{"type":"string"}, + "NotIndexException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation can only operate on index objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotNodeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotPolicyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation can only operate on policy objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NumberAttributeValue":{"type":"string"}, + "NumberResults":{ + "type":"integer", + "min":1 + }, + "ObjectAlreadyDetachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the object is not attached to the index.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ObjectAttributeAction":{ + "type":"structure", + "members":{ + "ObjectAttributeActionType":{ + "shape":"UpdateActionType", + "documentation":"

A type that can be either Update or Delete.

" + }, + "ObjectAttributeUpdateValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value that you want to update to.

" + } + }, + "documentation":"

The action to take on the object attribute.

" + }, + "ObjectAttributeRange":{ + "type":"structure", + "members":{ + "AttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute that the attribute range covers.

" + }, + "Range":{ + "shape":"TypedAttributeValueRange", + "documentation":"

The range of attribute values being selected.

" + } + }, + "documentation":"

A range of attributes.

" + }, + "ObjectAttributeRangeList":{ + "type":"list", + "member":{"shape":"ObjectAttributeRange"} + }, + "ObjectAttributeUpdate":{ + "type":"structure", + "members":{ + "ObjectAttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute being updated.

" + }, + "ObjectAttributeAction":{ + "shape":"ObjectAttributeAction", + "documentation":"

The action to perform as part of the attribute update.

" + } + }, + "documentation":"

Structure that contains attribute update information.

" + }, + "ObjectAttributeUpdateList":{ + "type":"list", + "member":{"shape":"ObjectAttributeUpdate"} + }, + "ObjectIdentifier":{"type":"string"}, + "ObjectIdentifierList":{ + "type":"list", + "member":{"shape":"ObjectIdentifier"} + }, + "ObjectIdentifierToLinkNameMap":{ + "type":"map", + "key":{"shape":"ObjectIdentifier"}, + "value":{"shape":"LinkName"} + }, + "ObjectNotDetachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ObjectReference":{ + "type":"structure", + "members":{ + "Selector":{ + "shape":"SelectorObjectReference", + "documentation":"

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Accessing Objects. You can identify an object in one of the following ways:

  • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

" + } + }, + "documentation":"

The reference that identifies an object.

" + }, + "ObjectType":{ + "type":"string", + "enum":[ + "NODE", + "LEAF_NODE", + "POLICY", + "INDEX" + ] + }, + "PathString":{"type":"string"}, + "PathToObjectIdentifiers":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"PathString", + "documentation":"

The path that is used to identify the object starting from directory root.

" + }, + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

Lists ObjectIdentifiers starting from directory root to the object in the request.

" + } + }, + "documentation":"

Returns the path to the ObjectIdentifiers that is associated with the directory.

" + }, + "PathToObjectIdentifiersList":{ + "type":"list", + "member":{"shape":"PathToObjectIdentifiers"} + }, + "PolicyAttachment":{ + "type":"structure", + "members":{ + "PolicyId":{ + "shape":"ObjectIdentifier", + "documentation":"

The ID of PolicyAttachment.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier that is associated with PolicyAttachment.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The type of policy that can be associated with PolicyAttachment.

" + } + }, + "documentation":"

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached. For more information, see Policies.

" + }, + "PolicyAttachmentList":{ + "type":"list", + "member":{"shape":"PolicyAttachment"} + }, + "PolicyToPath":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"PathString", + "documentation":"

The path that is referenced from the root.

" + }, + "Policies":{ + "shape":"PolicyAttachmentList", + "documentation":"

List of policy objects.

" + } + }, + "documentation":"

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

" + }, + "PolicyToPathList":{ + "type":"list", + "member":{"shape":"PolicyToPath"} + }, + "PolicyType":{"type":"string"}, + "PublishSchemaRequest":{ + "type":"structure", + "required":[ + "DevelopmentSchemaArn", + "Version" + ], + "members":{ + "DevelopmentSchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Version":{ + "shape":"Version", + "documentation":"

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

" + }, + "MinorVersion":{ + "shape":"Version", + "documentation":"

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

" + }, + "Name":{ + "shape":"SchemaName", + "documentation":"

The new name under which the schema will be published. If this is not provided, the development schema is considered.

" + } + } + }, + "PublishSchemaResponse":{ + "type":"structure", + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the published schema. For more information, see arns.

" + } + } + }, + "PutSchemaFromJsonRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Document" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to update.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Document":{ + "shape":"SchemaJsonDocument", + "documentation":"

The replacement JSON schema.

" + } + } + }, + "PutSchemaFromJsonResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to update.

" + } + } + }, + "RangeMode":{ + "type":"string", + "enum":[ + "FIRST", + "LAST", + "LAST_BEFORE_MISSING_VALUES", + "INCLUSIVE", + "EXCLUSIVE" + ] + }, + "RemoveFacetFromObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory in which the object resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

The facet to remove. See SchemaFacet for details.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object to remove the facet from.

" + } + } + }, + "RemoveFacetFromObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "RequiredAttributeBehavior":{ + "type":"string", + "enum":[ + "REQUIRED_ALWAYS", + "NOT_REQUIRED" + ] + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified resource could not be found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RetryableConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "Rule":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"RuleType", + "documentation":"

The type of attribute validation rule.

" + }, + "Parameters":{ + "shape":"RuleParameterMap", + "documentation":"

The minimum and maximum parameters that are associated with the rule.

" + } + }, + "documentation":"

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

" + }, + "RuleKey":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "RuleMap":{ + "type":"map", + "key":{"shape":"RuleKey"}, + "value":{"shape":"Rule"} + }, + "RuleParameterKey":{"type":"string"}, + "RuleParameterMap":{ + "type":"map", + "key":{"shape":"RuleParameterKey"}, + "value":{"shape":"RuleParameterValue"} + }, + "RuleParameterValue":{"type":"string"}, + "RuleType":{ + "type":"string", + "enum":[ + "BINARY_LENGTH", + "NUMBER_COMPARISON", + "STRING_FROM_SET", + "STRING_LENGTH" + ] + }, + "SchemaAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SchemaAlreadyPublishedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a schema is already published.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SchemaFacet":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.

" + }, + "FacetName":{ + "shape":"FacetName", + "documentation":"

The name of the facet.

" + } + }, + "documentation":"

A facet.

" + }, + "SchemaFacetList":{ + "type":"list", + "member":{"shape":"SchemaFacet"} + }, + "SchemaJsonDocument":{"type":"string"}, + "SchemaName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "SelectorObjectReference":{"type":"string"}, + "StillContainsLinksException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The object could not be deleted because links still exist. Remove the links and then try the operation again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "StringAttributeValue":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key that is associated with the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value that is associated with the tag.

" + } + }, + "documentation":"

The tag structure that contains a tag key and value.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tag key-value pairs.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "TagsNumberResults":{ + "type":"integer", + "min":50 + }, + "TypedAttributeValue":{ + "type":"structure", + "members":{ + "StringValue":{ + "shape":"StringAttributeValue", + "documentation":"

A string data value.

" + }, + "BinaryValue":{ + "shape":"BinaryAttributeValue", + "documentation":"

A binary data value.

" + }, + "BooleanValue":{ + "shape":"BooleanAttributeValue", + "documentation":"

A Boolean data value.

" + }, + "NumberValue":{ + "shape":"NumberAttributeValue", + "documentation":"

A number data value.

" + }, + "DatetimeValue":{ + "shape":"DatetimeAttributeValue", + "documentation":"

A date and time value.

" + } + }, + "documentation":"

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

" + }, + "TypedAttributeValueRange":{ + "type":"structure", + "required":[ + "StartMode", + "EndMode" + ], + "members":{ + "StartMode":{ + "shape":"RangeMode", + "documentation":"

The inclusive or exclusive range start.

" + }, + "StartValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value to start the range at.

" + }, + "EndMode":{ + "shape":"RangeMode", + "documentation":"

The inclusive or exclusive range end.

" + }, + "EndValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The attribute value to terminate the range at.

" + } + }, + "documentation":"

A range of attribute values. For more information, see Range Filters.

" + }, + "TypedLinkAttributeDefinition":{ + "type":"structure", + "required":[ + "Name", + "Type", + "RequiredBehavior" + ], + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

The unique name of the typed link attribute.

" + }, + "Type":{ + "shape":"FacetAttributeType", + "documentation":"

The type of the attribute.

" + }, + "DefaultValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The default value of the attribute (if configured).

" + }, + "IsImmutable":{ + "shape":"Bool", + "documentation":"

Whether the attribute is mutable or not.

" + }, + "Rules":{ + "shape":"RuleMap", + "documentation":"

Validation rules that are attached to the attribute definition.

" + }, + "RequiredBehavior":{ + "shape":"RequiredAttributeBehavior", + "documentation":"

The required behavior of the TypedLinkAttributeDefinition.

" + } + }, + "documentation":"

A typed link attribute definition.

" + }, + "TypedLinkAttributeDefinitionList":{ + "type":"list", + "member":{"shape":"TypedLinkAttributeDefinition"} + }, + "TypedLinkAttributeRange":{ + "type":"structure", + "required":["Range"], + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The unique name of the typed link attribute.

" + }, + "Range":{ + "shape":"TypedAttributeValueRange", + "documentation":"

The range of attribute values that are being selected.

" + } + }, + "documentation":"

Identifies the range of attributes that are used by a specified filter.

" + }, + "TypedLinkAttributeRangeList":{ + "type":"list", + "member":{"shape":"TypedLinkAttributeRange"} + }, + "TypedLinkFacet":{ + "type":"structure", + "required":[ + "Name", + "Attributes", + "IdentityAttributeOrder" + ], + "members":{ + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "Attributes":{ + "shape":"TypedLinkAttributeDefinitionList", + "documentation":"

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

" + }, + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

" + } + }, + "documentation":"

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

" + }, + "TypedLinkFacetAttributeUpdate":{ + "type":"structure", + "required":[ + "Attribute", + "Action" + ], + "members":{ + "Attribute":{ + "shape":"TypedLinkAttributeDefinition", + "documentation":"

The attribute to update.

" + }, + "Action":{ + "shape":"UpdateActionType", + "documentation":"

The action to perform when updating the attribute.

" + } + }, + "documentation":"

A typed link facet attribute update.

" + }, + "TypedLinkFacetAttributeUpdateList":{ + "type":"list", + "member":{"shape":"TypedLinkFacetAttributeUpdate"} + }, + "TypedLinkName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "TypedLinkNameList":{ + "type":"list", + "member":{"shape":"TypedLinkName"} + }, + "TypedLinkSchemaAndFacetName":{ + "type":"structure", + "required":[ + "SchemaArn", + "TypedLinkName" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" + }, + "TypedLinkName":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + }, + "documentation":"

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

" + }, + "TypedLinkSpecifier":{ + "type":"structure", + "required":[ + "TypedLinkFacet", + "SourceObjectReference", + "TargetObjectReference", + "IdentityAttributeValues" + ], + "members":{ + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "IdentityAttributeValues":{ + "shape":"AttributeNameAndValueList", + "documentation":"

Identifies the attribute value to update.

" + } + }, + "documentation":"

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

" + }, + "TypedLinkSpecifierList":{ + "type":"list", + "member":{"shape":"TypedLinkSpecifier"} + }, + "UnsupportedIndexTypeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested index type is not supported.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

Keys of the tag that need to be removed from the resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateActionType":{ + "type":"string", + "enum":[ + "CREATE_OR_UPDATE", + "DELETE" + ] + }, + "UpdateFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet.

" + }, + "AttributeUpdates":{ + "shape":"FacetAttributeUpdateList", + "documentation":"

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" + } + } + }, + "UpdateFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLinkAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeUpdates":{ + "shape":"LinkAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + } + }, + "UpdateLinkAttributesResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference", + "AttributeUpdates" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object.

" + }, + "AttributeUpdates":{ + "shape":"ObjectAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + } + }, + "UpdateObjectAttributesResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the updated object.

" + } + } + }, + "UpdateSchemaRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"SchemaName", + "documentation":"

The name of the schema.

" + } + } + }, + "UpdateSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the updated schema. For more information, see arns.

" + } + } + }, + "UpdateTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name", + "AttributeUpdates", + "IdentityAttributeOrder" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "AttributeUpdates":{ + "shape":"TypedLinkFacetAttributeUpdateList", + "documentation":"

Attributes update structure.

" + }, + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed link.

" + } + } + }, + "UpdateTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpgradeAppliedSchemaRequest":{ + "type":"structure", + "required":[ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The revision of the published schema to upgrade the directory to.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN for the directory to which the upgraded schema will be applied.

" + }, + "DryRun":{ + "shape":"Bool", + "documentation":"

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

" + } + } + }, + "UpgradeAppliedSchemaResponse":{ + "type":"structure", + "members":{ + "UpgradedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that is returned as part of the response.

" + } + } + }, + "UpgradePublishedSchemaRequest":{ + "type":"structure", + "required":[ + "DevelopmentSchemaArn", + "PublishedSchemaArn", + "MinorVersion" + ], + "members":{ + "DevelopmentSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the development schema with the changes used for the upgrade.

" + }, + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the published schema to be upgraded.

" + }, + "MinorVersion":{ + "shape":"Version", + "documentation":"

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

" + }, + "DryRun":{ + "shape":"Bool", + "documentation":"

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

" + } + } + }, + "UpgradePublishedSchemaResponse":{ + "type":"structure", + "members":{ + "UpgradedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that your request is malformed in some manner. See the exception message.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Version":{ + "type":"string", + "max":10, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + } + }, + "documentation":"Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

" +} diff --git a/aws/dist/botocore/data/clouddirectory/2017-01-11/paginators-1.json b/aws/dist/botocore/data/clouddirectory/2017-01-11/paginators-1.json new file mode 100644 index 00000000..5a06fb0b --- /dev/null +++ b/aws/dist/botocore/data/clouddirectory/2017-01-11/paginators-1.json @@ -0,0 +1,118 @@ +{ + "pagination": { + "ListObjectParentPaths": { + "result_key": "PathToObjectIdentifiersList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetNames": { + "result_key": "FacetNames", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPublishedSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDirectories": { + "result_key": "Directories", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDevelopmentSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetNames": { + "result_key": "FacetNames", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIndex": { + "result_key": "IndexAttachments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFacetAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectPolicies": { + "result_key": "AttachedPolicyIds", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "result_key": "Tags", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAttachedIndices": { + "result_key": "IndexAttachments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "LookupPolicy": { + "result_key": "PolicyToPathList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListPolicyAttachments": { + "result_key": "ObjectIdentifiers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListObjectAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAppliedSchemaArns": { + "result_key": "SchemaArns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTypedLinkFacetAttributes": { + "result_key": "Attributes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIncomingTypedLinks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LinkSpecifiers" + }, + "ListManagedSchemaArns": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SchemaArns" + }, + "ListOutgoingTypedLinks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TypedLinkSpecifiers" + } + } +} diff --git a/aws/dist/botocore/data/clouddirectory/2017-01-11/service-2.json b/aws/dist/botocore/data/clouddirectory/2017-01-11/service-2.json new file mode 100644 index 00000000..086af778 --- /dev/null +++ b/aws/dist/botocore/data/clouddirectory/2017-01-11/service-2.json @@ -0,0 +1,6035 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-01-11", + "endpointPrefix":"clouddirectory", + "protocol":"rest-json", + "serviceFullName":"Amazon CloudDirectory", + "serviceId":"CloudDirectory", + "signatureVersion":"v4", + "signingName":"clouddirectory", + "uid":"clouddirectory-2017-01-11" + }, + "operations":{ + "AddFacetToObject":{ + "name":"AddFacetToObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/facets", + "responseCode":200 + }, + "input":{"shape":"AddFacetToObjectRequest"}, + "output":{"shape":"AddFacetToObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Adds a new Facet to an object. An object can have more than one facet applied on it.

" + }, + "ApplySchema":{ + "name":"ApplySchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/apply", + "responseCode":200 + }, + "input":{"shape":"ApplySchemaRequest"}, + "output":{"shape":"ApplySchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"SchemaAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"} + ], + "documentation":"

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

" + }, + "AttachObject":{ + "name":"AttachObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attach", + "responseCode":200 + }, + "input":{"shape":"AttachObjectRequest"}, + "output":{"shape":"AttachObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ValidationException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Attaches an existing object to another object. An object can be accessed in two ways:

  1. Using the path

  2. Using ObjectIdentifier

" + }, + "AttachPolicy":{ + "name":"AttachPolicy", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/attach", + "responseCode":200 + }, + "input":{"shape":"AttachPolicyRequest"}, + "output":{"shape":"AttachPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "AttachToIndex":{ + "name":"AttachToIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index/attach", + "responseCode":200 + }, + "input":{"shape":"AttachToIndexRequest"}, + "output":{"shape":"AttachToIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"IndexedAttributeMissingException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Attaches the specified object to the specified index.

" + }, + "AttachTypedLink":{ + "name":"AttachTypedLink", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attach", + "responseCode":200 + }, + "input":{"shape":"AttachTypedLinkRequest"}, + "output":{"shape":"AttachTypedLinkResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"ValidationException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" + }, + "BatchRead":{ + "name":"BatchRead", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/batchread", + "responseCode":200 + }, + "input":{"shape":"BatchReadRequest"}, + "output":{"shape":"BatchReadResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"} + ], + "documentation":"

Performs all the read operations in a batch.

" + }, + "BatchWrite":{ + "name":"BatchWrite", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/batchwrite", + "responseCode":200 + }, + "input":{"shape":"BatchWriteRequest"}, + "output":{"shape":"BatchWriteResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"BatchWriteException"} + ], + "documentation":"

Performs all the write operations in a batch. Either all the operations succeed or none.

" + }, + "CreateDirectory":{ + "name":"CreateDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/create", + "responseCode":200 + }, + "input":{"shape":"CreateDirectoryRequest"}, + "output":{"shape":"CreateDirectoryResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema in the Amazon Cloud Directory Developer Guide.

" + }, + "CreateFacet":{ + "name":"CreateFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/create", + "responseCode":200 + }, + "input":{"shape":"CreateFacetRequest"}, + "output":{"shape":"CreateFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetAlreadyExistsException"}, + {"shape":"InvalidRuleException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

" + }, + "CreateIndex":{ + "name":"CreateIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index", + "responseCode":200 + }, + "input":{"shape":"CreateIndexRequest"}, + "output":{"shape":"CreateIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"UnsupportedIndexTypeException"} + ], + "documentation":"

Creates an index object. See Indexing and search for more information.

" + }, + "CreateObject":{ + "name":"CreateObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object", + "responseCode":200 + }, + "input":{"shape":"CreateObjectRequest"}, + "output":{"shape":"CreateObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"UnsupportedIndexTypeException"} + ], + "documentation":"

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

" + }, + "CreateSchema":{ + "name":"CreateSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/create", + "responseCode":200 + }, + "input":{"shape":"CreateSchemaRequest"}, + "output":{"shape":"CreateSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"SchemaAlreadyExistsException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

" + }, + "CreateTypedLinkFacet":{ + "name":"CreateTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/create", + "responseCode":200 + }, + "input":{"shape":"CreateTypedLinkFacetRequest"}, + "output":{"shape":"CreateTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetAlreadyExistsException"}, + {"shape":"InvalidRuleException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Creates a TypedLinkFacet. For more information, see Typed Links.

" + }, + "DeleteDirectory":{ + "name":"DeleteDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory", + "responseCode":200 + }, + "input":{"shape":"DeleteDirectoryRequest"}, + "output":{"shape":"DeleteDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryNotDisabledException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

" + }, + "DeleteFacet":{ + "name":"DeleteFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteFacetRequest"}, + "output":{"shape":"DeleteFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"FacetInUseException"} + ], + "documentation":"

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

" + }, + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ObjectNotDetachedException"} + ], + "documentation":"

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits.

" + }, + "DeleteSchema":{ + "name":"DeleteSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema", + "responseCode":200 + }, + "input":{"shape":"DeleteSchemaRequest"}, + "output":{"shape":"DeleteSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"StillContainsLinksException"} + ], + "documentation":"

Deletes a given schema. Schemas in a development and published state can only be deleted.

" + }, + "DeleteTypedLinkFacet":{ + "name":"DeleteTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteTypedLinkFacetRequest"}, + "output":{"shape":"DeleteTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Deletes a TypedLinkFacet. For more information, see Typed Links.

" + }, + "DetachFromIndex":{ + "name":"DetachFromIndex", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/index/detach", + "responseCode":200 + }, + "input":{"shape":"DetachFromIndexRequest"}, + "output":{"shape":"DetachFromIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ObjectAlreadyDetachedException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Detaches the specified object from the specified index.

" + }, + "DetachObject":{ + "name":"DetachObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/detach", + "responseCode":200 + }, + "input":{"shape":"DetachObjectRequest"}, + "output":{"shape":"DetachObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotNodeException"} + ], + "documentation":"

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

" + }, + "DetachPolicy":{ + "name":"DetachPolicy", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/detach", + "responseCode":200 + }, + "input":{"shape":"DetachPolicyRequest"}, + "output":{"shape":"DetachPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Detaches a policy from an object.

" + }, + "DetachTypedLink":{ + "name":"DetachTypedLink", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/detach", + "responseCode":200 + }, + "input":{"shape":"DetachTypedLinkRequest"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" + }, + "DisableDirectory":{ + "name":"DisableDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/disable", + "responseCode":200 + }, + "input":{"shape":"DisableDirectoryRequest"}, + "output":{"shape":"DisableDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

" + }, + "EnableDirectory":{ + "name":"EnableDirectory", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/enable", + "responseCode":200 + }, + "input":{"shape":"EnableDirectoryRequest"}, + "output":{"shape":"EnableDirectoryResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DirectoryDeletedException"}, + {"shape":"InternalServiceException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RetryableConflictException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

" + }, + "GetAppliedSchemaVersion":{ + "name":"GetAppliedSchemaVersion", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema", + "responseCode":200 + }, + "input":{"shape":"GetAppliedSchemaVersionRequest"}, + "output":{"shape":"GetAppliedSchemaVersionResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns current applied schema version ARN, including the minor version in use.

" + }, + "GetDirectory":{ + "name":"GetDirectory", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/get", + "responseCode":200 + }, + "input":{"shape":"GetDirectoryRequest"}, + "output":{"shape":"GetDirectoryResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Retrieves metadata about a directory.

" + }, + "GetFacet":{ + "name":"GetFacet", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet", + "responseCode":200 + }, + "input":{"shape":"GetFacetRequest"}, + "output":{"shape":"GetFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

" + }, + "GetLinkAttributes":{ + "name":"GetLinkAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get", + "responseCode":200 + }, + "input":{"shape":"GetLinkAttributesRequest"}, + "output":{"shape":"GetLinkAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Retrieves attributes that are associated with a typed link.

" + }, + "GetObjectAttributes":{ + "name":"GetObjectAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get", + "responseCode":200 + }, + "input":{"shape":"GetObjectAttributesRequest"}, + "output":{"shape":"GetObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "GetObjectInformation":{ + "name":"GetObjectInformation", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/information", + "responseCode":200 + }, + "input":{"shape":"GetObjectInformationRequest"}, + "output":{"shape":"GetObjectInformationResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves metadata about an object.

" + }, + "GetSchemaAsJson":{ + "name":"GetSchemaAsJson", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", + "responseCode":200 + }, + "input":{"shape":"GetSchemaAsJsonRequest"}, + "output":{"shape":"GetSchemaAsJsonResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Retrieves a JSON representation of the schema. See JSON Schema Format for more information.

" + }, + "GetTypedLinkFacetInformation":{ + "name":"GetTypedLinkFacetInformation", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/get", + "responseCode":200 + }, + "input":{"shape":"GetTypedLinkFacetInformationRequest"}, + "output":{"shape":"GetTypedLinkFacetInformationResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetNotFoundException"} + ], + "documentation":"

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

" + }, + "ListAppliedSchemaArns":{ + "name":"ListAppliedSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/applied", + "responseCode":200 + }, + "input":{"shape":"ListAppliedSchemaArnsRequest"}, + "output":{"shape":"ListAppliedSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

" + }, + "ListAttachedIndices":{ + "name":"ListAttachedIndices", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/indices", + "responseCode":200 + }, + "input":{"shape":"ListAttachedIndicesRequest"}, + "output":{"shape":"ListAttachedIndicesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists indices attached to the specified object.

" + }, + "ListDevelopmentSchemaArns":{ + "name":"ListDevelopmentSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/development", + "responseCode":200 + }, + "input":{"shape":"ListDevelopmentSchemaArnsRequest"}, + "output":{"shape":"ListDevelopmentSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

" + }, + "ListDirectories":{ + "name":"ListDirectories", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/directory/list", + "responseCode":200 + }, + "input":{"shape":"ListDirectoriesRequest"}, + "output":{"shape":"ListDirectoriesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists directories created within an account.

" + }, + "ListFacetAttributes":{ + "name":"ListFacetAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/attributes", + "responseCode":200 + }, + "input":{"shape":"ListFacetAttributesRequest"}, + "output":{"shape":"ListFacetAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves attributes attached to the facet.

" + }, + "ListFacetNames":{ + "name":"ListFacetNames", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/facet/list", + "responseCode":200 + }, + "input":{"shape":"ListFacetNamesRequest"}, + "output":{"shape":"ListFacetNamesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves the names of facets that exist in a schema.

" + }, + "ListIncomingTypedLinks":{ + "name":"ListIncomingTypedLinks", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/incoming", + "responseCode":200 + }, + "input":{"shape":"ListIncomingTypedLinksRequest"}, + "output":{"shape":"ListIncomingTypedLinksResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "ListIndex":{ + "name":"ListIndex", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/index/targets", + "responseCode":200 + }, + "input":{"shape":"ListIndexRequest"}, + "output":{"shape":"ListIndexResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"FacetValidationException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotIndexException"} + ], + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListManagedSchemaArns":{ + "name":"ListManagedSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/managed", + "responseCode":200 + }, + "input":{"shape":"ListManagedSchemaArnsRequest"}, + "output":{"shape":"ListManagedSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

" + }, + "ListObjectAttributes":{ + "name":"ListObjectAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/attributes", + "responseCode":200 + }, + "input":{"shape":"ListObjectAttributesRequest"}, + "output":{"shape":"ListObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "name":"ListObjectChildren", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/children", + "responseCode":200 + }, + "input":{"shape":"ListObjectChildrenRequest"}, + "output":{"shape":"ListObjectChildrenResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NotNodeException"} + ], + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "ListObjectParentPaths":{ + "name":"ListObjectParentPaths", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/parentpaths", + "responseCode":200 + }, + "input":{"shape":"ListObjectParentPathsRequest"}, + "output":{"shape":"ListObjectParentPathsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

" + }, + "ListObjectParents":{ + "name":"ListObjectParents", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/parent", + "responseCode":200 + }, + "input":{"shape":"ListObjectParentsRequest"}, + "output":{"shape":"ListObjectParentsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"CannotListParentOfRootException"} + ], + "documentation":"

Lists parent objects that are associated with a given object in pagination fashion.

" + }, + "ListObjectPolicies":{ + "name":"ListObjectPolicies", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/object/policy", + "responseCode":200 + }, + "input":{"shape":"ListObjectPoliciesRequest"}, + "output":{"shape":"ListObjectPoliciesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListOutgoingTypedLinks":{ + "name":"ListOutgoingTypedLinks", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/outgoing", + "responseCode":200 + }, + "input":{"shape":"ListOutgoingTypedLinksRequest"}, + "output":{"shape":"ListOutgoingTypedLinksResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "ListPolicyAttachments":{ + "name":"ListPolicyAttachments", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/attachment", + "responseCode":200 + }, + "input":{"shape":"ListPolicyAttachmentsRequest"}, + "output":{"shape":"ListPolicyAttachmentsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotPolicyException"} + ], + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "ListPublishedSchemaArns":{ + "name":"ListPublishedSchemaArns", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/published", + "responseCode":200 + }, + "input":{"shape":"ListPublishedSchemaArnsRequest"}, + "output":{"shape":"ListPublishedSchemaArnsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/tags", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

" + }, + "ListTypedLinkFacetAttributes":{ + "name":"ListTypedLinkFacetAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/attributes", + "responseCode":200 + }, + "input":{"shape":"ListTypedLinkFacetAttributesRequest"}, + "output":{"shape":"ListTypedLinkFacetAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.

" + }, + "ListTypedLinkFacetNames":{ + "name":"ListTypedLinkFacetNames", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/list", + "responseCode":200 + }, + "input":{"shape":"ListTypedLinkFacetNamesRequest"}, + "output":{"shape":"ListTypedLinkFacetNamesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links.

" + }, + "LookupPolicy":{ + "name":"LookupPolicy", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/policy/lookup", + "responseCode":200 + }, + "input":{"shape":"LookupPolicyRequest"}, + "output":{"shape":"LookupPolicyResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "PublishSchema":{ + "name":"PublishSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/publish", + "responseCode":200 + }, + "input":{"shape":"PublishSchemaRequest"}, + "output":{"shape":"PublishSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"SchemaAlreadyPublishedException"} + ], + "documentation":"

Publishes a development schema with a major version and a recommended minor version.

" + }, + "PutSchemaFromJson":{ + "name":"PutSchemaFromJson", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/json", + "responseCode":200 + }, + "input":{"shape":"PutSchemaFromJsonRequest"}, + "output":{"shape":"PutSchemaFromJsonResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidSchemaDocException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.

" + }, + "RemoveFacetFromObject":{ + "name":"RemoveFacetFromObject", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/facets/delete", + "responseCode":200 + }, + "input":{"shape":"RemoveFacetFromObjectRequest"}, + "output":{"shape":"RemoveFacetFromObjectResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Removes the specified facet from the specified object.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/tags/add", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

An API operation for adding tags to a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/tags/remove", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidTaggingRequestException"} + ], + "documentation":"

An API operation for removing tags from a resource.

" + }, + "UpdateFacet":{ + "name":"UpdateFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/facet", + "responseCode":200 + }, + "input":{"shape":"UpdateFacetRequest"}, + "output":{"shape":"UpdateFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidFacetUpdateException"}, + {"shape":"FacetValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Does the following:

  1. Adds new Attributes, Rules, or ObjectTypes.

  2. Updates existing Attributes, Rules, or ObjectTypes.

  3. Deletes existing Attributes, Rules, or ObjectTypes.

" + }, + "UpdateLinkAttributes":{ + "name":"UpdateLinkAttributes", + "http":{ + "method":"POST", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update", + "responseCode":200 + }, + "input":{"shape":"UpdateLinkAttributesRequest"}, + "output":{"shape":"UpdateLinkAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

" + }, + "UpdateObjectAttributes":{ + "name":"UpdateObjectAttributes", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/object/update", + "responseCode":200 + }, + "input":{"shape":"UpdateObjectAttributesRequest"}, + "output":{"shape":"UpdateObjectAttributesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"DirectoryNotEnabledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LinkNameAlreadyInUseException"}, + {"shape":"FacetValidationException"} + ], + "documentation":"

Updates a given object's attributes.

" + }, + "UpdateSchema":{ + "name":"UpdateSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/update", + "responseCode":200 + }, + "input":{"shape":"UpdateSchemaRequest"}, + "output":{"shape":"UpdateSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the schema name with a new name. Only development schema names can be updated.

" + }, + "UpdateTypedLinkFacet":{ + "name":"UpdateTypedLinkFacet", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet", + "responseCode":200 + }, + "input":{"shape":"UpdateTypedLinkFacetRequest"}, + "output":{"shape":"UpdateTypedLinkFacetResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"FacetValidationException"}, + {"shape":"InvalidFacetUpdateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"FacetNotFoundException"}, + {"shape":"InvalidRuleException"} + ], + "documentation":"

Updates a TypedLinkFacet. For more information, see Typed Links.

" + }, + "UpgradeAppliedSchema":{ + "name":"UpgradeAppliedSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied", + "responseCode":200 + }, + "input":{"shape":"UpgradeAppliedSchemaRequest"}, + "output":{"shape":"UpgradeAppliedSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"IncompatibleSchemaException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"SchemaAlreadyExistsException"} + ], + "documentation":"

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

" + }, + "UpgradePublishedSchema":{ + "name":"UpgradePublishedSchema", + "http":{ + "method":"PUT", + "requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished", + "responseCode":200 + }, + "input":{"shape":"UpgradePublishedSchemaRequest"}, + "output":{"shape":"UpgradePublishedSchemaResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidArnException"}, + {"shape":"RetryableConflictException"}, + {"shape":"ValidationException"}, + {"shape":"IncompatibleSchemaException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAttachmentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Access denied. Check your permissions.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AddFacetToObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifiers for the facet that you are adding to the object. See SchemaFacet for details.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

Attributes on the facet that you are adding to the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object you are adding the specified facet to.

" + } + } + }, + "AddFacetToObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "ApplySchemaRequest":{ + "type":"structure", + "required":[ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory into which the schema is copied. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "ApplySchemaResponse":{ + "type":"structure", + "members":{ + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" + } + } + }, + "Arn":{"type":"string"}, + "Arns":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "AttachObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ParentReference", + "ChildReference", + "LinkName" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent object reference.

" + }, + "ChildReference":{ + "shape":"ObjectReference", + "documentation":"

The child object reference to be attached to the object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The link name with which the child object is attached to the parent.

" + } + } + }, + "AttachObjectResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The attached ObjectIdentifier, which is the child ObjectIdentifier.

" + } + } + }, + "AttachPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that is associated with the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object to which the policy will be attached.

" + } + } + }, + "AttachPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "AttachToIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where the object and index exist.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index that you are attaching the object to.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that you are attaching to the index.

" + } + } + }, + "AttachToIndexResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" + } + } + }, + "AttachTypedLinkRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "Attributes":{ + "shape":"AttributeNameAndValueList", + "documentation":"

A set of attributes that are associated with the typed link.

" + } + } + }, + "AttachTypedLinkResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Returns a typed link specifier as output.

" + } + } + }, + "AttributeKey":{ + "type":"structure", + "required":[ + "SchemaArn", + "FacetName", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.

" + }, + "FacetName":{ + "shape":"FacetName", + "documentation":"

The name of the facet that the attribute exists within.

" + }, + "Name":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + } + }, + "documentation":"

A unique identifier for an attribute.

" + }, + "AttributeKeyAndValue":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute.

" + }, + "Value":{ + "shape":"TypedAttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

The combination of an attribute key and an attribute value.

" + }, + "AttributeKeyAndValueList":{ + "type":"list", + "member":{"shape":"AttributeKeyAndValue"} + }, + "AttributeKeyList":{ + "type":"list", + "member":{"shape":"AttributeKey"} + }, + "AttributeName":{ + "type":"string", + "max":230, + "min":1, + "pattern":"^[a-zA-Z0-9._:-]*$" + }, + "AttributeNameAndValue":{ + "type":"structure", + "required":[ + "AttributeName", + "Value" + ], + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The attribute name of the typed link.

" + }, + "Value":{ + "shape":"TypedAttributeValue", + "documentation":"

The value for the typed link.

" + } + }, + "documentation":"

Identifies the attribute name and value for a typed link.

" + }, + "AttributeNameAndValueList":{ + "type":"list", + "member":{"shape":"AttributeNameAndValue"} + }, + "AttributeNameList":{ + "type":"list", + "member":{"shape":"AttributeName"} + }, + "BatchAddFacetToObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectAttributeList", + "ObjectReference" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Represents the facet being added to the object.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes to set on the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being mutated.

" + } + }, + "documentation":"

Represents the output of a batch add facet to object operation.

" + }, + "BatchAddFacetToObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a batch add facet to object operation.

" + }, + "BatchAttachObject":{ + "type":"structure", + "required":[ + "ParentReference", + "ChildReference", + "LinkName" + ], + "members":{ + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent object reference.

" + }, + "ChildReference":{ + "shape":"ObjectReference", + "documentation":"

The child object reference that is to be attached to the object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + } + }, + "documentation":"

Represents the output of an AttachObject operation.

" + }, + "BatchAttachObjectResponse":{ + "type":"structure", + "members":{ + "attachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that has been attached.

" + } + }, + "documentation":"

Represents the output batch AttachObject response operation.

" + }, + "BatchAttachPolicy":{ + "type":"structure", + "required":[ + "PolicyReference", + "ObjectReference" + ], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that is associated with the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object to which the policy will be attached.

" + } + }, + "documentation":"

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.

" + }, + "BatchAttachPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of an AttachPolicy response operation.

" + }, + "BatchAttachToIndex":{ + "type":"structure", + "required":[ + "IndexReference", + "TargetReference" + ], + "members":{ + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index that you are attaching the object to.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that you are attaching to the index.

" + } + }, + "documentation":"

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.

" + }, + "BatchAttachToIndexResponse":{ + "type":"structure", + "members":{ + "AttachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was attached to the index.

" + } + }, + "documentation":"

Represents the output of a AttachToIndex response operation.

" + }, + "BatchAttachTypedLink":{ + "type":"structure", + "required":[ + "SourceObjectReference", + "TargetObjectReference", + "TypedLinkFacet", + "Attributes" + ], + "members":{ + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "Attributes":{ + "shape":"AttributeNameAndValueList", + "documentation":"

A set of attributes that are associated with the typed link.

" + } + }, + "documentation":"

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.

" + }, + "BatchAttachTypedLinkResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Returns a typed link specifier as output.

" + } + }, + "documentation":"

Represents the output of a AttachTypedLink response operation.

" + }, + "BatchCreateIndex":{ + "type":"structure", + "required":[ + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members":{ + "OrderedIndexedAttributeList":{ + "shape":"AttributeKeyList", + "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" + }, + "IsUnique":{ + "shape":"Bool", + "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the parent object that contains the index object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link between the parent object and the index object.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Transaction Support for more information.

" + } + }, + "documentation":"

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.

" + }, + "BatchCreateIndexResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the index created by this operation.

" + } + }, + "documentation":"

Represents the output of a CreateIndex response operation.

" + }, + "BatchCreateObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectAttributeList" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacetList", + "documentation":"

A list of FacetArns that will be associated with the object. For more information, see arns.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

An attribute map, which contains an attribute ARN as the key and attribute value as the map value.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

If specified, the parent reference to which this object will be attached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Transaction Support for more information.

" + } + }, + "documentation":"

Represents the output of a CreateObject operation.

" + }, + "BatchCreateObjectResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ID that is associated with the object.

" + } + }, + "documentation":"

Represents the output of a CreateObject response operation.

" + }, + "BatchDeleteObject":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object.

" + } + }, + "documentation":"

Represents the output of a DeleteObject operation.

" + }, + "BatchDeleteObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DeleteObject response operation.

" + }, + "BatchDetachFromIndex":{ + "type":"structure", + "required":[ + "IndexReference", + "TargetReference" + ], + "members":{ + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index object.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being detached from the index.

" + } + }, + "documentation":"

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.

" + }, + "BatchDetachFromIndexResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" + } + }, + "documentation":"

Represents the output of a DetachFromIndex response operation.

" + }, + "BatchDetachObject":{ + "type":"structure", + "required":[ + "ParentReference", + "LinkName" + ], + "members":{ + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

Parent reference from which the object with the specified link name is detached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link.

" + }, + "BatchReferenceName":{ + "shape":"BatchReferenceName", + "documentation":"

The batch reference name. See Transaction Support for more information.

" + } + }, + "documentation":"

Represents the output of a DetachObject operation.

" + }, + "BatchDetachObjectResponse":{ + "type":"structure", + "members":{ + "detachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the detached object.

" + } + }, + "documentation":"

Represents the output of a DetachObject response operation.

" + }, + "BatchDetachPolicy":{ + "type":"structure", + "required":[ + "PolicyReference", + "ObjectReference" + ], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policy object will be detached.

" + } + }, + "documentation":"

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.

" + }, + "BatchDetachPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DetachPolicy response operation.

" + }, + "BatchDetachTypedLink":{ + "type":"structure", + "required":["TypedLinkSpecifier"], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Used to accept a typed link specifier as input.

" + } + }, + "documentation":"

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.

" + }, + "BatchDetachTypedLinkResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a DetachTypedLink response operation.

" + }, + "BatchGetLinkAttributes":{ + "type":"structure", + "required":[ + "TypedLinkSpecifier", + "AttributeNames" + ], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attribute names whose values will be retrieved.

" + } + }, + "documentation":"

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations.

" + }, + "BatchGetLinkAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the typed link.

" + } + }, + "documentation":"

Represents the output of a GetLinkAttributes response operation.

" + }, + "BatchGetObjectAttributes":{ + "type":"structure", + "required":[ + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

List of attribute names whose values will be retrieved.

" + } + }, + "documentation":"

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations.

" + }, + "BatchGetObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attribute values that are associated with an object.

" + } + }, + "documentation":"

Represents the output of a GetObjectAttributes response operation.

" + }, + "BatchGetObjectInformation":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object.

" + } + }, + "documentation":"

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.

" + }, + "BatchGetObjectInformationResponse":{ + "type":"structure", + "members":{ + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

The facets attached to the specified object.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the specified object.

" + } + }, + "documentation":"

Represents the output of a GetObjectInformation response operation.

" + }, + "BatchListAttachedIndices":{ + "type":"structure", + "required":["TargetReference"], + "members":{ + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that has indices attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.

" + }, + "BatchListAttachedIndicesResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The indices attached to the specified object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListAttachedIndices response operation.

" + }, + "BatchListIncomingTypedLinks":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.

" + }, + "BatchListIncomingTypedLinksResponse":{ + "type":"structure", + "members":{ + "LinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns one or more typed link specifiers as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListIncomingTypedLinks response operation.

" + }, + "BatchListIndex":{ + "type":"structure", + "required":["IndexReference"], + "members":{ + "RangesOnIndexedValues":{ + "shape":"ObjectAttributeRangeList", + "documentation":"

Specifies the ranges of indexed values that you want to query.

" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

The reference to the index to list.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.

" + }, + "BatchListIndexResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The objects and indexed values attached to the index.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListIndex response operation.

" + }, + "BatchListObjectAttributes":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference of the object whose attributes need to be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "FacetFilter":{ + "shape":"SchemaFacet", + "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" + } + }, + "documentation":"

Represents the output of a ListObjectAttributes operation.

" + }, + "BatchListObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes map that is associated with the object. AttributeArn is the key; attribute value is the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectAttributes response operation.

" + }, + "BatchListObjectChildren":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference of the object for which child objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

Maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + }, + "documentation":"

Represents the output of a ListObjectChildren operation.

" + }, + "BatchListObjectChildrenResponse":{ + "type":"structure", + "members":{ + "Children":{ + "shape":"LinkNameToObjectIdentifierMap", + "documentation":"

The children structure, which is a map with the key as the LinkName and ObjectIdentifier as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectChildren response operation.

" + }, + "BatchListObjectParentPaths":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.

" + }, + "BatchListObjectParentPathsResponse":{ + "type":"structure", + "members":{ + "PathToObjectIdentifiersList":{ + "shape":"PathToObjectIdentifiersList", + "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectParentPaths response operation.

" + }, + "BatchListObjectParents":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{"shape":"ObjectReference"}, + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"NumberResults"} + } + }, + "BatchListObjectParentsResponse":{ + "type":"structure", + "members":{ + "ParentLinks":{"shape":"ObjectIdentifierAndLinkNameList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "BatchListObjectPolicies":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.

" + }, + "BatchListObjectPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicyIds":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListObjectPolicies response operation.

" + }, + "BatchListOutgoingTypedLinks":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

" + }, + "BatchListOutgoingTypedLinksResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns a typed link specifier as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListOutgoingTypedLinks response operation.

" + }, + "BatchListPolicyAttachments":{ + "type":"structure", + "required":["PolicyReference"], + "members":{ + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the policy object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.

" + }, + "BatchListPolicyAttachmentsResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a ListPolicyAttachments response operation.

" + }, + "BatchLookupPolicy":{ + "type":"structure", + "required":["ObjectReference"], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policies will be looked up.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + }, + "documentation":"

Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.

" + }, + "BatchLookupPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyToPathList":{ + "shape":"PolicyToPathList", + "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the output of a LookupPolicy response operation.

" + }, + "BatchOperationIndex":{"type":"integer"}, + "BatchReadException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"BatchReadExceptionType", + "documentation":"

A type of exception, such as InvalidArnException.

" + }, + "Message":{ + "shape":"ExceptionMessage", + "documentation":"

An exception message that is associated with the failure.

" + } + }, + "documentation":"

The batch read exception structure, which contains the exception type and message.

" + }, + "BatchReadExceptionType":{ + "type":"string", + "enum":[ + "ValidationException", + "InvalidArnException", + "ResourceNotFoundException", + "InvalidNextTokenException", + "AccessDeniedException", + "NotNodeException", + "FacetValidationException", + "CannotListParentOfRootException", + "NotIndexException", + "NotPolicyException", + "DirectoryNotEnabledException", + "LimitExceededException", + "InternalServiceException" + ] + }, + "BatchReadOperation":{ + "type":"structure", + "members":{ + "ListObjectAttributes":{ + "shape":"BatchListObjectAttributes", + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "shape":"BatchListObjectChildren", + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "ListAttachedIndices":{ + "shape":"BatchListAttachedIndices", + "documentation":"

Lists indices attached to an object.

" + }, + "ListObjectParentPaths":{ + "shape":"BatchListObjectParentPaths", + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" + }, + "GetObjectInformation":{ + "shape":"BatchGetObjectInformation", + "documentation":"

Retrieves metadata about an object.

" + }, + "GetObjectAttributes":{ + "shape":"BatchGetObjectAttributes", + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "ListObjectParents":{"shape":"BatchListObjectParents"}, + "ListObjectPolicies":{ + "shape":"BatchListObjectPolicies", + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListPolicyAttachments":{ + "shape":"BatchListPolicyAttachments", + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "LookupPolicy":{ + "shape":"BatchLookupPolicy", + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "ListIndex":{ + "shape":"BatchListIndex", + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListOutgoingTypedLinks":{ + "shape":"BatchListOutgoingTypedLinks", + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "ListIncomingTypedLinks":{ + "shape":"BatchListIncomingTypedLinks", + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "GetLinkAttributes":{ + "shape":"BatchGetLinkAttributes", + "documentation":"

Retrieves attributes that are associated with a typed link.

" + } + }, + "documentation":"

Represents the output of a BatchRead operation.

" + }, + "BatchReadOperationList":{ + "type":"list", + "member":{"shape":"BatchReadOperation"} + }, + "BatchReadOperationResponse":{ + "type":"structure", + "members":{ + "SuccessfulResponse":{ + "shape":"BatchReadSuccessfulResponse", + "documentation":"

Identifies which operation in a batch has succeeded.

" + }, + "ExceptionResponse":{ + "shape":"BatchReadException", + "documentation":"

Identifies which operation in a batch has failed.

" + } + }, + "documentation":"

Represents the output of a BatchRead response operation.

" + }, + "BatchReadOperationResponseList":{ + "type":"list", + "member":{"shape":"BatchReadOperationResponse"} + }, + "BatchReadRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Operations" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Operations":{ + "shape":"BatchReadOperationList", + "documentation":"

A list of operations that are part of the batch.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "BatchReadResponse":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchReadOperationResponseList", + "documentation":"

A list of all the responses for each batch read.

" + } + } + }, + "BatchReadSuccessfulResponse":{ + "type":"structure", + "members":{ + "ListObjectAttributes":{ + "shape":"BatchListObjectAttributesResponse", + "documentation":"

Lists all attributes that are associated with an object.

" + }, + "ListObjectChildren":{ + "shape":"BatchListObjectChildrenResponse", + "documentation":"

Returns a paginated list of child objects that are associated with a given object.

" + }, + "GetObjectInformation":{ + "shape":"BatchGetObjectInformationResponse", + "documentation":"

Retrieves metadata about an object.

" + }, + "GetObjectAttributes":{ + "shape":"BatchGetObjectAttributesResponse", + "documentation":"

Retrieves attributes within a facet that are associated with an object.

" + }, + "ListAttachedIndices":{ + "shape":"BatchListAttachedIndicesResponse", + "documentation":"

Lists indices attached to an object.

" + }, + "ListObjectParentPaths":{ + "shape":"BatchListObjectParentPathsResponse", + "documentation":"

Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.

" + }, + "ListObjectPolicies":{ + "shape":"BatchListObjectPoliciesResponse", + "documentation":"

Returns policies attached to an object in pagination fashion.

" + }, + "ListPolicyAttachments":{ + "shape":"BatchListPolicyAttachmentsResponse", + "documentation":"

Returns all of the ObjectIdentifiers to which a given policy is attached.

" + }, + "LookupPolicy":{ + "shape":"BatchLookupPolicyResponse", + "documentation":"

Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.

" + }, + "ListIndex":{ + "shape":"BatchListIndexResponse", + "documentation":"

Lists objects attached to the specified index.

" + }, + "ListOutgoingTypedLinks":{ + "shape":"BatchListOutgoingTypedLinksResponse", + "documentation":"

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "ListIncomingTypedLinks":{ + "shape":"BatchListIncomingTypedLinksResponse", + "documentation":"

Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.

" + }, + "GetLinkAttributes":{ + "shape":"BatchGetLinkAttributesResponse", + "documentation":"

The list of attributes to retrieve from the typed link.

" + }, + "ListObjectParents":{"shape":"BatchListObjectParentsResponse"} + }, + "documentation":"

Represents the output of a BatchRead success response operation.

" + }, + "BatchReferenceName":{"type":"string"}, + "BatchRemoveFacetFromObject":{ + "type":"structure", + "required":[ + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

The facet to remove from the object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object whose facet will be removed.

" + } + }, + "documentation":"

A batch operation to remove a facet from an object.

" + }, + "BatchRemoveFacetFromObjectResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An empty result that represents success.

" + }, + "BatchUpdateLinkAttributes":{ + "type":"structure", + "required":[ + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members":{ + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeUpdates":{ + "shape":"LinkAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + }, + "documentation":"

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder. For more information, see UpdateLinkAttributes and BatchReadRequest$Operations.

" + }, + "BatchUpdateLinkAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the output of a UpdateLinkAttributes response operation.

" + }, + "BatchUpdateObjectAttributes":{ + "type":"structure", + "required":[ + "ObjectReference", + "AttributeUpdates" + ], + "members":{ + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object.

" + }, + "AttributeUpdates":{ + "shape":"ObjectAttributeUpdateList", + "documentation":"

Attributes update structure.

" + } + }, + "documentation":"

Represents the output of a BatchUpdate operation.

" + }, + "BatchUpdateObjectAttributesResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

ID that is associated with the object.

" + } + }, + "documentation":"

Represents the output of a BatchUpdate response operation.

" + }, + "BatchWriteException":{ + "type":"structure", + "members":{ + "Index":{"shape":"BatchOperationIndex"}, + "Type":{"shape":"BatchWriteExceptionType"}, + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A BatchWrite exception has occurred.

", + "exception":true + }, + "BatchWriteExceptionType":{ + "type":"string", + "enum":[ + "InternalServiceException", + "ValidationException", + "InvalidArnException", + "LinkNameAlreadyInUseException", + "StillContainsLinksException", + "FacetValidationException", + "ObjectNotDetachedException", + "ResourceNotFoundException", + "AccessDeniedException", + "InvalidAttachmentException", + "NotIndexException", + "NotNodeException", + "IndexedAttributeMissingException", + "ObjectAlreadyDetachedException", + "NotPolicyException", + "DirectoryNotEnabledException", + "LimitExceededException", + "UnsupportedIndexTypeException" + ] + }, + "BatchWriteOperation":{ + "type":"structure", + "members":{ + "CreateObject":{ + "shape":"BatchCreateObject", + "documentation":"

Creates an object.

" + }, + "AttachObject":{ + "shape":"BatchAttachObject", + "documentation":"

Attaches an object to a Directory.

" + }, + "DetachObject":{ + "shape":"BatchDetachObject", + "documentation":"

Detaches an object from a Directory.

" + }, + "UpdateObjectAttributes":{ + "shape":"BatchUpdateObjectAttributes", + "documentation":"

Updates a given object's attributes.

" + }, + "DeleteObject":{ + "shape":"BatchDeleteObject", + "documentation":"

Deletes an object in a Directory.

" + }, + "AddFacetToObject":{ + "shape":"BatchAddFacetToObject", + "documentation":"

A batch operation that adds a facet to an object.

" + }, + "RemoveFacetFromObject":{ + "shape":"BatchRemoveFacetFromObject", + "documentation":"

A batch operation that removes a facet from an object.

" + }, + "AttachPolicy":{ + "shape":"BatchAttachPolicy", + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "DetachPolicy":{ + "shape":"BatchDetachPolicy", + "documentation":"

Detaches a policy from a Directory.

" + }, + "CreateIndex":{ + "shape":"BatchCreateIndex", + "documentation":"

Creates an index object. See Indexing and search for more information.

" + }, + "AttachToIndex":{ + "shape":"BatchAttachToIndex", + "documentation":"

Attaches the specified object to the specified index.

" + }, + "DetachFromIndex":{ + "shape":"BatchDetachFromIndex", + "documentation":"

Detaches the specified object from the specified index.

" + }, + "AttachTypedLink":{ + "shape":"BatchAttachTypedLink", + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" + }, + "DetachTypedLink":{ + "shape":"BatchDetachTypedLink", + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" + }, + "UpdateLinkAttributes":{ + "shape":"BatchUpdateLinkAttributes", + "documentation":"

Updates a given object's attributes.

" + } + }, + "documentation":"

Represents the output of a BatchWrite operation.

" + }, + "BatchWriteOperationList":{ + "type":"list", + "member":{"shape":"BatchWriteOperation"} + }, + "BatchWriteOperationResponse":{ + "type":"structure", + "members":{ + "CreateObject":{ + "shape":"BatchCreateObjectResponse", + "documentation":"

Creates an object in a Directory.

" + }, + "AttachObject":{ + "shape":"BatchAttachObjectResponse", + "documentation":"

Attaches an object to a Directory.

" + }, + "DetachObject":{ + "shape":"BatchDetachObjectResponse", + "documentation":"

Detaches an object from a Directory.

" + }, + "UpdateObjectAttributes":{ + "shape":"BatchUpdateObjectAttributesResponse", + "documentation":"

Updates a given object’s attributes.

" + }, + "DeleteObject":{ + "shape":"BatchDeleteObjectResponse", + "documentation":"

Deletes an object in a Directory.

" + }, + "AddFacetToObject":{ + "shape":"BatchAddFacetToObjectResponse", + "documentation":"

The result of an add facet to object batch operation.

" + }, + "RemoveFacetFromObject":{ + "shape":"BatchRemoveFacetFromObjectResponse", + "documentation":"

The result of a batch remove facet from object operation.

" + }, + "AttachPolicy":{ + "shape":"BatchAttachPolicyResponse", + "documentation":"

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

" + }, + "DetachPolicy":{ + "shape":"BatchDetachPolicyResponse", + "documentation":"

Detaches a policy from a Directory.

" + }, + "CreateIndex":{ + "shape":"BatchCreateIndexResponse", + "documentation":"

Creates an index object. See Indexing and search for more information.

" + }, + "AttachToIndex":{ + "shape":"BatchAttachToIndexResponse", + "documentation":"

Attaches the specified object to the specified index.

" + }, + "DetachFromIndex":{ + "shape":"BatchDetachFromIndexResponse", + "documentation":"

Detaches the specified object from the specified index.

" + }, + "AttachTypedLink":{ + "shape":"BatchAttachTypedLinkResponse", + "documentation":"

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

" + }, + "DetachTypedLink":{ + "shape":"BatchDetachTypedLinkResponse", + "documentation":"

Detaches a typed link from a specified source and target object. For more information, see Typed Links.

" + }, + "UpdateLinkAttributes":{ + "shape":"BatchUpdateLinkAttributesResponse", + "documentation":"

Represents the output of a BatchWrite response operation.

" + } + }, + "documentation":"

Represents the output of a BatchWrite response operation.

" + }, + "BatchWriteOperationResponseList":{ + "type":"list", + "member":{"shape":"BatchWriteOperationResponse"} + }, + "BatchWriteRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Operations" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Operations":{ + "shape":"BatchWriteOperationList", + "documentation":"

A list of operations that are part of the batch.

" + } + } + }, + "BatchWriteResponse":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchWriteOperationResponseList", + "documentation":"

A list of all the responses for each batch write.

" + } + } + }, + "BinaryAttributeValue":{"type":"blob"}, + "Bool":{"type":"boolean"}, + "BooleanAttributeValue":{"type":"boolean"}, + "CannotListParentOfRootException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Cannot list the parents of a Directory root.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConsistencyLevel":{ + "type":"string", + "enum":[ + "SERIALIZABLE", + "EVENTUAL" + ] + }, + "CreateDirectoryRequest":{ + "type":"structure", + "required":[ + "Name", + "SchemaArn" + ], + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the Directory. Should be unique per account, per region.

" + }, + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the published schema that will be copied into the data Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "CreateDirectoryResponse":{ + "type":"structure", + "required":[ + "DirectoryArn", + "Name", + "ObjectIdentifier", + "AppliedSchemaArn" + ], + "members":{ + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The ARN that is associated with the Directory. For more information, see arns.

" + }, + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the Directory.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The root object node of the created directory.

" + }, + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the published schema in the Directory. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see arns.

" + } + } + }, + "CreateFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The schema ARN in which the new Facet will be created. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the Facet, which is unique for a given schema.

" + }, + "Attributes":{ + "shape":"FacetAttributeList", + "documentation":"

The attributes that are associated with the Facet.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.

  • Leaf node: Cannot have children but can have multiple parents.

  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.

  • Index: Can be created with the Index API.

" + }, + "FacetStyle":{ + "shape":"FacetStyle", + "documentation":"

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

" + } + } + }, + "CreateFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "OrderedIndexedAttributeList", + "IsUnique" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory where the index should be created.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "OrderedIndexedAttributeList":{ + "shape":"AttributeKeyList", + "documentation":"

Specifies the attributes that should be indexed on. Currently only a single attribute is supported.

" + }, + "IsUnique":{ + "shape":"Bool", + "documentation":"

Indicates whether the attribute that is being indexed has unique values or not.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the parent object that contains the index object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link between the parent object and the index object.

" + } + } + }, + "CreateIndexResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the index created by this operation.

" + } + } + }, + "CreateObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacets" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

" + }, + "ObjectAttributeList":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attribute map whose attribute ARN contains the key and attribute value as the map value.

" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

If specified, the parent reference to which this object will be attached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of link that is used to attach this object to a parent.

" + } + } + }, + "CreateObjectResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The identifier that is associated with the object.

" + } + } + }, + "CreateSchemaRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"SchemaName", + "documentation":"

The name that is associated with the schema. This is unique to each account and in each region.

" + } + } + }, + "CreateSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" + } + } + }, + "CreateTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Facet" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Facet":{ + "shape":"TypedLinkFacet", + "documentation":"

Facet structure that is associated with the typed link facet.

" + } + } + }, + "CreateTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "Date":{"type":"timestamp"}, + "DatetimeAttributeValue":{"type":"timestamp"}, + "DeleteDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to delete.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DeleteDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the deleted directory.

" + } + } + }, + "DeleteFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet to delete.

" + } + } + }, + "DeleteFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference that identifies the object.

" + } + } + }, + "DeleteObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSchemaRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DeleteSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The input ARN that is returned as part of the response. For more information, see arns.

" + } + } + }, + "DeleteTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + } + }, + "DeleteTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "DetachFromIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory the index and object exist in.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the index object.

" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object being detached from the index.

" + } + } + }, + "DetachFromIndexResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the object that was detached from the index.

" + } + } + }, + "DetachObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ParentReference", + "LinkName" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ParentReference":{ + "shape":"ObjectReference", + "documentation":"

The parent reference from which the object with the specified link name is detached.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The link name associated with the object that needs to be detached.

" + } + } + }, + "DetachObjectResponse":{ + "type":"structure", + "members":{ + "DetachedObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier that was detached from the object.

" + } + } + }, + "DetachPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where both objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the policy object.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policy object will be detached.

" + } + } + }, + "DetachPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DetachTypedLinkRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Used to accept a typed link specifier as input.

" + } + } + }, + "Directory":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The name of the directory.

" + }, + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.

" + }, + "State":{ + "shape":"DirectoryState", + "documentation":"

The state of the directory. Can be either Enabled, Disabled, or Deleted.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the directory was created.

" + } + }, + "documentation":"

Directory structure that includes the directory name and directory ARN.

" + }, + "DirectoryAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryArn":{"type":"string"}, + "DirectoryDeletedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryList":{ + "type":"list", + "member":{"shape":"Directory"} + }, + "DirectoryName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "DirectoryNotDisabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An operation can only operate on a disabled directory.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryNotEnabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Operations are only permitted on enabled directories.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DirectoryState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "DELETED" + ] + }, + "DisableDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to disable.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "DisableDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that has been disabled.

" + } + } + }, + "EnableDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to enable.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "EnableDirectoryResponse":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the enabled directory.

" + } + } + }, + "ExceptionMessage":{"type":"string"}, + "Facet":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the Facet.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" + }, + "FacetStyle":{ + "shape":"FacetStyle", + "documentation":"

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

" + } + }, + "documentation":"

A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes. See Facets for more information.

" + }, + "FacetAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A facet with the same name already exists.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetAttribute":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

The name of the facet attribute.

" + }, + "AttributeDefinition":{ + "shape":"FacetAttributeDefinition", + "documentation":"

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

" + }, + "AttributeReference":{ + "shape":"FacetAttributeReference", + "documentation":"

An attribute reference that is associated with the attribute. See Attribute References for more information.

" + }, + "RequiredBehavior":{ + "shape":"RequiredAttributeBehavior", + "documentation":"

The required behavior of the FacetAttribute.

" + } + }, + "documentation":"

An attribute that is associated with the Facet.

" + }, + "FacetAttributeDefinition":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"FacetAttributeType", + "documentation":"

The type of the attribute.

" + }, + "DefaultValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The default value of the attribute (if configured).

" + }, + "IsImmutable":{ + "shape":"Bool", + "documentation":"

Whether the attribute is mutable or not.

" + }, + "Rules":{ + "shape":"RuleMap", + "documentation":"

Validation rules attached to the attribute definition.

" + } + }, + "documentation":"

A facet attribute definition. See Attribute References for more information.

" + }, + "FacetAttributeList":{ + "type":"list", + "member":{"shape":"FacetAttribute"} + }, + "FacetAttributeReference":{ + "type":"structure", + "required":[ + "TargetFacetName", + "TargetAttributeName" + ], + "members":{ + "TargetFacetName":{ + "shape":"FacetName", + "documentation":"

The target facet name that is associated with the facet reference. See Attribute References for more information.

" + }, + "TargetAttributeName":{ + "shape":"AttributeName", + "documentation":"

The target attribute name that is associated with the facet reference. See Attribute References for more information.

" + } + }, + "documentation":"

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

" + }, + "FacetAttributeType":{ + "type":"string", + "enum":[ + "STRING", + "BINARY", + "BOOLEAN", + "NUMBER", + "DATETIME", + "VARIANT" + ] + }, + "FacetAttributeUpdate":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"FacetAttribute", + "documentation":"

The attribute to update.

" + }, + "Action":{ + "shape":"UpdateActionType", + "documentation":"

The action to perform when updating the attribute.

" + } + }, + "documentation":"

A structure that contains information used to update an attribute.

" + }, + "FacetAttributeUpdateList":{ + "type":"list", + "member":{"shape":"FacetAttributeUpdate"} + }, + "FacetInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "FacetNameList":{ + "type":"list", + "member":{"shape":"FacetName"} + }, + "FacetNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified Facet could not be found.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FacetStyle":{ + "type":"string", + "enum":[ + "STATIC", + "DYNAMIC" + ] + }, + "FacetValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The Facet that you provided was not well formed or could not be validated with the schema.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "GetAppliedSchemaVersionRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the applied schema.

" + } + } + }, + "GetAppliedSchemaVersionResponse":{ + "type":"structure", + "members":{ + "AppliedSchemaArn":{ + "shape":"Arn", + "documentation":"

Current applied schema ARN, including the minor version in use if one was provided.

" + } + } + }, + "GetDirectoryRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"DirectoryArn", + "documentation":"

The ARN of the directory.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "GetDirectoryResponse":{ + "type":"structure", + "required":["Directory"], + "members":{ + "Directory":{ + "shape":"Directory", + "documentation":"

Metadata about the directory.

" + } + } + }, + "GetFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet to retrieve.

" + } + } + }, + "GetFacetResponse":{ + "type":"structure", + "members":{ + "Facet":{ + "shape":"Facet", + "documentation":"

The Facet structure that is associated with the facet.

" + } + } + }, + "GetLinkAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeNames" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

A list of attribute names whose values will be retrieved.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the attributes on a typed link.

" + } + } + }, + "GetLinkAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the typed link.

" + } + } + }, + "GetObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference", + "SchemaFacet", + "AttributeNames" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be retrieved.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the attributes on an object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.

" + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

List of attribute names whose values will be retrieved.

" + } + } + }, + "GetObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The attributes that are associated with the object.

" + } + } + }, + "GetObjectInformationRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory being retrieved.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level at which to retrieve the object information.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "GetObjectInformationResponse":{ + "type":"structure", + "members":{ + "SchemaFacets":{ + "shape":"SchemaFacetList", + "documentation":"

The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the specified object.

" + } + } + }, + "GetSchemaAsJsonRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to retrieve.

", + "location":"header", + "locationName":"x-amz-data-partition" + } + } + }, + "GetSchemaAsJsonResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"SchemaName", + "documentation":"

The name of the retrieved schema.

" + }, + "Document":{ + "shape":"SchemaJsonDocument", + "documentation":"

The JSON representation of the schema document.

" + } + } + }, + "GetTypedLinkFacetInformationRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + } + }, + "GetTypedLinkFacetInformationResponse":{ + "type":"structure", + "members":{ + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

" + } + } + }, + "IncompatibleSchemaException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IndexAttachment":{ + "type":"structure", + "members":{ + "IndexedAttributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

The indexed attribute values.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

In response to ListIndex, the ObjectIdentifier of the object attached to the index. In response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object. This field will always contain the ObjectIdentifier of the object on the opposite side of the attachment specified in the query.

" + } + }, + "documentation":"

Represents an index and an attached object.

" + }, + "IndexAttachmentList":{ + "type":"list", + "member":{"shape":"IndexAttachment"} + }, + "IndexedAttributeMissingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidArnException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the provided ARN value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidAttachmentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidFacetUpdateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An attempt to modify a Facet resulted in an invalid schema exception.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the NextToken value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRuleException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when any of the rule parameter keys or values are invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSchemaDocException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the provided SchemaDoc value is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTaggingRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that limits are exceeded. See Limits for more information.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LinkAttributeAction":{ + "type":"structure", + "members":{ + "AttributeActionType":{ + "shape":"UpdateActionType", + "documentation":"

A type that can be either UPDATE_OR_CREATE or DELETE.

" + }, + "AttributeUpdateValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value that you want to update to.

" + } + }, + "documentation":"

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

" + }, + "LinkAttributeUpdate":{ + "type":"structure", + "members":{ + "AttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute being updated.

" + }, + "AttributeAction":{ + "shape":"LinkAttributeAction", + "documentation":"

The action to perform as part of the attribute update.

" + } + }, + "documentation":"

Structure that contains attribute update information.

" + }, + "LinkAttributeUpdateList":{ + "type":"list", + "member":{"shape":"LinkAttributeUpdate"} + }, + "LinkName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+" + }, + "LinkNameAlreadyInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LinkNameToObjectIdentifierMap":{ + "type":"map", + "key":{"shape":"LinkName"}, + "value":{"shape":"ObjectIdentifier"} + }, + "ListAppliedSchemaArnsRequest":{ + "type":"structure", + "required":["DirectoryArn"], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory you are listing.

" + }, + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListAppliedSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of schemas that are applied to the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListAttachedIndicesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TargetReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TargetReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object that has indices attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to use for this operation.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListAttachedIndicesResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The indices attached to the specified object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListDevelopmentSchemaArnsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListDevelopmentSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of retrieved development schemas.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListDirectoriesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "state":{ + "shape":"DirectoryState", + "documentation":"

The state of the directories in the list. Can be either Enabled, Disabled, or Deleted.

" + } + } + }, + "ListDirectoriesResponse":{ + "type":"structure", + "required":["Directories"], + "members":{ + "Directories":{ + "shape":"DirectoryList", + "documentation":"

Lists all directories that are associated with your account in pagination fashion.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListFacetAttributesRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema where the facet resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet whose attributes will be retrieved.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListFacetAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"FacetAttributeList", + "documentation":"

The attributes attached to the facet.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListFacetNamesRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) to retrieve facet names from.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListFacetNamesResponse":{ + "type":"structure", + "members":{ + "FacetNames":{ + "shape":"FacetNameList", + "documentation":"

The names of facets that exist within the schema.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListIncomingTypedLinksRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

" + } + } + }, + "ListIncomingTypedLinksResponse":{ + "type":"structure", + "members":{ + "LinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns one or more typed link specifiers as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListIndexRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "IndexReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that the index exists in.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "RangesOnIndexedValues":{ + "shape":"ObjectAttributeRangeList", + "documentation":"

Specifies the ranges of indexed values that you want to query.

" + }, + "IndexReference":{ + "shape":"ObjectReference", + "documentation":"

The reference to the index to list.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListIndexResponse":{ + "type":"structure", + "members":{ + "IndexAttachments":{ + "shape":"IndexAttachmentList", + "documentation":"

The objects and indexed values attached to the index.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListManagedSchemaArnsRequest":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListManagedSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs for all AWS managed schemas.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose attributes will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + }, + "FacetFilter":{ + "shape":"SchemaFacet", + "documentation":"

Used to filter the list of object attributes that are associated with a certain facet.

" + } + } + }, + "ListObjectAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeKeyAndValueList", + "documentation":"

Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectChildrenRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object for which child objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListObjectChildrenResponse":{ + "type":"structure", + "members":{ + "Children":{ + "shape":"LinkNameToObjectIdentifierMap", + "documentation":"

Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectParentPathsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory to which the parent path applies.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object whose parent paths are listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + } + }, + "ListObjectParentPathsResponse":{ + "type":"structure", + "members":{ + "PathToObjectIdentifiersList":{ + "shape":"PathToObjectIdentifiersList", + "documentation":"

Returns the path to the ObjectIdentifiers that are associated with the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListObjectParentsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object for which parent objects are being listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + }, + "IncludeAllLinksToEachParent":{ + "shape":"Bool", + "documentation":"

When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

" + } + } + }, + "ListObjectParentsResponse":{ + "type":"structure", + "members":{ + "Parents":{ + "shape":"ObjectIdentifierToLinkNameMap", + "documentation":"

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "ParentLinks":{ + "shape":"ObjectIdentifierAndLinkNameList", + "documentation":"

Returns a list of parent reference and LinkName Tuples.

" + } + } + }, + "ListObjectPoliciesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object for which policies will be listed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListObjectPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicyIds":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of policy ObjectIdentifiers, that are attached to the object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListOutgoingTypedLinksRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference that identifies the object whose attributes will be listed.

" + }, + "FilterAttributeRanges":{ + "shape":"TypedLinkAttributeRangeList", + "documentation":"

Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

" + }, + "FilterTypedLink":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

The consistency level to execute the request at.

" + } + } + }, + "ListOutgoingTypedLinksResponse":{ + "type":"structure", + "members":{ + "TypedLinkSpecifiers":{ + "shape":"TypedLinkSpecifierList", + "documentation":"

Returns a typed link specifier as output.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListPolicyAttachmentsRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "PolicyReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where objects reside. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "PolicyReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the policy object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + }, + "ConsistencyLevel":{ + "shape":"ConsistencyLevel", + "documentation":"

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

", + "location":"header", + "locationName":"x-amz-consistency-level" + } + } + }, + "ListPolicyAttachmentsResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

A list of ObjectIdentifiers to which the policy is attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListPublishedSchemaArnsRequest":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The response for ListPublishedSchemaArns when this parameter is used will list all minor version ARNs for a major version.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListPublishedSchemaArnsResponse":{ + "type":"structure", + "members":{ + "SchemaArns":{ + "shape":"Arns", + "documentation":"

The ARNs of published schemas.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token. This is for future use. Currently pagination is not supported for tagging.

" + }, + "MaxResults":{ + "shape":"TagsNumberResults", + "documentation":"

The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tag key value pairs that are associated with the response.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTypedLinkFacetAttributesRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListTypedLinkFacetAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TypedLinkAttributeDefinitionList", + "documentation":"

An ordered set of attributes associate with the typed link.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "ListTypedLinkFacetNamesRequest":{ + "type":"structure", + "required":["SchemaArn"], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of results to retrieve.

" + } + } + }, + "ListTypedLinkFacetNamesResponse":{ + "type":"structure", + "members":{ + "FacetNames":{ + "shape":"TypedLinkNameList", + "documentation":"

The names of typed link facets that exist within the schema.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "LookupPolicyRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Reference that identifies the object whose policies will be looked up.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"NumberResults", + "documentation":"

The maximum number of items to be retrieved in a single call. This is an approximate number.

" + } + } + }, + "LookupPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyToPathList":{ + "shape":"PolicyToPathList", + "documentation":"

Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType. For more information, see Policies.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The pagination token.

" + } + } + }, + "NextToken":{"type":"string"}, + "NotIndexException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation can only operate on index objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotNodeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotPolicyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation can only operate on policy objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NumberAttributeValue":{"type":"string"}, + "NumberResults":{ + "type":"integer", + "min":1 + }, + "ObjectAlreadyDetachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the object is not attached to the index.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ObjectAttributeAction":{ + "type":"structure", + "members":{ + "ObjectAttributeActionType":{ + "shape":"UpdateActionType", + "documentation":"

A type that can be either Update or Delete.

" + }, + "ObjectAttributeUpdateValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value that you want to update to.

" + } + }, + "documentation":"

The action to take on the object attribute.

" + }, + "ObjectAttributeRange":{ + "type":"structure", + "members":{ + "AttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute that the attribute range covers.

" + }, + "Range":{ + "shape":"TypedAttributeValueRange", + "documentation":"

The range of attribute values being selected.

" + } + }, + "documentation":"

A range of attributes.

" + }, + "ObjectAttributeRangeList":{ + "type":"list", + "member":{"shape":"ObjectAttributeRange"} + }, + "ObjectAttributeUpdate":{ + "type":"structure", + "members":{ + "ObjectAttributeKey":{ + "shape":"AttributeKey", + "documentation":"

The key of the attribute being updated.

" + }, + "ObjectAttributeAction":{ + "shape":"ObjectAttributeAction", + "documentation":"

The action to perform as part of the attribute update.

" + } + }, + "documentation":"

Structure that contains attribute update information.

" + }, + "ObjectAttributeUpdateList":{ + "type":"list", + "member":{"shape":"ObjectAttributeUpdate"} + }, + "ObjectIdentifier":{"type":"string"}, + "ObjectIdentifierAndLinkNameList":{ + "type":"list", + "member":{"shape":"ObjectIdentifierAndLinkNameTuple"} + }, + "ObjectIdentifierAndLinkNameTuple":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ID that is associated with the object.

" + }, + "LinkName":{ + "shape":"LinkName", + "documentation":"

The name of the link between the parent and the child object.

" + } + }, + "documentation":"

A pair of ObjectIdentifier and LinkName.

" + }, + "ObjectIdentifierList":{ + "type":"list", + "member":{"shape":"ObjectIdentifier"} + }, + "ObjectIdentifierToLinkNameMap":{ + "type":"map", + "key":{"shape":"ObjectIdentifier"}, + "value":{"shape":"LinkName"} + }, + "ObjectNotDetachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ObjectReference":{ + "type":"structure", + "members":{ + "Selector":{ + "shape":"SelectorObjectReference", + "documentation":"

A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:

  • $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier

  • /some/path - Identifies the object based on path

  • #SomeBatchReference - Identifies the object in a batch call

" + } + }, + "documentation":"

The reference that identifies an object.

" + }, + "ObjectType":{ + "type":"string", + "enum":[ + "NODE", + "LEAF_NODE", + "POLICY", + "INDEX" + ] + }, + "PathString":{"type":"string"}, + "PathToObjectIdentifiers":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"PathString", + "documentation":"

The path that is used to identify the object starting from directory root.

" + }, + "ObjectIdentifiers":{ + "shape":"ObjectIdentifierList", + "documentation":"

Lists ObjectIdentifiers starting from directory root to the object in the request.

" + } + }, + "documentation":"

Returns the path to the ObjectIdentifiers that is associated with the directory.

" + }, + "PathToObjectIdentifiersList":{ + "type":"list", + "member":{"shape":"PathToObjectIdentifiers"} + }, + "PolicyAttachment":{ + "type":"structure", + "members":{ + "PolicyId":{ + "shape":"ObjectIdentifier", + "documentation":"

The ID of PolicyAttachment.

" + }, + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier that is associated with PolicyAttachment.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The type of policy that can be associated with PolicyAttachment.

" + } + }, + "documentation":"

Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached. For more information, see Policies.

" + }, + "PolicyAttachmentList":{ + "type":"list", + "member":{"shape":"PolicyAttachment"} + }, + "PolicyToPath":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"PathString", + "documentation":"

The path that is referenced from the root.

" + }, + "Policies":{ + "shape":"PolicyAttachmentList", + "documentation":"

List of policy objects.

" + } + }, + "documentation":"

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

" + }, + "PolicyToPathList":{ + "type":"list", + "member":{"shape":"PolicyToPath"} + }, + "PolicyType":{"type":"string"}, + "PublishSchemaRequest":{ + "type":"structure", + "required":[ + "DevelopmentSchemaArn", + "Version" + ], + "members":{ + "DevelopmentSchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Version":{ + "shape":"Version", + "documentation":"

The major version under which the schema will be published. Schemas have both a major and minor version associated with them.

" + }, + "MinorVersion":{ + "shape":"Version", + "documentation":"

The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.

" + }, + "Name":{ + "shape":"SchemaName", + "documentation":"

The new name under which the schema will be published. If this is not provided, the development schema is considered.

" + } + } + }, + "PublishSchemaResponse":{ + "type":"structure", + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the published schema. For more information, see arns.

" + } + } + }, + "PutSchemaFromJsonRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Document" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to update.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Document":{ + "shape":"SchemaJsonDocument", + "documentation":"

The replacement JSON schema.

" + } + } + }, + "PutSchemaFromJsonResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to update.

" + } + } + }, + "RangeMode":{ + "type":"string", + "enum":[ + "FIRST", + "LAST", + "LAST_BEFORE_MISSING_VALUES", + "INCLUSIVE", + "EXCLUSIVE" + ] + }, + "RemoveFacetFromObjectRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "SchemaFacet", + "ObjectReference" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory in which the object resides.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "SchemaFacet":{ + "shape":"SchemaFacet", + "documentation":"

The facet to remove. See SchemaFacet for details.

" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

A reference to the object to remove the facet from.

" + } + } + }, + "RemoveFacetFromObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "RequiredAttributeBehavior":{ + "type":"string", + "enum":[ + "REQUIRED_ALWAYS", + "NOT_REQUIRED" + ] + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified resource could not be found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RetryableConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "Rule":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"RuleType", + "documentation":"

The type of attribute validation rule.

" + }, + "Parameters":{ + "shape":"RuleParameterMap", + "documentation":"

The minimum and maximum parameters that are associated with the rule.

" + } + }, + "documentation":"

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

" + }, + "RuleKey":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "RuleMap":{ + "type":"map", + "key":{"shape":"RuleKey"}, + "value":{"shape":"Rule"} + }, + "RuleParameterKey":{"type":"string"}, + "RuleParameterMap":{ + "type":"map", + "key":{"shape":"RuleParameterKey"}, + "value":{"shape":"RuleParameterValue"} + }, + "RuleParameterValue":{"type":"string"}, + "RuleType":{ + "type":"string", + "enum":[ + "BINARY_LENGTH", + "NUMBER_COMPARISON", + "STRING_FROM_SET", + "STRING_LENGTH" + ] + }, + "SchemaAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SchemaAlreadyPublishedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that a schema is already published.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SchemaFacet":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions.

" + }, + "FacetName":{ + "shape":"FacetName", + "documentation":"

The name of the facet.

" + } + }, + "documentation":"

A facet.

" + }, + "SchemaFacetList":{ + "type":"list", + "member":{"shape":"SchemaFacet"} + }, + "SchemaJsonDocument":{"type":"string"}, + "SchemaName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "SelectorObjectReference":{"type":"string"}, + "StillContainsLinksException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The object could not be deleted because links still exist. Remove the links and then try the operation again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "StringAttributeValue":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key that is associated with the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value that is associated with the tag.

" + } + }, + "documentation":"

The tag structure that contains a tag key and value.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tag key-value pairs.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "TagsNumberResults":{ + "type":"integer", + "min":50 + }, + "TypedAttributeValue":{ + "type":"structure", + "members":{ + "StringValue":{ + "shape":"StringAttributeValue", + "documentation":"

A string data value.

" + }, + "BinaryValue":{ + "shape":"BinaryAttributeValue", + "documentation":"

A binary data value.

" + }, + "BooleanValue":{ + "shape":"BooleanAttributeValue", + "documentation":"

A Boolean data value.

" + }, + "NumberValue":{ + "shape":"NumberAttributeValue", + "documentation":"

A number data value.

" + }, + "DatetimeValue":{ + "shape":"DatetimeAttributeValue", + "documentation":"

A date and time value.

" + } + }, + "documentation":"

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

" + }, + "TypedAttributeValueRange":{ + "type":"structure", + "required":[ + "StartMode", + "EndMode" + ], + "members":{ + "StartMode":{ + "shape":"RangeMode", + "documentation":"

The inclusive or exclusive range start.

" + }, + "StartValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The value to start the range at.

" + }, + "EndMode":{ + "shape":"RangeMode", + "documentation":"

The inclusive or exclusive range end.

" + }, + "EndValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The attribute value to terminate the range at.

" + } + }, + "documentation":"

A range of attribute values. For more information, see Range Filters.

" + }, + "TypedLinkAttributeDefinition":{ + "type":"structure", + "required":[ + "Name", + "Type", + "RequiredBehavior" + ], + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

The unique name of the typed link attribute.

" + }, + "Type":{ + "shape":"FacetAttributeType", + "documentation":"

The type of the attribute.

" + }, + "DefaultValue":{ + "shape":"TypedAttributeValue", + "documentation":"

The default value of the attribute (if configured).

" + }, + "IsImmutable":{ + "shape":"Bool", + "documentation":"

Whether the attribute is mutable or not.

" + }, + "Rules":{ + "shape":"RuleMap", + "documentation":"

Validation rules that are attached to the attribute definition.

" + }, + "RequiredBehavior":{ + "shape":"RequiredAttributeBehavior", + "documentation":"

The required behavior of the TypedLinkAttributeDefinition.

" + } + }, + "documentation":"

A typed link attribute definition.

" + }, + "TypedLinkAttributeDefinitionList":{ + "type":"list", + "member":{"shape":"TypedLinkAttributeDefinition"} + }, + "TypedLinkAttributeRange":{ + "type":"structure", + "required":["Range"], + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The unique name of the typed link attribute.

" + }, + "Range":{ + "shape":"TypedAttributeValueRange", + "documentation":"

The range of attribute values that are being selected.

" + } + }, + "documentation":"

Identifies the range of attributes that are used by a specified filter.

" + }, + "TypedLinkAttributeRangeList":{ + "type":"list", + "member":{"shape":"TypedLinkAttributeRange"} + }, + "TypedLinkFacet":{ + "type":"structure", + "required":[ + "Name", + "Attributes", + "IdentityAttributeOrder" + ], + "members":{ + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "Attributes":{ + "shape":"TypedLinkAttributeDefinitionList", + "documentation":"

A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.

" + }, + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.

" + } + }, + "documentation":"

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

" + }, + "TypedLinkFacetAttributeUpdate":{ + "type":"structure", + "required":[ + "Attribute", + "Action" + ], + "members":{ + "Attribute":{ + "shape":"TypedLinkAttributeDefinition", + "documentation":"

The attribute to update.

" + }, + "Action":{ + "shape":"UpdateActionType", + "documentation":"

The action to perform when updating the attribute.

" + } + }, + "documentation":"

A typed link facet attribute update.

" + }, + "TypedLinkFacetAttributeUpdateList":{ + "type":"list", + "member":{"shape":"TypedLinkFacetAttributeUpdate"} + }, + "TypedLinkName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9._-]*$" + }, + "TypedLinkNameList":{ + "type":"list", + "member":{"shape":"TypedLinkName"} + }, + "TypedLinkSchemaAndFacetName":{ + "type":"structure", + "required":[ + "SchemaArn", + "TypedLinkName" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

" + }, + "TypedLinkName":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + } + }, + "documentation":"

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

" + }, + "TypedLinkSpecifier":{ + "type":"structure", + "required":[ + "TypedLinkFacet", + "SourceObjectReference", + "TargetObjectReference", + "IdentityAttributeValues" + ], + "members":{ + "TypedLinkFacet":{ + "shape":"TypedLinkSchemaAndFacetName", + "documentation":"

Identifies the typed link facet that is associated with the typed link.

" + }, + "SourceObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the source object that the typed link will attach to.

" + }, + "TargetObjectReference":{ + "shape":"ObjectReference", + "documentation":"

Identifies the target object that the typed link will attach to.

" + }, + "IdentityAttributeValues":{ + "shape":"AttributeNameAndValueList", + "documentation":"

Identifies the attribute value to update.

" + } + }, + "documentation":"

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

" + }, + "TypedLinkSpecifierList":{ + "type":"list", + "member":{"shape":"TypedLinkSpecifier"} + }, + "UnsupportedIndexTypeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that the requested index type is not supported.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

Keys of the tag that need to be removed from the resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateActionType":{ + "type":"string", + "enum":[ + "CREATE_OR_UPDATE", + "DELETE" + ] + }, + "UpdateFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"FacetName", + "documentation":"

The name of the facet.

" + }, + "AttributeUpdates":{ + "shape":"FacetAttributeUpdateList", + "documentation":"

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

" + }, + "ObjectType":{ + "shape":"ObjectType", + "documentation":"

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

" + } + } + }, + "UpdateFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLinkAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "TypedLinkSpecifier", + "AttributeUpdates" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "TypedLinkSpecifier":{ + "shape":"TypedLinkSpecifier", + "documentation":"

Allows a typed link specifier to be accepted as input.

" + }, + "AttributeUpdates":{ + "shape":"LinkAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + } + }, + "UpdateLinkAttributesResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateObjectAttributesRequest":{ + "type":"structure", + "required":[ + "DirectoryArn", + "ObjectReference", + "AttributeUpdates" + ], + "members":{ + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "ObjectReference":{ + "shape":"ObjectReference", + "documentation":"

The reference that identifies the object.

" + }, + "AttributeUpdates":{ + "shape":"ObjectAttributeUpdateList", + "documentation":"

The attributes update structure.

" + } + } + }, + "UpdateObjectAttributesResponse":{ + "type":"structure", + "members":{ + "ObjectIdentifier":{ + "shape":"ObjectIdentifier", + "documentation":"

The ObjectIdentifier of the updated object.

" + } + } + }, + "UpdateSchemaRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"SchemaName", + "documentation":"

The name of the schema.

" + } + } + }, + "UpdateSchemaResponse":{ + "type":"structure", + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN that is associated with the updated schema. For more information, see arns.

" + } + } + }, + "UpdateTypedLinkFacetRequest":{ + "type":"structure", + "required":[ + "SchemaArn", + "Name", + "AttributeUpdates", + "IdentityAttributeOrder" + ], + "members":{ + "SchemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

", + "location":"header", + "locationName":"x-amz-data-partition" + }, + "Name":{ + "shape":"TypedLinkName", + "documentation":"

The unique name of the typed link facet.

" + }, + "AttributeUpdates":{ + "shape":"TypedLinkFacetAttributeUpdateList", + "documentation":"

Attributes update structure.

" + }, + "IdentityAttributeOrder":{ + "shape":"AttributeNameList", + "documentation":"

The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

" + } + } + }, + "UpdateTypedLinkFacetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpgradeAppliedSchemaRequest":{ + "type":"structure", + "required":[ + "PublishedSchemaArn", + "DirectoryArn" + ], + "members":{ + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The revision of the published schema to upgrade the directory to.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN for the directory to which the upgraded schema will be applied.

" + }, + "DryRun":{ + "shape":"Bool", + "documentation":"

Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.

" + } + } + }, + "UpgradeAppliedSchemaResponse":{ + "type":"structure", + "members":{ + "UpgradedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" + }, + "DirectoryArn":{ + "shape":"Arn", + "documentation":"

The ARN of the directory that is returned as part of the response.

" + } + } + }, + "UpgradePublishedSchemaRequest":{ + "type":"structure", + "required":[ + "DevelopmentSchemaArn", + "PublishedSchemaArn", + "MinorVersion" + ], + "members":{ + "DevelopmentSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the development schema with the changes used for the upgrade.

" + }, + "PublishedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the published schema to be upgraded.

" + }, + "MinorVersion":{ + "shape":"Version", + "documentation":"

Identifies the minor version of the published schema that will be created. This parameter is NOT optional.

" + }, + "DryRun":{ + "shape":"Bool", + "documentation":"

Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.

" + } + } + }, + "UpgradePublishedSchemaResponse":{ + "type":"structure", + "members":{ + "UpgradedSchemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the upgraded schema that is returned as part of the response.

" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Indicates that your request is malformed in some manner. See the exception message.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Version":{ + "type":"string", + "max":10, + "min":1, + "pattern":"^[a-zA-Z0-9._-]*$" + } + }, + "documentation":"Amazon Cloud Directory

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudformation/2010-05-15/examples-1.json b/aws/dist/botocore/data/cloudformation/2010-05-15/examples-1.json new file mode 100644 index 00000000..e7802626 --- /dev/null +++ b/aws/dist/botocore/data/cloudformation/2010-05-15/examples-1.json @@ -0,0 +1,158 @@ +{ + "version": "1.0", + "examples": { + "CancelUpdateStack": [ + { + "input": { + "StackName": "MyStack" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels an update of the specified stack.", + "id": "to-cancel-a-stack-update-that-is-in-progress-1472747085196", + "title": "To cancel a stack update in progress" + } + ], + "UpdateStack": [ + { + "input": { + "NotificationARNs": [ + + ], + "Parameters": [ + { + "ParameterKey": "KeyPairName", + "ParameterValue": "ExampleKeyPair" + }, + { + "ParameterKey": "SubnetIDs", + "ParameterValue": "ExampleSubnetID1, ExampleSubnetID2" + } + ], + "ResourceTypes": [ + + ], + "StackName": "MyStack", + "Tags": [ + + ], + "TemplateURL": "https://s3.amazonaws.com/example/updated.template" + }, + "output": { + "StackId": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the template and input parameters for the specified stack.", + "id": "to-update-an-aws-cloudformation-stack-1472841931621", + "title": "To update an AWS CloudFormation stack" + }, + { + "input": { + "NotificationARNs": [ + + ], + "Parameters": [ + { + "ParameterKey": "KeyPairName", + "UsePreviousValue": true + }, + { + "ParameterKey": "SubnetIDs", + "ParameterValue": "SampleSubnetID1, UpdatedSampleSubnetID2" + } + ], + "ResourceTypes": [ + + ], + "StackName": "MyStack", + "Tags": [ + + ], + "TemplateURL": "https://s3.amazonaws.com/example/updated.template" + }, + "output": { + "StackId": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.", + "id": "to-update-an-aws-cloudformation-stack-1472841931621", + "title": "To update an AWS CloudFormation stack" + }, + { + "input": { + "Capabilities": [ + + ], + "NotificationARNs": [ + "arn:aws:sns:use-east-1:123456789012:mytopic1", + "arn:aws:sns:us-east-1:123456789012:mytopic2" + ], + "Parameters": [ + + ], + "ResourceTypes": [ + + ], + "StackName": "MyStack", + "Tags": [ + + ], + "TemplateURL": "https://s3.amazonaws.com/example/updated.template", + "UsePreviousTemplate": true + }, + "output": { + "StackId": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds two stack notification topics to the specified stack.", + "id": "to-update-an-aws-cloudformation-stack-1472841931621", + "title": "To update an AWS CloudFormation stack" + } + ], + "ValidateTemplate": [ + { + "input": { + "TemplateBody": "MyTemplate.json" + }, + "output": { + "Capabilities": [ + + ], + "CapabilitiesReason": "", + "Description": "AWS CloudFormation Example Template S3_Bucket: An example template that shows how to create a publicly-accessible S3 bucket. IMPORTANT: This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.", + "Parameters": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example validates the specified template.", + "id": "to-validate-an-aws-cloudformation-template-1472839072307", + "title": "To validate an AWS CloudFormation template" + } + ] + } +} diff --git a/aws/dist/botocore/data/cloudformation/2010-05-15/paginators-1.json b/aws/dist/botocore/data/cloudformation/2010-05-15/paginators-1.json new file mode 100644 index 00000000..8ce34e47 --- /dev/null +++ b/aws/dist/botocore/data/cloudformation/2010-05-15/paginators-1.json @@ -0,0 +1,89 @@ +{ + "pagination": { + "DescribeAccountLimits": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "AccountLimits" + }, + "DescribeChangeSet": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Changes", + "non_aggregate_keys": [ + "ChangeSetName", + "ChangeSetId", + "StackId", + "StackName", + "Description", + "Parameters", + "CreationTime", + "ExecutionStatus", + "Status", + "StatusReason", + "NotificationARNs", + "RollbackConfiguration", + "Capabilities", + "Tags" + ] + }, + "DescribeStackEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackEvents" + }, + "DescribeStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Stacks" + }, + "ListChangeSets": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Summaries" + }, + "ListStackInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Summaries" + }, + "ListStackResources": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackResourceSummaries" + }, + "ListStacks": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "StackSummaries" + }, + "ListStackSetOperationResults": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Summaries" + }, + "ListStackSetOperations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Summaries" + }, + "ListStackSets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Summaries" + }, + "ListExports": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Exports" + }, + "ListImports": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Imports" + } + } +} diff --git a/aws/dist/botocore/data/cloudformation/2010-05-15/service-2.json b/aws/dist/botocore/data/cloudformation/2010-05-15/service-2.json new file mode 100644 index 00000000..f29128b3 --- /dev/null +++ b/aws/dist/botocore/data/cloudformation/2010-05-15/service-2.json @@ -0,0 +1,4232 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-05-15", + "endpointPrefix":"cloudformation", + "protocol":"query", + "serviceFullName":"AWS CloudFormation", + "serviceId":"CloudFormation", + "signatureVersion":"v4", + "uid":"cloudformation-2010-05-15", + "xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/" + }, + "operations":{ + "CancelUpdateStack":{ + "name":"CancelUpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelUpdateStackInput"}, + "errors":[ + {"shape":"TokenAlreadyExistsException"} + ], + "documentation":"

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

" + }, + "ContinueUpdateRollback":{ + "name":"ContinueUpdateRollback", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ContinueUpdateRollbackInput"}, + "output":{ + "shape":"ContinueUpdateRollbackOutput", + "resultWrapper":"ContinueUpdateRollbackResult" + }, + "errors":[ + {"shape":"TokenAlreadyExistsException"} + ], + "documentation":"

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

" + }, + "CreateChangeSet":{ + "name":"CreateChangeSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateChangeSetInput"}, + "output":{ + "shape":"CreateChangeSetOutput", + "resultWrapper":"CreateChangeSetResult" + }, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InsufficientCapabilitiesException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.

To create a change set for a stack that doesn't exist, for the ChangeSetType parameter, specify CREATE. To create a change set for an existing stack, specify UPDATE for the ChangeSetType parameter. After the CreateChangeSet call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the DescribeChangeSet action.

When you are satisfied with the changes the change set will make, execute the change set by using the ExecuteChangeSet action. AWS CloudFormation doesn't make changes until you execute the change set.

" + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackInput"}, + "output":{ + "shape":"CreateStackOutput", + "resultWrapper":"CreateStackResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"TokenAlreadyExistsException"}, + {"shape":"InsufficientCapabilitiesException"} + ], + "documentation":"

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

" + }, + "CreateStackInstances":{ + "name":"CreateStackInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackInstancesInput"}, + "output":{ + "shape":"CreateStackInstancesOutput", + "resultWrapper":"CreateStackInstancesResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationInProgressException"}, + {"shape":"OperationIdAlreadyExistsException"}, + {"shape":"StaleRequestException"}, + {"shape":"InvalidOperationException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. Accounts and Regions are required parameters—you must specify at least one account and one region.

" + }, + "CreateStackSet":{ + "name":"CreateStackSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackSetInput"}, + "output":{ + "shape":"CreateStackSetOutput", + "resultWrapper":"CreateStackSetResult" + }, + "errors":[ + {"shape":"NameAlreadyExistsException"}, + {"shape":"CreatedButModifiedException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a stack set.

" + }, + "DeleteChangeSet":{ + "name":"DeleteChangeSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteChangeSetInput"}, + "output":{ + "shape":"DeleteChangeSetOutput", + "resultWrapper":"DeleteChangeSetResult" + }, + "errors":[ + {"shape":"InvalidChangeSetStatusException"} + ], + "documentation":"

Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.

If the call successfully completes, AWS CloudFormation successfully deleted the change set.

" + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackInput"}, + "errors":[ + {"shape":"TokenAlreadyExistsException"} + ], + "documentation":"

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

" + }, + "DeleteStackInstances":{ + "name":"DeleteStackInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackInstancesInput"}, + "output":{ + "shape":"DeleteStackInstancesOutput", + "resultWrapper":"DeleteStackInstancesResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationInProgressException"}, + {"shape":"OperationIdAlreadyExistsException"}, + {"shape":"StaleRequestException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Deletes stack instances for the specified accounts, in the specified regions.

" + }, + "DeleteStackSet":{ + "name":"DeleteStackSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackSetInput"}, + "output":{ + "shape":"DeleteStackSetOutput", + "resultWrapper":"DeleteStackSetResult" + }, + "errors":[ + {"shape":"StackSetNotEmptyException"}, + {"shape":"OperationInProgressException"} + ], + "documentation":"

Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see DeleteStackInstances.

" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountLimitsInput"}, + "output":{ + "shape":"DescribeAccountLimitsOutput", + "resultWrapper":"DescribeAccountLimitsResult" + }, + "documentation":"

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.

" + }, + "DescribeChangeSet":{ + "name":"DescribeChangeSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeChangeSetInput"}, + "output":{ + "shape":"DescribeChangeSetOutput", + "resultWrapper":"DescribeChangeSetResult" + }, + "errors":[ + {"shape":"ChangeSetNotFoundException"} + ], + "documentation":"

Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets in the AWS CloudFormation User Guide.

" + }, + "DescribeStackDriftDetectionStatus":{ + "name":"DescribeStackDriftDetectionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackDriftDetectionStatusInput"}, + "output":{ + "shape":"DescribeStackDriftDetectionStatusOutput", + "resultWrapper":"DescribeStackDriftDetectionStatusResult" + }, + "documentation":"

Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift to initiate a stack drift detection operation. DetectStackDrift returns a StackDriftDetectionId you can use to monitor the progress of the operation using DescribeStackDriftDetectionStatus. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

" + }, + "DescribeStackEvents":{ + "name":"DescribeStackEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackEventsInput"}, + "output":{ + "shape":"DescribeStackEventsOutput", + "resultWrapper":"DescribeStackEventsResult" + }, + "documentation":"

Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

" + }, + "DescribeStackInstance":{ + "name":"DescribeStackInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackInstanceInput"}, + "output":{ + "shape":"DescribeStackInstanceOutput", + "resultWrapper":"DescribeStackInstanceResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"StackInstanceNotFoundException"} + ], + "documentation":"

Returns the stack instance that's associated with the specified stack set, AWS account, and region.

For a list of stack instances that are associated with a specific stack set, use ListStackInstances.

" + }, + "DescribeStackResource":{ + "name":"DescribeStackResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackResourceInput"}, + "output":{ + "shape":"DescribeStackResourceOutput", + "resultWrapper":"DescribeStackResourceResult" + }, + "documentation":"

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

" + }, + "DescribeStackResourceDrifts":{ + "name":"DescribeStackResourceDrifts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackResourceDriftsInput"}, + "output":{ + "shape":"DescribeStackResourceDriftsOutput", + "resultWrapper":"DescribeStackResourceDriftsResult" + }, + "documentation":"

Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all supported resources for a given stack.

" + }, + "DescribeStackResources":{ + "name":"DescribeStackResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackResourcesInput"}, + "output":{ + "shape":"DescribeStackResourcesOutput", + "resultWrapper":"DescribeStackResourcesResult" + }, + "documentation":"

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

" + }, + "DescribeStackSet":{ + "name":"DescribeStackSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackSetInput"}, + "output":{ + "shape":"DescribeStackSetOutput", + "resultWrapper":"DescribeStackSetResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"} + ], + "documentation":"

Returns the description of the specified stack set.

" + }, + "DescribeStackSetOperation":{ + "name":"DescribeStackSetOperation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackSetOperationInput"}, + "output":{ + "shape":"DescribeStackSetOperationOutput", + "resultWrapper":"DescribeStackSetOperationResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationNotFoundException"} + ], + "documentation":"

Returns the description of the specified stack set operation.

" + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStacksInput"}, + "output":{ + "shape":"DescribeStacksOutput", + "resultWrapper":"DescribeStacksResult" + }, + "documentation":"

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

If the stack does not exist, an AmazonCloudFormationException is returned.

" + }, + "DetectStackDrift":{ + "name":"DetectStackDrift", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectStackDriftInput"}, + "output":{ + "shape":"DetectStackDriftOutput", + "resultWrapper":"DetectStackDriftResult" + }, + "documentation":"

Detects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackDrift to detect drift on all supported resources for a given stack, or DetectStackResourceDrift to detect drift on individual resources.

For a list of stack resources that currently support drift detection, see Resources that Support Drift Detection.

DetectStackDrift can take up to several minutes, depending on the number of resources contained within the stack. Use DescribeStackDriftDetectionStatus to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use DescribeStackResourceDrifts to return drift information about the stack and its resources.

When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform DetectStackDrift directly on the nested stack itself.

" + }, + "DetectStackResourceDrift":{ + "name":"DetectStackResourceDrift", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectStackResourceDriftInput"}, + "output":{ + "shape":"DetectStackResourceDriftOutput", + "resultWrapper":"DetectStackResourceDriftResult" + }, + "documentation":"

Returns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

" + }, + "EstimateTemplateCost":{ + "name":"EstimateTemplateCost", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EstimateTemplateCostInput"}, + "output":{ + "shape":"EstimateTemplateCostOutput", + "resultWrapper":"EstimateTemplateCostResult" + }, + "documentation":"

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

" + }, + "ExecuteChangeSet":{ + "name":"ExecuteChangeSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecuteChangeSetInput"}, + "output":{ + "shape":"ExecuteChangeSetOutput", + "resultWrapper":"ExecuteChangeSetResult" + }, + "errors":[ + {"shape":"InvalidChangeSetStatusException"}, + {"shape":"ChangeSetNotFoundException"}, + {"shape":"InsufficientCapabilitiesException"}, + {"shape":"TokenAlreadyExistsException"} + ], + "documentation":"

Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.

When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.

If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.

" + }, + "GetStackPolicy":{ + "name":"GetStackPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetStackPolicyInput"}, + "output":{ + "shape":"GetStackPolicyOutput", + "resultWrapper":"GetStackPolicyResult" + }, + "documentation":"

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

" + }, + "GetTemplate":{ + "name":"GetTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTemplateInput"}, + "output":{ + "shape":"GetTemplateOutput", + "resultWrapper":"GetTemplateResult" + }, + "errors":[ + {"shape":"ChangeSetNotFoundException"} + ], + "documentation":"

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template does not exist, a ValidationError is returned.

" + }, + "GetTemplateSummary":{ + "name":"GetTemplateSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTemplateSummaryInput"}, + "output":{ + "shape":"GetTemplateSummaryOutput", + "resultWrapper":"GetTemplateSummaryResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"} + ], + "documentation":"

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

" + }, + "ListChangeSets":{ + "name":"ListChangeSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListChangeSetsInput"}, + "output":{ + "shape":"ListChangeSetsOutput", + "resultWrapper":"ListChangeSetsResult" + }, + "documentation":"

Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.

" + }, + "ListExports":{ + "name":"ListExports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExportsInput"}, + "output":{ + "shape":"ListExportsOutput", + "resultWrapper":"ListExportsResult" + }, + "documentation":"

Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the Fn::ImportValue function.

For more information, see AWS CloudFormation Export Stack Output Values.

" + }, + "ListImports":{ + "name":"ListImports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListImportsInput"}, + "output":{ + "shape":"ListImportsOutput", + "resultWrapper":"ListImportsResult" + }, + "documentation":"

Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see ListExports.

For more information about importing an exported output value, see the Fn::ImportValue function.

" + }, + "ListStackInstances":{ + "name":"ListStackInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackInstancesInput"}, + "output":{ + "shape":"ListStackInstancesOutput", + "resultWrapper":"ListStackInstancesResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"} + ], + "documentation":"

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.

" + }, + "ListStackResources":{ + "name":"ListStackResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackResourcesInput"}, + "output":{ + "shape":"ListStackResourcesOutput", + "resultWrapper":"ListStackResourcesResult" + }, + "documentation":"

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

" + }, + "ListStackSetOperationResults":{ + "name":"ListStackSetOperationResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackSetOperationResultsInput"}, + "output":{ + "shape":"ListStackSetOperationResultsOutput", + "resultWrapper":"ListStackSetOperationResultsResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationNotFoundException"} + ], + "documentation":"

Returns summary information about the results of a stack set operation.

" + }, + "ListStackSetOperations":{ + "name":"ListStackSetOperations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackSetOperationsInput"}, + "output":{ + "shape":"ListStackSetOperationsOutput", + "resultWrapper":"ListStackSetOperationsResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"} + ], + "documentation":"

Returns summary information about operations performed on a stack set.

" + }, + "ListStackSets":{ + "name":"ListStackSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackSetsInput"}, + "output":{ + "shape":"ListStackSetsOutput", + "resultWrapper":"ListStackSetsResult" + }, + "documentation":"

Returns summary information about stack sets that are associated with the user.

" + }, + "ListStacks":{ + "name":"ListStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStacksInput"}, + "output":{ + "shape":"ListStacksOutput", + "resultWrapper":"ListStacksResult" + }, + "documentation":"

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

" + }, + "SetStackPolicy":{ + "name":"SetStackPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetStackPolicyInput"}, + "documentation":"

Sets a stack policy for a specified stack.

" + }, + "SignalResource":{ + "name":"SignalResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SignalResourceInput"}, + "documentation":"

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

" + }, + "StopStackSetOperation":{ + "name":"StopStackSetOperation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStackSetOperationInput"}, + "output":{ + "shape":"StopStackSetOperationOutput", + "resultWrapper":"StopStackSetOperationResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationNotFoundException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Stops an in-progress operation on a stack set and its associated stack instances.

" + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackInput"}, + "output":{ + "shape":"UpdateStackOutput", + "resultWrapper":"UpdateStackResult" + }, + "errors":[ + {"shape":"InsufficientCapabilitiesException"}, + {"shape":"TokenAlreadyExistsException"} + ], + "documentation":"

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

" + }, + "UpdateStackInstances":{ + "name":"UpdateStackInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackInstancesInput"}, + "output":{ + "shape":"UpdateStackInstancesOutput", + "resultWrapper":"UpdateStackInstancesResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"StackInstanceNotFoundException"}, + {"shape":"OperationInProgressException"}, + {"shape":"OperationIdAlreadyExistsException"}, + {"shape":"StaleRequestException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region.

You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use CreateStackInstances.

During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.

You can only update the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

" + }, + "UpdateStackSet":{ + "name":"UpdateStackSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackSetInput"}, + "output":{ + "shape":"UpdateStackSetOutput", + "resultWrapper":"UpdateStackSetResult" + }, + "errors":[ + {"shape":"StackSetNotFoundException"}, + {"shape":"OperationInProgressException"}, + {"shape":"OperationIdAlreadyExistsException"}, + {"shape":"StaleRequestException"}, + {"shape":"InvalidOperationException"}, + {"shape":"StackInstanceNotFoundException"} + ], + "documentation":"

Updates the stack set, and associated stack instances in the specified accounts and regions.

Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent CreateStackInstances calls on the specified stack set use the updated stack set.

" + }, + "UpdateTerminationProtection":{ + "name":"UpdateTerminationProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTerminationProtectionInput"}, + "output":{ + "shape":"UpdateTerminationProtectionOutput", + "resultWrapper":"UpdateTerminationProtectionResult" + }, + "documentation":"

Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

" + }, + "ValidateTemplate":{ + "name":"ValidateTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ValidateTemplateInput"}, + "output":{ + "shape":"ValidateTemplateOutput", + "resultWrapper":"ValidateTemplateResult" + }, + "documentation":"

Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.

" + } + }, + "shapes":{ + "Account":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AccountGateResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"AccountGateStatus", + "documentation":"

The status of the account gate function.

  • SUCCEEDED: The account gate function has determined that the account and region passes any requirements for a stack set operation to occur. AWS CloudFormation proceeds with the stack operation in that account and region.

  • FAILED: The account gate function has determined that the account and region does not meet the requirements for a stack set operation to occur. AWS CloudFormation cancels the stack set operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.

  • SKIPPED: AWS CloudFormation has skipped calling the account gate function for this account and region, for one of the following reasons:

    • An account gate function has not been specified for the account and region. AWS CloudFormation proceeds with the stack set operation in this account and region.

    • The AWSCloudFormationStackSetExecutionRole of the stack set adminstration account lacks permissions to invoke the function. AWS CloudFormation proceeds with the stack set operation in this account and region.

    • Either no action is necessary, or no action is possible, on the stack. AWS CloudFormation skips the stack set operation in this account and region.

" + }, + "StatusReason":{ + "shape":"AccountGateStatusReason", + "documentation":"

The reason for the account gate status assigned to this account and region for the stack set operation.

" + } + }, + "documentation":"

Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.

For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns FAILED, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to FAILED.

For more information, see Configuring a target account gate.

" + }, + "AccountGateStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "FAILED", + "SKIPPED" + ] + }, + "AccountGateStatusReason":{"type":"string"}, + "AccountLimit":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LimitName", + "documentation":"

The name of the account limit.

" + }, + "Value":{ + "shape":"LimitValue", + "documentation":"

The value that is associated with the account limit name.

" + } + }, + "documentation":"

The AccountLimit data type. For more information about account limits, see AWS CloudFormation Limits in the AWS CloudFormation User Guide.

" + }, + "AccountLimitList":{ + "type":"list", + "member":{"shape":"AccountLimit"} + }, + "AccountList":{ + "type":"list", + "member":{"shape":"Account"} + }, + "AllowedValue":{"type":"string"}, + "AllowedValues":{ + "type":"list", + "member":{"shape":"AllowedValue"} + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource with the name requested already exists.

", + "error":{ + "code":"AlreadyExistsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Arn":{"type":"string"}, + "BoxedInteger":{ + "type":"integer", + "box":true + }, + "BoxedMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "CancelUpdateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this CancelUpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry CancelUpdateStack requests to ensure that AWS CloudFormation successfully received them.

" + } + }, + "documentation":"

The input for the CancelUpdateStack action.

" + }, + "Capabilities":{ + "type":"list", + "member":{"shape":"Capability"} + }, + "CapabilitiesReason":{"type":"string"}, + "Capability":{ + "type":"string", + "enum":[ + "CAPABILITY_IAM", + "CAPABILITY_NAMED_IAM", + "CAPABILITY_AUTO_EXPAND" + ] + }, + "CausingEntity":{"type":"string"}, + "Change":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ChangeType", + "documentation":"

The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.

" + }, + "ResourceChange":{ + "shape":"ResourceChange", + "documentation":"

A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.

" + } + }, + "documentation":"

The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.

" + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "Add", + "Modify", + "Remove" + ] + }, + "ChangeSetId":{ + "type":"string", + "min":1, + "pattern":"arn:[-a-zA-Z0-9:/]*" + }, + "ChangeSetName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z][-a-zA-Z0-9]*" + }, + "ChangeSetNameOrId":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[a-zA-Z][-a-zA-Z0-9]*|arn:[-a-zA-Z0-9:/]*" + }, + "ChangeSetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.

", + "error":{ + "code":"ChangeSetNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ChangeSetStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "DELETE_COMPLETE", + "FAILED" + ] + }, + "ChangeSetStatusReason":{"type":"string"}, + "ChangeSetSummaries":{ + "type":"list", + "member":{"shape":"ChangeSetSummary"} + }, + "ChangeSetSummary":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The ID of the stack with which the change set is associated.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name of the stack with which the change set is associated.

" + }, + "ChangeSetId":{ + "shape":"ChangeSetId", + "documentation":"

The ID of the change set.

" + }, + "ChangeSetName":{ + "shape":"ChangeSetName", + "documentation":"

The name of the change set.

" + }, + "ExecutionStatus":{ + "shape":"ExecutionStatus", + "documentation":"

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

" + }, + "Status":{ + "shape":"ChangeSetStatus", + "documentation":"

The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

" + }, + "StatusReason":{ + "shape":"ChangeSetStatusReason", + "documentation":"

A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The start time when the change set was created, in UTC.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Descriptive information about the change set.

" + } + }, + "documentation":"

The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.

" + }, + "ChangeSetType":{ + "type":"string", + "enum":[ + "CREATE", + "UPDATE" + ] + }, + "ChangeSource":{ + "type":"string", + "enum":[ + "ResourceReference", + "ParameterReference", + "ResourceAttribute", + "DirectModification", + "Automatic" + ] + }, + "ChangeType":{ + "type":"string", + "enum":["Resource"] + }, + "Changes":{ + "type":"list", + "member":{"shape":"Change"} + }, + "ClientRequestToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9][-a-zA-Z0-9]*" + }, + "ClientToken":{ + "type":"string", + "max":128, + "min":1 + }, + "ContinueUpdateRollbackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name or the unique ID of the stack that you want to continue rolling back.

Don't specify the name of a nested stack (a stack that was created by using the AWS::CloudFormation::Stack resource). Instead, use this operation on the parent stack (the stack that contains the AWS::CloudFormation::Stack resource).

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" + }, + "ResourcesToSkip":{ + "shape":"ResourcesToSkip", + "documentation":"

A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the UPDATE_FAILED state because a rollback failed. You can't specify resources that are in the UPDATE_FAILED state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the DescribeStackResources action, and view the resource status reason.

Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you troubleshoot resources before skipping them. AWS CloudFormation sets the status of the specified resources to UPDATE_COMPLETE and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable.

Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources.

To skip resources that are part of nested stacks, use the following format: NestedStackName.ResourceLogicalID. If you want to specify the logical ID of a stack resource (Type: AWS::CloudFormation::Stack) in the ResourcesToSkip list, then its corresponding embedded stack must be in one of the following states: DELETE_IN_PROGRESS, DELETE_COMPLETE, or DELETE_FAILED.

Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see Using ResourcesToSkip to recover a nested stacks hierarchy.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this ContinueUpdateRollback request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry ContinueUpdateRollback requests to ensure that AWS CloudFormation successfully received them.

" + } + }, + "documentation":"

The input for the ContinueUpdateRollback action.

" + }, + "ContinueUpdateRollbackOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for a ContinueUpdateRollback action.

" + }, + "CreateChangeSetInput":{ + "type":"structure", + "required":[ + "StackName", + "ChangeSetName" + ], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.

Conditional: You must specify only TemplateBody or TemplateURL.

" + }, + "UsePreviousTemplate":{ + "shape":"UsePreviousTemplate", + "documentation":"

Whether to reuse the template that is associated with the stack to create the change set.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.

    Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create or update the stack directly from the template using the CreateStack or UpdateStack action, and specifying this capability.

    For more information on macros, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

" + }, + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" + }, + "RollbackConfiguration":{ + "shape":"RollbackConfiguration", + "documentation":"

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 50 tags.

" + }, + "ChangeSetName":{ + "shape":"ChangeSetName", + "documentation":"

The name of the change set. The name must be unique among all change sets that are associated with the specified stack.

A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description to help you identify this change set.

" + }, + "ChangeSetType":{ + "shape":"ChangeSetType", + "documentation":"

The type of change set operation. To create a change set for a new stack, specify CREATE. To create a change set for an existing stack, specify UPDATE.

If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the REVIEW_IN_PROGRESS state until you execute the change set.

By default, AWS CloudFormation specifies UPDATE. You can't use the UPDATE type to create a change set for a new stack or the CREATE type to create a change set for an existing stack.

" + } + }, + "documentation":"

The input for the CreateChangeSet action.

" + }, + "CreateChangeSetOutput":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ChangeSetId", + "documentation":"

The Amazon Resource Name (ARN) of the change set.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

The unique ID of the stack.

" + } + }, + "documentation":"

The output for the CreateChangeSet action.

" + }, + "CreateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

" + }, + "DisableRollback":{ + "shape":"DisableRollback", + "documentation":"

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

Default: false

" + }, + "RollbackConfiguration":{ + "shape":"RollbackConfiguration", + "documentation":"

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

" + }, + "TimeoutInMinutes":{ + "shape":"TimeoutMinutes", + "documentation":"

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

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

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

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros and nested stacks, you must create the stack directly from the template using this capability.

    You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.

    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

" + }, + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

The template resource types that you have permissions to work with for this create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. Use the following syntax to describe template resource types: AWS::* (for all AWS resource), Custom::* (for all custom resources), Custom::logical_ID (for a specific custom resource), AWS::service_name::* (for all resources of a particular AWS service), and AWS::service_name::resource_logical_ID (for a specific AWS resource).

If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" + }, + "OnFailure":{ + "shape":"OnFailure", + "documentation":"

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

Default: ROLLBACK

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this CreateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry CreateStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + }, + "EnableTerminationProtection":{ + "shape":"EnableTerminationProtection", + "documentation":"

Whether to enable termination protection on the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide. Termination protection is disabled on stacks by default.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack.

" + } + }, + "documentation":"

The input for CreateStack action.

" + }, + "CreateStackInstancesInput":{ + "type":"structure", + "required":[ + "StackSetName", + "Accounts", + "Regions" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to create stack instances from.

" + }, + "Accounts":{ + "shape":"AccountList", + "documentation":"

The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.

" + }, + "Regions":{ + "shape":"RegionList", + "documentation":"

The names of one or more regions where you want to create stack instances using the specified AWS account(s).

" + }, + "ParameterOverrides":{ + "shape":"Parameters", + "documentation":"

A list of stack set parameters whose values you want to override in the selected stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template.

" + }, + "OperationPreferences":{ + "shape":"StackSetOperationPreferences", + "documentation":"

Preferences for how AWS CloudFormation performs this stack set operation.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

", + "idempotencyToken":true + } + } + }, + "CreateStackInstancesOutput":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

" + } + } + }, + "CreateStackOutput":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + } + }, + "documentation":"

The output for a CreateStack action.

" + }, + "CreateStackSetInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name to associate with the stack set. The name must be unique in the region where you create your stack set.

A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and can't be longer than 128 characters.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the stack set. You can use the description to identify the stack set's purpose or other important information.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

The input parameters for the stack set template.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.

If you specify tags as part of a CreateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you don't, the entire CreateStackSet action fails with an access denied error, and the stack set is not created.

" + }, + "AdministrationRoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Number (ARN) of the IAM role to use to create this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

" + }, + "ExecutionRoleName":{ + "shape":"ExecutionRoleName", + "documentation":"

The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this CreateStackSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry CreateStackSet requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

", + "idempotencyToken":true + } + } + }, + "CreateStackSetOutput":{ + "type":"structure", + "members":{ + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The ID of the stack set that you're creating.

" + } + } + }, + "CreatedButModifiedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource exists, but has been changed.

", + "error":{ + "code":"CreatedButModifiedException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreationTime":{"type":"timestamp"}, + "DeleteChangeSetInput":{ + "type":"structure", + "required":["ChangeSetName"], + "members":{ + "ChangeSetName":{ + "shape":"ChangeSetNameOrId", + "documentation":"

The name or Amazon Resource Name (ARN) of the change set that you want to delete.

" + }, + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.

" + } + }, + "documentation":"

The input for the DeleteChangeSet action.

" + }, + "DeleteChangeSetOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteChangeSet action.

" + }, + "DeleteStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack.

" + }, + "RetainResources":{ + "shape":"RetainResources", + "documentation":"

For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.

Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this DeleteStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry DeleteStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + } + }, + "documentation":"

The input for DeleteStack action.

" + }, + "DeleteStackInstancesInput":{ + "type":"structure", + "required":[ + "StackSetName", + "Accounts", + "Regions", + "RetainStacks" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to delete stack instances for.

" + }, + "Accounts":{ + "shape":"AccountList", + "documentation":"

The names of the AWS accounts that you want to delete stack instances for.

" + }, + "Regions":{ + "shape":"RegionList", + "documentation":"

The regions where you want to delete stack set instances.

" + }, + "OperationPreferences":{ + "shape":"StackSetOperationPreferences", + "documentation":"

Preferences for how AWS CloudFormation performs this stack set operation.

" + }, + "RetainStacks":{ + "shape":"RetainStacks", + "documentation":"

Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.

For more information, see Stack set operation options.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

If you don't specify an operation ID, the SDK generates one automatically.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

", + "idempotencyToken":true + } + } + }, + "DeleteStackInstancesOutput":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

" + } + } + }, + "DeleteStackSetInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you're deleting. You can obtain this value by running ListStackSets.

" + } + } + }, + "DeleteStackSetOutput":{ + "type":"structure", + "members":{ + } + }, + "DeletionTime":{"type":"timestamp"}, + "DescribeAccountLimitsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of limits that you want to retrieve.

" + } + }, + "documentation":"

The input for the DescribeAccountLimits action.

" + }, + "DescribeAccountLimitsOutput":{ + "type":"structure", + "members":{ + "AccountLimits":{ + "shape":"AccountLimitList", + "documentation":"

An account limit structure that contain a list of AWS CloudFormation account limits and their values.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.

" + } + }, + "documentation":"

The output for the DescribeAccountLimits action.

" + }, + "DescribeChangeSetInput":{ + "type":"structure", + "required":["ChangeSetName"], + "members":{ + "ChangeSetName":{ + "shape":"ChangeSetNameOrId", + "documentation":"

The name or Amazon Resource Name (ARN) of the change set that you want to describe.

" + }, + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

" + } + }, + "documentation":"

The input for the DescribeChangeSet action.

" + }, + "DescribeChangeSetOutput":{ + "type":"structure", + "members":{ + "ChangeSetName":{ + "shape":"ChangeSetName", + "documentation":"

The name of the change set.

" + }, + "ChangeSetId":{ + "shape":"ChangeSetId", + "documentation":"

The ARN of the change set.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

The ARN of the stack that is associated with the change set.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name of the stack that is associated with the change set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Information about the change set.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The start time when the change set was created, in UTC.

" + }, + "ExecutionStatus":{ + "shape":"ExecutionStatus", + "documentation":"

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

" + }, + "Status":{ + "shape":"ChangeSetStatus", + "documentation":"

The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.

" + }, + "StatusReason":{ + "shape":"ChangeSetStatusReason", + "documentation":"

A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.

" + }, + "RollbackConfiguration":{ + "shape":"RollbackConfiguration", + "documentation":"

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

If you execute the change set, the tags that will be associated with the stack.

" + }, + "Changes":{ + "shape":"Changes", + "documentation":"

A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.

" + } + }, + "documentation":"

The output for the DescribeChangeSet action.

" + }, + "DescribeStackDriftDetectionStatusInput":{ + "type":"structure", + "required":["StackDriftDetectionId"], + "members":{ + "StackDriftDetectionId":{ + "shape":"StackDriftDetectionId", + "documentation":"

The ID of the drift detection results of this operation.

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.

" + } + } + }, + "DescribeStackDriftDetectionStatusOutput":{ + "type":"structure", + "required":[ + "StackId", + "StackDriftDetectionId", + "DetectionStatus", + "Timestamp" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The ID of the stack.

" + }, + "StackDriftDetectionId":{ + "shape":"StackDriftDetectionId", + "documentation":"

The ID of the drift detection results of this operation.

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.

" + }, + "StackDriftStatus":{ + "shape":"StackDriftStatus", + "documentation":"

Status of the stack's actual configuration compared to its expected configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

" + }, + "DetectionStatus":{ + "shape":"StackDriftDetectionStatus", + "documentation":"

The status of the stack drift detection operation.

  • DETECTION_COMPLETE: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)

    If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.

  • DETECTION_FAILED: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.

  • DETECTION_IN_PROGRESS: The stack drift detection operation is currently in progress.

" + }, + "DetectionStatusReason":{ + "shape":"StackDriftDetectionStatusReason", + "documentation":"

The reason the stack drift detection operation has its current status.

" + }, + "DriftedStackResourceCount":{ + "shape":"BoxedInteger", + "documentation":"

Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of DETECTION_COMPLETE. This value will be 0 for stacks whose drift status is IN_SYNC.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time at which the stack drift detection operation was initiated.

" + } + } + }, + "DescribeStackEventsInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of events that you want to retrieve.

" + } + }, + "documentation":"

The input for DescribeStackEvents action.

" + }, + "DescribeStackEventsOutput":{ + "type":"structure", + "members":{ + "StackEvents":{ + "shape":"StackEvents", + "documentation":"

A list of StackEvents structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.

" + } + }, + "documentation":"

The output for a DescribeStackEvents action.

" + }, + "DescribeStackInstanceInput":{ + "type":"structure", + "required":[ + "StackSetName", + "StackInstanceAccount", + "StackInstanceRegion" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or the unique stack ID of the stack set that you want to get stack instance information for.

" + }, + "StackInstanceAccount":{ + "shape":"Account", + "documentation":"

The ID of an AWS account that's associated with this stack instance.

" + }, + "StackInstanceRegion":{ + "shape":"Region", + "documentation":"

The name of a region that's associated with this stack instance.

" + } + } + }, + "DescribeStackInstanceOutput":{ + "type":"structure", + "members":{ + "StackInstance":{ + "shape":"StackInstance", + "documentation":"

The stack instance that matches the specified request parameters.

" + } + } + }, + "DescribeStackResourceDriftsInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name of the stack for which you want drift information.

" + }, + "StackResourceDriftStatusFilters":{ + "shape":"StackResourceDriftStatusFilters", + "documentation":"

The resource drift status values to use as filters for the resource drift results returned.

  • DELETED: The resource differs from its expected template configuration in that the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected template values.

  • IN_SYNC: The resources's actual configuration matches its expected template configuration.

  • NOT_CHECKED: AWS CloudFormation does not currently return this value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of stack resource drift results.

" + }, + "MaxResults":{ + "shape":"BoxedMaxResults", + "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + } + } + }, + "DescribeStackResourceDriftsOutput":{ + "type":"structure", + "required":["StackResourceDrifts"], + "members":{ + "StackResourceDrifts":{ + "shape":"StackResourceDrifts", + "documentation":"

Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects drift.

For a given stack, there will be one StackResourceDrift for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see Resources that Support Drift Detection.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call DescribeStackResourceDrifts again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" + } + } + }, + "DescribeStackResourceInput":{ + "type":"structure", + "required":[ + "StackName", + "LogicalResourceId" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource as specified in the template.

Default: There is no default value.

" + } + }, + "documentation":"

The input for DescribeStackResource action.

" + }, + "DescribeStackResourceOutput":{ + "type":"structure", + "members":{ + "StackResourceDetail":{ + "shape":"StackResourceDetail", + "documentation":"

A StackResourceDetail structure containing the description of the specified resource in the specified stack.

" + } + }, + "documentation":"

The output for a DescribeStackResource action.

" + }, + "DescribeStackResourcesInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource as specified in the template.

Default: There is no default value.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

" + } + }, + "documentation":"

The input for DescribeStackResources action.

" + }, + "DescribeStackResourcesOutput":{ + "type":"structure", + "members":{ + "StackResources":{ + "shape":"StackResources", + "documentation":"

A list of StackResource structures.

" + } + }, + "documentation":"

The output for a DescribeStackResources action.

" + }, + "DescribeStackSetInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set whose description you want.

" + } + } + }, + "DescribeStackSetOperationInput":{ + "type":"structure", + "required":[ + "StackSetName", + "OperationId" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or the unique stack ID of the stack set for the stack operation.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique ID of the stack set operation.

" + } + } + }, + "DescribeStackSetOperationOutput":{ + "type":"structure", + "members":{ + "StackSetOperation":{ + "shape":"StackSetOperation", + "documentation":"

The specified stack set operation.

" + } + } + }, + "DescribeStackSetOutput":{ + "type":"structure", + "members":{ + "StackSet":{ + "shape":"StackSet", + "documentation":"

The specified stack set.

" + } + } + }, + "DescribeStacksInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of stacks that you want to retrieve.

" + } + }, + "documentation":"

The input for DescribeStacks action.

" + }, + "DescribeStacksOutput":{ + "type":"structure", + "members":{ + "Stacks":{ + "shape":"Stacks", + "documentation":"

A list of stack structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

" + } + }, + "documentation":"

The output for a DescribeStacks action.

" + }, + "Description":{ + "type":"string", + "max":1024, + "min":1 + }, + "DetectStackDriftInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name of the stack for which you want to detect drift.

" + }, + "LogicalResourceIds":{ + "shape":"LogicalResourceIds", + "documentation":"

The logical names of any resources you want to use as filters.

" + } + } + }, + "DetectStackDriftOutput":{ + "type":"structure", + "required":["StackDriftDetectionId"], + "members":{ + "StackDriftDetectionId":{ + "shape":"StackDriftDetectionId", + "documentation":"

The ID of the drift detection results of this operation.

AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary.

" + } + } + }, + "DetectStackResourceDriftInput":{ + "type":"structure", + "required":[ + "StackName", + "LogicalResourceId" + ], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name of the stack to which the resource belongs.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource for which to return drift information.

" + } + } + }, + "DetectStackResourceDriftOutput":{ + "type":"structure", + "required":["StackResourceDrift"], + "members":{ + "StackResourceDrift":{ + "shape":"StackResourceDrift", + "documentation":"

Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.

" + } + } + }, + "DifferenceType":{ + "type":"string", + "enum":[ + "ADD", + "REMOVE", + "NOT_EQUAL" + ] + }, + "DisableRollback":{"type":"boolean"}, + "EnableTerminationProtection":{"type":"boolean"}, + "EstimateTemplateCostInput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

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

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters.

" + } + }, + "documentation":"

The input for an EstimateTemplateCost action.

" + }, + "EstimateTemplateCostOutput":{ + "type":"structure", + "members":{ + "Url":{ + "shape":"Url", + "documentation":"

An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

" + } + }, + "documentation":"

The output for a EstimateTemplateCost action.

" + }, + "EvaluationType":{ + "type":"string", + "enum":[ + "Static", + "Dynamic" + ] + }, + "EventId":{"type":"string"}, + "ExecuteChangeSetInput":{ + "type":"structure", + "required":["ChangeSetName"], + "members":{ + "ChangeSetName":{ + "shape":"ChangeSetNameOrId", + "documentation":"

The name or ARN of the change set that you want use to update the specified stack.

" + }, + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this ExecuteChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry ExecuteChangeSet requests to ensure that AWS CloudFormation successfully received them.

" + } + }, + "documentation":"

The input for the ExecuteChangeSet action.

" + }, + "ExecuteChangeSetOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the ExecuteChangeSet action.

" + }, + "ExecutionRoleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z_0-9+=,.@-]+" + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "UNAVAILABLE", + "AVAILABLE", + "EXECUTE_IN_PROGRESS", + "EXECUTE_COMPLETE", + "EXECUTE_FAILED", + "OBSOLETE" + ] + }, + "Export":{ + "type":"structure", + "members":{ + "ExportingStackId":{ + "shape":"StackId", + "documentation":"

The stack that contains the exported output name and value.

" + }, + "Name":{ + "shape":"ExportName", + "documentation":"

The name of exported output value. Use this name and the Fn::ImportValue function to import the associated value into other stacks. The name is defined in the Export field in the associated stack's Outputs section.

" + }, + "Value":{ + "shape":"ExportValue", + "documentation":"

The value of the exported output, such as a resource physical ID. This value is defined in the Export field in the associated stack's Outputs section.

" + } + }, + "documentation":"

The Export structure describes the exported output values for a stack.

" + }, + "ExportName":{"type":"string"}, + "ExportValue":{"type":"string"}, + "Exports":{ + "type":"list", + "member":{"shape":"Export"} + }, + "FailureToleranceCount":{ + "type":"integer", + "min":0 + }, + "FailureTolerancePercentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "GetStackPolicyInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or unique stack ID that is associated with the stack whose policy you want to get.

" + } + }, + "documentation":"

The input for the GetStackPolicy action.

" + }, + "GetStackPolicyOutput":{ + "type":"structure", + "members":{ + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)

" + } + }, + "documentation":"

The output for the GetStackPolicy action.

" + }, + "GetTemplateInput":{ + "type":"structure", + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" + }, + "ChangeSetName":{ + "shape":"ChangeSetNameOrId", + "documentation":"

The name or Amazon Resource Name (ARN) of a change set for which AWS CloudFormation returns the associated template. If you specify a name, you must also specify the StackName.

" + }, + "TemplateStage":{ + "shape":"TemplateStage", + "documentation":"

For templates that include transforms, the stage of the template that AWS CloudFormation returns. To get the user-submitted template, specify Original. To get the template after AWS CloudFormation has processed all transforms, specify Processed.

If the template doesn't include transforms, Original and Processed return the same template. By default, AWS CloudFormation specifies Original.

" + } + }, + "documentation":"

The input for a GetTemplate action.

" + }, + "GetTemplateOutput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

AWS CloudFormation returns the same template that was used when the stack was created.

" + }, + "StagesAvailable":{ + "shape":"StageList", + "documentation":"

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After AWS CloudFormation finishes creating the change set, the Processed template becomes available.

" + } + }, + "documentation":"

The output for GetTemplate action.

" + }, + "GetTemplateSummaryInput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

" + }, + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

" + }, + "StackSetName":{ + "shape":"StackSetNameOrId", + "documentation":"

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

" + } + }, + "documentation":"

The input for the GetTemplateSummary action.

" + }, + "GetTemplateSummaryOutput":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParameterDeclarations", + "documentation":"

A list of parameter declarations that describe various properties for each parameter.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The value that is defined in the Description property of the template.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" + }, + "CapabilitiesReason":{ + "shape":"CapabilitiesReason", + "documentation":"

The list of resources that generated the values in the Capabilities response element.

" + }, + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

" + }, + "Version":{ + "shape":"Version", + "documentation":"

The AWS template format version, which identifies the capabilities of the template.

" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

The value that is defined for the Metadata property of the template.

" + }, + "DeclaredTransforms":{ + "shape":"TransformsList", + "documentation":"

A list of the transforms that are declared in the template.

" + } + }, + "documentation":"

The output for the GetTemplateSummary action.

" + }, + "Imports":{ + "type":"list", + "member":{"shape":"StackName"} + }, + "InsufficientCapabilitiesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The template contains resources with capabilities that weren't specified in the Capabilities parameter.

", + "error":{ + "code":"InsufficientCapabilitiesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidChangeSetStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified change set can't be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS, or the stack status might be UPDATE_IN_PROGRESS.

", + "error":{ + "code":"InvalidChangeSetStatus", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified operation isn't valid.

", + "error":{ + "code":"InvalidOperationException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Key":{"type":"string"}, + "LastUpdatedTime":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The quota for the resource has already been reached.

For information on resource and stack limitations, see Limits in the AWS CloudFormation User Guide.

", + "error":{ + "code":"LimitExceededException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitName":{"type":"string"}, + "LimitValue":{"type":"integer"}, + "ListChangeSetsInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

" + } + }, + "documentation":"

The input for the ListChangeSets action.

" + }, + "ListChangeSetsOutput":{ + "type":"structure", + "members":{ + "Summaries":{ + "shape":"ChangeSetSummaries", + "documentation":"

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.

" + } + }, + "documentation":"

The output for the ListChangeSets action.

" + }, + "ListExportsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string (provided by the ListExports response output) that identifies the next page of exported output values that you asked to retrieve.

" + } + } + }, + "ListExportsOutput":{ + "type":"structure", + "members":{ + "Exports":{ + "shape":"Exports", + "documentation":"

The output for the ListExports action.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 100 exported output values, a string that identifies the next page of exports. If there is no additional page, this value is null.

" + } + } + }, + "ListImportsInput":{ + "type":"structure", + "required":["ExportName"], + "members":{ + "ExportName":{ + "shape":"ExportName", + "documentation":"

The name of the exported output value. AWS CloudFormation returns the stack names that are importing this value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string (provided by the ListImports response output) that identifies the next page of stacks that are importing the specified exported output value.

" + } + } + }, + "ListImportsOutput":{ + "type":"structure", + "members":{ + "Imports":{ + "shape":"Imports", + "documentation":"

A list of stack names that are importing the specified exported output value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of exports. If there is no additional page, this value is null.

" + } + } + }, + "ListStackInstancesInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to list stack instances for.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the previous request didn't return all of the remaining results, the response's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + }, + "StackInstanceAccount":{ + "shape":"Account", + "documentation":"

The name of the AWS account that you want to list stack instances for.

" + }, + "StackInstanceRegion":{ + "shape":"Region", + "documentation":"

The name of the region where you want to list stack instances.

" + } + } + }, + "ListStackInstancesOutput":{ + "type":"structure", + "members":{ + "Summaries":{ + "shape":"StackInstanceSummaries", + "documentation":"

A list of StackInstanceSummary structures that contain information about the specified stack instances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" + } + } + }, + "ListStackResourcesInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of stack resources that you want to retrieve.

" + } + }, + "documentation":"

The input for the ListStackResource action.

" + }, + "ListStackResourcesOutput":{ + "type":"structure", + "members":{ + "StackResourceSummaries":{ + "shape":"StackResourceSummaries", + "documentation":"

A list of StackResourceSummary structures.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.

" + } + }, + "documentation":"

The output for a ListStackResources action.

" + }, + "ListStackSetOperationResultsInput":{ + "type":"structure", + "required":[ + "StackSetName", + "OperationId" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to get operation results for.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The ID of the stack set operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the previous request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + } + } + }, + "ListStackSetOperationResultsOutput":{ + "type":"structure", + "members":{ + "Summaries":{ + "shape":"StackSetOperationResultSummaries", + "documentation":"

A list of StackSetOperationResultSummary structures that contain information about the specified operation results, for accounts and regions that are included in the operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

" + } + } + }, + "ListStackSetOperationsInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to get operation summaries for.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSetOperations again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + } + } + }, + "ListStackSetOperationsOutput":{ + "type":"structure", + "members":{ + "Summaries":{ + "shape":"StackSetOperationSummaries", + "documentation":"

A list of StackSetOperationSummary structures that contain summary information about operations for the specified stack set.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the request doesn't return all results, NextToken is set to a token. To retrieve the next set of results, call ListOperationResults again and assign that token to the request object's NextToken parameter. If there are no remaining results, NextToken is set to null.

" + } + } + }, + "ListStackSetsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call ListStackSets again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + }, + "Status":{ + "shape":"StackSetStatus", + "documentation":"

The status of the stack sets that you want to get summary information about.

" + } + } + }, + "ListStackSetsOutput":{ + "type":"structure", + "members":{ + "Summaries":{ + "shape":"StackSetSummaries", + "documentation":"

A list of StackSetSummary structures that contain information about the user's stack sets.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the request doesn't return all of the remaining results, NextToken is set to a token. To retrieve the next set of results, call ListStackInstances again and assign that token to the request object's NextToken parameter. If the request returns all results, NextToken is set to null.

" + } + } + }, + "ListStacksInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A string that identifies the next page of stacks that you want to retrieve.

" + }, + "StackStatusFilter":{ + "shape":"StackStatusFilter", + "documentation":"

Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the StackStatus parameter of the Stack data type.

" + } + }, + "documentation":"

The input for ListStacks action.

" + }, + "ListStacksOutput":{ + "type":"structure", + "members":{ + "StackSummaries":{ + "shape":"StackSummaries", + "documentation":"

A list of StackSummary structures containing information about the specified stacks.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.

" + } + }, + "documentation":"

The output for ListStacks action.

" + }, + "LogicalResourceId":{"type":"string"}, + "LogicalResourceIds":{ + "type":"list", + "member":{"shape":"LogicalResourceId"}, + "max":200, + "min":1 + }, + "MaxConcurrentCount":{ + "type":"integer", + "min":1 + }, + "MaxConcurrentPercentage":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Metadata":{"type":"string"}, + "MonitoringTimeInMinutes":{ + "type":"integer", + "max":180, + "min":0 + }, + "NameAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified name is already in use.

", + "error":{ + "code":"NameAlreadyExistsException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "NoEcho":{"type":"boolean"}, + "NotificationARN":{"type":"string"}, + "NotificationARNs":{ + "type":"list", + "member":{"shape":"NotificationARN"}, + "max":5 + }, + "OnFailure":{ + "type":"string", + "enum":[ + "DO_NOTHING", + "ROLLBACK", + "DELETE" + ] + }, + "OperationIdAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified operation ID already exists.

", + "error":{ + "code":"OperationIdAlreadyExistsException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "OperationInProgressException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Another operation is currently in progress for this stack set. Only one operation can be performed for a stack set at a given time.

", + "error":{ + "code":"OperationInProgressException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "OperationNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified ID refers to an operation that doesn't exist.

", + "error":{ + "code":"OperationNotFoundException", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Output":{ + "type":"structure", + "members":{ + "OutputKey":{ + "shape":"OutputKey", + "documentation":"

The key associated with the output.

" + }, + "OutputValue":{ + "shape":"OutputValue", + "documentation":"

The value associated with the output.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the output.

" + }, + "ExportName":{ + "shape":"ExportName", + "documentation":"

The name of the export associated with the output.

" + } + }, + "documentation":"

The Output data type.

" + }, + "OutputKey":{"type":"string"}, + "OutputValue":{"type":"string"}, + "Outputs":{ + "type":"list", + "member":{"shape":"Output"} + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

" + }, + "ParameterValue":{ + "shape":"ParameterValue", + "documentation":"

The input value associated with the parameter.

" + }, + "UsePreviousValue":{ + "shape":"UsePreviousValue", + "documentation":"

During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

" + }, + "ResolvedValue":{ + "shape":"ParameterValue", + "documentation":"

Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for SSM parameter types in the template.

" + } + }, + "documentation":"

The Parameter data type.

" + }, + "ParameterConstraints":{ + "type":"structure", + "members":{ + "AllowedValues":{ + "shape":"AllowedValues", + "documentation":"

A list of values that are permitted for a parameter.

" + } + }, + "documentation":"

A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.

" + }, + "ParameterDeclaration":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

The name that is associated with the parameter.

" + }, + "DefaultValue":{ + "shape":"ParameterValue", + "documentation":"

The default value of the parameter.

" + }, + "ParameterType":{ + "shape":"ParameterType", + "documentation":"

The type of parameter.

" + }, + "NoEcho":{ + "shape":"NoEcho", + "documentation":"

Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description that is associate with the parameter.

" + }, + "ParameterConstraints":{ + "shape":"ParameterConstraints", + "documentation":"

The criteria that AWS CloudFormation uses to validate parameter values.

" + } + }, + "documentation":"

The ParameterDeclaration data type.

" + }, + "ParameterDeclarations":{ + "type":"list", + "member":{"shape":"ParameterDeclaration"} + }, + "ParameterKey":{"type":"string"}, + "ParameterType":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "Parameters":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "PhysicalResourceId":{"type":"string"}, + "PhysicalResourceIdContext":{ + "type":"list", + "member":{"shape":"PhysicalResourceIdContextKeyValuePair"}, + "max":5 + }, + "PhysicalResourceIdContextKeyValuePair":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The resource context key.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The resource context value.

" + } + }, + "documentation":"

Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.

" + }, + "Properties":{"type":"string"}, + "PropertyDifference":{ + "type":"structure", + "required":[ + "PropertyPath", + "ExpectedValue", + "ActualValue", + "DifferenceType" + ], + "members":{ + "PropertyPath":{ + "shape":"PropertyPath", + "documentation":"

The fully-qualified path to the resource property.

" + }, + "ExpectedValue":{ + "shape":"PropertyValue", + "documentation":"

The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.

" + }, + "ActualValue":{ + "shape":"PropertyValue", + "documentation":"

The actual property value of the resource property.

" + }, + "DifferenceType":{ + "shape":"DifferenceType", + "documentation":"

The type of property difference.

  • ADD: A value has been added to a resource property that is an array or list data type.

  • REMOVE: The property has been removed from the current resource configuration.

  • NOT_EQUAL: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).

" + } + }, + "documentation":"

Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose StackResourceDriftStatus is MODIFIED. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + }, + "PropertyDifferences":{ + "type":"list", + "member":{"shape":"PropertyDifference"} + }, + "PropertyName":{"type":"string"}, + "PropertyPath":{"type":"string"}, + "PropertyValue":{"type":"string"}, + "Reason":{"type":"string"}, + "Region":{"type":"string"}, + "RegionList":{ + "type":"list", + "member":{"shape":"Region"} + }, + "Replacement":{ + "type":"string", + "enum":[ + "True", + "False", + "Conditional" + ] + }, + "RequiresRecreation":{ + "type":"string", + "enum":[ + "Never", + "Conditionally", + "Always" + ] + }, + "ResourceAttribute":{ + "type":"string", + "enum":[ + "Properties", + "Metadata", + "CreationPolicy", + "UpdatePolicy", + "DeletionPolicy", + "Tags" + ] + }, + "ResourceChange":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The resource's logical ID, which is defined in the stack's template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.

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

The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

" + }, + "Replacement":{ + "shape":"Replacement", + "documentation":"

For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.

If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.

" + }, + "Scope":{ + "shape":"Scope", + "documentation":"

For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

" + }, + "Details":{ + "shape":"ResourceChangeDetails", + "documentation":"

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.

" + } + }, + "documentation":"

The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.

" + }, + "ResourceChangeDetail":{ + "type":"structure", + "members":{ + "Target":{ + "shape":"ResourceTargetDefinition", + "documentation":"

A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.

" + }, + "Evaluation":{ + "shape":"EvaluationType", + "documentation":"

Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.

For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.

For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.

" + }, + "ChangeSource":{ + "shape":"ChangeSource", + "documentation":"

The group to which the CausingEntity value belongs. There are five entity groups:

  • ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { \"Ref\" : \"MyEC2InstanceResource\" }.

  • ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { \"Ref\" : \"MyPasswordParameter\" }.

  • ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { \"Fn::GetAtt\" : [ \"MyEC2InstanceResource\", \"PublicDnsName\" ] }.

  • DirectModification entities are changes that are made directly to the template.

  • Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.

" + }, + "CausingEntity":{ + "shape":"CausingEntity", + "documentation":"

The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).

If the ChangeSource value is DirectModification, no value is given for CausingEntity.

" + } + }, + "documentation":"

For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.

" + }, + "ResourceChangeDetails":{ + "type":"list", + "member":{"shape":"ResourceChangeDetail"} + }, + "ResourceProperties":{"type":"string"}, + "ResourceSignalStatus":{ + "type":"string", + "enum":[ + "SUCCESS", + "FAILURE" + ] + }, + "ResourceSignalUniqueId":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATE_COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETE_COMPLETE", + "DELETE_SKIPPED", + "UPDATE_IN_PROGRESS", + "UPDATE_FAILED", + "UPDATE_COMPLETE" + ] + }, + "ResourceStatusReason":{"type":"string"}, + "ResourceTargetDefinition":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"ResourceAttribute", + "documentation":"

Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.

" + }, + "Name":{ + "shape":"PropertyName", + "documentation":"

If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.

" + }, + "RequiresRecreation":{ + "shape":"RequiresRecreation", + "documentation":"

If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.

" + } + }, + "documentation":"

The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.

" + }, + "ResourceToSkip":{ + "type":"string", + "pattern":"[a-zA-Z0-9]+|[a-zA-Z][-a-zA-Z0-9]*\\.[a-zA-Z0-9]+" + }, + "ResourceType":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceTypes":{ + "type":"list", + "member":{"shape":"ResourceType"} + }, + "ResourcesToSkip":{ + "type":"list", + "member":{"shape":"ResourceToSkip"} + }, + "RetainResources":{ + "type":"list", + "member":{"shape":"LogicalResourceId"} + }, + "RetainStacks":{"type":"boolean"}, + "RetainStacksNullable":{"type":"boolean"}, + "RoleARN":{ + "type":"string", + "max":2048, + "min":20 + }, + "RollbackConfiguration":{ + "type":"structure", + "members":{ + "RollbackTriggers":{ + "shape":"RollbackTriggers", + "documentation":"

The triggers to monitor during stack creation or update actions.

By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:

  • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.

  • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.

  • To remove all currently specified triggers, specify an empty list for this parameter.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

" + }, + "MonitoringTimeInMinutes":{ + "shape":"MonitoringTimeInMinutes", + "documentation":"

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

" + } + }, + "documentation":"

Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations.

" + }, + "RollbackTrigger":{ + "type":"structure", + "required":[ + "Arn", + "Type" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the rollback trigger.

If a specified trigger is missing, the entire stack operation fails and is rolled back.

" + }, + "Type":{ + "shape":"Type", + "documentation":"

The resource type of the rollback trigger. Currently, AWS::CloudWatch::Alarm is the only supported resource type.

" + } + }, + "documentation":"

A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

" + }, + "RollbackTriggers":{ + "type":"list", + "member":{"shape":"RollbackTrigger"}, + "max":5 + }, + "Scope":{ + "type":"list", + "member":{"shape":"ResourceAttribute"} + }, + "SetStackPolicyInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or unique stack ID that you want to associate a policy with.

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing the stack policy body. For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

" + } + }, + "documentation":"

The input for the SetStackPolicy action.

" + }, + "SignalResourceInput":{ + "type":"structure", + "required":[ + "StackName", + "LogicalResourceId", + "UniqueId", + "Status" + ], + "members":{ + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The stack name or unique stack ID that includes the resource that you want to signal.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

" + }, + "UniqueId":{ + "shape":"ResourceSignalUniqueId", + "documentation":"

A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

" + }, + "Status":{ + "shape":"ResourceSignalStatus", + "documentation":"

The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

" + } + }, + "documentation":"

The input for the SignalResource action.

" + }, + "Stack":{ + "type":"structure", + "required":[ + "StackName", + "CreationTime", + "StackStatus" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "ChangeSetId":{ + "shape":"ChangeSetId", + "documentation":"

The unique ID of the change set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A user-defined description associated with the stack.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The time at which the stack was created.

" + }, + "DeletionTime":{ + "shape":"DeletionTime", + "documentation":"

The time the stack was deleted.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

" + }, + "RollbackConfiguration":{ + "shape":"RollbackConfiguration", + "documentation":"

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

" + }, + "StackStatus":{ + "shape":"StackStatus", + "documentation":"

Current status of the stack.

" + }, + "StackStatusReason":{ + "shape":"StackStatusReason", + "documentation":"

Success/failure message associated with the stack status.

" + }, + "DisableRollback":{ + "shape":"DisableRollback", + "documentation":"

Boolean to enable or disable rollback on stack creation failures:

  • true: disable rollback

  • false: enable rollback

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

SNS topic ARNs to which stack related events are published.

" + }, + "TimeoutInMinutes":{ + "shape":"TimeoutMinutes", + "documentation":"

The amount of time within which stack creation should complete.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities allowed in the stack.

" + }, + "Outputs":{ + "shape":"Outputs", + "documentation":"

A list of output structures.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of Tags that specify information about the stack.

" + }, + "EnableTerminationProtection":{ + "shape":"EnableTerminationProtection", + "documentation":"

Whether termination protection is enabled for the stack.

For nested stacks, termination protection is set on the root stack and cannot be changed directly on the nested stack. For more information, see Protecting a Stack From Being Deleted in the AWS CloudFormation User Guide.

" + }, + "ParentId":{ + "shape":"StackId", + "documentation":"

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

" + }, + "RootId":{ + "shape":"StackId", + "documentation":"

For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

" + }, + "DriftInformation":{ + "shape":"StackDriftInformation", + "documentation":"

Information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + } + }, + "documentation":"

The Stack data type.

" + }, + "StackDriftDetectionId":{ + "type":"string", + "max":36, + "min":1 + }, + "StackDriftDetectionStatus":{ + "type":"string", + "enum":[ + "DETECTION_IN_PROGRESS", + "DETECTION_FAILED", + "DETECTION_COMPLETE" + ] + }, + "StackDriftDetectionStatusReason":{"type":"string"}, + "StackDriftInformation":{ + "type":"structure", + "required":["StackDriftStatus"], + "members":{ + "StackDriftStatus":{ + "shape":"StackDriftStatus", + "documentation":"

Status of the stack's actual configuration compared to its expected template configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

" + }, + "LastCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

" + } + }, + "documentation":"

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

" + }, + "StackDriftInformationSummary":{ + "type":"structure", + "required":["StackDriftStatus"], + "members":{ + "StackDriftStatus":{ + "shape":"StackDriftStatus", + "documentation":"

Status of the stack's actual configuration compared to its expected template configuration.

  • DRIFTED: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.

  • NOT_CHECKED: AWS CloudFormation has not checked if the stack differs from its expected template configuration.

  • IN_SYNC: The stack's actual configuration matches its expected template configuration.

  • UNKNOWN: This value is reserved for future use.

" + }, + "LastCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"

Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.

" + } + }, + "documentation":"

Contains information about whether the stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.

" + }, + "StackDriftStatus":{ + "type":"string", + "enum":[ + "DRIFTED", + "IN_SYNC", + "UNKNOWN", + "NOT_CHECKED" + ] + }, + "StackEvent":{ + "type":"structure", + "required":[ + "StackId", + "EventId", + "StackName", + "Timestamp" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The unique ID name of the instance of the stack.

" + }, + "EventId":{ + "shape":"EventId", + "documentation":"

The unique ID of this event.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with a stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier associated with the physical instance of the resource.

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

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "ResourceProperties":{ + "shape":"ResourceProperties", + "documentation":"

BLOB of the properties used to create the resource.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The token passed to the operation that generated this event.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + } + }, + "documentation":"

The StackEvent data type.

" + }, + "StackEvents":{ + "type":"list", + "member":{"shape":"StackEvent"} + }, + "StackId":{"type":"string"}, + "StackInstance":{ + "type":"structure", + "members":{ + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The name or unique ID of the stack set that the stack instance is associated with.

" + }, + "Region":{ + "shape":"Region", + "documentation":"

The name of the AWS region that the stack instance is associated with.

" + }, + "Account":{ + "shape":"Account", + "documentation":"

The name of the AWS account that the stack instance is associated with.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

The ID of the stack instance.

" + }, + "ParameterOverrides":{ + "shape":"Parameters", + "documentation":"

A list of parameters from the stack set template whose values have been overridden in this stack instance.

" + }, + "Status":{ + "shape":"StackInstanceStatus", + "documentation":"

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

" + }, + "StatusReason":{ + "shape":"Reason", + "documentation":"

The explanation for the specific status code that is assigned to this stack instance.

" + } + }, + "documentation":"

An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

" + }, + "StackInstanceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified stack instance doesn't exist.

", + "error":{ + "code":"StackInstanceNotFoundException", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "StackInstanceStatus":{ + "type":"string", + "enum":[ + "CURRENT", + "OUTDATED", + "INOPERABLE" + ] + }, + "StackInstanceSummaries":{ + "type":"list", + "member":{"shape":"StackInstanceSummary"} + }, + "StackInstanceSummary":{ + "type":"structure", + "members":{ + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The name or unique ID of the stack set that the stack instance is associated with.

" + }, + "Region":{ + "shape":"Region", + "documentation":"

The name of the AWS region that the stack instance is associated with.

" + }, + "Account":{ + "shape":"Account", + "documentation":"

The name of the AWS account that the stack instance is associated with.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

The ID of the stack instance.

" + }, + "Status":{ + "shape":"StackInstanceStatus", + "documentation":"

The status of the stack instance, in terms of its synchronization with its associated stack set.

  • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

" + }, + "StatusReason":{ + "shape":"Reason", + "documentation":"

The explanation for the specific status code assigned to this stack instance.

" + } + }, + "documentation":"

The structure that contains summary information about a stack instance.

" + }, + "StackName":{"type":"string"}, + "StackNameOrId":{ + "type":"string", + "min":1, + "pattern":"([a-zA-Z][-a-zA-Z0-9]*)|(arn:\\b(aws|aws-us-gov|aws-cn)\\b:[-a-zA-Z0-9:/._+]*)" + }, + "StackPolicyBody":{ + "type":"string", + "max":16384, + "min":1 + }, + "StackPolicyDuringUpdateBody":{ + "type":"string", + "max":16384, + "min":1 + }, + "StackPolicyDuringUpdateURL":{ + "type":"string", + "max":1350, + "min":1 + }, + "StackPolicyURL":{ + "type":"string", + "max":1350, + "min":1 + }, + "StackResource":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "Timestamp", + "ResourceStatus" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

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

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the resource.

" + }, + "DriftInformation":{ + "shape":"StackResourceDriftInformation", + "documentation":"

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + } + }, + "documentation":"

The StackResource data type.

" + }, + "StackResourceDetail":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

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

Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the resource.

" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

The content of the Metadata attribute declared for the resource. For more information, see Metadata Attribute in the AWS CloudFormation User Guide.

" + }, + "DriftInformation":{ + "shape":"StackResourceDriftInformation", + "documentation":"

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + } + }, + "documentation":"

Contains detailed information about the specified stack resource.

" + }, + "StackResourceDrift":{ + "type":"structure", + "required":[ + "StackId", + "LogicalResourceId", + "ResourceType", + "StackResourceDriftStatus", + "Timestamp" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The ID of the stack.

" + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

" + }, + "PhysicalResourceIdContext":{ + "shape":"PhysicalResourceIdContext", + "documentation":"

Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.

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

The type of the resource.

" + }, + "ExpectedProperties":{ + "shape":"Properties", + "documentation":"

A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

" + }, + "ActualProperties":{ + "shape":"Properties", + "documentation":"

A JSON structure containing the actual property values of the stack resource.

For resources whose StackResourceDriftStatus is DELETED, this structure will not be present.

" + }, + "PropertyDifferences":{ + "shape":"PropertyDifferences", + "documentation":"

A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose StackResourceDriftStatus is MODIFIED.

" + }, + "StackResourceDriftStatus":{ + "shape":"StackResourceDriftStatus", + "documentation":"

Status of the resource's actual configuration compared to its expected configuration

  • DELETED: The resource differs from its expected template configuration because the resource has been deleted.

  • MODIFIED: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).

  • IN_SYNC: The resources's actual configuration matches its expected template configuration.

  • NOT_CHECKED: AWS CloudFormation does not currently return this value.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Time at which AWS CloudFormation performed drift detection on the stack resource.

" + } + }, + "documentation":"

Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see Resources that Support Drift Detection.

Use DetectStackResourceDrift to detect drift on individual resources, or DetectStackDrift to detect drift on all resources in a given stack that support drift detection.

" + }, + "StackResourceDriftInformation":{ + "type":"structure", + "required":["StackResourceDriftStatus"], + "members":{ + "StackResourceDriftStatus":{ + "shape":"StackResourceDriftStatus", + "documentation":"

Status of the resource's actual configuration compared to its expected configuration

  • DELETED: The resource differs from its expected configuration in that it has been deleted.

  • MODIFIED: The resource differs from its expected configuration.

  • NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration.

    Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection.

  • IN_SYNC: The resources's actual configuration matches its expected configuration.

" + }, + "LastCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"

When AWS CloudFormation last checked if the resource had drifted from its expected configuration.

" + } + }, + "documentation":"

Contains information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

" + }, + "StackResourceDriftInformationSummary":{ + "type":"structure", + "required":["StackResourceDriftStatus"], + "members":{ + "StackResourceDriftStatus":{ + "shape":"StackResourceDriftStatus", + "documentation":"

Status of the resource's actual configuration compared to its expected configuration

  • DELETED: The resource differs from its expected configuration in that it has been deleted.

  • MODIFIED: The resource differs from its expected configuration.

  • NOT_CHECKED: AWS CloudFormation has not checked if the resource differs from its expected configuration.

    Any resources that do not currently support drift detection have a status of NOT_CHECKED. For more information, see Resources that Support Drift Detection. If you performed an ContinueUpdateRollback operation on a stack, any resources included in ResourcesToSkip will also have a status of NOT_CHECKED. For more information on skipping resources during rollback operations, see Continue Rolling Back an Update in the AWS CloudFormation User Guide.

  • IN_SYNC: The resources's actual configuration matches its expected configuration.

" + }, + "LastCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"

When AWS CloudFormation last checked if the resource had drifted from its expected configuration.

" + } + }, + "documentation":"

Summarizes information about whether the resource's actual configuration differs, or has drifted, from its expected configuration.

" + }, + "StackResourceDriftStatus":{ + "type":"string", + "enum":[ + "IN_SYNC", + "MODIFIED", + "DELETED", + "NOT_CHECKED" + ] + }, + "StackResourceDriftStatusFilters":{ + "type":"list", + "member":{"shape":"StackResourceDriftStatus"}, + "max":4, + "min":1 + }, + "StackResourceDrifts":{ + "type":"list", + "member":{"shape":"StackResourceDrift"} + }, + "StackResourceSummaries":{ + "type":"list", + "member":{"shape":"StackResourceSummary"} + }, + "StackResourceSummary":{ + "type":"structure", + "required":[ + "LogicalResourceId", + "ResourceType", + "LastUpdatedTimestamp", + "ResourceStatus" + ], + "members":{ + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

The logical name of the resource specified in the template.

" + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

The name or unique identifier that corresponds to a physical instance ID of the resource.

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

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

" + }, + "LastUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time the status was updated.

" + }, + "ResourceStatus":{ + "shape":"ResourceStatus", + "documentation":"

Current status of the resource.

" + }, + "ResourceStatusReason":{ + "shape":"ResourceStatusReason", + "documentation":"

Success/failure message associated with the resource.

" + }, + "DriftInformation":{ + "shape":"StackResourceDriftInformationSummary", + "documentation":"

Information about whether the resource's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + } + }, + "documentation":"

Contains high-level information about the specified stack resource.

" + }, + "StackResources":{ + "type":"list", + "member":{"shape":"StackResource"} + }, + "StackSet":{ + "type":"structure", + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name that's associated with the stack set.

" + }, + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The ID of the stack set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the stack set that you specify when the stack set is created or updated.

" + }, + "Status":{ + "shape":"StackSetStatus", + "documentation":"

The status of the stack set.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

The structure that contains the body of the template that was used to create or update the stack set.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of input parameters for a stack set.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags that specify information about the stack set. A maximum number of 50 tags can be specified.

" + }, + "StackSetARN":{ + "shape":"StackSetARN", + "documentation":"

The Amazon Resource Number (ARN) of the stack set.

" + }, + "AdministrationRoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Prerequisites: Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

" + }, + "ExecutionRoleName":{ + "shape":"ExecutionRoleName", + "documentation":"

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

" + } + }, + "documentation":"

A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires.

" + }, + "StackSetARN":{"type":"string"}, + "StackSetId":{"type":"string"}, + "StackSetName":{"type":"string"}, + "StackSetNameOrId":{ + "type":"string", + "pattern":"[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?" + }, + "StackSetNotEmptyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You can't yet delete this stack set, because it still contains one or more stack instances. Delete all stack instances from the stack set before deleting the stack set.

", + "error":{ + "code":"StackSetNotEmptyException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "StackSetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified stack set doesn't exist.

", + "error":{ + "code":"StackSetNotFoundException", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "StackSetOperation":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique ID of a stack set operation.

" + }, + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The ID of the stack set.

" + }, + "Action":{ + "shape":"StackSetOperationAction", + "documentation":"

The type of stack set operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack set instances that are associated with the specified stack set. Update operations affect both the stack set itself, as well as all associated stack set instances.

" + }, + "Status":{ + "shape":"StackSetOperationStatus", + "documentation":"

The status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has cancelled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

" + }, + "OperationPreferences":{ + "shape":"StackSetOperationPreferences", + "documentation":"

The preferences for how AWS CloudFormation performs this stack set operation.

" + }, + "RetainStacks":{ + "shape":"RetainStacksNullable", + "documentation":"

For stack set operations of action type DELETE, specifies whether to remove the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack, or add an existing, saved stack to a new stack set.

" + }, + "AdministrationRoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation.

Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Define Permissions for Multiple Administrators in the AWS CloudFormation User Guide.

" + }, + "ExecutionRoleName":{ + "shape":"ExecutionRoleName", + "documentation":"

The name of the IAM execution role used to create or update the stack set.

Use customized execution roles to control which stack resources users and groups can include in their stack sets.

" + }, + "CreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.

" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.

" + } + }, + "documentation":"

The structure that contains information about a stack set operation.

" + }, + "StackSetOperationAction":{ + "type":"string", + "enum":[ + "CREATE", + "UPDATE", + "DELETE" + ] + }, + "StackSetOperationPreferences":{ + "type":"structure", + "members":{ + "RegionOrder":{ + "shape":"RegionList", + "documentation":"

The order of the regions in where you want to perform the stack operation.

" + }, + "FailureToleranceCount":{ + "shape":"FailureToleranceCount", + "documentation":"

The number of accounts, per region, for which this operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage (but not both).

" + }, + "FailureTolerancePercentage":{ + "shape":"FailureTolerancePercentage", + "documentation":"

The percentage of accounts, per region, for which this stack operation can fail before AWS CloudFormation stops the operation in that region. If the operation is stopped in a region, AWS CloudFormation doesn't attempt the operation in any subsequent regions.

When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number.

Conditional: You must specify either FailureToleranceCount or FailureTolerancePercentage, but not both.

" + }, + "MaxConcurrentCount":{ + "shape":"MaxConcurrentCount", + "documentation":"

The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of FailureToleranceCount—MaxConcurrentCount is at most one more than the FailureToleranceCount .

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

" + }, + "MaxConcurrentPercentage":{ + "shape":"MaxConcurrentPercentage", + "documentation":"

The maximum percentage of accounts in which to perform this operation at one time.

When calculating the number of accounts based on the specified percentage, AWS CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead.

Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

Conditional: You must specify either MaxConcurrentCount or MaxConcurrentPercentage, but not both.

" + } + }, + "documentation":"

The user-specified preferences for how AWS CloudFormation performs a stack set operation.

For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options.

" + }, + "StackSetOperationResultStatus":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ] + }, + "StackSetOperationResultSummaries":{ + "type":"list", + "member":{"shape":"StackSetOperationResultSummary"} + }, + "StackSetOperationResultSummary":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"Account", + "documentation":"

The name of the AWS account for this operation result.

" + }, + "Region":{ + "shape":"Region", + "documentation":"

The name of the AWS region for this operation result.

" + }, + "Status":{ + "shape":"StackSetOperationResultStatus", + "documentation":"

The result status of the stack set operation for the given account in the given region.

  • CANCELLED: The operation in the specified account and region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

  • FAILED: The operation in the specified account and region failed.

    If the stack set operation fails in enough accounts within a region, the failure tolerance for the stack set operation as a whole might be exceeded.

  • RUNNING: The operation in the specified account and region is currently in progress.

  • PENDING: The operation in the specified account and region has yet to start.

  • SUCCEEDED: The operation in the specified account and region completed successfully.

" + }, + "StatusReason":{ + "shape":"Reason", + "documentation":"

The reason for the assigned result status.

" + }, + "AccountGateResult":{ + "shape":"AccountGateResult", + "documentation":"

The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account

" + } + }, + "documentation":"

The structure that contains information about a specified operation's results for a given account in a given region.

" + }, + "StackSetOperationStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED", + "STOPPING", + "STOPPED" + ] + }, + "StackSetOperationSummaries":{ + "type":"list", + "member":{"shape":"StackSetOperationSummary"} + }, + "StackSetOperationSummary":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique ID of the stack set operation.

" + }, + "Action":{ + "shape":"StackSetOperationAction", + "documentation":"

The type of operation: CREATE, UPDATE, or DELETE. Create and delete operations affect only the specified stack instances that are associated with the specified stack set. Update operations affect both the stack set itself as well as all associated stack set instances.

" + }, + "Status":{ + "shape":"StackSetOperationStatus", + "documentation":"

The overall status of the operation.

  • FAILED: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each region during stack create and update operations. If the number of failed stacks within a region exceeds the failure tolerance, the status of the operation in the region is set to FAILED. This in turn sets the status of the operation as a whole to FAILED, and AWS CloudFormation cancels the operation in any remaining regions.

  • RUNNING: The operation is currently being performed.

  • STOPPED: The user has cancelled the operation.

  • STOPPING: The operation is in the process of stopping, at user request.

  • SUCCEEDED: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.

" + }, + "CreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.

" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.

" + } + }, + "documentation":"

The structures that contain summary information about the specified operation.

" + }, + "StackSetStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "DELETED" + ] + }, + "StackSetSummaries":{ + "type":"list", + "member":{"shape":"StackSetSummary"} + }, + "StackSetSummary":{ + "type":"structure", + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name of the stack set.

" + }, + "StackSetId":{ + "shape":"StackSetId", + "documentation":"

The ID of the stack set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the stack set that you specify when the stack set is created or updated.

" + }, + "Status":{ + "shape":"StackSetStatus", + "documentation":"

The status of the stack set.

" + } + }, + "documentation":"

The structures that contain summary information about the specified stack set.

" + }, + "StackStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "CREATE_COMPLETE", + "ROLLBACK_IN_PROGRESS", + "ROLLBACK_FAILED", + "ROLLBACK_COMPLETE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETE_COMPLETE", + "UPDATE_IN_PROGRESS", + "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_COMPLETE", + "UPDATE_ROLLBACK_IN_PROGRESS", + "UPDATE_ROLLBACK_FAILED", + "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", + "UPDATE_ROLLBACK_COMPLETE", + "REVIEW_IN_PROGRESS" + ] + }, + "StackStatusFilter":{ + "type":"list", + "member":{"shape":"StackStatus"} + }, + "StackStatusReason":{"type":"string"}, + "StackSummaries":{ + "type":"list", + "member":{"shape":"StackSummary"} + }, + "StackSummary":{ + "type":"structure", + "required":[ + "StackName", + "CreationTime", + "StackStatus" + ], + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique stack identifier.

" + }, + "StackName":{ + "shape":"StackName", + "documentation":"

The name associated with the stack.

" + }, + "TemplateDescription":{ + "shape":"TemplateDescription", + "documentation":"

The template description of the template used to create the stack.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The time the stack was created.

" + }, + "LastUpdatedTime":{ + "shape":"LastUpdatedTime", + "documentation":"

The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

" + }, + "DeletionTime":{ + "shape":"DeletionTime", + "documentation":"

The time the stack was deleted.

" + }, + "StackStatus":{ + "shape":"StackStatus", + "documentation":"

The current status of the stack.

" + }, + "StackStatusReason":{ + "shape":"StackStatusReason", + "documentation":"

Success/Failure message associated with the stack status.

" + }, + "ParentId":{ + "shape":"StackId", + "documentation":"

For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

" + }, + "RootId":{ + "shape":"StackId", + "documentation":"

For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.

For more information, see Working with Nested Stacks in the AWS CloudFormation User Guide.

" + }, + "DriftInformation":{ + "shape":"StackDriftInformationSummary", + "documentation":"

Summarizes information on whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see Detecting Unregulated Configuration Changes to Stacks and Resources.

" + } + }, + "documentation":"

The StackSummary Data Type

" + }, + "Stacks":{ + "type":"list", + "member":{"shape":"Stack"} + }, + "StageList":{ + "type":"list", + "member":{"shape":"TemplateStage"} + }, + "StaleRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Another operation has been performed on this stack set since the specified operation was performed.

", + "error":{ + "code":"StaleRequestException", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "StopStackSetOperationInput":{ + "type":"structure", + "required":[ + "StackSetName", + "OperationId" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to stop the operation for.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The ID of the stack operation.

" + } + } + }, + "StopStackSetOperationOutput":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

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

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

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

" + } + }, + "documentation":"

The Tag type enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50 + }, + "TemplateBody":{ + "type":"string", + "min":1 + }, + "TemplateDescription":{"type":"string"}, + "TemplateParameter":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

The name associated with the parameter.

" + }, + "DefaultValue":{ + "shape":"ParameterValue", + "documentation":"

The default value associated with the parameter.

" + }, + "NoEcho":{ + "shape":"NoEcho", + "documentation":"

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User defined description associated with the parameter.

" + } + }, + "documentation":"

The TemplateParameter data type.

" + }, + "TemplateParameters":{ + "type":"list", + "member":{"shape":"TemplateParameter"} + }, + "TemplateStage":{ + "type":"string", + "enum":[ + "Original", + "Processed" + ] + }, + "TemplateURL":{ + "type":"string", + "max":1024, + "min":1 + }, + "TimeoutMinutes":{ + "type":"integer", + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TokenAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A client request token already exists.

", + "error":{ + "code":"TokenAlreadyExistsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TransformName":{"type":"string"}, + "TransformsList":{ + "type":"list", + "member":{"shape":"TransformName"} + }, + "Type":{"type":"string"}, + "UpdateStackInput":{ + "type":"structure", + "required":["StackName"], + "members":{ + "StackName":{ + "shape":"StackName", + "documentation":"

The name or unique stack ID of the stack to update.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

" + }, + "UsePreviousTemplate":{ + "shape":"UsePreviousTemplate", + "documentation":"

Reuse the existing template that is associated with the stack that you are updating.

Conditional: You must specify only one of the following parameters: TemplateBody, TemplateURL, or set the UsePreviousTemplate to true.

" + }, + "StackPolicyDuringUpdateBody":{ + "shape":"StackPolicyDuringUpdateBody", + "documentation":"

Structure containing the temporary overriding stack policy body. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

" + }, + "StackPolicyDuringUpdateURL":{ + "shape":"StackPolicyDuringUpdateURL", + "documentation":"

Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL parameter, but not both.

If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.

    Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros and nested stacks, you must update the stack directly from the template using this capability.

    You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.

    Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.

    For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

" + }, + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

The template resource types that you have permissions to work with for this update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.

If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see Controlling Access with AWS Identity and Access Management.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.

If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.

" + }, + "RollbackConfiguration":{ + "shape":"RollbackConfiguration", + "documentation":"

The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

" + }, + "StackPolicyBody":{ + "shape":"StackPolicyBody", + "documentation":"

Structure containing a new stack policy body. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" + }, + "StackPolicyURL":{ + "shape":"StackPolicyURL", + "documentation":"

Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the StackPolicyBody or the StackPolicyURL parameter, but not both.

You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

" + }, + "NotificationARNs":{ + "shape":"NotificationARNs", + "documentation":"

Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.

If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique identifier for this UpdateStack request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry UpdateStack requests to ensure that AWS CloudFormation successfully received them.

All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a CreateStack operation with the token token1, then all the StackEvents generated by that operation will have ClientRequestToken set as token1.

In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format Console-StackOperation-ID, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002.

" + } + }, + "documentation":"

The input for an UpdateStack action.

" + }, + "UpdateStackInstancesInput":{ + "type":"structure", + "required":[ + "StackSetName", + "Accounts", + "Regions" + ], + "members":{ + "StackSetName":{ + "shape":"StackSetNameOrId", + "documentation":"

The name or unique ID of the stack set associated with the stack instances.

" + }, + "Accounts":{ + "shape":"AccountList", + "documentation":"

The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

" + }, + "Regions":{ + "shape":"RegionList", + "documentation":"

The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.

" + }, + "ParameterOverrides":{ + "shape":"Parameters", + "documentation":"

A list of input parameters whose values you want to update for the specified stack instances.

Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:

  • To override the current value for a parameter, include the parameter and specify its value.

  • To leave a parameter set to its present value, you can do one of the following:

    • Do not include the parameter in the list.

    • Include the parameter and specify UsePreviousValue as true. (You cannot specify both a value and set UsePreviousValue to true.)

  • To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.

  • To leave all parameters set to their present values, do not specify this property at all.

During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.

You can only override the parameter values that are specified in the stack set; to add or delete a parameter itself, use UpdateStackSet to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use UpdateStackSet to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using UpdateStackInstances.

" + }, + "OperationPreferences":{ + "shape":"StackSetOperationPreferences", + "documentation":"

Preferences for how AWS CloudFormation performs this stack set operation.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, the SDK generates one automatically.

", + "idempotencyToken":true + } + } + }, + "UpdateStackInstancesOutput":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique identifier for this stack set operation.

" + } + } + }, + "UpdateStackOutput":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

Unique identifier of the stack.

" + } + }, + "documentation":"

The output for an UpdateStack action.

" + }, + "UpdateStackSetInput":{ + "type":"structure", + "required":["StackSetName"], + "members":{ + "StackSetName":{ + "shape":"StackSetName", + "documentation":"

The name or unique ID of the stack set that you want to update.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A brief description of updates that you are making.

" + }, + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see Template Anatomy in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

" + }, + "UsePreviousTemplate":{ + "shape":"UsePreviousTemplate", + "documentation":"

Use the existing template that's associated with the stack set that you're updating.

Conditional: You must specify only one of the following parameters: TemplateBody or TemplateURL—or set UsePreviousTemplate to true.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A list of input parameters for the stack set template.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.

  • CAPABILITY_IAM and CAPABILITY_NAMED_IAM

    Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.

    The following IAM resources require you to specify either the CAPABILITY_IAM or CAPABILITY_NAMED_IAM capability.

    • If you have IAM resources, you can specify either capability.

    • If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM.

    • If you don't specify either of these capabilities, AWS CloudFormation returns an InsufficientCapabilities error.

    If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.

    For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

  • CAPABILITY_AUTO_EXPAND

    Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see Using AWS CloudFormation Macros to Perform Custom Processing on Templates.

    Stack sets do not currently support macros in stack templates. (This includes the AWS::Include and AWS::Serverless transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. You can specify a maximum number of 50 tags.

If you specify tags for this parameter, those tags replace any list of tags that are currently associated with this stack set. This means:

  • If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags.

  • If you specify any tags using this parameter, you must specify all the tags that you want associated with this stack set, even tags you've specifed before (for example, when creating the stack set or during a previous update of the stack set.). Any tags that you don't include in the updated list of tags are removed from the stack set, and therefore from the stacks and resources as well.

  • If you specify an empty value, AWS CloudFormation removes all currently associated tags.

If you specify new tags as part of an UpdateStackSet action, AWS CloudFormation checks to see if you have the required IAM permission to tag resources. If you omit tags that are currently associated with the stack set from the list of tags you specify, AWS CloudFormation assumes that you want to remove those tags from the stack set, and checks to see if you have permission to untag resources. If you don't have the necessary permission(s), the entire UpdateStackSet action fails with an access denied error, and the stack set is not updated.

" + }, + "OperationPreferences":{ + "shape":"StackSetOperationPreferences", + "documentation":"

Preferences for how AWS CloudFormation performs this stack set operation.

" + }, + "AdministrationRoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.

Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see Granting Permissions for Stack Set Operations in the AWS CloudFormation User Guide.

If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.

" + }, + "ExecutionRoleName":{ + "shape":"ExecutionRoleName", + "documentation":"

The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.

Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets.

If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.

" + }, + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique ID for this stack set operation.

The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.

If you don't specify an operation ID, AWS CloudFormation generates one automatically.

Repeating this stack set operation with a new operation ID retries all stack instances whose status is OUTDATED.

", + "idempotencyToken":true + }, + "Accounts":{ + "shape":"AccountList", + "documentation":"

The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.

" + }, + "Regions":{ + "shape":"RegionList", + "documentation":"

The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.

To update all the stack instances associated with this stack set, do not specify the Accounts or Regions properties.

If the stack set update includes changes to the template (that is, if the TemplateBody or TemplateURL properties are specified), or the Parameters property, AWS CloudFormation marks all stack instances with a status of OUTDATED prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status.

" + } + } + }, + "UpdateStackSetOutput":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"ClientRequestToken", + "documentation":"

The unique ID for this stack set operation.

" + } + } + }, + "UpdateTerminationProtectionInput":{ + "type":"structure", + "required":[ + "EnableTerminationProtection", + "StackName" + ], + "members":{ + "EnableTerminationProtection":{ + "shape":"EnableTerminationProtection", + "documentation":"

Whether to enable termination protection on the specified stack.

" + }, + "StackName":{ + "shape":"StackNameOrId", + "documentation":"

The name or unique ID of the stack for which you want to set termination protection.

" + } + } + }, + "UpdateTerminationProtectionOutput":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"StackId", + "documentation":"

The unique ID of the stack.

" + } + } + }, + "Url":{"type":"string"}, + "UsePreviousTemplate":{"type":"boolean"}, + "UsePreviousValue":{"type":"boolean"}, + "ValidateTemplateInput":{ + "type":"structure", + "members":{ + "TemplateBody":{ + "shape":"TemplateBody", + "documentation":"

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" + }, + "TemplateURL":{ + "shape":"TemplateURL", + "documentation":"

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to Template Anatomy in the AWS CloudFormation User Guide.

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

" + } + }, + "documentation":"

The input for ValidateTemplate action.

" + }, + "ValidateTemplateOutput":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"TemplateParameters", + "documentation":"

A list of TemplateParameter structures.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description found within the template.

" + }, + "Capabilities":{ + "shape":"Capabilities", + "documentation":"

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.

" + }, + "CapabilitiesReason":{ + "shape":"CapabilitiesReason", + "documentation":"

The list of resources that generated the values in the Capabilities response element.

" + }, + "DeclaredTransforms":{ + "shape":"TransformsList", + "documentation":"

A list of the transforms that are declared in the template.

" + } + }, + "documentation":"

The output for ValidateTemplate action.

" + }, + "Value":{"type":"string"}, + "Version":{"type":"string"} + }, + "documentation":"AWS CloudFormation

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

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

For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.

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

" +} diff --git a/aws/dist/botocore/data/cloudformation/2010-05-15/waiters-2.json b/aws/dist/botocore/data/cloudformation/2010-05-15/waiters-2.json new file mode 100644 index 00000000..4e8c8282 --- /dev/null +++ b/aws/dist/botocore/data/cloudformation/2010-05-15/waiters-2.json @@ -0,0 +1,182 @@ +{ + "version": 2, + "waiters": { + "StackExists": { + "delay": 5, + "operation": "DescribeStacks", + "maxAttempts": 20, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "ValidationError", + "state": "retry" + } + ] + }, + "StackCreateComplete": { + "delay": 30, + "operation": "DescribeStacks", + "maxAttempts": 120, + "description": "Wait until stack status is CREATE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_COMPLETE", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_COMPLETE", + "matcher": "pathAny", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, + "StackDeleteComplete": { + "delay": 30, + "operation": "DescribeStacks", + "maxAttempts": 120, + "description": "Wait until stack status is DELETE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "success" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "DELETE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "CREATE_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_IN_PROGRESS", + "matcher": "pathAny", + "state": "failure" + } + ] + }, + "StackUpdateComplete": { + "delay": 30, + "maxAttempts": 120, + "operation": "DescribeStacks", + "description": "Wait until stack status is UPDATE_COMPLETE.", + "acceptors": [ + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_COMPLETE", + "matcher": "pathAll", + "state": "success" + }, + { + "expected": "UPDATE_FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Stacks[].StackStatus" + }, + { + "argument": "Stacks[].StackStatus", + "expected": "UPDATE_ROLLBACK_FAILED", + "matcher": "pathAny", + "state": "failure" + }, + { + "expected": "UPDATE_ROLLBACK_COMPLETE", + "matcher": "pathAny", + "state": "failure", + "argument": "Stacks[].StackStatus" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + }, + "ChangeSetCreateComplete": { + "delay": 30, + "operation": "DescribeChangeSet", + "maxAttempts": 120, + "description": "Wait until change set status is CREATE_COMPLETE.", + "acceptors": [ + { + "argument": "Status", + "expected": "CREATE_COMPLETE", + "matcher": "path", + "state": "success" + }, + { + "argument": "Status", + "expected": "FAILED", + "matcher": "path", + "state": "failure" + }, + { + "expected": "ValidationError", + "matcher": "error", + "state": "failure" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-05-31/paginators-1.json b/aws/dist/botocore/data/cloudfront/2014-05-31/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-05-31/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-05-31/service-2.json b/aws/dist/botocore/data/cloudfront/2014-05-31/service-2.json new file mode 100644 index 00000000..9410f8f9 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-05-31/service-2.json @@ -0,0 +1,3541 @@ +{ + "metadata":{ + "apiVersion":"2014-05-31", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2014_05_31", + "http":{ + "method":"POST", + "requestUri":"/2014-05-31/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2014_05_31", + "http":{ + "method":"DELETE", + "requestUri":"/2014-05-31/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListInvalidations":{ + "name":"ListInvalidations2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2014_05_31", + "http":{ + "method":"GET", + "requestUri":"/2014-05-31/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2014_05_31", + "http":{ + "method":"PUT", + "requestUri":"/2014-05-31/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests) and 7 (for DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests)." + }, + "Items":{ + "shape":"AllowedMethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + } + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are two options: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT requests. If you choose the second option, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AllowedMethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Aliases", + "DefaultRootObject", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "Comment", + "Logging", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions you want in the response body." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Aliases", + "Comment", + "Logging", + "TrustedSigners", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-05-31/"}, + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-05-31/waiters-2.json b/aws/dist/botocore/data/cloudfront/2014-05-31/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-05-31/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-10-21/paginators-1.json b/aws/dist/botocore/data/cloudfront/2014-10-21/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-10-21/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-10-21/service-2.json b/aws/dist/botocore/data/cloudfront/2014-10-21/service-2.json new file mode 100644 index 00000000..7a7a2799 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-10-21/service-2.json @@ -0,0 +1,3589 @@ +{ + "metadata":{ + "apiVersion":"2014-10-21", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2014_10_21", + "http":{ + "method":"POST", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2014_10_21", + "http":{ + "method":"POST", + "requestUri":"/2014-10-21/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidProtocolSettings", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2014_10_21", + "http":{ + "method":"POST", + "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2014_10_21", + "http":{ + "method":"POST", + "requestUri":"/2014-10-21/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2014_10_21", + "http":{ + "method":"DELETE", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2014_10_21", + "http":{ + "method":"DELETE", + "requestUri":"/2014-10-21/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2014_10_21", + "http":{ + "method":"DELETE", + "requestUri":"/2014-10-21/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListInvalidations":{ + "name":"ListInvalidations2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2014_10_21", + "http":{ + "method":"GET", + "requestUri":"/2014-10-21/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2014_10_21", + "http":{ + "method":"PUT", + "requestUri":"/2014-10-21/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2014_10_21", + "http":{ + "method":"PUT", + "requestUri":"/2014-10-21/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2014_10_21", + "http":{ + "method":"PUT", + "requestUri":"/2014-10-21/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Aliases", + "DefaultRootObject", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "Comment", + "Logging", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions you want in the response body." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Aliases", + "Comment", + "Logging", + "TrustedSigners", + "PriceClass", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-10-21/"}, + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-10-21/waiters-2.json b/aws/dist/botocore/data/cloudfront/2014-10-21/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-10-21/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-11-06/paginators-1.json b/aws/dist/botocore/data/cloudfront/2014-11-06/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-11-06/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-11-06/service-2.json b/aws/dist/botocore/data/cloudfront/2014-11-06/service-2.json new file mode 100644 index 00000000..d1afd52a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-11-06/service-2.json @@ -0,0 +1,3586 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-06", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2014_11_06", + "http":{ + "method":"POST", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2014_11_06", + "http":{ + "method":"POST", + "requestUri":"/2014-11-06/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidProtocolSettings", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2014_11_06", + "http":{ + "method":"POST", + "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2014_11_06", + "http":{ + "method":"POST", + "requestUri":"/2014-11-06/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2014_11_06", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2014_11_06", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-06/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2014_11_06", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-06/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListInvalidations":{ + "name":"ListInvalidations2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2014_11_06", + "http":{ + "method":"GET", + "requestUri":"/2014-11-06/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2014_11_06", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-06/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2014_11_06", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-06/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2014_11_06", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-06/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions you want in the response body." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2014-11-06/"}, + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2014-11-06/waiters-2.json b/aws/dist/botocore/data/cloudfront/2014-11-06/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2014-11-06/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-04-17/paginators-1.json b/aws/dist/botocore/data/cloudfront/2015-04-17/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-04-17/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-04-17/service-2.json b/aws/dist/botocore/data/cloudfront/2015-04-17/service-2.json new file mode 100644 index 00000000..b900b163 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-04-17/service-2.json @@ -0,0 +1,3638 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-17", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2015_04_17", + "http":{ + "method":"POST", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2015_04_17", + "http":{ + "method":"POST", + "requestUri":"/2015-04-17/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidMinimumProtocolVersion", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidProtocolSettings", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + { + "shape":"InvalidTTLOrder", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2015_04_17", + "http":{ + "method":"POST", + "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2015_04_17", + "http":{ + "method":"POST", + "requestUri":"/2015-04-17/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2015_04_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2015_04_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-04-17/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2015_04_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-04-17/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListInvalidations":{ + "name":"ListInvalidations2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2015_04_17", + "http":{ + "method":"GET", + "requestUri":"/2015-04-17/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2015_04_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-04-17/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2015_04_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-04-17/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidMinimumProtocolVersion", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidTTLOrder", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2015_04_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-04-17/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"} + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions you want in the response body." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-04-17/"}, + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-04-17/waiters-2.json b/aws/dist/botocore/data/cloudfront/2015-04-17/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-04-17/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-07-27/paginators-1.json b/aws/dist/botocore/data/cloudfront/2015-07-27/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-07-27/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-07-27/service-2.json b/aws/dist/botocore/data/cloudfront/2015-07-27/service-2.json new file mode 100644 index 00000000..5ebd2f4c --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-07-27/service-2.json @@ -0,0 +1,3732 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-07-27", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "protocol":"rest-xml" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2015_07_27", + "http":{ + "method":"POST", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{ + "shape":"CreateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to create a new origin access identity." + }, + "output":{ + "shape":"CreateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CloudFrontOriginAccessIdentityAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyCloudFrontOriginAccessIdentities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2015_07_27", + "http":{ + "method":"POST", + "requestUri":"/2015-07-27/distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateDistributionRequest", + "documentation":"The request to create a new distribution." + }, + "output":{ + "shape":"CreateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"DistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidMinimumProtocolVersion", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"TooManyDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidProtocolSettings", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + { + "shape":"InvalidTTLOrder", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidWebACLId", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2015_07_27", + "http":{ + "method":"POST", + "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{ + "shape":"CreateInvalidationRequest", + "documentation":"The request to create an invalidation." + }, + "output":{ + "shape":"CreateInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"BatchTooLarge", + "error":{"httpStatusCode":413}, + "exception":true + }, + { + "shape":"TooManyInvalidationsInProgress", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2015_07_27", + "http":{ + "method":"POST", + "requestUri":"/2015-07-27/streaming-distribution", + "responseCode":201 + }, + "input":{ + "shape":"CreateStreamingDistributionRequest", + "documentation":"The request to create a new streaming distribution." + }, + "output":{ + "shape":"CreateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"StreamingDistributionAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidOrigin", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"TooManyStreamingDistributions", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2015_07_27", + "http":{ + "method":"DELETE", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to delete a origin access identity." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"CloudFrontOriginAccessIdentityInUse", + "error":{"httpStatusCode":409}, + "exception":true + } + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2015_07_27", + "http":{ + "method":"DELETE", + "requestUri":"/2015-07-27/distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteDistributionRequest", + "documentation":"The request to delete a distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"DistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2015_07_27", + "http":{ + "method":"DELETE", + "requestUri":"/2015-07-27/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{ + "shape":"DeleteStreamingDistributionRequest", + "documentation":"The request to delete a streaming distribution." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"StreamingDistributionNotDisabled", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + } + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to get an origin access identity's information." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigRequest", + "documentation":"The request to get an origin access identity's configuration." + }, + "output":{ + "shape":"GetCloudFrontOriginAccessIdentityConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distribution/{Id}" + }, + "input":{ + "shape":"GetDistributionRequest", + "documentation":"The request to get a distribution's information." + }, + "output":{ + "shape":"GetDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distribution/{Id}/config" + }, + "input":{ + "shape":"GetDistributionConfigRequest", + "documentation":"The request to get a distribution configuration." + }, + "output":{ + "shape":"GetDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{ + "shape":"GetInvalidationRequest", + "documentation":"The request to get an invalidation's information." + }, + "output":{ + "shape":"GetInvalidationResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchInvalidation", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/streaming-distribution/{Id}" + }, + "input":{ + "shape":"GetStreamingDistributionRequest", + "documentation":"The request to get a streaming distribution's information." + }, + "output":{ + "shape":"GetStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"GetStreamingDistributionConfigRequest", + "documentation":"To request to get a streaming distribution configuration." + }, + "output":{ + "shape":"GetStreamingDistributionConfigResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront" + }, + "input":{ + "shape":"ListCloudFrontOriginAccessIdentitiesRequest", + "documentation":"The request to list origin access identities." + }, + "output":{ + "shape":"ListCloudFrontOriginAccessIdentitiesResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distribution" + }, + "input":{ + "shape":"ListDistributionsRequest", + "documentation":"The request to list your distributions." + }, + "output":{ + "shape":"ListDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distributionsByWebACLId/{WebACLId}" + }, + "input":{ + "shape":"ListDistributionsByWebACLIdRequest", + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "output":{ + "shape":"ListDistributionsByWebACLIdResult", + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidWebACLId", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/distribution/{DistributionId}/invalidation" + }, + "input":{ + "shape":"ListInvalidationsRequest", + "documentation":"The request to list invalidations." + }, + "output":{ + "shape":"ListInvalidationsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + } + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2015_07_27", + "http":{ + "method":"GET", + "requestUri":"/2015-07-27/streaming-distribution" + }, + "input":{ + "shape":"ListStreamingDistributionsRequest", + "documentation":"The request to list your streaming distributions." + }, + "output":{ + "shape":"ListStreamingDistributionsResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + } + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2015_07_27", + "http":{ + "method":"PUT", + "requestUri":"/2015-07-27/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{ + "shape":"UpdateCloudFrontOriginAccessIdentityRequest", + "documentation":"The request to update an origin access identity." + }, + "output":{ + "shape":"UpdateCloudFrontOriginAccessIdentityResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchCloudFrontOriginAccessIdentity", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2015_07_27", + "http":{ + "method":"PUT", + "requestUri":"/2015-07-27/distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateDistributionRequest", + "documentation":"The request to update a distribution." + }, + "output":{ + "shape":"UpdateDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + { + "shape":"InvalidDefaultRootObject", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + { + "shape":"InvalidRelativePath", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + { + "shape":"InvalidErrorCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidResponseCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InvalidViewerCertificate", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidMinimumProtocolVersion", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidRequiredProtocol", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + { + "shape":"NoSuchOrigin", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + { + "shape":"TooManyOrigins", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + { + "shape":"TooManyCacheBehaviors", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + { + "shape":"TooManyCookieNamesInWhiteList", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + { + "shape":"InvalidForwardCookies", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + { + "shape":"TooManyHeadersInForwardedValues", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidHeadersForS3Origin", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + { + "shape":"TooManyCertificates", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + { + "shape":"InvalidLocationCode", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidGeoRestrictionParameter", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidTTLOrder", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidWebACLId", + "error":{"httpStatusCode":400}, + "exception":true + } + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2015_07_27", + "http":{ + "method":"PUT", + "requestUri":"/2015-07-27/streaming-distribution/{Id}/config" + }, + "input":{ + "shape":"UpdateStreamingDistributionRequest", + "documentation":"The request to update a streaming distribution." + }, + "output":{ + "shape":"UpdateStreamingDistributionResult", + "documentation":"The returned result of the corresponding request." + }, + "errors":[ + { + "shape":"AccessDenied", + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + { + "shape":"CNAMEAlreadyExists", + "error":{"httpStatusCode":409}, + "exception":true + }, + { + "shape":"IllegalUpdate", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + { + "shape":"InvalidIfMatchVersion", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + { + "shape":"MissingBody", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + { + "shape":"NoSuchStreamingDistribution", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + { + "shape":"PreconditionFailed", + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + { + "shape":"TooManyStreamingDistributionCNAMEs", + "error":{"httpStatusCode":400}, + "exception":true + }, + { + "shape":"InvalidArgument", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + { + "shape":"InvalidOriginAccessIdentity", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + { + "shape":"TooManyTrustedSigners", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + { + "shape":"TrustedSignerDoesNotExist", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + { + "shape":"InconsistentQuantities", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + } + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":403}, + "exception":true, + "documentation":"Access denied." + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"DistributionConfig" + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"InvalidationBatch" + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID." + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"StreamingDistributionConfig" + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "location":"header", + "locationName":"Location", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution created." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The origin access identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a origin access identity.", + "required":["Id"] + }, + "DeleteDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a distribution.", + "required":["Id"] + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to delete a streaming distribution.", + "required":["Id"] + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution." + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's configuration.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + } + }, + "documentation":"The request to get an origin access identity's information.", + "required":["Id"] + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution configuration.", + "required":["Id"] + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + } + }, + "documentation":"The request to get a distribution's information.", + "required":["Id"] + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The invalidation's id." + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"To request to get a streaming distribution configuration.", + "required":["Id"] + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + } + }, + "documentation":"The request to get a streaming distribution's information.", + "required":["Id"] + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Origin and CallerReference cannot be updated." + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The value of Quantity and the size of Items do not match." + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The argument is invalid." + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The default root object file name is too big or contains an invalid character." + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected." + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The If-Match version is missing or not valid for the distribution." + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket." + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The origin access identity is not valid or doesn't exist." + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI)." + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/)." + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration." + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of origin access identities you want in the response body." + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)" + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100." + }, + "WebACLId":{ + "shape":"string", + "location":"uri", + "locationName":"WebACLId", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL." + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)" + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100." + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "location":"uri", + "locationName":"DistributionId", + "documentation":"The distribution's id." + }, + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of invalidation batches you want in the response body." + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "location":"querystring", + "locationName":"Marker", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page)." + }, + "MaxItems":{ + "shape":"string", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"The maximum number of streaming distributions you want in the response body." + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set." + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified origin access identity does not exist." + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified distribution does not exist." + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified invalidation does not exist." + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"No origin exists with the specified Origin Id." + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"The specified streaming distribution does not exist." + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":412}, + "exception":true, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false." + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore cache behaviors for the distribution." + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore custom ssl certificates." + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed." + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior." + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more CNAMEs than are allowed per distribution." + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed." + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects." + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"You cannot create anymore origins for the distribution." + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed." + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"Your request contains more trusted signers than are allowed per distribution." + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"One or more of your trusted signers do not exist." + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"CloudFrontOriginAccessIdentityConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The identity's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"DistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-07-27/"}, + "locationName":"StreamingDistributionConfig" + }, + "Id":{ + "shape":"string", + "location":"uri", + "locationName":"Id", + "documentation":"The streaming distribution's id." + }, + "IfMatch":{ + "shape":"string", + "location":"header", + "locationName":"If-Match", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate." + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-07-27/waiters-2.json b/aws/dist/botocore/data/cloudfront/2015-07-27/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-07-27/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-09-17/paginators-1.json b/aws/dist/botocore/data/cloudfront/2015-09-17/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-09-17/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-09-17/service-2.json b/aws/dist/botocore/data/cloudfront/2015-09-17/service-2.json new file mode 100644 index 00000000..277883dd --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-09-17/service-2.json @@ -0,0 +1,2929 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-09-17", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2015_09_17", + "http":{ + "method":"POST", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2015_09_17", + "http":{ + "method":"POST", + "requestUri":"/2015-09-17/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2015_09_17", + "http":{ + "method":"POST", + "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2015_09_17", + "http":{ + "method":"POST", + "requestUri":"/2015-09-17/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2015_09_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2015_09_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-09-17/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2015_09_17", + "http":{ + "method":"DELETE", + "requestUri":"/2015-09-17/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2015_09_17", + "http":{ + "method":"GET", + "requestUri":"/2015-09-17/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2015_09_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-09-17/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2015_09_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-09-17/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2015_09_17", + "http":{ + "method":"PUT", + "requestUri":"/2015-09-17/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer" + ] + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2015-09-17/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), set to the IAM certificate identifier of the custom viewer certificate for this distribution." + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to \"cloudfront\". If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), set to \"iam\", and update the Certificate field with the IAM certificate identifier of the custom viewer certificate for this distribution." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use \"iam\" as CertificateSource and specify the IAM certificate Id as the Certificate. If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate.", + "deprecated":true + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"Note: this field is deprecated. Please use \"cloudfront\" as CertificateSource and omit specifying a Certificate. If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId.", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2015-09-17/waiters-2.json b/aws/dist/botocore/data/cloudfront/2015-09-17/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2015-09-17/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-13/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-01-13/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-13/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-13/service-2.json b/aws/dist/botocore/data/cloudfront/2016-01-13/service-2.json new file mode 100644 index 00000000..22f148bf --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-13/service-2.json @@ -0,0 +1,3022 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-01-13", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_01_13", + "http":{ + "method":"POST", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_01_13", + "http":{ + "method":"POST", + "requestUri":"/2016-01-13/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_01_13", + "http":{ + "method":"POST", + "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_01_13", + "http":{ + "method":"POST", + "requestUri":"/2016-01-13/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_01_13", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_01_13", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-13/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_01_13", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-13/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_01_13", + "http":{ + "method":"GET", + "requestUri":"/2016-01-13/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_01_13", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-13/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_01_13", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-13/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_01_13", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-13/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom headers for this origin." + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"A complex type that contains the custom headers for this Origin." + } + }, + "documentation":"A complex type that contains the list of Custom Headers for each origin." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"A complex type that contains information about the custom headers associated with this Origin." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"The header's name." + }, + "HeaderValue":{ + "shape":"string", + "documentation":"The header's value." + } + }, + "documentation":"A complex type that contains information related to a Header" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + } + }, + "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-13/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), you can use your own IAM or ACM certificate. For ACM, set to the ACM certificate ARN. For IAM, set to the IAM certificate identifier." + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to \"cloudfront\". If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), you can use your own IAM or ACM certificate. To use an ACM certificate, set to \"acm\" and update the Certificate to the ACM certificate ARN. To use an IAM certificate, set to \"iam\" and update the Certificate to the IAM certificate identifier." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use \"iam\" as CertificateSource and specify the IAM certificate Id as the Certificate. If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value or CloudFrontDefaultCertificate.", + "deprecated":true + }, + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"Note: this field is deprecated. Please use \"cloudfront\" as CertificateSource and omit specifying a Certificate. If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an IAMCertificateId.", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-13/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-01-13/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-13/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-28/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-01-28/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-28/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-28/service-2.json b/aws/dist/botocore/data/cloudfront/2016-01-28/service-2.json new file mode 100644 index 00000000..59385f72 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-28/service-2.json @@ -0,0 +1,3027 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-01-28", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_01_28", + "http":{ + "method":"POST", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_01_28", + "http":{ + "method":"POST", + "requestUri":"/2016-01-28/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Create a new distribution." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_01_28", + "http":{ + "method":"POST", + "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_01_28", + "http":{ + "method":"POST", + "requestUri":"/2016-01-28/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_01_28", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_01_28", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-28/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_01_28", + "http":{ + "method":"DELETE", + "requestUri":"/2016-01-28/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_01_28", + "http":{ + "method":"GET", + "requestUri":"/2016-01-28/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_01_28", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-28/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_01_28", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-28/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_01_28", + "http":{ + "method":"PUT", + "requestUri":"/2016-01-28/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom headers for this origin." + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"A complex type that contains the custom headers for this Origin." + } + }, + "documentation":"A complex type that contains the list of Custom Headers for each origin." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"A complex type that contains information about the custom headers associated with this Origin." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"The header's name." + }, + "HeaderValue":{ + "shape":"string", + "documentation":"The header's value." + } + }, + "documentation":"A complex type that contains information related to a Header" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + } + }, + "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-01-28/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "Certificate":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-01-28/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-01-28/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-01-28/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-01/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-08-01/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-01/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-01/service-2.json b/aws/dist/botocore/data/cloudfront/2016-08-01/service-2.json new file mode 100644 index 00000000..8b830bd0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-01/service-2.json @@ -0,0 +1,3434 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-08-01", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Create a new distribution." + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"} + ], + "documentation":"Create a new distribution with tags." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"Create a new streaming distribution with tags." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_08_01", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_08_01", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-01/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_08_01", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-01/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2016_08_01", + "http":{ + "method":"GET", + "requestUri":"/2016-08-01/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"List tags for a CloudFront resource." + }, + "TagResource":{ + "name":"TagResource2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Add tags to a CloudFront resource." + }, + "UntagResource":{ + "name":"UntagResource2016_08_01", + "http":{ + "method":"POST", + "requestUri":"/2016-08-01/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Remove tags from a CloudFront resource." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_08_01", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-01/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_08_01", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-01/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_08_01", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-01/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create a new distribution with tags", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to create a new streaming distribution with tags.", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom headers for this origin." + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"A complex type that contains the custom headers for this Origin." + } + }, + "documentation":"A complex type that contains the list of Custom Headers for each origin." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"A distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"The request to list tags for a CloudFront resource." + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified CloudFront resource does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"A complex type that contains information about the custom headers associated with this Origin." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"The header's name." + }, + "HeaderValue":{ + "shape":"string", + "documentation":"The header's value." + } + }, + "documentation":"A complex type that contains information related to a Header" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + } + }, + "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"A streaming distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + }, + "Value":{ + "shape":"TagValue", + "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + } + }, + "documentation":"A complex type that contains Tag key and Tag value." + }, + "TagKey":{ + "type":"string", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"A complex type that contains Tag key elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements.", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to add tags to a CloudFront resource.", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"A complex type that contains Tag elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"A complex type that contains zero or more Tag key elements.", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + } + }, + "documentation":"The request to remove tags from a CloudFront resource.", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-01/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "Certificate":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-01/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-08-01/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-01/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-20/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-08-20/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-20/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-20/service-2.json b/aws/dist/botocore/data/cloudfront/2016-08-20/service-2.json new file mode 100644 index 00000000..09fa631b --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-20/service-2.json @@ -0,0 +1,3481 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-08-20", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Create a new distribution." + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Create a new distribution with tags." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"Create a new streaming distribution with tags." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_08_20", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_08_20", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-20/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_08_20", + "http":{ + "method":"DELETE", + "requestUri":"/2016-08-20/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2016_08_20", + "http":{ + "method":"GET", + "requestUri":"/2016-08-20/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"List tags for a CloudFront resource." + }, + "TagResource":{ + "name":"TagResource2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Add tags to a CloudFront resource." + }, + "UntagResource":{ + "name":"UntagResource2016_08_20", + "http":{ + "method":"POST", + "requestUri":"/2016-08-20/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Remove tags from a CloudFront resource." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_08_20", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-20/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_08_20", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-20/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_08_20", + "http":{ + "method":"PUT", + "requestUri":"/2016-08-20/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create a new distribution with tags", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to create a new streaming distribution with tags.", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom headers for this origin." + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"A complex type that contains the custom headers for this Origin." + } + }, + "documentation":"A complex type that contains the list of Custom Headers for each origin." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"A distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

  • If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
  • If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
  • If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"The request to list tags for a CloudFront resource." + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified CloudFront resource does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"A complex type that contains information about the custom headers associated with this Origin." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"The header's name." + }, + "HeaderValue":{ + "shape":"string", + "documentation":"The header's value." + } + }, + "documentation":"A complex type that contains information related to a Header" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + } + }, + "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted query string parameters for this cache behavior." + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"Optional: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items." + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"A streaming distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + }, + "Value":{ + "shape":"TagValue", + "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + } + }, + "documentation":"A complex type that contains Tag key and Tag value." + }, + "TagKey":{ + "type":"string", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"A complex type that contains Tag key elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements.", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to add tags to a CloudFront resource.", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"A complex type that contains Tag elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"A complex type that contains zero or more Tag key elements.", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + } + }, + "documentation":"The request to remove tags from a CloudFront resource.", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-08-20/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "Certificate":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2016-08-20/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-08-20/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-08-20/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-07/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-09-07/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-07/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-07/service-2.json b/aws/dist/botocore/data/cloudfront/2016-09-07/service-2.json new file mode 100644 index 00000000..64747f92 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-07/service-2.json @@ -0,0 +1,3497 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-09-07", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new origin access identity." + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Create a new distribution." + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Create a new distribution with tags." + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new invalidation." + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Create a new streaming distribution." + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"Create a new streaming distribution with tags." + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_09_07", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"Delete an origin access identity." + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_09_07", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-07/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a distribution." + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_09_07", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-07/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"Delete a streaming distribution." + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an origin access identity." + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about an origin access identity." + }, + "GetDistribution":{ + "name":"GetDistribution2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a distribution." + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a distribution." + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about an invalidation." + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the information about a streaming distribution." + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"Get the configuration information about a streaming distribution." + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List origin access identities." + }, + "ListDistributions":{ + "name":"ListDistributions2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List distributions." + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"List the distributions that are associated with a specified AWS WAF web ACL." + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"List invalidation batches." + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"List streaming distributions." + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2016_09_07", + "http":{ + "method":"GET", + "requestUri":"/2016-09-07/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"List tags for a CloudFront resource." + }, + "TagResource":{ + "name":"TagResource2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Add tags to a CloudFront resource." + }, + "UntagResource":{ + "name":"UntagResource2016_09_07", + "http":{ + "method":"POST", + "requestUri":"/2016-09-07/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"Remove tags from a CloudFront resource." + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_09_07", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-07/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update an origin access identity." + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_09_07", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-07/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"Update a distribution." + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_09_07", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-07/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"Update a streaming distribution." + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Access denied.", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Each active trusted signer." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3." + }, + "Items":{ + "shape":"SignerList", + "documentation":"A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors." + } + }, + "documentation":"A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for the default cache behavior or for any of the other cache behaviors for this distribution. These are accounts that you want to allow to create signed URLs for private content." + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of CNAMEs, if any, for this distribution." + }, + "Items":{ + "shape":"AliasList", + "documentation":"Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin." + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: - CloudFront forwards only GET and HEAD requests. - CloudFront forwards only GET, HEAD and OPTIONS requests. - CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you may not want users to have permission to delete objects from your origin." + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior." + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes how CloudFront processes requests. You can create up to 10 cache behaviors.You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin will never be used. If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error. To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element. To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution." + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of cache behaviors for this distribution." + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests)." + }, + "Items":{ + "shape":"MethodsList", + "documentation":"A complex type that contains the HTTP methods that you want CloudFront to cache responses to." + } + }, + "documentation":"A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: - CloudFront caches responses to GET and HEAD requests. - CloudFront caches responses to GET, HEAD, and OPTIONS requests. If you pick the second choice for your S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers and Origin headers for the responses to be cached correctly." + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The current configuration information for the identity." + } + }, + "documentation":"CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the origin access identity." + } + }, + "documentation":"Origin access identity configuration." + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of CloudFront origin access identities that were created by the current AWS account." + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account." + } + }, + "documentation":"The CloudFrontOriginAccessIdentityList type." + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The ID for the origin access identity. For example: E74FTE3AJFJ256A." + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment for this origin access identity, as originally specified when created." + } + }, + "documentation":"Summary of the information about a CloudFront origin access identity." + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted cookies for this cache behavior." + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses." + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior." + } + }, + "documentation":"A complex type that specifies the cookie preferences associated with this cache behavior." + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create a new origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create a new distribution.", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create a new distribution with tags", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The batch information for the invalidation.", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create an invalidation.", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create a new streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to create a new streaming distribution with tags.", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "Location":{ + "shape":"string", + "documentation":"The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution created.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation." + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer." + }, + "ResponseCode":{ + "shape":"string", + "documentation":"The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation." + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000." + } + }, + "documentation":"A complex type that describes how you'd prefer CloudFront to respond to requests that result in either a 4xx or 5xx response. You can control whether a custom error page should be displayed, what the desired response code should be for this error page and how long should the error response be cached by CloudFront. If you don't want to specify any custom error responses, include only an empty CustomErrorResponses element. To delete all custom error responses in an existing distribution, update the distribution configuration and include only an empty CustomErrorResponses element. To add, change, or remove one or more custom error responses, update the distribution configuration and specify all of the custom error responses that you want to include in the updated distribution." + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom error responses for this distribution." + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of custom headers for this origin." + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"A complex type that contains the custom headers for this Origin." + } + }, + "documentation":"A complex type that contains the list of Custom Headers for each origin." + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"The HTTP port the custom origin listens on." + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"The HTTPS port the custom origin listens on." + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"The origin protocol policy to apply to your origin." + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + } + }, + "documentation":"A customer origin." + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior." + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL." + }, + "MinTTL":{ + "shape":"long", + "documentation":"The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false." + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "MaxTTL":{ + "shape":"long", + "documentation":"The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years)." + }, + "Compress":{ + "shape":"boolean", + "documentation":"Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version." + } + }, + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The origin access identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a origin access identity." + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a distribution." + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to delete a streaming distribution." + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"The number of invalidation batches currently in progress." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The current configuration information for the distribution." + } + }, + "documentation":"A distribution." + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The caller reference you attempted to create the distribution with is associated with another distribution.", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponse elements." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the distribution." + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"(Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution." + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version." + } + }, + "documentation":"A distribution Configuration." + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"A distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A distribution Configuration and a list of tags to be associated with the distribution." + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A distribution list." + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." + }, + "Origins":{ + "shape":"Origins", + "documentation":"A complex type that contains information about origins for this distribution." + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior." + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"A complex type that contains zero or more CacheBehavior elements." + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"A complex type that contains zero or more CustomErrorResponses elements." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"The Web ACL Id (if any) associated with the distribution." + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront distribution." + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

  • If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.
  • If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.
  • If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.
" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"A complex type that specifies how CloudFront handles cookies." + }, + "Headers":{ + "shape":"Headers", + "documentation":"A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior." + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"A complex type that specifies how CloudFront handles query strings, cookies and headers." + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content." + }, + "Quantity":{ + "shape":"integer", + "documentation":"When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items." + }, + "Items":{ + "shape":"LocationList", + "documentation":"A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes." + } + }, + "documentation":"A complex type that controls the countries in which your content is distributed. For more information about geo restriction, go to Customizing Error Responses in the Amazon CloudFront Developer Guide. CloudFront determines the location of your users using MaxMind GeoIP databases. For information about the accuracy of these databases, see How accurate are your GeoIP databases? on the MaxMind website." + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's configuration." + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The origin access identity's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an origin access identity's information." + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution configuration." + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a distribution's information." + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"The invalidation's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get an invalidation's information." + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"The invalidation's information." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"To request to get a streaming distribution configuration." + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"The request to get a streaming distribution's information." + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items." + }, + "Items":{ + "shape":"HeaderList", + "documentation":"Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items." + } + }, + "documentation":"A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior. For the headers that you specify, CloudFront also caches separate versions of a given object based on the header values in viewer requests; this is known as varying on headers. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to vary on the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value." + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Origin and CallerReference cannot be updated.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The value of Quantity and the size of Items do not match.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The argument is invalid.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The default root object file name is too big or contains an invalid character.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The If-Match version is missing or not valid for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The origin access identity is not valid or doesn't exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that Support Server Name Indication (SNI).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The relative path is too big, is not URL-encoded, or does not begin with a slash (/).", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified tagging for a CloudFront resource is invalid. For more information, see the error text.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the invalidation request. For example: IDFDVBD632BHDS5." + }, + "Status":{ + "shape":"string", + "documentation":"The status of the invalidation request. When the invalidation batch is finished, the status is Completed." + }, + "CreateTime":{ + "shape":"timestamp", + "documentation":"The date and time the invalidation request was first made." + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"The current invalidation information for the batch request." + } + }, + "documentation":"An invalidation." + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object." + }, + "CallerReference":{ + "shape":"string", + "documentation":"A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error." + } + }, + "documentation":"An invalidation batch." + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of invalidation batches that were created by the current AWS account." + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account." + } + }, + "documentation":"An invalidation list." + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The unique ID for an invalidation request." + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"The status of an invalidation request." + } + }, + "documentation":"Summary of an invalidation request." + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of active CloudFront key pairs for AwsAccountNumber." + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of origin access identities you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list origin access identities." + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"The CloudFrontOriginAccessIdentityList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify \"null\" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"The request to list distributions that are associated with a specified AWS WAF web ACL." + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your distributions." + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"The DistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of invalidation batches you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list invalidations." + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"Information about invalidation batches." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"The maximum number of streaming distributions you want in the response body.", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"The request to list your streaming distributions." + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"The StreamingDistributionList type." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"The request to list tags for a CloudFront resource." + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted." + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for the distribution." + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"This operation requires a body. Ensure that the body is present and the Content-Type header is set.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified origin access identity does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified invalidation does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"No origin exists with the specified Origin Id.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified CloudFront resource does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The specified streaming distribution does not exist.", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior." + }, + "DomainName":{ + "shape":"string", + "documentation":"Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com." + }, + "OriginPath":{ + "shape":"string", + "documentation":"An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName." + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"A complex type that contains information about the custom headers associated with this Origin." + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead." + } + }, + "documentation":"A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files.You must create at least one origin." + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"The header's name." + }, + "HeaderValue":{ + "shape":"string", + "documentation":"The header's value." + } + }, + "documentation":"A complex type that contains information related to a Header" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin." + } + }, + "documentation":"A complex type that contains the list of SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS." + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of origins for this distribution." + }, + "Items":{ + "shape":"OriginList", + "documentation":"A complex type that contains origins for this distribution." + } + }, + "documentation":"A complex type that contains information about origins for this distribution." + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of objects that you want to invalidate." + }, + "Items":{ + "shape":"PathList", + "documentation":"A complex type that contains a list of the objects that you want to invalidate." + } + }, + "documentation":"A complex type that contains information about the objects that you want to invalidate." + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"The precondition given in one or more of the request-header fields evaluated to false.", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"The number of whitelisted query string parameters for this cache behavior." + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"Optional: A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items." + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"A complex type that identifies ways in which you want to restrict distribution of your content." + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"The DNS name of the S3 origin." + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"Your S3 origin's origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity." + } + }, + "documentation":"A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead." + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number." + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber." + } + }, + "documentation":"A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any." + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the streaming distribution. For example: EGTXBD79H29TRA8." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net." + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs." + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The current configuration information for the streaming distribution." + } + }, + "documentation":"A streaming distribution." + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"Any comments you want to include about the streaming distribution." + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"A complex type that controls whether access logs are written for the streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"A complex type that contains information about price class for this streaming distribution." + }, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the streaming distribution is enabled to accept end user requests for content." + } + }, + "documentation":"The configuration for the streaming distribution." + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"A streaming distribution Configuration." + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements." + } + }, + "documentation":"A streaming distribution Configuration and a list of tags to be associated with the streaming distribution." + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"The value you provided for the Marker request parameter." + }, + "NextMarker":{ + "shape":"string", + "documentation":"If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off." + }, + "MaxItems":{ + "shape":"integer", + "documentation":"The value you provided for the MaxItems request parameter." + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of streaming distributions that were created by the current AWS account." + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account." + } + }, + "documentation":"A streaming distribution list." + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"The identifier for the distribution. For example: EDFDVBD632BHDS5." + }, + "ARN":{ + "shape":"string", + "documentation":"The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account Id." + }, + "Status":{ + "shape":"string", + "documentation":"Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system." + }, + "LastModifiedTime":{ + "shape":"timestamp", + "documentation":"The date and time the distribution was last modified." + }, + "DomainName":{ + "shape":"string", + "documentation":"The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net." + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution." + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution." + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "Comment":{ + "shape":"string", + "documentation":"The comment originally specified when this distribution was created." + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"Whether the distribution is enabled to accept end user requests for content." + } + }, + "documentation":"A summary of the information for an Amazon CloudFront streaming distribution." + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted." + }, + "Bucket":{ + "shape":"string", + "documentation":"The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com." + }, + "Prefix":{ + "shape":"string", + "documentation":"An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element." + } + }, + "documentation":"A complex type that controls whether access logs are written for this streaming distribution." + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + }, + "Value":{ + "shape":"TagValue", + "documentation":"A string that contains an optional Tag value. The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @." + } + }, + "documentation":"A complex type that contains Tag key and Tag value." + }, + "TagKey":{ + "type":"string", + "documentation":"A string that contains Tag key. The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"A complex type that contains Tag key elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"A complex type that contains zero or more Tag elements.", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to add tags to a CloudFront resource.", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"A complex type that contains Tag elements" + } + }, + "documentation":"A complex type that contains zero or more Tag elements." + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore cache behaviors for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore custom ssl certificates.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of origin access identities allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more cookie names in the whitelist than are allowed per cache behavior.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more CNAMEs than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"You cannot create anymore origins for the distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Processing your request would cause you to exceed the maximum number of streaming distributions allowed.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"Your request contains more trusted signers than are allowed per distribution.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"One or more of your trusted signers do not exist.", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId." + }, + "Quantity":{ + "shape":"integer", + "documentation":"The number of trusted signers for this cache behavior." + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items." + } + }, + "documentation":"A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution." + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"An ARN of a CloudFront resource.", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"A complex type that contains zero or more Tag key elements.", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + } + }, + "documentation":"The request to remove tags from a CloudFront resource.", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"The identity's configuration information.", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + }, + "Id":{ + "shape":"string", + "documentation":"The identity's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update an origin access identity.", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"The origin access identity's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"The distribution's configuration information.", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + }, + "Id":{ + "shape":"string", + "documentation":"The distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a distribution.", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"The distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"The streaming distribution's configuration information.", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-07/"} + }, + "Id":{ + "shape":"string", + "documentation":"The streaming distribution's id.", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"The request to update a streaming distribution.", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"The streaming distribution's information." + }, + "ETag":{ + "shape":"string", + "documentation":"The current version of the configuration. For example: E2QWRUHAPOMQZL.", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"The returned result of the corresponding request.", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId." + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate." + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate." + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate." + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion." + }, + "Certificate":{ + "shape":"string", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].", + "deprecated":true + } + }, + "documentation":"A complex type that contains information about viewer certificates for this distribution." + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

Amazon CloudFront is a global content delivery network (CDN) service that accelerates delivery of your websites, APIs, video content or other web assets. It integrates with other Amazon Web Services products to give developers and businesses an easy way to accelerate content to end users with no minimum usage commitments.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-07/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-09-07/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-07/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-29/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-09-29/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-29/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-29/service-2.json b/aws/dist/botocore/data/cloudfront/2016-09-29/service-2.json new file mode 100644 index 00000000..e1cbcb41 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-29/service-2.json @@ -0,0 +1,3497 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-09-29", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"

Creates a new web distribution. Send a GET request to the /CloudFront API version/distribution/distribution ID resource.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_09_29", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_09_29", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-29/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_09_29", + "http":{ + "method":"DELETE", + "requestUri":"/2016-09-29/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2016_09_29", + "http":{ + "method":"GET", + "requestUri":"/2016-09-29/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2016_09_29", + "http":{ + "method":"POST", + "requestUri":"/2016-09-29/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_09_29", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-29/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_09_29", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-29/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"} + ], + "documentation":"

Update a distribution.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_09_29", + "http":{ + "method":"PUT", + "requestUri":"/2016-09-29/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + } + }, + "documentation":"

A customer origin.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Do not add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

If you do not want to enable logging when you create a distribution, or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want to forward, and specify the header names in Name elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A complex type that contains one Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.

For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to cache your content based on values in the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items do not match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

" + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/CloudFront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers do not exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-09-29/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId.

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Do not specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: SSLv3 or TLSv1. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. Note the following:

  • If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is TLSv1 and can't be changed.

  • If you're using a custom certificate (if you specify a value for ACMCertificateArn or for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

Include one of these values to specify the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify one (and only one) of the three values. Do not specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

    If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

    • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

    • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

    You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

    • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

    • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

    For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field is deprecated. You can use one of the following: [ACMCertificateArn, IAMCertificateId, or CloudFrontDefaultCertificate].

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Which SSL/TLS certificate to use when viewers request objects using HTTPS

  • Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names

  • The minimum protocol version that you want CloudFront to use when communicating with viewers

For more information, see Using an HTTPS Connection to Access Your Objects in the Amazon Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2016-09-29/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-09-29/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-09-29/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-11-25/examples-1.json b/aws/dist/botocore/data/cloudfront/2016-11-25/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-11-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-11-25/paginators-1.json b/aws/dist/botocore/data/cloudfront/2016-11-25/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-11-25/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2016-11-25/service-2.json b/aws/dist/botocore/data/cloudfront/2016-11-25/service-2.json new file mode 100644 index 00000000..304d0ad8 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-11-25/service-2.json @@ -0,0 +1,3578 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-25", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2016-11-25" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"} + ], + "documentation":"

Creates a new web distribution. Send a GET request to the /CloudFront API version/distribution/distribution ID resource.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2016_11_25", + "http":{ + "method":"DELETE", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2016_11_25", + "http":{ + "method":"DELETE", + "requestUri":"/2016-11-25/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2016_11_25", + "http":{ + "method":"DELETE", + "requestUri":"/2016-11-25/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2016_11_25", + "http":{ + "method":"GET", + "requestUri":"/2016-11-25/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2016_11_25", + "http":{ + "method":"POST", + "requestUri":"/2016-11-25/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2016_11_25", + "http":{ + "method":"PUT", + "requestUri":"/2016-11-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2016_11_25", + "http":{ + "method":"PUT", + "requestUri":"/2016-11-25/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"} + ], + "documentation":"

Update a distribution.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2016_11_25", + "http":{ + "method":"PUT", + "requestUri":"/2016-11-25/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + } + }, + "documentation":"

A customer origin.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Do not add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket.

If you do not want to enable logging when you create a distribution, or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want to forward, and specify the header names in Name elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A complex type that contains one Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.

For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom Product header that has a value of either Acme or Apex, and you configure CloudFront to cache your content based on values in the Product header. CloudFront forwards the Product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items do not match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

" + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "LambdaFunctionARN":{ + "shape":"string", + "documentation":"

The ARN of the Lambda function.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. Valid values are:

  • viewer-request

  • origin-request

  • viewer-response

  • origin-response

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/CloudFront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers do not exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2016-11-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{"shape":"boolean"}, + "IAMCertificateId":{"shape":"string"}, + "ACMCertificateArn":{"shape":"string"}, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Do not specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: SSLv3 or TLSv1. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. Note the following:

  • If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is TLSv1 and can't be changed.

  • If you're using a custom certificate (if you specify a value for ACMCertificateArn or for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

Include one of these values to specify the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify one (and only one) of the three values. Do not specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

    If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

    • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

    • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

    You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

    • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

    • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

    For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field is deprecated. You can use one of the following: [ACMCertificateArn, IAMCertificateId, or CloudFrontDefaultCertificate].

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Which SSL/TLS certificate to use when viewers request objects using HTTPS

  • Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names

  • The minimum protocol version that you want CloudFront to use when communicating with viewers

For more information, see Using an HTTPS Connection to Access Your Objects in the Amazon Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2016-11-25/waiters-2.json b/aws/dist/botocore/data/cloudfront/2016-11-25/waiters-2.json new file mode 100644 index 00000000..6e044bc5 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2016-11-25/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 60, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-03-25/examples-1.json b/aws/dist/botocore/data/cloudfront/2017-03-25/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-03-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-03-25/paginators-1.json b/aws/dist/botocore/data/cloudfront/2017-03-25/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-03-25/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-03-25/service-2.json b/aws/dist/botocore/data/cloudfront/2017-03-25/service-2.json new file mode 100644 index 00000000..a424317e --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-03-25/service-2.json @@ -0,0 +1,3654 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-03-25", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2017-03-25" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"} + ], + "documentation":"

Creates a new web distribution. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2017_03_25", + "http":{ + "method":"DELETE", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2017_03_25", + "http":{ + "method":"DELETE", + "requestUri":"/2017-03-25/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteServiceLinkedRole":{ + "name":"DeleteServiceLinkedRole2017_03_25", + "http":{ + "method":"DELETE", + "requestUri":"/2017-03-25/service-linked-role/{RoleName}", + "responseCode":204 + }, + "input":{"shape":"DeleteServiceLinkedRoleRequest"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"AccessDenied"}, + {"shape":"ResourceInUse"}, + {"shape":"NoSuchResource"} + ] + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2017_03_25", + "http":{ + "method":"DELETE", + "requestUri":"/2017-03-25/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2017_03_25", + "http":{ + "method":"GET", + "requestUri":"/2017-03-25/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2017_03_25", + "http":{ + "method":"POST", + "requestUri":"/2017-03-25/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2017_03_25", + "http":{ + "method":"PUT", + "requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2017_03_25", + "http":{ + "method":"PUT", + "requestUri":"/2017-03-25/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"} + ], + "documentation":"

Updates the configuration for a web distribution. Perform the following steps.

For information about updating a distribution using the CloudFront console, see Creating or Updating a Web Distribution Using the CloudFront Console in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you need to get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include the desired changes. You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into the existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

    Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a distribution. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values you're actually specifying.
" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2017_03_25", + "http":{ + "method":"PUT", + "requestUri":"/2017-03-25/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation":"

A customer origin.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteServiceLinkedRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"string", + "location":"uri", + "locationName":"RoleName" + } + } + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

From this field, you can enable or disable the selected distribution.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items don't match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginKeepaliveTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginReadTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

" + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "LambdaFunctionARN":{ + "shape":"string", + "documentation":"

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "ResourceInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers don't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

For information about how and when to use IAMCertificateId, see ViewerCertificate.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

For information about how and when to use ACMCertificateArn, see ViewerCertificate.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify only one of the following values:

Don't specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2017-03-25/waiters-2.json b/aws/dist/botocore/data/cloudfront/2017-03-25/waiters-2.json new file mode 100644 index 00000000..edd74b2a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-03-25/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 30, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-10-30/examples-1.json b/aws/dist/botocore/data/cloudfront/2017-10-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-10-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-10-30/paginators-1.json b/aws/dist/botocore/data/cloudfront/2017-10-30/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-10-30/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2017-10-30/service-2.json b/aws/dist/botocore/data/cloudfront/2017-10-30/service-2.json new file mode 100644 index 00000000..3dad99bf --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-10-30/service-2.json @@ -0,0 +1,5187 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-30", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2017-10-30" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Creates a new web distribution. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateFieldLevelEncryptionConfig":{ + "name":"CreateFieldLevelEncryptionConfig2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/field-level-encryption", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, + {"shape":"TooManyFieldLevelEncryptionConfigs"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Create a new field-level encryption configuration.

" + }, + "CreateFieldLevelEncryptionProfile":{ + "name":"CreateFieldLevelEncryptionProfile2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/field-level-encryption-profile", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionProfiles"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Create a field-level encryption profile.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreatePublicKey":{ + "name":"CreatePublicKey2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/public-key", + "responseCode":201 + }, + "input":{"shape":"CreatePublicKeyRequest"}, + "output":{"shape":"CreatePublicKeyResult"}, + "errors":[ + {"shape":"PublicKeyAlreadyExists"}, + {"shape":"InvalidArgument"}, + {"shape":"TooManyPublicKeys"} + ], + "documentation":"

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteFieldLevelEncryptionConfig":{ + "name":"DeleteFieldLevelEncryptionConfig2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/field-level-encryption/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionConfigInUse"} + ], + "documentation":"

Remove a field-level encryption configuration.

" + }, + "DeleteFieldLevelEncryptionProfile":{ + "name":"DeleteFieldLevelEncryptionProfile2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/field-level-encryption-profile/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileInUse"} + ], + "documentation":"

Remove a field-level encryption profile.

" + }, + "DeletePublicKey":{ + "name":"DeletePublicKey2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/public-key/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeletePublicKeyRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"PublicKeyInUse"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Remove a public key you previously added to CloudFront.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2017_10_30", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-30/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetFieldLevelEncryption":{ + "name":"GetFieldLevelEncryption2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionRequest"}, + "output":{"shape":"GetFieldLevelEncryptionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionConfig":{ + "name":"GetFieldLevelEncryptionConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionProfile":{ + "name":"GetFieldLevelEncryptionProfile2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption-profile/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile information.

" + }, + "GetFieldLevelEncryptionProfileConfig":{ + "name":"GetFieldLevelEncryptionProfileConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile configuration information.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetPublicKey":{ + "name":"GetPublicKey2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/public-key/{Id}" + }, + "input":{"shape":"GetPublicKeyRequest"}, + "output":{"shape":"GetPublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Get the public key information.

" + }, + "GetPublicKeyConfig":{ + "name":"GetPublicKeyConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/public-key/{Id}/config" + }, + "input":{"shape":"GetPublicKeyConfigRequest"}, + "output":{"shape":"GetPublicKeyConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Return public key configuration informaation

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListFieldLevelEncryptionConfigs":{ + "name":"ListFieldLevelEncryptionConfigs2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption" + }, + "input":{"shape":"ListFieldLevelEncryptionConfigsRequest"}, + "output":{"shape":"ListFieldLevelEncryptionConfigsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all field-level encryption configurations that have been created in CloudFront for this account.

" + }, + "ListFieldLevelEncryptionProfiles":{ + "name":"ListFieldLevelEncryptionProfiles2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/field-level-encryption-profile" + }, + "input":{"shape":"ListFieldLevelEncryptionProfilesRequest"}, + "output":{"shape":"ListFieldLevelEncryptionProfilesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListPublicKeys":{ + "name":"ListPublicKeys2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/public-key" + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all public keys that have been added to CloudFront for this account.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2017_10_30", + "http":{ + "method":"GET", + "requestUri":"/2017-10-30/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2017_10_30", + "http":{ + "method":"POST", + "requestUri":"/2017-10-30/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Updates the configuration for a web distribution. Perform the following steps.

For information about updating a distribution using the CloudFront console, see Creating or Updating a Web Distribution Using the CloudFront Console in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you need to get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include the desired changes. You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into the existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

    Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a distribution. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values you're actually specifying.
" + }, + "UpdateFieldLevelEncryptionConfig":{ + "name":"UpdateFieldLevelEncryptionConfig2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/field-level-encryption/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Update a field-level encryption configuration.

" + }, + "UpdateFieldLevelEncryptionProfile":{ + "name":"UpdateFieldLevelEncryptionProfile2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Update a field-level encryption profile.

" + }, + "UpdatePublicKey":{ + "name":"UpdatePublicKey2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/public-key/{Id}/config" + }, + "input":{"shape":"UpdatePublicKeyRequest"}, + "output":{"shape":"UpdatePublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CannotChangeImmutablePublicKeyFields"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"IllegalUpdate"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Update public key information. Note that the only value you can change is the comment.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2017_10_30", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-30/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{"shape":"string"} + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CannotChangeImmutablePublicKeyFields":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You can't change the value of a public key.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "ContentTypeProfile":{ + "type":"structure", + "required":[ + "Format", + "ContentType" + ], + "members":{ + "Format":{ + "shape":"Format", + "documentation":"

The format for a field-level encryption content type-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

The profile ID for a field-level encryption content type-profile mapping.

" + }, + "ContentType":{ + "shape":"string", + "documentation":"

The content type for a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

A field-level encryption content type profile.

" + }, + "ContentTypeProfileConfig":{ + "type":"structure", + "required":["ForwardWhenContentTypeIsUnknown"], + "members":{ + "ForwardWhenContentTypeIsUnknown":{ + "shape":"boolean", + "documentation":"

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

" + }, + "ContentTypeProfiles":{ + "shape":"ContentTypeProfiles", + "documentation":"

The configuration for a field-level encryption content type-profile.

" + } + }, + "documentation":"

The configuration for a field-level encryption content type-profile mapping.

" + }, + "ContentTypeProfileList":{ + "type":"list", + "member":{ + "shape":"ContentTypeProfile", + "locationName":"ContentTypeProfile" + } + }, + "ContentTypeProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption content type-profile mappings.

" + }, + "Items":{ + "shape":"ContentTypeProfileList", + "documentation":"

Items in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Field-level encryption content type-profile.

" + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionConfig"], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

The request to create a new field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "CreateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Returned when you create a new field-level encryption configuration.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "CreateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionProfileConfig"], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

The request to create a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "CreateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Returned when you create a new field-level encryption profile.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreatePublicKeyRequest":{ + "type":"structure", + "required":["PublicKeyConfig"], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

The request to add a public key to CloudFront.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "payload":"PublicKeyConfig" + }, + "CreatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Returned when you add a public key.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation":"

A customer origin.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{"shape":"string"} + }, + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID of the profile you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeletePublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the public key you want to remove from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes map to CloudFront regions, see Amazon CloudFront Pricing.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

From this field, you can enable or disable the selected distribution.

If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EncryptionEntities":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of field pattern items in a field-level encryption content type-profile mapping.

" + }, + "Items":{ + "shape":"EncryptionEntityList", + "documentation":"

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + }, + "EncryptionEntity":{ + "type":"structure", + "required":[ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members":{ + "PublicKeyId":{ + "shape":"string", + "documentation":"

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

" + }, + "ProviderId":{ + "shape":"string", + "documentation":"

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

" + }, + "FieldPatterns":{ + "shape":"FieldPatterns", + "documentation":"

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + }, + "EncryptionEntityList":{ + "type":"list", + "member":{ + "shape":"EncryptionEntity", + "locationName":"EncryptionEntity" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "FieldLevelEncryption":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption configuration was changed.

" + }, + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfig":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the configuration.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfigAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionConfigInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of elements you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption items.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionSummaryList", + "documentation":"

An array of field-level encryption items.

" + } + }, + "documentation":"

List of field-level encrpytion configurations.

" + }, + "FieldLevelEncryptionProfile":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption profile was updated.

" + }, + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

" + } + }, + "documentation":"

A complex data type for field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileConfig":{ + "type":"structure", + "required":[ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members":{ + "Name":{ + "shape":"string", + "documentation":"

Profile name for the field-level encryption profile.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + } + }, + "documentation":"

A complex data type of profiles for the field-level encryption.

" + }, + "FieldLevelEncryptionProfileInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption profiles.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionProfileSummaryList", + "documentation":"

The field-level encryption profile items.

" + } + }, + "documentation":"

List of field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum size of a profile for field-level encryption was exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FieldLevelEncryptionProfileSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for the field-level encryption profile summary.

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

The time when the the field-level encryption profile summary was last updated.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for the field-level encryption profile summary.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile summary.

" + } + }, + "documentation":"

The field-level encryption profile summary.

" + }, + "FieldLevelEncryptionProfileSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionProfileSummary", + "locationName":"FieldLevelEncryptionProfileSummary" + } + }, + "FieldLevelEncryptionSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID of a field-level encryption item.

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

The last time that the summary of field-level encryption items was modified.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the field-level encryption item.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A summary of a query argument-profile mapping.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A summary of a content type-profile mapping.

" + } + }, + "documentation":"

A summary of a field-level encryption item.

" + }, + "FieldLevelEncryptionSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionSummary", + "locationName":"FieldLevelEncryptionSummary" + } + }, + "FieldPatternList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"FieldPattern" + } + }, + "FieldPatterns":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption field patterns.

" + }, + "Items":{ + "shape":"FieldPatternList", + "documentation":"

An array of the field-level encryption field patterns.

" + } + }, + "documentation":"

A complex data type that includes the field patterns to match for field-level encryption.

" + }, + "Format":{ + "type":"string", + "enum":["URLEncoded"] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "GetFieldLevelEncryptionProfileConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Return the field-level encryption profile configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "GetFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the field-level encryption profile information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "GetFieldLevelEncryptionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetPublicKeyConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key configuration.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyConfigResult":{ + "type":"structure", + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Return the result for the public key configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKeyConfig" + }, + "GetPublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items don't match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginKeepaliveTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginReadTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

" + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionARN":{"type":"string"}, + "LambdaFunctionAssociation":{ + "type":"structure", + "required":[ + "LambdaFunctionARN", + "EventType" + ], + "members":{ + "LambdaFunctionARN":{ + "shape":"LambdaFunctionARN", + "documentation":"

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListFieldLevelEncryptionConfigsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption configurations you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionConfigsResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionList":{ + "shape":"FieldLevelEncryptionList", + "documentation":"

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionList" + }, + "ListFieldLevelEncryptionProfilesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionProfilesResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileList":{ + "shape":"FieldLevelEncryptionProfileList", + "documentation":"

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionProfileList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListPublicKeysRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of public keys you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListPublicKeysResult":{ + "type":"structure", + "members":{ + "PublicKeyList":{ + "shape":"PublicKeyList", + "documentation":"

Returns a list of all public keys that have been added to CloudFront for this account.

" + } + }, + "payload":"PublicKeyList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionProfile":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchPublicKey":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "PublicKey":{ + "type":"structure", + "required":[ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique ID assigned to a public key you've added to CloudFront.

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

A time you added a public key to CloudFront.

" + }, + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A complex data type of public keys you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Name", + "EncodedKey" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Name":{ + "shape":"string", + "documentation":"

The name for a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about a public key.

" + } + }, + "documentation":"

Information about a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of public keys you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of public keys you added to CloudFront to use with features like field-level encryption.

" + }, + "Items":{ + "shape":"PublicKeySummaryList", + "documentation":"

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A list of public keys you've added to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for public key information summary.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for public key information summary.

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

Creation time for public key information summary.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

Encoded key for public key information summary.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Comment for public key information summary.

" + } + }, + "documentation":"

Public key information summary.

" + }, + "PublicKeySummaryList":{ + "type":"list", + "member":{ + "shape":"PublicKeySummary", + "locationName":"PublicKeySummary" + } + }, + "QueryArgProfile":{ + "type":"structure", + "required":[ + "QueryArg", + "ProfileId" + ], + "members":{ + "QueryArg":{ + "shape":"string", + "documentation":"

Query argument for field-level encryption query argument-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

ID of profile to use for field-level encryption query argument-profile mapping

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileConfig":{ + "type":"structure", + "required":["ForwardWhenQueryArgProfileIsUnknown"], + "members":{ + "ForwardWhenQueryArgProfileIsUnknown":{ + "shape":"boolean", + "documentation":"

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

" + }, + "QueryArgProfiles":{ + "shape":"QueryArgProfiles", + "documentation":"

Profiles specified for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Configuration for query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileEmpty":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No profile specified for the field-level encryption query argument.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QueryArgProfileList":{ + "type":"list", + "member":{ + "shape":"QueryArgProfile", + "locationName":"QueryArgProfile" + } + }, + "QueryArgProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of profiles for query argument-profile mapping for field-level encryption.

" + }, + "Items":{ + "shape":"QueryArgProfileList", + "documentation":"

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionConfigs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of configurations for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionContentTypeProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of content type profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionEncryptionEntities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of encryption entities for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionFieldPatterns":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of field patterns for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionQueryArgProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of query arg profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyPublicKeys":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers don't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Request to update a field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to update.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "UpdateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the results of updating the configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "UpdateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Request to update a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the field-level encryption profile request.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "UpdateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the results of updating the profile.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The result of the field-level encryption profile request.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "UpdatePublicKeyRequest":{ + "type":"structure", + "required":[ + "PublicKeyConfig", + "Id" + ], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Request to update public key information.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

ID of the public key to be updated.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"PublicKeyConfig" + }, + "UpdatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the results of updating the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the update public key result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-10-30/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

For information about how and when to use IAMCertificateId, see ViewerCertificate.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

For information about how and when to use ACMCertificateArn, see ViewerCertificate.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify only one of the following values:

Don't specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2017-10-30/waiters-2.json b/aws/dist/botocore/data/cloudfront/2017-10-30/waiters-2.json new file mode 100644 index 00000000..edd74b2a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2017-10-30/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 30, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-06-18/examples-1.json b/aws/dist/botocore/data/cloudfront/2018-06-18/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-06-18/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-06-18/paginators-1.json b/aws/dist/botocore/data/cloudfront/2018-06-18/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-06-18/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-06-18/service-2.json b/aws/dist/botocore/data/cloudfront/2018-06-18/service-2.json new file mode 100644 index 00000000..74027b2e --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-06-18/service-2.json @@ -0,0 +1,5197 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-06-18", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2018-06-18" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateFieldLevelEncryptionConfig":{ + "name":"CreateFieldLevelEncryptionConfig2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/field-level-encryption", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, + {"shape":"TooManyFieldLevelEncryptionConfigs"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Create a new field-level encryption configuration.

" + }, + "CreateFieldLevelEncryptionProfile":{ + "name":"CreateFieldLevelEncryptionProfile2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/field-level-encryption-profile", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionProfiles"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Create a field-level encryption profile.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreatePublicKey":{ + "name":"CreatePublicKey2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/public-key", + "responseCode":201 + }, + "input":{"shape":"CreatePublicKeyRequest"}, + "output":{"shape":"CreatePublicKeyResult"}, + "errors":[ + {"shape":"PublicKeyAlreadyExists"}, + {"shape":"InvalidArgument"}, + {"shape":"TooManyPublicKeys"} + ], + "documentation":"

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteFieldLevelEncryptionConfig":{ + "name":"DeleteFieldLevelEncryptionConfig2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/field-level-encryption/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionConfigInUse"} + ], + "documentation":"

Remove a field-level encryption configuration.

" + }, + "DeleteFieldLevelEncryptionProfile":{ + "name":"DeleteFieldLevelEncryptionProfile2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/field-level-encryption-profile/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileInUse"} + ], + "documentation":"

Remove a field-level encryption profile.

" + }, + "DeletePublicKey":{ + "name":"DeletePublicKey2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/public-key/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeletePublicKeyRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"PublicKeyInUse"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Remove a public key you previously added to CloudFront.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2018_06_18", + "http":{ + "method":"DELETE", + "requestUri":"/2018-06-18/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetFieldLevelEncryption":{ + "name":"GetFieldLevelEncryption2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionRequest"}, + "output":{"shape":"GetFieldLevelEncryptionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionConfig":{ + "name":"GetFieldLevelEncryptionConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionProfile":{ + "name":"GetFieldLevelEncryptionProfile2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption-profile/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile information.

" + }, + "GetFieldLevelEncryptionProfileConfig":{ + "name":"GetFieldLevelEncryptionProfileConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile configuration information.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetPublicKey":{ + "name":"GetPublicKey2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/public-key/{Id}" + }, + "input":{"shape":"GetPublicKeyRequest"}, + "output":{"shape":"GetPublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Get the public key information.

" + }, + "GetPublicKeyConfig":{ + "name":"GetPublicKeyConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/public-key/{Id}/config" + }, + "input":{"shape":"GetPublicKeyConfigRequest"}, + "output":{"shape":"GetPublicKeyConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Return public key configuration informaation

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListFieldLevelEncryptionConfigs":{ + "name":"ListFieldLevelEncryptionConfigs2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption" + }, + "input":{"shape":"ListFieldLevelEncryptionConfigsRequest"}, + "output":{"shape":"ListFieldLevelEncryptionConfigsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all field-level encryption configurations that have been created in CloudFront for this account.

" + }, + "ListFieldLevelEncryptionProfiles":{ + "name":"ListFieldLevelEncryptionProfiles2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/field-level-encryption-profile" + }, + "input":{"shape":"ListFieldLevelEncryptionProfilesRequest"}, + "output":{"shape":"ListFieldLevelEncryptionProfilesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListPublicKeys":{ + "name":"ListPublicKeys2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/public-key" + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all public keys that have been added to CloudFront for this account.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2018_06_18", + "http":{ + "method":"GET", + "requestUri":"/2018-06-18/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2018_06_18", + "http":{ + "method":"POST", + "requestUri":"/2018-06-18/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Updates the configuration for a web distribution.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you must get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

    When you edit the XML file, be aware of the following:

    • You must strip out the ETag parameter that is returned.

    • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

    • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

" + }, + "UpdateFieldLevelEncryptionConfig":{ + "name":"UpdateFieldLevelEncryptionConfig2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/field-level-encryption/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Update a field-level encryption configuration.

" + }, + "UpdateFieldLevelEncryptionProfile":{ + "name":"UpdateFieldLevelEncryptionProfile2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Update a field-level encryption profile.

" + }, + "UpdatePublicKey":{ + "name":"UpdatePublicKey2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/public-key/{Id}/config" + }, + "input":{"shape":"UpdatePublicKeyRequest"}, + "output":{"shape":"UpdatePublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CannotChangeImmutablePublicKeyFields"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"IllegalUpdate"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Update public key information. Note that the only value you can change is the comment.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2018_06_18", + "http":{ + "method":"PUT", + "requestUri":"/2018-06-18/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CannotChangeImmutablePublicKeyFields":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You can't change the value of a public key.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "ContentTypeProfile":{ + "type":"structure", + "required":[ + "Format", + "ContentType" + ], + "members":{ + "Format":{ + "shape":"Format", + "documentation":"

The format for a field-level encryption content type-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

The profile ID for a field-level encryption content type-profile mapping.

" + }, + "ContentType":{ + "shape":"string", + "documentation":"

The content type for a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

A field-level encryption content type profile.

" + }, + "ContentTypeProfileConfig":{ + "type":"structure", + "required":["ForwardWhenContentTypeIsUnknown"], + "members":{ + "ForwardWhenContentTypeIsUnknown":{ + "shape":"boolean", + "documentation":"

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

" + }, + "ContentTypeProfiles":{ + "shape":"ContentTypeProfiles", + "documentation":"

The configuration for a field-level encryption content type-profile.

" + } + }, + "documentation":"

The configuration for a field-level encryption content type-profile mapping.

" + }, + "ContentTypeProfileList":{ + "type":"list", + "member":{ + "shape":"ContentTypeProfile", + "locationName":"ContentTypeProfile" + } + }, + "ContentTypeProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption content type-profile mappings.

" + }, + "Items":{ + "shape":"ContentTypeProfileList", + "documentation":"

Items in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Field-level encryption content type-profile.

" + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionConfig"], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

The request to create a new field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "CreateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Returned when you create a new field-level encryption configuration.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "CreateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionProfileConfig"], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

The request to create a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "CreateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Returned when you create a new field-level encryption profile.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreatePublicKeyRequest":{ + "type":"structure", + "required":["PublicKeyConfig"], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

The request to add a public key to CloudFront.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "payload":"PublicKeyConfig" + }, + "CreatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Returned when you add a public key.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation":"

A customer origin or an Amazon S3 bucket configured as a website endpoint.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID of the profile you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeletePublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the public key you want to remove from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value you already sent in a previous request to create a distribution, and if the content of the DistributionConfig is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.

If CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

From this field, you can enable or disable the selected distribution.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{"shape":"ViewerCertificate"}, + "Restrictions":{"shape":"Restrictions"}, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EncryptionEntities":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of field pattern items in a field-level encryption content type-profile mapping.

" + }, + "Items":{ + "shape":"EncryptionEntityList", + "documentation":"

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + }, + "EncryptionEntity":{ + "type":"structure", + "required":[ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members":{ + "PublicKeyId":{ + "shape":"string", + "documentation":"

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

" + }, + "ProviderId":{ + "shape":"string", + "documentation":"

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

" + }, + "FieldPatterns":{ + "shape":"FieldPatterns", + "documentation":"

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + }, + "EncryptionEntityList":{ + "type":"list", + "member":{ + "shape":"EncryptionEntity", + "locationName":"EncryptionEntity" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "FieldLevelEncryption":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption configuration was changed.

" + }, + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfig":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the configuration.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfigAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionConfigInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of elements you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption items.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionSummaryList", + "documentation":"

An array of field-level encryption items.

" + } + }, + "documentation":"

List of field-level encrpytion configurations.

" + }, + "FieldLevelEncryptionProfile":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption profile was updated.

" + }, + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

" + } + }, + "documentation":"

A complex data type for field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileConfig":{ + "type":"structure", + "required":[ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members":{ + "Name":{ + "shape":"string", + "documentation":"

Profile name for the field-level encryption profile.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + } + }, + "documentation":"

A complex data type of profiles for the field-level encryption.

" + }, + "FieldLevelEncryptionProfileInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption profiles.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionProfileSummaryList", + "documentation":"

The field-level encryption profile items.

" + } + }, + "documentation":"

List of field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum size of a profile for field-level encryption was exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FieldLevelEncryptionProfileSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for the field-level encryption profile summary.

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

The time when the the field-level encryption profile summary was last updated.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for the field-level encryption profile summary.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile summary.

" + } + }, + "documentation":"

The field-level encryption profile summary.

" + }, + "FieldLevelEncryptionProfileSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionProfileSummary", + "locationName":"FieldLevelEncryptionProfileSummary" + } + }, + "FieldLevelEncryptionSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID of a field-level encryption item.

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

The last time that the summary of field-level encryption items was modified.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the field-level encryption item.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A summary of a query argument-profile mapping.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A summary of a content type-profile mapping.

" + } + }, + "documentation":"

A summary of a field-level encryption item.

" + }, + "FieldLevelEncryptionSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionSummary", + "locationName":"FieldLevelEncryptionSummary" + } + }, + "FieldPatternList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"FieldPattern" + } + }, + "FieldPatterns":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption field patterns.

" + }, + "Items":{ + "shape":"FieldPatternList", + "documentation":"

An array of the field-level encryption field patterns.

" + } + }, + "documentation":"

A complex data type that includes the field patterns to match for field-level encryption.

" + }, + "Format":{ + "type":"string", + "enum":["URLEncoded"] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "GetFieldLevelEncryptionProfileConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Return the field-level encryption profile configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "GetFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the field-level encryption profile information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "GetFieldLevelEncryptionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetPublicKeyConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key configuration.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyConfigResult":{ + "type":"structure", + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Return the result for the public key configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKeyConfig" + }, + "GetPublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items don't match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginKeepaliveTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginReadTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

" + }, + "CreateTime":{"shape":"timestamp"}, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionARN":{"type":"string"}, + "LambdaFunctionAssociation":{ + "type":"structure", + "required":[ + "LambdaFunctionARN", + "EventType" + ], + "members":{ + "LambdaFunctionARN":{ + "shape":"LambdaFunctionARN", + "documentation":"

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + }, + "IncludeBody":{ + "shape":"boolean", + "documentation":"

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListFieldLevelEncryptionConfigsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption configurations you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionConfigsResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionList":{ + "shape":"FieldLevelEncryptionList", + "documentation":"

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionList" + }, + "ListFieldLevelEncryptionProfilesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionProfilesResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileList":{ + "shape":"FieldLevelEncryptionProfileList", + "documentation":"

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionProfileList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListPublicKeysRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of public keys you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListPublicKeysResult":{ + "type":"structure", + "members":{ + "PublicKeyList":{ + "shape":"PublicKeyList", + "documentation":"

Returns a list of all public keys that have been added to CloudFront for this account.

" + } + }, + "payload":"PublicKeyList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionProfile":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchPublicKey":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.

For the current limit on the number of origins that you can create for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "PublicKey":{ + "type":"structure", + "required":[ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique ID assigned to a public key you've added to CloudFront.

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

A time you added a public key to CloudFront.

" + }, + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A complex data type of public keys you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Name", + "EncodedKey" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Name":{ + "shape":"string", + "documentation":"

The name for a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about a public key.

" + } + }, + "documentation":"

Information about a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of public keys you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of public keys you added to CloudFront to use with features like field-level encryption.

" + }, + "Items":{ + "shape":"PublicKeySummaryList", + "documentation":"

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A list of public keys you've added to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for public key information summary.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for public key information summary.

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

Creation time for public key information summary.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

Encoded key for public key information summary.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Comment for public key information summary.

" + } + }, + "documentation":"

Public key information summary.

" + }, + "PublicKeySummaryList":{ + "type":"list", + "member":{ + "shape":"PublicKeySummary", + "locationName":"PublicKeySummary" + } + }, + "QueryArgProfile":{ + "type":"structure", + "required":[ + "QueryArg", + "ProfileId" + ], + "members":{ + "QueryArg":{ + "shape":"string", + "documentation":"

Query argument for field-level encryption query argument-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

ID of profile to use for field-level encryption query argument-profile mapping

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileConfig":{ + "type":"structure", + "required":["ForwardWhenQueryArgProfileIsUnknown"], + "members":{ + "ForwardWhenQueryArgProfileIsUnknown":{ + "shape":"boolean", + "documentation":"

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

" + }, + "QueryArgProfiles":{ + "shape":"QueryArgProfiles", + "documentation":"

Profiles specified for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Configuration for query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileEmpty":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No profile specified for the field-level encryption query argument.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QueryArgProfileList":{ + "type":"list", + "member":{ + "shape":"QueryArgProfile", + "locationName":"QueryArgProfile" + } + }, + "QueryArgProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of profiles for query argument-profile mapping for field-level encryption.

" + }, + "Items":{ + "shape":"QueryArgProfileList", + "documentation":"

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{"shape":"string"}, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value that you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{"shape":"PriceClass"}, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionConfigs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of configurations for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionContentTypeProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of content type profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionEncryptionEntities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of encryption entities for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionFieldPatterns":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of field patterns for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionQueryArgProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of query arg profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyPublicKeys":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers don't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Request to update a field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to update.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "UpdateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the results of updating the configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "UpdateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Request to update a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the field-level encryption profile request.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "UpdateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the results of updating the profile.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The result of the field-level encryption profile request.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "UpdatePublicKeyRequest":{ + "type":"structure", + "required":[ + "PublicKeyConfig", + "Id" + ], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Request to update public key information.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

ID of the public key to be updated.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"PublicKeyConfig" + }, + "UpdatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the results of updating the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the update public key result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-06-18/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

For information about how and when to use IAMCertificateId, see ViewerCertificate.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

For information about how and when to use ACMCertificateArn, see ViewerCertificate.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify only one of the following values:

Don't specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2018-06-18/waiters-2.json b/aws/dist/botocore/data/cloudfront/2018-06-18/waiters-2.json new file mode 100644 index 00000000..edd74b2a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-06-18/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 30, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-11-05/examples-1.json b/aws/dist/botocore/data/cloudfront/2018-11-05/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-11-05/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-11-05/paginators-1.json b/aws/dist/botocore/data/cloudfront/2018-11-05/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-11-05/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2018-11-05/service-2.json b/aws/dist/botocore/data/cloudfront/2018-11-05/service-2.json new file mode 100644 index 00000000..e303f3d0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-11-05/service-2.json @@ -0,0 +1,5368 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-11-05", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2018-11-05" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

If you are using Adobe Flash Media Server's RTMP protocol, you set up a different kind of CloudFront distribution. For more information, see CreateStreamingDistribution.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateFieldLevelEncryptionConfig":{ + "name":"CreateFieldLevelEncryptionConfig2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/field-level-encryption", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, + {"shape":"TooManyFieldLevelEncryptionConfigs"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Create a new field-level encryption configuration.

" + }, + "CreateFieldLevelEncryptionProfile":{ + "name":"CreateFieldLevelEncryptionProfile2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/field-level-encryption-profile", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionProfiles"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Create a field-level encryption profile.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreatePublicKey":{ + "name":"CreatePublicKey2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/public-key", + "responseCode":201 + }, + "input":{"shape":"CreatePublicKeyRequest"}, + "output":{"shape":"CreatePublicKeyResult"}, + "errors":[ + {"shape":"PublicKeyAlreadyExists"}, + {"shape":"InvalidArgument"}, + {"shape":"TooManyPublicKeys"} + ], + "documentation":"

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new web distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteFieldLevelEncryptionConfig":{ + "name":"DeleteFieldLevelEncryptionConfig2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/field-level-encryption/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionConfigInUse"} + ], + "documentation":"

Remove a field-level encryption configuration.

" + }, + "DeleteFieldLevelEncryptionProfile":{ + "name":"DeleteFieldLevelEncryptionProfile2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/field-level-encryption-profile/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileInUse"} + ], + "documentation":"

Remove a field-level encryption profile.

" + }, + "DeletePublicKey":{ + "name":"DeletePublicKey2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/public-key/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeletePublicKeyRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"PublicKeyInUse"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Remove a public key you previously added to CloudFront.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2018_11_05", + "http":{ + "method":"DELETE", + "requestUri":"/2018-11-05/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetFieldLevelEncryption":{ + "name":"GetFieldLevelEncryption2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionRequest"}, + "output":{"shape":"GetFieldLevelEncryptionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionConfig":{ + "name":"GetFieldLevelEncryptionConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionProfile":{ + "name":"GetFieldLevelEncryptionProfile2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption-profile/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile information.

" + }, + "GetFieldLevelEncryptionProfileConfig":{ + "name":"GetFieldLevelEncryptionProfileConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile configuration information.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetPublicKey":{ + "name":"GetPublicKey2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/public-key/{Id}" + }, + "input":{"shape":"GetPublicKeyRequest"}, + "output":{"shape":"GetPublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Get the public key information.

" + }, + "GetPublicKeyConfig":{ + "name":"GetPublicKeyConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/public-key/{Id}/config" + }, + "input":{"shape":"GetPublicKeyConfigRequest"}, + "output":{"shape":"GetPublicKeyConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Return public key configuration informaation

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListFieldLevelEncryptionConfigs":{ + "name":"ListFieldLevelEncryptionConfigs2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption" + }, + "input":{"shape":"ListFieldLevelEncryptionConfigsRequest"}, + "output":{"shape":"ListFieldLevelEncryptionConfigsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all field-level encryption configurations that have been created in CloudFront for this account.

" + }, + "ListFieldLevelEncryptionProfiles":{ + "name":"ListFieldLevelEncryptionProfiles2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/field-level-encryption-profile" + }, + "input":{"shape":"ListFieldLevelEncryptionProfilesRequest"}, + "output":{"shape":"ListFieldLevelEncryptionProfilesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListPublicKeys":{ + "name":"ListPublicKeys2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/public-key" + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all public keys that have been added to CloudFront for this account.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2018_11_05", + "http":{ + "method":"GET", + "requestUri":"/2018-11-05/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2018_11_05", + "http":{ + "method":"POST", + "requestUri":"/2018-11-05/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Updates the configuration for a web distribution.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you must get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

    When you edit the XML file, be aware of the following:

    • You must strip out the ETag parameter that is returned.

    • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

    • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

" + }, + "UpdateFieldLevelEncryptionConfig":{ + "name":"UpdateFieldLevelEncryptionConfig2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/field-level-encryption/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Update a field-level encryption configuration.

" + }, + "UpdateFieldLevelEncryptionProfile":{ + "name":"UpdateFieldLevelEncryptionProfile2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Update a field-level encryption profile.

" + }, + "UpdatePublicKey":{ + "name":"UpdatePublicKey2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/public-key/{Id}/config" + }, + "input":{"shape":"UpdatePublicKeyRequest"}, + "output":{"shape":"UpdatePublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CannotChangeImmutablePublicKeyFields"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"IllegalUpdate"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Update public key information. Note that the only value you can change is the comment.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2018_11_05", + "http":{ + "method":"PUT", + "requestUri":"/2018-11-05/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this RTMP distribution have active CloudFront key pairs. If not, Enabled is false.

For more information, see ActiveTrustedSigners.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CannotChangeImmutablePublicKeyFields":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You can't change the value of a public key.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "ContentTypeProfile":{ + "type":"structure", + "required":[ + "Format", + "ContentType" + ], + "members":{ + "Format":{ + "shape":"Format", + "documentation":"

The format for a field-level encryption content type-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

The profile ID for a field-level encryption content type-profile mapping.

" + }, + "ContentType":{ + "shape":"string", + "documentation":"

The content type for a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

A field-level encryption content type profile.

" + }, + "ContentTypeProfileConfig":{ + "type":"structure", + "required":["ForwardWhenContentTypeIsUnknown"], + "members":{ + "ForwardWhenContentTypeIsUnknown":{ + "shape":"boolean", + "documentation":"

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

" + }, + "ContentTypeProfiles":{ + "shape":"ContentTypeProfiles", + "documentation":"

The configuration for a field-level encryption content type-profile.

" + } + }, + "documentation":"

The configuration for a field-level encryption content type-profile mapping.

" + }, + "ContentTypeProfileList":{ + "type":"list", + "member":{ + "shape":"ContentTypeProfile", + "locationName":"ContentTypeProfile" + } + }, + "ContentTypeProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption content type-profile mappings.

" + }, + "Items":{ + "shape":"ContentTypeProfileList", + "documentation":"

Items in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Field-level encryption content type-profile.

" + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see Amazon CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create a new origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionConfig"], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

The request to create a new field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "CreateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Returned when you create a new field-level encryption configuration.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "CreateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionProfileConfig"], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

The request to create a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "CreateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Returned when you create a new field-level encryption profile.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreatePublicKeyRequest":{ + "type":"structure", + "required":["PublicKeyConfig"], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

The request to add a public key to CloudFront.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "payload":"PublicKeyConfig" + }, + "CreatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Returned when you add a public key.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation":"

A customer origin or an Amazon S3 bucket configured as a website endpoint.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{"shape":"long"}, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID of the profile you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeletePublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the public key you want to remove from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + } + }, + "documentation":"

The distribution's information.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups":{ + "shape":"OriginGroups", + "documentation":"

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

From this field, you can enable or disable the selected distribution.

" + }, + "ViewerCertificate":{ + "shape":"ViewerCertificate", + "documentation":"

" + }, + "Restrictions":{ + "shape":"Restrictions", + "documentation":"

" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups":{ + "shape":"OriginGroups", + "documentation":"

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{ + "shape":"ViewerCertificate", + "documentation":"

" + }, + "Restrictions":{ + "shape":"Restrictions", + "documentation":"

" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EncryptionEntities":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of field pattern items in a field-level encryption content type-profile mapping.

" + }, + "Items":{ + "shape":"EncryptionEntityList", + "documentation":"

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + }, + "EncryptionEntity":{ + "type":"structure", + "required":[ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members":{ + "PublicKeyId":{ + "shape":"string", + "documentation":"

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

" + }, + "ProviderId":{ + "shape":"string", + "documentation":"

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

" + }, + "FieldPatterns":{ + "shape":"FieldPatterns", + "documentation":"

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + }, + "EncryptionEntityList":{ + "type":"list", + "member":{ + "shape":"EncryptionEntity", + "locationName":"EncryptionEntity" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "FieldLevelEncryption":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption configuration was changed.

" + }, + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfig":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the configuration.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfigAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionConfigInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of elements you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption items.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionSummaryList", + "documentation":"

An array of field-level encryption items.

" + } + }, + "documentation":"

List of field-level encrpytion configurations.

" + }, + "FieldLevelEncryptionProfile":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption profile was updated.

" + }, + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

" + } + }, + "documentation":"

A complex data type for field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileConfig":{ + "type":"structure", + "required":[ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members":{ + "Name":{ + "shape":"string", + "documentation":"

Profile name for the field-level encryption profile.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + } + }, + "documentation":"

A complex data type of profiles for the field-level encryption.

" + }, + "FieldLevelEncryptionProfileInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption profiles.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionProfileSummaryList", + "documentation":"

The field-level encryption profile items.

" + } + }, + "documentation":"

List of field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum size of a profile for field-level encryption was exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FieldLevelEncryptionProfileSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for the field-level encryption profile summary.

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

The time when the the field-level encryption profile summary was last updated.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for the field-level encryption profile summary.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile summary.

" + } + }, + "documentation":"

The field-level encryption profile summary.

" + }, + "FieldLevelEncryptionProfileSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionProfileSummary", + "locationName":"FieldLevelEncryptionProfileSummary" + } + }, + "FieldLevelEncryptionSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID of a field-level encryption item.

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

The last time that the summary of field-level encryption items was modified.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the field-level encryption item.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A summary of a query argument-profile mapping.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A summary of a content type-profile mapping.

" + } + }, + "documentation":"

A summary of a field-level encryption item.

" + }, + "FieldLevelEncryptionSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionSummary", + "locationName":"FieldLevelEncryptionSummary" + } + }, + "FieldPatternList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"FieldPattern" + } + }, + "FieldPatterns":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption field patterns.

" + }, + "Items":{ + "shape":"FieldPatternList", + "documentation":"

An array of the field-level encryption field patterns.

" + } + }, + "documentation":"

A complex data type that includes the field patterns to match for field-level encryption.

" + }, + "Format":{ + "type":"string", + "enum":["URLEncoded"] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to base caching on for this cache behavior.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfigComplexType.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "GetFieldLevelEncryptionProfileConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Return the field-level encryption profile configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "GetFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the field-level encryption profile information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "GetFieldLevelEncryptionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetPublicKeyConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key configuration.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyConfigResult":{ + "type":"structure", + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Return the result for the public key configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKeyConfig" + }, + "GetPublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items don't match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginKeepaliveTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginReadTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

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

The time that an invalidation request was created.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionARN":{"type":"string"}, + "LambdaFunctionAssociation":{ + "type":"structure", + "required":[ + "LambdaFunctionARN", + "EventType" + ], + "members":{ + "LambdaFunctionARN":{ + "shape":"LambdaFunctionARN", + "documentation":"

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + }, + "IncludeBody":{ + "shape":"boolean", + "documentation":"

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListFieldLevelEncryptionConfigsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption configurations you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionConfigsResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionList":{ + "shape":"FieldLevelEncryptionList", + "documentation":"

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionList" + }, + "ListFieldLevelEncryptionProfilesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionProfilesResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileList":{ + "shape":"FieldLevelEncryptionProfileList", + "documentation":"

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionProfileList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListPublicKeysRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of public keys you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListPublicKeysResult":{ + "type":"structure", + "members":{ + "PublicKeyList":{ + "shape":"PublicKeyList", + "documentation":"

Returns a list of all public keys that have been added to CloudFront for this account.

" + } + }, + "payload":"PublicKeyList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionProfile":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchPublicKey":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group.

For the current limit on the number of origins or origin groups that you can specify for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginGroup":{ + "type":"structure", + "required":[ + "Id", + "FailoverCriteria", + "Members" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin group's ID.

" + }, + "FailoverCriteria":{ + "shape":"OriginGroupFailoverCriteria", + "documentation":"

A complex type that contains information about the failover criteria for an origin group.

" + }, + "Members":{ + "shape":"OriginGroupMembers", + "documentation":"

A complex type that contains information about the origins in an origin group.

" + } + }, + "documentation":"

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

" + }, + "OriginGroupFailoverCriteria":{ + "type":"structure", + "required":["StatusCodes"], + "members":{ + "StatusCodes":{ + "shape":"StatusCodes", + "documentation":"

The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

" + } + }, + "documentation":"

A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

" + }, + "OriginGroupList":{ + "type":"list", + "member":{ + "shape":"OriginGroup", + "locationName":"OriginGroup" + }, + "documentation":"

List of origin groups for a distribution.

" + }, + "OriginGroupMember":{ + "type":"structure", + "required":["OriginId"], + "members":{ + "OriginId":{ + "shape":"string", + "documentation":"

The ID for an origin in an origin group.

" + } + }, + "documentation":"

An origin in an origin group.

" + }, + "OriginGroupMemberList":{ + "type":"list", + "member":{ + "shape":"OriginGroupMember", + "locationName":"OriginGroupMember" + }, + "documentation":"

List of origins in an origin group.

", + "max":2, + "min":2 + }, + "OriginGroupMembers":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins in an origin group.

" + }, + "Items":{ + "shape":"OriginGroupMemberList", + "documentation":"

Items (origins) in an origin group.

" + } + }, + "documentation":"

A complex data type for the origins included in an origin group.

" + }, + "OriginGroups":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origin groups.

" + }, + "Items":{ + "shape":"OriginGroupList", + "documentation":"

The items (origin groups) in a distribution.

" + } + }, + "documentation":"

A complex data type for the origin groups specified for a distribution.

" + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins or origin groups for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins or origin groups for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins and origin groups for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "PublicKey":{ + "type":"structure", + "required":[ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique ID assigned to a public key you've added to CloudFront.

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

A time you added a public key to CloudFront.

" + }, + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A complex data type of public keys you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Name", + "EncodedKey" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed.

" + }, + "Name":{ + "shape":"string", + "documentation":"

The name for a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about a public key.

" + } + }, + "documentation":"

Information about a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of public keys you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of public keys you added to CloudFront to use with features like field-level encryption.

" + }, + "Items":{ + "shape":"PublicKeySummaryList", + "documentation":"

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A list of public keys you've added to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for public key information summary.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for public key information summary.

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

Creation time for public key information summary.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

Encoded key for public key information summary.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Comment for public key information summary.

" + } + }, + "documentation":"

A complex data type for public key information.

" + }, + "PublicKeySummaryList":{ + "type":"list", + "member":{ + "shape":"PublicKeySummary", + "locationName":"PublicKeySummary" + } + }, + "QueryArgProfile":{ + "type":"structure", + "required":[ + "QueryArg", + "ProfileId" + ], + "members":{ + "QueryArg":{ + "shape":"string", + "documentation":"

Query argument for field-level encryption query argument-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

ID of profile to use for field-level encryption query argument-profile mapping

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileConfig":{ + "type":"structure", + "required":["ForwardWhenQueryArgProfileIsUnknown"], + "members":{ + "ForwardWhenQueryArgProfileIsUnknown":{ + "shape":"boolean", + "documentation":"

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

" + }, + "QueryArgProfiles":{ + "shape":"QueryArgProfiles", + "documentation":"

Profiles specified for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Configuration for query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileEmpty":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No profile specified for the field-level encryption query argument.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QueryArgProfileList":{ + "type":"list", + "member":{ + "shape":"QueryArgProfile", + "locationName":"QueryArgProfile" + } + }, + "QueryArgProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of profiles for query argument-profile mapping for field-level encryption.

" + }, + "Items":{ + "shape":"QueryArgProfileList", + "documentation":"

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for this cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If Quantity is 0, you can omit Items.

" + } + } + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{"shape":"GeoRestriction"} + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this RTMP distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StatusCodeList":{ + "type":"list", + "member":{ + "shape":"integer", + "locationName":"StatusCode" + }, + "documentation":"

List of status codes for origin failover.

", + "min":1 + }, + "StatusCodes":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of status codes.

" + }, + "Items":{ + "shape":"StatusCodeList", + "documentation":"

The items (status codes) for an origin group.

" + } + }, + "documentation":"

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

" + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for an Amazon CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionConfigs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of configurations for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionContentTypeProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of content type profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionEncryptionEntities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of encryption entities for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionFieldPatterns":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of field patterns for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionQueryArgProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of query arg profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginGroupsPerDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin groups allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyPublicKeys":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers don't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig .

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Request to update a field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to update.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "UpdateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the results of updating the configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "UpdateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Request to update a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the field-level encryption profile request.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "UpdateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the results of updating the profile.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The result of the field-level encryption profile request.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "UpdatePublicKeyRequest":{ + "type":"structure", + "required":[ + "PublicKeyConfig", + "Id" + ], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Request to update public key information.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

ID of the public key to be updated.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"PublicKeyConfig" + }, + "UpdatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the results of updating the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the update public key result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2018-11-05/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

For information about how and when to use CloudFrontDefaultCertificate, see ViewerCertificate.

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

For information about how and when to use IAMCertificateId, see ViewerCertificate.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

For information about how and when to use ACMCertificateArn, see ViewerCertificate.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ViewerCertificate$ACMCertificateArn or for ViewerCertificate$IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:

    • Use the vip option (dedicated IP addresses) instead of sni-only.

    • Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, https://d111111abcdef8.cloudfront.net/logo.png.

    • If you can control which browser your users use, upgrade the browser to one that supports SNI.

    • Use HTTP instead of HTTPS.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field has been deprecated. Use one of the following fields instead:

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

You must specify only one of the following values:

Don't specify false for CloudFrontDefaultCertificate.

If you want viewers to use HTTP instead of HTTPS to request your objects: Specify the following value:

<CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

In addition, specify allow-all for ViewerProtocolPolicy for all of your cache behaviors.

If you want viewers to use HTTPS to request your objects: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:

  • If you're using an alternate domain name, such as example.com: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:

    • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

    • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

    If you specify ACMCertificateArn or IAMCertificateId, you must also specify a value for SSLSupportMethod.

    If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (https://example.com/logo.jpg). If you use the domain name that is associated with your CloudFront distribution (such as https://d111111abcdef8.cloudfront.net/logo.jpg) and the viewer supports SNI, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for SSLSupportMethod:

    • vip: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.

    • sni-only: CloudFront drops the connection with the browser without returning the object.

  • If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net : Specify the following value:

    <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:

  • <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy>

  • <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy>

You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:

  • <OriginProtocolPolicy>https-only<OriginProtocolPolicy>

  • <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy>

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2018-11-05/waiters-2.json b/aws/dist/botocore/data/cloudfront/2018-11-05/waiters-2.json new file mode 100644 index 00000000..edd74b2a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2018-11-05/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 25, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 30, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2019-03-26/examples-1.json b/aws/dist/botocore/data/cloudfront/2019-03-26/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2019-03-26/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudfront/2019-03-26/paginators-1.json b/aws/dist/botocore/data/cloudfront/2019-03-26/paginators-1.json new file mode 100644 index 00000000..51fbb907 --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2019-03-26/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListCloudFrontOriginAccessIdentities": { + "input_token": "Marker", + "output_token": "CloudFrontOriginAccessIdentityList.NextMarker", + "limit_key": "MaxItems", + "more_results": "CloudFrontOriginAccessIdentityList.IsTruncated", + "result_key": "CloudFrontOriginAccessIdentityList.Items" + }, + "ListDistributions": { + "input_token": "Marker", + "output_token": "DistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "DistributionList.IsTruncated", + "result_key": "DistributionList.Items" + }, + "ListInvalidations": { + "input_token": "Marker", + "output_token": "InvalidationList.NextMarker", + "limit_key": "MaxItems", + "more_results": "InvalidationList.IsTruncated", + "result_key": "InvalidationList.Items" + }, + "ListStreamingDistributions": { + "input_token": "Marker", + "output_token": "StreamingDistributionList.NextMarker", + "limit_key": "MaxItems", + "more_results": "StreamingDistributionList.IsTruncated", + "result_key": "StreamingDistributionList.Items" + } + } +} diff --git a/aws/dist/botocore/data/cloudfront/2019-03-26/service-2.json b/aws/dist/botocore/data/cloudfront/2019-03-26/service-2.json new file mode 100644 index 00000000..1ab4369a --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2019-03-26/service-2.json @@ -0,0 +1,5440 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-03-26", + "endpointPrefix":"cloudfront", + "globalEndpoint":"cloudfront.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"CloudFront", + "serviceFullName":"Amazon CloudFront", + "serviceId":"CloudFront", + "signatureVersion":"v4", + "uid":"cloudfront-2019-03-26" + }, + "operations":{ + "CreateCloudFrontOriginAccessIdentity":{ + "name":"CreateCloudFrontOriginAccessIdentity2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront", + "responseCode":201 + }, + "input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"CloudFrontOriginAccessIdentityAlreadyExists"}, + {"shape":"MissingBody"}, + {"shape":"TooManyCloudFrontOriginAccessIdentities"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistribution":{ + "name":"CreateDistribution2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/distribution", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionRequest"}, + "output":{"shape":"CreateDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Creates a new web distribution. You create a CloudFront distribution to tell CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery. Send a POST request to the /CloudFront API version/distribution/distribution ID resource.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using UpdateDistribution, follow the steps included in the documentation to get the current configuration and then make your updates. This helps to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

" + }, + "CreateDistributionWithTags":{ + "name":"CreateDistributionWithTags2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateDistributionWithTagsRequest"}, + "output":{"shape":"CreateDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"DistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"MissingBody"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"TooManyDistributions"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidProtocolSettings"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"InvalidTagging"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Create a new distribution with tags.

" + }, + "CreateFieldLevelEncryptionConfig":{ + "name":"CreateFieldLevelEncryptionConfig2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/field-level-encryption", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"FieldLevelEncryptionConfigAlreadyExists"}, + {"shape":"TooManyFieldLevelEncryptionConfigs"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Create a new field-level encryption configuration.

" + }, + "CreateFieldLevelEncryptionProfile":{ + "name":"CreateFieldLevelEncryptionProfile2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/field-level-encryption-profile", + "responseCode":201 + }, + "input":{"shape":"CreateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"CreateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionProfiles"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Create a field-level encryption profile.

" + }, + "CreateInvalidation":{ + "name":"CreateInvalidation2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/distribution/{DistributionId}/invalidation", + "responseCode":201 + }, + "input":{"shape":"CreateInvalidationRequest"}, + "output":{"shape":"CreateInvalidationResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"MissingBody"}, + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"BatchTooLarge"}, + {"shape":"TooManyInvalidationsInProgress"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Create a new invalidation.

" + }, + "CreatePublicKey":{ + "name":"CreatePublicKey2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/public-key", + "responseCode":201 + }, + "input":{"shape":"CreatePublicKeyRequest"}, + "output":{"shape":"CreatePublicKeyResult"}, + "errors":[ + {"shape":"PublicKeyAlreadyExists"}, + {"shape":"InvalidArgument"}, + {"shape":"TooManyPublicKeys"} + ], + "documentation":"

Add a new public key to CloudFront to use, for example, for field-level encryption. You can add a maximum of 10 public keys with one AWS account.

" + }, + "CreateStreamingDistribution":{ + "name":"CreateStreamingDistribution2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/streaming-distribution", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionRequest"}, + "output":{"shape":"CreateStreamingDistributionResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Creates a new RTMP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP.

To create a new distribution, submit a POST request to the CloudFront API version/distribution resource. The request body must include a document with a StreamingDistributionConfig element. The response echoes the StreamingDistributionConfig element and returns other information about the RTMP distribution.

To get the status of your request, use the GET StreamingDistribution API action. When the value of Enabled is true and the value of Status is Deployed, your distribution is ready. A distribution usually deploys in less than 15 minutes.

For more information about web distributions, see Working with RTMP Distributions in the Amazon CloudFront Developer Guide.

Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the Quantity element and the number of values specified.

" + }, + "CreateStreamingDistributionWithTags":{ + "name":"CreateStreamingDistributionWithTags2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/streaming-distribution?WithTags", + "responseCode":201 + }, + "input":{"shape":"CreateStreamingDistributionWithTagsRequest"}, + "output":{"shape":"CreateStreamingDistributionWithTagsResult"}, + "errors":[ + {"shape":"CNAMEAlreadyExists"}, + {"shape":"StreamingDistributionAlreadyExists"}, + {"shape":"InvalidOrigin"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"AccessDenied"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"MissingBody"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"TooManyStreamingDistributions"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidTagging"} + ], + "documentation":"

Create a new streaming distribution with tags.

" + }, + "DeleteCloudFrontOriginAccessIdentity":{ + "name":"DeleteCloudFrontOriginAccessIdentity2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"CloudFrontOriginAccessIdentityInUse"} + ], + "documentation":"

Delete an origin access identity.

" + }, + "DeleteDistribution":{ + "name":"DeleteDistribution2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"DistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a distribution.

" + }, + "DeleteFieldLevelEncryptionConfig":{ + "name":"DeleteFieldLevelEncryptionConfig2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/field-level-encryption/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionConfigRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionConfigInUse"} + ], + "documentation":"

Remove a field-level encryption configuration.

" + }, + "DeleteFieldLevelEncryptionProfile":{ + "name":"DeleteFieldLevelEncryptionProfile2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/field-level-encryption-profile/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteFieldLevelEncryptionProfileRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileInUse"} + ], + "documentation":"

Remove a field-level encryption profile.

" + }, + "DeletePublicKey":{ + "name":"DeletePublicKey2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/public-key/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeletePublicKeyRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"PublicKeyInUse"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Remove a public key you previously added to CloudFront.

" + }, + "DeleteStreamingDistribution":{ + "name":"DeleteStreamingDistribution2019_03_26", + "http":{ + "method":"DELETE", + "requestUri":"/2019-03-26/streaming-distribution/{Id}", + "responseCode":204 + }, + "input":{"shape":"DeleteStreamingDistributionRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"StreamingDistributionNotDisabled"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.

To delete an RTMP distribution using the CloudFront API:

  1. Disable the RTMP distribution.

  2. Submit a GET Streaming Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Streaming Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Streaming Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  5. Review the response to the PUT Streaming Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Streaming Distribution Config request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Streaming Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Streaming Distribution Config request in Step 2.

  8. Review the response to your DELETE Streaming Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "GetCloudFrontOriginAccessIdentity":{ + "name":"GetCloudFrontOriginAccessIdentity2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront/{Id}" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an origin access identity.

" + }, + "GetCloudFrontOriginAccessIdentityConfig":{ + "name":"GetCloudFrontOriginAccessIdentityConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"}, + "output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"}, + "errors":[ + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about an origin access identity.

" + }, + "GetDistribution":{ + "name":"GetDistribution2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distribution/{Id}" + }, + "input":{"shape":"GetDistributionRequest"}, + "output":{"shape":"GetDistributionResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about a distribution.

" + }, + "GetDistributionConfig":{ + "name":"GetDistributionConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distribution/{Id}/config" + }, + "input":{"shape":"GetDistributionConfigRequest"}, + "output":{"shape":"GetDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a distribution.

" + }, + "GetFieldLevelEncryption":{ + "name":"GetFieldLevelEncryption2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionRequest"}, + "output":{"shape":"GetFieldLevelEncryptionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionConfig":{ + "name":"GetFieldLevelEncryptionConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"} + ], + "documentation":"

Get the field-level encryption configuration information.

" + }, + "GetFieldLevelEncryptionProfile":{ + "name":"GetFieldLevelEncryptionProfile2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption-profile/{Id}" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile information.

" + }, + "GetFieldLevelEncryptionProfileConfig":{ + "name":"GetFieldLevelEncryptionProfileConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"GetFieldLevelEncryptionProfileConfigRequest"}, + "output":{"shape":"GetFieldLevelEncryptionProfileConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"} + ], + "documentation":"

Get the field-level encryption profile configuration information.

" + }, + "GetInvalidation":{ + "name":"GetInvalidation2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distribution/{DistributionId}/invalidation/{Id}" + }, + "input":{"shape":"GetInvalidationRequest"}, + "output":{"shape":"GetInvalidationResult"}, + "errors":[ + {"shape":"NoSuchInvalidation"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the information about an invalidation.

" + }, + "GetPublicKey":{ + "name":"GetPublicKey2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/public-key/{Id}" + }, + "input":{"shape":"GetPublicKeyRequest"}, + "output":{"shape":"GetPublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Get the public key information.

" + }, + "GetPublicKeyConfig":{ + "name":"GetPublicKeyConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/public-key/{Id}/config" + }, + "input":{"shape":"GetPublicKeyConfigRequest"}, + "output":{"shape":"GetPublicKeyConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"NoSuchPublicKey"} + ], + "documentation":"

Return public key configuration informaation

" + }, + "GetStreamingDistribution":{ + "name":"GetStreamingDistribution2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/streaming-distribution/{Id}" + }, + "input":{"shape":"GetStreamingDistributionRequest"}, + "output":{"shape":"GetStreamingDistributionResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Gets information about a specified RTMP distribution, including the distribution configuration.

" + }, + "GetStreamingDistributionConfig":{ + "name":"GetStreamingDistributionConfig2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/streaming-distribution/{Id}/config" + }, + "input":{"shape":"GetStreamingDistributionConfigRequest"}, + "output":{"shape":"GetStreamingDistributionConfigResult"}, + "errors":[ + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Get the configuration information about a streaming distribution.

" + }, + "ListCloudFrontOriginAccessIdentities":{ + "name":"ListCloudFrontOriginAccessIdentities2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront" + }, + "input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"}, + "output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Lists origin access identities.

" + }, + "ListDistributions":{ + "name":"ListDistributions2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distribution" + }, + "input":{"shape":"ListDistributionsRequest"}, + "output":{"shape":"ListDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List CloudFront distributions.

" + }, + "ListDistributionsByWebACLId":{ + "name":"ListDistributionsByWebACLId2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distributionsByWebACLId/{WebACLId}" + }, + "input":{"shape":"ListDistributionsByWebACLIdRequest"}, + "output":{"shape":"ListDistributionsByWebACLIdResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"InvalidWebACLId"} + ], + "documentation":"

List the distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListFieldLevelEncryptionConfigs":{ + "name":"ListFieldLevelEncryptionConfigs2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption" + }, + "input":{"shape":"ListFieldLevelEncryptionConfigsRequest"}, + "output":{"shape":"ListFieldLevelEncryptionConfigsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all field-level encryption configurations that have been created in CloudFront for this account.

" + }, + "ListFieldLevelEncryptionProfiles":{ + "name":"ListFieldLevelEncryptionProfiles2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/field-level-encryption-profile" + }, + "input":{"shape":"ListFieldLevelEncryptionProfilesRequest"}, + "output":{"shape":"ListFieldLevelEncryptionProfilesResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

Request a list of field-level encryption profiles that have been created in CloudFront for this account.

" + }, + "ListInvalidations":{ + "name":"ListInvalidations2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/distribution/{DistributionId}/invalidation" + }, + "input":{"shape":"ListInvalidationsRequest"}, + "output":{"shape":"ListInvalidationsResult"}, + "errors":[ + {"shape":"InvalidArgument"}, + {"shape":"NoSuchDistribution"}, + {"shape":"AccessDenied"} + ], + "documentation":"

Lists invalidation batches.

" + }, + "ListPublicKeys":{ + "name":"ListPublicKeys2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/public-key" + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List all public keys that have been added to CloudFront for this account.

" + }, + "ListStreamingDistributions":{ + "name":"ListStreamingDistributions2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/streaming-distribution" + }, + "input":{"shape":"ListStreamingDistributionsRequest"}, + "output":{"shape":"ListStreamingDistributionsResult"}, + "errors":[ + {"shape":"InvalidArgument"} + ], + "documentation":"

List streaming distributions.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource2019_03_26", + "http":{ + "method":"GET", + "requestUri":"/2019-03-26/tagging" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

List tags for a CloudFront resource.

" + }, + "TagResource":{ + "name":"TagResource2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/tagging?Operation=Tag", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Add tags to a CloudFront resource.

" + }, + "UntagResource":{ + "name":"UntagResource2019_03_26", + "http":{ + "method":"POST", + "requestUri":"/2019-03-26/tagging?Operation=Untag", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidTagging"}, + {"shape":"NoSuchResource"} + ], + "documentation":"

Remove tags from a CloudFront resource.

" + }, + "UpdateCloudFrontOriginAccessIdentity":{ + "name":"UpdateCloudFrontOriginAccessIdentity2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/origin-access-identity/cloudfront/{Id}/config" + }, + "input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"}, + "output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchCloudFrontOriginAccessIdentity"}, + {"shape":"PreconditionFailed"}, + {"shape":"InvalidArgument"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update an origin access identity.

" + }, + "UpdateDistribution":{ + "name":"UpdateDistribution2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/distribution/{Id}/config" + }, + "input":{"shape":"UpdateDistributionRequest"}, + "output":{"shape":"UpdateDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyDistributionCNAMEs"}, + {"shape":"InvalidDefaultRootObject"}, + {"shape":"InvalidRelativePath"}, + {"shape":"InvalidErrorCode"}, + {"shape":"InvalidResponseCode"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InvalidViewerCertificate"}, + {"shape":"InvalidMinimumProtocolVersion"}, + {"shape":"InvalidRequiredProtocol"}, + {"shape":"NoSuchOrigin"}, + {"shape":"TooManyOrigins"}, + {"shape":"TooManyOriginGroupsPerDistribution"}, + {"shape":"TooManyCacheBehaviors"}, + {"shape":"TooManyCookieNamesInWhiteList"}, + {"shape":"InvalidForwardCookies"}, + {"shape":"TooManyHeadersInForwardedValues"}, + {"shape":"InvalidHeadersForS3Origin"}, + {"shape":"InconsistentQuantities"}, + {"shape":"TooManyCertificates"}, + {"shape":"InvalidLocationCode"}, + {"shape":"InvalidGeoRestrictionParameter"}, + {"shape":"InvalidTTLOrder"}, + {"shape":"InvalidWebACLId"}, + {"shape":"TooManyOriginCustomHeaders"}, + {"shape":"TooManyQueryStringParameters"}, + {"shape":"InvalidQueryStringParameters"}, + {"shape":"TooManyDistributionsWithLambdaAssociations"}, + {"shape":"TooManyLambdaFunctionAssociations"}, + {"shape":"InvalidLambdaFunctionAssociation"}, + {"shape":"InvalidOriginReadTimeout"}, + {"shape":"InvalidOriginKeepaliveTimeout"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior"}, + {"shape":"TooManyDistributionsAssociatedToFieldLevelEncryptionConfig"} + ], + "documentation":"

Updates the configuration for a web distribution.

When you update a distribution, there are more required fields than when you create a distribution. When you update your distribution by using this API action, follow the steps here to get the current configuration and then make your updates, to make sure that you include all of the required fields. To view a summary, see Required Fields for Create Distribution and Update Distribution in the Amazon CloudFront Developer Guide.

The update process includes getting the current distribution configuration, updating the XML document that is returned to make your changes, and then submitting an UpdateDistribution request to make the updates.

For information about updating a distribution using the CloudFront console instead, see Creating a Distribution in the Amazon CloudFront Developer Guide.

To update a web distribution using the CloudFront API

  1. Submit a GetDistributionConfig request to get the current configuration and an Etag header for the distribution.

    If you update the distribution again, you must get a new Etag header.

  2. Update the XML document that was returned in the response to your GetDistributionConfig request to include your changes.

    When you edit the XML file, be aware of the following:

    • You must strip out the ETag parameter that is returned.

    • Additional fields are required when you update a distribution. There may be fields included in the XML file for features that you haven't configured for your distribution. This is expected and required to successfully update the distribution.

    • You can't change the value of CallerReference. If you try to change this value, CloudFront returns an IllegalUpdate error.

    • The new configuration replaces the existing configuration; the values that you specify in an UpdateDistribution request are not merged into your existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, CNAME), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding Quantity element.

  3. Submit an UpdateDistribution request to update the configuration for your distribution:

    • In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a DistributionConfig element.

    • Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GetDistributionConfig request in Step 1.

  4. Review the response to the UpdateDistribution request to confirm that the configuration was successfully updated.

  5. Optional: Submit a GetDistribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

" + }, + "UpdateFieldLevelEncryptionConfig":{ + "name":"UpdateFieldLevelEncryptionConfig2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/field-level-encryption/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionConfigRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionConfigResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"NoSuchFieldLevelEncryptionConfig"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyFieldLevelEncryptionQueryArgProfiles"}, + {"shape":"TooManyFieldLevelEncryptionContentTypeProfiles"}, + {"shape":"QueryArgProfileEmpty"} + ], + "documentation":"

Update a field-level encryption configuration.

" + }, + "UpdateFieldLevelEncryptionProfile":{ + "name":"UpdateFieldLevelEncryptionProfile2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/field-level-encryption-profile/{Id}/config" + }, + "input":{"shape":"UpdateFieldLevelEncryptionProfileRequest"}, + "output":{"shape":"UpdateFieldLevelEncryptionProfileResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"FieldLevelEncryptionProfileAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InconsistentQuantities"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"NoSuchFieldLevelEncryptionProfile"}, + {"shape":"PreconditionFailed"}, + {"shape":"FieldLevelEncryptionProfileSizeExceeded"}, + {"shape":"TooManyFieldLevelEncryptionEncryptionEntities"}, + {"shape":"TooManyFieldLevelEncryptionFieldPatterns"} + ], + "documentation":"

Update a field-level encryption profile.

" + }, + "UpdatePublicKey":{ + "name":"UpdatePublicKey2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/public-key/{Id}/config" + }, + "input":{"shape":"UpdatePublicKeyRequest"}, + "output":{"shape":"UpdatePublicKeyResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CannotChangeImmutablePublicKeyFields"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"IllegalUpdate"}, + {"shape":"NoSuchPublicKey"}, + {"shape":"PreconditionFailed"} + ], + "documentation":"

Update public key information. Note that the only value you can change is the comment.

" + }, + "UpdateStreamingDistribution":{ + "name":"UpdateStreamingDistribution2019_03_26", + "http":{ + "method":"PUT", + "requestUri":"/2019-03-26/streaming-distribution/{Id}/config" + }, + "input":{"shape":"UpdateStreamingDistributionRequest"}, + "output":{"shape":"UpdateStreamingDistributionResult"}, + "errors":[ + {"shape":"AccessDenied"}, + {"shape":"CNAMEAlreadyExists"}, + {"shape":"IllegalUpdate"}, + {"shape":"InvalidIfMatchVersion"}, + {"shape":"MissingBody"}, + {"shape":"NoSuchStreamingDistribution"}, + {"shape":"PreconditionFailed"}, + {"shape":"TooManyStreamingDistributionCNAMEs"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidOriginAccessIdentity"}, + {"shape":"TooManyTrustedSigners"}, + {"shape":"TrustedSignerDoesNotExist"}, + {"shape":"InconsistentQuantities"} + ], + "documentation":"

Update a streaming distribution.

" + } + }, + "shapes":{ + "AccessDenied":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Access denied.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ActiveTrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Enabled is true if any of the AWS accounts listed in the TrustedSigners complex type for this distribution have active CloudFront key pairs. If not, Enabled is false.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers specified in the TrustedSigners complex type.

" + }, + "Items":{ + "shape":"SignerList", + "documentation":"

A complex type that contains one Signer complex type for each trusted signer that is specified in the TrustedSigners complex type.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "AliasICPRecordal":{ + "type":"structure", + "members":{ + "CNAME":{ + "shape":"string", + "documentation":"

A domain name associated with a distribution.

" + }, + "ICPRecordalStatus":{ + "shape":"ICPRecordalStatus", + "documentation":"

The Internet Content Provider (ICP) recordal status for a CNAME. The ICPRecordalStatus is set to APPROVED for all CNAMEs (aliases) in regions outside of China.

The status values returned are the following:

  • APPROVED indicates that the associated CNAME has a valid ICP recordal number. Multiple CNAMEs can be associated with a distribution, and CNAMEs can correspond to different ICP recordals. To be marked as APPROVED, that is, valid to use with China region, a CNAME must have one ICP recordal number associated with it.

  • SUSPENDED indicates that the associated CNAME does not have a valid ICP recordal number.

  • PENDING indicates that at least one CNAME associated with the distribution does not have a valid ICP recordal number.

" + } + }, + "documentation":"

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions. The status is returned in the CloudFront response; you can't configure it yourself.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + }, + "AliasICPRecordals":{ + "type":"list", + "member":{ + "shape":"AliasICPRecordal", + "locationName":"AliasICPRecordal" + } + }, + "AliasList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"CNAME" + } + }, + "Aliases":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CNAME aliases, if any, that you want to associate with this distribution.

" + }, + "Items":{ + "shape":"AliasList", + "documentation":"

A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.

" + } + }, + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "AllowedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD, and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

" + }, + "CachedMethods":{"shape":"CachedMethods"} + }, + "documentation":"

A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:

  • CloudFront forwards only GET and HEAD requests.

  • CloudFront forwards only GET, HEAD, and OPTIONS requests.

  • CloudFront forwards GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests.

If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.

" + }, + "AwsAccountNumberList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"AwsAccountNumber" + } + }, + "BatchTooLarge":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Invalidation batch specified is too large.

", + "error":{"httpStatusCode":413}, + "exception":true + }, + "CNAMEAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The CNAME specified is already defined for CloudFront.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CacheBehavior":{ + "type":"structure", + "required":[ + "PathPattern", + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "PathPattern":{ + "shape":"string", + "documentation":"

The pattern (for example, images/*.jpg) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.

You can optionally include a slash (/) at the beginning of the path pattern. For example, /images/*.jpg. CloudFront behavior is the same with or without the leading /.

The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.

For more information, see Path Pattern in the Amazon CloudFront Developer Guide.

" + }, + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes how CloudFront processes requests.

You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.

For the current limit on the number of cache behaviors that you can add to a distribution, see Amazon CloudFront Limits in the AWS General Reference.

If you don't want to specify any cache behaviors, include only an empty CacheBehaviors element. Don't include an empty CacheBehavior element, or CloudFront returns a MalformedXML error.

To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty CacheBehaviors element.

To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.

For more information about cache behaviors, see Cache Behaviors in the Amazon CloudFront Developer Guide.

" + }, + "CacheBehaviorList":{ + "type":"list", + "member":{ + "shape":"CacheBehavior", + "locationName":"CacheBehavior" + } + }, + "CacheBehaviors":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of cache behaviors for this distribution.

" + }, + "Items":{ + "shape":"CacheBehaviorList", + "documentation":"

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CachedMethods":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).

" + }, + "Items":{ + "shape":"MethodsList", + "documentation":"

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

" + } + }, + "documentation":"

A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:

  • CloudFront caches responses to GET and HEAD requests.

  • CloudFront caches responses to GET, HEAD, and OPTIONS requests.

If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly.

" + }, + "CannotChangeImmutablePublicKeyFields":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You can't change the value of a public key.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CertificateSource":{ + "type":"string", + "enum":[ + "cloudfront", + "iam", + "acm" + ] + }, + "CloudFrontOriginAccessIdentity":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity, for example, E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

" + } + }, + "documentation":"

CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentityAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Comment" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created.

If the CallerReference is a value already sent in a previous identity request, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request.

If the CallerReference is a value you already sent in a previous request to create an identity, but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the origin access identity.

" + } + }, + "documentation":"

Origin access identity configuration. Send a GET request to the /CloudFront API version/CloudFront/identity ID/config resource.

" + }, + "CloudFrontOriginAccessIdentityInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Origin Access Identity specified is already in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CloudFrontOriginAccessIdentityList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of origin access identities you want in the response body.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of CloudFront origin access identities that were created by the current AWS account.

" + }, + "Items":{ + "shape":"CloudFrontOriginAccessIdentitySummaryList", + "documentation":"

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

" + } + }, + "documentation":"

Lists the origin access identities for CloudFront.Send a GET request to the /CloudFront API version/origin-access-identity/cloudfront resource. The response includes a CloudFrontOriginAccessIdentityList element with zero or more CloudFrontOriginAccessIdentitySummary child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the MaxItems and Marker parameters.

" + }, + "CloudFrontOriginAccessIdentitySummary":{ + "type":"structure", + "required":[ + "Id", + "S3CanonicalUserId", + "Comment" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for the origin access identity. For example: E74FTE3AJFJ256A.

" + }, + "S3CanonicalUserId":{ + "shape":"string", + "documentation":"

The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment for this origin access identity, as originally specified when created.

" + } + }, + "documentation":"

Summary of the information about a CloudFront origin access identity.

" + }, + "CloudFrontOriginAccessIdentitySummaryList":{ + "type":"list", + "member":{ + "shape":"CloudFrontOriginAccessIdentitySummary", + "locationName":"CloudFrontOriginAccessIdentitySummary" + } + }, + "CommentType":{ + "type":"string", + "sensitive":true + }, + "ContentTypeProfile":{ + "type":"structure", + "required":[ + "Format", + "ContentType" + ], + "members":{ + "Format":{ + "shape":"Format", + "documentation":"

The format for a field-level encryption content type-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

The profile ID for a field-level encryption content type-profile mapping.

" + }, + "ContentType":{ + "shape":"string", + "documentation":"

The content type for a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

A field-level encryption content type profile.

" + }, + "ContentTypeProfileConfig":{ + "type":"structure", + "required":["ForwardWhenContentTypeIsUnknown"], + "members":{ + "ForwardWhenContentTypeIsUnknown":{ + "shape":"boolean", + "documentation":"

The setting in a field-level encryption content type-profile mapping that specifies what to do when an unknown content type is provided for the profile. If true, content is forwarded without being encrypted when the content type is unknown. If false (the default), an error is returned when the content type is unknown.

" + }, + "ContentTypeProfiles":{ + "shape":"ContentTypeProfiles", + "documentation":"

The configuration for a field-level encryption content type-profile.

" + } + }, + "documentation":"

The configuration for a field-level encryption content type-profile mapping.

" + }, + "ContentTypeProfileList":{ + "type":"list", + "member":{ + "shape":"ContentTypeProfile", + "locationName":"ContentTypeProfile" + } + }, + "ContentTypeProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption content type-profile mappings.

" + }, + "Items":{ + "shape":"ContentTypeProfileList", + "documentation":"

Items in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Field-level encryption content type-profile.

" + }, + "CookieNameList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "CookieNames":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.

" + }, + "Items":{ + "shape":"CookieNameList", + "documentation":"

A complex type that contains one Name element for each cookie that you want CloudFront to forward to the origin for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" + }, + "CookiePreference":{ + "type":"structure", + "required":["Forward"], + "members":{ + "Forward":{ + "shape":"ItemSelection", + "documentation":"

Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the WhitelistedNames complex type.

Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the Forward element.

" + }, + "WhitelistedNames":{ + "shape":"CookieNames", + "documentation":"

Required if you specify whitelist for the value of Forward:. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.

If you specify all or none for the value of Forward, omit WhitelistedNames. If you change the value of Forward from whitelist to all or none and you don't delete the WhitelistedNames element and its child elements, CloudFront deletes them automatically.

For the current limit on the number of cookie names that you can whitelist for each cache behavior, see CloudFront Limits in the AWS General Reference.

" + } + }, + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see Caching Content Based on Cookies in the Amazon CloudFront Developer Guide.

" + }, + "CreateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["CloudFrontOriginAccessIdentityConfig"], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The current configuration information for the identity.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create a new origin access identity (OAI). An origin access identity is a special CloudFront user that you can associate with Amazon S3 origins, so that you can secure all or just some of your Amazon S3 content. For more information, see Restricting Access to Amazon S3 Content by Using an Origin Access Identity in the Amazon CloudFront Developer Guide.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "CreateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "CreateDistributionRequest":{ + "type":"structure", + "required":["DistributionConfig"], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create a new distribution.

", + "payload":"DistributionConfig" + }, + "CreateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateDistributionWithTagsRequest":{ + "type":"structure", + "required":["DistributionConfigWithTags"], + "members":{ + "DistributionConfigWithTags":{ + "shape":"DistributionConfigWithTags", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create a new distribution with tags.

", + "payload":"DistributionConfigWithTags" + }, + "CreateDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "CreateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionConfig"], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

The request to create a new field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "CreateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Returned when you create a new field-level encryption configuration.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "CreateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["FieldLevelEncryptionProfileConfig"], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

The request to create a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "CreateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Returned when you create a new field-level encryption profile.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "CreateInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "InvalidationBatch" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"DistributionId" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The batch information for the invalidation.

", + "locationName":"InvalidationBatch", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create an invalidation.

", + "payload":"InvalidationBatch" + }, + "CreateInvalidationResult":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

", + "location":"header", + "locationName":"Location" + }, + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "CreatePublicKeyRequest":{ + "type":"structure", + "required":["PublicKeyConfig"], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

The request to add a public key to CloudFront.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "payload":"PublicKeyConfig" + }, + "CreatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Returned when you add a public key.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "CreateStreamingDistributionRequest":{ + "type":"structure", + "required":["StreamingDistributionConfig"], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create a new streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "CreateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CreateStreamingDistributionWithTagsRequest":{ + "type":"structure", + "required":["StreamingDistributionConfigWithTags"], + "members":{ + "StreamingDistributionConfigWithTags":{ + "shape":"StreamingDistributionConfigWithTags", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfigWithTags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to create a new streaming distribution with tags.

", + "payload":"StreamingDistributionConfigWithTags" + }, + "CreateStreamingDistributionWithTagsResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "Location":{ + "shape":"string", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "location":"header", + "locationName":"Location" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution created.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "CustomErrorResponse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"integer", + "documentation":"

The HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + }, + "ResponsePagePath":{ + "shape":"string", + "documentation":"

The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ErrorCode, for example, /4xx-errors/403-forbidden.html. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:

  • The value of PathPattern matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named /4xx-errors. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, /4xx-errors/*.

  • The value of TargetOriginId specifies the value of the ID element for the origin that contains your custom error pages.

If you specify a value for ResponsePagePath, you must also specify a value for ResponseCode. If you don't want to specify a value, include an empty element, <ResponsePagePath>, in the XML document.

We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.

" + }, + "ResponseCode":{ + "shape":"string", + "documentation":"

The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:

  • Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute 200, the response typically won't be intercepted.

  • If you don't care about distinguishing among different client errors or server errors, you can specify 400 or 500 as the ResponseCode for all 4xx or 5xx errors.

  • You might want to return a 200 status code (OK) and static website so your customers don't know that your website is down.

If you specify a value for ResponseCode, you must also specify a value for ResponsePagePath. If you don't want to specify a value, include an empty element, <ResponseCode>, in the XML document.

" + }, + "ErrorCachingMinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ErrorCode. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.

If you don't want to specify a value, include an empty element, <ErrorCachingMinTTL>, in the XML document.

For more information, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomErrorResponseList":{ + "type":"list", + "member":{ + "shape":"CustomErrorResponse", + "locationName":"CustomErrorResponse" + } + }, + "CustomErrorResponses":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If Quantity is 0, you can omit Items.

" + }, + "Items":{ + "shape":"CustomErrorResponseList", + "documentation":"

A complex type that contains a CustomErrorResponse element for each HTTP status code for which you want to specify a custom error page and/or a caching duration.

" + } + }, + "documentation":"

A complex type that controls:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "CustomHeaders":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of custom headers, if any, for this distribution.

" + }, + "Items":{ + "shape":"OriginCustomHeadersList", + "documentation":"

Optional: A list that contains one OriginCustomHeader element for each custom header that you want CloudFront to forward to the origin. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that contains the list of Custom Headers for each origin.

" + }, + "CustomOriginConfig":{ + "type":"structure", + "required":[ + "HTTPPort", + "HTTPSPort", + "OriginProtocolPolicy" + ], + "members":{ + "HTTPPort":{ + "shape":"integer", + "documentation":"

The HTTP port the custom origin listens on.

" + }, + "HTTPSPort":{ + "shape":"integer", + "documentation":"

The HTTPS port the custom origin listens on.

" + }, + "OriginProtocolPolicy":{ + "shape":"OriginProtocolPolicy", + "documentation":"

The origin protocol policy to apply to your origin.

" + }, + "OriginSslProtocols":{ + "shape":"OriginSslProtocols", + "documentation":"

The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.

" + }, + "OriginReadTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + }, + "OriginKeepaliveTimeout":{ + "shape":"integer", + "documentation":"

You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.

If you need to increase the maximum time limit, contact the AWS Support Center.

" + } + }, + "documentation":"

A custom origin or an Amazon S3 bucket configured as a website endpoint.

" + }, + "DefaultCacheBehavior":{ + "type":"structure", + "required":[ + "TargetOriginId", + "ForwardedValues", + "TrustedSigners", + "ViewerProtocolPolicy", + "MinTTL" + ], + "members":{ + "TargetOriginId":{ + "shape":"string", + "documentation":"

The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior in your distribution.

" + }, + "ForwardedValues":{ + "shape":"ForwardedValues", + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

" + }, + "ViewerProtocolPolicy":{ + "shape":"ViewerProtocolPolicy", + "documentation":"

The protocol that viewers can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. You can specify the following options:

  • allow-all: Viewers can use HTTP or HTTPS.

  • redirect-to-https: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.

  • https-only: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).

For more information about requiring the HTTPS protocol, see Using an HTTPS Connection to Access Your Objects in the Amazon CloudFront Developer Guide.

The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MinTTL":{ + "shape":"long", + "documentation":"

The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

You must specify 0 for MinTTL if you configure CloudFront to forward all headers to your origin (under Headers, if you specify 1 for Quantity and * for Name).

" + }, + "AllowedMethods":{"shape":"AllowedMethods"}, + "SmoothStreaming":{ + "shape":"boolean", + "documentation":"

Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false. If you specify true for SmoothStreaming, you can still distribute other content using this cache behavior if the content matches the value of PathPattern.

" + }, + "DefaultTTL":{ + "shape":"long", + "documentation":"

The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "MaxTTL":{ + "shape":"long", + "documentation":"

The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. For more information, see Managing How Long Content Stays in an Edge Cache (Expiration) in the Amazon CloudFront Developer Guide.

" + }, + "Compress":{ + "shape":"boolean", + "documentation":"

Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see Serving Compressed Files in the Amazon CloudFront Developer Guide.

" + }, + "LambdaFunctionAssociations":{ + "shape":"LambdaFunctionAssociations", + "documentation":"

A complex type that contains zero or more Lambda function associations for a cache behavior.

" + }, + "FieldLevelEncryptionId":{ + "shape":"string", + "documentation":"

The value of ID for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for a cache behavior or for the default cache behavior in your distribution.

" + } + }, + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "DeleteCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin access identity's ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

Deletes a origin access identity.

" + }, + "DeleteDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.

To delete a web distribution using the CloudFront API:

  1. Disable the web distribution

  2. Submit a GET Distribution Config request to get the current configuration and the Etag header for the distribution.

  3. Update the XML document that was returned in the response to your GET Distribution Config request to change the value of Enabled to false.

  4. Submit a PUT Distribution Config request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 2.

  5. Review the response to the PUT Distribution Config request to confirm that the distribution was successfully disabled.

  6. Submit a GET Distribution request to confirm that your changes have propagated. When propagation is complete, the value of Status is Deployed.

  7. Submit a DELETE Distribution request. Set the value of the HTTP If-Match header to the value of the ETag header that CloudFront returned when you submitted the GET Distribution Config request in Step 6.

  8. Review the response to your DELETE Distribution request to confirm that the distribution was successfully deleted.

For information about deleting a distribution using the CloudFront console, see Deleting a Distribution in the Amazon CloudFront Developer Guide.

" + }, + "DeleteFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID of the profile you want to delete from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeletePublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID of the public key you want to remove from CloudFront.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key identity to delete. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + } + }, + "DeleteStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution ID.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to delete a streaming distribution.

" + }, + "Distribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "InProgressInvalidationBatches", + "DomainName", + "ActiveTrustedSigners", + "DistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "InProgressInvalidationBatches":{ + "shape":"integer", + "documentation":"

The number of invalidation batches currently in progress.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.

" + }, + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The current configuration information for the distribution. Send a GET request to the /CloudFront API version/distribution ID/config resource.

" + }, + "AliasICPRecordals":{ + "shape":"AliasICPRecordals", + "documentation":"

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + } + }, + "documentation":"

A distribution tells CloudFront where you want content to be delivered from, and the details about how to track and manage content delivery.

" + }, + "DistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the distribution with is associated with another distribution.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Origins", + "DefaultCacheBehavior", + "Comment", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the DistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "DefaultRootObject":{ + "shape":"string", + "documentation":"

The object that you want CloudFront to request from your origin (for example, index.html) when a viewer requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html). Specifying a default root object avoids exposing the contents of your distribution.

Specify only the object name, for example, index.html. Don't add a / before the object name.

If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element.

To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element.

To replace the default root object, update the distribution configuration and specify the new object.

For more information about the default root object, see Creating a Default Root Object in the Amazon CloudFront Developer Guide.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups":{ + "shape":"OriginGroups", + "documentation":"

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that controls the following:

  • Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.

  • How long CloudFront caches HTTP status codes in the 4xx and 5xx range.

For more information about custom error pages, see Customizing Error Responses in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"CommentType", + "documentation":"

Any comments you want to include about the distribution.

If you don't want to specify a comment, include an empty Comment element.

To delete an existing comment, update the distribution configuration and include an empty Comment element.

To add or change a comment, update the distribution configuration and specify the new comment.

" + }, + "Logging":{ + "shape":"LoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the distribution.

For more information about logging, see Access Logs in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

From this field, you can enable or disable the selected distribution.

" + }, + "ViewerCertificate":{ + "shape":"ViewerCertificate", + "documentation":"

A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.

" + }, + "Restrictions":{ + "shape":"Restrictions", + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the AWS WAF Developer Guide.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.

For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).

In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\"

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify true. If you specify false, CloudFront responds to IPv6 DNS requests with the DNS response code NOERROR and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution.

In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the IpAddress parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see Creating a Signed URL Using a Custom Policy in the Amazon CloudFront Developer Guide.

If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:

  • You enable IPv6 for the distribution

  • You're using alternate domain names in the URLs for your objects

For more information, see Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name in the Amazon Route 53 Developer Guide.

If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.

" + } + }, + "documentation":"

A distribution configuration.

" + }, + "DistributionConfigWithTags":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Tags" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

A distribution configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A distribution Configuration and a list of tags to be associated with the distribution.

" + }, + "DistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"DistributionSummaryList", + "documentation":"

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A distribution list.

" + }, + "DistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "Aliases", + "Origins", + "DefaultCacheBehavior", + "CacheBehaviors", + "CustomErrorResponses", + "Comment", + "PriceClass", + "Enabled", + "ViewerCertificate", + "Restrictions", + "WebACLId", + "HttpVersion", + "IsIPV6Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution. For example: EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

" + }, + "Origins":{ + "shape":"Origins", + "documentation":"

A complex type that contains information about origins for this distribution.

" + }, + "OriginGroups":{ + "shape":"OriginGroups", + "documentation":"

A complex type that contains information about origin groups for this distribution.

" + }, + "DefaultCacheBehavior":{ + "shape":"DefaultCacheBehavior", + "documentation":"

A complex type that describes the default cache behavior if you don't specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements. You must create exactly one default cache behavior.

" + }, + "CacheBehaviors":{ + "shape":"CacheBehaviors", + "documentation":"

A complex type that contains zero or more CacheBehavior elements.

" + }, + "CustomErrorResponses":{ + "shape":"CustomErrorResponses", + "documentation":"

A complex type that contains zero or more CustomErrorResponses elements.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept user requests for content.

" + }, + "ViewerCertificate":{ + "shape":"ViewerCertificate", + "documentation":"

A complex type that specifies whether you want viewers to use HTTP or HTTPS to request your objects, whether you're using an alternate domain name with HTTPS, and if so, if you're using AWS Certificate Manager (ACM) or a third-party certificate authority.

" + }, + "Restrictions":{ + "shape":"Restrictions", + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The Web ACL Id (if any) associated with the distribution.

" + }, + "HttpVersion":{ + "shape":"HttpVersion", + "documentation":"

Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 will automatically use an earlier version.

" + }, + "IsIPV6Enabled":{ + "shape":"boolean", + "documentation":"

Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.

" + }, + "AliasICPRecordals":{ + "shape":"AliasICPRecordals", + "documentation":"

AWS services in China customers must file for an Internet Content Provider (ICP) recordal if they want to serve content publicly on an alternate domain name, also known as a CNAME, that they've added to CloudFront. AliasICPRecordal provides the ICP recordal status for CNAMEs associated with distributions.

For more information about ICP recordals, see Signup, Accounts, and Credentials in Getting Started with AWS services in China.

" + } + }, + "documentation":"

A summary of the information about a CloudFront distribution.

" + }, + "DistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"DistributionSummary", + "locationName":"DistributionSummary" + } + }, + "EncryptionEntities":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of field pattern items in a field-level encryption content type-profile mapping.

" + }, + "Items":{ + "shape":"EncryptionEntityList", + "documentation":"

An array of field patterns in a field-level encryption content type-profile mapping.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes all of the encryption entities.

" + }, + "EncryptionEntity":{ + "type":"structure", + "required":[ + "PublicKeyId", + "ProviderId", + "FieldPatterns" + ], + "members":{ + "PublicKeyId":{ + "shape":"string", + "documentation":"

The public key associated with a set of field-level encryption patterns, to be used when encrypting the fields that match the patterns.

" + }, + "ProviderId":{ + "shape":"string", + "documentation":"

The provider associated with the public key being used for encryption. This value must also be provided with the private key for applications to be able to decrypt data.

" + }, + "FieldPatterns":{ + "shape":"FieldPatterns", + "documentation":"

Field patterns in a field-level encryption content type profile specify the fields that you want to be encrypted. You can provide the full field name, or any beginning characters followed by a wildcard (*). You can't overlap field patterns. For example, you can't have both ABC* and AB*. Note that field patterns are case-sensitive.

" + } + }, + "documentation":"

Complex data type for field-level encryption profiles that includes the encryption key and field pattern specifications.

" + }, + "EncryptionEntityList":{ + "type":"list", + "member":{ + "shape":"EncryptionEntity", + "locationName":"EncryptionEntity" + } + }, + "EventType":{ + "type":"string", + "enum":[ + "viewer-request", + "viewer-response", + "origin-request", + "origin-response" + ] + }, + "FieldLevelEncryption":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The configuration ID for a field-level encryption configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption configuration was changed.

" + }, + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations and other options specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfig":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the configuration.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a profile isn't found and the profile that can be provided as a query argument in a request.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A complex data type that specifies when to forward content if a content type isn't recognized and profiles to use as by default in a request if a query argument doesn't specify a profile to use.

" + } + }, + "documentation":"

A complex data type that includes the profile configurations specified for field-level encryption.

" + }, + "FieldLevelEncryptionConfigAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionConfigInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your configurations where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of elements you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption items.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionSummaryList", + "documentation":"

An array of field-level encryption items.

" + } + }, + "documentation":"

List of field-level encrpytion configurations.

" + }, + "FieldLevelEncryptionProfile":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "FieldLevelEncryptionProfileConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The ID for a field-level encryption profile configuration which includes a set of profiles that specify certain selected data fields to be encrypted by specific public keys.

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

The last time the field-level encryption profile was updated.

" + }, + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

A complex data type that includes the profile name and the encryption entities for the field-level encryption profile.

" + } + }, + "documentation":"

A complex data type for field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileConfig":{ + "type":"structure", + "required":[ + "Name", + "CallerReference", + "EncryptionEntities" + ], + "members":{ + "Name":{ + "shape":"string", + "documentation":"

Profile name for the field-level encryption profile.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + } + }, + "documentation":"

A complex data type of profiles for the field-level encryption.

" + }, + "FieldLevelEncryptionProfileInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FieldLevelEncryptionProfileList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your profiles where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption profiles.

" + }, + "Items":{ + "shape":"FieldLevelEncryptionProfileSummaryList", + "documentation":"

The field-level encryption profile items.

" + } + }, + "documentation":"

List of field-level encryption profiles.

" + }, + "FieldLevelEncryptionProfileSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum size of a profile for field-level encryption was exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "FieldLevelEncryptionProfileSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime", + "Name", + "EncryptionEntities" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for the field-level encryption profile summary.

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

The time when the the field-level encryption profile summary was last updated.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for the field-level encryption profile summary.

" + }, + "EncryptionEntities":{ + "shape":"EncryptionEntities", + "documentation":"

A complex data type of encryption entities for the field-level encryption profile that include the public key ID, provider, and field patterns for specifying which fields to encrypt with this key.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment for the field-level encryption profile summary.

" + } + }, + "documentation":"

The field-level encryption profile summary.

" + }, + "FieldLevelEncryptionProfileSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionProfileSummary", + "locationName":"FieldLevelEncryptionProfileSummary" + } + }, + "FieldLevelEncryptionSummary":{ + "type":"structure", + "required":[ + "Id", + "LastModifiedTime" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID of a field-level encryption item.

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

The last time that the summary of field-level encryption items was modified.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about the field-level encryption item.

" + }, + "QueryArgProfileConfig":{ + "shape":"QueryArgProfileConfig", + "documentation":"

A summary of a query argument-profile mapping.

" + }, + "ContentTypeProfileConfig":{ + "shape":"ContentTypeProfileConfig", + "documentation":"

A summary of a content type-profile mapping.

" + } + }, + "documentation":"

A summary of a field-level encryption item.

" + }, + "FieldLevelEncryptionSummaryList":{ + "type":"list", + "member":{ + "shape":"FieldLevelEncryptionSummary", + "locationName":"FieldLevelEncryptionSummary" + } + }, + "FieldPatternList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"FieldPattern" + } + }, + "FieldPatterns":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of field-level encryption field patterns.

" + }, + "Items":{ + "shape":"FieldPatternList", + "documentation":"

An array of the field-level encryption field patterns.

" + } + }, + "documentation":"

A complex data type that includes the field patterns to match for field-level encryption.

" + }, + "Format":{ + "type":"string", + "enum":["URLEncoded"] + }, + "ForwardedValues":{ + "type":"structure", + "required":[ + "QueryString", + "Cookies" + ], + "members":{ + "QueryString":{ + "shape":"boolean", + "documentation":"

Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of QueryString and on the values that you specify for QueryStringCacheKeys, if any:

If you specify true for QueryString and you don't specify any values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.

If you specify true for QueryString and you specify one or more values for QueryStringCacheKeys, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.

If you specify false for QueryString, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.

For more information, see Configuring CloudFront to Cache Based on Query String Parameters in the Amazon CloudFront Developer Guide.

" + }, + "Cookies":{ + "shape":"CookiePreference", + "documentation":"

A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see How CloudFront Forwards, Caches, and Logs Cookies in the Amazon CloudFront Developer Guide.

" + }, + "Headers":{ + "shape":"Headers", + "documentation":"

A complex type that specifies the Headers, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests.

For more information, see Caching Content Based on Request Headers in the Amazon CloudFront Developer Guide.

" + }, + "QueryStringCacheKeys":{ + "shape":"QueryStringCacheKeys", + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.

" + } + }, + "documentation":"

A complex type that specifies how CloudFront handles query strings and cookies.

" + }, + "GeoRestriction":{ + "type":"structure", + "required":[ + "RestrictionType", + "Quantity" + ], + "members":{ + "RestrictionType":{ + "shape":"GeoRestrictionType", + "documentation":"

The method that you want to use to restrict distribution of your content by country:

  • none: No geo restriction is enabled, meaning access to content is not restricted by client geo location.

  • blacklist: The Location elements specify the countries in which you don't want CloudFront to distribute your content.

  • whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.

" + }, + "Items":{ + "shape":"LocationList", + "documentation":"

A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist).

The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country.

CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.

" + } + }, + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + }, + "GeoRestrictionType":{ + "type":"string", + "enum":[ + "blacklist", + "whitelist", + "none" + ] + }, + "GetCloudFrontOriginAccessIdentityConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The origin access identity's configuration information. For more information, see CloudFrontOriginAccessIdentityConfig.

" + }, + "GetCloudFrontOriginAccessIdentityConfigResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The origin access identity's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "GetCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identity's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an origin access identity's information.

" + }, + "GetCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "GetDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution configuration.

" + }, + "GetDistributionConfigResult":{ + "type":"structure", + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionConfig" + }, + "GetDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The distribution's ID. If the ID is empty, an empty distribution configuration is returned.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a distribution's information.

" + }, + "GetDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "GetFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "GetFieldLevelEncryptionProfileConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Return the field-level encryption profile configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field-level encryption profile configuration result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "GetFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Get the ID for the field-level encryption profile information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the field-level encryption profile information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption profile. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "GetFieldLevelEncryptionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the field-level encryption configuration information.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetFieldLevelEncryptionResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the field-level encryption configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the field level encryption configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "GetInvalidationRequest":{ + "type":"structure", + "required":[ + "DistributionId", + "Id" + ], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request, for example, IDFDVBD632BHDS5.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get an invalidation's information.

" + }, + "GetInvalidationResult":{ + "type":"structure", + "members":{ + "Invalidation":{ + "shape":"Invalidation", + "documentation":"

The invalidation's information. For more information, see Invalidation Complex Type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Invalidation" + }, + "GetPublicKeyConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key configuration.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyConfigResult":{ + "type":"structure", + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Return the result for the public key configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKeyConfig" + }, + "GetPublicKeyRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

Request the ID for the public key.

", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetPublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the public key. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "GetStreamingDistributionConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

To request to get a streaming distribution configuration.

" + }, + "GetStreamingDistributionConfigResult":{ + "type":"structure", + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionConfig" + }, + "GetStreamingDistributionRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's ID.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The request to get a streaming distribution's information.

" + }, + "GetStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "HeaderList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "Headers":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:

  • Forward all headers to your origin: Specify 1 for Quantity and * for Name.

    CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin.

  • Forward a whitelist of headers you specify: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in Name elements. CloudFront caches your objects based on the values in the specified headers.

  • Forward only the default headers: Specify 0 for Quantity and omit Items. In this configuration, CloudFront doesn't cache based on the values in the request headers.

Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:

" + }, + "Items":{ + "shape":"HeaderList", + "documentation":"

A list that contains one Name element for each header that you want CloudFront to use for caching in this cache behavior. If Quantity is 0, omit Items.

" + } + }, + "documentation":"

A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior.

For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for logo.jpg contain a custom product header that has a value of either acme or apex, and you configure CloudFront to cache your content based on values in the product header. CloudFront forwards the product header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see How CloudFront Forwards and Caches Headers in the Amazon CloudFront Developer Guide.

" + }, + "HttpVersion":{ + "type":"string", + "enum":[ + "http1.1", + "http2" + ] + }, + "ICPRecordalStatus":{ + "type":"string", + "enum":[ + "APPROVED", + "SUSPENDED", + "PENDING" + ] + }, + "IllegalFieldLevelEncryptionConfigAssociationWithCacheBehavior":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption can't be associated with the specified cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IllegalUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Origin and CallerReference cannot be updated.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InconsistentQuantities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The value of Quantity and the size of Items don't match.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The argument is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDefaultRootObject":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The default root object file name is too big or contains an invalid character.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidErrorCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

An invalid error code was specified.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidForwardCookies":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains forward cookies option which doesn't match with the expectation for the whitelisted list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGeoRestrictionParameter":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified geo restriction parameter is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidHeadersForS3Origin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The headers specified are not valid for an Amazon S3 origin.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidIfMatchVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The If-Match version is missing or not valid for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLambdaFunctionAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified Lambda function association is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidLocationCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The location code specified is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMinimumProtocolVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The minimum protocol version specified is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The origin access identity is not valid or doesn't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginKeepaliveTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The keep alive timeout specified for the origin is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidOriginReadTimeout":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The read timeout specified for the origin is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidProtocolSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Query string parameters specified in the response body are not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRelativePath":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The relative path is too big, is not URL-encoded, or does not begin with a slash (/).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequiredProtocol":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the RequiredProtocols element from your distribution configuration.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseCode":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

A response code specified in the response body is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTTLOrder":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

TTL order specified in the response body is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTagging":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Tagging specified in the response body is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidViewerCertificate":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

A viewer certificate specified in the response body is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidWebACLId":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

A web ACL id specified in the response body is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invalidation":{ + "type":"structure", + "required":[ + "Id", + "Status", + "CreateTime", + "InvalidationBatch" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

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

The date and time the invalidation request was first made.

" + }, + "InvalidationBatch":{ + "shape":"InvalidationBatch", + "documentation":"

The current invalidation information for the batch request.

" + } + }, + "documentation":"

An invalidation.

" + }, + "InvalidationBatch":{ + "type":"structure", + "required":[ + "Paths", + "CallerReference" + ], + "members":{ + "Paths":{ + "shape":"Paths", + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "CallerReference":{ + "shape":"string", + "documentation":"

A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for CallerReference and change other values in the request as applicable. One way to ensure that the value of CallerReference is unique is to use a timestamp, for example, 20120301090000.

If you make a second invalidation request with the same value for CallerReference, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same CallerReference.

If CallerReference is a value you already sent in a previous invalidation batch request but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.

" + } + }, + "documentation":"

An invalidation batch.

" + }, + "InvalidationList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value that you can use for the Marker request parameter to continue listing your invalidation batches where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value that you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation batches that were created by the current AWS account.

" + }, + "Items":{ + "shape":"InvalidationSummaryList", + "documentation":"

A complex type that contains one InvalidationSummary element for each invalidation batch created by the current AWS account.

" + } + }, + "documentation":"

The InvalidationList complex type describes the list of invalidation objects. For more information about invalidation, see Invalidating Objects (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "InvalidationSummary":{ + "type":"structure", + "required":[ + "Id", + "CreateTime", + "Status" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The unique ID for an invalidation request.

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

The time that an invalidation request was created.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The status of an invalidation request.

" + } + }, + "documentation":"

A summary of an invalidation request.

" + }, + "InvalidationSummaryList":{ + "type":"list", + "member":{ + "shape":"InvalidationSummary", + "locationName":"InvalidationSummary" + } + }, + "ItemSelection":{ + "type":"string", + "enum":[ + "none", + "whitelist", + "all" + ] + }, + "KeyPairIdList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"KeyPairId" + } + }, + "KeyPairIds":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of active CloudFront key pairs for AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "Items":{ + "shape":"KeyPairIdList", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + } + }, + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

For more information, see ActiveTrustedSigners.

" + }, + "LambdaFunctionARN":{"type":"string"}, + "LambdaFunctionAssociation":{ + "type":"structure", + "required":[ + "LambdaFunctionARN", + "EventType" + ], + "members":{ + "LambdaFunctionARN":{ + "shape":"LambdaFunctionARN", + "documentation":"

The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

Specifies the event type that triggers a Lambda function invocation. You can specify the following values:

  • viewer-request: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache.

  • origin-request: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.

  • origin-response: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.

  • viewer-response: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.

    If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.

" + }, + "IncludeBody":{ + "shape":"boolean", + "documentation":"

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains a Lambda function association.

" + }, + "LambdaFunctionAssociationList":{ + "type":"list", + "member":{ + "shape":"LambdaFunctionAssociation", + "locationName":"LambdaFunctionAssociation" + } + }, + "LambdaFunctionAssociations":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of Lambda function associations for this cache behavior.

" + }, + "Items":{ + "shape":"LambdaFunctionAssociationList", + "documentation":"

Optional: A complex type that contains LambdaFunctionAssociation items for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies a list of Lambda functions associations for a cache behavior.

If you want to invoke one or more Lambda functions triggered by requests that match the PathPattern of the cache behavior, specify the applicable values for Quantity and Items. Note that there can be up to 4 LambdaFunctionAssociation items in this list (one for each possible value of EventType) and each EventType can be associated with the Lambda function only once.

If you don't want to invoke any Lambda functions for the requests that match PathPattern, specify 0 for Quantity and omit Items.

" + }, + "ListCloudFrontOriginAccessIdentitiesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of origin access identities you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list origin access identities.

" + }, + "ListCloudFrontOriginAccessIdentitiesResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentityList":{ + "shape":"CloudFrontOriginAccessIdentityList", + "documentation":"

The CloudFrontOriginAccessIdentityList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentityList" + }, + "ListDistributionsByWebACLIdRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "WebACLId":{ + "shape":"string", + "documentation":"

The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.

", + "location":"uri", + "locationName":"WebACLId" + } + }, + "documentation":"

The request to list distributions that are associated with a specified AWS WAF web ACL.

" + }, + "ListDistributionsByWebACLIdResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The response to a request to list the distributions that are associated with a specified AWS WAF web ACL.

", + "payload":"DistributionList" + }, + "ListDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of distributions you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your distributions.

" + }, + "ListDistributionsResult":{ + "type":"structure", + "members":{ + "DistributionList":{ + "shape":"DistributionList", + "documentation":"

The DistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"DistributionList" + }, + "ListFieldLevelEncryptionConfigsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of configurations. The results include configurations in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last configuration on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption configurations you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionConfigsResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionList":{ + "shape":"FieldLevelEncryptionList", + "documentation":"

Returns a list of all field-level encryption configurations that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionList" + }, + "ListFieldLevelEncryptionProfilesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of profiles. The results include profiles in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last profile on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of field-level encryption profiles you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFieldLevelEncryptionProfilesResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfileList":{ + "shape":"FieldLevelEncryptionProfileList", + "documentation":"

Returns a list of the field-level encryption profiles that have been created in CloudFront for this account.

" + } + }, + "payload":"FieldLevelEncryptionProfileList" + }, + "ListInvalidationsRequest":{ + "type":"structure", + "required":["DistributionId"], + "members":{ + "DistributionId":{ + "shape":"string", + "documentation":"

The distribution's ID.

", + "location":"uri", + "locationName":"DistributionId" + }, + "Marker":{ + "shape":"string", + "documentation":"

Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of invalidation batches that you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list invalidations.

" + }, + "ListInvalidationsResult":{ + "type":"structure", + "members":{ + "InvalidationList":{ + "shape":"InvalidationList", + "documentation":"

Information about invalidation batches.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"InvalidationList" + }, + "ListPublicKeysRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

Use this when paginating results to indicate where to begin in your list of public keys. The results include public keys in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last public key on that page).

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The maximum number of public keys you want in the response body.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListPublicKeysResult":{ + "type":"structure", + "members":{ + "PublicKeyList":{ + "shape":"PublicKeyList", + "documentation":"

Returns a list of all public keys that have been added to CloudFront for this account.

" + } + }, + "payload":"PublicKeyList" + }, + "ListStreamingDistributionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value that you provided for the Marker request parameter.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"string", + "documentation":"

The value that you provided for the MaxItems request parameter.

", + "location":"querystring", + "locationName":"MaxItems" + } + }, + "documentation":"

The request to list your streaming distributions.

" + }, + "ListStreamingDistributionsResult":{ + "type":"structure", + "members":{ + "StreamingDistributionList":{ + "shape":"StreamingDistributionList", + "documentation":"

The StreamingDistributionList type.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistributionList" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + } + }, + "documentation":"

The request to list tags for a CloudFront resource.

" + }, + "ListTagsForResourceResult":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Tags" + }, + "LocationList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Location" + } + }, + "LoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "IncludeCookies", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

" + }, + "IncludeCookies":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for the distribution.

" + }, + "Method":{ + "type":"string", + "enum":[ + "GET", + "HEAD", + "POST", + "PUT", + "PATCH", + "OPTIONS", + "DELETE" + ] + }, + "MethodsList":{ + "type":"list", + "member":{ + "shape":"Method", + "locationName":"Method" + } + }, + "MinimumProtocolVersion":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1_2016", + "TLSv1.1_2016", + "TLSv1.2_2018" + ] + }, + "MissingBody":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

This operation requires a body. Ensure that the body is present and the Content-Type header is set.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoSuchCloudFrontOriginAccessIdentity":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified origin access identity does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified configuration for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchFieldLevelEncryptionProfile":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified profile for field-level encryption doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchInvalidation":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified invalidation does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchOrigin":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No origin exists with the specified Origin Id.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchPublicKey":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchResource":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

A resource that was specified is not valid.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchStreamingDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified streaming distribution does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Origin":{ + "type":"structure", + "required":[ + "Id", + "DomainName" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique identifier for the origin or origin group. The value of Id must be unique within the distribution.

When you specify the value of TargetOriginId for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the Id element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. If you set up your bucket to be configured as a website endpoint, enter the Amazon S3 static website hosting endpoint for the bucket.

For more information about specifying this value for different types of origins, see Origin Domain Name in the Amazon CloudFront Developer Guide.

Constraints for Amazon S3 origins:

  • If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the s3-accelerate endpoint for DomainName.

  • The bucket name must be between 3 and 63 characters long (inclusive).

  • The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.

  • The bucket name must not contain adjacent periods.

Custom Origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.

Constraints for custom origins:

  • DomainName must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.

  • The name cannot exceed 128 characters.

" + }, + "OriginPath":{ + "shape":"string", + "documentation":"

An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName, for example, example.com/production. Do not include a / at the end of the directory name.

For example, suppose you've specified the following values for your distribution:

  • DomainName: An Amazon S3 bucket named myawsbucket.

  • OriginPath: /production

  • CNAME: example.com

When a user enters example.com/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/index.html.

When a user enters example.com/acme/index.html in a browser, CloudFront sends a request to Amazon S3 for myawsbucket/production/acme/index.html.

" + }, + "CustomHeaders":{ + "shape":"CustomHeaders", + "documentation":"

A complex type that contains names and values for the custom headers that you want.

" + }, + "S3OriginConfig":{ + "shape":"S3OriginConfig", + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "CustomOriginConfig":{ + "shape":"CustomOriginConfig", + "documentation":"

A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.

" + } + }, + "documentation":"

A complex type that describes the Amazon S3 bucket, HTTP server (for example, a web server), Amazon MediaStore, or other server from which CloudFront gets your files. This can also be an origin group, if you've created an origin group. You must specify at least one origin or origin group.

For the current limit on the number of origins or origin groups that you can specify for a distribution, see Amazon CloudFront Limits in the AWS General Reference.

" + }, + "OriginCustomHeader":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"string", + "documentation":"

The name of a header that you want CloudFront to forward to your origin. For more information, see Forwarding Custom Headers to Your Origin (Web Distributions Only) in the Amazon CloudFront Developer Guide.

" + }, + "HeaderValue":{ + "shape":"string", + "documentation":"

The value for the header that you specified in the HeaderName field.

" + } + }, + "documentation":"

A complex type that contains HeaderName and HeaderValue elements, if any, for this distribution.

" + }, + "OriginCustomHeadersList":{ + "type":"list", + "member":{ + "shape":"OriginCustomHeader", + "locationName":"OriginCustomHeader" + } + }, + "OriginGroup":{ + "type":"structure", + "required":[ + "Id", + "FailoverCriteria", + "Members" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The origin group's ID.

" + }, + "FailoverCriteria":{ + "shape":"OriginGroupFailoverCriteria", + "documentation":"

A complex type that contains information about the failover criteria for an origin group.

" + }, + "Members":{ + "shape":"OriginGroupMembers", + "documentation":"

A complex type that contains information about the origins in an origin group.

" + } + }, + "documentation":"

An origin group includes two origins (a primary origin and a second origin to failover to) and a failover criteria that you specify. You create an origin group to support origin failover in CloudFront. When you create or update a distribution, you can specifiy the origin group instead of a single origin, and CloudFront will failover from the primary origin to the second origin under the failover conditions that you've chosen.

" + }, + "OriginGroupFailoverCriteria":{ + "type":"structure", + "required":["StatusCodes"], + "members":{ + "StatusCodes":{ + "shape":"StatusCodes", + "documentation":"

The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin.

" + } + }, + "documentation":"

A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin.

" + }, + "OriginGroupList":{ + "type":"list", + "member":{ + "shape":"OriginGroup", + "locationName":"OriginGroup" + }, + "documentation":"

List of origin groups for a distribution.

" + }, + "OriginGroupMember":{ + "type":"structure", + "required":["OriginId"], + "members":{ + "OriginId":{ + "shape":"string", + "documentation":"

The ID for an origin in an origin group.

" + } + }, + "documentation":"

An origin in an origin group.

" + }, + "OriginGroupMemberList":{ + "type":"list", + "member":{ + "shape":"OriginGroupMember", + "locationName":"OriginGroupMember" + }, + "documentation":"

List of origins in an origin group.

", + "max":2, + "min":2 + }, + "OriginGroupMembers":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins in an origin group.

" + }, + "Items":{ + "shape":"OriginGroupMemberList", + "documentation":"

Items (origins) in an origin group.

" + } + }, + "documentation":"

A complex data type for the origins included in an origin group.

" + }, + "OriginGroups":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origin groups.

" + }, + "Items":{ + "shape":"OriginGroupList", + "documentation":"

The items (origin groups) in a distribution.

" + } + }, + "documentation":"

A complex data type for the origin groups specified for a distribution.

" + }, + "OriginList":{ + "type":"list", + "member":{ + "shape":"Origin", + "locationName":"Origin" + }, + "min":1 + }, + "OriginProtocolPolicy":{ + "type":"string", + "enum":[ + "http-only", + "match-viewer", + "https-only" + ] + }, + "OriginSslProtocols":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.

" + }, + "Items":{ + "shape":"SslProtocolsList", + "documentation":"

A list that contains allowed SSL/TLS protocols for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.

" + }, + "Origins":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of origins or origin groups for this distribution.

" + }, + "Items":{ + "shape":"OriginList", + "documentation":"

A complex type that contains origins or origin groups for this distribution.

" + } + }, + "documentation":"

A complex type that contains information about origins and origin groups for this distribution.

" + }, + "PathList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Path" + } + }, + "Paths":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of invalidation paths specified for the objects that you want to invalidate.

" + }, + "Items":{ + "shape":"PathList", + "documentation":"

A complex type that contains a list of the paths that you want to invalidate.

" + } + }, + "documentation":"

A complex type that contains information about the objects that you want to invalidate. For more information, see Specifying the Objects to Invalidate in the Amazon CloudFront Developer Guide.

" + }, + "PreconditionFailed":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The precondition given in one or more of the request-header fields evaluated to false.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "PriceClass":{ + "type":"string", + "enum":[ + "PriceClass_100", + "PriceClass_200", + "PriceClass_All" + ] + }, + "PublicKey":{ + "type":"structure", + "required":[ + "Id", + "CreatedTime", + "PublicKeyConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

A unique ID assigned to a public key you've added to CloudFront.

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

A time you added a public key to CloudFront.

" + }, + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

A complex data type for a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A complex data type of public keys you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "Name", + "EncodedKey" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique number that ensures that the request can't be replayed.

" + }, + "Name":{ + "shape":"string", + "documentation":"

The name for a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

The encoded public key that you want to add to CloudFront to use with features like field-level encryption.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

An optional comment about a public key.

" + } + }, + "documentation":"

Information about a public key you add to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeyInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified public key is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PublicKeyList":{ + "type":"structure", + "required":[ + "MaxItems", + "Quantity" + ], + "members":{ + "NextMarker":{ + "shape":"string", + "documentation":"

If there are more elements to be listed, this element is present and contains the value that you can use for the Marker request parameter to continue listing your public keys where you left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The maximum number of public keys you want in the response body.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of public keys you added to CloudFront to use with features like field-level encryption.

" + }, + "Items":{ + "shape":"PublicKeySummaryList", + "documentation":"

An array of information about a public key you add to CloudFront to use with features like field-level encryption.

" + } + }, + "documentation":"

A list of public keys you've added to CloudFront to use with features like field-level encryption.

" + }, + "PublicKeySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CreatedTime", + "EncodedKey" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

ID for public key information summary.

" + }, + "Name":{ + "shape":"string", + "documentation":"

Name for public key information summary.

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

Creation time for public key information summary.

" + }, + "EncodedKey":{ + "shape":"string", + "documentation":"

Encoded key for public key information summary.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Comment for public key information summary.

" + } + }, + "documentation":"

A complex data type for public key information.

" + }, + "PublicKeySummaryList":{ + "type":"list", + "member":{ + "shape":"PublicKeySummary", + "locationName":"PublicKeySummary" + } + }, + "QueryArgProfile":{ + "type":"structure", + "required":[ + "QueryArg", + "ProfileId" + ], + "members":{ + "QueryArg":{ + "shape":"string", + "documentation":"

Query argument for field-level encryption query argument-profile mapping.

" + }, + "ProfileId":{ + "shape":"string", + "documentation":"

ID of profile to use for field-level encryption query argument-profile mapping

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileConfig":{ + "type":"structure", + "required":["ForwardWhenQueryArgProfileIsUnknown"], + "members":{ + "ForwardWhenQueryArgProfileIsUnknown":{ + "shape":"boolean", + "documentation":"

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

" + }, + "QueryArgProfiles":{ + "shape":"QueryArgProfiles", + "documentation":"

Profiles specified for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Configuration for query argument-profile mapping for field-level encryption.

" + }, + "QueryArgProfileEmpty":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

No profile specified for the field-level encryption query argument.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QueryArgProfileList":{ + "type":"list", + "member":{ + "shape":"QueryArgProfile", + "locationName":"QueryArgProfile" + } + }, + "QueryArgProfiles":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

Number of profiles for query argument-profile mapping for field-level encryption.

" + }, + "Items":{ + "shape":"QueryArgProfileList", + "documentation":"

Number of items for query argument-profile mapping for field-level encryption.

" + } + }, + "documentation":"

Query argument-profile mapping for field-level encryption.

" + }, + "QueryStringCacheKeys":{ + "type":"structure", + "required":["Quantity"], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of whitelisted query string parameters for a cache behavior.

" + }, + "Items":{ + "shape":"QueryStringCacheKeysList", + "documentation":"

A list that contains the query string parameters that you want CloudFront to use as a basis for caching for a cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that contains information about the query string parameters that you want CloudFront to use for caching for a cache behavior.

" + }, + "QueryStringCacheKeysList":{ + "type":"list", + "member":{ + "shape":"string", + "locationName":"Name" + } + }, + "ResourceARN":{ + "type":"string", + "pattern":"arn:aws(-cn)?:cloudfront::[0-9]+:.*" + }, + "Restrictions":{ + "type":"structure", + "required":["GeoRestriction"], + "members":{ + "GeoRestriction":{ + "shape":"GeoRestriction", + "documentation":"

A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using MaxMind GeoIP databases.

" + } + }, + "documentation":"

A complex type that identifies ways in which you want to restrict distribution of your content.

" + }, + "S3Origin":{ + "type":"structure", + "required":[ + "DomainName", + "OriginAccessIdentity" + ], + "members":{ + "DomainName":{ + "shape":"string", + "documentation":"

The DNS name of the Amazon S3 origin.

" + }, + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.

If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "S3OriginConfig":{ + "type":"structure", + "required":["OriginAccessIdentity"], + "members":{ + "OriginAccessIdentity":{ + "shape":"string", + "documentation":"

The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can only access objects in an Amazon S3 bucket through CloudFront. The format of the value is:

origin-access-identity/cloudfront/ID-of-origin-access-identity

where ID-of-origin-access-identity is the value that CloudFront returned in the ID element when you created the origin access identity.

If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element.

To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element.

To replace the origin access identity, update the distribution configuration and specify the new origin access identity.

For more information about the origin access identity, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + } + }, + "documentation":"

A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.

" + }, + "SSLSupportMethod":{ + "type":"string", + "enum":[ + "sni-only", + "vip" + ] + }, + "Signer":{ + "type":"structure", + "members":{ + "AwsAccountNumber":{ + "shape":"string", + "documentation":"

An AWS account that is included in the TrustedSigners complex type for this distribution. Valid values include:

  • self, which is the AWS account used to create the distribution.

  • An AWS account number.

" + }, + "KeyPairIds":{ + "shape":"KeyPairIds", + "documentation":"

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

" + } + }, + "documentation":"

A complex type that lists the AWS accounts that were included in the TrustedSigners complex type, as well as their active CloudFront key pair IDs, if any.

" + }, + "SignerList":{ + "type":"list", + "member":{ + "shape":"Signer", + "locationName":"Signer" + } + }, + "SslProtocol":{ + "type":"string", + "enum":[ + "SSLv3", + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + }, + "SslProtocolsList":{ + "type":"list", + "member":{ + "shape":"SslProtocol", + "locationName":"SslProtocol" + } + }, + "StatusCodeList":{ + "type":"list", + "member":{ + "shape":"integer", + "locationName":"StatusCode" + }, + "documentation":"

List of status codes for origin failover.

", + "min":1 + }, + "StatusCodes":{ + "type":"structure", + "required":[ + "Quantity", + "Items" + ], + "members":{ + "Quantity":{ + "shape":"integer", + "documentation":"

The number of status codes.

" + }, + "Items":{ + "shape":"StatusCodeList", + "documentation":"

The items (status codes) for an origin group.

" + } + }, + "documentation":"

A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin.

" + }, + "StreamingDistribution":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "DomainName", + "ActiveTrustedSigners", + "StreamingDistributionConfig" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the RTMP distribution. For example: EGTXBD79EXAMPLE.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

The current status of the RTMP distribution. When the status is Deployed, the distribution's information is propagated to all CloudFront edge locations.

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

The date and time that the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name that corresponds to the streaming distribution, for example, s5c39gqb8ow64r.cloudfront.net.

" + }, + "ActiveTrustedSigners":{ + "shape":"ActiveTrustedSigners", + "documentation":"

A complex type that lists the AWS accounts, if any, that you included in the TrustedSigners complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.

The Signer complex type lists the AWS account number of the trusted signer or self if the signer is the AWS account that created the distribution. The Signer element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create signed URLs.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The current configuration information for the RTMP distribution.

" + } + }, + "documentation":"

A streaming distribution tells CloudFront where you want RTMP content to be delivered from, and the details about how to track and manage content delivery.

" + }, + "StreamingDistributionAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The caller reference you attempted to create the streaming distribution with is associated with another distribution

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionConfig":{ + "type":"structure", + "required":[ + "CallerReference", + "S3Origin", + "Comment", + "TrustedSigners", + "Enabled" + ], + "members":{ + "CallerReference":{ + "shape":"string", + "documentation":"

A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.

If the value of CallerReference is new (regardless of the content of the StreamingDistributionConfig object), CloudFront creates a new distribution.

If CallerReference is a value that you already sent in a previous request to create a distribution, CloudFront returns a DistributionAlreadyExists error.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

Any comments you want to include about the streaming distribution.

" + }, + "Logging":{ + "shape":"StreamingLoggingConfig", + "documentation":"

A complex type that controls whether access logs are written for the streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the streaming distribution is enabled to accept user requests for content.

" + } + }, + "documentation":"

The RTMP distribution's configuration information.

" + }, + "StreamingDistributionConfigWithTags":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Tags" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

A streaming distribution Configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

" + } + }, + "documentation":"

A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.

" + }, + "StreamingDistributionList":{ + "type":"structure", + "required":[ + "Marker", + "MaxItems", + "IsTruncated", + "Quantity" + ], + "members":{ + "Marker":{ + "shape":"string", + "documentation":"

The value you provided for the Marker request parameter.

" + }, + "NextMarker":{ + "shape":"string", + "documentation":"

If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your RTMP distributions where they left off.

" + }, + "MaxItems":{ + "shape":"integer", + "documentation":"

The value you provided for the MaxItems request parameter.

" + }, + "IsTruncated":{ + "shape":"boolean", + "documentation":"

A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of streaming distributions that were created by the current AWS account.

" + }, + "Items":{ + "shape":"StreamingDistributionSummaryList", + "documentation":"

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

" + } + }, + "documentation":"

A streaming distribution list.

" + }, + "StreamingDistributionNotDisabled":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The specified CloudFront distribution is not disabled. You must disable the distribution before you can delete it.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "StreamingDistributionSummary":{ + "type":"structure", + "required":[ + "Id", + "ARN", + "Status", + "LastModifiedTime", + "DomainName", + "S3Origin", + "Aliases", + "TrustedSigners", + "Comment", + "PriceClass", + "Enabled" + ], + "members":{ + "Id":{ + "shape":"string", + "documentation":"

The identifier for the distribution, for example, EDFDVBD632BHDS5.

" + }, + "ARN":{ + "shape":"string", + "documentation":"

The ARN (Amazon Resource Name) for the streaming distribution. For example: arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID.

" + }, + "Status":{ + "shape":"string", + "documentation":"

Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.

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

The date and time the distribution was last modified.

" + }, + "DomainName":{ + "shape":"string", + "documentation":"

The domain name corresponding to the distribution, for example, d111111abcdef8.cloudfront.net.

" + }, + "S3Origin":{ + "shape":"S3Origin", + "documentation":"

A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.

" + }, + "Aliases":{ + "shape":"Aliases", + "documentation":"

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

" + }, + "TrustedSigners":{ + "shape":"TrustedSigners", + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items.If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Comment":{ + "shape":"string", + "documentation":"

The comment originally specified when this distribution was created.

" + }, + "PriceClass":{ + "shape":"PriceClass", + "documentation":"

A complex type that contains information about price class for this streaming distribution.

" + }, + "Enabled":{ + "shape":"boolean", + "documentation":"

Whether the distribution is enabled to accept end user requests for content.

" + } + }, + "documentation":"

A summary of the information for a CloudFront streaming distribution.

" + }, + "StreamingDistributionSummaryList":{ + "type":"list", + "member":{ + "shape":"StreamingDistributionSummary", + "locationName":"StreamingDistributionSummary" + } + }, + "StreamingLoggingConfig":{ + "type":"structure", + "required":[ + "Enabled", + "Bucket", + "Prefix" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.

" + }, + "Bucket":{ + "shape":"string", + "documentation":"

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty Prefix element in the Logging element.

" + } + }, + "documentation":"

A complex type that controls whether access logs are written for this streaming distribution.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A string that contains an optional Tag value.

The string length should be between 0 and 256 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

" + } + }, + "documentation":"

A complex type that contains Tag key and Tag value.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string that contains Tag key.

The string length should be between 1 and 128 characters. Valid characters include a-z, A-Z, 0-9, space, and the special characters _ - . : / = + @.

", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + } + }, + "TagKeys":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagKeyList", + "documentation":"

A complex type that contains Tag key elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A complex type that contains zero or more Tag elements.

", + "locationName":"Tags", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to add tags to a CloudFront resource.

", + "payload":"Tags" + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"TagList", + "documentation":"

A complex type that contains Tag elements.

" + } + }, + "documentation":"

A complex type that contains zero or more Tag elements.

" + }, + "TooManyCacheBehaviors":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more cache behaviors for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCertificates":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create anymore custom SSL/TLS certificates.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCloudFrontOriginAccessIdentities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin access identities allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyCookieNamesInWhiteList":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more cookie names in the whitelist than are allowed per cache behavior.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsAssociatedToFieldLevelEncryptionConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of distributions have been associated with the specified configuration for field-level encryption.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyDistributionsWithLambdaAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionConfigs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of configurations for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionContentTypeProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of content type profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionEncryptionEntities":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of encryption entities for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionFieldPatterns":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of field patterns for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyFieldLevelEncryptionQueryArgProfiles":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of query arg profiles for field-level encryption have been created.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyHeadersInForwardedValues":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains too many headers in forwarded values.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyInvalidationsInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyLambdaFunctionAssociations":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more Lambda function associations than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginCustomHeaders":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains too many origin custom headers.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOriginGroupsPerDistribution":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of origin groups allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyOrigins":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

You cannot create more origins for the distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyPublicKeys":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

The maximum number of public keys for field-level encryption have been created. To create a new public key, delete one of the existing keys.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyQueryStringParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains too many query string parameters.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributionCNAMEs":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more CNAMEs than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyStreamingDistributions":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Processing your request would cause you to exceed the maximum number of streaming distributions allowed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrustedSigners":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

Your request contains more trusted signers than are allowed per distribution.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSignerDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"string"} + }, + "documentation":"

One or more of your trusted signers don't exist.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrustedSigners":{ + "type":"structure", + "required":[ + "Enabled", + "Quantity" + ], + "members":{ + "Enabled":{ + "shape":"boolean", + "documentation":"

Specifies whether you want to require viewers to use signed URLs to access the files specified by PathPattern and TargetOriginId.

" + }, + "Quantity":{ + "shape":"integer", + "documentation":"

The number of trusted signers for this cache behavior.

" + }, + "Items":{ + "shape":"AwsAccountNumberList", + "documentation":"

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

" + } + }, + "documentation":"

A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.

If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, see Serving Private Content through CloudFront in the Amazon CloudFront Developer Guide.

If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items.

To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.

For more information about updating the distribution configuration, see DistributionConfig in the Amazon CloudFront API Reference.

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ResourceARN", + "documentation":"

An ARN of a CloudFront resource.

", + "location":"querystring", + "locationName":"Resource" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A complex type that contains zero or more Tag key elements.

", + "locationName":"TagKeys", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + } + }, + "documentation":"

The request to remove tags from a CloudFront resource.

", + "payload":"TagKeys" + }, + "UpdateCloudFrontOriginAccessIdentityRequest":{ + "type":"structure", + "required":[ + "CloudFrontOriginAccessIdentityConfig", + "Id" + ], + "members":{ + "CloudFrontOriginAccessIdentityConfig":{ + "shape":"CloudFrontOriginAccessIdentityConfig", + "documentation":"

The identity's configuration information.

", + "locationName":"CloudFrontOriginAccessIdentityConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The identity's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update an origin access identity.

", + "payload":"CloudFrontOriginAccessIdentityConfig" + }, + "UpdateCloudFrontOriginAccessIdentityResult":{ + "type":"structure", + "members":{ + "CloudFrontOriginAccessIdentity":{ + "shape":"CloudFrontOriginAccessIdentity", + "documentation":"

The origin access identity's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"CloudFrontOriginAccessIdentity" + }, + "UpdateDistributionRequest":{ + "type":"structure", + "required":[ + "DistributionConfig", + "Id" + ], + "members":{ + "DistributionConfig":{ + "shape":"DistributionConfig", + "documentation":"

The distribution's configuration information.

", + "locationName":"DistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a distribution.

", + "payload":"DistributionConfig" + }, + "UpdateDistributionResult":{ + "type":"structure", + "members":{ + "Distribution":{ + "shape":"Distribution", + "documentation":"

The distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"Distribution" + }, + "UpdateFieldLevelEncryptionConfigRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionConfig":{ + "shape":"FieldLevelEncryptionConfig", + "documentation":"

Request to update a field-level encryption configuration.

", + "locationName":"FieldLevelEncryptionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the configuration you want to update.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the configuration identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionConfig" + }, + "UpdateFieldLevelEncryptionConfigResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryption":{ + "shape":"FieldLevelEncryption", + "documentation":"

Return the results of updating the configuration.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when updating the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryption" + }, + "UpdateFieldLevelEncryptionProfileRequest":{ + "type":"structure", + "required":[ + "FieldLevelEncryptionProfileConfig", + "Id" + ], + "members":{ + "FieldLevelEncryptionProfileConfig":{ + "shape":"FieldLevelEncryptionProfileConfig", + "documentation":"

Request to update a field-level encryption profile.

", + "locationName":"FieldLevelEncryptionProfileConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The ID of the field-level encryption profile request.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the profile identity to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"FieldLevelEncryptionProfileConfig" + }, + "UpdateFieldLevelEncryptionProfileResult":{ + "type":"structure", + "members":{ + "FieldLevelEncryptionProfile":{ + "shape":"FieldLevelEncryptionProfile", + "documentation":"

Return the results of updating the profile.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The result of the field-level encryption profile request.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"FieldLevelEncryptionProfile" + }, + "UpdatePublicKeyRequest":{ + "type":"structure", + "required":[ + "PublicKeyConfig", + "Id" + ], + "members":{ + "PublicKeyConfig":{ + "shape":"PublicKeyConfig", + "documentation":"

Request to update public key information.

", + "locationName":"PublicKeyConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

ID of the public key to be updated.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the public key to update. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "payload":"PublicKeyConfig" + }, + "UpdatePublicKeyResult":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

Return the results of updating the public key.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the update public key result. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "payload":"PublicKey" + }, + "UpdateStreamingDistributionRequest":{ + "type":"structure", + "required":[ + "StreamingDistributionConfig", + "Id" + ], + "members":{ + "StreamingDistributionConfig":{ + "shape":"StreamingDistributionConfig", + "documentation":"

The streaming distribution's configuration information.

", + "locationName":"StreamingDistributionConfig", + "xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2019-03-26/"} + }, + "Id":{ + "shape":"string", + "documentation":"

The streaming distribution's id.

", + "location":"uri", + "locationName":"Id" + }, + "IfMatch":{ + "shape":"string", + "documentation":"

The value of the ETag header that you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"If-Match" + } + }, + "documentation":"

The request to update a streaming distribution.

", + "payload":"StreamingDistributionConfig" + }, + "UpdateStreamingDistributionResult":{ + "type":"structure", + "members":{ + "StreamingDistribution":{ + "shape":"StreamingDistribution", + "documentation":"

The streaming distribution's information.

" + }, + "ETag":{ + "shape":"string", + "documentation":"

The current version of the configuration. For example: E2QWRUHAPOMQZL.

", + "location":"header", + "locationName":"ETag" + } + }, + "documentation":"

The returned result of the corresponding request.

", + "payload":"StreamingDistribution" + }, + "ViewerCertificate":{ + "type":"structure", + "members":{ + "CloudFrontDefaultCertificate":{ + "shape":"boolean", + "documentation":"

If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value:

  • <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

" + }, + "IAMCertificateId":{ + "shape":"string", + "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority:

  • <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod.

" + }, + "ACMCertificateArn":{ + "shape":"string", + "documentation":"

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate:

  • <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod.

" + }, + "SSLSupportMethod":{ + "shape":"SSLSupportMethod", + "documentation":"

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

  • sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

  • vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

" + }, + "MinimumProtocolVersion":{ + "shape":"MinimumProtocolVersion", + "documentation":"

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

  • The cipher that CloudFront uses to encrypt the content that it returns to viewers

On the CloudFront console, this setting is called Security policy.

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

  • You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

  • You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

" + }, + "Certificate":{ + "shape":"string", + "documentation":"

This field is no longer used. Use one of the following fields instead:

", + "deprecated":true + }, + "CertificateSource":{ + "shape":"CertificateSource", + "documentation":"

This field is no longer used. Use one of the following fields instead:

", + "deprecated":true + } + }, + "documentation":"

A complex type that specifies the following:

  • Whether you want viewers to use HTTP or HTTPS to request your objects.

  • If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net.

  • If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.

Specify only one of the following values:

For more information, see Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + }, + "ViewerProtocolPolicy":{ + "type":"string", + "enum":[ + "allow-all", + "https-only", + "redirect-to-https" + ] + }, + "boolean":{"type":"boolean"}, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"Amazon CloudFront

This is the Amazon CloudFront API Reference. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the Amazon CloudFront Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudfront/2019-03-26/waiters-2.json b/aws/dist/botocore/data/cloudfront/2019-03-26/waiters-2.json new file mode 100644 index 00000000..95f0a2dd --- /dev/null +++ b/aws/dist/botocore/data/cloudfront/2019-03-26/waiters-2.json @@ -0,0 +1,47 @@ +{ + "version": 2, + "waiters": { + "DistributionDeployed": { + "delay": 60, + "operation": "GetDistribution", + "maxAttempts": 35, + "description": "Wait until a distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "Distribution.Status" + } + ] + }, + "InvalidationCompleted": { + "delay": 20, + "operation": "GetInvalidation", + "maxAttempts": 30, + "description": "Wait until an invalidation has completed.", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "Invalidation.Status" + } + ] + }, + "StreamingDistributionDeployed": { + "delay": 60, + "operation": "GetStreamingDistribution", + "maxAttempts": 25, + "description": "Wait until a streaming distribution is deployed.", + "acceptors": [ + { + "expected": "Deployed", + "matcher": "path", + "state": "success", + "argument": "StreamingDistribution.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudhsm/2014-05-30/examples-1.json b/aws/dist/botocore/data/cloudhsm/2014-05-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudhsm/2014-05-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudhsm/2014-05-30/paginators-1.json b/aws/dist/botocore/data/cloudhsm/2014-05-30/paginators-1.json new file mode 100644 index 00000000..3dedddf1 --- /dev/null +++ b/aws/dist/botocore/data/cloudhsm/2014-05-30/paginators-1.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListHapgs": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "HapgList" + }, + "ListHsms": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "HsmList" + }, + "ListLunaClients": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ClientList" + } + } +} diff --git a/aws/dist/botocore/data/cloudhsm/2014-05-30/service-2.json b/aws/dist/botocore/data/cloudhsm/2014-05-30/service-2.json new file mode 100644 index 00000000..139daddb --- /dev/null +++ b/aws/dist/botocore/data/cloudhsm/2014-05-30/service-2.json @@ -0,0 +1,1197 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-05-30", + "endpointPrefix":"cloudhsm", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CloudHSM", + "serviceFullName":"Amazon CloudHSM", + "serviceId":"CloudHSM", + "signatureVersion":"v4", + "targetPrefix":"CloudHsmFrontendService", + "uid":"cloudhsm-2014-05-30" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceRequest"}, + "output":{"shape":"AddTagsToResourceResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Adds or overwrites one or more tags for the specified AWS CloudHSM resource.

Each tag consists of a key and a value. Tag keys must be unique to each resource.

" + }, + "CreateHapg":{ + "name":"CreateHapg", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHapgRequest"}, + "output":{"shape":"CreateHapgResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

" + }, + "CreateHsm":{ + "name":"CreateHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmRequest"}, + "output":{"shape":"CreateHsmResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center, create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

" + }, + "CreateLunaClient":{ + "name":"CreateLunaClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLunaClientRequest"}, + "output":{"shape":"CreateLunaClientResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Creates an HSM client.

" + }, + "DeleteHapg":{ + "name":"DeleteHapg", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHapgRequest"}, + "output":{"shape":"DeleteHapgResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Deletes a high-availability partition group.

" + }, + "DeleteHsm":{ + "name":"DeleteHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmRequest"}, + "output":{"shape":"DeleteHsmResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

" + }, + "DeleteLunaClient":{ + "name":"DeleteLunaClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLunaClientRequest"}, + "output":{"shape":"DeleteLunaClientResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Deletes a client.

" + }, + "DescribeHapg":{ + "name":"DescribeHapg", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHapgRequest"}, + "output":{"shape":"DescribeHapgResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Retrieves information about a high-availability partition group.

" + }, + "DescribeHsm":{ + "name":"DescribeHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHsmRequest"}, + "output":{"shape":"DescribeHsmResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

" + }, + "DescribeLunaClient":{ + "name":"DescribeLunaClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLunaClientRequest"}, + "output":{"shape":"DescribeLunaClientResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Retrieves information about an HSM client.

" + }, + "GetConfig":{ + "name":"GetConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConfigRequest"}, + "output":{"shape":"GetConfigResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

" + }, + "ListAvailableZones":{ + "name":"ListAvailableZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableZonesRequest"}, + "output":{"shape":"ListAvailableZonesResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Lists the Availability Zones that have available AWS CloudHSM capacity.

" + }, + "ListHapgs":{ + "name":"ListHapgs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHapgsRequest"}, + "output":{"shape":"ListHapgsResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

" + }, + "ListHsms":{ + "name":"ListHsms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHsmsRequest"}, + "output":{"shape":"ListHsmsResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

" + }, + "ListLunaClients":{ + "name":"ListLunaClients", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLunaClientsRequest"}, + "output":{"shape":"ListLunaClientsResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Returns a list of all tags for the specified AWS CloudHSM resource.

" + }, + "ModifyHapg":{ + "name":"ModifyHapg", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHapgRequest"}, + "output":{"shape":"ModifyHapgResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Modifies an existing high-availability partition group.

" + }, + "ModifyHsm":{ + "name":"ModifyHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHsmRequest"}, + "output":{"shape":"ModifyHsmResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

" + }, + "ModifyLunaClient":{ + "name":"ModifyLunaClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyLunaClientRequest"}, + "output":{"shape":"ModifyLunaClientResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceRequest"}, + "output":{"shape":"RemoveTagsFromResourceResponse"}, + "errors":[ + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInternalException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

" + } + }, + "shapes":{ + "AZ":{ + "type":"string", + "pattern":"[a-zA-Z0-9\\-]*" + }, + "AZList":{ + "type":"list", + "member":{"shape":"AZ"} + }, + "AddTagsToResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagList" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

" + }, + "TagList":{ + "shape":"TagList", + "documentation":"

One or more tags.

" + } + } + }, + "AddTagsToResourceResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the operation.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "Certificate":{ + "type":"string", + "max":2400, + "min":600, + "pattern":"[\\w :+=./\\n-]*" + }, + "CertificateFingerprint":{ + "type":"string", + "pattern":"([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]" + }, + "ClientArn":{ + "type":"string", + "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}" + }, + "ClientLabel":{ + "type":"string", + "pattern":"[a-zA-Z0-9_.-]{2,64}" + }, + "ClientList":{ + "type":"list", + "member":{"shape":"ClientArn"} + }, + "ClientToken":{ + "type":"string", + "pattern":"[a-zA-Z0-9]{1,64}" + }, + "ClientVersion":{ + "type":"string", + "enum":[ + "5.1", + "5.3" + ] + }, + "CloudHsmInternalException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Indicates that an internal error occurred.

", + "exception":true, + "fault":true + }, + "CloudHsmObjectState":{ + "type":"string", + "enum":[ + "READY", + "UPDATING", + "DEGRADED" + ] + }, + "CloudHsmServiceException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

Additional information about the error.

" + }, + "retryable":{ + "shape":"Boolean", + "documentation":"

Indicates if the action can be retried.

" + } + }, + "documentation":"

Indicates that an exception occurred in the AWS CloudHSM service.

", + "exception":true + }, + "CreateHapgRequest":{ + "type":"structure", + "required":["Label"], + "members":{ + "Label":{ + "shape":"Label", + "documentation":"

The label of the new high-availability partition group.

" + } + }, + "documentation":"

Contains the inputs for the CreateHapgRequest action.

" + }, + "CreateHapgResponse":{ + "type":"structure", + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group.

" + } + }, + "documentation":"

Contains the output of the CreateHAPartitionGroup action.

" + }, + "CreateHsmRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "SshKey", + "IamRoleArn", + "SubscriptionType" + ], + "members":{ + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The identifier of the subnet in your VPC in which to place the HSM.

", + "locationName":"SubnetId" + }, + "SshKey":{ + "shape":"SshKey", + "documentation":"

The SSH public key to install on the HSM.

", + "locationName":"SshKey" + }, + "EniIp":{ + "shape":"IpAddress", + "documentation":"

The IP address to assign to the HSM's ENI.

If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.

", + "locationName":"EniIp" + }, + "IamRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

", + "locationName":"IamRoleArn" + }, + "ExternalId":{ + "shape":"ExternalId", + "documentation":"

The external ID from IamRoleArn, if present.

", + "locationName":"ExternalId" + }, + "SubscriptionType":{ + "shape":"SubscriptionType", + "locationName":"SubscriptionType" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

", + "locationName":"ClientToken" + }, + "SyslogIp":{ + "shape":"IpAddress", + "documentation":"

The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

", + "locationName":"SyslogIp" + } + }, + "documentation":"

Contains the inputs for the CreateHsm operation.

", + "locationName":"CreateHsmRequest" + }, + "CreateHsmResponse":{ + "type":"structure", + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM.

" + } + }, + "documentation":"

Contains the output of the CreateHsm operation.

" + }, + "CreateLunaClientRequest":{ + "type":"structure", + "required":["Certificate"], + "members":{ + "Label":{ + "shape":"ClientLabel", + "documentation":"

The label for the client.

" + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

" + } + }, + "documentation":"

Contains the inputs for the CreateLunaClient action.

" + }, + "CreateLunaClientResponse":{ + "type":"structure", + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + } + }, + "documentation":"

Contains the output of the CreateLunaClient action.

" + }, + "DeleteHapgRequest":{ + "type":"structure", + "required":["HapgArn"], + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group to delete.

" + } + }, + "documentation":"

Contains the inputs for the DeleteHapg action.

" + }, + "DeleteHapgResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the action.

" + } + }, + "documentation":"

Contains the output of the DeleteHapg action.

" + }, + "DeleteHsmRequest":{ + "type":"structure", + "required":["HsmArn"], + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM to delete.

", + "locationName":"HsmArn" + } + }, + "documentation":"

Contains the inputs for the DeleteHsm operation.

", + "locationName":"DeleteHsmRequest" + }, + "DeleteHsmResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the operation.

" + } + }, + "documentation":"

Contains the output of the DeleteHsm operation.

" + }, + "DeleteLunaClientRequest":{ + "type":"structure", + "required":["ClientArn"], + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client to delete.

" + } + } + }, + "DeleteLunaClientResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the action.

" + } + } + }, + "DescribeHapgRequest":{ + "type":"structure", + "required":["HapgArn"], + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group to describe.

" + } + }, + "documentation":"

Contains the inputs for the DescribeHapg action.

" + }, + "DescribeHapgResponse":{ + "type":"structure", + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group.

" + }, + "HapgSerial":{ + "shape":"String", + "documentation":"

The serial number of the high-availability partition group.

" + }, + "HsmsLastActionFailed":{ + "shape":"HsmList", + "documentation":"

" + }, + "HsmsPendingDeletion":{ + "shape":"HsmList", + "documentation":"

" + }, + "HsmsPendingRegistration":{ + "shape":"HsmList", + "documentation":"

" + }, + "Label":{ + "shape":"Label", + "documentation":"

The label for the high-availability partition group.

" + }, + "LastModifiedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time the high-availability partition group was last modified.

" + }, + "PartitionSerialList":{ + "shape":"PartitionSerialList", + "documentation":"

The list of partition serial numbers that belong to the high-availability partition group.

" + }, + "State":{ + "shape":"CloudHsmObjectState", + "documentation":"

The state of the high-availability partition group.

" + } + }, + "documentation":"

Contains the output of the DescribeHapg action.

" + }, + "DescribeHsmRequest":{ + "type":"structure", + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.

" + }, + "HsmSerialNumber":{ + "shape":"HsmSerialNumber", + "documentation":"

The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.

" + } + }, + "documentation":"

Contains the inputs for the DescribeHsm operation.

" + }, + "DescribeHsmResponse":{ + "type":"structure", + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM.

" + }, + "Status":{ + "shape":"HsmStatus", + "documentation":"

The status of the HSM.

" + }, + "StatusDetails":{ + "shape":"String", + "documentation":"

Contains additional information about the status of the HSM.

" + }, + "AvailabilityZone":{ + "shape":"AZ", + "documentation":"

The Availability Zone that the HSM is in.

" + }, + "EniId":{ + "shape":"EniId", + "documentation":"

The identifier of the elastic network interface (ENI) attached to the HSM.

" + }, + "EniIp":{ + "shape":"IpAddress", + "documentation":"

The IP address assigned to the HSM's ENI.

" + }, + "SubscriptionType":{"shape":"SubscriptionType"}, + "SubscriptionStartDate":{ + "shape":"Timestamp", + "documentation":"

The subscription start date.

" + }, + "SubscriptionEndDate":{ + "shape":"Timestamp", + "documentation":"

The subscription end date.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC that the HSM is in.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The identifier of the subnet that the HSM is in.

" + }, + "IamRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The ARN of the IAM role assigned to the HSM.

" + }, + "SerialNumber":{ + "shape":"HsmSerialNumber", + "documentation":"

The serial number of the HSM.

" + }, + "VendorName":{ + "shape":"String", + "documentation":"

The name of the HSM vendor.

" + }, + "HsmType":{ + "shape":"String", + "documentation":"

The HSM model type.

" + }, + "SoftwareVersion":{ + "shape":"String", + "documentation":"

The HSM software version.

" + }, + "SshPublicKey":{ + "shape":"SshKey", + "documentation":"

The public SSH key.

" + }, + "SshKeyLastUpdated":{ + "shape":"Timestamp", + "documentation":"

The date and time that the SSH key was last updated.

" + }, + "ServerCertUri":{ + "shape":"String", + "documentation":"

The URI of the certificate server.

" + }, + "ServerCertLastUpdated":{ + "shape":"Timestamp", + "documentation":"

The date and time that the server certificate was last updated.

" + }, + "Partitions":{ + "shape":"PartitionList", + "documentation":"

The list of partitions on the HSM.

" + } + }, + "documentation":"

Contains the output of the DescribeHsm operation.

" + }, + "DescribeLunaClientRequest":{ + "type":"structure", + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + }, + "CertificateFingerprint":{ + "shape":"CertificateFingerprint", + "documentation":"

The certificate fingerprint.

" + } + } + }, + "DescribeLunaClientResponse":{ + "type":"structure", + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"

The certificate installed on the HSMs used by this client.

" + }, + "CertificateFingerprint":{ + "shape":"CertificateFingerprint", + "documentation":"

The certificate fingerprint.

" + }, + "LastModifiedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time the client was last modified.

" + }, + "Label":{ + "shape":"Label", + "documentation":"

The label of the client.

" + } + } + }, + "EniId":{ + "type":"string", + "pattern":"eni-[0-9a-f]{8}" + }, + "ExternalId":{ + "type":"string", + "pattern":"[\\w :+=./-]*" + }, + "GetConfigRequest":{ + "type":"structure", + "required":[ + "ClientArn", + "ClientVersion", + "HapgList" + ], + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + }, + "ClientVersion":{ + "shape":"ClientVersion", + "documentation":"

The client version.

" + }, + "HapgList":{ + "shape":"HapgList", + "documentation":"

A list of ARNs that identify the high-availability partition groups that are associated with the client.

" + } + } + }, + "GetConfigResponse":{ + "type":"structure", + "members":{ + "ConfigType":{ + "shape":"String", + "documentation":"

The type of credentials.

" + }, + "ConfigFile":{ + "shape":"String", + "documentation":"

The chrystoki.conf configuration file.

" + }, + "ConfigCred":{ + "shape":"String", + "documentation":"

The certificate file containing the server.pem files of the HSMs.

" + } + } + }, + "HapgArn":{ + "type":"string", + "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}" + }, + "HapgList":{ + "type":"list", + "member":{"shape":"HapgArn"} + }, + "HsmArn":{ + "type":"string", + "documentation":"

An ARN that identifies an HSM.

", + "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}" + }, + "HsmList":{ + "type":"list", + "member":{"shape":"HsmArn"}, + "documentation":"

Contains a list of ARNs that identify the HSMs.

" + }, + "HsmSerialNumber":{ + "type":"string", + "pattern":"\\d{1,16}" + }, + "HsmStatus":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "UPDATING", + "SUSPENDED", + "TERMINATING", + "TERMINATED", + "DEGRADED" + ] + }, + "IamRoleArn":{ + "type":"string", + "pattern":"arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}" + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Indicates that one or more of the request parameters are not valid.

", + "exception":true + }, + "IpAddress":{ + "type":"string", + "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" + }, + "Label":{ + "type":"string", + "pattern":"[a-zA-Z0-9_.-]{1,64}" + }, + "ListAvailableZonesRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the inputs for the ListAvailableZones action.

" + }, + "ListAvailableZonesResponse":{ + "type":"structure", + "members":{ + "AZList":{ + "shape":"AZList", + "documentation":"

The list of Availability Zones that have available AWS CloudHSM capacity.

" + } + } + }, + "ListHapgsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.

" + } + } + }, + "ListHapgsResponse":{ + "type":"structure", + "required":["HapgList"], + "members":{ + "HapgList":{ + "shape":"HapgList", + "documentation":"

The list of high-availability partition groups.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.

" + } + } + }, + "ListHsmsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The NextToken value from a previous call to ListHsms. Pass null if this is the first call.

" + } + } + }, + "ListHsmsResponse":{ + "type":"structure", + "members":{ + "HsmList":{ + "shape":"HsmList", + "documentation":"

The list of ARNs that identify the HSMs.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.

" + } + }, + "documentation":"

Contains the output of the ListHsms operation.

" + }, + "ListLunaClientsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.

" + } + } + }, + "ListLunaClientsResponse":{ + "type":"structure", + "required":["ClientList"], + "members":{ + "ClientList":{ + "shape":"ClientList", + "documentation":"

The list of clients.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["TagList"], + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

One or more tags.

" + } + } + }, + "ModifyHapgRequest":{ + "type":"structure", + "required":["HapgArn"], + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group to modify.

" + }, + "Label":{ + "shape":"Label", + "documentation":"

The new label for the high-availability partition group.

" + }, + "PartitionSerialList":{ + "shape":"PartitionSerialList", + "documentation":"

The list of partition serial numbers to make members of the high-availability partition group.

" + } + } + }, + "ModifyHapgResponse":{ + "type":"structure", + "members":{ + "HapgArn":{ + "shape":"HapgArn", + "documentation":"

The ARN of the high-availability partition group.

" + } + } + }, + "ModifyHsmRequest":{ + "type":"structure", + "required":["HsmArn"], + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM to modify.

", + "locationName":"HsmArn" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.

", + "locationName":"SubnetId" + }, + "EniIp":{ + "shape":"IpAddress", + "documentation":"

The new IP address for the elastic network interface (ENI) attached to the HSM.

If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.

", + "locationName":"EniIp" + }, + "IamRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The new IAM role ARN.

", + "locationName":"IamRoleArn" + }, + "ExternalId":{ + "shape":"ExternalId", + "documentation":"

The new external ID.

", + "locationName":"ExternalId" + }, + "SyslogIp":{ + "shape":"IpAddress", + "documentation":"

The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.

", + "locationName":"SyslogIp" + } + }, + "documentation":"

Contains the inputs for the ModifyHsm operation.

", + "locationName":"ModifyHsmRequest" + }, + "ModifyHsmResponse":{ + "type":"structure", + "members":{ + "HsmArn":{ + "shape":"HsmArn", + "documentation":"

The ARN of the HSM.

" + } + }, + "documentation":"

Contains the output of the ModifyHsm operation.

" + }, + "ModifyLunaClientRequest":{ + "type":"structure", + "required":[ + "ClientArn", + "Certificate" + ], + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"

The new certificate for the client.

" + } + } + }, + "ModifyLunaClientResponse":{ + "type":"structure", + "members":{ + "ClientArn":{ + "shape":"ClientArn", + "documentation":"

The ARN of the client.

" + } + } + }, + "PaginationToken":{ + "type":"string", + "pattern":"[a-zA-Z0-9+/]*" + }, + "PartitionArn":{ + "type":"string", + "pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}" + }, + "PartitionList":{ + "type":"list", + "member":{"shape":"PartitionArn"} + }, + "PartitionSerial":{ + "type":"string", + "pattern":"\\d{6,12}" + }, + "PartitionSerialList":{ + "type":"list", + "member":{"shape":"PartitionSerial"} + }, + "RemoveTagsFromResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeyList" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

" + }, + "TagKeyList":{ + "shape":"TagKeyList", + "documentation":"

The tag key or keys to remove.

Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

" + } + } + }, + "RemoveTagsFromResourceResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the operation.

" + } + } + }, + "SshKey":{ + "type":"string", + "pattern":"[a-zA-Z0-9+/= ._:\\\\@-]*" + }, + "String":{ + "type":"string", + "pattern":"[\\w :+=./\\\\-]*" + }, + "SubnetId":{ + "type":"string", + "pattern":"subnet-[0-9a-f]{8}" + }, + "SubscriptionType":{ + "type":"string", + "documentation":"

Specifies the type of subscription for the HSM.

  • PRODUCTION - The HSM is being used in a production environment.

  • TRIAL - The HSM is being used in a product trial.

", + "enum":["PRODUCTION"] + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Timestamp":{ + "type":"string", + "pattern":"\\d*" + }, + "VpcId":{ + "type":"string", + "pattern":"vpc-[0-9a-f]{8}" + } + }, + "documentation":"AWS CloudHSM Service

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs, the AWS CloudHSM Classic User Guide, and the AWS CloudHSM Classic API Reference.

For information about the current version of AWS CloudHSM, see AWS CloudHSM, the AWS CloudHSM User Guide, and the AWS CloudHSM API Reference.

" +} diff --git a/aws/dist/botocore/data/cloudhsmv2/2017-04-28/paginators-1.json b/aws/dist/botocore/data/cloudhsmv2/2017-04-28/paginators-1.json new file mode 100644 index 00000000..19c403f0 --- /dev/null +++ b/aws/dist/botocore/data/cloudhsmv2/2017-04-28/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeBackups": { + "result_key": "Backups", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeClusters": { + "result_key": "Clusters", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "result_key": "TagList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/cloudhsmv2/2017-04-28/service-2.json b/aws/dist/botocore/data/cloudhsmv2/2017-04-28/service-2.json new file mode 100644 index 00000000..31c7a261 --- /dev/null +++ b/aws/dist/botocore/data/cloudhsmv2/2017-04-28/service-2.json @@ -0,0 +1,979 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-04-28", + "endpointPrefix":"cloudhsmv2", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CloudHSM V2", + "serviceFullName":"AWS CloudHSM V2", + "serviceId":"CloudHSM V2", + "signatureVersion":"v4", + "signingName":"cloudhsm", + "targetPrefix":"BaldrApiService", + "uid":"cloudhsmv2-2017-04-28" + }, + "operations":{ + "CopyBackupToRegion":{ + "name":"CopyBackupToRegion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyBackupToRegionRequest"}, + "output":{"shape":"CopyBackupToRegionResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Copy an AWS CloudHSM cluster backup to a different region.

" + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Creates a new AWS CloudHSM cluster.

" + }, + "CreateHsm":{ + "name":"CreateHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmRequest"}, + "output":{"shape":"CreateHsmResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

" + }, + "DeleteBackup":{ + "name":"DeleteBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBackupRequest"}, + "output":{"shape":"DeleteBackupResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup

" + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterRequest"}, + "output":{"shape":"DeleteClusterResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

" + }, + "DeleteHsm":{ + "name":"DeleteHsm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmRequest"}, + "output":{"shape":"DeleteHsmResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

" + }, + "DescribeBackups":{ + "name":"DescribeBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBackupsRequest"}, + "output":{"shape":"DescribeBackupsResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

" + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClustersRequest"}, + "output":{"shape":"DescribeClustersResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

" + }, + "InitializeCluster":{ + "name":"InitializeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InitializeClusterRequest"}, + "output":{"shape":"InitializeClusterResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

" + }, + "RestoreBackup":{ + "name":"RestoreBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreBackupRequest"}, + "output":{"shape":"RestoreBackupResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"CloudHsmInternalFailureException"}, + {"shape":"CloudHsmServiceException"}, + {"shape":"CloudHsmResourceNotFoundException"}, + {"shape":"CloudHsmInvalidRequestException"}, + {"shape":"CloudHsmAccessDeniedException"} + ], + "documentation":"

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

" + } + }, + "shapes":{ + "Backup":{ + "type":"structure", + "required":["BackupId"], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The identifier (ID) of the backup.

" + }, + "BackupState":{ + "shape":"BackupState", + "documentation":"

The state of the backup.

" + }, + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the cluster that was backed up.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time when the backup was created.

" + }, + "CopyTimestamp":{"shape":"Timestamp"}, + "SourceRegion":{"shape":"Region"}, + "SourceBackup":{"shape":"BackupId"}, + "SourceCluster":{"shape":"ClusterId"}, + "DeleteTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time when the backup will be permanently deleted.

" + } + }, + "documentation":"

Contains information about a backup of an AWS CloudHSM cluster.

" + }, + "BackupId":{ + "type":"string", + "pattern":"backup-[2-7a-zA-Z]{11,16}" + }, + "BackupPolicy":{ + "type":"string", + "enum":["DEFAULT"] + }, + "BackupState":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "READY", + "DELETED", + "PENDING_DELETION" + ] + }, + "Backups":{ + "type":"list", + "member":{"shape":"Backup"} + }, + "Boolean":{"type":"boolean"}, + "Cert":{ + "type":"string", + "max":5000, + "pattern":"[a-zA-Z0-9+-/=\\s]*" + }, + "Certificates":{ + "type":"structure", + "members":{ + "ClusterCsr":{ + "shape":"Cert", + "documentation":"

The cluster's certificate signing request (CSR). The CSR exists only when the cluster's state is UNINITIALIZED.

" + }, + "HsmCertificate":{ + "shape":"Cert", + "documentation":"

The HSM certificate issued (signed) by the HSM hardware.

" + }, + "AwsHardwareCertificate":{ + "shape":"Cert", + "documentation":"

The HSM hardware certificate issued (signed) by AWS CloudHSM.

" + }, + "ManufacturerHardwareCertificate":{ + "shape":"Cert", + "documentation":"

The HSM hardware certificate issued (signed) by the hardware manufacturer.

" + }, + "ClusterCertificate":{ + "shape":"Cert", + "documentation":"

The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.

" + } + }, + "documentation":"

Contains one or more certificates or a certificate signing request (CSR).

" + }, + "CloudHsmAccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The request was rejected because the requester does not have permission to perform the requested operation.

", + "exception":true + }, + "CloudHsmInternalFailureException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.

", + "exception":true, + "fault":true + }, + "CloudHsmInvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The request was rejected because it is not a valid request.

", + "exception":true + }, + "CloudHsmResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The request was rejected because it refers to a resource that cannot be found.

", + "exception":true + }, + "CloudHsmServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

The request was rejected because an error occurred.

", + "exception":true + }, + "Cluster":{ + "type":"structure", + "members":{ + "BackupPolicy":{ + "shape":"BackupPolicy", + "documentation":"

The cluster's backup policy.

" + }, + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The cluster's identifier (ID).

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time when the cluster was created.

" + }, + "Hsms":{ + "shape":"Hsms", + "documentation":"

Contains information about the HSMs in the cluster.

" + }, + "HsmType":{ + "shape":"HsmType", + "documentation":"

The type of HSM that the cluster contains.

" + }, + "PreCoPassword":{ + "shape":"PreCoPassword", + "documentation":"

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

" + }, + "SecurityGroup":{ + "shape":"SecurityGroup", + "documentation":"

The identifier (ID) of the cluster's security group.

" + }, + "SourceBackupId":{ + "shape":"BackupId", + "documentation":"

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

" + }, + "State":{ + "shape":"ClusterState", + "documentation":"

The cluster's state.

" + }, + "StateMessage":{ + "shape":"StateMessage", + "documentation":"

A description of the cluster's state.

" + }, + "SubnetMapping":{ + "shape":"ExternalSubnetMapping", + "documentation":"

A map of the cluster's subnets and their corresponding Availability Zones.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

" + }, + "Certificates":{ + "shape":"Certificates", + "documentation":"

Contains one or more certificates or a certificate signing request (CSR).

" + } + }, + "documentation":"

Contains information about an AWS CloudHSM cluster.

" + }, + "ClusterId":{ + "type":"string", + "pattern":"cluster-[2-7a-zA-Z]{11,16}" + }, + "ClusterState":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "UNINITIALIZED", + "INITIALIZE_IN_PROGRESS", + "INITIALIZED", + "ACTIVE", + "UPDATE_IN_PROGRESS", + "DELETE_IN_PROGRESS", + "DELETED", + "DEGRADED" + ] + }, + "Clusters":{ + "type":"list", + "member":{"shape":"Cluster"} + }, + "CopyBackupToRegionRequest":{ + "type":"structure", + "required":[ + "DestinationRegion", + "BackupId" + ], + "members":{ + "DestinationRegion":{ + "shape":"Region", + "documentation":"

The AWS region that will contain your copied CloudHSM cluster backup.

" + }, + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup that will be copied to the destination region.

" + } + } + }, + "CopyBackupToRegionResponse":{ + "type":"structure", + "members":{ + "DestinationBackup":{ + "shape":"DestinationBackup", + "documentation":"

Information on the backup that will be copied to the destination region, including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. CreateTimestamp of the destination backup will be the same as that of the source backup.

You will need to use the sourceBackupID returned in this operation to use the DescribeBackups operation on the backup that will be copied to the destination region.

" + } + } + }, + "CreateClusterRequest":{ + "type":"structure", + "required":[ + "SubnetIds", + "HsmType" + ], + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

  • All subnets must be in the same virtual private cloud (VPC).

  • You can specify only one subnet per Availability Zone.

" + }, + "HsmType":{ + "shape":"HsmType", + "documentation":"

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

" + }, + "SourceBackupId":{ + "shape":"BackupId", + "documentation":"

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

" + } + } + }, + "CreateClusterResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

Information about the cluster that was created.

" + } + } + }, + "CreateHsmRequest":{ + "type":"structure", + "required":[ + "ClusterId", + "AvailabilityZone" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.

" + }, + "AvailabilityZone":{ + "shape":"ExternalAz", + "documentation":"

The Availability Zone where you are creating the HSM. To find the cluster's Availability Zones, use DescribeClusters.

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

The HSM's IP address. If you specify an IP address, use an available address from the subnet that maps to the Availability Zone where you are creating the HSM. If you don't specify an IP address, one is chosen for you from that subnet.

" + } + } + }, + "CreateHsmResponse":{ + "type":"structure", + "members":{ + "Hsm":{ + "shape":"Hsm", + "documentation":"

Information about the HSM that was created.

" + } + } + }, + "DeleteBackupRequest":{ + "type":"structure", + "required":["BackupId"], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups operation.

" + } + } + }, + "DeleteBackupResponse":{ + "type":"structure", + "members":{ + "Backup":{ + "shape":"Backup", + "documentation":"

Information on the Backup object deleted.

" + } + } + }, + "DeleteClusterRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the cluster that you are deleting. To find the cluster ID, use DescribeClusters.

" + } + } + }, + "DeleteClusterResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

Information about the cluster that was deleted.

" + } + } + }, + "DeleteHsmRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the cluster that contains the HSM that you are deleting.

" + }, + "HsmId":{ + "shape":"HsmId", + "documentation":"

The identifier (ID) of the HSM that you are deleting.

" + }, + "EniId":{ + "shape":"EniId", + "documentation":"

The identifier (ID) of the elastic network interface (ENI) of the HSM that you are deleting.

" + }, + "EniIp":{ + "shape":"IpAddress", + "documentation":"

The IP address of the elastic network interface (ENI) of the HSM that you are deleting.

" + } + } + }, + "DeleteHsmResponse":{ + "type":"structure", + "members":{ + "HsmId":{ + "shape":"HsmId", + "documentation":"

The identifier (ID) of the HSM that was deleted.

" + } + } + }, + "DescribeBackupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The NextToken value that you received in the previous response. Use this value to get more backups.

" + }, + "MaxResults":{ + "shape":"MaxSize", + "documentation":"

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

" + }, + "SortAscending":{"shape":"Boolean"} + } + }, + "DescribeBackupsResponse":{ + "type":"structure", + "members":{ + "Backups":{ + "shape":"Backups", + "documentation":"

A list of backups.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

" + } + } + }, + "DescribeClustersRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"Filters", + "documentation":"

One or more filters to limit the items returned in the response.

Use the clusterIds filter to return only the specified clusters. Specify clusters by their cluster identifier (ID).

Use the vpcIds filter to return only the clusters in the specified virtual private clouds (VPCs). Specify VPCs by their VPC identifier (ID).

Use the states filter to return only clusters that match the specified state.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The NextToken value that you received in the previous response. Use this value to get more clusters.

" + }, + "MaxResults":{ + "shape":"MaxSize", + "documentation":"

The maximum number of clusters to return in the response. When there are more clusters than the number you specify, the response contains a NextToken value.

" + } + } + }, + "DescribeClustersResponse":{ + "type":"structure", + "members":{ + "Clusters":{ + "shape":"Clusters", + "documentation":"

A list of clusters.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates that the response contains only a subset of clusters. Use this value in a subsequent DescribeClusters request to get more clusters.

" + } + } + }, + "DestinationBackup":{ + "type":"structure", + "members":{ + "CreateTimestamp":{"shape":"Timestamp"}, + "SourceRegion":{"shape":"Region"}, + "SourceBackup":{"shape":"BackupId"}, + "SourceCluster":{"shape":"ClusterId"} + } + }, + "EniId":{ + "type":"string", + "pattern":"eni-[0-9a-fA-F]{8,17}" + }, + "ExternalAz":{ + "type":"string", + "pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d[a-z]" + }, + "ExternalSubnetMapping":{ + "type":"map", + "key":{"shape":"ExternalAz"}, + "value":{"shape":"SubnetId"} + }, + "Field":{ + "type":"string", + "pattern":"[a-zA-Z0-9_-]+" + }, + "Filters":{ + "type":"map", + "key":{"shape":"Field"}, + "value":{"shape":"Strings"} + }, + "Hsm":{ + "type":"structure", + "required":["HsmId"], + "members":{ + "AvailabilityZone":{ + "shape":"ExternalAz", + "documentation":"

The Availability Zone that contains the HSM.

" + }, + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the cluster that contains the HSM.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The subnet that contains the HSM's elastic network interface (ENI).

" + }, + "EniId":{ + "shape":"EniId", + "documentation":"

The identifier (ID) of the HSM's elastic network interface (ENI).

" + }, + "EniIp":{ + "shape":"IpAddress", + "documentation":"

The IP address of the HSM's elastic network interface (ENI).

" + }, + "HsmId":{ + "shape":"HsmId", + "documentation":"

The HSM's identifier (ID).

" + }, + "State":{ + "shape":"HsmState", + "documentation":"

The HSM's state.

" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

A description of the HSM's state.

" + } + }, + "documentation":"

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

" + }, + "HsmId":{ + "type":"string", + "pattern":"hsm-[2-7a-zA-Z]{11,16}" + }, + "HsmState":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "ACTIVE", + "DEGRADED", + "DELETE_IN_PROGRESS", + "DELETED" + ] + }, + "HsmType":{ + "type":"string", + "pattern":"(hsm1\\.medium)" + }, + "Hsms":{ + "type":"list", + "member":{"shape":"Hsm"} + }, + "InitializeClusterRequest":{ + "type":"structure", + "required":[ + "ClusterId", + "SignedCert", + "TrustAnchor" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier (ID) of the cluster that you are claiming. To find the cluster ID, use DescribeClusters.

" + }, + "SignedCert":{ + "shape":"Cert", + "documentation":"

The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.

" + }, + "TrustAnchor":{ + "shape":"Cert", + "documentation":"

The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.

" + } + } + }, + "InitializeClusterResponse":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ClusterState", + "documentation":"

The cluster's state.

" + }, + "StateMessage":{ + "shape":"StateMessage", + "documentation":"

A description of the cluster's state.

" + } + } + }, + "IpAddress":{ + "type":"string", + "pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}" + }, + "ListTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"ClusterId", + "documentation":"

The cluster identifier (ID) for the cluster whose tags you are getting. To find the cluster ID, use DescribeClusters.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The NextToken value that you received in the previous response. Use this value to get more tags.

" + }, + "MaxResults":{ + "shape":"MaxSize", + "documentation":"

The maximum number of tags to return in the response. When there are more tags than the number you specify, the response contains a NextToken value.

" + } + } + }, + "ListTagsResponse":{ + "type":"structure", + "required":["TagList"], + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

A list of tags.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates that the response contains only a subset of tags. Use this value in a subsequent ListTags request to get more tags.

" + } + } + }, + "MaxSize":{ + "type":"integer", + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "PreCoPassword":{ + "type":"string", + "max":32, + "min":7 + }, + "Region":{ + "type":"string", + "pattern":"[a-z]{2}(-(gov))?-(east|west|north|south|central){1,2}-\\d" + }, + "RestoreBackupRequest":{ + "type":"structure", + "required":["BackupId"], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup to be restored. To find the ID of a backup, use the DescribeBackups operation.

" + } + } + }, + "RestoreBackupResponse":{ + "type":"structure", + "members":{ + "Backup":{ + "shape":"Backup", + "documentation":"

Information on the Backup object created.

" + } + } + }, + "SecurityGroup":{ + "type":"string", + "pattern":"sg-[0-9a-fA-F]" + }, + "StateMessage":{ + "type":"string", + "max":300, + "pattern":".*" + }, + "String":{"type":"string"}, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetId":{ + "type":"string", + "pattern":"subnet-[0-9a-fA-F]{8,17}" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":10, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Contains a tag. A tag is a key-value pair.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagList" + ], + "members":{ + "ResourceId":{ + "shape":"ClusterId", + "documentation":"

The cluster identifier (ID) for the cluster that you are tagging. To find the cluster ID, use DescribeClusters.

" + }, + "TagList":{ + "shape":"TagList", + "documentation":"

A list of one or more tags.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Timestamp":{"type":"timestamp"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeyList" + ], + "members":{ + "ResourceId":{ + "shape":"ClusterId", + "documentation":"

The cluster identifier (ID) for the cluster whose tags you are removing. To find the cluster ID, use DescribeClusters.

" + }, + "TagKeyList":{ + "shape":"TagKeyList", + "documentation":"

A list of one or more tag keys for the tags that you are removing. Specify only the tag keys, not the tag values.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "VpcId":{ + "type":"string", + "pattern":"vpc-[0-9a-fA-F]" + }, + "errorMessage":{"type":"string"} + }, + "documentation":"

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.

" +} diff --git a/aws/dist/botocore/data/cloudsearch/2011-02-01/service-2.json b/aws/dist/botocore/data/cloudsearch/2011-02-01/service-2.json new file mode 100644 index 00000000..37c87252 --- /dev/null +++ b/aws/dist/botocore/data/cloudsearch/2011-02-01/service-2.json @@ -0,0 +1,2097 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2011-02-01", + "endpointPrefix":"cloudsearch", + "serviceFullName":"Amazon CloudSearch", + "serviceId":"CloudSearch", + "signatureVersion":"v4", + "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2011-02-01/", + "protocol":"query" + }, + "documentation":"Amazon CloudSearch Configuration Service

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", + "operations":{ + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "output":{ + "shape":"CreateDomainResponse", + "documentation":"

A response message that contains the status of a newly created domain.

", + "resultWrapper":"CreateDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + } + ], + "documentation":"

Creates a new search domain.

" + }, + "DefineIndexField":{ + "name":"DefineIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DefineIndexFieldRequest"}, + "output":{ + "shape":"DefineIndexFieldResponse", + "documentation":"

A response message that contains the status of an updated index field.

", + "resultWrapper":"DefineIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

" + }, + "DefineRankExpression":{ + "name":"DefineRankExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DefineRankExpressionRequest"}, + "output":{ + "shape":"DefineRankExpressionResponse", + "documentation":"

A response message that contains the status of an updated RankExpression.

", + "resultWrapper":"DefineRankExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

" + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "output":{ + "shape":"DeleteDomainResponse", + "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", + "resultWrapper":"DeleteDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Permanently deletes a search domain and all of its data.

" + }, + "DeleteIndexField":{ + "name":"DeleteIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIndexFieldRequest"}, + "output":{ + "shape":"DeleteIndexFieldResponse", + "documentation":"

A response message that contains the status of a deleted index field.

", + "resultWrapper":"DeleteIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an IndexField from the search domain.

" + }, + "DeleteRankExpression":{ + "name":"DeleteRankExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRankExpressionRequest"}, + "output":{ + "shape":"DeleteRankExpressionResponse", + "documentation":"

A response message that contains the status of a deleted RankExpression.

", + "resultWrapper":"DeleteRankExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes a RankExpression from the search domain.

" + }, + "DescribeAvailabilityOptions":{ + "name":"DescribeAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAvailabilityOptionsResponse", + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", + "resultWrapper":"DescribeAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeDefaultSearchField":{ + "name":"DescribeDefaultSearchField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDefaultSearchFieldRequest"}, + "output":{ + "shape":"DescribeDefaultSearchFieldResponse", + "documentation":"

A response message that contains the default search field for a search domain.

", + "resultWrapper":"DescribeDefaultSearchFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the default search field configured for the search domain.

" + }, + "DescribeDomains":{ + "name":"DescribeDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainsRequest"}, + "output":{ + "shape":"DescribeDomainsResponse", + "documentation":"

A response message that contains the status of one or more domains.

", + "resultWrapper":"DescribeDomainsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

" + }, + "DescribeIndexFields":{ + "name":"DescribeIndexFields", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIndexFieldsRequest"}, + "output":{ + "shape":"DescribeIndexFieldsResponse", + "documentation":"

A response message that contains the index fields for a search domain.

", + "resultWrapper":"DescribeIndexFieldsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

" + }, + "DescribeRankExpressions":{ + "name":"DescribeRankExpressions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRankExpressionsRequest"}, + "output":{ + "shape":"DescribeRankExpressionsResponse", + "documentation":"

A response message that contains the rank expressions for a search domain.

", + "resultWrapper":"DescribeRankExpressionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

" + }, + "DescribeServiceAccessPolicies":{ + "name":"DescribeServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceAccessPoliciesRequest"}, + "output":{ + "shape":"DescribeServiceAccessPoliciesResponse", + "documentation":"

A response message that contains the access policies for a domain.

", + "resultWrapper":"DescribeServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the resource-based policies that control access to the domain's document and search services.

" + }, + "DescribeStemmingOptions":{ + "name":"DescribeStemmingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStemmingOptionsRequest"}, + "output":{ + "shape":"DescribeStemmingOptionsResponse", + "documentation":"

A response message that contains the stemming options for a search domain.

", + "resultWrapper":"DescribeStemmingOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the stemming dictionary configured for the search domain.

" + }, + "DescribeStopwordOptions":{ + "name":"DescribeStopwordOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStopwordOptionsRequest"}, + "output":{ + "shape":"DescribeStopwordOptionsResponse", + "documentation":"

A response message that contains the stopword options for a search domain.

", + "resultWrapper":"DescribeStopwordOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the stopwords configured for the search domain.

" + }, + "DescribeSynonymOptions":{ + "name":"DescribeSynonymOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSynonymOptionsRequest"}, + "output":{ + "shape":"DescribeSynonymOptionsResponse", + "documentation":"

A response message that contains the synonym options for a search domain.

", + "resultWrapper":"DescribeSynonymOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the synonym dictionary configured for the search domain.

" + }, + "IndexDocuments":{ + "name":"IndexDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IndexDocumentsRequest"}, + "output":{ + "shape":"IndexDocumentsResponse", + "documentation":"

The result of an IndexDocuments action.

", + "resultWrapper":"IndexDocumentsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

" + }, + "UpdateAvailabilityOptions":{ + "name":"UpdateAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "output":{ + "shape":"UpdateAvailabilityOptionsResponse", + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", + "resultWrapper":"UpdateAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateDefaultSearchField":{ + "name":"UpdateDefaultSearchField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDefaultSearchFieldRequest"}, + "output":{ + "shape":"UpdateDefaultSearchFieldResponse", + "documentation":"

A response message that contains the status of an updated default search field.

", + "resultWrapper":"UpdateDefaultSearchFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

" + }, + "UpdateServiceAccessPolicies":{ + "name":"UpdateServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceAccessPoliciesRequest"}, + "output":{ + "shape":"UpdateServiceAccessPoliciesResponse", + "documentation":"

A response message that contains the status of updated access policies.

", + "resultWrapper":"UpdateServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.

" + }, + "UpdateStemmingOptions":{ + "name":"UpdateStemmingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStemmingOptionsRequest"}, + "output":{ + "shape":"UpdateStemmingOptionsResponse", + "documentation":"

A response message that contains the status of updated stemming options.

", + "resultWrapper":"UpdateStemmingOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.

" + }, + "UpdateStopwordOptions":{ + "name":"UpdateStopwordOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStopwordOptionsRequest"}, + "output":{ + "shape":"UpdateStopwordOptionsResponse", + "documentation":"

A response message that contains the status of updated stopword options.

", + "resultWrapper":"UpdateStopwordOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.

" + }, + "UpdateSynonymOptions":{ + "name":"UpdateSynonymOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSynonymOptionsRequest"}, + "output":{ + "shape":"UpdateSynonymOptionsResponse", + "documentation":"

A response message that contains the status of updated synonym options.

", + "resultWrapper":"UpdateSynonymOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

" + } + }, + "shapes":{ + "AccessPoliciesStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"PolicyDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.

" + }, + "Arn":{ + "type":"string", + "documentation":"

An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "AvailabilityOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"MultiAZ", + "documentation":"

The availability options configured for the domain.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of the domain's availability options.

" + }, + "BaseException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + "Boolean":{"type":"boolean"}, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "CreateDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

A response message that contains the status of a newly created domain.

" + }, + "DefaultSearchFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"FieldName", + "documentation":"

The name of the IndexField to use as the default search field. The default is an empty string, which automatically searches all text fields.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of the DefaultSearchField configured for this search domain and its current status.

" + }, + "DefineIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexField":{"shape":"IndexField"} + } + }, + "DefineIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

A response message that contains the status of an updated index field.

" + }, + "DefineRankExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "RankExpression" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankExpression":{"shape":"NamedRankExpression"} + } + }, + "DefineRankExpressionResponse":{ + "type":"structure", + "required":["RankExpression"], + "members":{ + "RankExpression":{"shape":"RankExpressionStatus"} + }, + "documentation":"

A response message that contains the status of an updated RankExpression.

" + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DeleteDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

A response message that contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" + }, + "DeleteIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexFieldName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexFieldName":{"shape":"FieldName"} + } + }, + "DeleteIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

A response message that contains the status of a deleted index field.

" + }, + "DeleteRankExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "RankName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankName":{ + "shape":"FieldName", + "documentation":"

The name of the RankExpression to delete.

" + } + } + }, + "DeleteRankExpressionResponse":{ + "type":"structure", + "required":["RankExpression"], + "members":{ + "RankExpression":{"shape":"RankExpressionStatus"} + }, + "documentation":"

A response message that contains the status of a deleted RankExpression.

" + }, + "DescribeAvailabilityOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" + }, + "DescribeDefaultSearchFieldRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeDefaultSearchFieldResponse":{ + "type":"structure", + "required":["DefaultSearchField"], + "members":{ + "DefaultSearchField":{ + "shape":"DefaultSearchFieldStatus", + "documentation":"

The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.

" + } + }, + "documentation":"

A response message that contains the default search field for a search domain.

" + }, + "DescribeDomainsRequest":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"

Limits the DescribeDomains response to the specified search domains.

" + } + } + }, + "DescribeDomainsResponse":{ + "type":"structure", + "required":["DomainStatusList"], + "members":{ + "DomainStatusList":{"shape":"DomainStatusList"} + }, + "documentation":"

A response message that contains the status of one or more domains.

" + }, + "DescribeIndexFieldsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

Limits the DescribeIndexFields response to the specified fields.

" + } + } + }, + "DescribeIndexFieldsResponse":{ + "type":"structure", + "required":["IndexFields"], + "members":{ + "IndexFields":{ + "shape":"IndexFieldStatusList", + "documentation":"

The index fields configured for the domain.

" + } + }, + "documentation":"

A response message that contains the index fields for a search domain.

" + }, + "DescribeRankExpressionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"}, + "RankNames":{ + "shape":"FieldNameList", + "documentation":"

Limits the DescribeRankExpressions response to the specified fields.

" + } + } + }, + "DescribeRankExpressionsResponse":{ + "type":"structure", + "required":["RankExpressions"], + "members":{ + "RankExpressions":{ + "shape":"RankExpressionStatusList", + "documentation":"

The rank expressions configured for the domain.

" + } + }, + "documentation":"

A response message that contains the rank expressions for a search domain.

" + }, + "DescribeServiceAccessPoliciesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{"shape":"AccessPoliciesStatus"} + }, + "documentation":"

A response message that contains the access policies for a domain.

" + }, + "DescribeStemmingOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeStemmingOptionsResponse":{ + "type":"structure", + "required":["Stems"], + "members":{ + "Stems":{"shape":"StemmingOptionsStatus"} + }, + "documentation":"

A response message that contains the stemming options for a search domain.

" + }, + "DescribeStopwordOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeStopwordOptionsResponse":{ + "type":"structure", + "required":["Stopwords"], + "members":{ + "Stopwords":{"shape":"StopwordOptionsStatus"} + }, + "documentation":"

A response message that contains the stopword options for a search domain.

" + }, + "DescribeSynonymOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "DescribeSynonymOptionsResponse":{ + "type":"structure", + "required":["Synonyms"], + "members":{ + "Synonyms":{"shape":"SynonymOptionsStatus"} + }, + "documentation":"

A response message that contains the synonym options for a search domain.

" + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + }, + "DocumentCount":{ + "type":"long", + "min":0 + }, + "DomainId":{ + "type":"string", + "min":1, + "max":64, + "documentation":"

An internally generated unique identifier for a domain.

" + }, + "DomainName":{ + "type":"string", + "min":3, + "max":28, + "pattern":"[a-z][a-z0-9\\-]+", + "documentation":"

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

" + }, + "DomainNameList":{ + "type":"list", + "member":{"shape":"DomainName"}, + "documentation":"

A list of domain names.

" + }, + "DomainStatus":{ + "type":"structure", + "required":[ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "DomainName":{"shape":"DomainName"}, + "Created":{ + "shape":"Boolean", + "documentation":"

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" + }, + "Deleted":{ + "shape":"Boolean", + "documentation":"

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

" + }, + "NumSearchableDocs":{ + "shape":"DocumentCount", + "documentation":"

The number of documents that have been submitted to the domain and indexed.

" + }, + "DocService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for updating documents in a search domain.

" + }, + "SearchService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for requesting search results from a search domain.

" + }, + "RequiresIndexDocuments":{ + "shape":"Boolean", + "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" + }, + "Processing":{ + "shape":"Boolean", + "documentation":"

True if processing is being done to activate the current domain configuration.

" + }, + "SearchInstanceType":{ + "shape":"SearchInstanceType", + "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" + }, + "SearchPartitionCount":{ + "shape":"PartitionCount", + "documentation":"

The number of partitions across which the search index is spread.

" + }, + "SearchInstanceCount":{ + "shape":"InstanceCount", + "documentation":"

The number of search instances that are available to process search requests.

" + } + }, + "documentation":"

The current status of the search domain.

" + }, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"}, + "documentation":"

The current status of all of your search domains.

" + }, + "ErrorCode":{ + "type":"string", + "documentation":"

A machine-parsable string error or warning code.

" + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A human-readable string error or warning message.

" + }, + "FieldName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z][a-z0-9_]*", + "documentation":"

A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "FieldNameList":{ + "type":"list", + "member":{"shape":"FieldName"} + }, + "FieldValue":{ + "type":"string", + "min":0, + "max":1024, + "documentation":"

The value of a field or source document attribute.

" + }, + "IndexDocumentsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + } + }, + "IndexDocumentsResponse":{ + "type":"structure", + "members":{ + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

The names of the fields that are currently being processed due to an IndexDocuments action.

" + } + }, + "documentation":"

The result of an IndexDocuments action.

" + }, + "IndexField":{ + "type":"structure", + "required":[ + "IndexFieldName", + "IndexFieldType" + ], + "members":{ + "IndexFieldName":{ + "shape":"FieldName", + "documentation":"

The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "IndexFieldType":{ + "shape":"IndexFieldType", + "documentation":"

The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.

" + }, + "UIntOptions":{ + "shape":"UIntOptions", + "documentation":"

Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.

" + }, + "LiteralOptions":{ + "shape":"LiteralOptions", + "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal.

" + }, + "TextOptions":{ + "shape":"TextOptions", + "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text.

" + }, + "SourceAttributes":{ + "shape":"SourceAttributeList", + "documentation":"

An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this IndexField. When one or more source attributes are specified, an optional data transformation can be applied to the source data when populating the index field. You can configure a maximum of 20 sources for an IndexField.

" + } + }, + "documentation":"

Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.

" + }, + "IndexFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"IndexField"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an IndexField and its current status.

" + }, + "IndexFieldStatusList":{ + "type":"list", + "member":{"shape":"IndexFieldStatus"} + }, + "IndexFieldType":{ + "type":"string", + "enum":[ + "uint", + "literal", + "text" + ], + "documentation":"

The type of IndexField.

" + }, + "InstanceCount":{ + "type":"integer", + "min":1 + }, + "InternalException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + "Language":{ + "type":"string", + "pattern":"[a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*", + "documentation":"

An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + "LiteralOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value for a literal field. Optional.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether search is enabled for this field. Default: False.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" + }, + "ResultEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" + } + }, + "documentation":"

Options that define a literal field in the search index.

" + }, + "MultiAZ":{"type":"boolean"}, + "NamedRankExpression":{ + "type":"structure", + "required":[ + "RankName", + "RankExpression" + ], + "members":{ + "RankName":{ + "shape":"FieldName", + "documentation":"

The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names \"body\", \"docid\", and \"text_relevance\" are reserved and cannot be specified as field or rank expression names.

" + }, + "RankExpression":{ + "shape":"RankExpression", + "documentation":"

The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:

  • Integer, floating point, hex and octal literals
  • Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
  • JavaScript order of precedence for operators
  • Arithmetic operators: + - * / %
  • Boolean operators (including the ternary operator)
  • Bitwise operators
  • Comparison operators
  • Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
  • Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
  • Random generation of a number between 0 and 1: rand
  • Current time in epoch: time
  • The min max functions that operate on a variable argument list

Intermediate results are calculated as double precision floating point values. The final return value of a RankExpression is automatically converted from floating point to a 32-bit unsigned integer by rounding to the nearest integer, with a natural floor of 0 and a ceiling of max(uint32_t), 4294967295. Mathematical errors such as dividing by 0 will fail during evaluation and return a value of 0.

The source data for a RankExpression can be the name of an IndexField of type uint, another RankExpression or the reserved name text_relevance. The text_relevance source is defined to return an integer from 0 to 1000 (inclusive) to indicate how relevant a document is to the search request, taking into account repetition of search terms in the document and proximity of search terms to each other in each matching IndexField in the document.

For more information about using rank expressions to customize ranking, see the Amazon CloudSearch Developer Guide.

" + } + }, + "documentation":"

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

" + }, + "OptionState":{ + "type":"string", + "enum":[ + "RequiresIndexDocuments", + "Processing", + "Active" + ], + "documentation":"

The state of processing a change to an option.

" + }, + "OptionStatus":{ + "type":"structure", + "required":[ + "CreationDate", + "UpdateDate", + "State" + ], + "members":{ + "CreationDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was created.

" + }, + "UpdateDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was last updated.

" + }, + "UpdateVersion":{ + "shape":"UIntValue", + "documentation":"

A unique integer that indicates when this option was last updated.

" + }, + "State":{ + "shape":"OptionState", + "documentation":"

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be visible in searches until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is not yet visible in all searches but is in the process of being activated.
  • Active: the option's latest value is completely visible. Any warnings or messages generated during processing are provided in Diagnostics.
" + }, + "PendingDeletion":{ + "shape":"Boolean", + "documentation":"

Indicates that the option will be deleted once processing is complete.

" + } + }, + "documentation":"

The status of an option, including when it was last updated and whether it is actively in use for searches.

" + }, + "PartitionCount":{ + "type":"integer", + "min":1 + }, + "PolicyDocument":{ + "type":"string", + "documentation":"

An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.

Example: {\"Statement\": [{\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:search/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }}, {\"Effect\":\"Allow\", \"Action\": \"*\", \"Resource\": \"arn:aws:cs:us-east-1:1234567890:documents/movies\", \"Condition\": { \"IpAddress\": { \"aws:SourceIp\": [\"203.0.113.1/32\"] } }} ] }

" + }, + "RankExpression":{ + "type":"string", + "min":1, + "max":10240, + "documentation":"

The current status of the rank expression.

" + }, + "RankExpressionStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"NamedRankExpression", + "documentation":"

The expression that is evaluated for ranking or thresholding while processing a search request.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of a RankExpression and its current status.

" + }, + "RankExpressionStatusList":{ + "type":"list", + "member":{"shape":"RankExpressionStatus"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + "SearchInstanceType":{"type":"string"}, + "ServiceEndpoint":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "Endpoint":{"shape":"ServiceUrl"} + }, + "documentation":"

The endpoint to which service requests can be submitted, including the actual URL prefix for sending requests and the Amazon Resource Name (ARN) so the endpoint can be referenced in other API calls such as UpdateServiceAccessPolicies.

" + }, + "ServiceUrl":{ + "type":"string", + "documentation":"

The URL (including /version/pathPrefix) to which service requests can be submitted.

" + }, + "SourceAttribute":{ + "type":"structure", + "required":["SourceDataFunction"], + "members":{ + "SourceDataFunction":{ + "shape":"SourceDataFunction", + "documentation":"

Identifies the transformation to apply when copying data from a source attribute.

" + }, + "SourceDataCopy":{ + "shape":"SourceData", + "documentation":"

Copies data from a source document attribute to an IndexField.

" + }, + "SourceDataTrimTitle":{ + "shape":"SourceDataTrimTitle", + "documentation":"

Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.

" + }, + "SourceDataMap":{ + "shape":"SourceDataMap", + "documentation":"

Maps source document attribute values to new values when populating the IndexField.

" + } + }, + "documentation":"

Identifies the source data for an index field. An optional data transformation can be applied to the source data when populating the index field. By default, the value of the source attribute is copied to the index field.

" + }, + "SourceAttributeList":{ + "type":"list", + "member":{"shape":"SourceAttribute"} + }, + "SourceData":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + } + }, + "documentation":"

The source attribute name and an optional default value to use if a document doesn't have an attribute of that name.

" + }, + "SourceDataFunction":{ + "type":"string", + "enum":[ + "Copy", + "TrimTitle", + "Map" + ] + }, + "SourceDataMap":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + }, + "Cases":{ + "shape":"StringCaseMap", + "documentation":"

A map that translates source field values to custom values.

" + } + }, + "documentation":"

Specifies how to map source attribute values to custom values when populating an IndexField.

" + }, + "SourceDataTrimTitle":{ + "type":"structure", + "required":["SourceName"], + "members":{ + "SourceName":{ + "shape":"FieldName", + "documentation":"

The name of the document source field to add to this IndexField.

" + }, + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value to use if the source attribute is not specified in a document. Optional.

" + }, + "Separator":{ + "shape":"String", + "documentation":"

The separator that follows the text to trim.

" + }, + "Language":{"shape":"Language"} + }, + "documentation":"

Specifies how to trim common words from the beginning of a field to enable title sorting by that field.

" + }, + "StemmingOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"StemsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The stemming options configured for this search domain and the current status of those options.

" + }, + "StemsDocument":{ + "type":"string", + "documentation":"

Maps terms to their stems, serialized as a JSON document. The document has a single object with one property \"stems\" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { \"stems\": {\"people\": \"person\", \"walking\": \"walk\"} }

" + }, + "StopwordOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"StopwordsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The stopword options configured for this search domain and the current status of those options.

" + }, + "StopwordsDocument":{ + "type":"string", + "documentation":"

Lists stopwords serialized as a JSON document. The document has a single object with one property \"stopwords\" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { \"stopwords\": [\"a\", \"an\", \"the\", \"of\"] }

" + }, + "String":{"type":"string"}, + "StringCaseMap":{ + "type":"map", + "key":{"shape":"FieldValue"}, + "value":{"shape":"FieldValue"} + }, + "SynonymOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"SynonymsDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The synonym options configured for this search domain and the current status of those options.

" + }, + "SynonymsDocument":{ + "type":"string", + "documentation":"

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property \"synonyms\" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { \"synonyms\": {\"cat\": [\"feline\", \"kitten\"], \"puppy\": \"dog\"} }

" + }, + "TextOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"

The default value for a text field. Optional.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether facets are enabled for this field. Default: False.

" + }, + "ResultEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

" + }, + "TextProcessor":{ + "shape":"FieldName", + "documentation":"

The text processor to apply to this field. Optional. Possible values:

  • cs_text_no_stemming: turns off stemming for the field.

Default: none

" + } + }, + "documentation":"

Options that define a text field in the search index.

" + }, + "UIntOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"UIntValue", + "documentation":"

The default value for an unsigned integer field. Optional.

" + } + }, + "documentation":"

Options that define a uint field in the search index.

" + }, + "UIntValue":{ + "type":"integer", + "min":0 + }, + "UpdateAvailabilityOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "MultiAZ" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" + } + }, + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "UpdateAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" + }, + "UpdateDefaultSearchFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DefaultSearchField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "DefaultSearchField":{ + "shape":"String", + "documentation":"

The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the q parameter, or if a match expression specified with the bq parameter does not constrain the search to a particular field. The default is an empty string, which automatically searches all text fields.

" + } + } + }, + "UpdateDefaultSearchFieldResponse":{ + "type":"structure", + "required":["DefaultSearchField"], + "members":{ + "DefaultSearchField":{"shape":"DefaultSearchFieldStatus"} + }, + "documentation":"

A response message that contains the status of an updated default search field.

" + }, + "UpdateServiceAccessPoliciesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AccessPolicies" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AccessPolicies":{"shape":"PolicyDocument"} + } + }, + "UpdateServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{"shape":"AccessPoliciesStatus"} + }, + "documentation":"

A response message that contains the status of updated access policies.

" + }, + "UpdateStemmingOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Stems" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Stems":{"shape":"StemsDocument"} + } + }, + "UpdateStemmingOptionsResponse":{ + "type":"structure", + "required":["Stems"], + "members":{ + "Stems":{"shape":"StemmingOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated stemming options.

" + }, + "UpdateStopwordOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Stopwords" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Stopwords":{"shape":"StopwordsDocument"} + } + }, + "UpdateStopwordOptionsResponse":{ + "type":"structure", + "required":["Stopwords"], + "members":{ + "Stopwords":{"shape":"StopwordOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated stopword options.

" + }, + "UpdateSynonymOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Synonyms" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Synonyms":{"shape":"SynonymsDocument"} + } + }, + "UpdateSynonymOptionsResponse":{ + "type":"structure", + "required":["Synonyms"], + "members":{ + "Synonyms":{"shape":"SynonymOptionsStatus"} + }, + "documentation":"

A response message that contains the status of updated synonym options.

" + }, + "UpdateTimestamp":{"type":"timestamp"} + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/cloudsearch/2013-01-01/paginators-1.json b/aws/dist/botocore/data/cloudsearch/2013-01-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/cloudsearch/2013-01-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/cloudsearch/2013-01-01/service-2.json b/aws/dist/botocore/data/cloudsearch/2013-01-01/service-2.json new file mode 100644 index 00000000..6c232754 --- /dev/null +++ b/aws/dist/botocore/data/cloudsearch/2013-01-01/service-2.json @@ -0,0 +1,2707 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-01-01", + "endpointPrefix":"cloudsearch", + "serviceFullName":"Amazon CloudSearch", + "serviceId":"CloudSearch", + "signatureVersion":"v4", + "xmlNamespace":"http://cloudsearch.amazonaws.com/doc/2013-01-01/", + "protocol":"query", + "uid":"cloudsearch-2013-01-01" + }, + "documentation":"Amazon CloudSearch Configuration Service

You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

", + "operations":{ + "BuildSuggesters":{ + "name":"BuildSuggesters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"BuildSuggestersRequest", + "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" + }, + "output":{ + "shape":"BuildSuggestersResponse", + "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

", + "resultWrapper":"BuildSuggestersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

" + }, + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDomainRequest", + "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" + }, + "output":{ + "shape":"CreateDomainResponse", + "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

", + "resultWrapper":"CreateDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + } + ], + "documentation":"

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DefineAnalysisScheme":{ + "name":"DefineAnalysisScheme", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineAnalysisSchemeRequest", + "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" + }, + "output":{ + "shape":"DefineAnalysisSchemeResponse", + "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

", + "resultWrapper":"DefineAnalysisSchemeResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DefineExpression":{ + "name":"DefineExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineExpressionRequest", + "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" + }, + "output":{ + "shape":"DefineExpressionResponse", + "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

", + "resultWrapper":"DefineExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DefineIndexField":{ + "name":"DefineIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineIndexFieldRequest", + "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" + }, + "output":{ + "shape":"DefineIndexFieldResponse", + "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

", + "resultWrapper":"DefineIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "DefineSuggester":{ + "name":"DefineSuggester", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DefineSuggesterRequest", + "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" + }, + "output":{ + "shape":"DefineSuggesterResponse", + "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

", + "resultWrapper":"DefineSuggesterResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteAnalysisScheme":{ + "name":"DeleteAnalysisScheme", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteAnalysisSchemeRequest", + "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" + }, + "output":{ + "shape":"DeleteAnalysisSchemeResponse", + "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

", + "resultWrapper":"DeleteAnalysisSchemeResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDomainRequest", + "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" + }, + "output":{ + "shape":"DeleteDomainResponse", + "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

", + "resultWrapper":"DeleteDomainResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteExpression":{ + "name":"DeleteExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteExpressionRequest", + "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" + }, + "output":{ + "shape":"DeleteExpressionResponse", + "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

", + "resultWrapper":"DeleteExpressionResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteIndexField":{ + "name":"DeleteIndexField", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteIndexFieldRequest", + "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" + }, + "output":{ + "shape":"DeleteIndexFieldResponse", + "documentation":"

The result of a DeleteIndexField request.

", + "resultWrapper":"DeleteIndexFieldResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "DeleteSuggester":{ + "name":"DeleteSuggester", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteSuggesterRequest", + "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" + }, + "output":{ + "shape":"DeleteSuggesterResponse", + "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

", + "resultWrapper":"DeleteSuggesterResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeAnalysisSchemes":{ + "name":"DescribeAnalysisSchemes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAnalysisSchemesRequest", + "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAnalysisSchemesResponse", + "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

", + "resultWrapper":"DescribeAnalysisSchemesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeAvailabilityOptions":{ + "name":"DescribeAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeAvailabilityOptionsResponse", + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

", + "resultWrapper":"DescribeAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeDomains":{ + "name":"DescribeDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDomainsRequest", + "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" + }, + "output":{ + "shape":"DescribeDomainsResponse", + "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

", + "resultWrapper":"DescribeDomainsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + } + ], + "documentation":"

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&amp;q.parser=structured&amp;size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeExpressions":{ + "name":"DescribeExpressions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeExpressionsRequest", + "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeExpressionsResponse", + "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

", + "resultWrapper":"DescribeExpressionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeIndexFields":{ + "name":"DescribeIndexFields", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeIndexFieldsRequest", + "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeIndexFieldsResponse", + "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

", + "resultWrapper":"DescribeIndexFieldsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeScalingParameters":{ + "name":"DescribeScalingParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeScalingParametersRequest", + "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" + }, + "output":{ + "shape":"DescribeScalingParametersResponse", + "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

", + "resultWrapper":"DescribeScalingParametersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeServiceAccessPolicies":{ + "name":"DescribeServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeServiceAccessPoliciesRequest", + "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeServiceAccessPoliciesResponse", + "documentation":"

The result of a DescribeServiceAccessPolicies request.

", + "resultWrapper":"DescribeServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide.

" + }, + "DescribeSuggesters":{ + "name":"DescribeSuggesters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSuggestersRequest", + "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "output":{ + "shape":"DescribeSuggestersResponse", + "documentation":"

The result of a DescribeSuggesters request.

", + "resultWrapper":"DescribeSuggestersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

" + }, + "IndexDocuments":{ + "name":"IndexDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"IndexDocumentsRequest", + "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" + }, + "output":{ + "shape":"IndexDocumentsResponse", + "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

", + "resultWrapper":"IndexDocumentsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + } + ], + "documentation":"

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

" + }, + "ListDomainNames":{ + "name":"ListDomainNames", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListDomainNamesResponse", + "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

", + "resultWrapper":"ListDomainNamesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + } + ], + "documentation":"

Lists all search domains owned by an account.

" + }, + "UpdateAvailabilityOptions":{ + "name":"UpdateAvailabilityOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateAvailabilityOptionsRequest", + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "output":{ + "shape":"UpdateAvailabilityOptionsResponse", + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

", + "resultWrapper":"UpdateAvailabilityOptionsResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"DisabledOperationException", + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + } + ], + "documentation":"

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateScalingParameters":{ + "name":"UpdateScalingParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateScalingParametersRequest", + "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" + }, + "output":{ + "shape":"UpdateScalingParametersResponse", + "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

", + "resultWrapper":"UpdateScalingParametersResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

" + }, + "UpdateServiceAccessPolicies":{ + "name":"UpdateServiceAccessPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"UpdateServiceAccessPoliciesRequest", + "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" + }, + "output":{ + "shape":"UpdateServiceAccessPoliciesResponse", + "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

", + "resultWrapper":"UpdateServiceAccessPoliciesResult" + }, + "errors":[ + { + "shape":"BaseException", + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + { + "shape":"InternalException", + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + { + "shape":"InvalidTypeException", + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + } + ], + "documentation":"

Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain.

" + } + }, + "shapes":{ + "APIVersion":{ + "type":"string", + "documentation":"

The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.

" + }, + "ARN":{ + "type":"string", + "documentation":"

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "AccessPoliciesStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"PolicyDocument"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

" + }, + "AlgorithmicStemming":{ + "type":"string", + "enum":[ + "none", + "minimal", + "light", + "full" + ] + }, + "AnalysisOptions":{ + "type":"structure", + "members":{ + "Synonyms":{ + "shape":"String", + "documentation":"

A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.

" + }, + "Stopwords":{ + "shape":"String", + "documentation":"

A JSON array of terms to ignore during indexing and searching. For example, [\"a\", \"an\", \"the\", \"of\"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.

" + }, + "StemmingDictionary":{ + "shape":"String", + "documentation":"

A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.

" + }, + "JapaneseTokenizationDictionary":{ + "shape":"String", + "documentation":"

A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.

" + }, + "AlgorithmicStemming":{ + "shape":"AlgorithmicStemming", + "documentation":"

The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide

" + } + }, + "documentation":"

Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

" + }, + "AnalysisScheme":{ + "type":"structure", + "required":[ + "AnalysisSchemeName", + "AnalysisSchemeLanguage" + ], + "members":{ + "AnalysisSchemeName":{"shape":"StandardName"}, + "AnalysisSchemeLanguage":{"shape":"AnalysisSchemeLanguage"}, + "AnalysisOptions":{"shape":"AnalysisOptions"} + }, + "documentation":"

Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.

" + }, + "AnalysisSchemeLanguage":{ + "type":"string", + "enum":[ + "ar", + "bg", + "ca", + "cs", + "da", + "de", + "el", + "en", + "es", + "eu", + "fa", + "fi", + "fr", + "ga", + "gl", + "he", + "hi", + "hu", + "hy", + "id", + "it", + "ja", + "ko", + "lv", + "mul", + "nl", + "no", + "pt", + "ro", + "ru", + "sv", + "th", + "tr", + "zh-Hans", + "zh-Hant" + ], + "documentation":"

An IETF RFC 4646 language code or mul for multiple languages.

" + }, + "AnalysisSchemeStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"AnalysisScheme"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of an AnalysisScheme.

" + }, + "AnalysisSchemeStatusList":{ + "type":"list", + "member":{"shape":"AnalysisSchemeStatus"}, + "documentation":"

A list of the analysis schemes configured for a domain.

" + }, + "AvailabilityOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"MultiAZ", + "documentation":"

The availability options configured for the domain.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of the domain's availability options.

" + }, + "BaseException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"

An error occurred while processing the request.

" + }, + "Boolean":{"type":"boolean"}, + "BuildSuggestersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

" + }, + "BuildSuggestersResponse":{ + "type":"structure", + "members":{ + "FieldNames":{"shape":"FieldNameList"} + }, + "documentation":"

The result of a BuildSuggester request. Contains a list of the fields used for suggestions.

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

A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.

" + } + }, + "documentation":"

Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

" + }, + "CreateDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

The result of a CreateDomainRequest. Contains the status of a newly created domain.

" + }, + "DateArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

" + }, + "DateOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

" + }, + "DefineAnalysisSchemeRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AnalysisScheme" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AnalysisScheme":{"shape":"AnalysisScheme"} + }, + "documentation":"

Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

" + }, + "DefineAnalysisSchemeResponse":{ + "type":"structure", + "required":["AnalysisScheme"], + "members":{ + "AnalysisScheme":{"shape":"AnalysisSchemeStatus"} + }, + "documentation":"

The result of a DefineAnalysisScheme request. Contains the status of the newly-configured analysis scheme.

" + }, + "DefineExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Expression" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Expression":{"shape":"Expression"} + }, + "documentation":"

Container for the parameters to the DefineExpression operation. Specifies the name of the domain you want to update and the expression you want to configure.

" + }, + "DefineExpressionResponse":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{"shape":"ExpressionStatus"} + }, + "documentation":"

The result of a DefineExpression request. Contains the status of the newly-configured expression.

" + }, + "DefineIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexField" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexField":{ + "shape":"IndexField", + "documentation":"

The index field and field options you want to configure.

" + } + }, + "documentation":"

Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

" + }, + "DefineIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{"shape":"IndexFieldStatus"} + }, + "documentation":"

The result of a DefineIndexField request. Contains the status of the newly-configured index field.

" + }, + "DefineSuggesterRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Suggester" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "Suggester":{"shape":"Suggester"} + }, + "documentation":"

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

" + }, + "DefineSuggesterResponse":{ + "type":"structure", + "required":["Suggester"], + "members":{ + "Suggester":{"shape":"SuggesterStatus"} + }, + "documentation":"

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

" + }, + "DeleteAnalysisSchemeRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AnalysisSchemeName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AnalysisSchemeName":{ + "shape":"StandardName", + "documentation":"

The name of the analysis scheme you want to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete.

" + }, + "DeleteAnalysisSchemeResponse":{ + "type":"structure", + "required":["AnalysisScheme"], + "members":{ + "AnalysisScheme":{ + "shape":"AnalysisSchemeStatus", + "documentation":"

The status of the analysis scheme being deleted.

" + } + }, + "documentation":"

The result of a DeleteAnalysisScheme request. Contains the status of the deleted analysis scheme.

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

The name of the domain you want to permanently delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

" + }, + "DeleteDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{"shape":"DomainStatus"} + }, + "documentation":"

The result of a DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

" + }, + "DeleteExpressionRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ExpressionName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "ExpressionName":{ + "shape":"StandardName", + "documentation":"

The name of the Expression to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteExpression operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.

" + }, + "DeleteExpressionResponse":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{ + "shape":"ExpressionStatus", + "documentation":"

The status of the expression being deleted.

" + } + }, + "documentation":"

The result of a DeleteExpression request. Specifies the expression being deleted.

" + }, + "DeleteIndexFieldRequest":{ + "type":"structure", + "required":[ + "DomainName", + "IndexFieldName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "IndexFieldName":{ + "shape":"DynamicFieldName", + "documentation":"

The name of the index field your want to remove from the domain's indexing options.

" + } + }, + "documentation":"

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

" + }, + "DeleteIndexFieldResponse":{ + "type":"structure", + "required":["IndexField"], + "members":{ + "IndexField":{ + "shape":"IndexFieldStatus", + "documentation":"

The status of the index field being deleted.

" + } + }, + "documentation":"

The result of a DeleteIndexField request.

" + }, + "DeleteSuggesterRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SuggesterName" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "SuggesterName":{ + "shape":"StandardName", + "documentation":"

Specifies the name of the suggester you want to delete.

" + } + }, + "documentation":"

Container for the parameters to the DeleteSuggester operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.

" + }, + "DeleteSuggesterResponse":{ + "type":"structure", + "required":["Suggester"], + "members":{ + "Suggester":{ + "shape":"SuggesterStatus", + "documentation":"

The status of the suggester being deleted.

" + } + }, + "documentation":"

The result of a DeleteSuggester request. Contains the status of the deleted suggester.

" + }, + "DescribeAnalysisSchemesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "AnalysisSchemeNames":{ + "shape":"StandardNameList", + "documentation":"

The analysis schemes you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAnalysisSchemes operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAnalysisSchemesResponse":{ + "type":"structure", + "required":["AnalysisSchemes"], + "members":{ + "AnalysisSchemes":{ + "shape":"AnalysisSchemeStatusList", + "documentation":"

The analysis scheme descriptions.

" + } + }, + "documentation":"

The result of a DescribeAnalysisSchemes request. Contains the analysis schemes configured for the domain specified in the request.

" + }, + "DescribeAvailabilityOptionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeAvailabilityOptions operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

" + }, + "DescribeDomainsRequest":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"

The names of the domains you want to include in the response.

" + } + }, + "documentation":"

Container for the parameters to the DescribeDomains operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.

" + }, + "DescribeDomainsResponse":{ + "type":"structure", + "required":["DomainStatusList"], + "members":{ + "DomainStatusList":{"shape":"DomainStatusList"} + }, + "documentation":"

The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

" + }, + "DescribeExpressionsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "ExpressionNames":{ + "shape":"StandardNameList", + "documentation":"

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeDomains operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeExpressionsResponse":{ + "type":"structure", + "required":["Expressions"], + "members":{ + "Expressions":{ + "shape":"ExpressionStatusList", + "documentation":"

The expressions configured for the domain.

" + } + }, + "documentation":"

The result of a DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

" + }, + "DescribeIndexFieldsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "FieldNames":{ + "shape":"DynamicFieldNameList", + "documentation":"

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeIndexFieldsResponse":{ + "type":"structure", + "required":["IndexFields"], + "members":{ + "IndexFields":{ + "shape":"IndexFieldStatusList", + "documentation":"

The index fields configured for the domain.

" + } + }, + "documentation":"

The result of a DescribeIndexFields request. Contains the index fields configured for the domain specified in the request.

" + }, + "DescribeScalingParametersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

" + }, + "DescribeScalingParametersResponse":{ + "type":"structure", + "required":["ScalingParameters"], + "members":{ + "ScalingParameters":{"shape":"ScalingParametersStatus"} + }, + "documentation":"

The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

" + }, + "DescribeServiceAccessPoliciesRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeServiceAccessPolicies operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{ + "shape":"AccessPoliciesStatus", + "documentation":"

The access rules configured for the domain specified in the request.

" + } + }, + "documentation":"

The result of a DescribeServiceAccessPolicies request.

" + }, + "DescribeSuggestersRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain you want to describe.

" + }, + "SuggesterNames":{ + "shape":"StandardNameList", + "documentation":"

The suggesters you want to describe.

" + }, + "Deployed":{ + "shape":"Boolean", + "documentation":"

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

" + } + }, + "documentation":"

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

" + }, + "DescribeSuggestersResponse":{ + "type":"structure", + "required":["Suggesters"], + "members":{ + "Suggesters":{ + "shape":"SuggesterStatusList", + "documentation":"

The suggesters configured for the domain specified in the request.

" + } + }, + "documentation":"

The result of a DescribeSuggesters request.

" + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DisabledAction", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted an operation which is not enabled.

" + }, + "DocumentSuggesterOptions":{ + "type":"structure", + "required":["SourceField"], + "members":{ + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the index field you want to use for suggestions.

" + }, + "FuzzyMatching":{ + "shape":"SuggesterFuzzyMatching", + "documentation":"

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

" + }, + "SortExpression":{ + "shape":"String", + "documentation":"

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

" + } + }, + "documentation":"

Options for a search suggester.

" + }, + "DomainId":{ + "type":"string", + "min":1, + "max":64, + "documentation":"

An internally generated unique identifier for a domain.

" + }, + "DomainName":{ + "type":"string", + "min":3, + "max":28, + "pattern":"[a-z][a-z0-9\\-]+", + "documentation":"

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" + }, + "DomainNameList":{ + "type":"list", + "member":{"shape":"DomainName"}, + "documentation":"

A list of domain names.

" + }, + "DomainNameMap":{ + "type":"map", + "key":{"shape":"DomainName"}, + "value":{"shape":"APIVersion"}, + "documentation":"

A collection of domain names.

" + }, + "DomainStatus":{ + "type":"structure", + "required":[ + "DomainId", + "DomainName", + "RequiresIndexDocuments" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "DomainName":{"shape":"DomainName"}, + "ARN":{"shape":"ARN"}, + "Created":{ + "shape":"Boolean", + "documentation":"

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

" + }, + "Deleted":{ + "shape":"Boolean", + "documentation":"

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

" + }, + "DocService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for updating documents in a search domain.

" + }, + "SearchService":{ + "shape":"ServiceEndpoint", + "documentation":"

The service endpoint for requesting search results from a search domain.

" + }, + "RequiresIndexDocuments":{ + "shape":"Boolean", + "documentation":"

True if IndexDocuments needs to be called to activate the current domain configuration.

" + }, + "Processing":{ + "shape":"Boolean", + "documentation":"

True if processing is being done to activate the current domain configuration.

" + }, + "SearchInstanceType":{ + "shape":"SearchInstanceType", + "documentation":"

The instance type that is being used to process search requests.

" + }, + "SearchPartitionCount":{ + "shape":"PartitionCount", + "documentation":"

The number of partitions across which the search index is spread.

" + }, + "SearchInstanceCount":{ + "shape":"InstanceCount", + "documentation":"

The number of search instances that are available to process search requests.

" + }, + "Limits":{"shape":"Limits"} + }, + "documentation":"

The current status of the search domain.

" + }, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"}, + "documentation":"

A list that contains the status of each requested domain.

" + }, + "Double":{"type":"double"}, + "DoubleArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Double", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

" + }, + "DoubleOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Double", + "documentation":"

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

" + }, + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the source field to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

" + }, + "DynamicFieldName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"([a-z][a-z0-9_]*\\*?|\\*[a-z0-9_]*)" + }, + "DynamicFieldNameList":{ + "type":"list", + "member":{"shape":"DynamicFieldName"} + }, + "ErrorCode":{ + "type":"string", + "documentation":"

A machine-parsable string error or warning code.

" + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A human-readable string error or warning message.

" + }, + "Expression":{ + "type":"structure", + "required":[ + "ExpressionName", + "ExpressionValue" + ], + "members":{ + "ExpressionName":{"shape":"StandardName"}, + "ExpressionValue":{"shape":"ExpressionValue"} + }, + "documentation":"

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

" + }, + "ExpressionStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"Expression", + "documentation":"

The expression that is evaluated for sorting while processing a search request.

" + }, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an Expression and its current status.

" + }, + "ExpressionStatusList":{ + "type":"list", + "member":{"shape":"ExpressionStatus"}, + "documentation":"

Contains the status of multiple expressions.

" + }, + "ExpressionValue":{ + "type":"string", + "min":1, + "max":10240, + "documentation":"

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

" + }, + "FieldName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z][a-z0-9_]*", + "documentation":"

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

" + }, + "FieldNameCommaList":{ + "type":"string", + "pattern":"\\s*[a-z*][a-z0-9_]*\\*?\\s*(,\\s*[a-z*][a-z0-9_]*\\*?\\s*)*" + }, + "FieldNameList":{ + "type":"list", + "member":{"shape":"FieldName"}, + "documentation":"

A list of field names.

" + }, + "FieldValue":{ + "type":"string", + "min":0, + "max":1024, + "documentation":"

The value of a field attribute.

" + }, + "IndexDocumentsRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{"shape":"DomainName"} + }, + "documentation":"

Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

" + }, + "IndexDocumentsResponse":{ + "type":"structure", + "members":{ + "FieldNames":{ + "shape":"FieldNameList", + "documentation":"

The names of the fields that are currently being indexed.

" + } + }, + "documentation":"

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

" + }, + "IndexField":{ + "type":"structure", + "required":[ + "IndexFieldName", + "IndexFieldType" + ], + "members":{ + "IndexFieldName":{ + "shape":"DynamicFieldName", + "documentation":"

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

" + }, + "IndexFieldType":{"shape":"IndexFieldType"}, + "IntOptions":{"shape":"IntOptions"}, + "DoubleOptions":{"shape":"DoubleOptions"}, + "LiteralOptions":{"shape":"LiteralOptions"}, + "TextOptions":{"shape":"TextOptions"}, + "DateOptions":{"shape":"DateOptions"}, + "LatLonOptions":{"shape":"LatLonOptions"}, + "IntArrayOptions":{"shape":"IntArrayOptions"}, + "DoubleArrayOptions":{"shape":"DoubleArrayOptions"}, + "LiteralArrayOptions":{"shape":"LiteralArrayOptions"}, + "TextArrayOptions":{"shape":"TextArrayOptions"}, + "DateArrayOptions":{"shape":"DateArrayOptions"} + }, + "documentation":"

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

" + }, + "IndexFieldStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"IndexField"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of an IndexField and its current status.

" + }, + "IndexFieldStatusList":{ + "type":"list", + "member":{"shape":"IndexFieldStatus"}, + "documentation":"

Contains the status of multiple index fields.

" + }, + "IndexFieldType":{ + "type":"string", + "enum":[ + "int", + "double", + "literal", + "text", + "date", + "latlon", + "int-array", + "double-array", + "literal-array", + "text-array", + "date-array" + ], + "documentation":"

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

" + }, + "InstanceCount":{ + "type":"integer", + "min":1 + }, + "IntArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Long", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

" + }, + "IntOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"Long", + "documentation":"A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document." + }, + "SourceField":{ + "shape":"FieldName", + "documentation":"

The name of the source field to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

" + }, + "InternalException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InternalException", + "httpStatusCode":500 + }, + "exception":true, + "documentation":"

An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

" + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidType", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it specified an invalid type definition.

" + }, + "LatLonOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because a resource limit has already been met.

" + }, + "Limits":{ + "type":"structure", + "required":[ + "MaximumReplicationCount", + "MaximumPartitionCount" + ], + "members":{ + "MaximumReplicationCount":{"shape":"MaximumReplicationCount"}, + "MaximumPartitionCount":{"shape":"MaximumPartitionCount"} + } + }, + "ListDomainNamesResponse":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameMap", + "documentation":"

The names of the search domains owned by an account.

" + } + }, + "documentation":"

The result of a ListDomainNames request. Contains a list of the domains owned by an account.

" + }, + "LiteralArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + } + }, + "documentation":"

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

" + }, + "LiteralOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "FacetEnabled":{ + "shape":"Boolean", + "documentation":"

Whether facet information can be returned for the field.

" + }, + "SearchEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field are searchable.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + } + }, + "documentation":"

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

" + }, + "Long":{"type":"long"}, + "MaximumPartitionCount":{ + "type":"integer", + "min":1 + }, + "MaximumReplicationCount":{ + "type":"integer", + "min":1 + }, + "MultiAZ":{"type":"boolean"}, + "OptionState":{ + "type":"string", + "enum":[ + "RequiresIndexDocuments", + "Processing", + "Active", + "FailedToValidate" + ], + "documentation":"

The state of processing a change to an option. One of:

  • RequiresIndexDocuments: The option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: The option's latest value is in the process of being activated.
  • Active: The option's latest value is fully deployed.
  • FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
" + }, + "OptionStatus":{ + "type":"structure", + "required":[ + "CreationDate", + "UpdateDate", + "State" + ], + "members":{ + "CreationDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was created.

" + }, + "UpdateDate":{ + "shape":"UpdateTimestamp", + "documentation":"

A timestamp for when this option was last updated.

" + }, + "UpdateVersion":{ + "shape":"UIntValue", + "documentation":"

A unique integer that indicates when this option was last updated.

" + }, + "State":{ + "shape":"OptionState", + "documentation":"

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
" + }, + "PendingDeletion":{ + "shape":"Boolean", + "documentation":"

Indicates that the option will be deleted once processing is complete.

" + } + }, + "documentation":"

The status of domain configuration option.

" + }, + "PartitionCount":{ + "type":"integer", + "min":1, + "documentation":"

The number of partitions used to hold the domain's index.

" + }, + "PartitionInstanceType":{ + "type":"string", + "enum":[ + "search.m1.small", + "search.m1.large", + "search.m2.xlarge", + "search.m2.2xlarge", + "search.m3.medium", + "search.m3.large", + "search.m3.xlarge", + "search.m3.2xlarge" + ], + "documentation":"

The instance type (such as search.m1.small) on which an index partition is hosted.

" + }, + "PolicyDocument":{ + "type":"string", + "documentation":"

Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

The request was rejected because it attempted to reference a resource that does not exist.

" + }, + "ScalingParameters":{ + "type":"structure", + "members":{ + "DesiredInstanceType":{ + "shape":"PartitionInstanceType", + "documentation":"

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

" + }, + "DesiredReplicationCount":{ + "shape":"UIntValue", + "documentation":"

The number of replicas you want to preconfigure for each index partition.

" + }, + "DesiredPartitionCount":{ + "shape":"UIntValue", + "documentation":"

The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

" + } + }, + "documentation":"

The desired instance type and desired number of replicas of each index partition.

" + }, + "ScalingParametersStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"ScalingParameters"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The status and configuration of a search domain's scaling parameters.

" + }, + "SearchInstanceType":{ + "type":"string", + "documentation":"

The instance type (such as search.m1.small) that is being used to process search requests.

" + }, + "ServiceEndpoint":{ + "type":"structure", + "members":{ + "Endpoint":{"shape":"ServiceUrl"} + }, + "documentation":"

The endpoint to which service requests can be submitted.

" + }, + "ServiceUrl":{ + "type":"string", + "documentation":"

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

" + }, + "StandardName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z][a-z0-9_]*", + "documentation":"

Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

" + }, + "StandardNameList":{ + "type":"list", + "member":{"shape":"StandardName"} + }, + "String":{"type":"string"}, + "Suggester":{ + "type":"structure", + "required":[ + "SuggesterName", + "DocumentSuggesterOptions" + ], + "members":{ + "SuggesterName":{"shape":"StandardName"}, + "DocumentSuggesterOptions":{"shape":"DocumentSuggesterOptions"} + }, + "documentation":"

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

" + }, + "SuggesterFuzzyMatching":{ + "type":"string", + "enum":[ + "none", + "low", + "high" + ] + }, + "SuggesterStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{"shape":"Suggester"}, + "Status":{"shape":"OptionStatus"} + }, + "documentation":"

The value of a Suggester and its current status.

" + }, + "SuggesterStatusList":{ + "type":"list", + "member":{"shape":"SuggesterStatus"}, + "documentation":"

Contains the status of multiple suggesters.

" + }, + "TextArrayOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceFields":{ + "shape":"FieldNameCommaList", + "documentation":"

A list of source fields to map to the field.

" + }, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "HighlightEnabled":{ + "shape":"Boolean", + "documentation":"

Whether highlights can be returned for the field.

" + }, + "AnalysisScheme":{ + "shape":"Word", + "documentation":"

The name of an analysis scheme for a text-array field.

" + } + }, + "documentation":"

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

" + }, + "TextOptions":{ + "type":"structure", + "members":{ + "DefaultValue":{ + "shape":"FieldValue", + "documentation":"A value to use for the field if the field isn't specified for a document." + }, + "SourceField":{"shape":"FieldName"}, + "ReturnEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the contents of the field can be returned in the search results.

" + }, + "SortEnabled":{ + "shape":"Boolean", + "documentation":"

Whether the field can be used to sort the search results.

" + }, + "HighlightEnabled":{ + "shape":"Boolean", + "documentation":"

Whether highlights can be returned for the field.

" + }, + "AnalysisScheme":{ + "shape":"Word", + "documentation":"

The name of an analysis scheme for a text field.

" + } + }, + "documentation":"

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

" + }, + "UIntValue":{ + "type":"integer", + "min":0 + }, + "UpdateAvailabilityOptionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "MultiAZ" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

" + } + }, + "documentation":"

Container for the parameters to the UpdateAvailabilityOptions operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.

" + }, + "UpdateAvailabilityOptionsResponse":{ + "type":"structure", + "members":{ + "AvailabilityOptions":{ + "shape":"AvailabilityOptionsStatus", + "documentation":"

The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

" + } + }, + "documentation":"

The result of a UpdateAvailabilityOptions request. Contains the status of the domain's availability options.

" + }, + "UpdateScalingParametersRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ScalingParameters" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "ScalingParameters":{"shape":"ScalingParameters"} + }, + "documentation":"

Container for the parameters to the UpdateScalingParameters operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.

" + }, + "UpdateScalingParametersResponse":{ + "type":"structure", + "required":["ScalingParameters"], + "members":{ + "ScalingParameters":{"shape":"ScalingParametersStatus"} + }, + "documentation":"

The result of a UpdateScalingParameters request. Contains the status of the newly-configured scaling parameters.

" + }, + "UpdateServiceAccessPoliciesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "AccessPolicies" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "AccessPolicies":{ + "shape":"PolicyDocument", + "documentation":"

The access rules you want to configure. These rules replace any existing rules.

" + } + }, + "documentation":"

Container for the parameters to the UpdateServiceAccessPolicies operation. Specifies the name of the domain you want to update and the access rules you want to configure.

" + }, + "UpdateServiceAccessPoliciesResponse":{ + "type":"structure", + "required":["AccessPolicies"], + "members":{ + "AccessPolicies":{ + "shape":"AccessPoliciesStatus", + "documentation":"

The access rules configured for the domain.

" + } + }, + "documentation":"

The result of an UpdateServiceAccessPolicies request. Contains the new access policies.

" + }, + "UpdateTimestamp":{"type":"timestamp"}, + "Word":{ + "type":"string", + "pattern":"[\\S]+" + } + } +} diff --git a/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/examples-1.json b/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/service-2.json b/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/service-2.json new file mode 100644 index 00000000..018b114d --- /dev/null +++ b/aws/dist/botocore/data/cloudsearchdomain/2013-01-01/service-2.json @@ -0,0 +1,548 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-01-01", + "endpointPrefix":"cloudsearchdomain", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon CloudSearch Domain", + "serviceId":"CloudSearch Domain", + "signatureVersion":"v4", + "signingName":"cloudsearch", + "uid":"cloudsearchdomain-2013-01-01" + }, + "operations":{ + "Search":{ + "name":"Search", + "http":{ + "method":"GET", + "requestUri":"/2013-01-01/search?format=sdk&pretty=true" + }, + "input":{"shape":"SearchRequest"}, + "output":{"shape":"SearchResponse"}, + "errors":[ + {"shape":"SearchException"} + ], + "documentation":"

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

  • simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
  • structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
  • lucene: specify search criteria using the Apache Lucene query parser syntax.
  • dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" + }, + "Suggest":{ + "name":"Suggest", + "http":{ + "method":"GET", + "requestUri":"/2013-01-01/suggest?format=sdk&pretty=true" + }, + "input":{"shape":"SuggestRequest"}, + "output":{"shape":"SuggestResponse"}, + "errors":[ + {"shape":"SearchException"} + ], + "documentation":"

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

" + }, + "UploadDocuments":{ + "name":"UploadDocuments", + "http":{ + "method":"POST", + "requestUri":"/2013-01-01/documents/batch?format=sdk" + }, + "input":{"shape":"UploadDocumentsRequest"}, + "output":{"shape":"UploadDocumentsResponse"}, + "errors":[ + {"shape":"DocumentServiceException"} + ], + "documentation":"

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

" + } + }, + "shapes":{ + "Adds":{"type":"long"}, + "Blob":{ + "type":"blob", + "streaming":true + }, + "Bucket":{ + "type":"structure", + "members":{ + "value":{ + "shape":"String", + "documentation":"

The facet value being counted.

" + }, + "count":{ + "shape":"Long", + "documentation":"

The number of hits that contain the facet value in the specified facet field.

" + } + }, + "documentation":"

A container for facet information.

" + }, + "BucketInfo":{ + "type":"structure", + "members":{ + "buckets":{ + "shape":"BucketList", + "documentation":"

A list of the calculated facet values and counts.

" + } + }, + "documentation":"

A container for the calculated facet values and counts.

" + }, + "BucketList":{ + "type":"list", + "member":{"shape":"Bucket"} + }, + "ContentType":{ + "type":"string", + "enum":[ + "application/json", + "application/xml" + ] + }, + "Cursor":{"type":"string"}, + "Deletes":{"type":"long"}, + "DocumentServiceException":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"

The return status of a document upload request, error or success.

" + }, + "message":{ + "shape":"String", + "documentation":"

The description of the errors returned by the document service.

" + } + }, + "documentation":"

Information about any problems encountered while processing an upload request.

", + "exception":true + }, + "DocumentServiceWarning":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The description for a warning returned by the document service.

" + } + }, + "documentation":"

A warning returned by the document service when an issue is discovered while processing an upload request.

" + }, + "DocumentServiceWarnings":{ + "type":"list", + "member":{"shape":"DocumentServiceWarning"} + }, + "Double":{"type":"double"}, + "Expr":{"type":"string"}, + "Exprs":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Facet":{"type":"string"}, + "Facets":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"BucketInfo"} + }, + "FieldStats":{ + "type":"structure", + "members":{ + "min":{ + "shape":"String", + "documentation":"

The minimum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + }, + "max":{ + "shape":"String", + "documentation":"

The maximum value found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + }, + "count":{ + "shape":"Long", + "documentation":"

The number of documents that contain a value in the specified field in the result set.

" + }, + "missing":{ + "shape":"Long", + "documentation":"

The number of documents that do not contain a value in the specified field in the result set.

" + }, + "sum":{ + "shape":"Double", + "documentation":"

The sum of the field values across the documents in the result set. null for date fields.

" + }, + "sumOfSquares":{ + "shape":"Double", + "documentation":"

The sum of all field values in the result set squared.

" + }, + "mean":{ + "shape":"String", + "documentation":"

The average of the values found in the specified field in the result set.

If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.

" + }, + "stddev":{ + "shape":"Double", + "documentation":"

The standard deviation of the values in the specified field in the result set.

" + } + }, + "documentation":"

The statistics for a field calculated in the request.

" + }, + "FieldValue":{ + "type":"list", + "member":{"shape":"String"} + }, + "Fields":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"FieldValue"} + }, + "FilterQuery":{"type":"string"}, + "Highlight":{"type":"string"}, + "Highlights":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Hit":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The document ID of a document that matches the search request.

" + }, + "fields":{ + "shape":"Fields", + "documentation":"

The fields returned from a document that matches the search request.

" + }, + "exprs":{ + "shape":"Exprs", + "documentation":"

The expressions returned from a document that matches the search request.

" + }, + "highlights":{ + "shape":"Highlights", + "documentation":"

The highlights returned from a document that matches the search request.

" + } + }, + "documentation":"

Information about a document that matches the search request.

" + }, + "HitList":{ + "type":"list", + "member":{"shape":"Hit"} + }, + "Hits":{ + "type":"structure", + "members":{ + "found":{ + "shape":"Long", + "documentation":"

The total number of documents that match the search request.

" + }, + "start":{ + "shape":"Long", + "documentation":"

The index of the first matching document.

" + }, + "cursor":{ + "shape":"String", + "documentation":"

A cursor that can be used to retrieve the next set of matching documents when you want to page through a large result set.

" + }, + "hit":{ + "shape":"HitList", + "documentation":"

A document that matches the search request.

" + } + }, + "documentation":"

The collection of documents that match the search request.

" + }, + "Long":{"type":"long"}, + "Partial":{"type":"boolean"}, + "Query":{"type":"string"}, + "QueryOptions":{"type":"string"}, + "QueryParser":{ + "type":"string", + "enum":[ + "simple", + "structured", + "lucene", + "dismax" + ] + }, + "Return":{"type":"string"}, + "SearchException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

A description of the error returned by the search service.

" + } + }, + "documentation":"

Information about any problems encountered while processing a search request.

", + "exception":true + }, + "SearchRequest":{ + "type":"structure", + "required":["query"], + "members":{ + "cursor":{ + "shape":"Cursor", + "documentation":"

Retrieves a cursor value you can use to page through large result sets. Use the size parameter to control the number of hits to include in each response. You can specify either the cursor or start parameter in a request; they are mutually exclusive. To get the first cursor, set the cursor value to initial. In subsequent requests, specify the cursor value returned in the hits section of the response.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"cursor" + }, + "expr":{ + "shape":"Expr", + "documentation":"

Defines one or more numeric expressions that can be used to sort results or specify search or filter criteria. You can also specify expressions as return fields.

You specify the expressions in JSON using the form {\"EXPRESSIONNAME\":\"EXPRESSION\"}. You can define and use multiple expressions in a search request. For example:

{\"expression1\":\"_score*rating\", \"expression2\":\"(1/rank)*year\"}

For information about the variables, operators, and functions you can use in expressions, see Writing Expressions in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"expr" + }, + "facet":{ + "shape":"Facet", + "documentation":"

Specifies one or more fields for which to get facet information, and options that control how the facet information is returned. Each specified field must be facet-enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following faceting options:

  • buckets specifies an array of the facet values or ranges to count. Ranges are specified using the same syntax that you use to search for a range of values. For more information, see Searching for a Range of Values in the Amazon CloudSearch Developer Guide. Buckets are returned in the order they are specified in the request. The sort and size options are not valid if you specify buckets.

  • size specifies the maximum number of facets to include in the results. By default, Amazon CloudSearch returns counts for the top 10. The size parameter is only valid when you specify the sort option; it cannot be used in conjunction with buckets.

  • sort specifies how you want to sort the facets in the results: bucket or count. Specify bucket to sort alphabetically or numerically by facet value (in ascending order). Specify count to sort by the facet counts computed for each facet value (in descending order). To retrieve facet counts for particular values or ranges of values, use the buckets option instead of sort.

If no facet options are specified, facet counts are computed for all field values, the facets are sorted by facet count, and the top 10 facets are returned in the results.

To count particular buckets of values, use the buckets option. For example, the following request uses the buckets option to calculate and return facet counts by decade.

{\"year\":{\"buckets\":[\"[1970,1979]\",\"[1980,1989]\",\"[1990,1999]\",\"[2000,2009]\",\"[2010,}\"]}}

To sort facets by facet count, use the count option. For example, the following request sets the sort option to count to sort the facet values by facet count, with the facet values that have the most matching documents listed first. Setting the size option to 3 returns only the top three facet values.

{\"year\":{\"sort\":\"count\",\"size\":3}}

To sort the facets by value, use the bucket option. For example, the following request sets the sort option to bucket to sort the facet values numerically by year, with earliest year listed first.

{\"year\":{\"sort\":\"bucket\"}}

For more information, see Getting and Using Facet Information in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"facet" + }, + "filterQuery":{ + "shape":"FilterQuery", + "documentation":"

Specifies a structured query that filters the results of a search without affecting how the results are scored and sorted. You use filterQuery in conjunction with the query parameter to filter the documents that match the constraints specified in the query parameter. Specifying a filter controls only which matching documents are included in the results, it has no effect on how they are scored and sorted. The filterQuery parameter supports the full structured query syntax.

For more information about using filters, see Filtering Matching Documents in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"fq" + }, + "highlight":{ + "shape":"Highlight", + "documentation":"

Retrieves highlights for matches in the specified text or text-array fields. Each specified field must be highlight enabled in the domain configuration. The fields and options are specified in JSON using the form {\"FIELD\":{\"OPTION\":VALUE,\"OPTION:\"STRING\"},\"FIELD\":{\"OPTION\":VALUE,\"OPTION\":\"STRING\"}}.

You can specify the following highlight options:

  • format: specifies the format of the data in the text field: text or html. When data is returned as HTML, all non-alphanumeric characters are encoded. The default is html.
  • max_phrases: specifies the maximum number of occurrences of the search term(s) you want to highlight. By default, the first occurrence is highlighted.
  • pre_tag: specifies the string to prepend to an occurrence of a search term. The default for HTML highlights is &lt;em&gt;. The default for text highlights is *.
  • post_tag: specifies the string to append to an occurrence of a search term. The default for HTML highlights is &lt;/em&gt;. The default for text highlights is *.

If no highlight options are specified for a field, the returned field text is treated as HTML and the first match is highlighted with emphasis tags: &lt;em>search-term&lt;/em&gt;.

For example, the following request retrieves highlights for the actors and title fields.

{ \"actors\": {}, \"title\": {\"format\": \"text\",\"max_phrases\": 2,\"pre_tag\": \"\",\"post_tag\": \"\"} }

", + "location":"querystring", + "locationName":"highlight" + }, + "partial":{ + "shape":"Partial", + "documentation":"

Enables partial results to be returned if one or more index partitions are unavailable. When your search index is partitioned across multiple search instances, by default Amazon CloudSearch only returns results if every partition can be queried. This means that the failure of a single search instance can result in 5xx (internal server) errors. When you enable partial results, Amazon CloudSearch returns whatever results are available and includes the percentage of documents searched in the search results (percent-searched). This enables you to more gracefully degrade your users' search experience. For example, rather than displaying no results, you could display the partial results and a message indicating that the results might be incomplete due to a temporary system outage.

", + "location":"querystring", + "locationName":"partial" + }, + "query":{ + "shape":"Query", + "documentation":"

Specifies the search criteria for the request. How you specify the search criteria depends on the query parser used for the request and the parser options specified in the queryOptions parameter. By default, the simple query parser is used to process requests. To use the structured, lucene, or dismax query parser, you must also specify the queryParser parameter.

For more information about specifying search criteria, see Searching Your Data in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"q" + }, + "queryOptions":{ + "shape":"QueryOptions", + "documentation":"

Configures options for the query parser specified in the queryParser parameter. You specify the options in JSON using the following form {\"OPTION1\":\"VALUE1\",\"OPTION2\":VALUE2\"...\"OPTIONN\":\"VALUEN\"}.

The options you can configure vary according to which parser you use:

  • defaultOperator: The default operator used to combine individual terms in the search string. For example: defaultOperator: 'or'. For the dismax parser, you specify a percentage that represents the percentage of terms in the search string (rounded down) that must match, rather than a default operator. A value of 0% is the equivalent to OR, and a value of 100% is equivalent to AND. The percentage must be specified as a value in the range 0-100 followed by the percent (%) symbol. For example, defaultOperator: 50%. Valid values: and, or, a percentage in the range 0%-100% (dismax). Default: and (simple, structured, lucene) or 100 (dismax). Valid for: simple, structured, lucene, and dismax.
  • fields: An array of the fields to search when no fields are specified in a search. If no fields are specified in a search and this option is not specified, all text and text-array fields are searched. You can specify a weight for each field to control the relative importance of each field when Amazon CloudSearch calculates relevance scores. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost the importance of the title field over the description field you could specify: \"fields\":[\"title^5\",\"description\"]. Valid values: The name of any configured field and an optional numeric value greater than zero. Default: All text and text-array fields. Valid for: simple, structured, lucene, and dismax.
  • operators: An array of the operators or special characters you want to disable for the simple query parser. If you disable the and, or, or not operators, the corresponding operators (+, |, -) have no special meaning and are dropped from the search string. Similarly, disabling prefix disables the wildcard operator (*) and disabling phrase disables the ability to search for phrases by enclosing phrases in double quotes. Disabling precedence disables the ability to control order of precedence using parentheses. Disabling near disables the ability to use the ~ operator to perform a sloppy phrase search. Disabling the fuzzy operator disables the ability to use the ~ operator to perform a fuzzy search. escape disables the ability to use a backslash (\\) to escape special characters within the search string. Disabling whitespace is an advanced option that prevents the parser from tokenizing on whitespace, which can be useful for Vietnamese. (It prevents Vietnamese words from being split incorrectly.) For example, you could disable all operators other than the phrase operator to support just simple term and phrase queries: \"operators\":[\"and\",\"not\",\"or\", \"prefix\"]. Valid values: and, escape, fuzzy, near, not, or, phrase, precedence, prefix, whitespace. Default: All operators and special characters are enabled. Valid for: simple.
  • phraseFields: An array of the text or text-array fields you want to use for phrase searches. When the terms in the search string appear in close proximity within a field, the field scores higher. You can specify a weight for each field to boost that score. The phraseSlop option controls how much the matches can deviate from the search string and still be boosted. To specify a field weight, append a caret (^) symbol and the weight to the field name. For example, to boost phrase matches in the title field over the abstract field, you could specify: \"phraseFields\":[\"title^3\", \"plot\"] Valid values: The name of any text or text-array field and an optional numeric value greater than zero. Default: No fields. If you don't specify any fields with phraseFields, proximity scoring is disabled even if phraseSlop is specified. Valid for: dismax.
  • phraseSlop: An integer value that specifies how much matches can deviate from the search phrase and still be boosted according to the weights specified in the phraseFields option; for example, phraseSlop: 2. You must also specify phraseFields to enable proximity scoring. Valid values: positive integers. Default: 0. Valid for: dismax.
  • explicitPhraseSlop: An integer value that specifies how much a match can deviate from the search phrase when the phrase is enclosed in double quotes in the search string. (Phrases that exceed this proximity distance are not considered a match.) For example, to specify a slop of three for dismax phrase queries, you would specify \"explicitPhraseSlop\":3. Valid values: positive integers. Default: 0. Valid for: dismax.
  • tieBreaker: When a term in the search string is found in a document's field, a score is calculated for that field based on how common the word is in that field compared to other documents. If the term occurs in multiple fields within a document, by default only the highest scoring field contributes to the document's overall score. You can specify a tieBreaker value to enable the matches in lower-scoring fields to contribute to the document's score. That way, if two documents have the same max field score for a particular term, the score for the document that has matches in more fields will be higher. The formula for calculating the score with a tieBreaker is (max field score) + (tieBreaker) * (sum of the scores for the rest of the matching fields). Set tieBreaker to 0 to disregard all but the highest scoring field (pure max): \"tieBreaker\":0. Set to 1 to sum the scores from all fields (pure sum): \"tieBreaker\":1. Valid values: 0.0 to 1.0. Default: 0.0. Valid for: dismax.
", + "location":"querystring", + "locationName":"q.options" + }, + "queryParser":{ + "shape":"QueryParser", + "documentation":"

Specifies which query parser to use to process the request. If queryParser is not specified, Amazon CloudSearch uses the simple query parser.

Amazon CloudSearch supports four query parsers:

  • simple: perform simple searches of text and text-array fields. By default, the simple query parser searches all text and text-array fields. You can specify which fields to search by with the queryOptions parameter. If you prefix a search term with a plus sign (+) documents must contain the term to be considered a match. (This is the default, unless you configure the default operator with the queryOptions parameter.) You can use the - (NOT), | (OR), and * (wildcard) operators to exclude particular terms, find results that match any of the specified terms, or search for a prefix. To search for a phrase rather than individual terms, enclose the phrase in double quotes. For more information, see Searching for Text in the Amazon CloudSearch Developer Guide.
  • structured: perform advanced searches by combining multiple expressions to define the search criteria. You can also search within particular fields, search for values and ranges of values, and use advanced options such as term boosting, matchall, and near. For more information, see Constructing Compound Queries in the Amazon CloudSearch Developer Guide.
  • lucene: search using the Apache Lucene query parser syntax. For more information, see Apache Lucene Query Parser Syntax.
  • dismax: search using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser. For more information, see DisMax Query Parser Syntax.
", + "location":"querystring", + "locationName":"q.parser" + }, + "return":{ + "shape":"Return", + "documentation":"

Specifies the field and expression values to include in the response. Multiple fields or expressions are specified as a comma-separated list. By default, a search response includes all return enabled fields (_all_fields). To return only the document IDs for the matching documents, specify _no_fields. To retrieve the relevance score calculated for each document, specify _score.

", + "location":"querystring", + "locationName":"return" + }, + "size":{ + "shape":"Size", + "documentation":"

Specifies the maximum number of search hits to include in the response.

", + "location":"querystring", + "locationName":"size" + }, + "sort":{ + "shape":"Sort", + "documentation":"

Specifies the fields or custom expressions to use to sort the search results. Multiple fields or expressions are specified as a comma-separated list. You must specify the sort direction (asc or desc) for each field; for example, year desc,title asc. To use a field to sort results, the field must be sort-enabled in the domain configuration. Array type fields cannot be used for sorting. If no sort parameter is specified, results are sorted by their default relevance scores in descending order: _score desc. You can also sort by document ID (_id asc) and version (_version desc).

For more information, see Sorting Results in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"sort" + }, + "start":{ + "shape":"Start", + "documentation":"

Specifies the offset of the first search hit you want to return. Note that the result set is zero-based; the first result is at index 0. You can specify either the start or cursor parameter in a request, they are mutually exclusive.

For more information, see Paginating Results in the Amazon CloudSearch Developer Guide.

", + "location":"querystring", + "locationName":"start" + }, + "stats":{ + "shape":"Stat", + "documentation":"

Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:

{\"FIELD-A\":{},\"FIELD-B\":{}}

There are currently no options supported for statistics.

", + "location":"querystring", + "locationName":"stats" + } + }, + "documentation":"

Container for the parameters to the Search request.

" + }, + "SearchResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SearchStatus", + "documentation":"

The status information returned for the search request.

" + }, + "hits":{ + "shape":"Hits", + "documentation":"

The documents that match the search criteria.

" + }, + "facets":{ + "shape":"Facets", + "documentation":"

The requested facet information.

" + }, + "stats":{ + "shape":"Stats", + "documentation":"

The requested field statistics information.

" + } + }, + "documentation":"

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

" + }, + "SearchStatus":{ + "type":"structure", + "members":{ + "timems":{ + "shape":"Long", + "documentation":"

How long it took to process the request, in milliseconds.

" + }, + "rid":{ + "shape":"String", + "documentation":"

The encrypted resource ID for the request.

" + } + }, + "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" + }, + "Size":{"type":"long"}, + "Sort":{"type":"string"}, + "Start":{"type":"long"}, + "Stat":{"type":"string"}, + "Stats":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"FieldStats"}, + "documentation":"

The statistics calculated in the request.

" + }, + "String":{"type":"string"}, + "SuggestModel":{ + "type":"structure", + "members":{ + "query":{ + "shape":"String", + "documentation":"

The query string specified in the suggest request.

" + }, + "found":{ + "shape":"Long", + "documentation":"

The number of documents that were found to match the query string.

" + }, + "suggestions":{ + "shape":"Suggestions", + "documentation":"

The documents that match the query string.

" + } + }, + "documentation":"

Container for the suggestion information returned in a SuggestResponse.

" + }, + "SuggestRequest":{ + "type":"structure", + "required":[ + "query", + "suggester" + ], + "members":{ + "query":{ + "shape":"Query", + "documentation":"

Specifies the string for which you want to get suggestions.

", + "location":"querystring", + "locationName":"q" + }, + "suggester":{ + "shape":"Suggester", + "documentation":"

Specifies the name of the suggester to use to find suggested matches.

", + "location":"querystring", + "locationName":"suggester" + }, + "size":{ + "shape":"SuggestionsSize", + "documentation":"

Specifies the maximum number of suggestions to return.

", + "location":"querystring", + "locationName":"size" + } + }, + "documentation":"

Container for the parameters to the Suggest request.

" + }, + "SuggestResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SuggestStatus", + "documentation":"

The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

" + }, + "suggest":{ + "shape":"SuggestModel", + "documentation":"

Container for the matching search suggestion information.

" + } + }, + "documentation":"

Contains the response to a Suggest request.

" + }, + "SuggestStatus":{ + "type":"structure", + "members":{ + "timems":{ + "shape":"Long", + "documentation":"

How long it took to process the request, in milliseconds.

" + }, + "rid":{ + "shape":"String", + "documentation":"

The encrypted resource ID for the request.

" + } + }, + "documentation":"

Contains the resource id (rid) and the time it took to process the request (timems).

" + }, + "Suggester":{"type":"string"}, + "SuggestionMatch":{ + "type":"structure", + "members":{ + "suggestion":{ + "shape":"String", + "documentation":"

The string that matches the query string specified in the SuggestRequest.

" + }, + "score":{ + "shape":"Long", + "documentation":"

The relevance score of a suggested match.

" + }, + "id":{ + "shape":"String", + "documentation":"

The document ID of the suggested document.

" + } + }, + "documentation":"

An autocomplete suggestion that matches the query string specified in a SuggestRequest.

" + }, + "Suggestions":{ + "type":"list", + "member":{"shape":"SuggestionMatch"} + }, + "SuggestionsSize":{"type":"long"}, + "UploadDocumentsRequest":{ + "type":"structure", + "required":[ + "documents", + "contentType" + ], + "members":{ + "documents":{ + "shape":"Blob", + "documentation":"

A batch of documents formatted in JSON or HTML.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

  • application/json
  • application/xml
", + "location":"header", + "locationName":"Content-Type" + } + }, + "documentation":"

Container for the parameters to the UploadDocuments request.

", + "payload":"documents" + }, + "UploadDocumentsResponse":{ + "type":"structure", + "members":{ + "status":{ + "shape":"String", + "documentation":"

The status of an UploadDocumentsRequest.

" + }, + "adds":{ + "shape":"Adds", + "documentation":"

The number of documents that were added to the search domain.

" + }, + "deletes":{ + "shape":"Deletes", + "documentation":"

The number of documents that were deleted from the search domain.

" + }, + "warnings":{ + "shape":"DocumentServiceWarnings", + "documentation":"

Any warnings returned by the document service about the documents being uploaded.

" + } + }, + "documentation":"

Contains the response to an UploadDocuments request.

" + } + }, + "documentation":"

You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

" +} diff --git a/aws/dist/botocore/data/cloudtrail/2013-11-01/examples-1.json b/aws/dist/botocore/data/cloudtrail/2013-11-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudtrail/2013-11-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudtrail/2013-11-01/paginators-1.json b/aws/dist/botocore/data/cloudtrail/2013-11-01/paginators-1.json new file mode 100644 index 00000000..d990ba91 --- /dev/null +++ b/aws/dist/botocore/data/cloudtrail/2013-11-01/paginators-1.json @@ -0,0 +1,25 @@ +{ + "pagination": { + "LookupEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Events" + }, + "ListPublicKeys": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "PublicKeyList" + }, + "ListTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ResourceTagList" + }, + "ListTrails": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Trails" + } + } +} diff --git a/aws/dist/botocore/data/cloudtrail/2013-11-01/service-2.json b/aws/dist/botocore/data/cloudtrail/2013-11-01/service-2.json new file mode 100644 index 00000000..47de1282 --- /dev/null +++ b/aws/dist/botocore/data/cloudtrail/2013-11-01/service-2.json @@ -0,0 +1,1569 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-11-01", + "endpointPrefix":"cloudtrail", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CloudTrail", + "serviceFullName":"AWS CloudTrail", + "serviceId":"CloudTrail", + "signatureVersion":"v4", + "targetPrefix":"com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101", + "uid":"cloudtrail-2013-11-01" + }, + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsRequest"}, + "output":{"shape":"AddTagsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"CloudTrailARNInvalidException"}, + {"shape":"ResourceTypeNotSupportedException"}, + {"shape":"TagsLimitExceededException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"} + ], + "documentation":"

Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region).

", + "idempotent":true + }, + "CreateTrail":{ + "name":"CreateTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrailRequest"}, + "output":{"shape":"CreateTrailResponse"}, + "errors":[ + {"shape":"MaximumNumberOfTrailsExceededException"}, + {"shape":"TrailAlreadyExistsException"}, + {"shape":"S3BucketDoesNotExistException"}, + {"shape":"InsufficientS3BucketPolicyException"}, + {"shape":"InsufficientSnsTopicPolicyException"}, + {"shape":"InsufficientEncryptionPolicyException"}, + {"shape":"InvalidS3BucketNameException"}, + {"shape":"InvalidS3PrefixException"}, + {"shape":"InvalidSnsTopicNameException"}, + {"shape":"InvalidKmsKeyIdException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"TrailNotProvidedException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"KmsKeyNotFoundException"}, + {"shape":"KmsKeyDisabledException"}, + {"shape":"KmsException"}, + {"shape":"InvalidCloudWatchLogsLogGroupArnException"}, + {"shape":"InvalidCloudWatchLogsRoleArnException"}, + {"shape":"CloudWatchLogsDeliveryUnavailableException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"CloudTrailAccessNotEnabledException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"OrganizationsNotInUseException"}, + {"shape":"OrganizationNotInAllFeaturesModeException"} + ], + "documentation":"

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

", + "idempotent":true + }, + "DeleteTrail":{ + "name":"DeleteTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrailRequest"}, + "output":{"shape":"DeleteTrailResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidHomeRegionException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"} + ], + "documentation":"

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

", + "idempotent":true + }, + "DescribeTrails":{ + "name":"DescribeTrails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrailsRequest"}, + "output":{"shape":"DescribeTrailsResponse"}, + "errors":[ + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Retrieves settings for one or more trails associated with the current region for your account.

", + "idempotent":true + }, + "GetEventSelectors":{ + "name":"GetEventSelectors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEventSelectorsRequest"}, + "output":{"shape":"GetEventSelectorsResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

  • If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.

  • If your event selector includes management events.

  • If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.

For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

", + "idempotent":true + }, + "GetTrail":{ + "name":"GetTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTrailRequest"}, + "output":{"shape":"GetTrailResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Returns settings information for a specified trail.

", + "idempotent":true + }, + "GetTrailStatus":{ + "name":"GetTrailStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTrailStatusRequest"}, + "output":{"shape":"GetTrailStatusResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"} + ], + "documentation":"

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

", + "idempotent":true + }, + "ListPublicKeys":{ + "name":"ListPublicKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPublicKeysRequest"}, + "output":{"shape":"ListPublicKeysResponse"}, + "errors":[ + {"shape":"InvalidTimeRangeException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidTokenException"} + ], + "documentation":"

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

", + "idempotent":true + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"CloudTrailARNInvalidException"}, + {"shape":"ResourceTypeNotSupportedException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidTokenException"} + ], + "documentation":"

Lists the tags for the trail in the current region.

", + "idempotent":true + }, + "ListTrails":{ + "name":"ListTrails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTrailsRequest"}, + "output":{"shape":"ListTrailsResponse"}, + "errors":[ + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Lists trails that are in the current account.

", + "idempotent":true + }, + "LookupEvents":{ + "name":"LookupEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LookupEventsRequest"}, + "output":{"shape":"LookupEventsResponse"}, + "errors":[ + {"shape":"InvalidLookupAttributesException"}, + {"shape":"InvalidTimeRangeException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Looks up management events captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes:

  • AWS access key

  • Event ID

  • Event name

  • Event source

  • Read only

  • Resource name

  • Resource type

  • User name

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

", + "idempotent":true + }, + "PutEventSelectors":{ + "name":"PutEventSelectors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutEventSelectorsRequest"}, + "output":{"shape":"PutEventSelectorsResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidHomeRegionException"}, + {"shape":"InvalidEventSelectorsException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"} + ], + "documentation":"

Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

  1. You create an event selector for a trail and specify that you want write-only events.

  2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

  3. CloudTrail evaluates whether the events match your event selectors.

  4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

  5. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.

", + "idempotent":true + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsRequest"}, + "output":{"shape":"RemoveTagsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"CloudTrailARNInvalidException"}, + {"shape":"ResourceTypeNotSupportedException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"} + ], + "documentation":"

Removes the specified tags from a trail.

", + "idempotent":true + }, + "StartLogging":{ + "name":"StartLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartLoggingRequest"}, + "output":{"shape":"StartLoggingResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidHomeRegionException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"} + ], + "documentation":"

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

", + "idempotent":true + }, + "StopLogging":{ + "name":"StopLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopLoggingRequest"}, + "output":{"shape":"StopLoggingResponse"}, + "errors":[ + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"InvalidHomeRegionException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"} + ], + "documentation":"

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

", + "idempotent":true + }, + "UpdateTrail":{ + "name":"UpdateTrail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTrailRequest"}, + "output":{"shape":"UpdateTrailResponse"}, + "errors":[ + {"shape":"S3BucketDoesNotExistException"}, + {"shape":"InsufficientS3BucketPolicyException"}, + {"shape":"InsufficientSnsTopicPolicyException"}, + {"shape":"InsufficientEncryptionPolicyException"}, + {"shape":"TrailNotFoundException"}, + {"shape":"InvalidS3BucketNameException"}, + {"shape":"InvalidS3PrefixException"}, + {"shape":"InvalidSnsTopicNameException"}, + {"shape":"InvalidKmsKeyIdException"}, + {"shape":"InvalidTrailNameException"}, + {"shape":"TrailNotProvidedException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InvalidHomeRegionException"}, + {"shape":"KmsKeyNotFoundException"}, + {"shape":"KmsKeyDisabledException"}, + {"shape":"KmsException"}, + {"shape":"InvalidCloudWatchLogsLogGroupArnException"}, + {"shape":"InvalidCloudWatchLogsRoleArnException"}, + {"shape":"CloudWatchLogsDeliveryUnavailableException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"CloudTrailAccessNotEnabledException"}, + {"shape":"InsufficientDependencyServiceAccessPermissionException"}, + {"shape":"OrganizationsNotInUseException"}, + {"shape":"NotOrganizationMasterAccountException"}, + {"shape":"OrganizationNotInAllFeaturesModeException"} + ], + "documentation":"

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

", + "idempotent":true + } + }, + "shapes":{ + "AddTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "TagsList":{ + "shape":"TagsList", + "documentation":"

Contains a list of CloudTrail tags, up to a limit of 50

" + } + }, + "documentation":"

Specifies the tags to add to a trail.

" + }, + "AddTagsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "Boolean":{"type":"boolean"}, + "ByteBuffer":{"type":"blob"}, + "CloudTrailARNInvalidException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

", + "exception":true + }, + "CloudTrailAccessNotEnabledException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when trusted access has not been enabled between AWS CloudTrail and AWS Organizations. For more information, see Enabling Trusted Access with Other AWS Services and Prepare For Creating a Trail For Your Organization.

", + "exception":true + }, + "CloudWatchLogsDeliveryUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Cannot set a CloudWatch Logs delivery for this region.

", + "exception":true + }, + "CreateTrailRequest":{ + "type":"structure", + "required":[ + "Name", + "S3BucketName" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail. The name must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + }, + "IsMultiRegionTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.

" + }, + "EnableLogFileValidation":{ + "shape":"Boolean", + "documentation":"

Specifies whether log file integrity validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"String", + "documentation":"

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

" + }, + "IsOrganizationTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations.

" + }, + "TagsList":{"shape":"TagsList"} + }, + "documentation":"

Specifies the settings for each trail.

" + }, + "CreateTrailResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

This field is no longer in use. Use SnsTopicARN.

", + "deprecated":true + }, + "SnsTopicARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + }, + "IsMultiRegionTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail exists in one region or in all regions.

" + }, + "TrailARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "LogFileValidationEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether log file integrity validation is enabled.

" + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"String", + "documentation":"

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

" + }, + "IsOrganizationTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is an organization trail.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "DataResource":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources.

" + }, + "Values":{ + "shape":"DataResourceValues", + "documentation":"

An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

  • To log data events for all objects in all S3 buckets in your AWS account, specify the prefix as arn:aws:s3:::.

    This will also enable logging of data event activity performed by any user or role in your AWS account, even if that activity is performed on a bucket that belongs to another AWS account.

  • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.

  • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

  • To log data events for all functions in your AWS account, specify the prefix as arn:aws:lambda.

    This will also enable logging of Invoke activity performed by any user or role in your AWS account, even if that activity is performed on a function that belongs to another AWS account.

  • To log data events for a specific Lambda function, specify the function ARN.

    Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us-west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us-west-2:111111111111:function:helloworld2.
" + } + }, + "documentation":"

The Amazon S3 buckets or AWS Lambda functions that you specify in your event selectors for your trail to log data events. Data events provide insight into the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.

The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.

The following example demonstrates how logging works when you configure logging of all data events for an S3 bucket named bucket-1. In this example, the CloudTrail user specified an empty prefix, and the option to log both Read and Write data events.

  1. A user uploads an image file to bucket-1.

  2. The PutObject API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event.

  3. A user uploads an object to an Amazon S3 bucket named arn:aws:s3:::bucket-2.

  4. The PutObject API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.

The following example demonstrates how logging works when you configure logging of AWS Lambda data events for a Lambda function named MyLambdaFunction, but not for all AWS Lambda functions.

  1. A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.

  2. The Invoke API operation on MyLambdaFunction is an AWS Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event.

  3. The Invoke API operation on MyOtherLambdaFunction is an AWS Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, the Invoke operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.

" + }, + "DataResourceValues":{ + "type":"list", + "member":{"shape":"String"} + }, + "DataResources":{ + "type":"list", + "member":{"shape":"DataResource"} + }, + "Date":{"type":"timestamp"}, + "DeleteTrailRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + } + }, + "documentation":"

The request that specifies the name of a trail to delete.

" + }, + "DeleteTrailResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "DescribeTrailsRequest":{ + "type":"structure", + "members":{ + "trailNameList":{ + "shape":"TrailNameList", + "documentation":"

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current region is returned.

  • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned.

  • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.

" + }, + "includeShadowTrails":{ + "shape":"Boolean", + "documentation":"

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.

" + } + }, + "documentation":"

Returns information about the trail.

" + }, + "DescribeTrailsResponse":{ + "type":"structure", + "members":{ + "trailList":{ + "shape":"TrailList", + "documentation":"

The list of trail objects.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "Event":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"String", + "documentation":"

The CloudTrail ID of the event returned.

" + }, + "EventName":{ + "shape":"String", + "documentation":"

The name of the event returned.

" + }, + "ReadOnly":{ + "shape":"String", + "documentation":"

Information about whether the event is a write event or a read event.

" + }, + "AccessKeyId":{ + "shape":"String", + "documentation":"

The AWS access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.

" + }, + "EventTime":{ + "shape":"Date", + "documentation":"

The date and time of the event returned.

" + }, + "EventSource":{ + "shape":"String", + "documentation":"

The AWS service that the request was made to.

" + }, + "Username":{ + "shape":"String", + "documentation":"

A user name or role name of the requester that called the API in the event returned.

" + }, + "Resources":{ + "shape":"ResourceList", + "documentation":"

A list of resources referenced by the event returned.

" + }, + "CloudTrailEvent":{ + "shape":"String", + "documentation":"

A JSON string that contains a representation of the event returned.

" + } + }, + "documentation":"

Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.

" + }, + "EventSelector":{ + "type":"structure", + "members":{ + "ReadWriteType":{ + "shape":"ReadWriteType", + "documentation":"

Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.

By default, the value is All.

" + }, + "IncludeManagementEvents":{ + "shape":"Boolean", + "documentation":"

Specify if you want your event selector to include management events for your trail.

For more information, see Management Events in the AWS CloudTrail User Guide.

By default, the value is true.

" + }, + "DataResources":{ + "shape":"DataResources", + "documentation":"

CloudTrail supports data event logging for Amazon S3 objects and AWS Lambda functions. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events.

For more information, see Data Events and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.

" + } + }, + "documentation":"

Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

" + }, + "EventSelectors":{ + "type":"list", + "member":{"shape":"EventSelector"} + }, + "EventsList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "GetEventSelectorsRequest":{ + "type":"structure", + "required":["TrailName"], + "members":{ + "TrailName":{ + "shape":"String", + "documentation":"

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + } + } + }, + "GetEventSelectorsResponse":{ + "type":"structure", + "members":{ + "TrailARN":{ + "shape":"String", + "documentation":"

The specified trail ARN that has the event selectors.

" + }, + "EventSelectors":{ + "shape":"EventSelectors", + "documentation":"

The event selectors that are configured for the trail.

" + } + } + }, + "GetTrailRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

" + } + } + }, + "GetTrailResponse":{ + "type":"structure", + "members":{ + "Trail":{"shape":"Trail"} + } + }, + "GetTrailStatusRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + } + }, + "documentation":"

The name of a trail about which you want the current status.

" + }, + "GetTrailStatusResponse":{ + "type":"structure", + "members":{ + "IsLogging":{ + "shape":"Boolean", + "documentation":"

Whether the CloudTrail is currently logging AWS API calls.

" + }, + "LatestDeliveryError":{ + "shape":"String", + "documentation":"

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.

" + }, + "LatestNotificationError":{ + "shape":"String", + "documentation":"

Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the Amazon SNS Developer Guide.

" + }, + "LatestDeliveryTime":{ + "shape":"Date", + "documentation":"

Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.

" + }, + "LatestNotificationTime":{ + "shape":"Date", + "documentation":"

Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.

" + }, + "StartLoggingTime":{ + "shape":"Date", + "documentation":"

Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.

" + }, + "StopLoggingTime":{ + "shape":"Date", + "documentation":"

Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.

" + }, + "LatestCloudWatchLogsDeliveryError":{ + "shape":"String", + "documentation":"

Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.

" + }, + "LatestCloudWatchLogsDeliveryTime":{ + "shape":"Date", + "documentation":"

Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.

" + }, + "LatestDigestDeliveryTime":{ + "shape":"Date", + "documentation":"

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

" + }, + "LatestDigestDeliveryError":{ + "shape":"String", + "documentation":"

Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic Error Responses in the Amazon S3 API Reference.

This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.

" + }, + "LatestDeliveryAttemptTime":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + }, + "LatestNotificationAttemptTime":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + }, + "LatestNotificationAttemptSucceeded":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + }, + "LatestDeliveryAttemptSucceeded":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + }, + "TimeLoggingStarted":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + }, + "TimeLoggingStopped":{ + "shape":"String", + "documentation":"

This field is no longer in use.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "InsufficientDependencyServiceAccessPermissionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for creating an organization trail in a required service. For more information, see Prepare For Creating a Trail For Your Organization.

", + "exception":true + }, + "InsufficientEncryptionPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.

", + "exception":true + }, + "InsufficientS3BucketPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the policy on the S3 bucket is not sufficient.

", + "exception":true + }, + "InsufficientSnsTopicPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the policy on the SNS topic is not sufficient.

", + "exception":true + }, + "InvalidCloudWatchLogsLogGroupArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided CloudWatch log group is not valid.

", + "exception":true + }, + "InvalidCloudWatchLogsRoleArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided role is not valid.

", + "exception":true + }, + "InvalidEventSelectorsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the PutEventSelectors operation is called with a number of event selectors or data resources that is not valid. The combination of event selectors and data resources is not valid. A trail can have up to 5 event selectors. A trail is limited to 250 data resources. These data resources can be distributed across event selectors, but the overall total cannot exceed 250.

You can:

  • Specify a valid number of event selectors (1 to 5) for a trail.

  • Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.

  • Specify a valid value for a parameter. For example, specifying the ReadWriteType parameter with a value of read-only is invalid.

", + "exception":true + }, + "InvalidHomeRegionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.

", + "exception":true + }, + "InvalidKmsKeyIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the KMS key ARN is invalid.

", + "exception":true + }, + "InvalidLookupAttributesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Occurs when an invalid lookup attribute is specified.

", + "exception":true + }, + "InvalidMaxResultsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown if the limit specified is invalid.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.

", + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the combination of parameters provided is not valid.

", + "exception":true + }, + "InvalidS3BucketNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided S3 bucket name is not valid.

", + "exception":true + }, + "InvalidS3PrefixException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided S3 prefix is not valid.

", + "exception":true + }, + "InvalidSnsTopicNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided SNS topic name is not valid.

", + "exception":true + }, + "InvalidTagParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.

", + "exception":true + }, + "InvalidTimeRangeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.

", + "exception":true + }, + "InvalidTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Reserved for future use.

", + "exception":true + }, + "InvalidTrailNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

", + "exception":true + }, + "KmsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.

", + "exception":true + }, + "KmsKeyDisabledException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is no longer in use.

", + "deprecated":true, + "exception":true + }, + "KmsKeyNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.

", + "exception":true + }, + "ListPublicKeysRequest":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Date", + "documentation":"

Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

" + }, + "EndTime":{ + "shape":"Date", + "documentation":"

Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Requests the public keys for a specified time range.

" + }, + "ListPublicKeysResponse":{ + "type":"structure", + "members":{ + "PublicKeyList":{ + "shape":"PublicKeyList", + "documentation":"

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "ListTagsRequest":{ + "type":"structure", + "required":["ResourceIdList"], + "members":{ + "ResourceIdList":{ + "shape":"ResourceIdList", + "documentation":"

Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Specifies a list of trail tags to return.

" + }, + "ListTagsResponse":{ + "type":"structure", + "members":{ + "ResourceTagList":{ + "shape":"ResourceTagList", + "documentation":"

A list of resource tags.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "ListTrailsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"String"} + } + }, + "ListTrailsResponse":{ + "type":"structure", + "members":{ + "Trails":{ + "shape":"Trails", + "documentation":"

Returns the name, ARN, and home region of trails in the current account.

" + }, + "NextToken":{"shape":"String"} + } + }, + "LookupAttribute":{ + "type":"structure", + "required":[ + "AttributeKey", + "AttributeValue" + ], + "members":{ + "AttributeKey":{ + "shape":"LookupAttributeKey", + "documentation":"

Specifies an attribute on which to filter the events returned.

" + }, + "AttributeValue":{ + "shape":"String", + "documentation":"

Specifies a value for the specified AttributeKey.

" + } + }, + "documentation":"

Specifies an attribute and value that filter the events returned.

" + }, + "LookupAttributeKey":{ + "type":"string", + "enum":[ + "EventId", + "EventName", + "ReadOnly", + "Username", + "ResourceType", + "ResourceName", + "EventSource", + "AccessKeyId" + ] + }, + "LookupAttributesList":{ + "type":"list", + "member":{"shape":"LookupAttribute"} + }, + "LookupEventsRequest":{ + "type":"structure", + "members":{ + "LookupAttributes":{ + "shape":"LookupAttributesList", + "documentation":"

Contains a list of lookup attributes. Currently the list can contain only one item.

" + }, + "StartTime":{ + "shape":"Date", + "documentation":"

Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.

" + }, + "EndTime":{ + "shape":"Date", + "documentation":"

Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of events to return. Possible values are 1 through 50. The default is 50.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" + } + }, + "documentation":"

Contains a request for LookupEvents.

" + }, + "LookupEventsResponse":{ + "type":"structure", + "members":{ + "Events":{ + "shape":"EventsList", + "documentation":"

A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.

" + } + }, + "documentation":"

Contains a response to a LookupEvents action.

" + }, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaximumNumberOfTrailsExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the maximum number of trails is reached.

", + "exception":true + }, + "NextToken":{"type":"string"}, + "NotOrganizationMasterAccountException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the AWS account making the request to create or update an organization trail is not the master account for an organization in AWS Organizations. For more information, see Prepare For Creating a Trail For Your Organization.

", + "exception":true + }, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the requested operation is not permitted.

", + "exception":true + }, + "OrganizationNotInAllFeaturesModeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when AWS Organizations is not configured to support all features. All features must be enabled in AWS Organization to support creating an organization trail. For more information, see Prepare For Creating a Trail For Your Organization.

", + "exception":true + }, + "OrganizationsNotInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the request is made from an AWS account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.

", + "exception":true + }, + "PublicKey":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"ByteBuffer", + "documentation":"

The DER encoded public key value in PKCS#1 format.

" + }, + "ValidityStartTime":{ + "shape":"Date", + "documentation":"

The starting time of validity of the public key.

" + }, + "ValidityEndTime":{ + "shape":"Date", + "documentation":"

The ending time of validity of the public key.

" + }, + "Fingerprint":{ + "shape":"String", + "documentation":"

The fingerprint of the public key.

" + } + }, + "documentation":"

Contains information about a returned public key.

" + }, + "PublicKeyList":{ + "type":"list", + "member":{"shape":"PublicKey"} + }, + "PutEventSelectorsRequest":{ + "type":"structure", + "required":[ + "TrailName", + "EventSelectors" + ], + "members":{ + "TrailName":{ + "shape":"String", + "documentation":"

Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

If you specify a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "EventSelectors":{ + "shape":"EventSelectors", + "documentation":"

Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.

" + } + } + }, + "PutEventSelectorsResponse":{ + "type":"structure", + "members":{ + "TrailARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "EventSelectors":{ + "shape":"EventSelectors", + "documentation":"

Specifies the event selectors configured for your trail.

" + } + } + }, + "ReadWriteType":{ + "type":"string", + "enum":[ + "ReadOnly", + "WriteOnly", + "All" + ] + }, + "RemoveTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "TagsList":{ + "shape":"TagsList", + "documentation":"

Specifies a list of tags to be removed.

" + } + }, + "documentation":"

Specifies the tags to remove from a trail.

" + }, + "RemoveTagsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "Resource":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"String", + "documentation":"

The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.

" + }, + "ResourceName":{ + "shape":"String", + "documentation":"

The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.

" + } + }, + "documentation":"

Specifies the type and name of a resource referenced by an event.

" + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"}, + "documentation":"

A list of resources referenced by the event returned.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the specified resource is not found.

", + "exception":true + }, + "ResourceTag":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

Specifies the ARN of the resource.

" + }, + "TagsList":{ + "shape":"TagsList", + "documentation":"

A list of tags.

" + } + }, + "documentation":"

A resource tag.

" + }, + "ResourceTagList":{ + "type":"list", + "member":{"shape":"ResourceTag"} + }, + "ResourceTypeNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the specified resource type is not supported by CloudTrail.

", + "exception":true + }, + "S3BucketDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the specified S3 bucket does not exist.

", + "exception":true + }, + "StartLoggingRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + } + }, + "documentation":"

The request to CloudTrail to start logging AWS API calls for an account.

" + }, + "StartLoggingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "StopLoggingRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + } + }, + "documentation":"

Passes the request to CloudTrail to stop logging AWS API calls for the specified account.

" + }, + "StopLoggingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

" + } + }, + "documentation":"

A custom key-value pair associated with a resource such as a CloudTrail trail.

" + }, + "TagsLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.

", + "exception":true + }, + "TagsList":{ + "type":"list", + "member":{"shape":"Tag"}, + "documentation":"

A list of tags.

" + }, + "Trail":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Name of the trail set by calling CreateTrail. The maximum length is 128 characters.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.The maximum length is 200 characters.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

This field is no longer in use. Use SnsTopicARN.

", + "deprecated":true + }, + "SnsTopicARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.

" + }, + "IsMultiRegionTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail exists only in one region or exists in all regions.

" + }, + "HomeRegion":{ + "shape":"String", + "documentation":"

The region in which the trail was created.

" + }, + "TrailARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "LogFileValidationEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether log file validation is enabled.

" + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"String", + "documentation":"

Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

" + }, + "HasCustomEventSelectors":{ + "shape":"Boolean", + "documentation":"

Specifies if the trail has custom event selectors.

" + }, + "IsOrganizationTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is an organization trail.

" + } + }, + "documentation":"

The settings for a trail.

" + }, + "TrailAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the specified trail already exists.

", + "exception":true + }, + "TrailInfo":{ + "type":"structure", + "members":{ + "TrailARN":{ + "shape":"String", + "documentation":"

The ARN of a trail.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of a trail.

" + }, + "HomeRegion":{ + "shape":"String", + "documentation":"

The AWS region in which a trail was created.

" + } + }, + "documentation":"

Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).

" + }, + "TrailList":{ + "type":"list", + "member":{"shape":"Trail"} + }, + "TrailNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TrailNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the trail with the given name is not found.

", + "exception":true + }, + "TrailNotProvidedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is no longer in use.

", + "exception":true + }, + "Trails":{ + "type":"list", + "member":{"shape":"TrailInfo"} + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception is thrown when the requested operation is not supported.

", + "exception":true + }, + "UpdateTrailRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

  • Start with a letter or number, and end with a letter or number

  • Be between 3 and 128 characters

  • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.

  • Not be in IP address format (for example, 192.168.5.4)

If Name is a trail ARN, it must be in the format:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + }, + "IsMultiRegionTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions.

" + }, + "EnableLogFileValidation":{ + "shape":"Boolean", + "documentation":"

Specifies whether log file validation is enabled. The default is false.

When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

" + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"String", + "documentation":"

Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

Examples:

  • alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

  • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

  • 12345678-1234-1234-1234-123456789012

" + }, + "IsOrganizationTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.

" + } + }, + "documentation":"

Specifies settings to update for the trail.

" + }, + "UpdateTrailResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Specifies the name of the trail.

" + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

Specifies the name of the Amazon S3 bucket designated for publishing log files.

" + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

" + }, + "SnsTopicName":{ + "shape":"String", + "documentation":"

This field is no longer in use. Use SnsTopicARN.

", + "deprecated":true + }, + "SnsTopicARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

" + }, + "IncludeGlobalServiceEvents":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is publishing events from global services such as IAM to the log files.

" + }, + "IsMultiRegionTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail exists in one region or in all regions.

" + }, + "TrailARN":{ + "shape":"String", + "documentation":"

Specifies the ARN of the trail that was updated. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

" + }, + "LogFileValidationEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether log file integrity validation is enabled.

" + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"String", + "documentation":"

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"String", + "documentation":"

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

" + }, + "IsOrganizationTrail":{ + "shape":"Boolean", + "documentation":"

Specifies whether the trail is an organization trail.

" + } + }, + "documentation":"

Returns the objects or data listed below if successful. Otherwise, returns an error.

" + } + }, + "documentation":"AWS CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

See the AWS CloudTrail User Guide for information about the data that is included with each AWS API call listed in the log files.

" +} diff --git a/aws/dist/botocore/data/cloudwatch/2010-08-01/examples-1.json b/aws/dist/botocore/data/cloudwatch/2010-08-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cloudwatch/2010-08-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cloudwatch/2010-08-01/paginators-1.json b/aws/dist/botocore/data/cloudwatch/2010-08-01/paginators-1.json new file mode 100644 index 00000000..a1b14c13 --- /dev/null +++ b/aws/dist/botocore/data/cloudwatch/2010-08-01/paginators-1.json @@ -0,0 +1,35 @@ +{ + "pagination": { + "DescribeAlarmHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "AlarmHistoryItems" + }, + "DescribeAlarms": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "MetricAlarms" + }, + "ListDashboards": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "DashboardEntries" + }, + "ListMetrics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Metrics" + }, + "GetMetricData": { + "input_token": "NextToken", + "limit_key": "MaxDatapoints", + "output_token": "NextToken", + "result_key": [ + "MetricDataResults", + "Messages" + ] + } + } +} diff --git a/aws/dist/botocore/data/cloudwatch/2010-08-01/service-2.json b/aws/dist/botocore/data/cloudwatch/2010-08-01/service-2.json new file mode 100644 index 00000000..c75d6352 --- /dev/null +++ b/aws/dist/botocore/data/cloudwatch/2010-08-01/service-2.json @@ -0,0 +1,2244 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-08-01", + "endpointPrefix":"monitoring", + "protocol":"query", + "serviceAbbreviation":"CloudWatch", + "serviceFullName":"Amazon CloudWatch", + "serviceId":"CloudWatch", + "signatureVersion":"v4", + "uid":"monitoring-2010-08-01", + "xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/" + }, + "operations":{ + "DeleteAlarms":{ + "name":"DeleteAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAlarmsInput"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

Deletes the specified alarms. You can delete up to 50 alarms in one operation. In the event of an error, no alarms are deleted.

" + }, + "DeleteAnomalyDetector":{ + "name":"DeleteAnomalyDetector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAnomalyDetectorInput"}, + "output":{ + "shape":"DeleteAnomalyDetectorOutput", + "resultWrapper":"DeleteAnomalyDetectorResult" + }, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"} + ], + "documentation":"

Deletes the specified anomaly detection model from your account.

" + }, + "DeleteDashboards":{ + "name":"DeleteDashboards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDashboardsInput"}, + "output":{ + "shape":"DeleteDashboardsOutput", + "resultWrapper":"DeleteDashboardsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"DashboardNotFoundError"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Deletes all dashboards that you specify. You may specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

" + }, + "DescribeAlarmHistory":{ + "name":"DescribeAlarmHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmHistoryInput"}, + "output":{ + "shape":"DescribeAlarmHistoryOutput", + "resultWrapper":"DescribeAlarmHistoryResult" + }, + "errors":[ + {"shape":"InvalidNextToken"} + ], + "documentation":"

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for all alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

" + }, + "DescribeAlarms":{ + "name":"DescribeAlarms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsInput"}, + "output":{ + "shape":"DescribeAlarmsOutput", + "resultWrapper":"DescribeAlarmsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"} + ], + "documentation":"

Retrieves the specified alarms. If no alarms are specified, all alarms are returned. Alarms can be retrieved by using only a prefix for the alarm name, the alarm state, or a prefix for any action.

" + }, + "DescribeAlarmsForMetric":{ + "name":"DescribeAlarmsForMetric", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlarmsForMetricInput"}, + "output":{ + "shape":"DescribeAlarmsForMetricOutput", + "resultWrapper":"DescribeAlarmsForMetricResult" + }, + "documentation":"

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

" + }, + "DescribeAnomalyDetectors":{ + "name":"DescribeAnomalyDetectors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAnomalyDetectorsInput"}, + "output":{ + "shape":"DescribeAnomalyDetectorsOutput", + "resultWrapper":"DescribeAnomalyDetectorsResult" + }, + "errors":[ + {"shape":"InvalidNextToken"}, + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

" + }, + "DisableAlarmActions":{ + "name":"DisableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableAlarmActionsInput"}, + "documentation":"

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

" + }, + "EnableAlarmActions":{ + "name":"EnableAlarmActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAlarmActionsInput"}, + "documentation":"

Enables the actions for the specified alarms.

" + }, + "GetDashboard":{ + "name":"GetDashboard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDashboardInput"}, + "output":{ + "shape":"GetDashboardOutput", + "resultWrapper":"GetDashboardResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"DashboardNotFoundError"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Displays the details of the dashboard that you specify.

To copy an existing dashboard, use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard to create the copy.

" + }, + "GetMetricData":{ + "name":"GetMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricDataInput"}, + "output":{ + "shape":"GetMetricDataOutput", + "resultWrapper":"GetMetricDataResult" + }, + "errors":[ + {"shape":"InvalidNextToken"} + ], + "documentation":"

You can use the GetMetricData API to retrieve as many as 100 different metrics in a single request, with a total of as many as 100,800 datapoints. You can also optionally perform math expressions on the values of the returned statistics, to create new time series that represent new insights into your data. For example, using Lambda metrics, you could divide the Errors metric by the Invocations metric to get an error rate time series. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Calls to the GetMetricData API have a different pricing structure than calls to GetMetricStatistics. For more information about pricing, see Amazon CloudWatch Pricing.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

If you omit Unit in your request, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + }, + "GetMetricStatistics":{ + "name":"GetMetricStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricStatisticsInput"}, + "output":{ + "shape":"GetMetricStatisticsOutput", + "resultWrapper":"GetMetricStatisticsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Gets statistics for the specified metric.

The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. Data points are not returned in chronological order.

CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1.

  • The Min and the Max values of the statistic set are equal.

Percentile statistics are not available for metrics when any of the metric values are negative numbers.

Amazon CloudWatch retains metric data as follows:

  • Data points with a period of less than 60 seconds are available for 3 hours. These data points are high-resolution metrics and are available only for custom metrics that have been defined with a StorageResolution of 1.

  • Data points with a period of 60 seconds (1-minute) are available for 15 days.

  • Data points with a period of 300 seconds (5-minute) are available for 63 days.

  • Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months).

Data points that are initially published with a shorter period are aggregated together for long-term storage. For example, if you collect data using a period of 1 minute, the data remains available for 15 days with 1-minute resolution. After 15 days, this data is still available, but is aggregated and retrievable only with a resolution of 5 minutes. After 63 days, the data is further aggregated and is available with a resolution of 1 hour.

CloudWatch started retaining 5-minute and 1-hour metric data as of July 9, 2016.

For information about metrics and dimensions supported by AWS services, see the Amazon CloudWatch Metrics and Dimensions Reference in the Amazon CloudWatch User Guide.

" + }, + "GetMetricWidgetImage":{ + "name":"GetMetricWidgetImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMetricWidgetImageInput"}, + "output":{ + "shape":"GetMetricWidgetImageOutput", + "resultWrapper":"GetMetricWidgetImageResult" + }, + "documentation":"

You can use the GetMetricWidgetImage API to retrieve a snapshot graph of one or more Amazon CloudWatch metrics as a bitmap image. You can then embed this image into your services and products, such as wiki pages, reports, and documents. You could also retrieve images regularly, such as every minute, and create your own custom live dashboard.

The graph you retrieve can include all CloudWatch metric graph features, including metric math and horizontal and vertical annotations.

There is a limit of 20 transactions per second for this API. Each GetMetricWidgetImage action has the following limits:

  • As many as 100 metrics in the graph.

  • Up to 100 KB uncompressed payload.

" + }, + "ListDashboards":{ + "name":"ListDashboards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDashboardsInput"}, + "output":{ + "shape":"ListDashboardsOutput", + "resultWrapper":"ListDashboardsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Returns a list of the dashboards for your account. If you include DashboardNamePrefix, only those dashboards with names starting with the prefix are listed. Otherwise, all dashboards in your account are listed.

ListDashboards returns up to 1000 results on one page. If there are more than 1000 dashboards, you can call ListDashboards again and include the value you received for NextToken in the first call, to receive the next 1000 results.

" + }, + "ListMetrics":{ + "name":"ListMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMetricsInput"}, + "output":{ + "shape":"ListMetricsOutput", + "resultWrapper":"ListMetricsResult" + }, + "errors":[ + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to fifteen minutes before the metric appears. Statistics about the metric, however, are available sooner using GetMetricData or GetMetricStatistics.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{ + "shape":"ListTagsForResourceOutput", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Displays the tags associated with a CloudWatch resource. Alarms support tagging.

" + }, + "PutAnomalyDetector":{ + "name":"PutAnomalyDetector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAnomalyDetectorInput"}, + "output":{ + "shape":"PutAnomalyDetectorOutput", + "resultWrapper":"PutAnomalyDetectorResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"} + ], + "documentation":"

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

" + }, + "PutDashboard":{ + "name":"PutDashboard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDashboardInput"}, + "output":{ + "shape":"PutDashboardOutput", + "resultWrapper":"PutDashboardResult" + }, + "errors":[ + {"shape":"DashboardInvalidInputError"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

" + }, + "PutMetricAlarm":{ + "name":"PutMetricAlarm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricAlarmInput"}, + "errors":[ + {"shape":"LimitExceededFault"} + ], + "documentation":"

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

  • iam:CreateServiceLinkedRole for all alarms with EC2 actions

  • ec2:DescribeInstanceStatus and ec2:DescribeInstances for all alarms on EC2 instance status metrics

  • ec2:StopInstances for alarms with stop actions

  • ec2:TerminateInstances for alarms with terminate actions

  • No specific permissions are needed for alarms with recover actions

If you have read/write permissions for Amazon CloudWatch but not for Amazon EC2, you can still create an alarm, but the stop or terminate actions are not performed. However, if you are later granted the required permissions, the alarm actions that you created earlier are performed.

If you are using an IAM role (for example, an EC2 instance profile), you cannot stop or terminate the instance using alarm actions. However, you can still see the alarm state and perform any other actions such as Amazon SNS notifications or Auto Scaling policies.

If you are using temporary security credentials granted using AWS STS, you cannot stop or terminate an EC2 instance using alarm actions.

The first time you create an alarm in the AWS Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked role is called AWSServiceRoleForCloudWatchEvents. For more information, see AWS service-linked role.

" + }, + "PutMetricData":{ + "name":"PutMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricDataInput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

  • The SampleCount value of the statistic set is 1 and Min, Max, and Sum are all equal.

  • The Min and Max are equal, and Sum is equal to Min multiplied by SampleCount.

" + }, + "SetAlarmState":{ + "name":"SetAlarmState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetAlarmStateInput"}, + "errors":[ + {"shape":"ResourceNotFound"}, + {"shape":"InvalidFormatFault"} + ], + "documentation":"

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message. The alarm returns to its actual state (often within seconds). Because the alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{ + "shape":"TagResourceOutput", + "resultWrapper":"TagResourceResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Assigns one or more tags (key-value pairs) to the specified CloudWatch resource. Currently, the only CloudWatch resources that can be tagged are alarms.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with an alarm that already has tags. If you specify a new tag key for the alarm, this tag is appended to the list of tags associated with the alarm. If you specify a tag key that is already associated with the alarm, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{ + "shape":"UntagResourceOutput", + "resultWrapper":"UntagResourceResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InternalServiceFault"} + ], + "documentation":"

Removes one or more tags from the specified resource.

" + } + }, + "shapes":{ + "ActionPrefix":{ + "type":"string", + "max":1024, + "min":1 + }, + "ActionsEnabled":{"type":"boolean"}, + "AlarmArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "AlarmDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "AlarmHistoryItem":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

The descriptive name for the alarm.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The time stamp for the alarm history item.

" + }, + "HistoryItemType":{ + "shape":"HistoryItemType", + "documentation":"

The type of alarm history item.

" + }, + "HistorySummary":{ + "shape":"HistorySummary", + "documentation":"

A summary of the alarm history, in text format.

" + }, + "HistoryData":{ + "shape":"HistoryData", + "documentation":"

Data about the alarm, in JSON format.

" + } + }, + "documentation":"

Represents the history of a specific alarm.

" + }, + "AlarmHistoryItems":{ + "type":"list", + "member":{"shape":"AlarmHistoryItem"} + }, + "AlarmName":{ + "type":"string", + "max":255, + "min":1 + }, + "AlarmNamePrefix":{ + "type":"string", + "max":255, + "min":1 + }, + "AlarmNames":{ + "type":"list", + "member":{"shape":"AlarmName"}, + "max":100 + }, + "AmazonResourceName":{ + "type":"string", + "max":1024, + "min":1 + }, + "AnomalyDetector":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric associated with the anomaly detection model.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric associated with the anomaly detection model.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The metric dimensions associated with the anomaly detection model.

" + }, + "Stat":{ + "shape":"Stat", + "documentation":"

The statistic associated with the anomaly detection model.

" + }, + "Configuration":{ + "shape":"AnomalyDetectorConfiguration", + "documentation":"

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model, and the time zone to use for the metric.

" + } + }, + "documentation":"

An anomaly detection model associated with a particular CloudWatch metric athresnd statistic. You can use the model to display a band of expected normal values when the metric is graphed.

" + }, + "AnomalyDetectorConfiguration":{ + "type":"structure", + "members":{ + "ExcludedTimeRanges":{ + "shape":"AnomalyDetectorExcludedTimeRanges", + "documentation":"

An array of time ranges to exclude from use when the anomaly detection model is trained. Use this to make sure that events that could cause unusual values for the metric, such as deployments, aren't used when CloudWatch creates the model.

" + }, + "MetricTimezone":{ + "shape":"AnomalyDetectorMetricTimezone", + "documentation":"

The time zone to use for the metric. This is useful to enable the model to automatically account for daylight savings time changes if the metric is sensitive to such time changes.

To specify a time zone, use the name of the time zone as specified in the standard tz database. For more information, see tz database.

" + } + }, + "documentation":"

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude from use for training the model and the time zone to use for the metric.

" + }, + "AnomalyDetectorExcludedTimeRanges":{ + "type":"list", + "member":{"shape":"Range"} + }, + "AnomalyDetectorMetricTimezone":{"type":"string"}, + "AnomalyDetectors":{ + "type":"list", + "member":{"shape":"AnomalyDetector"} + }, + "AwsQueryErrorMessage":{"type":"string"}, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold", + "LessThanLowerOrGreaterThanUpperThreshold", + "LessThanLowerThreshold", + "GreaterThanUpperThreshold" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

More than one process tried to modify a resource at the same time.

", + "error":{ + "code":"ConcurrentModificationException", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Counts":{ + "type":"list", + "member":{"shape":"DatapointValue"} + }, + "DashboardArn":{"type":"string"}, + "DashboardBody":{"type":"string"}, + "DashboardEntries":{ + "type":"list", + "member":{"shape":"DashboardEntry"} + }, + "DashboardEntry":{ + "type":"structure", + "members":{ + "DashboardName":{ + "shape":"DashboardName", + "documentation":"

The name of the dashboard.

" + }, + "DashboardArn":{ + "shape":"DashboardArn", + "documentation":"

The Amazon Resource Name (ARN) of the dashboard.

" + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

The time stamp of when the dashboard was last modified, either by an API call or through the console. This number is expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" + }, + "Size":{ + "shape":"Size", + "documentation":"

The size of the dashboard, in bytes.

" + } + }, + "documentation":"

Represents a specific dashboard.

" + }, + "DashboardErrorMessage":{"type":"string"}, + "DashboardInvalidInputError":{ + "type":"structure", + "members":{ + "message":{"shape":"DashboardErrorMessage"}, + "dashboardValidationMessages":{"shape":"DashboardValidationMessages"} + }, + "documentation":"

Some part of the dashboard data is invalid.

", + "error":{ + "code":"InvalidParameterInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DashboardName":{"type":"string"}, + "DashboardNamePrefix":{"type":"string"}, + "DashboardNames":{ + "type":"list", + "member":{"shape":"DashboardName"} + }, + "DashboardNotFoundError":{ + "type":"structure", + "members":{ + "message":{"shape":"DashboardErrorMessage"} + }, + "documentation":"

The specified dashboard does not exist.

", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DashboardValidationMessage":{ + "type":"structure", + "members":{ + "DataPath":{ + "shape":"DataPath", + "documentation":"

The data path related to the message.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A message describing the error or warning.

" + } + }, + "documentation":"

An error or warning for the operation.

" + }, + "DashboardValidationMessages":{ + "type":"list", + "member":{"shape":"DashboardValidationMessage"} + }, + "DataPath":{"type":"string"}, + "Datapoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The time stamp used for the data point.

" + }, + "SampleCount":{ + "shape":"DatapointValue", + "documentation":"

The number of metric values that contributed to the aggregate value of this data point.

" + }, + "Average":{ + "shape":"DatapointValue", + "documentation":"

The average of the metric values that correspond to the data point.

" + }, + "Sum":{ + "shape":"DatapointValue", + "documentation":"

The sum of the metric values for the data point.

" + }, + "Minimum":{ + "shape":"DatapointValue", + "documentation":"

The minimum metric value for the data point.

" + }, + "Maximum":{ + "shape":"DatapointValue", + "documentation":"

The maximum metric value for the data point.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

The standard unit for the data point.

" + }, + "ExtendedStatistics":{ + "shape":"DatapointValueMap", + "documentation":"

The percentile statistic for the data point.

" + } + }, + "documentation":"

Encapsulates the statistical data that CloudWatch computes from metric data.

", + "xmlOrder":[ + "Timestamp", + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum", + "Unit", + "ExtendedStatistics" + ] + }, + "DatapointValue":{"type":"double"}, + "DatapointValueMap":{ + "type":"map", + "key":{"shape":"ExtendedStatistic"}, + "value":{"shape":"DatapointValue"} + }, + "DatapointValues":{ + "type":"list", + "member":{"shape":"DatapointValue"} + }, + "Datapoints":{ + "type":"list", + "member":{"shape":"Datapoint"} + }, + "DatapointsToAlarm":{ + "type":"integer", + "min":1 + }, + "DeleteAlarmsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

The alarms to be deleted.

" + } + } + }, + "DeleteAnomalyDetectorInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricName", + "Stat" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace associated with the anomaly detection model to delete.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The metric name associated with the anomaly detection model to delete.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The metric dimensions associated with the anomaly detection model to delete.

" + }, + "Stat":{ + "shape":"Stat", + "documentation":"

The statistic associated with the anomaly detection model to delete.

" + } + } + }, + "DeleteAnomalyDetectorOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteDashboardsInput":{ + "type":"structure", + "required":["DashboardNames"], + "members":{ + "DashboardNames":{ + "shape":"DashboardNames", + "documentation":"

The dashboards to be deleted. This parameter is required.

" + } + } + }, + "DeleteDashboardsOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeAlarmHistoryInput":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

The name of the alarm.

" + }, + "HistoryItemType":{ + "shape":"HistoryItemType", + "documentation":"

The type of alarm histories to retrieve.

" + }, + "StartDate":{ + "shape":"Timestamp", + "documentation":"

The starting date to retrieve alarm history.

" + }, + "EndDate":{ + "shape":"Timestamp", + "documentation":"

The ending date to retrieve alarm history.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of alarm history records to retrieve.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + } + } + }, + "DescribeAlarmHistoryOutput":{ + "type":"structure", + "members":{ + "AlarmHistoryItems":{ + "shape":"AlarmHistoryItems", + "documentation":"

The alarm histories, in JSON format.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that marks the start of the next batch of returned results.

" + } + } + }, + "DescribeAlarmsForMetricInput":{ + "type":"structure", + "required":[ + "MetricName", + "Namespace" + ], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric.

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

The statistic for the metric, other than percentiles. For percentile statistics, use ExtendedStatistics.

" + }, + "ExtendedStatistic":{ + "shape":"ExtendedStatistic", + "documentation":"

The percentile statistic for the metric. Specify a value between p0.0 and p100.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the call to succeed.

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The period, in seconds, over which the statistic is applied.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

The unit for the metric.

" + } + } + }, + "DescribeAlarmsForMetricOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{ + "shape":"MetricAlarms", + "documentation":"

The information for each alarm with the specified metric.

" + } + } + }, + "DescribeAlarmsInput":{ + "type":"structure", + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

The names of the alarms.

" + }, + "AlarmNamePrefix":{ + "shape":"AlarmNamePrefix", + "documentation":"

The alarm name prefix. If this parameter is specified, you cannot specify AlarmNames.

" + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

The state value to be used in matching alarms.

" + }, + "ActionPrefix":{ + "shape":"ActionPrefix", + "documentation":"

The action name prefix.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

The maximum number of alarm descriptions to retrieve.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + } + } + }, + "DescribeAlarmsOutput":{ + "type":"structure", + "members":{ + "MetricAlarms":{ + "shape":"MetricAlarms", + "documentation":"

The information for the specified alarms.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that marks the start of the next batch of returned results.

" + } + } + }, + "DescribeAnomalyDetectorsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use the token returned by the previous operation to request the next page of results.

" + }, + "MaxResults":{ + "shape":"MaxReturnedResultsCount", + "documentation":"

The maximum number of results to return in one operation. The maximum value you can specify is 10.

To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

Limits the results to only the anomaly detection models that are associated with the specified namespace.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

Limits the results to only the anomaly detection models that are associated with the specified metric name. If there are multiple metrics with this name in different namespaces that have anomaly detection models, they're all returned.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

Limits the results to only the anomaly detection models that are associated with the specified metric dimensions. If there are multiple metrics that have these dimensions and have anomaly detection models associated, they're all returned.

" + } + } + }, + "DescribeAnomalyDetectorsOutput":{ + "type":"structure", + "members":{ + "AnomalyDetectors":{ + "shape":"AnomalyDetectors", + "documentation":"

The list of anomaly detection models returned by the operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"DimensionName", + "documentation":"

The name of the dimension.

" + }, + "Value":{ + "shape":"DimensionValue", + "documentation":"

The value representing the dimension measurement.

" + } + }, + "documentation":"

Expands the identity of a metric.

", + "xmlOrder":[ + "Name", + "Value" + ] + }, + "DimensionFilter":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DimensionName", + "documentation":"

The dimension name to be matched.

" + }, + "Value":{ + "shape":"DimensionValue", + "documentation":"

The value of the dimension to be matched.

" + } + }, + "documentation":"

Represents filters for a dimension.

" + }, + "DimensionFilters":{ + "type":"list", + "member":{"shape":"DimensionFilter"}, + "max":10 + }, + "DimensionName":{ + "type":"string", + "max":255, + "min":1 + }, + "DimensionValue":{ + "type":"string", + "max":255, + "min":1 + }, + "Dimensions":{ + "type":"list", + "member":{"shape":"Dimension"}, + "max":10 + }, + "DisableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

The names of the alarms.

" + } + } + }, + "EnableAlarmActionsInput":{ + "type":"structure", + "required":["AlarmNames"], + "members":{ + "AlarmNames":{ + "shape":"AlarmNames", + "documentation":"

The names of the alarms.

" + } + } + }, + "ErrorMessage":{ + "type":"string", + "max":255, + "min":1 + }, + "EvaluateLowSampleCountPercentile":{ + "type":"string", + "max":255, + "min":1 + }, + "EvaluationPeriods":{ + "type":"integer", + "min":1 + }, + "ExtendedStatistic":{ + "type":"string", + "pattern":"p(\\d{1,2}(\\.\\d{0,2})?|100)" + }, + "ExtendedStatistics":{ + "type":"list", + "member":{"shape":"ExtendedStatistic"}, + "max":10, + "min":1 + }, + "FaultDescription":{"type":"string"}, + "GetDashboardInput":{ + "type":"structure", + "required":["DashboardName"], + "members":{ + "DashboardName":{ + "shape":"DashboardName", + "documentation":"

The name of the dashboard to be described.

" + } + } + }, + "GetDashboardOutput":{ + "type":"structure", + "members":{ + "DashboardArn":{ + "shape":"DashboardArn", + "documentation":"

The Amazon Resource Name (ARN) of the dashboard.

" + }, + "DashboardBody":{ + "shape":"DashboardBody", + "documentation":"

The detailed information about the dashboard, including what widgets are included and their location on the dashboard. For more information about the DashboardBody syntax, see CloudWatch-Dashboard-Body-Structure.

" + }, + "DashboardName":{ + "shape":"DashboardName", + "documentation":"

The name of the dashboard.

" + } + } + }, + "GetMetricDataInput":{ + "type":"structure", + "required":[ + "MetricDataQueries", + "StartTime", + "EndTime" + ], + "members":{ + "MetricDataQueries":{ + "shape":"MetricDataQueries", + "documentation":"

The metric queries to be returned. A single GetMetricData call can include as many as 100 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

The time stamp indicating the earliest data to be returned.

The value specified is inclusive; results include data points with the specified time stamp.

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as StartTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the StartTime.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time stamp indicating the latest data to be returned.

The value specified is exclusive; results include data points up to the specified time stamp.

For better performance, specify StartTime and EndTime values that align with the value of the metric's Period and sync up with the beginning and end of an hour. For example, if the Period of a metric is 5 minutes, specifying 12:05 or 12:30 as EndTime can get a faster response from CloudWatch than setting 12:07 or 12:29 as the EndTime.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Include this value, if it was returned by the previous call, to get the next set of data points.

" + }, + "ScanBy":{ + "shape":"ScanBy", + "documentation":"

The order in which data points should be returned. TimestampDescending returns the newest data first and paginates when the MaxDatapoints limit is reached. TimestampAscending returns the oldest data first and paginates when the MaxDatapoints limit is reached.

" + }, + "MaxDatapoints":{ + "shape":"GetMetricDataMaxDatapoints", + "documentation":"

The maximum number of data points the request should return before paginating. If you omit this, the default of 100,800 is used.

" + } + } + }, + "GetMetricDataMaxDatapoints":{"type":"integer"}, + "GetMetricDataOutput":{ + "type":"structure", + "members":{ + "MetricDataResults":{ + "shape":"MetricDataResults", + "documentation":"

The metrics that are returned, including the metric name, namespace, and dimensions.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that marks the next batch of returned results.

" + }, + "Messages":{ + "shape":"MetricDataResultMessages", + "documentation":"

Contains a message about this GetMetricData operation, if the operation results in such a message. An example of a message that may be returned is Maximum number of allowed metrics exceeded. If there is a message, as much of the operation as possible is still executed.

A message appears here only if it is related to the global GetMetricData operation. Any message about a specific metric returned by the operation appears in the MetricDataResult object returned for that metric.

" + } + } + }, + "GetMetricStatisticsInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricName", + "StartTime", + "EndTime", + "Period" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric, with or without spaces.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric, with or without spaces.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. If a specific combination of dimensions was not published, you can't retrieve statistics for it. You must specify the same dimensions that were used when the metrics were created. For an example, see Dimension Combinations in the Amazon CloudWatch User Guide. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

The time stamp that determines the first data point to return. Start times are evaluated relative to the time that CloudWatch receives the request.

The value specified is inclusive; results include data points with the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-03T23:00:00Z).

CloudWatch rounds the specified time stamp as follows:

  • Start time less than 15 days ago - Round down to the nearest whole minute. For example, 12:32:34 is rounded down to 12:32:00.

  • Start time between 15 and 63 days ago - Round down to the nearest 5-minute clock interval. For example, 12:32:34 is rounded down to 12:30:00.

  • Start time greater than 63 days ago - Round down to the nearest 1-hour clock interval. For example, 12:32:34 is rounded down to 12:00:00.

If you set Period to 5, 10, or 30, the start time of your request is rounded down to the nearest time that corresponds to even 5-, 10-, or 30-second divisions of a minute. For example, if you make a query at (HH:mm:ss) 01:05:23 for the previous 10-second period, the start time of your request is rounded down and you receive data from 01:05:10 to 01:05:20. If you make a query at 15:07:17 for the previous 5 minutes of data, using a period of 5 seconds, you receive data timestamped between 15:02:15 and 15:07:15.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time stamp that determines the last data point to return.

The value specified is exclusive; results include data points up to the specified time stamp. The time stamp must be in ISO 8601 UTC format (for example, 2016-10-10T23:00:00Z).

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

" + }, + "Statistics":{ + "shape":"Statistics", + "documentation":"

The metric statistics, other than percentile. For percentile statistics, use ExtendedStatistics. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both.

" + }, + "ExtendedStatistics":{ + "shape":"ExtendedStatistics", + "documentation":"

The percentile statistics. Specify values between p0.0 and p100. When calling GetMetricStatistics, you must specify either Statistics or ExtendedStatistics, but not both. Percentile statistics are not available for metrics when any of the metric values are negative numbers.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

The unit for a given metric. If you omit Unit, all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + } + } + }, + "GetMetricStatisticsOutput":{ + "type":"structure", + "members":{ + "Label":{ + "shape":"MetricLabel", + "documentation":"

A label for the specified metric.

" + }, + "Datapoints":{ + "shape":"Datapoints", + "documentation":"

The data points for the specified metric.

" + } + } + }, + "GetMetricWidgetImageInput":{ + "type":"structure", + "required":["MetricWidget"], + "members":{ + "MetricWidget":{ + "shape":"MetricWidget", + "documentation":"

A JSON string that defines the bitmap graph to be retrieved. The string includes the metrics to include in the graph, statistics, annotations, title, axis limits, and so on. You can include only one MetricWidget parameter in each GetMetricWidgetImage call.

For more information about the syntax of MetricWidget see CloudWatch-Metric-Widget-Structure.

If any metric on the graph could not load all the requested data points, an orange triangle with an exclamation point appears next to the graph legend.

" + }, + "OutputFormat":{ + "shape":"OutputFormat", + "documentation":"

The format of the resulting image. Only PNG images are supported.

The default is png. If you specify png, the API returns an HTTP response with the content-type set to text/xml. The image data is in a MetricWidgetImage field. For example:

<GetMetricWidgetImageResponse xmlns=<URLstring>>

<GetMetricWidgetImageResult>

<MetricWidgetImage>

iVBORw0KGgoAAAANSUhEUgAAAlgAAAGQEAYAAAAip...

</MetricWidgetImage>

</GetMetricWidgetImageResult>

<ResponseMetadata>

<RequestId>6f0d4192-4d42-11e8-82c1-f539a07e0e3b</RequestId>

</ResponseMetadata>

</GetMetricWidgetImageResponse>

The image/png setting is intended only for custom HTTP requests. For most use cases, and all actions using an AWS SDK, you should use png. If you specify image/png, the HTTP response has a content-type set to image/png, and the body of the response is a PNG image.

" + } + } + }, + "GetMetricWidgetImageOutput":{ + "type":"structure", + "members":{ + "MetricWidgetImage":{ + "shape":"MetricWidgetImage", + "documentation":"

The image of the graph, in the output format specified.

" + } + } + }, + "HistoryData":{ + "type":"string", + "max":4095, + "min":1 + }, + "HistoryItemType":{ + "type":"string", + "enum":[ + "ConfigurationUpdate", + "StateUpdate", + "Action" + ] + }, + "HistorySummary":{ + "type":"string", + "max":255, + "min":1 + }, + "InternalServiceFault":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"FaultDescription", + "documentation":"

" + } + }, + "documentation":"

Request processing has failed due to some unknown error, exception, or failure.

", + "error":{ + "code":"InternalServiceError", + "httpStatusCode":500 + }, + "exception":true, + "xmlOrder":["Message"] + }, + "InvalidFormatFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Data was not syntactically valid JSON.

", + "error":{ + "code":"InvalidFormat", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

The next token specified is invalid.

", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Parameters were used together that cannot be used together.

", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "synthetic":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "documentation":"

The value of an input parameter is bad or out-of-range.

", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "synthetic":true + }, + "LastModified":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The operation exceeded one or more limits.

", + "error":{ + "code":"LimitExceededException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

The quota for alarms for this customer has already been reached.

", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ListDashboardsInput":{ + "type":"structure", + "members":{ + "DashboardNamePrefix":{ + "shape":"DashboardNamePrefix", + "documentation":"

If you specify this parameter, only the dashboards with names starting with the specified string are listed. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \".\", \"-\", and \"_\".

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + } + } + }, + "ListDashboardsOutput":{ + "type":"structure", + "members":{ + "DashboardEntries":{ + "shape":"DashboardEntries", + "documentation":"

The list of matching dashboards.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that marks the start of the next batch of returned results.

" + } + } + }, + "ListMetricsInput":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace to filter against.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric to filter against.

" + }, + "Dimensions":{ + "shape":"DimensionFilters", + "documentation":"

The dimensions to filter against.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + } + } + }, + "ListMetricsOutput":{ + "type":"structure", + "members":{ + "Metrics":{ + "shape":"Metrics", + "documentation":"

The metrics.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that marks the start of the next batch of returned results.

" + } + }, + "xmlOrder":[ + "Metrics", + "NextToken" + ] + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the CloudWatch resource that you want to view tags for. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The list of tag keys and values associated with the resource you specified.

" + } + } + }, + "MaxRecords":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxReturnedResultsCount":{ + "type":"integer", + "min":1 + }, + "Message":{"type":"string"}, + "MessageData":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"MessageDataCode", + "documentation":"

The error code or status code associated with the message.

" + }, + "Value":{ + "shape":"MessageDataValue", + "documentation":"

The message text.

" + } + }, + "documentation":"

A message returned by the GetMetricDataAPI, including a code and a description.

" + }, + "MessageDataCode":{"type":"string"}, + "MessageDataValue":{"type":"string"}, + "Metric":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric. This is a required field.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions for the metric.

" + } + }, + "documentation":"

Represents a specific metric.

", + "xmlOrder":[ + "Namespace", + "MetricName", + "Dimensions" + ] + }, + "MetricAlarm":{ + "type":"structure", + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

The name of the alarm.

" + }, + "AlarmArn":{ + "shape":"AlarmArn", + "documentation":"

The Amazon Resource Name (ARN) of the alarm.

" + }, + "AlarmDescription":{ + "shape":"AlarmDescription", + "documentation":"

The description of the alarm.

" + }, + "AlarmConfigurationUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time stamp of the last update to the alarm configuration.

" + }, + "ActionsEnabled":{ + "shape":"ActionsEnabled", + "documentation":"

Indicates whether actions should be executed during any changes to the alarm state.

" + }, + "OKActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" + }, + "AlarmActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" + }, + "InsufficientDataActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

" + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

The state value for the alarm.

" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

An explanation for the alarm state, in text format.

" + }, + "StateReasonData":{ + "shape":"StateReasonData", + "documentation":"

An explanation for the alarm state, in JSON format.

" + }, + "StateUpdatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time stamp of the last update to the alarm state.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric associated with the alarm.

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

" + }, + "ExtendedStatistic":{ + "shape":"ExtendedStatistic", + "documentation":"

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions for the metric associated with the alarm.

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The period, in seconds, over which the statistic is applied.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

The unit of the metric associated with the alarm.

" + }, + "EvaluationPeriods":{ + "shape":"EvaluationPeriods", + "documentation":"

The number of periods over which data is compared to the specified threshold.

" + }, + "DatapointsToAlarm":{ + "shape":"DatapointsToAlarm", + "documentation":"

The number of datapoints that must be breaching to trigger the alarm.

" + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

The value to compare with the specified statistic.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

" + }, + "TreatMissingData":{ + "shape":"TreatMissingData", + "documentation":"

Sets how this alarm is to handle missing data points. If this parameter is omitted, the default behavior of missing is used.

" + }, + "EvaluateLowSampleCountPercentile":{ + "shape":"EvaluateLowSampleCountPercentile", + "documentation":"

Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.

" + }, + "Metrics":{ + "shape":"MetricDataQueries", + "documentation":"

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnValue set to true.

" + }, + "ThresholdMetricId":{ + "shape":"MetricId", + "documentation":"

In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.

" + } + }, + "documentation":"

Represents an alarm.

", + "xmlOrder":[ + "AlarmName", + "AlarmArn", + "AlarmDescription", + "AlarmConfigurationUpdatedTimestamp", + "ActionsEnabled", + "OKActions", + "AlarmActions", + "InsufficientDataActions", + "StateValue", + "StateReason", + "StateReasonData", + "StateUpdatedTimestamp", + "MetricName", + "Namespace", + "Statistic", + "Dimensions", + "Period", + "Unit", + "EvaluationPeriods", + "Threshold", + "ComparisonOperator", + "ExtendedStatistic", + "TreatMissingData", + "EvaluateLowSampleCountPercentile", + "DatapointsToAlarm", + "Metrics", + "ThresholdMetricId" + ] + }, + "MetricAlarms":{ + "type":"list", + "member":{"shape":"MetricAlarm"} + }, + "MetricData":{ + "type":"list", + "member":{"shape":"MetricDatum"} + }, + "MetricDataQueries":{ + "type":"list", + "member":{"shape":"MetricDataQuery"} + }, + "MetricDataQuery":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"MetricId", + "documentation":"

A short name used to tie this object to the results in the response. This name must be unique within a single call to GetMetricData. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

" + }, + "MetricStat":{ + "shape":"MetricStat", + "documentation":"

The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

Within one MetricDataQuery object, you must specify either Expression or MetricStat but not both.

" + }, + "Expression":{ + "shape":"MetricExpression", + "documentation":"

The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Within each MetricDataQuery object, you must specify either Expression or MetricStat but not both.

" + }, + "Label":{ + "shape":"MetricLabel", + "documentation":"

A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CloudWatch dashboard widget, the label is shown. If Label is omitted, CloudWatch generates a default.

" + }, + "ReturnData":{ + "shape":"ReturnData", + "documentation":"

When used in GetMetricData, this option indicates whether to return the timestamps and raw data values of this metric. If you are performing this call just to do math expressions and do not also need the raw data returned, you can specify False. If you omit this, the default of True is used.

When used in PutMetricAlarm, specify True for the one expression result to use as the alarm. For all other metrics and expressions in the same PutMetricAlarm operation, specify ReturnData as False.

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData operation that includes a StorageResolution of 1 second.

Use this field only when you are performing a GetMetricData operation, and only when you are specifying the Expression field. Do not use this field with a PutMetricAlarm operation or when you are specifying a MetricStat in a GetMetricData operation.

" + } + }, + "documentation":"

This structure is used in both GetMetricData and PutMetricAlarm. The supported use of this structure is different for those two operations.

When used in GetMetricData, it indicates the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. A single GetMetricData call can include up to 100 MetricDataQuery structures.

When used in PutMetricAlarm, it enables you to create an alarm based on a metric math expression. Each MetricDataQuery in the array specifies either a metric to retrieve, or a math expression to be performed on retrieved metrics. A single PutMetricAlarm call can include up to 20 MetricDataQuery structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat parameter to retrieve a metric, and as many as 10 structures that contain the Expression parameter to perform a math expression. Of those Expression structures, one must have True as the value for ReturnData. The result of this expression is the value the alarm watches.

Any expression used in a PutMetricAlarm operation must return a single time series. For more information, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide.

Some of the parameters of this structure also have different uses whether you are using this structure in a GetMetricData operation or a PutMetricAlarm operation. These differences are explained in the following parameter list.

" + }, + "MetricDataResult":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"MetricId", + "documentation":"

The short name you specified to represent this metric.

" + }, + "Label":{ + "shape":"MetricLabel", + "documentation":"

The human-readable label associated with the data.

" + }, + "Timestamps":{ + "shape":"Timestamps", + "documentation":"

The timestamps for the data points, formatted in Unix timestamp format. The number of timestamps always matches the number of values and the value for Timestamps[x] is Values[x].

" + }, + "Values":{ + "shape":"DatapointValues", + "documentation":"

The data points for the metric corresponding to Timestamps. The number of values always matches the number of timestamps and the timestamp for Values[x] is Timestamps[x].

" + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"

The status of the returned data. Complete indicates that all data points in the requested time range were returned. PartialData means that an incomplete set of data points were returned. You can use the NextToken value that was returned and repeat your request to get more data points. NextToken is not returned if you are performing a math expression. InternalError indicates that an error occurred. Retry your request using NextToken, if present.

" + }, + "Messages":{ + "shape":"MetricDataResultMessages", + "documentation":"

A list of messages with additional information about the data returned.

" + } + }, + "documentation":"

A GetMetricData call returns an array of MetricDataResult structures. Each of these structures includes the data points for that metric, along with the timestamps of those data points and other identifying information.

" + }, + "MetricDataResultMessages":{ + "type":"list", + "member":{"shape":"MessageData"} + }, + "MetricDataResults":{ + "type":"list", + "member":{"shape":"MetricDataResult"} + }, + "MetricDatum":{ + "type":"structure", + "required":["MetricName"], + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions associated with the metric.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The time the metric data was received, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

" + }, + "Value":{ + "shape":"DatapointValue", + "documentation":"

The value for the metric.

Although the parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

" + }, + "StatisticValues":{ + "shape":"StatisticSet", + "documentation":"

The statistical values for the metric.

" + }, + "Values":{ + "shape":"Values", + "documentation":"

Array of numbers representing the values for the metric during the period. Each unique value is listed just once in this array, and the corresponding number in the Counts array specifies the number of times that value occurred during the period. You can include up to 150 unique values in each PutMetricData action that specifies a Values array.

Although the Values array accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

" + }, + "Counts":{ + "shape":"Counts", + "documentation":"

Array of numbers that is used along with the Values array. Each number in the Count array is the number of times the corresponding value in the Values array occurred during the period.

If you omit the Counts array, the default of 1 is used as the value for each count. If you include a Counts array, it must include the same amount of values as the Values array.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, this displays the unit that is used for the metric.

" + }, + "StorageResolution":{ + "shape":"StorageResolution", + "documentation":"

Valid values are 1 and 60. Setting this to 1 specifies this metric as a high-resolution metric, so that CloudWatch stores the metric with sub-minute resolution down to one second. Setting this to 60 specifies this metric as a regular-resolution metric, which CloudWatch stores at 1-minute resolution. Currently, high resolution is available only for custom metrics. For more information about high-resolution metrics, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

This field is optional, if you do not specify it the default of 60 is used.

" + } + }, + "documentation":"

Encapsulates the information sent to either create a metric or add new values to be aggregated into an existing metric.

" + }, + "MetricExpression":{ + "type":"string", + "max":1024, + "min":1 + }, + "MetricId":{ + "type":"string", + "max":255, + "min":1 + }, + "MetricLabel":{"type":"string"}, + "MetricName":{ + "type":"string", + "max":255, + "min":1 + }, + "MetricStat":{ + "type":"structure", + "required":[ + "Metric", + "Period", + "Stat" + ], + "members":{ + "Metric":{ + "shape":"Metric", + "documentation":"

The metric to return, including the metric name, namespace, and dimensions.

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a PutMetricData call that includes a StorageResolution of 1 second.

If the StartTime parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:

  • Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).

  • Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).

  • Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).

" + }, + "Stat":{ + "shape":"Stat", + "documentation":"

The statistic to return. It can include any CloudWatch statistic or extended statistic.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

When you are using a Put operation, this defines what unit you want to use when storing the metric.

In a Get operation, if you omit Unit then all data that was collected with any unit is returned, along with the corresponding units that were specified when the data was reported to CloudWatch. If you specify a unit, the operation returns only data data that was collected with that unit specified. If you specify a unit that does not match the data collected, the results of the operation are null. CloudWatch does not perform unit conversions.

" + } + }, + "documentation":"

This structure defines the metric to be returned, along with the statistics, period, and units.

" + }, + "MetricWidget":{"type":"string"}, + "MetricWidgetImage":{"type":"blob"}, + "Metrics":{ + "type":"list", + "member":{"shape":"Metric"} + }, + "MissingRequiredParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

" + } + }, + "documentation":"

An input parameter that is required is missing.

", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "synthetic":true + }, + "Namespace":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[^:].*" + }, + "NextToken":{"type":"string"}, + "OutputFormat":{"type":"string"}, + "Period":{ + "type":"integer", + "min":1 + }, + "PutAnomalyDetectorInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricName", + "Stat" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace of the metric to create the anomaly detection model for.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric to create the anomaly detection model for.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The metric dimensions to create the anomaly detection model for.

" + }, + "Stat":{ + "shape":"Stat", + "documentation":"

The statistic to use for the metric and the anomaly detection model.

" + }, + "Configuration":{ + "shape":"AnomalyDetectorConfiguration", + "documentation":"

The configuration specifies details about how the anomaly detection model is to be trained, including time ranges to exclude when training and updating the model. You can specify as many as 10 time ranges.

The configuration can also include the time zone to use for the metric.

You can in

" + } + } + }, + "PutAnomalyDetectorOutput":{ + "type":"structure", + "members":{ + } + }, + "PutDashboardInput":{ + "type":"structure", + "required":[ + "DashboardName", + "DashboardBody" + ], + "members":{ + "DashboardName":{ + "shape":"DashboardName", + "documentation":"

The name of the dashboard. If a dashboard with this name already exists, this call modifies that dashboard, replacing its current contents. Otherwise, a new dashboard is created. The maximum length is 255, and valid characters are A-Z, a-z, 0-9, \"-\", and \"_\". This parameter is required.

" + }, + "DashboardBody":{ + "shape":"DashboardBody", + "documentation":"

The detailed information about the dashboard in JSON format, including the widgets to include and their location on the dashboard. This parameter is required.

For more information about the syntax, see CloudWatch-Dashboard-Body-Structure.

" + } + } + }, + "PutDashboardOutput":{ + "type":"structure", + "members":{ + "DashboardValidationMessages":{ + "shape":"DashboardValidationMessages", + "documentation":"

If the input for PutDashboard was correct and the dashboard was successfully created or modified, this result is empty.

If this result includes only warning messages, then the input was valid enough for the dashboard to be created or modified, but some elements of the dashboard may not render.

If this result includes error messages, the input was not valid and the operation failed.

" + } + } + }, + "PutMetricAlarmInput":{ + "type":"structure", + "required":[ + "AlarmName", + "EvaluationPeriods", + "ComparisonOperator" + ], + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

The name for the alarm. This name must be unique within your AWS account.

" + }, + "AlarmDescription":{ + "shape":"AlarmDescription", + "documentation":"

The description for the alarm.

" + }, + "ActionsEnabled":{ + "shape":"ActionsEnabled", + "documentation":"

Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

" + }, + "OKActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" + }, + "AlarmActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" + }, + "InsufficientDataActions":{ + "shape":"ResourceList", + "documentation":"

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover | arn:aws:automate:region:ec2:reboot | arn:aws:sns:region:account-id:sns-topic-name | arn:aws:autoscaling:region:account-id:scalingPolicy:policy-idautoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

Valid Values (for use with IAM roles): >arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace for the metric associated specified in MetricName.

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

" + }, + "ExtendedStatistic":{ + "shape":"ExtendedStatistic", + "documentation":"

The percentile statistic for the metric specified in MetricName. Specify a value between p0.0 and p100. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

" + }, + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions for the metric specified in MetricName.

" + }, + "Period":{ + "shape":"Period", + "documentation":"

The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 30, and any multiple of 60.

Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.

Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10 or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm may often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

An alarm's total current evaluation period can be no longer than one day, so Period multiplied by EvaluationPeriods cannot be more than 86,400 seconds.

" + }, + "Unit":{ + "shape":"StandardUnit", + "documentation":"

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually metrics are published with only one unit, so the alarm will work as intended.

However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and will behave un-predictably.

We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

" + }, + "EvaluationPeriods":{ + "shape":"EvaluationPeriods", + "documentation":"

The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an \"M out of N\" alarm, this value is the N.

An alarm's total current evaluation period can be no longer than one day, so this number multiplied by Period cannot be more than 86,400 seconds.

" + }, + "DatapointsToAlarm":{ + "shape":"DatapointsToAlarm", + "documentation":"

The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an \"M out of N\" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

" + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

The value against which the specified statistic is compared.

This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

" + }, + "TreatMissingData":{ + "shape":"TreatMissingData", + "documentation":"

Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

Valid Values: breaching | notBreaching | ignore | missing

" + }, + "EvaluateLowSampleCountPercentile":{ + "shape":"EvaluateLowSampleCountPercentile", + "documentation":"

Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

Valid Values: evaluate | ignore

" + }, + "Metrics":{ + "shape":"MetricDataQueries", + "documentation":"

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

Each item in the Metrics array either retrieves a metric or performs a math expression.

One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnValue to true for this object in the array. For more information, see MetricDataQuery.

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values.

" + }, + "ThresholdMetricId":{ + "shape":"MetricId", + "documentation":"

If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.

For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.

If your alarm uses this parameter, it cannot have Auto Scaling actions.

" + } + } + }, + "PutMetricDataInput":{ + "type":"structure", + "required":[ + "Namespace", + "MetricData" + ], + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

The namespace for the metric data.

To avoid conflicts with AWS service namespaces, you should not specify a namespace that begins with AWS/

" + }, + "MetricData":{ + "shape":"MetricData", + "documentation":"

The data for the metric. The array can include no more than 20 metrics per call.

" + } + } + }, + "Range":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the range to exclude. The format is yyyy-MM-dd'T'HH:mm:ss. For example, 2019-07-01T23:59:59.

" + } + }, + "documentation":"

Specifies one range of days or times to exclude from use for training an anomaly detection model.

", + "xmlOrder":[ + "StartTime", + "EndTime" + ] + }, + "ResourceId":{"type":"string"}, + "ResourceList":{ + "type":"list", + "member":{"shape":"ResourceName"}, + "max":5 + }, + "ResourceName":{ + "type":"string", + "max":1024, + "min":1 + }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

The named resource does not exist.

", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "ResourceType":{"shape":"ResourceType"}, + "ResourceId":{"shape":"ResourceId"} + }, + "documentation":"

The named resource does not exist.

", + "error":{ + "code":"ResourceNotFoundException", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourceType":{"type":"string"}, + "ReturnData":{"type":"boolean"}, + "ScanBy":{ + "type":"string", + "enum":[ + "TimestampDescending", + "TimestampAscending" + ] + }, + "SetAlarmStateInput":{ + "type":"structure", + "required":[ + "AlarmName", + "StateValue", + "StateReason" + ], + "members":{ + "AlarmName":{ + "shape":"AlarmName", + "documentation":"

The name for the alarm. This name must be unique within the AWS account. The maximum length is 255 characters.

" + }, + "StateValue":{ + "shape":"StateValue", + "documentation":"

The value of the state.

" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason that this alarm is set to this specific state, in text format.

" + }, + "StateReasonData":{ + "shape":"StateReasonData", + "documentation":"

The reason that this alarm is set to this specific state, in JSON format.

" + } + } + }, + "Size":{"type":"long"}, + "StandardUnit":{ + "type":"string", + "enum":[ + "Seconds", + "Microseconds", + "Milliseconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ] + }, + "Stat":{"type":"string"}, + "StateReason":{ + "type":"string", + "max":1023, + "min":0 + }, + "StateReasonData":{ + "type":"string", + "max":4000, + "min":0 + }, + "StateValue":{ + "type":"string", + "enum":[ + "OK", + "ALARM", + "INSUFFICIENT_DATA" + ] + }, + "Statistic":{ + "type":"string", + "enum":[ + "SampleCount", + "Average", + "Sum", + "Minimum", + "Maximum" + ] + }, + "StatisticSet":{ + "type":"structure", + "required":[ + "SampleCount", + "Sum", + "Minimum", + "Maximum" + ], + "members":{ + "SampleCount":{ + "shape":"DatapointValue", + "documentation":"

The number of samples used for the statistic set.

" + }, + "Sum":{ + "shape":"DatapointValue", + "documentation":"

The sum of values for the sample set.

" + }, + "Minimum":{ + "shape":"DatapointValue", + "documentation":"

The minimum value of the sample set.

" + }, + "Maximum":{ + "shape":"DatapointValue", + "documentation":"

The maximum value of the sample set.

" + } + }, + "documentation":"

Represents a set of statistics that describes a specific metric.

" + }, + "Statistics":{ + "type":"list", + "member":{"shape":"Statistic"}, + "max":5, + "min":1 + }, + "StatusCode":{ + "type":"string", + "enum":[ + "Complete", + "InternalError", + "PartialData" + ] + }, + "StorageResolution":{ + "type":"integer", + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value for the specified tag key.

" + } + }, + "documentation":"

A key-value pair associated with a CloudWatch resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the CloudWatch alarm that you're adding tags to. The ARN format is arn:aws:cloudwatch:Region:account-id:alarm:alarm-name

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The list of key-value pairs to associate with the alarm.

" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Threshold":{"type":"double"}, + "Timestamp":{"type":"timestamp"}, + "Timestamps":{ + "type":"list", + "member":{"shape":"Timestamp"} + }, + "TreatMissingData":{ + "type":"string", + "max":255, + "min":1 + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the CloudWatch resource that you're removing tags from. For more information on ARN format, see Example ARNs in the Amazon Web Services General Reference.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The list of tag keys to remove from the resource.

" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "Values":{ + "type":"list", + "member":{"shape":"DatapointValue"} + } + }, + "documentation":"

Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.

CloudWatch alarms send notifications or automatically change the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon EC2 instances. Then, use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.

In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.

" +} diff --git a/aws/dist/botocore/data/cloudwatch/2010-08-01/waiters-2.json b/aws/dist/botocore/data/cloudwatch/2010-08-01/waiters-2.json new file mode 100644 index 00000000..cb0cf0bf --- /dev/null +++ b/aws/dist/botocore/data/cloudwatch/2010-08-01/waiters-2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "AlarmExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeAlarms", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(MetricAlarms[]) > `0`", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/codebuild/2016-10-06/examples-1.json b/aws/dist/botocore/data/codebuild/2016-10-06/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/codebuild/2016-10-06/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/codebuild/2016-10-06/paginators-1.json b/aws/dist/botocore/data/codebuild/2016-10-06/paginators-1.json new file mode 100644 index 00000000..3ac2ff1f --- /dev/null +++ b/aws/dist/botocore/data/codebuild/2016-10-06/paginators-1.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListBuilds": { + "output_token": "nextToken", + "input_token": "nextToken", + "result_key": "ids" + }, + "ListProjects": { + "output_token": "nextToken", + "input_token": "nextToken", + "result_key": "projects" + }, + "ListBuildsForProject": { + "output_token": "nextToken", + "input_token": "nextToken", + "result_key": "ids" + } + } +} diff --git a/aws/dist/botocore/data/codebuild/2016-10-06/service-2.json b/aws/dist/botocore/data/codebuild/2016-10-06/service-2.json new file mode 100644 index 00000000..dbe7e2ca --- /dev/null +++ b/aws/dist/botocore/data/codebuild/2016-10-06/service-2.json @@ -0,0 +1,2134 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-10-06", + "endpointPrefix":"codebuild", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS CodeBuild", + "serviceId":"CodeBuild", + "signatureVersion":"v4", + "targetPrefix":"CodeBuild_20161006", + "uid":"codebuild-2016-10-06" + }, + "operations":{ + "BatchDeleteBuilds":{ + "name":"BatchDeleteBuilds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteBuildsInput"}, + "output":{"shape":"BatchDeleteBuildsOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Deletes one or more builds.

" + }, + "BatchGetBuilds":{ + "name":"BatchGetBuilds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetBuildsInput"}, + "output":{"shape":"BatchGetBuildsOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets information about builds.

" + }, + "BatchGetProjects":{ + "name":"BatchGetProjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetProjectsInput"}, + "output":{"shape":"BatchGetProjectsOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets information about build projects.

" + }, + "CreateProject":{ + "name":"CreateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProjectInput"}, + "output":{"shape":"CreateProjectOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccountLimitExceededException"} + ], + "documentation":"

Creates a build project.

" + }, + "CreateWebhook":{ + "name":"CreateWebhook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWebhookInput"}, + "output":{"shape":"CreateWebhookOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"OAuthProviderException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

" + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProjectInput"}, + "output":{"shape":"DeleteProjectOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Deletes a build project.

" + }, + "DeleteSourceCredentials":{ + "name":"DeleteSourceCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSourceCredentialsInput"}, + "output":{"shape":"DeleteSourceCredentialsOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

" + }, + "DeleteWebhook":{ + "name":"DeleteWebhook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebhookInput"}, + "output":{"shape":"DeleteWebhookOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OAuthProviderException"} + ], + "documentation":"

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

" + }, + "ImportSourceCredentials":{ + "name":"ImportSourceCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSourceCredentialsInput"}, + "output":{"shape":"ImportSourceCredentialsOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AccountLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

" + }, + "InvalidateProjectCache":{ + "name":"InvalidateProjectCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InvalidateProjectCacheInput"}, + "output":{"shape":"InvalidateProjectCacheOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Resets the cache for a project.

" + }, + "ListBuilds":{ + "name":"ListBuilds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBuildsInput"}, + "output":{"shape":"ListBuildsOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets a list of build IDs, with each build ID representing a single build.

" + }, + "ListBuildsForProject":{ + "name":"ListBuildsForProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBuildsForProjectInput"}, + "output":{"shape":"ListBuildsForProjectOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

" + }, + "ListCuratedEnvironmentImages":{ + "name":"ListCuratedEnvironmentImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCuratedEnvironmentImagesInput"}, + "output":{"shape":"ListCuratedEnvironmentImagesOutput"}, + "documentation":"

Gets information about Docker images that are managed by AWS CodeBuild.

" + }, + "ListProjects":{ + "name":"ListProjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProjectsInput"}, + "output":{"shape":"ListProjectsOutput"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets a list of build project names, with each build project name representing a single build project.

" + }, + "ListSourceCredentials":{ + "name":"ListSourceCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSourceCredentialsInput"}, + "output":{"shape":"ListSourceCredentialsOutput"}, + "documentation":"

Returns a list of SourceCredentialsInfo objects.

" + }, + "StartBuild":{ + "name":"StartBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartBuildInput"}, + "output":{"shape":"StartBuildOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccountLimitExceededException"} + ], + "documentation":"

Starts running a build.

" + }, + "StopBuild":{ + "name":"StopBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopBuildInput"}, + "output":{"shape":"StopBuildOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Attempts to stop running a build.

" + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProjectInput"}, + "output":{"shape":"UpdateProjectOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Changes the settings of a build project.

" + }, + "UpdateWebhook":{ + "name":"UpdateWebhook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWebhookInput"}, + "output":{"shape":"UpdateWebhookOutput"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OAuthProviderException"} + ], + "documentation":"

Updates the webhook associated with an AWS CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

" + } + }, + "shapes":{ + "AccountLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An AWS service limit was exceeded for the calling AWS account.

", + "exception":true + }, + "ArtifactNamespace":{ + "type":"string", + "enum":[ + "NONE", + "BUILD_ID" + ] + }, + "ArtifactPackaging":{ + "type":"string", + "enum":[ + "NONE", + "ZIP" + ] + }, + "ArtifactsType":{ + "type":"string", + "enum":[ + "CODEPIPELINE", + "S3", + "NO_ARTIFACTS" + ] + }, + "AuthType":{ + "type":"string", + "enum":[ + "OAUTH", + "BASIC_AUTH", + "PERSONAL_ACCESS_TOKEN" + ] + }, + "BatchDeleteBuildsInput":{ + "type":"structure", + "required":["ids"], + "members":{ + "ids":{ + "shape":"BuildIds", + "documentation":"

The IDs of the builds to delete.

" + } + } + }, + "BatchDeleteBuildsOutput":{ + "type":"structure", + "members":{ + "buildsDeleted":{ + "shape":"BuildIds", + "documentation":"

The IDs of the builds that were successfully deleted.

" + }, + "buildsNotDeleted":{ + "shape":"BuildsNotDeleted", + "documentation":"

Information about any builds that could not be successfully deleted.

" + } + } + }, + "BatchGetBuildsInput":{ + "type":"structure", + "required":["ids"], + "members":{ + "ids":{ + "shape":"BuildIds", + "documentation":"

The IDs of the builds.

" + } + } + }, + "BatchGetBuildsOutput":{ + "type":"structure", + "members":{ + "builds":{ + "shape":"Builds", + "documentation":"

Information about the requested builds.

" + }, + "buildsNotFound":{ + "shape":"BuildIds", + "documentation":"

The IDs of builds for which information could not be found.

" + } + } + }, + "BatchGetProjectsInput":{ + "type":"structure", + "required":["names"], + "members":{ + "names":{ + "shape":"ProjectNames", + "documentation":"

The names of the build projects.

" + } + } + }, + "BatchGetProjectsOutput":{ + "type":"structure", + "members":{ + "projects":{ + "shape":"Projects", + "documentation":"

Information about the requested build projects.

" + }, + "projectsNotFound":{ + "shape":"ProjectNames", + "documentation":"

The names of build projects for which information could not be found.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "Build":{ + "type":"structure", + "members":{ + "id":{ + "shape":"NonEmptyString", + "documentation":"

The unique ID for the build.

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

The Amazon Resource Name (ARN) of the build.

" + }, + "buildNumber":{ + "shape":"WrapperLong", + "documentation":"

The number of the build. For each project, the buildNumber of its first build is 1. The buildNumber of each subsequent build is incremented by 1. If a build is deleted, the buildNumber of other builds does not change.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

When the build process started, expressed in Unix time format.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

When the build process ended, expressed in Unix time format.

" + }, + "currentPhase":{ + "shape":"String", + "documentation":"

The current build phase.

" + }, + "buildStatus":{ + "shape":"StatusType", + "documentation":"

The current status of the build. Valid values include:

  • FAILED: The build failed.

  • FAULT: The build faulted.

  • IN_PROGRESS: The build is still in progress.

  • STOPPED: The build stopped.

  • SUCCEEDED: The build succeeded.

  • TIMED_OUT: The build timed out.

" + }, + "sourceVersion":{ + "shape":"NonEmptyString", + "documentation":"

Any version identifier for the version of the source code to be built. If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + }, + "resolvedSourceVersion":{ + "shape":"NonEmptyString", + "documentation":"

An identifier for the version of this build's source code.

  • For AWS CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.

  • For AWS CodePipeline, the source revision provided by AWS CodePipeline.

  • For Amazon Simple Storage Service (Amazon S3), this does not apply.

" + }, + "projectName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the AWS CodeBuild project.

" + }, + "phases":{ + "shape":"BuildPhases", + "documentation":"

Information about all previous build phases that are complete and information about any current build phase that is not yet complete.

" + }, + "source":{ + "shape":"ProjectSource", + "documentation":"

Information about the source code to be built.

" + }, + "secondarySources":{ + "shape":"ProjectSources", + "documentation":"

An array of ProjectSource objects.

" + }, + "secondarySourceVersions":{ + "shape":"ProjectSecondarySourceVersions", + "documentation":"

An array of ProjectSourceVersion objects. Each ProjectSourceVersion must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

" + }, + "artifacts":{ + "shape":"BuildArtifacts", + "documentation":"

Information about the output artifacts for the build.

" + }, + "secondaryArtifacts":{ + "shape":"BuildArtifactsList", + "documentation":"

An array of ProjectArtifacts objects.

" + }, + "cache":{ + "shape":"ProjectCache", + "documentation":"

Information about the cache for the build.

" + }, + "environment":{ + "shape":"ProjectEnvironment", + "documentation":"

Information about the build environment for this build.

" + }, + "serviceRole":{ + "shape":"NonEmptyString", + "documentation":"

The name of a service role used for this build.

" + }, + "logs":{ + "shape":"LogsLocation", + "documentation":"

Information about the build's logs in Amazon CloudWatch Logs.

" + }, + "timeoutInMinutes":{ + "shape":"WrapperInt", + "documentation":"

How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.

" + }, + "queuedTimeoutInMinutes":{ + "shape":"WrapperInt", + "documentation":"

The number of minutes a build is allowed to be queued before it times out.

" + }, + "buildComplete":{ + "shape":"Boolean", + "documentation":"

Whether the build is complete. True if complete; otherwise, false.

" + }, + "initiator":{ + "shape":"String", + "documentation":"

The entity that started the build. Valid values include:

  • If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline).

  • If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example, MyUserName).

  • If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.

" + }, + "networkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Describes a network interface.

" + }, + "encryptionKey":{ + "shape":"NonEmptyString", + "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

" + }, + "exportedEnvironmentVariables":{ + "shape":"ExportedEnvironmentVariables", + "documentation":"

A list of exported environment variables for this build.

" + } + }, + "documentation":"

Information about a build.

" + }, + "BuildArtifacts":{ + "type":"structure", + "members":{ + "location":{ + "shape":"String", + "documentation":"

Information about the location of the build artifacts.

" + }, + "sha256sum":{ + "shape":"String", + "documentation":"

The SHA-256 hash of the build artifact.

You can use this hash along with a checksum tool to confirm file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" + }, + "md5sum":{ + "shape":"String", + "documentation":"

The MD5 hash of the build artifact.

You can use this hash along with a checksum tool to confirm file integrity and authenticity.

This value is available only if the build project's packaging value is set to ZIP.

" + }, + "overrideArtifactName":{ + "shape":"WrapperBoolean", + "documentation":"

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

" + }, + "encryptionDisabled":{ + "shape":"WrapperBoolean", + "documentation":"

Information that tells you if encryption for build artifacts is disabled.

" + }, + "artifactIdentifier":{ + "shape":"String", + "documentation":"

An identifier for this artifact definition.

" + } + }, + "documentation":"

Information about build output artifacts.

" + }, + "BuildArtifactsList":{ + "type":"list", + "member":{"shape":"BuildArtifacts"}, + "max":12, + "min":0 + }, + "BuildIds":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":100, + "min":1 + }, + "BuildNotDeleted":{ + "type":"structure", + "members":{ + "id":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the build that could not be successfully deleted.

" + }, + "statusCode":{ + "shape":"String", + "documentation":"

Additional information about the build that could not be successfully deleted.

" + } + }, + "documentation":"

Information about a build that could not be successfully deleted.

" + }, + "BuildPhase":{ + "type":"structure", + "members":{ + "phaseType":{ + "shape":"BuildPhaseType", + "documentation":"

The name of the build phase. Valid values include:

  • BUILD: Core build activities typically occur in this build phase.

  • COMPLETED: The build has been completed.

  • DOWNLOAD_SOURCE: Source code is being downloaded in this build phase.

  • FINALIZING: The build process is completing in this build phase.

  • INSTALL: Installation activities typically occur in this build phase.

  • POST_BUILD: Post-build activities typically occur in this build phase.

  • PRE_BUILD: Pre-build activities typically occur in this build phase.

  • PROVISIONING: The build environment is being set up.

  • QUEUED: The build has been submitted and is queued behind other submitted builds.

  • SUBMITTED: The build has been submitted.

  • UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.

" + }, + "phaseStatus":{ + "shape":"StatusType", + "documentation":"

The current status of the build phase. Valid values include:

  • FAILED: The build phase failed.

  • FAULT: The build phase faulted.

  • IN_PROGRESS: The build phase is still in progress.

  • QUEUED: The build has been submitted and is queued behind other submitted builds.

  • STOPPED: The build phase stopped.

  • SUCCEEDED: The build phase succeeded.

  • TIMED_OUT: The build phase timed out.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

When the build phase started, expressed in Unix time format.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

When the build phase ended, expressed in Unix time format.

" + }, + "durationInSeconds":{ + "shape":"WrapperLong", + "documentation":"

How long, in seconds, between the starting and ending times of the build's phase.

" + }, + "contexts":{ + "shape":"PhaseContexts", + "documentation":"

Additional information about a build phase, especially to help troubleshoot a failed build.

" + } + }, + "documentation":"

Information about a stage for a build.

" + }, + "BuildPhaseType":{ + "type":"string", + "enum":[ + "SUBMITTED", + "QUEUED", + "PROVISIONING", + "DOWNLOAD_SOURCE", + "INSTALL", + "PRE_BUILD", + "BUILD", + "POST_BUILD", + "UPLOAD_ARTIFACTS", + "FINALIZING", + "COMPLETED" + ] + }, + "BuildPhases":{ + "type":"list", + "member":{"shape":"BuildPhase"} + }, + "Builds":{ + "type":"list", + "member":{"shape":"Build"} + }, + "BuildsNotDeleted":{ + "type":"list", + "member":{"shape":"BuildNotDeleted"} + }, + "CacheMode":{ + "type":"string", + "enum":[ + "LOCAL_DOCKER_LAYER_CACHE", + "LOCAL_SOURCE_CACHE", + "LOCAL_CUSTOM_CACHE" + ] + }, + "CacheType":{ + "type":"string", + "enum":[ + "NO_CACHE", + "S3", + "LOCAL" + ] + }, + "CloudWatchLogsConfig":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"LogsConfigStatusType", + "documentation":"

The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are:

  • ENABLED: Amazon CloudWatch Logs are enabled for this build project.

  • DISABLED: Amazon CloudWatch Logs are not enabled for this build project.

" + }, + "groupName":{ + "shape":"String", + "documentation":"

The group name of the logs in Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

" + }, + "streamName":{ + "shape":"String", + "documentation":"

The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

" + } + }, + "documentation":"

Information about Amazon CloudWatch Logs for a build project.

" + }, + "ComputeType":{ + "type":"string", + "enum":[ + "BUILD_GENERAL1_SMALL", + "BUILD_GENERAL1_MEDIUM", + "BUILD_GENERAL1_LARGE" + ] + }, + "CreateProjectInput":{ + "type":"structure", + "required":[ + "name", + "source", + "artifacts", + "environment", + "serviceRole" + ], + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

The name of the build project.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

A description that makes the build project easy to identify.

" + }, + "source":{ + "shape":"ProjectSource", + "documentation":"

Information about the build input source code for the build project.

" + }, + "secondarySources":{ + "shape":"ProjectSources", + "documentation":"

An array of ProjectSource objects.

" + }, + "sourceVersion":{ + "shape":"String", + "documentation":"

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + }, + "secondarySourceVersions":{ + "shape":"ProjectSecondarySourceVersions", + "documentation":"

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

" + }, + "artifacts":{ + "shape":"ProjectArtifacts", + "documentation":"

Information about the build output artifacts for the build project.

" + }, + "secondaryArtifacts":{ + "shape":"ProjectArtifactsList", + "documentation":"

An array of ProjectArtifacts objects.

" + }, + "cache":{ + "shape":"ProjectCache", + "documentation":"

Stores recently used information so that it can be quickly accessed at a later time.

" + }, + "environment":{ + "shape":"ProjectEnvironment", + "documentation":"

Information about the build environment for the build project.

" + }, + "serviceRole":{ + "shape":"NonEmptyString", + "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" + }, + "timeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

" + }, + "queuedTimeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

The number of minutes a build is allowed to be queued before it times out.

" + }, + "encryptionKey":{ + "shape":"NonEmptyString", + "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

A set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + }, + "badgeEnabled":{ + "shape":"WrapperBoolean", + "documentation":"

Set this to true to generate a publicly accessible URL for your project's build badge.

" + }, + "logsConfig":{ + "shape":"LogsConfig", + "documentation":"

Information about logs for the build project. These can be logs in Amazon CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

" + } + } + }, + "CreateProjectOutput":{ + "type":"structure", + "members":{ + "project":{ + "shape":"Project", + "documentation":"

Information about the build project that was created.

" + } + } + }, + "CreateWebhookInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the AWS CodeBuild project.

" + }, + "branchFilter":{ + "shape":"String", + "documentation":"

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

" + }, + "filterGroups":{ + "shape":"FilterGroups", + "documentation":"

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

" + } + } + }, + "CreateWebhookOutput":{ + "type":"structure", + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

" + } + } + }, + "CredentialProviderType":{ + "type":"string", + "enum":["SECRETS_MANAGER"] + }, + "DeleteProjectInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the build project.

" + } + } + }, + "DeleteProjectOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteSourceCredentialsInput":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the token.

" + } + } + }, + "DeleteSourceCredentialsOutput":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the token.

" + } + } + }, + "DeleteWebhookInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the AWS CodeBuild project.

" + } + } + }, + "DeleteWebhookOutput":{ + "type":"structure", + "members":{ + } + }, + "EnvironmentImage":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the Docker image.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the Docker image.

" + }, + "versions":{ + "shape":"ImageVersions", + "documentation":"

A list of environment image versions.

" + } + }, + "documentation":"

Information about a Docker image that is managed by AWS CodeBuild.

" + }, + "EnvironmentImages":{ + "type":"list", + "member":{"shape":"EnvironmentImage"} + }, + "EnvironmentLanguage":{ + "type":"structure", + "members":{ + "language":{ + "shape":"LanguageType", + "documentation":"

The programming language for the Docker images.

" + }, + "images":{ + "shape":"EnvironmentImages", + "documentation":"

The list of Docker images that are related by the specified programming language.

" + } + }, + "documentation":"

A set of Docker images that are related by programming language and are managed by AWS CodeBuild.

" + }, + "EnvironmentLanguages":{ + "type":"list", + "member":{"shape":"EnvironmentLanguage"} + }, + "EnvironmentPlatform":{ + "type":"structure", + "members":{ + "platform":{ + "shape":"PlatformType", + "documentation":"

The platform's name.

" + }, + "languages":{ + "shape":"EnvironmentLanguages", + "documentation":"

The list of programming languages that are available for the specified platform.

" + } + }, + "documentation":"

A set of Docker images that are related by platform and are managed by AWS CodeBuild.

" + }, + "EnvironmentPlatforms":{ + "type":"list", + "member":{"shape":"EnvironmentPlatform"} + }, + "EnvironmentType":{ + "type":"string", + "enum":[ + "WINDOWS_CONTAINER", + "LINUX_CONTAINER" + ] + }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name or key of the environment variable.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the environment variable.

We strongly discourage the use of environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).

" + }, + "type":{ + "shape":"EnvironmentVariableType", + "documentation":"

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store.

  • PLAINTEXT: An environment variable in plaintext format.

  • SECRETS_MANAGER: An environment variable stored in AWS Secrets Manager.

" + } + }, + "documentation":"

Information about an environment variable for a build project or a build.

" + }, + "EnvironmentVariableType":{ + "type":"string", + "enum":[ + "PLAINTEXT", + "PARAMETER_STORE", + "SECRETS_MANAGER" + ] + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"} + }, + "ExportedEnvironmentVariable":{ + "type":"structure", + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of this exported environment variable.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value assigned to this exported environment variable.

During a build, the value of a variable is available starting with the install phase. It can be updated between the start of the install phase and the end of the post_build phase. After the post_build phase ends, the value of exported variables cannot change.

" + } + }, + "documentation":"

Information about an exported environment variable.

" + }, + "ExportedEnvironmentVariables":{ + "type":"list", + "member":{"shape":"ExportedEnvironmentVariable"} + }, + "FilterGroup":{ + "type":"list", + "member":{"shape":"WebhookFilter"} + }, + "FilterGroups":{ + "type":"list", + "member":{"shape":"FilterGroup"} + }, + "GitCloneDepth":{ + "type":"integer", + "min":0 + }, + "GitSubmodulesConfig":{ + "type":"structure", + "required":["fetchSubmodules"], + "members":{ + "fetchSubmodules":{ + "shape":"WrapperBoolean", + "documentation":"

Set to true to fetch Git submodules for your AWS CodeBuild build project.

" + } + }, + "documentation":"

Information about the Git submodules configuration for an AWS CodeBuild build project.

" + }, + "ImagePullCredentialsType":{ + "type":"string", + "enum":[ + "CODEBUILD", + "SERVICE_ROLE" + ] + }, + "ImageVersions":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportSourceCredentialsInput":{ + "type":"structure", + "required":[ + "token", + "serverType", + "authType" + ], + "members":{ + "username":{ + "shape":"NonEmptyString", + "documentation":"

The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

" + }, + "token":{ + "shape":"SensitiveNonEmptyString", + "documentation":"

For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

" + }, + "serverType":{ + "shape":"ServerType", + "documentation":"

The source provider used for this project.

" + }, + "authType":{ + "shape":"AuthType", + "documentation":"

The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console.

" + }, + "shouldOverwrite":{ + "shape":"WrapperBoolean", + "documentation":"

Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

" + } + } + }, + "ImportSourceCredentialsOutput":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the token.

" + } + } + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input value that was provided is not valid.

", + "exception":true + }, + "InvalidateProjectCacheInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the AWS CodeBuild build project that the cache is reset for.

" + } + } + }, + "InvalidateProjectCacheOutput":{ + "type":"structure", + "members":{ + } + }, + "KeyInput":{ + "type":"string", + "max":127, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=@+\\-]*)$" + }, + "LanguageType":{ + "type":"string", + "enum":[ + "JAVA", + "PYTHON", + "NODE_JS", + "RUBY", + "GOLANG", + "DOCKER", + "ANDROID", + "DOTNET", + "BASE", + "PHP" + ] + }, + "ListBuildsForProjectInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the AWS CodeBuild project.

" + }, + "sortOrder":{ + "shape":"SortOrderType", + "documentation":"

The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.

  • DESCENDING: List the build IDs in descending order by build ID.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + } + } + }, + "ListBuildsForProjectOutput":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"BuildIds", + "documentation":"

A list of build IDs for the specified build project, with each build ID representing a single build.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + } + } + }, + "ListBuildsInput":{ + "type":"structure", + "members":{ + "sortOrder":{ + "shape":"SortOrderType", + "documentation":"

The order to list build IDs. Valid values include:

  • ASCENDING: List the build IDs in ascending order by build ID.

  • DESCENDING: List the build IDs in descending order by build ID.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + } + } + }, + "ListBuildsOutput":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"BuildIds", + "documentation":"

A list of build IDs, with each build ID representing a single build.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + } + } + }, + "ListCuratedEnvironmentImagesInput":{ + "type":"structure", + "members":{ + } + }, + "ListCuratedEnvironmentImagesOutput":{ + "type":"structure", + "members":{ + "platforms":{ + "shape":"EnvironmentPlatforms", + "documentation":"

Information about supported platforms for Docker images that are managed by AWS CodeBuild.

" + } + } + }, + "ListProjectsInput":{ + "type":"structure", + "members":{ + "sortBy":{ + "shape":"ProjectSortByType", + "documentation":"

The criterion to be used to list build project names. Valid values include:

  • CREATED_TIME: List based on when each build project was created.

  • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.

  • NAME: List based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

" + }, + "sortOrder":{ + "shape":"SortOrderType", + "documentation":"

The order in which to list build projects. Valid values include:

  • ASCENDING: List in ascending order.

  • DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list build project names.

" + }, + "nextToken":{ + "shape":"NonEmptyString", + "documentation":"

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

" + } + } + }, + "ListProjectsOutput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

" + }, + "projects":{ + "shape":"ProjectNames", + "documentation":"

The list of build project names, with each build project name representing a single build project.

" + } + } + }, + "ListSourceCredentialsInput":{ + "type":"structure", + "members":{ + } + }, + "ListSourceCredentialsOutput":{ + "type":"structure", + "members":{ + "sourceCredentialsInfos":{ + "shape":"SourceCredentialsInfos", + "documentation":"

A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

" + } + } + }, + "LogsConfig":{ + "type":"structure", + "members":{ + "cloudWatchLogs":{ + "shape":"CloudWatchLogsConfig", + "documentation":"

Information about Amazon CloudWatch Logs for a build project. Amazon CloudWatch Logs are enabled by default.

" + }, + "s3Logs":{ + "shape":"S3LogsConfig", + "documentation":"

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

" + } + }, + "documentation":"

Information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.

" + }, + "LogsConfigStatusType":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "LogsLocation":{ + "type":"structure", + "members":{ + "groupName":{ + "shape":"String", + "documentation":"

The name of the Amazon CloudWatch Logs group for the build logs.

" + }, + "streamName":{ + "shape":"String", + "documentation":"

The name of the Amazon CloudWatch Logs stream for the build logs.

" + }, + "deepLink":{ + "shape":"String", + "documentation":"

The URL to an individual build log in Amazon CloudWatch Logs.

" + }, + "s3DeepLink":{ + "shape":"String", + "documentation":"

The URL to a build log in an S3 bucket.

" + }, + "cloudWatchLogs":{ + "shape":"CloudWatchLogsConfig", + "documentation":"

Information about Amazon CloudWatch Logs for a build project.

" + }, + "s3Logs":{ + "shape":"S3LogsConfig", + "documentation":"

Information about S3 logs for a build project.

" + } + }, + "documentation":"

Information about build logs in Amazon CloudWatch Logs.

" + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "subnetId":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the subnet.

" + }, + "networkInterfaceId":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the network interface.

" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "OAuthProviderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There was a problem with the underlying OAuth provider.

", + "exception":true + }, + "PhaseContext":{ + "type":"structure", + "members":{ + "statusCode":{ + "shape":"String", + "documentation":"

The status code for the context of the build phase.

" + }, + "message":{ + "shape":"String", + "documentation":"

An explanation of the build phase's context. This might include a command ID and an exit code.

" + } + }, + "documentation":"

Additional information about a build phase that has an error. You can use this information for troubleshooting.

" + }, + "PhaseContexts":{ + "type":"list", + "member":{"shape":"PhaseContext"} + }, + "PlatformType":{ + "type":"string", + "enum":[ + "DEBIAN", + "AMAZON_LINUX", + "UBUNTU", + "WINDOWS_SERVER" + ] + }, + "Project":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

The name of the build project.

" + }, + "arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the build project.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

A description that makes the build project easy to identify.

" + }, + "source":{ + "shape":"ProjectSource", + "documentation":"

Information about the build input source code for this build project.

" + }, + "secondarySources":{ + "shape":"ProjectSources", + "documentation":"

An array of ProjectSource objects.

" + }, + "sourceVersion":{ + "shape":"String", + "documentation":"

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + }, + "secondarySourceVersions":{ + "shape":"ProjectSecondarySourceVersions", + "documentation":"

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

" + }, + "artifacts":{ + "shape":"ProjectArtifacts", + "documentation":"

Information about the build output artifacts for the build project.

" + }, + "secondaryArtifacts":{ + "shape":"ProjectArtifactsList", + "documentation":"

An array of ProjectArtifacts objects.

" + }, + "cache":{ + "shape":"ProjectCache", + "documentation":"

Information about the cache for the build project.

" + }, + "environment":{ + "shape":"ProjectEnvironment", + "documentation":"

Information about the build environment for this build project.

" + }, + "serviceRole":{ + "shape":"NonEmptyString", + "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" + }, + "timeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

" + }, + "queuedTimeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

The number of minutes a build is allowed to be queued before it times out.

" + }, + "encryptionKey":{ + "shape":"NonEmptyString", + "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

When the build project was created, expressed in Unix time format.

" + }, + "lastModified":{ + "shape":"Timestamp", + "documentation":"

When the build project's settings were last modified, expressed in Unix time format.

" + }, + "webhook":{ + "shape":"Webhook", + "documentation":"

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Information about the VPC configuration that AWS CodeBuild accesses.

" + }, + "badge":{ + "shape":"ProjectBadge", + "documentation":"

Information about the build badge for the build project.

" + }, + "logsConfig":{ + "shape":"LogsConfig", + "documentation":"

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.

" + } + }, + "documentation":"

Information about a build project.

" + }, + "ProjectArtifacts":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"ArtifactsType", + "documentation":"

The type of build output artifact. Valid values include:

  • CODEPIPELINE: The build project has build output generated through AWS CodePipeline.

    The CODEPIPELINE type is not supported for secondaryArtifacts.

  • NO_ARTIFACTS: The build project does not produce any build output.

  • S3: The build project stores build output in Amazon Simple Storage Service (Amazon S3).

" + }, + "location":{ + "shape":"String", + "documentation":"

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output bucket.

" + }, + "path":{ + "shape":"String", + "documentation":"

Along with namespaceType and name, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.

" + }, + "namespaceType":{ + "shape":"ArtifactNamespace", + "documentation":"

Along with path and name, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, valid values include:

    • BUILD_ID: Include the build ID in the location of the build output artifact.

    • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.

" + }, + "name":{ + "shape":"String", + "documentation":"

Along with path and namespaceType, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash (\"/\"), the artifact is stored in the root of the output bucket.

For example:

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/build-ID/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to \"/\", the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to \"/\", the output artifact is stored in MyArtifacts/build-ID .

" + }, + "packaging":{ + "shape":"ArtifactPackaging", + "documentation":"

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, valid values include:

    • NONE: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

" + }, + "overrideArtifactName":{ + "shape":"WrapperBoolean", + "documentation":"

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

" + }, + "encryptionDisabled":{ + "shape":"WrapperBoolean", + "documentation":"

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

" + }, + "artifactIdentifier":{ + "shape":"String", + "documentation":"

An identifier for this artifact definition.

" + } + }, + "documentation":"

Information about the build output artifacts for the build project.

" + }, + "ProjectArtifactsList":{ + "type":"list", + "member":{"shape":"ProjectArtifacts"}, + "max":12, + "min":0 + }, + "ProjectBadge":{ + "type":"structure", + "members":{ + "badgeEnabled":{ + "shape":"Boolean", + "documentation":"

Set this to true to generate a publicly accessible URL for your project's build badge.

" + }, + "badgeRequestUrl":{ + "shape":"String", + "documentation":"

The publicly-accessible URL through which you can access the build badge for your project.

The publicly accessible URL through which you can access the build badge for your project.

" + } + }, + "documentation":"

Information about the build badge for the build project.

" + }, + "ProjectCache":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"CacheType", + "documentation":"

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

" + }, + "location":{ + "shape":"String", + "documentation":"

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

" + }, + "modes":{ + "shape":"ProjectCacheModes", + "documentation":"

If you use a LOCAL cache, the local cache mode. You can use one or more local cache modes at the same time.

  • LOCAL_SOURCE_CACHE mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

  • LOCAL_DOCKER_LAYER_CACHE mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

    • You can use a Docker layer cache in the Linux environment only.

    • The privileged flag must be set so that your project has the required Docker permissions.

    • You should consider the security implications before you use a Docker layer cache.

  • LOCAL_CUSTOM_CACHE mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

    • Only directories can be specified for caching. You cannot specify individual files.

    • Symlinks are used to reference cached directories.

    • Cached directories are linked to your build before it downloads its project sources. Cached items are overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

" + } + }, + "documentation":"

Information about the cache for the build project.

" + }, + "ProjectCacheModes":{ + "type":"list", + "member":{"shape":"CacheMode"} + }, + "ProjectDescription":{ + "type":"string", + "max":255, + "min":0 + }, + "ProjectEnvironment":{ + "type":"structure", + "required":[ + "type", + "image", + "computeType" + ], + "members":{ + "type":{ + "shape":"EnvironmentType", + "documentation":"

The type of build environment to use for related builds.

" + }, + "image":{ + "shape":"NonEmptyString", + "documentation":"

The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:

  • For an image tag: registry/repository:tag. For example, to specify an image with the tag \"latest,\" use registry/repository:latest.

  • For an image digest: registry/repository@digest. For example, to specify an image with the digest \"sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,\" use registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

" + }, + "computeType":{ + "shape":"ComputeType", + "documentation":"

Information about the compute resources the build project uses. Available values include:

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.

For more information, see Build Environment Compute Types in the AWS CodeBuild User Guide.

" + }, + "environmentVariables":{ + "shape":"EnvironmentVariables", + "documentation":"

A set of environment variables to make available to builds for this build project.

" + }, + "privilegedMode":{ + "shape":"WrapperBoolean", + "documentation":"

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

If the operating system's base image is Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c \"until docker info; do echo .; sleep 1; done\"

If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"

" + }, + "certificate":{ + "shape":"String", + "documentation":"

The certificate to use with this build project.

" + }, + "registryCredential":{ + "shape":"RegistryCredential", + "documentation":"

The credentials for access to a private registry.

" + }, + "imagePullCredentialsType":{ + "shape":"ImagePullCredentialsType", + "documentation":"

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

  • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

  • SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.

" + } + }, + "documentation":"

Information about the build environment of the build project.

" + }, + "ProjectName":{ + "type":"string", + "max":255, + "min":2, + "pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}" + }, + "ProjectNames":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":100, + "min":1 + }, + "ProjectSecondarySourceVersions":{ + "type":"list", + "member":{"shape":"ProjectSourceVersion"}, + "max":12, + "min":0 + }, + "ProjectSortByType":{ + "type":"string", + "enum":[ + "NAME", + "CREATED_TIME", + "LAST_MODIFIED_TIME" + ] + }, + "ProjectSource":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"SourceType", + "documentation":"

The type of repository that contains the source code to be built. Valid values include:

  • BITBUCKET: The source code is in a Bitbucket repository.

  • CODECOMMIT: The source code is in an AWS CodeCommit repository.

  • CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.

  • GITHUB: The source code is in a GitHub repository.

  • GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise repository.

  • NO_SOURCE: The project does not have input source code.

  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

" + }, + "location":{ + "shape":"String", + "documentation":"

Information about the location of the source code to be built. Valid values include:

  • For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.

  • For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ).

  • For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following.

    • The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip).

    • The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/).

  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow AWS CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

  • For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

" + }, + "gitCloneDepth":{ + "shape":"GitCloneDepth", + "documentation":"

Information about the Git clone depth for the build project.

" + }, + "gitSubmodulesConfig":{ + "shape":"GitSubmodulesConfig", + "documentation":"

Information about the Git submodules configuration for the build project.

" + }, + "buildspec":{ + "shape":"String", + "documentation":"

The build spec declaration to use for the builds in this build project.

If this value is not specified, a build spec must be included along with the source code to be built.

" + }, + "auth":{ + "shape":"SourceAuth", + "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.

" + }, + "reportBuildStatus":{ + "shape":"WrapperBoolean", + "documentation":"

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

" + }, + "insecureSsl":{ + "shape":"WrapperBoolean", + "documentation":"

Enable this flag to ignore SSL warnings while connecting to the project source code.

" + }, + "sourceIdentifier":{ + "shape":"String", + "documentation":"

An identifier for this project source.

" + } + }, + "documentation":"

Information about the build input source code for the build project.

" + }, + "ProjectSourceVersion":{ + "type":"structure", + "required":[ + "sourceIdentifier", + "sourceVersion" + ], + "members":{ + "sourceIdentifier":{ + "shape":"String", + "documentation":"

An identifier for a source in the build project.

" + }, + "sourceVersion":{ + "shape":"String", + "documentation":"

The source version for the corresponding source identifier. If specified, must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + } + }, + "documentation":"

A source identifier and its corresponding version.

" + }, + "ProjectSources":{ + "type":"list", + "member":{"shape":"ProjectSource"}, + "max":12, + "min":0 + }, + "Projects":{ + "type":"list", + "member":{"shape":"Project"} + }, + "RegistryCredential":{ + "type":"structure", + "required":[ + "credential", + "credentialProvider" + ], + "members":{ + "credential":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.

The credential can use the name of the credentials only if they exist in your current region.

" + }, + "credentialProvider":{ + "shape":"CredentialProviderType", + "documentation":"

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.

" + } + }, + "documentation":"

Information about credentials that provide access to a private Docker registry. When this is set:

  • imagePullCredentialsType must be set to SERVICE_ROLE.

  • images cannot be curated or an Amazon ECR image.

For more information, see Private Registry with AWS Secrets Manager Sample for AWS CodeBuild.

" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified AWS resource cannot be found.

", + "exception":true + }, + "S3LogsConfig":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"LogsConfigStatusType", + "documentation":"

The current status of the S3 build logs. Valid values are:

  • ENABLED: S3 build logs are enabled for this build project.

  • DISABLED: S3 build logs are not enabled for this build project.

" + }, + "location":{ + "shape":"String", + "documentation":"

The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

" + }, + "encryptionDisabled":{ + "shape":"WrapperBoolean", + "documentation":"

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

" + } + }, + "documentation":"

Information about S3 logs for a build project.

" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":5 + }, + "SensitiveNonEmptyString":{ + "type":"string", + "min":1, + "sensitive":true + }, + "ServerType":{ + "type":"string", + "enum":[ + "GITHUB", + "BITBUCKET", + "GITHUB_ENTERPRISE" + ] + }, + "SortOrderType":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "SourceAuth":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"SourceAuthType", + "documentation":"

This data type is deprecated and is no longer accurate or used.

The authorization type to use. The only valid value is OAUTH, which represents the OAuth authorization type.

" + }, + "resource":{ + "shape":"String", + "documentation":"

The resource value that applies to the specified authorization type.

" + } + }, + "documentation":"

Information about the authorization settings for AWS CodeBuild to access the source code to be built.

This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly.

" + }, + "SourceAuthType":{ + "type":"string", + "enum":["OAUTH"] + }, + "SourceCredentialsInfo":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the token.

" + }, + "serverType":{ + "shape":"ServerType", + "documentation":"

The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

" + }, + "authType":{ + "shape":"AuthType", + "documentation":"

The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

" + } + }, + "documentation":"

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

" + }, + "SourceCredentialsInfos":{ + "type":"list", + "member":{"shape":"SourceCredentialsInfo"} + }, + "SourceType":{ + "type":"string", + "enum":[ + "CODECOMMIT", + "CODEPIPELINE", + "GITHUB", + "S3", + "BITBUCKET", + "GITHUB_ENTERPRISE", + "NO_SOURCE" + ] + }, + "StartBuildInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the AWS CodeBuild build project to start running a build.

" + }, + "secondarySourcesOverride":{ + "shape":"ProjectSources", + "documentation":"

An array of ProjectSource objects.

" + }, + "secondarySourcesVersionOverride":{ + "shape":"ProjectSecondarySourceVersions", + "documentation":"

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

" + }, + "sourceVersion":{ + "shape":"String", + "documentation":"

A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + }, + "artifactsOverride":{ + "shape":"ProjectArtifacts", + "documentation":"

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

" + }, + "secondaryArtifactsOverride":{ + "shape":"ProjectArtifactsList", + "documentation":"

An array of ProjectArtifacts objects.

" + }, + "environmentVariablesOverride":{ + "shape":"EnvironmentVariables", + "documentation":"

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

" + }, + "sourceTypeOverride":{ + "shape":"SourceType", + "documentation":"

A source input type, for this build, that overrides the source input defined in the build project.

" + }, + "sourceLocationOverride":{ + "shape":"String", + "documentation":"

A location that overrides, for this build, the source location for the one defined in the build project.

" + }, + "sourceAuthOverride":{ + "shape":"SourceAuth", + "documentation":"

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

" + }, + "gitCloneDepthOverride":{ + "shape":"GitCloneDepth", + "documentation":"

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

" + }, + "gitSubmodulesConfigOverride":{ + "shape":"GitSubmodulesConfig", + "documentation":"

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

" + }, + "buildspecOverride":{ + "shape":"String", + "documentation":"

A build spec declaration that overrides, for this build only, the latest one already defined in the build project.

" + }, + "insecureSslOverride":{ + "shape":"WrapperBoolean", + "documentation":"

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

" + }, + "reportBuildStatusOverride":{ + "shape":"WrapperBoolean", + "documentation":"

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

" + }, + "environmentTypeOverride":{ + "shape":"EnvironmentType", + "documentation":"

A container type for this build that overrides the one specified in the build project.

" + }, + "imageOverride":{ + "shape":"NonEmptyString", + "documentation":"

The name of an image for this build that overrides the one specified in the build project.

" + }, + "computeTypeOverride":{ + "shape":"ComputeType", + "documentation":"

The name of a compute type for this build that overrides the one specified in the build project.

" + }, + "certificateOverride":{ + "shape":"String", + "documentation":"

The name of a certificate for this build that overrides the one specified in the build project.

" + }, + "cacheOverride":{ + "shape":"ProjectCache", + "documentation":"

A ProjectCache object specified for this build that overrides the one defined in the build project.

" + }, + "serviceRoleOverride":{ + "shape":"NonEmptyString", + "documentation":"

The name of a service role for this build that overrides the one specified in the build project.

" + }, + "privilegedModeOverride":{ + "shape":"WrapperBoolean", + "documentation":"

Enable this flag to override privileged mode in the build project.

" + }, + "timeoutInMinutesOverride":{ + "shape":"TimeOut", + "documentation":"

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

" + }, + "queuedTimeoutInMinutesOverride":{ + "shape":"TimeOut", + "documentation":"

The number of minutes a build is allowed to be queued before it times out.

" + }, + "idempotencyToken":{ + "shape":"String", + "documentation":"

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

" + }, + "logsConfigOverride":{ + "shape":"LogsConfig", + "documentation":"

Log settings for this build that override the log settings defined in the build project.

" + }, + "registryCredentialOverride":{ + "shape":"RegistryCredential", + "documentation":"

The credentials for access to a private registry.

" + }, + "imagePullCredentialsTypeOverride":{ + "shape":"ImagePullCredentialsType", + "documentation":"

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

  • CODEBUILD specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

  • SERVICE_ROLE specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

" + } + } + }, + "StartBuildOutput":{ + "type":"structure", + "members":{ + "build":{ + "shape":"Build", + "documentation":"

Information about the build to be run.

" + } + } + }, + "StatusType":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "FAILED", + "FAULT", + "TIMED_OUT", + "IN_PROGRESS", + "STOPPED" + ] + }, + "StopBuildInput":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the build.

" + } + } + }, + "StopBuildOutput":{ + "type":"structure", + "members":{ + "build":{ + "shape":"Build", + "documentation":"

Information about the build.

" + } + } + }, + "String":{"type":"string"}, + "Subnets":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":16 + }, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"KeyInput", + "documentation":"

The tag's key.

" + }, + "value":{ + "shape":"ValueInput", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TimeOut":{ + "type":"integer", + "max":480, + "min":5 + }, + "Timestamp":{"type":"timestamp"}, + "UpdateProjectInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the build project.

You cannot change a build project's name.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

A new or replacement description of the build project.

" + }, + "source":{ + "shape":"ProjectSource", + "documentation":"

Information to be changed about the build input source code for the build project.

" + }, + "secondarySources":{ + "shape":"ProjectSources", + "documentation":"

An array of ProjectSource objects.

" + }, + "sourceVersion":{ + "shape":"String", + "documentation":"

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

" + }, + "secondarySourceVersions":{ + "shape":"ProjectSecondarySourceVersions", + "documentation":"

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

" + }, + "artifacts":{ + "shape":"ProjectArtifacts", + "documentation":"

Information to be changed about the build output artifacts for the build project.

" + }, + "secondaryArtifacts":{ + "shape":"ProjectArtifactsList", + "documentation":"

An array of ProjectSource objects.

" + }, + "cache":{ + "shape":"ProjectCache", + "documentation":"

Stores recently used information so that it can be quickly accessed at a later time.

" + }, + "environment":{ + "shape":"ProjectEnvironment", + "documentation":"

Information to be changed about the build environment for the build project.

" + }, + "serviceRole":{ + "shape":"NonEmptyString", + "documentation":"

The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" + }, + "timeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.

" + }, + "queuedTimeoutInMinutes":{ + "shape":"TimeOut", + "documentation":"

The number of minutes a build is allowed to be queued before it times out.

" + }, + "encryptionKey":{ + "shape":"NonEmptyString", + "documentation":"

The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/alias-name ).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The replacement set of tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.

" + }, + "badgeEnabled":{ + "shape":"WrapperBoolean", + "documentation":"

Set this to true to generate a publicly accessible URL for your project's build badge.

" + }, + "logsConfig":{ + "shape":"LogsConfig", + "documentation":"

Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, logs in an S3 bucket, or both.

" + } + } + }, + "UpdateProjectOutput":{ + "type":"structure", + "members":{ + "project":{ + "shape":"Project", + "documentation":"

Information about the build project that was changed.

" + } + } + }, + "UpdateWebhookInput":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the AWS CodeBuild project.

" + }, + "branchFilter":{ + "shape":"String", + "documentation":"

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

" + }, + "rotateSecret":{ + "shape":"Boolean", + "documentation":"

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

" + }, + "filterGroups":{ + "shape":"FilterGroups", + "documentation":"

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one EVENT WebhookFilter.

" + } + } + }, + "UpdateWebhookOutput":{ + "type":"structure", + "members":{ + "webhook":{ + "shape":"Webhook", + "documentation":"

Information about a repository's webhook that is associated with a project in AWS CodeBuild.

" + } + } + }, + "ValueInput":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=@+\\-]*)$" + }, + "VpcConfig":{ + "type":"structure", + "members":{ + "vpcId":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the Amazon VPC.

" + }, + "subnets":{ + "shape":"Subnets", + "documentation":"

A list of one or more subnet IDs in your Amazon VPC.

" + }, + "securityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of one or more security groups IDs in your Amazon VPC.

" + } + }, + "documentation":"

Information about the VPC configuration that AWS CodeBuild accesses.

" + }, + "Webhook":{ + "type":"structure", + "members":{ + "url":{ + "shape":"NonEmptyString", + "documentation":"

The URL to the webhook.

" + }, + "payloadUrl":{ + "shape":"NonEmptyString", + "documentation":"

The AWS CodeBuild endpoint where webhook events are sent.

" + }, + "secret":{ + "shape":"NonEmptyString", + "documentation":"

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

" + }, + "branchFilter":{ + "shape":"String", + "documentation":"

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

" + }, + "filterGroups":{ + "shape":"FilterGroups", + "documentation":"

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

" + }, + "lastModifiedSecret":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates the last time a repository's secret token was modified.

" + } + }, + "documentation":"

Information about a webhook that connects repository events to a build project in AWS CodeBuild.

" + }, + "WebhookFilter":{ + "type":"structure", + "required":[ + "type", + "pattern" + ], + "members":{ + "type":{ + "shape":"WebhookFilterType", + "documentation":"

The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH.

EVENT

A webhook event triggers a build when the provided pattern matches one of four event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, and PULL_REQUEST_REOPENED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.

The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.

ACTOR_ACCOUNT_ID

A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

HEAD_REF

A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

BASE_REF

A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

Works with pull request events only.

FILE_PATH

A webhook triggers a build when the path of a changed file matches the regular expression pattern.

Works with GitHub and GitHub Enterprise push events only.

" + }, + "pattern":{ + "shape":"String", + "documentation":"

For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.

For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.

" + }, + "excludeMatchedPattern":{ + "shape":"WrapperBoolean", + "documentation":"

Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.

" + } + }, + "documentation":"

A filter used to determine which webhooks trigger a build.

" + }, + "WebhookFilterType":{ + "type":"string", + "enum":[ + "EVENT", + "BASE_REF", + "HEAD_REF", + "ACTOR_ACCOUNT_ID", + "FILE_PATH" + ] + }, + "WrapperBoolean":{"type":"boolean"}, + "WrapperInt":{"type":"integer"}, + "WrapperLong":{"type":"long"} + }, + "documentation":"AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

  • BatchDeleteBuilds: Deletes one or more builds.

  • BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment is a representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build. You can add tags to build projects to help manage your resources and costs.

  • CreateProject: Creates a build project.

  • CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

  • UpdateWebhook: Changes the settings of an existing webhook.

  • DeleteProject: Deletes a build project.

  • DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

  • ListProjects: Gets a list of build project names, with each build project name representing a single build project.

  • UpdateProject: Changes the settings of an existing build project.

  • BatchGetBuilds: Gets information about one or more builds.

  • ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

  • ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

  • StartBuild: Starts running a build.

  • StopBuild: Attempts to stop running a build.

  • ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

  • DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

  • ImportSourceCredentials: Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

  • ListSourceCredentials: Returns a list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

" +} diff --git a/aws/dist/botocore/data/codecommit/2015-04-13/examples-1.json b/aws/dist/botocore/data/codecommit/2015-04-13/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/codecommit/2015-04-13/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/codecommit/2015-04-13/paginators-1.json b/aws/dist/botocore/data/codecommit/2015-04-13/paginators-1.json new file mode 100644 index 00000000..b3310fca --- /dev/null +++ b/aws/dist/botocore/data/codecommit/2015-04-13/paginators-1.json @@ -0,0 +1,44 @@ +{ + "pagination": { + "ListBranches": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "branches" + }, + "ListRepositories": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "repositories" + }, + "GetCommentsForComparedCommit": { + "result_key": "commentsForComparedCommitData", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "DescribePullRequestEvents": { + "result_key": "pullRequestEvents", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetCommentsForPullRequest": { + "result_key": "commentsForPullRequestData", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListPullRequests": { + "result_key": "pullRequestIds", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetDifferences": { + "result_key": "differences", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/codecommit/2015-04-13/service-2.json b/aws/dist/botocore/data/codecommit/2015-04-13/service-2.json new file mode 100644 index 00000000..77df1527 --- /dev/null +++ b/aws/dist/botocore/data/codecommit/2015-04-13/service-2.json @@ -0,0 +1,6090 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-13", + "endpointPrefix":"codecommit", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CodeCommit", + "serviceFullName":"AWS CodeCommit", + "serviceId":"CodeCommit", + "signatureVersion":"v4", + "targetPrefix":"CodeCommit_20150413", + "uid":"codecommit-2015-04-13" + }, + "operations":{ + "BatchDescribeMergeConflicts":{ + "name":"BatchDescribeMergeConflicts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDescribeMergeConflictsInput"}, + "output":{"shape":"BatchDescribeMergeConflictsOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"MergeOptionRequiredException"}, + {"shape":"InvalidMergeOptionException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"CommitRequiredException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"InvalidMaxConflictFilesException"}, + {"shape":"InvalidMaxMergeHunksException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy.

" + }, + "BatchGetCommits":{ + "name":"BatchGetCommits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetCommitsInput"}, + "output":{"shape":"BatchGetCommitsOutput"}, + "errors":[ + {"shape":"CommitIdsListRequiredException"}, + {"shape":"CommitIdsLimitExceededException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about the contents of one or more commits in a repository.

" + }, + "BatchGetRepositories":{ + "name":"BatchGetRepositories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetRepositoriesInput"}, + "output":{"shape":"BatchGetRepositoriesOutput"}, + "errors":[ + {"shape":"RepositoryNamesRequiredException"}, + {"shape":"MaximumRepositoryNamesExceededException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" + }, + "CreateBranch":{ + "name":"CreateBranch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBranchInput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"BranchNameExistsException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Creates a new branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

" + }, + "CreateCommit":{ + "name":"CreateCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCommitInput"}, + "output":{"shape":"CreateCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"ParentCommitIdRequiredException"}, + {"shape":"InvalidParentCommitIdException"}, + {"shape":"ParentCommitDoesNotExistException"}, + {"shape":"ParentCommitIdOutdatedException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"FileEntryRequiredException"}, + {"shape":"MaximumFileEntriesExceededException"}, + {"shape":"PutFileEntryConflictException"}, + {"shape":"SourceFileOrContentRequiredException"}, + {"shape":"FileContentAndSourceFileSpecifiedException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"SamePathRequestException"}, + {"shape":"FileDoesNotExistException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"InvalidDeletionParameterException"}, + {"shape":"RestrictedSourceFileException"}, + {"shape":"FileModeRequiredException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"NoChangeException"}, + {"shape":"FileNameConflictsWithDirectoryNameException"}, + {"shape":"DirectoryNameConflictsWithFileNameException"}, + {"shape":"FilePathConflictsWithSubmodulePathException"} + ], + "documentation":"

Creates a commit for a repository on the tip of a specified branch.

" + }, + "CreatePullRequest":{ + "name":"CreatePullRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePullRequestInput"}, + "output":{"shape":"CreatePullRequestOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"ClientRequestTokenRequiredException"}, + {"shape":"InvalidClientRequestTokenException"}, + {"shape":"IdempotencyParameterMismatchException"}, + {"shape":"ReferenceNameRequiredException"}, + {"shape":"InvalidReferenceNameException"}, + {"shape":"ReferenceDoesNotExistException"}, + {"shape":"ReferenceTypeNotSupportedException"}, + {"shape":"TitleRequiredException"}, + {"shape":"InvalidTitleException"}, + {"shape":"InvalidDescriptionException"}, + {"shape":"TargetsRequiredException"}, + {"shape":"InvalidTargetsException"}, + {"shape":"TargetRequiredException"}, + {"shape":"InvalidTargetException"}, + {"shape":"MultipleRepositoriesInPullRequestException"}, + {"shape":"MaximumOpenPullRequestsExceededException"}, + {"shape":"SourceAndDestinationAreSameException"} + ], + "documentation":"

Creates a pull request in the specified repository.

" + }, + "CreateRepository":{ + "name":"CreateRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRepositoryInput"}, + "output":{"shape":"CreateRepositoryOutput"}, + "errors":[ + {"shape":"RepositoryNameExistsException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"InvalidRepositoryDescriptionException"}, + {"shape":"RepositoryLimitExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"InvalidTagsMapException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidSystemTagUsageException"}, + {"shape":"TagPolicyException"} + ], + "documentation":"

Creates a new, empty repository.

" + }, + "CreateUnreferencedMergeCommit":{ + "name":"CreateUnreferencedMergeCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUnreferencedMergeCommitInput"}, + "output":{"shape":"CreateUnreferencedMergeCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"MergeOptionRequiredException"}, + {"shape":"InvalidMergeOptionException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"InvalidConflictResolutionException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"MaximumConflictResolutionEntriesExceededException"}, + {"shape":"MultipleConflictResolutionEntriesException"}, + {"shape":"ReplacementTypeRequiredException"}, + {"shape":"InvalidReplacementTypeException"}, + {"shape":"ReplacementContentRequiredException"}, + {"shape":"InvalidReplacementContentException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"FileModeRequiredException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Creates an unreferenced commit that represents the result of merging two branches using a specified merge strategy. This can help you determine the outcome of a potential merge. This API cannot be used with the fast-forward merge strategy, as that strategy does not create a merge commit.

This unreferenced merge commit can only be accessed using the GetCommit API or through git commands such as git fetch. To retrieve this commit, you must specify its commit ID or otherwise reference it.

" + }, + "DeleteBranch":{ + "name":"DeleteBranch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBranchInput"}, + "output":{"shape":"DeleteBranchOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"DefaultBranchCannotBeDeletedException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Deletes a branch from a repository, unless that branch is the default branch for the repository.

" + }, + "DeleteCommentContent":{ + "name":"DeleteCommentContent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCommentContentInput"}, + "output":{"shape":"DeleteCommentContentOutput"}, + "errors":[ + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"}, + {"shape":"CommentDeletedException"} + ], + "documentation":"

Deletes the content of a comment made on a change, file, or commit in a repository.

" + }, + "DeleteFile":{ + "name":"DeleteFile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFileInput"}, + "output":{"shape":"DeleteFileOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"ParentCommitIdRequiredException"}, + {"shape":"InvalidParentCommitIdException"}, + {"shape":"ParentCommitDoesNotExistException"}, + {"shape":"ParentCommitIdOutdatedException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileDoesNotExistException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file will still exist in the commits prior to the commit that contains the deletion.

" + }, + "DeleteRepository":{ + "name":"DeleteRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRepositoryInput"}, + "output":{"shape":"DeleteRepositoryOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

" + }, + "DescribeMergeConflicts":{ + "name":"DescribeMergeConflicts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMergeConflictsInput"}, + "output":{"shape":"DescribeMergeConflictsOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"MergeOptionRequiredException"}, + {"shape":"InvalidMergeOptionException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"CommitRequiredException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileDoesNotExistException"}, + {"shape":"InvalidMaxMergeHunksException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about one or more merge conflicts in the attempted merge of two commit specifiers using the squash or three-way merge strategy. If the merge option for the attempted merge is specified as FAST_FORWARD_MERGE, an exception will be thrown.

" + }, + "DescribePullRequestEvents":{ + "name":"DescribePullRequestEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePullRequestEventsInput"}, + "output":{"shape":"DescribePullRequestEventsOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"InvalidPullRequestEventTypeException"}, + {"shape":"InvalidActorArnException"}, + {"shape":"ActorDoesNotExistException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about one or more pull request events.

" + }, + "GetBlob":{ + "name":"GetBlob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetBlobInput"}, + "output":{"shape":"GetBlobOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"BlobIdRequiredException"}, + {"shape":"InvalidBlobIdException"}, + {"shape":"BlobIdDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"FileTooLargeException"} + ], + "documentation":"

Returns the base-64 encoded content of an individual blob within a repository.

" + }, + "GetBranch":{ + "name":"GetBranch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetBranchInput"}, + "output":{"shape":"GetBranchOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about a repository branch, including its name and the last commit ID.

" + }, + "GetComment":{ + "name":"GetComment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommentInput"}, + "output":{"shape":"GetCommentOutput"}, + "errors":[ + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"}, + {"shape":"CommentDeletedException"} + ], + "documentation":"

Returns the content of a comment made on a change, file, or commit in a repository.

" + }, + "GetCommentsForComparedCommit":{ + "name":"GetCommentsForComparedCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommentsForComparedCommitInput"}, + "output":{"shape":"GetCommentsForComparedCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about comments made on the comparison between two commits.

" + }, + "GetCommentsForPullRequest":{ + "name":"GetCommentsForPullRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommentsForPullRequestInput"}, + "output":{"shape":"GetCommentsForPullRequestOutput"}, + "errors":[ + {"shape":"PullRequestIdRequiredException"}, + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"RepositoryNotAssociatedWithPullRequestException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns comments made on a pull request.

" + }, + "GetCommit":{ + "name":"GetCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommitInput"}, + "output":{"shape":"GetCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"CommitIdDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about a commit, including commit message and committer information.

" + }, + "GetDifferences":{ + "name":"GetDifferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDifferencesInput"}, + "output":{"shape":"GetDifferencesOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidPathException"}, + {"shape":"PathDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.

" + }, + "GetFile":{ + "name":"GetFile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFileInput"}, + "output":{"shape":"GetFileOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"FileTooLargeException"} + ], + "documentation":"

Returns the base-64 encoded contents of a specified file and its metadata.

" + }, + "GetFolder":{ + "name":"GetFolder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFolderInput"}, + "output":{"shape":"GetFolderOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FolderDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns the contents of a specified folder in a repository.

" + }, + "GetMergeCommit":{ + "name":"GetMergeCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMergeCommitInput"}, + "output":{"shape":"GetMergeCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about a specified merge commit.

" + }, + "GetMergeConflicts":{ + "name":"GetMergeConflicts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMergeConflictsInput"}, + "output":{"shape":"GetMergeConflictsOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"MergeOptionRequiredException"}, + {"shape":"InvalidMergeOptionException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"CommitRequiredException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"InvalidMaxConflictFilesException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidDestinationCommitSpecifierException"}, + {"shape":"InvalidSourceCommitSpecifierException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.

" + }, + "GetMergeOptions":{ + "name":"GetMergeOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMergeOptionsInput"}, + "output":{"shape":"GetMergeOptionsOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"CommitRequiredException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidCommitException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about the merge options available for merging two specified branches. For details about why a particular merge option is not available, use GetMergeConflicts or DescribeMergeConflicts.

" + }, + "GetPullRequest":{ + "name":"GetPullRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPullRequestInput"}, + "output":{"shape":"GetPullRequestOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Gets information about a pull request in a specified repository.

" + }, + "GetRepository":{ + "name":"GetRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRepositoryInput"}, + "output":{"shape":"GetRepositoryOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns information about a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" + }, + "GetRepositoryTriggers":{ + "name":"GetRepositoryTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRepositoryTriggersInput"}, + "output":{"shape":"GetRepositoryTriggersOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Gets information about triggers configured for a repository.

" + }, + "ListBranches":{ + "name":"ListBranches", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBranchesInput"}, + "output":{"shape":"ListBranchesOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"InvalidContinuationTokenException"} + ], + "documentation":"

Gets information about one or more branches in a repository.

" + }, + "ListPullRequests":{ + "name":"ListPullRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPullRequestsInput"}, + "output":{"shape":"ListPullRequestsOutput"}, + "errors":[ + {"shape":"InvalidPullRequestStatusException"}, + {"shape":"InvalidAuthorArnException"}, + {"shape":"AuthorDoesNotExistException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidContinuationTokenException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.

" + }, + "ListRepositories":{ + "name":"ListRepositories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRepositoriesInput"}, + "output":{"shape":"ListRepositoriesOutput"}, + "errors":[ + {"shape":"InvalidSortByException"}, + {"shape":"InvalidOrderException"}, + {"shape":"InvalidContinuationTokenException"} + ], + "documentation":"

Gets information about one or more repositories.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"ResourceArnRequiredException"}, + {"shape":"InvalidResourceArnException"} + ], + "documentation":"

Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

" + }, + "MergeBranchesByFastForward":{ + "name":"MergeBranchesByFastForward", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeBranchesByFastForwardInput"}, + "output":{"shape":"MergeBranchesByFastForwardOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidTargetBranchException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Merges two branches using the fast-forward merge strategy.

" + }, + "MergeBranchesBySquash":{ + "name":"MergeBranchesBySquash", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeBranchesBySquashInput"}, + "output":{"shape":"MergeBranchesBySquashOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidTargetBranchException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"InvalidConflictResolutionException"}, + {"shape":"MaximumConflictResolutionEntriesExceededException"}, + {"shape":"MultipleConflictResolutionEntriesException"}, + {"shape":"ReplacementTypeRequiredException"}, + {"shape":"InvalidReplacementTypeException"}, + {"shape":"ReplacementContentRequiredException"}, + {"shape":"InvalidReplacementContentException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"FileModeRequiredException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Merges two branches using the squash merge strategy.

" + }, + "MergeBranchesByThreeWay":{ + "name":"MergeBranchesByThreeWay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeBranchesByThreeWayInput"}, + "output":{"shape":"MergeBranchesByThreeWayOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"CommitRequiredException"}, + {"shape":"InvalidCommitException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidTargetBranchException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"InvalidConflictResolutionException"}, + {"shape":"MaximumConflictResolutionEntriesExceededException"}, + {"shape":"MultipleConflictResolutionEntriesException"}, + {"shape":"ReplacementTypeRequiredException"}, + {"shape":"InvalidReplacementTypeException"}, + {"shape":"ReplacementContentRequiredException"}, + {"shape":"InvalidReplacementContentException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"FileModeRequiredException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Merges two specified branches using the three-way merge strategy.

" + }, + "MergePullRequestByFastForward":{ + "name":"MergePullRequestByFastForward", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergePullRequestByFastForwardInput"}, + "output":{"shape":"MergePullRequestByFastForwardOutput"}, + "errors":[ + {"shape":"ManualMergeRequiredException"}, + {"shape":"PullRequestAlreadyClosedException"}, + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"TipOfSourceReferenceIsDifferentException"}, + {"shape":"ReferenceDoesNotExistException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"RepositoryNotAssociatedWithPullRequestException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge strategy. If the merge is successful, it closes the pull request.

" + }, + "MergePullRequestBySquash":{ + "name":"MergePullRequestBySquash", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergePullRequestBySquashInput"}, + "output":{"shape":"MergePullRequestBySquashOutput"}, + "errors":[ + {"shape":"PullRequestAlreadyClosedException"}, + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"TipOfSourceReferenceIsDifferentException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"InvalidConflictResolutionException"}, + {"shape":"ReplacementTypeRequiredException"}, + {"shape":"InvalidReplacementTypeException"}, + {"shape":"MultipleConflictResolutionEntriesException"}, + {"shape":"ReplacementContentRequiredException"}, + {"shape":"MaximumConflictResolutionEntriesExceededException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"InvalidReplacementContentException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"RepositoryNotAssociatedWithPullRequestException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the squash merge strategy. If the merge is successful, it closes the pull request.

" + }, + "MergePullRequestByThreeWay":{ + "name":"MergePullRequestByThreeWay", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergePullRequestByThreeWayInput"}, + "output":{"shape":"MergePullRequestByThreeWayOutput"}, + "errors":[ + {"shape":"PullRequestAlreadyClosedException"}, + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"ManualMergeRequiredException"}, + {"shape":"TipOfSourceReferenceIsDifferentException"}, + {"shape":"TipsDivergenceExceededException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"InvalidConflictDetailLevelException"}, + {"shape":"InvalidConflictResolutionStrategyException"}, + {"shape":"InvalidConflictResolutionException"}, + {"shape":"ReplacementTypeRequiredException"}, + {"shape":"InvalidReplacementTypeException"}, + {"shape":"MultipleConflictResolutionEntriesException"}, + {"shape":"ReplacementContentRequiredException"}, + {"shape":"MaximumConflictResolutionEntriesExceededException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"InvalidReplacementContentException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"MaximumFileContentToLoadExceededException"}, + {"shape":"MaximumItemsToCompareExceededException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"RepositoryNotAssociatedWithPullRequestException"}, + {"shape":"ConcurrentReferenceUpdateException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the three-way merge strategy. If the merge is successful, it closes the pull request.

" + }, + "PostCommentForComparedCommit":{ + "name":"PostCommentForComparedCommit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PostCommentForComparedCommitInput"}, + "output":{"shape":"PostCommentForComparedCommitOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"ClientRequestTokenRequiredException"}, + {"shape":"InvalidClientRequestTokenException"}, + {"shape":"IdempotencyParameterMismatchException"}, + {"shape":"CommentContentRequiredException"}, + {"shape":"CommentContentSizeLimitExceededException"}, + {"shape":"InvalidFileLocationException"}, + {"shape":"InvalidRelativeFileVersionEnumException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidFilePositionException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidPathException"}, + {"shape":"PathDoesNotExistException"} + ], + "documentation":"

Posts a comment on the comparison between two commits.

", + "idempotent":true + }, + "PostCommentForPullRequest":{ + "name":"PostCommentForPullRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PostCommentForPullRequestInput"}, + "output":{"shape":"PostCommentForPullRequestOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"RepositoryNotAssociatedWithPullRequestException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"ClientRequestTokenRequiredException"}, + {"shape":"InvalidClientRequestTokenException"}, + {"shape":"IdempotencyParameterMismatchException"}, + {"shape":"CommentContentRequiredException"}, + {"shape":"CommentContentSizeLimitExceededException"}, + {"shape":"InvalidFileLocationException"}, + {"shape":"InvalidRelativeFileVersionEnumException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidFilePositionException"}, + {"shape":"CommitIdRequiredException"}, + {"shape":"InvalidCommitIdException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"CommitDoesNotExistException"}, + {"shape":"InvalidPathException"}, + {"shape":"PathDoesNotExistException"}, + {"shape":"PathRequiredException"}, + {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"} + ], + "documentation":"

Posts a comment on a pull request.

", + "idempotent":true + }, + "PostCommentReply":{ + "name":"PostCommentReply", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PostCommentReplyInput"}, + "output":{"shape":"PostCommentReplyOutput"}, + "errors":[ + {"shape":"ClientRequestTokenRequiredException"}, + {"shape":"InvalidClientRequestTokenException"}, + {"shape":"IdempotencyParameterMismatchException"}, + {"shape":"CommentContentRequiredException"}, + {"shape":"CommentContentSizeLimitExceededException"}, + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"} + ], + "documentation":"

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

", + "idempotent":true + }, + "PutFile":{ + "name":"PutFile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutFileInput"}, + "output":{"shape":"PutFileOutput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"ParentCommitIdRequiredException"}, + {"shape":"InvalidParentCommitIdException"}, + {"shape":"ParentCommitDoesNotExistException"}, + {"shape":"ParentCommitIdOutdatedException"}, + {"shape":"FileContentRequiredException"}, + {"shape":"FileContentSizeLimitExceededException"}, + {"shape":"FolderContentSizeLimitExceededException"}, + {"shape":"PathRequiredException"}, + {"shape":"InvalidPathException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"BranchNameIsTagNameException"}, + {"shape":"InvalidFileModeException"}, + {"shape":"NameLengthExceededException"}, + {"shape":"InvalidEmailException"}, + {"shape":"CommitMessageLengthExceededException"}, + {"shape":"InvalidDeletionParameterException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"}, + {"shape":"SameFileContentException"}, + {"shape":"FileNameConflictsWithDirectoryNameException"}, + {"shape":"DirectoryNameConflictsWithFileNameException"}, + {"shape":"FilePathConflictsWithSubmodulePathException"} + ], + "documentation":"

Adds or updates a file in a branch in an AWS CodeCommit repository, and generates a commit for the addition in the specified branch.

" + }, + "PutRepositoryTriggers":{ + "name":"PutRepositoryTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRepositoryTriggersInput"}, + "output":{"shape":"PutRepositoryTriggersOutput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryTriggersListRequiredException"}, + {"shape":"MaximumRepositoryTriggersExceededException"}, + {"shape":"InvalidRepositoryTriggerNameException"}, + {"shape":"InvalidRepositoryTriggerDestinationArnException"}, + {"shape":"InvalidRepositoryTriggerRegionException"}, + {"shape":"InvalidRepositoryTriggerCustomDataException"}, + {"shape":"MaximumBranchesExceededException"}, + {"shape":"InvalidRepositoryTriggerBranchNameException"}, + {"shape":"InvalidRepositoryTriggerEventsException"}, + {"shape":"RepositoryTriggerNameRequiredException"}, + {"shape":"RepositoryTriggerDestinationArnRequiredException"}, + {"shape":"RepositoryTriggerBranchNameListRequiredException"}, + {"shape":"RepositoryTriggerEventsListRequiredException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Replaces all triggers for a repository. This can be used to create or delete triggers.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"ResourceArnRequiredException"}, + {"shape":"InvalidResourceArnException"}, + {"shape":"TagsMapRequiredException"}, + {"shape":"InvalidTagsMapException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidSystemTagUsageException"}, + {"shape":"TagPolicyException"} + ], + "documentation":"

Adds or updates tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

" + }, + "TestRepositoryTriggers":{ + "name":"TestRepositoryTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestRepositoryTriggersInput"}, + "output":{"shape":"TestRepositoryTriggersOutput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"RepositoryTriggersListRequiredException"}, + {"shape":"MaximumRepositoryTriggersExceededException"}, + {"shape":"InvalidRepositoryTriggerNameException"}, + {"shape":"InvalidRepositoryTriggerDestinationArnException"}, + {"shape":"InvalidRepositoryTriggerRegionException"}, + {"shape":"InvalidRepositoryTriggerCustomDataException"}, + {"shape":"MaximumBranchesExceededException"}, + {"shape":"InvalidRepositoryTriggerBranchNameException"}, + {"shape":"InvalidRepositoryTriggerEventsException"}, + {"shape":"RepositoryTriggerNameRequiredException"}, + {"shape":"RepositoryTriggerDestinationArnRequiredException"}, + {"shape":"RepositoryTriggerBranchNameListRequiredException"}, + {"shape":"RepositoryTriggerEventsListRequiredException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"ResourceArnRequiredException"}, + {"shape":"InvalidResourceArnException"}, + {"shape":"TagKeysListRequiredException"}, + {"shape":"InvalidTagKeysListException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidSystemTagUsageException"}, + {"shape":"TagPolicyException"} + ], + "documentation":"

Removes tags for a resource in AWS CodeCommit. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

" + }, + "UpdateComment":{ + "name":"UpdateComment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCommentInput"}, + "output":{"shape":"UpdateCommentOutput"}, + "errors":[ + {"shape":"CommentContentRequiredException"}, + {"shape":"CommentContentSizeLimitExceededException"}, + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"}, + {"shape":"CommentNotCreatedByCallerException"}, + {"shape":"CommentDeletedException"} + ], + "documentation":"

Replaces the contents of a comment.

" + }, + "UpdateDefaultBranch":{ + "name":"UpdateDefaultBranch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDefaultBranchInput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"BranchNameRequiredException"}, + {"shape":"InvalidBranchNameException"}, + {"shape":"BranchDoesNotExistException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Sets or changes the default branch name for the specified repository.

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

" + }, + "UpdatePullRequestDescription":{ + "name":"UpdatePullRequestDescription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePullRequestDescriptionInput"}, + "output":{"shape":"UpdatePullRequestDescriptionOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"InvalidDescriptionException"}, + {"shape":"PullRequestAlreadyClosedException"} + ], + "documentation":"

Replaces the contents of the description of a pull request.

" + }, + "UpdatePullRequestStatus":{ + "name":"UpdatePullRequestStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePullRequestStatusInput"}, + "output":{"shape":"UpdatePullRequestStatusOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"InvalidPullRequestStatusUpdateException"}, + {"shape":"InvalidPullRequestStatusException"}, + {"shape":"PullRequestStatusRequiredException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Updates the status of a pull request.

" + }, + "UpdatePullRequestTitle":{ + "name":"UpdatePullRequestTitle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePullRequestTitleInput"}, + "output":{"shape":"UpdatePullRequestTitleOutput"}, + "errors":[ + {"shape":"PullRequestDoesNotExistException"}, + {"shape":"InvalidPullRequestIdException"}, + {"shape":"PullRequestIdRequiredException"}, + {"shape":"TitleRequiredException"}, + {"shape":"InvalidTitleException"}, + {"shape":"PullRequestAlreadyClosedException"} + ], + "documentation":"

Replaces the title of a pull request.

" + }, + "UpdateRepositoryDescription":{ + "name":"UpdateRepositoryDescription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRepositoryDescriptionInput"}, + "errors":[ + {"shape":"RepositoryNameRequiredException"}, + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"InvalidRepositoryNameException"}, + {"shape":"InvalidRepositoryDescriptionException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" + }, + "UpdateRepositoryName":{ + "name":"UpdateRepositoryName", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRepositoryNameInput"}, + "errors":[ + {"shape":"RepositoryDoesNotExistException"}, + {"shape":"RepositoryNameExistsException"}, + {"shape":"RepositoryNameRequiredException"}, + {"shape":"InvalidRepositoryNameException"} + ], + "documentation":"

Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix \".git\" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide.

" + } + }, + "shapes":{ + "AccountId":{"type":"string"}, + "ActorDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon Resource Name (ARN) does not exist in the AWS account.

", + "exception":true + }, + "AdditionalData":{"type":"string"}, + "Arn":{"type":"string"}, + "AuthorDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon Resource Name (ARN) does not exist in the AWS account.

", + "exception":true + }, + "BatchDescribeMergeConflictsError":{ + "type":"structure", + "required":[ + "filePath", + "exceptionName", + "message" + ], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The path to the file.

" + }, + "exceptionName":{ + "shape":"ExceptionName", + "documentation":"

The name of the exception.

" + }, + "message":{ + "shape":"Message", + "documentation":"

The message provided by the exception.

" + } + }, + "documentation":"

Information about errors in a BatchDescribeMergeConflicts operation.

" + }, + "BatchDescribeMergeConflictsErrors":{ + "type":"list", + "member":{"shape":"BatchDescribeMergeConflictsError"} + }, + "BatchDescribeMergeConflictsInput":{ + "type":"structure", + "required":[ + "repositoryName", + "destinationCommitSpecifier", + "sourceCommitSpecifier", + "mergeOption" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the merge conflicts you want to review.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "mergeOption":{ + "shape":"MergeOptionTypeEnum", + "documentation":"

The merge option or strategy you want to use to merge the code.

" + }, + "maxMergeHunks":{ + "shape":"MaxResults", + "documentation":"

The maximum number of merge hunks to include in the output.

" + }, + "maxConflictFiles":{ + "shape":"MaxResults", + "documentation":"

The maximum number of files to include in the output.

" + }, + "filePaths":{ + "shape":"FilePaths", + "documentation":"

The path of the target files used to describe the conflicts. If not specified, the default is all conflict files.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "BatchDescribeMergeConflictsOutput":{ + "type":"structure", + "required":[ + "conflicts", + "destinationCommitId", + "sourceCommitId" + ], + "members":{ + "conflicts":{ + "shape":"Conflicts", + "documentation":"

A list of conflicts for each file, including the conflict metadata and the hunks of the differences between the files.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + }, + "errors":{ + "shape":"BatchDescribeMergeConflictsErrors", + "documentation":"

A list of any errors returned while describing the merge conflicts for each file.

" + }, + "destinationCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the source commit specifier that was used in the merge evaluation.

" + }, + "baseCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge base.

" + } + } + }, + "BatchGetCommitsError":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

A commit ID that either could not be found or was not in a valid format.

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

An error code that specifies whether the commit ID was not valid or not found.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

An error message that provides detail about why the commit ID either was not found or was not valid.

" + } + }, + "documentation":"

Returns information about errors in a BatchGetCommits operation.

" + }, + "BatchGetCommitsErrorsList":{ + "type":"list", + "member":{"shape":"BatchGetCommitsError"} + }, + "BatchGetCommitsInput":{ + "type":"structure", + "required":[ + "commitIds", + "repositoryName" + ], + "members":{ + "commitIds":{ + "shape":"CommitIdsInputList", + "documentation":"

The full commit IDs of the commits to get information about.

You must supply the full SHAs of each commit. You cannot use shortened SHAs.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the commits.

" + } + } + }, + "BatchGetCommitsOutput":{ + "type":"structure", + "members":{ + "commits":{ + "shape":"CommitObjectsList", + "documentation":"

An array of commit data type objects, each of which contains information about a specified commit.

" + }, + "errors":{ + "shape":"BatchGetCommitsErrorsList", + "documentation":"

Returns any commit IDs for which information could not be found. For example, if one of the commit IDs was a shortened SHA or that commit was not found in the specified repository, the ID will return an error object with additional information.

" + } + } + }, + "BatchGetRepositoriesInput":{ + "type":"structure", + "required":["repositoryNames"], + "members":{ + "repositoryNames":{ + "shape":"RepositoryNameList", + "documentation":"

The names of the repositories to get information about.

" + } + }, + "documentation":"

Represents the input of a batch get repositories operation.

" + }, + "BatchGetRepositoriesOutput":{ + "type":"structure", + "members":{ + "repositories":{ + "shape":"RepositoryMetadataList", + "documentation":"

A list of repositories returned by the batch get repositories operation.

" + }, + "repositoriesNotFound":{ + "shape":"RepositoryNotFoundList", + "documentation":"

Returns a list of repository names for which information could not be found.

" + } + }, + "documentation":"

Represents the output of a batch get repositories operation.

" + }, + "BeforeCommitIdAndAfterCommitIdAreSameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The before commit ID and the after commit ID are the same, which is not valid. The before commit ID and the after commit ID must be different commit IDs.

", + "exception":true + }, + "BlobIdDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified blob does not exist.

", + "exception":true + }, + "BlobIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A blob ID is required but was not specified.

", + "exception":true + }, + "BlobMetadata":{ + "type":"structure", + "members":{ + "blobId":{ + "shape":"ObjectId", + "documentation":"

The full ID of the blob.

" + }, + "path":{ + "shape":"Path", + "documentation":"

The path to the blob and any associated file name, if any.

" + }, + "mode":{ + "shape":"Mode", + "documentation":"

The file mode permissions of the blob. File mode permission codes include:

  • 100644 indicates read/write

  • 100755 indicates read/write/execute

  • 160000 indicates a submodule

  • 120000 indicates a symlink

" + } + }, + "documentation":"

Returns information about a specific Git blob object.

" + }, + "BranchDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified branch does not exist.

", + "exception":true + }, + "BranchInfo":{ + "type":"structure", + "members":{ + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch.

" + }, + "commitId":{ + "shape":"CommitId", + "documentation":"

The ID of the last commit made to the branch.

" + } + }, + "documentation":"

Returns information about a branch.

" + }, + "BranchName":{ + "type":"string", + "max":256, + "min":1 + }, + "BranchNameExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified branch name already exists.

", + "exception":true + }, + "BranchNameIsTagNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified branch name is not valid because it is a tag name. Type the name of a current branch in the repository. For a list of valid branch names, use ListBranches.

", + "exception":true + }, + "BranchNameList":{ + "type":"list", + "member":{"shape":"BranchName"} + }, + "BranchNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A branch name is required but was not specified.

", + "exception":true + }, + "CapitalBoolean":{"type":"boolean"}, + "ChangeTypeEnum":{ + "type":"string", + "enum":[ + "A", + "M", + "D" + ] + }, + "ClientRequestToken":{"type":"string"}, + "ClientRequestTokenRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A client request token is required. A client request token is an unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

", + "exception":true + }, + "CloneUrlHttp":{"type":"string"}, + "CloneUrlSsh":{"type":"string"}, + "Comment":{ + "type":"structure", + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The system-generated comment ID.

" + }, + "content":{ + "shape":"Content", + "documentation":"

The content of the comment.

" + }, + "inReplyTo":{ + "shape":"CommentId", + "documentation":"

The ID of the comment for which this comment is a reply, if any.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The date and time the comment was created, in timestamp format.

" + }, + "lastModifiedDate":{ + "shape":"LastModifiedDate", + "documentation":"

The date and time the comment was most recently modified, in timestamp format.

" + }, + "authorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the person who posted the comment.

" + }, + "deleted":{ + "shape":"IsCommentDeleted", + "documentation":"

A Boolean value indicating whether the comment has been deleted.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

" + } + }, + "documentation":"

Returns information about a specific comment.

" + }, + "CommentContentRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The comment is empty. You must provide some content for a comment. The content cannot be null.

", + "exception":true + }, + "CommentContentSizeLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The comment is too large. Comments are limited to 1,000 characters.

", + "exception":true + }, + "CommentDeletedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This comment has already been deleted. You cannot edit or delete a deleted comment.

", + "exception":true + }, + "CommentDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

No comment exists with the provided ID. Verify that you have provided the correct ID, and then try again.

", + "exception":true + }, + "CommentId":{"type":"string"}, + "CommentIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The comment ID is missing or null. A comment ID is required.

", + "exception":true + }, + "CommentNotCreatedByCallerException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot modify or delete this comment. Only comment authors can modify or delete their comments.

", + "exception":true + }, + "Comments":{ + "type":"list", + "member":{"shape":"Comment"} + }, + "CommentsForComparedCommit":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the compared commits.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit used to establish the 'before' of the comparison.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit used to establish the 'after' of the comparison.

" + }, + "beforeBlobId":{ + "shape":"ObjectId", + "documentation":"

The full blob ID of the commit used to establish the 'before' of the comparison.

" + }, + "afterBlobId":{ + "shape":"ObjectId", + "documentation":"

The full blob ID of the commit used to establish the 'after' of the comparison.

" + }, + "location":{ + "shape":"Location", + "documentation":"

Location information about the comment on the comparison, including the file name, line number, and whether the version of the file where the comment was made is 'BEFORE' or 'AFTER'.

" + }, + "comments":{ + "shape":"Comments", + "documentation":"

An array of comment objects. Each comment object contains information about a comment on the comparison between commits.

" + } + }, + "documentation":"

Returns information about comments on the comparison between two commits.

" + }, + "CommentsForComparedCommitData":{ + "type":"list", + "member":{"shape":"CommentsForComparedCommit"} + }, + "CommentsForPullRequest":{ + "type":"structure", + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the pull request.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit that was the tip of the destination branch when the pull request was created. This commit will be superceded by the after commit in the source branch when and if you merge the source branch into the destination branch.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

he full commit ID of the commit that was the tip of the source branch at the time the comment was made.

" + }, + "beforeBlobId":{ + "shape":"ObjectId", + "documentation":"

The full blob ID of the file on which you want to comment on the destination commit.

" + }, + "afterBlobId":{ + "shape":"ObjectId", + "documentation":"

The full blob ID of the file on which you want to comment on the source commit.

" + }, + "location":{ + "shape":"Location", + "documentation":"

Location information about the comment on the pull request, including the file name, line number, and whether the version of the file where the comment was made is 'BEFORE' (destination branch) or 'AFTER' (source branch).

" + }, + "comments":{ + "shape":"Comments", + "documentation":"

An array of comment objects. Each comment object contains information about a comment on the pull request.

" + } + }, + "documentation":"

Returns information about comments on a pull request.

" + }, + "CommentsForPullRequestData":{ + "type":"list", + "member":{"shape":"CommentsForPullRequest"} + }, + "Commit":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full SHA of the specified commit.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

Tree information for the specified commit.

" + }, + "parents":{ + "shape":"ParentList", + "documentation":"

A list of parent commits for the specified commit. Each parent commit ID is the full commit ID.

" + }, + "message":{ + "shape":"Message", + "documentation":"

The commit message associated with the specified commit.

" + }, + "author":{ + "shape":"UserInfo", + "documentation":"

Information about the author of the specified commit. Information includes the date in timestamp format with GMT offset, the name of the author, and the email address for the author, as configured in Git.

" + }, + "committer":{ + "shape":"UserInfo", + "documentation":"

Information about the person who committed the specified commit, also known as the committer. Information includes the date in timestamp format with GMT offset, the name of the committer, and the email address for the committer, as configured in Git.

For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.

" + }, + "additionalData":{ + "shape":"AdditionalData", + "documentation":"

Any additional data associated with the specified commit.

" + } + }, + "documentation":"

Returns information about a specific commit.

" + }, + "CommitDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified commit does not exist or no commit was specified, and the specified repository has no default branch.

", + "exception":true + }, + "CommitId":{"type":"string"}, + "CommitIdDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified commit ID does not exist.

", + "exception":true + }, + "CommitIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A commit ID was not specified.

", + "exception":true + }, + "CommitIdsInputList":{ + "type":"list", + "member":{"shape":"ObjectId"} + }, + "CommitIdsLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of allowed commit IDs in a batch request is 100. Verify that your batch requests contains no more than 100 commit IDs, and then try again.

", + "exception":true + }, + "CommitIdsListRequiredException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "CommitMessageLengthExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit message is too long. Provide a shorter string.

", + "exception":true + }, + "CommitName":{"type":"string"}, + "CommitObjectsList":{ + "type":"list", + "member":{"shape":"Commit"} + }, + "CommitRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A commit was not specified.

", + "exception":true + }, + "ConcurrentReferenceUpdateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The merge cannot be completed because the target branch has been modified. Another user might have modified the target branch while the merge was in progress. Wait a few minutes, and then try again.

", + "exception":true + }, + "Conflict":{ + "type":"structure", + "members":{ + "conflictMetadata":{ + "shape":"ConflictMetadata", + "documentation":"

Metadata about a conflict in a merge operation.

" + }, + "mergeHunks":{ + "shape":"MergeHunks", + "documentation":"

A list of hunks that contain the differences between files or lines causing the conflict.

" + } + }, + "documentation":"

Information about conflicts in a merge operation.

" + }, + "ConflictDetailLevelTypeEnum":{ + "type":"string", + "enum":[ + "FILE_LEVEL", + "LINE_LEVEL" + ] + }, + "ConflictMetadata":{ + "type":"structure", + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The path of the file that contains conflicts.

" + }, + "fileSizes":{ + "shape":"FileSizes", + "documentation":"

The file sizes of the file in the source, destination, and base of the merge.

" + }, + "fileModes":{ + "shape":"FileModes", + "documentation":"

The file modes of the file in the source, destination, and base of the merge.

" + }, + "objectTypes":{ + "shape":"ObjectTypes", + "documentation":"

Information about any object type conflicts in a merge operation.

" + }, + "numberOfConflicts":{ + "shape":"NumberOfConflicts", + "documentation":"

The number of conflicts, including both hunk conflicts and metadata conflicts.

" + }, + "isBinaryFile":{ + "shape":"IsBinaryFile", + "documentation":"

A boolean value (true or false) indicating whether the file is binary or textual in the source, destination, and base of the merge.

" + }, + "contentConflict":{ + "shape":"IsContentConflict", + "documentation":"

A boolean value indicating whether there are conflicts in the content of a file.

" + }, + "fileModeConflict":{ + "shape":"IsFileModeConflict", + "documentation":"

A boolean value indicating whether there are conflicts in the file mode of a file.

" + }, + "objectTypeConflict":{ + "shape":"IsObjectTypeConflict", + "documentation":"

A boolean value (true or false) indicating whether there are conflicts between the branches in the object type of a file, folder, or submodule.

" + }, + "mergeOperations":{ + "shape":"MergeOperations", + "documentation":"

Whether an add, modify, or delete operation caused the conflict between the source and destination of the merge.

" + } + }, + "documentation":"

Information about the metadata for a conflict in a merge operation.

" + }, + "ConflictMetadataList":{ + "type":"list", + "member":{"shape":"ConflictMetadata"} + }, + "ConflictResolution":{ + "type":"structure", + "members":{ + "replaceContents":{ + "shape":"ReplaceContentEntries", + "documentation":"

Files that will have content replaced as part of the merge conflict resolution.

" + }, + "deleteFiles":{ + "shape":"DeleteFileEntries", + "documentation":"

Files that will be deleted as part of the merge conflict resolution.

" + }, + "setFileModes":{ + "shape":"SetFileModeEntries", + "documentation":"

File modes that will be set as part of the merge conflict resolution.

" + } + }, + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + }, + "ConflictResolutionStrategyTypeEnum":{ + "type":"string", + "enum":[ + "NONE", + "ACCEPT_SOURCE", + "ACCEPT_DESTINATION", + "AUTOMERGE" + ] + }, + "Conflicts":{ + "type":"list", + "member":{"shape":"Conflict"} + }, + "Content":{"type":"string"}, + "CreateBranchInput":{ + "type":"structure", + "required":[ + "repositoryName", + "branchName", + "commitId" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository in which you want to create the new branch.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the new branch to create.

" + }, + "commitId":{ + "shape":"CommitId", + "documentation":"

The ID of the commit to point the new branch to.

" + } + }, + "documentation":"

Represents the input of a create branch operation.

" + }, + "CreateCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "branchName" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you will create the commit.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch where you will create the commit.

" + }, + "parentCommitId":{ + "shape":"CommitId", + "documentation":"

The ID of the commit that is the parent of the commit you will create. If this is an empty repository, this is not required.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address of the person who created the commit.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message you want to include as part of creating the commit. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "putFiles":{ + "shape":"PutFileEntries", + "documentation":"

The files to add or update in this commit.

" + }, + "deleteFiles":{ + "shape":"DeleteFileEntries", + "documentation":"

The files to delete in this commit. These files will still exist in prior commits.

" + }, + "setFileModes":{ + "shape":"SetFileModeEntries", + "documentation":"

The file modes to update for files in this commit.

" + } + } + }, + "CreateCommitOutput":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the commit that contains your committed file changes.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains the commited file changes.

" + }, + "filesAdded":{ + "shape":"FilesMetadata", + "documentation":"

The files added as part of the committed file changes.

" + }, + "filesUpdated":{ + "shape":"FilesMetadata", + "documentation":"

The files updated as part of the commited file changes.

" + }, + "filesDeleted":{ + "shape":"FilesMetadata", + "documentation":"

The files deleted as part of the committed file changes.

" + } + } + }, + "CreatePullRequestInput":{ + "type":"structure", + "required":[ + "title", + "targets" + ], + "members":{ + "title":{ + "shape":"Title", + "documentation":"

The title of the pull request. This title will be used to identify the pull request to other users in the repository.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the pull request.

" + }, + "targets":{ + "shape":"TargetList", + "documentation":"

The targets for the pull request, including the source of the code to be reviewed (the source branch), and the destination where the creator of the pull request intends the code to be merged after the pull request is closed (the destination branch).

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If using an AWS SDK, you do not have to generate an idempotency token, as this will be done for you.

", + "idempotencyToken":true + } + } + }, + "CreatePullRequestOutput":{ + "type":"structure", + "required":["pullRequest"], + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the newly created pull request.

" + } + } + }, + "CreateRepositoryInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the new repository to be created.

The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. The suffix \".git\" is prohibited.

" + }, + "repositoryDescription":{ + "shape":"RepositoryDescription", + "documentation":"

A comment or description about the new repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"

One or more tag key-value pairs to use when tagging this repository.

" + } + }, + "documentation":"

Represents the input of a create repository operation.

" + }, + "CreateRepositoryOutput":{ + "type":"structure", + "members":{ + "repositoryMetadata":{ + "shape":"RepositoryMetadata", + "documentation":"

Information about the newly created repository.

" + } + }, + "documentation":"

Represents the output of a create repository operation.

" + }, + "CreateUnreferencedMergeCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier", + "mergeOption" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to create the unreferenced merge commit.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "mergeOption":{ + "shape":"MergeOptionTypeEnum", + "documentation":"

The merge option or strategy you want to use to merge the code.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the unreferenced commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address for the person who created the unreferenced commit.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message for the unreferenced commit.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "conflictResolution":{ + "shape":"ConflictResolution", + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + } + } + }, + "CreateUnreferencedMergeCommitOutput":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the commit that contains your merge results.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains the merge results.

" + } + } + }, + "CreationDate":{"type":"timestamp"}, + "Date":{"type":"string"}, + "DefaultBranchCannotBeDeletedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified branch is the default branch for the repository, and cannot be deleted. To delete this branch, you must first set another branch as the default branch.

", + "exception":true + }, + "DeleteBranchInput":{ + "type":"structure", + "required":[ + "repositoryName", + "branchName" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the branch to be deleted.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch to delete.

" + } + }, + "documentation":"

Represents the input of a delete branch operation.

" + }, + "DeleteBranchOutput":{ + "type":"structure", + "members":{ + "deletedBranch":{ + "shape":"BranchInfo", + "documentation":"

Information about the branch deleted by the operation, including the branch name and the commit ID that was the tip of the branch.

" + } + }, + "documentation":"

Represents the output of a delete branch operation.

" + }, + "DeleteCommentContentInput":{ + "type":"structure", + "required":["commentId"], + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

" + } + } + }, + "DeleteCommentContentOutput":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"Comment", + "documentation":"

Information about the comment you just deleted.

" + } + } + }, + "DeleteFileEntries":{ + "type":"list", + "member":{"shape":"DeleteFileEntry"} + }, + "DeleteFileEntry":{ + "type":"structure", + "required":["filePath"], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The full path of the file that will be deleted, including the name of the file.

" + } + }, + "documentation":"

A file that will be deleted as part of a commit.

" + }, + "DeleteFileInput":{ + "type":"structure", + "required":[ + "repositoryName", + "branchName", + "filePath", + "parentCommitId" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the file to delete.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch where the commit will be made deleting the file.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the file that will be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.

" + }, + "parentCommitId":{ + "shape":"CommitId", + "documentation":"

The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file. This must be the HEAD commit for the branch. The commit that deletes the file will be created from this commit ID.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 will also delete the empty folders dir4, dir3, and dir2.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the author of the commit that deletes the file. If no name is specified, the user's ARN will be used as the author name and committer name.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address for the commit that deletes the file. If no email address is specified, the email address will be left blank.

" + } + } + }, + "DeleteFileOutput":{ + "type":"structure", + "required":[ + "commitId", + "blobId", + "treeId", + "filePath" + ], + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the commit that contains the change that deletes the file.

" + }, + "blobId":{ + "shape":"ObjectId", + "documentation":"

The blob ID removed from the tree as part of deleting the file.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains the delete file change.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the file that will be deleted, including the full name and extension of that file.

" + } + } + }, + "DeleteRepositoryInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to delete.

" + } + }, + "documentation":"

Represents the input of a delete repository operation.

" + }, + "DeleteRepositoryOutput":{ + "type":"structure", + "members":{ + "repositoryId":{ + "shape":"RepositoryId", + "documentation":"

The ID of the repository that was deleted.

" + } + }, + "documentation":"

Represents the output of a delete repository operation.

" + }, + "DescribeMergeConflictsInput":{ + "type":"structure", + "required":[ + "repositoryName", + "destinationCommitSpecifier", + "sourceCommitSpecifier", + "mergeOption", + "filePath" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to get information about a merge conflict.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "mergeOption":{ + "shape":"MergeOptionTypeEnum", + "documentation":"

The merge option or strategy you want to use to merge the code.

" + }, + "maxMergeHunks":{ + "shape":"MaxResults", + "documentation":"

The maximum number of merge hunks to include in the output.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The path of the target files used to describe the conflicts.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "DescribeMergeConflictsOutput":{ + "type":"structure", + "required":[ + "conflictMetadata", + "mergeHunks", + "destinationCommitId", + "sourceCommitId" + ], + "members":{ + "conflictMetadata":{ + "shape":"ConflictMetadata", + "documentation":"

Contains metadata about the conflicts found in the merge.

" + }, + "mergeHunks":{ + "shape":"MergeHunks", + "documentation":"

A list of merge hunks of the differences between the files or lines.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + }, + "destinationCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the source commit specifier that was used in the merge evaluation.

" + }, + "baseCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge base.

" + } + } + }, + "DescribePullRequestEventsInput":{ + "type":"structure", + "required":["pullRequestId"], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "pullRequestEventType":{ + "shape":"PullRequestEventType", + "documentation":"

Optional. The pull request event type about which you want to return information.

" + }, + "actorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The default is 100 events, which is also the maximum number of events that can be returned in a result.

" + } + } + }, + "DescribePullRequestEventsOutput":{ + "type":"structure", + "required":["pullRequestEvents"], + "members":{ + "pullRequestEvents":{ + "shape":"PullRequestEventList", + "documentation":"

Information about the pull request events.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "Description":{ + "type":"string", + "max":10240 + }, + "Difference":{ + "type":"structure", + "members":{ + "beforeBlob":{ + "shape":"BlobMetadata", + "documentation":"

Information about a beforeBlob data type object, including the ID, the file mode permission code, and the path.

" + }, + "afterBlob":{ + "shape":"BlobMetadata", + "documentation":"

Information about an afterBlob data type object, including the ID, the file mode permission code, and the path.

" + }, + "changeType":{ + "shape":"ChangeTypeEnum", + "documentation":"

Whether the change type of the difference is an addition (A), deletion (D), or modification (M).

" + } + }, + "documentation":"

Returns information about a set of differences for a commit specifier.

" + }, + "DifferenceList":{ + "type":"list", + "member":{"shape":"Difference"} + }, + "DirectoryNameConflictsWithFileNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A file cannot be added to the repository because the specified path name has the same name as a file that already exists in this repository. Either provide a different name for the file, or specify a different path for the file.

", + "exception":true + }, + "Email":{"type":"string"}, + "EncryptionIntegrityChecksFailedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An encryption integrity check failed.

", + "exception":true, + "fault":true + }, + "EncryptionKeyAccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An encryption key could not be accessed.

", + "exception":true + }, + "EncryptionKeyDisabledException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The encryption key is disabled.

", + "exception":true + }, + "EncryptionKeyNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

No encryption key was found.

", + "exception":true + }, + "EncryptionKeyUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The encryption key is not available.

", + "exception":true + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "EventDate":{"type":"timestamp"}, + "ExceptionName":{"type":"string"}, + "File":{ + "type":"structure", + "members":{ + "blobId":{ + "shape":"ObjectId", + "documentation":"

The blob ID that contains the file information.

" + }, + "absolutePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the file in the repository.

" + }, + "relativePath":{ + "shape":"Path", + "documentation":"

The relative path of the file from the folder where the query originated.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

" + } + }, + "documentation":"

Returns information about a file in a repository.

" + }, + "FileContent":{ + "type":"blob", + "max":6291456 + }, + "FileContentAndSourceFileSpecifiedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because both a source file and file content have been specified for the same file. You cannot provide both. Either specify a source file, or provide the file content directly.

", + "exception":true + }, + "FileContentRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The file cannot be added because it is empty. Empty files cannot be added to the repository with this API.

", + "exception":true + }, + "FileContentSizeLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The file cannot be added because it is too large. The maximum file size that can be added is 6 MB, and the combined file content change size is 7 MB. Consider making these changes using a Git client.

", + "exception":true + }, + "FileDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified file does not exist. Verify that you have provided the correct name of the file, including its full path and extension.

", + "exception":true + }, + "FileEntryRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because no files have been specified as added, updated, or changed (PutFile or DeleteFile) for the commit.

", + "exception":true + }, + "FileList":{ + "type":"list", + "member":{"shape":"File"} + }, + "FileMetadata":{ + "type":"structure", + "members":{ + "absolutePath":{ + "shape":"Path", + "documentation":"

The full path to the file that will be added or updated, including the name of the file.

" + }, + "blobId":{ + "shape":"ObjectId", + "documentation":"

The blob ID that contains the file information.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

" + } + }, + "documentation":"

A file that will be added, updated, or deleted as part of a commit.

" + }, + "FileModeRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because a file mode is required to update mode permissions for an existing file, but no file mode has been specified.

", + "exception":true + }, + "FileModeTypeEnum":{ + "type":"string", + "enum":[ + "EXECUTABLE", + "NORMAL", + "SYMLINK" + ] + }, + "FileModes":{ + "type":"structure", + "members":{ + "source":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode of a file in the source of a merge or pull request.

" + }, + "destination":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode of a file in the destination of a merge or pull request.

" + }, + "base":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode of a file in the base of a merge or pull request.

" + } + }, + "documentation":"

Information about file modes in a merge or pull request.

" + }, + "FileNameConflictsWithDirectoryNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A file cannot be added to the repository because the specified file name has the same name as a directory in this repository. Either provide another name for the file, or add the file in a directory that does not match the file name.

", + "exception":true + }, + "FilePathConflictsWithSubmodulePathException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because a specified file path points to a submodule. Verify that the destination files have valid file paths that do not point to a submodule.

", + "exception":true + }, + "FilePaths":{ + "type":"list", + "member":{"shape":"Path"} + }, + "FileSize":{"type":"long"}, + "FileSizes":{ + "type":"structure", + "members":{ + "source":{ + "shape":"FileSize", + "documentation":"

The size of a file in the source of a merge or pull request.

" + }, + "destination":{ + "shape":"FileSize", + "documentation":"

The size of a file in the destination of a merge or pull request.

" + }, + "base":{ + "shape":"FileSize", + "documentation":"

The size of a file in the base of a merge or pull request.

" + } + }, + "documentation":"

Information about the size of files in a merge or pull request.

" + }, + "FileTooLargeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified file exceeds the file size limit for AWS CodeCommit. For more information about limits in AWS CodeCommit, see AWS CodeCommit User Guide.

", + "exception":true + }, + "FilesMetadata":{ + "type":"list", + "member":{"shape":"FileMetadata"} + }, + "Folder":{ + "type":"structure", + "members":{ + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains the folder.

" + }, + "absolutePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path of the folder in the repository.

" + }, + "relativePath":{ + "shape":"Path", + "documentation":"

The relative path of the specified folder from the folder where the query originated.

" + } + }, + "documentation":"

Returns information about a folder in a repository.

" + }, + "FolderContentSizeLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because at least one of the overall changes in the commit results in a folder whose contents exceed the limit of 6 MB. Either reduce the number and size of your changes, or split the changes across multiple folders.

", + "exception":true + }, + "FolderDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified folder does not exist. Either the folder name is not correct, or you did not provide the full path to the folder.

", + "exception":true + }, + "FolderList":{ + "type":"list", + "member":{"shape":"Folder"} + }, + "GetBlobInput":{ + "type":"structure", + "required":[ + "repositoryName", + "blobId" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the blob.

" + }, + "blobId":{ + "shape":"ObjectId", + "documentation":"

The ID of the blob, which is its SHA-1 pointer.

" + } + }, + "documentation":"

Represents the input of a get blob operation.

" + }, + "GetBlobOutput":{ + "type":"structure", + "required":["content"], + "members":{ + "content":{ + "shape":"blob", + "documentation":"

The content of the blob, usually a file.

" + } + }, + "documentation":"

Represents the output of a get blob operation.

" + }, + "GetBranchInput":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the branch for which you want to retrieve information.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch for which you want to retrieve information.

" + } + }, + "documentation":"

Represents the input of a get branch operation.

" + }, + "GetBranchOutput":{ + "type":"structure", + "members":{ + "branch":{ + "shape":"BranchInfo", + "documentation":"

The name of the branch.

" + } + }, + "documentation":"

Represents the output of a get branch operation.

" + }, + "GetCommentInput":{ + "type":"structure", + "required":["commentId"], + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The unique, system-generated ID of the comment. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

" + } + } + }, + "GetCommentOutput":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"Comment", + "documentation":"

The contents of the comment.

" + } + } + }, + "GetCommentsForComparedCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "afterCommitId" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to compare commits.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

To establish the directionality of the comparison, the full commit ID of the 'before' commit.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

To establish the directionality of the comparison, the full commit ID of the 'after' commit.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The default is 100 comments, and is configurable up to 500.

" + } + } + }, + "GetCommentsForComparedCommitOutput":{ + "type":"structure", + "members":{ + "commentsForComparedCommitData":{ + "shape":"CommentsForComparedCommitData", + "documentation":"

A list of comment objects on the compared commit.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "GetCommentsForPullRequestInput":{ + "type":"structure", + "required":["pullRequestId"], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the pull request.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the source branch that was the tip of the branch at the time the comment was made.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The default is 100 comments. You can return up to 500 comments with a single request.

" + } + } + }, + "GetCommentsForPullRequestOutput":{ + "type":"structure", + "members":{ + "commentsForPullRequestData":{ + "shape":"CommentsForPullRequestData", + "documentation":"

An array of comment objects on the pull request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "GetCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "commitId" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to which the commit was made.

" + }, + "commitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID. Commit IDs are the full SHA of the commit.

" + } + }, + "documentation":"

Represents the input of a get commit operation.

" + }, + "GetCommitOutput":{ + "type":"structure", + "required":["commit"], + "members":{ + "commit":{ + "shape":"Commit", + "documentation":"

A commit data type object that contains information about the specified commit.

" + } + }, + "documentation":"

Represents the output of a get commit operation.

" + }, + "GetDifferencesInput":{ + "type":"structure", + "required":[ + "repositoryName", + "afterCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to get differences.

" + }, + "beforeCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, the full commit ID. Optional. If not specified, all changes prior to the afterCommitSpecifier value will be shown. If you do not use beforeCommitSpecifier in your request, consider limiting the results with maxResults.

" + }, + "afterCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit.

" + }, + "beforePath":{ + "shape":"Path", + "documentation":"

The file path in which to check for differences. Limits the results to this path. Can also be used to specify the previous name of a directory or folder. If beforePath and afterPath are not specified, differences will be shown for all paths.

" + }, + "afterPath":{ + "shape":"Path", + "documentation":"

The file path in which to check differences. Limits the results to this path. Can also be used to specify the changed name of a directory or folder, if it has changed. If not specified, differences will be shown for all paths.

" + }, + "MaxResults":{ + "shape":"Limit", + "documentation":"

A non-negative integer used to limit the number of returned results.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "GetDifferencesOutput":{ + "type":"structure", + "members":{ + "differences":{ + "shape":"DifferenceList", + "documentation":"

A differences data type object that contains information about the differences, including whether the difference is added, modified, or deleted (A, D, M).

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "GetFileInput":{ + "type":"structure", + "required":[ + "repositoryName", + "filePath" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the file.

" + }, + "commitSpecifier":{ + "shape":"CommitName", + "documentation":"

The fully-quaified reference that identifies the commit that contains the file. For example, you could specify a full commit ID, a tag, a branch name, or a reference such as refs/heads/master. If none is provided, then the head commit will be used.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the file, including the full name and extension of the file. For example, /examples/file.md is the fully-qualified path to a file named file.md in a folder named examples.

" + } + } + }, + "GetFileOutput":{ + "type":"structure", + "required":[ + "commitId", + "blobId", + "filePath", + "fileMode", + "fileSize", + "fileContent" + ], + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the commit that contains the content returned by GetFile.

" + }, + "blobId":{ + "shape":"ObjectId", + "documentation":"

The blob ID of the object that represents the file content.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The fully qualified path to the specified file. This returns the name and extension of the file.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The extrapolated file mode permissions of the blob. Valid values include strings such as EXECUTABLE and not numeric values.

The file mode permissions returned by this API are not the standard file mode permission values, such as 100644, but rather extrapolated values. See below for a full list of supported return values.

" + }, + "fileSize":{ + "shape":"ObjectSize", + "documentation":"

The size of the contents of the file, in bytes.

" + }, + "fileContent":{ + "shape":"FileContent", + "documentation":"

The base-64 encoded binary data object that represents the content of the file.

" + } + } + }, + "GetFolderInput":{ + "type":"structure", + "required":[ + "repositoryName", + "folderPath" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository.

" + }, + "commitSpecifier":{ + "shape":"CommitName", + "documentation":"

A fully-qualified reference used to identify a commit that contains the version of the folder's content to return. A fully-qualified reference can be a commit ID, branch name, tag, or reference such as HEAD. If no specifier is provided, the folder content will be returned as it exists in the HEAD commit.

" + }, + "folderPath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the folder whose contents will be returned, including the folder name. For example, /examples is a fully-qualified path to a folder named examples that was created off of the root directory (/) of a repository.

" + } + } + }, + "GetFolderOutput":{ + "type":"structure", + "required":[ + "commitId", + "folderPath" + ], + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID used as a reference for which version of the folder content is returned.

" + }, + "folderPath":{ + "shape":"Path", + "documentation":"

The fully-qualified path of the folder whose contents are returned.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains the folder.

" + }, + "subFolders":{ + "shape":"FolderList", + "documentation":"

The list of folders that exist beneath the specified folder, if any.

" + }, + "files":{ + "shape":"FileList", + "documentation":"

The list of files that exist in the specified folder, if any.

" + }, + "symbolicLinks":{ + "shape":"SymbolicLinkList", + "documentation":"

The list of symbolic links to other files and folders that exist in the specified folder, if any.

" + }, + "subModules":{ + "shape":"SubModuleList", + "documentation":"

The list of submodules that exist in the specified folder, if any.

" + } + } + }, + "GetMergeCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the merge commit about which you want to get information.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + } + } + }, + "GetMergeCommitOutput":{ + "type":"structure", + "members":{ + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the source commit specifier that was used in the merge evaluation.

" + }, + "destinationCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + }, + "baseCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge base.

" + }, + "mergedCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID for the merge commit created when the source branch was merged into the destination branch. If the fast-forward merge strategy was used, no merge commit exists.

" + } + } + }, + "GetMergeConflictsInput":{ + "type":"structure", + "required":[ + "repositoryName", + "destinationCommitSpecifier", + "sourceCommitSpecifier", + "mergeOption" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "mergeOption":{ + "shape":"MergeOptionTypeEnum", + "documentation":"

The merge option or strategy you want to use to merge the code.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "maxConflictFiles":{ + "shape":"MaxResults", + "documentation":"

The maximum number of files to include in the output.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "GetMergeConflictsOutput":{ + "type":"structure", + "required":[ + "mergeable", + "destinationCommitId", + "sourceCommitId", + "conflictMetadataList" + ], + "members":{ + "mergeable":{ + "shape":"IsMergeable", + "documentation":"

A Boolean value that indicates whether the code is mergeable by the specified merge option.

" + }, + "destinationCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the source commit specifier that was used in the merge evaluation.

" + }, + "baseCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge base.

" + }, + "conflictMetadataList":{ + "shape":"ConflictMetadataList", + "documentation":"

A list of metadata for any conflicting files. If the specified merge strategy is FAST_FORWARD_MERGE, this list will always be empty.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "GetMergeOptionsInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the commits about which you want to get merge options.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + } + } + }, + "GetMergeOptionsOutput":{ + "type":"structure", + "required":[ + "mergeOptions", + "sourceCommitId", + "destinationCommitId", + "baseCommitId" + ], + "members":{ + "mergeOptions":{ + "shape":"MergeOptions", + "documentation":"

The merge option or strategy used to merge the code.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the source commit specifier that was used in the merge evaluation.

" + }, + "destinationCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the destination commit specifier that was used in the merge evaluation.

" + }, + "baseCommitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge base.

" + } + } + }, + "GetPullRequestInput":{ + "type":"structure", + "required":["pullRequestId"], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + } + } + }, + "GetPullRequestOutput":{ + "type":"structure", + "required":["pullRequest"], + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the specified pull request.

" + } + } + }, + "GetRepositoryInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to get information about.

" + } + }, + "documentation":"

Represents the input of a get repository operation.

" + }, + "GetRepositoryOutput":{ + "type":"structure", + "members":{ + "repositoryMetadata":{ + "shape":"RepositoryMetadata", + "documentation":"

Information about the repository.

" + } + }, + "documentation":"

Represents the output of a get repository operation.

" + }, + "GetRepositoryTriggersInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository for which the trigger is configured.

" + } + }, + "documentation":"

Represents the input of a get repository triggers operation.

" + }, + "GetRepositoryTriggersOutput":{ + "type":"structure", + "members":{ + "configurationId":{ + "shape":"RepositoryTriggersConfigurationId", + "documentation":"

The system-generated unique ID for the trigger.

" + }, + "triggers":{ + "shape":"RepositoryTriggersList", + "documentation":"

The JSON block of configuration information for each trigger.

" + } + }, + "documentation":"

Represents the output of a get repository triggers operation.

" + }, + "HunkContent":{"type":"string"}, + "IdempotencyParameterMismatchException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The client request token is not valid. Either the token is not in a valid format, or the token has been used in a previous request and cannot be re-used.

", + "exception":true + }, + "InvalidActorArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon Resource Name (ARN) is not valid. Make sure that you have provided the full ARN for the user who initiated the change for the pull request, and then try again.

", + "exception":true + }, + "InvalidAuthorArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon Resource Name (ARN) is not valid. Make sure that you have provided the full ARN for the author of the pull request, and then try again.

", + "exception":true + }, + "InvalidBlobIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified blob is not valid.

", + "exception":true + }, + "InvalidBranchNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified reference name is not valid.

", + "exception":true + }, + "InvalidClientRequestTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The client request token is not valid.

", + "exception":true + }, + "InvalidCommentIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The comment ID is not in a valid format. Make sure that you have provided the full comment ID.

", + "exception":true + }, + "InvalidCommitException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified commit is not valid.

", + "exception":true + }, + "InvalidCommitIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified commit ID is not valid.

", + "exception":true + }, + "InvalidConflictDetailLevelException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified conflict detail level is not valid.

", + "exception":true + }, + "InvalidConflictResolutionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified conflict resolution list is not valid.

", + "exception":true + }, + "InvalidConflictResolutionStrategyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified conflict resolution strategy is not valid.

", + "exception":true + }, + "InvalidContinuationTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified continuation token is not valid.

", + "exception":true + }, + "InvalidDeletionParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified deletion parameter is not valid.

", + "exception":true + }, + "InvalidDescriptionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request description is not valid. Descriptions are limited to 1,000 characters in length.

", + "exception":true + }, + "InvalidDestinationCommitSpecifierException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The destination commit specifier is not valid. You must provide a valid branch name, tag, or full commit ID.

", + "exception":true + }, + "InvalidEmailException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified email address either contains one or more characters that are not allowed, or it exceeds the maximum number of characters allowed for an email address.

", + "exception":true + }, + "InvalidFileLocationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The location of the file is not valid. Make sure that you include the extension of the file as well as the file name.

", + "exception":true + }, + "InvalidFileModeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified file mode permission is not valid. For a list of valid file mode permissions, see PutFile.

", + "exception":true + }, + "InvalidFilePositionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The position is not valid. Make sure that the line number exists in the version of the file you want to comment on.

", + "exception":true + }, + "InvalidMaxConflictFilesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified value for the number of conflict files to return is not valid.

", + "exception":true + }, + "InvalidMaxMergeHunksException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified value for the number of merge hunks to return is not valid.

", + "exception":true + }, + "InvalidMaxResultsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified number of maximum results is not valid.

", + "exception":true + }, + "InvalidMergeOptionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified merge option is not valid for this operation. Not all merge strategies are supported for all operations.

", + "exception":true + }, + "InvalidOrderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified sort order is not valid.

", + "exception":true + }, + "InvalidParentCommitIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The parent commit ID is not valid. The commit ID cannot be empty, and must match the head commit ID for the branch of the repository where you want to add or update a file.

", + "exception":true + }, + "InvalidPathException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified path is not valid.

", + "exception":true + }, + "InvalidPullRequestEventTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request event type is not valid.

", + "exception":true + }, + "InvalidPullRequestIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request ID is not valid. Make sure that you have provided the full ID and that the pull request is in the specified repository, and then try again.

", + "exception":true + }, + "InvalidPullRequestStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request status is not valid. The only valid values are OPEN and CLOSED.

", + "exception":true + }, + "InvalidPullRequestStatusUpdateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request status update is not valid. The only valid update is from OPEN to CLOSED.

", + "exception":true + }, + "InvalidReferenceNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified reference name format is not valid. Reference names must conform to the Git references format, for example refs/heads/master. For more information, see Git Internals - Git References or consult your Git documentation.

", + "exception":true + }, + "InvalidRelativeFileVersionEnumException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Either the enum is not in a valid format, or the specified file version enum is not valid in respect to the current file version.

", + "exception":true + }, + "InvalidReplacementContentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Automerge was specified for resolving the conflict, but the replacement type is not valid or content is missing.

", + "exception":true + }, + "InvalidReplacementTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Automerge was specified for resolving the conflict, but the specified replacement type is not valid.

", + "exception":true + }, + "InvalidRepositoryDescriptionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified repository description is not valid.

", + "exception":true + }, + "InvalidRepositoryNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

At least one specified repository name is not valid.

This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.

", + "exception":true + }, + "InvalidRepositoryTriggerBranchNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more branch names specified for the trigger is not valid.

", + "exception":true + }, + "InvalidRepositoryTriggerCustomDataException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The custom data provided for the trigger is not valid.

", + "exception":true + }, + "InvalidRepositoryTriggerDestinationArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon Resource Name (ARN) for the trigger is not valid for the specified destination. The most common reason for this error is that the ARN does not meet the requirements for the service type.

", + "exception":true + }, + "InvalidRepositoryTriggerEventsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more events specified for the trigger is not valid. Check to make sure that all events specified match the requirements for allowed events.

", + "exception":true + }, + "InvalidRepositoryTriggerNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The name of the trigger is not valid.

", + "exception":true + }, + "InvalidRepositoryTriggerRegionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The region for the trigger target does not match the region for the repository. Triggers must be created in the same region as the target for the trigger.

", + "exception":true + }, + "InvalidResourceArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The value for the resource ARN is not valid. For more information about resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

", + "exception":true + }, + "InvalidSortByException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified sort by value is not valid.

", + "exception":true + }, + "InvalidSourceCommitSpecifierException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The source commit specifier is not valid. You must provide a valid branch name, tag, or full commit ID.

", + "exception":true + }, + "InvalidSystemTagUsageException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified tag is not valid. Key names cannot be prefixed with aws:.

", + "exception":true + }, + "InvalidTagKeysListException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The list of tags is not valid.

", + "exception":true + }, + "InvalidTagsMapException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The map of tags is not valid.

", + "exception":true + }, + "InvalidTargetBranchException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified target branch is not valid.

", + "exception":true + }, + "InvalidTargetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target for the pull request is not valid. A target must contain the full values for the repository name, source branch, and destination branch for the pull request.

", + "exception":true + }, + "InvalidTargetsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The targets for the pull request is not valid or not in a valid format. Targets are a list of target objects. Each target object must contain the full values for the repository name, source branch, and destination branch for a pull request.

", + "exception":true + }, + "InvalidTitleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The title of the pull request is not valid. Pull request titles cannot exceed 100 characters in length.

", + "exception":true + }, + "IsBinaryFile":{ + "type":"structure", + "members":{ + "source":{ + "shape":"CapitalBoolean", + "documentation":"

The binary or non-binary status of file in the source of a merge or pull request.

" + }, + "destination":{ + "shape":"CapitalBoolean", + "documentation":"

The binary or non-binary status of a file in the destination of a merge or pull request.

" + }, + "base":{ + "shape":"CapitalBoolean", + "documentation":"

The binary or non-binary status of a file in the base of a merge or pull request.

" + } + }, + "documentation":"

Information about whether a file is binary or textual in a merge or pull request operation.

" + }, + "IsCommentDeleted":{"type":"boolean"}, + "IsContentConflict":{"type":"boolean"}, + "IsFileModeConflict":{"type":"boolean"}, + "IsHunkConflict":{"type":"boolean"}, + "IsMergeable":{"type":"boolean"}, + "IsMerged":{"type":"boolean"}, + "IsMove":{"type":"boolean"}, + "IsObjectTypeConflict":{"type":"boolean"}, + "KeepEmptyFolders":{"type":"boolean"}, + "LastModifiedDate":{"type":"timestamp"}, + "Limit":{ + "type":"integer", + "box":true + }, + "LineNumber":{"type":"integer"}, + "ListBranchesInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the branches.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that allows the operation to batch the results.

" + } + }, + "documentation":"

Represents the input of a list branches operation.

" + }, + "ListBranchesOutput":{ + "type":"structure", + "members":{ + "branches":{ + "shape":"BranchNameList", + "documentation":"

The list of branch names.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that returns the batch of the results.

" + } + }, + "documentation":"

Represents the output of a list branches operation.

" + }, + "ListPullRequestsInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository for which you want to list pull requests.

" + }, + "authorArn":{ + "shape":"Arn", + "documentation":"

Optional. The Amazon Resource Name (ARN) of the user who created the pull request. If used, this filters the results to pull requests created by that user.

" + }, + "pullRequestStatus":{ + "shape":"PullRequestStatusEnum", + "documentation":"

Optional. The status of the pull request. If used, this refines the results to the pull requests that match the specified status.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results.

" + } + } + }, + "ListPullRequestsOutput":{ + "type":"structure", + "required":["pullRequestIds"], + "members":{ + "pullRequestIds":{ + "shape":"PullRequestIdList", + "documentation":"

The system-generated IDs of the pull requests.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "ListRepositoriesInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

" + }, + "sortBy":{ + "shape":"SortByEnum", + "documentation":"

The criteria used to sort the results of a list repositories operation.

" + }, + "order":{ + "shape":"OrderEnum", + "documentation":"

The order in which to sort the results of a list repositories operation.

" + } + }, + "documentation":"

Represents the input of a list repositories operation.

" + }, + "ListRepositoriesOutput":{ + "type":"structure", + "members":{ + "repositories":{ + "shape":"RepositoryNameIdPairList", + "documentation":"

Lists the repositories called by the list repositories operation.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that allows the operation to batch the results of the operation. Batch sizes are 1,000 for list repository operations. When the client sends the token back to AWS CodeCommit, another page of 1,000 records is retrieved.

" + } + }, + "documentation":"

Represents the output of a list repositories operation.

" + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that when provided in a request, returns the next batch of the results.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagsMap", + "documentation":"

A list of tag key and value pairs associated with the specified resource.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that allows the operation to batch the next results of the operation.

" + } + } + }, + "Location":{ + "type":"structure", + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The name of the file being compared, including its extension and subdirectory, if any.

" + }, + "filePosition":{ + "shape":"Position", + "documentation":"

The position of a change within a compared file, in line number format.

" + }, + "relativeFileVersion":{ + "shape":"RelativeFileVersionEnum", + "documentation":"

In a comparison of commits or a pull request, whether the change is in the 'before' or 'after' of that comparison.

" + } + }, + "documentation":"

Returns information about the location of a change or comment in the comparison between two commits or a pull request.

" + }, + "ManualMergeRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request cannot be merged automatically into the destination branch. You must manually merge the branches and resolve any conflicts.

", + "exception":true + }, + "MaxResults":{"type":"integer"}, + "MaximumBranchesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of branches for the trigger was exceeded.

", + "exception":true + }, + "MaximumConflictResolutionEntriesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of allowed conflict resolution entries was exceeded.

", + "exception":true + }, + "MaximumFileContentToLoadExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of files to load exceeds the allowed limit.

", + "exception":true + }, + "MaximumFileEntriesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of specified files to change as part of this commit exceeds the maximum number of files that can be changed in a single commit. Consider using a Git client for these changes.

", + "exception":true + }, + "MaximumItemsToCompareExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of items to compare between the source or destination branches and the merge base has exceeded the maximum allowed.

", + "exception":true + }, + "MaximumOpenPullRequestsExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot create the pull request because the repository has too many open pull requests. The maximum number of open pull requests for a repository is 1,000. Close one or more open pull requests, and then try again.

", + "exception":true + }, + "MaximumRepositoryNamesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of allowed repository names was exceeded. Currently, this number is 25.

", + "exception":true + }, + "MaximumRepositoryTriggersExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of triggers allowed for the repository was exceeded.

", + "exception":true + }, + "MergeBranchesByFastForwardInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to merge two branches.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "targetBranch":{ + "shape":"BranchName", + "documentation":"

The branch where the merge will be applied.

" + } + } + }, + "MergeBranchesByFastForwardOutput":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge in the destination or target branch.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The tree ID of the merge in the destination or target branch.

" + } + } + }, + "MergeBranchesBySquashInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to merge two branches.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "targetBranch":{ + "shape":"BranchName", + "documentation":"

The branch where the merge will be applied.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address of the person merging the branches. This information will be used in the commit information for the merge.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message for the merge.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "conflictResolution":{ + "shape":"ConflictResolution", + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + } + } + }, + "MergeBranchesBySquashOutput":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge in the destination or target branch.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The tree ID of the merge in the destination or target branch.

" + } + } + }, + "MergeBranchesByThreeWayInput":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceCommitSpecifier", + "destinationCommitSpecifier" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to merge two branches.

" + }, + "sourceCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "destinationCommitSpecifier":{ + "shape":"CommitName", + "documentation":"

The branch, tag, HEAD, or other fully qualified reference used to identify a commit. For example, a branch name or a full commit ID.

" + }, + "targetBranch":{ + "shape":"BranchName", + "documentation":"

The branch where the merge will be applied.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address of the person merging the branches. This information will be used in the commit information for the merge.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message to include in the commit information for the merge.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "conflictResolution":{ + "shape":"ConflictResolution", + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + } + } + }, + "MergeBranchesByThreeWayOutput":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID of the merge in the destination or target branch.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The tree ID of the merge in the destination or target branch.

" + } + } + }, + "MergeHunk":{ + "type":"structure", + "members":{ + "isConflict":{ + "shape":"IsHunkConflict", + "documentation":"

A Boolean value indicating whether a combination of hunks contains a conflict. Conflicts occur when the same file or the same lines in a file were modified in both the source and destination of a merge or pull request. Valid values include true, false, and null. This will be true when the hunk represents a conflict and one or more files contains a line conflict. File mode conflicts in a merge will not set this to be true.

" + }, + "source":{ + "shape":"MergeHunkDetail", + "documentation":"

Information about the merge hunk in the source of a merge or pull request.

" + }, + "destination":{ + "shape":"MergeHunkDetail", + "documentation":"

Information about the merge hunk in the destination of a merge or pull request.

" + }, + "base":{ + "shape":"MergeHunkDetail", + "documentation":"

Information about the merge hunk in the base of a merge or pull request.

" + } + }, + "documentation":"

Information about merge hunks in a merge or pull request operation.

" + }, + "MergeHunkDetail":{ + "type":"structure", + "members":{ + "startLine":{ + "shape":"LineNumber", + "documentation":"

The start position of the hunk in the merge result.

" + }, + "endLine":{ + "shape":"LineNumber", + "documentation":"

The end position of the hunk in the merge result.

" + }, + "hunkContent":{ + "shape":"HunkContent", + "documentation":"

The base-64 encoded content of the hunk merged region that might or might not contain a conflict.

" + } + }, + "documentation":"

Information about the details of a merge hunk that contains a conflict in a merge or pull request operation.

" + }, + "MergeHunks":{ + "type":"list", + "member":{"shape":"MergeHunk"} + }, + "MergeMetadata":{ + "type":"structure", + "members":{ + "isMerged":{ + "shape":"IsMerged", + "documentation":"

A Boolean value indicating whether the merge has been made.

" + }, + "mergedBy":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the user who merged the branches.

" + }, + "mergeCommitId":{ + "shape":"CommitId", + "documentation":"

The commit ID for the merge commit, if any.

" + }, + "mergeOption":{ + "shape":"MergeOptionTypeEnum", + "documentation":"

The merge strategy used in the merge.

" + } + }, + "documentation":"

Returns information about a merge or potential merge between a source reference and a destination reference in a pull request.

" + }, + "MergeOperations":{ + "type":"structure", + "members":{ + "source":{ + "shape":"ChangeTypeEnum", + "documentation":"

The operation on a file (add, modify, or delete) of a file in the source of a merge or pull request.

" + }, + "destination":{ + "shape":"ChangeTypeEnum", + "documentation":"

The operation on a file in the destination of a merge or pull request.

" + } + }, + "documentation":"

Information about the file operation conflicts in a merge operation.

" + }, + "MergeOptionRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A merge option or stategy is required, and none was provided.

", + "exception":true + }, + "MergeOptionTypeEnum":{ + "type":"string", + "enum":[ + "FAST_FORWARD_MERGE", + "SQUASH_MERGE", + "THREE_WAY_MERGE" + ] + }, + "MergeOptions":{ + "type":"list", + "member":{"shape":"MergeOptionTypeEnum"} + }, + "MergePullRequestByFastForwardInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "repositoryName" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" + } + } + }, + "MergePullRequestByFastForwardOutput":{ + "type":"structure", + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the specified pull request, including information about the merge.

" + } + } + }, + "MergePullRequestBySquashInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "repositoryName" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message to include in the commit information for the merge.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address of the person merging the branches. This information will be used in the commit information for the merge.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "conflictResolution":{ + "shape":"ConflictResolution", + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + } + } + }, + "MergePullRequestBySquashOutput":{ + "type":"structure", + "members":{ + "pullRequest":{"shape":"PullRequest"} + } + }, + "MergePullRequestByThreeWayInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "repositoryName" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "sourceCommitId":{ + "shape":"ObjectId", + "documentation":"

The full commit ID of the original or updated commit in the pull request source branch. Pass this value if you want an exception thrown if the current commit ID of the tip of the source branch does not match this commit ID.

" + }, + "conflictDetailLevel":{ + "shape":"ConflictDetailLevelTypeEnum", + "documentation":"

The level of conflict detail to use. If unspecified, the default FILE_LEVEL is used, which will return a not mergeable result if the same file has differences in both branches. If LINE_LEVEL is specified, a conflict will be considered not mergeable if the same file in both branches has differences on the same line.

" + }, + "conflictResolutionStrategy":{ + "shape":"ConflictResolutionStrategyTypeEnum", + "documentation":"

Specifies which branch to use when resolving conflicts, or whether to attempt automatically merging two versions of a file. The default is NONE, which requires any conflicts to be resolved manually before the merge operation will be successful.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

The commit message to include in the commit information for the merge.

" + }, + "authorName":{ + "shape":"Name", + "documentation":"

The name of the author who created the commit. This information will be used as both the author and committer for the commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address of the person merging the branches. This information will be used in the commit information for the merge.

" + }, + "keepEmptyFolders":{ + "shape":"KeepEmptyFolders", + "documentation":"

If the commit contains deletions, whether to keep a folder or folder structure if the changes leave the folders empty. If this is specified as true, a .gitkeep file will be created for empty folders. The default is false.

" + }, + "conflictResolution":{ + "shape":"ConflictResolution", + "documentation":"

A list of inputs to use when resolving conflicts during a merge if AUTOMERGE is chosen as the conflict resolution strategy.

" + } + } + }, + "MergePullRequestByThreeWayOutput":{ + "type":"structure", + "members":{ + "pullRequest":{"shape":"PullRequest"} + } + }, + "Message":{"type":"string"}, + "Mode":{"type":"string"}, + "MultipleConflictResolutionEntriesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

More than one conflict resolution entries exists for the conflict. A conflict can have only one conflict resolution entry.

", + "exception":true + }, + "MultipleRepositoriesInPullRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot include more than one repository in a pull request. Make sure you have specified only one repository name in your request, and then try again.

", + "exception":true + }, + "Name":{"type":"string"}, + "NameLengthExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The user name is not valid because it has exceeded the character limit for author names.

", + "exception":true + }, + "NextToken":{"type":"string"}, + "NoChangeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because no changes will be made to the repository as a result of this commit. A commit must contain at least one change.

", + "exception":true + }, + "NumberOfConflicts":{"type":"integer"}, + "ObjectId":{"type":"string"}, + "ObjectSize":{"type":"long"}, + "ObjectTypeEnum":{ + "type":"string", + "enum":[ + "FILE", + "DIRECTORY", + "GIT_LINK", + "SYMBOLIC_LINK" + ] + }, + "ObjectTypes":{ + "type":"structure", + "members":{ + "source":{ + "shape":"ObjectTypeEnum", + "documentation":"

The type of the object in the source branch.

" + }, + "destination":{ + "shape":"ObjectTypeEnum", + "documentation":"

The type of the object in the destination branch.

" + }, + "base":{ + "shape":"ObjectTypeEnum", + "documentation":"

The type of the object in the base commit of the merge.

" + } + }, + "documentation":"

Information about the type of an object in a merge operation.

" + }, + "OrderEnum":{ + "type":"string", + "enum":[ + "ascending", + "descending" + ] + }, + "ParentCommitDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The parent commit ID is not valid because it does not exist. The specified parent commit ID does not exist in the specified branch of the repository.

", + "exception":true + }, + "ParentCommitIdOutdatedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The file could not be added because the provided parent commit ID is not the current tip of the specified branch. To view the full commit ID of the current head of the branch, use GetBranch.

", + "exception":true + }, + "ParentCommitIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A parent commit ID is required. To view the full commit ID of a branch in a repository, use GetBranch or a Git command (for example, git pull or git log).

", + "exception":true + }, + "ParentList":{ + "type":"list", + "member":{"shape":"ObjectId"} + }, + "Path":{"type":"string"}, + "PathDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified path does not exist.

", + "exception":true + }, + "PathRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The folderPath for a location cannot be null.

", + "exception":true + }, + "Position":{"type":"long"}, + "PostCommentForComparedCommitInput":{ + "type":"structure", + "required":[ + "repositoryName", + "afterCommitId", + "content" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to post a comment on the comparison between commits.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

To establish the directionality of the comparison, the full commit ID of the 'before' commit.

This is required for commenting on any commit unless that commit is the initial commit.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

To establish the directionality of the comparison, the full commit ID of the 'after' commit.

" + }, + "location":{ + "shape":"Location", + "documentation":"

The location of the comparison where you want to comment.

" + }, + "content":{ + "shape":"Content", + "documentation":"

The content of the comment you want to make.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

", + "idempotencyToken":true + } + } + }, + "PostCommentForComparedCommitOutput":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you posted a comment on the comparison between commits.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

In the directionality you established, the full commit ID of the 'before' commit.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

In the directionality you established, the full commit ID of the 'after' commit.

" + }, + "beforeBlobId":{ + "shape":"ObjectId", + "documentation":"

In the directionality you established, the blob ID of the 'before' blob.

" + }, + "afterBlobId":{ + "shape":"ObjectId", + "documentation":"

In the directionality you established, the blob ID of the 'after' blob.

" + }, + "location":{ + "shape":"Location", + "documentation":"

The location of the comment in the comparison between the two commits.

" + }, + "comment":{ + "shape":"Comment", + "documentation":"

The content of the comment you posted.

" + } + } + }, + "PostCommentForPullRequestInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "repositoryName", + "beforeCommitId", + "afterCommitId", + "content" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to post a comment on a pull request.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was created.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the source branch that is the current tip of the branch for the pull request when you post the comment.

" + }, + "location":{ + "shape":"Location", + "documentation":"

The location of the change where you want to post your comment. If no location is provided, the comment will be posted as a general comment on the pull request difference between the before commit ID and the after commit ID.

" + }, + "content":{ + "shape":"Content", + "documentation":"

The content of your comment on the change.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

", + "idempotencyToken":true + } + } + }, + "PostCommentForPullRequestOutput":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you posted a comment on a pull request.

" + }, + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the source branch used to create the pull request, or in the case of an updated pull request, the full commit ID of the commit used to update the pull request.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the destination branch where the pull request will be merged.

" + }, + "beforeBlobId":{ + "shape":"ObjectId", + "documentation":"

In the directionality of the pull request, the blob ID of the 'before' blob.

" + }, + "afterBlobId":{ + "shape":"ObjectId", + "documentation":"

In the directionality of the pull request, the blob ID of the 'after' blob.

" + }, + "location":{ + "shape":"Location", + "documentation":"

The location of the change where you posted your comment.

" + }, + "comment":{ + "shape":"Comment", + "documentation":"

The content of the comment you posted.

" + } + } + }, + "PostCommentReplyInput":{ + "type":"structure", + "required":[ + "inReplyTo", + "content" + ], + "members":{ + "inReplyTo":{ + "shape":"CommentId", + "documentation":"

The system-generated ID of the comment to which you want to reply. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

", + "idempotencyToken":true + }, + "content":{ + "shape":"Content", + "documentation":"

The contents of your reply to a comment.

" + } + } + }, + "PostCommentReplyOutput":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"Comment", + "documentation":"

Information about the reply to a comment.

" + } + } + }, + "PullRequest":{ + "type":"structure", + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request.

" + }, + "title":{ + "shape":"Title", + "documentation":"

The user-defined title of the pull request. This title is displayed in the list of pull requests to other users of the repository.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The user-defined description of the pull request. This description can be used to clarify what should be reviewed and other details of the request.

" + }, + "lastActivityDate":{ + "shape":"LastModifiedDate", + "documentation":"

The day and time of the last user or system activity on the pull request, in timestamp format.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The date and time the pull request was originally created, in timestamp format.

" + }, + "pullRequestStatus":{ + "shape":"PullRequestStatusEnum", + "documentation":"

The status of the pull request. Pull request status can only change from OPEN to CLOSED.

" + }, + "authorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the user who created the pull request.

" + }, + "pullRequestTargets":{ + "shape":"PullRequestTargetList", + "documentation":"

The targets of the pull request, including the source branch and destination branch for the pull request.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request will return information about the initial request that used that token.

" + } + }, + "documentation":"

Returns information about a pull request.

" + }, + "PullRequestAlreadyClosedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request status cannot be updated because it is already closed.

", + "exception":true + }, + "PullRequestCreatedEventMetadata":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "sourceCommitId":{ + "shape":"CommitId", + "documentation":"

The commit ID on the source branch used when the pull request was created.

" + }, + "destinationCommitId":{ + "shape":"CommitId", + "documentation":"

The commit ID of the tip of the branch specified as the destination branch when the pull request was created.

" + }, + "mergeBase":{ + "shape":"CommitId", + "documentation":"

The commit ID of the most recent commit that the source branch and the destination branch have in common.

" + } + }, + "documentation":"

Metadata about the pull request that is used when comparing the pull request source with its destination.

" + }, + "PullRequestDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pull request ID could not be found. Make sure that you have specified the correct repository name and pull request ID, and then try again.

", + "exception":true + }, + "PullRequestEvent":{ + "type":"structure", + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request.

" + }, + "eventDate":{ + "shape":"EventDate", + "documentation":"

The day and time of the pull request event, in timestamp format.

" + }, + "pullRequestEventType":{ + "shape":"PullRequestEventType", + "documentation":"

The type of the pull request event, for example a status change event (PULL_REQUEST_STATUS_CHANGED) or update event (PULL_REQUEST_SOURCE_REFERENCE_UPDATED).

" + }, + "actorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the user whose actions resulted in the event. Examples include updating the pull request with additional commits or changing the status of a pull request.

" + }, + "pullRequestCreatedEventMetadata":{ + "shape":"PullRequestCreatedEventMetadata", + "documentation":"

Information about the source and destination branches for the pull request.

" + }, + "pullRequestStatusChangedEventMetadata":{ + "shape":"PullRequestStatusChangedEventMetadata", + "documentation":"

Information about the change in status for the pull request event.

" + }, + "pullRequestSourceReferenceUpdatedEventMetadata":{ + "shape":"PullRequestSourceReferenceUpdatedEventMetadata", + "documentation":"

Information about the updated source branch for the pull request event.

" + }, + "pullRequestMergedStateChangedEventMetadata":{ + "shape":"PullRequestMergedStateChangedEventMetadata", + "documentation":"

Information about the change in mergability state for the pull request event.

" + } + }, + "documentation":"

Returns information about a pull request event.

" + }, + "PullRequestEventList":{ + "type":"list", + "member":{"shape":"PullRequestEvent"} + }, + "PullRequestEventType":{ + "type":"string", + "enum":[ + "PULL_REQUEST_CREATED", + "PULL_REQUEST_STATUS_CHANGED", + "PULL_REQUEST_SOURCE_REFERENCE_UPDATED", + "PULL_REQUEST_MERGE_STATE_CHANGED" + ] + }, + "PullRequestId":{"type":"string"}, + "PullRequestIdList":{ + "type":"list", + "member":{"shape":"PullRequestId"} + }, + "PullRequestIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A pull request ID is required, but none was provided.

", + "exception":true + }, + "PullRequestMergedStateChangedEventMetadata":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was created.

" + }, + "destinationReference":{ + "shape":"ReferenceName", + "documentation":"

The name of the branch that the pull request will be merged into.

" + }, + "mergeMetadata":{ + "shape":"MergeMetadata", + "documentation":"

Information about the merge state change event.

" + } + }, + "documentation":"

Returns information about the change in the merge state for a pull request event.

" + }, + "PullRequestSourceReferenceUpdatedEventMetadata":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where the pull request was updated.

" + }, + "beforeCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the destination branch that was the tip of the branch at the time the pull request was updated.

" + }, + "afterCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the commit in the source branch that was the tip of the branch at the time the pull request was updated.

" + }, + "mergeBase":{ + "shape":"CommitId", + "documentation":"

The commit ID of the most recent commit that the source branch and the destination branch have in common.

" + } + }, + "documentation":"

Information about an update to the source branch of a pull request.

" + }, + "PullRequestStatusChangedEventMetadata":{ + "type":"structure", + "members":{ + "pullRequestStatus":{ + "shape":"PullRequestStatusEnum", + "documentation":"

The changed status of the pull request.

" + } + }, + "documentation":"

Information about a change to the status of a pull request.

" + }, + "PullRequestStatusEnum":{ + "type":"string", + "enum":[ + "OPEN", + "CLOSED" + ] + }, + "PullRequestStatusRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A pull request status is required, but none was provided.

", + "exception":true + }, + "PullRequestTarget":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the pull request source and destination branches.

" + }, + "sourceReference":{ + "shape":"ReferenceName", + "documentation":"

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

" + }, + "destinationReference":{ + "shape":"ReferenceName", + "documentation":"

The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

" + }, + "destinationCommit":{ + "shape":"CommitId", + "documentation":"

The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.

" + }, + "sourceCommit":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID will change to reflect the new tip of the branch.

" + }, + "mergeBase":{ + "shape":"CommitId", + "documentation":"

The commit ID of the most recent commit that the source branch and the destination branch have in common.

" + }, + "mergeMetadata":{ + "shape":"MergeMetadata", + "documentation":"

Returns metadata about the state of the merge, including whether the merge has been made.

" + } + }, + "documentation":"

Returns information about a pull request target.

" + }, + "PullRequestTargetList":{ + "type":"list", + "member":{"shape":"PullRequestTarget"} + }, + "PutFileEntries":{ + "type":"list", + "member":{"shape":"PutFileEntry"} + }, + "PutFileEntry":{ + "type":"structure", + "required":["filePath"], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The full path to the file in the repository, including the name of the file.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The extrapolated file mode permissions for the file. Valid values include EXECUTABLE and NORMAL.

" + }, + "fileContent":{ + "shape":"FileContent", + "documentation":"

The content of the file, if a source file is not specified.

" + }, + "sourceFile":{ + "shape":"SourceFileSpecifier", + "documentation":"

The name and full path of the file that contains the changes you want to make as part of the commit, if you are not providing the file content directly.

" + } + }, + "documentation":"

Information about a file that will be added or updated as part of a commit.

" + }, + "PutFileEntryConflictException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because one or more files specified in the commit reference both a file and a folder.

", + "exception":true + }, + "PutFileInput":{ + "type":"structure", + "required":[ + "repositoryName", + "branchName", + "fileContent", + "filePath" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to add or update the file.

" + }, + "branchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch where you want to add or update the file. If this is an empty repository, this branch will be created.

" + }, + "fileContent":{ + "shape":"FileContent", + "documentation":"

The content of the file, in binary object format.

" + }, + "filePath":{ + "shape":"Path", + "documentation":"

The name of the file you want to add or update, including the relative path to the file in the repository.

If the path does not currently exist in the repository, the path will be created as part of adding the file.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode permissions of the blob. Valid file mode permissions are listed below.

" + }, + "parentCommitId":{ + "shape":"CommitId", + "documentation":"

The full commit ID of the head commit in the branch where you want to add or update the file. If this is an empty repository, no commit ID is required. If this is not an empty repository, a commit ID is required.

The commit ID must match the ID of the head commit at the time of the operation, or an error will occur, and the file will not be added or updated.

" + }, + "commitMessage":{ + "shape":"Message", + "documentation":"

A message about why this file was added or updated. While optional, adding a message is strongly encouraged in order to provide a more useful commit history for your repository.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the person adding or updating the file. While optional, adding a name is strongly encouraged in order to provide a more useful commit history for your repository.

" + }, + "email":{ + "shape":"Email", + "documentation":"

An email address for the person adding or updating the file.

" + } + } + }, + "PutFileOutput":{ + "type":"structure", + "required":[ + "commitId", + "blobId", + "treeId" + ], + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The full SHA of the commit that contains this file change.

" + }, + "blobId":{ + "shape":"ObjectId", + "documentation":"

The ID of the blob, which is its SHA-1 pointer.

" + }, + "treeId":{ + "shape":"ObjectId", + "documentation":"

The full SHA-1 pointer of the tree information for the commit that contains this file change.

" + } + } + }, + "PutRepositoryTriggersInput":{ + "type":"structure", + "required":[ + "repositoryName", + "triggers" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository where you want to create or update the trigger.

" + }, + "triggers":{ + "shape":"RepositoryTriggersList", + "documentation":"

The JSON block of configuration information for each trigger.

" + } + }, + "documentation":"

Represents the input ofa put repository triggers operation.

" + }, + "PutRepositoryTriggersOutput":{ + "type":"structure", + "members":{ + "configurationId":{ + "shape":"RepositoryTriggersConfigurationId", + "documentation":"

The system-generated unique ID for the create or update operation.

" + } + }, + "documentation":"

Represents the output of a put repository triggers operation.

" + }, + "ReferenceDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified reference does not exist. You must provide a full commit ID.

", + "exception":true + }, + "ReferenceName":{"type":"string"}, + "ReferenceNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A reference name is required, but none was provided.

", + "exception":true + }, + "ReferenceTypeNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified reference is not a supported type.

", + "exception":true + }, + "RelativeFileVersionEnum":{ + "type":"string", + "enum":[ + "BEFORE", + "AFTER" + ] + }, + "ReplaceContentEntries":{ + "type":"list", + "member":{"shape":"ReplaceContentEntry"} + }, + "ReplaceContentEntry":{ + "type":"structure", + "required":[ + "filePath", + "replacementType" + ], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The path of the conflicting file.

" + }, + "replacementType":{ + "shape":"ReplacementTypeEnum", + "documentation":"

The replacement type to use when determining how to resolve the conflict.

" + }, + "content":{ + "shape":"FileContent", + "documentation":"

The base-64 encoded content to use when the replacement type is USE_NEW_CONTENT.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode to apply during conflict resoltion.

" + } + }, + "documentation":"

Information about a replacement content entry in the conflict of a merge or pull request operation.

" + }, + "ReplacementContentRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

USE_NEW_CONTENT was specified but no replacement content has been provided.

", + "exception":true + }, + "ReplacementTypeEnum":{ + "type":"string", + "enum":[ + "KEEP_BASE", + "KEEP_SOURCE", + "KEEP_DESTINATION", + "USE_NEW_CONTENT" + ] + }, + "ReplacementTypeRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A replacement type is required.

", + "exception":true + }, + "RepositoryDescription":{ + "type":"string", + "max":1000 + }, + "RepositoryDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified repository does not exist.

", + "exception":true + }, + "RepositoryId":{"type":"string"}, + "RepositoryLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A repository resource limit was exceeded.

", + "exception":true + }, + "RepositoryMetadata":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"AccountId", + "documentation":"

The ID of the AWS account associated with the repository.

" + }, + "repositoryId":{ + "shape":"RepositoryId", + "documentation":"

The ID of the repository.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository's name.

" + }, + "repositoryDescription":{ + "shape":"RepositoryDescription", + "documentation":"

A comment or description about the repository.

" + }, + "defaultBranch":{ + "shape":"BranchName", + "documentation":"

The repository's default branch name.

" + }, + "lastModifiedDate":{ + "shape":"LastModifiedDate", + "documentation":"

The date and time the repository was last modified, in timestamp format.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The date and time the repository was created, in timestamp format.

" + }, + "cloneUrlHttp":{ + "shape":"CloneUrlHttp", + "documentation":"

The URL to use for cloning the repository over HTTPS.

" + }, + "cloneUrlSsh":{ + "shape":"CloneUrlSsh", + "documentation":"

The URL to use for cloning the repository over SSH.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the repository.

" + } + }, + "documentation":"

Information about a repository.

" + }, + "RepositoryMetadataList":{ + "type":"list", + "member":{"shape":"RepositoryMetadata"} + }, + "RepositoryName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[\\w\\.-]+" + }, + "RepositoryNameExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified repository name already exists.

", + "exception":true + }, + "RepositoryNameIdPair":{ + "type":"structure", + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name associated with the repository.

" + }, + "repositoryId":{ + "shape":"RepositoryId", + "documentation":"

The ID associated with the repository.

" + } + }, + "documentation":"

Information about a repository name and ID.

" + }, + "RepositoryNameIdPairList":{ + "type":"list", + "member":{"shape":"RepositoryNameIdPair"} + }, + "RepositoryNameList":{ + "type":"list", + "member":{"shape":"RepositoryName"} + }, + "RepositoryNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A repository name is required but was not specified.

", + "exception":true + }, + "RepositoryNamesRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A repository names object is required but was not specified.

", + "exception":true + }, + "RepositoryNotAssociatedWithPullRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The repository does not contain any pull requests with that pull request ID. Use GetPullRequest to verify the correct repository name for the pull request ID.

", + "exception":true + }, + "RepositoryNotFoundList":{ + "type":"list", + "member":{"shape":"RepositoryName"} + }, + "RepositoryTrigger":{ + "type":"structure", + "required":[ + "name", + "destinationArn", + "events" + ], + "members":{ + "name":{ + "shape":"RepositoryTriggerName", + "documentation":"

The name of the trigger.

" + }, + "destinationArn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon SNS.

" + }, + "customData":{ + "shape":"RepositoryTriggerCustomData", + "documentation":"

Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.

" + }, + "branches":{ + "shape":"BranchNameList", + "documentation":"

The branches that will be included in the trigger configuration. If you specify an empty array, the trigger will apply to all branches.

Although no content is required in the array, you must include the array itself.

" + }, + "events":{ + "shape":"RepositoryTriggerEventList", + "documentation":"

The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon SNS.

The valid value \"all\" cannot be used with any other values.

" + } + }, + "documentation":"

Information about a trigger for a repository.

" + }, + "RepositoryTriggerBranchNameListRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

At least one branch name is required but was not specified in the trigger configuration.

", + "exception":true + }, + "RepositoryTriggerCustomData":{"type":"string"}, + "RepositoryTriggerDestinationArnRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A destination ARN for the target service for the trigger is required but was not specified.

", + "exception":true + }, + "RepositoryTriggerEventEnum":{ + "type":"string", + "enum":[ + "all", + "updateReference", + "createReference", + "deleteReference" + ] + }, + "RepositoryTriggerEventList":{ + "type":"list", + "member":{"shape":"RepositoryTriggerEventEnum"} + }, + "RepositoryTriggerEventsListRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

At least one event for the trigger is required but was not specified.

", + "exception":true + }, + "RepositoryTriggerExecutionFailure":{ + "type":"structure", + "members":{ + "trigger":{ + "shape":"RepositoryTriggerName", + "documentation":"

The name of the trigger that did not run.

" + }, + "failureMessage":{ + "shape":"RepositoryTriggerExecutionFailureMessage", + "documentation":"

Additional message information about the trigger that did not run.

" + } + }, + "documentation":"

A trigger failed to run.

" + }, + "RepositoryTriggerExecutionFailureList":{ + "type":"list", + "member":{"shape":"RepositoryTriggerExecutionFailure"} + }, + "RepositoryTriggerExecutionFailureMessage":{"type":"string"}, + "RepositoryTriggerName":{"type":"string"}, + "RepositoryTriggerNameList":{ + "type":"list", + "member":{"shape":"RepositoryTriggerName"} + }, + "RepositoryTriggerNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A name for the trigger is required but was not specified.

", + "exception":true + }, + "RepositoryTriggersConfigurationId":{"type":"string"}, + "RepositoryTriggersList":{ + "type":"list", + "member":{"shape":"RepositoryTrigger"} + }, + "RepositoryTriggersListRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The list of triggers for the repository is required but was not specified.

", + "exception":true + }, + "ResourceArn":{"type":"string"}, + "ResourceArnRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A valid Amazon Resource Name (ARN) for an AWS CodeCommit resource is required. For a list of valid resources in AWS CodeCommit, see CodeCommit Resources and Operations in the AWS CodeCommit User Guide.

", + "exception":true + }, + "RestrictedSourceFileException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because one of the changes specifies copying or moving a .gitkeep file.

", + "exception":true + }, + "SameFileContentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The file was not added or updated because the content of the file is exactly the same as the content of that file in the repository and branch that you specified.

", + "exception":true + }, + "SamePathRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because one or more changes in this commit duplicate actions in the same file path. For example, you cannot make the same delete request to the same file in the same file path twice, or make a delete request and a move request to the same file as part of the same commit.

", + "exception":true + }, + "SetFileModeEntries":{ + "type":"list", + "member":{"shape":"SetFileModeEntry"} + }, + "SetFileModeEntry":{ + "type":"structure", + "required":[ + "filePath", + "fileMode" + ], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The full path to the file, including the name of the file.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode for the file.

" + } + }, + "documentation":"

Information about the file mode changes.

" + }, + "SortByEnum":{ + "type":"string", + "enum":[ + "repositoryName", + "lastModifiedDate" + ] + }, + "SourceAndDestinationAreSameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The source branch and the destination branch for the pull request are the same. You must specify different branches for the source and destination.

", + "exception":true + }, + "SourceFileOrContentRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The commit cannot be created because no source files or file content have been specified for the commit.

", + "exception":true + }, + "SourceFileSpecifier":{ + "type":"structure", + "required":["filePath"], + "members":{ + "filePath":{ + "shape":"Path", + "documentation":"

The full path to the file, including the name of the file.

" + }, + "isMove":{ + "shape":"IsMove", + "documentation":"

Whether to remove the source file from the parent commit.

" + } + }, + "documentation":"

Information about a source file that is part of changes made in a commit.

" + }, + "SubModule":{ + "type":"structure", + "members":{ + "commitId":{ + "shape":"ObjectId", + "documentation":"

The commit ID that contains the reference to the submodule.

" + }, + "absolutePath":{ + "shape":"Path", + "documentation":"

The fully qualified path to the folder that contains the reference to the submodule.

" + }, + "relativePath":{ + "shape":"Path", + "documentation":"

The relative path of the submodule from the folder where the query originated.

" + } + }, + "documentation":"

Returns information about a submodule reference in a repository folder.

" + }, + "SubModuleList":{ + "type":"list", + "member":{"shape":"SubModule"} + }, + "SymbolicLink":{ + "type":"structure", + "members":{ + "blobId":{ + "shape":"ObjectId", + "documentation":"

The blob ID that contains the information about the symbolic link.

" + }, + "absolutePath":{ + "shape":"Path", + "documentation":"

The fully-qualified path to the folder that contains the symbolic link.

" + }, + "relativePath":{ + "shape":"Path", + "documentation":"

The relative path of the symbolic link from the folder where the query originated.

" + }, + "fileMode":{ + "shape":"FileModeTypeEnum", + "documentation":"

The file mode permissions of the blob that cotains information about the symbolic link.

" + } + }, + "documentation":"

Returns information about a symbolic link in a repository folder.

" + }, + "SymbolicLinkList":{ + "type":"list", + "member":{"shape":"SymbolicLink"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeysList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagKeysListRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A list of tag keys is required. The list cannot be empty or null.

", + "exception":true + }, + "TagPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tag policy is not valid.

", + "exception":true + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.

" + }, + "tags":{ + "shape":"TagsMap", + "documentation":"

The key-value pair to use when tagging this repository.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagsMapRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A map of tags is required.

", + "exception":true + }, + "Target":{ + "type":"structure", + "required":[ + "repositoryName", + "sourceReference" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the pull request.

" + }, + "sourceReference":{ + "shape":"ReferenceName", + "documentation":"

The branch of the repository that contains the changes for the pull request. Also known as the source branch.

" + }, + "destinationReference":{ + "shape":"ReferenceName", + "documentation":"

The branch of the repository where the pull request changes will be merged into. Also known as the destination branch.

" + } + }, + "documentation":"

Returns information about a target for a pull request.

" + }, + "TargetList":{ + "type":"list", + "member":{"shape":"Target"} + }, + "TargetRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A pull request target is required. It cannot be empty or null. A pull request target must contain the full values for the repository name, source branch, and destination branch for the pull request.

", + "exception":true + }, + "TargetsRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An array of target objects is required. It cannot be empty or null.

", + "exception":true + }, + "TestRepositoryTriggersInput":{ + "type":"structure", + "required":[ + "repositoryName", + "triggers" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository in which to test the triggers.

" + }, + "triggers":{ + "shape":"RepositoryTriggersList", + "documentation":"

The list of triggers to test.

" + } + }, + "documentation":"

Represents the input of a test repository triggers operation.

" + }, + "TestRepositoryTriggersOutput":{ + "type":"structure", + "members":{ + "successfulExecutions":{ + "shape":"RepositoryTriggerNameList", + "documentation":"

The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas.

" + }, + "failedExecutions":{ + "shape":"RepositoryTriggerExecutionFailureList", + "documentation":"

The list of triggers that were not able to be tested. This list provides the names of the triggers that could not be tested, separated by commas.

" + } + }, + "documentation":"

Represents the output of a test repository triggers operation.

" + }, + "TipOfSourceReferenceIsDifferentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tip of the source branch in the destination repository does not match the tip of the source branch specified in your request. The pull request might have been updated. Make sure that you have the latest changes.

", + "exception":true + }, + "TipsDivergenceExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The divergence between the tips of the provided commit specifiers is too great to determine whether there might be any merge conflicts. Locally compare the specifiers using git diff or a diff tool.

", + "exception":true + }, + "Title":{ + "type":"string", + "max":150 + }, + "TitleRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A pull request title is required. It cannot be empty or null.

", + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of tags for an AWS CodeCommit resource has been exceeded.

", + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which you want to remove tags.

" + }, + "tagKeys":{ + "shape":"TagKeysList", + "documentation":"

The tag key for each tag that you want to remove from the resource.

" + } + } + }, + "UpdateCommentInput":{ + "type":"structure", + "required":[ + "commentId", + "content" + ], + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The system-generated ID of the comment you want to update. To get this ID, use GetCommentsForComparedCommit or GetCommentsForPullRequest.

" + }, + "content":{ + "shape":"Content", + "documentation":"

The updated content with which you want to replace the existing content of the comment.

" + } + } + }, + "UpdateCommentOutput":{ + "type":"structure", + "members":{ + "comment":{ + "shape":"Comment", + "documentation":"

Information about the updated comment.

" + } + } + }, + "UpdateDefaultBranchInput":{ + "type":"structure", + "required":[ + "repositoryName", + "defaultBranchName" + ], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to set or change the default branch for.

" + }, + "defaultBranchName":{ + "shape":"BranchName", + "documentation":"

The name of the branch to set as the default.

" + } + }, + "documentation":"

Represents the input of an update default branch operation.

" + }, + "UpdatePullRequestDescriptionInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "description" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The updated content of the description for the pull request. This content will replace the existing description.

" + } + } + }, + "UpdatePullRequestDescriptionOutput":{ + "type":"structure", + "required":["pullRequest"], + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the updated pull request.

" + } + } + }, + "UpdatePullRequestStatusInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "pullRequestStatus" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "pullRequestStatus":{ + "shape":"PullRequestStatusEnum", + "documentation":"

The status of the pull request. The only valid operations are to update the status from OPEN to OPEN, OPEN to CLOSED or from from CLOSED to CLOSED.

" + } + } + }, + "UpdatePullRequestStatusOutput":{ + "type":"structure", + "required":["pullRequest"], + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the pull request.

" + } + } + }, + "UpdatePullRequestTitleInput":{ + "type":"structure", + "required":[ + "pullRequestId", + "title" + ], + "members":{ + "pullRequestId":{ + "shape":"PullRequestId", + "documentation":"

The system-generated ID of the pull request. To get this ID, use ListPullRequests.

" + }, + "title":{ + "shape":"Title", + "documentation":"

The updated title of the pull request. This will replace the existing title.

" + } + } + }, + "UpdatePullRequestTitleOutput":{ + "type":"structure", + "required":["pullRequest"], + "members":{ + "pullRequest":{ + "shape":"PullRequest", + "documentation":"

Information about the updated pull request.

" + } + } + }, + "UpdateRepositoryDescriptionInput":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to set or change the comment or description for.

" + }, + "repositoryDescription":{ + "shape":"RepositoryDescription", + "documentation":"

The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

" + } + }, + "documentation":"

Represents the input of an update repository description operation.

" + }, + "UpdateRepositoryNameInput":{ + "type":"structure", + "required":[ + "oldName", + "newName" + ], + "members":{ + "oldName":{ + "shape":"RepositoryName", + "documentation":"

The existing name of the repository.

" + }, + "newName":{ + "shape":"RepositoryName", + "documentation":"

The new name for the repository.

" + } + }, + "documentation":"

Represents the input of an update repository description operation.

" + }, + "UserInfo":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the user who made the specified commit.

" + }, + "email":{ + "shape":"Email", + "documentation":"

The email address associated with the user who made the commit, if any.

" + }, + "date":{ + "shape":"Date", + "documentation":"

The date when the specified commit was commited, in timestamp format with GMT offset.

" + } + }, + "documentation":"

Information about the user who made a specified commit.

" + }, + "blob":{"type":"blob"} + }, + "documentation":"AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

  • BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.

  • CreateRepository, which creates an AWS CodeCommit repository.

  • DeleteRepository, which deletes an AWS CodeCommit repository.

  • GetRepository, which returns information about a specified repository.

  • ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.

  • UpdateRepositoryDescription, which sets or updates the description of the repository.

  • UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

  • CreateBranch, which creates a new branch in a specified repository.

  • DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

  • GetBranch, which returns information about a specified branch.

  • ListBranches, which lists all branches for a specified repository.

  • UpdateDefaultBranch, which changes the default branch for a repository.

Files, by calling the following:

  • DeleteFile, which deletes the content of a specified file from a specified branch.

  • GetBlob, which returns the base-64 encoded content of an individual Git blob object within a repository.

  • GetFile, which returns the base-64 encoded content of a specified file.

  • GetFolder, which returns the contents of a specified folder or directory.

  • PutFile, which adds or modifies a single file in a specified repository and branch.

Commits, by calling the following:

  • BatchGetCommits, which returns information about one or more commits in a repository

  • CreateCommit, which creates a commit for changes to a repository.

  • GetCommit, which returns information about a commit, including commit messages and author and committer information.

  • GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference).

Merges, by calling the following:

  • BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

  • CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.

  • DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.

  • GetMergeCommit, which returns information about the merge between a source and destination commit.

  • GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.

  • GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

  • MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

  • MergeBranchesBySquash, which merges two branches using the squash merge option.

  • MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

Pull requests, by calling the following:

Comments in a repository, by calling the following:

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

  • TagResource, which adds or updates tags for a resource in AWS CodeCommit.

  • UntagResource, which removes tags for a resource in AWS CodeCommit.

Triggers, by calling the following:

  • GetRepositoryTriggers, which returns information about triggers configured for a repository.

  • PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.

  • TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target.

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

" +} diff --git a/aws/dist/botocore/data/codedeploy/2014-10-06/examples-1.json b/aws/dist/botocore/data/codedeploy/2014-10-06/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/codedeploy/2014-10-06/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/codedeploy/2014-10-06/paginators-1.json b/aws/dist/botocore/data/codedeploy/2014-10-06/paginators-1.json new file mode 100644 index 00000000..aae3fad3 --- /dev/null +++ b/aws/dist/botocore/data/codedeploy/2014-10-06/paginators-1.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "ListApplicationRevisions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "revisions" + }, + "ListApplications": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "applications" + }, + "ListDeploymentConfigs": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deploymentConfigsList" + }, + "ListDeploymentGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deploymentGroups" + }, + "ListDeploymentInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "instancesList" + }, + "ListDeployments": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "deployments" + }, + "ListDeploymentTargets": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "targetIds" + }, + "ListGitHubAccountTokenNames": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "tokenNameList" + }, + "ListOnPremisesInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "instanceNames" + } + } +} diff --git a/aws/dist/botocore/data/codedeploy/2014-10-06/service-2.json b/aws/dist/botocore/data/codedeploy/2014-10-06/service-2.json new file mode 100644 index 00000000..8f7fcc25 --- /dev/null +++ b/aws/dist/botocore/data/codedeploy/2014-10-06/service-2.json @@ -0,0 +1,4698 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-06", + "endpointPrefix":"codedeploy", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CodeDeploy", + "serviceFullName":"AWS CodeDeploy", + "serviceId":"CodeDeploy", + "signatureVersion":"v4", + "targetPrefix":"CodeDeploy_20141006", + "uid":"codedeploy-2014-10-06" + }, + "operations":{ + "AddTagsToOnPremisesInstances":{ + "name":"AddTagsToOnPremisesInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToOnPremisesInstancesInput"}, + "errors":[ + {"shape":"InstanceNameRequiredException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"TagRequiredException"}, + {"shape":"InvalidTagException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"InstanceLimitExceededException"}, + {"shape":"InstanceNotRegisteredException"} + ], + "documentation":"

Adds tags to on-premises instances.

" + }, + "BatchGetApplicationRevisions":{ + "name":"BatchGetApplicationRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetApplicationRevisionsInput"}, + "output":{"shape":"BatchGetApplicationRevisionsOutput"}, + "errors":[ + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"RevisionRequiredException"}, + {"shape":"InvalidRevisionException"}, + {"shape":"BatchLimitExceededException"} + ], + "documentation":"

Gets information about one or more application revisions. The maximum number of application revisions that can be returned is 25.

" + }, + "BatchGetApplications":{ + "name":"BatchGetApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetApplicationsInput"}, + "output":{"shape":"BatchGetApplicationsOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"BatchLimitExceededException"} + ], + "documentation":"

Gets information about one or more applications. The maximum number of applications that can be returned is 25.

" + }, + "BatchGetDeploymentGroups":{ + "name":"BatchGetDeploymentGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetDeploymentGroupsInput"}, + "output":{"shape":"BatchGetDeploymentGroupsOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"BatchLimitExceededException"}, + {"shape":"DeploymentConfigDoesNotExistException"} + ], + "documentation":"

Gets information about one or more deployment groups.

" + }, + "BatchGetDeploymentInstances":{ + "name":"BatchGetDeploymentInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetDeploymentInstancesInput"}, + "output":{"shape":"BatchGetDeploymentInstancesOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"InstanceIdRequiredException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"BatchLimitExceededException"}, + {"shape":"InvalidComputePlatformException"} + ], + "documentation":"

This method works, but is deprecated. Use BatchGetDeploymentTargets instead.

Returns an array of one or more instances associated with a deployment. This method works with EC2/On-premises and AWS Lambda compute platforms. The newer BatchGetDeploymentTargets works with all compute platforms. The maximum number of instances that can be returned is 25.

", + "deprecated":true, + "deprecatedMessage":"This operation is deprecated, use BatchGetDeploymentTargets instead." + }, + "BatchGetDeploymentTargets":{ + "name":"BatchGetDeploymentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetDeploymentTargetsInput"}, + "output":{"shape":"BatchGetDeploymentTargetsOutput"}, + "errors":[ + {"shape":"InvalidDeploymentIdException"}, + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentNotStartedException"}, + {"shape":"DeploymentTargetIdRequiredException"}, + {"shape":"InvalidDeploymentTargetIdException"}, + {"shape":"DeploymentTargetDoesNotExistException"}, + {"shape":"DeploymentTargetListSizeExceededException"} + ], + "documentation":"

Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances. The maximum number of targets that can be returned is 25.

The type of targets returned depends on the deployment's compute platform:

  • EC2/On-premises: Information about EC2 instance targets.

  • AWS Lambda: Information about Lambda functions targets.

  • Amazon ECS: Information about Amazon ECS service targets.

" + }, + "BatchGetDeployments":{ + "name":"BatchGetDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetDeploymentsInput"}, + "output":{"shape":"BatchGetDeploymentsOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"BatchLimitExceededException"} + ], + "documentation":"

Gets information about one or more deployments. The maximum number of deployments that can be returned is 25.

" + }, + "BatchGetOnPremisesInstances":{ + "name":"BatchGetOnPremisesInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetOnPremisesInstancesInput"}, + "output":{"shape":"BatchGetOnPremisesInstancesOutput"}, + "errors":[ + {"shape":"InstanceNameRequiredException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"BatchLimitExceededException"} + ], + "documentation":"

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

" + }, + "ContinueDeployment":{ + "name":"ContinueDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ContinueDeploymentInput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentAlreadyCompletedException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"DeploymentIsNotInReadyStateException"}, + {"shape":"UnsupportedActionForDeploymentTypeException"}, + {"shape":"InvalidDeploymentWaitTypeException"}, + {"shape":"InvalidDeploymentStatusException"} + ], + "documentation":"

For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.)

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationInput"}, + "output":{"shape":"CreateApplicationOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationAlreadyExistsException"}, + {"shape":"ApplicationLimitExceededException"}, + {"shape":"InvalidComputePlatformException"}, + {"shape":"InvalidTagsToAddException"} + ], + "documentation":"

Creates an application.

" + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentInput"}, + "output":{"shape":"CreateDeploymentOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"RevisionRequiredException"}, + {"shape":"RevisionDoesNotExistException"}, + {"shape":"InvalidRevisionException"}, + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"DescriptionTooLongException"}, + {"shape":"DeploymentLimitExceededException"}, + {"shape":"InvalidTargetInstancesException"}, + {"shape":"InvalidAutoRollbackConfigException"}, + {"shape":"InvalidLoadBalancerInfoException"}, + {"shape":"InvalidFileExistsBehaviorException"}, + {"shape":"InvalidRoleException"}, + {"shape":"InvalidAutoScalingGroupException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidUpdateOutdatedInstancesOnlyValueException"}, + {"shape":"InvalidIgnoreApplicationStopFailuresValueException"}, + {"shape":"InvalidGitHubAccountTokenException"} + ], + "documentation":"

Deploys an application revision through the specified deployment group.

" + }, + "CreateDeploymentConfig":{ + "name":"CreateDeploymentConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentConfigInput"}, + "output":{"shape":"CreateDeploymentConfigOutput"}, + "errors":[ + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigNameRequiredException"}, + {"shape":"DeploymentConfigAlreadyExistsException"}, + {"shape":"InvalidMinimumHealthyHostValueException"}, + {"shape":"DeploymentConfigLimitExceededException"}, + {"shape":"InvalidComputePlatformException"}, + {"shape":"InvalidTrafficRoutingConfigurationException"} + ], + "documentation":"

Creates a deployment configuration.

" + }, + "CreateDeploymentGroup":{ + "name":"CreateDeploymentGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentGroupInput"}, + "output":{"shape":"CreateDeploymentGroupOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"DeploymentGroupAlreadyExistsException"}, + {"shape":"InvalidEC2TagException"}, + {"shape":"InvalidTagException"}, + {"shape":"InvalidAutoScalingGroupException"}, + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"RoleRequiredException"}, + {"shape":"InvalidRoleException"}, + {"shape":"DeploymentGroupLimitExceededException"}, + {"shape":"LifecycleHookLimitExceededException"}, + {"shape":"InvalidTriggerConfigException"}, + {"shape":"TriggerTargetsLimitExceededException"}, + {"shape":"InvalidAlarmConfigException"}, + {"shape":"AlarmsLimitExceededException"}, + {"shape":"InvalidAutoRollbackConfigException"}, + {"shape":"InvalidLoadBalancerInfoException"}, + {"shape":"InvalidDeploymentStyleException"}, + {"shape":"InvalidBlueGreenDeploymentConfigurationException"}, + {"shape":"InvalidEC2TagCombinationException"}, + {"shape":"InvalidOnPremisesTagCombinationException"}, + {"shape":"TagSetListLimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidECSServiceException"}, + {"shape":"InvalidTargetGroupPairException"}, + {"shape":"ECSServiceMappingLimitExceededException"}, + {"shape":"InvalidTagsToAddException"} + ], + "documentation":"

Creates a deployment group to which application revisions are deployed.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationInput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"InvalidRoleException"} + ], + "documentation":"

Deletes an application.

" + }, + "DeleteDeploymentConfig":{ + "name":"DeleteDeploymentConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeploymentConfigInput"}, + "errors":[ + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigNameRequiredException"}, + {"shape":"DeploymentConfigInUseException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Deletes a deployment configuration.

A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.

" + }, + "DeleteDeploymentGroup":{ + "name":"DeleteDeploymentGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeploymentGroupInput"}, + "output":{"shape":"DeleteDeploymentGroupOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"InvalidRoleException"} + ], + "documentation":"

Deletes a deployment group.

" + }, + "DeleteGitHubAccountToken":{ + "name":"DeleteGitHubAccountToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGitHubAccountTokenInput"}, + "output":{"shape":"DeleteGitHubAccountTokenOutput"}, + "errors":[ + {"shape":"GitHubAccountTokenNameRequiredException"}, + {"shape":"GitHubAccountTokenDoesNotExistException"}, + {"shape":"InvalidGitHubAccountTokenNameException"}, + {"shape":"ResourceValidationException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

Deletes a GitHub account connection.

" + }, + "DeregisterOnPremisesInstance":{ + "name":"DeregisterOnPremisesInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterOnPremisesInstanceInput"}, + "errors":[ + {"shape":"InstanceNameRequiredException"}, + {"shape":"InvalidInstanceNameException"} + ], + "documentation":"

Deregisters an on-premises instance.

" + }, + "GetApplication":{ + "name":"GetApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetApplicationInput"}, + "output":{"shape":"GetApplicationOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"} + ], + "documentation":"

Gets information about an application.

" + }, + "GetApplicationRevision":{ + "name":"GetApplicationRevision", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetApplicationRevisionInput"}, + "output":{"shape":"GetApplicationRevisionOutput"}, + "errors":[ + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"RevisionDoesNotExistException"}, + {"shape":"RevisionRequiredException"}, + {"shape":"InvalidRevisionException"} + ], + "documentation":"

Gets information about an application revision.

" + }, + "GetDeployment":{ + "name":"GetDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeploymentInput"}, + "output":{"shape":"GetDeploymentOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"DeploymentDoesNotExistException"} + ], + "documentation":"

Gets information about a deployment.

The content property of the appSpecContent object in the returned revision is always null. Use GetApplicationRevision and the sha256 property of the returned appSpecContent object to get the content of the deployment’s AppSpec file.

" + }, + "GetDeploymentConfig":{ + "name":"GetDeploymentConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeploymentConfigInput"}, + "output":{"shape":"GetDeploymentConfigOutput"}, + "errors":[ + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigNameRequiredException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"InvalidComputePlatformException"} + ], + "documentation":"

Gets information about a deployment configuration.

" + }, + "GetDeploymentGroup":{ + "name":"GetDeploymentGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeploymentGroupInput"}, + "output":{"shape":"GetDeploymentGroupOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"DeploymentConfigDoesNotExistException"} + ], + "documentation":"

Gets information about a deployment group.

" + }, + "GetDeploymentInstance":{ + "name":"GetDeploymentInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeploymentInstanceInput"}, + "output":{"shape":"GetDeploymentInstanceOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"InstanceIdRequiredException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"InstanceDoesNotExistException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"InvalidComputePlatformException"} + ], + "documentation":"

Gets information about an instance as part of a deployment.

", + "deprecated":true, + "deprecatedMessage":"This operation is deprecated, use GetDeploymentTarget instead." + }, + "GetDeploymentTarget":{ + "name":"GetDeploymentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeploymentTargetInput"}, + "output":{"shape":"GetDeploymentTargetOutput"}, + "errors":[ + {"shape":"InvalidDeploymentIdException"}, + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentNotStartedException"}, + {"shape":"DeploymentTargetIdRequiredException"}, + {"shape":"InvalidDeploymentTargetIdException"}, + {"shape":"DeploymentTargetDoesNotExistException"}, + {"shape":"InvalidInstanceNameException"} + ], + "documentation":"

Returns information about a deployment target.

" + }, + "GetOnPremisesInstance":{ + "name":"GetOnPremisesInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOnPremisesInstanceInput"}, + "output":{"shape":"GetOnPremisesInstanceOutput"}, + "errors":[ + {"shape":"InstanceNameRequiredException"}, + {"shape":"InstanceNotRegisteredException"}, + {"shape":"InvalidInstanceNameException"} + ], + "documentation":"

Gets information about an on-premises instance.

" + }, + "ListApplicationRevisions":{ + "name":"ListApplicationRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationRevisionsInput"}, + "output":{"shape":"ListApplicationRevisionsOutput"}, + "errors":[ + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"InvalidSortByException"}, + {"shape":"InvalidSortOrderException"}, + {"shape":"InvalidBucketNameFilterException"}, + {"shape":"InvalidKeyPrefixFilterException"}, + {"shape":"BucketNameFilterRequiredException"}, + {"shape":"InvalidDeployedStateFilterException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists information about revisions for an application.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationsInput"}, + "output":{"shape":"ListApplicationsOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the applications registered with the IAM user or AWS account.

" + }, + "ListDeploymentConfigs":{ + "name":"ListDeploymentConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeploymentConfigsInput"}, + "output":{"shape":"ListDeploymentConfigsOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the deployment configurations with the IAM user or AWS account.

" + }, + "ListDeploymentGroups":{ + "name":"ListDeploymentGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeploymentGroupsInput"}, + "output":{"shape":"ListDeploymentGroupsOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the deployment groups for an application registered with the IAM user or AWS account.

" + }, + "ListDeploymentInstances":{ + "name":"ListDeploymentInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeploymentInstancesInput"}, + "output":{"shape":"ListDeploymentInstancesOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentNotStartedException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"InvalidInstanceStatusException"}, + {"shape":"InvalidInstanceTypeException"}, + {"shape":"InvalidDeploymentInstanceTypeException"}, + {"shape":"InvalidTargetFilterNameException"}, + {"shape":"InvalidComputePlatformException"} + ], + "documentation":"

The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or AWS Lambda.

Lists the instance for a deployment associated with the IAM user or AWS account.

", + "deprecated":true, + "deprecatedMessage":"This operation is deprecated, use ListDeploymentTargets instead." + }, + "ListDeploymentTargets":{ + "name":"ListDeploymentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeploymentTargetsInput"}, + "output":{"shape":"ListDeploymentTargetsOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentNotStartedException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"InvalidInstanceStatusException"}, + {"shape":"InvalidInstanceTypeException"}, + {"shape":"InvalidDeploymentInstanceTypeException"} + ], + "documentation":"

Returns an array of target IDs that are associated a deployment.

" + }, + "ListDeployments":{ + "name":"ListDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeploymentsInput"}, + "output":{"shape":"ListDeploymentsOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"InvalidTimeRangeException"}, + {"shape":"InvalidDeploymentStatusException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists the deployments in a deployment group for an application registered with the IAM user or AWS account.

" + }, + "ListGitHubAccountTokenNames":{ + "name":"ListGitHubAccountTokenNames", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGitHubAccountTokenNamesInput"}, + "output":{"shape":"ListGitHubAccountTokenNamesOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceValidationException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

Lists the names of stored connections to GitHub accounts.

" + }, + "ListOnPremisesInstances":{ + "name":"ListOnPremisesInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOnPremisesInstancesInput"}, + "output":{"shape":"ListOnPremisesInstancesOutput"}, + "errors":[ + {"shape":"InvalidRegistrationStatusException"}, + {"shape":"InvalidTagFilterException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets a list of names for one or more on-premises instances.

Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ArnNotSupportedException"}, + {"shape":"InvalidArnException"}, + {"shape":"ResourceArnRequiredException"} + ], + "documentation":"

Returns a list of tags for the resource identified by a specified ARN. Tags are used to organize and categorize your CodeDeploy resources.

" + }, + "PutLifecycleEventHookExecutionStatus":{ + "name":"PutLifecycleEventHookExecutionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLifecycleEventHookExecutionStatusInput"}, + "output":{"shape":"PutLifecycleEventHookExecutionStatusOutput"}, + "errors":[ + {"shape":"InvalidLifecycleEventHookExecutionStatusException"}, + {"shape":"InvalidLifecycleEventHookExecutionIdException"}, + {"shape":"LifecycleEventAlreadyCompletedException"}, + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"UnsupportedActionForDeploymentTypeException"} + ], + "documentation":"

Sets the result of a Lambda validation function. The function validates one or both lifecycle events (BeforeAllowTraffic and AfterAllowTraffic) and returns Succeeded or Failed.

" + }, + "RegisterApplicationRevision":{ + "name":"RegisterApplicationRevision", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterApplicationRevisionInput"}, + "errors":[ + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"DescriptionTooLongException"}, + {"shape":"RevisionRequiredException"}, + {"shape":"InvalidRevisionException"} + ], + "documentation":"

Registers with AWS CodeDeploy a revision for the specified application.

" + }, + "RegisterOnPremisesInstance":{ + "name":"RegisterOnPremisesInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterOnPremisesInstanceInput"}, + "errors":[ + {"shape":"InstanceNameAlreadyRegisteredException"}, + {"shape":"IamArnRequiredException"}, + {"shape":"IamSessionArnAlreadyRegisteredException"}, + {"shape":"IamUserArnAlreadyRegisteredException"}, + {"shape":"InstanceNameRequiredException"}, + {"shape":"IamUserArnRequiredException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"InvalidIamSessionArnException"}, + {"shape":"InvalidIamUserArnException"}, + {"shape":"MultipleIamArnsProvidedException"} + ], + "documentation":"

Registers an on-premises instance.

Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

" + }, + "RemoveTagsFromOnPremisesInstances":{ + "name":"RemoveTagsFromOnPremisesInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromOnPremisesInstancesInput"}, + "errors":[ + {"shape":"InstanceNameRequiredException"}, + {"shape":"InvalidInstanceNameException"}, + {"shape":"TagRequiredException"}, + {"shape":"InvalidTagException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"InstanceLimitExceededException"}, + {"shape":"InstanceNotRegisteredException"} + ], + "documentation":"

Removes one or more tags from one or more on-premises instances.

" + }, + "SkipWaitTimeForInstanceTermination":{ + "name":"SkipWaitTimeForInstanceTermination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SkipWaitTimeForInstanceTerminationInput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentAlreadyCompletedException"}, + {"shape":"InvalidDeploymentIdException"}, + {"shape":"DeploymentNotStartedException"}, + {"shape":"UnsupportedActionForDeploymentTypeException"} + ], + "documentation":"

In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete.

", + "deprecated":true, + "deprecatedMessage":"This operation is deprecated, use ContinueDeployment with DeploymentWaitType instead." + }, + "StopDeployment":{ + "name":"StopDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDeploymentInput"}, + "output":{"shape":"StopDeploymentOutput"}, + "errors":[ + {"shape":"DeploymentIdRequiredException"}, + {"shape":"DeploymentDoesNotExistException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"DeploymentAlreadyCompletedException"}, + {"shape":"InvalidDeploymentIdException"} + ], + "documentation":"

Attempts to stop an ongoing deployment.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ResourceArnRequiredException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"TagRequiredException"}, + {"shape":"InvalidTagsToAddException"}, + {"shape":"ArnNotSupportedException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Associates the list of tags in the input Tags parameter with the resource identified by the ResourceArn input parameter.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ResourceArnRequiredException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"TagRequiredException"}, + {"shape":"InvalidTagsToAddException"}, + {"shape":"ArnNotSupportedException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Disassociates a resource from a list of tags. The resource is identified by the ResourceArn input parameter. The tags are identfied by the list of keys in the TagKeys input parameter.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationInput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationAlreadyExistsException"}, + {"shape":"ApplicationDoesNotExistException"} + ], + "documentation":"

Changes the name of an application.

" + }, + "UpdateDeploymentGroup":{ + "name":"UpdateDeploymentGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDeploymentGroupInput"}, + "output":{"shape":"UpdateDeploymentGroupOutput"}, + "errors":[ + {"shape":"ApplicationNameRequiredException"}, + {"shape":"InvalidApplicationNameException"}, + {"shape":"ApplicationDoesNotExistException"}, + {"shape":"InvalidDeploymentGroupNameException"}, + {"shape":"DeploymentGroupAlreadyExistsException"}, + {"shape":"DeploymentGroupNameRequiredException"}, + {"shape":"DeploymentGroupDoesNotExistException"}, + {"shape":"InvalidEC2TagException"}, + {"shape":"InvalidTagException"}, + {"shape":"InvalidAutoScalingGroupException"}, + {"shape":"InvalidDeploymentConfigNameException"}, + {"shape":"DeploymentConfigDoesNotExistException"}, + {"shape":"InvalidRoleException"}, + {"shape":"LifecycleHookLimitExceededException"}, + {"shape":"InvalidTriggerConfigException"}, + {"shape":"TriggerTargetsLimitExceededException"}, + {"shape":"InvalidAlarmConfigException"}, + {"shape":"AlarmsLimitExceededException"}, + {"shape":"InvalidAutoRollbackConfigException"}, + {"shape":"InvalidLoadBalancerInfoException"}, + {"shape":"InvalidDeploymentStyleException"}, + {"shape":"InvalidBlueGreenDeploymentConfigurationException"}, + {"shape":"InvalidEC2TagCombinationException"}, + {"shape":"InvalidOnPremisesTagCombinationException"}, + {"shape":"TagSetListLimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidECSServiceException"}, + {"shape":"InvalidTargetGroupPairException"}, + {"shape":"ECSServiceMappingLimitExceededException"} + ], + "documentation":"

Changes information about a deployment group.

" + } + }, + "shapes":{ + "AddTagsToOnPremisesInstancesInput":{ + "type":"structure", + "required":[ + "tags", + "instanceNames" + ], + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The tag key-value pairs to add to the on-premises instances.

Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.

" + }, + "instanceNames":{ + "shape":"InstanceNameList", + "documentation":"

The names of the on-premises instances to which to add tags.

" + } + }, + "documentation":"

Represents the input of, and adds tags to, an on-premises instance operation.

" + }, + "AdditionalDeploymentStatusInfo":{ + "type":"string", + "deprecated":true, + "deprecatedMessage":"AdditionalDeploymentStatusInfo is deprecated, use DeploymentStatusMessageList instead." + }, + "Alarm":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AlarmName", + "documentation":"

The name of the alarm. Maximum length is 255 characters. Each alarm name can be used only once in a list of alarms.

" + } + }, + "documentation":"

Information about an alarm.

" + }, + "AlarmConfiguration":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the alarm configuration is enabled.

" + }, + "ignorePollAlarmFailure":{ + "shape":"Boolean", + "documentation":"

Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch. The default value is false.

  • true: The deployment proceeds even if alarm status information can't be retrieved from Amazon CloudWatch.

  • false: The deployment stops if alarm status information can't be retrieved from Amazon CloudWatch.

" + }, + "alarms":{ + "shape":"AlarmList", + "documentation":"

A list of alarms configured for the deployment group. A maximum of 10 alarms can be added to a deployment group.

" + } + }, + "documentation":"

Information about alarms associated with the deployment group.

" + }, + "AlarmList":{ + "type":"list", + "member":{"shape":"Alarm"} + }, + "AlarmName":{"type":"string"}, + "AlarmsLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of alarms for a deployment group (10) was exceeded.

", + "exception":true + }, + "AppSpecContent":{ + "type":"structure", + "members":{ + "content":{ + "shape":"RawStringContent", + "documentation":"

The YAML-formatted or JSON-formatted revision string.

For an AWS Lambda deployment, the content includes a Lambda function name, the alias for its original version, and the alias for its replacement version. The deployment shifts traffic from the original version of the Lambda function to the replacement version.

For an Amazon ECS deployment, the content includes the task name, information about the load balancer that serves traffic to the container, and more.

For both types of deployments, the content can specify Lambda functions that run at specified hooks, such as BeforeInstall, during a deployment.

" + }, + "sha256":{ + "shape":"RawStringSha256", + "documentation":"

The SHA256 hash value of the revision content.

" + } + }, + "documentation":"

A revision for an AWS Lambda or Amazon ECS deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda and Amazon ECS deployments, the revision is the same as the AppSpec file. This method replaces the deprecated RawString data type.

" + }, + "ApplicationAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An application with the specified name with the IAM user or AWS account already exists.

", + "exception":true + }, + "ApplicationDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The application does not exist with the IAM user or AWS account.

", + "exception":true + }, + "ApplicationId":{"type":"string"}, + "ApplicationInfo":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

The application ID.

" + }, + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the application was created.

" + }, + "linkedToGitHub":{ + "shape":"Boolean", + "documentation":"

True if the user has authenticated with GitHub for the specified application. Otherwise, false.

" + }, + "gitHubAccountName":{ + "shape":"GitHubAccountTokenName", + "documentation":"

The name for a connection to a GitHub account.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for deployment of the application (Lambda or Server).

" + } + }, + "documentation":"

Information about an application.

" + }, + "ApplicationLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

More applications were attempted to be created than are allowed.

", + "exception":true + }, + "ApplicationName":{ + "type":"string", + "max":100, + "min":1 + }, + "ApplicationNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The minimum number of required application names was not specified.

", + "exception":true + }, + "ApplicationRevisionSortBy":{ + "type":"string", + "enum":[ + "registerTime", + "firstUsedTime", + "lastUsedTime" + ] + }, + "ApplicationsInfoList":{ + "type":"list", + "member":{"shape":"ApplicationInfo"} + }, + "ApplicationsList":{ + "type":"list", + "member":{"shape":"ApplicationName"} + }, + "Arn":{ + "type":"string", + "max":1011, + "min":1 + }, + "ArnNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified ARN is not supported. For example, it might be an ARN for a resource that is not expected.

", + "exception":true + }, + "AutoRollbackConfiguration":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether a defined automatic rollback configuration is currently enabled.

" + }, + "events":{ + "shape":"AutoRollbackEventsList", + "documentation":"

The event type or types that trigger a rollback.

" + } + }, + "documentation":"

Information about a configuration for automatically rolling back to a previous version of an application revision when a deployment is not completed successfully.

" + }, + "AutoRollbackEvent":{ + "type":"string", + "enum":[ + "DEPLOYMENT_FAILURE", + "DEPLOYMENT_STOP_ON_ALARM", + "DEPLOYMENT_STOP_ON_REQUEST" + ] + }, + "AutoRollbackEventsList":{ + "type":"list", + "member":{"shape":"AutoRollbackEvent"} + }, + "AutoScalingGroup":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AutoScalingGroupName", + "documentation":"

The Auto Scaling group name.

" + }, + "hook":{ + "shape":"AutoScalingGroupHook", + "documentation":"

An Auto Scaling lifecycle event hook name.

" + } + }, + "documentation":"

Information about an Auto Scaling group.

" + }, + "AutoScalingGroupHook":{"type":"string"}, + "AutoScalingGroupList":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"} + }, + "AutoScalingGroupName":{"type":"string"}, + "AutoScalingGroupNameList":{ + "type":"list", + "member":{"shape":"AutoScalingGroupName"} + }, + "BatchGetApplicationRevisionsInput":{ + "type":"structure", + "required":[ + "applicationName", + "revisions" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application about which to get revision information.

" + }, + "revisions":{ + "shape":"RevisionLocationList", + "documentation":"

An array of RevisionLocation objects that specify information to get about the application revisions, including type and location. The maximum number of RevisionLocation objects you can specify is 25.

" + } + }, + "documentation":"

Represents the input of a BatchGetApplicationRevisions operation.

" + }, + "BatchGetApplicationRevisionsOutput":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that corresponds to the revisions.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

Information about errors that might have occurred during the API call.

" + }, + "revisions":{ + "shape":"RevisionInfoList", + "documentation":"

Additional information about the revisions, including the type and location.

" + } + }, + "documentation":"

Represents the output of a BatchGetApplicationRevisions operation.

" + }, + "BatchGetApplicationsInput":{ + "type":"structure", + "required":["applicationNames"], + "members":{ + "applicationNames":{ + "shape":"ApplicationsList", + "documentation":"

A list of application names separated by spaces. The maximum number of application names you can specify is 25.

" + } + }, + "documentation":"

Represents the input of a BatchGetApplications operation.

" + }, + "BatchGetApplicationsOutput":{ + "type":"structure", + "members":{ + "applicationsInfo":{ + "shape":"ApplicationsInfoList", + "documentation":"

Information about the applications.

" + } + }, + "documentation":"

Represents the output of a BatchGetApplications operation.

" + }, + "BatchGetDeploymentGroupsInput":{ + "type":"structure", + "required":[ + "applicationName", + "deploymentGroupNames" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.

" + }, + "deploymentGroupNames":{ + "shape":"DeploymentGroupsList", + "documentation":"

The names of the deployment groups.

" + } + }, + "documentation":"

Represents the input of a BatchGetDeploymentGroups operation.

" + }, + "BatchGetDeploymentGroupsOutput":{ + "type":"structure", + "members":{ + "deploymentGroupsInfo":{ + "shape":"DeploymentGroupInfoList", + "documentation":"

Information about the deployment groups.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

Information about errors that might have occurred during the API call.

" + } + }, + "documentation":"

Represents the output of a BatchGetDeploymentGroups operation.

" + }, + "BatchGetDeploymentInstancesInput":{ + "type":"structure", + "required":[ + "deploymentId", + "instanceIds" + ], + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "instanceIds":{ + "shape":"InstancesList", + "documentation":"

The unique IDs of instances used in the deployment. The maximum number of instance IDs you can specify is 25.

" + } + }, + "documentation":"

Represents the input of a BatchGetDeploymentInstances operation.

" + }, + "BatchGetDeploymentInstancesOutput":{ + "type":"structure", + "members":{ + "instancesSummary":{ + "shape":"InstanceSummaryList", + "documentation":"

Information about the instance.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

Information about errors that might have occurred during the API call.

" + } + }, + "documentation":"

Represents the output of a BatchGetDeploymentInstances operation.

" + }, + "BatchGetDeploymentTargetsInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "targetIds":{ + "shape":"TargetIdList", + "documentation":"

The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.

  • For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget.

  • For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget.

  • For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename>. Their target type is ecsTarget.

" + } + } + }, + "BatchGetDeploymentTargetsOutput":{ + "type":"structure", + "members":{ + "deploymentTargets":{ + "shape":"DeploymentTargetList", + "documentation":"

A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment' compute platform.

  • EC2/On-premises: Each target object is an EC2 or on-premises instance.

  • AWS Lambda: The target object is a specific version of an AWS Lambda function.

  • Amazon ECS: The target object is an Amazon ECS service.

" + } + } + }, + "BatchGetDeploymentsInput":{ + "type":"structure", + "required":["deploymentIds"], + "members":{ + "deploymentIds":{ + "shape":"DeploymentsList", + "documentation":"

A list of deployment IDs, separated by spaces. The maximum number of deployment IDs you can specify is 25.

" + } + }, + "documentation":"

Represents the input of a BatchGetDeployments operation.

" + }, + "BatchGetDeploymentsOutput":{ + "type":"structure", + "members":{ + "deploymentsInfo":{ + "shape":"DeploymentsInfoList", + "documentation":"

Information about the deployments.

" + } + }, + "documentation":"

Represents the output of a BatchGetDeployments operation.

" + }, + "BatchGetOnPremisesInstancesInput":{ + "type":"structure", + "required":["instanceNames"], + "members":{ + "instanceNames":{ + "shape":"InstanceNameList", + "documentation":"

The names of the on-premises instances about which to get information. The maximum number of instance names you can specify is 25.

" + } + }, + "documentation":"

Represents the input of a BatchGetOnPremisesInstances operation.

" + }, + "BatchGetOnPremisesInstancesOutput":{ + "type":"structure", + "members":{ + "instanceInfos":{ + "shape":"InstanceInfoList", + "documentation":"

Information about the on-premises instances.

" + } + }, + "documentation":"

Represents the output of a BatchGetOnPremisesInstances operation.

" + }, + "BatchLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of names or IDs allowed for this request (100) was exceeded.

", + "exception":true + }, + "BlueGreenDeploymentConfiguration":{ + "type":"structure", + "members":{ + "terminateBlueInstancesOnDeploymentSuccess":{ + "shape":"BlueInstanceTerminationOption", + "documentation":"

Information about whether to terminate instances in the original fleet during a blue/green deployment.

" + }, + "deploymentReadyOption":{ + "shape":"DeploymentReadyOption", + "documentation":"

Information about the action to take when newly provisioned instances are ready to receive traffic in a blue/green deployment.

" + }, + "greenFleetProvisioningOption":{ + "shape":"GreenFleetProvisioningOption", + "documentation":"

Information about how instances are provisioned for a replacement environment in a blue/green deployment.

" + } + }, + "documentation":"

Information about blue/green deployment options for a deployment group.

" + }, + "BlueInstanceTerminationOption":{ + "type":"structure", + "members":{ + "action":{ + "shape":"InstanceAction", + "documentation":"

The action to take on instances in the original environment after a successful blue/green deployment.

  • TERMINATE: Instances are terminated after a specified wait time.

  • KEEP_ALIVE: Instances are left running after they are deregistered from the load balancer and removed from the deployment group.

" + }, + "terminationWaitTimeInMinutes":{ + "shape":"Duration", + "documentation":"

For an Amazon EC2 deployment, the number of minutes to wait after a successful blue/green deployment before terminating instances from the original environment.

For an Amazon ECS deployment, the number of minutes before deleting the original (blue) task set. During an Amazon ECS deployment, CodeDeploy shifts traffic from the original (blue) task set to a replacement (green) task set.

The maximum setting is 2880 minutes (2 days).

" + } + }, + "documentation":"

Information about whether instances in the original environment are terminated when a blue/green deployment is successful. BlueInstanceTerminationOption does not apply to Lambda deployments.

" + }, + "Boolean":{"type":"boolean"}, + "BucketNameFilterRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A bucket name is required, but was not provided.

", + "exception":true + }, + "BundleType":{ + "type":"string", + "enum":[ + "tar", + "tgz", + "zip", + "YAML", + "JSON" + ] + }, + "CommitId":{"type":"string"}, + "ComputePlatform":{ + "type":"string", + "enum":[ + "Server", + "Lambda", + "ECS" + ] + }, + "ContinueDeploymentInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a blue/green deployment for which you want to start rerouting traffic to the replacement environment.

" + }, + "deploymentWaitType":{ + "shape":"DeploymentWaitType", + "documentation":"

The status of the deployment's waiting period. READY_WAIT indicates the deployment is ready to start shifting traffic. TERMINATION_WAIT indicates the traffic is shifted, but the original target is not terminated.

" + } + } + }, + "CreateApplicationInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application. This name must be unique with the applicable IAM user or AWS account.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for the deployment (Lambda, Server, or ECS).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The metadata that you apply to CodeDeploy applications to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

" + } + }, + "documentation":"

Represents the input of a CreateApplication operation.

" + }, + "CreateApplicationOutput":{ + "type":"structure", + "members":{ + "applicationId":{ + "shape":"ApplicationId", + "documentation":"

A unique application ID.

" + } + }, + "documentation":"

Represents the output of a CreateApplication operation.

" + }, + "CreateDeploymentConfigInput":{ + "type":"structure", + "required":["deploymentConfigName"], + "members":{ + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The name of the deployment configuration to create.

" + }, + "minimumHealthyHosts":{ + "shape":"MinimumHealthyHosts", + "documentation":"

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.

  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

" + }, + "trafficRoutingConfig":{ + "shape":"TrafficRoutingConfig", + "documentation":"

The configuration that specifies how the deployment traffic is routed.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for the deployment (Lambda, Server, or ECS).

" + } + }, + "documentation":"

Represents the input of a CreateDeploymentConfig operation.

" + }, + "CreateDeploymentConfigOutput":{ + "type":"structure", + "members":{ + "deploymentConfigId":{ + "shape":"DeploymentConfigId", + "documentation":"

A unique deployment configuration ID.

" + } + }, + "documentation":"

Represents the output of a CreateDeploymentConfig operation.

" + }, + "CreateDeploymentGroupInput":{ + "type":"structure", + "required":[ + "applicationName", + "deploymentGroupName", + "serviceRoleArn" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The name of a new deployment group for the specified application.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.

CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or deployment group.

For more information about the predefined deployment configurations in AWS CodeDeploy, see Working with Deployment Groups in AWS CodeDeploy in the AWS CodeDeploy User Guide.

" + }, + "ec2TagFilters":{ + "shape":"EC2TagFilterList", + "documentation":"

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags. Cannot be used in the same call as ec2TagSet.

" + }, + "onPremisesInstanceTagFilters":{ + "shape":"TagFilterList", + "documentation":"

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags. Cannot be used in the same call as OnPremisesTagSet.

" + }, + "autoScalingGroups":{ + "shape":"AutoScalingGroupNameList", + "documentation":"

A list of associated Amazon EC2 Auto Scaling groups.

" + }, + "serviceRoleArn":{ + "shape":"Role", + "documentation":"

A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.

" + }, + "triggerConfigurations":{ + "shape":"TriggerConfigList", + "documentation":"

Information about triggers to create when the deployment group is created. For examples, see Create a Trigger for an AWS CodeDeploy Event in the AWS CodeDeploy User Guide.

" + }, + "alarmConfiguration":{ + "shape":"AlarmConfiguration", + "documentation":"

Information to add about Amazon CloudWatch alarms when the deployment group is created.

" + }, + "autoRollbackConfiguration":{ + "shape":"AutoRollbackConfiguration", + "documentation":"

Configuration information for an automatic rollback that is added when a deployment group is created.

" + }, + "deploymentStyle":{ + "shape":"DeploymentStyle", + "documentation":"

Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.

" + }, + "blueGreenDeploymentConfiguration":{ + "shape":"BlueGreenDeploymentConfiguration", + "documentation":"

Information about blue/green deployment options for a deployment group.

" + }, + "loadBalancerInfo":{ + "shape":"LoadBalancerInfo", + "documentation":"

Information about the load balancer used in a deployment.

" + }, + "ec2TagSet":{ + "shape":"EC2TagSet", + "documentation":"

Information about groups of tags applied to EC2 instances. The deployment group includes only EC2 instances identified by all the tag groups. Cannot be used in the same call as ec2TagFilters.

" + }, + "ecsServices":{ + "shape":"ECSServiceList", + "documentation":"

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

" + }, + "onPremisesTagSet":{ + "shape":"OnPremisesTagSet", + "documentation":"

Information about groups of tags applied to on-premises instances. The deployment group includes only on-premises instances identified by all of the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The metadata that you apply to CodeDeploy deployment groups to help you organize and categorize them. Each tag consists of a key and an optional value, both of which you define.

" + } + }, + "documentation":"

Represents the input of a CreateDeploymentGroup operation.

" + }, + "CreateDeploymentGroupOutput":{ + "type":"structure", + "members":{ + "deploymentGroupId":{ + "shape":"DeploymentGroupId", + "documentation":"

A unique deployment group ID.

" + } + }, + "documentation":"

Represents the output of a CreateDeploymentGroup operation.

" + }, + "CreateDeploymentInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The name of the deployment group.

" + }, + "revision":{ + "shape":"RevisionLocation", + "documentation":"

The type and location of the revision to deploy.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The name of a deployment configuration associated with the IAM user or AWS account.

If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A comment about the deployment.

" + }, + "ignoreApplicationStopFailures":{ + "shape":"Boolean", + "documentation":"

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

" + }, + "targetInstances":{ + "shape":"TargetInstances", + "documentation":"

Information about the instances that belong to the replacement environment in a blue/green deployment.

" + }, + "autoRollbackConfiguration":{ + "shape":"AutoRollbackConfiguration", + "documentation":"

Configuration information for an automatic rollback that is added when a deployment is created.

" + }, + "updateOutdatedInstancesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

" + }, + "fileExistsBehavior":{ + "shape":"FileExistsBehavior", + "documentation":"

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

The fileExistsBehavior parameter takes any of the following values:

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

" + } + }, + "documentation":"

Represents the input of a CreateDeployment operation.

" + }, + "CreateDeploymentOutput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + } + }, + "documentation":"

Represents the output of a CreateDeployment operation.

" + }, + "DeleteApplicationInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + } + }, + "documentation":"

Represents the input of a DeleteApplication operation.

" + }, + "DeleteDeploymentConfigInput":{ + "type":"structure", + "required":["deploymentConfigName"], + "members":{ + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The name of a deployment configuration associated with the IAM user or AWS account.

" + } + }, + "documentation":"

Represents the input of a DeleteDeploymentConfig operation.

" + }, + "DeleteDeploymentGroupInput":{ + "type":"structure", + "required":[ + "applicationName", + "deploymentGroupName" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The name of a deployment group for the specified application.

" + } + }, + "documentation":"

Represents the input of a DeleteDeploymentGroup operation.

" + }, + "DeleteDeploymentGroupOutput":{ + "type":"structure", + "members":{ + "hooksNotCleanedUp":{ + "shape":"AutoScalingGroupList", + "documentation":"

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.

" + } + }, + "documentation":"

Represents the output of a DeleteDeploymentGroup operation.

" + }, + "DeleteGitHubAccountTokenInput":{ + "type":"structure", + "members":{ + "tokenName":{ + "shape":"GitHubAccountTokenName", + "documentation":"

The name of the GitHub account connection to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteGitHubAccount operation.

" + }, + "DeleteGitHubAccountTokenOutput":{ + "type":"structure", + "members":{ + "tokenName":{ + "shape":"GitHubAccountTokenName", + "documentation":"

The name of the GitHub account connection that was deleted.

" + } + }, + "documentation":"

Represents the output of a DeleteGitHubAccountToken operation.

" + }, + "DeploymentAlreadyCompletedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment is already complete.

", + "exception":true + }, + "DeploymentAlreadyStartedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A deployment to a target was attempted while another deployment was in progress.

", + "exception":true + }, + "DeploymentConfigAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A deployment configuration with the specified name with the IAM user or AWS account already exists .

", + "exception":true + }, + "DeploymentConfigDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment configuration does not exist with the IAM user or AWS account.

", + "exception":true + }, + "DeploymentConfigId":{"type":"string"}, + "DeploymentConfigInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment configuration is still in use.

", + "exception":true + }, + "DeploymentConfigInfo":{ + "type":"structure", + "members":{ + "deploymentConfigId":{ + "shape":"DeploymentConfigId", + "documentation":"

The deployment configuration ID.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The deployment configuration name.

" + }, + "minimumHealthyHosts":{ + "shape":"MinimumHealthyHosts", + "documentation":"

Information about the number or percentage of minimum healthy instance.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the deployment configuration was created.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for the deployment (Lambda, Server, or ECS).

" + }, + "trafficRoutingConfig":{ + "shape":"TrafficRoutingConfig", + "documentation":"

The configuration that specifies how the deployment traffic is routed. Only deployments with a Lambda compute platform can specify this.

" + } + }, + "documentation":"

Information about a deployment configuration.

" + }, + "DeploymentConfigLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment configurations limit was exceeded.

", + "exception":true + }, + "DeploymentConfigName":{ + "type":"string", + "max":100, + "min":1 + }, + "DeploymentConfigNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment configuration name was not specified.

", + "exception":true + }, + "DeploymentConfigsList":{ + "type":"list", + "member":{"shape":"DeploymentConfigName"} + }, + "DeploymentCreator":{ + "type":"string", + "enum":[ + "user", + "autoscaling", + "codeDeployRollback" + ] + }, + "DeploymentDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment with the IAM user or AWS account does not exist.

", + "exception":true + }, + "DeploymentGroupAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A deployment group with the specified name with the IAM user or AWS account already exists.

", + "exception":true + }, + "DeploymentGroupDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The named deployment group with the IAM user or AWS account does not exist.

", + "exception":true + }, + "DeploymentGroupId":{"type":"string"}, + "DeploymentGroupInfo":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "deploymentGroupId":{ + "shape":"DeploymentGroupId", + "documentation":"

The deployment group ID.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The deployment group name.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The deployment configuration name.

" + }, + "ec2TagFilters":{ + "shape":"EC2TagFilterList", + "documentation":"

The Amazon EC2 tags on which to filter. The deployment group includes EC2 instances with any of the specified tags.

" + }, + "onPremisesInstanceTagFilters":{ + "shape":"TagFilterList", + "documentation":"

The on-premises instance tags on which to filter. The deployment group includes on-premises instances with any of the specified tags.

" + }, + "autoScalingGroups":{ + "shape":"AutoScalingGroupList", + "documentation":"

A list of associated Auto Scaling groups.

" + }, + "serviceRoleArn":{ + "shape":"Role", + "documentation":"

A service role Amazon Resource Name (ARN) that grants CodeDeploy permission to make calls to AWS services on your behalf. For more information, see Create a Service Role for AWS CodeDeploy in the AWS CodeDeploy User Guide.

" + }, + "targetRevision":{ + "shape":"RevisionLocation", + "documentation":"

Information about the deployment group's target revision, including type and location.

" + }, + "triggerConfigurations":{ + "shape":"TriggerConfigList", + "documentation":"

Information about triggers associated with the deployment group.

" + }, + "alarmConfiguration":{ + "shape":"AlarmConfiguration", + "documentation":"

A list of alarms associated with the deployment group.

" + }, + "autoRollbackConfiguration":{ + "shape":"AutoRollbackConfiguration", + "documentation":"

Information about the automatic rollback configuration associated with the deployment group.

" + }, + "deploymentStyle":{ + "shape":"DeploymentStyle", + "documentation":"

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" + }, + "blueGreenDeploymentConfiguration":{ + "shape":"BlueGreenDeploymentConfiguration", + "documentation":"

Information about blue/green deployment options for a deployment group.

" + }, + "loadBalancerInfo":{ + "shape":"LoadBalancerInfo", + "documentation":"

Information about the load balancer to use in a deployment.

" + }, + "lastSuccessfulDeployment":{ + "shape":"LastDeploymentInfo", + "documentation":"

Information about the most recent successful deployment to the deployment group.

" + }, + "lastAttemptedDeployment":{ + "shape":"LastDeploymentInfo", + "documentation":"

Information about the most recent attempted deployment to the deployment group.

" + }, + "ec2TagSet":{ + "shape":"EC2TagSet", + "documentation":"

Information about groups of tags applied to an EC2 instance. The deployment group includes only EC2 instances identified by all of the tag groups. Cannot be used in the same call as ec2TagFilters.

" + }, + "onPremisesTagSet":{ + "shape":"OnPremisesTagSet", + "documentation":"

Information about groups of tags applied to an on-premises instance. The deployment group includes only on-premises instances identified by all the tag groups. Cannot be used in the same call as onPremisesInstanceTagFilters.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for the deployment (Lambda, Server, or ECS).

" + }, + "ecsServices":{ + "shape":"ECSServiceList", + "documentation":"

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

" + } + }, + "documentation":"

Information about a deployment group.

" + }, + "DeploymentGroupInfoList":{ + "type":"list", + "member":{"shape":"DeploymentGroupInfo"} + }, + "DeploymentGroupLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment groups limit was exceeded.

", + "exception":true + }, + "DeploymentGroupName":{ + "type":"string", + "max":100, + "min":1 + }, + "DeploymentGroupNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment group name was not specified.

", + "exception":true + }, + "DeploymentGroupsList":{ + "type":"list", + "member":{"shape":"DeploymentGroupName"} + }, + "DeploymentId":{"type":"string"}, + "DeploymentIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

At least one deployment ID must be specified.

", + "exception":true + }, + "DeploymentInfo":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The deployment group name.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The deployment configuration name.

" + }, + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "previousRevision":{ + "shape":"RevisionLocation", + "documentation":"

Information about the application revision that was deployed to the deployment group before the most recent successful deployment.

" + }, + "revision":{ + "shape":"RevisionLocation", + "documentation":"

Information about the location of stored application artifacts and the service from which to retrieve them.

" + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

The current state of the deployment as a whole.

" + }, + "errorInformation":{ + "shape":"ErrorInformation", + "documentation":"

Information about any error associated with this deployment.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the deployment was created.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the deployment was deployed to the deployment group.

In some cases, the reported value of the start time might be later than the complete time. This is due to differences in the clock settings of backend servers that participate in the deployment process.

" + }, + "completeTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the deployment was complete.

" + }, + "deploymentOverview":{ + "shape":"DeploymentOverview", + "documentation":"

A summary of the deployment status of the instances in the deployment.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A comment about the deployment.

" + }, + "creator":{ + "shape":"DeploymentCreator", + "documentation":"

The means by which the deployment was created:

  • user: A user created the deployment.

  • autoscaling: Amazon EC2 Auto Scaling created the deployment.

  • codeDeployRollback: A rollback process created the deployment.

" + }, + "ignoreApplicationStopFailures":{ + "shape":"Boolean", + "documentation":"

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

" + }, + "autoRollbackConfiguration":{ + "shape":"AutoRollbackConfiguration", + "documentation":"

Information about the automatic rollback configuration associated with the deployment.

" + }, + "updateOutdatedInstancesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether only instances that are not running the latest application revision are to be deployed to.

" + }, + "rollbackInfo":{ + "shape":"RollbackInfo", + "documentation":"

Information about a deployment rollback.

" + }, + "deploymentStyle":{ + "shape":"DeploymentStyle", + "documentation":"

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" + }, + "targetInstances":{ + "shape":"TargetInstances", + "documentation":"

Information about the instances that belong to the replacement environment in a blue/green deployment.

" + }, + "instanceTerminationWaitTimeStarted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the wait period set for the termination of instances in the original environment has started. Status is 'false' if the KEEP_ALIVE option is specified. Otherwise, 'true' as soon as the termination wait period starts.

" + }, + "blueGreenDeploymentConfiguration":{ + "shape":"BlueGreenDeploymentConfiguration", + "documentation":"

Information about blue/green deployment options for this deployment.

" + }, + "loadBalancerInfo":{ + "shape":"LoadBalancerInfo", + "documentation":"

Information about the load balancer used in the deployment.

" + }, + "additionalDeploymentStatusInfo":{ + "shape":"AdditionalDeploymentStatusInfo", + "documentation":"

Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.

" + }, + "fileExistsBehavior":{ + "shape":"FileExistsBehavior", + "documentation":"

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.

  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.

  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

" + }, + "deploymentStatusMessages":{ + "shape":"DeploymentStatusMessageList", + "documentation":"

Messages that contain information about the status of a deployment.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The destination platform type for the deployment (Lambda, Server, or ECS).

" + } + }, + "documentation":"

Information about a deployment.

" + }, + "DeploymentIsNotInReadyStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment does not have a status of Ready and can't continue yet.

", + "exception":true + }, + "DeploymentLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of allowed deployments was exceeded.

", + "exception":true + }, + "DeploymentNotStartedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified deployment has not started.

", + "exception":true + }, + "DeploymentOption":{ + "type":"string", + "enum":[ + "WITH_TRAFFIC_CONTROL", + "WITHOUT_TRAFFIC_CONTROL" + ] + }, + "DeploymentOverview":{ + "type":"structure", + "members":{ + "Pending":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in the deployment in a pending state.

" + }, + "InProgress":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in which the deployment is in progress.

" + }, + "Succeeded":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in the deployment to which revisions have been successfully deployed.

" + }, + "Failed":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in the deployment in a failed state.

" + }, + "Skipped":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in the deployment in a skipped state.

" + }, + "Ready":{ + "shape":"InstanceCount", + "documentation":"

The number of instances in a replacement environment ready to receive traffic in a blue/green deployment.

" + } + }, + "documentation":"

Information about the deployment status of the instances in the deployment.

" + }, + "DeploymentReadyAction":{ + "type":"string", + "enum":[ + "CONTINUE_DEPLOYMENT", + "STOP_DEPLOYMENT" + ] + }, + "DeploymentReadyOption":{ + "type":"structure", + "members":{ + "actionOnTimeout":{ + "shape":"DeploymentReadyAction", + "documentation":"

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

  • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

" + }, + "waitTimeInMinutes":{ + "shape":"Duration", + "documentation":"

The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the STOP_DEPLOYMENT option for actionOnTimeout

" + } + }, + "documentation":"

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

" + }, + "DeploymentStatus":{ + "type":"string", + "enum":[ + "Created", + "Queued", + "InProgress", + "Succeeded", + "Failed", + "Stopped", + "Ready" + ] + }, + "DeploymentStatusList":{ + "type":"list", + "member":{"shape":"DeploymentStatus"} + }, + "DeploymentStatusMessageList":{ + "type":"list", + "member":{"shape":"ErrorMessage"} + }, + "DeploymentStyle":{ + "type":"structure", + "members":{ + "deploymentType":{ + "shape":"DeploymentType", + "documentation":"

Indicates whether to run an in-place deployment or a blue/green deployment.

" + }, + "deploymentOption":{ + "shape":"DeploymentOption", + "documentation":"

Indicates whether to route deployment traffic behind a load balancer.

" + } + }, + "documentation":"

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" + }, + "DeploymentTarget":{ + "type":"structure", + "members":{ + "deploymentTargetType":{ + "shape":"DeploymentTargetType", + "documentation":"

The deployment type that is specific to the deployment's compute platform.

" + }, + "instanceTarget":{ + "shape":"InstanceTarget", + "documentation":"

Information about the target for a deployment that uses the EC2/On-premises compute platform.

" + }, + "lambdaTarget":{ + "shape":"LambdaTarget", + "documentation":"

Information about the target for a deployment that uses the AWS Lambda compute platform.

" + }, + "ecsTarget":{ + "shape":"ECSTarget", + "documentation":"

Information about the target for a deployment that uses the Amazon ECS compute platform.

" + } + }, + "documentation":"

Information about the deployment target.

" + }, + "DeploymentTargetDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The provided target ID does not belong to the attempted deployment.

", + "exception":true + }, + "DeploymentTargetIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A deployment target ID was not provided.

", + "exception":true + }, + "DeploymentTargetList":{ + "type":"list", + "member":{"shape":"DeploymentTarget"} + }, + "DeploymentTargetListSizeExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of targets that can be associated with an Amazon ECS or AWS Lambda deployment was exceeded. The target list of both types of deployments must have exactly one item. This exception does not apply to EC2/On-premises deployments.

", + "exception":true + }, + "DeploymentTargetType":{ + "type":"string", + "enum":[ + "InstanceTarget", + "LambdaTarget", + "ECSTarget" + ] + }, + "DeploymentType":{ + "type":"string", + "enum":[ + "IN_PLACE", + "BLUE_GREEN" + ] + }, + "DeploymentWaitType":{ + "type":"string", + "enum":[ + "READY_WAIT", + "TERMINATION_WAIT" + ] + }, + "DeploymentsInfoList":{ + "type":"list", + "member":{"shape":"DeploymentInfo"} + }, + "DeploymentsList":{ + "type":"list", + "member":{"shape":"DeploymentId"} + }, + "DeregisterOnPremisesInstanceInput":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"InstanceName", + "documentation":"

The name of the on-premises instance to deregister.

" + } + }, + "documentation":"

Represents the input of a DeregisterOnPremisesInstance operation.

" + }, + "Description":{"type":"string"}, + "DescriptionTooLongException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The description is too long.

", + "exception":true + }, + "Diagnostics":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"LifecycleErrorCode", + "documentation":"

The associated error code:

  • Success: The specified script ran.

  • ScriptMissing: The specified script was not found in the specified location.

  • ScriptNotExecutable: The specified script is not a recognized executable file type.

  • ScriptTimedOut: The specified script did not finish running in the specified time period.

  • ScriptFailed: The specified script failed to run as expected.

  • UnknownError: The specified script did not run for an unknown reason.

" + }, + "scriptName":{ + "shape":"ScriptName", + "documentation":"

The name of the script.

" + }, + "message":{ + "shape":"LifecycleMessage", + "documentation":"

The message associated with the error.

" + }, + "logTail":{ + "shape":"LogTail", + "documentation":"

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

" + } + }, + "documentation":"

Diagnostic information about executable scripts that are part of a deployment.

" + }, + "Duration":{"type":"integer"}, + "EC2TagFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The tag filter key.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The tag filter value.

" + }, + "Type":{ + "shape":"EC2TagFilterType", + "documentation":"

The tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

" + } + }, + "documentation":"

Information about an EC2 tag filter.

" + }, + "EC2TagFilterList":{ + "type":"list", + "member":{"shape":"EC2TagFilter"} + }, + "EC2TagFilterType":{ + "type":"string", + "enum":[ + "KEY_ONLY", + "VALUE_ONLY", + "KEY_AND_VALUE" + ] + }, + "EC2TagSet":{ + "type":"structure", + "members":{ + "ec2TagSetList":{ + "shape":"EC2TagSetList", + "documentation":"

A list that contains other lists of EC2 instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

" + } + }, + "documentation":"

Information about groups of EC2 instance tags.

" + }, + "EC2TagSetList":{ + "type":"list", + "member":{"shape":"EC2TagFilterList"} + }, + "ECSClusterName":{"type":"string"}, + "ECSService":{ + "type":"structure", + "members":{ + "serviceName":{ + "shape":"ECSServiceName", + "documentation":"

The name of the target Amazon ECS service.

" + }, + "clusterName":{ + "shape":"ECSClusterName", + "documentation":"

The name of the cluster that the Amazon ECS service is associated with.

" + } + }, + "documentation":"

Contains the service and cluster names used to identify an Amazon ECS deployment's target.

" + }, + "ECSServiceList":{ + "type":"list", + "member":{"shape":"ECSService"} + }, + "ECSServiceMappingLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon ECS service is associated with more than one deployment groups. An Amazon ECS service can be associated with only one deployment group.

", + "exception":true + }, + "ECSServiceName":{"type":"string"}, + "ECSTarget":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "targetId":{ + "shape":"TargetId", + "documentation":"

The unique ID of a deployment target that has a type of ecsTarget.

" + }, + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The ARN of the target.

" + }, + "lastUpdatedAt":{ + "shape":"Time", + "documentation":"

The date and time when the target Amazon ECS application was updated by a deployment.

" + }, + "lifecycleEvents":{ + "shape":"LifecycleEventList", + "documentation":"

The lifecycle events of the deployment to this target Amazon ECS application.

" + }, + "status":{ + "shape":"TargetStatus", + "documentation":"

The status an Amazon ECS deployment's target ECS application.

" + }, + "taskSetsInfo":{ + "shape":"ECSTaskSetList", + "documentation":"

The ECSTaskSet objects associated with the ECS target.

" + } + }, + "documentation":"

Information about the target of an Amazon ECS deployment.

" + }, + "ECSTaskSet":{ + "type":"structure", + "members":{ + "identifer":{ + "shape":"ECSTaskSetIdentifier", + "documentation":"

A unique ID of an ECSTaskSet.

" + }, + "desiredCount":{ + "shape":"ECSTaskSetCount", + "documentation":"

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

" + }, + "pendingCount":{ + "shape":"ECSTaskSetCount", + "documentation":"

The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

" + }, + "runningCount":{ + "shape":"ECSTaskSetCount", + "documentation":"

The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

" + }, + "status":{ + "shape":"ECSTaskSetStatus", + "documentation":"

The status of the task set. There are three valid task set statuses:

  • PRIMARY: Indicates the task set is serving production traffic.

  • ACTIVE: Indicates the task set is not serving production traffic.

  • DRAINING: Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

" + }, + "trafficWeight":{ + "shape":"TrafficWeight", + "documentation":"

The percentage of traffic served by this task set.

" + }, + "targetGroup":{ + "shape":"TargetGroupInfo", + "documentation":"

The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.

" + }, + "taskSetLabel":{ + "shape":"TargetLabel", + "documentation":"

A label that identifies whether the ECS task set is an original target (BLUE) or a replacement target (GREEN).

" + } + }, + "documentation":"

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An AWS CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.

" + }, + "ECSTaskSetCount":{"type":"long"}, + "ECSTaskSetIdentifier":{"type":"string"}, + "ECSTaskSetList":{ + "type":"list", + "member":{"shape":"ECSTaskSet"} + }, + "ECSTaskSetStatus":{"type":"string"}, + "ELBInfo":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ELBName", + "documentation":"

For blue/green deployments, the name of the load balancer that is used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

" + } + }, + "documentation":"

Information about a load balancer in Elastic Load Balancing to use in a deployment. Instances are registered directly with a load balancer, and traffic is routed to the load balancer.

" + }, + "ELBInfoList":{ + "type":"list", + "member":{"shape":"ELBInfo"} + }, + "ELBName":{"type":"string"}, + "ETag":{"type":"string"}, + "ErrorCode":{ + "type":"string", + "enum":[ + "AGENT_ISSUE", + "ALARM_ACTIVE", + "APPLICATION_MISSING", + "AUTOSCALING_VALIDATION_ERROR", + "AUTO_SCALING_CONFIGURATION", + "AUTO_SCALING_IAM_ROLE_PERMISSIONS", + "CODEDEPLOY_RESOURCE_CANNOT_BE_FOUND", + "CUSTOMER_APPLICATION_UNHEALTHY", + "DEPLOYMENT_GROUP_MISSING", + "ECS_UPDATE_ERROR", + "ELASTIC_LOAD_BALANCING_INVALID", + "ELB_INVALID_INSTANCE", + "HEALTH_CONSTRAINTS", + "HEALTH_CONSTRAINTS_INVALID", + "HOOK_EXECUTION_FAILURE", + "IAM_ROLE_MISSING", + "IAM_ROLE_PERMISSIONS", + "INTERNAL_ERROR", + "INVALID_ECS_SERVICE", + "INVALID_LAMBDA_CONFIGURATION", + "INVALID_LAMBDA_FUNCTION", + "INVALID_REVISION", + "MANUAL_STOP", + "MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION", + "MISSING_ELB_INFORMATION", + "MISSING_GITHUB_TOKEN", + "NO_EC2_SUBSCRIPTION", + "NO_INSTANCES", + "OVER_MAX_INSTANCES", + "RESOURCE_LIMIT_EXCEEDED", + "REVISION_MISSING", + "THROTTLED", + "TIMEOUT" + ] + }, + "ErrorInformation":{ + "type":"structure", + "members":{ + "code":{ + "shape":"ErrorCode", + "documentation":"

For more information, see Error Codes for AWS CodeDeploy in the AWS CodeDeploy User Guide.

The error code:

  • APPLICATION_MISSING: The application was missing. This error code is most likely raised if the application is deleted after the deployment is created, but before it is started.

  • DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code is most likely raised if the deployment group is deleted after the deployment is created, but before it is started.

  • HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.

  • HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.

  • IAM_ROLE_MISSING: The service role cannot be accessed.

  • IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.

  • INTERNAL_ERROR: There was an internal error.

  • NO_EC2_SUBSCRIPTION: The calling account is not subscribed to Amazon EC2.

  • NO_INSTANCES: No instances were specified, or no instances can be found.

  • OVER_MAX_INSTANCES: The maximum number of instances was exceeded.

  • THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.

  • TIMEOUT: The deployment has timed out.

  • REVISION_MISSING: The revision ID was missing. This error code is most likely raised if the revision is deleted after the deployment is created, but before it is started.

" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

An accompanying error message.

" + } + }, + "documentation":"

Information about a deployment error.

" + }, + "ErrorMessage":{"type":"string"}, + "FileExistsBehavior":{ + "type":"string", + "enum":[ + "DISALLOW", + "OVERWRITE", + "RETAIN" + ] + }, + "FilterValue":{"type":"string"}, + "FilterValueList":{ + "type":"list", + "member":{"shape":"FilterValue"} + }, + "GenericRevisionInfo":{ + "type":"structure", + "members":{ + "description":{ + "shape":"Description", + "documentation":"

A comment about the revision.

" + }, + "deploymentGroups":{ + "shape":"DeploymentGroupsList", + "documentation":"

The deployment groups for which this is the current target revision.

" + }, + "firstUsedTime":{ + "shape":"Timestamp", + "documentation":"

When the revision was first used by AWS CodeDeploy.

" + }, + "lastUsedTime":{ + "shape":"Timestamp", + "documentation":"

When the revision was last used by AWS CodeDeploy.

" + }, + "registerTime":{ + "shape":"Timestamp", + "documentation":"

When the revision was registered with AWS CodeDeploy.

" + } + }, + "documentation":"

Information about an application revision.

" + }, + "GetApplicationInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + } + }, + "documentation":"

Represents the input of a GetApplication operation.

" + }, + "GetApplicationOutput":{ + "type":"structure", + "members":{ + "application":{ + "shape":"ApplicationInfo", + "documentation":"

Information about the application.

" + } + }, + "documentation":"

Represents the output of a GetApplication operation.

" + }, + "GetApplicationRevisionInput":{ + "type":"structure", + "required":[ + "applicationName", + "revision" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that corresponds to the revision.

" + }, + "revision":{ + "shape":"RevisionLocation", + "documentation":"

Information about the application revision to get, including type and location.

" + } + }, + "documentation":"

Represents the input of a GetApplicationRevision operation.

" + }, + "GetApplicationRevisionOutput":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that corresponds to the revision.

" + }, + "revision":{ + "shape":"RevisionLocation", + "documentation":"

Additional information about the revision, including type and location.

" + }, + "revisionInfo":{ + "shape":"GenericRevisionInfo", + "documentation":"

General information about the revision.

" + } + }, + "documentation":"

Represents the output of a GetApplicationRevision operation.

" + }, + "GetDeploymentConfigInput":{ + "type":"structure", + "required":["deploymentConfigName"], + "members":{ + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The name of a deployment configuration associated with the IAM user or AWS account.

" + } + }, + "documentation":"

Represents the input of a GetDeploymentConfig operation.

" + }, + "GetDeploymentConfigOutput":{ + "type":"structure", + "members":{ + "deploymentConfigInfo":{ + "shape":"DeploymentConfigInfo", + "documentation":"

Information about the deployment configuration.

" + } + }, + "documentation":"

Represents the output of a GetDeploymentConfig operation.

" + }, + "GetDeploymentGroupInput":{ + "type":"structure", + "required":[ + "applicationName", + "deploymentGroupName" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The name of a deployment group for the specified application.

" + } + }, + "documentation":"

Represents the input of a GetDeploymentGroup operation.

" + }, + "GetDeploymentGroupOutput":{ + "type":"structure", + "members":{ + "deploymentGroupInfo":{ + "shape":"DeploymentGroupInfo", + "documentation":"

Information about the deployment group.

" + } + }, + "documentation":"

Represents the output of a GetDeploymentGroup operation.

" + }, + "GetDeploymentInput":{ + "type":"structure", + "required":["deploymentId"], + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment associated with the IAM user or AWS account.

" + } + }, + "documentation":"

Represents the input of a GetDeployment operation.

" + }, + "GetDeploymentInstanceInput":{ + "type":"structure", + "required":[ + "deploymentId", + "instanceId" + ], + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "instanceId":{ + "shape":"InstanceId", + "documentation":"

The unique ID of an instance in the deployment group.

" + } + }, + "documentation":"

Represents the input of a GetDeploymentInstance operation.

" + }, + "GetDeploymentInstanceOutput":{ + "type":"structure", + "members":{ + "instanceSummary":{ + "shape":"InstanceSummary", + "documentation":"

Information about the instance.

" + } + }, + "documentation":"

Represents the output of a GetDeploymentInstance operation.

" + }, + "GetDeploymentOutput":{ + "type":"structure", + "members":{ + "deploymentInfo":{ + "shape":"DeploymentInfo", + "documentation":"

Information about the deployment.

" + } + }, + "documentation":"

Represents the output of a GetDeployment operation.

" + }, + "GetDeploymentTargetInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "targetId":{ + "shape":"TargetId", + "documentation":"

The unique ID of a deployment target.

" + } + } + }, + "GetDeploymentTargetOutput":{ + "type":"structure", + "members":{ + "deploymentTarget":{ + "shape":"DeploymentTarget", + "documentation":"

A deployment target that contains information about a deployment such as its status, lifecyle events, and when it was last updated. It also contains metadata about the deployment target. The deployment target metadata depends on the deployment target's type (instanceTarget, lambdaTarget, or ecsTarget).

" + } + } + }, + "GetOnPremisesInstanceInput":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"InstanceName", + "documentation":"

The name of the on-premises instance about which to get information.

" + } + }, + "documentation":"

Represents the input of a GetOnPremisesInstance operation.

" + }, + "GetOnPremisesInstanceOutput":{ + "type":"structure", + "members":{ + "instanceInfo":{ + "shape":"InstanceInfo", + "documentation":"

Information about the on-premises instance.

" + } + }, + "documentation":"

Represents the output of a GetOnPremisesInstance operation.

" + }, + "GitHubAccountTokenDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

No GitHub account connection exists with the named specified in the call.

", + "exception":true + }, + "GitHubAccountTokenName":{"type":"string"}, + "GitHubAccountTokenNameList":{ + "type":"list", + "member":{"shape":"GitHubAccountTokenName"} + }, + "GitHubAccountTokenNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The call is missing a required GitHub account connection name.

", + "exception":true + }, + "GitHubLocation":{ + "type":"structure", + "members":{ + "repository":{ + "shape":"Repository", + "documentation":"

The GitHub account and repository pair that stores a reference to the commit that represents the bundled artifacts for the application revision.

Specified as account/repository.

" + }, + "commitId":{ + "shape":"CommitId", + "documentation":"

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

" + } + }, + "documentation":"

Information about the location of application artifacts stored in GitHub.

" + }, + "GreenFleetProvisioningAction":{ + "type":"string", + "enum":[ + "DISCOVER_EXISTING", + "COPY_AUTO_SCALING_GROUP" + ] + }, + "GreenFleetProvisioningOption":{ + "type":"structure", + "members":{ + "action":{ + "shape":"GreenFleetProvisioningAction", + "documentation":"

The method used to add instances to a replacement environment.

  • DISCOVER_EXISTING: Use instances that already exist or will be created manually.

  • COPY_AUTO_SCALING_GROUP: Use settings from a specified Auto Scaling group to define and create instances in a new Auto Scaling group.

" + } + }, + "documentation":"

Information about the instances that belong to the replacement environment in a blue/green deployment.

" + }, + "IamArnRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

No IAM ARN was included in the request. You must use an IAM session ARN or IAM user ARN in the request.

", + "exception":true + }, + "IamSessionArn":{"type":"string"}, + "IamSessionArnAlreadyRegisteredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request included an IAM session ARN that has already been used to register a different instance.

", + "exception":true + }, + "IamUserArn":{"type":"string"}, + "IamUserArnAlreadyRegisteredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified IAM user ARN is already registered with an on-premises instance.

", + "exception":true + }, + "IamUserArnRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An IAM user ARN was not specified.

", + "exception":true + }, + "InstanceAction":{ + "type":"string", + "enum":[ + "TERMINATE", + "KEEP_ALIVE" + ] + }, + "InstanceArn":{"type":"string"}, + "InstanceCount":{"type":"long"}, + "InstanceDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified instance does not exist in the deployment group.

", + "deprecated":true, + "deprecatedMessage":"This exception is deprecated, use DeploymentTargetDoesNotExistException instead.", + "exception":true + }, + "InstanceId":{"type":"string"}, + "InstanceIdRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The instance ID was not specified.

", + "deprecated":true, + "deprecatedMessage":"This exception is deprecated, use DeploymentTargetIdRequiredException instead.", + "exception":true + }, + "InstanceInfo":{ + "type":"structure", + "members":{ + "instanceName":{ + "shape":"InstanceName", + "documentation":"

The name of the on-premises instance.

" + }, + "iamSessionArn":{ + "shape":"IamSessionArn", + "documentation":"

The ARN of the IAM session associated with the on-premises instance.

" + }, + "iamUserArn":{ + "shape":"IamUserArn", + "documentation":"

The IAM user ARN associated with the on-premises instance.

" + }, + "instanceArn":{ + "shape":"InstanceArn", + "documentation":"

The ARN of the on-premises instance.

" + }, + "registerTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the on-premises instance was registered.

" + }, + "deregisterTime":{ + "shape":"Timestamp", + "documentation":"

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags currently associated with the on-premises instance.

" + } + }, + "documentation":"

Information about an on-premises instance.

" + }, + "InstanceInfoList":{ + "type":"list", + "member":{"shape":"InstanceInfo"} + }, + "InstanceLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum number of allowed on-premises instances in a single call was exceeded.

", + "exception":true + }, + "InstanceName":{"type":"string"}, + "InstanceNameAlreadyRegisteredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified on-premises instance name is already registered.

", + "exception":true + }, + "InstanceNameList":{ + "type":"list", + "member":{"shape":"InstanceName"} + }, + "InstanceNameRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An on-premises instance name was not specified.

", + "exception":true + }, + "InstanceNotRegisteredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified on-premises instance is not registered.

", + "exception":true + }, + "InstanceStatus":{ + "type":"string", + "deprecated":true, + "deprecatedMessage":"InstanceStatus is deprecated, use TargetStatus instead.", + "enum":[ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "Skipped", + "Unknown", + "Ready" + ] + }, + "InstanceStatusList":{ + "type":"list", + "member":{"shape":"InstanceStatus"} + }, + "InstanceSummary":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "instanceId":{ + "shape":"InstanceId", + "documentation":"

The instance ID.

" + }, + "status":{ + "shape":"InstanceStatus", + "documentation":"

The deployment status for this instance:

  • Pending: The deployment is pending for this instance.

  • In Progress: The deployment is in progress for this instance.

  • Succeeded: The deployment has succeeded for this instance.

  • Failed: The deployment has failed for this instance.

  • Skipped: The deployment has been skipped for this instance.

  • Unknown: The deployment status is unknown for this instance.

" + }, + "lastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicaties when the instance information was last updated.

" + }, + "lifecycleEvents":{ + "shape":"LifecycleEventList", + "documentation":"

A list of lifecycle events for this instance.

" + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"

Information about which environment an instance belongs to in a blue/green deployment.

  • BLUE: The instance is part of the original environment.

  • GREEN: The instance is part of the replacement environment.

" + } + }, + "documentation":"

Information about an instance in a deployment.

", + "deprecated":true, + "deprecatedMessage":"InstanceSummary is deprecated, use DeploymentTarget instead." + }, + "InstanceSummaryList":{ + "type":"list", + "member":{"shape":"InstanceSummary"} + }, + "InstanceTarget":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "targetId":{ + "shape":"TargetId", + "documentation":"

The unique ID of a deployment target that has a type of instanceTarget.

" + }, + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The ARN of the target.

" + }, + "status":{ + "shape":"TargetStatus", + "documentation":"

The status an EC2/On-premises deployment's target instance.

" + }, + "lastUpdatedAt":{ + "shape":"Time", + "documentation":"

The date and time when the target instance was updated by a deployment.

" + }, + "lifecycleEvents":{ + "shape":"LifecycleEventList", + "documentation":"

The lifecycle events of the deployment to this target instance.

" + }, + "instanceLabel":{ + "shape":"TargetLabel", + "documentation":"

A label that identifies whether the instance is an original target (BLUE) or a replacement target (GREEN).

" + } + }, + "documentation":"

A target Amazon EC2 or on-premises instance during a deployment that uses the EC2/On-premises compute platform.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "Blue", + "Green" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "InstancesList":{ + "type":"list", + "member":{"shape":"InstanceId"} + }, + "InvalidAlarmConfigException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The format of the alarm configuration is invalid. Possible causes include:

  • The alarm list is null.

  • The alarm object is null.

  • The alarm name is empty or null or exceeds the limit of 255 characters.

  • Two alarms with the same name have been specified.

  • The alarm configuration is enabled, but the alarm list is empty.

", + "exception":true + }, + "InvalidApplicationNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The application name was specified in an invalid format.

", + "exception":true + }, + "InvalidArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified ARN is not in a valid format.

", + "exception":true + }, + "InvalidAutoRollbackConfigException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The automatic rollback configuration was specified in an invalid format. For example, automatic rollback is enabled, but an invalid triggering event type or no event types were listed.

", + "exception":true + }, + "InvalidAutoScalingGroupException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Auto Scaling group was specified in an invalid format or does not exist.

", + "exception":true + }, + "InvalidBlueGreenDeploymentConfigurationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The configuration for the blue/green deployment group was provided in an invalid format. For information about deployment configuration format, see CreateDeploymentConfig.

", + "exception":true + }, + "InvalidBucketNameFilterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The bucket name either doesn't exist or was specified in an invalid format.

", + "exception":true + }, + "InvalidComputePlatformException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The computePlatform is invalid. The computePlatform should be Lambda or Server.

", + "exception":true + }, + "InvalidDeployedStateFilterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployed state filter was specified in an invalid format.

", + "exception":true + }, + "InvalidDeploymentConfigIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The ID of the deployment configuration is invalid.

", + "exception":true + }, + "InvalidDeploymentConfigNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment configuration name was specified in an invalid format.

", + "exception":true + }, + "InvalidDeploymentGroupNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The deployment group name was specified in an invalid format.

", + "exception":true + }, + "InvalidDeploymentIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

At least one of the deployment IDs was specified in an invalid format.

", + "exception":true + }, + "InvalidDeploymentInstanceTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.

", + "exception":true + }, + "InvalidDeploymentStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified deployment status doesn't exist or cannot be determined.

", + "exception":true + }, + "InvalidDeploymentStyleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN.\" Valid deployment options include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL.\"

", + "exception":true + }, + "InvalidDeploymentTargetIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target ID provided was not valid.

", + "exception":true + }, + "InvalidDeploymentWaitTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The wait type is invalid.

", + "exception":true + }, + "InvalidEC2TagCombinationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A call was submitted that specified both Ec2TagFilters and Ec2TagSet, but only one of these data types can be used in a single call.

", + "exception":true + }, + "InvalidEC2TagException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tag was specified in an invalid format.

", + "exception":true + }, + "InvalidECSServiceException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon ECS service identifier is not valid.

", + "exception":true + }, + "InvalidFileExistsBehaviorException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location, but weren't part of the previous successful deployment. Valid values include \"DISALLOW,\" \"OVERWRITE,\" and \"RETAIN.\"

", + "exception":true + }, + "InvalidGitHubAccountTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The GitHub token is not valid.

", + "exception":true + }, + "InvalidGitHubAccountTokenNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The format of the specified GitHub account connection name is invalid.

", + "exception":true + }, + "InvalidIamSessionArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The IAM session ARN was specified in an invalid format.

", + "exception":true + }, + "InvalidIamUserArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The IAM user ARN was specified in an invalid format.

", + "exception":true + }, + "InvalidIgnoreApplicationStopFailuresValueException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The IgnoreApplicationStopFailures value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

", + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input was specified in an invalid format.

", + "exception":true + }, + "InvalidInstanceIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

", + "exception":true + }, + "InvalidInstanceNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The on-premises instance name was specified in an invalid format.

", + "exception":true + }, + "InvalidInstanceStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified instance status does not exist.

", + "exception":true + }, + "InvalidInstanceTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid instance type was specified for instances in a blue/green deployment. Valid values include \"Blue\" for an original environment and \"Green\" for a replacement environment.

", + "exception":true + }, + "InvalidKeyPrefixFilterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified key prefix filter was specified in an invalid format.

", + "exception":true + }, + "InvalidLifecycleEventHookExecutionIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A lifecycle event hook is invalid. Review the hooks section in your AppSpec file to ensure the lifecycle events and hooks functions are valid.

", + "exception":true + }, + "InvalidLifecycleEventHookExecutionStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return Succeeded or Failed.

", + "exception":true + }, + "InvalidLoadBalancerInfoException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid load balancer name, or no load balancer name, was specified.

", + "exception":true + }, + "InvalidMinimumHealthyHostValueException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The minimum healthy instance value was specified in an invalid format.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The next token was specified in an invalid format.

", + "exception":true + }, + "InvalidOnPremisesTagCombinationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A call was submitted that specified both OnPremisesTagFilters and OnPremisesTagSet, but only one of these data types can be used in a single call.

", + "exception":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid operation was detected.

", + "exception":true + }, + "InvalidRegistrationStatusException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The registration status was specified in an invalid format.

", + "exception":true + }, + "InvalidRevisionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The revision was specified in an invalid format.

", + "exception":true + }, + "InvalidRoleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.

", + "exception":true + }, + "InvalidSortByException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The column name to sort by is either not present or was specified in an invalid format.

", + "exception":true + }, + "InvalidSortOrderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The sort order was specified in an invalid format.

", + "exception":true + }, + "InvalidTagException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tag was specified in an invalid format.

", + "exception":true + }, + "InvalidTagFilterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tag filter was specified in an invalid format.

", + "exception":true + }, + "InvalidTagsToAddException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified tags are not valid.

", + "exception":true + }, + "InvalidTargetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A target is not valid.

", + "exception":true + }, + "InvalidTargetFilterNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target filter name is invalid.

", + "exception":true + }, + "InvalidTargetGroupPairException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A target group pair associated with this deployment is not valid.

", + "exception":true + }, + "InvalidTargetInstancesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The target instance configuration is invalid. Possible causes include:

  • Configuration data for target instances was entered for an in-place deployment.

  • The limit of 10 tags for a tag type was exceeded.

  • The combined length of the tag names exceeded the limit.

  • A specified tag is not currently applied to any instances.

", + "exception":true + }, + "InvalidTimeRangeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified time range was specified in an invalid format.

", + "exception":true + }, + "InvalidTrafficRoutingConfigurationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The configuration that specifies how traffic is routed during a deployment is invalid.

", + "exception":true + }, + "InvalidTriggerConfigException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The trigger was specified in an invalid format.

", + "exception":true + }, + "InvalidUpdateOutdatedInstancesOnlyValueException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The UpdateOutdatedInstancesOnly value is invalid. For AWS Lambda deployments, false is expected. For EC2/On-premises deployments, true or false is expected.

", + "exception":true + }, + "Key":{"type":"string"}, + "LambdaFunctionAlias":{"type":"string"}, + "LambdaFunctionInfo":{ + "type":"structure", + "members":{ + "functionName":{ + "shape":"LambdaFunctionName", + "documentation":"

The name of a Lambda function.

" + }, + "functionAlias":{ + "shape":"LambdaFunctionAlias", + "documentation":"

The alias of a Lambda function. For more information, see Introduction to AWS Lambda Aliases.

" + }, + "currentVersion":{ + "shape":"Version", + "documentation":"

The version of a Lambda function that production traffic points to.

" + }, + "targetVersion":{ + "shape":"Version", + "documentation":"

The version of a Lambda function that production traffic points to after the Lambda function is deployed.

" + }, + "targetVersionWeight":{ + "shape":"TrafficWeight", + "documentation":"

The percentage of production traffic that the target version of a Lambda function receives.

" + } + }, + "documentation":"

Information about a Lambda function specified in a deployment.

" + }, + "LambdaFunctionName":{"type":"string"}, + "LambdaTarget":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "targetId":{ + "shape":"TargetId", + "documentation":"

The unique ID of a deployment target that has a type of lambdaTarget.

" + }, + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The ARN of the target.

" + }, + "status":{ + "shape":"TargetStatus", + "documentation":"

The status an AWS Lambda deployment's target Lambda function.

" + }, + "lastUpdatedAt":{ + "shape":"Time", + "documentation":"

The date and time when the target Lambda function was updated by a deployment.

" + }, + "lifecycleEvents":{ + "shape":"LifecycleEventList", + "documentation":"

The lifecycle events of the deployment to this target Lambda function.

" + }, + "lambdaFunctionInfo":{ + "shape":"LambdaFunctionInfo", + "documentation":"

A LambdaFunctionInfo object that describes a target Lambda function.

" + } + }, + "documentation":"

Information about the target AWS Lambda function during an AWS Lambda deployment.

" + }, + "LastDeploymentInfo":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

The status of the most recent deployment.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the most recent deployment to the deployment group was complete.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the most recent deployment to the deployment group started.

" + } + }, + "documentation":"

Information about the most recent attempted or successful deployment to a deployment group.

" + }, + "LifecycleErrorCode":{ + "type":"string", + "enum":[ + "Success", + "ScriptMissing", + "ScriptNotExecutable", + "ScriptTimedOut", + "ScriptFailed", + "UnknownError" + ] + }, + "LifecycleEvent":{ + "type":"structure", + "members":{ + "lifecycleEventName":{ + "shape":"LifecycleEventName", + "documentation":"

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

" + }, + "diagnostics":{ + "shape":"Diagnostics", + "documentation":"

Diagnostic information about the deployment lifecycle event.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the deployment lifecycle event started.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

A timestamp that indicates when the deployment lifecycle event ended.

" + }, + "status":{ + "shape":"LifecycleEventStatus", + "documentation":"

The deployment lifecycle event status:

  • Pending: The deployment lifecycle event is pending.

  • InProgress: The deployment lifecycle event is in progress.

  • Succeeded: The deployment lifecycle event ran successfully.

  • Failed: The deployment lifecycle event has failed.

  • Skipped: The deployment lifecycle event has been skipped.

  • Unknown: The deployment lifecycle event is unknown.

" + } + }, + "documentation":"

Information about a deployment lifecycle event.

" + }, + "LifecycleEventAlreadyCompletedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An attempt to return the status of an already completed lifecycle event occurred.

", + "exception":true + }, + "LifecycleEventHookExecutionId":{"type":"string"}, + "LifecycleEventList":{ + "type":"list", + "member":{"shape":"LifecycleEvent"} + }, + "LifecycleEventName":{"type":"string"}, + "LifecycleEventStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "Skipped", + "Unknown" + ] + }, + "LifecycleHookLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The limit for lifecycle hooks was exceeded.

", + "exception":true + }, + "LifecycleMessage":{"type":"string"}, + "ListApplicationRevisionsInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "sortBy":{ + "shape":"ApplicationRevisionSortBy", + "documentation":"

The column name to use to sort the list results:

  • registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.

  • firstUsedTime: Sort by the time the revisions were first used in a deployment.

  • lastUsedTime: Sort by the time the revisions were last used in a deployment.

If not specified or set to null, the results are returned in an arbitrary order.

" + }, + "sortOrder":{ + "shape":"SortOrder", + "documentation":"

The order in which to sort the list results:

  • ascending: ascending order.

  • descending: descending order.

If not specified, the results are sorted in ascending order.

If set to null, the results are sorted in an arbitrary order.

" + }, + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

An Amazon S3 bucket name to limit the search for revisions.

If set to null, all of the user's buckets are searched.

" + }, + "s3KeyPrefix":{ + "shape":"S3Key", + "documentation":"

A key prefix for the set of Amazon S3 objects to limit the search for revisions.

" + }, + "deployed":{ + "shape":"ListStateFilterAction", + "documentation":"

Whether to list revisions based on whether the revision is the target revision of an deployment group:

  • include: List revisions that are target revisions of a deployment group.

  • exclude: Do not list revisions that are target revisions of a deployment group.

  • ignore: List all revisions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous ListApplicationRevisions call. It can be used to return the next set of applications in the list.

" + } + }, + "documentation":"

Represents the input of a ListApplicationRevisions operation.

" + }, + "ListApplicationRevisionsOutput":{ + "type":"structure", + "members":{ + "revisions":{ + "shape":"RevisionLocationList", + "documentation":"

A list of locations that contain the matching revisions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.

" + } + }, + "documentation":"

Represents the output of a ListApplicationRevisions operation.

" + }, + "ListApplicationsInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.

" + } + }, + "documentation":"

Represents the input of a ListApplications operation.

" + }, + "ListApplicationsOutput":{ + "type":"structure", + "members":{ + "applications":{ + "shape":"ApplicationsList", + "documentation":"

A list of application names.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications in the list.

" + } + }, + "documentation":"

Represents the output of a ListApplications operation.

" + }, + "ListDeploymentConfigsInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous ListDeploymentConfigs call. It can be used to return the next set of deployment configurations in the list.

" + } + }, + "documentation":"

Represents the input of a ListDeploymentConfigs operation.

" + }, + "ListDeploymentConfigsOutput":{ + "type":"structure", + "members":{ + "deploymentConfigsList":{ + "shape":"DeploymentConfigsList", + "documentation":"

A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.

" + } + }, + "documentation":"

Represents the output of a ListDeploymentConfigs operation.

" + }, + "ListDeploymentGroupsInput":{ + "type":"structure", + "required":["applicationName"], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.

" + } + }, + "documentation":"

Represents the input of a ListDeploymentGroups operation.

" + }, + "ListDeploymentGroupsOutput":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "deploymentGroups":{ + "shape":"DeploymentGroupsList", + "documentation":"

A list of deployment group names.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.

" + } + }, + "documentation":"

Represents the output of a ListDeploymentGroups operation.

" + }, + "ListDeploymentInstancesInput":{ + "type":"structure", + "required":["deploymentId"], + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.

" + }, + "instanceStatusFilter":{ + "shape":"InstanceStatusList", + "documentation":"

A subset of instances to list by status:

  • Pending: Include those instances with pending deployments.

  • InProgress: Include those instances where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instances with failed deployments.

  • Skipped: Include those instances with skipped deployments.

  • Unknown: Include those instances with deployments in an unknown state.

" + }, + "instanceTypeFilter":{ + "shape":"InstanceTypeList", + "documentation":"

The set of instances in a blue/green deployment, either those in the original environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you want to view instance information.

" + } + }, + "documentation":"

Represents the input of a ListDeploymentInstances operation.

" + }, + "ListDeploymentInstancesOutput":{ + "type":"structure", + "members":{ + "instancesList":{ + "shape":"InstancesList", + "documentation":"

A list of instance IDs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.

" + } + }, + "documentation":"

Represents the output of a ListDeploymentInstances operation.

" + }, + "ListDeploymentTargetsInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token identifier returned from the previous ListDeploymentTargets call. It can be used to return the next set of deployment targets in the list.

" + }, + "targetFilters":{ + "shape":"TargetFilters", + "documentation":"

A key used to filter the returned targets. The two valid values are:

  • TargetStatus - A TargetStatus filter string can be Failed, InProgress, Pending, Ready, Skipped, Succeeded, or Unknown.

  • ServerInstanceLabel - A ServerInstanceLabel filter string can be Blue or Green.

" + } + } + }, + "ListDeploymentTargetsOutput":{ + "type":"structure", + "members":{ + "targetIds":{ + "shape":"TargetIdList", + "documentation":"

The unique IDs of deployment targets.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, a token identifier is also returned. It can be used in a subsequent ListDeploymentTargets call to return the next set of deployment targets in the list.

" + } + } + }, + "ListDeploymentsInput":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

" + }, + "deploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The name of a deployment group for the specified application.

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

" + }, + "includeOnlyStatuses":{ + "shape":"DeploymentStatusList", + "documentation":"

A subset of deployments to list by status:

  • Created: Include created deployments in the resulting list.

  • Queued: Include queued deployments in the resulting list.

  • In Progress: Include in-progress deployments in the resulting list.

  • Succeeded: Include successful deployments in the resulting list.

  • Failed: Include failed deployments in the resulting list.

  • Stopped: Include stopped deployments in the resulting list.

" + }, + "createTimeRange":{ + "shape":"TimeRange", + "documentation":"

A time range (start and end) for returning a subset of the list of deployments.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.

" + } + }, + "documentation":"

Represents the input of a ListDeployments operation.

" + }, + "ListDeploymentsOutput":{ + "type":"structure", + "members":{ + "deployments":{ + "shape":"DeploymentsList", + "documentation":"

A list of deployment IDs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.

" + } + }, + "documentation":"

Represents the output of a ListDeployments operation.

" + }, + "ListGitHubAccountTokenNamesInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list.

" + } + }, + "documentation":"

Represents the input of a ListGitHubAccountTokenNames operation.

" + }, + "ListGitHubAccountTokenNamesOutput":{ + "type":"structure", + "members":{ + "tokenNameList":{ + "shape":"GitHubAccountTokenNameList", + "documentation":"

A list of names of connections to GitHub accounts.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list.

" + } + }, + "documentation":"

Represents the output of a ListGitHubAccountTokenNames operation.

" + }, + "ListOnPremisesInstancesInput":{ + "type":"structure", + "members":{ + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

The registration status of the on-premises instances:

  • Deregistered: Include deregistered on-premises instances in the resulting list.

  • Registered: Include registered on-premises instances in the resulting list.

" + }, + "tagFilters":{ + "shape":"TagFilterList", + "documentation":"

The on-premises instance tags that are used to restrict the on-premises instance names returned.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.

" + } + }, + "documentation":"

Represents the input of a ListOnPremisesInstances operation.

" + }, + "ListOnPremisesInstancesOutput":{ + "type":"structure", + "members":{ + "instanceNames":{ + "shape":"InstanceNameList", + "documentation":"

The list of matching on-premises instance names.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.

" + } + }, + "documentation":"

Represents the output of the list on-premises instances operation.

" + }, + "ListStateFilterAction":{ + "type":"string", + "enum":[ + "include", + "exclude", + "ignore" + ] + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of a CodeDeploy resource. ListTagsForResource returns all the tags associated with the resource that is identified by the ResourceArn.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An identifier returned from the previous ListTagsForResource call. It can be used to return the next set of applications in the list.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags returned by ListTagsForResource. The tags are associated with the resource identified by the input ResourceArn parameter.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.

" + } + } + }, + "ListenerArn":{"type":"string"}, + "ListenerArnList":{ + "type":"list", + "member":{"shape":"ListenerArn"} + }, + "LoadBalancerInfo":{ + "type":"structure", + "members":{ + "elbInfoList":{ + "shape":"ELBInfoList", + "documentation":"

An array that contains information about the load balancer to use for load balancing in a deployment. In Elastic Load Balancing, load balancers are used with Classic Load Balancers.

Adding more than one load balancer to the array is not supported.

" + }, + "targetGroupInfoList":{ + "shape":"TargetGroupInfoList", + "documentation":"

An array that contains information about the target group to use for load balancing in a deployment. In Elastic Load Balancing, target groups are used with Application Load Balancers.

Adding more than one target group to the array is not supported.

" + }, + "targetGroupPairInfoList":{ + "shape":"TargetGroupPairInfoList", + "documentation":"

The target group pair information. This is an array of TargeGroupPairInfo objects with a maximum size of one.

" + } + }, + "documentation":"

Information about the Elastic Load Balancing load balancer or target group used in a deployment.

" + }, + "LogTail":{"type":"string"}, + "Message":{"type":"string"}, + "MinimumHealthyHosts":{ + "type":"structure", + "members":{ + "value":{ + "shape":"MinimumHealthyHostsValue", + "documentation":"

The minimum healthy instance value.

" + }, + "type":{ + "shape":"MinimumHealthyHostsType", + "documentation":"

The minimum healthy instance type:

  • HOST_COUNT: The minimum number of healthy instance as an absolute value.

  • FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.

In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails.

In a call to the GetDeploymentConfig, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.

For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide.

" + } + }, + "documentation":"

Information about minimum healthy instance.

" + }, + "MinimumHealthyHostsType":{ + "type":"string", + "enum":[ + "HOST_COUNT", + "FLEET_PERCENT" + ] + }, + "MinimumHealthyHostsValue":{"type":"integer"}, + "MultipleIamArnsProvidedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Both an IAM user ARN and an IAM session ARN were included in the request. Use only one ARN type.

", + "exception":true + }, + "NextToken":{"type":"string"}, + "NullableBoolean":{"type":"boolean"}, + "OnPremisesTagSet":{ + "type":"structure", + "members":{ + "onPremisesTagSetList":{ + "shape":"OnPremisesTagSetList", + "documentation":"

A list that contains other lists of on-premises instance tag groups. For an instance to be included in the deployment group, it must be identified by all of the tag groups in the list.

" + } + }, + "documentation":"

Information about groups of on-premises instance tags.

" + }, + "OnPremisesTagSetList":{ + "type":"list", + "member":{"shape":"TagFilterList"} + }, + "OperationNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The API used does not support the deployment.

", + "exception":true + }, + "Percentage":{"type":"integer"}, + "PutLifecycleEventHookExecutionStatusInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.

" + }, + "lifecycleEventHookExecutionId":{ + "shape":"LifecycleEventHookExecutionId", + "documentation":"

The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the hooks section of the AppSpec file.

" + }, + "status":{ + "shape":"LifecycleEventStatus", + "documentation":"

The result of a Lambda function that validates a deployment lifecycle event (Succeeded or Failed).

" + } + } + }, + "PutLifecycleEventHookExecutionStatusOutput":{ + "type":"structure", + "members":{ + "lifecycleEventHookExecutionId":{ + "shape":"LifecycleEventHookExecutionId", + "documentation":"

The execution ID of the lifecycle event hook. A hook is specified in the hooks section of the deployment's AppSpec file.

" + } + } + }, + "RawString":{ + "type":"structure", + "members":{ + "content":{ + "shape":"RawStringContent", + "documentation":"

The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.

" + }, + "sha256":{ + "shape":"RawStringSha256", + "documentation":"

The SHA256 hash value of the revision content.

" + } + }, + "documentation":"

A revision for an AWS Lambda deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda deployments, the revision is the same as the AppSpec file.

", + "deprecated":true, + "deprecatedMessage":"RawString and String revision type are deprecated, use AppSpecContent type instead." + }, + "RawStringContent":{"type":"string"}, + "RawStringSha256":{"type":"string"}, + "RegisterApplicationRevisionInput":{ + "type":"structure", + "required":[ + "applicationName", + "revision" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A comment about the revision.

" + }, + "revision":{ + "shape":"RevisionLocation", + "documentation":"

Information about the application revision to register, including type and location.

" + } + }, + "documentation":"

Represents the input of a RegisterApplicationRevision operation.

" + }, + "RegisterOnPremisesInstanceInput":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"InstanceName", + "documentation":"

The name of the on-premises instance to register.

" + }, + "iamSessionArn":{ + "shape":"IamSessionArn", + "documentation":"

The ARN of the IAM session to associate with the on-premises instance.

" + }, + "iamUserArn":{ + "shape":"IamUserArn", + "documentation":"

The ARN of the IAM user to associate with the on-premises instance.

" + } + }, + "documentation":"

Represents the input of the register on-premises instance operation.

" + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "Registered", + "Deregistered" + ] + }, + "RemoveTagsFromOnPremisesInstancesInput":{ + "type":"structure", + "required":[ + "tags", + "instanceNames" + ], + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The tag key-value pairs to remove from the on-premises instances.

" + }, + "instanceNames":{ + "shape":"InstanceNameList", + "documentation":"

The names of the on-premises instances from which to remove tags.

" + } + }, + "documentation":"

Represents the input of a RemoveTagsFromOnPremisesInstances operation.

" + }, + "Repository":{"type":"string"}, + "ResourceArnRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The ARN of a resource is required, but was not found.

", + "exception":true + }, + "ResourceValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource could not be validated.

", + "exception":true + }, + "RevisionDoesNotExistException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The named revision does not exist with the IAM user or AWS account.

", + "exception":true + }, + "RevisionInfo":{ + "type":"structure", + "members":{ + "revisionLocation":{ + "shape":"RevisionLocation", + "documentation":"

Information about the location and type of an application revision.

" + }, + "genericRevisionInfo":{ + "shape":"GenericRevisionInfo", + "documentation":"

Information about an application revision, including usage details and associated deployment groups.

" + } + }, + "documentation":"

Information about an application revision.

" + }, + "RevisionInfoList":{ + "type":"list", + "member":{"shape":"RevisionInfo"} + }, + "RevisionLocation":{ + "type":"structure", + "members":{ + "revisionType":{ + "shape":"RevisionLocationType", + "documentation":"

The type of application revision:

  • S3: An application revision stored in Amazon S3.

  • GitHub: An application revision stored in GitHub (EC2/On-premises deployments only).

  • String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only).

" + }, + "s3Location":{ + "shape":"S3Location", + "documentation":"

Information about the location of a revision stored in Amazon S3.

" + }, + "gitHubLocation":{ + "shape":"GitHubLocation", + "documentation":"

Information about the location of application artifacts stored in GitHub.

" + }, + "string":{ + "shape":"RawString", + "documentation":"

Information about the location of an AWS Lambda deployment revision stored as a RawString.

" + }, + "appSpecContent":{ + "shape":"AppSpecContent", + "documentation":"

The content of an AppSpec file for an AWS Lambda or Amazon ECS deployment. The content is formatted as JSON or YAML and stored as a RawString.

" + } + }, + "documentation":"

Information about the location of an application revision.

" + }, + "RevisionLocationList":{ + "type":"list", + "member":{"shape":"RevisionLocation"} + }, + "RevisionLocationType":{ + "type":"string", + "enum":[ + "S3", + "GitHub", + "String", + "AppSpecContent" + ] + }, + "RevisionRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The revision ID was not specified.

", + "exception":true + }, + "Role":{"type":"string"}, + "RoleRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The role ID was not specified.

", + "exception":true + }, + "RollbackInfo":{ + "type":"structure", + "members":{ + "rollbackDeploymentId":{ + "shape":"DeploymentId", + "documentation":"

The ID of the deployment rollback.

" + }, + "rollbackTriggeringDeploymentId":{ + "shape":"DeploymentId", + "documentation":"

The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.

" + }, + "rollbackMessage":{ + "shape":"Description", + "documentation":"

Information that describes the status of a deployment rollback (for example, whether the deployment can't be rolled back, is in progress, failed, or succeeded).

" + } + }, + "documentation":"

Information about a deployment rollback.

" + }, + "S3Bucket":{"type":"string"}, + "S3Key":{"type":"string"}, + "S3Location":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"S3Bucket", + "documentation":"

The name of the Amazon S3 bucket where the application revision is stored.

" + }, + "key":{ + "shape":"S3Key", + "documentation":"

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

" + }, + "bundleType":{ + "shape":"BundleType", + "documentation":"

The file type of the application revision. Must be one of the following:

  • tar: A tar archive file.

  • tgz: A compressed tar archive file.

  • zip: A zip archive file.

" + }, + "version":{ + "shape":"VersionId", + "documentation":"

A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the version is not specified, the system uses the most recent version by default.

" + }, + "eTag":{ + "shape":"ETag", + "documentation":"

The ETag of the Amazon S3 object that represents the bundled artifacts for the application revision.

If the ETag is not specified as an input parameter, ETag validation of the object is skipped.

" + } + }, + "documentation":"

Information about the location of application artifacts stored in Amazon S3.

" + }, + "ScriptName":{"type":"string"}, + "SkipWaitTimeForInstanceTerminationInput":{ + "type":"structure", + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a blue/green deployment for which you want to skip the instance termination wait time.

" + } + } + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ascending", + "descending" + ] + }, + "StopDeploymentInput":{ + "type":"structure", + "required":["deploymentId"], + "members":{ + "deploymentId":{ + "shape":"DeploymentId", + "documentation":"

The unique ID of a deployment.

" + }, + "autoRollbackEnabled":{ + "shape":"NullableBoolean", + "documentation":"

Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.

" + } + }, + "documentation":"

Represents the input of a StopDeployment operation.

" + }, + "StopDeploymentOutput":{ + "type":"structure", + "members":{ + "status":{ + "shape":"StopStatus", + "documentation":"

The status of the stop deployment operation:

  • Pending: The stop operation is pending.

  • Succeeded: The stop operation was successful.

" + }, + "statusMessage":{ + "shape":"Message", + "documentation":"

An accompanying status message.

" + } + }, + "documentation":"

Represents the output of a StopDeployment operation.

" + }, + "StopStatus":{ + "type":"string", + "enum":[ + "Pending", + "Succeeded" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The tag's key.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

Information about a tag.

" + }, + "TagFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The on-premises instance tag filter key.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The on-premises instance tag filter value.

" + }, + "Type":{ + "shape":"TagFilterType", + "documentation":"

The on-premises instance tag filter type:

  • KEY_ONLY: Key only.

  • VALUE_ONLY: Value only.

  • KEY_AND_VALUE: Key and value.

" + } + }, + "documentation":"

Information about an on-premises instance tag filter.

" + }, + "TagFilterList":{ + "type":"list", + "member":{"shape":"TagFilter"} + }, + "TagFilterType":{ + "type":"string", + "enum":[ + "KEY_ONLY", + "VALUE_ONLY", + "KEY_AND_VALUE" + ] + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"Key"} + }, + "TagLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum allowed number of tags was exceeded.

", + "exception":true + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A tag was not specified.

", + "exception":true + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of a resource, such as a CodeDeploy application or deployment group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags that TagResource associates with a resource. The resource is identified by the ResourceArn input parameter.

" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagSetListLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of tag groups included in the tag set list exceeded the maximum allowed limit of 3.

", + "exception":true + }, + "TargetArn":{"type":"string"}, + "TargetFilterName":{ + "type":"string", + "enum":[ + "TargetStatus", + "ServerInstanceLabel" + ] + }, + "TargetFilters":{ + "type":"map", + "key":{"shape":"TargetFilterName"}, + "value":{"shape":"FilterValueList"} + }, + "TargetGroupInfo":{ + "type":"structure", + "members":{ + "name":{ + "shape":"TargetGroupName", + "documentation":"

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

" + } + }, + "documentation":"

Information about a target group in Elastic Load Balancing to use in a deployment. Instances are registered as targets in a target group, and traffic is routed to the target group.

" + }, + "TargetGroupInfoList":{ + "type":"list", + "member":{"shape":"TargetGroupInfo"} + }, + "TargetGroupName":{"type":"string"}, + "TargetGroupPairInfo":{ + "type":"structure", + "members":{ + "targetGroups":{ + "shape":"TargetGroupInfoList", + "documentation":"

One pair of target groups. One is associated with the original task set. The second is associated with the task set that serves traffic after the deployment is complete.

" + }, + "prodTrafficRoute":{ + "shape":"TrafficRoute", + "documentation":"

The path used by a load balancer to route production traffic when an Amazon ECS deployment is complete.

" + }, + "testTrafficRoute":{ + "shape":"TrafficRoute", + "documentation":"

An optional path used by a load balancer to route test traffic after an Amazon ECS deployment. Validation can occur while test traffic is served during a deployment.

" + } + }, + "documentation":"

Information about two target groups and how traffic is routed during an Amazon ECS deployment. An optional test traffic route can be specified.

" + }, + "TargetGroupPairInfoList":{ + "type":"list", + "member":{"shape":"TargetGroupPairInfo"} + }, + "TargetId":{"type":"string"}, + "TargetIdList":{ + "type":"list", + "member":{"shape":"TargetId"} + }, + "TargetInstances":{ + "type":"structure", + "members":{ + "tagFilters":{ + "shape":"EC2TagFilterList", + "documentation":"

The tag filter key, type, and value used to identify Amazon EC2 instances in a replacement environment for a blue/green deployment. Cannot be used in the same call as ec2TagSet.

" + }, + "autoScalingGroups":{ + "shape":"AutoScalingGroupNameList", + "documentation":"

The names of one or more Auto Scaling groups to identify a replacement environment for a blue/green deployment.

" + }, + "ec2TagSet":{ + "shape":"EC2TagSet", + "documentation":"

Information about the groups of EC2 instance tags that an instance must be identified by in order for it to be included in the replacement environment for a blue/green deployment. Cannot be used in the same call as tagFilters.

" + } + }, + "documentation":"

Information about the instances to be used in the replacement environment in a blue/green deployment.

" + }, + "TargetLabel":{ + "type":"string", + "enum":[ + "Blue", + "Green" + ] + }, + "TargetStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Succeeded", + "Failed", + "Skipped", + "Unknown", + "Ready" + ] + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An API function was called too frequently.

", + "exception":true + }, + "Time":{"type":"timestamp"}, + "TimeBasedCanary":{ + "type":"structure", + "members":{ + "canaryPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

" + }, + "canaryInterval":{ + "shape":"WaitTimeInMins", + "documentation":"

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

" + } + }, + "documentation":"

A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.

" + }, + "TimeBasedLinear":{ + "type":"structure", + "members":{ + "linearPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

" + }, + "linearInterval":{ + "shape":"WaitTimeInMins", + "documentation":"

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.

" + } + }, + "documentation":"

A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.

" + }, + "TimeRange":{ + "type":"structure", + "members":{ + "start":{ + "shape":"Timestamp", + "documentation":"

The start time of the time range.

Specify null to leave the start time open-ended.

" + }, + "end":{ + "shape":"Timestamp", + "documentation":"

The end time of the time range.

Specify null to leave the end time open-ended.

" + } + }, + "documentation":"

Information about a time range.

" + }, + "Timestamp":{"type":"timestamp"}, + "TrafficRoute":{ + "type":"structure", + "members":{ + "listenerArns":{ + "shape":"ListenerArnList", + "documentation":"

The ARN of one listener. The listener identifies the route between a target group and a load balancer. This is an array of strings with a maximum size of one.

" + } + }, + "documentation":"

Information about a listener. The listener contains the path used to route traffic that is received from the load balancer to a target group.

" + }, + "TrafficRoutingConfig":{ + "type":"structure", + "members":{ + "type":{ + "shape":"TrafficRoutingType", + "documentation":"

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear) used by a deployment configuration .

" + }, + "timeBasedCanary":{ + "shape":"TimeBasedCanary", + "documentation":"

A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.

" + }, + "timeBasedLinear":{ + "shape":"TimeBasedLinear", + "documentation":"

A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.

" + } + }, + "documentation":"

The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment.

" + }, + "TrafficRoutingType":{ + "type":"string", + "enum":[ + "TimeBasedCanary", + "TimeBasedLinear", + "AllAtOnce" + ] + }, + "TrafficWeight":{"type":"double"}, + "TriggerConfig":{ + "type":"structure", + "members":{ + "triggerName":{ + "shape":"TriggerName", + "documentation":"

The name of the notification trigger.

" + }, + "triggerTargetArn":{ + "shape":"TriggerTargetArn", + "documentation":"

The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.

" + }, + "triggerEvents":{ + "shape":"TriggerEventTypeList", + "documentation":"

The event type or types for which notifications are triggered.

" + } + }, + "documentation":"

Information about notification triggers for the deployment group.

" + }, + "TriggerConfigList":{ + "type":"list", + "member":{"shape":"TriggerConfig"} + }, + "TriggerEventType":{ + "type":"string", + "enum":[ + "DeploymentStart", + "DeploymentSuccess", + "DeploymentFailure", + "DeploymentStop", + "DeploymentRollback", + "DeploymentReady", + "InstanceStart", + "InstanceSuccess", + "InstanceFailure", + "InstanceReady" + ] + }, + "TriggerEventTypeList":{ + "type":"list", + "member":{"shape":"TriggerEventType"} + }, + "TriggerName":{"type":"string"}, + "TriggerTargetArn":{"type":"string"}, + "TriggerTargetsLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The maximum allowed number of triggers was exceeded.

", + "exception":true + }, + "UnsupportedActionForDeploymentTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A call was submitted that is not supported for the specified deployment type.

", + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies from which resource to disassociate the tags with the keys in the TagKeys input paramter.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of keys of Tag objects. The Tag objects identified by the keys are disassociated from the resource specified by the ResourceArn input parameter.

" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationInput":{ + "type":"structure", + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The current name of the application you want to change.

" + }, + "newApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The new name to give the application.

" + } + }, + "documentation":"

Represents the input of an UpdateApplication operation.

" + }, + "UpdateDeploymentGroupInput":{ + "type":"structure", + "required":[ + "applicationName", + "currentDeploymentGroupName" + ], + "members":{ + "applicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name that corresponds to the deployment group to update.

" + }, + "currentDeploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The current name of the deployment group.

" + }, + "newDeploymentGroupName":{ + "shape":"DeploymentGroupName", + "documentation":"

The new name of the deployment group, if you want to change it.

" + }, + "deploymentConfigName":{ + "shape":"DeploymentConfigName", + "documentation":"

The replacement deployment configuration name to use, if you want to change it.

" + }, + "ec2TagFilters":{ + "shape":"EC2TagFilterList", + "documentation":"

The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

" + }, + "onPremisesInstanceTagFilters":{ + "shape":"TagFilterList", + "documentation":"

The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.

" + }, + "autoScalingGroups":{ + "shape":"AutoScalingGroupNameList", + "documentation":"

The replacement list of Auto Scaling groups to be included in the deployment group, if you want to change them. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.

" + }, + "serviceRoleArn":{ + "shape":"Role", + "documentation":"

A replacement ARN for the service role, if you want to change it.

" + }, + "triggerConfigurations":{ + "shape":"TriggerConfigList", + "documentation":"

Information about triggers to change when the deployment group is updated. For examples, see Modify Triggers in an AWS CodeDeploy Deployment Group in the AWS CodeDeploy User Guide.

" + }, + "alarmConfiguration":{ + "shape":"AlarmConfiguration", + "documentation":"

Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.

" + }, + "autoRollbackConfiguration":{ + "shape":"AutoRollbackConfiguration", + "documentation":"

Information for an automatic rollback configuration that is added or changed when a deployment group is updated.

" + }, + "deploymentStyle":{ + "shape":"DeploymentStyle", + "documentation":"

Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.

" + }, + "blueGreenDeploymentConfiguration":{ + "shape":"BlueGreenDeploymentConfiguration", + "documentation":"

Information about blue/green deployment options for a deployment group.

" + }, + "loadBalancerInfo":{ + "shape":"LoadBalancerInfo", + "documentation":"

Information about the load balancer used in a deployment.

" + }, + "ec2TagSet":{ + "shape":"EC2TagSet", + "documentation":"

Information about groups of tags applied to on-premises instances. The deployment group includes only EC2 instances identified by all the tag groups.

" + }, + "ecsServices":{ + "shape":"ECSServiceList", + "documentation":"

The target Amazon ECS services in the deployment group. This applies only to deployment groups that use the Amazon ECS compute platform. A target Amazon ECS service is specified as an Amazon ECS cluster and service name pair using the format <clustername>:<servicename>.

" + }, + "onPremisesTagSet":{ + "shape":"OnPremisesTagSet", + "documentation":"

Information about an on-premises instance tag set. The deployment group includes only on-premises instances identified by all the tag groups.

" + } + }, + "documentation":"

Represents the input of an UpdateDeploymentGroup operation.

" + }, + "UpdateDeploymentGroupOutput":{ + "type":"structure", + "members":{ + "hooksNotCleanedUp":{ + "shape":"AutoScalingGroupList", + "documentation":"

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.

" + } + }, + "documentation":"

Represents the output of an UpdateDeploymentGroup operation.

" + }, + "Value":{"type":"string"}, + "Version":{"type":"string"}, + "VersionId":{"type":"string"}, + "WaitTimeInMins":{"type":"integer"} + }, + "documentation":"AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless AWS Lambda functions, or applications in an Amazon ECS service.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

  • Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

  • Deployment group: A set of individual instances, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.

  • Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.

  • Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.

  • Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.

AWS CodeDeploy Information Resources

" +} diff --git a/aws/dist/botocore/data/codedeploy/2014-10-06/waiters-2.json b/aws/dist/botocore/data/codedeploy/2014-10-06/waiters-2.json new file mode 100644 index 00000000..0fea4fac --- /dev/null +++ b/aws/dist/botocore/data/codedeploy/2014-10-06/waiters-2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "DeploymentSuccessful": { + "delay": 15, + "operation": "GetDeployment", + "maxAttempts": 120, + "acceptors": [ + { + "expected": "Succeeded", + "matcher": "path", + "state": "success", + "argument": "deploymentInfo.status" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "deploymentInfo.status" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "failure", + "argument": "deploymentInfo.status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/codepipeline/2015-07-09/examples-1.json b/aws/dist/botocore/data/codepipeline/2015-07-09/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/codepipeline/2015-07-09/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/codepipeline/2015-07-09/paginators-1.json b/aws/dist/botocore/data/codepipeline/2015-07-09/paginators-1.json new file mode 100644 index 00000000..a3a7a46c --- /dev/null +++ b/aws/dist/botocore/data/codepipeline/2015-07-09/paginators-1.json @@ -0,0 +1,38 @@ +{ + "pagination": { + "ListActionTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "actionTypes" + }, + "ListPipelineExecutions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "pipelineExecutionSummaries" + }, + "ListPipelines": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "pipelines" + }, + "ListWebhooks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "webhooks" + }, + "ListActionExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "actionExecutionDetails" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "tags" + } + } +} diff --git a/aws/dist/botocore/data/codepipeline/2015-07-09/service-2.json b/aws/dist/botocore/data/codepipeline/2015-07-09/service-2.json new file mode 100644 index 00000000..aaa8d241 --- /dev/null +++ b/aws/dist/botocore/data/codepipeline/2015-07-09/service-2.json @@ -0,0 +1,3592 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-07-09", + "endpointPrefix":"codepipeline", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CodePipeline", + "serviceFullName":"AWS CodePipeline", + "serviceId":"CodePipeline", + "signatureVersion":"v4", + "targetPrefix":"CodePipeline_20150709", + "uid":"codepipeline-2015-07-09" + }, + "operations":{ + "AcknowledgeJob":{ + "name":"AcknowledgeJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcknowledgeJobInput"}, + "output":{"shape":"AcknowledgeJobOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNonceException"}, + {"shape":"JobNotFoundException"} + ], + "documentation":"

Returns information about a specified job and whether that job has been received by the job worker. Used for custom actions only.

" + }, + "AcknowledgeThirdPartyJob":{ + "name":"AcknowledgeThirdPartyJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcknowledgeThirdPartyJobInput"}, + "output":{"shape":"AcknowledgeThirdPartyJobOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNonceException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InvalidClientTokenException"} + ], + "documentation":"

Confirms a job worker has received the specified job. Used for partner actions only.

" + }, + "CreateCustomActionType":{ + "name":"CreateCustomActionType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomActionTypeInput"}, + "output":{"shape":"CreateCustomActionTypeOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a new custom action that can be used in all pipelines associated with the AWS account. Only used for custom actions.

" + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePipelineInput"}, + "output":{"shape":"CreatePipelineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNameInUseException"}, + {"shape":"InvalidStageDeclarationException"}, + {"shape":"InvalidActionDeclarationException"}, + {"shape":"InvalidBlockerDeclarationException"}, + {"shape":"InvalidStructureException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a pipeline.

In the pipeline structure, you must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

" + }, + "DeleteCustomActionType":{ + "name":"DeleteCustomActionType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomActionTypeInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.

To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.

" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePipelineInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes the specified pipeline.

" + }, + "DeleteWebhook":{ + "name":"DeleteWebhook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebhookInput"}, + "output":{"shape":"DeleteWebhookOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a previously created webhook by name. Deleting the webhook stops AWS CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.

" + }, + "DeregisterWebhookWithThirdParty":{ + "name":"DeregisterWebhookWithThirdParty", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterWebhookWithThirdPartyInput"}, + "output":{"shape":"DeregisterWebhookWithThirdPartyOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"WebhookNotFoundException"} + ], + "documentation":"

Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.

" + }, + "DisableStageTransition":{ + "name":"DisableStageTransition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableStageTransitionInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"StageNotFoundException"} + ], + "documentation":"

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

" + }, + "EnableStageTransition":{ + "name":"EnableStageTransition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableStageTransitionInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"StageNotFoundException"} + ], + "documentation":"

Enables artifacts in a pipeline to transition to a stage in a pipeline.

" + }, + "GetJobDetails":{ + "name":"GetJobDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobDetailsInput"}, + "output":{"shape":"GetJobDetailsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"JobNotFoundException"} + ], + "documentation":"

Returns information about a job. Used for custom actions only.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

" + }, + "GetPipeline":{ + "name":"GetPipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPipelineInput"}, + "output":{"shape":"GetPipelineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineVersionNotFoundException"} + ], + "documentation":"

Returns the metadata, structure, stages, and actions of a pipeline. Can be used to return the entire structure of a pipeline in JSON format, which can then be modified and used to update the pipeline structure with UpdatePipeline.

" + }, + "GetPipelineExecution":{ + "name":"GetPipelineExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPipelineExecutionInput"}, + "output":{"shape":"GetPipelineExecutionOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"PipelineExecutionNotFoundException"} + ], + "documentation":"

Returns information about an execution of a pipeline, including details about artifacts, the pipeline execution ID, and the name, version, and status of the pipeline.

" + }, + "GetPipelineState":{ + "name":"GetPipelineState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPipelineStateInput"}, + "output":{"shape":"GetPipelineStateOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"} + ], + "documentation":"

Returns information about the state of a pipeline, including the stages and actions.

Values returned in the revisionId and revisionUrl fields indicate the source revision information, such as the commit ID, for the current state.

" + }, + "GetThirdPartyJobDetails":{ + "name":"GetThirdPartyJobDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetThirdPartyJobDetailsInput"}, + "output":{"shape":"GetThirdPartyJobDetailsOutput"}, + "errors":[ + {"shape":"JobNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidJobException"} + ], + "documentation":"

Requests the details of a job for a third party action. Used for partner actions only.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

" + }, + "ListActionExecutions":{ + "name":"ListActionExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActionExecutionsInput"}, + "output":{"shape":"ListActionExecutionsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"PipelineExecutionNotFoundException"} + ], + "documentation":"

Lists the action executions that have occurred in a pipeline.

" + }, + "ListActionTypes":{ + "name":"ListActionTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActionTypesInput"}, + "output":{"shape":"ListActionTypesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets a summary of all AWS CodePipeline action types associated with your account.

" + }, + "ListPipelineExecutions":{ + "name":"ListPipelineExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPipelineExecutionsInput"}, + "output":{"shape":"ListPipelineExecutionsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets a summary of the most recent executions for a pipeline.

" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPipelinesInput"}, + "output":{"shape":"ListPipelinesOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets a summary of all of the pipelines associated with your account.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidArnException"} + ], + "documentation":"

Gets the set of key-value pairs (metadata) that are used to manage the resource.

" + }, + "ListWebhooks":{ + "name":"ListWebhooks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWebhooksInput"}, + "output":{"shape":"ListWebhooksOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets a listing of all the webhooks in this AWS Region for this account. The output lists all webhooks and includes the webhook URL and ARN and the configuration for each webhook.

" + }, + "PollForJobs":{ + "name":"PollForJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForJobsInput"}, + "output":{"shape":"PollForJobsOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ActionTypeNotFoundException"} + ], + "documentation":"

Returns information about any jobs for AWS CodePipeline to act on. PollForJobs is valid only for action types with \"Custom\" in the owner field. If the action type contains \"AWS\" or \"ThirdParty\" in the owner field, the PollForJobs action returns an error.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.

" + }, + "PollForThirdPartyJobs":{ + "name":"PollForThirdPartyJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForThirdPartyJobsInput"}, + "output":{"shape":"PollForThirdPartyJobsOutput"}, + "errors":[ + {"shape":"ActionTypeNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Determines whether there are any third party jobs for a job worker to act on. Used for partner actions only.

When this API is called, AWS CodePipeline returns temporary credentials for the Amazon S3 bucket used to store artifacts for the pipeline, if the action requires access to that Amazon S3 bucket for input or output artifacts.

" + }, + "PutActionRevision":{ + "name":"PutActionRevision", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutActionRevisionInput"}, + "output":{"shape":"PutActionRevisionOutput"}, + "errors":[ + {"shape":"PipelineNotFoundException"}, + {"shape":"StageNotFoundException"}, + {"shape":"ActionNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Provides information to AWS CodePipeline about new revisions to a source.

" + }, + "PutApprovalResult":{ + "name":"PutApprovalResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutApprovalResultInput"}, + "output":{"shape":"PutApprovalResultOutput"}, + "errors":[ + {"shape":"InvalidApprovalTokenException"}, + {"shape":"ApprovalAlreadyCompletedException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"StageNotFoundException"}, + {"shape":"ActionNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

" + }, + "PutJobFailureResult":{ + "name":"PutJobFailureResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutJobFailureResultInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InvalidJobStateException"} + ], + "documentation":"

Represents the failure of a job as returned to the pipeline by a job worker. Used for custom actions only.

" + }, + "PutJobSuccessResult":{ + "name":"PutJobSuccessResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutJobSuccessResultInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InvalidJobStateException"} + ], + "documentation":"

Represents the success of a job as returned to the pipeline by a job worker. Used for custom actions only.

" + }, + "PutThirdPartyJobFailureResult":{ + "name":"PutThirdPartyJobFailureResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutThirdPartyJobFailureResultInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"InvalidClientTokenException"} + ], + "documentation":"

Represents the failure of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

" + }, + "PutThirdPartyJobSuccessResult":{ + "name":"PutThirdPartyJobSuccessResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutThirdPartyJobSuccessResultInput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"InvalidClientTokenException"} + ], + "documentation":"

Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.

" + }, + "PutWebhook":{ + "name":"PutWebhook", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutWebhookInput"}, + "output":{"shape":"PutWebhookOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidWebhookFilterPatternException"}, + {"shape":"InvalidWebhookAuthenticationParametersException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Defines a webhook and returns a unique webhook URL generated by CodePipeline. This URL can be supplied to third party source hosting providers to call every time there's a code change. When CodePipeline receives a POST request on this URL, the pipeline defined in the webhook is started as long as the POST request satisfied the authentication and filtering requirements supplied when defining the webhook. RegisterWebhookWithThirdParty and DeregisterWebhookWithThirdParty APIs can be used to automatically configure supported third parties to call the generated webhook URL.

" + }, + "RegisterWebhookWithThirdParty":{ + "name":"RegisterWebhookWithThirdParty", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterWebhookWithThirdPartyInput"}, + "output":{"shape":"RegisterWebhookWithThirdPartyOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"WebhookNotFoundException"} + ], + "documentation":"

Configures a connection between the webhook that was created and the external tool with events to be detected.

" + }, + "RetryStageExecution":{ + "name":"RetryStageExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetryStageExecutionInput"}, + "output":{"shape":"RetryStageExecutionOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"}, + {"shape":"StageNotFoundException"}, + {"shape":"StageNotRetryableException"}, + {"shape":"NotLatestPipelineExecutionException"} + ], + "documentation":"

Resumes the pipeline execution by retrying the last failed actions in a stage. You can retry a stage immediately if any of the actions in the stage fail. When you retry, all actions that are still in progress continue working, and failed actions are triggered again.

" + }, + "StartPipelineExecution":{ + "name":"StartPipelineExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartPipelineExecutionInput"}, + "output":{"shape":"StartPipelineExecutionOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"PipelineNotFoundException"} + ], + "documentation":"

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes tags from an AWS resource.

" + }, + "UpdatePipeline":{ + "name":"UpdatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePipelineInput"}, + "output":{"shape":"UpdatePipelineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidStageDeclarationException"}, + {"shape":"InvalidActionDeclarationException"}, + {"shape":"InvalidBlockerDeclarationException"}, + {"shape":"InvalidStructureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

" + } + }, + "shapes":{ + "AWSRegionName":{ + "type":"string", + "max":30, + "min":4 + }, + "AWSSessionCredentials":{ + "type":"structure", + "required":[ + "accessKeyId", + "secretAccessKey", + "sessionToken" + ], + "members":{ + "accessKeyId":{ + "shape":"AccessKeyId", + "documentation":"

The access key for the session.

" + }, + "secretAccessKey":{ + "shape":"SecretAccessKey", + "documentation":"

The secret access key for the session.

" + }, + "sessionToken":{ + "shape":"SessionToken", + "documentation":"

The token for the session.

" + } + }, + "documentation":"

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

", + "sensitive":true + }, + "AccessKeyId":{"type":"string"}, + "AccountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AcknowledgeJobInput":{ + "type":"structure", + "required":[ + "jobId", + "nonce" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID of the job for which you want to confirm receipt.

" + }, + "nonce":{ + "shape":"Nonce", + "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response of the PollForJobs request that returned this job.

" + } + }, + "documentation":"

Represents the input of an AcknowledgeJob action.

" + }, + "AcknowledgeJobOutput":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatus", + "documentation":"

Whether the job worker has received the specified job.

" + } + }, + "documentation":"

Represents the output of an AcknowledgeJob action.

" + }, + "AcknowledgeThirdPartyJobInput":{ + "type":"structure", + "required":[ + "jobId", + "nonce", + "clientToken" + ], + "members":{ + "jobId":{ + "shape":"ThirdPartyJobId", + "documentation":"

The unique system-generated ID of the job.

" + }, + "nonce":{ + "shape":"Nonce", + "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Get this number from the response to a GetThirdPartyJobDetails request.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" + } + }, + "documentation":"

Represents the input of an AcknowledgeThirdPartyJob action.

" + }, + "AcknowledgeThirdPartyJobOutput":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatus", + "documentation":"

The status information for the third party job, if any.

" + } + }, + "documentation":"

Represents the output of an AcknowledgeThirdPartyJob action.

" + }, + "ActionCategory":{ + "type":"string", + "enum":[ + "Source", + "Build", + "Deploy", + "Test", + "Invoke", + "Approval" + ] + }, + "ActionConfiguration":{ + "type":"structure", + "members":{ + "configuration":{ + "shape":"ActionConfigurationMap", + "documentation":"

The configuration data for the action.

" + } + }, + "documentation":"

Represents information about an action configuration.

" + }, + "ActionConfigurationKey":{ + "type":"string", + "max":50, + "min":1 + }, + "ActionConfigurationMap":{ + "type":"map", + "key":{"shape":"ActionConfigurationKey"}, + "value":{"shape":"ActionConfigurationValue"} + }, + "ActionConfigurationProperty":{ + "type":"structure", + "required":[ + "name", + "required", + "key", + "secret" + ], + "members":{ + "name":{ + "shape":"ActionConfigurationKey", + "documentation":"

The name of the action configuration property.

" + }, + "required":{ + "shape":"Boolean", + "documentation":"

Whether the configuration property is a required value.

" + }, + "key":{ + "shape":"Boolean", + "documentation":"

Whether the configuration property is a key.

" + }, + "secret":{ + "shape":"Boolean", + "documentation":"

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action preserves the previous value of the secret.

" + }, + "queryable":{ + "shape":"Boolean", + "documentation":"

Indicates that the property is used with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the action configuration property that is displayed to users.

" + }, + "type":{ + "shape":"ActionConfigurationPropertyType", + "documentation":"

The type of the configuration property.

" + } + }, + "documentation":"

Represents information about an action configuration property.

" + }, + "ActionConfigurationPropertyList":{ + "type":"list", + "member":{"shape":"ActionConfigurationProperty"}, + "max":10 + }, + "ActionConfigurationPropertyType":{ + "type":"string", + "enum":[ + "String", + "Number", + "Boolean" + ] + }, + "ActionConfigurationQueryableValue":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ActionConfigurationValue":{ + "type":"string", + "max":1000, + "min":1 + }, + "ActionContext":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ActionName", + "documentation":"

The name of the action in the context of a job.

" + }, + "actionExecutionId":{ + "shape":"ActionExecutionId", + "documentation":"

The system-generated unique ID that corresponds to an action's execution.

" + } + }, + "documentation":"

Represents the context of an action in the stage of a pipeline to a job worker.

" + }, + "ActionDeclaration":{ + "type":"structure", + "required":[ + "name", + "actionTypeId" + ], + "members":{ + "name":{ + "shape":"ActionName", + "documentation":"

The action declaration's name.

" + }, + "actionTypeId":{ + "shape":"ActionTypeId", + "documentation":"

Specifies the action type and the provider of the action.

" + }, + "runOrder":{ + "shape":"ActionRunOrder", + "documentation":"

The order in which actions are run.

" + }, + "configuration":{ + "shape":"ActionConfigurationMap", + "documentation":"

The action's configuration. These are key-value pairs that specify input values for an action. For more information, see Action Structure Requirements in CodePipeline. For the list of configuration properties for the AWS CloudFormation action type in CodePipeline, see Configuration Properties Reference in the AWS CloudFormation User Guide. For template snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in the AWS CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON configuration item format is as follows:

JSON:

\"Configuration\" : { Key : Value },

" + }, + "outputArtifacts":{ + "shape":"OutputArtifactList", + "documentation":"

The name or ID of the result of the action declaration, such as a test or build artifact.

" + }, + "inputArtifacts":{ + "shape":"InputArtifactList", + "documentation":"

The name or ID of the artifact consumed by the action, such as a test or build artifact.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

" + }, + "region":{ + "shape":"AWSRegionName", + "documentation":"

The action declaration's AWS Region, such as us-east-1.

" + } + }, + "documentation":"

Represents information about an action declaration.

" + }, + "ActionExecution":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ActionExecutionStatus", + "documentation":"

The status of the action, or for a completed action, the last status of the action.

" + }, + "summary":{ + "shape":"ExecutionSummary", + "documentation":"

A summary of the run of the action.

" + }, + "lastStatusChange":{ + "shape":"Timestamp", + "documentation":"

The last status change of the action.

" + }, + "token":{ + "shape":"ActionExecutionToken", + "documentation":"

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState command. It is used to validate that the approval request corresponding to this token is still valid.

" + }, + "lastUpdatedBy":{ + "shape":"LastUpdatedBy", + "documentation":"

The ARN of the user who last changed the pipeline.

" + }, + "externalExecutionId":{ + "shape":"ExecutionId", + "documentation":"

The external ID of the run of the action.

" + }, + "externalExecutionUrl":{ + "shape":"Url", + "documentation":"

The URL of a resource external to AWS that is used when running the action (for example, an external repository URL).

" + }, + "percentComplete":{ + "shape":"Percentage", + "documentation":"

A percentage of completeness of the action as it runs.

" + }, + "errorDetails":{ + "shape":"ErrorDetails", + "documentation":"

The details of an error returned by a URL external to AWS.

" + } + }, + "documentation":"

Represents information about the run of an action.

" + }, + "ActionExecutionDetail":{ + "type":"structure", + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The pipeline execution ID for the action execution.

" + }, + "actionExecutionId":{ + "shape":"ActionExecutionId", + "documentation":"

The action execution ID.

" + }, + "pipelineVersion":{ + "shape":"PipelineVersion", + "documentation":"

The version of the pipeline where the action was run.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage that contains the action.

" + }, + "actionName":{ + "shape":"ActionName", + "documentation":"

The name of the action.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the action execution.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last update time of the action execution.

" + }, + "status":{ + "shape":"ActionExecutionStatus", + "documentation":"

The status of the action execution. Status categories are InProgress, Succeeded, and Failed.

" + }, + "input":{ + "shape":"ActionExecutionInput", + "documentation":"

Input details for the action execution, such as role ARN, Region, and input artifacts.

" + }, + "output":{ + "shape":"ActionExecutionOutput", + "documentation":"

Output details for the action execution, such as the action execution result.

" + } + }, + "documentation":"

Returns information about an execution of an action, including the action execution ID, and the name, version, and timing of the action.

" + }, + "ActionExecutionDetailList":{ + "type":"list", + "member":{"shape":"ActionExecutionDetail"} + }, + "ActionExecutionFilter":{ + "type":"structure", + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The pipeline execution ID used to filter action execution history.

" + } + }, + "documentation":"

Filter values for the action execution.

" + }, + "ActionExecutionId":{"type":"string"}, + "ActionExecutionInput":{ + "type":"structure", + "members":{ + "actionTypeId":{"shape":"ActionTypeId"}, + "configuration":{ + "shape":"ActionConfigurationMap", + "documentation":"

Configuration data for an action execution.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM service role that performs the declared action. This is assumed through the roleArn for the pipeline.

" + }, + "region":{ + "shape":"AWSRegionName", + "documentation":"

The AWS Region for the action, such as us-east-1.

" + }, + "inputArtifacts":{ + "shape":"ArtifactDetailList", + "documentation":"

Details of input artifacts of the action that correspond to the action execution.

" + } + }, + "documentation":"

Input information used for an action execution.

" + }, + "ActionExecutionOutput":{ + "type":"structure", + "members":{ + "outputArtifacts":{ + "shape":"ArtifactDetailList", + "documentation":"

Details of output artifacts of the action that correspond to the action execution.

" + }, + "executionResult":{ + "shape":"ActionExecutionResult", + "documentation":"

Execution result information listed in the output details for an action execution.

" + } + }, + "documentation":"

Output details listed for an action execution, such as the action execution result.

" + }, + "ActionExecutionResult":{ + "type":"structure", + "members":{ + "externalExecutionId":{ + "shape":"ExternalExecutionId", + "documentation":"

The action provider's external ID for the action execution.

" + }, + "externalExecutionSummary":{ + "shape":"ExternalExecutionSummary", + "documentation":"

The action provider's summary for the action execution.

" + }, + "externalExecutionUrl":{ + "shape":"Url", + "documentation":"

The deepest external link to the external resource (for example, a repository URL or deployment endpoint) that is used when running the action.

" + } + }, + "documentation":"

Execution result information, such as the external execution ID.

" + }, + "ActionExecutionStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Succeeded", + "Failed" + ] + }, + "ActionExecutionToken":{"type":"string"}, + "ActionName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9.@\\-_]+" + }, + "ActionNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified action cannot be found.

", + "exception":true + }, + "ActionOwner":{ + "type":"string", + "enum":[ + "AWS", + "ThirdParty", + "Custom" + ] + }, + "ActionProvider":{ + "type":"string", + "max":25, + "min":1, + "pattern":"[0-9A-Za-z_-]+" + }, + "ActionRevision":{ + "type":"structure", + "required":[ + "revisionId", + "revisionChangeId", + "created" + ], + "members":{ + "revisionId":{ + "shape":"Revision", + "documentation":"

The system-generated unique ID that identifies the revision number of the action.

" + }, + "revisionChangeId":{ + "shape":"RevisionChangeIdentifier", + "documentation":"

The unique identifier of the change that set the state to this revision (for example, a deployment ID or timestamp).

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time when the most recent version of the action was created, in timestamp format.

" + } + }, + "documentation":"

Represents information about the version (or revision) of an action.

" + }, + "ActionRunOrder":{ + "type":"integer", + "max":999, + "min":1 + }, + "ActionState":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"ActionName", + "documentation":"

The name of the action.

" + }, + "currentRevision":{ + "shape":"ActionRevision", + "documentation":"

Represents information about the version (or revision) of an action.

" + }, + "latestExecution":{ + "shape":"ActionExecution", + "documentation":"

Represents information about the run of an action.

" + }, + "entityUrl":{ + "shape":"Url", + "documentation":"

A URL link for more information about the state of the action, such as a deployment group details page.

" + }, + "revisionUrl":{ + "shape":"Url", + "documentation":"

A URL link for more information about the revision, such as a commit details page.

" + } + }, + "documentation":"

Represents information about the state of an action.

" + }, + "ActionStateList":{ + "type":"list", + "member":{"shape":"ActionState"} + }, + "ActionType":{ + "type":"structure", + "required":[ + "id", + "inputArtifactDetails", + "outputArtifactDetails" + ], + "members":{ + "id":{ + "shape":"ActionTypeId", + "documentation":"

Represents information about an action type.

" + }, + "settings":{ + "shape":"ActionTypeSettings", + "documentation":"

The settings for the action type.

" + }, + "actionConfigurationProperties":{ + "shape":"ActionConfigurationPropertyList", + "documentation":"

The configuration properties for the action type.

" + }, + "inputArtifactDetails":{ + "shape":"ArtifactDetails", + "documentation":"

The details of the input artifact for the action, such as its commit ID.

" + }, + "outputArtifactDetails":{ + "shape":"ArtifactDetails", + "documentation":"

The details of the output artifact of the action, such as its commit ID.

" + } + }, + "documentation":"

Returns information about the details of an action type.

" + }, + "ActionTypeId":{ + "type":"structure", + "required":[ + "category", + "owner", + "provider", + "version" + ], + "members":{ + "category":{ + "shape":"ActionCategory", + "documentation":"

A category defines what kind of action can be taken in the stage, and constrains the provider type for the action. Valid categories are limited to one of the following values.

" + }, + "owner":{ + "shape":"ActionOwner", + "documentation":"

The creator of the action being called.

" + }, + "provider":{ + "shape":"ActionProvider", + "documentation":"

The provider of the service being called by the action. Valid providers are determined by the action category. For example, an action in the Deploy category type might have a provider of AWS CodeDeploy, which would be specified as CodeDeploy. For more information, see Valid Action Types and Providers in CodePipeline.

" + }, + "version":{ + "shape":"Version", + "documentation":"

A string that describes the action version.

" + } + }, + "documentation":"

Represents information about an action type.

" + }, + "ActionTypeList":{ + "type":"list", + "member":{"shape":"ActionType"} + }, + "ActionTypeNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified action type cannot be found.

", + "exception":true + }, + "ActionTypeSettings":{ + "type":"structure", + "members":{ + "thirdPartyConfigurationUrl":{ + "shape":"Url", + "documentation":"

The URL of a sign-up page where users can sign up for an external service and perform initial configuration of the action provided by that service.

" + }, + "entityUrlTemplate":{ + "shape":"UrlTemplate", + "documentation":"

The URL returned to the AWS CodePipeline console that provides a deep link to the resources of the external system, such as the configuration page for an AWS CodeDeploy deployment group. This link is provided as part of the action display in the pipeline.

" + }, + "executionUrlTemplate":{ + "shape":"UrlTemplate", + "documentation":"

The URL returned to the AWS CodePipeline console that contains a link to the top-level landing page for the external system, such as the console page for AWS CodeDeploy. This link is shown on the pipeline view page in the AWS CodePipeline console and provides a link to the execution entity of the external action.

" + }, + "revisionUrlTemplate":{ + "shape":"UrlTemplate", + "documentation":"

The URL returned to the AWS CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.

" + } + }, + "documentation":"

Returns information about the settings for an action type.

" + }, + "ApprovalAlreadyCompletedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The approval action has already been approved or rejected.

", + "exception":true + }, + "ApprovalResult":{ + "type":"structure", + "required":[ + "summary", + "status" + ], + "members":{ + "summary":{ + "shape":"ApprovalSummary", + "documentation":"

The summary of the current status of the approval request.

" + }, + "status":{ + "shape":"ApprovalStatus", + "documentation":"

The response submitted by a reviewer assigned to an approval action request.

" + } + }, + "documentation":"

Represents information about the result of an approval request.

" + }, + "ApprovalStatus":{ + "type":"string", + "enum":[ + "Approved", + "Rejected" + ] + }, + "ApprovalSummary":{ + "type":"string", + "max":512, + "min":0 + }, + "ApprovalToken":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "Artifact":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ArtifactName", + "documentation":"

The artifact's name.

" + }, + "revision":{ + "shape":"Revision", + "documentation":"

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or a revision ID (Amazon S3).

" + }, + "location":{ + "shape":"ArtifactLocation", + "documentation":"

The location of an artifact.

" + } + }, + "documentation":"

Represents information about an artifact that is worked on by actions in the pipeline.

" + }, + "ArtifactDetail":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ArtifactName", + "documentation":"

The artifact object name for the action execution.

" + }, + "s3location":{ + "shape":"S3Location", + "documentation":"

The Amazon S3 artifact location for the action execution.

" + } + }, + "documentation":"

Artifact details for the action execution, such as the artifact location.

" + }, + "ArtifactDetailList":{ + "type":"list", + "member":{"shape":"ArtifactDetail"} + }, + "ArtifactDetails":{ + "type":"structure", + "required":[ + "minimumCount", + "maximumCount" + ], + "members":{ + "minimumCount":{ + "shape":"MinimumArtifactCount", + "documentation":"

The minimum number of artifacts allowed for the action type.

" + }, + "maximumCount":{ + "shape":"MaximumArtifactCount", + "documentation":"

The maximum number of artifacts allowed for the action type.

" + } + }, + "documentation":"

Returns information about the details of an artifact.

" + }, + "ArtifactList":{ + "type":"list", + "member":{"shape":"Artifact"} + }, + "ArtifactLocation":{ + "type":"structure", + "members":{ + "type":{ + "shape":"ArtifactLocationType", + "documentation":"

The type of artifact in the location.

" + }, + "s3Location":{ + "shape":"S3ArtifactLocation", + "documentation":"

The Amazon S3 bucket that contains the artifact.

" + } + }, + "documentation":"

Represents information about the location of an artifact.

" + }, + "ArtifactLocationType":{ + "type":"string", + "enum":["S3"] + }, + "ArtifactName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z0-9_\\-]+" + }, + "ArtifactRevision":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ArtifactName", + "documentation":"

The name of an artifact. This name might be system-generated, such as \"MyApp\", or defined by the user when an action is created.

" + }, + "revisionId":{ + "shape":"Revision", + "documentation":"

The revision ID of the artifact.

" + }, + "revisionChangeIdentifier":{ + "shape":"RevisionChangeIdentifier", + "documentation":"

An additional identifier for a revision, such as a commit date or, for artifacts stored in Amazon S3 buckets, the ETag value.

" + }, + "revisionSummary":{ + "shape":"RevisionSummary", + "documentation":"

Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time when the most recent revision of the artifact was created, in timestamp format.

" + }, + "revisionUrl":{ + "shape":"Url", + "documentation":"

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.

" + } + }, + "documentation":"

Represents revision details of an artifact.

" + }, + "ArtifactRevisionList":{ + "type":"list", + "member":{"shape":"ArtifactRevision"} + }, + "ArtifactStore":{ + "type":"structure", + "required":[ + "type", + "location" + ], + "members":{ + "type":{ + "shape":"ArtifactStoreType", + "documentation":"

The type of the artifact store, such as S3.

" + }, + "location":{ + "shape":"ArtifactStoreLocation", + "documentation":"

The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder in the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.

" + }, + "encryptionKey":{ + "shape":"EncryptionKey", + "documentation":"

The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

" + } + }, + "documentation":"

The Amazon S3 bucket where artifacts for the pipeline are stored.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

" + }, + "ArtifactStoreLocation":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-zA-Z0-9\\-\\.]+" + }, + "ArtifactStoreMap":{ + "type":"map", + "key":{"shape":"AWSRegionName"}, + "value":{"shape":"ArtifactStore"} + }, + "ArtifactStoreType":{ + "type":"string", + "enum":["S3"] + }, + "BlockerDeclaration":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "name":{ + "shape":"BlockerName", + "documentation":"

Reserved for future use.

" + }, + "type":{ + "shape":"BlockerType", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Reserved for future use.

" + }, + "BlockerName":{ + "type":"string", + "max":100, + "min":1 + }, + "BlockerType":{ + "type":"string", + "enum":["Schedule"] + }, + "Boolean":{"type":"boolean"}, + "ClientId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ClientRequestToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ClientToken":{ + "type":"string", + "max":256, + "min":1 + }, + "Code":{"type":"string"}, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

Unable to modify the tag due to a simultaneous update request.

", + "exception":true + }, + "ContinuationToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "CreateCustomActionTypeInput":{ + "type":"structure", + "required":[ + "category", + "provider", + "version", + "inputArtifactDetails", + "outputArtifactDetails" + ], + "members":{ + "category":{ + "shape":"ActionCategory", + "documentation":"

The category of the custom action, such as a build action or a test action.

Although Source and Approval are listed as valid values, they are not currently functional. These values are reserved for future use.

" + }, + "provider":{ + "shape":"ActionProvider", + "documentation":"

The provider of the service used in the custom action, such as AWS CodeDeploy.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version identifier of the custom action.

" + }, + "settings":{ + "shape":"ActionTypeSettings", + "documentation":"

URLs that provide users information about this custom action.

" + }, + "configurationProperties":{ + "shape":"ActionConfigurationPropertyList", + "documentation":"

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

" + }, + "inputArtifactDetails":{ + "shape":"ArtifactDetails", + "documentation":"

The details of the input artifact for the action, such as its commit ID.

" + }, + "outputArtifactDetails":{ + "shape":"ArtifactDetails", + "documentation":"

The details of the output artifact of the action, such as its commit ID.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags for the custom action.

" + } + }, + "documentation":"

Represents the input of a CreateCustomActionType operation.

" + }, + "CreateCustomActionTypeOutput":{ + "type":"structure", + "required":["actionType"], + "members":{ + "actionType":{ + "shape":"ActionType", + "documentation":"

Returns information about the details of an action type.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Specifies the tags applied to the custom action.

" + } + }, + "documentation":"

Represents the output of a CreateCustomActionType operation.

" + }, + "CreatePipelineInput":{ + "type":"structure", + "required":["pipeline"], + "members":{ + "pipeline":{ + "shape":"PipelineDeclaration", + "documentation":"

Represents the structure of actions and stages to be performed in the pipeline.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags for the pipeline.

" + } + }, + "documentation":"

Represents the input of a CreatePipeline action.

" + }, + "CreatePipelineOutput":{ + "type":"structure", + "members":{ + "pipeline":{ + "shape":"PipelineDeclaration", + "documentation":"

Represents the structure of actions and stages to be performed in the pipeline.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Specifies the tags applied to the pipeline.

" + } + }, + "documentation":"

Represents the output of a CreatePipeline action.

" + }, + "CurrentRevision":{ + "type":"structure", + "required":[ + "revision", + "changeIdentifier" + ], + "members":{ + "revision":{ + "shape":"Revision", + "documentation":"

The revision ID of the current version of an artifact.

" + }, + "changeIdentifier":{ + "shape":"RevisionChangeIdentifier", + "documentation":"

The change identifier for the current revision.

" + }, + "created":{ + "shape":"Time", + "documentation":"

The date and time when the most recent revision of the artifact was created, in timestamp format.

" + }, + "revisionSummary":{ + "shape":"RevisionSummary", + "documentation":"

The summary of the most recent revision of the artifact.

" + } + }, + "documentation":"

Represents information about a current revision.

" + }, + "DeleteCustomActionTypeInput":{ + "type":"structure", + "required":[ + "category", + "provider", + "version" + ], + "members":{ + "category":{ + "shape":"ActionCategory", + "documentation":"

The category of the custom action that you want to delete, such as source or deploy.

" + }, + "provider":{ + "shape":"ActionProvider", + "documentation":"

The provider of the service used in the custom action, such as AWS CodeDeploy.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the custom action to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteCustomActionType operation. The custom action will be marked as deleted.

" + }, + "DeletePipelineInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline to be deleted.

" + } + }, + "documentation":"

Represents the input of a DeletePipeline action.

" + }, + "DeleteWebhookInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"WebhookName", + "documentation":"

The name of the webhook you want to delete.

" + } + } + }, + "DeleteWebhookOutput":{ + "type":"structure", + "members":{ + } + }, + "DeregisterWebhookWithThirdPartyInput":{ + "type":"structure", + "members":{ + "webhookName":{ + "shape":"WebhookName", + "documentation":"

The name of the webhook you want to deregister.

" + } + } + }, + "DeregisterWebhookWithThirdPartyOutput":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":160, + "min":1 + }, + "DisableStageTransitionInput":{ + "type":"structure", + "required":[ + "pipelineName", + "stageName", + "transitionType", + "reason" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage where you want to disable the inbound or outbound transition of artifacts.

" + }, + "transitionType":{ + "shape":"StageTransitionType", + "documentation":"

Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

" + }, + "reason":{ + "shape":"DisabledReason", + "documentation":"

The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

" + } + }, + "documentation":"

Represents the input of a DisableStageTransition action.

" + }, + "DisabledReason":{ + "type":"string", + "max":300, + "min":1, + "pattern":"[a-zA-Z0-9!@ \\(\\)\\.\\*\\?\\-]+" + }, + "EnableStageTransitionInput":{ + "type":"structure", + "required":[ + "pipelineName", + "stageName", + "transitionType" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage where you want to enable the transition of artifacts, either into the stage (inbound) or from that stage to the next stage (outbound).

" + }, + "transitionType":{ + "shape":"StageTransitionType", + "documentation":"

Specifies whether artifacts are allowed to enter the stage and be processed by the actions in that stage (inbound) or whether already processed artifacts are allowed to transition to the next stage (outbound).

" + } + }, + "documentation":"

Represents the input of an EnableStageTransition action.

" + }, + "Enabled":{"type":"boolean"}, + "EncryptionKey":{ + "type":"structure", + "required":[ + "id", + "type" + ], + "members":{ + "id":{ + "shape":"EncryptionKeyId", + "documentation":"

The ID used to identify the key. For an AWS KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the customer master key (CMK). For cross-account actions, you can only use the key ID or key ARN to identify the key.

" + }, + "type":{ + "shape":"EncryptionKeyType", + "documentation":"

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

" + } + }, + "documentation":"

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

" + }, + "EncryptionKeyId":{ + "type":"string", + "max":100, + "min":1 + }, + "EncryptionKeyType":{ + "type":"string", + "enum":["KMS"] + }, + "ErrorDetails":{ + "type":"structure", + "members":{ + "code":{ + "shape":"Code", + "documentation":"

The system ID or number code of the error.

" + }, + "message":{ + "shape":"Message", + "documentation":"

The text of the error message.

" + } + }, + "documentation":"

Represents information about an error in AWS CodePipeline.

" + }, + "ExecutionDetails":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"ExecutionSummary", + "documentation":"

The summary of the current status of the actions.

" + }, + "externalExecutionId":{ + "shape":"ExecutionId", + "documentation":"

The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.

" + }, + "percentComplete":{ + "shape":"Percentage", + "documentation":"

The percentage of work completed on the action, represented on a scale of 0 to 100 percent.

" + } + }, + "documentation":"

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

" + }, + "ExecutionId":{ + "type":"string", + "max":1500, + "min":1 + }, + "ExecutionSummary":{ + "type":"string", + "max":2048, + "min":1 + }, + "ExecutionTrigger":{ + "type":"structure", + "members":{ + "triggerType":{ + "shape":"TriggerType", + "documentation":"

The type of change-detection method, command, or user interaction that started a pipeline execution.

" + }, + "triggerDetail":{ + "shape":"TriggerDetail", + "documentation":"

Detail related to the event that started a pipeline execution, such as the webhook ARN of the webhook that triggered the pipeline execution or the user ARN for a user-initiated start-pipeline-execution CLI command.

" + } + }, + "documentation":"

The interaction or event that started a pipeline execution.

" + }, + "ExternalExecutionId":{"type":"string"}, + "ExternalExecutionSummary":{"type":"string"}, + "FailureDetails":{ + "type":"structure", + "required":[ + "type", + "message" + ], + "members":{ + "type":{ + "shape":"FailureType", + "documentation":"

The type of the failure.

" + }, + "message":{ + "shape":"Message", + "documentation":"

The message about the failure.

" + }, + "externalExecutionId":{ + "shape":"ExecutionId", + "documentation":"

The external ID of the run of the action that failed.

" + } + }, + "documentation":"

Represents information about failure details.

" + }, + "FailureType":{ + "type":"string", + "enum":[ + "JobFailed", + "ConfigurationError", + "PermissionError", + "RevisionOutOfSync", + "RevisionUnavailable", + "SystemUnavailable" + ] + }, + "GetJobDetailsInput":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID for the job.

" + } + }, + "documentation":"

Represents the input of a GetJobDetails action.

" + }, + "GetJobDetailsOutput":{ + "type":"structure", + "members":{ + "jobDetails":{ + "shape":"JobDetails", + "documentation":"

The details of the job.

If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.

" + } + }, + "documentation":"

Represents the output of a GetJobDetails action.

" + }, + "GetPipelineExecutionInput":{ + "type":"structure", + "required":[ + "pipelineName", + "pipelineExecutionId" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline about which you want to get execution details.

" + }, + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the pipeline execution about which you want to get execution details.

" + } + }, + "documentation":"

Represents the input of a GetPipelineExecution action.

" + }, + "GetPipelineExecutionOutput":{ + "type":"structure", + "members":{ + "pipelineExecution":{ + "shape":"PipelineExecution", + "documentation":"

Represents information about the execution of a pipeline.

" + } + }, + "documentation":"

Represents the output of a GetPipelineExecution action.

" + }, + "GetPipelineInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline for which you want to get information. Pipeline names must be unique under an AWS user account.

" + }, + "version":{ + "shape":"PipelineVersion", + "documentation":"

The version number of the pipeline. If you do not specify a version, defaults to the current version.

" + } + }, + "documentation":"

Represents the input of a GetPipeline action.

" + }, + "GetPipelineOutput":{ + "type":"structure", + "members":{ + "pipeline":{ + "shape":"PipelineDeclaration", + "documentation":"

Represents the structure of actions and stages to be performed in the pipeline.

" + }, + "metadata":{ + "shape":"PipelineMetadata", + "documentation":"

Represents the pipeline metadata information returned as part of the output of a GetPipeline action.

" + } + }, + "documentation":"

Represents the output of a GetPipeline action.

" + }, + "GetPipelineStateInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline about which you want to get information.

" + } + }, + "documentation":"

Represents the input of a GetPipelineState action.

" + }, + "GetPipelineStateOutput":{ + "type":"structure", + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline for which you want to get the state.

" + }, + "pipelineVersion":{ + "shape":"PipelineVersion", + "documentation":"

The version number of the pipeline.

A newly created pipeline is always assigned a version number of 1.

" + }, + "stageStates":{ + "shape":"StageStateList", + "documentation":"

A list of the pipeline stage output information, including stage name, state, most recent run details, whether the stage is disabled, and other data.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time the pipeline was created, in timestamp format.

" + }, + "updated":{ + "shape":"Timestamp", + "documentation":"

The date and time the pipeline was last updated, in timestamp format.

" + } + }, + "documentation":"

Represents the output of a GetPipelineState action.

" + }, + "GetThirdPartyJobDetailsInput":{ + "type":"structure", + "required":[ + "jobId", + "clientToken" + ], + "members":{ + "jobId":{ + "shape":"ThirdPartyJobId", + "documentation":"

The unique system-generated ID used for identifying the job.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" + } + }, + "documentation":"

Represents the input of a GetThirdPartyJobDetails action.

" + }, + "GetThirdPartyJobDetailsOutput":{ + "type":"structure", + "members":{ + "jobDetails":{ + "shape":"ThirdPartyJobDetails", + "documentation":"

The details of the job, including any protected values defined for the job.

" + } + }, + "documentation":"

Represents the output of a GetThirdPartyJobDetails action.

" + }, + "InputArtifact":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ArtifactName", + "documentation":"

The name of the artifact to be worked on (for example, \"My App\").

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

" + } + }, + "documentation":"

Represents information about an artifact to be worked on, such as a test or build artifact.

" + }, + "InputArtifactList":{ + "type":"list", + "member":{"shape":"InputArtifact"} + }, + "InvalidActionDeclarationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The action declaration was specified in an invalid format.

", + "exception":true + }, + "InvalidApprovalTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The approval request already received a response or has expired.

", + "exception":true + }, + "InvalidArnException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The specified resource ARN is invalid.

", + "exception":true + }, + "InvalidBlockerDeclarationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Reserved for future use.

", + "exception":true + }, + "InvalidClientTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The client token was specified in an invalid format

", + "exception":true + }, + "InvalidJobException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The job was specified in an invalid format or cannot be found.

", + "exception":true + }, + "InvalidJobStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The job state was specified in an invalid format.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The next token was specified in an invalid format. Make sure that the next token you provide is the token returned by a previous call.

", + "exception":true + }, + "InvalidNonceException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The nonce was specified in an invalid format.

", + "exception":true + }, + "InvalidStageDeclarationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The stage declaration was specified in an invalid format.

", + "exception":true + }, + "InvalidStructureException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The structure was specified in an invalid format.

", + "exception":true + }, + "InvalidTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The specified resource tags are invalid.

", + "exception":true + }, + "InvalidWebhookAuthenticationParametersException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified authentication type is in an invalid format.

", + "exception":true + }, + "InvalidWebhookFilterPatternException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified event filter rule is in an invalid format.

", + "exception":true + }, + "Job":{ + "type":"structure", + "members":{ + "id":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID of the job.

" + }, + "data":{ + "shape":"JobData", + "documentation":"

Other data about a job.

" + }, + "nonce":{ + "shape":"Nonce", + "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeJob request.

" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"

The ID of the AWS account to use when performing the job.

" + } + }, + "documentation":"

Represents information about a job.

" + }, + "JobData":{ + "type":"structure", + "members":{ + "actionTypeId":{ + "shape":"ActionTypeId", + "documentation":"

Represents information about an action type.

" + }, + "actionConfiguration":{ + "shape":"ActionConfiguration", + "documentation":"

Represents information about an action configuration.

" + }, + "pipelineContext":{ + "shape":"PipelineContext", + "documentation":"

Represents information about a pipeline to a job worker.

Includes pipelineArn and pipelineExecutionId for custom jobs.

" + }, + "inputArtifacts":{ + "shape":"ArtifactList", + "documentation":"

The artifact supplied to the job.

" + }, + "outputArtifacts":{ + "shape":"ArtifactList", + "documentation":"

The output of the job.

" + }, + "artifactCredentials":{ + "shape":"AWSSessionCredentials", + "documentation":"

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifacts for the pipeline in AWS CodePipeline.

" + }, + "continuationToken":{ + "shape":"ContinuationToken", + "documentation":"

A system-generated token, such as a AWS CodeDeploy deployment ID, required by a job to continue the job asynchronously.

" + }, + "encryptionKey":{ + "shape":"EncryptionKey", + "documentation":"

Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key.

" + } + }, + "documentation":"

Represents other information about a job required for a job worker to complete the job.

" + }, + "JobDetails":{ + "type":"structure", + "members":{ + "id":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID of the job.

" + }, + "data":{ + "shape":"JobData", + "documentation":"

Represents other information about a job required for a job worker to complete the job.

" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"

The AWS account ID associated with the job.

" + } + }, + "documentation":"

Represents information about the details of a job.

" + }, + "JobId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "JobList":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JobNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The job was specified in an invalid format or cannot be found.

", + "exception":true + }, + "JobStatus":{ + "type":"string", + "enum":[ + "Created", + "Queued", + "Dispatched", + "InProgress", + "TimedOut", + "Succeeded", + "Failed" + ] + }, + "JsonPath":{ + "type":"string", + "max":150, + "min":1 + }, + "LastChangedAt":{"type":"timestamp"}, + "LastChangedBy":{"type":"string"}, + "LastUpdatedBy":{"type":"string"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of pipelines associated with the AWS account has exceeded the limit allowed for the account.

", + "exception":true + }, + "ListActionExecutionsInput":{ + "type":"structure", + "required":["pipelineName"], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline for which you want to list action execution history.

" + }, + "filter":{ + "shape":"ActionExecutionFilter", + "documentation":"

Input information used to filter action execution history.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Action execution history is retained for up to 12 months, based on action execution start times. Default value is 100.

Detailed execution history is available for executions run on or after February 21, 2019.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token that was returned from the previous ListActionExecutions call, which can be used to return the next set of action executions in the list.

" + } + } + }, + "ListActionExecutionsOutput":{ + "type":"structure", + "members":{ + "actionExecutionDetails":{ + "shape":"ActionExecutionDetailList", + "documentation":"

The details for a list of recent executions, such as action execution ID.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListActionExecutions call to return the next set of action executions in the list.

" + } + } + }, + "ListActionTypesInput":{ + "type":"structure", + "members":{ + "actionOwnerFilter":{ + "shape":"ActionOwner", + "documentation":"

Filters the list of action types to those created by a specified entity.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.

" + } + }, + "documentation":"

Represents the input of a ListActionTypes action.

" + }, + "ListActionTypesOutput":{ + "type":"structure", + "required":["actionTypes"], + "members":{ + "actionTypes":{ + "shape":"ActionTypeList", + "documentation":"

Provides details of the action types.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list action types call to return the next set of action types in the list.

" + } + }, + "documentation":"

Represents the output of a ListActionTypes action.

" + }, + "ListPipelineExecutionsInput":{ + "type":"structure", + "required":["pipelineName"], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline for which you want to get execution summary information.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. Pipeline history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token that was returned from the previous ListPipelineExecutions call, which can be used to return the next set of pipeline executions in the list.

" + } + }, + "documentation":"

Represents the input of a ListPipelineExecutions action.

" + }, + "ListPipelineExecutionsOutput":{ + "type":"structure", + "members":{ + "pipelineExecutionSummaries":{ + "shape":"PipelineExecutionSummaryList", + "documentation":"

A list of executions in the history of a pipeline.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used in the next ListPipelineExecutions call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

" + } + }, + "documentation":"

Represents the output of a ListPipelineExecutions action.

" + }, + "ListPipelinesInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.

" + } + }, + "documentation":"

Represents the input of a ListPipelines action.

" + }, + "ListPipelinesOutput":{ + "type":"structure", + "members":{ + "pipelines":{ + "shape":"PipelineList", + "documentation":"

The list of pipelines.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the amount of returned information is significantly large, an identifier is also returned. It can be used in a subsequent list pipelines call to return the next set of pipelines in the list.

" + } + }, + "documentation":"

Represents the output of a ListPipelines action.

" + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to get tags for.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token that was returned from the previous API call, which would be used to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in a single call.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The tags for the resource.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent API call to return the next page of the list. The ListTagsforResource call lists all available tags in one call and does not use pagination.

" + } + } + }, + "ListWebhookItem":{ + "type":"structure", + "required":[ + "definition", + "url" + ], + "members":{ + "definition":{ + "shape":"WebhookDefinition", + "documentation":"

The detail returned for each webhook, such as the webhook authentication type and filter rules.

" + }, + "url":{ + "shape":"WebhookUrl", + "documentation":"

A unique URL generated by CodePipeline. When a POST request is made to this URL, the defined pipeline is started as long as the body of the post request satisfies the defined authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL invalid and generates a new one.

" + }, + "errorMessage":{ + "shape":"WebhookErrorMessage", + "documentation":"

The text of the error message about the webhook.

" + }, + "errorCode":{ + "shape":"WebhookErrorCode", + "documentation":"

The number code of the error.

" + }, + "lastTriggered":{ + "shape":"WebhookLastTriggered", + "documentation":"

The date and time a webhook was last successfully triggered, in timestamp format.

" + }, + "arn":{ + "shape":"WebhookArn", + "documentation":"

The Amazon Resource Name (ARN) of the webhook.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Specifies the tags applied to the webhook.

" + } + }, + "documentation":"

The detail returned for each webhook after listing webhooks, such as the webhook URL, the webhook name, and the webhook ARN.

" + }, + "ListWebhooksInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that was returned from the previous ListWebhooks call, which can be used to return the next set of webhooks in the list.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "ListWebhooksOutput":{ + "type":"structure", + "members":{ + "webhooks":{ + "shape":"WebhookList", + "documentation":"

The JSON detail returned for each webhook in the list output for the ListWebhooks call.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the amount of returned information is significantly large, an identifier is also returned and can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.

" + } + } + }, + "MatchEquals":{ + "type":"string", + "max":150, + "min":1 + }, + "MaxBatchSize":{ + "type":"integer", + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaximumArtifactCount":{ + "type":"integer", + "max":5, + "min":0 + }, + "Message":{ + "type":"string", + "max":5000, + "min":1 + }, + "MinimumArtifactCount":{ + "type":"integer", + "max":5, + "min":0 + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "Nonce":{ + "type":"string", + "max":50, + "min":1 + }, + "NotLatestPipelineExecutionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated with the request is out of date.

", + "exception":true + }, + "OutputArtifact":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"ArtifactName", + "documentation":"

The name of the output of an artifact, such as \"My App\".

The input artifact of an action must exactly match the output artifact declared in a preceding action, but the input artifact does not have to be the next action in strict sequence from the action that provided the output artifact. Actions in parallel can declare different output artifacts, which are in turn consumed by different following actions.

Output artifact names must be unique within a pipeline.

" + } + }, + "documentation":"

Represents information about the output of an action.

" + }, + "OutputArtifactList":{ + "type":"list", + "member":{"shape":"OutputArtifact"} + }, + "Percentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "PipelineArn":{ + "type":"string", + "pattern":"arn:aws(-[\\w]+)*:codepipeline:.+:[0-9]{12}:.+" + }, + "PipelineContext":{ + "type":"structure", + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline. This is a user-specified value. Pipeline names must be unique across all pipeline names under an Amazon Web Services account.

" + }, + "stage":{ + "shape":"StageContext", + "documentation":"

The stage of the pipeline.

" + }, + "action":{ + "shape":"ActionContext", + "documentation":"

The context of an action to a job worker in the stage of a pipeline.

" + }, + "pipelineArn":{ + "shape":"PipelineArn", + "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" + }, + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The execution ID of the pipeline.

" + } + }, + "documentation":"

Represents information about a pipeline to a job worker.

PipelineContext contains pipelineArn and pipelineExecutionId for custom action jobs. The pipelineArn and pipelineExecutionId fields are not populated for ThirdParty action jobs.

" + }, + "PipelineDeclaration":{ + "type":"structure", + "required":[ + "name", + "roleArn", + "stages" + ], + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the action to be performed.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

" + }, + "artifactStore":{ + "shape":"ArtifactStore", + "documentation":"

Represents information about the Amazon S3 bucket where artifacts are stored for the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

" + }, + "artifactStores":{ + "shape":"ArtifactStoreMap", + "documentation":"

A mapping of artifactStore objects and their corresponding AWS Regions. There must be an artifact store for the pipeline Region and for each cross-region action in the pipeline.

You must include either artifactStore or artifactStores in your pipeline, but you cannot use both. If you create a cross-region action in your pipeline, you must use artifactStores.

" + }, + "stages":{ + "shape":"PipelineStageDeclarationList", + "documentation":"

The stage in which to perform the action.

" + }, + "version":{ + "shape":"PipelineVersion", + "documentation":"

The version number of the pipeline. A new pipeline always has a version number of 1. This number is incremented when a pipeline is updated.

" + } + }, + "documentation":"

Represents the structure of actions and stages to be performed in the pipeline.

" + }, + "PipelineExecution":{ + "type":"structure", + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline that was executed.

" + }, + "pipelineVersion":{ + "shape":"PipelineVersion", + "documentation":"

The version number of the pipeline that was executed.

" + }, + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the pipeline execution.

" + }, + "status":{ + "shape":"PipelineExecutionStatus", + "documentation":"

The status of the pipeline execution.

  • InProgress: The pipeline execution is currently running.

  • Succeeded: The pipeline execution was completed successfully.

  • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead.

  • Failed: The pipeline execution was not completed successfully.

" + }, + "artifactRevisions":{ + "shape":"ArtifactRevisionList", + "documentation":"

A list of ArtifactRevision objects included in a pipeline execution.

" + } + }, + "documentation":"

Represents information about an execution of a pipeline.

" + }, + "PipelineExecutionId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "PipelineExecutionNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

", + "exception":true + }, + "PipelineExecutionStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Succeeded", + "Superseded", + "Failed" + ] + }, + "PipelineExecutionSummary":{ + "type":"structure", + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the pipeline execution.

" + }, + "status":{ + "shape":"PipelineExecutionStatus", + "documentation":"

The status of the pipeline execution.

  • InProgress: The pipeline execution is currently running.

  • Succeeded: The pipeline execution was completed successfully.

  • Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution advanced and continued through the pipeline instead.

  • Failed: The pipeline execution was not completed successfully.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the pipeline execution began, in timestamp format.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The date and time of the last change to the pipeline execution, in timestamp format.

" + }, + "sourceRevisions":{ + "shape":"SourceRevisionList", + "documentation":"

A list of the source artifact revisions that initiated a pipeline execution.

" + }, + "trigger":{ + "shape":"ExecutionTrigger", + "documentation":"

The interaction or event that started a pipeline execution, such as automated change detection or a StartPipelineExecution API call.

" + } + }, + "documentation":"

Summary information about a pipeline execution.

" + }, + "PipelineExecutionSummaryList":{ + "type":"list", + "member":{"shape":"PipelineExecutionSummary"} + }, + "PipelineList":{ + "type":"list", + "member":{"shape":"PipelineSummary"} + }, + "PipelineMetadata":{ + "type":"structure", + "members":{ + "pipelineArn":{ + "shape":"PipelineArn", + "documentation":"

The Amazon Resource Name (ARN) of the pipeline.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time the pipeline was created, in timestamp format.

" + }, + "updated":{ + "shape":"Timestamp", + "documentation":"

The date and time the pipeline was last updated, in timestamp format.

" + } + }, + "documentation":"

Information about a pipeline.

" + }, + "PipelineName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9.@\\-_]+" + }, + "PipelineNameInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified pipeline name is already in use.

", + "exception":true + }, + "PipelineNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pipeline was specified in an invalid format or cannot be found.

", + "exception":true + }, + "PipelineStageDeclarationList":{ + "type":"list", + "member":{"shape":"StageDeclaration"} + }, + "PipelineSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline.

" + }, + "version":{ + "shape":"PipelineVersion", + "documentation":"

The version number of the pipeline.

" + }, + "created":{ + "shape":"Timestamp", + "documentation":"

The date and time the pipeline was created, in timestamp format.

" + }, + "updated":{ + "shape":"Timestamp", + "documentation":"

The date and time of the last update to the pipeline, in timestamp format.

" + } + }, + "documentation":"

Returns a summary of a pipeline.

" + }, + "PipelineVersion":{ + "type":"integer", + "min":1 + }, + "PipelineVersionNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The pipeline version was specified in an invalid format or cannot be found.

", + "exception":true + }, + "PollForJobsInput":{ + "type":"structure", + "required":["actionTypeId"], + "members":{ + "actionTypeId":{ + "shape":"ActionTypeId", + "documentation":"

Represents information about an action type.

" + }, + "maxBatchSize":{ + "shape":"MaxBatchSize", + "documentation":"

The maximum number of jobs to return in a poll for jobs call.

" + }, + "queryParam":{ + "shape":"QueryParamMap", + "documentation":"

A map of property names and values. For an action type with no queryable properties, this value must be null or an empty map. For an action type with a queryable property, you must supply that property as a key in the map. Only jobs whose action configuration matches the mapped value are returned.

" + } + }, + "documentation":"

Represents the input of a PollForJobs action.

" + }, + "PollForJobsOutput":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"JobList", + "documentation":"

Information about the jobs to take action on.

" + } + }, + "documentation":"

Represents the output of a PollForJobs action.

" + }, + "PollForThirdPartyJobsInput":{ + "type":"structure", + "required":["actionTypeId"], + "members":{ + "actionTypeId":{ + "shape":"ActionTypeId", + "documentation":"

Represents information about an action type.

" + }, + "maxBatchSize":{ + "shape":"MaxBatchSize", + "documentation":"

The maximum number of jobs to return in a poll for jobs call.

" + } + }, + "documentation":"

Represents the input of a PollForThirdPartyJobs action.

" + }, + "PollForThirdPartyJobsOutput":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"ThirdPartyJobList", + "documentation":"

Information about the jobs to take action on.

" + } + }, + "documentation":"

Represents the output of a PollForThirdPartyJobs action.

" + }, + "PutActionRevisionInput":{ + "type":"structure", + "required":[ + "pipelineName", + "stageName", + "actionName", + "actionRevision" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline that starts processing the revision to the source.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage that contains the action that acts on the revision.

" + }, + "actionName":{ + "shape":"ActionName", + "documentation":"

The name of the action that processes the revision.

" + }, + "actionRevision":{ + "shape":"ActionRevision", + "documentation":"

Represents information about the version (or revision) of an action.

" + } + }, + "documentation":"

Represents the input of a PutActionRevision action.

" + }, + "PutActionRevisionOutput":{ + "type":"structure", + "members":{ + "newRevision":{ + "shape":"Boolean", + "documentation":"

Indicates whether the artifact revision was previously used in an execution of the specified pipeline.

" + }, + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the current workflow state of the pipeline.

" + } + }, + "documentation":"

Represents the output of a PutActionRevision action.

" + }, + "PutApprovalResultInput":{ + "type":"structure", + "required":[ + "pipelineName", + "stageName", + "actionName", + "result", + "token" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline that contains the action.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage that contains the action.

" + }, + "actionName":{ + "shape":"ActionName", + "documentation":"

The name of the action for which approval is requested.

" + }, + "result":{ + "shape":"ApprovalResult", + "documentation":"

Represents information about the result of the approval request.

" + }, + "token":{ + "shape":"ApprovalToken", + "documentation":"

The system-generated token used to identify a unique approval request. The token for each open approval request can be obtained using the GetPipelineState action. It is used to validate that the approval request corresponding to this token is still valid.

" + } + }, + "documentation":"

Represents the input of a PutApprovalResult action.

" + }, + "PutApprovalResultOutput":{ + "type":"structure", + "members":{ + "approvedAt":{ + "shape":"Timestamp", + "documentation":"

The timestamp showing when the approval or rejection was submitted.

" + } + }, + "documentation":"

Represents the output of a PutApprovalResult action.

" + }, + "PutJobFailureResultInput":{ + "type":"structure", + "required":[ + "jobId", + "failureDetails" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

" + }, + "failureDetails":{ + "shape":"FailureDetails", + "documentation":"

The details about the failure of a job.

" + } + }, + "documentation":"

Represents the input of a PutJobFailureResult action.

" + }, + "PutJobSuccessResultInput":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

" + }, + "currentRevision":{ + "shape":"CurrentRevision", + "documentation":"

The ID of the current revision of the artifact successfully worked on by the job.

" + }, + "continuationToken":{ + "shape":"ContinuationToken", + "documentation":"

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

" + }, + "executionDetails":{ + "shape":"ExecutionDetails", + "documentation":"

The execution details of the successful job, such as the actions taken by the job worker.

" + } + }, + "documentation":"

Represents the input of a PutJobSuccessResult action.

" + }, + "PutThirdPartyJobFailureResultInput":{ + "type":"structure", + "required":[ + "jobId", + "clientToken", + "failureDetails" + ], + "members":{ + "jobId":{ + "shape":"ThirdPartyJobId", + "documentation":"

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" + }, + "failureDetails":{ + "shape":"FailureDetails", + "documentation":"

Represents information about failure details.

" + } + }, + "documentation":"

Represents the input of a PutThirdPartyJobFailureResult action.

" + }, + "PutThirdPartyJobSuccessResultInput":{ + "type":"structure", + "required":[ + "jobId", + "clientToken" + ], + "members":{ + "jobId":{ + "shape":"ThirdPartyJobId", + "documentation":"

The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

" + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" + }, + "currentRevision":{ + "shape":"CurrentRevision", + "documentation":"

Represents information about a current revision.

" + }, + "continuationToken":{ + "shape":"ContinuationToken", + "documentation":"

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

" + }, + "executionDetails":{ + "shape":"ExecutionDetails", + "documentation":"

The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.

" + } + }, + "documentation":"

Represents the input of a PutThirdPartyJobSuccessResult action.

" + }, + "PutWebhookInput":{ + "type":"structure", + "required":["webhook"], + "members":{ + "webhook":{ + "shape":"WebhookDefinition", + "documentation":"

The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags for the webhook.

" + } + } + }, + "PutWebhookOutput":{ + "type":"structure", + "members":{ + "webhook":{ + "shape":"ListWebhookItem", + "documentation":"

The detail returned from creating the webhook, such as the webhook name, webhook URL, and webhook ARN.

" + } + } + }, + "QueryParamMap":{ + "type":"map", + "key":{"shape":"ActionConfigurationKey"}, + "value":{"shape":"ActionConfigurationQueryableValue"}, + "max":1, + "min":0 + }, + "RegisterWebhookWithThirdPartyInput":{ + "type":"structure", + "members":{ + "webhookName":{ + "shape":"WebhookName", + "documentation":"

The name of an existing webhook created with PutWebhook to register with a supported third party.

" + } + } + }, + "RegisterWebhookWithThirdPartyOutput":{ + "type":"structure", + "members":{ + } + }, + "ResourceArn":{ + "type":"string", + "pattern":"arn:aws(-[\\w]+)*:codepipeline:.+:[0-9]{12}:.+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource was specified in an invalid format.

", + "exception":true + }, + "RetryStageExecutionInput":{ + "type":"structure", + "required":[ + "pipelineName", + "stageName", + "pipelineExecutionId", + "retryMode" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline that contains the failed stage.

" + }, + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the failed stage to be retried.

" + }, + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState action to retrieve the current pipelineExecutionId of the failed stage

" + }, + "retryMode":{ + "shape":"StageRetryMode", + "documentation":"

The scope of the retry attempt. Currently, the only supported value is FAILED_ACTIONS.

" + } + }, + "documentation":"

Represents the input of a RetryStageExecution action.

" + }, + "RetryStageExecutionOutput":{ + "type":"structure", + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the current workflow execution in the failed stage.

" + } + }, + "documentation":"

Represents the output of a RetryStageExecution action.

" + }, + "Revision":{ + "type":"string", + "max":1500, + "min":1 + }, + "RevisionChangeIdentifier":{ + "type":"string", + "max":100, + "min":1 + }, + "RevisionSummary":{ + "type":"string", + "max":2048, + "min":1 + }, + "RoleArn":{ + "type":"string", + "max":1024, + "pattern":"arn:aws(-[\\w]+)*:iam::[0-9]{12}:role/.*" + }, + "S3ArtifactLocation":{ + "type":"structure", + "required":[ + "bucketName", + "objectKey" + ], + "members":{ + "bucketName":{ + "shape":"S3BucketName", + "documentation":"

The name of the Amazon S3 bucket.

" + }, + "objectKey":{ + "shape":"S3ObjectKey", + "documentation":"

The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.

" + } + }, + "documentation":"

The location of the Amazon S3 bucket that contains a revision.

" + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":3 + }, + "S3BucketName":{"type":"string"}, + "S3Key":{ + "type":"string", + "max":100, + "min":1 + }, + "S3Location":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"S3Bucket", + "documentation":"

The Amazon S3 artifact bucket for an action's artifacts.

" + }, + "key":{ + "shape":"S3Key", + "documentation":"

The artifact name.

" + } + }, + "documentation":"

The Amazon S3 artifact location for an action's artifacts.

" + }, + "S3ObjectKey":{"type":"string"}, + "SecretAccessKey":{"type":"string"}, + "SessionToken":{"type":"string"}, + "SourceRevision":{ + "type":"structure", + "required":["actionName"], + "members":{ + "actionName":{ + "shape":"ActionName", + "documentation":"

The name of the action that processed the revision to the source artifact.

" + }, + "revisionId":{ + "shape":"Revision", + "documentation":"

The system-generated unique ID that identifies the revision number of the artifact.

" + }, + "revisionSummary":{ + "shape":"RevisionSummary", + "documentation":"

Summary information about the most recent revision of the artifact. For GitHub and AWS CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-provided content of a codepipeline-artifact-revision-summary key specified in the object metadata.

" + }, + "revisionUrl":{ + "shape":"Url", + "documentation":"

The commit ID for the artifact revision. For artifacts stored in GitHub or AWS CodeCommit repositories, the commit ID is linked to a commit details page.

" + } + }, + "documentation":"

Information about the version (or revision) of a source artifact that initiated a pipeline execution.

" + }, + "SourceRevisionList":{ + "type":"list", + "member":{"shape":"SourceRevision"} + }, + "StageActionDeclarationList":{ + "type":"list", + "member":{"shape":"ActionDeclaration"} + }, + "StageBlockerDeclarationList":{ + "type":"list", + "member":{"shape":"BlockerDeclaration"} + }, + "StageContext":{ + "type":"structure", + "members":{ + "name":{ + "shape":"StageName", + "documentation":"

The name of the stage.

" + } + }, + "documentation":"

Represents information about a stage to a job worker.

" + }, + "StageDeclaration":{ + "type":"structure", + "required":[ + "name", + "actions" + ], + "members":{ + "name":{ + "shape":"StageName", + "documentation":"

The name of the stage.

" + }, + "blockers":{ + "shape":"StageBlockerDeclarationList", + "documentation":"

Reserved for future use.

" + }, + "actions":{ + "shape":"StageActionDeclarationList", + "documentation":"

The actions included in a stage.

" + } + }, + "documentation":"

Represents information about a stage and its definition.

" + }, + "StageExecution":{ + "type":"structure", + "required":[ + "pipelineExecutionId", + "status" + ], + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The ID of the pipeline execution associated with the stage.

" + }, + "status":{ + "shape":"StageExecutionStatus", + "documentation":"

The status of the stage, or for a completed stage, the last status of the stage.

" + } + }, + "documentation":"

Represents information about the run of a stage.

" + }, + "StageExecutionStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Failed", + "Succeeded" + ] + }, + "StageName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9.@\\-_]+" + }, + "StageNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The stage was specified in an invalid format or cannot be found.

", + "exception":true + }, + "StageNotRetryableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Unable to retry. The pipeline structure or stage state might have changed while actions awaited retry, or the stage contains no failed actions.

", + "exception":true + }, + "StageRetryMode":{ + "type":"string", + "enum":["FAILED_ACTIONS"] + }, + "StageState":{ + "type":"structure", + "members":{ + "stageName":{ + "shape":"StageName", + "documentation":"

The name of the stage.

" + }, + "inboundTransitionState":{ + "shape":"TransitionState", + "documentation":"

The state of the inbound transition, which is either enabled or disabled.

" + }, + "actionStates":{ + "shape":"ActionStateList", + "documentation":"

The state of the stage.

" + }, + "latestExecution":{ + "shape":"StageExecution", + "documentation":"

Information about the latest execution in the stage, including its ID and status.

" + } + }, + "documentation":"

Represents information about the state of the stage.

" + }, + "StageStateList":{ + "type":"list", + "member":{"shape":"StageState"} + }, + "StageTransitionType":{ + "type":"string", + "enum":[ + "Inbound", + "Outbound" + ] + }, + "StartPipelineExecutionInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline to start.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The system-generated unique ID used to identify a unique execution request.

", + "idempotencyToken":true + } + }, + "documentation":"

Represents the input of a StartPipelineExecution action.

" + }, + "StartPipelineExecutionOutput":{ + "type":"structure", + "members":{ + "pipelineExecutionId":{ + "shape":"PipelineExecutionId", + "documentation":"

The unique system-generated ID of the pipeline execution that was started.

" + } + }, + "documentation":"

Represents the output of a StartPipelineExecution action.

" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The tag's key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

A tag is a key-value pair that is used to manage the resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource you want to add tags to.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags you want to modify or add to the resource.

" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThirdPartyJob":{ + "type":"structure", + "members":{ + "clientId":{ + "shape":"ClientId", + "documentation":"

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The identifier used to identify the job in AWS CodePipeline.

" + } + }, + "documentation":"

A response to a PollForThirdPartyJobs request returned by AWS CodePipeline when there is a job to be worked on by a partner action.

" + }, + "ThirdPartyJobData":{ + "type":"structure", + "members":{ + "actionTypeId":{ + "shape":"ActionTypeId", + "documentation":"

Represents information about an action type.

" + }, + "actionConfiguration":{ + "shape":"ActionConfiguration", + "documentation":"

Represents information about an action configuration.

" + }, + "pipelineContext":{ + "shape":"PipelineContext", + "documentation":"

Represents information about a pipeline to a job worker.

Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

" + }, + "inputArtifacts":{ + "shape":"ArtifactList", + "documentation":"

The name of the artifact that is worked on by the action, if any. This name might be system-generated, such as \"MyApp\", or it might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.

" + }, + "outputArtifacts":{ + "shape":"ArtifactList", + "documentation":"

The name of the artifact that is the result of the action, if any. This name might be system-generated, such as \"MyBuiltApp\", or it might be defined by the user when the action is created.

" + }, + "artifactCredentials":{ + "shape":"AWSSessionCredentials", + "documentation":"

Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.

" + }, + "continuationToken":{ + "shape":"ContinuationToken", + "documentation":"

A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires to continue the job asynchronously.

" + }, + "encryptionKey":{ + "shape":"EncryptionKey", + "documentation":"

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

" + } + }, + "documentation":"

Represents information about the job data for a partner action.

" + }, + "ThirdPartyJobDetails":{ + "type":"structure", + "members":{ + "id":{ + "shape":"ThirdPartyJobId", + "documentation":"

The identifier used to identify the job details in AWS CodePipeline.

" + }, + "data":{ + "shape":"ThirdPartyJobData", + "documentation":"

The data to be returned by the third party job worker.

" + }, + "nonce":{ + "shape":"Nonce", + "documentation":"

A system-generated random number that AWS CodePipeline uses to ensure that the job is being worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.

" + } + }, + "documentation":"

The details of a job sent in response to a GetThirdPartyJobDetails request.

" + }, + "ThirdPartyJobId":{ + "type":"string", + "max":512, + "min":1 + }, + "ThirdPartyJobList":{ + "type":"list", + "member":{"shape":"ThirdPartyJob"} + }, + "Time":{"type":"timestamp"}, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The tags limit for a resource has been exceeded.

", + "exception":true + }, + "TransitionState":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Enabled", + "documentation":"

Whether the transition between stages is enabled (true) or disabled (false).

" + }, + "lastChangedBy":{ + "shape":"LastChangedBy", + "documentation":"

The ID of the user who last changed the transition state.

" + }, + "lastChangedAt":{ + "shape":"LastChangedAt", + "documentation":"

The timestamp when the transition state was last changed.

" + }, + "disabledReason":{ + "shape":"DisabledReason", + "documentation":"

The user-specified reason why the transition between two stages of a pipeline was disabled.

" + } + }, + "documentation":"

Represents information about the state of transitions between one stage and another stage.

" + }, + "TriggerDetail":{ + "type":"string", + "max":1024, + "min":0 + }, + "TriggerType":{ + "type":"string", + "enum":[ + "CreatePipeline", + "StartPipelineExecution", + "PollForSourceChanges", + "Webhook", + "CloudWatchEvent", + "PutActionRevision" + ] + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to remove tags from.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The list of keys for the tags to be removed from the resource.

" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdatePipelineInput":{ + "type":"structure", + "required":["pipeline"], + "members":{ + "pipeline":{ + "shape":"PipelineDeclaration", + "documentation":"

The name of the pipeline to be updated.

" + } + }, + "documentation":"

Represents the input of an UpdatePipeline action.

" + }, + "UpdatePipelineOutput":{ + "type":"structure", + "members":{ + "pipeline":{ + "shape":"PipelineDeclaration", + "documentation":"

The structure of the updated pipeline.

" + } + }, + "documentation":"

Represents the output of an UpdatePipeline action.

" + }, + "Url":{ + "type":"string", + "max":2048, + "min":1 + }, + "UrlTemplate":{ + "type":"string", + "max":2048, + "min":1 + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The validation was specified in an invalid format.

", + "exception":true + }, + "Version":{ + "type":"string", + "max":9, + "min":1, + "pattern":"[0-9A-Za-z_-]+" + }, + "WebhookArn":{"type":"string"}, + "WebhookAuthConfiguration":{ + "type":"structure", + "members":{ + "AllowedIPRange":{ + "shape":"WebhookAuthConfigurationAllowedIPRange", + "documentation":"

The property used to configure acceptance of webhooks in an IP address range. For IP, only the AllowedIPRange property must be set. This property must be set to a valid CIDR range.

" + }, + "SecretToken":{ + "shape":"WebhookAuthConfigurationSecretToken", + "documentation":"

The property used to configure GitHub authentication. For GITHUB_HMAC, only the SecretToken property must be set.

" + } + }, + "documentation":"

The authentication applied to incoming webhook trigger requests.

" + }, + "WebhookAuthConfigurationAllowedIPRange":{ + "type":"string", + "max":100, + "min":1 + }, + "WebhookAuthConfigurationSecretToken":{ + "type":"string", + "max":100, + "min":1 + }, + "WebhookAuthenticationType":{ + "type":"string", + "enum":[ + "GITHUB_HMAC", + "IP", + "UNAUTHENTICATED" + ] + }, + "WebhookDefinition":{ + "type":"structure", + "required":[ + "name", + "targetPipeline", + "targetAction", + "filters", + "authentication", + "authenticationConfiguration" + ], + "members":{ + "name":{ + "shape":"WebhookName", + "documentation":"

The name of the webhook.

" + }, + "targetPipeline":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline you want to connect to the webhook.

" + }, + "targetAction":{ + "shape":"ActionName", + "documentation":"

The name of the action in a pipeline you want to connect to the webhook. The action must be from the source (first) stage of the pipeline.

" + }, + "filters":{ + "shape":"WebhookFilters", + "documentation":"

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All defined rules must pass for the request to be accepted and the pipeline started.

" + }, + "authentication":{ + "shape":"WebhookAuthenticationType", + "documentation":"

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks on the GitHub Developer website.

  • IP rejects webhooks trigger requests unless they originate from an IP address in the IP range whitelisted in the authentication configuration.

  • UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

" + }, + "authenticationConfiguration":{ + "shape":"WebhookAuthConfiguration", + "documentation":"

Properties that configure the authentication applied to incoming webhook trigger requests. The required properties depend on the authentication type. For GITHUB_HMAC, only the SecretToken property must be set. For IP, only the AllowedIPRange property must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

" + } + }, + "documentation":"

Represents information about a webhook and its definition.

" + }, + "WebhookErrorCode":{"type":"string"}, + "WebhookErrorMessage":{"type":"string"}, + "WebhookFilterRule":{ + "type":"structure", + "required":["jsonPath"], + "members":{ + "jsonPath":{ + "shape":"JsonPath", + "documentation":"

A JsonPath expression that is applied to the body/payload of the webhook. The value selected by the JsonPath expression must match the value specified in the MatchEquals field. Otherwise, the request is ignored. For more information, see Java JsonPath implementation in GitHub.

" + }, + "matchEquals":{ + "shape":"MatchEquals", + "documentation":"

The value selected by the JsonPath expression must match what is supplied in the MatchEquals field. Otherwise, the request is ignored. Properties from the target action configuration can be included as placeholders in this value by surrounding the action configuration key with curly brackets. For example, if the value supplied here is \"refs/heads/{Branch}\" and the target action has an action configuration property called \"Branch\" with a value of \"master\", the MatchEquals value is evaluated as \"refs/heads/master\". For a list of action configuration properties for built-in action types, see Pipeline Structure Reference Action Requirements.

" + } + }, + "documentation":"

The event criteria that specify when a webhook notification is sent to your URL.

" + }, + "WebhookFilters":{ + "type":"list", + "member":{"shape":"WebhookFilterRule"}, + "max":5 + }, + "WebhookLastTriggered":{"type":"timestamp"}, + "WebhookList":{ + "type":"list", + "member":{"shape":"ListWebhookItem"} + }, + "WebhookName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9.@\\-_]+" + }, + "WebhookNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified webhook was entered in an invalid format or cannot be found.

", + "exception":true + }, + "WebhookUrl":{ + "type":"string", + "max":1000, + "min":1 + } + }, + "documentation":"AWS CodePipeline

Overview

This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and data types for AWS CodePipeline. Some functionality for your pipeline can only be configured through the API. For more information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists of stages, actions, and transitions.

You can work with pipelines by calling:

  • CreatePipeline, which creates a uniquely named pipeline.

  • DeletePipeline, which deletes the specified pipeline.

  • GetPipeline, which returns information about the pipeline structure and pipeline metadata, including the pipeline Amazon Resource Name (ARN).

  • GetPipelineExecution, which returns information about a specific execution of a pipeline.

  • GetPipelineState, which returns information about the current state of the stages and actions of a pipeline.

  • ListActionExecutions, which returns action-level details for past executions. The details include full stage and action-level details, including individual action duration, status, any errors that occurred during the execution, and input and output artifact location details.

  • ListPipelines, which gets a summary of all of the pipelines associated with your account.

  • ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.

  • StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.

  • UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages. Each stage contains one or more actions that must complete before the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at that stage and remains stopped until either a new version of an artifact appears in the source location, or a user takes action to rerun the most recent artifact through the pipeline. You can call GetPipelineState, which displays the status of a pipeline, including the status of stages in the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the stages of that pipeline. For more information about the structure of stages and actions, see AWS CodePipeline Pipeline Structure Reference.

Pipeline stages include actions that are categorized into categories such as source or build actions performed in a stage of a pipeline. For example, you can use a source action to import artifacts into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly in most cases, but you do define and interact with actions when working with pipeline operations such as CreatePipeline and GetPipelineState. Valid action categories are:

  • Source

  • Build

  • Test

  • Deploy

  • Approval

  • Invoke

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next in a pipeline after the actions in one stage complete.

You can work with transitions by calling:

Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with AWS CodePipeline, the expected sequence varies from the standard API user. To integrate with AWS CodePipeline, developers need to work with the following items:

Jobs, which are instances of an action. For example, a job for a source action might import a revision of an artifact from a source.

You can work with jobs by calling:

Third party jobs, which are instances of an action created by a partner action and integrated into AWS CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:

" +} diff --git a/aws/dist/botocore/data/codestar-notifications/2019-10-15/paginators-1.json b/aws/dist/botocore/data/codestar-notifications/2019-10-15/paginators-1.json new file mode 100644 index 00000000..95018141 --- /dev/null +++ b/aws/dist/botocore/data/codestar-notifications/2019-10-15/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListEventTypes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EventTypes" + }, + "ListNotificationRules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NotificationRules" + }, + "ListTargets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Targets" + } + } +} diff --git a/aws/dist/botocore/data/codestar-notifications/2019-10-15/service-2.json b/aws/dist/botocore/data/codestar-notifications/2019-10-15/service-2.json new file mode 100644 index 00000000..df94d9bc --- /dev/null +++ b/aws/dist/botocore/data/codestar-notifications/2019-10-15/service-2.json @@ -0,0 +1,973 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-10-15", + "endpointPrefix":"codestar-notifications", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS CodeStar Notifications", + "serviceId":"codestar notifications", + "signatureVersion":"v4", + "signingName":"codestar-notifications", + "uid":"codestar-notifications-2019-10-15" + }, + "operations":{ + "CreateNotificationRule":{ + "name":"CreateNotificationRule", + "http":{ + "method":"POST", + "requestUri":"/createNotificationRule" + }, + "input":{"shape":"CreateNotificationRuleRequest"}, + "output":{"shape":"CreateNotificationRuleResult"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConfigurationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a notification rule for a resource. The rule specifies the events you want notifications about and the targets (such as SNS topics) where you want to receive them.

" + }, + "DeleteNotificationRule":{ + "name":"DeleteNotificationRule", + "http":{ + "method":"POST", + "requestUri":"/deleteNotificationRule" + }, + "input":{"shape":"DeleteNotificationRuleRequest"}, + "output":{"shape":"DeleteNotificationRuleResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a notification rule for a resource.

" + }, + "DeleteTarget":{ + "name":"DeleteTarget", + "http":{ + "method":"POST", + "requestUri":"/deleteTarget" + }, + "input":{"shape":"DeleteTargetRequest"}, + "output":{"shape":"DeleteTargetResult"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Deletes a specified target for notifications.

" + }, + "DescribeNotificationRule":{ + "name":"DescribeNotificationRule", + "http":{ + "method":"POST", + "requestUri":"/describeNotificationRule" + }, + "input":{"shape":"DescribeNotificationRuleRequest"}, + "output":{"shape":"DescribeNotificationRuleResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns information about a specified notification rule.

" + }, + "ListEventTypes":{ + "name":"ListEventTypes", + "http":{ + "method":"POST", + "requestUri":"/listEventTypes" + }, + "input":{"shape":"ListEventTypesRequest"}, + "output":{"shape":"ListEventTypesResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns information about the event types available for configuring notifications.

" + }, + "ListNotificationRules":{ + "name":"ListNotificationRules", + "http":{ + "method":"POST", + "requestUri":"/listNotificationRules" + }, + "input":{"shape":"ListNotificationRulesRequest"}, + "output":{"shape":"ListNotificationRulesResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns a list of the notification rules for an AWS account.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/listTagsForResource" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns a list of the tags associated with a notification rule.

" + }, + "ListTargets":{ + "name":"ListTargets", + "http":{ + "method":"POST", + "requestUri":"/listTargets" + }, + "input":{"shape":"ListTargetsRequest"}, + "output":{"shape":"ListTargetsResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns a list of the notification rule targets for an AWS account.

" + }, + "Subscribe":{ + "name":"Subscribe", + "http":{ + "method":"POST", + "requestUri":"/subscribe" + }, + "input":{"shape":"SubscribeRequest"}, + "output":{"shape":"SubscribeResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates an association between a notification rule and an SNS topic so that the associated target can receive notifications when the events described in the rule are triggered.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tagResource" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Associates a set of provided tags with a notification rule.

" + }, + "Unsubscribe":{ + "name":"Unsubscribe", + "http":{ + "method":"POST", + "requestUri":"/unsubscribe" + }, + "input":{"shape":"UnsubscribeRequest"}, + "output":{"shape":"UnsubscribeResult"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Removes an association between a notification rule and an Amazon SNS topic so that subscribers to that topic stop receiving notifications when the events described in the rule are triggered.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/untagResource" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes the association between one or more provided tags and a notification rule.

" + }, + "UpdateNotificationRule":{ + "name":"UpdateNotificationRule", + "http":{ + "method":"POST", + "requestUri":"/updateNotificationRule" + }, + "input":{"shape":"UpdateNotificationRuleRequest"}, + "output":{"shape":"UpdateNotificationRuleResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a notification rule for a resource. You can change the events that trigger the notification rule, the status of the rule, and the targets that receive the notifications.

To add or remove tags for a notification rule, you must use TagResource and UntagResource.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

AWS CodeStar Notifications can't create the notification rule because you do not have sufficient permissions.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ClientRequestToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[\\w:/-]+$" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

AWS CodeStar Notifications can't complete the request because the resource is being modified by another process. Wait a few minutes and try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

Some or all of the configuration is incomplete, missing, or not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateNotificationRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "EventTypeIds", + "Resource", + "Targets", + "DetailType" + ], + "members":{ + "Name":{ + "shape":"NotificationRuleName", + "documentation":"

The name for the notification rule. Notifictaion rule names must be unique in your AWS account.

" + }, + "EventTypeIds":{ + "shape":"EventTypeIds", + "documentation":"

A list of event types associated with this notification rule. For a list of allowed events, see EventTypeSummary.

" + }, + "Resource":{ + "shape":"NotificationRuleResource", + "documentation":"

The Amazon Resource Name (ARN) of the resource to associate with the notification rule. Supported resources include pipelines in AWS CodePipeline, repositories in AWS CodeCommit, and build projects in AWS CodeBuild.

" + }, + "Targets":{ + "shape":"Targets", + "documentation":"

A list of Amazon Resource Names (ARNs) of SNS topics to associate with the notification rule.

" + }, + "DetailType":{ + "shape":"DetailType", + "documentation":"

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request with the same parameters is received and a token is included, the request returns information about the initial request that used that token.

The AWS SDKs prepopulate client request tokens. If you are using an AWS SDK, an idempotency token is created for you.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags to apply to this notification rule. Key names cannot start with \"aws\".

" + }, + "Status":{ + "shape":"NotificationRuleStatus", + "documentation":"

The status of the notification rule. The default value is ENABLED. If the status is set to DISABLED, notifications aren't sent for the notification rule.

" + } + } + }, + "CreateNotificationRuleResult":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + } + } + }, + "CreatedTimestamp":{"type":"timestamp"}, + "DeleteNotificationRuleRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule you want to delete.

" + } + } + }, + "DeleteNotificationRuleResult":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the deleted notification rule.

" + } + } + }, + "DeleteTargetRequest":{ + "type":"structure", + "required":["TargetAddress"], + "members":{ + "TargetAddress":{ + "shape":"TargetAddress", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic to delete.

" + }, + "ForceUnsubscribeAll":{ + "shape":"ForceUnsubscribeAll", + "documentation":"

A Boolean value that can be used to delete all associations with this SNS topic. The default value is FALSE. If set to TRUE, all associations between that target and every notification rule in your AWS account are deleted.

" + } + } + }, + "DeleteTargetResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeNotificationRuleRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + } + } + }, + "DescribeNotificationRuleResult":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + }, + "Name":{ + "shape":"NotificationRuleName", + "documentation":"

The name of the notification rule.

" + }, + "EventTypes":{ + "shape":"EventTypeBatch", + "documentation":"

A list of the event types associated with the notification rule.

" + }, + "Resource":{ + "shape":"NotificationRuleResource", + "documentation":"

The Amazon Resource Name (ARN) of the resource associated with the notification rule.

" + }, + "Targets":{ + "shape":"TargetsBatch", + "documentation":"

A list of the SNS topics associated with the notification rule.

" + }, + "DetailType":{ + "shape":"DetailType", + "documentation":"

The level of detail included in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" + }, + "CreatedBy":{ + "shape":"NotificationRuleCreatedBy", + "documentation":"

The name or email alias of the person who created the notification rule.

" + }, + "Status":{ + "shape":"NotificationRuleStatus", + "documentation":"

The status of the notification rule. Valid statuses are on (sending notifications) or off (not sending notifications).

" + }, + "CreatedTimestamp":{ + "shape":"CreatedTimestamp", + "documentation":"

The date and time the notification rule was created, in timestamp format.

" + }, + "LastModifiedTimestamp":{ + "shape":"LastModifiedTimestamp", + "documentation":"

The date and time the notification rule was most recently updated, in timestamp format.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags associated with the notification rule.

" + } + } + }, + "DetailType":{ + "type":"string", + "enum":[ + "BASIC", + "FULL" + ] + }, + "EventTypeBatch":{ + "type":"list", + "member":{"shape":"EventTypeSummary"} + }, + "EventTypeId":{ + "type":"string", + "max":200, + "min":1 + }, + "EventTypeIds":{ + "type":"list", + "member":{"shape":"EventTypeId"} + }, + "EventTypeName":{"type":"string"}, + "EventTypeSummary":{ + "type":"structure", + "members":{ + "EventTypeId":{ + "shape":"EventTypeId", + "documentation":"

The system-generated ID of the event.

" + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

The name of the service for which the event applies.

" + }, + "EventTypeName":{ + "shape":"EventTypeName", + "documentation":"

The name of the event.

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

The resource type of the event.

" + } + }, + "documentation":"

Returns information about an event that has triggered a notification rule.

" + }, + "ForceUnsubscribeAll":{"type":"boolean"}, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

The value for the enumeration token used in the request to return the next batch of the results is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LastModifiedTimestamp":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

One of the AWS CodeStar Notifications limits has been exceeded. Limits apply to accounts, notification rules, notifications, resources, and targets. For more information, see Limits.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListEventTypesFilter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ListEventTypesFilterName", + "documentation":"

The system-generated name of the filter type you want to filter by.

" + }, + "Value":{ + "shape":"ListEventTypesFilterValue", + "documentation":"

The name of the resource type (for example, pipeline) or service name (for example, CodePipeline) that you want to filter by.

" + } + }, + "documentation":"

Information about a filter to apply to the list of returned event types. You can filter by resource type or service name.

" + }, + "ListEventTypesFilterName":{ + "type":"string", + "enum":[ + "RESOURCE_TYPE", + "SERVICE_NAME" + ] + }, + "ListEventTypesFilterValue":{"type":"string"}, + "ListEventTypesFilters":{ + "type":"list", + "member":{"shape":"ListEventTypesFilter"} + }, + "ListEventTypesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListEventTypesFilters", + "documentation":"

The filters to use to return information by service or resource type.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that, when provided in a request, returns the next batch of the results.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The default number is 50. The maximum number of results that can be returned is 100.

", + "box":true + } + } + }, + "ListEventTypesResult":{ + "type":"structure", + "members":{ + "EventTypes":{ + "shape":"EventTypeBatch", + "documentation":"

Information about each event, including service name, resource type, event ID, and event name.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, + "ListNotificationRulesFilter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ListNotificationRulesFilterName", + "documentation":"

The name of the attribute you want to use to filter the returned notification rules.

" + }, + "Value":{ + "shape":"ListNotificationRulesFilterValue", + "documentation":"

The value of the attribute you want to use to filter the returned notification rules. For example, if you specify filtering by RESOURCE in Name, you might specify the ARN of a pipeline in AWS CodePipeline for the value.

" + } + }, + "documentation":"

Information about a filter to apply to the list of returned notification rules. You can filter by event type, owner, resource, or target.

" + }, + "ListNotificationRulesFilterName":{ + "type":"string", + "enum":[ + "EVENT_TYPE_ID", + "CREATED_BY", + "RESOURCE", + "TARGET_ADDRESS" + ] + }, + "ListNotificationRulesFilterValue":{"type":"string"}, + "ListNotificationRulesFilters":{ + "type":"list", + "member":{"shape":"ListNotificationRulesFilter"} + }, + "ListNotificationRulesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListNotificationRulesFilters", + "documentation":"

The filters to use to return information by service or resource type. For valid values, see ListNotificationRulesFilter.

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that, when provided in a request, returns the next batch of the results.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

", + "box":true + } + } + }, + "ListNotificationRulesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + }, + "NotificationRules":{ + "shape":"NotificationRuleBatch", + "documentation":"

The list of notification rules for the AWS account, by Amazon Resource Name (ARN) and ID.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) for the notification rule.

" + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The tags associated with the notification rule.

" + } + } + }, + "ListTargetsFilter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ListTargetsFilterName", + "documentation":"

The name of the attribute you want to use to filter the returned targets.

" + }, + "Value":{ + "shape":"ListTargetsFilterValue", + "documentation":"

The value of the attribute you want to use to filter the returned targets. For example, if you specify SNS for the Target type, you could specify an Amazon Resource Name (ARN) for a topic as the value.

" + } + }, + "documentation":"

Information about a filter to apply to the list of returned targets. You can filter by target type, address, or status. For example, to filter results to notification rules that have active Amazon SNS topics as targets, you could specify a ListTargetsFilter Name as TargetType and a Value of SNS, and a Name of TARGET_STATUS and a Value of ACTIVE.

" + }, + "ListTargetsFilterName":{ + "type":"string", + "enum":[ + "TARGET_TYPE", + "TARGET_ADDRESS", + "TARGET_STATUS" + ] + }, + "ListTargetsFilterValue":{"type":"string"}, + "ListTargetsFilters":{ + "type":"list", + "member":{"shape":"ListTargetsFilter"} + }, + "ListTargetsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListTargetsFilters", + "documentation":"

The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.

A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that, when provided in a request, returns the next batch of the results.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

A non-negative integer used to limit the number of returned results. The maximum number of results that can be returned is 100.

", + "box":true + } + } + }, + "ListTargetsResult":{ + "type":"structure", + "members":{ + "Targets":{ + "shape":"TargetsBatch", + "documentation":"

The list of notification rule targets.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of results.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Message":{ + "type":"string", + "min":1 + }, + "NextToken":{ + "type":"string", + "pattern":"^[\\w/+=]+$" + }, + "NotificationRuleArn":{ + "type":"string", + "pattern":"^arn:aws[^:\\s]*:codestar-notifications:[^:\\s]+:\\d{12}:notificationrule\\/(.*\\S)?$" + }, + "NotificationRuleBatch":{ + "type":"list", + "member":{"shape":"NotificationRuleSummary"} + }, + "NotificationRuleCreatedBy":{ + "type":"string", + "min":1 + }, + "NotificationRuleId":{ + "type":"string", + "max":40, + "min":1 + }, + "NotificationRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9\\-_ ]+$", + "sensitive":true + }, + "NotificationRuleResource":{ + "type":"string", + "pattern":"^arn:aws[^:\\s]*:[^:\\s]*:[^:\\s]*:[0-9]{12}:[^\\s]+$" + }, + "NotificationRuleStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "NotificationRuleSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"NotificationRuleId", + "documentation":"

The unique ID of the notification rule.

" + }, + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + } + }, + "documentation":"

Information about a specified notification rule.

" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

A resource with the same name or ID already exists. Notification rule names must be unique in your AWS account.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

AWS CodeStar Notifications can't find a resource that matches the provided ARN.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceType":{ + "type":"string", + "min":1, + "pattern":"^([a-zA-Z0-9-])+$" + }, + "ServiceName":{"type":"string"}, + "SubscribeRequest":{ + "type":"structure", + "required":[ + "Arn", + "Target" + ], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule for which you want to create the association.

" + }, + "Target":{"shape":"Target"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

An enumeration token that, when provided in a request, returns the next batch of the results.

" + } + } + }, + "SubscribeResult":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule for which you have created assocations.

" + } + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "Tags" + ], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule to tag.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The list of tags to associate with the resource. Tag key names cannot start with \"aws\".

" + } + } + }, + "TagResourceResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The list of tags associated with the resource.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "Target":{ + "type":"structure", + "members":{ + "TargetType":{ + "shape":"TargetType", + "documentation":"

The target type. Can be an Amazon SNS topic.

" + }, + "TargetAddress":{ + "shape":"TargetAddress", + "documentation":"

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

" + } + }, + "documentation":"

Information about the SNS topics associated with a notification rule.

" + }, + "TargetAddress":{ + "type":"string", + "max":320, + "min":1, + "sensitive":true + }, + "TargetStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "UNREACHABLE", + "INACTIVE", + "DEACTIVATED" + ] + }, + "TargetSummary":{ + "type":"structure", + "members":{ + "TargetAddress":{ + "shape":"TargetAddress", + "documentation":"

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

" + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"

The type of the target (for example, SNS).

" + }, + "TargetStatus":{ + "shape":"TargetStatus", + "documentation":"

The status of the target.

" + } + }, + "documentation":"

Information about the targets specified for a notification rule.

" + }, + "TargetType":{ + "type":"string", + "pattern":"^[A-Za-z]+$" + }, + "Targets":{ + "type":"list", + "member":{"shape":"Target"}, + "max":10 + }, + "TargetsBatch":{ + "type":"list", + "member":{"shape":"TargetSummary"} + }, + "UnsubscribeRequest":{ + "type":"structure", + "required":[ + "Arn", + "TargetAddress" + ], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + }, + "TargetAddress":{ + "shape":"TargetAddress", + "documentation":"

The ARN of the SNS topic to unsubscribe from the notification rule.

" + } + } + }, + "UnsubscribeResult":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the the notification rule from which you have removed a subscription.

" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "TagKeys" + ], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule from which to remove the tags.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

The key names of the tags to remove.

" + } + } + }, + "UntagResourceResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateNotificationRuleRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"NotificationRuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the notification rule.

" + }, + "Name":{ + "shape":"NotificationRuleName", + "documentation":"

The name of the notification rule.

" + }, + "Status":{ + "shape":"NotificationRuleStatus", + "documentation":"

The status of the notification rule. Valid statuses include enabled (sending notifications) or disabled (not sending notifications).

" + }, + "EventTypeIds":{ + "shape":"EventTypeIds", + "documentation":"

A list of event types associated with this notification rule.

" + }, + "Targets":{ + "shape":"Targets", + "documentation":"

The address and type of the targets to receive notifications from this notification rule.

" + }, + "DetailType":{ + "shape":"DetailType", + "documentation":"

The level of detail to include in the notifications for this resource. BASIC will include only the contents of the event as it would appear in AWS CloudWatch. FULL will include any supplemental information provided by AWS CodeStar Notifications and/or the service for the resource for which the notification is created.

" + } + } + }, + "UpdateNotificationRuleResult":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

One or more parameter values are not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + } + }, + "documentation":"

This AWS CodeStar Notifications API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Notifications API. You can use the AWS CodeStar Notifications API to work with the following objects:

Notification rules, by calling the following:

Targets, by calling the following:

  • DeleteTarget, which removes a notification rule target (SNS topic) from a notification rule.

  • ListTargets, which lists the targets associated with a notification rule.

Events, by calling the following:

  • ListEventTypes, which lists the event types you can include in a notification rule.

Tags, by calling the following:

  • ListTagsForResource, which lists the tags already associated with a notification rule in your account.

  • TagResource, which associates a tag you provide with a notification rule in your account.

  • UntagResource, which removes a tag from a notification rule in your account.

For information about how to use AWS CodeStar Notifications, see link in the CodeStarNotifications User Guide.

" +} diff --git a/aws/dist/botocore/data/codestar/2017-04-19/paginators-1.json b/aws/dist/botocore/data/codestar/2017-04-19/paginators-1.json new file mode 100644 index 00000000..d0c91820 --- /dev/null +++ b/aws/dist/botocore/data/codestar/2017-04-19/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListProjects": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "projects" + }, + "ListResources": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resources" + }, + "ListTeamMembers": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "teamMembers" + }, + "ListUserProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "userProfiles" + } + } +} diff --git a/aws/dist/botocore/data/codestar/2017-04-19/service-2.json b/aws/dist/botocore/data/codestar/2017-04-19/service-2.json new file mode 100644 index 00000000..fb0e1a56 --- /dev/null +++ b/aws/dist/botocore/data/codestar/2017-04-19/service-2.json @@ -0,0 +1,1456 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-04-19", + "endpointPrefix":"codestar", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"CodeStar", + "serviceFullName":"AWS CodeStar", + "serviceId":"CodeStar", + "signatureVersion":"v4", + "targetPrefix":"CodeStar_20170419", + "uid":"codestar-2017-04-19" + }, + "operations":{ + "AssociateTeamMember":{ + "name":"AssociateTeamMember", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateTeamMemberRequest"}, + "output":{"shape":"AssociateTeamMemberResult"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ProjectNotFoundException"}, + {"shape":"TeamMemberAlreadyAssociatedException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidServiceRoleException"}, + {"shape":"ProjectConfigurationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Adds an IAM user to the team for an AWS CodeStar project.

" + }, + "CreateProject":{ + "name":"CreateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProjectRequest"}, + "output":{"shape":"CreateProjectResult"}, + "errors":[ + {"shape":"ProjectAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ProjectCreationFailedException"}, + {"shape":"InvalidServiceRoleException"}, + {"shape":"ProjectConfigurationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

" + }, + "CreateUserProfile":{ + "name":"CreateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserProfileRequest"}, + "output":{"shape":"CreateUserProfileResult"}, + "errors":[ + {"shape":"UserProfileAlreadyExistsException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

" + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProjectRequest"}, + "output":{"shape":"DeleteProjectResult"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidServiceRoleException"} + ], + "documentation":"

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

" + }, + "DeleteUserProfile":{ + "name":"DeleteUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserProfileRequest"}, + "output":{"shape":"DeleteUserProfileResult"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

" + }, + "DescribeProject":{ + "name":"DescribeProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProjectRequest"}, + "output":{"shape":"DescribeProjectResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidServiceRoleException"}, + {"shape":"ProjectConfigurationException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Describes a project and its resources.

" + }, + "DescribeUserProfile":{ + "name":"DescribeUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserProfileRequest"}, + "output":{"shape":"DescribeUserProfileResult"}, + "errors":[ + {"shape":"UserProfileNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Describes a user in AWS CodeStar and the user attributes across all projects.

" + }, + "DisassociateTeamMember":{ + "name":"DisassociateTeamMember", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateTeamMemberRequest"}, + "output":{"shape":"DisassociateTeamMemberResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidServiceRoleException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.

" + }, + "ListProjects":{ + "name":"ListProjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProjectsRequest"}, + "output":{"shape":"ListProjectsResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Lists all projects in AWS CodeStar associated with your AWS account.

" + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesRequest"}, + "output":{"shape":"ListResourcesResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Lists resources associated with a project in AWS CodeStar.

" + }, + "ListTagsForProject":{ + "name":"ListTagsForProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForProjectRequest"}, + "output":{"shape":"ListTagsForProjectResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Gets the tags for a project.

" + }, + "ListTeamMembers":{ + "name":"ListTeamMembers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTeamMembersRequest"}, + "output":{"shape":"ListTeamMembersResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Lists all team members associated with a project.

" + }, + "ListUserProfiles":{ + "name":"ListUserProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserProfilesRequest"}, + "output":{"shape":"ListUserProfilesResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Lists all the user profiles configured for your AWS account in AWS CodeStar.

" + }, + "TagProject":{ + "name":"TagProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagProjectRequest"}, + "output":{"shape":"TagProjectResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Adds tags to a project.

" + }, + "UntagProject":{ + "name":"UntagProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagProjectRequest"}, + "output":{"shape":"UntagProjectResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes tags from a project.

" + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProjectRequest"}, + "output":{"shape":"UpdateProjectResult"}, + "errors":[ + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates a project in AWS CodeStar.

" + }, + "UpdateTeamMember":{ + "name":"UpdateTeamMember", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTeamMemberRequest"}, + "output":{"shape":"UpdateTeamMemberResult"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ProjectNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidServiceRoleException"}, + {"shape":"ProjectConfigurationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"TeamMemberNotFoundException"} + ], + "documentation":"

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.

" + }, + "UpdateUserProfile":{ + "name":"UpdateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserProfileRequest"}, + "output":{"shape":"UpdateUserProfileResult"}, + "errors":[ + {"shape":"UserProfileNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

" + } + }, + "shapes":{ + "AssociateTeamMemberRequest":{ + "type":"structure", + "required":[ + "projectId", + "userArn", + "projectRole" + ], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the project to which you will add the IAM user.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.

" + }, + "projectRole":{ + "shape":"Role", + "documentation":"

The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.

" + }, + "remoteAccessAllowed":{ + "shape":"RemoteAccessAllowed", + "documentation":"

Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.

", + "box":true + } + } + }, + "AssociateTeamMemberResult":{ + "type":"structure", + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The user- or system-generated token from the initial request that can be used to repeat the request.

" + } + } + }, + "BucketKey":{"type":"string"}, + "BucketName":{ + "type":"string", + "max":63, + "min":3 + }, + "ClientRequestToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[\\w:/-]+$" + }, + "Code":{ + "type":"structure", + "required":[ + "source", + "destination" + ], + "members":{ + "source":{ + "shape":"CodeSource", + "documentation":"

The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.

" + }, + "destination":{ + "shape":"CodeDestination", + "documentation":"

The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.

" + } + }, + "documentation":"

Location and destination information about the source code files provided with the project request. The source code is uploaded to the new project source repository after project creation.

" + }, + "CodeCommitCodeDestination":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"RepositoryName", + "documentation":"

The name of the AWS CodeCommit repository to be created in AWS CodeStar.

" + } + }, + "documentation":"

Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

" + }, + "CodeDestination":{ + "type":"structure", + "members":{ + "codeCommit":{ + "shape":"CodeCommitCodeDestination", + "documentation":"

Information about the AWS CodeCommit repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

" + }, + "gitHub":{ + "shape":"GitHubCodeDestination", + "documentation":"

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

" + } + }, + "documentation":"

The repository to be created in AWS CodeStar. Valid values are AWS CodeCommit or GitHub. After AWS CodeStar provisions the new repository, the source code files provided with the project request are placed in the repository.

" + }, + "CodeSource":{ + "type":"structure", + "required":["s3"], + "members":{ + "s3":{ + "shape":"S3Location", + "documentation":"

Information about the Amazon S3 location where the source code files provided with the project request are stored.

" + } + }, + "documentation":"

The location where the source code files provided with the project request are stored. AWS CodeStar retrieves the files during project creation.

" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Another modification is being made. That modification must complete before you can make your change.

", + "exception":true + }, + "CreateProjectRequest":{ + "type":"structure", + "required":[ + "name", + "id" + ], + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

The display name for the project to be created in AWS CodeStar.

" + }, + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project to be created in AWS CodeStar.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

The description of the project, if any.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request.

" + }, + "sourceCode":{ + "shape":"SourceCode", + "documentation":"

A list of the Code objects submitted with the project request. If this parameter is specified, the request must also include the toolchain parameter.

" + }, + "toolchain":{ + "shape":"Toolchain", + "documentation":"

The name of the toolchain template file submitted with the project request. If this parameter is specified, the request must also include the sourceCode parameter.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags created for the project.

" + } + } + }, + "CreateProjectResult":{ + "type":"structure", + "required":[ + "id", + "arn" + ], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + }, + "arn":{ + "shape":"ProjectArn", + "documentation":"

The Amazon Resource Name (ARN) of the created project.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A user- or system-generated token that identifies the entity that requested project creation.

" + }, + "projectTemplateId":{ + "shape":"ProjectTemplateId", + "documentation":"

Reserved for future use.

" + } + } + }, + "CreateUserProfileRequest":{ + "type":"structure", + "required":[ + "userArn", + "displayName", + "emailAddress" + ], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user in IAM.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The name that will be displayed as the friendly name for the user in AWS CodeStar.

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address that will be displayed as part of the user's profile in AWS CodeStar.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

" + } + } + }, + "CreateUserProfileResult":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user in IAM.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The name that is displayed as the friendly name for the user in AWS CodeStar.

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address that is displayed as part of the user's profile in AWS CodeStar.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.

" + }, + "createdTimestamp":{ + "shape":"CreatedTimestamp", + "documentation":"

The date the user profile was created, in timestamp format.

" + }, + "lastModifiedTimestamp":{ + "shape":"LastModifiedTimestamp", + "documentation":"

The date the user profile was last modified, in timestamp format.

" + } + } + }, + "CreatedTimestamp":{"type":"timestamp"}, + "DeleteProjectRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project to be deleted in AWS CodeStar.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

" + }, + "deleteStack":{ + "shape":"DeleteStack", + "documentation":"

Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

" + } + } + }, + "DeleteProjectResult":{ + "type":"structure", + "members":{ + "stackId":{ + "shape":"StackId", + "documentation":"

The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.

" + }, + "projectArn":{ + "shape":"ProjectArn", + "documentation":"

The Amazon Resource Name (ARN) of the deleted project.

" + } + } + }, + "DeleteStack":{"type":"boolean"}, + "DeleteUserProfileRequest":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.

" + } + } + }, + "DeleteUserProfileResult":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.

" + } + } + }, + "DescribeProjectRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + } + } + }, + "DescribeProjectResult":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

The display name for the project.

" + }, + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + }, + "arn":{ + "shape":"ProjectArn", + "documentation":"

The Amazon Resource Name (ARN) for the project.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

The description of the project, if any.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A user- or system-generated token that identifies the entity that requested project creation.

" + }, + "createdTimeStamp":{ + "shape":"CreatedTimestamp", + "documentation":"

The date and time the project was created, in timestamp format.

" + }, + "stackId":{ + "shape":"StackId", + "documentation":"

The ID of the primary stack in AWS CloudFormation used to generate resources for the project.

" + }, + "projectTemplateId":{ + "shape":"ProjectTemplateId", + "documentation":"

The ID for the AWS CodeStar project template used to create the project.

" + }, + "status":{ + "shape":"ProjectStatus", + "documentation":"

The project creation or deletion status.

" + } + } + }, + "DescribeUserProfileRequest":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user.

" + } + } + }, + "DescribeUserProfileResult":{ + "type":"structure", + "required":[ + "userArn", + "createdTimestamp", + "lastModifiedTimestamp" + ], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address for the user. Optional.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.

" + }, + "createdTimestamp":{ + "shape":"CreatedTimestamp", + "documentation":"

The date and time when the user profile was created in AWS CodeStar, in timestamp format.

" + }, + "lastModifiedTimestamp":{ + "shape":"LastModifiedTimestamp", + "documentation":"

The date and time when the user profile was last modified, in timestamp format.

" + } + } + }, + "DisassociateTeamMemberRequest":{ + "type":"structure", + "required":[ + "projectId", + "userArn" + ], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the AWS CodeStar project from which you want to remove a team member.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.

" + } + } + }, + "DisassociateTeamMemberResult":{ + "type":"structure", + "members":{ + } + }, + "Email":{ + "type":"string", + "max":128, + "min":3, + "pattern":"^[\\w-.+]+@[\\w-.+]+$", + "sensitive":true + }, + "GitHubCodeDestination":{ + "type":"structure", + "required":[ + "name", + "type", + "owner", + "privateRepository", + "issuesEnabled", + "token" + ], + "members":{ + "name":{ + "shape":"RepositoryName", + "documentation":"

Name of the GitHub repository to be created in AWS CodeStar.

" + }, + "description":{ + "shape":"RepositoryDescription", + "documentation":"

Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

" + }, + "type":{ + "shape":"RepositoryType", + "documentation":"

The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

" + }, + "owner":{ + "shape":"RepositoryOwner", + "documentation":"

The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

" + }, + "privateRepository":{ + "shape":"RepositoryIsPrivate", + "documentation":"

Whether the GitHub repository is to be a private repository.

" + }, + "issuesEnabled":{ + "shape":"RepositoryEnableIssues", + "documentation":"

Whether to enable issues for the GitHub repository.

" + }, + "token":{ + "shape":"GitHubPersonalToken", + "documentation":"

The GitHub user's personal access token for the GitHub repository.

" + } + }, + "documentation":"

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

" + }, + "GitHubPersonalToken":{ + "type":"string", + "min":1, + "sensitive":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The next token is not valid.

", + "exception":true + }, + "InvalidServiceRoleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The service role is not valid.

", + "exception":true + }, + "LastModifiedTimestamp":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A resource limit has been exceeded.

", + "exception":true + }, + "ListProjectsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token to be used to return the next set of results, if the results cannot be returned in one response.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum amount of data that can be contained in a single set of results.

", + "box":true + } + } + }, + "ListProjectsResult":{ + "type":"structure", + "required":["projects"], + "members":{ + "projects":{ + "shape":"ProjectsList", + "documentation":"

A list of projects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token to use when requesting the next set of results, if there are more results to be returned.

" + } + } + }, + "ListResourcesRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token for the next set of results, if the results cannot be returned in one response.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum amount of data that can be contained in a single set of results.

", + "box":true + } + } + }, + "ListResourcesResult":{ + "type":"structure", + "members":{ + "resources":{ + "shape":"ResourcesResult", + "documentation":"

An array of resources associated with the project.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token to use when requesting the next set of results, if there are more results to be returned.

" + } + } + }, + "ListTagsForProjectRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project to get tags for.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Reserved for future use.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Reserved for future use.

", + "box":true + } + } + }, + "ListTagsForProjectResult":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The tags for the project.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Reserved for future use.

" + } + } + }, + "ListTeamMembersRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the project for which you want to list team members.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token for the next set of results, if the results cannot be returned in one response.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of team members you want returned in a response.

", + "box":true + } + } + }, + "ListTeamMembersResult":{ + "type":"structure", + "required":["teamMembers"], + "members":{ + "teamMembers":{ + "shape":"TeamMemberResult", + "documentation":"

A list of team member objects for the project.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token to use when requesting the next set of results, if there are more results to be returned.

" + } + } + }, + "ListUserProfilesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token for the next set of results, if the results cannot be returned in one response.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in a response.

", + "box":true + } + } + }, + "ListUserProfilesResult":{ + "type":"structure", + "required":["userProfiles"], + "members":{ + "userProfiles":{ + "shape":"UserProfilesList", + "documentation":"

All the user profiles configured in AWS CodeStar for an AWS account.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The continuation token to use when requesting the next set of results, if there are more results to be returned.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "PaginationToken":{ + "type":"string", + "max":512, + "min":1, + "pattern":"^[\\w/+=]+$" + }, + "ProjectAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.

", + "exception":true + }, + "ProjectArn":{ + "type":"string", + "pattern":"^arn:aws[^:\\s]*:codestar:[^:\\s]+:[0-9]{12}:project\\/[a-z]([a-z0-9|-])+$" + }, + "ProjectConfigurationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Project configuration information is required but not specified.

", + "exception":true + }, + "ProjectCreationFailedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.

", + "exception":true + }, + "ProjectDescription":{ + "type":"string", + "max":1024, + "pattern":"^$|^\\S(.*\\S)?$", + "sensitive":true + }, + "ProjectId":{ + "type":"string", + "max":15, + "min":2, + "pattern":"^[a-z][a-z0-9-]+$" + }, + "ProjectName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^\\S(.*\\S)?$", + "sensitive":true + }, + "ProjectNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified AWS CodeStar project was not found.

", + "exception":true + }, + "ProjectStatus":{ + "type":"structure", + "required":["state"], + "members":{ + "state":{ + "shape":"State", + "documentation":"

The phase of completion for a project creation or deletion.

" + }, + "reason":{ + "shape":"Reason", + "documentation":"

In the case of a project creation or deletion failure, a reason for the failure.

" + } + }, + "documentation":"

An indication of whether a project creation or deletion is failed or successful.

" + }, + "ProjectSummary":{ + "type":"structure", + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + }, + "projectArn":{ + "shape":"ProjectArn", + "documentation":"

The Amazon Resource Name (ARN) of the project.

" + } + }, + "documentation":"

Information about the metadata for a project.

" + }, + "ProjectTemplateId":{ + "type":"string", + "min":1, + "pattern":"^arn:aws[^:\\s]{0,5}:codestar:[^:\\s]+::project-template(\\/(github|codecommit))?\\/[a-z0-9-]+$" + }, + "ProjectsList":{ + "type":"list", + "member":{"shape":"ProjectSummary"} + }, + "Reason":{ + "type":"string", + "max":1024, + "pattern":"^$|^\\S(.*\\S)?$" + }, + "RemoteAccessAllowed":{"type":"boolean"}, + "RepositoryDescription":{ + "type":"string", + "max":1000, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, + "RepositoryEnableIssues":{"type":"boolean"}, + "RepositoryIsPrivate":{"type":"boolean"}, + "RepositoryName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^\\S[\\w.-]*$" + }, + "RepositoryOwner":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, + "RepositoryType":{ + "type":"string", + "pattern":"^(user|organization|User|Organization)$" + }, + "Resource":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ResourceId", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "documentation":"

Information about a resource for a project.

" + }, + "ResourceId":{ + "type":"string", + "min":11, + "pattern":"^arn\\:aws\\:\\S.*\\:.*" + }, + "ResourcesResult":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "Role":{ + "type":"string", + "pattern":"^(Owner|Viewer|Contributor)$" + }, + "RoleArn":{ + "type":"string", + "max":1224, + "min":1 + }, + "S3Location":{ + "type":"structure", + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket name where the source code files provided with the project request are stored.

" + }, + "bucketKey":{ + "shape":"BucketKey", + "documentation":"

The Amazon S3 object key where the source code files provided with the project request are stored.

" + } + }, + "documentation":"

The Amazon S3 location where the source code files provided with the project request are stored.

" + }, + "SourceCode":{ + "type":"list", + "member":{"shape":"Code"} + }, + "SshPublicKey":{ + "type":"string", + "max":16384, + "pattern":"^[\\t\\r\\n\\u0020-\\u00FF]*$" + }, + "StackId":{ + "type":"string", + "pattern":"^arn:aws[^:\\s]*:cloudformation:[^:\\s]+:[0-9]{12}:stack\\/[^:\\s]+\\/[^:\\s]+$" + }, + "State":{ + "type":"string", + "pattern":"^(CreateInProgress|CreateComplete|CreateFailed|DeleteComplete|DeleteFailed|DeleteInProgress|UpdateComplete|UpdateInProgress|UpdateFailed|Unknown)$" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagProjectRequest":{ + "type":"structure", + "required":[ + "id", + "tags" + ], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project you want to add a tag to.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags you want to add to the project.

" + } + } + }, + "TagProjectResult":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The tags for the project.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TeamMember":{ + "type":"structure", + "required":[ + "userArn", + "projectRole" + ], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user in IAM.

" + }, + "projectRole":{ + "shape":"Role", + "documentation":"

The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

" + }, + "remoteAccessAllowed":{ + "shape":"RemoteAccessAllowed", + "documentation":"

Whether the user is allowed to remotely access project resources using an SSH public/private key pair.

", + "box":true + } + }, + "documentation":"

Information about a team member in a project.

" + }, + "TeamMemberAlreadyAssociatedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The team member is already associated with a role in this project.

", + "exception":true + }, + "TeamMemberNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified team member was not found.

", + "exception":true + }, + "TeamMemberResult":{ + "type":"list", + "member":{"shape":"TeamMember"} + }, + "TemplateParameterKey":{ + "type":"string", + "max":30, + "min":1, + "pattern":"^\\S(.*\\S)?$" + }, + "TemplateParameterMap":{ + "type":"map", + "key":{"shape":"TemplateParameterKey"}, + "value":{"shape":"TemplateParameterValue"}, + "max":25 + }, + "TemplateParameterValue":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^\\S(.*\\S)?$", + "sensitive":true + }, + "Toolchain":{ + "type":"structure", + "required":["source"], + "members":{ + "source":{ + "shape":"ToolchainSource", + "documentation":"

The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The service role ARN for AWS CodeStar to use for the toolchain template during stack provisioning.

" + }, + "stackParameters":{ + "shape":"TemplateParameterMap", + "documentation":"

The list of parameter overrides to be passed into the toolchain template during stack provisioning, if any.

" + } + }, + "documentation":"

The toolchain template file provided with the project request. AWS CodeStar uses the template to provision the toolchain stack in AWS CloudFormation.

" + }, + "ToolchainSource":{ + "type":"structure", + "required":["s3"], + "members":{ + "s3":{ + "shape":"S3Location", + "documentation":"

The Amazon S3 bucket where the toolchain template file provided with the project request is stored.

" + } + }, + "documentation":"

The Amazon S3 location where the toolchain template file provided with the project request is stored. AWS CodeStar retrieves the file during project creation.

" + }, + "UntagProjectRequest":{ + "type":"structure", + "required":[ + "id", + "tags" + ], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project to remove tags from.

" + }, + "tags":{ + "shape":"TagKeys", + "documentation":"

The tags to remove from the project.

" + } + } + }, + "UntagProjectResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateProjectRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"ProjectId", + "documentation":"

The ID of the project you want to update.

" + }, + "name":{ + "shape":"ProjectName", + "documentation":"

The name of the project you want to update.

" + }, + "description":{ + "shape":"ProjectDescription", + "documentation":"

The description of the project, if any.

" + } + } + }, + "UpdateProjectResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateTeamMemberRequest":{ + "type":"structure", + "required":[ + "projectId", + "userArn" + ], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

The ID of the project.

" + }, + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.

" + }, + "projectRole":{ + "shape":"Role", + "documentation":"

The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

" + }, + "remoteAccessAllowed":{ + "shape":"RemoteAccessAllowed", + "documentation":"

Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.

", + "box":true + } + } + }, + "UpdateTeamMemberResult":{ + "type":"structure", + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.

" + }, + "projectRole":{ + "shape":"Role", + "documentation":"

The project role granted to the user.

" + }, + "remoteAccessAllowed":{ + "shape":"RemoteAccessAllowed", + "documentation":"

Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.

", + "box":true + } + } + }, + "UpdateUserProfileRequest":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The name that will be displayed as the friendly name for the user in AWS CodeStar.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The name that is displayed as the friendly name for the user in AWS CodeStar.

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address that is displayed as part of the user's profile in AWS CodeStar.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

" + } + } + }, + "UpdateUserProfileResult":{ + "type":"structure", + "required":["userArn"], + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user in IAM.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The name that is displayed as the friendly name for the user in AWS CodeStar.

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address that is displayed as part of the user's profile in AWS CodeStar.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.

" + }, + "createdTimestamp":{ + "shape":"CreatedTimestamp", + "documentation":"

The date the user profile was created, in timestamp format.

" + }, + "lastModifiedTimestamp":{ + "shape":"LastModifiedTimestamp", + "documentation":"

The date the user profile was last modified, in timestamp format.

" + } + } + }, + "UserArn":{ + "type":"string", + "max":95, + "min":32, + "pattern":"^arn:aws:iam::\\d{12}:user(?:(\\u002F)|(\\u002F[\\u0021-\\u007E]+\\u002F))[\\w+=,.@-]+$" + }, + "UserProfileAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.

", + "exception":true + }, + "UserProfileDisplayName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^\\S(.*\\S)?$", + "sensitive":true + }, + "UserProfileNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The user profile was not found.

", + "exception":true + }, + "UserProfileSummary":{ + "type":"structure", + "members":{ + "userArn":{ + "shape":"UserArn", + "documentation":"

The Amazon Resource Name (ARN) of the user in IAM.

" + }, + "displayName":{ + "shape":"UserProfileDisplayName", + "documentation":"

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").

" + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

The email address associated with the user.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.

" + } + }, + "documentation":"

Information about a user's profile in AWS CodeStar.

" + }, + "UserProfilesList":{ + "type":"list", + "member":{"shape":"UserProfileSummary"} + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified input is either not valid, or it could not be validated.

", + "exception":true + } + }, + "documentation":"AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

  • DeleteProject, which deletes a project.

  • DescribeProject, which lists the attributes of a project.

  • ListProjects, which lists all projects associated with your AWS account.

  • ListResources, which lists the resources associated with a project.

  • ListTagsForProject, which lists the tags associated with a project.

  • TagProject, which adds tags to a project.

  • UntagProject, which removes tags from a project.

  • UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

  • AssociateTeamMember, which adds an IAM user to the team for a project.

  • DisassociateTeamMember, which removes an IAM user from the team for a project.

  • ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.

  • UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

  • CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.

  • DeleteUserProfile, which deletes all user profile information across all projects.

  • DescribeUserProfile, which describes the profile of a user.

  • ListUserProfiles, which lists all user profiles.

  • UpdateUserProfile, which updates the profile for a user.

" +} diff --git a/aws/dist/botocore/data/cognito-identity/2014-06-30/examples-1.json b/aws/dist/botocore/data/cognito-identity/2014-06-30/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cognito-identity/2014-06-30/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cognito-identity/2014-06-30/paginators-1.json b/aws/dist/botocore/data/cognito-identity/2014-06-30/paginators-1.json new file mode 100644 index 00000000..2af6e40c --- /dev/null +++ b/aws/dist/botocore/data/cognito-identity/2014-06-30/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListIdentityPools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IdentityPools" + } + } +} diff --git a/aws/dist/botocore/data/cognito-identity/2014-06-30/service-2.json b/aws/dist/botocore/data/cognito-identity/2014-06-30/service-2.json new file mode 100644 index 00000000..900e3b5a --- /dev/null +++ b/aws/dist/botocore/data/cognito-identity/2014-06-30/service-2.json @@ -0,0 +1,1477 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-06-30", + "endpointPrefix":"cognito-identity", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Cognito Identity", + "serviceId":"Cognito Identity", + "signatureVersion":"v4", + "targetPrefix":"AWSCognitoIdentityService", + "uid":"cognito-identity-2014-06-30" + }, + "operations":{ + "CreateIdentityPool":{ + "name":"CreateIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIdentityPoolInput"}, + "output":{"shape":"IdentityPool"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a new identity pool. The identity pool is a store of user identity information that is specific to your AWS account. The limit on identity pools is 60 per account. The keys for SupportedLoginProviders are as follows:

  • Facebook: graph.facebook.com

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

You must use AWS Developer credentials to call this API.

" + }, + "DeleteIdentities":{ + "name":"DeleteIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentitiesInput"}, + "output":{"shape":"DeleteIdentitiesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes identities from an identity pool. You can specify a list of 1-60 identities that you want to delete.

You must use AWS Developer credentials to call this API.

" + }, + "DeleteIdentityPool":{ + "name":"DeleteIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityPoolInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes an identity pool. Once a pool is deleted, users will not be able to authenticate with the pool.

You must use AWS Developer credentials to call this API.

" + }, + "DescribeIdentity":{ + "name":"DescribeIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityInput"}, + "output":{"shape":"IdentityDescription"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns metadata related to the given identity, including when the identity was created and any associated linked logins.

You must use AWS Developer credentials to call this API.

" + }, + "DescribeIdentityPool":{ + "name":"DescribeIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityPoolInput"}, + "output":{"shape":"IdentityPool"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use AWS Developer credentials to call this API.

" + }, + "GetCredentialsForIdentity":{ + "name":"GetCredentialsForIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCredentialsForIdentityInput"}, + "output":{"shape":"GetCredentialsForIdentityResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidIdentityPoolConfigurationException"}, + {"shape":"InternalErrorException"}, + {"shape":"ExternalServiceException"} + ], + "documentation":"

Returns credentials for the provided identity ID. Any provided logins will be validated against supported login providers. If the token is for cognito-identity.amazonaws.com, it will be passed through to AWS Security Token Service with the appropriate role for the token.

This is a public API. You do not need any credentials to call this API.

" + }, + "GetId":{ + "name":"GetId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdInput"}, + "output":{"shape":"GetIdResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"LimitExceededException"}, + {"shape":"ExternalServiceException"} + ], + "documentation":"

Generates (or retrieves) a Cognito ID. Supplying multiple logins will create an implicit linked account.

This is a public API. You do not need any credentials to call this API.

" + }, + "GetIdentityPoolRoles":{ + "name":"GetIdentityPoolRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityPoolRolesInput"}, + "output":{"shape":"GetIdentityPoolRolesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the roles for an identity pool.

You must use AWS Developer credentials to call this API.

" + }, + "GetOpenIdToken":{ + "name":"GetOpenIdToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpenIdTokenInput"}, + "output":{"shape":"GetOpenIdTokenResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"ExternalServiceException"} + ], + "documentation":"

Gets an OpenID token, using a known Cognito ID. This known Cognito ID is returned by GetId. You can optionally add additional logins for the identity. Supplying multiple logins creates an implicit link.

The OpenId token is valid for 10 minutes.

This is a public API. You do not need any credentials to call this API.

" + }, + "GetOpenIdTokenForDeveloperIdentity":{ + "name":"GetOpenIdTokenForDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpenIdTokenForDeveloperIdentityInput"}, + "output":{"shape":"GetOpenIdTokenForDeveloperIdentityResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"DeveloperUserAlreadyRegisteredException"} + ], + "documentation":"

Registers (or retrieves) a Cognito IdentityId and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins map, which is linked to the identity pool. The developer provider is the \"domain\" by which Cognito will refer to your users.

You can use GetOpenIdTokenForDeveloperIdentity to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId. This API will create the identity in the specified IdentityPoolId.

You must use AWS Developer credentials to call this API.

" + }, + "ListIdentities":{ + "name":"ListIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIdentitiesInput"}, + "output":{"shape":"ListIdentitiesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the identities in an identity pool.

You must use AWS Developer credentials to call this API.

" + }, + "ListIdentityPools":{ + "name":"ListIdentityPools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIdentityPoolsInput"}, + "output":{"shape":"ListIdentityPoolsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists all of the Cognito identity pools registered for your account.

You must use AWS Developer credentials to call this API.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the tags that are assigned to an Amazon Cognito identity pool.

A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

" + }, + "LookupDeveloperIdentity":{ + "name":"LookupDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LookupDeveloperIdentityInput"}, + "output":{"shape":"LookupDeveloperIdentityResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Retrieves the IdentityID associated with a DeveloperUserIdentifier or the list of DeveloperUserIdentifier values associated with an IdentityId for an existing identity. Either IdentityID or DeveloperUserIdentifier must not be null. If you supply only one of these values, the other value will be searched in the database and returned as a part of the response. If you supply both, DeveloperUserIdentifier will be matched against IdentityID. If the values are verified against the database, the response returns both values and is the same as the request. Otherwise a ResourceConflictException is thrown.

LookupDeveloperIdentity is intended for low-throughput control plane operations: for example, to enable customer service to locate an identity ID by username. If you are using it for higher-volume operations such as user authentication, your requests are likely to be throttled. GetOpenIdTokenForDeveloperIdentity is a better option for higher-volume operations for user authentication.

You must use AWS Developer credentials to call this API.

" + }, + "MergeDeveloperIdentities":{ + "name":"MergeDeveloperIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeDeveloperIdentitiesInput"}, + "output":{"shape":"MergeDeveloperIdentitiesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Merges two users having different IdentityIds, existing in the same identity pool, and identified by the same developer provider. You can use this action to request that discrete users be merged and identified as a single user in the Cognito environment. Cognito associates the given source user (SourceUserIdentifier) with the IdentityId of the DestinationUserIdentifier. Only developer-authenticated users can be merged. If the users to be merged are associated with the same public provider, but as two different users, an exception will be thrown.

The number of linked logins is limited to 20. So, the number of linked logins for the source user, SourceUserIdentifier, and the destination user, DestinationUserIdentifier, together should not be larger than 20. Otherwise, an exception will be thrown.

You must use AWS Developer credentials to call this API.

" + }, + "SetIdentityPoolRoles":{ + "name":"SetIdentityPoolRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityPoolRolesInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Assigns a set of tags to an Amazon Cognito identity pool. A tag is a label that you can use to categorize and manage identity pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of an identity pool, one for testing and another for production, you might assign an Environment tag key to both identity pools. The value of this key might be Test for one identity pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your identity pools. In an IAM policy, you can constrain permissions for identity pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. An identity pool can have as many as 50 tags.

" + }, + "UnlinkDeveloperIdentity":{ + "name":"UnlinkDeveloperIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnlinkDeveloperIdentityInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Unlinks a DeveloperUserIdentifier from an existing identity. Unlinked developer users will be considered new identities next time they are seen. If, for a given Cognito identity, you remove all federated identities as well as the developer user identifier, the Cognito identity becomes inaccessible.

You must use AWS Developer credentials to call this API.

" + }, + "UnlinkIdentity":{ + "name":"UnlinkIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnlinkIdentityInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"ExternalServiceException"} + ], + "documentation":"

Unlinks a federated identity from an existing account. Unlinked logins will be considered new identities next time they are seen. Removing the last linked login will make this identity inaccessible.

This is a public API. You do not need any credentials to call this API.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Removes the specified tags from an Amazon Cognito identity pool. You can use this action up to 5 times per second, per account

" + }, + "UpdateIdentityPool":{ + "name":"UpdateIdentityPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IdentityPool"}, + "output":{"shape":"IdentityPool"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Updates an identity pool.

You must use AWS Developer credentials to call this API.

" + } + }, + "shapes":{ + "ARNString":{ + "type":"string", + "max":2048, + "min":20 + }, + "AccessKeyString":{"type":"string"}, + "AccountId":{ + "type":"string", + "max":15, + "min":1, + "pattern":"\\d+" + }, + "AmbiguousRoleResolutionType":{ + "type":"string", + "enum":[ + "AuthenticatedRole", + "Deny" + ] + }, + "ClaimName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "ClaimValue":{ + "type":"string", + "max":128, + "min":1 + }, + "CognitoIdentityProvider":{ + "type":"structure", + "members":{ + "ProviderName":{ + "shape":"CognitoIdentityProviderName", + "documentation":"

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

" + }, + "ClientId":{ + "shape":"CognitoIdentityProviderClientId", + "documentation":"

The client ID for the Amazon Cognito user pool.

" + }, + "ServerSideTokenCheck":{ + "shape":"CognitoIdentityProviderTokenCheck", + "documentation":"

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

", + "box":true + } + }, + "documentation":"

A provider representing an Amazon Cognito user pool and its client ID.

" + }, + "CognitoIdentityProviderClientId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w_]+" + }, + "CognitoIdentityProviderList":{ + "type":"list", + "member":{"shape":"CognitoIdentityProvider"} + }, + "CognitoIdentityProviderName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w._:/-]+" + }, + "CognitoIdentityProviderTokenCheck":{"type":"boolean"}, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a ConcurrentModificationException.

" + } + }, + "documentation":"

Thrown if there are parallel requests to modify a resource.

", + "exception":true + }, + "CreateIdentityPoolInput":{ + "type":"structure", + "required":[ + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members":{ + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"

A string that you provide.

" + }, + "AllowUnauthenticatedIdentities":{ + "shape":"IdentityPoolUnauthenticated", + "documentation":"

TRUE if the identity pool supports unauthenticated logins.

" + }, + "SupportedLoginProviders":{ + "shape":"IdentityProviders", + "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

Once you have set a developer provider name, you cannot change it. Please take care in setting this parameter.

" + }, + "OpenIdConnectProviderARNs":{ + "shape":"OIDCProviderList", + "documentation":"

A list of OpendID Connect provider ARNs.

" + }, + "CognitoIdentityProviders":{ + "shape":"CognitoIdentityProviderList", + "documentation":"

An array of Amazon Cognito user pools and their client IDs.

" + }, + "SamlProviderARNs":{ + "shape":"SAMLProviderList", + "documentation":"

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

" + }, + "IdentityPoolTags":{ + "shape":"IdentityPoolTagsType", + "documentation":"

Tags to assign to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

" + } + }, + "documentation":"

Input to the CreateIdentityPool action.

" + }, + "Credentials":{ + "type":"structure", + "members":{ + "AccessKeyId":{ + "shape":"AccessKeyString", + "documentation":"

The Access Key portion of the credentials.

" + }, + "SecretKey":{ + "shape":"SecretKeyString", + "documentation":"

The Secret Access Key portion of the credentials

" + }, + "SessionToken":{ + "shape":"SessionTokenString", + "documentation":"

The Session Token portion of the credentials

" + }, + "Expiration":{ + "shape":"DateType", + "documentation":"

The date at which these credentials will expire.

" + } + }, + "documentation":"

Credentials for the provided identity ID.

" + }, + "DateType":{"type":"timestamp"}, + "DeleteIdentitiesInput":{ + "type":"structure", + "required":["IdentityIdsToDelete"], + "members":{ + "IdentityIdsToDelete":{ + "shape":"IdentityIdList", + "documentation":"

A list of 1-60 identities that you want to delete.

" + } + }, + "documentation":"

Input to the DeleteIdentities action.

" + }, + "DeleteIdentitiesResponse":{ + "type":"structure", + "members":{ + "UnprocessedIdentityIds":{ + "shape":"UnprocessedIdentityIdList", + "documentation":"

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

" + } + }, + "documentation":"

Returned in response to a successful DeleteIdentities operation.

" + }, + "DeleteIdentityPoolInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the DeleteIdentityPool action.

" + }, + "DescribeIdentityInput":{ + "type":"structure", + "required":["IdentityId"], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the DescribeIdentity action.

" + }, + "DescribeIdentityPoolInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the DescribeIdentityPool action.

" + }, + "DeveloperProviderName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w._-]+" + }, + "DeveloperUserAlreadyRegisteredException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

This developer user identifier is already registered with Cognito.

" + } + }, + "documentation":"

The provided developer user identifier is already registered with Cognito under a different identity ID.

", + "exception":true + }, + "DeveloperUserIdentifier":{ + "type":"string", + "max":1024, + "min":1 + }, + "DeveloperUserIdentifierList":{ + "type":"list", + "member":{"shape":"DeveloperUserIdentifier"} + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "AccessDenied", + "InternalServerError" + ] + }, + "ExternalServiceException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by an ExternalServiceException

" + } + }, + "documentation":"

An exception thrown when a dependent service such as Facebook or Twitter is not responding

", + "exception":true + }, + "GetCredentialsForIdentityInput":{ + "type":"structure", + "required":["IdentityId"], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. The name-value pair will follow the syntax \"provider_name\": \"provider_user_identifier\".

Logins should not be specified when trying to get credentials for an unauthenticated identity.

The Logins parameter is required when using identities associated with external identity providers such as FaceBook. For examples of Logins maps, see the code examples in the External Identity Providers section of the Amazon Cognito Developer Guide.

" + }, + "CustomRoleArn":{ + "shape":"ARNString", + "documentation":"

The Amazon Resource Name (ARN) of the role to be assumed when multiple roles were received in the token from the identity provider. For example, a SAML-based identity provider. This parameter is optional for identity providers that do not support role customization.

" + } + }, + "documentation":"

Input to the GetCredentialsForIdentity action.

" + }, + "GetCredentialsForIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Credentials":{ + "shape":"Credentials", + "documentation":"

Credentials for the provided identity ID.

" + } + }, + "documentation":"

Returned in response to a successful GetCredentialsForIdentity operation.

" + }, + "GetIdInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

A standard AWS account ID (9+ digits).

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. The available provider names for Logins are as follows:

  • Facebook: graph.facebook.com

  • Amazon Cognito user pool: cognito-idp.<region>.amazonaws.com/<YOUR_USER_POOL_ID>, for example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

  • Google: accounts.google.com

  • Amazon: www.amazon.com

  • Twitter: api.twitter.com

  • Digits: www.digits.com

" + } + }, + "documentation":"

Input to the GetId action.

" + }, + "GetIdResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + } + }, + "documentation":"

Returned in response to a GetId request.

" + }, + "GetIdentityPoolRolesInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the GetIdentityPoolRoles action.

" + }, + "GetIdentityPoolRolesResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "Roles":{ + "shape":"RolesMap", + "documentation":"

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

" + }, + "RoleMappings":{ + "shape":"RoleMappingMap", + "documentation":"

How users for a specific identity provider are to mapped to roles. This is a String-to-RoleMapping object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

" + } + }, + "documentation":"

Returned in response to a successful GetIdentityPoolRoles operation.

" + }, + "GetOpenIdTokenForDeveloperIdentityInput":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "Logins" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax \"developer_provider_name\": \"developer_user_identifier\". The developer provider is the \"domain\" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.

" + }, + "TokenDuration":{ + "shape":"TokenDuration", + "documentation":"

The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.

" + } + }, + "documentation":"

Input to the GetOpenIdTokenForDeveloperIdentity action.

" + }, + "GetOpenIdTokenForDeveloperIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Token":{ + "shape":"OIDCToken", + "documentation":"

An OpenID token.

" + } + }, + "documentation":"

Returned in response to a successful GetOpenIdTokenForDeveloperIdentity request.

" + }, + "GetOpenIdTokenInput":{ + "type":"structure", + "required":["IdentityId"], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito user pool provider, or any other OpenId Connect provider, always include the id_token.

" + } + }, + "documentation":"

Input to the GetOpenIdToken action.

" + }, + "GetOpenIdTokenResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.

" + }, + "Token":{ + "shape":"OIDCToken", + "documentation":"

An OpenID token, valid for 10 minutes.

" + } + }, + "documentation":"

Returned in response to a successful GetOpenIdToken request.

" + }, + "HideDisabled":{"type":"boolean"}, + "IdentitiesList":{ + "type":"list", + "member":{"shape":"IdentityDescription"} + }, + "IdentityDescription":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsList", + "documentation":"

The provider names.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

Date on which the identity was created.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

Date on which the identity was last modified.

" + } + }, + "documentation":"

A description of the identity.

" + }, + "IdentityId":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityIdList":{ + "type":"list", + "member":{"shape":"IdentityId"}, + "max":60, + "min":1 + }, + "IdentityPool":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityPoolName", + "AllowUnauthenticatedIdentities" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"

A string that you provide.

" + }, + "AllowUnauthenticatedIdentities":{ + "shape":"IdentityPoolUnauthenticated", + "documentation":"

TRUE if the identity pool supports unauthenticated logins.

" + }, + "SupportedLoginProviders":{ + "shape":"IdentityProviders", + "documentation":"

Optional key:value pairs mapping provider names to provider app IDs.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users.

" + }, + "OpenIdConnectProviderARNs":{ + "shape":"OIDCProviderList", + "documentation":"

A list of OpendID Connect provider ARNs.

" + }, + "CognitoIdentityProviders":{ + "shape":"CognitoIdentityProviderList", + "documentation":"

A list representing an Amazon Cognito user pool and its client ID.

" + }, + "SamlProviderARNs":{ + "shape":"SAMLProviderList", + "documentation":"

An array of Amazon Resource Names (ARNs) of the SAML provider for your identity pool.

" + }, + "IdentityPoolTags":{ + "shape":"IdentityPoolTagsType", + "documentation":"

The tags that are assigned to the identity pool. A tag is a label that you can apply to identity pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

" + } + }, + "documentation":"

An object representing an Amazon Cognito identity pool.

" + }, + "IdentityPoolId":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w ]+" + }, + "IdentityPoolShortDescription":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityPoolName":{ + "shape":"IdentityPoolName", + "documentation":"

A string that you provide.

" + } + }, + "documentation":"

A description of the identity pool.

" + }, + "IdentityPoolTagsListType":{ + "type":"list", + "member":{"shape":"TagKeysType"} + }, + "IdentityPoolTagsType":{ + "type":"map", + "key":{"shape":"TagKeysType"}, + "value":{"shape":"TagValueType"} + }, + "IdentityPoolUnauthenticated":{"type":"boolean"}, + "IdentityPoolsList":{ + "type":"list", + "member":{"shape":"IdentityPoolShortDescription"} + }, + "IdentityProviderId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w.;_/-]+" + }, + "IdentityProviderName":{ + "type":"string", + "max":128, + "min":1 + }, + "IdentityProviderToken":{ + "type":"string", + "max":50000, + "min":1 + }, + "IdentityProviders":{ + "type":"map", + "key":{"shape":"IdentityProviderName"}, + "value":{"shape":"IdentityProviderId"}, + "max":10 + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by an InternalErrorException.

" + } + }, + "documentation":"

Thrown when the service encounters an error during processing the request.

", + "exception":true, + "fault":true + }, + "InvalidIdentityPoolConfigurationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned for an InvalidIdentityPoolConfigurationException

" + } + }, + "documentation":"

Thrown if the identity pool has no role associated for the given auth type (auth/unauth) or if the AssumeRole fails.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by an InvalidParameterException.

" + } + }, + "documentation":"

Thrown for missing or bad input parameter(s).

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a LimitExceededException.

" + } + }, + "documentation":"

Thrown when the total number of user pools has exceeded a preset limit.

", + "exception":true + }, + "ListIdentitiesInput":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "MaxResults" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"

The maximum number of identities to return.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + }, + "HideDisabled":{ + "shape":"HideDisabled", + "documentation":"

An optional boolean parameter that allows you to hide disabled identities. If omitted, the ListIdentities API will include disabled identities in the response.

" + } + }, + "documentation":"

Input to the ListIdentities action.

" + }, + "ListIdentitiesResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "Identities":{ + "shape":"IdentitiesList", + "documentation":"

An object containing a set of identities and associated mappings.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + } + }, + "documentation":"

The response to a ListIdentities request.

" + }, + "ListIdentityPoolsInput":{ + "type":"structure", + "required":["MaxResults"], + "members":{ + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"

The maximum number of identities to return.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + } + }, + "documentation":"

Input to the ListIdentityPools action.

" + }, + "ListIdentityPoolsResponse":{ + "type":"structure", + "members":{ + "IdentityPools":{ + "shape":"IdentityPoolsList", + "documentation":"

The identity pools returned by the ListIdentityPools action.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + } + }, + "documentation":"

The result of a successful ListIdentityPools action.

" + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARNString", + "documentation":"

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"IdentityPoolTagsType", + "documentation":"

The tags that are assigned to the identity pool.

" + } + } + }, + "LoginsList":{ + "type":"list", + "member":{"shape":"IdentityProviderName"} + }, + "LoginsMap":{ + "type":"map", + "key":{"shape":"IdentityProviderName"}, + "value":{"shape":"IdentityProviderToken"}, + "max":10 + }, + "LookupDeveloperIdentityInput":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "DeveloperUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

A unique ID used by your backend authentication process to identify a user. Typically, a developer identity provider would issue many developer user identifiers, in keeping with the number of users.

" + }, + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"

The maximum number of identities to return.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" + } + }, + "documentation":"

Input to the LookupDeveloperIdentityInput action.

" + }, + "LookupDeveloperIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "DeveloperUserIdentifierList":{ + "shape":"DeveloperUserIdentifierList", + "documentation":"

This is the list of developer user identifiers associated with an identity ID. Cognito supports the association of multiple developer user identifiers with an identity ID.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token. The first call you make will have NextToken set to null. After that the service will return NextToken values as needed. For example, let's say you make a request with MaxResults set to 10, and there are 20 matches in the database. The service will return a pagination token as a part of the response. This token can be used to call the API again and get results starting from the 11th match.

" + } + }, + "documentation":"

Returned in response to a successful LookupDeveloperIdentity action.

" + }, + "MappingRule":{ + "type":"structure", + "required":[ + "Claim", + "MatchType", + "Value", + "RoleARN" + ], + "members":{ + "Claim":{ + "shape":"ClaimName", + "documentation":"

The claim name that must be present in the token, for example, \"isAdmin\" or \"paid\".

" + }, + "MatchType":{ + "shape":"MappingRuleMatchType", + "documentation":"

The match condition that specifies how closely the claim value in the IdP token must match Value.

" + }, + "Value":{ + "shape":"ClaimValue", + "documentation":"

A brief string that the claim must match, for example, \"paid\" or \"yes\".

" + }, + "RoleARN":{ + "shape":"ARNString", + "documentation":"

The role ARN.

" + } + }, + "documentation":"

A rule that maps a claim name, a claim value, and a match type to a role ARN.

" + }, + "MappingRuleMatchType":{ + "type":"string", + "enum":[ + "Equals", + "Contains", + "StartsWith", + "NotEqual" + ] + }, + "MappingRulesList":{ + "type":"list", + "member":{"shape":"MappingRule"}, + "max":25, + "min":1 + }, + "MergeDeveloperIdentitiesInput":{ + "type":"structure", + "required":[ + "SourceUserIdentifier", + "DestinationUserIdentifier", + "DeveloperProviderName", + "IdentityPoolId" + ], + "members":{ + "SourceUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

User identifier for the source user. The value should be a DeveloperUserIdentifier.

" + }, + "DestinationUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

User identifier for the destination user. The value should be a DeveloperUserIdentifier.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users. This is a (pseudo) domain name that you provide while creating an identity pool. This name acts as a placeholder that allows your backend and the Cognito service to communicate about the developer provider. For the DeveloperProviderName, you can use letters as well as period (.), underscore (_), and dash (-).

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + } + }, + "documentation":"

Input to the MergeDeveloperIdentities action.

" + }, + "MergeDeveloperIdentitiesResponse":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + } + }, + "documentation":"

Returned in response to a successful MergeDeveloperIdentities action.

" + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a NotAuthorizedException

" + } + }, + "documentation":"

Thrown when a user is not authorized to access the requested resource.

", + "exception":true + }, + "OIDCProviderList":{ + "type":"list", + "member":{"shape":"ARNString"} + }, + "OIDCToken":{"type":"string"}, + "PaginationKey":{ + "type":"string", + "min":1, + "pattern":"[\\S]+" + }, + "QueryLimit":{ + "type":"integer", + "max":60, + "min":1 + }, + "ResourceConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a ResourceConflictException.

" + } + }, + "documentation":"

Thrown when a user tries to use a login which is already linked to another account.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a ResourceNotFoundException.

" + } + }, + "documentation":"

Thrown when the requested resource (for example, a dataset or record) does not exist.

", + "exception":true + }, + "RoleMapping":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"RoleMappingType", + "documentation":"

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

" + }, + "AmbiguousRoleResolution":{ + "shape":"AmbiguousRoleResolutionType", + "documentation":"

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

" + }, + "RulesConfiguration":{ + "shape":"RulesConfigurationType", + "documentation":"

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

" + } + }, + "documentation":"

A role mapping.

" + }, + "RoleMappingMap":{ + "type":"map", + "key":{"shape":"IdentityProviderName"}, + "value":{"shape":"RoleMapping"}, + "max":10 + }, + "RoleMappingType":{ + "type":"string", + "enum":[ + "Token", + "Rules" + ] + }, + "RoleType":{ + "type":"string", + "pattern":"(un)?authenticated" + }, + "RolesMap":{ + "type":"map", + "key":{"shape":"RoleType"}, + "value":{"shape":"ARNString"}, + "max":2 + }, + "RulesConfigurationType":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"MappingRulesList", + "documentation":"

An array of rules. You can specify up to 25 rules per identity provider.

Rules are evaluated in order. The first one to match specifies the role.

" + } + }, + "documentation":"

A container for rules.

" + }, + "SAMLProviderList":{ + "type":"list", + "member":{"shape":"ARNString"} + }, + "SecretKeyString":{"type":"string"}, + "SessionTokenString":{"type":"string"}, + "SetIdentityPoolRolesInput":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "Roles" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "Roles":{ + "shape":"RolesMap", + "documentation":"

The map of roles associated with this pool. For a given role, the key will be either \"authenticated\" or \"unauthenticated\" and the value will be the Role ARN.

" + }, + "RoleMappings":{ + "shape":"RoleMappingMap", + "documentation":"

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, \"graph.facebook.com\" or \"cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id\".

Up to 25 rules can be specified per identity provider.

" + } + }, + "documentation":"

Input to the SetIdentityPoolRoles action.

" + }, + "String":{"type":"string"}, + "TagKeysType":{ + "type":"string", + "max":128, + "min":1 + }, + "TagResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARNString", + "documentation":"

The Amazon Resource Name (ARN) of the identity pool to assign the tags to.

" + }, + "Tags":{ + "shape":"IdentityPoolTagsType", + "documentation":"

The tags to assign to the identity pool.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValueType":{ + "type":"string", + "max":256, + "min":0 + }, + "TokenDuration":{ + "type":"long", + "max":86400, + "min":1 + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

Message returned by a TooManyRequestsException

" + } + }, + "documentation":"

Thrown when a request is throttled.

", + "exception":true + }, + "UnlinkDeveloperIdentityInput":{ + "type":"structure", + "required":[ + "IdentityId", + "IdentityPoolId", + "DeveloperProviderName", + "DeveloperUserIdentifier" + ], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

An identity pool ID in the format REGION:GUID.

" + }, + "DeveloperProviderName":{ + "shape":"DeveloperProviderName", + "documentation":"

The \"domain\" by which Cognito will refer to your users.

" + }, + "DeveloperUserIdentifier":{ + "shape":"DeveloperUserIdentifier", + "documentation":"

A unique ID used by your backend authentication process to identify a user.

" + } + }, + "documentation":"

Input to the UnlinkDeveloperIdentity action.

" + }, + "UnlinkIdentityInput":{ + "type":"structure", + "required":[ + "IdentityId", + "Logins", + "LoginsToRemove" + ], + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "Logins":{ + "shape":"LoginsMap", + "documentation":"

A set of optional name-value pairs that map provider names to provider tokens.

" + }, + "LoginsToRemove":{ + "shape":"LoginsList", + "documentation":"

Provider names to unlink from this identity.

" + } + }, + "documentation":"

Input to the UnlinkIdentity action.

" + }, + "UnprocessedIdentityId":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"

A unique identifier in the format REGION:GUID.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code indicating the type of error that occurred.

" + } + }, + "documentation":"

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

" + }, + "UnprocessedIdentityIdList":{ + "type":"list", + "member":{"shape":"UnprocessedIdentityId"}, + "max":60 + }, + "UntagResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ARNString", + "documentation":"

The Amazon Resource Name (ARN) of the identity pool that the tags are assigned to.

" + }, + "TagKeys":{ + "shape":"IdentityPoolTagsListType", + "documentation":"

The keys of the tags to remove from the user pool.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"Amazon Cognito Federated Identities

Amazon Cognito Federated Identities is a web service that delivers scoped temporary credentials to mobile devices and other untrusted environments. It uniquely identifies a device and supplies the user with a consistent identity over the lifetime of an application.

Using Amazon Cognito Federated Identities, you can enable authentication with one or more third-party identity providers (Facebook, Google, or Login with Amazon) or an Amazon Cognito user pool, and you can also choose to support unauthenticated access from your app. Cognito delivers a unique identifier for each user and acts as an OpenID token provider trusted by AWS Security Token Service (STS) to access temporary, limited-privilege AWS credentials.

For a description of the authentication flow from the Amazon Cognito Developer Guide see Authentication Flow.

For more information see Amazon Cognito Federated Identities.

" +} diff --git a/aws/dist/botocore/data/cognito-idp/2016-04-18/examples-1.json b/aws/dist/botocore/data/cognito-idp/2016-04-18/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cognito-idp/2016-04-18/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cognito-idp/2016-04-18/paginators-1.json b/aws/dist/botocore/data/cognito-idp/2016-04-18/paginators-1.json new file mode 100644 index 00000000..51b7c94d --- /dev/null +++ b/aws/dist/botocore/data/cognito-idp/2016-04-18/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "AdminListGroupsForUser": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Groups" + }, + "AdminListUserAuthEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AuthEvents" + }, + "ListGroups": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Groups" + }, + "ListIdentityProviders": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Providers" + }, + "ListResourceServers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ResourceServers" + }, + "ListUserPoolClients": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserPoolClients" + }, + "ListUserPools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserPools" + }, + "ListUsersInGroup": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Users" + }, + "ListUsers": { + "input_token": "PaginationToken", + "limit_key": "Limit", + "output_token": "PaginationToken", + "result_key": "Users" + } + } +} diff --git a/aws/dist/botocore/data/cognito-idp/2016-04-18/service-2.json b/aws/dist/botocore/data/cognito-idp/2016-04-18/service-2.json new file mode 100644 index 00000000..79ffb3b7 --- /dev/null +++ b/aws/dist/botocore/data/cognito-idp/2016-04-18/service-2.json @@ -0,0 +1,7970 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-04-18", + "endpointPrefix":"cognito-idp", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Cognito Identity Provider", + "serviceId":"Cognito Identity Provider", + "signatureVersion":"v4", + "targetPrefix":"AWSCognitoIdentityProviderService", + "uid":"cognito-idp-2016-04-18" + }, + "operations":{ + "AddCustomAttributes":{ + "name":"AddCustomAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddCustomAttributesRequest"}, + "output":{"shape":"AddCustomAttributesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserImportInProgressException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Adds additional user attributes to the user pool schema.

" + }, + "AdminAddUserToGroup":{ + "name":"AdminAddUserToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminAddUserToGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Adds the specified user to the specified group.

Calling this action requires developer credentials.

" + }, + "AdminConfirmSignUp":{ + "name":"AdminConfirmSignUp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminConfirmSignUpRequest"}, + "output":{"shape":"AdminConfirmSignUpResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyFailedAttemptsException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Confirms user registration as an admin without using a confirmation code. Works on any user.

Calling this action requires developer credentials.

" + }, + "AdminCreateUser":{ + "name":"AdminCreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminCreateUserRequest"}, + "output":{"shape":"AdminCreateUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UsernameExistsException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UnsupportedUserStateException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates a new user in the specified user pool.

If MessageAction is not set, the default is to send a welcome message via email or phone (SMS).

This message is based on a template that you configured in your call to or . This template includes your custom sign-up instructions and placeholders for user name and temporary password.

Alternatively, you can call AdminCreateUser with “SUPPRESS” for the MessageAction parameter, and Amazon Cognito will not send any email.

In either case, the user will be in the FORCE_CHANGE_PASSWORD state until they sign in and change their password.

AdminCreateUser requires developer credentials.

" + }, + "AdminDeleteUser":{ + "name":"AdminDeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminDeleteUserRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes a user as an administrator. Works on any user.

Calling this action requires developer credentials.

" + }, + "AdminDeleteUserAttributes":{ + "name":"AdminDeleteUserAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminDeleteUserAttributesRequest"}, + "output":{"shape":"AdminDeleteUserAttributesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes the user attributes in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

" + }, + "AdminDisableProviderForUser":{ + "name":"AdminDisableProviderForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminDisableProviderForUserRequest"}, + "output":{"shape":"AdminDisableProviderForUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"AliasExistsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Disables the user from signing in with the specified external (SAML or social) identity provider. If the user to disable is a Cognito User Pools native username + password user, they are not permitted to use their password to sign-in. If the user to disable is a linked external IdP user, any link between that user and an existing user is removed. The next time the external user (no longer attached to the previously linked DestinationUser) signs in, they must create a new user account. See .

This action is enabled only for admin access and requires developer credentials.

The ProviderName must match the value specified when creating an IdP for the pool.

To disable a native username + password user, the ProviderName value must be Cognito and the ProviderAttributeName must be Cognito_Subject, with the ProviderAttributeValue being the name that is used in the user pool for the user.

The ProviderAttributeName must always be Cognito_Subject for social identity providers. The ProviderAttributeValue must always be the exact subject that was used when the user was originally linked as a source user.

For de-linking a SAML identity, there are two scenarios. If the linked identity has not yet been used to sign-in, the ProviderAttributeName and ProviderAttributeValue must be the same values that were used for the SourceUser when the identities were originally linked in the call. (If the linking was done with ProviderAttributeName set to Cognito_Subject, the same applies here). However, if the user has already signed in, the ProviderAttributeName must be Cognito_Subject and ProviderAttributeValue must be the subject of the SAML assertion.

" + }, + "AdminDisableUser":{ + "name":"AdminDisableUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminDisableUserRequest"}, + "output":{"shape":"AdminDisableUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Disables the specified user.

Calling this action requires developer credentials.

" + }, + "AdminEnableUser":{ + "name":"AdminEnableUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminEnableUserRequest"}, + "output":{"shape":"AdminEnableUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Enables the specified user as an administrator. Works on any user.

Calling this action requires developer credentials.

" + }, + "AdminForgetDevice":{ + "name":"AdminForgetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminForgetDeviceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Forgets the device, as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminGetDevice":{ + "name":"AdminGetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminGetDeviceRequest"}, + "output":{"shape":"AdminGetDeviceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Gets the device, as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminGetUser":{ + "name":"AdminGetUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminGetUserRequest"}, + "output":{"shape":"AdminGetUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

" + }, + "AdminInitiateAuth":{ + "name":"AdminInitiateAuth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminInitiateAuthRequest"}, + "output":{"shape":"AdminInitiateAuthResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"MFAMethodNotFoundException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"} + ], + "documentation":"

Initiates the authentication flow, as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminLinkProviderForUser":{ + "name":"AdminLinkProviderForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminLinkProviderForUserRequest"}, + "output":{"shape":"AdminLinkProviderForUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"AliasExistsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Links an existing user account in a user pool (DestinationUser) to an identity from an external identity provider (SourceUser) based on a specified attribute name and value from the external identity provider. This allows you to create a link from the existing user account to an external federated user identity that has not yet been used to sign in, so that the federated user identity can be used to sign in as the existing user account.

For example, if there is an existing user with a username and password, this API links that user to a federated user identity, so that when the federated user identity is used, the user signs in as the existing user account.

Because this API allows a user with an external federated identity to sign in as an existing user in the user pool, it is critical that it only be used with external identity providers and provider attributes that have been trusted by the application owner.

See also .

This action is enabled only for admin access and requires developer credentials.

" + }, + "AdminListDevices":{ + "name":"AdminListDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminListDevicesRequest"}, + "output":{"shape":"AdminListDevicesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Lists devices, as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminListGroupsForUser":{ + "name":"AdminListGroupsForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminListGroupsForUserRequest"}, + "output":{"shape":"AdminListGroupsForUserResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the groups that the user belongs to.

Calling this action requires developer credentials.

" + }, + "AdminListUserAuthEvents":{ + "name":"AdminListUserAuthEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminListUserAuthEventsRequest"}, + "output":{"shape":"AdminListUserAuthEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserPoolAddOnNotEnabledException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists a history of user activity and any risks detected as part of Amazon Cognito advanced security.

" + }, + "AdminRemoveUserFromGroup":{ + "name":"AdminRemoveUserFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminRemoveUserFromGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Removes the specified user from the specified group.

Calling this action requires developer credentials.

" + }, + "AdminResetUserPassword":{ + "name":"AdminResetUserPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminResetUserPasswordRequest"}, + "output":{"shape":"AdminResetUserPasswordResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Resets the specified user's password in a user pool as an administrator. Works on any user.

When a developer calls this API, the current password is invalidated, so it must be changed. If a user tries to sign in after the API is called, the app will get a PasswordResetRequiredException exception back and should direct the user down the flow to reset the password, which is the same as the forgot password flow. In addition, if the user pool has phone verification selected and a verified phone number exists for the user, or if email verification is selected and a verified email exists for the user, calling this API will also result in sending a message to the end user with the code to change their password.

Calling this action requires developer credentials.

" + }, + "AdminRespondToAuthChallenge":{ + "name":"AdminRespondToAuthChallenge", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminRespondToAuthChallengeRequest"}, + "output":{"shape":"AdminRespondToAuthChallengeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"InternalErrorException"}, + {"shape":"MFAMethodNotFoundException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"AliasExistsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"SoftwareTokenMFANotFoundException"} + ], + "documentation":"

Responds to an authentication challenge, as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminSetUserMFAPreference":{ + "name":"AdminSetUserMFAPreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminSetUserMFAPreferenceRequest"}, + "output":{"shape":"AdminSetUserMFAPreferenceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Sets the user's multi-factor authentication (MFA) preference, including which MFA options are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

" + }, + "AdminSetUserPassword":{ + "name":"AdminSetUserPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminSetUserPasswordRequest"}, + "output":{"shape":"AdminSetUserPasswordResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"

Sets the specified user's password in a user pool as an administrator. Works on any user.

The password can be temporary or permanent. If it is temporary, the user status will be placed into the FORCE_CHANGE_PASSWORD state. When the user next tries to sign in, the InitiateAuth/AdminInitiateAuth response will contain the NEW_PASSWORD_REQUIRED challenge. If the user does not sign in before it expires, the user will not be able to sign in and their password will need to be reset by an administrator.

Once the user has set a new password, or the password is permanent, the user status will be set to Confirmed.

" + }, + "AdminSetUserSettings":{ + "name":"AdminSetUserSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminSetUserSettingsRequest"}, + "output":{"shape":"AdminSetUserSettingsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the AdminSetUserMFAPreference action instead.

" + }, + "AdminUpdateAuthEventFeedback":{ + "name":"AdminUpdateAuthEventFeedback", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminUpdateAuthEventFeedbackRequest"}, + "output":{"shape":"AdminUpdateAuthEventFeedbackResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserPoolAddOnNotEnabledException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Provides feedback for an authentication event as to whether it was from a valid user. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

" + }, + "AdminUpdateDeviceStatus":{ + "name":"AdminUpdateDeviceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminUpdateDeviceStatusRequest"}, + "output":{"shape":"AdminUpdateDeviceStatusResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the device status as an administrator.

Calling this action requires developer credentials.

" + }, + "AdminUpdateUserAttributes":{ + "name":"AdminUpdateUserAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminUpdateUserAttributesRequest"}, + "output":{"shape":"AdminUpdateUserAttributesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"AliasExistsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"} + ], + "documentation":"

Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.

For custom attributes, you must prepend the custom: prefix to the attribute name.

In addition to updating user attributes, this API can also be used to mark phone and email as verified.

Calling this action requires developer credentials.

" + }, + "AdminUserGlobalSignOut":{ + "name":"AdminUserGlobalSignOut", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdminUserGlobalSignOutRequest"}, + "output":{"shape":"AdminUserGlobalSignOutResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Signs out users from all devices, as an administrator.

Calling this action requires developer credentials.

" + }, + "AssociateSoftwareToken":{ + "name":"AssociateSoftwareToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSoftwareTokenRequest"}, + "output":{"shape":"AssociateSoftwareTokenResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"SoftwareTokenMFANotFoundException"} + ], + "documentation":"

Returns a unique generated shared secret key code for the user account. The request takes an access token or a session string, but not both.

" + }, + "ChangePassword":{ + "name":"ChangePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangePasswordRequest"}, + "output":{"shape":"ChangePasswordResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Changes the password for a specified user in a user pool.

", + "authtype":"none" + }, + "ConfirmDevice":{ + "name":"ConfirmDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmDeviceRequest"}, + "output":{"shape":"ConfirmDeviceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"UsernameExistsException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Confirms tracking of the device. This API call is the call that begins device tracking.

" + }, + "ConfirmForgotPassword":{ + "name":"ConfirmForgotPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmForgotPasswordRequest"}, + "output":{"shape":"ConfirmForgotPasswordResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"TooManyFailedAttemptsException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Allows a user to enter a confirmation code to reset a forgotten password.

", + "authtype":"none" + }, + "ConfirmSignUp":{ + "name":"ConfirmSignUp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmSignUpRequest"}, + "output":{"shape":"ConfirmSignUpResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyFailedAttemptsException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"AliasExistsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Confirms registration of a user and handles the existing alias from a previous user.

", + "authtype":"none" + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{"shape":"CreateGroupResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"GroupExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates a new group in the specified user pool.

Calling this action requires developer credentials.

" + }, + "CreateIdentityProvider":{ + "name":"CreateIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIdentityProviderRequest"}, + "output":{"shape":"CreateIdentityProviderResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"DuplicateProviderException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates an identity provider for a user pool.

" + }, + "CreateResourceServer":{ + "name":"CreateResourceServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceServerRequest"}, + "output":{"shape":"CreateResourceServerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates a new OAuth2.0 resource server and defines custom scopes in it.

" + }, + "CreateUserImportJob":{ + "name":"CreateUserImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserImportJobRequest"}, + "output":{"shape":"CreateUserImportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates the user import job.

" + }, + "CreateUserPool":{ + "name":"CreateUserPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserPoolRequest"}, + "output":{"shape":"CreateUserPoolResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserPoolTaggingException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates a new Amazon Cognito user pool and sets the password policy for the pool.

" + }, + "CreateUserPoolClient":{ + "name":"CreateUserPoolClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserPoolClientRequest"}, + "output":{"shape":"CreateUserPoolClientResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ScopeDoesNotExistException"}, + {"shape":"InvalidOAuthFlowException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates the user pool client.

" + }, + "CreateUserPoolDomain":{ + "name":"CreateUserPoolDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserPoolDomainRequest"}, + "output":{"shape":"CreateUserPoolDomainResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Creates a new domain for a user pool.

" + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes a group. Currently only groups with no members can be deleted.

Calling this action requires developer credentials.

" + }, + "DeleteIdentityProvider":{ + "name":"DeleteIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityProviderRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedIdentityProviderException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes an identity provider for a user pool.

" + }, + "DeleteResourceServer":{ + "name":"DeleteResourceServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceServerRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes a resource server.

" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Allows a user to delete himself or herself.

", + "authtype":"none" + }, + "DeleteUserAttributes":{ + "name":"DeleteUserAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserAttributesRequest"}, + "output":{"shape":"DeleteUserAttributesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes the attributes for a user.

", + "authtype":"none" + }, + "DeleteUserPool":{ + "name":"DeleteUserPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPoolRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserImportInProgressException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes the specified Amazon Cognito user pool.

" + }, + "DeleteUserPoolClient":{ + "name":"DeleteUserPoolClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPoolClientRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Allows the developer to delete the user pool client.

" + }, + "DeleteUserPoolDomain":{ + "name":"DeleteUserPoolDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPoolDomainRequest"}, + "output":{"shape":"DeleteUserPoolDomainResponse"}, + "errors":[ + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes a domain for a user pool.

" + }, + "DescribeIdentityProvider":{ + "name":"DescribeIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityProviderRequest"}, + "output":{"shape":"DescribeIdentityProviderResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets information about a specific identity provider.

" + }, + "DescribeResourceServer":{ + "name":"DescribeResourceServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceServerRequest"}, + "output":{"shape":"DescribeResourceServerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Describes a resource server.

" + }, + "DescribeRiskConfiguration":{ + "name":"DescribeRiskConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRiskConfigurationRequest"}, + "output":{"shape":"DescribeRiskConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserPoolAddOnNotEnabledException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Describes the risk configuration.

" + }, + "DescribeUserImportJob":{ + "name":"DescribeUserImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserImportJobRequest"}, + "output":{"shape":"DescribeUserImportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Describes the user import job.

" + }, + "DescribeUserPool":{ + "name":"DescribeUserPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserPoolRequest"}, + "output":{"shape":"DescribeUserPoolResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserPoolTaggingException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns the configuration information and metadata of the specified user pool.

" + }, + "DescribeUserPoolClient":{ + "name":"DescribeUserPoolClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserPoolClientRequest"}, + "output":{"shape":"DescribeUserPoolClientResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Client method for returning the configuration information and metadata of the specified user pool app client.

" + }, + "DescribeUserPoolDomain":{ + "name":"DescribeUserPoolDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserPoolDomainRequest"}, + "output":{"shape":"DescribeUserPoolDomainResponse"}, + "errors":[ + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets information about a domain.

" + }, + "ForgetDevice":{ + "name":"ForgetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ForgetDeviceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Forgets the specified device.

" + }, + "ForgotPassword":{ + "name":"ForgotPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ForgotPasswordRequest"}, + "output":{"shape":"ForgotPasswordResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the Username parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, InvalidParameterException is thrown. To use the confirmation code for resetting the password, call .

", + "authtype":"none" + }, + "GetCSVHeader":{ + "name":"GetCSVHeader", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCSVHeaderRequest"}, + "output":{"shape":"GetCSVHeaderResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the header information for the .csv file to be used as input for the user import job.

" + }, + "GetDevice":{ + "name":"GetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeviceRequest"}, + "output":{"shape":"GetDeviceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the device.

" + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{"shape":"GetGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets a group.

Calling this action requires developer credentials.

" + }, + "GetIdentityProviderByIdentifier":{ + "name":"GetIdentityProviderByIdentifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityProviderByIdentifierRequest"}, + "output":{"shape":"GetIdentityProviderByIdentifierResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the specified identity provider.

" + }, + "GetSigningCertificate":{ + "name":"GetSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSigningCertificateRequest"}, + "output":{"shape":"GetSigningCertificateResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

This method takes a user pool ID, and returns the signing certificate.

" + }, + "GetUICustomization":{ + "name":"GetUICustomization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUICustomizationRequest"}, + "output":{"shape":"GetUICustomizationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the UI Customization information for a particular app client's app UI, if there is something set. If nothing is set for the particular client, but there is an existing pool level customization (app clientId will be ALL), then that is returned. If nothing is present, then an empty shape is returned.

" + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserRequest"}, + "output":{"shape":"GetUserResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the user attributes and metadata for a user.

", + "authtype":"none" + }, + "GetUserAttributeVerificationCode":{ + "name":"GetUserAttributeVerificationCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserAttributeVerificationCodeRequest"}, + "output":{"shape":"GetUserAttributeVerificationCodeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"LimitExceededException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the user attribute verification code for the specified attribute name.

", + "authtype":"none" + }, + "GetUserPoolMfaConfig":{ + "name":"GetUserPoolMfaConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserPoolMfaConfigRequest"}, + "output":{"shape":"GetUserPoolMfaConfigResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Gets the user pool multi-factor authentication (MFA) configuration.

" + }, + "GlobalSignOut":{ + "name":"GlobalSignOut", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GlobalSignOutRequest"}, + "output":{"shape":"GlobalSignOutResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Signs out users from all devices.

" + }, + "InitiateAuth":{ + "name":"InitiateAuth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InitiateAuthRequest"}, + "output":{"shape":"InitiateAuthResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"} + ], + "documentation":"

Initiates the authentication flow.

" + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the devices.

" + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{"shape":"ListGroupsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the groups associated with a user pool.

Calling this action requires developer credentials.

" + }, + "ListIdentityProviders":{ + "name":"ListIdentityProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIdentityProvidersRequest"}, + "output":{"shape":"ListIdentityProvidersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists information about all identity providers for a user pool.

" + }, + "ListResourceServers":{ + "name":"ListResourceServers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceServersRequest"}, + "output":{"shape":"ListResourceServersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the resource servers for a user pool.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the tags that are assigned to an Amazon Cognito user pool.

A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

You can use this action up to 10 times per second, per account.

" + }, + "ListUserImportJobs":{ + "name":"ListUserImportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserImportJobsRequest"}, + "output":{"shape":"ListUserImportJobsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the user import jobs.

" + }, + "ListUserPoolClients":{ + "name":"ListUserPoolClients", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserPoolClientsRequest"}, + "output":{"shape":"ListUserPoolClientsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the clients that have been created for the specified user pool.

" + }, + "ListUserPools":{ + "name":"ListUserPools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserPoolsRequest"}, + "output":{"shape":"ListUserPoolsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the user pools associated with an AWS account.

" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the users in the Amazon Cognito user pool.

" + }, + "ListUsersInGroup":{ + "name":"ListUsersInGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersInGroupRequest"}, + "output":{"shape":"ListUsersInGroupResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the users in the specified group.

Calling this action requires developer credentials.

" + }, + "ResendConfirmationCode":{ + "name":"ResendConfirmationCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResendConfirmationCodeRequest"}, + "output":{"shape":"ResendConfirmationCodeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Resends the confirmation (for confirmation of registration) to a specific user in the user pool.

", + "authtype":"none" + }, + "RespondToAuthChallenge":{ + "name":"RespondToAuthChallenge", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondToAuthChallengeRequest"}, + "output":{"shape":"RespondToAuthChallengeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"MFAMethodNotFoundException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"AliasExistsException"}, + {"shape":"InternalErrorException"}, + {"shape":"SoftwareTokenMFANotFoundException"} + ], + "documentation":"

Responds to the authentication challenge.

" + }, + "SetRiskConfiguration":{ + "name":"SetRiskConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetRiskConfigurationRequest"}, + "output":{"shape":"SetRiskConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserPoolAddOnNotEnabledException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Configures actions on detected risks. To delete the risk configuration for UserPoolId or ClientId, pass null values for all four configuration types.

To enable Amazon Cognito advanced security features, update the user pool to include the UserPoolAddOns keyAdvancedSecurityMode.

See .

" + }, + "SetUICustomization":{ + "name":"SetUICustomization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetUICustomizationRequest"}, + "output":{"shape":"SetUICustomizationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Sets the UI customization information for a user pool's built-in app UI.

You can specify app UI customization settings for a single client (with a specific clientId) or for all clients (by setting the clientId to ALL). If you specify ALL, the default configuration will be used for every client that has no UI customization set previously. If you specify UI customization settings for a particular client, it will no longer fall back to the ALL configuration.

To use this API, your user pool must have a domain associated with it. Otherwise, there is no place to host the app's pages, and the service will throw an error.

" + }, + "SetUserMFAPreference":{ + "name":"SetUserMFAPreference", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetUserMFAPreferenceRequest"}, + "output":{"shape":"SetUserMFAPreferenceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are enabled and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are enabled. If multiple options are enabled and no preference is set, a challenge to choose an MFA option will be returned during sign in.

" + }, + "SetUserPoolMfaConfig":{ + "name":"SetUserPoolMfaConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetUserPoolMfaConfigRequest"}, + "output":{"shape":"SetUserPoolMfaConfigResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Set the user pool multi-factor authentication (MFA) configuration.

" + }, + "SetUserSettings":{ + "name":"SetUserSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetUserSettingsRequest"}, + "output":{"shape":"SetUserSettingsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure TOTP software token MFA. To configure either type of MFA, use the SetUserMFAPreference action instead.

", + "authtype":"none" + }, + "SignUp":{ + "name":"SignUp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SignUpRequest"}, + "output":{"shape":"SignUpResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"UsernameExistsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"CodeDeliveryFailureException"} + ], + "documentation":"

Registers the user in the specified user pool and creates a user name, password, and user attributes.

", + "authtype":"none" + }, + "StartUserImportJob":{ + "name":"StartUserImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartUserImportJobRequest"}, + "output":{"shape":"StartUserImportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Starts the user import.

" + }, + "StopUserImportJob":{ + "name":"StopUserImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopUserImportJobRequest"}, + "output":{"shape":"StopUserImportJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Stops the user import job.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Assigns a set of tags to an Amazon Cognito user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

Each tag consists of a key and value, both of which you define. A key is a general category for more specific values. For example, if you have two versions of a user pool, one for testing and another for production, you might assign an Environment tag key to both user pools. The value of this key might be Test for one user pool and Production for the other.

Tags are useful for cost tracking and access control. You can activate your tags so that they appear on the Billing and Cost Management console, where you can track the costs associated with your user pools. In an IAM policy, you can constrain permissions for user pools based on specific tags or tag values.

You can use this action up to 5 times per second, per account. A user pool can have as many as 50 tags.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Removes the specified tags from an Amazon Cognito user pool. You can use this action up to 5 times per second, per account

" + }, + "UpdateAuthEventFeedback":{ + "name":"UpdateAuthEventFeedback", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAuthEventFeedbackRequest"}, + "output":{"shape":"UpdateAuthEventFeedbackResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserPoolAddOnNotEnabledException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Provides the feedback for an authentication event whether it was from a valid user or not. This feedback is used for improving the risk evaluation decision for the user pool as part of Amazon Cognito advanced security.

" + }, + "UpdateDeviceStatus":{ + "name":"UpdateDeviceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDeviceStatusRequest"}, + "output":{"shape":"UpdateDeviceStatusResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the device status.

" + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "output":{"shape":"UpdateGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the specified group with the specified attributes.

Calling this action requires developer credentials.

" + }, + "UpdateIdentityProvider":{ + "name":"UpdateIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIdentityProviderRequest"}, + "output":{"shape":"UpdateIdentityProviderResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedIdentityProviderException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates identity provider information for a user pool.

" + }, + "UpdateResourceServer":{ + "name":"UpdateResourceServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResourceServerRequest"}, + "output":{"shape":"UpdateResourceServerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the name and scopes of resource server. All other fields are read-only.

" + }, + "UpdateUserAttributes":{ + "name":"UpdateUserAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserAttributesRequest"}, + "output":{"shape":"UpdateUserAttributesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UnexpectedLambdaException"}, + {"shape":"UserLambdaValidationException"}, + {"shape":"InvalidLambdaResponseException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AliasExistsException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"}, + {"shape":"CodeDeliveryFailureException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Allows a user to update a specific attribute (one at a time).

", + "authtype":"none" + }, + "UpdateUserPool":{ + "name":"UpdateUserPool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserPoolRequest"}, + "output":{"shape":"UpdateUserPoolResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UserImportInProgressException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidSmsRoleAccessPolicyException"}, + {"shape":"InvalidSmsRoleTrustRelationshipException"}, + {"shape":"UserPoolTaggingException"}, + {"shape":"InvalidEmailRoleAccessPolicyException"} + ], + "documentation":"

Updates the specified user pool with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool settings with .

" + }, + "UpdateUserPoolClient":{ + "name":"UpdateUserPoolClient", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserPoolClientRequest"}, + "output":{"shape":"UpdateUserPoolClientResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ScopeDoesNotExistException"}, + {"shape":"InvalidOAuthFlowException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the specified user pool app client with the specified attributes. If you don't provide a value for an attribute, it will be set to the default value. You can get a list of the current user pool app client settings with .

" + }, + "UpdateUserPoolDomain":{ + "name":"UpdateUserPoolDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserPoolDomainRequest"}, + "output":{"shape":"UpdateUserPoolDomainResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Updates the Secure Sockets Layer (SSL) certificate for the custom domain for your user pool.

You can use this operation to provide the Amazon Resource Name (ARN) of a new certificate to Amazon Cognito. You cannot use it to change the domain for a user pool.

A custom domain is used to host the Amazon Cognito hosted UI, which provides sign-up and sign-in pages for your application. When you set up a custom domain, you provide a certificate that you manage with AWS Certificate Manager (ACM). When necessary, you can use this operation to change the certificate that you applied to your custom domain.

Usually, this is unnecessary following routine certificate renewal with ACM. When you renew your existing certificate in ACM, the ARN for your certificate remains the same, and your custom domain uses the new certificate automatically.

However, if you replace your existing certificate with a new one, ACM gives the new certificate a new ARN. To apply the new certificate to your custom domain, you must provide this ARN to Amazon Cognito.

When you add your new certificate in ACM, you must choose US East (N. Virginia) as the AWS Region.

After you submit your request, Amazon Cognito requires up to 1 hour to distribute your new certificate to your custom domain.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" + }, + "VerifySoftwareToken":{ + "name":"VerifySoftwareToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifySoftwareTokenRequest"}, + "output":{"shape":"VerifySoftwareTokenResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidUserPoolConfigurationException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"}, + {"shape":"EnableSoftwareTokenMFAException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"SoftwareTokenMFANotFoundException"}, + {"shape":"CodeMismatchException"} + ], + "documentation":"

Use this API to register a user's entered TOTP code and mark the user's software token MFA status as \"verified\" if successful. The request takes an access token or a session string, but not both.

" + }, + "VerifyUserAttribute":{ + "name":"VerifyUserAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyUserAttributeRequest"}, + "output":{"shape":"VerifyUserAttributeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"CodeMismatchException"}, + {"shape":"ExpiredCodeException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"PasswordResetRequiredException"}, + {"shape":"UserNotFoundException"}, + {"shape":"UserNotConfirmedException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Verifies the specified user attributes in the user pool.

", + "authtype":"none" + } + }, + "shapes":{ + "AWSAccountIdType":{"type":"string"}, + "AccountTakeoverActionNotifyType":{"type":"boolean"}, + "AccountTakeoverActionType":{ + "type":"structure", + "required":[ + "Notify", + "EventAction" + ], + "members":{ + "Notify":{ + "shape":"AccountTakeoverActionNotifyType", + "documentation":"

Flag specifying whether to send a notification.

" + }, + "EventAction":{ + "shape":"AccountTakeoverEventActionType", + "documentation":"

The event action.

  • BLOCK Choosing this action will block the request.

  • MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

  • MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

  • NO_ACTION Allow the user sign-in.

" + } + }, + "documentation":"

Account takeover action type.

" + }, + "AccountTakeoverActionsType":{ + "type":"structure", + "members":{ + "LowAction":{ + "shape":"AccountTakeoverActionType", + "documentation":"

Action to take for a low risk.

" + }, + "MediumAction":{ + "shape":"AccountTakeoverActionType", + "documentation":"

Action to take for a medium risk.

" + }, + "HighAction":{ + "shape":"AccountTakeoverActionType", + "documentation":"

Action to take for a high risk.

" + } + }, + "documentation":"

Account takeover actions type.

" + }, + "AccountTakeoverEventActionType":{ + "type":"string", + "enum":[ + "BLOCK", + "MFA_IF_CONFIGURED", + "MFA_REQUIRED", + "NO_ACTION" + ] + }, + "AccountTakeoverRiskConfigurationType":{ + "type":"structure", + "required":["Actions"], + "members":{ + "NotifyConfiguration":{ + "shape":"NotifyConfigurationType", + "documentation":"

The notify configuration used to construct email notifications.

" + }, + "Actions":{ + "shape":"AccountTakeoverActionsType", + "documentation":"

Account takeover risk configuration actions

" + } + }, + "documentation":"

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

" + }, + "AddCustomAttributesRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "CustomAttributes" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to add custom attributes.

" + }, + "CustomAttributes":{ + "shape":"CustomAttributesListType", + "documentation":"

An array of custom attributes, such as Mutable and Name.

" + } + }, + "documentation":"

Represents the request to add custom attributes.

" + }, + "AddCustomAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server for the request to add custom attributes.

" + }, + "AdminAddUserToGroupRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "GroupName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The username for the user.

" + }, + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The group name.

" + } + } + }, + "AdminConfirmSignUpRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for which you want to confirm user registration.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name for which you want to confirm user registration.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

If your user pool configuration includes triggers, the AdminConfirmSignUp API action invokes the AWS Lambda function that is specified for the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. In this payload, the clientMetadata attribute provides the data that you assigned to the ClientMetadata parameter in your AdminConfirmSignUp request. In your function code in AWS Lambda, you can process the ClientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to confirm user registration.

" + }, + "AdminConfirmSignUpResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server for the request to confirm registration.

" + }, + "AdminCreateUserConfigType":{ + "type":"structure", + "members":{ + "AllowAdminCreateUserOnly":{ + "shape":"BooleanType", + "documentation":"

Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

" + }, + "UnusedAccountValidityDays":{ + "shape":"AdminCreateUserUnusedAccountValidityDaysType", + "documentation":"

The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

" + }, + "InviteMessageTemplate":{ + "shape":"MessageTemplateType", + "documentation":"

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

" + } + }, + "documentation":"

The configuration for creating a new user profile.

" + }, + "AdminCreateUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where the user will be created.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The username for the user. Must be unique within the user pool. Must be a UTF-8 string between 1 and 128 characters. After the user is created, the username cannot be changed.

" + }, + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in or in the Attributes tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).

For custom attributes, you must prepend the custom: prefix to the attribute name.

To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the Users tab of the Amazon Cognito console for managing your user pools.

In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You can also do this by calling .)

  • email: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.

  • phone_number: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.

" + }, + "ValidationData":{ + "shape":"AttributeListType", + "documentation":"

The user's validation data. This is an array of name-value pairs that contain user attributes and attribute values that you can use for custom validation, such as restricting the types of user accounts that can be registered. For example, you might choose to allow or disallow user sign-up based on the user's domain.

To configure custom validation, you must create a Pre Sign-up Lambda trigger for the user pool as described in the Amazon Cognito Developer Guide. The Lambda trigger receives the validation data and uses it in the validation process.

The user's validation data is not persisted.

" + }, + "TemporaryPassword":{ + "shape":"PasswordType", + "documentation":"

The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.

The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.

This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.

The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.

" + }, + "ForceAliasCreation":{ + "shape":"ForceAliasCreation", + "documentation":"

This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.

If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.

If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.

" + }, + "MessageAction":{ + "shape":"MessageActionType", + "documentation":"

Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.

" + }, + "DesiredDeliveryMediums":{ + "shape":"DeliveryMediumListType", + "documentation":"

Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminCreateUser API action, Amazon Cognito invokes the function that is assigned to the pre sign-up trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminCreateUser request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to create a user in the specified user pool.

" + }, + "AdminCreateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"UserType", + "documentation":"

The newly created user.

" + } + }, + "documentation":"

Represents the response from the server to the request to create the user.

" + }, + "AdminCreateUserUnusedAccountValidityDaysType":{ + "type":"integer", + "max":365, + "min":0 + }, + "AdminDeleteUserAttributesRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "UserAttributeNames" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to delete user attributes.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user from which you would like to delete attributes.

" + }, + "UserAttributeNames":{ + "shape":"AttributeNameListType", + "documentation":"

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + } + }, + "documentation":"

Represents the request to delete user attributes as an administrator.

" + }, + "AdminDeleteUserAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response received from the server for a request to delete user attributes.

" + }, + "AdminDeleteUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to delete the user.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to delete.

" + } + }, + "documentation":"

Represents the request to delete a user as an administrator.

" + }, + "AdminDisableProviderForUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "User" + ], + "members":{ + "UserPoolId":{ + "shape":"StringType", + "documentation":"

The user pool ID for the user pool.

" + }, + "User":{ + "shape":"ProviderUserIdentifierType", + "documentation":"

The user to be disabled.

" + } + } + }, + "AdminDisableProviderForUserResponse":{ + "type":"structure", + "members":{ + } + }, + "AdminDisableUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to disable the user.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to disable.

" + } + }, + "documentation":"

Represents the request to disable any user as an administrator.

" + }, + "AdminDisableUserResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response received from the server to disable the user as an administrator.

" + }, + "AdminEnableUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to enable the user.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to enable.

" + } + }, + "documentation":"

Represents the request that enables the user as an administrator.

" + }, + "AdminEnableUserResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server for the request to enable a user as an administrator.

" + }, + "AdminForgetDeviceRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "DeviceKey" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name.

" + }, + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + } + }, + "documentation":"

Sends the forgot device request, as an administrator.

" + }, + "AdminGetDeviceRequest":{ + "type":"structure", + "required":[ + "DeviceKey", + "UserPoolId", + "Username" + ], + "members":{ + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name.

" + } + }, + "documentation":"

Represents the request to get the device, as an administrator.

" + }, + "AdminGetDeviceResponse":{ + "type":"structure", + "required":["Device"], + "members":{ + "Device":{ + "shape":"DeviceType", + "documentation":"

The device.

" + } + }, + "documentation":"

Gets the device response, as an administrator.

" + }, + "AdminGetUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to get information about the user.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to retrieve.

" + } + }, + "documentation":"

Represents the request to get the specified user as an administrator.

" + }, + "AdminGetUserResponse":{ + "type":"structure", + "required":["Username"], + "members":{ + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user about whom you are receiving information.

" + }, + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs representing user attributes.

" + }, + "UserCreateDate":{ + "shape":"DateType", + "documentation":"

The date the user was created.

" + }, + "UserLastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the user was last modified.

" + }, + "Enabled":{ + "shape":"BooleanType", + "documentation":"

Indicates that the status is enabled.

" + }, + "UserStatus":{ + "shape":"UserStatusType", + "documentation":"

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

" + }, + "MFAOptions":{ + "shape":"MFAOptionListType", + "documentation":"

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.

" + }, + "PreferredMfaSetting":{ + "shape":"StringType", + "documentation":"

The user's preferred MFA setting.

" + }, + "UserMFASettingList":{ + "shape":"UserMFASettingListType", + "documentation":"

The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

" + } + }, + "documentation":"

Represents the response from the server from the request to get the specified user as an administrator.

" + }, + "AdminInitiateAuthRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientId", + "AuthFlow" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The ID of the Amazon Cognito user pool.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + }, + "AuthFlow":{ + "shape":"AuthFlowType", + "documentation":"

The authentication flow for this call to execute. The API action will depend on this value. For example:

  • REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

  • USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

  • USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

  • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

  • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

  • CUSTOM_AUTH: Custom authentication flow.

  • ADMIN_NO_SRP_AUTH: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.

  • USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

" + }, + "AuthParameters":{ + "shape":"AuthParametersType", + "documentation":"

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

  • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

  • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

  • For ADMIN_NO_SRP_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), PASSWORD (required), DEVICE_KEY

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminInitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

  • Pre signup

  • Pre authentication

  • User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminInitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the AdminInitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:

  • Post authentication

  • Custom message

  • Pre token generation

  • Create auth challenge

  • Define auth challenge

  • Verify auth challenge

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The analytics metadata for collecting Amazon Pinpoint metrics for AdminInitiateAuth calls.

" + }, + "ContextData":{ + "shape":"ContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + } + }, + "documentation":"

Initiates the authorization request, as an administrator.

" + }, + "AdminInitiateAuthResponse":{ + "type":"structure", + "members":{ + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge.

  • MFA_SETUP: If MFA is required, users who do not have at least one of the MFA methods set up are presented with an MFA_SETUP challenge. The user must set up at least one MFA type to continue to authenticate.

  • SELECT_MFA_TYPE: Selects the MFA type. Valid MFA options are SMS_MFA for text SMS MFA, and SOFTWARE_TOKEN_MFA for TOTP software token MFA.

  • SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

  • PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

  • CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

  • DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

  • DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

  • ADMIN_NO_SRP_AUTH: This is returned if you need to authenticate with USERNAME and PASSWORD directly. An app client must be enabled to use this flow.

  • NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If AdminInitiateAuth or AdminRespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next AdminRespondToAuthChallenge API call.

" + }, + "ChallengeParameters":{ + "shape":"ChallengeParametersType", + "documentation":"

The challenge parameters. These are returned to you in the AdminInitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (AdminRespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

The value of the USER_ID_FOR_SRP attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to AdminInitiateAuth. This is because, in the AdminRespondToAuthChallenge API ChallengeResponses, the USERNAME attribute cannot be an alias.

" + }, + "AuthenticationResult":{ + "shape":"AuthenticationResultType", + "documentation":"

The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

" + } + }, + "documentation":"

Initiates the authentication response, as an administrator.

" + }, + "AdminLinkProviderForUserRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "DestinationUser", + "SourceUser" + ], + "members":{ + "UserPoolId":{ + "shape":"StringType", + "documentation":"

The user pool ID for the user pool.

" + }, + "DestinationUser":{ + "shape":"ProviderUserIdentifierType", + "documentation":"

The existing user in the user pool to be linked to the external identity provider user account. Can be a native (Username + Password) Cognito User Pools user or a federated user (for example, a SAML or Facebook user). If the user doesn't exist, an exception is thrown. This is the user that is returned when the new user (with the linked identity provider attribute) signs in.

For a native username + password user, the ProviderAttributeValue for the DestinationUser should be the username in the user pool. For a federated user, it should be the provider-specific user_id.

The ProviderAttributeName of the DestinationUser is ignored.

The ProviderName should be set to Cognito for users in Cognito user pools.

" + }, + "SourceUser":{ + "shape":"ProviderUserIdentifierType", + "documentation":"

An external identity provider account for a user who does not currently exist yet in the user pool. This user must be a federated user (for example, a SAML or Facebook user), not another native user.

If the SourceUser is a federated social identity provider user (Facebook, Google, or Login with Amazon), you must set the ProviderAttributeName to Cognito_Subject. For social identity providers, the ProviderName will be Facebook, Google, or LoginWithAmazon, and Cognito will automatically parse the Facebook, Google, and Login with Amazon tokens for id, sub, and user_id, respectively. The ProviderAttributeValue for the user must be the same value as the id, sub, or user_id value found in the social identity provider token.

For SAML, the ProviderAttributeName can be any value that matches a claim in the SAML assertion. If you wish to link SAML users based on the subject of the SAML assertion, you should map the subject to a claim through the SAML identity provider and submit that claim name as the ProviderAttributeName. If you set ProviderAttributeName to Cognito_Subject, Cognito will automatically parse the default unique identifier found in the subject from the SAML token.

" + } + } + }, + "AdminLinkProviderForUserResponse":{ + "type":"structure", + "members":{ + } + }, + "AdminListDevicesRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

The limit of the devices request.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Represents the request to list devices, as an administrator.

" + }, + "AdminListDevicesResponse":{ + "type":"structure", + "members":{ + "Devices":{ + "shape":"DeviceListType", + "documentation":"

The devices in the list of devices response.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

The pagination token.

" + } + }, + "documentation":"

Lists the device's response, as an administrator.

" + }, + "AdminListGroupsForUserRequest":{ + "type":"structure", + "required":[ + "Username", + "UserPoolId" + ], + "members":{ + "Username":{ + "shape":"UsernameType", + "documentation":"

The username for the user.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

The limit of the request to list groups.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "AdminListGroupsForUserResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupListType", + "documentation":"

The groups that the user belongs to.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "AdminListUserAuthEventsRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user pool username or an alias.

" + }, + "MaxResults":{ + "shape":"QueryLimitType", + "documentation":"

The maximum number of authentication events to return.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + } + } + }, + "AdminListUserAuthEventsResponse":{ + "type":"structure", + "members":{ + "AuthEvents":{ + "shape":"AuthEventsType", + "documentation":"

The response object. It includes the EventID, EventType, CreationDate, EventRisk, and EventResponse.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

A pagination token.

" + } + } + }, + "AdminRemoveUserFromGroupRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "GroupName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The username for the user.

" + }, + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The group name.

" + } + } + }, + "AdminResetUserPasswordRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to reset the user's password.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user whose password you wish to reset.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminResetUserPassword API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminResetUserPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to reset a user's password as an administrator.

" + }, + "AdminResetUserPasswordResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server to reset a user password as an administrator.

" + }, + "AdminRespondToAuthChallengeRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientId", + "ChallengeName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The ID of the Amazon Cognito user pool.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + }, + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The challenge name. For more information, see .

" + }, + "ChallengeResponses":{ + "shape":"ChallengeResponsesType", + "documentation":"

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

  • SMS_MFA: SMS_MFA_CODE, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • ADMIN_NO_SRP_AUTH: PASSWORD, USERNAME, SECRET_HASH (if app client is configured with client secret).

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME, SECRET_HASH (if app client is configured with client secret).

The value of the USERNAME attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the AdminInitiateAuth response includes the actual username value in the USERNAMEUSER_ID_FOR_SRP attribute, even if you specified an alias in your call to AdminInitiateAuth.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The analytics metadata for collecting Amazon Pinpoint metrics for AdminRespondToAuthChallenge calls.

" + }, + "ContextData":{ + "shape":"ContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminRespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, post authentication, user migration, pre token generation, define auth challenge, create auth challenge, and verify auth challenge response. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminRespondToAuthChallenge request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

The request to respond to the authentication challenge, as an administrator.

" + }, + "AdminRespondToAuthChallengeResponse":{ + "type":"structure", + "members":{ + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The name of the challenge. For more information, see .

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

" + }, + "ChallengeParameters":{ + "shape":"ChallengeParametersType", + "documentation":"

The challenge parameters. For more information, see .

" + }, + "AuthenticationResult":{ + "shape":"AuthenticationResultType", + "documentation":"

The result returned by the server in response to the authentication request.

" + } + }, + "documentation":"

Responds to the authentication challenge, as an administrator.

" + }, + "AdminSetUserMFAPreferenceRequest":{ + "type":"structure", + "required":[ + "Username", + "UserPoolId" + ], + "members":{ + "SMSMfaSettings":{ + "shape":"SMSMfaSettingsType", + "documentation":"

The SMS text message MFA settings.

" + }, + "SoftwareTokenMfaSettings":{ + "shape":"SoftwareTokenMfaSettingsType", + "documentation":"

The time-based one-time password software token MFA settings.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user pool username or alias.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + } + } + }, + "AdminSetUserMFAPreferenceResponse":{ + "type":"structure", + "members":{ + } + }, + "AdminSetUserPasswordRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "Password" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to set the user's password.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user whose password you wish to set.

" + }, + "Password":{ + "shape":"PasswordType", + "documentation":"

The password for the user.

" + }, + "Permanent":{ + "shape":"BooleanType", + "documentation":"

True if the password is permanent, False if it is temporary.

" + } + } + }, + "AdminSetUserPasswordResponse":{ + "type":"structure", + "members":{ + } + }, + "AdminSetUserSettingsRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "MFAOptions" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The ID of the user pool that contains the user that you are setting options for.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user that you are setting options for.

" + }, + "MFAOptions":{ + "shape":"MFAOptionListType", + "documentation":"

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

" + } + }, + "documentation":"

You can use this parameter to set an MFA configuration that uses the SMS delivery medium.

" + }, + "AdminSetUserSettingsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server to set user settings as an administrator.

" + }, + "AdminUpdateAuthEventFeedbackRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "EventId", + "FeedbackValue" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user pool username.

" + }, + "EventId":{ + "shape":"EventIdType", + "documentation":"

The authentication event ID.

" + }, + "FeedbackValue":{ + "shape":"FeedbackValueType", + "documentation":"

The authentication event feedback value.

" + } + } + }, + "AdminUpdateAuthEventFeedbackResponse":{ + "type":"structure", + "members":{ + } + }, + "AdminUpdateDeviceStatusRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "DeviceKey" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name.

" + }, + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "DeviceRememberedStatus":{ + "shape":"DeviceRememberedStatusType", + "documentation":"

The status indicating whether a device has been remembered or not.

" + } + }, + "documentation":"

The request to update the device status, as an administrator.

" + }, + "AdminUpdateDeviceStatusResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The status response from the request to update the device, as an administrator.

" + }, + "AdminUpdateUserAttributesRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "UserAttributes" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to update user attributes.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user for whom you want to update user attributes.

" + }, + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the AdminUpdateUserAttributes API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your AdminUpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to update the user's attributes as an administrator.

" + }, + "AdminUpdateUserAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server for the request to update user attributes as an administrator.

" + }, + "AdminUserGlobalSignOutRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name.

" + } + }, + "documentation":"

The request to sign out of all devices, as an administrator.

" + }, + "AdminUserGlobalSignOutResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The global sign-out response, as an administrator.

" + }, + "AdvancedSecurityModeType":{ + "type":"string", + "enum":[ + "OFF", + "AUDIT", + "ENFORCED" + ] + }, + "AliasAttributeType":{ + "type":"string", + "enum":[ + "phone_number", + "email", + "preferred_username" + ] + }, + "AliasAttributesListType":{ + "type":"list", + "member":{"shape":"AliasAttributeType"} + }, + "AliasExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message sent to the user when an alias exists.

" + } + }, + "documentation":"

This exception is thrown when a user tries to confirm the account with an email or phone number that has already been supplied as an alias from a different account. This exception tells user that an account with this email or phone already exists.

", + "exception":true + }, + "AnalyticsConfigurationType":{ + "type":"structure", + "required":[ + "ApplicationId", + "RoleArn", + "ExternalId" + ], + "members":{ + "ApplicationId":{ + "shape":"HexStringType", + "documentation":"

The application ID for an Amazon Pinpoint application.

" + }, + "RoleArn":{ + "shape":"ArnType", + "documentation":"

The ARN of an IAM role that authorizes Amazon Cognito to publish events to Amazon Pinpoint analytics.

" + }, + "ExternalId":{ + "shape":"StringType", + "documentation":"

The external ID.

" + }, + "UserDataShared":{ + "shape":"BooleanType", + "documentation":"

If UserDataShared is true, Amazon Cognito will include user data in the events it publishes to Amazon Pinpoint analytics.

" + } + }, + "documentation":"

The Amazon Pinpoint analytics configuration for collecting metrics for a user pool.

" + }, + "AnalyticsMetadataType":{ + "type":"structure", + "members":{ + "AnalyticsEndpointId":{ + "shape":"StringType", + "documentation":"

The endpoint ID.

" + } + }, + "documentation":"

An Amazon Pinpoint analytics endpoint.

An endpoint uniquely identifies a mobile device, email address, or phone number that can receive messages from Amazon Pinpoint analytics.

" + }, + "ArnType":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:([\\w+=/,.@-]*)?:[0-9]+:[\\w+=/,.@-]+(:[\\w+=/,.@-]+)?(:[\\w+=/,.@-]+)?" + }, + "AssociateSoftwareTokenRequest":{ + "type":"structure", + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

" + } + } + }, + "AssociateSoftwareTokenResponse":{ + "type":"structure", + "members":{ + "SecretCode":{ + "shape":"SecretCodeType", + "documentation":"

A unique generated shared secret code that is used in the TOTP algorithm to generate a one time code.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. This allows authentication of the user as part of the MFA setup process.

" + } + } + }, + "AttributeDataType":{ + "type":"string", + "enum":[ + "String", + "Number", + "DateTime", + "Boolean" + ] + }, + "AttributeListType":{ + "type":"list", + "member":{"shape":"AttributeType"} + }, + "AttributeMappingKeyType":{ + "type":"string", + "max":32, + "min":1 + }, + "AttributeMappingType":{ + "type":"map", + "key":{"shape":"AttributeMappingKeyType"}, + "value":{"shape":"StringType"} + }, + "AttributeNameListType":{ + "type":"list", + "member":{"shape":"AttributeNameType"} + }, + "AttributeNameType":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "AttributeType":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"AttributeNameType", + "documentation":"

The name of the attribute.

" + }, + "Value":{ + "shape":"AttributeValueType", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Specifies whether the attribute is standard or custom.

" + }, + "AttributeValueType":{ + "type":"string", + "max":2048, + "sensitive":true + }, + "AuthEventType":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"StringType", + "documentation":"

The event ID.

" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The creation date

" + }, + "EventResponse":{ + "shape":"EventResponseType", + "documentation":"

The event response.

" + }, + "EventRisk":{ + "shape":"EventRiskType", + "documentation":"

The event risk.

" + }, + "ChallengeResponses":{ + "shape":"ChallengeResponseListType", + "documentation":"

The challenge responses.

" + }, + "EventContextData":{ + "shape":"EventContextDataType", + "documentation":"

The user context data captured at the time of an event request. It provides additional information about the client from which event the request is received.

" + }, + "EventFeedback":{ + "shape":"EventFeedbackType", + "documentation":"

A flag specifying the user feedback captured at the time of an event request is good or bad.

" + } + }, + "documentation":"

The authentication event type.

" + }, + "AuthEventsType":{ + "type":"list", + "member":{"shape":"AuthEventType"} + }, + "AuthFlowType":{ + "type":"string", + "enum":[ + "USER_SRP_AUTH", + "REFRESH_TOKEN_AUTH", + "REFRESH_TOKEN", + "CUSTOM_AUTH", + "ADMIN_NO_SRP_AUTH", + "USER_PASSWORD_AUTH" + ] + }, + "AuthParametersType":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "AuthenticationResultType":{ + "type":"structure", + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + }, + "ExpiresIn":{ + "shape":"IntegerType", + "documentation":"

The expiration period of the authentication result in seconds.

" + }, + "TokenType":{ + "shape":"StringType", + "documentation":"

The token type.

" + }, + "RefreshToken":{ + "shape":"TokenModelType", + "documentation":"

The refresh token.

" + }, + "IdToken":{ + "shape":"TokenModelType", + "documentation":"

The ID token.

" + }, + "NewDeviceMetadata":{ + "shape":"NewDeviceMetadataType", + "documentation":"

The new device metadata from an authentication result.

" + } + }, + "documentation":"

The authentication result.

" + }, + "BlockedIPRangeListType":{ + "type":"list", + "member":{"shape":"StringType"}, + "max":20 + }, + "BooleanType":{"type":"boolean"}, + "CSSType":{"type":"string"}, + "CSSVersionType":{"type":"string"}, + "CallbackURLsListType":{ + "type":"list", + "member":{"shape":"RedirectUrlType"}, + "max":100, + "min":0 + }, + "ChallengeName":{ + "type":"string", + "enum":[ + "Password", + "Mfa" + ] + }, + "ChallengeNameType":{ + "type":"string", + "enum":[ + "SMS_MFA", + "SOFTWARE_TOKEN_MFA", + "SELECT_MFA_TYPE", + "MFA_SETUP", + "PASSWORD_VERIFIER", + "CUSTOM_CHALLENGE", + "DEVICE_SRP_AUTH", + "DEVICE_PASSWORD_VERIFIER", + "ADMIN_NO_SRP_AUTH", + "NEW_PASSWORD_REQUIRED" + ] + }, + "ChallengeParametersType":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "ChallengeResponse":{ + "type":"string", + "enum":[ + "Success", + "Failure" + ] + }, + "ChallengeResponseListType":{ + "type":"list", + "member":{"shape":"ChallengeResponseType"} + }, + "ChallengeResponseType":{ + "type":"structure", + "members":{ + "ChallengeName":{ + "shape":"ChallengeName", + "documentation":"

The challenge name

" + }, + "ChallengeResponse":{ + "shape":"ChallengeResponse", + "documentation":"

The challenge response.

" + } + }, + "documentation":"

The challenge response type.

" + }, + "ChallengeResponsesType":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "ChangePasswordRequest":{ + "type":"structure", + "required":[ + "PreviousPassword", + "ProposedPassword", + "AccessToken" + ], + "members":{ + "PreviousPassword":{ + "shape":"PasswordType", + "documentation":"

The old password.

" + }, + "ProposedPassword":{ + "shape":"PasswordType", + "documentation":"

The new password.

" + }, + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + } + }, + "documentation":"

Represents the request to change a user password.

" + }, + "ChangePasswordResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response from the server to the change password request.

" + }, + "ClientIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+]+", + "sensitive":true + }, + "ClientMetadataType":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "ClientNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w\\s+=,.@-]+" + }, + "ClientPermissionListType":{ + "type":"list", + "member":{"shape":"ClientPermissionType"} + }, + "ClientPermissionType":{ + "type":"string", + "max":2048, + "min":1 + }, + "ClientSecretType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+]+", + "sensitive":true + }, + "CodeDeliveryDetailsListType":{ + "type":"list", + "member":{"shape":"CodeDeliveryDetailsType"} + }, + "CodeDeliveryDetailsType":{ + "type":"structure", + "members":{ + "Destination":{ + "shape":"StringType", + "documentation":"

The destination for the code delivery details.

" + }, + "DeliveryMedium":{ + "shape":"DeliveryMediumType", + "documentation":"

The delivery medium (email message or phone number).

" + }, + "AttributeName":{ + "shape":"AttributeNameType", + "documentation":"

The attribute name.

" + } + }, + "documentation":"

The code delivery details being returned from the server.

" + }, + "CodeDeliveryFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message sent when a verification code fails to deliver successfully.

" + } + }, + "documentation":"

This exception is thrown when a verification code fails to deliver successfully.

", + "exception":true + }, + "CodeMismatchException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message provided when the code mismatch exception is thrown.

" + } + }, + "documentation":"

This exception is thrown if the provided code does not match what the server was expecting.

", + "exception":true + }, + "CompletionMessageType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w]+" + }, + "CompromisedCredentialsActionsType":{ + "type":"structure", + "required":["EventAction"], + "members":{ + "EventAction":{ + "shape":"CompromisedCredentialsEventActionType", + "documentation":"

The event action.

" + } + }, + "documentation":"

The compromised credentials actions type

" + }, + "CompromisedCredentialsEventActionType":{ + "type":"string", + "enum":[ + "BLOCK", + "NO_ACTION" + ] + }, + "CompromisedCredentialsRiskConfigurationType":{ + "type":"structure", + "required":["Actions"], + "members":{ + "EventFilter":{ + "shape":"EventFiltersType", + "documentation":"

Perform the action for these events. The default is to perform all events if no event filter is specified.

" + }, + "Actions":{ + "shape":"CompromisedCredentialsActionsType", + "documentation":"

The compromised credentials risk configuration actions.

" + } + }, + "documentation":"

The compromised credentials risk configuration type.

" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message provided when the concurrent exception is thrown.

" + } + }, + "documentation":"

This exception is thrown if two or more modifications are happening concurrently.

", + "exception":true + }, + "ConfirmDeviceRequest":{ + "type":"structure", + "required":[ + "AccessToken", + "DeviceKey" + ], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + }, + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "DeviceSecretVerifierConfig":{ + "shape":"DeviceSecretVerifierConfigType", + "documentation":"

The configuration of the device secret verifier.

" + }, + "DeviceName":{ + "shape":"DeviceNameType", + "documentation":"

The device name.

" + } + }, + "documentation":"

Confirms the device request.

" + }, + "ConfirmDeviceResponse":{ + "type":"structure", + "members":{ + "UserConfirmationNecessary":{ + "shape":"BooleanType", + "documentation":"

Indicates whether the user confirmation is necessary to confirm the device response.

" + } + }, + "documentation":"

Confirms the device response.

" + }, + "ConfirmForgotPasswordRequest":{ + "type":"structure", + "required":[ + "ClientId", + "Username", + "ConfirmationCode", + "Password" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID of the app associated with the user pool.

" + }, + "SecretHash":{ + "shape":"SecretHashType", + "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user for whom you want to enter a code to retrieve a forgotten password.

" + }, + "ConfirmationCode":{ + "shape":"ConfirmationCodeType", + "documentation":"

The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see

" + }, + "Password":{ + "shape":"PasswordType", + "documentation":"

The password sent by a user's request to retrieve a forgotten password.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmForgotPassword calls.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the functions that are assigned to the post confirmation and pre mutation triggers. When Amazon Cognito invokes either of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

The request representing the confirmation for a password reset.

" + }, + "ConfirmForgotPasswordResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response from the server that results from a user's request to retrieve a forgotten password.

" + }, + "ConfirmSignUpRequest":{ + "type":"structure", + "required":[ + "ClientId", + "Username", + "ConfirmationCode" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the app client associated with the user pool.

" + }, + "SecretHash":{ + "shape":"SecretHashType", + "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user whose registration you wish to confirm.

" + }, + "ConfirmationCode":{ + "shape":"ConfirmationCodeType", + "documentation":"

The confirmation code sent by a user's request to confirm registration.

" + }, + "ForceAliasCreation":{ + "shape":"ForceAliasCreation", + "documentation":"

Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ConfirmSignUp API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmSignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to confirm registration of a user.

" + }, + "ConfirmSignUpResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server for the registration confirmation.

" + }, + "ConfirmationCodeType":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\S]+" + }, + "ContextDataType":{ + "type":"structure", + "required":[ + "IpAddress", + "ServerName", + "ServerPath", + "HttpHeaders" + ], + "members":{ + "IpAddress":{ + "shape":"StringType", + "documentation":"

Source IP address of your user.

" + }, + "ServerName":{ + "shape":"StringType", + "documentation":"

Your server endpoint where this API is invoked.

" + }, + "ServerPath":{ + "shape":"StringType", + "documentation":"

Your server path where this API is invoked.

" + }, + "HttpHeaders":{ + "shape":"HttpHeaderList", + "documentation":"

HttpHeaders received on your server in same order.

" + }, + "EncodedData":{ + "shape":"StringType", + "documentation":"

Encoded data containing device fingerprinting details, collected using the Amazon Cognito context data collection library.

" + } + }, + "documentation":"

Contextual user data type used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "CreateGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserPoolId" + ], + "members":{ + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group. Must be unique.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

A string containing the description of the group.

" + }, + "RoleArn":{ + "shape":"ArnType", + "documentation":"

The role ARN for the group.

" + }, + "Precedence":{ + "shape":"PrecedenceType", + "documentation":"

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

" + } + } + }, + "CreateGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"GroupType", + "documentation":"

The group object for the group.

" + } + } + }, + "CreateIdentityProviderRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ProviderName", + "ProviderType", + "ProviderDetails" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ProviderName":{ + "shape":"ProviderNameTypeV1", + "documentation":"

The identity provider name.

" + }, + "ProviderType":{ + "shape":"IdentityProviderTypeType", + "documentation":"

The identity provider type.

" + }, + "ProviderDetails":{ + "shape":"ProviderDetailsType", + "documentation":"

The identity provider details, such as MetadataURL and MetadataFile.

" + }, + "AttributeMapping":{ + "shape":"AttributeMappingType", + "documentation":"

A mapping of identity provider attributes to standard and custom user pool attributes.

" + }, + "IdpIdentifiers":{ + "shape":"IdpIdentifiersListType", + "documentation":"

A list of identity provider identifiers.

" + } + } + }, + "CreateIdentityProviderResponse":{ + "type":"structure", + "required":["IdentityProvider"], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProviderType", + "documentation":"

The newly created identity provider object.

" + } + } + }, + "CreateResourceServerRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Identifier", + "Name" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Identifier":{ + "shape":"ResourceServerIdentifierType", + "documentation":"

A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located. For example, https://my-weather-api.example.com.

" + }, + "Name":{ + "shape":"ResourceServerNameType", + "documentation":"

A friendly name for the resource server.

" + }, + "Scopes":{ + "shape":"ResourceServerScopeListType", + "documentation":"

A list of scopes. Each scope is map, where the keys are name and description.

" + } + } + }, + "CreateResourceServerResponse":{ + "type":"structure", + "required":["ResourceServer"], + "members":{ + "ResourceServer":{ + "shape":"ResourceServerType", + "documentation":"

The newly created resource server.

" + } + } + }, + "CreateUserImportJobRequest":{ + "type":"structure", + "required":[ + "JobName", + "UserPoolId", + "CloudWatchLogsRoleArn" + ], + "members":{ + "JobName":{ + "shape":"UserImportJobNameType", + "documentation":"

The job name for the user import job.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"ArnType", + "documentation":"

The role ARN for the Amazon CloudWatch Logging role for the user import job.

" + } + }, + "documentation":"

Represents the request to create the user import job.

" + }, + "CreateUserImportJobResponse":{ + "type":"structure", + "members":{ + "UserImportJob":{ + "shape":"UserImportJobType", + "documentation":"

The job object that represents the user import job.

" + } + }, + "documentation":"

Represents the response from the server to the request to create the user import job.

" + }, + "CreateUserPoolClientRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to create a user pool client.

" + }, + "ClientName":{ + "shape":"ClientNameType", + "documentation":"

The client name for the user pool client you would like to create.

" + }, + "GenerateSecret":{ + "shape":"GenerateSecret", + "documentation":"

Boolean to specify whether you want to generate a secret for the user pool client being created.

" + }, + "RefreshTokenValidity":{ + "shape":"RefreshTokenValidityType", + "documentation":"

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

" + }, + "ReadAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The read attributes.

" + }, + "WriteAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The user pool attributes that the app client can write to.

If your app client allows users to sign in through an identity provider, this array must include all attributes that are mapped to identity provider attributes. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If your app client lacks write access to a mapped attribute, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

" + }, + "ExplicitAuthFlows":{ + "shape":"ExplicitAuthFlowsListType", + "documentation":"

The explicit authentication flows.

" + }, + "SupportedIdentityProviders":{ + "shape":"SupportedIdentityProvidersListType", + "documentation":"

A list of provider names for the identity providers that are supported on this client. The following are supported: COGNITO, Facebook, Google and LoginWithAmazon.

" + }, + "CallbackURLs":{ + "shape":"CallbackURLsListType", + "documentation":"

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "LogoutURLs":{ + "shape":"LogoutURLsListType", + "documentation":"

A list of allowed logout URLs for the identity providers.

" + }, + "DefaultRedirectURI":{ + "shape":"RedirectUrlType", + "documentation":"

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "AllowedOAuthFlows":{ + "shape":"OAuthFlowsType", + "documentation":"

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

" + }, + "AllowedOAuthScopes":{ + "shape":"ScopeListType", + "documentation":"

A list of allowed OAuth scopes. Currently supported values are \"phone\", \"email\", \"openid\", and \"Cognito\". In addition to these values, custom scopes created in Resource Servers are also supported.

" + }, + "AllowedOAuthFlowsUserPoolClient":{ + "shape":"BooleanType", + "documentation":"

Set to True if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

" + }, + "AnalyticsConfiguration":{ + "shape":"AnalyticsConfigurationType", + "documentation":"

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

" + } + }, + "documentation":"

Represents the request to create a user pool client.

" + }, + "CreateUserPoolClientResponse":{ + "type":"structure", + "members":{ + "UserPoolClient":{ + "shape":"UserPoolClientType", + "documentation":"

The user pool client that was just created.

" + } + }, + "documentation":"

Represents the response from the server to create a user pool client.

" + }, + "CreateUserPoolDomainRequest":{ + "type":"structure", + "required":[ + "Domain", + "UserPoolId" + ], + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"

The domain string.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "CustomDomainConfig":{ + "shape":"CustomDomainConfigType", + "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

" + } + } + }, + "CreateUserPoolDomainResponse":{ + "type":"structure", + "members":{ + "CloudFrontDomain":{ + "shape":"DomainType", + "documentation":"

The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

" + } + } + }, + "CreateUserPoolRequest":{ + "type":"structure", + "required":["PoolName"], + "members":{ + "PoolName":{ + "shape":"UserPoolNameType", + "documentation":"

A string used to name the user pool.

" + }, + "Policies":{ + "shape":"UserPoolPolicyType", + "documentation":"

The policies associated with the new user pool.

" + }, + "LambdaConfig":{ + "shape":"LambdaConfigType", + "documentation":"

The Lambda trigger configuration information for the new user pool.

In a push model, event sources (such as Amazon S3 and custom applications) need permission to invoke a function. So you will need to make an extra call to add permission for these event sources to invoke your Lambda function.

For more information on using the Lambda API to add permission, see AddPermission .

For adding permission using the AWS CLI, see add-permission .

" + }, + "AutoVerifiedAttributes":{ + "shape":"VerifiedAttributesListType", + "documentation":"

The attributes to be auto-verified. Possible values: email, phone_number.

" + }, + "AliasAttributes":{ + "shape":"AliasAttributesListType", + "documentation":"

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

" + }, + "UsernameAttributes":{ + "shape":"UsernameAttributesListType", + "documentation":"

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

" + }, + "SmsVerificationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

A string representing the SMS verification message.

" + }, + "EmailVerificationMessage":{ + "shape":"EmailVerificationMessageType", + "documentation":"

A string representing the email verification message.

" + }, + "EmailVerificationSubject":{ + "shape":"EmailVerificationSubjectType", + "documentation":"

A string representing the email verification subject.

" + }, + "VerificationMessageTemplate":{ + "shape":"VerificationMessageTemplateType", + "documentation":"

The template for the verification message that the user sees when the app requests permission to access the user's information.

" + }, + "SmsAuthenticationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

A string representing the SMS authentication message.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

Specifies MFA configuration details.

" + }, + "DeviceConfiguration":{ + "shape":"DeviceConfigurationType", + "documentation":"

The device configuration.

" + }, + "EmailConfiguration":{ + "shape":"EmailConfigurationType", + "documentation":"

The email configuration.

" + }, + "SmsConfiguration":{ + "shape":"SmsConfigurationType", + "documentation":"

The SMS configuration.

" + }, + "UserPoolTags":{ + "shape":"UserPoolTagsType", + "documentation":"

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

" + }, + "AdminCreateUserConfig":{ + "shape":"AdminCreateUserConfigType", + "documentation":"

The configuration for AdminCreateUser requests.

" + }, + "Schema":{ + "shape":"SchemaAttributesListType", + "documentation":"

An array of schema attributes for the new user pool. These attributes can be standard or custom attributes.

" + }, + "UserPoolAddOns":{ + "shape":"UserPoolAddOnsType", + "documentation":"

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value \"AUDIT\".

" + } + }, + "documentation":"

Represents the request to create a user pool.

" + }, + "CreateUserPoolResponse":{ + "type":"structure", + "members":{ + "UserPool":{ + "shape":"UserPoolType", + "documentation":"

A container for the user pool details.

" + } + }, + "documentation":"

Represents the response from the server for the request to create a user pool.

" + }, + "CustomAttributeNameType":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "CustomAttributesListType":{ + "type":"list", + "member":{"shape":"SchemaAttributeType"}, + "max":25, + "min":1 + }, + "CustomDomainConfigType":{ + "type":"structure", + "required":["CertificateArn"], + "members":{ + "CertificateArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

" + } + }, + "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

" + }, + "DateType":{"type":"timestamp"}, + "DefaultEmailOptionType":{ + "type":"string", + "enum":[ + "CONFIRM_WITH_LINK", + "CONFIRM_WITH_CODE" + ] + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserPoolId" + ], + "members":{ + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + } + } + }, + "DeleteIdentityProviderRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ProviderName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The identity provider name.

" + } + } + }, + "DeleteResourceServerRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Identifier" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that hosts the resource server.

" + }, + "Identifier":{ + "shape":"ResourceServerIdentifierType", + "documentation":"

The identifier for the resource server.

" + } + } + }, + "DeleteUserAttributesRequest":{ + "type":"structure", + "required":[ + "UserAttributeNames", + "AccessToken" + ], + "members":{ + "UserAttributeNames":{ + "shape":"AttributeNameListType", + "documentation":"

An array of strings representing the user attribute names you wish to delete.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + }, + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token used in the request to delete user attributes.

" + } + }, + "documentation":"

Represents the request to delete user attributes.

" + }, + "DeleteUserAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server to delete user attributes.

" + }, + "DeleteUserPoolClientRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to delete the client.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID of the app associated with the user pool.

" + } + }, + "documentation":"

Represents the request to delete a user pool client.

" + }, + "DeleteUserPoolDomainRequest":{ + "type":"structure", + "required":[ + "Domain", + "UserPoolId" + ], + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"

The domain string.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + } + } + }, + "DeleteUserPoolDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserPoolRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool you want to delete.

" + } + }, + "documentation":"

Represents the request to delete a user pool.

" + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["AccessToken"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token from a request to delete a user.

" + } + }, + "documentation":"

Represents the request to delete a user.

" + }, + "DeliveryMediumListType":{ + "type":"list", + "member":{"shape":"DeliveryMediumType"} + }, + "DeliveryMediumType":{ + "type":"string", + "enum":[ + "SMS", + "EMAIL" + ] + }, + "DescribeIdentityProviderRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ProviderName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The identity provider name.

" + } + } + }, + "DescribeIdentityProviderResponse":{ + "type":"structure", + "required":["IdentityProvider"], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProviderType", + "documentation":"

The identity provider that was deleted.

" + } + } + }, + "DescribeResourceServerRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Identifier" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that hosts the resource server.

" + }, + "Identifier":{ + "shape":"ResourceServerIdentifierType", + "documentation":"

The identifier for the resource server

" + } + } + }, + "DescribeResourceServerResponse":{ + "type":"structure", + "required":["ResourceServer"], + "members":{ + "ResourceServer":{ + "shape":"ResourceServerType", + "documentation":"

The resource server.

" + } + } + }, + "DescribeRiskConfigurationRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + } + } + }, + "DescribeRiskConfigurationResponse":{ + "type":"structure", + "required":["RiskConfiguration"], + "members":{ + "RiskConfiguration":{ + "shape":"RiskConfigurationType", + "documentation":"

The risk configuration.

" + } + } + }, + "DescribeUserImportJobRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "JobId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "JobId":{ + "shape":"UserImportJobIdType", + "documentation":"

The job ID for the user import job.

" + } + }, + "documentation":"

Represents the request to describe the user import job.

" + }, + "DescribeUserImportJobResponse":{ + "type":"structure", + "members":{ + "UserImportJob":{ + "shape":"UserImportJobType", + "documentation":"

The job object that represents the user import job.

" + } + }, + "documentation":"

Represents the response from the server to the request to describe the user import job.

" + }, + "DescribeUserPoolClientRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool you want to describe.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID of the app associated with the user pool.

" + } + }, + "documentation":"

Represents the request to describe a user pool client.

" + }, + "DescribeUserPoolClientResponse":{ + "type":"structure", + "members":{ + "UserPoolClient":{ + "shape":"UserPoolClientType", + "documentation":"

The user pool client from a server response to describe the user pool client.

" + } + }, + "documentation":"

Represents the response from the server from a request to describe the user pool client.

" + }, + "DescribeUserPoolDomainRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"

The domain string.

" + } + } + }, + "DescribeUserPoolDomainResponse":{ + "type":"structure", + "members":{ + "DomainDescription":{ + "shape":"DomainDescriptionType", + "documentation":"

A domain description object containing information about the domain.

" + } + } + }, + "DescribeUserPoolRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool you want to describe.

" + } + }, + "documentation":"

Represents the request to describe the user pool.

" + }, + "DescribeUserPoolResponse":{ + "type":"structure", + "members":{ + "UserPool":{ + "shape":"UserPoolType", + "documentation":"

The container of metadata returned by the server to describe the pool.

" + } + }, + "documentation":"

Represents the response to describe the user pool.

" + }, + "DescriptionType":{ + "type":"string", + "max":2048 + }, + "DeviceConfigurationType":{ + "type":"structure", + "members":{ + "ChallengeRequiredOnNewDevice":{ + "shape":"BooleanType", + "documentation":"

Indicates whether a challenge is required on a new device. Only applicable to a new device.

" + }, + "DeviceOnlyRememberedOnUserPrompt":{ + "shape":"BooleanType", + "documentation":"

If true, a device is only remembered on user prompt.

" + } + }, + "documentation":"

The configuration for the user pool's device tracking.

" + }, + "DeviceKeyType":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+_[0-9a-f-]+" + }, + "DeviceListType":{ + "type":"list", + "member":{"shape":"DeviceType"} + }, + "DeviceNameType":{ + "type":"string", + "max":1024, + "min":1 + }, + "DeviceRememberedStatusType":{ + "type":"string", + "enum":[ + "remembered", + "not_remembered" + ] + }, + "DeviceSecretVerifierConfigType":{ + "type":"structure", + "members":{ + "PasswordVerifier":{ + "shape":"StringType", + "documentation":"

The password verifier.

" + }, + "Salt":{ + "shape":"StringType", + "documentation":"

The salt.

" + } + }, + "documentation":"

The device verifier against which it will be authenticated.

" + }, + "DeviceType":{ + "type":"structure", + "members":{ + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "DeviceAttributes":{ + "shape":"AttributeListType", + "documentation":"

The device attributes.

" + }, + "DeviceCreateDate":{ + "shape":"DateType", + "documentation":"

The creation date of the device.

" + }, + "DeviceLastModifiedDate":{ + "shape":"DateType", + "documentation":"

The last modified date of the device.

" + }, + "DeviceLastAuthenticatedDate":{ + "shape":"DateType", + "documentation":"

The date in which the device was last authenticated.

" + } + }, + "documentation":"

The device type.

" + }, + "DomainDescriptionType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "AWSAccountId":{ + "shape":"AWSAccountIdType", + "documentation":"

The AWS account ID for the user pool owner.

" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

The domain string.

" + }, + "S3Bucket":{ + "shape":"S3BucketType", + "documentation":"

The S3 bucket where the static files for this domain are stored.

" + }, + "CloudFrontDistribution":{ + "shape":"StringType", + "documentation":"

The ARN of the CloudFront distribution.

" + }, + "Version":{ + "shape":"DomainVersionType", + "documentation":"

The app version.

" + }, + "Status":{ + "shape":"DomainStatusType", + "documentation":"

The domain status.

" + }, + "CustomDomainConfig":{ + "shape":"CustomDomainConfigType", + "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

" + } + }, + "documentation":"

A container for information about a domain.

" + }, + "DomainStatusType":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "UPDATING", + "ACTIVE", + "FAILED" + ] + }, + "DomainType":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-z0-9](?:[a-z0-9\\-]{0,61}[a-z0-9])?$" + }, + "DomainVersionType":{ + "type":"string", + "max":20, + "min":1 + }, + "DuplicateProviderException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when the provider is already supported by the user pool.

", + "exception":true + }, + "EmailAddressType":{ + "type":"string", + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "EmailConfigurationType":{ + "type":"structure", + "members":{ + "SourceArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of a verified email address in Amazon SES. This email address is used in one of the following ways, depending on the value that you specify for the EmailSendingAccount parameter:

  • If you specify COGNITO_DEFAULT, Amazon Cognito uses this address as the custom FROM address when it emails your users by using its built-in email account.

  • If you specify DEVELOPER, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.

" + }, + "ReplyToEmailAddress":{ + "shape":"EmailAddressType", + "documentation":"

The destination to which the receiver of the email should reply to.

" + }, + "EmailSendingAccount":{ + "shape":"EmailSendingAccountType", + "documentation":"

Specifies whether Amazon Cognito emails your users by using its built-in email functionality or your Amazon SES email configuration. Specify one of the following values:

COGNITO_DEFAULT

When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is below the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.

To look up the email delivery limit for the default option, see Limits in Amazon Cognito in the Amazon Cognito Developer Guide.

The default FROM address is no-reply@verificationemail.com. To customize the FROM address, provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

DEVELOPER

When Amazon Cognito emails your users, it uses your Amazon SES configuration. Amazon Cognito calls Amazon SES on your behalf to send email from your verified email address. When you use this option, the email delivery limits are the same limits that apply to your Amazon SES verified email address in your AWS account.

If you use this option, you must provide the ARN of an Amazon SES verified email address for the SourceArn parameter.

Before Amazon Cognito can email your users, it requires additional permissions to call Amazon SES on your behalf. When you update your user pool with this option, Amazon Cognito creates a service-linked role, which is a type of IAM role, in your AWS account. This role contains the permissions that allow Amazon Cognito to access Amazon SES and send email messages with your address. For more information about the service-linked role that Amazon Cognito creates, see Using Service-Linked Roles for Amazon Cognito in the Amazon Cognito Developer Guide.

" + } + }, + "documentation":"

The email configuration type.

" + }, + "EmailNotificationBodyType":{ + "type":"string", + "max":20000, + "min":6, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]+" + }, + "EmailNotificationSubjectType":{ + "type":"string", + "max":140, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+" + }, + "EmailSendingAccountType":{ + "type":"string", + "enum":[ + "COGNITO_DEFAULT", + "DEVELOPER" + ] + }, + "EmailVerificationMessageByLinkType":{ + "type":"string", + "max":20000, + "min":6, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{##[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*##\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*" + }, + "EmailVerificationMessageType":{ + "type":"string", + "max":20000, + "min":6, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*" + }, + "EmailVerificationSubjectByLinkType":{ + "type":"string", + "max":140, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+" + }, + "EmailVerificationSubjectType":{ + "type":"string", + "max":140, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s]+" + }, + "EnableSoftwareTokenMFAException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when there is a code mismatch and the service fails to configure the software token TOTP multi-factor authentication (MFA).

", + "exception":true + }, + "EventContextDataType":{ + "type":"structure", + "members":{ + "IpAddress":{ + "shape":"StringType", + "documentation":"

The user's IP address.

" + }, + "DeviceName":{ + "shape":"StringType", + "documentation":"

The user's device name.

" + }, + "Timezone":{ + "shape":"StringType", + "documentation":"

The user's time zone.

" + }, + "City":{ + "shape":"StringType", + "documentation":"

The user's city.

" + }, + "Country":{ + "shape":"StringType", + "documentation":"

The user's country.

" + } + }, + "documentation":"

Specifies the user context data captured at the time of an event request.

" + }, + "EventFeedbackType":{ + "type":"structure", + "required":[ + "FeedbackValue", + "Provider" + ], + "members":{ + "FeedbackValue":{ + "shape":"FeedbackValueType", + "documentation":"

The event feedback value.

" + }, + "Provider":{ + "shape":"StringType", + "documentation":"

The provider.

" + }, + "FeedbackDate":{ + "shape":"DateType", + "documentation":"

The event feedback date.

" + } + }, + "documentation":"

Specifies the event feedback type.

" + }, + "EventFilterType":{ + "type":"string", + "enum":[ + "SIGN_IN", + "PASSWORD_CHANGE", + "SIGN_UP" + ] + }, + "EventFiltersType":{ + "type":"list", + "member":{"shape":"EventFilterType"} + }, + "EventIdType":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[\\w+-]+" + }, + "EventResponseType":{ + "type":"string", + "enum":[ + "Success", + "Failure" + ] + }, + "EventRiskType":{ + "type":"structure", + "members":{ + "RiskDecision":{ + "shape":"RiskDecisionType", + "documentation":"

The risk decision.

" + }, + "RiskLevel":{ + "shape":"RiskLevelType", + "documentation":"

The risk level.

" + } + }, + "documentation":"

The event risk type.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "SignIn", + "SignUp", + "ForgotPassword" + ] + }, + "ExpiredCodeException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the expired code exception is thrown.

" + } + }, + "documentation":"

This exception is thrown if a code has expired.

", + "exception":true + }, + "ExplicitAuthFlowsListType":{ + "type":"list", + "member":{"shape":"ExplicitAuthFlowsType"} + }, + "ExplicitAuthFlowsType":{ + "type":"string", + "enum":[ + "ADMIN_NO_SRP_AUTH", + "CUSTOM_AUTH_FLOW_ONLY", + "USER_PASSWORD_AUTH" + ] + }, + "FeedbackValueType":{ + "type":"string", + "enum":[ + "Valid", + "Invalid" + ] + }, + "ForceAliasCreation":{"type":"boolean"}, + "ForgetDeviceRequest":{ + "type":"structure", + "required":["DeviceKey"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token for the forgotten device request.

" + }, + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + } + }, + "documentation":"

Represents the request to forget the device.

" + }, + "ForgotPasswordRequest":{ + "type":"structure", + "required":[ + "ClientId", + "Username" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "SecretHash":{ + "shape":"SecretHashType", + "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user for whom you want to enter a code to reset a forgotten password.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for ForgotPassword calls.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ForgotPassword API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and user migration. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ForgotPassword request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to reset a user's password.

" + }, + "ForgotPasswordResponse":{ + "type":"structure", + "members":{ + "CodeDeliveryDetails":{ + "shape":"CodeDeliveryDetailsType", + "documentation":"

The code delivery details returned by the server in response to the request to reset a password.

" + } + }, + "documentation":"

Respresents the response from the server regarding the request to reset a password.

" + }, + "GenerateSecret":{"type":"boolean"}, + "GetCSVHeaderRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" + } + }, + "documentation":"

Represents the request to get the header information for the .csv file for the user import job.

" + }, + "GetCSVHeaderResponse":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are to be imported into.

" + }, + "CSVHeader":{ + "shape":"ListOfStringTypes", + "documentation":"

The header information for the .csv file for the user import job.

" + } + }, + "documentation":"

Represents the response from the server to the request to get the header information for the .csv file for the user import job.

" + }, + "GetDeviceRequest":{ + "type":"structure", + "required":["DeviceKey"], + "members":{ + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + } + }, + "documentation":"

Represents the request to get the device.

" + }, + "GetDeviceResponse":{ + "type":"structure", + "required":["Device"], + "members":{ + "Device":{ + "shape":"DeviceType", + "documentation":"

The device.

" + } + }, + "documentation":"

Gets the device response.

" + }, + "GetGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserPoolId" + ], + "members":{ + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + } + } + }, + "GetGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"GroupType", + "documentation":"

The group object for the group.

" + } + } + }, + "GetIdentityProviderByIdentifierRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "IdpIdentifier" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "IdpIdentifier":{ + "shape":"IdpIdentifierType", + "documentation":"

The identity provider ID.

" + } + } + }, + "GetIdentityProviderByIdentifierResponse":{ + "type":"structure", + "required":["IdentityProvider"], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProviderType", + "documentation":"

The identity provider object.

" + } + } + }, + "GetSigningCertificateRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + } + }, + "documentation":"

Request to get a signing certificate from Cognito.

" + }, + "GetSigningCertificateResponse":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"StringType", + "documentation":"

The signing certificate.

" + } + }, + "documentation":"

Response from Cognito for a signing certificate request.

" + }, + "GetUICustomizationRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The client ID for the client app.

" + } + } + }, + "GetUICustomizationResponse":{ + "type":"structure", + "required":["UICustomization"], + "members":{ + "UICustomization":{ + "shape":"UICustomizationType", + "documentation":"

The UI customization information.

" + } + } + }, + "GetUserAttributeVerificationCodeRequest":{ + "type":"structure", + "required":[ + "AccessToken", + "AttributeName" + ], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token returned by the server response to get the user attribute verification code.

" + }, + "AttributeName":{ + "shape":"AttributeNameType", + "documentation":"

The attribute name returned by the server response to get the user attribute verification code.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the GetUserAttributeVerificationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your GetUserAttributeVerificationCode request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to get user attribute verification.

" + }, + "GetUserAttributeVerificationCodeResponse":{ + "type":"structure", + "members":{ + "CodeDeliveryDetails":{ + "shape":"CodeDeliveryDetailsType", + "documentation":"

The code delivery details returned by the server in response to the request to get the user attribute verification code.

" + } + }, + "documentation":"

The verification code response returned by the server response to get the user attribute verification code.

" + }, + "GetUserPoolMfaConfigRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + } + } + }, + "GetUserPoolMfaConfigResponse":{ + "type":"structure", + "members":{ + "SmsMfaConfiguration":{ + "shape":"SmsMfaConfigType", + "documentation":"

The SMS text message multi-factor (MFA) configuration.

" + }, + "SoftwareTokenMfaConfiguration":{ + "shape":"SoftwareTokenMfaConfigType", + "documentation":"

The software token multi-factor (MFA) configuration.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

The multi-factor (MFA) configuration. Valid values include:

  • OFF MFA will not be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

" + } + } + }, + "GetUserRequest":{ + "type":"structure", + "required":["AccessToken"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token returned by the server response to get information about the user.

" + } + }, + "documentation":"

Represents the request to get information about the user.

" + }, + "GetUserResponse":{ + "type":"structure", + "required":[ + "Username", + "UserAttributes" + ], + "members":{ + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to retrieve from the get user request.

" + }, + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + }, + "MFAOptions":{ + "shape":"MFAOptionListType", + "documentation":"

This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the use the GetUserResponse$UserMFASettingList response instead.

" + }, + "PreferredMfaSetting":{ + "shape":"StringType", + "documentation":"

The user's preferred MFA setting.

" + }, + "UserMFASettingList":{ + "shape":"UserMFASettingListType", + "documentation":"

The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

" + } + }, + "documentation":"

Represents the response from the server from the request to get information about the user.

" + }, + "GlobalSignOutRequest":{ + "type":"structure", + "required":["AccessToken"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + } + }, + "documentation":"

Represents the request to sign out all devices.

" + }, + "GlobalSignOutResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response to the request to sign out all devices.

" + }, + "GroupExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when Amazon Cognito encounters a group that already exists in the user pool.

", + "exception":true + }, + "GroupListType":{ + "type":"list", + "member":{"shape":"GroupType"} + }, + "GroupNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "GroupType":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

A string containing the description of the group.

" + }, + "RoleArn":{ + "shape":"ArnType", + "documentation":"

The role ARN for the group.

" + }, + "Precedence":{ + "shape":"PrecedenceType", + "documentation":"

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the group was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the group was created.

" + } + }, + "documentation":"

The group type.

" + }, + "HexStringType":{ + "type":"string", + "pattern":"^[0-9a-fA-F]+$" + }, + "HttpHeader":{ + "type":"structure", + "members":{ + "headerName":{ + "shape":"StringType", + "documentation":"

The header name

" + }, + "headerValue":{ + "shape":"StringType", + "documentation":"

The header value.

" + } + }, + "documentation":"

The HTTP header.

" + }, + "HttpHeaderList":{ + "type":"list", + "member":{"shape":"HttpHeader"} + }, + "IdentityProviderType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The identity provider name.

" + }, + "ProviderType":{ + "shape":"IdentityProviderTypeType", + "documentation":"

The identity provider type.

" + }, + "ProviderDetails":{ + "shape":"ProviderDetailsType", + "documentation":"

The identity provider details, such as MetadataURL and MetadataFile.

" + }, + "AttributeMapping":{ + "shape":"AttributeMappingType", + "documentation":"

A mapping of identity provider attributes to standard and custom user pool attributes.

" + }, + "IdpIdentifiers":{ + "shape":"IdpIdentifiersListType", + "documentation":"

A list of identity provider identifiers.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the identity provider was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the identity provider was created.

" + } + }, + "documentation":"

A container for information about an identity provider.

" + }, + "IdentityProviderTypeType":{ + "type":"string", + "enum":[ + "SAML", + "Facebook", + "Google", + "LoginWithAmazon", + "OIDC" + ] + }, + "IdpIdentifierType":{ + "type":"string", + "max":40, + "min":1, + "pattern":"[\\w\\s+=.@-]+" + }, + "IdpIdentifiersListType":{ + "type":"list", + "member":{"shape":"IdpIdentifierType"}, + "max":50, + "min":0 + }, + "ImageFileType":{"type":"blob"}, + "ImageUrlType":{"type":"string"}, + "InitiateAuthRequest":{ + "type":"structure", + "required":[ + "AuthFlow", + "ClientId" + ], + "members":{ + "AuthFlow":{ + "shape":"AuthFlowType", + "documentation":"

The authentication flow for this call to execute. The API action will depend on this value. For example:

  • REFRESH_TOKEN_AUTH will take in a valid refresh token and return new tokens.

  • USER_SRP_AUTH will take in USERNAME and SRP_A and return the SRP variables to be used for next challenge execution.

  • USER_PASSWORD_AUTH will take in USERNAME and PASSWORD and return the next challenge or tokens.

Valid values include:

  • USER_SRP_AUTH: Authentication flow for the Secure Remote Password (SRP) protocol.

  • REFRESH_TOKEN_AUTH/REFRESH_TOKEN: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.

  • CUSTOM_AUTH: Custom authentication flow.

  • USER_PASSWORD_AUTH: Non-SRP authentication flow; USERNAME and PASSWORD are passed directly. If a user migration Lambda trigger is set, this flow will invoke the user migration Lambda if the USERNAME is not found in the user pool.

ADMIN_NO_SRP_AUTH is not a valid value.

" + }, + "AuthParameters":{ + "shape":"AuthParametersType", + "documentation":"

The authentication parameters. These are inputs corresponding to the AuthFlow that you are invoking. The required values depend on the value of AuthFlow:

  • For USER_SRP_AUTH: USERNAME (required), SRP_A (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

  • For REFRESH_TOKEN_AUTH/REFRESH_TOKEN: REFRESH_TOKEN (required), SECRET_HASH (required if the app client is configured with a client secret), DEVICE_KEY

  • For CUSTOM_AUTH: USERNAME (required), SECRET_HASH (if app client is configured with client secret), DEVICE_KEY

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for certain custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the InitiateAuth API action, Amazon Cognito invokes the AWS Lambda functions that are specified for various triggers. The ClientMetadata value is passed as input to the functions for only the following triggers:

  • Pre signup

  • Pre authentication

  • User migration

When Amazon Cognito invokes the functions for these triggers, it passes a JSON payload, which the function receives as input. This payload contains a validationData attribute, which provides the data that you assigned to the ClientMetadata parameter in your InitiateAuth request. In your function code in AWS Lambda, you can process the validationData value to enhance your workflow for your specific needs.

When you use the InitiateAuth API action, Amazon Cognito also invokes the functions for the following triggers, but it does not provide the ClientMetadata value as input:

  • Post authentication

  • Custom message

  • Pre token generation

  • Create auth challenge

  • Define auth challenge

  • Verify auth challenge

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for InitiateAuth calls.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + } + }, + "documentation":"

Initiates the authentication request.

" + }, + "InitiateAuthResponse":{ + "type":"structure", + "members":{ + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The name of the challenge which you are responding to with this call. This is returned to you in the AdminInitiateAuth response if you need to pass another challenge.

Valid values include the following. Note that all of these challenges require USERNAME and SECRET_HASH (if applicable) in the parameters.

  • SMS_MFA: Next challenge is to supply an SMS_MFA_CODE, delivered via SMS.

  • PASSWORD_VERIFIER: Next challenge is to supply PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, and TIMESTAMP after the client-side SRP calculations.

  • CUSTOM_CHALLENGE: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.

  • DEVICE_SRP_AUTH: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.

  • DEVICE_PASSWORD_VERIFIER: Similar to PASSWORD_VERIFIER, but for devices only.

  • NEW_PASSWORD_REQUIRED: For users which are required to change their passwords after successful first login. This challenge should be passed with NEW_PASSWORD and any other required attributes.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

" + }, + "ChallengeParameters":{ + "shape":"ChallengeParametersType", + "documentation":"

The challenge parameters. These are returned to you in the InitiateAuth response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (RespondToAuthChallenge).

All challenges require USERNAME and SECRET_HASH (if applicable).

" + }, + "AuthenticationResult":{ + "shape":"AuthenticationResultType", + "documentation":"

The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, ChallengeName, ChallengeParameters, and Session are returned.

" + } + }, + "documentation":"

Initiates the authentication response.

" + }, + "IntegerType":{"type":"integer"}, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when Amazon Cognito throws an internal error exception.

" + } + }, + "documentation":"

This exception is thrown when Amazon Cognito encounters an internal error.

", + "exception":true, + "fault":true + }, + "InvalidEmailRoleAccessPolicyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when you have an unverified email address or the identity policy is not set on an email address that Amazon Cognito can access.

" + } + }, + "documentation":"

This exception is thrown when Amazon Cognito is not allowed to use your email identity. HTTP status code: 400.

", + "exception":true + }, + "InvalidLambdaResponseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service throws an invalid AWS Lambda response exception.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.

", + "exception":true + }, + "InvalidOAuthFlowException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when the specified OAuth flow is invalid.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service throws an invalid parameter exception.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.

", + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service throws an invalid user password exception.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service encounters an invalid password.

", + "exception":true + }, + "InvalidSmsRoleAccessPolicyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message retuned when the invalid SMS role access policy exception is thrown.

" + } + }, + "documentation":"

This exception is returned when the role provided for SMS configuration does not have permission to publish using Amazon SNS.

", + "exception":true + }, + "InvalidSmsRoleTrustRelationshipException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the role trust relationship for the SMS message is invalid.

" + } + }, + "documentation":"

This exception is thrown when the trust relationship is invalid for the role provided for SMS configuration. This can happen if you do not trust cognito-idp.amazonaws.com or the external ID provided in the role does not match what is provided in the SMS configuration for the user pool.

", + "exception":true + }, + "InvalidUserPoolConfigurationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the user pool configuration is invalid.

" + } + }, + "documentation":"

This exception is thrown when the user pool configuration is invalid.

", + "exception":true + }, + "LambdaConfigType":{ + "type":"structure", + "members":{ + "PreSignUp":{ + "shape":"ArnType", + "documentation":"

A pre-registration AWS Lambda trigger.

" + }, + "CustomMessage":{ + "shape":"ArnType", + "documentation":"

A custom Message AWS Lambda trigger.

" + }, + "PostConfirmation":{ + "shape":"ArnType", + "documentation":"

A post-confirmation AWS Lambda trigger.

" + }, + "PreAuthentication":{ + "shape":"ArnType", + "documentation":"

A pre-authentication AWS Lambda trigger.

" + }, + "PostAuthentication":{ + "shape":"ArnType", + "documentation":"

A post-authentication AWS Lambda trigger.

" + }, + "DefineAuthChallenge":{ + "shape":"ArnType", + "documentation":"

Defines the authentication challenge.

" + }, + "CreateAuthChallenge":{ + "shape":"ArnType", + "documentation":"

Creates an authentication challenge.

" + }, + "VerifyAuthChallengeResponse":{ + "shape":"ArnType", + "documentation":"

Verifies the authentication challenge response.

" + }, + "PreTokenGeneration":{ + "shape":"ArnType", + "documentation":"

A Lambda trigger that is invoked before token generation.

" + }, + "UserMigration":{ + "shape":"ArnType", + "documentation":"

The user migration Lambda config type.

" + } + }, + "documentation":"

Specifies the configuration for AWS Lambda triggers.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when Amazon Cognito throws a limit exceeded exception.

" + } + }, + "documentation":"

This exception is thrown when a user exceeds the limit for a requested AWS resource.

", + "exception":true + }, + "ListDevicesRequest":{ + "type":"structure", + "required":["AccessToken"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access tokens for the request to list devices.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

The limit of the device request.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

The pagination token for the list request.

" + } + }, + "documentation":"

Represents the request to list the devices.

" + }, + "ListDevicesResponse":{ + "type":"structure", + "members":{ + "Devices":{ + "shape":"DeviceListType", + "documentation":"

The devices returned in the list devices response.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

The pagination token for the list device response.

" + } + }, + "documentation":"

Represents the response to list devices.

" + }, + "ListGroupsRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

The limit of the request to list groups.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupListType", + "documentation":"

The group objects for the groups.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListIdentityProvidersRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "MaxResults":{ + "shape":"ListProvidersLimitType", + "documentation":"

The maximum number of identity providers to return.

" + }, + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

A pagination token.

" + } + } + }, + "ListIdentityProvidersResponse":{ + "type":"structure", + "required":["Providers"], + "members":{ + "Providers":{ + "shape":"ProvidersListType", + "documentation":"

A list of identity provider objects.

" + }, + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

A pagination token.

" + } + } + }, + "ListOfStringTypes":{ + "type":"list", + "member":{"shape":"StringType"} + }, + "ListProvidersLimitType":{ + "type":"integer", + "max":60, + "min":0 + }, + "ListResourceServersLimitType":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListResourceServersRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "MaxResults":{ + "shape":"ListResourceServersLimitType", + "documentation":"

The maximum number of resource servers to return.

" + }, + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

A pagination token.

" + } + } + }, + "ListResourceServersResponse":{ + "type":"structure", + "required":["ResourceServers"], + "members":{ + "ResourceServers":{ + "shape":"ResourceServersListType", + "documentation":"

The resource servers.

" + }, + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

A pagination token.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"UserPoolTagsType", + "documentation":"

The tags that are assigned to the user pool.

" + } + } + }, + "ListUserImportJobsRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "MaxResults" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "MaxResults":{ + "shape":"PoolQueryLimitType", + "documentation":"

The maximum number of import jobs you want the request to return.

" + }, + "PaginationToken":{ + "shape":"PaginationKeyType", + "documentation":"

An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

" + } + }, + "documentation":"

Represents the request to list the user import jobs.

" + }, + "ListUserImportJobsResponse":{ + "type":"structure", + "members":{ + "UserImportJobs":{ + "shape":"UserImportJobsListType", + "documentation":"

The user import jobs.

" + }, + "PaginationToken":{ + "shape":"PaginationKeyType", + "documentation":"

An identifier that can be used to return the next set of user import jobs in the list.

" + } + }, + "documentation":"

Represents the response from the server to the request to list the user import jobs.

" + }, + "ListUserPoolClientsRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to list user pool clients.

" + }, + "MaxResults":{ + "shape":"QueryLimit", + "documentation":"

The maximum number of results you want the request to return when listing the user pool clients.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the request to list the user pool clients.

" + }, + "ListUserPoolClientsResponse":{ + "type":"structure", + "members":{ + "UserPoolClients":{ + "shape":"UserPoolClientListType", + "documentation":"

The user pool clients in the response that lists user pool clients.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the response from the server that lists user pool clients.

" + }, + "ListUserPoolsRequest":{ + "type":"structure", + "required":["MaxResults"], + "members":{ + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + }, + "MaxResults":{ + "shape":"PoolQueryLimitType", + "documentation":"

The maximum number of results you want the request to return when listing the user pools.

" + } + }, + "documentation":"

Represents the request to list user pools.

" + }, + "ListUserPoolsResponse":{ + "type":"structure", + "members":{ + "UserPools":{ + "shape":"UserPoolListType", + "documentation":"

The user pools from the response to list users.

" + }, + "NextToken":{ + "shape":"PaginationKeyType", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the response to list user pools.

" + }, + "ListUsersInGroupRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "GroupName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

The limit of the request to list users.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListUsersInGroupResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UsersListType", + "documentation":"

The users returned in the request to list users.

" + }, + "NextToken":{ + "shape":"PaginationKey", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool on which the search should be performed.

" + }, + "AttributesToGet":{ + "shape":"SearchedAttributeNamesListType", + "documentation":"

An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is null, all attributes are returned.

" + }, + "Limit":{ + "shape":"QueryLimitType", + "documentation":"

Maximum number of users to be returned.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + }, + "Filter":{ + "shape":"UserFilterType", + "documentation":"

A filter string of the form \"AttributeName Filter-Type \"AttributeValue\"\". Quotation marks within the filter string must be escaped using the backslash (\\) character. For example, \"family_name = \\\"Reddy\\\"\".

  • AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.

  • Filter-Type: For an exact match, use =, for example, \"given_name = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use ^=, for example, \"given_name ^= \\\"Jon\\\"\".

  • AttributeValue: The attribute value that must be matched for each user.

If the filter string is empty, ListUsers returns all users in the user pool.

You can only search for the following standard attributes:

  • username (case-sensitive)

  • email

  • phone_number

  • name

  • given_name

  • family_name

  • preferred_username

  • cognito:user_status (called Status in the Console) (case-insensitive)

  • status (called Enabled in the Console) (case-sensitive)

  • sub

Custom attributes are not searchable.

For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.

" + } + }, + "documentation":"

Represents the request to list users.

" + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UsersListType", + "documentation":"

The users returned in the request to list users.

" + }, + "PaginationToken":{ + "shape":"SearchPaginationTokenType", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

The response from the request to list users.

" + }, + "LogoutURLsListType":{ + "type":"list", + "member":{"shape":"RedirectUrlType"}, + "max":100, + "min":0 + }, + "LongType":{"type":"long"}, + "MFAMethodNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when Amazon Cognito throws an MFA method not found exception.

" + } + }, + "documentation":"

This exception is thrown when Amazon Cognito cannot find a multi-factor authentication (MFA) method.

", + "exception":true + }, + "MFAOptionListType":{ + "type":"list", + "member":{"shape":"MFAOptionType"} + }, + "MFAOptionType":{ + "type":"structure", + "members":{ + "DeliveryMedium":{ + "shape":"DeliveryMediumType", + "documentation":"

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

" + }, + "AttributeName":{ + "shape":"AttributeNameType", + "documentation":"

The attribute name of the MFA option type. The only valid value is phone_number.

" + } + }, + "documentation":"

This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference actions.

To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList or GetUserResponse$UserMFASettingList responses.

" + }, + "MessageActionType":{ + "type":"string", + "enum":[ + "RESEND", + "SUPPRESS" + ] + }, + "MessageTemplateType":{ + "type":"structure", + "members":{ + "SMSMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The message template for SMS messages.

" + }, + "EmailMessage":{ + "shape":"EmailVerificationMessageType", + "documentation":"

The message template for email messages.

" + }, + "EmailSubject":{ + "shape":"EmailVerificationSubjectType", + "documentation":"

The subject line for email messages.

" + } + }, + "documentation":"

The message template structure.

" + }, + "MessageType":{"type":"string"}, + "NewDeviceMetadataType":{ + "type":"structure", + "members":{ + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "DeviceGroupKey":{ + "shape":"StringType", + "documentation":"

The device group key.

" + } + }, + "documentation":"

The new device metadata type.

" + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns a not authorized exception.

" + } + }, + "documentation":"

This exception is thrown when a user is not authorized.

", + "exception":true + }, + "NotifyConfigurationType":{ + "type":"structure", + "required":["SourceArn"], + "members":{ + "From":{ + "shape":"StringType", + "documentation":"

The email address that is sending the email. It must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

" + }, + "ReplyTo":{ + "shape":"StringType", + "documentation":"

The destination to which the receiver of an email should reply to.

" + }, + "SourceArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the identity that is associated with the sending authorization policy. It permits Amazon Cognito to send for the email address specified in the From parameter.

" + }, + "BlockEmail":{ + "shape":"NotifyEmailType", + "documentation":"

Email template used when a detected risk event is blocked.

" + }, + "NoActionEmail":{ + "shape":"NotifyEmailType", + "documentation":"

The email template used when a detected risk event is allowed.

" + }, + "MfaEmail":{ + "shape":"NotifyEmailType", + "documentation":"

The MFA email template used when MFA is challenged as part of a detected risk.

" + } + }, + "documentation":"

The notify configuration type.

" + }, + "NotifyEmailType":{ + "type":"structure", + "required":["Subject"], + "members":{ + "Subject":{ + "shape":"EmailNotificationSubjectType", + "documentation":"

The subject.

" + }, + "HtmlBody":{ + "shape":"EmailNotificationBodyType", + "documentation":"

The HTML body.

" + }, + "TextBody":{ + "shape":"EmailNotificationBodyType", + "documentation":"

The text body.

" + } + }, + "documentation":"

The notify email type.

" + }, + "NumberAttributeConstraintsType":{ + "type":"structure", + "members":{ + "MinValue":{ + "shape":"StringType", + "documentation":"

The minimum value of an attribute that is of the number data type.

" + }, + "MaxValue":{ + "shape":"StringType", + "documentation":"

The maximum value of an attribute that is of the number data type.

" + } + }, + "documentation":"

The minimum and maximum value of an attribute that is of the number data type.

" + }, + "OAuthFlowType":{ + "type":"string", + "enum":[ + "code", + "implicit", + "client_credentials" + ] + }, + "OAuthFlowsType":{ + "type":"list", + "member":{"shape":"OAuthFlowType"}, + "max":3, + "min":0 + }, + "PaginationKey":{ + "type":"string", + "min":1, + "pattern":"[\\S]+" + }, + "PaginationKeyType":{ + "type":"string", + "min":1, + "pattern":"[\\S]+" + }, + "PasswordPolicyMinLengthType":{ + "type":"integer", + "max":99, + "min":6 + }, + "PasswordPolicyType":{ + "type":"structure", + "members":{ + "MinimumLength":{ + "shape":"PasswordPolicyMinLengthType", + "documentation":"

The minimum length of the password policy that you have set. Cannot be less than 6.

" + }, + "RequireUppercase":{ + "shape":"BooleanType", + "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.

" + }, + "RequireLowercase":{ + "shape":"BooleanType", + "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.

" + }, + "RequireNumbers":{ + "shape":"BooleanType", + "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one number in their password.

" + }, + "RequireSymbols":{ + "shape":"BooleanType", + "documentation":"

In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.

" + }, + "TemporaryPasswordValidityDays":{ + "shape":"TemporaryPasswordValidityDaysType", + "documentation":"

In the password policy you have set, refers to the number of days a temporary password is valid. If the user does not sign-in during this time, their password will need to be reset by an administrator.

When you set TemporaryPasswordValidityDays for a user pool, you will no longer be able to set the deprecated UnusedAccountValidityDays value for that user pool.

" + } + }, + "documentation":"

The password policy type.

" + }, + "PasswordResetRequiredException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when a password reset is required.

" + } + }, + "documentation":"

This exception is thrown when a password reset is required.

", + "exception":true + }, + "PasswordType":{ + "type":"string", + "max":256, + "min":6, + "pattern":"[\\S]+", + "sensitive":true + }, + "PoolQueryLimitType":{ + "type":"integer", + "max":60, + "min":1 + }, + "PreSignedUrlType":{ + "type":"string", + "max":2048, + "min":0 + }, + "PrecedenceType":{ + "type":"integer", + "min":0 + }, + "PreconditionNotMetException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when a precondition is not met.

" + } + }, + "documentation":"

This exception is thrown when a precondition is not met.

", + "exception":true + }, + "ProviderDescription":{ + "type":"structure", + "members":{ + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The identity provider name.

" + }, + "ProviderType":{ + "shape":"IdentityProviderTypeType", + "documentation":"

The identity provider type.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the provider was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the provider was added to the user pool.

" + } + }, + "documentation":"

A container for identity provider details.

" + }, + "ProviderDetailsType":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "ProviderNameType":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "ProviderNameTypeV1":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[^_][\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}][^_]+" + }, + "ProviderUserIdentifierType":{ + "type":"structure", + "members":{ + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The name of the provider, for example, Facebook, Google, or Login with Amazon.

" + }, + "ProviderAttributeName":{ + "shape":"StringType", + "documentation":"

The name of the provider attribute to link to, for example, NameID.

" + }, + "ProviderAttributeValue":{ + "shape":"StringType", + "documentation":"

The value of the provider attribute to link to, for example, xxxxx_account.

" + } + }, + "documentation":"

A container for information about an identity provider for a user pool.

" + }, + "ProvidersListType":{ + "type":"list", + "member":{"shape":"ProviderDescription"}, + "max":50, + "min":0 + }, + "QueryLimit":{ + "type":"integer", + "max":60, + "min":1 + }, + "QueryLimitType":{ + "type":"integer", + "max":60, + "min":0 + }, + "RedirectUrlType":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "RefreshTokenValidityType":{ + "type":"integer", + "max":3650, + "min":0 + }, + "ResendConfirmationCodeRequest":{ + "type":"structure", + "required":[ + "ClientId", + "Username" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "SecretHash":{ + "shape":"SecretHashType", + "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user to whom you wish to resend a confirmation code.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for ResendConfirmationCode calls.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your ResendConfirmationCode request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to resend the confirmation code.

" + }, + "ResendConfirmationCodeResponse":{ + "type":"structure", + "members":{ + "CodeDeliveryDetails":{ + "shape":"CodeDeliveryDetailsType", + "documentation":"

The code delivery details returned by the server in response to the request to resend the confirmation code.

" + } + }, + "documentation":"

The response from the server when the Amazon Cognito Your User Pools service makes the request to resend a confirmation code.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns a resource not found exception.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service cannot find the requested resource.

", + "exception":true + }, + "ResourceServerIdentifierType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" + }, + "ResourceServerNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w\\s+=,.@-]+" + }, + "ResourceServerScopeDescriptionType":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceServerScopeListType":{ + "type":"list", + "member":{"shape":"ResourceServerScopeType"}, + "max":100 + }, + "ResourceServerScopeNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\x21\\x23-\\x2E\\x30-\\x5B\\x5D-\\x7E]+" + }, + "ResourceServerScopeType":{ + "type":"structure", + "required":[ + "ScopeName", + "ScopeDescription" + ], + "members":{ + "ScopeName":{ + "shape":"ResourceServerScopeNameType", + "documentation":"

The name of the scope.

" + }, + "ScopeDescription":{ + "shape":"ResourceServerScopeDescriptionType", + "documentation":"

A description of the scope.

" + } + }, + "documentation":"

A resource server scope.

" + }, + "ResourceServerType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that hosts the resource server.

" + }, + "Identifier":{ + "shape":"ResourceServerIdentifierType", + "documentation":"

The identifier for the resource server.

" + }, + "Name":{ + "shape":"ResourceServerNameType", + "documentation":"

The name of the resource server.

" + }, + "Scopes":{ + "shape":"ResourceServerScopeListType", + "documentation":"

A list of scopes that are defined for the resource server.

" + } + }, + "documentation":"

A container for information about a resource server for a user pool.

" + }, + "ResourceServersListType":{ + "type":"list", + "member":{"shape":"ResourceServerType"} + }, + "RespondToAuthChallengeRequest":{ + "type":"structure", + "required":[ + "ClientId", + "ChallengeName" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + }, + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The challenge name. For more information, see .

ADMIN_NO_SRP_AUTH is not a valid value.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If InitiateAuth or RespondToAuthChallenge API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

" + }, + "ChallengeResponses":{ + "shape":"ChallengeResponsesType", + "documentation":"

The challenge responses. These are inputs corresponding to the value of ChallengeName, for example:

SECRET_HASH (if app client is configured with client secret) applies to all inputs below (including SOFTWARE_TOKEN_MFA).

  • SMS_MFA: SMS_MFA_CODE, USERNAME.

  • PASSWORD_VERIFIER: PASSWORD_CLAIM_SIGNATURE, PASSWORD_CLAIM_SECRET_BLOCK, TIMESTAMP, USERNAME.

  • NEW_PASSWORD_REQUIRED: NEW_PASSWORD, any other required attributes, USERNAME.

  • SOFTWARE_TOKEN_MFA: USERNAME and SOFTWARE_TOKEN_MFA_CODE are required attributes.

  • DEVICE_SRP_AUTH requires USERNAME, DEVICE_KEY, SRP_A (and SECRET_HASH).

  • DEVICE_PASSWORD_VERIFIER requires everything that PASSWORD_VERIFIER requires plus DEVICE_KEY.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for RespondToAuthChallenge calls.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the RespondToAuthChallenge API action, Amazon Cognito invokes any functions that are assigned to the following triggers: post authentication, pre token generation, define auth challenge, create auth challenge, and verify auth challenge. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your RespondToAuthChallenge request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

The request to respond to an authentication challenge.

" + }, + "RespondToAuthChallengeResponse":{ + "type":"structure", + "members":{ + "ChallengeName":{ + "shape":"ChallengeNameType", + "documentation":"

The challenge name. For more information, see .

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service. If the or API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next RespondToAuthChallenge API call.

" + }, + "ChallengeParameters":{ + "shape":"ChallengeParametersType", + "documentation":"

The challenge parameters. For more information, see .

" + }, + "AuthenticationResult":{ + "shape":"AuthenticationResultType", + "documentation":"

The result returned by the server in response to the request to respond to the authentication challenge.

" + } + }, + "documentation":"

The response to respond to the authentication challenge.

" + }, + "RiskConfigurationType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID.

" + }, + "CompromisedCredentialsRiskConfiguration":{ + "shape":"CompromisedCredentialsRiskConfigurationType", + "documentation":"

The compromised credentials risk configuration object including the EventFilter and the EventAction

" + }, + "AccountTakeoverRiskConfiguration":{ + "shape":"AccountTakeoverRiskConfigurationType", + "documentation":"

The account takeover risk configuration object including the NotifyConfiguration object and Actions to take in the case of an account takeover.

" + }, + "RiskExceptionConfiguration":{ + "shape":"RiskExceptionConfigurationType", + "documentation":"

The configuration to override the risk decision.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The last modified date.

" + } + }, + "documentation":"

The risk configuration type.

" + }, + "RiskDecisionType":{ + "type":"string", + "enum":[ + "NoRisk", + "AccountTakeover", + "Block" + ] + }, + "RiskExceptionConfigurationType":{ + "type":"structure", + "members":{ + "BlockedIPRangeList":{ + "shape":"BlockedIPRangeListType", + "documentation":"

Overrides the risk decision to always block the pre-authentication requests. The IP range is in CIDR notation: a compact representation of an IP address and its associated routing prefix.

" + }, + "SkippedIPRangeList":{ + "shape":"SkippedIPRangeListType", + "documentation":"

Risk detection is not performed on the IP addresses in the range list. The IP range is in CIDR notation.

" + } + }, + "documentation":"

The type of the configuration to override the risk decision.

" + }, + "RiskLevelType":{ + "type":"string", + "enum":[ + "Low", + "Medium", + "High" + ] + }, + "S3BucketType":{ + "type":"string", + "max":1024, + "min":3, + "pattern":"^[0-9A-Za-z\\.\\-_]*(?Specifies whether SMS text message MFA is enabled.

" + }, + "PreferredMfa":{ + "shape":"BooleanType", + "documentation":"

Specifies whether SMS is the preferred MFA method.

" + } + }, + "documentation":"

The type used for enabling SMS MFA at the user level.

" + }, + "SchemaAttributeType":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CustomAttributeNameType", + "documentation":"

A schema attribute of the name type.

" + }, + "AttributeDataType":{ + "shape":"AttributeDataType", + "documentation":"

The attribute data type.

" + }, + "DeveloperOnlyAttribute":{ + "shape":"BooleanType", + "documentation":"

Specifies whether the attribute type is developer only.

", + "box":true + }, + "Mutable":{ + "shape":"BooleanType", + "documentation":"

Specifies whether the value of the attribute can be changed.

For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.

", + "box":true + }, + "Required":{ + "shape":"BooleanType", + "documentation":"

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

", + "box":true + }, + "NumberAttributeConstraints":{ + "shape":"NumberAttributeConstraintsType", + "documentation":"

Specifies the constraints for an attribute of the number type.

" + }, + "StringAttributeConstraints":{ + "shape":"StringAttributeConstraintsType", + "documentation":"

Specifies the constraints for an attribute of the string type.

" + } + }, + "documentation":"

Contains information about the schema attribute.

" + }, + "SchemaAttributesListType":{ + "type":"list", + "member":{"shape":"SchemaAttributeType"}, + "max":50, + "min":1 + }, + "ScopeDoesNotExistException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when the specified scope does not exist.

", + "exception":true + }, + "ScopeListType":{ + "type":"list", + "member":{"shape":"ScopeType"}, + "max":50 + }, + "ScopeType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+" + }, + "SearchPaginationTokenType":{ + "type":"string", + "min":1, + "pattern":"[\\S]+" + }, + "SearchedAttributeNamesListType":{ + "type":"list", + "member":{"shape":"AttributeNameType"} + }, + "SecretCodeType":{ + "type":"string", + "min":16, + "pattern":"[A-Za-z0-9]+", + "sensitive":true + }, + "SecretHashType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=/]+", + "sensitive":true + }, + "SessionType":{ + "type":"string", + "max":2048, + "min":20 + }, + "SetRiskConfigurationRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The app client ID. If ClientId is null, then the risk configuration is mapped to userPoolId. When the client ID is null, the same risk configuration is applied to all the clients in the userPool.

Otherwise, ClientId is mapped to the client. When the client ID is not null, the user pool configuration is overridden and the risk configuration for the client is used instead.

" + }, + "CompromisedCredentialsRiskConfiguration":{ + "shape":"CompromisedCredentialsRiskConfigurationType", + "documentation":"

The compromised credentials risk configuration.

" + }, + "AccountTakeoverRiskConfiguration":{ + "shape":"AccountTakeoverRiskConfigurationType", + "documentation":"

The account takeover risk configuration.

" + }, + "RiskExceptionConfiguration":{ + "shape":"RiskExceptionConfigurationType", + "documentation":"

The configuration to override the risk decision.

" + } + } + }, + "SetRiskConfigurationResponse":{ + "type":"structure", + "required":["RiskConfiguration"], + "members":{ + "RiskConfiguration":{ + "shape":"RiskConfigurationType", + "documentation":"

The risk configuration.

" + } + } + }, + "SetUICustomizationRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The client ID for the client app.

" + }, + "CSS":{ + "shape":"CSSType", + "documentation":"

The CSS values in the UI customization.

" + }, + "ImageFile":{ + "shape":"ImageFileType", + "documentation":"

The uploaded logo image for the UI customization.

" + } + } + }, + "SetUICustomizationResponse":{ + "type":"structure", + "required":["UICustomization"], + "members":{ + "UICustomization":{ + "shape":"UICustomizationType", + "documentation":"

The UI customization information.

" + } + } + }, + "SetUserMFAPreferenceRequest":{ + "type":"structure", + "required":["AccessToken"], + "members":{ + "SMSMfaSettings":{ + "shape":"SMSMfaSettingsType", + "documentation":"

The SMS text message multi-factor authentication (MFA) settings.

" + }, + "SoftwareTokenMfaSettings":{ + "shape":"SoftwareTokenMfaSettingsType", + "documentation":"

The time-based one-time password software token MFA settings.

" + }, + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token for the user.

" + } + } + }, + "SetUserMFAPreferenceResponse":{ + "type":"structure", + "members":{ + } + }, + "SetUserPoolMfaConfigRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "SmsMfaConfiguration":{ + "shape":"SmsMfaConfigType", + "documentation":"

The SMS text message MFA configuration.

" + }, + "SoftwareTokenMfaConfiguration":{ + "shape":"SoftwareTokenMfaConfigType", + "documentation":"

The software token MFA configuration.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

The MFA configuration. Valid values include:

  • OFF MFA will not be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

" + } + } + }, + "SetUserPoolMfaConfigResponse":{ + "type":"structure", + "members":{ + "SmsMfaConfiguration":{ + "shape":"SmsMfaConfigType", + "documentation":"

The SMS text message MFA configuration.

" + }, + "SoftwareTokenMfaConfiguration":{ + "shape":"SoftwareTokenMfaConfigType", + "documentation":"

The software token MFA configuration.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

The MFA configuration. Valid values include:

  • OFF MFA will not be used for any users.

  • ON MFA is required for all users to sign in.

  • OPTIONAL MFA will be required only for individual users who have an MFA factor enabled.

" + } + } + }, + "SetUserSettingsRequest":{ + "type":"structure", + "required":[ + "AccessToken", + "MFAOptions" + ], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token for the set user settings request.

" + }, + "MFAOptions":{ + "shape":"MFAOptionListType", + "documentation":"

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

" + } + }, + "documentation":"

Represents the request to set user settings.

" + }, + "SetUserSettingsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response from the server for a set user settings request.

" + }, + "SignUpRequest":{ + "type":"structure", + "required":[ + "ClientId", + "Username", + "Password" + ], + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "SecretHash":{ + "shape":"SecretHashType", + "documentation":"

A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to register.

" + }, + "Password":{ + "shape":"PasswordType", + "documentation":"

The password of the user you wish to register.

" + }, + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + }, + "ValidationData":{ + "shape":"AttributeListType", + "documentation":"

The validation data in the request to register a user.

" + }, + "AnalyticsMetadata":{ + "shape":"AnalyticsMetadataType", + "documentation":"

The Amazon Pinpoint analytics metadata for collecting metrics for SignUp calls.

" + }, + "UserContextData":{ + "shape":"UserContextDataType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the SignUp API action, Amazon Cognito invokes any functions that are assigned to the following triggers: pre sign-up, custom message, and post confirmation. When Amazon Cognito invokes any of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your SignUp request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to register a user.

" + }, + "SignUpResponse":{ + "type":"structure", + "required":[ + "UserConfirmed", + "UserSub" + ], + "members":{ + "UserConfirmed":{ + "shape":"BooleanType", + "documentation":"

A response from the server indicating that a user registration has been confirmed.

" + }, + "CodeDeliveryDetails":{ + "shape":"CodeDeliveryDetailsType", + "documentation":"

The code delivery details returned by the server response to the user registration request.

" + }, + "UserSub":{ + "shape":"StringType", + "documentation":"

The UUID of the authenticated user. This is not the same as username.

" + } + }, + "documentation":"

The response from the server for a registration request.

" + }, + "SkippedIPRangeListType":{ + "type":"list", + "member":{"shape":"StringType"}, + "max":20 + }, + "SmsConfigurationType":{ + "type":"structure", + "required":["SnsCallerArn"], + "members":{ + "SnsCallerArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) caller. This is the ARN of the IAM role in your AWS account which Cognito will use to send SMS messages.

" + }, + "ExternalId":{ + "shape":"StringType", + "documentation":"

The external ID is a value that we recommend you use to add security to your IAM role which is used to call Amazon SNS to send SMS messages for your user pool. If you provide an ExternalId, the Cognito User Pool will include it when attempting to assume your IAM role, so that you can set your roles trust policy to require the ExternalID. If you use the Cognito Management Console to create a role for SMS MFA, Cognito will create a role with the required permissions and a trust policy that demonstrates use of the ExternalId.

" + } + }, + "documentation":"

The SMS configuration type that includes the settings the Cognito User Pool needs to call for the Amazon SNS service to send an SMS message from your AWS account. The Cognito User Pool makes the request to the Amazon SNS Service by using an AWS IAM role that you provide for your AWS account.

" + }, + "SmsMfaConfigType":{ + "type":"structure", + "members":{ + "SmsAuthenticationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The SMS authentication message that will be sent to users with the code they need to sign in. The message must contain the ‘{####}’ placeholder, which will be replaced with the code. If the message is not included, and default message will be used.

" + }, + "SmsConfiguration":{ + "shape":"SmsConfigurationType", + "documentation":"

The SMS configuration.

" + } + }, + "documentation":"

The SMS text message multi-factor authentication (MFA) configuration type.

" + }, + "SmsVerificationMessageType":{ + "type":"string", + "max":140, + "min":6, + "pattern":".*\\{####\\}.*" + }, + "SoftwareTokenMFANotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when the software token TOTP multi-factor authentication (MFA) is not enabled for the user pool.

", + "exception":true + }, + "SoftwareTokenMFAUserCodeType":{ + "type":"string", + "max":6, + "min":6, + "pattern":"[0-9]+" + }, + "SoftwareTokenMfaConfigType":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"BooleanType", + "documentation":"

Specifies whether software token MFA is enabled.

" + } + }, + "documentation":"

The type used for enabling software token MFA at the user pool level.

" + }, + "SoftwareTokenMfaSettingsType":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"BooleanType", + "documentation":"

Specifies whether software token MFA is enabled.

" + }, + "PreferredMfa":{ + "shape":"BooleanType", + "documentation":"

Specifies whether software token MFA is the preferred MFA method.

" + } + }, + "documentation":"

The type used for enabling software token MFA at the user level.

" + }, + "StartUserImportJobRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "JobId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "JobId":{ + "shape":"UserImportJobIdType", + "documentation":"

The job ID for the user import job.

" + } + }, + "documentation":"

Represents the request to start the user import job.

" + }, + "StartUserImportJobResponse":{ + "type":"structure", + "members":{ + "UserImportJob":{ + "shape":"UserImportJobType", + "documentation":"

The job object that represents the user import job.

" + } + }, + "documentation":"

Represents the response from the server to the request to start the user import job.

" + }, + "StatusType":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "StopUserImportJobRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "JobId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "JobId":{ + "shape":"UserImportJobIdType", + "documentation":"

The job ID for the user import job.

" + } + }, + "documentation":"

Represents the request to stop the user import job.

" + }, + "StopUserImportJobResponse":{ + "type":"structure", + "members":{ + "UserImportJob":{ + "shape":"UserImportJobType", + "documentation":"

The job object that represents the user import job.

" + } + }, + "documentation":"

Represents the response from the server to the request to stop the user import job.

" + }, + "StringAttributeConstraintsType":{ + "type":"structure", + "members":{ + "MinLength":{ + "shape":"StringType", + "documentation":"

The minimum length.

" + }, + "MaxLength":{ + "shape":"StringType", + "documentation":"

The maximum length.

" + } + }, + "documentation":"

The constraints associated with a string attribute.

" + }, + "StringType":{"type":"string"}, + "SupportedIdentityProvidersListType":{ + "type":"list", + "member":{"shape":"ProviderNameType"} + }, + "TagKeysType":{ + "type":"string", + "max":128, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the user pool to assign the tags to.

" + }, + "Tags":{ + "shape":"UserPoolTagsType", + "documentation":"

The tags to assign to the user pool.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValueType":{ + "type":"string", + "max":256, + "min":0 + }, + "TemporaryPasswordValidityDaysType":{ + "type":"integer", + "max":365, + "min":0 + }, + "TokenModelType":{ + "type":"string", + "pattern":"[A-Za-z0-9-_=.]+", + "sensitive":true + }, + "TooManyFailedAttemptsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns a too many failed attempts exception.

" + } + }, + "documentation":"

This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).

", + "exception":true + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns a too many requests exception.

" + } + }, + "documentation":"

This exception is thrown when the user has made too many requests for a given operation.

", + "exception":true + }, + "UICustomizationType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The client ID for the client app.

" + }, + "ImageUrl":{ + "shape":"ImageUrlType", + "documentation":"

The logo image for the UI customization.

" + }, + "CSS":{ + "shape":"CSSType", + "documentation":"

The CSS values in the UI customization.

" + }, + "CSSVersion":{ + "shape":"CSSVersionType", + "documentation":"

The CSS version number.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The last-modified date for the UI customization.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The creation date for the UI customization.

" + } + }, + "documentation":"

A container for the UI customization information for a user pool's built-in app UI.

" + }, + "UnexpectedLambdaException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns an unexpected AWS Lambda exception.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.

", + "exception":true + }, + "UnsupportedIdentityProviderException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when the specified identifier is not supported.

", + "exception":true + }, + "UnsupportedUserStateException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the user is in an unsupported state.

" + } + }, + "documentation":"

The request failed because the user is in an unsupported state.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the user pool that the tags are assigned to.

" + }, + "TagKeys":{ + "shape":"UserPoolTagsListType", + "documentation":"

The keys of the tags to remove from the user pool.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAuthEventFeedbackRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Username", + "EventId", + "FeedbackToken", + "FeedbackValue" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

The user pool username.

" + }, + "EventId":{ + "shape":"EventIdType", + "documentation":"

The event ID.

" + }, + "FeedbackToken":{ + "shape":"TokenModelType", + "documentation":"

The feedback token.

" + }, + "FeedbackValue":{ + "shape":"FeedbackValueType", + "documentation":"

The authentication event feedback value.

" + } + } + }, + "UpdateAuthEventFeedbackResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDeviceStatusRequest":{ + "type":"structure", + "required":[ + "AccessToken", + "DeviceKey" + ], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + }, + "DeviceKey":{ + "shape":"DeviceKeyType", + "documentation":"

The device key.

" + }, + "DeviceRememberedStatus":{ + "shape":"DeviceRememberedStatusType", + "documentation":"

The status of whether a device is remembered.

" + } + }, + "documentation":"

Represents the request to update the device status.

" + }, + "UpdateDeviceStatusResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response to the request to update the device status.

" + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserPoolId" + ], + "members":{ + "GroupName":{ + "shape":"GroupNameType", + "documentation":"

The name of the group.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

A string containing the new description of the group.

" + }, + "RoleArn":{ + "shape":"ArnType", + "documentation":"

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

" + }, + "Precedence":{ + "shape":"PrecedenceType", + "documentation":"

The new precedence value for the group. For more information about this parameter, see .

" + } + } + }, + "UpdateGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"GroupType", + "documentation":"

The group object for the group.

" + } + } + }, + "UpdateIdentityProviderRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ProviderName" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID.

" + }, + "ProviderName":{ + "shape":"ProviderNameType", + "documentation":"

The identity provider name.

" + }, + "ProviderDetails":{ + "shape":"ProviderDetailsType", + "documentation":"

The identity provider details to be updated, such as MetadataURL and MetadataFile.

" + }, + "AttributeMapping":{ + "shape":"AttributeMappingType", + "documentation":"

The identity provider attribute mapping to be changed.

" + }, + "IdpIdentifiers":{ + "shape":"IdpIdentifiersListType", + "documentation":"

A list of identity provider identifiers.

" + } + } + }, + "UpdateIdentityProviderResponse":{ + "type":"structure", + "required":["IdentityProvider"], + "members":{ + "IdentityProvider":{ + "shape":"IdentityProviderType", + "documentation":"

The identity provider object.

" + } + } + }, + "UpdateResourceServerRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "Identifier", + "Name" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool.

" + }, + "Identifier":{ + "shape":"ResourceServerIdentifierType", + "documentation":"

The identifier for the resource server.

" + }, + "Name":{ + "shape":"ResourceServerNameType", + "documentation":"

The name of the resource server.

" + }, + "Scopes":{ + "shape":"ResourceServerScopeListType", + "documentation":"

The scope values to be set for the resource server.

" + } + } + }, + "UpdateResourceServerResponse":{ + "type":"structure", + "required":["ResourceServer"], + "members":{ + "ResourceServer":{ + "shape":"ResourceServerType", + "documentation":"

The resource server.

" + } + } + }, + "UpdateUserAttributesRequest":{ + "type":"structure", + "required":[ + "UserAttributes", + "AccessToken" + ], + "members":{ + "UserAttributes":{ + "shape":"AttributeListType", + "documentation":"

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

" + }, + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token for the request to update user attributes.

" + }, + "ClientMetadata":{ + "shape":"ClientMetadataType", + "documentation":"

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

You create custom workflows by assigning AWS Lambda functions to user pool triggers. When you use the UpdateUserAttributes API action, Amazon Cognito invokes the functions that are assigned to the custom message and pre mutation triggers. When Amazon Cognito invokes either of these functions, it passes a JSON payload, which the function receives as input. This payload contains a clientMetadata attribute, which provides the data that you assigned to the ClientMetadata parameter in your UpdateUserAttributes request. In your function code in AWS Lambda, you can process the clientMetadata value to enhance your workflow for your specific needs.

For more information, see Customizing User Pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.

Take the following limitations into consideration when you use the ClientMetadata parameter:

  • Amazon Cognito does not store the ClientMetadata value. This data is available only to AWS Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose.

  • Amazon Cognito does not validate the ClientMetadata value.

  • Amazon Cognito does not encrypt the the ClientMetadata value, so don't use it to provide sensitive information.

" + } + }, + "documentation":"

Represents the request to update user attributes.

" + }, + "UpdateUserAttributesResponse":{ + "type":"structure", + "members":{ + "CodeDeliveryDetailsList":{ + "shape":"CodeDeliveryDetailsListType", + "documentation":"

The code delivery details list from the server for the request to update user attributes.

" + } + }, + "documentation":"

Represents the response from the server for the request to update user attributes.

" + }, + "UpdateUserPoolClientRequest":{ + "type":"structure", + "required":[ + "UserPoolId", + "ClientId" + ], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to update the user pool client.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "ClientName":{ + "shape":"ClientNameType", + "documentation":"

The client name from the update user pool client request.

" + }, + "RefreshTokenValidity":{ + "shape":"RefreshTokenValidityType", + "documentation":"

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

" + }, + "ReadAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The read-only attributes of the user pool.

" + }, + "WriteAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The writeable attributes of the user pool.

" + }, + "ExplicitAuthFlows":{ + "shape":"ExplicitAuthFlowsListType", + "documentation":"

Explicit authentication flows.

" + }, + "SupportedIdentityProviders":{ + "shape":"SupportedIdentityProvidersListType", + "documentation":"

A list of provider names for the identity providers that are supported on this client.

" + }, + "CallbackURLs":{ + "shape":"CallbackURLsListType", + "documentation":"

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "LogoutURLs":{ + "shape":"LogoutURLsListType", + "documentation":"

A list of allowed logout URLs for the identity providers.

" + }, + "DefaultRedirectURI":{ + "shape":"RedirectUrlType", + "documentation":"

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "AllowedOAuthFlows":{ + "shape":"OAuthFlowsType", + "documentation":"

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

" + }, + "AllowedOAuthScopes":{ + "shape":"ScopeListType", + "documentation":"

A list of allowed OAuth scopes. Currently supported values are \"phone\", \"email\", \"openid\", and \"Cognito\". In addition to these values, custom scopes created in Resource Servers are also supported.

" + }, + "AllowedOAuthFlowsUserPoolClient":{ + "shape":"BooleanType", + "documentation":"

Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

" + }, + "AnalyticsConfiguration":{ + "shape":"AnalyticsConfigurationType", + "documentation":"

The Amazon Pinpoint analytics configuration for collecting metrics for this user pool.

" + } + }, + "documentation":"

Represents the request to update the user pool client.

" + }, + "UpdateUserPoolClientResponse":{ + "type":"structure", + "members":{ + "UserPoolClient":{ + "shape":"UserPoolClientType", + "documentation":"

The user pool client value from the response from the server when an update user pool client request is made.

" + } + }, + "documentation":"

Represents the response from the server to the request to update the user pool client.

" + }, + "UpdateUserPoolDomainRequest":{ + "type":"structure", + "required":[ + "Domain", + "UserPoolId", + "CustomDomainConfig" + ], + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"

The domain name for the custom domain that hosts the sign-up and sign-in pages for your application. For example: auth.example.com.

This string can include only lowercase letters, numbers, and hyphens. Do not use a hyphen for the first or last character. Use periods to separate subdomain names.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The ID of the user pool that is associated with the custom domain that you are updating the certificate for.

" + }, + "CustomDomainConfig":{ + "shape":"CustomDomainConfigType", + "documentation":"

The configuration for a custom domain that hosts the sign-up and sign-in pages for your application. Use this object to specify an SSL certificate that is managed by ACM.

" + } + }, + "documentation":"

The UpdateUserPoolDomain request input.

" + }, + "UpdateUserPoolDomainResponse":{ + "type":"structure", + "members":{ + "CloudFrontDomain":{ + "shape":"DomainType", + "documentation":"

The Amazon CloudFront endpoint that Amazon Cognito set up when you added the custom domain to your user pool.

" + } + }, + "documentation":"

The UpdateUserPoolDomain response output.

" + }, + "UpdateUserPoolRequest":{ + "type":"structure", + "required":["UserPoolId"], + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool you want to update.

" + }, + "Policies":{ + "shape":"UserPoolPolicyType", + "documentation":"

A container with the policies you wish to update in a user pool.

" + }, + "LambdaConfig":{ + "shape":"LambdaConfigType", + "documentation":"

The AWS Lambda configuration information from the request to update the user pool.

" + }, + "AutoVerifiedAttributes":{ + "shape":"VerifiedAttributesListType", + "documentation":"

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

" + }, + "SmsVerificationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

A container with information about the SMS verification message.

" + }, + "EmailVerificationMessage":{ + "shape":"EmailVerificationMessageType", + "documentation":"

The contents of the email verification message.

" + }, + "EmailVerificationSubject":{ + "shape":"EmailVerificationSubjectType", + "documentation":"

The subject of the email verification message.

" + }, + "VerificationMessageTemplate":{ + "shape":"VerificationMessageTemplateType", + "documentation":"

The template for verification messages.

" + }, + "SmsAuthenticationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The contents of the SMS authentication message.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

" + }, + "DeviceConfiguration":{ + "shape":"DeviceConfigurationType", + "documentation":"

Device configuration.

" + }, + "EmailConfiguration":{ + "shape":"EmailConfigurationType", + "documentation":"

Email configuration.

" + }, + "SmsConfiguration":{ + "shape":"SmsConfigurationType", + "documentation":"

SMS configuration.

" + }, + "UserPoolTags":{ + "shape":"UserPoolTagsType", + "documentation":"

The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria.

" + }, + "AdminCreateUserConfig":{ + "shape":"AdminCreateUserConfigType", + "documentation":"

The configuration for AdminCreateUser requests.

" + }, + "UserPoolAddOns":{ + "shape":"UserPoolAddOnsType", + "documentation":"

Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value \"AUDIT\".

" + } + }, + "documentation":"

Represents the request to update the user pool.

" + }, + "UpdateUserPoolResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the response from the server when you make a request to update the user pool.

" + }, + "UserContextDataType":{ + "type":"structure", + "members":{ + "EncodedData":{ + "shape":"StringType", + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + } + }, + "documentation":"

Contextual data such as the user's device fingerprint, IP address, or location used for evaluating the risk of an unexpected event by Amazon Cognito advanced security.

" + }, + "UserFilterType":{ + "type":"string", + "max":256 + }, + "UserImportInProgressException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the user pool has an import job running.

" + } + }, + "documentation":"

This exception is thrown when you are trying to modify a user pool while a user import job is in progress for that pool.

", + "exception":true + }, + "UserImportJobIdType":{ + "type":"string", + "max":55, + "min":1, + "pattern":"import-[0-9a-zA-Z-]+" + }, + "UserImportJobNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w\\s+=,.@-]+" + }, + "UserImportJobStatusType":{ + "type":"string", + "enum":[ + "Created", + "Pending", + "InProgress", + "Stopping", + "Expired", + "Stopped", + "Failed", + "Succeeded" + ] + }, + "UserImportJobType":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"UserImportJobNameType", + "documentation":"

The job name for the user import job.

" + }, + "JobId":{ + "shape":"UserImportJobIdType", + "documentation":"

The job ID for the user import job.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool that the users are being imported into.

" + }, + "PreSignedUrl":{ + "shape":"PreSignedUrlType", + "documentation":"

The pre-signed URL to be used to upload the .csv file.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the user import job was created.

" + }, + "StartDate":{ + "shape":"DateType", + "documentation":"

The date when the user import job was started.

" + }, + "CompletionDate":{ + "shape":"DateType", + "documentation":"

The date when the user import job was completed.

" + }, + "Status":{ + "shape":"UserImportJobStatusType", + "documentation":"

The status of the user import job. One of the following:

  • Created - The job was created but not started.

  • Pending - A transition state. You have started the job, but it has not begun importing users yet.

  • InProgress - The job has started, and users are being imported.

  • Stopping - You have stopped the job, but the job has not stopped importing users yet.

  • Stopped - You have stopped the job, and the job has stopped importing users.

  • Succeeded - The job has completed successfully.

  • Failed - The job has stopped due to an error.

  • Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.

" + }, + "CloudWatchLogsRoleArn":{ + "shape":"ArnType", + "documentation":"

The role ARN for the Amazon CloudWatch Logging role for the user import job. For more information, see \"Creating the CloudWatch Logs IAM Role\" in the Amazon Cognito Developer Guide.

" + }, + "ImportedUsers":{ + "shape":"LongType", + "documentation":"

The number of users that were successfully imported.

" + }, + "SkippedUsers":{ + "shape":"LongType", + "documentation":"

The number of users that were skipped.

" + }, + "FailedUsers":{ + "shape":"LongType", + "documentation":"

The number of users that could not be imported.

" + }, + "CompletionMessage":{ + "shape":"CompletionMessageType", + "documentation":"

The message returned when the user import job is completed.

" + } + }, + "documentation":"

The user import job type.

" + }, + "UserImportJobsListType":{ + "type":"list", + "member":{"shape":"UserImportJobType"}, + "max":50, + "min":1 + }, + "UserLambdaValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when the Amazon Cognito service returns a user validation exception with the AWS Lambda service.

" + } + }, + "documentation":"

This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.

", + "exception":true + }, + "UserMFASettingListType":{ + "type":"list", + "member":{"shape":"StringType"} + }, + "UserNotConfirmedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when a user is not confirmed successfully.

" + } + }, + "documentation":"

This exception is thrown when a user is not confirmed successfully.

", + "exception":true + }, + "UserNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when a user is not found.

" + } + }, + "documentation":"

This exception is thrown when a user is not found.

", + "exception":true + }, + "UserPoolAddOnNotEnabledException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when user pool add-ons are not enabled.

", + "exception":true + }, + "UserPoolAddOnsType":{ + "type":"structure", + "required":["AdvancedSecurityMode"], + "members":{ + "AdvancedSecurityMode":{ + "shape":"AdvancedSecurityModeType", + "documentation":"

The advanced security mode.

" + } + }, + "documentation":"

The user pool add-ons type.

" + }, + "UserPoolClientDescription":{ + "type":"structure", + "members":{ + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool where you want to describe the user pool client.

" + }, + "ClientName":{ + "shape":"ClientNameType", + "documentation":"

The client name from the user pool client description.

" + } + }, + "documentation":"

The description of the user pool client.

" + }, + "UserPoolClientListType":{ + "type":"list", + "member":{"shape":"UserPoolClientDescription"} + }, + "UserPoolClientType":{ + "type":"structure", + "members":{ + "UserPoolId":{ + "shape":"UserPoolIdType", + "documentation":"

The user pool ID for the user pool client.

" + }, + "ClientName":{ + "shape":"ClientNameType", + "documentation":"

The client name from the user pool request of the client type.

" + }, + "ClientId":{ + "shape":"ClientIdType", + "documentation":"

The ID of the client associated with the user pool.

" + }, + "ClientSecret":{ + "shape":"ClientSecretType", + "documentation":"

The client secret from the user pool request of the client type.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the user pool client was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the user pool client was created.

" + }, + "RefreshTokenValidity":{ + "shape":"RefreshTokenValidityType", + "documentation":"

The time limit, in days, after which the refresh token is no longer valid and cannot be used.

" + }, + "ReadAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The Read-only attributes.

" + }, + "WriteAttributes":{ + "shape":"ClientPermissionListType", + "documentation":"

The writeable attributes.

" + }, + "ExplicitAuthFlows":{ + "shape":"ExplicitAuthFlowsListType", + "documentation":"

The explicit authentication flows.

" + }, + "SupportedIdentityProviders":{ + "shape":"SupportedIdentityProvidersListType", + "documentation":"

A list of provider names for the identity providers that are supported on this client.

" + }, + "CallbackURLs":{ + "shape":"CallbackURLsListType", + "documentation":"

A list of allowed redirect (callback) URLs for the identity providers.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "LogoutURLs":{ + "shape":"LogoutURLsListType", + "documentation":"

A list of allowed logout URLs for the identity providers.

" + }, + "DefaultRedirectURI":{ + "shape":"RedirectUrlType", + "documentation":"

The default redirect URI. Must be in the CallbackURLs list.

A redirect URI must:

  • Be an absolute URI.

  • Be registered with the authorization server.

  • Not include a fragment component.

See OAuth 2.0 - Redirection Endpoint.

Amazon Cognito requires HTTPS over HTTP except for http://localhost for testing purposes only.

App callback URLs such as myapp://example are also supported.

" + }, + "AllowedOAuthFlows":{ + "shape":"OAuthFlowsType", + "documentation":"

Set to code to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.

Set to token to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.

" + }, + "AllowedOAuthScopes":{ + "shape":"ScopeListType", + "documentation":"

A list of allowed OAuth scopes. Currently supported values are \"phone\", \"email\", \"openid\", and \"Cognito\". In addition to these values, custom scopes created in Resource Servers are also supported.

" + }, + "AllowedOAuthFlowsUserPoolClient":{ + "shape":"BooleanType", + "documentation":"

Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.

", + "box":true + }, + "AnalyticsConfiguration":{ + "shape":"AnalyticsConfigurationType", + "documentation":"

The Amazon Pinpoint analytics configuration for the user pool client.

" + } + }, + "documentation":"

Contains information about a user pool client.

" + }, + "UserPoolDescriptionType":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"UserPoolIdType", + "documentation":"

The ID in a user pool description.

" + }, + "Name":{ + "shape":"UserPoolNameType", + "documentation":"

The name in a user pool description.

" + }, + "LambdaConfig":{ + "shape":"LambdaConfigType", + "documentation":"

The AWS Lambda configuration information in a user pool description.

" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The user pool status in a user pool description.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the user pool description was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the user pool description was created.

" + } + }, + "documentation":"

A user pool description.

" + }, + "UserPoolIdType":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+_[0-9a-zA-Z]+" + }, + "UserPoolListType":{ + "type":"list", + "member":{"shape":"UserPoolDescriptionType"} + }, + "UserPoolMfaType":{ + "type":"string", + "enum":[ + "OFF", + "ON", + "OPTIONAL" + ] + }, + "UserPoolNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w\\s+=,.@-]+" + }, + "UserPoolPolicyType":{ + "type":"structure", + "members":{ + "PasswordPolicy":{ + "shape":"PasswordPolicyType", + "documentation":"

The password policy.

" + } + }, + "documentation":"

The policy associated with a user pool.

" + }, + "UserPoolTaggingException":{ + "type":"structure", + "members":{ + "message":{"shape":"MessageType"} + }, + "documentation":"

This exception is thrown when a user pool tag cannot be set or updated.

", + "exception":true + }, + "UserPoolTagsListType":{ + "type":"list", + "member":{"shape":"TagKeysType"} + }, + "UserPoolTagsType":{ + "type":"map", + "key":{"shape":"TagKeysType"}, + "value":{"shape":"TagValueType"} + }, + "UserPoolType":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"UserPoolIdType", + "documentation":"

The ID of the user pool.

" + }, + "Name":{ + "shape":"UserPoolNameType", + "documentation":"

The name of the user pool.

" + }, + "Policies":{ + "shape":"UserPoolPolicyType", + "documentation":"

The policies associated with the user pool.

" + }, + "LambdaConfig":{ + "shape":"LambdaConfigType", + "documentation":"

The AWS Lambda triggers associated with the user pool.

" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status of a user pool.

" + }, + "LastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the user pool was last modified.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date the user pool was created.

" + }, + "SchemaAttributes":{ + "shape":"SchemaAttributesListType", + "documentation":"

A container with the schema attributes of a user pool.

" + }, + "AutoVerifiedAttributes":{ + "shape":"VerifiedAttributesListType", + "documentation":"

Specifies the attributes that are auto-verified in a user pool.

" + }, + "AliasAttributes":{ + "shape":"AliasAttributesListType", + "documentation":"

Specifies the attributes that are aliased in a user pool.

" + }, + "UsernameAttributes":{ + "shape":"UsernameAttributesListType", + "documentation":"

Specifies whether email addresses or phone numbers can be specified as usernames when a user signs up.

" + }, + "SmsVerificationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The contents of the SMS verification message.

" + }, + "EmailVerificationMessage":{ + "shape":"EmailVerificationMessageType", + "documentation":"

The contents of the email verification message.

" + }, + "EmailVerificationSubject":{ + "shape":"EmailVerificationSubjectType", + "documentation":"

The subject of the email verification message.

" + }, + "VerificationMessageTemplate":{ + "shape":"VerificationMessageTemplateType", + "documentation":"

The template for verification messages.

" + }, + "SmsAuthenticationMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The contents of the SMS authentication message.

" + }, + "MfaConfiguration":{ + "shape":"UserPoolMfaType", + "documentation":"

Can be one of the following values:

  • OFF - MFA tokens are not required and cannot be specified during user registration.

  • ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.

  • OPTIONAL - Users have the option when registering to create an MFA token.

" + }, + "DeviceConfiguration":{ + "shape":"DeviceConfigurationType", + "documentation":"

The device configuration.

" + }, + "EstimatedNumberOfUsers":{ + "shape":"IntegerType", + "documentation":"

A number estimating the size of the user pool.

" + }, + "EmailConfiguration":{ + "shape":"EmailConfigurationType", + "documentation":"

The email configuration.

" + }, + "SmsConfiguration":{ + "shape":"SmsConfigurationType", + "documentation":"

The SMS configuration.

" + }, + "UserPoolTags":{ + "shape":"UserPoolTagsType", + "documentation":"

The tags that are assigned to the user pool. A tag is a label that you can apply to user pools to categorize and manage them in different ways, such as by purpose, owner, environment, or other criteria.

" + }, + "SmsConfigurationFailure":{ + "shape":"StringType", + "documentation":"

The reason why the SMS configuration cannot send the messages to your users.

" + }, + "EmailConfigurationFailure":{ + "shape":"StringType", + "documentation":"

The reason why the email configuration cannot send the messages to your users.

" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Holds the domain prefix if the user pool has a domain associated with it.

" + }, + "CustomDomain":{ + "shape":"DomainType", + "documentation":"

A custom domain name that you provide to Amazon Cognito. This parameter applies only if you use a custom domain to host the sign-up and sign-in pages for your application. For example: auth.example.com.

For more information about adding a custom domain to your user pool, see Using Your Own Domain for the Hosted UI.

" + }, + "AdminCreateUserConfig":{ + "shape":"AdminCreateUserConfigType", + "documentation":"

The configuration for AdminCreateUser requests.

" + }, + "UserPoolAddOns":{ + "shape":"UserPoolAddOnsType", + "documentation":"

The user pool add-ons.

" + }, + "Arn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) for the user pool.

" + } + }, + "documentation":"

A container for information about the user pool.

" + }, + "UserStatusType":{ + "type":"string", + "enum":[ + "UNCONFIRMED", + "CONFIRMED", + "ARCHIVED", + "COMPROMISED", + "UNKNOWN", + "RESET_REQUIRED", + "FORCE_CHANGE_PASSWORD" + ] + }, + "UserType":{ + "type":"structure", + "members":{ + "Username":{ + "shape":"UsernameType", + "documentation":"

The user name of the user you wish to describe.

" + }, + "Attributes":{ + "shape":"AttributeListType", + "documentation":"

A container with information about the user type attributes.

" + }, + "UserCreateDate":{ + "shape":"DateType", + "documentation":"

The creation date of the user.

" + }, + "UserLastModifiedDate":{ + "shape":"DateType", + "documentation":"

The last modified date of the user.

" + }, + "Enabled":{ + "shape":"BooleanType", + "documentation":"

Specifies whether the user is enabled.

" + }, + "UserStatus":{ + "shape":"UserStatusType", + "documentation":"

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

  • RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she can sign in.

  • FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change his or her password to a new value before doing anything else.

" + }, + "MFAOptions":{ + "shape":"MFAOptionListType", + "documentation":"

The MFA options for the user.

" + } + }, + "documentation":"

The user type.

" + }, + "UsernameAttributeType":{ + "type":"string", + "enum":[ + "phone_number", + "email" + ] + }, + "UsernameAttributesListType":{ + "type":"list", + "member":{"shape":"UsernameAttributeType"} + }, + "UsernameExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"MessageType", + "documentation":"

The message returned when Amazon Cognito throws a user name exists exception.

" + } + }, + "documentation":"

This exception is thrown when Amazon Cognito encounters a user name that already exists in the user pool.

", + "exception":true + }, + "UsernameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+", + "sensitive":true + }, + "UsersListType":{ + "type":"list", + "member":{"shape":"UserType"} + }, + "VerificationMessageTemplateType":{ + "type":"structure", + "members":{ + "SmsMessage":{ + "shape":"SmsVerificationMessageType", + "documentation":"

The SMS message template.

" + }, + "EmailMessage":{ + "shape":"EmailVerificationMessageType", + "documentation":"

The email message template.

" + }, + "EmailSubject":{ + "shape":"EmailVerificationSubjectType", + "documentation":"

The subject line for the email message template.

" + }, + "EmailMessageByLink":{ + "shape":"EmailVerificationMessageByLinkType", + "documentation":"

The email message template for sending a confirmation link to the user.

" + }, + "EmailSubjectByLink":{ + "shape":"EmailVerificationSubjectByLinkType", + "documentation":"

The subject line for the email message template for sending a confirmation link to the user.

" + }, + "DefaultEmailOption":{ + "shape":"DefaultEmailOptionType", + "documentation":"

The default email option.

" + } + }, + "documentation":"

The template for verification messages.

" + }, + "VerifiedAttributeType":{ + "type":"string", + "enum":[ + "phone_number", + "email" + ] + }, + "VerifiedAttributesListType":{ + "type":"list", + "member":{"shape":"VerifiedAttributeType"} + }, + "VerifySoftwareTokenRequest":{ + "type":"structure", + "required":["UserCode"], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

The access token.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service.

" + }, + "UserCode":{ + "shape":"SoftwareTokenMFAUserCodeType", + "documentation":"

The one time password computed using the secret code returned by

" + }, + "FriendlyDeviceName":{ + "shape":"StringType", + "documentation":"

The friendly device name.

" + } + } + }, + "VerifySoftwareTokenResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VerifySoftwareTokenResponseType", + "documentation":"

The status of the verify software token.

" + }, + "Session":{ + "shape":"SessionType", + "documentation":"

The session which should be passed both ways in challenge-response calls to the service.

" + } + } + }, + "VerifySoftwareTokenResponseType":{ + "type":"string", + "enum":[ + "SUCCESS", + "ERROR" + ] + }, + "VerifyUserAttributeRequest":{ + "type":"structure", + "required":[ + "AccessToken", + "AttributeName", + "Code" + ], + "members":{ + "AccessToken":{ + "shape":"TokenModelType", + "documentation":"

Represents the access token of the request to verify user attributes.

" + }, + "AttributeName":{ + "shape":"AttributeNameType", + "documentation":"

The attribute name in the request to verify user attributes.

" + }, + "Code":{ + "shape":"ConfirmationCodeType", + "documentation":"

The verification code in the request to verify user attributes.

" + } + }, + "documentation":"

Represents the request to verify user attributes.

" + }, + "VerifyUserAttributeResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

A container representing the response from the server from the request to verify user attributes.

" + } + }, + "documentation":"

Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.

This API reference provides information about user pools in Amazon Cognito User Pools.

For more information, see the Amazon Cognito Documentation.

" +} diff --git a/aws/dist/botocore/data/cognito-sync/2014-06-30/service-2.json b/aws/dist/botocore/data/cognito-sync/2014-06-30/service-2.json new file mode 100644 index 00000000..68c5ab5b --- /dev/null +++ b/aws/dist/botocore/data/cognito-sync/2014-06-30/service-2.json @@ -0,0 +1,2441 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-06-30", + "endpointPrefix":"cognito-sync", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Cognito Sync", + "serviceId":"Cognito Sync", + "signatureVersion":"v4", + "protocol":"rest-json", + "uid":"cognito-sync-2014-06-30" + }, + "documentation":"Amazon Cognito Sync

Amazon Cognito Sync provides an AWS service and client library that enable cross-device syncing of application-related user data. High-level client libraries are available for both iOS and Android. You can use these libraries to persist data locally so that it's available even if the device is offline. Developer credentials don't need to be stored on the mobile device to access the service. You can use Amazon Cognito to obtain a normalized user ID and credentials. User data is persisted in a dataset that can store up to 1 MB of key-value pairs, and you can have up to 20 datasets per user identity.

With Amazon Cognito Sync, the data stored for each identity is accessible only to credentials assigned to that identity. In order to use the Cognito Sync service, you need to make API calls using credentials retrieved with Amazon Cognito Identity service.

If you want to use Cognito Sync in an Android or iOS application, you will probably want to make API calls via the AWS Mobile SDK. To learn more, see the Developer Guide for Android and the Developer Guide for iOS.

", + "operations":{ + "BulkPublish":{ + "name":"BulkPublish", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/bulkpublish", + "responseCode":200 + }, + "input":{ + "shape":"BulkPublishRequest", + "documentation":"The input for the BulkPublish operation." + }, + "output":{ + "shape":"BulkPublishResponse", + "documentation":"The output for the BulkPublish operation." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"DuplicateRequestException", + "error":{ + "code":"DuplicateRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." + }, + { + "shape":"AlreadyStreamedException", + "error":{ + "code":"AlreadyStreamed", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." + } + ], + "documentation":"

Initiates a bulk publish of all existing datasets for an Identity Pool to the configured stream. Customers are limited to one successful bulk publish per 24 hours. Bulk publish is an asynchronous request, customers can see the status of the request via the GetBulkPublishDetails operation.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"DELETE", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"DeleteDatasetRequest", + "documentation":"A request to delete the specific dataset." + }, + "output":{ + "shape":"DeleteDatasetResponse", + "documentation":"Response to a successful DeleteDataset request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"ResourceConflictException", + "error":{ + "code":"ResourceConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + } + ], + "documentation":"

Deletes the specific dataset. The dataset will be deleted permanently, and the action can't be undone. Datasets that this dataset was merged with will no longer report the merge. Any subsequent operation on this dataset will result in a ResourceNotFoundException.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" + }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeDatasetRequest", + "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." + }, + "output":{ + "shape":"DescribeDatasetResponse", + "documentation":"Response to a successful DescribeDataset request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

" + }, + "DescribeIdentityPoolUsage":{ + "name":"DescribeIdentityPoolUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeIdentityPoolUsageRequest", + "documentation":"A request for usage information about the identity pool." + }, + "output":{ + "shape":"DescribeIdentityPoolUsageResponse", + "documentation":"Response to a successful DescribeIdentityPoolUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets usage details (for example, data storage) about a particular identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "DescribeIdentityUsage":{ + "name":"DescribeIdentityUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}", + "responseCode":200 + }, + "input":{ + "shape":"DescribeIdentityUsageRequest", + "documentation":"A request for information about the usage of an identity pool." + }, + "output":{ + "shape":"DescribeIdentityUsageResponse", + "documentation":"The response to a successful DescribeIdentityUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets usage information for an identity, including number of datasets and data usage.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" + }, + "GetBulkPublishDetails":{ + "name":"GetBulkPublishDetails", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/getBulkPublishDetails", + "responseCode":200 + }, + "input":{ + "shape":"GetBulkPublishDetailsRequest", + "documentation":"The input for the GetBulkPublishDetails operation." + }, + "output":{ + "shape":"GetBulkPublishDetailsResponse", + "documentation":"The output for the GetBulkPublishDetails operation." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"

Get the status of the last BulkPublish operation for an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "GetCognitoEvents":{ + "name":"GetCognitoEvents", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/events", + "responseCode":200 + }, + "input":{ + "shape":"GetCognitoEventsRequest", + "documentation":"

A request for a list of the configured Cognito Events

" + }, + "output":{ + "shape":"GetCognitoEventsResponse", + "documentation":"

The response from the GetCognitoEvents request

" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets the events and the corresponding Lambda functions associated with an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "GetIdentityPoolConfiguration":{ + "name":"GetIdentityPoolConfiguration", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/configuration", + "responseCode":200 + }, + "input":{ + "shape":"GetIdentityPoolConfigurationRequest", + "documentation":"

The input for the GetIdentityPoolConfiguration operation.

" + }, + "output":{ + "shape":"GetIdentityPoolConfigurationResponse", + "documentation":"

The output for the GetIdentityPoolConfiguration operation.

" + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets the configuration settings of an identity pool.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets", + "responseCode":200 + }, + "input":{ + "shape":"ListDatasetsRequest", + "documentation":"Request for a list of datasets for an identity." + }, + "output":{ + "shape":"ListDatasetsResponse", + "documentation":"Returned for a successful ListDatasets request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Lists datasets for an identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListDatasets can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use the Cognito Identity credentials to make this API call.

" + }, + "ListIdentityPoolUsage":{ + "name":"ListIdentityPoolUsage", + "http":{ + "method":"GET", + "requestUri":"/identitypools", + "responseCode":200 + }, + "input":{ + "shape":"ListIdentityPoolUsageRequest", + "documentation":"A request for usage information on an identity pool." + }, + "output":{ + "shape":"ListIdentityPoolUsageResponse", + "documentation":"Returned for a successful ListIdentityPoolUsage request." + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Gets a list of identity pools registered with Cognito.

ListIdentityPoolUsage can only be called with developer credentials. You cannot make this API call with the temporary user credentials provided by Cognito Identity.

" + }, + "ListRecords":{ + "name":"ListRecords", + "http":{ + "method":"GET", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/records", + "responseCode":200 + }, + "input":{ + "shape":"ListRecordsRequest", + "documentation":"A request for a list of records." + }, + "output":{ + "shape":"ListRecordsResponse", + "documentation":"Returned for a successful ListRecordsRequest." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"

Gets paginated records, optionally changed after a particular sync count for a dataset and identity. With Amazon Cognito Sync, each identity has access only to its own data. Thus, the credentials used to make this API call need to have access to the identity data.

ListRecords can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

" + }, + "RegisterDevice":{ + "name":"RegisterDevice", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/identity/{IdentityId}/device", + "responseCode":200 + }, + "input":{ + "shape":"RegisterDeviceRequest", + "documentation":"

A request to RegisterDevice.

" + }, + "output":{ + "shape":"RegisterDeviceResponse", + "documentation":"

Response to a RegisterDevice request.

" + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"InvalidConfigurationException", + "error":{ + "code":"InvalidConfiguration", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Registers a device to receive push sync notifications.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" + }, + "SetCognitoEvents":{ + "name":"SetCognitoEvents", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/events", + "responseCode":200 + }, + "input":{ + "shape":"SetCognitoEventsRequest", + "documentation":"

A request to configure Cognito Events\"

\"" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Sets the AWS Lambda function for a given event type for an identity pool. This request only updates the key/value pair specified. Other key/values pairs are not updated. To remove a key value pair, pass a empty value for the particular key.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "SetIdentityPoolConfiguration":{ + "name":"SetIdentityPoolConfiguration", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/configuration", + "responseCode":200 + }, + "input":{ + "shape":"SetIdentityPoolConfigurationRequest", + "documentation":"

The input for the SetIdentityPoolConfiguration operation.

" + }, + "output":{ + "shape":"SetIdentityPoolConfigurationResponse", + "documentation":"

The output for the SetIdentityPoolConfiguration operation

" + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"ConcurrentModificationException", + "error":{ + "code":"ConcurrentModification", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Thrown if there are parallel requests to modify a resource.

" + } + ], + "documentation":"

Sets the necessary configuration for push sync.

This API can only be called with developer credentials. You cannot call this API with the temporary user credentials provided by Cognito Identity.

" + }, + "SubscribeToDataset":{ + "name":"SubscribeToDataset", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", + "responseCode":200 + }, + "input":{ + "shape":"SubscribeToDatasetRequest", + "documentation":"

A request to SubscribeToDatasetRequest.

" + }, + "output":{ + "shape":"SubscribeToDatasetResponse", + "documentation":"

Response to a SubscribeToDataset request.

" + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"InvalidConfigurationException", + "error":{ + "code":"InvalidConfiguration", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Subscribes to receive notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" + }, + "UnsubscribeFromDataset":{ + "name":"UnsubscribeFromDataset", + "http":{ + "method":"DELETE", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}/subscriptions/{DeviceId}", + "responseCode":200 + }, + "input":{ + "shape":"UnsubscribeFromDatasetRequest", + "documentation":"

A request to UnsubscribeFromDataset.

" + }, + "output":{ + "shape":"UnsubscribeFromDatasetResponse", + "documentation":"

Response to an UnsubscribeFromDataset request.

" + }, + "errors":[ + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + { + "shape":"InvalidConfigurationException", + "error":{ + "code":"InvalidConfiguration", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + } + ], + "documentation":"

Unsubscribes from receiving notifications when a dataset is modified by another device.

This API can only be called with temporary credentials provided by Cognito Identity. You cannot call this API with developer credentials.

" + }, + "UpdateRecords":{ + "name":"UpdateRecords", + "http":{ + "method":"POST", + "requestUri":"/identitypools/{IdentityPoolId}/identities/{IdentityId}/datasets/{DatasetName}", + "responseCode":200 + }, + "input":{ + "shape":"UpdateRecordsRequest", + "documentation":"A request to post updates to records or add and delete records for a dataset and user." + }, + "output":{ + "shape":"UpdateRecordsResponse", + "documentation":"Returned for a successful UpdateRecordsRequest." + }, + "errors":[ + { + "shape":"InvalidParameterException", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + { + "shape":"LimitExceededException", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." + }, + { + "shape":"NotAuthorizedException", + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + { + "shape":"ResourceNotFoundException", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + { + "shape":"ResourceConflictException", + "error":{ + "code":"ResourceConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + }, + { + "shape":"InvalidLambdaFunctionOutputException", + "error":{ + "code":"InvalidLambdaFunctionOutput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The AWS Lambda function returned invalid output or an exception.

" + }, + { + "shape":"LambdaThrottledException", + "error":{ + "code":"LambdaThrottled", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"

AWS Lambda throttled your account, please contact AWS Support

" + }, + { + "shape":"TooManyRequestsException", + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + { + "shape":"InternalErrorException", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + } + ], + "documentation":"

Posts updates to records and adds and deletes records for a dataset and user.

The sync count in the record patch is your last known sync count for that record. The server will reject an UpdateRecords request with a ResourceConflictException if you try to patch a record with a new value but a stale sync count.

For example, if the sync count on the server is 5 for a key called highScore and you try and submit a new highScore with sync count of 4, the request will be rejected. To obtain the current sync count for a record, call ListRecords. On a successful update of the record, the response returns the new sync count for that record. You should present that sync count the next time you try to update that same record. When the record does not exist, specify the sync count as 0.

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials.

" + } + }, + "shapes":{ + "AlreadyStreamedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message associated with the AlreadyStreamedException exception." + } + }, + "error":{ + "code":"AlreadyStreamed", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"An exception thrown when a bulk publish operation is requested less than 24 hours after a previous bulk publish operation completed successfully." + }, + "ApplicationArn":{ + "type":"string", + "pattern":"arn:aws:sns:[-0-9a-z]+:\\d+:app/[A-Z_]+/[a-zA-Z0-9_.-]+" + }, + "ApplicationArnList":{ + "type":"list", + "member":{"shape":"ApplicationArn"} + }, + "AssumeRoleArn":{ + "type":"string", + "min":20, + "max":2048, + "pattern":"arn:aws:iam::\\d+:role/.*" + }, + "Boolean":{"type":"boolean"}, + "BulkPublishRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"The input for the BulkPublish operation." + }, + "BulkPublishResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"The output for the BulkPublish operation." + }, + "BulkPublishStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ] + }, + "ClientContext":{"type":"string"}, + "CognitoEventType":{"type":"string"}, + "CognitoStreams":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool." + }, + "RoleArn":{ + "shape":"AssumeRoleArn", + "documentation":"The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream." + }, + "StreamingStatus":{ + "shape":"StreamingStatus", + "documentation":"Status of the Cognito streams. Valid values are:

ENABLED - Streaming of updates to identity pool is enabled.

DISABLED - Streaming of updates to identity pool is disabled. Bulk publish will also fail if StreamingStatus is DISABLED.

" + } + }, + "documentation":"Configuration options for configure Cognito streams." + }, + "ConcurrentModificationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"String", + "documentation":"

The message returned by a ConcurrentModicationException.

" + } + }, + "error":{ + "code":"ConcurrentModification", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Thrown if there are parallel requests to modify a resource.

" + }, + "Dataset":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "CreationDate":{ + "shape":"Date", + "documentation":"Date on which the dataset was created." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date when the dataset was last modified." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The device that made the last change to this dataset." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Total size in bytes of the records in this dataset." + }, + "NumRecords":{ + "shape":"Long", + "documentation":"Number of records in this dataset." + } + }, + "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + }, + "DatasetList":{ + "type":"list", + "member":{"shape":"Dataset"} + }, + "DatasetName":{ + "type":"string", + "min":1, + "max":128, + "pattern":"[a-zA-Z0-9_.:-]+" + }, + "Date":{"type":"timestamp"}, + "DeleteDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + } + }, + "documentation":"A request to delete the specific dataset." + }, + "DeleteDatasetResponse":{ + "type":"structure", + "members":{ + "Dataset":{ + "shape":"Dataset", + "documentation":"A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + } + }, + "documentation":"Response to a successful DeleteDataset request." + }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + } + }, + "documentation":"A request for meta data about a dataset (creation date, number of records, size) by owner and dataset name." + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "Dataset":{ + "shape":"Dataset", + "documentation":"Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs." + } + }, + "documentation":"Response to a successful DescribeDataset request." + }, + "DescribeIdentityPoolUsageRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"A request for usage information about the identity pool." + }, + "DescribeIdentityPoolUsageResponse":{ + "type":"structure", + "members":{ + "IdentityPoolUsage":{ + "shape":"IdentityPoolUsage", + "documentation":"Information about the usage of the identity pool." + } + }, + "documentation":"Response to a successful DescribeIdentityPoolUsage request." + }, + "DescribeIdentityUsageRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"A request for information about the usage of an identity pool." + }, + "DescribeIdentityUsageResponse":{ + "type":"structure", + "members":{ + "IdentityUsage":{ + "shape":"IdentityUsage", + "documentation":"Usage information for the identity." + } + }, + "documentation":"The response to a successful DescribeIdentityUsage request." + }, + "DeviceId":{ + "type":"string", + "min":1, + "max":256 + }, + "DuplicateRequestException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message associated with the DuplicateRequestException exception." + } + }, + "error":{ + "code":"DuplicateRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"An exception thrown when there is an IN_PROGRESS bulk publish operation for the given identity pool." + }, + "Events":{ + "type":"map", + "key":{"shape":"CognitoEventType"}, + "value":{"shape":"LambdaFunctionArn"}, + "max":1 + }, + "ExceptionMessage":{"type":"string"}, + "GetBulkPublishDetailsRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + } + }, + "documentation":"The input for the GetBulkPublishDetails operation." + }, + "GetBulkPublishDetailsResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "BulkPublishStartTime":{ + "shape":"Date", + "documentation":"The date/time at which the last bulk publish was initiated." + }, + "BulkPublishCompleteTime":{ + "shape":"Date", + "documentation":"If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed." + }, + "BulkPublishStatus":{ + "shape":"BulkPublishStatus", + "documentation":"Status of the last bulk publish operation, valid values are:

NOT_STARTED - No bulk publish has been requested for this identity pool

IN_PROGRESS - Data is being published to the configured stream

SUCCEEDED - All data for the identity pool has been published to the configured stream

FAILED - Some portion of the data has failed to publish, check FailureMessage for the cause.

" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail." + } + }, + "documentation":"The output for the GetBulkPublishDetails operation." + }, + "GetCognitoEventsRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

The Cognito Identity Pool ID for the request

" + } + }, + "documentation":"

A request for a list of the configured Cognito Events

" + }, + "GetCognitoEventsResponse":{ + "type":"structure", + "members":{ + "Events":{ + "shape":"Events", + "documentation":"

The Cognito Events returned from the GetCognitoEvents request

" + } + }, + "documentation":"

The response from the GetCognitoEvents request

" + }, + "GetIdentityPoolConfigurationRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool for which to return a configuration.

" + } + }, + "documentation":"

The input for the GetIdentityPoolConfiguration operation.

" + }, + "GetIdentityPoolConfigurationResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" + }, + "PushSync":{ + "shape":"PushSync", + "documentation":"

Options to apply to this identity pool for push synchronization.

" + }, + "CognitoStreams":{ + "shape":"CognitoStreams", + "documentation":"Options to apply to this identity pool for Amazon Cognito streams." + } + }, + "documentation":"

The output for the GetIdentityPoolConfiguration operation.

" + }, + "IdentityId":{ + "type":"string", + "min":1, + "max":55, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolId":{ + "type":"string", + "min":1, + "max":55, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "IdentityPoolUsage":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "SyncSessionsCount":{ + "shape":"Long", + "documentation":"Number of sync sessions for the identity pool." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Data storage information for the identity pool." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date on which the identity pool was last modified." + } + }, + "documentation":"Usage information for the identity pool." + }, + "IdentityPoolUsageList":{ + "type":"list", + "member":{"shape":"IdentityPoolUsage"} + }, + "IdentityUsage":{ + "type":"structure", + "members":{ + "IdentityId":{ + "shape":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"Date on which the identity was last modified." + }, + "DatasetCount":{ + "shape":"Integer", + "documentation":"Number of datasets for the identity." + }, + "DataStorage":{ + "shape":"Long", + "documentation":"Total data storage for this identity." + } + }, + "documentation":"Usage information for the identity." + }, + "Integer":{"type":"integer"}, + "IntegerString":{"type":"integer"}, + "InternalErrorException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by InternalErrorException." + } + }, + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true, + "documentation":"Indicates an internal service error." + }, + "InvalidConfigurationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by InvalidConfigurationException." + } + }, + "error":{ + "code":"InvalidConfiguration", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidLambdaFunctionOutputException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

A message returned when an InvalidLambdaFunctionOutputException occurs

" + } + }, + "error":{ + "code":"InvalidLambdaFunctionOutput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The AWS Lambda function returned invalid output or an exception.

" + }, + "InvalidParameterException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by InvalidParameterException." + } + }, + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a request parameter does not comply with the associated constraints." + }, + "LambdaFunctionArn":{"type":"string"}, + "LambdaThrottledException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

A message returned when an LambdaThrottledException is thrown

" + } + }, + "error":{ + "code":"LambdaThrottled", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"

AWS Lambda throttled your account, please contact AWS Support

" + }, + "LimitExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by LimitExceededException." + } + }, + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when the limit on the number of objects or operations has been exceeded." + }, + "ListDatasetsRequest":{ + "type":"structure", + "required":[ + "IdentityId", + "IdentityPoolId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + } + }, + "documentation":"Request for a list of datasets for an identity." + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "Datasets":{ + "shape":"DatasetList", + "documentation":"A set of datasets." + }, + "Count":{ + "shape":"Integer", + "documentation":"Number of datasets returned." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + } + }, + "documentation":"Returned for a successful ListDatasets request." + }, + "ListIdentityPoolUsageRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + } + }, + "documentation":"A request for usage information on an identity pool." + }, + "ListIdentityPoolUsageResponse":{ + "type":"structure", + "members":{ + "IdentityPoolUsages":{ + "shape":"IdentityPoolUsageList", + "documentation":"Usage information for the identity pools." + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"The maximum number of results to be returned." + }, + "Count":{ + "shape":"Integer", + "documentation":"Total number of identities for the identity pool." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + } + }, + "documentation":"Returned for a successful ListIdentityPoolUsage request." + }, + "ListRecordsRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "LastSyncCount":{ + "shape":"Long", + "location":"querystring", + "locationName":"lastSyncCount", + "documentation":"The last server sync count for this record." + }, + "NextToken":{ + "shape":"String", + "location":"querystring", + "locationName":"nextToken", + "documentation":"A pagination token for obtaining the next page of results." + }, + "MaxResults":{ + "shape":"IntegerString", + "location":"querystring", + "locationName":"maxResults", + "documentation":"The maximum number of results to be returned." + }, + "SyncSessionToken":{ + "shape":"SyncSessionToken", + "location":"querystring", + "locationName":"syncSessionToken", + "documentation":"A token containing a session ID, identity ID, and expiration." + } + }, + "documentation":"A request for a list of records." + }, + "ListRecordsResponse":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"A list of all records." + }, + "NextToken":{ + "shape":"String", + "documentation":"A pagination token for obtaining the next page of results." + }, + "Count":{ + "shape":"Integer", + "documentation":"Total number of records." + }, + "DatasetSyncCount":{ + "shape":"Long", + "documentation":"Server sync count for this dataset." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The user/device that made the last change to this record." + }, + "MergedDatasetNames":{ + "shape":"MergedDatasetNameList", + "documentation":"Names of merged datasets." + }, + "DatasetExists":{ + "shape":"Boolean", + "documentation":"Indicates whether the dataset exists." + }, + "DatasetDeletedAfterRequestedSyncCount":{ + "shape":"Boolean", + "documentation":"A boolean value specifying whether to delete the dataset locally." + }, + "SyncSessionToken":{ + "shape":"String", + "documentation":"A token containing a session ID, identity ID, and expiration." + } + }, + "documentation":"Returned for a successful ListRecordsRequest." + }, + "Long":{"type":"long"}, + "MergedDatasetNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NotAuthorizedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message returned by a NotAuthorizedException." + } + }, + "error":{ + "code":"NotAuthorizedError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown when a user is not authorized to access the requested resource." + }, + "Operation":{ + "type":"string", + "enum":[ + "replace", + "remove" + ] + }, + "Platform":{ + "type":"string", + "enum":[ + "APNS", + "APNS_SANDBOX", + "GCM", + "ADM" + ] + }, + "PushSync":{ + "type":"structure", + "members":{ + "ApplicationArns":{ + "shape":"ApplicationArnList", + "documentation":"

List of SNS platform application ARNs that could be used by clients.

" + }, + "RoleArn":{ + "shape":"AssumeRoleArn", + "documentation":"

A role configured to allow Cognito to call SNS on behalf of the developer.

" + } + }, + "documentation":"

Configuration options to be applied to the identity pool.

" + }, + "PushToken":{"type":"string"}, + "Record":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"RecordKey", + "documentation":"The key for the record." + }, + "Value":{ + "shape":"RecordValue", + "documentation":"The value for the record." + }, + "SyncCount":{ + "shape":"Long", + "documentation":"The server sync count for this record." + }, + "LastModifiedDate":{ + "shape":"Date", + "documentation":"The date on which the record was last modified." + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"The user/device that made the last change to this record." + }, + "DeviceLastModifiedDate":{ + "shape":"Date", + "documentation":"The last modified date of the client device." + } + }, + "documentation":"The basic data structure of a dataset." + }, + "RecordKey":{ + "type":"string", + "min":1, + "max":1024 + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RecordPatch":{ + "type":"structure", + "required":[ + "Op", + "Key", + "SyncCount" + ], + "members":{ + "Op":{ + "shape":"Operation", + "documentation":"An operation, either replace or remove." + }, + "Key":{ + "shape":"RecordKey", + "documentation":"The key associated with the record patch." + }, + "Value":{ + "shape":"RecordValue", + "documentation":"The value associated with the record patch." + }, + "SyncCount":{ + "shape":"Long", + "documentation":"Last known server sync count for this record. Set to 0 if unknown." + }, + "DeviceLastModifiedDate":{ + "shape":"Date", + "documentation":"The last modified date of the client device." + } + }, + "documentation":"An update operation for a record." + }, + "RecordPatchList":{ + "type":"list", + "member":{"shape":"RecordPatch"} + }, + "RecordValue":{ + "type":"string", + "max":1048575 + }, + "RegisterDeviceRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "Platform", + "Token" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. Here, the ID of the pool that the identity belongs to.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"

The unique ID for this identity.

" + }, + "Platform":{ + "shape":"Platform", + "documentation":"

The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).

" + }, + "Token":{ + "shape":"PushToken", + "documentation":"

The push token.

" + } + }, + "documentation":"

A request to RegisterDevice.

" + }, + "RegisterDeviceResponse":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The unique ID generated for this device by Cognito.

" + } + }, + "documentation":"

Response to a RegisterDevice request.

" + }, + "ResourceConflictException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"The message returned by a ResourceConflictException." + } + }, + "error":{ + "code":"ResourceConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if an update can't be applied because the resource was changed by another call and this would result in a conflict." + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by a ResourceNotFoundException." + } + }, + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the resource doesn't exist." + }, + "SetCognitoEventsRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "Events" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

The Cognito Identity Pool to use when configuring Cognito Events

" + }, + "Events":{ + "shape":"Events", + "documentation":"

The events to configure

" + } + }, + "documentation":"

A request to configure Cognito Events\"

\"" + }, + "SetIdentityPoolConfigurationRequest":{ + "type":"structure", + "required":["IdentityPoolId"], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. This is the ID of the pool to modify.

" + }, + "PushSync":{ + "shape":"PushSync", + "documentation":"

Options to apply to this identity pool for push synchronization.

" + }, + "CognitoStreams":{ + "shape":"CognitoStreams", + "documentation":"Options to apply to this identity pool for Amazon Cognito streams." + } + }, + "documentation":"

The input for the SetIdentityPoolConfiguration operation.

" + }, + "SetIdentityPoolConfigurationResponse":{ + "type":"structure", + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.

" + }, + "PushSync":{ + "shape":"PushSync", + "documentation":"

Options to apply to this identity pool for push synchronization.

" + }, + "CognitoStreams":{ + "shape":"CognitoStreams", + "documentation":"Options to apply to this identity pool for Amazon Cognito streams." + } + }, + "documentation":"

The output for the SetIdentityPoolConfiguration operation

" + }, + "StreamName":{ + "type":"string", + "min":1, + "max":128 + }, + "StreamingStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "String":{"type":"string"}, + "SubscribeToDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "DeviceId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which the identity belongs.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"

Unique ID for this identity.

" + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"

The name of the dataset to subcribe to.

" + }, + "DeviceId":{ + "shape":"DeviceId", + "location":"uri", + "locationName":"DeviceId", + "documentation":"

The unique ID generated for this device by Cognito.

" + } + }, + "documentation":"

A request to SubscribeToDatasetRequest.

" + }, + "SubscribeToDatasetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response to a SubscribeToDataset request.

" + }, + "SyncSessionToken":{"type":"string"}, + "TooManyRequestsException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"Message returned by a TooManyRequestsException." + } + }, + "error":{ + "code":"TooManyRequests", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true, + "documentation":"Thrown if the request is throttled." + }, + "UnsubscribeFromDatasetRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "DeviceId" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"

A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. The ID of the pool to which this identity belongs.

" + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"

Unique ID for this identity.

" + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"

The name of the dataset from which to unsubcribe.

" + }, + "DeviceId":{ + "shape":"DeviceId", + "location":"uri", + "locationName":"DeviceId", + "documentation":"

The unique ID generated for this device by Cognito.

" + } + }, + "documentation":"

A request to UnsubscribeFromDataset.

" + }, + "UnsubscribeFromDatasetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

Response to an UnsubscribeFromDataset request.

" + }, + "UpdateRecordsRequest":{ + "type":"structure", + "required":[ + "IdentityPoolId", + "IdentityId", + "DatasetName", + "SyncSessionToken" + ], + "members":{ + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "location":"uri", + "locationName":"IdentityPoolId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "IdentityId":{ + "shape":"IdentityId", + "location":"uri", + "locationName":"IdentityId", + "documentation":"A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region." + }, + "DatasetName":{ + "shape":"DatasetName", + "location":"uri", + "locationName":"DatasetName", + "documentation":"A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot)." + }, + "DeviceId":{ + "shape":"DeviceId", + "documentation":"

The unique ID generated for this device by Cognito.

" + }, + "RecordPatches":{ + "shape":"RecordPatchList", + "documentation":"A list of patch operations." + }, + "SyncSessionToken":{ + "shape":"SyncSessionToken", + "documentation":"The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity." + }, + "ClientContext":{ + "shape":"ClientContext", + "location":"header", + "locationName":"x-amz-Client-Context", + "documentation":"Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented." + } + }, + "documentation":"A request to post updates to records or add and delete records for a dataset and user." + }, + "UpdateRecordsResponse":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"A list of records that have been updated." + } + }, + "documentation":"Returned for a successful UpdateRecordsRequest." + } + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/comprehend/2017-11-27/paginators-1.json b/aws/dist/botocore/data/comprehend/2017-11-27/paginators-1.json new file mode 100644 index 00000000..eb84c64c --- /dev/null +++ b/aws/dist/botocore/data/comprehend/2017-11-27/paginators-1.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "ListTopicsDetectionJobs": { + "result_key": "TopicsDetectionJobPropertiesList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDocumentClassificationJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DocumentClassificationJobPropertiesList" + }, + "ListDocumentClassifiers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DocumentClassifierPropertiesList" + }, + "ListDominantLanguageDetectionJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DominantLanguageDetectionJobPropertiesList" + }, + "ListEntitiesDetectionJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EntitiesDetectionJobPropertiesList" + }, + "ListEntityRecognizers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EntityRecognizerPropertiesList" + }, + "ListKeyPhrasesDetectionJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "KeyPhrasesDetectionJobPropertiesList" + }, + "ListSentimentDetectionJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SentimentDetectionJobPropertiesList" + } + } +} diff --git a/aws/dist/botocore/data/comprehend/2017-11-27/service-2.json b/aws/dist/botocore/data/comprehend/2017-11-27/service-2.json new file mode 100644 index 00000000..3e68c30d --- /dev/null +++ b/aws/dist/botocore/data/comprehend/2017-11-27/service-2.json @@ -0,0 +1,3649 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-27", + "endpointPrefix":"comprehend", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Comprehend", + "serviceId":"Comprehend", + "signatureVersion":"v4", + "signingName":"comprehend", + "targetPrefix":"Comprehend_20171127", + "uid":"comprehend-2017-11-27" + }, + "operations":{ + "BatchDetectDominantLanguage":{ + "name":"BatchDetectDominantLanguage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectDominantLanguageRequest"}, + "output":{"shape":"BatchDetectDominantLanguageResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

" + }, + "BatchDetectEntities":{ + "name":"BatchDetectEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectEntitiesRequest"}, + "output":{"shape":"BatchDetectEntitiesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

" + }, + "BatchDetectKeyPhrases":{ + "name":"BatchDetectKeyPhrases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectKeyPhrasesRequest"}, + "output":{"shape":"BatchDetectKeyPhrasesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Detects the key noun phrases found in a batch of documents.

" + }, + "BatchDetectSentiment":{ + "name":"BatchDetectSentiment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectSentimentRequest"}, + "output":{"shape":"BatchDetectSentimentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE, in each one.

" + }, + "BatchDetectSyntax":{ + "name":"BatchDetectSyntax", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectSyntaxRequest"}, + "output":{"shape":"BatchDetectSyntaxResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.

" + }, + "CreateDocumentClassifier":{ + "name":"CreateDocumentClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDocumentClassifierRequest"}, + "output":{"shape":"CreateDocumentClassifierResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

" + }, + "CreateEntityRecognizer":{ + "name":"CreateEntityRecognizer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEntityRecognizerRequest"}, + "output":{"shape":"CreateEntityRecognizerResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Creates an entity recognizer using submitted files. After your CreateEntityRecognizer request is submitted, you can check job status using the API.

" + }, + "DeleteDocumentClassifier":{ + "name":"DeleteDocumentClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDocumentClassifierRequest"}, + "output":{"shape":"DeleteDocumentClassifierResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Deletes a previously created document classifier

Only those classifiers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the classifier into a DELETING state, and it is then removed by a background job. Once removed, the classifier disappears from your account and is no longer available for use.

" + }, + "DeleteEntityRecognizer":{ + "name":"DeleteEntityRecognizer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEntityRecognizerRequest"}, + "output":{"shape":"DeleteEntityRecognizerResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Deletes an entity recognizer.

Only those recognizers that are in terminated states (IN_ERROR, TRAINED) will be deleted. If an active inference job is using the model, a ResourceInUseException will be returned.

This is an asynchronous action that puts the recognizer into a DELETING state, and it is then removed by a background job. Once removed, the recognizer disappears from your account and is no longer available for use.

" + }, + "DescribeDocumentClassificationJob":{ + "name":"DescribeDocumentClassificationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentClassificationJobRequest"}, + "output":{"shape":"DescribeDocumentClassificationJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a document classification job. Use this operation to get the status of a classification job.

" + }, + "DescribeDocumentClassifier":{ + "name":"DescribeDocumentClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentClassifierRequest"}, + "output":{"shape":"DescribeDocumentClassifierResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a document classifier.

" + }, + "DescribeDominantLanguageDetectionJob":{ + "name":"DescribeDominantLanguageDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDominantLanguageDetectionJobRequest"}, + "output":{"shape":"DescribeDominantLanguageDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a dominant language detection job. Use this operation to get the status of a detection job.

" + }, + "DescribeEntitiesDetectionJob":{ + "name":"DescribeEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntitiesDetectionJobRequest"}, + "output":{"shape":"DescribeEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

" + }, + "DescribeEntityRecognizer":{ + "name":"DescribeEntityRecognizer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntityRecognizerRequest"}, + "output":{"shape":"DescribeEntityRecognizerResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

" + }, + "DescribeKeyPhrasesDetectionJob":{ + "name":"DescribeKeyPhrasesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPhrasesDetectionJobRequest"}, + "output":{"shape":"DescribeKeyPhrasesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

" + }, + "DescribeSentimentDetectionJob":{ + "name":"DescribeSentimentDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSentimentDetectionJobRequest"}, + "output":{"shape":"DescribeSentimentDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

" + }, + "DescribeTopicsDetectionJob":{ + "name":"DescribeTopicsDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTopicsDetectionJobRequest"}, + "output":{"shape":"DescribeTopicsDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

" + }, + "DetectDominantLanguage":{ + "name":"DetectDominantLanguage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectDominantLanguageRequest"}, + "output":{"shape":"DetectDominantLanguageResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

" + }, + "DetectEntities":{ + "name":"DetectEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectEntitiesRequest"}, + "output":{"shape":"DetectEntitiesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

" + }, + "DetectKeyPhrases":{ + "name":"DetectKeyPhrases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectKeyPhrasesRequest"}, + "output":{"shape":"DetectKeyPhrasesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Detects the key noun phrases found in the text.

" + }, + "DetectSentiment":{ + "name":"DetectSentiment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectSentimentRequest"}, + "output":{"shape":"DetectSentimentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

" + }, + "DetectSyntax":{ + "name":"DetectSyntax", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectSyntaxRequest"}, + "output":{"shape":"DetectSyntaxResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

" + }, + "ListDocumentClassificationJobs":{ + "name":"ListDocumentClassificationJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDocumentClassificationJobsRequest"}, + "output":{"shape":"ListDocumentClassificationJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the documentation classification jobs that you have submitted.

" + }, + "ListDocumentClassifiers":{ + "name":"ListDocumentClassifiers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDocumentClassifiersRequest"}, + "output":{"shape":"ListDocumentClassifiersResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the document classifiers that you have created.

" + }, + "ListDominantLanguageDetectionJobs":{ + "name":"ListDominantLanguageDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDominantLanguageDetectionJobsRequest"}, + "output":{"shape":"ListDominantLanguageDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the dominant language detection jobs that you have submitted.

" + }, + "ListEntitiesDetectionJobs":{ + "name":"ListEntitiesDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntitiesDetectionJobsRequest"}, + "output":{"shape":"ListEntitiesDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the entity detection jobs that you have submitted.

" + }, + "ListEntityRecognizers":{ + "name":"ListEntityRecognizers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntityRecognizersRequest"}, + "output":{"shape":"ListEntityRecognizersResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

" + }, + "ListKeyPhrasesDetectionJobs":{ + "name":"ListKeyPhrasesDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListKeyPhrasesDetectionJobsRequest"}, + "output":{"shape":"ListKeyPhrasesDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Get a list of key phrase detection jobs that you have submitted.

" + }, + "ListSentimentDetectionJobs":{ + "name":"ListSentimentDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSentimentDetectionJobsRequest"}, + "output":{"shape":"ListSentimentDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of sentiment detection jobs that you have submitted.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Lists all tags associated with a given Amazon Comprehend resource.

" + }, + "ListTopicsDetectionJobs":{ + "name":"ListTopicsDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTopicsDetectionJobsRequest"}, + "output":{"shape":"ListTopicsDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of the topic detection jobs that you have submitted.

" + }, + "StartDocumentClassificationJob":{ + "name":"StartDocumentClassificationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDocumentClassificationJobRequest"}, + "output":{"shape":"StartDocumentClassificationJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous document classification job. Use the operation to track the progress of the job.

" + }, + "StartDominantLanguageDetectionJob":{ + "name":"StartDominantLanguageDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDominantLanguageDetectionJobRequest"}, + "output":{"shape":"StartDominantLanguageDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

" + }, + "StartEntitiesDetectionJob":{ + "name":"StartEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartEntitiesDetectionJobRequest"}, + "output":{"shape":"StartEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

" + }, + "StartKeyPhrasesDetectionJob":{ + "name":"StartKeyPhrasesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartKeyPhrasesDetectionJobRequest"}, + "output":{"shape":"StartKeyPhrasesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

" + }, + "StartSentimentDetectionJob":{ + "name":"StartSentimentDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSentimentDetectionJobRequest"}, + "output":{"shape":"StartSentimentDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

" + }, + "StartTopicsDetectionJob":{ + "name":"StartTopicsDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTopicsDetectionJobRequest"}, + "output":{"shape":"StartTopicsDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

" + }, + "StopDominantLanguageDetectionJob":{ + "name":"StopDominantLanguageDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDominantLanguageDetectionJobRequest"}, + "output":{"shape":"StopDominantLanguageDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

" + }, + "StopEntitiesDetectionJob":{ + "name":"StopEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopEntitiesDetectionJobRequest"}, + "output":{"shape":"StopEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

" + }, + "StopKeyPhrasesDetectionJob":{ + "name":"StopKeyPhrasesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopKeyPhrasesDetectionJobRequest"}, + "output":{"shape":"StopKeyPhrasesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

" + }, + "StopSentimentDetectionJob":{ + "name":"StopSentimentDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopSentimentDetectionJobRequest"}, + "output":{"shape":"StopSentimentDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

" + }, + "StopTrainingDocumentClassifier":{ + "name":"StopTrainingDocumentClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTrainingDocumentClassifierRequest"}, + "output":{"shape":"StopTrainingDocumentClassifierResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

" + }, + "StopTrainingEntityRecognizer":{ + "name":"StopTrainingEntityRecognizer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTrainingEntityRecognizerRequest"}, + "output":{"shape":"StopTrainingEntityRecognizerResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Associates a specific tag with an Amazon Comprehend resource. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"TooManyTagKeysException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Removes a specific tag associated with an Amazon Comprehend resource.

" + } + }, + "shapes":{ + "AnyLengthString":{"type":"string"}, + "BatchDetectDominantLanguageItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "Languages":{ + "shape":"ListOfDominantLanguages", + "documentation":"

One or more DominantLanguage objects describing the dominant languages in the document.

" + } + }, + "documentation":"

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

" + }, + "BatchDetectDominantLanguageRequest":{ + "type":"structure", + "required":["TextList"], + "members":{ + "TextList":{ + "shape":"StringList", + "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" + } + } + }, + "BatchDetectDominantLanguageResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectDominantLanguageResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" + } + } + }, + "BatchDetectEntitiesItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "Entities":{ + "shape":"ListOfEntities", + "documentation":"

One or more Entity objects, one for each entity detected in the document.

" + } + }, + "documentation":"

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

" + }, + "BatchDetectEntitiesRequest":{ + "type":"structure", + "required":[ + "TextList", + "LanguageCode" + ], + "members":{ + "TextList":{ + "shape":"StringList", + "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "BatchDetectEntitiesResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectEntitiesResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" + } + } + }, + "BatchDetectKeyPhrasesItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "KeyPhrases":{ + "shape":"ListOfKeyPhrases", + "documentation":"

One or more KeyPhrase objects, one for each key phrase detected in the document.

" + } + }, + "documentation":"

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

" + }, + "BatchDetectKeyPhrasesRequest":{ + "type":"structure", + "required":[ + "TextList", + "LanguageCode" + ], + "members":{ + "TextList":{ + "shape":"StringList", + "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "BatchDetectKeyPhrasesResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectKeyPhrasesResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" + } + } + }, + "BatchDetectSentimentItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "Sentiment":{ + "shape":"SentimentType", + "documentation":"

The sentiment detected in the document.

" + }, + "SentimentScore":{ + "shape":"SentimentScore", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.

" + } + }, + "documentation":"

The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

" + }, + "BatchDetectSentimentRequest":{ + "type":"structure", + "required":[ + "TextList", + "LanguageCode" + ], + "members":{ + "TextList":{ + "shape":"StringList", + "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "BatchDetectSentimentResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectSentimentResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" + } + } + }, + "BatchDetectSyntaxItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "SyntaxTokens":{ + "shape":"ListOfSyntaxTokens", + "documentation":"

The syntax tokens for the words in the document, one token for each word.

" + } + }, + "documentation":"

The result of calling the operation. The operation returns one object that is successfully processed by the operation.

" + }, + "BatchDetectSyntaxRequest":{ + "type":"structure", + "required":[ + "TextList", + "LanguageCode" + ], + "members":{ + "TextList":{ + "shape":"StringList", + "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"SyntaxLanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "BatchDetectSyntaxResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectSyntaxResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" + } + } + }, + "BatchItemError":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of the document in the input list.

" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

The numeric error code of the error.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

A text description of the error.

" + } + }, + "documentation":"

Describes an error that occurred while processing a document in a batch. The operation returns on BatchItemError object for each document that contained an error.

" + }, + "BatchItemErrorList":{ + "type":"list", + "member":{"shape":"BatchItemError"} + }, + "BatchSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.

", + "exception":true + }, + "ClassifierEvaluationMetrics":{ + "type":"structure", + "members":{ + "Accuracy":{ + "shape":"Double", + "documentation":"

The fraction of the labels that were correct recognized. It is computed by dividing the number of labels in the test documents that were correctly recognized by the total number of labels in the test documents.

" + }, + "Precision":{ + "shape":"Double", + "documentation":"

A measure of the usefulness of the classifier results in the test data. High precision means that the classifier returned substantially more relevant results than irrelevant ones.

" + }, + "Recall":{ + "shape":"Double", + "documentation":"

A measure of how complete the classifier results are for the test data. High recall means that the classifier returned most of the relevant results.

" + }, + "F1Score":{ + "shape":"Double", + "documentation":"

A measure of how accurate the classifier results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" + } + }, + "documentation":"

Describes the result metrics for the test data associated with an documentation classifier.

" + }, + "ClassifierMetadata":{ + "type":"structure", + "members":{ + "NumberOfLabels":{ + "shape":"Integer", + "documentation":"

The number of labels in the input data.

" + }, + "NumberOfTrainedDocuments":{ + "shape":"Integer", + "documentation":"

The number of documents in the input data that were used to train the classifier. Typically this is 80 to 90 percent of the input documents.

" + }, + "NumberOfTestDocuments":{ + "shape":"Integer", + "documentation":"

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.

" + }, + "EvaluationMetrics":{ + "shape":"ClassifierEvaluationMetrics", + "documentation":"

Describes the result metrics for the test data associated with an documentation classifier.

" + } + }, + "documentation":"

Provides information about a document classifier.

" + }, + "ClientRequestTokenString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ComprehendArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-]{1,64}/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "ComprehendArnName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported.

", + "exception":true + }, + "CreateDocumentClassifierRequest":{ + "type":"structure", + "required":[ + "DocumentClassifierName", + "DataAccessRoleArn", + "InputDataConfig", + "LanguageCode" + ], + "members":{ + "DocumentClassifierName":{ + "shape":"ComprehendArnName", + "documentation":"

The name of the document classifier.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Tags to be associated with the document classifier being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + }, + "InputDataConfig":{ + "shape":"DocumentClassifierInputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"DocumentClassifierOutputDataConfig", + "documentation":"

Enables the addition of output results configuration parameters for custom classifier jobs.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

" + } + } + }, + "CreateDocumentClassifierResponse":{ + "type":"structure", + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier.

" + } + } + }, + "CreateEntityRecognizerRequest":{ + "type":"structure", + "required":[ + "RecognizerName", + "DataAccessRoleArn", + "InputDataConfig", + "LanguageCode" + ], + "members":{ + "RecognizerName":{ + "shape":"ComprehendArnName", + "documentation":"

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + }, + "InputDataConfig":{ + "shape":"EntityRecognizerInputDataConfig", + "documentation":"

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

" + } + } + }, + "CreateEntityRecognizerResponse":{ + "type":"structure", + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + } + }, + "DeleteDocumentClassifierRequest":{ + "type":"structure", + "required":["DocumentClassifierArn"], + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier.

" + } + } + }, + "DeleteDocumentClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteEntityRecognizerRequest":{ + "type":"structure", + "required":["EntityRecognizerArn"], + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + } + }, + "DeleteEntityRecognizerResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeDocumentClassificationJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

" + } + } + }, + "DescribeDocumentClassificationJobResponse":{ + "type":"structure", + "members":{ + "DocumentClassificationJobProperties":{ + "shape":"DocumentClassificationJobProperties", + "documentation":"

An object that describes the properties associated with the document classification job.

" + } + } + }, + "DescribeDocumentClassifierRequest":{ + "type":"structure", + "required":["DocumentClassifierArn"], + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

" + } + } + }, + "DescribeDocumentClassifierResponse":{ + "type":"structure", + "members":{ + "DocumentClassifierProperties":{ + "shape":"DocumentClassifierProperties", + "documentation":"

An object that contains the properties associated with a document classifier.

" + } + } + }, + "DescribeDominantLanguageDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

" + } + } + }, + "DescribeDominantLanguageDetectionJobResponse":{ + "type":"structure", + "members":{ + "DominantLanguageDetectionJobProperties":{ + "shape":"DominantLanguageDetectionJobProperties", + "documentation":"

An object that contains the properties associated with a dominant language detection job.

" + } + } + }, + "DescribeEntitiesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

" + } + } + }, + "DescribeEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "EntitiesDetectionJobProperties":{ + "shape":"EntitiesDetectionJobProperties", + "documentation":"

An object that contains the properties associated with an entities detection job.

" + } + } + }, + "DescribeEntityRecognizerRequest":{ + "type":"structure", + "required":["EntityRecognizerArn"], + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + } + } + }, + "DescribeEntityRecognizerResponse":{ + "type":"structure", + "members":{ + "EntityRecognizerProperties":{ + "shape":"EntityRecognizerProperties", + "documentation":"

Describes information associated with an entity recognizer.

" + } + } + }, + "DescribeKeyPhrasesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

" + } + } + }, + "DescribeKeyPhrasesDetectionJobResponse":{ + "type":"structure", + "members":{ + "KeyPhrasesDetectionJobProperties":{ + "shape":"KeyPhrasesDetectionJobProperties", + "documentation":"

An object that contains the properties associated with a key phrases detection job.

" + } + } + }, + "DescribeSentimentDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

" + } + } + }, + "DescribeSentimentDetectionJobResponse":{ + "type":"structure", + "members":{ + "SentimentDetectionJobProperties":{ + "shape":"SentimentDetectionJobProperties", + "documentation":"

An object that contains the properties associated with a sentiment detection job.

" + } + } + }, + "DescribeTopicsDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned by the user to the detection job.

" + } + } + }, + "DescribeTopicsDetectionJobResponse":{ + "type":"structure", + "members":{ + "TopicsDetectionJobProperties":{ + "shape":"TopicsDetectionJobProperties", + "documentation":"

The list of properties for the requested job.

" + } + } + }, + "DetectDominantLanguageRequest":{ + "type":"structure", + "required":["Text"], + "members":{ + "Text":{ + "shape":"String", + "documentation":"

A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + } + } + }, + "DetectDominantLanguageResponse":{ + "type":"structure", + "members":{ + "Languages":{ + "shape":"ListOfDominantLanguages", + "documentation":"

The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

" + } + } + }, + "DetectEntitiesRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{ + "shape":"String", + "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "DetectEntitiesResponse":{ + "type":"structure", + "members":{ + "Entities":{ + "shape":"ListOfEntities", + "documentation":"

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see how-entities.

" + } + } + }, + "DetectKeyPhrasesRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{ + "shape":"String", + "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "DetectKeyPhrasesResponse":{ + "type":"structure", + "members":{ + "KeyPhrases":{ + "shape":"ListOfKeyPhrases", + "documentation":"

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + } + } + }, + "DetectSentimentRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{ + "shape":"String", + "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + } + } + }, + "DetectSentimentResponse":{ + "type":"structure", + "members":{ + "Sentiment":{ + "shape":"SentimentType", + "documentation":"

The inferred sentiment that Amazon Comprehend has the highest level of confidence in.

" + }, + "SentimentScore":{ + "shape":"SentimentScore", + "documentation":"

An object that lists the sentiments, and their corresponding confidence levels.

" + } + } + }, + "DetectSyntaxRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{ + "shape":"String", + "documentation":"

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

" + }, + "LanguageCode":{ + "shape":"SyntaxLanguageCode", + "documentation":"

The language code of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\").

" + } + } + }, + "DetectSyntaxResponse":{ + "type":"structure", + "members":{ + "SyntaxTokens":{ + "shape":"ListOfSyntaxTokens", + "documentation":"

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.

" + } + } + }, + "DocumentClassificationJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

" + }, + "DocumentClassificationJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the document classification job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned to the document classification job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the document classification job. If the status is FAILED, the Message field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of the job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the document classification job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the document classification job completed.

" + }, + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the document classification job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the document classification job.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a document classification job.

" + }, + "DocumentClassificationJobPropertiesList":{ + "type":"list", + "member":{"shape":"DocumentClassificationJobProperties"} + }, + "DocumentClassifierArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "DocumentClassifierFilter":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ModelStatus", + "documentation":"

Filters the list of classifiers based on status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted before the specified time. Classifiers are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of classifiers based on the time that the classifier was submitted for processing. Returns only classifiers submitted after the specified time. Classifiers are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of document classifiers. You can only specify one filtering parameter in a request. For more information, see the operation.

" + }, + "DocumentClassifierInputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

The Amazon S3 URI for the input data. The S3 bucket must be in the same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

" + } + }, + "documentation":"

The input properties for training a document classifier.

For more information on how the input file is formatted, see how-document-classification-training-data.

" + }, + "DocumentClassifierOutputDataConfig":{ + "type":"structure", + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

When you use the OutputDataConfig object while creating a custom classifier, you specify the Amazon S3 location where you want to write the confusion matrix. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of this output file.

When the custom classifier job is finished, the service creates the output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the confusion matrix.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • KMS Key Alias: \"alias/ExampleAlias\"

  • ARN of a KMS Key Alias: \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

" + } + }, + "documentation":"

Provides output results configuration parameters for custom classifier jobs.

" + }, + "DocumentClassifierProperties":{ + "type":"structure", + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language code for the language of the documents that the classifier was trained on.

" + }, + "Status":{ + "shape":"ModelStatus", + "documentation":"

The status of the document classifier. If the status is TRAINED the classifier is ready to use. If the status is FAILED you can see additional information about why the classifier wasn't trained in the Message field.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

Additional information about the status of the classifier.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the document classifier was submitted for training.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that training the document classifier completed.

" + }, + "TrainingStartTime":{ + "shape":"Timestamp", + "documentation":"

Indicates the time when the training starts on documentation classifiers. You are billed for the time interval between this time and the value of TrainingEndTime.

" + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

The time that training of the document classifier was completed. Indicates the time when the training completes on documentation classifiers. You are billed for the time interval between this time and the value of TrainingStartTime.

" + }, + "InputDataConfig":{ + "shape":"DocumentClassifierInputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the document classifier for training.

" + }, + "OutputDataConfig":{ + "shape":"DocumentClassifierOutputDataConfig", + "documentation":"

Provides output results configuration parameters for custom classifier jobs.

" + }, + "ClassifierMetadata":{ + "shape":"ClassifierMetadata", + "documentation":"

Information about the document classifier, including the number of documents used for training the classifier, the number of documents used for test the classifier, and an accuracy rating.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a document classifier.

" + }, + "DocumentClassifierPropertiesList":{ + "type":"list", + "member":{"shape":"DocumentClassifierProperties"} + }, + "DominantLanguage":{ + "type":"structure", + "members":{ + "LanguageCode":{ + "shape":"String", + "documentation":"

The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

" + }, + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + } + }, + "documentation":"

Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + }, + "DominantLanguageDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

" + }, + "DominantLanguageDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the dominant language detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned to the dominant language detection job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the dominant language detection job. If the status is FAILED, the Message field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description for the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the dominant language detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the dominant language detection job completed.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the dominant language detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the dominant language detection job.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a dominant language detection job.

" + }, + "DominantLanguageDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"DominantLanguageDetectionJobProperties"} + }, + "Double":{"type":"double"}, + "EntitiesDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

" + }, + "EntitiesDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the entities detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned the entities detection job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the entities detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the entities detection job completed

" + }, + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the entities detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the entities detection job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language code of the input documents.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about an entities detection job.

" + }, + "EntitiesDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"EntitiesDetectionJobProperties"} + }, + "Entity":{ + "type":"structure", + "members":{ + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + }, + "Type":{ + "shape":"EntityType", + "documentation":"

The entity's type.

" + }, + "Text":{ + "shape":"String", + "documentation":"

The text of the entity.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + } + }, + "documentation":"

Provides information about an entity.

" + }, + "EntityRecognizerAnnotations":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

Specifies the Amazon S3 location where the annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

" + } + }, + "documentation":"

Describes the annotations associated with a entity recognizer.

" + }, + "EntityRecognizerArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "EntityRecognizerDocuments":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

" + } + }, + "documentation":"

Describes the training documents submitted with an entity recognizer.

" + }, + "EntityRecognizerEntityList":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

" + } + }, + "documentation":"

Describes the entity recognizer submitted with an entity recognizer.

" + }, + "EntityRecognizerEvaluationMetrics":{ + "type":"structure", + "members":{ + "Precision":{ + "shape":"Double", + "documentation":"

A measure of the usefulness of the recognizer results in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

" + }, + "Recall":{ + "shape":"Double", + "documentation":"

A measure of how complete the recognizer results are for the test data. High recall means that the recognizer returned most of the relevant results.

" + }, + "F1Score":{ + "shape":"Double", + "documentation":"

A measure of how accurate the recognizer results are for the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" + } + }, + "documentation":"

Detailed information about the accuracy of an entity recognizer.

" + }, + "EntityRecognizerFilter":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ModelStatus", + "documentation":"

The status of an entity recognizer.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of entities based on the time that the list was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

" + } + }, + "documentation":"

Provides information for filtering a list of entity recognizers. You can only specify one filtering parameter in a request. For more information, see the operation./>

" + }, + "EntityRecognizerInputDataConfig":{ + "type":"structure", + "required":[ + "EntityTypes", + "Documents" + ], + "members":{ + "EntityTypes":{ + "shape":"EntityTypesList", + "documentation":"

The entity types in the input data for an entity recognizer. A maximum of 12 entity types can be used at one time to train an entity recognizer.

" + }, + "Documents":{ + "shape":"EntityRecognizerDocuments", + "documentation":"

S3 location of the documents folder for an entity recognizer

" + }, + "Annotations":{ + "shape":"EntityRecognizerAnnotations", + "documentation":"

S3 location of the annotations file for an entity recognizer.

" + }, + "EntityList":{ + "shape":"EntityRecognizerEntityList", + "documentation":"

S3 location of the entity list for an entity recognizer.

" + } + }, + "documentation":"

Specifies the format and location of the input data.

" + }, + "EntityRecognizerMetadata":{ + "type":"structure", + "members":{ + "NumberOfTrainedDocuments":{ + "shape":"Integer", + "documentation":"

The number of documents in the input data that were used to train the entity recognizer. Typically this is 80 to 90 percent of the input documents.

" + }, + "NumberOfTestDocuments":{ + "shape":"Integer", + "documentation":"

The number of documents in the input data that were used to test the entity recognizer. Typically this is 10 to 20 percent of the input documents.

" + }, + "EvaluationMetrics":{ + "shape":"EntityRecognizerEvaluationMetrics", + "documentation":"

Detailed information about the accuracy of an entity recognizer.

" + }, + "EntityTypes":{ + "shape":"EntityRecognizerMetadataEntityTypesList", + "documentation":"

Entity types from the metadata of an entity recognizer.

" + } + }, + "documentation":"

Detailed information about an entity recognizer.

" + }, + "EntityRecognizerMetadataEntityTypesList":{ + "type":"list", + "member":{"shape":"EntityRecognizerMetadataEntityTypesListItem"} + }, + "EntityRecognizerMetadataEntityTypesListItem":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"AnyLengthString", + "documentation":"

Type of entity from the list of entity types in the metadata of an entity recognizer.

" + }, + "EvaluationMetrics":{ + "shape":"EntityTypesEvaluationMetrics", + "documentation":"

Detailed information about the accuracy of the entity recognizer for a specific item on the list of entity types.

" + }, + "NumberOfTrainMentions":{ + "shape":"Integer", + "documentation":"

Indicates the number of times the given entity type was seen in the training data.

" + } + }, + "documentation":"

Individual item from the list of entity types in the metadata of an entity recognizer.

" + }, + "EntityRecognizerProperties":{ + "type":"structure", + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.

" + }, + "Status":{ + "shape":"ModelStatus", + "documentation":"

Provides the status of the entity recognizer.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of the recognizer.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the recognizer was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the recognizer creation completed.

" + }, + "TrainingStartTime":{ + "shape":"Timestamp", + "documentation":"

The time that training of the entity recognizer started.

" + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

The time that training of the entity recognizer was completed.

" + }, + "InputDataConfig":{ + "shape":"EntityRecognizerInputDataConfig", + "documentation":"

The input data properties of an entity recognizer.

" + }, + "RecognizerMetadata":{ + "shape":"EntityRecognizerMetadata", + "documentation":"

Provides information about an entity recognizer.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Describes information about an entity recognizer.

" + }, + "EntityRecognizerPropertiesList":{ + "type":"list", + "member":{"shape":"EntityRecognizerProperties"} + }, + "EntityType":{ + "type":"string", + "enum":[ + "PERSON", + "LOCATION", + "ORGANIZATION", + "COMMERCIAL_ITEM", + "EVENT", + "DATE", + "QUANTITY", + "TITLE", + "OTHER" + ] + }, + "EntityTypeName":{ + "type":"string", + "max":64, + "pattern":"[_A-Z0-9]+" + }, + "EntityTypesEvaluationMetrics":{ + "type":"structure", + "members":{ + "Precision":{ + "shape":"Double", + "documentation":"

A measure of the usefulness of the recognizer results for a specific entity type in the test data. High precision means that the recognizer returned substantially more relevant results than irrelevant ones.

" + }, + "Recall":{ + "shape":"Double", + "documentation":"

A measure of how complete the recognizer results are for a specific entity type in the test data. High recall means that the recognizer returned most of the relevant results.

" + }, + "F1Score":{ + "shape":"Double", + "documentation":"

A measure of how accurate the recognizer results are for for a specific entity type in the test data. It is derived from the Precision and Recall values. The F1Score is the harmonic average of the two scores. The highest score is 1, and the worst score is 0.

" + } + }, + "documentation":"

Detailed information about the accuracy of an entity recognizer for a specific entity type.

" + }, + "EntityTypesList":{ + "type":"list", + "member":{"shape":"EntityTypesListItem"} + }, + "EntityTypesListItem":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"EntityTypeName", + "documentation":"

Entity type of an item on an entity type list.

" + } + }, + "documentation":"

Information about an individual item on a list of entity types.

" + }, + "Float":{"type":"float"}, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + }, + "InputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

" + }, + "InputFormat":{ + "shape":"InputFormat", + "documentation":"

Specifies how the text in an input file should be processed:

  • ONE_DOC_PER_FILE - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.

  • ONE_DOC_PER_LINE - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.

" + } + }, + "documentation":"

The input properties for a topic detection job.

" + }, + "InputFormat":{ + "type":"string", + "enum":[ + "ONE_DOC_PER_FILE", + "ONE_DOC_PER_LINE" + ] + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

An internal server error occurred. Retry your request.

", + "exception":true, + "fault":true + }, + "InvalidFilterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The filter specified for the operation is invalid. Specify a different filter.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The request is invalid.

", + "exception":true + }, + "JobId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The specified job was not found. Check the job ID and try again.

", + "exception":true + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "STOP_REQUESTED", + "STOPPED" + ] + }, + "KeyPhrase":{ + "type":"structure", + "members":{ + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

" + }, + "Text":{ + "shape":"String", + "documentation":"

The text of a key noun phrase.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + } + }, + "documentation":"

Describes a key noun phrase.

" + }, + "KeyPhrasesDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

" + }, + "KeyPhrasesDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the key phrases detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned the key phrases detection job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the key phrases detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the key phrases detection job completed.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the key phrases detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the key phrases detection job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language code of the input documents.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a key phrases detection job.

" + }, + "KeyPhrasesDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"KeyPhrasesDetectionJobProperties"} + }, + "KmsKeyId":{ + "type":"string", + "max":2048 + }, + "KmsKeyValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.

", + "exception":true + }, + "LanguageCode":{ + "type":"string", + "enum":[ + "en", + "es", + "fr", + "de", + "it", + "pt", + "ar", + "hi", + "ja", + "ko", + "zh", + "zh-TW" + ] + }, + "ListDocumentClassificationJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"DocumentClassificationJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListDocumentClassificationJobsResponse":{ + "type":"structure", + "members":{ + "DocumentClassificationJobPropertiesList":{ + "shape":"DocumentClassificationJobPropertiesList", + "documentation":"

A list containing the properties of each job returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListDocumentClassifiersRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"DocumentClassifierFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListDocumentClassifiersResponse":{ + "type":"structure", + "members":{ + "DocumentClassifierPropertiesList":{ + "shape":"DocumentClassifierPropertiesList", + "documentation":"

A list containing the properties of each job returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListDominantLanguageDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"DominantLanguageDetectionJobFilter", + "documentation":"

Filters that jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListDominantLanguageDetectionJobsResponse":{ + "type":"structure", + "members":{ + "DominantLanguageDetectionJobPropertiesList":{ + "shape":"DominantLanguageDetectionJobPropertiesList", + "documentation":"

A list containing the properties of each job that is returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListEntitiesDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"EntitiesDetectionJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListEntitiesDetectionJobsResponse":{ + "type":"structure", + "members":{ + "EntitiesDetectionJobPropertiesList":{ + "shape":"EntitiesDetectionJobPropertiesList", + "documentation":"

A list containing the properties of each job that is returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListEntityRecognizersRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"EntityRecognizerFilter", + "documentation":"

Filters the list of entities returned. You can filter on Status, SubmitTimeBefore, or SubmitTimeAfter. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return on each page. The default is 100.

" + } + } + }, + "ListEntityRecognizersResponse":{ + "type":"structure", + "members":{ + "EntityRecognizerPropertiesList":{ + "shape":"EntityRecognizerPropertiesList", + "documentation":"

The list of properties of an entity recognizer.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListKeyPhrasesDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"KeyPhrasesDetectionJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListKeyPhrasesDetectionJobsResponse":{ + "type":"structure", + "members":{ + "KeyPhrasesDetectionJobPropertiesList":{ + "shape":"KeyPhrasesDetectionJobPropertiesList", + "documentation":"

A list containing the properties of each job that is returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListOfDetectDominantLanguageResult":{ + "type":"list", + "member":{"shape":"BatchDetectDominantLanguageItemResult"} + }, + "ListOfDetectEntitiesResult":{ + "type":"list", + "member":{"shape":"BatchDetectEntitiesItemResult"} + }, + "ListOfDetectKeyPhrasesResult":{ + "type":"list", + "member":{"shape":"BatchDetectKeyPhrasesItemResult"} + }, + "ListOfDetectSentimentResult":{ + "type":"list", + "member":{"shape":"BatchDetectSentimentItemResult"} + }, + "ListOfDetectSyntaxResult":{ + "type":"list", + "member":{"shape":"BatchDetectSyntaxItemResult"} + }, + "ListOfDominantLanguages":{ + "type":"list", + "member":{"shape":"DominantLanguage"} + }, + "ListOfEntities":{ + "type":"list", + "member":{"shape":"Entity"} + }, + "ListOfKeyPhrases":{ + "type":"list", + "member":{"shape":"KeyPhrase"} + }, + "ListOfSyntaxTokens":{ + "type":"list", + "member":{"shape":"SyntaxToken"} + }, + "ListSentimentDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"SentimentDetectionJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListSentimentDetectionJobsResponse":{ + "type":"structure", + "members":{ + "SentimentDetectionJobPropertiesList":{ + "shape":"SentimentDetectionJobPropertiesList", + "documentation":"

A list containing the properties of each job that is returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ComprehendArn", + "documentation":"

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ComprehendArn", + "documentation":"

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource you are querying.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Tags associated with the Amazon Comprehend resource being queried. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department.

" + } + } + }, + "ListTopicsDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"TopicsDetectionJobFilter", + "documentation":"

Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListTopicsDetectionJobsResponse":{ + "type":"structure", + "members":{ + "TopicsDetectionJobPropertiesList":{ + "shape":"TopicsDetectionJobPropertiesList", + "documentation":"

A list containing the properties of each job that is returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "MaxResultsInteger":{ + "type":"integer", + "max":500, + "min":1 + }, + "ModelStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "TRAINING", + "DELETING", + "STOP_REQUESTED", + "STOPPED", + "IN_ERROR", + "TRAINED" + ] + }, + "NumberOfTopicsInteger":{ + "type":"integer", + "max":100, + "min":1 + }, + "OutputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

  • KMS Key Alias: \"alias/ExampleAlias\"

  • ARN of a KMS Key Alias: \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

" + } + }, + "documentation":"

Provides configuration parameters for the output of topic detection jobs.

" + }, + "PartOfSpeechTag":{ + "type":"structure", + "members":{ + "Tag":{ + "shape":"PartOfSpeechTagType", + "documentation":"

Identifies the part of speech that the token represents.

" + }, + "Score":{ + "shape":"Float", + "documentation":"

The confidence that Amazon Comprehend has that the part of speech was correctly identified.

" + } + }, + "documentation":"

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

" + }, + "PartOfSpeechTagType":{ + "type":"string", + "enum":[ + "ADJ", + "ADP", + "ADV", + "AUX", + "CONJ", + "CCONJ", + "DET", + "INTJ", + "NOUN", + "NUM", + "O", + "PART", + "PRON", + "PROPN", + "PUNCT", + "SCONJ", + "SYM", + "VERB" + ] + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The specified name is already in use. Use a different name and try your request again.

", + "exception":true + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The specified resource ARN was not found. Check the ARN and try your request again.

", + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

", + "exception":true + }, + "S3Uri":{ + "type":"string", + "max":1024, + "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" + }, + "SecurityGroupId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, + "SentimentDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of dominant language detection jobs. For more information, see the operation.

" + }, + "SentimentDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the sentiment detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned to the sentiment detection job

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the sentiment detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the sentiment detection job ended.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the sentiment detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the sentiment detection job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language code of the input documents.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a sentiment detection job.

" + }, + "SentimentDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"SentimentDetectionJobProperties"} + }, + "SentimentScore":{ + "type":"structure", + "members":{ + "Positive":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

" + }, + "Negative":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

" + }, + "Neutral":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

" + }, + "Mixed":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the MIXED sentiment.

" + } + }, + "documentation":"

Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.

" + }, + "SentimentType":{ + "type":"string", + "enum":[ + "POSITIVE", + "NEGATIVE", + "NEUTRAL", + "MIXED" + ] + }, + "StartDocumentClassificationJobRequest":{ + "type":"structure", + "required":[ + "DocumentClassifierArn", + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) of the document classifier to use to process the job.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.

" + } + } + }, + "StartDocumentClassificationJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job:

  • SUBMITTED - The job has been received and queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. For details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

" + } + } + }, + "StartDominantLanguageDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

An identifier for the job.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.

" + } + } + }, + "StartDominantLanguageDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the operation.

" + } + } + }, + "StartEntitiesDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend: English (\"en\"), Spanish (\"es\"), French (\"fr\"), German (\"de\"), Italian (\"it\"), or Portuguese (\"pt\"). If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.

" + } + } + }, + "StartEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of job, use this identifier with the operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the operation.

  • STOP_REQUESTED - Amazon Comprehend has received a stop request for the job and is processing the request.

  • STOPPED - The job was successfully stopped without completing.

" + } + } + }, + "StartKeyPhrasesDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.

" + } + } + }, + "StartKeyPhrasesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the operation.

" + } + } + }, + "StartSentimentDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend: German (\"de\"), English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), or Portuguese (\"pt\"). All documents must be in the same language.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.

" + } + } + }, + "StartSentimentDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job.

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the operation.

" + } + } + }, + "StartTopicsDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "NumberOfTopics":{ + "shape":"NumberOfTopicsInteger", + "documentation":"

The number of topics to detect.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

", + "idempotencyToken":true + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

" + } + } + }, + "StartTopicsDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The status of the job:

  • SUBMITTED - The job has been received and is queued for processing.

  • IN_PROGRESS - Amazon Comprehend is processing the job.

  • COMPLETED - The job was successfully completed and the output is available.

  • FAILED - The job did not complete. To get details, use the DescribeTopicDetectionJob operation.

" + } + } + }, + "StopDominantLanguageDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the dominant language detection job to stop.

" + } + } + }, + "StopDominantLanguageDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the dominant language detection job to stop.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

" + } + } + }, + "StopEntitiesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the entities detection job to stop.

" + } + } + }, + "StopEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the entities detection job to stop.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

" + } + } + }, + "StopKeyPhrasesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the key phrases detection job to stop.

" + } + } + }, + "StopKeyPhrasesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the key phrases detection job to stop.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

" + } + } + }, + "StopSentimentDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the sentiment detection job to stop.

" + } + } + }, + "StopSentimentDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the sentiment detection job to stop.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

" + } + } + }, + "StopTrainingDocumentClassifierRequest":{ + "type":"structure", + "required":["DocumentClassifierArn"], + "members":{ + "DocumentClassifierArn":{ + "shape":"DocumentClassifierArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the document classifier currently being trained.

" + } + } + }, + "StopTrainingDocumentClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "StopTrainingEntityRecognizerRequest":{ + "type":"structure", + "required":["EntityRecognizerArn"], + "members":{ + "EntityRecognizerArn":{ + "shape":"EntityRecognizerArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the entity recognizer currently being trained.

" + } + } + }, + "StopTrainingEntityRecognizerResponse":{ + "type":"structure", + "members":{ + } + }, + "String":{ + "type":"string", + "min":1 + }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+" + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16, + "min":1 + }, + "SyntaxLanguageCode":{ + "type":"string", + "enum":[ + "en", + "es", + "fr", + "de", + "it", + "pt" + ] + }, + "SyntaxToken":{ + "type":"structure", + "members":{ + "TokenId":{ + "shape":"Integer", + "documentation":"

A unique identifier for a token.

" + }, + "Text":{ + "shape":"String", + "documentation":"

The word that was recognized in the source text.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

The zero-based offset from the beginning of the source text to the first character in the word.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

The zero-based offset from the beginning of the source text to the last character in the word.

" + }, + "PartOfSpeech":{ + "shape":"PartOfSpeechTag", + "documentation":"

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.

" + } + }, + "documentation":"

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The initial part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the key portion of the pair, with multiple possible values such as “sales,” “legal,” and “administration.”

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The second part of a key-value pair that forms a tag associated with a given resource. For instance, if you want to show which resources are used by which departments, you might use “Department” as the initial (key) portion of the pair, with a value of “sales” to indicate the sales department.

" + } + }, + "documentation":"

A key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with the key-value pair ‘Department’:’Sales’ might be added to a resource to indicate its use by a particular department.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ComprehendArn", + "documentation":"

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource to which you want to associate the tags.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Tags being associated with a specific Amazon Comprehend resource. There can be a maximum of 50 tags (both existing and pending) associated with a specific resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TextSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The size of the input text exceeds the limit. Use a smaller document.

", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The number of requests exceeds the limit. Resubmit your request later.

", + "exception":true + }, + "TooManyTagKeysException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The request contains more tag keys than can be associated with a resource (50 tag keys per resource).

", + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.

", + "exception":true + }, + "TopicsDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

" + } + }, + "documentation":"

Provides information for filtering topic detection jobs. For more information, see .

" + }, + "TopicsDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the topic detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name of the topic detection job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description for the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the topic detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the topic detection job was completed.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration supplied when you created the topic detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration supplied when you created the topic detection job.

" + }, + "NumberOfTopics":{ + "shape":"Integer", + "documentation":"

The number of topics to detect supplied when you created the topic detection job. The default is 10.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

" + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"

  • Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

" + } + }, + "documentation":"

Provides information about a topic detection job.

" + }, + "TopicsDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"TopicsDetectionJobProperties"} + }, + "UnsupportedLanguageException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as CreateEntityRecognizer), only English is accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see supported-languages.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ComprehendArn", + "documentation":"

The Amazon Resource Name (ARN) of the given Amazon Comprehend resource from which you want to remove the tags.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The initial part of a key-value pair that forms a tag being removed from a given resource. For example, a tag with \"Sales\" as the key might be added to a resource to indicate its use by the sales department. Keys must be unique and cannot be duplicated for a particular resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "VpcConfig":{ + "type":"structure", + "required":[ + "SecurityGroupIds", + "Subnets" + ], + "members":{ + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security Groups for your VPC.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". For more information, see VPCs and Subnets.

" + } + }, + "documentation":"

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For For more information, see Amazon VPC.

" + } + }, + "documentation":"

Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.

" +} diff --git a/aws/dist/botocore/data/comprehendmedical/2018-10-30/paginators-1.json b/aws/dist/botocore/data/comprehendmedical/2018-10-30/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/comprehendmedical/2018-10-30/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/comprehendmedical/2018-10-30/service-2.json b/aws/dist/botocore/data/comprehendmedical/2018-10-30/service-2.json new file mode 100644 index 00000000..372eb851 --- /dev/null +++ b/aws/dist/botocore/data/comprehendmedical/2018-10-30/service-2.json @@ -0,0 +1,978 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-10-30", + "endpointPrefix":"comprehendmedical", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"ComprehendMedical", + "serviceFullName":"AWS Comprehend Medical", + "serviceId":"ComprehendMedical", + "signatureVersion":"v4", + "signingName":"comprehendmedical", + "targetPrefix":"ComprehendMedical_20181030", + "uid":"comprehendmedical-2018-10-30" + }, + "operations":{ + "DescribeEntitiesDetectionV2Job":{ + "name":"DescribeEntitiesDetectionV2Job", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntitiesDetectionV2JobRequest"}, + "output":{"shape":"DescribeEntitiesDetectionV2JobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a medical entities detection job. Use this operation to get the status of a detection job.

" + }, + "DescribePHIDetectionJob":{ + "name":"DescribePHIDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePHIDetectionJobRequest"}, + "output":{"shape":"DescribePHIDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets the properties associated with a protected health information (PHI) detection job. Use this operation to get the status of a detection job.

" + }, + "DetectEntities":{ + "name":"DetectEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectEntitiesRequest"}, + "output":{"shape":"DetectEntitiesResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidEncodingException"}, + {"shape":"TextSizeLimitExceededException"} + ], + "documentation":"

The DetectEntities operation is deprecated. You should use the DetectEntitiesV2 operation instead.

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information .

", + "deprecated":true, + "deprecatedMessage":"This operation is deprecated, use DetectEntitiesV2 instead." + }, + "DetectEntitiesV2":{ + "name":"DetectEntitiesV2", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectEntitiesV2Request"}, + "output":{"shape":"DetectEntitiesV2Response"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidEncodingException"}, + {"shape":"TextSizeLimitExceededException"} + ], + "documentation":"

Inspects the clinical text for a variety of medical entities and returns specific information about them such as entity category, location, and confidence score on that information.

The DetectEntitiesV2 operation replaces the DetectEntities operation. This new action uses a different model for determining the entities in your medical text and changes the way that some entities are returned in the output. You should use the DetectEntitiesV2 operation in all new applications.

The DetectEntitiesV2 operation returns the Acuity and Direction entities as attributes instead of types. It does not return the Quality or Quantity entities.

" + }, + "DetectPHI":{ + "name":"DetectPHI", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectPHIRequest"}, + "output":{"shape":"DetectPHIResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidEncodingException"}, + {"shape":"TextSizeLimitExceededException"} + ], + "documentation":"

Inspects the clinical text for protected health information (PHI) entities and entity category, location, and confidence score on that information.

" + }, + "ListEntitiesDetectionV2Jobs":{ + "name":"ListEntitiesDetectionV2Jobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntitiesDetectionV2JobsRequest"}, + "output":{"shape":"ListEntitiesDetectionV2JobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of medical entity detection jobs that you have submitted.

" + }, + "ListPHIDetectionJobs":{ + "name":"ListPHIDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPHIDetectionJobsRequest"}, + "output":{"shape":"ListPHIDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ValidationException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Gets a list of protected health information (PHI) detection jobs that you have submitted.

" + }, + "StartEntitiesDetectionV2Job":{ + "name":"StartEntitiesDetectionV2Job", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartEntitiesDetectionV2JobRequest"}, + "output":{"shape":"StartEntitiesDetectionV2JobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous medical entity detection job for a collection of documents. Use the DescribeEntitiesDetectionV2Job operation to track the status of a job.

" + }, + "StartPHIDetectionJob":{ + "name":"StartPHIDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartPHIDetectionJobRequest"}, + "output":{"shape":"StartPHIDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Starts an asynchronous job to detect protected health information (PHI). Use the DescribePHIDetectionJob operation to track the status of a job.

" + }, + "StopEntitiesDetectionV2Job":{ + "name":"StopEntitiesDetectionV2Job", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopEntitiesDetectionV2JobRequest"}, + "output":{"shape":"StopEntitiesDetectionV2JobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a medical entities detection job in progress.

" + }, + "StopPHIDetectionJob":{ + "name":"StopPHIDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopPHIDetectionJobRequest"}, + "output":{"shape":"StopPHIDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Stops a protected health information (PHI) detection job in progress.

" + } + }, + "shapes":{ + "AnyLengthString":{"type":"string"}, + "Attribute":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"EntitySubType", + "documentation":"

The type of attribute.

" + }, + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend Medical has that the segment of text is correctly recognized as an attribute.

" + }, + "RelationshipScore":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend Medical has that this attribute is correctly related to this entity.

" + }, + "Id":{ + "shape":"Integer", + "documentation":"

The numeric identifier for this attribute. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

The 0-based character offset in the input text that shows where the attribute begins. The offset returns the UTF-8 code point in the string.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

The 0-based character offset in the input text that shows where the attribute ends. The offset returns the UTF-8 code point in the string.

" + }, + "Text":{ + "shape":"String", + "documentation":"

The segment of input text extracted as this attribute.

" + }, + "Traits":{ + "shape":"TraitList", + "documentation":"

Contextual information for this attribute.

" + } + }, + "documentation":"

An extracted segment of the text that is an attribute of an entity, or otherwise related to an entity, such as the dosage of a medication taken. It contains information about the attribute such as id, begin and end offset within the input text, and the segment of the input text.

" + }, + "AttributeList":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "AttributeName":{ + "type":"string", + "enum":[ + "SIGN", + "SYMPTOM", + "DIAGNOSIS", + "NEGATION" + ] + }, + "BoundedLengthString":{ + "type":"string", + "max":20000, + "min":1 + }, + "ClientRequestTokenString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ComprehendMedicalAsyncJobFilter":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

Filters on the name of the job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

Filters the list of jobs based on job status. Returns only jobs with the specified status.

" + }, + "SubmitTimeBefore":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" + }, + "SubmitTimeAfter":{ + "shape":"Timestamp", + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" + } + }, + "documentation":"

Provides information for filtering a list of detection jobs.

" + }, + "ComprehendMedicalAsyncJobProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier assigned to the detection job.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The name that you assigned to the detection job.

" + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

The current status of the detection job. If the status is FAILED, the Message field shows the reason for the failure.

" + }, + "Message":{ + "shape":"AnyLengthString", + "documentation":"

A description of the status of a job.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The time that the detection job was submitted for processing.

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

The time that the detection job completed.

" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

The input data configuration that you supplied when you created the detection job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

The output data configuration that you supplied when you created the detection job.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language code of the input documents.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

" + }, + "ManifestFilePath":{ + "shape":"ManifestFilePath", + "documentation":"

The path to the file that describes the results of a batch job.

" + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

The AWS Key Management Service key, if any, used to encrypt the output files.

" + }, + "ModelVersion":{ + "shape":"ModelVersion", + "documentation":"

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

" + } + }, + "documentation":"

Provides information about a detection job.

" + }, + "ComprehendMedicalAsyncJobPropertiesList":{ + "type":"list", + "member":{"shape":"ComprehendMedicalAsyncJobProperties"} + }, + "DescribeEntitiesDetectionV2JobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The StartEntitiesDetectionV2Job operation returns this identifier in its response.

" + } + } + }, + "DescribeEntitiesDetectionV2JobResponse":{ + "type":"structure", + "members":{ + "ComprehendMedicalAsyncJobProperties":{ + "shape":"ComprehendMedicalAsyncJobProperties", + "documentation":"

An object that contains the properties associated with a detection job.

" + } + } + }, + "DescribePHIDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier that Amazon Comprehend Medical generated for the job. The StartPHIDetectionJob operation returns this identifier in its response.

" + } + } + }, + "DescribePHIDetectionJobResponse":{ + "type":"structure", + "members":{ + "ComprehendMedicalAsyncJobProperties":{ + "shape":"ComprehendMedicalAsyncJobProperties", + "documentation":"

An object that contains the properties associated with a detection job.

" + } + } + }, + "DetectEntitiesRequest":{ + "type":"structure", + "required":["Text"], + "members":{ + "Text":{ + "shape":"BoundedLengthString", + "documentation":"

A UTF-8 text string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

" + } + } + }, + "DetectEntitiesResponse":{ + "type":"structure", + "required":[ + "Entities", + "ModelVersion" + ], + "members":{ + "Entities":{ + "shape":"EntityList", + "documentation":"

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in the detection and analysis. Attributes and traits of the entity are also returned.

" + }, + "UnmappedAttributes":{ + "shape":"UnmappedAttributeList", + "documentation":"

Attributes extracted from the input text that we were unable to relate to an entity.

" + }, + "PaginationToken":{ + "shape":"String", + "documentation":"

If the result of the previous request to DetectEntities was truncated, include the PaginationToken to fetch the next page of entities.

" + }, + "ModelVersion":{ + "shape":"String", + "documentation":"

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

" + } + } + }, + "DetectEntitiesV2Request":{ + "type":"structure", + "required":["Text"], + "members":{ + "Text":{ + "shape":"BoundedLengthString", + "documentation":"

A UTF-8 string containing the clinical content being examined for entities. Each string must contain fewer than 20,000 bytes of characters.

" + } + } + }, + "DetectEntitiesV2Response":{ + "type":"structure", + "required":[ + "Entities", + "ModelVersion" + ], + "members":{ + "Entities":{ + "shape":"EntityList", + "documentation":"

The collection of medical entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence in the detection and analysis. Attributes and traits of the entity are also returned.

" + }, + "UnmappedAttributes":{ + "shape":"UnmappedAttributeList", + "documentation":"

Attributes extracted from the input text that couldn't be related to an entity.

" + }, + "PaginationToken":{ + "shape":"String", + "documentation":"

If the result to the DetectEntitiesV2 operation was truncated, include the PaginationToken to fetch the next page of entities.

" + }, + "ModelVersion":{ + "shape":"String", + "documentation":"

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

" + } + } + }, + "DetectPHIRequest":{ + "type":"structure", + "required":["Text"], + "members":{ + "Text":{ + "shape":"BoundedLengthString", + "documentation":"

A UTF-8 text string containing the clinical content being examined for PHI entities. Each string must contain fewer than 20,000 bytes of characters.

" + } + } + }, + "DetectPHIResponse":{ + "type":"structure", + "required":[ + "Entities", + "ModelVersion" + ], + "members":{ + "Entities":{ + "shape":"EntityList", + "documentation":"

The collection of PHI entities extracted from the input text and their associated information. For each entity, the response provides the entity text, the entity category, where the entity text begins and ends, and the level of confidence that Amazon Comprehend Medical has in its detection.

" + }, + "PaginationToken":{ + "shape":"String", + "documentation":"

If the result of the previous request to DetectPHI was truncated, include the PaginationToken to fetch the next page of PHI entities.

" + }, + "ModelVersion":{ + "shape":"String", + "documentation":"

The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

" + } + } + }, + "Entity":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Integer", + "documentation":"

The numeric identifier for the entity. This is a monotonically increasing id unique within this response rather than a global unique identifier.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

The 0-based character offset in the input text that shows where the entity begins. The offset returns the UTF-8 code point in the string.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

The 0-based character offset in the input text that shows where the entity ends. The offset returns the UTF-8 code point in the string.

" + }, + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of the detection.

" + }, + "Text":{ + "shape":"String", + "documentation":"

The segment of input text extracted as this entity.

" + }, + "Category":{ + "shape":"EntityType", + "documentation":"

The category of the entity.

" + }, + "Type":{ + "shape":"EntitySubType", + "documentation":"

Describes the specific type of entity with category of entities.

" + }, + "Traits":{ + "shape":"TraitList", + "documentation":"

Contextual information for the entity

" + }, + "Attributes":{ + "shape":"AttributeList", + "documentation":"

The extracted attributes that relate to this entity.

" + } + }, + "documentation":"

Provides information about an extracted medical entity.

" + }, + "EntityList":{ + "type":"list", + "member":{"shape":"Entity"} + }, + "EntitySubType":{ + "type":"string", + "enum":[ + "NAME", + "DOSAGE", + "ROUTE_OR_MODE", + "FORM", + "FREQUENCY", + "DURATION", + "GENERIC_NAME", + "BRAND_NAME", + "STRENGTH", + "RATE", + "ACUITY", + "TEST_NAME", + "TEST_VALUE", + "TEST_UNITS", + "PROCEDURE_NAME", + "TREATMENT_NAME", + "DATE", + "AGE", + "CONTACT_POINT", + "EMAIL", + "IDENTIFIER", + "URL", + "ADDRESS", + "PROFESSION", + "SYSTEM_ORGAN_SITE", + "DIRECTION", + "QUALITY", + "QUANTITY" + ] + }, + "EntityType":{ + "type":"string", + "enum":[ + "MEDICATION", + "MEDICAL_CONDITION", + "PROTECTED_HEALTH_INFORMATION", + "TEST_TREATMENT_PROCEDURE", + "ANATOMY" + ] + }, + "Float":{"type":"float"}, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+" + }, + "InputDataConfig":{ + "type":"structure", + "required":["S3Bucket"], + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The URI of the S3 bucket that contains the input data. The bucket must be in the same region as the API endpoint that you are calling.

Each file in the document collection must be less than 40 KB. You can store a maximum of 30 GB in the bucket.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The path to the input data files in the S3 bucket.

" + } + }, + "documentation":"

The input properties for an entities detection job

" + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

An internal server error occurred. Retry your request.

", + "exception":true, + "fault":true + }, + "InvalidEncodingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The input text was not in valid UTF-8 character encoding. Check your text then retry your request.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

", + "exception":true + }, + "JobId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "JobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "PARTIAL_SUCCESS", + "FAILED", + "STOP_REQUESTED", + "STOPPED" + ] + }, + "KMSKey":{ + "type":"string", + "max":2048, + "min":1, + "pattern":".*" + }, + "LanguageCode":{ + "type":"string", + "enum":["en"] + }, + "ListEntitiesDetectionV2JobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"ComprehendMedicalAsyncJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListEntitiesDetectionV2JobsResponse":{ + "type":"structure", + "members":{ + "ComprehendMedicalAsyncJobPropertiesList":{ + "shape":"ComprehendMedicalAsyncJobPropertiesList", + "documentation":"

A list containing the properties of each job returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ListPHIDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"ComprehendMedicalAsyncJobFilter", + "documentation":"

Filters the jobs that are returned. You can filter jobs based on their names, status, or the date and time that they were submitted. You can only set one filter at a time.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

The maximum number of results to return in each page. The default is 100.

" + } + } + }, + "ListPHIDetectionJobsResponse":{ + "type":"structure", + "members":{ + "ComprehendMedicalAsyncJobPropertiesList":{ + "shape":"ComprehendMedicalAsyncJobPropertiesList", + "documentation":"

A list containing the properties of each job returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Identifies the next page of results to return.

" + } + } + }, + "ManifestFilePath":{ + "type":"string", + "max":4096, + "min":1 + }, + "MaxResultsInteger":{ + "type":"integer", + "max":500, + "min":1 + }, + "ModelVersion":{"type":"string"}, + "OutputDataConfig":{ + "type":"structure", + "required":["S3Bucket"], + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The path to the output data files in the S3 bucket. Amazon Comprehend Medical creates an output directory using the job ID so that the output from one job does not overwrite the output of another.

" + } + }, + "documentation":"

The output properties for a detection job.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The resource identified by the specified Amazon Resource Name (ARN) was not found. Check the ARN and try your request again.

", + "exception":true + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[0-9a-z\\.\\-_]*(?!\\.)$" + }, + "S3Key":{ + "type":"string", + "max":1024, + "pattern":".*" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The Amazon Comprehend Medical service is temporarily unavailable. Please wait and then retry your request.

", + "exception":true + }, + "StartEntitiesDetectionV2JobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", + "idempotencyToken":true + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. All documents must be in the same language.

" + } + } + }, + "StartEntitiesDetectionV2JobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the DescribeEntitiesDetectionV2Job operation.

" + } + } + }, + "StartPHIDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Specifies the format and location of the input data for the job.

" + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

Specifies where to send the output files.

" + }, + "DataAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.

" + }, + "JobName":{ + "shape":"JobName", + "documentation":"

The identifier of the job.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one.

", + "idempotencyToken":true + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.

" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

The language of the input documents. All documents must be in the same language.

" + } + } + }, + "StartPHIDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier generated for the job. To get the status of a job, use this identifier with the DescribePHIDetectionJob operation.

" + } + } + }, + "StopEntitiesDetectionV2JobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the medical entities job to stop.

" + } + } + }, + "StopEntitiesDetectionV2JobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the medical entities detection job that was stopped.

" + } + } + }, + "StopPHIDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the PHI detection job to stop.

" + } + } + }, + "StopPHIDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

The identifier of the PHI detection job that was stopped.

" + } + } + }, + "String":{ + "type":"string", + "min":1 + }, + "TextSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

You have made too many requests within a short period of time. Wait for a short time and then try your request again. Contact customer support for more information about a service limit increase.

", + "exception":true + }, + "Trait":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

Provides a name or contextual description about the trait.

" + }, + "Score":{ + "shape":"Float", + "documentation":"

The level of confidence that Amazon Comprehend Medical has in the accuracy of this trait.

" + } + }, + "documentation":"

Provides contextual information about the extracted entity.

" + }, + "TraitList":{ + "type":"list", + "member":{"shape":"Trait"} + }, + "UnmappedAttribute":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"EntityType", + "documentation":"

The type of the attribute, could be one of the following values: \"MEDICATION\", \"MEDICAL_CONDITION\", \"ANATOMY\", \"TEST_AND_TREATMENT_PROCEDURE\" or \"PROTECTED_HEALTH_INFORMATION\".

" + }, + "Attribute":{ + "shape":"Attribute", + "documentation":"

The specific attribute that has been extracted but not mapped to an entity.

" + } + }, + "documentation":"

An attribute that we extracted, but were unable to relate to an entity.

" + }, + "UnmappedAttributeList":{ + "type":"list", + "member":{"shape":"UnmappedAttribute"} + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The filter that you specified for the operation is invalid. Check the filter values that you entered and try your request again.

", + "exception":true + } + }, + "documentation":"

Amazon Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.

" +} diff --git a/aws/dist/botocore/data/config/2014-11-12/examples-1.json b/aws/dist/botocore/data/config/2014-11-12/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/config/2014-11-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/config/2014-11-12/paginators-1.json b/aws/dist/botocore/data/config/2014-11-12/paginators-1.json new file mode 100644 index 00000000..66701879 --- /dev/null +++ b/aws/dist/botocore/data/config/2014-11-12/paginators-1.json @@ -0,0 +1,99 @@ +{ + "pagination": { + "DescribeComplianceByConfigRule": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ComplianceByConfigRules" + }, + "DescribeComplianceByResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ComplianceByResources" + }, + "DescribeConfigRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ConfigRules" + }, + "GetComplianceDetailsByConfigRule": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "EvaluationResults" + }, + "GetComplianceDetailsByResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "EvaluationResults" + }, + "GetResourceConfigHistory": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "configurationItems", + "limit_key": "limit" + }, + "ListDiscoveredResources": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "resourceIdentifiers" + }, + "DescribeAggregateComplianceByConfigRules": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "AggregateComplianceByConfigRules" + }, + "DescribeAggregationAuthorizations": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "AggregationAuthorizations" + }, + "DescribeConfigRuleEvaluationStatus": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "ConfigRulesEvaluationStatus" + }, + "DescribeConfigurationAggregatorSourcesStatus": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "AggregatedSourceStatusList" + }, + "DescribeConfigurationAggregators": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "ConfigurationAggregators" + }, + "DescribePendingAggregationRequests": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "PendingAggregationRequests" + }, + "DescribeRetentionConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "RetentionConfigurations" + }, + "GetAggregateComplianceDetailsByConfigRule": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "AggregateEvaluationResults" + }, + "ListAggregateDiscoveredResources": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "ResourceIdentifiers" + }, + "DescribeRemediationExecutionStatus": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "RemediationExecutionStatuses" + } + } +} diff --git a/aws/dist/botocore/data/config/2014-11-12/service-2.json b/aws/dist/botocore/data/config/2014-11-12/service-2.json new file mode 100644 index 00000000..54c03639 --- /dev/null +++ b/aws/dist/botocore/data/config/2014-11-12/service-2.json @@ -0,0 +1,5273 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-12", + "endpointPrefix":"config", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Config Service", + "serviceFullName":"AWS Config", + "serviceId":"Config Service", + "signatureVersion":"v4", + "targetPrefix":"StarlingDoveService", + "uid":"config-2014-11-12" + }, + "operations":{ + "BatchGetAggregateResourceConfig":{ + "name":"BatchGetAggregateResourceConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetAggregateResourceConfigRequest"}, + "output":{"shape":"BatchGetAggregateResourceConfigResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Returns the current configuration items for resources that are present in your AWS Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.

  • The API does not return results for deleted resources.

  • The API does not return tags and relationships.

" + }, + "BatchGetResourceConfig":{ + "name":"BatchGetResourceConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetResourceConfigRequest"}, + "output":{"shape":"BatchGetResourceConfigResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"NoAvailableConfigurationRecorderException"} + ], + "documentation":"

Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.

  • The API does not return results for deleted resources.

  • The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.

" + }, + "DeleteAggregationAuthorization":{ + "name":"DeleteAggregationAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAggregationAuthorizationRequest"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

" + }, + "DeleteConfigRule":{ + "name":"DeleteConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigRuleRequest"}, + "errors":[ + {"shape":"NoSuchConfigRuleException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes the specified AWS Config rule and all of its evaluation results.

AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

" + }, + "DeleteConfigurationAggregator":{ + "name":"DeleteConfigurationAggregator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationAggregatorRequest"}, + "errors":[ + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

" + }, + "DeleteConfigurationRecorder":{ + "name":"DeleteConfigurationRecorder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationRecorderRequest"}, + "errors":[ + {"shape":"NoSuchConfigurationRecorderException"} + ], + "documentation":"

Deletes the configuration recorder.

After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.

" + }, + "DeleteDeliveryChannel":{ + "name":"DeleteDeliveryChannel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeliveryChannelRequest"}, + "errors":[ + {"shape":"NoSuchDeliveryChannelException"}, + {"shape":"LastDeliveryChannelDeleteFailedException"} + ], + "documentation":"

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

" + }, + "DeleteEvaluationResults":{ + "name":"DeleteEvaluationResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEvaluationResultsRequest"}, + "output":{"shape":"DeleteEvaluationResultsResponse"}, + "errors":[ + {"shape":"NoSuchConfigRuleException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.

" + }, + "DeleteOrganizationConfigRule":{ + "name":"DeleteOrganizationConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOrganizationConfigRuleRequest"}, + "errors":[ + {"shape":"NoSuchOrganizationConfigRuleException"}, + {"shape":"ResourceInUseException"}, + {"shape":"OrganizationAccessDeniedException"} + ], + "documentation":"

Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. Only a master account can delete an organization config rule.

AWS Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.

" + }, + "DeletePendingAggregationRequest":{ + "name":"DeletePendingAggregationRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePendingAggregationRequestRequest"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Deletes pending authorization requests for a specified aggregator account in a specified region.

" + }, + "DeleteRemediationConfiguration":{ + "name":"DeleteRemediationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRemediationConfigurationRequest"}, + "output":{"shape":"DeleteRemediationConfigurationResponse"}, + "errors":[ + {"shape":"NoSuchRemediationConfigurationException"}, + {"shape":"RemediationInProgressException"} + ], + "documentation":"

Deletes the remediation configuration.

" + }, + "DeleteRemediationExceptions":{ + "name":"DeleteRemediationExceptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRemediationExceptionsRequest"}, + "output":{"shape":"DeleteRemediationExceptionsResponse"}, + "errors":[ + {"shape":"NoSuchRemediationExceptionException"} + ], + "documentation":"

Deletes one or more remediation exceptions mentioned in the resource keys.

" + }, + "DeleteRetentionConfiguration":{ + "name":"DeleteRetentionConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRetentionConfigurationRequest"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"NoSuchRetentionConfigurationException"} + ], + "documentation":"

Deletes the retention configuration.

" + }, + "DeliverConfigSnapshot":{ + "name":"DeliverConfigSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeliverConfigSnapshotRequest"}, + "output":{"shape":"DeliverConfigSnapshotResponse"}, + "errors":[ + {"shape":"NoSuchDeliveryChannelException"}, + {"shape":"NoAvailableConfigurationRecorderException"}, + {"shape":"NoRunningConfigurationRecorderException"} + ], + "documentation":"

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified.

  • Notification of the start of the delivery.

  • Notification of the completion of the delivery, if the delivery was successfully completed.

  • Notification of delivery failure, if the delivery failed.

" + }, + "DescribeAggregateComplianceByConfigRules":{ + "name":"DescribeAggregateComplianceByConfigRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAggregateComplianceByConfigRulesRequest"}, + "output":{"shape":"DescribeAggregateComplianceByConfigRulesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

" + }, + "DescribeAggregationAuthorizations":{ + "name":"DescribeAggregationAuthorizations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAggregationAuthorizationsRequest"}, + "output":{"shape":"DescribeAggregationAuthorizationsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidLimitException"} + ], + "documentation":"

Returns a list of authorizations granted to various aggregator accounts and regions.

" + }, + "DescribeComplianceByConfigRule":{ + "name":"DescribeComplianceByConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComplianceByConfigRuleRequest"}, + "output":{"shape":"DescribeComplianceByConfigRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"NoSuchConfigRuleException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

" + }, + "DescribeComplianceByResource":{ + "name":"DescribeComplianceByResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeComplianceByResourceRequest"}, + "output":{"shape":"DescribeComplianceByResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.

A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.

  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

" + }, + "DescribeConfigRuleEvaluationStatus":{ + "name":"DescribeConfigRuleEvaluationStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigRuleEvaluationStatusRequest"}, + "output":{"shape":"DescribeConfigRuleEvaluationStatusResponse"}, + "errors":[ + {"shape":"NoSuchConfigRuleException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.

" + }, + "DescribeConfigRules":{ + "name":"DescribeConfigRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigRulesRequest"}, + "output":{"shape":"DescribeConfigRulesResponse"}, + "errors":[ + {"shape":"NoSuchConfigRuleException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns details about your AWS Config rules.

" + }, + "DescribeConfigurationAggregatorSourcesStatus":{ + "name":"DescribeConfigurationAggregatorSourcesStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationAggregatorSourcesStatusRequest"}, + "output":{"shape":"DescribeConfigurationAggregatorSourcesStatusResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"NoSuchConfigurationAggregatorException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidLimitException"} + ], + "documentation":"

Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

" + }, + "DescribeConfigurationAggregators":{ + "name":"DescribeConfigurationAggregators", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationAggregatorsRequest"}, + "output":{"shape":"DescribeConfigurationAggregatorsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"NoSuchConfigurationAggregatorException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidLimitException"} + ], + "documentation":"

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

" + }, + "DescribeConfigurationRecorderStatus":{ + "name":"DescribeConfigurationRecorderStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationRecorderStatusRequest"}, + "output":{"shape":"DescribeConfigurationRecorderStatusResponse"}, + "errors":[ + {"shape":"NoSuchConfigurationRecorderException"} + ], + "documentation":"

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

" + }, + "DescribeConfigurationRecorders":{ + "name":"DescribeConfigurationRecorders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationRecordersRequest"}, + "output":{"shape":"DescribeConfigurationRecordersResponse"}, + "errors":[ + {"shape":"NoSuchConfigurationRecorderException"} + ], + "documentation":"

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.

Currently, you can specify only one configuration recorder per region in your account.

" + }, + "DescribeDeliveryChannelStatus":{ + "name":"DescribeDeliveryChannelStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeliveryChannelStatusRequest"}, + "output":{"shape":"DescribeDeliveryChannelStatusResponse"}, + "errors":[ + {"shape":"NoSuchDeliveryChannelException"} + ], + "documentation":"

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

" + }, + "DescribeDeliveryChannels":{ + "name":"DescribeDeliveryChannels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeliveryChannelsRequest"}, + "output":{"shape":"DescribeDeliveryChannelsResponse"}, + "errors":[ + {"shape":"NoSuchDeliveryChannelException"} + ], + "documentation":"

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

" + }, + "DescribeOrganizationConfigRuleStatuses":{ + "name":"DescribeOrganizationConfigRuleStatuses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrganizationConfigRuleStatusesRequest"}, + "output":{"shape":"DescribeOrganizationConfigRuleStatusesResponse"}, + "errors":[ + {"shape":"NoSuchOrganizationConfigRuleException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"OrganizationAccessDeniedException"} + ], + "documentation":"

Provides organization config rule deployment status for an organization.

The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

Only a master account can call this API.

" + }, + "DescribeOrganizationConfigRules":{ + "name":"DescribeOrganizationConfigRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrganizationConfigRulesRequest"}, + "output":{"shape":"DescribeOrganizationConfigRulesResponse"}, + "errors":[ + {"shape":"NoSuchOrganizationConfigRuleException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidLimitException"}, + {"shape":"OrganizationAccessDeniedException"} + ], + "documentation":"

Returns a list of organization config rules.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

Only a master account can call this API.

" + }, + "DescribePendingAggregationRequests":{ + "name":"DescribePendingAggregationRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingAggregationRequestsRequest"}, + "output":{"shape":"DescribePendingAggregationRequestsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidLimitException"} + ], + "documentation":"

Returns a list of all pending aggregation requests.

" + }, + "DescribeRemediationConfigurations":{ + "name":"DescribeRemediationConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRemediationConfigurationsRequest"}, + "output":{"shape":"DescribeRemediationConfigurationsResponse"}, + "documentation":"

Returns the details of one or more remediation configurations.

" + }, + "DescribeRemediationExceptions":{ + "name":"DescribeRemediationExceptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRemediationExceptionsRequest"}, + "output":{"shape":"DescribeRemediationExceptionsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

" + }, + "DescribeRemediationExecutionStatus":{ + "name":"DescribeRemediationExecutionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRemediationExecutionStatusRequest"}, + "output":{"shape":"DescribeRemediationExecutionStatusResponse"}, + "errors":[ + {"shape":"NoSuchRemediationConfigurationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

" + }, + "DescribeRetentionConfigurations":{ + "name":"DescribeRetentionConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRetentionConfigurationsRequest"}, + "output":{"shape":"DescribeRetentionConfigurationsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"NoSuchRetentionConfigurationException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.

Currently, AWS Config supports only one retention configuration per region in your account.

" + }, + "GetAggregateComplianceDetailsByConfigRule":{ + "name":"GetAggregateComplianceDetailsByConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAggregateComplianceDetailsByConfigRuleRequest"}, + "output":{"shape":"GetAggregateComplianceDetailsByConfigRuleResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

" + }, + "GetAggregateConfigRuleComplianceSummary":{ + "name":"GetAggregateConfigRuleComplianceSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAggregateConfigRuleComplianceSummaryRequest"}, + "output":{"shape":"GetAggregateConfigRuleComplianceSummaryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

" + }, + "GetAggregateDiscoveredResourceCounts":{ + "name":"GetAggregateDiscoveredResourceCounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAggregateDiscoveredResourceCountsRequest"}, + "output":{"shape":"GetAggregateDiscoveredResourceCountsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey.

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

" + }, + "GetAggregateResourceConfig":{ + "name":"GetAggregateResourceConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAggregateResourceConfigRequest"}, + "output":{"shape":"GetAggregateResourceConfigResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"NoSuchConfigurationAggregatorException"}, + {"shape":"OversizedConfigurationItemException"}, + {"shape":"ResourceNotDiscoveredException"} + ], + "documentation":"

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

" + }, + "GetComplianceDetailsByConfigRule":{ + "name":"GetComplianceDetailsByConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComplianceDetailsByConfigRuleRequest"}, + "output":{"shape":"GetComplianceDetailsByConfigRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigRuleException"} + ], + "documentation":"

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

" + }, + "GetComplianceDetailsByResource":{ + "name":"GetComplianceDetailsByResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComplianceDetailsByResourceRequest"}, + "output":{"shape":"GetComplianceDetailsByResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

" + }, + "GetComplianceSummaryByConfigRule":{ + "name":"GetComplianceSummaryByConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"GetComplianceSummaryByConfigRuleResponse"}, + "documentation":"

Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

" + }, + "GetComplianceSummaryByResourceType":{ + "name":"GetComplianceSummaryByResourceType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComplianceSummaryByResourceTypeRequest"}, + "output":{"shape":"GetComplianceSummaryByResourceTypeResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

" + }, + "GetDiscoveredResourceCounts":{ + "name":"GetDiscoveredResourceCounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDiscoveredResourceCountsRequest"}, + "output":{"shape":"GetDiscoveredResourceCountsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.

Example

  1. AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. AWS Config returns the following:

    • The resource types (EC2 instances, IAM users, and S3 buckets).

    • The number of each resource type (25, 20, and 15).

    • The total number of all resources (60).

The response is paginated. By default, AWS Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

  • You are a new AWS Config customer.

  • You just enabled resource recording.

It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

" + }, + "GetOrganizationConfigRuleDetailedStatus":{ + "name":"GetOrganizationConfigRuleDetailedStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOrganizationConfigRuleDetailedStatusRequest"}, + "output":{"shape":"GetOrganizationConfigRuleDetailedStatusResponse"}, + "errors":[ + {"shape":"NoSuchOrganizationConfigRuleException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"OrganizationAccessDeniedException"} + ], + "documentation":"

Returns detailed status for each member account within an organization for a given organization config rule.

Only a master account can call this API.

" + }, + "GetResourceConfigHistory":{ + "name":"GetResourceConfigHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceConfigHistoryRequest"}, + "output":{"shape":"GetResourceConfigHistoryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidTimeRangeException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoAvailableConfigurationRecorderException"}, + {"shape":"ResourceNotDiscoveredException"} + ], + "documentation":"

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the ConfigurationItems for the specified retention period.

The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

" + }, + "ListAggregateDiscoveredResources":{ + "name":"ListAggregateDiscoveredResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAggregateDiscoveredResourcesRequest"}, + "output":{"shape":"ListAggregateDiscoveredResourcesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoSuchConfigurationAggregatorException"} + ], + "documentation":"

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.

For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

" + }, + "ListDiscoveredResources":{ + "name":"ListDiscoveredResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDiscoveredResourcesRequest"}, + "output":{"shape":"ListDiscoveredResourcesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"NoAvailableConfigurationRecorderException"} + ], + "documentation":"

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.

You can specify either resource IDs or a resource name, but not both, in the same request.

The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

List the tags for AWS Config resource.

" + }, + "PutAggregationAuthorization":{ + "name":"PutAggregationAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAggregationAuthorizationRequest"}, + "output":{"shape":"PutAggregationAuthorizationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Authorizes the aggregator account and region to collect data from the source account and region.

" + }, + "PutConfigRule":{ + "name":"PutConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConfigRuleRequest"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MaxNumberOfConfigRulesExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InsufficientPermissionsException"}, + {"shape":"NoAvailableConfigurationRecorderException"} + ], + "documentation":"

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.

You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules.

For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules.

If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

The maximum number of rules that AWS Config supports is 150.

For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

" + }, + "PutConfigurationAggregator":{ + "name":"PutConfigurationAggregator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConfigurationAggregatorRequest"}, + "output":{"shape":"PutConfigurationAggregatorResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidRoleException"}, + {"shape":"OrganizationAccessDeniedException"}, + {"shape":"NoAvailableOrganizationException"}, + {"shape":"OrganizationAllFeaturesNotEnabledException"} + ], + "documentation":"

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

AWS Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations.

" + }, + "PutConfigurationRecorder":{ + "name":"PutConfigurationRecorder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConfigurationRecorderRequest"}, + "errors":[ + {"shape":"MaxNumberOfConfigurationRecordersExceededException"}, + {"shape":"InvalidConfigurationRecorderNameException"}, + {"shape":"InvalidRoleException"}, + {"shape":"InvalidRecordingGroupException"} + ], + "documentation":"

Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Currently, you can specify only one configuration recorder per region in your account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

" + }, + "PutDeliveryChannel":{ + "name":"PutDeliveryChannel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDeliveryChannelRequest"}, + "errors":[ + {"shape":"MaxNumberOfDeliveryChannelsExceededException"}, + {"shape":"NoAvailableConfigurationRecorderException"}, + {"shape":"InvalidDeliveryChannelNameException"}, + {"shape":"NoSuchBucketException"}, + {"shape":"InvalidS3KeyPrefixException"}, + {"shape":"InvalidSNSTopicARNException"}, + {"shape":"InsufficientDeliveryPolicyException"} + ], + "documentation":"

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.

Before you can create a delivery channel, you must create a configuration recorder.

You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.

You can have only one delivery channel per region in your account.

" + }, + "PutEvaluations":{ + "name":"PutEvaluations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutEvaluationsRequest"}, + "output":{"shape":"PutEvaluationsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidResultTokenException"}, + {"shape":"NoSuchConfigRuleException"} + ], + "documentation":"

Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.

" + }, + "PutOrganizationConfigRule":{ + "name":"PutOrganizationConfigRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutOrganizationConfigRuleRequest"}, + "output":{"shape":"PutOrganizationConfigRuleResponse"}, + "errors":[ + {"shape":"MaxNumberOfOrganizationConfigRulesExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ValidationException"}, + {"shape":"OrganizationAccessDeniedException"}, + {"shape":"NoAvailableOrganizationException"}, + {"shape":"OrganizationAllFeaturesNotEnabledException"}, + {"shape":"InsufficientPermissionsException"} + ], + "documentation":"

Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations. Only a master account can create or update an organization config rule.

This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master account of your organization. The service linked role is created only when the role does not exist in the master account. AWS Config verifies the existence of role with GetRole action.

You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier key.

The maximum number of organization config rules that AWS Config supports is 150.

Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

" + }, + "PutRemediationConfigurations":{ + "name":"PutRemediationConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRemediationConfigurationsRequest"}, + "output":{"shape":"PutRemediationConfigurationsResponse"}, + "errors":[ + {"shape":"InsufficientPermissionsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

" + }, + "PutRemediationExceptions":{ + "name":"PutRemediationExceptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRemediationExceptionsRequest"}, + "output":{"shape":"PutRemediationExceptionsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.

" + }, + "PutRetentionConfiguration":{ + "name":"PutRetentionConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRetentionConfigurationRequest"}, + "output":{"shape":"PutRetentionConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MaxNumberOfRetentionConfigurationsExceededException"} + ], + "documentation":"

Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Currently, AWS Config supports only one retention configuration per region in your account.

" + }, + "SelectResourceConfig":{ + "name":"SelectResourceConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SelectResourceConfigRequest"}, + "output":{"shape":"SelectResourceConfigResponse"}, + "errors":[ + {"shape":"InvalidExpressionException"}, + {"shape":"InvalidLimitException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

For more information about query components, see the Query Components section in the AWS Config Developer Guide.

" + }, + "StartConfigRulesEvaluation":{ + "name":"StartConfigRulesEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartConfigRulesEvaluationRequest"}, + "output":{"shape":"StartConfigRulesEvaluationResponse"}, + "errors":[ + {"shape":"NoSuchConfigRuleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.

You can specify up to 25 AWS Config rules per request.

An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

" + }, + "StartConfigurationRecorder":{ + "name":"StartConfigurationRecorder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartConfigurationRecorderRequest"}, + "errors":[ + {"shape":"NoSuchConfigurationRecorderException"}, + {"shape":"NoAvailableDeliveryChannelException"} + ], + "documentation":"

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

You must have created at least one delivery channel to successfully start the configuration recorder.

" + }, + "StartRemediationExecution":{ + "name":"StartRemediationExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartRemediationExecutionRequest"}, + "output":{"shape":"StartRemediationExecutionResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InsufficientPermissionsException"}, + {"shape":"NoSuchRemediationConfigurationException"} + ], + "documentation":"

Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.

You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

" + }, + "StopConfigurationRecorder":{ + "name":"StopConfigurationRecorder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopConfigurationRecorderRequest"}, + "errors":[ + {"shape":"NoSuchConfigurationRecorderException"} + ], + "documentation":"

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyTagsException"} + ], + "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes specified tags from a resource.

" + } + }, + "shapes":{ + "ARN":{"type":"string"}, + "AccountAggregationSource":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountAggregationSourceAccountList", + "documentation":"

The 12-digit account ID of the account being aggregated.

" + }, + "AllAwsRegions":{ + "shape":"Boolean", + "documentation":"

If true, aggregate existing AWS Config regions and future regions.

" + }, + "AwsRegions":{ + "shape":"AggregatorRegionList", + "documentation":"

The source regions being aggregated.

" + } + }, + "documentation":"

A collection of accounts and regions.

" + }, + "AccountAggregationSourceAccountList":{ + "type":"list", + "member":{"shape":"AccountId"}, + "min":1 + }, + "AccountAggregationSourceList":{ + "type":"list", + "member":{"shape":"AccountAggregationSource"}, + "max":1, + "min":0 + }, + "AccountId":{ + "type":"string", + "pattern":"\\d{12}" + }, + "AggregateComplianceByConfigRule":{ + "type":"structure", + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule.

" + }, + "Compliance":{ + "shape":"Compliance", + "documentation":"

Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region from where the data is aggregated.

" + } + }, + "documentation":"

Indicates whether an AWS Config rule is compliant based on account ID, region, compliance, and rule name.

A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

" + }, + "AggregateComplianceByConfigRuleList":{ + "type":"list", + "member":{"shape":"AggregateComplianceByConfigRule"} + }, + "AggregateComplianceCount":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"StringWithCharLimit256", + "documentation":"

The 12-digit account ID or region based on the GroupByKey value.

" + }, + "ComplianceSummary":{ + "shape":"ComplianceSummary", + "documentation":"

The number of compliant and noncompliant AWS Config rules.

" + } + }, + "documentation":"

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

" + }, + "AggregateComplianceCountList":{ + "type":"list", + "member":{"shape":"AggregateComplianceCount"} + }, + "AggregateEvaluationResult":{ + "type":"structure", + "members":{ + "EvaluationResultIdentifier":{ + "shape":"EvaluationResultIdentifier", + "documentation":"

Uniquely identifies the evaluation result.

" + }, + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

The resource compliance status.

For the AggregationEvaluationResult data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

" + }, + "ResultRecordedTime":{ + "shape":"Date", + "documentation":"

The time when AWS Config recorded the aggregate evaluation result.

" + }, + "ConfigRuleInvokedTime":{ + "shape":"Date", + "documentation":"

The time when the AWS Config rule evaluated the AWS resource.

" + }, + "Annotation":{ + "shape":"StringWithCharLimit256", + "documentation":"

Supplementary information about how the agrregate evaluation determined the compliance.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region from where the data is aggregated.

" + } + }, + "documentation":"

The details of an AWS Config evaluation for an account ID and region in an aggregator. Provides the AWS resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

" + }, + "AggregateEvaluationResultList":{ + "type":"list", + "member":{"shape":"AggregateEvaluationResult"} + }, + "AggregateResourceIdentifier":{ + "type":"structure", + "required":[ + "SourceAccountId", + "SourceRegion", + "ResourceId", + "ResourceType" + ], + "members":{ + "SourceAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "SourceRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region where data is aggregated.

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

The ID of the AWS resource.

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

The type of the AWS resource.

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

The name of the AWS resource.

" + } + }, + "documentation":"

The details that identify a resource that is collected by AWS Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.

" + }, + "AggregatedSourceStatus":{ + "type":"structure", + "members":{ + "SourceId":{ + "shape":"String", + "documentation":"

The source account ID or an organization.

" + }, + "SourceType":{ + "shape":"AggregatedSourceType", + "documentation":"

The source account or an organization.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region authorized to collect aggregated data.

" + }, + "LastUpdateStatus":{ + "shape":"AggregatedSourceStatusType", + "documentation":"

Filters the last updated status type.

  • Valid value FAILED indicates errors while moving data.

  • Valid value SUCCEEDED indicates the data was successfully moved.

  • Valid value OUTDATED indicates the data is not the most recent.

" + }, + "LastUpdateTime":{ + "shape":"Date", + "documentation":"

The time of the last update.

" + }, + "LastErrorCode":{ + "shape":"String", + "documentation":"

The error code that AWS Config returned when the source account aggregation last failed.

" + }, + "LastErrorMessage":{ + "shape":"String", + "documentation":"

The message indicating that the source account aggregation failed due to an error.

" + } + }, + "documentation":"

The current sync status between the source and the aggregator account.

" + }, + "AggregatedSourceStatusList":{ + "type":"list", + "member":{"shape":"AggregatedSourceStatus"} + }, + "AggregatedSourceStatusType":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED", + "OUTDATED" + ] + }, + "AggregatedSourceStatusTypeList":{ + "type":"list", + "member":{"shape":"AggregatedSourceStatusType"}, + "min":1 + }, + "AggregatedSourceType":{ + "type":"string", + "enum":[ + "ACCOUNT", + "ORGANIZATION" + ] + }, + "AggregationAuthorization":{ + "type":"structure", + "members":{ + "AggregationAuthorizationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the aggregation object.

" + }, + "AuthorizedAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the account authorized to aggregate data.

" + }, + "AuthorizedAwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region authorized to collect aggregated data.

" + }, + "CreationTime":{ + "shape":"Date", + "documentation":"

The time stamp when the aggregation authorization was created.

" + } + }, + "documentation":"

An object that represents the authorizations granted to aggregator accounts and regions.

" + }, + "AggregationAuthorizationList":{ + "type":"list", + "member":{"shape":"AggregationAuthorization"} + }, + "AggregatorRegionList":{ + "type":"list", + "member":{"shape":"String"}, + "min":1 + }, + "AllSupported":{"type":"boolean"}, + "AmazonResourceName":{ + "type":"string", + "max":256, + "min":1 + }, + "AutoRemediationAttemptSeconds":{ + "type":"long", + "box":true, + "max":2678000, + "min":1 + }, + "AutoRemediationAttempts":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "AvailabilityZone":{"type":"string"}, + "AwsRegion":{ + "type":"string", + "max":64, + "min":1 + }, + "BaseConfigurationItem":{ + "type":"structure", + "members":{ + "version":{ + "shape":"Version", + "documentation":"

The version number of the resource configuration.

" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit AWS account ID associated with the resource.

" + }, + "configurationItemCaptureTime":{ + "shape":"ConfigurationItemCaptureTime", + "documentation":"

The time when the configuration recording was initiated.

" + }, + "configurationItemStatus":{ + "shape":"ConfigurationItemStatus", + "documentation":"

The configuration item status.

" + }, + "configurationStateId":{ + "shape":"ConfigurationStateId", + "documentation":"

An identifier that indicates the ordering of the configuration items of a resource.

" + }, + "arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

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

The type of AWS resource.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the resource (for example., sg-xxxxxx).

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

The custom name of the resource, if available.

" + }, + "awsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region where the resource resides.

" + }, + "availabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone associated with the resource.

" + }, + "resourceCreationTime":{ + "shape":"ResourceCreationTime", + "documentation":"

The time stamp when the resource was created.

" + }, + "configuration":{ + "shape":"Configuration", + "documentation":"

The description of the resource configuration.

" + }, + "supplementaryConfiguration":{ + "shape":"SupplementaryConfiguration", + "documentation":"

Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter.

" + } + }, + "documentation":"

The detailed configuration of a specified resource.

" + }, + "BaseConfigurationItems":{ + "type":"list", + "member":{"shape":"BaseConfigurationItem"} + }, + "BaseResourceId":{ + "type":"string", + "max":768, + "min":1 + }, + "BatchGetAggregateResourceConfigRequest":{ + "type":"structure", + "required":[ + "ConfigurationAggregatorName", + "ResourceIdentifiers" + ], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "ResourceIdentifiers":{ + "shape":"ResourceIdentifiersList", + "documentation":"

A list of aggregate ResourceIdentifiers objects.

" + } + } + }, + "BatchGetAggregateResourceConfigResponse":{ + "type":"structure", + "members":{ + "BaseConfigurationItems":{ + "shape":"BaseConfigurationItems", + "documentation":"

A list that contains the current configuration of one or more resources.

" + }, + "UnprocessedResourceIdentifiers":{ + "shape":"UnprocessedResourceIdentifierList", + "documentation":"

A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

" + } + } + }, + "BatchGetResourceConfigRequest":{ + "type":"structure", + "required":["resourceKeys"], + "members":{ + "resourceKeys":{ + "shape":"ResourceKeys", + "documentation":"

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

" + } + } + }, + "BatchGetResourceConfigResponse":{ + "type":"structure", + "members":{ + "baseConfigurationItems":{ + "shape":"BaseConfigurationItems", + "documentation":"

A list that contains the current configuration of one or more resources.

" + }, + "unprocessedResourceKeys":{ + "shape":"ResourceKeys", + "documentation":"

A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "ChannelName":{ + "type":"string", + "max":256, + "min":1 + }, + "ChronologicalOrder":{ + "type":"string", + "enum":[ + "Reverse", + "Forward" + ] + }, + "Compliance":{ + "type":"structure", + "members":{ + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

Indicates whether an AWS resource or AWS Config rule is compliant.

A resource is compliant if it complies with all of the AWS Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or AWS Config rule.

For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS Config does not support the NOT_APPLICABLE value for the Compliance data type.

" + }, + "ComplianceContributorCount":{ + "shape":"ComplianceContributorCount", + "documentation":"

The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

" + } + }, + "documentation":"

Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.

" + }, + "ComplianceByConfigRule":{ + "type":"structure", + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule.

" + }, + "Compliance":{ + "shape":"Compliance", + "documentation":"

Indicates whether the AWS Config rule is compliant.

" + } + }, + "documentation":"

Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.

" + }, + "ComplianceByConfigRules":{ + "type":"list", + "member":{"shape":"ComplianceByConfigRule"} + }, + "ComplianceByResource":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of the AWS resource that was evaluated.

" + }, + "ResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the AWS resource that was evaluated.

" + }, + "Compliance":{ + "shape":"Compliance", + "documentation":"

Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.

" + } + }, + "documentation":"

Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

" + }, + "ComplianceByResources":{ + "type":"list", + "member":{"shape":"ComplianceByResource"} + }, + "ComplianceContributorCount":{ + "type":"structure", + "members":{ + "CappedCount":{ + "shape":"Integer", + "documentation":"

The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

" + }, + "CapExceeded":{ + "shape":"Boolean", + "documentation":"

Indicates whether the maximum count is reached.

" + } + }, + "documentation":"

The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.

" + }, + "ComplianceResourceTypes":{ + "type":"list", + "member":{"shape":"StringWithCharLimit256"}, + "max":100, + "min":0 + }, + "ComplianceSummariesByResourceType":{ + "type":"list", + "member":{"shape":"ComplianceSummaryByResourceType"} + }, + "ComplianceSummary":{ + "type":"structure", + "members":{ + "CompliantResourceCount":{ + "shape":"ComplianceContributorCount", + "documentation":"

The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

" + }, + "NonCompliantResourceCount":{ + "shape":"ComplianceContributorCount", + "documentation":"

The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

" + }, + "ComplianceSummaryTimestamp":{ + "shape":"Date", + "documentation":"

The time that AWS Config created the compliance summary.

" + } + }, + "documentation":"

The number of AWS Config rules or AWS resources that are compliant and noncompliant.

" + }, + "ComplianceSummaryByResourceType":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of AWS resource.

" + }, + "ComplianceSummary":{ + "shape":"ComplianceSummary", + "documentation":"

The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each.

" + } + }, + "documentation":"

The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.

" + }, + "ComplianceType":{ + "type":"string", + "enum":[ + "COMPLIANT", + "NON_COMPLIANT", + "NOT_APPLICABLE", + "INSUFFICIENT_DATA" + ] + }, + "ComplianceTypes":{ + "type":"list", + "member":{"shape":"ComplianceType"}, + "max":3, + "min":0 + }, + "ConfigExportDeliveryInfo":{ + "type":"structure", + "members":{ + "lastStatus":{ + "shape":"DeliveryStatus", + "documentation":"

Status of the last attempted delivery.

" + }, + "lastErrorCode":{ + "shape":"String", + "documentation":"

The error code from the last attempted delivery.

" + }, + "lastErrorMessage":{ + "shape":"String", + "documentation":"

The error message from the last attempted delivery.

" + }, + "lastAttemptTime":{ + "shape":"Date", + "documentation":"

The time of the last attempted delivery.

" + }, + "lastSuccessfulTime":{ + "shape":"Date", + "documentation":"

The time of the last successful delivery.

" + }, + "nextDeliveryTime":{ + "shape":"Date", + "documentation":"

The time that the next delivery occurs.

" + } + }, + "documentation":"

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

" + }, + "ConfigRule":{ + "type":"structure", + "required":["Source"], + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

" + }, + "ConfigRuleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Config rule.

" + }, + "ConfigRuleId":{ + "shape":"String", + "documentation":"

The ID of the AWS Config rule.

" + }, + "Description":{ + "shape":"EmptiableStringWithCharLimit256", + "documentation":"

The description that you provide for the AWS Config rule.

" + }, + "Scope":{ + "shape":"Scope", + "documentation":"

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

" + }, + "Source":{ + "shape":"Source", + "documentation":"

Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.

" + }, + "InputParameters":{ + "shape":"StringWithCharLimit1024", + "documentation":"

A string, in JSON format, that is passed to the AWS Config rule Lambda function.

" + }, + "MaximumExecutionFrequency":{ + "shape":"MaximumExecutionFrequency", + "documentation":"

The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

  • You are using an AWS managed rule that is triggered at a periodic frequency.

  • Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

" + }, + "ConfigRuleState":{ + "shape":"ConfigRuleState", + "documentation":"

Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the AWS Config rule.

AWS Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the AWS Config rule.

AWS Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the AWS Config rule.

AWS Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

" + }, + "CreatedBy":{ + "shape":"StringWithCharLimit256", + "documentation":"

Service principal name of the service that created the rule.

The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.

" + } + }, + "documentation":"

An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).

You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

" + }, + "ConfigRuleComplianceFilters":{ + "type":"structure", + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule.

" + }, + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

The rule compliance status.

For the ConfigRuleComplianceFilters data type, AWS Config supports only COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region where the data is aggregated.

" + } + }, + "documentation":"

Filters the compliance results based on account ID, region, compliance type, and rule name.

" + }, + "ConfigRuleComplianceSummaryFilters":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region where the data is aggregated.

" + } + }, + "documentation":"

Filters the results based on the account IDs and regions.

" + }, + "ConfigRuleComplianceSummaryGroupKey":{ + "type":"string", + "enum":[ + "ACCOUNT_ID", + "AWS_REGION" + ] + }, + "ConfigRuleEvaluationStatus":{ + "type":"structure", + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule.

" + }, + "ConfigRuleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Config rule.

" + }, + "ConfigRuleId":{ + "shape":"String", + "documentation":"

The ID of the AWS Config rule.

" + }, + "LastSuccessfulInvocationTime":{ + "shape":"Date", + "documentation":"

The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.

" + }, + "LastFailedInvocationTime":{ + "shape":"Date", + "documentation":"

The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.

" + }, + "LastSuccessfulEvaluationTime":{ + "shape":"Date", + "documentation":"

The time that AWS Config last successfully evaluated your AWS resources against the rule.

" + }, + "LastFailedEvaluationTime":{ + "shape":"Date", + "documentation":"

The time that AWS Config last failed to evaluate your AWS resources against the rule.

" + }, + "FirstActivatedTime":{ + "shape":"Date", + "documentation":"

The time that you first activated the AWS Config rule.

" + }, + "LastErrorCode":{ + "shape":"String", + "documentation":"

The error code that AWS Config returned when the rule last failed.

" + }, + "LastErrorMessage":{ + "shape":"String", + "documentation":"

The error message that AWS Config returned when the rule last failed.

" + }, + "FirstEvaluationStarted":{ + "shape":"Boolean", + "documentation":"

Indicates whether AWS Config has evaluated your resources against the rule at least once.

  • true - AWS Config has evaluated your AWS resources against the rule at least once.

  • false - AWS Config has not once finished evaluating your AWS resources against the rule.

" + } + }, + "documentation":"

Status information for your AWS managed Config rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.

This action does not return status information about custom AWS Config rules.

" + }, + "ConfigRuleEvaluationStatusList":{ + "type":"list", + "member":{"shape":"ConfigRuleEvaluationStatus"} + }, + "ConfigRuleName":{ + "type":"string", + "max":128, + "min":1, + "pattern":".*\\S.*" + }, + "ConfigRuleNames":{ + "type":"list", + "member":{"shape":"ConfigRuleName"}, + "max":25, + "min":0 + }, + "ConfigRuleState":{ + "type":"string", + "enum":[ + "ACTIVE", + "DELETING", + "DELETING_RESULTS", + "EVALUATING" + ] + }, + "ConfigRules":{ + "type":"list", + "member":{"shape":"ConfigRule"} + }, + "ConfigSnapshotDeliveryProperties":{ + "type":"structure", + "members":{ + "deliveryFrequency":{ + "shape":"MaximumExecutionFrequency", + "documentation":"

The frequency with which AWS Config delivers configuration snapshots.

" + } + }, + "documentation":"

Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

  • The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for AWS Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule.

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.

" + }, + "ConfigStreamDeliveryInfo":{ + "type":"structure", + "members":{ + "lastStatus":{ + "shape":"DeliveryStatus", + "documentation":"

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for AWS Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

" + }, + "lastErrorCode":{ + "shape":"String", + "documentation":"

The error code from the last attempted delivery.

" + }, + "lastErrorMessage":{ + "shape":"String", + "documentation":"

The error message from the last attempted delivery.

" + }, + "lastStatusChangeTime":{ + "shape":"Date", + "documentation":"

The time from the last status change.

" + } + }, + "documentation":"

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

" + }, + "Configuration":{"type":"string"}, + "ConfigurationAggregator":{ + "type":"structure", + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the aggregator.

" + }, + "ConfigurationAggregatorArn":{ + "shape":"ConfigurationAggregatorArn", + "documentation":"

The Amazon Resource Name (ARN) of the aggregator.

" + }, + "AccountAggregationSources":{ + "shape":"AccountAggregationSourceList", + "documentation":"

Provides a list of source accounts and regions to be aggregated.

" + }, + "OrganizationAggregationSource":{ + "shape":"OrganizationAggregationSource", + "documentation":"

Provides an organization and list of regions to be aggregated.

" + }, + "CreationTime":{ + "shape":"Date", + "documentation":"

The time stamp when the configuration aggregator was created.

" + }, + "LastUpdatedTime":{ + "shape":"Date", + "documentation":"

The time of the last update.

" + } + }, + "documentation":"

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

" + }, + "ConfigurationAggregatorArn":{ + "type":"string", + "pattern":"arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+" + }, + "ConfigurationAggregatorList":{ + "type":"list", + "member":{"shape":"ConfigurationAggregator"} + }, + "ConfigurationAggregatorName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w\\-]+" + }, + "ConfigurationAggregatorNameList":{ + "type":"list", + "member":{"shape":"ConfigurationAggregatorName"}, + "max":10, + "min":0 + }, + "ConfigurationItem":{ + "type":"structure", + "members":{ + "version":{ + "shape":"Version", + "documentation":"

The version number of the resource configuration.

" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit AWS account ID associated with the resource.

" + }, + "configurationItemCaptureTime":{ + "shape":"ConfigurationItemCaptureTime", + "documentation":"

The time when the configuration recording was initiated.

" + }, + "configurationItemStatus":{ + "shape":"ConfigurationItemStatus", + "documentation":"

The configuration item status.

" + }, + "configurationStateId":{ + "shape":"ConfigurationStateId", + "documentation":"

An identifier that indicates the ordering of the configuration items of a resource.

" + }, + "configurationItemMD5Hash":{ + "shape":"ConfigurationItemMD5Hash", + "documentation":"

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

" + }, + "arn":{ + "shape":"ARN", + "documentation":"

accoun

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

The type of AWS resource.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the resource (for example, sg-xxxxxx).

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

The custom name of the resource, if available.

" + }, + "awsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region where the resource resides.

" + }, + "availabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone associated with the resource.

" + }, + "resourceCreationTime":{ + "shape":"ResourceCreationTime", + "documentation":"

The time stamp when the resource was created.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

A mapping of key value tags associated with the resource.

" + }, + "relatedEvents":{ + "shape":"RelatedEventList", + "documentation":"

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is AWS CloudTrail.

An empty field indicates that the current configuration was not initiated by any event.

" + }, + "relationships":{ + "shape":"RelationshipList", + "documentation":"

A list of related AWS resources.

" + }, + "configuration":{ + "shape":"Configuration", + "documentation":"

The description of the resource configuration.

" + }, + "supplementaryConfiguration":{ + "shape":"SupplementaryConfiguration", + "documentation":"

Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the configuration parameter.

" + } + }, + "documentation":"

A list that contains detailed configurations of a specified resource.

" + }, + "ConfigurationItemCaptureTime":{"type":"timestamp"}, + "ConfigurationItemList":{ + "type":"list", + "member":{"shape":"ConfigurationItem"} + }, + "ConfigurationItemMD5Hash":{"type":"string"}, + "ConfigurationItemStatus":{ + "type":"string", + "enum":[ + "OK", + "ResourceDiscovered", + "ResourceNotRecorded", + "ResourceDeleted", + "ResourceDeletedNotRecorded" + ] + }, + "ConfigurationRecorder":{ + "type":"structure", + "members":{ + "name":{ + "shape":"RecorderName", + "documentation":"

The name of the recorder. By default, AWS Config automatically assigns the name \"default\" when creating the configuration recorder. You cannot change the assigned name.

" + }, + "roleARN":{ + "shape":"String", + "documentation":"

Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.

" + }, + "recordingGroup":{ + "shape":"RecordingGroup", + "documentation":"

Specifies the types of AWS resources for which AWS Config records configuration changes.

" + } + }, + "documentation":"

An object that represents the recording of configuration changes of an AWS resource.

" + }, + "ConfigurationRecorderList":{ + "type":"list", + "member":{"shape":"ConfigurationRecorder"} + }, + "ConfigurationRecorderNameList":{ + "type":"list", + "member":{"shape":"RecorderName"} + }, + "ConfigurationRecorderStatus":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the configuration recorder.

" + }, + "lastStartTime":{ + "shape":"Date", + "documentation":"

The time the recorder was last started.

" + }, + "lastStopTime":{ + "shape":"Date", + "documentation":"

The time the recorder was last stopped.

" + }, + "recording":{ + "shape":"Boolean", + "documentation":"

Specifies whether or not the recorder is currently recording.

" + }, + "lastStatus":{ + "shape":"RecorderStatus", + "documentation":"

The last (previous) status of the recorder.

" + }, + "lastErrorCode":{ + "shape":"String", + "documentation":"

The error code indicating that the recording failed.

" + }, + "lastErrorMessage":{ + "shape":"String", + "documentation":"

The message indicating that the recording failed due to an error.

" + }, + "lastStatusChangeTime":{ + "shape":"Date", + "documentation":"

The time when the status was last changed.

" + } + }, + "documentation":"

The current status of the configuration recorder.

" + }, + "ConfigurationRecorderStatusList":{ + "type":"list", + "member":{"shape":"ConfigurationRecorderStatus"} + }, + "ConfigurationStateId":{"type":"string"}, + "CosmosPageLimit":{ + "type":"integer", + "max":100, + "min":0 + }, + "Date":{"type":"timestamp"}, + "DeleteAggregationAuthorizationRequest":{ + "type":"structure", + "required":[ + "AuthorizedAccountId", + "AuthorizedAwsRegion" + ], + "members":{ + "AuthorizedAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the account authorized to aggregate data.

" + }, + "AuthorizedAwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region authorized to collect aggregated data.

" + } + } + }, + "DeleteConfigRuleRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule that you want to delete.

" + } + }, + "documentation":"

" + }, + "DeleteConfigurationAggregatorRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + } + } + }, + "DeleteConfigurationRecorderRequest":{ + "type":"structure", + "required":["ConfigurationRecorderName"], + "members":{ + "ConfigurationRecorderName":{ + "shape":"RecorderName", + "documentation":"

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

" + } + }, + "documentation":"

The request object for the DeleteConfigurationRecorder action.

" + }, + "DeleteDeliveryChannelRequest":{ + "type":"structure", + "required":["DeliveryChannelName"], + "members":{ + "DeliveryChannelName":{ + "shape":"ChannelName", + "documentation":"

The name of the delivery channel to delete.

" + } + }, + "documentation":"

The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format.

" + }, + "DeleteEvaluationResultsRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule for which you want to delete the evaluation results.

" + } + }, + "documentation":"

" + }, + "DeleteEvaluationResultsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output when you delete the evaluation results for the specified AWS Config rule.

" + }, + "DeleteOrganizationConfigRuleRequest":{ + "type":"structure", + "required":["OrganizationConfigRuleName"], + "members":{ + "OrganizationConfigRuleName":{ + "shape":"OrganizationConfigRuleName", + "documentation":"

The name of organization config rule that you want to delete.

" + } + } + }, + "DeletePendingAggregationRequestRequest":{ + "type":"structure", + "required":[ + "RequesterAccountId", + "RequesterAwsRegion" + ], + "members":{ + "RequesterAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the account requesting to aggregate data.

" + }, + "RequesterAwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region requesting to aggregate data.

" + } + } + }, + "DeleteRemediationConfigurationRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule for which you want to delete remediation configuration.

" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The type of a resource.

" + } + } + }, + "DeleteRemediationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRemediationExceptionsRequest":{ + "type":"structure", + "required":[ + "ConfigRuleName", + "ResourceKeys" + ], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule for which you want to delete remediation exception configuration.

" + }, + "ResourceKeys":{ + "shape":"RemediationExceptionResourceKeys", + "documentation":"

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

" + } + } + }, + "DeleteRemediationExceptionsResponse":{ + "type":"structure", + "members":{ + "FailedBatches":{ + "shape":"FailedDeleteRemediationExceptionsBatches", + "documentation":"

Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

" + } + } + }, + "DeleteRetentionConfigurationRequest":{ + "type":"structure", + "required":["RetentionConfigurationName"], + "members":{ + "RetentionConfigurationName":{ + "shape":"RetentionConfigurationName", + "documentation":"

The name of the retention configuration to delete.

" + } + } + }, + "DeliverConfigSnapshotRequest":{ + "type":"structure", + "required":["deliveryChannelName"], + "members":{ + "deliveryChannelName":{ + "shape":"ChannelName", + "documentation":"

The name of the delivery channel through which the snapshot is delivered.

" + } + }, + "documentation":"

The input for the DeliverConfigSnapshot action.

" + }, + "DeliverConfigSnapshotResponse":{ + "type":"structure", + "members":{ + "configSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot that is being created.

" + } + }, + "documentation":"

The output for the DeliverConfigSnapshot action, in JSON format.

" + }, + "DeliveryChannel":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ChannelName", + "documentation":"

The name of the delivery channel. By default, AWS Config assigns the name \"default\" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

" + }, + "s3BucketName":{ + "shape":"String", + "documentation":"

The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon S3 Bucket in the AWS Config Developer Guide.

" + }, + "s3KeyPrefix":{ + "shape":"String", + "documentation":"

The prefix for the specified Amazon S3 bucket.

" + }, + "snsTopicARN":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see Permissions for the Amazon SNS Topic in the AWS Config Developer Guide.

" + }, + "configSnapshotDeliveryProperties":{ + "shape":"ConfigSnapshotDeliveryProperties", + "documentation":"

The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.

" + } + }, + "documentation":"

The channel through which AWS Config delivers notifications and updated configuration states.

" + }, + "DeliveryChannelList":{ + "type":"list", + "member":{"shape":"DeliveryChannel"} + }, + "DeliveryChannelNameList":{ + "type":"list", + "member":{"shape":"ChannelName"} + }, + "DeliveryChannelStatus":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the delivery channel.

" + }, + "configSnapshotDeliveryInfo":{ + "shape":"ConfigExportDeliveryInfo", + "documentation":"

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

" + }, + "configHistoryDeliveryInfo":{ + "shape":"ConfigExportDeliveryInfo", + "documentation":"

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

" + }, + "configStreamDeliveryInfo":{ + "shape":"ConfigStreamDeliveryInfo", + "documentation":"

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

" + } + }, + "documentation":"

The status of a specified delivery channel.

Valid values: Success | Failure

" + }, + "DeliveryChannelStatusList":{ + "type":"list", + "member":{"shape":"DeliveryChannelStatus"} + }, + "DeliveryStatus":{ + "type":"string", + "enum":[ + "Success", + "Failure", + "Not_Applicable" + ] + }, + "DescribeAggregateComplianceByConfigRulesRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "Filters":{ + "shape":"ConfigRuleComplianceFilters", + "documentation":"

Filters the results by ConfigRuleComplianceFilters object.

" + }, + "Limit":{ + "shape":"GroupByAPILimit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeAggregateComplianceByConfigRulesResponse":{ + "type":"structure", + "members":{ + "AggregateComplianceByConfigRules":{ + "shape":"AggregateComplianceByConfigRuleList", + "documentation":"

Returns a list of AggregateComplianceByConfigRule object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeAggregationAuthorizationsRequest":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeAggregationAuthorizationsResponse":{ + "type":"structure", + "members":{ + "AggregationAuthorizations":{ + "shape":"AggregationAuthorizationList", + "documentation":"

Returns a list of authorizations granted to various aggregator accounts and regions.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeComplianceByConfigRuleRequest":{ + "type":"structure", + "members":{ + "ConfigRuleNames":{ + "shape":"ConfigRuleNames", + "documentation":"

Specify one or more AWS Config rule names to filter the results by rule.

" + }, + "ComplianceTypes":{ + "shape":"ComplianceTypes", + "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeComplianceByConfigRuleResponse":{ + "type":"structure", + "members":{ + "ComplianceByConfigRules":{ + "shape":"ComplianceByConfigRules", + "documentation":"

Indicates whether each of the specified AWS Config rules is compliant.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeComplianceByResourceRequest":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The types of AWS resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.

" + }, + "ResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.

" + }, + "ComplianceTypes":{ + "shape":"ComplianceTypes", + "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeComplianceByResourceResponse":{ + "type":"structure", + "members":{ + "ComplianceByResources":{ + "shape":"ComplianceByResources", + "documentation":"

Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeConfigRuleEvaluationStatusRequest":{ + "type":"structure", + "members":{ + "ConfigRuleNames":{ + "shape":"ConfigRuleNames", + "documentation":"

The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + }, + "Limit":{ + "shape":"RuleLimit", + "documentation":"

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 150 rules.

For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

" + } + }, + "documentation":"

" + }, + "DescribeConfigRuleEvaluationStatusResponse":{ + "type":"structure", + "members":{ + "ConfigRulesEvaluationStatus":{ + "shape":"ConfigRuleEvaluationStatusList", + "documentation":"

Status information about your AWS managed Config rules.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeConfigRulesRequest":{ + "type":"structure", + "members":{ + "ConfigRuleNames":{ + "shape":"ConfigRuleNames", + "documentation":"

The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeConfigRulesResponse":{ + "type":"structure", + "members":{ + "ConfigRules":{ + "shape":"ConfigRules", + "documentation":"

The details about your AWS Config rules.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "DescribeConfigurationAggregatorSourcesStatusRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "UpdateStatus":{ + "shape":"AggregatedSourceStatusTypeList", + "documentation":"

Filters the status type.

  • Valid value FAILED indicates errors while moving data.

  • Valid value SUCCEEDED indicates the data was successfully moved.

  • Valid value OUTDATED indicates the data is not the most recent.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + } + } + }, + "DescribeConfigurationAggregatorSourcesStatusResponse":{ + "type":"structure", + "members":{ + "AggregatedSourceStatusList":{ + "shape":"AggregatedSourceStatusList", + "documentation":"

Returns an AggregatedSourceStatus object.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeConfigurationAggregatorsRequest":{ + "type":"structure", + "members":{ + "ConfigurationAggregatorNames":{ + "shape":"ConfigurationAggregatorNameList", + "documentation":"

The name of the configuration aggregators.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + } + } + }, + "DescribeConfigurationAggregatorsResponse":{ + "type":"structure", + "members":{ + "ConfigurationAggregators":{ + "shape":"ConfigurationAggregatorList", + "documentation":"

Returns a ConfigurationAggregators object.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeConfigurationRecorderStatusRequest":{ + "type":"structure", + "members":{ + "ConfigurationRecorderNames":{ + "shape":"ConfigurationRecorderNameList", + "documentation":"

The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.

" + } + }, + "documentation":"

The input for the DescribeConfigurationRecorderStatus action.

" + }, + "DescribeConfigurationRecorderStatusResponse":{ + "type":"structure", + "members":{ + "ConfigurationRecordersStatus":{ + "shape":"ConfigurationRecorderStatusList", + "documentation":"

A list that contains status of the specified recorders.

" + } + }, + "documentation":"

The output for the DescribeConfigurationRecorderStatus action, in JSON format.

" + }, + "DescribeConfigurationRecordersRequest":{ + "type":"structure", + "members":{ + "ConfigurationRecorderNames":{ + "shape":"ConfigurationRecorderNameList", + "documentation":"

A list of configuration recorder names.

" + } + }, + "documentation":"

The input for the DescribeConfigurationRecorders action.

" + }, + "DescribeConfigurationRecordersResponse":{ + "type":"structure", + "members":{ + "ConfigurationRecorders":{ + "shape":"ConfigurationRecorderList", + "documentation":"

A list that contains the descriptions of the specified configuration recorders.

" + } + }, + "documentation":"

The output for the DescribeConfigurationRecorders action.

" + }, + "DescribeDeliveryChannelStatusRequest":{ + "type":"structure", + "members":{ + "DeliveryChannelNames":{ + "shape":"DeliveryChannelNameList", + "documentation":"

A list of delivery channel names.

" + } + }, + "documentation":"

The input for the DeliveryChannelStatus action.

" + }, + "DescribeDeliveryChannelStatusResponse":{ + "type":"structure", + "members":{ + "DeliveryChannelsStatus":{ + "shape":"DeliveryChannelStatusList", + "documentation":"

A list that contains the status of a specified delivery channel.

" + } + }, + "documentation":"

The output for the DescribeDeliveryChannelStatus action.

" + }, + "DescribeDeliveryChannelsRequest":{ + "type":"structure", + "members":{ + "DeliveryChannelNames":{ + "shape":"DeliveryChannelNameList", + "documentation":"

A list of delivery channel names.

" + } + }, + "documentation":"

The input for the DescribeDeliveryChannels action.

" + }, + "DescribeDeliveryChannelsResponse":{ + "type":"structure", + "members":{ + "DeliveryChannels":{ + "shape":"DeliveryChannelList", + "documentation":"

A list that contains the descriptions of the specified delivery channel.

" + } + }, + "documentation":"

The output for the DescribeDeliveryChannels action.

" + }, + "DescribeOrganizationConfigRuleStatusesRequest":{ + "type":"structure", + "members":{ + "OrganizationConfigRuleNames":{ + "shape":"OrganizationConfigRuleNames", + "documentation":"

The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.

" + }, + "Limit":{ + "shape":"CosmosPageLimit", + "documentation":"

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeOrganizationConfigRuleStatusesResponse":{ + "type":"structure", + "members":{ + "OrganizationConfigRuleStatuses":{ + "shape":"OrganizationConfigRuleStatuses", + "documentation":"

A list of OrganizationConfigRuleStatus objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeOrganizationConfigRulesRequest":{ + "type":"structure", + "members":{ + "OrganizationConfigRuleNames":{ + "shape":"OrganizationConfigRuleNames", + "documentation":"

The names of organization config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization config rules.

" + }, + "Limit":{ + "shape":"CosmosPageLimit", + "documentation":"

The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeOrganizationConfigRulesResponse":{ + "type":"structure", + "members":{ + "OrganizationConfigRules":{ + "shape":"OrganizationConfigRules", + "documentation":"

Retuns a list OrganizationConfigRule objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribePendingAggregationRequestsLimit":{ + "type":"integer", + "max":20, + "min":0 + }, + "DescribePendingAggregationRequestsRequest":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"DescribePendingAggregationRequestsLimit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribePendingAggregationRequestsResponse":{ + "type":"structure", + "members":{ + "PendingAggregationRequests":{ + "shape":"PendingAggregationRequestList", + "documentation":"

Returns a PendingAggregationRequests object.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeRemediationConfigurationsRequest":{ + "type":"structure", + "required":["ConfigRuleNames"], + "members":{ + "ConfigRuleNames":{ + "shape":"ConfigRuleNames", + "documentation":"

A list of AWS Config rule names of remediation configurations for which you want details.

" + } + } + }, + "DescribeRemediationConfigurationsResponse":{ + "type":"structure", + "members":{ + "RemediationConfigurations":{ + "shape":"RemediationConfigurations", + "documentation":"

Returns a remediation configuration object.

" + } + } + }, + "DescribeRemediationExceptionsRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule.

" + }, + "ResourceKeys":{ + "shape":"RemediationExceptionResourceKeys", + "documentation":"

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } + } + }, + "DescribeRemediationExceptionsResponse":{ + "type":"structure", + "members":{ + "RemediationExceptions":{ + "shape":"RemediationExceptions", + "documentation":"

Returns a list of remediation exception objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } + } + }, + "DescribeRemediationExecutionStatusRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

A list of AWS Config rule names.

" + }, + "ResourceKeys":{ + "shape":"ResourceKeys", + "documentation":"

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeRemediationExecutionStatusResponse":{ + "type":"structure", + "members":{ + "RemediationExecutionStatuses":{ + "shape":"RemediationExecutionStatuses", + "documentation":"

Returns a list of remediation execution statuses objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeRetentionConfigurationsRequest":{ + "type":"structure", + "members":{ + "RetentionConfigurationNames":{ + "shape":"RetentionConfigurationNameList", + "documentation":"

A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account.

Currently, AWS Config supports only one retention configuration per region in your account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DescribeRetentionConfigurationsResponse":{ + "type":"structure", + "members":{ + "RetentionConfigurations":{ + "shape":"RetentionConfigurationList", + "documentation":"

Returns a retention configuration object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "DiscoveredResourceIdentifierList":{ + "type":"list", + "member":{"shape":"AggregateResourceIdentifier"} + }, + "EarlierTime":{"type":"timestamp"}, + "EmptiableStringWithCharLimit256":{ + "type":"string", + "max":256, + "min":0 + }, + "Evaluation":{ + "type":"structure", + "required":[ + "ComplianceResourceType", + "ComplianceResourceId", + "ComplianceType", + "OrderingTimestamp" + ], + "members":{ + "ComplianceResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of AWS resource that was evaluated.

" + }, + "ComplianceResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the AWS resource that was evaluated.

" + }, + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.

For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom AWS Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.

" + }, + "Annotation":{ + "shape":"StringWithCharLimit256", + "documentation":"

Supplementary information about how the evaluation determined the compliance.

" + }, + "OrderingTimestamp":{ + "shape":"OrderingTimestamp", + "documentation":"

The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

" + } + }, + "documentation":"

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

" + }, + "EvaluationResult":{ + "type":"structure", + "members":{ + "EvaluationResultIdentifier":{ + "shape":"EvaluationResultIdentifier", + "documentation":"

Uniquely identifies the evaluation result.

" + }, + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.

For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

" + }, + "ResultRecordedTime":{ + "shape":"Date", + "documentation":"

The time when AWS Config recorded the evaluation result.

" + }, + "ConfigRuleInvokedTime":{ + "shape":"Date", + "documentation":"

The time when the AWS Config rule evaluated the AWS resource.

" + }, + "Annotation":{ + "shape":"StringWithCharLimit256", + "documentation":"

Supplementary information about how the evaluation determined the compliance.

" + }, + "ResultToken":{ + "shape":"String", + "documentation":"

An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.

" + } + }, + "documentation":"

The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

" + }, + "EvaluationResultIdentifier":{ + "type":"structure", + "members":{ + "EvaluationResultQualifier":{ + "shape":"EvaluationResultQualifier", + "documentation":"

Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource.

" + }, + "OrderingTimestamp":{ + "shape":"Date", + "documentation":"

The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.

" + } + }, + "documentation":"

Uniquely identifies an evaluation result.

" + }, + "EvaluationResultQualifier":{ + "type":"structure", + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule that was used in the evaluation.

" + }, + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of AWS resource that was evaluated.

" + }, + "ResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the evaluated AWS resource.

" + } + }, + "documentation":"

Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated.

" + }, + "EvaluationResults":{ + "type":"list", + "member":{"shape":"EvaluationResult"} + }, + "Evaluations":{ + "type":"list", + "member":{"shape":"Evaluation"}, + "max":100, + "min":0 + }, + "EventSource":{ + "type":"string", + "enum":["aws.config"] + }, + "ExcludedAccounts":{ + "type":"list", + "member":{"shape":"AccountId"}, + "max":1000, + "min":0 + }, + "ExecutionControls":{ + "type":"structure", + "members":{ + "SsmControls":{ + "shape":"SsmControls", + "documentation":"

A SsmControls object.

" + } + }, + "documentation":"

The controls that AWS Config uses for executing remediations.

" + }, + "Expression":{ + "type":"string", + "max":4096, + "min":1 + }, + "FailedDeleteRemediationExceptionsBatch":{ + "type":"structure", + "members":{ + "FailureMessage":{ + "shape":"String", + "documentation":"

Returns a failure message for delete remediation exception. For example, AWS Config creates an exception due to an internal error.

" + }, + "FailedItems":{ + "shape":"RemediationExceptionResourceKeys", + "documentation":"

Returns remediation exception resource key object of the failed items.

" + } + }, + "documentation":"

List of each of the failed delete remediation exceptions with specific reasons.

" + }, + "FailedDeleteRemediationExceptionsBatches":{ + "type":"list", + "member":{"shape":"FailedDeleteRemediationExceptionsBatch"} + }, + "FailedRemediationBatch":{ + "type":"structure", + "members":{ + "FailureMessage":{ + "shape":"String", + "documentation":"

Returns a failure message. For example, the resource is already compliant.

" + }, + "FailedItems":{ + "shape":"RemediationConfigurations", + "documentation":"

Returns remediation configurations of the failed items.

" + } + }, + "documentation":"

List of each of the failed remediations with specific reasons.

" + }, + "FailedRemediationBatches":{ + "type":"list", + "member":{"shape":"FailedRemediationBatch"} + }, + "FailedRemediationExceptionBatch":{ + "type":"structure", + "members":{ + "FailureMessage":{ + "shape":"String", + "documentation":"

Returns a failure message. For example, the auto-remediation has failed.

" + }, + "FailedItems":{ + "shape":"RemediationExceptions", + "documentation":"

Returns remediation exception resource key object of the failed items.

" + } + }, + "documentation":"

List of each of the failed remediation exceptions with specific reasons.

" + }, + "FailedRemediationExceptionBatches":{ + "type":"list", + "member":{"shape":"FailedRemediationExceptionBatch"} + }, + "FieldInfo":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FieldName", + "documentation":"

Name of the field.

" + } + }, + "documentation":"

Details about the fields such as name of the field.

" + }, + "FieldInfoList":{ + "type":"list", + "member":{"shape":"FieldInfo"} + }, + "FieldName":{"type":"string"}, + "GetAggregateComplianceDetailsByConfigRuleRequest":{ + "type":"structure", + "required":[ + "ConfigurationAggregatorName", + "ConfigRuleName", + "AccountId", + "AwsRegion" + ], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule for which you want compliance information.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the source account.

" + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The source region from where the data is aggregated.

" + }, + "ComplianceType":{ + "shape":"ComplianceType", + "documentation":"

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the COMPLIANT and NON_COMPLIANT. AWS Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is 50. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateComplianceDetailsByConfigRuleResponse":{ + "type":"structure", + "members":{ + "AggregateEvaluationResults":{ + "shape":"AggregateEvaluationResultList", + "documentation":"

Returns an AggregateEvaluationResults object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateConfigRuleComplianceSummaryRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "Filters":{ + "shape":"ConfigRuleComplianceSummaryFilters", + "documentation":"

Filters the results based on the ConfigRuleComplianceSummaryFilters object.

" + }, + "GroupByKey":{ + "shape":"ConfigRuleComplianceSummaryGroupKey", + "documentation":"

Groups the result based on ACCOUNT_ID or AWS_REGION.

" + }, + "Limit":{ + "shape":"GroupByAPILimit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateConfigRuleComplianceSummaryResponse":{ + "type":"structure", + "members":{ + "GroupByKey":{ + "shape":"StringWithCharLimit256", + "documentation":"

Groups the result based on ACCOUNT_ID or AWS_REGION.

" + }, + "AggregateComplianceCounts":{ + "shape":"AggregateComplianceCountList", + "documentation":"

Returns a list of AggregateComplianceCounts object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateDiscoveredResourceCountsRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "Filters":{ + "shape":"ResourceCountFilters", + "documentation":"

Filters the results based on the ResourceCountFilters object.

" + }, + "GroupByKey":{ + "shape":"ResourceCountGroupKey", + "documentation":"

The key to group the resource counts.

" + }, + "Limit":{ + "shape":"GroupByAPILimit", + "documentation":"

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateDiscoveredResourceCountsResponse":{ + "type":"structure", + "required":["TotalDiscoveredResources"], + "members":{ + "TotalDiscoveredResources":{ + "shape":"Long", + "documentation":"

The total number of resources that are present in an aggregator with the filters that you provide.

" + }, + "GroupByKey":{ + "shape":"StringWithCharLimit256", + "documentation":"

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

" + }, + "GroupedResourceCounts":{ + "shape":"GroupedResourceCountList", + "documentation":"

Returns a list of GroupedResourceCount objects.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetAggregateResourceConfigRequest":{ + "type":"structure", + "required":[ + "ConfigurationAggregatorName", + "ResourceIdentifier" + ], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "ResourceIdentifier":{ + "shape":"AggregateResourceIdentifier", + "documentation":"

An object that identifies aggregate resource.

" + } + } + }, + "GetAggregateResourceConfigResponse":{ + "type":"structure", + "members":{ + "ConfigurationItem":{ + "shape":"ConfigurationItem", + "documentation":"

Returns a ConfigurationItem object.

" + } + } + }, + "GetComplianceDetailsByConfigRuleRequest":{ + "type":"structure", + "required":["ConfigRuleName"], + "members":{ + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of the AWS Config rule for which you want compliance information.

" + }, + "ComplianceTypes":{ + "shape":"ComplianceTypes", + "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "GetComplianceDetailsByConfigRuleResponse":{ + "type":"structure", + "members":{ + "EvaluationResults":{ + "shape":"EvaluationResults", + "documentation":"

Indicates whether the AWS resource complies with the specified AWS Config rule.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "GetComplianceDetailsByResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of the AWS resource for which you want compliance information.

" + }, + "ResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the AWS resource for which you want compliance information.

" + }, + "ComplianceTypes":{ + "shape":"ComplianceTypes", + "documentation":"

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "GetComplianceDetailsByResourceResponse":{ + "type":"structure", + "members":{ + "EvaluationResults":{ + "shape":"EvaluationResults", + "documentation":"

Indicates whether the specified AWS resource complies each AWS Config rule.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "GetComplianceSummaryByConfigRuleResponse":{ + "type":"structure", + "members":{ + "ComplianceSummary":{ + "shape":"ComplianceSummary", + "documentation":"

The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

" + } + }, + "documentation":"

" + }, + "GetComplianceSummaryByResourceTypeRequest":{ + "type":"structure", + "members":{ + "ResourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an AWS resource type such as AWS::EC2::Instance. You can specify that the resource type is an AWS account by specifying AWS::::Account.

" + } + }, + "documentation":"

" + }, + "GetComplianceSummaryByResourceTypeResponse":{ + "type":"structure", + "members":{ + "ComplianceSummariesByResourceType":{ + "shape":"ComplianceSummariesByResourceType", + "documentation":"

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

" + } + }, + "documentation":"

" + }, + "GetDiscoveredResourceCountsRequest":{ + "type":"structure", + "members":{ + "resourceTypes":{ + "shape":"ResourceTypes", + "documentation":"

The comma-separated list that specifies the resource types that you want AWS Config to return (for example, \"AWS::EC2::Instance\", \"AWS::IAM::User\").

If a value for resourceTypes is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account.

If the configuration recorder is turned off, AWS Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.

" + }, + "limit":{ + "shape":"Limit", + "documentation":"

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetDiscoveredResourceCountsResponse":{ + "type":"structure", + "members":{ + "totalDiscoveredResources":{ + "shape":"Long", + "documentation":"

The total number of resources that AWS Config is recording in the region for your account. If you specify resource types in the request, AWS Config returns only the total number of resources for those resource types.

Example

  1. AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.

  2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, \"AWS::EC2::Instances\", in the request.

  3. AWS Config returns 25 for totalDiscoveredResources.

" + }, + "resourceCounts":{ + "shape":"ResourceCounts", + "documentation":"

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + } + }, + "GetOrganizationConfigRuleDetailedStatusRequest":{ + "type":"structure", + "required":["OrganizationConfigRuleName"], + "members":{ + "OrganizationConfigRuleName":{ + "shape":"OrganizationConfigRuleName", + "documentation":"

The name of organization config rule for which you want status details for member accounts.

" + }, + "Filters":{ + "shape":"StatusDetailFilters", + "documentation":"

A StatusDetailFilters object.

" + }, + "Limit":{ + "shape":"CosmosPageLimit", + "documentation":"

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetOrganizationConfigRuleDetailedStatusResponse":{ + "type":"structure", + "members":{ + "OrganizationConfigRuleDetailedStatus":{ + "shape":"OrganizationConfigRuleDetailedStatus", + "documentation":"

A list of MemberAccountStatus objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "GetResourceConfigHistoryRequest":{ + "type":"structure", + "required":[ + "resourceType", + "resourceId" + ], + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" + }, + "laterTime":{ + "shape":"LaterTime", + "documentation":"

The time stamp that indicates a later time. If not specified, current time is taken.

" + }, + "earlierTime":{ + "shape":"EarlierTime", + "documentation":"

The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start when the first configuration item was recorded.

" + }, + "chronologicalOrder":{ + "shape":"ChronologicalOrder", + "documentation":"

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

" + }, + "limit":{ + "shape":"Limit", + "documentation":"

The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

The input for the GetResourceConfigHistory action.

" + }, + "GetResourceConfigHistoryResponse":{ + "type":"structure", + "members":{ + "configurationItems":{ + "shape":"ConfigurationItemList", + "documentation":"

A list that contains the configuration history of one or more resources.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

The output for the GetResourceConfigHistory action.

" + }, + "GroupByAPILimit":{ + "type":"integer", + "max":1000, + "min":0 + }, + "GroupedResourceCount":{ + "type":"structure", + "required":[ + "GroupName", + "ResourceCount" + ], + "members":{ + "GroupName":{ + "shape":"StringWithCharLimit256", + "documentation":"

The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

" + }, + "ResourceCount":{ + "shape":"Long", + "documentation":"

The number of resources in the group.

" + } + }, + "documentation":"

The count of resources that are grouped by the group name.

" + }, + "GroupedResourceCountList":{ + "type":"list", + "member":{"shape":"GroupedResourceCount"} + }, + "IncludeGlobalResourceTypes":{"type":"boolean"}, + "InsufficientDeliveryPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Your Amazon S3 bucket policy does not permit AWS Config to write to it.

", + "exception":true + }, + "InsufficientPermissionsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Indicates one of the following errors:

  • For PutConfigRule, the rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.

  • For PutConfigRule, the AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.

  • For OrganizationConfigRule, organization config rule cannot be created because you do not have permissions to call IAM GetRole action or create service linked role.

", + "exception":true + }, + "Integer":{"type":"integer"}, + "InvalidConfigurationRecorderNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have provided a configuration recorder name that is not valid.

", + "exception":true + }, + "InvalidDeliveryChannelNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified delivery channel name is not valid.

", + "exception":true + }, + "InvalidExpressionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The syntax of the query is incorrect.

", + "exception":true + }, + "InvalidLimitException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified limit is outside the allowable range.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

", + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

", + "exception":true + }, + "InvalidRecordingGroupException":{ + "type":"structure", + "members":{ + }, + "documentation":"

AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values might also be incorrectly formatted.

", + "exception":true + }, + "InvalidResultTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified ResultToken is invalid.

", + "exception":true + }, + "InvalidRoleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have provided a null or empty role ARN.

", + "exception":true + }, + "InvalidS3KeyPrefixException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon S3 key prefix is not valid.

", + "exception":true + }, + "InvalidSNSTopicARNException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon SNS topic does not exist.

", + "exception":true + }, + "InvalidTimeRangeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified time range is not valid. The earlier time is not chronologically before the later time.

", + "exception":true + }, + "LastDeliveryChannelDeleteFailedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot delete the delivery channel you specified because the configuration recorder is running.

", + "exception":true + }, + "LaterTime":{"type":"timestamp"}, + "Limit":{ + "type":"integer", + "max":100, + "min":0 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

", + "exception":true + }, + "ListAggregateDiscoveredResourcesRequest":{ + "type":"structure", + "required":[ + "ConfigurationAggregatorName", + "ResourceType" + ], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

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

The type of resources that you want AWS Config to list in the response.

" + }, + "Filters":{ + "shape":"ResourceFilters", + "documentation":"

Filters the results based on the ResourceFilters object.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "ListAggregateDiscoveredResourcesResponse":{ + "type":"structure", + "members":{ + "ResourceIdentifiers":{ + "shape":"DiscoveredResourceIdentifierList", + "documentation":"

Returns a list of ResourceIdentifiers objects.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "ListDiscoveredResourcesRequest":{ + "type":"structure", + "required":["resourceType"], + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resources that you want AWS Config to list in the response.

" + }, + "resourceIds":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

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

The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.

" + }, + "limit":{ + "shape":"Limit", + "documentation":"

The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.

" + }, + "includeDeletedResources":{ + "shape":"Boolean", + "documentation":"

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "ListDiscoveredResourcesResponse":{ + "type":"structure", + "members":{ + "resourceIdentifiers":{ + "shape":"ResourceIdentifierList", + "documentation":"

The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that you use in a subsequent request to get the next page of results in a paginated response.

" + } + }, + "documentation":"

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the resource.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

" + } + } + }, + "Long":{"type":"long"}, + "MaxNumberOfConfigRulesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Failed to add the AWS Config rule because the account already contains the maximum number of 150 rules. Consider deleting any deactivated rules before you add new rules.

", + "exception":true + }, + "MaxNumberOfConfigurationRecordersExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the limit of the number of recorders you can create.

", + "exception":true + }, + "MaxNumberOfDeliveryChannelsExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the limit of the number of delivery channels you can create.

", + "exception":true + }, + "MaxNumberOfOrganizationConfigRulesExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the limit of the number of organization config rules you can create.

", + "exception":true + }, + "MaxNumberOfRetentionConfigurationsExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Failed to add the retention configuration because a retention configuration with that name already exists.

", + "exception":true + }, + "MaximumExecutionFrequency":{ + "type":"string", + "enum":[ + "One_Hour", + "Three_Hours", + "Six_Hours", + "Twelve_Hours", + "TwentyFour_Hours" + ] + }, + "MemberAccountRuleStatus":{ + "type":"string", + "enum":[ + "CREATE_SUCCESSFUL", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "UPDATE_IN_PROGRESS", + "DELETE_SUCCESSFUL", + "DELETE_FAILED", + "DELETE_IN_PROGRESS" + ] + }, + "MemberAccountStatus":{ + "type":"structure", + "required":[ + "AccountId", + "ConfigRuleName", + "MemberAccountRuleStatus" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of a member account.

" + }, + "ConfigRuleName":{ + "shape":"StringWithCharLimit64", + "documentation":"

The name of config rule deployed in the member account.

" + }, + "MemberAccountRuleStatus":{ + "shape":"MemberAccountRuleStatus", + "documentation":"

Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

AWS Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when config rule has been created in the member account.

  • CREATE_IN_PROGRESS when config rule is being created in the member account.

  • CREATE_FAILED when config rule creation has failed in the member account.

  • DELETE_FAILED when config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when config rule is being updated in the member account.

  • UPDATE_FAILED when config rule deletion has failed in the member account.

" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

An error code that is returned when config rule creation or deletion failed in the member account.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

An error message indicating that config rule account creation or deletion has failed due to an error in the member account.

" + }, + "LastUpdateTime":{ + "shape":"Date", + "documentation":"

The timestamp of the last status update.

" + } + }, + "documentation":"

Organization config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.

" + }, + "MessageType":{ + "type":"string", + "enum":[ + "ConfigurationItemChangeNotification", + "ConfigurationSnapshotDeliveryCompleted", + "ScheduledNotification", + "OversizedConfigurationItemChangeNotification" + ] + }, + "Name":{"type":"string"}, + "NextToken":{"type":"string"}, + "NoAvailableConfigurationRecorderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.

", + "exception":true + }, + "NoAvailableDeliveryChannelException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is no delivery channel available to record configurations.

", + "exception":true + }, + "NoAvailableOrganizationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Organization is no longer available.

", + "exception":true + }, + "NoRunningConfigurationRecorderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is no configuration recorder running.

", + "exception":true + }, + "NoSuchBucketException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon S3 bucket does not exist.

", + "exception":true + }, + "NoSuchConfigRuleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.

", + "exception":true + }, + "NoSuchConfigurationAggregatorException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a configuration aggregator that does not exist.

", + "exception":true + }, + "NoSuchConfigurationRecorderException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a configuration recorder that does not exist.

", + "exception":true + }, + "NoSuchDeliveryChannelException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a delivery channel that does not exist.

", + "exception":true + }, + "NoSuchOrganizationConfigRuleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You specified one or more organization config rules that do not exist.

", + "exception":true + }, + "NoSuchRemediationConfigurationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You specified an AWS Config rule without a remediation configuration.

", + "exception":true + }, + "NoSuchRemediationExceptionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You tried to delete a remediation exception that does not exist.

", + "exception":true + }, + "NoSuchRetentionConfigurationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a retention configuration that does not exist.

", + "exception":true + }, + "OrderingTimestamp":{"type":"timestamp"}, + "OrganizationAccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

For PutConfigAggregator API, no permission to call EnableAWSServiceAccess API.

For all OrganizationConfigRule APIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.

", + "exception":true + }, + "OrganizationAggregationSource":{ + "type":"structure", + "required":["RoleArn"], + "members":{ + "RoleArn":{ + "shape":"String", + "documentation":"

ARN of the IAM role used to retrieve AWS Organization details associated with the aggregator account.

" + }, + "AwsRegions":{ + "shape":"AggregatorRegionList", + "documentation":"

The source regions being aggregated.

" + }, + "AllAwsRegions":{ + "shape":"Boolean", + "documentation":"

If true, aggregate existing AWS Config regions and future regions.

" + } + }, + "documentation":"

This object contains regions to set up the aggregator and an IAM role to retrieve organization details.

" + }, + "OrganizationAllFeaturesNotEnabledException":{ + "type":"structure", + "members":{ + }, + "documentation":"

AWS Config resource cannot be created because your organization does not have all features enabled.

", + "exception":true + }, + "OrganizationConfigRule":{ + "type":"structure", + "required":[ + "OrganizationConfigRuleName", + "OrganizationConfigRuleArn" + ], + "members":{ + "OrganizationConfigRuleName":{ + "shape":"OrganizationConfigRuleName", + "documentation":"

The name that you assign to organization config rule.

" + }, + "OrganizationConfigRuleArn":{ + "shape":"StringWithCharLimit256", + "documentation":"

The Amazon Resource Name (ARN) of organization config rule.

" + }, + "OrganizationManagedRuleMetadata":{ + "shape":"OrganizationManagedRuleMetadata", + "documentation":"

An OrganizationManagedRuleMetadata object.

" + }, + "OrganizationCustomRuleMetadata":{ + "shape":"OrganizationCustomRuleMetadata", + "documentation":"

An OrganizationCustomRuleMetadata object.

" + }, + "ExcludedAccounts":{ + "shape":"ExcludedAccounts", + "documentation":"

A comma-separated list of accounts excluded from organization config rule.

" + }, + "LastUpdateTime":{ + "shape":"Date", + "documentation":"

The timestamp of the last update.

" + } + }, + "documentation":"

An organization config rule that has information about config rules that AWS Config creates in member accounts.

" + }, + "OrganizationConfigRuleDetailedStatus":{ + "type":"list", + "member":{"shape":"MemberAccountStatus"} + }, + "OrganizationConfigRuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*\\S.*" + }, + "OrganizationConfigRuleNames":{ + "type":"list", + "member":{"shape":"StringWithCharLimit64"}, + "max":25, + "min":0 + }, + "OrganizationConfigRuleStatus":{ + "type":"structure", + "required":[ + "OrganizationConfigRuleName", + "OrganizationRuleStatus" + ], + "members":{ + "OrganizationConfigRuleName":{ + "shape":"OrganizationConfigRuleName", + "documentation":"

The name that you assign to organization config rule.

" + }, + "OrganizationRuleStatus":{ + "shape":"OrganizationRuleStatus", + "documentation":"

Indicates deployment status of an organization config rule. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in all the member accounts. Additionally, config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

AWS Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when an organization config rule has been successfully created in all the member accounts.

  • CREATE_IN_PROGRESS when an organization config rule creation is in progress.

  • CREATE_FAILED when an organization config rule creation failed in one or more member accounts within that organization.

  • DELETE_FAILED when an organization config rule deletion failed in one or more member accounts within that organization.

  • DELETE_IN_PROGRESS when an organization config rule deletion is in progress.

  • DELETE_SUCCESSFUL when an organization config rule has been successfully deleted from all the member accounts.

  • UPDATE_SUCCESSFUL when an organization config rule has been successfully updated in all the member accounts.

  • UPDATE_IN_PROGRESS when an organization config rule update is in progress.

  • UPDATE_FAILED when an organization config rule update failed in one or more member accounts within that organization.

" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

An error code that is returned when organization config rule creation or deletion has failed.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

An error message indicating that organization config rule creation or deletion failed due to an error.

" + }, + "LastUpdateTime":{ + "shape":"Date", + "documentation":"

The timestamp of the last update.

" + } + }, + "documentation":"

Returns the status for an organization config rule in an organization.

" + }, + "OrganizationConfigRuleStatuses":{ + "type":"list", + "member":{"shape":"OrganizationConfigRuleStatus"} + }, + "OrganizationConfigRuleTriggerType":{ + "type":"string", + "enum":[ + "ConfigurationItemChangeNotification", + "OversizedConfigurationItemChangeNotification", + "ScheduledNotification" + ] + }, + "OrganizationConfigRuleTriggerTypes":{ + "type":"list", + "member":{"shape":"OrganizationConfigRuleTriggerType"} + }, + "OrganizationConfigRules":{ + "type":"list", + "member":{"shape":"OrganizationConfigRule"} + }, + "OrganizationCustomRuleMetadata":{ + "type":"structure", + "required":[ + "LambdaFunctionArn", + "OrganizationConfigRuleTriggerTypes" + ], + "members":{ + "Description":{ + "shape":"StringWithCharLimit256Min0", + "documentation":"

The description that you provide for organization config rule.

" + }, + "LambdaFunctionArn":{ + "shape":"StringWithCharLimit256", + "documentation":"

The lambda function ARN.

" + }, + "OrganizationConfigRuleTriggerTypes":{ + "shape":"OrganizationConfigRuleTriggerTypes", + "documentation":"

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

" + }, + "InputParameters":{ + "shape":"StringWithCharLimit2048", + "documentation":"

A string, in JSON format, that is passed to organization config rule Lambda function.

" + }, + "MaximumExecutionFrequency":{ + "shape":"MaximumExecutionFrequency", + "documentation":"

The maximum frequency with which AWS Config runs evaluations for a rule. Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

" + }, + "ResourceTypesScope":{ + "shape":"ResourceTypesScope", + "documentation":"

The type of the AWS resource that was evaluated.

" + }, + "ResourceIdScope":{ + "shape":"StringWithCharLimit768", + "documentation":"

The ID of the AWS resource that was evaluated.

" + }, + "TagKeyScope":{ + "shape":"StringWithCharLimit128", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "TagValueScope":{ + "shape":"StringWithCharLimit256", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

An object that specifies organization custom rule metadata such as resource type, resource ID of AWS resource, Lamdba function ARN, and organization trigger types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.

" + }, + "OrganizationManagedRuleMetadata":{ + "type":"structure", + "required":["RuleIdentifier"], + "members":{ + "Description":{ + "shape":"StringWithCharLimit256Min0", + "documentation":"

The description that you provide for organization config rule.

" + }, + "RuleIdentifier":{ + "shape":"StringWithCharLimit256", + "documentation":"

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules.

" + }, + "InputParameters":{ + "shape":"StringWithCharLimit2048", + "documentation":"

A string, in JSON format, that is passed to organization config rule Lambda function.

" + }, + "MaximumExecutionFrequency":{ + "shape":"MaximumExecutionFrequency", + "documentation":"

The maximum frequency with which AWS Config runs evaluations for a rule. You are using an AWS managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

" + }, + "ResourceTypesScope":{ + "shape":"ResourceTypesScope", + "documentation":"

The type of the AWS resource that was evaluated.

" + }, + "ResourceIdScope":{ + "shape":"StringWithCharLimit768", + "documentation":"

The ID of the AWS resource that was evaluated.

" + }, + "TagKeyScope":{ + "shape":"StringWithCharLimit128", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "TagValueScope":{ + "shape":"StringWithCharLimit256", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

An object that specifies organization managed rule metadata such as resource type and ID of AWS resource along with the rule identifier. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic.

" + }, + "OrganizationRuleStatus":{ + "type":"string", + "enum":[ + "CREATE_SUCCESSFUL", + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "UPDATE_SUCCESSFUL", + "UPDATE_FAILED", + "UPDATE_IN_PROGRESS", + "DELETE_SUCCESSFUL", + "DELETE_FAILED", + "DELETE_IN_PROGRESS" + ] + }, + "OversizedConfigurationItemException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The configuration item size is outside the allowable range.

", + "exception":true + }, + "Owner":{ + "type":"string", + "enum":[ + "CUSTOM_LAMBDA", + "AWS" + ] + }, + "PendingAggregationRequest":{ + "type":"structure", + "members":{ + "RequesterAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the account requesting to aggregate data.

" + }, + "RequesterAwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region requesting to aggregate data.

" + } + }, + "documentation":"

An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.

" + }, + "PendingAggregationRequestList":{ + "type":"list", + "member":{"shape":"PendingAggregationRequest"} + }, + "Percentage":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "PutAggregationAuthorizationRequest":{ + "type":"structure", + "required":[ + "AuthorizedAccountId", + "AuthorizedAwsRegion" + ], + "members":{ + "AuthorizedAccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the account authorized to aggregate data.

" + }, + "AuthorizedAwsRegion":{ + "shape":"AwsRegion", + "documentation":"

The region authorized to collect aggregated data.

" + }, + "Tags":{ + "shape":"TagsList", + "documentation":"

An array of tag object.

" + } + } + }, + "PutAggregationAuthorizationResponse":{ + "type":"structure", + "members":{ + "AggregationAuthorization":{ + "shape":"AggregationAuthorization", + "documentation":"

Returns an AggregationAuthorization object.

" + } + } + }, + "PutConfigRuleRequest":{ + "type":"structure", + "required":["ConfigRule"], + "members":{ + "ConfigRule":{ + "shape":"ConfigRule", + "documentation":"

The rule that you want to add to your account.

" + }, + "Tags":{ + "shape":"TagsList", + "documentation":"

An array of tag object.

" + } + } + }, + "PutConfigurationAggregatorRequest":{ + "type":"structure", + "required":["ConfigurationAggregatorName"], + "members":{ + "ConfigurationAggregatorName":{ + "shape":"ConfigurationAggregatorName", + "documentation":"

The name of the configuration aggregator.

" + }, + "AccountAggregationSources":{ + "shape":"AccountAggregationSourceList", + "documentation":"

A list of AccountAggregationSource object.

" + }, + "OrganizationAggregationSource":{ + "shape":"OrganizationAggregationSource", + "documentation":"

An OrganizationAggregationSource object.

" + }, + "Tags":{ + "shape":"TagsList", + "documentation":"

An array of tag object.

" + } + } + }, + "PutConfigurationAggregatorResponse":{ + "type":"structure", + "members":{ + "ConfigurationAggregator":{ + "shape":"ConfigurationAggregator", + "documentation":"

Returns a ConfigurationAggregator object.

" + } + } + }, + "PutConfigurationRecorderRequest":{ + "type":"structure", + "required":["ConfigurationRecorder"], + "members":{ + "ConfigurationRecorder":{ + "shape":"ConfigurationRecorder", + "documentation":"

The configuration recorder object that records each configuration change made to the resources.

" + } + }, + "documentation":"

The input for the PutConfigurationRecorder action.

" + }, + "PutDeliveryChannelRequest":{ + "type":"structure", + "required":["DeliveryChannel"], + "members":{ + "DeliveryChannel":{ + "shape":"DeliveryChannel", + "documentation":"

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

" + } + }, + "documentation":"

The input for the PutDeliveryChannel action.

" + }, + "PutEvaluationsRequest":{ + "type":"structure", + "required":["ResultToken"], + "members":{ + "Evaluations":{ + "shape":"Evaluations", + "documentation":"

The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.

" + }, + "ResultToken":{ + "shape":"String", + "documentation":"

An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation.

" + }, + "TestMode":{ + "shape":"Boolean", + "documentation":"

Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

" + } + }, + "documentation":"

" + }, + "PutEvaluationsResponse":{ + "type":"structure", + "members":{ + "FailedEvaluations":{ + "shape":"Evaluations", + "documentation":"

Requests that failed because of a client or server error.

" + } + }, + "documentation":"

" + }, + "PutOrganizationConfigRuleRequest":{ + "type":"structure", + "required":["OrganizationConfigRuleName"], + "members":{ + "OrganizationConfigRuleName":{ + "shape":"OrganizationConfigRuleName", + "documentation":"

The name that you assign to an organization config rule.

" + }, + "OrganizationManagedRuleMetadata":{ + "shape":"OrganizationManagedRuleMetadata", + "documentation":"

An OrganizationManagedRuleMetadata object.

" + }, + "OrganizationCustomRuleMetadata":{ + "shape":"OrganizationCustomRuleMetadata", + "documentation":"

An OrganizationCustomRuleMetadata object.

" + }, + "ExcludedAccounts":{ + "shape":"ExcludedAccounts", + "documentation":"

A comma-separated list of accounts that you want to exclude from an organization config rule.

" + } + } + }, + "PutOrganizationConfigRuleResponse":{ + "type":"structure", + "members":{ + "OrganizationConfigRuleArn":{ + "shape":"StringWithCharLimit256", + "documentation":"

The Amazon Resource Name (ARN) of an organization config rule.

" + } + } + }, + "PutRemediationConfigurationsRequest":{ + "type":"structure", + "required":["RemediationConfigurations"], + "members":{ + "RemediationConfigurations":{ + "shape":"RemediationConfigurations", + "documentation":"

A list of remediation configuration objects.

" + } + } + }, + "PutRemediationConfigurationsResponse":{ + "type":"structure", + "members":{ + "FailedBatches":{ + "shape":"FailedRemediationBatches", + "documentation":"

Returns a list of failed remediation batch objects.

" + } + } + }, + "PutRemediationExceptionsRequest":{ + "type":"structure", + "required":[ + "ConfigRuleName", + "ResourceKeys" + ], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule for which you want to create remediation exception.

" + }, + "ResourceKeys":{ + "shape":"RemediationExceptionResourceKeys", + "documentation":"

An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

" + }, + "Message":{ + "shape":"StringWithCharLimit1024", + "documentation":"

The message contains an explanation of the exception.

" + }, + "ExpirationTime":{ + "shape":"Date", + "documentation":"

The exception is automatically deleted after the expiration date.

" + } + } + }, + "PutRemediationExceptionsResponse":{ + "type":"structure", + "members":{ + "FailedBatches":{ + "shape":"FailedRemediationExceptionBatches", + "documentation":"

Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

" + } + } + }, + "PutRetentionConfigurationRequest":{ + "type":"structure", + "required":["RetentionPeriodInDays"], + "members":{ + "RetentionPeriodInDays":{ + "shape":"RetentionPeriodInDays", + "documentation":"

Number of days AWS Config stores your historical information.

Currently, only applicable to the configuration item history.

" + } + } + }, + "PutRetentionConfigurationResponse":{ + "type":"structure", + "members":{ + "RetentionConfiguration":{ + "shape":"RetentionConfiguration", + "documentation":"

Returns a retention configuration object.

" + } + } + }, + "QueryInfo":{ + "type":"structure", + "members":{ + "SelectFields":{ + "shape":"FieldInfoList", + "documentation":"

Returns a FieldInfo object.

" + } + }, + "documentation":"

Details about the query.

" + }, + "RecorderName":{ + "type":"string", + "max":256, + "min":1 + }, + "RecorderStatus":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failure" + ] + }, + "RecordingGroup":{ + "type":"structure", + "members":{ + "allSupported":{ + "shape":"AllSupported", + "documentation":"

Specifies whether AWS Config records configuration changes for every supported type of regional resource.

If you set this option to true, when AWS Config adds support for a new type of regional resource, it starts recording resources of that type automatically.

If you set this option to true, you cannot enumerate a list of resourceTypes.

" + }, + "includeGlobalResourceTypes":{ + "shape":"IncludeGlobalResourceTypes", + "documentation":"

Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

Before you can set this option to true, you must set the allSupported option to true.

If you set this option to true, when AWS Config adds support for a new type of global resource, it starts recording resources of that type automatically.

The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.

" + }, + "resourceTypes":{ + "shape":"ResourceTypeList", + "documentation":"

A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

Before you can set this option to true, you must set the allSupported option to false.

If you set this option to true, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

For a list of valid resourceTypes values, see the resourceType Value column in Supported AWS Resource Types.

" + } + }, + "documentation":"

Specifies the types of AWS resource for which AWS Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.

You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter.

For a list of supported resource types, see Supported Resource Types.

For more information, see Selecting Which Resources AWS Config Records.

" + }, + "ReevaluateConfigRuleNames":{ + "type":"list", + "member":{"shape":"StringWithCharLimit64"}, + "max":25, + "min":1 + }, + "RelatedEvent":{"type":"string"}, + "RelatedEventList":{ + "type":"list", + "member":{"shape":"RelatedEvent"} + }, + "Relationship":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type of the related resource.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the related resource (for example, sg-xxxxxx).

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

The custom name of the related resource, if available.

" + }, + "relationshipName":{ + "shape":"RelationshipName", + "documentation":"

The type of relationship with the related resource.

" + } + }, + "documentation":"

The relationship of the related resource to the main resource.

" + }, + "RelationshipList":{ + "type":"list", + "member":{"shape":"Relationship"} + }, + "RelationshipName":{"type":"string"}, + "RemediationConfiguration":{ + "type":"structure", + "required":[ + "ConfigRuleName", + "TargetType", + "TargetId" + ], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule.

" + }, + "TargetType":{ + "shape":"RemediationTargetType", + "documentation":"

The type of the target. Target executes remediation. For example, SSM document.

" + }, + "TargetId":{ + "shape":"StringWithCharLimit256", + "documentation":"

Target ID is the name of the public document.

" + }, + "TargetVersion":{ + "shape":"String", + "documentation":"

Version of the target. For example, version of the SSM document.

" + }, + "Parameters":{ + "shape":"RemediationParameters", + "documentation":"

An object of the RemediationParameterValue.

" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The type of a resource.

" + }, + "Automatic":{ + "shape":"Boolean", + "documentation":"

The remediation is triggered automatically.

" + }, + "ExecutionControls":{ + "shape":"ExecutionControls", + "documentation":"

An ExecutionControls object.

" + }, + "MaximumAutomaticAttempts":{ + "shape":"AutoRemediationAttempts", + "documentation":"

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptsSeconds as 50 seconds, AWS Config throws an exception after the 5th failed attempt within 50 seconds.

" + }, + "RetryAttemptSeconds":{ + "shape":"AutoRemediationAttemptSeconds", + "documentation":"

Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptsSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

" + }, + "Arn":{ + "shape":"StringWithCharLimit1024", + "documentation":"

Amazon Resource Name (ARN) of remediation configuration.

" + }, + "CreatedByService":{ + "shape":"StringWithCharLimit1024", + "documentation":"

Name of the service that owns the service linked rule, if applicable.

" + } + }, + "documentation":"

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

" + }, + "RemediationConfigurations":{ + "type":"list", + "member":{"shape":"RemediationConfiguration"}, + "max":25, + "min":0 + }, + "RemediationException":{ + "type":"structure", + "required":[ + "ConfigRuleName", + "ResourceType", + "ResourceId" + ], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The name of the AWS Config rule.

" + }, + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of a resource.

" + }, + "ResourceId":{ + "shape":"StringWithCharLimit1024", + "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" + }, + "Message":{ + "shape":"StringWithCharLimit1024", + "documentation":"

An explanation of an remediation exception.

" + }, + "ExpirationTime":{ + "shape":"Date", + "documentation":"

The time when the remediation exception will be deleted.

" + } + }, + "documentation":"

An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

" + }, + "RemediationExceptionResourceKey":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"StringWithCharLimit256", + "documentation":"

The type of a resource.

" + }, + "ResourceId":{ + "shape":"StringWithCharLimit1024", + "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" + } + }, + "documentation":"

The details that identify a resource within AWS Config, including the resource type and resource ID.

" + }, + "RemediationExceptionResourceKeys":{ + "type":"list", + "member":{"shape":"RemediationExceptionResourceKey"}, + "max":100, + "min":1 + }, + "RemediationExceptions":{ + "type":"list", + "member":{"shape":"RemediationException"}, + "max":25, + "min":0 + }, + "RemediationExecutionState":{ + "type":"string", + "enum":[ + "QUEUED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "RemediationExecutionStatus":{ + "type":"structure", + "members":{ + "ResourceKey":{"shape":"ResourceKey"}, + "State":{ + "shape":"RemediationExecutionState", + "documentation":"

ENUM of the values.

" + }, + "StepDetails":{ + "shape":"RemediationExecutionSteps", + "documentation":"

Details of every step.

" + }, + "InvocationTime":{ + "shape":"Date", + "documentation":"

Start time when the remediation was executed.

" + }, + "LastUpdatedTime":{ + "shape":"Date", + "documentation":"

The time when the remediation execution was last updated.

" + } + }, + "documentation":"

Provides details of the current status of the invoked remediation action for that resource.

" + }, + "RemediationExecutionStatuses":{ + "type":"list", + "member":{"shape":"RemediationExecutionStatus"} + }, + "RemediationExecutionStep":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The details of the step.

" + }, + "State":{ + "shape":"RemediationExecutionStepState", + "documentation":"

The valid status of the step.

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

An error message if the step was interrupted during execution.

" + }, + "StartTime":{ + "shape":"Date", + "documentation":"

The time when the step started.

" + }, + "StopTime":{ + "shape":"Date", + "documentation":"

The time when the step stopped.

" + } + }, + "documentation":"

Name of the step from the SSM document.

" + }, + "RemediationExecutionStepState":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "PENDING", + "FAILED" + ] + }, + "RemediationExecutionSteps":{ + "type":"list", + "member":{"shape":"RemediationExecutionStep"} + }, + "RemediationInProgressException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Remediation action is in progress. You can either cancel execution in AWS Systems Manager or wait and try again later.

", + "exception":true + }, + "RemediationParameterValue":{ + "type":"structure", + "members":{ + "ResourceValue":{ + "shape":"ResourceValue", + "documentation":"

The value is dynamic and changes at run-time.

" + }, + "StaticValue":{ + "shape":"StaticValue", + "documentation":"

The value is static and does not change at run-time.

" + } + }, + "documentation":"

The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.

" + }, + "RemediationParameters":{ + "type":"map", + "key":{"shape":"StringWithCharLimit256"}, + "value":{"shape":"RemediationParameterValue"}, + "max":25, + "min":0 + }, + "RemediationTargetType":{ + "type":"string", + "enum":["SSM_DOCUMENT"] + }, + "ResourceCount":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type (for example, \"AWS::EC2::Instance\").

" + }, + "count":{ + "shape":"Long", + "documentation":"

The number of resources.

" + } + }, + "documentation":"

An object that contains the resource type and the number of resources.

" + }, + "ResourceCountFilters":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of the AWS resource.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit ID of the account.

" + }, + "Region":{ + "shape":"AwsRegion", + "documentation":"

The region where the account is located.

" + } + }, + "documentation":"

Filters the resource count based on account ID, region, and resource type.

" + }, + "ResourceCountGroupKey":{ + "type":"string", + "enum":[ + "RESOURCE_TYPE", + "ACCOUNT_ID", + "AWS_REGION" + ] + }, + "ResourceCounts":{ + "type":"list", + "member":{"shape":"ResourceCount"} + }, + "ResourceCreationTime":{"type":"timestamp"}, + "ResourceDeletionTime":{"type":"timestamp"}, + "ResourceFilters":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit source account ID.

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

The ID of the resource.

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

The name of the resource.

" + }, + "Region":{ + "shape":"AwsRegion", + "documentation":"

The source region.

" + } + }, + "documentation":"

Filters the results by resource account ID, region, resource ID, and resource name.

" + }, + "ResourceId":{ + "type":"string", + "max":768, + "min":1 + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"ResourceId"} + }, + "ResourceIdentifier":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the resource (for example, sg-xxxxxx).

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

The custom name of the resource (if available).

" + }, + "resourceDeletionTime":{ + "shape":"ResourceDeletionTime", + "documentation":"

The time that the resource was deleted.

" + } + }, + "documentation":"

The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.

" + }, + "ResourceIdentifierList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"} + }, + "ResourceIdentifiersList":{ + "type":"list", + "member":{"shape":"AggregateResourceIdentifier"}, + "max":100, + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You see this exception in the following cases:

  • For DeleteConfigRule API, AWS Config is deleting this rule. Try your request again later.

  • For DeleteConfigRule API, the rule is deleting your evaluation results. Try your request again later.

  • For DeleteConfigRule API, a remediation action is associated with the rule and AWS Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.

  • For PutConfigOrganizationRule, organization config rule deletion is in progress. Try your request again later.

  • For DeleteOrganizationConfigRule, organization config rule creation is in progress. Try your request again later.

", + "exception":true + }, + "ResourceKey":{ + "type":"structure", + "required":[ + "resourceType", + "resourceId" + ], + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

" + }, + "resourceId":{ + "shape":"ResourceId", + "documentation":"

The ID of the resource (for example., sg-xxxxxx).

" + } + }, + "documentation":"

The details that identify a resource within AWS Config, including the resource type and resource ID.

" + }, + "ResourceKeys":{ + "type":"list", + "member":{"shape":"ResourceKey"}, + "max":100, + "min":1 + }, + "ResourceName":{"type":"string"}, + "ResourceNotDiscoveredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a resource that is either unknown or has not been discovered.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have specified a resource that does not exist.

", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "AWS::EC2::CustomerGateway", + "AWS::EC2::EIP", + "AWS::EC2::Host", + "AWS::EC2::Instance", + "AWS::EC2::InternetGateway", + "AWS::EC2::NetworkAcl", + "AWS::EC2::NetworkInterface", + "AWS::EC2::RouteTable", + "AWS::EC2::SecurityGroup", + "AWS::EC2::Subnet", + "AWS::CloudTrail::Trail", + "AWS::EC2::Volume", + "AWS::EC2::VPC", + "AWS::EC2::VPNConnection", + "AWS::EC2::VPNGateway", + "AWS::EC2::RegisteredHAInstance", + "AWS::EC2::NatGateway", + "AWS::EC2::EgressOnlyInternetGateway", + "AWS::EC2::VPCEndpoint", + "AWS::EC2::VPCEndpointService", + "AWS::EC2::FlowLog", + "AWS::EC2::VPCPeeringConnection", + "AWS::IAM::Group", + "AWS::IAM::Policy", + "AWS::IAM::Role", + "AWS::IAM::User", + "AWS::ElasticLoadBalancingV2::LoadBalancer", + "AWS::ACM::Certificate", + "AWS::RDS::DBInstance", + "AWS::RDS::DBParameterGroup", + "AWS::RDS::DBOptionGroup", + "AWS::RDS::DBSubnetGroup", + "AWS::RDS::DBSecurityGroup", + "AWS::RDS::DBSnapshot", + "AWS::RDS::DBCluster", + "AWS::RDS::DBClusterParameterGroup", + "AWS::RDS::DBClusterSnapshot", + "AWS::RDS::EventSubscription", + "AWS::S3::Bucket", + "AWS::S3::AccountPublicAccessBlock", + "AWS::Redshift::Cluster", + "AWS::Redshift::ClusterSnapshot", + "AWS::Redshift::ClusterParameterGroup", + "AWS::Redshift::ClusterSecurityGroup", + "AWS::Redshift::ClusterSubnetGroup", + "AWS::Redshift::EventSubscription", + "AWS::SSM::ManagedInstanceInventory", + "AWS::CloudWatch::Alarm", + "AWS::CloudFormation::Stack", + "AWS::ElasticLoadBalancing::LoadBalancer", + "AWS::AutoScaling::AutoScalingGroup", + "AWS::AutoScaling::LaunchConfiguration", + "AWS::AutoScaling::ScalingPolicy", + "AWS::AutoScaling::ScheduledAction", + "AWS::DynamoDB::Table", + "AWS::CodeBuild::Project", + "AWS::WAF::RateBasedRule", + "AWS::WAF::Rule", + "AWS::WAF::RuleGroup", + "AWS::WAF::WebACL", + "AWS::WAFRegional::RateBasedRule", + "AWS::WAFRegional::Rule", + "AWS::WAFRegional::RuleGroup", + "AWS::WAFRegional::WebACL", + "AWS::CloudFront::Distribution", + "AWS::CloudFront::StreamingDistribution", + "AWS::Lambda::Alias", + "AWS::Lambda::Function", + "AWS::ElasticBeanstalk::Application", + "AWS::ElasticBeanstalk::ApplicationVersion", + "AWS::ElasticBeanstalk::Environment", + "AWS::MobileHub::Project", + "AWS::XRay::EncryptionConfig", + "AWS::SSM::AssociationCompliance", + "AWS::SSM::PatchCompliance", + "AWS::Shield::Protection", + "AWS::ShieldRegional::Protection", + "AWS::Config::ResourceCompliance", + "AWS::LicenseManager::LicenseConfiguration", + "AWS::ApiGateway::DomainName", + "AWS::ApiGateway::Method", + "AWS::ApiGateway::Stage", + "AWS::ApiGateway::RestApi", + "AWS::ApiGatewayV2::DomainName", + "AWS::ApiGatewayV2::Stage", + "AWS::ApiGatewayV2::Api", + "AWS::CodePipeline::Pipeline", + "AWS::ServiceCatalog::CloudFormationProvisionedProduct", + "AWS::ServiceCatalog::CloudFormationProduct", + "AWS::ServiceCatalog::Portfolio" + ] + }, + "ResourceTypeList":{ + "type":"list", + "member":{"shape":"ResourceType"} + }, + "ResourceTypes":{ + "type":"list", + "member":{"shape":"StringWithCharLimit256"}, + "max":20, + "min":0 + }, + "ResourceTypesScope":{ + "type":"list", + "member":{"shape":"StringWithCharLimit256"}, + "max":100, + "min":0 + }, + "ResourceValue":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{ + "shape":"ResourceValueType", + "documentation":"

The value is a resource ID.

" + } + }, + "documentation":"

The dynamic value of the resource.

" + }, + "ResourceValueType":{ + "type":"string", + "enum":["RESOURCE_ID"] + }, + "Results":{ + "type":"list", + "member":{"shape":"String"} + }, + "RetentionConfiguration":{ + "type":"structure", + "required":[ + "Name", + "RetentionPeriodInDays" + ], + "members":{ + "Name":{ + "shape":"RetentionConfigurationName", + "documentation":"

The name of the retention configuration object.

" + }, + "RetentionPeriodInDays":{ + "shape":"RetentionPeriodInDays", + "documentation":"

Number of days AWS Config stores your historical information.

Currently, only applicable to the configuration item history.

" + } + }, + "documentation":"

An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in AWS Config.

" + }, + "RetentionConfigurationList":{ + "type":"list", + "member":{"shape":"RetentionConfiguration"} + }, + "RetentionConfigurationName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w\\-]+" + }, + "RetentionConfigurationNameList":{ + "type":"list", + "member":{"shape":"RetentionConfigurationName"}, + "max":1, + "min":0 + }, + "RetentionPeriodInDays":{ + "type":"integer", + "max":2557, + "min":30 + }, + "RuleLimit":{ + "type":"integer", + "max":50, + "min":0 + }, + "Scope":{ + "type":"structure", + "members":{ + "ComplianceResourceTypes":{ + "shape":"ComplianceResourceTypes", + "documentation":"

The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

" + }, + "TagKey":{ + "shape":"StringWithCharLimit128", + "documentation":"

The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.

" + }, + "TagValue":{ + "shape":"StringWithCharLimit256", + "documentation":"

The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

" + }, + "ComplianceResourceId":{ + "shape":"BaseResourceId", + "documentation":"

The ID of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

" + } + }, + "documentation":"

Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

" + }, + "SelectResourceConfigRequest":{ + "type":"structure", + "required":["Expression"], + "members":{ + "Expression":{ + "shape":"Expression", + "documentation":"

The SQL query SELECT command.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of query results returned on each page.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } + } + }, + "SelectResourceConfigResponse":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"Results", + "documentation":"

Returns the results for the SQL query.

" + }, + "QueryInfo":{ + "shape":"QueryInfo", + "documentation":"

Returns the QueryInfo object.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

" + } + } + }, + "Source":{ + "type":"structure", + "required":[ + "Owner", + "SourceIdentifier" + ], + "members":{ + "Owner":{ + "shape":"Owner", + "documentation":"

Indicates whether AWS or the customer owns and manages the AWS Config rule.

" + }, + "SourceIdentifier":{ + "shape":"StringWithCharLimit256", + "documentation":"

For AWS Config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using AWS Managed Config Rules.

For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

" + }, + "SourceDetails":{ + "shape":"SourceDetails", + "documentation":"

Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.

" + } + }, + "documentation":"

Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.

" + }, + "SourceDetail":{ + "type":"structure", + "members":{ + "EventSource":{ + "shape":"EventSource", + "documentation":"

The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.

" + }, + "MessageType":{ + "shape":"MessageType", + "documentation":"

The type of notification that triggers AWS Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers a configuration item as a result of a resource change.

  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when AWS Config delivers an oversized configuration item. AWS Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

  • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

" + }, + "MaximumExecutionFrequency":{ + "shape":"MaximumExecutionFrequency", + "documentation":"

The frequency at which you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, AWS Config runs evaluations once for each valid value. For example, if you choose Three_Hours, AWS Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

" + } + }, + "documentation":"

Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.

" + }, + "SourceDetails":{ + "type":"list", + "member":{"shape":"SourceDetail"}, + "max":25, + "min":0 + }, + "SsmControls":{ + "type":"structure", + "members":{ + "ConcurrentExecutionRatePercentage":{ + "shape":"Percentage", + "documentation":"

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

" + }, + "ErrorPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

" + } + }, + "documentation":"

AWS Systems Manager (SSM) specific remediation controls.

" + }, + "StartConfigRulesEvaluationRequest":{ + "type":"structure", + "members":{ + "ConfigRuleNames":{ + "shape":"ReevaluateConfigRuleNames", + "documentation":"

The list of names of AWS Config rules that you want to run evaluations for.

" + } + }, + "documentation":"

" + }, + "StartConfigRulesEvaluationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output when you start the evaluation for the specified AWS Config rule.

" + }, + "StartConfigurationRecorderRequest":{ + "type":"structure", + "required":["ConfigurationRecorderName"], + "members":{ + "ConfigurationRecorderName":{ + "shape":"RecorderName", + "documentation":"

The name of the recorder object that records each configuration change made to the resources.

" + } + }, + "documentation":"

The input for the StartConfigurationRecorder action.

" + }, + "StartRemediationExecutionRequest":{ + "type":"structure", + "required":[ + "ConfigRuleName", + "ResourceKeys" + ], + "members":{ + "ConfigRuleName":{ + "shape":"ConfigRuleName", + "documentation":"

The list of names of AWS Config rules that you want to run remediation execution for.

" + }, + "ResourceKeys":{ + "shape":"ResourceKeys", + "documentation":"

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

" + } + } + }, + "StartRemediationExecutionResponse":{ + "type":"structure", + "members":{ + "FailureMessage":{ + "shape":"String", + "documentation":"

Returns a failure message. For example, the resource is already compliant.

" + }, + "FailedItems":{ + "shape":"ResourceKeys", + "documentation":"

For resources that have failed to start execution, the API returns a resource key object.

" + } + } + }, + "StaticParameterValues":{ + "type":"list", + "member":{"shape":"StringWithCharLimit256"}, + "max":25, + "min":0 + }, + "StaticValue":{ + "type":"structure", + "required":["Values"], + "members":{ + "Values":{ + "shape":"StaticParameterValues", + "documentation":"

A list of values. For example, the ARN of the assumed role.

" + } + }, + "documentation":"

The static value of the resource.

" + }, + "StatusDetailFilters":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The 12-digit account ID of the member account within an organization.

" + }, + "MemberAccountRuleStatus":{ + "shape":"MemberAccountRuleStatus", + "documentation":"

Indicates deployment status for config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

AWS Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when config rule has been created in the member account.

  • CREATE_IN_PROGRESS when config rule is being created in the member account.

  • CREATE_FAILED when config rule creation has failed in the member account.

  • DELETE_FAILED when config rule deletion has failed in the member account.

  • DELETE_IN_PROGRESS when config rule is being deleted in the member account.

  • DELETE_SUCCESSFUL when config rule has been deleted in the member account.

  • UPDATE_SUCCESSFUL when config rule has been updated in the member account.

  • UPDATE_IN_PROGRESS when config rule is being updated in the member account.

  • UPDATE_FAILED when config rule deletion has failed in the member account.

" + } + }, + "documentation":"

Status filter object to filter results based on specific member account ID or status type for an organization config rule.

" + }, + "StopConfigurationRecorderRequest":{ + "type":"structure", + "required":["ConfigurationRecorderName"], + "members":{ + "ConfigurationRecorderName":{ + "shape":"RecorderName", + "documentation":"

The name of the recorder object that records each configuration change made to the resources.

" + } + }, + "documentation":"

The input for the StopConfigurationRecorder action.

" + }, + "String":{"type":"string"}, + "StringWithCharLimit1024":{ + "type":"string", + "max":1024, + "min":1 + }, + "StringWithCharLimit128":{ + "type":"string", + "max":128, + "min":1 + }, + "StringWithCharLimit2048":{ + "type":"string", + "max":2048, + "min":1 + }, + "StringWithCharLimit256":{ + "type":"string", + "max":256, + "min":1 + }, + "StringWithCharLimit256Min0":{ + "type":"string", + "max":256, + "min":0 + }, + "StringWithCharLimit64":{ + "type":"string", + "max":64, + "min":1 + }, + "StringWithCharLimit768":{ + "type":"string", + "max":768, + "min":1 + }, + "SupplementaryConfiguration":{ + "type":"map", + "key":{"shape":"SupplementaryConfigurationName"}, + "value":{"shape":"SupplementaryConfigurationValue"} + }, + "SupplementaryConfigurationName":{"type":"string"}, + "SupplementaryConfigurationValue":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of tag object.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"Value"} + }, + "TagsList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the limit of the number of tags you can use. You have more than 50 tags.

", + "exception":true + }, + "UnprocessedResourceIdentifierList":{ + "type":"list", + "member":{"shape":"AggregateResourceIdentifier"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of the tags to be removed.

" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested action is not valid.

", + "exception":true + }, + "Value":{"type":"string"}, + "Version":{"type":"string"} + }, + "documentation":"AWS Config

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config. This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process. For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config in the AWS Config Developer Guide.

" +} diff --git a/aws/dist/botocore/data/connect/2017-08-08/paginators-1.json b/aws/dist/botocore/data/connect/2017-08-08/paginators-1.json new file mode 100644 index 00000000..2fd913b8 --- /dev/null +++ b/aws/dist/botocore/data/connect/2017-08-08/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "GetMetricData": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MetricResults" + }, + "ListRoutingProfiles": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "RoutingProfileSummaryList" + }, + "ListSecurityProfiles": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecurityProfileSummaryList" + }, + "ListUserHierarchyGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserHierarchyGroupSummaryList" + }, + "ListUsers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UserSummaryList" + }, + "ListContactFlows": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ContactFlowSummaryList" + }, + "ListHoursOfOperations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "HoursOfOperationSummaryList" + }, + "ListPhoneNumbers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PhoneNumberSummaryList" + }, + "ListQueues": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "QueueSummaryList" + } + } +} diff --git a/aws/dist/botocore/data/connect/2017-08-08/service-2.json b/aws/dist/botocore/data/connect/2017-08-08/service-2.json new file mode 100644 index 00000000..fe3d268a --- /dev/null +++ b/aws/dist/botocore/data/connect/2017-08-08/service-2.json @@ -0,0 +1,2514 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-08-08", + "endpointPrefix":"connect", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Amazon Connect", + "serviceFullName":"Amazon Connect Service", + "serviceId":"Connect", + "signatureVersion":"v4", + "signingName":"connect", + "uid":"connect-2017-08-08" + }, + "operations":{ + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"PUT", + "requestUri":"/users/{InstanceId}" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates a user account for the specified Amazon Connect instance.

" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"DELETE", + "requestUri":"/users/{InstanceId}/{UserId}" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes a user account from the specified Amazon Connect instance.

" + }, + "DescribeUser":{ + "name":"DescribeUser", + "http":{ + "method":"GET", + "requestUri":"/users/{InstanceId}/{UserId}" + }, + "input":{"shape":"DescribeUserRequest"}, + "output":{"shape":"DescribeUserResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the specified user account.

" + }, + "DescribeUserHierarchyGroup":{ + "name":"DescribeUserHierarchyGroup", + "http":{ + "method":"GET", + "requestUri":"/user-hierarchy-groups/{InstanceId}/{HierarchyGroupId}" + }, + "input":{"shape":"DescribeUserHierarchyGroupRequest"}, + "output":{"shape":"DescribeUserHierarchyGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the specified hierarchy group.

" + }, + "DescribeUserHierarchyStructure":{ + "name":"DescribeUserHierarchyStructure", + "http":{ + "method":"GET", + "requestUri":"/user-hierarchy-structure/{InstanceId}" + }, + "input":{"shape":"DescribeUserHierarchyStructureRequest"}, + "output":{"shape":"DescribeUserHierarchyStructureResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Describes the hierarchy structure of the specified Amazon Connect instance.

" + }, + "GetContactAttributes":{ + "name":"GetContactAttributes", + "http":{ + "method":"GET", + "requestUri":"/contact/attributes/{InstanceId}/{InitialContactId}" + }, + "input":{"shape":"GetContactAttributesRequest"}, + "output":{"shape":"GetContactAttributesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves the contact attributes for the specified contact.

" + }, + "GetCurrentMetricData":{ + "name":"GetCurrentMetricData", + "http":{ + "method":"POST", + "requestUri":"/metrics/current/{InstanceId}" + }, + "input":{"shape":"GetCurrentMetricDataRequest"}, + "output":{"shape":"GetCurrentMetricDataResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets the real-time metric data from the specified Amazon Connect instance.

For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.

" + }, + "GetFederationToken":{ + "name":"GetFederationToken", + "http":{ + "method":"GET", + "requestUri":"/user/federate/{InstanceId}" + }, + "input":{"shape":"GetFederationTokenRequest"}, + "output":{"shape":"GetFederationTokenResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UserNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"DuplicateResourceException"} + ], + "documentation":"

Retrieves a token for federation.

" + }, + "GetMetricData":{ + "name":"GetMetricData", + "http":{ + "method":"POST", + "requestUri":"/metrics/historical/{InstanceId}" + }, + "input":{"shape":"GetMetricDataRequest"}, + "output":{"shape":"GetMetricDataResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets historical metric data from the specified Amazon Connect instance.

For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.

" + }, + "ListContactFlows":{ + "name":"ListContactFlows", + "http":{ + "method":"GET", + "requestUri":"/contact-flows-summary/{InstanceId}" + }, + "input":{"shape":"ListContactFlowsRequest"}, + "output":{"shape":"ListContactFlowsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides information about the contact flows for the specified Amazon Connect instance.

" + }, + "ListHoursOfOperations":{ + "name":"ListHoursOfOperations", + "http":{ + "method":"GET", + "requestUri":"/hours-of-operations-summary/{InstanceId}" + }, + "input":{"shape":"ListHoursOfOperationsRequest"}, + "output":{"shape":"ListHoursOfOperationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides information about the hours of operation for the specified Amazon Connect instance.

" + }, + "ListPhoneNumbers":{ + "name":"ListPhoneNumbers", + "http":{ + "method":"GET", + "requestUri":"/phone-numbers-summary/{InstanceId}" + }, + "input":{"shape":"ListPhoneNumbersRequest"}, + "output":{"shape":"ListPhoneNumbersResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides information about the phone numbers for the specified Amazon Connect instance.

" + }, + "ListQueues":{ + "name":"ListQueues", + "http":{ + "method":"GET", + "requestUri":"/queues-summary/{InstanceId}" + }, + "input":{"shape":"ListQueuesRequest"}, + "output":{"shape":"ListQueuesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides information about the queues for the specified Amazon Connect instance.

" + }, + "ListRoutingProfiles":{ + "name":"ListRoutingProfiles", + "http":{ + "method":"GET", + "requestUri":"/routing-profiles-summary/{InstanceId}" + }, + "input":{"shape":"ListRoutingProfilesRequest"}, + "output":{"shape":"ListRoutingProfilesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides summary information about the routing profiles for the specified Amazon Connect instance.

" + }, + "ListSecurityProfiles":{ + "name":"ListSecurityProfiles", + "http":{ + "method":"GET", + "requestUri":"/security-profiles-summary/{InstanceId}" + }, + "input":{"shape":"ListSecurityProfilesRequest"}, + "output":{"shape":"ListSecurityProfilesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides summary information about the security profiles for the specified Amazon Connect instance.

" + }, + "ListUserHierarchyGroups":{ + "name":"ListUserHierarchyGroups", + "http":{ + "method":"GET", + "requestUri":"/user-hierarchy-groups-summary/{InstanceId}" + }, + "input":{"shape":"ListUserHierarchyGroupsRequest"}, + "output":{"shape":"ListUserHierarchyGroupsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"GET", + "requestUri":"/users-summary/{InstanceId}" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Provides summary information about the users for the specified Amazon Connect instance.

" + }, + "StartOutboundVoiceContact":{ + "name":"StartOutboundVoiceContact", + "http":{ + "method":"PUT", + "requestUri":"/contact/outbound-voice" + }, + "input":{"shape":"StartOutboundVoiceContactRequest"}, + "output":{"shape":"StartOutboundVoiceContactResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"LimitExceededException"}, + {"shape":"DestinationNotAllowedException"}, + {"shape":"OutboundContactNotPermittedException"} + ], + "documentation":"

Initiates a contact flow to place an outbound call to a customer.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

" + }, + "StopContact":{ + "name":"StopContact", + "http":{ + "method":"POST", + "requestUri":"/contact/stop" + }, + "input":{"shape":"StopContactRequest"}, + "output":{"shape":"StopContactResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ContactNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Ends the specified contact.

" + }, + "UpdateContactAttributes":{ + "name":"UpdateContactAttributes", + "http":{ + "method":"POST", + "requestUri":"/contact/attributes" + }, + "input":{"shape":"UpdateContactAttributesRequest"}, + "output":{"shape":"UpdateContactAttributesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates or updates the contact attributes associated with the specified contact.

You can add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers.

Contact attributes are available in Amazon Connect for 24 months, and are then deleted.

Important: You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance.

" + }, + "UpdateUserHierarchy":{ + "name":"UpdateUserHierarchy", + "http":{ + "method":"POST", + "requestUri":"/users/{InstanceId}/{UserId}/hierarchy" + }, + "input":{"shape":"UpdateUserHierarchyRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Assigns the specified hierarchy group to the specified user.

" + }, + "UpdateUserIdentityInfo":{ + "name":"UpdateUserIdentityInfo", + "http":{ + "method":"POST", + "requestUri":"/users/{InstanceId}/{UserId}/identity-info" + }, + "input":{"shape":"UpdateUserIdentityInfoRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Updates the identity information for the specified user.

" + }, + "UpdateUserPhoneConfig":{ + "name":"UpdateUserPhoneConfig", + "http":{ + "method":"POST", + "requestUri":"/users/{InstanceId}/{UserId}/phone-config" + }, + "input":{"shape":"UpdateUserPhoneConfigRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Updates the phone configuration settings for the specified user.

" + }, + "UpdateUserRoutingProfile":{ + "name":"UpdateUserRoutingProfile", + "http":{ + "method":"POST", + "requestUri":"/users/{InstanceId}/{UserId}/routing-profile" + }, + "input":{"shape":"UpdateUserRoutingProfileRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Assigns the specified routing profile to the specified user.

" + }, + "UpdateUserSecurityProfiles":{ + "name":"UpdateUserSecurityProfiles", + "http":{ + "method":"POST", + "requestUri":"/users/{InstanceId}/{UserId}/security-profiles" + }, + "input":{"shape":"UpdateUserSecurityProfilesRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Assigns the specified security profiles to the specified user.

" + } + }, + "shapes":{ + "ARN":{"type":"string"}, + "AfterContactWorkTimeLimit":{ + "type":"integer", + "min":0 + }, + "AgentFirstName":{ + "type":"string", + "max":100, + "min":1 + }, + "AgentLastName":{ + "type":"string", + "max":100, + "min":1 + }, + "AgentUsername":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[a-zA-Z0-9\\_\\-\\.]+" + }, + "AttributeName":{ + "type":"string", + "max":32767, + "min":1 + }, + "AttributeValue":{ + "type":"string", + "max":32767, + "min":0 + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AutoAccept":{"type":"boolean"}, + "Channel":{ + "type":"string", + "enum":["VOICE"] + }, + "Channels":{ + "type":"list", + "member":{"shape":"Channel"}, + "max":1 + }, + "ClientToken":{ + "type":"string", + "max":500 + }, + "Comparison":{ + "type":"string", + "enum":["LT"] + }, + "ContactFlowId":{ + "type":"string", + "max":500 + }, + "ContactFlowName":{"type":"string"}, + "ContactFlowSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ContactFlowId", + "documentation":"

The identifier of the contact flow.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the contact flow.

" + }, + "Name":{ + "shape":"ContactFlowName", + "documentation":"

The name of the contact flow.

" + }, + "ContactFlowType":{ + "shape":"ContactFlowType", + "documentation":"

The type of contact flow.

" + } + }, + "documentation":"

Contains summary information about a contact flow.

" + }, + "ContactFlowSummaryList":{ + "type":"list", + "member":{"shape":"ContactFlowSummary"} + }, + "ContactFlowType":{ + "type":"string", + "enum":[ + "CONTACT_FLOW", + "CUSTOMER_QUEUE", + "CUSTOMER_HOLD", + "CUSTOMER_WHISPER", + "AGENT_HOLD", + "AGENT_WHISPER", + "OUTBOUND_WHISPER", + "AGENT_TRANSFER", + "QUEUE_TRANSFER" + ] + }, + "ContactFlowTypes":{ + "type":"list", + "member":{"shape":"ContactFlowType"}, + "max":10 + }, + "ContactId":{ + "type":"string", + "max":256, + "min":1 + }, + "ContactNotFoundException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

The contact with the specified ID is not active or does not exist.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "Username", + "PhoneConfig", + "SecurityProfileIds", + "RoutingProfileId", + "InstanceId" + ], + "members":{ + "Username":{ + "shape":"AgentUsername", + "documentation":"

The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\\@]+.

" + }, + "Password":{ + "shape":"Password", + "documentation":"

The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.

" + }, + "IdentityInfo":{ + "shape":"UserIdentityInfo", + "documentation":"

The information about the identity of the user.

" + }, + "PhoneConfig":{ + "shape":"UserPhoneConfig", + "documentation":"

The phone settings for the user.

" + }, + "DirectoryUserId":{ + "shape":"DirectoryUserId", + "documentation":"

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory.

This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.

" + }, + "SecurityProfileIds":{ + "shape":"SecurityProfileIds", + "documentation":"

The identifier of the security profile for the user.

" + }, + "RoutingProfileId":{ + "shape":"RoutingProfileId", + "documentation":"

The identifier of the routing profile for the user.

" + }, + "HierarchyGroupId":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group for the user.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

" + }, + "UserArn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the user account.

" + } + } + }, + "Credentials":{ + "type":"structure", + "members":{ + "AccessToken":{ + "shape":"SecurityToken", + "documentation":"

An access token generated for a federated user to access Amazon Connect.

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

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

" + }, + "RefreshToken":{ + "shape":"SecurityToken", + "documentation":"

Renews a token generated for a user to access the Amazon Connect instance.

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

Renews the expiration timer for a generated token.

" + } + }, + "documentation":"

Contains credentials to use for federation.

" + }, + "CurrentMetric":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CurrentMetricName", + "documentation":"

The name of the metric.

" + }, + "Unit":{ + "shape":"Unit", + "documentation":"

The unit for the metric.

" + } + }, + "documentation":"

Contains information about a real-time metric.

" + }, + "CurrentMetricData":{ + "type":"structure", + "members":{ + "Metric":{ + "shape":"CurrentMetric", + "documentation":"

Information about the metric.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The value of the metric.

", + "box":true + } + }, + "documentation":"

Contains the data for a real-time metric.

" + }, + "CurrentMetricDataCollections":{ + "type":"list", + "member":{"shape":"CurrentMetricData"} + }, + "CurrentMetricName":{ + "type":"string", + "documentation":"

The current metric names.

", + "enum":[ + "AGENTS_ONLINE", + "AGENTS_AVAILABLE", + "AGENTS_ON_CALL", + "AGENTS_NON_PRODUCTIVE", + "AGENTS_AFTER_CONTACT_WORK", + "AGENTS_ERROR", + "AGENTS_STAFFED", + "CONTACTS_IN_QUEUE", + "OLDEST_CONTACT_AGE", + "CONTACTS_SCHEDULED" + ] + }, + "CurrentMetricResult":{ + "type":"structure", + "members":{ + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimensions for the metrics.

" + }, + "Collections":{ + "shape":"CurrentMetricDataCollections", + "documentation":"

The set of metrics.

" + } + }, + "documentation":"

Contains information about a set of real-time metrics.

" + }, + "CurrentMetricResults":{ + "type":"list", + "member":{"shape":"CurrentMetricResult"} + }, + "CurrentMetrics":{ + "type":"list", + "member":{"shape":"CurrentMetric"} + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "UserId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user.

", + "location":"uri", + "locationName":"UserId" + } + } + }, + "DescribeUserHierarchyGroupRequest":{ + "type":"structure", + "required":[ + "HierarchyGroupId", + "InstanceId" + ], + "members":{ + "HierarchyGroupId":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group.

", + "location":"uri", + "locationName":"HierarchyGroupId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "DescribeUserHierarchyGroupResponse":{ + "type":"structure", + "members":{ + "HierarchyGroup":{ + "shape":"HierarchyGroup", + "documentation":"

Information about the hierarchy group.

" + } + } + }, + "DescribeUserHierarchyStructureRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "DescribeUserHierarchyStructureResponse":{ + "type":"structure", + "members":{ + "HierarchyStructure":{ + "shape":"HierarchyStructure", + "documentation":"

Information about the hierarchy structure.

" + } + } + }, + "DescribeUserRequest":{ + "type":"structure", + "required":[ + "UserId", + "InstanceId" + ], + "members":{ + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "DescribeUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

Information about the user account and configuration settings.

" + } + } + }, + "DestinationNotAllowedException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

Outbound calls to the destination number are not allowed.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "Dimensions":{ + "type":"structure", + "members":{ + "Queue":{ + "shape":"QueueReference", + "documentation":"

Information about the queue for which metrics are returned.

" + }, + "Channel":{ + "shape":"Channel", + "documentation":"

The channel used for grouping and filters.

" + } + }, + "documentation":"

Contains information about the dimensions for a set of metrics.

" + }, + "DirectoryUserId":{"type":"string"}, + "DuplicateResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

A resource with the specified name already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "Email":{"type":"string"}, + "Filters":{ + "type":"structure", + "members":{ + "Queues":{ + "shape":"Queues", + "documentation":"

The queues to use to filter the metrics. You can specify up to 100 queues per request.

" + }, + "Channels":{ + "shape":"Channels", + "documentation":"

The channel to use to filter the metrics.

" + } + }, + "documentation":"

Contains the filter to apply when retrieving metrics.

" + }, + "GetContactAttributesRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "InitialContactId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "InitialContactId":{ + "shape":"ContactId", + "documentation":"

The identifier of the initial contact.

", + "location":"uri", + "locationName":"InitialContactId" + } + } + }, + "GetContactAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"Attributes", + "documentation":"

Information about the attributes.

" + } + } + }, + "GetCurrentMetricDataRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Filters", + "CurrentMetrics" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE.

" + }, + "Groupings":{ + "shape":"Groupings", + "documentation":"

The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of metrics is returned.

" + }, + "CurrentMetrics":{ + "shape":"CurrentMetrics", + "documentation":"

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

CONTACTS_SCHEDULED

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

" + }, + "MaxResults":{ + "shape":"MaxResult100", + "documentation":"

The maximimum number of results to return per page.

", + "box":true + } + } + }, + "GetCurrentMetricDataResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

" + }, + "MetricResults":{ + "shape":"CurrentMetricResults", + "documentation":"

Information about the real-time metrics.

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

The time at which the metrics were retrieved and cached for pagination.

" + } + } + }, + "GetFederationTokenRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "GetFederationTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

The credentials to use for federation.

" + } + } + }, + "GetMetricDataRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "StartTime", + "EndTime", + "Filters", + "HistoricalMetrics" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "StartTime":{ + "shape":"timestamp", + "documentation":"

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

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

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. The only supported channel is VOICE.

" + }, + "Groupings":{ + "shape":"Groupings", + "documentation":"

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

The only supported grouping is QUEUE.

If no grouping is specified, a summary of metrics for all queues is returned.

" + }, + "HistoricalMetrics":{ + "shape":"HistoricalMetrics", + "documentation":"

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

Unit: PERCENT

Statistic: AVG

Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

" + }, + "MaxResults":{ + "shape":"MaxResult100", + "documentation":"

The maximimum number of results to return per page.

", + "box":true + } + } + }, + "GetMetricDataResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.

" + }, + "MetricResults":{ + "shape":"HistoricalMetricResults", + "documentation":"

Information about the historical metrics.

If no grouping is specified, a summary of metric data is returned.

" + } + } + }, + "Grouping":{ + "type":"string", + "enum":[ + "QUEUE", + "CHANNEL" + ] + }, + "Groupings":{ + "type":"list", + "member":{"shape":"Grouping"}, + "max":2 + }, + "HierarchyGroup":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the hierarchy group.

" + }, + "Name":{ + "shape":"HierarchyGroupName", + "documentation":"

The name of the hierarchy group.

" + }, + "LevelId":{ + "shape":"HierarchyLevelId", + "documentation":"

The identifier of the level in the hierarchy group.

" + }, + "HierarchyPath":{ + "shape":"HierarchyPath", + "documentation":"

Information about the levels in the hierarchy group.

" + } + }, + "documentation":"

Contains information about a hierarchy group.

" + }, + "HierarchyGroupId":{"type":"string"}, + "HierarchyGroupName":{"type":"string"}, + "HierarchyGroupSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the hierarchy group.

" + }, + "Name":{ + "shape":"HierarchyGroupName", + "documentation":"

The name of the hierarchy group.

" + } + }, + "documentation":"

Contains summary information about a hierarchy group.

" + }, + "HierarchyGroupSummaryList":{ + "type":"list", + "member":{"shape":"HierarchyGroupSummary"} + }, + "HierarchyLevel":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"HierarchyLevelId", + "documentation":"

The identifier of the hierarchy level.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the hierarchy level.

" + }, + "Name":{ + "shape":"HierarchyLevelName", + "documentation":"

The name of the hierarchy level.

" + } + }, + "documentation":"

Contains information about a hierarchy level.

" + }, + "HierarchyLevelId":{"type":"string"}, + "HierarchyLevelName":{"type":"string"}, + "HierarchyPath":{ + "type":"structure", + "members":{ + "LevelOne":{ + "shape":"HierarchyGroupSummary", + "documentation":"

Information about level one.

" + }, + "LevelTwo":{ + "shape":"HierarchyGroupSummary", + "documentation":"

Information about level two.

" + }, + "LevelThree":{ + "shape":"HierarchyGroupSummary", + "documentation":"

Information about level three.

" + }, + "LevelFour":{ + "shape":"HierarchyGroupSummary", + "documentation":"

Information about level four.

" + }, + "LevelFive":{ + "shape":"HierarchyGroupSummary", + "documentation":"

Information about level five.

" + } + }, + "documentation":"

Contains information about the levels of a hierarchy group.

" + }, + "HierarchyStructure":{ + "type":"structure", + "members":{ + "LevelOne":{ + "shape":"HierarchyLevel", + "documentation":"

Information about level one.

" + }, + "LevelTwo":{ + "shape":"HierarchyLevel", + "documentation":"

Information about level two.

" + }, + "LevelThree":{ + "shape":"HierarchyLevel", + "documentation":"

Information about level three.

" + }, + "LevelFour":{ + "shape":"HierarchyLevel", + "documentation":"

Information about level four.

" + }, + "LevelFive":{ + "shape":"HierarchyLevel", + "documentation":"

Information about level five.

" + } + }, + "documentation":"

Contains information about a hierarchy structure.

" + }, + "HistoricalMetric":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"HistoricalMetricName", + "documentation":"

The name of the metric.

" + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

The threshold for the metric, used with service level metrics.

", + "box":true + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

The statistic for the metric.

" + }, + "Unit":{ + "shape":"Unit", + "documentation":"

The unit for the metric.

" + } + }, + "documentation":"

Contains information about a historical metric.

" + }, + "HistoricalMetricData":{ + "type":"structure", + "members":{ + "Metric":{ + "shape":"HistoricalMetric", + "documentation":"

Information about the metric.

" + }, + "Value":{ + "shape":"Value", + "documentation":"

The value of the metric.

", + "box":true + } + }, + "documentation":"

Contains the data for a historical metric.

" + }, + "HistoricalMetricDataCollections":{ + "type":"list", + "member":{"shape":"HistoricalMetricData"} + }, + "HistoricalMetricName":{ + "type":"string", + "documentation":"

The historical metric names.

", + "enum":[ + "CONTACTS_QUEUED", + "CONTACTS_HANDLED", + "CONTACTS_ABANDONED", + "CONTACTS_CONSULTED", + "CONTACTS_AGENT_HUNG_UP_FIRST", + "CONTACTS_HANDLED_INCOMING", + "CONTACTS_HANDLED_OUTBOUND", + "CONTACTS_HOLD_ABANDONS", + "CONTACTS_TRANSFERRED_IN", + "CONTACTS_TRANSFERRED_OUT", + "CONTACTS_TRANSFERRED_IN_FROM_QUEUE", + "CONTACTS_TRANSFERRED_OUT_FROM_QUEUE", + "CONTACTS_MISSED", + "CALLBACK_CONTACTS_HANDLED", + "API_CONTACTS_HANDLED", + "OCCUPANCY", + "HANDLE_TIME", + "AFTER_CONTACT_WORK_TIME", + "QUEUED_TIME", + "ABANDON_TIME", + "QUEUE_ANSWER_TIME", + "HOLD_TIME", + "INTERACTION_TIME", + "INTERACTION_AND_HOLD_TIME", + "SERVICE_LEVEL" + ] + }, + "HistoricalMetricResult":{ + "type":"structure", + "members":{ + "Dimensions":{ + "shape":"Dimensions", + "documentation":"

The dimension for the metrics.

" + }, + "Collections":{ + "shape":"HistoricalMetricDataCollections", + "documentation":"

The set of metrics.

" + } + }, + "documentation":"

Contains information about the historical metrics retrieved.

" + }, + "HistoricalMetricResults":{ + "type":"list", + "member":{"shape":"HistoricalMetricResult"} + }, + "HistoricalMetrics":{ + "type":"list", + "member":{"shape":"HistoricalMetric"} + }, + "HoursOfOperationId":{"type":"string"}, + "HoursOfOperationName":{"type":"string"}, + "HoursOfOperationSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"HoursOfOperationId", + "documentation":"

The identifier of the hours of operation.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the hours of operation.

" + }, + "Name":{ + "shape":"HoursOfOperationName", + "documentation":"

The name of the hours of operation.

" + } + }, + "documentation":"

Contains summary information about hours of operation for a contact center.

" + }, + "HoursOfOperationSummaryList":{ + "type":"list", + "member":{"shape":"HoursOfOperationSummary"} + }, + "InstanceId":{ + "type":"string", + "max":100, + "min":1 + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

Request processing failed due to an error or failure with the service.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

One or more of the specified parameters are not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

The request is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

The allowed limit for the resource has been exceeded.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListContactFlowsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "ContactFlowTypes":{ + "shape":"ContactFlowTypes", + "documentation":"

The type of contact flow.

", + "location":"querystring", + "locationName":"contactFlowTypes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListContactFlowsResponse":{ + "type":"structure", + "members":{ + "ContactFlowSummaryList":{ + "shape":"ContactFlowSummaryList", + "documentation":"

Information about the contact flows.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListHoursOfOperationsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListHoursOfOperationsResponse":{ + "type":"structure", + "members":{ + "HoursOfOperationSummaryList":{ + "shape":"HoursOfOperationSummaryList", + "documentation":"

Information about the hours of operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListPhoneNumbersRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "PhoneNumberTypes":{ + "shape":"PhoneNumberTypes", + "documentation":"

The type of phone number.

", + "location":"querystring", + "locationName":"phoneNumberTypes" + }, + "PhoneNumberCountryCodes":{ + "shape":"PhoneNumberCountryCodes", + "documentation":"

The ISO country code.

", + "location":"querystring", + "locationName":"phoneNumberCountryCodes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPhoneNumbersResponse":{ + "type":"structure", + "members":{ + "PhoneNumberSummaryList":{ + "shape":"PhoneNumberSummaryList", + "documentation":"

Information about the phone numbers.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListQueuesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "QueueTypes":{ + "shape":"QueueTypes", + "documentation":"

The type of queue.

", + "location":"querystring", + "locationName":"queueTypes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListQueuesResponse":{ + "type":"structure", + "members":{ + "QueueSummaryList":{ + "shape":"QueueSummaryList", + "documentation":"

Information about the queues.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListRoutingProfilesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListRoutingProfilesResponse":{ + "type":"structure", + "members":{ + "RoutingProfileSummaryList":{ + "shape":"RoutingProfileSummaryList", + "documentation":"

Information about the routing profiles.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListSecurityProfilesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSecurityProfilesResponse":{ + "type":"structure", + "members":{ + "SecurityProfileSummaryList":{ + "shape":"SecurityProfileSummaryList", + "documentation":"

Information about the security profiles.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListUserHierarchyGroupsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListUserHierarchyGroupsResponse":{ + "type":"structure", + "members":{ + "UserHierarchyGroupSummaryList":{ + "shape":"HierarchyGroupSummaryList", + "documentation":"

Information about the hierarchy groups.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResult1000", + "documentation":"

The maximimum number of results to return per page.

", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "UserSummaryList":{ + "shape":"UserSummaryList", + "documentation":"

Information about the users.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If there are additional results, this is the token for the next set of results.

" + } + } + }, + "MaxResult100":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxResult1000":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Message":{"type":"string"}, + "NextToken":{"type":"string"}, + "OutboundContactNotPermittedException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

The contact is not permitted.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "Password":{ + "type":"string", + "pattern":"/^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)[a-zA-Z\\d\\S]{8,64}$/" + }, + "PhoneNumber":{"type":"string"}, + "PhoneNumberCountryCode":{ + "type":"string", + "enum":[ + "AF", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AQ", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BA", + "BW", + "BR", + "IO", + "VG", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CA", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CX", + "CC", + "CO", + "KM", + "CK", + "CR", + "HR", + "CU", + "CW", + "CY", + "CZ", + "CD", + "DK", + "DJ", + "DM", + "DO", + "TL", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "PF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IM", + "IL", + "IT", + "CI", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MR", + "MU", + "YT", + "MX", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "AN", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "KP", + "MP", + "NO", + "OM", + "PK", + "PW", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "PR", + "QA", + "CG", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SG", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "KR", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "VI", + "UG", + "UA", + "AE", + "GB", + "US", + "UY", + "UZ", + "VU", + "VA", + "VE", + "VN", + "WF", + "EH", + "YE", + "ZM", + "ZW" + ] + }, + "PhoneNumberCountryCodes":{ + "type":"list", + "member":{"shape":"PhoneNumberCountryCode"}, + "max":10 + }, + "PhoneNumberId":{"type":"string"}, + "PhoneNumberSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"PhoneNumberId", + "documentation":"

The identifier of the phone number.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the phone number.

" + }, + "PhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number.

" + }, + "PhoneNumberType":{ + "shape":"PhoneNumberType", + "documentation":"

The type of phone number.

" + }, + "PhoneNumberCountryCode":{ + "shape":"PhoneNumberCountryCode", + "documentation":"

The ISO country code.

" + } + }, + "documentation":"

Contains summary information about a phone number for a contact center.

" + }, + "PhoneNumberSummaryList":{ + "type":"list", + "member":{"shape":"PhoneNumberSummary"} + }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "TOLL_FREE", + "DID" + ] + }, + "PhoneNumberTypes":{ + "type":"list", + "member":{"shape":"PhoneNumberType"}, + "max":2 + }, + "PhoneType":{ + "type":"string", + "enum":[ + "SOFT_PHONE", + "DESK_PHONE" + ] + }, + "QueueId":{"type":"string"}, + "QueueName":{ + "type":"string", + "max":256, + "min":1 + }, + "QueueReference":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"QueueId", + "documentation":"

The identifier of the queue.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the queue.

" + } + }, + "documentation":"

Contains information about a queue resource for which metrics are returned.

" + }, + "QueueSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"QueueId", + "documentation":"

The identifier of the queue.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the queue.

" + }, + "Name":{ + "shape":"QueueName", + "documentation":"

The name of the queue.

" + }, + "QueueType":{ + "shape":"QueueType", + "documentation":"

The type of queue.

" + } + }, + "documentation":"

Contains summary information about a queue.

" + }, + "QueueSummaryList":{ + "type":"list", + "member":{"shape":"QueueSummary"} + }, + "QueueType":{ + "type":"string", + "enum":[ + "STANDARD", + "AGENT" + ] + }, + "QueueTypes":{ + "type":"list", + "member":{"shape":"QueueType"}, + "max":2 + }, + "Queues":{ + "type":"list", + "member":{"shape":"QueueId"}, + "max":100, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"Message", + "documentation":"

The message.

" + } + }, + "documentation":"

The specified resource was not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoutingProfileId":{"type":"string"}, + "RoutingProfileName":{ + "type":"string", + "max":100, + "min":1 + }, + "RoutingProfileSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"RoutingProfileId", + "documentation":"

The identifier of the routing profile.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the routing profile.

" + }, + "Name":{ + "shape":"RoutingProfileName", + "documentation":"

The name of the routing profile.

" + } + }, + "documentation":"

Contains summary information about a routing profile.

" + }, + "RoutingProfileSummaryList":{ + "type":"list", + "member":{"shape":"RoutingProfileSummary"} + }, + "SecurityProfileId":{"type":"string"}, + "SecurityProfileIds":{ + "type":"list", + "member":{"shape":"SecurityProfileId"}, + "max":10, + "min":1 + }, + "SecurityProfileName":{"type":"string"}, + "SecurityProfileSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"SecurityProfileId", + "documentation":"

The identifier of the security profile.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the security profile.

" + }, + "Name":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile.

" + } + }, + "documentation":"

Contains information about a security profile.

" + }, + "SecurityProfileSummaryList":{ + "type":"list", + "member":{"shape":"SecurityProfileSummary"} + }, + "SecurityToken":{ + "type":"string", + "sensitive":true + }, + "StartOutboundVoiceContactRequest":{ + "type":"structure", + "required":[ + "DestinationPhoneNumber", + "ContactFlowId", + "InstanceId" + ], + "members":{ + "DestinationPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number of the customer, in E.164 format.

" + }, + "ContactFlowId":{ + "shape":"ContactFlowId", + "documentation":"

The identifier of the contact flow for the outbound call.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.

", + "idempotencyToken":true + }, + "SourcePhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.

" + }, + "QueueId":{ + "shape":"QueueId", + "documentation":"

The queue for the call. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue defined in the contact flow is used. If you do not specify a queue, you must specify a source phone number.

" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

" + } + } + }, + "StartOutboundVoiceContactResponse":{ + "type":"structure", + "members":{ + "ContactId":{ + "shape":"ContactId", + "documentation":"

The identifier of this contact within the Amazon Connect instance.

" + } + } + }, + "Statistic":{ + "type":"string", + "enum":[ + "SUM", + "MAX", + "AVG" + ] + }, + "StopContactRequest":{ + "type":"structure", + "required":[ + "ContactId", + "InstanceId" + ], + "members":{ + "ContactId":{ + "shape":"ContactId", + "documentation":"

The ID of the contact.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

" + } + } + }, + "StopContactResponse":{ + "type":"structure", + "members":{ + } + }, + "Threshold":{ + "type":"structure", + "members":{ + "Comparison":{ + "shape":"Comparison", + "documentation":"

The type of comparison. Only \"less than\" (LT) comparisons are supported.

" + }, + "ThresholdValue":{ + "shape":"ThresholdValue", + "documentation":"

The threshold value to compare.

", + "box":true + } + }, + "documentation":"

Contains information about the threshold for service level metrics.

" + }, + "ThresholdValue":{"type":"double"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

The throttling limit has been exceeded.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Unit":{ + "type":"string", + "enum":[ + "SECONDS", + "COUNT", + "PERCENT" + ] + }, + "UpdateContactAttributesRequest":{ + "type":"structure", + "required":[ + "InitialContactId", + "InstanceId", + "Attributes" + ], + "members":{ + "InitialContactId":{ + "shape":"ContactId", + "documentation":"

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

" + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

The Amazon Connect attributes. These attributes can be accessed in contact flows just like any other contact attributes.

You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

" + } + } + }, + "UpdateContactAttributesResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateUserHierarchyRequest":{ + "type":"structure", + "required":[ + "UserId", + "InstanceId" + ], + "members":{ + "HierarchyGroupId":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "UpdateUserIdentityInfoRequest":{ + "type":"structure", + "required":[ + "IdentityInfo", + "UserId", + "InstanceId" + ], + "members":{ + "IdentityInfo":{ + "shape":"UserIdentityInfo", + "documentation":"

The identity information for the user.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "UpdateUserPhoneConfigRequest":{ + "type":"structure", + "required":[ + "PhoneConfig", + "UserId", + "InstanceId" + ], + "members":{ + "PhoneConfig":{ + "shape":"UserPhoneConfig", + "documentation":"

Information about phone configuration settings for the user.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "UpdateUserRoutingProfileRequest":{ + "type":"structure", + "required":[ + "RoutingProfileId", + "UserId", + "InstanceId" + ], + "members":{ + "RoutingProfileId":{ + "shape":"RoutingProfileId", + "documentation":"

The identifier of the routing profile for the user.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "UpdateUserSecurityProfilesRequest":{ + "type":"structure", + "required":[ + "SecurityProfileIds", + "UserId", + "InstanceId" + ], + "members":{ + "SecurityProfileIds":{ + "shape":"SecurityProfileIds", + "documentation":"

The identifiers of the security profiles for the user.

" + }, + "UserId":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

", + "location":"uri", + "locationName":"UserId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The identifier of the Amazon Connect instance.

", + "location":"uri", + "locationName":"InstanceId" + } + } + }, + "User":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the user account.

" + }, + "Username":{ + "shape":"AgentUsername", + "documentation":"

The user name assigned to the user account.

" + }, + "IdentityInfo":{ + "shape":"UserIdentityInfo", + "documentation":"

Information about the user identity.

" + }, + "PhoneConfig":{ + "shape":"UserPhoneConfig", + "documentation":"

Information about the phone configuration for the user.

" + }, + "DirectoryUserId":{ + "shape":"DirectoryUserId", + "documentation":"

The identifier of the user account in the directory used for identity management.

" + }, + "SecurityProfileIds":{ + "shape":"SecurityProfileIds", + "documentation":"

The identifiers of the security profiles for the user.

" + }, + "RoutingProfileId":{ + "shape":"RoutingProfileId", + "documentation":"

The identifier of the routing profile for the user.

" + }, + "HierarchyGroupId":{ + "shape":"HierarchyGroupId", + "documentation":"

The identifier of the hierarchy group for the user.

" + } + }, + "documentation":"

Contains information about a user account for a Amazon Connect instance.

" + }, + "UserId":{"type":"string"}, + "UserIdentityInfo":{ + "type":"structure", + "members":{ + "FirstName":{ + "shape":"AgentFirstName", + "documentation":"

The first name. This is required if you are using Amazon Connect or SAML for identity management.

" + }, + "LastName":{ + "shape":"AgentLastName", + "documentation":"

The last name. This is required if you are using Amazon Connect or SAML for identity management.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email address. If you are using SAML for identity management and include this parameter, an error is returned.

" + } + }, + "documentation":"

Contains information about the identity of a user.

" + }, + "UserNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

No user with the specified credentials was found in the Amazon Connect instance.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "UserPhoneConfig":{ + "type":"structure", + "required":["PhoneType"], + "members":{ + "PhoneType":{ + "shape":"PhoneType", + "documentation":"

The phone type.

" + }, + "AutoAccept":{ + "shape":"AutoAccept", + "documentation":"

The Auto accept setting.

" + }, + "AfterContactWorkTimeLimit":{ + "shape":"AfterContactWorkTimeLimit", + "documentation":"

The After Call Work (ACW) timeout setting, in seconds.

" + }, + "DeskPhoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

The phone number for the user's desk phone.

" + } + }, + "documentation":"

Contains information about the phone configuration settings for a user.

" + }, + "UserSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"UserId", + "documentation":"

The identifier of the user account.

" + }, + "Arn":{ + "shape":"ARN", + "documentation":"

The Amazon Resource Name (ARN) of the user account.

" + }, + "Username":{ + "shape":"AgentUsername", + "documentation":"

The Amazon Connect user name of the user account.

" + } + }, + "documentation":"

Contains summary information about a user.

" + }, + "UserSummaryList":{ + "type":"list", + "member":{"shape":"UserSummary"} + }, + "Value":{"type":"double"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.

There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Limits in the Amazon Connect Administrator Guide.

" +} diff --git a/aws/dist/botocore/data/cur/2017-01-06/examples-1.json b/aws/dist/botocore/data/cur/2017-01-06/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/cur/2017-01-06/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/cur/2017-01-06/paginators-1.json b/aws/dist/botocore/data/cur/2017-01-06/paginators-1.json new file mode 100644 index 00000000..7db4dfe1 --- /dev/null +++ b/aws/dist/botocore/data/cur/2017-01-06/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "DescribeReportDefinitions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReportDefinitions" + } + } +} diff --git a/aws/dist/botocore/data/cur/2017-01-06/service-2.json b/aws/dist/botocore/data/cur/2017-01-06/service-2.json new file mode 100644 index 00000000..959e90ff --- /dev/null +++ b/aws/dist/botocore/data/cur/2017-01-06/service-2.json @@ -0,0 +1,333 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-01-06", + "endpointPrefix":"cur", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Cost and Usage Report Service", + "serviceId":"Cost and Usage Report Service", + "signatureVersion":"v4", + "signingName":"cur", + "targetPrefix":"AWSOrigamiServiceGatewayService", + "uid":"cur-2017-01-06" + }, + "operations":{ + "DeleteReportDefinition":{ + "name":"DeleteReportDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReportDefinitionRequest"}, + "output":{"shape":"DeleteReportDefinitionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Deletes the specified report.

" + }, + "DescribeReportDefinitions":{ + "name":"DescribeReportDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReportDefinitionsRequest"}, + "output":{"shape":"DescribeReportDefinitionsResponse"}, + "errors":[ + {"shape":"InternalErrorException"} + ], + "documentation":"

Lists the AWS Cost and Usage reports available to this account.

" + }, + "ModifyReportDefinition":{ + "name":"ModifyReportDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReportDefinitionRequest"}, + "output":{"shape":"ModifyReportDefinitionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Allows you to programatically update your report preferences.

" + }, + "PutReportDefinition":{ + "name":"PutReportDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutReportDefinitionRequest"}, + "output":{"shape":"PutReportDefinitionResponse"}, + "errors":[ + {"shape":"DuplicateReportNameException"}, + {"shape":"ReportLimitReachedException"}, + {"shape":"InternalErrorException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Creates a new report using the description that you provide.

" + } + }, + "shapes":{ + "AWSRegion":{ + "type":"string", + "documentation":"

The region of the S3 bucket that AWS delivers the report into.

", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-central-1", + "eu-west-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "eu-north-1", + "ap-northeast-3", + "ap-east-1" + ] + }, + "AdditionalArtifact":{ + "type":"string", + "documentation":"

The types of manifest that you want AWS to create for this report.

", + "enum":[ + "REDSHIFT", + "QUICKSIGHT", + "ATHENA" + ] + }, + "AdditionalArtifactList":{ + "type":"list", + "member":{"shape":"AdditionalArtifact"}, + "documentation":"

A list of additional artifacts.

" + }, + "CompressionFormat":{ + "type":"string", + "documentation":"

The compression format that AWS uses for the report.

", + "enum":[ + "ZIP", + "GZIP", + "Parquet" + ] + }, + "DeleteReportDefinitionRequest":{ + "type":"structure", + "members":{ + "ReportName":{"shape":"ReportName"} + }, + "documentation":"

Deletes the specified report.

" + }, + "DeleteReportDefinitionResponse":{ + "type":"structure", + "members":{ + "ResponseMessage":{"shape":"DeleteResponseMessage"} + }, + "documentation":"

If the action is successful, the service sends back an HTTP 200 response.

" + }, + "DeleteResponseMessage":{ + "type":"string", + "documentation":"

Whether the deletion was successful or not.

" + }, + "DescribeReportDefinitionsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"MaxResults"}, + "NextToken":{"shape":"GenericString"} + }, + "documentation":"

Requests a list of AWS Cost and Usage reports owned by the account.

" + }, + "DescribeReportDefinitionsResponse":{ + "type":"structure", + "members":{ + "ReportDefinitions":{ + "shape":"ReportDefinitionList", + "documentation":"

A list of AWS Cost and Usage reports owned by the account.

" + }, + "NextToken":{"shape":"GenericString"} + }, + "documentation":"

If the action is successful, the service sends back an HTTP 200 response.

" + }, + "DuplicateReportNameException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A report with the specified name already exists in the account. Specify a different report name.

", + "exception":true + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A message to show the detail of the exception.

" + }, + "GenericString":{ + "type":"string", + "documentation":"

A generic string.

" + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An error on the server occurred during the processing of your request. Try again later.

", + "exception":true, + "fault":true + }, + "MaxResults":{ + "type":"integer", + "documentation":"

The maximum number of results that AWS returns for the operation.

", + "box":true, + "max":5, + "min":5 + }, + "ModifyReportDefinitionRequest":{ + "type":"structure", + "required":[ + "ReportName", + "ReportDefinition" + ], + "members":{ + "ReportName":{"shape":"ReportName"}, + "ReportDefinition":{"shape":"ReportDefinition"} + } + }, + "ModifyReportDefinitionResponse":{ + "type":"structure", + "members":{ + } + }, + "PutReportDefinitionRequest":{ + "type":"structure", + "required":["ReportDefinition"], + "members":{ + "ReportDefinition":{ + "shape":"ReportDefinition", + "documentation":"

Represents the output of the PutReportDefinition operation. The content consists of the detailed metadata and data file information.

" + } + }, + "documentation":"

Creates a Cost and Usage Report.

" + }, + "PutReportDefinitionResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

" + }, + "RefreshClosedReports":{ + "type":"boolean", + "box":true + }, + "ReportDefinition":{ + "type":"structure", + "required":[ + "ReportName", + "TimeUnit", + "Format", + "Compression", + "AdditionalSchemaElements", + "S3Bucket", + "S3Prefix", + "S3Region" + ], + "members":{ + "ReportName":{"shape":"ReportName"}, + "TimeUnit":{"shape":"TimeUnit"}, + "Format":{"shape":"ReportFormat"}, + "Compression":{"shape":"CompressionFormat"}, + "AdditionalSchemaElements":{ + "shape":"SchemaElementList", + "documentation":"

A list of strings that indicate additional content that Amazon Web Services includes in the report, such as individual resource IDs.

" + }, + "S3Bucket":{"shape":"S3Bucket"}, + "S3Prefix":{"shape":"S3Prefix"}, + "S3Region":{"shape":"AWSRegion"}, + "AdditionalArtifacts":{ + "shape":"AdditionalArtifactList", + "documentation":"

A list of manifests that you want Amazon Web Services to create for this report.

" + }, + "RefreshClosedReports":{ + "shape":"RefreshClosedReports", + "documentation":"

Whether you want Amazon Web Services to update your reports after they have been finalized if Amazon Web Services detects charges related to previous months. These charges can include refunds, credits, or support fees.

" + }, + "ReportVersioning":{ + "shape":"ReportVersioning", + "documentation":"

Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.

" + } + }, + "documentation":"

The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition.

" + }, + "ReportDefinitionList":{ + "type":"list", + "member":{"shape":"ReportDefinition"}, + "documentation":"

A list of report definitions.

" + }, + "ReportFormat":{ + "type":"string", + "documentation":"

The format that AWS saves the report in.

", + "enum":[ + "textORcsv", + "Parquet" + ] + }, + "ReportLimitReachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

This account already has five reports defined. To define a new report, you must delete an existing report.

", + "exception":true + }, + "ReportName":{ + "type":"string", + "documentation":"

The name of the report that you want to create. The name must be unique, is case sensitive, and can't include spaces.

", + "max":256, + "pattern":"[0-9A-Za-z!\\-_.*\\'()]+" + }, + "ReportVersioning":{ + "type":"string", + "enum":[ + "CREATE_NEW_REPORT", + "OVERWRITE_REPORT" + ] + }, + "S3Bucket":{ + "type":"string", + "documentation":"

The S3 bucket where AWS delivers the report.

", + "max":256 + }, + "S3Prefix":{ + "type":"string", + "documentation":"

The prefix that AWS adds to the report name when AWS delivers the report. Your prefix can't include spaces.

", + "max":256, + "pattern":"[0-9A-Za-z!\\-_.*\\'()/]*" + }, + "SchemaElement":{ + "type":"string", + "documentation":"

Whether or not AWS includes resource IDs in the report.

", + "enum":["RESOURCES"] + }, + "SchemaElementList":{ + "type":"list", + "member":{"shape":"SchemaElement"}, + "documentation":"

A list of strings that indicate the content that is included in the report, such as service or usage type.

" + }, + "TimeUnit":{ + "type":"string", + "documentation":"

The length of time covered by the report.

", + "enum":[ + "HOURLY", + "DAILY" + ] + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

", + "exception":true + } + }, + "documentation":"

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.

AWS Cost and Usage reports track the monthly AWS costs and usage associated with your AWS account. The report contains line items for each unique combination of AWS product, usage type, and operation that your AWS account uses. You can configure the AWS Cost and Usage report to show only the data that you want, using the AWS Cost and Usage API.

Service Endpoint

The AWS Cost and Usage Report API provides the following endpoint:

  • cur.us-east-1.amazonaws.com

" +} diff --git a/aws/dist/botocore/data/datapipeline/2012-10-29/paginators-1.json b/aws/dist/botocore/data/datapipeline/2012-10-29/paginators-1.json new file mode 100644 index 00000000..c859c9fb --- /dev/null +++ b/aws/dist/botocore/data/datapipeline/2012-10-29/paginators-1.json @@ -0,0 +1,23 @@ +{ + "pagination": { + "ListPipelines": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineIdList" + }, + "DescribeObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "result_key": "pipelineObjects" + }, + "QueryObjects": { + "input_token": "marker", + "output_token": "marker", + "more_results": "hasMoreResults", + "limit_key": "limit", + "result_key": "ids" + } + } +} diff --git a/aws/dist/botocore/data/datapipeline/2012-10-29/service-2.json b/aws/dist/botocore/data/datapipeline/2012-10-29/service-2.json new file mode 100644 index 00000000..55298952 --- /dev/null +++ b/aws/dist/botocore/data/datapipeline/2012-10-29/service-2.json @@ -0,0 +1,1779 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-10-29", + "endpointPrefix":"datapipeline", + "jsonVersion":"1.1", + "serviceFullName":"AWS Data Pipeline", + "serviceId":"Data Pipeline", + "signatureVersion":"v4", + "targetPrefix":"DataPipeline", + "protocol":"json", + "uid":"datapipeline-2012-10-29" + }, + "documentation":"

AWS Data Pipeline configures and manages a data-driven workflow called a pipeline. AWS Data Pipeline handles the details of scheduling and ensuring that data dependencies are met so that your application can focus on processing the data.

AWS Data Pipeline provides a JAR implementation of a task runner called AWS Data Pipeline Task Runner. AWS Data Pipeline Task Runner provides logic for common data management scenarios, such as performing database queries and running data analysis using Amazon Elastic MapReduce (Amazon EMR). You can use AWS Data Pipeline Task Runner as your task runner, or you can write your own task runner to provide custom data management.

AWS Data Pipeline implements two main sets of functionality. Use the first set to create a pipeline and define data sources, schedules, dependencies, and the transforms to be performed on the data. Use the second set in your task runner application to receive the next task ready for processing. The logic for performing the task, such as querying the data, running data analysis, or converting the data from one format to another, is contained within the task runner. The task runner performs the task assigned to it by the web service, reporting progress to the web service as it does so. When the task is done, the task runner reports the final success or failure of the task to the web service.

", + "operations":{ + "ActivatePipeline":{ + "name":"ActivatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ActivatePipelineInput", + "documentation":"

Contains the parameters for ActivatePipeline.

" + }, + "output":{ + "shape":"ActivatePipelineOutput", + "documentation":"

Contains the output of ActivatePipeline.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Validates the specified pipeline and starts processing pipeline tasks. If the pipeline does not pass validation, activation fails.

If you need to pause the pipeline to investigate an issue with a component, such as a data source or script, call DeactivatePipeline.

To activate a finished pipeline, modify the end date for the pipeline and then activate it.

" + }, + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsInput", + "documentation":"

Contains the parameters for AddTags.

" + }, + "output":{ + "shape":"AddTagsOutput", + "documentation":"

Contains the output of AddTags.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Adds or modifies tags for the specified pipeline.

" + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreatePipelineInput", + "documentation":"

Contains the parameters for CreatePipeline.

" + }, + "output":{ + "shape":"CreatePipelineOutput", + "documentation":"

Contains the output of CreatePipeline.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Creates a new, empty pipeline. Use PutPipelineDefinition to populate the pipeline.

" + }, + "DeactivatePipeline":{ + "name":"DeactivatePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeactivatePipelineInput", + "documentation":"

Contains the parameters for DeactivatePipeline.

" + }, + "output":{ + "shape":"DeactivatePipelineOutput", + "documentation":"

Contains the output of DeactivatePipeline.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Deactivates the specified running pipeline. The pipeline is set to the DEACTIVATING state until the deactivation process completes.

To resume a deactivated pipeline, use ActivatePipeline. By default, the pipeline resumes from the last completed execution. Optionally, you can specify the date and time to resume the pipeline.

" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeletePipelineInput", + "documentation":"

Contains the parameters for DeletePipeline.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Deletes a pipeline, its pipeline definition, and its run history. AWS Data Pipeline attempts to cancel instances associated with the pipeline that are currently being processed by task runners.

Deleting a pipeline cannot be undone. You cannot query or restore a deleted pipeline. To temporarily pause a pipeline instead of deleting it, call SetStatus with the status set to PAUSE on individual components. Components that are paused by SetStatus can be resumed.

" + }, + "DescribeObjects":{ + "name":"DescribeObjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeObjectsInput", + "documentation":"

Contains the parameters for DescribeObjects.

" + }, + "output":{ + "shape":"DescribeObjectsOutput", + "documentation":"

Contains the output of DescribeObjects.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Gets the object definitions for a set of objects associated with the pipeline. Object definitions are composed of a set of fields that define the properties of the object.

" + }, + "DescribePipelines":{ + "name":"DescribePipelines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribePipelinesInput", + "documentation":"

Contains the parameters for DescribePipelines.

" + }, + "output":{ + "shape":"DescribePipelinesOutput", + "documentation":"

Contains the output of DescribePipelines.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Retrieves metadata about one or more pipelines. The information retrieved includes the name of the pipeline, the pipeline identifier, its current state, and the user account that owns the pipeline. Using account credentials, you can retrieve metadata about pipelines that you or your IAM users have created. If you are using an IAM user account, you can retrieve metadata about only those pipelines for which you have read permissions.

To retrieve the full pipeline definition instead of metadata about the pipeline, call GetPipelineDefinition.

" + }, + "EvaluateExpression":{ + "name":"EvaluateExpression", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EvaluateExpressionInput", + "documentation":"

Contains the parameters for EvaluateExpression.

" + }, + "output":{ + "shape":"EvaluateExpressionOutput", + "documentation":"

Contains the output of EvaluateExpression.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Task runners call EvaluateExpression to evaluate a string in the context of the specified object. For example, a task runner can evaluate SQL queries stored in Amazon S3.

" + }, + "GetPipelineDefinition":{ + "name":"GetPipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"GetPipelineDefinitionInput", + "documentation":"

Contains the parameters for GetPipelineDefinition.

" + }, + "output":{ + "shape":"GetPipelineDefinitionOutput", + "documentation":"

Contains the output of GetPipelineDefinition.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Gets the definition of the specified pipeline. You can call GetPipelineDefinition to retrieve the pipeline definition that you provided using PutPipelineDefinition.

" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListPipelinesInput", + "documentation":"

Contains the parameters for ListPipelines.

" + }, + "output":{ + "shape":"ListPipelinesOutput", + "documentation":"

Contains the output of ListPipelines.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Lists the pipeline identifiers for all active pipelines that you have permission to access.

" + }, + "PollForTask":{ + "name":"PollForTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PollForTaskInput", + "documentation":"

Contains the parameters for PollForTask.

" + }, + "output":{ + "shape":"PollForTaskOutput", + "documentation":"

Contains the output of PollForTask.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + } + ], + "documentation":"

Task runners call PollForTask to receive a task to perform from AWS Data Pipeline. The task runner specifies which tasks it can perform by setting a value for the workerGroup parameter. The task returned can come from any of the pipelines that match the workerGroup value passed in by the task runner and that was launched using the IAM user credentials specified by the task runner.

If tasks are ready in the work queue, PollForTask returns a response immediately. If no tasks are available in the queue, PollForTask uses long-polling and holds on to a poll connection for up to a 90 seconds, during which time the first newly scheduled task is handed to the task runner. To accomodate this, set the socket timeout in your task runner to 90 seconds. The task runner should not call PollForTask again on the same workerGroup until it receives a response, and this can take up to 90 seconds.

" + }, + "PutPipelineDefinition":{ + "name":"PutPipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutPipelineDefinitionInput", + "documentation":"

Contains the parameters for PutPipelineDefinition.

" + }, + "output":{ + "shape":"PutPipelineDefinitionOutput", + "documentation":"

Contains the output of PutPipelineDefinition.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Adds tasks, schedules, and preconditions to the specified pipeline. You can use PutPipelineDefinition to populate a new pipeline.

PutPipelineDefinition also validates the configuration as it adds it to the pipeline. Changes to the pipeline are saved unless one of the following three validation errors exists in the pipeline.

  1. An object is missing a name or identifier field.
  2. A string or reference field is empty.
  3. The number of objects in the pipeline exceeds the maximum allowed objects.
  4. The pipeline is in a FINISHED state.

Pipeline object definitions are passed to the PutPipelineDefinition action and returned by the GetPipelineDefinition action.

" + }, + "QueryObjects":{ + "name":"QueryObjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"QueryObjectsInput", + "documentation":"

Contains the parameters for QueryObjects.

" + }, + "output":{ + "shape":"QueryObjectsOutput", + "documentation":"

Contains the output of QueryObjects.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Queries the specified pipeline for the names of objects that match the specified set of conditions.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsInput", + "documentation":"

Contains the parameters for RemoveTags.

" + }, + "output":{ + "shape":"RemoveTagsOutput", + "documentation":"

Contains the output of RemoveTags.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Removes existing tags from the specified pipeline.

" + }, + "ReportTaskProgress":{ + "name":"ReportTaskProgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ReportTaskProgressInput", + "documentation":"

Contains the parameters for ReportTaskProgress.

" + }, + "output":{ + "shape":"ReportTaskProgressOutput", + "documentation":"

Contains the output of ReportTaskProgress.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Task runners call ReportTaskProgress when assigned a task to acknowledge that it has the task. If the web service does not receive this acknowledgement within 2 minutes, it assigns the task in a subsequent PollForTask call. After this initial acknowledgement, the task runner only needs to report progress every 15 minutes to maintain its ownership of the task. You can change this reporting time from 15 minutes by specifying a reportProgressTimeout field in your pipeline.

If a task runner does not report its status after 5 minutes, AWS Data Pipeline assumes that the task runner is unable to process the task and reassigns the task in a subsequent response to PollForTask. Task runners should call ReportTaskProgress every 60 seconds.

" + }, + "ReportTaskRunnerHeartbeat":{ + "name":"ReportTaskRunnerHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ReportTaskRunnerHeartbeatInput", + "documentation":"

Contains the parameters for ReportTaskRunnerHeartbeat.

" + }, + "output":{ + "shape":"ReportTaskRunnerHeartbeatOutput", + "documentation":"

Contains the output of ReportTaskRunnerHeartbeat.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

" + }, + "SetStatus":{ + "name":"SetStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetStatusInput", + "documentation":"

Contains the parameters for SetStatus.

" + }, + "errors":[ + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + } + ], + "documentation":"

Requests that the status of the specified physical or logical pipeline objects be updated in the specified pipeline. This update might not occur immediately, but is eventually consistent. The status that can be set depends on the type of object (for example, DataNode or Activity). You cannot perform this operation on FINISHED pipelines and attempting to do so returns InvalidRequestException.

" + }, + "SetTaskStatus":{ + "name":"SetTaskStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"SetTaskStatusInput", + "documentation":"

Contains the parameters for SetTaskStatus.

" + }, + "output":{ + "shape":"SetTaskStatusOutput", + "documentation":"

Contains the output of SetTaskStatus.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"TaskNotFoundException", + "exception":true, + "documentation":"

The specified task was not found.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Task runners call SetTaskStatus to notify AWS Data Pipeline that a task is completed and provide information about the final status. A task runner makes this call regardless of whether the task was sucessful. A task runner does not need to call SetTaskStatus for tasks that are canceled by the web service during a call to ReportTaskProgress.

" + }, + "ValidatePipelineDefinition":{ + "name":"ValidatePipelineDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ValidatePipelineDefinitionInput", + "documentation":"

Contains the parameters for ValidatePipelineDefinition.

" + }, + "output":{ + "shape":"ValidatePipelineDefinitionOutput", + "documentation":"

Contains the output of ValidatePipelineDefinition.

" + }, + "errors":[ + { + "shape":"InternalServiceError", + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + { + "shape":"InvalidRequestException", + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + { + "shape":"PipelineNotFoundException", + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + { + "shape":"PipelineDeletedException", + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + } + ], + "documentation":"

Validates the specified pipeline definition to ensure that it is well formed and can be run without error.

" + } + }, + "shapes":{ + "ActivatePipelineInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "parameterValues":{ + "shape":"ParameterValueList", + "documentation":"

A list of parameter values to pass to the pipeline at activation.

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

The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.

" + } + }, + "documentation":"

Contains the parameters for ActivatePipeline.

" + }, + "ActivatePipelineOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of ActivatePipeline.

" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "tags" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "tags":{ + "shape":"tagList", + "documentation":"

The tags to add, as key/value pairs.

" + } + }, + "documentation":"

Contains the parameters for AddTags.

" + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of AddTags.

" + }, + "CreatePipelineInput":{ + "type":"structure", + "required":[ + "name", + "uniqueId" + ], + "members":{ + "name":{ + "shape":"id", + "documentation":"

The name for the pipeline. You can use the same name for multiple pipelines associated with your AWS account, because AWS Data Pipeline assigns each pipeline a unique pipeline identifier.

" + }, + "uniqueId":{ + "shape":"id", + "documentation":"

A unique identifier. This identifier is not the same as the pipeline identifier assigned by AWS Data Pipeline. You are responsible for defining the format and ensuring the uniqueness of this identifier. You use this parameter to ensure idempotency during repeated calls to CreatePipeline. For example, if the first call to CreatePipeline does not succeed, you can pass in the same unique identifier and pipeline name combination on a subsequent call to CreatePipeline. CreatePipeline ensures that if a pipeline already exists with the same name and unique identifier, a new pipeline is not created. Instead, you'll receive the pipeline identifier from the previous attempt. The uniqueness of the name and unique identifier combination is scoped to the AWS account or IAM user credentials.

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

The description for the pipeline.

" + }, + "tags":{ + "shape":"tagList", + "documentation":"

A list of tags to associate with the pipeline at creation. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" + } + }, + "documentation":"

Contains the parameters for CreatePipeline.

" + }, + "CreatePipelineOutput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.

" + } + }, + "documentation":"

Contains the output of CreatePipeline.

" + }, + "DeactivatePipelineInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "cancelActive":{ + "shape":"cancelActive", + "documentation":"

Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.

" + } + }, + "documentation":"

Contains the parameters for DeactivatePipeline.

" + }, + "DeactivatePipelineOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of DeactivatePipeline.

" + }, + "DeletePipelineInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + } + }, + "documentation":"

Contains the parameters for DeletePipeline.

" + }, + "DescribeObjectsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectIds" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline that contains the object definitions.

" + }, + "objectIds":{ + "shape":"idList", + "documentation":"

The IDs of the pipeline objects that contain the definitions to be described. You can pass as many as 25 identifiers in a single call to DescribeObjects.

" + }, + "evaluateExpressions":{ + "shape":"boolean", + "documentation":"

Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call DescribeObjects with the marker value from the previous call to retrieve the next set of results.

" + } + }, + "documentation":"

Contains the parameters for DescribeObjects.

" + }, + "DescribeObjectsOutput":{ + "type":"structure", + "required":["pipelineObjects"], + "members":{ + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

An array of object definitions.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the next page of results. To view the next page of results, call DescribeObjects again with this marker value. If the value is null, there are no more results.

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

Indicates whether there are more results to return.

" + } + }, + "documentation":"

Contains the output of DescribeObjects.

" + }, + "DescribePipelinesInput":{ + "type":"structure", + "required":["pipelineIds"], + "members":{ + "pipelineIds":{ + "shape":"idList", + "documentation":"

The IDs of the pipelines to describe. You can pass as many as 25 identifiers in a single call. To obtain pipeline IDs, call ListPipelines.

" + } + }, + "documentation":"

Contains the parameters for DescribePipelines.

" + }, + "DescribePipelinesOutput":{ + "type":"structure", + "required":["pipelineDescriptionList"], + "members":{ + "pipelineDescriptionList":{ + "shape":"PipelineDescriptionList", + "documentation":"

An array of descriptions for the specified pipelines.

" + } + }, + "documentation":"

Contains the output of DescribePipelines.

" + }, + "EvaluateExpressionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectId", + "expression" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "objectId":{ + "shape":"id", + "documentation":"

The ID of the object.

" + }, + "expression":{ + "shape":"longString", + "documentation":"

The expression to evaluate.

" + } + }, + "documentation":"

Contains the parameters for EvaluateExpression.

" + }, + "EvaluateExpressionOutput":{ + "type":"structure", + "required":["evaluatedExpression"], + "members":{ + "evaluatedExpression":{ + "shape":"longString", + "documentation":"

The evaluated expression.

" + } + }, + "documentation":"

Contains the output of EvaluateExpression.

" + }, + "Field":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"fieldNameString", + "documentation":"

The field identifier.

" + }, + "stringValue":{ + "shape":"fieldStringValue", + "documentation":"

The field value, expressed as a String.

" + }, + "refValue":{ + "shape":"fieldNameString", + "documentation":"

The field value, expressed as the identifier of another object.

" + } + }, + "documentation":"

A key-value pair that describes a property of a pipeline object. The value is specified as either a string value (StringValue) or a reference to another object (RefValue) but not as both.

" + }, + "GetPipelineDefinitionInput":{ + "type":"structure", + "required":["pipelineId"], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

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

The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.

" + } + }, + "documentation":"

Contains the parameters for GetPipelineDefinition.

" + }, + "GetPipelineDefinitionOutput":{ + "type":"structure", + "members":{ + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

The objects defined in the pipeline.

" + }, + "parameterObjects":{ + "shape":"ParameterObjectList", + "documentation":"

The parameter objects used in the pipeline definition.

" + }, + "parameterValues":{ + "shape":"ParameterValueList", + "documentation":"

The parameter values used in the pipeline definition.

" + } + }, + "documentation":"

Contains the output of GetPipelineDefinition.

" + }, + "InstanceIdentity":{ + "type":"structure", + "members":{ + "document":{ + "shape":"string", + "documentation":"

A description of an EC2 instance that is generated when the instance is launched and exposed to the instance via the instance metadata service in the form of a JSON representation of an object.

" + }, + "signature":{ + "shape":"string", + "documentation":"

A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.

" + } + }, + "documentation":"

Identity information for the EC2 instance that is hosting the task runner. You can get this value by calling a metadata URI from the EC2 instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" + }, + "InternalServiceError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "fault":true, + "documentation":"

An internal service error occurred.

" + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The request was not valid. Verify that your request was properly formatted, that the signature was generated with the correct credentials, and that you haven't exceeded any of the service limits for your account.

" + }, + "ListPipelinesInput":{ + "type":"structure", + "members":{ + "marker":{ + "shape":"string", + "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call ListPipelines with the marker value from the previous call to retrieve the next set of results.

" + } + }, + "documentation":"

Contains the parameters for ListPipelines.

" + }, + "ListPipelinesOutput":{ + "type":"structure", + "required":["pipelineIdList"], + "members":{ + "pipelineIdList":{ + "shape":"pipelineList", + "documentation":"

The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the next page of results. To view the next page of results, call ListPipelinesOutput again with this marker value. If the value is null, there are no more results.

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

Indicates whether there are more results that can be obtained by a subsequent call.

" + } + }, + "documentation":"

Contains the output of ListPipelines.

" + }, + "Operator":{ + "type":"structure", + "members":{ + "type":{ + "shape":"OperatorType", + "documentation":"

The logical operation to be performed: equal (EQ), equal reference (REF_EQ), less than or equal (LE), greater than or equal (GE), or between (BETWEEN). Equal reference (REF_EQ) can be used only with reference fields. The other comparison types can be used only with String fields. The comparison types you can use apply only to certain object fields, as detailed below.

The comparison operators EQ and REF_EQ act on the following fields:

  • name
  • @sphere
  • parent
  • @componentParent
  • @instanceParent
  • @status
  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

The comparison operators GE, LE, and BETWEEN act on the following fields:

  • @scheduledStartTime
  • @scheduledEndTime
  • @actualStartTime
  • @actualEndTime

Note that fields beginning with the at sign (@) are read-only and set by the web service. When you name fields, you should choose names containing only alpha-numeric values, as symbols may be reserved by AWS Data Pipeline. User-defined fields that you add to a pipeline should prefix their name with the string \"my\".

" + }, + "values":{ + "shape":"stringList", + "documentation":"

The value that the actual field value will be compared with.

" + } + }, + "documentation":"

Contains a logical operation for comparing the value of a field with a specified value.

" + }, + "OperatorType":{ + "type":"string", + "enum":[ + "EQ", + "REF_EQ", + "LE", + "GE", + "BETWEEN" + ] + }, + "ParameterAttribute":{ + "type":"structure", + "required":[ + "key", + "stringValue" + ], + "members":{ + "key":{ + "shape":"attributeNameString", + "documentation":"

The field identifier.

" + }, + "stringValue":{ + "shape":"attributeValueString", + "documentation":"

The field value, expressed as a String.

" + } + }, + "documentation":"

The attributes allowed or specified with a parameter object.

" + }, + "ParameterAttributeList":{ + "type":"list", + "member":{"shape":"ParameterAttribute"} + }, + "ParameterObject":{ + "type":"structure", + "required":[ + "id", + "attributes" + ], + "members":{ + "id":{ + "shape":"fieldNameString", + "documentation":"

The ID of the parameter object.

" + }, + "attributes":{ + "shape":"ParameterAttributeList", + "documentation":"

The attributes of the parameter object.

" + } + }, + "documentation":"

Contains information about a parameter object.

" + }, + "ParameterObjectList":{ + "type":"list", + "member":{"shape":"ParameterObject"} + }, + "ParameterValue":{ + "type":"structure", + "required":[ + "id", + "stringValue" + ], + "members":{ + "id":{ + "shape":"fieldNameString", + "documentation":"

The ID of the parameter value.

" + }, + "stringValue":{ + "shape":"fieldStringValue", + "documentation":"

The field value, expressed as a String.

" + } + }, + "documentation":"

A value or list of parameter values.

" + }, + "ParameterValueList":{ + "type":"list", + "member":{"shape":"ParameterValue"} + }, + "PipelineDeletedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified pipeline has been deleted.

" + }, + "PipelineDescription":{ + "type":"structure", + "required":[ + "pipelineId", + "name", + "fields" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" + }, + "name":{ + "shape":"id", + "documentation":"

The name of the pipeline.

" + }, + "fields":{ + "shape":"fieldList", + "documentation":"

A list of read-only fields that contain metadata about the pipeline: @userId, @accountId, and @pipelineState.

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

Description of the pipeline.

" + }, + "tags":{ + "shape":"tagList", + "documentation":"

A list of tags to associated with a pipeline. Tags let you control access to pipelines. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" + } + }, + "documentation":"

Contains pipeline metadata.

" + }, + "PipelineDescriptionList":{ + "type":"list", + "member":{"shape":"PipelineDescription"} + }, + "PipelineIdName":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

" + }, + "name":{ + "shape":"id", + "documentation":"

The name of the pipeline.

" + } + }, + "documentation":"

Contains the name and identifier of a pipeline.

" + }, + "PipelineNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified pipeline was not found. Verify that you used the correct user and account identifiers.

" + }, + "PipelineObject":{ + "type":"structure", + "required":[ + "id", + "name", + "fields" + ], + "members":{ + "id":{ + "shape":"id", + "documentation":"

The ID of the object.

" + }, + "name":{ + "shape":"id", + "documentation":"

The name of the object.

" + }, + "fields":{ + "shape":"fieldList", + "documentation":"

Key-value pairs that define the properties of the object.

" + } + }, + "documentation":"

Contains information about a pipeline object. This can be a logical, physical, or physical attempt pipeline object. The complete set of components of a pipeline defines the pipeline.

" + }, + "PipelineObjectList":{ + "type":"list", + "member":{"shape":"PipelineObject"} + }, + "PipelineObjectMap":{ + "type":"map", + "key":{"shape":"id"}, + "value":{"shape":"PipelineObject"} + }, + "PollForTaskInput":{ + "type":"structure", + "required":["workerGroup"], + "members":{ + "workerGroup":{ + "shape":"string", + "documentation":"

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup in the call to PollForTask. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

" + }, + "hostname":{ + "shape":"id", + "documentation":"

The public DNS name of the calling task runner.

" + }, + "instanceIdentity":{ + "shape":"InstanceIdentity", + "documentation":"

Identity information for the EC2 instance that is hosting the task runner. You can get this value from the instance using http://169.254.169.254/latest/meta-data/instance-id. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide. Passing in this value proves that your task runner is running on an EC2 instance, and ensures the proper AWS Data Pipeline service charges are applied to your pipeline.

" + } + }, + "documentation":"

Contains the parameters for PollForTask.

" + }, + "PollForTaskOutput":{ + "type":"structure", + "members":{ + "taskObject":{ + "shape":"TaskObject", + "documentation":"

The information needed to complete the task that is being assigned to the task runner. One of the fields returned in this object is taskId, which contains an identifier for the task being assigned. The calling task runner uses taskId in subsequent calls to ReportTaskProgress and SetTaskStatus.

" + } + }, + "documentation":"

Contains the output of PollForTask.

" + }, + "PutPipelineDefinitionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "pipelineObjects" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

" + }, + "parameterObjects":{ + "shape":"ParameterObjectList", + "documentation":"

The parameter objects used with the pipeline.

" + }, + "parameterValues":{ + "shape":"ParameterValueList", + "documentation":"

The parameter values used with the pipeline.

" + } + }, + "documentation":"

Contains the parameters for PutPipelineDefinition.

" + }, + "PutPipelineDefinitionOutput":{ + "type":"structure", + "required":["errored"], + "members":{ + "validationErrors":{ + "shape":"ValidationErrors", + "documentation":"

The validation errors that are associated with the objects defined in pipelineObjects.

" + }, + "validationWarnings":{ + "shape":"ValidationWarnings", + "documentation":"

The validation warnings that are associated with the objects defined in pipelineObjects.

" + }, + "errored":{ + "shape":"boolean", + "documentation":"

Indicates whether there were validation errors, and the pipeline definition is stored but cannot be activated until you correct the pipeline and call PutPipelineDefinition to commit the corrected pipeline.

" + } + }, + "documentation":"

Contains the output of PutPipelineDefinition.

" + }, + "Query":{ + "type":"structure", + "members":{ + "selectors":{ + "shape":"SelectorList", + "documentation":"

List of selectors that define the query. An object must satisfy all of the selectors to match the query.

" + } + }, + "documentation":"

Defines the query to run against an object.

" + }, + "QueryObjectsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "sphere" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "query":{ + "shape":"Query", + "documentation":"

The query that defines the objects to be returned. The Query object can contain a maximum of ten selectors. The conditions in the query are limited to top-level String fields in the object. These filters can be applied to components, instances, and attempts.

" + }, + "sphere":{ + "shape":"string", + "documentation":"

Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the results to be returned. For the first call, this value should be empty. As long as there are more results, continue to call QueryObjects with the marker value from the previous call to retrieve the next set of results.

" + }, + "limit":{ + "shape":"int", + "documentation":"

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

" + } + }, + "documentation":"

Contains the parameters for QueryObjects.

" + }, + "QueryObjectsOutput":{ + "type":"structure", + "members":{ + "ids":{ + "shape":"idList", + "documentation":"

The identifiers that match the query selectors.

" + }, + "marker":{ + "shape":"string", + "documentation":"

The starting point for the next page of results. To view the next page of results, call QueryObjects again with this marker value. If the value is null, there are no more results.

" + }, + "hasMoreResults":{ + "shape":"boolean", + "documentation":"

Indicates whether there are more results that can be obtained by a subsequent call.

" + } + }, + "documentation":"

Contains the output of QueryObjects.

" + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "pipelineId", + "tagKeys" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "tagKeys":{ + "shape":"stringList", + "documentation":"

The keys of the tags to remove.

" + } + }, + "documentation":"

Contains the parameters for RemoveTags.

" + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of RemoveTags.

" + }, + "ReportTaskProgressInput":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

" + }, + "fields":{ + "shape":"fieldList", + "documentation":"

Key-value pairs that define the properties of the ReportTaskProgressInput object.

" + } + }, + "documentation":"

Contains the parameters for ReportTaskProgress.

" + }, + "ReportTaskProgressOutput":{ + "type":"structure", + "required":["canceled"], + "members":{ + "canceled":{ + "shape":"boolean", + "documentation":"

If true, the calling task runner should cancel processing of the task. The task runner does not need to call SetTaskStatus for canceled tasks.

" + } + }, + "documentation":"

Contains the output of ReportTaskProgress.

" + }, + "ReportTaskRunnerHeartbeatInput":{ + "type":"structure", + "required":["taskrunnerId"], + "members":{ + "taskrunnerId":{ + "shape":"id", + "documentation":"

The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

" + }, + "workerGroup":{ + "shape":"string", + "documentation":"

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

" + }, + "hostname":{ + "shape":"id", + "documentation":"

The public DNS name of the task runner.

" + } + }, + "documentation":"

Contains the parameters for ReportTaskRunnerHeartbeat.

" + }, + "ReportTaskRunnerHeartbeatOutput":{ + "type":"structure", + "required":["terminate"], + "members":{ + "terminate":{ + "shape":"boolean", + "documentation":"

Indicates whether the calling task runner should terminate.

" + } + }, + "documentation":"

Contains the output of ReportTaskRunnerHeartbeat.

" + }, + "Selector":{ + "type":"structure", + "members":{ + "fieldName":{ + "shape":"string", + "documentation":"

The name of the field that the operator will be applied to. The field name is the \"key\" portion of the field definition in the pipeline definition syntax that is used by the AWS Data Pipeline API. If the field is not set on the object, the condition fails.

" + }, + "operator":{"shape":"Operator"} + }, + "documentation":"

A comparision that is used to determine whether a query should return this object.

" + }, + "SelectorList":{ + "type":"list", + "member":{"shape":"Selector"}, + "documentation":"

The list of Selectors that define queries on individual fields.

" + }, + "SetStatusInput":{ + "type":"structure", + "required":[ + "pipelineId", + "objectIds", + "status" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline that contains the objects.

" + }, + "objectIds":{ + "shape":"idList", + "documentation":"

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

" + }, + "status":{ + "shape":"string", + "documentation":"

The status to be set on all the objects specified in objectIds. For components, use PAUSE or RESUME. For instances, use TRY_CANCEL, RERUN, or MARK_FINISHED.

" + } + }, + "documentation":"

Contains the parameters for SetStatus.

" + }, + "SetTaskStatusInput":{ + "type":"structure", + "required":[ + "taskId", + "taskStatus" + ], + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

" + }, + "taskStatus":{ + "shape":"TaskStatus", + "documentation":"

If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.

" + }, + "errorId":{ + "shape":"string", + "documentation":"

If an error occurred during the task, this value specifies the error code. This value is set on the physical attempt object. It is used to display error information to the user. It should not start with string \"Service_\" which is reserved by the system.

" + }, + "errorMessage":{ + "shape":"errorMessage", + "documentation":"

If an error occurred during the task, this value specifies a text description of the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + }, + "errorStackTrace":{ + "shape":"string", + "documentation":"

If an error occurred during the task, this value specifies the stack trace associated with the error. This value is set on the physical attempt object. It is used to display error information to the user. The web service does not parse this value.

" + } + }, + "documentation":"

Contains the parameters for SetTaskStatus.

" + }, + "SetTaskStatusOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of SetTaskStatus.

" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"tagKey", + "documentation":"

The key name of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" + }, + "value":{ + "shape":"tagValue", + "documentation":"

The optional value portion of a tag defined by a user. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" + } + }, + "documentation":"

Tags are key/value pairs defined by a user and associated with a pipeline to control access. AWS Data Pipeline allows you to associate ten tags per pipeline. For more information, see Controlling User Access to Pipelines in the AWS Data Pipeline Developer Guide.

" + }, + "TaskNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Description of the error message.

" + } + }, + "exception":true, + "documentation":"

The specified task was not found.

" + }, + "TaskObject":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"taskId", + "documentation":"

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

" + }, + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline that provided the task.

" + }, + "attemptId":{ + "shape":"id", + "documentation":"

The ID of the pipeline task attempt object. AWS Data Pipeline uses this value to track how many times a task is attempted.

" + }, + "objects":{ + "shape":"PipelineObjectMap", + "documentation":"

Connection information for the location where the task runner will publish the output of the task.

" + } + }, + "documentation":"

Contains information about a pipeline task that is assigned to a task runner.

" + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "FINISHED", + "FAILED", + "FALSE" + ] + }, + "ValidatePipelineDefinitionInput":{ + "type":"structure", + "required":[ + "pipelineId", + "pipelineObjects" + ], + "members":{ + "pipelineId":{ + "shape":"id", + "documentation":"

The ID of the pipeline.

" + }, + "pipelineObjects":{ + "shape":"PipelineObjectList", + "documentation":"

The objects that define the pipeline changes to validate against the pipeline.

" + }, + "parameterObjects":{ + "shape":"ParameterObjectList", + "documentation":"

The parameter objects used with the pipeline.

" + }, + "parameterValues":{ + "shape":"ParameterValueList", + "documentation":"

The parameter values used with the pipeline.

" + } + }, + "documentation":"

Contains the parameters for ValidatePipelineDefinition.

" + }, + "ValidatePipelineDefinitionOutput":{ + "type":"structure", + "required":["errored"], + "members":{ + "validationErrors":{ + "shape":"ValidationErrors", + "documentation":"

Any validation errors that were found.

" + }, + "validationWarnings":{ + "shape":"ValidationWarnings", + "documentation":"

Any validation warnings that were found.

" + }, + "errored":{ + "shape":"boolean", + "documentation":"

Indicates whether there were validation errors.

" + } + }, + "documentation":"

Contains the output of ValidatePipelineDefinition.

" + }, + "ValidationError":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

The identifier of the object that contains the validation error.

" + }, + "errors":{ + "shape":"validationMessages", + "documentation":"

A description of the validation error.

" + } + }, + "documentation":"

Defines a validation error. Validation errors prevent pipeline activation. The set of validation errors that can be returned are defined by AWS Data Pipeline.

" + }, + "ValidationErrors":{ + "type":"list", + "member":{"shape":"ValidationError"} + }, + "ValidationWarning":{ + "type":"structure", + "members":{ + "id":{ + "shape":"id", + "documentation":"

The identifier of the object that contains the validation warning.

" + }, + "warnings":{ + "shape":"validationMessages", + "documentation":"

A description of the validation warning.

" + } + }, + "documentation":"

Defines a validation warning. Validation warnings do not prevent pipeline activation. The set of validation warnings that can be returned are defined by AWS Data Pipeline.

" + }, + "ValidationWarnings":{ + "type":"list", + "member":{"shape":"ValidationWarning"} + }, + "attributeNameString":{ + "type":"string", + "min":1, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "attributeValueString":{ + "type":"string", + "min":0, + "max":10240, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "boolean":{"type":"boolean"}, + "cancelActive":{"type":"boolean"}, + "errorMessage":{"type":"string"}, + "fieldList":{ + "type":"list", + "member":{"shape":"Field"} + }, + "fieldNameString":{ + "type":"string", + "min":1, + "max":256, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "fieldStringValue":{ + "type":"string", + "min":0, + "max":10240, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "id":{ + "type":"string", + "min":1, + "max":1024, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "idList":{ + "type":"list", + "member":{"shape":"id"} + }, + "int":{"type":"integer"}, + "longString":{ + "type":"string", + "min":0, + "max":20971520, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "pipelineList":{ + "type":"list", + "member":{"shape":"PipelineIdName"} + }, + "string":{ + "type":"string", + "min":0, + "max":1024, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "stringList":{ + "type":"list", + "member":{"shape":"string"} + }, + "tagKey":{ + "type":"string", + "min":1, + "max":128 + }, + "tagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":0, + "max":10 + }, + "tagValue":{ + "type":"string", + "min":0, + "max":256 + }, + "taskId":{ + "type":"string", + "min":1, + "max":2048, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "timestamp":{"type":"timestamp"}, + "validationMessage":{ + "type":"string", + "min":0, + "max":10000, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "validationMessages":{ + "type":"list", + "member":{"shape":"validationMessage"} + } + } +} diff --git a/aws/dist/botocore/data/datasync/2018-11-09/paginators-1.json b/aws/dist/botocore/data/datasync/2018-11-09/paginators-1.json new file mode 100644 index 00000000..c6892f78 --- /dev/null +++ b/aws/dist/botocore/data/datasync/2018-11-09/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListAgents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Agents" + }, + "ListLocations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Locations" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + }, + "ListTaskExecutions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TaskExecutions" + }, + "ListTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tasks" + } + } +} diff --git a/aws/dist/botocore/data/datasync/2018-11-09/service-2.json b/aws/dist/botocore/data/datasync/2018-11-09/service-2.json new file mode 100644 index 00000000..819e02fa --- /dev/null +++ b/aws/dist/botocore/data/datasync/2018-11-09/service-2.json @@ -0,0 +1,1964 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-11-09", + "endpointPrefix":"datasync", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"DataSync", + "serviceFullName":"AWS DataSync", + "serviceId":"DataSync", + "signatureVersion":"v4", + "signingName":"datasync", + "targetPrefix":"FmrsService", + "uid":"datasync-2018-11-09" + }, + "operations":{ + "CancelTaskExecution":{ + "name":"CancelTaskExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelTaskExecutionRequest"}, + "output":{"shape":"CancelTaskExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Cancels execution of a task.

When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.

" + }, + "CreateAgent":{ + "name":"CreateAgent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAgentRequest"}, + "output":{"shape":"CreateAgentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.

You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.

" + }, + "CreateLocationEfs":{ + "name":"CreateLocationEfs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocationEfsRequest"}, + "output":{"shape":"CreateLocationEfsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Creates an endpoint for an Amazon EFS file system.

" + }, + "CreateLocationNfs":{ + "name":"CreateLocationNfs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocationNfsRequest"}, + "output":{"shape":"CreateLocationNfsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Defines a file system on a Network File System (NFS) server that can be read from or written to

" + }, + "CreateLocationS3":{ + "name":"CreateLocationS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocationS3Request"}, + "output":{"shape":"CreateLocationS3Response"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Creates an endpoint for an Amazon S3 bucket.

For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.

" + }, + "CreateLocationSmb":{ + "name":"CreateLocationSmb", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLocationSmbRequest"}, + "output":{"shape":"CreateLocationSmbResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Defines a file system on an Server Message Block (SMB) server that can be read from or written to

" + }, + "CreateTask":{ + "name":"CreateTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTaskRequest"}, + "output":{"shape":"CreateTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.

If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.

" + }, + "DeleteAgent":{ + "name":"DeleteAgent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAgentRequest"}, + "output":{"shape":"DeleteAgentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.

" + }, + "DeleteLocation":{ + "name":"DeleteLocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLocationRequest"}, + "output":{"shape":"DeleteLocationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Deletes the configuration of a location used by AWS DataSync.

" + }, + "DeleteTask":{ + "name":"DeleteTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTaskRequest"}, + "output":{"shape":"DeleteTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Deletes a task.

" + }, + "DescribeAgent":{ + "name":"DescribeAgent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAgentRequest"}, + "output":{"shape":"DescribeAgentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.

" + }, + "DescribeLocationEfs":{ + "name":"DescribeLocationEfs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLocationEfsRequest"}, + "output":{"shape":"DescribeLocationEfsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata, such as the path information about an Amazon EFS location.

" + }, + "DescribeLocationNfs":{ + "name":"DescribeLocationNfs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLocationNfsRequest"}, + "output":{"shape":"DescribeLocationNfsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata, such as the path information, about a NFS location.

" + }, + "DescribeLocationS3":{ + "name":"DescribeLocationS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLocationS3Request"}, + "output":{"shape":"DescribeLocationS3Response"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

" + }, + "DescribeLocationSmb":{ + "name":"DescribeLocationSmb", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLocationSmbRequest"}, + "output":{"shape":"DescribeLocationSmbResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata, such as the path and user information about a SMB location.

" + }, + "DescribeTask":{ + "name":"DescribeTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTaskRequest"}, + "output":{"shape":"DescribeTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns metadata about a task.

" + }, + "DescribeTaskExecution":{ + "name":"DescribeTaskExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTaskExecutionRequest"}, + "output":{"shape":"DescribeTaskExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns detailed metadata about a task that is being executed.

" + }, + "ListAgents":{ + "name":"ListAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAgentsRequest"}, + "output":{"shape":"ListAgentsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.

" + }, + "ListLocations":{ + "name":"ListLocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLocationsRequest"}, + "output":{"shape":"ListLocationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns a lists of source and destination locations.

If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns all the tags associated with a specified resources.

" + }, + "ListTaskExecutions":{ + "name":"ListTaskExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTaskExecutionsRequest"}, + "output":{"shape":"ListTaskExecutionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns a list of executed tasks.

" + }, + "ListTasks":{ + "name":"ListTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTasksRequest"}, + "output":{"shape":"ListTasksResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns a list of all the tasks.

" + }, + "StartTaskExecution":{ + "name":"StartTaskExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTaskExecutionRequest"}, + "output":{"shape":"StartTaskExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Applies a key-value pair to an AWS resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Removes a tag from an AWS resource.

" + }, + "UpdateAgent":{ + "name":"UpdateAgent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAgentRequest"}, + "output":{"shape":"UpdateAgentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Updates the name of an agent.

" + }, + "UpdateTask":{ + "name":"UpdateTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTaskRequest"}, + "output":{"shape":"UpdateTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalException"} + ], + "documentation":"

Updates the metadata associated with a task.

" + } + }, + "shapes":{ + "ActivationKey":{ + "type":"string", + "max":29, + "pattern":"[A-Z0-9]{5}(-[A-Z0-9]{5}){4}" + }, + "AgentArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$" + }, + "AgentArnList":{ + "type":"list", + "member":{"shape":"AgentArn"}, + "max":64, + "min":1 + }, + "AgentList":{ + "type":"list", + "member":{"shape":"AgentListEntry"} + }, + "AgentListEntry":{ + "type":"structure", + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of the agent.

" + }, + "Status":{ + "shape":"AgentStatus", + "documentation":"

The status of the agent.

" + } + }, + "documentation":"

Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.

" + }, + "AgentStatus":{ + "type":"string", + "enum":[ + "ONLINE", + "OFFLINE" + ] + }, + "Atime":{ + "type":"string", + "enum":[ + "NONE", + "BEST_EFFORT" + ] + }, + "BytesPerSecond":{ + "type":"long", + "min":-1 + }, + "CancelTaskExecutionRequest":{ + "type":"structure", + "required":["TaskExecutionArn"], + "members":{ + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the task execution to cancel.

" + } + }, + "documentation":"

CancelTaskExecutionRequest

" + }, + "CancelTaskExecutionResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateAgentRequest":{ + "type":"structure", + "required":["ActivationKey"], + "members":{ + "ActivationKey":{ + "shape":"ActivationKey", + "documentation":"

Your agent activation key. You can get the activation key either by sending an HTTP GET request with redirects that enable you to get the agent IP address (port 80). Alternatively, you can get it from the AWS DataSync console.

The redirect URL returned in the response provides you the activation key for your agent in the query string parameter activationKey. It might also include other activation-related parameters; however, these are merely defaults. The arguments you pass to this API call determine the actual configuration of your agent.

For more information, see Activating an Agent in the AWS DataSync User Guide.

" + }, + "AgentName":{ + "shape":"TagValue", + "documentation":"

The name you configured for your agent. This value is a text reference that is used to identify the agent in the console.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents the tag that you want to associate with the agent. The value can be an empty string. This value helps you manage, filter, and search for your agents.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @.

" + }, + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"

The ID of the VPC (Virtual Private Cloud) endpoint that the agent has access to. This is the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service Configuration in the AWS VPC User Guide.

VPC endpoint ID looks like this: vpce-01234d5aff67890e1.

" + }, + "SubnetArns":{ + "shape":"PLSubnetArnList", + "documentation":"

The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic network interfaces for each data transfer task. The agent that runs a task must be private. When you start a task that is associated with an agent created in a VPC, or one that has access to an IP address in a VPC, then the task is also private. In this case, DataSync creates four network interfaces for each task in your subnet. For a data transfer to work, the agent must be able to route to all these four network interfaces.

" + }, + "SecurityGroupArns":{ + "shape":"PLSecurityGroupArnList", + "documentation":"

The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.

" + } + }, + "documentation":"

CreateAgentRequest

" + }, + "CreateAgentResponse":{ + "type":"structure", + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to return a list of agents for your account and AWS Region.

" + } + }, + "documentation":"

CreateAgentResponse

" + }, + "CreateLocationEfsRequest":{ + "type":"structure", + "required":[ + "EfsFilesystemArn", + "Ec2Config" + ], + "members":{ + "Subdirectory":{ + "shape":"Subdirectory", + "documentation":"

A subdirectory in the location’s path. This subdirectory in the EFS file system is used to read data from the EFS source location or write data to the EFS destination. By default, AWS DataSync uses the root directory.

" + }, + "EfsFilesystemArn":{ + "shape":"EfsFilesystemArn", + "documentation":"

The Amazon Resource Name (ARN) for the Amazon EFS file system.

" + }, + "Ec2Config":{ + "shape":"Ec2Config", + "documentation":"

The subnet and security group that the Amazon EFS file system uses. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

The exact relationship between security group M (of the mount target) and security group S (which you provide for DataSync to use at this stage) is as follows:

  • Security group M (which you associate with the mount target) must allow inbound access for the Transmission Control Protocol (TCP) on the NFS port (2049) from security group S. You can enable inbound connections either by IP address (CIDR range) or security group.

  • Security group S (provided to DataSync to access EFS) should have a rule that enables outbound connections to the NFS port on one of the file system’s mount targets. You can enable outbound connections either by IP address (CIDR range) or security group.

    For information about security groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount Targets in the Amazon EFS User Guide.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.

" + } + }, + "documentation":"

CreateLocationEfsRequest

" + }, + "CreateLocationEfsResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon EFS file system location that is created.

" + } + }, + "documentation":"

CreateLocationEfs

" + }, + "CreateLocationNfsRequest":{ + "type":"structure", + "required":[ + "Subdirectory", + "ServerHostname", + "OnPremConfig" + ], + "members":{ + "Subdirectory":{ + "shape":"NonEmptySubdirectory", + "documentation":"

The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.

To see all the paths exported by your NFS server. run \"showmount -e nfs-server-name\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication.

To transfer all the data in the folder you specified, DataSync needs to have permissions to read all the data. To ensure this, either configure the NFS export with no_root_squash, or ensure that the permissions for all of the files that you want DataSync allow read access for all users. Doing either enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.

For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.

" + }, + "ServerHostname":{ + "shape":"ServerHostname", + "documentation":"

The name of the NFS server. This value is the IP address or Domain Name Service (DNS) name of the NFS server. An agent that is installed on-premises uses this host name to mount the NFS server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

" + }, + "OnPremConfig":{ + "shape":"OnPremConfig", + "documentation":"

Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to an NFS server.

" + }, + "MountOptions":{ + "shape":"NfsMountOptions", + "documentation":"

The NFS mount options that DataSync can use to mount your NFS share.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

" + } + }, + "documentation":"

CreateLocationNfsRequest

" + }, + "CreateLocationNfsResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the source NFS file system location that is created.

" + } + }, + "documentation":"

CreateLocationNfsResponse

" + }, + "CreateLocationS3Request":{ + "type":"structure", + "required":[ + "S3BucketArn", + "S3Config" + ], + "members":{ + "Subdirectory":{ + "shape":"Subdirectory", + "documentation":"

A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.

" + }, + "S3BucketArn":{ + "shape":"S3BucketArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 bucket.

" + }, + "S3StorageClass":{ + "shape":"S3StorageClass", + "documentation":"

The Amazon S3 storage class that you want to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

" + }, + "S3Config":{"shape":"S3Config"}, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

" + } + }, + "documentation":"

CreateLocationS3Request

" + }, + "CreateLocationS3Response":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is created.

" + } + }, + "documentation":"

CreateLocationS3Response

" + }, + "CreateLocationSmbRequest":{ + "type":"structure", + "required":[ + "Subdirectory", + "ServerHostname", + "User", + "Password", + "AgentArns" + ], + "members":{ + "Subdirectory":{ + "shape":"NonEmptySubdirectory", + "documentation":"

The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.

To transfer all the data in the folder you specified, DataSync needs to have permissions to mount the SMB share, as well as to access all the data in that share. To ensure this, either ensure that the user/password specified belongs to the user who can mount the share, and who has the appropriate permissions for all of the files and directories that you want DataSync to access, or use credentials of a member of the Backup Operators group to mount the share. Doing either enables the agent to access the data. For the agent to access directories, you must additionally enable all execute access.

" + }, + "ServerHostname":{ + "shape":"ServerHostname", + "documentation":"

The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB server in a network.

This name must either be DNS-compliant or must be an IP version 4 (IPv4) address.

" + }, + "User":{ + "shape":"SmbUser", + "documentation":"

The user who can mount the share, has the permissions to access files and folders in the SMB share.

" + }, + "Domain":{ + "shape":"SmbDomain", + "documentation":"

The name of the Windows domain that the SMB server belongs to.

" + }, + "Password":{ + "shape":"SmbPassword", + "documentation":"

The password of the user who can mount the share, has the permissions to access files and folders in the SMB share.

" + }, + "AgentArns":{ + "shape":"AgentArnList", + "documentation":"

The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.

" + }, + "MountOptions":{ + "shape":"SmbMountOptions", + "documentation":"

The mount options used by DataSync to access the SMB server.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents the tag that you want to add to the location. The value can be an empty string. We recommend using tags to name your resources.

" + } + }, + "documentation":"

CreateLocationSmbRequest

" + }, + "CreateLocationSmbResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

" + } + }, + "documentation":"

CreateLocationSmbResponse

" + }, + "CreateTaskRequest":{ + "type":"structure", + "required":[ + "SourceLocationArn", + "DestinationLocationArn" + ], + "members":{ + "SourceLocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the source location for the task.

" + }, + "DestinationLocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of an AWS storage resource's location.

" + }, + "CloudWatchLogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

For more information about how to use CloudWatch Logs with DataSync, see Monitoring Your Task in the AWS DataSync User Guide.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of a task. This value is a text reference that is used to identify the task in the console.

" + }, + "Options":{ + "shape":"Options", + "documentation":"

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the OverrideOptions before starting a the task execution. For more information, see the operation.

" + }, + "Excludes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\"

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pair that represents the tag that you want to add to the resource. The value can be an empty string.

" + } + }, + "documentation":"

CreateTaskRequest

" + }, + "CreateTaskResponse":{ + "type":"structure", + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task.

" + } + }, + "documentation":"

CreateTaskResponse

" + }, + "DeleteAgentRequest":{ + "type":"structure", + "required":["AgentArn"], + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents operation to return a list of agents for your account and AWS Region.

" + } + }, + "documentation":"

DeleteAgentRequest

" + }, + "DeleteAgentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteLocationRequest":{ + "type":"structure", + "required":["LocationArn"], + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the location to delete.

" + } + }, + "documentation":"

DeleteLocation

" + }, + "DeleteLocationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTaskRequest":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task to delete.

" + } + }, + "documentation":"

DeleteTask

" + }, + "DeleteTaskResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeAgentRequest":{ + "type":"structure", + "required":["AgentArn"], + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent to describe.

" + } + }, + "documentation":"

DescribeAgent

" + }, + "DescribeAgentResponse":{ + "type":"structure", + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of the agent.

" + }, + "Status":{ + "shape":"AgentStatus", + "documentation":"

The status of the agent. If the status is ONLINE, then the agent is configured properly and is available to use. The Running status is the normal running status for an agent. If the status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When the issue that caused the unhealthy state is resolved, the agent returns to ONLINE status.

" + }, + "LastConnectionTime":{ + "shape":"Time", + "documentation":"

The time that the agent last connected to DataSyc.

" + }, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the agent was activated (that is, created in your account).

" + }, + "EndpointType":{ + "shape":"EndpointType", + "documentation":"

The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint, the agent is not accessible over the public Internet.

" + }, + "PrivateLinkConfig":{ + "shape":"PrivateLinkConfig", + "documentation":"

The subnet and the security group that DataSync used to access a VPC endpoint.

" + } + }, + "documentation":"

DescribeAgentResponse

" + }, + "DescribeLocationEfsRequest":{ + "type":"structure", + "required":["LocationArn"], + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the EFS location to describe.

" + } + }, + "documentation":"

DescribeLocationEfsRequest

" + }, + "DescribeLocationEfsResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon resource Name (ARN) of the EFS location that was described.

" + }, + "LocationUri":{ + "shape":"LocationUri", + "documentation":"

The URL of the EFS location that was described.

" + }, + "Ec2Config":{"shape":"Ec2Config"}, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the EFS location was created.

" + } + }, + "documentation":"

DescribeLocationEfsResponse

" + }, + "DescribeLocationNfsRequest":{ + "type":"structure", + "required":["LocationArn"], + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon resource Name (ARN) of the NFS location to describe.

" + } + }, + "documentation":"

DescribeLocationNfsRequest

" + }, + "DescribeLocationNfsResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon resource Name (ARN) of the NFS location that was described.

" + }, + "LocationUri":{ + "shape":"LocationUri", + "documentation":"

The URL of the source NFS location that was described.

" + }, + "OnPremConfig":{"shape":"OnPremConfig"}, + "MountOptions":{ + "shape":"NfsMountOptions", + "documentation":"

The NFS mount options that DataSync used to mount your NFS share.

" + }, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the NFS location was created.

" + } + }, + "documentation":"

DescribeLocationNfsResponse

" + }, + "DescribeLocationS3Request":{ + "type":"structure", + "required":["LocationArn"], + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.

" + } + }, + "documentation":"

DescribeLocationS3Request

" + }, + "DescribeLocationS3Response":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon S3 bucket location.

" + }, + "LocationUri":{ + "shape":"LocationUri", + "documentation":"

The URL of the Amazon S3 location that was described.

" + }, + "S3StorageClass":{ + "shape":"S3StorageClass", + "documentation":"

The Amazon S3 storage class that you chose to store your files in when this location is used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the Amazon Simple Storage Service Developer Guide. Some storage classes have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.

" + }, + "S3Config":{"shape":"S3Config"}, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the Amazon S3 bucket location was created.

" + } + }, + "documentation":"

DescribeLocationS3Response

" + }, + "DescribeLocationSmbRequest":{ + "type":"structure", + "required":["LocationArn"], + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon resource Name (ARN) of the SMB location to describe.

" + } + }, + "documentation":"

DescribeLocationSmbRequest

" + }, + "DescribeLocationSmbResponse":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon resource Name (ARN) of the SMB location that was described.

" + }, + "LocationUri":{ + "shape":"LocationUri", + "documentation":"

The URL of the source SBM location that was described.

" + }, + "AgentArns":{ + "shape":"AgentArnList", + "documentation":"

The Amazon Resource Name (ARN) of the source SMB file system location that is created.

" + }, + "User":{ + "shape":"SmbUser", + "documentation":"

The user who can mount the share, has the permissions to access files and folders in the SMB share.

" + }, + "Domain":{ + "shape":"SmbDomain", + "documentation":"

The name of the Windows domain that the SMB server belongs to.

" + }, + "MountOptions":{ + "shape":"SmbMountOptions", + "documentation":"

The mount options that are available for DataSync to use to access an SMB location.

" + }, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the SMB location was created.

" + } + }, + "documentation":"

DescribeLocationSmbResponse

" + }, + "DescribeTaskExecutionRequest":{ + "type":"structure", + "required":["TaskExecutionArn"], + "members":{ + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the task that is being executed.

" + } + }, + "documentation":"

DescribeTaskExecutionRequest

" + }, + "DescribeTaskExecutionResponse":{ + "type":"structure", + "members":{ + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the task execution that was described. TaskExecutionArn is hierarchical and includes TaskArn for the task that was executed.

For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.

" + }, + "Status":{ + "shape":"TaskExecutionStatus", + "documentation":"

The status of the task execution.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

" + }, + "Options":{"shape":"Options"}, + "Excludes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

" + }, + "Includes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to include when running a task. The list should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

" + }, + "StartTime":{ + "shape":"Time", + "documentation":"

The time that the task execution was started.

" + }, + "EstimatedFilesToTransfer":{ + "shape":"long", + "documentation":"

The expected number of files that is to be transferred over the network. This value is calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the expected number of files to be transferred. It's calculated based on comparing the content of the source and destination locations and finding the delta that needs to be transferred.

" + }, + "EstimatedBytesToTransfer":{ + "shape":"long", + "documentation":"

The estimated physical number of bytes that is to be transferred over the network.

" + }, + "FilesTransferred":{ + "shape":"long", + "documentation":"

The actual number of files that was transferred over the network. This value is calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated periodically when each file is read from the source and sent over the network.

If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. This value can also be greater than EstimatedFilesTransferred in some cases. This element is implementation-specific for some location types, so don't use it as an indicator for a correct file number or to monitor your task execution.

" + }, + "BytesWritten":{ + "shape":"long", + "documentation":"

The number of logical bytes written to the destination AWS storage resource.

" + }, + "BytesTransferred":{ + "shape":"long", + "documentation":"

The physical number of bytes transferred over the network.

" + }, + "Result":{ + "shape":"TaskExecutionResultDetail", + "documentation":"

The result of the task execution.

" + } + }, + "documentation":"

DescribeTaskExecutionResponse

" + }, + "DescribeTaskRequest":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task to describe.

" + } + }, + "documentation":"

DescribeTaskRequest

" + }, + "DescribeTaskResponse":{ + "type":"structure", + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task that was described.

" + }, + "Status":{ + "shape":"TaskStatus", + "documentation":"

The status of the task that was described.

For detailed information about task execution statuses, see Understanding Task Statuses in the AWS DataSync User Guide.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of the task that was described.

" + }, + "CurrentTaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the task execution that is syncing files.

" + }, + "SourceLocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the source file system's location.

" + }, + "DestinationLocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS storage resource's location.

" + }, + "CloudWatchLogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the task.

For more information on these groups, see Working with Log Groups and Log Streams in the Amazon CloudWatch User Guide.

" + }, + "SourceNetworkInterfaceArns":{ + "shape":"SourceNetworkInterfaceArns", + "documentation":"

The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was created for your subnet.

" + }, + "DestinationNetworkInterfaceArns":{ + "shape":"DestinationNetworkInterfaceArns", + "documentation":"

The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that was created for your subnet.

" + }, + "Options":{ + "shape":"Options", + "documentation":"

The set of configuration options that control the behavior of a single execution of the task that occurs when you call StartTaskExecution. You can configure these options to preserve metadata such as user ID (UID) and group (GID), file permissions, data integrity verification, and so on.

For each individual task execution, you can override these options by specifying the overriding OverrideOptions value to operation.

" + }, + "Excludes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

" + }, + "ErrorCode":{ + "shape":"string", + "documentation":"

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

" + }, + "ErrorDetail":{ + "shape":"string", + "documentation":"

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

" + }, + "CreationTime":{ + "shape":"Time", + "documentation":"

The time that the task was created.

" + } + }, + "documentation":"

DescribeTaskResponse

" + }, + "DestinationNetworkInterfaceArns":{ + "type":"list", + "member":{"shape":"NetworkInterfaceArn"} + }, + "Duration":{ + "type":"long", + "min":0 + }, + "Ec2Config":{ + "type":"structure", + "required":[ + "SubnetArn", + "SecurityGroupArns" + ], + "members":{ + "SubnetArn":{ + "shape":"Ec2SubnetArn", + "documentation":"

The ARN of the subnet and the security group that DataSync uses to access the target EFS file system.

" + }, + "SecurityGroupArns":{ + "shape":"Ec2SecurityGroupArnList", + "documentation":"

The Amazon Resource Names (ARNs) of the security groups that are configured for the Amazon EC2 resource.

" + } + }, + "documentation":"

The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

" + }, + "Ec2SecurityGroupArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:security-group/.*$" + }, + "Ec2SecurityGroupArnList":{ + "type":"list", + "member":{"shape":"Ec2SecurityGroupArn"}, + "max":5, + "min":1 + }, + "Ec2SubnetArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):ec2:[a-z\\-0-9]*:[0-9]{12}:subnet/.*$" + }, + "EfsFilesystemArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):elasticfilesystem:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$" + }, + "Endpoint":{ + "type":"string", + "max":15, + "min":7, + "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" + }, + "EndpointType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE_LINK" + ] + }, + "FilterList":{ + "type":"list", + "member":{"shape":"FilterRule"}, + "max":1, + "min":0 + }, + "FilterRule":{ + "type":"structure", + "members":{ + "FilterType":{ + "shape":"FilterType", + "documentation":"

The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN rule type.

" + }, + "Value":{ + "shape":"FilterValue", + "documentation":"

A single filter string that consists of the patterns to include or exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: /folder1|/folder2

" + } + }, + "documentation":"

Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

" + }, + "FilterType":{ + "type":"string", + "enum":["SIMPLE_PATTERN"], + "max":128, + "pattern":"^[A-Z0-9_]+$" + }, + "FilterValue":{ + "type":"string", + "max":409600, + "pattern":"^[^\\x00]+$" + }, + "Gid":{ + "type":"string", + "enum":[ + "NONE", + "INT_VALUE", + "NAME", + "BOTH" + ] + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):iam::[0-9]{12}:role/.*$" + }, + "InternalException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"}, + "errorCode":{"shape":"string"} + }, + "documentation":"

This exception is thrown when an error occurs in the AWS DataSync service.

", + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"}, + "errorCode":{"shape":"string"} + }, + "documentation":"

This exception is thrown when the client submits a malformed request.

", + "exception":true + }, + "ListAgentsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of agents to list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin the next list of agents.

" + } + }, + "documentation":"

ListAgentsRequest

" + }, + "ListAgentsResponse":{ + "type":"structure", + "members":{ + "Agents":{ + "shape":"AgentList", + "documentation":"

A list of agents in your account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin returning the next list of agents.

" + } + }, + "documentation":"

ListAgentsResponse

" + }, + "ListLocationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of locations to return.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin the next list of locations.

" + } + }, + "documentation":"

ListLocationsRequest

" + }, + "ListLocationsResponse":{ + "type":"structure", + "members":{ + "Locations":{ + "shape":"LocationList", + "documentation":"

An array that contains a list of locations.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin returning the next list of locations.

" + } + }, + "documentation":"

ListLocationsResponse

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags to list.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of locations to return.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin the next list of locations.

" + } + }, + "documentation":"

ListTagsForResourceRequest

" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

Array of resource tags.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin returning the next list of resource tags.

" + } + }, + "documentation":"

ListTagsForResourceResponse

" + }, + "ListTaskExecutionsRequest":{ + "type":"structure", + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task whose tasks you want to list.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of executed tasks to list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin the next list of the executed tasks.

" + } + }, + "documentation":"

ListTaskExecutions

" + }, + "ListTaskExecutionsResponse":{ + "type":"structure", + "members":{ + "TaskExecutions":{ + "shape":"TaskExecutionList", + "documentation":"

A list of executed tasks.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin returning the next list of executed tasks.

" + } + }, + "documentation":"

ListTaskExecutionsResponse

" + }, + "ListTasksRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of tasks to return.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin the next list of tasks.

" + } + }, + "documentation":"

ListTasksRequest

" + }, + "ListTasksResponse":{ + "type":"structure", + "members":{ + "Tasks":{ + "shape":"TaskList", + "documentation":"

A list of all the tasks that are returned.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

An opaque string that indicates the position at which to begin returning the next list of tasks.

" + } + }, + "documentation":"

ListTasksResponse

" + }, + "LocationArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:location/loc-[0-9a-z]{17}$" + }, + "LocationList":{ + "type":"list", + "member":{"shape":"LocationListEntry"} + }, + "LocationListEntry":{ + "type":"structure", + "members":{ + "LocationArn":{ + "shape":"LocationArn", + "documentation":"

The Amazon Resource Name (ARN) of the location. For Network File System (NFS) or Amazon EFS, the location is the export path. For Amazon S3, the location is the prefix path that you want to mount and use as the root of the location.

" + }, + "LocationUri":{ + "shape":"LocationUri", + "documentation":"

Represents a list of URLs of a location. LocationUri returns an array that contains a list of locations when the ListLocations operation is called.

Format: TYPE://GLOBAL_ID/SUBDIR.

TYPE designates the type of location. Valid values: NFS | EFS | S3.

GLOBAL_ID is the globally unique identifier of the resource that backs the location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 address or a host name compliant with Domain Name Service (DNS).

SUBDIR is a valid file system path, delimited by forward slashes as is the *nix convention. For NFS and Amazon EFS, it's the export path to mount the location. For Amazon S3, it's the prefix path that you mount to and treat as the root of the location.

" + } + }, + "documentation":"

Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

" + }, + "LocationUri":{ + "type":"string", + "max":4355, + "pattern":"^(efs|nfs|s3|smb)://[a-zA-Z0-9.\\-]+$" + }, + "LogGroupArn":{ + "type":"string", + "max":562, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([^:\\*]*)$" + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":0 + }, + "Mtime":{ + "type":"string", + "enum":[ + "NONE", + "PRESERVE" + ] + }, + "NetworkInterfaceArn":{ + "type":"string", + "max":128, + "pattern":"^arn:aws[\\-a-z]{0,}:ec2:[a-z\\-0-9]*:[0-9]{12}:network-interface/eni-[0-9a-f]+$" + }, + "NextToken":{ + "type":"string", + "max":65535, + "pattern":"[a-zA-Z0-9=_-]+" + }, + "NfsMountOptions":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"NfsVersion", + "documentation":"

The specific NFS version that you want DataSync to use to mount your NFS share. If the server refuses to use the version specified, the sync will fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the NFS server.

You can specify the following NFS versions:

  • NFSv3 - stateless protocol version that allows for asynchronous writes on the server.

  • NFSv4.0 - stateful, firewall-friendly protocol version that supports delegations and pseudo filesystems.

  • NFSv4.1 - stateful protocol version that supports sessions, directory delegations, and parallel data processing. Version 4.1 also includes all features available in version 4.0.

" + } + }, + "documentation":"

Represents the mount options that are available for DataSync to access an NFS location.

" + }, + "NfsVersion":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "NFS3", + "NFS4_0", + "NFS4_1" + ] + }, + "NonEmptySubdirectory":{ + "type":"string", + "max":4096, + "pattern":"^[a-zA-Z0-9_\\-\\./]+$" + }, + "OnPremConfig":{ + "type":"structure", + "required":["AgentArns"], + "members":{ + "AgentArns":{ + "shape":"AgentArnList", + "documentation":"

ARNs)of the agents to use for an NFS location.

" + } + }, + "documentation":"

A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.

" + }, + "Options":{ + "type":"structure", + "members":{ + "VerifyMode":{ + "shape":"VerifyMode", + "documentation":"

A value that determines whether a data integrity verification should be performed at the end of a task execution after all data and metadata have been transferred.

Default value: POINT_IN_TIME_CONSISTENT.

POINT_IN_TIME_CONSISTENT: Perform verification (recommended).

ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.

NONE: Skip verification.

" + }, + "OverwriteMode":{ + "shape":"OverwriteMode", + "documentation":"

A value that determines whether files at the destination should be overwritten or preserved when copying files. If set to NEVER a destination file will not be replaced by a source file, even if the destination file differs from the source file. If you modify files in the destination and you sync the files, you can use this value to protect against overwriting those changes.

Some storage classes have specific behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

" + }, + "Atime":{ + "shape":"Atime", + "documentation":"

A file metadata value that shows the last time a file was accessed (that is, when the file was read or written to). If you set Atime to BEST_EFFORT, DataSync attempts to preserve the original Atime attribute on all source files (that is, the version before the PREPARING phase). However, Atime's behavior is not fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.

Default value: BEST_EFFORT.

BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).

NONE: Ignore Atime.

If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.

If Atime is set to NONE, Mtime must also be NONE.

" + }, + "Mtime":{ + "shape":"Mtime", + "documentation":"

A value that indicates the last time that a file was modified (that is, a file was written to) before the PREPARING phase.

Default value: PRESERVE.

PRESERVE: Preserve original Mtime (recommended)

NONE: Ignore Mtime.

If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.

If Mtime is set to NONE, Atime must also be set to NONE.

" + }, + "Uid":{ + "shape":"Uid", + "documentation":"

The user ID (UID) of the file's owner.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).

NONE: Ignore UID and GID.

" + }, + "Gid":{ + "shape":"Gid", + "documentation":"

The group ID (GID) of the file's owners.

Default value: INT_VALUE. This preserves the integer value of the ID.

INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).

NONE: Ignore UID and GID.

" + }, + "PreserveDeletedFiles":{ + "shape":"PreserveDeletedFiles", + "documentation":"

A value that specifies whether files in the destination that don't exist in the source file system should be preserved. This option can affect your storage cost. If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed information, see using-storage-classes in the AWS DataSync User Guide.

Default value: PRESERVE.

PRESERVE: Ignore such destination files (recommended).

REMOVE: Delete destination files that aren’t present in the source.

" + }, + "PreserveDevices":{ + "shape":"PreserveDevices", + "documentation":"

A value that determines whether AWS DataSync should preserve the metadata of block and character devices in the source file system, and recreate the files with that device name and metadata on the destination.

AWS DataSync can't sync the actual contents of such devices, because they are nonterminal and don't return an end-of-file (EOF) marker.

Default value: NONE.

NONE: Ignore special devices (recommended).

PRESERVE: Preserve character and block device metadata. This option isn't currently supported for Amazon EFS.

" + }, + "PosixPermissions":{ + "shape":"PosixPermissions", + "documentation":"

A value that determines which users or groups can access a file for a specific purpose such as reading, writing, or execution of the file.

Default value: PRESERVE.

PRESERVE: Preserve POSIX-style permissions (recommended).

NONE: Ignore permissions.

AWS DataSync can preserve extant permissions of a source location.

" + }, + "BytesPerSecond":{ + "shape":"BytesPerSecond", + "documentation":"

A value that limits the bandwidth used by AWS DataSync. For example, if you want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).

" + }, + "TaskQueueing":{ + "shape":"TaskQueueing", + "documentation":"

A value that determines whether tasks should be queued before executing the tasks. If set to Enabled, the tasks will queued. The default is Enabled.

If you use the same agent to run multiple tasks you can enable the tasks to run in series. For more information see task-queue.

" + } + }, + "documentation":"

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

" + }, + "OverwriteMode":{ + "type":"string", + "enum":[ + "ALWAYS", + "NEVER" + ] + }, + "PLSecurityGroupArnList":{ + "type":"list", + "member":{"shape":"Ec2SecurityGroupArn"}, + "max":1, + "min":1 + }, + "PLSubnetArnList":{ + "type":"list", + "member":{"shape":"Ec2SubnetArn"}, + "max":1, + "min":1 + }, + "PhaseStatus":{ + "type":"string", + "enum":[ + "PENDING", + "SUCCESS", + "ERROR" + ] + }, + "PosixPermissions":{ + "type":"string", + "enum":[ + "NONE", + "BEST_EFFORT", + "PRESERVE" + ] + }, + "PreserveDeletedFiles":{ + "type":"string", + "enum":[ + "PRESERVE", + "REMOVE" + ] + }, + "PreserveDevices":{ + "type":"string", + "enum":[ + "NONE", + "PRESERVE" + ] + }, + "PrivateLinkConfig":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"

The ID of the VPC endpoint that is configured for an agent. An agent that is configured with a VPC endpoint will not be accessible over the public Internet.

" + }, + "PrivateLinkEndpoint":{ + "shape":"Endpoint", + "documentation":"

The private endpoint that is configured for an agent that has access to IP addresses in a PrivateLink. An agent that is configured with this endpoint will not be accessible over the public Internet.

" + }, + "SubnetArns":{ + "shape":"PLSubnetArnList", + "documentation":"

The Amazon Resource Names (ARNs) of the subnets that are configured for an agent activated in a VPC or an agent that has access to a VPC endpoint.

" + }, + "SecurityGroupArns":{ + "shape":"PLSecurityGroupArnList", + "documentation":"

The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2 resource that hosts an agent activated in a VPC or an agent that has access to a VPC endpoint.

" + } + }, + "documentation":"

The VPC endpoint, subnet and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).

" + }, + "S3BucketArn":{ + "type":"string", + "max":76, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):s3:::([^/]*)$" + }, + "S3Config":{ + "type":"structure", + "required":["BucketAccessRoleArn"], + "members":{ + "BucketAccessRoleArn":{ + "shape":"IamRoleArn", + "documentation":"

The Amazon S3 bucket to access. This bucket is used as a parameter in the CreateLocationS3 operation.

" + } + }, + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.

" + }, + "S3StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "STANDARD_IA", + "ONEZONE_IA", + "INTELLIGENT_TIERING", + "GLACIER", + "DEEP_ARCHIVE" + ] + }, + "ServerHostname":{ + "type":"string", + "max":255, + "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])$" + }, + "SmbDomain":{ + "type":"string", + "max":253, + "pattern":"^([A-Za-z0-9]+[A-Za-z0-9-.]*)*[A-Za-z0-9-]*[A-Za-z0-9]$" + }, + "SmbMountOptions":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"SmbVersion", + "documentation":"

The specific SMB version that you want DataSync to use to mount your SMB share. If you don't specify a version, DataSync defaults to AUTOMATIC. That is, DataSync automatically selects a version based on negotiation with the SMB server.

" + } + }, + "documentation":"

Represents the mount options that are available for DataSync to access an SMB location.

" + }, + "SmbPassword":{ + "type":"string", + "max":104, + "pattern":"^.{0,104}$" + }, + "SmbUser":{ + "type":"string", + "max":104, + "pattern":"^[^\\\\x5B\\\\x5D\\\\/:;|=,+*?]{1,104}$" + }, + "SmbVersion":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "SMB2", + "SMB3" + ] + }, + "SourceNetworkInterfaceArns":{ + "type":"list", + "member":{"shape":"NetworkInterfaceArn"} + }, + "StartTaskExecutionRequest":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task to start.

" + }, + "OverrideOptions":{"shape":"Options"}, + "Includes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to include when running a task. The pattern should contain a single filter string that consists of the patterns to include. The patterns are delimited by \"|\" (that is, a pipe). For example: \"/folder1|/folder2\"

" + } + }, + "documentation":"

StartTaskExecutionRequest

" + }, + "StartTaskExecutionResponse":{ + "type":"structure", + "members":{ + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the specific task execution that was started.

" + } + }, + "documentation":"

StartTaskExecutionResponse

" + }, + "Subdirectory":{ + "type":"string", + "max":4096, + "pattern":"^[a-zA-Z0-9_\\-\\./]*$" + }, + "TagKey":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9\\s+=._:/-]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"TagListEntry"}, + "max":55, + "min":0 + }, + "TagListEntry":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key for an AWS resource tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value for an AWS resource tag.

" + } + }, + "documentation":"

Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

" + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to apply the tag to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to apply.

" + } + }, + "documentation":"

TagResourceRequest

" + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9\\s+=._:/-]+$" + }, + "TaggableResourceArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]+:[0-9]{12}:(agent|task|location)/(agent|task|loc)-[0-9a-z]{17}$" + }, + "TaskArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}$" + }, + "TaskExecutionArn":{ + "type":"string", + "max":128, + "pattern":"^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\\-0-9]*:[0-9]{12}:task/task-[0-9a-f]{17}/execution/exec-[0-9a-f]{17}$" + }, + "TaskExecutionList":{ + "type":"list", + "member":{"shape":"TaskExecutionListEntry"} + }, + "TaskExecutionListEntry":{ + "type":"structure", + "members":{ + "TaskExecutionArn":{ + "shape":"TaskExecutionArn", + "documentation":"

The Amazon Resource Name (ARN) of the task that was executed.

" + }, + "Status":{ + "shape":"TaskExecutionStatus", + "documentation":"

The status of a task execution.

" + } + }, + "documentation":"

Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.

" + }, + "TaskExecutionResultDetail":{ + "type":"structure", + "members":{ + "PrepareDuration":{ + "shape":"Duration", + "documentation":"

The total time in milliseconds that AWS DataSync spent in the PREPARING phase.

" + }, + "PrepareStatus":{ + "shape":"PhaseStatus", + "documentation":"

The status of the PREPARING phase.

" + }, + "TransferDuration":{ + "shape":"Duration", + "documentation":"

The total time in milliseconds that AWS DataSync spent in the TRANSFERRING phase.

" + }, + "TransferStatus":{ + "shape":"PhaseStatus", + "documentation":"

The status of the TRANSFERRING Phase.

" + }, + "VerifyDuration":{ + "shape":"Duration", + "documentation":"

The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.

" + }, + "VerifyStatus":{ + "shape":"PhaseStatus", + "documentation":"

The status of the VERIFYING Phase.

" + }, + "ErrorCode":{ + "shape":"string", + "documentation":"

Errors that AWS DataSync encountered during execution of the task. You can use this error code to help troubleshoot issues.

" + }, + "ErrorDetail":{ + "shape":"string", + "documentation":"

Detailed description of an error that was encountered during the task execution. You can use this information to help troubleshoot issues.

" + } + }, + "documentation":"

Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.

" + }, + "TaskExecutionStatus":{ + "type":"string", + "enum":[ + "QUEUED", + "LAUNCHING", + "PREPARING", + "TRANSFERRING", + "VERIFYING", + "SUCCESS", + "ERROR" + ] + }, + "TaskList":{ + "type":"list", + "member":{"shape":"TaskListEntry"} + }, + "TaskListEntry":{ + "type":"structure", + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the task.

" + }, + "Status":{ + "shape":"TaskStatus", + "documentation":"

The status of the task.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of the task.

" + } + }, + "documentation":"

Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

" + }, + "TaskQueueing":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "CREATING", + "QUEUED", + "RUNNING", + "UNAVAILABLE" + ] + }, + "Time":{"type":"timestamp"}, + "Uid":{ + "type":"string", + "enum":[ + "NONE", + "INT_VALUE", + "NAME", + "BOTH" + ] + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Keys" + ], + "members":{ + "ResourceArn":{ + "shape":"TaggableResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to remove the tag from.

" + }, + "Keys":{ + "shape":"TagKeyList", + "documentation":"

The keys in the key-value pair in the tag to remove.

" + } + }, + "documentation":"

UntagResourceRequest

" + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAgentRequest":{ + "type":"structure", + "required":["AgentArn"], + "members":{ + "AgentArn":{ + "shape":"AgentArn", + "documentation":"

The Amazon Resource Name (ARN) of the agent to update.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name that you want to use to configure the agent.

" + } + }, + "documentation":"

UpdateAgentRequest

" + }, + "UpdateAgentResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTaskRequest":{ + "type":"structure", + "required":["TaskArn"], + "members":{ + "TaskArn":{ + "shape":"TaskArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource name of the task to update.

" + }, + "Options":{"shape":"Options"}, + "Excludes":{ + "shape":"FilterList", + "documentation":"

A list of filter rules that determines which files to exclude from a task. The list should contain a single filter string that consists of the patterns to exclude. The patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

The name of the task to update.

" + }, + "CloudWatchLogGroupArn":{ + "shape":"LogGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.

" + } + }, + "documentation":"

UpdateTaskResponse

" + }, + "UpdateTaskResponse":{ + "type":"structure", + "members":{ + } + }, + "VerifyMode":{ + "type":"string", + "enum":[ + "POINT_IN_TIME_CONSISTENT", + "ONLY_FILES_TRANSFERRED", + "NONE" + ] + }, + "VpcEndpointId":{ + "type":"string", + "pattern":"^vpce-[0-9a-f]{17}$" + }, + "long":{"type":"long"}, + "string":{"type":"string"} + }, + "documentation":"AWS DataSync

AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.

" +} diff --git a/aws/dist/botocore/data/dax/2017-04-19/paginators-1.json b/aws/dist/botocore/data/dax/2017-04-19/paginators-1.json new file mode 100644 index 00000000..c13b2df9 --- /dev/null +++ b/aws/dist/botocore/data/dax/2017-04-19/paginators-1.json @@ -0,0 +1,45 @@ +{ + "pagination": { + "DescribeClusters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Clusters" + }, + "DescribeDefaultParameters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Parameters" + }, + "DescribeEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Events" + }, + "DescribeParameterGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ParameterGroups" + }, + "DescribeParameters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Parameters" + }, + "DescribeSubnetGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SubnetGroups" + }, + "ListTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/dax/2017-04-19/service-2.json b/aws/dist/botocore/data/dax/2017-04-19/service-2.json new file mode 100644 index 00000000..2a00dafa --- /dev/null +++ b/aws/dist/botocore/data/dax/2017-04-19/service-2.json @@ -0,0 +1,1684 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-04-19", + "endpointPrefix":"dax", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon DAX", + "serviceFullName":"Amazon DynamoDB Accelerator (DAX)", + "serviceId":"DAX", + "signatureVersion":"v4", + "targetPrefix":"AmazonDAXV3", + "uid":"dax-2017-04-19" + }, + "operations":{ + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResponse"}, + "errors":[ + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"SubnetGroupNotFoundFault"}, + {"shape":"InvalidParameterGroupStateFault"}, + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ClusterQuotaForCustomerExceededFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"TagQuotaPerResourceExceeded"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.

" + }, + "CreateParameterGroup":{ + "name":"CreateParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateParameterGroupRequest"}, + "output":{"shape":"CreateParameterGroupResponse"}, + "errors":[ + {"shape":"ParameterGroupQuotaExceededFault"}, + {"shape":"ParameterGroupAlreadyExistsFault"}, + {"shape":"InvalidParameterGroupStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.

" + }, + "CreateSubnetGroup":{ + "name":"CreateSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetGroupRequest"}, + "output":{"shape":"CreateSubnetGroupResponse"}, + "errors":[ + {"shape":"SubnetGroupAlreadyExistsFault"}, + {"shape":"SubnetGroupQuotaExceededFault"}, + {"shape":"SubnetQuotaExceededFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"ServiceLinkedRoleNotFoundFault"} + ], + "documentation":"

Creates a new subnet group.

" + }, + "DecreaseReplicationFactor":{ + "name":"DecreaseReplicationFactor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecreaseReplicationFactorRequest"}, + "output":{"shape":"DecreaseReplicationFactorResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"NodeNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Removes one or more nodes from a DAX cluster.

You cannot use DecreaseReplicationFactor to remove the last node in a DAX cluster. If you need to do this, use DeleteCluster instead.

" + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterRequest"}, + "output":{"shape":"DeleteClusterResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes a previously provisioned DAX cluster. DeleteCluster deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.

" + }, + "DeleteParameterGroup":{ + "name":"DeleteParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteParameterGroupRequest"}, + "output":{"shape":"DeleteParameterGroupResponse"}, + "errors":[ + {"shape":"InvalidParameterGroupStateFault"}, + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.

" + }, + "DeleteSubnetGroup":{ + "name":"DeleteSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetGroupRequest"}, + "output":{"shape":"DeleteSubnetGroupResponse"}, + "errors":[ + {"shape":"SubnetGroupInUseFault"}, + {"shape":"SubnetGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"} + ], + "documentation":"

Deletes a subnet group.

You cannot delete a subnet group if it is associated with any DAX clusters.

" + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClustersRequest"}, + "output":{"shape":"DescribeClustersResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is available, the cluster is ready for use.

If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.

" + }, + "DescribeDefaultParameters":{ + "name":"DescribeDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDefaultParametersRequest"}, + "output":{"shape":"DescribeDefaultParametersResponse"}, + "errors":[ + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns the default system parameter information for the DAX caching software.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsRequest"}, + "output":{"shape":"DescribeEventsResponse"}, + "errors":[ + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.

By default, only the events occurring within the last 24 hours are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" + }, + "DescribeParameterGroups":{ + "name":"DescribeParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeParameterGroupsRequest"}, + "output":{"shape":"DescribeParameterGroupsResponse"}, + "errors":[ + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.

" + }, + "DescribeParameters":{ + "name":"DescribeParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeParametersRequest"}, + "output":{"shape":"DescribeParametersResponse"}, + "errors":[ + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns the detailed parameter list for a particular parameter group.

" + }, + "DescribeSubnetGroups":{ + "name":"DescribeSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetGroupsRequest"}, + "output":{"shape":"DescribeSubnetGroupsResponse"}, + "errors":[ + {"shape":"SubnetGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"} + ], + "documentation":"

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

" + }, + "IncreaseReplicationFactor":{ + "name":"IncreaseReplicationFactor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IncreaseReplicationFactorRequest"}, + "output":{"shape":"IncreaseReplicationFactorResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Adds one or more nodes to a DAX cluster.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidARNFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

List all of the tags for a DAX cluster. You can call ListTags up to 10 times per second, per account.

" + }, + "RebootNode":{ + "name":"RebootNode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootNodeRequest"}, + "output":{"shape":"RebootNodeResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"NodeNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.

RebootNode restarts the DAX engine process and does not remove the contents of the cache.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"TagQuotaPerResourceExceeded"}, + {"shape":"InvalidARNFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Associates a set of tags with a DAX resource. You can call TagResource up to 5 times per second, per account.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidARNFault"}, + {"shape":"TagNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Removes the association of tags from a DAX resource. You can call UntagResource up to 5 times per second, per account.

" + }, + "UpdateCluster":{ + "name":"UpdateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateClusterRequest"}, + "output":{"shape":"UpdateClusterResponse"}, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidParameterGroupStateFault"}, + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.

" + }, + "UpdateParameterGroup":{ + "name":"UpdateParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateParameterGroupRequest"}, + "output":{"shape":"UpdateParameterGroupResponse"}, + "errors":[ + {"shape":"InvalidParameterGroupStateFault"}, + {"shape":"ParameterGroupNotFoundFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + }, + "UpdateSubnetGroup":{ + "name":"UpdateSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSubnetGroupRequest"}, + "output":{"shape":"UpdateSubnetGroupResponse"}, + "errors":[ + {"shape":"SubnetGroupNotFoundFault"}, + {"shape":"SubnetQuotaExceededFault"}, + {"shape":"SubnetInUse"}, + {"shape":"InvalidSubnet"}, + {"shape":"ServiceLinkedRoleNotFoundFault"} + ], + "documentation":"

Modifies an existing subnet group.

" + } + }, + "shapes":{ + "AvailabilityZoneList":{ + "type":"list", + "member":{"shape":"String"} + }, + "AwsQueryErrorMessage":{"type":"string"}, + "ChangeType":{ + "type":"string", + "enum":[ + "IMMEDIATE", + "REQUIRES_REBOOT" + ] + }, + "Cluster":{ + "type":"structure", + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the DAX cluster.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the cluster.

" + }, + "ClusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

" + }, + "TotalNodes":{ + "shape":"IntegerOptional", + "documentation":"

The total number of nodes in the cluster.

" + }, + "ActiveNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of nodes in the cluster that are active (i.e., capable of serving requests).

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current status of the cluster.

" + }, + "ClusterDiscoveryEndpoint":{ + "shape":"Endpoint", + "documentation":"

The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

" + }, + "NodeIdsToRemove":{ + "shape":"NodeIdentifierList", + "documentation":"

A list of nodes to be removed from the cluster.

" + }, + "Nodes":{ + "shape":"NodeList", + "documentation":"

A list of nodes that are currently in the cluster.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "SubnetGroup":{ + "shape":"String", + "documentation":"

The subnet group where the DAX cluster is running.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupMembershipList", + "documentation":"

A list of security groups, and the status of each, for the nodes in the cluster.

" + }, + "IamRoleArn":{ + "shape":"String", + "documentation":"

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

" + }, + "ParameterGroup":{ + "shape":"ParameterGroupStatus", + "documentation":"

The parameter group being used by nodes in the cluster.

" + }, + "SSEDescription":{ + "shape":"SSEDescription", + "documentation":"

The description of the server-side encryption status on the specified DAX cluster.

" + } + }, + "documentation":"

Contains all of the attributes of a specific DAX cluster.

" + }, + "ClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a DAX cluster with the given identifier.

", + "exception":true + }, + "ClusterList":{ + "type":"list", + "member":{"shape":"Cluster"} + }, + "ClusterNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cluster ID does not refer to an existing DAX cluster.

", + "exception":true + }, + "ClusterQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have attempted to exceed the maximum number of DAX clusters for your AWS account.

", + "exception":true + }, + "CreateClusterRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "NodeType", + "ReplicationFactor", + "IamRoleArn" + ], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "NodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the cluster.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the cluster.

" + }, + "ReplicationFactor":{ + "shape":"Integer", + "documentation":"

The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

AWS recommends that you have at least two read replicas per cluster.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

" + }, + "SubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group to be used for the replication group.

DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdentifierList", + "documentation":"

A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

If this parameter is not specified, DAX assigns the default VPC security group to each node.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:05:00-sun:09:00

If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

The Amazon SNS topic owner must be same as the DAX cluster owner.

" + }, + "IamRoleArn":{ + "shape":"String", + "documentation":"

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

" + }, + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The parameter group to be associated with the DAX cluster.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A set of tags to associate with the DAX cluster.

" + }, + "SSESpecification":{ + "shape":"SSESpecification", + "documentation":"

Represents the settings used to enable server-side encryption on the cluster.

" + } + } + }, + "CreateClusterResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster that you have created.

" + } + } + }, + "CreateParameterGroupRequest":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to apply to all of the clusters in this replication group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter group.

" + } + } + }, + "CreateParameterGroupResponse":{ + "type":"structure", + "members":{ + "ParameterGroup":{ + "shape":"ParameterGroup", + "documentation":"

Represents the output of a CreateParameterGroup action.

" + } + } + }, + "CreateSubnetGroupRequest":{ + "type":"structure", + "required":[ + "SubnetGroupName", + "SubnetIds" + ], + "members":{ + "SubnetGroupName":{ + "shape":"String", + "documentation":"

A name for the subnet group. This value is stored as a lowercase string.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the subnet group

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of VPC subnet IDs for the subnet group.

" + } + } + }, + "CreateSubnetGroupResponse":{ + "type":"structure", + "members":{ + "SubnetGroup":{ + "shape":"SubnetGroup", + "documentation":"

Represents the output of a CreateSubnetGroup operation.

" + } + } + }, + "DecreaseReplicationFactorRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "NewReplicationFactor" + ], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the DAX cluster from which you want to remove nodes.

" + }, + "NewReplicationFactor":{ + "shape":"Integer", + "documentation":"

The new number of nodes for the DAX cluster.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

The Availability Zone(s) from which to remove nodes.

" + }, + "NodeIdsToRemove":{ + "shape":"NodeIdentifierList", + "documentation":"

The unique identifiers of the nodes to be removed from the cluster.

" + } + } + }, + "DecreaseReplicationFactorResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster, after you have decreased its replication factor.

" + } + } + }, + "DeleteClusterRequest":{ + "type":"structure", + "required":["ClusterName"], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the cluster to be deleted.

" + } + } + }, + "DeleteClusterResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster that is being deleted.

" + } + } + }, + "DeleteParameterGroupRequest":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to delete.

" + } + } + }, + "DeleteParameterGroupResponse":{ + "type":"structure", + "members":{ + "DeletionMessage":{ + "shape":"String", + "documentation":"

A user-specified message for this action (i.e., a reason for deleting the parameter group).

" + } + } + }, + "DeleteSubnetGroupRequest":{ + "type":"structure", + "required":["SubnetGroupName"], + "members":{ + "SubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group to delete.

" + } + } + }, + "DeleteSubnetGroupResponse":{ + "type":"structure", + "members":{ + "DeletionMessage":{ + "shape":"String", + "documentation":"

A user-specified message for this action (i.e., a reason for deleting the subnet group).

" + } + } + }, + "DescribeClustersRequest":{ + "type":"structure", + "members":{ + "ClusterNames":{ + "shape":"ClusterNameList", + "documentation":"

The names of the DAX clusters being described.

" + }, + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeClustersResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Clusters":{ + "shape":"ClusterList", + "documentation":"

The descriptions of your DAX clusters, in response to a DescribeClusters request.

" + } + } + }, + "DescribeDefaultParametersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeDefaultParametersResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParameterList", + "documentation":"

A list of parameters. Each element in the list represents one parameter.

" + } + } + }, + "DescribeEventsRequest":{ + "type":"structure", + "members":{ + "SourceName":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes' worth of events to retrieve.

" + }, + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeEventsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

An array of events. Each element in the array represents one event.

" + } + } + }, + "DescribeParameterGroupsRequest":{ + "type":"structure", + "members":{ + "ParameterGroupNames":{ + "shape":"ParameterGroupNameList", + "documentation":"

The names of the parameter groups.

" + }, + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeParameterGroupsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ParameterGroups":{ + "shape":"ParameterGroupList", + "documentation":"

An array of parameter groups. Each element in the array represents one parameter group.

" + } + } + }, + "DescribeParametersRequest":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group.

" + }, + "Source":{ + "shape":"String", + "documentation":"

How the parameter is defined. For example, system denotes a system-defined parameter.

" + }, + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeParametersResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParameterList", + "documentation":"

A list of parameters within a parameter group. Each element in the list represents one parameter.

" + } + } + }, + "DescribeSubnetGroupsRequest":{ + "type":"structure", + "members":{ + "SubnetGroupNames":{ + "shape":"SubnetGroupNameList", + "documentation":"

The name of the subnet group.

" + }, + "MaxResults":{ + "shape":"IntegerOptional", + "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.

The value for MaxResults must be between 20 and 100.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "DescribeSubnetGroupsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "SubnetGroups":{ + "shape":"SubnetGroupList", + "documentation":"

An array of subnet groups. Each element in the array represents a single subnet group.

" + } + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

The DNS hostname of the endpoint.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port number that applications should use to connect to the endpoint.

" + } + }, + "documentation":"

Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceName":{ + "shape":"String", + "documentation":"

The source of the event. For example, if the event occurred at the node level, the source would be the node ID.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A user-defined message associated with the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

The date and time when the event occurred.

" + } + }, + "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

" + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "IncreaseReplicationFactorRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "NewReplicationFactor" + ], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the DAX cluster that will receive additional nodes.

" + }, + "NewReplicationFactor":{ + "shape":"Integer", + "documentation":"

The new number of nodes for the DAX cluster.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.

" + } + } + }, + "IncreaseReplicationFactorResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster. with its new replication factor.

" + } + } + }, + "InsufficientClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster).

", + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidARNFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon Resource Name (ARN) supplied in the request is not valid.

", + "exception":true + }, + "InvalidClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested DAX cluster is not in the available state.

", + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{"shape":"AwsQueryErrorMessage"} + }, + "documentation":"

Two or more incompatible parameters were specified.

", + "exception":true, + "synthetic":true + }, + "InvalidParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more parameters in a parameter group are in an invalid state.

", + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{"shape":"AwsQueryErrorMessage"} + }, + "documentation":"

The value for a parameter is invalid.

", + "exception":true, + "synthetic":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid subnet identifier was specified.

", + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The VPC network is in an invalid state.

", + "exception":true + }, + "IsModifiable":{ + "type":"string", + "enum":[ + "TRUE", + "FALSE", + "CONDITIONAL" + ] + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsRequest":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The name of the DAX resource to which the tags belong.

" + }, + "NextToken":{ + "shape":"String", + "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.

" + } + } + }, + "ListTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags currently associated with the DAX cluster.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

If this value is present, there are additional results to be displayed. To retrieve them, call ListTags again, with NextToken set to this value.

" + } + } + }, + "Node":{ + "type":"structure", + "members":{ + "NodeId":{ + "shape":"String", + "documentation":"

A system-generated identifier for the node.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

" + }, + "NodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time (in UNIX epoch format) when the node was launched.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone (AZ) in which the node has been deployed.

" + }, + "NodeStatus":{ + "shape":"String", + "documentation":"

The current status of the node. For example: available.

" + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

The status of the parameter group associated with this node. For example, in-sync.

" + } + }, + "documentation":"

Represents an individual node within a DAX cluster.

" + }, + "NodeIdentifierList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NodeList":{ + "type":"list", + "member":{"shape":"Node"} + }, + "NodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

None of the nodes in the cluster have the given node ID.

", + "exception":true + }, + "NodeQuotaForClusterExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have attempted to exceed the maximum number of nodes for a DAX cluster.

", + "exception":true + }, + "NodeQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have attempted to exceed the maximum number of nodes for your AWS account.

", + "exception":true + }, + "NodeTypeSpecificValue":{ + "type":"structure", + "members":{ + "NodeType":{ + "shape":"String", + "documentation":"

A node type to which the parameter value applies.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The parameter value for this node type.

" + } + }, + "documentation":"

Represents a parameter value that is applicable to a particular node type.

" + }, + "NodeTypeSpecificValueList":{ + "type":"list", + "member":{"shape":"NodeTypeSpecificValue"} + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" + }, + "TopicStatus":{ + "shape":"String", + "documentation":"

The current state of the topic.

" + } + }, + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterType":{ + "shape":"ParameterType", + "documentation":"

Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value for the parameter.

" + }, + "NodeTypeSpecificValues":{ + "shape":"NodeTypeSpecificValueList", + "documentation":"

A list of node types, and specific parameter values for each node.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter

" + }, + "Source":{ + "shape":"String", + "documentation":"

How the parameter is defined. For example, system denotes a system-defined parameter.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The data type of the parameter. For example, integer:

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

A range of values within which the parameter can be set.

" + }, + "IsModifiable":{ + "shape":"IsModifiable", + "documentation":"

Whether the customer is allowed to modify the parameter.

" + }, + "ChangeType":{ + "shape":"ChangeType", + "documentation":"

The conditions under which changes to this parameter can be applied. For example, requires-reboot indicates that a new value for this parameter will only take effect if a node is rebooted.

" + } + }, + "documentation":"

Describes an individual setting that controls some aspect of DAX behavior.

" + }, + "ParameterGroup":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter group.

" + } + }, + "documentation":"

A named set of parameters that are applied to all of the nodes in a DAX cluster.

" + }, + "ParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified parameter group already exists.

", + "exception":true + }, + "ParameterGroupList":{ + "type":"list", + "member":{"shape":"ParameterGroup"} + }, + "ParameterGroupNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified parameter group does not exist.

", + "exception":true + }, + "ParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have attempted to exceed the maximum number of parameter groups.

", + "exception":true + }, + "ParameterGroupStatus":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + }, + "NodeIdsToReboot":{ + "shape":"NodeIdentifierList", + "documentation":"

The node IDs of one or more nodes to be rebooted.

" + } + }, + "documentation":"

The status of a parameter group.

" + }, + "ParameterList":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "ParameterNameValue":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + } + }, + "documentation":"

An individual DAX parameter.

" + }, + "ParameterNameValueList":{ + "type":"list", + "member":{"shape":"ParameterNameValue"} + }, + "ParameterType":{ + "type":"string", + "enum":[ + "DEFAULT", + "NODE_TYPE_SPECIFIC" + ] + }, + "RebootNodeRequest":{ + "type":"structure", + "required":[ + "ClusterName", + "NodeId" + ], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the DAX cluster containing the node to be rebooted.

" + }, + "NodeId":{ + "shape":"String", + "documentation":"

The system-assigned ID of the node to be rebooted.

" + } + } + }, + "RebootNodeResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster after a node has been rebooted.

" + } + } + }, + "SSEDescription":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SSEStatus", + "documentation":"

The current state of server-side encryption:

  • ENABLING - Server-side encryption is being enabled.

  • ENABLED - Server-side encryption is enabled.

  • DISABLING - Server-side encryption is being disabled.

  • DISABLED - Server-side encryption is disabled.

" + } + }, + "documentation":"

The description of the server-side encryption status on the specified DAX cluster.

" + }, + "SSEEnabled":{"type":"boolean"}, + "SSESpecification":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"SSEEnabled", + "documentation":"

Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.

" + } + }, + "documentation":"

Represents the settings used to enable server-side encryption.

" + }, + "SSEStatus":{ + "type":"string", + "enum":[ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ] + }, + "SecurityGroupIdentifierList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SecurityGroupMembership":{ + "type":"structure", + "members":{ + "SecurityGroupIdentifier":{ + "shape":"String", + "documentation":"

The unique ID for this security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of this security group.

" + } + }, + "documentation":"

An individual VPC security group and its status.

" + }, + "SecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"SecurityGroupMembership"} + }, + "ServiceLinkedRoleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified service linked role (SLR) was not found.

", + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "CLUSTER", + "PARAMETER_GROUP", + "SUBNET_GROUP" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

The system-assigned identifier for the subnet.

" + }, + "SubnetAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone (AZ) for the subnet.

" + } + }, + "documentation":"

Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.

" + }, + "SubnetGroup":{ + "type":"structure", + "members":{ + "SubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

A list of subnets associated with the subnet group.

" + } + }, + "documentation":"

Represents the output of one of the following actions:

  • CreateSubnetGroup

  • ModifySubnetGroup

" + }, + "SubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified subnet group already exists.

", + "exception":true + }, + "SubnetGroupInUseFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified subnet group is currently in use.

", + "exception":true + }, + "SubnetGroupList":{ + "type":"list", + "member":{"shape":"SubnetGroup"} + }, + "SubnetGroupNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested subnet group name does not refer to an existing subnet group.

", + "exception":true + }, + "SubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

", + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested subnet is being used by another subnet group.

", + "exception":true + }, + "SubnetList":{ + "type":"list", + "member":{"shape":"Subnet"} + }, + "SubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.

", + "exception":true + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag. Tag values are case-sensitive and can be null.

" + } + }, + "documentation":"

A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user:.

You cannot backdate the application of a tag.

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The tag does not exist.

", + "exception":true + }, + "TagQuotaPerResourceExceeded":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the maximum number of tags for this DAX cluster.

", + "exception":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The name of the DAX resource to which tags should be added.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DAX resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The list of tags that are associated with the DAX resource.

" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The name of the DAX resource from which the tags should be removed.

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The tag keys that have been removed from the cluster.

" + } + } + }, + "UpdateClusterRequest":{ + "type":"structure", + "required":["ClusterName"], + "members":{ + "ClusterName":{ + "shape":"String", + "documentation":"

The name of the DAX cluster to be modified.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the changes being made to the cluster.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The current state of the topic.

" + }, + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a parameter group for this cluster.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdentifierList", + "documentation":"

A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.

" + } + } + }, + "UpdateClusterResponse":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

A description of the DAX cluster, after it has been modified.

" + } + } + }, + "UpdateParameterGroupRequest":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group.

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.

" + } + } + }, + "UpdateParameterGroupResponse":{ + "type":"structure", + "members":{ + "ParameterGroup":{ + "shape":"ParameterGroup", + "documentation":"

The parameter group that has been modified.

" + } + } + }, + "UpdateSubnetGroupRequest":{ + "type":"structure", + "required":["SubnetGroupName"], + "members":{ + "SubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of subnet IDs in the subnet group.

" + } + } + }, + "UpdateSubnetGroupResponse":{ + "type":"structure", + "members":{ + "SubnetGroup":{ + "shape":"SubnetGroup", + "documentation":"

The subnet group that has been modified.

" + } + } + } + }, + "documentation":"

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

" +} diff --git a/aws/dist/botocore/data/devicefarm/2015-06-23/examples-1.json b/aws/dist/botocore/data/devicefarm/2015-06-23/examples-1.json new file mode 100644 index 00000000..3b9063f8 --- /dev/null +++ b/aws/dist/botocore/data/devicefarm/2015-06-23/examples-1.json @@ -0,0 +1,1242 @@ +{ + "version": "1.0", + "examples": { + "CreateDevicePool": [ + { + "input": { + "name": "MyDevicePool", + "description": "My Android devices", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "rules": [ + + ] + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "name": "A device pool contains related devices, such as devices that run only on Android or that run only on iOS.", + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a new device pool named MyDevicePool inside an existing project.", + "id": "createdevicepool-example-1470862210860", + "title": "To create a new device pool" + } + ], + "CreateProject": [ + { + "input": { + "name": "MyProject" + }, + "output": { + "project": { + "name": "MyProject", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", + "created": "1472660939.152" + } + }, + "comments": { + "input": { + "name": "A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices." + }, + "output": { + } + }, + "description": "The following example creates a new project named MyProject.", + "id": "createproject-example-1470862210860", + "title": "To create a new project" + } + ], + "CreateRemoteAccessSession": [ + { + "input": { + "name": "MySession", + "configuration": { + "billingMethod": "METERED" + }, + "deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "remoteAccessSession": { + } + }, + "comments": { + "input": { + "deviceArn": "You can get the device ARN by using the list-devices CLI command.", + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a remote access session named MySession.", + "id": "to-create-a-remote-access-session-1470970668274", + "title": "To create a remote access session" + } + ], + "CreateUpload": [ + { + "input": { + "name": "MyAppiumPythonUpload", + "type": "APPIUM_PYTHON_TEST_PACKAGE", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "upload": { + "name": "MyAppiumPythonUpload", + "type": "APPIUM_PYTHON_TEST_PACKAGE", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE", + "created": "1472661404.186", + "status": "INITIALIZED", + "url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE" + } + }, + "comments": { + "input": { + "projectArn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example creates a new Appium Python test package upload inside an existing project.", + "id": "createupload-example-1470864711775", + "title": "To create a new test package upload" + } + ], + "DeleteDevicePool": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the device pool ARN by using the list-device-pools CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific device pool.", + "id": "deletedevicepool-example-1470866975494", + "title": "To delete a device pool" + } + ], + "DeleteProject": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific project.", + "id": "deleteproject-example-1470867374212", + "title": "To delete a project" + } + ], + "DeleteRemoteAccessSession": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific remote access session.", + "id": "to-delete-a-specific-remote-access-session-1470971431677", + "title": "To delete a specific remote access session" + } + ], + "DeleteRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the run ARN by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific test run.", + "id": "deleterun-example-1470867905129", + "title": "To delete a run" + } + ], + "DeleteUpload": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the upload ARN by using the list-uploads CLI command." + }, + "output": { + } + }, + "description": "The following example deletes a specific upload.", + "id": "deleteupload-example-1470868363942", + "title": "To delete a specific upload" + } + ], + "GetAccountSettings": [ + { + "input": { + }, + "output": { + "accountSettings": { + "awsAccountNumber": "123456789101", + "unmeteredDevices": { + "ANDROID": 1, + "IOS": 2 + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns information about your Device Farm account settings.", + "id": "to-get-information-about-account-settings-1472567568189", + "title": "To get information about account settings" + } + ], + "GetDevice": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE" + }, + "output": { + "device": { + "name": "LG G2 (Sprint)", + "arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C", + "cpu": { + "architecture": "armeabi-v7a", + "clock": 2265.6, + "frequency": "MHz" + }, + "formFactor": "PHONE", + "heapSize": 256000000, + "image": "75B2B7EF6C12345EXAMPLE", + "manufacturer": "LG", + "memory": 16000000000, + "model": "G2 (Sprint)", + "os": "4.2.2", + "platform": "ANDROID", + "resolution": { + "height": 1920, + "width": 1080 + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns information about a specific device.", + "id": "getdevice-example-1470870602173", + "title": "To get information about a device" + } + ], + "GetDevicePool": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "arn": "You can obtain the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about a specific device pool, given a project ARN.", + "id": "getdevicepool-example-1470870873136", + "title": "To get information about a device pool" + } + ], + "GetDevicePoolCompatibility": [ + { + "input": { + "appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID", + "devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID", + "testType": "APPIUM_PYTHON" + }, + "output": { + "compatibleDevices": [ + + ], + "incompatibleDevices": [ + + ] + }, + "comments": { + "input": { + "devicePoolArn": "You can get the device pool ARN by using the list-device-pools CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the compatibility of a specific device pool, given its ARN.", + "id": "getdevicepoolcompatibility-example-1470925003466", + "title": "To get information about the compatibility of a device pool" + } + ], + "GetJob": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID" + }, + "output": { + "job": { + } + }, + "comments": { + "input": { + "arn": "You can get the job ARN by using the list-jobs CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about a specific job.", + "id": "getjob-example-1470928294268", + "title": "To get information about a job" + } + ], + "GetOfferingStatus": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "current": { + "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + } + }, + "nextPeriod": { + "D68B3C05-1BA6-4360-BC69-12345EXAMPLE": { + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + } + } + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about Device Farm offerings available to your account.", + "id": "to-get-status-information-about-device-offerings-1472568124402", + "title": "To get status information about device offerings" + } + ], + "GetProject": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE" + }, + "output": { + "project": { + "name": "My Project", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE", + "created": "1472660939.152" + } + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific project.", + "id": "to-get-a-project-1470975038449", + "title": "To get information about a project" + } + ], + "GetRemoteAccessSession": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + "remoteAccessSession": { + } + }, + "comments": { + "input": { + "arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example gets a specific remote access session.", + "id": "to-get-a-remote-access-session-1471014119414", + "title": "To get a remote access session" + } + ], + "GetRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE" + }, + "output": { + "run": { + "name": "My Test Run", + "type": "BUILTIN_EXPLORER", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "billingMethod": "METERED", + "completedJobs": 0, + "counters": { + "errored": 0, + "failed": 0, + "passed": 0, + "skipped": 0, + "stopped": 0, + "total": 0, + "warned": 0 + }, + "created": "1472667509.852", + "deviceMinutes": { + "metered": 0.0, + "total": 0.0, + "unmetered": 0.0 + }, + "platform": "ANDROID", + "result": "PENDING", + "status": "RUNNING", + "totalJobs": 3 + } + }, + "comments": { + "input": { + "arn": "You can get the run ARN by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test run.", + "id": "to-get-a-test-run-1471015895657", + "title": "To get information about a test run" + } + ], + "GetSuite": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456" + }, + "output": { + "suite": { + } + }, + "comments": { + "input": { + "arn": "You can get the suite ARN by using the list-suites CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test suite.", + "id": "to-get-information-about-a-test-suite-1471016525008", + "title": "To get information about a test suite" + } + ], + "GetTest": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" + }, + "output": { + "test": { + } + }, + "comments": { + "input": { + "arn": "You can get the test ARN by using the list-tests CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific test.", + "id": "to-get-information-about-a-specific-test-1471025744238", + "title": "To get information about a specific test" + } + ], + "GetUpload": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456" + }, + "output": { + "upload": { + } + }, + "comments": { + "input": { + "arn": "You can get the test ARN by using the list-uploads CLI command." + }, + "output": { + } + }, + "description": "The following example gets information about a specific upload.", + "id": "to-get-information-about-a-specific-upload-1471025996221", + "title": "To get information about a specific upload" + } + ], + "InstallToRemoteAccessSession": [ + { + "input": { + "appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456", + "remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456" + }, + "output": { + "appUpload": { + } + }, + "comments": { + "input": { + "remoteAccessSessionArn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command." + }, + "output": { + } + }, + "description": "The following example installs a specific app to a device in a specific remote access session.", + "id": "to-install-to-a-remote-access-session-1471634453818", + "title": "To install to a remote access session" + } + ], + "ListArtifacts": [ + { + "input": { + "type": "SCREENSHOT", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "comments": { + "input": { + "arn": "Can also be used to list artifacts for a Job, Suite, or Test ARN." + }, + "output": { + } + }, + "description": "The following example lists screenshot artifacts for a specific run.", + "id": "to-list-artifacts-for-a-resource-1471635409527", + "title": "To list artifacts for a resource" + } + ], + "ListDevicePools": [ + { + "input": { + "type": "PRIVATE", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + "devicePools": [ + { + "name": "Top Devices", + "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", + "description": "Top devices", + "rules": [ + { + "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", + "attribute": "ARN", + "operator": "IN" + } + ] + }, + { + "name": "My Android Device Pool", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE", + "description": "Samsung Galaxy Android devices", + "rules": [ + { + "value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]", + "attribute": "ARN", + "operator": "IN" + } + ] + } + ] + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the private device pools in a specific project.", + "id": "to-get-information-about-device-pools-1471635745170", + "title": "To get information about device pools" + } + ], + "ListDevices": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "output": { + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about the available devices in a specific project.", + "id": "to-get-information-about-devices-1471641699344", + "title": "To get information about devices" + } + ], + "ListJobs": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456" + }, + "comments": { + "input": { + "arn": "You can get the project ARN by using the list-jobs CLI command." + }, + "output": { + } + }, + "description": "The following example returns information about jobs in a specific project.", + "id": "to-get-information-about-jobs-1471642228071", + "title": "To get information about jobs" + } + ], + "ListOfferingTransactions": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "offeringTransactions": [ + { + "cost": { + "amount": 0, + "currencyCode": "USD" + }, + "createdOn": "1470021420", + "offeringStatus": { + "type": "RENEW", + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 0 + }, + "transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE" + }, + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "createdOn": "1470021420", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1470021420", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE" + }, + { + "cost": { + "amount": 175, + "currencyCode": "USD" + }, + "createdOn": "1465538520", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1465538520", + "offering": { + "type": "RECURRING", + "description": "Android Unmetered Device Slot", + "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE" + }, + { + "cost": { + "amount": 8.07, + "currencyCode": "USD" + }, + "createdOn": "1459344300", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1459344300", + "offering": { + "type": "RECURRING", + "description": "iOS Unmetered Device Slot", + "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", + "platform": "IOS" + }, + "quantity": 1 + }, + "transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE" + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about Device Farm offering transactions.", + "id": "to-get-information-about-device-offering-transactions-1472561712315", + "title": "To get information about device offering transactions" + } + ], + "ListOfferings": [ + { + "input": { + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "offerings": [ + { + "type": "RECURRING", + "description": "iOS Unmetered Device Slot", + "id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE", + "platform": "IOS", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "Android Unmetered Device Slot", + "id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE", + "platform": "ANDROID", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + }, + { + "type": "RECURRING", + "description": "iOS Remote Access Unmetered Device Slot", + "id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE", + "platform": "IOS", + "recurringCharges": [ + { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "frequency": "MONTHLY" + } + ] + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about available device offerings.", + "id": "to-get-information-about-device-offerings-1472562810999", + "title": "To get information about device offerings" + } + ], + "ListProjects": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "projects": [ + { + "name": "My Test Project", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE", + "created": "1453163262.105" + }, + { + "name": "Hello World", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE", + "created": "1470350112.439" + } + ] + }, + "comments": { + "input": { + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about the specified project in Device Farm.", + "id": "to-get-information-about-a-device-farm-project-1472564014388", + "title": "To get information about a Device Farm project" + } + ], + "ListRemoteAccessSessions": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE=" + }, + "output": { + "remoteAccessSessions": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about a specific Device Farm remote access session.", + "id": "to-get-information-about-a-remote-access-session-1472581144803", + "title": "To get information about a remote access session" + } + ], + "ListRuns": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "runs": [ + { + "name": "My Test Run", + "type": "BUILTIN_EXPLORER", + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE", + "billingMethod": "METERED", + "completedJobs": 0, + "counters": { + "errored": 0, + "failed": 0, + "passed": 0, + "skipped": 0, + "stopped": 0, + "total": 0, + "warned": 0 + }, + "created": "1472667509.852", + "deviceMinutes": { + "metered": 0.0, + "total": 0.0, + "unmetered": 0.0 + }, + "platform": "ANDROID", + "result": "PENDING", + "status": "RUNNING", + "totalJobs": 3 + } + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about a specific test run.", + "id": "to-get-information-about-test-runs-1472582711069", + "title": "To get information about a test run" + } + ], + "ListSamples": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "samples": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about samples, given a specific Device Farm project.", + "id": "to-get-information-about-samples-1472582847534", + "title": "To get information about samples" + } + ], + "ListSuites": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "suites": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about suites, given a specific Device Farm project.", + "id": "to-get-information-about-suites-1472583038218", + "title": "To get information about suites" + } + ], + "ListTests": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "tests": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about tests, given a specific Device Farm project.", + "id": "to-get-information-about-tests-1472617372212", + "title": "To get information about tests" + } + ], + "ListUniqueProblems": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "uniqueProblems": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about unique problems, given a specific Device Farm project.", + "id": "to-get-information-about-unique-problems-1472617781008", + "title": "To get information about unique problems" + } + ], + "ListUploads": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE" + }, + "output": { + "uploads": [ + + ] + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "nextToken": "A dynamically generated value, used for paginating results." + }, + "output": { + } + }, + "description": "The following example returns information about uploads, given a specific Device Farm project.", + "id": "to-get-information-about-uploads-1472617943090", + "title": "To get information about uploads" + } + ], + "PurchaseOffering": [ + { + "input": { + "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "quantity": 1 + }, + "output": { + "offeringTransaction": { + "cost": { + "amount": 8.07, + "currencyCode": "USD" + }, + "createdOn": "1472648340", + "offeringStatus": { + "type": "PURCHASE", + "effectiveOn": "1472648340", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "d30614ed-1b03-404c-9893-12345EXAMPLE" + } + }, + "comments": { + "input": { + "offeringId": "You can get the offering ID by using the list-offerings CLI command." + }, + "output": { + } + }, + "description": "The following example purchases a specific device slot offering.", + "id": "to-purchase-a-device-slot-offering-1472648146343", + "title": "To purchase a device slot offering" + } + ], + "RenewOffering": [ + { + "input": { + "offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "quantity": 1 + }, + "output": { + "offeringTransaction": { + "cost": { + "amount": 250, + "currencyCode": "USD" + }, + "createdOn": "1472648880", + "offeringStatus": { + "type": "RENEW", + "effectiveOn": "1472688000", + "offering": { + "type": "RECURRING", + "description": "Android Remote Access Unmetered Device Slot", + "id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE", + "platform": "ANDROID" + }, + "quantity": 1 + }, + "transactionId": "e90f1405-8c35-4561-be43-12345EXAMPLE" + } + }, + "comments": { + "input": { + "offeringId": "You can get the offering ID by using the list-offerings CLI command." + }, + "output": { + } + }, + "description": "The following example renews a specific device slot offering.", + "id": "to-renew-a-device-slot-offering-1472648899785", + "title": "To renew a device slot offering" + } + ], + "ScheduleRun": [ + { + "input": { + "name": "MyRun", + "devicePoolArn": "arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456", + "projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456", + "test": { + "type": "APPIUM_JAVA_JUNIT", + "testPackageArn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456" + } + }, + "output": { + "run": { + } + }, + "comments": { + "input": { + "devicePoolArn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.", + "projectArn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.", + "testPackageArn": "You can get the Amazon Resource Name (ARN) of the test package by using the list-tests CLI command." + }, + "output": { + } + }, + "description": "The following example schedules a test run named MyRun.", + "id": "to-schedule-a-test-run-1472652429636", + "title": "To schedule a test run" + } + ], + "StopRun": [ + { + "input": { + "arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456" + }, + "output": { + "run": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command." + }, + "output": { + } + }, + "description": "The following example stops a specific test run.", + "id": "to-stop-a-test-run-1472653770340", + "title": "To stop a test run" + } + ], + "UpdateDevicePool": [ + { + "input": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE", + "description": "NewDescription", + "rules": [ + { + "value": "True", + "attribute": "REMOTE_ACCESS_ENABLED", + "operator": "EQUALS" + } + ] + }, + "output": { + "devicePool": { + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command." + }, + "output": { + "devicePool": "Note: you cannot update curated device pools." + } + }, + "description": "The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.", + "id": "to-update-a-device-pool-1472653887677", + "title": "To update a device pool" + } + ], + "UpdateProject": [ + { + "input": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE" + }, + "output": { + "project": { + "name": "NewName", + "arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE", + "created": "1448400709.927" + } + }, + "comments": { + "input": { + "arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command." + }, + "output": { + } + }, + "description": "The following example updates the specified project with a new name.", + "id": "to-update-a-device-pool-1472653887677", + "title": "To update a device pool" + } + ] + } +} diff --git a/aws/dist/botocore/data/devicefarm/2015-06-23/paginators-1.json b/aws/dist/botocore/data/devicefarm/2015-06-23/paginators-1.json new file mode 100644 index 00000000..982e07f9 --- /dev/null +++ b/aws/dist/botocore/data/devicefarm/2015-06-23/paginators-1.json @@ -0,0 +1,110 @@ +{ + "pagination": { + "ListArtifacts": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "artifacts" + }, + "ListDevicePools": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "devicePools" + }, + "ListDevices": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "devices" + }, + "ListJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "jobs" + }, + "ListProjects": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "projects" + }, + "ListRuns": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "runs" + }, + "ListSamples": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "samples" + }, + "ListSuites": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "suites" + }, + "ListTests": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "tests" + }, + "ListUniqueProblems": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "uniqueProblems" + }, + "ListUploads": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "uploads" + }, + "GetOfferingStatus": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": [ + "current", + "nextPeriod" + ] + }, + "ListOfferingTransactions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "offeringTransactions" + }, + "ListOfferings": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "offerings" + }, + "ListDeviceInstances": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "deviceInstances" + }, + "ListInstanceProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "instanceProfiles" + }, + "ListNetworkProfiles": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "networkProfiles" + }, + "ListOfferingPromotions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "offeringPromotions" + }, + "ListRemoteAccessSessions": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "remoteAccessSessions" + }, + "ListVPCEConfigurations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "vpceConfigurations" + } + } +} diff --git a/aws/dist/botocore/data/devicefarm/2015-06-23/service-2.json b/aws/dist/botocore/data/devicefarm/2015-06-23/service-2.json new file mode 100644 index 00000000..975b226d --- /dev/null +++ b/aws/dist/botocore/data/devicefarm/2015-06-23/service-2.json @@ -0,0 +1,4992 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-06-23", + "endpointPrefix":"devicefarm", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Device Farm", + "serviceId":"Device Farm", + "signatureVersion":"v4", + "targetPrefix":"DeviceFarm_20150623", + "uid":"devicefarm-2015-06-23" + }, + "operations":{ + "CreateDevicePool":{ + "name":"CreateDevicePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDevicePoolRequest"}, + "output":{"shape":"CreateDevicePoolResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Creates a device pool.

" + }, + "CreateInstanceProfile":{ + "name":"CreateInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceProfileRequest"}, + "output":{"shape":"CreateInstanceProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Creates a profile that can be applied to one or more private fleet device instances.

" + }, + "CreateNetworkProfile":{ + "name":"CreateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkProfileRequest"}, + "output":{"shape":"CreateNetworkProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Creates a network profile.

" + }, + "CreateProject":{ + "name":"CreateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProjectRequest"}, + "output":{"shape":"CreateProjectResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"}, + {"shape":"TagOperationException"} + ], + "documentation":"

Creates a new project.

" + }, + "CreateRemoteAccessSession":{ + "name":"CreateRemoteAccessSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRemoteAccessSessionRequest"}, + "output":{"shape":"CreateRemoteAccessSessionResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Specifies and starts a remote access session.

" + }, + "CreateUpload":{ + "name":"CreateUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUploadRequest"}, + "output":{"shape":"CreateUploadResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Uploads an app or test scripts.

" + }, + "CreateVPCEConfiguration":{ + "name":"CreateVPCEConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVPCEConfigurationRequest"}, + "output":{"shape":"CreateVPCEConfigurationResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Creates a configuration record in Device Farm for your Amazon Virtual Private Cloud (VPC) endpoint.

" + }, + "DeleteDevicePool":{ + "name":"DeleteDevicePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDevicePoolRequest"}, + "output":{"shape":"DeleteDevicePoolResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.

" + }, + "DeleteInstanceProfile":{ + "name":"DeleteInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceProfileRequest"}, + "output":{"shape":"DeleteInstanceProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes a profile that can be applied to one or more private device instances.

" + }, + "DeleteNetworkProfile":{ + "name":"DeleteNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkProfileRequest"}, + "output":{"shape":"DeleteNetworkProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes a network profile.

" + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProjectRequest"}, + "output":{"shape":"DeleteProjectResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes an AWS Device Farm project, given the project ARN.

Note Deleting this resource does not stop an in-progress run.

" + }, + "DeleteRemoteAccessSession":{ + "name":"DeleteRemoteAccessSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRemoteAccessSessionRequest"}, + "output":{"shape":"DeleteRemoteAccessSessionResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes a completed remote access session and its results.

" + }, + "DeleteRun":{ + "name":"DeleteRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRunRequest"}, + "output":{"shape":"DeleteRunResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes the run, given the run ARN.

Note Deleting this resource does not stop an in-progress run.

" + }, + "DeleteUpload":{ + "name":"DeleteUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUploadRequest"}, + "output":{"shape":"DeleteUploadResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Deletes an upload given the upload ARN.

" + }, + "DeleteVPCEConfiguration":{ + "name":"DeleteVPCEConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVPCEConfigurationRequest"}, + "output":{"shape":"DeleteVPCEConfigurationResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceAccountException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Deletes a configuration for your Amazon Virtual Private Cloud (VPC) endpoint.

" + }, + "GetAccountSettings":{ + "name":"GetAccountSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountSettingsRequest"}, + "output":{"shape":"GetAccountSettingsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.

" + }, + "GetDevice":{ + "name":"GetDevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeviceRequest"}, + "output":{"shape":"GetDeviceResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a unique device type.

" + }, + "GetDeviceInstance":{ + "name":"GetDeviceInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeviceInstanceRequest"}, + "output":{"shape":"GetDeviceInstanceResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about a device instance belonging to a private device fleet.

" + }, + "GetDevicePool":{ + "name":"GetDevicePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDevicePoolRequest"}, + "output":{"shape":"GetDevicePoolResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a device pool.

" + }, + "GetDevicePoolCompatibility":{ + "name":"GetDevicePoolCompatibility", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDevicePoolCompatibilityRequest"}, + "output":{"shape":"GetDevicePoolCompatibilityResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about compatibility with a device pool.

" + }, + "GetInstanceProfile":{ + "name":"GetInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceProfileRequest"}, + "output":{"shape":"GetInstanceProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about the specified instance profile.

" + }, + "GetJob":{ + "name":"GetJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobRequest"}, + "output":{"shape":"GetJobResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a job.

" + }, + "GetNetworkProfile":{ + "name":"GetNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNetworkProfileRequest"}, + "output":{"shape":"GetNetworkProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about a network profile.

" + }, + "GetOfferingStatus":{ + "name":"GetOfferingStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOfferingStatusRequest"}, + "output":{"shape":"GetOfferingStatusResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "GetProject":{ + "name":"GetProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProjectRequest"}, + "output":{"shape":"GetProjectResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a project.

" + }, + "GetRemoteAccessSession":{ + "name":"GetRemoteAccessSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRemoteAccessSessionRequest"}, + "output":{"shape":"GetRemoteAccessSessionResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns a link to a currently running remote access session.

" + }, + "GetRun":{ + "name":"GetRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRunRequest"}, + "output":{"shape":"GetRunResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a run.

" + }, + "GetSuite":{ + "name":"GetSuite", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSuiteRequest"}, + "output":{"shape":"GetSuiteResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a suite.

" + }, + "GetTest":{ + "name":"GetTest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTestRequest"}, + "output":{"shape":"GetTestResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about a test.

" + }, + "GetUpload":{ + "name":"GetUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUploadRequest"}, + "output":{"shape":"GetUploadResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about an upload.

" + }, + "GetVPCEConfiguration":{ + "name":"GetVPCEConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetVPCEConfigurationRequest"}, + "output":{"shape":"GetVPCEConfigurationResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about the configuration settings for your Amazon Virtual Private Cloud (VPC) endpoint.

" + }, + "InstallToRemoteAccessSession":{ + "name":"InstallToRemoteAccessSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InstallToRemoteAccessSessionRequest"}, + "output":{"shape":"InstallToRemoteAccessSessionResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.

" + }, + "ListArtifacts":{ + "name":"ListArtifacts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListArtifactsRequest"}, + "output":{"shape":"ListArtifactsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about artifacts.

" + }, + "ListDeviceInstances":{ + "name":"ListDeviceInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeviceInstancesRequest"}, + "output":{"shape":"ListDeviceInstancesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about the private device instances associated with one or more AWS accounts.

" + }, + "ListDevicePools":{ + "name":"ListDevicePools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDevicePoolsRequest"}, + "output":{"shape":"ListDevicePoolsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about device pools.

" + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about unique device types.

" + }, + "ListInstanceProfiles":{ + "name":"ListInstanceProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesRequest"}, + "output":{"shape":"ListInstanceProfilesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about all the instance profiles in an AWS account.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about jobs for a given test run.

" + }, + "ListNetworkProfiles":{ + "name":"ListNetworkProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListNetworkProfilesRequest"}, + "output":{"shape":"ListNetworkProfilesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns the list of available network profiles.

" + }, + "ListOfferingPromotions":{ + "name":"ListOfferingPromotions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOfferingPromotionsRequest"}, + "output":{"shape":"ListOfferingPromotionsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a NotEligible error if the caller is not permitted to invoke the operation. Contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "ListOfferingTransactions":{ + "name":"ListOfferingTransactions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOfferingTransactionsRequest"}, + "output":{"shape":"ListOfferingTransactionsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "ListOfferings":{ + "name":"ListOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOfferingsRequest"}, + "output":{"shape":"ListOfferingsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns a list of products or offerings that the user can manage through the API. Each offering record indicates the recurring price per unit and the frequency for that offering. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "ListProjects":{ + "name":"ListProjects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProjectsRequest"}, + "output":{"shape":"ListProjectsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about projects.

" + }, + "ListRemoteAccessSessions":{ + "name":"ListRemoteAccessSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRemoteAccessSessionsRequest"}, + "output":{"shape":"ListRemoteAccessSessionsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns a list of all currently running remote access sessions.

" + }, + "ListRuns":{ + "name":"ListRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRunsRequest"}, + "output":{"shape":"ListRunsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about runs, given an AWS Device Farm project ARN.

" + }, + "ListSamples":{ + "name":"ListSamples", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSamplesRequest"}, + "output":{"shape":"ListSamplesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about samples, given an AWS Device Farm job ARN.

" + }, + "ListSuites":{ + "name":"ListSuites", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSuitesRequest"}, + "output":{"shape":"ListSuitesResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about test suites for a given job.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TagOperationException"} + ], + "documentation":"

List the tags for an AWS Device Farm resource.

" + }, + "ListTests":{ + "name":"ListTests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTestsRequest"}, + "output":{"shape":"ListTestsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about tests in a given test suite.

" + }, + "ListUniqueProblems":{ + "name":"ListUniqueProblems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUniqueProblemsRequest"}, + "output":{"shape":"ListUniqueProblemsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about unique problems.

" + }, + "ListUploads":{ + "name":"ListUploads", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUploadsRequest"}, + "output":{"shape":"ListUploadsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Gets information about uploads, given an AWS Device Farm project ARN.

" + }, + "ListVPCEConfigurations":{ + "name":"ListVPCEConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVPCEConfigurationsRequest"}, + "output":{"shape":"ListVPCEConfigurationsResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Returns information about all Amazon Virtual Private Cloud (VPC) endpoint configurations in the AWS account.

" + }, + "PurchaseOffering":{ + "name":"PurchaseOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseOfferingRequest"}, + "output":{"shape":"PurchaseOfferingResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "RenewOffering":{ + "name":"RenewOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RenewOfferingRequest"}, + "output":{"shape":"RenewOfferingResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"NotEligibleException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

" + }, + "ScheduleRun":{ + "name":"ScheduleRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScheduleRunRequest"}, + "output":{"shape":"ScheduleRunResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"IdempotencyException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Schedules a run.

" + }, + "StopJob":{ + "name":"StopJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopJobRequest"}, + "output":{"shape":"StopJobResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Initiates a stop request for the current job. AWS Device Farm will immediately stop the job on the device where tests have not started executing, and you will not be billed for this device. On the device where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on the device. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

" + }, + "StopRemoteAccessSession":{ + "name":"StopRemoteAccessSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopRemoteAccessSessionRequest"}, + "output":{"shape":"StopRemoteAccessSessionResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Ends a specified remote access session.

" + }, + "StopRun":{ + "name":"StopRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopRunRequest"}, + "output":{"shape":"StopRunResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TagOperationException"}, + {"shape":"TooManyTagsException"}, + {"shape":"TagPolicyException"} + ], + "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TagOperationException"} + ], + "documentation":"

Deletes the specified tags from a resource.

" + }, + "UpdateDeviceInstance":{ + "name":"UpdateDeviceInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDeviceInstanceRequest"}, + "output":{"shape":"UpdateDeviceInstanceResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Updates information about an existing private device instance.

" + }, + "UpdateDevicePool":{ + "name":"UpdateDevicePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDevicePoolRequest"}, + "output":{"shape":"UpdateDevicePoolResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).

" + }, + "UpdateInstanceProfile":{ + "name":"UpdateInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInstanceProfileRequest"}, + "output":{"shape":"UpdateInstanceProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Updates information about an existing private device instance profile.

" + }, + "UpdateNetworkProfile":{ + "name":"UpdateNetworkProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNetworkProfileRequest"}, + "output":{"shape":"UpdateNetworkProfileResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Updates the network profile with specific settings.

" + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProjectRequest"}, + "output":{"shape":"UpdateProjectResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Modifies the specified project name, given the project ARN and a new name.

" + }, + "UpdateUpload":{ + "name":"UpdateUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUploadRequest"}, + "output":{"shape":"UpdateUploadResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceAccountException"} + ], + "documentation":"

Update an uploaded test specification (test spec).

" + }, + "UpdateVPCEConfiguration":{ + "name":"UpdateVPCEConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVPCEConfigurationRequest"}, + "output":{"shape":"UpdateVPCEConfigurationResult"}, + "errors":[ + {"shape":"ArgumentException"}, + {"shape":"NotFoundException"}, + {"shape":"ServiceAccountException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

Updates information about an existing Amazon Virtual Private Cloud (VPC) endpoint configuration.

" + } + }, + "shapes":{ + "AWSAccountNumber":{ + "type":"string", + "max":16, + "min":2 + }, + "AccountSettings":{ + "type":"structure", + "members":{ + "awsAccountNumber":{ + "shape":"AWSAccountNumber", + "documentation":"

The AWS account number specified in the AccountSettings container.

" + }, + "unmeteredDevices":{ + "shape":"PurchasedDevicesMap", + "documentation":"

Returns the unmetered devices you have purchased or want to purchase.

" + }, + "unmeteredRemoteAccessDevices":{ + "shape":"PurchasedDevicesMap", + "documentation":"

Returns the unmetered remote access devices you have purchased or want to purchase.

" + }, + "maxJobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The maximum number of minutes a test run will execute before it times out.

" + }, + "trialMinutes":{ + "shape":"TrialMinutes", + "documentation":"

Information about an AWS account's usage of free trial device minutes.

" + }, + "maxSlots":{ + "shape":"MaxSlotMap", + "documentation":"

The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an offering-id:number pair, where the offering-id represents one of the IDs returned by the ListOfferings command.

" + }, + "defaultJobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The default number of minutes (at the account level) a test run will execute before it times out. The default value is 150 minutes.

" + }, + "skipAppResign":{ + "shape":"SkipAppResign", + "documentation":"

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

" + } + }, + "documentation":"

A container for account-level settings within AWS Device Farm.

" + }, + "AccountsCleanup":{"type":"boolean"}, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":32 + }, + "AmazonResourceNames":{ + "type":"list", + "member":{"shape":"AmazonResourceName"} + }, + "AndroidPaths":{ + "type":"list", + "member":{"shape":"String"} + }, + "AppPackagesCleanup":{"type":"boolean"}, + "ArgumentException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Any additional information about the exception.

" + } + }, + "documentation":"

An invalid argument was specified.

", + "exception":true + }, + "Artifact":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The artifact's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The artifact's name.

" + }, + "type":{ + "shape":"ArtifactType", + "documentation":"

The artifact's type.

Allowed values include the following:

  • UNKNOWN: An unknown type.

  • SCREENSHOT: The screenshot type.

  • DEVICE_LOG: The device log type.

  • MESSAGE_LOG: The message log type.

  • VIDEO_LOG: The video log type.

  • RESULT_LOG: The result log type.

  • SERVICE_LOG: The service log type.

  • WEBKIT_LOG: The web kit log type.

  • INSTRUMENTATION_OUTPUT: The instrumentation type.

  • EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.

  • CALABASH_JSON_OUTPUT: The Calabash JSON output type.

  • CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.

  • CALABASH_STANDARD_OUTPUT: The Calabash standard output type.

  • CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.

  • AUTOMATION_OUTPUT: The automation output type.

  • APPIUM_SERVER_OUTPUT: The Appium server output type.

  • APPIUM_JAVA_OUTPUT: The Appium Java output type.

  • APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.

  • APPIUM_PYTHON_OUTPUT: The Appium Python output type.

  • APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.

  • EXPLORER_EVENT_LOG: The Explorer event log output type.

  • EXPLORER_SUMMARY_LOG: The Explorer summary log output type.

  • APPLICATION_CRASH_REPORT: The application crash report output type.

  • XCTEST_LOG: The Xcode test output type.

  • VIDEO: The Video output type.

  • CUSTOMER_ARTIFACT:The Customer Artifact output type.

  • CUSTOMER_ARTIFACT_LOG: The Customer Artifact Log output type.

  • TESTSPEC_OUTPUT: The Test Spec Output type.

" + }, + "extension":{ + "shape":"String", + "documentation":"

The artifact's file extension.

" + }, + "url":{ + "shape":"URL", + "documentation":"

The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.

" + } + }, + "documentation":"

Represents the output of a test. Examples of artifacts include logs and screenshots.

" + }, + "ArtifactCategory":{ + "type":"string", + "enum":[ + "SCREENSHOT", + "FILE", + "LOG" + ] + }, + "ArtifactType":{ + "type":"string", + "enum":[ + "UNKNOWN", + "SCREENSHOT", + "DEVICE_LOG", + "MESSAGE_LOG", + "VIDEO_LOG", + "RESULT_LOG", + "SERVICE_LOG", + "WEBKIT_LOG", + "INSTRUMENTATION_OUTPUT", + "EXERCISER_MONKEY_OUTPUT", + "CALABASH_JSON_OUTPUT", + "CALABASH_PRETTY_OUTPUT", + "CALABASH_STANDARD_OUTPUT", + "CALABASH_JAVA_XML_OUTPUT", + "AUTOMATION_OUTPUT", + "APPIUM_SERVER_OUTPUT", + "APPIUM_JAVA_OUTPUT", + "APPIUM_JAVA_XML_OUTPUT", + "APPIUM_PYTHON_OUTPUT", + "APPIUM_PYTHON_XML_OUTPUT", + "EXPLORER_EVENT_LOG", + "EXPLORER_SUMMARY_LOG", + "APPLICATION_CRASH_REPORT", + "XCTEST_LOG", + "VIDEO", + "CUSTOMER_ARTIFACT", + "CUSTOMER_ARTIFACT_LOG", + "TESTSPEC_OUTPUT" + ] + }, + "Artifacts":{ + "type":"list", + "member":{"shape":"Artifact"} + }, + "BillingMethod":{ + "type":"string", + "enum":[ + "METERED", + "UNMETERED" + ] + }, + "Boolean":{"type":"boolean"}, + "CPU":{ + "type":"structure", + "members":{ + "frequency":{ + "shape":"String", + "documentation":"

The CPU's frequency.

" + }, + "architecture":{ + "shape":"String", + "documentation":"

The CPU's architecture, for example x86 or ARM.

" + }, + "clock":{ + "shape":"Double", + "documentation":"

The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.

" + } + }, + "documentation":"

Represents the amount of CPU that an app is using on a physical device.

Note that this does not represent system-wide CPU usage.

" + }, + "ClientId":{ + "type":"string", + "max":64, + "min":0 + }, + "ContentType":{ + "type":"string", + "max":64, + "min":0 + }, + "Counters":{ + "type":"structure", + "members":{ + "total":{ + "shape":"Integer", + "documentation":"

The total number of entities.

" + }, + "passed":{ + "shape":"Integer", + "documentation":"

The number of passed entities.

" + }, + "failed":{ + "shape":"Integer", + "documentation":"

The number of failed entities.

" + }, + "warned":{ + "shape":"Integer", + "documentation":"

The number of warned entities.

" + }, + "errored":{ + "shape":"Integer", + "documentation":"

The number of errored entities.

" + }, + "stopped":{ + "shape":"Integer", + "documentation":"

The number of stopped entities.

" + }, + "skipped":{ + "shape":"Integer", + "documentation":"

The number of skipped entities.

" + } + }, + "documentation":"

Represents entity counters.

" + }, + "CreateDevicePoolRequest":{ + "type":"structure", + "required":[ + "projectArn", + "name", + "rules" + ], + "members":{ + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the project for the device pool.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The device pool's name.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The device pool's description.

" + }, + "rules":{ + "shape":"Rules", + "documentation":"

The device pool's rules.

" + }, + "maxDevices":{ + "shape":"Integer", + "documentation":"

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

" + } + }, + "documentation":"

Represents a request to the create device pool operation.

" + }, + "CreateDevicePoolResult":{ + "type":"structure", + "members":{ + "devicePool":{ + "shape":"DevicePool", + "documentation":"

The newly created device pool.

" + } + }, + "documentation":"

Represents the result of a create device pool request.

" + }, + "CreateInstanceProfileRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of your instance profile.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The description of your instance profile.

" + }, + "packageCleanup":{ + "shape":"Boolean", + "documentation":"

When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.

" + }, + "excludeAppPackagesFromCleanup":{ + "shape":"PackageIds", + "documentation":"

An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

" + }, + "rebootAfterUse":{ + "shape":"Boolean", + "documentation":"

When set to true, Device Farm will reboot the instance after a test run. The default value is true.

" + } + } + }, + "CreateInstanceProfileResult":{ + "type":"structure", + "members":{ + "instanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

An object containing information about your instance profile.

" + } + } + }, + "CreateNetworkProfileRequest":{ + "type":"structure", + "required":[ + "projectArn", + "name" + ], + "members":{ + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to create a network profile.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name you wish to specify for the new network profile.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The description of the network profile.

" + }, + "type":{ + "shape":"NetworkProfileType", + "documentation":"

The type of network profile you wish to create. Valid values are listed below.

" + }, + "uplinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "downlinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "uplinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" + }, + "downlinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + } + } + }, + "CreateNetworkProfileResult":{ + "type":"structure", + "members":{ + "networkProfile":{ + "shape":"NetworkProfile", + "documentation":"

The network profile that is returned by the create network profile request.

" + } + } + }, + "CreateProjectRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The project's name.

" + }, + "defaultJobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.

" + } + }, + "documentation":"

Represents a request to the create project operation.

" + }, + "CreateProjectResult":{ + "type":"structure", + "members":{ + "project":{ + "shape":"Project", + "documentation":"

The newly created project.

" + } + }, + "documentation":"

Represents the result of a create project request.

" + }, + "CreateRemoteAccessSessionConfiguration":{ + "type":"structure", + "members":{ + "billingMethod":{ + "shape":"BillingMethod", + "documentation":"

The billing method for the remote access session.

" + }, + "vpceConfigurationArns":{ + "shape":"AmazonResourceNames", + "documentation":"

An array of Amazon Resource Names (ARNs) included in the VPC endpoint configuration.

" + } + }, + "documentation":"

Configuration settings for a remote access session, including billing method.

" + }, + "CreateRemoteAccessSessionRequest":{ + "type":"structure", + "required":[ + "projectArn", + "deviceArn" + ], + "members":{ + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.

" + }, + "deviceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.

" + }, + "instanceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.

" + }, + "sshPublicKey":{ + "shape":"SshPublicKey", + "documentation":"

Ignored. The public key of the ssh key pair you want to use for connecting to remote devices in your remote debugging session. This is only required if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

" + }, + "remoteDebugEnabled":{ + "shape":"Boolean", + "documentation":"

Set to true if you want to access devices remotely for debugging in your remote access session.

Remote debugging is no longer supported.

" + }, + "remoteRecordEnabled":{ + "shape":"Boolean", + "documentation":"

Set to true to enable remote recording for the remote access session.

" + }, + "remoteRecordAppArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the remote access session that you wish to create.

" + }, + "clientId":{ + "shape":"ClientId", + "documentation":"

Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same clientId value in each call to CreateRemoteAccessSession. This is required only if remoteDebugEnabled is set to true.

Remote debugging is no longer supported.

" + }, + "configuration":{ + "shape":"CreateRemoteAccessSessionConfiguration", + "documentation":"

The configuration information for the remote access session request.

" + }, + "interactionMode":{ + "shape":"InteractionMode", + "documentation":"

The interaction mode of the remote access session. Valid values are:

  • INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.

  • NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.

  • VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

" + }, + "skipAppResign":{ + "shape":"Boolean", + "documentation":"

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

" + } + }, + "documentation":"

Creates and submits a request to start a remote access session.

" + }, + "CreateRemoteAccessSessionResult":{ + "type":"structure", + "members":{ + "remoteAccessSession":{ + "shape":"RemoteAccessSession", + "documentation":"

A container that describes the remote access session when the request to create a remote access session is sent.

" + } + }, + "documentation":"

Represents the server response from a request to create a remote access session.

" + }, + "CreateUploadRequest":{ + "type":"structure", + "required":[ + "projectArn", + "name", + "type" + ], + "members":{ + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the project for the upload.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the .ipa extension. If uploading an Android app, the file name needs to end with the .apk extension. For all others, the file name must end with the .zip file extension.

" + }, + "type":{ + "shape":"UploadType", + "documentation":"

The upload's upload type.

Must be one of the following values:

  • ANDROID_APP: An Android upload.

  • IOS_APP: An iOS upload.

  • WEB_APP: A web application upload.

  • EXTERNAL_DATA: An external data upload.

  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.

  • APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.

  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.

  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.

  • APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.

  • APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.

  • CALABASH_TEST_PACKAGE: A Calabash test package upload.

  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.

  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.

  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.

  • XCTEST_TEST_PACKAGE: An Xcode test package upload.

  • XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.

  • APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.

  • APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.

  • APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.

  • APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.

  • APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.

  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.

  • APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.

  • APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.

  • APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.

  • INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.

  • XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.

Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The upload's content type (for example, \"application/octet-stream\").

" + } + }, + "documentation":"

Represents a request to the create upload operation.

" + }, + "CreateUploadResult":{ + "type":"structure", + "members":{ + "upload":{ + "shape":"Upload", + "documentation":"

The newly created upload.

" + } + }, + "documentation":"

Represents the result of a create upload request.

" + }, + "CreateVPCEConfigurationRequest":{ + "type":"structure", + "required":[ + "vpceConfigurationName", + "vpceServiceName", + "serviceDnsName" + ], + "members":{ + "vpceConfigurationName":{ + "shape":"VPCEConfigurationName", + "documentation":"

The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

" + }, + "vpceServiceName":{ + "shape":"VPCEServiceName", + "documentation":"

The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.

" + }, + "serviceDnsName":{ + "shape":"ServiceDnsName", + "documentation":"

The DNS name of the service running in your VPC that you want Device Farm to test.

" + }, + "vpceConfigurationDescription":{ + "shape":"VPCEConfigurationDescription", + "documentation":"

An optional description, providing more details about your VPC endpoint configuration.

" + } + } + }, + "CreateVPCEConfigurationResult":{ + "type":"structure", + "members":{ + "vpceConfiguration":{ + "shape":"VPCEConfiguration", + "documentation":"

An object containing information about your VPC endpoint configuration.

" + } + } + }, + "CurrencyCode":{ + "type":"string", + "enum":["USD"] + }, + "CustomerArtifactPaths":{ + "type":"structure", + "members":{ + "iosPaths":{ + "shape":"IosPaths", + "documentation":"

Comma-separated list of paths on the iOS device where the artifacts generated by the customer's tests will be pulled from.

" + }, + "androidPaths":{ + "shape":"AndroidPaths", + "documentation":"

Comma-separated list of paths on the Android device where the artifacts generated by the customer's tests will be pulled from.

" + }, + "deviceHostPaths":{ + "shape":"DeviceHostPaths", + "documentation":"

Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.

" + } + }, + "documentation":"

A JSON object specifying the paths where the artifacts generated by the customer's tests, on the device or in the test environment, will be pulled from.

Specify deviceHostPaths and optionally specify either iosPaths or androidPaths.

For web app tests, you can specify both iosPaths and androidPaths.

" + }, + "DateTime":{"type":"timestamp"}, + "DeleteDevicePoolRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.

" + } + }, + "documentation":"

Represents a request to the delete device pool operation.

" + }, + "DeleteDevicePoolResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the result of a delete device pool request.

" + }, + "DeleteInstanceProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.

" + } + } + }, + "DeleteInstanceProfileResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteNetworkProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the network profile you want to delete.

" + } + } + }, + "DeleteNetworkProfileResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteProjectRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.

" + } + }, + "documentation":"

Represents a request to the delete project operation.

" + }, + "DeleteProjectResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the result of a delete project request.

" + }, + "DeleteRemoteAccessSessionRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the session for which you want to delete remote access.

" + } + }, + "documentation":"

Represents the request to delete the specified remote access session.

" + }, + "DeleteRemoteAccessSessionResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response from the server when a request is made to delete the remote access session.

" + }, + "DeleteRunRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) for the run you wish to delete.

" + } + }, + "documentation":"

Represents a request to the delete run operation.

" + }, + "DeleteRunResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the result of a delete run request.

" + }, + "DeleteUploadRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.

" + } + }, + "documentation":"

Represents a request to the delete upload operation.

" + }, + "DeleteUploadResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the result of a delete upload request.

" + }, + "DeleteVPCEConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to delete.

" + } + } + }, + "DeleteVPCEConfigurationResult":{ + "type":"structure", + "members":{ + } + }, + "Device":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The device's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The device's display name.

" + }, + "manufacturer":{ + "shape":"String", + "documentation":"

The device's manufacturer name.

" + }, + "model":{ + "shape":"String", + "documentation":"

The device's model name.

" + }, + "modelId":{ + "shape":"String", + "documentation":"

The device's model ID.

" + }, + "formFactor":{ + "shape":"DeviceFormFactor", + "documentation":"

The device's form factor.

Allowed values include:

  • PHONE: The phone form factor.

  • TABLET: The tablet form factor.

" + }, + "platform":{ + "shape":"DevicePlatform", + "documentation":"

The device's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

" + }, + "os":{ + "shape":"String", + "documentation":"

The device's operating system type.

" + }, + "cpu":{ + "shape":"CPU", + "documentation":"

Information about the device's CPU.

" + }, + "resolution":{ + "shape":"Resolution", + "documentation":"

The resolution of the device.

" + }, + "heapSize":{ + "shape":"Long", + "documentation":"

The device's heap size, expressed in bytes.

" + }, + "memory":{ + "shape":"Long", + "documentation":"

The device's total memory size, expressed in bytes.

" + }, + "image":{ + "shape":"String", + "documentation":"

The device's image name.

" + }, + "carrier":{ + "shape":"String", + "documentation":"

The device's carrier.

" + }, + "radio":{ + "shape":"String", + "documentation":"

The device's radio.

" + }, + "remoteAccessEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether remote access has been enabled for the specified device.

" + }, + "remoteDebugEnabled":{ + "shape":"Boolean", + "documentation":"

This flag is set to true if remote debugging is enabled for the device.

Remote debugging is no longer supported.

" + }, + "fleetType":{ + "shape":"String", + "documentation":"

The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.

" + }, + "fleetName":{ + "shape":"String", + "documentation":"

The name of the fleet to which this device belongs.

" + }, + "instances":{ + "shape":"DeviceInstances", + "documentation":"

The instances belonging to this device.

" + }, + "availability":{ + "shape":"DeviceAvailability", + "documentation":"

Reflects how likely a device will be available for a test run. It is currently available in the ListDevices and GetDevice API methods.

" + } + }, + "documentation":"

Represents a device type that an app is tested against.

" + }, + "DeviceAttribute":{ + "type":"string", + "enum":[ + "ARN", + "PLATFORM", + "FORM_FACTOR", + "MANUFACTURER", + "REMOTE_ACCESS_ENABLED", + "REMOTE_DEBUG_ENABLED", + "APPIUM_VERSION", + "INSTANCE_ARN", + "INSTANCE_LABELS", + "FLEET_TYPE", + "OS_VERSION", + "MODEL", + "AVAILABILITY" + ] + }, + "DeviceAvailability":{ + "type":"string", + "enum":[ + "TEMPORARY_NOT_AVAILABLE", + "BUSY", + "AVAILABLE", + "HIGHLY_AVAILABLE" + ] + }, + "DeviceFilter":{ + "type":"structure", + "members":{ + "attribute":{ + "shape":"DeviceFilterAttribute", + "documentation":"

The aspect of a device such as platform or model used as the selection criteria in a device filter.

The supported operators for each attribute are provided in the following list.

ARN

The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".

Supported operators: EQUALS, IN, NOT_IN

PLATFORM

The device platform. Valid values are \"ANDROID\" or \"IOS\".

Supported operators: EQUALS

OS_VERSION

The operating system version. For example, \"10.3.2\".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

MODEL

The device model. For example, \"iPad 5th Gen\".

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are \"PHONE\" or \"TABLET\".

Supported operators: EQUALS

MANUFACTURER

The device manufacturer. For example, \"Apple\".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Ignored.Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

FLEET_TYPE

The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".

Supported operators: EQUALS

" + }, + "operator":{ + "shape":"RuleOperator", + "documentation":"

Specifies how Device Farm compares the filter's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

" + }, + "values":{ + "shape":"DeviceFilterValues", + "documentation":"

An array of one or more filter values used in a device filter.

Operator Values

  • The IN and NOT_IN operators can take a values array that has more than one element.

  • The other operators require an array with a single element.

Attribute Values

  • The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".

  • The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

  • The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".

  • The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".

" + } + }, + "documentation":"

Represents a device filter used to select a set of devices to be included in a test run. This data structure is passed in as the deviceSelectionConfiguration parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

It is also passed in as the filters parameter to ListDevices. For an example of the JSON request syntax, see ListDevices.

" + }, + "DeviceFilterAttribute":{ + "type":"string", + "enum":[ + "ARN", + "PLATFORM", + "OS_VERSION", + "MODEL", + "AVAILABILITY", + "FORM_FACTOR", + "MANUFACTURER", + "REMOTE_ACCESS_ENABLED", + "REMOTE_DEBUG_ENABLED", + "INSTANCE_ARN", + "INSTANCE_LABELS", + "FLEET_TYPE" + ] + }, + "DeviceFilterValues":{ + "type":"list", + "member":{"shape":"String"} + }, + "DeviceFilters":{ + "type":"list", + "member":{"shape":"DeviceFilter"} + }, + "DeviceFormFactor":{ + "type":"string", + "enum":[ + "PHONE", + "TABLET" + ] + }, + "DeviceHostPaths":{ + "type":"list", + "member":{"shape":"String"} + }, + "DeviceInstance":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the device instance.

" + }, + "deviceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the device.

" + }, + "labels":{ + "shape":"InstanceLabels", + "documentation":"

An array of strings describing the device instance.

" + }, + "status":{ + "shape":"InstanceStatus", + "documentation":"

The status of the device instance. Valid values are listed below.

" + }, + "udid":{ + "shape":"String", + "documentation":"

Unique device identifier for the device instance.

" + }, + "instanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

A object containing information about the instance profile.

" + } + }, + "documentation":"

Represents the device instance.

" + }, + "DeviceInstances":{ + "type":"list", + "member":{"shape":"DeviceInstance"} + }, + "DeviceMinutes":{ + "type":"structure", + "members":{ + "total":{ + "shape":"Double", + "documentation":"

When specified, represents the total minutes used by the resource to run tests.

" + }, + "metered":{ + "shape":"Double", + "documentation":"

When specified, represents only the sum of metered minutes used by the resource to run tests.

" + }, + "unmetered":{ + "shape":"Double", + "documentation":"

When specified, represents only the sum of unmetered minutes used by the resource to run tests.

" + } + }, + "documentation":"

Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.

" + }, + "DevicePlatform":{ + "type":"string", + "enum":[ + "ANDROID", + "IOS" + ] + }, + "DevicePool":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The device pool's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The device pool's name.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The device pool's description.

" + }, + "type":{ + "shape":"DevicePoolType", + "documentation":"

The device pool's type.

Allowed values include:

  • CURATED: A device pool that is created and managed by AWS Device Farm.

  • PRIVATE: A device pool that is created and managed by the device pool developer.

" + }, + "rules":{ + "shape":"Rules", + "documentation":"

Information about the device pool's rules.

" + }, + "maxDevices":{ + "shape":"Integer", + "documentation":"

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

" + } + }, + "documentation":"

Represents a collection of device types.

" + }, + "DevicePoolCompatibilityResult":{ + "type":"structure", + "members":{ + "device":{ + "shape":"Device", + "documentation":"

The device (phone or tablet) that you wish to return information about.

" + }, + "compatible":{ + "shape":"Boolean", + "documentation":"

Whether the result was compatible with the device pool.

" + }, + "incompatibilityMessages":{ + "shape":"IncompatibilityMessages", + "documentation":"

Information about the compatibility.

" + } + }, + "documentation":"

Represents a device pool compatibility result.

" + }, + "DevicePoolCompatibilityResults":{ + "type":"list", + "member":{"shape":"DevicePoolCompatibilityResult"} + }, + "DevicePoolType":{ + "type":"string", + "enum":[ + "CURATED", + "PRIVATE" + ] + }, + "DevicePools":{ + "type":"list", + "member":{"shape":"DevicePool"} + }, + "DeviceSelectionConfiguration":{ + "type":"structure", + "required":[ + "filters", + "maxDevices" + ], + "members":{ + "filters":{ + "shape":"DeviceFilters", + "documentation":"

Used to dynamically select a set of devices for a test run. A filter is made up of an attribute, an operator, and one or more values.

  • Attribute

    The aspect of a device such as platform or model used as the selection criteria in a device filter.

    Allowed values include:

    • ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".

    • PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".

    • OS_VERSION: The operating system version. For example, \"10.3.2\".

    • MODEL: The device model. For example, \"iPad 5th Gen\".

    • AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

    • FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".

    • MANUFACTURER: The device manufacturer. For example, \"Apple\".

    • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".

    • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\". This filter will be ignored, as remote debugging is no longer supported.

    • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.

    • INSTANCE_LABELS: The label of the device instance.

    • FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".

  • Operator

    The filter operator.

    • The EQUALS operator is available for every attribute except INSTANCE_LABELS.

    • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

    • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.

    • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

  • Values

    An array of one or more filter values.

    Operator Values

    • The IN and NOT_IN operators can take a values array that has more than one element.

    • The other operators require an array with a single element.

    Attribute Values

    • The PLATFORM attribute can be set to \"ANDROID\" or \"IOS\".

    • The AVAILABILITY attribute can be set to \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

    • The FORM_FACTOR attribute can be set to \"PHONE\" or \"TABLET\".

    • The FLEET_TYPE attribute can be set to \"PUBLIC\" or \"PRIVATE\".

" + }, + "maxDevices":{ + "shape":"Integer", + "documentation":"

The maximum number of devices to be included in a test run.

" + } + }, + "documentation":"

Represents the device filters used in a test run as well as the maximum number of devices to be included in the run. It is passed in as the deviceSelectionConfiguration request parameter in ScheduleRun.

" + }, + "DeviceSelectionResult":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"DeviceFilters", + "documentation":"

The filters in a device selection result.

" + }, + "matchedDevicesCount":{ + "shape":"Integer", + "documentation":"

The number of devices that matched the device filter selection criteria.

" + }, + "maxDevices":{ + "shape":"Integer", + "documentation":"

The maximum number of devices to be selected by a device filter and included in a test run.

" + } + }, + "documentation":"

Contains the run results requested by the device selection configuration as well as how many devices were returned. For an example of the JSON response syntax, see ScheduleRun.

" + }, + "Devices":{ + "type":"list", + "member":{"shape":"Device"} + }, + "Double":{"type":"double"}, + "ExceptionMessage":{"type":"string"}, + "ExecutionConfiguration":{ + "type":"structure", + "members":{ + "jobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The number of minutes a test run will execute before it times out.

" + }, + "accountsCleanup":{ + "shape":"AccountsCleanup", + "documentation":"

True if account cleanup is enabled at the beginning of the test; otherwise, false.

" + }, + "appPackagesCleanup":{ + "shape":"AppPackagesCleanup", + "documentation":"

True if app package cleanup is enabled at the beginning of the test; otherwise, false.

" + }, + "videoCapture":{ + "shape":"VideoCapture", + "documentation":"

Set to true to enable video capture; otherwise, set to false. The default is true.

" + }, + "skipAppResign":{ + "shape":"SkipAppResign", + "documentation":"

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

" + } + }, + "documentation":"

Represents configuration information about a test run, such as the execution timeout (in minutes).

" + }, + "ExecutionResult":{ + "type":"string", + "enum":[ + "PENDING", + "PASSED", + "WARNED", + "FAILED", + "SKIPPED", + "ERRORED", + "STOPPED" + ] + }, + "ExecutionResultCode":{ + "type":"string", + "enum":[ + "PARSING_FAILED", + "VPC_ENDPOINT_SETUP_FAILED" + ] + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "PENDING", + "PENDING_CONCURRENCY", + "PENDING_DEVICE", + "PROCESSING", + "SCHEDULING", + "PREPARING", + "RUNNING", + "COMPLETED", + "STOPPING" + ] + }, + "Filter":{ + "type":"string", + "max":8192, + "min":0 + }, + "GetAccountSettingsRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the request sent to retrieve the account settings.

" + }, + "GetAccountSettingsResult":{ + "type":"structure", + "members":{ + "accountSettings":{ + "shape":"AccountSettings", + "documentation":"

The account settings.

" + } + }, + "documentation":"

Represents the account settings return values from the GetAccountSettings request.

" + }, + "GetDeviceInstanceRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance you're requesting information about.

" + } + } + }, + "GetDeviceInstanceResult":{ + "type":"structure", + "members":{ + "deviceInstance":{ + "shape":"DeviceInstance", + "documentation":"

An object containing information about your device instance.

" + } + } + }, + "GetDevicePoolCompatibilityRequest":{ + "type":"structure", + "required":["devicePoolArn"], + "members":{ + "devicePoolArn":{ + "shape":"AmazonResourceName", + "documentation":"

The device pool's ARN.

" + }, + "appArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the app that is associated with the specified device pool.

" + }, + "testType":{ + "shape":"TestType", + "documentation":"

The test type for the specified device pool.

Allowed values include the following:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "test":{ + "shape":"ScheduleRunTest", + "documentation":"

Information about the uploaded test to be run against the device pool.

" + }, + "configuration":{ + "shape":"ScheduleRunConfiguration", + "documentation":"

An object containing information about the settings for a run.

" + } + }, + "documentation":"

Represents a request to the get device pool compatibility operation.

" + }, + "GetDevicePoolCompatibilityResult":{ + "type":"structure", + "members":{ + "compatibleDevices":{ + "shape":"DevicePoolCompatibilityResults", + "documentation":"

Information about compatible devices.

" + }, + "incompatibleDevices":{ + "shape":"DevicePoolCompatibilityResults", + "documentation":"

Information about incompatible devices.

" + } + }, + "documentation":"

Represents the result of describe device pool compatibility request.

" + }, + "GetDevicePoolRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The device pool's ARN.

" + } + }, + "documentation":"

Represents a request to the get device pool operation.

" + }, + "GetDevicePoolResult":{ + "type":"structure", + "members":{ + "devicePool":{ + "shape":"DevicePool", + "documentation":"

An object containing information about the requested device pool.

" + } + }, + "documentation":"

Represents the result of a get device pool request.

" + }, + "GetDeviceRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The device type's ARN.

" + } + }, + "documentation":"

Represents a request to the get device request.

" + }, + "GetDeviceResult":{ + "type":"structure", + "members":{ + "device":{ + "shape":"Device", + "documentation":"

An object containing information about the requested device.

" + } + }, + "documentation":"

Represents the result of a get device request.

" + }, + "GetInstanceProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of your instance profile.

" + } + } + }, + "GetInstanceProfileResult":{ + "type":"structure", + "members":{ + "instanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

An object containing information about your instance profile.

" + } + } + }, + "GetJobRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The job's ARN.

" + } + }, + "documentation":"

Represents a request to the get job operation.

" + }, + "GetJobResult":{ + "type":"structure", + "members":{ + "job":{ + "shape":"Job", + "documentation":"

An object containing information about the requested job.

" + } + }, + "documentation":"

Represents the result of a get job request.

" + }, + "GetNetworkProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the network profile you want to return information about.

" + } + } + }, + "GetNetworkProfileResult":{ + "type":"structure", + "members":{ + "networkProfile":{ + "shape":"NetworkProfile", + "documentation":"

The network profile.

" + } + } + }, + "GetOfferingStatusRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the request to retrieve the offering status for the specified customer or account.

" + }, + "GetOfferingStatusResult":{ + "type":"structure", + "members":{ + "current":{ + "shape":"OfferingStatusMap", + "documentation":"

When specified, gets the offering status for the current period.

" + }, + "nextPeriod":{ + "shape":"OfferingStatusMap", + "documentation":"

When specified, gets the offering status for the next period.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Returns the status result for a device offering.

" + }, + "GetProjectRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The project's ARN.

" + } + }, + "documentation":"

Represents a request to the get project operation.

" + }, + "GetProjectResult":{ + "type":"structure", + "members":{ + "project":{ + "shape":"Project", + "documentation":"

The project you wish to get information about.

" + } + }, + "documentation":"

Represents the result of a get project request.

" + }, + "GetRemoteAccessSessionRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the remote access session about which you want to get session information.

" + } + }, + "documentation":"

Represents the request to get information about the specified remote access session.

" + }, + "GetRemoteAccessSessionResult":{ + "type":"structure", + "members":{ + "remoteAccessSession":{ + "shape":"RemoteAccessSession", + "documentation":"

A container that lists detailed information about the remote access session.

" + } + }, + "documentation":"

Represents the response from the server that lists detailed information about the remote access session.

" + }, + "GetRunRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The run's ARN.

" + } + }, + "documentation":"

Represents a request to the get run operation.

" + }, + "GetRunResult":{ + "type":"structure", + "members":{ + "run":{ + "shape":"Run", + "documentation":"

The run you wish to get results from.

" + } + }, + "documentation":"

Represents the result of a get run request.

" + }, + "GetSuiteRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The suite's ARN.

" + } + }, + "documentation":"

Represents a request to the get suite operation.

" + }, + "GetSuiteResult":{ + "type":"structure", + "members":{ + "suite":{ + "shape":"Suite", + "documentation":"

A collection of one or more tests.

" + } + }, + "documentation":"

Represents the result of a get suite request.

" + }, + "GetTestRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The test's ARN.

" + } + }, + "documentation":"

Represents a request to the get test operation.

" + }, + "GetTestResult":{ + "type":"structure", + "members":{ + "test":{ + "shape":"Test", + "documentation":"

A test condition that is evaluated.

" + } + }, + "documentation":"

Represents the result of a get test request.

" + }, + "GetUploadRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The upload's ARN.

" + } + }, + "documentation":"

Represents a request to the get upload operation.

" + }, + "GetUploadResult":{ + "type":"structure", + "members":{ + "upload":{ + "shape":"Upload", + "documentation":"

An app or a set of one or more tests to upload or that have been uploaded.

" + } + }, + "documentation":"

Represents the result of a get upload request.

" + }, + "GetVPCEConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to describe.

" + } + } + }, + "GetVPCEConfigurationResult":{ + "type":"structure", + "members":{ + "vpceConfiguration":{ + "shape":"VPCEConfiguration", + "documentation":"

An object containing information about your VPC endpoint configuration.

" + } + } + }, + "HostAddress":{ + "type":"string", + "max":1024 + }, + "IdempotencyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Any additional information about the exception.

" + } + }, + "documentation":"

An entity with the same name already exists.

", + "exception":true + }, + "IncompatibilityMessage":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

A message about the incompatibility.

" + }, + "type":{ + "shape":"DeviceAttribute", + "documentation":"

The type of incompatibility.

Allowed values include:

  • ARN: The ARN.

  • FORM_FACTOR: The form factor (for example, phone or tablet).

  • MANUFACTURER: The manufacturer.

  • PLATFORM: The platform (for example, Android or iOS).

  • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.

  • APPIUM_VERSION: The Appium version for the test.

" + } + }, + "documentation":"

Represents information about incompatibility.

" + }, + "IncompatibilityMessages":{ + "type":"list", + "member":{"shape":"IncompatibilityMessage"} + }, + "InstallToRemoteAccessSessionRequest":{ + "type":"structure", + "required":[ + "remoteAccessSessionArn", + "appArn" + ], + "members":{ + "remoteAccessSessionArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.

" + }, + "appArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the app about which you are requesting information.

" + } + }, + "documentation":"

Represents the request to install an Android application (in .apk format) or an iOS application (in .ipa format) as part of a remote access session.

" + }, + "InstallToRemoteAccessSessionResult":{ + "type":"structure", + "members":{ + "appUpload":{ + "shape":"Upload", + "documentation":"

An app to upload or that has been uploaded.

" + } + }, + "documentation":"

Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.

" + }, + "InstanceLabels":{ + "type":"list", + "member":{"shape":"String"} + }, + "InstanceProfile":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

" + }, + "packageCleanup":{ + "shape":"Boolean", + "documentation":"

When set to true, Device Farm will remove app packages after a test run. The default value is false for private devices.

" + }, + "excludeAppPackagesFromCleanup":{ + "shape":"PackageIds", + "documentation":"

An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

" + }, + "rebootAfterUse":{ + "shape":"Boolean", + "documentation":"

When set to true, Device Farm will reboot the instance after a test run. The default value is true.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the instance profile.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The description of the instance profile.

" + } + }, + "documentation":"

Represents the instance profile.

" + }, + "InstanceProfiles":{ + "type":"list", + "member":{"shape":"InstanceProfile"} + }, + "InstanceStatus":{ + "type":"string", + "enum":[ + "IN_USE", + "PREPARING", + "AVAILABLE", + "NOT_AVAILABLE" + ] + }, + "Integer":{"type":"integer"}, + "InteractionMode":{ + "type":"string", + "enum":[ + "INTERACTIVE", + "NO_VIDEO", + "VIDEO_ONLY" + ], + "max":64, + "min":0 + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

There was an error with the update request, or you do not have sufficient permissions to update this VPC endpoint configuration.

", + "exception":true + }, + "IosPaths":{ + "type":"list", + "member":{"shape":"String"} + }, + "Job":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The job's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The job's name.

" + }, + "type":{ + "shape":"TestType", + "documentation":"

The job's type.

Allowed values include the following:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby test type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the job was created.

" + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

The job's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The job's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "started":{ + "shape":"DateTime", + "documentation":"

The job's start time.

" + }, + "stopped":{ + "shape":"DateTime", + "documentation":"

The job's stop time.

" + }, + "counters":{ + "shape":"Counters", + "documentation":"

The job's result counters.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the job's result.

" + }, + "device":{ + "shape":"Device", + "documentation":"

The device (phone or tablet).

" + }, + "instanceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance.

" + }, + "deviceMinutes":{ + "shape":"DeviceMinutes", + "documentation":"

Represents the total (metered or unmetered) minutes used by the job.

" + }, + "videoEndpoint":{ + "shape":"String", + "documentation":"

The endpoint for streaming device video.

" + }, + "videoCapture":{ + "shape":"VideoCapture", + "documentation":"

This value is set to true if video capture is enabled; otherwise, it is set to false.

" + } + }, + "documentation":"

Represents a device.

" + }, + "JobTimeoutMinutes":{"type":"integer"}, + "Jobs":{ + "type":"list", + "member":{"shape":"Job"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Any additional information about the exception.

" + } + }, + "documentation":"

A limit was exceeded.

", + "exception":true + }, + "ListArtifactsRequest":{ + "type":"structure", + "required":[ + "arn", + "type" + ], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Run, Job, Suite, or Test ARN.

" + }, + "type":{ + "shape":"ArtifactCategory", + "documentation":"

The artifacts' type.

Allowed values include:

  • FILE: The artifacts are files.

  • LOG: The artifacts are logs.

  • SCREENSHOT: The artifacts are screenshots.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list artifacts operation.

" + }, + "ListArtifactsResult":{ + "type":"structure", + "members":{ + "artifacts":{ + "shape":"Artifacts", + "documentation":"

Information about the artifacts.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list artifacts operation.

" + }, + "ListDeviceInstancesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"Integer", + "documentation":"

An integer specifying the maximum number of items you want to return in the API response.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListDeviceInstancesResult":{ + "type":"structure", + "members":{ + "deviceInstances":{ + "shape":"DeviceInstances", + "documentation":"

An object containing information about your device instances.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that can be used in the next call to this operation to return the next set of items in the list.

" + } + } + }, + "ListDevicePoolsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The project ARN.

" + }, + "type":{ + "shape":"DevicePoolType", + "documentation":"

The device pools' type.

Allowed values include:

  • CURATED: A device pool that is created and managed by AWS Device Farm.

  • PRIVATE: A device pool that is created and managed by the device pool developer.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list device pools request.

" + }, + "ListDevicePoolsResult":{ + "type":"structure", + "members":{ + "devicePools":{ + "shape":"DevicePools", + "documentation":"

Information about the device pools.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list device pools request.

" + }, + "ListDevicesRequest":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + }, + "filters":{ + "shape":"DeviceFilters", + "documentation":"

Used to select a set of devices. A filter is made up of an attribute, an operator, and one or more values.

  • Attribute: The aspect of a device such as platform or model used as the selection criteria in a device filter.

    Allowed values include:

    • ARN: The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".

    • PLATFORM: The device platform. Valid values are \"ANDROID\" or \"IOS\".

    • OS_VERSION: The operating system version. For example, \"10.3.2\".

    • MODEL: The device model. For example, \"iPad 5th Gen\".

    • AVAILABILITY: The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

    • FORM_FACTOR: The device form factor. Valid values are \"PHONE\" or \"TABLET\".

    • MANUFACTURER: The device manufacturer. For example, \"Apple\".

    • REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".

    • REMOTE_DEBUG_ENABLED: Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\". This attribute will be ignored, as remote debugging is no longer supported.

    • INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.

    • INSTANCE_LABELS: The label of the device instance.

    • FLEET_TYPE: The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".

  • Operator: The filter operator.

    • The EQUALS operator is available for every attribute except INSTANCE_LABELS.

    • The CONTAINS operator is available for the INSTANCE_LABELS and MODEL attributes.

    • The IN and NOT_IN operators are available for the ARN, OS_VERSION, MODEL, MANUFACTURER, and INSTANCE_ARN attributes.

    • The LESS_THAN, GREATER_THAN, LESS_THAN_OR_EQUALS, and GREATER_THAN_OR_EQUALS operators are also available for the OS_VERSION attribute.

  • Values: An array of one or more filter values.

    • The IN and NOT_IN operators take a values array that has one or more elements.

    • The other operators require an array with a single element.

    • In a request, the AVAILABILITY attribute takes \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\" as values.

" + } + }, + "documentation":"

Represents the result of a list devices request.

" + }, + "ListDevicesResult":{ + "type":"structure", + "members":{ + "devices":{ + "shape":"Devices", + "documentation":"

Information about the devices.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list devices operation.

" + }, + "ListInstanceProfilesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"Integer", + "documentation":"

An integer specifying the maximum number of items you want to return in the API response.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListInstanceProfilesResult":{ + "type":"structure", + "members":{ + "instanceProfiles":{ + "shape":"InstanceProfiles", + "documentation":"

An object containing information about your instance profiles.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that can be used in the next call to this operation to return the next set of items in the list.

" + } + } + }, + "ListJobsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The run's Amazon Resource Name (ARN).

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list jobs operation.

" + }, + "ListJobsResult":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"Jobs", + "documentation":"

Information about the jobs.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list jobs request.

" + }, + "ListNetworkProfilesRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list network profiles.

" + }, + "type":{ + "shape":"NetworkProfileType", + "documentation":"

The type of network profile you wish to return information about. Valid values are listed below.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListNetworkProfilesResult":{ + "type":"structure", + "members":{ + "networkProfiles":{ + "shape":"NetworkProfiles", + "documentation":"

A list of the available network profiles.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListOfferingPromotionsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListOfferingPromotionsResult":{ + "type":"structure", + "members":{ + "offeringPromotions":{ + "shape":"OfferingPromotions", + "documentation":"

Information about the offering promotions.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier to be used in the next call to this operation, to return the next set of items in the list.

" + } + } + }, + "ListOfferingTransactionsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the request to list the offering transaction history.

" + }, + "ListOfferingTransactionsResult":{ + "type":"structure", + "members":{ + "offeringTransactions":{ + "shape":"OfferingTransactions", + "documentation":"

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Returns the transaction log of the specified offerings.

" + }, + "ListOfferingsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the request to list all offerings.

" + }, + "ListOfferingsResult":{ + "type":"structure", + "members":{ + "offerings":{ + "shape":"Offerings", + "documentation":"

A value representing the list offering results.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the return values of the list of offerings.

" + }, + "ListProjectsRequest":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list projects operation.

" + }, + "ListProjectsResult":{ + "type":"structure", + "members":{ + "projects":{ + "shape":"Projects", + "documentation":"

Information about the projects.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list projects request.

" + }, + "ListRemoteAccessSessionsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project about which you are requesting information.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the request to return information about the remote access session.

" + }, + "ListRemoteAccessSessionsResult":{ + "type":"structure", + "members":{ + "remoteAccessSessions":{ + "shape":"RemoteAccessSessions", + "documentation":"

A container representing the metadata from the service about each remote access session you are requesting.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the response from the server after AWS Device Farm makes a request to return information about the remote access session.

" + }, + "ListRunsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list runs.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list runs operation.

" + }, + "ListRunsResult":{ + "type":"structure", + "members":{ + "runs":{ + "shape":"Runs", + "documentation":"

Information about the runs.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list runs request.

" + }, + "ListSamplesRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the job used to list samples.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list samples operation.

" + }, + "ListSamplesResult":{ + "type":"structure", + "members":{ + "samples":{ + "shape":"Samples", + "documentation":"

Information about the samples.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list samples request.

" + }, + "ListSuitesRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The job's Amazon Resource Name (ARN).

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list suites operation.

" + }, + "ListSuitesResult":{ + "type":"structure", + "members":{ + "suites":{ + "shape":"Suites", + "documentation":"

Information about the suites.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list suites request.

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource(s) for which to list tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + } + } + }, + "ListTestsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The test suite's Amazon Resource Name (ARN).

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list tests operation.

" + }, + "ListTestsResult":{ + "type":"structure", + "members":{ + "tests":{ + "shape":"Tests", + "documentation":"

Information about the tests.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list tests request.

" + }, + "ListUniqueProblemsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The unique problems' ARNs.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list unique problems operation.

" + }, + "ListUniqueProblemsResult":{ + "type":"structure", + "members":{ + "uniqueProblems":{ + "shape":"UniqueProblemsByExecutionResultMap", + "documentation":"

Information about the unique problems.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list unique problems request.

" + }, + "ListUploadsRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to list uploads.

" + }, + "type":{ + "shape":"UploadType", + "documentation":"

The type of upload.

Must be one of the following values:

  • ANDROID_APP: An Android upload.

  • IOS_APP: An iOS upload.

  • WEB_APP: A web application upload.

  • EXTERNAL_DATA: An external data upload.

  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.

  • APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for a web app.

  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for a web app.

  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for a web app.

  • APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for a web app.

  • APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for a web app.

  • CALABASH_TEST_PACKAGE: A Calabash test package upload.

  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.

  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.

  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.

  • XCTEST_TEST_PACKAGE: An Xcode test package upload.

  • XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.

  • APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.

  • APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.

  • APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.

  • APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.

  • APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.

  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.

  • APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.

  • APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.

  • APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.

  • INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.

  • XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + }, + "documentation":"

Represents a request to the list uploads operation.

" + }, + "ListUploadsResult":{ + "type":"structure", + "members":{ + "uploads":{ + "shape":"Uploads", + "documentation":"

Information about the uploads.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.

" + } + }, + "documentation":"

Represents the result of a list uploads request.

" + }, + "ListVPCEConfigurationsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"Integer", + "documentation":"

An integer specifying the maximum number of items you want to return in the API response.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "ListVPCEConfigurationsResult":{ + "type":"structure", + "members":{ + "vpceConfigurations":{ + "shape":"VPCEConfigurations", + "documentation":"

An array of VPCEConfiguration objects containing information about your VPC endpoint configuration.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

" + } + } + }, + "Location":{ + "type":"structure", + "required":[ + "latitude", + "longitude" + ], + "members":{ + "latitude":{ + "shape":"Double", + "documentation":"

The latitude.

" + }, + "longitude":{ + "shape":"Double", + "documentation":"

The longitude.

" + } + }, + "documentation":"

Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).

Elevation is currently not supported.

" + }, + "Long":{"type":"long"}, + "MaxSlotMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Integer"} + }, + "Message":{ + "type":"string", + "max":16384, + "min":0 + }, + "Metadata":{ + "type":"string", + "max":8192, + "min":0 + }, + "MonetaryAmount":{ + "type":"structure", + "members":{ + "amount":{ + "shape":"Double", + "documentation":"

The numerical amount of an offering or transaction.

" + }, + "currencyCode":{ + "shape":"CurrencyCode", + "documentation":"

The currency code of a monetary amount. For example, USD means \"U.S. dollars.\"

" + } + }, + "documentation":"

A number representing the monetary amount for an offering or transaction.

" + }, + "Name":{ + "type":"string", + "max":256, + "min":0 + }, + "NetworkProfile":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the network profile.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the network profile.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The description of the network profile.

" + }, + "type":{ + "shape":"NetworkProfileType", + "documentation":"

The type of network profile. Valid values are listed below.

" + }, + "uplinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "downlinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "uplinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" + }, + "downlinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + } + }, + "documentation":"

An array of settings that describes characteristics of a network profile.

" + }, + "NetworkProfileType":{ + "type":"string", + "enum":[ + "CURATED", + "PRIVATE" + ] + }, + "NetworkProfiles":{ + "type":"list", + "member":{"shape":"NetworkProfile"} + }, + "NotEligibleException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

The HTTP response code of a Not Eligible exception.

" + } + }, + "documentation":"

Exception gets thrown when a user is not eligible to perform the specified transaction.

", + "exception":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Any additional information about the exception.

" + } + }, + "documentation":"

The specified entity was not found.

", + "exception":true + }, + "Offering":{ + "type":"structure", + "members":{ + "id":{ + "shape":"OfferingIdentifier", + "documentation":"

The ID that corresponds to a device offering.

" + }, + "description":{ + "shape":"Message", + "documentation":"

A string describing the offering.

" + }, + "type":{ + "shape":"OfferingType", + "documentation":"

The type of offering (e.g., \"RECURRING\") for a device.

" + }, + "platform":{ + "shape":"DevicePlatform", + "documentation":"

The platform of the device (e.g., ANDROID or IOS).

" + }, + "recurringCharges":{ + "shape":"RecurringCharges", + "documentation":"

Specifies whether there are recurring charges for the offering.

" + } + }, + "documentation":"

Represents the metadata of a device offering.

" + }, + "OfferingIdentifier":{ + "type":"string", + "min":32 + }, + "OfferingPromotion":{ + "type":"structure", + "members":{ + "id":{ + "shape":"OfferingPromotionIdentifier", + "documentation":"

The ID of the offering promotion.

" + }, + "description":{ + "shape":"Message", + "documentation":"

A string describing the offering promotion.

" + } + }, + "documentation":"

Represents information about an offering promotion.

" + }, + "OfferingPromotionIdentifier":{ + "type":"string", + "min":4 + }, + "OfferingPromotions":{ + "type":"list", + "member":{"shape":"OfferingPromotion"} + }, + "OfferingStatus":{ + "type":"structure", + "members":{ + "type":{ + "shape":"OfferingTransactionType", + "documentation":"

The type specified for the offering status.

" + }, + "offering":{ + "shape":"Offering", + "documentation":"

Represents the metadata of an offering status.

" + }, + "quantity":{ + "shape":"Integer", + "documentation":"

The number of available devices in the offering.

" + }, + "effectiveOn":{ + "shape":"DateTime", + "documentation":"

The date on which the offering is effective.

" + } + }, + "documentation":"

The status of the offering.

" + }, + "OfferingStatusMap":{ + "type":"map", + "key":{"shape":"OfferingIdentifier"}, + "value":{"shape":"OfferingStatus"} + }, + "OfferingTransaction":{ + "type":"structure", + "members":{ + "offeringStatus":{ + "shape":"OfferingStatus", + "documentation":"

The status of an offering transaction.

" + }, + "transactionId":{ + "shape":"TransactionIdentifier", + "documentation":"

The transaction ID of the offering transaction.

" + }, + "offeringPromotionId":{ + "shape":"OfferingPromotionIdentifier", + "documentation":"

The ID that corresponds to a device offering promotion.

" + }, + "createdOn":{ + "shape":"DateTime", + "documentation":"

The date on which an offering transaction was created.

" + }, + "cost":{ + "shape":"MonetaryAmount", + "documentation":"

The cost of an offering transaction.

" + } + }, + "documentation":"

Represents the metadata of an offering transaction.

" + }, + "OfferingTransactionType":{ + "type":"string", + "enum":[ + "PURCHASE", + "RENEW", + "SYSTEM" + ] + }, + "OfferingTransactions":{ + "type":"list", + "member":{"shape":"OfferingTransaction"} + }, + "OfferingType":{ + "type":"string", + "enum":["RECURRING"] + }, + "Offerings":{ + "type":"list", + "member":{"shape":"Offering"} + }, + "PackageIds":{ + "type":"list", + "member":{"shape":"String"} + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":4 + }, + "PercentInteger":{ + "type":"integer", + "max":100, + "min":0 + }, + "Problem":{ + "type":"structure", + "members":{ + "run":{ + "shape":"ProblemDetail", + "documentation":"

Information about the associated run.

" + }, + "job":{ + "shape":"ProblemDetail", + "documentation":"

Information about the associated job.

" + }, + "suite":{ + "shape":"ProblemDetail", + "documentation":"

Information about the associated suite.

" + }, + "test":{ + "shape":"ProblemDetail", + "documentation":"

Information about the associated test.

" + }, + "device":{ + "shape":"Device", + "documentation":"

Information about the associated device.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The problem's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the problem's result.

" + } + }, + "documentation":"

Represents a specific warning or failure.

" + }, + "ProblemDetail":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The problem detail's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The problem detail's name.

" + } + }, + "documentation":"

Information about a problem detail.

" + }, + "Problems":{ + "type":"list", + "member":{"shape":"Problem"} + }, + "Project":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The project's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The project's name.

" + }, + "defaultJobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The default number of minutes (at the project level) a test run will execute before it times out. The default value is 150 minutes.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the project was created.

" + } + }, + "documentation":"

Represents an operating-system neutral workspace for running and managing tests.

" + }, + "Projects":{ + "type":"list", + "member":{"shape":"Project"} + }, + "PurchaseOfferingRequest":{ + "type":"structure", + "members":{ + "offeringId":{ + "shape":"OfferingIdentifier", + "documentation":"

The ID of the offering.

" + }, + "quantity":{ + "shape":"Integer", + "documentation":"

The number of device slots you wish to purchase in an offering request.

" + }, + "offeringPromotionId":{ + "shape":"OfferingPromotionIdentifier", + "documentation":"

The ID of the offering promotion to be applied to the purchase.

" + } + }, + "documentation":"

Represents a request for a purchase offering.

" + }, + "PurchaseOfferingResult":{ + "type":"structure", + "members":{ + "offeringTransaction":{ + "shape":"OfferingTransaction", + "documentation":"

Represents the offering transaction for the purchase result.

" + } + }, + "documentation":"

The result of the purchase offering (e.g., success or failure).

" + }, + "PurchasedDevicesMap":{ + "type":"map", + "key":{"shape":"DevicePlatform"}, + "value":{"shape":"Integer"} + }, + "Radios":{ + "type":"structure", + "members":{ + "wifi":{ + "shape":"Boolean", + "documentation":"

True if Wi-Fi is enabled at the beginning of the test; otherwise, false.

" + }, + "bluetooth":{ + "shape":"Boolean", + "documentation":"

True if Bluetooth is enabled at the beginning of the test; otherwise, false.

" + }, + "nfc":{ + "shape":"Boolean", + "documentation":"

True if NFC is enabled at the beginning of the test; otherwise, false.

" + }, + "gps":{ + "shape":"Boolean", + "documentation":"

True if GPS is enabled at the beginning of the test; otherwise, false.

" + } + }, + "documentation":"

Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "cost":{ + "shape":"MonetaryAmount", + "documentation":"

The cost of the recurring charge.

" + }, + "frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency in which charges will recur.

" + } + }, + "documentation":"

Specifies whether charges for devices will be recurring.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["MONTHLY"] + }, + "RecurringCharges":{ + "type":"list", + "member":{"shape":"RecurringCharge"} + }, + "RemoteAccessSession":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the remote access session.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the remote access session.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

The date and time the remote access session was created.

" + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

The status of the remote access session. Can be any of the following:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The result of the remote access session. Can be any of the following:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the remote access session.

" + }, + "started":{ + "shape":"DateTime", + "documentation":"

The date and time the remote access session was started.

" + }, + "stopped":{ + "shape":"DateTime", + "documentation":"

The date and time the remote access session was stopped.

" + }, + "device":{ + "shape":"Device", + "documentation":"

The device (phone or tablet) used in the remote access session.

" + }, + "instanceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance.

" + }, + "remoteDebugEnabled":{ + "shape":"Boolean", + "documentation":"

This flag is set to true if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" + }, + "remoteRecordEnabled":{ + "shape":"Boolean", + "documentation":"

This flag is set to true if remote recording is enabled for the remote access session.

" + }, + "remoteRecordAppArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.

" + }, + "hostAddress":{ + "shape":"HostAddress", + "documentation":"

IP address of the EC2 host where you need to connect to remotely debug devices. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" + }, + "clientId":{ + "shape":"ClientId", + "documentation":"

Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" + }, + "billingMethod":{ + "shape":"BillingMethod", + "documentation":"

The billing method of the remote access session. Possible values include METERED or UNMETERED. For more information about metered devices, see AWS Device Farm terminology.\"

" + }, + "deviceMinutes":{ + "shape":"DeviceMinutes", + "documentation":"

The number of minutes a device is used in a remote access session (including setup and teardown minutes).

" + }, + "endpoint":{ + "shape":"String", + "documentation":"

The endpoint for the remote access sesssion.

" + }, + "deviceUdid":{ + "shape":"String", + "documentation":"

Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.

Remote debugging is no longer supported.

" + }, + "interactionMode":{ + "shape":"InteractionMode", + "documentation":"

The interaction mode of the remote access session. Valid values are:

  • INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You cannot run XCUITest framework-based tests in this mode.

  • NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You can run XCUITest framework-based tests in this mode.

  • VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You can run XCUITest framework-based tests and watch the screen in this mode.

" + }, + "skipAppResign":{ + "shape":"SkipAppResign", + "documentation":"

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

" + } + }, + "documentation":"

Represents information about the remote access session.

" + }, + "RemoteAccessSessions":{ + "type":"list", + "member":{"shape":"RemoteAccessSession"} + }, + "RenewOfferingRequest":{ + "type":"structure", + "members":{ + "offeringId":{ + "shape":"OfferingIdentifier", + "documentation":"

The ID of a request to renew an offering.

" + }, + "quantity":{ + "shape":"Integer", + "documentation":"

The quantity requested in an offering renewal.

" + } + }, + "documentation":"

A request representing an offering renewal.

" + }, + "RenewOfferingResult":{ + "type":"structure", + "members":{ + "offeringTransaction":{ + "shape":"OfferingTransaction", + "documentation":"

Represents the status of the offering transaction for the renewal.

" + } + }, + "documentation":"

The result of a renewal offering.

" + }, + "Resolution":{ + "type":"structure", + "members":{ + "width":{ + "shape":"Integer", + "documentation":"

The screen resolution's width, expressed in pixels.

" + }, + "height":{ + "shape":"Integer", + "documentation":"

The screen resolution's height, expressed in pixels.

" + } + }, + "documentation":"

Represents the screen resolution of a device in height and width, expressed in pixels.

" + }, + "Rule":{ + "type":"structure", + "members":{ + "attribute":{ + "shape":"DeviceAttribute", + "documentation":"

The rule's stringified attribute. For example, specify the value as \"\\\"abc\\\"\".

The supported operators for each attribute are provided in the following list.

APPIUM_VERSION

The Appium version for the test.

Supported operators: CONTAINS

ARN

The Amazon Resource Name (ARN) of the device. For example, \"arn:aws:devicefarm:us-west-2::device:12345Example\".

Supported operators: EQUALS, IN, NOT_IN

AVAILABILITY

The current availability of the device. Valid values are \"AVAILABLE\", \"HIGHLY_AVAILABLE\", \"BUSY\", or \"TEMPORARY_NOT_AVAILABLE\".

Supported operators: EQUALS

FLEET_TYPE

The fleet type. Valid values are \"PUBLIC\" or \"PRIVATE\".

Supported operators: EQUALS

FORM_FACTOR

The device form factor. Valid values are \"PHONE\" or \"TABLET\".

Supported operators: EQUALS, IN, NOT_IN

INSTANCE_ARN

The Amazon Resource Name (ARN) of the device instance.

Supported operators: IN, NOT_IN

INSTANCE_LABELS

The label of the device instance.

Supported operators: CONTAINS

MANUFACTURER

The device manufacturer. For example, \"Apple\".

Supported operators: EQUALS, IN, NOT_IN

MODEL

The device model, such as \"Apple iPad Air 2\" or \"Google Pixel\".

Supported operators: CONTAINS, EQUALS, IN, NOT_IN

OS_VERSION

The operating system version. For example, \"10.3.2\".

Supported operators: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUALS, IN, LESS_THAN, LESS_THAN_OR_EQUALS, NOT_IN

PLATFORM

The device platform. Valid values are \"ANDROID\" or \"IOS\".

Supported operators: EQUALS, IN, NOT_IN

REMOTE_ACCESS_ENABLED

Whether the device is enabled for remote access. Valid values are \"TRUE\" or \"FALSE\".

Supported operators: EQUALS

REMOTE_DEBUG_ENABLED

Whether the device is enabled for remote debugging. Valid values are \"TRUE\" or \"FALSE\".

Supported operators: EQUALS

This filter will be ignored, as remote debugging is no longer supported.

" + }, + "operator":{ + "shape":"RuleOperator", + "documentation":"

Specifies how Device Farm compares the rule's attribute to the value. For the operators that are supported by each attribute, see the attribute descriptions.

" + }, + "value":{ + "shape":"String", + "documentation":"

The rule's value.

" + } + }, + "documentation":"

Represents a condition for a device pool.

" + }, + "RuleOperator":{ + "type":"string", + "enum":[ + "EQUALS", + "LESS_THAN", + "LESS_THAN_OR_EQUALS", + "GREATER_THAN", + "GREATER_THAN_OR_EQUALS", + "IN", + "NOT_IN", + "CONTAINS" + ] + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"} + }, + "Run":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The run's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The run's name.

" + }, + "type":{ + "shape":"TestType", + "documentation":"

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "platform":{ + "shape":"DevicePlatform", + "documentation":"

The run's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the run was created.

" + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

The run's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The run's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "started":{ + "shape":"DateTime", + "documentation":"

The run's start time.

" + }, + "stopped":{ + "shape":"DateTime", + "documentation":"

The run's stop time.

" + }, + "counters":{ + "shape":"Counters", + "documentation":"

The run's result counters.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the run's result.

" + }, + "totalJobs":{ + "shape":"Integer", + "documentation":"

The total number of jobs for the run.

" + }, + "completedJobs":{ + "shape":"Integer", + "documentation":"

The total number of completed jobs.

" + }, + "billingMethod":{ + "shape":"BillingMethod", + "documentation":"

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

" + }, + "deviceMinutes":{ + "shape":"DeviceMinutes", + "documentation":"

Represents the total (metered or unmetered) minutes used by the test run.

" + }, + "networkProfile":{ + "shape":"NetworkProfile", + "documentation":"

The network profile being used for a test run.

" + }, + "parsingResultUrl":{ + "shape":"String", + "documentation":"

Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

" + }, + "resultCode":{ + "shape":"ExecutionResultCode", + "documentation":"

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

" + }, + "seed":{ + "shape":"Integer", + "documentation":"

For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

" + }, + "appUpload":{ + "shape":"AmazonResourceName", + "documentation":"

An app to upload or that has been uploaded.

" + }, + "eventCount":{ + "shape":"Integer", + "documentation":"

For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.

" + }, + "jobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The number of minutes the job will execute before it times out.

" + }, + "devicePoolArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the device pool for the run.

" + }, + "locale":{ + "shape":"String", + "documentation":"

Information about the locale that is used for the run.

" + }, + "radios":{ + "shape":"Radios", + "documentation":"

Information about the radio states for the run.

" + }, + "location":{ + "shape":"Location", + "documentation":"

Information about the location that is used for the run.

" + }, + "customerArtifactPaths":{ + "shape":"CustomerArtifactPaths", + "documentation":"

Output CustomerArtifactPaths object for the test run.

" + }, + "webUrl":{ + "shape":"String", + "documentation":"

The Device Farm console URL for the recording of the run.

" + }, + "skipAppResign":{ + "shape":"SkipAppResign", + "documentation":"

When set to true, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.

For more information about how Device Farm re-signs your app(s), see Do you modify my app? in the AWS Device Farm FAQs.

" + }, + "testSpecArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the YAML-formatted test specification for the run.

" + }, + "deviceSelectionResult":{ + "shape":"DeviceSelectionResult", + "documentation":"

The results of a device filter used to select the devices for a test run.

" + } + }, + "documentation":"

Represents a test run on a set of devices with a given app package, test parameters, etc.

" + }, + "Runs":{ + "type":"list", + "member":{"shape":"Run"} + }, + "Sample":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The sample's ARN.

" + }, + "type":{ + "shape":"SampleType", + "documentation":"

The sample's type.

Must be one of the following values:

  • CPU: A CPU sample type. This is expressed as the app processing CPU time (including child processes) as reported by process, as a percentage.

  • MEMORY: A memory usage sample type. This is expressed as the total proportional set size of an app process, in kilobytes.

  • NATIVE_AVG_DRAWTIME

  • NATIVE_FPS

  • NATIVE_FRAMES

  • NATIVE_MAX_DRAWTIME

  • NATIVE_MIN_DRAWTIME

  • OPENGL_AVG_DRAWTIME

  • OPENGL_FPS

  • OPENGL_FRAMES

  • OPENGL_MAX_DRAWTIME

  • OPENGL_MIN_DRAWTIME

  • RX

  • RX_RATE: The total number of bytes per second (TCP and UDP) that are sent, by app process.

  • THREADS: A threads sample type. This is expressed as the total number of threads per app process.

  • TX

  • TX_RATE: The total number of bytes per second (TCP and UDP) that are received, by app process.

" + }, + "url":{ + "shape":"URL", + "documentation":"

The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.

" + } + }, + "documentation":"

Represents a sample of performance data.

" + }, + "SampleType":{ + "type":"string", + "enum":[ + "CPU", + "MEMORY", + "THREADS", + "RX_RATE", + "TX_RATE", + "RX", + "TX", + "NATIVE_FRAMES", + "NATIVE_FPS", + "NATIVE_MIN_DRAWTIME", + "NATIVE_AVG_DRAWTIME", + "NATIVE_MAX_DRAWTIME", + "OPENGL_FRAMES", + "OPENGL_FPS", + "OPENGL_MIN_DRAWTIME", + "OPENGL_AVG_DRAWTIME", + "OPENGL_MAX_DRAWTIME" + ] + }, + "Samples":{ + "type":"list", + "member":{"shape":"Sample"} + }, + "ScheduleRunConfiguration":{ + "type":"structure", + "members":{ + "extraDataPackageArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.

" + }, + "networkProfileArn":{ + "shape":"AmazonResourceName", + "documentation":"

Reserved for internal use.

" + }, + "locale":{ + "shape":"String", + "documentation":"

Information about the locale that is used for the run.

" + }, + "location":{ + "shape":"Location", + "documentation":"

Information about the location that is used for the run.

" + }, + "vpceConfigurationArns":{ + "shape":"AmazonResourceNames", + "documentation":"

An array of Amazon Resource Names (ARNs) for your VPC endpoint configurations.

" + }, + "customerArtifactPaths":{ + "shape":"CustomerArtifactPaths", + "documentation":"

Input CustomerArtifactPaths object for the scheduled run configuration.

" + }, + "radios":{ + "shape":"Radios", + "documentation":"

Information about the radio states for the run.

" + }, + "auxiliaryApps":{ + "shape":"AmazonResourceNames", + "documentation":"

A list of Upload ARNs for app packages that will be installed alongside your app.

" + }, + "billingMethod":{ + "shape":"BillingMethod", + "documentation":"

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

" + } + }, + "documentation":"

Represents the settings for a run. Includes things like location, radio states, auxiliary apps, and network profiles.

" + }, + "ScheduleRunRequest":{ + "type":"structure", + "required":[ + "projectArn", + "test" + ], + "members":{ + "projectArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the project for the run to be scheduled.

" + }, + "appArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the app to schedule a run.

" + }, + "devicePoolArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the device pool for the run to be scheduled.

" + }, + "deviceSelectionConfiguration":{ + "shape":"DeviceSelectionConfiguration", + "documentation":"

The filter criteria used to dynamically select a set of devices for a test run, as well as the maximum number of devices to be included in the run.

Either devicePoolArn or deviceSelectionConfiguration is required in a request.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name for the run to be scheduled.

" + }, + "test":{ + "shape":"ScheduleRunTest", + "documentation":"

Information about the test for the run to be scheduled.

" + }, + "configuration":{ + "shape":"ScheduleRunConfiguration", + "documentation":"

Information about the settings for the run to be scheduled.

" + }, + "executionConfiguration":{ + "shape":"ExecutionConfiguration", + "documentation":"

Specifies configuration information about a test run, such as the execution timeout (in minutes).

" + } + }, + "documentation":"

Represents a request to the schedule run operation.

" + }, + "ScheduleRunResult":{ + "type":"structure", + "members":{ + "run":{ + "shape":"Run", + "documentation":"

Information about the scheduled run.

" + } + }, + "documentation":"

Represents the result of a schedule run request.

" + }, + "ScheduleRunTest":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"TestType", + "documentation":"

The test's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "testPackageArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the uploaded test that will be run.

" + }, + "testSpecArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the YAML-formatted test specification.

" + }, + "filter":{ + "shape":"Filter", + "documentation":"

The test's filter.

" + }, + "parameters":{ + "shape":"TestParameters", + "documentation":"

The test's parameters, such as test framework parameters and fixture settings. Parameters are represented by name-value pairs of strings.

For all tests:

  • app_performance_monitoring: Performance monitoring is enabled by default. Set this parameter to \"false\" to disable it.

For Calabash tests:

  • profile: A cucumber profile, for example, \"my_profile_name\".

  • tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".

For Appium tests (all types):

  • appium_version: The Appium version. Currently supported values are \"1.6.5\" (and higher), \"latest\", and \"default\".

    • “latest” will run the latest Appium version supported by Device Farm (1.9.1).

    • For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.7.2 on Android devices and iOS 9 and earlier, 1.7.2 for iOS 10 and later.

    • This behavior is subject to change.

For Fuzz tests (Android only):

  • event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.

  • throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.

  • seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.

For Explorer tests:

  • username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.

  • password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.

For Instrumentation:

  • filter: A test filter string. Examples:

    • Running a single test case: \"com.android.abc.Test1\"

    • Running a single test: \"com.android.abc.Test1#smoke\"

    • Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"

For XCTest and XCTestUI:

  • filter: A test filter string. Examples:

    • Running a single test class: \"LoginTests\"

    • Running a multiple test classes: \"LoginTests,SmokeTests\"

    • Running a single test: \"LoginTests/testValid\"

    • Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"

For UIAutomator:

  • filter: A test filter string. Examples:

    • Running a single test case: \"com.android.abc.Test1\"

    • Running a single test: \"com.android.abc.Test1#smoke\"

    • Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"

" + } + }, + "documentation":"

Represents test settings. This data structure is passed in as the \"test\" parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

" + }, + "ServiceAccountException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Any additional information about the exception.

" + } + }, + "documentation":"

There was a problem with the service account.

", + "exception":true + }, + "ServiceDnsName":{ + "type":"string", + "max":2048, + "min":0 + }, + "SkipAppResign":{"type":"boolean"}, + "SshPublicKey":{ + "type":"string", + "max":8192, + "min":0 + }, + "StopJobRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm job you wish to stop.

" + } + } + }, + "StopJobResult":{ + "type":"structure", + "members":{ + "job":{ + "shape":"Job", + "documentation":"

The job that was stopped.

" + } + } + }, + "StopRemoteAccessSessionRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the remote access session you wish to stop.

" + } + }, + "documentation":"

Represents the request to stop the remote access session.

" + }, + "StopRemoteAccessSessionResult":{ + "type":"structure", + "members":{ + "remoteAccessSession":{ + "shape":"RemoteAccessSession", + "documentation":"

A container representing the metadata from the service about the remote access session you are stopping.

" + } + }, + "documentation":"

Represents the response from the server that describes the remote access session when AWS Device Farm stops the session.

" + }, + "StopRunRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.

" + } + }, + "documentation":"

Represents the request to stop a specific run.

" + }, + "StopRunResult":{ + "type":"structure", + "members":{ + "run":{ + "shape":"Run", + "documentation":"

The run that was stopped.

" + } + }, + "documentation":"

Represents the results of your stop run attempt.

" + }, + "String":{"type":"string"}, + "Suite":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The suite's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The suite's name.

" + }, + "type":{ + "shape":"TestType", + "documentation":"

The suite's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the suite was created.

" + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

The suite's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The suite's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "started":{ + "shape":"DateTime", + "documentation":"

The suite's start time.

" + }, + "stopped":{ + "shape":"DateTime", + "documentation":"

The suite's stop time.

" + }, + "counters":{ + "shape":"Counters", + "documentation":"

The suite's result counters.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the suite's result.

" + }, + "deviceMinutes":{ + "shape":"DeviceMinutes", + "documentation":"

Represents the total (metered or unmetered) minutes used by the test suite.

" + } + }, + "documentation":"

Represents a collection of one or more tests.

" + }, + "Suites":{ + "type":"list", + "member":{"shape":"Suite"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

The metadata that you apply to a resource to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":150 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":150 + }, + "TagOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"

The operation was not successful. Try again.

", + "exception":true + }, + "TagPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"

The request doesn't comply with the AWS Identity and Access Management (IAM) tag policy. Correct your request and then retry it.

", + "exception":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource(s) to which to add tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Test":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The test's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The test's name.

" + }, + "type":{ + "shape":"TestType", + "documentation":"

The test's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_NODE: The Appium Node.js type.

  • APPIUM_RUBY: The Appium Ruby type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for web apps.

  • APPIUM_WEB_NODE: The Appium Node.js type for web apps.

  • APPIUM_WEB_RUBY: The Appium Ruby type for web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The Xcode test type.

  • XCTEST_UI: The Xcode UI test type.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the test was created.

" + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

The test's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

" + }, + "result":{ + "shape":"ExecutionResult", + "documentation":"

The test's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

" + }, + "started":{ + "shape":"DateTime", + "documentation":"

The test's start time.

" + }, + "stopped":{ + "shape":"DateTime", + "documentation":"

The test's stop time.

" + }, + "counters":{ + "shape":"Counters", + "documentation":"

The test's result counters.

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the test's result.

" + }, + "deviceMinutes":{ + "shape":"DeviceMinutes", + "documentation":"

Represents the total (metered or unmetered) minutes used by the test.

" + } + }, + "documentation":"

Represents a condition that is evaluated.

" + }, + "TestParameters":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "TestType":{ + "type":"string", + "enum":[ + "BUILTIN_FUZZ", + "BUILTIN_EXPLORER", + "WEB_PERFORMANCE_PROFILE", + "APPIUM_JAVA_JUNIT", + "APPIUM_JAVA_TESTNG", + "APPIUM_PYTHON", + "APPIUM_NODE", + "APPIUM_RUBY", + "APPIUM_WEB_JAVA_JUNIT", + "APPIUM_WEB_JAVA_TESTNG", + "APPIUM_WEB_PYTHON", + "APPIUM_WEB_NODE", + "APPIUM_WEB_RUBY", + "CALABASH", + "INSTRUMENTATION", + "UIAUTOMATION", + "UIAUTOMATOR", + "XCTEST", + "XCTEST_UI", + "REMOTE_ACCESS_RECORD", + "REMOTE_ACCESS_REPLAY" + ] + }, + "Tests":{ + "type":"list", + "member":{"shape":"Test"} + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceName":{"shape":"AmazonResourceName"} + }, + "documentation":"

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

", + "exception":true + }, + "TransactionIdentifier":{ + "type":"string", + "min":32 + }, + "TrialMinutes":{ + "type":"structure", + "members":{ + "total":{ + "shape":"Double", + "documentation":"

The total number of free trial minutes that the account started with.

" + }, + "remaining":{ + "shape":"Double", + "documentation":"

The number of free trial minutes remaining in the account.

" + } + }, + "documentation":"

Represents information about free trial device minutes for an AWS account.

" + }, + "URL":{ + "type":"string", + "max":2048, + "min":0 + }, + "UniqueProblem":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

A message about the unique problems' result.

" + }, + "problems":{ + "shape":"Problems", + "documentation":"

Information about the problems.

" + } + }, + "documentation":"

A collection of one or more problems, grouped by their result.

" + }, + "UniqueProblems":{ + "type":"list", + "member":{"shape":"UniqueProblem"} + }, + "UniqueProblemsByExecutionResultMap":{ + "type":"map", + "key":{"shape":"ExecutionResult"}, + "value":{"shape":"UniqueProblems"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource(s) from which to delete tags. You can associate tags with the following Device Farm resources: PROJECT, RUN, NETWORK_PROFILE, INSTANCE_PROFILE, DEVICE_INSTANCE, SESSION, DEVICE_POOL, DEVICE, and VPCE_CONFIGURATION.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of the tags to be removed.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDeviceInstanceRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the device instance.

" + }, + "profileArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.

" + }, + "labels":{ + "shape":"InstanceLabels", + "documentation":"

An array of strings that you want to associate with the device instance.

" + } + } + }, + "UpdateDeviceInstanceResult":{ + "type":"structure", + "members":{ + "deviceInstance":{ + "shape":"DeviceInstance", + "documentation":"

An object containing information about your device instance.

" + } + } + }, + "UpdateDevicePoolRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Device Farm device pool you wish to update.

" + }, + "name":{ + "shape":"Name", + "documentation":"

A string representing the name of the device pool you wish to update.

" + }, + "description":{ + "shape":"Message", + "documentation":"

A description of the device pool you wish to update.

" + }, + "rules":{ + "shape":"Rules", + "documentation":"

Represents the rules you wish to modify for the device pool. Updating rules is optional; however, if you choose to update rules for your request, the update will replace the existing rules.

" + }, + "maxDevices":{ + "shape":"Integer", + "documentation":"

The number of devices that Device Farm can add to your device pool. Device Farm adds devices that are available and that meet the criteria that you assign for the rules parameter. Depending on how many devices meet these constraints, your device pool might contain fewer devices than the value for this parameter.

By specifying the maximum number of devices, you can control the costs that you incur by running tests.

If you use this parameter in your request, you cannot use the clearMaxDevices parameter in the same request.

" + }, + "clearMaxDevices":{ + "shape":"Boolean", + "documentation":"

Sets whether the maxDevices parameter applies to your device pool. If you set this parameter to true, the maxDevices parameter does not apply, and Device Farm does not limit the number of devices that it adds to your device pool. In this case, Device Farm adds all available devices that meet the criteria that are specified for the rules parameter.

If you use this parameter in your request, you cannot use the maxDevices parameter in the same request.

" + } + }, + "documentation":"

Represents a request to the update device pool operation.

" + }, + "UpdateDevicePoolResult":{ + "type":"structure", + "members":{ + "devicePool":{ + "shape":"DevicePool", + "documentation":"

The device pool you just updated.

" + } + }, + "documentation":"

Represents the result of an update device pool request.

" + }, + "UpdateInstanceProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The updated name for your instance profile.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The updated description for your instance profile.

" + }, + "packageCleanup":{ + "shape":"Boolean", + "documentation":"

The updated choice for whether you want to specify package cleanup. The default value is false for private devices.

" + }, + "excludeAppPackagesFromCleanup":{ + "shape":"PackageIds", + "documentation":"

An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.

The list of packages is only considered if you set packageCleanup to true.

" + }, + "rebootAfterUse":{ + "shape":"Boolean", + "documentation":"

The updated choice for whether you want to reboot the device after use. The default value is true.

" + } + } + }, + "UpdateInstanceProfileResult":{ + "type":"structure", + "members":{ + "instanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

An object containing information about your instance profile.

" + } + } + }, + "UpdateNetworkProfileRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The name of the network profile about which you are returning information.

" + }, + "description":{ + "shape":"Message", + "documentation":"

The description of the network profile about which you are returning information.

" + }, + "type":{ + "shape":"NetworkProfileType", + "documentation":"

The type of network profile you wish to return information about. Valid values are listed below.

" + }, + "uplinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "downlinkBandwidthBits":{ + "shape":"Long", + "documentation":"

The data throughput rate in bits per second, as an integer from 0 to 104857600.

" + }, + "uplinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkDelayMs":{ + "shape":"Long", + "documentation":"

Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "downlinkJitterMs":{ + "shape":"Long", + "documentation":"

Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.

" + }, + "uplinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of transmitted packets that fail to arrive from 0 to 100 percent.

" + }, + "downlinkLossPercent":{ + "shape":"PercentInteger", + "documentation":"

Proportion of received packets that fail to arrive from 0 to 100 percent.

" + } + } + }, + "UpdateNetworkProfileResult":{ + "type":"structure", + "members":{ + "networkProfile":{ + "shape":"NetworkProfile", + "documentation":"

A list of the available network profiles.

" + } + } + }, + "UpdateProjectRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the project whose name you wish to update.

" + }, + "name":{ + "shape":"Name", + "documentation":"

A string representing the new name of the project that you are updating.

" + }, + "defaultJobTimeoutMinutes":{ + "shape":"JobTimeoutMinutes", + "documentation":"

The number of minutes a test run in the project will execute before it times out.

" + } + }, + "documentation":"

Represents a request to the update project operation.

" + }, + "UpdateProjectResult":{ + "type":"structure", + "members":{ + "project":{ + "shape":"Project", + "documentation":"

The project you wish to update.

" + } + }, + "documentation":"

Represents the result of an update project request.

" + }, + "UpdateUploadRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the uploaded test spec.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The upload's test spec file name. The name should not contain the '/' character. The test spec file name must end with the .yaml or .yml file extension.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The upload's content type (for example, \"application/x-yaml\").

" + }, + "editContent":{ + "shape":"Boolean", + "documentation":"

Set to true if the YAML file has changed and needs to be updated; otherwise, set to false.

" + } + } + }, + "UpdateUploadResult":{ + "type":"structure", + "members":{ + "upload":{ + "shape":"Upload", + "documentation":"

A test spec uploaded to Device Farm.

" + } + } + }, + "UpdateVPCEConfigurationRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the VPC endpoint configuration you want to update.

" + }, + "vpceConfigurationName":{ + "shape":"VPCEConfigurationName", + "documentation":"

The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

" + }, + "vpceServiceName":{ + "shape":"VPCEServiceName", + "documentation":"

The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.

" + }, + "serviceDnsName":{ + "shape":"ServiceDnsName", + "documentation":"

The DNS (domain) name used to connect to your private service in your Amazon VPC. The DNS name must not already be in use on the Internet.

" + }, + "vpceConfigurationDescription":{ + "shape":"VPCEConfigurationDescription", + "documentation":"

An optional description, providing more details about your VPC endpoint configuration.

" + } + } + }, + "UpdateVPCEConfigurationResult":{ + "type":"structure", + "members":{ + "vpceConfiguration":{ + "shape":"VPCEConfiguration", + "documentation":"

An object containing information about your VPC endpoint configuration.

" + } + } + }, + "Upload":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The upload's ARN.

" + }, + "name":{ + "shape":"Name", + "documentation":"

The upload's file name.

" + }, + "created":{ + "shape":"DateTime", + "documentation":"

When the upload was created.

" + }, + "type":{ + "shape":"UploadType", + "documentation":"

The upload's type.

Must be one of the following values:

  • ANDROID_APP: An Android upload.

  • IOS_APP: An iOS upload.

  • WEB_APP: A web application upload.

  • EXTERNAL_DATA: An external data upload.

  • APPIUM_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload.

  • APPIUM_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload.

  • APPIUM_PYTHON_TEST_PACKAGE: An Appium Python test package upload.

  • APPIUM_NODE_TEST_PACKAGE: An Appium Node.js test package upload.

  • APPIUM_RUBY_TEST_PACKAGE: An Appium Ruby test package upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE: An Appium Java JUnit test package upload for web apps.

  • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE: An Appium Java TestNG test package upload for web apps.

  • APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload for web apps.

  • APPIUM_WEB_NODE_TEST_PACKAGE: An Appium Node.js test package upload for web apps.

  • APPIUM_WEB_RUBY_TEST_PACKAGE: An Appium Ruby test package upload for web apps.

  • CALABASH_TEST_PACKAGE: A Calabash test package upload.

  • INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.

  • UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.

  • UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.

  • XCTEST_TEST_PACKAGE: An Xcode test package upload.

  • XCTEST_UI_TEST_PACKAGE: An Xcode UI test package upload.

  • APPIUM_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload.

  • APPIUM_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload.

  • APPIUM_PYTHON_TEST_SPEC: An Appium Python test spec upload.

  • APPIUM_NODE_TEST_SPEC: An Appium Node.js test spec upload.

  • APPIUM_RUBY_TEST_SPEC: An Appium Ruby test spec upload.

  • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC: An Appium Java JUnit test spec upload for a web app.

  • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC: An Appium Java TestNG test spec upload for a web app.

  • APPIUM_WEB_PYTHON_TEST_SPEC: An Appium Python test spec upload for a web app.

  • APPIUM_WEB_NODE_TEST_SPEC: An Appium Node.js test spec upload for a web app.

  • APPIUM_WEB_RUBY_TEST_SPEC: An Appium Ruby test spec upload for a web app.

  • INSTRUMENTATION_TEST_SPEC: An instrumentation test spec upload.

  • XCTEST_UI_TEST_SPEC: An Xcode UI test spec upload.

" + }, + "status":{ + "shape":"UploadStatus", + "documentation":"

The upload's status.

Must be one of the following values:

  • FAILED: A failed status.

  • INITIALIZED: An initialized status.

  • PROCESSING: A processing status.

  • SUCCEEDED: A succeeded status.

" + }, + "url":{ + "shape":"URL", + "documentation":"

The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.

" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"

The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The upload's content type (for example, \"application/octet-stream\").

" + }, + "message":{ + "shape":"Message", + "documentation":"

A message about the upload's result.

" + }, + "category":{ + "shape":"UploadCategory", + "documentation":"

The upload's category. Allowed values include:

  • CURATED: An upload managed by AWS Device Farm.

  • PRIVATE: An upload managed by the AWS Device Farm customer.

" + } + }, + "documentation":"

An app or a set of one or more tests to upload or that have been uploaded.

" + }, + "UploadCategory":{ + "type":"string", + "enum":[ + "CURATED", + "PRIVATE" + ] + }, + "UploadStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "PROCESSING", + "SUCCEEDED", + "FAILED" + ] + }, + "UploadType":{ + "type":"string", + "enum":[ + "ANDROID_APP", + "IOS_APP", + "WEB_APP", + "EXTERNAL_DATA", + "APPIUM_JAVA_JUNIT_TEST_PACKAGE", + "APPIUM_JAVA_TESTNG_TEST_PACKAGE", + "APPIUM_PYTHON_TEST_PACKAGE", + "APPIUM_NODE_TEST_PACKAGE", + "APPIUM_RUBY_TEST_PACKAGE", + "APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE", + "APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE", + "APPIUM_WEB_PYTHON_TEST_PACKAGE", + "APPIUM_WEB_NODE_TEST_PACKAGE", + "APPIUM_WEB_RUBY_TEST_PACKAGE", + "CALABASH_TEST_PACKAGE", + "INSTRUMENTATION_TEST_PACKAGE", + "UIAUTOMATION_TEST_PACKAGE", + "UIAUTOMATOR_TEST_PACKAGE", + "XCTEST_TEST_PACKAGE", + "XCTEST_UI_TEST_PACKAGE", + "APPIUM_JAVA_JUNIT_TEST_SPEC", + "APPIUM_JAVA_TESTNG_TEST_SPEC", + "APPIUM_PYTHON_TEST_SPEC", + "APPIUM_NODE_TEST_SPEC", + "APPIUM_RUBY_TEST_SPEC", + "APPIUM_WEB_JAVA_JUNIT_TEST_SPEC", + "APPIUM_WEB_JAVA_TESTNG_TEST_SPEC", + "APPIUM_WEB_PYTHON_TEST_SPEC", + "APPIUM_WEB_NODE_TEST_SPEC", + "APPIUM_WEB_RUBY_TEST_SPEC", + "INSTRUMENTATION_TEST_SPEC", + "XCTEST_UI_TEST_SPEC" + ] + }, + "Uploads":{ + "type":"list", + "member":{"shape":"Upload"} + }, + "VPCEConfiguration":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the VPC endpoint configuration.

" + }, + "vpceConfigurationName":{ + "shape":"VPCEConfigurationName", + "documentation":"

The friendly name you give to your VPC endpoint configuration, to manage your configurations more easily.

" + }, + "vpceServiceName":{ + "shape":"VPCEServiceName", + "documentation":"

The name of the VPC endpoint service running inside your AWS account that you want Device Farm to test.

" + }, + "serviceDnsName":{ + "shape":"ServiceDnsName", + "documentation":"

The DNS name that maps to the private IP address of the service you want to access.

" + }, + "vpceConfigurationDescription":{ + "shape":"VPCEConfigurationDescription", + "documentation":"

An optional description, providing more details about your VPC endpoint configuration.

" + } + }, + "documentation":"

Represents an Amazon Virtual Private Cloud (VPC) endpoint configuration.

" + }, + "VPCEConfigurationDescription":{ + "type":"string", + "max":2048, + "min":0 + }, + "VPCEConfigurationName":{ + "type":"string", + "max":1024, + "min":0 + }, + "VPCEConfigurations":{ + "type":"list", + "member":{"shape":"VPCEConfiguration"} + }, + "VPCEServiceName":{ + "type":"string", + "max":2048, + "min":0 + }, + "VideoCapture":{"type":"boolean"} + }, + "documentation":"

AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.

" +} diff --git a/aws/dist/botocore/data/directconnect/2012-10-25/examples-1.json b/aws/dist/botocore/data/directconnect/2012-10-25/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/directconnect/2012-10-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/directconnect/2012-10-25/paginators-1.json b/aws/dist/botocore/data/directconnect/2012-10-25/paginators-1.json new file mode 100644 index 00000000..dbca668f --- /dev/null +++ b/aws/dist/botocore/data/directconnect/2012-10-25/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeDirectConnectGatewayAssociations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "directConnectGatewayAssociations" + }, + "DescribeDirectConnectGatewayAttachments": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "directConnectGatewayAttachments" + }, + "DescribeDirectConnectGateways": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "directConnectGateways" + } + } +} diff --git a/aws/dist/botocore/data/directconnect/2012-10-25/service-2.json b/aws/dist/botocore/data/directconnect/2012-10-25/service-2.json new file mode 100644 index 00000000..05dfa537 --- /dev/null +++ b/aws/dist/botocore/data/directconnect/2012-10-25/service-2.json @@ -0,0 +1,3235 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-10-25", + "endpointPrefix":"directconnect", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Direct Connect", + "serviceId":"Direct Connect", + "signatureVersion":"v4", + "targetPrefix":"OvertureService", + "uid":"directconnect-2012-10-25" + }, + "operations":{ + "AcceptDirectConnectGatewayAssociationProposal":{ + "name":"AcceptDirectConnectGatewayAssociationProposal", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptDirectConnectGatewayAssociationProposalRequest"}, + "output":{"shape":"AcceptDirectConnectGatewayAssociationProposalResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

" + }, + "AllocateConnectionOnInterconnect":{ + "name":"AllocateConnectionOnInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateConnectionOnInterconnectRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

", + "deprecated":true + }, + "AllocateHostedConnection":{ + "name":"AllocateHostedConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateHostedConnectionRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. AWS polices the hosted connection for the specified capacity and the AWS Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by AWS Direct Connect Partners only.

" + }, + "AllocatePrivateVirtualInterface":{ + "name":"AllocatePrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocatePrivateVirtualInterfaceRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Provisions a private virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

" + }, + "AllocatePublicVirtualInterface":{ + "name":"AllocatePublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocatePublicVirtualInterfaceRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Provisions a public virtual interface to be owned by the specified AWS account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified AWS account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

" + }, + "AllocateTransitVirtualInterface":{ + "name":"AllocateTransitVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateTransitVirtualInterfaceRequest"}, + "output":{"shape":"AllocateTransitVirtualInterfaceResult"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Provisions a transit virtual interface to be owned by the specified AWS account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified AWS account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

" + }, + "AssociateConnectionWithLag":{ + "name":"AssociateConnectionWithLag", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateConnectionWithLagRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS is interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that's currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

" + }, + "AssociateHostedConnection":{ + "name":"AssociateHostedConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateHostedConnectionRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.

Intended for use by AWS Direct Connect Partners only.

" + }, + "AssociateVirtualInterface":{ + "name":"AssociateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateVirtualInterfaceRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

" + }, + "ConfirmConnection":{ + "name":"ConfirmConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmConnectionRequest"}, + "output":{"shape":"ConfirmConnectionResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

" + }, + "ConfirmPrivateVirtualInterface":{ + "name":"ConfirmPrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmPrivateVirtualInterfaceRequest"}, + "output":{"shape":"ConfirmPrivateVirtualInterfaceResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Accepts ownership of a private virtual interface created by another AWS account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

" + }, + "ConfirmPublicVirtualInterface":{ + "name":"ConfirmPublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmPublicVirtualInterfaceRequest"}, + "output":{"shape":"ConfirmPublicVirtualInterfaceResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Accepts ownership of a public virtual interface created by another AWS account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

" + }, + "ConfirmTransitVirtualInterface":{ + "name":"ConfirmTransitVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmTransitVirtualInterfaceRequest"}, + "output":{"shape":"ConfirmTransitVirtualInterfaceResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Accepts ownership of a transit virtual interface created by another AWS account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

" + }, + "CreateBGPPeer":{ + "name":"CreateBGPPeer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBGPPeerRequest"}, + "output":{"shape":"CreateBGPPeerResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.

" + }, + "CreateConnection":{ + "name":"CreateConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConnectionRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a connection between a customer network and a specific AWS Direct Connect location.

A connection links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

" + }, + "CreateDirectConnectGateway":{ + "name":"CreateDirectConnectGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDirectConnectGatewayRequest"}, + "output":{"shape":"CreateDirectConnectGatewayResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

" + }, + "CreateDirectConnectGatewayAssociation":{ + "name":"CreateDirectConnectGatewayAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDirectConnectGatewayAssociationRequest"}, + "output":{"shape":"CreateDirectConnectGatewayAssociationResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

" + }, + "CreateDirectConnectGatewayAssociationProposal":{ + "name":"CreateDirectConnectGatewayAssociationProposal", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDirectConnectGatewayAssociationProposalRequest"}, + "output":{"shape":"CreateDirectConnectGatewayAssociationProposalResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can only associate a Direct Connect gateway and virtual private gateway or transit gateway when the account that owns the Direct Connect gateway and the account that owns the virtual private gateway or transit gateway have the same AWS Payer ID.

" + }, + "CreateInterconnect":{ + "name":"CreateInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInterconnectRequest"}, + "output":{"shape":"Interconnect"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates an interconnect between an AWS Direct Connect Partner's network and a specific AWS Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner's network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the AWS Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect Partner.

Intended for use by AWS Direct Connect Partners only.

" + }, + "CreateLag":{ + "name":"CreateLag", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLagRequest"}, + "output":{"shape":"Lag"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

" + }, + "CreatePrivateVirtualInterface":{ + "name":"CreatePrivateVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePrivateVirtualInterfaceRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different AWS Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

" + }, + "CreatePublicVirtualInterface":{ + "name":"CreatePublicVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePublicVirtualInterfaceRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

" + }, + "CreateTransitVirtualInterface":{ + "name":"CreateTransitVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransitVirtualInterfaceRequest"}, + "output":{"shape":"CreateTransitVirtualInterfaceResult"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

" + }, + "DeleteBGPPeer":{ + "name":"DeleteBGPPeer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBGPPeerRequest"}, + "output":{"shape":"DeleteBGPPeerResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

" + }, + "DeleteConnection":{ + "name":"DeleteConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConnectionRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the specified connection.

Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the AWS Direct Connect location, you must cancel your service with them separately.

" + }, + "DeleteDirectConnectGateway":{ + "name":"DeleteDirectConnectGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDirectConnectGatewayRequest"}, + "output":{"shape":"DeleteDirectConnectGatewayResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

" + }, + "DeleteDirectConnectGatewayAssociation":{ + "name":"DeleteDirectConnectGatewayAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDirectConnectGatewayAssociationRequest"}, + "output":{"shape":"DeleteDirectConnectGatewayAssociationResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

" + }, + "DeleteDirectConnectGatewayAssociationProposal":{ + "name":"DeleteDirectConnectGatewayAssociationProposal", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDirectConnectGatewayAssociationProposalRequest"}, + "output":{"shape":"DeleteDirectConnectGatewayAssociationProposalResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

" + }, + "DeleteInterconnect":{ + "name":"DeleteInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInterconnectRequest"}, + "output":{"shape":"DeleteInterconnectResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

" + }, + "DeleteLag":{ + "name":"DeleteLag", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLagRequest"}, + "output":{"shape":"Lag"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

" + }, + "DeleteVirtualInterface":{ + "name":"DeleteVirtualInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVirtualInterfaceRequest"}, + "output":{"shape":"DeleteVirtualInterfaceResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deletes a virtual interface.

" + }, + "DescribeConnectionLoa":{ + "name":"DescribeConnectionLoa", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionLoaRequest"}, + "output":{"shape":"DescribeConnectionLoaResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

", + "deprecated":true + }, + "DescribeConnections":{ + "name":"DescribeConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionsRequest"}, + "output":{"shape":"Connections"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Displays the specified connection or all connections in this Region.

" + }, + "DescribeConnectionsOnInterconnect":{ + "name":"DescribeConnectionsOnInterconnect", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionsOnInterconnectRequest"}, + "output":{"shape":"Connections"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by AWS Direct Connect Partners only.

", + "deprecated":true + }, + "DescribeDirectConnectGatewayAssociationProposals":{ + "name":"DescribeDirectConnectGatewayAssociationProposals", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectConnectGatewayAssociationProposalsRequest"}, + "output":{"shape":"DescribeDirectConnectGatewayAssociationProposalsResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

" + }, + "DescribeDirectConnectGatewayAssociations":{ + "name":"DescribeDirectConnectGatewayAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectConnectGatewayAssociationsRequest"}, + "output":{"shape":"DescribeDirectConnectGatewayAssociationsResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.

" + }, + "DescribeDirectConnectGatewayAttachments":{ + "name":"DescribeDirectConnectGatewayAttachments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectConnectGatewayAttachmentsRequest"}, + "output":{"shape":"DescribeDirectConnectGatewayAttachmentsResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

" + }, + "DescribeDirectConnectGateways":{ + "name":"DescribeDirectConnectGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectConnectGatewaysRequest"}, + "output":{"shape":"DescribeDirectConnectGatewaysResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

" + }, + "DescribeHostedConnections":{ + "name":"DescribeHostedConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostedConnectionsRequest"}, + "output":{"shape":"Connections"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by AWS Direct Connect Partners only.

" + }, + "DescribeInterconnectLoa":{ + "name":"DescribeInterconnectLoa", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInterconnectLoaRequest"}, + "output":{"shape":"DescribeInterconnectLoaResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

", + "deprecated":true + }, + "DescribeInterconnects":{ + "name":"DescribeInterconnects", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInterconnectsRequest"}, + "output":{"shape":"Interconnects"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the interconnects owned by the AWS account or only the specified interconnect.

" + }, + "DescribeLags":{ + "name":"DescribeLags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLagsRequest"}, + "output":{"shape":"Lags"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Describes all your link aggregation groups (LAG) or the specified LAG.

" + }, + "DescribeLoa":{ + "name":"DescribeLoa", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoaRequest"}, + "output":{"shape":"Loa"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see Requesting Cross Connects at AWS Direct Connect Locations in the AWS Direct Connect User Guide.

" + }, + "DescribeLocations":{ + "name":"DescribeLocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"Locations"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the AWS Direct Connect locations in the current AWS Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Describes the tags associated with the specified AWS Direct Connect resources.

" + }, + "DescribeVirtualGateways":{ + "name":"DescribeVirtualGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"VirtualGateways"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Lists the virtual private gateways owned by the AWS account.

You can create one or more AWS Direct Connect private virtual interfaces linked to a virtual private gateway.

" + }, + "DescribeVirtualInterfaces":{ + "name":"DescribeVirtualInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVirtualInterfacesRequest"}, + "output":{"shape":"VirtualInterfaces"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer network.

" + }, + "DisassociateConnectionFromLag":{ + "name":"DisassociateConnectionFromLag", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateConnectionFromLagRequest"}, + "output":{"shape":"Connection"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Adds the specified tags to the specified AWS Direct Connect resource. Each resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Removes one or more tags from the specified AWS Direct Connect resource.

" + }, + "UpdateDirectConnectGatewayAssociation":{ + "name":"UpdateDirectConnectGatewayAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDirectConnectGatewayAssociationRequest"}, + "output":{"shape":"UpdateDirectConnectGatewayAssociationResult"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

" + }, + "UpdateLag":{ + "name":"UpdateLag", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLagRequest"}, + "output":{"shape":"Lag"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Updates the attributes of the specified link aggregation group (LAG).

You can update the following attributes:

  • The name of the LAG.

  • The value for the minimum number of connections that must be operational for the LAG itself to be operational.

When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value and the number of operational connections falls below the specified value, the LAG automatically goes down to avoid over-utilization of the remaining connections. Adjust this value with care, as it could force the LAG down if it is set higher than the current number of operational connections.

" + }, + "UpdateVirtualInterfaceAttributes":{ + "name":"UpdateVirtualInterfaceAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVirtualInterfaceAttributesRequest"}, + "output":{"shape":"VirtualInterface"}, + "errors":[ + {"shape":"DirectConnectServerException"}, + {"shape":"DirectConnectClientException"} + ], + "documentation":"

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

" + } + }, + "shapes":{ + "ASN":{"type":"integer"}, + "AcceptDirectConnectGatewayAssociationProposalRequest":{ + "type":"structure", + "required":[ + "directConnectGatewayId", + "proposalId", + "associatedGatewayOwnerAccount" + ], + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "proposalId":{ + "shape":"DirectConnectGatewayAssociationProposalId", + "documentation":"

The ID of the request proposal.

" + }, + "associatedGatewayOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the virtual private gateway or transit gateway.

" + }, + "overrideAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

" + } + } + }, + "AcceptDirectConnectGatewayAssociationProposalResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"} + } + }, + "AddressFamily":{ + "type":"string", + "enum":[ + "ipv4", + "ipv6" + ] + }, + "AllocateConnectionOnInterconnectRequest":{ + "type":"structure", + "required":[ + "bandwidth", + "connectionName", + "ownerAccount", + "interconnectId", + "vlan" + ], + "members":{ + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"

The name of the provisioned connection.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account of the customer for whom the connection will be provisioned.

" + }, + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect on which the connection will be provisioned.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The dedicated VLAN provisioned to the connection.

" + } + } + }, + "AllocateHostedConnectionRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "bandwidth", + "connectionName", + "vlan" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the interconnect or LAG.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account ID of the customer for the connection.

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those AWS Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"

The name of the hosted connection.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The dedicated VLAN provisioned to the hosted connection.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the connection.

" + } + } + }, + "AllocatePrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "newPrivateVirtualInterfaceAllocation" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection on which the private virtual interface is provisioned.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the virtual private interface.

" + }, + "newPrivateVirtualInterfaceAllocation":{ + "shape":"NewPrivateVirtualInterfaceAllocation", + "documentation":"

Information about the private virtual interface.

" + } + } + }, + "AllocatePublicVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "newPublicVirtualInterfaceAllocation" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection on which the public virtual interface is provisioned.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the public virtual interface.

" + }, + "newPublicVirtualInterfaceAllocation":{ + "shape":"NewPublicVirtualInterfaceAllocation", + "documentation":"

Information about the public virtual interface.

" + } + } + }, + "AllocateTransitVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "ownerAccount", + "newTransitVirtualInterfaceAllocation" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection on which the transit virtual interface is provisioned.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the transit virtual interface.

" + }, + "newTransitVirtualInterfaceAllocation":{ + "shape":"NewTransitVirtualInterfaceAllocation", + "documentation":"

Information about the transit virtual interface.

" + } + } + }, + "AllocateTransitVirtualInterfaceResult":{ + "type":"structure", + "members":{ + "virtualInterface":{"shape":"VirtualInterface"} + } + }, + "AmazonAddress":{"type":"string"}, + "AssociateConnectionWithLagRequest":{ + "type":"structure", + "required":[ + "connectionId", + "lagId" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG with which to associate the connection.

" + } + } + }, + "AssociateHostedConnectionRequest":{ + "type":"structure", + "required":[ + "connectionId", + "parentConnectionId" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the hosted connection.

" + }, + "parentConnectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the interconnect or the LAG.

" + } + } + }, + "AssociateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "virtualInterfaceId", + "connectionId" + ], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the LAG or connection.

" + } + } + }, + "AssociatedGateway":{ + "type":"structure", + "members":{ + "id":{ + "shape":"GatewayIdentifier", + "documentation":"

The ID of the associated gateway.

" + }, + "type":{ + "shape":"GatewayType", + "documentation":"

The type of associated gateway.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The Region where the associated gateway is located.

" + } + }, + "documentation":"

Information about the associated gateway.

" + }, + "AssociatedGatewayId":{"type":"string"}, + "AvailablePortSpeeds":{ + "type":"list", + "member":{"shape":"PortSpeed"} + }, + "AwsDevice":{ + "type":"string", + "deprecated":true + }, + "AwsDeviceV2":{"type":"string"}, + "BGPAuthKey":{"type":"string"}, + "BGPPeer":{ + "type":"structure", + "members":{ + "bgpPeerId":{ + "shape":"BGPPeerId", + "documentation":"

The ID of the BGP peer.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "bgpPeerState":{ + "shape":"BGPPeerState", + "documentation":"

The state of the BGP peer. The following are the possible values:

  • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

  • pending: The BGP peer is created, and remains in this state until it is ready to be established.

  • available: The BGP peer is ready to be established.

  • deleting: The BGP peer is being deleted.

  • deleted: The BGP peer is deleted and cannot be established.

" + }, + "bgpStatus":{ + "shape":"BGPStatus", + "documentation":"

The status of the BGP peer. The following are the possible values:

  • up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

  • down: The BGP peer is down.

  • unknown: The BGP peer status is not available.

" + }, + "awsDeviceV2":{ + "shape":"AwsDeviceV2", + "documentation":"

The Direct Connect endpoint on which the BGP peer terminates.

" + } + }, + "documentation":"

Information about a BGP peer.

" + }, + "BGPPeerId":{"type":"string"}, + "BGPPeerList":{ + "type":"list", + "member":{"shape":"BGPPeer"} + }, + "BGPPeerState":{ + "type":"string", + "enum":[ + "verifying", + "pending", + "available", + "deleting", + "deleted" + ] + }, + "BGPStatus":{ + "type":"string", + "enum":[ + "up", + "down", + "unknown" + ] + }, + "Bandwidth":{"type":"string"}, + "BooleanFlag":{"type":"boolean"}, + "CIDR":{"type":"string"}, + "ConfirmConnectionRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the hosted connection.

" + } + } + }, + "ConfirmConnectionResponse":{ + "type":"structure", + "members":{ + "connectionState":{ + "shape":"ConnectionState", + "documentation":"

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

" + } + } + }, + "ConfirmPrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + } + } + }, + "ConfirmPrivateVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{ + "shape":"VirtualInterfaceState", + "documentation":"

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

" + } + } + }, + "ConfirmPublicVirtualInterfaceRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + } + } + }, + "ConfirmPublicVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{ + "shape":"VirtualInterfaceState", + "documentation":"

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

" + } + } + }, + "ConfirmTransitVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "virtualInterfaceId", + "directConnectGatewayId" + ], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + } + } + }, + "ConfirmTransitVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{ + "shape":"VirtualInterfaceState", + "documentation":"

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

" + } + } + }, + "Connection":{ + "type":"structure", + "members":{ + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the connection.

" + }, + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"

The name of the connection.

" + }, + "connectionState":{ + "shape":"ConnectionState", + "documentation":"

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The AWS Region where the connection is located.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the connection.

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the connection.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "partnerName":{ + "shape":"PartnerName", + "documentation":"

The name of the AWS Direct Connect service provider associated with the connection.

" + }, + "loaIssueTime":{ + "shape":"LoaIssueTime", + "documentation":"

The time of the most recent call to DescribeLoa for this connection.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "awsDevice":{ + "shape":"AwsDevice", + "documentation":"

The Direct Connect endpoint on which the physical connection terminates.

" + }, + "jumboFrameCapable":{ + "shape":"JumboFrameCapable", + "documentation":"

Indicates whether jumbo frames (9001 MTU) are supported.

" + }, + "awsDeviceV2":{ + "shape":"AwsDeviceV2", + "documentation":"

The Direct Connect endpoint on which the physical connection terminates.

" + }, + "hasLogicalRedundancy":{ + "shape":"HasLogicalRedundancy", + "documentation":"

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the connection.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the connection.

" + } + }, + "documentation":"

Information about an AWS Direct Connect connection.

" + }, + "ConnectionId":{"type":"string"}, + "ConnectionList":{ + "type":"list", + "member":{"shape":"Connection"} + }, + "ConnectionName":{"type":"string"}, + "ConnectionState":{ + "type":"string", + "enum":[ + "ordering", + "requested", + "pending", + "available", + "down", + "deleting", + "deleted", + "rejected", + "unknown" + ] + }, + "Connections":{ + "type":"structure", + "members":{ + "connections":{ + "shape":"ConnectionList", + "documentation":"

The connections.

" + } + } + }, + "Count":{"type":"integer"}, + "CreateBGPPeerRequest":{ + "type":"structure", + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "newBGPPeer":{ + "shape":"NewBGPPeer", + "documentation":"

Information about the BGP peer.

" + } + } + }, + "CreateBGPPeerResponse":{ + "type":"structure", + "members":{ + "virtualInterface":{ + "shape":"VirtualInterface", + "documentation":"

The virtual interface.

" + } + } + }, + "CreateConnectionRequest":{ + "type":"structure", + "required":[ + "location", + "bandwidth", + "connectionName" + ], + "members":{ + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the connection.

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the connection.

" + }, + "connectionName":{ + "shape":"ConnectionName", + "documentation":"

The name of the connection.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags to associate with the lag.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the requested connection.

" + } + } + }, + "CreateDirectConnectGatewayAssociationProposalRequest":{ + "type":"structure", + "required":[ + "directConnectGatewayId", + "directConnectGatewayOwnerAccount", + "gatewayId" + ], + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "directConnectGatewayOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the Direct Connect gateway.

" + }, + "gatewayId":{ + "shape":"GatewayIdToAssociate", + "documentation":"

The ID of the virtual private gateway or transit gateway.

" + }, + "addAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" + }, + "removeAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

" + } + } + }, + "CreateDirectConnectGatewayAssociationProposalResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociationProposal":{ + "shape":"DirectConnectGatewayAssociationProposal", + "documentation":"

Information about the Direct Connect gateway proposal.

" + } + } + }, + "CreateDirectConnectGatewayAssociationRequest":{ + "type":"structure", + "required":["directConnectGatewayId"], + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "gatewayId":{ + "shape":"GatewayIdToAssociate", + "documentation":"

The ID of the virtual private gateway or transit gateway.

" + }, + "addAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "CreateDirectConnectGatewayAssociationResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociation":{ + "shape":"DirectConnectGatewayAssociation", + "documentation":"

The association to be created.

" + } + } + }, + "CreateDirectConnectGatewayRequest":{ + "type":"structure", + "required":["directConnectGatewayName"], + "members":{ + "directConnectGatewayName":{ + "shape":"DirectConnectGatewayName", + "documentation":"

The name of the Direct Connect gateway.

" + }, + "amazonSideAsn":{ + "shape":"LongAsn", + "documentation":"

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

" + } + } + }, + "CreateDirectConnectGatewayResult":{ + "type":"structure", + "members":{ + "directConnectGateway":{ + "shape":"DirectConnectGateway", + "documentation":"

The Direct Connect gateway.

" + } + } + }, + "CreateInterconnectRequest":{ + "type":"structure", + "required":[ + "interconnectName", + "bandwidth", + "location" + ], + "members":{ + "interconnectName":{ + "shape":"InterconnectName", + "documentation":"

The name of the interconnect.

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The port bandwidth, in Gbps. The possible values are 1 and 10.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the interconnect.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags to associate with the interconnect.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the interconnect.

" + } + } + }, + "CreateLagRequest":{ + "type":"structure", + "required":[ + "numberOfConnections", + "location", + "connectionsBandwidth", + "lagName" + ], + "members":{ + "numberOfConnections":{ + "shape":"Count", + "documentation":"

The number of physical connections initially provisioned and bundled by the LAG.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location for the LAG.

" + }, + "connectionsBandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the individual physical connections bundled by the LAG. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps.

" + }, + "lagName":{ + "shape":"LagName", + "documentation":"

The name of the LAG.

" + }, + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of an existing connection to migrate to the LAG.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags to associate with the LAG.

" + }, + "childConnectionTags":{ + "shape":"TagList", + "documentation":"

The tags to associate with the automtically created LAGs.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the LAG.

" + } + } + }, + "CreatePrivateVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "newPrivateVirtualInterface" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "newPrivateVirtualInterface":{ + "shape":"NewPrivateVirtualInterface", + "documentation":"

Information about the private virtual interface.

" + } + } + }, + "CreatePublicVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "newPublicVirtualInterface" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "newPublicVirtualInterface":{ + "shape":"NewPublicVirtualInterface", + "documentation":"

Information about the public virtual interface.

" + } + } + }, + "CreateTransitVirtualInterfaceRequest":{ + "type":"structure", + "required":[ + "connectionId", + "newTransitVirtualInterface" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "newTransitVirtualInterface":{ + "shape":"NewTransitVirtualInterface", + "documentation":"

Information about the transit virtual interface.

" + } + } + }, + "CreateTransitVirtualInterfaceResult":{ + "type":"structure", + "members":{ + "virtualInterface":{"shape":"VirtualInterface"} + } + }, + "CustomerAddress":{"type":"string"}, + "DeleteBGPPeerRequest":{ + "type":"structure", + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "bgpPeerId":{ + "shape":"BGPPeerId", + "documentation":"

The ID of the BGP peer.

" + } + } + }, + "DeleteBGPPeerResponse":{ + "type":"structure", + "members":{ + "virtualInterface":{ + "shape":"VirtualInterface", + "documentation":"

The virtual interface.

" + } + } + }, + "DeleteConnectionRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + } + } + }, + "DeleteDirectConnectGatewayAssociationProposalRequest":{ + "type":"structure", + "required":["proposalId"], + "members":{ + "proposalId":{ + "shape":"DirectConnectGatewayAssociationProposalId", + "documentation":"

The ID of the proposal.

" + } + } + }, + "DeleteDirectConnectGatewayAssociationProposalResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociationProposal":{ + "shape":"DirectConnectGatewayAssociationProposal", + "documentation":"

The ID of the associated gateway.

" + } + } + }, + "DeleteDirectConnectGatewayAssociationRequest":{ + "type":"structure", + "members":{ + "associationId":{ + "shape":"DirectConnectGatewayAssociationId", + "documentation":"

The ID of the Direct Connect gateway association.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DeleteDirectConnectGatewayAssociationResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociation":{ + "shape":"DirectConnectGatewayAssociation", + "documentation":"

Information about the deleted association.

" + } + } + }, + "DeleteDirectConnectGatewayRequest":{ + "type":"structure", + "required":["directConnectGatewayId"], + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + } + } + }, + "DeleteDirectConnectGatewayResult":{ + "type":"structure", + "members":{ + "directConnectGateway":{ + "shape":"DirectConnectGateway", + "documentation":"

The Direct Connect gateway.

" + } + } + }, + "DeleteInterconnectRequest":{ + "type":"structure", + "required":["interconnectId"], + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect.

" + } + } + }, + "DeleteInterconnectResponse":{ + "type":"structure", + "members":{ + "interconnectState":{ + "shape":"InterconnectState", + "documentation":"

The state of the interconnect. The following are the possible values:

  • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The interconnect is approved, and is being initialized.

  • available: The network link is up, and the interconnect is ready for use.

  • down: The network link is down.

  • deleting: The interconnect is being deleted.

  • deleted: The interconnect is deleted.

  • unknown: The state of the interconnect is not available.

" + } + } + }, + "DeleteLagRequest":{ + "type":"structure", + "required":["lagId"], + "members":{ + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + } + } + }, + "DeleteVirtualInterfaceRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + } + } + }, + "DeleteVirtualInterfaceResponse":{ + "type":"structure", + "members":{ + "virtualInterfaceState":{ + "shape":"VirtualInterfaceState", + "documentation":"

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

" + } + } + }, + "DescribeConnectionLoaRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

" + }, + "loaContentType":{ + "shape":"LoaContentType", + "documentation":"

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" + } + } + }, + "DescribeConnectionLoaResponse":{ + "type":"structure", + "members":{ + "loa":{ + "shape":"Loa", + "documentation":"

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

" + } + } + }, + "DescribeConnectionsOnInterconnectRequest":{ + "type":"structure", + "required":["interconnectId"], + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect.

" + } + } + }, + "DescribeConnectionsRequest":{ + "type":"structure", + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + } + } + }, + "DescribeDirectConnectGatewayAssociationProposalsRequest":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "proposalId":{ + "shape":"DirectConnectGatewayAssociationProposalId", + "documentation":"

The ID of the proposal.

" + }, + "associatedGatewayId":{ + "shape":"AssociatedGatewayId", + "documentation":"

The ID of the associated gateway.

" + }, + "maxResults":{ + "shape":"MaxResultSetSize", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeDirectConnectGatewayAssociationProposalsResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociationProposals":{ + "shape":"DirectConnectGatewayAssociationProposalList", + "documentation":"

Describes the Direct Connect gateway association proposals.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeDirectConnectGatewayAssociationsRequest":{ + "type":"structure", + "members":{ + "associationId":{ + "shape":"DirectConnectGatewayAssociationId", + "documentation":"

The ID of the Direct Connect gateway association.

" + }, + "associatedGatewayId":{ + "shape":"AssociatedGatewayId", + "documentation":"

The ID of the associated gateway.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "maxResults":{ + "shape":"MaxResultSetSize", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token provided in the previous call to retrieve the next page.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DescribeDirectConnectGatewayAssociationsResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociations":{ + "shape":"DirectConnectGatewayAssociationList", + "documentation":"

Information about the associations.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to retrieve the next page.

" + } + } + }, + "DescribeDirectConnectGatewayAttachmentsRequest":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "maxResults":{ + "shape":"MaxResultSetSize", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token provided in the previous call to retrieve the next page.

" + } + } + }, + "DescribeDirectConnectGatewayAttachmentsResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAttachments":{ + "shape":"DirectConnectGatewayAttachmentList", + "documentation":"

The attachments.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to retrieve the next page.

" + } + } + }, + "DescribeDirectConnectGatewaysRequest":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "maxResults":{ + "shape":"MaxResultSetSize", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token provided in the previous call to retrieve the next page.

" + } + } + }, + "DescribeDirectConnectGatewaysResult":{ + "type":"structure", + "members":{ + "directConnectGateways":{ + "shape":"DirectConnectGatewayList", + "documentation":"

The Direct Connect gateways.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The token to retrieve the next page.

" + } + } + }, + "DescribeHostedConnectionsRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the interconnect or LAG.

" + } + } + }, + "DescribeInterconnectLoaRequest":{ + "type":"structure", + "required":["interconnectId"], + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

" + }, + "loaContentType":{ + "shape":"LoaContentType", + "documentation":"

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" + } + } + }, + "DescribeInterconnectLoaResponse":{ + "type":"structure", + "members":{ + "loa":{ + "shape":"Loa", + "documentation":"

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

" + } + } + }, + "DescribeInterconnectsRequest":{ + "type":"structure", + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect.

" + } + } + }, + "DescribeLagsRequest":{ + "type":"structure", + "members":{ + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + } + } + }, + "DescribeLoaRequest":{ + "type":"structure", + "required":["connectionId"], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of a connection, LAG, or interconnect.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

" + }, + "loaContentType":{ + "shape":"LoaContentType", + "documentation":"

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "required":["resourceArns"], + "members":{ + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

The Amazon Resource Names (ARNs) of the resources.

" + } + } + }, + "DescribeTagsResponse":{ + "type":"structure", + "members":{ + "resourceTags":{ + "shape":"ResourceTagList", + "documentation":"

Information about the tags.

" + } + } + }, + "DescribeVirtualInterfacesRequest":{ + "type":"structure", + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + } + } + }, + "DirectConnectClientException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

One or more parameters are not valid.

", + "exception":true + }, + "DirectConnectGateway":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "directConnectGatewayName":{ + "shape":"DirectConnectGatewayName", + "documentation":"

The name of the Direct Connect gateway.

" + }, + "amazonSideAsn":{ + "shape":"LongAsn", + "documentation":"

The autonomous system number (ASN) for the Amazon side of the connection.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the Direct Connect gateway.

" + }, + "directConnectGatewayState":{ + "shape":"DirectConnectGatewayState", + "documentation":"

The state of the Direct Connect gateway. The following are the possible values:

  • pending: The initial state after calling CreateDirectConnectGateway.

  • available: The Direct Connect gateway is ready for use.

  • deleting: The initial state after calling DeleteDirectConnectGateway.

  • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

" + }, + "stateChangeError":{ + "shape":"StateChangeError", + "documentation":"

The error message if the state of an object failed to advance.

" + } + }, + "documentation":"

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

" + }, + "DirectConnectGatewayAssociation":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "directConnectGatewayOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the associated gateway.

" + }, + "associationState":{ + "shape":"DirectConnectGatewayAssociationState", + "documentation":"

The state of the association. The following are the possible values:

  • associating: The initial state after calling CreateDirectConnectGatewayAssociation.

  • associated: The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

  • disassociating: The initial state after calling DeleteDirectConnectGatewayAssociation.

  • disassociated: The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

" + }, + "stateChangeError":{ + "shape":"StateChangeError", + "documentation":"

The error message if the state of an object failed to advance.

" + }, + "associatedGateway":{ + "shape":"AssociatedGateway", + "documentation":"

Information about the associated gateway.

" + }, + "associationId":{ + "shape":"DirectConnectGatewayAssociationId", + "documentation":"

The ID of the Direct Connect gateway association.

" + }, + "allowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway. Applies only to private virtual interfaces.

" + }, + "virtualGatewayRegion":{ + "shape":"VirtualGatewayRegion", + "documentation":"

The AWS Region where the virtual private gateway is located.

" + }, + "virtualGatewayOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the virtual private gateway.

" + } + }, + "documentation":"

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

" + }, + "DirectConnectGatewayAssociationId":{"type":"string"}, + "DirectConnectGatewayAssociationList":{ + "type":"list", + "member":{"shape":"DirectConnectGatewayAssociation"} + }, + "DirectConnectGatewayAssociationProposal":{ + "type":"structure", + "members":{ + "proposalId":{ + "shape":"DirectConnectGatewayAssociationProposalId", + "documentation":"

The ID of the association proposal.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "directConnectGatewayOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the Direct Connect gateway.

" + }, + "proposalState":{ + "shape":"DirectConnectGatewayAssociationProposalState", + "documentation":"

The state of the proposal. The following are possible values:

  • accepted: The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

  • deleted: The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

  • requested: The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

" + }, + "associatedGateway":{ + "shape":"AssociatedGateway", + "documentation":"

Information about the associated gateway.

" + }, + "existingAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

" + }, + "requestedAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" + } + }, + "documentation":"

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

" + }, + "DirectConnectGatewayAssociationProposalId":{"type":"string"}, + "DirectConnectGatewayAssociationProposalList":{ + "type":"list", + "member":{"shape":"DirectConnectGatewayAssociationProposal"} + }, + "DirectConnectGatewayAssociationProposalState":{ + "type":"string", + "enum":[ + "requested", + "accepted", + "deleted" + ] + }, + "DirectConnectGatewayAssociationState":{ + "type":"string", + "enum":[ + "associating", + "associated", + "disassociating", + "disassociated", + "updating" + ] + }, + "DirectConnectGatewayAttachment":{ + "type":"structure", + "members":{ + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "virtualInterfaceRegion":{ + "shape":"VirtualInterfaceRegion", + "documentation":"

The AWS Region where the virtual interface is located.

" + }, + "virtualInterfaceOwnerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the virtual interface.

" + }, + "attachmentState":{ + "shape":"DirectConnectGatewayAttachmentState", + "documentation":"

The state of the attachment. The following are the possible values:

  • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

  • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

  • detaching: The initial state after calling DeleteVirtualInterface.

  • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

" + }, + "attachmentType":{ + "shape":"DirectConnectGatewayAttachmentType", + "documentation":"

The type of attachment.

" + }, + "stateChangeError":{ + "shape":"StateChangeError", + "documentation":"

The error message if the state of an object failed to advance.

" + } + }, + "documentation":"

Information about an attachment between a Direct Connect gateway and a virtual interface.

" + }, + "DirectConnectGatewayAttachmentList":{ + "type":"list", + "member":{"shape":"DirectConnectGatewayAttachment"} + }, + "DirectConnectGatewayAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "DirectConnectGatewayAttachmentType":{ + "type":"string", + "enum":[ + "TransitVirtualInterface", + "PrivateVirtualInterface" + ] + }, + "DirectConnectGatewayId":{"type":"string"}, + "DirectConnectGatewayList":{ + "type":"list", + "member":{"shape":"DirectConnectGateway"} + }, + "DirectConnectGatewayName":{"type":"string"}, + "DirectConnectGatewayState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "DirectConnectServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A server-side error occurred.

", + "exception":true + }, + "DisassociateConnectionFromLagRequest":{ + "type":"structure", + "required":[ + "connectionId", + "lagId" + ], + "members":{ + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + } + } + }, + "DuplicateTagKeysException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A tag key was specified more than once.

", + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "GatewayIdToAssociate":{"type":"string"}, + "GatewayIdentifier":{"type":"string"}, + "GatewayType":{ + "type":"string", + "enum":[ + "virtualPrivateGateway", + "transitGateway" + ] + }, + "HasLogicalRedundancy":{ + "type":"string", + "enum":[ + "unknown", + "yes", + "no" + ] + }, + "Interconnect":{ + "type":"structure", + "members":{ + "interconnectId":{ + "shape":"InterconnectId", + "documentation":"

The ID of the interconnect.

" + }, + "interconnectName":{ + "shape":"InterconnectName", + "documentation":"

The name of the interconnect.

" + }, + "interconnectState":{ + "shape":"InterconnectState", + "documentation":"

The state of the interconnect. The following are the possible values:

  • requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The interconnect is approved, and is being initialized.

  • available: The network link is up, and the interconnect is ready for use.

  • down: The network link is down.

  • deleting: The interconnect is being deleted.

  • deleted: The interconnect is deleted.

  • unknown: The state of the interconnect is not available.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The AWS Region where the connection is located.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the connection.

" + }, + "bandwidth":{ + "shape":"Bandwidth", + "documentation":"

The bandwidth of the connection.

" + }, + "loaIssueTime":{ + "shape":"LoaIssueTime", + "documentation":"

The time of the most recent call to DescribeLoa for this connection.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "awsDevice":{ + "shape":"AwsDevice", + "documentation":"

The Direct Connect endpoint on which the physical connection terminates.

" + }, + "jumboFrameCapable":{ + "shape":"JumboFrameCapable", + "documentation":"

Indicates whether jumbo frames (9001 MTU) are supported.

" + }, + "awsDeviceV2":{ + "shape":"AwsDeviceV2", + "documentation":"

The Direct Connect endpoint on which the physical connection terminates.

" + }, + "hasLogicalRedundancy":{ + "shape":"HasLogicalRedundancy", + "documentation":"

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the interconnect.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the interconnect.

" + } + }, + "documentation":"

Information about an interconnect.

" + }, + "InterconnectId":{"type":"string"}, + "InterconnectList":{ + "type":"list", + "member":{"shape":"Interconnect"} + }, + "InterconnectName":{"type":"string"}, + "InterconnectState":{ + "type":"string", + "enum":[ + "requested", + "pending", + "available", + "down", + "deleting", + "deleted", + "unknown" + ] + }, + "Interconnects":{ + "type":"structure", + "members":{ + "interconnects":{ + "shape":"InterconnectList", + "documentation":"

The interconnects.

" + } + } + }, + "JumboFrameCapable":{"type":"boolean"}, + "Lag":{ + "type":"structure", + "members":{ + "connectionsBandwidth":{ + "shape":"Bandwidth", + "documentation":"

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps and 10Gbps.

" + }, + "numberOfConnections":{ + "shape":"Count", + "documentation":"

The number of physical connections bundled by the LAG, up to a maximum of 10.

" + }, + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the LAG.

" + }, + "lagName":{ + "shape":"LagName", + "documentation":"

The name of the LAG.

" + }, + "lagState":{ + "shape":"LagState", + "documentation":"

The state of the LAG. The following are the possible values:

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

  • pending: The LAG has been approved and is being initialized.

  • available: The network link is established and the LAG is ready for use.

  • down: The network link is down.

  • deleting: The LAG is being deleted.

  • deleted: The LAG is deleted.

  • unknown: The state of the LAG is not available.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the LAG.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The AWS Region where the connection is located.

" + }, + "minimumLinks":{ + "shape":"Count", + "documentation":"

The minimum number of physical connections that must be operational for the LAG itself to be operational.

" + }, + "awsDevice":{ + "shape":"AwsDevice", + "documentation":"

The AWS Direct Connect endpoint that hosts the LAG.

" + }, + "awsDeviceV2":{ + "shape":"AwsDeviceV2", + "documentation":"

The AWS Direct Connect endpoint that hosts the LAG.

" + }, + "connections":{ + "shape":"ConnectionList", + "documentation":"

The connections bundled by the LAG.

" + }, + "allowsHostedConnections":{ + "shape":"BooleanFlag", + "documentation":"

Indicates whether the LAG can host other connections.

" + }, + "jumboFrameCapable":{ + "shape":"JumboFrameCapable", + "documentation":"

Indicates whether jumbo frames (9001 MTU) are supported.

" + }, + "hasLogicalRedundancy":{ + "shape":"HasLogicalRedundancy", + "documentation":"

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the LAG.

" + }, + "providerName":{ + "shape":"ProviderName", + "documentation":"

The name of the service provider associated with the LAG.

" + } + }, + "documentation":"

Information about a link aggregation group (LAG).

" + }, + "LagId":{"type":"string"}, + "LagList":{ + "type":"list", + "member":{"shape":"Lag"} + }, + "LagName":{"type":"string"}, + "LagState":{ + "type":"string", + "enum":[ + "requested", + "pending", + "available", + "down", + "deleting", + "deleted", + "unknown" + ] + }, + "Lags":{ + "type":"structure", + "members":{ + "lags":{ + "shape":"LagList", + "documentation":"

The LAGs.

" + } + } + }, + "Loa":{ + "type":"structure", + "members":{ + "loaContent":{ + "shape":"LoaContent", + "documentation":"

The binary contents of the LOA-CFA document.

" + }, + "loaContentType":{ + "shape":"LoaContentType", + "documentation":"

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

" + } + }, + "documentation":"

Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

" + }, + "LoaContent":{"type":"blob"}, + "LoaContentType":{ + "type":"string", + "enum":["application/pdf"] + }, + "LoaIssueTime":{"type":"timestamp"}, + "Location":{ + "type":"structure", + "members":{ + "locationCode":{ + "shape":"LocationCode", + "documentation":"

The code for the location.

" + }, + "locationName":{ + "shape":"LocationName", + "documentation":"

The name of the location. This includes the name of the colocation partner and the physical site of the building.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The AWS Region for the location.

" + }, + "availablePortSpeeds":{ + "shape":"AvailablePortSpeeds", + "documentation":"

The available port speeds for the location.

" + }, + "availableProviders":{ + "shape":"ProviderList", + "documentation":"

The name of the service provider for the location.

" + } + }, + "documentation":"

Information about an AWS Direct Connect location.

" + }, + "LocationCode":{"type":"string"}, + "LocationList":{ + "type":"list", + "member":{"shape":"Location"} + }, + "LocationName":{"type":"string"}, + "Locations":{ + "type":"structure", + "members":{ + "locations":{ + "shape":"LocationList", + "documentation":"

The locations.

" + } + } + }, + "LongAsn":{"type":"long"}, + "MTU":{"type":"integer"}, + "MaxResultSetSize":{ + "type":"integer", + "box":true + }, + "NewBGPPeer":{ + "type":"structure", + "members":{ + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + } + }, + "documentation":"

Information about a new BGP peer.

" + }, + "NewPrivateVirtualInterface":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the private virtual interface.

" + } + }, + "documentation":"

Information about a private virtual interface.

" + }, + "NewPrivateVirtualInterfaceAllocation":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the private virtual interface.

" + } + }, + "documentation":"

Information about a private virtual interface to be provisioned on a connection.

" + }, + "NewPublicVirtualInterface":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "routeFilterPrefixes":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the public virtual interface.

" + } + }, + "documentation":"

Information about a public virtual interface.

" + }, + "NewPublicVirtualInterfaceAllocation":{ + "type":"structure", + "required":[ + "virtualInterfaceName", + "vlan", + "asn" + ], + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "routeFilterPrefixes":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the public virtual interface.

" + } + }, + "documentation":"

Information about a public virtual interface to be provisioned on a connection.

" + }, + "NewTransitVirtualInterface":{ + "type":"structure", + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the transitive virtual interface.

" + } + }, + "documentation":"

Information about a transit virtual interface.

" + }, + "NewTransitVirtualInterfaceAllocation":{ + "type":"structure", + "members":{ + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the transitive virtual interface.

" + } + }, + "documentation":"

Information about a transit virtual interface to be provisioned on a connection.

" + }, + "OwnerAccount":{"type":"string"}, + "PaginationToken":{"type":"string"}, + "PartnerName":{"type":"string"}, + "PortSpeed":{"type":"string"}, + "ProviderList":{ + "type":"list", + "member":{"shape":"ProviderName"} + }, + "ProviderName":{"type":"string"}, + "Region":{"type":"string"}, + "ResourceArn":{"type":"string"}, + "ResourceArnList":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, + "ResourceTag":{ + "type":"structure", + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags.

" + } + }, + "documentation":"

Information about a tag associated with an AWS Direct Connect resource.

" + }, + "ResourceTagList":{ + "type":"list", + "member":{"shape":"ResourceTag"} + }, + "RouteFilterPrefix":{ + "type":"structure", + "members":{ + "cidr":{ + "shape":"CIDR", + "documentation":"

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

" + } + }, + "documentation":"

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

" + }, + "RouteFilterPrefixList":{ + "type":"list", + "member":{"shape":"RouteFilterPrefix"} + }, + "RouterConfig":{"type":"string"}, + "StateChangeError":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The value.

" + } + }, + "documentation":"

Information about a tag.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags to add.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the limit on the number of tags that can be assigned.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tag keys of the tags to remove.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDirectConnectGatewayAssociationRequest":{ + "type":"structure", + "members":{ + "associationId":{ + "shape":"DirectConnectGatewayAssociationId", + "documentation":"

The ID of the Direct Connect gateway association.

" + }, + "addAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

" + }, + "removeAllowedPrefixesToDirectConnectGateway":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

" + } + } + }, + "UpdateDirectConnectGatewayAssociationResult":{ + "type":"structure", + "members":{ + "directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"} + } + }, + "UpdateLagRequest":{ + "type":"structure", + "required":["lagId"], + "members":{ + "lagId":{ + "shape":"LagId", + "documentation":"

The ID of the LAG.

" + }, + "lagName":{ + "shape":"LagName", + "documentation":"

The name of the LAG.

" + }, + "minimumLinks":{ + "shape":"Count", + "documentation":"

The minimum number of physical connections that must be operational for the LAG itself to be operational.

" + } + } + }, + "UpdateVirtualInterfaceAttributesRequest":{ + "type":"structure", + "required":["virtualInterfaceId"], + "members":{ + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual private interface.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + } + } + }, + "VLAN":{"type":"integer"}, + "VirtualGateway":{ + "type":"structure", + "members":{ + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "virtualGatewayState":{ + "shape":"VirtualGatewayState", + "documentation":"

The state of the virtual private gateway. The following are the possible values:

  • pending: Initial state after creating the virtual private gateway.

  • available: Ready for use by a private virtual interface.

  • deleting: Initial state after deleting the virtual private gateway.

  • deleted: The virtual private gateway is deleted. The private virtual interface is unable to send traffic over this gateway.

" + } + }, + "documentation":"

Information about a virtual private gateway for a private virtual interface.

" + }, + "VirtualGatewayId":{"type":"string"}, + "VirtualGatewayList":{ + "type":"list", + "member":{"shape":"VirtualGateway"} + }, + "VirtualGatewayRegion":{ + "type":"string", + "deprecated":true + }, + "VirtualGatewayState":{"type":"string"}, + "VirtualGateways":{ + "type":"structure", + "members":{ + "virtualGateways":{ + "shape":"VirtualGatewayList", + "documentation":"

The virtual private gateways.

" + } + } + }, + "VirtualInterface":{ + "type":"structure", + "members":{ + "ownerAccount":{ + "shape":"OwnerAccount", + "documentation":"

The ID of the AWS account that owns the virtual interface.

" + }, + "virtualInterfaceId":{ + "shape":"VirtualInterfaceId", + "documentation":"

The ID of the virtual interface.

" + }, + "location":{ + "shape":"LocationCode", + "documentation":"

The location of the connection.

" + }, + "connectionId":{ + "shape":"ConnectionId", + "documentation":"

The ID of the connection.

" + }, + "virtualInterfaceType":{ + "shape":"VirtualInterfaceType", + "documentation":"

The type of virtual interface. The possible values are private and public.

" + }, + "virtualInterfaceName":{ + "shape":"VirtualInterfaceName", + "documentation":"

The name of the virtual interface assigned by the customer network.

" + }, + "vlan":{ + "shape":"VLAN", + "documentation":"

The ID of the VLAN.

" + }, + "asn":{ + "shape":"ASN", + "documentation":"

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

" + }, + "amazonSideAsn":{ + "shape":"LongAsn", + "documentation":"

The autonomous system number (ASN) for the Amazon side of the connection.

" + }, + "authKey":{ + "shape":"BGPAuthKey", + "documentation":"

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

" + }, + "amazonAddress":{ + "shape":"AmazonAddress", + "documentation":"

The IP address assigned to the Amazon interface.

" + }, + "customerAddress":{ + "shape":"CustomerAddress", + "documentation":"

The IP address assigned to the customer interface.

" + }, + "addressFamily":{ + "shape":"AddressFamily", + "documentation":"

The address family for the BGP peer.

" + }, + "virtualInterfaceState":{ + "shape":"VirtualInterfaceState", + "documentation":"

The state of the virtual interface. The following are the possible values:

  • confirming: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.

  • verifying: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.

  • pending: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.

  • available: A virtual interface that is able to forward traffic.

  • down: A virtual interface that is BGP down.

  • deleting: A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.

  • deleted: A virtual interface that cannot forward traffic.

  • rejected: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the Confirming state is deleted by the virtual interface owner, the virtual interface enters the Rejected state.

  • unknown: The state of the virtual interface is not available.

" + }, + "customerRouterConfig":{ + "shape":"RouterConfig", + "documentation":"

The customer router configuration.

" + }, + "mtu":{ + "shape":"MTU", + "documentation":"

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

" + }, + "jumboFrameCapable":{ + "shape":"JumboFrameCapable", + "documentation":"

Indicates whether jumbo frames (9001 MTU) are supported.

" + }, + "virtualGatewayId":{ + "shape":"VirtualGatewayId", + "documentation":"

The ID of the virtual private gateway. Applies only to private virtual interfaces.

" + }, + "directConnectGatewayId":{ + "shape":"DirectConnectGatewayId", + "documentation":"

The ID of the Direct Connect gateway.

" + }, + "routeFilterPrefixes":{ + "shape":"RouteFilterPrefixList", + "documentation":"

The routes to be advertised to the AWS network in this Region. Applies to public virtual interfaces.

" + }, + "bgpPeers":{ + "shape":"BGPPeerList", + "documentation":"

The BGP peers configured on this virtual interface.

" + }, + "region":{ + "shape":"Region", + "documentation":"

The AWS Region where the virtual interface is located.

" + }, + "awsDeviceV2":{ + "shape":"AwsDeviceV2", + "documentation":"

The Direct Connect endpoint on which the virtual interface terminates.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the virtual interface.

" + } + }, + "documentation":"

Information about a virtual interface.

" + }, + "VirtualInterfaceId":{"type":"string"}, + "VirtualInterfaceList":{ + "type":"list", + "member":{"shape":"VirtualInterface"} + }, + "VirtualInterfaceName":{"type":"string"}, + "VirtualInterfaceRegion":{"type":"string"}, + "VirtualInterfaceState":{ + "type":"string", + "enum":[ + "confirming", + "verifying", + "pending", + "available", + "down", + "deleting", + "deleted", + "rejected", + "unknown" + ] + }, + "VirtualInterfaceType":{"type":"string"}, + "VirtualInterfaces":{ + "type":"structure", + "members":{ + "virtualInterfaces":{ + "shape":"VirtualInterfaceList", + "documentation":"

The virtual interfaces

" + } + } + } + }, + "documentation":"

AWS Direct Connect links your internal network to an AWS Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. With this connection in place, you can create virtual interfaces directly to the AWS cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all AWS Regions except the China (Beijing) and (China) Ningxia Regions. AWS resources in the China Regions can only be accessed through locations associated with those Regions.

" +} diff --git a/aws/dist/botocore/data/discovery/2015-11-01/examples-1.json b/aws/dist/botocore/data/discovery/2015-11-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/discovery/2015-11-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/discovery/2015-11-01/paginators-1.json b/aws/dist/botocore/data/discovery/2015-11-01/paginators-1.json new file mode 100644 index 00000000..9afc883b --- /dev/null +++ b/aws/dist/botocore/data/discovery/2015-11-01/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "DescribeAgents": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "agentsInfo" + }, + "DescribeContinuousExports": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "descriptions" + }, + "DescribeExportConfigurations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "exportsInfo" + }, + "DescribeExportTasks": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "exportsInfo" + }, + "DescribeTags": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "tags" + }, + "ListConfigurations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "configurations" + } + } +} diff --git a/aws/dist/botocore/data/discovery/2015-11-01/service-2.json b/aws/dist/botocore/data/discovery/2015-11-01/service-2.json new file mode 100644 index 00000000..1f54b8d9 --- /dev/null +++ b/aws/dist/botocore/data/discovery/2015-11-01/service-2.json @@ -0,0 +1,1920 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-11-01", + "endpointPrefix":"discovery", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Application Discovery Service", + "serviceId":"Application Discovery Service", + "signatureVersion":"v4", + "targetPrefix":"AWSPoseidonService_V2015_11_01", + "uid":"discovery-2015-11-01" + }, + "operations":{ + "AssociateConfigurationItemsToApplication":{ + "name":"AssociateConfigurationItemsToApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateConfigurationItemsToApplicationRequest"}, + "output":{"shape":"AssociateConfigurationItemsToApplicationResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Associates one or more configuration items with an application.

" + }, + "BatchDeleteImportData":{ + "name":"BatchDeleteImportData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteImportDataRequest"}, + "output":{"shape":"BatchDeleteImportDataResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Deletes one or more import tasks, each identified by their import ID. Each import task has a number of records that can identify servers or applications.

AWS Application Discovery Service has built-in matching logic that will identify when discovered servers match existing entries that you've previously discovered, the information for the already-existing discovered server is updated. When you delete an import task that contains records that were used to match, the information in those matched records that comes from the deleted records will also be deleted.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Creates an application with the given name and description.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "output":{"shape":"CreateTagsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Creates one or more tags for configuration items. Tags are metadata that help you categorize IT assets. This API accepts a list of multiple configuration items.

" + }, + "DeleteApplications":{ + "name":"DeleteApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationsRequest"}, + "output":{"shape":"DeleteApplicationsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Deletes a list of applications and their associations with configuration items.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "output":{"shape":"DeleteTagsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Deletes the association between configuration items and one or more tags. This API accepts a list of multiple configuration items.

" + }, + "DescribeAgents":{ + "name":"DescribeAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAgentsRequest"}, + "output":{"shape":"DescribeAgentsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Lists agents or connectors as specified by ID or other filters. All agents/connectors associated with your user account can be listed if you call DescribeAgents as is without passing any parameters.

" + }, + "DescribeConfigurations":{ + "name":"DescribeConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationsRequest"}, + "output":{"shape":"DescribeConfigurationsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieves attributes for a list of configuration item IDs.

All of the supplied IDs must be for the same asset type from one of the following:

  • server

  • application

  • process

  • connection

Output fields are specific to the asset type specified. For example, the output for a server configuration item includes a list of attributes about the server, such as host name, operating system, number of network cards, etc.

For a complete list of outputs for each asset type, see Using the DescribeConfigurations Action.

" + }, + "DescribeContinuousExports":{ + "name":"DescribeContinuousExports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeContinuousExportsRequest"}, + "output":{"shape":"DescribeContinuousExportsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists exports as specified by ID. All continuous exports associated with your user account can be listed if you call DescribeContinuousExports as is without passing any parameters.

" + }, + "DescribeExportConfigurations":{ + "name":"DescribeExportConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportConfigurationsRequest"}, + "output":{"shape":"DescribeExportConfigurationsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

DescribeExportConfigurations is deprecated. Use DescribeImportTasks, instead.

", + "deprecated":true + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.

" + }, + "DescribeImportTasks":{ + "name":"DescribeImportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportTasksRequest"}, + "output":{"shape":"DescribeImportTasksResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Returns an array of import tasks for your account, including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieves a list of configuration items that have tags as specified by the key-value pairs, name and value, passed to the optional parameter filters.

There are three valid tag filter names:

  • tagKey

  • tagValue

  • configurationId

Also, all configuration items associated with your user account that have tags can be listed if you call DescribeTags as is without passing any parameters.

" + }, + "DisassociateConfigurationItemsFromApplication":{ + "name":"DisassociateConfigurationItemsFromApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateConfigurationItemsFromApplicationRequest"}, + "output":{"shape":"DisassociateConfigurationItemsFromApplicationResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Disassociates one or more configuration items from an application.

" + }, + "ExportConfigurations":{ + "name":"ExportConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"ExportConfigurationsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Deprecated. Use StartExportTask instead.

Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the DescribeExportConfigurations API. The system imposes a limit of two configuration exports in six hours.

", + "deprecated":true + }, + "GetDiscoverySummary":{ + "name":"GetDiscoverySummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDiscoverySummaryRequest"}, + "output":{"shape":"GetDiscoverySummaryResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieves a short summary of discovered assets.

This API operation takes no request parameters and is called as is at the command prompt as shown in the example.

" + }, + "ListConfigurations":{ + "name":"ListConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListConfigurationsRequest"}, + "output":{"shape":"ListConfigurationsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieves a list of configuration items as specified by the value passed to the required paramater configurationType. Optional filtering may be applied to refine search results.

" + }, + "ListServerNeighbors":{ + "name":"ListServerNeighbors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServerNeighborsRequest"}, + "output":{"shape":"ListServerNeighborsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Retrieves a list of servers that are one network hop away from a specified server.

" + }, + "StartContinuousExport":{ + "name":"StartContinuousExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartContinuousExportRequest"}, + "output":{"shape":"StartContinuousExportResponse"}, + "errors":[ + {"shape":"ConflictErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Start the continuous flow of agent's discovered data into Amazon Athena.

" + }, + "StartDataCollectionByAgentIds":{ + "name":"StartDataCollectionByAgentIds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDataCollectionByAgentIdsRequest"}, + "output":{"shape":"StartDataCollectionByAgentIdsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Instructs the specified agents or connectors to start collecting data.

" + }, + "StartExportTask":{ + "name":"StartExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartExportTaskRequest"}, + "output":{"shape":"StartExportTaskResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Begins the export of discovered data to an S3 bucket.

If you specify agentIds in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using startTime and endTime. Export of detailed agent data is limited to five concurrently running exports.

If you do not include an agentIds filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day.

" + }, + "StartImportTask":{ + "name":"StartImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartImportTaskRequest"}, + "output":{"shape":"StartImportTaskResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Starts an import task, which allows you to import details of your on-premises environment directly into AWS without having to use the Application Discovery Service (ADS) tools such as the Discovery Connector or Discovery Agent. This gives you the option to perform migration assessment and planning directly from your imported data, including the ability to group your devices as applications and track their migration status.

To start an import request, do this:

  1. Download the specially formatted comma separated value (CSV) import template, which you can find here: https://s3-us-west-2.amazonaws.com/templates-7cffcf56-bd96-4b1c-b45b-a5b42f282e46/import_template.csv.

  2. Fill out the template with your server and application data.

  3. Upload your import file to an Amazon S3 bucket, and make a note of it's Object URL. Your import file must be in the CSV format.

  4. Use the console or the StartImportTask command with the AWS CLI or one of the AWS SDKs to import the records from your file.

For more information, including step-by-step procedures, see Migration Hub Import in the AWS Application Discovery Service User Guide.

There are limits to the number of import tasks you can create (and delete) in an AWS account. For more information, see AWS Application Discovery Service Limits in the AWS Application Discovery Service User Guide.

" + }, + "StopContinuousExport":{ + "name":"StopContinuousExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopContinuousExportRequest"}, + "output":{"shape":"StopContinuousExportResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Stop the continuous flow of agent's discovered data into Amazon Athena.

" + }, + "StopDataCollectionByAgentIds":{ + "name":"StopDataCollectionByAgentIds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDataCollectionByAgentIdsRequest"}, + "output":{"shape":"StopDataCollectionByAgentIdsResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Instructs the specified agents or connectors to stop collecting data.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalErrorException"} + ], + "documentation":"

Updates metadata about an application.

" + } + }, + "shapes":{ + "AgentConfigurationStatus":{ + "type":"structure", + "members":{ + "agentId":{ + "shape":"String", + "documentation":"

The agent/connector ID.

" + }, + "operationSucceeded":{ + "shape":"Boolean", + "documentation":"

Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command.

" + }, + "description":{ + "shape":"String", + "documentation":"

A description of the operation performed.

" + } + }, + "documentation":"

Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.

" + }, + "AgentConfigurationStatusList":{ + "type":"list", + "member":{"shape":"AgentConfigurationStatus"} + }, + "AgentId":{"type":"string"}, + "AgentIds":{ + "type":"list", + "member":{"shape":"AgentId"} + }, + "AgentInfo":{ + "type":"structure", + "members":{ + "agentId":{ + "shape":"AgentId", + "documentation":"

The agent or connector ID.

" + }, + "hostName":{ + "shape":"String", + "documentation":"

The name of the host where the agent or connector resides. The host can be a server or virtual machine.

" + }, + "agentNetworkInfoList":{ + "shape":"AgentNetworkInfoList", + "documentation":"

Network details about the host where the agent or connector resides.

" + }, + "connectorId":{ + "shape":"String", + "documentation":"

The ID of the connector.

" + }, + "version":{ + "shape":"String", + "documentation":"

The agent or connector version.

" + }, + "health":{ + "shape":"AgentStatus", + "documentation":"

The health of the agent or connector.

" + }, + "lastHealthPingTime":{ + "shape":"String", + "documentation":"

Time since agent or connector health was reported.

" + }, + "collectionStatus":{ + "shape":"String", + "documentation":"

Status of the collection process for an agent or connector.

" + }, + "agentType":{ + "shape":"String", + "documentation":"

Type of agent.

" + }, + "registeredTime":{ + "shape":"String", + "documentation":"

Agent's first registration timestamp in UTC.

" + } + }, + "documentation":"

Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.

" + }, + "AgentNetworkInfo":{ + "type":"structure", + "members":{ + "ipAddress":{ + "shape":"String", + "documentation":"

The IP address for the host where the agent/connector resides.

" + }, + "macAddress":{ + "shape":"String", + "documentation":"

The MAC address for the host where the agent/connector resides.

" + } + }, + "documentation":"

Network details about the host where the agent/connector resides.

" + }, + "AgentNetworkInfoList":{ + "type":"list", + "member":{"shape":"AgentNetworkInfo"} + }, + "AgentStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "RUNNING", + "UNKNOWN", + "BLACKLISTED", + "SHUTDOWN" + ] + }, + "AgentsInfo":{ + "type":"list", + "member":{"shape":"AgentInfo"} + }, + "ApplicationId":{"type":"string"}, + "ApplicationIdsList":{ + "type":"list", + "member":{"shape":"ApplicationId"} + }, + "AssociateConfigurationItemsToApplicationRequest":{ + "type":"structure", + "required":[ + "applicationConfigurationId", + "configurationIds" + ], + "members":{ + "applicationConfigurationId":{ + "shape":"ApplicationId", + "documentation":"

The configuration ID of an application with which items are to be associated.

" + }, + "configurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

The ID of each configuration item to be associated with an application.

" + } + } + }, + "AssociateConfigurationItemsToApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "AuthorizationErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

", + "exception":true + }, + "BatchDeleteImportDataError":{ + "type":"structure", + "members":{ + "importTaskId":{ + "shape":"ImportTaskIdentifier", + "documentation":"

The unique import ID associated with the error that occurred.

" + }, + "errorCode":{ + "shape":"BatchDeleteImportDataErrorCode", + "documentation":"

The type of error that occurred for a specific import task.

" + }, + "errorDescription":{ + "shape":"BatchDeleteImportDataErrorDescription", + "documentation":"

The description of the error that occurred for a specific import task.

" + } + }, + "documentation":"

Error messages returned for each import task that you deleted as a response for this command.

" + }, + "BatchDeleteImportDataErrorCode":{ + "type":"string", + "enum":[ + "NOT_FOUND", + "INTERNAL_SERVER_ERROR", + "OVER_LIMIT" + ] + }, + "BatchDeleteImportDataErrorDescription":{"type":"string"}, + "BatchDeleteImportDataErrorList":{ + "type":"list", + "member":{"shape":"BatchDeleteImportDataError"} + }, + "BatchDeleteImportDataRequest":{ + "type":"structure", + "required":["importTaskIds"], + "members":{ + "importTaskIds":{ + "shape":"ToDeleteIdentifierList", + "documentation":"

The IDs for the import tasks that you want to delete.

" + } + } + }, + "BatchDeleteImportDataResponse":{ + "type":"structure", + "members":{ + "errors":{ + "shape":"BatchDeleteImportDataErrorList", + "documentation":"

Error messages returned for each import task that you deleted as a response for this command.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "BoxedInteger":{ + "type":"integer", + "box":true + }, + "ClientRequestToken":{ + "type":"string", + "max":100, + "min":1 + }, + "Condition":{"type":"string"}, + "Configuration":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "ConfigurationId":{"type":"string"}, + "ConfigurationIdList":{ + "type":"list", + "member":{"shape":"ConfigurationId"} + }, + "ConfigurationItemType":{ + "type":"string", + "enum":[ + "SERVER", + "PROCESS", + "CONNECTION", + "APPLICATION" + ] + }, + "ConfigurationTag":{ + "type":"structure", + "members":{ + "configurationType":{ + "shape":"ConfigurationItemType", + "documentation":"

A type of IT asset to tag.

" + }, + "configurationId":{ + "shape":"ConfigurationId", + "documentation":"

The configuration ID for the item to tag. You can specify a list of keys and values.

" + }, + "key":{ + "shape":"TagKey", + "documentation":"

A type of tag on which to filter. For example, serverType.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

A value on which to filter. For example key = serverType and value = web server.

" + }, + "timeOfCreation":{ + "shape":"TimeStamp", + "documentation":"

The time the configuration tag was created in Coordinated Universal Time (UTC).

" + } + }, + "documentation":"

Tags for a configuration item. Tags are metadata that help you categorize IT assets.

" + }, + "ConfigurationTagSet":{ + "type":"list", + "member":{"shape":"ConfigurationTag"} + }, + "Configurations":{ + "type":"list", + "member":{"shape":"Configuration"} + }, + "ConfigurationsDownloadUrl":{"type":"string"}, + "ConfigurationsExportId":{"type":"string"}, + "ConflictErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

", + "exception":true + }, + "ContinuousExportDescription":{ + "type":"structure", + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

The unique ID assigned to this export.

" + }, + "status":{ + "shape":"ContinuousExportStatus", + "documentation":"

Describes the status of the export. Can be one of the following values:

  • START_IN_PROGRESS - setting up resources to start continuous export.

  • START_FAILED - an error occurred setting up continuous export. To recover, call start-continuous-export again.

  • ACTIVE - data is being exported to the customer bucket.

  • ERROR - an error occurred during export. To fix the issue, call stop-continuous-export and start-continuous-export.

  • STOP_IN_PROGRESS - stopping the export.

  • STOP_FAILED - an error occurred stopping the export. To recover, call stop-continuous-export again.

  • INACTIVE - the continuous export has been stopped. Data is no longer being exported to the customer bucket.

" + }, + "statusDetail":{ + "shape":"StringMax255", + "documentation":"

Contains information about any errors that have occurred. This data type can have the following values:

  • ACCESS_DENIED - You don’t have permission to start Data Exploration in Amazon Athena. Contact your AWS administrator for help. For more information, see Setting Up AWS Application Discovery Service in the Application Discovery Service User Guide.

  • DELIVERY_STREAM_LIMIT_FAILURE - You reached the limit for Amazon Kinesis Data Firehose delivery streams. Reduce the number of streams or request a limit increase and try again. For more information, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

  • FIREHOSE_ROLE_MISSING - The Data Exploration feature is in an error state because your IAM User is missing the AWSApplicationDiscoveryServiceFirehose role. Turn on Data Exploration in Amazon Athena and try again. For more information, see Step 3: Provide Application Discovery Service Access to Non-Administrator Users by Attaching Policies in the Application Discovery Service User Guide.

  • FIREHOSE_STREAM_DOES_NOT_EXIST - The Data Exploration feature is in an error state because your IAM User is missing one or more of the Kinesis data delivery streams.

  • INTERNAL_FAILURE - The Data Exploration feature is in an error state because of an internal failure. Try again later. If this problem persists, contact AWS Support.

  • S3_BUCKET_LIMIT_FAILURE - You reached the limit for Amazon S3 buckets. Reduce the number of Amazon S3 buckets or request a limit increase and try again. For more information, see Bucket Restrictions and Limitations in the Amazon Simple Storage Service Developer Guide.

  • S3_NOT_SIGNED_UP - Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3.

" + }, + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The name of the s3 bucket where the export data parquet files are stored.

" + }, + "startTime":{ + "shape":"TimeStamp", + "documentation":"

The timestamp representing when the continuous export was started.

" + }, + "stopTime":{ + "shape":"TimeStamp", + "documentation":"

The timestamp that represents when this continuous export was stopped.

" + }, + "dataSource":{ + "shape":"DataSource", + "documentation":"

The type of data collector used to gather this data (currently only offered for AGENT).

" + }, + "schemaStorageConfig":{ + "shape":"SchemaStorageConfig", + "documentation":"

An object which describes how the data is stored.

  • databaseName - the name of the Glue database used to store the schema.

" + } + }, + "documentation":"

A list of continuous export descriptions.

" + }, + "ContinuousExportDescriptions":{ + "type":"list", + "member":{"shape":"ContinuousExportDescription"} + }, + "ContinuousExportIds":{ + "type":"list", + "member":{"shape":"ConfigurationsExportId"} + }, + "ContinuousExportStatus":{ + "type":"string", + "enum":[ + "START_IN_PROGRESS", + "START_FAILED", + "ACTIVE", + "ERROR", + "STOP_IN_PROGRESS", + "STOP_FAILED", + "INACTIVE" + ] + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

Name of the application to be created.

" + }, + "description":{ + "shape":"String", + "documentation":"

Description of the application to be created.

" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "members":{ + "configurationId":{ + "shape":"String", + "documentation":"

Configuration ID of an application to be created.

" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "configurationIds", + "tags" + ], + "members":{ + "configurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

A list of configuration items that you want to tag.

" + }, + "tags":{ + "shape":"TagSet", + "documentation":"

Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

" + } + } + }, + "CreateTagsResponse":{ + "type":"structure", + "members":{ + } + }, + "CustomerAgentInfo":{ + "type":"structure", + "required":[ + "activeAgents", + "healthyAgents", + "blackListedAgents", + "shutdownAgents", + "unhealthyAgents", + "totalAgents", + "unknownAgents" + ], + "members":{ + "activeAgents":{ + "shape":"Integer", + "documentation":"

Number of active discovery agents.

" + }, + "healthyAgents":{ + "shape":"Integer", + "documentation":"

Number of healthy discovery agents

" + }, + "blackListedAgents":{ + "shape":"Integer", + "documentation":"

Number of blacklisted discovery agents.

" + }, + "shutdownAgents":{ + "shape":"Integer", + "documentation":"

Number of discovery agents with status SHUTDOWN.

" + }, + "unhealthyAgents":{ + "shape":"Integer", + "documentation":"

Number of unhealthy discovery agents.

" + }, + "totalAgents":{ + "shape":"Integer", + "documentation":"

Total number of discovery agents.

" + }, + "unknownAgents":{ + "shape":"Integer", + "documentation":"

Number of unknown discovery agents.

" + } + }, + "documentation":"

Inventory data for installed discovery agents.

" + }, + "CustomerConnectorInfo":{ + "type":"structure", + "required":[ + "activeConnectors", + "healthyConnectors", + "blackListedConnectors", + "shutdownConnectors", + "unhealthyConnectors", + "totalConnectors", + "unknownConnectors" + ], + "members":{ + "activeConnectors":{ + "shape":"Integer", + "documentation":"

Number of active discovery connectors.

" + }, + "healthyConnectors":{ + "shape":"Integer", + "documentation":"

Number of healthy discovery connectors.

" + }, + "blackListedConnectors":{ + "shape":"Integer", + "documentation":"

Number of blacklisted discovery connectors.

" + }, + "shutdownConnectors":{ + "shape":"Integer", + "documentation":"

Number of discovery connectors with status SHUTDOWN,

" + }, + "unhealthyConnectors":{ + "shape":"Integer", + "documentation":"

Number of unhealthy discovery connectors.

" + }, + "totalConnectors":{ + "shape":"Integer", + "documentation":"

Total number of discovery connectors.

" + }, + "unknownConnectors":{ + "shape":"Integer", + "documentation":"

Number of unknown discovery connectors.

" + } + }, + "documentation":"

Inventory data for installed discovery connectors.

" + }, + "DataSource":{ + "type":"string", + "enum":["AGENT"] + }, + "DatabaseName":{ + "type":"string", + "max":252, + "min":1 + }, + "DeleteApplicationsRequest":{ + "type":"structure", + "required":["configurationIds"], + "members":{ + "configurationIds":{ + "shape":"ApplicationIdsList", + "documentation":"

Configuration ID of an application to be deleted.

" + } + } + }, + "DeleteApplicationsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["configurationIds"], + "members":{ + "configurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

A list of configuration items with tags that you want to delete.

" + }, + "tags":{ + "shape":"TagSet", + "documentation":"

Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

" + } + } + }, + "DeleteTagsResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeAgentsRequest":{ + "type":"structure", + "members":{ + "agentIds":{ + "shape":"AgentIds", + "documentation":"

The agent or the Connector IDs for which you want information. If you specify no IDs, the system returns information about all agents/Connectors associated with your AWS user account.

" + }, + "filters":{ + "shape":"Filters", + "documentation":"

You can filter the request using various logical operators and a key-value format. For example:

{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The total number of agents/Connectors to return in a single page of output. The maximum value is 100.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" + } + } + }, + "DescribeAgentsResponse":{ + "type":"structure", + "members":{ + "agentsInfo":{ + "shape":"AgentsInfo", + "documentation":"

Lists agents or the Connector by ID or lists all agents/Connectors associated with your user account if you did not specify an agent/Connector ID. The output includes agent/Connector IDs, IP addresses, media access control (MAC) addresses, agent/Connector health, host name where the agent/Connector resides, and the version number of each agent/Connector.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Token to retrieve the next set of results. For example, if you specified 100 IDs for DescribeAgentsRequest$agentIds but set DescribeAgentsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" + } + } + }, + "DescribeConfigurationsAttribute":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "DescribeConfigurationsAttributes":{ + "type":"list", + "member":{"shape":"DescribeConfigurationsAttribute"} + }, + "DescribeConfigurationsRequest":{ + "type":"structure", + "required":["configurationIds"], + "members":{ + "configurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

One or more configuration IDs.

" + } + } + }, + "DescribeConfigurationsResponse":{ + "type":"structure", + "members":{ + "configurations":{ + "shape":"DescribeConfigurationsAttributes", + "documentation":"

A key in the response map. The value is an array of data.

" + } + } + }, + "DescribeContinuousExportsMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "DescribeContinuousExportsRequest":{ + "type":"structure", + "members":{ + "exportIds":{ + "shape":"ContinuousExportIds", + "documentation":"

The unique IDs assigned to the exports.

" + }, + "maxResults":{ + "shape":"DescribeContinuousExportsMaxResults", + "documentation":"

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous call to DescribeExportTasks.

" + } + } + }, + "DescribeContinuousExportsResponse":{ + "type":"structure", + "members":{ + "descriptions":{ + "shape":"ContinuousExportDescriptions", + "documentation":"

A list of continuous export descriptions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous call to DescribeExportTasks.

" + } + } + }, + "DescribeExportConfigurationsRequest":{ + "type":"structure", + "members":{ + "exportIds":{ + "shape":"ExportIds", + "documentation":"

A list of continuous export ids to search for.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

A number between 1 and 100 specifying the maximum number of continuous export descriptions returned.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous call to describe-export-tasks.

" + } + } + }, + "DescribeExportConfigurationsResponse":{ + "type":"structure", + "members":{ + "exportsInfo":{ + "shape":"ExportsInfo", + "documentation":"

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token from the previous call to describe-export-tasks.

" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "exportIds":{ + "shape":"ExportIds", + "documentation":"

One or more unique identifiers used to query the status of an export request.

" + }, + "filters":{ + "shape":"ExportFilters", + "documentation":"

One or more filters.

  • AgentId - ID of the agent whose collected data will be exported

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeExportTasks in paginated output. When this parameter is used, DescribeExportTasks only returns maxResults results in a single page along with a nextToken response element.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated DescribeExportTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

" + } + } + }, + "DescribeExportTasksResponse":{ + "type":"structure", + "members":{ + "exportsInfo":{ + "shape":"ExportsInfo", + "documentation":"

Contains one or more sets of export request details. When the status of a request is SUCCEEDED, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future DescribeExportTasks request. When the results of a DescribeExportTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeImportTasksFilterList":{ + "type":"list", + "member":{"shape":"ImportTaskFilter"} + }, + "DescribeImportTasksMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "DescribeImportTasksRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"DescribeImportTasksFilterList", + "documentation":"

An array of name-value pairs that you provide to filter the results for the DescribeImportTask request to a specific subset of results. Currently, wildcard values aren't supported for filters.

" + }, + "maxResults":{ + "shape":"DescribeImportTasksMaxResults", + "documentation":"

The maximum number of results that you want this request to return, up to 100.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to request a specific page of results.

" + } + } + }, + "DescribeImportTasksResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to request the next page of results.

" + }, + "tasks":{ + "shape":"ImportTaskList", + "documentation":"

A returned array of import tasks that match any applied filters, up to the specified number of maximum results.

" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"TagFilters", + "documentation":"

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The total number of items to return in a single page of output. The maximum value is 100.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to start the list. Use this token to get the next set of results.

" + } + } + }, + "DescribeTagsResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"ConfigurationTagSet", + "documentation":"

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The call returns a token. Use this token to get the next set of results.

" + } + } + }, + "DisassociateConfigurationItemsFromApplicationRequest":{ + "type":"structure", + "required":[ + "applicationConfigurationId", + "configurationIds" + ], + "members":{ + "applicationConfigurationId":{ + "shape":"ApplicationId", + "documentation":"

Configuration ID of an application from which each item is disassociated.

" + }, + "configurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

Configuration ID of each item to be disassociated from an application.

" + } + } + }, + "DisassociateConfigurationItemsFromApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "ExportConfigurationsResponse":{ + "type":"structure", + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

A unique identifier that you can use to query the export status.

" + } + } + }, + "ExportDataFormat":{ + "type":"string", + "enum":[ + "CSV", + "GRAPHML" + ] + }, + "ExportDataFormats":{ + "type":"list", + "member":{"shape":"ExportDataFormat"} + }, + "ExportFilter":{ + "type":"structure", + "required":[ + "name", + "values", + "condition" + ], + "members":{ + "name":{ + "shape":"FilterName", + "documentation":"

A single ExportFilter name. Supported filters: agentId.

" + }, + "values":{ + "shape":"FilterValues", + "documentation":"

A single agentId for a Discovery Agent. An agentId can be found using the DescribeAgents action. Typically an ADS agentId is in the form o-0123456789abcdef0.

" + }, + "condition":{ + "shape":"Condition", + "documentation":"

Supported condition: EQUALS

" + } + }, + "documentation":"

Used to select which agent's data is to be exported. A single agent ID may be selected for export using the StartExportTask action.

" + }, + "ExportFilters":{ + "type":"list", + "member":{"shape":"ExportFilter"} + }, + "ExportIds":{ + "type":"list", + "member":{"shape":"ConfigurationsExportId"} + }, + "ExportInfo":{ + "type":"structure", + "required":[ + "exportId", + "exportStatus", + "statusMessage", + "exportRequestTime" + ], + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

A unique identifier used to query an export.

" + }, + "exportStatus":{ + "shape":"ExportStatus", + "documentation":"

The status of the data export job.

" + }, + "statusMessage":{ + "shape":"ExportStatusMessage", + "documentation":"

A status message provided for API callers.

" + }, + "configurationsDownloadUrl":{ + "shape":"ConfigurationsDownloadUrl", + "documentation":"

A URL for an Amazon S3 bucket where you can review the exported data. The URL is displayed only if the export succeeded.

" + }, + "exportRequestTime":{ + "shape":"ExportRequestTime", + "documentation":"

The time that the data export was initiated.

" + }, + "isTruncated":{ + "shape":"Boolean", + "documentation":"

If true, the export of agent information exceeded the size limit for a single export and the exported data is incomplete for the requested time range. To address this, select a smaller time range for the export by using startDate and endDate.

" + }, + "requestedStartTime":{ + "shape":"TimeStamp", + "documentation":"

The value of startTime parameter in the StartExportTask request. If no startTime was requested, this result does not appear in ExportInfo.

" + }, + "requestedEndTime":{ + "shape":"TimeStamp", + "documentation":"

The endTime used in the StartExportTask request. If no endTime was requested, this result does not appear in ExportInfo.

" + } + }, + "documentation":"

Information regarding the export status of discovered data. The value is an array of objects.

" + }, + "ExportRequestTime":{"type":"timestamp"}, + "ExportStatus":{ + "type":"string", + "enum":[ + "FAILED", + "SUCCEEDED", + "IN_PROGRESS" + ] + }, + "ExportStatusMessage":{"type":"string"}, + "ExportsInfo":{ + "type":"list", + "member":{"shape":"ExportInfo"} + }, + "Filter":{ + "type":"structure", + "required":[ + "name", + "values", + "condition" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the filter.

" + }, + "values":{ + "shape":"FilterValues", + "documentation":"

A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

" + }, + "condition":{ + "shape":"Condition", + "documentation":"

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

" + } + }, + "documentation":"

A filter that can use conditional operators.

For more information about filters, see Querying Discovered Configuration Items.

" + }, + "FilterName":{"type":"string"}, + "FilterValue":{"type":"string"}, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"} + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetDiscoverySummaryRequest":{ + "type":"structure", + "members":{ + } + }, + "GetDiscoverySummaryResponse":{ + "type":"structure", + "members":{ + "servers":{ + "shape":"Long", + "documentation":"

The number of servers discovered.

" + }, + "applications":{ + "shape":"Long", + "documentation":"

The number of applications discovered.

" + }, + "serversMappedToApplications":{ + "shape":"Long", + "documentation":"

The number of servers mapped to applications.

" + }, + "serversMappedtoTags":{ + "shape":"Long", + "documentation":"

The number of servers mapped to tags.

" + }, + "agentSummary":{ + "shape":"CustomerAgentInfo", + "documentation":"

Details about discovered agents, including agent status and health.

" + }, + "connectorSummary":{ + "shape":"CustomerConnectorInfo", + "documentation":"

Details about discovered connectors, including connector status and health.

" + } + } + }, + "ImportStatus":{ + "type":"string", + "enum":[ + "IMPORT_IN_PROGRESS", + "IMPORT_COMPLETE", + "IMPORT_COMPLETE_WITH_ERRORS", + "IMPORT_FAILED", + "IMPORT_FAILED_SERVER_LIMIT_EXCEEDED", + "IMPORT_FAILED_RECORD_LIMIT_EXCEEDED", + "DELETE_IN_PROGRESS", + "DELETE_COMPLETE", + "DELETE_FAILED", + "DELETE_FAILED_LIMIT_EXCEEDED", + "INTERNAL_ERROR" + ] + }, + "ImportTask":{ + "type":"structure", + "members":{ + "importTaskId":{ + "shape":"ImportTaskIdentifier", + "documentation":"

The unique ID for a specific import task. These IDs aren't globally unique, but they are unique within an AWS account.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

A unique token used to prevent the same import request from occurring more than once. If you didn't provide a token, a token was automatically generated when the import task request was sent.

" + }, + "name":{ + "shape":"ImportTaskName", + "documentation":"

A descriptive name for an import task. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

" + }, + "importUrl":{ + "shape":"ImportURL", + "documentation":"

The URL for your import file that you've uploaded to Amazon S3.

" + }, + "status":{ + "shape":"ImportStatus", + "documentation":"

The status of the import task. An import can have the status of IMPORT_COMPLETE and still have some records fail to import from the overall request. More information can be found in the downloadable archive defined in the errorsAndFailedEntriesZip field, or in the Migration Hub management console.

" + }, + "importRequestTime":{ + "shape":"TimeStamp", + "documentation":"

The time that the import task request was made, presented in the Unix time stamp format.

" + }, + "importCompletionTime":{ + "shape":"TimeStamp", + "documentation":"

The time that the import task request finished, presented in the Unix time stamp format.

" + }, + "importDeletedTime":{ + "shape":"TimeStamp", + "documentation":"

The time that the import task request was deleted, presented in the Unix time stamp format.

" + }, + "serverImportSuccess":{ + "shape":"Integer", + "documentation":"

The total number of server records in the import file that were successfully imported.

" + }, + "serverImportFailure":{ + "shape":"Integer", + "documentation":"

The total number of server records in the import file that failed to be imported.

" + }, + "applicationImportSuccess":{ + "shape":"Integer", + "documentation":"

The total number of application records in the import file that were successfully imported.

" + }, + "applicationImportFailure":{ + "shape":"Integer", + "documentation":"

The total number of application records in the import file that failed to be imported.

" + }, + "errorsAndFailedEntriesZip":{ + "shape":"S3PresignedUrl", + "documentation":"

A link to a compressed archive folder (in the ZIP format) that contains an error log and a file of failed records. You can use these two files to quickly identify records that failed, why they failed, and correct those records. Afterward, you can upload the corrected file to your Amazon S3 bucket and create another import task request.

This field also includes authorization information so you can confirm the authenticity of the compressed archive before you download it.

If some records failed to be imported we recommend that you correct the records in the failed entries file and then imports that failed entries file. This prevents you from having to correct and update the larger original file and attempt importing it again.

" + } + }, + "documentation":"

An array of information related to the import task request that includes status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

" + }, + "ImportTaskFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ImportTaskFilterName", + "documentation":"

The name, status, or import task ID for a specific import task.

" + }, + "values":{ + "shape":"ImportTaskFilterValueList", + "documentation":"

An array of strings that you can provide to match against a specific name, status, or import task ID to filter the results for your import task queries.

" + } + }, + "documentation":"

A name-values pair of elements you can use to filter the results when querying your import tasks. Currently, wildcards are not supported for filters.

When filtering by import status, all other filter values are ignored.

" + }, + "ImportTaskFilterName":{ + "type":"string", + "enum":[ + "IMPORT_TASK_ID", + "STATUS", + "NAME" + ] + }, + "ImportTaskFilterValue":{ + "type":"string", + "max":100, + "min":1 + }, + "ImportTaskFilterValueList":{ + "type":"list", + "member":{"shape":"ImportTaskFilterValue"}, + "max":100, + "min":1 + }, + "ImportTaskIdentifier":{"type":"string"}, + "ImportTaskList":{ + "type":"list", + "member":{"shape":"ImportTask"} + }, + "ImportTaskName":{ + "type":"string", + "max":100, + "min":1 + }, + "ImportURL":{ + "type":"string", + "max":4000, + "min":1 + }, + "Integer":{"type":"integer"}, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

One or more parameters are not valid. Verify the parameters and try again.

", + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The value of one or more parameters are either invalid or out of range. Verify the parameter values and try again.

", + "exception":true + }, + "ListConfigurationsRequest":{ + "type":"structure", + "required":["configurationType"], + "members":{ + "configurationType":{ + "shape":"ConfigurationItemType", + "documentation":"

A valid configuration identified by Application Discovery Service.

" + }, + "filters":{ + "shape":"Filters", + "documentation":"

You can filter the request using various logical operators and a key-value format. For example:

{\"key\": \"serverType\", \"value\": \"webServer\"}

For a complete list of filter options and guidance about using them with this action, see Querying Discovered Configuration Items.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The total number of items to return. The maximum value is 100.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Token to retrieve the next set of results. For example, if a previous call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" + }, + "orderBy":{ + "shape":"OrderByList", + "documentation":"

Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see Using the ListConfigurations Action.

" + } + } + }, + "ListConfigurationsResponse":{ + "type":"structure", + "members":{ + "configurations":{ + "shape":"Configurations", + "documentation":"

Returns configuration details, including the configuration ID, attribute names, and attribute values.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Token to retrieve the next set of results. For example, if your call to ListConfigurations returned 100 items, but you set ListConfigurationsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" + } + } + }, + "ListServerNeighborsRequest":{ + "type":"structure", + "required":["configurationId"], + "members":{ + "configurationId":{ + "shape":"ConfigurationId", + "documentation":"

Configuration ID of the server for which neighbors are being listed.

" + }, + "portInformationNeeded":{ + "shape":"Boolean", + "documentation":"

Flag to indicate if port and protocol information is needed as part of the response.

" + }, + "neighborConfigurationIds":{ + "shape":"ConfigurationIdList", + "documentation":"

List of configuration IDs to test for one-hop-away.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

Maximum number of results to return in a single page of output.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

Token to retrieve the next set of results. For example, if you previously specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with a token. Use that token in this query to get the next set of 10.

" + } + } + }, + "ListServerNeighborsResponse":{ + "type":"structure", + "required":["neighbors"], + "members":{ + "neighbors":{ + "shape":"NeighborDetailsList", + "documentation":"

List of distinct servers that are one hop away from the given server.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

Token to retrieve the next set of results. For example, if you specified 100 IDs for ListServerNeighborsRequest$neighborConfigurationIds but set ListServerNeighborsRequest$maxResults to 10, you received a set of 10 results along with this token. Use this token in the next query to retrieve the next set of 10.

" + }, + "knownDependencyCount":{ + "shape":"Long", + "documentation":"

Count of distinct servers that are one hop away from the given server.

" + } + } + }, + "Long":{"type":"long"}, + "Message":{"type":"string"}, + "NeighborConnectionDetail":{ + "type":"structure", + "required":[ + "sourceServerId", + "destinationServerId", + "connectionsCount" + ], + "members":{ + "sourceServerId":{ + "shape":"ConfigurationId", + "documentation":"

The ID of the server that opened the network connection.

" + }, + "destinationServerId":{ + "shape":"ConfigurationId", + "documentation":"

The ID of the server that accepted the network connection.

" + }, + "destinationPort":{ + "shape":"BoxedInteger", + "documentation":"

The destination network port for the connection.

" + }, + "transportProtocol":{ + "shape":"String", + "documentation":"

The network protocol used for the connection.

" + }, + "connectionsCount":{ + "shape":"Long", + "documentation":"

The number of open network connections with the neighboring server.

" + } + }, + "documentation":"

Details about neighboring servers.

" + }, + "NeighborDetailsList":{ + "type":"list", + "member":{"shape":"NeighborConnectionDetail"} + }, + "NextToken":{"type":"string"}, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

This operation is not permitted.

", + "exception":true + }, + "OrderByElement":{ + "type":"structure", + "required":["fieldName"], + "members":{ + "fieldName":{ + "shape":"String", + "documentation":"

The field on which to order.

" + }, + "sortOrder":{ + "shape":"orderString", + "documentation":"

Ordering direction.

" + } + }, + "documentation":"

A field and direction for ordered output.

" + }, + "OrderByList":{ + "type":"list", + "member":{"shape":"OrderByElement"} + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

This issue occurs when the same clientRequestToken is used with the StartImportTask action, but with different parameters. For example, you use the same request token but have two different import URLs, you can encounter this issue. If the import tasks are meant to be different, use a different clientRequestToken, and try again.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The specified configuration ID was not located. Verify the configuration ID and try again.

", + "exception":true + }, + "S3Bucket":{"type":"string"}, + "S3PresignedUrl":{"type":"string"}, + "SchemaStorageConfig":{ + "type":"map", + "key":{"shape":"DatabaseName"}, + "value":{"shape":"String"} + }, + "ServerInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"Message"} + }, + "documentation":"

The server experienced an internal error. Try again.

", + "exception":true, + "fault":true + }, + "StartContinuousExportRequest":{ + "type":"structure", + "members":{ + } + }, + "StartContinuousExportResponse":{ + "type":"structure", + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

The unique ID assigned to this export.

" + }, + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The name of the s3 bucket where the export data parquet files are stored.

" + }, + "startTime":{ + "shape":"TimeStamp", + "documentation":"

The timestamp representing when the continuous export was started.

" + }, + "dataSource":{ + "shape":"DataSource", + "documentation":"

The type of data collector used to gather this data (currently only offered for AGENT).

" + }, + "schemaStorageConfig":{ + "shape":"SchemaStorageConfig", + "documentation":"

A dictionary which describes how the data is stored.

  • databaseName - the name of the Glue database used to store the schema.

" + } + } + }, + "StartDataCollectionByAgentIdsRequest":{ + "type":"structure", + "required":["agentIds"], + "members":{ + "agentIds":{ + "shape":"AgentIds", + "documentation":"

The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows Failed in the Description field.

" + } + } + }, + "StartDataCollectionByAgentIdsResponse":{ + "type":"structure", + "members":{ + "agentsConfigurationStatus":{ + "shape":"AgentConfigurationStatusList", + "documentation":"

Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

" + } + } + }, + "StartExportTaskRequest":{ + "type":"structure", + "members":{ + "exportDataFormat":{ + "shape":"ExportDataFormats", + "documentation":"

The file format for the returned export data. Default value is CSV. Note: The GRAPHML option has been deprecated.

" + }, + "filters":{ + "shape":"ExportFilters", + "documentation":"

If a filter is present, it selects the single agentId of the Application Discovery Agent for which data is exported. The agentId can be found in the results of the DescribeAgents API or CLI. If no filter is present, startTime and endTime are ignored and exported data includes both Agentless Discovery Connector data and summary data from Application Discovery agents.

" + }, + "startTime":{ + "shape":"TimeStamp", + "documentation":"

The start timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, data is exported starting from the first data collected by the agent.

" + }, + "endTime":{ + "shape":"TimeStamp", + "documentation":"

The end timestamp for exported data from the single Application Discovery Agent selected in the filters. If no value is specified, exported data includes the most recent data collected by the agent.

" + } + } + }, + "StartExportTaskResponse":{ + "type":"structure", + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

A unique identifier used to query the status of an export request.

" + } + } + }, + "StartImportTaskRequest":{ + "type":"structure", + "required":[ + "name", + "importUrl" + ], + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

Optional. A unique token that you can provide to prevent the same import request from occurring more than once. If you don't provide a token, a token is automatically generated.

Sending more than one StartImportTask request with the same client request token will return information about the original import task with that client request token.

", + "idempotencyToken":true + }, + "name":{ + "shape":"ImportTaskName", + "documentation":"

A descriptive name for this request. You can use this name to filter future requests related to this import task, such as identifying applications and servers that were included in this import task. We recommend that you use a meaningful name for each import task.

" + }, + "importUrl":{ + "shape":"ImportURL", + "documentation":"

The URL for your import file that you've uploaded to Amazon S3.

If you're using the AWS CLI, this URL is structured as follows: s3://BucketName/ImportFileName.CSV

" + } + } + }, + "StartImportTaskResponse":{ + "type":"structure", + "members":{ + "task":{ + "shape":"ImportTask", + "documentation":"

An array of information related to the import task request including status information, times, IDs, the Amazon S3 Object URL for the import file, and more.

" + } + } + }, + "StopContinuousExportRequest":{ + "type":"structure", + "required":["exportId"], + "members":{ + "exportId":{ + "shape":"ConfigurationsExportId", + "documentation":"

The unique ID assigned to this export.

" + } + } + }, + "StopContinuousExportResponse":{ + "type":"structure", + "members":{ + "startTime":{ + "shape":"TimeStamp", + "documentation":"

Timestamp that represents when this continuous export started collecting data.

" + }, + "stopTime":{ + "shape":"TimeStamp", + "documentation":"

Timestamp that represents when this continuous export was stopped.

" + } + } + }, + "StopDataCollectionByAgentIdsRequest":{ + "type":"structure", + "required":["agentIds"], + "members":{ + "agentIds":{ + "shape":"AgentIds", + "documentation":"

The IDs of the agents or connectors from which to stop collecting data.

" + } + } + }, + "StopDataCollectionByAgentIdsResponse":{ + "type":"structure", + "members":{ + "agentsConfigurationStatus":{ + "shape":"AgentConfigurationStatusList", + "documentation":"

Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.

" + } + } + }, + "String":{"type":"string"}, + "StringMax255":{ + "type":"string", + "max":255, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The type of tag on which to filter.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

A value for a tag key on which to filter.

" + } + }, + "documentation":"

Metadata that help you categorize IT assets.

" + }, + "TagFilter":{ + "type":"structure", + "required":[ + "name", + "values" + ], + "members":{ + "name":{ + "shape":"FilterName", + "documentation":"

A name of the tag filter.

" + }, + "values":{ + "shape":"FilterValues", + "documentation":"

Values for the tag filter.

" + } + }, + "documentation":"

The tag filter. Valid names are: tagKey, tagValue, configurationId.

" + }, + "TagFilters":{ + "type":"list", + "member":{"shape":"TagFilter"} + }, + "TagKey":{"type":"string"}, + "TagSet":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{"type":"string"}, + "TimeStamp":{"type":"timestamp"}, + "ToDeleteIdentifierList":{ + "type":"list", + "member":{"shape":"ImportTaskIdentifier"}, + "max":10, + "min":1 + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":["configurationId"], + "members":{ + "configurationId":{ + "shape":"ApplicationId", + "documentation":"

Configuration ID of the application to be updated.

" + }, + "name":{ + "shape":"String", + "documentation":"

New name of the application to be updated.

" + }, + "description":{ + "shape":"String", + "documentation":"

New description of the application to be updated.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "orderString":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + } + }, + "documentation":"AWS Application Discovery Service

AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an AWS-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see AWS Application Discovery Service FAQ.

Application Discovery Service offers two modes of operation:

  • Agentless discovery mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments.

  • Agent-based discovery mode collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud.

We recommend that you use agent-based discovery for non-VMware environments and to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts.

Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.

Application Discovery Service doesn't gather sensitive information. All data is handled according to the AWS Privacy Policy. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.

This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

This guide is intended for use with the AWS Application Discovery Service User Guide .

" +} diff --git a/aws/dist/botocore/data/dlm/2018-01-12/paginators-1.json b/aws/dist/botocore/data/dlm/2018-01-12/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/dlm/2018-01-12/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/dlm/2018-01-12/service-2.json b/aws/dist/botocore/data/dlm/2018-01-12/service-2.json new file mode 100644 index 00000000..287eef1a --- /dev/null +++ b/aws/dist/botocore/data/dlm/2018-01-12/service-2.json @@ -0,0 +1,602 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-01-12", + "endpointPrefix":"dlm", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Amazon DLM", + "serviceFullName":"Amazon Data Lifecycle Manager", + "serviceId":"DLM", + "signatureVersion":"v4", + "signingName":"dlm", + "uid":"dlm-2018-01-12" + }, + "operations":{ + "CreateLifecyclePolicy":{ + "name":"CreateLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/policies" + }, + "input":{"shape":"CreateLifecyclePolicyRequest"}, + "output":{"shape":"CreateLifecyclePolicyResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

" + }, + "DeleteLifecyclePolicy":{ + "name":"DeleteLifecyclePolicy", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyId}/" + }, + "input":{"shape":"DeleteLifecyclePolicyRequest"}, + "output":{"shape":"DeleteLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

" + }, + "GetLifecyclePolicies":{ + "name":"GetLifecyclePolicies", + "http":{ + "method":"GET", + "requestUri":"/policies" + }, + "input":{"shape":"GetLifecyclePoliciesRequest"}, + "output":{"shape":"GetLifecyclePoliciesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

" + }, + "GetLifecyclePolicy":{ + "name":"GetLifecyclePolicy", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyId}/" + }, + "input":{"shape":"GetLifecyclePolicyRequest"}, + "output":{"shape":"GetLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Gets detailed information about the specified lifecycle policy.

" + }, + "UpdateLifecyclePolicy":{ + "name":"UpdateLifecyclePolicy", + "http":{ + "method":"PATCH", + "requestUri":"/policies/{policyId}" + }, + "input":{"shape":"UpdateLifecyclePolicyRequest"}, + "output":{"shape":"UpdateLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServerException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Updates the specified lifecycle policy.

" + } + }, + "shapes":{ + "CopyTags":{"type":"boolean"}, + "Count":{ + "type":"integer", + "max":1000, + "min":1 + }, + "CreateLifecyclePolicyRequest":{ + "type":"structure", + "required":[ + "ExecutionRoleArn", + "Description", + "State", + "PolicyDetails" + ], + "members":{ + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

" + }, + "State":{ + "shape":"SettablePolicyStateValues", + "documentation":"

The desired activation state of the lifecycle policy after creation.

" + }, + "PolicyDetails":{ + "shape":"PolicyDetails", + "documentation":"

The configuration details of the lifecycle policy.

Target tags cannot be re-used across lifecycle policies.

" + } + } + }, + "CreateLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

" + } + } + }, + "CreateRule":{ + "type":"structure", + "required":[ + "Interval", + "IntervalUnit" + ], + "members":{ + "Interval":{ + "shape":"Interval", + "documentation":"

The interval between snapshots. The supported values are 2, 3, 4, 6, 8, 12, and 24.

" + }, + "IntervalUnit":{ + "shape":"IntervalUnitValues", + "documentation":"

The interval unit.

" + }, + "Times":{ + "shape":"TimesList", + "documentation":"

The time, in UTC, to start the operation. The supported format is hh:mm.

The operation occurs within a one-hour window following the specified time.

" + } + }, + "documentation":"

Specifies when to create snapshots of EBS volumes.

" + }, + "DeleteLifecyclePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

", + "location":"uri", + "locationName":"policyId" + } + } + }, + "DeleteLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "ExcludeBootVolume":{"type":"boolean"}, + "ExecutionRoleArn":{"type":"string"}, + "GetLifecyclePoliciesRequest":{ + "type":"structure", + "members":{ + "PolicyIds":{ + "shape":"PolicyIdList", + "documentation":"

The identifiers of the data lifecycle policies.

", + "location":"querystring", + "locationName":"policyIds" + }, + "State":{ + "shape":"GettablePolicyStateValues", + "documentation":"

The activation state.

", + "location":"querystring", + "locationName":"state" + }, + "ResourceTypes":{ + "shape":"ResourceTypeValuesList", + "documentation":"

The resource type.

", + "location":"querystring", + "locationName":"resourceTypes" + }, + "TargetTags":{ + "shape":"TargetTagsFilterList", + "documentation":"

The target tag for a policy.

Tags are strings in the format key=value.

", + "location":"querystring", + "locationName":"targetTags" + }, + "TagsToAdd":{ + "shape":"TagsToAddFilterList", + "documentation":"

The tags to add to objects created by the policy.

Tags are strings in the format key=value.

These user-defined tags are added in addition to the AWS-added lifecycle tags.

", + "location":"querystring", + "locationName":"tagsToAdd" + } + } + }, + "GetLifecyclePoliciesResponse":{ + "type":"structure", + "members":{ + "Policies":{ + "shape":"LifecyclePolicySummaryList", + "documentation":"

Summary information about the lifecycle policies.

" + } + } + }, + "GetLifecyclePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

", + "location":"uri", + "locationName":"policyId" + } + } + }, + "GetLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"LifecyclePolicy", + "documentation":"

Detailed information about the lifecycle policy.

" + } + } + }, + "GettablePolicyStateValues":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "ERROR" + ] + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"} + }, + "documentation":"

The service failed in an unexpected way.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "Interval":{ + "type":"integer", + "min":1 + }, + "IntervalUnitValues":{ + "type":"string", + "enum":["HOURS"] + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"}, + "RequiredParameters":{ + "shape":"ParameterList", + "documentation":"

The request omitted one or more required parameters.

" + }, + "MutuallyExclusiveParameters":{ + "shape":"ParameterList", + "documentation":"

The request included parameters that cannot be provided together.

" + } + }, + "documentation":"

Bad request. The request is missing required parameters or has invalid parameters.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LifecyclePolicy":{ + "type":"structure", + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

The description of the lifecycle policy.

" + }, + "State":{ + "shape":"GettablePolicyStateValues", + "documentation":"

The activation state of the lifecycle policy.

" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

" + }, + "DateCreated":{ + "shape":"Timestamp", + "documentation":"

The local date and time when the lifecycle policy was created.

" + }, + "DateModified":{ + "shape":"Timestamp", + "documentation":"

The local date and time when the lifecycle policy was last modified.

" + }, + "PolicyDetails":{ + "shape":"PolicyDetails", + "documentation":"

The configuration of the lifecycle policy

" + } + }, + "documentation":"

Detailed information about a lifecycle policy.

" + }, + "LifecyclePolicySummary":{ + "type":"structure", + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

The description of the lifecycle policy.

" + }, + "State":{ + "shape":"GettablePolicyStateValues", + "documentation":"

The activation state of the lifecycle policy.

" + } + }, + "documentation":"

Summary information about a lifecycle policy.

" + }, + "LifecyclePolicySummaryList":{ + "type":"list", + "member":{"shape":"LifecyclePolicySummary"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"}, + "ResourceType":{ + "shape":"String", + "documentation":"

Value is the type of resource for which a limit was exceeded.

" + } + }, + "documentation":"

The request failed because a limit was exceeded.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Parameter":{"type":"string"}, + "ParameterList":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "Parameters":{ + "type":"structure", + "members":{ + "ExcludeBootVolume":{ + "shape":"ExcludeBootVolume", + "documentation":"

When executing an EBS Snapshot Management – Instance policy, execute all CreateSnapshots calls with the excludeBootVolume set to the supplied field. Defaults to false. Only valid for EBS Snapshot Management – Instance policies.

" + } + }, + "documentation":"

Optional parameters that can be added to the policy. The set of valid parameters depends on the combination of policyType and resourceType values.

" + }, + "PolicyDescription":{ + "type":"string", + "max":500, + "min":0 + }, + "PolicyDetails":{ + "type":"structure", + "members":{ + "PolicyType":{ + "shape":"PolicyTypeValues", + "documentation":"

This field determines the valid target resource types and actions a policy can manage. This field defaults to EBS_SNAPSHOT_MANAGEMENT if not present.

" + }, + "ResourceTypes":{ + "shape":"ResourceTypeValuesList", + "documentation":"

The resource type.

" + }, + "TargetTags":{ + "shape":"TargetTagList", + "documentation":"

The single tag that identifies targeted resources for this policy.

" + }, + "Schedules":{ + "shape":"ScheduleList", + "documentation":"

The schedule of policy-defined actions.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

A set of optional parameters that can be provided by the policy.

" + } + }, + "documentation":"

Specifies the configuration of a lifecycle policy.

" + }, + "PolicyId":{"type":"string"}, + "PolicyIdList":{ + "type":"list", + "member":{"shape":"PolicyId"} + }, + "PolicyTypeValues":{ + "type":"string", + "enum":["EBS_SNAPSHOT_MANAGEMENT"] + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"}, + "ResourceType":{ + "shape":"String", + "documentation":"

Value is the type of resource that was not found.

" + }, + "ResourceIds":{ + "shape":"PolicyIdList", + "documentation":"

Value is a list of resource IDs that were not found.

" + } + }, + "documentation":"

A requested resource was not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceTypeValues":{ + "type":"string", + "enum":[ + "VOLUME", + "INSTANCE" + ] + }, + "ResourceTypeValuesList":{ + "type":"list", + "member":{"shape":"ResourceTypeValues"}, + "max":1, + "min":1 + }, + "RetainRule":{ + "type":"structure", + "required":["Count"], + "members":{ + "Count":{ + "shape":"Count", + "documentation":"

The number of snapshots to keep for each volume, up to a maximum of 1000.

" + } + }, + "documentation":"

Specifies the number of snapshots to keep for each EBS volume.

" + }, + "Schedule":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ScheduleName", + "documentation":"

The name of the schedule.

" + }, + "CopyTags":{ + "shape":"CopyTags", + "documentation":"

Copy all user-defined tags on a source volume to snapshots of the volume created by this policy.

" + }, + "TagsToAdd":{ + "shape":"TagsToAddList", + "documentation":"

The tags to apply to policy-created resources. These user-defined tags are in addition to the AWS-added lifecycle tags.

" + }, + "VariableTags":{ + "shape":"VariableTagsList", + "documentation":"

A collection of key/value pairs with values determined dynamically when the policy is executed. Keys may be any valid Amazon EC2 tag key. Values must be in one of the two following formats: $(instance-id) or $(timestamp). Variable tags are only valid for EBS Snapshot Management – Instance policies.

" + }, + "CreateRule":{ + "shape":"CreateRule", + "documentation":"

The create rule.

" + }, + "RetainRule":{ + "shape":"RetainRule", + "documentation":"

The retain rule.

" + } + }, + "documentation":"

Specifies a schedule.

" + }, + "ScheduleList":{ + "type":"list", + "member":{"shape":"Schedule"}, + "max":1, + "min":1 + }, + "ScheduleName":{ + "type":"string", + "max":500, + "min":0 + }, + "SettablePolicyStateValues":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The tag key.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

" + } + }, + "documentation":"

Specifies a tag for a resource.

" + }, + "TagFilter":{"type":"string"}, + "TagsToAddFilterList":{ + "type":"list", + "member":{"shape":"TagFilter"}, + "max":50, + "min":0 + }, + "TagsToAddList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TargetTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TargetTagsFilterList":{ + "type":"list", + "member":{"shape":"TagFilter"}, + "max":50, + "min":1 + }, + "Time":{ + "type":"string", + "pattern":"^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + }, + "TimesList":{ + "type":"list", + "member":{"shape":"Time"}, + "max":1 + }, + "Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UpdateLifecyclePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The identifier of the lifecycle policy.

", + "location":"uri", + "locationName":"policyId" + }, + "ExecutionRoleArn":{ + "shape":"ExecutionRoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

" + }, + "State":{ + "shape":"SettablePolicyStateValues", + "documentation":"

The desired activation state of the lifecycle policy after creation.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

A description of the lifecycle policy.

" + }, + "PolicyDetails":{ + "shape":"PolicyDetails", + "documentation":"

The configuration of the lifecycle policy.

Target tags cannot be re-used across policies.

" + } + } + }, + "UpdateLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "VariableTagsList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + } + }, + "documentation":"Amazon Data Lifecycle Manager

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot Lifecycle in the Amazon EC2 User Guide.

" +} diff --git a/aws/dist/botocore/data/dms/2016-01-01/examples-1.json b/aws/dist/botocore/data/dms/2016-01-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/dms/2016-01-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/dms/2016-01-01/paginators-1.json b/aws/dist/botocore/data/dms/2016-01-01/paginators-1.json new file mode 100644 index 00000000..be68c9ea --- /dev/null +++ b/aws/dist/botocore/data/dms/2016-01-01/paginators-1.json @@ -0,0 +1,82 @@ +{ + "pagination": { + "DescribeSchemas": { + "result_key": "Schemas", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeCertificates": { + "result_key": "Certificates", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEndpoints": { + "result_key": "Endpoints", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEventSubscriptions": { + "result_key": "EventSubscriptionsList", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEndpointTypes": { + "result_key": "SupportedEndpointTypes", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationInstances": { + "result_key": "ReplicationInstances", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeTableStatistics": { + "result_key": "TableStatistics", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeConnections": { + "result_key": "Connections", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationTaskAssessmentResults": { + "result_key": "ReplicationTaskAssessmentResults", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeEvents": { + "result_key": "Events", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeOrderableReplicationInstances": { + "result_key": "OrderableReplicationInstances", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationSubnetGroups": { + "result_key": "ReplicationSubnetGroups", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + }, + "DescribeReplicationTasks": { + "result_key": "ReplicationTasks", + "output_token": "Marker", + "input_token": "Marker", + "limit_key": "MaxRecords" + } + } +} diff --git a/aws/dist/botocore/data/dms/2016-01-01/service-2.json b/aws/dist/botocore/data/dms/2016-01-01/service-2.json new file mode 100644 index 00000000..1d1d885e --- /dev/null +++ b/aws/dist/botocore/data/dms/2016-01-01/service-2.json @@ -0,0 +1,4047 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-01-01", + "endpointPrefix":"dms", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Database Migration Service", + "serviceId":"Database Migration Service", + "signatureVersion":"v4", + "targetPrefix":"AmazonDMSv20160101", + "uid":"dms-2016-01-01" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "output":{"shape":"AddTagsToResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Adds metadata tags to an AWS DMS resource, including replication instance, endpoint, security group, and migration task. These tags can also be used with cost allocation reporting to track cost associated with DMS resources, or used in a Condition statement in an IAM policy for DMS.

" + }, + "ApplyPendingMaintenanceAction":{ + "name":"ApplyPendingMaintenanceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, + "output":{"shape":"ApplyPendingMaintenanceActionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Applies a pending maintenance action to a resource (for example, to a replication instance).

" + }, + "CreateEndpoint":{ + "name":"CreateEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointMessage"}, + "output":{"shape":"CreateEndpointResponse"}, + "errors":[ + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"AccessDeniedFault"} + ], + "documentation":"

Creates an endpoint using the provided settings.

" + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{"shape":"CreateEventSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"KMSAccessDeniedFault"}, + {"shape":"KMSDisabledFault"}, + {"shape":"KMSInvalidStateFault"}, + {"shape":"KMSNotFoundFault"}, + {"shape":"KMSThrottlingFault"} + ], + "documentation":"

Creates an AWS DMS event notification subscription.

You can specify the type of source (SourceType) you want to be notified of, provide a list of AWS DMS source IDs (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. If you specify both the SourceType and SourceIds, such as SourceType = replication-instance and SourceIdentifier = my-replinstance, you will be notified of all the replication instance events for the specified source. If you specify a SourceType but don't specify a SourceIdentifier, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either SourceType nor SourceIdentifier, you will be notified of events generated from all AWS DMS sources belonging to your customer account.

For more information about AWS DMS events, see Working with Events and Notifications in the AWS Database Migration Service User Guide.

" + }, + "CreateReplicationInstance":{ + "name":"CreateReplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReplicationInstanceMessage"}, + "output":{"shape":"CreateReplicationInstanceResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"InsufficientResourceCapacityFault"}, + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Creates the replication instance using the specified parameters.

AWS DMS requires that your account have certain roles with appropriate permissions before you can create a replication instance. For information on the required roles, see Creating the IAM Roles to Use With the AWS CLI and AWS DMS API. For information on the required permissions, see IAM Permissions Needed to Use AWS DMS.

" + }, + "CreateReplicationSubnetGroup":{ + "name":"CreateReplicationSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReplicationSubnetGroupMessage"}, + "output":{"shape":"CreateReplicationSubnetGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Creates a replication subnet group given a list of the subnet IDs in a VPC.

" + }, + "CreateReplicationTask":{ + "name":"CreateReplicationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReplicationTaskMessage"}, + "output":{"shape":"CreateReplicationTaskResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"ResourceQuotaExceededFault"} + ], + "documentation":"

Creates a replication task using the specified parameters.

" + }, + "DeleteCertificate":{ + "name":"DeleteCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCertificateMessage"}, + "output":{"shape":"DeleteCertificateResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Deletes the specified certificate.

" + }, + "DeleteConnection":{ + "name":"DeleteConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConnectionMessage"}, + "output":{"shape":"DeleteConnectionResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Deletes the connection between a replication instance and an endpoint.

" + }, + "DeleteEndpoint":{ + "name":"DeleteEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointMessage"}, + "output":{"shape":"DeleteEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Deletes the specified endpoint.

All tasks associated with the endpoint must be deleted before you can delete the endpoint.

" + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{"shape":"DeleteEventSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Deletes an AWS DMS event subscription.

" + }, + "DeleteReplicationInstance":{ + "name":"DeleteReplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReplicationInstanceMessage"}, + "output":{"shape":"DeleteReplicationInstanceResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Deletes the specified replication instance.

You must delete any migration tasks that are associated with the replication instance before you can delete it.

" + }, + "DeleteReplicationSubnetGroup":{ + "name":"DeleteReplicationSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReplicationSubnetGroupMessage"}, + "output":{"shape":"DeleteReplicationSubnetGroupResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Deletes a subnet group.

" + }, + "DeleteReplicationTask":{ + "name":"DeleteReplicationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReplicationTaskMessage"}, + "output":{"shape":"DeleteReplicationTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Deletes the specified replication task.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesMessage"}, + "output":{"shape":"DescribeAccountAttributesResponse"}, + "documentation":"

Lists all of the AWS DMS attributes for a customer account. These attributes include AWS DMS quotas for the account and a unique account identifier in a particular DMS region. DMS quotas include a list of resource quotas supported by the account, such as the number of replication instances allowed. The description for each resource quota, includes the quota name, current usage toward that quota, and the quota's maximum value. DMS uses the unique account identifier to name each artifact used by DMS in the given region.

This command does not take any parameters.

" + }, + "DescribeCertificates":{ + "name":"DescribeCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCertificatesMessage"}, + "output":{"shape":"DescribeCertificatesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Provides a description of the certificate.

" + }, + "DescribeConnections":{ + "name":"DescribeConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConnectionsMessage"}, + "output":{"shape":"DescribeConnectionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

" + }, + "DescribeEndpointTypes":{ + "name":"DescribeEndpointTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointTypesMessage"}, + "output":{"shape":"DescribeEndpointTypesResponse"}, + "documentation":"

Returns information about the type of endpoints available.

" + }, + "DescribeEndpoints":{ + "name":"DescribeEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointsMessage"}, + "output":{"shape":"DescribeEndpointsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns information about the endpoints for your account in the current region.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{"shape":"DescribeEventCategoriesResponse"}, + "documentation":"

Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in Working with Events and Notifications in the AWS Database Migration Service User Guide.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{"shape":"DescribeEventSubscriptionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Lists all the event subscriptions for a customer account. The description of a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify SubscriptionName, this action lists the description for that subscription.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{"shape":"DescribeEventsResponse"}, + "documentation":"

Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see Working with Events and Notifications in the AWS Database Migration User Guide.

" + }, + "DescribeOrderableReplicationInstances":{ + "name":"DescribeOrderableReplicationInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableReplicationInstancesMessage"}, + "output":{"shape":"DescribeOrderableReplicationInstancesResponse"}, + "documentation":"

Returns information about the replication instance types that can be created in the specified region.

" + }, + "DescribePendingMaintenanceActions":{ + "name":"DescribePendingMaintenanceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, + "output":{"shape":"DescribePendingMaintenanceActionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

For internal use only

" + }, + "DescribeRefreshSchemasStatus":{ + "name":"DescribeRefreshSchemasStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRefreshSchemasStatusMessage"}, + "output":{"shape":"DescribeRefreshSchemasStatusResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns the status of the RefreshSchemas operation.

" + }, + "DescribeReplicationInstanceTaskLogs":{ + "name":"DescribeReplicationInstanceTaskLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationInstanceTaskLogsMessage"}, + "output":{"shape":"DescribeReplicationInstanceTaskLogsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Returns information about the task logs for the specified task.

" + }, + "DescribeReplicationInstances":{ + "name":"DescribeReplicationInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationInstancesMessage"}, + "output":{"shape":"DescribeReplicationInstancesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns information about replication instances for your account in the current region.

" + }, + "DescribeReplicationSubnetGroups":{ + "name":"DescribeReplicationSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationSubnetGroupsMessage"}, + "output":{"shape":"DescribeReplicationSubnetGroupsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns information about the replication subnet groups.

" + }, + "DescribeReplicationTaskAssessmentResults":{ + "name":"DescribeReplicationTaskAssessmentResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationTaskAssessmentResultsMessage"}, + "output":{"shape":"DescribeReplicationTaskAssessmentResultsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns the task assessment results from Amazon S3. This action always returns the latest results.

" + }, + "DescribeReplicationTasks":{ + "name":"DescribeReplicationTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationTasksMessage"}, + "output":{"shape":"DescribeReplicationTasksResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns information about replication tasks for your account in the current region.

" + }, + "DescribeSchemas":{ + "name":"DescribeSchemas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSchemasMessage"}, + "output":{"shape":"DescribeSchemasResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns information about the schema for the specified endpoint.

" + }, + "DescribeTableStatistics":{ + "name":"DescribeTableStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTableStatisticsMessage"}, + "output":{"shape":"DescribeTableStatisticsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.

Note that the \"last updated\" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.

" + }, + "ImportCertificate":{ + "name":"ImportCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportCertificateMessage"}, + "output":{"shape":"ImportCertificateResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"InvalidCertificateFault"}, + {"shape":"ResourceQuotaExceededFault"} + ], + "documentation":"

Uploads the specified certificate.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Lists all tags for an AWS DMS resource.

" + }, + "ModifyEndpoint":{ + "name":"ModifyEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEndpointMessage"}, + "output":{"shape":"ModifyEndpointResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"AccessDeniedFault"} + ], + "documentation":"

Modifies the specified endpoint.

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{"shape":"ModifyEventSubscriptionResponse"}, + "errors":[ + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"KMSAccessDeniedFault"}, + {"shape":"KMSDisabledFault"}, + {"shape":"KMSInvalidStateFault"}, + {"shape":"KMSNotFoundFault"}, + {"shape":"KMSThrottlingFault"} + ], + "documentation":"

Modifies an existing AWS DMS event notification subscription.

" + }, + "ModifyReplicationInstance":{ + "name":"ModifyReplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReplicationInstanceMessage"}, + "output":{"shape":"ModifyReplicationInstanceResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"InsufficientResourceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"UpgradeDependencyFailureFault"} + ], + "documentation":"

Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.

Some settings are applied during the maintenance window.

" + }, + "ModifyReplicationSubnetGroup":{ + "name":"ModifyReplicationSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReplicationSubnetGroupMessage"}, + "output":{"shape":"ModifyReplicationSubnetGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"ReplicationSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Modifies the settings for the specified replication subnet group.

" + }, + "ModifyReplicationTask":{ + "name":"ModifyReplicationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReplicationTaskMessage"}, + "output":{"shape":"ModifyReplicationTaskResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"ResourceAlreadyExistsFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.

" + }, + "RebootReplicationInstance":{ + "name":"RebootReplicationInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootReplicationInstanceMessage"}, + "output":{"shape":"RebootReplicationInstanceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

" + }, + "RefreshSchemas":{ + "name":"RefreshSchemas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RefreshSchemasMessage"}, + "output":{"shape":"RefreshSchemasResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"ResourceQuotaExceededFault"} + ], + "documentation":"

Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.

" + }, + "ReloadTables":{ + "name":"ReloadTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReloadTablesMessage"}, + "output":{"shape":"ReloadTablesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Reloads the target database table with the source data.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "output":{"shape":"RemoveTagsFromResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Removes metadata tags from a DMS resource.

" + }, + "StartReplicationTask":{ + "name":"StartReplicationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartReplicationTaskMessage"}, + "output":{"shape":"StartReplicationTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"AccessDeniedFault"} + ], + "documentation":"

Starts the replication task.

For more information about AWS DMS tasks, see Working with Migration Tasks in the AWS Database Migration Service User Guide.

" + }, + "StartReplicationTaskAssessment":{ + "name":"StartReplicationTaskAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartReplicationTaskAssessmentMessage"}, + "output":{"shape":"StartReplicationTaskAssessmentResponse"}, + "errors":[ + {"shape":"InvalidResourceStateFault"}, + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Starts the replication task assessment for unsupported data types in the source database.

" + }, + "StopReplicationTask":{ + "name":"StopReplicationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopReplicationTaskMessage"}, + "output":{"shape":"StopReplicationTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"} + ], + "documentation":"

Stops the replication task.

" + }, + "TestConnection":{ + "name":"TestConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestConnectionMessage"}, + "output":{"shape":"TestConnectionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidResourceStateFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"ResourceQuotaExceededFault"} + ], + "documentation":"

Tests the connection between the replication instance and the endpoint.

" + } + }, + "shapes":{ + "AccessDeniedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

AWS DMS was denied access to the endpoint. Check that the role is correctly configured.

", + "exception":true + }, + "AccountQuota":{ + "type":"structure", + "members":{ + "AccountQuotaName":{ + "shape":"String", + "documentation":"

The name of the AWS DMS quota for this AWS account.

" + }, + "Used":{ + "shape":"Long", + "documentation":"

The amount currently used toward the quota maximum.

" + }, + "Max":{ + "shape":"Long", + "documentation":"

The maximum allowed value for the quota.

" + } + }, + "documentation":"

Describes a quota for an AWS account, for example, the number of replication instances allowed.

" + }, + "AccountQuotaList":{ + "type":"list", + "member":{"shape":"AccountQuota"} + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

Identifies the AWS DMS resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN).

For AWS DMS, you can tag a replication instance, an endpoint, or a replication task.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the resource.

" + } + }, + "documentation":"

Associates a set of tags with an AWS DMS resource.

" + }, + "AddTagsToResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "ApplyPendingMaintenanceActionMessage":{ + "type":"structure", + "required":[ + "ReplicationInstanceArn", + "ApplyAction", + "OptInType" + ], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS DMS resource that the pending maintenance action applies to.

" + }, + "ApplyAction":{ + "shape":"String", + "documentation":"

The pending maintenance action to apply to this resource.

" + }, + "OptInType":{ + "shape":"String", + "documentation":"

A value that specifies the type of opt-in request, or undoes an opt-in request. You can't undo an opt-in request of type immediate.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" + } + }, + "documentation":"

" + }, + "ApplyPendingMaintenanceActionResponse":{ + "type":"structure", + "members":{ + "ResourcePendingMaintenanceActions":{ + "shape":"ResourcePendingMaintenanceActions", + "documentation":"

The AWS DMS resource that the pending maintenance action will be applied to.

" + } + }, + "documentation":"

" + }, + "AuthMechanismValue":{ + "type":"string", + "enum":[ + "default", + "mongodb_cr", + "scram_sha_1" + ] + }, + "AuthTypeValue":{ + "type":"string", + "enum":[ + "no", + "password" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the availability zone.

" + } + }, + "documentation":"

" + }, + "AvailabilityZonesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "Certificate":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

A customer-assigned name for the certificate. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "CertificateCreationDate":{ + "shape":"TStamp", + "documentation":"

The date that the certificate was created.

" + }, + "CertificatePem":{ + "shape":"String", + "documentation":"

The contents of a .pem file, which contains an X.509 certificate.

" + }, + "CertificateWallet":{ + "shape":"CertificateWallet", + "documentation":"

The location of an imported Oracle Wallet certificate for use with SSL.

" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the certificate.

" + }, + "CertificateOwner":{ + "shape":"String", + "documentation":"

The owner of the certificate.

" + }, + "ValidFromDate":{ + "shape":"TStamp", + "documentation":"

The beginning date that the certificate is valid.

" + }, + "ValidToDate":{ + "shape":"TStamp", + "documentation":"

The final date that the certificate is valid.

" + }, + "SigningAlgorithm":{ + "shape":"String", + "documentation":"

The signing algorithm for the certificate.

" + }, + "KeyLength":{ + "shape":"IntegerOptional", + "documentation":"

The key length of the cryptographic algorithm being used.

" + } + }, + "documentation":"

The SSL certificate that can be used to encrypt connections between the endpoints and the replication instance.

" + }, + "CertificateList":{ + "type":"list", + "member":{"shape":"Certificate"} + }, + "CertificateWallet":{"type":"blob"}, + "CompressionTypeValue":{ + "type":"string", + "enum":[ + "none", + "gzip" + ] + }, + "Connection":{ + "type":"structure", + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The connection status.

" + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"

The error message when the connection last failed.

" + }, + "EndpointIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "ReplicationInstanceIdentifier":{ + "shape":"String", + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

" + } + }, + "documentation":"

" + }, + "ConnectionList":{ + "type":"list", + "member":{"shape":"Connection"} + }, + "CreateEndpointMessage":{ + "type":"structure", + "required":[ + "EndpointIdentifier", + "EndpointType", + "EngineName" + ], + "members":{ + "EndpointIdentifier":{ + "shape":"String", + "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "EndpointType":{ + "shape":"ReplicationEndpointTypeValue", + "documentation":"

The type of endpoint. Valid values are source and target.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.

" + }, + "Username":{ + "shape":"String", + "documentation":"

The user name to be used to log in to the endpoint database.

" + }, + "Password":{ + "shape":"SecretString", + "documentation":"

The password to be used to log in to the endpoint database.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server where the endpoint database resides.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port used by the endpoint database.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The name of the endpoint database.

" + }, + "ExtraConnectionAttributes":{ + "shape":"String", + "documentation":"

Additional attributes associated with the connection. Each attribute is specified as a name-value pair associated by an equal sign (=). Multiple attributes are separated by a semicolon (;) with no additional white space. For information on the attributes available for connecting your source or target endpoint, see Working with AWS DMS Endpoints in the AWS Database Migration Service User Guide.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the endpoint.

" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the certificate.

" + }, + "SslMode":{ + "shape":"DmsSslModeValue", + "documentation":"

The Secure Sockets Layer (SSL) mode to use for the SSL connection. The default is none

" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the service access role that you want to use to create the endpoint.

" + }, + "ExternalTableDefinition":{ + "shape":"String", + "documentation":"

The external table definition.

" + }, + "DynamoDbSettings":{ + "shape":"DynamoDbSettings", + "documentation":"

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

" + }, + "S3Settings":{ + "shape":"S3Settings", + "documentation":"

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

" + }, + "DmsTransferSettings":{ + "shape":"DmsTransferSettings", + "documentation":"

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

  • ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

  • BucketName - The name of the S3 bucket to use.

  • CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" }

" + }, + "MongoDbSettings":{ + "shape":"MongoDbSettings", + "documentation":"

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" + }, + "KinesisSettings":{ + "shape":"KinesisSettings", + "documentation":"

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.

" + }, + "ElasticsearchSettings":{ + "shape":"ElasticsearchSettings", + "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

" + }, + "RedshiftSettings":{"shape":"RedshiftSettings"} + }, + "documentation":"

" + }, + "CreateEndpointResponse":{ + "type":"structure", + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The endpoint that was created.

" + } + }, + "documentation":"

" + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the AWS DMS event notification subscription. This name must be less than 255 characters.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.

Valid values: replication-instance | replication-task

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the AWS Database Migration Service User Guide.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

A list of identifiers for which AWS DMS provides notification events.

If you don't specify a value, notifications are provided for all sources.

If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the event subscription.

" + } + }, + "documentation":"

" + }, + "CreateEventSubscriptionResponse":{ + "type":"structure", + "members":{ + "EventSubscription":{ + "shape":"EventSubscription", + "documentation":"

The event subscription that was created.

" + } + }, + "documentation":"

" + }, + "CreateReplicationInstanceMessage":{ + "type":"structure", + "required":[ + "ReplicationInstanceIdentifier", + "ReplicationInstanceClass" + ], + "members":{ + "ReplicationInstanceIdentifier":{ + "shape":"String", + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) to be initially allocated for the replication instance.

" + }, + "ReplicationInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the replication instance as specified by the replication instance class.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The AWS Availability Zone where the replication instance will be created. The default value is a random, system-chosen Availability Zone in the endpoint's AWS Region, for example: us-east-1d

" + }, + "ReplicationSubnetGroupIdentifier":{ + "shape":"String", + "documentation":"

A subnet group to associate with the replication instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version number of the replication instance.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates whether minor engine upgrades will be applied automatically to the replication instance during the maintenance window. This parameter defaults to true.

Default: true

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the replication instance.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

An AWS KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

" + }, + "DnsNameServers":{ + "shape":"String", + "documentation":"

A list of DNS name servers supported for the replication instance.

" + } + }, + "documentation":"

" + }, + "CreateReplicationInstanceResponse":{ + "type":"structure", + "members":{ + "ReplicationInstance":{ + "shape":"ReplicationInstance", + "documentation":"

The replication instance that was created.

" + } + }, + "documentation":"

" + }, + "CreateReplicationSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ReplicationSubnetGroupIdentifier", + "ReplicationSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "ReplicationSubnetGroupIdentifier":{ + "shape":"String", + "documentation":"

The name for the replication subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be \"default\".

Example: mySubnetgroup

" + }, + "ReplicationSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

One or more subnet IDs to be assigned to the subnet group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the subnet group.

" + } + }, + "documentation":"

" + }, + "CreateReplicationSubnetGroupResponse":{ + "type":"structure", + "members":{ + "ReplicationSubnetGroup":{ + "shape":"ReplicationSubnetGroup", + "documentation":"

The replication subnet group that was created.

" + } + }, + "documentation":"

" + }, + "CreateReplicationTaskMessage":{ + "type":"structure", + "required":[ + "ReplicationTaskIdentifier", + "SourceEndpointArn", + "TargetEndpointArn", + "ReplicationInstanceArn", + "MigrationType", + "TableMappings" + ], + "members":{ + "ReplicationTaskIdentifier":{ + "shape":"String", + "documentation":"

An identifier for the replication task.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "SourceEndpointArn":{ + "shape":"String", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

" + }, + "TargetEndpointArn":{ + "shape":"String", + "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of a replication instance.

" + }, + "MigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"

The migration type. Valid values: full-load | cdc | full-load-and-cdc

" + }, + "TableMappings":{ + "shape":"String", + "documentation":"

The table mappings for the task, in JSON format. For more information, see Table Mapping in the AWS Database Migration User Guide.

" + }, + "ReplicationTaskSettings":{ + "shape":"String", + "documentation":"

Overall settings for the task, in JSON format. For more information, see Task Settings in the AWS Database Migration User Guide.

" + }, + "CdcStartTime":{ + "shape":"TStamp", + "documentation":"

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

" + }, + "CdcStartPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

" + }, + "CdcStopPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to be assigned to the replication task.

" + } + }, + "documentation":"

" + }, + "CreateReplicationTaskResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The replication task that was created.

" + } + }, + "documentation":"

" + }, + "DataFormatValue":{ + "type":"string", + "enum":[ + "csv", + "parquet" + ] + }, + "DeleteCertificateMessage":{ + "type":"structure", + "required":["CertificateArn"], + "members":{ + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the deleted certificate.

" + } + } + }, + "DeleteCertificateResponse":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"

The Secure Sockets Layer (SSL) certificate.

" + } + } + }, + "DeleteConnectionMessage":{ + "type":"structure", + "required":[ + "EndpointArn", + "ReplicationInstanceArn" + ], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + } + }, + "documentation":"

" + }, + "DeleteConnectionResponse":{ + "type":"structure", + "members":{ + "Connection":{ + "shape":"Connection", + "documentation":"

The connection that is being deleted.

" + } + }, + "documentation":"

" + }, + "DeleteEndpointMessage":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + } + }, + "documentation":"

" + }, + "DeleteEndpointResponse":{ + "type":"structure", + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The endpoint that was deleted.

" + } + }, + "documentation":"

" + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the DMS event notification subscription to be deleted.

" + } + }, + "documentation":"

" + }, + "DeleteEventSubscriptionResponse":{ + "type":"structure", + "members":{ + "EventSubscription":{ + "shape":"EventSubscription", + "documentation":"

The event subscription that was deleted.

" + } + }, + "documentation":"

" + }, + "DeleteReplicationInstanceMessage":{ + "type":"structure", + "required":["ReplicationInstanceArn"], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance to be deleted.

" + } + }, + "documentation":"

" + }, + "DeleteReplicationInstanceResponse":{ + "type":"structure", + "members":{ + "ReplicationInstance":{ + "shape":"ReplicationInstance", + "documentation":"

The replication instance that was deleted.

" + } + }, + "documentation":"

" + }, + "DeleteReplicationSubnetGroupMessage":{ + "type":"structure", + "required":["ReplicationSubnetGroupIdentifier"], + "members":{ + "ReplicationSubnetGroupIdentifier":{ + "shape":"String", + "documentation":"

The subnet group name of the replication instance.

" + } + }, + "documentation":"

" + }, + "DeleteReplicationSubnetGroupResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "DeleteReplicationTaskMessage":{ + "type":"structure", + "required":["ReplicationTaskArn"], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task to be deleted.

" + } + }, + "documentation":"

" + }, + "DeleteReplicationTaskResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The deleted replication task.

" + } + }, + "documentation":"

" + }, + "DescribeAccountAttributesMessage":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "DescribeAccountAttributesResponse":{ + "type":"structure", + "members":{ + "AccountQuotas":{ + "shape":"AccountQuotaList", + "documentation":"

Account quota information.

" + }, + "UniqueAccountIdentifier":{ + "shape":"String", + "documentation":"

A unique AWS DMS identifier for an account in a particular AWS Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given AWS Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.

AWS DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.

" + } + }, + "documentation":"

" + }, + "DescribeCertificatesMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the certificate described in the form of key-value pairs.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 10

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the vlue specified by MaxRecords.

" + } + } + }, + "DescribeCertificatesResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

The pagination token.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

The Secure Sockets Layer (SSL) certificates associated with the replication instance.

" + } + } + }, + "DescribeConnectionsMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeConnectionsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Connections":{ + "shape":"ConnectionList", + "documentation":"

A description of the connections.

" + } + }, + "documentation":"

" + }, + "DescribeEndpointTypesMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe action.

Valid filter names: engine-name | endpoint-type

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEndpointTypesResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "SupportedEndpointTypes":{ + "shape":"SupportedEndpointTypeList", + "documentation":"

The types of endpoints that are supported.

" + } + }, + "documentation":"

" + }, + "DescribeEndpointsMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEndpointsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Endpoints":{ + "shape":"EndpointList", + "documentation":"

Endpoint description.

" + } + }, + "documentation":"

" + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-task

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the action.

" + } + }, + "documentation":"

" + }, + "DescribeEventCategoriesResponse":{ + "type":"structure", + "members":{ + "EventCategoryGroupList":{ + "shape":"EventCategoryGroupList", + "documentation":"

A list of event categories.

" + } + }, + "documentation":"

" + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the AWS DMS event subscription to be described.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the action.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEventSubscriptionsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of event subscriptions.

" + } + }, + "documentation":"

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of an event source.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-task

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The start time for the events to be listed.

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end time for the events to be listed.

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The duration of the events to be listed.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for the source type that you've chosen.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the action.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeEventsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

The events described.

" + } + }, + "documentation":"

" + }, + "DescribeOrderableReplicationInstancesMessage":{ + "type":"structure", + "members":{ + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeOrderableReplicationInstancesResponse":{ + "type":"structure", + "members":{ + "OrderableReplicationInstances":{ + "shape":"OrderableReplicationInstanceList", + "documentation":"

The order-able replication instances available.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribePendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + } + }, + "documentation":"

" + }, + "DescribePendingMaintenanceActionsResponse":{ + "type":"structure", + "members":{ + "PendingMaintenanceActions":{ + "shape":"PendingMaintenanceActions", + "documentation":"

The pending maintenance action.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeRefreshSchemasStatusMessage":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + } + }, + "documentation":"

" + }, + "DescribeRefreshSchemasStatusResponse":{ + "type":"structure", + "members":{ + "RefreshSchemasStatus":{ + "shape":"RefreshSchemasStatus", + "documentation":"

The status of the schema.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationInstanceTaskLogsMessage":{ + "type":"structure", + "required":["ReplicationInstanceArn"], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeReplicationInstanceTaskLogsResponse":{ + "type":"structure", + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "ReplicationInstanceTaskLogs":{ + "shape":"ReplicationInstanceTaskLogsList", + "documentation":"

An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeReplicationInstancesMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe action.

Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationInstancesResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReplicationInstances":{ + "shape":"ReplicationInstanceList", + "documentation":"

The replication instances described.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe action.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationSubnetGroupsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReplicationSubnetGroups":{ + "shape":"ReplicationSubnetGroups", + "documentation":"

A description of the replication subnet groups.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationTaskAssessmentResultsMessage":{ + "type":"structure", + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

- The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationTaskAssessmentResultsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

- The Amazon S3 bucket where the task assessment report is located.

" + }, + "ReplicationTaskAssessmentResults":{ + "shape":"ReplicationTaskAssessmentResultList", + "documentation":"

The task assessment report.

" + } + }, + "documentation":"

" + }, + "DescribeReplicationTasksMessage":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe action.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "WithoutSettings":{ + "shape":"BooleanOptional", + "documentation":"

An option to set to avoid returning information about settings. Use this to reduce overhead when setting information is too large. To use this option, choose true; otherwise, choose false (the default).

" + } + }, + "documentation":"

" + }, + "DescribeReplicationTasksResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ReplicationTasks":{ + "shape":"ReplicationTaskList", + "documentation":"

A description of the replication tasks.

" + } + }, + "documentation":"

" + }, + "DescribeSchemasMessage":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DescribeSchemasResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Schemas":{ + "shape":"SchemaList", + "documentation":"

The described schema.

" + } + }, + "documentation":"

" + }, + "DescribeTableStatisticsMessage":{ + "type":"structure", + "required":["ReplicationTaskArn"], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 500.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters applied to the describe table statistics action.

Valid filter names: schema-name | table-name | table-state

A combination of filters creates an AND condition where each record matches all specified filters.

" + } + }, + "documentation":"

" + }, + "DescribeTableStatisticsResponse":{ + "type":"structure", + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "TableStatistics":{ + "shape":"TableStatisticsList", + "documentation":"

The table statistics.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

" + }, + "DmsSslModeValue":{ + "type":"string", + "enum":[ + "none", + "require", + "verify-ca", + "verify-full" + ] + }, + "DmsTransferSettings":{ + "type":"structure", + "members":{ + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The IAM role that has permission to access the Amazon S3 bucket.

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

The name of the S3 bucket to use.

" + } + }, + "documentation":"

The settings in JSON format for the DMS Transfer type source endpoint.

" + }, + "DynamoDbSettings":{ + "type":"structure", + "required":["ServiceAccessRoleArn"], + "members":{ + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) used by the service access IAM role.

" + } + }, + "documentation":"

" + }, + "ElasticsearchSettings":{ + "type":"structure", + "required":[ + "ServiceAccessRoleArn", + "EndpointUri" + ], + "members":{ + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) used by service to access the IAM role.

" + }, + "EndpointUri":{ + "shape":"String", + "documentation":"

The endpoint for the Elasticsearch cluster.

" + }, + "FullLoadErrorPercentage":{ + "shape":"IntegerOptional", + "documentation":"

The maximum percentage of records that can fail to be written before a full load operation stops.

" + }, + "ErrorRetryDuration":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of seconds that DMS retries failed API requests to the Elasticsearch cluster.

" + } + }, + "documentation":"

" + }, + "EncodingTypeValue":{ + "type":"string", + "enum":[ + "plain", + "plain-dictionary", + "rle-dictionary" + ] + }, + "EncryptionModeValue":{ + "type":"string", + "enum":[ + "sse-s3", + "sse-kms" + ] + }, + "Endpoint":{ + "type":"structure", + "members":{ + "EndpointIdentifier":{ + "shape":"String", + "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "EndpointType":{ + "shape":"ReplicationEndpointTypeValue", + "documentation":"

The type of endpoint. Valid values are source and target.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.

" + }, + "EngineDisplayName":{ + "shape":"String", + "documentation":"

The expanded name for the engine name. For example, if the EngineName parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"

" + }, + "Username":{ + "shape":"String", + "documentation":"

The user name used to connect to the endpoint.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server at the endpoint.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port value used to access the endpoint.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The name of the database at the endpoint.

" + }, + "ExtraConnectionAttributes":{ + "shape":"String", + "documentation":"

Additional connection attributes used to connect to the endpoint.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the endpoint.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

An AWS KMS key identifier that is used to encrypt the connection parameters for the endpoint.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + }, + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) used for SSL connection to the endpoint.

" + }, + "SslMode":{ + "shape":"DmsSslModeValue", + "documentation":"

The SSL mode used to connect to the endpoint. The default value is none.

" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) used by the service access IAM role.

" + }, + "ExternalTableDefinition":{ + "shape":"String", + "documentation":"

The external table definition.

" + }, + "ExternalId":{ + "shape":"String", + "documentation":"

Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account.

" + }, + "DynamoDbSettings":{ + "shape":"DynamoDbSettings", + "documentation":"

The settings for the target DynamoDB database. For more information, see the DynamoDBSettings structure.

" + }, + "S3Settings":{ + "shape":"S3Settings", + "documentation":"

The settings for the S3 target endpoint. For more information, see the S3Settings structure.

" + }, + "DmsTransferSettings":{ + "shape":"DmsTransferSettings", + "documentation":"

The settings in JSON format for the DMS transfer type of source endpoint.

Possible settings include the following:

  • ServiceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

  • BucketName - The name of the S3 bucket to use.

  • CompressionType - An optional parameter to use GZIP to compress the target files. To use GZIP, set this value to NONE (the default). To keep the files uncompressed, don't use this value.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string,BucketName=string,CompressionType=string

JSON syntax for these settings is as follows: { \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" }

" + }, + "MongoDbSettings":{ + "shape":"MongoDbSettings", + "documentation":"

The settings for the MongoDB source endpoint. For more information, see the MongoDbSettings structure.

" + }, + "KinesisSettings":{ + "shape":"KinesisSettings", + "documentation":"

The settings for the Amazon Kinesis source endpoint. For more information, see the KinesisSettings structure.

" + }, + "ElasticsearchSettings":{ + "shape":"ElasticsearchSettings", + "documentation":"

The settings for the Elasticsearch source endpoint. For more information, see the ElasticsearchSettings structure.

" + }, + "RedshiftSettings":{ + "shape":"RedshiftSettings", + "documentation":"

Settings for the Amazon Redshift endpoint.

" + } + }, + "documentation":"

" + }, + "EndpointList":{ + "type":"list", + "member":{"shape":"Endpoint"} + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of an event source.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The type of AWS DMS resource that generates events.

Valid values: replication-instance | endpoint | replication-task

" + }, + "Message":{ + "shape":"String", + "documentation":"

The event message.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories available for the specified source type.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

The date of the event.

" + } + }, + "documentation":"

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "EventCategoryGroup":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-server | security-group | replication-task

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories from a source type that you've chosen.

" + } + }, + "documentation":"

" + }, + "EventCategoryGroupList":{ + "type":"list", + "member":{"shape":"EventCategoryGroup"} + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the AWS DMS event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The AWS DMS event notification subscription Id.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The topic ARN of the AWS DMS event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the AWS DMS event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that AWS DMS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

The time the RDS event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of AWS DMS resource that generates events.

Valid values: replication-instance | replication-server | security-group | replication-task

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of source Ids for the event subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

A lists of event categories.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Boolean value that indicates if the event subscription is enabled.

" + } + }, + "documentation":"

" + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{"shape":"EventSubscription"} + }, + "ExceptionMessage":{"type":"string"}, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter.

" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

The filter value.

" + } + }, + "documentation":"

" + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "FilterValueList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportCertificateMessage":{ + "type":"structure", + "required":["CertificateIdentifier"], + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

A customer-assigned name for the certificate. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "CertificatePem":{ + "shape":"String", + "documentation":"

The contents of a .pem file, which contains an X.509 certificate.

" + }, + "CertificateWallet":{ + "shape":"CertificateWallet", + "documentation":"

The location of an imported Oracle Wallet certificate for use with SSL.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags associated with the certificate.

" + } + } + }, + "ImportCertificateResponse":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"

The certificate to be uploaded.

" + } + } + }, + "InsufficientResourceCapacityFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

There are not enough resources allocated to the database migration.

", + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidCertificateFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The certificate was not valid.

", + "exception":true + }, + "InvalidResourceStateFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The resource is in a state that prevents it from being used for database migration.

", + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The subnet provided is invalid.

", + "exception":true + }, + "KMSAccessDeniedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The ciphertext references a key that doesn't exist or that the DMS account doesn't have access to.

", + "exception":true + }, + "KMSDisabledFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified master key (CMK) isn't enabled.

", + "exception":true + }, + "KMSInvalidStateFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The state of the specified AWS KMS resource isn't valid for this request.

", + "exception":true + }, + "KMSKeyNotAccessibleFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

AWS DMS cannot access the AWS KMS key.

", + "exception":true + }, + "KMSNotFoundFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified AWS KMS entity or resource can't be found.

", + "exception":true + }, + "KMSThrottlingFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

This request triggered AWS KMS request throttling.

", + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "KinesisSettings":{ + "type":"structure", + "members":{ + "StreamArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.

" + }, + "MessageFormat":{ + "shape":"MessageFormatValue", + "documentation":"

The output format for the records created on the endpoint. The message format is JSON.

" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Amazon Kinesis data stream.

" + } + }, + "documentation":"

" + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.

" + } + }, + "documentation":"

" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

A list of tags for the resource.

" + } + }, + "documentation":"

" + }, + "Long":{"type":"long"}, + "MessageFormatValue":{ + "type":"string", + "enum":["json"] + }, + "MigrationTypeValue":{ + "type":"string", + "enum":[ + "full-load", + "cdc", + "full-load-and-cdc" + ] + }, + "ModifyEndpointMessage":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "EndpointIdentifier":{ + "shape":"String", + "documentation":"

The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

" + }, + "EndpointType":{ + "shape":"ReplicationEndpointTypeValue", + "documentation":"

The type of endpoint. Valid values are source and target.

" + }, + "EngineName":{ + "shape":"String", + "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.

" + }, + "Username":{ + "shape":"String", + "documentation":"

The user name to be used to login to the endpoint database.

" + }, + "Password":{ + "shape":"SecretString", + "documentation":"

The password to be used to login to the endpoint database.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server where the endpoint database resides.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port used by the endpoint database.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The name of the endpoint database.

" + }, + "ExtraConnectionAttributes":{ + "shape":"String", + "documentation":"

Additional attributes associated with the connection. To reset this parameter, pass the empty string (\"\") as an argument.

" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

" + }, + "SslMode":{ + "shape":"DmsSslModeValue", + "documentation":"

The SSL mode used to connect to the endpoint. The default value is none.

" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the service access role you want to use to modify the endpoint.

" + }, + "ExternalTableDefinition":{ + "shape":"String", + "documentation":"

The external table definition.

" + }, + "DynamoDbSettings":{ + "shape":"DynamoDbSettings", + "documentation":"

Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to DynamoDB in the AWS Database Migration Service User Guide.

" + }, + "S3Settings":{ + "shape":"S3Settings", + "documentation":"

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for AWS DMS in the AWS Database Migration Service User Guide.

" + }, + "DmsTransferSettings":{ + "shape":"DmsTransferSettings", + "documentation":"

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

  • serviceAccessRoleArn - The IAM role that has permission to access the Amazon S3 bucket.

  • BucketName - The name of the S3 bucket to use.

  • compressionType - An optional parameter to use GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed.

Shorthand syntax: ServiceAccessRoleArn=string ,BucketName=string,CompressionType=string

JSON syntax:

{ \"ServiceAccessRoleArn\": \"string\", \"BucketName\": \"string\", \"CompressionType\": \"none\"|\"gzip\" }

" + }, + "MongoDbSettings":{ + "shape":"MongoDbSettings", + "documentation":"

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Using MongoDB as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" + }, + "KinesisSettings":{ + "shape":"KinesisSettings", + "documentation":"

Settings in JSON format for the target Amazon Kinesis Data Streams endpoint. For more information about the available settings, see Using Object Mapping to Migrate Data to a Kinesis Data Stream in the AWS Database Migration User Guide.

" + }, + "ElasticsearchSettings":{ + "shape":"ElasticsearchSettings", + "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

" + }, + "RedshiftSettings":{"shape":"RedshiftSettings"} + }, + "documentation":"

" + }, + "ModifyEndpointResponse":{ + "type":"structure", + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The modified endpoint.

" + } + }, + "documentation":"

" + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the AWS DMS event notification subscription to be modified.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of AWS DMS resource that generates the events you want to subscribe to.

Valid values: replication-instance | replication-task

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a source type that you want to subscribe to. Use the DescribeEventCategories action to see a list of event categories.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription.

" + } + }, + "documentation":"

" + }, + "ModifyEventSubscriptionResponse":{ + "type":"structure", + "members":{ + "EventSubscription":{ + "shape":"EventSubscription", + "documentation":"

The modified event subscription.

" + } + }, + "documentation":"

" + }, + "ModifyReplicationInstanceMessage":{ + "type":"structure", + "required":["ReplicationInstanceArn"], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) to be allocated for the replication instance.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Indicates whether the changes should be applied immediately or during the next maintenance window.

" + }, + "ReplicationInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

Specifies the VPC security group to be used with the replication instance. The VPC security group must work with the VPC containing the replication instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version number of the replication instance.

" + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage, and the change is asynchronously applied as soon as possible.

This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.

" + }, + "ReplicationInstanceIdentifier":{ + "shape":"String", + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

" + } + }, + "documentation":"

" + }, + "ModifyReplicationInstanceResponse":{ + "type":"structure", + "members":{ + "ReplicationInstance":{ + "shape":"ReplicationInstance", + "documentation":"

The modified replication instance.

" + } + }, + "documentation":"

" + }, + "ModifyReplicationSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ReplicationSubnetGroupIdentifier", + "SubnetIds" + ], + "members":{ + "ReplicationSubnetGroupIdentifier":{ + "shape":"String", + "documentation":"

The name of the replication instance subnet group.

" + }, + "ReplicationSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the replication instance subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of subnet IDs.

" + } + }, + "documentation":"

" + }, + "ModifyReplicationSubnetGroupResponse":{ + "type":"structure", + "members":{ + "ReplicationSubnetGroup":{ + "shape":"ReplicationSubnetGroup", + "documentation":"

The modified replication subnet group.

" + } + }, + "documentation":"

" + }, + "ModifyReplicationTaskMessage":{ + "type":"structure", + "required":["ReplicationTaskArn"], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "ReplicationTaskIdentifier":{ + "shape":"String", + "documentation":"

The replication task identifier.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "MigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"

The migration type. Valid values: full-load | cdc | full-load-and-cdc

" + }, + "TableMappings":{ + "shape":"String", + "documentation":"

When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. When working with the DMS API, provide the JSON as the parameter value, for example: --table-mappings file://mappingfile.json

" + }, + "ReplicationTaskSettings":{ + "shape":"String", + "documentation":"

JSON file that contains settings for the task, such as target metadata settings.

" + }, + "CdcStartTime":{ + "shape":"TStamp", + "documentation":"

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

" + }, + "CdcStartPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

" + }, + "CdcStopPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + } + }, + "documentation":"

" + }, + "ModifyReplicationTaskResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The replication task that was modified.

" + } + }, + "documentation":"

" + }, + "MongoDbSettings":{ + "type":"structure", + "members":{ + "Username":{ + "shape":"String", + "documentation":"

The user name you use to access the MongoDB source endpoint.

" + }, + "Password":{ + "shape":"SecretString", + "documentation":"

The password for the user account you use to access the MongoDB source endpoint.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server on the MongoDB source endpoint.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port value for the MongoDB source endpoint.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The database name on the MongoDB source endpoint.

" + }, + "AuthType":{ + "shape":"AuthTypeValue", + "documentation":"

The authentication type you use to access the MongoDB source endpoint.

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.

" + }, + "AuthMechanism":{ + "shape":"AuthMechanismValue", + "documentation":"

The authentication mechanism you use to access the MongoDB source endpoint.

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting is not used when authType=No.

" + }, + "NestingLevel":{ + "shape":"NestingLevelValue", + "documentation":"

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

" + }, + "ExtractDocId":{ + "shape":"String", + "documentation":"

Specifies the document ID. Use this setting when NestingLevel is set to NONE.

Default value is false.

" + }, + "DocsToInvestigate":{ + "shape":"String", + "documentation":"

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to ONE.

Must be a positive value greater than 0. Default value is 1000.

" + }, + "AuthSource":{ + "shape":"String", + "documentation":"

The MongoDB database name. This setting is not used when authType=NO.

The default is admin.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier that is used to encrypt the content on the replication instance. If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + } + }, + "documentation":"

" + }, + "NestingLevelValue":{ + "type":"string", + "enum":[ + "none", + "one" + ] + }, + "OrderableReplicationInstance":{ + "type":"structure", + "members":{ + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the replication engine.

" + }, + "ReplicationInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

The type of storage used by the replication instance.

" + }, + "MinAllocatedStorage":{ + "shape":"Integer", + "documentation":"

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

" + }, + "MaxAllocatedStorage":{ + "shape":"Integer", + "documentation":"

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

" + }, + "DefaultAllocatedStorage":{ + "shape":"Integer", + "documentation":"

The default amount of storage (in gigabytes) that is allocated for the replication instance.

" + }, + "IncludedAllocatedStorage":{ + "shape":"Integer", + "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZonesList", + "documentation":"

List of Availability Zones for this replication instance.

" + }, + "ReleaseStatus":{ + "shape":"ReleaseStatusValues", + "documentation":"

The value returned when the specified EngineVersion of the replication instance is in Beta or test mode. This indicates some features might not work as expected.

AWS DMS supports the ReleaseStatus parameter in versions 3.1.4 and later.

" + } + }, + "documentation":"

" + }, + "OrderableReplicationInstanceList":{ + "type":"list", + "member":{"shape":"OrderableReplicationInstance"} + }, + "ParquetVersionValue":{ + "type":"string", + "enum":[ + "parquet-1-0", + "parquet-2-0" + ] + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"String", + "documentation":"

The type of pending maintenance action that is available for the resource.

" + }, + "AutoAppliedAfterDate":{ + "shape":"TStamp", + "documentation":"

The date of the maintenance window when the action will be applied. The maintenance action will be applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

" + }, + "ForcedApplyDate":{ + "shape":"TStamp", + "documentation":"

The date when the maintenance action will be automatically applied. The maintenance action will be applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

" + }, + "OptInStatus":{ + "shape":"String", + "documentation":"

Indicates the type of opt-in request that has been received for the resource.

" + }, + "CurrentApplyDate":{ + "shape":"TStamp", + "documentation":"

The effective date when the pending maintenance action will be applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description providing more detail about the maintenance action.

" + } + }, + "documentation":"

" + }, + "PendingMaintenanceActionDetails":{ + "type":"list", + "member":{"shape":"PendingMaintenanceAction"} + }, + "PendingMaintenanceActions":{ + "type":"list", + "member":{"shape":"ResourcePendingMaintenanceActions"} + }, + "RebootReplicationInstanceMessage":{ + "type":"structure", + "required":["ReplicationInstanceArn"], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is true, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify true.)

" + } + } + }, + "RebootReplicationInstanceResponse":{ + "type":"structure", + "members":{ + "ReplicationInstance":{ + "shape":"ReplicationInstance", + "documentation":"

The replication instance that is being rebooted.

" + } + } + }, + "RedshiftSettings":{ + "type":"structure", + "members":{ + "AcceptAnyDate":{ + "shape":"BooleanOptional", + "documentation":"

A value that indicates to allow any date format, including invalid formats such as 00/00/00 00:00:00, to be loaded without generating an error. You can choose true or false (the default).

This parameter applies only to TIMESTAMP and DATE columns. Always use ACCEPTANYDATE with the DATEFORMAT parameter. If the date format for the data doesn't match the DATEFORMAT specification, Amazon Redshift inserts a NULL value into that field.

" + }, + "AfterConnectScript":{ + "shape":"String", + "documentation":"

Code to run after connecting. This parameter should contain the code itself, not the name of a file containing the code.

" + }, + "BucketFolder":{ + "shape":"String", + "documentation":"

The location where the comma-separated value (.csv) files are stored before being uploaded to the S3 bucket.

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

The name of the S3 bucket you want to use

" + }, + "ConnectionTimeout":{ + "shape":"IntegerOptional", + "documentation":"

A value that sets the amount of time to wait (in milliseconds) before timing out, beginning from when you initially establish a connection.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift data warehouse (service) that you are working with.

" + }, + "DateFormat":{ + "shape":"String", + "documentation":"

The date format that you are using. Valid values are auto (case-sensitive), your date format string enclosed in quotes, or NULL. If this parameter is left unset (NULL), it defaults to a format of 'YYYY-MM-DD'. Using auto recognizes most strings, even some that aren't supported when you use a date format string.

If your date and time values use formats different from each other, set this to auto.

" + }, + "EmptyAsNull":{ + "shape":"BooleanOptional", + "documentation":"

A value that specifies whether AWS DMS should migrate empty CHAR and VARCHAR fields as NULL. A value of true sets empty CHAR and VARCHAR fields to null. The default is false.

" + }, + "EncryptionMode":{ + "shape":"EncryptionModeValue", + "documentation":"

The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. To use SSE_S3, create an AWS Identity and Access Management (IAM) role with a policy that allows \"arn:aws:s3:::*\" to use the following actions: \"s3:PutObject\", \"s3:ListBucket\"

" + }, + "FileTransferUploadStreams":{ + "shape":"IntegerOptional", + "documentation":"

The number of threads used to upload a single file. This parameter accepts a value from 1 through 64. It defaults to 10.

" + }, + "LoadTimeout":{ + "shape":"IntegerOptional", + "documentation":"

The amount of time to wait (in milliseconds) before timing out, beginning from when you begin loading.

" + }, + "MaxFileSize":{ + "shape":"IntegerOptional", + "documentation":"

The maximum size (in KB) of any .csv file used to transfer data to Amazon Redshift. This accepts a value from 1 through 1,048,576. It defaults to 32,768 KB (32 MB).

" + }, + "Password":{ + "shape":"SecretString", + "documentation":"

The password for the user named in the username property.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number for Amazon Redshift. The default value is 5439.

" + }, + "RemoveQuotes":{ + "shape":"BooleanOptional", + "documentation":"

A value that specifies to remove surrounding quotation marks from strings in the incoming data. All characters within the quotation marks, including delimiters, are retained. Choose true to remove quotation marks. The default is false.

" + }, + "ReplaceInvalidChars":{ + "shape":"String", + "documentation":"

A list of characters that you want to replace. Use with ReplaceChars.

" + }, + "ReplaceChars":{ + "shape":"String", + "documentation":"

A value that specifies to replaces the invalid characters specified in ReplaceInvalidChars, substituting the specified characters instead. The default is \"?\".

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the Amazon Redshift cluster you are using.

" + }, + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that has access to the Amazon Redshift service.

" + }, + "ServerSideEncryptionKmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key ID. If you are using SSE_KMS for the EncryptionMode, provide this key ID. The key that you use needs an attached policy that enables IAM user permissions and allows use of the key.

" + }, + "TimeFormat":{ + "shape":"String", + "documentation":"

The time format that you want to use. Valid values are auto (case-sensitive), 'timeformat_string', 'epochsecs', or 'epochmillisecs'. It defaults to 10. Using auto recognizes most strings, even some that aren't supported when you use a time format string.

If your date and time values use formats different from each other, set this parameter to auto.

" + }, + "TrimBlanks":{ + "shape":"BooleanOptional", + "documentation":"

A value that specifies to remove the trailing white space characters from a VARCHAR string. This parameter applies only to columns with a VARCHAR data type. Choose true to remove unneeded white space. The default is false.

" + }, + "TruncateColumns":{ + "shape":"BooleanOptional", + "documentation":"

A value that specifies to truncate data in columns to the appropriate number of characters, so that the data fits in the column. This parameter applies only to columns with a VARCHAR or CHAR data type, and rows with a size of 4 MB or less. Choose true to truncate data. The default is false.

" + }, + "Username":{ + "shape":"String", + "documentation":"

An Amazon Redshift user name for a registered user.

" + }, + "WriteBufferSize":{ + "shape":"IntegerOptional", + "documentation":"

The size of the write buffer to use in rows. Valid values range from 1 through 2,048. The default is 1,024. Use this setting to tune performance.

" + } + }, + "documentation":"

" + }, + "RefreshSchemasMessage":{ + "type":"structure", + "required":[ + "EndpointArn", + "ReplicationInstanceArn" + ], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + } + }, + "documentation":"

" + }, + "RefreshSchemasResponse":{ + "type":"structure", + "members":{ + "RefreshSchemasStatus":{ + "shape":"RefreshSchemasStatus", + "documentation":"

The status of the refreshed schema.

" + } + }, + "documentation":"

" + }, + "RefreshSchemasStatus":{ + "type":"structure", + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "Status":{ + "shape":"RefreshSchemasStatusTypeValue", + "documentation":"

The status of the schema.

" + }, + "LastRefreshDate":{ + "shape":"TStamp", + "documentation":"

The date the schema was last refreshed.

" + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"

The last failure message for the schema.

" + } + }, + "documentation":"

" + }, + "RefreshSchemasStatusTypeValue":{ + "type":"string", + "enum":[ + "successful", + "failed", + "refreshing" + ] + }, + "ReleaseStatusValues":{ + "type":"string", + "enum":["beta"] + }, + "ReloadOptionValue":{ + "type":"string", + "enum":[ + "data-reload", + "validate-only" + ] + }, + "ReloadTablesMessage":{ + "type":"structure", + "required":[ + "ReplicationTaskArn", + "TablesToReload" + ], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "TablesToReload":{ + "shape":"TableListToReload", + "documentation":"

The name and schema of the table to be reloaded.

" + }, + "ReloadOption":{ + "shape":"ReloadOptionValue", + "documentation":"

Options for reload. Specify data-reload to reload the data and re-validate it if validation is enabled. Specify validate-only to re-validate the table. This option applies only when validation is enabled for the task.

Valid values: data-reload, validate-only

Default value is data-reload.

" + } + } + }, + "ReloadTablesResponse":{ + "type":"structure", + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + } + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

An AWS DMS resource from which you want to remove tag(s). The value for this parameter is an Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + }, + "documentation":"

Removes one or more tags from an AWS DMS resource.

" + }, + "RemoveTagsFromResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "ReplicationEndpointTypeValue":{ + "type":"string", + "enum":[ + "source", + "target" + ] + }, + "ReplicationInstance":{ + "type":"structure", + "members":{ + "ReplicationInstanceIdentifier":{ + "shape":"String", + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" + }, + "ReplicationInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + }, + "ReplicationInstanceStatus":{ + "shape":"String", + "documentation":"

The status of the replication instance.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

The time the replication instance was created.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

The VPC security group for the instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the instance.

" + }, + "ReplicationSubnetGroup":{ + "shape":"ReplicationSubnetGroup", + "documentation":"

The subnet group for the replication instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The maintenance window times for the replication instance.

" + }, + "PendingModifiedValues":{ + "shape":"ReplicationPendingModifiedValues", + "documentation":"

The pending modification values.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version number of the replication instance.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

An AWS KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then AWS DMS uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "ReplicationInstancePublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address of the replication instance.

", + "deprecated":true + }, + "ReplicationInstancePrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the replication instance.

", + "deprecated":true + }, + "ReplicationInstancePublicIpAddresses":{ + "shape":"ReplicationInstancePublicIpAddressList", + "documentation":"

One or more public IP addresses for the replication instance.

" + }, + "ReplicationInstancePrivateIpAddresses":{ + "shape":"ReplicationInstancePrivateIpAddressList", + "documentation":"

One or more private IP addresses for the replication instance.

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

" + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

The availability zone of the standby replication instance in a Multi-AZ deployment.

" + }, + "FreeUntil":{ + "shape":"TStamp", + "documentation":"

The expiration date of the free replication instance that is part of the Free DMS program.

" + }, + "DnsNameServers":{ + "shape":"String", + "documentation":"

The DNS name servers for the replication instance.

" + } + }, + "documentation":"

" + }, + "ReplicationInstanceList":{ + "type":"list", + "member":{"shape":"ReplicationInstance"} + }, + "ReplicationInstancePrivateIpAddressList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReplicationInstancePublicIpAddressList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReplicationInstanceTaskLog":{ + "type":"structure", + "members":{ + "ReplicationTaskName":{ + "shape":"String", + "documentation":"

The name of the replication task.

" + }, + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "ReplicationInstanceTaskLogSize":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the replication task log.

" + } + }, + "documentation":"

Contains metadata for a replication instance task log.

" + }, + "ReplicationInstanceTaskLogsList":{ + "type":"list", + "member":{"shape":"ReplicationInstanceTaskLog"} + }, + "ReplicationPendingModifiedValues":{ + "type":"structure", + "members":{ + "ReplicationInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gigabytes) that is allocated for the replication instance.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the replication instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version number of the replication instance.

" + } + }, + "documentation":"

" + }, + "ReplicationSubnetGroup":{ + "type":"structure", + "members":{ + "ReplicationSubnetGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the replication instance subnet group.

" + }, + "ReplicationSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the replication subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

The status of the subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

The subnets that are in the subnet group.

" + } + }, + "documentation":"

" + }, + "ReplicationSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The replication subnet group does not cover enough Availability Zones (AZs). Edit the replication subnet group and add more AZs.

", + "exception":true + }, + "ReplicationSubnetGroups":{ + "type":"list", + "member":{"shape":"ReplicationSubnetGroup"} + }, + "ReplicationTask":{ + "type":"structure", + "members":{ + "ReplicationTaskIdentifier":{ + "shape":"String", + "documentation":"

The user-assigned replication task identifier or name.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "SourceEndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "TargetEndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + }, + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "MigrationType":{ + "shape":"MigrationTypeValue", + "documentation":"

The type of migration.

" + }, + "TableMappings":{ + "shape":"String", + "documentation":"

Table mappings specified in the task.

" + }, + "ReplicationTaskSettings":{ + "shape":"String", + "documentation":"

The settings for the replication task.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the replication task.

" + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"

The last error (failure) message generated for the replication instance.

" + }, + "StopReason":{ + "shape":"String", + "documentation":"

The reason the replication task was stopped.

" + }, + "ReplicationTaskCreationDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task was created.

" + }, + "ReplicationTaskStartDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task is scheduled to start.

" + }, + "CdcStartPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want the CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

" + }, + "CdcStopPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + }, + "RecoveryCheckpoint":{ + "shape":"String", + "documentation":"

Indicates the last checkpoint that occurred during a change data capture (CDC) operation. You can provide this value to the CdcStartPosition parameter to start a CDC operation that begins at that checkpoint.

" + }, + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "ReplicationTaskStats":{ + "shape":"ReplicationTaskStats", + "documentation":"

The statistics for the task, including elapsed time, tables loaded, and table errors.

" + } + }, + "documentation":"

" + }, + "ReplicationTaskAssessmentResult":{ + "type":"structure", + "members":{ + "ReplicationTaskIdentifier":{ + "shape":"String", + "documentation":"

The replication task identifier of the task on which the task assessment was run.

" + }, + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + }, + "ReplicationTaskLastAssessmentDate":{ + "shape":"TStamp", + "documentation":"

The date the task assessment was completed.

" + }, + "AssessmentStatus":{ + "shape":"String", + "documentation":"

The status of the task assessment.

" + }, + "AssessmentResultsFile":{ + "shape":"String", + "documentation":"

The file containing the results of the task assessment.

" + }, + "AssessmentResults":{ + "shape":"String", + "documentation":"

The task assessment results in JSON format.

" + }, + "S3ObjectUrl":{ + "shape":"String", + "documentation":"

The URL of the S3 object containing the task assessment results.

" + } + }, + "documentation":"

The task assessment report in JSON format.

" + }, + "ReplicationTaskAssessmentResultList":{ + "type":"list", + "member":{"shape":"ReplicationTaskAssessmentResult"} + }, + "ReplicationTaskList":{ + "type":"list", + "member":{"shape":"ReplicationTask"} + }, + "ReplicationTaskStats":{ + "type":"structure", + "members":{ + "FullLoadProgressPercent":{ + "shape":"Integer", + "documentation":"

The percent complete for the full load migration task.

" + }, + "ElapsedTimeMillis":{ + "shape":"Long", + "documentation":"

The elapsed time of the task, in milliseconds.

" + }, + "TablesLoaded":{ + "shape":"Integer", + "documentation":"

The number of tables loaded for this task.

" + }, + "TablesLoading":{ + "shape":"Integer", + "documentation":"

The number of tables currently loading for this task.

" + }, + "TablesQueued":{ + "shape":"Integer", + "documentation":"

The number of tables queued for this task.

" + }, + "TablesErrored":{ + "shape":"Integer", + "documentation":"

The number of errors that have occurred during this task.

" + }, + "FreshStartDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task was started either with a fresh start or a target reload.

" + }, + "StartDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task was started either with a fresh start or a resume. For more information, see StartReplicationTaskType.

" + }, + "StopDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task was stopped.

" + }, + "FullLoadStartDate":{ + "shape":"TStamp", + "documentation":"

The date the the replication task full load was started.

" + }, + "FullLoadFinishDate":{ + "shape":"TStamp", + "documentation":"

The date the replication task full load was completed.

" + } + }, + "documentation":"

" + }, + "ResourceAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

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

The resource you are attempting to create already exists.

", + "exception":true + }, + "ResourceArn":{"type":"string"}, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The resource could not be found.

", + "exception":true + }, + "ResourcePendingMaintenanceActions":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the DMS resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN) for AWS DMS in the DMS documentation.

" + }, + "PendingMaintenanceActionDetails":{ + "shape":"PendingMaintenanceActionDetails", + "documentation":"

Detailed information about the pending maintenance action.

" + } + }, + "documentation":"

" + }, + "ResourceQuotaExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The quota for this resource quota has been exceeded.

", + "exception":true + }, + "S3Settings":{ + "type":"structure", + "members":{ + "ServiceAccessRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) used by the service access IAM role.

" + }, + "ExternalTableDefinition":{ + "shape":"String", + "documentation":"

The external table definition.

" + }, + "CsvRowDelimiter":{ + "shape":"String", + "documentation":"

The delimiter used to separate rows in the source files. The default is a carriage return (\\n).

" + }, + "CsvDelimiter":{ + "shape":"String", + "documentation":"

The delimiter used to separate columns in the source files. The default is a comma.

" + }, + "BucketFolder":{ + "shape":"String", + "documentation":"

An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path bucketFolder/schema_name/table_name/. If this parameter is not specified, then the path used is schema_name/table_name/.

" + }, + "BucketName":{ + "shape":"String", + "documentation":"

The name of the S3 bucket.

" + }, + "CompressionType":{ + "shape":"CompressionTypeValue", + "documentation":"

An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. Applies to both .csv and .parquet file formats.

" + }, + "EncryptionMode":{ + "shape":"EncryptionModeValue", + "documentation":"

The type of server-side encryption that you want to use for your data. This encryption type is part of the endpoint settings or the extra connections attributes for Amazon S3. You can choose either SSE_S3 (the default) or SSE_KMS. To use SSE_S3, you need an AWS Identity and Access Management (IAM) role with permission to allow \"arn:aws:s3:::dms-*\" to use the following actions:

  • s3:CreateBucket

  • s3:ListBucket

  • s3:DeleteBucket

  • s3:GetBucketLocation

  • s3:GetObject

  • s3:PutObject

  • s3:DeleteObject

  • s3:GetObjectVersion

  • s3:GetBucketPolicy

  • s3:PutBucketPolicy

  • s3:DeleteBucketPolicy

" + }, + "ServerSideEncryptionKmsKeyId":{ + "shape":"String", + "documentation":"

If you are using SSE_KMS for the EncryptionMode, provide the AWS KMS key ID. The key that you use needs an attached policy that enables AWS Identity and Access Management (IAM) user permissions and allows use of the key.

Here is a CLI example: aws dms create-endpoint --endpoint-identifier value --endpoint-type target --engine-name s3 --s3-settings ServiceAccessRoleArn=value,BucketFolder=value,BucketName=value,EncryptionMode=SSE_KMS,ServerSideEncryptionKmsKeyId=value

" + }, + "DataFormat":{ + "shape":"DataFormatValue", + "documentation":"

The format of the data that you want to use for output. You can choose one of the following:

  • csv : This is a row-based file format with comma-separated values (.csv).

  • parquet : Apache Parquet (.parquet) is a columnar storage file format that features efficient compression and provides faster query response.

" + }, + "EncodingType":{ + "shape":"EncodingTypeValue", + "documentation":"

The type of encoding you are using:

  • RLE_DICTIONARY uses a combination of bit-packing and run-length encoding to store repeated values more efficiently. This is the default.

  • PLAIN doesn't use encoding at all. Values are stored as they are.

  • PLAIN_DICTIONARY builds a dictionary of the values encountered in a given column. The dictionary is stored in a dictionary page for each column chunk.

" + }, + "DictPageSizeLimit":{ + "shape":"IntegerOptional", + "documentation":"

The maximum size of an encoded dictionary page of a column. If the dictionary page exceeds this, this column is stored using an encoding type of PLAIN. This parameter defaults to 1024 * 1024 bytes (1 MiB), the maximum size of a dictionary page before it reverts to PLAIN encoding. This size is used for .parquet file format only.

" + }, + "RowGroupLength":{ + "shape":"IntegerOptional", + "documentation":"

The number of rows in a row group. A smaller row group size provides faster reads. But as the number of row groups grows, the slower writes become. This parameter defaults to 10,000 rows. This number is used for .parquet file format only.

If you choose a value larger than the maximum, RowGroupLength is set to the max row group length in bytes (64 * 1024 * 1024).

" + }, + "DataPageSize":{ + "shape":"IntegerOptional", + "documentation":"

The size of one data page in bytes. This parameter defaults to 1024 * 1024 bytes (1 MiB). This number is used for .parquet file format only.

" + }, + "ParquetVersion":{ + "shape":"ParquetVersionValue", + "documentation":"

The version of the Apache Parquet format that you want to use: parquet_1_0 (the default) or parquet_2_0.

" + }, + "EnableStatistics":{ + "shape":"BooleanOptional", + "documentation":"

A value that enables statistics for Parquet pages and row groups. Choose true to enable statistics, false to disable. Statistics include NULL, DISTINCT, MAX, and MIN values. This parameter defaults to true. This value is used for .parquet file format only.

" + }, + "IncludeOpForFullLoad":{ + "shape":"BooleanOptional", + "documentation":"

A value that enables a full load to write INSERT operations to the comma-separated value (.csv) output files only to indicate how the rows were added to the source database.

AWS DMS supports the IncludeOpForFullLoad parameter in versions 3.1.4 and later.

For full load, records can only be inserted. By default (the false setting), no information is recorded in these output files for a full load to indicate that the rows were inserted at the source database. If IncludeOpForFullLoad is set to true or y, the INSERT is recorded as an I annotation in the first field of the .csv file. This allows the format of your target records from a full load to be consistent with the target records from a CDC load.

This setting works together with the CdcInsertsOnly parameter for output to .csv files only. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide..

" + }, + "CdcInsertsOnly":{ + "shape":"BooleanOptional", + "documentation":"

A value that enables a change data capture (CDC) load to write only INSERT operations to .csv or columnar storage (.parquet) output files. By default (the false setting), the first field in a .csv or .parquet record contains the letter I (INSERT), U (UPDATE), or D (DELETE). These values indicate whether the row was inserted, updated, or deleted at the source database for a CDC load to the target.

If CdcInsertsOnly is set to true or y, only INSERTs from the source database are migrated to the .csv or .parquet file. For .csv format only, how these INSERTs are recorded depends on the value of IncludeOpForFullLoad. If IncludeOpForFullLoad is set to true, the first field of every CDC record is set to I to indicate the INSERT operation at the source. If IncludeOpForFullLoad is set to false, every CDC record is written without a first field to indicate the INSERT operation at the source. For more information about how these settings work together, see Indicating Source DB Operations in Migrated S3 Data in the AWS Database Migration Service User Guide..

AWS DMS supports this interaction between the CdcInsertsOnly and IncludeOpForFullLoad parameters in versions 3.1.4 and later.

" + }, + "TimestampColumnName":{ + "shape":"String", + "documentation":"

A value that when nonblank causes AWS DMS to add a column with timestamp information to the endpoint data for an Amazon S3 target.

AWS DMS supports the TimestampColumnName parameter in versions 3.1.4 and later.

DMS includes an additional STRING column in the .csv or .parquet object files of your migrated data when you set TimestampColumnName to a nonblank value.

For a full load, each row of this timestamp column contains a timestamp for when the data was transferred from the source to the target by DMS.

For a change data capture (CDC) load, each row of the timestamp column contains the timestamp for the commit of that row in the source database.

The string format for this timestamp column value is yyyy-MM-dd HH:mm:ss.SSSSSS. By default, the precision of this value is in microseconds. For a CDC load, the rounding of the precision depends on the commit timestamp supported by DMS for the source database.

When the AddColumnName parameter is set to true, DMS also includes a name for the timestamp column that you set with TimestampColumnName.

" + }, + "ParquetTimestampInMillisecond":{ + "shape":"BooleanOptional", + "documentation":"

A value that specifies the precision of any TIMESTAMP column values that are written to an Amazon S3 object file in .parquet format.

AWS DMS supports the ParquetTimestampInMillisecond parameter in versions 3.1.4 and later.

When ParquetTimestampInMillisecond is set to true or y, AWS DMS writes all TIMESTAMP columns in a .parquet formatted file with millisecond precision. Otherwise, DMS writes them with microsecond precision.

Currently, Amazon Athena and AWS Glue can handle only millisecond precision for TIMESTAMP values. Set this parameter to true for S3 endpoint object files that are .parquet formatted only if you plan to query or process the data with Athena or AWS Glue.

AWS DMS writes any TIMESTAMP column values written to an S3 file in .csv format with microsecond precision.

Setting ParquetTimestampInMillisecond has no effect on the string format of the timestamp column value that is inserted by setting the TimestampColumnName parameter.

" + } + }, + "documentation":"

Settings for exporting data to Amazon S3.

" + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The SNS topic is invalid.

", + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

You are not authorized for the SNS subscription.

", + "exception":true + }, + "SchemaList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SecretString":{ + "type":"string", + "sensitive":true + }, + "SourceIdsList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SourceType":{ + "type":"string", + "enum":["replication-instance"] + }, + "StartReplicationTaskAssessmentMessage":{ + "type":"structure", + "required":["ReplicationTaskArn"], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task.

" + } + }, + "documentation":"

" + }, + "StartReplicationTaskAssessmentResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The assessed replication task.

" + } + }, + "documentation":"

" + }, + "StartReplicationTaskMessage":{ + "type":"structure", + "required":[ + "ReplicationTaskArn", + "StartReplicationTaskType" + ], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication task to be started.

" + }, + "StartReplicationTaskType":{ + "shape":"StartReplicationTaskTypeValue", + "documentation":"

The type of replication task.

" + }, + "CdcStartTime":{ + "shape":"TStamp", + "documentation":"

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

" + }, + "CdcStartPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

The value can be in date, checkpoint, or LSN/SCN format.

Date Example: --cdc-start-position “2018-03-08T12:12:12”

Checkpoint Example: --cdc-start-position \"checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93\"

LSN Example: --cdc-start-position “mysql-bin-changelog.000024:373”

When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS.

" + }, + "CdcStopPosition":{ + "shape":"String", + "documentation":"

Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

Server time example: --cdc-stop-position “server_time:3018-02-09T12:12:12”

Commit time example: --cdc-stop-position “commit_time: 3018-02-09T12:12:12 “

" + } + }, + "documentation":"

" + }, + "StartReplicationTaskResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The replication task started.

" + } + }, + "documentation":"

" + }, + "StartReplicationTaskTypeValue":{ + "type":"string", + "enum":[ + "start-replication", + "resume-processing", + "reload-target" + ] + }, + "StopReplicationTaskMessage":{ + "type":"structure", + "required":["ReplicationTaskArn"], + "members":{ + "ReplicationTaskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name(ARN) of the replication task to be stopped.

" + } + }, + "documentation":"

" + }, + "StopReplicationTaskResponse":{ + "type":"structure", + "members":{ + "ReplicationTask":{ + "shape":"ReplicationTask", + "documentation":"

The replication task stopped.

" + } + }, + "documentation":"

" + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The storage quota has been exceeded.

", + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

The subnet identifier.

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone of the subnet.

" + }, + "SubnetStatus":{ + "shape":"String", + "documentation":"

The status of the subnet.

" + } + }, + "documentation":"

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

The specified subnet is already in use.

", + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubnetList":{ + "type":"list", + "member":{"shape":"Subnet"} + }, + "SupportedEndpointType":{ + "type":"structure", + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

The database engine name. Valid values, depending on the EndpointType, include mysql, oracle, postgres, mariadb, aurora, aurora-postgresql, redshift, s3, db2, azuredb, sybase, dynamodb, mongodb, and sqlserver.

" + }, + "SupportsCDC":{ + "shape":"Boolean", + "documentation":"

Indicates if Change Data Capture (CDC) is supported.

" + }, + "EndpointType":{ + "shape":"ReplicationEndpointTypeValue", + "documentation":"

The type of endpoint. Valid values are source and target.

" + }, + "EngineDisplayName":{ + "shape":"String", + "documentation":"

The expanded name for the engine name. For example, if the EngineName parameter is \"aurora,\" this value would be \"Amazon Aurora MySQL.\"

" + } + }, + "documentation":"

" + }, + "SupportedEndpointTypeList":{ + "type":"list", + "member":{"shape":"SupportedEndpointType"} + }, + "TStamp":{"type":"timestamp"}, + "TableListToReload":{ + "type":"list", + "member":{"shape":"TableToReload"} + }, + "TableStatistics":{ + "type":"structure", + "members":{ + "SchemaName":{ + "shape":"String", + "documentation":"

The schema name.

" + }, + "TableName":{ + "shape":"String", + "documentation":"

The name of the table.

" + }, + "Inserts":{ + "shape":"Long", + "documentation":"

The number of insert actions performed on a table.

" + }, + "Deletes":{ + "shape":"Long", + "documentation":"

The number of delete actions performed on a table.

" + }, + "Updates":{ + "shape":"Long", + "documentation":"

The number of update actions performed on a table.

" + }, + "Ddls":{ + "shape":"Long", + "documentation":"

The Data Definition Language (DDL) used to build and modify the structure of your tables.

" + }, + "FullLoadRows":{ + "shape":"Long", + "documentation":"

The number of rows added during the Full Load operation.

" + }, + "FullLoadCondtnlChkFailedRows":{ + "shape":"Long", + "documentation":"

The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).

" + }, + "FullLoadErrorRows":{ + "shape":"Long", + "documentation":"

The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).

" + }, + "LastUpdateTime":{ + "shape":"TStamp", + "documentation":"

The last time the table was updated.

" + }, + "TableState":{ + "shape":"String", + "documentation":"

The state of the tables described.

Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded

" + }, + "ValidationPendingRecords":{ + "shape":"Long", + "documentation":"

The number of records that have yet to be validated.

" + }, + "ValidationFailedRecords":{ + "shape":"Long", + "documentation":"

The number of records that failed validation.

" + }, + "ValidationSuspendedRecords":{ + "shape":"Long", + "documentation":"

The number of records that could not be validated.

" + }, + "ValidationState":{ + "shape":"String", + "documentation":"

The validation state of the table.

The parameter can have the following values

  • Not enabled—Validation is not enabled for the table in the migration task.

  • Pending records—Some records in the table are waiting for validation.

  • Mismatched records—Some records in the table do not match between the source and target.

  • Suspended records—Some records in the table could not be validated.

  • No primary key—The table could not be validated because it had no primary key.

  • Table error—The table was not validated because it was in an error state and some data was not migrated.

  • Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.

  • Error—The table could not be validated because of an unexpected error.

" + }, + "ValidationStateDetails":{ + "shape":"String", + "documentation":"

Additional details about the state of validation.

" + } + }, + "documentation":"

" + }, + "TableStatisticsList":{ + "type":"list", + "member":{"shape":"TableStatistics"} + }, + "TableToReload":{ + "type":"structure", + "members":{ + "SchemaName":{ + "shape":"String", + "documentation":"

The schema name of the table to be reloaded.

" + }, + "TableName":{ + "shape":"String", + "documentation":"

The table name of the table to be reloaded.

" + } + }, + "documentation":"

" + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TestConnectionMessage":{ + "type":"structure", + "required":[ + "ReplicationInstanceArn", + "EndpointArn" + ], + "members":{ + "ReplicationInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the replication instance.

" + }, + "EndpointArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

" + } + }, + "documentation":"

" + }, + "TestConnectionResponse":{ + "type":"structure", + "members":{ + "Connection":{ + "shape":"Connection", + "documentation":"

The connection tested.

" + } + }, + "documentation":"

" + }, + "UpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

" + } + }, + "documentation":"

An upgrade dependency is preventing the database migration.

", + "exception":true + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The VPC security group Id.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC security group.

" + } + }, + "documentation":"

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"VpcSecurityGroupMembership"} + } + }, + "documentation":"AWS Database Migration Service

AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.

For more information about AWS DMS, see What Is AWS Database Migration Service? in the AWS Database Migration User Guide.

" +} diff --git a/aws/dist/botocore/data/dms/2016-01-01/waiters-2.json b/aws/dist/botocore/data/dms/2016-01-01/waiters-2.json new file mode 100644 index 00000000..ebfc736e --- /dev/null +++ b/aws/dist/botocore/data/dms/2016-01-01/waiters-2.json @@ -0,0 +1,336 @@ +{ + "version":2, + "waiters":{ + "TestConnectionSucceeds":{ + "acceptors":[ + { + "argument":"Connections[].Status", + "expected":"successful", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"Connections[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":5, + "description":"Wait until testing connection succeeds.", + "maxAttempts":60, + "operation":"DescribeConnections" + }, + "EndpointDeleted":{ + "acceptors":[ + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + }, + { + "argument":"Endpoints[].Status", + "expected":"active", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"Endpoints[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":5, + "description":"Wait until testing endpoint is deleted.", + "maxAttempts":60, + "operation":"DescribeEndpoints" + }, + "ReplicationInstanceAvailable":{ + "acceptors":[ + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"incompatible-credentials", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"inaccessible-encryption-credentials", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":60, + "description":"Wait until DMS replication instance is available.", + "maxAttempts":60, + "operation":"DescribeReplicationInstances" + }, + "ReplicationInstanceDeleted":{ + "acceptors":[ + { + "argument":"ReplicationInstances[].ReplicationInstanceStatus", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until DMS replication instance is deleted.", + "maxAttempts":60, + "operation":"DescribeReplicationInstances" + }, + "ReplicationTaskReady":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"starting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopping", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is ready.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskStopped":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"starting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is stopped.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskRunning":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopping", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"testing", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until DMS replication task is running.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + }, + "ReplicationTaskDeleted":{ + "acceptors":[ + { + "argument":"ReplicationTasks[].Status", + "expected":"ready", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"stopped", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"running", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"ReplicationTasks[].Status", + "expected":"failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ResourceNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until DMS replication task is deleted.", + "maxAttempts":60, + "operation":"DescribeReplicationTasks" + } + } +} diff --git a/aws/dist/botocore/data/docdb/2014-10-31/paginators-1.json b/aws/dist/botocore/data/docdb/2014-10-31/paginators-1.json new file mode 100644 index 00000000..f747ff67 --- /dev/null +++ b/aws/dist/botocore/data/docdb/2014-10-31/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "DescribeDBClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusters" + }, + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + } + } +} diff --git a/aws/dist/botocore/data/docdb/2014-10-31/service-2.json b/aws/dist/botocore/data/docdb/2014-10-31/service-2.json new file mode 100644 index 00000000..5a57835f --- /dev/null +++ b/aws/dist/botocore/data/docdb/2014-10-31/service-2.json @@ -0,0 +1,3908 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-31", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon DocDB", + "serviceFullName":"Amazon DocumentDB with MongoDB compatibility", + "serviceId":"DocDB", + "signatureVersion":"v4", + "signingName":"rds", + "uid":"docdb-2014-10-31", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

" + }, + "ApplyPendingMaintenanceAction":{ + "name":"ApplyPendingMaintenanceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, + "output":{ + "shape":"ApplyPendingMaintenanceActionResult", + "resultWrapper":"ApplyPendingMaintenanceActionResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

Applies a pending maintenance action to a resource (for example, to a DB instance).

" + }, + "CopyDBClusterParameterGroup":{ + "name":"CopyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CopyDBClusterParameterGroupResult", + "resultWrapper":"CopyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

Copies the specified DB cluster parameter group.

" + }, + "CopyDBClusterSnapshot":{ + "name":"CopyDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterSnapshotMessage"}, + "output":{ + "shape":"CopyDBClusterSnapshotResult", + "resultWrapper":"CopyDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status.

" + }, + "CreateDBCluster":{ + "name":"CreateDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterMessage"}, + "output":{ + "shape":"CreateDBClusterResult", + "resultWrapper":"CreateDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"} + ], + "documentation":"

Creates a new Amazon DocumentDB DB cluster.

" + }, + "CreateDBClusterParameterGroup":{ + "name":"CreateDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateDBClusterParameterGroupResult", + "resultWrapper":"CreateDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter.

" + }, + "CreateDBClusterSnapshot":{ + "name":"CreateDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterSnapshotMessage"}, + "output":{ + "shape":"CreateDBClusterSnapshotResult", + "resultWrapper":"CreateDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

Creates a snapshot of a DB cluster.

" + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Creates a new DB instance.

" + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

" + }, + "DeleteDBCluster":{ + "name":"DeleteDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterMessage"}, + "output":{ + "shape":"DeleteDBClusterResult", + "resultWrapper":"DeleteDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

Deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

" + }, + "DeleteDBClusterParameterGroup":{ + "name":"DeleteDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

" + }, + "DeleteDBClusterSnapshot":{ + "name":"DeleteDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteDBClusterSnapshotResult", + "resultWrapper":"DeleteDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

" + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

Deletes a previously provisioned DB instance.

" + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

" + }, + "DescribeCertificates":{ + "name":"DescribeCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCertificatesMessage"}, + "output":{ + "shape":"CertificateMessage", + "resultWrapper":"DescribeCertificatesResult" + }, + "errors":[ + {"shape":"CertificateNotFoundFault"} + ], + "documentation":"

Returns a list of certificate authority (CA) certificates provided by Amazon RDS for this AWS account.

" + }, + "DescribeDBClusterParameterGroups":{ + "name":"DescribeDBClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, + "output":{ + "shape":"DBClusterParameterGroupsMessage", + "resultWrapper":"DescribeDBClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified DB cluster parameter group.

" + }, + "DescribeDBClusterParameters":{ + "name":"DescribeDBClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParametersMessage"}, + "output":{ + "shape":"DBClusterParameterGroupDetails", + "resultWrapper":"DescribeDBClusterParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns the detailed parameter list for a particular DB cluster parameter group.

" + }, + "DescribeDBClusterSnapshotAttributes":{ + "name":"DescribeDBClusterSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBClusterSnapshotAttributesResult", + "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

" + }, + "DescribeDBClusterSnapshots":{ + "name":"DescribeDBClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, + "output":{ + "shape":"DBClusterSnapshotMessage", + "resultWrapper":"DescribeDBClusterSnapshotsResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Returns information about DB cluster snapshots. This API operation supports pagination.

" + }, + "DescribeDBClusters":{ + "name":"DescribeDBClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClustersMessage"}, + "output":{ + "shape":"DBClusterMessage", + "resultWrapper":"DescribeDBClustersResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination.

" + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

Returns a list of the available DB engines.

" + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

" + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

" + }, + "DescribeEngineDefaultClusterParameters":{ + "name":"DescribeEngineDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultClusterParametersResult", + "resultWrapper":"DescribeEngineDefaultClusterParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the cluster database engine.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

" + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" + }, + "DescribePendingMaintenanceActions":{ + "name":"DescribePendingMaintenanceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, + "output":{ + "shape":"PendingMaintenanceActionsMessage", + "resultWrapper":"DescribePendingMaintenanceActionsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

" + }, + "FailoverDBCluster":{ + "name":"FailoverDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FailoverDBClusterMessage"}, + "output":{ + "shape":"FailoverDBClusterResult", + "resultWrapper":"FailoverDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Lists all tags on an Amazon DocumentDB resource.

" + }, + "ModifyDBCluster":{ + "name":"ModifyDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterMessage"}, + "output":{ + "shape":"ModifyDBClusterResult", + "resultWrapper":"ModifyDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterAlreadyExistsFault"} + ], + "documentation":"

Modifies a setting for an Amazon DocumentDB DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBClusterParameterGroup":{ + "name":"ModifyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ModifyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ], + "documentation":"

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter.

" + }, + "ModifyDBClusterSnapshotAttribute":{ + "name":"ModifyDBClusterSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBClusterSnapshotAttributeResult", + "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ], + "documentation":"

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

" + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"DBUpgradeDependencyFailureFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"CertificateNotFoundFault"} + ], + "documentation":"

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

" + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Removes metadata tags from an Amazon DocumentDB resource.

" + }, + "ResetDBClusterParameterGroup":{ + "name":"ResetDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ResetDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

" + }, + "RestoreDBClusterFromSnapshot":{ + "name":"RestoreDBClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, + "output":{ + "shape":"RestoreDBClusterFromSnapshotResult", + "resultWrapper":"RestoreDBClusterFromSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

" + }, + "RestoreDBClusterToPointInTime":{ + "name":"RestoreDBClusterToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBClusterToPointInTimeResult", + "resultWrapper":"RestoreDBClusterToPointInTimeResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"StorageQuotaExceededFault"} + ], + "documentation":"

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

" + }, + "StartDBCluster":{ + "name":"StartDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDBClusterMessage"}, + "output":{ + "shape":"StartDBClusterResult", + "resultWrapper":"StartDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

" + }, + "StopDBCluster":{ + "name":"StopDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDBClusterMessage"}, + "output":{ + "shape":"StopDBClusterResult", + "resultWrapper":"StopDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

" + } + }, + "shapes":{ + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the Amazon DocumentDB resource.

" + } + }, + "documentation":"

Represents the input to AddTagsToResource.

" + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "ApplyPendingMaintenanceActionMessage":{ + "type":"structure", + "required":[ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to.

" + }, + "ApplyAction":{ + "shape":"String", + "documentation":"

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

" + }, + "OptInType":{ + "shape":"String", + "documentation":"

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" + } + }, + "documentation":"

Represents the input to ApplyPendingMaintenanceAction.

" + }, + "ApplyPendingMaintenanceActionResult":{ + "type":"structure", + "members":{ + "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} + } + }, + "AttributeValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeValue" + } + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified DB security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

" + } + }, + "documentation":"

Information about an Availability Zone.

", + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "AvailabilityZones":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "Certificate":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

The unique key that identifies a certificate.

Example: rds-ca-2019

" + }, + "CertificateType":{ + "shape":"String", + "documentation":"

The type of the certificate.

Example: CA

" + }, + "Thumbprint":{ + "shape":"String", + "documentation":"

The thumbprint of the certificate.

" + }, + "ValidFrom":{ + "shape":"TStamp", + "documentation":"

The starting date-time from which the certificate is valid.

Example: 2019-07-31T17:57:09Z

" + }, + "ValidTill":{ + "shape":"TStamp", + "documentation":"

The date-time after which the certificate is no longer valid.

Example: 2024-07-31T17:57:09Z

" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the certificate.

Example: arn:aws:rds:us-east-1::cert:rds-ca-2019

" + } + }, + "documentation":"

A certificate authority (CA) certificate for an AWS account.

", + "wrapper":true + }, + "CertificateList":{ + "type":"list", + "member":{ + "shape":"Certificate", + "locationName":"Certificate" + } + }, + "CertificateMessage":{ + "type":"structure", + "members":{ + "Certificates":{ + "shape":"CertificateList", + "documentation":"

A list of certificates for this AWS account.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

" + } + } + }, + "CertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

CertificateIdentifier doesn't refer to an existing certificate.

", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CloudwatchLogsExportConfiguration":{ + "type":"structure", + "members":{ + "EnableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The list of log types to enable.

" + }, + "DisableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The list of log types to disable.

" + } + }, + "documentation":"

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine that is being used.

" + }, + "CopyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members":{ + "SourceDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group.

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

" + }, + "TargetDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied DB cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

" + }, + "TargetDBClusterParameterGroupDescription":{ + "shape":"String", + "documentation":"

A description for the copied DB cluster parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags that are to be assigned to the parameter group.

" + } + }, + "documentation":"

Represents the input to CopyDBClusterParameterGroup.

" + }, + "CopyDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CopyDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members":{ + "SourceDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot to copy. This parameter is not case sensitive.

You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN.

Example: my-cluster-snapshot1

" + }, + "TargetDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key ID for an encrypted DB cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted DB cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the DB cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

" + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. You must use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another AWS Region.

The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.

" + }, + "CopyTags":{ + "shape":"BooleanOptional", + "documentation":"

Set to true to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB cluster snapshot.

" + } + }, + "documentation":"

Represents the input to CopyDBClusterSnapshot.

" + }, + "CopyDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CreateDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to associate with this DB cluster.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to associate with this DB cluster.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this DB cluster.

Valid values: docdb

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the instances in the DB cluster accept connections.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name of the master user for the DB cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).

Constraints: Must contain from 8 to 100 characters.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB cluster.

" + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the DB cluster is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier for an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a DB cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new DB cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

" + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" + } + }, + "documentation":"

Represents the input to CreateDBCluster.

" + }, + "CreateDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB cluster parameter group family name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB cluster parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB cluster parameter group.

" + } + }, + "documentation":"

Represents the input of CreateDBClusterParameterGroup.

" + }, + "CreateDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CreateDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "CreateDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB cluster snapshot.

" + } + }, + "documentation":"

Represents the input of CreateDBClusterSnapshot.

" + }, + "CreateDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine", + "DBClusterIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the DB instance; for example, db.r5.large.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this instance.

Valid value: docdb

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Amazon EC2 Availability Zone that the DB instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB instance. You can assign up to 10 tags to an instance.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster that the instance will belong to.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

" + } + }, + "documentation":"

Represents the input to CreateDBInstance.

" + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The Amazon EC2 subnet IDs for the DB subnet group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB subnet group.

" + } + }, + "documentation":"

Represents the input to CreateDBSubnetGroup.

" + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "DBCluster":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster can be created in.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + }, + "DBClusterParameterGroup":{ + "shape":"String", + "documentation":"

Specifies the name of the DB cluster parameter group for the DB cluster.

" + }, + "DBSubnetGroup":{ + "shape":"String", + "documentation":"

Specifies information on the subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the current state of this DB cluster.

" + }, + "PercentProgress":{ + "shape":"String", + "documentation":"

Specifies the progress of the operation as a percentage.

" + }, + "EarliestRestorableTime":{ + "shape":"TStamp", + "documentation":"

The earliest time to which a database can be restored with point-in-time restore.

" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

Specifies the connection endpoint for the primary instance of the DB cluster.

" + }, + "ReaderEndpoint":{ + "shape":"String", + "documentation":"

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load balances connections across the Amazon DocumentDB replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the DB cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your DB cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster has instances in multiple Availability Zones.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the port that the database engine is listening on.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master user name for the DB cluster.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + }, + "DBClusterMembers":{ + "shape":"DBClusterMemberList", + "documentation":"

Provides the list of instances that make up the DB cluster.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides a list of virtual private cloud (VPC) security groups that the DB cluster belongs to.

" + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

" + }, + "DbClusterResourceId":{ + "shape":"String", + "documentation":"

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

" + }, + "DBClusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster.

" + }, + "AssociatedRoles":{ + "shape":"DBClusterRoles", + "documentation":"

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that this DB cluster is configured to export to Amazon CloudWatch Logs.

" + }, + "DeletionProtection":{ + "shape":"Boolean", + "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" + } + }, + "documentation":"

Detailed information about a DB cluster.

", + "wrapper":true + }, + "DBClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a DB cluster with the given identifier.

", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterList":{ + "type":"list", + "member":{ + "shape":"DBCluster", + "locationName":"DBCluster" + } + }, + "DBClusterMember":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Specifies the instance identifier for this member of the DB cluster.

" + }, + "IsClusterWriter":{ + "shape":"Boolean", + "documentation":"

A value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" + }, + "DBClusterParameterGroupStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

" + } + }, + "documentation":"

Contains information about an instance that is part of a DB cluster.

", + "wrapper":true + }, + "DBClusterMemberList":{ + "type":"list", + "member":{ + "shape":"DBClusterMember", + "locationName":"DBClusterMember" + } + }, + "DBClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBClusters":{ + "shape":"DBClusterList", + "documentation":"

A list of DB clusters.

" + } + }, + "documentation":"

Represents the output of DescribeDBClusters.

" + }, + "DBClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterIdentifier doesn't refer to an existing DB cluster.

", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroup":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB cluster parameter group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB cluster parameter group.

" + }, + "DBClusterParameterGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + } + }, + "documentation":"

Detailed information about a DB cluster parameter group.

", + "wrapper":true + }, + "DBClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Provides a list of parameters for the DB cluster parameter group.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the output of DBClusterParameterGroup.

" + }, + "DBClusterParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBClusterParameterGroup", + "locationName":"DBClusterParameterGroup" + } + }, + "DBClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a DB cluster parameter group.

Constraints:

  • Must be from 1 to 255 letters or numbers.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

This value is stored as a lowercase string.

" + } + }, + "documentation":"

Contains the name of a DB cluster parameter group.

" + }, + "DBClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

", + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBClusterParameterGroups":{ + "shape":"DBClusterParameterGroupList", + "documentation":"

A list of DB cluster parameter groups.

" + } + }, + "documentation":"

Represents the output of DBClusterParameterGroups.

" + }, + "DBClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB cluster can't be created because you have reached the maximum allowed quota of DB clusters.

", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterRole":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - The IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - The IAM role ARN is being associated with the DB cluster.

  • INVALID - The IAM role ARN is associated with the DB cluster, but the DB cluster cannot assume the IAM role to access other AWS services on your behalf.

" + } + }, + "documentation":"

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

" + }, + "DBClusterRoles":{ + "type":"list", + "member":{ + "shape":"DBClusterRole", + "locationName":"DBClusterRole" + } + }, + "DBClusterSnapshot":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of Amazon EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

" + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier for the DB cluster snapshot.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the time when the snapshot was taken, in UTC.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Specifies the name of the database engine.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of this DB cluster snapshot.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the virtual private cloud (VPC) ID that is associated with the DB cluster snapshot.

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Provides the master user name for the DB cluster snapshot.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Provides the version of the database engine for this DB cluster snapshot.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

Provides the type of the DB cluster snapshot.

" + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

Specifies the percentage of the estimated data that has been transferred.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster snapshot is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

" + }, + "DBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" + }, + "SourceDBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

If the DB cluster snapshot was copied from a source DB cluster snapshot, the ARN for the source DB cluster snapshot; otherwise, a null value.

" + } + }, + "documentation":"

Detailed information about a DB cluster snapshot.

", + "wrapper":true + }, + "DBClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a DB cluster snapshot with the given identifier.

", + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot.

" + }, + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

The values for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

" + } + }, + "documentation":"

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot.

" + }, + "DBClusterSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshotAttribute", + "locationName":"DBClusterSnapshotAttribute" + } + }, + "DBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot that the attributes apply to.

" + }, + "DBClusterSnapshotAttributes":{ + "shape":"DBClusterSnapshotAttributeList", + "documentation":"

The list of attributes and values for the DB cluster snapshot.

" + } + }, + "documentation":"

Detailed information about the attributes that are associated with a DB cluster snapshot.

", + "wrapper":true + }, + "DBClusterSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshot", + "locationName":"DBClusterSnapshot" + } + }, + "DBClusterSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBClusterSnapshots":{ + "shape":"DBClusterSnapshotList", + "documentation":"

Provides a list of DB cluster snapshots.

" + } + }, + "documentation":"

Represents the output of DescribeDBClusterSnapshots.

" + }, + "DBClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB parameter group family for the database engine.

" + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

The description of the database engine.

" + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the database engine version.

" + }, + "ValidUpgradeTarget":{ + "shape":"ValidUpgradeTargetList", + "documentation":"

A list of engine versions that this database engine version can be upgraded to.

" + }, + "ExportableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The types of logs that the database engine has available for export to Amazon CloudWatch Logs.

" + }, + "SupportsLogExportsToCloudwatchLogs":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + } + }, + "documentation":"

Detailed information about a DB engine version.

" + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

Detailed information about one or more DB engine versions.

" + } + }, + "documentation":"

Represents the output of DescribeDBEngineVersions.

" + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-provided database identifier. This identifier is the unique key that identifies a DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB instance.

" + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

Specifies the current state of this database.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

Specifies the connection endpoint.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the date and time that the DB instance was created.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides a list of VPC security group elements that the DB instance belongs to.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone that the DB instance is located in.

" + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

Specifies information on the subnet group that is associated with the DB instance, including the name, description, and subnets in the subnet group.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

Specifies that changes to the DB instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that minor version patches are applied automatically.

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

" + }, + "StatusInfos":{ + "shape":"DBInstanceStatusInfoList", + "documentation":"

The status of a read replica. If the instance is not a read replica, this is blank.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB cluster.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether or not the DB instance is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

" + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the CA certificate for this DB instance.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

" + }, + "DBInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB instance.

" + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs.

" + } + }, + "documentation":"

Detailed information about a DB instance.

", + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a DB instance with the given identifier.

", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

Detailed information about one or more DB instances.

" + } + }, + "documentation":"

Represents the output of DescribeDBInstances.

" + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBInstanceIdentifier doesn't refer to an existing DB instance.

", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{ + "shape":"String", + "documentation":"

This value is currently \"read replication.\"

" + }, + "Normal":{ + "shape":"Boolean", + "documentation":"

A Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

" + } + }, + "documentation":"

Provides a list of status information for a DB instance.

" + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

A DB parameter group with the same name already exists.

", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBParameterGroupName doesn't refer to an existing DB parameter group.

", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

This request would cause you to exceed the allowed number of DB parameter groups.

", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSecurityGroupName doesn't refer to an existing DB security group.

", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSnapshotIdentifier is already being used by an existing snapshot.

", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group.

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the virtual private cloud (VPC) ID of the DB subnet group.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

Provides the status of the DB subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Detailed information about one or more subnets within a DB subnet group.

" + }, + "DBSubnetGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB subnet group.

" + } + }, + "documentation":"

Detailed information about a DB subnet group.

", + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSubnetGroupName is already being used by an existing DB subnet group.

", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

Detailed information about one or more DB subnet groups.

" + } + }, + "documentation":"

Represents the output of DescribeDBSubnetGroups.

" + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSubnetGroupName doesn't refer to an existing DB subnet group.

", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request would cause you to exceed the allowed number of DB subnet groups.

", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request would cause you to exceed the allowed number of subnets in a DB subnet group.

", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB upgrade failed because a resource that the DB depends on can't be modified.

", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + } + }, + "documentation":"

Represents the input to DeleteDBCluster.

" + }, + "DeleteDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be the name of an existing DB cluster parameter group.

  • You can't delete a default DB cluster parameter group.

  • Cannot be associated with any DB clusters.

" + } + }, + "documentation":"

Represents the input to DeleteDBClusterParameterGroup.

" + }, + "DeleteDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "DeleteDBClusterSnapshotMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

" + } + }, + "documentation":"

Represents the input to DeleteDBClusterSnapshot.

" + }, + "DeleteDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.

Constraints:

  • Must match the name of an existing DB instance.

" + } + }, + "documentation":"

Represents the input to DeleteDBInstance.

" + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + } + }, + "documentation":"

Represents the input to DeleteDBSubnetGroup.

" + }, + "DescribeCertificatesMessage":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

  • Must match an existing CertificateIdentifier.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints:

  • Minimum: 20

  • Maximum: 100

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeDBClusterParameterGroups.

" + }, + "DescribeDBClusterParametersMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

  • If provided, must match the name of an existing DBClusterParameterGroup.

" + }, + "Source":{ + "shape":"String", + "documentation":"

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeDBClusterParameters.

" + }, + "DescribeDBClusterSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB cluster snapshot to describe the attributes for.

" + } + }, + "documentation":"

Represents the input to DescribeDBClusterSnapshotAttributes.

" + }, + "DescribeDBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "DescribeDBClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used with the DBClusterSnapshotIdentifier parameter. This parameter is not case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBCluster.

" + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

A specific DB cluster snapshot identifier to describe. This parameter can't be used with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If provided, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that Amazon DocumentDB has automatically created for your AWS account.

  • manual - Return all DB cluster snapshots that you have manually created for your AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to your AWS account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "IncludeShared":{ + "shape":"Boolean", + "documentation":"

Set to true to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

" + }, + "IncludePublic":{ + "shape":"Boolean", + "documentation":"

Set to true to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

" + } + }, + "documentation":"

Represents the input to DescribeDBClusterSnapshots.

" + }, + "DescribeDBClustersMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The user-provided DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match an existing DBClusterIdentifier.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeDBClusters.

" + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The database engine to return.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The database engine version to return.

Example: 5.1.49

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group family to return details for.

Constraints:

  • If provided, must match an existing DBParameterGroupFamily.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" + }, + "ListSupportedTimezones":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

" + } + }, + "documentation":"

Represents the input to DescribeDBEngineVersions.

" + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The user-provided instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.

Constraints:

  • If provided, must match the identifier of an existing DBInstance.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only the information about the DB instances that are associated with the DB clusters that are identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes only the information about the DB instances that are identified by these ARNs.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeDBInstances.

" + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group to return details for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeDBSubnetGroups.

" + }, + "DescribeEngineDefaultClusterParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group family to return the engine parameter information for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeEngineDefaultClusterParameters.

" + }, + "DescribeEngineDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that is generating the events.

Valid values: db-instance, db-parameter-group, db-security-group, db-snapshot

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + } + }, + "documentation":"

Represents the input to DescribeEventCategories.

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes to retrieve events for.

Default: 60

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories that trigger notifications for an event notification subscription.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeEvents.

" + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the engine to retrieve DB instance options for.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings that match the specified DB instance class.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

" + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input to DescribeOrderableDBInstanceOptions.

" + }, + "DescribePendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The ARN of a resource to return pending maintenance actions for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list includes only pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list includes only pending maintenance actions for the DB instances identified by these ARNs.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + } + }, + "documentation":"

Represents the input to DescribePendingMaintenanceActions.

" + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

Specifies the DNS address of the DB instance.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine is listening on.

" + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + }, + "documentation":"

Network information for accessing a DB cluster or DB instance. Client programs must specify a valid endpoint to access these Amazon DocumentDB resources.

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group family to return the engine parameter information for.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

The parameters of a particular DB cluster parameter group family.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultClusterParameters operation.

", + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

Provides the identifier for the source of the event.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the source type for this event.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Provides the text of this event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the category for the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

Specifies the date and time of the event.

" + }, + "SourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the event.

" + } + }, + "documentation":"

Detailed information about an event.

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The source type that the returned categories belong to.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories for the specified source type.

" + } + }, + "documentation":"

An event source type, accompanied by one or more event category names.

", + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

A list of event category maps.

" + } + }, + "documentation":"

Represents the output of DescribeEventCategories.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

Detailed information about one or more events.

" + } + }, + "documentation":"

Represents the output of DescribeEvents.

" + }, + "FailoverDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

A DB cluster identifier to force a failover for. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Amazon DocumentDB replica in the DB cluster. For example, mydbcluster-replica1.

" + } + }, + "documentation":"

Represents the input to FailoverDBCluster.

" + }, + "FailoverDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case sensitive.

" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

One or more filter values. Filter values are case sensitive.

" + } + }, + "documentation":"

A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

Wildcards are not supported in filters.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request would cause you to exceed the allowed number of DB instances.

", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB cluster doesn't have enough capacity for the current operation.

", + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified DB instance class isn't available in the specified Availability Zone.

", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientStorageClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

", + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The provided value isn't a valid DB cluster snapshot state.

", + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB cluster isn't in a valid state.

", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified DB instance isn't in the available state.

", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The state of the DB security group doesn't allow deletion.

", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The state of the DB snapshot doesn't allow deletion.

", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet group can't be deleted because it's in use.

", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet isn't in the available state.

", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSKeyNotAccessibleFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

An error occurred when accessing an AWS KMS key.

", + "error":{ + "code":"KMSKeyNotAccessibleFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon DocumentDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + } + }, + "documentation":"

Represents the input to ListTagsForResource.

" + }, + "LogTypeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ModifyDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier for the cluster that is being modified. This parameter is not case sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "NewDBClusterIdentifier":{ + "shape":"String", + "documentation":"

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster2

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

A value that specifies whether the changes in this request and any pending changes are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter affects only the NewDBClusterIdentifier and MasterUserPassword values. If you set this parameter value to false, the changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35.

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to use for the DB cluster.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of virtual private cloud (VPC) security groups that the DB cluster will belong to.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the DB cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original DB cluster.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).

Constraints: Must contain from 8 to 100 characters.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

" + }, + "CloudwatchLogsExportConfiguration":{ + "shape":"CloudwatchLogsExportConfiguration", + "documentation":"

The configuration setting for the log types to be enabled for export to Amazon CloudWatch Logs for a specific DB instance or DB cluster. The EnableLogTypes and DisableLogTypes arrays determine which logs are exported (or not exported) to CloudWatch Logs.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

" + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" + } + }, + "documentation":"

Represents the input to ModifyDBCluster.

" + }, + "ModifyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "Parameters" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to modify.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of parameters in the DB cluster parameter group to modify.

" + } + }, + "documentation":"

Represents the input to ModifyDBClusterParameterGroup.

" + }, + "ModifyDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ModifyDBClusterSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB cluster snapshot to modify the attributes for.

" + }, + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

" + }, + "ValuesToAdd":{ + "shape":"AttributeValueList", + "documentation":"

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs. To make the manual DB cluster snapshot restorable by any AWS account, set it to all. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want to be available to all AWS accounts.

" + }, + "ValuesToRemove":{ + "shape":"AttributeValueList", + "documentation":"

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers. To remove authorization for any AWS account to copy or restore the DB cluster snapshot, set it to all . If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

" + } + }, + "documentation":"

Represents the input to ModifyDBClusterSnapshotAttribute.

" + }, + "ModifyDBClusterSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The new compute and memory capacity of the DB instance; for example, db.r5.large. Not all DB instance classes are available in all AWS Regions.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next reboot.

Default: false

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, changing this parameter causes a reboot of the DB instance. If you are moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Must be at least 30 minutes.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case, and the change is asynchronously applied as soon as possible. An outage results if this parameter is set to true during the maintenance window, and a newer minor version is available, and Amazon DocumentDB has enabled automatic patching for that engine version.

" + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you set Apply Immediately to true. It occurs during the next maintenance window if you set Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

Indicates the certificate that needs to be associated with the instance.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid values: 0-15

" + } + }, + "documentation":"

Represents the input to ModifyDBInstance.

" + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The Amazon EC2 subnet IDs for the DB subnet group.

" + } + }, + "documentation":"

Represents the input to ModifyDBSubnetGroup.

" + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The engine type of a DB instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of a DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for a DB instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for a DB instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

A list of Availability Zones for a DB instance.

" + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance is in a virtual private cloud (VPC).

" + } + }, + "documentation":"

The options that are available for a DB instance.

", + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

The options that are available for a particular orderable DB instance.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the output of DescribeOrderableDBInstanceOptions.

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

Specifies the name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

Specifies the value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides a description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

Indicates the source of the parameter value.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

Specifies the engine-specific parameters type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest engine version to which the parameter can apply.

" + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

Indicates when to apply parameter updates.

" + } + }, + "documentation":"

Detailed information about an individual parameter.

" + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingCloudwatchLogsExports":{ + "type":"structure", + "members":{ + "LogTypesToEnable":{ + "shape":"LogTypeList", + "documentation":"

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" + }, + "LogTypesToDisable":{ + "shape":"LogTypeList", + "documentation":"

Log types that are in the process of being enabled. After they are enabled, these log types are exported to Amazon CloudWatch Logs.

" + } + }, + "documentation":"

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

" + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"String", + "documentation":"

The type of pending maintenance action that is available for the resource.

" + }, + "AutoAppliedAfterDate":{ + "shape":"TStamp", + "documentation":"

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

" + }, + "ForcedApplyDate":{ + "shape":"TStamp", + "documentation":"

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

" + }, + "OptInStatus":{ + "shape":"String", + "documentation":"

Indicates the type of opt-in request that has been received for the resource.

" + }, + "CurrentApplyDate":{ + "shape":"TStamp", + "documentation":"

The effective date when the pending maintenance action is applied to the resource.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description providing more detail about the maintenance action.

" + } + }, + "documentation":"

Provides information about a pending maintenance action for a resource.

" + }, + "PendingMaintenanceActionDetails":{ + "type":"list", + "member":{ + "shape":"PendingMaintenanceAction", + "locationName":"PendingMaintenanceAction" + } + }, + "PendingMaintenanceActions":{ + "type":"list", + "member":{ + "shape":"ResourcePendingMaintenanceActions", + "locationName":"ResourcePendingMaintenanceActions" + } + }, + "PendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "PendingMaintenanceActions":{ + "shape":"PendingMaintenanceActions", + "documentation":"

The maintenance actions to be applied.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the output of DescribePendingMaintenanceActions.

" + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Contains the pending or currently in-progress change of the master credentials for the DB instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending port for the DB instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending number of days for which automated backups are retained.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for the DB instance.

Valid values: license-included, bring-your-own-license, general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Specifies the storage type to be associated with the DB instance.

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the certificate authority (CA) certificate for the DB instance.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The new DB subnet group for the DB instance.

" + }, + "PendingCloudwatchLogsExports":{ + "shape":"PendingCloudwatchLogsExports", + "documentation":"

A list of the log types whose configuration is still pending. These log types are in the process of being activated or deactivated.

" + } + }, + "documentation":"

One or more modified settings for a DB instance. These modified settings have been requested, but haven't been applied yet.

" + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

" + } + }, + "documentation":"

Represents the input to RebootDBInstance.

" + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon DocumentDB resource that the tags are removed from. This value is an Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + }, + "documentation":"

Represents the input to RemoveTagsFromResource.

" + }, + "ResetDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to reset.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

" + } + }, + "documentation":"

Represents the input to ResetDBClusterParameterGroup.

" + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource ID was not found.

", + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourcePendingMaintenanceActions":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource that has pending maintenance actions.

" + }, + "PendingMaintenanceActionDetails":{ + "shape":"PendingMaintenanceActionDetails", + "documentation":"

A list that provides details about the pending maintenance actions for the resource.

" + } + }, + "documentation":"

Represents the output of ApplyPendingMaintenanceAction.

", + "wrapper":true + }, + "RestoreDBClusterFromSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of Amazon EC2 Availability Zones that instances in the restored DB cluster can be created in.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-snapshot-id

" + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing snapshot.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new DB cluster.

Default: The same as source.

Constraint: Must be compatible with the engine of the source.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the database engine to use for the new DB cluster.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The same port as the original DB cluster.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group to use for the new DB cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of virtual private cloud (VPC) security groups that the new DB cluster will belong to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the restored DB cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the DB snapshot or the DB cluster snapshot.

  • If the DB snapshot or the DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

" + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" + } + }, + "documentation":"

Represents the input to RestoreDBClusterFromSnapshot.

" + }, + "RestoreDBClusterFromSnapshotResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterToPointInTimeMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "SourceDBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "RestoreToTime":{ + "shape":"TStamp", + "documentation":"

The date and time to restore the DB cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

  • Must be before the latest restorable time for the DB instance.

  • Must be specified if the UseLatestRestorableTime parameter is not provided.

  • Cannot be specified if the UseLatestRestorableTime parameter is true.

  • Cannot be specified if the RestoreType parameter is copy-on-write.

Example: 2015-03-07T23:45:00Z

" + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Must be a value from 1150 to 65535.

Default: The default port for the engine.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new DB cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VPC security groups that the new DB cluster belongs to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the restored DB cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the AWS KMS encryption key used to encrypt the new DB cluster, then you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with an AWS KMS key that is different from the AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that must be enabled for exporting to Amazon CloudWatch Logs.

" + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" + } + }, + "documentation":"

Represents the input to RestoreDBClusterToPointInTime.

" + }, + "RestoreDBClusterToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "SharedSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", + "error":{ + "code":"SharedSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request would cause you to exceed the allowed number of DB snapshots.

", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot", + "db-cluster", + "db-cluster-snapshot" + ] + }, + "StartDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the cluster to restart. Example: docdb-2019-05-28-15-24-52

" + } + } + }, + "StartDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "StopDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the cluster to stop. Example: docdb-2019-05-28-15-24-52

" + } + } + }, + "StopDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request would cause you to exceed the allowed amount of storage available across all DB instances.

", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Storage of the specified StorageType can't be associated with the DB instance.

", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the subnet.

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

Specifies the Availability Zone for the subnet.

" + }, + "SubnetStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the subnet.

" + } + }, + "documentation":"

Detailed information about a subnet.

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet is already in use in the Availability Zone.

", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

A list of one or more tags.

" + } + }, + "documentation":"

Represents the output of ListTagsForResource.

" + }, + "UpgradeTarget":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the upgrade target database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the upgrade target database engine.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" + }, + "AutoUpgrade":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" + }, + "IsMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether a database engine is upgraded to a major version.

" + } + }, + "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" + }, + "ValidUpgradeTargetList":{ + "type":"list", + "member":{ + "shape":"UpgradeTarget", + "locationName":"UpgradeTarget" + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The name of the VPC security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC security group.

" + } + }, + "documentation":"

Used as a response element for queries on virtual private cloud (VPC) security group membership.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + }, + "documentation":"

Amazon DocumentDB API documentation

" +} diff --git a/aws/dist/botocore/data/docdb/2014-10-31/waiters-2.json b/aws/dist/botocore/data/docdb/2014-10-31/waiters-2.json new file mode 100644 index 00000000..e75f03b2 --- /dev/null +++ b/aws/dist/botocore/data/docdb/2014-10-31/waiters-2.json @@ -0,0 +1,90 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ds/2015-04-16/examples-1.json b/aws/dist/botocore/data/ds/2015-04-16/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/ds/2015-04-16/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/ds/2015-04-16/paginators-1.json b/aws/dist/botocore/data/ds/2015-04-16/paginators-1.json new file mode 100644 index 00000000..3b74918e --- /dev/null +++ b/aws/dist/botocore/data/ds/2015-04-16/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "DescribeDomainControllers": { + "result_key": "DomainControllers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "Limit" + }, + "DescribeDirectories": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "DirectoryDescriptions" + }, + "DescribeSharedDirectories": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "SharedDirectories" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Snapshots" + }, + "DescribeTrusts": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Trusts" + }, + "ListIpRoutes": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "IpRoutesInfo" + }, + "ListLogSubscriptions": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "LogSubscriptions" + }, + "ListSchemaExtensions": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "SchemaExtensionsInfo" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/ds/2015-04-16/service-2.json b/aws/dist/botocore/data/ds/2015-04-16/service-2.json new file mode 100644 index 00000000..0b142fed --- /dev/null +++ b/aws/dist/botocore/data/ds/2015-04-16/service-2.json @@ -0,0 +1,3746 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-16", + "endpointPrefix":"ds", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Directory Service", + "serviceFullName":"AWS Directory Service", + "serviceId":"Directory Service", + "signatureVersion":"v4", + "targetPrefix":"DirectoryService_20150416", + "uid":"ds-2015-04-16" + }, + "operations":{ + "AcceptSharedDirectory":{ + "name":"AcceptSharedDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptSharedDirectoryRequest"}, + "output":{"shape":"AcceptSharedDirectoryResult"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryAlreadySharedException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Accepts a directory sharing request that was sent from the directory owner account.

" + }, + "AddIpRoutes":{ + "name":"AddIpRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddIpRoutesRequest"}, + "output":{"shape":"AddIpRoutesResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"InvalidParameterException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"IpRouteLimitExceededException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

If the DNS server for your on-premises domain uses a publicly addressable IP address, you must add a CIDR address block to correctly route traffic to and from your Microsoft AD on Amazon Web Services. AddIpRoutes adds this address block. You can also use AddIpRoutes to facilitate routing traffic that uses public IP ranges from your Microsoft AD on AWS to a peer VPC.

Before you call AddIpRoutes, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the AddIpRoutes operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceRequest"}, + "output":{"shape":"AddTagsToResourceResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Adds or overwrites one or more tags for the specified directory. Each directory can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique to each resource.

" + }, + "CancelSchemaExtension":{ + "name":"CancelSchemaExtension", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSchemaExtensionRequest"}, + "output":{"shape":"CancelSchemaExtensionResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Cancels an in-progress schema extension to a Microsoft AD directory. Once a schema extension has started replicating to all domain controllers, the task can no longer be canceled. A schema extension can be canceled during any of the following states; Initializing, CreatingSnapshot, and UpdatingSchema.

" + }, + "ConnectDirectory":{ + "name":"ConnectDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConnectDirectoryRequest"}, + "output":{"shape":"ConnectDirectoryResult"}, + "errors":[ + {"shape":"DirectoryLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates an AD Connector to connect to an on-premises directory.

Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasRequest"}, + "output":{"shape":"CreateAliasResult"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

" + }, + "CreateComputer":{ + "name":"CreateComputer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateComputerRequest"}, + "output":{"shape":"CreateComputerResult"}, + "errors":[ + {"shape":"AuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates a computer account in the specified directory, and joins the computer to the directory.

" + }, + "CreateConditionalForwarder":{ + "name":"CreateConditionalForwarder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConditionalForwarderRequest"}, + "output":{"shape":"CreateConditionalForwarderResult"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates a conditional forwarder associated with your AWS directory. Conditional forwarders are required in order to set up a trust relationship with another domain. The conditional forwarder points to the trusted domain.

" + }, + "CreateDirectory":{ + "name":"CreateDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDirectoryRequest"}, + "output":{"shape":"CreateDirectoryResult"}, + "errors":[ + {"shape":"DirectoryLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates a Simple AD directory.

Before you call CreateDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + }, + "CreateLogSubscription":{ + "name":"CreateLogSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogSubscriptionRequest"}, + "output":{"shape":"CreateLogSubscriptionResult"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InsufficientPermissionsException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates a subscription to forward real time Directory Service domain controller security logs to the specified CloudWatch log group in your AWS account.

" + }, + "CreateMicrosoftAD":{ + "name":"CreateMicrosoftAD", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMicrosoftADRequest"}, + "output":{"shape":"CreateMicrosoftADResult"}, + "errors":[ + {"shape":"DirectoryLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Creates an AWS Managed Microsoft AD directory.

Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{"shape":"CreateSnapshotResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"SnapshotLimitExceededException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Creates a snapshot of a Simple AD or Microsoft AD directory in the AWS cloud.

You cannot take snapshots of AD Connector directories.

" + }, + "CreateTrust":{ + "name":"CreateTrust", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrustRequest"}, + "output":{"shape":"CreateTrustResult"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain. You can create either a forest trust or an external trust.

" + }, + "DeleteConditionalForwarder":{ + "name":"DeleteConditionalForwarder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConditionalForwarderRequest"}, + "output":{"shape":"DeleteConditionalForwarderResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Deletes a conditional forwarder that has been set up for your AWS directory.

" + }, + "DeleteDirectory":{ + "name":"DeleteDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDirectoryRequest"}, + "output":{"shape":"DeleteDirectoryResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Deletes an AWS Directory Service directory.

Before you call DeleteDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the DeleteDirectory operation, see AWS Directory Service API Permissions: Actions, Resources, and Conditions Reference.

" + }, + "DeleteLogSubscription":{ + "name":"DeleteLogSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogSubscriptionRequest"}, + "output":{"shape":"DeleteLogSubscriptionResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Deletes the specified log subscription.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "output":{"shape":"DeleteSnapshotResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Deletes a directory snapshot.

" + }, + "DeleteTrust":{ + "name":"DeleteTrust", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrustRequest"}, + "output":{"shape":"DeleteTrustResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Deletes an existing trust relationship between your AWS Managed Microsoft AD directory and an external domain.

" + }, + "DeregisterEventTopic":{ + "name":"DeregisterEventTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterEventTopicRequest"}, + "output":{"shape":"DeregisterEventTopicResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Removes the specified directory as a publisher to the specified SNS topic.

" + }, + "DescribeConditionalForwarders":{ + "name":"DescribeConditionalForwarders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConditionalForwardersRequest"}, + "output":{"shape":"DescribeConditionalForwardersResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains information about the conditional forwarders for this account.

If no input parameters are provided for RemoteDomainNames, this request describes all conditional forwarders for the specified directory ID.

" + }, + "DescribeDirectories":{ + "name":"DescribeDirectories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDirectoriesRequest"}, + "output":{"shape":"DescribeDirectoriesResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains information about the directories that belong to this account.

You can retrieve information about specific directories by passing the directory identifiers in the DirectoryIds parameter. Otherwise, all directories that belong to the current account are returned.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeDirectoriesResult.NextToken member contains a token that you pass in the next call to DescribeDirectories to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

" + }, + "DescribeDomainControllers":{ + "name":"DescribeDomainControllers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainControllersRequest"}, + "output":{"shape":"DescribeDomainControllersResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Provides information about any domain controllers in your directory.

" + }, + "DescribeEventTopics":{ + "name":"DescribeEventTopics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventTopicsRequest"}, + "output":{"shape":"DescribeEventTopicsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains information about which SNS topics receive status messages from the specified directory.

If no input parameters are provided, such as DirectoryId or TopicName, this request describes all of the associations in the account.

" + }, + "DescribeSharedDirectories":{ + "name":"DescribeSharedDirectories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSharedDirectoriesRequest"}, + "output":{"shape":"DescribeSharedDirectoriesResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Returns the shared directories in your account.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains information about the directory snapshots that belong to this account.

This operation supports pagination with the use of the NextToken request and response parameters. If more results are available, the DescribeSnapshots.NextToken member contains a token that you pass in the next call to DescribeSnapshots to retrieve the next set of items.

You can also specify a maximum number of return results with the Limit parameter.

" + }, + "DescribeTrusts":{ + "name":"DescribeTrusts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustsRequest"}, + "output":{"shape":"DescribeTrustsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Obtains information about the trust relationships for this account.

If no input parameters are provided, such as DirectoryId or TrustIds, this request describes all the trust relationships belonging to the account.

" + }, + "DisableRadius":{ + "name":"DisableRadius", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableRadiusRequest"}, + "output":{"shape":"DisableRadiusResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Disables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" + }, + "DisableSso":{ + "name":"DisableSso", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableSsoRequest"}, + "output":{"shape":"DisableSsoResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InsufficientPermissionsException"}, + {"shape":"AuthenticationFailedException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Disables single-sign on for a directory.

" + }, + "EnableRadius":{ + "name":"EnableRadius", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableRadiusRequest"}, + "output":{"shape":"EnableRadiusResult"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

" + }, + "EnableSso":{ + "name":"EnableSso", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableSsoRequest"}, + "output":{"shape":"EnableSsoResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InsufficientPermissionsException"}, + {"shape":"AuthenticationFailedException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Enables single sign-on for a directory.

" + }, + "GetDirectoryLimits":{ + "name":"GetDirectoryLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDirectoryLimitsRequest"}, + "output":{"shape":"GetDirectoryLimitsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains directory limit information for the current region.

" + }, + "GetSnapshotLimits":{ + "name":"GetSnapshotLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSnapshotLimitsRequest"}, + "output":{"shape":"GetSnapshotLimitsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Obtains the manual snapshot limits for a directory.

" + }, + "ListIpRoutes":{ + "name":"ListIpRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIpRoutesRequest"}, + "output":{"shape":"ListIpRoutesResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Lists the address blocks that you have added to a directory.

" + }, + "ListLogSubscriptions":{ + "name":"ListLogSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLogSubscriptionsRequest"}, + "output":{"shape":"ListLogSubscriptionsResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Lists the active log subscriptions for the AWS account.

" + }, + "ListSchemaExtensions":{ + "name":"ListSchemaExtensions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSchemaExtensionsRequest"}, + "output":{"shape":"ListSchemaExtensionsResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Lists all schema extensions applied to a Microsoft AD Directory.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Lists all tags on a directory.

" + }, + "RegisterEventTopic":{ + "name":"RegisterEventTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterEventTopicRequest"}, + "output":{"shape":"RegisterEventTopicResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Associates a directory with an SNS topic. This establishes the directory as a publisher to the specified SNS topic. You can then receive email or text (SMS) messages when the status of your directory changes. You get notified if your directory goes from an Active status to an Impaired or Inoperable status. You also receive a notification when the directory returns to an Active status.

" + }, + "RejectSharedDirectory":{ + "name":"RejectSharedDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectSharedDirectoryRequest"}, + "output":{"shape":"RejectSharedDirectoryResult"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryAlreadySharedException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Rejects a directory sharing request that was sent from the directory owner account.

" + }, + "RemoveIpRoutes":{ + "name":"RemoveIpRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveIpRoutesRequest"}, + "output":{"shape":"RemoveIpRoutesResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Removes IP address blocks from a directory.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceRequest"}, + "output":{"shape":"RemoveTagsFromResourceResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Removes tags from a directory.

" + }, + "ResetUserPassword":{ + "name":"ResetUserPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetUserPasswordRequest"}, + "output":{"shape":"ResetUserPasswordResult"}, + "errors":[ + {"shape":"DirectoryUnavailableException"}, + {"shape":"UserDoesNotExistException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Resets the password for any user in your AWS Managed Microsoft AD or Simple AD directory.

" + }, + "RestoreFromSnapshot":{ + "name":"RestoreFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreFromSnapshotRequest"}, + "output":{"shape":"RestoreFromSnapshotResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Restores a directory using an existing directory snapshot.

When you restore a directory from a snapshot, any changes made to the directory after the snapshot date are overwritten.

This action returns as soon as the restore operation is initiated. You can monitor the progress of the restore operation by calling the DescribeDirectories operation with the directory identifier. When the DirectoryDescription.Stage value changes to Active, the restore operation is complete.

" + }, + "ShareDirectory":{ + "name":"ShareDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ShareDirectoryRequest"}, + "output":{"shape":"ShareDirectoryResult"}, + "errors":[ + {"shape":"DirectoryAlreadySharedException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidTargetException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ShareLimitExceededException"}, + {"shape":"OrganizationsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Shares a specified directory (DirectoryId) in your AWS account (directory owner) with another AWS account (directory consumer). With this operation you can use your directory from any AWS account and from any Amazon VPC within an AWS Region.

When you share your AWS Managed Microsoft AD directory, AWS Directory Service creates a shared directory in the directory consumer account. This shared directory contains the metadata to provide access to the directory within the directory owner account. The shared directory is visible in all VPCs in the directory consumer account.

The ShareMethod parameter determines whether the specified directory can be shared between AWS accounts inside the same AWS organization (ORGANIZATIONS). It also determines whether you can share the directory with any other AWS account either inside or outside of the organization (HANDSHAKE).

The ShareNotes parameter is only used when HANDSHAKE is called, which sends a directory sharing request to the directory consumer.

" + }, + "StartSchemaExtension":{ + "name":"StartSchemaExtension", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSchemaExtensionRequest"}, + "output":{"shape":"StartSchemaExtensionResult"}, + "errors":[ + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"SnapshotLimitExceededException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Applies a schema extension to a Microsoft AD directory.

" + }, + "UnshareDirectory":{ + "name":"UnshareDirectory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnshareDirectoryRequest"}, + "output":{"shape":"UnshareDirectoryResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidTargetException"}, + {"shape":"DirectoryNotSharedException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Stops the directory sharing between the directory owner and consumer accounts.

" + }, + "UpdateConditionalForwarder":{ + "name":"UpdateConditionalForwarder", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConditionalForwarderRequest"}, + "output":{"shape":"UpdateConditionalForwarderResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Updates a conditional forwarder that has been set up for your AWS directory.

" + }, + "UpdateNumberOfDomainControllers":{ + "name":"UpdateNumberOfDomainControllers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNumberOfDomainControllersRequest"}, + "output":{"shape":"UpdateNumberOfDomainControllersResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"DomainControllerLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

" + }, + "UpdateRadius":{ + "name":"UpdateRadius", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRadiusRequest"}, + "output":{"shape":"UpdateRadiusResult"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"EntityDoesNotExistException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Updates the Remote Authentication Dial In User Service (RADIUS) server information for an AD Connector or Microsoft AD directory.

" + }, + "UpdateTrust":{ + "name":"UpdateTrust", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTrustRequest"}, + "output":{"shape":"UpdateTrustResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Updates the trust that has been set up between your AWS Managed Microsoft AD directory and an on-premises Active Directory.

" + }, + "VerifyTrust":{ + "name":"VerifyTrust", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyTrustRequest"}, + "output":{"shape":"VerifyTrustResult"}, + "errors":[ + {"shape":"EntityDoesNotExistException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServiceException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure and verify trust relationships.

This action verifies a trust relationship between your AWS Managed Microsoft AD directory and an external domain.

" + } + }, + "shapes":{ + "AcceptSharedDirectoryRequest":{ + "type":"structure", + "required":["SharedDirectoryId"], + "members":{ + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

" + } + } + }, + "AcceptSharedDirectoryResult":{ + "type":"structure", + "members":{ + "SharedDirectory":{ + "shape":"SharedDirectory", + "documentation":"

The shared directory in the directory consumer account.

" + } + } + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "exception":true + }, + "AccessUrl":{ + "type":"string", + "max":128, + "min":1 + }, + "AddIpRoutesRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "IpRoutes" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory to which to add the address block.

" + }, + "IpRoutes":{ + "shape":"IpRoutes", + "documentation":"

IP address blocks, using CIDR format, of the traffic to route. This is often the IP address block of the DNS server used for your on-premises domain.

" + }, + "UpdateSecurityGroupForDirectoryControllers":{ + "shape":"UpdateSecurityGroupForDirectoryControllers", + "documentation":"

If set to true, updates the inbound and outbound rules of the security group that has the description: \"AWS created security group for directory ID directory controllers.\" Following are the new rules:

Inbound:

  • Type: Custom UDP Rule, Protocol: UDP, Range: 88, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 123, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 138, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 389, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 464, Source: 0.0.0.0/0

  • Type: Custom UDP Rule, Protocol: UDP, Range: 445, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 88, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 135, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 445, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 464, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 636, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 1024-65535, Source: 0.0.0.0/0

  • Type: Custom TCP Rule, Protocol: TCP, Range: 3268-33269, Source: 0.0.0.0/0

  • Type: DNS (UDP), Protocol: UDP, Range: 53, Source: 0.0.0.0/0

  • Type: DNS (TCP), Protocol: TCP, Range: 53, Source: 0.0.0.0/0

  • Type: LDAP, Protocol: TCP, Range: 389, Source: 0.0.0.0/0

  • Type: All ICMP, Protocol: All, Range: N/A, Source: 0.0.0.0/0

Outbound:

  • Type: All traffic, Protocol: All, Range: All, Destination: 0.0.0.0/0

These security rules impact an internal network interface that is not exposed publicly.

" + } + } + }, + "AddIpRoutesResult":{ + "type":"structure", + "members":{ + } + }, + "AddTagsToResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

Identifier (ID) for the directory to which to add the tag.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to be assigned to the directory.

" + } + } + }, + "AddTagsToResourceResult":{ + "type":"structure", + "members":{ + } + }, + "AddedDateTime":{"type":"timestamp"}, + "AliasName":{ + "type":"string", + "max":62, + "min":1, + "pattern":"^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*" + }, + "Attribute":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + }, + "Value":{ + "shape":"AttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Represents a named directory attribute.

" + }, + "AttributeName":{ + "type":"string", + "min":1 + }, + "AttributeValue":{"type":"string"}, + "Attributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "AuthenticationFailedException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ExceptionMessage", + "documentation":"

The textual message for the exception.

" + }, + "RequestId":{ + "shape":"RequestId", + "documentation":"

The identifier of the request that caused the exception.

" + } + }, + "documentation":"

An authentication error occurred.

", + "exception":true + }, + "AvailabilityZone":{"type":"string"}, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZone"} + }, + "CancelSchemaExtensionRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "SchemaExtensionId" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory whose schema extension will be canceled.

" + }, + "SchemaExtensionId":{ + "shape":"SchemaExtensionId", + "documentation":"

The identifier of the schema extension that will be canceled.

" + } + } + }, + "CancelSchemaExtensionResult":{ + "type":"structure", + "members":{ + } + }, + "CidrIp":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/([1-9]|[1-2][0-9]|3[0-2]))$" + }, + "CidrIps":{ + "type":"list", + "member":{"shape":"CidrIp"} + }, + "ClientException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

A client exception has occurred.

", + "exception":true + }, + "CloudOnlyDirectoriesLimitReached":{"type":"boolean"}, + "Computer":{ + "type":"structure", + "members":{ + "ComputerId":{ + "shape":"SID", + "documentation":"

The identifier of the computer.

" + }, + "ComputerName":{ + "shape":"ComputerName", + "documentation":"

The computer name.

" + }, + "ComputerAttributes":{ + "shape":"Attributes", + "documentation":"

An array of Attribute objects containing the LDAP attributes that belong to the computer account.

" + } + }, + "documentation":"

Contains information about a computer account in a directory.

" + }, + "ComputerName":{ + "type":"string", + "max":15, + "min":1 + }, + "ComputerPassword":{ + "type":"string", + "max":64, + "min":8, + "pattern":"[\\u0020-\\u00FF]+", + "sensitive":true + }, + "ConditionalForwarder":{ + "type":"structure", + "members":{ + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

" + }, + "DnsIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.

" + }, + "ReplicationScope":{ + "shape":"ReplicationScope", + "documentation":"

The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.

" + } + }, + "documentation":"

Points to a remote domain with which you are setting up a trust relationship. Conditional forwarders are required in order to set up a trust relationship with another domain.

" + }, + "ConditionalForwarders":{ + "type":"list", + "member":{"shape":"ConditionalForwarder"} + }, + "ConnectDirectoryRequest":{ + "type":"structure", + "required":[ + "Name", + "Password", + "Size", + "ConnectSettings" + ], + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name of the on-premises directory, such as corp.example.com.

" + }, + "ShortName":{ + "shape":"DirectoryShortName", + "documentation":"

The NetBIOS name of the on-premises directory, such as CORP.

" + }, + "Password":{ + "shape":"ConnectPassword", + "documentation":"

The password for the on-premises user account.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A textual description for the directory.

" + }, + "Size":{ + "shape":"DirectorySize", + "documentation":"

The size of the directory.

" + }, + "ConnectSettings":{ + "shape":"DirectoryConnectSettings", + "documentation":"

A DirectoryConnectSettings object that contains additional information for the operation.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to be assigned to AD Connector.

" + } + }, + "documentation":"

Contains the inputs for the ConnectDirectory operation.

" + }, + "ConnectDirectoryResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the new directory.

" + } + }, + "documentation":"

Contains the results of the ConnectDirectory operation.

" + }, + "ConnectPassword":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "ConnectedDirectoriesLimitReached":{"type":"boolean"}, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "Alias" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to create the alias.

" + }, + "Alias":{ + "shape":"AliasName", + "documentation":"

The requested alias.

The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

" + } + }, + "documentation":"

Contains the inputs for the CreateAlias operation.

" + }, + "CreateAliasResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory.

" + }, + "Alias":{ + "shape":"AliasName", + "documentation":"

The alias for the directory.

" + } + }, + "documentation":"

Contains the results of the CreateAlias operation.

" + }, + "CreateComputerRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "ComputerName", + "Password" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory in which to create the computer account.

" + }, + "ComputerName":{ + "shape":"ComputerName", + "documentation":"

The name of the computer account.

" + }, + "Password":{ + "shape":"ComputerPassword", + "documentation":"

A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.

" + }, + "OrganizationalUnitDistinguishedName":{ + "shape":"OrganizationalUnitDN", + "documentation":"

The fully-qualified distinguished name of the organizational unit to place the computer account in.

" + }, + "ComputerAttributes":{ + "shape":"Attributes", + "documentation":"

An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

" + } + }, + "documentation":"

Contains the inputs for the CreateComputer operation.

" + }, + "CreateComputerResult":{ + "type":"structure", + "members":{ + "Computer":{ + "shape":"Computer", + "documentation":"

A Computer object that represents the computer account.

" + } + }, + "documentation":"

Contains the results for the CreateComputer operation.

" + }, + "CreateConditionalForwarderRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RemoteDomainName", + "DnsIpAddrs" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory ID of the AWS directory for which you are creating the conditional forwarder.

" + }, + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

" + }, + "DnsIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName.

" + } + }, + "documentation":"

Initiates the creation of a conditional forwarder for your AWS Directory Service for Microsoft Active Directory. Conditional forwarders are required in order to set up a trust relationship with another domain.

" + }, + "CreateConditionalForwarderResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a CreateConditinalForwarder request.

" + }, + "CreateDirectoryRequest":{ + "type":"structure", + "required":[ + "Name", + "Password", + "Size" + ], + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name for the directory, such as corp.example.com.

" + }, + "ShortName":{ + "shape":"DirectoryShortName", + "documentation":"

The short name of the directory, such as CORP.

" + }, + "Password":{ + "shape":"Password", + "documentation":"

The password for the directory administrator. The directory creation process creates a directory administrator account with the user name Administrator and this password.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A textual description for the directory.

" + }, + "Size":{ + "shape":"DirectorySize", + "documentation":"

The size of the directory.

" + }, + "VpcSettings":{ + "shape":"DirectoryVpcSettings", + "documentation":"

A DirectoryVpcSettings object that contains additional information for the operation.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to be assigned to the Simple AD directory.

" + } + }, + "documentation":"

Contains the inputs for the CreateDirectory operation.

" + }, + "CreateDirectoryResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory that was created.

" + } + }, + "documentation":"

Contains the results of the CreateDirectory operation.

" + }, + "CreateLogSubscriptionRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "LogGroupName" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory to which you want to subscribe and receive real-time logs to your specified CloudWatch log group.

" + }, + "LogGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the CloudWatch log group where the real-time domain controller logs are forwarded.

" + } + } + }, + "CreateLogSubscriptionResult":{ + "type":"structure", + "members":{ + } + }, + "CreateMicrosoftADRequest":{ + "type":"structure", + "required":[ + "Name", + "Password", + "VpcSettings" + ], + "members":{ + "Name":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified domain name for the directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.

" + }, + "ShortName":{ + "shape":"DirectoryShortName", + "documentation":"

The NetBIOS name for your domain. A short identifier for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.

" + }, + "Password":{ + "shape":"Password", + "documentation":"

The password for the default administrative user named Admin.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.

" + }, + "VpcSettings":{ + "shape":"DirectoryVpcSettings", + "documentation":"

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

" + }, + "Edition":{ + "shape":"DirectoryEdition", + "documentation":"

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to be assigned to the AWS Managed Microsoft AD directory.

" + } + }, + "documentation":"

Creates an AWS Managed Microsoft AD directory.

" + }, + "CreateMicrosoftADResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory that was created.

" + } + }, + "documentation":"

Result of a CreateMicrosoftAD request.

" + }, + "CreateSnapshotBeforeSchemaExtension":{"type":"boolean"}, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory of which to take a snapshot.

" + }, + "Name":{ + "shape":"SnapshotName", + "documentation":"

The descriptive name to apply to the snapshot.

" + } + }, + "documentation":"

Contains the inputs for the CreateSnapshot operation.

" + }, + "CreateSnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The identifier of the snapshot that was created.

" + } + }, + "documentation":"

Contains the results of the CreateSnapshot operation.

" + }, + "CreateTrustRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RemoteDomainName", + "TrustPassword", + "TrustDirection" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID of the AWS Managed Microsoft AD directory for which to establish the trust relationship.

" + }, + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.

" + }, + "TrustPassword":{ + "shape":"TrustPassword", + "documentation":"

The trust password. The must be the same password that was used when creating the trust relationship on the external domain.

" + }, + "TrustDirection":{ + "shape":"TrustDirection", + "documentation":"

The direction of the trust relationship.

" + }, + "TrustType":{ + "shape":"TrustType", + "documentation":"

The trust relationship type. Forest is the default.

" + }, + "ConditionalForwarderIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

The IP addresses of the remote DNS server associated with RemoteDomainName.

" + }, + "SelectiveAuth":{ + "shape":"SelectiveAuth", + "documentation":"

Optional parameter to enable selective authentication for the trust.

" + } + }, + "documentation":"

AWS Directory Service for Microsoft Active Directory allows you to configure trust relationships. For example, you can establish a trust between your AWS Managed Microsoft AD directory, and your existing on-premises Microsoft Active Directory. This would allow you to provide users and groups access to resources in either domain, with a single set of credentials.

This action initiates the creation of the AWS side of a trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + }, + "CreateTrustResult":{ + "type":"structure", + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

A unique identifier for the trust relationship that was created.

" + } + }, + "documentation":"

The result of a CreateTrust request.

" + }, + "CreatedDateTime":{"type":"timestamp"}, + "CustomerId":{ + "type":"string", + "pattern":"^(\\d{12})$" + }, + "CustomerUserName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^(?!.*\\\\|.*\"|.*\\/|.*\\[|.*\\]|.*:|.*;|.*\\||.*=|.*,|.*\\+|.*\\*|.*\\?|.*<|.*>|.*@).*$" + }, + "DeleteAssociatedConditionalForwarder":{"type":"boolean"}, + "DeleteConditionalForwarderRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RemoteDomainName" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory ID for which you are deleting the conditional forwarder.

" + }, + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.

" + } + }, + "documentation":"

Deletes a conditional forwarder.

" + }, + "DeleteConditionalForwarderResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a DeleteConditionalForwarder request.

" + }, + "DeleteDirectoryRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory to delete.

" + } + }, + "documentation":"

Contains the inputs for the DeleteDirectory operation.

" + }, + "DeleteDirectoryResult":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory identifier.

" + } + }, + "documentation":"

Contains the results of the DeleteDirectory operation.

" + }, + "DeleteLogSubscriptionRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory whose log subscription you want to delete.

" + } + } + }, + "DeleteLogSubscriptionResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The identifier of the directory snapshot to be deleted.

" + } + }, + "documentation":"

Contains the inputs for the DeleteSnapshot operation.

" + }, + "DeleteSnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The identifier of the directory snapshot that was deleted.

" + } + }, + "documentation":"

Contains the results of the DeleteSnapshot operation.

" + }, + "DeleteTrustRequest":{ + "type":"structure", + "required":["TrustId"], + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

The Trust ID of the trust relationship to be deleted.

" + }, + "DeleteAssociatedConditionalForwarder":{ + "shape":"DeleteAssociatedConditionalForwarder", + "documentation":"

Delete a conditional forwarder as part of a DeleteTrustRequest.

" + } + }, + "documentation":"

Deletes the local side of an existing trust relationship between the AWS Managed Microsoft AD directory and the external domain.

" + }, + "DeleteTrustResult":{ + "type":"structure", + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

The Trust ID of the trust relationship that was deleted.

" + } + }, + "documentation":"

The result of a DeleteTrust request.

" + }, + "DeregisterEventTopicRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "TopicName" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.

" + }, + "TopicName":{ + "shape":"TopicName", + "documentation":"

The name of the SNS topic from which to remove the directory as a publisher.

" + } + }, + "documentation":"

Removes the specified directory as a publisher to the specified SNS topic.

" + }, + "DeregisterEventTopicResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a DeregisterEventTopic request.

" + }, + "DescribeConditionalForwardersRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory ID for which to get the list of associated conditional forwarders.

" + }, + "RemoteDomainNames":{ + "shape":"RemoteDomainNames", + "documentation":"

The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.

" + } + }, + "documentation":"

Describes a conditional forwarder.

" + }, + "DescribeConditionalForwardersResult":{ + "type":"structure", + "members":{ + "ConditionalForwarders":{ + "shape":"ConditionalForwarders", + "documentation":"

The list of conditional forwarders that have been created.

" + } + }, + "documentation":"

The result of a DescribeConditionalForwarder request.

" + }, + "DescribeDirectoriesRequest":{ + "type":"structure", + "members":{ + "DirectoryIds":{ + "shape":"DirectoryIds", + "documentation":"

A list of identifiers of the directories for which to obtain the information. If this member is null, all directories that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" + } + }, + "documentation":"

Contains the inputs for the DescribeDirectories operation.

" + }, + "DescribeDirectoriesResult":{ + "type":"structure", + "members":{ + "DirectoryDescriptions":{ + "shape":"DirectoryDescriptions", + "documentation":"

The list of DirectoryDescription objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDirectories to retrieve the next set of items.

" + } + }, + "documentation":"

Contains the results of the DescribeDirectories operation.

" + }, + "DescribeDomainControllersRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory for which to retrieve the domain controller information.

" + }, + "DomainControllerIds":{ + "shape":"DomainControllerIds", + "documentation":"

A list of identifiers for the domain controllers whose information will be provided.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The DescribeDomainControllers.NextToken value from a previous call to DescribeDomainControllers. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of items to return.

" + } + } + }, + "DescribeDomainControllersResult":{ + "type":"structure", + "members":{ + "DomainControllers":{ + "shape":"DomainControllers", + "documentation":"

List of the DomainController objects that were retrieved.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeDomainControllers retrieve the next set of items.

" + } + } + }, + "DescribeEventTopicsRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.

" + }, + "TopicNames":{ + "shape":"TopicNames", + "documentation":"

A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.

An empty list results in an InvalidParameterException being thrown.

" + } + }, + "documentation":"

Describes event topics.

" + }, + "DescribeEventTopicsResult":{ + "type":"structure", + "members":{ + "EventTopics":{ + "shape":"EventTopics", + "documentation":"

A list of SNS topic names that receive status messages from the specified Directory ID.

" + } + }, + "documentation":"

The result of a DescribeEventTopic request.

" + }, + "DescribeSharedDirectoriesRequest":{ + "type":"structure", + "required":["OwnerDirectoryId"], + "members":{ + "OwnerDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Returns the identifier of the directory in the directory owner account.

" + }, + "SharedDirectoryIds":{ + "shape":"DirectoryIds", + "documentation":"

A list of identifiers of all shared directories in your account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The DescribeSharedDirectoriesResult.NextToken value from a previous call to DescribeSharedDirectories. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The number of shared directories to return in the response object.

" + } + } + }, + "DescribeSharedDirectoriesResult":{ + "type":"structure", + "members":{ + "SharedDirectories":{ + "shape":"SharedDirectories", + "documentation":"

A list of all shared directories in your account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSharedDirectories to retrieve the next set of items.

" + } + } + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to retrieve snapshot information.

" + }, + "SnapshotIds":{ + "shape":"SnapshotIds", + "documentation":"

A list of identifiers of the snapshots to obtain the information for. If this member is null or empty, all snapshots are returned using the Limit and NextToken members.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of objects to return.

" + } + }, + "documentation":"

Contains the inputs for the DescribeSnapshots operation.

" + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"Snapshots", + "documentation":"

The list of Snapshot objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

" + } + }, + "documentation":"

Contains the results of the DescribeSnapshots operation.

" + }, + "DescribeTrustsRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID of the AWS directory that is a part of the requested trust relationship.

" + }, + "TrustIds":{ + "shape":"TrustIds", + "documentation":"

A list of identifiers of the trust relationships for which to obtain the information. If this member is null, all trust relationships that belong to the current account are returned.

An empty list results in an InvalidParameterException being thrown.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of objects to return.

" + } + }, + "documentation":"

Describes the trust relationships for a particular AWS Managed Microsoft AD directory. If no input parameters are are provided, such as directory ID or trust ID, this request describes all the trust relationships.

" + }, + "DescribeTrustsResult":{ + "type":"structure", + "members":{ + "Trusts":{ + "shape":"Trusts", + "documentation":"

The list of Trust objects that were retrieved.

It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeTrusts to retrieve the next set of items.

" + } + }, + "documentation":"

The result of a DescribeTrust request.

" + }, + "Description":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + }, + "DesiredNumberOfDomainControllers":{ + "type":"integer", + "min":2 + }, + "DirectoryAlreadySharedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified directory has already been shared with this AWS account.

", + "exception":true + }, + "DirectoryConnectSettings":{ + "type":"structure", + "required":[ + "VpcId", + "SubnetIds", + "CustomerDnsIps", + "CustomerUserName" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC in which the AD Connector is created.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of subnet identifiers in the VPC in which the AD Connector is created.

" + }, + "CustomerDnsIps":{ + "shape":"DnsIpAddrs", + "documentation":"

A list of one or more IP addresses of DNS servers or domain controllers in the on-premises directory.

" + }, + "CustomerUserName":{ + "shape":"UserName", + "documentation":"

The user name of an account in the on-premises directory that is used to connect to the directory. This account must have the following permissions:

  • Read users and groups

  • Create computer objects

  • Join computers to the domain

" + } + }, + "documentation":"

Contains information for the ConnectDirectory operation when an AD Connector directory is being created.

" + }, + "DirectoryConnectSettingsDescription":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC that the AD Connector is in.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of subnet identifiers in the VPC that the AD connector is in.

" + }, + "CustomerUserName":{ + "shape":"UserName", + "documentation":"

The user name of the service account in the on-premises directory.

" + }, + "SecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"

The security group identifier for the AD Connector directory.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of the Availability Zones that the directory is in.

" + }, + "ConnectIps":{ + "shape":"IpAddrs", + "documentation":"

The IP addresses of the AD Connector servers.

" + } + }, + "documentation":"

Contains information about an AD Connector directory.

" + }, + "DirectoryDescription":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory identifier.

" + }, + "Name":{ + "shape":"DirectoryName", + "documentation":"

The fully qualified name of the directory.

" + }, + "ShortName":{ + "shape":"DirectoryShortName", + "documentation":"

The short name of the directory.

" + }, + "Size":{ + "shape":"DirectorySize", + "documentation":"

The directory size.

" + }, + "Edition":{ + "shape":"DirectoryEdition", + "documentation":"

The edition associated with this directory.

" + }, + "Alias":{ + "shape":"AliasName", + "documentation":"

The alias for the directory. If no alias has been created for the directory, the alias is the directory identifier, such as d-XXXXXXXXXX.

" + }, + "AccessUrl":{ + "shape":"AccessUrl", + "documentation":"

The access URL for the directory, such as http://<alias>.awsapps.com. If no alias has been created for the directory, <alias> is the directory identifier, such as d-XXXXXXXXXX.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The textual description for the directory.

" + }, + "DnsIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

The IP addresses of the DNS servers for the directory. For a Simple AD or Microsoft AD directory, these are the IP addresses of the Simple AD or Microsoft AD directory servers. For an AD Connector directory, these are the IP addresses of the DNS servers or domain controllers in the on-premises directory to which the AD Connector is connected.

" + }, + "Stage":{ + "shape":"DirectoryStage", + "documentation":"

The current stage of the directory.

" + }, + "ShareStatus":{ + "shape":"ShareStatus", + "documentation":"

Current directory status of the shared AWS Managed Microsoft AD directory.

" + }, + "ShareMethod":{ + "shape":"ShareMethod", + "documentation":"

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).

" + }, + "ShareNotes":{ + "shape":"Notes", + "documentation":"

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

" + }, + "LaunchTime":{ + "shape":"LaunchTime", + "documentation":"

Specifies when the directory was created.

" + }, + "StageLastUpdatedDateTime":{ + "shape":"LastUpdatedDateTime", + "documentation":"

The date and time that the stage was last updated.

" + }, + "Type":{ + "shape":"DirectoryType", + "documentation":"

The directory size.

" + }, + "VpcSettings":{ + "shape":"DirectoryVpcSettingsDescription", + "documentation":"

A DirectoryVpcSettingsDescription object that contains additional information about a directory. This member is only present if the directory is a Simple AD or Managed AD directory.

" + }, + "ConnectSettings":{ + "shape":"DirectoryConnectSettingsDescription", + "documentation":"

A DirectoryConnectSettingsDescription object that contains additional information about an AD Connector directory. This member is only present if the directory is an AD Connector directory.

" + }, + "RadiusSettings":{ + "shape":"RadiusSettings", + "documentation":"

A RadiusSettings object that contains information about the RADIUS server configured for this directory.

" + }, + "RadiusStatus":{ + "shape":"RadiusStatus", + "documentation":"

The status of the RADIUS MFA server connection.

" + }, + "StageReason":{ + "shape":"StageReason", + "documentation":"

Additional information about the directory stage.

" + }, + "SsoEnabled":{ + "shape":"SsoEnabled", + "documentation":"

Indicates if single sign-on is enabled for the directory. For more information, see EnableSso and DisableSso.

" + }, + "DesiredNumberOfDomainControllers":{ + "shape":"DesiredNumberOfDomainControllers", + "documentation":"

The desired number of domain controllers in the directory if the directory is Microsoft AD.

" + }, + "OwnerDirectoryDescription":{ + "shape":"OwnerDirectoryDescription", + "documentation":"

Describes the AWS Managed Microsoft AD directory in the directory owner account.

" + } + }, + "documentation":"

Contains information about an AWS Directory Service directory.

" + }, + "DirectoryDescriptions":{ + "type":"list", + "member":{"shape":"DirectoryDescription"}, + "documentation":"

A list of directory descriptions.

" + }, + "DirectoryEdition":{ + "type":"string", + "enum":[ + "Enterprise", + "Standard" + ] + }, + "DirectoryId":{ + "type":"string", + "pattern":"^d-[0-9a-f]{10}$" + }, + "DirectoryIds":{ + "type":"list", + "member":{"shape":"DirectoryId"}, + "documentation":"

A list of directory identifiers.

" + }, + "DirectoryLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum number of directories in the region has been reached. You can use the GetDirectoryLimits operation to determine your directory limits in the region.

", + "exception":true + }, + "DirectoryLimits":{ + "type":"structure", + "members":{ + "CloudOnlyDirectoriesLimit":{ + "shape":"Limit", + "documentation":"

The maximum number of cloud directories allowed in the region.

" + }, + "CloudOnlyDirectoriesCurrentCount":{ + "shape":"Limit", + "documentation":"

The current number of cloud directories in the region.

" + }, + "CloudOnlyDirectoriesLimitReached":{ + "shape":"CloudOnlyDirectoriesLimitReached", + "documentation":"

Indicates if the cloud directory limit has been reached.

" + }, + "CloudOnlyMicrosoftADLimit":{ + "shape":"Limit", + "documentation":"

The maximum number of AWS Managed Microsoft AD directories allowed in the region.

" + }, + "CloudOnlyMicrosoftADCurrentCount":{ + "shape":"Limit", + "documentation":"

The current number of AWS Managed Microsoft AD directories in the region.

" + }, + "CloudOnlyMicrosoftADLimitReached":{ + "shape":"CloudOnlyDirectoriesLimitReached", + "documentation":"

Indicates if the AWS Managed Microsoft AD directory limit has been reached.

" + }, + "ConnectedDirectoriesLimit":{ + "shape":"Limit", + "documentation":"

The maximum number of connected directories allowed in the region.

" + }, + "ConnectedDirectoriesCurrentCount":{ + "shape":"Limit", + "documentation":"

The current number of connected directories in the region.

" + }, + "ConnectedDirectoriesLimitReached":{ + "shape":"ConnectedDirectoriesLimitReached", + "documentation":"

Indicates if the connected directory limit has been reached.

" + } + }, + "documentation":"

Contains directory limit information for a region.

" + }, + "DirectoryName":{ + "type":"string", + "pattern":"^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" + }, + "DirectoryNotSharedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified directory has not been shared with this AWS account.

", + "exception":true + }, + "DirectoryShortName":{ + "type":"string", + "pattern":"^[^\\\\/:*?\\\"\\<\\>|.]+[^\\\\/:*?\\\"<>|]*$" + }, + "DirectorySize":{ + "type":"string", + "enum":[ + "Small", + "Large" + ] + }, + "DirectoryStage":{ + "type":"string", + "enum":[ + "Requested", + "Creating", + "Created", + "Active", + "Inoperable", + "Impaired", + "Restoring", + "RestoreFailed", + "Deleting", + "Deleted", + "Failed" + ] + }, + "DirectoryType":{ + "type":"string", + "enum":[ + "SimpleAD", + "ADConnector", + "MicrosoftAD", + "SharedMicrosoftAD" + ] + }, + "DirectoryUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified directory is unavailable or could not be found.

", + "exception":true + }, + "DirectoryVpcSettings":{ + "type":"structure", + "required":[ + "VpcId", + "SubnetIds" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC in which to create the directory.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service creates a directory server and a DNS server in each of these subnets.

" + } + }, + "documentation":"

Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.

" + }, + "DirectoryVpcSettingsDescription":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC that the directory is in.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The identifiers of the subnets for the directory servers.

" + }, + "SecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"

The domain controller security group identifier for the directory.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The list of Availability Zones that the directory is in.

" + } + }, + "documentation":"

Contains information about the directory.

" + }, + "DisableRadiusRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to disable MFA.

" + } + }, + "documentation":"

Contains the inputs for the DisableRadius operation.

" + }, + "DisableRadiusResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the DisableRadius operation.

" + }, + "DisableSsoRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to disable single-sign on.

" + }, + "UserName":{ + "shape":"UserName", + "documentation":"

The username of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. This account must have privileges to remove a service principal name.

If the AD Connector service account does not have privileges to remove a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to disable single sign-on and are not stored by the service. The AD Connector service account is not changed.

" + }, + "Password":{ + "shape":"ConnectPassword", + "documentation":"

The password of an alternate account to use to disable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

" + } + }, + "documentation":"

Contains the inputs for the DisableSso operation.

" + }, + "DisableSsoResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the DisableSso operation.

" + }, + "DnsIpAddrs":{ + "type":"list", + "member":{"shape":"IpAddr"} + }, + "DomainController":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory where the domain controller resides.

" + }, + "DomainControllerId":{ + "shape":"DomainControllerId", + "documentation":"

Identifies a specific domain controller in the directory.

" + }, + "DnsIpAddr":{ + "shape":"IpAddr", + "documentation":"

The IP address of the domain controller.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the VPC that contains the domain controller.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

Identifier of the subnet in the VPC that contains the domain controller.

" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone where the domain controller is located.

" + }, + "Status":{ + "shape":"DomainControllerStatus", + "documentation":"

The status of the domain controller.

" + }, + "StatusReason":{ + "shape":"DomainControllerStatusReason", + "documentation":"

A description of the domain controller state.

" + }, + "LaunchTime":{ + "shape":"LaunchTime", + "documentation":"

Specifies when the domain controller was created.

" + }, + "StatusLastUpdatedDateTime":{ + "shape":"LastUpdatedDateTime", + "documentation":"

The date and time that the status was last updated.

" + } + }, + "documentation":"

Contains information about the domain controllers for a specified directory.

" + }, + "DomainControllerId":{ + "type":"string", + "pattern":"^dc-[0-9a-f]{10}$" + }, + "DomainControllerIds":{ + "type":"list", + "member":{"shape":"DomainControllerId"} + }, + "DomainControllerLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum allowed number of domain controllers per directory was exceeded. The default limit per directory is 20 domain controllers.

", + "exception":true + }, + "DomainControllerStatus":{ + "type":"string", + "enum":[ + "Creating", + "Active", + "Impaired", + "Restoring", + "Deleting", + "Deleted", + "Failed" + ] + }, + "DomainControllerStatusReason":{"type":"string"}, + "DomainControllers":{ + "type":"list", + "member":{"shape":"DomainController"} + }, + "EnableRadiusRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RadiusSettings" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to enable MFA.

" + }, + "RadiusSettings":{ + "shape":"RadiusSettings", + "documentation":"

A RadiusSettings object that contains information about the RADIUS server.

" + } + }, + "documentation":"

Contains the inputs for the EnableRadius operation.

" + }, + "EnableRadiusResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the EnableRadius operation.

" + }, + "EnableSsoRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to enable single-sign on.

" + }, + "UserName":{ + "shape":"UserName", + "documentation":"

The username of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. This account must have privileges to add a service principal name.

If the AD Connector service account does not have privileges to add a service principal name, you can specify an alternate account with the UserName and Password parameters. These credentials are only used to enable single sign-on and are not stored by the service. The AD Connector service account is not changed.

" + }, + "Password":{ + "shape":"ConnectPassword", + "documentation":"

The password of an alternate account to use to enable single-sign on. This is only used for AD Connector directories. For more information, see the UserName parameter.

" + } + }, + "documentation":"

Contains the inputs for the EnableSso operation.

" + }, + "EnableSsoResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the EnableSso operation.

" + }, + "EndDateTime":{"type":"timestamp"}, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified entity already exists.

", + "exception":true + }, + "EntityDoesNotExistException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified entity could not be found.

", + "exception":true + }, + "EventTopic":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

" + }, + "TopicName":{ + "shape":"TopicName", + "documentation":"

The name of an AWS SNS topic the receives status messages from the directory.

" + }, + "TopicArn":{ + "shape":"TopicArn", + "documentation":"

The SNS topic ARN (Amazon Resource Name).

" + }, + "CreatedDateTime":{ + "shape":"CreatedDateTime", + "documentation":"

The date and time of when you associated your directory with the SNS topic.

" + }, + "Status":{ + "shape":"TopicStatus", + "documentation":"

The topic registration status.

" + } + }, + "documentation":"

Information about SNS topic and AWS Directory Service directory associations.

" + }, + "EventTopics":{ + "type":"list", + "member":{"shape":"EventTopic"} + }, + "ExceptionMessage":{ + "type":"string", + "documentation":"

The descriptive message for the exception.

" + }, + "GetDirectoryLimitsRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the inputs for the GetDirectoryLimits operation.

" + }, + "GetDirectoryLimitsResult":{ + "type":"structure", + "members":{ + "DirectoryLimits":{ + "shape":"DirectoryLimits", + "documentation":"

A DirectoryLimits object that contains the directory limits for the current region.

" + } + }, + "documentation":"

Contains the results of the GetDirectoryLimits operation.

" + }, + "GetSnapshotLimitsRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Contains the identifier of the directory to obtain the limits for.

" + } + }, + "documentation":"

Contains the inputs for the GetSnapshotLimits operation.

" + }, + "GetSnapshotLimitsResult":{ + "type":"structure", + "members":{ + "SnapshotLimits":{ + "shape":"SnapshotLimits", + "documentation":"

A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

" + } + }, + "documentation":"

Contains the results of the GetSnapshotLimits operation.

" + }, + "InsufficientPermissionsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The account does not have sufficient permission to perform the operation.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The NextToken value is not valid.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

One or more parameters are not valid.

", + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The new password provided by the user does not meet the password complexity requirements defined in your directory.

", + "exception":true + }, + "InvalidTargetException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The specified shared target is not valid.

", + "exception":true + }, + "IpAddr":{ + "type":"string", + "pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$" + }, + "IpAddrs":{ + "type":"list", + "member":{"shape":"IpAddr"} + }, + "IpRoute":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"CidrIp", + "documentation":"

IP address block using CIDR format, for example 10.0.0.0/24. This is often the address block of the DNS server used for your on-premises domain. For a single IP address use a CIDR address block with /32. For example 10.0.0.0/32.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Description of the address block.

" + } + }, + "documentation":"

IP address block. This is often the address block of the DNS server used for your on-premises domain.

" + }, + "IpRouteInfo":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory associated with the IP addresses.

" + }, + "CidrIp":{ + "shape":"CidrIp", + "documentation":"

IP address block in the IpRoute.

" + }, + "IpRouteStatusMsg":{ + "shape":"IpRouteStatusMsg", + "documentation":"

The status of the IP address block.

" + }, + "AddedDateTime":{ + "shape":"AddedDateTime", + "documentation":"

The date and time the address block was added to the directory.

" + }, + "IpRouteStatusReason":{ + "shape":"IpRouteStatusReason", + "documentation":"

The reason for the IpRouteStatusMsg.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Description of the IpRouteInfo.

" + } + }, + "documentation":"

Information about one or more IP address blocks.

" + }, + "IpRouteLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum allowed number of IP addresses was exceeded. The default limit is 100 IP address blocks.

", + "exception":true + }, + "IpRouteStatusMsg":{ + "type":"string", + "enum":[ + "Adding", + "Added", + "Removing", + "Removed", + "AddFailed", + "RemoveFailed" + ] + }, + "IpRouteStatusReason":{"type":"string"}, + "IpRoutes":{ + "type":"list", + "member":{"shape":"IpRoute"} + }, + "IpRoutesInfo":{ + "type":"list", + "member":{"shape":"IpRouteInfo"} + }, + "LastUpdatedDateTime":{"type":"timestamp"}, + "LaunchTime":{"type":"timestamp"}, + "LdifContent":{ + "type":"string", + "max":500000, + "min":1 + }, + "Limit":{ + "type":"integer", + "min":0 + }, + "ListIpRoutesRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory for which you want to retrieve the IP addresses.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The ListIpRoutes.NextToken value from a previous call to ListIpRoutes. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

Maximum number of items to return. If this value is zero, the maximum number of items is specified by the limitations of the operation.

" + } + } + }, + "ListIpRoutesResult":{ + "type":"structure", + "members":{ + "IpRoutesInfo":{ + "shape":"IpRoutesInfo", + "documentation":"

A list of IpRoutes.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListIpRoutes to retrieve the next set of items.

" + } + } + }, + "ListLogSubscriptionsRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

If a DirectoryID is provided, lists only the log subscription associated with that directory. If no DirectoryId is provided, lists all log subscriptions associated with your AWS account. If there are no log subscriptions for the AWS account or the directory, an empty list will be returned.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of items returned.

" + } + } + }, + "ListLogSubscriptionsResult":{ + "type":"structure", + "members":{ + "LogSubscriptions":{ + "shape":"LogSubscriptions", + "documentation":"

A list of active LogSubscription objects for calling the AWS account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return.

" + } + } + }, + "ListSchemaExtensionsRequest":{ + "type":"structure", + "required":["DirectoryId"], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory from which to retrieve the schema extension information.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The ListSchemaExtensions.NextToken value from a previous call to ListSchemaExtensions. Pass null if this is the first call.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of items to return.

" + } + } + }, + "ListSchemaExtensionsResult":{ + "type":"structure", + "members":{ + "SchemaExtensionsInfo":{ + "shape":"SchemaExtensionsInfo", + "documentation":"

Information about the schema extensions applied to the directory.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If not null, more results are available. Pass this value for the NextToken parameter in a subsequent call to ListSchemaExtensions to retrieve the next set of items.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

Identifier (ID) of the directory for which you want to retrieve tags.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Reserved for future use.

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

Reserved for future use.

" + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Reserved for future use.

" + } + } + }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[-._/#A-Za-z0-9]+" + }, + "LogSubscription":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory that you want to associate with the log subscription.

" + }, + "LogGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "SubscriptionCreatedDateTime":{ + "shape":"SubscriptionCreatedDateTime", + "documentation":"

The date and time that the log subscription was created.

" + } + }, + "documentation":"

Represents a log subscription, which tracks real-time data from a chosen log group to a specified destination.

" + }, + "LogSubscriptions":{ + "type":"list", + "member":{"shape":"LogSubscription"} + }, + "ManualSnapshotsLimitReached":{"type":"boolean"}, + "NextToken":{"type":"string"}, + "Notes":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "OrganizationalUnitDN":{ + "type":"string", + "max":2000, + "min":1 + }, + "OrganizationsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

Exception encountered while trying to access your AWS organization.

", + "exception":true + }, + "OwnerDirectoryDescription":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the AWS Managed Microsoft AD directory in the directory owner account.

" + }, + "AccountId":{ + "shape":"CustomerId", + "documentation":"

Identifier of the directory owner account.

" + }, + "DnsIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

IP address of the directory’s domain controllers.

" + }, + "VpcSettings":{ + "shape":"DirectoryVpcSettingsDescription", + "documentation":"

Information about the VPC settings for the directory.

" + }, + "RadiusSettings":{ + "shape":"RadiusSettings", + "documentation":"

A RadiusSettings object that contains information about the RADIUS server.

" + }, + "RadiusStatus":{ + "shape":"RadiusStatus", + "documentation":"

Information about the status of the RADIUS server.

" + } + }, + "documentation":"

Describes the directory owner account details that have been shared to the directory consumer account.

" + }, + "Password":{ + "type":"string", + "pattern":"(?=^.{8,64}$)((?=.*\\d)(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[^A-Za-z0-9\\s])(?=.*[a-z])|(?=.*[^A-Za-z0-9\\s])(?=.*[A-Z])(?=.*[a-z])|(?=.*\\d)(?=.*[A-Z])(?=.*[^A-Za-z0-9\\s]))^.*", + "sensitive":true + }, + "PortNumber":{ + "type":"integer", + "max":65535, + "min":1025 + }, + "RadiusAuthenticationProtocol":{ + "type":"string", + "enum":[ + "PAP", + "CHAP", + "MS-CHAPv1", + "MS-CHAPv2" + ] + }, + "RadiusDisplayLabel":{ + "type":"string", + "max":64, + "min":1 + }, + "RadiusRetries":{ + "type":"integer", + "max":10, + "min":0 + }, + "RadiusSettings":{ + "type":"structure", + "members":{ + "RadiusServers":{ + "shape":"Servers", + "documentation":"

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

" + }, + "RadiusPort":{ + "shape":"PortNumber", + "documentation":"

The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS Directory Service servers.

" + }, + "RadiusTimeout":{ + "shape":"RadiusTimeout", + "documentation":"

The amount of time, in seconds, to wait for the RADIUS server to respond.

" + }, + "RadiusRetries":{ + "shape":"RadiusRetries", + "documentation":"

The maximum number of times that communication with the RADIUS server is attempted.

" + }, + "SharedSecret":{ + "shape":"RadiusSharedSecret", + "documentation":"

Required for enabling RADIUS on the directory.

" + }, + "AuthenticationProtocol":{ + "shape":"RadiusAuthenticationProtocol", + "documentation":"

The protocol specified for your RADIUS endpoints.

" + }, + "DisplayLabel":{ + "shape":"RadiusDisplayLabel", + "documentation":"

Not currently used.

" + }, + "UseSameUsername":{ + "shape":"UseSameUsername", + "documentation":"

Not currently used.

" + } + }, + "documentation":"

Contains information about a Remote Authentication Dial In User Service (RADIUS) server.

" + }, + "RadiusSharedSecret":{ + "type":"string", + "max":512, + "min":8, + "sensitive":true + }, + "RadiusStatus":{ + "type":"string", + "enum":[ + "Creating", + "Completed", + "Failed" + ] + }, + "RadiusTimeout":{ + "type":"integer", + "max":20, + "min":1 + }, + "RegisterEventTopicRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "TopicName" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID that will publish status messages to the SNS topic.

" + }, + "TopicName":{ + "shape":"TopicName", + "documentation":"

The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.

" + } + }, + "documentation":"

Registers a new event topic.

" + }, + "RegisterEventTopicResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of a RegisterEventTopic request.

" + }, + "RejectSharedDirectoryRequest":{ + "type":"structure", + "required":["SharedDirectoryId"], + "members":{ + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

" + } + } + }, + "RejectSharedDirectoryResult":{ + "type":"structure", + "members":{ + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the shared directory in the directory consumer account.

" + } + } + }, + "RemoteDomainName":{ + "type":"string", + "pattern":"^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+[.]?$" + }, + "RemoteDomainNames":{ + "type":"list", + "member":{"shape":"RemoteDomainName"} + }, + "RemoveIpRoutesRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "CidrIps" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier (ID) of the directory from which you want to remove the IP addresses.

" + }, + "CidrIps":{ + "shape":"CidrIps", + "documentation":"

IP address blocks that you want to remove.

" + } + } + }, + "RemoveIpRoutesResult":{ + "type":"structure", + "members":{ + } + }, + "RemoveTagsFromResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

Identifier (ID) of the directory from which to remove the tag.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + } + }, + "RemoveTagsFromResourceResult":{ + "type":"structure", + "members":{ + } + }, + "ReplicationScope":{ + "type":"string", + "enum":["Domain"] + }, + "RequestId":{ + "type":"string", + "documentation":"

The AWS request identifier.

", + "pattern":"^([A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12})$" + }, + "ResetUserPasswordRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "UserName", + "NewPassword" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the AWS Managed Microsoft AD or Simple AD directory in which the user resides.

" + }, + "UserName":{ + "shape":"CustomerUserName", + "documentation":"

The user name of the user whose password will be reset.

" + }, + "NewPassword":{ + "shape":"UserPassword", + "documentation":"

The new password that will be reset.

" + } + } + }, + "ResetUserPasswordResult":{ + "type":"structure", + "members":{ + } + }, + "ResourceId":{ + "type":"string", + "pattern":"^[d]-[0-9a-f]{10}$" + }, + "RestoreFromSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The identifier of the snapshot to restore from.

" + } + }, + "documentation":"

An object representing the inputs for the RestoreFromSnapshot operation.

" + }, + "RestoreFromSnapshotResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the RestoreFromSnapshot operation.

" + }, + "SID":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[&\\w+-.@]+" + }, + "SchemaExtensionId":{ + "type":"string", + "pattern":"^e-[0-9a-f]{10}$" + }, + "SchemaExtensionInfo":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory to which the schema extension is applied.

" + }, + "SchemaExtensionId":{ + "shape":"SchemaExtensionId", + "documentation":"

The identifier of the schema extension.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the schema extension.

" + }, + "SchemaExtensionStatus":{ + "shape":"SchemaExtensionStatus", + "documentation":"

The current status of the schema extension.

" + }, + "SchemaExtensionStatusReason":{ + "shape":"SchemaExtensionStatusReason", + "documentation":"

The reason for the SchemaExtensionStatus.

" + }, + "StartDateTime":{ + "shape":"StartDateTime", + "documentation":"

The date and time that the schema extension started being applied to the directory.

" + }, + "EndDateTime":{ + "shape":"EndDateTime", + "documentation":"

The date and time that the schema extension was completed.

" + } + }, + "documentation":"

Information about a schema extension.

" + }, + "SchemaExtensionStatus":{ + "type":"string", + "enum":[ + "Initializing", + "CreatingSnapshot", + "UpdatingSchema", + "Replicating", + "CancelInProgress", + "RollbackInProgress", + "Cancelled", + "Failed", + "Completed" + ] + }, + "SchemaExtensionStatusReason":{"type":"string"}, + "SchemaExtensionsInfo":{ + "type":"list", + "member":{"shape":"SchemaExtensionInfo"} + }, + "SecurityGroupId":{ + "type":"string", + "pattern":"^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$" + }, + "SelectiveAuth":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Server":{ + "type":"string", + "max":256, + "min":1 + }, + "Servers":{ + "type":"list", + "member":{"shape":"Server"} + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

An exception has occurred in AWS Directory Service.

", + "exception":true, + "fault":true + }, + "ShareDirectoryRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "ShareTarget", + "ShareMethod" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the AWS Managed Microsoft AD directory that you want to share with other AWS accounts.

" + }, + "ShareNotes":{ + "shape":"Notes", + "documentation":"

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

" + }, + "ShareTarget":{ + "shape":"ShareTarget", + "documentation":"

Identifier for the directory consumer account with whom the directory is to be shared.

" + }, + "ShareMethod":{ + "shape":"ShareMethod", + "documentation":"

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a directory sharing request (HANDSHAKE).

" + } + } + }, + "ShareDirectoryResult":{ + "type":"structure", + "members":{ + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory that is stored in the directory consumer account that is shared from the specified directory (DirectoryId).

" + } + } + }, + "ShareLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum number of AWS accounts that you can share with this directory has been reached.

", + "exception":true + }, + "ShareMethod":{ + "type":"string", + "enum":[ + "ORGANIZATIONS", + "HANDSHAKE" + ] + }, + "ShareStatus":{ + "type":"string", + "enum":[ + "Shared", + "PendingAcceptance", + "Rejected", + "Rejecting", + "RejectFailed", + "Sharing", + "ShareFailed", + "Deleted", + "Deleting" + ] + }, + "ShareTarget":{ + "type":"structure", + "required":[ + "Id", + "Type" + ], + "members":{ + "Id":{ + "shape":"TargetId", + "documentation":"

Identifier of the directory consumer account.

" + }, + "Type":{ + "shape":"TargetType", + "documentation":"

Type of identifier to be used in the Id field.

" + } + }, + "documentation":"

Identifier that contains details about the directory consumer account.

" + }, + "SharedDirectories":{ + "type":"list", + "member":{"shape":"SharedDirectory"} + }, + "SharedDirectory":{ + "type":"structure", + "members":{ + "OwnerAccountId":{ + "shape":"CustomerId", + "documentation":"

Identifier of the directory owner account, which contains the directory that has been shared to the consumer account.

" + }, + "OwnerDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory in the directory owner account.

" + }, + "ShareMethod":{ + "shape":"ShareMethod", + "documentation":"

The method used when sharing a directory to determine whether the directory should be shared within your AWS organization (ORGANIZATIONS) or with any AWS account by sending a shared directory request (HANDSHAKE).

" + }, + "SharedAccountId":{ + "shape":"CustomerId", + "documentation":"

Identifier of the directory consumer account that has access to the shared directory (OwnerDirectoryId) in the directory owner account.

" + }, + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the shared directory in the directory consumer account. This identifier is different for each directory owner account.

" + }, + "ShareStatus":{ + "shape":"ShareStatus", + "documentation":"

Current directory status of the shared AWS Managed Microsoft AD directory.

" + }, + "ShareNotes":{ + "shape":"Notes", + "documentation":"

A directory share request that is sent by the directory owner to the directory consumer. The request includes a typed message to help the directory consumer administrator determine whether to approve or reject the share invitation.

" + }, + "CreatedDateTime":{ + "shape":"CreatedDateTime", + "documentation":"

The date and time that the shared directory was created.

" + }, + "LastUpdatedDateTime":{ + "shape":"LastUpdatedDateTime", + "documentation":"

The date and time that the shared directory was last updated.

" + } + }, + "documentation":"

Details about the shared directory in the directory owner account for which the share request in the directory consumer account has been accepted.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory identifier.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The snapshot identifier.

" + }, + "Type":{ + "shape":"SnapshotType", + "documentation":"

The snapshot type.

" + }, + "Name":{ + "shape":"SnapshotName", + "documentation":"

The descriptive name of the snapshot.

" + }, + "Status":{ + "shape":"SnapshotStatus", + "documentation":"

The snapshot status.

" + }, + "StartTime":{ + "shape":"StartTime", + "documentation":"

The date and time that the snapshot was taken.

" + } + }, + "documentation":"

Describes a directory snapshot.

" + }, + "SnapshotId":{ + "type":"string", + "pattern":"^s-[0-9a-f]{10}$" + }, + "SnapshotIds":{ + "type":"list", + "member":{"shape":"SnapshotId"}, + "documentation":"

A list of directory snapshot identifiers.

" + }, + "SnapshotLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum number of manual snapshots for the directory has been reached. You can use the GetSnapshotLimits operation to determine the snapshot limits for a directory.

", + "exception":true + }, + "SnapshotLimits":{ + "type":"structure", + "members":{ + "ManualSnapshotsLimit":{ + "shape":"Limit", + "documentation":"

The maximum number of manual snapshots allowed.

" + }, + "ManualSnapshotsCurrentCount":{ + "shape":"Limit", + "documentation":"

The current number of manual snapshots of the directory.

" + }, + "ManualSnapshotsLimitReached":{ + "shape":"ManualSnapshotsLimitReached", + "documentation":"

Indicates if the manual snapshot limit has been reached.

" + } + }, + "documentation":"

Contains manual snapshot limit information for a directory.

" + }, + "SnapshotName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]*$" + }, + "SnapshotStatus":{ + "type":"string", + "enum":[ + "Creating", + "Completed", + "Failed" + ] + }, + "SnapshotType":{ + "type":"string", + "enum":[ + "Auto", + "Manual" + ] + }, + "Snapshots":{ + "type":"list", + "member":{"shape":"Snapshot"}, + "documentation":"

A list of descriptions of directory snapshots.

" + }, + "SsoEnabled":{"type":"boolean"}, + "StageReason":{"type":"string"}, + "StartDateTime":{"type":"timestamp"}, + "StartSchemaExtensionRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "CreateSnapshotBeforeSchemaExtension", + "LdifContent", + "Description" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which the schema extension will be applied to.

" + }, + "CreateSnapshotBeforeSchemaExtension":{ + "shape":"CreateSnapshotBeforeSchemaExtension", + "documentation":"

If true, creates a snapshot of the directory before applying the schema extension.

" + }, + "LdifContent":{ + "shape":"LdifContent", + "documentation":"

The LDIF file represented as a string. To construct the LdifContent string, precede each line as it would be formatted in an ldif file with \\n. See the example request below for more details. The file size can be no larger than 1MB.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the schema extension.

" + } + } + }, + "StartSchemaExtensionResult":{ + "type":"structure", + "members":{ + "SchemaExtensionId":{ + "shape":"SchemaExtensionId", + "documentation":"

The identifier of the schema extension that will be applied.

" + } + } + }, + "StartTime":{"type":"timestamp"}, + "StateLastUpdatedDateTime":{"type":"timestamp"}, + "SubnetId":{ + "type":"string", + "pattern":"^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "SubscriptionCreatedDateTime":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

Required name of the tag. The string value can be Unicode characters and cannot be prefixed with \"aws:\". The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to a directory consisting of a key-value pair.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The maximum allowed number of tags was exceeded.

", + "exception":true + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TargetId":{ + "type":"string", + "max":64, + "min":1 + }, + "TargetType":{ + "type":"string", + "enum":["ACCOUNT"] + }, + "TopicArn":{"type":"string"}, + "TopicName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "TopicNames":{ + "type":"list", + "member":{"shape":"TopicName"} + }, + "TopicStatus":{ + "type":"string", + "enum":[ + "Registered", + "Topic not found", + "Failed", + "Deleted" + ] + }, + "Trust":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The Directory ID of the AWS directory involved in the trust relationship.

" + }, + "TrustId":{ + "shape":"TrustId", + "documentation":"

The unique ID of the trust relationship.

" + }, + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

" + }, + "TrustType":{ + "shape":"TrustType", + "documentation":"

The trust relationship type. Forest is the default.

" + }, + "TrustDirection":{ + "shape":"TrustDirection", + "documentation":"

The trust relationship direction.

" + }, + "TrustState":{ + "shape":"TrustState", + "documentation":"

The trust relationship state.

" + }, + "CreatedDateTime":{ + "shape":"CreatedDateTime", + "documentation":"

The date and time that the trust relationship was created.

" + }, + "LastUpdatedDateTime":{ + "shape":"LastUpdatedDateTime", + "documentation":"

The date and time that the trust relationship was last updated.

" + }, + "StateLastUpdatedDateTime":{ + "shape":"StateLastUpdatedDateTime", + "documentation":"

The date and time that the TrustState was last updated.

" + }, + "TrustStateReason":{ + "shape":"TrustStateReason", + "documentation":"

The reason for the TrustState.

" + }, + "SelectiveAuth":{ + "shape":"SelectiveAuth", + "documentation":"

Current state of selective authentication for the trust.

" + } + }, + "documentation":"

Describes a trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + }, + "TrustDirection":{ + "type":"string", + "enum":[ + "One-Way: Outgoing", + "One-Way: Incoming", + "Two-Way" + ] + }, + "TrustId":{ + "type":"string", + "pattern":"^t-[0-9a-f]{10}$" + }, + "TrustIds":{ + "type":"list", + "member":{"shape":"TrustId"} + }, + "TrustPassword":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(.|\\s)*\\S(.|\\s)*", + "sensitive":true + }, + "TrustState":{ + "type":"string", + "enum":[ + "Creating", + "Created", + "Verifying", + "VerifyFailed", + "Verified", + "Updating", + "UpdateFailed", + "Updated", + "Deleting", + "Deleted", + "Failed" + ] + }, + "TrustStateReason":{"type":"string"}, + "TrustType":{ + "type":"string", + "enum":[ + "Forest", + "External" + ] + }, + "Trusts":{ + "type":"list", + "member":{"shape":"Trust"} + }, + "UnshareDirectoryRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "UnshareTarget" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the AWS Managed Microsoft AD directory that you want to stop sharing.

" + }, + "UnshareTarget":{ + "shape":"UnshareTarget", + "documentation":"

Identifier for the directory consumer account with whom the directory has to be unshared.

" + } + } + }, + "UnshareDirectoryResult":{ + "type":"structure", + "members":{ + "SharedDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory stored in the directory consumer account that is to be unshared from the specified directory (DirectoryId).

" + } + } + }, + "UnshareTarget":{ + "type":"structure", + "required":[ + "Id", + "Type" + ], + "members":{ + "Id":{ + "shape":"TargetId", + "documentation":"

Identifier of the directory consumer account.

" + }, + "Type":{ + "shape":"TargetType", + "documentation":"

Type of identifier to be used in the Id field.

" + } + }, + "documentation":"

Identifier that contains details about the directory consumer account with whom the directory is being unshared.

" + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The operation is not supported.

", + "exception":true + }, + "UpdateConditionalForwarderRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RemoteDomainName", + "DnsIpAddrs" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory ID of the AWS directory for which to update the conditional forwarder.

" + }, + "RemoteDomainName":{ + "shape":"RemoteDomainName", + "documentation":"

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

" + }, + "DnsIpAddrs":{ + "shape":"DnsIpAddrs", + "documentation":"

The updated IP addresses of the remote DNS server associated with the conditional forwarder.

" + } + }, + "documentation":"

Updates a conditional forwarder.

" + }, + "UpdateConditionalForwarderResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

The result of an UpdateConditionalForwarder request.

" + }, + "UpdateNumberOfDomainControllersRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "DesiredNumber" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

Identifier of the directory to which the domain controllers will be added or removed.

" + }, + "DesiredNumber":{ + "shape":"DesiredNumberOfDomainControllers", + "documentation":"

The number of domain controllers desired in the directory.

" + } + } + }, + "UpdateNumberOfDomainControllersResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateRadiusRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "RadiusSettings" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The identifier of the directory for which to update the RADIUS server information.

" + }, + "RadiusSettings":{ + "shape":"RadiusSettings", + "documentation":"

A RadiusSettings object that contains information about the RADIUS server.

" + } + }, + "documentation":"

Contains the inputs for the UpdateRadius operation.

" + }, + "UpdateRadiusResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the results of the UpdateRadius operation.

" + }, + "UpdateSecurityGroupForDirectoryControllers":{"type":"boolean"}, + "UpdateTrustRequest":{ + "type":"structure", + "required":["TrustId"], + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

Identifier of the trust relationship.

" + }, + "SelectiveAuth":{ + "shape":"SelectiveAuth", + "documentation":"

Updates selective authentication for the trust.

" + } + } + }, + "UpdateTrustResult":{ + "type":"structure", + "members":{ + "RequestId":{"shape":"RequestId"}, + "TrustId":{ + "shape":"TrustId", + "documentation":"

Identifier of the trust relationship.

" + } + } + }, + "UseSameUsername":{"type":"boolean"}, + "UserDoesNotExistException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "RequestId":{"shape":"RequestId"} + }, + "documentation":"

The user provided a username that does not exist in your directory.

", + "exception":true + }, + "UserName":{ + "type":"string", + "min":1, + "pattern":"[a-zA-Z0-9._-]+" + }, + "UserPassword":{ + "type":"string", + "max":127, + "min":1, + "sensitive":true + }, + "VerifyTrustRequest":{ + "type":"structure", + "required":["TrustId"], + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

The unique Trust ID of the trust relationship to verify.

" + } + }, + "documentation":"

Initiates the verification of an existing trust relationship between an AWS Managed Microsoft AD directory and an external domain.

" + }, + "VerifyTrustResult":{ + "type":"structure", + "members":{ + "TrustId":{ + "shape":"TrustId", + "documentation":"

The unique Trust ID of the trust relationship that was verified.

" + } + }, + "documentation":"

Result of a VerifyTrust request.

" + }, + "VpcId":{ + "type":"string", + "pattern":"^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$" + } + }, + "documentation":"AWS Directory Service

AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

" +} diff --git a/aws/dist/botocore/data/dynamodb/2012-08-10/examples-1.json b/aws/dist/botocore/data/dynamodb/2012-08-10/examples-1.json new file mode 100644 index 00000000..e66e704b --- /dev/null +++ b/aws/dist/botocore/data/dynamodb/2012-08-10/examples-1.json @@ -0,0 +1,628 @@ +{ + "version": "1.0", + "examples": { + "BatchGetItem": [ + { + "input": { + "RequestItems": { + "Music": { + "Keys": [ + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ProjectionExpression": "AlbumTitle" + } + } + }, + "output": { + "Responses": { + "Music": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + } + }, + { + "AlbumTitle": { + "S": "Louder Than Ever" + } + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.", + "id": "to-retrieve-multiple-items-from-a-table-1476118438992", + "title": "To retrieve multiple items from a table" + } + ], + "BatchWriteItem": [ + { + "input": { + "RequestItems": { + "Music": [ + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + } + }, + { + "PutRequest": { + "Item": { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + } + } + ] + } + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds three new items to the Music table using a batch of three PutItem requests.", + "id": "to-add-multiple-items-to-a-table-1476118519747", + "title": "To add multiple items to a table" + } + ], + "CreateTable": [ + { + "input": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music" + }, + "output": { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "CREATING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a table named Music.", + "id": "to-create-a-table-1476116291743", + "title": "To create a table" + } + ], + "DeleteItem": [ + { + "input": { + "Key": { + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + }, + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an item from the Music table.", + "id": "to-delete-an-item-1475884573758", + "title": "To delete an item" + } + ], + "DeleteTable": [ + { + "input": { + "TableName": "Music" + }, + "output": { + "TableDescription": { + "ItemCount": 0, + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "DELETING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the Music table.", + "id": "to-delete-a-table-1475884368755", + "title": "To delete a table" + } + ], + "DescribeLimits": [ + { + "input": { + }, + "output": { + "AccountMaxReadCapacityUnits": 20000, + "AccountMaxWriteCapacityUnits": 20000, + "TableMaxReadCapacityUnits": 10000, + "TableMaxWriteCapacityUnits": 10000 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.", + "id": "to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064", + "title": "To determine capacity limits per table and account, in the current AWS region" + } + ], + "DescribeTable": [ + { + "input": { + "TableName": "Music" + }, + "output": { + "Table": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 5, + "WriteCapacityUnits": 5 + }, + "TableName": "Music", + "TableSizeBytes": 0, + "TableStatus": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Music table.", + "id": "to-describe-a-table-1475884440502", + "title": "To describe a table" + } + ], + "GetItem": [ + { + "input": { + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "TableName": "Music" + }, + "output": { + "Item": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.", + "id": "to-read-an-item-from-a-table-1475884258350", + "title": "To read an item from a table" + } + ], + "ListTables": [ + { + "input": { + }, + "output": { + "TableNames": [ + "Forum", + "ProductCatalog", + "Reply", + "Thread" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of the tables associated with the current AWS account and endpoint.", + "id": "to-list-tables-1475884741238", + "title": "To list tables" + } + ], + "PutItem": [ + { + "input": { + "Item": { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "Artist": { + "S": "No One You Know" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + "ReturnConsumedCapacity": "TOTAL", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + "CapacityUnits": 1, + "TableName": "Music" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a new item to the Music table.", + "id": "to-add-an-item-to-a-table-1476116191110", + "title": "To add an item to a table" + } + ], + "Query": [ + { + "input": { + "ExpressionAttributeValues": { + ":v1": { + "S": "No One You Know" + } + }, + "KeyConditionExpression": "Artist = :v1", + "ProjectionExpression": "SongTitle", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + }, + "Count": 2, + "Items": [ + { + "SongTitle": { + "S": "Call Me Today" + } + } + ], + "ScannedCount": 2 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named \"No One You Know\".", + "id": "to-query-an-item-1475883874631", + "title": "To query an item" + } + ], + "Scan": [ + { + "input": { + "ExpressionAttributeNames": { + "AT": "AlbumTitle", + "ST": "SongTitle" + }, + "ExpressionAttributeValues": { + ":a": { + "S": "No One You Know" + } + }, + "FilterExpression": "Artist = :a", + "ProjectionExpression": "#ST, #AT", + "TableName": "Music" + }, + "output": { + "ConsumedCapacity": { + }, + "Count": 2, + "Items": [ + { + "AlbumTitle": { + "S": "Somewhat Famous" + }, + "SongTitle": { + "S": "Call Me Today" + } + }, + { + "AlbumTitle": { + "S": "Blue Sky Blues" + }, + "SongTitle": { + "S": "Scared of My Shadow" + } + } + ], + "ScannedCount": 3 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example scans the entire Music table, and then narrows the results to songs by the artist \"No One You Know\". For each item, only the album title and song title are returned.", + "id": "to-scan-a-table-1475883652470", + "title": "To scan a table" + } + ], + "UpdateItem": [ + { + "input": { + "ExpressionAttributeNames": { + "#AT": "AlbumTitle", + "#Y": "Year" + }, + "ExpressionAttributeValues": { + ":t": { + "S": "Louder Than Ever" + }, + ":y": { + "N": "2015" + } + }, + "Key": { + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + }, + "ReturnValues": "ALL_NEW", + "TableName": "Music", + "UpdateExpression": "SET #Y = :y, #AT = :t" + }, + "output": { + "Attributes": { + "AlbumTitle": { + "S": "Songs About Life" + }, + "Artist": { + "S": "Acme Band" + }, + "SongTitle": { + "S": "Happy Day" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.", + "id": "to-update-an-item-in-a-table-1476118250055", + "title": "To update an item in a table" + } + ], + "UpdateTable": [ + { + "input": { + "ProvisionedThroughput": { + "ReadCapacityUnits": 10, + "WriteCapacityUnits": 10 + }, + "TableName": "MusicCollection" + }, + "output": { + "TableDescription": { + "AttributeDefinitions": [ + { + "AttributeName": "Artist", + "AttributeType": "S" + }, + { + "AttributeName": "SongTitle", + "AttributeType": "S" + } + ], + "CreationDateTime": "1421866952.062", + "ItemCount": 0, + "KeySchema": [ + { + "AttributeName": "Artist", + "KeyType": "HASH" + }, + { + "AttributeName": "SongTitle", + "KeyType": "RANGE" + } + ], + "ProvisionedThroughput": { + "LastIncreaseDateTime": "1421874759.194", + "NumberOfDecreasesToday": 1, + "ReadCapacityUnits": 1, + "WriteCapacityUnits": 1 + }, + "TableName": "MusicCollection", + "TableSizeBytes": 0, + "TableStatus": "UPDATING" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example increases the provisioned read and write capacity on the Music table.", + "id": "to-modify-a-tables-provisioned-throughput-1476118076147", + "title": "To modify a table's provisioned throughput" + } + ] + } +} diff --git a/aws/dist/botocore/data/dynamodb/2012-08-10/paginators-1.json b/aws/dist/botocore/data/dynamodb/2012-08-10/paginators-1.json new file mode 100644 index 00000000..8e10a0c7 --- /dev/null +++ b/aws/dist/botocore/data/dynamodb/2012-08-10/paginators-1.json @@ -0,0 +1,47 @@ +{ + "pagination": { + "ListBackups": { + "input_token": "ExclusiveStartBackupArn", + "output_token": "LastEvaluatedBackupArn", + "limit_key": "Limit", + "result_key": "BackupSummaries" + }, + "ListTables": { + "input_token": "ExclusiveStartTableName", + "output_token": "LastEvaluatedTableName", + "limit_key": "Limit", + "result_key": "TableNames" + }, + "Query": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": [ + "Items", + "Count", + "ScannedCount" + ], + "non_aggregate_keys": [ + "ConsumedCapacity" + ] + }, + "Scan": { + "input_token": "ExclusiveStartKey", + "output_token": "LastEvaluatedKey", + "limit_key": "Limit", + "result_key": [ + "Items", + "Count", + "ScannedCount" + ], + "non_aggregate_keys": [ + "ConsumedCapacity" + ] + }, + "ListTagsOfResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/dynamodb/2012-08-10/service-2.json b/aws/dist/botocore/data/dynamodb/2012-08-10/service-2.json new file mode 100644 index 00000000..656e0055 --- /dev/null +++ b/aws/dist/botocore/data/dynamodb/2012-08-10/service-2.json @@ -0,0 +1,4397 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-08-10", + "endpointPrefix":"dynamodb", + "jsonVersion":"1.0", + "protocol":"json", + "serviceAbbreviation":"DynamoDB", + "serviceFullName":"Amazon DynamoDB", + "serviceId":"DynamoDB", + "signatureVersion":"v4", + "targetPrefix":"DynamoDB_20120810", + "uid":"dynamodb-2012-08-10" + }, + "operations":{ + "BatchGetItem":{ + "name":"BatchGetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetItemInput"}, + "output":{"shape":"BatchGetItemOutput"}, + "errors":[ + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items, BatchGetItem returns a ValidationException with the message \"Too many items requested for the BatchGetItem call.\"

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem retrieves items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + }, + "BatchWriteItem":{ + "name":"BatchWriteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchWriteItemInput"}, + "output":{"shape":"BatchWriteItemOutput"}, + "errors":[ + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ItemCollectionSizeLimitExceededException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 16 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 400 KB.

BatchWriteItem cannot update items. To update items, use the UpdateItem action.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException.

If DynamoDB returns any unprocessed items, you should retry the batch operation on those items. However, we strongly recommend that you use an exponential backoff algorithm. If you retry the batch operation immediately, the underlying read or write requests can still fail due to throttling on the individual tables. If you delay the batch operation using exponential backoff, the individual requests in the batch are much more likely to succeed.

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

  • One or more tables specified in the BatchWriteItem request does not exist.

  • Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

  • You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

  • Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

  • There are more than 25 requests in the batch.

  • Any individual item in a batch exceeds 400 KB.

  • The total request size exceeds 16 MB.

", + "endpointdiscovery":{ + } + }, + "CreateBackup":{ + "name":"CreateBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBackupInput"}, + "output":{"shape":"CreateBackupOutput"}, + "errors":[ + {"shape":"TableNotFoundException"}, + {"shape":"TableInUseException"}, + {"shape":"ContinuousBackupsUnavailableException"}, + {"shape":"BackupInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Streams

  • Provisioned read and write capacity

", + "endpointdiscovery":{ + } + }, + "CreateGlobalTable":{ + "name":"CreateGlobalTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGlobalTableInput"}, + "output":{"shape":"CreateGlobalTableOutput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"GlobalTableAlreadyExistsException"}, + {"shape":"TableNotFoundException"} + ], + "documentation":"

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

If you want to add a new replica table to a global table, each of the following conditions must be true:

  • The table must have the same primary key as all of the other replicas.

  • The table must have the same name as all of the other replicas.

  • The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

  • None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

", + "endpointdiscovery":{ + } + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTableInput"}, + "output":{"shape":"CreateTableOutput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The CreateTable operation adds a new table to your account. In an AWS account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

", + "endpointdiscovery":{ + } + }, + "DeleteBackup":{ + "name":"DeleteBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBackupInput"}, + "output":{"shape":"DeleteBackupOutput"}, + "errors":[ + {"shape":"BackupNotFoundException"}, + {"shape":"BackupInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes an existing backup of a table.

You can call DeleteBackup at a maximum rate of 10 times per second.

", + "endpointdiscovery":{ + } + }, + "DeleteItem":{ + "name":"DeleteItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteItemInput"}, + "output":{"shape":"DeleteItemOutput"}, + "errors":[ + {"shape":"ConditionalCheckFailedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ItemCollectionSizeLimitExceededException"}, + {"shape":"TransactionConflictException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

", + "endpointdiscovery":{ + } + }, + "DeleteTable":{ + "name":"DeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTableInput"}, + "output":{"shape":"DeleteTableOutput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

", + "endpointdiscovery":{ + } + }, + "DescribeBackup":{ + "name":"DescribeBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBackupInput"}, + "output":{"shape":"DescribeBackupOutput"}, + "errors":[ + {"shape":"BackupNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

", + "endpointdiscovery":{ + } + }, + "DescribeContinuousBackups":{ + "name":"DescribeContinuousBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeContinuousBackupsInput"}, + "output":{"shape":"DescribeContinuousBackupsOutput"}, + "errors":[ + {"shape":"TableNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

", + "endpointdiscovery":{ + } + }, + "DescribeEndpoints":{ + "name":"DescribeEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointsRequest"}, + "output":{"shape":"DescribeEndpointsResponse"}, + "documentation":"

Returns the regional endpoint information.

", + "endpointoperation":true + }, + "DescribeGlobalTable":{ + "name":"DescribeGlobalTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGlobalTableInput"}, + "output":{"shape":"DescribeGlobalTableOutput"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"GlobalTableNotFoundException"} + ], + "documentation":"

Returns information about the specified global table.

", + "endpointdiscovery":{ + } + }, + "DescribeGlobalTableSettings":{ + "name":"DescribeGlobalTableSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGlobalTableSettingsInput"}, + "output":{"shape":"DescribeGlobalTableSettingsOutput"}, + "errors":[ + {"shape":"GlobalTableNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Describes Region-specific settings for a global table.

", + "endpointdiscovery":{ + } + }, + "DescribeLimits":{ + "name":"DescribeLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLimitsInput"}, + "output":{"shape":"DescribeLimitsOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

Returns the current provisioned-capacity limits for your AWS account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an AWS account, the account has initial limits on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table limits that apply when you create a table there. For more information, see Limits page in the Amazon DynamoDB Developer Guide.

Although you can increase these limits by filing a case at AWS Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those limits imposed by your account so that you have enough time to apply for an increase before you hit a limit.

For example, you could use one of the AWS SDKs to do the following:

  1. Call DescribeLimits for a particular Region to obtain your current account limits on provisioned capacity there.

  2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.

  3. Call ListTables to obtain a list of all your DynamoDB tables.

  4. For each table name listed by ListTables, do the following:

    • Call DescribeTable with the table name.

    • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

    • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

  5. Report the account limits for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level limits.

The per-table limits apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly. But the only upper limit that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account limits.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

", + "endpointdiscovery":{ + } + }, + "DescribeTable":{ + "name":"DescribeTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTableInput"}, + "output":{"shape":"DescribeTableOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

", + "endpointdiscovery":{ + } + }, + "DescribeTimeToLive":{ + "name":"DescribeTimeToLive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTimeToLiveInput"}, + "output":{"shape":"DescribeTimeToLiveOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Gives a description of the Time to Live (TTL) status on the specified table.

", + "endpointdiscovery":{ + } + }, + "GetItem":{ + "name":"GetItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetItemInput"}, + "output":{"shape":"GetItemOutput"}, + "errors":[ + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

", + "endpointdiscovery":{ + } + }, + "ListBackups":{ + "name":"ListBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBackupsInput"}, + "output":{"shape":"ListBackupsOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

List backups associated with an AWS account. To list backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a limit for the maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these limits are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

", + "endpointdiscovery":{ + } + }, + "ListGlobalTables":{ + "name":"ListGlobalTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGlobalTablesInput"}, + "output":{"shape":"ListGlobalTablesOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

Lists all global tables that have a replica in the specified Region.

", + "endpointdiscovery":{ + } + }, + "ListTables":{ + "name":"ListTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTablesInput"}, + "output":{"shape":"ListTablesOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

", + "endpointdiscovery":{ + } + }, + "ListTagsOfResource":{ + "name":"ListTagsOfResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsOfResourceInput"}, + "output":{"shape":"ListTagsOfResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + }, + "PutItem":{ + "name":"PutItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutItemInput"}, + "output":{"shape":"PutItemOutput"}, + "errors":[ + {"shape":"ConditionalCheckFailedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ItemCollectionSizeLimitExceededException"}, + {"shape":"TransactionConflictException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.

This topic provides general information about the PutItem API.

For information on how to call the PutItem API using the AWS SDK in specific languages, see the following:

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException exception.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + }, + "Query":{ + "name":"Query", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"QueryInput"}, + "output":{"shape":"QueryOutput"}, + "errors":[ + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The Query operation finds items based on primary key values. You can query any table or secondary index that has a composite primary key (a partition key and a sort key).

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

", + "endpointdiscovery":{ + } + }, + "RestoreTableFromBackup":{ + "name":"RestoreTableFromBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableFromBackupInput"}, + "output":{"shape":"RestoreTableFromBackupOutput"}, + "errors":[ + {"shape":"TableAlreadyExistsException"}, + {"shape":"TableInUseException"}, + {"shape":"BackupNotFoundException"}, + {"shape":"BackupInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Amazon CloudWatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

", + "endpointdiscovery":{ + } + }, + "RestoreTableToPointInTime":{ + "name":"RestoreTableToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableToPointInTimeInput"}, + "output":{"shape":"RestoreTableToPointInTimeOutput"}, + "errors":[ + {"shape":"TableAlreadyExistsException"}, + {"shape":"TableNotFoundException"}, + {"shape":"TableInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidRestoreTimeException"}, + {"shape":"PointInTimeRecoveryUnavailableException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

  • Global secondary indexes (GSIs)

  • Local secondary indexes (LSIs)

  • Provisioned read and write capacity

  • Encryption settings

    All these settings come from the current settings of the source table at the time of restore.

You must manually set up the following on the restored table:

  • Auto scaling policies

  • IAM policies

  • Amazon CloudWatch metrics and alarms

  • Tags

  • Stream settings

  • Time to Live (TTL) settings

  • Point in time recovery settings

", + "endpointdiscovery":{ + } + }, + "Scan":{ + "name":"Scan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScanInput"}, + "output":{"shape":"ScanOutput"}, + "errors":[ + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a LastEvaluatedKey value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single Scan operation reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the Scan begins, you can set the ConsistentRead parameter to true.

", + "endpointdiscovery":{ + } + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + }, + "TransactGetItems":{ + "name":"TransactGetItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TransactGetItemsInput"}, + "output":{"shape":"TransactGetItemsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TransactionCanceledException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 25 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one AWS account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction with up to 4 MB of data, except the following AWS Regions:

  • China (Beijing)

  • China (Ningxia)

The China (Beijing) and China (Ningxia) Regions support up to 10 items per transaction with up to 4 MB of data.

DynamoDB rejects the entire TransactGetItems request if any of the following is true:

  • A conflicting operation is in the process of updating an item to be read.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • There is a user error, such as an invalid data format.

  • The aggregate size of the items in the transaction cannot exceed 4 MB.

", + "endpointdiscovery":{ + } + }, + "TransactWriteItems":{ + "name":"TransactWriteItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TransactWriteItemsInput"}, + "output":{"shape":"TransactWriteItemsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TransactionCanceledException"}, + {"shape":"TransactionInProgressException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

TransactWriteItems is a synchronous write operation that groups up to 25 action requests. These actions can target items in different tables, but not in different AWS accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

All AWS Regions and AWS GovCloud (US) support up to 25 items per transaction with up to 4 MB of data, except the following AWS Regions:

  • China (Beijing)

  • China (Ningxia)

The China (Beijing) and China (Ningxia) Regions support up to 10 items per transaction with up to 4 MB of data.

The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

  • Put  —   Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • Update  —   Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • Delete  —   Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.

  • ConditionCheck  —   Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.

DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

  • A condition in one of the condition expressions is not met.

  • An ongoing operation is in the process of updating the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • The aggregate size of the items in the transaction exceeds 4 MB.

  • There is a user error, such as an invalid data format.

", + "endpointdiscovery":{ + } + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + }, + "UpdateContinuousBackups":{ + "name":"UpdateContinuousBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateContinuousBackupsInput"}, + "output":{"shape":"UpdateContinuousBackupsOutput"}, + "errors":[ + {"shape":"TableNotFoundException"}, + {"shape":"ContinuousBackupsUnavailableException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

Once continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

", + "endpointdiscovery":{ + } + }, + "UpdateGlobalTable":{ + "name":"UpdateGlobalTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGlobalTableInput"}, + "output":{"shape":"UpdateGlobalTableOutput"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"GlobalTableNotFoundException"}, + {"shape":"ReplicaAlreadyExistsException"}, + {"shape":"ReplicaNotFoundException"}, + {"shape":"TableNotFoundException"} + ], + "documentation":"

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

  • The global secondary indexes must have the same name.

  • The global secondary indexes must have the same hash key and sort key (if present).

  • The global secondary indexes must have the same provisioned and maximum write capacity units.

", + "endpointdiscovery":{ + } + }, + "UpdateGlobalTableSettings":{ + "name":"UpdateGlobalTableSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGlobalTableSettingsInput"}, + "output":{"shape":"UpdateGlobalTableSettingsOutput"}, + "errors":[ + {"shape":"GlobalTableNotFoundException"}, + {"shape":"ReplicaNotFoundException"}, + {"shape":"IndexNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Updates settings for a global table.

", + "endpointdiscovery":{ + } + }, + "UpdateItem":{ + "name":"UpdateItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateItemInput"}, + "output":{"shape":"UpdateItemOutput"}, + "errors":[ + {"shape":"ConditionalCheckFailedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ItemCollectionSizeLimitExceededException"}, + {"shape":"TransactionConflictException"}, + {"shape":"RequestLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

", + "endpointdiscovery":{ + } + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTableInput"}, + "output":{"shape":"UpdateTableOutput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

  • Modify the provisioned throughput settings of the table.

  • Enable or disable DynamoDB Streams on the table.

  • Remove a global secondary index from the table.

  • Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it is executing, the table status changes from ACTIVE to UPDATING. While it is UPDATING, you cannot issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

", + "endpointdiscovery":{ + } + }, + "UpdateTimeToLive":{ + "name":"UpdateTimeToLive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTimeToLiveInput"}, + "output":{"shape":"UpdateTimeToLiveOutput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

", + "endpointdiscovery":{ + } + } + }, + "shapes":{ + "AttributeAction":{ + "type":"string", + "enum":[ + "ADD", + "PUT", + "DELETE" + ] + }, + "AttributeDefinition":{ + "type":"structure", + "required":[ + "AttributeName", + "AttributeType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

A name for the attribute.

" + }, + "AttributeType":{ + "shape":"ScalarAttributeType", + "documentation":"

The data type for the attribute, where:

  • S - the attribute is of type String

  • N - the attribute is of type Number

  • B - the attribute is of type Binary

" + } + }, + "documentation":"

Represents an attribute for describing the key schema for the table and indexes.

" + }, + "AttributeDefinitions":{ + "type":"list", + "member":{"shape":"AttributeDefinition"} + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributeName":{ + "type":"string", + "max":65535 + }, + "AttributeNameList":{ + "type":"list", + "member":{"shape":"AttributeName"}, + "min":1 + }, + "AttributeUpdates":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValueUpdate"} + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{ + "shape":"StringAttributeValue", + "documentation":"

An attribute of type String. For example:

\"S\": \"Hello\"

" + }, + "N":{ + "shape":"NumberAttributeValue", + "documentation":"

An attribute of type Number. For example:

\"N\": \"123.45\"

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" + }, + "B":{ + "shape":"BinaryAttributeValue", + "documentation":"

An attribute of type Binary. For example:

\"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"

" + }, + "SS":{ + "shape":"StringSetAttributeValue", + "documentation":"

An attribute of type String Set. For example:

\"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]

" + }, + "NS":{ + "shape":"NumberSetAttributeValue", + "documentation":"

An attribute of type Number Set. For example:

\"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]

Numbers are sent across the network to DynamoDB as strings, to maximize compatibility across languages and libraries. However, DynamoDB treats them as number type attributes for mathematical operations.

" + }, + "BS":{ + "shape":"BinarySetAttributeValue", + "documentation":"

An attribute of type Binary Set. For example:

\"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]

" + }, + "M":{ + "shape":"MapAttributeValue", + "documentation":"

An attribute of type Map. For example:

\"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}

" + }, + "L":{ + "shape":"ListAttributeValue", + "documentation":"

An attribute of type List. For example:

\"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\", \"3.14159\"}]

" + }, + "NULL":{ + "shape":"NullAttributeValue", + "documentation":"

An attribute of type Null. For example:

\"NULL\": true

" + }, + "BOOL":{ + "shape":"BooleanAttributeValue", + "documentation":"

An attribute of type Boolean. For example:

\"BOOL\": true

" + } + }, + "documentation":"

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

" + }, + "AttributeValueList":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "AttributeValueUpdate":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"AttributeValue", + "documentation":"

Represents the data for an attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

" + }, + "Action":{ + "shape":"AttributeAction", + "documentation":"

Specifies how to perform the update. Valid values are PUT (default), DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table.

If an item with the specified Key is found in the table:

  • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.

  • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.

  • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set, and if the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [1,2,3]. An error occurs if an Add action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.

    This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.

If no item with the specified Key is found:

  • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.

  • DELETE - Nothing happens; there is no attribute to delete.

  • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.

" + } + }, + "documentation":"

For the UpdateItem operation, represents the attributes to be modified, the action to perform on each, and the new value for each.

You cannot use UpdateItem to update any primary key attributes. Instead, you will need to delete the item, and then use PutItem to create a new item with new attributes.

Attribute values cannot be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.

" + }, + "AutoScalingPolicyDescription":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"AutoScalingPolicyName", + "documentation":"

The name of the scaling policy.

" + }, + "TargetTrackingScalingPolicyConfiguration":{ + "shape":"AutoScalingTargetTrackingScalingPolicyConfigurationDescription", + "documentation":"

Represents a target tracking scaling policy configuration.

" + } + }, + "documentation":"

Represents the properties of the scaling policy.

" + }, + "AutoScalingPolicyDescriptionList":{ + "type":"list", + "member":{"shape":"AutoScalingPolicyDescription"} + }, + "AutoScalingPolicyName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"\\p{Print}+" + }, + "AutoScalingPolicyUpdate":{ + "type":"structure", + "required":["TargetTrackingScalingPolicyConfiguration"], + "members":{ + "PolicyName":{ + "shape":"AutoScalingPolicyName", + "documentation":"

The name of the scaling policy.

" + }, + "TargetTrackingScalingPolicyConfiguration":{ + "shape":"AutoScalingTargetTrackingScalingPolicyConfigurationUpdate", + "documentation":"

Represents a target tracking scaling policy configuration.

" + } + }, + "documentation":"

Represents the autoscaling policy to be modified.

" + }, + "AutoScalingRoleArn":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "AutoScalingSettingsDescription":{ + "type":"structure", + "members":{ + "MinimumUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The minimum capacity units that a global table or global secondary index should be scaled down to.

" + }, + "MaximumUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum capacity units that a global table or global secondary index should be scaled up to.

" + }, + "AutoScalingDisabled":{ + "shape":"BooleanObject", + "documentation":"

Disabled autoscaling for this global table or global secondary index.

" + }, + "AutoScalingRoleArn":{ + "shape":"String", + "documentation":"

Role ARN used for configuring autoScaling policy.

" + }, + "ScalingPolicies":{ + "shape":"AutoScalingPolicyDescriptionList", + "documentation":"

Information about the scaling policies.

" + } + }, + "documentation":"

Represents the autoscaling settings for a global table or global secondary index.

" + }, + "AutoScalingSettingsUpdate":{ + "type":"structure", + "members":{ + "MinimumUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The minimum capacity units that a global table or global secondary index should be scaled down to.

" + }, + "MaximumUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum capacity units that a global table or global secondary index should be scaled up to.

" + }, + "AutoScalingDisabled":{ + "shape":"BooleanObject", + "documentation":"

Disabled autoscaling for this global table or global secondary index.

" + }, + "AutoScalingRoleArn":{ + "shape":"AutoScalingRoleArn", + "documentation":"

Role ARN used for configuring autoscaling policy.

" + }, + "ScalingPolicyUpdate":{ + "shape":"AutoScalingPolicyUpdate", + "documentation":"

The scaling policy to apply for scaling target global table or global secondary index capacity units.

" + } + }, + "documentation":"

Represents the autoscaling settings to be modified for a global table or global secondary index.

" + }, + "AutoScalingTargetTrackingScalingPolicyConfigurationDescription":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "DisableScaleIn":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

" + }, + "ScaleInCooldown":{ + "shape":"IntegerObject", + "documentation":"

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

" + }, + "ScaleOutCooldown":{ + "shape":"IntegerObject", + "documentation":"

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

" + }, + "TargetValue":{ + "shape":"Double", + "documentation":"

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

" + } + }, + "documentation":"

Represents the properties of a target tracking scaling policy.

" + }, + "AutoScalingTargetTrackingScalingPolicyConfigurationUpdate":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "DisableScaleIn":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether scale in by the target tracking policy is disabled. If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is false.

" + }, + "ScaleInCooldown":{ + "shape":"IntegerObject", + "documentation":"

The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. The cooldown period is used to block subsequent scale in requests until it has expired. You should scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, application autoscaling scales out your scalable target immediately.

" + }, + "ScaleOutCooldown":{ + "shape":"IntegerObject", + "documentation":"

The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. You should continuously (but not excessively) scale out.

" + }, + "TargetValue":{ + "shape":"Double", + "documentation":"

The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

" + } + }, + "documentation":"

Represents the settings of a target tracking scaling policy that will be modified.

" + }, + "Backfilling":{"type":"boolean"}, + "BackupArn":{ + "type":"string", + "max":1024, + "min":37 + }, + "BackupCreationDateTime":{"type":"timestamp"}, + "BackupDescription":{ + "type":"structure", + "members":{ + "BackupDetails":{ + "shape":"BackupDetails", + "documentation":"

Contains the details of the backup created for the table.

" + }, + "SourceTableDetails":{ + "shape":"SourceTableDetails", + "documentation":"

Contains the details of the table when the backup was created.

" + }, + "SourceTableFeatureDetails":{ + "shape":"SourceTableFeatureDetails", + "documentation":"

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

" + } + }, + "documentation":"

Contains the description of the backup created for the table.

" + }, + "BackupDetails":{ + "type":"structure", + "required":[ + "BackupArn", + "BackupName", + "BackupStatus", + "BackupType", + "BackupCreationDateTime" + ], + "members":{ + "BackupArn":{ + "shape":"BackupArn", + "documentation":"

ARN associated with the backup.

" + }, + "BackupName":{ + "shape":"BackupName", + "documentation":"

Name of the requested backup.

" + }, + "BackupSizeBytes":{ + "shape":"BackupSizeBytes", + "documentation":"

Size of the backup in bytes.

" + }, + "BackupStatus":{ + "shape":"BackupStatus", + "documentation":"

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" + }, + "BackupType":{ + "shape":"BackupType", + "documentation":"

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

" + }, + "BackupCreationDateTime":{ + "shape":"BackupCreationDateTime", + "documentation":"

Time at which the backup was created. This is the request time of the backup.

" + }, + "BackupExpiryDateTime":{ + "shape":"Date", + "documentation":"

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

" + } + }, + "documentation":"

Contains the details of the backup created for the table.

" + }, + "BackupInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

", + "exception":true + }, + "BackupName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "BackupNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Backup not found for the given BackupARN.

", + "exception":true + }, + "BackupSizeBytes":{ + "type":"long", + "min":0 + }, + "BackupStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETED", + "AVAILABLE" + ] + }, + "BackupSummaries":{ + "type":"list", + "member":{"shape":"BackupSummary"} + }, + "BackupSummary":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table.

" + }, + "TableId":{ + "shape":"TableId", + "documentation":"

Unique identifier for the table.

" + }, + "TableArn":{ + "shape":"TableArn", + "documentation":"

ARN associated with the table.

" + }, + "BackupArn":{ + "shape":"BackupArn", + "documentation":"

ARN associated with the backup.

" + }, + "BackupName":{ + "shape":"BackupName", + "documentation":"

Name of the specified backup.

" + }, + "BackupCreationDateTime":{ + "shape":"BackupCreationDateTime", + "documentation":"

Time at which the backup was created.

" + }, + "BackupExpiryDateTime":{ + "shape":"Date", + "documentation":"

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

" + }, + "BackupStatus":{ + "shape":"BackupStatus", + "documentation":"

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

" + }, + "BackupType":{ + "shape":"BackupType", + "documentation":"

BackupType:

  • USER - You create and manage these using the on-demand backup feature.

  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.

  • AWS_BACKUP - On-demand backup created by you from AWS Backup service.

" + }, + "BackupSizeBytes":{ + "shape":"BackupSizeBytes", + "documentation":"

Size of the backup in bytes.

" + } + }, + "documentation":"

Contains details for the backup.

" + }, + "BackupType":{ + "type":"string", + "enum":[ + "USER", + "SYSTEM", + "AWS_BACKUP" + ] + }, + "BackupTypeFilter":{ + "type":"string", + "enum":[ + "USER", + "SYSTEM", + "AWS_BACKUP", + "ALL" + ] + }, + "BackupsInputLimit":{ + "type":"integer", + "max":100, + "min":1 + }, + "BatchGetItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{ + "shape":"BatchGetRequestMap", + "documentation":"

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per BatchGetItem request.

Each element in the map of items to retrieve consists of the following:

  • ConsistentRead - If true, a strongly consistent read is used; if false (the default), an eventually consistent read is used.

  • ExpressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter. The following are some use cases for using ExpressionAttributeNames:

    • To access an attribute whose name conflicts with a DynamoDB reserved word.

    • To create a placeholder for repeating occurrences of an attribute name in an expression.

    • To prevent special characters in an attribute name from being misinterpreted in an expression.

    Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

    • Percentile

    The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

    • {\"#P\":\"Percentile\"}

    You could then use this substitution in an expression, as in this example:

    • #P = :val

    Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

    For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • Keys - An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.

  • ProjectionExpression - A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

    If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

    For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

  • AttributesToGet - This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"} + }, + "documentation":"

Represents the input of a BatchGetItem operation.

" + }, + "BatchGetItemOutput":{ + "type":"structure", + "members":{ + "Responses":{ + "shape":"BatchGetResponseMap", + "documentation":"

A map of table name to a list of items. Each object in Responses consists of a table name, along with a map of attribute data consisting of the data type and attribute value.

" + }, + "UnprocessedKeys":{ + "shape":"BatchGetRequestMap", + "documentation":"

A map of tables and their respective keys that were not processed with the current response. The UnprocessedKeys value is in the same form as RequestItems, so the value can be provided directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each element consists of:

  • Keys - An array of primary key attribute values that define specific items in the table.

  • ProjectionExpression - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a requested attribute is not found, it does not appear in the result.

  • ConsistentRead - The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

The read capacity units consumed by the entire BatchGetItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

" + } + }, + "documentation":"

Represents the output of a BatchGetItem operation.

" + }, + "BatchGetRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"KeysAndAttributes"}, + "max":100, + "min":1 + }, + "BatchGetResponseMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"ItemList"} + }, + "BatchWriteItemInput":{ + "type":"structure", + "required":["RequestItems"], + "members":{ + "RequestItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

A map of one or more table names and, for each table, a list of operations to be performed (DeleteRequest or PutRequest). Each element in the map consists of the following:

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a ValidationException exception.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + } + }, + "documentation":"

Represents the input of a BatchWriteItem operation.

" + }, + "BatchWriteItemOutput":{ + "type":"structure", + "members":{ + "UnprocessedItems":{ + "shape":"BatchWriteItemRequestMap", + "documentation":"

A map of tables and requests against those tables that were not processed. The UnprocessedItems value is in the same form as RequestItems, so you can provide this value directly to a subsequent BatchGetItem operation. For more information, see RequestItems in the Request Parameters section.

Each UnprocessedItems entry consists of a table name and, for that table, a list of operations to perform (DeleteRequest or PutRequest).

  • DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:

    • Key - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value.

  • PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:

    • Item - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values will be rejected with a ValidationException exception.

      If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetricsPerTable", + "documentation":"

A list of tables that were processed by BatchWriteItem and, for each table, information about any item collections that were affected by individual DeleteItem or PutItem operations.

Each entry consists of the following subelements:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item.

  • SizeEstimateRangeGB - An estimate of item collection size, expressed in GB. This is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on the table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

The capacity units consumed by the entire BatchWriteItem operation.

Each element consists of:

  • TableName - The table that consumed the provisioned throughput.

  • CapacityUnits - The total number of capacity units consumed.

" + } + }, + "documentation":"

Represents the output of a BatchWriteItem operation.

" + }, + "BatchWriteItemRequestMap":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"WriteRequests"}, + "max":25, + "min":1 + }, + "BillingMode":{ + "type":"string", + "enum":[ + "PROVISIONED", + "PAY_PER_REQUEST" + ] + }, + "BillingModeSummary":{ + "type":"structure", + "members":{ + "BillingMode":{ + "shape":"BillingMode", + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

" + }, + "LastUpdateToPayPerRequestDateTime":{ + "shape":"Date", + "documentation":"

Represents the time when PAY_PER_REQUEST was last set as the read/write capacity mode.

" + } + }, + "documentation":"

Contains the details for the read/write capacity mode.

" + }, + "BinaryAttributeValue":{"type":"blob"}, + "BinarySetAttributeValue":{ + "type":"list", + "member":{"shape":"BinaryAttributeValue"} + }, + "BooleanAttributeValue":{"type":"boolean"}, + "BooleanObject":{"type":"boolean"}, + "CancellationReason":{ + "type":"structure", + "members":{ + "Item":{ + "shape":"AttributeMap", + "documentation":"

Item in the request which caused the transaction to get cancelled.

" + }, + "Code":{ + "shape":"Code", + "documentation":"

Status code for the result of the cancelled transaction.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

Cancellation reason message description.

" + } + }, + "documentation":"

An ordered list of errors for each item in the request which caused the transaction to get cancelled. The values of the list are ordered according to the ordering of the TransactWriteItems request parameter. If no error occurred for the associated item an error with a Null code and Null message will be present.

" + }, + "CancellationReasonList":{ + "type":"list", + "member":{"shape":"CancellationReason"}, + "max":10, + "min":1 + }, + "Capacity":{ + "type":"structure", + "members":{ + "ReadCapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of read capacity units consumed on a table or an index.

" + }, + "WriteCapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of write capacity units consumed on a table or an index.

" + }, + "CapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of capacity units consumed on a table or an index.

" + } + }, + "documentation":"

Represents the amount of provisioned throughput capacity consumed on a table or an index.

" + }, + "ClientRequestToken":{ + "type":"string", + "max":36, + "min":1 + }, + "Code":{"type":"string"}, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "IN", + "LE", + "LT", + "GE", + "GT", + "BETWEEN", + "NOT_NULL", + "NULL", + "CONTAINS", + "NOT_CONTAINS", + "BEGINS_WITH" + ] + }, + "Condition":{ + "type":"structure", + "required":["ComparisonOperator"], + "members":{ + "AttributeValueList":{ + "shape":"AttributeValueList", + "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

A comparator for evaluating attributes. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}

For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the selection criteria for a Query or Scan operation:

  • For a Query operation, Condition is used for specifying the KeyConditions to use when querying a table or an index. For KeyConditions, only the following comparison operators are supported:

    EQ | LE | LT | GE | GT | BEGINS_WITH | BETWEEN

    Condition is also used in a QueryFilter, which evaluates the query results and returns only the desired values.

  • For a Scan operation, Condition is used in a ScanFilter, which evaluates the scan results and returns only the desired values.

" + }, + "ConditionCheck":{ + "type":"structure", + "required":[ + "Key", + "TableName", + "ConditionExpression" + ], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table for the check item request.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

" + }, + "ReturnValuesOnConditionCheckFailure":{ + "shape":"ReturnValuesOnConditionCheckFailure", + "documentation":"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

" + } + }, + "documentation":"

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item..

" + }, + "ConditionExpression":{"type":"string"}, + "ConditionalCheckFailedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The conditional request failed.

" + } + }, + "documentation":"

A condition specified in the operation could not be evaluated.

", + "exception":true + }, + "ConditionalOperator":{ + "type":"string", + "enum":[ + "AND", + "OR" + ] + }, + "ConsistentRead":{"type":"boolean"}, + "ConsumedCapacity":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table that was affected by the operation.

" + }, + "CapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of capacity units consumed by the operation.

" + }, + "ReadCapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of read capacity units consumed by the operation.

" + }, + "WriteCapacityUnits":{ + "shape":"ConsumedCapacityUnits", + "documentation":"

The total number of write capacity units consumed by the operation.

" + }, + "Table":{ + "shape":"Capacity", + "documentation":"

The amount of throughput consumed on the table affected by the operation.

" + }, + "LocalSecondaryIndexes":{ + "shape":"SecondaryIndexesCapacityMap", + "documentation":"

The amount of throughput consumed on each local index affected by the operation.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"SecondaryIndexesCapacityMap", + "documentation":"

The amount of throughput consumed on each global index affected by the operation.

" + } + }, + "documentation":"

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + }, + "ConsumedCapacityMultiple":{ + "type":"list", + "member":{"shape":"ConsumedCapacity"} + }, + "ConsumedCapacityUnits":{"type":"double"}, + "ContinuousBackupsDescription":{ + "type":"structure", + "required":["ContinuousBackupsStatus"], + "members":{ + "ContinuousBackupsStatus":{ + "shape":"ContinuousBackupsStatus", + "documentation":"

ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

" + }, + "PointInTimeRecoveryDescription":{ + "shape":"PointInTimeRecoveryDescription", + "documentation":"

The description of the point in time recovery settings applied to the table.

" + } + }, + "documentation":"

Represents the continuous backups and point in time recovery settings on the table.

" + }, + "ContinuousBackupsStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ContinuousBackupsUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Backups have not yet been enabled for this table.

", + "exception":true + }, + "CreateBackupInput":{ + "type":"structure", + "required":[ + "TableName", + "BackupName" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table.

" + }, + "BackupName":{ + "shape":"BackupName", + "documentation":"

Specified name for the backup.

" + } + } + }, + "CreateBackupOutput":{ + "type":"structure", + "members":{ + "BackupDetails":{ + "shape":"BackupDetails", + "documentation":"

Contains the details of the backup created for the table.

" + } + } + }, + "CreateGlobalSecondaryIndexAction":{ + "type":"structure", + "required":[ + "IndexName", + "KeySchema", + "Projection" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index to be created.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The key schema for the global secondary index.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents a new global secondary index to be added to an existing table.

" + }, + "CreateGlobalTableInput":{ + "type":"structure", + "required":[ + "GlobalTableName", + "ReplicationGroup" + ], + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The global table name.

" + }, + "ReplicationGroup":{ + "shape":"ReplicaList", + "documentation":"

The Regions where the global table needs to be created.

" + } + } + }, + "CreateGlobalTableOutput":{ + "type":"structure", + "members":{ + "GlobalTableDescription":{ + "shape":"GlobalTableDescription", + "documentation":"

Contains the details of the global table.

" + } + } + }, + "CreateReplicaAction":{ + "type":"structure", + "required":["RegionName"], + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The region of the replica to be added.

" + } + }, + "documentation":"

Represents a replica to be added.

" + }, + "CreateTableInput":{ + "type":"structure", + "required":[ + "AttributeDefinitions", + "TableName", + "KeySchema" + ], + "members":{ + "AttributeDefinitions":{ + "shape":"AttributeDefinitions", + "documentation":"

An array of attributes that describe the key schema for the table and indexes.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to create.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

  • AttributeName - The name of this key attribute.

  • KeyType - The role that the key attribute will assume:

    • HASH - partition key

    • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

" + }, + "LocalSecondaryIndexes":{ + "shape":"LocalSecondaryIndexList", + "documentation":"

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

  • IndexName - The name of the local secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"GlobalSecondaryIndexList", + "documentation":"

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

  • IndexName - The name of the global secondary index. Must be unique only for this table.

  • KeySchema - Specifies the key schema for the global secondary index.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

" + }, + "BillingMode":{ + "shape":"BillingMode", + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "StreamSpecification":{ + "shape":"StreamSpecification", + "documentation":"

The settings for DynamoDB Streams on the table. These settings consist of:

  • StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).

  • StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:

    • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

    • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

    • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

    • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

" + }, + "SSESpecification":{ + "shape":"SSESpecification", + "documentation":"

Represents the settings used to enable server-side encryption.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

" + } + }, + "documentation":"

Represents the input of a CreateTable operation.

" + }, + "CreateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{ + "shape":"TableDescription", + "documentation":"

Represents the properties of the table.

" + } + }, + "documentation":"

Represents the output of a CreateTable operation.

" + }, + "Date":{"type":"timestamp"}, + "Delete":{ + "type":"structure", + "required":[ + "Key", + "TableName" + ], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table in which the item to be deleted resides.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional delete to succeed.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

" + }, + "ReturnValuesOnConditionCheckFailure":{ + "shape":"ReturnValuesOnConditionCheckFailure", + "documentation":"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Delete condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

" + } + }, + "documentation":"

Represents a request to perform a DeleteItem operation.

" + }, + "DeleteBackupInput":{ + "type":"structure", + "required":["BackupArn"], + "members":{ + "BackupArn":{ + "shape":"BackupArn", + "documentation":"

The ARN associated with the backup.

" + } + } + }, + "DeleteBackupOutput":{ + "type":"structure", + "members":{ + "BackupDescription":{ + "shape":"BackupDescription", + "documentation":"

Contains the description of the backup created for the table.

" + } + } + }, + "DeleteGlobalSecondaryIndexAction":{ + "type":"structure", + "required":["IndexName"], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index to be deleted.

" + } + }, + "documentation":"

Represents a global secondary index to be deleted from an existing table.

" + }, + "DeleteItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table from which to delete the item.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - The content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the input of a DeleteItem operation.

" + }, + "DeleteItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Mode in the Amazon DynamoDB Developer Guide.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetrics", + "documentation":"

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + } + }, + "documentation":"

Represents the output of a DeleteItem operation.

" + }, + "DeleteReplicaAction":{ + "type":"structure", + "required":["RegionName"], + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The region of the replica to be removed.

" + } + }, + "documentation":"

Represents a replica to be removed.

" + }, + "DeleteRequest":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.

" + } + }, + "documentation":"

Represents a request to perform a DeleteItem operation on an item.

" + }, + "DeleteTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteTable operation.

" + }, + "DeleteTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{ + "shape":"TableDescription", + "documentation":"

Represents the properties of a table.

" + } + }, + "documentation":"

Represents the output of a DeleteTable operation.

" + }, + "DescribeBackupInput":{ + "type":"structure", + "required":["BackupArn"], + "members":{ + "BackupArn":{ + "shape":"BackupArn", + "documentation":"

The Amazon Resource Name (ARN) associated with the backup.

" + } + } + }, + "DescribeBackupOutput":{ + "type":"structure", + "members":{ + "BackupDescription":{ + "shape":"BackupDescription", + "documentation":"

Contains the description of the backup created for the table.

" + } + } + }, + "DescribeContinuousBackupsInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

" + } + } + }, + "DescribeContinuousBackupsOutput":{ + "type":"structure", + "members":{ + "ContinuousBackupsDescription":{ + "shape":"ContinuousBackupsDescription", + "documentation":"

Represents the continuous backups and point in time recovery settings on the table.

" + } + } + }, + "DescribeEndpointsRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeEndpointsResponse":{ + "type":"structure", + "required":["Endpoints"], + "members":{ + "Endpoints":{ + "shape":"Endpoints", + "documentation":"

List of endpoints.

" + } + } + }, + "DescribeGlobalTableInput":{ + "type":"structure", + "required":["GlobalTableName"], + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The name of the global table.

" + } + } + }, + "DescribeGlobalTableOutput":{ + "type":"structure", + "members":{ + "GlobalTableDescription":{ + "shape":"GlobalTableDescription", + "documentation":"

Contains the details of the global table.

" + } + } + }, + "DescribeGlobalTableSettingsInput":{ + "type":"structure", + "required":["GlobalTableName"], + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The name of the global table to describe.

" + } + } + }, + "DescribeGlobalTableSettingsOutput":{ + "type":"structure", + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The name of the global table.

" + }, + "ReplicaSettings":{ + "shape":"ReplicaSettingsDescriptionList", + "documentation":"

The Region-specific settings for the global table.

" + } + } + }, + "DescribeLimitsInput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the input of a DescribeLimits operation. Has no content.

" + }, + "DescribeLimitsOutput":{ + "type":"structure", + "members":{ + "AccountMaxReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.

" + }, + "AccountMaxWriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.

" + }, + "TableMaxReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).

" + }, + "TableMaxWriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).

" + } + }, + "documentation":"

Represents the output of a DescribeLimits operation.

" + }, + "DescribeTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to describe.

" + } + }, + "documentation":"

Represents the input of a DescribeTable operation.

" + }, + "DescribeTableOutput":{ + "type":"structure", + "members":{ + "Table":{ + "shape":"TableDescription", + "documentation":"

The properties of the table.

" + } + }, + "documentation":"

Represents the output of a DescribeTable operation.

" + }, + "DescribeTimeToLiveInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to be described.

" + } + } + }, + "DescribeTimeToLiveOutput":{ + "type":"structure", + "members":{ + "TimeToLiveDescription":{ + "shape":"TimeToLiveDescription", + "documentation":"

" + } + } + }, + "Double":{"type":"double"}, + "Endpoint":{ + "type":"structure", + "required":[ + "Address", + "CachePeriodInMinutes" + ], + "members":{ + "Address":{ + "shape":"String", + "documentation":"

IP address of the endpoint.

" + }, + "CachePeriodInMinutes":{ + "shape":"Long", + "documentation":"

Endpoint cache time to live (TTL) value.

" + } + }, + "documentation":"

An endpoint information details.

" + }, + "Endpoints":{ + "type":"list", + "member":{"shape":"Endpoint"} + }, + "ErrorMessage":{"type":"string"}, + "ExpectedAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"ExpectedAttributeValue"} + }, + "ExpectedAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"AttributeValue", + "documentation":"

Represents the data for the expected attribute.

Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.

For more information, see Data Types in the Amazon DynamoDB Developer Guide.

" + }, + "Exists":{ + "shape":"BooleanObject", + "documentation":"

Causes DynamoDB to evaluate the value before attempting a conditional operation:

  • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionCheckFailedException.

  • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionCheckFailedException.

The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied.

DynamoDB returns a ValidationException if:

  • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)

  • Exists is false but you also provide a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

A comparator for evaluating attributes in the AttributeValueList. For example, equals, greater than, less than, etc.

The following comparison operators are available:

EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN

The following are descriptions of each comparison operator.

  • EQ : Equal. EQ is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue element of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NE : Not equal. NE is supported for all data types, including lists and maps.

    AttributeValueList can contain only one AttributeValue of type String, Number, Binary, String Set, Number Set, or Binary Set. If an item contains an AttributeValue of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not equal {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LE : Less than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • LT : Less than.

    AttributeValueList can contain only one AttributeValue of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GE : Greater than or equal.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • GT : Greater than.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not equal {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}.

  • NOT_NULL : The attribute exists. NOT_NULL is supported for all data types, including lists and maps.

    This operator tests for the existence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NOT_NULL, the result is a Boolean true. This result is because the attribute \"a\" exists; its data type is not relevant to the NOT_NULL comparison operator.

  • NULL : The attribute does not exist. NULL is supported for all data types, including lists and maps.

    This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute \"a\" is null, and you evaluate it using NULL, the result is a Boolean false. This is because the attribute \"a\" exists; its data type is not relevant to the NULL comparison operator.

  • CONTAINS : Checks for a subsequence, or value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is of type String, then the operator checks for a substring match. If the target attribute of the comparison is of type Binary, then the operator looks for a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it finds an exact match with any member of the set.

    CONTAINS is supported for lists: When evaluating \"a CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • NOT_CONTAINS : Checks for absence of a subsequence, or absence of a value in a set.

    AttributeValueList can contain only one AttributeValue element of type String, Number, or Binary (not a set type). If the target attribute of the comparison is a String, then the operator checks for the absence of a substring match. If the target attribute of the comparison is Binary, then the operator checks for the absence of a subsequence of the target that matches the input. If the target attribute of the comparison is a set (\"SS\", \"NS\", or \"BS\"), then the operator evaluates to true if it does not find an exact match with any member of the set.

    NOT_CONTAINS is supported for lists: When evaluating \"a NOT CONTAINS b\", \"a\" can be a list; however, \"b\" cannot be a set, a map, or a list.

  • BEGINS_WITH : Checks for a prefix.

    AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).

  • IN : Checks for matching elements in a list.

    AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary. These attributes are compared against an existing attribute of an item. If any elements of the input are equal to the item attribute, the expression evaluates to true.

  • BETWEEN : Greater than or equal to the first value, and less than or equal to the second value.

    AttributeValueList must contain two AttributeValue elements of the same type, either String, Number, or Binary (not a set type). A target attribute matches if the target value is greater than, or equal to, the first element and less than, or equal to, the second element. If an item contains an AttributeValue element of a different type than the one provided in the request, the value does not match. For example, {\"S\":\"6\"} does not compare to {\"N\":\"6\"}. Also, {\"N\":\"6\"} does not compare to {\"NS\":[\"6\", \"2\", \"1\"]}

" + }, + "AttributeValueList":{ + "shape":"AttributeValueList", + "documentation":"

One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.

For type Number, value comparisons are numeric.

String value comparisons for greater than, equals, or less than are based on ASCII character code values. For example, a is greater than A, and a is greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.

For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.

For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents a condition to be compared with an attribute value. This condition can be used with DeleteItem, PutItem or UpdateItem operations; if the comparison evaluates to true, the operation succeeds; if not, the operation fails. You can use ExpectedAttributeValue in one of two different ways:

  • Use AttributeValueList to specify one or more values to compare against an attribute. Use ComparisonOperator to specify how you want to perform the comparison. If the comparison evaluates to true, then the conditional operation succeeds.

  • Use Value to specify a value that DynamoDB will compare against an attribute. If the values match, then ExpectedAttributeValue evaluates to true and the conditional operation succeeds. Optionally, you can also set Exists to false, indicating that you do not expect to find the attribute value in the table. In this case, the conditional operation succeeds only if the comparison evaluates to false.

Value and Exists are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.

" + }, + "ExpressionAttributeNameMap":{ + "type":"map", + "key":{"shape":"ExpressionAttributeNameVariable"}, + "value":{"shape":"AttributeName"} + }, + "ExpressionAttributeNameVariable":{"type":"string"}, + "ExpressionAttributeValueMap":{ + "type":"map", + "key":{"shape":"ExpressionAttributeValueVariable"}, + "value":{"shape":"AttributeValue"} + }, + "ExpressionAttributeValueVariable":{"type":"string"}, + "FilterConditionMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"Condition"} + }, + "Get":{ + "type":"structure", + "required":[ + "Key", + "TableName" + ], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table from which to retrieve the specified item.

" + }, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in the ProjectionExpression parameter.

" + } + }, + "documentation":"

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

" + }, + "GetItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested item.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the input of a GetItem operation.

" + }, + "GetItemOutput":{ + "type":"structure", + "members":{ + "Item":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the output of a GetItem operation.

" + }, + "GlobalSecondaryIndex":{ + "type":"structure", + "required":[ + "IndexName", + "KeySchema", + "Projection" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the properties of a global secondary index.

" + }, + "GlobalSecondaryIndexDescription":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "IndexStatus":{ + "shape":"IndexStatus", + "documentation":"

The current state of the global secondary index:

  • CREATING - The index is being created.

  • UPDATING - The index is being updated.

  • DELETING - The index is being deleted.

  • ACTIVE - The index is ready for use.

" + }, + "Backfilling":{ + "shape":"Backfilling", + "documentation":"

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and Backfilling is false.

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughputDescription", + "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "IndexSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "IndexArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the index.

" + } + }, + "documentation":"

Represents the properties of a global secondary index.

" + }, + "GlobalSecondaryIndexDescriptionList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndexDescription"} + }, + "GlobalSecondaryIndexInfo":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

" + } + }, + "documentation":"

Represents the properties of a global secondary index for the table when the backup was created.

" + }, + "GlobalSecondaryIndexList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndex"} + }, + "GlobalSecondaryIndexUpdate":{ + "type":"structure", + "members":{ + "Update":{ + "shape":"UpdateGlobalSecondaryIndexAction", + "documentation":"

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

" + }, + "Create":{ + "shape":"CreateGlobalSecondaryIndexAction", + "documentation":"

The parameters required for creating a global secondary index on an existing table:

  • IndexName

  • KeySchema

  • AttributeDefinitions

  • Projection

  • ProvisionedThroughput

" + }, + "Delete":{ + "shape":"DeleteGlobalSecondaryIndexAction", + "documentation":"

The name of an existing global secondary index to be removed.

" + } + }, + "documentation":"

Represents one of the following:

  • A new global secondary index to be added to an existing table.

  • New provisioned throughput parameters for an existing global secondary index.

  • An existing global secondary index to be removed from an existing table.

" + }, + "GlobalSecondaryIndexUpdateList":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndexUpdate"} + }, + "GlobalSecondaryIndexes":{ + "type":"list", + "member":{"shape":"GlobalSecondaryIndexInfo"} + }, + "GlobalTable":{ + "type":"structure", + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The global table name.

" + }, + "ReplicationGroup":{ + "shape":"ReplicaList", + "documentation":"

The regions where the global table has replicas.

" + } + }, + "documentation":"

Represents the properties of a global table.

" + }, + "GlobalTableAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified global table already exists.

", + "exception":true + }, + "GlobalTableArnString":{"type":"string"}, + "GlobalTableDescription":{ + "type":"structure", + "members":{ + "ReplicationGroup":{ + "shape":"ReplicaDescriptionList", + "documentation":"

The regions where the global table has replicas.

" + }, + "GlobalTableArn":{ + "shape":"GlobalTableArnString", + "documentation":"

The unique identifier of the global table.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation time of the global table.

" + }, + "GlobalTableStatus":{ + "shape":"GlobalTableStatus", + "documentation":"

The current state of the global table:

  • CREATING - The global table is being created.

  • UPDATING - The global table is being updated.

  • DELETING - The global table is being deleted.

  • ACTIVE - The global table is ready for use.

" + }, + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The global table name.

" + } + }, + "documentation":"

Contains details about the global table.

" + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdate":{ + "type":"structure", + "required":["IndexName"], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" + }, + "ProvisionedWriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + }, + "ProvisionedWriteCapacityAutoScalingSettingsUpdate":{ + "shape":"AutoScalingSettingsUpdate", + "documentation":"

AutoScaling settings for managing a global secondary index's write capacity units.

" + } + }, + "documentation":"

Represents the settings of a global secondary index for a global table that will be modified.

" + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdateList":{ + "type":"list", + "member":{"shape":"GlobalTableGlobalSecondaryIndexSettingsUpdate"}, + "max":20, + "min":1 + }, + "GlobalTableList":{ + "type":"list", + "member":{"shape":"GlobalTable"} + }, + "GlobalTableNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified global table does not exist.

", + "exception":true + }, + "GlobalTableStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "UPDATING" + ] + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

", + "exception":true + }, + "IndexName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "IndexNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The operation tried to access a nonexistent index.

", + "exception":true + }, + "IndexStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "Integer":{"type":"integer"}, + "IntegerObject":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The server encountered an internal error trying to fulfill the request.

" + } + }, + "documentation":"

An error occurred on the server side.

", + "exception":true, + "fault":true + }, + "InvalidRestoreTimeException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

", + "exception":true + }, + "ItemCollectionKeyAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "ItemCollectionMetrics":{ + "type":"structure", + "members":{ + "ItemCollectionKey":{ + "shape":"ItemCollectionKeyAttributeMap", + "documentation":"

The partition key value of the item collection. This value is the same as the partition key value of the item.

" + }, + "SizeEstimateRangeGB":{ + "shape":"ItemCollectionSizeEstimateRange", + "documentation":"

An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + } + }, + "documentation":"

Information about item collections, if any, that were affected by the operation. ItemCollectionMetrics is only returned if the request asked for it. If the table does not have any local secondary indexes, this information is not returned in the response.

" + }, + "ItemCollectionMetricsMultiple":{ + "type":"list", + "member":{"shape":"ItemCollectionMetrics"} + }, + "ItemCollectionMetricsPerTable":{ + "type":"map", + "key":{"shape":"TableName"}, + "value":{"shape":"ItemCollectionMetricsMultiple"} + }, + "ItemCollectionSizeEstimateBound":{"type":"double"}, + "ItemCollectionSizeEstimateRange":{ + "type":"list", + "member":{"shape":"ItemCollectionSizeEstimateBound"} + }, + "ItemCollectionSizeLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The total size of an item collection has exceeded the maximum limit of 10 gigabytes.

" + } + }, + "documentation":"

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

", + "exception":true + }, + "ItemCount":{ + "type":"long", + "min":0 + }, + "ItemList":{ + "type":"list", + "member":{"shape":"AttributeMap"} + }, + "ItemResponse":{ + "type":"structure", + "members":{ + "Item":{ + "shape":"AttributeMap", + "documentation":"

Map of attribute data consisting of the data type and attribute value.

" + } + }, + "documentation":"

Details for the requested item.

" + }, + "ItemResponseList":{ + "type":"list", + "member":{"shape":"ItemResponse"}, + "max":10, + "min":1 + }, + "KMSMasterKeyArn":{"type":"string"}, + "KMSMasterKeyId":{"type":"string"}, + "Key":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "KeyConditions":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"Condition"} + }, + "KeyExpression":{"type":"string"}, + "KeyList":{ + "type":"list", + "member":{"shape":"Key"}, + "max":100, + "min":1 + }, + "KeySchema":{ + "type":"list", + "member":{"shape":"KeySchemaElement"}, + "max":2, + "min":1 + }, + "KeySchemaAttributeName":{ + "type":"string", + "max":255, + "min":1 + }, + "KeySchemaElement":{ + "type":"structure", + "required":[ + "AttributeName", + "KeyType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

The name of a key attribute.

" + }, + "KeyType":{ + "shape":"KeyType", + "documentation":"

The role that this key attribute will assume:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + } + }, + "documentation":"

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key would be represented by one KeySchemaElement (for the partition key). A composite primary key would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

A KeySchemaElement must be a scalar, top-level attribute (not a nested attribute). The data type must be one of String, Number, or Binary. The attribute cannot be nested within a List or a Map.

" + }, + "KeyType":{ + "type":"string", + "enum":[ + "HASH", + "RANGE" + ] + }, + "KeysAndAttributes":{ + "type":"structure", + "required":["Keys"], + "members":{ + "Keys":{ + "shape":"KeyList", + "documentation":"

The primary key attribute values that define the items and the attributes associated with the items.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

" + }, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the ProjectionExpression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents a set of primary keys and, for each key, the attributes to retrieve from the table.

For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key. For a composite primary key, you must provide both the partition key and the sort key.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Too many operations for a given subscriber.

" + } + }, + "documentation":"

There is no limit to the number of daily on-demand backups that can be taken.

Up to 50 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

The only exception is when you are creating a table with one or more secondary indexes. You can have up to 25 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

There is a soft account limit of 256 tables.

", + "exception":true + }, + "ListAttributeValue":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "ListBackupsInput":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The backups from the table specified by TableName are listed.

" + }, + "Limit":{ + "shape":"BackupsInputLimit", + "documentation":"

Maximum number of backups to return at once.

" + }, + "TimeRangeLowerBound":{ + "shape":"TimeRangeLowerBound", + "documentation":"

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

" + }, + "TimeRangeUpperBound":{ + "shape":"TimeRangeUpperBound", + "documentation":"

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

" + }, + "ExclusiveStartBackupArn":{ + "shape":"BackupArn", + "documentation":"

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

" + }, + "BackupType":{ + "shape":"BackupTypeFilter", + "documentation":"

The backups from the table specified by BackupType are listed.

Where BackupType can be:

  • USER - On-demand backup created by you.

  • SYSTEM - On-demand backup automatically created by DynamoDB.

  • ALL - All types of on-demand backups (USER and SYSTEM).

" + } + } + }, + "ListBackupsOutput":{ + "type":"structure", + "members":{ + "BackupSummaries":{ + "shape":"BackupSummaries", + "documentation":"

List of BackupSummary objects.

" + }, + "LastEvaluatedBackupArn":{ + "shape":"BackupArn", + "documentation":"

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

" + } + } + }, + "ListGlobalTablesInput":{ + "type":"structure", + "members":{ + "ExclusiveStartGlobalTableName":{ + "shape":"TableName", + "documentation":"

The first global table name that this operation will evaluate.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of table names to return.

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

Lists the global tables in a specific Region.

" + } + } + }, + "ListGlobalTablesOutput":{ + "type":"structure", + "members":{ + "GlobalTables":{ + "shape":"GlobalTableList", + "documentation":"

List of global table names.

" + }, + "LastEvaluatedGlobalTableName":{ + "shape":"TableName", + "documentation":"

Last evaluated global table name.

" + } + } + }, + "ListTablesInput":{ + "type":"structure", + "members":{ + "ExclusiveStartTableName":{ + "shape":"TableName", + "documentation":"

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

" + }, + "Limit":{ + "shape":"ListTablesInputLimit", + "documentation":"

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

" + } + }, + "documentation":"

Represents the input of a ListTables operation.

" + }, + "ListTablesInputLimit":{ + "type":"integer", + "max":100, + "min":1 + }, + "ListTablesOutput":{ + "type":"structure", + "members":{ + "TableNames":{ + "shape":"TableNameList", + "documentation":"

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

" + }, + "LastEvaluatedTableName":{ + "shape":"TableName", + "documentation":"

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

" + } + }, + "documentation":"

Represents the output of a ListTables operation.

" + }, + "ListTagsOfResourceInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"

An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

" + } + } + }, + "ListTagsOfResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The tags currently associated with the Amazon DynamoDB resource.

" + }, + "NextToken":{ + "shape":"NextTokenString", + "documentation":"

If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

" + } + } + }, + "LocalSecondaryIndex":{ + "type":"structure", + "required":[ + "IndexName", + "KeySchema", + "Projection" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the local secondary index. The name must be unique among all other indexes on this table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + } + }, + "documentation":"

Represents the properties of a local secondary index.

" + }, + "LocalSecondaryIndexDescription":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

Represents the name of the local secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "IndexSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "IndexArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the index.

" + } + }, + "documentation":"

Represents the properties of a local secondary index.

" + }, + "LocalSecondaryIndexDescriptionList":{ + "type":"list", + "member":{"shape":"LocalSecondaryIndexDescription"} + }, + "LocalSecondaryIndexInfo":{ + "type":"structure", + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

Represents the name of the local secondary index.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The complete key schema for a local secondary index, which consists of one or more pairs of attribute names and key types:

  • HASH - partition key

  • RANGE - sort key

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "Projection":{ + "shape":"Projection", + "documentation":"

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + } + }, + "documentation":"

Represents the properties of a local secondary index for the table when the backup was created.

" + }, + "LocalSecondaryIndexList":{ + "type":"list", + "member":{"shape":"LocalSecondaryIndex"} + }, + "LocalSecondaryIndexes":{ + "type":"list", + "member":{"shape":"LocalSecondaryIndexInfo"} + }, + "Long":{"type":"long"}, + "MapAttributeValue":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "NextTokenString":{"type":"string"}, + "NonKeyAttributeName":{ + "type":"string", + "max":255, + "min":1 + }, + "NonKeyAttributeNameList":{ + "type":"list", + "member":{"shape":"NonKeyAttributeName"}, + "max":20, + "min":1 + }, + "NonNegativeLongObject":{ + "type":"long", + "min":0 + }, + "NullAttributeValue":{"type":"boolean"}, + "NumberAttributeValue":{"type":"string"}, + "NumberSetAttributeValue":{ + "type":"list", + "member":{"shape":"NumberAttributeValue"} + }, + "PointInTimeRecoveryDescription":{ + "type":"structure", + "members":{ + "PointInTimeRecoveryStatus":{ + "shape":"PointInTimeRecoveryStatus", + "documentation":"

The current state of point in time recovery:

  • ENABLING - Point in time recovery is being enabled.

  • ENABLED - Point in time recovery is enabled.

  • DISABLED - Point in time recovery is disabled.

" + }, + "EarliestRestorableDateTime":{ + "shape":"Date", + "documentation":"

Specifies the earliest point in time you can restore your table to. It You can restore your table to any point in time during the last 35 days.

" + }, + "LatestRestorableDateTime":{ + "shape":"Date", + "documentation":"

LatestRestorableDateTime is typically 5 minutes before the current time.

" + } + }, + "documentation":"

The description of the point in time settings applied to the table.

" + }, + "PointInTimeRecoverySpecification":{ + "type":"structure", + "required":["PointInTimeRecoveryEnabled"], + "members":{ + "PointInTimeRecoveryEnabled":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.

" + } + }, + "documentation":"

Represents the settings used to enable point in time recovery.

" + }, + "PointInTimeRecoveryStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "PointInTimeRecoveryUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Point in time recovery has not yet been enabled for this source table.

", + "exception":true + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "PositiveLongObject":{ + "type":"long", + "min":1 + }, + "Projection":{ + "type":"structure", + "members":{ + "ProjectionType":{ + "shape":"ProjectionType", + "documentation":"

The set of attributes that are projected into the index:

  • KEYS_ONLY - Only the index and primary keys are projected into the index.

  • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

  • ALL - All of the table attributes are projected into the index.

" + }, + "NonKeyAttributes":{ + "shape":"NonKeyAttributeNameList", + "documentation":"

Represents the non-key attribute names which will be projected into the index.

For local secondary indexes, the total count of NonKeyAttributes summed across all of the local secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

" + } + }, + "documentation":"

Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

" + }, + "ProjectionExpression":{"type":"string"}, + "ProjectionType":{ + "type":"string", + "enum":[ + "ALL", + "KEYS_ONLY", + "INCLUDE" + ] + }, + "ProvisionedThroughput":{ + "type":"structure", + "required":[ + "ReadCapacityUnits", + "WriteCapacityUnits" + ], + "members":{ + "ReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

" + }, + "WriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

If read/write capacity mode is PAY_PER_REQUEST the value is set to 0.

" + } + }, + "documentation":"

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "ProvisionedThroughputDescription":{ + "type":"structure", + "members":{ + "LastIncreaseDateTime":{ + "shape":"Date", + "documentation":"

The date and time of the last provisioned throughput increase for this table.

" + }, + "LastDecreaseDateTime":{ + "shape":"Date", + "documentation":"

The date and time of the last provisioned throughput decrease for this table.

" + }, + "NumberOfDecreasesToday":{ + "shape":"PositiveLongObject", + "documentation":"

The number of provisioned throughput decreases for this table during this UTC calendar day. For current maximums on provisioned throughput decreases, see Limits in the Amazon DynamoDB Developer Guide.

" + }, + "ReadCapacityUnits":{ + "shape":"NonNegativeLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. Eventually consistent reads require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits per second provides 100 eventually consistent ReadCapacityUnits per second.

" + }, + "WriteCapacityUnits":{ + "shape":"NonNegativeLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + } + }, + "documentation":"

Represents the provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

You exceeded your maximum allowed provisioned throughput.

" + } + }, + "documentation":"

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", + "exception":true + }, + "Put":{ + "type":"structure", + "required":[ + "Item", + "TableName" + ], + "members":{ + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table in which to write the item.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

" + }, + "ReturnValuesOnConditionCheckFailure":{ + "shape":"ReturnValuesOnConditionCheckFailure", + "documentation":"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

" + } + }, + "documentation":"

Represents a request to perform a PutItem operation.

" + }, + "PutItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Item" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to contain the item.

" + }, + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the input of a PutItem operation.

" + }, + "PutItemInputAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "PutItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Read/Write Capacity Mode in the Amazon DynamoDB Developer Guide.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetrics", + "documentation":"

Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + } + }, + "documentation":"

Represents the output of a PutItem operation.

" + }, + "PutRequest":{ + "type":"structure", + "required":["Item"], + "members":{ + "Item":{ + "shape":"PutItemInputAttributeMap", + "documentation":"

A map of attribute name to attribute values, representing the primary key of an item to be processed by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item which are part of an index key schema for the table, their types must match the index key schema.

" + } + }, + "documentation":"

Represents a request to perform a PutItem operation on an item.

" + }, + "QueryInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested items.

" + }, + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

" + }, + "Select":{ + "shape":"Select", + "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" + }, + "KeyConditions":{ + "shape":"KeyConditions", + "documentation":"

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

" + }, + "QueryFilter":{ + "shape":"FilterConditionMap", + "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + }, + "ScanIndexForward":{ + "shape":"BooleanObject", + "documentation":"

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types are allowed.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "FilterExpression":{ + "shape":"ConditionExpression", + "documentation":"

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

" + }, + "KeyConditionExpression":{ + "shape":"KeyExpression", + "documentation":"

The condition that specifies the key values for items to be retrieved by the Query action.

The condition must perform an equality test on a single partition key value.

The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

The partition key equality test is required, and must be specified in the following format:

partitionKeyName = :partitionkeyval

If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval

Valid comparisons for the sort key condition are as follows:

  • sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.

  • sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.

  • sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.

  • sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.

  • sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.

  • sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.

  • begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

  • Size = :myval

To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

  • #S = :myval

For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the input of a Query operation.

" + }, + "QueryOutput":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

" + }, + "ScannedCount":{ + "shape":"Integer", + "documentation":"

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the output of a Query operation.

" + }, + "RegionName":{"type":"string"}, + "Replica":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The region where the replica needs to be created.

" + } + }, + "documentation":"

Represents the properties of a replica.

" + }, + "ReplicaAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified replica is already part of the global table.

", + "exception":true + }, + "ReplicaDescription":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The name of the region.

" + } + }, + "documentation":"

Contains the details of the replica.

" + }, + "ReplicaDescriptionList":{ + "type":"list", + "member":{"shape":"ReplicaDescription"} + }, + "ReplicaGlobalSecondaryIndexSettingsDescription":{ + "type":"structure", + "required":["IndexName"], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" + }, + "IndexStatus":{ + "shape":"IndexStatus", + "documentation":"

The current status of the global secondary index:

  • CREATING - The global secondary index is being created.

  • UPDATING - The global secondary index is being updated.

  • DELETING - The global secondary index is being deleted.

  • ACTIVE - The global secondary index is ready for use.

" + }, + "ProvisionedReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" + }, + "ProvisionedReadCapacityAutoScalingSettings":{ + "shape":"AutoScalingSettingsDescription", + "documentation":"

Autoscaling settings for a global secondary index replica's read capacity units.

" + }, + "ProvisionedWriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + }, + "ProvisionedWriteCapacityAutoScalingSettings":{ + "shape":"AutoScalingSettingsDescription", + "documentation":"

AutoScaling settings for a global secondary index replica's write capacity units.

" + } + }, + "documentation":"

Represents the properties of a global secondary index.

" + }, + "ReplicaGlobalSecondaryIndexSettingsDescriptionList":{ + "type":"list", + "member":{"shape":"ReplicaGlobalSecondaryIndexSettingsDescription"} + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate":{ + "type":"structure", + "required":["IndexName"], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index. The name must be unique among all other indexes on this table.

" + }, + "ProvisionedReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

" + }, + "ProvisionedReadCapacityAutoScalingSettingsUpdate":{ + "shape":"AutoScalingSettingsUpdate", + "documentation":"

Autoscaling settings for managing a global secondary index replica's read capacity units.

" + } + }, + "documentation":"

Represents the settings of a global secondary index for a global table that will be modified.

" + }, + "ReplicaGlobalSecondaryIndexSettingsUpdateList":{ + "type":"list", + "member":{"shape":"ReplicaGlobalSecondaryIndexSettingsUpdate"}, + "max":20, + "min":1 + }, + "ReplicaList":{ + "type":"list", + "member":{"shape":"Replica"} + }, + "ReplicaNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified replica is no longer part of the global table.

", + "exception":true + }, + "ReplicaSettingsDescription":{ + "type":"structure", + "required":["RegionName"], + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The region name of the replica.

" + }, + "ReplicaStatus":{ + "shape":"ReplicaStatus", + "documentation":"

The current state of the region:

  • CREATING - The region is being created.

  • UPDATING - The region is being updated.

  • DELETING - The region is being deleted.

  • ACTIVE - The region is ready for use.

" + }, + "ReplicaBillingModeSummary":{ + "shape":"BillingModeSummary", + "documentation":"

The read/write capacity mode of the replica.

" + }, + "ReplicaProvisionedReadCapacityUnits":{ + "shape":"NonNegativeLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" + }, + "ReplicaProvisionedReadCapacityAutoScalingSettings":{ + "shape":"AutoScalingSettingsDescription", + "documentation":"

Autoscaling settings for a global table replica's read capacity units.

" + }, + "ReplicaProvisionedWriteCapacityUnits":{ + "shape":"NonNegativeLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" + }, + "ReplicaProvisionedWriteCapacityAutoScalingSettings":{ + "shape":"AutoScalingSettingsDescription", + "documentation":"

AutoScaling settings for a global table replica's write capacity units.

" + }, + "ReplicaGlobalSecondaryIndexSettings":{ + "shape":"ReplicaGlobalSecondaryIndexSettingsDescriptionList", + "documentation":"

Replica global secondary index settings for the global table.

" + } + }, + "documentation":"

Represents the properties of a replica.

" + }, + "ReplicaSettingsDescriptionList":{ + "type":"list", + "member":{"shape":"ReplicaSettingsDescription"} + }, + "ReplicaSettingsUpdate":{ + "type":"structure", + "required":["RegionName"], + "members":{ + "RegionName":{ + "shape":"RegionName", + "documentation":"

The region of the replica to be added.

" + }, + "ReplicaProvisionedReadCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException. For more information, see Specifying Read and Write Requirements in the Amazon DynamoDB Developer Guide.

" + }, + "ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate":{ + "shape":"AutoScalingSettingsUpdate", + "documentation":"

Autoscaling settings for managing a global table replica's read capacity units.

" + }, + "ReplicaGlobalSecondaryIndexSettingsUpdate":{ + "shape":"ReplicaGlobalSecondaryIndexSettingsUpdateList", + "documentation":"

Represents the settings of a global secondary index for a global table that will be modified.

" + } + }, + "documentation":"

Represents the settings for a global table in a region that will be modified.

" + }, + "ReplicaSettingsUpdateList":{ + "type":"list", + "member":{"shape":"ReplicaSettingsUpdate"}, + "max":50, + "min":1 + }, + "ReplicaStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "ReplicaUpdate":{ + "type":"structure", + "members":{ + "Create":{ + "shape":"CreateReplicaAction", + "documentation":"

The parameters required for creating a replica on an existing global table.

" + }, + "Delete":{ + "shape":"DeleteReplicaAction", + "documentation":"

The name of the existing replica to be removed.

" + } + }, + "documentation":"

Represents one of the following:

  • A new replica to be added to an existing global table.

  • New parameters for an existing replica.

  • An existing replica to be removed from an existing global table.

" + }, + "ReplicaUpdateList":{ + "type":"list", + "member":{"shape":"ReplicaUpdate"} + }, + "RequestLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Throughput exceeds the current throughput limit for your account. Please contact AWS Support at AWS Support to request a limit increase.

", + "exception":true + }, + "ResourceArnString":{ + "type":"string", + "max":1283, + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The resource which is being attempted to be changed is in use.

" + } + }, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the CREATING state.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The resource which is being requested does not exist.

" + } + }, + "documentation":"

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

", + "exception":true + }, + "RestoreInProgress":{"type":"boolean"}, + "RestoreSummary":{ + "type":"structure", + "required":[ + "RestoreDateTime", + "RestoreInProgress" + ], + "members":{ + "SourceBackupArn":{ + "shape":"BackupArn", + "documentation":"

ARN of the backup from which the table was restored.

" + }, + "SourceTableArn":{ + "shape":"TableArn", + "documentation":"

ARN of the source table of the backup that is being restored.

" + }, + "RestoreDateTime":{ + "shape":"Date", + "documentation":"

Point in time or source backup time.

" + }, + "RestoreInProgress":{ + "shape":"RestoreInProgress", + "documentation":"

Indicates if a restore is in progress or not.

" + } + }, + "documentation":"

Contains details for the restore.

" + }, + "RestoreTableFromBackupInput":{ + "type":"structure", + "required":[ + "TargetTableName", + "BackupArn" + ], + "members":{ + "TargetTableName":{ + "shape":"TableName", + "documentation":"

The name of the new table to which the backup must be restored.

" + }, + "BackupArn":{ + "shape":"BackupArn", + "documentation":"

The Amazon Resource Name (ARN) associated with the backup.

" + } + } + }, + "RestoreTableFromBackupOutput":{ + "type":"structure", + "members":{ + "TableDescription":{ + "shape":"TableDescription", + "documentation":"

The description of the table created from an existing backup.

" + } + } + }, + "RestoreTableToPointInTimeInput":{ + "type":"structure", + "required":[ + "SourceTableName", + "TargetTableName" + ], + "members":{ + "SourceTableName":{ + "shape":"TableName", + "documentation":"

Name of the source table that is being restored.

" + }, + "TargetTableName":{ + "shape":"TableName", + "documentation":"

The name of the new table to which it must be restored to.

" + }, + "UseLatestRestorableTime":{ + "shape":"BooleanObject", + "documentation":"

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

" + }, + "RestoreDateTime":{ + "shape":"Date", + "documentation":"

Time in the past to restore the table to.

" + } + } + }, + "RestoreTableToPointInTimeOutput":{ + "type":"structure", + "members":{ + "TableDescription":{ + "shape":"TableDescription", + "documentation":"

Represents the properties of a table.

" + } + } + }, + "ReturnConsumedCapacity":{ + "type":"string", + "documentation":"

Determines the level of detail about provisioned throughput consumption that is returned in the response:

  • INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

    Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).

  • TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.

  • NONE - No ConsumedCapacity details are included in the response.

", + "enum":[ + "INDEXES", + "TOTAL", + "NONE" + ] + }, + "ReturnItemCollectionMetrics":{ + "type":"string", + "enum":[ + "SIZE", + "NONE" + ] + }, + "ReturnValue":{ + "type":"string", + "enum":[ + "NONE", + "ALL_OLD", + "UPDATED_OLD", + "ALL_NEW", + "UPDATED_NEW" + ] + }, + "ReturnValuesOnConditionCheckFailure":{ + "type":"string", + "enum":[ + "ALL_OLD", + "NONE" + ] + }, + "SSEDescription":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SSEStatus", + "documentation":"

Represents the current state of server-side encryption. The only supported values are:

  • ENABLED - Server-side encryption is enabled.

  • UPDATING - Server-side encryption is being updated.

" + }, + "SSEType":{ + "shape":"SSEType", + "documentation":"

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

" + }, + "KMSMasterKeyArn":{ + "shape":"KMSMasterKeyArn", + "documentation":"

The KMS customer master key (CMK) ARN used for the KMS encryption.

" + } + }, + "documentation":"

The description of the server-side encryption status on the specified table.

" + }, + "SSEEnabled":{"type":"boolean"}, + "SSESpecification":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"SSEEnabled", + "documentation":"

Indicates whether server-side encryption is done using an AWS managed CMK or an AWS owned CMK. If enabled (true), server-side encryption type is set to KMS and an AWS managed CMK is used (AWS KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned CMK.

" + }, + "SSEType":{ + "shape":"SSEType", + "documentation":"

Server-side encryption type. The only supported value is:

  • KMS - Server-side encryption which uses AWS Key Management Service. Key is stored in your account and is managed by AWS KMS (KMS charges apply).

" + }, + "KMSMasterKeyId":{ + "shape":"KMSMasterKeyId", + "documentation":"

The KMS Customer Master Key (CMK) which should be used for the KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB Customer Master Key alias/aws/dynamodb.

" + } + }, + "documentation":"

Represents the settings used to enable server-side encryption.

" + }, + "SSEStatus":{ + "type":"string", + "enum":[ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED", + "UPDATING" + ] + }, + "SSEType":{ + "type":"string", + "enum":[ + "AES256", + "KMS" + ] + }, + "ScalarAttributeType":{ + "type":"string", + "enum":[ + "S", + "N", + "B" + ] + }, + "ScanInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the requested items; or, if you provide IndexName, the name of the table to which that index belongs.

" + }, + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

" + }, + "AttributesToGet":{ + "shape":"AttributeNameList", + "documentation":"

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

" + }, + "Select":{ + "shape":"Select", + "documentation":"

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

  • ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.

  • ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.

  • COUNT - Returns the number of matching items, rather than the matching items themselves.

  • SPECIFIC_ATTRIBUTES - Returns only the attributes listed in AttributesToGet. This return value is equivalent to specifying AttributesToGet without specifying any value for Select.

    If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

    If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor AttributesToGet are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and AttributesToGet together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying AttributesToGet without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

" + }, + "ScanFilter":{ + "shape":"FilterConditionMap", + "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + }, + "ExclusiveStartKey":{ + "shape":"Key", + "documentation":"

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "TotalSegments":{ + "shape":"ScanTotalSegments", + "documentation":"

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

" + }, + "Segment":{ + "shape":"ScanSegment", + "documentation":"

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

" + }, + "ProjectionExpression":{ + "shape":"ProjectionExpression", + "documentation":"

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "FilterExpression":{ + "shape":"ConditionExpression", + "documentation":"

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + }, + "ConsistentRead":{ + "shape":"ConsistentRead", + "documentation":"

A Boolean value that determines the read consistency model during the scan:

  • If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).

  • If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

" + } + }, + "documentation":"

Represents the input of a Scan operation.

" + }, + "ScanOutput":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

" + }, + "ScannedCount":{ + "shape":"Integer", + "documentation":"

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

" + }, + "LastEvaluatedKey":{ + "shape":"Key", + "documentation":"

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the output of a Scan operation.

" + }, + "ScanSegment":{ + "type":"integer", + "max":999999, + "min":0 + }, + "ScanTotalSegments":{ + "type":"integer", + "max":1000000, + "min":1 + }, + "SecondaryIndexesCapacityMap":{ + "type":"map", + "key":{"shape":"IndexName"}, + "value":{"shape":"Capacity"} + }, + "Select":{ + "type":"string", + "enum":[ + "ALL_ATTRIBUTES", + "ALL_PROJECTED_ATTRIBUTES", + "SPECIFIC_ATTRIBUTES", + "COUNT" + ] + }, + "SourceTableDetails":{ + "type":"structure", + "required":[ + "TableName", + "TableId", + "KeySchema", + "TableCreationDateTime", + "ProvisionedThroughput" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table for which the backup was created.

" + }, + "TableId":{ + "shape":"TableId", + "documentation":"

Unique identifier for the table for which the backup was created.

" + }, + "TableArn":{ + "shape":"TableArn", + "documentation":"

ARN of the table for which backup was created.

" + }, + "TableSizeBytes":{ + "shape":"Long", + "documentation":"

Size of the table in bytes. Please note this is an approximate value.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

Schema of the table.

" + }, + "TableCreationDateTime":{ + "shape":"TableCreationDateTime", + "documentation":"

Time when the source table was created.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Read IOPs and Write IOPS on the table when the backup was created.

" + }, + "ItemCount":{ + "shape":"ItemCount", + "documentation":"

Number of items in the table. Please note this is an approximate value.

" + }, + "BillingMode":{ + "shape":"BillingMode", + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

  • PROVISIONED - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the read/write capacity mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

" + } + }, + "documentation":"

Contains the details of the table when the backup was created.

" + }, + "SourceTableFeatureDetails":{ + "type":"structure", + "members":{ + "LocalSecondaryIndexes":{ + "shape":"LocalSecondaryIndexes", + "documentation":"

Represents the LSI properties for the table when the backup was created. It includes the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"GlobalSecondaryIndexes", + "documentation":"

Represents the GSI properties for the table when the backup was created. It includes the IndexName, KeySchema, Projection and ProvisionedThroughput for the GSIs on the table at the time of backup.

" + }, + "StreamDescription":{ + "shape":"StreamSpecification", + "documentation":"

Stream settings on the table when the backup was created.

" + }, + "TimeToLiveDescription":{ + "shape":"TimeToLiveDescription", + "documentation":"

Time to Live settings on the table when the backup was created.

" + }, + "SSEDescription":{ + "shape":"SSEDescription", + "documentation":"

The description of the server-side encryption status on the table when the backup was created.

" + } + }, + "documentation":"

Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL.

" + }, + "StreamArn":{ + "type":"string", + "max":1024, + "min":37 + }, + "StreamEnabled":{"type":"boolean"}, + "StreamSpecification":{ + "type":"structure", + "members":{ + "StreamEnabled":{ + "shape":"StreamEnabled", + "documentation":"

Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.

" + }, + "StreamViewType":{ + "shape":"StreamViewType", + "documentation":"

When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Valid values for StreamViewType are:

  • KEYS_ONLY - Only the key attributes of the modified item are written to the stream.

  • NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.

  • OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.

  • NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

" + } + }, + "documentation":"

Represents the DynamoDB Streams configuration for a table in DynamoDB.

" + }, + "StreamViewType":{ + "type":"string", + "enum":[ + "NEW_IMAGE", + "OLD_IMAGE", + "NEW_AND_OLD_IMAGES", + "KEYS_ONLY" + ] + }, + "String":{"type":"string"}, + "StringAttributeValue":{"type":"string"}, + "StringSetAttributeValue":{ + "type":"list", + "member":{"shape":"StringAttributeValue"} + }, + "TableAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A target table with the specified name already exists.

", + "exception":true + }, + "TableArn":{"type":"string"}, + "TableCreationDateTime":{"type":"timestamp"}, + "TableDescription":{ + "type":"structure", + "members":{ + "AttributeDefinitions":{ + "shape":"AttributeDefinitions", + "documentation":"

An array of AttributeDefinition objects. Each of these objects describes one attribute in the table and index key schema.

Each AttributeDefinition object in this array is composed of:

  • AttributeName - The name of the attribute.

  • AttributeType - The data type for the attribute.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The primary key structure for the table. Each KeySchemaElement consists of:

  • AttributeName - The name of the attribute.

  • KeyType - The role of the attribute:

    • HASH - partition key

    • RANGE - sort key

    The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

    The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

" + }, + "TableStatus":{ + "shape":"TableStatus", + "documentation":"

The current state of the table:

  • CREATING - The table is being created.

  • UPDATING - The table is being updated.

  • DELETING - The table is being deleted.

  • ACTIVE - The table is ready for use.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the table was created, in UNIX epoch time format.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughputDescription", + "documentation":"

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

" + }, + "TableSizeBytes":{ + "shape":"Long", + "documentation":"

The total size of the specified table, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "ItemCount":{ + "shape":"Long", + "documentation":"

The number of items in the specified table. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

" + }, + "TableArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the table.

" + }, + "TableId":{ + "shape":"TableId", + "documentation":"

Unique identifier for the table for which the backup was created.

" + }, + "BillingModeSummary":{ + "shape":"BillingModeSummary", + "documentation":"

Contains the details for the read/write capacity mode.

" + }, + "LocalSecondaryIndexes":{ + "shape":"LocalSecondaryIndexDescriptionList", + "documentation":"

Represents one or more local secondary indexes on the table. Each index is scoped to a given partition key value. Tables with one or more local secondary indexes are subject to an item collection size limit, where the amount of data within a given item collection cannot exceed 10 GB. Each element is composed of:

  • IndexName - The name of the local secondary index.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • IndexSizeBytes - Represents the total size of the index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • ItemCount - Represents the number of items in the index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

If the table is in the DELETING state, no information about indexes will be returned.

" + }, + "GlobalSecondaryIndexes":{ + "shape":"GlobalSecondaryIndexDescriptionList", + "documentation":"

The global secondary indexes, if any, on the table. Each index is scoped to a given partition key value. Each element is composed of:

  • Backfilling - If true, then the index is currently in the backfilling phase. Backfilling occurs only when a new global secondary index is added to the table; it is the process by which DynamoDB populates the new index with data from the table. (This attribute does not appear for indexes that were created during a CreateTable operation.)

  • IndexName - The name of the global secondary index.

  • IndexSizeBytes - The total size of the global secondary index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • IndexStatus - The current status of the global secondary index:

    • CREATING - The index is being created.

    • UPDATING - The index is being updated.

    • DELETING - The index is being deleted.

    • ACTIVE - The index is ready for use.

  • ItemCount - The number of items in the global secondary index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • KeySchema - Specifies the complete index key schema. The attribute names in the key schema must be between 1 and 255 characters (inclusive). The key schema must begin with the same partition key as the table.

  • Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:

    • ProjectionType - One of the following:

      • KEYS_ONLY - Only the index and primary keys are projected into the index.

      • INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes are in NonKeyAttributes.

      • ALL - All of the table attributes are projected into the index.

    • NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 20. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

  • ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.

If the table is in the DELETING state, no information about indexes will be returned.

" + }, + "StreamSpecification":{ + "shape":"StreamSpecification", + "documentation":"

The current DynamoDB Streams configuration for the table.

" + }, + "LatestStreamLabel":{ + "shape":"String", + "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name.

  • the StreamLabel.

" + }, + "LatestStreamArn":{ + "shape":"StreamArn", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.

" + }, + "RestoreSummary":{ + "shape":"RestoreSummary", + "documentation":"

Contains details for the restore.

" + }, + "SSEDescription":{ + "shape":"SSEDescription", + "documentation":"

The description of the server-side encryption status on the specified table.

" + } + }, + "documentation":"

Represents the properties of a table.

" + }, + "TableId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "TableInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A target table with the specified name is either being created or deleted.

", + "exception":true + }, + "TableName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TableNameList":{ + "type":"list", + "member":{"shape":"TableName"} + }, + "TableNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A source table with the name TableName does not currently exist within the subscriber's account.

", + "exception":true + }, + "TableStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "DELETING", + "ACTIVE" + ] + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKeyString", + "documentation":"

The key of the tag. Tag keys are case sensitive. Each DynamoDB table can only have up to one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.

" + }, + "Value":{ + "shape":"TagValueString", + "documentation":"

The value of the tag. Tag values are case-sensitive and can be null.

" + } + }, + "documentation":"

Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single DynamoDB table.

AWS-assigned tag names and values are automatically assigned the aws: prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix user: in the Cost Allocation Report. You cannot backdate the application of a tag.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKeyString"} + }, + "TagKeyString":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the Amazon DynamoDB resource.

" + } + } + }, + "TagValueString":{ + "type":"string", + "max":256, + "min":0 + }, + "TimeRangeLowerBound":{"type":"timestamp"}, + "TimeRangeUpperBound":{"type":"timestamp"}, + "TimeToLiveAttributeName":{ + "type":"string", + "max":255, + "min":1 + }, + "TimeToLiveDescription":{ + "type":"structure", + "members":{ + "TimeToLiveStatus":{ + "shape":"TimeToLiveStatus", + "documentation":"

The TTL status for the table.

" + }, + "AttributeName":{ + "shape":"TimeToLiveAttributeName", + "documentation":"

The name of the TTL attribute for items in the table.

" + } + }, + "documentation":"

The description of the Time to Live (TTL) status on the specified table.

" + }, + "TimeToLiveEnabled":{"type":"boolean"}, + "TimeToLiveSpecification":{ + "type":"structure", + "required":[ + "Enabled", + "AttributeName" + ], + "members":{ + "Enabled":{ + "shape":"TimeToLiveEnabled", + "documentation":"

Indicates whether TTL is to be enabled (true) or disabled (false) on the table.

" + }, + "AttributeName":{ + "shape":"TimeToLiveAttributeName", + "documentation":"

The name of the TTL attribute used to store the expiration time for items in the table.

" + } + }, + "documentation":"

Represents the settings used to enable or disable Time to Live (TTL) for the specified table.

" + }, + "TimeToLiveStatus":{ + "type":"string", + "enum":[ + "ENABLING", + "DISABLING", + "ENABLED", + "DISABLED" + ] + }, + "TransactGetItem":{ + "type":"structure", + "required":["Get"], + "members":{ + "Get":{ + "shape":"Get", + "documentation":"

Contains the primary key that identifies the item to get, together with the name of the table that contains the item, and optionally the specific attributes of the item to retrieve.

" + } + }, + "documentation":"

Specifies an item to be retrieved as part of the transaction.

" + }, + "TransactGetItemList":{ + "type":"list", + "member":{"shape":"TransactGetItem"}, + "max":10, + "min":1 + }, + "TransactGetItemsInput":{ + "type":"structure", + "required":["TransactItems"], + "members":{ + "TransactItems":{ + "shape":"TransactGetItemList", + "documentation":"

An ordered array of up to 25 TransactGetItem objects, each of which contains a Get structure.

" + }, + "ReturnConsumedCapacity":{ + "shape":"ReturnConsumedCapacity", + "documentation":"

A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid.

" + } + } + }, + "TransactGetItemsOutput":{ + "type":"structure", + "members":{ + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

" + }, + "Responses":{ + "shape":"ItemResponseList", + "documentation":"

An ordered array of up to 25 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

" + } + } + }, + "TransactWriteItem":{ + "type":"structure", + "members":{ + "ConditionCheck":{ + "shape":"ConditionCheck", + "documentation":"

A request to perform a check item operation.

" + }, + "Put":{ + "shape":"Put", + "documentation":"

A request to perform a PutItem operation.

" + }, + "Delete":{ + "shape":"Delete", + "documentation":"

A request to perform a DeleteItem operation.

" + }, + "Update":{ + "shape":"Update", + "documentation":"

A request to perform an UpdateItem operation.

" + } + }, + "documentation":"

A list of requests that can perform update, put, delete, or check operations on multiple items in one or more tables atomically.

" + }, + "TransactWriteItemList":{ + "type":"list", + "member":{"shape":"TransactWriteItem"}, + "max":10, + "min":1 + }, + "TransactWriteItemsInput":{ + "type":"structure", + "required":["TransactItems"], + "members":{ + "TransactItems":{ + "shape":"TransactWriteItemList", + "documentation":"

An ordered array of up to 25 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same AWS account and Region, and no two of them can operate on the same item.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity> parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

", + "idempotencyToken":true + } + } + }, + "TransactWriteItemsOutput":{ + "type":"structure", + "members":{ + "ConsumedCapacity":{ + "shape":"ConsumedCapacityMultiple", + "documentation":"

The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetricsPerTable", + "documentation":"

A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem, or DeleteItem operations.

" + } + } + }, + "TransactionCanceledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "CancellationReasons":{ + "shape":"CancellationReasonList", + "documentation":"

A list of cancellation reasons.

" + } + }, + "documentation":"

The entire transaction request was canceled.

DynamoDB cancels a TransactWriteItems request under the following circumstances:

  • A condition in one of the condition expressions is not met.

  • A table in the TransactWriteItems request is in a different account or region.

  • More than one action in the TransactWriteItems operation targets the same item.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

  • The aggregate size of the items in the transaction exceeds 4 MBs.

  • There is a user error, such as an invalid data format.

DynamoDB cancels a TransactGetItems request under the following circumstances:

  • There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

  • A table in the TransactGetItems request is in a different account or region.

  • There is insufficient provisioned capacity for the transaction to be completed.

  • The aggregate size of the items in the transaction exceeds 4 MBs.

  • There is a user error, such as an invalid data format.

If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have NONE code and Null message.

Cancellation reason codes and possible error messages:

  • No Errors:

    • Code: NONE

    • Message: null

  • Conditional Check Failed:

    • Code: ConditionalCheckFailed

    • Message: The conditional request failed.

  • Item Collection Size Limit Exceeded:

    • Code: ItemCollectionSizeLimitExceeded

    • Message: Collection size exceeded.

  • Transaction Conflict:

    • Code: TransactionConflict

    • Message: Transaction is ongoing for the item.

  • Provisioned Throughput Exceeded:

    • Code: ProvisionedThroughputExceeded

    • Messages:

      • The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.

        This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.

      • The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.

        This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

  • Throttling Error:

    • Code: ThrottlingError

    • Messages:

      • Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.

        This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.

      • Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.

        This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

  • Validation Error:

    • Code: ValidationError

    • Messages:

      • One or more parameter values were invalid.

      • The update expression attempted to update the secondary index key beyond allowed size limits.

      • The update expression attempted to update the secondary index key to unsupported type.

      • An operand in the update expression has an incorrect data type.

      • Item size to update has exceeded the maximum allowed size.

      • Number overflow. Attempting to store a number with magnitude larger than supported range.

      • Type mismatch for attribute to update.

      • Nesting Levels have exceeded supported limits.

      • The document path provided in the update expression is invalid for update.

      • The provided expression refers to an attribute that does not exist in the item.

", + "exception":true + }, + "TransactionConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Operation was rejected because there is an ongoing transaction for the item.

", + "exception":true + }, + "TransactionInProgressException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The transaction with the given request token is already in progress.

", + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.

" + } + } + }, + "Update":{ + "type":"structure", + "required":[ + "Key", + "UpdateExpression", + "TableName" + ], + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

" + }, + "UpdateExpression":{ + "shape":"UpdateExpression", + "documentation":"

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

Name of the table for the UpdateItem request.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

" + }, + "ReturnValuesOnConditionCheckFailure":{ + "shape":"ReturnValuesOnConditionCheckFailure", + "documentation":"

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.

" + } + }, + "documentation":"

Represents a request to perform an UpdateItem operation.

" + }, + "UpdateContinuousBackupsInput":{ + "type":"structure", + "required":[ + "TableName", + "PointInTimeRecoverySpecification" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table.

" + }, + "PointInTimeRecoverySpecification":{ + "shape":"PointInTimeRecoverySpecification", + "documentation":"

Represents the settings used to enable point in time recovery.

" + } + } + }, + "UpdateContinuousBackupsOutput":{ + "type":"structure", + "members":{ + "ContinuousBackupsDescription":{ + "shape":"ContinuousBackupsDescription", + "documentation":"

Represents the continuous backups and point in time recovery settings on the table.

" + } + } + }, + "UpdateExpression":{"type":"string"}, + "UpdateGlobalSecondaryIndexAction":{ + "type":"structure", + "required":[ + "IndexName", + "ProvisionedThroughput" + ], + "members":{ + "IndexName":{ + "shape":"IndexName", + "documentation":"

The name of the global secondary index to be updated.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the new provisioned throughput settings to be applied to a global secondary index.

" + }, + "UpdateGlobalTableInput":{ + "type":"structure", + "required":[ + "GlobalTableName", + "ReplicaUpdates" + ], + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The global table name.

" + }, + "ReplicaUpdates":{ + "shape":"ReplicaUpdateList", + "documentation":"

A list of Regions that should be added or removed from the global table.

" + } + } + }, + "UpdateGlobalTableOutput":{ + "type":"structure", + "members":{ + "GlobalTableDescription":{ + "shape":"GlobalTableDescription", + "documentation":"

Contains the details of the global table.

" + } + } + }, + "UpdateGlobalTableSettingsInput":{ + "type":"structure", + "required":["GlobalTableName"], + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The name of the global table

" + }, + "GlobalTableBillingMode":{ + "shape":"BillingMode", + "documentation":"

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

" + }, + "GlobalTableProvisionedWriteCapacityUnits":{ + "shape":"PositiveLongObject", + "documentation":"

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

" + }, + "GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate":{ + "shape":"AutoScalingSettingsUpdate", + "documentation":"

Auto scaling settings for managing provisioned write capacity for the global table.

" + }, + "GlobalTableGlobalSecondaryIndexSettingsUpdate":{ + "shape":"GlobalTableGlobalSecondaryIndexSettingsUpdateList", + "documentation":"

Represents the settings of a global secondary index for a global table that will be modified.

" + }, + "ReplicaSettingsUpdate":{ + "shape":"ReplicaSettingsUpdateList", + "documentation":"

Represents the settings for a global table in a Region that will be modified.

" + } + } + }, + "UpdateGlobalTableSettingsOutput":{ + "type":"structure", + "members":{ + "GlobalTableName":{ + "shape":"TableName", + "documentation":"

The name of the global table.

" + }, + "ReplicaSettings":{ + "shape":"ReplicaSettingsDescriptionList", + "documentation":"

The Region-specific settings for the global table.

" + } + } + }, + "UpdateItemInput":{ + "type":"structure", + "required":[ + "TableName", + "Key" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table containing the item to update.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

" + }, + "AttributeUpdates":{ + "shape":"AttributeUpdates", + "documentation":"

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

" + }, + "Expected":{ + "shape":"ExpectedAttributeMap", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionalOperator":{ + "shape":"ConditionalOperator", + "documentation":"

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

" + }, + "ReturnValues":{ + "shape":"ReturnValue", + "documentation":"

Use ReturnValues if you want to get the item attributes as they appear before or after they are updated. For UpdateItem, the valid values are:

  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)

  • ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.

  • UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.

  • ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.

  • UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

" + }, + "ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"}, + "ReturnItemCollectionMetrics":{ + "shape":"ReturnItemCollectionMetrics", + "documentation":"

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set to NONE (the default), no statistics are returned.

" + }, + "UpdateExpression":{ + "shape":"UpdateExpression", + "documentation":"

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

  • SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

    SET supports the following functions:

    • if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.

    • list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.

    These function names are case-sensitive.

  • REMOVE - Removes one or more attributes from an item.

  • ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:

    • If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.

      If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.

      Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.

    • If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.

      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.

    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.

  • DELETE - Deletes an element from a set.

    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

    The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ConditionExpression":{ + "shape":"ConditionExpression", + "documentation":"

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

  • Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

    These function names are case-sensitive.

  • Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN

  • Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeNames":{ + "shape":"ExpressionAttributeNameMap", + "documentation":"

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

  • To access an attribute whose name conflicts with a DynamoDB reserved word.

  • To create a placeholder for repeating occurrences of an attribute name in an expression.

  • To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

  • Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

  • {\"#P\":\"Percentile\"}

You could then use this substitution in an expression, as in this example:

  • #P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

" + }, + "ExpressionAttributeValues":{ + "shape":"ExpressionAttributeValueMap", + "documentation":"

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ \":avail\":{\"S\":\"Available\"}, \":back\":{\"S\":\"Backordered\"}, \":disc\":{\"S\":\"Discontinued\"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

" + } + }, + "documentation":"

Represents the input of an UpdateItem operation.

" + }, + "UpdateItemOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

" + }, + "ConsumedCapacity":{ + "shape":"ConsumedCapacity", + "documentation":"

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned Throughput in the Amazon DynamoDB Developer Guide.

" + }, + "ItemCollectionMetrics":{ + "shape":"ItemCollectionMetrics", + "documentation":"

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

  • ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.

  • SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

    The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

" + } + }, + "documentation":"

Represents the output of an UpdateItem operation.

" + }, + "UpdateTableInput":{ + "type":"structure", + "required":["TableName"], + "members":{ + "AttributeDefinitions":{ + "shape":"AttributeDefinitions", + "documentation":"

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to be updated.

" + }, + "BillingMode":{ + "shape":"BillingMode", + "documentation":"

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

  • PROVISIONED - Sets the billing mode to PROVISIONED. We recommend using PROVISIONED for predictable workloads.

  • PAY_PER_REQUEST - Sets the billing mode to PAY_PER_REQUEST. We recommend using PAY_PER_REQUEST for unpredictable workloads.

" + }, + "ProvisionedThroughput":{ + "shape":"ProvisionedThroughput", + "documentation":"

The new provisioned throughput settings for the specified table or index.

" + }, + "GlobalSecondaryIndexUpdates":{ + "shape":"GlobalSecondaryIndexUpdateList", + "documentation":"

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

  • Create - add a new global secondary index to the table.

  • Update - modify the provisioned throughput settings of an existing global secondary index.

  • Delete - remove a global secondary index from the table.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

" + }, + "StreamSpecification":{ + "shape":"StreamSpecification", + "documentation":"

Represents the DynamoDB Streams configuration for the table.

You receive a ResourceInUseException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

" + }, + "SSESpecification":{ + "shape":"SSESpecification", + "documentation":"

The new server-side encryption settings for the specified table.

" + } + }, + "documentation":"

Represents the input of an UpdateTable operation.

" + }, + "UpdateTableOutput":{ + "type":"structure", + "members":{ + "TableDescription":{ + "shape":"TableDescription", + "documentation":"

Represents the properties of the table.

" + } + }, + "documentation":"

Represents the output of an UpdateTable operation.

" + }, + "UpdateTimeToLiveInput":{ + "type":"structure", + "required":[ + "TableName", + "TimeToLiveSpecification" + ], + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

The name of the table to be configured.

" + }, + "TimeToLiveSpecification":{ + "shape":"TimeToLiveSpecification", + "documentation":"

Represents the settings used to enable or disable Time to Live for the specified table.

" + } + }, + "documentation":"

Represents the input of an UpdateTimeToLive operation.

" + }, + "UpdateTimeToLiveOutput":{ + "type":"structure", + "members":{ + "TimeToLiveSpecification":{ + "shape":"TimeToLiveSpecification", + "documentation":"

Represents the output of an UpdateTimeToLive operation.

" + } + } + }, + "WriteRequest":{ + "type":"structure", + "members":{ + "PutRequest":{ + "shape":"PutRequest", + "documentation":"

A request to perform a PutItem operation.

" + }, + "DeleteRequest":{ + "shape":"DeleteRequest", + "documentation":"

A request to perform a DeleteItem operation.

" + } + }, + "documentation":"

Represents an operation to perform - either DeleteItem or PutItem. You can only request one of these operations, not both, in a single WriteRequest. If you do need to perform both of these operations, you will need to provide two separate WriteRequest objects.

" + }, + "WriteRequests":{ + "type":"list", + "member":{"shape":"WriteRequest"}, + "max":25, + "min":1 + } + }, + "documentation":"Amazon DynamoDB

Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. DynamoDB lets you offload the administrative burdens of operating and scaling a distributed database, so that you don't have to worry about hardware provisioning, setup and configuration, replication, software patching, or cluster scaling.

With DynamoDB, you can create database tables that can store and retrieve any amount of data, and serve any level of request traffic. You can scale up or scale down your tables' throughput capacity without downtime or performance degradation, and use the AWS Management Console to monitor resource utilization and performance metrics.

DynamoDB automatically spreads the data and traffic for your tables over a sufficient number of servers to handle your throughput and storage requirements, while maintaining consistent and fast performance. All of your data is stored on solid state disks (SSDs) and automatically replicated across multiple Availability Zones in an AWS region, providing built-in high availability and data durability.

" +} diff --git a/aws/dist/botocore/data/dynamodb/2012-08-10/waiters-2.json b/aws/dist/botocore/data/dynamodb/2012-08-10/waiters-2.json new file mode 100644 index 00000000..43a55ca7 --- /dev/null +++ b/aws/dist/botocore/data/dynamodb/2012-08-10/waiters-2.json @@ -0,0 +1,35 @@ +{ + "version": 2, + "waiters": { + "TableExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "Table.TableStatus" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "retry" + } + ] + }, + "TableNotExists": { + "delay": 20, + "operation": "DescribeTable", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/dynamodbstreams/2012-08-10/examples-1.json b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/examples-1.json new file mode 100644 index 00000000..8287e2c4 --- /dev/null +++ b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/examples-1.json @@ -0,0 +1,212 @@ +{ + "version": "1.0", + "examples": { + "DescribeStream": [ + { + "input": { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252" + }, + "output": { + "StreamDescription": { + "CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015", + "KeySchema": [ + { + "AttributeName": "ForumName", + "KeyType": "HASH" + }, + { + "AttributeName": "Subject", + "KeyType": "RANGE" + } + ], + "Shards": [ + { + "SequenceNumberRange": { + "EndingSequenceNumber": "20500000000000000910398", + "StartingSequenceNumber": "20500000000000000910398" + }, + "ShardId": "shardId-00000001414562045508-2bac9cd2" + }, + { + "ParentShardId": "shardId-00000001414562045508-2bac9cd2", + "SequenceNumberRange": { + "EndingSequenceNumber": "820400000000000001192334", + "StartingSequenceNumber": "820400000000000001192334" + }, + "ShardId": "shardId-00000001414576573621-f55eea83" + }, + { + "ParentShardId": "shardId-00000001414576573621-f55eea83", + "SequenceNumberRange": { + "EndingSequenceNumber": "1683700000000000001135967", + "StartingSequenceNumber": "1683700000000000001135967" + }, + "ShardId": "shardId-00000001414592258131-674fd923" + }, + { + "ParentShardId": "shardId-00000001414592258131-674fd923", + "SequenceNumberRange": { + "StartingSequenceNumber": "2574600000000000000935255" + }, + "ShardId": "shardId-00000001414608446368-3a1afbaf" + } + ], + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", + "StreamLabel": "2015-05-20T20:51:10.252", + "StreamStatus": "ENABLED", + "StreamViewType": "NEW_AND_OLD_IMAGES", + "TableName": "Forum" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example describes a stream with a given stream ARN.", + "id": "to-describe-a-stream-with-a-given-stream-arn-1473457835200", + "title": "To describe a stream with a given stream ARN" + } + ], + "GetRecords": [ + { + "input": { + "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... ..." + }, + "output": { + "NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... ...", + "Records": [ + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480646E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 3" + } + }, + "SequenceNumber": "300000000000000499659", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "e2fd9c34eff2d779b297b26f5fef4206", + "eventName": "INSERT", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + }, + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480527E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 1" + } + }, + "SequenceNumber": "400000000000000499660", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "4b25bd0da9a181a155114127e4837252", + "eventName": "MODIFY", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + }, + { + "awsRegion": "us-west-2", + "dynamodb": { + "ApproximateCreationDateTime": "1.46480646E9", + "Keys": { + "ForumName": { + "S": "DynamoDB" + }, + "Subject": { + "S": "DynamoDB Thread 2" + } + }, + "SequenceNumber": "500000000000000499661", + "SizeBytes": 41, + "StreamViewType": "KEYS_ONLY" + }, + "eventID": "740280c73a3df7842edab3548a1b08ad", + "eventName": "REMOVE", + "eventSource": "aws:dynamodb", + "eventVersion": "1.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves all the stream records from a shard.", + "id": "to-retrieve-all-the-stream-records-from-a-shard-1473707781419", + "title": "To retrieve all the stream records from a shard" + } + ], + "GetShardIterator": [ + { + "input": { + "ShardId": "00000001414576573621-f55eea83", + "ShardIteratorType": "TRIM_HORIZON", + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252" + }, + "output": { + "ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... ..." + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a shard iterator for the provided stream ARN and shard ID.", + "id": "to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476", + "title": "To obtain a shard iterator for the provided stream ARN and shard ID" + } + ], + "ListStreams": [ + { + "input": { + }, + "output": { + "Streams": [ + { + "StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252", + "StreamLabel": "2015-05-20T20:51:10.252", + "TableName": "Forum" + }, + { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714", + "StreamLabel": "2015-05-20T20:50:02.714", + "TableName": "Forum" + }, + { + "StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641", + "StreamLabel": "2015-05-19T23:03:50.641", + "TableName": "Forum" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists all of the stream ARNs.", + "id": "to-list-all-of-the-stream-arns--1473459534285", + "title": "To list all of the stream ARNs " + } + ] + } +} diff --git a/aws/dist/botocore/data/dynamodbstreams/2012-08-10/paginators-1.json b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/dynamodbstreams/2012-08-10/service-2.json b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/service-2.json new file mode 100644 index 00000000..c8112d65 --- /dev/null +++ b/aws/dist/botocore/data/dynamodbstreams/2012-08-10/service-2.json @@ -0,0 +1,638 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-08-10", + "endpointPrefix":"streams.dynamodb", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"Amazon DynamoDB Streams", + "serviceId":"DynamoDB Streams", + "signatureVersion":"v4", + "signingName":"dynamodb", + "targetPrefix":"DynamoDBStreams_20120810", + "uid":"streams-dynamodb-2012-08-10" + }, + "operations":{ + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamInput"}, + "output":{"shape":"DescribeStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.

You can call DescribeStream at a maximum rate of 10 times per second.

Each shard in the stream has a SequenceNumberRange associated with it. If the SequenceNumberRange has a StartingSequenceNumber but no EndingSequenceNumber, then the shard is still open (able to receive more stream records). If both StartingSequenceNumber and EndingSequenceNumber are present, then that shard is closed and can no longer receive more data.

" + }, + "GetRecords":{ + "name":"GetRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRecordsInput"}, + "output":{"shape":"GetRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"ExpiredIteratorException"}, + {"shape":"TrimmedDataAccessException"} + ], + "documentation":"

Retrieves the stream records from a given shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading stream records sequentially. If there are no stream records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. Note that it might take multiple calls to get to a portion of the shard that contains stream records.

GetRecords can retrieve a maximum of 1 MB of data or 1000 stream records, whichever comes first.

" + }, + "GetShardIterator":{ + "name":"GetShardIterator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetShardIteratorInput"}, + "output":{"shape":"GetShardIteratorOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"}, + {"shape":"TrimmedDataAccessException"} + ], + "documentation":"

Returns a shard iterator. A shard iterator provides information about how to retrieve the stream records from within a shard. Use the shard iterator in a subsequent GetRecords request to read the stream records from the shard.

A shard iterator expires 15 minutes after it is returned to the requester.

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamsInput"}, + "output":{"shape":"ListStreamsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns an array of stream ARNs associated with the current account and endpoint. If the TableName parameter is present, then ListStreams will return only the streams ARNs for that table.

You can call ListStreams at a maximum rate of 5 times per second.

" + } + }, + "shapes":{ + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributeName":{ + "type":"string", + "max":65535 + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{ + "shape":"StringAttributeValue", + "documentation":"

A String data type.

" + }, + "N":{ + "shape":"NumberAttributeValue", + "documentation":"

A Number data type.

" + }, + "B":{ + "shape":"BinaryAttributeValue", + "documentation":"

A Binary data type.

" + }, + "SS":{ + "shape":"StringSetAttributeValue", + "documentation":"

A String Set data type.

" + }, + "NS":{ + "shape":"NumberSetAttributeValue", + "documentation":"

A Number Set data type.

" + }, + "BS":{ + "shape":"BinarySetAttributeValue", + "documentation":"

A Binary Set data type.

" + }, + "M":{ + "shape":"MapAttributeValue", + "documentation":"

A Map data type.

" + }, + "L":{ + "shape":"ListAttributeValue", + "documentation":"

A List data type.

" + }, + "NULL":{ + "shape":"NullAttributeValue", + "documentation":"

A Null data type.

" + }, + "BOOL":{ + "shape":"BooleanAttributeValue", + "documentation":"

A Boolean data type.

" + } + }, + "documentation":"

Represents the data for an attribute. You can set one, and only one, of the elements.

Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.

" + }, + "BinaryAttributeValue":{"type":"blob"}, + "BinarySetAttributeValue":{ + "type":"list", + "member":{"shape":"BinaryAttributeValue"} + }, + "BooleanAttributeValue":{"type":"boolean"}, + "Date":{"type":"timestamp"}, + "DescribeStreamInput":{ + "type":"structure", + "required":["StreamArn"], + "members":{ + "StreamArn":{ + "shape":"StreamArn", + "documentation":"

The Amazon Resource Name (ARN) for the stream.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of shard objects to return. The upper limit is 100.

" + }, + "ExclusiveStartShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedShardId in the previous operation.

" + } + }, + "documentation":"

Represents the input of a DescribeStream operation.

" + }, + "DescribeStreamOutput":{ + "type":"structure", + "members":{ + "StreamDescription":{ + "shape":"StreamDescription", + "documentation":"

A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.

" + } + }, + "documentation":"

Represents the output of a DescribeStream operation.

" + }, + "ErrorMessage":{"type":"string"}, + "ExpiredIteratorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The provided iterator exceeds the maximum age allowed.

" + } + }, + "documentation":"

The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the GetShardIterator action.

", + "exception":true + }, + "GetRecordsInput":{ + "type":"structure", + "required":["ShardIterator"], + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of records to return from the shard. The upper limit is 1000.

" + } + }, + "documentation":"

Represents the input of a GetRecords operation.

" + }, + "GetRecordsOutput":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"

The stream records from the shard, which were retrieved using the shard iterator.

" + }, + "NextShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The next position in the shard from which to start sequentially reading stream records. If set to null, the shard has been closed and the requested iterator will not return any more data.

" + } + }, + "documentation":"

Represents the output of a GetRecords operation.

" + }, + "GetShardIteratorInput":{ + "type":"structure", + "required":[ + "StreamArn", + "ShardId", + "ShardIteratorType" + ], + "members":{ + "StreamArn":{ + "shape":"StreamArn", + "documentation":"

The Amazon Resource Name (ARN) for the stream.

" + }, + "ShardId":{ + "shape":"ShardId", + "documentation":"

The identifier of the shard. The iterator will be returned for this shard ID.

" + }, + "ShardIteratorType":{ + "shape":"ShardIteratorType", + "documentation":"

Determines how the shard iterator is used to start reading stream records from the shard:

  • AT_SEQUENCE_NUMBER - Start reading exactly from the position denoted by a specific sequence number.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number.

  • TRIM_HORIZON - Start reading at the last (untrimmed) stream record, which is the oldest record in the shard. In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream.

  • LATEST - Start reading just after the most recent stream record in the shard, so that you always read the most recent data in the shard.

" + }, + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number of a stream record in the shard from which to start reading.

" + } + }, + "documentation":"

Represents the input of a GetShardIterator operation.

" + }, + "GetShardIteratorOutput":{ + "type":"structure", + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.

" + } + }, + "documentation":"

Represents the output of a GetShardIterator operation.

" + }, + "Identity":{ + "type":"structure", + "members":{ + "PrincipalId":{ + "shape":"String", + "documentation":"

A unique identifier for the entity that made the call. For Time To Live, the principalId is \"dynamodb.amazonaws.com\".

" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of the identity. For Time To Live, the type is \"Service\".

" + } + }, + "documentation":"

Contains details about the type of identity that made the request.

" + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The server encountered an internal error trying to fulfill the request.

" + } + }, + "documentation":"

An error occurred on the server side.

", + "exception":true, + "fault":true + }, + "KeySchema":{ + "type":"list", + "member":{"shape":"KeySchemaElement"}, + "max":2, + "min":1 + }, + "KeySchemaAttributeName":{ + "type":"string", + "max":255, + "min":1 + }, + "KeySchemaElement":{ + "type":"structure", + "required":[ + "AttributeName", + "KeyType" + ], + "members":{ + "AttributeName":{ + "shape":"KeySchemaAttributeName", + "documentation":"

The name of a key attribute.

" + }, + "KeyType":{ + "shape":"KeyType", + "documentation":"

The attribute data, consisting of the data type and the attribute value itself.

" + } + }, + "documentation":"

Represents a single element of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.

A KeySchemaElement represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one KeySchemaElement. A composite primary key (partition key and sort key) would require one KeySchemaElement for the partition key, and another KeySchemaElement for the sort key.

The partition key of an item is also known as its hash attribute. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

" + }, + "KeyType":{ + "type":"string", + "enum":[ + "HASH", + "RANGE" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Too many operations for a given subscriber.

" + } + }, + "documentation":"

Your request rate is too high. The AWS SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

", + "exception":true + }, + "ListAttributeValue":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"TableName", + "documentation":"

If this parameter is provided, then only the streams associated with this table name are returned.

" + }, + "Limit":{ + "shape":"PositiveIntegerObject", + "documentation":"

The maximum number of streams to return. The upper limit is 100.

" + }, + "ExclusiveStartStreamArn":{ + "shape":"StreamArn", + "documentation":"

The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedStreamArn in the previous operation.

" + } + }, + "documentation":"

Represents the input of a ListStreams operation.

" + }, + "ListStreamsOutput":{ + "type":"structure", + "members":{ + "Streams":{ + "shape":"StreamList", + "documentation":"

A list of stream descriptors associated with the current account and endpoint.

" + }, + "LastEvaluatedStreamArn":{ + "shape":"StreamArn", + "documentation":"

The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedStreamArn is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedStreamArn is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedStreamArn is empty.

" + } + }, + "documentation":"

Represents the output of a ListStreams operation.

" + }, + "MapAttributeValue":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "NullAttributeValue":{"type":"boolean"}, + "NumberAttributeValue":{"type":"string"}, + "NumberSetAttributeValue":{ + "type":"list", + "member":{"shape":"NumberAttributeValue"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "INSERT", + "MODIFY", + "REMOVE" + ] + }, + "PositiveIntegerObject":{ + "type":"integer", + "min":1 + }, + "PositiveLongObject":{ + "type":"long", + "min":1 + }, + "Record":{ + "type":"structure", + "members":{ + "eventID":{ + "shape":"String", + "documentation":"

A globally unique identifier for the event that was recorded in this stream record.

" + }, + "eventName":{ + "shape":"OperationType", + "documentation":"

The type of data modification that was performed on the DynamoDB table:

  • INSERT - a new item was added to the table.

  • MODIFY - one or more of an existing item's attributes were modified.

  • REMOVE - the item was deleted from the table

" + }, + "eventVersion":{ + "shape":"String", + "documentation":"

The version number of the stream record format. This number is updated whenever the structure of Record is modified.

Client applications must not assume that eventVersion will remain at a particular value, as this number is subject to change at any time. In general, eventVersion will only increase as the low-level DynamoDB Streams API evolves.

" + }, + "eventSource":{ + "shape":"String", + "documentation":"

The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

" + }, + "awsRegion":{ + "shape":"String", + "documentation":"

The region in which the GetRecords request was received.

" + }, + "dynamodb":{ + "shape":"StreamRecord", + "documentation":"

The main body of the stream record, containing all of the DynamoDB-specific fields.

" + }, + "userIdentity":{ + "shape":"Identity", + "documentation":"

Items that are deleted by the Time to Live process after expiration have the following fields:

  • Records[].userIdentity.type

    \"Service\"

  • Records[].userIdentity.principalId

    \"dynamodb.amazonaws.com\"

" + } + }, + "documentation":"

A description of a unique event within a stream.

" + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The resource which is being requested does not exist.

" + } + }, + "documentation":"

The operation tried to access a nonexistent stream.

", + "exception":true + }, + "SequenceNumber":{ + "type":"string", + "max":40, + "min":21 + }, + "SequenceNumberRange":{ + "type":"structure", + "members":{ + "StartingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The first sequence number.

" + }, + "EndingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The last sequence number.

" + } + }, + "documentation":"

The beginning and ending sequence numbers for the stream records contained within a shard.

" + }, + "Shard":{ + "type":"structure", + "members":{ + "ShardId":{ + "shape":"ShardId", + "documentation":"

The system-generated identifier for this shard.

" + }, + "SequenceNumberRange":{ + "shape":"SequenceNumberRange", + "documentation":"

The range of possible sequence numbers for the shard.

" + }, + "ParentShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the current shard's parent.

" + } + }, + "documentation":"

A uniquely identified group of stream records within a stream.

" + }, + "ShardDescriptionList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "ShardId":{ + "type":"string", + "max":65, + "min":28 + }, + "ShardIterator":{ + "type":"string", + "max":2048, + "min":1 + }, + "ShardIteratorType":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST", + "AT_SEQUENCE_NUMBER", + "AFTER_SEQUENCE_NUMBER" + ] + }, + "Stream":{ + "type":"structure", + "members":{ + "StreamArn":{ + "shape":"StreamArn", + "documentation":"

The Amazon Resource Name (ARN) for the stream.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The DynamoDB table with which the stream is associated.

" + }, + "StreamLabel":{ + "shape":"String", + "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

" + } + }, + "documentation":"

Represents all of the data describing a particular stream.

" + }, + "StreamArn":{ + "type":"string", + "max":1024, + "min":37 + }, + "StreamDescription":{ + "type":"structure", + "members":{ + "StreamArn":{ + "shape":"StreamArn", + "documentation":"

The Amazon Resource Name (ARN) for the stream.

" + }, + "StreamLabel":{ + "shape":"String", + "documentation":"

A timestamp, in ISO 8601 format, for this stream.

Note that LatestStreamLabel is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:

  • the AWS customer ID.

  • the table name

  • the StreamLabel

" + }, + "StreamStatus":{ + "shape":"StreamStatus", + "documentation":"

Indicates the current status of the stream:

  • ENABLING - Streams is currently being enabled on the DynamoDB table.

  • ENABLED - the stream is enabled.

  • DISABLING - Streams is currently being disabled on the DynamoDB table.

  • DISABLED - the stream is disabled.

" + }, + "StreamViewType":{ + "shape":"StreamViewType", + "documentation":"

Indicates the format of the records within this stream:

  • KEYS_ONLY - only the key attributes of items that were modified in the DynamoDB table.

  • NEW_IMAGE - entire items from the table, as they appeared after they were modified.

  • OLD_IMAGE - entire items from the table, as they appeared before they were modified.

  • NEW_AND_OLD_IMAGES - both the new and the old images of the items from the table.

" + }, + "CreationRequestDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the request to create this stream was issued.

" + }, + "TableName":{ + "shape":"TableName", + "documentation":"

The DynamoDB table with which the stream is associated.

" + }, + "KeySchema":{ + "shape":"KeySchema", + "documentation":"

The key attribute(s) of the stream's DynamoDB table.

" + }, + "Shards":{ + "shape":"ShardDescriptionList", + "documentation":"

The shards that comprise the stream.

" + }, + "LastEvaluatedShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedShardId is empty, then the \"last page\" of results has been processed and there is currently no more data to be retrieved.

If LastEvaluatedShardId is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedShardId is empty.

" + } + }, + "documentation":"

Represents all of the data describing a particular stream.

" + }, + "StreamList":{ + "type":"list", + "member":{"shape":"Stream"} + }, + "StreamRecord":{ + "type":"structure", + "members":{ + "ApproximateCreationDateTime":{ + "shape":"Date", + "documentation":"

The approximate date and time when the stream record was created, in UNIX epoch time format.

" + }, + "Keys":{ + "shape":"AttributeMap", + "documentation":"

The primary key attribute(s) for the DynamoDB item that was modified.

" + }, + "NewImage":{ + "shape":"AttributeMap", + "documentation":"

The item in the DynamoDB table as it appeared after it was modified.

" + }, + "OldImage":{ + "shape":"AttributeMap", + "documentation":"

The item in the DynamoDB table as it appeared before it was modified.

" + }, + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number of the stream record.

" + }, + "SizeBytes":{ + "shape":"PositiveLongObject", + "documentation":"

The size of the stream record, in bytes.

" + }, + "StreamViewType":{ + "shape":"StreamViewType", + "documentation":"

The type of data from the modified DynamoDB item that was captured in this stream record:

  • KEYS_ONLY - only the key attributes of the modified item.

  • NEW_IMAGE - the entire item, as it appeared after it was modified.

  • OLD_IMAGE - the entire item, as it appeared before it was modified.

  • NEW_AND_OLD_IMAGES - both the new and the old item images of the item.

" + } + }, + "documentation":"

A description of a single data modification that was performed on an item in a DynamoDB table.

" + }, + "StreamStatus":{ + "type":"string", + "enum":[ + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ] + }, + "StreamViewType":{ + "type":"string", + "enum":[ + "NEW_IMAGE", + "OLD_IMAGE", + "NEW_AND_OLD_IMAGES", + "KEYS_ONLY" + ] + }, + "String":{"type":"string"}, + "StringAttributeValue":{"type":"string"}, + "StringSetAttributeValue":{ + "type":"list", + "member":{"shape":"StringAttributeValue"} + }, + "TableName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "TrimmedDataAccessException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

\"The data you are trying to access has been trimmed.

" + } + }, + "documentation":"

The operation attempted to read past the oldest stream record in a shard.

In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:

  • You request a shard iterator with a sequence number older than the trim point (24 hours).

  • You obtain a shard iterator, but before you use the iterator in a GetRecords request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.

", + "exception":true + } + }, + "documentation":"Amazon DynamoDB

Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see Capturing Table Activity with DynamoDB Streams in the Amazon DynamoDB Developer Guide.

" +} diff --git a/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/paginators-1.json b/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/service-2.json b/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/service-2.json new file mode 100644 index 00000000..55b2911f --- /dev/null +++ b/aws/dist/botocore/data/ec2-instance-connect/2018-04-02/service-2.json @@ -0,0 +1,144 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-04-02", + "endpointPrefix":"ec2-instance-connect", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"EC2 Instance Connect", + "serviceFullName":"AWS EC2 Instance Connect", + "serviceId":"EC2 Instance Connect", + "signatureVersion":"v4", + "targetPrefix":"AWSEC2InstanceConnectService", + "uid":"ec2-instance-connect-2018-04-02" + }, + "operations":{ + "SendSSHPublicKey":{ + "name":"SendSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendSSHPublicKeyRequest"}, + "output":{"shape":"SendSSHPublicKeyResponse"}, + "errors":[ + {"shape":"AuthException"}, + {"shape":"InvalidArgsException"}, + {"shape":"ServiceException"}, + {"shape":"ThrottlingException"}, + {"shape":"EC2InstanceNotFoundException"} + ], + "documentation":"

Pushes an SSH public key to a particular OS user on a given EC2 instance for 60 seconds.

" + } + }, + "shapes":{ + "AuthException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Indicates that either your AWS credentials are invalid or you do not have access to the EC2 instance.

", + "exception":true + }, + "AvailabilityZone":{ + "type":"string", + "max":32, + "min":6, + "pattern":"^(\\w+-){2,3}\\d+\\w+$" + }, + "EC2InstanceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Indicates that the instance requested was not found in the given zone. Check that you have provided a valid instance ID and the correct zone.

", + "exception":true + }, + "InstanceId":{ + "type":"string", + "max":32, + "min":10, + "pattern":"^i-[a-f0-9]+$" + }, + "InstanceOSUser":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[A-Za-z_][A-Za-z0-9\\@\\._-]{0,30}[A-Za-z0-9\\$_-]?$" + }, + "InvalidArgsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Indicates that you provided bad input. Ensure you have a valid instance ID, the correct zone, and a valid SSH public key.

", + "exception":true + }, + "RequestId":{"type":"string"}, + "SSHPublicKey":{ + "type":"string", + "max":4096, + "min":256 + }, + "SendSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "InstanceOSUser", + "SSHPublicKey", + "AvailabilityZone" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The EC2 instance you wish to publish the SSH key to.

" + }, + "InstanceOSUser":{ + "shape":"InstanceOSUser", + "documentation":"

The OS user on the EC2 instance whom the key may be used to authenticate as.

" + }, + "SSHPublicKey":{ + "shape":"SSHPublicKey", + "documentation":"

The public key to be published to the instance. To use it after publication you must have the matching private key.

" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The availability zone the EC2 instance was launched in.

" + } + } + }, + "SendSSHPublicKeyResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"RequestId", + "documentation":"

The request ID as logged by EC2 Connect. Please provide this when contacting AWS Support.

" + }, + "Success":{ + "shape":"Success", + "documentation":"

Indicates request success.

" + } + } + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Indicates that the service encountered an error. Follow the message's instructions and try again.

", + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "Success":{"type":"boolean"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

Indicates you have been making requests too frequently and have been throttled. Wait for a while and try again. If higher call volume is warranted contact AWS Support.

", + "exception":true + } + }, + "documentation":"

AWS EC2 Connect Service is a service that enables system administrators to publish temporary SSH keys to their EC2 instances in order to establish connections to their instances without leaving a permanent authentication option.

" +} diff --git a/aws/dist/botocore/data/ec2/2014-09-01/paginators-1.json b/aws/dist/botocore/data/ec2/2014-09-01/paginators-1.json new file mode 100644 index 00000000..b643e696 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-09-01/paginators-1.json @@ -0,0 +1,45 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2014-09-01/service-2.json b/aws/dist/botocore/data/ec2/2014-09-01/service-2.json new file mode 100644 index 00000000..07903f11 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-09-01/service-2.json @@ -0,0 +1,11700 @@ +{ + "metadata":{ + "apiVersion":"2014-09-01", + "endpointPrefix":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-09-01", + "protocol":"ec2" + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can only be attached as the root device of a stopped instance.
  • You must be subscribed to the AWS Marketplace code that is on the volume.
  • The configuration (instance type, operating system) of the instance must support that specific AWS Marketplace code. For example, you cannot take a volume from a Windows instance and attach it to a Linux instance.
  • AWS Marketplace product codes are copied from the volume to the instance.

For an overview of the AWS Marketplace, see https://aws.amazon.com/marketplace/help/200900000. For more information about how to use the AWS Marketplace, see AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the region in which the request was made. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). If specifying more than one domain name, separate them with spaces.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{ + "shape":"KeyPair", + "documentation":"

Information about the key pair.

", + "locationName":"keyPair" + }, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{ + "shape":"Snapshot", + "locationName":"snapshot" + }, + "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a datafeed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{ + "shape":"Volume", + "locationName":"volume" + }, + "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the specified region.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes the specified attribute of your AWS account.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{ + "shape":"ImageAttribute", + "documentation":"

Information about the image attribute.

", + "locationName":"imageAttribute" + }, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the datafeed for Spot Instances. For more information, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot Price history. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you specify an Availability Zone, this operation describes the price history for the specified Availability Zone with the most recent set of prices listed first. If you don't specify an Availability Zone, you get the prices across all Availability Zones, starting with the most recent set. However, if you're using an API version earlier than 2011-05-15, you get the lowest price across the region for the specified time period. The prices returned are listed in chronological order, from the oldest to the most recent.

When you specify the start and end time options, this operation returns two pieces of data: the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

If the root volume is detached from an instance with an AWS Marketplace product code, then the AWS Marketplace product codes from that volume are no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux/Unix instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a machine. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output displays the last three system event log errors.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, see Spot Instances in the Amazon Elastic Compute Cloud User Guide.

Users must be subscribed to the required product to run an instance with AWS Marketplace product codes.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{ + "shape":"Reservation", + "documentation":"

One or more reservations.

", + "locationName":"reservation" + }, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + } + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + } + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + } + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", + "locationName":"allowReassociation" + } + } + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + } + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + } + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + } + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + } + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + } + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + } + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "locationName":"value" + } + } + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "locationName":"value" + } + } + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":["available"] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeral[0..3]). The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + } + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID for this bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + } + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

The bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "locationName":"reasonMessage" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + } + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + } + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + } + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot Instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot Instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + } + } + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new Amazon EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region of the snapshot copy operation. This parameter is required in the PresignedUrl.

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + } + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + } + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + } + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + } + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + } + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + } + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + } + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "locationName":"exportToS3" + } + } + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "locationName":"exportTask" + } + } + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + } + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + } + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + } + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + } + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + } + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + } + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + } + } + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instances listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + } + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + } + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot Instance datafeed.

Constraints: Must be a valid bucket associated with your AWS account.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the datafeed file names.

", + "locationName":"prefix" + } + } + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance datafeed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" + } + } + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + } + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + } + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + } + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted.

", + "locationName":"encrypted" + } + } + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + } + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", + "locationName":"instanceTenancy" + } + } + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + } + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + } + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + } + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + } + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + } + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + } + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + } + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + } + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + } + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + } + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + } + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + } + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + } + } + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + } + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + } + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + } + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + } + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + } + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + } + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + } + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + } + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + } + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "locationName":"conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + } + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + } + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "locationName":"exportTaskSet" + } + } + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

" + } + } + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request), or all (all owners).

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + } + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

", + "locationName":"attribute" + } + } + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next paginated set of results to return. (You received this token from a prior call.)

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of paginated instance items per response. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Default: 1000

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next paginated set of results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use group-name instead.

  • group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use group-id instead.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, m1.small).

  • instance.group-id - The ID of the security group for the instance. If the instance is in EC2-Classic or a default VPC, you can use instance.group-name instead.

  • instance.group-name - The name of the security group for the instance. If the instance is in a nondefault VPC, you must use instance.group-id instead.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-destination-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

One or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + } + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + } + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + } + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + } + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + } + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + } + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + } + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + } + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + } + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + } + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + } + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance Listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + } + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of data.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + } + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of data.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next paginated set of offerings.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of offerings to return. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + } + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next paginated set of results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + } + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + } + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + } + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. You can specify either the security group name or the security group ID.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for nondefault VPCs.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + } + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + } + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + } + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + } + } + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "locationName":"snapshotSet" + } + } + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance datafeed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + } + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The start date and time of the Spot Price history data.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The end date and time of the Spot Price history data.

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

One or more instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

One or more basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The number of rows to return.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next set of rows to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot Prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The string marking the next set of results. This is empty if there are no more results.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + } + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + } + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next paginated set of results to return using the pagination token returned by a previous call.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of paginated volume items per response.

" + } + } + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The next paginated set of results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results.

", + "locationName":"maxResults" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + } + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + } + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + } + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + } + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + } + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + } + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + } + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + } + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + } + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{"shape":"DiskImageDetail"}, + "Description":{"shape":"String"}, + "Volume":{"shape":"VolumeDetail"} + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + } + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + } + } + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + } + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: If the volume type is io1, the minimum size of the volume is 10 GiB; otherwise, the minimum size is 1 GiB. The maximum volume size is 1024 GiB. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes an Amazon EBS block device.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + } + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

The instance being exported.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACL permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "locationName":"s3Key" + } + } + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values.

", + "locationName":"Value" + } + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "Float":{"type":"float"}, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64 encoded.

", + "locationName":"output" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + } + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + } + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping" + ] + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "available", + "deregistered" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"String", + "documentation":"

User data to be made available to the instance.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + } + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + } + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + } + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", + "locationName":"publicKeyMaterial" + } + } + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

An optional description for the volume being imported.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "locationName":"volume" + } + } + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The Base64-encoded MIME user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":["spot"] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If luanching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Extra information regarding events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The associated code of the event.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes an instance event.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. If requesting a Spot Instance in a nondefault VPC, you must specify the security group ID. If requesting a Spot Instance in EC2-Classic or a default VPC, you can specify either the security group name or ID.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

Default: m1.small

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the Spot Instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification of a Spot Instance.

" + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + } + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

For example, if you want the instance to be in sg-1a1a1a1a and sg-9b9b9b9b, specify GroupId.1=sg-1a1a1a1a and GroupId.2=sg-9b9b9b9b.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + } + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + } + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + } + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + } + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{"shape":"AttributeBooleanValue"} + } + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + } + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "enabled", + "pending" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "locationName":"tenancy" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of instances available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + } + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + } + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + } + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + } + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + } + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + } + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + } + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + } + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

Information about the Spot Instance request.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you created the listing.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the modification request is idempotent.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + } + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + } + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

", + "locationName":"attribute" + } + } + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + } + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" + } + } + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + } + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instances.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + } + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the Base64 encoded JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the S3 bucket for an instance store-backed AMI.

" + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot Instance datafeed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to datafeed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot Instance datafeed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the datafeed for a Spot Instance.

" + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For information, see Tracking Spot Requests with Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot Instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the Spot Instance request was created.

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot Instance.

", + "locationName":"productDescription" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describe a Spot Instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot Instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot Instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code of the request.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent status update.

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code for the Spot request.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot Instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price you will pay to launch one or more Spot Instances.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created.

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the Spot Price.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + } + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + } + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + } + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + } + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + } + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The ID of the security group owned by the specified AWS account.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The name of the security group in the specified AWS account.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group and AWS account ID pair for EC2-Classic.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 4000 for Provisioned IOPS (SSD) volumes and 3 to 3072 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an Amazon EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the peer VPC.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

Default: m1.small

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the Spot Instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification of a Spot Instance.

" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2014-09-01/waiters-2.json b/aws/dist/botocore/data/ec2/2014-09-01/waiters-2.json new file mode 100644 index 00000000..fb8c16bd --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-09-01/waiters-2.json @@ -0,0 +1,341 @@ +{ + "version": 2, + "waiters": { + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2014-10-01/paginators-1.json b/aws/dist/botocore/data/ec2/2014-10-01/paginators-1.json new file mode 100644 index 00000000..ca7a8767 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-10-01/paginators-1.json @@ -0,0 +1,51 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2014-10-01/service-2.json b/aws/dist/botocore/data/ec2/2014-10-01/service-2.json new file mode 100644 index 00000000..91ef68f0 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-10-01/service-2.json @@ -0,0 +1,12086 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-01", + "endpointPrefix":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2014-10-01", + "protocol":"ec2" + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide for Linux.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{ + "shape":"KeyPair", + "documentation":"

Information about the key pair.

", + "locationName":"keyPair" + }, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{ + "shape":"Snapshot", + "locationName":"snapshot" + }, + "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{ + "shape":"Volume", + "locationName":"volume" + }, + "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{ + "shape":"ImageAttribute", + "documentation":"

Information about the image attribute.

", + "locationName":"imageAttribute" + }, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot Price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide for Linux.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

Snapshots with AWS Marketplace product codes cannot be made public.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{ + "shape":"Reservation", + "documentation":"

One or more reservations.

", + "locationName":"reservation" + }, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide for Linux.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + } + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + } + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + } + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", + "locationName":"allowReassociation" + } + } + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + } + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + } + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + } + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + } + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + } + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + } + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + } + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

Valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

Valid values are case-sensitive and vary by action.

", + "locationName":"value" + } + }, + "documentation":"

The value to use for a resource attribute.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":["available"] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + } + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + } + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

The bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "locationName":"reasonMessage" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + } + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + } + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + } + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot Instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot Instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + } + } + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.

" + } + } + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new Amazon EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + } + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + } + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + } + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + } + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + } + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + } + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + } + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "locationName":"exportToS3" + } + } + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "locationName":"exportTask" + } + } + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + } + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + } + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + } + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + } + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + } + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + } + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instances listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + } + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + } + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot Instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + } + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" + } + } + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + } + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + } + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + } + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

" + } + } + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + } + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", + "locationName":"instanceTenancy" + } + } + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + } + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + } + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + } + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + } + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + } + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + } + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + } + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + } + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + } + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + } + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + } + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + } + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + } + } + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + } + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + } + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + } + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + } + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + } + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + } + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + } + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + } + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + } + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + } + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "locationName":"conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + } + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + } + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "locationName":"exportTaskSet" + } + } + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + } + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + } + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

", + "locationName":"attribute" + } + } + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

One or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + } + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + } + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + } + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + } + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + } + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + } + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + } + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + } + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + } + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + } + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + } + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance Listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + } + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + } + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + } + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + } + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + } + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + } + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + } + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + } + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + } + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + } + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + } + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data.

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot Prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + } + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + } + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + } + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + } + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + } + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + } + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + } + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + } + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + } + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + } + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + } + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + } + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + } + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{"shape":"DiskImageDetail"}, + "Description":{"shape":"String"}, + "Volume":{"shape":"VolumeDetail"} + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + } + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + } + } + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + } + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes an Amazon EBS block device.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + } + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + } + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

The instance being exported.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "locationName":"s3Key" + } + } + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "Float":{"type":"float"}, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64 encoded.

", + "locationName":"output" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + } + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + } + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping" + ] + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "available", + "deregistered" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

User data to be made available to the instance.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + } + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + } + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + } + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", + "locationName":"publicKeyMaterial" + } + } + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

An optional description for the volume being imported.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "locationName":"volume" + } + } + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The Base64-encoded MIME user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":["spot"] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Extra information regarding events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The associated code of the event.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes an instance event.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + } + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + } + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + } + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + } + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + } + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + } + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + } + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "enabled", + "pending" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "locationName":"tenancy" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of instances available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + } + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + } + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + } + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + } + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + } + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + } + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + } + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + } + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + } + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + } + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

", + "locationName":"attribute" + } + } + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + } + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" + } + } + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + } + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instances.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + } + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the Base64 encoded JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot Instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot Instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot Instance.

" + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot Instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the Spot Instance request was created.

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot Instance.

", + "locationName":"productDescription" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describe a Spot Instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot Instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot Instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent status update.

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot Instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot Instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot Instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created.

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + } + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + } + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + } + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + } + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + } + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "locationName":"data" + } + } + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. EC2-Classic only.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an Amazon EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the peer VPC.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2014-10-01/waiters-2.json b/aws/dist/botocore/data/ec2/2014-10-01/waiters-2.json new file mode 100644 index 00000000..17f08705 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2014-10-01/waiters-2.json @@ -0,0 +1,436 @@ +{ + "version": 2, + "waiters": { + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-03-01/paginators-1.json b/aws/dist/botocore/data/ec2/2015-03-01/paginators-1.json new file mode 100644 index 00000000..ca7a8767 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-03-01/paginators-1.json @@ -0,0 +1,51 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-03-01/service-2.json b/aws/dist/botocore/data/ec2/2015-03-01/service-2.json new file mode 100644 index 00000000..dbaf9d8b --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-03-01/service-2.json @@ -0,0 +1,12708 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-03-01", + "endpointPrefix":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-03-01", + "protocol":"ec2" + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Attaches an Amazon EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For a list of supported device names, see Attaching an Amazon EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for Amazon EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide for Linux.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about Amazon EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot Instance requests. Spot Instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted Amazon EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an Amazon EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create Amazon EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted Amazon EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted.

Copying snapshots that were encrypted with non-default AWS Key Management Service (KMS) master keys is not supported at this time.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{ + "shape":"KeyPair", + "documentation":"

Information about the key pair.

", + "locationName":"keyPair" + }, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a Seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{ + "shape":"Snapshot", + "locationName":"snapshot" + }, + "documentation":"

Creates a snapshot of an Amazon EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of Amazon EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for Amazon EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{ + "shape":"Volume", + "locationName":"volume" + }, + "documentation":"

Creates an Amazon EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an Amazon EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an Amazon EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified Amazon EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{ + "shape":"ImageAttribute", + "documentation":"

Information about the image attribute.

", + "locationName":"imageAttribute" + }, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Displays details about an import snapshot tasks that is already created.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances, including any scheduled events.

Instance status has two main components:

  • System Status reports impaired functionality that stems from issues related to the systems that support an instance, such as such as hardware failures and network connectivity problems. This call reports such problems as impaired reachability.

  • Instance Status reports impaired functionality that arises from problems internal to the instance. This call reports such problems as impaired reachability.

Instance status provides information about four types of scheduled events for an instance that may require your attention:

  • Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instances status returns one of two event codes: system-reboot or instance-reboot. System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.

  • System Maintenance: When Amazon EC2 determines that an instance requires maintenance that requires power or network impact, the instance status is the event code system-maintenance. System maintenance is either power maintenance or network maintenance. For power maintenance, your instance will be unavailable for a brief period of time and then rebooted. For network maintenance, your instance will experience a brief loss of network connectivity. System maintenance events include a scheduled start and end time. You will also be notified by email if one of your instances is set for system maintenance. The email message indicates when your instance is scheduled for maintenance.

  • Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance status is the event code instance-retirement. Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You will also be notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  • Scheduled Stop: When Amazon EC2 determines that an instance must be shut down, the instances status returns an event code called instance-stop. Stop events include a scheduled start and end time. You will also be notified by email if one of your instances is set to stop. The email message indicates when your instance will be stopped.

When your instance is retired, it will either be terminated (if its root device type is the instance-store) or stopped (if its root device type is an EBS volume). Instances stopped due to retirement will not be restarted, but you can do so manually. You can also avoid retirement of EBS-backed instances by manually restarting your instance when its event code is instance-retirement. This ensures that your instance is started on a different underlying host.

For more information about failed status checks, see Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about working with scheduled events, see Working with an Instance That Has a Scheduled Event in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the Amazon EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about Amazon EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot Price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide for Linux.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified Amazon EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about Amazon EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "locationName":"attachment" + }, + "documentation":"

Detaches an Amazon EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide for Linux.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or Amazon EBS snapshots into an Amazon Machine Image (AMI).

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Import a disk into an Amazon Elastic Block Store (Amazon EBS) snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

Snapshots with AWS Marketplace product codes cannot be made public.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time. You pay a lower usage rate than with On-Demand instances for the time that you actually use the capacity reservation.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide for Linux.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide for Linux.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot Instance request. Spot Instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{ + "shape":"Reservation", + "documentation":"

One or more reservations.

", + "locationName":"reservation" + }, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide for Linux.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide for Linux.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide for Linux.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all Amazon EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide for Linux.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide for Linux.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + } + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + } + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + } + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", + "locationName":"allowReassociation" + } + } + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + } + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + } + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + } + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + } + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + } + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + } + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + } + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

Valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

Valid values are case-sensitive and vary by action.

", + "locationName":"value" + } + }, + "documentation":"

The value to use for a resource attribute.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":["available"] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + } + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + } + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

The bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "locationName":"reasonMessage" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + } + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the ImportImage or ImportSnapshot task to be cancelled.

" + }, + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + } + } + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the ImportImage or ImportSnapshot task being canceled.

", + "locationName":"importTaskId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the ImportImage or ImportSnapshot task being canceled.

", + "locationName":"state" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the ImportImage or ImportSnapshot task being canceled.

", + "locationName":"previousState" + } + } + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + } + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + } + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot Instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot Instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClientData":{ + "type":"structure", + "members":{ + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

User-defined comment about the upload.

" + } + }, + "documentation":"

Client-specific data.

" + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + } + } + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide for Linux.

" + } + } + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new Amazon EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because Amazon EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + } + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + } + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + } + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + } + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + } + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + } + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + } + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "locationName":"exportToS3" + } + } + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "locationName":"exportTask" + } + } + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + } + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + } + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + } + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + } + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + } + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + } + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instances listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + } + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + } + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot Instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + } + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" + } + } + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + } + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + } + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + } + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key to use when creating the encrypted volume. This parameter is only required if you want to use a non-default master key; if this parameter is not specified, the default master key is used. The ARN contains the arn:aws:kms namespace, followed by the region of the master key, the AWS account ID of the master key owner, the key namespace, and then the master key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

" + } + } + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + } + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", + "locationName":"instanceTenancy" + } + } + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + } + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + } + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + } + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + } + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + } + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + } + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + } + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + } + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + } + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + } + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + } + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + } + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + } + } + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + } + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + } + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + } + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + } + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + } + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + } + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + } + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + } + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + } + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + } + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "locationName":"conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + } + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + } + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "locationName":"exportTaskSet" + } + } + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + } + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the Amazon EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + } + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of ImportImage task IDs to describe.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to get the next page of paginated describe requests.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results in a page.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filters to be applied on a describe request.

" + } + } + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more ImportImage tasks that are currently active or completed/cancelled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to get the next page of paginated describe requests.

", + "locationName":"nextToken" + } + } + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of IDs of the ImportSnapshot tasks to describe.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to get to the next page of paginated describe requests.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results in a page.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters to be applied on a describe request.

" + } + } + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more ImportSnapshot tasks that are currently active or completed/cancelled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to get to the next page of paginated describe requests.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

", + "locationName":"attribute" + } + } + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code identifying the type of event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • event.not-before - The earliest start time for the scheduled event, for example: 2010-09-15T17:15:20.000Z.

  • instance-state-code - A code representing the state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an Amazon EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the Amazon EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the Amazon EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

One or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + } + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + } + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + } + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + } + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + } + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + } + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + } + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + } + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + } + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + } + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + } + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance Listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + } + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + } + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + } + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2014-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The product description of the Reserved Instance (Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (pending-payment | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + } + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + } + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + } + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - The description of the security group.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + } + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + } + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + } + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + } + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + } + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot Instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + } + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data.

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot Price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot Price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot Price history (for example, 2010-08-16T05:06:11.000Z). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot Prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + } + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + } + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + } + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + } + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + } + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + } + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + } + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + } + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + } + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + } + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + } + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + } + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + } + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{"shape":"DiskImageDetail"}, + "Description":{"shape":"String"}, + "Volume":{"shape":"VolumeDetail"} + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + } + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + } + } + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + } + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes an Amazon EBS block device.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an Amazon EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the Amazon EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + } + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + } + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

The instance being exported.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "locationName":"s3Key" + } + } + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "Float":{"type":"float"}, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64 encoded.

", + "locationName":"output" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + } + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + } + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image (optional).

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported (optional).

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{"shape":"UserBucket"}, + "DeviceName":{ + "shape":"String", + "documentation":"

The Amazon EBS block device mapping for the disk (optional).

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The Amazon EBS snapshot ID to be used for importing the snapshot.

" + } + }, + "documentation":"

The disk container object for an ImportImage task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task (optional).

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "locationName":"DiskContainer" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing (optional).

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide for Linux.

Valid Values: AWS | BYOL

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform to use (optional).

" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine being imported (optional).

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine being imported (optional).

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

Client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests (optional).

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role name 'vmimport' (optional).

" + } + } + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task id of the ImportImage task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

Architecture of the virtual machine being imported.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

License type of the virtual machine being imported.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

Operating system of the VM being imported.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

Target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The Amazon Machine Image (AMI) ID created by the import task.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The task's progress.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + } + } + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

Architecture of the VM being imported.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

License type of the VM being imported.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

Target hypervisor for the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

Description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The Amazon Machine Image (AMI) ID of the imported virtual machine.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the ImportImage task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the ImportImage task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the ImportImage task.

", + "locationName":"status" + } + } + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

User data to be made available to the instance.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. This is not supported for VMs imported into a VPC, which are assigned the default security group. After a VM is imported into a VPC, you can specify another security group using the AWS Management Console. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux. For more information about the Linux instance types you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] Optionally, you can use this parameter to assign the instance a specific available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + } + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + } + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + } + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", + "locationName":"publicKeyMaterial" + } + } + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + } + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "DryRun":{"shape":"Boolean"}, + "Description":{ + "shape":"String", + "documentation":"

The description string for the ImportSnapshot task.

" + }, + "DiskContainer":{"shape":"SnapshotDiskContainer"}, + "ClientData":{"shape":"ClientData"}, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests (optional).

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role name 'vmimport' (optional).

" + } + } + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

Task ID of the ImportSnapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

Description of the import snapshot task.

", + "locationName":"description" + } + } + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the ImportSnapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

Description for the import snapshot task.

", + "locationName":"description" + } + } + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting Amazon EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

An optional description for the volume being imported.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "locationName":"volume" + } + } + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "locationName":"conversionTask" + } + } + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The Base64-encoded MIME user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up Amazon EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

he number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":["spot"] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Extra information regarding events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The associated code of the event.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes an instance event.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + } + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or intanceInitiateShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + } + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + } + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + } + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

" + }, + "OperationType":{ + "shape":"String", + "documentation":"

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + } + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + } + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + } + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "locationName":"tenancy" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of instances available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + } + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + } + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + } + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + } + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + } + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + } + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + } + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + } + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + } + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + } + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + } + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

", + "locationName":"attribute" + } + } + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + } + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset (currently only the attribute for permission to create volumes can be reset).

" + } + } + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the destination security group. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The ID of the source security group. You can't specify a source security group and a CIDR IP address range.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + } + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you launch an instance without specifying a key pair, you can't connect to the instance.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instances.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide for Linux.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + } + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the Base64 encoded JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

Description for the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "locationName":"userBucket" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The Amazon EBS block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + } + }, + "documentation":"

The details of the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{"shape":"UserBucket"} + }, + "documentation":"

The disk container object for the ImportSnapshot request.

" + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "locationName":"userBucket" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the ImportSnapshot task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the ImportSnapshot task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the ImportSnapshot task.

", + "locationName":"status" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot Instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot Instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot Instance.

" + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot Instance request. Spot bid status information can help you track your Spot Instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide for Linux.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot Instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the Spot Instance request was created.

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot Instance.

", + "locationName":"productDescription" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describe a Spot Instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot Instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot Instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent status update.

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot Instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot Instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot Instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created.

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot Instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + } + } + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + } + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + } + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + } + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + } + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + } + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket name where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The Amazon S3 Key for the disk image.

" + } + }, + "documentation":"

User's Amazon S3 bucket details used to access the image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The Amazon S3 key from which the disk image was created.

", + "locationName":"s3Key" + } + }, + "documentation":"

User's Amazon S3 bucket details used to access the image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "locationName":"data" + } + } + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. EC2-Classic only.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide for Linux.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (KMS) master key that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Amazon EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an Amazon EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the peer VPC.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-03-01/waiters-2.json b/aws/dist/botocore/data/ec2/2015-03-01/waiters-2.json new file mode 100644 index 00000000..17f08705 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-03-01/waiters-2.json @@ -0,0 +1,436 @@ +{ + "version": 2, + "waiters": { + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-04-15/paginators-1.json b/aws/dist/botocore/data/ec2/2015-04-15/paginators-1.json new file mode 100644 index 00000000..ca7a8767 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-04-15/paginators-1.json @@ -0,0 +1,51 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-04-15/service-2.json b/aws/dist/botocore/data/ec2/2015-04-15/service-2.json new file mode 100644 index 00000000..3ca3ae43 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-04-15/service-2.json @@ -0,0 +1,14626 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-15", + "endpointPrefix":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-04-15", + "protocol":"ec2" + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

", + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "documentation":"

Information about the volume attachment.

", + "locationName":"attachment" + }, + "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.
  • AWS Marketplace product codes are copied from the volume to the instance.
  • You must be subscribed to the product.
  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC.

You can have up to 50 rules per security group (covering both ingress and egress rules).

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests":{ + "name":"CancelSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CancelSpotFleetRequestsRequest", + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "output":{ + "shape":"CancelSpotFleetRequestsResponse", + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "documentation":"

Cancels the specified Spot fleet requests.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CancelSpotInstanceRequestsRequest", + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "output":{ + "shape":"CancelSpotInstanceRequestsResult", + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request. AMIs that use encrypted EBS snapshots cannot be copied with this method.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can't be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.
  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFlowLogs":{ + "name":"CreateFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowLogsRequest"}, + "output":{"shape":"CreateFlowLogsResult"}, + "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{ + "shape":"KeyPair", + "documentation":"

Information about the key pair.

", + "locationName":"keyPair" + }, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "output":{"shape":"CreateRouteResult"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 100 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{ + "shape":"Snapshot", + "documentation":"

Information about the snapshot.

", + "locationName":"snapshot" + }, + "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateSpotDatafeedSubscriptionRequest", + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "output":{ + "shape":"CreateSpotDatafeedSubscriptionResult", + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{ + "shape":"Volume", + "documentation":"

Information about the volume.

", + "locationName":"volume" + }, + "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResult"}, + "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteFlowLogs":{ + "name":"DeleteFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowLogsRequest"}, + "output":{"shape":"DeleteFlowLogsResult"}, + "documentation":"

Deletes one or more flow logs.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteSpotDatafeedSubscriptionRequest", + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "documentation":"

Deletes the data feed for Spot instances.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpoints":{ + "name":"DeleteVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointsRequest"}, + "output":{"shape":"DeleteVpcEndpointsResult"}, + "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeFlowLogs":{ + "name":"DescribeFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlowLogsRequest"}, + "output":{"shape":"DescribeFlowLogsResult"}, + "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{ + "shape":"ImageAttribute", + "documentation":"

Information about the image attribute.

", + "locationName":"imageAttribute" + }, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{ + "shape":"InstanceAttribute", + "documentation":"

Information about the instance attribute.

" + }, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeMovingAddresses":{ + "name":"DescribeMovingAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMovingAddressesRequest"}, + "output":{"shape":"DescribeMovingAddressesResult"}, + "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists":{ + "name":"DescribePrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrefixListsRequest"}, + "output":{"shape":"DescribePrefixListsResult"}, + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.
  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotDatafeedSubscriptionRequest", + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "output":{ + "shape":"DescribeSpotDatafeedSubscriptionResult", + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotFleetInstances":{ + "name":"DescribeSpotFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotFleetInstancesRequest", + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "output":{ + "shape":"DescribeSpotFleetInstancesResponse", + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "documentation":"

Describes the running instances for the specified Spot fleet.

" + }, + "DescribeSpotFleetRequestHistory":{ + "name":"DescribeSpotFleetRequestHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotFleetRequestHistoryRequest", + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "output":{ + "shape":"DescribeSpotFleetRequestHistoryResponse", + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" + }, + "DescribeSpotFleetRequests":{ + "name":"DescribeSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotFleetRequestsRequest", + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "output":{ + "shape":"DescribeSpotFleetRequestsResponse", + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "documentation":"

Describes your Spot fleet requests.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotInstanceRequestsRequest", + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "output":{ + "shape":"DescribeSpotInstanceRequestsResult", + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSpotPriceHistoryRequest", + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "output":{ + "shape":"DescribeSpotPriceHistoryResult", + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcEndpointServices":{ + "name":"DescribeVpcEndpointServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicesRequest"}, + "output":{"shape":"DescribeVpcEndpointServicesResult"}, + "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResult"}, + "documentation":"

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{ + "shape":"VolumeAttachment", + "documentation":"

Information about the volume attachment.

", + "locationName":"attachment" + }, + "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

Snapshots with AWS Marketplace product codes cannot be made public.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint":{ + "name":"ModifyVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointRequest"}, + "output":{"shape":"ModifyVpcEndpointResult"}, + "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "MoveAddressToVpc":{ + "name":"MoveAddressToVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAddressToVpcRequest"}, + "output":{"shape":"MoveAddressToVpcResult"}, + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that's allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Amazon EC2 Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to on-Demand Instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If a Linux/Unix instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet":{ + "name":"RequestSpotFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RequestSpotFleetRequest", + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "output":{ + "shape":"RequestSpotFleetResponse", + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RequestSpotInstancesRequest", + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "output":{ + "shape":"RequestSpotInstancesResult", + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the SourceDestCheck, the instance can be either running or stopped.

The SourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic":{ + "name":"RestoreAddressToClassic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreAddressToClassicRequest"}, + "output":{"shape":"RestoreAddressToClassicResult"}, + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

Removes one or more egress rules from a security group for EC2-VPC. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{ + "shape":"Reservation", + "documentation":"

One or more reservations.

", + "locationName":"reservation" + }, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

T2 instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot Instances.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "ActiveInstance":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + } + }, + "documentation":"

Describes a running instance in a Spot fleet.

" + }, + "ActiveInstanceSet":{ + "type":"list", + "member":{ + "shape":"ActiveInstance", + "locationName":"item" + } + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + } + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + } + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "diversified" + ] + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + } + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] Allows an Elastic IP address that is already associated with an instance or network interface to be re-associated with the specified instance or network interface. Otherwise, the operation fails.

Default: false

", + "locationName":"allowReassociation" + } + } + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + } + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + } + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + } + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + } + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + } + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + } + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + } + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

Valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

Valid values are case-sensitive and vary by action.

", + "locationName":"value" + } + }, + "documentation":"

The value to use for a resource attribute.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The AWS account number for the source security group. For EC2-VPC, the source security group must be in the same VPC. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone (available | impaired | unavailable).

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":["available"] + }, + "BatchState":{ + "type":"string", + "enum":[ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating" + ] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + } + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBatchErrorCode":{ + "type":"string", + "enum":[ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + } + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + } + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "documentation":"

The reason for canceling the conversion task.

", + "locationName":"reasonMessage" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + } + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image or import snapshot task to be canceled.

" + }, + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + } + } + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the task being canceled.

", + "locationName":"importTaskId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"state" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"previousState" + } + } + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + } + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CancelSpotFleetRequestsError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"CancelBatchErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "Error" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "Error":{ + "shape":"CancelSpotFleetRequestsError", + "documentation":"

The error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsErrorItem", + "locationName":"item" + } + }, + "CancelSpotFleetRequestsRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", + "locationName":"terminateInstances" + } + }, + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "UnsuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsErrorSet", + "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", + "locationName":"unsuccessfulFleetRequestSet" + }, + "SuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsSuccessSet", + "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", + "locationName":"successfulFleetRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "CurrentSpotFleetRequestState", + "PreviousSpotFleetRequestState" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "CurrentSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The current state of the Spot fleet request.

", + "locationName":"currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The previous state of the Spot fleet request.

", + "locationName":"previousSpotFleetRequestState" + } + }, + "documentation":"

Describes a Spot fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsSuccessItem", + "locationName":"item" + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + }, + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClientData":{ + "type":"structure", + "members":{ + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image, in GiB.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment about the disk upload.

" + } + }, + "documentation":"

Describes the client-specific data.

" + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + }, + "Return":{ + "shape":"Boolean", + "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName":"return" + } + } + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the task.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + } + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + } + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + } + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + } + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + } + }, + "CreateFlowLogsRequest":{ + "type":"structure", + "required":[ + "ResourceIds", + "ResourceType", + "TrafficType", + "LogGroupName", + "DeliverLogsPermissionArn" + ], + "members":{ + "ResourceIds":{ + "shape":"ValueStringList", + "documentation":"

One or more subnet, network interface, or VPC IDs.

", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowLogsResourceType", + "documentation":"

The type of resource on which to create the flow log.

" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic to log.

" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch log group.

" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the flow logs.

", + "locationName":"flowLogIdSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be created successfully.

", + "locationName":"unsuccessful" + } + } + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, this parameter is set to false, which means Amazon EC2 attempts to shut down the instance cleanly before image creation and then reboots the instance. When the parameter is set to true, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + } + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"

The format and location for an instance export task.

", + "locationName":"exportToS3" + } + } + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "documentation":"

Information about the instance export task.

", + "locationName":"exportTask" + } + } + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + } + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + } + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + } + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + } + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + } + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + } + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instances listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "CreateRouteResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + } + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + } + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + }, + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: Amazon EC2 selects one for you (recommended).

" + } + } + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + } + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + }, + "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + }, + "documentation":"

Describes modifications to the permissions for a volume.

" + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS (SSD) volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" + } + } + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "VpcId", + "ServiceName" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

", + "locationName":"RouteTableId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateVpcEndpointResult":{ + "type":"structure", + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"

Information about the endpoint.

", + "locationName":"vpcEndpoint" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + } + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + } + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The supported tenancy options for instances launched into the VPC. A value of default means that instances can be launched with any tenancy; a value of dedicated means all instances launched into the VPC are launched as dedicated tenancy instances regardless of the tenancy assigned to the instance at launch. Dedicated tenancy instances run on single-tenant hardware.

Default: default

", + "locationName":"instanceTenancy" + } + } + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + } + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + } + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + } + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + } + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + } + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + } + }, + "DeleteFlowLogsRequest":{ + "type":"structure", + "required":["FlowLogIds"], + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + } + } + }, + "DeleteFlowLogsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + } + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + } + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + } + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + } + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + } + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + } + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + } + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + } + } + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + } + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + } + }, + "DeleteVpcEndpointsRequest":{ + "type":"structure", + "required":["VpcEndpointIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + } + } + }, + "DeleteVpcEndpointsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the endpoints that were not successfully deleted.

", + "locationName":"unsuccessful" + } + } + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + } + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + } + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + } + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + } + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + } + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + } + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + } + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + } + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + } + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "documentation":"

Information about the conversion tasks.

", + "locationName":"conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + } + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + } + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "documentation":"

Information about the export tasks.

", + "locationName":"exportTaskSet" + } + } + }, + "DescribeFlowLogsRequest":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" + } + } + }, + "DescribeFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogs":{ + "shape":"FlowLogSet", + "documentation":"

Information about the flow logs.

", + "locationName":"flowLogSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + } + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | standard | io1).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + } + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import image task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single request.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

" + } + } + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import snapshot task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single request.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

" + } + } + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

", + "locationName":"attribute" + } + } + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance (spot).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface.id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface-private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

One or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + } + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + } + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + } + }, + "DescribeMovingAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"

One or more Elastic IP addresses.

", + "locationName":"publicIp" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName":"filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName":"maxResults" + } + } + }, + "DescribeMovingAddressesResult":{ + "type":"structure", + "members":{ + "MovingAddressStatuses":{ + "shape":"MovingAddressStatusSet", + "documentation":"

The status for each Elastic IP address.

", + "locationName":"movingAddressStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + } + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + } + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + } + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform Network Address Translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + } + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + } + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + } + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + } + }, + "DescribePrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribePrefixListsResult":{ + "type":"structure", + "members":{ + "PrefixLists":{ + "shape":"PrefixListSet", + "documentation":"

All available prefix lists.

", + "locationName":"prefixListSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + } + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance Listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + } + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + } + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + } + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from AWS and Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the Reserved Instance offering. A Reserved Instance with dedicated tenancy runs on single-tenant hardware and can only be launched within a VPC.

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + } + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type on which the Reserved Instance can be used.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + } + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + } + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + } + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + } + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + } + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + } + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + } + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotFleetInstancesRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetInstancesResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "ActiveInstances" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetRequestHistoryRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The type of events to describe. By default, all events are described.

", + "locationName":"eventType" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestHistoryResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime", + "LastEvaluatedTime", + "HistoryRecords" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "HistoryRecords":{ + "shape":"HistoryRecords", + "documentation":"

Information about the events in the history of the Spot fleet request.

", + "locationName":"historyRecordSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "DescribeSpotFleetRequestsResponse":{ + "type":"structure", + "required":["SpotFleetRequestConfigs"], + "members":{ + "SpotFleetRequestConfigs":{ + "shape":"SpotFleetRequestConfigSet", + "documentation":"

Information about the configuration of your Spot fleet.

", + "locationName":"spotFleetRequestConfigSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume (gp2 | standard | io1).

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m1.small).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m1.small).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + } + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + } + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + } + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + } + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "documentation":"

Information about the volumes.

", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + } + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + } + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpcEndpointServicesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribeVpcEndpointServicesResult":{ + "type":"structure", + "members":{ + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

A list of supported AWS services.

", + "locationName":"serviceNameSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribeVpcEndpointsResult":{ + "type":"structure", + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpointSet", + "documentation":"

Information about the endpoints.

", + "locationName":"vpcEndpointSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + } + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + } + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + } + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway.

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + } + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + } + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + } + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + } + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + } + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + } + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + } + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

Information about the disk image.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the disk image.

" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

Information about the volume.

" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

", + "locationName":"importManifestUrl" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + }, + "documentation":"

Describes a disk image volume.

" + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-1024 for standard volumes, 1-16384 for gp2 volumes, and 4-16384 for io1 volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + } + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + } + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + } + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "EventInformation":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", + "locationName":"instanceId" + }, + "EventSubType":{ + "shape":"String", + "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - Spot fleet did not have the required permissions either to launch or terminate an instance.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", + "locationName":"eventSubType" + }, + "EventDescription":{ + "shape":"String", + "documentation":"

The description of the event.

", + "locationName":"eventDescription" + } + }, + "documentation":"

Describes a Spot fleet event.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "instanceChange", + "fleetRequestChange", + "error" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the export task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

Information about the instance to export.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "documentation":"

Information about the export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The encryption key for your S3 bucket.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the format and location for an instance export task.

" + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "Float":{"type":"float"}, + "FlowLog":{ + "type":"structure", + "members":{ + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The date and time the flow log was created.

", + "locationName":"creationTime" + }, + "FlowLogId":{ + "shape":"String", + "documentation":"

The flow log ID.

", + "locationName":"flowLogId" + }, + "FlowLogStatus":{ + "shape":"String", + "documentation":"

The status of the flow log (ACTIVE).

", + "locationName":"flowLogStatus" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource on which the flow log was created.

", + "locationName":"resourceId" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic captured for the flow log.

", + "locationName":"trafficType" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the flow log group.

", + "locationName":"logGroupName" + }, + "DeliverLogsStatus":{ + "shape":"String", + "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", + "locationName":"deliverLogsStatus" + }, + "DeliverLogsErrorMessage":{ + "shape":"String", + "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", + "locationName":"deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "locationName":"deliverLogsPermissionArn" + } + }, + "documentation":"

Describes a flow log.

" + }, + "FlowLogSet":{ + "type":"list", + "member":{ + "shape":"FlowLog", + "locationName":"item" + } + }, + "FlowLogsResourceType":{ + "type":"string", + "enum":[ + "VPC", + "Subnet", + "NetworkInterface" + ] + }, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + } + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64 encoded.

", + "locationName":"output" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + } + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + } + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HistoryRecord":{ + "type":"structure", + "required":[ + "Timestamp", + "EventType", + "EventInformation" + ], + "members":{ + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", + "locationName":"eventType" + }, + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + } + }, + "documentation":"

Describes an event in the history of the Spot fleet request.

" + }, + "HistoryRecords":{ + "type":"list", + "member":{ + "shape":"HistoryRecord", + "locationName":"item" + } + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the disk.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "documentation":"

Describes the disk container object for an import image task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task.

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "documentation":"

Information about the disk containers.

", + "locationName":"DiskContainer" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.

Valid values: AWS | BYOL

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform.

Valid values: xen

" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + } + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + } + } + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor for the import task.

Valid values: xen

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the import image task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the import image task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import image task.

", + "locationName":"status" + } + }, + "documentation":"

Describes an import image task.

" + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

The Base64-encoded MIME user data to be made available to the instance.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the launch specification for VM import.

" + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

The launch specification.

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"

The disk image.

", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + } + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + } + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "documentation":"

One or more volumes.

", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import instance task.

" + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. You must base64 encode the public key material before sending it to AWS.

", + "locationName":"publicKeyMaterial" + } + } + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + } + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description string for the import snapshot task.

" + }, + "DiskContainer":{ + "shape":"SnapshotDiskContainer", + "documentation":"

Information about the disk container.

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + } + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Information about the import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + } + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Describes an import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import snapshot task.

" + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

The disk image.

", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the volume.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

The volume size.

", + "locationName":"volume" + } + } + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + } + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The Base64-encoded MIME user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance to export.

" + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":["spot"] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Any scheduled events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The event code.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes a scheduled event for an instance.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The protocol.

When you call DescribeSecurityGroups, the protocol value returned is the number. Exception: For TCP, UDP, and ICMP, the value returned is the name (for example, tcp, udp, or icmp). For a list of protocol numbers, see Protocol Numbers. (VPC only) When you call AuthorizeSecurityGroupIngress, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdList", + "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", + "locationName":"prefixListIds" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "LaunchSpecsList":{ + "type":"list", + "member":{ + "shape":"SpotFleetLaunchSpecification", + "locationName":"item" + }, + "min":1 + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

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

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + } + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + } + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + } + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + } + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

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

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + } + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + } + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + } + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You can only enable DNS hostnames if you also enable DNS support.

" + } + } + }, + "ModifyVpcEndpointRequest":{ + "type":"structure", + "required":["VpcEndpointId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the endpoint.

" + }, + "ResetPolicy":{ + "shape":"Boolean", + "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" + }, + "AddRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables IDs to associate with the endpoint.

", + "locationName":"AddRouteTableId" + }, + "RemoveRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs to disassociate from the endpoint.

", + "locationName":"RemoveRouteTableId" + } + } + }, + "ModifyVpcEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "MoveAddressToVpcRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + } + }, + "MoveAddressToVpcResult":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID for the Elastic IP address.

", + "locationName":"allocationId" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the move of the IP address.

", + "locationName":"status" + } + } + }, + "MoveStatus":{ + "type":"string", + "enum":[ + "movingToVpc", + "restoringToClassic" + ] + }, + "MovingAddressStatus":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "MoveStatus":{ + "shape":"MoveStatus", + "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", + "locationName":"moveStatus" + } + }, + "documentation":"

Describes the status of a moving Elastic IP address.

" + }, + "MovingAddressStatusSet":{ + "type":"list", + "member":{ + "shape":"MovingAddressStatus", + "locationName":"item" + } + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OperationType":{ + "type":"string", + "enum":[ + "add", + "remove" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "locationName":"tenancy" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PrefixList":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix.

", + "locationName":"prefixListName" + }, + "Cidrs":{ + "shape":"ValueStringList", + "documentation":"

The IP address range of the AWS service.

", + "locationName":"cidrSet" + } + }, + "documentation":"

Describes prefixes for AWS services.

" + }, + "PrefixListId":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + } + }, + "documentation":"

The ID of the prefix.

" + }, + "PrefixListIdList":{ + "type":"list", + "member":{ + "shape":"PrefixListId", + "locationName":"item" + } + }, + "PrefixListSet":{ + "type":"list", + "member":{ + "shape":"PrefixList", + "locationName":"item" + } + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of instances available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + } + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + } + } + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + } + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + } + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + } + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + } + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + } + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + } + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestSpotFleetRequest":{ + "type":"structure", + "required":["SpotFleetRequestConfig"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration for the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "RequestSpotFleetResponse":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + }, + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + } + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the reserved instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + } + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

", + "locationName":"attribute" + } + } + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + } + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" + } + } + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RestoreAddressToClassicRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + } + }, + "RestoreAddressToClassicResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

The move status for the IP address.

", + "locationName":"status" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + } + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + } + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The AWS account ID of the source security group. For EC2-VPC, the source security group must be in the same VPC. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + } + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationPrefixListId":{ + "shape":"String", + "documentation":"

The prefix of the AWS service.

", + "locationName":"destinationPrefixListId" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable indicates that route was automatically created when the route table was created.
  • CreateRoute indicates that the route was manually added to the route table.
  • EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instances.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + } + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

A Base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the Base64 encoded JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume that was used to create the snapshot.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"statusMessage" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + }, + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"dataEncryptionKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "locationName":"userBucket" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + } + }, + "documentation":"

Describes the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{"shape":"UserBucket"} + }, + "documentation":"

The disk container object for the import snapshot request.

" + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the import snapshot task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the import snapshot task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import snapshot task.

", + "locationName":"status" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot instance.

" + }, + "SpotFleetLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. To request an instance in a nondefault VPC, you must specify the ID of the security group. To request an instance in EC2-Classic or a default VPC, you can specify the name or the ID of the security group.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "Monitoring":{ + "shape":"SpotFleetMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "locationName":"weightedCapacity" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", + "locationName":"spotPrice" + } + }, + "documentation":"

Describes the launch specification for one or more Spot instances.

" + }, + "SpotFleetMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables monitoring for the instance.

Default: false

", + "locationName":"enabled" + } + }, + "documentation":"

Describes whether monitoring is enabled.

" + }, + "SpotFleetRequestConfig":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "SpotFleetRequestState", + "SpotFleetRequestConfig" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "SpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The state of the Spot fleet request.

", + "locationName":"spotFleetRequestState" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

Information about the configuration of the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Describes a Spot fleet request.

" + }, + "SpotFleetRequestConfigData":{ + "type":"structure", + "required":[ + "SpotPrice", + "TargetCapacity", + "IamFleetRole", + "LaunchSpecifications" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour.

", + "locationName":"spotPrice" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", + "locationName":"targetCapacity" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", + "locationName":"validUntil" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "IamFleetRole":{ + "shape":"String", + "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", + "locationName":"iamFleetRole" + }, + "LaunchSpecifications":{ + "shape":"LaunchSpecsList", + "documentation":"

Information about the launch specifications for the Spot fleet request.

", + "locationName":"launchSpecifications" + }, + "AllocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"

Determines how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", + "locationName":"allocationStrategy" + } + }, + "documentation":"

Describes the configuration of a Spot fleet request.

" + }, + "SpotFleetRequestConfigSet":{ + "type":"list", + "member":{ + "shape":"SpotFleetRequestConfig", + "locationName":"item" + } + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot instance.

", + "locationName":"productDescription" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describe a Spot instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + } + }, + "State":{ + "type":"string", + "enum":[ + "Pending", + "Available", + "Deleting", + "Deleted" + ] + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot Instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The volume limit was exceeded.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "Status":{ + "type":"string", + "enum":[ + "MoveInProgress", + "InVpc", + "InClassic" + ] + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data", + "initializing" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + } + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + } + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable", + "initializing" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + } + }, + "TrafficType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "ALL" + ] + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + } + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + } + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + } + }, + "UnsuccessfulItem":{ + "type":"structure", + "required":["Error"], + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "Error":{ + "shape":"UnsuccessfulItemError", + "documentation":"

Information about the error.

", + "locationName":"error" + } + }, + "documentation":"

Information about items that were not successfully processed in a batch call.

" + }, + "UnsuccessfulItemError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message accompanying the error code.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" + }, + "UnsuccessfulItemSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The key for the disk image.

" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The key from which the disk image was created.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instance.

", + "locationName":"data" + } + }, + "documentation":"

Describes the user data to be made available to an instance.

" + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. EC2-Classic only.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use GroupId.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"

Information about the volume attachments.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS (SSD) volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose (SSD) volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose (SSD) baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100 to 20000 for Provisioned IOPS (SSD) volumes and 3 to 10000 for General Purpose (SSD) volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create standard or gp2 volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the endpoint is associated.

", + "locationName":"vpcId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the AWS service to which the endpoint is associated.

", + "locationName":"serviceName" + }, + "State":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"state" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

The policy document associated with the endpoint.

", + "locationName":"policyDocument" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables associated with the endpoint.

", + "locationName":"routeTableIdSet" + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + } + }, + "documentation":"

Describes a VPC endpoint.

" + }, + "VpcEndpointSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the peer VPC.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

The information of the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"VpcPeeringConnectionStateReasonCode", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionStateReasonCode":{ + "type":"string", + "enum":[ + "initiating-request", + "pending-acceptance", + "active", + "deleted", + "rejected", + "failed", + "expired", + "provisioning", + "deleting" + ] + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + } + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/ec2/2015-04-15/waiters-2.json b/aws/dist/botocore/data/ec2/2015-04-15/waiters-2.json new file mode 100644 index 00000000..5a6dbbc9 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-04-15/waiters-2.json @@ -0,0 +1,458 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceIDNotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolumeNotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-10-01/paginators-1.json b/aws/dist/botocore/data/ec2/2015-10-01/paginators-1.json new file mode 100644 index 00000000..2bd01ad5 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-10-01/paginators-1.json @@ -0,0 +1,63 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + }, + "DescribeSpotFleetRequests": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotFleetRequestConfigs" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Volumes" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2015-10-01/service-2.json b/aws/dist/botocore/data/ec2/2015-10-01/service-2.json new file mode 100644 index 00000000..f7b37154 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-10-01/service-2.json @@ -0,0 +1,17076 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-01", + "endpointPrefix":"ec2", + "protocol":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2015-10-01" + }, + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AllocateHosts":{ + "name":"AllocateHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateHostsRequest"}, + "output":{"shape":"AllocateHostsResult"}, + "documentation":"

Allocates a Dedicated host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests":{ + "name":"CancelSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotFleetRequestsRequest"}, + "output":{"shape":"CancelSpotFleetRequestsResponse"}, + "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFlowLogs":{ + "name":"CreateFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowLogsRequest"}, + "output":{"shape":"CreateFlowLogsResult"}, + "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting EC2 Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{"shape":"KeyPair"}, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateNatGateway":{ + "name":"CreateNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNatGatewayRequest"}, + "output":{"shape":"CreateNatGatewayResult"}, + "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "output":{"shape":"CreateRouteResult"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{"shape":"Snapshot"}, + "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 10 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{"shape":"Volume"}, + "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResult"}, + "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteFlowLogs":{ + "name":"DeleteFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowLogsRequest"}, + "output":{"shape":"DeleteFlowLogsResult"}, + "documentation":"

Deletes one or more flow logs.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNatGateway":{ + "name":"DeleteNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNatGatewayRequest"}, + "output":{"shape":"DeleteNatGatewayResult"}, + "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot instances.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpoints":{ + "name":"DeleteVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointsRequest"}, + "output":{"shape":"DeleteVpcEndpointsResult"}, + "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeFlowLogs":{ + "name":"DescribeFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlowLogsRequest"}, + "output":{"shape":"DescribeFlowLogsResult"}, + "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeHosts":{ + "name":"DescribeHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostsRequest"}, + "output":{"shape":"DescribeHostsResult"}, + "documentation":"

Describes one or more of your Dedicated hosts.

The results describe only the Dedicated hosts in the region you're currently using. All listed instances consume capacity on your Dedicated host. Dedicated hosts that have recently been released will be listed with the state released.

" + }, + "DescribeIdFormat":{ + "name":"DescribeIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdFormatRequest"}, + "output":{"shape":"DescribeIdFormatResult"}, + "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{"shape":"ImageAttribute"}, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeMovingAddresses":{ + "name":"DescribeMovingAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMovingAddressesRequest"}, + "output":{"shape":"DescribeMovingAddressesResult"}, + "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNatGateways":{ + "name":"DescribeNatGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNatGatewaysRequest"}, + "output":{"shape":"DescribeNatGatewaysResult"}, + "documentation":"

Describes one or more of the your NAT gateways.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists":{ + "name":"DescribePrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrefixListsRequest"}, + "output":{"shape":"DescribePrefixListsResult"}, + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeScheduledInstanceAvailability":{ + "name":"DescribeScheduledInstanceAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, + "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, + "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" + }, + "DescribeScheduledInstances":{ + "name":"DescribeScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstancesRequest"}, + "output":{"shape":"DescribeScheduledInstancesResult"}, + "documentation":"

Describes one or more of your Scheduled Instances.

" + }, + "DescribeSecurityGroupReferences":{ + "name":"DescribeSecurityGroupReferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, + "output":{"shape":"DescribeSecurityGroupReferencesResult"}, + "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotFleetInstances":{ + "name":"DescribeSpotFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetInstancesRequest"}, + "output":{"shape":"DescribeSpotFleetInstancesResponse"}, + "documentation":"

Describes the running instances for the specified Spot fleet.

" + }, + "DescribeSpotFleetRequestHistory":{ + "name":"DescribeSpotFleetRequestHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, + "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, + "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" + }, + "DescribeSpotFleetRequests":{ + "name":"DescribeSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestsRequest"}, + "output":{"shape":"DescribeSpotFleetRequestsResponse"}, + "documentation":"

Describes your Spot fleet requests.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeStaleSecurityGroups":{ + "name":"DescribeStaleSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, + "output":{"shape":"DescribeStaleSecurityGroupsResult"}, + "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcClassicLinkDnsSupport":{ + "name":"DescribeVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, + "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcEndpointServices":{ + "name":"DescribeVpcEndpointServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicesRequest"}, + "output":{"shape":"DescribeVpcEndpointServicesResult"}, + "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResult"}, + "documentation":"

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so results in the volume being stuck in a busy state while detaching.

If an Amazon EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisableVpcClassicLinkDnsSupport":{ + "name":"DisableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EnableVpcClassicLinkDnsSupport":{ + "name":"EnableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetConsoleScreenshot":{ + "name":"GetConsoleScreenshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleScreenshotRequest"}, + "output":{"shape":"GetConsoleScreenshotResult"}, + "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is base64-encoded.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. After importing the image, you then upload it using the ec2-import-volume command in the EC2 command line tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image. After importing the image, you then upload it using the ec2-import-volume command in the Amazon EC2 command-line interface (CLI) tools. For more information, see Using the Command Line Tools to Import Your Virtual Machine to Amazon EC2 in the Amazon Elastic Compute Cloud User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ModifyHosts":{ + "name":"ModifyHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHostsRequest"}, + "output":{"shape":"ModifyHostsResult"}, + "documentation":"

Modify the auto-placement setting of a Dedicated host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" + }, + "ModifyIdFormat":{ + "name":"ModifyIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdFormatRequest"}, + "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user or as an IAM role that has permission to use this action, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Controlling Access to Longer ID Settings in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstancePlacement":{ + "name":"ModifyInstancePlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstancePlacementRequest"}, + "output":{"shape":"ModifyInstancePlacementResult"}, + "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

Snapshots with AWS Marketplace product codes cannot be made public.

" + }, + "ModifySpotFleetRequest":{ + "name":"ModifySpotFleetRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySpotFleetRequestRequest"}, + "output":{"shape":"ModifySpotFleetRequestResponse"}, + "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint":{ + "name":"ModifyVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointRequest"}, + "output":{"shape":"ModifyVpcEndpointResult"}, + "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" + }, + "ModifyVpcPeeringConnectionOptions":{ + "name":"ModifyVpcPeeringConnectionOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, + "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, + "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to enable or disable communication in either direction, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "MoveAddressToVpc":{ + "name":"MoveAddressToVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAddressToVpcRequest"}, + "output":{"shape":"MoveAddressToVpcResult"}, + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseScheduledInstances":{ + "name":"PurchaseScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseScheduledInstancesRequest"}, + "output":{"shape":"PurchaseScheduledInstancesResult"}, + "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReleaseHosts":{ + "name":"ReleaseHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseHostsRequest"}, + "output":{"shape":"ReleaseHostsResult"}, + "documentation":"

When you no longer want to use a Dedicated host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet":{ + "name":"RequestSpotFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotFleetRequest"}, + "output":{"shape":"RequestSpotFleetResponse"}, + "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic":{ + "name":"RestoreAddressToClassic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreAddressToClassicRequest"}, + "output":{"shape":"RestoreAddressToClassicResult"}, + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{"shape":"Reservation"}, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RunScheduledInstances":{ + "name":"RunScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunScheduledInstancesRequest"}, + "output":{"shape":"RunScheduledInstancesResult"}, + "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "ActiveInstance":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + } + }, + "documentation":"

Describes a running instance in a Spot fleet.

" + }, + "ActiveInstanceSet":{ + "type":"list", + "member":{ + "shape":"ActiveInstance", + "locationName":"item" + } + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "Affinity":{ + "type":"string", + "enum":[ + "default", + "host" + ] + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + }, + "documentation":"

Contains the parameters for AllocateAddress.

" + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + }, + "documentation":"

Contains the output of AllocateAddress.

" + }, + "AllocateHostsRequest":{ + "type":"structure", + "required":[ + "InstanceType", + "Quantity", + "AvailabilityZone" + ], + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", + "locationName":"autoPlacement" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

Specify the instance type that you want your Dedicated hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", + "locationName":"instanceType" + }, + "Quantity":{ + "shape":"Integer", + "documentation":"

The number of Dedicated hosts you want to allocate to your account with these parameters.

", + "locationName":"quantity" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the Dedicated hosts.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Contains the parameters for AllocateHosts.

" + }, + "AllocateHostsResult":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"ResponseHostIdList", + "documentation":"

The ID of the allocated Dedicated host. This is used when you want to launch an instance onto a specific host.

", + "locationName":"hostIdSet" + } + }, + "documentation":"

Contains the output of AllocateHosts.

" + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "AllocationState":{ + "type":"string", + "enum":[ + "available", + "under-assessment", + "permanent-failure", + "released", + "released-permanent-failure" + ] + }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "diversified" + ] + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + }, + "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "locationName":"allowReassociation" + } + }, + "documentation":"

Contains the parameters for AssociateAddress.

" + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateAddress.

" + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AssociateDhcpOptions.

" + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for AssociateRouteTable.

" + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateRouteTable.

" + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of AttachClassicLinkVpc.

" + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for AttachInternetGateway.

" + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + }, + "documentation":"

Contains the parameters for AttachNetworkInterface.

" + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + }, + "documentation":"

Contains the output of AttachNetworkInterface.

" + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + }, + "documentation":"

Contains the parameters for AttachVolume.

" + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AttachVpnGateway.

" + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of AttachVpnGateway.

" + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

Valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

The value to use when a resource attribute accepts a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

Valid values are case-sensitive and vary by action.

", + "locationName":"value" + } + }, + "documentation":"

The value to use for a resource attribute.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" + }, + "AutoPlacement":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone.

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":[ + "available", + "information", + "impaired", + "unavailable" + ] + }, + "AvailableCapacity":{ + "type":"structure", + "members":{ + "AvailableInstanceCapacity":{ + "shape":"AvailableInstanceCapacityList", + "documentation":"

The total number of instances that the Dedicated host supports.

", + "locationName":"availableInstanceCapacity" + }, + "AvailableVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs available on the Dedicated host.

", + "locationName":"availableVCpus" + } + }, + "documentation":"

The capacity information for instances launched onto the Dedicated host.

" + }, + "AvailableInstanceCapacityList":{ + "type":"list", + "member":{ + "shape":"InstanceCapacity", + "locationName":"item" + } + }, + "BatchState":{ + "type":"string", + "enum":[ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating", + "modifying" + ] + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + }, + "documentation":"

Contains the parameters for BundleInstance.

" + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of BundleInstance.

" + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBatchErrorCode":{ + "type":"string", + "enum":[ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + }, + "documentation":"

Contains the parameters for CancelBundleTask.

" + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of CancelBundleTask.

" + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "documentation":"

The reason for canceling the conversion task.

", + "locationName":"reasonMessage" + } + }, + "documentation":"

Contains the parameters for CancelConversionTask.

" + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for CancelExportTask.

" + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image or import snapshot task to be canceled.

" + }, + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + } + }, + "documentation":"

Contains the parameters for CancelImportTask.

" + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the task being canceled.

", + "locationName":"importTaskId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"state" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"previousState" + } + }, + "documentation":"

Contains the output for CancelImportTask.

" + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + }, + "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CancelReservedInstancesListing.

" + }, + "CancelSpotFleetRequestsError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"CancelBatchErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "Error" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "Error":{ + "shape":"CancelSpotFleetRequestsError", + "documentation":"

The error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsErrorItem", + "locationName":"item" + } + }, + "CancelSpotFleetRequestsRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", + "locationName":"terminateInstances" + } + }, + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "UnsuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsErrorSet", + "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", + "locationName":"unsuccessfulFleetRequestSet" + }, + "SuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsSuccessSet", + "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", + "locationName":"successfulFleetRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "CurrentSpotFleetRequestState", + "PreviousSpotFleetRequestState" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "CurrentSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The current state of the Spot fleet request.

", + "locationName":"currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The previous state of the Spot fleet request.

", + "locationName":"previousSpotFleetRequestState" + } + }, + "documentation":"

Describes a Spot fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsSuccessItem", + "locationName":"item" + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + }, + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkDnsSupport":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkDnsSupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "locationName":"classicLinkDnsSupported" + } + }, + "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" + }, + "ClassicLinkDnsSupportList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkDnsSupport", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClientData":{ + "type":"structure", + "members":{ + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image, in GiB.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment about the disk upload.

" + } + }, + "documentation":"

Describes the client-specific data.

" + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for ConfirmProductInstance.

" + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + }, + "Return":{ + "shape":"Boolean", + "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ConfirmProductInstance.

" + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the task.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopyImage.

" + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CopyImage.

" + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopySnapshot.

" + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Contains the output of CopySnapshot.

" + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + }, + "documentation":"

Contains the parameters for CreateCustomerGateway.

" + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + }, + "documentation":"

Contains the output of CreateCustomerGateway.

" + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + }, + "documentation":"

Contains the parameters for CreateDhcpOptions.

" + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + }, + "documentation":"

Contains the output of CreateDhcpOptions.

" + }, + "CreateFlowLogsRequest":{ + "type":"structure", + "required":[ + "ResourceIds", + "ResourceType", + "TrafficType", + "LogGroupName", + "DeliverLogsPermissionArn" + ], + "members":{ + "ResourceIds":{ + "shape":"ValueStringList", + "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowLogsResourceType", + "documentation":"

The type of resource on which to create the flow log.

" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic to log.

" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch log group.

" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateFlowLogs.

" + }, + "CreateFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the flow logs.

", + "locationName":"flowLogIdSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be created successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of CreateFlowLogs.

" + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Contains the parameters for CreateImage.

" + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CreateImage.

" + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"

The format and location for an instance export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Contains the parameters for CreateInstanceExportTask.

" + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "documentation":"

Information about the instance export task.

", + "locationName":"exportTask" + } + }, + "documentation":"

Contains the output for CreateInstanceExportTask.

" + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateInternetGateway.

" + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + }, + "documentation":"

Contains the output of CreateInternetGateway.

" + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + }, + "documentation":"

Contains the parameters for CreateKeyPair.

" + }, + "CreateNatGatewayRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "AllocationId" + ], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The subnet in which to create the NAT gateway.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + } + }, + "documentation":"

Contains the parameters for CreateNatGateway.

" + }, + "CreateNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGateway":{ + "shape":"NatGateway", + "documentation":"

Information about the NAT gateway.

", + "locationName":"natGateway" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateNatGateway.

" + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAcl.

" + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + }, + "documentation":"

Contains the output of CreateNetworkAcl.

" + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateNetworkInterface.

" + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + }, + "documentation":"

Contains the output of CreateNetworkInterface.

" + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + }, + "documentation":"

Contains the parameters for CreatePlacementGroup.

" + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CreateReservedInstancesListing.

" + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for CreateRoute.

" + }, + "CreateRouteResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of CreateRoute.

" + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateRouteTable.

" + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + }, + "documentation":"

Contains the output of CreateRouteTable.

" + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for CreateSecurityGroup.

" + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Contains the output of CreateSecurityGroup.

" + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + }, + "documentation":"

Contains the parameters for CreateSnapshot.

" + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + }, + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" + } + }, + "documentation":"

Contains the parameters for CreateSubnet.

" + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + }, + "documentation":"

Contains the output of CreateSubnet.

" + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + }, + "documentation":"

Contains the parameters for CreateTags.

" + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + }, + "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + }, + "documentation":"

Describes modifications to the permissions for a volume.

" + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" + } + }, + "documentation":"

Contains the parameters for CreateVolume.

" + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "VpcId", + "ServiceName" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

", + "locationName":"RouteTableId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateVpcEndpoint.

" + }, + "CreateVpcEndpointResult":{ + "type":"structure", + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"

Information about the endpoint.

", + "locationName":"vpcEndpoint" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateVpcEndpoint.

" + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + }, + "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of CreateVpcPeeringConnection.

" + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName":"instanceTenancy" + } + }, + "documentation":"

Contains the parameters for CreateVpc.

" + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + }, + "documentation":"

Contains the output of CreateVpc.

" + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnection.

" + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + }, + "documentation":"

Contains the output of CreateVpnConnection.

" + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnGateway.

" + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + }, + "documentation":"

Contains the output of CreateVpnGateway.

" + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteCustomerGateway.

" + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + }, + "documentation":"

Contains the parameters for DeleteDhcpOptions.

" + }, + "DeleteFlowLogsRequest":{ + "type":"structure", + "required":["FlowLogIds"], + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + } + }, + "documentation":"

Contains the parameters for DeleteFlowLogs.

" + }, + "DeleteFlowLogsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteFlowLogs.

" + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + }, + "documentation":"

Contains the parameters for DeleteInternetGateway.

" + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + }, + "documentation":"

Contains the parameters for DeleteKeyPair.

" + }, + "DeleteNatGatewayRequest":{ + "type":"structure", + "required":["NatGatewayId"], + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteNatGateway.

" + }, + "DeleteNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the output of DeleteNatGateway.

" + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAcl.

" + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkInterface.

" + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + }, + "documentation":"

Contains the parameters for DeletePlacementGroup.

" + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + }, + "documentation":"

Contains the parameters for DeleteRoute.

" + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for DeleteRouteTable.

" + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteSecurityGroup.

" + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + } + }, + "documentation":"

Contains the parameters for DeleteSnapshot.

" + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + }, + "documentation":"

Contains the parameters for DeleteSubnet.

" + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + }, + "documentation":"

Contains the parameters for DeleteTags.

" + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + }, + "documentation":"

Contains the parameters for DeleteVolume.

" + }, + "DeleteVpcEndpointsRequest":{ + "type":"structure", + "required":["VpcEndpointIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" + }, + "DeleteVpcEndpointsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the endpoints that were not successfully deleted.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteVpcEndpoints.

" + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpc.

" + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnection.

" + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnGateway.

" + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + }, + "documentation":"

Contains the parameters for DeregisterImage.

" + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + }, + "documentation":"

Contains the parameters for DescribeAccountAttributes.

" + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + }, + "documentation":"

Contains the output of DescribeAccountAttributes.

" + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + }, + "documentation":"

Contains the parameters for DescribeAddresses.

" + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + }, + "documentation":"

Contains the output of DescribeAddresses.

" + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + }, + "documentation":"

Contains the output of DescribeAvailabiltyZones.

" + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeBundleTasks.

" + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + }, + "documentation":"

Contains the output of DescribeBundleTasks.

" + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeClassicLinkInstances.

" + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeConversionTasks.

" + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "documentation":"

Information about the conversion tasks.

", + "locationName":"conversionTasks" + } + }, + "documentation":"

Contains the output for DescribeConversionTasks.

" + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeCustomerGateways.

" + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeCustomerGateways.

" + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeDhcpOptions.

" + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + }, + "documentation":"

Contains the output of DescribeDhcpOptions.

" + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeExportTasks.

" + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "documentation":"

Information about the export tasks.

", + "locationName":"exportTaskSet" + } + }, + "documentation":"

Contains the output for DescribeExportTasks.

" + }, + "DescribeFlowLogsRequest":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeFlowLogs.

" + }, + "DescribeFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogs":{ + "shape":"FlowLogSet", + "documentation":"

Information about the flow logs.

", + "locationName":"flowLogSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeFlowLogs.

" + }, + "DescribeHostsRequest":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.

", + "locationName":"hostId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", + "locationName":"maxResults" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation associated with this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeHosts.

" + }, + "DescribeHostsResult":{ + "type":"structure", + "members":{ + "Hosts":{ + "shape":"HostList", + "documentation":"

Information about the Dedicated hosts.

", + "locationName":"hostSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeHosts.

" + }, + "DescribeIdFormatRequest":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

" + } + }, + "documentation":"

Contains the parameters for DescribeIdFormat.

" + }, + "DescribeIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resource.

", + "locationName":"statusSet" + } + }, + "documentation":"

Contains the output of DescribeIdFormat.

" + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + }, + "documentation":"

Contains the parameters for DescribeImageAttribute.

" + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, amazon (owner is Amazon), aws-marketplace (owner is AWS Marketplace), self (owner is the sender of the request). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - The AWS account alias (for example, amazon).

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeImages.

" + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + }, + "documentation":"

Contains the output of DescribeImages.

" + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import image task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportImageTasks.

" + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportImageTasks.

" + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import snapshot task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceStatus.

" + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstanceStatus.

" + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-Id - The ID of the Dedicated host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeInstances.

" + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

Zero or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstances.

" + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeInternetGateways.

" + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeInternetGateways.

" + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeKeyPairs.

" + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + }, + "documentation":"

Contains the output of DescribeKeyPairs.

" + }, + "DescribeMovingAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"

One or more Elastic IP addresses.

", + "locationName":"publicIp" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName":"filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeMovingAddresses.

" + }, + "DescribeMovingAddressesResult":{ + "type":"structure", + "members":{ + "MovingAddressStatuses":{ + "shape":"MovingAddressStatusSet", + "documentation":"

The status for each Elastic IP address.

", + "locationName":"movingAddressStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeMovingAddresses.

" + }, + "DescribeNatGatewaysRequest":{ + "type":"structure", + "members":{ + "NatGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more NAT gateway IDs.

", + "locationName":"NatGatewayId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + }, + "documentation":"

Contains the parameters for DescribeNatGateways.

" + }, + "DescribeNatGatewaysResult":{ + "type":"structure", + "members":{ + "NatGateways":{ + "shape":"NatGatewayList", + "documentation":"

Information about the NAT gateways.

", + "locationName":"natGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeNatGateways.

" + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkAcls.

" + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkAcls.

" + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaces.

" + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribePlacementGroups.

" + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + }, + "documentation":"

Contains the output of DescribePlacementGroups.

" + }, + "DescribePrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribePrefixLists.

" + }, + "DescribePrefixListsResult":{ + "type":"structure", + "members":{ + "PrefixLists":{ + "shape":"PrefixListSet", + "documentation":"

All available prefix lists.

", + "locationName":"prefixListSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribePrefixLists.

" + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRegions.

" + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + }, + "documentation":"

Contains the output of DescribeRegions.

" + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstances.

" + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + }, + "documentation":"

Contains the output for DescribeReservedInstances.

" + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRouteTables.

" + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + }, + "documentation":"

Contains the output of DescribeRouteTables.

" + }, + "DescribeScheduledInstanceAvailabilityRequest":{ + "type":"structure", + "required":[ + "Recurrence", + "FirstSlotStartTimeRange" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrenceRequest", + "documentation":"

The schedule recurrence.

" + }, + "FirstSlotStartTimeRange":{ + "shape":"SlotDateTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "MinSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" + }, + "MaxSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstanceAvailabilityResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceAvailabilitySet":{ + "shape":"ScheduledInstanceAvailabilitySet", + "documentation":"

Information about the available Scheduled Instances.

", + "locationName":"scheduledInstanceAvailabilitySet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ScheduledInstanceIds":{ + "shape":"ScheduledInstanceIdRequestSet", + "documentation":"

One or more Scheduled Instance IDs.

", + "locationName":"ScheduledInstanceId" + }, + "SlotStartTimeRange":{ + "shape":"SlotStartTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstances.

" + }, + "DescribeScheduledInstancesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceSet":{ + "shape":"ScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstances.

" + }, + "DescribeSecurityGroupReferencesRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"GroupIds", + "documentation":"

One or more security group IDs in your account.

" + } + } + }, + "DescribeSecurityGroupReferencesResult":{ + "type":"structure", + "members":{ + "SecurityGroupReferenceSet":{ + "shape":"SecurityGroupReferences", + "documentation":"

Information about the VPCs with the referencing security groups.

", + "locationName":"securityGroupReferenceSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSecurityGroups.

" + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + }, + "documentation":"

Contains the output of DescribeSecurityGroups.

" + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshots.

" + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSnapshots.

" + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotFleetInstancesRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetInstancesResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "ActiveInstances" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetRequestHistoryRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The type of events to describe. By default, all events are described.

", + "locationName":"eventType" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestHistoryResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime", + "LastEvaluatedTime", + "HistoryRecords" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "HistoryRecords":{ + "shape":"HistoryRecords", + "documentation":"

Information about the events in the history of the Spot fleet request.

", + "locationName":"historyRecordSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "DescribeSpotFleetRequestsResponse":{ + "type":"structure", + "required":["SpotFleetRequestConfigs"], + "members":{ + "SpotFleetRequestConfigs":{ + "shape":"SpotFleetRequestConfigSet", + "documentation":"

Information about the configuration of your Spot fleet.

", + "locationName":"spotFleetRequestConfigSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "DescribeStaleSecurityGroupsRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribeStaleSecurityGroupsResult":{ + "type":"structure", + "members":{ + "StaleSecurityGroupSet":{ + "shape":"StaleSecurityGroupSet", + "documentation":"

Information about the stale security groups.

", + "locationName":"staleSecurityGroupSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSubnets.

" + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + }, + "documentation":"

Contains the output of DescribeSubnets.

" + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeTags.

" + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeTags.

" + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeVolumeAttribute.

" + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeStatus.

" + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumeStatus.

" + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeVolumes.

" + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "documentation":"

Information about the volumes.

", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumes.

" + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":[ + "VpcId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcAttribute.

" + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + }, + "documentation":"

Contains the output of DescribeVpcAttribute.

" + }, + "DescribeVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPC IDs.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"ClassicLinkDnsSupportList", + "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", + "locationName":"vpcs" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use when requesting the next set of items.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLink.

" + }, + "DescribeVpcEndpointServicesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointServicesResult":{ + "type":"structure", + "members":{ + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

A list of supported AWS services.

", + "locationName":"serviceNameSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" + }, + "DescribeVpcEndpointsResult":{ + "type":"structure", + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpointSet", + "documentation":"

Information about the endpoints.

", + "locationName":"vpcEndpointSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpoints.

" + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcs.

" + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcs.

" + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnConnections.

" + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpnConnections.

" + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnGateways.

" + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeVpnGateways.

" + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DetachClassicLinkVpc.

" + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachInternetGateway.

" + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for DetachNetworkInterface.

" + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + }, + "documentation":"

Contains the parameters for DetachVolume.

" + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DetachVpnGateway.

" + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" + }, + "DisableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLink.

" + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLink.

" + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for DisassociateAddress.

" + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the parameters for DisassociateRouteTable.

" + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

Information about the disk image.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the disk image.

" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

Information about the volume.

" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + }, + "documentation":"

Describes a disk image volume.

" + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Contains the parameters for EnableVolumeIO.

" + }, + "EnableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLink.

" + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLink.

" + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "EventInformation":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", + "locationName":"instanceId" + }, + "EventSubType":{ + "shape":"String", + "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", + "locationName":"eventSubType" + }, + "EventDescription":{ + "shape":"String", + "documentation":"

The description of the event.

", + "locationName":"eventDescription" + } + }, + "documentation":"

Describes a Spot fleet event.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "instanceChange", + "fleetRequestChange", + "error" + ] + }, + "ExcessCapacityTerminationPolicy":{ + "type":"string", + "enum":[ + "noTermination", + "default" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the export task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

Information about the instance to export.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "documentation":"

Information about the export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The encryption key for your S3 bucket.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the format and location for an instance export task.

" + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FleetType":{ + "type":"string", + "enum":[ + "request", + "maintain" + ] + }, + "Float":{"type":"float"}, + "FlowLog":{ + "type":"structure", + "members":{ + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The date and time the flow log was created.

", + "locationName":"creationTime" + }, + "FlowLogId":{ + "shape":"String", + "documentation":"

The flow log ID.

", + "locationName":"flowLogId" + }, + "FlowLogStatus":{ + "shape":"String", + "documentation":"

The status of the flow log (ACTIVE).

", + "locationName":"flowLogStatus" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource on which the flow log was created.

", + "locationName":"resourceId" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic captured for the flow log.

", + "locationName":"trafficType" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the flow log group.

", + "locationName":"logGroupName" + }, + "DeliverLogsStatus":{ + "shape":"String", + "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", + "locationName":"deliverLogsStatus" + }, + "DeliverLogsErrorMessage":{ + "shape":"String", + "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", + "locationName":"deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "locationName":"deliverLogsPermissionArn" + } + }, + "documentation":"

Describes a flow log.

" + }, + "FlowLogSet":{ + "type":"list", + "member":{ + "shape":"FlowLog", + "locationName":"item" + } + }, + "FlowLogsResourceType":{ + "type":"string", + "enum":[ + "VPC", + "Subnet", + "NetworkInterface" + ] + }, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for GetConsoleOutput.

" + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, base64-encoded. If using a command line tool, the tools decode the output for you.

", + "locationName":"output" + } + }, + "documentation":"

Contains the output of GetConsoleOutput.

" + }, + "GetConsoleScreenshotRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "WakeUp":{ + "shape":"Boolean", + "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" + } + }, + "documentation":"

Contains the parameters for the request.

" + }, + "GetConsoleScreenshotResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageData":{ + "shape":"String", + "documentation":"

The data that comprises the image.

", + "locationName":"imageData" + } + }, + "documentation":"

Contains the output of the request.

" + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + }, + "documentation":"

Contains the parameters for GetPasswordData.

" + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + }, + "documentation":"

Contains the output of GetPasswordData.

" + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupIds":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HistoryRecord":{ + "type":"structure", + "required":[ + "Timestamp", + "EventType", + "EventInformation" + ], + "members":{ + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", + "locationName":"eventType" + }, + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + } + }, + "documentation":"

Describes an event in the history of the Spot fleet request.

" + }, + "HistoryRecords":{ + "type":"list", + "member":{ + "shape":"HistoryRecord", + "locationName":"item" + } + }, + "Host":{ + "type":"structure", + "members":{ + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated host.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Whether auto-placement is on or off.

", + "locationName":"autoPlacement" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.

", + "locationName":"hostReservationId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "HostProperties":{ + "shape":"HostProperties", + "documentation":"

The hardware specifications of the Dedicated host.

", + "locationName":"hostProperties" + }, + "State":{ + "shape":"AllocationState", + "documentation":"

The Dedicated host's state.

", + "locationName":"state" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the Dedicated host.

", + "locationName":"availabilityZone" + }, + "Instances":{ + "shape":"HostInstanceList", + "documentation":"

The IDs and instance type that are currently running on the Dedicated host.

", + "locationName":"instances" + }, + "AvailableCapacity":{ + "shape":"AvailableCapacity", + "documentation":"

The number of new instances that can be launched onto the Dedicated host.

", + "locationName":"availableCapacity" + } + }, + "documentation":"

Describes the properties of the Dedicated host.

" + }, + "HostInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

the IDs of instances that are running on the Dedicated host.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes an instance running on a Dedicated host.

" + }, + "HostInstanceList":{ + "type":"list", + "member":{ + "shape":"HostInstance", + "locationName":"item" + } + }, + "HostList":{ + "type":"list", + "member":{ + "shape":"Host", + "locationName":"item" + } + }, + "HostProperties":{ + "type":"structure", + "members":{ + "Sockets":{ + "shape":"Integer", + "documentation":"

The number of sockets on the Dedicated host.

", + "locationName":"sockets" + }, + "Cores":{ + "shape":"Integer", + "documentation":"

The number of cores on the Dedicated host.

", + "locationName":"cores" + }, + "TotalVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs on the Dedicated host.

", + "locationName":"totalVCpus" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size that the Dedicated host supports (for example, m3.medium).

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes properties of a Dedicated host.

" + }, + "HostTenancy":{ + "type":"string", + "enum":[ + "dedicated", + "host" + ] + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "IdFormat":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "locationName":"useLongIds" + }, + "Deadline":{ + "shape":"DateTime", + "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "locationName":"deadline" + } + }, + "documentation":"

Describes the ID format for a resource.

" + }, + "IdFormatList":{ + "type":"list", + "member":{ + "shape":"IdFormat", + "locationName":"item" + } + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the disk.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "documentation":"

Describes the disk container object for an import image task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task.

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "documentation":"

Information about the disk containers.

", + "locationName":"DiskContainer" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see VM Import/Export Prerequisites in the Amazon Elastic Compute Cloud User Guide.

Valid values: AWS | BYOL

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform.

Valid values: xen

" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportImage.

" + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output for ImportImage.

" + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor for the import task.

Valid values: xen

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the import image task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the import image task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import image task.

", + "locationName":"status" + } + }, + "documentation":"

Describes an import image task.

" + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

The Base64-encoded MIME user data to be made available to the instance.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the launch specification for VM import.

" + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

The launch specification.

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"

The disk image.

", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + }, + "documentation":"

Contains the parameters for ImportInstance.

" + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportInstance.

" + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "documentation":"

One or more volumes.

", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import instance task.

" + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", + "locationName":"publicKeyMaterial" + } + }, + "documentation":"

Contains the parameters for ImportKeyPair.

" + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Contains the output of ImportKeyPair.

" + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description string for the import snapshot task.

" + }, + "DiskContainer":{ + "shape":"SnapshotDiskContainer", + "documentation":"

Information about the disk container.

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportSnapshot.

" + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Information about the import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Contains the output for ImportSnapshot.

" + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Describes an import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import snapshot task.

" + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

The disk image.

", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the volume.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

The volume size.

", + "locationName":"volume" + } + }, + "documentation":"

Contains the parameters for ImportVolume.

" + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportVolume.

" + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance, if applicable.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched, if applicable.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance, if applicable.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance, if applicable.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance, if applicable.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

If the request is a Spot instance request, the ID of the request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance, if applicable.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The Base64-encoded MIME user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "locationName":"sriovNetSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCapacity":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size supported by the Dedicated host.

", + "locationName":"instanceType" + }, + "AvailableCapacity":{ + "shape":"Integer", + "documentation":"

The number of instances that can still be launched onto the Dedicated host.

", + "locationName":"availableCapacity" + }, + "TotalCapacity":{ + "shape":"Integer", + "documentation":"

The total number of instances that can be launched onto the Dedicated host.

", + "locationName":"totalCapacity" + } + }, + "documentation":"

Information about the instance type that the Dedicated host supports.

" + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance to export.

" + }, + "InstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":[ + "spot", + "scheduled" + ] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Any scheduled events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The event code.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes a scheduled event for an instance.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "t2.nano", + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "x1.4xlarge", + "x1.8xlarge", + "x1.16xlarge", + "x1.32xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "g2.8xlarge", + "cg1.4xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdList", + "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", + "locationName":"prefixListIds" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "IpRanges":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "LaunchSpecsList":{ + "type":"list", + "member":{ + "shape":"SpotFleetLaunchSpecification", + "locationName":"item" + }, + "min":1 + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "ModifyHostsRequest":{ + "type":"structure", + "required":[ + "HostIds", + "AutoPlacement" + ], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The host IDs of the Dedicated hosts you want to modify.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Specify whether to enable or disable auto-placement.

", + "locationName":"autoPlacement" + } + }, + "documentation":"

Contains the parameters for ModifyHosts.

" + }, + "ModifyHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated hosts that were successfully modified.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated hosts that could not be modified. Check whether the setting you requested can be used.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ModifyHosts.

" + }, + "ModifyIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" + } + }, + "documentation":"

Contains the parameters of ModifyIdFormat.

" + }, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

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

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + }, + "documentation":"

Contains the parameters for ModifyImageAttribute.

" + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified base64-encoded value. For command line tools, base64 encoding is performed for you.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking for the instance.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" + }, + "ModifyInstancePlacementRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that you are modifying.

", + "locationName":"instanceId" + }, + "Tenancy":{ + "shape":"HostTenancy", + "documentation":"

The tenancy of the instance that you are modifying.

", + "locationName":"tenancy" + }, + "Affinity":{ + "shape":"Affinity", + "documentation":"

The new affinity setting for the instance.

", + "locationName":"affinity" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated host that the instance will have affinity with.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ModifyInstancePlacement.

" + }, + "ModifyInstancePlacementResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyInstancePlacement.

" + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + }, + "documentation":"

Contains the parameters for ModifyReservedInstances.

" + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + }, + "documentation":"

Contains the output of ModifyReservedInstances.

" + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

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

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + }, + "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" + }, + "ModifySpotFleetRequestRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The size of the fleet.

", + "locationName":"targetCapacity" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + } + }, + "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" + }, + "ModifySpotFleetRequestResponse":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifySpotFleetRequest.

" + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + }, + "documentation":"

Contains the parameters for ModifySubnetAttribute.

" + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + }, + "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + } + }, + "documentation":"

Contains the parameters for ModifyVpcAttribute.

" + }, + "ModifyVpcEndpointRequest":{ + "type":"structure", + "required":["VpcEndpointId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the endpoint.

" + }, + "ResetPolicy":{ + "shape":"Boolean", + "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" + }, + "AddRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables IDs to associate with the endpoint.

", + "locationName":"AddRouteTableId" + }, + "RemoveRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs to disassociate from the endpoint.

", + "locationName":"RemoveRouteTableId" + } + }, + "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" + }, + "ModifyVpcEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyVpcEndpoint.

" + }, + "ModifyVpcPeeringConnectionOptionsRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

" + }, + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the requester VPC.

" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the accepter VPC.

" + } + } + }, + "ModifyVpcPeeringConnectionOptionsResult":{ + "type":"structure", + "members":{ + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the requester VPC.

", + "locationName":"requesterPeeringConnectionOptions" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", + "locationName":"accepterPeeringConnectionOptions" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for MonitorInstances.

" + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of MonitorInstances.

" + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "MoveAddressToVpcRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for MoveAddressToVpc.

" + }, + "MoveAddressToVpcResult":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID for the Elastic IP address.

", + "locationName":"allocationId" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the move of the IP address.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output of MoveAddressToVpc.

" + }, + "MoveStatus":{ + "type":"string", + "enum":[ + "movingToVpc", + "restoringToClassic" + ] + }, + "MovingAddressStatus":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "MoveStatus":{ + "shape":"MoveStatus", + "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", + "locationName":"moveStatus" + } + }, + "documentation":"

Describes the status of a moving Elastic IP address.

" + }, + "MovingAddressStatusSet":{ + "type":"list", + "member":{ + "shape":"MovingAddressStatus", + "locationName":"item" + } + }, + "NatGateway":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the NAT gateway is located.

", + "locationName":"vpcId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the NAT gateway is located.

", + "locationName":"subnetId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was created.

", + "locationName":"createTime" + }, + "DeleteTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", + "locationName":"deleteTime" + }, + "NatGatewayAddresses":{ + "shape":"NatGatewayAddressList", + "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", + "locationName":"natGatewayAddressSet" + }, + "State":{ + "shape":"NatGatewayState", + "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", + "locationName":"state" + }, + "FailureCode":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", + "locationName":"failureCode" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", + "locationName":"failureMessage" + }, + "ProvisionedBandwidth":{ + "shape":"ProvisionedBandwidth", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionedBandwidth" + } + }, + "documentation":"

Describes a NAT gateway.

" + }, + "NatGatewayAddress":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address associated with the NAT gateway.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "locationName":"allocationId" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIp" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface associated with the NAT gateway.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" + }, + "NatGatewayAddressList":{ + "type":"list", + "member":{ + "shape":"NatGatewayAddress", + "locationName":"item" + } + }, + "NatGatewayList":{ + "type":"list", + "member":{ + "shape":"NatGateway", + "locationName":"item" + } + }, + "NatGatewayState":{ + "type":"string", + "enum":[ + "pending", + "failed", + "available", + "deleting", + "deleted" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + }, + "InterfaceType":{ + "shape":"NetworkInterfaceType", + "documentation":"

The type of interface.

", + "locationName":"interfaceType" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "NetworkInterfaceType":{ + "type":"string", + "enum":[ + "interface", + "natGateway" + ] + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "OccurrenceDayRequestSet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"OccurenceDay" + } + }, + "OccurrenceDaySet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"item" + } + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OperationType":{ + "type":"string", + "enum":[ + "add", + "remove" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PeeringConnectionOptions":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "PeeringConnectionOptionsRequest":{ + "type":"structure", + "required":[ + "AllowEgressFromLocalClassicLinkToRemoteVpc", + "AllowEgressFromLocalVpcToRemoteClassicLink" + ], + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" + } + }, + "documentation":"

The VPC peering connection options.

" + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", + "locationName":"tenancy" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", + "locationName":"hostId" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for the instance on the Dedicated host. This parameter is not supported for the ImportInstance command.

", + "locationName":"affinity" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PrefixList":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix.

", + "locationName":"prefixListName" + }, + "Cidrs":{ + "shape":"ValueStringList", + "documentation":"

The IP address range of the AWS service.

", + "locationName":"cidrSet" + } + }, + "documentation":"

Describes prefixes for AWS services.

" + }, + "PrefixListId":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + } + }, + "documentation":"

The ID of the prefix.

" + }, + "PrefixListIdList":{ + "type":"list", + "member":{ + "shape":"PrefixListId", + "locationName":"item" + } + }, + "PrefixListIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "PrefixListSet":{ + "type":"list", + "member":{ + "shape":"PrefixList", + "locationName":"item" + } + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of reservations available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressConfigSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesPrivateIpAddressConfig", + "locationName":"PrivateIpAddressConfigSet" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "ProvisionedBandwidth":{ + "type":"structure", + "members":{ + "Provisioned":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisioned" + }, + "Requested":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requested" + }, + "RequestTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requestTime" + }, + "ProvisionTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionTime" + }, + "Status":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"status" + } + }, + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PurchaseRequest":{ + "type":"structure", + "required":[ + "PurchaseToken", + "InstanceCount" + ], + "members":{ + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

" + } + }, + "documentation":"

Describes a request to purchase Scheduled Instances.

" + }, + "PurchaseRequestSet":{ + "type":"list", + "member":{ + "shape":"PurchaseRequest", + "locationName":"PurchaseRequest" + }, + "min":1 + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + }, + "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" + }, + "PurchaseScheduledInstancesRequest":{ + "type":"structure", + "required":["PurchaseRequests"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "PurchaseRequests":{ + "shape":"PurchaseRequestSet", + "documentation":"

One or more purchase requests.

", + "locationName":"PurchaseRequest" + } + }, + "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" + }, + "PurchaseScheduledInstancesResult":{ + "type":"structure", + "members":{ + "ScheduledInstanceSet":{ + "shape":"PurchasedScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of PurchaseScheduledInstances.

" + }, + "PurchasedScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for RebootInstances.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking for the AMI and any instances that you launch from the AMI.

There is no way to disable enhanced networking at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Contains the parameters for RegisterImage.

" + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of RegisterImage.

" + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of RejectVpcPeeringConnection.

" + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for ReleaseAddress.

" + }, + "ReleaseHostsRequest":{ + "type":"structure", + "required":["HostIds"], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated hosts you want to release.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ReleaseHosts.

" + }, + "ReleaseHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated hosts that were successfully released.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated hosts that could not be released, including an error message.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ReleaseHosts.

" + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for ReplaceRoute.

" + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + }, + "documentation":"

Contains the parameters for ReportInstanceStatus.

" + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestSpotFleetRequest":{ + "type":"structure", + "required":["SpotFleetRequestConfig"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration for the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "RequestSpotFleetResponse":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", + "locationName":"blockDurationMinutes" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + }, + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

[EC2-Classic only] One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reservations purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + }, + "documentation":"

Describes the modification request/s.

" + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + }, + "documentation":"

Contains the parameters for ResetImageAttribute.

" + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for ResetInstanceAttribute.

" + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" + } + }, + "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "ResponseHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RestoreAddressToClassicRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for RestoreAddressToClassic.

" + }, + "RestoreAddressToClassicResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

The move status for the IP address.

", + "locationName":"status" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the output of RestoreAddressToClassic.

" + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationPrefixListId":{ + "shape":"String", + "documentation":"

The prefix of the AWS service.

", + "locationName":"destinationPrefixListId" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

Data to configure the instance, or a script to run during instance launch. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). For API calls, the text must be base64-encoded. For command line tools, the encoding is performed for you, and you can load the text from a file.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + }, + "documentation":"

Contains the parameters for RunInstances.

" + }, + "RunScheduledInstancesRequest":{ + "type":"structure", + "required":[ + "ScheduledInstanceId", + "LaunchSpecification" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

Default: 1

" + }, + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

" + }, + "LaunchSpecification":{ + "shape":"ScheduledInstancesLaunchSpecification", + "documentation":"

The launch specification.

" + } + }, + "documentation":"

Contains the parameters for RunScheduledInstances.

" + }, + "RunScheduledInstancesResult":{ + "type":"structure", + "members":{ + "InstanceIdSet":{ + "shape":"InstanceIdSet", + "documentation":"

The IDs of the newly launched instances.

", + "locationName":"instanceIdSet" + } + }, + "documentation":"

Contains the output of RunScheduledInstances.

" + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

A base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. For command line tools, base64 encoding is performed for you.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the Base64 encoded JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "ScheduledInstance":{ + "type":"structure", + "members":{ + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

", + "locationName":"scheduledInstanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "PreviousSlotEndTime":{ + "shape":"DateTime", + "documentation":"

The time that the previous schedule ended or will end.

", + "locationName":"previousSlotEndTime" + }, + "NextSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time for the next schedule to start.

", + "locationName":"nextSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

", + "locationName":"instanceCount" + }, + "TermStartDate":{ + "shape":"DateTime", + "documentation":"

The start date for the Scheduled Instance.

", + "locationName":"termStartDate" + }, + "TermEndDate":{ + "shape":"DateTime", + "documentation":"

The end date for the Scheduled Instance.

", + "locationName":"termEndDate" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The date when the Scheduled Instance was purchased.

", + "locationName":"createDate" + } + }, + "documentation":"

Describes a Scheduled Instance.

" + }, + "ScheduledInstanceAvailability":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token. This token expires in two hours.

", + "locationName":"purchaseToken" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "FirstSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time period for the first schedule to start.

", + "locationName":"firstSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of available instances.

", + "locationName":"availableInstanceCount" + }, + "MinTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The minimum term. The only possible value is 365 days.

", + "locationName":"minTermDurationInDays" + }, + "MaxTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The maximum term. The only possible value is 365 days.

", + "locationName":"maxTermDurationInDays" + } + }, + "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" + }, + "ScheduledInstanceAvailabilitySet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstanceAvailability", + "locationName":"item" + } + }, + "ScheduledInstanceIdRequestSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ScheduledInstanceId" + } + }, + "ScheduledInstanceRecurrence":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

", + "locationName":"frequency" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", + "locationName":"interval" + }, + "OccurrenceDaySet":{ + "shape":"OccurrenceDaySet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", + "locationName":"occurrenceDaySet" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "locationName":"occurrenceRelativeToEnd" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "locationName":"occurrenceUnit" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceRecurrenceRequest":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" + }, + "OccurrenceDays":{ + "shape":"OccurrenceDayRequestSet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", + "locationName":"OccurrenceDay" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "ScheduledInstancesBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" + }, + "Ebs":{ + "shape":"ScheduledInstancesEbs", + "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" + } + }, + "documentation":"

Describes a block device mapping for a Scheduled Instance.

" + }, + "ScheduledInstancesBlockDeviceMappingSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesBlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "ScheduledInstancesEbs":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + } + }, + "documentation":"

Describes an EBS volume for a Scheduled Instance.

" + }, + "ScheduledInstancesIamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN).

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + } + }, + "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" + }, + "ScheduledInstancesLaunchSpecification":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI).

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + }, + "SecurityGroupIds":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The base64-encoded MIME user data.

" + }, + "Placement":{ + "shape":"ScheduledInstancesPlacement", + "documentation":"

The placement information.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

" + }, + "BlockDeviceMappings":{ + "shape":"ScheduledInstancesBlockDeviceMappingSet", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"ScheduledInstancesMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

" + }, + "NetworkInterfaces":{ + "shape":"ScheduledInstancesNetworkInterfaceSet", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"ScheduledInstancesIamInstanceProfile", + "documentation":"

The IAM instance profile.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" + } + }, + "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" + }, + "ScheduledInstancesMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

" + } + }, + "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

" + }, + "PrivateIpAddressConfigs":{ + "shape":"PrivateIpAddressConfigSet", + "documentation":"

The private IP addresses.

", + "locationName":"PrivateIpAddressConfig" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses.

" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" + }, + "Groups":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"Group" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" + } + }, + "documentation":"

Describes a network interface for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterfaceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesNetworkInterface", + "locationName":"NetworkInterface" + } + }, + "ScheduledInstancesPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

" + } + }, + "documentation":"

Describes the placement for a Scheduled Instance.

" + }, + "ScheduledInstancesPrivateIpAddressConfig":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address.

" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" + } + }, + "documentation":"

Describes a private IP address for a Scheduled Instance.

" + }, + "ScheduledInstancesSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupReference":{ + "type":"structure", + "required":[ + "GroupId", + "ReferencingVpcId" + ], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of your security group.

", + "locationName":"groupId" + }, + "ReferencingVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with the referencing security group.

", + "locationName":"referencingVpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC with a security group that references your security group.

" + }, + "SecurityGroupReferences":{ + "type":"list", + "member":{ + "shape":"SecurityGroupReference", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "SlotDateTimeRangeRequest":{ + "type":"structure", + "required":[ + "EarliestTime", + "LatestTime" + ], + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + }, + "SlotStartTimeRangeRequest":{ + "type":"structure", + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume that was used to create the snapshot.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"statusMessage" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + }, + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"dataEncryptionKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + } + }, + "documentation":"

Describes the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + } + }, + "documentation":"

The disk container object for the import snapshot request.

" + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the import snapshot task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the import snapshot task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import snapshot task.

", + "locationName":"status" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot instance.

" + }, + "SpotFleetLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data to make available to the instances.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "Monitoring":{ + "shape":"SpotFleetMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "locationName":"weightedCapacity" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", + "locationName":"spotPrice" + } + }, + "documentation":"

Describes the launch specification for one or more Spot instances.

" + }, + "SpotFleetMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables monitoring for the instance.

Default: false

", + "locationName":"enabled" + } + }, + "documentation":"

Describes whether monitoring is enabled.

" + }, + "SpotFleetRequestConfig":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "SpotFleetRequestState", + "SpotFleetRequestConfig", + "CreateTime" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "SpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The state of the Spot fleet request.

", + "locationName":"spotFleetRequestState" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

Information about the configuration of the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The creation date and time of the request.

", + "locationName":"createTime" + } + }, + "documentation":"

Describes a Spot fleet request.

" + }, + "SpotFleetRequestConfigData":{ + "type":"structure", + "required":[ + "SpotPrice", + "TargetCapacity", + "IamFleetRole", + "LaunchSpecifications" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour.

", + "locationName":"spotPrice" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", + "locationName":"targetCapacity" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", + "locationName":"validUntil" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "IamFleetRole":{ + "shape":"String", + "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", + "locationName":"iamFleetRole" + }, + "LaunchSpecifications":{ + "shape":"LaunchSpecsList", + "documentation":"

Information about the launch specifications for the Spot fleet request.

", + "locationName":"launchSpecifications" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "AllocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", + "locationName":"allocationStrategy" + }, + "FulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", + "locationName":"fulfilledCapacity" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", + "locationName":"type" + } + }, + "documentation":"

Describes the configuration of a Spot fleet request.

" + }, + "SpotFleetRequestConfigSet":{ + "type":"list", + "member":{ + "shape":"SpotFleetRequestConfig", + "locationName":"item" + } + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot instance.

", + "locationName":"productDescription" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The duration for the Spot instance, in minutes.

", + "locationName":"blockDurationMinutes" + }, + "ActualBlockHourlyPrice":{ + "shape":"String", + "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", + "locationName":"actualBlockHourlyPrice" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describes a Spot instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StaleIpPermission":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "locationName":"ipProtocol" + }, + "IpRanges":{ + "shape":"IpRanges", + "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdSet", + "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", + "locationName":"prefixListIds" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairSet", + "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", + "locationName":"groups" + } + }, + "documentation":"

Describes a stale rule in a security group.

" + }, + "StaleIpPermissionSet":{ + "type":"list", + "member":{ + "shape":"StaleIpPermission", + "locationName":"item" + } + }, + "StaleSecurityGroup":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the security group.

", + "locationName":"description" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "StaleIpPermissions":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale inbound rules in the security group.

", + "locationName":"staleIpPermissions" + }, + "StaleIpPermissionsEgress":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale outbound rules in the security group.

", + "locationName":"staleIpPermissionsEgress" + } + }, + "documentation":"

Describes a stale security group (a security group that contains stale rules).

" + }, + "StaleSecurityGroupSet":{ + "type":"list", + "member":{ + "shape":"StaleSecurityGroup", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for StartInstances.

" + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StartInstances.

" + }, + "State":{ + "type":"string", + "enum":[ + "Pending", + "Available", + "Deleting", + "Deleted" + ] + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "Status":{ + "type":"string", + "enum":[ + "MoveInProgress", + "InVpc", + "InClassic" + ] + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data", + "initializing" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for StopInstances.

" + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StopInstances.

" + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable", + "initializing" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated", + "host" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for TerminateInstances.

" + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of TerminateInstances.

" + }, + "TrafficType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "ALL" + ] + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for UnmonitorInstances.

" + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of UnmonitorInstances.

" + }, + "UnsuccessfulItem":{ + "type":"structure", + "required":["Error"], + "members":{ + "Error":{ + "shape":"UnsuccessfulItemError", + "documentation":"

Information about the error.

", + "locationName":"error" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + } + }, + "documentation":"

Information about items that were not successfully processed in a batch call.

" + }, + "UnsuccessfulItemError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message accompanying the error code.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" + }, + "UnsuccessfulItemList":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UnsuccessfulItemSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "documentation":"

The Base64-encoded MIME user data for the instance.

", + "locationName":"data" + } + }, + "documentation":"

Describes the user data to be made available to an instance.

" + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", + "locationName":"vpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection, if applicable.

", + "locationName":"vpcPeeringConnectionId" + }, + "PeeringStatus":{ + "shape":"String", + "documentation":"

The status of a VPC peering connection, if applicable.

", + "locationName":"peeringStatus" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdGroupPairSet":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"

Information about the volume attachments.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2", + "sc1", + "st1" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the endpoint is associated.

", + "locationName":"vpcId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the AWS service to which the endpoint is associated.

", + "locationName":"serviceName" + }, + "State":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"state" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

The policy document associated with the endpoint.

", + "locationName":"policyDocument" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables associated with the endpoint.

", + "locationName":"routeTableIdSet" + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + } + }, + "documentation":"

Describes a VPC endpoint.

" + }, + "VpcEndpointSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionOptionsDescription":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"VpcPeeringConnectionStateReasonCode", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionStateReasonCode":{ + "type":"string", + "enum":[ + "initiating-request", + "pending-acceptance", + "active", + "deleted", + "rejected", + "failed", + "expired", + "provisioning", + "deleting" + ] + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "PeeringOptions":{ + "shape":"VpcPeeringConnectionOptionsDescription", + "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", + "locationName":"peeringOptions" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + } + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" +} diff --git a/aws/dist/botocore/data/ec2/2015-10-01/waiters-2.json b/aws/dist/botocore/data/ec2/2015-10-01/waiters-2.json new file mode 100644 index 00000000..652a8cad --- /dev/null +++ b/aws/dist/botocore/data/ec2/2015-10-01/waiters-2.json @@ -0,0 +1,589 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Reservations[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConsoleOutputAvailable": { + "operation": "GetConsoleOutput", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(Output || '') > `0`", + "expected": true + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageExists": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Images[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidAMIID.NotFound", + "state": "retry" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "KeyPairExists": { + "operation": "DescribeKeyPairs", + "delay": 5, + "maxAttempts": 6, + "acceptors": [ + { + "expected": true, + "matcher": "pathAll", + "state": "success", + "argument": "length(KeyPairs[].KeyName) > `0`" + }, + { + "expected": "InvalidKeyPair.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NatGatewayAvailable": { + "operation": "DescribeNatGateways", + "delay": 15, + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "NatGateways[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "failed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleting" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleted" + }, + { + "state": "retry", + "matcher": "error", + "expected": "NatGatewayNotFound" + } + ] + }, + "NetworkInterfaceAvailable": { + "operation": "DescribeNetworkInterfaces", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "NetworkInterfaces[].Status" + }, + { + "expected": "InvalidNetworkInterfaceID.NotFound", + "matcher": "error", + "state": "failure" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolume.NotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 60, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpcPeeringConnectionExists": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "retry" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-04-01/paginators-1.json b/aws/dist/botocore/data/ec2/2016-04-01/paginators-1.json new file mode 100644 index 00000000..2bd01ad5 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-04-01/paginators-1.json @@ -0,0 +1,63 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + }, + "DescribeSpotFleetRequests": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotFleetRequestConfigs" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Volumes" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-04-01/service-2.json b/aws/dist/botocore/data/ec2/2016-04-01/service-2.json new file mode 100644 index 00000000..b4f7063c --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-04-01/service-2.json @@ -0,0 +1,17630 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-04-01", + "endpointPrefix":"ec2", + "protocol":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-04-01" + }, + "operations":{ + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AllocateHosts":{ + "name":"AllocateHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateHostsRequest"}, + "output":{"shape":"AllocateHostsResult"}, + "documentation":"

Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests":{ + "name":"CancelSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotFleetRequestsRequest"}, + "output":{"shape":"CancelSpotFleetRequestsResponse"}, + "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFlowLogs":{ + "name":"CreateFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowLogsRequest"}, + "output":{"shape":"CreateFlowLogsResult"}, + "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{"shape":"KeyPair"}, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateNatGateway":{ + "name":"CreateNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNatGatewayRequest"}, + "output":{"shape":"CreateNatGatewayResult"}, + "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Reserved Instance listing at a time. To get a list of your Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Reserved Instances, and specify the upfront price to receive for them. Your Reserved Instance listings then become available for purchase. To view the details of your Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "output":{"shape":"CreateRouteResult"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{"shape":"Snapshot"}, + "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{"shape":"Volume"}, + "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResult"}, + "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteFlowLogs":{ + "name":"DeleteFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowLogsRequest"}, + "output":{"shape":"DeleteFlowLogsResult"}, + "documentation":"

Deletes one or more flow logs.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNatGateway":{ + "name":"DeleteNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNatGatewayRequest"}, + "output":{"shape":"DeleteNatGatewayResult"}, + "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot instances.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpoints":{ + "name":"DeleteVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointsRequest"}, + "output":{"shape":"DeleteVpcEndpointsResult"}, + "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeFlowLogs":{ + "name":"DescribeFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlowLogsRequest"}, + "output":{"shape":"DescribeFlowLogsResult"}, + "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeHostReservationOfferings":{ + "name":"DescribeHostReservationOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationOfferingsRequest"}, + "output":{"shape":"DescribeHostReservationOfferingsResult"}, + "documentation":"

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeHostReservations":{ + "name":"DescribeHostReservations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationsRequest"}, + "output":{"shape":"DescribeHostReservationsResult"}, + "documentation":"

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

" + }, + "DescribeHosts":{ + "name":"DescribeHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostsRequest"}, + "output":{"shape":"DescribeHostsResult"}, + "documentation":"

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

" + }, + "DescribeIdFormat":{ + "name":"DescribeIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdFormatRequest"}, + "output":{"shape":"DescribeIdFormatResult"}, + "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "DescribeIdentityIdFormat":{ + "name":"DescribeIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityIdFormatRequest"}, + "output":{"shape":"DescribeIdentityIdFormatResult"}, + "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{"shape":"ImageAttribute"}, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeMovingAddresses":{ + "name":"DescribeMovingAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMovingAddressesRequest"}, + "output":{"shape":"DescribeMovingAddressesResult"}, + "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNatGateways":{ + "name":"DescribeNatGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNatGatewaysRequest"}, + "output":{"shape":"DescribeNatGatewaysResult"}, + "documentation":"

Describes one or more of the your NAT gateways.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists":{ + "name":"DescribePrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrefixListsRequest"}, + "output":{"shape":"DescribePrefixListsResult"}, + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeScheduledInstanceAvailability":{ + "name":"DescribeScheduledInstanceAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, + "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, + "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" + }, + "DescribeScheduledInstances":{ + "name":"DescribeScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstancesRequest"}, + "output":{"shape":"DescribeScheduledInstancesResult"}, + "documentation":"

Describes one or more of your Scheduled Instances.

" + }, + "DescribeSecurityGroupReferences":{ + "name":"DescribeSecurityGroupReferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, + "output":{"shape":"DescribeSecurityGroupReferencesResult"}, + "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotFleetInstances":{ + "name":"DescribeSpotFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetInstancesRequest"}, + "output":{"shape":"DescribeSpotFleetInstancesResponse"}, + "documentation":"

Describes the running instances for the specified Spot fleet.

" + }, + "DescribeSpotFleetRequestHistory":{ + "name":"DescribeSpotFleetRequestHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, + "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, + "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" + }, + "DescribeSpotFleetRequests":{ + "name":"DescribeSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestsRequest"}, + "output":{"shape":"DescribeSpotFleetRequestsResponse"}, + "documentation":"

Describes your Spot fleet requests.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeStaleSecurityGroups":{ + "name":"DescribeStaleSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, + "output":{"shape":"DescribeStaleSecurityGroupsResult"}, + "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcClassicLinkDnsSupport":{ + "name":"DescribeVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, + "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcEndpointServices":{ + "name":"DescribeVpcEndpointServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicesRequest"}, + "output":{"shape":"DescribeVpcEndpointServicesResult"}, + "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResult"}, + "documentation":"

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisableVpcClassicLinkDnsSupport":{ + "name":"DisableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EnableVpcClassicLinkDnsSupport":{ + "name":"EnableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetConsoleScreenshot":{ + "name":"GetConsoleScreenshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleScreenshotRequest"}, + "output":{"shape":"GetConsoleScreenshotResult"}, + "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" + }, + "GetHostReservationPurchasePreview":{ + "name":"GetHostReservationPurchasePreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, + "output":{"shape":"GetHostReservationPurchasePreviewResult"}, + "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ModifyHosts":{ + "name":"ModifyHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHostsRequest"}, + "output":{"shape":"ModifyHostsResult"}, + "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" + }, + "ModifyIdFormat":{ + "name":"ModifyIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdFormatRequest"}, + "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyIdentityIdFormat":{ + "name":"ModifyIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdentityIdFormatRequest"}, + "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstancePlacement":{ + "name":"ModifyInstancePlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstancePlacementRequest"}, + "output":{"shape":"ModifyInstancePlacementResult"}, + "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySpotFleetRequest":{ + "name":"ModifySpotFleetRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySpotFleetRequestRequest"}, + "output":{"shape":"ModifySpotFleetRequestResponse"}, + "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint":{ + "name":"ModifyVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointRequest"}, + "output":{"shape":"ModifyVpcEndpointResult"}, + "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" + }, + "ModifyVpcPeeringConnectionOptions":{ + "name":"ModifyVpcPeeringConnectionOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, + "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, + "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "MoveAddressToVpc":{ + "name":"MoveAddressToVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAddressToVpcRequest"}, + "output":{"shape":"MoveAddressToVpcResult"}, + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "PurchaseHostReservation":{ + "name":"PurchaseHostReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseHostReservationRequest"}, + "output":{"shape":"PurchaseHostReservationResult"}, + "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you obtain a capacity reservation for a certain instance configuration over a specified period of time and pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseScheduledInstances":{ + "name":"PurchaseScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseScheduledInstancesRequest"}, + "output":{"shape":"PurchaseScheduledInstancesResult"}, + "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReleaseHosts":{ + "name":"ReleaseHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseHostsRequest"}, + "output":{"shape":"ReleaseHostsResult"}, + "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet":{ + "name":"RequestSpotFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotFleetRequest"}, + "output":{"shape":"RequestSpotFleetResponse"}, + "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic":{ + "name":"RestoreAddressToClassic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreAddressToClassicRequest"}, + "output":{"shape":"RestoreAddressToClassicResult"}, + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{"shape":"Reservation"}, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RunScheduledInstances":{ + "name":"RunScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunScheduledInstancesRequest"}, + "output":{"shape":"RunScheduledInstancesResult"}, + "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "shapes":{ + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "ActiveInstance":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + } + }, + "documentation":"

Describes a running instance in a Spot fleet.

" + }, + "ActiveInstanceSet":{ + "type":"list", + "member":{ + "shape":"ActiveInstance", + "locationName":"item" + } + }, + "ActivityStatus":{ + "type":"string", + "enum":[ + "error", + "pending_fulfillment", + "pending_termination", + "fulfilled" + ] + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "Affinity":{ + "type":"string", + "enum":[ + "default", + "host" + ] + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + }, + "documentation":"

Contains the parameters for AllocateAddress.

" + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + }, + "documentation":"

Contains the output of AllocateAddress.

" + }, + "AllocateHostsRequest":{ + "type":"structure", + "required":[ + "InstanceType", + "Quantity", + "AvailabilityZone" + ], + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", + "locationName":"autoPlacement" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", + "locationName":"instanceType" + }, + "Quantity":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts you want to allocate to your account with these parameters.

", + "locationName":"quantity" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the Dedicated Hosts.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Contains the parameters for AllocateHosts.

" + }, + "AllocateHostsResult":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"ResponseHostIdList", + "documentation":"

The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.

", + "locationName":"hostIdSet" + } + }, + "documentation":"

Contains the output of AllocateHosts.

" + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "AllocationState":{ + "type":"string", + "enum":[ + "available", + "under-assessment", + "permanent-failure", + "released", + "released-permanent-failure" + ] + }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "diversified" + ] + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + }, + "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "locationName":"allowReassociation" + } + }, + "documentation":"

Contains the parameters for AssociateAddress.

" + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateAddress.

" + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AssociateDhcpOptions.

" + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for AssociateRouteTable.

" + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateRouteTable.

" + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of AttachClassicLinkVpc.

" + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for AttachInternetGateway.

" + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + }, + "documentation":"

Contains the parameters for AttachNetworkInterface.

" + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + }, + "documentation":"

Contains the output of AttachNetworkInterface.

" + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + }, + "documentation":"

Contains the parameters for AttachVolume.

" + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AttachVpnGateway.

" + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of AttachVpnGateway.

" + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

The attribute value. The valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The attribute value. Note that the value is case-sensitive.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a String.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all traffic. If you specify -1, traffic on all ports is allowed, regardless of any ports you specify.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" + }, + "AutoPlacement":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone.

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":[ + "available", + "information", + "impaired", + "unavailable" + ] + }, + "AvailableCapacity":{ + "type":"structure", + "members":{ + "AvailableInstanceCapacity":{ + "shape":"AvailableInstanceCapacityList", + "documentation":"

The total number of instances that the Dedicated Host supports.

", + "locationName":"availableInstanceCapacity" + }, + "AvailableVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs available on the Dedicated Host.

", + "locationName":"availableVCpus" + } + }, + "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" + }, + "AvailableInstanceCapacityList":{ + "type":"list", + "member":{ + "shape":"InstanceCapacity", + "locationName":"item" + } + }, + "BatchState":{ + "type":"string", + "enum":[ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating", + "modifying" + ] + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + }, + "documentation":"

Contains the parameters for BundleInstance.

" + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of BundleInstance.

" + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBatchErrorCode":{ + "type":"string", + "enum":[ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + }, + "documentation":"

Contains the parameters for CancelBundleTask.

" + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of CancelBundleTask.

" + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "documentation":"

The reason for canceling the conversion task.

", + "locationName":"reasonMessage" + } + }, + "documentation":"

Contains the parameters for CancelConversionTask.

" + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for CancelExportTask.

" + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image or import snapshot task to be canceled.

" + }, + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + } + }, + "documentation":"

Contains the parameters for CancelImportTask.

" + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the task being canceled.

", + "locationName":"importTaskId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"state" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"previousState" + } + }, + "documentation":"

Contains the output for CancelImportTask.

" + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + }, + "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CancelReservedInstancesListing.

" + }, + "CancelSpotFleetRequestsError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"CancelBatchErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "Error" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "Error":{ + "shape":"CancelSpotFleetRequestsError", + "documentation":"

The error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsErrorItem", + "locationName":"item" + } + }, + "CancelSpotFleetRequestsRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", + "locationName":"terminateInstances" + } + }, + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "UnsuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsErrorSet", + "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", + "locationName":"unsuccessfulFleetRequestSet" + }, + "SuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsSuccessSet", + "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", + "locationName":"successfulFleetRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "CurrentSpotFleetRequestState", + "PreviousSpotFleetRequestState" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "CurrentSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The current state of the Spot fleet request.

", + "locationName":"currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The previous state of the Spot fleet request.

", + "locationName":"previousSpotFleetRequestState" + } + }, + "documentation":"

Describes a Spot fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsSuccessItem", + "locationName":"item" + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + }, + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkDnsSupport":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkDnsSupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "locationName":"classicLinkDnsSupported" + } + }, + "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" + }, + "ClassicLinkDnsSupportList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkDnsSupport", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClientData":{ + "type":"structure", + "members":{ + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image, in GiB.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment about the disk upload.

" + } + }, + "documentation":"

Describes the client-specific data.

" + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for ConfirmProductInstance.

" + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + }, + "Return":{ + "shape":"Boolean", + "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ConfirmProductInstance.

" + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the task.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopyImage.

" + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CopyImage.

" + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopySnapshot.

" + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Contains the output of CopySnapshot.

" + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + }, + "documentation":"

Contains the parameters for CreateCustomerGateway.

" + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + }, + "documentation":"

Contains the output of CreateCustomerGateway.

" + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + }, + "documentation":"

Contains the parameters for CreateDhcpOptions.

" + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + }, + "documentation":"

Contains the output of CreateDhcpOptions.

" + }, + "CreateFlowLogsRequest":{ + "type":"structure", + "required":[ + "ResourceIds", + "ResourceType", + "TrafficType", + "LogGroupName", + "DeliverLogsPermissionArn" + ], + "members":{ + "ResourceIds":{ + "shape":"ValueStringList", + "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowLogsResourceType", + "documentation":"

The type of resource on which to create the flow log.

" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic to log.

" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch log group.

" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateFlowLogs.

" + }, + "CreateFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the flow logs.

", + "locationName":"flowLogIdSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be created successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of CreateFlowLogs.

" + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Contains the parameters for CreateImage.

" + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CreateImage.

" + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"

The format and location for an instance export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Contains the parameters for CreateInstanceExportTask.

" + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "documentation":"

Information about the instance export task.

", + "locationName":"exportTask" + } + }, + "documentation":"

Contains the output for CreateInstanceExportTask.

" + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateInternetGateway.

" + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + }, + "documentation":"

Contains the output of CreateInternetGateway.

" + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + }, + "documentation":"

Contains the parameters for CreateKeyPair.

" + }, + "CreateNatGatewayRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "AllocationId" + ], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The subnet in which to create the NAT gateway.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + } + }, + "documentation":"

Contains the parameters for CreateNatGateway.

" + }, + "CreateNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGateway":{ + "shape":"NatGateway", + "documentation":"

Information about the NAT gateway.

", + "locationName":"natGateway" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateNatGateway.

" + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAcl.

" + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + }, + "documentation":"

Contains the output of CreateNetworkAcl.

" + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateNetworkInterface.

" + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + }, + "documentation":"

Contains the output of CreateNetworkInterface.

" + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + }, + "documentation":"

Contains the parameters for CreatePlacementGroup.

" + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CreateReservedInstancesListing.

" + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for CreateRoute.

" + }, + "CreateRouteResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of CreateRoute.

" + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateRouteTable.

" + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + }, + "documentation":"

Contains the output of CreateRouteTable.

" + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for CreateSecurityGroup.

" + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Contains the output of CreateSecurityGroup.

" + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + }, + "documentation":"

Contains the parameters for CreateSnapshot.

" + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + }, + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" + } + }, + "documentation":"

Contains the parameters for CreateSubnet.

" + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + }, + "documentation":"

Contains the output of CreateSubnet.

" + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + }, + "documentation":"

Contains the parameters for CreateTags.

" + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + }, + "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + }, + "documentation":"

Describes modifications to the permissions for a volume.

" + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" + } + }, + "documentation":"

Contains the parameters for CreateVolume.

" + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "VpcId", + "ServiceName" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The AWS service name, in the form com.amazonaws.region.service . To get a list of available services, use the DescribeVpcEndpointServices request.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

", + "locationName":"RouteTableId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateVpcEndpoint.

" + }, + "CreateVpcEndpointResult":{ + "type":"structure", + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"

Information about the endpoint.

", + "locationName":"vpcEndpoint" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateVpcEndpoint.

" + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + }, + "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of CreateVpcPeeringConnection.

" + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName":"instanceTenancy" + } + }, + "documentation":"

Contains the parameters for CreateVpc.

" + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + }, + "documentation":"

Contains the output of CreateVpc.

" + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnection.

" + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + }, + "documentation":"

Contains the output of CreateVpnConnection.

" + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnGateway.

" + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + }, + "documentation":"

Contains the output of CreateVpnGateway.

" + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteCustomerGateway.

" + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + }, + "documentation":"

Contains the parameters for DeleteDhcpOptions.

" + }, + "DeleteFlowLogsRequest":{ + "type":"structure", + "required":["FlowLogIds"], + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + } + }, + "documentation":"

Contains the parameters for DeleteFlowLogs.

" + }, + "DeleteFlowLogsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteFlowLogs.

" + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + }, + "documentation":"

Contains the parameters for DeleteInternetGateway.

" + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + }, + "documentation":"

Contains the parameters for DeleteKeyPair.

" + }, + "DeleteNatGatewayRequest":{ + "type":"structure", + "required":["NatGatewayId"], + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteNatGateway.

" + }, + "DeleteNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the output of DeleteNatGateway.

" + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAcl.

" + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkInterface.

" + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + }, + "documentation":"

Contains the parameters for DeletePlacementGroup.

" + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + }, + "documentation":"

Contains the parameters for DeleteRoute.

" + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for DeleteRouteTable.

" + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteSecurityGroup.

" + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + } + }, + "documentation":"

Contains the parameters for DeleteSnapshot.

" + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + }, + "documentation":"

Contains the parameters for DeleteSubnet.

" + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + }, + "documentation":"

Contains the parameters for DeleteTags.

" + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + }, + "documentation":"

Contains the parameters for DeleteVolume.

" + }, + "DeleteVpcEndpointsRequest":{ + "type":"structure", + "required":["VpcEndpointIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" + }, + "DeleteVpcEndpointsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the endpoints that were not successfully deleted.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteVpcEndpoints.

" + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpc.

" + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnection.

" + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnGateway.

" + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + }, + "documentation":"

Contains the parameters for DeregisterImage.

" + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + }, + "documentation":"

Contains the parameters for DescribeAccountAttributes.

" + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + }, + "documentation":"

Contains the output of DescribeAccountAttributes.

" + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + }, + "documentation":"

Contains the parameters for DescribeAddresses.

" + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + }, + "documentation":"

Contains the output of DescribeAddresses.

" + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + }, + "documentation":"

Contains the output of DescribeAvailabiltyZones.

" + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeBundleTasks.

" + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + }, + "documentation":"

Contains the output of DescribeBundleTasks.

" + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeClassicLinkInstances.

" + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

", + "locationName":"filter" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeConversionTasks.

" + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "documentation":"

Information about the conversion tasks.

", + "locationName":"conversionTasks" + } + }, + "documentation":"

Contains the output for DescribeConversionTasks.

" + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeCustomerGateways.

" + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeCustomerGateways.

" + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeDhcpOptions.

" + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + }, + "documentation":"

Contains the output of DescribeDhcpOptions.

" + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeExportTasks.

" + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "documentation":"

Information about the export tasks.

", + "locationName":"exportTaskSet" + } + }, + "documentation":"

Contains the output for DescribeExportTasks.

" + }, + "DescribeFlowLogsRequest":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeFlowLogs.

" + }, + "DescribeFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogs":{ + "shape":"FlowLogSet", + "documentation":"

Information about the flow logs.

", + "locationName":"flowLogSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeFlowLogs.

" + }, + "DescribeHostReservationOfferingsRequest":{ + "type":"structure", + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation offering.

" + }, + "MinDuration":{ + "shape":"Integer", + "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" + }, + "MaxDuration":{ + "shape":"Integer", + "documentation":"

This is the maximum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationOfferingsResult":{ + "type":"structure", + "members":{ + "OfferingSet":{ + "shape":"HostOfferingSet", + "documentation":"

Information about the offerings.

", + "locationName":"offeringSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostReservationsRequest":{ + "type":"structure", + "members":{ + "HostReservationIdSet":{ + "shape":"HostReservationIdSet", + "documentation":"

One or more host reservation IDs.

" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationsResult":{ + "type":"structure", + "members":{ + "HostReservationSet":{ + "shape":"HostReservationSet", + "documentation":"

Details about the reservation's configuration.

", + "locationName":"hostReservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostsRequest":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", + "locationName":"hostId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", + "locationName":"maxResults" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeHosts.

" + }, + "DescribeHostsResult":{ + "type":"structure", + "members":{ + "Hosts":{ + "shape":"HostList", + "documentation":"

Information about the Dedicated Hosts.

", + "locationName":"hostSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeHosts.

" + }, + "DescribeIdFormatRequest":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

" + } + }, + "documentation":"

Contains the parameters for DescribeIdFormat.

" + }, + "DescribeIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resource.

", + "locationName":"statusSet" + } + }, + "documentation":"

Contains the output of DescribeIdFormat.

" + }, + "DescribeIdentityIdFormatRequest":{ + "type":"structure", + "required":["PrincipalArn"], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

", + "locationName":"resource" + }, + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "locationName":"principalArn" + } + }, + "documentation":"

Contains the parameters for DescribeIdentityIdFormat.

" + }, + "DescribeIdentityIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resources.

", + "locationName":"statusSet" + } + }, + "documentation":"

Contains the output of DescribeIdentityIdFormat.

" + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + }, + "documentation":"

Contains the parameters for DescribeImageAttribute.

" + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeImages.

" + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + }, + "documentation":"

Contains the output of DescribeImages.

" + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import image task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportImageTasks.

" + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportImageTasks.

" + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import snapshot task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceStatus.

" + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstanceStatus.

" + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeInstances.

" + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

Zero or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstances.

" + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeInternetGateways.

" + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeInternetGateways.

" + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeKeyPairs.

" + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + }, + "documentation":"

Contains the output of DescribeKeyPairs.

" + }, + "DescribeMovingAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"

One or more Elastic IP addresses.

", + "locationName":"publicIp" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName":"filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeMovingAddresses.

" + }, + "DescribeMovingAddressesResult":{ + "type":"structure", + "members":{ + "MovingAddressStatuses":{ + "shape":"MovingAddressStatusSet", + "documentation":"

The status for each Elastic IP address.

", + "locationName":"movingAddressStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeMovingAddresses.

" + }, + "DescribeNatGatewaysRequest":{ + "type":"structure", + "members":{ + "NatGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more NAT gateway IDs.

", + "locationName":"NatGatewayId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + }, + "documentation":"

Contains the parameters for DescribeNatGateways.

" + }, + "DescribeNatGatewaysResult":{ + "type":"structure", + "members":{ + "NatGateways":{ + "shape":"NatGatewayList", + "documentation":"

Information about the NAT gateways.

", + "locationName":"natGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeNatGateways.

" + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkAcls.

" + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkAcls.

" + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaces.

" + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribePlacementGroups.

" + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + }, + "documentation":"

Contains the output of DescribePlacementGroups.

" + }, + "DescribePrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribePrefixLists.

" + }, + "DescribePrefixListsResult":{ + "type":"structure", + "members":{ + "PrefixLists":{ + "shape":"PrefixListSet", + "documentation":"

All available prefix lists.

", + "locationName":"prefixListSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribePrefixLists.

" + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRegions.

" + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + }, + "documentation":"

Contains the output of DescribeRegions.

" + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"filters" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstances.

" + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + }, + "documentation":"

Contains the output for DescribeReservedInstances.

" + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRouteTables.

" + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + }, + "documentation":"

Contains the output of DescribeRouteTables.

" + }, + "DescribeScheduledInstanceAvailabilityRequest":{ + "type":"structure", + "required":[ + "Recurrence", + "FirstSlotStartTimeRange" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrenceRequest", + "documentation":"

The schedule recurrence.

" + }, + "FirstSlotStartTimeRange":{ + "shape":"SlotDateTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "MinSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" + }, + "MaxSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstanceAvailabilityResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceAvailabilitySet":{ + "shape":"ScheduledInstanceAvailabilitySet", + "documentation":"

Information about the available Scheduled Instances.

", + "locationName":"scheduledInstanceAvailabilitySet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ScheduledInstanceIds":{ + "shape":"ScheduledInstanceIdRequestSet", + "documentation":"

One or more Scheduled Instance IDs.

", + "locationName":"ScheduledInstanceId" + }, + "SlotStartTimeRange":{ + "shape":"SlotStartTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstances.

" + }, + "DescribeScheduledInstancesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceSet":{ + "shape":"ScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstances.

" + }, + "DescribeSecurityGroupReferencesRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"GroupIds", + "documentation":"

One or more security group IDs in your account.

" + } + } + }, + "DescribeSecurityGroupReferencesResult":{ + "type":"structure", + "members":{ + "SecurityGroupReferenceSet":{ + "shape":"SecurityGroupReferences", + "documentation":"

Information about the VPCs with the referencing security groups.

", + "locationName":"securityGroupReferenceSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSecurityGroups.

" + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + }, + "documentation":"

Contains the output of DescribeSecurityGroups.

" + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshots.

" + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSnapshots.

" + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotFleetInstancesRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetInstancesResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "ActiveInstances" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetRequestHistoryRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The type of events to describe. By default, all events are described.

", + "locationName":"eventType" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestHistoryResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime", + "LastEvaluatedTime", + "HistoryRecords" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "HistoryRecords":{ + "shape":"HistoryRecords", + "documentation":"

Information about the events in the history of the Spot fleet request.

", + "locationName":"historyRecordSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "DescribeSpotFleetRequestsResponse":{ + "type":"structure", + "required":["SpotFleetRequestConfigs"], + "members":{ + "SpotFleetRequestConfigs":{ + "shape":"SpotFleetRequestConfigSet", + "documentation":"

Information about the configuration of your Spot fleet.

", + "locationName":"spotFleetRequestConfigSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "DescribeStaleSecurityGroupsRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribeStaleSecurityGroupsResult":{ + "type":"structure", + "members":{ + "StaleSecurityGroupSet":{ + "shape":"StaleSecurityGroupSet", + "documentation":"

Information about the stale security groups.

", + "locationName":"staleSecurityGroupSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSubnets.

" + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + }, + "documentation":"

Contains the output of DescribeSubnets.

" + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeTags.

" + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeTags.

" + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeVolumeAttribute.

" + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeStatus.

" + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumeStatus.

" + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeVolumes.

" + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "documentation":"

Information about the volumes.

", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumes.

" + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":[ + "VpcId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcAttribute.

" + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + }, + "documentation":"

Contains the output of DescribeVpcAttribute.

" + }, + "DescribeVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPC IDs.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"ClassicLinkDnsSupportList", + "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", + "locationName":"vpcs" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use when requesting the next set of items.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLink.

" + }, + "DescribeVpcEndpointServicesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointServicesResult":{ + "type":"structure", + "members":{ + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

A list of supported AWS services.

", + "locationName":"serviceNameSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" + }, + "DescribeVpcEndpointsResult":{ + "type":"structure", + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpointSet", + "documentation":"

Information about the endpoints.

", + "locationName":"vpcEndpointSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpoints.

" + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcs.

" + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcs.

" + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnConnections.

" + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpnConnections.

" + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnGateways.

" + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeVpnGateways.

" + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DetachClassicLinkVpc.

" + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachInternetGateway.

" + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for DetachNetworkInterface.

" + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + }, + "documentation":"

Contains the parameters for DetachVolume.

" + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DetachVpnGateway.

" + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" + }, + "DisableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLink.

" + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLink.

" + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for DisassociateAddress.

" + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the parameters for DisassociateRouteTable.

" + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

Information about the disk image.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the disk image.

" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

Information about the volume.

" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + }, + "documentation":"

Describes a disk image volume.

" + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Contains the parameters for EnableVolumeIO.

" + }, + "EnableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLink.

" + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLink.

" + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "EventInformation":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", + "locationName":"instanceId" + }, + "EventSubType":{ + "shape":"String", + "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", + "locationName":"eventSubType" + }, + "EventDescription":{ + "shape":"String", + "documentation":"

The description of the event.

", + "locationName":"eventDescription" + } + }, + "documentation":"

Describes a Spot fleet event.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "instanceChange", + "fleetRequestChange", + "error" + ] + }, + "ExcessCapacityTerminationPolicy":{ + "type":"string", + "enum":[ + "noTermination", + "default" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the export task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

Information about the instance to export.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "documentation":"

Information about the export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The encryption key for your S3 bucket.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the format and location for an instance export task.

" + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FleetType":{ + "type":"string", + "enum":[ + "request", + "maintain" + ] + }, + "Float":{"type":"float"}, + "FlowLog":{ + "type":"structure", + "members":{ + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The date and time the flow log was created.

", + "locationName":"creationTime" + }, + "FlowLogId":{ + "shape":"String", + "documentation":"

The flow log ID.

", + "locationName":"flowLogId" + }, + "FlowLogStatus":{ + "shape":"String", + "documentation":"

The status of the flow log (ACTIVE).

", + "locationName":"flowLogStatus" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource on which the flow log was created.

", + "locationName":"resourceId" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic captured for the flow log.

", + "locationName":"trafficType" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the flow log group.

", + "locationName":"logGroupName" + }, + "DeliverLogsStatus":{ + "shape":"String", + "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", + "locationName":"deliverLogsStatus" + }, + "DeliverLogsErrorMessage":{ + "shape":"String", + "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", + "locationName":"deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "locationName":"deliverLogsPermissionArn" + } + }, + "documentation":"

Describes a flow log.

" + }, + "FlowLogSet":{ + "type":"list", + "member":{ + "shape":"FlowLog", + "locationName":"item" + } + }, + "FlowLogsResourceType":{ + "type":"string", + "enum":[ + "VPC", + "Subnet", + "NetworkInterface" + ] + }, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for GetConsoleOutput.

" + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

", + "locationName":"output" + } + }, + "documentation":"

Contains the output of GetConsoleOutput.

" + }, + "GetConsoleScreenshotRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "WakeUp":{ + "shape":"Boolean", + "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" + } + }, + "documentation":"

Contains the parameters for the request.

" + }, + "GetConsoleScreenshotResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageData":{ + "shape":"String", + "documentation":"

The data that comprises the image.

", + "locationName":"imageData" + } + }, + "documentation":"

Contains the output of the request.

" + }, + "GetHostReservationPurchasePreviewRequest":{ + "type":"structure", + "required":[ + "OfferingId", + "HostIdSet" + ], + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The offering ID of the reservation.

" + }, + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" + } + } + }, + "GetHostReservationPurchasePreviewResult":{ + "type":"structure", + "members":{ + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

", + "locationName":"purchase" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The potential total upfront price. This is billed immediately.

", + "locationName":"totalUpfrontPrice" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The potential total hourly price of the reservation per hour.

", + "locationName":"totalHourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + }, + "documentation":"

Contains the parameters for GetPasswordData.

" + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + }, + "documentation":"

Contains the output of GetPasswordData.

" + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupIds":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HistoryRecord":{ + "type":"structure", + "required":[ + "Timestamp", + "EventType", + "EventInformation" + ], + "members":{ + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", + "locationName":"eventType" + }, + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + } + }, + "documentation":"

Describes an event in the history of the Spot fleet request.

" + }, + "HistoryRecords":{ + "type":"list", + "member":{ + "shape":"HistoryRecord", + "locationName":"item" + } + }, + "Host":{ + "type":"structure", + "members":{ + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Whether auto-placement is on or off.

", + "locationName":"autoPlacement" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", + "locationName":"hostReservationId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "HostProperties":{ + "shape":"HostProperties", + "documentation":"

The hardware specifications of the Dedicated Host.

", + "locationName":"hostProperties" + }, + "State":{ + "shape":"AllocationState", + "documentation":"

The Dedicated Host's state.

", + "locationName":"state" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the Dedicated Host.

", + "locationName":"availabilityZone" + }, + "Instances":{ + "shape":"HostInstanceList", + "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", + "locationName":"instances" + }, + "AvailableCapacity":{ + "shape":"AvailableCapacity", + "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + } + }, + "documentation":"

Describes the properties of the Dedicated Host.

" + }, + "HostInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

the IDs of instances that are running on the Dedicated Host.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes an instance running on a Dedicated Host.

" + }, + "HostInstanceList":{ + "type":"list", + "member":{ + "shape":"HostInstance", + "locationName":"item" + } + }, + "HostList":{ + "type":"list", + "member":{ + "shape":"Host", + "locationName":"item" + } + }, + "HostOffering":{ + "type":"structure", + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the offering.

", + "locationName":"offeringId" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the offering.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The available payment option.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", + "locationName":"upfrontPrice" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the offering.

", + "locationName":"hourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the offering.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering (in seconds).

", + "locationName":"duration" + } + }, + "documentation":"

Details about the Dedicated Host Reservation offering.

" + }, + "HostOfferingSet":{ + "type":"list", + "member":{"shape":"HostOffering"} + }, + "HostProperties":{ + "type":"structure", + "members":{ + "Sockets":{ + "shape":"Integer", + "documentation":"

The number of sockets on the Dedicated Host.

", + "locationName":"sockets" + }, + "Cores":{ + "shape":"Integer", + "documentation":"

The number of cores on the Dedicated Host.

", + "locationName":"cores" + }, + "TotalVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs on the Dedicated Host.

", + "locationName":"totalVCpus" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes properties of a Dedicated Host.

" + }, + "HostReservation":{ + "type":"structure", + "members":{ + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "locationName":"hostReservationId" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", + "locationName":"offeringId" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option selected for this reservation.

", + "locationName":"paymentOption" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation.

", + "locationName":"hourlyPrice" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", + "locationName":"count" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", + "locationName":"duration" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation ends.

", + "locationName":"end" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation started.

", + "locationName":"start" + }, + "State":{ + "shape":"ReservationState", + "documentation":"

The state of the reservation.

", + "locationName":"state" + } + }, + "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" + }, + "HostReservationIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "HostReservationSet":{ + "type":"list", + "member":{"shape":"HostReservation"} + }, + "HostTenancy":{ + "type":"string", + "enum":[ + "dedicated", + "host" + ] + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "IdFormat":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "locationName":"useLongIds" + }, + "Deadline":{ + "shape":"DateTime", + "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "locationName":"deadline" + } + }, + "documentation":"

Describes the ID format for a resource.

" + }, + "IdFormatList":{ + "type":"list", + "member":{ + "shape":"IdFormat", + "locationName":"item" + } + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the disk.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "documentation":"

Describes the disk container object for an import image task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task.

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "documentation":"

Information about the disk containers.

", + "locationName":"DiskContainer" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform.

Valid values: xen

" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportImage.

" + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output for ImportImage.

" + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor for the import task.

Valid values: xen

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the import image task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the import image task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import image task.

", + "locationName":"status" + } + }, + "documentation":"

Describes an import image task.

" + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the launch specification for VM import.

" + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

The launch specification.

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"

The disk image.

", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + }, + "documentation":"

Contains the parameters for ImportInstance.

" + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportInstance.

" + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "documentation":"

One or more volumes.

", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import instance task.

" + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", + "locationName":"publicKeyMaterial" + } + }, + "documentation":"

Contains the parameters for ImportKeyPair.

" + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Contains the output of ImportKeyPair.

" + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description string for the import snapshot task.

" + }, + "DiskContainer":{ + "shape":"SnapshotDiskContainer", + "documentation":"

Information about the disk container.

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportSnapshot.

" + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Information about the import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Contains the output for ImportSnapshot.

" + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Describes an import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import snapshot task.

" + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

The disk image.

", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the volume.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

The volume size.

", + "locationName":"volume" + } + }, + "documentation":"

Contains the parameters for ImportVolume.

" + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportVolume.

" + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance, if applicable.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched, if applicable.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance, if applicable.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance, if applicable.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance, if applicable.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

If the request is a Spot instance request, the ID of the request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance, if applicable.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport", + "enaSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCapacity":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size supported by the Dedicated Host.

", + "locationName":"instanceType" + }, + "AvailableCapacity":{ + "shape":"Integer", + "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + }, + "TotalCapacity":{ + "shape":"Integer", + "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", + "locationName":"totalCapacity" + } + }, + "documentation":"

Information about the instance type that the Dedicated Host supports.

" + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance to export.

" + }, + "InstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":[ + "spot", + "scheduled" + ] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Any scheduled events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The event code.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes a scheduled event for an instance.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "t2.nano", + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "x1.4xlarge", + "x1.8xlarge", + "x1.16xlarge", + "x1.32xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "g2.8xlarge", + "cg1.4xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdList", + "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", + "locationName":"prefixListIds" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "IpRanges":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "LaunchSpecsList":{ + "type":"list", + "member":{ + "shape":"SpotFleetLaunchSpecification", + "locationName":"item" + }, + "min":1 + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "ModifyHostsRequest":{ + "type":"structure", + "required":[ + "HostIds", + "AutoPlacement" + ], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The host IDs of the Dedicated Hosts you want to modify.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Specify whether to enable or disable auto-placement.

", + "locationName":"autoPlacement" + } + }, + "documentation":"

Contains the parameters for ModifyHosts.

" + }, + "ModifyHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ModifyHosts.

" + }, + "ModifyIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" + } + }, + "documentation":"

Contains the parameters of ModifyIdFormat.

" + }, + "ModifyIdentityIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds", + "PrincipalArn" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", + "locationName":"useLongIds" + }, + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", + "locationName":"principalArn" + } + }, + "documentation":"

Contains the parameters of ModifyIdentityIdFormat.

" + }, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

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

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + }, + "documentation":"

Contains the parameters for ModifyImageAttribute.

" + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" + }, + "ModifyInstancePlacementRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that you are modifying.

", + "locationName":"instanceId" + }, + "Tenancy":{ + "shape":"HostTenancy", + "documentation":"

The tenancy of the instance that you are modifying.

", + "locationName":"tenancy" + }, + "Affinity":{ + "shape":"Affinity", + "documentation":"

The new affinity setting for the instance.

", + "locationName":"affinity" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host that the instance will have affinity with.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ModifyInstancePlacement.

" + }, + "ModifyInstancePlacementResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyInstancePlacement.

" + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + }, + "documentation":"

Contains the parameters for ModifyReservedInstances.

" + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + }, + "documentation":"

Contains the output of ModifyReservedInstances.

" + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

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

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + }, + "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" + }, + "ModifySpotFleetRequestRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The size of the fleet.

", + "locationName":"targetCapacity" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + } + }, + "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" + }, + "ModifySpotFleetRequestResponse":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifySpotFleetRequest.

" + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + }, + "documentation":"

Contains the parameters for ModifySubnetAttribute.

" + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + }, + "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + } + }, + "documentation":"

Contains the parameters for ModifyVpcAttribute.

" + }, + "ModifyVpcEndpointRequest":{ + "type":"structure", + "required":["VpcEndpointId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the endpoint.

" + }, + "ResetPolicy":{ + "shape":"Boolean", + "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" + }, + "AddRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables IDs to associate with the endpoint.

", + "locationName":"AddRouteTableId" + }, + "RemoveRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs to disassociate from the endpoint.

", + "locationName":"RemoveRouteTableId" + } + }, + "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" + }, + "ModifyVpcEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyVpcEndpoint.

" + }, + "ModifyVpcPeeringConnectionOptionsRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

" + }, + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the requester VPC.

" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the accepter VPC.

" + } + } + }, + "ModifyVpcPeeringConnectionOptionsResult":{ + "type":"structure", + "members":{ + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the requester VPC.

", + "locationName":"requesterPeeringConnectionOptions" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", + "locationName":"accepterPeeringConnectionOptions" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for MonitorInstances.

" + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of MonitorInstances.

" + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "MoveAddressToVpcRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for MoveAddressToVpc.

" + }, + "MoveAddressToVpcResult":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID for the Elastic IP address.

", + "locationName":"allocationId" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the move of the IP address.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output of MoveAddressToVpc.

" + }, + "MoveStatus":{ + "type":"string", + "enum":[ + "movingToVpc", + "restoringToClassic" + ] + }, + "MovingAddressStatus":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "MoveStatus":{ + "shape":"MoveStatus", + "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", + "locationName":"moveStatus" + } + }, + "documentation":"

Describes the status of a moving Elastic IP address.

" + }, + "MovingAddressStatusSet":{ + "type":"list", + "member":{ + "shape":"MovingAddressStatus", + "locationName":"item" + } + }, + "NatGateway":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the NAT gateway is located.

", + "locationName":"vpcId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the NAT gateway is located.

", + "locationName":"subnetId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was created.

", + "locationName":"createTime" + }, + "DeleteTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", + "locationName":"deleteTime" + }, + "NatGatewayAddresses":{ + "shape":"NatGatewayAddressList", + "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", + "locationName":"natGatewayAddressSet" + }, + "State":{ + "shape":"NatGatewayState", + "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", + "locationName":"state" + }, + "FailureCode":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", + "locationName":"failureCode" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", + "locationName":"failureMessage" + }, + "ProvisionedBandwidth":{ + "shape":"ProvisionedBandwidth", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionedBandwidth" + } + }, + "documentation":"

Describes a NAT gateway.

" + }, + "NatGatewayAddress":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address associated with the NAT gateway.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "locationName":"allocationId" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIp" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface associated with the NAT gateway.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" + }, + "NatGatewayAddressList":{ + "type":"list", + "member":{ + "shape":"NatGatewayAddress", + "locationName":"item" + } + }, + "NatGatewayList":{ + "type":"list", + "member":{ + "shape":"NatGateway", + "locationName":"item" + } + }, + "NatGatewayState":{ + "type":"string", + "enum":[ + "pending", + "failed", + "available", + "deleting", + "deleted" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + }, + "InterfaceType":{ + "shape":"NetworkInterfaceType", + "documentation":"

The type of interface.

", + "locationName":"interfaceType" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "NetworkInterfaceType":{ + "type":"string", + "enum":[ + "interface", + "natGateway" + ] + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "OccurrenceDayRequestSet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"OccurenceDay" + } + }, + "OccurrenceDaySet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"item" + } + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OperationType":{ + "type":"string", + "enum":[ + "add", + "remove" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PaymentOption":{ + "type":"string", + "enum":[ + "AllUpfront", + "PartialUpfront", + "NoUpfront" + ] + }, + "PeeringConnectionOptions":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "PeeringConnectionOptionsRequest":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" + } + }, + "documentation":"

The VPC peering connection options.

" + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", + "locationName":"tenancy" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", + "locationName":"hostId" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", + "locationName":"affinity" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PrefixList":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix.

", + "locationName":"prefixListName" + }, + "Cidrs":{ + "shape":"ValueStringList", + "documentation":"

The IP address range of the AWS service.

", + "locationName":"cidrSet" + } + }, + "documentation":"

Describes prefixes for AWS services.

" + }, + "PrefixListId":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + } + }, + "documentation":"

The ID of the prefix.

" + }, + "PrefixListIdList":{ + "type":"list", + "member":{ + "shape":"PrefixListId", + "locationName":"item" + } + }, + "PrefixListIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "PrefixListSet":{ + "type":"list", + "member":{ + "shape":"PrefixList", + "locationName":"item" + } + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of reservations available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressConfigSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesPrivateIpAddressConfig", + "locationName":"PrivateIpAddressConfigSet" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "ProvisionedBandwidth":{ + "type":"structure", + "members":{ + "Provisioned":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisioned" + }, + "Requested":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requested" + }, + "RequestTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requestTime" + }, + "ProvisionTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionTime" + }, + "Status":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"status" + } + }, + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "Purchase":{ + "type":"structure", + "members":{ + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"hostReservationId" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option for the reservation.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation per hour.

", + "locationName":"hourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation's term in seconds.

", + "locationName":"duration" + } + }, + "documentation":"

Describes the result of the purchase.

" + }, + "PurchaseHostReservationRequest":{ + "type":"structure", + "required":[ + "OfferingId", + "HostIdSet" + ], + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the offering.

" + }, + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" + }, + "LimitPrice":{ + "shape":"String", + "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "PurchaseHostReservationResult":{ + "type":"structure", + "members":{ + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

Describes the details of the purchase.

", + "locationName":"purchase" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The total amount that will be charged to your account when you purchase the reservation.

", + "locationName":"totalUpfrontPrice" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The total hourly price of the reservation calculated per hour.

", + "locationName":"totalHourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

", + "locationName":"clientToken" + } + } + }, + "PurchaseRequest":{ + "type":"structure", + "required":[ + "PurchaseToken", + "InstanceCount" + ], + "members":{ + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

" + } + }, + "documentation":"

Describes a request to purchase Scheduled Instances.

" + }, + "PurchaseRequestSet":{ + "type":"list", + "member":{ + "shape":"PurchaseRequest", + "locationName":"PurchaseRequest" + }, + "min":1 + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + }, + "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" + }, + "PurchaseScheduledInstancesRequest":{ + "type":"structure", + "required":["PurchaseRequests"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "PurchaseRequests":{ + "shape":"PurchaseRequestSet", + "documentation":"

One or more purchase requests.

", + "locationName":"PurchaseRequest" + } + }, + "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" + }, + "PurchaseScheduledInstancesResult":{ + "type":"structure", + "members":{ + "ScheduledInstanceSet":{ + "shape":"PurchasedScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of PurchaseScheduledInstances.

" + }, + "PurchaseSet":{ + "type":"list", + "member":{"shape":"Purchase"} + }, + "PurchasedScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for RebootInstances.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Contains the parameters for RegisterImage.

" + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of RegisterImage.

" + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of RejectVpcPeeringConnection.

" + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for ReleaseAddress.

" + }, + "ReleaseHostsRequest":{ + "type":"structure", + "required":["HostIds"], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts you want to release.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ReleaseHosts.

" + }, + "ReleaseHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ReleaseHosts.

" + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for ReplaceRoute.

" + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + }, + "documentation":"

Contains the parameters for ReportInstanceStatus.

" + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestHostIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestSpotFleetRequest":{ + "type":"structure", + "required":["SpotFleetRequestConfig"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration for the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "RequestSpotFleetResponse":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", + "locationName":"blockDurationMinutes" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + }, + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

[EC2-Classic only] One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservationState":{ + "type":"string", + "enum":[ + "payment-pending", + "payment-failed", + "active", + "retired" + ] + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reservations purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + }, + "documentation":"

Describes the modification request/s.

" + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + }, + "documentation":"

Contains the parameters for ResetImageAttribute.

" + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for ResetInstanceAttribute.

" + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" + } + }, + "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "ResponseHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ResponseHostIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RestoreAddressToClassicRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for RestoreAddressToClassic.

" + }, + "RestoreAddressToClassicResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

The move status for the IP address.

", + "locationName":"status" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the output of RestoreAddressToClassic.

" + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationPrefixListId":{ + "shape":"String", + "documentation":"

The prefix of the AWS service.

", + "locationName":"destinationPrefixListId" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + }, + "documentation":"

Contains the parameters for RunInstances.

" + }, + "RunScheduledInstancesRequest":{ + "type":"structure", + "required":[ + "ScheduledInstanceId", + "LaunchSpecification" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

Default: 1

" + }, + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

" + }, + "LaunchSpecification":{ + "shape":"ScheduledInstancesLaunchSpecification", + "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" + } + }, + "documentation":"

Contains the parameters for RunScheduledInstances.

" + }, + "RunScheduledInstancesResult":{ + "type":"structure", + "members":{ + "InstanceIdSet":{ + "shape":"InstanceIdSet", + "documentation":"

The IDs of the newly launched instances.

", + "locationName":"instanceIdSet" + } + }, + "documentation":"

Contains the output of RunScheduledInstances.

" + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "ScheduledInstance":{ + "type":"structure", + "members":{ + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

", + "locationName":"scheduledInstanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "PreviousSlotEndTime":{ + "shape":"DateTime", + "documentation":"

The time that the previous schedule ended or will end.

", + "locationName":"previousSlotEndTime" + }, + "NextSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time for the next schedule to start.

", + "locationName":"nextSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

", + "locationName":"instanceCount" + }, + "TermStartDate":{ + "shape":"DateTime", + "documentation":"

The start date for the Scheduled Instance.

", + "locationName":"termStartDate" + }, + "TermEndDate":{ + "shape":"DateTime", + "documentation":"

The end date for the Scheduled Instance.

", + "locationName":"termEndDate" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The date when the Scheduled Instance was purchased.

", + "locationName":"createDate" + } + }, + "documentation":"

Describes a Scheduled Instance.

" + }, + "ScheduledInstanceAvailability":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token. This token expires in two hours.

", + "locationName":"purchaseToken" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "FirstSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time period for the first schedule to start.

", + "locationName":"firstSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of available instances.

", + "locationName":"availableInstanceCount" + }, + "MinTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The minimum term. The only possible value is 365 days.

", + "locationName":"minTermDurationInDays" + }, + "MaxTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The maximum term. The only possible value is 365 days.

", + "locationName":"maxTermDurationInDays" + } + }, + "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" + }, + "ScheduledInstanceAvailabilitySet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstanceAvailability", + "locationName":"item" + } + }, + "ScheduledInstanceIdRequestSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ScheduledInstanceId" + } + }, + "ScheduledInstanceRecurrence":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

", + "locationName":"frequency" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", + "locationName":"interval" + }, + "OccurrenceDaySet":{ + "shape":"OccurrenceDaySet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", + "locationName":"occurrenceDaySet" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "locationName":"occurrenceRelativeToEnd" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "locationName":"occurrenceUnit" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceRecurrenceRequest":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" + }, + "OccurrenceDays":{ + "shape":"OccurrenceDayRequestSet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", + "locationName":"OccurrenceDay" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "ScheduledInstancesBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" + }, + "Ebs":{ + "shape":"ScheduledInstancesEbs", + "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" + } + }, + "documentation":"

Describes a block device mapping for a Scheduled Instance.

" + }, + "ScheduledInstancesBlockDeviceMappingSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesBlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "ScheduledInstancesEbs":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + } + }, + "documentation":"

Describes an EBS volume for a Scheduled Instance.

" + }, + "ScheduledInstancesIamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN).

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + } + }, + "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" + }, + "ScheduledInstancesLaunchSpecification":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI).

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + }, + "SecurityGroupIds":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The base64-encoded MIME user data.

" + }, + "Placement":{ + "shape":"ScheduledInstancesPlacement", + "documentation":"

The placement information.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

" + }, + "BlockDeviceMappings":{ + "shape":"ScheduledInstancesBlockDeviceMappingSet", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"ScheduledInstancesMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

" + }, + "NetworkInterfaces":{ + "shape":"ScheduledInstancesNetworkInterfaceSet", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"ScheduledInstancesIamInstanceProfile", + "documentation":"

The IAM instance profile.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" + } + }, + "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" + }, + "ScheduledInstancesMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

" + } + }, + "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

" + }, + "PrivateIpAddressConfigs":{ + "shape":"PrivateIpAddressConfigSet", + "documentation":"

The private IP addresses.

", + "locationName":"PrivateIpAddressConfig" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses.

" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" + }, + "Groups":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"Group" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" + } + }, + "documentation":"

Describes a network interface for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterfaceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesNetworkInterface", + "locationName":"NetworkInterface" + } + }, + "ScheduledInstancesPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

" + } + }, + "documentation":"

Describes the placement for a Scheduled Instance.

" + }, + "ScheduledInstancesPrivateIpAddressConfig":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address.

" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" + } + }, + "documentation":"

Describes a private IP address for a Scheduled Instance.

" + }, + "ScheduledInstancesSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupReference":{ + "type":"structure", + "required":[ + "GroupId", + "ReferencingVpcId" + ], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of your security group.

", + "locationName":"groupId" + }, + "ReferencingVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with the referencing security group.

", + "locationName":"referencingVpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC with a security group that references your security group.

" + }, + "SecurityGroupReferences":{ + "type":"list", + "member":{ + "shape":"SecurityGroupReference", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "SlotDateTimeRangeRequest":{ + "type":"structure", + "required":[ + "EarliestTime", + "LatestTime" + ], + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + }, + "SlotStartTimeRangeRequest":{ + "type":"structure", + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"statusMessage" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + }, + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"dataEncryptionKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + } + }, + "documentation":"

Describes the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + } + }, + "documentation":"

The disk container object for the import snapshot request.

" + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the import snapshot task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the import snapshot task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import snapshot task.

", + "locationName":"status" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot instance.

" + }, + "SpotFleetLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "Monitoring":{ + "shape":"SpotFleetMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "locationName":"weightedCapacity" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", + "locationName":"spotPrice" + } + }, + "documentation":"

Describes the launch specification for one or more Spot instances.

" + }, + "SpotFleetMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables monitoring for the instance.

Default: false

", + "locationName":"enabled" + } + }, + "documentation":"

Describes whether monitoring is enabled.

" + }, + "SpotFleetRequestConfig":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "SpotFleetRequestState", + "SpotFleetRequestConfig", + "CreateTime" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "SpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The state of the Spot fleet request.

", + "locationName":"spotFleetRequestState" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

Information about the configuration of the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The creation date and time of the request.

", + "locationName":"createTime" + }, + "ActivityStatus":{ + "shape":"ActivityStatus", + "documentation":"

The progress of the Spot fleet request. If there is an error, the status is error. After all bids are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.

", + "locationName":"activityStatus" + } + }, + "documentation":"

Describes a Spot fleet request.

" + }, + "SpotFleetRequestConfigData":{ + "type":"structure", + "required":[ + "SpotPrice", + "TargetCapacity", + "IamFleetRole", + "LaunchSpecifications" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour.

", + "locationName":"spotPrice" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", + "locationName":"targetCapacity" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", + "locationName":"validUntil" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "IamFleetRole":{ + "shape":"String", + "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", + "locationName":"iamFleetRole" + }, + "LaunchSpecifications":{ + "shape":"LaunchSpecsList", + "documentation":"

Information about the launch specifications for the Spot fleet request.

", + "locationName":"launchSpecifications" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "AllocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", + "locationName":"allocationStrategy" + }, + "FulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", + "locationName":"fulfilledCapacity" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", + "locationName":"type" + } + }, + "documentation":"

Describes the configuration of a Spot fleet request.

" + }, + "SpotFleetRequestConfigSet":{ + "type":"list", + "member":{ + "shape":"SpotFleetRequestConfig", + "locationName":"item" + } + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot instance.

", + "locationName":"productDescription" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The duration for the Spot instance, in minutes.

", + "locationName":"blockDurationMinutes" + }, + "ActualBlockHourlyPrice":{ + "shape":"String", + "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", + "locationName":"actualBlockHourlyPrice" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describes a Spot instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StaleIpPermission":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "locationName":"ipProtocol" + }, + "IpRanges":{ + "shape":"IpRanges", + "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdSet", + "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", + "locationName":"prefixListIds" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairSet", + "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", + "locationName":"groups" + } + }, + "documentation":"

Describes a stale rule in a security group.

" + }, + "StaleIpPermissionSet":{ + "type":"list", + "member":{ + "shape":"StaleIpPermission", + "locationName":"item" + } + }, + "StaleSecurityGroup":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the security group.

", + "locationName":"description" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "StaleIpPermissions":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale inbound rules in the security group.

", + "locationName":"staleIpPermissions" + }, + "StaleIpPermissionsEgress":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale outbound rules in the security group.

", + "locationName":"staleIpPermissionsEgress" + } + }, + "documentation":"

Describes a stale security group (a security group that contains stale rules).

" + }, + "StaleSecurityGroupSet":{ + "type":"list", + "member":{ + "shape":"StaleSecurityGroup", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for StartInstances.

" + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StartInstances.

" + }, + "State":{ + "type":"string", + "enum":[ + "Pending", + "Available", + "Deleting", + "Deleted" + ] + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "Status":{ + "type":"string", + "enum":[ + "MoveInProgress", + "InVpc", + "InClassic" + ] + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data", + "initializing" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for StopInstances.

" + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StopInstances.

" + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable", + "initializing" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated", + "host" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for TerminateInstances.

" + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of TerminateInstances.

" + }, + "TrafficType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "ALL" + ] + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for UnmonitorInstances.

" + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of UnmonitorInstances.

" + }, + "UnsuccessfulItem":{ + "type":"structure", + "required":["Error"], + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "Error":{ + "shape":"UnsuccessfulItemError", + "documentation":"

Information about the error.

", + "locationName":"error" + } + }, + "documentation":"

Information about items that were not successfully processed in a batch call.

" + }, + "UnsuccessfulItemError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message accompanying the error code.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" + }, + "UnsuccessfulItemList":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UnsuccessfulItemSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"data" + } + }, + "documentation":"

Describes the user data for an instance.

" + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", + "locationName":"vpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection, if applicable.

", + "locationName":"vpcPeeringConnectionId" + }, + "PeeringStatus":{ + "shape":"String", + "documentation":"

The status of a VPC peering connection, if applicable.

", + "locationName":"peeringStatus" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdGroupPairSet":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"

Information about the volume attachments.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2", + "sc1", + "st1" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the endpoint is associated.

", + "locationName":"vpcId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the AWS service to which the endpoint is associated.

", + "locationName":"serviceName" + }, + "State":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"state" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

The policy document associated with the endpoint.

", + "locationName":"policyDocument" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables associated with the endpoint.

", + "locationName":"routeTableIdSet" + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + } + }, + "documentation":"

Describes a VPC endpoint.

" + }, + "VpcEndpointSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionOptionsDescription":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"VpcPeeringConnectionStateReasonCode", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionStateReasonCode":{ + "type":"string", + "enum":[ + "initiating-request", + "pending-acceptance", + "active", + "deleted", + "rejected", + "failed", + "expired", + "provisioning", + "deleting" + ] + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "PeeringOptions":{ + "shape":"VpcPeeringConnectionOptionsDescription", + "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", + "locationName":"peeringOptions" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + } + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" +} diff --git a/aws/dist/botocore/data/ec2/2016-04-01/waiters-2.json b/aws/dist/botocore/data/ec2/2016-04-01/waiters-2.json new file mode 100644 index 00000000..aa36a044 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-04-01/waiters-2.json @@ -0,0 +1,607 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Reservations[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConsoleOutputAvailable": { + "operation": "GetConsoleOutput", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(Output || '') > `0`", + "expected": true + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageExists": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Images[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidAMIID.NotFound", + "state": "retry" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "KeyPairExists": { + "operation": "DescribeKeyPairs", + "delay": 5, + "maxAttempts": 6, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(KeyPairs[].KeyName) > `0`" + }, + { + "expected": "InvalidKeyPair.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NatGatewayAvailable": { + "operation": "DescribeNatGateways", + "delay": 15, + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "NatGateways[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "failed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleting" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleted" + }, + { + "state": "retry", + "matcher": "error", + "expected": "NatGatewayNotFound" + } + ] + }, + "NetworkAclExists": { + "operation": "DescribeNetworkAcls", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(NetworkAcls[]) > `0`", + "state": "success" + }, + { + "expected": "InvalidNetworkAclID.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NetworkInterfaceAvailable": { + "operation": "DescribeNetworkInterfaces", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "NetworkInterfaces[].Status" + }, + { + "expected": "InvalidNetworkInterfaceID.NotFound", + "matcher": "error", + "state": "failure" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolume.NotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 60, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpcPeeringConnectionExists": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "retry" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-09-15/examples-1.json b/aws/dist/botocore/data/ec2/2016-09-15/examples-1.json new file mode 100644 index 00000000..f6a8719f --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-09-15/examples-1.json @@ -0,0 +1,3740 @@ +{ + "version": "1.0", + "examples": { + "AllocateAddress": [ + { + "input": { + "Domain": "vpc" + }, + "output": { + "AllocationId": "eipalloc-64d5890a", + "Domain": "vpc", + "PublicIp": "203.0.113.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in a VPC.", + "id": "ec2-allocate-address-1", + "title": "To allocate an Elastic IP address for EC2-VPC" + }, + { + "output": { + "Domain": "standard", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.", + "id": "ec2-allocate-address-2", + "title": "To allocate an Elastic IP address for EC2-Classic" + } + ], + "AssignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns the specified secondary private IP address to the specified network interface.", + "id": "ec2-assign-private-ip-addresses-1", + "title": "To assign a specific secondary private IP address to an interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "SecondaryPrivateIpAddressCount": 2 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", + "id": "ec2-assign-private-ip-addresses-2", + "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface" + } + ], + "AssociateAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "InstanceId": "i-0b263919b6498b123" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified instance in a VPC.", + "id": "ec2-associate-address-1", + "title": "To associate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "NetworkInterfaceId": "eni-1a2b3c4d" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified network interface.", + "id": "ec2-associate-address-2", + "title": "To associate an Elastic IP address with a network interface" + }, + { + "input": { + "InstanceId": "i-07ffe74c7330ebf53", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates an Elastic IP address with an instance in EC2-Classic.", + "id": "ec2-associate-address-3", + "title": "To associate an Elastic IP address in EC2-Classic" + } + ], + "AssociateDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-1", + "title": "To associate a DHCP options set with a VPC" + }, + { + "input": { + "DhcpOptionsId": "default", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the default DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-2", + "title": "To associate the default DHCP options set with a VPC" + } + ], + "AssociateRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640", + "SubnetId": "subnet-9d4a7b6" + }, + "output": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the specified subnet.", + "id": "ec2-associate-route-table-1", + "title": "To associate a route table with a subnet" + } + ], + "AttachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified Internet gateway to the specified VPC.", + "id": "ec2-attach-internet-gateway-1", + "title": "To attach an Internet gateway to a VPC" + } + ], + "AttachNetworkInterface": [ + { + "input": { + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "output": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified network interface to the specified instance.", + "id": "ec2-attach-network-interface-1", + "title": "To attach a network interface to an instance" + } + ], + "AttachVolume": [ + { + "input": { + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2016-08-29T18:52:32.724Z", + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "State": "attaching", + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", + "id": "to-attach-a-volume-to-an-instance-1472499213109", + "title": "To attach a volume to an instance" + } + ], + "CancelSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": true + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_running", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-1", + "title": "To cancel a Spot fleet request" + }, + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": false + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_terminating", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-2", + "title": "To cancel a Spot fleet request without terminating its Spot Instances" + } + ], + "CancelSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "CancelledSpotInstanceRequests": [ + { + "SpotInstanceRequestId": "sir-08b93456", + "State": "cancelled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels a Spot Instance request.", + "id": "ec2-cancel-spot-instance-requests-1", + "title": "To cancel Spot Instance requests" + } + ], + "ConfirmProductInstance": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0", + "ProductCode": "774F4FF8" + }, + "output": { + "OwnerId": "123456789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example determines whether the specified product code is associated with the specified instance.", + "id": "to-confirm-the-product-instance-1472712108494", + "title": "To confirm the product instance" + } + ], + "CopySnapshot": [ + { + "input": { + "Description": "This is my copied snapshot.", + "DestinationRegion": "us-east-1", + "SourceRegion": "us-west-2", + "SourceSnapshotId": "snap-066877671789bd71b" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", + "id": "to-copy-a-snapshot-1472502259774", + "title": "To copy a snapshot" + } + ], + "CreateCustomerGateway": [ + { + "input": { + "BgpAsn": 65534, + "PublicIp": "12.1.2.3", + "Type": "ipsec.1" + }, + "output": { + "CustomerGateway": { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a customer gateway with the specified IP address for its outside interface.", + "id": "ec2-create-customer-gateway-1", + "title": "To create a customer gateway" + } + ], + "CreateDhcpOptions": [ + { + "input": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + "10.2.5.1", + "10.2.5.2" + ] + } + ] + }, + "output": { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DHCP options set.", + "id": "ec2-create-dhcp-options-1", + "title": "To create a DHCP options set" + } + ], + "CreateInternetGateway": [ + { + "output": { + "InternetGateway": { + "Attachments": [ + + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Internet gateway.", + "id": "ec2-create-internet-gateway-1", + "title": "To create an Internet gateway" + } + ], + "CreateKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a key pair named my-key-pair.", + "id": "ec2-create-key-pair-1", + "title": "To create a key pair" + } + ], + "CreateNatGateway": [ + { + "input": { + "AllocationId": "eipalloc-37fc1a52", + "SubnetId": "subnet-1a2b3c4d" + }, + "output": { + "NatGateway": { + "CreateTime": "2015-12-17T12:45:26.732Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "NatGatewayId": "nat-08d48af2a8e83edfd", + "State": "pending", + "SubnetId": "subnet-1a2b3c4d", + "VpcId": "vpc-1122aabb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", + "id": "ec2-create-nat-gateway-1", + "title": "To create a NAT gateway" + } + ], + "CreateNetworkAcl": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "NetworkAcl": { + "Associations": [ + + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network ACL for the specified VPC.", + "id": "ec2-create-network-acl-1", + "title": "To create a network ACL" + } + ], + "CreateNetworkAclEntry": [ + { + "input": { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "udp", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-create-network-acl-entry-1", + "title": "To create a network ACL entry" + } + ], + "CreateNetworkInterface": [ + { + "input": { + "Description": "my network interface", + "Groups": [ + "sg-903004f8" + ], + "PrivateIpAddress": "10.0.2.17", + "SubnetId": "subnet-9d4a7b6c" + }, + "output": { + "NetworkInterface": { + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "default" + } + ], + "MacAddress": "02:1a:80:41:52:9c", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateIpAddress": "10.0.2.17", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.2.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-9d4a7b6c", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network interface for the specified subnet.", + "id": "ec2-create-network-interface-1", + "title": "To create a network interface" + } + ], + "CreatePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster", + "Strategy": "cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a placement group with the specified name.", + "id": "to-create-a-placement-group-1472712245768", + "title": "To create a placement group" + } + ], + "CreateRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-c0a643a9", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", + "id": "ec2-create-route-1", + "title": "To create a route" + } + ], + "CreateRouteTable": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "RouteTable": { + "Associations": [ + + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-22574640", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route table for the specified VPC.", + "id": "ec2-create-route-table-1", + "title": "To create a route table" + } + ], + "CreateSnapshot": [ + { + "input": { + "Description": "This is my root volume snapshot.", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "Description": "This is my root volume snapshot.", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:06:01.000Z", + "State": "pending", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", + "id": "to-create-a-snapshot-1472502529790", + "title": "To create a snapshot" + } + ], + "CreateSpotDatafeedSubscription": [ + { + "input": { + "Bucket": "my-s3-bucket", + "Prefix": "spotdata" + }, + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot Instance data feed for your AWS account.", + "id": "ec2-create-spot-datafeed-subscription-1", + "title": "To create a Spot Instance datafeed" + } + ], + "CreateSubnet": [ + { + "input": { + "CidrBlock": "10.0.1.0/24", + "VpcId": "vpc-a01106c2" + }, + "output": { + "Subnet": { + "AvailabilityZone": "us-west-2c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "State": "pending", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", + "id": "ec2-create-subnet-1", + "title": "To create a subnet" + } + ], + "CreateTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "production" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", + "id": "ec2-create-tags-1", + "title": "To add a tag to a resource" + } + ], + "CreateVolume": [ + { + "input": { + "AvailabilityZone": "us-east-1a", + "Size": 80, + "VolumeType": "gp2" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Encrypted": false, + "Iops": 240, + "Size": 80, + "SnapshotId": "", + "State": "creating", + "VolumeId": "vol-6b60b7c7", + "VolumeType": "gp2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-volume-1472496724296", + "title": "To create a new volume" + }, + { + "input": { + "AvailabilityZone": "us-east-1a", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "VolumeType": "io1" + }, + "output": { + "Attachments": [ + + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Iops": 1000, + "Size": 500, + "SnapshotId": "snap-066877671789bd71b", + "State": "creating", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeType": "io1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176", + "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot" + } + ], + "CreateVpc": [ + { + "input": { + "CidrBlock": "10.0.0.0/16" + }, + "output": { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "State": "pending", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a VPC with the specified CIDR block.", + "id": "ec2-create-vpc-1", + "title": "To create a VPC" + } + ], + "DeleteCustomerGateway": [ + { + "input": { + "CustomerGatewayId": "cgw-0e11f167" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified customer gateway.", + "id": "ec2-delete-customer-gateway-1", + "title": "To delete a customer gateway" + } + ], + "DeleteDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DHCP options set.", + "id": "ec2-delete-dhcp-options-1", + "title": "To delete a DHCP options set" + } + ], + "DeleteInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Internet gateway.", + "id": "ec2-delete-internet-gateway-1", + "title": "To delete an Internet gateway" + } + ], + "DeleteKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified key pair.", + "id": "ec2-delete-key-pair-1", + "title": "To delete a key pair" + } + ], + "DeleteNatGateway": [ + { + "input": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "output": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified NAT gateway.", + "id": "ec2-delete-nat-gateway-1", + "title": "To delete a NAT gateway" + } + ], + "DeleteNetworkAcl": [ + { + "input": { + "NetworkAclId": "acl-5fb85d36" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network ACL.", + "id": "ec2-delete-network-acl-1", + "title": "To delete a network ACL" + } + ], + "DeleteNetworkAclEntry": [ + { + "input": { + "Egress": true, + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes ingress rule number 100 from the specified network ACL.", + "id": "ec2-delete-network-acl-entry-1", + "title": "To delete a network ACL entry" + } + ], + "DeleteNetworkInterface": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network interface.", + "id": "ec2-delete-network-interface-1", + "title": "To delete a network interface" + } + ], + "DeletePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified placement group.\n", + "id": "to-delete-a-placement-group-1472712349959", + "title": "To delete a placement group" + } + ], + "DeleteRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route from the specified route table.", + "id": "ec2-delete-route-1", + "title": "To delete a route" + } + ], + "DeleteRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route table.", + "id": "ec2-delete-route-table-1", + "title": "To delete a route table" + } + ], + "DeleteSnapshot": [ + { + "input": { + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-delete-a-snapshot-1472503042567", + "title": "To delete a snapshot" + } + ], + "DeleteSpotDatafeedSubscription": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a Spot data feed subscription for the account.", + "id": "ec2-delete-spot-datafeed-subscription-1", + "title": "To cancel a Spot Instance data feed subscription" + } + ], + "DeleteSubnet": [ + { + "input": { + "SubnetId": "subnet-9d4a7b6c" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified subnet.", + "id": "ec2-delete-subnet-1", + "title": "To delete a subnet" + } + ], + "DeleteTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "test" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the tag Stack=test from the specified image.", + "id": "ec2-delete-tags-1", + "title": "To delete a tag from a resource" + } + ], + "DeleteVolume": [ + { + "input": { + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", + "id": "to-delete-a-volume-1472503111160", + "title": "To delete a volume" + } + ], + "DeleteVpc": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified VPC.", + "id": "ec2-delete-vpc-1", + "title": "To delete a VPC" + } + ], + "DescribeAccountAttributes": [ + { + "input": { + "AttributeNames": [ + "supported-platforms" + ] + }, + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the supported-platforms attribute for your AWS account.", + "id": "ec2-describe-account-attributes-1", + "title": "To describe a single attribute for your AWS account" + }, + { + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + }, + { + "AttributeName": "vpc-max-security-groups-per-interface", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-instances", + "AttributeValues": [ + { + "AttributeValue": "20" + } + ] + }, + { + "AttributeName": "vpc-max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "default-vpc", + "AttributeValues": [ + { + "AttributeValue": "none" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes for your AWS account.", + "id": "ec2-describe-account-attributes-2", + "title": "To describe all attributes for your AWS account" + } + ], + "DescribeAddresses": [ + { + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + }, + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses.", + "id": "ec2-describe-addresses-1", + "title": "To describe your Elastic IP addresses" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "vpc" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in a VPC.", + "id": "ec2-describe-addresses-2", + "title": "To describe your Elastic IP addresses for EC2-VPC" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "standard" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in EC2-Classic.", + "id": "ec2-describe-addresses-3", + "title": "To describe your Elastic IP addresses for EC2-Classic" + } + ], + "DescribeAvailabilityZones": [ + { + "output": { + "AvailabilityZones": [ + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1b" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1c" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1d" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1e" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", + "id": "ec2-describe-availability-zones-1", + "title": "To describe your Availability Zones" + } + ], + "DescribeCustomerGateways": [ + { + "input": { + "CustomerGatewayIds": [ + "cgw-0e11f167" + ] + }, + "output": { + "CustomerGateways": [ + { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified customer gateway.", + "id": "ec2-describe-customer-gateways-1", + "title": "To describe a customer gateway" + } + ], + "DescribeDhcpOptions": [ + { + "input": { + "DhcpOptionsIds": [ + "dopt-d9070ebb" + ] + }, + "output": { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified DHCP options set.", + "id": "ec2-describe-dhcp-options-1", + "title": "To describe a DHCP options set" + } + ], + "DescribeInstanceAttribute": [ + { + "input": { + "Attribute": "instanceType", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "t1.micro" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instance type of the specified instance.\n", + "id": "to-describe-the-instance-type-1472712432132", + "title": "To describe the instance type" + }, + { + "input": { + "Attribute": "disableApiTermination", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "DisableApiTermination": { + "Value": "false" + }, + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``disableApiTermination`` attribute of the specified instance.\n", + "id": "to-describe-the-disableapitermination-attribute-1472712533466", + "title": "To describe the disableApiTermination attribute" + }, + { + "input": { + "Attribute": "blockDeviceMapping", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "AttachTime": "2013-05-17T22:42:34.000Z", + "DeleteOnTermination": true, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + }, + { + "DeviceName": "/dev/sdf", + "Ebs": { + "AttachTime": "2013-09-10T23:07:00.000Z", + "DeleteOnTermination": false, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + } + ], + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", + "id": "to-describe-the-block-device-mapping-for-an-instance-1472712645423", + "title": "To describe the block device mapping for an instance" + } + ], + "DescribeInternetGateways": [ + { + "input": { + "Filters": [ + { + "Name": "attachment.vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "InternetGateways": [ + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-a01106c2" + } + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Internet gateway for the specified VPC.", + "id": "ec2-describe-internet-gateways-1", + "title": "To describe the Internet gateway for a VPC" + } + ], + "DescribeKeyPairs": [ + { + "input": { + "KeyNames": [ + "my-key-pair" + ] + }, + "output": { + "KeyPairs": [ + { + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", + "KeyName": "my-key-pair" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example displays the fingerprint for the specified key.", + "id": "ec2-describe-key-pairs-1", + "title": "To display a key pair" + } + ], + "DescribeMovingAddresses": [ + { + "output": { + "MovingAddressStatuses": [ + { + "MoveStatus": "MovingToVpc", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your moving Elastic IP addresses.", + "id": "ec2-describe-moving-addresses-1", + "title": "To describe your moving addresses" + } + ], + "DescribeNatGateways": [ + { + "input": { + "Filter": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-1a2b3c4d" + ] + } + ] + }, + "output": { + "NatGateways": [ + { + "CreateTime": "2015-12-01T12:26:55.983Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-89c620ec", + "NetworkInterfaceId": "eni-9dec76cd", + "PrivateIp": "10.0.0.149", + "PublicIp": "198.11.222.333" + } + ], + "NatGatewayId": "nat-05dba92075d71c408", + "State": "available", + "SubnetId": "subnet-847e4dc2", + "VpcId": "vpc-1a2b3c4d" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the NAT gateway for the specified VPC.", + "id": "ec2-describe-nat-gateways-1", + "title": "To describe a NAT gateway" + } + ], + "DescribeNetworkAcls": [ + { + "input": { + "NetworkAclIds": [ + "acl-5fb85d36" + ] + }, + "output": { + "NetworkAcls": [ + { + "Associations": [ + { + "NetworkAclAssociationId": "aclassoc-66ea5f0b", + "NetworkAclId": "acl-9aeb5ef7", + "SubnetId": "subnet-65ea5f08" + } + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified network ACL.", + "id": "ec2-", + "title": "To describe a network ACL" + } + ], + "DescribeNetworkInterfaceAttribute": [ + { + "input": { + "Attribute": "attachment", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Attachment": { + "AttachTime": "2015-05-21T20:02:20.000Z", + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": true, + "DeviceIndex": 0, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attachment attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-1", + "title": "To describe the attachment attribute of a network interface" + }, + { + "input": { + "Attribute": "description", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the description attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-2", + "title": "To describe the description attribute of a network interface" + }, + { + "input": { + "Attribute": "groupSet", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "my-security-group" + } + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the groupSet attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-3", + "title": "To describe the groupSet attribute of a network interface" + }, + { + "input": { + "Attribute": "sourceDestCheck", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": true + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-4", + "title": "To describe the sourceDestCheck attribute of a network interface" + } + ], + "DescribeNetworkInterfaces": [ + { + "input": { + "NetworkInterfaceIds": [ + "eni-e5aa89a3" + ] + }, + "output": { + "NetworkInterfaces": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Attachment": { + "AttachTime": "2013-11-30T23:36:42.000Z", + "AttachmentId": "eni-attach-66c4350a", + "DeleteOnTermination": false, + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-8637d3e3", + "GroupName": "default" + } + ], + "MacAddress": "02:2f:8f:b0:cf:75", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17", + "PrivateIpAddresses": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Primary": true, + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "in-use", + "SubnetId": "subnet-b61f49f0", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "ec2-describe-network-interfaces-1", + "title": "To describe a network interface" + } + ], + "DescribeRegions": [ + { + "output": { + "Regions": [ + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all the regions that are available to you.", + "id": "ec2-describe-regions-1", + "title": "To describe your regions" + } + ], + "DescribeRouteTables": [ + { + "input": { + "RouteTableIds": [ + "rtb-1f382e7d" + ] + }, + "output": { + "RouteTables": [ + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-d8ccddba", + "RouteTableId": "rtb-1f382e7d" + } + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-1f382e7d", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified route table.", + "id": "ec2-describe-route-tables-1", + "title": "To describe a route table" + } + ], + "DescribeScheduledInstanceAvailability": [ + { + "input": { + "FirstSlotStartTimeRange": { + "EarliestTime": "2016-01-31T00:00:00Z", + "LatestTime": "2016-01-31T04:00:00Z" + }, + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDays": [ + 1 + ] + } + }, + "output": { + "ScheduledInstanceAvailabilitySet": [ + { + "AvailabilityZone": "us-west-2b", + "AvailableInstanceCount": 20, + "FirstSlotStartTime": "2016-01-31T00:00:00Z", + "HourlyPrice": "0.095", + "InstanceType": "c4.large", + "MaxTermDurationInDays": 366, + "MinTermDurationInDays": 366, + "NetworkPlatform": "EC2-VPC", + "Platform": "Linux/UNIX", + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false + }, + "SlotDurationInHours": 23, + "TotalScheduledInstanceHours": 1219 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.", + "id": "ec2-describe-scheduled-instance-availability-1", + "title": "To describe an available schedule" + } + ], + "DescribeScheduledInstances": [ + { + "input": { + "ScheduledInstanceIds": [ + "sci-1234-1234-1234-1234-123456789012" + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Scheduled Instance.", + "id": "ec2-describe-scheduled-instances-1", + "title": "To describe your Scheduled Instances" + } + ], + "DescribeSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-066877671789bd71b" + }, + "output": { + "CreateVolumePermissions": [ + + ], + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", + "id": "to-describe-snapshot-attributes-1472503199736", + "title": "To describe snapshot attributes" + } + ], + "DescribeSnapshots": [ + { + "input": { + "SnapshotIds": [ + "snap-1234567890abcdef0" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my snapshot.", + "OwnerId": "012345678910", + "Progress": "100%", + "SnapshotId": "snap-1234567890abcdef0", + "StartTime": "2014-02-28T21:28:32.000Z", + "State": "completed", + "VolumeId": "vol-049df61146c4d7901", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", + "id": "to-describe-a-snapshot-1472503807850", + "title": "To describe a snapshot" + }, + { + "input": { + "Filters": [ + { + "Name": "status", + "Values": [ + "pending" + ] + } + ], + "OwnerIds": [ + "012345678910" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my copied snapshot.", + "OwnerId": "012345678910", + "Progress": "87%", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:37:27.000Z", + "State": "pending", + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", + "id": "to-describe-snapshots-using-filters-1472503929793", + "title": "To describe snapshots using filters" + } + ], + "DescribeSpotDatafeedSubscription": [ + { + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Spot Instance datafeed subscription for your AWS account.", + "id": "ec2-describe-spot-datafeed-subscription-1", + "title": "To describe the datafeed for your AWS account" + } + ], + "DescribeSpotFleetInstances": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "output": { + "ActiveInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": "m3.medium", + "SpotInstanceRequestId": "sir-08b93456" + } + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the Spot Instances associated with the specified Spot fleet.", + "id": "ec2-describe-spot-fleet-instances-1", + "title": "To describe the Spot Instances associated with a Spot fleet" + } + ], + "DescribeSpotFleetRequestHistory": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "output": { + "HistoryRecords": [ + { + "EventInformation": { + "EventSubType": "submitted" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.697Z" + }, + { + "EventInformation": { + "EventSubType": "active" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.873Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef0" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.712Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef1" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.816Z" + } + ], + "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the history for the specified Spot fleet starting at the specified time.", + "id": "ec2-describe-spot-fleet-request-history-1", + "title": "To describe Spot fleet history" + } + ], + "DescribeSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ] + }, + "output": { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "cc2.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + }, + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + } + ], + "SpotPrice": "0.05", + "TargetCapacity": 20 + }, + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestState": "active" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot fleet request.", + "id": "ec2-describe-spot-fleet-requests-1", + "title": "To describe a Spot fleet request" + } + ], + "DescribeSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "SpotInstanceRequests": [ + { + "CreateTime": "2014-04-30T18:14:55.000Z", + "InstanceId": "i-1234567890abcdef0", + "LaunchSpecification": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "EbsOptimized": false, + "ImageId": "ami-7aba833f", + "InstanceType": "m1.small", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-e38f24a7", + "GroupName": "my-security-group" + } + ] + }, + "LaunchedAvailabilityZone": "us-west-1b", + "ProductDescription": "Linux/UNIX", + "SpotInstanceRequestId": "sir-08b93456", + "SpotPrice": "0.010000", + "State": "active", + "Status": { + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled.", + "UpdateTime": "2014-04-30T18:16:21.000Z" + }, + "Type": "one-time" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot Instance request.", + "id": "ec2-describe-spot-instance-requests-1", + "title": "To describe a Spot Instance request" + } + ], + "DescribeSpotPriceHistory": [ + { + "input": { + "EndTime": "2014-01-06T08:09:10", + "InstanceTypes": [ + "m1.xlarge" + ], + "ProductDescriptions": [ + "Linux/UNIX (Amazon VPC)" + ], + "StartTime": "2014-01-06T07:08:09" + }, + "output": { + "SpotPriceHistory": [ + { + "AvailabilityZone": "us-west-1a", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-06T04:32:53.000Z" + }, + { + "AvailabilityZone": "us-west-1c", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-05T11:28:26.000Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", + "id": "ec2-describe-spot-price-history-1", + "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)" + } + ], + "DescribeSubnets": [ + { + "input": { + "Filters": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "Subnets": [ + { + "AvailabilityZone": "us-east-1c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the subnets for the specified VPC.", + "id": "ec2-describe-subnets-1", + "title": "To describe the subnets for a VPC" + } + ], + "DescribeTags": [ + { + "input": { + "Filters": [ + { + "Name": "resource-id", + "Values": [ + "i-1234567890abcdef8" + ] + } + ] + }, + "output": { + "Tags": [ + { + "Key": "Stack", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "test" + }, + { + "Key": "Name", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "Beta Server" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified instance.", + "id": "ec2-describe-tags-1", + "title": "To describe the tags for a single resource" + } + ], + "DescribeVolumeAttribute": [ + { + "input": { + "Attribute": "autoEnableIO", + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", + "id": "to-describe-a-volume-attribute-1472505773492", + "title": "To describe a volume attribute" + } + ], + "DescribeVolumeStatus": [ + { + "input": { + "VolumeIds": [ + "vol-1234567890abcdef0" + ] + }, + "output": { + "VolumeStatuses": [ + { + "Actions": [ + + ], + "AvailabilityZone": "us-east-1a", + "Events": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeStatus": { + "Details": [ + { + "Name": "io-enabled", + "Status": "passed" + }, + { + "Name": "io-performance", + "Status": "not-applicable" + } + ], + "Status": "ok" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for the volume ``vol-1234567890abcdef0``.", + "id": "to-describe-the-status-of-a-single-volume-1472507016193", + "title": "To describe the status of a single volume" + }, + { + "input": { + "Filters": [ + { + "Name": "volume-status.status", + "Values": [ + "impaired" + ] + } + ] + }, + "output": { + "VolumeStatuses": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", + "id": "to-describe-the-status-of-impaired-volumes-1472507239821", + "title": "To describe the status of impaired volumes" + } + ], + "DescribeVolumes": [ + { + "input": { + }, + "output": { + "NextToken": "", + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your volumes in the default region.", + "id": "to-describe-all-volumes-1472506358883", + "title": "To describe all volumes" + }, + { + "input": { + "Filters": [ + { + "Name": "attachment.instance-id", + "Values": [ + "i-1234567890abcdef0" + ] + }, + { + "Name": "attachment.delete-on-termination", + "Values": [ + "true" + ] + } + ] + }, + "output": { + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", + "id": "to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578", + "title": "To describe volumes that are attached to a specific instance" + } + ], + "DescribeVpcAttribute": [ + { + "input": { + "Attribute": "enableDnsSupport", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsSupport": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-describe-vpc-attribute-1", + "title": "To describe the enableDnsSupport attribute" + }, + { + "input": { + "Attribute": "enableDnsHostnames", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsHostnames": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-describe-vpc-attribute-2", + "title": "To describe the enableDnsHostnames attribute" + } + ], + "DescribeVpcs": [ + { + "input": { + "VpcIds": [ + "vpc-a01106c2" + ] + }, + "output": { + "Vpcs": [ + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "IsDefault": false, + "State": "available", + "Tags": [ + { + "Key": "Name", + "Value": "MyVPC" + } + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified VPC.", + "id": "ec2-describe-vpcs-1", + "title": "To describe a VPC" + } + ], + "DetachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified Internet gateway from the specified VPC.", + "id": "ec2-detach-internet-gateway-1", + "title": "To detach an Internet gateway from a VPC" + } + ], + "DetachNetworkInterface": [ + { + "input": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified network interface from its attached instance.", + "id": "ec2-detach-network-interface-1", + "title": "To detach a network interface from an instance" + } + ], + "DetachVolume": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2014-02-27T19:23:06.000Z", + "Device": "/dev/sdb", + "InstanceId": "i-1234567890abcdef0", + "State": "detaching", + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", + "id": "to-detach-a-volume-from-an-instance-1472507977694", + "title": "To detach a volume from an instance" + } + ], + "DisableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", + "id": "ec2-disable-vgw-route-propagation-1", + "title": "To disable route propagation" + } + ], + "DisassociateAddress": [ + { + "input": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in a VPC.", + "id": "ec2-disassociate-address-1", + "title": "To disassociate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in EC2-Classic.", + "id": "ec2-disassociate-address-2", + "title": "To disassociate an Elastic IP addresses in EC2-Classic" + } + ], + "DisassociateRouteTable": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates the specified route table from its associated subnet.", + "id": "ec2-disassociate-route-table-1", + "title": "To disassociate a route table" + } + ], + "EnableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", + "id": "ec2-enable-vgw-route-propagation-1", + "title": "To enable route propagation" + } + ], + "EnableVolumeIO": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables I/O on volume ``vol-1234567890abcdef0``.", + "id": "to-enable-io-for-a-volume-1472508114867", + "title": "To enable I/O for a volume" + } + ], + "ModifyNetworkInterfaceAttribute": [ + { + "input": { + "Attachment": { + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": false + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the attachment attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-1", + "title": "To modify the attachment attribute of a network interface" + }, + { + "input": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the description attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-2", + "title": "To modify the description attribute of a network interface" + }, + { + "input": { + "Groups": [ + "sg-903004f8", + "sg-1a2b3c4d" + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the groupSet attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-3", + "title": "To modify the groupSet attribute of a network interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": false + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-4", + "title": "To modify the sourceDestCheck attribute of a network interface" + } + ], + "ModifySnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "OperationType": "remove", + "SnapshotId": "snap-1234567890abcdef0", + "UserIds": [ + "123456789012" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", + "id": "to-modify-a-snapshot-attribute-1472508385907", + "title": "To modify a snapshot attribute" + }, + { + "input": { + "Attribute": "createVolumePermission", + "GroupNames": [ + "all" + ], + "OperationType": "add", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", + "id": "to-make-a-snapshot-public-1472508470529", + "title": "To make a snapshot public" + } + ], + "ModifySpotFleetRequest": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 20 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example increases the target capacity of the specified Spot fleet request.", + "id": "ec2-modify-spot-fleet-request-1", + "title": "To increase the target capacity of a Spot fleet request" + }, + { + "input": { + "ExcessCapacityTerminationPolicy": "NoTermination ", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 10 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.", + "id": "ec2-modify-spot-fleet-request-2", + "title": "To decrease the target capacity of a Spot fleet request" + } + ], + "ModifySubnetAttribute": [ + { + "input": { + "MapPublicIpOnLaunch": { + "Value": true + }, + "SubnetId": "subnet-1a2b3c4d" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", + "id": "ec2-modify-subnet-attribute-1", + "title": "To change a subnet's public IP addressing behavior" + } + ], + "ModifyVolumeAttribute": [ + { + "input": { + "AutoEnableIO": { + "Value": true + }, + "DryRun": true, + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", + "id": "to-modify-a-volume-attribute-1472508596749", + "title": "To modify a volume attribute" + } + ], + "ModifyVpcAttribute": [ + { + "input": { + "EnableDnsSupport": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-modify-vpc-attribute-1", + "title": "To modify the enableDnsSupport attribute" + }, + { + "input": { + "EnableDnsHostnames": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-modify-vpc-attribute-2", + "title": "To modify the enableDnsHostnames attribute" + } + ], + "MoveAddressToVpc": [ + { + "input": { + "PublicIp": "54.123.4.56" + }, + "output": { + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example moves the specified Elastic IP address to the EC2-VPC platform.", + "id": "ec2-move-address-to-vpc-1", + "title": "To move an address to EC2-VPC" + } + ], + "PurchaseScheduledInstances": [ + { + "input": { + "PurchaseRequests": [ + { + "InstanceCount": 1, + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..." + } + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example purchases a Scheduled Instance.", + "id": "ec2-purchase-scheduled-instances-1", + "title": "To purchase a Scheduled Instance" + } + ], + "ReleaseAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in a VPC.", + "id": "ec2-release-address-1", + "title": "To release an Elastic IP address for EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in EC2-Classic.", + "id": "ec2-release-address-2", + "title": "To release an Elastic IP addresses for EC2-Classic" + } + ], + "ReplaceNetworkAclAssociation": [ + { + "input": { + "AssociationId": "aclassoc-e5b95c8c", + "NetworkAclId": "acl-5fb85d36" + }, + "output": { + "NewAssociationId": "aclassoc-3999875b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified network ACL with the subnet for the specified network ACL association.", + "id": "ec2-replace-network-acl-association-1", + "title": "To replace the network ACL associated with a subnet" + } + ], + "ReplaceNetworkAclEntry": [ + { + "input": { + "CidrBlock": "203.0.113.12/24", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "udp", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-replace-network-acl-entry-1", + "title": "To replace a network ACL entry" + } + ], + "ReplaceRoute": [ + { + "input": { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", + "id": "ec2-replace-route-1", + "title": "To replace a route" + } + ], + "ReplaceRouteTableAssociation": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a", + "RouteTableId": "rtb-22574640" + }, + "output": { + "NewAssociationId": "rtbassoc-3a1f0f58" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the subnet for the specified route table association.", + "id": "ec2-replace-route-table-association-1", + "title": "To replace the route table associated with a subnet" + } + ], + "RequestSpotFleet": [ + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f" + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", + "id": "ec2-request-spot-fleet-1", + "title": "To request a Spot fleet in the subnet with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a, us-west-2b" + }, + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.", + "id": "ec2-request-spot-fleet-2", + "title": "To request a Spot fleet in the Availability Zone with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", + "id": "ec2-request-spot-fleet-3", + "title": "To launch Spot instances in a subnet and assign them public IP addresses" + }, + { + "input": { + "SpotFleetRequestConfig": { + "AllocationStrategy": "diversified", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "c4.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + } + ], + "SpotPrice": "0.70", + "TargetCapacity": 30 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", + "id": "ec2-request-spot-fleet-4", + "title": "To request a Spot fleet using the diversified allocation strategy" + } + ], + "RequestSpotInstances": [ + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ] + }, + "SpotPrice": "0.03", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.", + "id": "ec2-request-spot-instances-1", + "title": "To create a one-time Spot Instance request" + }, + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + }, + "SpotPrice": "0.050", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", + "id": "ec2-request-spot-instances-2", + "title": "To create a one-time Spot Instance request" + } + ], + "ResetSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-reset-a-snapshot-attribute-1472508825735", + "title": "To reset a snapshot attribute" + } + ], + "RestoreAddressToClassic": [ + { + "input": { + "PublicIp": "198.51.100.0" + }, + "output": { + "PublicIp": "198.51.100.0", + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example restores the specified Elastic IP address to the EC2-Classic platform.", + "id": "ec2-restore-address-to-classic-1", + "title": "To restore an address to EC2-Classic" + } + ], + "RunScheduledInstances": [ + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-12345678" + ], + "SubnetId": "subnet-12345678" + } + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in a VPC.", + "id": "ec2-run-scheduled-instances-1", + "title": "To launch a Scheduled Instance in a VPC" + }, + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2b" + }, + "SecurityGroupIds": [ + "sg-12345678" + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in EC2-Classic.", + "id": "ec2-run-scheduled-instances-2", + "title": "To launch a Scheduled Instance in EC2-Classic" + } + ], + "UnassignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example unassigns the specified private IP address from the specified network interface.", + "id": "ec2-unassign-private-ip-addresses-1", + "title": "To unassign a secondary private IP address from a network interface" + } + ] + } +} diff --git a/aws/dist/botocore/data/ec2/2016-09-15/paginators-1.json b/aws/dist/botocore/data/ec2/2016-09-15/paginators-1.json new file mode 100644 index 00000000..2bd01ad5 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-09-15/paginators-1.json @@ -0,0 +1,63 @@ +{ + "pagination": { + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + }, + "DescribeSpotFleetRequests": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotFleetRequestConfigs" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Volumes" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-09-15/service-2.json b/aws/dist/botocore/data/ec2/2016-09-15/service-2.json new file mode 100644 index 00000000..34ad98b0 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-09-15/service-2.json @@ -0,0 +1,17908 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-09-15", + "endpointPrefix":"ec2", + "protocol":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-09-15" + }, + "operations":{ + "AcceptReservedInstancesExchangeQuote":{ + "name":"AcceptReservedInstancesExchangeQuote", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptReservedInstancesExchangeQuoteRequest"}, + "output":{"shape":"AcceptReservedInstancesExchangeQuoteResult"}, + "documentation":"

Purchases Convertible Reserved Instance offerings described in the GetReservedInstancesExchangeQuote call.

" + }, + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Acquires an Elastic IP address.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AllocateHosts":{ + "name":"AllocateHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateHostsRequest"}, + "output":{"shape":"AllocateHostsResult"}, + "documentation":"

Allocates a Dedicated Host to your account. At minimum you need to specify the instance size type, Availability Zone, and quantity of hosts you want to allocate.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface. You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

AssignPrivateIpAddresses is available only in EC2-VPC.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an Internet gateway to a VPC, enabling connectivity between the Internet and the VPC. For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For an overview of the AWS Marketplace, see Introducing AWS Marketplace.

For more information about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. For more information, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Adds one or more egress rules to a security group for use with a VPC. Specifically, this action permits instances to send traffic to one or more destination CIDR IP address ranges, or to one or more destination security groups for the same VPC. This action doesn't apply to security groups for use in EC2-Classic. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

You can have up to 50 rules per security group (covering both ingress and egress rules).

Each rule consists of the protocol (for example, TCP), plus either a CIDR range or a source group. For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds one or more ingress rules to a security group.

EC2-Classic: You can have up to 100 rules per group.

EC2-VPC: You can have up to 50 rules per group (covering both ingress and egress rules).

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

[EC2-Classic] This action gives one or more CIDR IP address ranges permission to access a security group in your account, or gives one or more security groups (called the source groups) permission to access a security group for your account. A source group can be for your own AWS account, or another.

[EC2-VPC] This action gives one or more CIDR IP address ranges permission to access a security group in your VPC, or gives one or more other security groups (called the source groups) permission to access a security group for your VPC. The security groups must all be for the same VPC.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

For more information, see Creating an Instance Store-Backed Windows AMI.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests":{ + "name":"CancelSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotFleetRequestsRequest"}, + "output":{"shape":"CancelSpotFleetRequestsResponse"}, + "documentation":"

Cancels the specified Spot fleet requests.

After you cancel a Spot fleet request, the Spot fleet launches no new Spot instances. You must specify whether the Spot fleet should also terminate its Spot instances. If you terminate the instances, the Spot fleet request enters the cancelled_terminating state. Otherwise, the Spot fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot instance requests. Spot instances are instances that Amazon EC2 starts on your behalf when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

Canceling a Spot instance request does not terminate running Spot instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner needs to verify whether another user's instance is eligible for support.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.

For more information, see Copying AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same region or from one region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. If you want your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in \"us-east-1\", specify \"ec2.internal\". If you're using AmazonProvidedDNS in another region, specify \"region.compute.internal\" (for example, \"ap-northeast-1.compute.internal\"). Otherwise, specify a domain name (for example, \"MyCompany.com\"). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an Internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFlowLogs":{ + "name":"CreateFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowLogsRequest"}, + "output":{"shape":"CreateFlowLogsResult"}, + "documentation":"

Creates one or more flow logs to capture IP traffic for a specific network interface, subnet, or VPC. Flow logs are delivered to a specified log group in Amazon CloudWatch Logs. If you specify a VPC or subnet in the request, a log stream is created in CloudWatch Logs for each network interface in the subnet or VPC. Log streams can include information about accepted and rejected traffic to a network interface. You can view the data in your log streams using Amazon CloudWatch Logs.

In your request, you must also specify an IAM role that has permission to publish logs to CloudWatch Logs.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an Internet gateway for use with a VPC. After creating the Internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and Internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{"shape":"KeyPair"}, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#8 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per region.

The key pair returned to you is available only in the region in which you create it. To create a key pair that is available in all regions, use ImportKeyPair.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateNatGateway":{ + "name":"CreateNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNatGatewayRequest"}, + "output":{"shape":"CreateNatGatewayResult"}, + "documentation":"

Creates a NAT gateway in the specified subnet. A NAT gateway can be used to enable instances in a private subnet to connect to the Internet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group that you launch cluster instances into. You must give the group a name that's unique within the scope of your account.

For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "output":{"shape":"CreateRouteResult"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

When determining how to route traffic, we use the route with the most specific match. For example, let's say the traffic is destined for 192.0.2.3, and the route table includes the following two routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

EC2-Classic: You can have up to 500 security groups.

EC2-VPC: You can create up to 500 security groups per VPC.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{"shape":"Snapshot"}, + "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot instances, enabling you to view Spot instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and the CIDR block you want for the subnet. After you create a subnet, you can't change its CIDR block. The subnet's CIDR block can be the same as the VPC's CIDR block (assuming you want only a single subnet in the VPC), or a subset of the VPC's CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest subnet (and VPC) you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses).

AWS reserves both the first four and the last IP address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites one or more tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{"shape":"Volume"}, + "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating or Restoring an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified CIDR block.

The smallest VPC you can create uses a /28 netmask (16 IP addresses), and the largest uses a /16 netmask (65,536 IP addresses). To help you decide how big to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

By default, each instance you launch in the VPC has the default DHCP options, which includes only a default DNS server that we provide (AmazonProvidedDNS). For more information about DHCP options, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResult"}, + "documentation":"

Creates a VPC endpoint for a specified AWS service. An endpoint enables you to create a private connection between your VPC and another AWS service in your account. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

Currently, only endpoints to Amazon S3 are supported.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and a peer VPC with which to create the connection. The peer VPC can belong to another AWS account. The requester VPC and peer VPC cannot have overlapping CIDR blocks.

The owner of the peer VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

A CreateVpcPeeringConnection request between VPCs with overlapping CIDR blocks results in the VPC peering connection having a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information about virtual private gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteFlowLogs":{ + "name":"DeleteFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowLogsRequest"}, + "output":{"shape":"DeleteFlowLogsResult"}, + "documentation":"

Deletes one or more flow logs.

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified Internet gateway. You must detach the Internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteNatGateway":{ + "name":"DeleteNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNatGatewayRequest"}, + "output":{"shape":"DeleteNatGatewayResult"}, + "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot instances.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources. This call is designed to follow a DescribeTags request.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume may remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpoints":{ + "name":"DeleteVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointsRequest"}, + "output":{"shape":"DeleteVpcEndpointsResult"}, + "documentation":"

Deletes one or more specified VPC endpoints. Deleting the endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the peer VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances.

This command does not delete the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes one or more of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes one or more of the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes one or more of your bundling tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink; you cannot use this request to return information about other instances.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes one or more of your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information about DHCP options sets, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes one or more of your export tasks.

" + }, + "DescribeFlowLogs":{ + "name":"DescribeFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlowLogsRequest"}, + "output":{"shape":"DescribeFlowLogsResult"}, + "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeHostReservationOfferings":{ + "name":"DescribeHostReservationOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationOfferingsRequest"}, + "output":{"shape":"DescribeHostReservationOfferingsResult"}, + "documentation":"

Describes the Dedicated Host Reservations that are available to purchase.

The results describe all the Dedicated Host Reservation offerings, including offerings that may not match the instance family and region of your Dedicated Hosts. When purchasing an offering, ensure that the the instance family and region of the offering matches that of the Dedicated Host/s it will be associated with. For an overview of supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeHostReservations":{ + "name":"DescribeHostReservations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationsRequest"}, + "output":{"shape":"DescribeHostReservationsResult"}, + "documentation":"

Describes Dedicated Host Reservations which are associated with Dedicated Hosts in your account.

" + }, + "DescribeHosts":{ + "name":"DescribeHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostsRequest"}, + "output":{"shape":"DescribeHostsResult"}, + "documentation":"

Describes one or more of your Dedicated Hosts.

The results describe only the Dedicated Hosts in the region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released will be listed with the state released.

" + }, + "DescribeIdFormat":{ + "name":"DescribeIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdFormatRequest"}, + "output":{"shape":"DescribeIdFormatResult"}, + "documentation":"

Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "DescribeIdentityIdFormat":{ + "name":"DescribeIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityIdFormatRequest"}, + "output":{"shape":"DescribeIdentityIdFormatResult"}, + "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: instance | reservation | snapshot | volume.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{"shape":"ImageAttribute"}, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.

Deregistered images are included in the returned results for an unspecified interval after deregistration.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of one or more instances. By default, only running instances are described, unless specified otherwise.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes one or more of your instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your Internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes one or more of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeMovingAddresses":{ + "name":"DescribeMovingAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMovingAddressesRequest"}, + "output":{"shape":"DescribeMovingAddressesResult"}, + "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNatGateways":{ + "name":"DescribeNatGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNatGatewaysRequest"}, + "output":{"shape":"DescribeNatGatewaysResult"}, + "documentation":"

Describes one or more of the your NAT gateways.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes one or more of your placement groups. For more information about placement groups and cluster instances, see Cluster Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists":{ + "name":"DescribePrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrefixListsRequest"}, + "output":{"shape":"DescribePrefixListsResult"}, + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a VPC endpoint.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes one or more regions that are currently available to you.

For a list of the regions supported by Amazon EC2, see Regions and Endpoints.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeScheduledInstanceAvailability":{ + "name":"DescribeScheduledInstanceAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, + "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, + "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" + }, + "DescribeScheduledInstances":{ + "name":"DescribeScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstancesRequest"}, + "output":{"shape":"DescribeScheduledInstancesResult"}, + "documentation":"

Describes one or more of your Scheduled Instances.

" + }, + "DescribeSecurityGroupReferences":{ + "name":"DescribeSecurityGroupReferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, + "output":{"shape":"DescribeSecurityGroupReferencesResult"}, + "documentation":"

[EC2-VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes one or more of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot instances. For more information, see Spot Instance Data Feed in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotFleetInstances":{ + "name":"DescribeSpotFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetInstancesRequest"}, + "output":{"shape":"DescribeSpotFleetInstancesResponse"}, + "documentation":"

Describes the running instances for the specified Spot fleet.

" + }, + "DescribeSpotFleetRequestHistory":{ + "name":"DescribeSpotFleetRequestHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, + "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, + "documentation":"

Describes the events for the specified Spot fleet request during the specified time.

Spot fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event.

" + }, + "DescribeSpotFleetRequests":{ + "name":"DescribeSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestsRequest"}, + "output":{"shape":"DescribeSpotFleetRequestsResponse"}, + "documentation":"

Describes your Spot fleet requests.

Spot fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

Spot instance requests are deleted 4 hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeStaleSecurityGroups":{ + "name":"DescribeStaleSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, + "output":{"shape":"DescribeStaleSecurityGroupsResult"}, + "documentation":"

[EC2-VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information on volume status, see Monitoring the Status of Your Volumes.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcClassicLinkDnsSupport":{ + "name":"DescribeVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, + "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcEndpointServices":{ + "name":"DescribeVpcEndpointServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicesRequest"}, + "output":{"shape":"DescribeVpcEndpointServicesResult"}, + "documentation":"

Describes all supported AWS services that can be specified when creating a VPC endpoint.

" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResult"}, + "documentation":"

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information about VPN connections, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information about virtual private gateways, see Adding an IPsec Hardware VPN to Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an Internet gateway from a VPC, disabling connectivity between the Internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisableVpcClassicLinkDnsSupport":{ + "name":"DisableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC's route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EnableVpcClassicLinkDnsSupport":{ + "name":"EnableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information about ClassicLink, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance.

Instances do not have a physical monitor through which you can view their console output. They also lack physical controls that allow you to power up, reboot, or shut them down. To allow these actions, we provide them through the Amazon EC2 API and command line interface.

Instance console output is buffered and posted shortly after instance boot, reboot, and termination. Amazon EC2 preserves the most recent 64 KB output which is available for at least one hour after the most recent post.

For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. This output is buffered because the instance produces it and then posts it to a store where the instance's owner can retrieve it.

For Windows instances, the instance console output includes output from the EC2Config service.

" + }, + "GetConsoleScreenshot":{ + "name":"GetConsoleScreenshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleScreenshotRequest"}, + "output":{"shape":"GetConsoleScreenshotResult"}, + "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" + }, + "GetHostReservationPurchasePreview":{ + "name":"GetHostReservationPurchasePreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, + "output":{"shape":"GetHostReservationPurchasePreviewResult"}, + "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for an instance running Windows.

The Windows password is generated at boot if the EC2Config service plugin, Ec2SetPassword, is enabled. This usually only happens the first time an AMI is launched, and then Ec2SetPassword is automatically disabled. The password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

Password generation and encryption takes a few moments. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "GetReservedInstancesExchangeQuote":{ + "name":"GetReservedInstancesExchangeQuote", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservedInstancesExchangeQuoteRequest"}, + "output":{"shape":"GetReservedInstancesExchangeQuoteResult"}, + "documentation":"

Returns details about the values and term of your specified Convertible Reserved Instances. When an offering ID is specified it returns information about whether the exchange is valid and can be performed.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ModifyHosts":{ + "name":"ModifyHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHostsRequest"}, + "output":{"shape":"ModifyHostsResult"}, + "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, AWS will place instances that you launch with a tenancy of host, but without targeting a specific host ID, onto any available Dedicated Host in your account which has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID if you want the instance to launch onto a specific host. If no host ID is provided, the instance will be launched onto a suitable host which has auto-placement enabled.

" + }, + "ModifyIdFormat":{ + "name":"ModifyIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdFormatRequest"}, + "documentation":"

Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: instance | reservation | snapshot | volume.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyIdentityIdFormat":{ + "name":"ModifyIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdentityIdFormatRequest"}, + "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

The following resource types support longer IDs: instance | reservation | snapshot | volume. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

The SriovNetSupport enhanced networking attribute cannot be changed using this command. Instead, enable SriovNetSupport on an instance and create an AMI from the instance. This will result in an image with SriovNetSupport enabled.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstancePlacement":{ + "name":"ModifyInstancePlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstancePlacementRequest"}, + "output":{"shape":"ModifyInstancePlacementResult"}, + "documentation":"

Set the instance affinity value for a specific stopped instance and modify the instance tenancy setting.

Instance affinity is disabled by default. When instance affinity is host and it is not associated with a specific Dedicated Host, the next time it is launched it will automatically be associated with the host it lands on. This relationship will persist if the instance is stopped/started, or rebooted.

You can modify the host ID associated with a stopped instance. If a stopped instance has a new host ID association, the instance will target that host when restarted.

You can modify the tenancy of a stopped instance with a tenancy of host or dedicated.

Affinity, hostID, and tenancy are not required parameters, but at least one of them must be specified in the request. Affinity and tenancy can be modified in the same request, but tenancy can only be modified on instances that are stopped.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Standard Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySpotFleetRequest":{ + "name":"ModifySpotFleetRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySpotFleetRequestRequest"}, + "output":{"shape":"ModifySpotFleetRequestResponse"}, + "documentation":"

Modifies the specified Spot fleet request.

While the Spot fleet request is being modified, it is in the modifying state.

To scale up your Spot fleet, increase its target capacity. The Spot fleet launches the additional Spot instances according to the allocation strategy for the Spot fleet request. If the allocation strategy is lowestPrice, the Spot fleet launches instances using the Spot pool with the lowest price. If the allocation strategy is diversified, the Spot fleet distributes the instances across the Spot pools.

To scale down your Spot fleet, decrease its target capacity. First, the Spot fleet cancels any open bids that exceed the new target capacity. You can request that the Spot fleet terminate Spot instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot fleet terminates the instances with the highest price per unit. If the allocation strategy is diversified, the Spot fleet terminates instances across the Spot pools. Alternatively, you can request that the Spot fleet keep the fleet at its current size, but not replace any Spot instances that are interrupted or that you terminate manually.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint":{ + "name":"ModifyVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointRequest"}, + "output":{"shape":"ModifyVpcEndpointResult"}, + "documentation":"

Modifies attributes of a specified VPC endpoint. You can modify the policy associated with the endpoint, and you can add and remove route tables associated with the endpoint.

" + }, + "ModifyVpcPeeringConnectionOptions":{ + "name":"ModifyVpcPeeringConnectionOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, + "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, + "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in different accounts, each owner must initiate a separate request to modify the peering connection options, depending on whether their VPC was the requester or accepter for the VPC peering connection. If the peered VPCs are in the same account, you can modify the requester and accepter options in the same request. To confirm which VPC is the accepter and requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "MoveAddressToVpc":{ + "name":"MoveAddressToVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAddressToVpcRequest"}, + "output":{"shape":"MoveAddressToVpcResult"}, + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "PurchaseHostReservation":{ + "name":"PurchaseHostReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseHostReservationRequest"}, + "output":{"shape":"PurchaseHostReservationResult"}, + "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseScheduledInstances":{ + "name":"PurchaseScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseScheduledInstancesRequest"}, + "output":{"shape":"PurchaseScheduledInstancesResult"}, + "documentation":"

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of one or more instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. For more information, see Launching an Instance from a Snapshot in the Amazon Elastic Compute Cloud User Guide.

Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billingProduct code associated with an AMI to verify subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and subsequent instances launched from such an AMI will not be able to connect to package update infrastructure.

Similarly, although you can create a Windows AMI from a snapshot, you can't successfully launch an instance from the AMI.

To create Windows AMIs or to create AMIs for Linux operating systems that must retain AMI billing codes to work properly, see CreateImage.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

After releasing an Elastic IP address, it is released to the IP address pool and might be unavailable to you. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you try to release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

" + }, + "ReleaseHosts":{ + "name":"ReleaseHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseHostsRequest"}, + "output":{"shape":"ReleaseHostsResult"}, + "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, e.g., ModifyHosts. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it make take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated hosts. Try waiting a few minutes, and then try again.

Released hosts will still appear in a DescribeHosts response.

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: Internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, or network interface.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet":{ + "name":"RequestSpotFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotFleetRequest"}, + "output":{"shape":"RequestSpotFleetResponse"}, + "documentation":"

Creates a Spot fleet request.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot fleet requests Spot instances in the Spot pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot instances in your Spot fleet are in different Spot pools, you can improve the availability of your fleet.

For more information, see Spot Fleet Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot instance request. Spot instances are instances that Amazon EC2 launches when the bid price that you specify exceeds the current Spot price. Amazon EC2 periodically sets the Spot price based on available Spot Instance capacity and current Spot instance requests. For more information, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information on modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic":{ + "name":"RestoreAddressToClassic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreAddressToClassicRequest"}, + "output":{"shape":"RestoreAddressToClassicResult"}, + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

[EC2-VPC only] Removes one or more egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be revoked.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes one or more ingress rules from a security group. The values that you specify in the revoke request (for example, ports) must match the existing rule's values for the rule to be removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{"shape":"Reservation"}, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

When you launch an instance, it enters the pending state. After the instance is ready for you, it enters the running state. To check the state of your instance, call DescribeInstances.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

To tag your instance, ensure that it is running as CreateTags requires a resource ID. For more information about tagging, see Tagging Your Amazon EC2 Resources.

If you don't specify a security group when launching an instance, Amazon EC2 uses the default security group. For more information, see Security Groups in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC only accounts] If you don't specify a subnet in the request, we choose a default subnet from your default VPC for you.

[EC2-Classic accounts] If you're launching into EC2-Classic and you don't specify an Availability Zone, we choose one for you.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

You can provide optional user data when launching an instance. For more information, see Instance Metadata in the Amazon Elastic Compute Cloud User Guide.

If any of the AMIs have a product code attached for which the user has not subscribed, RunInstances fails.

Some instance types can only be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID in the request, RunInstances fails. For more information, see Instance Types Available Only in a VPC.

For more information about troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RunScheduledInstances":{ + "name":"RunScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunScheduledInstancesRequest"}, + "output":{"shape":"RunScheduledInstancesResult"}, + "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed AMI that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for hourly instance usage. However, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance.

We don't charge hourly usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains, continues to persist your data, and you are charged for Amazon EBS volume usage. Each time you transition an instance from stopped to started, Amazon EC2 charges a full instance hour, even if transitions happen multiple times within a single hour.

You can't start or stop Spot instances, and you can't stop instance store-backed instances.

When you stop an instance, we shut it down. You can restart your instance at any time. Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Stopping an instance is different to rebooting or terminating it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down one or more instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables monitoring for a running instance. For more information about monitoring instances, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "shapes":{ + "AcceptReservedInstancesExchangeQuoteRequest":{ + "type":"structure", + "required":["ReservedInstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstanceIds":{ + "shape":"ReservedInstanceIdSet", + "documentation":"

The IDs of the Convertible Reserved Instances that you want to exchange for other Convertible Reserved Instances of the same or higher value.

", + "locationName":"ReservedInstanceId" + }, + "TargetConfigurations":{ + "shape":"TargetConfigurationRequestSet", + "documentation":"

The configurations of the Convertible Reserved Instance offerings you are purchasing in this exchange.

", + "locationName":"TargetConfiguration" + } + }, + "documentation":"

Contains the parameters for accepting the quote.

" + }, + "AcceptReservedInstancesExchangeQuoteResult":{ + "type":"structure", + "members":{ + "ExchangeId":{ + "shape":"String", + "documentation":"

The ID of the successful exchange.

", + "locationName":"exchangeId" + } + }, + "documentation":"

The result of the exchange and whether it was successful.

" + }, + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for AcceptVpcPeeringConnection.

" + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of AcceptVpcPeeringConnection.

" + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

One or more values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "ActiveInstance":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + } + }, + "documentation":"

Describes a running instance in a Spot fleet.

" + }, + "ActiveInstanceSet":{ + "type":"list", + "member":{ + "shape":"ActiveInstance", + "locationName":"item" + } + }, + "ActivityStatus":{ + "type":"string", + "enum":[ + "error", + "pending_fulfillment", + "pending_termination", + "fulfilled" + ] + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "Affinity":{ + "type":"string", + "enum":[ + "default", + "host" + ] + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + } + }, + "documentation":"

Contains the parameters for AllocateAddress.

" + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + } + }, + "documentation":"

Contains the output of AllocateAddress.

" + }, + "AllocateHostsRequest":{ + "type":"structure", + "required":[ + "InstanceType", + "Quantity", + "AvailabilityZone" + ], + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

This is enabled by default. This property allows instances to be automatically placed onto available Dedicated Hosts, when you are launching instances without specifying a host ID.

Default: Enabled

", + "locationName":"autoPlacement" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

Specify the instance type that you want your Dedicated Hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.

", + "locationName":"instanceType" + }, + "Quantity":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts you want to allocate to your account with these parameters.

", + "locationName":"quantity" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the Dedicated Hosts.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Contains the parameters for AllocateHosts.

" + }, + "AllocateHostsResult":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"ResponseHostIdList", + "documentation":"

The ID of the allocated Dedicated Host. This is used when you want to launch an instance onto a specific host.

", + "locationName":"hostIdSet" + } + }, + "documentation":"

Contains the output of AllocateHosts.

" + }, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "AllocationState":{ + "type":"string", + "enum":[ + "available", + "under-assessment", + "permanent-failure", + "released", + "released-permanent-failure" + ] + }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "diversified" + ] + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64" + ] + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + } + }, + "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address. This is required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "locationName":"allowReassociation" + } + }, + "documentation":"

Contains the parameters for AssociateAddress.

" + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateAddress.

" + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AssociateDhcpOptions.

" + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for AssociateRouteTable.

" + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID (needed to disassociate the route table).

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the output of AssociateRouteTable.

" + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId", + "Groups" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Contains the parameters for AttachClassicLinkVpc.

" + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of AttachClassicLinkVpc.

" + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for AttachInternetGateway.

" + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "InstanceId", + "DeviceIndex" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + } + }, + "documentation":"

Contains the parameters for AttachNetworkInterface.

" + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + }, + "documentation":"

Contains the output of AttachNetworkInterface.

" + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "VolumeId", + "InstanceId", + "Device" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name to expose to the instance (for example, /dev/sdh or xvdh).

" + } + }, + "documentation":"

Contains the parameters for AttachVolume.

" + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for AttachVpnGateway.

" + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of AttachVpnGateway.

" + }, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

The attribute value. The valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The attribute value. Note that the value is case-sensitive.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a String.

" + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupEgress.

" + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all traffic. If you specify -1, traffic on all ports is allowed, regardless of any ports you specify.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. Can be used to specify multiple rules in a single command.

" + } + }, + "documentation":"

Contains the parameters for AuthorizeSecurityGroupIngress.

" + }, + "AutoPlacement":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone.

", + "locationName":"zoneState" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":[ + "available", + "information", + "impaired", + "unavailable" + ] + }, + "AvailableCapacity":{ + "type":"structure", + "members":{ + "AvailableInstanceCapacity":{ + "shape":"AvailableInstanceCapacityList", + "documentation":"

The total number of instances that the Dedicated Host supports.

", + "locationName":"availableInstanceCapacity" + }, + "AvailableVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs available on the Dedicated Host.

", + "locationName":"availableVCpus" + } + }, + "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" + }, + "AvailableInstanceCapacityList":{ + "type":"list", + "member":{ + "shape":"InstanceCapacity", + "locationName":"item" + } + }, + "BatchState":{ + "type":"string", + "enum":[ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating", + "modifying" + ] + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + } + }, + "documentation":"

Contains the parameters for BundleInstance.

" + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of BundleInstance.

" + }, + "BundleTask":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "CancelBatchErrorCode":{ + "type":"string", + "enum":[ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + } + }, + "documentation":"

Contains the parameters for CancelBundleTask.

" + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of CancelBundleTask.

" + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ReasonMessage":{ + "shape":"String", + "documentation":"

The reason for canceling the conversion task.

", + "locationName":"reasonMessage" + } + }, + "documentation":"

Contains the parameters for CancelConversionTask.

" + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for CancelExportTask.

" + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image or import snapshot task to be canceled.

" + }, + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + } + }, + "documentation":"

Contains the parameters for CancelImportTask.

" + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the task being canceled.

", + "locationName":"importTaskId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"state" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"previousState" + } + }, + "documentation":"

Contains the output for CancelImportTask.

" + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + }, + "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CancelReservedInstancesListing.

" + }, + "CancelSpotFleetRequestsError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"CancelBatchErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "Error" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "Error":{ + "shape":"CancelSpotFleetRequestsError", + "documentation":"

The error.

", + "locationName":"error" + } + }, + "documentation":"

Describes a Spot fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsErrorItem", + "locationName":"item" + } + }, + "CancelSpotFleetRequestsRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.

", + "locationName":"terminateInstances" + } + }, + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "UnsuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsErrorSet", + "documentation":"

Information about the Spot fleet requests that are not successfully canceled.

", + "locationName":"unsuccessfulFleetRequestSet" + }, + "SuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsSuccessSet", + "documentation":"

Information about the Spot fleet requests that are successfully canceled.

", + "locationName":"successfulFleetRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "CurrentSpotFleetRequestState", + "PreviousSpotFleetRequestState" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "CurrentSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The current state of the Spot fleet request.

", + "locationName":"currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The previous state of the Spot fleet request.

", + "locationName":"previousSpotFleetRequestState" + } + }, + "documentation":"

Describes a Spot fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsSuccessItem", + "locationName":"item" + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + }, + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "ClassicLinkDnsSupport":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkDnsSupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "locationName":"classicLinkDnsSupported" + } + }, + "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" + }, + "ClassicLinkDnsSupportList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkDnsSupport", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClientData":{ + "type":"structure", + "members":{ + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image, in GiB.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment about the disk upload.

" + } + }, + "documentation":"

Describes the client-specific data.

" + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "InstanceId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for ConfirmProductInstance.

" + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + }, + "Return":{ + "shape":"Boolean", + "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ConfirmProductInstance.

" + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "required":[ + "ConversionTaskId", + "State" + ], + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the task.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceImageId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the region that contains the AMI to copy.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination region.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination region.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopyImage.

" + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CopyImage.

" + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to copy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination region in a PresignedUrl parameter, where it is required.

CopySnapshot sends the snapshot copy to the regional endpoint that you send the HTTP request to, such as ec2.us-east-1.amazonaws.com (in the AWS CLI, this is specified with the --region parameter or the default region in your AWS configuration file).

", + "locationName":"destinationRegion" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshot should be encrypted. You can encrypt a copy of an unencrypted snapshot using this flag, but you cannot use it to create an unencrypted copy from an encrypted snapshot. Your default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Contains the parameters for CopySnapshot.

" + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Contains the output of CopySnapshot.

" + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "Type", + "PublicIp", + "BgpAsn" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + } + }, + "documentation":"

Contains the parameters for CreateCustomerGateway.

" + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + }, + "documentation":"

Contains the output of CreateCustomerGateway.

" + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + } + }, + "documentation":"

Contains the parameters for CreateDhcpOptions.

" + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + }, + "documentation":"

Contains the output of CreateDhcpOptions.

" + }, + "CreateFlowLogsRequest":{ + "type":"structure", + "required":[ + "ResourceIds", + "ResourceType", + "TrafficType", + "LogGroupName", + "DeliverLogsPermissionArn" + ], + "members":{ + "ResourceIds":{ + "shape":"ValueStringList", + "documentation":"

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowLogsResourceType", + "documentation":"

The type of resource on which to create the flow log.

" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic to log.

" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch log group.

" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateFlowLogs.

" + }, + "CreateFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the flow logs.

", + "locationName":"flowLogIdSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be created successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of CreateFlowLogs.

" + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

Information about one or more block device mappings.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Contains the parameters for CreateImage.

" + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CreateImage.

" + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"

The format and location for an instance export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Contains the parameters for CreateInstanceExportTask.

" + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "documentation":"

Information about the instance export task.

", + "locationName":"exportTask" + } + }, + "documentation":"

Contains the output for CreateInstanceExportTask.

" + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateInternetGateway.

" + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the Internet gateway.

", + "locationName":"internetGateway" + } + }, + "documentation":"

Contains the output of CreateInternetGateway.

" + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + } + }, + "documentation":"

Contains the parameters for CreateKeyPair.

" + }, + "CreateNatGatewayRequest":{ + "type":"structure", + "required":[ + "SubnetId", + "AllocationId" + ], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The subnet in which to create the NAT gateway.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + } + }, + "documentation":"

Contains the parameters for CreateNatGateway.

" + }, + "CreateNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGateway":{ + "shape":"NatGateway", + "documentation":"

Information about the NAT gateway.

", + "locationName":"natGateway" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateNatGateway.

" + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAclEntry.

" + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateNetworkAcl.

" + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + }, + "documentation":"

Contains the output of CreateNetworkAcl.

" + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see Private IP Addresses Per ENI Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateNetworkInterface.

" + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + }, + "documentation":"

Contains the output of CreateNetworkInterface.

" + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Strategy" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + } + }, + "documentation":"

Contains the parameters for CreatePlacementGroup.

" + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesId", + "InstanceCount", + "PriceSchedules", + "ClientToken" + ], + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Standard Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Standard Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CreateReservedInstancesListing.

" + }, + "CreateRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for CreateRoute.

" + }, + "CreateRouteResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of CreateRoute.

" + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for CreateRouteTable.

" + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + }, + "documentation":"

Contains the output of CreateRouteTable.

" + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "Description" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for CreateSecurityGroup.

" + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Contains the output of CreateSecurityGroup.

" + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + } + }, + "documentation":"

Contains the parameters for CreateSnapshot.

" + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot instance data feed.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + }, + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "VpcId", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" + } + }, + "documentation":"

Contains the parameters for CreateSubnet.

" + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + }, + "documentation":"

Contains the output of CreateSubnet.

" + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + }, + "documentation":"

Contains the parameters for CreateTags.

" + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The specific group that is to be added or removed from a volume's list of create volume permissions.

", + "locationName":"group" + } + }, + "documentation":"

Describes the user or group to be added or removed from the permissions for a volume.

" + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes a specific AWS account ID or group from a volume's list of create volume permissions.

" + } + }, + "documentation":"

Describes modifications to the permissions for a volume.

" + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which to create the volume.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.

Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If a KmsKeyId is specified, the Encrypted flag must also be set.

" + } + }, + "documentation":"

Contains the parameters for CreateVolume.

" + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "VpcId", + "ServiceName" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The AWS service name, in the form com.amazonaws.region.service . To get a list of available services, use the DescribeVpcEndpointServices request.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

", + "locationName":"RouteTableId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + }, + "documentation":"

Contains the parameters for CreateVpcEndpoint.

" + }, + "CreateVpcEndpointResult":{ + "type":"structure", + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"

Information about the endpoint.

", + "locationName":"vpcEndpoint" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateVpcEndpoint.

" + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the requester VPC.

", + "locationName":"vpcId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection.

", + "locationName":"peerVpcId" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + } + }, + "documentation":"

Contains the parameters for CreateVpcPeeringConnection.

" + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + }, + "documentation":"

Contains the output of CreateVpcPeeringConnection.

" + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName":"instanceTenancy" + } + }, + "documentation":"

Contains the parameters for CreateVpc.

" + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + }, + "documentation":"

Contains the output of CreateVpc.

" + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "Type", + "CustomerGatewayId", + "VpnGatewayId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.

Default: false

", + "locationName":"options" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnection.

" + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + }, + "documentation":"

Contains the output of CreateVpnConnection.

" + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnGateway.

" + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + }, + "documentation":"

Contains the output of CreateVpnGateway.

" + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteCustomerGateway.

" + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the DHCP options set.

" + } + }, + "documentation":"

Contains the parameters for DeleteDhcpOptions.

" + }, + "DeleteFlowLogsRequest":{ + "type":"structure", + "required":["FlowLogIds"], + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + } + }, + "documentation":"

Contains the parameters for DeleteFlowLogs.

" + }, + "DeleteFlowLogsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteFlowLogs.

" + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + } + }, + "documentation":"

Contains the parameters for DeleteInternetGateway.

" + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + } + }, + "documentation":"

Contains the parameters for DeleteKeyPair.

" + }, + "DeleteNatGatewayRequest":{ + "type":"structure", + "required":["NatGatewayId"], + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteNatGateway.

" + }, + "DeleteNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the output of DeleteNatGateway.

" + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Egress" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAclEntry.

" + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkAcl.

" + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkInterface.

" + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + }, + "documentation":"

Contains the parameters for DeletePlacementGroup.

" + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + } + }, + "documentation":"

Contains the parameters for DeleteRoute.

" + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for DeleteRouteTable.

" + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteSecurityGroup.

" + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + } + }, + "documentation":"

Contains the parameters for DeleteSnapshot.

" + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + }, + "documentation":"

Contains the parameters for DeleteSubnet.

" + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to delete. If you omit the value parameter, we delete the tag regardless of its value. If you specify this parameter with an empty string as the value, we delete the key only if its value is an empty string.

", + "locationName":"tag" + } + }, + "documentation":"

Contains the parameters for DeleteTags.

" + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + } + }, + "documentation":"

Contains the parameters for DeleteVolume.

" + }, + "DeleteVpcEndpointsRequest":{ + "type":"structure", + "required":["VpcEndpointIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" + }, + "DeleteVpcEndpointsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the endpoints that were not successfully deleted.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteVpcEndpoints.

" + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcPeeringConnection.

" + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DeleteVpcPeeringConnection.

" + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpc.

" + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnection.

" + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "DestinationCidrBlock" + ], + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnGateway.

" + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + } + }, + "documentation":"

Contains the parameters for DeregisterImage.

" + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

One or more account attribute names.

", + "locationName":"attributeName" + } + }, + "documentation":"

Contains the parameters for DescribeAccountAttributes.

" + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about one or more account attributes.

", + "locationName":"accountAttributeSet" + } + }, + "documentation":"

Contains the output of DescribeAccountAttributes.

" + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

", + "locationName":"Filter" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

", + "locationName":"AllocationId" + } + }, + "documentation":"

Contains the parameters for DescribeAddresses.

" + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about one or more Elastic IP addresses.

", + "locationName":"addressesSet" + } + }, + "documentation":"

Contains the output of DescribeAddresses.

" + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of one or more Availability Zones.

", + "locationName":"ZoneName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeAvailabilityZones.

" + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about one or more Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + }, + "documentation":"

Contains the output of DescribeAvailabiltyZones.

" + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

One or more bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeBundleTasks.

" + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about one or more bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + }, + "documentation":"

Contains the output of DescribeBundleTasks.

" + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the instance IDs parameter in the same request.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeClassicLinkInstances.

" + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeClassicLinkInstances.

" + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

One or more conversion task IDs.

", + "locationName":"conversionTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeConversionTasks.

" + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "documentation":"

Information about the conversion tasks.

", + "locationName":"conversionTasks" + } + }, + "documentation":"

Contains the output for DescribeConversionTasks.

" + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeCustomerGateways.

" + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeCustomerGateways.

" + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a set of DHCP options.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeDhcpOptions.

" + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + } + }, + "documentation":"

Contains the output of DescribeDhcpOptions.

" + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

One or more export task IDs.

", + "locationName":"exportTaskId" + } + }, + "documentation":"

Contains the parameters for DescribeExportTasks.

" + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "documentation":"

Information about the export tasks.

", + "locationName":"exportTaskSet" + } + }, + "documentation":"

Contains the output for DescribeExportTasks.

" + }, + "DescribeFlowLogsRequest":{ + "type":"structure", + "members":{ + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

", + "locationName":"FlowLogId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL)

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. You cannot specify this parameter and the flow log IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeFlowLogs.

" + }, + "DescribeFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogs":{ + "shape":"FlowLogSet", + "documentation":"

Information about the flow logs.

", + "locationName":"flowLogSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeFlowLogs.

" + }, + "DescribeHostReservationOfferingsRequest":{ + "type":"structure", + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation offering.

" + }, + "MinDuration":{ + "shape":"Integer", + "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" + }, + "MaxDuration":{ + "shape":"Integer", + "documentation":"

This is the maximum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-family - The instance family of the offering (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationOfferingsResult":{ + "type":"structure", + "members":{ + "OfferingSet":{ + "shape":"HostOfferingSet", + "documentation":"

Information about the offerings.

", + "locationName":"offeringSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostReservationsRequest":{ + "type":"structure", + "members":{ + "HostReservationIdSet":{ + "shape":"HostReservationIdSet", + "documentation":"

One or more host reservation IDs.

" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-family - The instance family (e.g., m4).

  • payment-option - The payment option (No Upfront | Partial Upfront | All Upfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationsResult":{ + "type":"structure", + "members":{ + "HostReservationSet":{ + "shape":"HostReservationSet", + "documentation":"

Details about the reservation's configuration.

", + "locationName":"hostReservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostsRequest":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", + "locationName":"hostId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500; if maxResults is given a larger value than 500, you will receive an error. You cannot specify this parameter and the host IDs parameter in the same request.

", + "locationName":"maxResults" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • host-reservation-id - The ID of the reservation assigned to this host.

  • client-token - The idempotency token you provided when you launched the instance

  • state- The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • availability-zone - The Availability Zone of the host.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeHosts.

" + }, + "DescribeHostsResult":{ + "type":"structure", + "members":{ + "Hosts":{ + "shape":"HostList", + "documentation":"

Information about the Dedicated Hosts.

", + "locationName":"hostSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeHosts.

" + }, + "DescribeIdFormatRequest":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

" + } + }, + "documentation":"

Contains the parameters for DescribeIdFormat.

" + }, + "DescribeIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resource.

", + "locationName":"statusSet" + } + }, + "documentation":"

Contains the output of DescribeIdFormat.

" + }, + "DescribeIdentityIdFormatRequest":{ + "type":"structure", + "required":["PrincipalArn"], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

", + "locationName":"resource" + }, + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "locationName":"principalArn" + } + }, + "documentation":"

Contains the parameters for DescribeIdentityIdFormat.

" + }, + "DescribeIdentityIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resources.

", + "locationName":"statusSet" + } + }, + "documentation":"

Contains the output of DescribeIdentityIdFormat.

" + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + } + }, + "documentation":"

Contains the parameters for DescribeImageAttribute.

" + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

One or more image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • architecture - The image architecture (i386 | x86_64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • description - The description of the image (provided during image creation).

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeImages.

" + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about one or more images.

", + "locationName":"imagesSet" + } + }, + "documentation":"

Contains the output of DescribeImages.

" + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import image task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportImageTasks.

" + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportImageTasks.

" + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import snapshot task IDs.

", + "locationName":"ImportTaskId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

" + } + }, + "documentation":"

Contains the parameters for DescribeImportSnapshotTasks.

" + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeImportSnapshotTasks.

" + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceAttribute.

" + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceStatus.

" + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

One or more instance status descriptions.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstanceStatus.

" + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name for the EBS volume (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IP address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether monitoring is enabled for the instance (disabled | enabled).

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • platform - The platform. Use windows if you have Windows instances; otherwise, leave blank.

  • private-dns-name - The private DNS name of the instance.

  • private-ip-address - The private IP address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you'll get one reservation ID. If you launch ten instances using the same launch request, you'll also get one reservation ID.

  • root-device-name - The name of the root device for the instance (for example, /dev/sda1 or /dev/xvda).

  • root-device-type - The type of root device that the instance uses (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:key=value - The key/value combination of a tag assigned to the resource, where tag:key is the tag's key.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

  • network-interface.description - The description of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.addresses.private-ip-address - The private IP address associated with the network interface.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.addresses.primary - Specifies whether the IP address of the network interface is the primary private IP address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter or tag filters in the same call.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeInstances.

" + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

Zero or more reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeInstances.

" + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

", + "locationName":"internetGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeInternetGateways.

" + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more Internet gateways.

", + "locationName":"internetGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeInternetGateways.

" + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

One or more key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeKeyPairs.

" + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about one or more key pairs.

", + "locationName":"keySet" + } + }, + "documentation":"

Contains the output of DescribeKeyPairs.

" + }, + "DescribeMovingAddressesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"

One or more Elastic IP addresses.

", + "locationName":"publicIp" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName":"filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeMovingAddresses.

" + }, + "DescribeMovingAddressesResult":{ + "type":"structure", + "members":{ + "MovingAddressStatuses":{ + "shape":"MovingAddressStatusSet", + "documentation":"

The status for each Elastic IP address.

", + "locationName":"movingAddressStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeMovingAddresses.

" + }, + "DescribeNatGatewaysRequest":{ + "type":"structure", + "members":{ + "NatGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more NAT gateway IDs.

", + "locationName":"NatGatewayId" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + }, + "documentation":"

Contains the parameters for DescribeNatGateways.

" + }, + "DescribeNatGatewaysResult":{ + "type":"structure", + "members":{ + "NatGateways":{ + "shape":"NatGatewayList", + "documentation":"

Information about the NAT gateways.

", + "locationName":"natGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeNatGateways.

" + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The CIDR range specified in the entry.

  • entry.egress - Indicates whether the entry applies to egress traffic.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the ACL's set of entries.

  • network-acl-id - The ID of the network ACL.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkAcls.

" + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkAcls.

" + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IP addresses associated with the network interface.

  • addresses.primary - Whether the private IP address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address.

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IP address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address associated with the network interface.

  • association.public-ip - The address of the Elastic IP address bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface.

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach.time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IP address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-desk-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaces.

" + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribePlacementGroups.

" + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

One or more placement groups.

", + "locationName":"placementGroupSet" + } + }, + "documentation":"

Contains the output of DescribePlacementGroups.

" + }, + "DescribePrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value specified is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribePrefixLists.

" + }, + "DescribePrefixListsResult":{ + "type":"structure", + "members":{ + "PrefixLists":{ + "shape":"PrefixListSet", + "documentation":"

All available prefix lists.

", + "locationName":"prefixListSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribePrefixLists.

" + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of one or more regions.

", + "locationName":"RegionName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).

  • region-name - The name of the region (for example, us-east-1).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRegions.

" + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about one or more regions.

", + "locationName":"regionInfo" + } + }, + "documentation":"

Contains the output of DescribeRegions.

" + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance listing IDs.

", + "locationName":"reservedInstancesListingId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Default: default

", + "locationName":"instanceTenancy" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

The offering class of the Reserved Instance. Can be standard or convertible.

" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

Describes whether the Reserved Instance is Standard or Convertible.

" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstances.

" + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + }, + "documentation":"

Contains the output for DescribeReservedInstances.

" + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false).

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The CIDR range specified in a route in the table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeRouteTables.

" + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + } + }, + "documentation":"

Contains the output of DescribeRouteTables.

" + }, + "DescribeScheduledInstanceAvailabilityRequest":{ + "type":"structure", + "required":[ + "Recurrence", + "FirstSlotStartTimeRange" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrenceRequest", + "documentation":"

The schedule recurrence.

" + }, + "FirstSlotStartTimeRange":{ + "shape":"SlotDateTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "MinSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" + }, + "MaxSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstanceAvailabilityResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceAvailabilitySet":{ + "shape":"ScheduledInstanceAvailabilitySet", + "documentation":"

Information about the available Scheduled Instances.

", + "locationName":"scheduledInstanceAvailabilitySet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ScheduledInstanceIds":{ + "shape":"ScheduledInstanceIdRequestSet", + "documentation":"

One or more Scheduled Instance IDs.

", + "locationName":"ScheduledInstanceId" + }, + "SlotStartTimeRange":{ + "shape":"SlotStartTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstances.

" + }, + "DescribeScheduledInstancesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceSet":{ + "shape":"ScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstances.

" + }, + "DescribeSecurityGroupReferencesRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"GroupIds", + "documentation":"

One or more security group IDs in your account.

" + } + } + }, + "DescribeSecurityGroupReferencesResult":{ + "type":"structure", + "members":{ + "SecurityGroupReferenceSet":{ + "shape":"SecurityGroupReferences", + "documentation":"

Information about the VPCs with the referencing security groups.

", + "locationName":"securityGroupReferenceSet" + } + } + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which the security group allows access.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - A CIDR range that has been granted permission.

  • ip-permission.from-port - The start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been granted permission.

  • ip-permission.group-name - The name of a security group that has been granted permission.

  • ip-permission.protocol - The IP protocol for the permission (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - The end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been granted permission.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag-key - The key of a tag assigned to the security group.

  • tag-value - The value of a tag assigned to the security group.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSecurityGroups.

" + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about one or more security groups.

", + "locationName":"securityGroupInfo" + } + }, + "documentation":"

Contains the output of DescribeSecurityGroups.

" + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

", + "locationName":"snapshotId" + }, + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

A list of permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

", + "locationName":"SnapshotId" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

One or more AWS accounts IDs that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • description - A description of the snapshot.

  • owner-alias - Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM consolew.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshots.

" + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSnapshots.

" + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotFleetInstancesRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetInstancesResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "ActiveInstances" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. Note that this list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetRequestHistoryRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The type of events to describe. By default, all events are described.

", + "locationName":"eventType" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestHistoryResponse":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime", + "LastEvaluatedTime", + "HistoryRecords" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "HistoryRecords":{ + "shape":"HistoryRecords", + "documentation":"

Information about the events in the history of the Spot fleet request.

", + "locationName":"historyRecordSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "DescribeSpotFleetRequestsResponse":{ + "type":"structure", + "required":["SpotFleetRequestConfigs"], + "members":{ + "SpotFleetRequestConfigs":{ + "shape":"SpotFleetRequestConfigSet", + "documentation":"

Information about the configuration of your Spot fleet.

", + "locationName":"spotFleetRequestConfigSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.

  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether monitoring is enabled for the Spot instance.

  • launch.ramdisk-id - The RAM disk ID.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • network-interface.description - A description of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.group-name - The name of the security group associated with the network interface.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot instance request ID.

  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.

  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

  • status-code - The short code describing the most recent evaluation of your Spot instance request.

  • status-message - The message explaining the status of the Spot instance request.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of Spot instance request (one-time | persistent).

  • launched-availability-zone - The Availability Zone in which the bid is launched.

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The timestamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot prices.

", + "locationName":"spotPriceHistorySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "DescribeStaleSecurityGroupsRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + } + }, + "DescribeStaleSecurityGroupsResult":{ + "type":"structure", + "members":{ + "StaleSecurityGroupSet":{ + "shape":"StaleSecurityGroupSet", + "documentation":"

Information about the stale security groups.

", + "locationName":"staleSecurityGroupSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + } + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availabilityZone - The Availability Zone for the subnet. You can also use availability-zone as the filter name.

  • available-ip-address-count - The number of IP addresses in the subnet that are available.

  • cidrBlock - The CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidr-block as the filter names.

  • defaultForAz - Indicates whether this is the default subnet for the Availability Zone. You can also use default-for-az as the filter name.

  • state - The state of the subnet (pending | available).

  • subnet-id - The ID of the subnet.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeSubnets.

" + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + } + }, + "documentation":"

Contains the output of DescribeSubnets.

" + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • key - The tag key.

  • resource-id - The resource ID.

  • resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeTags.

" + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

A list of tags.

", + "locationName":"tagSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return..

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeTags.

" + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The instance attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Contains the output of DescribeVolumeAttribute.

" + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeStatus.

" + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

A list of volumes.

", + "locationName":"volumeStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumeStatus.

" + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

One or more volume IDs.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - The encryption status of the volume.

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + } + }, + "documentation":"

Contains the parameters for DescribeVolumes.

" + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "documentation":"

Information about the volumes.

", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVolumes.

" + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":[ + "VpcId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcAttribute.

" + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + } + }, + "documentation":"

Contains the output of DescribeVpcAttribute.

" + }, + "DescribeVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPC IDs.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"ClassicLinkDnsSupportList", + "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", + "locationName":"vpcs" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use when requesting the next set of items.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLinkDnsSupport.

" + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcClassicLink.

" + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcClassicLink.

" + }, + "DescribeVpcEndpointServicesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointServicesResult":{ + "type":"structure", + "members":{ + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

A list of supported AWS services.

", + "locationName":"serviceNameSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the AWS service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state: The state of the endpoint. (pending | available | deleting | deleted)

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" + }, + "DescribeVpcEndpointsResult":{ + "type":"structure", + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpointSet", + "documentation":"

Information about the endpoints.

", + "locationName":"vpcEndpointSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpoints.

" + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The CIDR block of the peer VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the peer VPC.

  • accepter-vpc-info.vpc-id - The ID of the peer VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcPeeringConnections.

" + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpcPeeringConnections.

" + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • dhcp-options-id - The ID of a set of DHCP options.

  • isDefault - Indicates whether the VPC is the default VPC.

  • state - The state of the VPC (pending | available).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpcs.

" + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + } + }, + "documentation":"

Contains the output of DescribeVpcs.

" + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnConnections.

" + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpnConnections.

" + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:key=value - The key/value combination of a tag assigned to the resource.

  • tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter \"tag-key=Purpose\" and the filter \"tag-value=X\", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + } + }, + "documentation":"

Contains the parameters for DescribeVpnGateways.

" + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeVpnGateways.

" + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachClassicLinkVpc.

" + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DetachClassicLinkVpc.

" + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DetachInternetGateway.

" + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for DetachNetworkInterface.

" + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + } + }, + "documentation":"

Contains the parameters for DetachVolume.

" + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpnGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DetachVpnGateway.

" + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" + }, + "DisableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLinkDnsSupport.

" + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for DisableVpcClassicLink.

" + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of DisableVpcClassicLink.

" + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for DisassociateAddress.

" + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + } + }, + "documentation":"

Contains the parameters for DisassociateRouteTable.

" + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

Information about the disk image.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the disk image.

" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

Information about the volume.

" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "required":[ + "Format", + "Size", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"size" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + }, + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Format", + "Bytes", + "ImportManifestUrl" + ], + "members":{ + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "Bytes":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"bytes" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + }, + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + } + }, + "documentation":"

Describes a disk image volume.

" + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

", + "locationName":"volumeSize" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.

", + "locationName":"encrypted" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "GatewayId" + ], + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

" + } + }, + "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Contains the parameters for EnableVolumeIO.

" + }, + "EnableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLinkDnsSupport.

" + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains the parameters for EnableVpcClassicLink.

" + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of EnableVpcClassicLink.

" + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "EventInformation":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", + "locationName":"instanceId" + }, + "EventSubType":{ + "shape":"String", + "documentation":"

The event.

The following are the error events.

  • iamFleetRoleInvalid - The Spot fleet did not have the required permissions either to launch or terminate an instance.

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot instances that you can launch.

The following are the fleetRequestChange events.

  • active - The Spot fleet has been validated and Amazon EC2 is attempting to maintain the target number of running Spot instances.

  • cancelled - The Spot fleet is canceled and has no running Spot instances. The Spot fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The Spot fleet is canceled and will not launch additional Spot instances, but its existing Spot instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The Spot fleet is canceled and its Spot instances are terminating.

  • expired - The Spot fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the Spot fleet request was accepted and is in progress.

  • modify_successful - The Spot fleet request was modified.

  • price_update - The bid price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The Spot fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot instances.

The following are the instanceChange events.

  • launched - A bid was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

", + "locationName":"eventSubType" + }, + "EventDescription":{ + "shape":"String", + "documentation":"

The description of the event.

", + "locationName":"eventDescription" + } + }, + "documentation":"

Describes a Spot fleet event.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "instanceChange", + "fleetRequestChange", + "error" + ] + }, + "ExcessCapacityTerminationPolicy":{ + "type":"string", + "enum":[ + "noTermination", + "default" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportTask":{ + "type":"structure", + "members":{ + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the export task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

Information about the instance to export.

", + "locationName":"instanceExport" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "documentation":"

Information about the export task.

", + "locationName":"exportToS3" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The encryption key for your S3 bucket.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the format and location for an instance export task.

" + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

One or more filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results. Filters can be used to match a set of resources by various criteria, such as tags, attributes, or IDs.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FleetType":{ + "type":"string", + "enum":[ + "request", + "maintain" + ] + }, + "Float":{"type":"float"}, + "FlowLog":{ + "type":"structure", + "members":{ + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The date and time the flow log was created.

", + "locationName":"creationTime" + }, + "FlowLogId":{ + "shape":"String", + "documentation":"

The flow log ID.

", + "locationName":"flowLogId" + }, + "FlowLogStatus":{ + "shape":"String", + "documentation":"

The status of the flow log (ACTIVE).

", + "locationName":"flowLogStatus" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource on which the flow log was created.

", + "locationName":"resourceId" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic captured for the flow log.

", + "locationName":"trafficType" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the flow log group.

", + "locationName":"logGroupName" + }, + "DeliverLogsStatus":{ + "shape":"String", + "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", + "locationName":"deliverLogsStatus" + }, + "DeliverLogsErrorMessage":{ + "shape":"String", + "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of CloudWatch Logs log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", + "locationName":"deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "locationName":"deliverLogsPermissionArn" + } + }, + "documentation":"

Describes a flow log.

" + }, + "FlowLogSet":{ + "type":"list", + "member":{ + "shape":"FlowLog", + "locationName":"item" + } + }, + "FlowLogsResourceType":{ + "type":"string", + "enum":[ + "VPC", + "Subnet", + "NetworkInterface" + ] + }, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + } + }, + "documentation":"

Contains the parameters for GetConsoleOutput.

" + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the output was last updated.

", + "locationName":"timestamp" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, Base64-encoded. If using a command line tool, the tool decodes the output for you.

", + "locationName":"output" + } + }, + "documentation":"

Contains the output of GetConsoleOutput.

" + }, + "GetConsoleScreenshotRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "WakeUp":{ + "shape":"Boolean", + "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" + } + }, + "documentation":"

Contains the parameters for the request.

" + }, + "GetConsoleScreenshotResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageData":{ + "shape":"String", + "documentation":"

The data that comprises the image.

", + "locationName":"imageData" + } + }, + "documentation":"

Contains the output of the request.

" + }, + "GetHostReservationPurchasePreviewRequest":{ + "type":"structure", + "required":[ + "OfferingId", + "HostIdSet" + ], + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The offering ID of the reservation.

" + }, + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" + } + } + }, + "GetHostReservationPurchasePreviewResult":{ + "type":"structure", + "members":{ + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

The purchase information of the Dedicated Host Reservation and the Dedicated Hosts associated with it.

", + "locationName":"purchase" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The potential total upfront price. This is billed immediately.

", + "locationName":"totalUpfrontPrice" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The potential total hourly price of the reservation per hour.

", + "locationName":"totalHourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

" + } + }, + "documentation":"

Contains the parameters for GetPasswordData.

" + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance.

", + "locationName":"passwordData" + } + }, + "documentation":"

Contains the output of GetPasswordData.

" + }, + "GetReservedInstancesExchangeQuoteRequest":{ + "type":"structure", + "required":["ReservedInstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstanceIds":{ + "shape":"ReservedInstanceIdSet", + "documentation":"

The ID/s of the Convertible Reserved Instances you want to exchange.

", + "locationName":"ReservedInstanceId" + }, + "TargetConfigurations":{ + "shape":"TargetConfigurationRequestSet", + "documentation":"

The configuration requirements of the Convertible Reserved Instances you want in exchange for your current Convertible Reserved Instances.

", + "locationName":"TargetConfiguration" + } + }, + "documentation":"

Contains the parameters for GetReservedInstanceExchangeQuote.

" + }, + "GetReservedInstancesExchangeQuoteResult":{ + "type":"structure", + "members":{ + "ReservedInstanceValueSet":{ + "shape":"ReservedInstanceReservationValueSet", + "documentation":"

The configuration of your Convertible Reserved Instances.

", + "locationName":"reservedInstanceValueSet" + }, + "ReservedInstanceValueRollup":{ + "shape":"ReservationValue", + "locationName":"reservedInstanceValueRollup" + }, + "TargetConfigurationValueSet":{ + "shape":"TargetReservationValueSet", + "documentation":"

The values of the target Convertible Reserved Instances.

", + "locationName":"targetConfigurationValueSet" + }, + "TargetConfigurationValueRollup":{ + "shape":"ReservationValue", + "locationName":"targetConfigurationValueRollup" + }, + "PaymentDue":{ + "shape":"String", + "documentation":"

The total true upfront charge for the exchange.

", + "locationName":"paymentDue" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency of the transaction.

", + "locationName":"currencyCode" + }, + "OutputReservedInstancesWillExpireAt":{ + "shape":"DateTime", + "documentation":"

The new end date of the reservation term.

", + "locationName":"outputReservedInstancesWillExpireAt" + }, + "IsValidExchange":{ + "shape":"Boolean", + "documentation":"

If true, the exchange is valid. If false, the exchange cannot be performed.

", + "locationName":"isValidExchange" + }, + "ValidationFailureReason":{ + "shape":"String", + "documentation":"

Describes the reason why the exchange can not be completed.

", + "locationName":"validationFailureReason" + } + }, + "documentation":"

Contains the output of GetReservedInstancesExchangeQuote.

" + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupIds":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HistoryRecord":{ + "type":"structure", + "required":[ + "Timestamp", + "EventType", + "EventInformation" + ], + "members":{ + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

  • error - Indicates an error with the Spot fleet request.

  • fleetRequestChange - Indicates a change in the status or configuration of the Spot fleet request.

  • instanceChange - Indicates that an instance was launched or terminated.

", + "locationName":"eventType" + }, + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + } + }, + "documentation":"

Describes an event in the history of the Spot fleet request.

" + }, + "HistoryRecords":{ + "type":"list", + "member":{ + "shape":"HistoryRecord", + "locationName":"item" + } + }, + "Host":{ + "type":"structure", + "members":{ + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Whether auto-placement is on or off.

", + "locationName":"autoPlacement" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", + "locationName":"hostReservationId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "HostProperties":{ + "shape":"HostProperties", + "documentation":"

The hardware specifications of the Dedicated Host.

", + "locationName":"hostProperties" + }, + "State":{ + "shape":"AllocationState", + "documentation":"

The Dedicated Host's state.

", + "locationName":"state" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the Dedicated Host.

", + "locationName":"availabilityZone" + }, + "Instances":{ + "shape":"HostInstanceList", + "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", + "locationName":"instances" + }, + "AvailableCapacity":{ + "shape":"AvailableCapacity", + "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + } + }, + "documentation":"

Describes the properties of the Dedicated Host.

" + }, + "HostInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

the IDs of instances that are running on the Dedicated Host.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes an instance running on a Dedicated Host.

" + }, + "HostInstanceList":{ + "type":"list", + "member":{ + "shape":"HostInstance", + "locationName":"item" + } + }, + "HostList":{ + "type":"list", + "member":{ + "shape":"Host", + "locationName":"item" + } + }, + "HostOffering":{ + "type":"structure", + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the offering.

", + "locationName":"offeringId" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the offering.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The available payment option.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", + "locationName":"upfrontPrice" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the offering.

", + "locationName":"hourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the offering.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering (in seconds).

", + "locationName":"duration" + } + }, + "documentation":"

Details about the Dedicated Host Reservation offering.

" + }, + "HostOfferingSet":{ + "type":"list", + "member":{"shape":"HostOffering"} + }, + "HostProperties":{ + "type":"structure", + "members":{ + "Sockets":{ + "shape":"Integer", + "documentation":"

The number of sockets on the Dedicated Host.

", + "locationName":"sockets" + }, + "Cores":{ + "shape":"Integer", + "documentation":"

The number of cores on the Dedicated Host.

", + "locationName":"cores" + }, + "TotalVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs on the Dedicated Host.

", + "locationName":"totalVCpus" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes properties of a Dedicated Host.

" + }, + "HostReservation":{ + "type":"structure", + "members":{ + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "locationName":"hostReservationId" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", + "locationName":"offeringId" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option selected for this reservation.

", + "locationName":"paymentOption" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation.

", + "locationName":"hourlyPrice" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", + "locationName":"count" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", + "locationName":"duration" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation ends.

", + "locationName":"end" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation started.

", + "locationName":"start" + }, + "State":{ + "shape":"ReservationState", + "documentation":"

The state of the reservation.

", + "locationName":"state" + } + }, + "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" + }, + "HostReservationIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "HostReservationSet":{ + "type":"list", + "member":{"shape":"HostReservation"} + }, + "HostTenancy":{ + "type":"string", + "enum":[ + "dedicated", + "host" + ] + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"type" + }, + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"code" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "IdFormat":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "locationName":"useLongIds" + }, + "Deadline":{ + "shape":"DateTime", + "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "locationName":"deadline" + } + }, + "documentation":"

Describes the ID format for a resource.

" + }, + "IdFormatList":{ + "type":"list", + "member":{ + "shape":"IdFormat", + "locationName":"item" + } + }, + "Image":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows AMIs; otherwise blank.

", + "locationName":"platform" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

One or more launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

One or more product codes.

", + "locationName":"productCodes" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the disk.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" + } + }, + "documentation":"

Describes the disk container object for an import image task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task.

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "documentation":"

Information about the disk containers.

", + "locationName":"DiskContainer" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

Valid values: AWS | BYOL

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform.

Valid values: xen

" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportImage.

" + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output for ImportImage.

" + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image task.

", + "locationName":"importTaskId" + }, + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64

", + "locationName":"architecture" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor for the import task.

Valid values: xen

", + "locationName":"hypervisor" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the import image task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the import image task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import image task.

", + "locationName":"status" + } + }, + "documentation":"

Describes an import image task.

" + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

One or more security group names.

", + "locationName":"GroupName" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"GroupId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "Monitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the launch specification for VM import.

" + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

The launch specification.

", + "locationName":"launchSpecification" + }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"

The disk image.

", + "locationName":"diskImage" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + }, + "documentation":"

Contains the parameters for ImportInstance.

" + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportInstance.

" + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "required":["Volumes"], + "members":{ + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "documentation":"

One or more volumes.

", + "locationName":"volumes" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import instance task.

" + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume", + "Status" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", + "locationName":"publicKeyMaterial" + } + }, + "documentation":"

Contains the parameters for ImportKeyPair.

" + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Contains the output of ImportKeyPair.

" + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description string for the import snapshot task.

" + }, + "DiskContainer":{ + "shape":"SnapshotDiskContainer", + "documentation":"

Information about the disk container.

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + }, + "documentation":"

Contains the parameters for ImportSnapshot.

" + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Information about the import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Contains the output for ImportSnapshot.

" + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Describes an import snapshot task.

", + "locationName":"snapshotTaskDetail" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + } + }, + "documentation":"

Describes an import snapshot task.

" + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting EBS volume.

", + "locationName":"availabilityZone" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

The disk image.

", + "locationName":"image" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the volume.

", + "locationName":"description" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

The volume size.

", + "locationName":"volume" + } + }, + "documentation":"

Contains the parameters for ImportVolume.

" + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + }, + "documentation":"

Contains the output for ImportVolume.

" + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "required":[ + "BytesConverted", + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"privateDnsName" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"dnsName" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance, if applicable.

", + "locationName":"productCodes" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched, if applicable.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance, if applicable.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance, if applicable.

", + "locationName":"ramdiskId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information for the instance.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address assigned to the instance, if applicable.

", + "locationName":"ipAddress" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The root device name (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot instance or a Scheduled Instance.

", + "locationName":"instanceLifecycle" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

If the request is a Spot instance request, the ID of the request.

", + "locationName":"spotInstanceRequestId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] One or more network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance, if applicable.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The user data.

", + "locationName":"userData" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The name of the root device (for example, /dev/sda1 or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for EBS I/O.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport", + "enaSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCapacity":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size supported by the Dedicated Host.

", + "locationName":"instanceType" + }, + "AvailableCapacity":{ + "shape":"Integer", + "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + }, + "TotalCapacity":{ + "shape":"Integer", + "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", + "locationName":"totalCapacity" + } + }, + "documentation":"

Information about the instance type that the Dedicated Host supports.

" + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance to export.

" + }, + "InstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":[ + "spot", + "scheduled" + ] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring information.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring information of the instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.

", + "locationName":"deviceIndex" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"privateIpAddress" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes a private IP address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The low byte represents the state. The high byte is an opaque internal value and should be ignored.

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of the instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Any scheduled events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + }, + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"EventCode", + "documentation":"

The event code.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + } + }, + "documentation":"

Describes a scheduled event for an instance.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + }, + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "t2.nano", + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "m4.16xlarge", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "x1.16xlarge", + "x1.32xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "g2.8xlarge", + "cg1.4xlarge", + "p2.xlarge", + "p2.8xlarge", + "p2.16xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "Integer":{"type":"integer"}, + "InternetGateway":{ + "type":"structure", + "members":{ + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the Internet gateway.

", + "locationName":"internetGatewayId" + }, + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the Internet gateway.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an Internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes the attachment of a VPC to an Internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

[EC2-VPC only] When you authorize or revoke security group rules, you can use -1 to specify all.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

One or more security group and AWS account ID pairs.

", + "locationName":"groups" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

One or more IP ranges.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdList", + "documentation":"

(Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.

", + "locationName":"prefixListIds" + } + }, + "documentation":"

Describes a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR range. You can either specify a CIDR range or a source security group, not both.

", + "locationName":"cidrIp" + } + }, + "documentation":"

Describes an IP range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "IpRanges":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"String", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "LaunchPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "LaunchSpecsList":{ + "type":"list", + "member":{ + "shape":"SpotFleetLaunchSpecification", + "locationName":"item" + }, + "min":1 + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "ModifyHostsRequest":{ + "type":"structure", + "required":[ + "HostIds", + "AutoPlacement" + ], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The host IDs of the Dedicated Hosts you want to modify.

", + "locationName":"hostId" + }, + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Specify whether to enable or disable auto-placement.

", + "locationName":"autoPlacement" + } + }, + "documentation":"

Contains the parameters for ModifyHosts.

" + }, + "ModifyHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ModifyHosts.

" + }, + "ModifyIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" + } + }, + "documentation":"

Contains the parameters of ModifyIdFormat.

" + }, + "ModifyIdentityIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds", + "PrincipalArn" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: instance | reservation | snapshot | volume

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", + "locationName":"useLongIds" + }, + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", + "locationName":"principalArn" + } + }, + "documentation":"

Contains the parameters of ModifyIdentityIdFormat.

" + }, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify.

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

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

One or more user groups. This is only valid when modifying the launchPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This is only valid when modifying the description attribute.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A launch permission modification.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

" + } + }, + "documentation":"

Contains the parameters for ModifyImageAttribute.

" + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", + "locationName":"value" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this paramater for Spot Instances.

", + "locationName":"disableApiTermination" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Contains the parameters for ModifyInstanceAttribute.

" + }, + "ModifyInstancePlacementRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that you are modifying.

", + "locationName":"instanceId" + }, + "Tenancy":{ + "shape":"HostTenancy", + "documentation":"

The tenancy of the instance that you are modifying.

", + "locationName":"tenancy" + }, + "Affinity":{ + "shape":"Affinity", + "documentation":"

The new affinity setting for the instance.

", + "locationName":"affinity" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host that the instance will have affinity with.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ModifyInstancePlacement.

" + }, + "ModifyInstancePlacementResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyInstancePlacement.

" + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + }, + "documentation":"

Contains the parameters for ModifyReservedInstances.

" + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + }, + "documentation":"

Contains the output of ModifyReservedInstances.

" + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

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

The type of operation to perform to the attribute.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + } + }, + "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" + }, + "ModifySpotFleetRequestRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The size of the fleet.

", + "locationName":"targetCapacity" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + } + }, + "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" + }, + "ModifySpotFleetRequestResponse":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifySpotFleetRequest.

" + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

" + } + }, + "documentation":"

Contains the parameters for ModifySubnetAttribute.

" + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + } + }, + "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + } + }, + "documentation":"

Contains the parameters for ModifyVpcAttribute.

" + }, + "ModifyVpcEndpointRequest":{ + "type":"structure", + "required":["VpcEndpointId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the endpoint.

" + }, + "ResetPolicy":{ + "shape":"Boolean", + "documentation":"

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy document to attach to the endpoint. The policy must be in valid JSON format.

" + }, + "AddRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables IDs to associate with the endpoint.

", + "locationName":"AddRouteTableId" + }, + "RemoveRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs to disassociate from the endpoint.

", + "locationName":"RemoveRouteTableId" + } + }, + "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" + }, + "ModifyVpcEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifyVpcEndpoint.

" + }, + "ModifyVpcPeeringConnectionOptionsRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

" + }, + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the requester VPC.

" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the accepter VPC.

" + } + } + }, + "ModifyVpcPeeringConnectionOptionsResult":{ + "type":"structure", + "members":{ + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the requester VPC.

", + "locationName":"requesterPeeringConnectionOptions" + }, + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", + "locationName":"accepterPeeringConnectionOptions" + } + } + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for MonitorInstances.

" + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of MonitorInstances.

" + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "MoveAddressToVpcRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for MoveAddressToVpc.

" + }, + "MoveAddressToVpcResult":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID for the Elastic IP address.

", + "locationName":"allocationId" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the move of the IP address.

", + "locationName":"status" + } + }, + "documentation":"

Contains the output of MoveAddressToVpc.

" + }, + "MoveStatus":{ + "type":"string", + "enum":[ + "movingToVpc", + "restoringToClassic" + ] + }, + "MovingAddressStatus":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "MoveStatus":{ + "shape":"MoveStatus", + "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", + "locationName":"moveStatus" + } + }, + "documentation":"

Describes the status of a moving Elastic IP address.

" + }, + "MovingAddressStatusSet":{ + "type":"list", + "member":{ + "shape":"MovingAddressStatus", + "locationName":"item" + } + }, + "NatGateway":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the NAT gateway is located.

", + "locationName":"vpcId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the NAT gateway is located.

", + "locationName":"subnetId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was created.

", + "locationName":"createTime" + }, + "DeleteTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", + "locationName":"deleteTime" + }, + "NatGatewayAddresses":{ + "shape":"NatGatewayAddressList", + "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", + "locationName":"natGatewayAddressSet" + }, + "State":{ + "shape":"NatGatewayState", + "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", + "locationName":"state" + }, + "FailureCode":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", + "locationName":"failureCode" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", + "locationName":"failureMessage" + }, + "ProvisionedBandwidth":{ + "shape":"ProvisionedBandwidth", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionedBandwidth" + } + }, + "documentation":"

Describes a NAT gateway.

" + }, + "NatGatewayAddress":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address associated with the NAT gateway.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "locationName":"allocationId" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIp" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface associated with the NAT gateway.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" + }, + "NatGatewayAddressList":{ + "type":"list", + "member":{ + "shape":"NatGatewayAddress", + "locationName":"item" + } + }, + "NatGatewayList":{ + "type":"list", + "member":{ + "shape":"NatGateway", + "locationName":"item" + } + }, + "NatGatewayState":{ + "type":"string", + "enum":[ + "pending", + "failed", + "available", + "deleting", + "deleted" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol. A value of -1 means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP associated with the network interface.

", + "locationName":"association" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IP addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + }, + "InterfaceType":{ + "shape":"NetworkInterfaceType", + "documentation":"

The type of interface.

", + "locationName":"interfaceType" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + } + }, + "documentation":"

Describes association information for an Elastic IP address.

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address.

", + "locationName":"privateIpAddress" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IP address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address associated with the network interface.

", + "locationName":"association" + } + }, + "documentation":"

Describes the private IP address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "attaching", + "in-use", + "detaching" + ] + }, + "NetworkInterfaceType":{ + "type":"string", + "enum":[ + "interface", + "natGateway" + ] + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "OccurrenceDayRequestSet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"OccurenceDay" + } + }, + "OccurrenceDaySet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"item" + } + }, + "OfferingClassType":{ + "type":"string", + "enum":[ + "standard", + "convertible" + ] + }, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OperationType":{ + "type":"string", + "enum":[ + "add", + "remove" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PaymentOption":{ + "type":"string", + "enum":[ + "AllUpfront", + "PartialUpfront", + "NoUpfront" + ] + }, + "PeeringConnectionOptions":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "PeeringConnectionOptionsRequest":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" + } + }, + "documentation":"

The VPC peering connection options.

" + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in (for cluster compute instances).

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", + "locationName":"tenancy" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

", + "locationName":"hostId" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", + "locationName":"affinity" + } + }, + "documentation":"

Describes the placement for the instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementStrategy":{ + "type":"string", + "enum":["cluster"] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PrefixList":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix.

", + "locationName":"prefixListName" + }, + "Cidrs":{ + "shape":"ValueStringList", + "documentation":"

The IP address range of the AWS service.

", + "locationName":"cidrSet" + } + }, + "documentation":"

Describes prefixes for AWS services.

" + }, + "PrefixListId":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + } + }, + "documentation":"

The ID of the prefix.

" + }, + "PrefixListIdList":{ + "type":"list", + "member":{ + "shape":"PrefixListId", + "locationName":"item" + } + }, + "PrefixListIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "PrefixListSet":{ + "type":"list", + "member":{ + "shape":"PrefixList", + "locationName":"item" + } + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + }, + "Count":{ + "shape":"Integer", + "documentation":"

The number of reservations available for the price.

", + "locationName":"count" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrivateIpAddressConfigSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesPrivateIpAddressConfig", + "locationName":"PrivateIpAddressConfigSet" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "required":["PrivateIpAddress"], + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP addresses.

", + "locationName":"privateIpAddress" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

", + "locationName":"primary" + } + }, + "documentation":"

Describes a secondary private IP address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway (VGW).

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "ProvisionedBandwidth":{ + "type":"structure", + "members":{ + "Provisioned":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisioned" + }, + "Requested":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requested" + }, + "RequestTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requestTime" + }, + "ProvisionTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionTime" + }, + "Status":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"status" + } + }, + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "Purchase":{ + "type":"structure", + "members":{ + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"hostReservationId" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option for the reservation.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation per hour.

", + "locationName":"hourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation's term in seconds.

", + "locationName":"duration" + } + }, + "documentation":"

Describes the result of the purchase.

" + }, + "PurchaseHostReservationRequest":{ + "type":"structure", + "required":[ + "OfferingId", + "HostIdSet" + ], + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the offering.

" + }, + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The ID/s of the Dedicated Host/s that the reservation will be associated with.

" + }, + "LimitPrice":{ + "shape":"String", + "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request will fail. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "PurchaseHostReservationResult":{ + "type":"structure", + "members":{ + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

Describes the details of the purchase.

", + "locationName":"purchase" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The total amount that will be charged to your account when you purchase the reservation.

", + "locationName":"totalUpfrontPrice" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The total hourly price of the reservation calculated per hour.

", + "locationName":"totalHourlyPrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide

", + "locationName":"clientToken" + } + } + }, + "PurchaseRequest":{ + "type":"structure", + "required":[ + "PurchaseToken", + "InstanceCount" + ], + "members":{ + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

" + } + }, + "documentation":"

Describes a request to purchase Scheduled Instances.

" + }, + "PurchaseRequestSet":{ + "type":"list", + "member":{ + "shape":"PurchaseRequest", + "locationName":"PurchaseRequest" + }, + "min":1 + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesOfferingId", + "InstanceCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + } + }, + "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" + }, + "PurchaseScheduledInstancesRequest":{ + "type":"structure", + "required":["PurchaseRequests"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "PurchaseRequests":{ + "shape":"PurchaseRequestSet", + "documentation":"

One or more purchase requests.

", + "locationName":"PurchaseRequest" + } + }, + "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" + }, + "PurchaseScheduledInstancesResult":{ + "type":"structure", + "members":{ + "ScheduledInstanceSet":{ + "shape":"PurchasedScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of PurchaseScheduledInstances.

" + }, + "PurchaseSet":{ + "type":"list", + "member":{"shape":"Purchase"} + }, + "PurchasedScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for RebootInstances.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + }, + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

The name of the region.

", + "locationName":"regionName" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

The region service endpoint.

", + "locationName":"regionEndpoint" + } + }, + "documentation":"

Describes a region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The name of the root device (for example, /dev/sda1, or /dev/xvda).

", + "locationName":"rootDeviceName" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization.

Default: paravirtual

", + "locationName":"virtualizationType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"enaSupport" + } + }, + "documentation":"

Contains the parameters for RegisterImage.

" + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of RegisterImage.

" + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Contains the parameters for RejectVpcPeeringConnection.

" + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of RejectVpcPeeringConnection.

" + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + } + }, + "documentation":"

Contains the parameters for ReleaseAddress.

" + }, + "ReleaseHostsRequest":{ + "type":"structure", + "required":["HostIds"], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts you want to release.

", + "locationName":"hostId" + } + }, + "documentation":"

Contains the parameters for ReleaseHosts.

" + }, + "ReleaseHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of ReleaseHosts.

" + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceNetworkAclAssociation.

" + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "NetworkAclId", + "RuleNumber", + "Protocol", + "RuleAction", + "Egress", + "CidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The IP protocol. You can specify all or -1 to mean all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

", + "locationName":"Icmp" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.

", + "locationName":"portRange" + } + }, + "documentation":"

Contains the parameters for ReplaceNetworkAclEntry.

" + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of an Internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + } + }, + "documentation":"

Contains the parameters for ReplaceRoute.

" + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + }, + "documentation":"

Contains the parameters for ReplaceRouteTableAssociation.

" + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + }, + "documentation":"

Contains the output of ReplaceRouteTableAssociation.

" + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "Status", + "ReasonCodes" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instances.

", + "locationName":"instanceId" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

One or more reason codes that describes the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems which I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems which I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems which I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + } + }, + "documentation":"

Contains the parameters for ReportInstanceStatus.

" + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestHostIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestSpotFleetRequest":{ + "type":"structure", + "required":["SpotFleetRequestConfig"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration for the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "RequestSpotFleetResponse":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "required":["SpotPrice"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

Default: The request is effective indefinitely.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

Default: The request is effective indefinitely.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of bids.

When you specify an Availability Zone group in a Spot Instance request, all Spot instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to bids for Spot Instances of the same instance type. Any additional Spot instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot instance request (all instances are terminated, the bid is expired, or the bid falls below current market), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

Note that you can't specify an Availability Zone group or a launch group if you specify a duration.

", + "locationName":"blockDurationMinutes" + }, + "LaunchSpecification":{"shape":"RequestSpotLaunchSpecification"} + }, + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "locationName":"SecurityGroup" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.

", + "locationName":"blockDeviceMapping" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "locationName":"SecurityGroupId" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "Reservation":{ + "type":"structure", + "members":{ + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

[EC2-Classic only] One or more security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

One or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservationState":{ + "type":"string", + "enum":[ + "payment-pending", + "payment-failed", + "active", + "retired" + ] + }, + "ReservationValue":{ + "type":"structure", + "members":{ + "RemainingTotalValue":{ + "shape":"String", + "documentation":"

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", + "locationName":"remainingTotalValue" + }, + "RemainingUpfrontValue":{ + "shape":"String", + "documentation":"

The remaining upfront cost of the reservation.

", + "locationName":"remainingUpfrontValue" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly rate of the reservation.

", + "locationName":"hourlyPrice" + } + }, + "documentation":"

The cost associated with the Reserved Instance.

" + }, + "ReservedInstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstanceId" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceReservationValue":{ + "type":"structure", + "members":{ + "ReservedInstanceId":{ + "shape":"String", + "documentation":"

The ID of the Convertible Reserved Instance that you are exchanging.

", + "locationName":"reservedInstanceId" + }, + "ReservationValue":{ + "shape":"ReservationValue", + "documentation":"

The total value of the Convertible Reserved Instance that you are exchanging.

", + "locationName":"reservationValue" + } + }, + "documentation":"

The total value of the Convertible Reserved Instance.

" + }, + "ReservedInstanceReservationValueSet":{ + "type":"list", + "member":{ + "shape":"ReservedInstanceReservationValue", + "locationName":"item" + } + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reservations purchased.

", + "locationName":"instanceCount" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

The offering class of the Reserved Instance.

", + "locationName":"offeringClass" + }, + "Scope":{ + "shape":"scope", + "documentation":"

The scope of the Reserved Instance.

", + "locationName":"scope" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + }, + "Scope":{ + "shape":"scope", + "documentation":"

Whether the Reserved Instance is standard or convertible.

", + "locationName":"scope" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + }, + "documentation":"

Describes the modification request/s.

" + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.

", + "locationName":"reservedInstancesOfferingId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

", + "locationName":"offeringClass" + }, + "Scope":{ + "shape":"scope", + "documentation":"

Whether the Reserved Instance is applied to instances in a region or an Availability Zone.

", + "locationName":"scope" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "ImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + } + }, + "documentation":"

Contains the parameters for ResetImageAttribute.

" + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", + "locationName":"attribute" + } + }, + "documentation":"

Contains the parameters for ResetInstanceAttribute.

" + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" + } + }, + "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "customer-gateway", + "dhcp-options", + "image", + "instance", + "internet-gateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "snapshot", + "spot-instances-request", + "subnet", + "security-group", + "volume", + "vpc", + "vpn-connection", + "vpn-gateway" + ] + }, + "ResponseHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ResponseHostIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RestoreAddressToClassicRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the parameters for RestoreAddressToClassic.

" + }, + "RestoreAddressToClassicResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

The move status for the IP address.

", + "locationName":"status" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Contains the output of RestoreAddressToClassic.

" + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.

", + "locationName":"sourceSecurityGroupOwnerId" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

", + "locationName":"ipProtocol" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.

", + "locationName":"toPort" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.

", + "locationName":"cidrIp" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

", + "locationName":"ipPermissions" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupEgress.

" + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a security group in a nondefault VPC.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

" + } + }, + "documentation":"

Contains the parameters for RevokeSecurityGroupIngress.

" + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationPrefixListId":{ + "shape":"String", + "documentation":"

The prefix of the AWS service.

", + "locationName":"destinationPrefixListId" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", + "locationName":"origin" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "locationName":"subnetId" + }, + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled for the instance.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "ImageId", + "MinCount", + "MaxCount" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI, which you can get by calling DescribeImages.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

The monitoring for the instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. If you set this parameter to true and then later want to be able to terminate the instance, you must first change the value of the disableApiTermination attribute to false using ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.

Only one private IP address can be designated as primary. Therefore, you can't specify this parameter if PrivateIpAddresses.n.Primary is set to true and PrivateIpAddresses.n.PrivateIpAddress is set to an IP address.

You cannot specify this option if you're launching more than one instance in the request.

Default: We select an IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterface" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + } + }, + "documentation":"

Contains the parameters for RunInstances.

" + }, + "RunScheduledInstancesRequest":{ + "type":"structure", + "required":[ + "ScheduledInstanceId", + "LaunchSpecification" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

Default: 1

" + }, + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

" + }, + "LaunchSpecification":{ + "shape":"ScheduledInstancesLaunchSpecification", + "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" + } + }, + "documentation":"

Contains the parameters for RunScheduledInstances.

" + }, + "RunScheduledInstancesResult":{ + "type":"structure", + "members":{ + "InstanceIdSet":{ + "shape":"InstanceIdSet", + "documentation":"

The IDs of the newly launched instances.

", + "locationName":"instanceIdSet" + } + }, + "documentation":"

Contains the output of RunScheduledInstances.

" + }, + "S3Storage":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "ScheduledInstance":{ + "type":"structure", + "members":{ + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

", + "locationName":"scheduledInstanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "PreviousSlotEndTime":{ + "shape":"DateTime", + "documentation":"

The time that the previous schedule ended or will end.

", + "locationName":"previousSlotEndTime" + }, + "NextSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time for the next schedule to start.

", + "locationName":"nextSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

", + "locationName":"instanceCount" + }, + "TermStartDate":{ + "shape":"DateTime", + "documentation":"

The start date for the Scheduled Instance.

", + "locationName":"termStartDate" + }, + "TermEndDate":{ + "shape":"DateTime", + "documentation":"

The end date for the Scheduled Instance.

", + "locationName":"termEndDate" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The date when the Scheduled Instance was purchased.

", + "locationName":"createDate" + } + }, + "documentation":"

Describes a Scheduled Instance.

" + }, + "ScheduledInstanceAvailability":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token. This token expires in two hours.

", + "locationName":"purchaseToken" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "FirstSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time period for the first schedule to start.

", + "locationName":"firstSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of available instances.

", + "locationName":"availableInstanceCount" + }, + "MinTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The minimum term. The only possible value is 365 days.

", + "locationName":"minTermDurationInDays" + }, + "MaxTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The maximum term. The only possible value is 365 days.

", + "locationName":"maxTermDurationInDays" + } + }, + "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" + }, + "ScheduledInstanceAvailabilitySet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstanceAvailability", + "locationName":"item" + } + }, + "ScheduledInstanceIdRequestSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ScheduledInstanceId" + } + }, + "ScheduledInstanceRecurrence":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

", + "locationName":"frequency" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", + "locationName":"interval" + }, + "OccurrenceDaySet":{ + "shape":"OccurrenceDaySet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", + "locationName":"occurrenceDaySet" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "locationName":"occurrenceRelativeToEnd" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "locationName":"occurrenceUnit" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceRecurrenceRequest":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" + }, + "OccurrenceDays":{ + "shape":"OccurrenceDayRequestSet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", + "locationName":"OccurrenceDay" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "ScheduledInstancesBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name exposed to the instance (for example, /dev/sdh or xvdh).

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1.The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" + }, + "Ebs":{ + "shape":"ScheduledInstancesEbs", + "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" + } + }, + "documentation":"

Describes a block device mapping for a Scheduled Instance.

" + }, + "ScheduledInstancesBlockDeviceMappingSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesBlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "ScheduledInstancesEbs":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: standard

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + } + }, + "documentation":"

Describes an EBS volume for a Scheduled Instance.

" + }, + "ScheduledInstancesIamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN).

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + } + }, + "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" + }, + "ScheduledInstancesLaunchSpecification":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI).

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + }, + "SecurityGroupIds":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The base64-encoded MIME user data.

" + }, + "Placement":{ + "shape":"ScheduledInstancesPlacement", + "documentation":"

The placement information.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

" + }, + "BlockDeviceMappings":{ + "shape":"ScheduledInstancesBlockDeviceMappingSet", + "documentation":"

One or more block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "Monitoring":{ + "shape":"ScheduledInstancesMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

" + }, + "NetworkInterfaces":{ + "shape":"ScheduledInstancesNetworkInterfaceSet", + "documentation":"

One or more network interfaces.

", + "locationName":"NetworkInterface" + }, + "IamInstanceProfile":{ + "shape":"ScheduledInstancesIamInstanceProfile", + "documentation":"

The IAM instance profile.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" + } + }, + "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" + }, + "ScheduledInstancesMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

" + } + }, + "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterface":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address of the network interface within the subnet.

" + }, + "PrivateIpAddressConfigs":{ + "shape":"PrivateIpAddressConfigSet", + "documentation":"

The private IP addresses.

", + "locationName":"PrivateIpAddressConfig" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IP addresses.

" + }, + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IP address to instances launched in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" + }, + "Groups":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"Group" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" + } + }, + "documentation":"

Describes a network interface for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterfaceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesNetworkInterface", + "locationName":"NetworkInterface" + } + }, + "ScheduledInstancesPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

" + } + }, + "documentation":"

Describes the placement for a Scheduled Instance.

" + }, + "ScheduledInstancesPrivateIpAddressConfig":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IP address.

" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

" + } + }, + "documentation":"

Describes a private IP address for a Scheduled Instance.

" + }, + "ScheduledInstancesSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

One or more inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[EC2-VPC] One or more outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupReference":{ + "type":"structure", + "required":[ + "GroupId", + "ReferencingVpcId" + ], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of your security group.

", + "locationName":"groupId" + }, + "ReferencingVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with the referencing security group.

", + "locationName":"referencingVpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC with a security group that references your security group.

" + }, + "SecurityGroupReferences":{ + "type":"list", + "member":{ + "shape":"SecurityGroupReference", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "SlotDateTimeRangeRequest":{ + "type":"structure", + "required":[ + "EarliestTime", + "LatestTime" + ], + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + }, + "SlotStartTimeRangeRequest":{ + "type":"structure", + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", + "locationName":"snapshotId" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"statusMessage" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

Value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + }, + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

", + "locationName":"dataEncryptionKeyId" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + } + }, + "documentation":"

Describes the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + } + }, + "documentation":"

The disk container object for the import snapshot request.

" + }, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the import snapshot task.

", + "locationName":"progress" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the import snapshot task.

", + "locationName":"statusMessage" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import snapshot task.

", + "locationName":"status" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot instance data feed is located.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot instance data feed subscription.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + } + }, + "documentation":"

Describes the data feed for a Spot instance.

" + }, + "SpotFleetLaunchSpecification":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"userData" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information.

", + "locationName":"placement" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "Monitoring":{ + "shape":"SpotFleetMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

", + "locationName":"monitoring" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-a61dafcf, subnet-65ea5f08\".

", + "locationName":"subnetId" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "locationName":"weightedCapacity" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

", + "locationName":"spotPrice" + } + }, + "documentation":"

Describes the launch specification for one or more Spot instances.

" + }, + "SpotFleetMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables monitoring for the instance.

Default: false

", + "locationName":"enabled" + } + }, + "documentation":"

Describes whether monitoring is enabled.

" + }, + "SpotFleetRequestConfig":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "SpotFleetRequestState", + "SpotFleetRequestConfig", + "CreateTime" + ], + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot fleet request.

", + "locationName":"spotFleetRequestId" + }, + "SpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The state of the Spot fleet request.

", + "locationName":"spotFleetRequestState" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

Information about the configuration of the Spot fleet request.

", + "locationName":"spotFleetRequestConfig" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The creation date and time of the request.

", + "locationName":"createTime" + }, + "ActivityStatus":{ + "shape":"ActivityStatus", + "documentation":"

The progress of the Spot fleet request. If there is an error, the status is error. After all bids are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot instances are terminating.

", + "locationName":"activityStatus" + } + }, + "documentation":"

Describes a Spot fleet request.

" + }, + "SpotFleetRequestConfigData":{ + "type":"structure", + "required":[ + "SpotPrice", + "TargetCapacity", + "IamFleetRole", + "LaunchSpecifications" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The bid price per unit hour.

", + "locationName":"spotPrice" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

", + "locationName":"targetCapacity" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

", + "locationName":"validUntil" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "IamFleetRole":{ + "shape":"String", + "documentation":"

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

", + "locationName":"iamFleetRole" + }, + "LaunchSpecifications":{ + "shape":"LaunchSpecsList", + "documentation":"

Information about the launch specifications for the Spot fleet request.

", + "locationName":"launchSpecifications" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "AllocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

", + "locationName":"allocationStrategy" + }, + "FulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", + "locationName":"fulfilledCapacity" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of request. Indicates whether the fleet will only request the target capacity or also attempt to maintain it. When you request a certain target capacity, the fleet will only place the required bids. It will not attempt to replenish Spot instances if capacity is diminished, nor will it submit bids in alternative Spot pools if capacity is not available. When you want to maintain a certain target capacity, fleet will place the required bids to meet this target capacity. It will also automatically replenish any interrupted instances. Default: maintain.

", + "locationName":"type" + } + }, + "documentation":"

Describes the configuration of a Spot fleet request.

" + }, + "SpotFleetRequestConfigSet":{ + "type":"list", + "member":{ + "shape":"SpotFleetRequestConfig", + "locationName":"item" + } + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot instance request type.

", + "locationName":"type" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"state" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot instance request, if any.

", + "locationName":"fault" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot instance request.

", + "locationName":"status" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached.

", + "locationName":"validUntil" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot instance request.

", + "locationName":"instanceId" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"createTime" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot instance.

", + "locationName":"productDescription" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The duration for the Spot instance, in minutes.

", + "locationName":"blockDurationMinutes" + }, + "ActualBlockHourlyPrice":{ + "shape":"String", + "documentation":"

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

", + "locationName":"actualBlockHourlyPrice" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the bid is launched.

", + "locationName":"launchedAvailabilityZone" + } + }, + "documentation":"

Describes a Spot instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"code" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"updateTime" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a Spot instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group (for cluster instances).

", + "locationName":"groupName" + } + }, + "documentation":"

Describes Spot instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price (bid) that you are willing to pay for a Spot instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + } + }, + "documentation":"

Describes the maximum hourly price (bid) for any Spot instance launched to fulfill the request.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StaleIpPermission":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "locationName":"ipProtocol" + }, + "IpRanges":{ + "shape":"IpRanges", + "documentation":"

One or more IP ranges. Not applicable for stale security group rules.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdSet", + "documentation":"

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

", + "locationName":"prefixListIds" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairSet", + "documentation":"

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", + "locationName":"groups" + } + }, + "documentation":"

Describes a stale rule in a security group.

" + }, + "StaleIpPermissionSet":{ + "type":"list", + "member":{ + "shape":"StaleIpPermission", + "locationName":"item" + } + }, + "StaleSecurityGroup":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the security group.

", + "locationName":"description" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the security group.

", + "locationName":"vpcId" + }, + "StaleIpPermissions":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale inbound rules in the security group.

", + "locationName":"staleIpPermissions" + }, + "StaleIpPermissionsEgress":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale outbound rules in the security group.

", + "locationName":"staleIpPermissionsEgress" + } + }, + "documentation":"

Describes a stale security group (a security group that contains stale rules).

" + }, + "StaleSecurityGroupSet":{ + "type":"list", + "member":{ + "shape":"StaleSecurityGroup", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for StartInstances.

" + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more started instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StartInstances.

" + }, + "State":{ + "type":"string", + "enum":[ + "Pending", + "Available", + "Deleting", + "Deleted" + ] + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

  • Server.InternalError: An internal error occurred during instance launch, resulting in termination.

  • Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

  • Client.InternalError: A client error caused the instance to terminate on launch.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "Status":{ + "type":"string", + "enum":[ + "MoveInProgress", + "InVpc", + "InClassic" + ] + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data", + "initializing" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for StopInstances.

" + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more stopped instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of StopInstances.

" + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IP address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable", + "initializing" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource. For example, ami-1a2b3c4d.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TargetConfiguration":{ + "type":"structure", + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the Convertible Reserved Instance offering.

", + "locationName":"offeringId" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

", + "locationName":"instanceCount" + } + }, + "documentation":"

Information about the Convertible Reserved Instance offering.

" + }, + "TargetConfigurationRequest":{ + "type":"structure", + "required":["OfferingId"], + "members":{ + "OfferingId":{ + "shape":"String", + "documentation":"

The Convertible Reserved Instance offering ID. If this isn't included in the request, the response lists your current Convertible Reserved Instance/s and their value/s.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

" + } + }, + "documentation":"

Details about the target configuration.

" + }, + "TargetConfigurationRequestSet":{ + "type":"list", + "member":{ + "shape":"TargetConfigurationRequest", + "locationName":"TargetConfigurationRequest" + } + }, + "TargetReservationValue":{ + "type":"structure", + "members":{ + "TargetConfiguration":{ + "shape":"TargetConfiguration", + "documentation":"

The configuration of the Convertible Reserved Instances that make up the exchange.

", + "locationName":"targetConfiguration" + }, + "ReservationValue":{ + "shape":"ReservationValue", + "documentation":"

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.

", + "locationName":"reservationValue" + } + }, + "documentation":"

The total value of the new Convertible Reserved Instances.

" + }, + "TargetReservationValueSet":{ + "type":"list", + "member":{ + "shape":"TargetReservationValue", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated", + "host" + ] + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for TerminateInstances.

" + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about one or more terminated instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of TerminateInstances.

" + }, + "TrafficType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "ALL" + ] + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs.

", + "locationName":"InstanceId" + } + }, + "documentation":"

Contains the parameters for UnmonitorInstances.

" + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

Monitoring information for one or more instances.

", + "locationName":"instancesSet" + } + }, + "documentation":"

Contains the output of UnmonitorInstances.

" + }, + "UnsuccessfulItem":{ + "type":"structure", + "required":["Error"], + "members":{ + "Error":{ + "shape":"UnsuccessfulItemError", + "documentation":"

Information about the error.

", + "locationName":"error" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + } + }, + "documentation":"

Information about items that were not successfully processed in a batch call.

" + }, + "UnsuccessfulItemError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message accompanying the error code.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" + }, + "UnsuccessfulItemList":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UnsuccessfulItemSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"data" + } + }, + "documentation":"

Describes the user data for an instance.

" + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", + "locationName":"userId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", + "locationName":"vpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection, if applicable.

", + "locationName":"vpcPeeringConnectionId" + }, + "PeeringStatus":{ + "shape":"String", + "documentation":"

The status of a VPC peering connection, if applicable.

", + "locationName":"peeringStatus" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdGroupPairSet":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"

Information about the volume attachments.

", + "locationName":"attachmentSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"volumeType" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume will be encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an EBS volume.

" + }, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + }, + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2", + "sc1", + "st1" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the endpoint is associated.

", + "locationName":"vpcId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the AWS service to which the endpoint is associated.

", + "locationName":"serviceName" + }, + "State":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"state" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

The policy document associated with the endpoint.

", + "locationName":"policyDocument" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route tables associated with the endpoint.

", + "locationName":"routeTableIdSet" + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + } + }, + "documentation":"

Describes a VPC endpoint.

" + }, + "VpcEndpointSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"item" + } + }, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the requester VPC.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionOptionsDescription":{ + "type":"structure", + "members":{ + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + }, + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"VpcPeeringConnectionStateReasonCode", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionStateReasonCode":{ + "type":"string", + "enum":[ + "initiating-request", + "pending-acceptance", + "active", + "deleted", + "rejected", + "failed", + "expired", + "provisioning", + "deleting" + ] + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "PeeringOptions":{ + "shape":"VpcPeeringConnectionOptionsDescription", + "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", + "locationName":"peeringOptions" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", + "locationName":"availabilityZone" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "scope":{ + "type":"string", + "enum":[ + "Availability Zone", + "Region" + ] + } + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides resizable computing capacity in the Amazon Web Services (AWS) cloud. Using Amazon EC2 eliminates your need to invest in hardware up front, so you can develop and deploy applications faster.

" +} diff --git a/aws/dist/botocore/data/ec2/2016-09-15/waiters-2.json b/aws/dist/botocore/data/ec2/2016-09-15/waiters-2.json new file mode 100644 index 00000000..71051948 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-09-15/waiters-2.json @@ -0,0 +1,593 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Reservations[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageExists": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Images[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidAMIID.NotFound", + "state": "retry" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "KeyPairExists": { + "operation": "DescribeKeyPairs", + "delay": 5, + "maxAttempts": 6, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(KeyPairs[].KeyName) > `0`" + }, + { + "expected": "InvalidKeyPair.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NatGatewayAvailable": { + "operation": "DescribeNatGateways", + "delay": 15, + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "NatGateways[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "failed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleting" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleted" + }, + { + "state": "retry", + "matcher": "error", + "expected": "NatGatewayNotFound" + } + ] + }, + "NetworkInterfaceAvailable": { + "operation": "DescribeNetworkInterfaces", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "NetworkInterfaces[].Status" + }, + { + "expected": "InvalidNetworkInterfaceID.NotFound", + "matcher": "error", + "state": "failure" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolume.NotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpcExists": { + "operation": "DescribeVpcs", + "delay": 1, + "maxAttempts": 5, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcID.NotFound", + "state": "retry" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpcPeeringConnectionExists": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "retry" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-11-15/examples-1.json b/aws/dist/botocore/data/ec2/2016-11-15/examples-1.json new file mode 100644 index 00000000..f6a8719f --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-11-15/examples-1.json @@ -0,0 +1,3740 @@ +{ + "version": "1.0", + "examples": { + "AllocateAddress": [ + { + "input": { + "Domain": "vpc" + }, + "output": { + "AllocationId": "eipalloc-64d5890a", + "Domain": "vpc", + "PublicIp": "203.0.113.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in a VPC.", + "id": "ec2-allocate-address-1", + "title": "To allocate an Elastic IP address for EC2-VPC" + }, + { + "output": { + "Domain": "standard", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example allocates an Elastic IP address to use with an instance in EC2-Classic.", + "id": "ec2-allocate-address-2", + "title": "To allocate an Elastic IP address for EC2-Classic" + } + ], + "AssignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns the specified secondary private IP address to the specified network interface.", + "id": "ec2-assign-private-ip-addresses-1", + "title": "To assign a specific secondary private IP address to an interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "SecondaryPrivateIpAddressCount": 2 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses in the CIDR block range of the subnet the network interface is associated with.", + "id": "ec2-assign-private-ip-addresses-2", + "title": "To assign secondary private IP addresses that Amazon EC2 selects to an interface" + } + ], + "AssociateAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "InstanceId": "i-0b263919b6498b123" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified instance in a VPC.", + "id": "ec2-associate-address-1", + "title": "To associate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "AllocationId": "eipalloc-64d5890a", + "NetworkInterfaceId": "eni-1a2b3c4d" + }, + "output": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified Elastic IP address with the specified network interface.", + "id": "ec2-associate-address-2", + "title": "To associate an Elastic IP address with a network interface" + }, + { + "input": { + "InstanceId": "i-07ffe74c7330ebf53", + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates an Elastic IP address with an instance in EC2-Classic.", + "id": "ec2-associate-address-3", + "title": "To associate an Elastic IP address in EC2-Classic" + } + ], + "AssociateDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-1", + "title": "To associate a DHCP options set with a VPC" + }, + { + "input": { + "DhcpOptionsId": "default", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the default DHCP options set with the specified VPC.", + "id": "ec2-associate-dhcp-options-2", + "title": "To associate the default DHCP options set with a VPC" + } + ], + "AssociateRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640", + "SubnetId": "subnet-9d4a7b6" + }, + "output": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the specified subnet.", + "id": "ec2-associate-route-table-1", + "title": "To associate a route table with a subnet" + } + ], + "AttachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified Internet gateway to the specified VPC.", + "id": "ec2-attach-internet-gateway-1", + "title": "To attach an Internet gateway to a VPC" + } + ], + "AttachNetworkInterface": [ + { + "input": { + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "output": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches the specified network interface to the specified instance.", + "id": "ec2-attach-network-interface-1", + "title": "To attach a network interface to an instance" + } + ], + "AttachVolume": [ + { + "input": { + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2016-08-29T18:52:32.724Z", + "Device": "/dev/sdf", + "InstanceId": "i-01474ef662b89480", + "State": "attaching", + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example attaches a volume (``vol-1234567890abcdef0``) to an instance (``i-01474ef662b89480``) as ``/dev/sdf``.", + "id": "to-attach-a-volume-to-an-instance-1472499213109", + "title": "To attach a volume to an instance" + } + ], + "CancelSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": true + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_running", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request and terminates its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-1", + "title": "To cancel a Spot fleet request" + }, + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ], + "TerminateInstances": false + }, + "output": { + "SuccessfulFleetRequests": [ + { + "CurrentSpotFleetRequestState": "cancelled_terminating", + "PreviousSpotFleetRequestState": "active", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels the specified Spot fleet request without terminating its associated Spot Instances.", + "id": "ec2-cancel-spot-fleet-requests-2", + "title": "To cancel a Spot fleet request without terminating its Spot Instances" + } + ], + "CancelSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "CancelledSpotInstanceRequests": [ + { + "SpotInstanceRequestId": "sir-08b93456", + "State": "cancelled" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example cancels a Spot Instance request.", + "id": "ec2-cancel-spot-instance-requests-1", + "title": "To cancel Spot Instance requests" + } + ], + "ConfirmProductInstance": [ + { + "input": { + "InstanceId": "i-1234567890abcdef0", + "ProductCode": "774F4FF8" + }, + "output": { + "OwnerId": "123456789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example determines whether the specified product code is associated with the specified instance.", + "id": "to-confirm-the-product-instance-1472712108494", + "title": "To confirm the product instance" + } + ], + "CopySnapshot": [ + { + "input": { + "Description": "This is my copied snapshot.", + "DestinationRegion": "us-east-1", + "SourceRegion": "us-west-2", + "SourceSnapshotId": "snap-066877671789bd71b" + }, + "output": { + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a snapshot with the snapshot ID of ``snap-066877671789bd71b`` from the ``us-west-2`` region to the ``us-east-1`` region and adds a short description to identify the snapshot.", + "id": "to-copy-a-snapshot-1472502259774", + "title": "To copy a snapshot" + } + ], + "CreateCustomerGateway": [ + { + "input": { + "BgpAsn": 65534, + "PublicIp": "12.1.2.3", + "Type": "ipsec.1" + }, + "output": { + "CustomerGateway": { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a customer gateway with the specified IP address for its outside interface.", + "id": "ec2-create-customer-gateway-1", + "title": "To create a customer gateway" + } + ], + "CreateDhcpOptions": [ + { + "input": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + "10.2.5.1", + "10.2.5.2" + ] + } + ] + }, + "output": { + "DhcpOptions": { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DHCP options set.", + "id": "ec2-create-dhcp-options-1", + "title": "To create a DHCP options set" + } + ], + "CreateInternetGateway": [ + { + "output": { + "InternetGateway": { + "Attachments": [ + + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Internet gateway.", + "id": "ec2-create-internet-gateway-1", + "title": "To create an Internet gateway" + } + ], + "CreateKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a key pair named my-key-pair.", + "id": "ec2-create-key-pair-1", + "title": "To create a key pair" + } + ], + "CreateNatGateway": [ + { + "input": { + "AllocationId": "eipalloc-37fc1a52", + "SubnetId": "subnet-1a2b3c4d" + }, + "output": { + "NatGateway": { + "CreateTime": "2015-12-17T12:45:26.732Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-37fc1a52" + } + ], + "NatGatewayId": "nat-08d48af2a8e83edfd", + "State": "pending", + "SubnetId": "subnet-1a2b3c4d", + "VpcId": "vpc-1122aabb" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a NAT gateway in subnet subnet-1a2b3c4d and associates an Elastic IP address with the allocation ID eipalloc-37fc1a52 with the NAT gateway.", + "id": "ec2-create-nat-gateway-1", + "title": "To create a NAT gateway" + } + ], + "CreateNetworkAcl": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "NetworkAcl": { + "Associations": [ + + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network ACL for the specified VPC.", + "id": "ec2-create-network-acl-1", + "title": "To create a network ACL" + } + ], + "CreateNetworkAclEntry": [ + { + "input": { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "udp", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an entry for the specified network ACL. The rule allows ingress traffic from anywhere (0.0.0.0/0) on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-create-network-acl-entry-1", + "title": "To create a network ACL entry" + } + ], + "CreateNetworkInterface": [ + { + "input": { + "Description": "my network interface", + "Groups": [ + "sg-903004f8" + ], + "PrivateIpAddress": "10.0.2.17", + "SubnetId": "subnet-9d4a7b6c" + }, + "output": { + "NetworkInterface": { + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "default" + } + ], + "MacAddress": "02:1a:80:41:52:9c", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateIpAddress": "10.0.2.17", + "PrivateIpAddresses": [ + { + "Primary": true, + "PrivateIpAddress": "10.0.2.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "pending", + "SubnetId": "subnet-9d4a7b6c", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a network interface for the specified subnet.", + "id": "ec2-create-network-interface-1", + "title": "To create a network interface" + } + ], + "CreatePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster", + "Strategy": "cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a placement group with the specified name.", + "id": "to-create-a-placement-group-1472712245768", + "title": "To create a placement group" + } + ], + "CreateRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "GatewayId": "igw-c0a643a9", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route for the specified route table. The route matches all traffic (0.0.0.0/0) and routes it to the specified Internet gateway.", + "id": "ec2-create-route-1", + "title": "To create a route" + } + ], + "CreateRouteTable": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "output": { + "RouteTable": { + "Associations": [ + + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-22574640", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a route table for the specified VPC.", + "id": "ec2-create-route-table-1", + "title": "To create a route table" + } + ], + "CreateSnapshot": [ + { + "input": { + "Description": "This is my root volume snapshot.", + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "Description": "This is my root volume snapshot.", + "OwnerId": "012345678910", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:06:01.000Z", + "State": "pending", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a snapshot of the volume with a volume ID of ``vol-1234567890abcdef0`` and a short description to identify the snapshot.", + "id": "to-create-a-snapshot-1472502529790", + "title": "To create a snapshot" + } + ], + "CreateSpotDatafeedSubscription": [ + { + "input": { + "Bucket": "my-s3-bucket", + "Prefix": "spotdata" + }, + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot Instance data feed for your AWS account.", + "id": "ec2-create-spot-datafeed-subscription-1", + "title": "To create a Spot Instance datafeed" + } + ], + "CreateSubnet": [ + { + "input": { + "CidrBlock": "10.0.1.0/24", + "VpcId": "vpc-a01106c2" + }, + "output": { + "Subnet": { + "AvailabilityZone": "us-west-2c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "State": "pending", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a subnet in the specified VPC with the specified CIDR block. We recommend that you let us select an Availability Zone for you.", + "id": "ec2-create-subnet-1", + "title": "To create a subnet" + } + ], + "CreateTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "production" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the tag Stack=production to the specified image, or overwrites an existing tag for the AMI where the tag key is Stack.", + "id": "ec2-create-tags-1", + "title": "To add a tag to a resource" + } + ], + "CreateVolume": [ + { + "input": { + "AvailabilityZone": "us-east-1a", + "Size": 80, + "VolumeType": "gp2" + }, + "output": { + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Encrypted": false, + "Iops": 240, + "Size": 80, + "SnapshotId": "", + "State": "creating", + "VolumeId": "vol-6b60b7c7", + "VolumeType": "gp2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an 80 GiB General Purpose (SSD) volume in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-volume-1472496724296", + "title": "To create a new volume" + }, + { + "input": { + "AvailabilityZone": "us-east-1a", + "Iops": 1000, + "SnapshotId": "snap-066877671789bd71b", + "VolumeType": "io1" + }, + "output": { + "Attachments": [ + + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2016-08-29T18:52:32.724Z", + "Iops": 1000, + "Size": 500, + "SnapshotId": "snap-066877671789bd71b", + "State": "creating", + "Tags": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeType": "io1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a new Provisioned IOPS (SSD) volume with 1000 provisioned IOPS from a snapshot in the Availability Zone ``us-east-1a``.", + "id": "to-create-a-new-provisioned-iops-ssd-volume-from-a-snapshot-1472498975176", + "title": "To create a new Provisioned IOPS (SSD) volume from a snapshot" + } + ], + "CreateVpc": [ + { + "input": { + "CidrBlock": "10.0.0.0/16" + }, + "output": { + "Vpc": { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "State": "pending", + "VpcId": "vpc-a01106c2" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a VPC with the specified CIDR block.", + "id": "ec2-create-vpc-1", + "title": "To create a VPC" + } + ], + "DeleteCustomerGateway": [ + { + "input": { + "CustomerGatewayId": "cgw-0e11f167" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified customer gateway.", + "id": "ec2-delete-customer-gateway-1", + "title": "To delete a customer gateway" + } + ], + "DeleteDhcpOptions": [ + { + "input": { + "DhcpOptionsId": "dopt-d9070ebb" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DHCP options set.", + "id": "ec2-delete-dhcp-options-1", + "title": "To delete a DHCP options set" + } + ], + "DeleteInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified Internet gateway.", + "id": "ec2-delete-internet-gateway-1", + "title": "To delete an Internet gateway" + } + ], + "DeleteKeyPair": [ + { + "input": { + "KeyName": "my-key-pair" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified key pair.", + "id": "ec2-delete-key-pair-1", + "title": "To delete a key pair" + } + ], + "DeleteNatGateway": [ + { + "input": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "output": { + "NatGatewayId": "nat-04ae55e711cec5680" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified NAT gateway.", + "id": "ec2-delete-nat-gateway-1", + "title": "To delete a NAT gateway" + } + ], + "DeleteNetworkAcl": [ + { + "input": { + "NetworkAclId": "acl-5fb85d36" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network ACL.", + "id": "ec2-delete-network-acl-1", + "title": "To delete a network ACL" + } + ], + "DeleteNetworkAclEntry": [ + { + "input": { + "Egress": true, + "NetworkAclId": "acl-5fb85d36", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes ingress rule number 100 from the specified network ACL.", + "id": "ec2-delete-network-acl-entry-1", + "title": "To delete a network ACL entry" + } + ], + "DeleteNetworkInterface": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified network interface.", + "id": "ec2-delete-network-interface-1", + "title": "To delete a network interface" + } + ], + "DeletePlacementGroup": [ + { + "input": { + "GroupName": "my-cluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified placement group.\n", + "id": "to-delete-a-placement-group-1472712349959", + "title": "To delete a placement group" + } + ], + "DeleteRoute": [ + { + "input": { + "DestinationCidrBlock": "0.0.0.0/0", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route from the specified route table.", + "id": "ec2-delete-route-1", + "title": "To delete a route" + } + ], + "DeleteRouteTable": [ + { + "input": { + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified route table.", + "id": "ec2-delete-route-table-1", + "title": "To delete a route table" + } + ], + "DeleteSnapshot": [ + { + "input": { + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-delete-a-snapshot-1472503042567", + "title": "To delete a snapshot" + } + ], + "DeleteSpotDatafeedSubscription": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes a Spot data feed subscription for the account.", + "id": "ec2-delete-spot-datafeed-subscription-1", + "title": "To cancel a Spot Instance data feed subscription" + } + ], + "DeleteSubnet": [ + { + "input": { + "SubnetId": "subnet-9d4a7b6c" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified subnet.", + "id": "ec2-delete-subnet-1", + "title": "To delete a subnet" + } + ], + "DeleteTags": [ + { + "input": { + "Resources": [ + "ami-78a54011" + ], + "Tags": [ + { + "Key": "Stack", + "Value": "test" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the tag Stack=test from the specified image.", + "id": "ec2-delete-tags-1", + "title": "To delete a tag from a resource" + } + ], + "DeleteVolume": [ + { + "input": { + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an available volume with the volume ID of ``vol-049df61146c4d7901``. If the command succeeds, no output is returned.", + "id": "to-delete-a-volume-1472503111160", + "title": "To delete a volume" + } + ], + "DeleteVpc": [ + { + "input": { + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified VPC.", + "id": "ec2-delete-vpc-1", + "title": "To delete a VPC" + } + ], + "DescribeAccountAttributes": [ + { + "input": { + "AttributeNames": [ + "supported-platforms" + ] + }, + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the supported-platforms attribute for your AWS account.", + "id": "ec2-describe-account-attributes-1", + "title": "To describe a single attribute for your AWS account" + }, + { + "output": { + "AccountAttributes": [ + { + "AttributeName": "supported-platforms", + "AttributeValues": [ + { + "AttributeValue": "EC2" + }, + { + "AttributeValue": "VPC" + } + ] + }, + { + "AttributeName": "vpc-max-security-groups-per-interface", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "max-instances", + "AttributeValues": [ + { + "AttributeValue": "20" + } + ] + }, + { + "AttributeName": "vpc-max-elastic-ips", + "AttributeValues": [ + { + "AttributeValue": "5" + } + ] + }, + { + "AttributeName": "default-vpc", + "AttributeValues": [ + { + "AttributeValue": "none" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes for your AWS account.", + "id": "ec2-describe-account-attributes-2", + "title": "To describe all attributes for your AWS account" + } + ], + "DescribeAddresses": [ + { + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + }, + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses.", + "id": "ec2-describe-addresses-1", + "title": "To describe your Elastic IP addresses" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "vpc" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "AllocationId": "eipalloc-12345678", + "AssociationId": "eipassoc-12345678", + "Domain": "vpc", + "InstanceId": "i-1234567890abcdef0", + "NetworkInterfaceId": "eni-12345678", + "NetworkInterfaceOwnerId": "123456789012", + "PrivateIpAddress": "10.0.1.241", + "PublicIp": "203.0.113.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in a VPC.", + "id": "ec2-describe-addresses-2", + "title": "To describe your Elastic IP addresses for EC2-VPC" + }, + { + "input": { + "Filters": [ + { + "Name": "domain", + "Values": [ + "standard" + ] + } + ] + }, + "output": { + "Addresses": [ + { + "Domain": "standard", + "InstanceId": "i-1234567890abcdef0", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes your Elastic IP addresses for use with instances in EC2-Classic.", + "id": "ec2-describe-addresses-3", + "title": "To describe your Elastic IP addresses for EC2-Classic" + } + ], + "DescribeAvailabilityZones": [ + { + "output": { + "AvailabilityZones": [ + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1b" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1c" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1d" + }, + { + "Messages": [ + + ], + "RegionName": "us-east-1", + "State": "available", + "ZoneName": "us-east-1e" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Availability Zones that are available to you. The response includes Availability Zones only for the current region.", + "id": "ec2-describe-availability-zones-1", + "title": "To describe your Availability Zones" + } + ], + "DescribeCustomerGateways": [ + { + "input": { + "CustomerGatewayIds": [ + "cgw-0e11f167" + ] + }, + "output": { + "CustomerGateways": [ + { + "BgpAsn": "65534", + "CustomerGatewayId": "cgw-0e11f167", + "IpAddress": "12.1.2.3", + "State": "available", + "Type": "ipsec.1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified customer gateway.", + "id": "ec2-describe-customer-gateways-1", + "title": "To describe a customer gateway" + } + ], + "DescribeDhcpOptions": [ + { + "input": { + "DhcpOptionsIds": [ + "dopt-d9070ebb" + ] + }, + "output": { + "DhcpOptions": [ + { + "DhcpConfigurations": [ + { + "Key": "domain-name-servers", + "Values": [ + { + "Value": "10.2.5.2" + }, + { + "Value": "10.2.5.1" + } + ] + } + ], + "DhcpOptionsId": "dopt-d9070ebb" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified DHCP options set.", + "id": "ec2-describe-dhcp-options-1", + "title": "To describe a DHCP options set" + } + ], + "DescribeInstanceAttribute": [ + { + "input": { + "Attribute": "instanceType", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": { + "Value": "t1.micro" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the instance type of the specified instance.\n", + "id": "to-describe-the-instance-type-1472712432132", + "title": "To describe the instance type" + }, + { + "input": { + "Attribute": "disableApiTermination", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "DisableApiTermination": { + "Value": "false" + }, + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``disableApiTermination`` attribute of the specified instance.\n", + "id": "to-describe-the-disableapitermination-attribute-1472712533466", + "title": "To describe the disableApiTermination attribute" + }, + { + "input": { + "Attribute": "blockDeviceMapping", + "InstanceId": "i-1234567890abcdef0" + }, + "output": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "AttachTime": "2013-05-17T22:42:34.000Z", + "DeleteOnTermination": true, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + }, + { + "DeviceName": "/dev/sdf", + "Ebs": { + "AttachTime": "2013-09-10T23:07:00.000Z", + "DeleteOnTermination": false, + "Status": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + } + ], + "InstanceId": "i-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``blockDeviceMapping`` attribute of the specified instance.\n", + "id": "to-describe-the-block-device-mapping-for-an-instance-1472712645423", + "title": "To describe the block device mapping for an instance" + } + ], + "DescribeInternetGateways": [ + { + "input": { + "Filters": [ + { + "Name": "attachment.vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "InternetGateways": [ + { + "Attachments": [ + { + "State": "available", + "VpcId": "vpc-a01106c2" + } + ], + "InternetGatewayId": "igw-c0a643a9", + "Tags": [ + + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Internet gateway for the specified VPC.", + "id": "ec2-describe-internet-gateways-1", + "title": "To describe the Internet gateway for a VPC" + } + ], + "DescribeKeyPairs": [ + { + "input": { + "KeyNames": [ + "my-key-pair" + ] + }, + "output": { + "KeyPairs": [ + { + "KeyFingerprint": "1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f", + "KeyName": "my-key-pair" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example displays the fingerprint for the specified key.", + "id": "ec2-describe-key-pairs-1", + "title": "To display a key pair" + } + ], + "DescribeMovingAddresses": [ + { + "output": { + "MovingAddressStatuses": [ + { + "MoveStatus": "MovingToVpc", + "PublicIp": "198.51.100.0" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your moving Elastic IP addresses.", + "id": "ec2-describe-moving-addresses-1", + "title": "To describe your moving addresses" + } + ], + "DescribeNatGateways": [ + { + "input": { + "Filter": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-1a2b3c4d" + ] + } + ] + }, + "output": { + "NatGateways": [ + { + "CreateTime": "2015-12-01T12:26:55.983Z", + "NatGatewayAddresses": [ + { + "AllocationId": "eipalloc-89c620ec", + "NetworkInterfaceId": "eni-9dec76cd", + "PrivateIp": "10.0.0.149", + "PublicIp": "198.11.222.333" + } + ], + "NatGatewayId": "nat-05dba92075d71c408", + "State": "available", + "SubnetId": "subnet-847e4dc2", + "VpcId": "vpc-1a2b3c4d" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the NAT gateway for the specified VPC.", + "id": "ec2-describe-nat-gateways-1", + "title": "To describe a NAT gateway" + } + ], + "DescribeNetworkAcls": [ + { + "input": { + "NetworkAclIds": [ + "acl-5fb85d36" + ] + }, + "output": { + "NetworkAcls": [ + { + "Associations": [ + { + "NetworkAclAssociationId": "aclassoc-66ea5f0b", + "NetworkAclId": "acl-9aeb5ef7", + "SubnetId": "subnet-65ea5f08" + } + ], + "Entries": [ + { + "CidrBlock": "0.0.0.0/0", + "Egress": true, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + }, + { + "CidrBlock": "0.0.0.0/0", + "Egress": false, + "Protocol": "-1", + "RuleAction": "deny", + "RuleNumber": 32767 + } + ], + "IsDefault": false, + "NetworkAclId": "acl-5fb85d36", + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified network ACL.", + "id": "ec2-", + "title": "To describe a network ACL" + } + ], + "DescribeNetworkInterfaceAttribute": [ + { + "input": { + "Attribute": "attachment", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Attachment": { + "AttachTime": "2015-05-21T20:02:20.000Z", + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": true, + "DeviceIndex": 0, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attachment attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-1", + "title": "To describe the attachment attribute of a network interface" + }, + { + "input": { + "Attribute": "description", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the description attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-2", + "title": "To describe the description attribute of a network interface" + }, + { + "input": { + "Attribute": "groupSet", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "Groups": [ + { + "GroupId": "sg-903004f8", + "GroupName": "my-security-group" + } + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the groupSet attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-3", + "title": "To describe the groupSet attribute of a network interface" + }, + { + "input": { + "Attribute": "sourceDestCheck", + "NetworkInterfaceId": "eni-686ea200" + }, + "output": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": true + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-describe-network-interface-attribute-4", + "title": "To describe the sourceDestCheck attribute of a network interface" + } + ], + "DescribeNetworkInterfaces": [ + { + "input": { + "NetworkInterfaceIds": [ + "eni-e5aa89a3" + ] + }, + "output": { + "NetworkInterfaces": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Attachment": { + "AttachTime": "2013-11-30T23:36:42.000Z", + "AttachmentId": "eni-attach-66c4350a", + "DeleteOnTermination": false, + "DeviceIndex": 1, + "InstanceId": "i-1234567890abcdef0", + "InstanceOwnerId": "123456789012", + "Status": "attached" + }, + "AvailabilityZone": "us-east-1d", + "Description": "my network interface", + "Groups": [ + { + "GroupId": "sg-8637d3e3", + "GroupName": "default" + } + ], + "MacAddress": "02:2f:8f:b0:cf:75", + "NetworkInterfaceId": "eni-e5aa89a3", + "OwnerId": "123456789012", + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17", + "PrivateIpAddresses": [ + { + "Association": { + "AssociationId": "eipassoc-0fbb766a", + "IpOwnerId": "123456789012", + "PublicDnsName": "ec2-203-0-113-12.compute-1.amazonaws.com", + "PublicIp": "203.0.113.12" + }, + "Primary": true, + "PrivateDnsName": "ip-10-0-1-17.ec2.internal", + "PrivateIpAddress": "10.0.1.17" + } + ], + "RequesterManaged": false, + "SourceDestCheck": true, + "Status": "in-use", + "SubnetId": "subnet-b61f49f0", + "TagSet": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "ec2-describe-network-interfaces-1", + "title": "To describe a network interface" + } + ], + "DescribeRegions": [ + { + "output": { + "Regions": [ + { + "Endpoint": "ec2.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1" + }, + { + "Endpoint": "ec2.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1" + }, + { + "Endpoint": "ec2.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1" + }, + { + "Endpoint": "ec2.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2" + }, + { + "Endpoint": "ec2.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1" + }, + { + "Endpoint": "ec2.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2" + }, + { + "Endpoint": "ec2.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1" + }, + { + "Endpoint": "ec2.us-east-1.amazonaws.com", + "RegionName": "us-east-1" + }, + { + "Endpoint": "ec2.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1" + }, + { + "Endpoint": "ec2.us-west-1.amazonaws.com", + "RegionName": "us-west-1" + }, + { + "Endpoint": "ec2.us-west-2.amazonaws.com", + "RegionName": "us-west-2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all the regions that are available to you.", + "id": "ec2-describe-regions-1", + "title": "To describe your regions" + } + ], + "DescribeRouteTables": [ + { + "input": { + "RouteTableIds": [ + "rtb-1f382e7d" + ] + }, + "output": { + "RouteTables": [ + { + "Associations": [ + { + "Main": true, + "RouteTableAssociationId": "rtbassoc-d8ccddba", + "RouteTableId": "rtb-1f382e7d" + } + ], + "PropagatingVgws": [ + + ], + "RouteTableId": "rtb-1f382e7d", + "Routes": [ + { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "local", + "State": "active" + } + ], + "Tags": [ + + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified route table.", + "id": "ec2-describe-route-tables-1", + "title": "To describe a route table" + } + ], + "DescribeScheduledInstanceAvailability": [ + { + "input": { + "FirstSlotStartTimeRange": { + "EarliestTime": "2016-01-31T00:00:00Z", + "LatestTime": "2016-01-31T04:00:00Z" + }, + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDays": [ + 1 + ] + } + }, + "output": { + "ScheduledInstanceAvailabilitySet": [ + { + "AvailabilityZone": "us-west-2b", + "AvailableInstanceCount": 20, + "FirstSlotStartTime": "2016-01-31T00:00:00Z", + "HourlyPrice": "0.095", + "InstanceType": "c4.large", + "MaxTermDurationInDays": 366, + "MinTermDurationInDays": 366, + "NetworkPlatform": "EC2-VPC", + "Platform": "Linux/UNIX", + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi...", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false + }, + "SlotDurationInHours": 23, + "TotalScheduledInstanceHours": 1219 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a schedule that occurs every week on Sunday, starting on the specified date. Note that the output contains a single schedule as an example.", + "id": "ec2-describe-scheduled-instance-availability-1", + "title": "To describe an available schedule" + } + ], + "DescribeScheduledInstances": [ + { + "input": { + "ScheduledInstanceIds": [ + "sci-1234-1234-1234-1234-123456789012" + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Scheduled Instance.", + "id": "ec2-describe-scheduled-instances-1", + "title": "To describe your Scheduled Instances" + } + ], + "DescribeSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-066877671789bd71b" + }, + "output": { + "CreateVolumePermissions": [ + + ], + "SnapshotId": "snap-066877671789bd71b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``createVolumePermission`` attribute on a snapshot with the snapshot ID of ``snap-066877671789bd71b``.", + "id": "to-describe-snapshot-attributes-1472503199736", + "title": "To describe snapshot attributes" + } + ], + "DescribeSnapshots": [ + { + "input": { + "SnapshotIds": [ + "snap-1234567890abcdef0" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my snapshot.", + "OwnerId": "012345678910", + "Progress": "100%", + "SnapshotId": "snap-1234567890abcdef0", + "StartTime": "2014-02-28T21:28:32.000Z", + "State": "completed", + "VolumeId": "vol-049df61146c4d7901", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes a snapshot with the snapshot ID of ``snap-1234567890abcdef0``.", + "id": "to-describe-a-snapshot-1472503807850", + "title": "To describe a snapshot" + }, + { + "input": { + "Filters": [ + { + "Name": "status", + "Values": [ + "pending" + ] + } + ], + "OwnerIds": [ + "012345678910" + ] + }, + "output": { + "NextToken": "", + "Snapshots": [ + { + "Description": "This is my copied snapshot.", + "OwnerId": "012345678910", + "Progress": "87%", + "SnapshotId": "snap-066877671789bd71b", + "StartTime": "2014-02-28T21:37:27.000Z", + "State": "pending", + "VolumeId": "vol-1234567890abcdef0", + "VolumeSize": 8 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all snapshots owned by the ID 012345678910 that are in the ``pending`` status.", + "id": "to-describe-snapshots-using-filters-1472503929793", + "title": "To describe snapshots using filters" + } + ], + "DescribeSpotDatafeedSubscription": [ + { + "output": { + "SpotDatafeedSubscription": { + "Bucket": "my-s3-bucket", + "OwnerId": "123456789012", + "Prefix": "spotdata", + "State": "Active" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the Spot Instance datafeed subscription for your AWS account.", + "id": "ec2-describe-spot-datafeed-subscription-1", + "title": "To describe the datafeed for your AWS account" + } + ], + "DescribeSpotFleetInstances": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "output": { + "ActiveInstances": [ + { + "InstanceId": "i-1234567890abcdef0", + "InstanceType": "m3.medium", + "SpotInstanceRequestId": "sir-08b93456" + } + ], + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the Spot Instances associated with the specified Spot fleet.", + "id": "ec2-describe-spot-fleet-instances-1", + "title": "To describe the Spot Instances associated with a Spot fleet" + } + ], + "DescribeSpotFleetRequestHistory": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "output": { + "HistoryRecords": [ + { + "EventInformation": { + "EventSubType": "submitted" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.697Z" + }, + { + "EventInformation": { + "EventSubType": "active" + }, + "EventType": "fleetRequestChange", + "Timestamp": "2015-05-26T23:17:20.873Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef0" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.712Z" + }, + { + "EventInformation": { + "EventSubType": "launched", + "InstanceId": "i-1234567890abcdef1" + }, + "EventType": "instanceChange", + "Timestamp": "2015-05-26T23:21:21.816Z" + } + ], + "NextToken": "CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "StartTime": "2015-05-26T00:00:00Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the history for the specified Spot fleet starting at the specified time.", + "id": "ec2-describe-spot-fleet-request-history-1", + "title": "To describe Spot fleet history" + } + ], + "DescribeSpotFleetRequests": [ + { + "input": { + "SpotFleetRequestIds": [ + "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + ] + }, + "output": { + "SpotFleetRequestConfigs": [ + { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "cc2.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + }, + { + "EbsOptimized": false, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.8xlarge", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeleteOnTermination": false, + "DeviceIndex": 0, + "SecondaryPrivateIpAddressCount": 0, + "SubnetId": "subnet-a61dafcf" + } + ] + } + ], + "SpotPrice": "0.05", + "TargetCapacity": 20 + }, + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "SpotFleetRequestState": "active" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot fleet request.", + "id": "ec2-describe-spot-fleet-requests-1", + "title": "To describe a Spot fleet request" + } + ], + "DescribeSpotInstanceRequests": [ + { + "input": { + "SpotInstanceRequestIds": [ + "sir-08b93456" + ] + }, + "output": { + "SpotInstanceRequests": [ + { + "CreateTime": "2014-04-30T18:14:55.000Z", + "InstanceId": "i-1234567890abcdef0", + "LaunchSpecification": { + "BlockDeviceMappings": [ + { + "DeviceName": "/dev/sda1", + "Ebs": { + "DeleteOnTermination": true, + "VolumeSize": 8, + "VolumeType": "standard" + } + } + ], + "EbsOptimized": false, + "ImageId": "ami-7aba833f", + "InstanceType": "m1.small", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-e38f24a7", + "GroupName": "my-security-group" + } + ] + }, + "LaunchedAvailabilityZone": "us-west-1b", + "ProductDescription": "Linux/UNIX", + "SpotInstanceRequestId": "sir-08b93456", + "SpotPrice": "0.010000", + "State": "active", + "Status": { + "Code": "fulfilled", + "Message": "Your Spot request is fulfilled.", + "UpdateTime": "2014-04-30T18:16:21.000Z" + }, + "Type": "one-time" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified Spot Instance request.", + "id": "ec2-describe-spot-instance-requests-1", + "title": "To describe a Spot Instance request" + } + ], + "DescribeSpotPriceHistory": [ + { + "input": { + "EndTime": "2014-01-06T08:09:10", + "InstanceTypes": [ + "m1.xlarge" + ], + "ProductDescriptions": [ + "Linux/UNIX (Amazon VPC)" + ], + "StartTime": "2014-01-06T07:08:09" + }, + "output": { + "SpotPriceHistory": [ + { + "AvailabilityZone": "us-west-1a", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-06T04:32:53.000Z" + }, + { + "AvailabilityZone": "us-west-1c", + "InstanceType": "m1.xlarge", + "ProductDescription": "Linux/UNIX (Amazon VPC)", + "SpotPrice": "0.080000", + "Timestamp": "2014-01-05T11:28:26.000Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example returns the Spot Price history for m1.xlarge, Linux/UNIX (Amazon VPC) instances for a particular day in January.", + "id": "ec2-describe-spot-price-history-1", + "title": "To describe Spot price history for Linux/UNIX (Amazon VPC)" + } + ], + "DescribeSubnets": [ + { + "input": { + "Filters": [ + { + "Name": "vpc-id", + "Values": [ + "vpc-a01106c2" + ] + } + ] + }, + "output": { + "Subnets": [ + { + "AvailabilityZone": "us-east-1c", + "AvailableIpAddressCount": 251, + "CidrBlock": "10.0.1.0/24", + "DefaultForAz": false, + "MapPublicIpOnLaunch": false, + "State": "available", + "SubnetId": "subnet-9d4a7b6c", + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the subnets for the specified VPC.", + "id": "ec2-describe-subnets-1", + "title": "To describe the subnets for a VPC" + } + ], + "DescribeTags": [ + { + "input": { + "Filters": [ + { + "Name": "resource-id", + "Values": [ + "i-1234567890abcdef8" + ] + } + ] + }, + "output": { + "Tags": [ + { + "Key": "Stack", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "test" + }, + { + "Key": "Name", + "ResourceId": "i-1234567890abcdef8", + "ResourceType": "instance", + "Value": "Beta Server" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified instance.", + "id": "ec2-describe-tags-1", + "title": "To describe the tags for a single resource" + } + ], + "DescribeVolumeAttribute": [ + { + "input": { + "Attribute": "autoEnableIO", + "VolumeId": "vol-049df61146c4d7901" + }, + "output": { + "AutoEnableIO": { + "Value": false + }, + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the ``autoEnableIo`` attribute of the volume with the ID ``vol-049df61146c4d7901``.", + "id": "to-describe-a-volume-attribute-1472505773492", + "title": "To describe a volume attribute" + } + ], + "DescribeVolumeStatus": [ + { + "input": { + "VolumeIds": [ + "vol-1234567890abcdef0" + ] + }, + "output": { + "VolumeStatuses": [ + { + "Actions": [ + + ], + "AvailabilityZone": "us-east-1a", + "Events": [ + + ], + "VolumeId": "vol-1234567890abcdef0", + "VolumeStatus": { + "Details": [ + { + "Name": "io-enabled", + "Status": "passed" + }, + { + "Name": "io-performance", + "Status": "not-applicable" + } + ], + "Status": "ok" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for the volume ``vol-1234567890abcdef0``.", + "id": "to-describe-the-status-of-a-single-volume-1472507016193", + "title": "To describe the status of a single volume" + }, + { + "input": { + "Filters": [ + { + "Name": "volume-status.status", + "Values": [ + "impaired" + ] + } + ] + }, + "output": { + "VolumeStatuses": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the status for all volumes that are impaired. In this example output, there are no impaired volumes.", + "id": "to-describe-the-status-of-impaired-volumes-1472507239821", + "title": "To describe the status of impaired volumes" + } + ], + "DescribeVolumes": [ + { + "input": { + }, + "output": { + "NextToken": "", + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all of your volumes in the default region.", + "id": "to-describe-all-volumes-1472506358883", + "title": "To describe all volumes" + }, + { + "input": { + "Filters": [ + { + "Name": "attachment.instance-id", + "Values": [ + "i-1234567890abcdef0" + ] + }, + { + "Name": "attachment.delete-on-termination", + "Values": [ + "true" + ] + } + ] + }, + "output": { + "Volumes": [ + { + "Attachments": [ + { + "AttachTime": "2013-12-18T22:35:00.000Z", + "DeleteOnTermination": true, + "Device": "/dev/sda1", + "InstanceId": "i-1234567890abcdef0", + "State": "attached", + "VolumeId": "vol-049df61146c4d7901" + } + ], + "AvailabilityZone": "us-east-1a", + "CreateTime": "2013-12-18T22:35:00.084Z", + "Size": 8, + "SnapshotId": "snap-1234567890abcdef0", + "State": "in-use", + "VolumeId": "vol-049df61146c4d7901", + "VolumeType": "standard" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes all volumes that are both attached to the instance with the ID i-1234567890abcdef0 and set to delete when the instance terminates.", + "id": "to-describe-volumes-that-are-attached-to-a-specific-instance-1472506613578", + "title": "To describe volumes that are attached to a specific instance" + } + ], + "DescribeVpcAttribute": [ + { + "input": { + "Attribute": "enableDnsSupport", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsSupport": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-describe-vpc-attribute-1", + "title": "To describe the enableDnsSupport attribute" + }, + { + "input": { + "Attribute": "enableDnsHostnames", + "VpcId": "vpc-a01106c2" + }, + "output": { + "EnableDnsHostnames": { + "Value": true + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the enableDnsHostnames attribute. This attribute indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-describe-vpc-attribute-2", + "title": "To describe the enableDnsHostnames attribute" + } + ], + "DescribeVpcs": [ + { + "input": { + "VpcIds": [ + "vpc-a01106c2" + ] + }, + "output": { + "Vpcs": [ + { + "CidrBlock": "10.0.0.0/16", + "DhcpOptionsId": "dopt-7a8b9c2d", + "InstanceTenancy": "default", + "IsDefault": false, + "State": "available", + "Tags": [ + { + "Key": "Name", + "Value": "MyVPC" + } + ], + "VpcId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified VPC.", + "id": "ec2-describe-vpcs-1", + "title": "To describe a VPC" + } + ], + "DetachInternetGateway": [ + { + "input": { + "InternetGatewayId": "igw-c0a643a9", + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified Internet gateway from the specified VPC.", + "id": "ec2-detach-internet-gateway-1", + "title": "To detach an Internet gateway from a VPC" + } + ], + "DetachNetworkInterface": [ + { + "input": { + "AttachmentId": "eni-attach-66c4350a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified network interface from its attached instance.", + "id": "ec2-detach-network-interface-1", + "title": "To detach a network interface from an instance" + } + ], + "DetachVolume": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + "AttachTime": "2014-02-27T19:23:06.000Z", + "Device": "/dev/sdb", + "InstanceId": "i-1234567890abcdef0", + "State": "detaching", + "VolumeId": "vol-049df61146c4d7901" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the volume (``vol-049df61146c4d7901``) from the instance it is attached to.", + "id": "to-detach-a-volume-from-an-instance-1472507977694", + "title": "To detach a volume from an instance" + } + ], + "DisableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disables the specified virtual private gateway from propagating static routes to the specified route table.", + "id": "ec2-disable-vgw-route-propagation-1", + "title": "To disable route propagation" + } + ], + "DisassociateAddress": [ + { + "input": { + "AssociationId": "eipassoc-2bebb745" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in a VPC.", + "id": "ec2-disassociate-address-1", + "title": "To disassociate an Elastic IP address in EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates an Elastic IP address from an instance in EC2-Classic.", + "id": "ec2-disassociate-address-2", + "title": "To disassociate an Elastic IP addresses in EC2-Classic" + } + ], + "DisassociateRouteTable": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example disassociates the specified route table from its associated subnet.", + "id": "ec2-disassociate-route-table-1", + "title": "To disassociate a route table" + } + ], + "EnableVgwRoutePropagation": [ + { + "input": { + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables the specified virtual private gateway to propagate static routes to the specified route table.", + "id": "ec2-enable-vgw-route-propagation-1", + "title": "To enable route propagation" + } + ], + "EnableVolumeIO": [ + { + "input": { + "VolumeId": "vol-1234567890abcdef0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables I/O on volume ``vol-1234567890abcdef0``.", + "id": "to-enable-io-for-a-volume-1472508114867", + "title": "To enable I/O for a volume" + } + ], + "ModifyNetworkInterfaceAttribute": [ + { + "input": { + "Attachment": { + "AttachmentId": "eni-attach-43348162", + "DeleteOnTermination": false + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the attachment attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-1", + "title": "To modify the attachment attribute of a network interface" + }, + { + "input": { + "Description": { + "Value": "My description" + }, + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the description attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-2", + "title": "To modify the description attribute of a network interface" + }, + { + "input": { + "Groups": [ + "sg-903004f8", + "sg-1a2b3c4d" + ], + "NetworkInterfaceId": "eni-686ea200" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the groupSet attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-3", + "title": "To modify the groupSet attribute of a network interface" + }, + { + "input": { + "NetworkInterfaceId": "eni-686ea200", + "SourceDestCheck": { + "Value": false + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command modifies the sourceDestCheck attribute of the specified network interface.", + "id": "ec2-modify-network-interface-attribute-4", + "title": "To modify the sourceDestCheck attribute of a network interface" + } + ], + "ModifySnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "OperationType": "remove", + "SnapshotId": "snap-1234567890abcdef0", + "UserIds": [ + "123456789012" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies snapshot ``snap-1234567890abcdef0`` to remove the create volume permission for a user with the account ID ``123456789012``. If the command succeeds, no output is returned.", + "id": "to-modify-a-snapshot-attribute-1472508385907", + "title": "To modify a snapshot attribute" + }, + { + "input": { + "Attribute": "createVolumePermission", + "GroupNames": [ + "all" + ], + "OperationType": "add", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example makes the snapshot ``snap-1234567890abcdef0`` public.", + "id": "to-make-a-snapshot-public-1472508470529", + "title": "To make a snapshot public" + } + ], + "ModifySpotFleetRequest": [ + { + "input": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 20 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example increases the target capacity of the specified Spot fleet request.", + "id": "ec2-modify-spot-fleet-request-1", + "title": "To increase the target capacity of a Spot fleet request" + }, + { + "input": { + "ExcessCapacityTerminationPolicy": "NoTermination ", + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE", + "TargetCapacity": 10 + }, + "output": { + "Return": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example decreases the target capacity of the specified Spot fleet request without terminating any Spot Instances as a result.", + "id": "ec2-modify-spot-fleet-request-2", + "title": "To decrease the target capacity of a Spot fleet request" + } + ], + "ModifySubnetAttribute": [ + { + "input": { + "MapPublicIpOnLaunch": { + "Value": true + }, + "SubnetId": "subnet-1a2b3c4d" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the specified subnet so that all instances launched into this subnet are assigned a public IP address.", + "id": "ec2-modify-subnet-attribute-1", + "title": "To change a subnet's public IP addressing behavior" + } + ], + "ModifyVolumeAttribute": [ + { + "input": { + "AutoEnableIO": { + "Value": true + }, + "DryRun": true, + "VolumeId": "vol-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the ``autoEnableIo`` attribute of the volume with the ID ``vol-1234567890abcdef0`` to ``true``. If the command succeeds, no output is returned.", + "id": "to-modify-a-volume-attribute-1472508596749", + "title": "To modify a volume attribute" + } + ], + "ModifyVpcAttribute": [ + { + "input": { + "EnableDnsSupport": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsSupport attribute. This attribute indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for instances in the VPC to their corresponding IP addresses; otherwise, it does not.", + "id": "ec2-modify-vpc-attribute-1", + "title": "To modify the enableDnsSupport attribute" + }, + { + "input": { + "EnableDnsHostnames": { + "Value": false + }, + "VpcId": "vpc-a01106c2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the enableDnsHostnames attribute. This attribute indicates whether instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.", + "id": "ec2-modify-vpc-attribute-2", + "title": "To modify the enableDnsHostnames attribute" + } + ], + "MoveAddressToVpc": [ + { + "input": { + "PublicIp": "54.123.4.56" + }, + "output": { + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example moves the specified Elastic IP address to the EC2-VPC platform.", + "id": "ec2-move-address-to-vpc-1", + "title": "To move an address to EC2-VPC" + } + ], + "PurchaseScheduledInstances": [ + { + "input": { + "PurchaseRequests": [ + { + "InstanceCount": 1, + "PurchaseToken": "eyJ2IjoiMSIsInMiOjEsImMiOi..." + } + ] + }, + "output": { + "ScheduledInstanceSet": [ + { + "AvailabilityZone": "us-west-2b", + "CreateDate": "2016-01-25T21:43:38.612Z", + "HourlyPrice": "0.095", + "InstanceCount": 1, + "InstanceType": "c4.large", + "NetworkPlatform": "EC2-VPC", + "NextSlotStartTime": "2016-01-31T09:00:00Z", + "Platform": "Linux/UNIX", + "Recurrence": { + "Frequency": "Weekly", + "Interval": 1, + "OccurrenceDaySet": [ + 1 + ], + "OccurrenceRelativeToEnd": false, + "OccurrenceUnit": "" + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012", + "SlotDurationInHours": 32, + "TermEndDate": "2017-01-31T09:00:00Z", + "TermStartDate": "2016-01-31T09:00:00Z", + "TotalScheduledInstanceHours": 1696 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example purchases a Scheduled Instance.", + "id": "ec2-purchase-scheduled-instances-1", + "title": "To purchase a Scheduled Instance" + } + ], + "ReleaseAddress": [ + { + "input": { + "AllocationId": "eipalloc-64d5890a" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in a VPC.", + "id": "ec2-release-address-1", + "title": "To release an Elastic IP address for EC2-VPC" + }, + { + "input": { + "PublicIp": "198.51.100.0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example releases an Elastic IP address for use with instances in EC2-Classic.", + "id": "ec2-release-address-2", + "title": "To release an Elastic IP addresses for EC2-Classic" + } + ], + "ReplaceNetworkAclAssociation": [ + { + "input": { + "AssociationId": "aclassoc-e5b95c8c", + "NetworkAclId": "acl-5fb85d36" + }, + "output": { + "NewAssociationId": "aclassoc-3999875b" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified network ACL with the subnet for the specified network ACL association.", + "id": "ec2-replace-network-acl-association-1", + "title": "To replace the network ACL associated with a subnet" + } + ], + "ReplaceNetworkAclEntry": [ + { + "input": { + "CidrBlock": "203.0.113.12/24", + "Egress": false, + "NetworkAclId": "acl-5fb85d36", + "PortRange": { + "From": 53, + "To": 53 + }, + "Protocol": "udp", + "RuleAction": "allow", + "RuleNumber": 100 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces an entry for the specified network ACL. The new rule 100 allows ingress traffic from 203.0.113.12/24 on UDP port 53 (DNS) into any associated subnet.", + "id": "ec2-replace-network-acl-entry-1", + "title": "To replace a network ACL entry" + } + ], + "ReplaceRoute": [ + { + "input": { + "DestinationCidrBlock": "10.0.0.0/16", + "GatewayId": "vgw-9a4cacf3", + "RouteTableId": "rtb-22574640" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the specified route in the specified table table. The new route matches the specified CIDR and sends the traffic to the specified virtual private gateway.", + "id": "ec2-replace-route-1", + "title": "To replace a route" + } + ], + "ReplaceRouteTableAssociation": [ + { + "input": { + "AssociationId": "rtbassoc-781d0d1a", + "RouteTableId": "rtb-22574640" + }, + "output": { + "NewAssociationId": "rtbassoc-3a1f0f58" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified route table with the subnet for the specified route table association.", + "id": "ec2-replace-route-table-association-1", + "title": "To replace the route table associated with a subnet" + } + ], + "RequestSpotFleet": [ + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ], + "SubnetId": "subnet-1a2b3c4d, subnet-3c4d5e6f" + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by subnet. The Spot fleet launches the instances in the specified subnet with the lowest price. If the instances are launched in a default VPC, they receive a public IP address by default. If the instances are launched in a nondefault VPC, they do not receive a public IP address by default. Note that you can't specify different subnets from the same Availability Zone in a Spot fleet request.", + "id": "ec2-request-spot-fleet-1", + "title": "To request a Spot fleet in the subnet with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a, us-west-2b" + }, + "SecurityGroups": [ + { + "GroupId": "sg-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request with two launch specifications that differ only by Availability Zone. The Spot fleet launches the instances in the specified Availability Zone with the lowest price. If your account supports EC2-VPC only, Amazon EC2 launches the Spot instances in the default subnet of the Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the Availability Zone.", + "id": "ec2-request-spot-fleet-2", + "title": "To request a Spot fleet in the Availability Zone with the lowest price" + }, + { + "input": { + "SpotFleetRequestConfig": { + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::880185128111:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + } + ] + } + ], + "SpotPrice": "0.04", + "TargetCapacity": 2 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example assigns public addresses to instances launched in a nondefault VPC. Note that when you specify a network interface, you must include the subnet ID and security group ID using the network interface.", + "id": "ec2-request-spot-fleet-3", + "title": "To launch Spot instances in a subnet and assign them public IP addresses" + }, + { + "input": { + "SpotFleetRequestConfig": { + "AllocationStrategy": "diversified", + "IamFleetRole": "arn:aws:iam::123456789012:role/my-spot-fleet-role", + "LaunchSpecifications": [ + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "c4.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + }, + { + "ImageId": "ami-1a2b3c4d", + "InstanceType": "r3.2xlarge", + "SubnetId": "subnet-1a2b3c4d" + } + ], + "SpotPrice": "0.70", + "TargetCapacity": 30 + } + }, + "output": { + "SpotFleetRequestId": "sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a Spot fleet request that launches 30 instances using the diversified allocation strategy. The launch specifications differ by instance type. The Spot fleet distributes the instances across the launch specifications such that there are 10 instances of each type.", + "id": "ec2-request-spot-fleet-4", + "title": "To request a Spot fleet using the diversified allocation strategy" + } + ], + "RequestSpotInstances": [ + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2a" + }, + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ] + }, + "SpotPrice": "0.03", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a one-time Spot Instance request for five instances in the specified Availability Zone. If your account supports EC2-VPC only, Amazon EC2 launches the instances in the default subnet of the specified Availability Zone. If your account supports EC2-Classic, Amazon EC2 launches the instances in EC2-Classic in the specified Availability Zone.", + "id": "ec2-request-spot-instances-1", + "title": "To create a one-time Spot Instance request" + }, + { + "input": { + "InstanceCount": 5, + "LaunchSpecification": { + "IamInstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/my-iam-role" + }, + "ImageId": "ami-1a2b3c4d", + "InstanceType": "m3.medium", + "SecurityGroupIds": [ + "sg-1a2b3c4d" + ], + "SubnetId": "subnet-1a2b3c4d" + }, + "SpotPrice": "0.050", + "Type": "one-time" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example command creates a one-time Spot Instance request for five instances in the specified subnet. Amazon EC2 launches the instances in the specified subnet. If the VPC is a nondefault VPC, the instances do not receive a public IP address by default.", + "id": "ec2-request-spot-instances-2", + "title": "To create a one-time Spot Instance request" + } + ], + "ResetSnapshotAttribute": [ + { + "input": { + "Attribute": "createVolumePermission", + "SnapshotId": "snap-1234567890abcdef0" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets the create volume permissions for snapshot ``snap-1234567890abcdef0``. If the command succeeds, no output is returned.", + "id": "to-reset-a-snapshot-attribute-1472508825735", + "title": "To reset a snapshot attribute" + } + ], + "RestoreAddressToClassic": [ + { + "input": { + "PublicIp": "198.51.100.0" + }, + "output": { + "PublicIp": "198.51.100.0", + "Status": "MoveInProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example restores the specified Elastic IP address to the EC2-Classic platform.", + "id": "ec2-restore-address-to-classic-1", + "title": "To restore an address to EC2-Classic" + } + ], + "RunScheduledInstances": [ + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "NetworkInterfaces": [ + { + "AssociatePublicIpAddress": true, + "DeviceIndex": 0, + "Groups": [ + "sg-12345678" + ], + "SubnetId": "subnet-12345678" + } + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in a VPC.", + "id": "ec2-run-scheduled-instances-1", + "title": "To launch a Scheduled Instance in a VPC" + }, + { + "input": { + "InstanceCount": 1, + "LaunchSpecification": { + "IamInstanceProfile": { + "Name": "my-iam-role" + }, + "ImageId": "ami-12345678", + "InstanceType": "c4.large", + "KeyName": "my-key-pair", + "Placement": { + "AvailabilityZone": "us-west-2b" + }, + "SecurityGroupIds": [ + "sg-12345678" + ] + }, + "ScheduledInstanceId": "sci-1234-1234-1234-1234-123456789012" + }, + "output": { + "InstanceIdSet": [ + "i-1234567890abcdef0" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example launches the specified Scheduled Instance in EC2-Classic.", + "id": "ec2-run-scheduled-instances-2", + "title": "To launch a Scheduled Instance in EC2-Classic" + } + ], + "UnassignPrivateIpAddresses": [ + { + "input": { + "NetworkInterfaceId": "eni-e5aa89a3", + "PrivateIpAddresses": [ + "10.0.0.82" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example unassigns the specified private IP address from the specified network interface.", + "id": "ec2-unassign-private-ip-addresses-1", + "title": "To unassign a secondary private IP address from a network interface" + } + ] + } +} diff --git a/aws/dist/botocore/data/ec2/2016-11-15/paginators-1.json b/aws/dist/botocore/data/ec2/2016-11-15/paginators-1.json new file mode 100644 index 00000000..4545f2c1 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-11-15/paginators-1.json @@ -0,0 +1,420 @@ +{ + "pagination": { + "DescribeRouteTables": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RouteTables" + }, + "DescribeIamInstanceProfileAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "IamInstanceProfileAssociations" + }, + "DescribeInstanceStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceStatuses" + }, + "DescribeInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeReservedInstancesOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ReservedInstancesOfferings" + }, + "DescribeReservedInstancesModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "ReservedInstancesModifications" + }, + "DescribeSecurityGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SecurityGroups" + }, + "DescribeSnapshots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Snapshots" + }, + "DescribeSpotFleetInstances": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ActiveInstances" + }, + "DescribeSpotFleetRequests": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotFleetRequestConfigs" + }, + "DescribeSpotPriceHistory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "SpotPriceHistory" + }, + "DescribeTags": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Tags" + }, + "DescribeVolumeStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VolumeStatuses" + }, + "DescribeVolumes": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Volumes" + }, + "DescribeNatGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NatGateways" + }, + "DescribeNetworkInterfaces": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInterfaces" + }, + "DescribeVpcEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VpcEndpoints" + }, + "DescribeVpcEndpointServices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": [ + "ServiceDetails", + "ServiceNames" + ] + }, + "DescribeVpcEndpointConnections": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "VpcEndpointConnections" + }, + "DescribeByoipCidrs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ByoipCidrs" + }, + "DescribeCapacityReservations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CapacityReservations" + }, + "DescribeClassicLinkInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Instances" + }, + "DescribeClientVpnAuthorizationRules": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AuthorizationRules" + }, + "DescribeClientVpnConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Connections" + }, + "DescribeClientVpnEndpoints": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClientVpnEndpoints" + }, + "DescribeClientVpnRoutes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Routes" + }, + "DescribeClientVpnTargetNetworks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClientVpnTargetNetworks" + }, + "DescribeEgressOnlyInternetGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EgressOnlyInternetGateways" + }, + "DescribeFleets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Fleets" + }, + "DescribeFlowLogs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FlowLogs" + }, + "DescribeFpgaImages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FpgaImages" + }, + "DescribeHostReservationOfferings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "OfferingSet" + }, + "DescribeHostReservations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "HostReservationSet" + }, + "DescribeHosts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Hosts" + }, + "DescribeImportImageTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ImportImageTasks" + }, + "DescribeImportSnapshotTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ImportSnapshotTasks" + }, + "DescribeInstanceCreditSpecifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstanceCreditSpecifications" + }, + "DescribeLaunchTemplateVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LaunchTemplateVersions" + }, + "DescribeLaunchTemplates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LaunchTemplates" + }, + "DescribeMovingAddresses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MovingAddressStatuses" + }, + "DescribeNetworkInterfacePermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkInterfacePermissions" + }, + "DescribePrefixLists": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PrefixLists" + }, + "DescribePrincipalIdFormat": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Principals" + }, + "DescribePublicIpv4Pools": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PublicIpv4Pools" + }, + "DescribeScheduledInstanceAvailability": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledInstanceAvailabilitySet" + }, + "DescribeScheduledInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledInstanceSet" + }, + "DescribeStaleSecurityGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StaleSecurityGroupSet" + }, + "DescribeTransitGatewayAttachments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayAttachments" + }, + "DescribeTransitGatewayRouteTables": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayRouteTables" + }, + "DescribeTransitGatewayVpcAttachments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayVpcAttachments" + }, + "DescribeTransitGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGateways" + }, + "DescribeVolumesModifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VolumesModifications" + }, + "DescribeVpcClassicLinkDnsSupport": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Vpcs" + }, + "DescribeVpcEndpointConnectionNotifications": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ConnectionNotificationSet" + }, + "DescribeVpcEndpointServiceConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ServiceConfigurations" + }, + "DescribeVpcEndpointServicePermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AllowedPrincipals" + }, + "DescribeVpcPeeringConnections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "VpcPeeringConnections" + }, + "GetTransitGatewayAttachmentPropagations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayAttachmentPropagations" + }, + "GetTransitGatewayRouteTableAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Associations" + }, + "GetTransitGatewayRouteTablePropagations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransitGatewayRouteTablePropagations" + }, + "DescribeInternetGateways": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InternetGateways" + }, + "DescribeNetworkAcls": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NetworkAcls" + }, + "DescribeVpcs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Vpcs" + }, + "DescribeSpotInstanceRequests": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SpotInstanceRequests" + }, + "DescribeDhcpOptions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DhcpOptions" + }, + "DescribeSubnets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Subnets" + }, + "DescribeTrafficMirrorFilters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TrafficMirrorFilters" + }, + "DescribeTrafficMirrorSessions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TrafficMirrorSessions" + }, + "DescribeTrafficMirrorTargets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TrafficMirrorTargets" + } + } +} diff --git a/aws/dist/botocore/data/ec2/2016-11-15/service-2.json b/aws/dist/botocore/data/ec2/2016-11-15/service-2.json new file mode 100644 index 00000000..92709574 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-11-15/service-2.json @@ -0,0 +1,32606 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-15", + "endpointPrefix":"ec2", + "protocol":"ec2", + "serviceAbbreviation":"Amazon EC2", + "serviceFullName":"Amazon Elastic Compute Cloud", + "serviceId":"EC2", + "signatureVersion":"v4", + "uid":"ec2-2016-11-15", + "xmlNamespace":"http://ec2.amazonaws.com/doc/2016-11-15" + }, + "operations":{ + "AcceptReservedInstancesExchangeQuote":{ + "name":"AcceptReservedInstancesExchangeQuote", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptReservedInstancesExchangeQuoteRequest"}, + "output":{"shape":"AcceptReservedInstancesExchangeQuoteResult"}, + "documentation":"

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

" + }, + "AcceptTransitGatewayVpcAttachment":{ + "name":"AcceptTransitGatewayVpcAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptTransitGatewayVpcAttachmentRequest"}, + "output":{"shape":"AcceptTransitGatewayVpcAttachmentResult"}, + "documentation":"

Accepts a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use RejectTransitGatewayVpcAttachment to reject a VPC attachment request.

" + }, + "AcceptVpcEndpointConnections":{ + "name":"AcceptVpcEndpointConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcEndpointConnectionsRequest"}, + "output":{"shape":"AcceptVpcEndpointConnectionsResult"}, + "documentation":"

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

" + }, + "AcceptVpcPeeringConnection":{ + "name":"AcceptVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, + "output":{"shape":"AcceptVpcPeeringConnectionResult"}, + "documentation":"

Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.

For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.

" + }, + "AdvertiseByoipCidr":{ + "name":"AdvertiseByoipCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AdvertiseByoipCidrRequest"}, + "output":{"shape":"AdvertiseByoipCidrResult"}, + "documentation":"

Advertises an IPv4 address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

We recommend that you stop advertising the BYOIP CIDR from other locations when you advertise it from AWS. To minimize down time, you can configure your AWS resources to use an address from a BYOIP CIDR before it is advertised, and then simultaneously stop advertising it from the current location and start advertising it through AWS.

It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.

To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.

" + }, + "AllocateAddress":{ + "name":"AllocateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateAddressRequest"}, + "output":{"shape":"AllocateAddressResult"}, + "documentation":"

Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.

You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.

An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AllocateHosts":{ + "name":"AllocateHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateHostsRequest"}, + "output":{"shape":"AllocateHostsResult"}, + "documentation":"

Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.

" + }, + "ApplySecurityGroupsToClientVpnTargetNetwork":{ + "name":"ApplySecurityGroupsToClientVpnTargetNetwork", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplySecurityGroupsToClientVpnTargetNetworkRequest"}, + "output":{"shape":"ApplySecurityGroupsToClientVpnTargetNetworkResult"}, + "documentation":"

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

" + }, + "AssignIpv6Addresses":{ + "name":"AssignIpv6Addresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignIpv6AddressesRequest"}, + "output":{"shape":"AssignIpv6AddressesResult"}, + "documentation":"

Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet's IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AssignPrivateIpAddresses":{ + "name":"AssignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignPrivateIpAddressesRequest"}, + "output":{"shape":"AssignPrivateIpAddressesResult"}, + "documentation":"

Assigns one or more secondary private IP addresses to the specified network interface.

You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.

Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.

" + }, + "AssociateAddress":{ + "name":"AssociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAddressRequest"}, + "output":{"shape":"AssociateAddressResult"}, + "documentation":"

Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

" + }, + "AssociateClientVpnTargetNetwork":{ + "name":"AssociateClientVpnTargetNetwork", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateClientVpnTargetNetworkRequest"}, + "output":{"shape":"AssociateClientVpnTargetNetworkResult"}, + "documentation":"

Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy.

" + }, + "AssociateDhcpOptions":{ + "name":"AssociateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDhcpOptionsRequest"}, + "documentation":"

Associates a set of DHCP options (that you've previously created) with the specified VPC, or associates no DHCP options with the VPC.

After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don't need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateIamInstanceProfile":{ + "name":"AssociateIamInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateIamInstanceProfileRequest"}, + "output":{"shape":"AssociateIamInstanceProfileResult"}, + "documentation":"

Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

" + }, + "AssociateRouteTable":{ + "name":"AssociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateRouteTableRequest"}, + "output":{"shape":"AssociateRouteTableResult"}, + "documentation":"

Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "AssociateSubnetCidrBlock":{ + "name":"AssociateSubnetCidrBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateSubnetCidrBlockRequest"}, + "output":{"shape":"AssociateSubnetCidrBlockResult"}, + "documentation":"

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

" + }, + "AssociateTransitGatewayRouteTable":{ + "name":"AssociateTransitGatewayRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateTransitGatewayRouteTableRequest"}, + "output":{"shape":"AssociateTransitGatewayRouteTableResult"}, + "documentation":"

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

" + }, + "AssociateVpcCidrBlock":{ + "name":"AssociateVpcCidrBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateVpcCidrBlockRequest"}, + "output":{"shape":"AssociateVpcCidrBlockResult"}, + "documentation":"

Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56.

For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachClassicLinkVpc":{ + "name":"AttachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachClassicLinkVpcRequest"}, + "output":{"shape":"AttachClassicLinkVpcResult"}, + "documentation":"

Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the running state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it.

After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again.

Linking your instance to a VPC is sometimes referred to as attaching your instance.

" + }, + "AttachInternetGateway":{ + "name":"AttachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInternetGatewayRequest"}, + "documentation":"

Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "AttachNetworkInterface":{ + "name":"AttachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachNetworkInterfaceRequest"}, + "output":{"shape":"AttachNetworkInterfaceResult"}, + "documentation":"

Attaches a network interface to an instance.

" + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Attaches an EBS volume to a running or stopped instance and exposes it to the instance with the specified device name.

Encrypted EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

After you attach an EBS volume, you must make it available. For more information, see Making an EBS Volume Available For Use.

If a volume has an AWS Marketplace product code:

  • The volume can be attached only to a stopped instance.

  • AWS Marketplace product codes are copied from the volume to the instance.

  • You must be subscribed to the product.

  • The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance.

For more information, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "AttachVpnGateway":{ + "name":"AttachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVpnGatewayRequest"}, + "output":{"shape":"AttachVpnGatewayResult"}, + "documentation":"

Attaches a virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "AuthorizeClientVpnIngress":{ + "name":"AuthorizeClientVpnIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeClientVpnIngressRequest"}, + "output":{"shape":"AuthorizeClientVpnIngressResult"}, + "documentation":"

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

" + }, + "AuthorizeSecurityGroupEgress":{ + "name":"AuthorizeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupEgressRequest"}, + "documentation":"

[VPC only] Adds the specified egress rules to a security group for use with a VPC.

An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.

Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "AuthorizeSecurityGroupIngress":{ + "name":"AuthorizeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, + "documentation":"

Adds the specified ingress rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address ranges, or from the instances associated with the specified destination security groups.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "BundleInstance":{ + "name":"BundleInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BundleInstanceRequest"}, + "output":{"shape":"BundleInstanceResult"}, + "documentation":"

Bundles an Amazon instance store-backed Windows instance.

During bundling, only the root device volume (C:\\) is bundled. Data on other instance store volumes is not preserved.

This action is not applicable for Linux/Unix instances or Windows instances that are backed by Amazon EBS.

" + }, + "CancelBundleTask":{ + "name":"CancelBundleTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelBundleTaskRequest"}, + "output":{"shape":"CancelBundleTaskResult"}, + "documentation":"

Cancels a bundling operation for an instance store-backed Windows instance.

" + }, + "CancelCapacityReservation":{ + "name":"CancelCapacityReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelCapacityReservationRequest"}, + "output":{"shape":"CancelCapacityReservationResult"}, + "documentation":"

Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to cancelled.

Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity.

" + }, + "CancelConversionTask":{ + "name":"CancelConversionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelConversionRequest"}, + "documentation":"

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "documentation":"

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

" + }, + "CancelImportTask":{ + "name":"CancelImportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelImportTaskRequest"}, + "output":{"shape":"CancelImportTaskResult"}, + "documentation":"

Cancels an in-process import virtual machine or import snapshot task.

" + }, + "CancelReservedInstancesListing":{ + "name":"CancelReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelReservedInstancesListingRequest"}, + "output":{"shape":"CancelReservedInstancesListingResult"}, + "documentation":"

Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CancelSpotFleetRequests":{ + "name":"CancelSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotFleetRequestsRequest"}, + "output":{"shape":"CancelSpotFleetRequestsResponse"}, + "documentation":"

Cancels the specified Spot Fleet requests.

After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating state. Otherwise, the Spot Fleet request enters the cancelled_running state and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "CancelSpotInstanceRequests":{ + "name":"CancelSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelSpotInstanceRequestsRequest"}, + "output":{"shape":"CancelSpotInstanceRequestsResult"}, + "documentation":"

Cancels one or more Spot Instance requests.

Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.

" + }, + "ConfirmProductInstance":{ + "name":"ConfirmProductInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmProductInstanceRequest"}, + "output":{"shape":"ConfirmProductInstanceResult"}, + "documentation":"

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support.

" + }, + "CopyFpgaImage":{ + "name":"CopyFpgaImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyFpgaImageRequest"}, + "output":{"shape":"CopyFpgaImageResult"}, + "documentation":"

Copies the specified Amazon FPGA Image (AFI) to the current Region.

" + }, + "CopyImage":{ + "name":"CopyImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyImageRequest"}, + "output":{"shape":"CopyImageResult"}, + "documentation":"

Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.

Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.

For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "documentation":"

Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).

Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a different CMK.

To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.

Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.

For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateCapacityReservation":{ + "name":"CreateCapacityReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCapacityReservationRequest"}, + "output":{"shape":"CreateCapacityReservationResult"}, + "documentation":"

Creates a new Capacity Reservation with the specified attributes.

Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. This gives you the flexibility to selectively add capacity reservations and still get the Regional RI discounts for that usage. By creating Capacity Reservations, you ensure that you always have access to Amazon EC2 capacity when you need it, for as long as you need it. For more information, see Capacity Reservations in the Amazon Elastic Compute Cloud User Guide.

Your request to create a Capacity Reservation could fail if Amazon EC2 does not have sufficient capacity to fulfill the request. If your request fails due to Amazon EC2 capacity constraints, either try again at a later time, try in a different Availability Zone, or request a smaller capacity reservation. If your application is flexible across instance types and sizes, try to create a Capacity Reservation with different instance attributes.

Your request could also fail if the requested quantity exceeds your On-Demand Instance limit for the selected instance type. If your request fails due to limit constraints, increase your On-Demand Instance limit for the required instance type and try again. For more information about increasing your instance limits, see Amazon EC2 Service Limits in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateClientVpnEndpoint":{ + "name":"CreateClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClientVpnEndpointRequest"}, + "output":{"shape":"CreateClientVpnEndpointResult"}, + "documentation":"

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

" + }, + "CreateClientVpnRoute":{ + "name":"CreateClientVpnRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClientVpnRouteRequest"}, + "output":{"shape":"CreateClientVpnRouteResult"}, + "documentation":"

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traffic to specific resources or networks.

" + }, + "CreateCustomerGateway":{ + "name":"CreateCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomerGatewayRequest"}, + "output":{"shape":"CreateCustomerGatewayResult"}, + "documentation":"

Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and can be behind a device performing network address translation (NAT).

For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).

Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-1 Region.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.

" + }, + "CreateDefaultSubnet":{ + "name":"CreateDefaultSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDefaultSubnetRequest"}, + "output":{"shape":"CreateDefaultSubnetResult"}, + "documentation":"

Creates a default subnet with a size /20 IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateDefaultVpc":{ + "name":"CreateDefaultVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDefaultVpcRequest"}, + "output":{"shape":"CreateDefaultVpcResult"}, + "documentation":"

Creates a default VPC with a size /16 IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see Default VPC and Default Subnets in the Amazon Virtual Private Cloud User Guide. You cannot specify the components of the default VPC yourself.

If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region.

If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see \"I really want a default VPC for my existing EC2 account. Is that possible?\" in the Default VPCs FAQ.

" + }, + "CreateDhcpOptions":{ + "name":"CreateDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDhcpOptionsRequest"}, + "output":{"shape":"CreateDhcpOptionsResult"}, + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateEgressOnlyInternetGateway":{ + "name":"CreateEgressOnlyInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEgressOnlyInternetGatewayRequest"}, + "output":{"shape":"CreateEgressOnlyInternetGatewayResult"}, + "documentation":"

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

" + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFleetRequest"}, + "output":{"shape":"CreateFleetResult"}, + "documentation":"

Launches an EC2 Fleet.

You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateFlowLogs":{ + "name":"CreateFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowLogsRequest"}, + "output":{"shape":"CreateFlowLogsResult"}, + "documentation":"

Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.

Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow Log Records in the Amazon Virtual Private Cloud User Guide.

When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.

For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateFpgaImage":{ + "name":"CreateFpgaImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFpgaImageRequest"}, + "output":{"shape":"CreateFpgaImageResult"}, + "documentation":"

Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP).

The create operation is asynchronous. To verify that the AFI is ready for use, check the output logs.

An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the AWS FPGA Hardware Development Kit.

" + }, + "CreateImage":{ + "name":"CreateImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateImageRequest"}, + "output":{"shape":"CreateImageResult"}, + "documentation":"

Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped.

If you customized your instance with instance store volumes or EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes.

For more information, see Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateInstanceExportTask":{ + "name":"CreateInstanceExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceExportTaskRequest"}, + "output":{"shape":"CreateInstanceExportTaskResult"}, + "documentation":"

Exports a running or stopped instance to an S3 bucket.

For information about the supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an Instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "CreateInternetGateway":{ + "name":"CreateInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInternetGatewayRequest"}, + "output":{"shape":"CreateInternetGatewayResult"}, + "documentation":"

Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using AttachInternetGateway.

For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateKeyPair":{ + "name":"CreateKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyPairRequest"}, + "output":{"shape":"KeyPair"}, + "documentation":"

Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.

You can have up to five thousand key pairs per Region.

The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.

For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateLaunchTemplate":{ + "name":"CreateLaunchTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLaunchTemplateRequest"}, + "output":{"shape":"CreateLaunchTemplateResult"}, + "documentation":"

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request.

" + }, + "CreateLaunchTemplateVersion":{ + "name":"CreateLaunchTemplateVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLaunchTemplateVersionRequest"}, + "output":{"shape":"CreateLaunchTemplateVersionResult"}, + "documentation":"

Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.

Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.

" + }, + "CreateNatGateway":{ + "name":"CreateNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNatGatewayRequest"}, + "output":{"shape":"CreateNatGatewayResult"}, + "documentation":"

Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAcl":{ + "name":"CreateNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclRequest"}, + "output":{"shape":"CreateNetworkAclResult"}, + "documentation":"

Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkAclEntry":{ + "name":"CreateNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkAclEntryRequest"}, + "documentation":"

Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules.

We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules.

After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one.

For more information about network ACLs, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterface":{ + "name":"CreateNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfaceRequest"}, + "output":{"shape":"CreateNetworkInterfaceResult"}, + "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateNetworkInterfacePermission":{ + "name":"CreateNetworkInterfacePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNetworkInterfacePermissionRequest"}, + "output":{"shape":"CreateNetworkInterfacePermissionResult"}, + "documentation":"

Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.

You can grant permission to a single AWS account only, and only one account at a time.

" + }, + "CreatePlacementGroup":{ + "name":"CreatePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlacementGroupRequest"}, + "documentation":"

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateReservedInstancesListing":{ + "name":"CreateReservedInstancesListing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReservedInstancesListingRequest"}, + "output":{"shape":"CreateReservedInstancesListingResult"}, + "documentation":"

Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.

Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.

The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateRoute":{ + "name":"CreateRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteRequest"}, + "output":{"shape":"CreateRouteResult"}, + "documentation":"

Creates a route in a route table within a VPC.

You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.

When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3, and the route table includes the following two IPv4 routes:

  • 192.0.2.0/24 (goes to some target A)

  • 192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.

For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateRouteTable":{ + "name":"CreateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRouteTableRequest"}, + "output":{"shape":"CreateRouteTableResult"}, + "documentation":"

Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateSecurityGroup":{ + "name":"CreateSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityGroupRequest"}, + "output":{"shape":"CreateSecurityGroupResult"}, + "documentation":"

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotRequest"}, + "output":{"shape":"Snapshot"}, + "documentation":"

Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.

When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot.

You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your EBS volume at the time the snapshot command is issued; this may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.

To create a snapshot for EBS volumes that serve as root devices, you should stop the instance before taking the snapshot.

Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.

You can tag your snapshots during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Amazon Elastic Block Store and Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateSnapshots":{ + "name":"CreateSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotsRequest"}, + "output":{"shape":"CreateSnapshotsResult"}, + "documentation":"

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.

" + }, + "CreateSpotDatafeedSubscription":{ + "name":"CreateSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, + "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + }, + "CreateSubnet":{ + "name":"CreateSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubnetRequest"}, + "output":{"shape":"CreateSubnetResult"}, + "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "documentation":"

Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide. For more information about creating IAM policies that control users' access to resources based on tags, see Supported Resource-Level Permissions for Amazon EC2 API Actions in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateTrafficMirrorFilter":{ + "name":"CreateTrafficMirrorFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrafficMirrorFilterRequest"}, + "output":{"shape":"CreateTrafficMirrorFilterResult"}, + "documentation":"

Creates a Traffic Mirror filter.

A Traffic Mirror filter is a set of rules that defines the traffic to mirror.

By default, no traffic is mirrored. To mirror traffic, use CreateTrafficMirrorFilterRule to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use ModifyTrafficMirrorFilterNetworkServices to mirror supported network services.

" + }, + "CreateTrafficMirrorFilterRule":{ + "name":"CreateTrafficMirrorFilterRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrafficMirrorFilterRuleRequest"}, + "output":{"shape":"CreateTrafficMirrorFilterRuleResult"}, + "documentation":"

Creates a Traffic Mirror filter rule.

A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror.

You need the Traffic Mirror filter ID when you create the rule.

" + }, + "CreateTrafficMirrorSession":{ + "name":"CreateTrafficMirrorSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrafficMirrorSessionRequest"}, + "output":{"shape":"CreateTrafficMirrorSessionResult"}, + "documentation":"

Creates a Traffic Mirror session.

A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.

The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.

By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.

" + }, + "CreateTrafficMirrorTarget":{ + "name":"CreateTrafficMirrorTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrafficMirrorTargetRequest"}, + "output":{"shape":"CreateTrafficMirrorTargetResult"}, + "documentation":"

Creates a target for your Traffic Mirror session.

A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.

A Traffic Mirror target can be a network interface, or a Network Load Balancer.

To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.

" + }, + "CreateTransitGateway":{ + "name":"CreateTransitGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransitGatewayRequest"}, + "output":{"shape":"CreateTransitGatewayResult"}, + "documentation":"

Creates a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use CreateTransitGatewayVpcAttachment.

To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.

" + }, + "CreateTransitGatewayRoute":{ + "name":"CreateTransitGatewayRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransitGatewayRouteRequest"}, + "output":{"shape":"CreateTransitGatewayRouteResult"}, + "documentation":"

Creates a static route for the specified transit gateway route table.

" + }, + "CreateTransitGatewayRouteTable":{ + "name":"CreateTransitGatewayRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransitGatewayRouteTableRequest"}, + "output":{"shape":"CreateTransitGatewayRouteTableResult"}, + "documentation":"

Creates a route table for the specified transit gateway.

" + }, + "CreateTransitGatewayVpcAttachment":{ + "name":"CreateTransitGatewayVpcAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransitGatewayVpcAttachmentRequest"}, + "output":{"shape":"CreateTransitGatewayVpcAttachmentResult"}, + "documentation":"

Attaches the specified VPC to the specified transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using CreateRoute.

" + }, + "CreateVolume":{ + "name":"CreateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVolumeRequest"}, + "output":{"shape":"Volume"}, + "documentation":"

Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.

You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.

You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can tag your volumes during creation. For more information, see Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.

For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpc":{ + "name":"CreateVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcRequest"}, + "output":{"shape":"CreateVpcResult"}, + "documentation":"

Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.

By default, each instance you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

You can specify the instance tenancy value for the VPC when you create it. You can't change this value for the VPC after you create it. For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CreateVpcEndpoint":{ + "name":"CreateVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointRequest"}, + "output":{"shape":"CreateVpcEndpointResult"}, + "documentation":"

Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.

An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.

Use DescribeVpcEndpointServices to get a list of supported services.

" + }, + "CreateVpcEndpointConnectionNotification":{ + "name":"CreateVpcEndpointConnectionNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointConnectionNotificationRequest"}, + "output":{"shape":"CreateVpcEndpointConnectionNotificationResult"}, + "documentation":"

Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

You can create a connection notification for interface endpoints only.

" + }, + "CreateVpcEndpointServiceConfiguration":{ + "name":"CreateVpcEndpointServiceConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcEndpointServiceConfigurationRequest"}, + "output":{"shape":"CreateVpcEndpointServiceConfigurationResult"}, + "documentation":"

Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.

To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionRequest"}, + "output":{"shape":"CreateVpcPeeringConnectionResult"}, + "documentation":"

Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.

Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.

The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.

If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.

" + }, + "CreateVpnConnection":{ + "name":"CreateVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRequest"}, + "output":{"shape":"CreateVpnConnectionResult"}, + "documentation":"

Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The supported connection type is ipsec.1.

The response includes information that you need to give to your network administrator to configure your customer gateway.

We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.

If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "CreateVpnConnectionRoute":{ + "name":"CreateVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnConnectionRouteRequest"}, + "documentation":"

Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "CreateVpnGateway":{ + "name":"CreateVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpnGatewayRequest"}, + "output":{"shape":"CreateVpnGatewayResult"}, + "documentation":"

Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DeleteClientVpnEndpoint":{ + "name":"DeleteClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClientVpnEndpointRequest"}, + "output":{"shape":"DeleteClientVpnEndpointResult"}, + "documentation":"

Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.

" + }, + "DeleteClientVpnRoute":{ + "name":"DeleteClientVpnRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClientVpnRouteRequest"}, + "output":{"shape":"DeleteClientVpnRouteResult"}, + "documentation":"

Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the CreateClientVpnRoute action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint.

" + }, + "DeleteCustomerGateway":{ + "name":"DeleteCustomerGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomerGatewayRequest"}, + "documentation":"

Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.

" + }, + "DeleteDhcpOptions":{ + "name":"DeleteDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDhcpOptionsRequest"}, + "documentation":"

Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC.

" + }, + "DeleteEgressOnlyInternetGateway":{ + "name":"DeleteEgressOnlyInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEgressOnlyInternetGatewayRequest"}, + "output":{"shape":"DeleteEgressOnlyInternetGatewayResult"}, + "documentation":"

Deletes an egress-only internet gateway.

" + }, + "DeleteFleets":{ + "name":"DeleteFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFleetsRequest"}, + "output":{"shape":"DeleteFleetsResult"}, + "documentation":"

Deletes the specified EC2 Fleet.

After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you terminate the instances, the EC2 Fleet enters the deleted_terminating state. Otherwise, the EC2 Fleet enters the deleted_running state, and the instances continue to run until they are interrupted or you terminate them manually.

" + }, + "DeleteFlowLogs":{ + "name":"DeleteFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowLogsRequest"}, + "output":{"shape":"DeleteFlowLogsResult"}, + "documentation":"

Deletes one or more flow logs.

" + }, + "DeleteFpgaImage":{ + "name":"DeleteFpgaImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFpgaImageRequest"}, + "output":{"shape":"DeleteFpgaImageResult"}, + "documentation":"

Deletes the specified Amazon FPGA Image (AFI).

" + }, + "DeleteInternetGateway":{ + "name":"DeleteInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInternetGatewayRequest"}, + "documentation":"

Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.

" + }, + "DeleteKeyPair":{ + "name":"DeleteKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKeyPairRequest"}, + "documentation":"

Deletes the specified key pair, by removing the public key from Amazon EC2.

" + }, + "DeleteLaunchTemplate":{ + "name":"DeleteLaunchTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLaunchTemplateRequest"}, + "output":{"shape":"DeleteLaunchTemplateResult"}, + "documentation":"

Deletes a launch template. Deleting a launch template deletes all of its versions.

" + }, + "DeleteLaunchTemplateVersions":{ + "name":"DeleteLaunchTemplateVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLaunchTemplateVersionsRequest"}, + "output":{"shape":"DeleteLaunchTemplateVersionsResult"}, + "documentation":"

Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.

" + }, + "DeleteNatGateway":{ + "name":"DeleteNatGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNatGatewayRequest"}, + "output":{"shape":"DeleteNatGatewayResult"}, + "documentation":"

Deletes the specified NAT gateway. Deleting a NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables.

" + }, + "DeleteNetworkAcl":{ + "name":"DeleteNetworkAcl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclRequest"}, + "documentation":"

Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL.

" + }, + "DeleteNetworkAclEntry":{ + "name":"DeleteNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkAclEntryRequest"}, + "documentation":"

Deletes the specified ingress or egress entry (rule) from the specified network ACL.

" + }, + "DeleteNetworkInterface":{ + "name":"DeleteNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfaceRequest"}, + "documentation":"

Deletes the specified network interface. You must detach the network interface before you can delete it.

" + }, + "DeleteNetworkInterfacePermission":{ + "name":"DeleteNetworkInterfacePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNetworkInterfacePermissionRequest"}, + "output":{"shape":"DeleteNetworkInterfacePermissionResult"}, + "documentation":"

Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment.

" + }, + "DeletePlacementGroup":{ + "name":"DeletePlacementGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlacementGroupRequest"}, + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteQueuedReservedInstances":{ + "name":"DeleteQueuedReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteQueuedReservedInstancesRequest"}, + "output":{"shape":"DeleteQueuedReservedInstancesResult"}, + "documentation":"

Deletes the queued purchases for the specified Reserved Instances.

" + }, + "DeleteRoute":{ + "name":"DeleteRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteRequest"}, + "documentation":"

Deletes the specified route from the specified route table.

" + }, + "DeleteRouteTable":{ + "name":"DeleteRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRouteTableRequest"}, + "documentation":"

Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table.

" + }, + "DeleteSecurityGroup":{ + "name":"DeleteSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityGroupRequest"}, + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotRequest"}, + "documentation":"

Deletes the specified snapshot.

When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.

You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.

For more information, see Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteSpotDatafeedSubscription":{ + "name":"DeleteSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpotDatafeedSubscriptionRequest"}, + "documentation":"

Deletes the data feed for Spot Instances.

" + }, + "DeleteSubnet":{ + "name":"DeleteSubnet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubnetRequest"}, + "documentation":"

Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "documentation":"

Deletes the specified set of tags from the specified set of resources.

To list the current tags, use DescribeTags. For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteTrafficMirrorFilter":{ + "name":"DeleteTrafficMirrorFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrafficMirrorFilterRequest"}, + "output":{"shape":"DeleteTrafficMirrorFilterResult"}, + "documentation":"

Deletes the specified Traffic Mirror filter.

You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.

" + }, + "DeleteTrafficMirrorFilterRule":{ + "name":"DeleteTrafficMirrorFilterRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrafficMirrorFilterRuleRequest"}, + "output":{"shape":"DeleteTrafficMirrorFilterRuleResult"}, + "documentation":"

Deletes the specified Traffic Mirror rule.

" + }, + "DeleteTrafficMirrorSession":{ + "name":"DeleteTrafficMirrorSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrafficMirrorSessionRequest"}, + "output":{"shape":"DeleteTrafficMirrorSessionResult"}, + "documentation":"

Deletes the specified Traffic Mirror session.

" + }, + "DeleteTrafficMirrorTarget":{ + "name":"DeleteTrafficMirrorTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTrafficMirrorTargetRequest"}, + "output":{"shape":"DeleteTrafficMirrorTargetResult"}, + "documentation":"

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

" + }, + "DeleteTransitGateway":{ + "name":"DeleteTransitGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTransitGatewayRequest"}, + "output":{"shape":"DeleteTransitGatewayResult"}, + "documentation":"

Deletes the specified transit gateway.

" + }, + "DeleteTransitGatewayRoute":{ + "name":"DeleteTransitGatewayRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTransitGatewayRouteRequest"}, + "output":{"shape":"DeleteTransitGatewayRouteResult"}, + "documentation":"

Deletes the specified route from the specified transit gateway route table.

" + }, + "DeleteTransitGatewayRouteTable":{ + "name":"DeleteTransitGatewayRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTransitGatewayRouteTableRequest"}, + "output":{"shape":"DeleteTransitGatewayRouteTableResult"}, + "documentation":"

Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.

" + }, + "DeleteTransitGatewayVpcAttachment":{ + "name":"DeleteTransitGatewayVpcAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTransitGatewayVpcAttachmentRequest"}, + "output":{"shape":"DeleteTransitGatewayVpcAttachmentResult"}, + "documentation":"

Deletes the specified VPC attachment.

" + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeRequest"}, + "documentation":"

Deletes the specified EBS volume. The volume must be in the available state (not attached to an instance).

The volume can remain in the deleting state for several minutes.

For more information, see Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DeleteVpc":{ + "name":"DeleteVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcRequest"}, + "documentation":"

Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on.

" + }, + "DeleteVpcEndpointConnectionNotifications":{ + "name":"DeleteVpcEndpointConnectionNotifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointConnectionNotificationsRequest"}, + "output":{"shape":"DeleteVpcEndpointConnectionNotificationsResult"}, + "documentation":"

Deletes one or more VPC endpoint connection notifications.

" + }, + "DeleteVpcEndpointServiceConfigurations":{ + "name":"DeleteVpcEndpointServiceConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointServiceConfigurationsRequest"}, + "output":{"shape":"DeleteVpcEndpointServiceConfigurationsResult"}, + "documentation":"

Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.

" + }, + "DeleteVpcEndpoints":{ + "name":"DeleteVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcEndpointsRequest"}, + "output":{"shape":"DeleteVpcEndpointsResult"}, + "documentation":"

Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionRequest"}, + "output":{"shape":"DeleteVpcPeeringConnectionResult"}, + "documentation":"

Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the active state. The owner of the requester VPC can delete a VPC peering connection in the pending-acceptance state. You cannot delete a VPC peering connection that's in the failed state.

" + }, + "DeleteVpnConnection":{ + "name":"DeleteVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRequest"}, + "documentation":"

Deletes the specified VPN connection.

If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway using the new configuration information returned with the new VPN connection ID.

" + }, + "DeleteVpnConnectionRoute":{ + "name":"DeleteVpnConnectionRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnConnectionRouteRequest"}, + "documentation":"

Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway.

" + }, + "DeleteVpnGateway":{ + "name":"DeleteVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpnGatewayRequest"}, + "documentation":"

Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network.

" + }, + "DeprovisionByoipCidr":{ + "name":"DeprovisionByoipCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprovisionByoipCidrRequest"}, + "output":{"shape":"DeprovisionByoipCidrResult"}, + "documentation":"

Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool.

Before you can release an address range, you must stop advertising it using WithdrawByoipCidr and you must not have any IP addresses allocated from its address range.

" + }, + "DeregisterImage":{ + "name":"DeregisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterImageRequest"}, + "documentation":"

Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.

When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResult"}, + "documentation":"

Describes attributes of your AWS account. The following are the supported account attributes:

  • supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.

  • default-vpc: The ID of the default VPC for your account, or none.

  • max-instances: The maximum number of On-Demand Instances that you can run.

  • vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.

  • max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.

  • vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.

" + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "documentation":"

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeAggregateIdFormat":{ + "name":"DescribeAggregateIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAggregateIdFormatRequest"}, + "output":{"shape":"DescribeAggregateIdFormatResult"}, + "documentation":"

Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).

This request only returns information about resource types that support longer IDs.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

" + }, + "DescribeAvailabilityZones":{ + "name":"DescribeAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailabilityZonesRequest"}, + "output":{"shape":"DescribeAvailabilityZonesResult"}, + "documentation":"

Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.

For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeBundleTasks":{ + "name":"DescribeBundleTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBundleTasksRequest"}, + "output":{"shape":"DescribeBundleTasksResult"}, + "documentation":"

Describes the specified bundle tasks or all of your bundle tasks.

Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use RegisterImage with the Amazon S3 bucket name and image manifest name you provided to the bundle task.

" + }, + "DescribeByoipCidrs":{ + "name":"DescribeByoipCidrs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeByoipCidrsRequest"}, + "output":{"shape":"DescribeByoipCidrsResult"}, + "documentation":"

Describes the IP address ranges that were specified in calls to ProvisionByoipCidr.

To describe the address pools that were created when you provisioned the address ranges, use DescribePublicIpv4Pools.

" + }, + "DescribeCapacityReservations":{ + "name":"DescribeCapacityReservations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCapacityReservationsRequest"}, + "output":{"shape":"DescribeCapacityReservationsResult"}, + "documentation":"

Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.

" + }, + "DescribeClassicLinkInstances":{ + "name":"DescribeClassicLinkInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClassicLinkInstancesRequest"}, + "output":{"shape":"DescribeClassicLinkInstancesResult"}, + "documentation":"

Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.

" + }, + "DescribeClientVpnAuthorizationRules":{ + "name":"DescribeClientVpnAuthorizationRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnAuthorizationRulesRequest"}, + "output":{"shape":"DescribeClientVpnAuthorizationRulesResult"}, + "documentation":"

Describes the authorization rules for a specified Client VPN endpoint.

" + }, + "DescribeClientVpnConnections":{ + "name":"DescribeClientVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnConnectionsRequest"}, + "output":{"shape":"DescribeClientVpnConnectionsResult"}, + "documentation":"

Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.

" + }, + "DescribeClientVpnEndpoints":{ + "name":"DescribeClientVpnEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnEndpointsRequest"}, + "output":{"shape":"DescribeClientVpnEndpointsResult"}, + "documentation":"

Describes one or more Client VPN endpoints in the account.

" + }, + "DescribeClientVpnRoutes":{ + "name":"DescribeClientVpnRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnRoutesRequest"}, + "output":{"shape":"DescribeClientVpnRoutesResult"}, + "documentation":"

Describes the routes for the specified Client VPN endpoint.

" + }, + "DescribeClientVpnTargetNetworks":{ + "name":"DescribeClientVpnTargetNetworks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientVpnTargetNetworksRequest"}, + "output":{"shape":"DescribeClientVpnTargetNetworksResult"}, + "documentation":"

Describes the target networks associated with the specified Client VPN endpoint.

" + }, + "DescribeConversionTasks":{ + "name":"DescribeConversionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConversionTasksRequest"}, + "output":{"shape":"DescribeConversionTasksResult"}, + "documentation":"

Describes the specified conversion tasks or all your conversion tasks. For more information, see the VM Import/Export User Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "DescribeCustomerGateways":{ + "name":"DescribeCustomerGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomerGatewaysRequest"}, + "output":{"shape":"DescribeCustomerGatewaysResult"}, + "documentation":"

Describes one or more of your VPN customer gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DescribeDhcpOptions":{ + "name":"DescribeDhcpOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDhcpOptionsRequest"}, + "output":{"shape":"DescribeDhcpOptionsResult"}, + "documentation":"

Describes one or more of your DHCP options sets.

For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeEgressOnlyInternetGateways":{ + "name":"DescribeEgressOnlyInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEgressOnlyInternetGatewaysRequest"}, + "output":{"shape":"DescribeEgressOnlyInternetGatewaysResult"}, + "documentation":"

Describes one or more of your egress-only internet gateways.

" + }, + "DescribeElasticGpus":{ + "name":"DescribeElasticGpus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticGpusRequest"}, + "output":{"shape":"DescribeElasticGpusResult"}, + "documentation":"

Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.

" + }, + "DescribeExportImageTasks":{ + "name":"DescribeExportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportImageTasksRequest"}, + "output":{"shape":"DescribeExportImageTasksResult"}, + "documentation":"

Describes the specified export image tasks or all your export image tasks.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResult"}, + "documentation":"

Describes the specified export instance tasks or all your export instance tasks.

" + }, + "DescribeFleetHistory":{ + "name":"DescribeFleetHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetHistoryRequest"}, + "output":{"shape":"DescribeFleetHistoryResult"}, + "documentation":"

Describes the events for the specified EC2 Fleet during the specified time.

" + }, + "DescribeFleetInstances":{ + "name":"DescribeFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetInstancesRequest"}, + "output":{"shape":"DescribeFleetInstancesResult"}, + "documentation":"

Describes the running instances for the specified EC2 Fleet.

" + }, + "DescribeFleets":{ + "name":"DescribeFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetsRequest"}, + "output":{"shape":"DescribeFleetsResult"}, + "documentation":"

Describes the specified EC2 Fleets or all your EC2 Fleets.

" + }, + "DescribeFlowLogs":{ + "name":"DescribeFlowLogs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFlowLogsRequest"}, + "output":{"shape":"DescribeFlowLogsResult"}, + "documentation":"

Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.

" + }, + "DescribeFpgaImageAttribute":{ + "name":"DescribeFpgaImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFpgaImageAttributeRequest"}, + "output":{"shape":"DescribeFpgaImageAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified Amazon FPGA Image (AFI).

" + }, + "DescribeFpgaImages":{ + "name":"DescribeFpgaImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFpgaImagesRequest"}, + "output":{"shape":"DescribeFpgaImagesResult"}, + "documentation":"

Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions.

" + }, + "DescribeHostReservationOfferings":{ + "name":"DescribeHostReservationOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationOfferingsRequest"}, + "output":{"shape":"DescribeHostReservationOfferingsResult"}, + "documentation":"

Describes the Dedicated Host reservations that are available to purchase.

The results describe all the Dedicated Host reservation offerings, including offerings that may not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts Overview in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeHostReservations":{ + "name":"DescribeHostReservations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostReservationsRequest"}, + "output":{"shape":"DescribeHostReservationsResult"}, + "documentation":"

Describes reservations that are associated with Dedicated Hosts in your account.

" + }, + "DescribeHosts":{ + "name":"DescribeHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHostsRequest"}, + "output":{"shape":"DescribeHostsResult"}, + "documentation":"

Describes the specified Dedicated Hosts or all your Dedicated Hosts.

The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state released.

" + }, + "DescribeIamInstanceProfileAssociations":{ + "name":"DescribeIamInstanceProfileAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIamInstanceProfileAssociationsRequest"}, + "output":{"shape":"DescribeIamInstanceProfileAssociationsResult"}, + "documentation":"

Describes your IAM instance profile associations.

" + }, + "DescribeIdFormat":{ + "name":"DescribeIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdFormatRequest"}, + "output":{"shape":"DescribeIdFormatResult"}, + "documentation":"

Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "DescribeIdentityIdFormat":{ + "name":"DescribeIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIdentityIdFormatRequest"}, + "output":{"shape":"DescribeIdentityIdFormatResult"}, + "documentation":"

Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.

" + }, + "DescribeImageAttribute":{ + "name":"DescribeImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageAttributeRequest"}, + "output":{"shape":"ImageAttribute"}, + "documentation":"

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResult"}, + "documentation":"

Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.

The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.

Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results in an error indicating that the AMI ID cannot be found.

" + }, + "DescribeImportImageTasks":{ + "name":"DescribeImportImageTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportImageTasksRequest"}, + "output":{"shape":"DescribeImportImageTasksResult"}, + "documentation":"

Displays details about an import virtual machine or import snapshot tasks that are already created.

" + }, + "DescribeImportSnapshotTasks":{ + "name":"DescribeImportSnapshotTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImportSnapshotTasksRequest"}, + "output":{"shape":"DescribeImportSnapshotTasksResult"}, + "documentation":"

Describes your import snapshot tasks.

" + }, + "DescribeInstanceAttribute":{ + "name":"DescribeInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAttributeRequest"}, + "output":{"shape":"InstanceAttribute"}, + "documentation":"

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Valid attribute values are: instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport

" + }, + "DescribeInstanceCreditSpecifications":{ + "name":"DescribeInstanceCreditSpecifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceCreditSpecificationsRequest"}, + "output":{"shape":"DescribeInstanceCreditSpecificationsResult"}, + "documentation":"

Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a T2 or T3 instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstanceStatus":{ + "name":"DescribeInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceStatusRequest"}, + "output":{"shape":"DescribeInstanceStatusResult"}, + "documentation":"

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "documentation":"

Describes the specified instances or all of AWS account's instances.

If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the returned results.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally.

" + }, + "DescribeInternetGateways":{ + "name":"DescribeInternetGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInternetGatewaysRequest"}, + "output":{"shape":"DescribeInternetGatewaysResult"}, + "documentation":"

Describes one or more of your internet gateways.

" + }, + "DescribeKeyPairs":{ + "name":"DescribeKeyPairs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyPairsRequest"}, + "output":{"shape":"DescribeKeyPairsResult"}, + "documentation":"

Describes the specified key pairs or all of your key pairs.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeLaunchTemplateVersions":{ + "name":"DescribeLaunchTemplateVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLaunchTemplateVersionsRequest"}, + "output":{"shape":"DescribeLaunchTemplateVersionsResult"}, + "documentation":"

Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions.

" + }, + "DescribeLaunchTemplates":{ + "name":"DescribeLaunchTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLaunchTemplatesRequest"}, + "output":{"shape":"DescribeLaunchTemplatesResult"}, + "documentation":"

Describes one or more launch templates.

" + }, + "DescribeMovingAddresses":{ + "name":"DescribeMovingAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMovingAddressesRequest"}, + "output":{"shape":"DescribeMovingAddressesResult"}, + "documentation":"

Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.

" + }, + "DescribeNatGateways":{ + "name":"DescribeNatGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNatGatewaysRequest"}, + "output":{"shape":"DescribeNatGatewaysResult"}, + "documentation":"

Describes one or more of your NAT gateways.

" + }, + "DescribeNetworkAcls":{ + "name":"DescribeNetworkAcls", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkAclsRequest"}, + "output":{"shape":"DescribeNetworkAclsResult"}, + "documentation":"

Describes one or more of your network ACLs.

For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeNetworkInterfaceAttribute":{ + "name":"DescribeNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfaceAttributeRequest"}, + "output":{"shape":"DescribeNetworkInterfaceAttributeResult"}, + "documentation":"

Describes a network interface attribute. You can specify only one attribute at a time.

" + }, + "DescribeNetworkInterfacePermissions":{ + "name":"DescribeNetworkInterfacePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacePermissionsRequest"}, + "output":{"shape":"DescribeNetworkInterfacePermissionsResult"}, + "documentation":"

Describes the permissions for your network interfaces.

" + }, + "DescribeNetworkInterfaces":{ + "name":"DescribeNetworkInterfaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNetworkInterfacesRequest"}, + "output":{"shape":"DescribeNetworkInterfacesResult"}, + "documentation":"

Describes one or more of your network interfaces.

" + }, + "DescribePlacementGroups":{ + "name":"DescribePlacementGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlacementGroupsRequest"}, + "output":{"shape":"DescribePlacementGroupsResult"}, + "documentation":"

Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribePrefixLists":{ + "name":"DescribePrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrefixListsRequest"}, + "output":{"shape":"DescribePrefixListsResult"}, + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB.

" + }, + "DescribePrincipalIdFormat":{ + "name":"DescribePrincipalIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePrincipalIdFormatRequest"}, + "output":{"shape":"DescribePrincipalIdFormatResult"}, + "documentation":"

Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference.

By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.

The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

" + }, + "DescribePublicIpv4Pools":{ + "name":"DescribePublicIpv4Pools", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePublicIpv4PoolsRequest"}, + "output":{"shape":"DescribePublicIpv4PoolsResult"}, + "documentation":"

Describes the specified IPv4 address pools.

" + }, + "DescribeRegions":{ + "name":"DescribeRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRegionsRequest"}, + "output":{"shape":"DescribeRegionsResult"}, + "documentation":"

Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.

For information about enabling and disabling Regions for your account, see Managing AWS Regions in the AWS General Reference.

" + }, + "DescribeReservedInstances":{ + "name":"DescribeReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesRequest"}, + "output":{"shape":"DescribeReservedInstancesResult"}, + "documentation":"

Describes one or more of the Reserved Instances that you purchased.

For more information about Reserved Instances, see Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesListings":{ + "name":"DescribeReservedInstancesListings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesListingsRequest"}, + "output":{"shape":"DescribeReservedInstancesListingsResult"}, + "documentation":"

Describes your account's Reserved Instance listings in the Reserved Instance Marketplace.

The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.

As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.

As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesModifications":{ + "name":"DescribeReservedInstancesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesModificationsRequest"}, + "output":{"shape":"DescribeReservedInstancesModificationsResult"}, + "documentation":"

Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeReservedInstancesOfferings":{ + "name":"DescribeReservedInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedInstancesOfferingsRequest"}, + "output":{"shape":"DescribeReservedInstancesOfferingsResult"}, + "documentation":"

Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.

If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.

For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeRouteTables":{ + "name":"DescribeRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRouteTablesRequest"}, + "output":{"shape":"DescribeRouteTablesResult"}, + "documentation":"

Describes one or more of your route tables.

Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeScheduledInstanceAvailability":{ + "name":"DescribeScheduledInstanceAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstanceAvailabilityRequest"}, + "output":{"shape":"DescribeScheduledInstanceAvailabilityResult"}, + "documentation":"

Finds available schedules that meet the specified criteria.

You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

After you find a schedule that meets your needs, call PurchaseScheduledInstances to purchase Scheduled Instances with that schedule.

" + }, + "DescribeScheduledInstances":{ + "name":"DescribeScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScheduledInstancesRequest"}, + "output":{"shape":"DescribeScheduledInstancesResult"}, + "documentation":"

Describes the specified Scheduled Instances or all your Scheduled Instances.

" + }, + "DescribeSecurityGroupReferences":{ + "name":"DescribeSecurityGroupReferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupReferencesRequest"}, + "output":{"shape":"DescribeSecurityGroupReferencesResult"}, + "documentation":"

[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.

" + }, + "DescribeSecurityGroups":{ + "name":"DescribeSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityGroupsRequest"}, + "output":{"shape":"DescribeSecurityGroupsResult"}, + "documentation":"

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 Security Groups in the Amazon Elastic Compute Cloud User Guide and Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeSnapshotAttribute":{ + "name":"DescribeSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotAttributeRequest"}, + "output":{"shape":"DescribeSnapshotAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsRequest"}, + "output":{"shape":"DescribeSnapshotsResult"}, + "documentation":"

Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.

The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions.

The create volume permissions fall into the following categories:

  • public: The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

  • explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.

  • implicit: An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners using the OwnerIds option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeSpotDatafeedSubscription":{ + "name":"DescribeSpotDatafeedSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, + "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, + "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + }, + "DescribeSpotFleetInstances":{ + "name":"DescribeSpotFleetInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetInstancesRequest"}, + "output":{"shape":"DescribeSpotFleetInstancesResponse"}, + "documentation":"

Describes the running instances for the specified Spot Fleet.

" + }, + "DescribeSpotFleetRequestHistory":{ + "name":"DescribeSpotFleetRequestHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestHistoryRequest"}, + "output":{"shape":"DescribeSpotFleetRequestHistoryResponse"}, + "documentation":"

Describes the events for the specified Spot Fleet request during the specified time.

Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.

" + }, + "DescribeSpotFleetRequests":{ + "name":"DescribeSpotFleetRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotFleetRequestsRequest"}, + "output":{"shape":"DescribeSpotFleetRequestsResponse"}, + "documentation":"

Describes your Spot Fleet requests.

Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotInstanceRequests":{ + "name":"DescribeSpotInstanceRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotInstanceRequestsRequest"}, + "output":{"shape":"DescribeSpotInstanceRequestsResult"}, + "documentation":"

Describes the specified Spot Instance requests.

You can use DescribeSpotInstanceRequests to find a running Spot Instance by examining the response. If the status of the Spot Instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot.

We recommend that you set MaxResults to a value between 5 and 1000 to limit the number of results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.

Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.

" + }, + "DescribeSpotPriceHistory":{ + "name":"DescribeSpotPriceHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpotPriceHistoryRequest"}, + "output":{"shape":"DescribeSpotPriceHistoryResult"}, + "documentation":"

Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + }, + "DescribeStaleSecurityGroups":{ + "name":"DescribeStaleSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStaleSecurityGroupsRequest"}, + "output":{"shape":"DescribeStaleSecurityGroupsResult"}, + "documentation":"

[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.

" + }, + "DescribeSubnets":{ + "name":"DescribeSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubnetsRequest"}, + "output":{"shape":"DescribeSubnetsResult"}, + "documentation":"

Describes one or more of your subnets.

For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "documentation":"

Describes the specified tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeTrafficMirrorFilters":{ + "name":"DescribeTrafficMirrorFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrafficMirrorFiltersRequest"}, + "output":{"shape":"DescribeTrafficMirrorFiltersResult"}, + "documentation":"

Describes one or more Traffic Mirror filters.

" + }, + "DescribeTrafficMirrorSessions":{ + "name":"DescribeTrafficMirrorSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrafficMirrorSessionsRequest"}, + "output":{"shape":"DescribeTrafficMirrorSessionsResult"}, + "documentation":"

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

" + }, + "DescribeTrafficMirrorTargets":{ + "name":"DescribeTrafficMirrorTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrafficMirrorTargetsRequest"}, + "output":{"shape":"DescribeTrafficMirrorTargetsResult"}, + "documentation":"

Information about one or more Traffic Mirror targets.

" + }, + "DescribeTransitGatewayAttachments":{ + "name":"DescribeTransitGatewayAttachments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTransitGatewayAttachmentsRequest"}, + "output":{"shape":"DescribeTransitGatewayAttachmentsResult"}, + "documentation":"

Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.

" + }, + "DescribeTransitGatewayRouteTables":{ + "name":"DescribeTransitGatewayRouteTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTransitGatewayRouteTablesRequest"}, + "output":{"shape":"DescribeTransitGatewayRouteTablesResult"}, + "documentation":"

Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.

" + }, + "DescribeTransitGatewayVpcAttachments":{ + "name":"DescribeTransitGatewayVpcAttachments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTransitGatewayVpcAttachmentsRequest"}, + "output":{"shape":"DescribeTransitGatewayVpcAttachmentsResult"}, + "documentation":"

Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.

" + }, + "DescribeTransitGateways":{ + "name":"DescribeTransitGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTransitGatewaysRequest"}, + "output":{"shape":"DescribeTransitGatewaysResult"}, + "documentation":"

Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.

" + }, + "DescribeVolumeAttribute":{ + "name":"DescribeVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeAttributeRequest"}, + "output":{"shape":"DescribeVolumeAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified volume. You can specify only one attribute at a time.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumeStatus":{ + "name":"DescribeVolumeStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumeStatusRequest"}, + "output":{"shape":"DescribeVolumeStatusResult"}, + "documentation":"

Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.

The DescribeVolumeStatus operation provides the following information about the specified volumes:

Status: Reflects the current status of the volume. The possible values are ok, impaired , warning, or insufficient-data. If all checks pass, the overall status of the volume is ok. If the check fails, the overall status is impaired. If the status is insufficient-data, then the checks may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide.

Events: Reflect the cause of a volume status and may require you to take action. For example, if your volume returns an impaired status, then the volume event might be potential-data-inconsistency. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and may have inconsistent data.

Actions: Reflect the actions you may have to take in response to an event. For example, if the status of the volume is impaired and the volume event shows potential-data-inconsistency, then the action shows enable-volume-io. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.

Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error state (for example, when a volume is incapable of accepting I/O.)

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "documentation":"

Describes the specified EBS volumes or all of your EBS volumes.

If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.

For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVolumesModifications":{ + "name":"DescribeVolumesModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesModificationsRequest"}, + "output":{"shape":"DescribeVolumesModificationsResult"}, + "documentation":"

Reports the current modification status of EBS volumes.

Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.

You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitoring Volume Modifications\" in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcAttribute":{ + "name":"DescribeVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcAttributeRequest"}, + "output":{"shape":"DescribeVpcAttributeResult"}, + "documentation":"

Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.

" + }, + "DescribeVpcClassicLink":{ + "name":"DescribeVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkRequest"}, + "output":{"shape":"DescribeVpcClassicLinkResult"}, + "documentation":"

Describes the ClassicLink status of one or more VPCs.

" + }, + "DescribeVpcClassicLinkDnsSupport":{ + "name":"DescribeVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DescribeVpcClassicLinkDnsSupportResult"}, + "documentation":"

Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DescribeVpcEndpointConnectionNotifications":{ + "name":"DescribeVpcEndpointConnectionNotifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointConnectionNotificationsRequest"}, + "output":{"shape":"DescribeVpcEndpointConnectionNotificationsResult"}, + "documentation":"

Describes the connection notifications for VPC endpoints and VPC endpoint services.

" + }, + "DescribeVpcEndpointConnections":{ + "name":"DescribeVpcEndpointConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointConnectionsRequest"}, + "output":{"shape":"DescribeVpcEndpointConnectionsResult"}, + "documentation":"

Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.

" + }, + "DescribeVpcEndpointServiceConfigurations":{ + "name":"DescribeVpcEndpointServiceConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServiceConfigurationsRequest"}, + "output":{"shape":"DescribeVpcEndpointServiceConfigurationsResult"}, + "documentation":"

Describes the VPC endpoint service configurations in your account (your services).

" + }, + "DescribeVpcEndpointServicePermissions":{ + "name":"DescribeVpcEndpointServicePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicePermissionsRequest"}, + "output":{"shape":"DescribeVpcEndpointServicePermissionsResult"}, + "documentation":"

Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.

" + }, + "DescribeVpcEndpointServices":{ + "name":"DescribeVpcEndpointServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointServicesRequest"}, + "output":{"shape":"DescribeVpcEndpointServicesResult"}, + "documentation":"

Describes available services to which you can create a VPC endpoint.

" + }, + "DescribeVpcEndpoints":{ + "name":"DescribeVpcEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcEndpointsRequest"}, + "output":{"shape":"DescribeVpcEndpointsResult"}, + "documentation":"

Describes one or more of your VPC endpoints.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsRequest"}, + "output":{"shape":"DescribeVpcPeeringConnectionsResult"}, + "documentation":"

Describes one or more of your VPC peering connections.

" + }, + "DescribeVpcs":{ + "name":"DescribeVpcs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcsRequest"}, + "output":{"shape":"DescribeVpcsResult"}, + "documentation":"

Describes one or more of your VPCs.

" + }, + "DescribeVpnConnections":{ + "name":"DescribeVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnConnectionsRequest"}, + "output":{"shape":"DescribeVpnConnectionsResult"}, + "documentation":"

Describes one or more of your VPN connections.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DescribeVpnGateways":{ + "name":"DescribeVpnGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpnGatewaysRequest"}, + "output":{"shape":"DescribeVpnGatewaysResult"}, + "documentation":"

Describes one or more of your virtual private gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

" + }, + "DetachClassicLinkVpc":{ + "name":"DetachClassicLinkVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachClassicLinkVpcRequest"}, + "output":{"shape":"DetachClassicLinkVpcResult"}, + "documentation":"

Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped.

" + }, + "DetachInternetGateway":{ + "name":"DetachInternetGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInternetGatewayRequest"}, + "documentation":"

Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses.

" + }, + "DetachNetworkInterface":{ + "name":"DetachNetworkInterface", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachNetworkInterfaceRequest"}, + "documentation":"

Detaches a network interface from an instance.

" + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeRequest"}, + "output":{"shape":"VolumeAttachment"}, + "documentation":"

Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the busy state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first.

When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.

For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DetachVpnGateway":{ + "name":"DetachVpnGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVpnGatewayRequest"}, + "documentation":"

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described).

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway.

" + }, + "DisableEbsEncryptionByDefault":{ + "name":"DisableEbsEncryptionByDefault", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableEbsEncryptionByDefaultRequest"}, + "output":{"shape":"DisableEbsEncryptionByDefaultResult"}, + "documentation":"

Disables EBS encryption by default for your account in the current Region.

After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume.

Disabling encryption by default does not change the encryption status of your existing volumes.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisableTransitGatewayRouteTablePropagation":{ + "name":"DisableTransitGatewayRouteTablePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableTransitGatewayRouteTablePropagationRequest"}, + "output":{"shape":"DisableTransitGatewayRouteTablePropagationResult"}, + "documentation":"

Disables the specified resource attachment from propagating routes to the specified propagation route table.

" + }, + "DisableVgwRoutePropagation":{ + "name":"DisableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVgwRoutePropagationRequest"}, + "documentation":"

Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.

" + }, + "DisableVpcClassicLink":{ + "name":"DisableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkRequest"}, + "output":{"shape":"DisableVpcClassicLinkResult"}, + "documentation":"

Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.

" + }, + "DisableVpcClassicLinkDnsSupport":{ + "name":"DisableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"DisableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisassociateAddress":{ + "name":"DisassociateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAddressRequest"}, + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + }, + "DisassociateClientVpnTargetNetwork":{ + "name":"DisassociateClientVpnTargetNetwork", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateClientVpnTargetNetworkRequest"}, + "output":{"shape":"DisassociateClientVpnTargetNetworkResult"}, + "documentation":"

Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens:

  • The route that was automatically added for the VPC is deleted

  • All active client connections are terminated

  • New client connections are disallowed

  • The Client VPN endpoint's status changes to pending-associate

" + }, + "DisassociateIamInstanceProfile":{ + "name":"DisassociateIamInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateIamInstanceProfileRequest"}, + "output":{"shape":"DisassociateIamInstanceProfileResult"}, + "documentation":"

Disassociates an IAM instance profile from a running or stopped instance.

Use DescribeIamInstanceProfileAssociations to get the association ID.

" + }, + "DisassociateRouteTable":{ + "name":"DisassociateRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateRouteTableRequest"}, + "documentation":"

Disassociates a subnet from a route table.

After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "DisassociateSubnetCidrBlock":{ + "name":"DisassociateSubnetCidrBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateSubnetCidrBlockRequest"}, + "output":{"shape":"DisassociateSubnetCidrBlockResult"}, + "documentation":"

Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

" + }, + "DisassociateTransitGatewayRouteTable":{ + "name":"DisassociateTransitGatewayRouteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateTransitGatewayRouteTableRequest"}, + "output":{"shape":"DisassociateTransitGatewayRouteTableResult"}, + "documentation":"

Disassociates a resource attachment from a transit gateway route table.

" + }, + "DisassociateVpcCidrBlock":{ + "name":"DisassociateVpcCidrBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateVpcCidrBlockRequest"}, + "output":{"shape":"DisassociateVpcCidrBlockResult"}, + "documentation":"

Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using DescribeVpcs. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.

You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block).

" + }, + "EnableEbsEncryptionByDefault":{ + "name":"EnableEbsEncryptionByDefault", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableEbsEncryptionByDefaultRequest"}, + "output":{"shape":"EnableEbsEncryptionByDefaultResult"}, + "documentation":"

Enables EBS encryption by default for your account in the current Region.

After you enable encryption by default, the EBS volumes that you create are are always encrypted, either using the default CMK or the CMK that you specified when you created each volume. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

You can specify the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

Enabling encryption by default has no effect on the encryption status of your existing volumes.

After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see Supported Instance Types.

" + }, + "EnableTransitGatewayRouteTablePropagation":{ + "name":"EnableTransitGatewayRouteTablePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableTransitGatewayRouteTablePropagationRequest"}, + "output":{"shape":"EnableTransitGatewayRouteTablePropagationResult"}, + "documentation":"

Enables the specified attachment to propagate routes to the specified propagation route table.

" + }, + "EnableVgwRoutePropagation":{ + "name":"EnableVgwRoutePropagation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVgwRoutePropagationRequest"}, + "documentation":"

Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.

" + }, + "EnableVolumeIO":{ + "name":"EnableVolumeIO", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVolumeIORequest"}, + "documentation":"

Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.

" + }, + "EnableVpcClassicLink":{ + "name":"EnableVpcClassicLink", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkRequest"}, + "output":{"shape":"EnableVpcClassicLinkResult"}, + "documentation":"

Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the 10.0.0.0/8 IP address range, excluding local routes for VPCs in the 10.0.0.0/16 and 10.1.0.0/16 IP address ranges. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EnableVpcClassicLinkDnsSupport":{ + "name":"EnableVpcClassicLinkDnsSupport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableVpcClassicLinkDnsSupportRequest"}, + "output":{"shape":"EnableVpcClassicLinkDnsSupportResult"}, + "documentation":"

Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ExportClientVpnClientCertificateRevocationList":{ + "name":"ExportClientVpnClientCertificateRevocationList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportClientVpnClientCertificateRevocationListRequest"}, + "output":{"shape":"ExportClientVpnClientCertificateRevocationListResult"}, + "documentation":"

Downloads the client certificate revocation list for the specified Client VPN endpoint.

" + }, + "ExportClientVpnClientConfiguration":{ + "name":"ExportClientVpnClientConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportClientVpnClientConfigurationRequest"}, + "output":{"shape":"ExportClientVpnClientConfigurationResult"}, + "documentation":"

Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint.

" + }, + "ExportImage":{ + "name":"ExportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportImageRequest"}, + "output":{"shape":"ExportImageResult"}, + "documentation":"

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM Directory from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.

" + }, + "ExportTransitGatewayRoutes":{ + "name":"ExportTransitGatewayRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportTransitGatewayRoutesRequest"}, + "output":{"shape":"ExportTransitGatewayRoutesResult"}, + "documentation":"

Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.

" + }, + "GetCapacityReservationUsage":{ + "name":"GetCapacityReservationUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCapacityReservationUsageRequest"}, + "output":{"shape":"GetCapacityReservationUsageResult"}, + "documentation":"

Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.

" + }, + "GetConsoleOutput":{ + "name":"GetConsoleOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleOutputRequest"}, + "output":{"shape":"GetConsoleOutputResult"}, + "documentation":"

Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.

By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.

You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.

For more information, see Instance Console Output in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetConsoleScreenshot":{ + "name":"GetConsoleScreenshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConsoleScreenshotRequest"}, + "output":{"shape":"GetConsoleScreenshotResult"}, + "documentation":"

Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.

The returned content is Base64-encoded.

" + }, + "GetEbsDefaultKmsKeyId":{ + "name":"GetEbsDefaultKmsKeyId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEbsDefaultKmsKeyIdRequest"}, + "output":{"shape":"GetEbsDefaultKmsKeyIdResult"}, + "documentation":"

Describes the default customer master key (CMK) for EBS encryption by default for your account in this Region. You can change the default CMK for encryption by default using ModifyEbsDefaultKmsKeyId or ResetEbsDefaultKmsKeyId.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetEbsEncryptionByDefault":{ + "name":"GetEbsEncryptionByDefault", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEbsEncryptionByDefaultRequest"}, + "output":{"shape":"GetEbsEncryptionByDefaultResult"}, + "documentation":"

Describes whether EBS encryption by default is enabled for your account in the current Region.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "GetHostReservationPurchasePreview":{ + "name":"GetHostReservationPurchasePreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostReservationPurchasePreviewRequest"}, + "output":{"shape":"GetHostReservationPurchasePreviewResult"}, + "documentation":"

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

" + }, + "GetLaunchTemplateData":{ + "name":"GetLaunchTemplateData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLaunchTemplateDataRequest"}, + "output":{"shape":"GetLaunchTemplateDataResult"}, + "documentation":"

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

" + }, + "GetPasswordData":{ + "name":"GetPasswordData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPasswordDataRequest"}, + "output":{"shape":"GetPasswordDataResult"}, + "documentation":"

Retrieves the encrypted administrator password for a running Windows instance.

The Windows password is generated at boot by the EC2Config service or EC2Launch scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see EC2Config and EC2Launch in the Amazon Elastic Compute Cloud User Guide.

For the EC2Config service, the password is not generated for rebundled AMIs unless Ec2SetPassword is enabled before bundling.

The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file.

When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password.

" + }, + "GetReservedInstancesExchangeQuote":{ + "name":"GetReservedInstancesExchangeQuote", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservedInstancesExchangeQuoteRequest"}, + "output":{"shape":"GetReservedInstancesExchangeQuoteResult"}, + "documentation":"

Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

" + }, + "GetTransitGatewayAttachmentPropagations":{ + "name":"GetTransitGatewayAttachmentPropagations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTransitGatewayAttachmentPropagationsRequest"}, + "output":{"shape":"GetTransitGatewayAttachmentPropagationsResult"}, + "documentation":"

Lists the route tables to which the specified resource attachment propagates routes.

" + }, + "GetTransitGatewayRouteTableAssociations":{ + "name":"GetTransitGatewayRouteTableAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTransitGatewayRouteTableAssociationsRequest"}, + "output":{"shape":"GetTransitGatewayRouteTableAssociationsResult"}, + "documentation":"

Gets information about the associations for the specified transit gateway route table.

" + }, + "GetTransitGatewayRouteTablePropagations":{ + "name":"GetTransitGatewayRouteTablePropagations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTransitGatewayRouteTablePropagationsRequest"}, + "output":{"shape":"GetTransitGatewayRouteTablePropagationsResult"}, + "documentation":"

Gets information about the route table propagations for the specified transit gateway route table.

" + }, + "ImportClientVpnClientCertificateRevocationList":{ + "name":"ImportClientVpnClientCertificateRevocationList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportClientVpnClientCertificateRevocationListRequest"}, + "output":{"shape":"ImportClientVpnClientCertificateRevocationListResult"}, + "documentation":"

Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list.

Uploading a client certificate revocation list resets existing client connections.

" + }, + "ImportImage":{ + "name":"ImportImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportImageRequest"}, + "output":{"shape":"ImportImageResult"}, + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.

" + }, + "ImportInstance":{ + "name":"ImportInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstanceRequest"}, + "output":{"shape":"ImportInstanceResult"}, + "documentation":"

Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ImportKeyPair":{ + "name":"ImportKeyPair", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyPairRequest"}, + "output":{"shape":"ImportKeyPairResult"}, + "documentation":"

Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.

For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ImportSnapshot":{ + "name":"ImportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSnapshotRequest"}, + "output":{"shape":"ImportSnapshotResult"}, + "documentation":"

Imports a disk into an EBS snapshot.

" + }, + "ImportVolume":{ + "name":"ImportVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportVolumeRequest"}, + "output":{"shape":"ImportVolumeResult"}, + "documentation":"

Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.

For information about the import manifest referenced by this API action, see VM Import Manifest.

" + }, + "ModifyCapacityReservation":{ + "name":"ModifyCapacityReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCapacityReservationRequest"}, + "output":{"shape":"ModifyCapacityReservationResult"}, + "documentation":"

Modifies a Capacity Reservation's capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation's instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.

" + }, + "ModifyClientVpnEndpoint":{ + "name":"ModifyClientVpnEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClientVpnEndpointRequest"}, + "output":{"shape":"ModifyClientVpnEndpointResult"}, + "documentation":"

Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.

" + }, + "ModifyEbsDefaultKmsKeyId":{ + "name":"ModifyEbsDefaultKmsKeyId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEbsDefaultKmsKeyIdRequest"}, + "output":{"shape":"ModifyEbsDefaultKmsKeyIdResult"}, + "documentation":"

Changes the default customer master key (CMK) for EBS encryption by default for your account in this Region.

AWS creates a unique AWS managed CMK in each Region for use with encryption by default. If you change the default CMK to a customer managed CMK, it is used instead of the AWS managed CMK. To reset the default CMK to the AWS managed CMK for EBS, use ResetEbsDefaultKmsKeyId.

If you delete or disable the customer managed CMK that you specified for use with encryption by default, your instances will fail to launch.

For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyFleet":{ + "name":"ModifyFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyFleetRequest"}, + "output":{"shape":"ModifyFleetResult"}, + "documentation":"

Modifies the specified EC2 Fleet.

You can only modify an EC2 Fleet request of type maintain.

While the EC2 Fleet is being modified, it is in the modifying state.

To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is lowest-price, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowest-price, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacity-optimized, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0.

" + }, + "ModifyFpgaImageAttribute":{ + "name":"ModifyFpgaImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyFpgaImageAttributeRequest"}, + "output":{"shape":"ModifyFpgaImageAttributeResult"}, + "documentation":"

Modifies the specified attribute of the specified Amazon FPGA Image (AFI).

" + }, + "ModifyHosts":{ + "name":"ModifyHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyHostsRequest"}, + "output":{"shape":"ModifyHostsResult"}, + "documentation":"

Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of host but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled.

" + }, + "ModifyIdFormat":{ + "name":"ModifyIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdFormatRequest"}, + "documentation":"

Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyIdentityIdFormat":{ + "name":"ModifyIdentityIdFormat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyIdentityIdFormatRequest"}, + "documentation":"

Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created.

This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.

This setting applies to the principal specified in the request; it does not apply to the principal that makes the request.

Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.

" + }, + "ModifyImageAttribute":{ + "name":"ModifyImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyImageAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode.

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

" + }, + "ModifyInstanceAttribute":{ + "name":"ModifyInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstanceCapacityReservationAttributes":{ + "name":"ModifyInstanceCapacityReservationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceCapacityReservationAttributesRequest"}, + "output":{"shape":"ModifyInstanceCapacityReservationAttributesResult"}, + "documentation":"

Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.

" + }, + "ModifyInstanceCreditSpecification":{ + "name":"ModifyInstanceCreditSpecification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceCreditSpecificationRequest"}, + "output":{"shape":"ModifyInstanceCreditSpecificationResult"}, + "documentation":"

Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyInstanceEventStartTime":{ + "name":"ModifyInstanceEventStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceEventStartTimeRequest"}, + "output":{"shape":"ModifyInstanceEventStartTimeResult"}, + "documentation":"

Modifies the start time for a scheduled Amazon EC2 instance event.

" + }, + "ModifyInstancePlacement":{ + "name":"ModifyInstancePlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstancePlacementRequest"}, + "output":{"shape":"ModifyInstancePlacementResult"}, + "documentation":"

Modifies the placement attributes for a specified instance. You can do the following:

  • Modify the affinity between an instance and a Dedicated Host. When affinity is set to host and the instance is not associated with a specific Dedicated Host, the next time the instance is launched, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists.

  • Change the Dedicated Host with which an instance is associated.

  • Change the instance tenancy of an instance from host to dedicated, or from dedicated to host.

  • Move an instance to or from a placement group.

At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request.

To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the stopped state.

" + }, + "ModifyLaunchTemplate":{ + "name":"ModifyLaunchTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyLaunchTemplateRequest"}, + "output":{"shape":"ModifyLaunchTemplateResult"}, + "documentation":"

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

" + }, + "ModifyNetworkInterfaceAttribute":{ + "name":"ModifyNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyNetworkInterfaceAttributeRequest"}, + "documentation":"

Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance.

" + }, + "ModifyReservedInstances":{ + "name":"ModifyReservedInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReservedInstancesRequest"}, + "output":{"shape":"ModifyReservedInstancesResult"}, + "documentation":"

Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.

For more information, see Modifying Reserved Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySnapshotAttribute":{ + "name":"ModifySnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotAttributeRequest"}, + "documentation":"

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifySpotFleetRequest":{ + "name":"ModifySpotFleetRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySpotFleetRequestRequest"}, + "output":{"shape":"ModifySpotFleetRequestResponse"}, + "documentation":"

Modifies the specified Spot Fleet request.

You can only modify a Spot Fleet request of type maintain.

While the Spot Fleet request is being modified, it is in the modifying state.

To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is lowestPrice, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is lowestPrice, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is capacityOptimized, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is diversified, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually.

If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0.

" + }, + "ModifySubnetAttribute":{ + "name":"ModifySubnetAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySubnetAttributeRequest"}, + "documentation":"

Modifies a subnet attribute. You can only modify one attribute at a time.

" + }, + "ModifyTrafficMirrorFilterNetworkServices":{ + "name":"ModifyTrafficMirrorFilterNetworkServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTrafficMirrorFilterNetworkServicesRequest"}, + "output":{"shape":"ModifyTrafficMirrorFilterNetworkServicesResult"}, + "documentation":"

Allows or restricts mirroring network services.

By default, Amazon DNS network services are not eligible for Traffic Mirror. Use AddNetworkServices to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use RemoveNetworkServices to remove the network services from the Traffic Mirror filter.

For information about filter rule properties, see Network Services in the Traffic Mirroring User Guide .

" + }, + "ModifyTrafficMirrorFilterRule":{ + "name":"ModifyTrafficMirrorFilterRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTrafficMirrorFilterRuleRequest"}, + "output":{"shape":"ModifyTrafficMirrorFilterRuleResult"}, + "documentation":"

Modifies the specified Traffic Mirror rule.

DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.

" + }, + "ModifyTrafficMirrorSession":{ + "name":"ModifyTrafficMirrorSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTrafficMirrorSessionRequest"}, + "output":{"shape":"ModifyTrafficMirrorSessionResult"}, + "documentation":"

Modifies a Traffic Mirror session.

" + }, + "ModifyTransitGatewayVpcAttachment":{ + "name":"ModifyTransitGatewayVpcAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTransitGatewayVpcAttachmentRequest"}, + "output":{"shape":"ModifyTransitGatewayVpcAttachmentResult"}, + "documentation":"

Modifies the specified VPC attachment.

" + }, + "ModifyVolume":{ + "name":"ModifyVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeRequest"}, + "output":{"shape":"ModifyVolumeResult"}, + "documentation":"

You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending a Windows File System.

You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitoring Volume Modifications.

With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows.

If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.

" + }, + "ModifyVolumeAttribute":{ + "name":"ModifyVolumeAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVolumeAttributeRequest"}, + "documentation":"

Modifies a volume attribute.

By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.

You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.

" + }, + "ModifyVpcAttribute":{ + "name":"ModifyVpcAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcAttributeRequest"}, + "documentation":"

Modifies the specified attribute of the specified VPC.

" + }, + "ModifyVpcEndpoint":{ + "name":"ModifyVpcEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointRequest"}, + "output":{"shape":"ModifyVpcEndpointResult"}, + "documentation":"

Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.

" + }, + "ModifyVpcEndpointConnectionNotification":{ + "name":"ModifyVpcEndpointConnectionNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointConnectionNotificationRequest"}, + "output":{"shape":"ModifyVpcEndpointConnectionNotificationResult"}, + "documentation":"

Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified.

" + }, + "ModifyVpcEndpointServiceConfiguration":{ + "name":"ModifyVpcEndpointServiceConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointServiceConfigurationRequest"}, + "output":{"shape":"ModifyVpcEndpointServiceConfigurationResult"}, + "documentation":"

Modifies the attributes of your VPC endpoint service configuration. You can change the Network Load Balancers for your service, and you can specify whether acceptance is required for requests to connect to your endpoint service through an interface VPC endpoint.

" + }, + "ModifyVpcEndpointServicePermissions":{ + "name":"ModifyVpcEndpointServicePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcEndpointServicePermissionsRequest"}, + "output":{"shape":"ModifyVpcEndpointServicePermissionsResult"}, + "documentation":"

Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) to connect to your endpoint service.

If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved.

" + }, + "ModifyVpcPeeringConnectionOptions":{ + "name":"ModifyVpcPeeringConnectionOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcPeeringConnectionOptionsRequest"}, + "output":{"shape":"ModifyVpcPeeringConnectionOptionsResult"}, + "documentation":"

Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:

  • Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.

  • Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.

  • Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.

" + }, + "ModifyVpcTenancy":{ + "name":"ModifyVpcTenancy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpcTenancyRequest"}, + "output":{"shape":"ModifyVpcTenancyResult"}, + "documentation":"

Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to default only. You cannot change the instance tenancy attribute to dedicated.

After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of default, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected.

For more information, see Dedicated Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ModifyVpnConnection":{ + "name":"ModifyVpnConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpnConnectionRequest"}, + "output":{"shape":"ModifyVpnConnectionResult"}, + "documentation":"

Modifies the target gateway of an AWS Site-to-Site VPN connection. The following migration options are available:

  • An existing virtual private gateway to a new virtual private gateway

  • An existing virtual private gateway to a transit gateway

  • An existing transit gateway to a new transit gateway

  • An existing transit gateway to a virtual private gateway

Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.

This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.

You must delete the static routes before you migrate to the new gateway.

Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.

After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.

When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.

If you deleted VPN static routes, you must add the static routes to the transit gateway route table.

After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints

" + }, + "ModifyVpnTunnelCertificate":{ + "name":"ModifyVpnTunnelCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpnTunnelCertificateRequest"}, + "output":{"shape":"ModifyVpnTunnelCertificateResult"}, + "documentation":"

Modifies the VPN tunnel endpoint certificate.

" + }, + "ModifyVpnTunnelOptions":{ + "name":"ModifyVpnTunnelOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyVpnTunnelOptionsRequest"}, + "output":{"shape":"ModifyVpnTunnelOptionsResult"}, + "documentation":"

Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see Site-to-Site VPN Tunnel Options for Your Site-to-Site VPN Connection in the AWS Site-to-Site VPN User Guide.

" + }, + "MonitorInstances":{ + "name":"MonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MonitorInstancesRequest"}, + "output":{"shape":"MonitorInstancesResult"}, + "documentation":"

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

" + }, + "MoveAddressToVpc":{ + "name":"MoveAddressToVpc", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAddressToVpcRequest"}, + "output":{"shape":"MoveAddressToVpcResult"}, + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

" + }, + "ProvisionByoipCidr":{ + "name":"ProvisionByoipCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ProvisionByoipCidrRequest"}, + "output":{"shape":"ProvisionByoipCidrResult"}, + "documentation":"

Provisions an address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.

AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.

Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.

" + }, + "PurchaseHostReservation":{ + "name":"PurchaseHostReservation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseHostReservationRequest"}, + "output":{"shape":"PurchaseHostReservationResult"}, + "documentation":"

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

" + }, + "PurchaseReservedInstancesOffering":{ + "name":"PurchaseReservedInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedInstancesOfferingRequest"}, + "output":{"shape":"PurchaseReservedInstancesOfferingResult"}, + "documentation":"

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.

" + }, + "PurchaseScheduledInstances":{ + "name":"PurchaseScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseScheduledInstancesRequest"}, + "output":{"shape":"PurchaseScheduledInstancesResult"}, + "documentation":"

Purchases the Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

" + }, + "RebootInstances":{ + "name":"RebootInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstancesRequest"}, + "documentation":"

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RegisterImage":{ + "name":"RegisterImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterImageRequest"}, + "output":{"shape":"RegisterImageResult"}, + "documentation":"

Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.

For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.

You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.

You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.

Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, do the following:

  1. Launch an instance from an existing AMI with that billing product code.

  2. Customize the instance.

  3. Create a new AMI from the instance using CreateImage to preserve the billing product code association.

If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance.

If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.

" + }, + "RejectTransitGatewayVpcAttachment":{ + "name":"RejectTransitGatewayVpcAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectTransitGatewayVpcAttachmentRequest"}, + "output":{"shape":"RejectTransitGatewayVpcAttachmentResult"}, + "documentation":"

Rejects a request to attach a VPC to a transit gateway.

The VPC attachment must be in the pendingAcceptance state. Use DescribeTransitGatewayVpcAttachments to view your pending VPC attachment requests. Use AcceptTransitGatewayVpcAttachment to accept a VPC attachment request.

" + }, + "RejectVpcEndpointConnections":{ + "name":"RejectVpcEndpointConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcEndpointConnectionsRequest"}, + "output":{"shape":"RejectVpcEndpointConnectionsResult"}, + "documentation":"

Rejects one or more VPC endpoint connection requests to your VPC endpoint service.

" + }, + "RejectVpcPeeringConnection":{ + "name":"RejectVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectVpcPeeringConnectionRequest"}, + "output":{"shape":"RejectVpcPeeringConnectionResult"}, + "documentation":"

Rejects a VPC peering connection request. The VPC peering connection must be in the pending-acceptance state. Use the DescribeVpcPeeringConnections request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use DeleteVpcPeeringConnection.

" + }, + "ReleaseAddress":{ + "name":"ReleaseAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseAddressRequest"}, + "documentation":"

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another AWS account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

" + }, + "ReleaseHosts":{ + "name":"ReleaseHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReleaseHostsRequest"}, + "output":{"shape":"ReleaseHostsResult"}, + "documentation":"

When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into released state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released.

When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again.

Released hosts still appear in a DescribeHosts response.

" + }, + "ReplaceIamInstanceProfileAssociation":{ + "name":"ReplaceIamInstanceProfileAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceIamInstanceProfileAssociationRequest"}, + "output":{"shape":"ReplaceIamInstanceProfileAssociationResult"}, + "documentation":"

Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use DescribeIamInstanceProfileAssociations to get the association ID.

" + }, + "ReplaceNetworkAclAssociation":{ + "name":"ReplaceNetworkAclAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclAssociationRequest"}, + "output":{"shape":"ReplaceNetworkAclAssociationResult"}, + "documentation":"

Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

This is an idempotent operation.

" + }, + "ReplaceNetworkAclEntry":{ + "name":"ReplaceNetworkAclEntry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceNetworkAclEntryRequest"}, + "documentation":"

Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRoute":{ + "name":"ReplaceRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteRequest"}, + "documentation":"

Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.

For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.

" + }, + "ReplaceRouteTableAssociation":{ + "name":"ReplaceRouteTableAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceRouteTableAssociationRequest"}, + "output":{"shape":"ReplaceRouteTableAssociationResult"}, + "documentation":"

Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.

You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.

" + }, + "ReplaceTransitGatewayRoute":{ + "name":"ReplaceTransitGatewayRoute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReplaceTransitGatewayRouteRequest"}, + "output":{"shape":"ReplaceTransitGatewayRouteResult"}, + "documentation":"

Replaces the specified route in the specified transit gateway route table.

" + }, + "ReportInstanceStatus":{ + "name":"ReportInstanceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReportInstanceStatusRequest"}, + "documentation":"

Submits feedback about the status of an instance. The instance must be in the running state. If your experience with the instance differs from the instance status returned by DescribeInstanceStatus, use ReportInstanceStatus to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by DescribeInstanceStatus.

" + }, + "RequestSpotFleet":{ + "name":"RequestSpotFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotFleetRequest"}, + "output":{"shape":"RequestSpotFleetResponse"}, + "documentation":"

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported.

For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances.

" + }, + "RequestSpotInstances":{ + "name":"RequestSpotInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestSpotInstancesRequest"}, + "output":{"shape":"RequestSpotInstancesResult"}, + "documentation":"

Creates a Spot Instance request.

For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances.

" + }, + "ResetEbsDefaultKmsKeyId":{ + "name":"ResetEbsDefaultKmsKeyId", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetEbsDefaultKmsKeyIdRequest"}, + "output":{"shape":"ResetEbsDefaultKmsKeyIdResult"}, + "documentation":"

Resets the default customer master key (CMK) for EBS encryption for your account in this Region to the AWS managed CMK for EBS.

After resetting the default CMK to the AWS managed CMK, you can continue to encrypt by a customer managed CMK by specifying it when you create the volume. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ResetFpgaImageAttribute":{ + "name":"ResetFpgaImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetFpgaImageAttributeRequest"}, + "output":{"shape":"ResetFpgaImageAttributeResult"}, + "documentation":"

Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

" + }, + "ResetImageAttribute":{ + "name":"ResetImageAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetImageAttributeRequest"}, + "documentation":"

Resets an attribute of an AMI to its default value.

The productCodes attribute can't be reset.

" + }, + "ResetInstanceAttribute":{ + "name":"ResetInstanceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetInstanceAttributeRequest"}, + "documentation":"

Resets an attribute of an instance to its default value. To reset the kernel or ramdisk, the instance must be in a stopped state. To reset the sourceDestCheck, the instance can be either running or stopped.

The sourceDestCheck attribute controls whether source/destination checking is enabled. The default value is true, which means checking is enabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

" + }, + "ResetNetworkInterfaceAttribute":{ + "name":"ResetNetworkInterfaceAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetNetworkInterfaceAttributeRequest"}, + "documentation":"

Resets a network interface attribute. You can specify only one attribute at a time.

" + }, + "ResetSnapshotAttribute":{ + "name":"ResetSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetSnapshotAttributeRequest"}, + "documentation":"

Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RestoreAddressToClassic":{ + "name":"RestoreAddressToClassic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreAddressToClassicRequest"}, + "output":{"shape":"RestoreAddressToClassicResult"}, + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" + }, + "RevokeClientVpnIngress":{ + "name":"RevokeClientVpnIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeClientVpnIngressRequest"}, + "output":{"shape":"RevokeClientVpnIngressResult"}, + "documentation":"

Removes an ingress authorization rule from a Client VPN endpoint.

" + }, + "RevokeSecurityGroupEgress":{ + "name":"RevokeSecurityGroupEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupEgressRequest"}, + "documentation":"

[VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RevokeSecurityGroupIngress":{ + "name":"RevokeSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSecurityGroupIngressRequest"}, + "documentation":"

Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.

[EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed.

Each rule consists of the protocol and the CIDR range or source security group. For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not have to specify the description to revoke the rule.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

" + }, + "RunInstances":{ + "name":"RunInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunInstancesRequest"}, + "output":{"shape":"Reservation"}, + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance Types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "RunScheduledInstances":{ + "name":"RunScheduledInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunScheduledInstancesRequest"}, + "output":{"shape":"RunScheduledInstancesResult"}, + "documentation":"

Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "SearchTransitGatewayRoutes":{ + "name":"SearchTransitGatewayRoutes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchTransitGatewayRoutesRequest"}, + "output":{"shape":"SearchTransitGatewayRoutesResult"}, + "documentation":"

Searches for routes in the specified transit gateway route table.

" + }, + "SendDiagnosticInterrupt":{ + "name":"SendDiagnosticInterrupt", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendDiagnosticInterruptRequest"}, + "documentation":"

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a Diagnostic Interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).

" + }, + "StartInstances":{ + "name":"StartInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstancesRequest"}, + "output":{"shape":"StartInstancesResult"}, + "documentation":"

Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + }, + "StopInstances":{ + "name":"StopInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstancesRequest"}, + "output":{"shape":"StopInstancesResult"}, + "documentation":"

Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "TerminateClientVpnConnections":{ + "name":"TerminateClientVpnConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateClientVpnConnectionsRequest"}, + "output":{"shape":"TerminateClientVpnConnectionsResult"}, + "documentation":"

Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

" + }, + "TerminateInstances":{ + "name":"TerminateInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateInstancesRequest"}, + "output":{"shape":"TerminateInstancesResult"}, + "documentation":"

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UnassignIpv6Addresses":{ + "name":"UnassignIpv6Addresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignIpv6AddressesRequest"}, + "output":{"shape":"UnassignIpv6AddressesResult"}, + "documentation":"

Unassigns one or more IPv6 addresses from a network interface.

" + }, + "UnassignPrivateIpAddresses":{ + "name":"UnassignPrivateIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignPrivateIpAddressesRequest"}, + "documentation":"

Unassigns one or more secondary private IP addresses from a network interface.

" + }, + "UnmonitorInstances":{ + "name":"UnmonitorInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnmonitorInstancesRequest"}, + "output":{"shape":"UnmonitorInstancesResult"}, + "documentation":"

Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + }, + "UpdateSecurityGroupRuleDescriptionsEgress":{ + "name":"UpdateSecurityGroupRuleDescriptionsEgress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecurityGroupRuleDescriptionsEgressRequest"}, + "output":{"shape":"UpdateSecurityGroupRuleDescriptionsEgressResult"}, + "documentation":"

[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

" + }, + "UpdateSecurityGroupRuleDescriptionsIngress":{ + "name":"UpdateSecurityGroupRuleDescriptionsIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecurityGroupRuleDescriptionsIngressRequest"}, + "output":{"shape":"UpdateSecurityGroupRuleDescriptionsIngressResult"}, + "documentation":"

Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously.

You specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.

" + }, + "WithdrawByoipCidr":{ + "name":"WithdrawByoipCidr", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"WithdrawByoipCidrRequest"}, + "output":{"shape":"WithdrawByoipCidrResult"}, + "documentation":"

Stops advertising an IPv4 address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays.

" + } + }, + "shapes":{ + "AcceptReservedInstancesExchangeQuoteRequest":{ + "type":"structure", + "required":["ReservedInstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstanceIds":{ + "shape":"ReservedInstanceIdSet", + "documentation":"

The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

", + "locationName":"ReservedInstanceId" + }, + "TargetConfigurations":{ + "shape":"TargetConfigurationRequestSet", + "documentation":"

The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

", + "locationName":"TargetConfiguration" + } + }, + "documentation":"

Contains the parameters for accepting the quote.

" + }, + "AcceptReservedInstancesExchangeQuoteResult":{ + "type":"structure", + "members":{ + "ExchangeId":{ + "shape":"String", + "documentation":"

The ID of the successful exchange.

", + "locationName":"exchangeId" + } + }, + "documentation":"

The result of the exchange and whether it was successful.

" + }, + "AcceptTransitGatewayVpcAttachmentRequest":{ + "type":"structure", + "required":["TransitGatewayAttachmentId"], + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AcceptTransitGatewayVpcAttachmentResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachment":{ + "shape":"TransitGatewayVpcAttachment", + "documentation":"

The VPC attachment.

", + "locationName":"transitGatewayVpcAttachment" + } + } + }, + "AcceptVpcEndpointConnectionsRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "VpcEndpointIds" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"ServiceId", + "documentation":"

The ID of the endpoint service.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more interface VPC endpoints.

", + "locationName":"VpcEndpointId" + } + } + }, + "AcceptVpcEndpointConnectionsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the interface endpoints that were not accepted, if applicable.

", + "locationName":"unsuccessful" + } + } + }, + "AcceptVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of the VPC peering connection. You must specify this parameter in the request.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "AcceptVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the account attribute.

", + "locationName":"attributeName" + }, + "AttributeValues":{ + "shape":"AccountAttributeValueList", + "documentation":"

The values for the account attribute.

", + "locationName":"attributeValueSet" + } + }, + "documentation":"

Describes an account attribute.

" + }, + "AccountAttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"item" + } + }, + "AccountAttributeName":{ + "type":"string", + "enum":[ + "supported-platforms", + "default-vpc" + ] + }, + "AccountAttributeNameStringList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeName", + "locationName":"attributeName" + } + }, + "AccountAttributeValue":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute.

", + "locationName":"attributeValue" + } + }, + "documentation":"

Describes a value of an account attribute.

" + }, + "AccountAttributeValueList":{ + "type":"list", + "member":{ + "shape":"AccountAttributeValue", + "locationName":"item" + } + }, + "ActiveInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "InstanceHealth":{ + "shape":"InstanceHealthStatus", + "documentation":"

The health status of the instance. If the status of either the instance status check or the system status check is impaired, the health status of the instance is unhealthy. Otherwise, the health status is healthy.

", + "locationName":"instanceHealth" + } + }, + "documentation":"

Describes a running instance in a Spot Fleet.

" + }, + "ActiveInstanceSet":{ + "type":"list", + "member":{ + "shape":"ActiveInstance", + "locationName":"item" + } + }, + "ActivityStatus":{ + "type":"string", + "enum":[ + "error", + "pending_fulfillment", + "pending_termination", + "fulfilled" + ] + }, + "Address":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is associated with (if any).

", + "locationName":"instanceId" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

The ID representing the allocation of the address for use with EC2-VPC.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID representing the association of the address with an instance in a VPC.

", + "locationName":"associationId" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "NetworkInterfaceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network interface.

", + "locationName":"networkInterfaceOwnerId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIpAddress" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Elastic IP address.

", + "locationName":"tagSet" + }, + "PublicIpv4Pool":{ + "shape":"String", + "documentation":"

The ID of an address pool.

", + "locationName":"publicIpv4Pool" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "AddressList":{ + "type":"list", + "member":{ + "shape":"Address", + "locationName":"item" + } + }, + "AdvertiseByoipCidrRequest":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AdvertiseByoipCidrResult":{ + "type":"structure", + "members":{ + "ByoipCidr":{ + "shape":"ByoipCidr", + "documentation":"

Information about the address range.

", + "locationName":"byoipCidr" + } + } + }, + "Affinity":{ + "type":"string", + "enum":[ + "default", + "host" + ] + }, + "AllocateAddressRequest":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"DomainType", + "documentation":"

Set to vpc to allocate the address for use with instances in a VPC.

Default: The address is for use with instances in EC2-Classic.

" + }, + "Address":{ + "shape":"String", + "documentation":"

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

" + }, + "PublicIpv4Pool":{ + "shape":"String", + "documentation":"

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "AllocateAddressResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "AllocationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.

", + "locationName":"allocationId" + }, + "PublicIpv4Pool":{ + "shape":"String", + "documentation":"

The ID of an address pool.

", + "locationName":"publicIpv4Pool" + }, + "Domain":{ + "shape":"DomainType", + "documentation":"

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC (vpc).

", + "locationName":"domain" + } + } + }, + "AllocateHostsRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "InstanceType", + "Quantity" + ], + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.

Default: on

", + "locationName":"autoPlacement" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to allocate the Dedicated Host.

", + "locationName":"availabilityZone" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host.

", + "locationName":"instanceType" + }, + "Quantity":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts to allocate to your account with these parameters.

", + "locationName":"quantity" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the Dedicated Host during creation.

", + "locationName":"TagSpecification" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

Default: off

" + } + } + }, + "AllocateHostsResult":{ + "type":"structure", + "members":{ + "HostIds":{ + "shape":"ResponseHostIdList", + "documentation":"

The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.

", + "locationName":"hostIdSet" + } + }, + "documentation":"

Contains the output of AllocateHosts.

" + }, + "AllocationId":{"type":"string"}, + "AllocationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AllocationId" + } + }, + "AllocationState":{ + "type":"string", + "enum":[ + "available", + "under-assessment", + "permanent-failure", + "released", + "released-permanent-failure", + "pending" + ] + }, + "AllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "diversified", + "capacityOptimized" + ] + }, + "AllowedPrincipal":{ + "type":"structure", + "members":{ + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"

The type of principal.

", + "locationName":"principalType" + }, + "Principal":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the principal.

", + "locationName":"principal" + } + }, + "documentation":"

Describes a principal.

" + }, + "AllowedPrincipalSet":{ + "type":"list", + "member":{ + "shape":"AllowedPrincipal", + "locationName":"item" + } + }, + "ApplySecurityGroupsToClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "VpcId", + "SecurityGroupIds" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC in which the associated target network is located.

" + }, + "SecurityGroupIds":{ + "shape":"ClientVpnSecurityGroupIdSet", + "documentation":"

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

", + "locationName":"SecurityGroupId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ApplySecurityGroupsToClientVpnTargetNetworkResult":{ + "type":"structure", + "members":{ + "SecurityGroupIds":{ + "shape":"ClientVpnSecurityGroupIdSet", + "documentation":"

The IDs of the applied security groups.

", + "locationName":"securityGroupIds" + } + } + }, + "ArchitectureValues":{ + "type":"string", + "enum":[ + "i386", + "x86_64", + "arm64" + ] + }, + "AssignIpv6AddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

The number of IPv6 addresses to assign to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

", + "locationName":"ipv6AddressCount" + }, + "Ipv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "locationName":"ipv6Addresses" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "AssignIpv6AddressesResult":{ + "type":"structure", + "members":{ + "AssignedIpv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"

The IPv6 addresses assigned to the network interface.

", + "locationName":"assignedIpv6Addresses" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "AssignPrivateIpAddressesRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "AllowReassignment":{ + "shape":"Boolean", + "documentation":"

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

", + "locationName":"allowReassignment" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "locationName":"privateIpAddress" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.

", + "locationName":"secondaryPrivateIpAddressCount" + } + }, + "documentation":"

Contains the parameters for AssignPrivateIpAddresses.

" + }, + "AssignPrivateIpAddressesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "AssignedPrivateIpAddresses":{ + "shape":"AssignedPrivateIpAddressList", + "documentation":"

The private IP addresses assigned to the network interface.

", + "locationName":"assignedPrivateIpAddressesSet" + } + } + }, + "AssignedPrivateIpAddress":{ + "type":"structure", + "members":{ + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address assigned to the network interface.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the private IP addresses assigned to a network interface.

" + }, + "AssignedPrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"AssignedPrivateIpAddress", + "locationName":"item" + } + }, + "AssociateAddressRequest":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"AllocationId", + "documentation":"

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address to associate with the instance. This is required for EC2-Classic.

" + }, + "AllowReassociation":{ + "shape":"Boolean", + "documentation":"

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

", + "locationName":"allowReassociation" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

", + "locationName":"privateIpAddress" + } + } + }, + "AssociateAddressResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.

", + "locationName":"associationId" + } + } + }, + "AssociateClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "SubnetId" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet to associate with the Client VPN endpoint.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AssociateClientVpnTargetNetworkResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The unique ID of the target network association.

", + "locationName":"associationId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"

The current state of the target network association.

", + "locationName":"status" + } + } + }, + "AssociateDhcpOptionsRequest":{ + "type":"structure", + "required":[ + "DhcpOptionsId", + "VpcId" + ], + "members":{ + "DhcpOptionsId":{ + "shape":"DhcpOptionsId", + "documentation":"

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "AssociateIamInstanceProfileRequest":{ + "type":"structure", + "required":[ + "IamInstanceProfile", + "InstanceId" + ], + "members":{ + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + } + } + }, + "AssociateIamInstanceProfileResult":{ + "type":"structure", + "members":{ + "IamInstanceProfileAssociation":{ + "shape":"IamInstanceProfileAssociation", + "documentation":"

Information about the IAM instance profile association.

", + "locationName":"iamInstanceProfileAssociation" + } + } + }, + "AssociateRouteTableRequest":{ + "type":"structure", + "required":[ + "RouteTableId", + "SubnetId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + } + }, + "AssociateRouteTableResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The route table association ID. This ID is required for disassociating the route table.

", + "locationName":"associationId" + } + } + }, + "AssociateSubnetCidrBlockRequest":{ + "type":"structure", + "required":[ + "Ipv6CidrBlock", + "SubnetId" + ], + "members":{ + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.

", + "locationName":"ipv6CidrBlock" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of your subnet.

", + "locationName":"subnetId" + } + } + }, + "AssociateSubnetCidrBlockResult":{ + "type":"structure", + "members":{ + "Ipv6CidrBlockAssociation":{ + "shape":"SubnetIpv6CidrBlockAssociation", + "documentation":"

Information about the IPv6 CIDR block association.

", + "locationName":"ipv6CidrBlockAssociation" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + } + }, + "AssociateTransitGatewayRouteTableRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AssociateTransitGatewayRouteTableResult":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"TransitGatewayAssociation", + "documentation":"

The ID of the association.

", + "locationName":"association" + } + } + }, + "AssociateVpcCidrBlockRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "AmazonProvidedIpv6CidrBlock":{ + "shape":"Boolean", + "documentation":"

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

", + "locationName":"amazonProvidedIpv6CidrBlock" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

An IPv4 CIDR block to associate with the VPC.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AssociateVpcCidrBlockResult":{ + "type":"structure", + "members":{ + "Ipv6CidrBlockAssociation":{ + "shape":"VpcIpv6CidrBlockAssociation", + "documentation":"

Information about the IPv6 CIDR block association.

", + "locationName":"ipv6CidrBlockAssociation" + }, + "CidrBlockAssociation":{ + "shape":"VpcCidrBlockAssociation", + "documentation":"

Information about the IPv4 CIDR block association.

", + "locationName":"cidrBlockAssociation" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AssociatedNetworkType":{ + "type":"string", + "enum":["vpc"] + }, + "AssociatedTargetNetwork":{ + "type":"structure", + "members":{ + "NetworkId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"networkId" + }, + "NetworkType":{ + "shape":"AssociatedNetworkType", + "documentation":"

The target network type.

", + "locationName":"networkType" + } + }, + "documentation":"

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

" + }, + "AssociatedTargetNetworkSet":{ + "type":"list", + "member":{ + "shape":"AssociatedTargetNetwork", + "locationName":"item" + } + }, + "AssociationIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AssociationId" + } + }, + "AssociationStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"AssociationStatusCode", + "documentation":"

The state of the target network association.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the target network association, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of a target network association.

" + }, + "AssociationStatusCode":{ + "type":"string", + "enum":[ + "associating", + "associated", + "association-failed", + "disassociating", + "disassociated" + ] + }, + "AttachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "Groups", + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

", + "locationName":"SecurityGroupId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of a ClassicLink-enabled VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "AttachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"InternetGatewayId", + "documentation":"

The ID of the internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "AttachNetworkInterfaceRequest":{ + "type":"structure", + "required":[ + "DeviceIndex", + "InstanceId", + "NetworkInterfaceId" + ], + "members":{ + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for AttachNetworkInterface.

" + }, + "AttachNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + } + }, + "documentation":"

Contains the output of AttachNetworkInterface.

" + }, + "AttachVolumeRequest":{ + "type":"structure", + "required":[ + "Device", + "InstanceId", + "VolumeId" + ], + "members":{ + "Device":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for AttachVolume.

" + }, + "AttachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpcId", + "VpnGatewayId" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "VpnGatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for AttachVpnGateway.

" + }, + "AttachVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpcAttachment":{ + "shape":"VpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"attachment" + } + }, + "documentation":"

Contains the output of AttachVpnGateway.

" + }, + "AttachmentId":{"type":"string"}, + "AttachmentStatus":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached" + ] + }, + "AttributeBooleanValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

The attribute value. The valid values are true or false.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a Boolean value.

" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The attribute value. The value is case-sensitive.

", + "locationName":"value" + } + }, + "documentation":"

Describes a value for a resource attribute that is a String.

" + }, + "AuthorizationRule":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint with which the authorization rule is associated.

", + "locationName":"clientVpnEndpointId" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the authorization rule.

", + "locationName":"description" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the Active Directory group to which the authorization rule grants access.

", + "locationName":"groupId" + }, + "AccessAll":{ + "shape":"Boolean", + "documentation":"

Indicates whether the authorization rule grants access to all clients.

", + "locationName":"accessAll" + }, + "DestinationCidr":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.

", + "locationName":"destinationCidr" + }, + "Status":{ + "shape":"ClientVpnAuthorizationRuleStatus", + "documentation":"

The current state of the authorization rule.

", + "locationName":"status" + } + }, + "documentation":"

Information about an authorization rule.

" + }, + "AuthorizationRuleSet":{ + "type":"list", + "member":{ + "shape":"AuthorizationRule", + "locationName":"item" + } + }, + "AuthorizeClientVpnIngressRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "TargetNetworkCidr":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

" + }, + "AccessGroupId":{ + "shape":"String", + "documentation":"

The ID of the Active Directory group to grant access.

" + }, + "AuthorizeAllGroups":{ + "shape":"Boolean", + "documentation":"

Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the authorization rule.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "AuthorizeClientVpnIngressResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ClientVpnAuthorizationRuleStatus", + "documentation":"

The current state of the authorization rule.

", + "locationName":"status" + } + } + }, + "AuthorizeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", + "locationName":"ipPermissions" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify the CIDR.

", + "locationName":"cidrIp" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

Not supported. Use a set of IP permissions to specify the port.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify the protocol name or number.

", + "locationName":"ipProtocol" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

Not supported. Use a set of IP permissions to specify the port.

", + "locationName":"toPort" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName":"sourceSecurityGroupOwnerId" + } + } + }, + "AuthorizeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR format. You can't specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The sets of IP permissions.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "AutoAcceptSharedAttachmentsValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "AutoPlacement":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "State":{ + "shape":"AvailabilityZoneState", + "documentation":"

The state of the Availability Zone.

", + "locationName":"zoneState" + }, + "Messages":{ + "shape":"AvailabilityZoneMessageList", + "documentation":"

Any messages about the Availability Zone.

", + "locationName":"messageSet" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the Region.

", + "locationName":"regionName" + }, + "ZoneName":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

", + "locationName":"zoneName" + }, + "ZoneId":{ + "shape":"String", + "documentation":"

The ID of the Availability Zone.

", + "locationName":"zoneId" + } + }, + "documentation":"

Describes an Availability Zone.

" + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"item" + } + }, + "AvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The message about the Availability Zone.

", + "locationName":"message" + } + }, + "documentation":"

Describes a message about an Availability Zone.

" + }, + "AvailabilityZoneMessageList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZoneMessage", + "locationName":"item" + } + }, + "AvailabilityZoneState":{ + "type":"string", + "enum":[ + "available", + "information", + "impaired", + "unavailable" + ] + }, + "AvailableCapacity":{ + "type":"structure", + "members":{ + "AvailableInstanceCapacity":{ + "shape":"AvailableInstanceCapacityList", + "documentation":"

The total number of instances supported by the Dedicated Host.

", + "locationName":"availableInstanceCapacity" + }, + "AvailableVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs available on the Dedicated Host.

", + "locationName":"availableVCpus" + } + }, + "documentation":"

The capacity information for instances launched onto the Dedicated Host.

" + }, + "AvailableInstanceCapacityList":{ + "type":"list", + "member":{ + "shape":"InstanceCapacity", + "locationName":"item" + } + }, + "BatchState":{ + "type":"string", + "enum":[ + "submitted", + "active", + "cancelled", + "failed", + "cancelled_running", + "cancelled_terminating", + "modifying" + ] + }, + "BillingProductList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "Blob":{"type":"blob"}, + "BlobAttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Blob", + "locationName":"value" + } + } + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

", + "locationName":"virtualName" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "BlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"item" + } + }, + "BlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"BlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "Boolean":{"type":"boolean"}, + "BundleIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"BundleId" + } + }, + "BundleInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Storage" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for BundleInstance.

" + }, + "BundleInstanceResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of BundleInstance.

" + }, + "BundleTask":{ + "type":"structure", + "members":{ + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

", + "locationName":"bundleId" + }, + "BundleTaskError":{ + "shape":"BundleTaskError", + "documentation":"

If the task fails, a description of the error.

", + "locationName":"error" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance associated with this bundle task.

", + "locationName":"instanceId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The level of task completion, as a percent (for example, 20%).

", + "locationName":"progress" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time this task started.

", + "locationName":"startTime" + }, + "State":{ + "shape":"BundleTaskState", + "documentation":"

The state of the task.

", + "locationName":"state" + }, + "Storage":{ + "shape":"Storage", + "documentation":"

The Amazon S3 storage locations.

", + "locationName":"storage" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update for the task.

", + "locationName":"updateTime" + } + }, + "documentation":"

Describes a bundle task.

" + }, + "BundleTaskError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes an error for BundleInstance.

" + }, + "BundleTaskList":{ + "type":"list", + "member":{ + "shape":"BundleTask", + "locationName":"item" + } + }, + "BundleTaskState":{ + "type":"string", + "enum":[ + "pending", + "waiting-for-shutdown", + "bundling", + "storing", + "cancelling", + "complete", + "failed" + ] + }, + "ByoipCidr":{ + "type":"structure", + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The public IPv4 address range, in CIDR notation.

", + "locationName":"cidr" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the address range.

", + "locationName":"description" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

Upon success, contains the ID of the address pool. Otherwise, contains an error message.

", + "locationName":"statusMessage" + }, + "State":{ + "shape":"ByoipCidrState", + "documentation":"

The state of the address pool.

", + "locationName":"state" + } + }, + "documentation":"

Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

" + }, + "ByoipCidrSet":{ + "type":"list", + "member":{ + "shape":"ByoipCidr", + "locationName":"item" + } + }, + "ByoipCidrState":{ + "type":"string", + "enum":[ + "advertised", + "deprovisioned", + "failed-deprovision", + "failed-provision", + "pending-deprovision", + "pending-provision", + "provisioned" + ] + }, + "CancelBatchErrorCode":{ + "type":"string", + "enum":[ + "fleetRequestIdDoesNotExist", + "fleetRequestIdMalformed", + "fleetRequestNotInCancellableState", + "unexpectedError" + ] + }, + "CancelBundleTaskRequest":{ + "type":"structure", + "required":["BundleId"], + "members":{ + "BundleId":{ + "shape":"String", + "documentation":"

The ID of the bundle task.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CancelBundleTask.

" + }, + "CancelBundleTaskResult":{ + "type":"structure", + "members":{ + "BundleTask":{ + "shape":"BundleTask", + "documentation":"

Information about the bundle task.

", + "locationName":"bundleInstanceTask" + } + }, + "documentation":"

Contains the output of CancelBundleTask.

" + }, + "CancelCapacityReservationRequest":{ + "type":"structure", + "required":["CapacityReservationId"], + "members":{ + "CapacityReservationId":{ + "shape":"CapacityReservationId", + "documentation":"

The ID of the Capacity Reservation to be cancelled.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CancelCapacityReservationResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "CancelConversionRequest":{ + "type":"structure", + "required":["ConversionTaskId"], + "members":{ + "ConversionTaskId":{ + "shape":"ConversionTaskId", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "ReasonMessage":{ + "shape":"String", + "documentation":"

The reason for canceling the conversion task.

", + "locationName":"reasonMessage" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["ExportTaskId"], + "members":{ + "ExportTaskId":{ + "shape":"ExportTaskId", + "documentation":"

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

", + "locationName":"exportTaskId" + } + } + }, + "CancelImportTaskRequest":{ + "type":"structure", + "members":{ + "CancelReason":{ + "shape":"String", + "documentation":"

The reason for canceling the task.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImportTaskId":{ + "shape":"ImportTaskId", + "documentation":"

The ID of the import image or import snapshot task to be canceled.

" + } + } + }, + "CancelImportTaskResult":{ + "type":"structure", + "members":{ + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the task being canceled.

", + "locationName":"importTaskId" + }, + "PreviousState":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"previousState" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the task being canceled.

", + "locationName":"state" + } + } + }, + "CancelReservedInstancesListingRequest":{ + "type":"structure", + "required":["ReservedInstancesListingId"], + "members":{ + "ReservedInstancesListingId":{ + "shape":"ReservedInstancesListingId", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + } + }, + "documentation":"

Contains the parameters for CancelReservedInstancesListing.

" + }, + "CancelReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

The Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CancelReservedInstancesListing.

" + }, + "CancelSpotFleetRequestsError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"CancelBatchErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Fleet error.

" + }, + "CancelSpotFleetRequestsErrorItem":{ + "type":"structure", + "members":{ + "Error":{ + "shape":"CancelSpotFleetRequestsError", + "documentation":"

The error.

", + "locationName":"error" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Describes a Spot Fleet request that was not successfully canceled.

" + }, + "CancelSpotFleetRequestsErrorSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsErrorItem", + "locationName":"item" + } + }, + "CancelSpotFleetRequestsRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot Fleet requests.

", + "locationName":"spotFleetRequestId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

", + "locationName":"terminateInstances" + } + }, + "documentation":"

Contains the parameters for CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "SuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsSuccessSet", + "documentation":"

Information about the Spot Fleet requests that are successfully canceled.

", + "locationName":"successfulFleetRequestSet" + }, + "UnsuccessfulFleetRequests":{ + "shape":"CancelSpotFleetRequestsErrorSet", + "documentation":"

Information about the Spot Fleet requests that are not successfully canceled.

", + "locationName":"unsuccessfulFleetRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotFleetRequests.

" + }, + "CancelSpotFleetRequestsSuccessItem":{ + "type":"structure", + "members":{ + "CurrentSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The current state of the Spot Fleet request.

", + "locationName":"currentSpotFleetRequestState" + }, + "PreviousSpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The previous state of the Spot Fleet request.

", + "locationName":"previousSpotFleetRequestState" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Describes a Spot Fleet request that was successfully canceled.

" + }, + "CancelSpotFleetRequestsSuccessSet":{ + "type":"list", + "member":{ + "shape":"CancelSpotFleetRequestsSuccessItem", + "locationName":"item" + } + }, + "CancelSpotInstanceRequestState":{ + "type":"string", + "enum":[ + "active", + "open", + "closed", + "cancelled", + "completed" + ] + }, + "CancelSpotInstanceRequestsRequest":{ + "type":"structure", + "required":["SpotInstanceRequestIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + } + }, + "documentation":"

Contains the parameters for CancelSpotInstanceRequests.

" + }, + "CancelSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "CancelledSpotInstanceRequests":{ + "shape":"CancelledSpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of CancelSpotInstanceRequests.

" + }, + "CancelledSpotInstanceRequest":{ + "type":"structure", + "members":{ + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "State":{ + "shape":"CancelSpotInstanceRequestState", + "documentation":"

The state of the Spot Instance request.

", + "locationName":"state" + } + }, + "documentation":"

Describes a request to cancel a Spot Instance.

" + }, + "CancelledSpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"CancelledSpotInstanceRequest", + "locationName":"item" + } + }, + "CapacityReservation":{ + "type":"structure", + "members":{ + "CapacityReservationId":{ + "shape":"String", + "documentation":"

The ID of the Capacity Reservation.

", + "locationName":"capacityReservationId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the Capacity Reservation.

", + "locationName":"ownerId" + }, + "CapacityReservationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Capacity Reservation.

", + "locationName":"capacityReservationArn" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"

The Availability Zone ID of the Capacity Reservation.

", + "locationName":"availabilityZoneId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The type of instance for which the Capacity Reservation reserves capacity.

", + "locationName":"instanceType" + }, + "InstancePlatform":{ + "shape":"CapacityReservationInstancePlatform", + "documentation":"

The type of operating system for which the Capacity Reservation reserves capacity.

", + "locationName":"instancePlatform" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the capacity is reserved.

", + "locationName":"availabilityZone" + }, + "Tenancy":{ + "shape":"CapacityReservationTenancy", + "documentation":"

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

", + "locationName":"tenancy" + }, + "TotalInstanceCount":{ + "shape":"Integer", + "documentation":"

The total number of instances for which the Capacity Reservation reserves capacity.

", + "locationName":"totalInstanceCount" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "locationName":"availableInstanceCount" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

", + "locationName":"ebsOptimized" + }, + "EphemeralStorage":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

", + "locationName":"ephemeralStorage" + }, + "State":{ + "shape":"CapacityReservationState", + "documentation":"

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

", + "locationName":"state" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

", + "locationName":"endDate" + }, + "EndDateType":{ + "shape":"EndDateType", + "documentation":"

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it.

  • limited - The Capacity Reservation expires automatically at a specified date and time.

", + "locationName":"endDateType" + }, + "InstanceMatchCriteria":{ + "shape":"InstanceMatchCriteria", + "documentation":"

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

", + "locationName":"instanceMatchCriteria" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The date and time at which the Capacity Reservation was created.

", + "locationName":"createDate" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Capacity Reservation.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a Capacity Reservation.

" + }, + "CapacityReservationId":{"type":"string"}, + "CapacityReservationIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "CapacityReservationInstancePlatform":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Red Hat Enterprise Linux", + "SUSE Linux", + "Windows", + "Windows with SQL Server", + "Windows with SQL Server Enterprise", + "Windows with SQL Server Standard", + "Windows with SQL Server Web", + "Linux with SQL Server Standard", + "Linux with SQL Server Web", + "Linux with SQL Server Enterprise" + ] + }, + "CapacityReservationPreference":{ + "type":"string", + "enum":[ + "open", + "none" + ] + }, + "CapacityReservationSet":{ + "type":"list", + "member":{ + "shape":"CapacityReservation", + "locationName":"item" + } + }, + "CapacityReservationSpecification":{ + "type":"structure", + "members":{ + "CapacityReservationPreference":{ + "shape":"CapacityReservationPreference", + "documentation":"

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

" + }, + "CapacityReservationTarget":{ + "shape":"CapacityReservationTarget", + "documentation":"

Information about the target Capacity Reservation.

" + } + }, + "documentation":"

Describes an instance's Capacity Reservation targeting option. You can specify only one parameter at a time. If you specify CapacityReservationPreference and CapacityReservationTarget, the request fails.

Use the CapacityReservationPreference parameter to configure the instance to run as an On-Demand Instance or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation.

" + }, + "CapacityReservationSpecificationResponse":{ + "type":"structure", + "members":{ + "CapacityReservationPreference":{ + "shape":"CapacityReservationPreference", + "documentation":"

Describes the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

", + "locationName":"capacityReservationPreference" + }, + "CapacityReservationTarget":{ + "shape":"CapacityReservationTargetResponse", + "documentation":"

Information about the targeted Capacity Reservation.

", + "locationName":"capacityReservationTarget" + } + }, + "documentation":"

Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation.

" + }, + "CapacityReservationState":{ + "type":"string", + "enum":[ + "active", + "expired", + "cancelled", + "pending", + "failed" + ] + }, + "CapacityReservationTarget":{ + "type":"structure", + "members":{ + "CapacityReservationId":{ + "shape":"String", + "documentation":"

The ID of the Capacity Reservation.

" + } + }, + "documentation":"

Describes a target Capacity Reservation.

" + }, + "CapacityReservationTargetResponse":{ + "type":"structure", + "members":{ + "CapacityReservationId":{ + "shape":"String", + "documentation":"

The ID of the Capacity Reservation.

", + "locationName":"capacityReservationId" + } + }, + "documentation":"

Describes a target Capacity Reservation.

" + }, + "CapacityReservationTenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated" + ] + }, + "CertificateAuthentication":{ + "type":"structure", + "members":{ + "ClientRootCertificateChain":{ + "shape":"String", + "documentation":"

The ARN of the client certificate.

", + "locationName":"clientRootCertificateChain" + } + }, + "documentation":"

Information about the client certificate used for authentication.

" + }, + "CertificateAuthenticationRequest":{ + "type":"structure", + "members":{ + "ClientRootCertificateChainArn":{ + "shape":"String", + "documentation":"

The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

" + } + }, + "documentation":"

Information about the client certificate to be used for authentication.

" + }, + "CidrAuthorizationContext":{ + "type":"structure", + "required":[ + "Message", + "Signature" + ], + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The plain-text authorization message for the prefix and account.

" + }, + "Signature":{ + "shape":"String", + "documentation":"

The signed authorization message for the prefix and account.

" + } + }, + "documentation":"

Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP). For more information, see Prepare to Bring Your Address Range to Your AWS Account in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CidrBlock":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR block.

", + "locationName":"cidrBlock" + } + }, + "documentation":"

Describes an IPv4 CIDR block.

" + }, + "CidrBlockSet":{ + "type":"list", + "member":{ + "shape":"CidrBlock", + "locationName":"item" + } + }, + "ClassicLinkDnsSupport":{ + "type":"structure", + "members":{ + "ClassicLinkDnsSupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether ClassicLink DNS support is enabled for the VPC.

", + "locationName":"classicLinkDnsSupported" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes the ClassicLink DNS support status of a VPC.

" + }, + "ClassicLinkDnsSupportList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkDnsSupport", + "locationName":"item" + } + }, + "ClassicLinkInstance":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

A list of security groups.

", + "locationName":"groupSet" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a linked EC2-Classic instance.

" + }, + "ClassicLinkInstanceList":{ + "type":"list", + "member":{ + "shape":"ClassicLinkInstance", + "locationName":"item" + } + }, + "ClassicLoadBalancer":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the load balancer.

", + "locationName":"name" + } + }, + "documentation":"

Describes a Classic Load Balancer.

" + }, + "ClassicLoadBalancers":{ + "type":"list", + "member":{ + "shape":"ClassicLoadBalancer", + "locationName":"item" + }, + "max":5, + "min":1 + }, + "ClassicLoadBalancersConfig":{ + "type":"structure", + "members":{ + "ClassicLoadBalancers":{ + "shape":"ClassicLoadBalancers", + "documentation":"

One or more Classic Load Balancers.

", + "locationName":"classicLoadBalancers" + } + }, + "documentation":"

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.

" + }, + "ClientCertificateRevocationListStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientCertificateRevocationListStatusCode", + "documentation":"

The state of the client certificate revocation list.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the client certificate revocation list, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of a client certificate revocation list.

" + }, + "ClientCertificateRevocationListStatusCode":{ + "type":"string", + "enum":[ + "pending", + "active" + ] + }, + "ClientData":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment about the disk upload.

" + }, + "UploadEnd":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload ends.

" + }, + "UploadSize":{ + "shape":"Double", + "documentation":"

The size of the uploaded disk image, in GiB.

" + }, + "UploadStart":{ + "shape":"DateTime", + "documentation":"

The time that the disk upload starts.

" + } + }, + "documentation":"

Describes the client-specific data.

" + }, + "ClientVpnAuthentication":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ClientVpnAuthenticationType", + "documentation":"

The authentication type used.

", + "locationName":"type" + }, + "ActiveDirectory":{ + "shape":"DirectoryServiceAuthentication", + "documentation":"

Information about the Active Directory, if applicable.

", + "locationName":"activeDirectory" + }, + "MutualAuthentication":{ + "shape":"CertificateAuthentication", + "documentation":"

Information about the authentication certificates, if applicable.

", + "locationName":"mutualAuthentication" + } + }, + "documentation":"

Describes the authentication methods used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide.

" + }, + "ClientVpnAuthenticationList":{ + "type":"list", + "member":{ + "shape":"ClientVpnAuthentication", + "locationName":"item" + } + }, + "ClientVpnAuthenticationRequest":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ClientVpnAuthenticationType", + "documentation":"

The type of client authentication to be used. Specify certificate-authentication to use certificate-based authentication, or directory-service-authentication to use Active Directory authentication.

" + }, + "ActiveDirectory":{ + "shape":"DirectoryServiceAuthenticationRequest", + "documentation":"

Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.

" + }, + "MutualAuthentication":{ + "shape":"CertificateAuthenticationRequest", + "documentation":"

Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.

" + } + }, + "documentation":"

Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide.

" + }, + "ClientVpnAuthenticationRequestList":{ + "type":"list", + "member":{"shape":"ClientVpnAuthenticationRequest"} + }, + "ClientVpnAuthenticationType":{ + "type":"string", + "enum":[ + "certificate-authentication", + "directory-service-authentication" + ] + }, + "ClientVpnAuthorizationRuleStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnAuthorizationRuleStatusCode", + "documentation":"

The state of the authorization rule.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the authorization rule, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of an authorization rule.

" + }, + "ClientVpnAuthorizationRuleStatusCode":{ + "type":"string", + "enum":[ + "authorizing", + "active", + "failed", + "revoking" + ] + }, + "ClientVpnConnection":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint to which the client is connected.

", + "locationName":"clientVpnEndpointId" + }, + "Timestamp":{ + "shape":"String", + "documentation":"

The current date and time.

", + "locationName":"timestamp" + }, + "ConnectionId":{ + "shape":"String", + "documentation":"

The ID of the client connection.

", + "locationName":"connectionId" + }, + "Username":{ + "shape":"String", + "documentation":"

The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

", + "locationName":"username" + }, + "ConnectionEstablishedTime":{ + "shape":"String", + "documentation":"

The date and time the client connection was established.

", + "locationName":"connectionEstablishedTime" + }, + "IngressBytes":{ + "shape":"String", + "documentation":"

The number of bytes sent by the client.

", + "locationName":"ingressBytes" + }, + "EgressBytes":{ + "shape":"String", + "documentation":"

The number of bytes received by the client.

", + "locationName":"egressBytes" + }, + "IngressPackets":{ + "shape":"String", + "documentation":"

The number of packets sent by the client.

", + "locationName":"ingressPackets" + }, + "EgressPackets":{ + "shape":"String", + "documentation":"

The number of packets received by the client.

", + "locationName":"egressPackets" + }, + "ClientIp":{ + "shape":"String", + "documentation":"

The IP address of the client.

", + "locationName":"clientIp" + }, + "CommonName":{ + "shape":"String", + "documentation":"

The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

", + "locationName":"commonName" + }, + "Status":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"

The current state of the client connection.

", + "locationName":"status" + }, + "ConnectionEndTime":{ + "shape":"String", + "documentation":"

The date and time the client connection was terminated.

", + "locationName":"connectionEndTime" + } + }, + "documentation":"

Describes a client connection.

" + }, + "ClientVpnConnectionSet":{ + "type":"list", + "member":{ + "shape":"ClientVpnConnection", + "locationName":"item" + } + }, + "ClientVpnConnectionStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnConnectionStatusCode", + "documentation":"

The state of the client connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the client connection, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a client connection.

" + }, + "ClientVpnConnectionStatusCode":{ + "type":"string", + "enum":[ + "active", + "failed-to-terminate", + "terminating", + "terminated" + ] + }, + "ClientVpnEndpoint":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

", + "locationName":"clientVpnEndpointId" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the endpoint.

", + "locationName":"description" + }, + "Status":{ + "shape":"ClientVpnEndpointStatus", + "documentation":"

The current state of the Client VPN endpoint.

", + "locationName":"status" + }, + "CreationTime":{ + "shape":"String", + "documentation":"

The date and time the Client VPN endpoint was created.

", + "locationName":"creationTime" + }, + "DeletionTime":{ + "shape":"String", + "documentation":"

The date and time the Client VPN endpoint was deleted, if applicable.

", + "locationName":"deletionTime" + }, + "DnsName":{ + "shape":"String", + "documentation":"

The DNS name to be used by clients when connecting to the Client VPN endpoint.

", + "locationName":"dnsName" + }, + "ClientCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

", + "locationName":"clientCidrBlock" + }, + "DnsServers":{ + "shape":"ValueStringList", + "documentation":"

Information about the DNS servers to be used for DNS resolution.

", + "locationName":"dnsServer" + }, + "SplitTunnel":{ + "shape":"Boolean", + "documentation":"

Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.

", + "locationName":"splitTunnel" + }, + "VpnProtocol":{ + "shape":"VpnProtocol", + "documentation":"

The protocol used by the VPN session.

", + "locationName":"vpnProtocol" + }, + "TransportProtocol":{ + "shape":"TransportProtocol", + "documentation":"

The transport protocol used by the Client VPN endpoint.

", + "locationName":"transportProtocol" + }, + "AssociatedTargetNetworks":{ + "shape":"AssociatedTargetNetworkSet", + "documentation":"

Information about the associated target networks. A target network is a subnet in a VPC.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.", + "locationName":"associatedTargetNetwork" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"

The ARN of the server certificate.

", + "locationName":"serverCertificateArn" + }, + "AuthenticationOptions":{ + "shape":"ClientVpnAuthenticationList", + "documentation":"

Information about the authentication method used by the Client VPN endpoint.

", + "locationName":"authenticationOptions" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogResponseOptions", + "documentation":"

Information about the client connection logging options for the Client VPN endpoint.

", + "locationName":"connectionLogOptions" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Client VPN endpoint.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a Client VPN endpoint.

" + }, + "ClientVpnEndpointId":{"type":"string"}, + "ClientVpnEndpointStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnEndpointStatusCode", + "documentation":"

The state of the Client VPN endpoint. Possible states include:

  • pending-associate - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.

  • available - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.

  • deleting - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.

  • deleted - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the Client VPN endpoint.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of a Client VPN endpoint.

" + }, + "ClientVpnEndpointStatusCode":{ + "type":"string", + "enum":[ + "pending-associate", + "available", + "deleting", + "deleted" + ] + }, + "ClientVpnRoute":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint with which the route is associated.

", + "locationName":"clientVpnEndpointId" + }, + "DestinationCidr":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the route destination.

", + "locationName":"destinationCidr" + }, + "TargetSubnet":{ + "shape":"String", + "documentation":"

The ID of the subnet through which traffic is routed.

", + "locationName":"targetSubnet" + }, + "Type":{ + "shape":"String", + "documentation":"

The route type.

", + "locationName":"type" + }, + "Origin":{ + "shape":"String", + "documentation":"

Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.

", + "locationName":"origin" + }, + "Status":{ + "shape":"ClientVpnRouteStatus", + "documentation":"

The current state of the route.

", + "locationName":"status" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the route.

", + "locationName":"description" + } + }, + "documentation":"

Information about a Client VPN endpoint route.

" + }, + "ClientVpnRouteSet":{ + "type":"list", + "member":{ + "shape":"ClientVpnRoute", + "locationName":"item" + } + }, + "ClientVpnRouteStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClientVpnRouteStatusCode", + "documentation":"

The state of the Client VPN endpoint route.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message about the status of the Client VPN endpoint route, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of a Client VPN endpoint route.

" + }, + "ClientVpnRouteStatusCode":{ + "type":"string", + "enum":[ + "creating", + "active", + "failed", + "deleting" + ] + }, + "ClientVpnSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConfirmProductInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "ProductCode" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "ProductCode":{ + "shape":"String", + "documentation":"

The product code. This must be a product code that you own.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "ConfirmProductInstanceResult":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.

", + "locationName":"ownerId" + }, + "Return":{ + "shape":"Boolean", + "documentation":"

The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.

", + "locationName":"return" + } + } + }, + "ConnectionLogOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether connection logging is enabled.

" + }, + "CloudwatchLogGroup":{ + "shape":"String", + "documentation":"

The name of the CloudWatch Logs log group.

" + }, + "CloudwatchLogStream":{ + "shape":"String", + "documentation":"

The name of the CloudWatch Logs log stream to which the connection data is published.

" + } + }, + "documentation":"

Describes the client connection logging options for the Client VPN endpoint.

" + }, + "ConnectionLogResponseOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether client connection logging is enabled for the Client VPN endpoint.

" + }, + "CloudwatchLogGroup":{ + "shape":"String", + "documentation":"

The name of the Amazon CloudWatch Logs log group to which connection logging data is published.

" + }, + "CloudwatchLogStream":{ + "shape":"String", + "documentation":"

The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.

" + } + }, + "documentation":"

Information about the client connection logging options for a Client VPN endpoint.

" + }, + "ConnectionNotification":{ + "type":"structure", + "members":{ + "ConnectionNotificationId":{ + "shape":"String", + "documentation":"

The ID of the notification.

", + "locationName":"connectionNotificationId" + }, + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the endpoint service.

", + "locationName":"serviceId" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "ConnectionNotificationType":{ + "shape":"ConnectionNotificationType", + "documentation":"

The type of notification.

", + "locationName":"connectionNotificationType" + }, + "ConnectionNotificationArn":{ + "shape":"String", + "documentation":"

The ARN of the SNS topic for the notification.

", + "locationName":"connectionNotificationArn" + }, + "ConnectionEvents":{ + "shape":"ValueStringList", + "documentation":"

The events for the notification. Valid values are Accept, Connect, Delete, and Reject.

", + "locationName":"connectionEvents" + }, + "ConnectionNotificationState":{ + "shape":"ConnectionNotificationState", + "documentation":"

The state of the notification.

", + "locationName":"connectionNotificationState" + } + }, + "documentation":"

Describes a connection notification for a VPC endpoint or VPC endpoint service.

" + }, + "ConnectionNotificationId":{"type":"string"}, + "ConnectionNotificationSet":{ + "type":"list", + "member":{ + "shape":"ConnectionNotification", + "locationName":"item" + } + }, + "ConnectionNotificationState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ConnectionNotificationType":{ + "type":"string", + "enum":["Topic"] + }, + "ContainerFormat":{ + "type":"string", + "enum":["ova"] + }, + "ConversionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ConversionTask":{ + "type":"structure", + "members":{ + "ConversionTaskId":{ + "shape":"String", + "documentation":"

The ID of the conversion task.

", + "locationName":"conversionTaskId" + }, + "ExpirationTime":{ + "shape":"String", + "documentation":"

The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.

", + "locationName":"expirationTime" + }, + "ImportInstance":{ + "shape":"ImportInstanceTaskDetails", + "documentation":"

If the task is for importing an instance, this contains information about the import instance task.

", + "locationName":"importInstance" + }, + "ImportVolume":{ + "shape":"ImportVolumeTaskDetails", + "documentation":"

If the task is for importing a volume, this contains information about the import volume task.

", + "locationName":"importVolume" + }, + "State":{ + "shape":"ConversionTaskState", + "documentation":"

The state of the conversion task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the conversion task.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the task.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a conversion task.

" + }, + "ConversionTaskId":{"type":"string"}, + "ConversionTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "CopyFpgaImageRequest":{ + "type":"structure", + "required":[ + "SourceFpgaImageId", + "SourceRegion" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "SourceFpgaImageId":{ + "shape":"String", + "documentation":"

The ID of the source AFI.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the new AFI.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name for the new AFI. The default is the name of the source AFI.

" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The Region that contains the source AFI.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + } + } + }, + "CopyFpgaImageResult":{ + "type":"structure", + "members":{ + "FpgaImageId":{ + "shape":"String", + "documentation":"

The ID of the new AFI.

", + "locationName":"fpgaImageId" + } + } + }, + "CopyImageRequest":{ + "type":"structure", + "required":[ + "Name", + "SourceImageId", + "SourceRegion" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new AMI in the destination Region.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

", + "locationName":"kmsKeyId" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the new AMI in the destination Region.

" + }, + "SourceImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI to copy.

" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The name of the Region that contains the AMI to copy.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CopyImage.

" + }, + "CopyImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of CopyImage.

" + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "SourceRegion", + "SourceSnapshotId" + ], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the EBS snapshot.

" + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ec2.us-east-1.amazonaws.com). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.

", + "locationName":"destinationRegion" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

", + "locationName":"kmsKeyId" + }, + "PresignedUrl":{ + "shape":"String", + "documentation":"

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

", + "locationName":"presignedUrl" + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

The ID of the Region that contains the snapshot to be copied.

" + }, + "SourceSnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to copy.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CopySnapshot.

" + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the new snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Contains the output of CopySnapshot.

" + }, + "CopyTagsFromSource":{ + "type":"string", + "enum":["volume"] + }, + "CpuOptions":{ + "type":"structure", + "members":{ + "CoreCount":{ + "shape":"Integer", + "documentation":"

The number of CPU cores for the instance.

", + "locationName":"coreCount" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"

The number of threads per CPU core.

", + "locationName":"threadsPerCore" + } + }, + "documentation":"

The CPU options for the instance.

" + }, + "CpuOptionsRequest":{ + "type":"structure", + "members":{ + "CoreCount":{ + "shape":"Integer", + "documentation":"

The number of CPU cores for the instance.

" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"

The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

" + } + }, + "documentation":"

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

" + }, + "CreateCapacityReservationRequest":{ + "type":"structure", + "required":[ + "InstanceType", + "InstancePlatform", + "InstanceCount" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "InstancePlatform":{ + "shape":"CapacityReservationInstancePlatform", + "documentation":"

The type of operating system for which to reserve capacity.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the Capacity Reservation.

" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"

The ID of the Availability Zone in which to create the Capacity Reservation.

" + }, + "Tenancy":{ + "shape":"CapacityReservationTenancy", + "documentation":"

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

  • default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

  • dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances for which to reserve capacity.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

" + }, + "EphemeralStorage":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

" + }, + "EndDateType":{ + "shape":"EndDateType", + "documentation":"

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

" + }, + "InstanceMatchCriteria":{ + "shape":"InstanceMatchCriteria", + "documentation":"

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

  • open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

  • targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the Capacity Reservation during launch.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateCapacityReservationResult":{ + "type":"structure", + "members":{ + "CapacityReservation":{ + "shape":"CapacityReservation", + "documentation":"

Information about the Capacity Reservation.

", + "locationName":"capacityReservation" + } + } + }, + "CreateClientVpnEndpointRequest":{ + "type":"structure", + "required":[ + "ClientCidrBlock", + "ServerCertificateArn", + "AuthenticationOptions", + "ConnectionLogOptions" + ], + "members":{ + "ClientCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"

The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.

" + }, + "AuthenticationOptions":{ + "shape":"ClientVpnAuthenticationRequestList", + "documentation":"

Information about the authentication method to be used to authenticate clients.

", + "locationName":"Authentication" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogOptions", + "documentation":"

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

" + }, + "DnsServers":{ + "shape":"ValueStringList", + "documentation":"

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

" + }, + "TransportProtocol":{ + "shape":"TransportProtocol", + "documentation":"

The transport protocol to be used by the VPN session.

Default value: udp

" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the Client VPN endpoint.

" + }, + "SplitTunnel":{ + "shape":"Boolean", + "documentation":"

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the Client VPN endpoint during creation.

", + "locationName":"TagSpecification" + } + } + }, + "CreateClientVpnEndpointResult":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

", + "locationName":"clientVpnEndpointId" + }, + "Status":{ + "shape":"ClientVpnEndpointStatus", + "documentation":"

The current state of the Client VPN endpoint.

", + "locationName":"status" + }, + "DnsName":{ + "shape":"String", + "documentation":"

The DNS name to be used by clients when establishing their VPN session.

", + "locationName":"dnsName" + } + } + }, + "CreateClientVpnRouteRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "DestinationCidrBlock", + "TargetVpcSubnetId" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint to which to add the route.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the route destination. For example:

  • To add a route for Internet access, enter 0.0.0.0/0

  • To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range

  • To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range

Route address ranges cannot overlap with the CIDR range specified for client allocation.

" + }, + "TargetVpcSubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the route.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateClientVpnRouteResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ClientVpnRouteStatus", + "documentation":"

The current state of the route.

", + "locationName":"status" + } + } + }, + "CreateCustomerGatewayRequest":{ + "type":"structure", + "required":[ + "BgpAsn", + "Type" + ], + "members":{ + "BgpAsn":{ + "shape":"Integer", + "documentation":"

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

", + "locationName":"IpAddress" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the customer gateway certificate.

" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection that this customer gateway supports (ipsec.1).

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateCustomerGateway.

" + }, + "CreateCustomerGatewayResult":{ + "type":"structure", + "members":{ + "CustomerGateway":{ + "shape":"CustomerGateway", + "documentation":"

Information about the customer gateway.

", + "locationName":"customerGateway" + } + }, + "documentation":"

Contains the output of CreateCustomerGateway.

" + }, + "CreateDefaultSubnetRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the default subnet.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateDefaultSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateDefaultVpcRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateDefaultVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpConfigurations"], + "members":{ + "DhcpConfigurations":{ + "shape":"NewDhcpConfigurationList", + "documentation":"

A DHCP configuration option.

", + "locationName":"dhcpConfiguration" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptions", + "documentation":"

A set of DHCP options.

", + "locationName":"dhcpOptions" + } + } + }, + "CreateEgressOnlyInternetGatewayRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC for which to create the egress-only internet gateway.

" + } + } + }, + "CreateEgressOnlyInternetGatewayResult":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "EgressOnlyInternetGateway":{ + "shape":"EgressOnlyInternetGateway", + "documentation":"

Information about the egress-only internet gateway.

", + "locationName":"egressOnlyInternetGateway" + } + } + }, + "CreateFleetError":{ + "type":"structure", + "members":{ + "LaunchTemplateAndOverrides":{ + "shape":"LaunchTemplateAndOverridesResponse", + "documentation":"

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName":"launchTemplateAndOverrides" + }, + "Lifecycle":{ + "shape":"InstanceLifecycle", + "documentation":"

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "locationName":"lifecycle" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.

", + "locationName":"errorCode" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.

", + "locationName":"errorMessage" + } + }, + "documentation":"

Describes the instances that could not be launched by the fleet.

" + }, + "CreateFleetErrorsSet":{ + "type":"list", + "member":{ + "shape":"CreateFleetError", + "locationName":"item" + } + }, + "CreateFleetInstance":{ + "type":"structure", + "members":{ + "LaunchTemplateAndOverrides":{ + "shape":"LaunchTemplateAndOverridesResponse", + "documentation":"

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName":"launchTemplateAndOverrides" + }, + "Lifecycle":{ + "shape":"InstanceLifecycle", + "documentation":"

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "locationName":"lifecycle" + }, + "InstanceIds":{ + "shape":"InstanceIdsSet", + "documentation":"

The IDs of the instances.

", + "locationName":"instanceIds" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + } + }, + "documentation":"

Describes the instances that were launched by the fleet.

" + }, + "CreateFleetInstancesSet":{ + "type":"list", + "member":{ + "shape":"CreateFleetInstance", + "locationName":"item" + } + }, + "CreateFleetRequest":{ + "type":"structure", + "required":[ + "LaunchTemplateConfigs", + "TargetCapacitySpecification" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + }, + "SpotOptions":{ + "shape":"SpotOptionsRequest", + "documentation":"

Describes the configuration of Spot Instances in an EC2 Fleet.

" + }, + "OnDemandOptions":{ + "shape":"OnDemandOptionsRequest", + "documentation":"

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"FleetExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" + }, + "LaunchTemplateConfigs":{ + "shape":"FleetLaunchTemplateConfigListRequest", + "documentation":"

The configuration for the EC2 Fleet.

" + }, + "TargetCapacitySpecification":{ + "shape":"TargetCapacitySpecificationRequest", + "documentation":"

The number of units to request.

" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running instances should be terminated when the EC2 Fleet expires.

" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

" + }, + "ReplaceUnhealthyInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether EC2 Fleet should replace unhealthy instances.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.

", + "locationName":"TagSpecification" + } + } + }, + "CreateFleetResult":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

", + "locationName":"fleetId" + }, + "Errors":{ + "shape":"CreateFleetErrorsSet", + "documentation":"

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

", + "locationName":"errorSet" + }, + "Instances":{ + "shape":"CreateFleetInstancesSet", + "documentation":"

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

", + "locationName":"fleetInstanceSet" + } + } + }, + "CreateFlowLogsRequest":{ + "type":"structure", + "required":[ + "ResourceIds", + "ResourceType", + "TrafficType" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

" + }, + "ResourceIds":{ + "shape":"ValueStringList", + "documentation":"

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

", + "locationName":"ResourceId" + }, + "ResourceType":{ + "shape":"FlowLogsResourceType", + "documentation":"

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

" + }, + "LogDestinationType":{ + "shape":"LogDestinationType", + "documentation":"

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

" + }, + "LogDestination":{ + "shape":"String", + "documentation":"

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

" + }, + "LogFormat":{ + "shape":"String", + "documentation":"

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

" + } + } + }, + "CreateFlowLogsResult":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + }, + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the flow logs.

", + "locationName":"flowLogIdSet" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be created successfully.

", + "locationName":"unsuccessful" + } + } + }, + "CreateFpgaImageRequest":{ + "type":"structure", + "required":["InputStorageLocation"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InputStorageLocation":{ + "shape":"StorageLocation", + "documentation":"

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

" + }, + "LogsStorageLocation":{ + "shape":"StorageLocation", + "documentation":"

The location in Amazon S3 for the output logs.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the AFI.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the AFI.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the FPGA image during creation.

", + "locationName":"TagSpecification" + } + } + }, + "CreateFpgaImageResult":{ + "type":"structure", + "members":{ + "FpgaImageId":{ + "shape":"String", + "documentation":"

The FPGA image identifier (AFI ID).

", + "locationName":"fpgaImageId" + }, + "FpgaImageGlobalId":{ + "shape":"String", + "documentation":"

The global FPGA image identifier (AGFI ID).

", + "locationName":"fpgaImageGlobalId" + } + } + }, + "CreateImageRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Name" + ], + "members":{ + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

", + "locationName":"blockDeviceMapping" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the new image.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "NoReboot":{ + "shape":"Boolean", + "documentation":"

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed.

", + "locationName":"noReboot" + } + } + }, + "CreateImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the new AMI.

", + "locationName":"imageId" + } + } + }, + "CreateInstanceExportTaskRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the conversion task or the resource being exported. The maximum length is 255 bytes.

", + "locationName":"description" + }, + "ExportToS3Task":{ + "shape":"ExportToS3TaskSpecification", + "documentation":"

The format and location for an instance export task.

", + "locationName":"exportToS3" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + } + }, + "CreateInstanceExportTaskResult":{ + "type":"structure", + "members":{ + "ExportTask":{ + "shape":"ExportTask", + "documentation":"

Information about the instance export task.

", + "locationName":"exportTask" + } + } + }, + "CreateInternetGatewayRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateInternetGatewayResult":{ + "type":"structure", + "members":{ + "InternetGateway":{ + "shape":"InternetGateway", + "documentation":"

Information about the internet gateway.

", + "locationName":"internetGateway" + } + } + }, + "CreateKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "KeyName":{ + "shape":"KeyPairName", + "documentation":"

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateLaunchTemplateRequest":{ + "type":"structure", + "required":[ + "LaunchTemplateName", + "LaunchTemplateData" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

A name for the launch template.

" + }, + "VersionDescription":{ + "shape":"VersionDescription", + "documentation":"

A description for the first version of the launch template.

" + }, + "LaunchTemplateData":{ + "shape":"RequestLaunchTemplateData", + "documentation":"

The information for the launch template.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the launch template during creation.

", + "locationName":"TagSpecification" + } + } + }, + "CreateLaunchTemplateResult":{ + "type":"structure", + "members":{ + "LaunchTemplate":{ + "shape":"LaunchTemplate", + "documentation":"

Information about the launch template.

", + "locationName":"launchTemplate" + } + } + }, + "CreateLaunchTemplateVersionRequest":{ + "type":"structure", + "required":["LaunchTemplateData"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

" + }, + "LaunchTemplateId":{ + "shape":"LaunchTemplateId", + "documentation":"

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "SourceVersion":{ + "shape":"String", + "documentation":"

The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.

" + }, + "VersionDescription":{ + "shape":"VersionDescription", + "documentation":"

A description for the version of the launch template.

" + }, + "LaunchTemplateData":{ + "shape":"RequestLaunchTemplateData", + "documentation":"

The information for the launch template.

" + } + } + }, + "CreateLaunchTemplateVersionResult":{ + "type":"structure", + "members":{ + "LaunchTemplateVersion":{ + "shape":"LaunchTemplateVersion", + "documentation":"

Information about the launch template version.

", + "locationName":"launchTemplateVersion" + } + } + }, + "CreateNatGatewayRequest":{ + "type":"structure", + "required":[ + "AllocationId", + "SubnetId" + ], + "members":{ + "AllocationId":{ + "shape":"AllocationId", + "documentation":"

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The subnet in which to create the NAT gateway.

" + } + } + }, + "CreateNatGatewayResult":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.

", + "locationName":"clientToken" + }, + "NatGateway":{ + "shape":"NatGateway", + "documentation":"

Information about the NAT gateway.

", + "locationName":"natGateway" + } + } + }, + "CreateNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "Egress", + "NetworkAclId", + "Protocol", + "RuleAction", + "RuleNumber" + ], + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "locationName":"Icmp" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).

", + "locationName":"ipv6CidrBlock" + }, + "NetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "locationName":"portRange" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

", + "locationName":"ruleNumber" + } + } + }, + "CreateNetworkAclRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateNetworkAclResult":{ + "type":"structure", + "members":{ + "NetworkAcl":{ + "shape":"NetworkAcl", + "documentation":"

Information about the network ACL.

", + "locationName":"networkAcl" + } + } + }, + "CreateNetworkInterfacePermissionRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "Permission" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

" + }, + "AwsAccountId":{ + "shape":"String", + "documentation":"

The AWS account ID.

" + }, + "AwsService":{ + "shape":"String", + "documentation":"

The AWS service. Currently not supported.

" + }, + "Permission":{ + "shape":"InterfacePermissionType", + "documentation":"

The type of permission to grant.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "documentation":"

Contains the parameters for CreateNetworkInterfacePermission.

" + }, + "CreateNetworkInterfacePermissionResult":{ + "type":"structure", + "members":{ + "InterfacePermission":{ + "shape":"NetworkInterfacePermission", + "documentation":"

Information about the permission for the network interface.

", + "locationName":"interfacePermission" + } + }, + "documentation":"

Contains the output of CreateNetworkInterfacePermission.

" + }, + "CreateNetworkInterfaceRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

", + "locationName":"ipv6AddressCount" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

", + "locationName":"ipv6Addresses" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IPv4 addresses.

", + "locationName":"privateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "InterfaceType":{ + "shape":"NetworkInterfaceCreationType", + "documentation":"

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet to associate with the network interface.

", + "locationName":"subnetId" + } + }, + "documentation":"

Contains the parameters for CreateNetworkInterface.

" + }, + "CreateNetworkInterfaceResult":{ + "type":"structure", + "members":{ + "NetworkInterface":{ + "shape":"NetworkInterface", + "documentation":"

Information about the network interface.

", + "locationName":"networkInterface" + } + }, + "documentation":"

Contains the output of CreateNetworkInterface.

" + }, + "CreatePlacementGroupRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

", + "locationName":"groupName" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "PartitionCount":{ + "shape":"Integer", + "documentation":"

The number of partitions. Valid only when Strategy is set to partition.

" + } + } + }, + "CreateReservedInstancesListingRequest":{ + "type":"structure", + "required":[ + "ClientToken", + "InstanceCount", + "PriceSchedules", + "ReservedInstancesId" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

", + "locationName":"instanceCount" + }, + "PriceSchedules":{ + "shape":"PriceScheduleSpecificationList", + "documentation":"

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

", + "locationName":"priceSchedules" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the active Standard Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Contains the parameters for CreateReservedInstancesListing.

" + }, + "CreateReservedInstancesListingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Standard Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of CreateReservedInstancesListing.

" + }, + "CreateRouteRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", + "locationName":"destinationIpv6CidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "locationName":"egressOnlyInternetGatewayId" + }, + "GatewayId":{ + "shape":"RouteTableGatewayId", + "documentation":"

The ID of an internet gateway or virtual private gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

", + "locationName":"instanceId" + }, + "NatGatewayId":{ + "shape":"NatGatewayId", + "documentation":"

[IPv4 traffic only] The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of a transit gateway.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table for the route.

", + "locationName":"routeTableId" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "CreateRouteResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "CreateRouteTableRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "CreateRouteTableResult":{ + "type":"structure", + "members":{ + "RouteTable":{ + "shape":"RouteTable", + "documentation":"

Information about the route table.

", + "locationName":"routeTable" + } + } + }, + "CreateSecurityGroupRequest":{ + "type":"structure", + "required":[ + "Description", + "GroupName" + ], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

", + "locationName":"GroupDescription" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with sg-.

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateSecurityGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + } + }, + "CreateSnapshotRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the EBS volume.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the snapshot during creation.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateSnapshot.

" + }, + "CreateSnapshotsRequest":{ + "type":"structure", + "required":["InstanceSpecification"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description propagated to every snapshot specified by the instance.

" + }, + "InstanceSpecification":{ + "shape":"InstanceSpecification", + "documentation":"

The instance to specify which volumes should be included in the snapshots.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

Tags to apply to every snapshot specified by the instance.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action without actually making the request. Provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "CopyTagsFromSource":{ + "shape":"CopyTagsFromSource", + "documentation":"

Copies the tags from the specified volume to corresponding snapshot.

" + } + } + }, + "CreateSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotSet", + "documentation":"

List of snapshots.

", + "locationName":"snapshotSet" + } + } + }, + "CreateSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket in which to store the Spot Instance data feed.

", + "locationName":"bucket" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Prefix":{ + "shape":"String", + "documentation":"

A prefix for the data feed file names.

", + "locationName":"prefix" + } + }, + "documentation":"

Contains the parameters for CreateSpotDatafeedSubscription.

" + }, + "CreateSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of CreateSpotDatafeedSubscription.

" + }, + "CreateSubnetRequest":{ + "type":"structure", + "required":[ + "CidrBlock", + "VpcId" + ], + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.

" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"

The AZ ID of the subnet.

" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "CreateSubnetResult":{ + "type":"structure", + "members":{ + "Subnet":{ + "shape":"Subnet", + "documentation":"

Information about the subnet.

", + "locationName":"subnet" + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "Resources", + "Tags" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "locationName":"ResourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

", + "locationName":"Tag" + } + } + }, + "CreateTrafficMirrorFilterRequest":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror filter.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to a Traffic Mirror filter.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + } + } + }, + "CreateTrafficMirrorFilterResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilter":{ + "shape":"TrafficMirrorFilter", + "documentation":"

Information about the Traffic Mirror filter.

", + "locationName":"trafficMirrorFilter" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateTrafficMirrorFilterRuleRequest":{ + "type":"structure", + "required":[ + "TrafficMirrorFilterId", + "TrafficDirection", + "RuleNumber", + "RuleAction", + "DestinationCidrBlock", + "SourceCidrBlock" + ], + "members":{ + "TrafficMirrorFilterId":{ + "shape":"TrafficMirrorFilterId", + "documentation":"

The ID of the filter that this rule is associated with.

" + }, + "TrafficDirection":{ + "shape":"TrafficDirection", + "documentation":"

The type of traffic (ingress | egress).

" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

" + }, + "RuleAction":{ + "shape":"TrafficMirrorRuleAction", + "documentation":"

The action to take (accept | reject) on the filtered traffic.

" + }, + "DestinationPortRange":{ + "shape":"TrafficMirrorPortRangeRequest", + "documentation":"

The destination port range.

" + }, + "SourcePortRange":{ + "shape":"TrafficMirrorPortRangeRequest", + "documentation":"

The source port range.

" + }, + "Protocol":{ + "shape":"Integer", + "documentation":"

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The destination CIDR block to assign to the Traffic Mirror rule.

" + }, + "SourceCidrBlock":{ + "shape":"String", + "documentation":"

The source CIDR block to assign to the Traffic Mirror rule.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror rule.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + } + } + }, + "CreateTrafficMirrorFilterRuleResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterRule":{ + "shape":"TrafficMirrorFilterRule", + "documentation":"

The Traffic Mirror rule.

", + "locationName":"trafficMirrorFilterRule" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateTrafficMirrorSessionRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "TrafficMirrorTargetId", + "TrafficMirrorFilterId", + "SessionNumber" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the source network interface.

" + }, + "TrafficMirrorTargetId":{ + "shape":"TrafficMirrorTargetId", + "documentation":"

The ID of the Traffic Mirror target.

" + }, + "TrafficMirrorFilterId":{ + "shape":"TrafficMirrorFilterId", + "documentation":"

The ID of the Traffic Mirror filter.

" + }, + "PacketLength":{ + "shape":"Integer", + "documentation":"

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

" + }, + "SessionNumber":{ + "shape":"Integer", + "documentation":"

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

" + }, + "VirtualNetworkId":{ + "shape":"Integer", + "documentation":"

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror session.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to a Traffic Mirror session.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + } + } + }, + "CreateTrafficMirrorSessionResult":{ + "type":"structure", + "members":{ + "TrafficMirrorSession":{ + "shape":"TrafficMirrorSession", + "documentation":"

Information about the Traffic Mirror session.

", + "locationName":"trafficMirrorSession" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateTrafficMirrorTargetRequest":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The network interface ID that is associated with the target.

" + }, + "NetworkLoadBalancerArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror target.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the Traffic Mirror target.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "idempotencyToken":true + } + } + }, + "CreateTrafficMirrorTargetResult":{ + "type":"structure", + "members":{ + "TrafficMirrorTarget":{ + "shape":"TrafficMirrorTarget", + "documentation":"

Information about the Traffic Mirror target.

", + "locationName":"trafficMirrorTarget" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + } + } + }, + "CreateTransitGatewayRequest":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the transit gateway.

" + }, + "Options":{ + "shape":"TransitGatewayRequestOptions", + "documentation":"

The transit gateway options.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the transit gateway.

", + "locationName":"TagSpecification" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayResult":{ + "type":"structure", + "members":{ + "TransitGateway":{ + "shape":"TransitGateway", + "documentation":"

Information about the transit gateway.

", + "locationName":"transitGateway" + } + } + }, + "CreateTransitGatewayRouteRequest":{ + "type":"structure", + "required":[ + "DestinationCidrBlock", + "TransitGatewayRouteTableId" + ], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

" + }, + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "Blackhole":{ + "shape":"Boolean", + "documentation":"

Indicates whether to drop traffic that matches this route.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayRouteResult":{ + "type":"structure", + "members":{ + "Route":{ + "shape":"TransitGatewayRoute", + "documentation":"

Information about the route.

", + "locationName":"route" + } + } + }, + "CreateTransitGatewayRouteTableRequest":{ + "type":"structure", + "required":["TransitGatewayId"], + "members":{ + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of the transit gateway.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the transit gateway route table.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayRouteTableResult":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTable":{ + "shape":"TransitGatewayRouteTable", + "documentation":"

Information about the transit gateway route table.

", + "locationName":"transitGatewayRouteTable" + } + } + }, + "CreateTransitGatewayVpcAttachmentRequest":{ + "type":"structure", + "required":[ + "TransitGatewayId", + "VpcId", + "SubnetIds" + ], + "members":{ + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of the transit gateway.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "SubnetIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet.

" + }, + "Options":{ + "shape":"CreateTransitGatewayVpcAttachmentRequestOptions", + "documentation":"

The VPC attachment options.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the VPC attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "CreateTransitGatewayVpcAttachmentRequestOptions":{ + "type":"structure", + "members":{ + "DnsSupport":{ + "shape":"DnsSupportValue", + "documentation":"

Enable or disable DNS support. The default is enable.

" + }, + "Ipv6Support":{ + "shape":"Ipv6SupportValue", + "documentation":"

Enable or disable IPv6 support. The default is enable.

" + } + }, + "documentation":"

Describes the options for a VPC attachment.

" + }, + "CreateTransitGatewayVpcAttachmentResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachment":{ + "shape":"TransitGatewayVpcAttachment", + "documentation":"

Information about the VPC attachment.

", + "locationName":"transitGatewayVpcAttachment" + } + } + }, + "CreateVolumePermission":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The group to be added or removed. The possible value is all.

", + "locationName":"group" + }, + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID to be added or removed.

", + "locationName":"userId" + } + }, + "documentation":"

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

" + }, + "CreateVolumePermissionList":{ + "type":"list", + "member":{ + "shape":"CreateVolumePermission", + "locationName":"item" + } + }, + "CreateVolumePermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Adds the specified AWS account ID or group to the list.

" + }, + "Remove":{ + "shape":"CreateVolumePermissionList", + "documentation":"

Removes the specified AWS account ID or group from the list.

" + } + }, + "documentation":"

Describes modifications to the list of create volume permissions for a volume.

" + }, + "CreateVolumeRequest":{ + "type":"structure", + "required":["AvailabilityZone"], + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to create the volume.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by Default in the Amazon Elastic Compute Cloud User Guide.

Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

", + "locationName":"encrypted" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

This parameter is valid only for Provisioned IOPS SSD (io1) volumes.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

At least one of Size or SnapshotId is required.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The snapshot from which to create the volume.

At least one of Size or SnapshotId are required.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

Default: gp2

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the volume during creation.

", + "locationName":"TagSpecification" + } + }, + "documentation":"

Contains the parameters for CreateVolume.

" + }, + "CreateVpcEndpointConnectionNotificationRequest":{ + "type":"structure", + "required":[ + "ConnectionNotificationArn", + "ConnectionEvents" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"ServiceId", + "documentation":"

The ID of the endpoint service.

" + }, + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"

The ID of the endpoint.

" + }, + "ConnectionNotificationArn":{ + "shape":"String", + "documentation":"

The ARN of the SNS topic for the notifications.

" + }, + "ConnectionEvents":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateVpcEndpointConnectionNotificationResult":{ + "type":"structure", + "members":{ + "ConnectionNotification":{ + "shape":"ConnectionNotification", + "documentation":"

Information about the notification.

", + "locationName":"connectionNotification" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + } + }, + "CreateVpcEndpointRequest":{ + "type":"structure", + "required":[ + "VpcId", + "ServiceName" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointType":{ + "shape":"VpcEndpointType", + "documentation":"

The type of endpoint.

Default: Gateway

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC in which the endpoint will be used.

" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.

" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

(Gateway endpoint) One or more route table IDs.

", + "locationName":"RouteTableId" + }, + "SubnetIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface.

", + "locationName":"SubnetId" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface.

", + "locationName":"SecurityGroupId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "PrivateDnsEnabled":{ + "shape":"Boolean", + "documentation":"

(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.

To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.

Default: true

" + } + }, + "documentation":"

Contains the parameters for CreateVpcEndpoint.

" + }, + "CreateVpcEndpointResult":{ + "type":"structure", + "members":{ + "VpcEndpoint":{ + "shape":"VpcEndpoint", + "documentation":"

Information about the endpoint.

", + "locationName":"vpcEndpoint" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + }, + "documentation":"

Contains the output of CreateVpcEndpoint.

" + }, + "CreateVpcEndpointServiceConfigurationRequest":{ + "type":"structure", + "required":["NetworkLoadBalancerArns"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "AcceptanceRequired":{ + "shape":"Boolean", + "documentation":"

Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.

" + }, + "NetworkLoadBalancerArns":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.

", + "locationName":"NetworkLoadBalancerArn" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + } + } + }, + "CreateVpcEndpointServiceConfigurationResult":{ + "type":"structure", + "members":{ + "ServiceConfiguration":{ + "shape":"ServiceConfiguration", + "documentation":"

Information about the service configuration.

", + "locationName":"serviceConfiguration" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

", + "locationName":"clientToken" + } + } + }, + "CreateVpcPeeringConnectionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PeerOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the accepter VPC.

Default: Your AWS account ID

", + "locationName":"peerOwnerId" + }, + "PeerVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request.

", + "locationName":"peerVpcId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the requester VPC. You must specify this parameter in the request.

", + "locationName":"vpcId" + }, + "PeerRegion":{ + "shape":"String", + "documentation":"

The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.

Default: The Region in which you make the request.

" + } + } + }, + "CreateVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnection":{ + "shape":"VpcPeeringConnection", + "documentation":"

Information about the VPC peering connection.

", + "locationName":"vpcPeeringConnection" + } + } + }, + "CreateVpcRequest":{ + "type":"structure", + "required":["CidrBlock"], + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + }, + "AmazonProvidedIpv6CidrBlock":{ + "shape":"Boolean", + "documentation":"

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.

", + "locationName":"amazonProvidedIpv6CidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName":"instanceTenancy" + } + } + }, + "CreateVpcResult":{ + "type":"structure", + "members":{ + "Vpc":{ + "shape":"Vpc", + "documentation":"

Information about the VPC.

", + "locationName":"vpc" + } + } + }, + "CreateVpnConnectionRequest":{ + "type":"structure", + "required":[ + "CustomerGatewayId", + "Type" + ], + "members":{ + "CustomerGatewayId":{ + "shape":"CustomerGatewayId", + "documentation":"

The ID of the customer gateway.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection (ipsec.1).

" + }, + "VpnGatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.

" + }, + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Options":{ + "shape":"VpnConnectionOptionsSpecification", + "documentation":"

The options for the VPN connection.

", + "locationName":"options" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnection.

" + }, + "CreateVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "documentation":"

Information about the VPN connection.

", + "locationName":"vpnConnection" + } + }, + "documentation":"

Contains the output of CreateVpnConnection.

" + }, + "CreateVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + }, + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the VPN connection.

" + } + }, + "documentation":"

Contains the parameters for CreateVpnConnectionRoute.

" + }, + "CreateVpnGatewayRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the virtual private gateway.

" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection this virtual private gateway supports.

" + }, + "AmazonSideAsn":{ + "shape":"Long", + "documentation":"

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range.

Default: 64512

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for CreateVpnGateway.

" + }, + "CreateVpnGatewayResult":{ + "type":"structure", + "members":{ + "VpnGateway":{ + "shape":"VpnGateway", + "documentation":"

Information about the virtual private gateway.

", + "locationName":"vpnGateway" + } + }, + "documentation":"

Contains the output of CreateVpnGateway.

" + }, + "CreditSpecification":{ + "type":"structure", + "members":{ + "CpuCredits":{ + "shape":"String", + "documentation":"

The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.

", + "locationName":"cpuCredits" + } + }, + "documentation":"

Describes the credit option for CPU usage of a T2 or T3 instance.

" + }, + "CreditSpecificationRequest":{ + "type":"structure", + "required":["CpuCredits"], + "members":{ + "CpuCredits":{ + "shape":"String", + "documentation":"

The credit option for CPU usage of a T2 or T3 instance. Valid values are standard and unlimited.

" + } + }, + "documentation":"

The credit option for CPU usage of a T2 or T3 instance.

" + }, + "CurrencyCodeValues":{ + "type":"string", + "enum":["USD"] + }, + "CustomerGateway":{ + "type":"structure", + "members":{ + "BgpAsn":{ + "shape":"String", + "documentation":"

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

", + "locationName":"bgpAsn" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway.

", + "locationName":"customerGatewayId" + }, + "IpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the customer gateway's outside interface.

", + "locationName":"ipAddress" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the customer gateway certificate.

", + "locationName":"certificateArn" + }, + "State":{ + "shape":"String", + "documentation":"

The current state of the customer gateway (pending | available | deleting | deleted).

", + "locationName":"state" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of VPN connection the customer gateway supports (ipsec.1).

", + "locationName":"type" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the customer gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a customer gateway.

" + }, + "CustomerGatewayId":{"type":"string"}, + "CustomerGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CustomerGatewayId" + } + }, + "CustomerGatewayList":{ + "type":"list", + "member":{ + "shape":"CustomerGateway", + "locationName":"item" + } + }, + "DatafeedSubscriptionState":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "DateTime":{"type":"timestamp"}, + "DefaultRouteTableAssociationValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "DefaultRouteTablePropagationValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "DefaultTargetCapacityType":{ + "type":"string", + "enum":[ + "spot", + "on-demand" + ] + }, + "DeleteClientVpnEndpointRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN to be deleted.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteClientVpnEndpointResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ClientVpnEndpointStatus", + "documentation":"

The current state of the Client VPN endpoint.

", + "locationName":"status" + } + } + }, + "DeleteClientVpnRouteRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "DestinationCidrBlock" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint from which the route is to be deleted.

" + }, + "TargetVpcSubnetId":{ + "shape":"String", + "documentation":"

The ID of the target subnet used by the route.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the route to be deleted.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteClientVpnRouteResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ClientVpnRouteStatus", + "documentation":"

The current state of the route.

", + "locationName":"status" + } + } + }, + "DeleteCustomerGatewayRequest":{ + "type":"structure", + "required":["CustomerGatewayId"], + "members":{ + "CustomerGatewayId":{ + "shape":"CustomerGatewayId", + "documentation":"

The ID of the customer gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteCustomerGateway.

" + }, + "DeleteDhcpOptionsRequest":{ + "type":"structure", + "required":["DhcpOptionsId"], + "members":{ + "DhcpOptionsId":{ + "shape":"DhcpOptionsId", + "documentation":"

The ID of the DHCP options set.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DeleteEgressOnlyInternetGatewayRequest":{ + "type":"structure", + "required":["EgressOnlyInternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"

The ID of the egress-only internet gateway.

" + } + } + }, + "DeleteEgressOnlyInternetGatewayResult":{ + "type":"structure", + "members":{ + "ReturnCode":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"returnCode" + } + } + }, + "DeleteFleetError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"DeleteFleetErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the error code.

", + "locationName":"message" + } + }, + "documentation":"

Describes an EC2 Fleet error.

" + }, + "DeleteFleetErrorCode":{ + "type":"string", + "enum":[ + "fleetIdDoesNotExist", + "fleetIdMalformed", + "fleetNotInDeletableState", + "unexpectedError" + ] + }, + "DeleteFleetErrorItem":{ + "type":"structure", + "members":{ + "Error":{ + "shape":"DeleteFleetError", + "documentation":"

The error.

", + "locationName":"error" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

", + "locationName":"fleetId" + } + }, + "documentation":"

Describes an EC2 Fleet that was not successfully deleted.

" + }, + "DeleteFleetErrorSet":{ + "type":"list", + "member":{ + "shape":"DeleteFleetErrorItem", + "locationName":"item" + } + }, + "DeleteFleetSuccessItem":{ + "type":"structure", + "members":{ + "CurrentFleetState":{ + "shape":"FleetStateCode", + "documentation":"

The current state of the EC2 Fleet.

", + "locationName":"currentFleetState" + }, + "PreviousFleetState":{ + "shape":"FleetStateCode", + "documentation":"

The previous state of the EC2 Fleet.

", + "locationName":"previousFleetState" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

", + "locationName":"fleetId" + } + }, + "documentation":"

Describes an EC2 Fleet that was successfully deleted.

" + }, + "DeleteFleetSuccessSet":{ + "type":"list", + "member":{ + "shape":"DeleteFleetSuccessItem", + "locationName":"item" + } + }, + "DeleteFleetsRequest":{ + "type":"structure", + "required":[ + "FleetIds", + "TerminateInstances" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FleetIds":{ + "shape":"FleetIdSet", + "documentation":"

The IDs of the EC2 Fleets.

", + "locationName":"FleetId" + }, + "TerminateInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.

" + } + } + }, + "DeleteFleetsResult":{ + "type":"structure", + "members":{ + "SuccessfulFleetDeletions":{ + "shape":"DeleteFleetSuccessSet", + "documentation":"

Information about the EC2 Fleets that are successfully deleted.

", + "locationName":"successfulFleetDeletionSet" + }, + "UnsuccessfulFleetDeletions":{ + "shape":"DeleteFleetErrorSet", + "documentation":"

Information about the EC2 Fleets that are not successfully deleted.

", + "locationName":"unsuccessfulFleetDeletionSet" + } + } + }, + "DeleteFlowLogsRequest":{ + "type":"structure", + "required":["FlowLogIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

", + "locationName":"FlowLogId" + } + } + }, + "DeleteFlowLogsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the flow logs that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + } + }, + "DeleteFpgaImageRequest":{ + "type":"structure", + "required":["FpgaImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId":{ + "shape":"FpgaImageId", + "documentation":"

The ID of the AFI.

" + } + } + }, + "DeleteFpgaImageResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + } + }, + "DeleteInternetGatewayRequest":{ + "type":"structure", + "required":["InternetGatewayId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"InternetGatewayId", + "documentation":"

The ID of the internet gateway.

", + "locationName":"internetGatewayId" + } + } + }, + "DeleteKeyPairRequest":{ + "type":"structure", + "required":["KeyName"], + "members":{ + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DeleteLaunchTemplateRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId":{ + "shape":"LaunchTemplateId", + "documentation":"

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + } + } + }, + "DeleteLaunchTemplateResult":{ + "type":"structure", + "members":{ + "LaunchTemplate":{ + "shape":"LaunchTemplate", + "documentation":"

Information about the launch template.

", + "locationName":"launchTemplate" + } + } + }, + "DeleteLaunchTemplateVersionsRequest":{ + "type":"structure", + "required":["Versions"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId":{ + "shape":"LaunchTemplateId", + "documentation":"

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "Versions":{ + "shape":"VersionStringList", + "documentation":"

The version numbers of one or more launch template versions to delete.

", + "locationName":"LaunchTemplateVersion" + } + } + }, + "DeleteLaunchTemplateVersionsResponseErrorItem":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

", + "locationName":"launchTemplateId" + }, + "LaunchTemplateName":{ + "shape":"String", + "documentation":"

The name of the launch template.

", + "locationName":"launchTemplateName" + }, + "VersionNumber":{ + "shape":"Long", + "documentation":"

The version number of the launch template.

", + "locationName":"versionNumber" + }, + "ResponseError":{ + "shape":"ResponseError", + "documentation":"

Information about the error.

", + "locationName":"responseError" + } + }, + "documentation":"

Describes a launch template version that could not be deleted.

" + }, + "DeleteLaunchTemplateVersionsResponseErrorSet":{ + "type":"list", + "member":{ + "shape":"DeleteLaunchTemplateVersionsResponseErrorItem", + "locationName":"item" + } + }, + "DeleteLaunchTemplateVersionsResponseSuccessItem":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

", + "locationName":"launchTemplateId" + }, + "LaunchTemplateName":{ + "shape":"String", + "documentation":"

The name of the launch template.

", + "locationName":"launchTemplateName" + }, + "VersionNumber":{ + "shape":"Long", + "documentation":"

The version number of the launch template.

", + "locationName":"versionNumber" + } + }, + "documentation":"

Describes a launch template version that was successfully deleted.

" + }, + "DeleteLaunchTemplateVersionsResponseSuccessSet":{ + "type":"list", + "member":{ + "shape":"DeleteLaunchTemplateVersionsResponseSuccessItem", + "locationName":"item" + } + }, + "DeleteLaunchTemplateVersionsResult":{ + "type":"structure", + "members":{ + "SuccessfullyDeletedLaunchTemplateVersions":{ + "shape":"DeleteLaunchTemplateVersionsResponseSuccessSet", + "documentation":"

Information about the launch template versions that were successfully deleted.

", + "locationName":"successfullyDeletedLaunchTemplateVersionSet" + }, + "UnsuccessfullyDeletedLaunchTemplateVersions":{ + "shape":"DeleteLaunchTemplateVersionsResponseErrorSet", + "documentation":"

Information about the launch template versions that could not be deleted.

", + "locationName":"unsuccessfullyDeletedLaunchTemplateVersionSet" + } + } + }, + "DeleteNatGatewayRequest":{ + "type":"structure", + "required":["NatGatewayId"], + "members":{ + "NatGatewayId":{ + "shape":"NatGatewayId", + "documentation":"

The ID of the NAT gateway.

" + } + } + }, + "DeleteNatGatewayResult":{ + "type":"structure", + "members":{ + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + } + } + }, + "DeleteNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "Egress", + "NetworkAclId", + "RuleNumber" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule.

", + "locationName":"egress" + }, + "NetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to delete.

", + "locationName":"ruleNumber" + } + } + }, + "DeleteNetworkAclRequest":{ + "type":"structure", + "required":["NetworkAclId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + } + } + }, + "DeleteNetworkInterfacePermissionRequest":{ + "type":"structure", + "required":["NetworkInterfacePermissionId"], + "members":{ + "NetworkInterfacePermissionId":{ + "shape":"String", + "documentation":"

The ID of the network interface permission.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specify true to remove the permission even if the network interface is attached to an instance.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkInterfacePermission.

" + }, + "DeleteNetworkInterfacePermissionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds, otherwise returns an error.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output for DeleteNetworkInterfacePermission.

" + }, + "DeleteNetworkInterfaceRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for DeleteNetworkInterface.

" + }, + "DeletePlacementGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + } + } + }, + "DeleteQueuedReservedInstancesError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"DeleteQueuedReservedInstancesErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

" + }, + "DeleteQueuedReservedInstancesErrorCode":{ + "type":"string", + "enum":[ + "reserved-instances-id-invalid", + "reserved-instances-not-in-queued-state", + "unexpected-error" + ] + }, + "DeleteQueuedReservedInstancesIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + }, + "max":100, + "min":1 + }, + "DeleteQueuedReservedInstancesRequest":{ + "type":"structure", + "required":["ReservedInstancesIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstancesIds":{ + "shape":"DeleteQueuedReservedInstancesIdList", + "documentation":"

The IDs of the Reserved Instances.

", + "locationName":"ReservedInstancesId" + } + } + }, + "DeleteQueuedReservedInstancesResult":{ + "type":"structure", + "members":{ + "SuccessfulQueuedPurchaseDeletions":{ + "shape":"SuccessfulQueuedPurchaseDeletionSet", + "documentation":"

Information about the queued purchases that were successfully deleted.

", + "locationName":"successfulQueuedPurchaseDeletionSet" + }, + "FailedQueuedPurchaseDeletions":{ + "shape":"FailedQueuedPurchaseDeletionSet", + "documentation":"

Information about the queued purchases that could not be deleted.

", + "locationName":"failedQueuedPurchaseDeletionSet" + } + } + }, + "DeleteRouteRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationCidrBlock" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", + "locationName":"destinationIpv6CidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteRouteTableRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + } + } + }, + "DeleteSecurityGroupRequest":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. Required for a nondefault VPC.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DeleteSnapshotRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the EBS snapshot.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSnapshot.

" + }, + "DeleteSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteSpotDatafeedSubscription.

" + }, + "DeleteSubnetRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":["Resources"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Resources":{ + "shape":"ResourceIdList", + "documentation":"

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

", + "locationName":"resourceId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string.

If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the aws: prefix).

", + "locationName":"tag" + } + } + }, + "DeleteTrafficMirrorFilterRequest":{ + "type":"structure", + "required":["TrafficMirrorFilterId"], + "members":{ + "TrafficMirrorFilterId":{ + "shape":"TrafficMirrorFilterId", + "documentation":"

The ID of the Traffic Mirror filter.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorFilterResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror filter.

", + "locationName":"trafficMirrorFilterId" + } + } + }, + "DeleteTrafficMirrorFilterRuleRequest":{ + "type":"structure", + "required":["TrafficMirrorFilterRuleId"], + "members":{ + "TrafficMirrorFilterRuleId":{ + "shape":"TrafficMirrorFilterRuleId", + "documentation":"

The ID of the Traffic Mirror rule.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorFilterRuleResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterRuleId":{ + "shape":"String", + "documentation":"

The ID of the deleted Traffic Mirror rule.

", + "locationName":"trafficMirrorFilterRuleId" + } + } + }, + "DeleteTrafficMirrorSessionRequest":{ + "type":"structure", + "required":["TrafficMirrorSessionId"], + "members":{ + "TrafficMirrorSessionId":{ + "shape":"TrafficMirrorSessionId", + "documentation":"

The ID of the Traffic Mirror session.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorSessionResult":{ + "type":"structure", + "members":{ + "TrafficMirrorSessionId":{ + "shape":"String", + "documentation":"

The ID of the deleted Traffic Mirror session.

", + "locationName":"trafficMirrorSessionId" + } + } + }, + "DeleteTrafficMirrorTargetRequest":{ + "type":"structure", + "required":["TrafficMirrorTargetId"], + "members":{ + "TrafficMirrorTargetId":{ + "shape":"TrafficMirrorTargetId", + "documentation":"

The ID of the Traffic Mirror target.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTrafficMirrorTargetResult":{ + "type":"structure", + "members":{ + "TrafficMirrorTargetId":{ + "shape":"String", + "documentation":"

The ID of the deleted Traffic Mirror target.

", + "locationName":"trafficMirrorTargetId" + } + } + }, + "DeleteTransitGatewayRequest":{ + "type":"structure", + "required":["TransitGatewayId"], + "members":{ + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of the transit gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayResult":{ + "type":"structure", + "members":{ + "TransitGateway":{ + "shape":"TransitGateway", + "documentation":"

Information about the deleted transit gateway.

", + "locationName":"transitGateway" + } + } + }, + "DeleteTransitGatewayRouteRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "DestinationCidrBlock" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range for the route. This must match the CIDR for the route exactly.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayRouteResult":{ + "type":"structure", + "members":{ + "Route":{ + "shape":"TransitGatewayRoute", + "documentation":"

Information about the route.

", + "locationName":"route" + } + } + }, + "DeleteTransitGatewayRouteTableRequest":{ + "type":"structure", + "required":["TransitGatewayRouteTableId"], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayRouteTableResult":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTable":{ + "shape":"TransitGatewayRouteTable", + "documentation":"

Information about the deleted transit gateway route table.

", + "locationName":"transitGatewayRouteTable" + } + } + }, + "DeleteTransitGatewayVpcAttachmentRequest":{ + "type":"structure", + "required":["TransitGatewayAttachmentId"], + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeleteTransitGatewayVpcAttachmentResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachment":{ + "shape":"TransitGatewayVpcAttachment", + "documentation":"

Information about the deleted VPC attachment.

", + "locationName":"transitGatewayVpcAttachment" + } + } + }, + "DeleteVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the volume.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteVolume.

" + }, + "DeleteVpcEndpointConnectionNotificationsRequest":{ + "type":"structure", + "required":["ConnectionNotificationIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ConnectionNotificationIds":{ + "shape":"ValueStringList", + "documentation":"

One or more notification IDs.

", + "locationName":"ConnectionNotificationId" + } + } + }, + "DeleteVpcEndpointConnectionNotificationsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the notifications that could not be deleted successfully.

", + "locationName":"unsuccessful" + } + } + }, + "DeleteVpcEndpointServiceConfigurationsRequest":{ + "type":"structure", + "required":["ServiceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more services.

", + "locationName":"ServiceId" + } + } + }, + "DeleteVpcEndpointServiceConfigurationsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the service configurations that were not deleted, if applicable.

", + "locationName":"unsuccessful" + } + } + }, + "DeleteVpcEndpointsRequest":{ + "type":"structure", + "required":["VpcEndpointIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC endpoint IDs.

", + "locationName":"VpcEndpointId" + } + }, + "documentation":"

Contains the parameters for DeleteVpcEndpoints.

" + }, + "DeleteVpcEndpointsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the VPC endpoints that were not successfully deleted.

", + "locationName":"unsuccessful" + } + }, + "documentation":"

Contains the output of DeleteVpcEndpoints.

" + }, + "DeleteVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "DeleteVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DeleteVpcRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DeleteVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the VPN connection.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnection.

" + }, + "DeleteVpnConnectionRouteRequest":{ + "type":"structure", + "required":[ + "DestinationCidrBlock", + "VpnConnectionId" + ], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer network.

" + }, + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the VPN connection.

" + } + }, + "documentation":"

Contains the parameters for DeleteVpnConnectionRoute.

" + }, + "DeleteVpnGatewayRequest":{ + "type":"structure", + "required":["VpnGatewayId"], + "members":{ + "VpnGatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeleteVpnGateway.

" + }, + "DeprovisionByoipCidrRequest":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DeprovisionByoipCidrResult":{ + "type":"structure", + "members":{ + "ByoipCidr":{ + "shape":"ByoipCidr", + "documentation":"

Information about the address range.

", + "locationName":"byoipCidr" + } + } + }, + "DeregisterImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"ImageId", + "documentation":"

The ID of the AMI.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DeregisterImage.

" + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + "AttributeNames":{ + "shape":"AccountAttributeNameStringList", + "documentation":"

The account attribute names.

", + "locationName":"attributeName" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AccountAttributeList", + "documentation":"

Information about the account attributes.

", + "locationName":"accountAttributeSet" + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

  • allocation-id - [EC2-VPC] The allocation ID for the address.

  • association-id - [EC2-VPC] The association ID for the address.

  • domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).

  • instance-id - The ID of the instance the address is associated with, if any.

  • network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.

  • network-interface-owner-id - The AWS account ID of the owner.

  • private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.

  • public-ip - The Elastic IP address.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "PublicIps":{ + "shape":"PublicIpStringList", + "documentation":"

One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

", + "locationName":"PublicIp" + }, + "AllocationIds":{ + "shape":"AllocationIdList", + "documentation":"

[EC2-VPC] Information about the allocation IDs.

", + "locationName":"AllocationId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

Information about the Elastic IP addresses.

", + "locationName":"addressesSet" + } + } + }, + "DescribeAggregateIdFormatRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeAggregateIdFormatResult":{ + "type":"structure", + "members":{ + "UseLongIdsAggregated":{ + "shape":"Boolean", + "documentation":"

Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.

", + "locationName":"useLongIdsAggregated" + }, + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about each resource's ID format.

", + "locationName":"statusSet" + } + } + }, + "DescribeAvailabilityZonesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • message - Information about the Availability Zone.

  • region-name - The name of the Region for the Availability Zone (for example, us-east-1).

  • state - The state of the Availability Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1).

  • zone-name - The name of the Availability Zone (for example, us-east-1a).

", + "locationName":"Filter" + }, + "ZoneNames":{ + "shape":"ZoneNameStringList", + "documentation":"

The names of the Availability Zones.

", + "locationName":"ZoneName" + }, + "ZoneIds":{ + "shape":"ZoneIdStringList", + "documentation":"

The IDs of the Availability Zones.

", + "locationName":"ZoneId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeAvailabilityZonesResult":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

Information about the Availability Zones.

", + "locationName":"availabilityZoneInfo" + } + } + }, + "DescribeBundleTasksRequest":{ + "type":"structure", + "members":{ + "BundleIds":{ + "shape":"BundleIdStringList", + "documentation":"

The bundle task IDs.

Default: Describes all your bundle tasks.

", + "locationName":"BundleId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • bundle-id - The ID of the bundle task.

  • error-code - If the task failed, the error code returned.

  • error-message - If the task failed, the error message returned.

  • instance-id - The ID of the instance.

  • progress - The level of task completion, as a percentage (for example, 20%).

  • s3-bucket - The Amazon S3 bucket to store the AMI.

  • s3-prefix - The beginning of the AMI name.

  • start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).

  • state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).

  • update-time - The time of the most recent update for the task.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeBundleTasksResult":{ + "type":"structure", + "members":{ + "BundleTasks":{ + "shape":"BundleTaskList", + "documentation":"

Information about the bundle tasks.

", + "locationName":"bundleInstanceTasksSet" + } + } + }, + "DescribeByoipCidrsMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "DescribeByoipCidrsRequest":{ + "type":"structure", + "required":["MaxResults"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"DescribeByoipCidrsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeByoipCidrsResult":{ + "type":"structure", + "members":{ + "ByoipCidrs":{ + "shape":"ByoipCidrSet", + "documentation":"

Information about your address ranges.

", + "locationName":"byoipCidrSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeCapacityReservationsMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "DescribeCapacityReservationsRequest":{ + "type":"structure", + "members":{ + "CapacityReservationIds":{ + "shape":"CapacityReservationIdSet", + "documentation":"

The ID of the Capacity Reservation.

", + "locationName":"CapacityReservationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeCapacityReservationsMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeCapacityReservationsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "CapacityReservations":{ + "shape":"CapacityReservationSet", + "documentation":"

Information about the Capacity Reservations.

", + "locationName":"capacityReservationSet" + } + } + }, + "DescribeClassicLinkInstancesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClassicLinkInstancesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • group-id - The ID of a VPC security group that's associated with the instance.

  • instance-id - The ID of the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC to which the instance is linked.

    vpc-id - The ID of the VPC that the instance is linked to.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

", + "locationName":"InstanceId" + }, + "MaxResults":{ + "shape":"DescribeClassicLinkInstancesMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

Constraint: If the value is greater than 1000, we return only 1000 items.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeClassicLinkInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"ClassicLinkInstanceList", + "documentation":"

Information about one or more linked EC2-Classic instances.

", + "locationName":"instancesSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeClientVpnAuthorizationRulesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClientVpnAuthorizationRulesRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"DescribeClientVpnAuthorizationRulesMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + } + } + }, + "DescribeClientVpnAuthorizationRulesResult":{ + "type":"structure", + "members":{ + "AuthorizationRules":{ + "shape":"AuthorizationRuleSet", + "documentation":"

Information about the authorization rules.

", + "locationName":"authorizationRule" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeClientVpnConnectionsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClientVpnConnectionsRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeClientVpnConnectionsMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnConnectionsResult":{ + "type":"structure", + "members":{ + "Connections":{ + "shape":"ClientVpnConnectionSet", + "documentation":"

Information about the active and terminated client connections.

", + "locationName":"connections" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeClientVpnEndpointMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClientVpnEndpointsRequest":{ + "type":"structure", + "members":{ + "ClientVpnEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

The ID of the Client VPN endpoint.

", + "locationName":"ClientVpnEndpointId" + }, + "MaxResults":{ + "shape":"DescribeClientVpnEndpointMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnEndpointsResult":{ + "type":"structure", + "members":{ + "ClientVpnEndpoints":{ + "shape":"EndpointSet", + "documentation":"

Information about the Client VPN endpoints.

", + "locationName":"clientVpnEndpoint" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeClientVpnRoutesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClientVpnRoutesRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"DescribeClientVpnRoutesMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnRoutesResult":{ + "type":"structure", + "members":{ + "Routes":{ + "shape":"ClientVpnRouteSet", + "documentation":"

Information about the Client VPN endpoint routes.

", + "locationName":"routes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeClientVpnTargetNetworksMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeClientVpnTargetNetworksRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "AssociationIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the target network associations.

" + }, + "MaxResults":{ + "shape":"DescribeClientVpnTargetNetworksMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. Filter names and values are case-sensitive.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeClientVpnTargetNetworksResult":{ + "type":"structure", + "members":{ + "ClientVpnTargetNetworks":{ + "shape":"TargetNetworkSet", + "documentation":"

Information about the associated target networks.

", + "locationName":"clientVpnTargetNetworks" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeConversionTaskList":{ + "type":"list", + "member":{ + "shape":"ConversionTask", + "locationName":"item" + } + }, + "DescribeConversionTasksRequest":{ + "type":"structure", + "members":{ + "ConversionTaskIds":{ + "shape":"ConversionIdStringList", + "documentation":"

The conversion task IDs.

", + "locationName":"conversionTaskId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeConversionTasksResult":{ + "type":"structure", + "members":{ + "ConversionTasks":{ + "shape":"DescribeConversionTaskList", + "documentation":"

Information about the conversion tasks.

", + "locationName":"conversionTasks" + } + } + }, + "DescribeCustomerGatewaysRequest":{ + "type":"structure", + "members":{ + "CustomerGatewayIds":{ + "shape":"CustomerGatewayIdStringList", + "documentation":"

One or more customer gateway IDs.

Default: Describes all your customer gateways.

", + "locationName":"CustomerGatewayId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • bgp-asn - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

  • customer-gateway-id - The ID of the customer gateway.

  • ip-address - The IP address of the customer gateway's Internet-routable external interface.

  • state - The state of the customer gateway (pending | available | deleting | deleted).

  • type - The type of customer gateway. Currently, the only supported type is ipsec.1.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeCustomerGateways.

" + }, + "DescribeCustomerGatewaysResult":{ + "type":"structure", + "members":{ + "CustomerGateways":{ + "shape":"CustomerGatewayList", + "documentation":"

Information about one or more customer gateways.

", + "locationName":"customerGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeCustomerGateways.

" + }, + "DescribeDhcpOptionsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeDhcpOptionsRequest":{ + "type":"structure", + "members":{ + "DhcpOptionsIds":{ + "shape":"DhcpOptionsIdStringList", + "documentation":"

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

", + "locationName":"DhcpOptionsId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • dhcp-options-id - The ID of a DHCP options set.

  • key - The key for one of the options (for example, domain-name).

  • value - The value for one of the options.

  • owner-id - The ID of the AWS account that owns the DHCP options set.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeDhcpOptionsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeDhcpOptionsResult":{ + "type":"structure", + "members":{ + "DhcpOptions":{ + "shape":"DhcpOptionsList", + "documentation":"

Information about one or more DHCP options sets.

", + "locationName":"dhcpOptionsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeEgressOnlyInternetGatewaysMaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "DescribeEgressOnlyInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EgressOnlyInternetGatewayIds":{ + "shape":"EgressOnlyInternetGatewayIdList", + "documentation":"

One or more egress-only internet gateway IDs.

", + "locationName":"EgressOnlyInternetGatewayId" + }, + "MaxResults":{ + "shape":"DescribeEgressOnlyInternetGatewaysMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeEgressOnlyInternetGatewaysResult":{ + "type":"structure", + "members":{ + "EgressOnlyInternetGateways":{ + "shape":"EgressOnlyInternetGatewayList", + "documentation":"

Information about the egress-only internet gateways.

", + "locationName":"egressOnlyInternetGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeElasticGpusMaxResults":{ + "type":"integer", + "max":1000, + "min":10 + }, + "DescribeElasticGpusRequest":{ + "type":"structure", + "members":{ + "ElasticGpuIds":{ + "shape":"ElasticGpuIdSet", + "documentation":"

The Elastic Graphics accelerator IDs.

", + "locationName":"ElasticGpuId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.

  • elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).

  • elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).

  • elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.

  • instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"DescribeElasticGpusMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "DescribeElasticGpusResult":{ + "type":"structure", + "members":{ + "ElasticGpuSet":{ + "shape":"ElasticGpuSet", + "documentation":"

Information about the Elastic Graphics accelerators.

", + "locationName":"elasticGpuSet" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

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

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeExportImageTasksMaxResults":{ + "type":"integer", + "max":500, + "min":1 + }, + "DescribeExportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

", + "locationName":"Filter" + }, + "ExportImageTaskIds":{ + "shape":"ExportImageTaskIdList", + "documentation":"

The IDs of the export image tasks.

", + "locationName":"ExportImageTaskId" + }, + "MaxResults":{ + "shape":"DescribeExportImageTasksMaxResults", + "documentation":"

The maximum number of results to return in a single call.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates the next page of results.

" + } + } + }, + "DescribeExportImageTasksResult":{ + "type":"structure", + "members":{ + "ExportImageTasks":{ + "shape":"ExportImageTaskList", + "documentation":"

Information about the export image tasks.

", + "locationName":"exportImageTaskSet" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "ExportTaskIds":{ + "shape":"ExportTaskIdStringList", + "documentation":"

The export task IDs.

", + "locationName":"exportTaskId" + } + } + }, + "DescribeExportTasksResult":{ + "type":"structure", + "members":{ + "ExportTasks":{ + "shape":"ExportTaskList", + "documentation":"

Information about the export tasks.

", + "locationName":"exportTaskSet" + } + } + }, + "DescribeFleetError":{ + "type":"structure", + "members":{ + "LaunchTemplateAndOverrides":{ + "shape":"LaunchTemplateAndOverridesResponse", + "documentation":"

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName":"launchTemplateAndOverrides" + }, + "Lifecycle":{ + "shape":"InstanceLifecycle", + "documentation":"

Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.

", + "locationName":"lifecycle" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

The error code that indicates why the instance could not be launched. For more information about error codes, see Error Codes.

", + "locationName":"errorCode" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message that describes why the instance could not be launched. For more information about error messages, see ee Error Codes.

", + "locationName":"errorMessage" + } + }, + "documentation":"

Describes the instances that could not be launched by the fleet.

" + }, + "DescribeFleetHistoryRequest":{ + "type":"structure", + "required":[ + "FleetId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "EventType":{ + "shape":"FleetEventType", + "documentation":"

The type of events to describe. By default, all events are described.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + } + }, + "DescribeFleetHistoryResult":{ + "type":"structure", + "members":{ + "HistoryRecords":{ + "shape":"HistoryRecordSet", + "documentation":"

Information about the events in the history of the EC2 Fleet.

", + "locationName":"historyRecordSet" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC Fleet.

", + "locationName":"fleetId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + } + } + }, + "DescribeFleetInstancesRequest":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • instance-type - The instance type.

", + "locationName":"Filter" + } + } + }, + "DescribeFleetInstancesResult":{ + "type":"structure", + "members":{ + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. This list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

", + "locationName":"fleetId" + } + } + }, + "DescribeFleetsErrorSet":{ + "type":"list", + "member":{ + "shape":"DescribeFleetError", + "locationName":"item" + } + }, + "DescribeFleetsInstances":{ + "type":"structure", + "members":{ + "LaunchTemplateAndOverrides":{ + "shape":"LaunchTemplateAndOverridesResponse", + "documentation":"

The launch templates and overrides that were used for launching the instances. Any parameters that you specify in the Overrides override the same parameters in the launch template.

", + "locationName":"launchTemplateAndOverrides" + }, + "Lifecycle":{ + "shape":"InstanceLifecycle", + "documentation":"

Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.

", + "locationName":"lifecycle" + }, + "InstanceIds":{ + "shape":"InstanceIdsSet", + "documentation":"

The IDs of the instances.

", + "locationName":"instanceIds" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + } + }, + "documentation":"

Describes the instances that were launched by the fleet.

" + }, + "DescribeFleetsInstancesSet":{ + "type":"list", + "member":{ + "shape":"DescribeFleetsInstances", + "locationName":"item" + } + }, + "DescribeFleetsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "FleetIds":{ + "shape":"FleetIdSet", + "documentation":"

The ID of the EC2 Fleets.

", + "locationName":"FleetId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).

  • excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).

  • fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).

  • replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).

  • type - The type of request (instant | request | maintain).

", + "locationName":"Filter" + } + } + }, + "DescribeFleetsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "Fleets":{ + "shape":"FleetSet", + "documentation":"

Information about the EC2 Fleets.

", + "locationName":"fleetSet" + } + } + }, + "DescribeFlowLogsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).

  • log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3.

  • flow-log-id - The ID of the flow log.

  • log-group-name - The name of the log group.

  • resource-id - The ID of the VPC, subnet, or network interface.

  • traffic-type - The type of traffic (ACCEPT | REJECT | ALL).

" + }, + "FlowLogIds":{ + "shape":"ValueStringList", + "documentation":"

One or more flow log IDs.

Constraint: Maximum of 1000 flow log IDs.

", + "locationName":"FlowLogId" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeFlowLogsResult":{ + "type":"structure", + "members":{ + "FlowLogs":{ + "shape":"FlowLogSet", + "documentation":"

Information about the flow logs.

", + "locationName":"flowLogSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeFpgaImageAttributeRequest":{ + "type":"structure", + "required":[ + "FpgaImageId", + "Attribute" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId":{ + "shape":"String", + "documentation":"

The ID of the AFI.

" + }, + "Attribute":{ + "shape":"FpgaImageAttributeName", + "documentation":"

The AFI attribute.

" + } + } + }, + "DescribeFpgaImageAttributeResult":{ + "type":"structure", + "members":{ + "FpgaImageAttribute":{ + "shape":"FpgaImageAttribute", + "documentation":"

Information about the attribute.

", + "locationName":"fpgaImageAttribute" + } + } + }, + "DescribeFpgaImagesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeFpgaImagesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageIds":{ + "shape":"FpgaImageIdList", + "documentation":"

The AFI IDs.

", + "locationName":"FpgaImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).

", + "locationName":"Owner" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • create-time - The creation time of the AFI.

  • fpga-image-id - The FPGA image identifier (AFI ID).

  • fpga-image-global-id - The global FPGA image identifier (AGFI ID).

  • name - The name of the AFI.

  • owner-id - The AWS account ID of the AFI owner.

  • product-code - The product code.

  • shell-version - The version of the AWS Shell that was used to create the bitstream.

  • state - The state of the AFI (pending | failed | available | unavailable).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • update-time - The time of the most recent update.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeFpgaImagesMaxResults", + "documentation":"

The maximum number of results to return in a single call.

" + } + } + }, + "DescribeFpgaImagesResult":{ + "type":"structure", + "members":{ + "FpgaImages":{ + "shape":"FpgaImageList", + "documentation":"

Information about the FPGA images.

", + "locationName":"fpgaImageSet" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostReservationOfferingsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"FilterList", + "documentation":"

The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

" + }, + "MaxDuration":{ + "shape":"Integer", + "documentation":"

This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

" + }, + "MaxResults":{ + "shape":"DescribeHostReservationsMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + }, + "MinDuration":{ + "shape":"Integer", + "documentation":"

This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation offering.

" + } + } + }, + "DescribeHostReservationOfferingsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "OfferingSet":{ + "shape":"HostOfferingSet", + "documentation":"

Information about the offerings.

", + "locationName":"offeringSet" + } + } + }, + "DescribeHostReservationsMaxResults":{ + "type":"integer", + "max":500, + "min":5 + }, + "DescribeHostReservationsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"FilterList", + "documentation":"

The filters.

  • instance-family - The instance family (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

  • state - The state of the reservation (payment-pending | payment-failed | active | retired).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

" + }, + "HostReservationIdSet":{ + "shape":"HostReservationIdSet", + "documentation":"

The host reservation IDs.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

" + } + } + }, + "DescribeHostReservationsResult":{ + "type":"structure", + "members":{ + "HostReservationSet":{ + "shape":"HostReservationSet", + "documentation":"

Details about the reservation's configuration.

", + "locationName":"hostReservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"FilterList", + "documentation":"

The filters.

  • auto-placement - Whether auto-placement is enabled or disabled (on | off).

  • availability-zone - The Availability Zone of the host.

  • client-token - The idempotency token that you provided when you allocated the host.

  • host-reservation-id - The ID of the reservation assigned to this host.

  • instance-type - The instance type size that the Dedicated Host is configured to support.

  • state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"filter" + }, + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches.

", + "locationName":"hostId" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

You cannot specify this parameter and the host IDs parameter in the same request.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeHostsResult":{ + "type":"structure", + "members":{ + "Hosts":{ + "shape":"HostList", + "documentation":"

Information about the Dedicated Hosts.

", + "locationName":"hostSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeIamInstanceProfileAssociationsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeIamInstanceProfileAssociationsRequest":{ + "type":"structure", + "members":{ + "AssociationIds":{ + "shape":"AssociationIdList", + "documentation":"

The IAM instance profile associations.

", + "locationName":"AssociationId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • instance-id - The ID of the instance.

  • state - The state of the association (associating | associated | disassociating | disassociated).

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"DescribeIamInstanceProfileAssociationsMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "DescribeIamInstanceProfileAssociationsResult":{ + "type":"structure", + "members":{ + "IamInstanceProfileAssociations":{ + "shape":"IamInstanceProfileAssociationSet", + "documentation":"

Information about the IAM instance profile associations.

", + "locationName":"iamInstanceProfileAssociationSet" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeIdFormatRequest":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

" + } + } + }, + "DescribeIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resource.

", + "locationName":"statusSet" + } + } + }, + "DescribeIdentityIdFormatRequest":{ + "type":"structure", + "required":["PrincipalArn"], + "members":{ + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM role, IAM user, or the root user.

", + "locationName":"principalArn" + }, + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

", + "locationName":"resource" + } + } + }, + "DescribeIdentityIdFormatResult":{ + "type":"structure", + "members":{ + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

Information about the ID format for the resources.

", + "locationName":"statusSet" + } + } + }, + "DescribeImageAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "ImageId" + ], + "members":{ + "Attribute":{ + "shape":"ImageAttributeName", + "documentation":"

The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.

" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeImageAttribute.

" + }, + "DescribeImagesRequest":{ + "type":"structure", + "members":{ + "ExecutableUsers":{ + "shape":"ExecutableByStringList", + "documentation":"

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

", + "locationName":"ExecutableBy" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • architecture - The image architecture (i386 | x86_64 | arm64).

  • block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

  • block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

  • block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).

  • block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.

  • description - The description of the image (provided during image creation).

  • ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

  • hypervisor - The hypervisor type (ovm | xen).

  • image-id - The ID of the image.

  • image-type - The image type (machine | kernel | ramdisk).

  • is-public - A Boolean that indicates whether the image is public.

  • kernel-id - The kernel ID.

  • manifest-location - The location of the image manifest.

  • name - The name of the AMI (provided during image creation).

  • owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The AWS account ID of the image owner.

  • platform - The platform. To only list Windows-based AMIs, use windows.

  • product-code - The product code.

  • product-code.type - The type of the product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • state - The state of the image (available | pending | failed).

  • state-reason-code - The reason code for the state change.

  • state-reason-message - The message for the state change.

  • sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • virtualization-type - The virtualization type (paravirtual | hvm).

", + "locationName":"Filter" + }, + "ImageIds":{ + "shape":"ImageIdStringList", + "documentation":"

The image IDs.

Default: Describes all images available to you.

", + "locationName":"ImageId" + }, + "Owners":{ + "shape":"OwnerStringList", + "documentation":"

Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.

", + "locationName":"Owner" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"ImageList", + "documentation":"

Information about the images.

", + "locationName":"imagesSet" + } + } + }, + "DescribeImportImageTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

The IDs of the import image tasks.

", + "locationName":"ImportTaskId" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + } + } + }, + "DescribeImportImageTasksResult":{ + "type":"structure", + "members":{ + "ImportImageTasks":{ + "shape":"ImportImageTaskList", + "documentation":"

A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importImageTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeImportSnapshotTasksRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

" + }, + "ImportTaskIds":{ + "shape":"ImportTaskIdList", + "documentation":"

A list of import snapshot task IDs.

", + "locationName":"ImportTaskId" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token that indicates the next page of results.

" + } + } + }, + "DescribeImportSnapshotTasksResult":{ + "type":"structure", + "members":{ + "ImportSnapshotTasks":{ + "shape":"ImportSnapshotTaskList", + "documentation":"

A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.

", + "locationName":"importSnapshotTaskSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to get the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "InstanceId" + ], + "members":{ + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The instance attribute.

Note: The enaSupport attribute is not supported at this time.

", + "locationName":"attribute" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + } + } + }, + "DescribeInstanceCreditSpecificationsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeInstanceCreditSpecificationsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • instance-id - The ID of the instance.

", + "locationName":"Filter" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 1000 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "MaxResults":{ + "shape":"DescribeInstanceCreditSpecificationsMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + } + }, + "DescribeInstanceCreditSpecificationsResult":{ + "type":"structure", + "members":{ + "InstanceCreditSpecifications":{ + "shape":"InstanceCreditSpecificationList", + "documentation":"

Information about the credit option for CPU usage of an instance.

", + "locationName":"instanceCreditSpecificationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstanceStatusRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • availability-zone - The Availability Zone of the instance.

  • event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).

  • event.description - A description of the event.

  • event.instance-event-id - The ID of the event whose date and time you are modifying.

  • event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).

  • event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).

  • instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).

  • instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

  • system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).

  • system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).

", + "locationName":"Filter" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

", + "locationName":"InstanceId" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "IncludeAllInstances":{ + "shape":"Boolean", + "documentation":"

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

", + "locationName":"includeAllInstances" + } + } + }, + "DescribeInstanceStatusResult":{ + "type":"structure", + "members":{ + "InstanceStatuses":{ + "shape":"InstanceStatusList", + "documentation":"

Information about the status of the instances.

", + "locationName":"instanceStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • affinity - The affinity setting for an instance running on a Dedicated Host (default | host).

  • architecture - The instance architecture (i386 | x86_64 | arm64).

  • availability-zone - The Availability Zone of the instance.

  • block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.

  • block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.

  • block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).

  • block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).

  • block-device-mapping.volume-id - The volume ID of the EBS volume.

  • client-token - The idempotency token you provided when you launched the instance.

  • dns-name - The public DNS name of the instance.

  • group-id - The ID of the security group for the instance. EC2-Classic only.

  • group-name - The name of the security group for the instance. EC2-Classic only.

  • hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.

  • host-id - The ID of the Dedicated Host on which the instance is running, if applicable.

  • hypervisor - The hypervisor type of the instance (ovm | xen).

  • iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.

  • image-id - The ID of the image used to launch the instance.

  • instance-id - The ID of the instance.

  • instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).

  • instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).

  • instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).

  • instance-type - The type of instance (for example, t2.micro).

  • instance.group-id - The ID of the security group for the instance.

  • instance.group-name - The name of the security group for the instance.

  • ip-address - The public IPv4 address of the instance.

  • kernel-id - The kernel ID.

  • key-name - The name of the key pair used when the instance was launched.

  • launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).

  • launch-time - The time when the instance was launched.

  • monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).

  • network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.

  • network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.

  • network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.

  • network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.

  • network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • network-interface.attachment.attachment-id - The ID of the interface attachment.

  • network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.

  • network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • network-interface.attachment.device-index - The device index to which the network interface is attached.

  • network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • network-interface.attachment.attach-time - The time that the network interface was attached to an instance.

  • network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.

  • network-interface.availability-zone - The Availability Zone for the network interface.

  • network-interface.description - The description of the network interface.

  • network-interface.group-id - The ID of a security group associated with the network interface.

  • network-interface.group-name - The name of a security group associated with the network interface.

  • network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.

  • network-interface.mac-address - The MAC address of the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.owner-id - The ID of the owner of the network interface.

  • network-interface.private-dns-name - The private DNS name of the network interface.

  • network-interface.requester-id - The requester ID for the network interface.

  • network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.

  • network-interface.status - The status of the network interface (available) | in-use).

  • network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • network-interface.subnet-id - The ID of the subnet for the network interface.

  • network-interface.vpc-id - The ID of the VPC for the network interface.

  • owner-id - The AWS account ID of the instance owner.

  • placement-group-name - The name of the placement group for the instance.

  • placement-partition-number - The partition in which the instance is located.

  • platform - The platform. To list only Windows instances, use windows.

  • private-dns-name - The private IPv4 DNS name of the instance.

  • private-ip-address - The private IPv4 address of the instance.

  • product-code - The product code associated with the AMI used to launch the instance.

  • product-code.type - The type of product code (devpay | marketplace).

  • ramdisk-id - The RAM disk ID.

  • reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.

  • root-device-name - The device name of the root device volume (for example, /dev/sda1).

  • root-device-type - The type of the root device volume (ebs | instance-store).

  • source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.

  • spot-instance-request-id - The ID of the Spot Instance request.

  • state-reason-code - The reason code for the state change.

  • state-reason-message - A message that describes the state change.

  • subnet-id - The ID of the subnet for the instance.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.

  • tenancy - The tenancy of an instance (dedicated | default | host).

  • virtualization-type - The virtualization type of the instance (paravirtual | hvm).

  • vpc-id - The ID of the VPC that the instance is running in.

", + "locationName":"Filter" + }, + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The instance IDs.

Default: Describes all your instances.

", + "locationName":"InstanceId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Reservations":{ + "shape":"ReservationList", + "documentation":"

Information about the reservations.

", + "locationName":"reservationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeInternetGatewaysMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeInternetGatewaysRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.

  • attachment.vpc-id - The ID of an attached VPC.

  • internet-gateway-id - The ID of the Internet gateway.

  • owner-id - The ID of the AWS account that owns the internet gateway.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more internet gateway IDs.

Default: Describes all your internet gateways.

", + "locationName":"internetGatewayId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeInternetGatewaysMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeInternetGatewaysResult":{ + "type":"structure", + "members":{ + "InternetGateways":{ + "shape":"InternetGatewayList", + "documentation":"

Information about one or more internet gateways.

", + "locationName":"internetGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeKeyPairsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • fingerprint - The fingerprint of the key pair.

  • key-name - The name of the key pair.

", + "locationName":"Filter" + }, + "KeyNames":{ + "shape":"KeyNameStringList", + "documentation":"

The key pair names.

Default: Describes all your key pairs.

", + "locationName":"KeyName" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeKeyPairsResult":{ + "type":"structure", + "members":{ + "KeyPairs":{ + "shape":"KeyPairList", + "documentation":"

Information about the key pairs.

", + "locationName":"keySet" + } + } + }, + "DescribeLaunchTemplateVersionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "Versions":{ + "shape":"VersionStringList", + "documentation":"

One or more versions of the launch template.

", + "locationName":"LaunchTemplateVersion" + }, + "MinVersion":{ + "shape":"String", + "documentation":"

The version number after which to describe launch template versions.

" + }, + "MaxVersion":{ + "shape":"String", + "documentation":"

The version number up to which to describe launch template versions.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • create-time - The time the launch template version was created.

  • ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.

  • iam-instance-profile - The ARN of the IAM instance profile.

  • image-id - The ID of the AMI.

  • instance-type - The instance type.

  • is-default-version - A boolean that indicates whether the launch template version is the default version.

  • kernel-id - The kernel ID.

  • ram-disk-id - The RAM disk ID.

", + "locationName":"Filter" + } + } + }, + "DescribeLaunchTemplateVersionsResult":{ + "type":"structure", + "members":{ + "LaunchTemplateVersions":{ + "shape":"LaunchTemplateVersionSet", + "documentation":"

Information about the launch template versions.

", + "locationName":"launchTemplateVersionSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeLaunchTemplatesMaxResults":{ + "type":"integer", + "max":200, + "min":1 + }, + "DescribeLaunchTemplatesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "LaunchTemplateIds":{ + "shape":"ValueStringList", + "documentation":"

One or more launch template IDs.

", + "locationName":"LaunchTemplateId" + }, + "LaunchTemplateNames":{ + "shape":"LaunchTemplateNameStringList", + "documentation":"

One or more launch template names.

", + "locationName":"LaunchTemplateName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • create-time - The time the launch template was created.

  • launch-template-name - The name of the launch template.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeLaunchTemplatesMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 1 and 200.

" + } + } + }, + "DescribeLaunchTemplatesResult":{ + "type":"structure", + "members":{ + "LaunchTemplates":{ + "shape":"LaunchTemplateSet", + "documentation":"

Information about the launch templates.

", + "locationName":"launchTemplates" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeMovingAddressesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeMovingAddressesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).

", + "locationName":"filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "MaxResults":{ + "shape":"DescribeMovingAddressesMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.

Default: If no value is provided, the default is 1000.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

", + "locationName":"nextToken" + }, + "PublicIps":{ + "shape":"ValueStringList", + "documentation":"

One or more Elastic IP addresses.

", + "locationName":"publicIp" + } + } + }, + "DescribeMovingAddressesResult":{ + "type":"structure", + "members":{ + "MovingAddressStatuses":{ + "shape":"MovingAddressStatusSet", + "documentation":"

The status for each Elastic IP address.

", + "locationName":"movingAddressStatusSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeNatGatewaysMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeNatGatewaysRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • nat-gateway-id - The ID of the NAT gateway.

  • state - The state of the NAT gateway (pending | failed | available | deleting | deleted).

  • subnet-id - The ID of the subnet in which the NAT gateway resides.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC in which the NAT gateway resides.

" + }, + "MaxResults":{ + "shape":"DescribeNatGatewaysMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NatGatewayIds":{ + "shape":"ValueStringList", + "documentation":"

One or more NAT gateway IDs.

", + "locationName":"NatGatewayId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeNatGatewaysResult":{ + "type":"structure", + "members":{ + "NatGateways":{ + "shape":"NatGatewayList", + "documentation":"

Information about the NAT gateways.

", + "locationName":"natGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeNetworkAclsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeNetworkAclsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.association-id - The ID of an association ID for the ACL.

  • association.network-acl-id - The ID of the network ACL involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • default - Indicates whether the ACL is the default network ACL for the VPC.

  • entry.cidr - The IPv4 CIDR range specified in the entry.

  • entry.icmp.code - The ICMP code specified in the entry, if any.

  • entry.icmp.type - The ICMP type specified in the entry, if any.

  • entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.

  • entry.port-range.from - The start of the port range specified in the entry.

  • entry.port-range.to - The end of the port range specified in the entry.

  • entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).

  • entry.rule-action - Allows or denies the matching traffic (allow | deny).

  • entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.

  • network-acl-id - The ID of the network ACL.

  • owner-id - The ID of the AWS account that owns the network ACL.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the network ACL.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclIds":{ + "shape":"ValueStringList", + "documentation":"

One or more network ACL IDs.

Default: Describes all your network ACLs.

", + "locationName":"NetworkAclId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeNetworkAclsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeNetworkAclsResult":{ + "type":"structure", + "members":{ + "NetworkAcls":{ + "shape":"NetworkAclList", + "documentation":"

Information about one or more network ACLs.

", + "locationName":"networkAclSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "Attribute":{ + "shape":"NetworkInterfaceAttribute", + "documentation":"

The attribute of the network interface. This parameter is required.

", + "locationName":"attribute" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfaceAttributeResult":{ + "type":"structure", + "members":{ + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The attachment (if any) of the network interface.

", + "locationName":"attachment" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

The description of the network interface.

", + "locationName":"description" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaceAttribute.

" + }, + "DescribeNetworkInterfacePermissionsMaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "DescribeNetworkInterfacePermissionsRequest":{ + "type":"structure", + "members":{ + "NetworkInterfacePermissionIds":{ + "shape":"NetworkInterfacePermissionIdList", + "documentation":"

One or more network interface permission IDs.

", + "locationName":"NetworkInterfacePermissionId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • network-interface-permission.network-interface-permission-id - The ID of the permission.

  • network-interface-permission.network-interface-id - The ID of the network interface.

  • network-interface-permission.aws-account-id - The AWS account ID.

  • network-interface-permission.aws-service - The AWS service.

  • network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeNetworkInterfacePermissionsMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. If this parameter is not specified, up to 50 results are returned by default.

" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfacePermissions.

" + }, + "DescribeNetworkInterfacePermissionsResult":{ + "type":"structure", + "members":{ + "NetworkInterfacePermissions":{ + "shape":"NetworkInterfacePermissionList", + "documentation":"

The network interface permissions.

", + "locationName":"networkInterfacePermissions" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output for DescribeNetworkInterfacePermissions.

" + }, + "DescribeNetworkInterfacesMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeNetworkInterfacesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the network interface.

", + "locationName":"filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIdList", + "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "locationName":"NetworkInterfaceId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeNetworkInterfacesMaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + } + }, + "documentation":"

Contains the parameters for DescribeNetworkInterfaces.

" + }, + "DescribeNetworkInterfacesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaces":{ + "shape":"NetworkInterfaceList", + "documentation":"

Information about one or more network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeNetworkInterfaces.

" + }, + "DescribePlacementGroupsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • group-name - The name of the placement group.

  • state - The state of the placement group (pending | available | deleting | deleted).

  • strategy - The strategy of the placement group (cluster | spread | partition).

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupNames":{ + "shape":"PlacementGroupStringList", + "documentation":"

The names of the placement groups.

Default: Describes all your placement groups, or only those otherwise specified.

", + "locationName":"groupName" + } + } + }, + "DescribePlacementGroupsResult":{ + "type":"structure", + "members":{ + "PlacementGroups":{ + "shape":"PlacementGroupList", + "documentation":"

Information about the placement groups.

", + "locationName":"placementGroupSet" + } + } + }, + "DescribePrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • prefix-list-id: The ID of a prefix list.

  • prefix-list-name: The name of a prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + } + } + }, + "DescribePrefixListsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "PrefixLists":{ + "shape":"PrefixListSet", + "documentation":"

All available prefix lists.

", + "locationName":"prefixListSet" + } + } + }, + "DescribePrincipalIdFormatMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "DescribePrincipalIdFormatRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Resources":{ + "shape":"ResourceList", + "documentation":"

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway

", + "locationName":"Resource" + }, + "MaxResults":{ + "shape":"DescribePrincipalIdFormatMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "DescribePrincipalIdFormatResult":{ + "type":"structure", + "members":{ + "Principals":{ + "shape":"PrincipalIdFormatList", + "documentation":"

Information about the ID format settings for the ARN.

", + "locationName":"principalSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribePublicIpv4PoolsRequest":{ + "type":"structure", + "members":{ + "PoolIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the address pools.

", + "locationName":"PoolId" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"PoolMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribePublicIpv4PoolsResult":{ + "type":"structure", + "members":{ + "PublicIpv4Pools":{ + "shape":"PublicIpv4PoolSet", + "documentation":"

Information about the address pools.

", + "locationName":"publicIpv4PoolSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeRegionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).

  • opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).

  • region-name - The name of the Region (for example, us-east-1).

", + "locationName":"Filter" + }, + "RegionNames":{ + "shape":"RegionNameStringList", + "documentation":"

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

", + "locationName":"RegionName" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "AllRegions":{ + "shape":"Boolean", + "documentation":"

Indicates whether to display all Regions, including Regions that are disabled for your account.

" + } + } + }, + "DescribeRegionsResult":{ + "type":"structure", + "members":{ + "Regions":{ + "shape":"RegionList", + "documentation":"

Information about the Regions.

", + "locationName":"regionInfo" + } + } + }, + "DescribeReservedInstancesListingsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • reserved-instances-id - The ID of the Reserved Instances.

  • reserved-instances-listing-id - The ID of the Reserved Instances listing.

  • status - The status of the Reserved Instance listing (pending | active | cancelled | closed).

  • status-message - The reason for the status.

", + "locationName":"Filter" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance IDs.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

One or more Reserved Instance listing IDs.

", + "locationName":"reservedInstancesListingId" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesListingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesListings":{ + "shape":"ReservedInstancesListingList", + "documentation":"

Information about the Reserved Instance listing.

", + "locationName":"reservedInstancesListingsSet" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesListings.

" + }, + "DescribeReservedInstancesModificationsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • client-token - The idempotency token for the modification request.

  • create-date - The time when the modification request was created.

  • effective-date - The time when the modification becomes effective.

  • modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.

  • modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.

  • modification-result.target-configuration.instance-count - The number of new Reserved Instances.

  • modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.

  • modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).

  • reserved-instances-id - The ID of the Reserved Instances modified.

  • reserved-instances-modification-id - The ID of the modification request.

  • status - The status of the Reserved Instances modification request (processing | fulfilled | failed).

  • status-message - The reason for the status.

  • update-date - The time when the modification request was last updated.

", + "locationName":"Filter" + }, + "ReservedInstancesModificationIds":{ + "shape":"ReservedInstancesModificationIdStringList", + "documentation":"

IDs for the submitted modification request.

", + "locationName":"ReservedInstancesModificationId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesModificationsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ReservedInstancesModifications":{ + "shape":"ReservedInstancesModificationList", + "documentation":"

The Reserved Instance modification information.

", + "locationName":"reservedInstancesModificationsSet" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesModifications.

" + }, + "DescribeReservedInstancesOfferingsRequest":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed.

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))

  • reserved-instances-offering-id - The Reserved Instances offering ID.

  • scope - The scope of the Reserved Instance (Availability Zone or Region).

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "IncludeMarketplace":{ + "shape":"Boolean", + "documentation":"

Include Reserved Instance Marketplace offerings in the response.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "MaxDuration":{ + "shape":"Long", + "documentation":"

The maximum duration (in seconds) to filter when searching for offerings.

Default: 94608000 (3 years)

" + }, + "MaxInstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to filter when searching for offerings.

Default: 20

" + }, + "MinDuration":{ + "shape":"Long", + "documentation":"

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

The offering class of the Reserved Instance. Can be standard or convertible.

" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

" + }, + "ReservedInstancesOfferingIds":{ + "shape":"ReservedInstancesOfferingIdStringList", + "documentation":"

One or more Reserved Instances offering IDs.

", + "locationName":"ReservedInstancesOfferingId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).

Important: The host value cannot be used with this parameter. Use the default or dedicated values only.

Default: default

", + "locationName":"instanceTenancy" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.

Default: 100

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesOfferingsResult":{ + "type":"structure", + "members":{ + "ReservedInstancesOfferings":{ + "shape":"ReservedInstancesOfferingList", + "documentation":"

A list of Reserved Instances offerings.

", + "locationName":"reservedInstancesOfferingsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeReservedInstancesOfferings.

" + }, + "DescribeReservedInstancesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone where the Reserved Instance can be used.

  • duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).

  • end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).

  • fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).

  • instance-type - The instance type that is covered by the reservation.

  • scope - The scope of the Reserved Instance (Region or Availability Zone).

  • product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).

  • reserved-instances-id - The ID of the Reserved Instance.

  • start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).

  • state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).

", + "locationName":"Filter" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

Describes whether the Reserved Instance is Standard or Convertible.

" + }, + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

", + "locationName":"ReservedInstancesId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.

", + "locationName":"offeringType" + } + }, + "documentation":"

Contains the parameters for DescribeReservedInstances.

" + }, + "DescribeReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstances":{ + "shape":"ReservedInstancesList", + "documentation":"

A list of Reserved Instances.

", + "locationName":"reservedInstancesSet" + } + }, + "documentation":"

Contains the output for DescribeReservedInstances.

" + }, + "DescribeRouteTablesMaxResults":{ + "type":"integer", + "max":100, + "min":5 + }, + "DescribeRouteTablesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • association.route-table-association-id - The ID of an association ID for the route table.

  • association.route-table-id - The ID of the route table involved in the association.

  • association.subnet-id - The ID of the subnet involved in the association.

  • association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.

  • owner-id - The ID of the AWS account that owns the route table.

  • route-table-id - The ID of the route table.

  • route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.

  • route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.

  • route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.

  • route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.

  • route.gateway-id - The ID of a gateway specified in a route in the table.

  • route.instance-id - The ID of an instance specified in a route in the table.

  • route.nat-gateway-id - The ID of a NAT gateway.

  • route.transit-gateway-id - The ID of a transit gateway.

  • route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.

  • route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).

  • route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • transit-gateway-id - The ID of a transit gateway.

  • vpc-id - The ID of the VPC for the route table.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

One or more route table IDs.

Default: Describes all your route tables.

", + "locationName":"RouteTableId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeRouteTablesMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeRouteTablesResult":{ + "type":"structure", + "members":{ + "RouteTables":{ + "shape":"RouteTableList", + "documentation":"

Information about one or more route tables.

", + "locationName":"routeTableSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeRouteTables.

" + }, + "DescribeScheduledInstanceAvailabilityMaxResults":{ + "type":"integer", + "max":300, + "min":5 + }, + "DescribeScheduledInstanceAvailabilityRequest":{ + "type":"structure", + "required":[ + "FirstSlotStartTimeRange", + "Recurrence" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + }, + "FirstSlotStartTimeRange":{ + "shape":"SlotDateTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + }, + "MaxResults":{ + "shape":"DescribeScheduledInstanceAvailabilityMaxResults", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "MaxSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

" + }, + "MinSlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrenceRequest", + "documentation":"

The schedule recurrence.

" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstanceAvailabilityResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceAvailabilitySet":{ + "shape":"ScheduledInstanceAvailabilitySet", + "documentation":"

Information about the available Scheduled Instances.

", + "locationName":"scheduledInstanceAvailabilitySet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstanceAvailability.

" + }, + "DescribeScheduledInstancesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • availability-zone - The Availability Zone (for example, us-west-2a).

  • instance-type - The instance type (for example, c4.large).

  • network-platform - The network platform (EC2-Classic or EC2-VPC).

  • platform - The platform (Linux/UNIX or Windows).

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

" + }, + "ScheduledInstanceIds":{ + "shape":"ScheduledInstanceIdRequestSet", + "documentation":"

The Scheduled Instance IDs.

", + "locationName":"ScheduledInstanceId" + }, + "SlotStartTimeRange":{ + "shape":"SlotStartTimeRangeRequest", + "documentation":"

The time period for the first schedule to start.

" + } + }, + "documentation":"

Contains the parameters for DescribeScheduledInstances.

" + }, + "DescribeScheduledInstancesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "ScheduledInstanceSet":{ + "shape":"ScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of DescribeScheduledInstances.

" + }, + "DescribeSecurityGroupReferencesRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"GroupIds", + "documentation":"

The IDs of the security groups in your account.

" + } + } + }, + "DescribeSecurityGroupReferencesResult":{ + "type":"structure", + "members":{ + "SecurityGroupReferenceSet":{ + "shape":"SecurityGroupReferences", + "documentation":"

Information about the VPCs with the referencing security groups.

", + "locationName":"securityGroupReferenceSet" + } + } + }, + "DescribeSecurityGroupsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeSecurityGroupsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "locationName":"Filter" + }, + "GroupIds":{ + "shape":"GroupIdStringList", + "documentation":"

The IDs of the security groups. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

", + "locationName":"GroupId" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.

Default: Describes all your security groups.

", + "locationName":"GroupName" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeSecurityGroupsMaxResults", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.

" + } + } + }, + "DescribeSecurityGroupsResult":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroupList", + "documentation":"

Information about the security groups.

", + "locationName":"securityGroupInfo" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "SnapshotId" + ], + "members":{ + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute you would like to view.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "CreateVolumePermissions":{ + "shape":"CreateVolumePermissionList", + "documentation":"

The users and groups that have the permissions for creating volumes from the snapshot.

", + "locationName":"createVolumePermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes.

", + "locationName":"productCodes" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Contains the output of DescribeSnapshotAttribute.

" + }, + "DescribeSnapshotsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • description - A description of the snapshot.

  • encrypted - Indicates whether the snapshot is encrypted (true | false)

  • owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

  • owner-id - The ID of the AWS account that owns the snapshot.

  • progress - The progress of the snapshot, as a percentage (for example, 80%).

  • snapshot-id - The snapshot ID.

  • start-time - The time stamp when the snapshot was initiated.

  • status - The status of the snapshot (pending | completed | error).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • volume-id - The ID of the volume the snapshot is for.

  • volume-size - The size of the volume, in GiB.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

" + }, + "OwnerIds":{ + "shape":"OwnerStringList", + "documentation":"

Describes the snapshots owned by these owners.

", + "locationName":"Owner" + }, + "RestorableByUserIds":{ + "shape":"RestorableByStringList", + "documentation":"

The IDs of the AWS accounts that can create volumes from the snapshot.

", + "locationName":"RestorableBy" + }, + "SnapshotIds":{ + "shape":"SnapshotIdStringList", + "documentation":"

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

", + "locationName":"SnapshotId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeSnapshotsResult":{ + "type":"structure", + "members":{ + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeSnapshots request. When the results of a DescribeSnapshots request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeSpotDatafeedSubscriptionRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotDatafeedSubscriptionResult":{ + "type":"structure", + "members":{ + "SpotDatafeedSubscription":{ + "shape":"SpotDatafeedSubscription", + "documentation":"

The Spot Instance data feed subscription.

", + "locationName":"spotDatafeedSubscription" + } + }, + "documentation":"

Contains the output of DescribeSpotDatafeedSubscription.

" + }, + "DescribeSpotFleetInstancesMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "DescribeSpotFleetInstancesRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "MaxResults":{ + "shape":"DescribeSpotFleetInstancesMaxResults", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetInstancesResponse":{ + "type":"structure", + "members":{ + "ActiveInstances":{ + "shape":"ActiveInstanceSet", + "documentation":"

The running instances. This list is refreshed periodically and might be out of date.

", + "locationName":"activeInstanceSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetInstances.

" + }, + "DescribeSpotFleetRequestHistoryMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "DescribeSpotFleetRequestHistoryRequest":{ + "type":"structure", + "required":[ + "SpotFleetRequestId", + "StartTime" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The type of events to describe. By default, all events are described.

", + "locationName":"eventType" + }, + "MaxResults":{ + "shape":"DescribeSpotFleetRequestHistoryMaxResults", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestHistoryResponse":{ + "type":"structure", + "members":{ + "HistoryRecords":{ + "shape":"HistoryRecords", + "documentation":"

Information about the events in the history of the Spot Fleet request.

", + "locationName":"historyRecordSet" + }, + "LastEvaluatedTime":{ + "shape":"DateTime", + "documentation":"

The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.

If nextToken indicates that there are more results, this value is not present.

", + "locationName":"lastEvaluatedTime" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequestHistory.

" + }, + "DescribeSpotFleetRequestsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "SpotFleetRequestIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the Spot Fleet requests.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the parameters for DescribeSpotFleetRequests.

" + }, + "DescribeSpotFleetRequestsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "SpotFleetRequestConfigs":{ + "shape":"SpotFleetRequestConfigSet", + "documentation":"

Information about the configuration of your Spot Fleet.

", + "locationName":"spotFleetRequestConfigSet" + } + }, + "documentation":"

Contains the output of DescribeSpotFleetRequests.

" + }, + "DescribeSpotInstanceRequestsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the Amazon EC2 User Guide for Linux Instances.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • type - The type of Spot Instance request (one-time | persistent).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotInstanceRequestIds":{ + "shape":"SpotInstanceRequestIdList", + "documentation":"

One or more Spot Instance request IDs.

", + "locationName":"SpotInstanceRequestId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next set of results. This value is null when there are no more results to return.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

" + } + }, + "documentation":"

Contains the parameters for DescribeSpotInstanceRequests.

" + }, + "DescribeSpotInstanceRequestsResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next set of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeSpotInstanceRequests.

" + }, + "DescribeSpotPriceHistoryRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for which prices should be returned.

  • instance-type - The type of instance (for example, m3.medium).

  • product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).

  • spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).

  • timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.

", + "locationName":"Filter" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Filters the results by the specified Availability Zone.

", + "locationName":"availabilityZone" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"endTime" + }, + "InstanceTypes":{ + "shape":"InstanceTypeList", + "documentation":"

Filters the results by the specified instance types.

", + "locationName":"InstanceType" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results.

", + "locationName":"nextToken" + }, + "ProductDescriptions":{ + "shape":"ProductDescriptionList", + "documentation":"

Filters the results by the specified basic product descriptions.

", + "locationName":"ProductDescription" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"startTime" + } + }, + "documentation":"

Contains the parameters for DescribeSpotPriceHistory.

" + }, + "DescribeSpotPriceHistoryResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.

", + "locationName":"nextToken" + }, + "SpotPriceHistory":{ + "shape":"SpotPriceHistoryList", + "documentation":"

The historical Spot prices.

", + "locationName":"spotPriceHistorySet" + } + }, + "documentation":"

Contains the output of DescribeSpotPriceHistory.

" + }, + "DescribeStaleSecurityGroupsMaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "DescribeStaleSecurityGroupsNextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "DescribeStaleSecurityGroupsRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "MaxResults":{ + "shape":"DescribeStaleSecurityGroupsMaxResults", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

" + }, + "NextToken":{ + "shape":"DescribeStaleSecurityGroupsNextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DescribeStaleSecurityGroupsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + }, + "StaleSecurityGroupSet":{ + "shape":"StaleSecurityGroupSet", + "documentation":"

Information about the stale security groups.

", + "locationName":"staleSecurityGroupSet" + } + } + }, + "DescribeSubnetsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeSubnetsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.

  • availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.

  • available-ip-address-count - The number of IPv4 addresses in the subnet that are available.

  • cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.

  • default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.

  • owner-id - The ID of the AWS account that owns the subnet.

  • state - The state of the subnet (pending | available).

  • subnet-arn - The Amazon Resource Name (ARN) of the subnet.

  • subnet-id - The ID of the subnet.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC for the subnet.

", + "locationName":"Filter" + }, + "SubnetIds":{ + "shape":"SubnetIdStringList", + "documentation":"

One or more subnet IDs.

Default: Describes all your subnets.

", + "locationName":"SubnetId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeSubnetsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeSubnetsResult":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Information about one or more subnets.

", + "locationName":"subnetSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • key - The tag key.

  • resource-id - The ID of the resource.

  • resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | image | instance | host-reservation | internet-gateway | launch-template | natgateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-peering-connection | vpn-connection | vpn-gateway).

  • tag:<key> - The key/value combination of the tag. For example, specify \"tag:Owner\" for the filter name and \"TeamA\" for the filter value to find resources with the tag \"Owner=TeamA\".

  • value - The tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

", + "locationName":"nextToken" + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "Tags":{ + "shape":"TagDescriptionList", + "documentation":"

The tags.

", + "locationName":"tagSet" + } + } + }, + "DescribeTrafficMirrorFiltersRequest":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterIds":{ + "shape":"ValueStringList", + "documentation":"

The ID of the Traffic Mirror filter.

", + "locationName":"TrafficMirrorFilterId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • description: The Traffic Mirror filter description.

  • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TrafficMirroringMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeTrafficMirrorFiltersResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilters":{ + "shape":"TrafficMirrorFilterSet", + "documentation":"

Information about one or more Traffic Mirror filters.

", + "locationName":"trafficMirrorFilterSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTrafficMirrorSessionsRequest":{ + "type":"structure", + "members":{ + "TrafficMirrorSessionIds":{ + "shape":"ValueStringList", + "documentation":"

The ID of the Traffic Mirror session.

", + "locationName":"TrafficMirrorSessionId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • description: The Traffic Mirror session description.

  • network-interface-id: The ID of the Traffic Mirror session network interface.

  • owner-id: The ID of the account that owns the Traffic Mirror session.

  • packet-length: The assigned number of packets to mirror.

  • session-number: The assigned session number.

  • traffic-mirror-filter-id: The ID of the Traffic Mirror filter.

  • traffic-mirror-session-id: The ID of the Traffic Mirror session.

  • traffic-mirror-target-id: The ID of the Traffic Mirror target.

  • virtual-network-id: The virtual network ID of the Traffic Mirror session.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TrafficMirroringMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeTrafficMirrorSessionsResult":{ + "type":"structure", + "members":{ + "TrafficMirrorSessions":{ + "shape":"TrafficMirrorSessionSet", + "documentation":"

Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.

", + "locationName":"trafficMirrorSessionSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTrafficMirrorTargetsRequest":{ + "type":"structure", + "members":{ + "TrafficMirrorTargetIds":{ + "shape":"ValueStringList", + "documentation":"

The ID of the Traffic Mirror targets.

", + "locationName":"TrafficMirrorTargetId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • description: The Traffic Mirror target description.

  • network-interface-id: The ID of the Traffic Mirror session network interface.

  • network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.

  • owner-id: The ID of the account that owns the Traffic Mirror session.

  • traffic-mirror-target-id: The ID of the Traffic Mirror target.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TrafficMirroringMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "DescribeTrafficMirrorTargetsResult":{ + "type":"structure", + "members":{ + "TrafficMirrorTargets":{ + "shape":"TrafficMirrorTargetSet", + "documentation":"

Information about one or more Traffic Mirror targets.

", + "locationName":"trafficMirrorTargetSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. The value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTransitGatewayAttachmentsRequest":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentIds":{ + "shape":"TransitGatewayAttachmentIdStringList", + "documentation":"

The IDs of the attachments.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • association.state - The state of the association (associating | associated | disassociating).

  • association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.

  • resource-id - The ID of the resource.

  • resource-owner-id - The ID of the AWS account that owns the resource.

  • resource-type - The resource type (vpc | vpn).

  • state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeTransitGatewayAttachmentsResult":{ + "type":"structure", + "members":{ + "TransitGatewayAttachments":{ + "shape":"TransitGatewayAttachmentList", + "documentation":"

Information about the attachments.

", + "locationName":"transitGatewayAttachments" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTransitGatewayRouteTablesRequest":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTableIds":{ + "shape":"TransitGatewayRouteTableIdStringList", + "documentation":"

The IDs of the transit gateway route tables.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).

  • default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).

  • state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • transit-gateway-id - The ID of the transit gateway.

  • transit-gateway-route-table-id - The ID of the transit gateway route table.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeTransitGatewayRouteTablesResult":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTables":{ + "shape":"TransitGatewayRouteTableList", + "documentation":"

Information about the transit gateway route tables.

", + "locationName":"transitGatewayRouteTables" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTransitGatewayVpcAttachmentsRequest":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentIds":{ + "shape":"TransitGatewayAttachmentIdStringList", + "documentation":"

The IDs of the attachments.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • transit-gateway-attachment-id - The ID of the attachment.

  • transit-gateway-id - The ID of the transit gateway.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeTransitGatewayVpcAttachmentsResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachments":{ + "shape":"TransitGatewayVpcAttachmentList", + "documentation":"

Information about the VPC attachments.

", + "locationName":"transitGatewayVpcAttachments" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeTransitGatewaysRequest":{ + "type":"structure", + "members":{ + "TransitGatewayIds":{ + "shape":"TransitGatewayIdStringList", + "documentation":"

The IDs of the transit gateways.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • options.propagation-default-route-table-id - The ID of the default propagation route table.

  • options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.

  • options.association-default-route-table-id - The ID of the default association route table.

  • options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).

  • options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).

  • options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).

  • options.dns-support - Indicates whether DNS support is enabled (enable | disable).

  • options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).

  • owner-id - The ID of the AWS account that owns the transit gateway.

  • state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • transit-gateway-id - The ID of the transit gateway.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DescribeTransitGatewaysResult":{ + "type":"structure", + "members":{ + "TransitGateways":{ + "shape":"TransitGatewayList", + "documentation":"

Information about the transit gateways.

", + "locationName":"transitGatewaySet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumeAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "VolumeId" + ], + "members":{ + "Attribute":{ + "shape":"VolumeAttributeName", + "documentation":"

The attribute of the volume. This parameter is required.

" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeVolumeAttribute.

" + }, + "DescribeVolumeAttributeResult":{ + "type":"structure", + "members":{ + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

The state of autoEnableIO attribute.

", + "locationName":"autoEnableIO" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Contains the output of DescribeVolumeAttribute.

" + }, + "DescribeVolumeStatusRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • action.code - The action code for the event (for example, enable-volume-io).

  • action.description - A description of the action.

  • action.event-id - The event ID associated with the action.

  • availability-zone - The Availability Zone of the instance.

  • event.description - A description of the event.

  • event.event-id - The event ID.

  • event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).

  • event.not-after - The latest end time for the event.

  • event.not-before - The earliest start time for the event.

  • volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).

  • volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).

  • volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

The IDs of the volumes.

Default: Describes all your volumes.

", + "locationName":"VolumeId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeVolumeStatusResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "VolumeStatuses":{ + "shape":"VolumeStatusList", + "documentation":"

Information about the status of the volumes.

", + "locationName":"volumeStatusSet" + } + } + }, + "DescribeVolumesModificationsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

The IDs of the volumes for which in-progress modifications will be described.

", + "locationName":"VolumeId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters. Supported filters: volume-id, modification-state, target-size, target-iops, target-volume-type, original-size, original-iops, original-volume-type, start-time.

", + "locationName":"Filter" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned by a previous paginated request.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results (up to a limit of 500) to be returned in a paginated request.

" + } + } + }, + "DescribeVolumesModificationsResult":{ + "type":"structure", + "members":{ + "VolumesModifications":{ + "shape":"VolumeModificationList", + "documentation":"

Information about the volume modifications.

", + "locationName":"volumeModificationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for pagination, null if there are no more results

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

The filters.

  • attachment.attach-time - The time stamp when the attachment initiated.

  • attachment.delete-on-termination - Whether the volume is deleted on instance termination.

  • attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).

  • attachment.instance-id - The ID of the instance the volume is attached to.

  • attachment.status - The attachment state (attaching | attached | detaching).

  • availability-zone - The Availability Zone in which the volume was created.

  • create-time - The time stamp when the volume was created.

  • encrypted - Indicates whether the volume is encrypted (true | false)

  • size - The size of the volume, in GiB.

  • snapshot-id - The snapshot from which the volume was created.

  • status - The status of the volume (creating | available | in-use | deleting | deleted | error).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • volume-id - The volume ID.

  • volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"Filter" + }, + "VolumeIds":{ + "shape":"VolumeIdStringList", + "documentation":"

The volume IDs.

", + "locationName":"VolumeId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"VolumeList", + "documentation":"

Information about the volumes.

", + "locationName":"volumeSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The NextToken value to include in a future DescribeVolumes request. When the results of a DescribeVolumes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "VpcId" + ], + "members":{ + "Attribute":{ + "shape":"VpcAttributeName", + "documentation":"

The VPC attribute.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DescribeVpcAttributeResult":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.

", + "locationName":"enableDnsHostnames" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.

", + "locationName":"enableDnsSupport" + } + } + }, + "DescribeVpcClassicLinkDnsSupportMaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "DescribeVpcClassicLinkDnsSupportNextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "DescribeVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"DescribeVpcClassicLinkDnsSupportMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"DescribeVpcClassicLinkDnsSupportNextToken", + "documentation":"

The token for the next page of results.

", + "locationName":"nextToken" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPC IDs.

" + } + } + }, + "DescribeVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"DescribeVpcClassicLinkDnsSupportNextToken", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "Vpcs":{ + "shape":"ClassicLinkDnsSupportList", + "documentation":"

Information about the ClassicLink DNS support status of the VPCs.

", + "locationName":"vpcs" + } + } + }, + "DescribeVpcClassicLinkRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcIds":{ + "shape":"VpcClassicLinkIdList", + "documentation":"

One or more VPCs for which you want to describe the ClassicLink status.

", + "locationName":"VpcId" + } + } + }, + "DescribeVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcClassicLinkList", + "documentation":"

The ClassicLink status of one or more VPCs.

", + "locationName":"vpcSet" + } + } + }, + "DescribeVpcEndpointConnectionNotificationsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ConnectionNotificationId":{ + "shape":"String", + "documentation":"

The ID of the notification.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • connection-notification-arn - The ARN of SNS topic for the notification.

  • connection-notification-id - The ID of the notification.

  • connection-notification-state - The state of the notification (Enabled | Disabled).

  • connection-notification-type - The type of notification (Topic).

  • service-id - The ID of the endpoint service.

  • vpc-endpoint-id - The ID of the VPC endpoint.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to request the next page of results.

" + } + } + }, + "DescribeVpcEndpointConnectionNotificationsResult":{ + "type":"structure", + "members":{ + "ConnectionNotificationSet":{ + "shape":"ConnectionNotificationSet", + "documentation":"

One or more notifications.

", + "locationName":"connectionNotificationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcEndpointConnectionsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-id - The ID of the service.

  • vpc-endpoint-owner - The AWS account number of the owner of the endpoint.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • vpc-endpoint-id - The ID of the endpoint.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + } + }, + "DescribeVpcEndpointConnectionsResult":{ + "type":"structure", + "members":{ + "VpcEndpointConnections":{ + "shape":"VpcEndpointConnectionSet", + "documentation":"

Information about one or more VPC endpoint connections.

", + "locationName":"vpcEndpointConnectionSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcEndpointServiceConfigurationsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more services.

", + "locationName":"ServiceId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name - The name of the service.

  • service-id - The ID of the service.

  • service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + } + }, + "DescribeVpcEndpointServiceConfigurationsResult":{ + "type":"structure", + "members":{ + "ServiceConfigurations":{ + "shape":"ServiceConfigurationSet", + "documentation":"

Information about one or more services.

", + "locationName":"serviceConfigurationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcEndpointServicePermissionsRequest":{ + "type":"structure", + "required":["ServiceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the service.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • principal - The ARN of the principal.

  • principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + } + } + }, + "DescribeVpcEndpointServicePermissionsResult":{ + "type":"structure", + "members":{ + "AllowedPrincipals":{ + "shape":"AllowedPrincipalSet", + "documentation":"

Information about one or more allowed principals.

", + "locationName":"allowedPrincipals" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcEndpointServicesRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

One or more service names.

", + "locationName":"ServiceName" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the service.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointServicesResult":{ + "type":"structure", + "members":{ + "ServiceNames":{ + "shape":"ValueStringList", + "documentation":"

A list of supported services.

", + "locationName":"serviceNameSet" + }, + "ServiceDetails":{ + "shape":"ServiceDetailSet", + "documentation":"

Information about the service.

", + "locationName":"serviceDetailSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpointServices.

" + }, + "DescribeVpcEndpointsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

One or more endpoint IDs.

", + "locationName":"VpcEndpointId" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • service-name: The name of the service.

  • vpc-id: The ID of the VPC in which the endpoint resides.

  • vpc-endpoint-id: The ID of the endpoint.

  • vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.

Constraint: If the value is greater than 1000, we return only 1000 items.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of items to return. (You received this token from a prior call.)

" + } + }, + "documentation":"

Contains the parameters for DescribeVpcEndpoints.

" + }, + "DescribeVpcEndpointsResult":{ + "type":"structure", + "members":{ + "VpcEndpoints":{ + "shape":"VpcEndpointSet", + "documentation":"

Information about the endpoints.

", + "locationName":"vpcEndpointSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

", + "locationName":"nextToken" + } + }, + "documentation":"

Contains the output of DescribeVpcEndpoints.

" + }, + "DescribeVpcPeeringConnectionsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeVpcPeeringConnectionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.

  • accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.

  • accepter-vpc-info.vpc-id - The ID of the accepter VPC.

  • expiration-time - The expiration date and time for the VPC peering connection.

  • requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.

  • requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.

  • requester-vpc-info.vpc-id - The ID of the requester VPC.

  • status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).

  • status-message - A message that provides more information about the status of the VPC peering connection, if applicable.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-peering-connection-id - The ID of the VPC peering connection.

", + "locationName":"Filter" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionIds":{ + "shape":"ValueStringList", + "documentation":"

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

", + "locationName":"VpcPeeringConnectionId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeVpcPeeringConnectionsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeVpcPeeringConnectionsResult":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Information about the VPC peering connections.

", + "locationName":"vpcPeeringConnectionSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpcsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "DescribeVpcsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).

  • cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.

  • cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.

  • cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.

  • dhcp-options-id - The ID of a set of DHCP options.

  • ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.

  • ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.

  • isDefault - Indicates whether the VPC is the default VPC.

  • owner-id - The ID of the AWS account that owns the VPC.

  • state - The state of the VPC (pending | available).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • vpc-id - The ID of the VPC.

", + "locationName":"Filter" + }, + "VpcIds":{ + "shape":"VpcIdStringList", + "documentation":"

One or more VPC IDs.

Default: Describes all your VPCs.

", + "locationName":"VpcId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "MaxResults":{ + "shape":"DescribeVpcsMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + } + } + }, + "DescribeVpcsResult":{ + "type":"structure", + "members":{ + "Vpcs":{ + "shape":"VpcList", + "documentation":"

Information about one or more VPCs.

", + "locationName":"vpcSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "DescribeVpnConnectionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • customer-gateway-configuration - The configuration information for the customer gateway.

  • customer-gateway-id - The ID of a customer gateway associated with the VPN connection.

  • state - The state of the VPN connection (pending | available | deleting | deleted).

  • option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).

  • route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.

  • bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • type - The type of VPN connection. Currently the only supported type is ipsec.1.

  • vpn-connection-id - The ID of the VPN connection.

  • vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.

", + "locationName":"Filter" + }, + "VpnConnectionIds":{ + "shape":"VpnConnectionIdStringList", + "documentation":"

One or more VPN connection IDs.

Default: Describes your VPN connections.

", + "locationName":"VpnConnectionId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeVpnConnections.

" + }, + "DescribeVpnConnectionsResult":{ + "type":"structure", + "members":{ + "VpnConnections":{ + "shape":"VpnConnectionList", + "documentation":"

Information about one or more VPN connections.

", + "locationName":"vpnConnectionSet" + } + }, + "documentation":"

Contains the output of DescribeVpnConnections.

" + }, + "DescribeVpnGatewaysRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.

  • attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).

  • attachment.vpc-id - The ID of an attached VPC.

  • availability-zone - The Availability Zone for the virtual private gateway (if applicable).

  • state - The state of the virtual private gateway (pending | available | deleting | deleted).

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

  • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

  • type - The type of virtual private gateway. Currently the only supported type is ipsec.1.

  • vpn-gateway-id - The ID of the virtual private gateway.

", + "locationName":"Filter" + }, + "VpnGatewayIds":{ + "shape":"VpnGatewayIdStringList", + "documentation":"

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

", + "locationName":"VpnGatewayId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DescribeVpnGateways.

" + }, + "DescribeVpnGatewaysResult":{ + "type":"structure", + "members":{ + "VpnGateways":{ + "shape":"VpnGatewayList", + "documentation":"

Information about one or more virtual private gateways.

", + "locationName":"vpnGatewaySet" + } + }, + "documentation":"

Contains the output of DescribeVpnGateways.

" + }, + "DetachClassicLinkVpcRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance to unlink from the VPC.

", + "locationName":"instanceId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC to which the instance is linked.

", + "locationName":"vpcId" + } + } + }, + "DetachClassicLinkVpcResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DetachInternetGatewayRequest":{ + "type":"structure", + "required":[ + "InternetGatewayId", + "VpcId" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InternetGatewayId":{ + "shape":"InternetGatewayId", + "documentation":"

The ID of the internet gateway.

", + "locationName":"internetGatewayId" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DetachNetworkInterfaceRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "AttachmentId":{ + "shape":"AttachmentId", + "documentation":"

The ID of the attachment.

", + "locationName":"attachmentId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force a detachment.

  • Use the Force parameter only as a last resort to detach a network interface from a failed instance.

  • If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.

  • If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.

", + "locationName":"force" + } + }, + "documentation":"

Contains the parameters for DetachNetworkInterface.

" + }, + "DetachVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the volume.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DetachVolume.

" + }, + "DetachVpnGatewayRequest":{ + "type":"structure", + "required":[ + "VpcId", + "VpnGatewayId" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "VpnGatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for DetachVpnGateway.

" + }, + "DeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "DhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of a DHCP option.

", + "locationName":"key" + }, + "Values":{ + "shape":"DhcpConfigurationValueList", + "documentation":"

One or more values for the DHCP option.

", + "locationName":"valueSet" + } + }, + "documentation":"

Describes a DHCP configuration option.

" + }, + "DhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"DhcpConfiguration", + "locationName":"item" + } + }, + "DhcpConfigurationValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValue", + "locationName":"item" + } + }, + "DhcpOptions":{ + "type":"structure", + "members":{ + "DhcpConfigurations":{ + "shape":"DhcpConfigurationList", + "documentation":"

One or more DHCP options in the set.

", + "locationName":"dhcpConfigurationSet" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options.

", + "locationName":"dhcpOptionsId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the DHCP options set.

", + "locationName":"ownerId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the DHCP options set.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a set of DHCP options.

" + }, + "DhcpOptionsId":{"type":"string"}, + "DhcpOptionsIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DhcpOptionsId" + } + }, + "DhcpOptionsList":{ + "type":"list", + "member":{ + "shape":"DhcpOptions", + "locationName":"item" + } + }, + "DirectoryServiceAuthentication":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"String", + "documentation":"

The ID of the Active Directory used for authentication.

", + "locationName":"directoryId" + } + }, + "documentation":"

Describes an Active Directory.

" + }, + "DirectoryServiceAuthenticationRequest":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"String", + "documentation":"

The ID of the Active Directory to be used for authentication.

" + } + }, + "documentation":"

Describes the Active Directory to be used for client authentication.

" + }, + "DisableEbsEncryptionByDefaultRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DisableEbsEncryptionByDefaultResult":{ + "type":"structure", + "members":{ + "EbsEncryptionByDefault":{ + "shape":"Boolean", + "documentation":"

The updated status of encryption by default.

", + "locationName":"ebsEncryptionByDefault" + } + } + }, + "DisableTransitGatewayRouteTablePropagationRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the propagation route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DisableTransitGatewayRouteTablePropagationResult":{ + "type":"structure", + "members":{ + "Propagation":{ + "shape":"TransitGatewayPropagation", + "documentation":"

Information about route propagation.

", + "locationName":"propagation" + } + } + }, + "DisableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "GatewayId", + "RouteTableId" + ], + "members":{ + "GatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway.

" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table.

" + } + }, + "documentation":"

Contains the parameters for DisableVgwRoutePropagation.

" + }, + "DisableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + } + } + }, + "DisableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DisableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DisableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "DisassociateAddressRequest":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The association ID. Required for EC2-VPC.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DisassociateClientVpnTargetNetworkRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "AssociationId" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint from which to disassociate the target network.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the target network association.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DisassociateClientVpnTargetNetworkResult":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the target network association.

", + "locationName":"associationId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"

The current state of the target network association.

", + "locationName":"status" + } + } + }, + "DisassociateIamInstanceProfileRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the IAM instance profile association.

" + } + } + }, + "DisassociateIamInstanceProfileResult":{ + "type":"structure", + "members":{ + "IamInstanceProfileAssociation":{ + "shape":"IamInstanceProfileAssociation", + "documentation":"

Information about the IAM instance profile association.

", + "locationName":"iamInstanceProfileAssociation" + } + } + }, + "DisassociateRouteTableRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"RouteTableAssociationId", + "documentation":"

The association ID representing the current association between the route table and subnet.

", + "locationName":"associationId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "DisassociateSubnetCidrBlockRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"SubnetCidrAssociationId", + "documentation":"

The association ID for the CIDR block.

", + "locationName":"associationId" + } + } + }, + "DisassociateSubnetCidrBlockResult":{ + "type":"structure", + "members":{ + "Ipv6CidrBlockAssociation":{ + "shape":"SubnetIpv6CidrBlockAssociation", + "documentation":"

Information about the IPv6 CIDR block association.

", + "locationName":"ipv6CidrBlockAssociation" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + } + }, + "DisassociateTransitGatewayRouteTableRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "DisassociateTransitGatewayRouteTableResult":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"TransitGatewayAssociation", + "documentation":"

Information about the association.

", + "locationName":"association" + } + } + }, + "DisassociateVpcCidrBlockRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"VpcCidrAssociationId", + "documentation":"

The association ID for the CIDR block.

", + "locationName":"associationId" + } + } + }, + "DisassociateVpcCidrBlockResult":{ + "type":"structure", + "members":{ + "Ipv6CidrBlockAssociation":{ + "shape":"VpcIpv6CidrBlockAssociation", + "documentation":"

Information about the IPv6 CIDR block association.

", + "locationName":"ipv6CidrBlockAssociation" + }, + "CidrBlockAssociation":{ + "shape":"VpcCidrBlockAssociation", + "documentation":"

Information about the IPv4 CIDR block association.

", + "locationName":"cidrBlockAssociation" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "DiskImage":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the disk image.

" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

Information about the disk image.

" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

Information about the volume.

" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDescription":{ + "type":"structure", + "members":{ + "Checksum":{ + "shape":"String", + "documentation":"

The checksum computed for the disk image.

", + "locationName":"checksum" + }, + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageDetail":{ + "type":"structure", + "required":[ + "Bytes", + "Format", + "ImportManifestUrl" + ], + "members":{ + "Bytes":{ + "shape":"Long", + "documentation":"

The size of the disk image, in GiB.

", + "locationName":"bytes" + }, + "Format":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

", + "locationName":"format" + }, + "ImportManifestUrl":{ + "shape":"String", + "documentation":"

A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the \"Query String Request Authentication Alternative\" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.

For information about the import manifest referenced by this API action, see VM Import Manifest.

", + "locationName":"importManifestUrl" + } + }, + "documentation":"

Describes a disk image.

" + }, + "DiskImageFormat":{ + "type":"string", + "enum":[ + "VMDK", + "RAW", + "VHD" + ] + }, + "DiskImageList":{ + "type":"list", + "member":{"shape":"DiskImage"} + }, + "DiskImageVolumeDescription":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

The volume identifier.

", + "locationName":"id" + }, + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes a disk image volume.

" + }, + "DnsEntry":{ + "type":"structure", + "members":{ + "DnsName":{ + "shape":"String", + "documentation":"

The DNS name.

", + "locationName":"dnsName" + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

The ID of the private hosted zone.

", + "locationName":"hostedZoneId" + } + }, + "documentation":"

Describes a DNS entry.

" + }, + "DnsEntrySet":{ + "type":"list", + "member":{ + "shape":"DnsEntry", + "locationName":"item" + } + }, + "DnsServersOptionsModifyStructure":{ + "type":"structure", + "members":{ + "CustomDnsServers":{ + "shape":"ValueStringList", + "documentation":"

The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.

" + } + }, + "documentation":"

Information about the DNS server to be used.

" + }, + "DnsSupportValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "DomainType":{ + "type":"string", + "enum":[ + "vpc", + "standard" + ] + }, + "Double":{"type":"double"}, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"deleteOnTermination" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD (sc1), and 1-1024 for Magnetic (standard) volumes. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

", + "locationName":"volumeSize" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. If you set the type to io1, you must also specify the IOPS that the volume supports.

Default: gp2

", + "locationName":"volumeType" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "EbsInstanceBlockDevice":{ + "type":"structure", + "members":{ + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Describes a parameter used to set up an EBS volume in a block device mapping.

" + }, + "EbsInstanceBlockDeviceSpecification":{ + "type":"structure", + "members":{ + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the EBS volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Describes information used to set up an EBS volume specified in a block device mapping.

" + }, + "EgressOnlyInternetGateway":{ + "type":"structure", + "members":{ + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Information about the attachment of the egress-only internet gateway.

", + "locationName":"attachmentSet" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"

The ID of the egress-only internet gateway.

", + "locationName":"egressOnlyInternetGatewayId" + } + }, + "documentation":"

Describes an egress-only internet gateway.

" + }, + "EgressOnlyInternetGatewayId":{"type":"string"}, + "EgressOnlyInternetGatewayIdList":{ + "type":"list", + "member":{ + "shape":"EgressOnlyInternetGatewayId", + "locationName":"item" + } + }, + "EgressOnlyInternetGatewayList":{ + "type":"list", + "member":{ + "shape":"EgressOnlyInternetGateway", + "locationName":"item" + } + }, + "ElasticGpuAssociation":{ + "type":"structure", + "members":{ + "ElasticGpuId":{ + "shape":"String", + "documentation":"

The ID of the Elastic Graphics accelerator.

", + "locationName":"elasticGpuId" + }, + "ElasticGpuAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association.

", + "locationName":"elasticGpuAssociationId" + }, + "ElasticGpuAssociationState":{ + "shape":"String", + "documentation":"

The state of the association between the instance and the Elastic Graphics accelerator.

", + "locationName":"elasticGpuAssociationState" + }, + "ElasticGpuAssociationTime":{ + "shape":"String", + "documentation":"

The time the Elastic Graphics accelerator was associated with the instance.

", + "locationName":"elasticGpuAssociationTime" + } + }, + "documentation":"

Describes the association between an instance and an Elastic Graphics accelerator.

" + }, + "ElasticGpuAssociationList":{ + "type":"list", + "member":{ + "shape":"ElasticGpuAssociation", + "locationName":"item" + } + }, + "ElasticGpuHealth":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ElasticGpuStatus", + "documentation":"

The health status.

", + "locationName":"status" + } + }, + "documentation":"

Describes the status of an Elastic Graphics accelerator.

" + }, + "ElasticGpuIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ElasticGpuSet":{ + "type":"list", + "member":{ + "shape":"ElasticGpus", + "locationName":"item" + } + }, + "ElasticGpuSpecification":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The type of Elastic Graphics accelerator.

" + } + }, + "documentation":"

A specification for an Elastic Graphics accelerator.

" + }, + "ElasticGpuSpecificationList":{ + "type":"list", + "member":{ + "shape":"ElasticGpuSpecification", + "locationName":"ElasticGpuSpecification" + } + }, + "ElasticGpuSpecificationResponse":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The elastic GPU type.

", + "locationName":"type" + } + }, + "documentation":"

Describes an elastic GPU.

" + }, + "ElasticGpuSpecificationResponseList":{ + "type":"list", + "member":{ + "shape":"ElasticGpuSpecificationResponse", + "locationName":"item" + } + }, + "ElasticGpuSpecifications":{ + "type":"list", + "member":{ + "shape":"ElasticGpuSpecification", + "locationName":"item" + } + }, + "ElasticGpuState":{ + "type":"string", + "enum":["ATTACHED"] + }, + "ElasticGpuStatus":{ + "type":"string", + "enum":[ + "OK", + "IMPAIRED" + ] + }, + "ElasticGpus":{ + "type":"structure", + "members":{ + "ElasticGpuId":{ + "shape":"String", + "documentation":"

The ID of the Elastic Graphics accelerator.

", + "locationName":"elasticGpuId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in the which the Elastic Graphics accelerator resides.

", + "locationName":"availabilityZone" + }, + "ElasticGpuType":{ + "shape":"String", + "documentation":"

The type of Elastic Graphics accelerator.

", + "locationName":"elasticGpuType" + }, + "ElasticGpuHealth":{ + "shape":"ElasticGpuHealth", + "documentation":"

The status of the Elastic Graphics accelerator.

", + "locationName":"elasticGpuHealth" + }, + "ElasticGpuState":{ + "shape":"ElasticGpuState", + "documentation":"

The state of the Elastic Graphics accelerator.

", + "locationName":"elasticGpuState" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance to which the Elastic Graphics accelerator is attached.

", + "locationName":"instanceId" + } + }, + "documentation":"

Describes an Elastic Graphics accelerator.

" + }, + "ElasticInferenceAccelerator":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The type of elastic inference accelerator. The possible values are eia1.small, eia1.medium, and eia1.large.

" + } + }, + "documentation":"

Describes an elastic inference accelerator.

" + }, + "ElasticInferenceAcceleratorAssociation":{ + "type":"structure", + "members":{ + "ElasticInferenceAcceleratorArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the elastic inference accelerator.

", + "locationName":"elasticInferenceAcceleratorArn" + }, + "ElasticInferenceAcceleratorAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association.

", + "locationName":"elasticInferenceAcceleratorAssociationId" + }, + "ElasticInferenceAcceleratorAssociationState":{ + "shape":"String", + "documentation":"

The state of the elastic inference accelerator.

", + "locationName":"elasticInferenceAcceleratorAssociationState" + }, + "ElasticInferenceAcceleratorAssociationTime":{ + "shape":"DateTime", + "documentation":"

The time at which the elastic inference accelerator is associated with an instance.

", + "locationName":"elasticInferenceAcceleratorAssociationTime" + } + }, + "documentation":"

Describes the association between an instance and an elastic inference accelerator.

" + }, + "ElasticInferenceAcceleratorAssociationList":{ + "type":"list", + "member":{ + "shape":"ElasticInferenceAcceleratorAssociation", + "locationName":"item" + } + }, + "ElasticInferenceAccelerators":{ + "type":"list", + "member":{ + "shape":"ElasticInferenceAccelerator", + "locationName":"item" + } + }, + "EnableEbsEncryptionByDefaultRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "EnableEbsEncryptionByDefaultResult":{ + "type":"structure", + "members":{ + "EbsEncryptionByDefault":{ + "shape":"Boolean", + "documentation":"

The updated status of encryption by default.

", + "locationName":"ebsEncryptionByDefault" + } + } + }, + "EnableTransitGatewayRouteTablePropagationRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "TransitGatewayAttachmentId" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the propagation route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "EnableTransitGatewayRouteTablePropagationResult":{ + "type":"structure", + "members":{ + "Propagation":{ + "shape":"TransitGatewayPropagation", + "documentation":"

Information about route propagation.

", + "locationName":"propagation" + } + } + }, + "EnableVgwRoutePropagationRequest":{ + "type":"structure", + "required":[ + "GatewayId", + "RouteTableId" + ], + "members":{ + "GatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with.

" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to.

" + } + }, + "documentation":"

Contains the parameters for EnableVgwRoutePropagation.

" + }, + "EnableVolumeIORequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + } + }, + "documentation":"

Contains the parameters for EnableVolumeIO.

" + }, + "EnableVpcClassicLinkDnsSupportRequest":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + } + } + }, + "EnableVpcClassicLinkDnsSupportResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "EnableVpcClassicLinkRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "EnableVpcClassicLinkResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "EndDateType":{ + "type":"string", + "enum":[ + "unlimited", + "limited" + ] + }, + "EndpointSet":{ + "type":"list", + "member":{ + "shape":"ClientVpnEndpoint", + "locationName":"item" + } + }, + "EventCode":{ + "type":"string", + "enum":[ + "instance-reboot", + "system-reboot", + "system-maintenance", + "instance-retirement", + "instance-stop" + ] + }, + "EventInformation":{ + "type":"structure", + "members":{ + "EventDescription":{ + "shape":"String", + "documentation":"

The description of the event.

", + "locationName":"eventDescription" + }, + "EventSubType":{ + "shape":"String", + "documentation":"

The event.

The following are the error events:

  • iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet did not have the required permissions either to launch or terminate an instance.

  • spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.

  • spotInstanceCountLimitExceeded - You've reached the limit on the number of Spot Instances that you can launch.

The following are the fleetRequestChange events:

  • active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running Spot Instances.

  • cancelled - The EC2 Fleet or Spot Fleet request is canceled and has no running Spot Instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances were terminated.

  • cancelled_running - The EC2 Fleet or Spot Fleet request is canceled and does not launch additional Spot Instances. Existing Spot Instances continue to run until they are interrupted or terminated.

  • cancelled_terminating - The EC2 Fleet or Spot Fleet request is canceled and its Spot Instances are terminating.

  • expired - The EC2 Fleet or Spot Fleet request has expired. A subsequent event indicates that the instances were terminated, if the request was created with TerminateInstancesWithExpiration set.

  • modify_in_progress - A request to modify the EC2 Fleet or Spot Fleet request was accepted and is in progress.

  • modify_successful - The EC2 Fleet or Spot Fleet request was modified.

  • price_update - The price for a launch configuration was adjusted because it was too high. This change is permanent.

  • submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of Spot Instances.

The following are the instanceChange events:

  • launched - A request was fulfilled and a new instance was launched.

  • terminated - An instance was terminated by the user.

The following are the Information events:

  • launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.

  • launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price or the Spot price is above the On-Demand price.

  • fleetProgressHalted - The price in every launch specification is not valid. A launch specification might become valid if the Spot price changes.

", + "locationName":"eventSubType" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance. This information is available only for instanceChange events.

", + "locationName":"instanceId" + } + }, + "documentation":"

Describes an EC2 Fleet or Spot Fleet event.

" + }, + "EventType":{ + "type":"string", + "enum":[ + "instanceChange", + "fleetRequestChange", + "error", + "information" + ] + }, + "ExcessCapacityTerminationPolicy":{ + "type":"string", + "enum":[ + "noTermination", + "default" + ] + }, + "ExecutableByStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExecutableBy" + } + }, + "ExportClientVpnClientCertificateRevocationListRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ExportClientVpnClientCertificateRevocationListResult":{ + "type":"structure", + "members":{ + "CertificateRevocationList":{ + "shape":"String", + "documentation":"

Information about the client certificate revocation list.

", + "locationName":"certificateRevocationList" + }, + "Status":{ + "shape":"ClientCertificateRevocationListStatus", + "documentation":"

The current state of the client certificate revocation list.

", + "locationName":"status" + } + } + }, + "ExportClientVpnClientConfigurationRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ExportClientVpnClientConfigurationResult":{ + "type":"structure", + "members":{ + "ClientConfiguration":{ + "shape":"String", + "documentation":"

The contents of the Client VPN endpoint configuration file.

", + "locationName":"clientConfiguration" + } + } + }, + "ExportEnvironment":{ + "type":"string", + "enum":[ + "citrix", + "vmware", + "microsoft" + ] + }, + "ExportImageRequest":{ + "type":"structure", + "required":[ + "DiskImageFormat", + "ImageId", + "S3ExportLocation" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for export image requests.

", + "idempotencyToken":true + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the image being exported. The maximum length is 255 bytes.

" + }, + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

The ID of the image.

" + }, + "S3ExportLocation":{ + "shape":"ExportTaskS3LocationRequest", + "documentation":"

Information about the destination S3 bucket. The bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role that grants VM Import/Export permission to export images to your S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

" + } + } + }, + "ExportImageResult":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the image being exported.

", + "locationName":"description" + }, + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The disk image format for the exported image.

", + "locationName":"diskImageFormat" + }, + "ExportImageTaskId":{ + "shape":"String", + "documentation":"

The ID of the export image task.

", + "locationName":"exportImageTaskId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the image.

", + "locationName":"imageId" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role that grants VM Import/Export permission to export images to your S3 bucket.

", + "locationName":"roleName" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percent complete of the export image task.

", + "locationName":"progress" + }, + "S3ExportLocation":{ + "shape":"ExportTaskS3Location", + "documentation":"

Information about the destination S3 bucket.

", + "locationName":"s3ExportLocation" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the export image task. The possible values are active, completed, deleting, and deleted.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message for the export image task.

", + "locationName":"statusMessage" + } + } + }, + "ExportImageTask":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the image being exported.

", + "locationName":"description" + }, + "ExportImageTaskId":{ + "shape":"String", + "documentation":"

The ID of the export image task.

", + "locationName":"exportImageTaskId" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the image.

", + "locationName":"imageId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percent complete of the export image task.

", + "locationName":"progress" + }, + "S3ExportLocation":{ + "shape":"ExportTaskS3Location", + "documentation":"

Information about the destination S3 bucket.

", + "locationName":"s3ExportLocation" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the export image task. The possible values are active, completed, deleting, and deleted.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message for the export image task.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes an export image task.

" + }, + "ExportImageTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportImageTaskId" + } + }, + "ExportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ExportImageTask", + "locationName":"item" + } + }, + "ExportTask":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the resource being exported.

", + "locationName":"description" + }, + "ExportTaskId":{ + "shape":"String", + "documentation":"

The ID of the export task.

", + "locationName":"exportTaskId" + }, + "ExportToS3Task":{ + "shape":"ExportToS3Task", + "documentation":"

Information about the export task.

", + "locationName":"exportToS3" + }, + "InstanceExportDetails":{ + "shape":"InstanceExportDetails", + "documentation":"

Information about the instance to export.

", + "locationName":"instanceExport" + }, + "State":{ + "shape":"ExportTaskState", + "documentation":"

The state of the export task.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status message related to the export task.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTaskId":{"type":"string"}, + "ExportTaskIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ExportTaskId" + } + }, + "ExportTaskList":{ + "type":"list", + "member":{ + "shape":"ExportTask", + "locationName":"item" + } + }, + "ExportTaskS3Location":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The destination S3 bucket.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The prefix (logical hierarchy) in the bucket.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes the destination for an export image task.

" + }, + "ExportTaskS3LocationRequest":{ + "type":"structure", + "required":["S3Bucket"], + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The destination S3 bucket.

" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The prefix (logical hierarchy) in the bucket.

" + } + }, + "documentation":"

Describes the destination for an export image task.

" + }, + "ExportTaskState":{ + "type":"string", + "enum":[ + "active", + "cancelling", + "cancelled", + "completed" + ] + }, + "ExportToS3Task":{ + "type":"structure", + "members":{ + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The encryption key for your S3 bucket.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the format and location for an instance export task.

" + }, + "ExportToS3TaskSpecification":{ + "type":"structure", + "members":{ + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

", + "locationName":"containerFormat" + }, + "DiskImageFormat":{ + "shape":"DiskImageFormat", + "documentation":"

The format for the exported image.

", + "locationName":"diskImageFormat" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account vm-import-export@amazon.com.

", + "locationName":"s3Bucket" + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.

", + "locationName":"s3Prefix" + } + }, + "documentation":"

Describes an instance export task.

" + }, + "ExportTransitGatewayRoutesRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "S3Bucket" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the route table.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.

  • attachment.resource-id - The resource id of the transit gateway attachment.

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).

  • transit-gateway-route-destination-cidr-block - The CIDR range.

  • type - The type of route (active | blackhole).

", + "locationName":"Filter" + }, + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ExportTransitGatewayRoutesResult":{ + "type":"structure", + "members":{ + "S3Location":{ + "shape":"String", + "documentation":"

The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.

", + "locationName":"s3Location" + } + } + }, + "FailedQueuedPurchaseDeletion":{ + "type":"structure", + "members":{ + "Error":{ + "shape":"DeleteQueuedReservedInstancesError", + "documentation":"

The error.

", + "locationName":"error" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes a Reserved Instance whose queued purchase was not deleted.

" + }, + "FailedQueuedPurchaseDeletionSet":{ + "type":"list", + "member":{ + "shape":"FailedQueuedPurchaseDeletion", + "locationName":"item" + } + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

The filter values. Filter values are case-sensitive.

", + "locationName":"Value" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a describe operation are documented with the describe operation. For example:

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FleetActivityStatus":{ + "type":"string", + "enum":[ + "error", + "pending_fulfillment", + "pending_termination", + "fulfilled" + ] + }, + "FleetData":{ + "type":"structure", + "members":{ + "ActivityStatus":{ + "shape":"FleetActivityStatus", + "documentation":"

The progress of the EC2 Fleet. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.

", + "locationName":"activityStatus" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The creation date and time of the EC2 Fleet.

", + "locationName":"createTime" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

", + "locationName":"fleetId" + }, + "FleetState":{ + "shape":"FleetStateCode", + "documentation":"

The state of the EC2 Fleet.

", + "locationName":"fleetState" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"FleetExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "FulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target capacity.

", + "locationName":"fulfilledCapacity" + }, + "FulfilledOnDemandCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target On-Demand capacity.

", + "locationName":"fulfilledOnDemandCapacity" + }, + "LaunchTemplateConfigs":{ + "shape":"FleetLaunchTemplateConfigList", + "documentation":"

The launch template and overrides.

", + "locationName":"launchTemplateConfigs" + }, + "TargetCapacitySpecification":{ + "shape":"TargetCapacitySpecification", + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

", + "locationName":"targetCapacitySpecification" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running instances should be terminated when the EC2 Fleet expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.

", + "locationName":"validUntil" + }, + "ReplaceUnhealthyInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether EC2 Fleet should replace unhealthy instances.

", + "locationName":"replaceUnhealthyInstances" + }, + "SpotOptions":{ + "shape":"SpotOptions", + "documentation":"

The configuration of Spot Instances in an EC2 Fleet.

", + "locationName":"spotOptions" + }, + "OnDemandOptions":{ + "shape":"OnDemandOptions", + "documentation":"

The allocation strategy of On-Demand Instances in an EC2 Fleet.

", + "locationName":"onDemandOptions" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for an EC2 Fleet resource.

", + "locationName":"tagSet" + }, + "Errors":{ + "shape":"DescribeFleetsErrorSet", + "documentation":"

Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.

", + "locationName":"errorSet" + }, + "Instances":{ + "shape":"DescribeFleetsInstancesSet", + "documentation":"

Information about the instances that were launched by the fleet. Valid only when Type is set to instant.

", + "locationName":"fleetInstanceSet" + } + }, + "documentation":"

Describes an EC2 Fleet.

" + }, + "FleetEventType":{ + "type":"string", + "enum":[ + "instance-change", + "fleet-change", + "service-error" + ] + }, + "FleetExcessCapacityTerminationPolicy":{ + "type":"string", + "enum":[ + "no-termination", + "termination" + ] + }, + "FleetIdSet":{ + "type":"list", + "member":{"shape":"FleetIdentifier"} + }, + "FleetIdentifier":{"type":"string"}, + "FleetLaunchTemplateConfig":{ + "type":"structure", + "members":{ + "LaunchTemplateSpecification":{ + "shape":"FleetLaunchTemplateSpecification", + "documentation":"

The launch template.

", + "locationName":"launchTemplateSpecification" + }, + "Overrides":{ + "shape":"FleetLaunchTemplateOverridesList", + "documentation":"

Any parameters that you specify override the same parameters in the launch template.

", + "locationName":"overrides" + } + }, + "documentation":"

Describes a launch template and overrides.

" + }, + "FleetLaunchTemplateConfigList":{ + "type":"list", + "member":{ + "shape":"FleetLaunchTemplateConfig", + "locationName":"item" + } + }, + "FleetLaunchTemplateConfigListRequest":{ + "type":"list", + "member":{ + "shape":"FleetLaunchTemplateConfigRequest", + "locationName":"item" + }, + "max":50 + }, + "FleetLaunchTemplateConfigRequest":{ + "type":"structure", + "members":{ + "LaunchTemplateSpecification":{ + "shape":"FleetLaunchTemplateSpecificationRequest", + "documentation":"

The launch template to use. You must specify either the launch template ID or launch template name in the request.

" + }, + "Overrides":{ + "shape":"FleetLaunchTemplateOverridesListRequest", + "documentation":"

Any parameters that you specify override the same parameters in the launch template.

" + } + }, + "documentation":"

Describes a launch template and overrides.

" + }, + "FleetLaunchTemplateOverrides":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "MaxPrice":{ + "shape":"String", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", + "locationName":"maxPrice" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

", + "locationName":"subnetId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to launch the instances.

", + "locationName":"availabilityZone" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type.

", + "locationName":"weightedCapacity" + }, + "Priority":{ + "shape":"Double", + "documentation":"

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority.

", + "locationName":"priority" + }, + "Placement":{ + "shape":"PlacementResponse", + "documentation":"

The location where the instance launched, if applicable.

", + "locationName":"placement" + } + }, + "documentation":"

Describes overrides for a launch template.

" + }, + "FleetLaunchTemplateOverridesList":{ + "type":"list", + "member":{ + "shape":"FleetLaunchTemplateOverrides", + "locationName":"item" + } + }, + "FleetLaunchTemplateOverridesListRequest":{ + "type":"list", + "member":{ + "shape":"FleetLaunchTemplateOverridesRequest", + "locationName":"item" + }, + "max":50 + }, + "FleetLaunchTemplateOverridesRequest":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

" + }, + "MaxPrice":{ + "shape":"String", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to launch the instances.

" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type.

" + }, + "Priority":{ + "shape":"Double", + "documentation":"

The priority for the launch template override. If AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority.

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched, if applicable.

" + } + }, + "documentation":"

Describes overrides for a launch template.

" + }, + "FleetLaunchTemplateSpecification":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template. You must specify either a template ID or a template name.

", + "locationName":"launchTemplateId" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either a template name or a template ID.

", + "locationName":"launchTemplateName" + }, + "Version":{ + "shape":"String", + "documentation":"

The version number of the launch template. You must specify a version number.

", + "locationName":"version" + } + }, + "documentation":"

Describes a launch template.

" + }, + "FleetLaunchTemplateSpecificationRequest":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version number of the launch template. Note: This is a required parameter and will be updated soon.

" + } + }, + "documentation":"

The launch template to use. You must specify either the launch template ID or launch template name in the request.

" + }, + "FleetOnDemandAllocationStrategy":{ + "type":"string", + "enum":[ + "lowest-price", + "prioritized" + ] + }, + "FleetSet":{ + "type":"list", + "member":{ + "shape":"FleetData", + "locationName":"item" + } + }, + "FleetStateCode":{ + "type":"string", + "enum":[ + "submitted", + "active", + "deleted", + "failed", + "deleted_running", + "deleted_terminating", + "modifying" + ] + }, + "FleetType":{ + "type":"string", + "enum":[ + "request", + "maintain", + "instant" + ] + }, + "Float":{"type":"float"}, + "FlowLog":{ + "type":"structure", + "members":{ + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The date and time the flow log was created.

", + "locationName":"creationTime" + }, + "DeliverLogsErrorMessage":{ + "shape":"String", + "documentation":"

Information about the error that occurred. Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.

", + "locationName":"deliverLogsErrorMessage" + }, + "DeliverLogsPermissionArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role that posts logs to CloudWatch Logs.

", + "locationName":"deliverLogsPermissionArn" + }, + "DeliverLogsStatus":{ + "shape":"String", + "documentation":"

The status of the logs delivery (SUCCESS | FAILED).

", + "locationName":"deliverLogsStatus" + }, + "FlowLogId":{ + "shape":"String", + "documentation":"

The flow log ID.

", + "locationName":"flowLogId" + }, + "FlowLogStatus":{ + "shape":"String", + "documentation":"

The status of the flow log (ACTIVE).

", + "locationName":"flowLogStatus" + }, + "LogGroupName":{ + "shape":"String", + "documentation":"

The name of the flow log group.

", + "locationName":"logGroupName" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource on which the flow log was created.

", + "locationName":"resourceId" + }, + "TrafficType":{ + "shape":"TrafficType", + "documentation":"

The type of traffic captured for the flow log.

", + "locationName":"trafficType" + }, + "LogDestinationType":{ + "shape":"LogDestinationType", + "documentation":"

Specifies the type of destination to which the flow log data is published. Flow log data can be published to CloudWatch Logs or Amazon S3.

", + "locationName":"logDestinationType" + }, + "LogDestination":{ + "shape":"String", + "documentation":"

Specifies the destination to which the flow log data is published. Flow log data can be published to an CloudWatch Logs log group or an Amazon S3 bucket. If the flow log publishes to CloudWatch Logs, this element indicates the Amazon Resource Name (ARN) of the CloudWatch Logs log group to which the data is published. If the flow log publishes to Amazon S3, this element indicates the ARN of the Amazon S3 bucket to which the data is published.

", + "locationName":"logDestination" + }, + "LogFormat":{ + "shape":"String", + "documentation":"

The format of the flow log record.

", + "locationName":"logFormat" + } + }, + "documentation":"

Describes a flow log.

" + }, + "FlowLogSet":{ + "type":"list", + "member":{ + "shape":"FlowLog", + "locationName":"item" + } + }, + "FlowLogsResourceType":{ + "type":"string", + "enum":[ + "VPC", + "Subnet", + "NetworkInterface" + ] + }, + "FpgaImage":{ + "type":"structure", + "members":{ + "FpgaImageId":{ + "shape":"String", + "documentation":"

The FPGA image identifier (AFI ID).

", + "locationName":"fpgaImageId" + }, + "FpgaImageGlobalId":{ + "shape":"String", + "documentation":"

The global FPGA image identifier (AGFI ID).

", + "locationName":"fpgaImageGlobalId" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AFI.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AFI.

", + "locationName":"description" + }, + "ShellVersion":{ + "shape":"String", + "documentation":"

The version of the AWS Shell that was used to create the bitstream.

", + "locationName":"shellVersion" + }, + "PciId":{ + "shape":"PciId", + "documentation":"

Information about the PCI bus.

", + "locationName":"pciId" + }, + "State":{ + "shape":"FpgaImageState", + "documentation":"

Information about the state of the AFI.

", + "locationName":"state" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time the AFI was created.

", + "locationName":"createTime" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The time of the most recent update to the AFI.

", + "locationName":"updateTime" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the AFI owner.

", + "locationName":"ownerId" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.

", + "locationName":"ownerAlias" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes for the AFI.

", + "locationName":"productCodes" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the AFI.

", + "locationName":"tags" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the AFI is public.

", + "locationName":"public" + }, + "DataRetentionSupport":{ + "shape":"Boolean", + "documentation":"

Indicates whether data retention support is enabled for the AFI.

", + "locationName":"dataRetentionSupport" + } + }, + "documentation":"

Describes an Amazon FPGA image (AFI).

" + }, + "FpgaImageAttribute":{ + "type":"structure", + "members":{ + "FpgaImageId":{ + "shape":"String", + "documentation":"

The ID of the AFI.

", + "locationName":"fpgaImageId" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AFI.

", + "locationName":"name" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AFI.

", + "locationName":"description" + }, + "LoadPermissions":{ + "shape":"LoadPermissionList", + "documentation":"

The load permissions.

", + "locationName":"loadPermissions" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes.

", + "locationName":"productCodes" + } + }, + "documentation":"

Describes an Amazon FPGA image (AFI) attribute.

" + }, + "FpgaImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "name", + "loadPermission", + "productCodes" + ] + }, + "FpgaImageId":{"type":"string"}, + "FpgaImageIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "FpgaImageList":{ + "type":"list", + "member":{ + "shape":"FpgaImage", + "locationName":"item" + } + }, + "FpgaImageState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"FpgaImageStateCode", + "documentation":"

The state. The following are the possible values:

  • pending - AFI bitstream generation is in progress.

  • available - The AFI is available for use.

  • failed - AFI bitstream generation failed.

  • unavailable - The AFI is no longer available for use.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

If the state is failed, this is the error message.

", + "locationName":"message" + } + }, + "documentation":"

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

" + }, + "FpgaImageStateCode":{ + "type":"string", + "enum":[ + "pending", + "failed", + "available", + "unavailable" + ] + }, + "GatewayType":{ + "type":"string", + "enum":["ipsec.1"] + }, + "GetCapacityReservationUsageRequest":{ + "type":"structure", + "required":["CapacityReservationId"], + "members":{ + "CapacityReservationId":{ + "shape":"CapacityReservationId", + "documentation":"

The ID of the Capacity Reservation.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to retrieve the next page of results.

" + }, + "MaxResults":{ + "shape":"GetCapacityReservationUsageRequestMaxResults", + "documentation":"

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value.

Valid range: Minimum value of 1. Maximum value of 1000.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetCapacityReservationUsageRequestMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "GetCapacityReservationUsageResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + }, + "CapacityReservationId":{ + "shape":"String", + "documentation":"

The ID of the Capacity Reservation.

", + "locationName":"capacityReservationId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The type of instance for which the Capacity Reservation reserves capacity.

", + "locationName":"instanceType" + }, + "TotalInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances for which the Capacity Reservation reserves capacity.

", + "locationName":"totalInstanceCount" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

", + "locationName":"availableInstanceCount" + }, + "State":{ + "shape":"CapacityReservationState", + "documentation":"

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

  • active - The Capacity Reservation is active and the capacity is available for your use.

  • expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

  • cancelled - The Capacity Reservation was manually cancelled. The reserved capacity is no longer available for your use.

  • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

  • failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

", + "locationName":"state" + }, + "InstanceUsages":{ + "shape":"InstanceUsageSet", + "documentation":"

Information about the Capacity Reservation usage.

", + "locationName":"instanceUsageSet" + } + } + }, + "GetConsoleOutputRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Latest":{ + "shape":"Boolean", + "documentation":"

When enabled, retrieves the latest console output for the instance.

Default: disabled (false)

" + } + } + }, + "GetConsoleOutputResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Output":{ + "shape":"String", + "documentation":"

The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you.

", + "locationName":"output" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time at which the output was last updated.

", + "locationName":"timestamp" + } + } + }, + "GetConsoleScreenshotRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "WakeUp":{ + "shape":"Boolean", + "documentation":"

When set to true, acts as keystroke input and wakes up an instance that's in standby or \"sleep\" mode.

" + } + } + }, + "GetConsoleScreenshotResult":{ + "type":"structure", + "members":{ + "ImageData":{ + "shape":"String", + "documentation":"

The data that comprises the image.

", + "locationName":"imageData" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + } + } + }, + "GetEbsDefaultKmsKeyIdRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetEbsDefaultKmsKeyIdResult":{ + "type":"structure", + "members":{ + "KmsKeyId":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the default CMK for encryption by default.

", + "locationName":"kmsKeyId" + } + } + }, + "GetEbsEncryptionByDefaultRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetEbsEncryptionByDefaultResult":{ + "type":"structure", + "members":{ + "EbsEncryptionByDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether encryption by default is enabled.

", + "locationName":"ebsEncryptionByDefault" + } + } + }, + "GetHostReservationPurchasePreviewRequest":{ + "type":"structure", + "required":[ + "HostIdSet", + "OfferingId" + ], + "members":{ + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts with which the reservation is associated.

" + }, + "OfferingId":{ + "shape":"OfferingId", + "documentation":"

The offering ID of the reservation.

" + } + } + }, + "GetHostReservationPurchasePreviewResult":{ + "type":"structure", + "members":{ + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.

", + "locationName":"purchase" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The potential total hourly price of the reservation per hour.

", + "locationName":"totalHourlyPrice" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The potential total upfront price. This is billed immediately.

", + "locationName":"totalUpfrontPrice" + } + } + }, + "GetLaunchTemplateDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + } + } + }, + "GetLaunchTemplateDataResult":{ + "type":"structure", + "members":{ + "LaunchTemplateData":{ + "shape":"ResponseLaunchTemplateData", + "documentation":"

The instance data.

", + "locationName":"launchTemplateData" + } + } + }, + "GetPasswordDataRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the Windows instance.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "GetPasswordDataResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the Windows instance.

", + "locationName":"instanceId" + }, + "PasswordData":{ + "shape":"String", + "documentation":"

The password of the instance. Returns an empty string if the password is not available.

", + "locationName":"passwordData" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the data was last updated.

", + "locationName":"timestamp" + } + } + }, + "GetReservedInstancesExchangeQuoteRequest":{ + "type":"structure", + "required":["ReservedInstanceIds"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ReservedInstanceIds":{ + "shape":"ReservedInstanceIdSet", + "documentation":"

The IDs of the Convertible Reserved Instances to exchange.

", + "locationName":"ReservedInstanceId" + }, + "TargetConfigurations":{ + "shape":"TargetConfigurationRequestSet", + "documentation":"

The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

", + "locationName":"TargetConfiguration" + } + }, + "documentation":"

Contains the parameters for GetReservedInstanceExchangeQuote.

" + }, + "GetReservedInstancesExchangeQuoteResult":{ + "type":"structure", + "members":{ + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency of the transaction.

", + "locationName":"currencyCode" + }, + "IsValidExchange":{ + "shape":"Boolean", + "documentation":"

If true, the exchange is valid. If false, the exchange cannot be completed.

", + "locationName":"isValidExchange" + }, + "OutputReservedInstancesWillExpireAt":{ + "shape":"DateTime", + "documentation":"

The new end date of the reservation term.

", + "locationName":"outputReservedInstancesWillExpireAt" + }, + "PaymentDue":{ + "shape":"String", + "documentation":"

The total true upfront charge for the exchange.

", + "locationName":"paymentDue" + }, + "ReservedInstanceValueRollup":{ + "shape":"ReservationValue", + "documentation":"

The cost associated with the Reserved Instance.

", + "locationName":"reservedInstanceValueRollup" + }, + "ReservedInstanceValueSet":{ + "shape":"ReservedInstanceReservationValueSet", + "documentation":"

The configuration of your Convertible Reserved Instances.

", + "locationName":"reservedInstanceValueSet" + }, + "TargetConfigurationValueRollup":{ + "shape":"ReservationValue", + "documentation":"

The cost associated with the Reserved Instance.

", + "locationName":"targetConfigurationValueRollup" + }, + "TargetConfigurationValueSet":{ + "shape":"TargetReservationValueSet", + "documentation":"

The values of the target Convertible Reserved Instances.

", + "locationName":"targetConfigurationValueSet" + }, + "ValidationFailureReason":{ + "shape":"String", + "documentation":"

Describes the reason why the exchange cannot be completed.

", + "locationName":"validationFailureReason" + } + }, + "documentation":"

Contains the output of GetReservedInstancesExchangeQuote.

" + }, + "GetTransitGatewayAttachmentPropagationsRequest":{ + "type":"structure", + "required":["TransitGatewayAttachmentId"], + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • transit-gateway-route-table-id - The ID of the transit gateway route table.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetTransitGatewayAttachmentPropagationsResult":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentPropagations":{ + "shape":"TransitGatewayAttachmentPropagationList", + "documentation":"

Information about the propagation route tables.

", + "locationName":"transitGatewayAttachmentPropagations" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "GetTransitGatewayRouteTableAssociationsRequest":{ + "type":"structure", + "required":["TransitGatewayRouteTableId"], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The resource type (vpc | vpn).

  • transit-gateway-attachment-id - The ID of the attachment.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetTransitGatewayRouteTableAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"TransitGatewayRouteTableAssociationList", + "documentation":"

Information about the associations.

", + "locationName":"associations" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "GetTransitGatewayRouteTablePropagationsRequest":{ + "type":"structure", + "required":["TransitGatewayRouteTableId"], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • resource-id - The ID of the resource.

  • resource-type - The resource type (vpc | vpn).

  • transit-gateway-attachment-id - The ID of the attachment.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next page of results.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "GetTransitGatewayRouteTablePropagationsResult":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTablePropagations":{ + "shape":"TransitGatewayRouteTablePropagationList", + "documentation":"

Information about the route table propagations.

", + "locationName":"transitGatewayRouteTablePropagations" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", + "locationName":"nextToken" + } + } + }, + "GroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"groupId" + } + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + } + }, + "documentation":"

Describes a security group.

" + }, + "GroupIdentifierList":{ + "type":"list", + "member":{ + "shape":"GroupIdentifier", + "locationName":"item" + } + }, + "GroupIdentifierSet":{ + "type":"list", + "member":{ + "shape":"SecurityGroupIdentifier", + "locationName":"item" + } + }, + "GroupIds":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "GroupNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"GroupName" + } + }, + "HibernationOptions":{ + "type":"structure", + "members":{ + "Configured":{ + "shape":"Boolean", + "documentation":"

If this parameter is set to true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

", + "locationName":"configured" + } + }, + "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "HibernationOptionsRequest":{ + "type":"structure", + "members":{ + "Configured":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, your instance is enabled for hibernation.

Default: false

" + } + }, + "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "HistoryRecord":{ + "type":"structure", + "members":{ + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + }, + "EventType":{ + "shape":"EventType", + "documentation":"

The event type.

  • error - An error with the Spot Fleet request.

  • fleetRequestChange - A change in the status or configuration of the Spot Fleet request.

  • instanceChange - An instance was launched or terminated.

  • Information - An informational event.

", + "locationName":"eventType" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + } + }, + "documentation":"

Describes an event in the history of the Spot Fleet request.

" + }, + "HistoryRecordEntry":{ + "type":"structure", + "members":{ + "EventInformation":{ + "shape":"EventInformation", + "documentation":"

Information about the event.

", + "locationName":"eventInformation" + }, + "EventType":{ + "shape":"FleetEventType", + "documentation":"

The event type.

", + "locationName":"eventType" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + } + }, + "documentation":"

Describes an event in the history of an EC2 Fleet.

" + }, + "HistoryRecordSet":{ + "type":"list", + "member":{ + "shape":"HistoryRecordEntry", + "locationName":"item" + } + }, + "HistoryRecords":{ + "type":"list", + "member":{ + "shape":"HistoryRecord", + "locationName":"item" + } + }, + "Host":{ + "type":"structure", + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Whether auto-placement is on or off.

", + "locationName":"autoPlacement" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the Dedicated Host.

", + "locationName":"availabilityZone" + }, + "AvailableCapacity":{ + "shape":"AvailableCapacity", + "documentation":"

The number of new instances that can be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host.

", + "locationName":"hostId" + }, + "HostProperties":{ + "shape":"HostProperties", + "documentation":"

The hardware specifications of the Dedicated Host.

", + "locationName":"hostProperties" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.

", + "locationName":"hostReservationId" + }, + "Instances":{ + "shape":"HostInstanceList", + "documentation":"

The IDs and instance type that are currently running on the Dedicated Host.

", + "locationName":"instances" + }, + "State":{ + "shape":"AllocationState", + "documentation":"

The Dedicated Host's state.

", + "locationName":"state" + }, + "AllocationTime":{ + "shape":"DateTime", + "documentation":"

The time that the Dedicated Host was allocated.

", + "locationName":"allocationTime" + }, + "ReleaseTime":{ + "shape":"DateTime", + "documentation":"

The time that the Dedicated Host was released.

", + "locationName":"releaseTime" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Dedicated Host.

", + "locationName":"tagSet" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether host recovery is enabled or disabled for the Dedicated Host.

", + "locationName":"hostRecovery" + } + }, + "documentation":"

Describes the properties of the Dedicated Host.

" + }, + "HostId":{"type":"string"}, + "HostInstance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

the IDs of instances that are running on the Dedicated Host.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size (for example, m3.medium) of the running instance.

", + "locationName":"instanceType" + } + }, + "documentation":"

Describes an instance running on a Dedicated Host.

" + }, + "HostInstanceList":{ + "type":"list", + "member":{ + "shape":"HostInstance", + "locationName":"item" + } + }, + "HostList":{ + "type":"list", + "member":{ + "shape":"Host", + "locationName":"item" + } + }, + "HostOffering":{ + "type":"structure", + "members":{ + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the offering.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering (in seconds).

", + "locationName":"duration" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the offering.

", + "locationName":"hourlyPrice" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the offering.

", + "locationName":"instanceFamily" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the offering.

", + "locationName":"offeringId" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The available payment option.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the offering. Does not apply to No Upfront offerings.

", + "locationName":"upfrontPrice" + } + }, + "documentation":"

Details about the Dedicated Host Reservation offering.

" + }, + "HostOfferingSet":{ + "type":"list", + "member":{ + "shape":"HostOffering", + "locationName":"item" + } + }, + "HostProperties":{ + "type":"structure", + "members":{ + "Cores":{ + "shape":"Integer", + "documentation":"

The number of cores on the Dedicated Host.

", + "locationName":"cores" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size that the Dedicated Host supports (for example, m3.medium).

", + "locationName":"instanceType" + }, + "Sockets":{ + "shape":"Integer", + "documentation":"

The number of sockets on the Dedicated Host.

", + "locationName":"sockets" + }, + "TotalVCpus":{ + "shape":"Integer", + "documentation":"

The number of vCPUs on the Dedicated Host.

", + "locationName":"totalVCpus" + } + }, + "documentation":"

Describes properties of a Dedicated Host.

" + }, + "HostRecovery":{ + "type":"string", + "enum":[ + "on", + "off" + ] + }, + "HostReservation":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Integer", + "documentation":"

The number of Dedicated Hosts the reservation is associated with.

", + "locationName":"count" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The length of the reservation's term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).

", + "locationName":"duration" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation ends.

", + "locationName":"end" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation that specifies the associated Dedicated Hosts.

", + "locationName":"hostReservationId" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation.

", + "locationName":"hourlyPrice" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.

", + "locationName":"instanceFamily" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.

", + "locationName":"offeringId" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option selected for this reservation.

", + "locationName":"paymentOption" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time that the reservation started.

", + "locationName":"start" + }, + "State":{ + "shape":"ReservationState", + "documentation":"

The state of the reservation.

", + "locationName":"state" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the Dedicated Host Reservation.

", + "locationName":"tagSet" + } + }, + "documentation":"

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

" + }, + "HostReservationIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "HostReservationSet":{ + "type":"list", + "member":{ + "shape":"HostReservation", + "locationName":"item" + } + }, + "HostTenancy":{ + "type":"string", + "enum":[ + "dedicated", + "host" + ] + }, + "HypervisorType":{ + "type":"string", + "enum":[ + "ovm", + "xen" + ] + }, + "IKEVersionsList":{ + "type":"list", + "member":{ + "shape":"IKEVersionsListValue", + "locationName":"item" + } + }, + "IKEVersionsListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The IKE version.

", + "locationName":"value" + } + }, + "documentation":"

The internet key exchange (IKE) version permitted for the VPN tunnel.

" + }, + "IKEVersionsRequestList":{ + "type":"list", + "member":{ + "shape":"IKEVersionsRequestListValue", + "locationName":"item" + } + }, + "IKEVersionsRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The IKE version.

" + } + }, + "documentation":"

The IKE version that is permitted for the VPN tunnel.

" + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the instance profile.

", + "locationName":"id" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IamInstanceProfileAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the association.

", + "locationName":"associationId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "State":{ + "shape":"IamInstanceProfileAssociationState", + "documentation":"

The state of the association.

", + "locationName":"state" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The time the IAM instance profile was associated with the instance.

", + "locationName":"timestamp" + } + }, + "documentation":"

Describes an association between an IAM instance profile and an instance.

" + }, + "IamInstanceProfileAssociationSet":{ + "type":"list", + "member":{ + "shape":"IamInstanceProfileAssociation", + "locationName":"item" + } + }, + "IamInstanceProfileAssociationState":{ + "type":"string", + "enum":[ + "associating", + "associated", + "disassociating", + "disassociated" + ] + }, + "IamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "IcmpTypeCode":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The ICMP code. A value of -1 means all codes for the specified ICMP type.

", + "locationName":"code" + }, + "Type":{ + "shape":"Integer", + "documentation":"

The ICMP type. A value of -1 means all types.

", + "locationName":"type" + } + }, + "documentation":"

Describes the ICMP type and code.

" + }, + "IdFormat":{ + "type":"structure", + "members":{ + "Deadline":{ + "shape":"DateTime", + "documentation":"

The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.

", + "locationName":"deadline" + }, + "Resource":{ + "shape":"String", + "documentation":"

The type of resource.

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

", + "locationName":"useLongIds" + } + }, + "documentation":"

Describes the ID format for a resource.

" + }, + "IdFormatList":{ + "type":"list", + "member":{ + "shape":"IdFormat", + "locationName":"item" + } + }, + "Image":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "CreationDate":{ + "shape":"String", + "documentation":"

The date and time the image was created.

", + "locationName":"creationDate" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "ImageLocation":{ + "shape":"String", + "documentation":"

The location of the AMI.

", + "locationName":"imageLocation" + }, + "ImageType":{ + "shape":"ImageTypeValues", + "documentation":"

The type of image.

", + "locationName":"imageType" + }, + "Public":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

", + "locationName":"isPublic" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with the image, if any. Only applicable for machine images.

", + "locationName":"kernelId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the image owner.

", + "locationName":"imageOwnerId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

This value is set to windows for Windows AMIs; otherwise, it is blank.

", + "locationName":"platform" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

Any product codes associated with the AMI.

", + "locationName":"productCodes" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with the image, if any. Only applicable for machine images.

", + "locationName":"ramdiskId" + }, + "State":{ + "shape":"ImageState", + "documentation":"

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

", + "locationName":"imageState" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

Any block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the AMI that was provided during image creation.

", + "locationName":"description" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the image.

", + "locationName":"hypervisor" + }, + "ImageOwnerAlias":{ + "shape":"String", + "documentation":"

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

", + "locationName":"imageOwnerAlias" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the AMI that was provided during image creation.

", + "locationName":"name" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device volume (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the state change.

", + "locationName":"stateReason" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the image.

", + "locationName":"tagSet" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization of the AMI.

", + "locationName":"virtualizationType" + } + }, + "documentation":"

Describes an image.

" + }, + "ImageAttribute":{ + "type":"structure", + "members":{ + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

The block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "LaunchPermissions":{ + "shape":"LaunchPermissionList", + "documentation":"

The launch permissions.

", + "locationName":"launchPermission" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes.

", + "locationName":"productCodes" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the AMI.

", + "locationName":"description" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + } + }, + "documentation":"

Describes an image attribute.

" + }, + "ImageAttributeName":{ + "type":"string", + "enum":[ + "description", + "kernel", + "ramdisk", + "launchPermission", + "productCodes", + "blockDeviceMapping", + "sriovNetSupport" + ] + }, + "ImageDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image.

" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the disk.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: VHD | VMDK | OVA

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the EBS snapshot to be used for importing the snapshot.

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + } + }, + "documentation":"

Describes the disk container object for an import image task.

" + }, + "ImageDiskContainerList":{ + "type":"list", + "member":{ + "shape":"ImageDiskContainer", + "locationName":"item" + } + }, + "ImageId":{"type":"string"}, + "ImageIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImageId" + } + }, + "ImageList":{ + "type":"list", + "member":{ + "shape":"Image", + "locationName":"item" + } + }, + "ImageState":{ + "type":"string", + "enum":[ + "pending", + "available", + "invalid", + "deregistered", + "transient", + "failed", + "error" + ] + }, + "ImageTypeValues":{ + "type":"string", + "enum":[ + "machine", + "kernel", + "ramdisk" + ] + }, + "ImportClientVpnClientCertificateRevocationListRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "CertificateRevocationList" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint to which the client certificate revocation list applies.

" + }, + "CertificateRevocationList":{ + "shape":"String", + "documentation":"

The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ImportClientVpnClientCertificateRevocationListResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ImportImageRequest":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

" + }, + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The token to enable idempotency for VM import requests.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description string for the import image task.

" + }, + "DiskContainers":{ + "shape":"ImageDiskContainerList", + "documentation":"

Information about the disk containers.

", + "locationName":"DiskContainer" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor platform.

Valid values: xen

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the AMI is being copied to.

" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an AWS license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see Prerequisites in the VM Import/Export User Guide.

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

Valid values: Windows | Linux

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + } + }, + "ImportImageResult":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

", + "locationName":"architecture" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the AMI is encypted.

", + "locationName":"encrypted" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor of the import task.

", + "locationName":"hypervisor" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) created by the import task.

", + "locationName":"imageId" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The task ID of the import image task.

", + "locationName":"importTaskId" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted AMI.

", + "locationName":"kmsKeyId" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The operating system of the virtual machine.

", + "locationName":"platform" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the task.

", + "locationName":"progress" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the task.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message of the import task.

", + "locationName":"statusMessage" + } + } + }, + "ImportImageTask":{ + "type":"structure", + "members":{ + "Architecture":{ + "shape":"String", + "documentation":"

The architecture of the virtual machine.

Valid values: i386 | x86_64 | arm64

", + "locationName":"architecture" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the import task.

", + "locationName":"description" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the image is encrypted.

", + "locationName":"encrypted" + }, + "Hypervisor":{ + "shape":"String", + "documentation":"

The target hypervisor for the import task.

Valid values: xen

", + "locationName":"hypervisor" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

", + "locationName":"imageId" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import image task.

", + "locationName":"importTaskId" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted image.

", + "locationName":"kmsKeyId" + }, + "LicenseType":{ + "shape":"String", + "documentation":"

The license type of the virtual machine.

", + "locationName":"licenseType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The description string for the import image task.

", + "locationName":"platform" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress of the import image task.

", + "locationName":"progress" + }, + "SnapshotDetails":{ + "shape":"SnapshotDetailList", + "documentation":"

Information about the snapshots.

", + "locationName":"snapshotDetailSet" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import image task.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A descriptive status message for the import image task.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes an import image task.

" + }, + "ImportImageTaskList":{ + "type":"list", + "member":{ + "shape":"ImportImageTask", + "locationName":"item" + } + }, + "ImportInstanceLaunchSpecification":{ + "type":"structure", + "members":{ + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the instance.

", + "locationName":"architecture" + }, + "GroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The security group IDs.

", + "locationName":"GroupId" + }, + "GroupNames":{ + "shape":"SecurityGroupStringList", + "documentation":"

The security group names.

", + "locationName":"GroupName" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.

", + "locationName":"instanceType" + }, + "Monitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

", + "locationName":"monitoring" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] An available IP address from the IP address range of the subnet.

", + "locationName":"privateIpAddress" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "UserData":{ + "shape":"UserData", + "documentation":"

The Base64-encoded user data to make available to the instance.

", + "locationName":"userData" + } + }, + "documentation":"

Describes the launch specification for VM import.

" + }, + "ImportInstanceRequest":{ + "type":"structure", + "required":["Platform"], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the instance being imported.

", + "locationName":"description" + }, + "DiskImages":{ + "shape":"DiskImageList", + "documentation":"

The disk image.

", + "locationName":"diskImage" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "LaunchSpecification":{ + "shape":"ImportInstanceLaunchSpecification", + "documentation":"

The launch specification.

", + "locationName":"launchSpecification" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + } + } + }, + "ImportInstanceResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + } + }, + "ImportInstanceTaskDetails":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The instance operating system.

", + "locationName":"platform" + }, + "Volumes":{ + "shape":"ImportInstanceVolumeDetailSet", + "documentation":"

The volumes.

", + "locationName":"volumes" + } + }, + "documentation":"

Describes an import instance task.

" + }, + "ImportInstanceVolumeDetailItem":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting instance will reside.

", + "locationName":"availabilityZone" + }, + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the import of this particular disk image.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The status information or errors related to the disk image.

", + "locationName":"statusMessage" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "ImportInstanceVolumeDetailSet":{ + "type":"list", + "member":{ + "shape":"ImportInstanceVolumeDetailItem", + "locationName":"item" + } + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "KeyName", + "PublicKeyMaterial" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "KeyName":{ + "shape":"String", + "documentation":"

A unique name for the key pair.

", + "locationName":"keyName" + }, + "PublicKeyMaterial":{ + "shape":"Blob", + "documentation":"

The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.

", + "locationName":"publicKeyMaterial" + } + } + }, + "ImportKeyPairResult":{ + "type":"structure", + "members":{ + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

", + "locationName":"keyFingerprint" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The key pair name you provided.

", + "locationName":"keyName" + } + } + }, + "ImportSnapshotRequest":{ + "type":"structure", + "members":{ + "ClientData":{ + "shape":"ClientData", + "documentation":"

The client-specific data.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Token to enable idempotency for VM import requests.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description string for the import snapshot task.

" + }, + "DiskContainer":{ + "shape":"SnapshotDiskContainer", + "documentation":"

Information about the disk container.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

  • Key ID

  • Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

  • ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.

The specified CMK must exist in the Region that the snapshot is being copied to.

" + }, + "RoleName":{ + "shape":"String", + "documentation":"

The name of the role to use when not using the default role, 'vmimport'.

" + } + } + }, + "ImportSnapshotResult":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Information about the import snapshot task.

", + "locationName":"snapshotTaskDetail" + } + } + }, + "ImportSnapshotTask":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the import snapshot task.

", + "locationName":"description" + }, + "ImportTaskId":{ + "shape":"String", + "documentation":"

The ID of the import snapshot task.

", + "locationName":"importTaskId" + }, + "SnapshotTaskDetail":{ + "shape":"SnapshotTaskDetail", + "documentation":"

Describes an import snapshot task.

", + "locationName":"snapshotTaskDetail" + } + }, + "documentation":"

Describes an import snapshot task.

" + }, + "ImportSnapshotTaskList":{ + "type":"list", + "member":{ + "shape":"ImportSnapshotTask", + "locationName":"item" + } + }, + "ImportTaskId":{"type":"string"}, + "ImportTaskIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ImportTaskId" + } + }, + "ImportVolumeRequest":{ + "type":"structure", + "required":[ + "AvailabilityZone", + "Image", + "Volume" + ], + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the resulting EBS volume.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the volume.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Image":{ + "shape":"DiskImageDetail", + "documentation":"

The disk image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"VolumeDetail", + "documentation":"

The volume size.

", + "locationName":"volume" + } + } + }, + "ImportVolumeResult":{ + "type":"structure", + "members":{ + "ConversionTask":{ + "shape":"ConversionTask", + "documentation":"

Information about the conversion task.

", + "locationName":"conversionTask" + } + } + }, + "ImportVolumeTaskDetails":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the resulting volume will reside.

", + "locationName":"availabilityZone" + }, + "BytesConverted":{ + "shape":"Long", + "documentation":"

The number of bytes converted so far.

", + "locationName":"bytesConverted" + }, + "Description":{ + "shape":"String", + "documentation":"

The description you provided when starting the import volume task.

", + "locationName":"description" + }, + "Image":{ + "shape":"DiskImageDescription", + "documentation":"

The image.

", + "locationName":"image" + }, + "Volume":{ + "shape":"DiskImageVolumeDescription", + "documentation":"

The volume.

", + "locationName":"volume" + } + }, + "documentation":"

Describes an import volume task.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "AmiLaunchIndex":{ + "shape":"Integer", + "documentation":"

The AMI launch index, which can be used to find this instance in the launch group.

", + "locationName":"amiLaunchIndex" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI used to launch the instance.

", + "locationName":"imageId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The kernel associated with this instance, if applicable.

", + "locationName":"kernelId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair, if this instance was launched with an associated key pair.

", + "locationName":"keyName" + }, + "LaunchTime":{ + "shape":"DateTime", + "documentation":"

The time the instance was launched.

", + "locationName":"launchTime" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring for the instance.

", + "locationName":"monitoring" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The location where the instance launched, if applicable.

", + "locationName":"placement" + }, + "Platform":{ + "shape":"PlatformValues", + "documentation":"

The value is Windows for Windows instances; otherwise blank.

", + "locationName":"platform" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

(IPv4 only) The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

[EC2-VPC] The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IPv4 address assigned to the instance.

", + "locationName":"privateIpAddress" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

The product codes attached to this instance, if applicable.

", + "locationName":"productCodes" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

(IPv4 only) The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.

", + "locationName":"dnsName" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IPv4 address assigned to the instance, if applicable.

", + "locationName":"ipAddress" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The RAM disk associated with this instance, if applicable.

", + "locationName":"ramdiskId" + }, + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"instanceState" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The reason for the most recent state transition. This might be an empty string.

", + "locationName":"reason" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet in which the instance is running.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the VPC in which the instance is running.

", + "locationName":"vpcId" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the image.

", + "locationName":"architecture" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

Any block device mapping entries for the instance.

", + "locationName":"blockDeviceMapping" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

The idempotency token you provided when you launched the instance, if applicable.

", + "locationName":"clientToken" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Specifies whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "Hypervisor":{ + "shape":"HypervisorType", + "documentation":"

The hypervisor type of the instance.

", + "locationName":"hypervisor" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The IAM instance profile associated with the instance, if applicable.

", + "locationName":"iamInstanceProfile" + }, + "InstanceLifecycle":{ + "shape":"InstanceLifecycleType", + "documentation":"

Indicates whether this is a Spot Instance or a Scheduled Instance.

", + "locationName":"instanceLifecycle" + }, + "ElasticGpuAssociations":{ + "shape":"ElasticGpuAssociationList", + "documentation":"

The Elastic GPU associated with the instance.

", + "locationName":"elasticGpuAssociationSet" + }, + "ElasticInferenceAcceleratorAssociations":{ + "shape":"ElasticInferenceAcceleratorAssociationList", + "documentation":"

The elastic inference accelerator associated with the instance.

", + "locationName":"elasticInferenceAcceleratorAssociationSet" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceList", + "documentation":"

[EC2-VPC] The network interfaces for the instance.

", + "locationName":"networkInterfaceSet" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device volume (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "RootDeviceType":{ + "shape":"DeviceType", + "documentation":"

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

", + "locationName":"rootDeviceType" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups for the instance.

", + "locationName":"groupSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

If the request is a Spot Instance request, the ID of the request.

", + "locationName":"spotInstanceRequestId" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "StateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the most recent state transition.

", + "locationName":"stateReason" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the instance.

", + "locationName":"tagSet" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The virtualization type of the instance.

", + "locationName":"virtualizationType" + }, + "CpuOptions":{ + "shape":"CpuOptions", + "documentation":"

The CPU options for the instance.

", + "locationName":"cpuOptions" + }, + "CapacityReservationId":{ + "shape":"String", + "documentation":"

The ID of the Capacity Reservation.

", + "locationName":"capacityReservationId" + }, + "CapacityReservationSpecification":{ + "shape":"CapacityReservationSpecificationResponse", + "documentation":"

Information about the Capacity Reservation targeting option.

", + "locationName":"capacityReservationSpecification" + }, + "HibernationOptions":{ + "shape":"HibernationOptions", + "documentation":"

Indicates whether the instance is enabled for hibernation.

", + "locationName":"hibernationOptions" + }, + "Licenses":{ + "shape":"LicenseList", + "documentation":"

The license configurations.

", + "locationName":"licenseSet" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceAttribute":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

The security groups associated with the instance.

", + "locationName":"groupSet" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingList", + "documentation":"

The block device mapping of the instance.

", + "locationName":"blockDeviceMapping" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.

", + "locationName":"disableApiTermination" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether enhanced networking with ENA is enabled.

", + "locationName":"enaSupport" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "locationName":"ebsOptimized" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"AttributeValue", + "documentation":"

The kernel ID.

", + "locationName":"kernel" + }, + "ProductCodes":{ + "shape":"ProductCodeList", + "documentation":"

A list of product codes.

", + "locationName":"productCodes" + }, + "RamdiskId":{ + "shape":"AttributeValue", + "documentation":"

The RAM disk ID.

", + "locationName":"ramdisk" + }, + "RootDeviceName":{ + "shape":"AttributeValue", + "documentation":"

The device name of the root device volume (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT.

", + "locationName":"sourceDestCheck" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

", + "locationName":"sriovNetSupport" + }, + "UserData":{ + "shape":"AttributeValue", + "documentation":"

The user data.

", + "locationName":"userData" + } + }, + "documentation":"

Describes an instance attribute.

" + }, + "InstanceAttributeName":{ + "type":"string", + "enum":[ + "instanceType", + "kernel", + "ramdisk", + "userData", + "disableApiTermination", + "instanceInitiatedShutdownBehavior", + "rootDeviceName", + "blockDeviceMapping", + "productCodes", + "sourceDestCheck", + "groupSet", + "ebsOptimized", + "sriovNetSupport", + "enaSupport" + ] + }, + "InstanceBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDevice", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "InstanceBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMapping", + "locationName":"item" + } + }, + "InstanceBlockDeviceMappingSpecification":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

", + "locationName":"deviceName" + }, + "Ebs":{ + "shape":"EbsInstanceBlockDeviceSpecification", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

suppress the specified device included in the block device mapping.

", + "locationName":"noDevice" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name.

", + "locationName":"virtualName" + } + }, + "documentation":"

Describes a block device mapping entry.

" + }, + "InstanceBlockDeviceMappingSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceBlockDeviceMappingSpecification", + "locationName":"item" + } + }, + "InstanceCapacity":{ + "type":"structure", + "members":{ + "AvailableCapacity":{ + "shape":"Integer", + "documentation":"

The number of instances that can still be launched onto the Dedicated Host.

", + "locationName":"availableCapacity" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type size supported by the Dedicated Host.

", + "locationName":"instanceType" + }, + "TotalCapacity":{ + "shape":"Integer", + "documentation":"

The total number of instances that can be launched onto the Dedicated Host.

", + "locationName":"totalCapacity" + } + }, + "documentation":"

Information about the instance type that the Dedicated Host supports.

" + }, + "InstanceCount":{ + "type":"structure", + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of listed Reserved Instances in the state specified by the state.

", + "locationName":"instanceCount" + }, + "State":{ + "shape":"ListingState", + "documentation":"

The states of the listed Reserved Instances.

", + "locationName":"state" + } + }, + "documentation":"

Describes a Reserved Instance listing state.

" + }, + "InstanceCountList":{ + "type":"list", + "member":{ + "shape":"InstanceCount", + "locationName":"item" + } + }, + "InstanceCreditSpecification":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "CpuCredits":{ + "shape":"String", + "documentation":"

The credit option for CPU usage of the instance. Valid values are standard and unlimited.

", + "locationName":"cpuCredits" + } + }, + "documentation":"

Describes the credit option for CPU usage of a T2 or T3 instance.

" + }, + "InstanceCreditSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceCreditSpecification", + "locationName":"item" + } + }, + "InstanceCreditSpecificationListRequest":{ + "type":"list", + "member":{ + "shape":"InstanceCreditSpecificationRequest", + "locationName":"item" + } + }, + "InstanceCreditSpecificationRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

" + }, + "CpuCredits":{ + "shape":"String", + "documentation":"

The credit option for CPU usage of the instance. Valid values are standard and unlimited.

" + } + }, + "documentation":"

Describes the credit option for CPU usage of a T2 or T3 instance.

" + }, + "InstanceEventId":{"type":"string"}, + "InstanceExportDetails":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the resource being exported.

", + "locationName":"instanceId" + }, + "TargetEnvironment":{ + "shape":"ExportEnvironment", + "documentation":"

The target virtualization environment.

", + "locationName":"targetEnvironment" + } + }, + "documentation":"

Describes an instance to export.

" + }, + "InstanceHealthStatus":{ + "type":"string", + "enum":[ + "healthy", + "unhealthy" + ] + }, + "InstanceId":{"type":"string"}, + "InstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "InstanceIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"InstanceId" + } + }, + "InstanceIdsSet":{ + "type":"list", + "member":{ + "shape":"InstanceId", + "locationName":"item" + } + }, + "InstanceInterruptionBehavior":{ + "type":"string", + "enum":[ + "hibernate", + "stop", + "terminate" + ] + }, + "InstanceIpv6Address":{ + "type":"structure", + "members":{ + "Ipv6Address":{ + "shape":"String", + "documentation":"

The IPv6 address.

", + "locationName":"ipv6Address" + } + }, + "documentation":"

Describes an IPv6 address.

" + }, + "InstanceIpv6AddressList":{ + "type":"list", + "member":{ + "shape":"InstanceIpv6Address", + "locationName":"item" + } + }, + "InstanceIpv6AddressListRequest":{ + "type":"list", + "member":{ + "shape":"InstanceIpv6AddressRequest", + "locationName":"InstanceIpv6Address" + } + }, + "InstanceIpv6AddressRequest":{ + "type":"structure", + "members":{ + "Ipv6Address":{ + "shape":"String", + "documentation":"

The IPv6 address.

" + } + }, + "documentation":"

Describes an IPv6 address.

" + }, + "InstanceLifecycle":{ + "type":"string", + "enum":[ + "spot", + "on-demand" + ] + }, + "InstanceLifecycleType":{ + "type":"string", + "enum":[ + "spot", + "scheduled" + ] + }, + "InstanceList":{ + "type":"list", + "member":{ + "shape":"Instance", + "locationName":"item" + } + }, + "InstanceMarketOptionsRequest":{ + "type":"structure", + "members":{ + "MarketType":{ + "shape":"MarketType", + "documentation":"

The market type.

" + }, + "SpotOptions":{ + "shape":"SpotMarketOptions", + "documentation":"

The options for Spot Instances.

" + } + }, + "documentation":"

Describes the market (purchasing) option for the instances.

" + }, + "InstanceMatchCriteria":{ + "type":"string", + "enum":[ + "open", + "targeted" + ] + }, + "InstanceMonitoring":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Monitoring":{ + "shape":"Monitoring", + "documentation":"

The monitoring for the instance.

", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the monitoring of an instance.

" + }, + "InstanceMonitoringList":{ + "type":"list", + "member":{ + "shape":"InstanceMonitoring", + "locationName":"item" + } + }, + "InstanceNetworkInterface":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IPv4 associated with the network interface.

", + "locationName":"association" + }, + "Attachment":{ + "shape":"InstanceNetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups.

", + "locationName":"groupSet" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"

One or more IPv6 addresses associated with the network interface.

", + "locationName":"ipv6AddressesSet" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that created the network interface.

", + "locationName":"ownerId" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IPv4 address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"InstancePrivateIpAddressList", + "documentation":"

One or more private IPv4 addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether to validate network traffic to or from this network interface.

", + "locationName":"sourceDestCheck" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "InterfaceType":{ + "shape":"String", + "documentation":"

Describes the type of network interface.

Valid values: interface | efa

", + "locationName":"interfaceType" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the Elastic IP address.

", + "locationName":"ipOwnerId" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The public IP address or Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + } + }, + "documentation":"

Describes association information for an Elastic IP address (IPv4).

" + }, + "InstanceNetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device on the instance for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "InstanceNetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterface", + "locationName":"item" + } + }, + "InstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

", + "locationName":"associatePublicIpAddress" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.

", + "locationName":"deleteOnTermination" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"description" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The position of the network interface in the attachment order. A primary network interface has a device index of 0.

If you specify a network interface when launching an instance, you must specify the device index.

", + "locationName":"deviceIndex" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"SecurityGroupId" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

", + "locationName":"ipv6AddressCount" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

", + "locationName":"ipv6AddressesSet", + "queryName":"Ipv6Addresses" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"privateIpAddressesSet", + "queryName":"PrivateIpAddresses" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.

", + "locationName":"subnetId" + }, + "InterfaceType":{ + "shape":"String", + "documentation":"

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

" + } + }, + "documentation":"

Describes a network interface.

" + }, + "InstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"InstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "InstancePrivateIpAddress":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"InstanceNetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address for the network interface.

", + "locationName":"association" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IPv4 address is the primary private IP address of the network interface.

", + "locationName":"primary" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private IPv4 DNS name.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IPv4 address of the network interface.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes a private IPv4 address.

" + }, + "InstancePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"InstancePrivateIpAddress", + "locationName":"item" + } + }, + "InstanceSpecification":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance to specify which volumes should be snapshotted.

" + }, + "ExcludeBootVolume":{ + "shape":"Boolean", + "documentation":"

Excludes the root volume from being snapshotted.

" + } + }, + "documentation":"

The instance details to specify which volumes should be snapshotted.

" + }, + "InstanceState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"Integer", + "documentation":"

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

", + "locationName":"code" + }, + "Name":{ + "shape":"InstanceStateName", + "documentation":"

The current state of the instance.

", + "locationName":"name" + } + }, + "documentation":"

Describes the current state of an instance.

" + }, + "InstanceStateChange":{ + "type":"structure", + "members":{ + "CurrentState":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

", + "locationName":"currentState" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "PreviousState":{ + "shape":"InstanceState", + "documentation":"

The previous state of the instance.

", + "locationName":"previousState" + } + }, + "documentation":"

Describes an instance state change.

" + }, + "InstanceStateChangeList":{ + "type":"list", + "member":{ + "shape":"InstanceStateChange", + "locationName":"item" + } + }, + "InstanceStateName":{ + "type":"string", + "enum":[ + "pending", + "running", + "shutting-down", + "terminated", + "stopping", + "stopped" + ] + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"InstanceStatusEventList", + "documentation":"

Any scheduled events associated with the instance.

", + "locationName":"eventsSet" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceState":{ + "shape":"InstanceState", + "documentation":"

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

", + "locationName":"instanceState" + }, + "InstanceStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

", + "locationName":"instanceStatus" + }, + "SystemStatus":{ + "shape":"InstanceStatusSummary", + "documentation":"

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

", + "locationName":"systemStatus" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceStatusDetails":{ + "type":"structure", + "members":{ + "ImpairedSince":{ + "shape":"DateTime", + "documentation":"

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

", + "locationName":"impairedSince" + }, + "Name":{ + "shape":"StatusName", + "documentation":"

The type of instance status.

", + "locationName":"name" + }, + "Status":{ + "shape":"StatusType", + "documentation":"

The status.

", + "locationName":"status" + } + }, + "documentation":"

Describes the instance status.

" + }, + "InstanceStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusDetails", + "locationName":"item" + } + }, + "InstanceStatusEvent":{ + "type":"structure", + "members":{ + "InstanceEventId":{ + "shape":"InstanceEventId", + "documentation":"

The ID of the event.

", + "locationName":"instanceEventId" + }, + "Code":{ + "shape":"EventCode", + "documentation":"

The event code.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

", + "locationName":"description" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest scheduled end time for the event.

", + "locationName":"notAfter" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest scheduled start time for the event.

", + "locationName":"notBefore" + }, + "NotBeforeDeadline":{ + "shape":"DateTime", + "documentation":"

The deadline for starting the event.

", + "locationName":"notBeforeDeadline" + } + }, + "documentation":"

Describes a scheduled event for an instance.

" + }, + "InstanceStatusEventList":{ + "type":"list", + "member":{ + "shape":"InstanceStatusEvent", + "locationName":"item" + } + }, + "InstanceStatusList":{ + "type":"list", + "member":{ + "shape":"InstanceStatus", + "locationName":"item" + } + }, + "InstanceStatusSummary":{ + "type":"structure", + "members":{ + "Details":{ + "shape":"InstanceStatusDetailsList", + "documentation":"

The system instance health or application instance health.

", + "locationName":"details" + }, + "Status":{ + "shape":"SummaryStatus", + "documentation":"

The status.

", + "locationName":"status" + } + }, + "documentation":"

Describes the status of an instance.

" + }, + "InstanceType":{ + "type":"string", + "enum":[ + "t1.micro", + "t2.nano", + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "t2.xlarge", + "t2.2xlarge", + "t3.nano", + "t3.micro", + "t3.small", + "t3.medium", + "t3.large", + "t3.xlarge", + "t3.2xlarge", + "t3a.nano", + "t3a.micro", + "t3a.small", + "t3a.medium", + "t3a.large", + "t3a.xlarge", + "t3a.2xlarge", + "m1.small", + "m1.medium", + "m1.large", + "m1.xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "m4.16xlarge", + "m2.xlarge", + "m2.2xlarge", + "m2.4xlarge", + "cr1.8xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "r4.large", + "r4.xlarge", + "r4.2xlarge", + "r4.4xlarge", + "r4.8xlarge", + "r4.16xlarge", + "r5.large", + "r5.xlarge", + "r5.2xlarge", + "r5.4xlarge", + "r5.8xlarge", + "r5.12xlarge", + "r5.16xlarge", + "r5.24xlarge", + "r5.metal", + "r5a.large", + "r5a.xlarge", + "r5a.2xlarge", + "r5a.4xlarge", + "r5a.8xlarge", + "r5a.12xlarge", + "r5a.16xlarge", + "r5a.24xlarge", + "r5d.large", + "r5d.xlarge", + "r5d.2xlarge", + "r5d.4xlarge", + "r5d.8xlarge", + "r5d.12xlarge", + "r5d.16xlarge", + "r5d.24xlarge", + "r5d.metal", + "r5ad.large", + "r5ad.xlarge", + "r5ad.2xlarge", + "r5ad.4xlarge", + "r5ad.8xlarge", + "r5ad.12xlarge", + "r5ad.16xlarge", + "r5ad.24xlarge", + "x1.16xlarge", + "x1.32xlarge", + "x1e.xlarge", + "x1e.2xlarge", + "x1e.4xlarge", + "x1e.8xlarge", + "x1e.16xlarge", + "x1e.32xlarge", + "i2.xlarge", + "i2.2xlarge", + "i2.4xlarge", + "i2.8xlarge", + "i3.large", + "i3.xlarge", + "i3.2xlarge", + "i3.4xlarge", + "i3.8xlarge", + "i3.16xlarge", + "i3.metal", + "i3en.large", + "i3en.xlarge", + "i3en.2xlarge", + "i3en.3xlarge", + "i3en.6xlarge", + "i3en.12xlarge", + "i3en.24xlarge", + "i3en.metal", + "hi1.4xlarge", + "hs1.8xlarge", + "c1.medium", + "c1.xlarge", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "c5.large", + "c5.xlarge", + "c5.2xlarge", + "c5.4xlarge", + "c5.9xlarge", + "c5.12xlarge", + "c5.18xlarge", + "c5.24xlarge", + "c5.metal", + "c5d.large", + "c5d.xlarge", + "c5d.2xlarge", + "c5d.4xlarge", + "c5d.9xlarge", + "c5d.18xlarge", + "c5n.large", + "c5n.xlarge", + "c5n.2xlarge", + "c5n.4xlarge", + "c5n.9xlarge", + "c5n.18xlarge", + "cc1.4xlarge", + "cc2.8xlarge", + "g2.2xlarge", + "g2.8xlarge", + "g3.4xlarge", + "g3.8xlarge", + "g3.16xlarge", + "g3s.xlarge", + "g4dn.xlarge", + "g4dn.2xlarge", + "g4dn.4xlarge", + "g4dn.8xlarge", + "g4dn.12xlarge", + "g4dn.16xlarge", + "cg1.4xlarge", + "p2.xlarge", + "p2.8xlarge", + "p2.16xlarge", + "p3.2xlarge", + "p3.8xlarge", + "p3.16xlarge", + "p3dn.24xlarge", + "d2.xlarge", + "d2.2xlarge", + "d2.4xlarge", + "d2.8xlarge", + "f1.2xlarge", + "f1.4xlarge", + "f1.16xlarge", + "m5.large", + "m5.xlarge", + "m5.2xlarge", + "m5.4xlarge", + "m5.8xlarge", + "m5.12xlarge", + "m5.16xlarge", + "m5.24xlarge", + "m5.metal", + "m5a.large", + "m5a.xlarge", + "m5a.2xlarge", + "m5a.4xlarge", + "m5a.8xlarge", + "m5a.12xlarge", + "m5a.16xlarge", + "m5a.24xlarge", + "m5d.large", + "m5d.xlarge", + "m5d.2xlarge", + "m5d.4xlarge", + "m5d.8xlarge", + "m5d.12xlarge", + "m5d.16xlarge", + "m5d.24xlarge", + "m5d.metal", + "m5ad.large", + "m5ad.xlarge", + "m5ad.2xlarge", + "m5ad.4xlarge", + "m5ad.8xlarge", + "m5ad.12xlarge", + "m5ad.16xlarge", + "m5ad.24xlarge", + "h1.2xlarge", + "h1.4xlarge", + "h1.8xlarge", + "h1.16xlarge", + "z1d.large", + "z1d.xlarge", + "z1d.2xlarge", + "z1d.3xlarge", + "z1d.6xlarge", + "z1d.12xlarge", + "z1d.metal", + "u-6tb1.metal", + "u-9tb1.metal", + "u-12tb1.metal", + "u-18tb1.metal", + "u-24tb1.metal", + "a1.medium", + "a1.large", + "a1.xlarge", + "a1.2xlarge", + "a1.4xlarge", + "a1.metal", + "m5dn.large", + "m5dn.xlarge", + "m5dn.2xlarge", + "m5dn.4xlarge", + "m5dn.8xlarge", + "m5dn.12xlarge", + "m5dn.16xlarge", + "m5dn.24xlarge", + "m5n.large", + "m5n.xlarge", + "m5n.2xlarge", + "m5n.4xlarge", + "m5n.8xlarge", + "m5n.12xlarge", + "m5n.16xlarge", + "m5n.24xlarge", + "r5dn.large", + "r5dn.xlarge", + "r5dn.2xlarge", + "r5dn.4xlarge", + "r5dn.8xlarge", + "r5dn.12xlarge", + "r5dn.16xlarge", + "r5dn.24xlarge", + "r5n.large", + "r5n.xlarge", + "r5n.2xlarge", + "r5n.4xlarge", + "r5n.8xlarge", + "r5n.12xlarge", + "r5n.16xlarge", + "r5n.24xlarge" + ] + }, + "InstanceTypeList":{ + "type":"list", + "member":{"shape":"InstanceType"} + }, + "InstanceUsage":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that is making use of the Capacity Reservation.

", + "locationName":"accountId" + }, + "UsedInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances the AWS account currently has in the Capacity Reservation.

", + "locationName":"usedInstanceCount" + } + }, + "documentation":"

Information about the Capacity Reservation usage.

" + }, + "InstanceUsageSet":{ + "type":"list", + "member":{ + "shape":"InstanceUsage", + "locationName":"item" + } + }, + "Integer":{"type":"integer"}, + "InterfacePermissionType":{ + "type":"string", + "enum":[ + "INSTANCE-ATTACH", + "EIP-ASSOCIATE" + ] + }, + "InternetGateway":{ + "type":"structure", + "members":{ + "Attachments":{ + "shape":"InternetGatewayAttachmentList", + "documentation":"

Any VPCs attached to the internet gateway.

", + "locationName":"attachmentSet" + }, + "InternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the internet gateway.

", + "locationName":"internetGatewayId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the internet gateway.

", + "locationName":"ownerId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the internet gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an internet gateway.

" + }, + "InternetGatewayAttachment":{ + "type":"structure", + "members":{ + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

" + }, + "InternetGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"InternetGatewayAttachment", + "locationName":"item" + } + }, + "InternetGatewayId":{"type":"string"}, + "InternetGatewayList":{ + "type":"list", + "member":{ + "shape":"InternetGateway", + "locationName":"item" + } + }, + "IpPermission":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

[VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

", + "locationName":"ipProtocol" + }, + "IpRanges":{ + "shape":"IpRangeList", + "documentation":"

The IPv4 ranges.

", + "locationName":"ipRanges" + }, + "Ipv6Ranges":{ + "shape":"Ipv6RangeList", + "documentation":"

[VPC only] The IPv6 ranges.

", + "locationName":"ipv6Ranges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdList", + "documentation":"

[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.

", + "locationName":"prefixListIds" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairList", + "documentation":"

The security group and AWS account ID pairs.

", + "locationName":"groups" + } + }, + "documentation":"

Describes a set of permissions for a security group rule.

" + }, + "IpPermissionList":{ + "type":"list", + "member":{ + "shape":"IpPermission", + "locationName":"item" + } + }, + "IpRange":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.

", + "locationName":"cidrIp" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group rule that references this IPv4 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", + "locationName":"description" + } + }, + "documentation":"

Describes an IPv4 range.

" + }, + "IpRangeList":{ + "type":"list", + "member":{ + "shape":"IpRange", + "locationName":"item" + } + }, + "IpRanges":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "Ipv6Address":{"type":"string"}, + "Ipv6AddressList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "Ipv6CidrBlock":{ + "type":"structure", + "members":{ + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block.

", + "locationName":"ipv6CidrBlock" + } + }, + "documentation":"

Describes an IPv6 CIDR block.

" + }, + "Ipv6CidrBlockSet":{ + "type":"list", + "member":{ + "shape":"Ipv6CidrBlock", + "locationName":"item" + } + }, + "Ipv6Range":{ + "type":"structure", + "members":{ + "CidrIpv6":{ + "shape":"String", + "documentation":"

The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.

", + "locationName":"cidrIpv6" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the security group rule that references this IPv6 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", + "locationName":"description" + } + }, + "documentation":"

[EC2-VPC only] Describes an IPv6 range.

" + }, + "Ipv6RangeList":{ + "type":"list", + "member":{ + "shape":"Ipv6Range", + "locationName":"item" + } + }, + "Ipv6SupportValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "KernelId":{"type":"string"}, + "KeyNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"KeyName" + } + }, + "KeyPair":{ + "type":"structure", + "members":{ + "KeyFingerprint":{ + "shape":"String", + "documentation":"

The SHA-1 digest of the DER encoded private key.

", + "locationName":"keyFingerprint" + }, + "KeyMaterial":{ + "shape":"SensitiveUserData", + "documentation":"

An unencrypted PEM encoded RSA private key.

", + "locationName":"keyMaterial" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairInfo":{ + "type":"structure", + "members":{ + "KeyFingerprint":{ + "shape":"String", + "documentation":"

If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.

", + "locationName":"keyFingerprint" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{ + "shape":"KeyPairInfo", + "locationName":"item" + } + }, + "KeyPairName":{"type":"string"}, + "KmsKeyId":{"type":"string"}, + "LaunchPermission":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + }, + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + } + }, + "documentation":"

Describes a launch permission.

" + }, + "LaunchPermissionList":{ + "type":"list", + "member":{ + "shape":"LaunchPermission", + "locationName":"item" + } + }, + "LaunchPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to add to the list of launch permissions for the AMI.

" + }, + "Remove":{ + "shape":"LaunchPermissionList", + "documentation":"

The AWS account ID to remove from the list of launch permissions for the AMI.

" + } + }, + "documentation":"

Describes a launch permission modification.

" + }, + "LaunchSpecification":{ + "type":"structure", + "members":{ + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded user data for the instance.

", + "locationName":"userData" + }, + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries.

", + "locationName":"blockDeviceMapping" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", + "locationName":"networkInterfaceSet" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instance.

", + "locationName":"subnetId" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "locationName":"monitoring" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "LaunchSpecsList":{ + "type":"list", + "member":{ + "shape":"SpotFleetLaunchSpecification", + "locationName":"item" + } + }, + "LaunchTemplate":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

", + "locationName":"launchTemplateId" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template.

", + "locationName":"launchTemplateName" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time launch template was created.

", + "locationName":"createTime" + }, + "CreatedBy":{ + "shape":"String", + "documentation":"

The principal that created the launch template.

", + "locationName":"createdBy" + }, + "DefaultVersionNumber":{ + "shape":"Long", + "documentation":"

The version number of the default version of the launch template.

", + "locationName":"defaultVersionNumber" + }, + "LatestVersionNumber":{ + "shape":"Long", + "documentation":"

The version number of the latest version of the launch template.

", + "locationName":"latestVersionNumber" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the launch template.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a launch template.

" + }, + "LaunchTemplateAndOverridesResponse":{ + "type":"structure", + "members":{ + "LaunchTemplateSpecification":{ + "shape":"FleetLaunchTemplateSpecification", + "documentation":"

The launch template.

", + "locationName":"launchTemplateSpecification" + }, + "Overrides":{ + "shape":"FleetLaunchTemplateOverrides", + "documentation":"

Any parameters that you specify override the same parameters in the launch template.

", + "locationName":"overrides" + } + }, + "documentation":"

Describes a launch template and overrides.

" + }, + "LaunchTemplateBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"deviceName" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN).

", + "locationName":"virtualName" + }, + "Ebs":{ + "shape":"LaunchTemplateEbsBlockDevice", + "documentation":"

Information about the block device for an EBS volume.

", + "locationName":"ebs" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

", + "locationName":"noDevice" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "LaunchTemplateBlockDeviceMappingList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateBlockDeviceMapping", + "locationName":"item" + } + }, + "LaunchTemplateBlockDeviceMappingRequest":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

" + }, + "Ebs":{ + "shape":"LaunchTemplateEbsBlockDeviceRequest", + "documentation":"

Parameters used to automatically set up EBS volumes when the instance is launched.

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" + } + }, + "documentation":"

Describes a block device mapping.

" + }, + "LaunchTemplateBlockDeviceMappingRequestList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateBlockDeviceMappingRequest", + "locationName":"BlockDeviceMapping" + } + }, + "LaunchTemplateCapacityReservationSpecificationRequest":{ + "type":"structure", + "members":{ + "CapacityReservationPreference":{ + "shape":"CapacityReservationPreference", + "documentation":"

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

" + }, + "CapacityReservationTarget":{ + "shape":"CapacityReservationTarget", + "documentation":"

Information about the target Capacity Reservation.

" + } + }, + "documentation":"

Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation.

" + }, + "LaunchTemplateCapacityReservationSpecificationResponse":{ + "type":"structure", + "members":{ + "CapacityReservationPreference":{ + "shape":"CapacityReservationPreference", + "documentation":"

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

", + "locationName":"capacityReservationPreference" + }, + "CapacityReservationTarget":{ + "shape":"CapacityReservationTargetResponse", + "documentation":"

Information about the target Capacity Reservation.

", + "locationName":"capacityReservationTarget" + } + }, + "documentation":"

Information about the Capacity Reservation targeting option.

" + }, + "LaunchTemplateConfig":{ + "type":"structure", + "members":{ + "LaunchTemplateSpecification":{ + "shape":"FleetLaunchTemplateSpecification", + "documentation":"

The launch template.

", + "locationName":"launchTemplateSpecification" + }, + "Overrides":{ + "shape":"LaunchTemplateOverridesList", + "documentation":"

Any parameters that you specify override the same parameters in the launch template.

", + "locationName":"overrides" + } + }, + "documentation":"

Describes a launch template and overrides.

" + }, + "LaunchTemplateConfigList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateConfig", + "locationName":"item" + } + }, + "LaunchTemplateCpuOptions":{ + "type":"structure", + "members":{ + "CoreCount":{ + "shape":"Integer", + "documentation":"

The number of CPU cores for the instance.

", + "locationName":"coreCount" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"

The number of threads per CPU core.

", + "locationName":"threadsPerCore" + } + }, + "documentation":"

The CPU options for the instance.

" + }, + "LaunchTemplateCpuOptionsRequest":{ + "type":"structure", + "members":{ + "CoreCount":{ + "shape":"Integer", + "documentation":"

The number of CPU cores for the instance.

" + }, + "ThreadsPerCore":{ + "shape":"Integer", + "documentation":"

The number of threads per CPU core. To disable multithreading for the instance, specify a value of 1. Otherwise, specify the default value of 2.

" + } + }, + "documentation":"

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

" + }, + "LaunchTemplateEbsBlockDevice":{ + "type":"structure", + "members":{ + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted.

", + "locationName":"encrypted" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports.

", + "locationName":"iops" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

", + "locationName":"kmsKeyId" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

", + "locationName":"snapshotId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type.

", + "locationName":"volumeType" + } + }, + "documentation":"

Describes a block device for an EBS volume.

" + }, + "LaunchTemplateEbsBlockDeviceRequest":{ + "type":"structure", + "members":{ + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ARN of the AWS Key Management Service (AWS KMS) CMK used for encryption.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type.

" + } + }, + "documentation":"

The parameters for a block device for an EBS volume.

" + }, + "LaunchTemplateElasticInferenceAccelerator":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

" + } + }, + "documentation":"

Describes an elastic inference accelerator.

" + }, + "LaunchTemplateElasticInferenceAcceleratorList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateElasticInferenceAccelerator", + "locationName":"item" + } + }, + "LaunchTemplateElasticInferenceAcceleratorResponse":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.

", + "locationName":"type" + } + }, + "documentation":"

Describes an elastic inference accelerator.

" + }, + "LaunchTemplateElasticInferenceAcceleratorResponseList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateElasticInferenceAcceleratorResponse", + "locationName":"item" + } + }, + "LaunchTemplateErrorCode":{ + "type":"string", + "enum":[ + "launchTemplateIdDoesNotExist", + "launchTemplateIdMalformed", + "launchTemplateNameDoesNotExist", + "launchTemplateNameMalformed", + "launchTemplateVersionDoesNotExist", + "unexpectedError" + ] + }, + "LaunchTemplateHibernationOptions":{ + "type":"structure", + "members":{ + "Configured":{ + "shape":"Boolean", + "documentation":"

If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

", + "locationName":"configured" + } + }, + "documentation":"

Indicates whether an instance is configured for hibernation.

" + }, + "LaunchTemplateHibernationOptionsRequest":{ + "type":"structure", + "members":{ + "Configured":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, the instance is enabled for hibernation.

Default: false

" + } + }, + "documentation":"

Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites.

" + }, + "LaunchTemplateIamInstanceProfileSpecification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

", + "locationName":"arn" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

", + "locationName":"name" + } + }, + "documentation":"

Describes an IAM instance profile.

" + }, + "LaunchTemplateIamInstanceProfileSpecificationRequest":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the instance profile.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance profile.

" + } + }, + "documentation":"

An IAM instance profile.

" + }, + "LaunchTemplateId":{"type":"string"}, + "LaunchTemplateInstanceMarketOptions":{ + "type":"structure", + "members":{ + "MarketType":{ + "shape":"MarketType", + "documentation":"

The market type.

", + "locationName":"marketType" + }, + "SpotOptions":{ + "shape":"LaunchTemplateSpotMarketOptions", + "documentation":"

The options for Spot Instances.

", + "locationName":"spotOptions" + } + }, + "documentation":"

The market (purchasing) option for the instances.

" + }, + "LaunchTemplateInstanceMarketOptionsRequest":{ + "type":"structure", + "members":{ + "MarketType":{ + "shape":"MarketType", + "documentation":"

The market type.

" + }, + "SpotOptions":{ + "shape":"LaunchTemplateSpotMarketOptionsRequest", + "documentation":"

The options for Spot Instances.

" + } + }, + "documentation":"

The market (purchasing) option for the instances.

" + }, + "LaunchTemplateInstanceNetworkInterfaceSpecification":{ + "type":"structure", + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to associate a public IPv4 address with eth0 for a new network interface.

", + "locationName":"associatePublicIpAddress" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index for the network interface attachment.

", + "locationName":"deviceIndex" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"groupSet" + }, + "InterfaceType":{ + "shape":"String", + "documentation":"

The type of network interface.

", + "locationName":"interfaceType" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

The number of IPv6 addresses for the network interface.

", + "locationName":"ipv6AddressCount" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"

The IPv6 addresses for the network interface.

", + "locationName":"ipv6AddressesSet" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IPv4 address of the network interface.

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IPv4 addresses.

", + "locationName":"privateIpAddressesSet" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IPv4 addresses for the network interface.

", + "locationName":"secondaryPrivateIpAddressCount" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet for the network interface.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes a network interface.

" + }, + "LaunchTemplateInstanceNetworkInterfaceSpecificationList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateInstanceNetworkInterfaceSpecification", + "locationName":"item" + } + }, + "LaunchTemplateInstanceNetworkInterfaceSpecificationRequest":{ + "type":"structure", + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Associates a public IPv4 address with eth0 for a new network interface.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the network interface.

" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index for the network interface attachment.

" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of one or more security groups.

", + "locationName":"SecurityGroupId" + }, + "InterfaceType":{ + "shape":"String", + "documentation":"

The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

If you are not creating an EFA, specify interface or omit this parameter.

Valid values: interface | efa

" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses.

" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressListRequest", + "documentation":"

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The primary private IPv4 address of the network interface.

" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressSpecificationList", + "documentation":"

One or more private IPv4 addresses.

" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IPv4 addresses to assign to a network interface.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet for the network interface.

" + } + }, + "documentation":"

The parameters for a network interface.

" + }, + "LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateInstanceNetworkInterfaceSpecificationRequest", + "locationName":"InstanceNetworkInterfaceSpecification" + } + }, + "LaunchTemplateLicenseConfiguration":{ + "type":"structure", + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the license configuration.

", + "locationName":"licenseConfigurationArn" + } + }, + "documentation":"

Describes a license configuration.

" + }, + "LaunchTemplateLicenseConfigurationRequest":{ + "type":"structure", + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the license configuration.

" + } + }, + "documentation":"

Describes a license configuration.

" + }, + "LaunchTemplateLicenseList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateLicenseConfiguration", + "locationName":"item" + } + }, + "LaunchTemplateLicenseSpecificationListRequest":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateLicenseConfigurationRequest", + "locationName":"item" + } + }, + "LaunchTemplateName":{ + "type":"string", + "max":128, + "min":3, + "pattern":"[a-zA-Z0-9\\(\\)\\.\\-/_]+" + }, + "LaunchTemplateNameStringList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateName", + "locationName":"item" + } + }, + "LaunchTemplateOverrides":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", + "locationName":"spotPrice" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

", + "locationName":"subnetId" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which to launch the instances.

", + "locationName":"availabilityZone" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type.

", + "locationName":"weightedCapacity" + }, + "Priority":{ + "shape":"Double", + "documentation":"

The priority for the launch template override. If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity. The highest priority is launched first. Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority.

", + "locationName":"priority" + } + }, + "documentation":"

Describes overrides for a launch template.

" + }, + "LaunchTemplateOverridesList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateOverrides", + "locationName":"item" + } + }, + "LaunchTemplatePlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

", + "locationName":"availabilityZone" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for the instance on the Dedicated Host.

", + "locationName":"affinity" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group for the instance.

", + "locationName":"groupName" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host for the instance.

", + "locationName":"hostId" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

", + "locationName":"tenancy" + }, + "SpreadDomain":{ + "shape":"String", + "documentation":"

Reserved for future use.

", + "locationName":"spreadDomain" + } + }, + "documentation":"

Describes the placement of an instance.

" + }, + "LaunchTemplatePlacementRequest":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the instance.

" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for an instance on a Dedicated Host.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group for the instance.

" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host for the instance.

" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.

" + }, + "SpreadDomain":{ + "shape":"String", + "documentation":"

Reserved for future use.

" + } + }, + "documentation":"

Describes the placement of an instance.

" + }, + "LaunchTemplateSet":{ + "type":"list", + "member":{ + "shape":"LaunchTemplate", + "locationName":"item" + } + }, + "LaunchTemplateSpecification":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

" + }, + "LaunchTemplateName":{ + "shape":"String", + "documentation":"

The name of the launch template.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version number of the launch template.

Default: The default version for the launch template.

" + } + }, + "documentation":"

The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.

" + }, + "LaunchTemplateSpotMarketOptions":{ + "type":"structure", + "members":{ + "MaxPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price you're willing to pay for the Spot Instances.

", + "locationName":"maxPrice" + }, + "SpotInstanceType":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

", + "locationName":"spotInstanceType" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

", + "locationName":"blockDurationMinutes" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.

", + "locationName":"validUntil" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted.

", + "locationName":"instanceInterruptionBehavior" + } + }, + "documentation":"

The options for Spot Instances.

" + }, + "LaunchTemplateSpotMarketOptionsRequest":{ + "type":"structure", + "members":{ + "MaxPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price you're willing to pay for the Spot Instances.

" + }, + "SpotInstanceType":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + }, + "documentation":"

The options for Spot Instances.

" + }, + "LaunchTemplateTagSpecification":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource.

", + "locationName":"resourceType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the resource.

", + "locationName":"tagSet" + } + }, + "documentation":"

The tag specification for the launch template.

" + }, + "LaunchTemplateTagSpecificationList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateTagSpecification", + "locationName":"item" + } + }, + "LaunchTemplateTagSpecificationRequest":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to apply to the resource.

", + "locationName":"Tag" + } + }, + "documentation":"

The tags specification for the launch template.

" + }, + "LaunchTemplateTagSpecificationRequestList":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateTagSpecificationRequest", + "locationName":"LaunchTemplateTagSpecificationRequest" + } + }, + "LaunchTemplateVersion":{ + "type":"structure", + "members":{ + "LaunchTemplateId":{ + "shape":"String", + "documentation":"

The ID of the launch template.

", + "locationName":"launchTemplateId" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template.

", + "locationName":"launchTemplateName" + }, + "VersionNumber":{ + "shape":"Long", + "documentation":"

The version number.

", + "locationName":"versionNumber" + }, + "VersionDescription":{ + "shape":"VersionDescription", + "documentation":"

The description for the version.

", + "locationName":"versionDescription" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time the version was created.

", + "locationName":"createTime" + }, + "CreatedBy":{ + "shape":"String", + "documentation":"

The principal that created the version.

", + "locationName":"createdBy" + }, + "DefaultVersion":{ + "shape":"Boolean", + "documentation":"

Indicates whether the version is the default version.

", + "locationName":"defaultVersion" + }, + "LaunchTemplateData":{ + "shape":"ResponseLaunchTemplateData", + "documentation":"

Information about the launch template.

", + "locationName":"launchTemplateData" + } + }, + "documentation":"

Describes a launch template version.

" + }, + "LaunchTemplateVersionSet":{ + "type":"list", + "member":{ + "shape":"LaunchTemplateVersion", + "locationName":"item" + } + }, + "LaunchTemplatesMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "LaunchTemplatesMonitoringRequest":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specify true to enable detailed monitoring. Otherwise, basic monitoring is enabled.

" + } + }, + "documentation":"

Describes the monitoring for the instance.

" + }, + "LicenseConfiguration":{ + "type":"structure", + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the license configuration.

", + "locationName":"licenseConfigurationArn" + } + }, + "documentation":"

Describes a license configuration.

" + }, + "LicenseConfigurationRequest":{ + "type":"structure", + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the license configuration.

" + } + }, + "documentation":"

Describes a license configuration.

" + }, + "LicenseList":{ + "type":"list", + "member":{ + "shape":"LicenseConfiguration", + "locationName":"item" + } + }, + "LicenseSpecificationListRequest":{ + "type":"list", + "member":{ + "shape":"LicenseConfigurationRequest", + "locationName":"item" + } + }, + "ListingState":{ + "type":"string", + "enum":[ + "available", + "sold", + "cancelled", + "pending" + ] + }, + "ListingStatus":{ + "type":"string", + "enum":[ + "active", + "pending", + "cancelled", + "closed" + ] + }, + "LoadBalancersConfig":{ + "type":"structure", + "members":{ + "ClassicLoadBalancersConfig":{ + "shape":"ClassicLoadBalancersConfig", + "documentation":"

The Classic Load Balancers.

", + "locationName":"classicLoadBalancersConfig" + }, + "TargetGroupsConfig":{ + "shape":"TargetGroupsConfig", + "documentation":"

The target groups.

", + "locationName":"targetGroupsConfig" + } + }, + "documentation":"

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.

" + }, + "LoadPermission":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"userId" + }, + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

", + "locationName":"group" + } + }, + "documentation":"

Describes a load permission.

" + }, + "LoadPermissionList":{ + "type":"list", + "member":{ + "shape":"LoadPermission", + "locationName":"item" + } + }, + "LoadPermissionListRequest":{ + "type":"list", + "member":{ + "shape":"LoadPermissionRequest", + "locationName":"item" + } + }, + "LoadPermissionModifications":{ + "type":"structure", + "members":{ + "Add":{ + "shape":"LoadPermissionListRequest", + "documentation":"

The load permissions to add.

" + }, + "Remove":{ + "shape":"LoadPermissionListRequest", + "documentation":"

The load permissions to remove.

" + } + }, + "documentation":"

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

" + }, + "LoadPermissionRequest":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"PermissionGroup", + "documentation":"

The name of the group.

" + }, + "UserId":{ + "shape":"String", + "documentation":"

The AWS account ID.

" + } + }, + "documentation":"

Describes a load permission.

" + }, + "LogDestinationType":{ + "type":"string", + "enum":[ + "cloud-watch-logs", + "s3" + ] + }, + "Long":{"type":"long"}, + "MarketType":{ + "type":"string", + "enum":["spot"] + }, + "MillisecondDateTime":{"type":"timestamp"}, + "ModifyCapacityReservationRequest":{ + "type":"structure", + "required":["CapacityReservationId"], + "members":{ + "CapacityReservationId":{ + "shape":"CapacityReservationId", + "documentation":"

The ID of the Capacity Reservation.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances for which to reserve capacity.

" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.

The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

" + }, + "EndDateType":{ + "shape":"EndDateType", + "documentation":"

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

  • unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.

  • limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyCapacityReservationResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyClientVpnEndpointRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint to modify.

" + }, + "ServerCertificateArn":{ + "shape":"String", + "documentation":"

The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).

" + }, + "ConnectionLogOptions":{ + "shape":"ConnectionLogOptions", + "documentation":"

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

  • Client connection requests

  • Client connection results (successful and unsuccessful)

  • Reasons for unsuccessful client connection requests

  • Client connection termination time

" + }, + "DnsServers":{ + "shape":"DnsServersOptionsModifyStructure", + "documentation":"

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A brief description of the Client VPN endpoint.

" + }, + "SplitTunnel":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyClientVpnEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyEbsDefaultKmsKeyIdRequest":{ + "type":"structure", + "required":["KmsKeyId"], + "members":{ + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

  • Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias. For example, alias/ExampleAlias.

  • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

  • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyEbsDefaultKmsKeyIdResult":{ + "type":"structure", + "members":{ + "KmsKeyId":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the default CMK for encryption by default.

", + "locationName":"kmsKeyId" + } + } + }, + "ModifyFleetRequest":{ + "type":"structure", + "required":[ + "FleetId", + "TargetCapacitySpecification" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"FleetExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

" + }, + "FleetId":{ + "shape":"FleetIdentifier", + "documentation":"

The ID of the EC2 Fleet.

" + }, + "TargetCapacitySpecification":{ + "shape":"TargetCapacitySpecificationRequest", + "documentation":"

The size of the EC2 Fleet.

" + } + } + }, + "ModifyFleetResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + } + }, + "ModifyFpgaImageAttributeRequest":{ + "type":"structure", + "required":["FpgaImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId":{ + "shape":"FpgaImageId", + "documentation":"

The ID of the AFI.

" + }, + "Attribute":{ + "shape":"FpgaImageAttributeName", + "documentation":"

The name of the attribute.

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

The operation type.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.

", + "locationName":"UserId" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

The user groups. This parameter is valid only when modifying the loadPermission attribute.

", + "locationName":"UserGroup" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the productCodes attribute.

", + "locationName":"ProductCode" + }, + "LoadPermission":{ + "shape":"LoadPermissionModifications", + "documentation":"

The load permission for the AFI.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the AFI.

" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for the AFI.

" + } + } + }, + "ModifyFpgaImageAttributeResult":{ + "type":"structure", + "members":{ + "FpgaImageAttribute":{ + "shape":"FpgaImageAttribute", + "documentation":"

Information about the attribute.

", + "locationName":"fpgaImageAttribute" + } + } + }, + "ModifyHostsRequest":{ + "type":"structure", + "required":["HostIds"], + "members":{ + "AutoPlacement":{ + "shape":"AutoPlacement", + "documentation":"

Specify whether to enable or disable auto-placement.

", + "locationName":"autoPlacement" + }, + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts to modify.

", + "locationName":"hostId" + }, + "HostRecovery":{ + "shape":"HostRecovery", + "documentation":"

Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide.

" + } + } + }, + "ModifyHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully modified.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.

", + "locationName":"unsuccessful" + } + } + }, + "ModifyIdFormatRequest":{ + "type":"structure", + "required":[ + "Resource", + "UseLongIds" + ], + "members":{ + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicate whether the resource should use longer IDs (17-character IDs).

" + } + } + }, + "ModifyIdentityIdFormatRequest":{ + "type":"structure", + "required":[ + "PrincipalArn", + "Resource", + "UseLongIds" + ], + "members":{ + "PrincipalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify all to modify the ID format for all IAM users, IAM roles, and the root user of the account.

", + "locationName":"principalArn" + }, + "Resource":{ + "shape":"String", + "documentation":"

The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.

Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.

", + "locationName":"resource" + }, + "UseLongIds":{ + "shape":"Boolean", + "documentation":"

Indicates whether the resource should use longer IDs (17-character IDs)

", + "locationName":"useLongIds" + } + } + }, + "ModifyImageAttributeRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "Attribute":{ + "shape":"String", + "documentation":"

The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.

" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A new description for the AMI.

" + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

The ID of the AMI.

" + }, + "LaunchPermission":{ + "shape":"LaunchPermissionModifications", + "documentation":"

A new launch permission for the AMI.

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

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

" + }, + "ProductCodes":{ + "shape":"ProductCodeStringList", + "documentation":"

The DevPay product codes. After you add a product code to an AMI, it can't be removed.

", + "locationName":"ProductCode" + }, + "UserGroups":{ + "shape":"UserGroupStringList", + "documentation":"

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

", + "locationName":"UserGroup" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

", + "locationName":"UserId" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for ModifyImageAttribute.

" + }, + "ModifyInstanceAttributeRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means that checking is disabled. This value must be false for a NAT instance to perform NAT.

" + }, + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The name of the attribute.

", + "locationName":"attribute" + }, + "BlockDeviceMappings":{ + "shape":"InstanceBlockDeviceMappingSpecificationList", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"blockDeviceMapping" + }, + "DisableApiTermination":{ + "shape":"AttributeBooleanValue", + "documentation":"

If the value is true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.

", + "locationName":"disableApiTermination" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EbsOptimized":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

", + "locationName":"ebsOptimized" + }, + "EnaSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Set to true to enable enhanced networking with ENA for the instance.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"enaSupport" + }, + "Groups":{ + "shape":"GroupIdStringList", + "documentation":"

[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.

", + "locationName":"GroupId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"AttributeValue", + "documentation":"

Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "InstanceType":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "locationName":"instanceType" + }, + "Kernel":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"kernel" + }, + "Ramdisk":{ + "shape":"AttributeValue", + "documentation":"

Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.

", + "locationName":"ramdisk" + }, + "SriovNetSupport":{ + "shape":"AttributeValue", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.

There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.

This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.

", + "locationName":"sriovNetSupport" + }, + "UserData":{ + "shape":"BlobAttributeValue", + "documentation":"

Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.

", + "locationName":"userData" + }, + "Value":{ + "shape":"String", + "documentation":"

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

", + "locationName":"value" + } + } + }, + "ModifyInstanceCapacityReservationAttributesRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "CapacityReservationSpecification" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance to be modified.

" + }, + "CapacityReservationSpecification":{ + "shape":"CapacityReservationSpecification", + "documentation":"

Information about the Capacity Reservation targeting option.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyInstanceCapacityReservationAttributesResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyInstanceCreditSpecificationRequest":{ + "type":"structure", + "required":["InstanceCreditSpecifications"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

" + }, + "InstanceCreditSpecifications":{ + "shape":"InstanceCreditSpecificationListRequest", + "documentation":"

Information about the credit option for CPU usage.

", + "locationName":"InstanceCreditSpecification" + } + } + }, + "ModifyInstanceCreditSpecificationResult":{ + "type":"structure", + "members":{ + "SuccessfulInstanceCreditSpecifications":{ + "shape":"SuccessfulInstanceCreditSpecificationSet", + "documentation":"

Information about the instances whose credit option for CPU usage was successfully modified.

", + "locationName":"successfulInstanceCreditSpecificationSet" + }, + "UnsuccessfulInstanceCreditSpecifications":{ + "shape":"UnsuccessfulInstanceCreditSpecificationSet", + "documentation":"

Information about the instances whose credit option for CPU usage was not modified.

", + "locationName":"unsuccessfulInstanceCreditSpecificationSet" + } + } + }, + "ModifyInstanceEventStartTimeRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "InstanceEventId", + "NotBefore" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance with the scheduled event.

" + }, + "InstanceEventId":{ + "shape":"String", + "documentation":"

The ID of the event whose date and time you are modifying.

" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The new date and time when the event will take place.

" + } + } + }, + "ModifyInstanceEventStartTimeResult":{ + "type":"structure", + "members":{ + "Event":{ + "shape":"InstanceStatusEvent", + "locationName":"event" + } + } + }, + "ModifyInstancePlacementRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "Affinity":{ + "shape":"Affinity", + "documentation":"

The affinity setting for the instance.

", + "locationName":"affinity" + }, + "GroupName":{ + "shape":"PlacementGroupName", + "documentation":"

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string (\"\").

" + }, + "HostId":{ + "shape":"HostId", + "documentation":"

The ID of the Dedicated Host with which to associate the instance.

", + "locationName":"hostId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance that you are modifying.

", + "locationName":"instanceId" + }, + "Tenancy":{ + "shape":"HostTenancy", + "documentation":"

The tenancy for the instance.

", + "locationName":"tenancy" + }, + "PartitionNumber":{ + "shape":"Integer", + "documentation":"

Reserved for future use.

" + } + } + }, + "ModifyInstancePlacementResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + } + }, + "ModifyLaunchTemplateRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

" + }, + "LaunchTemplateId":{ + "shape":"LaunchTemplateId", + "documentation":"

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "LaunchTemplateName":{ + "shape":"LaunchTemplateName", + "documentation":"

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

" + }, + "DefaultVersion":{ + "shape":"String", + "documentation":"

The version number of the launch template to set as the default version.

", + "locationName":"SetDefaultVersion" + } + } + }, + "ModifyLaunchTemplateResult":{ + "type":"structure", + "members":{ + "LaunchTemplate":{ + "shape":"LaunchTemplate", + "documentation":"

Information about the launch template.

", + "locationName":"launchTemplate" + } + } + }, + "ModifyNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "Attachment":{ + "shape":"NetworkInterfaceAttachmentChanges", + "documentation":"

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

", + "locationName":"attachment" + }, + "Description":{ + "shape":"AttributeValue", + "documentation":"

A description for the network interface.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Groups":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.

", + "locationName":"SecurityGroupId" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT. For more information, see NAT Instances in the Amazon Virtual Private Cloud User Guide.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the parameters for ModifyNetworkInterfaceAttribute.

" + }, + "ModifyReservedInstancesRequest":{ + "type":"structure", + "required":[ + "ReservedInstancesIds", + "TargetConfigurations" + ], + "members":{ + "ReservedInstancesIds":{ + "shape":"ReservedInstancesIdStringList", + "documentation":"

The IDs of the Reserved Instances to modify.

", + "locationName":"ReservedInstancesId" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "TargetConfigurations":{ + "shape":"ReservedInstancesConfigurationList", + "documentation":"

The configuration settings for the Reserved Instances to modify.

", + "locationName":"ReservedInstancesConfigurationSetItemType" + } + }, + "documentation":"

Contains the parameters for ModifyReservedInstances.

" + }, + "ModifyReservedInstancesResult":{ + "type":"structure", + "members":{ + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

The ID for the modification.

", + "locationName":"reservedInstancesModificationId" + } + }, + "documentation":"

Contains the output of ModifyReservedInstances.

" + }, + "ModifySnapshotAttributeRequest":{ + "type":"structure", + "required":["SnapshotId"], + "members":{ + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The snapshot attribute to modify. Only volume creation permissions can be modified.

" + }, + "CreateVolumePermission":{ + "shape":"CreateVolumePermissionModifications", + "documentation":"

A JSON representation of the snapshot attribute modification.

" + }, + "GroupNames":{ + "shape":"GroupNameStringList", + "documentation":"

The group to modify for the snapshot.

", + "locationName":"UserGroup" + }, + "OperationType":{ + "shape":"OperationType", + "documentation":"

The type of operation to perform to the attribute.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the snapshot.

" + }, + "UserIds":{ + "shape":"UserIdStringList", + "documentation":"

The account ID to modify for the snapshot.

", + "locationName":"UserId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for ModifySnapshotAttribute.

" + }, + "ModifySpotFleetRequestRequest":{ + "type":"structure", + "required":["SpotFleetRequestId"], + "members":{ + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "SpotFleetRequestId":{ + "shape":"SpotFleetRequestId", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The size of the fleet.

", + "locationName":"targetCapacity" + }, + "OnDemandTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of On-Demand Instances in the fleet.

" + } + }, + "documentation":"

Contains the parameters for ModifySpotFleetRequest.

" + }, + "ModifySpotFleetRequestResponse":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + }, + "documentation":"

Contains the output of ModifySpotFleetRequest.

" + }, + "ModifySubnetAttributeRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "AssignIpv6AddressOnCreation":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address).

If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version 2016-11-15 or later of the Amazon EC2 API.

" + }, + "MapPublicIpOnLaunch":{ + "shape":"AttributeBooleanValue", + "documentation":"

Specify true to indicate that ENIs attached to instances created in the specified subnet should be assigned a public IPv4 address.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + } + }, + "ModifyTrafficMirrorFilterNetworkServicesRequest":{ + "type":"structure", + "required":["TrafficMirrorFilterId"], + "members":{ + "TrafficMirrorFilterId":{ + "shape":"TrafficMirrorFilterId", + "documentation":"

The ID of the Traffic Mirror filter.

" + }, + "AddNetworkServices":{ + "shape":"TrafficMirrorNetworkServiceList", + "documentation":"

The network service, for example Amazon DNS, that you want to mirror.

", + "locationName":"AddNetworkService" + }, + "RemoveNetworkServices":{ + "shape":"TrafficMirrorNetworkServiceList", + "documentation":"

The network service, for example Amazon DNS, that you no longer want to mirror.

", + "locationName":"RemoveNetworkService" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyTrafficMirrorFilterNetworkServicesResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilter":{ + "shape":"TrafficMirrorFilter", + "documentation":"

The Traffic Mirror filter that the network service is associated with.

", + "locationName":"trafficMirrorFilter" + } + } + }, + "ModifyTrafficMirrorFilterRuleRequest":{ + "type":"structure", + "required":["TrafficMirrorFilterRuleId"], + "members":{ + "TrafficMirrorFilterRuleId":{ + "shape":"TrafficMirrorFilterRuleId", + "documentation":"

The ID of the Traffic Mirror rule.

" + }, + "TrafficDirection":{ + "shape":"TrafficDirection", + "documentation":"

The type of traffic (ingress | egress) to assign to the rule.

" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

" + }, + "RuleAction":{ + "shape":"TrafficMirrorRuleAction", + "documentation":"

The action to assign to the rule.

" + }, + "DestinationPortRange":{ + "shape":"TrafficMirrorPortRangeRequest", + "documentation":"

The destination ports that are associated with the Traffic Mirror rule.

" + }, + "SourcePortRange":{ + "shape":"TrafficMirrorPortRangeRequest", + "documentation":"

The port range to assign to the Traffic Mirror rule.

" + }, + "Protocol":{ + "shape":"Integer", + "documentation":"

The protocol, for example TCP, to assign to the Traffic Mirror rule.

" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The destination CIDR block to assign to the Traffic Mirror rule.

" + }, + "SourceCidrBlock":{ + "shape":"String", + "documentation":"

The source CIDR block to assign to the Traffic Mirror rule.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to assign to the Traffic Mirror rule.

" + }, + "RemoveFields":{ + "shape":"TrafficMirrorFilterRuleFieldList", + "documentation":"

The properties that you want to remove from the Traffic Mirror filter rule.

When you remove a property from a Traffic Mirror filter rule, the property is set to the default.

", + "locationName":"RemoveField" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyTrafficMirrorFilterRuleResult":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterRule":{ + "shape":"TrafficMirrorFilterRule", + "documentation":"

Modifies a Traffic Mirror rule.

", + "locationName":"trafficMirrorFilterRule" + } + } + }, + "ModifyTrafficMirrorSessionRequest":{ + "type":"structure", + "required":["TrafficMirrorSessionId"], + "members":{ + "TrafficMirrorSessionId":{ + "shape":"TrafficMirrorSessionId", + "documentation":"

The ID of the Traffic Mirror session.

" + }, + "TrafficMirrorTargetId":{ + "shape":"TrafficMirrorTargetId", + "documentation":"

The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.

" + }, + "TrafficMirrorFilterId":{ + "shape":"TrafficMirrorFilterId", + "documentation":"

The ID of the Traffic Mirror filter.

" + }, + "PacketLength":{ + "shape":"Integer", + "documentation":"

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.

" + }, + "SessionNumber":{ + "shape":"Integer", + "documentation":"

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

" + }, + "VirtualNetworkId":{ + "shape":"Integer", + "documentation":"

The virtual network ID of the Traffic Mirror session.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description to assign to the Traffic Mirror session.

" + }, + "RemoveFields":{ + "shape":"TrafficMirrorSessionFieldList", + "documentation":"

The properties that you want to remove from the Traffic Mirror session.

When you remove a property from a Traffic Mirror session, the property is set to the default.

", + "locationName":"RemoveField" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyTrafficMirrorSessionResult":{ + "type":"structure", + "members":{ + "TrafficMirrorSession":{ + "shape":"TrafficMirrorSession", + "documentation":"

Information about the Traffic Mirror session.

", + "locationName":"trafficMirrorSession" + } + } + }, + "ModifyTransitGatewayVpcAttachmentRequest":{ + "type":"structure", + "required":["TransitGatewayAttachmentId"], + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "AddSubnetIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.

" + }, + "RemoveSubnetIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more subnets to remove.

" + }, + "Options":{ + "shape":"ModifyTransitGatewayVpcAttachmentRequestOptions", + "documentation":"

The new VPC attachment options.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyTransitGatewayVpcAttachmentRequestOptions":{ + "type":"structure", + "members":{ + "DnsSupport":{ + "shape":"DnsSupportValue", + "documentation":"

Enable or disable DNS support. The default is enable.

" + }, + "Ipv6Support":{ + "shape":"Ipv6SupportValue", + "documentation":"

Enable or disable IPv6 support. The default is enable.

" + } + }, + "documentation":"

Describes the options for a VPC attachment.

" + }, + "ModifyTransitGatewayVpcAttachmentResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachment":{ + "shape":"TransitGatewayVpcAttachment", + "documentation":"

Information about the modified attachment.

", + "locationName":"transitGatewayVpcAttachment" + } + } + }, + "ModifyVolumeAttributeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "AutoEnableIO":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the volume should be auto-enabled for I/O operations.

" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the volume.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for ModifyVolumeAttribute.

" + }, + "ModifyVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

The ID of the volume.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types.

Default: If no size is specified, the existing size is retained.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The target EBS volume type of the volume.

Default: If no type is specified, the existing type is retained.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The target IOPS rate of the volume.

This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes.

Default: If no IOPS value is specified, the existing value is retained.

" + } + } + }, + "ModifyVolumeResult":{ + "type":"structure", + "members":{ + "VolumeModification":{ + "shape":"VolumeModification", + "documentation":"

Information about the volume modification.

", + "locationName":"volumeModification" + } + } + }, + "ModifyVpcAttributeRequest":{ + "type":"structure", + "required":["VpcId"], + "members":{ + "EnableDnsHostnames":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support.

" + }, + "EnableDnsSupport":{ + "shape":"AttributeBooleanValue", + "documentation":"

Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range \"plus two\" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.

You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + } + }, + "ModifyVpcEndpointConnectionNotificationRequest":{ + "type":"structure", + "required":["ConnectionNotificationId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ConnectionNotificationId":{ + "shape":"ConnectionNotificationId", + "documentation":"

The ID of the notification.

" + }, + "ConnectionNotificationArn":{ + "shape":"String", + "documentation":"

The ARN for the SNS topic for the notification.

" + }, + "ConnectionEvents":{ + "shape":"ValueStringList", + "documentation":"

One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.

" + } + } + }, + "ModifyVpcEndpointConnectionNotificationResult":{ + "type":"structure", + "members":{ + "ReturnValue":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyVpcEndpointRequest":{ + "type":"structure", + "required":["VpcEndpointId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"

The ID of the endpoint.

" + }, + "ResetPolicy":{ + "shape":"Boolean", + "documentation":"

(Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.

" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.

" + }, + "AddRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

(Gateway endpoint) One or more route tables IDs to associate with the endpoint.

", + "locationName":"AddRouteTableId" + }, + "RemoveRouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

(Gateway endpoint) One or more route table IDs to disassociate from the endpoint.

", + "locationName":"RemoveRouteTableId" + }, + "AddSubnetIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more subnet IDs in which to serve the endpoint.

", + "locationName":"AddSubnetId" + }, + "RemoveSubnetIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more subnets IDs in which to remove the endpoint.

", + "locationName":"RemoveSubnetId" + }, + "AddSecurityGroupIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more security group IDs to associate with the network interface.

", + "locationName":"AddSecurityGroupId" + }, + "RemoveSecurityGroupIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more security group IDs to disassociate from the network interface.

", + "locationName":"RemoveSecurityGroupId" + }, + "PrivateDnsEnabled":{ + "shape":"Boolean", + "documentation":"

(Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.

" + } + }, + "documentation":"

Contains the parameters for ModifyVpcEndpoint.

" + }, + "ModifyVpcEndpointResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyVpcEndpointServiceConfigurationRequest":{ + "type":"structure", + "required":["ServiceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"ServiceId", + "documentation":"

The ID of the service.

" + }, + "AcceptanceRequired":{ + "shape":"Boolean", + "documentation":"

Indicate whether requests to create an endpoint to your service must be accepted.

" + }, + "AddNetworkLoadBalancerArns":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.

", + "locationName":"AddNetworkLoadBalancerArn" + }, + "RemoveNetworkLoadBalancerArns":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.

", + "locationName":"RemoveNetworkLoadBalancerArn" + } + } + }, + "ModifyVpcEndpointServiceConfigurationResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyVpcEndpointServicePermissionsRequest":{ + "type":"structure", + "required":["ServiceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the service.

" + }, + "AddAllowedPrincipals":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).

" + }, + "RemoveAllowedPrincipals":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.

" + } + } + }, + "ModifyVpcEndpointServicePermissionsResult":{ + "type":"structure", + "members":{ + "ReturnValue":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ModifyVpcPeeringConnectionOptionsRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the accepter VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptionsRequest", + "documentation":"

The VPC peering connection options for the requester VPC.

" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of the VPC peering connection.

" + } + } + }, + "ModifyVpcPeeringConnectionOptionsResult":{ + "type":"structure", + "members":{ + "AccepterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the accepter VPC.

", + "locationName":"accepterPeeringConnectionOptions" + }, + "RequesterPeeringConnectionOptions":{ + "shape":"PeeringConnectionOptions", + "documentation":"

Information about the VPC peering connection options for the requester VPC.

", + "locationName":"requesterPeeringConnectionOptions" + } + } + }, + "ModifyVpcTenancyRequest":{ + "type":"structure", + "required":[ + "VpcId", + "InstanceTenancy" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + }, + "InstanceTenancy":{ + "shape":"VpcTenancy", + "documentation":"

The instance tenancy attribute for the VPC.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyVpcTenancyResult":{ + "type":"structure", + "members":{ + "ReturnValue":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, returns an error.

", + "locationName":"return" + } + } + }, + "ModifyVpnConnectionRequest":{ + "type":"structure", + "required":["VpnConnectionId"], + "members":{ + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the VPN connection.

" + }, + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of the transit gateway.

" + }, + "CustomerGatewayId":{ + "shape":"CustomerGatewayId", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

" + }, + "VpnGatewayId":{ + "shape":"VpnGatewayId", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyVpnConnectionResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "locationName":"vpnConnection" + } + } + }, + "ModifyVpnTunnelCertificateRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "VpnTunnelOutsideIpAddress" + ], + "members":{ + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the AWS Site-to-Site VPN connection.

" + }, + "VpnTunnelOutsideIpAddress":{ + "shape":"String", + "documentation":"

The external IP address of the VPN tunnel.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyVpnTunnelCertificateResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "locationName":"vpnConnection" + } + } + }, + "ModifyVpnTunnelOptionsRequest":{ + "type":"structure", + "required":[ + "VpnConnectionId", + "VpnTunnelOutsideIpAddress", + "TunnelOptions" + ], + "members":{ + "VpnConnectionId":{ + "shape":"VpnConnectionId", + "documentation":"

The ID of the AWS Site-to-Site VPN connection.

" + }, + "VpnTunnelOutsideIpAddress":{ + "shape":"String", + "documentation":"

The external IP address of the VPN tunnel.

" + }, + "TunnelOptions":{ + "shape":"ModifyVpnTunnelOptionsSpecification", + "documentation":"

The tunnel options to modify.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ModifyVpnTunnelOptionsResult":{ + "type":"structure", + "members":{ + "VpnConnection":{ + "shape":"VpnConnection", + "locationName":"vpnConnection" + } + } + }, + "ModifyVpnTunnelOptionsSpecification":{ + "type":"structure", + "members":{ + "TunnelInsideCidr":{ + "shape":"String", + "documentation":"

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:

  • 169.254.0.0/30

  • 169.254.1.0/30

  • 169.254.2.0/30

  • 169.254.3.0/30

  • 169.254.4.0/30

  • 169.254.5.0/30

  • 169.254.169.252/30

" + }, + "PreSharedKey":{ + "shape":"String", + "documentation":"

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.

Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).

" + }, + "Phase1LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 1 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 28,800.

Default: 28800

" + }, + "Phase2LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 2 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

Default: 3600

" + }, + "RekeyMarginTimeSeconds":{ + "shape":"Integer", + "documentation":"

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

Default: 540

" + }, + "RekeyFuzzPercentage":{ + "shape":"Integer", + "documentation":"

The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

Constraints: A value between 0 and 100.

Default: 100

" + }, + "ReplayWindowSize":{ + "shape":"Integer", + "documentation":"

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

" + }, + "DPDTimeoutSeconds":{ + "shape":"Integer", + "documentation":"

The number of seconds after which a DPD timeout occurs.

Constraints: A value between 0 and 30.

Default: 30

" + }, + "Phase1EncryptionAlgorithms":{ + "shape":"Phase1EncryptionAlgorithmsRequestList", + "documentation":"

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256

", + "locationName":"Phase1EncryptionAlgorithm" + }, + "Phase2EncryptionAlgorithms":{ + "shape":"Phase2EncryptionAlgorithmsRequestList", + "documentation":"

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256

", + "locationName":"Phase2EncryptionAlgorithm" + }, + "Phase1IntegrityAlgorithms":{ + "shape":"Phase1IntegrityAlgorithmsRequestList", + "documentation":"

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256

", + "locationName":"Phase1IntegrityAlgorithm" + }, + "Phase2IntegrityAlgorithms":{ + "shape":"Phase2IntegrityAlgorithmsRequestList", + "documentation":"

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256

", + "locationName":"Phase2IntegrityAlgorithm" + }, + "Phase1DHGroupNumbers":{ + "shape":"Phase1DHGroupNumbersRequestList", + "documentation":"

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

", + "locationName":"Phase1DHGroupNumber" + }, + "Phase2DHGroupNumbers":{ + "shape":"Phase2DHGroupNumbersRequestList", + "documentation":"

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

", + "locationName":"Phase2DHGroupNumber" + }, + "IKEVersions":{ + "shape":"IKEVersionsRequestList", + "documentation":"

The IKE versions that are permitted for the VPN tunnel.

Valid values: ikev1 | ikev2

", + "locationName":"IKEVersion" + } + }, + "documentation":"

The AWS Site-to-Site VPN tunnel options to modify.

" + }, + "MonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The IDs of the instances.

", + "locationName":"InstanceId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "MonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

The monitoring information.

", + "locationName":"instancesSet" + } + } + }, + "Monitoring":{ + "type":"structure", + "members":{ + "State":{ + "shape":"MonitoringState", + "documentation":"

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

", + "locationName":"state" + } + }, + "documentation":"

Describes the monitoring of an instance.

" + }, + "MonitoringState":{ + "type":"string", + "enum":[ + "disabled", + "disabling", + "enabled", + "pending" + ] + }, + "MoveAddressToVpcRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + } + }, + "MoveAddressToVpcResult":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID for the Elastic IP address.

", + "locationName":"allocationId" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the move of the IP address.

", + "locationName":"status" + } + } + }, + "MoveStatus":{ + "type":"string", + "enum":[ + "movingToVpc", + "restoringToClassic" + ] + }, + "MovingAddressStatus":{ + "type":"structure", + "members":{ + "MoveStatus":{ + "shape":"MoveStatus", + "documentation":"

The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.

", + "locationName":"moveStatus" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + }, + "documentation":"

Describes the status of a moving Elastic IP address.

" + }, + "MovingAddressStatusSet":{ + "type":"list", + "member":{ + "shape":"MovingAddressStatus", + "locationName":"item" + } + }, + "NatGateway":{ + "type":"structure", + "members":{ + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was created.

", + "locationName":"createTime" + }, + "DeleteTime":{ + "shape":"DateTime", + "documentation":"

The date and time the NAT gateway was deleted, if applicable.

", + "locationName":"deleteTime" + }, + "FailureCode":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)

", + "locationName":"failureCode" + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.

  • For InsufficientFreeAddressesInSubnet: \"Subnet has insufficient free addresses to create this NAT gateway\"

  • For Gateway.NotAttached: \"Network vpc-xxxxxxxx has no Internet gateway attached\"

  • For InvalidAllocationID.NotFound: \"Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway\"

  • For Resource.AlreadyAssociated: \"Elastic IP address eipalloc-xxxxxxxx is already associated\"

  • For InternalError: \"Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again.\"

  • For InvalidSubnetID.NotFound: \"The specified subnet subnet-xxxxxxxx does not exist or could not be found.\"

", + "locationName":"failureMessage" + }, + "NatGatewayAddresses":{ + "shape":"NatGatewayAddressList", + "documentation":"

Information about the IP addresses and network interface associated with the NAT gateway.

", + "locationName":"natGatewayAddressSet" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of the NAT gateway.

", + "locationName":"natGatewayId" + }, + "ProvisionedBandwidth":{ + "shape":"ProvisionedBandwidth", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionedBandwidth" + }, + "State":{ + "shape":"NatGatewayState", + "documentation":"

The state of the NAT gateway.

  • pending: The NAT gateway is being created and is not ready to process traffic.

  • failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

  • available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

  • deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

  • deleted: The NAT gateway has been terminated and is no longer processing traffic.

", + "locationName":"state" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which the NAT gateway is located.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the NAT gateway is located.

", + "locationName":"vpcId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the NAT gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a NAT gateway.

" + }, + "NatGatewayAddress":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

", + "locationName":"allocationId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface associated with the NAT gateway.

", + "locationName":"networkInterfaceId" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The private IP address associated with the Elastic IP address.

", + "locationName":"privateIp" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address associated with the NAT gateway.

", + "locationName":"publicIp" + } + }, + "documentation":"

Describes the IP addresses and network interface associated with a NAT gateway.

" + }, + "NatGatewayAddressList":{ + "type":"list", + "member":{ + "shape":"NatGatewayAddress", + "locationName":"item" + } + }, + "NatGatewayId":{"type":"string"}, + "NatGatewayList":{ + "type":"list", + "member":{ + "shape":"NatGateway", + "locationName":"item" + } + }, + "NatGatewayState":{ + "type":"string", + "enum":[ + "pending", + "failed", + "available", + "deleting", + "deleted" + ] + }, + "NetworkAcl":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"NetworkAclAssociationList", + "documentation":"

Any associations between the network ACL and one or more subnets

", + "locationName":"associationSet" + }, + "Entries":{ + "shape":"NetworkAclEntryList", + "documentation":"

One or more entries (rules) in the network ACL.

", + "locationName":"entrySet" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default network ACL for the VPC.

", + "locationName":"default" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network ACL.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the network ACL.

", + "locationName":"vpcId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the network ACL.

", + "locationName":"ownerId" + } + }, + "documentation":"

Describes a network ACL.

" + }, + "NetworkAclAssociation":{ + "type":"structure", + "members":{ + "NetworkAclAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a network ACL and a subnet.

", + "locationName":"networkAclAssociationId" + }, + "NetworkAclId":{ + "shape":"String", + "documentation":"

The ID of the network ACL.

", + "locationName":"networkAclId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a network ACL and a subnet.

" + }, + "NetworkAclAssociationId":{"type":"string"}, + "NetworkAclAssociationList":{ + "type":"list", + "member":{ + "shape":"NetworkAclAssociation", + "locationName":"item" + } + }, + "NetworkAclEntry":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 network range to allow or deny, in CIDR notation.

", + "locationName":"cidrBlock" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

", + "locationName":"egress" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP type and code.

", + "locationName":"icmpTypeCode" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 network range to allow or deny, in CIDR notation.

", + "locationName":"ipv6CidrBlock" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to.

", + "locationName":"portRange" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol number. A value of \"-1\" means all protocols.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number for the entry. ACL entries are processed in ascending order by rule number.

", + "locationName":"ruleNumber" + } + }, + "documentation":"

Describes an entry in a network ACL.

" + }, + "NetworkAclEntryList":{ + "type":"list", + "member":{ + "shape":"NetworkAclEntry", + "locationName":"item" + } + }, + "NetworkAclId":{"type":"string"}, + "NetworkAclList":{ + "type":"list", + "member":{ + "shape":"NetworkAcl", + "locationName":"item" + } + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "locationName":"association" + }, + "Attachment":{ + "shape":"NetworkInterfaceAttachment", + "documentation":"

The network interface attachment.

", + "locationName":"attachment" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "Description":{ + "shape":"String", + "documentation":"

A description.

", + "locationName":"description" + }, + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

Any security groups for the network interface.

", + "locationName":"groupSet" + }, + "InterfaceType":{ + "shape":"NetworkInterfaceType", + "documentation":"

The type of network interface.

", + "locationName":"interfaceType" + }, + "Ipv6Addresses":{ + "shape":"NetworkInterfaceIpv6AddressesList", + "documentation":"

The IPv6 addresses associated with the network interface.

", + "locationName":"ipv6AddressesSet" + }, + "MacAddress":{ + "shape":"String", + "documentation":"

The MAC address.

", + "locationName":"macAddress" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the network interface.

", + "locationName":"ownerId" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IPv4 address of the network interface within the subnet.

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"NetworkInterfacePrivateIpAddressList", + "documentation":"

The private IPv4 addresses associated with the network interface.

", + "locationName":"privateIpAddressesSet" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is being managed by AWS.

", + "locationName":"requesterManaged" + }, + "SourceDestCheck":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic to or from the instance is validated.

", + "locationName":"sourceDestCheck" + }, + "Status":{ + "shape":"NetworkInterfaceStatus", + "documentation":"

The status of the network interface.

", + "locationName":"status" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "TagSet":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the network interface.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a network interface.

" + }, + "NetworkInterfaceAssociation":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"String", + "documentation":"

The allocation ID.

", + "locationName":"allocationId" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "IpOwnerId":{ + "shape":"String", + "documentation":"

The ID of the Elastic IP address owner.

", + "locationName":"ipOwnerId" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name.

", + "locationName":"publicDnsName" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The address of the Elastic IP address bound to the network interface.

", + "locationName":"publicIp" + } + }, + "documentation":"

Describes association information for an Elastic IP address (IPv4 only).

" + }, + "NetworkInterfaceAttachment":{ + "type":"structure", + "members":{ + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The timestamp indicating when the attachment initiated.

", + "locationName":"attachTime" + }, + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The device index of the network interface attachment on the instance.

", + "locationName":"deviceIndex" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "Status":{ + "shape":"AttachmentStatus", + "documentation":"

The attachment state.

", + "locationName":"status" + } + }, + "documentation":"

Describes a network interface attachment.

" + }, + "NetworkInterfaceAttachmentChanges":{ + "type":"structure", + "members":{ + "AttachmentId":{ + "shape":"String", + "documentation":"

The ID of the network interface attachment.

", + "locationName":"attachmentId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the network interface is deleted when the instance is terminated.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes an attachment change.

" + }, + "NetworkInterfaceAttribute":{ + "type":"string", + "enum":[ + "description", + "groupSet", + "sourceDestCheck", + "attachment" + ] + }, + "NetworkInterfaceCreationType":{ + "type":"string", + "enum":["efa"] + }, + "NetworkInterfaceId":{"type":"string"}, + "NetworkInterfaceIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "NetworkInterfaceIpv6Address":{ + "type":"structure", + "members":{ + "Ipv6Address":{ + "shape":"String", + "documentation":"

The IPv6 address.

", + "locationName":"ipv6Address" + } + }, + "documentation":"

Describes an IPv6 address associated with a network interface.

" + }, + "NetworkInterfaceIpv6AddressesList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfaceIpv6Address", + "locationName":"item" + } + }, + "NetworkInterfaceList":{ + "type":"list", + "member":{ + "shape":"NetworkInterface", + "locationName":"item" + } + }, + "NetworkInterfacePermission":{ + "type":"structure", + "members":{ + "NetworkInterfacePermissionId":{ + "shape":"String", + "documentation":"

The ID of the network interface permission.

", + "locationName":"networkInterfacePermissionId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "AwsAccountId":{ + "shape":"String", + "documentation":"

The AWS account ID.

", + "locationName":"awsAccountId" + }, + "AwsService":{ + "shape":"String", + "documentation":"

The AWS service.

", + "locationName":"awsService" + }, + "Permission":{ + "shape":"InterfacePermissionType", + "documentation":"

The type of permission.

", + "locationName":"permission" + }, + "PermissionState":{ + "shape":"NetworkInterfacePermissionState", + "documentation":"

Information about the state of the permission.

", + "locationName":"permissionState" + } + }, + "documentation":"

Describes a permission for a network interface.

" + }, + "NetworkInterfacePermissionIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NetworkInterfacePermissionList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePermission", + "locationName":"item" + } + }, + "NetworkInterfacePermissionState":{ + "type":"structure", + "members":{ + "State":{ + "shape":"NetworkInterfacePermissionStateCode", + "documentation":"

The state of the permission.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A status message, if applicable.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes the state of a network interface permission.

" + }, + "NetworkInterfacePermissionStateCode":{ + "type":"string", + "enum":[ + "pending", + "granted", + "revoking", + "revoked" + ] + }, + "NetworkInterfacePrivateIpAddress":{ + "type":"structure", + "members":{ + "Association":{ + "shape":"NetworkInterfaceAssociation", + "documentation":"

The association information for an Elastic IP address (IPv4) associated with the network interface.

", + "locationName":"association" + }, + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.

", + "locationName":"primary" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IPv4 address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes the private IPv4 address of a network interface.

" + }, + "NetworkInterfacePrivateIpAddressList":{ + "type":"list", + "member":{ + "shape":"NetworkInterfacePrivateIpAddress", + "locationName":"item" + } + }, + "NetworkInterfaceStatus":{ + "type":"string", + "enum":[ + "available", + "associated", + "attaching", + "in-use", + "detaching" + ] + }, + "NetworkInterfaceType":{ + "type":"string", + "enum":[ + "interface", + "natGateway", + "efa" + ] + }, + "NewDhcpConfiguration":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "locationName":"key" + }, + "Values":{ + "shape":"ValueStringList", + "locationName":"Value" + } + } + }, + "NewDhcpConfigurationList":{ + "type":"list", + "member":{ + "shape":"NewDhcpConfiguration", + "locationName":"item" + } + }, + "NextToken":{"type":"string"}, + "OccurrenceDayRequestSet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"OccurenceDay" + } + }, + "OccurrenceDaySet":{ + "type":"list", + "member":{ + "shape":"Integer", + "locationName":"item" + } + }, + "OfferingClassType":{ + "type":"string", + "enum":[ + "standard", + "convertible" + ] + }, + "OfferingId":{"type":"string"}, + "OfferingTypeValues":{ + "type":"string", + "enum":[ + "Heavy Utilization", + "Medium Utilization", + "Light Utilization", + "No Upfront", + "Partial Upfront", + "All Upfront" + ] + }, + "OnDemandAllocationStrategy":{ + "type":"string", + "enum":[ + "lowestPrice", + "prioritized" + ] + }, + "OnDemandOptions":{ + "type":"structure", + "members":{ + "AllocationStrategy":{ + "shape":"FleetOnDemandAllocationStrategy", + "documentation":"

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.

", + "locationName":"allocationStrategy" + }, + "SingleInstanceType":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

", + "locationName":"singleInstanceType" + }, + "SingleAvailabilityZone":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

", + "locationName":"singleAvailabilityZone" + }, + "MinTargetCapacity":{ + "shape":"Integer", + "documentation":"

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

", + "locationName":"minTargetCapacity" + }, + "MaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for On-Demand Instances that you're willing to pay.

", + "locationName":"maxTotalPrice" + } + }, + "documentation":"

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + }, + "OnDemandOptionsRequest":{ + "type":"structure", + "members":{ + "AllocationStrategy":{ + "shape":"FleetOnDemandAllocationStrategy", + "documentation":"

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.

" + }, + "SingleInstanceType":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.

" + }, + "SingleAvailabilityZone":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.

" + }, + "MinTargetCapacity":{ + "shape":"Integer", + "documentation":"

The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

" + }, + "MaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for On-Demand Instances that you're willing to pay.

" + } + }, + "documentation":"

Describes the configuration of On-Demand Instances in an EC2 Fleet.

" + }, + "OperationType":{ + "type":"string", + "enum":[ + "add", + "remove" + ] + }, + "OwnerStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Owner" + } + }, + "PaymentOption":{ + "type":"string", + "enum":[ + "AllUpfront", + "PartialUpfront", + "NoUpfront" + ] + }, + "PciId":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"String", + "documentation":"

The ID of the device.

" + }, + "VendorId":{ + "shape":"String", + "documentation":"

The ID of the vendor.

" + }, + "SubsystemId":{ + "shape":"String", + "documentation":"

The ID of the subsystem.

" + }, + "SubsystemVendorId":{ + "shape":"String", + "documentation":"

The ID of the vendor for the subsystem.

" + } + }, + "documentation":"

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

" + }, + "PeeringConnectionOptions":{ + "type":"structure", + "members":{ + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "PeeringConnectionOptionsRequest":{ + "type":"structure", + "members":{ + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.

" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.

" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.

" + } + }, + "documentation":"

The VPC peering connection options.

" + }, + "PermissionGroup":{ + "type":"string", + "enum":["all"] + }, + "Phase1DHGroupNumbersList":{ + "type":"list", + "member":{ + "shape":"Phase1DHGroupNumbersListValue", + "locationName":"item" + } + }, + "Phase1DHGroupNumbersListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Integer", + "documentation":"

The Diffie-Hellmann group number.

", + "locationName":"value" + } + }, + "documentation":"

The Diffie-Hellmann group number for phase 1 IKE negotiations.

" + }, + "Phase1DHGroupNumbersRequestList":{ + "type":"list", + "member":{ + "shape":"Phase1DHGroupNumbersRequestListValue", + "locationName":"item" + } + }, + "Phase1DHGroupNumbersRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Integer", + "documentation":"

The Diffie-Hellmann group number.

" + } + }, + "documentation":"

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.

" + }, + "Phase1EncryptionAlgorithmsList":{ + "type":"list", + "member":{ + "shape":"Phase1EncryptionAlgorithmsListValue", + "locationName":"item" + } + }, + "Phase1EncryptionAlgorithmsListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The value for the encryption algorithm.

", + "locationName":"value" + } + }, + "documentation":"

The encryption algorithm for phase 1 IKE negotiations.

" + }, + "Phase1EncryptionAlgorithmsRequestList":{ + "type":"list", + "member":{ + "shape":"Phase1EncryptionAlgorithmsRequestListValue", + "locationName":"item" + } + }, + "Phase1EncryptionAlgorithmsRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The value for the encryption algorithm.

" + } + }, + "documentation":"

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.

" + }, + "Phase1IntegrityAlgorithmsList":{ + "type":"list", + "member":{ + "shape":"Phase1IntegrityAlgorithmsListValue", + "locationName":"item" + } + }, + "Phase1IntegrityAlgorithmsListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The value for the integrity algorithm.

", + "locationName":"value" + } + }, + "documentation":"

The integrity algorithm for phase 1 IKE negotiations.

" + }, + "Phase1IntegrityAlgorithmsRequestList":{ + "type":"list", + "member":{ + "shape":"Phase1IntegrityAlgorithmsRequestListValue", + "locationName":"item" + } + }, + "Phase1IntegrityAlgorithmsRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The value for the integrity algorithm.

" + } + }, + "documentation":"

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.

" + }, + "Phase2DHGroupNumbersList":{ + "type":"list", + "member":{ + "shape":"Phase2DHGroupNumbersListValue", + "locationName":"item" + } + }, + "Phase2DHGroupNumbersListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Integer", + "documentation":"

The Diffie-Hellmann group number.

", + "locationName":"value" + } + }, + "documentation":"

The Diffie-Hellmann group number for phase 2 IKE negotiations.

" + }, + "Phase2DHGroupNumbersRequestList":{ + "type":"list", + "member":{ + "shape":"Phase2DHGroupNumbersRequestListValue", + "locationName":"item" + } + }, + "Phase2DHGroupNumbersRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Integer", + "documentation":"

The Diffie-Hellmann group number.

" + } + }, + "documentation":"

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.

" + }, + "Phase2EncryptionAlgorithmsList":{ + "type":"list", + "member":{ + "shape":"Phase2EncryptionAlgorithmsListValue", + "locationName":"item" + } + }, + "Phase2EncryptionAlgorithmsListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The encryption algorithm.

", + "locationName":"value" + } + }, + "documentation":"

The encryption algorithm for phase 2 IKE negotiations.

" + }, + "Phase2EncryptionAlgorithmsRequestList":{ + "type":"list", + "member":{ + "shape":"Phase2EncryptionAlgorithmsRequestListValue", + "locationName":"item" + } + }, + "Phase2EncryptionAlgorithmsRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The encryption algorithm.

" + } + }, + "documentation":"

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.

" + }, + "Phase2IntegrityAlgorithmsList":{ + "type":"list", + "member":{ + "shape":"Phase2IntegrityAlgorithmsListValue", + "locationName":"item" + } + }, + "Phase2IntegrityAlgorithmsListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The integrity algorithm.

", + "locationName":"value" + } + }, + "documentation":"

The integrity algorithm for phase 2 IKE negotiations.

" + }, + "Phase2IntegrityAlgorithmsRequestList":{ + "type":"list", + "member":{ + "shape":"Phase2IntegrityAlgorithmsRequestListValue", + "locationName":"item" + } + }, + "Phase2IntegrityAlgorithmsRequestListValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

The integrity algorithm.

" + } + }, + "documentation":"

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.

" + }, + "Placement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

", + "locationName":"availabilityZone" + }, + "Affinity":{ + "shape":"String", + "documentation":"

The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command.

", + "locationName":"affinity" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in.

", + "locationName":"groupName" + }, + "PartitionNumber":{ + "shape":"Integer", + "documentation":"

The number of the partition the instance is in. Valid only if the placement group strategy is set to partition.

", + "locationName":"partitionNumber" + }, + "HostId":{ + "shape":"String", + "documentation":"

The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.

", + "locationName":"hostId" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.

", + "locationName":"tenancy" + }, + "SpreadDomain":{ + "shape":"String", + "documentation":"

Reserved for future use.

", + "locationName":"spreadDomain" + } + }, + "documentation":"

Describes the placement of an instance.

" + }, + "PlacementGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "State":{ + "shape":"PlacementGroupState", + "documentation":"

The state of the placement group.

", + "locationName":"state" + }, + "Strategy":{ + "shape":"PlacementStrategy", + "documentation":"

The placement strategy.

", + "locationName":"strategy" + }, + "PartitionCount":{ + "shape":"Integer", + "documentation":"

The number of partitions. Valid only if strategy is set to partition.

", + "locationName":"partitionCount" + } + }, + "documentation":"

Describes a placement group.

" + }, + "PlacementGroupList":{ + "type":"list", + "member":{ + "shape":"PlacementGroup", + "locationName":"item" + } + }, + "PlacementGroupName":{"type":"string"}, + "PlacementGroupState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "PlacementGroupStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PlacementResponse":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group the instance is in.

", + "locationName":"groupName" + } + }, + "documentation":"

Describes the placement of an instance.

" + }, + "PlacementStrategy":{ + "type":"string", + "enum":[ + "cluster", + "spread", + "partition" + ] + }, + "PlatformValues":{ + "type":"string", + "enum":["Windows"] + }, + "PoolMaxResults":{ + "type":"integer", + "max":10, + "min":1 + }, + "PortRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The first port in the range.

", + "locationName":"from" + }, + "To":{ + "shape":"Integer", + "documentation":"

The last port in the range.

", + "locationName":"to" + } + }, + "documentation":"

Describes a range of ports.

" + }, + "PrefixList":{ + "type":"structure", + "members":{ + "Cidrs":{ + "shape":"ValueStringList", + "documentation":"

The IP address range of the AWS service.

", + "locationName":"cidrSet" + }, + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix.

", + "locationName":"prefixListName" + } + }, + "documentation":"

Describes prefixes for AWS services.

" + }, + "PrefixListId":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the security group rule that references this prefix list ID.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", + "locationName":"description" + }, + "PrefixListId":{ + "shape":"String", + "documentation":"

The ID of the prefix.

", + "locationName":"prefixListId" + } + }, + "documentation":"

Describes a prefix list ID.

" + }, + "PrefixListIdList":{ + "type":"list", + "member":{ + "shape":"PrefixListId", + "locationName":"item" + } + }, + "PrefixListIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "PrefixListSet":{ + "type":"list", + "member":{ + "shape":"PrefixList", + "locationName":"item" + } + }, + "PriceSchedule":{ + "type":"structure", + "members":{ + "Active":{ + "shape":"Boolean", + "documentation":"

The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.

A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.

", + "locationName":"active" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleList":{ + "type":"list", + "member":{ + "shape":"PriceSchedule", + "locationName":"item" + } + }, + "PriceScheduleSpecification":{ + "type":"structure", + "members":{ + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Price":{ + "shape":"Double", + "documentation":"

The fixed price for the term.

", + "locationName":"price" + }, + "Term":{ + "shape":"Long", + "documentation":"

The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.

", + "locationName":"term" + } + }, + "documentation":"

Describes the price for a Reserved Instance.

" + }, + "PriceScheduleSpecificationList":{ + "type":"list", + "member":{ + "shape":"PriceScheduleSpecification", + "locationName":"item" + } + }, + "PricingDetail":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Integer", + "documentation":"

The number of reservations available for the price.

", + "locationName":"count" + }, + "Price":{ + "shape":"Double", + "documentation":"

The price per instance.

", + "locationName":"price" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "PricingDetailsList":{ + "type":"list", + "member":{ + "shape":"PricingDetail", + "locationName":"item" + } + }, + "PrincipalIdFormat":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

PrincipalIdFormatARN description

", + "locationName":"arn" + }, + "Statuses":{ + "shape":"IdFormatList", + "documentation":"

PrincipalIdFormatStatuses description

", + "locationName":"statusSet" + } + }, + "documentation":"

PrincipalIdFormat description

" + }, + "PrincipalIdFormatList":{ + "type":"list", + "member":{ + "shape":"PrincipalIdFormat", + "locationName":"item" + } + }, + "PrincipalType":{ + "type":"string", + "enum":[ + "All", + "Service", + "OrganizationUnit", + "Account", + "User", + "Role" + ] + }, + "PrivateIpAddressConfigSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesPrivateIpAddressConfig", + "locationName":"PrivateIpAddressConfigSet" + } + }, + "PrivateIpAddressSpecification":{ + "type":"structure", + "members":{ + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.

", + "locationName":"primary" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IPv4 addresses.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Describes a secondary private IPv4 address for a network interface.

" + }, + "PrivateIpAddressSpecificationList":{ + "type":"list", + "member":{ + "shape":"PrivateIpAddressSpecification", + "locationName":"item" + } + }, + "PrivateIpAddressStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PrivateIpAddress" + } + }, + "ProductCode":{ + "type":"structure", + "members":{ + "ProductCodeId":{ + "shape":"String", + "documentation":"

The product code.

", + "locationName":"productCode" + }, + "ProductCodeType":{ + "shape":"ProductCodeValues", + "documentation":"

The type of product code.

", + "locationName":"type" + } + }, + "documentation":"

Describes a product code.

" + }, + "ProductCodeList":{ + "type":"list", + "member":{ + "shape":"ProductCode", + "locationName":"item" + } + }, + "ProductCodeStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ProductCode" + } + }, + "ProductCodeValues":{ + "type":"string", + "enum":[ + "devpay", + "marketplace" + ] + }, + "ProductDescriptionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PropagatingVgw":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"gatewayId" + } + }, + "documentation":"

Describes a virtual private gateway propagating route.

" + }, + "PropagatingVgwList":{ + "type":"list", + "member":{ + "shape":"PropagatingVgw", + "locationName":"item" + } + }, + "ProvisionByoipCidrRequest":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another Region.

" + }, + "CidrAuthorizationContext":{ + "shape":"CidrAuthorizationContext", + "documentation":"

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the address range and the address pool.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ProvisionByoipCidrResult":{ + "type":"structure", + "members":{ + "ByoipCidr":{ + "shape":"ByoipCidr", + "documentation":"

Information about the address pool.

", + "locationName":"byoipCidr" + } + } + }, + "ProvisionedBandwidth":{ + "type":"structure", + "members":{ + "ProvisionTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisionTime" + }, + "Provisioned":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"provisioned" + }, + "RequestTime":{ + "shape":"DateTime", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requestTime" + }, + "Requested":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"requested" + }, + "Status":{ + "shape":"String", + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

", + "locationName":"status" + } + }, + "documentation":"

Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.

" + }, + "PublicIpStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PublicIp" + } + }, + "PublicIpv4Pool":{ + "type":"structure", + "members":{ + "PoolId":{ + "shape":"String", + "documentation":"

The ID of the IPv4 address pool.

", + "locationName":"poolId" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the address pool.

", + "locationName":"description" + }, + "PoolAddressRanges":{ + "shape":"PublicIpv4PoolRangeSet", + "documentation":"

The address ranges.

", + "locationName":"poolAddressRangeSet" + }, + "TotalAddressCount":{ + "shape":"Integer", + "documentation":"

The total number of addresses.

", + "locationName":"totalAddressCount" + }, + "TotalAvailableAddressCount":{ + "shape":"Integer", + "documentation":"

The total number of available addresses.

", + "locationName":"totalAvailableAddressCount" + } + }, + "documentation":"

Describes an address pool.

" + }, + "PublicIpv4PoolRange":{ + "type":"structure", + "members":{ + "FirstAddress":{ + "shape":"String", + "documentation":"

The first IP address in the range.

", + "locationName":"firstAddress" + }, + "LastAddress":{ + "shape":"String", + "documentation":"

The last IP address in the range.

", + "locationName":"lastAddress" + }, + "AddressCount":{ + "shape":"Integer", + "documentation":"

The number of addresses in the range.

", + "locationName":"addressCount" + }, + "AvailableAddressCount":{ + "shape":"Integer", + "documentation":"

The number of available addresses in the range.

", + "locationName":"availableAddressCount" + } + }, + "documentation":"

Describes an address range of an IPv4 address pool.

" + }, + "PublicIpv4PoolRangeSet":{ + "type":"list", + "member":{ + "shape":"PublicIpv4PoolRange", + "locationName":"item" + } + }, + "PublicIpv4PoolSet":{ + "type":"list", + "member":{ + "shape":"PublicIpv4Pool", + "locationName":"item" + } + }, + "Purchase":{ + "type":"structure", + "members":{ + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation's term in seconds.

", + "locationName":"duration" + }, + "HostIdSet":{ + "shape":"ResponseHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts associated with the reservation.

", + "locationName":"hostIdSet" + }, + "HostReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"hostReservationId" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price of the reservation per hour.

", + "locationName":"hourlyPrice" + }, + "InstanceFamily":{ + "shape":"String", + "documentation":"

The instance family on the Dedicated Host that the reservation can be associated with.

", + "locationName":"instanceFamily" + }, + "PaymentOption":{ + "shape":"PaymentOption", + "documentation":"

The payment option for the reservation.

", + "locationName":"paymentOption" + }, + "UpfrontPrice":{ + "shape":"String", + "documentation":"

The upfront price of the reservation.

", + "locationName":"upfrontPrice" + } + }, + "documentation":"

Describes the result of the purchase.

" + }, + "PurchaseHostReservationRequest":{ + "type":"structure", + "required":[ + "HostIdSet", + "OfferingId" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

" + }, + "HostIdSet":{ + "shape":"RequestHostIdSet", + "documentation":"

The IDs of the Dedicated Hosts with which the reservation will be associated.

" + }, + "LimitPrice":{ + "shape":"String", + "documentation":"

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

" + }, + "OfferingId":{ + "shape":"OfferingId", + "documentation":"

The ID of the offering.

" + } + } + }, + "PurchaseHostReservationResult":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

", + "locationName":"clientToken" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "Purchase":{ + "shape":"PurchaseSet", + "documentation":"

Describes the details of the purchase.

", + "locationName":"purchase" + }, + "TotalHourlyPrice":{ + "shape":"String", + "documentation":"

The total hourly price of the reservation calculated per hour.

", + "locationName":"totalHourlyPrice" + }, + "TotalUpfrontPrice":{ + "shape":"String", + "documentation":"

The total amount charged to your account when you purchase the reservation.

", + "locationName":"totalUpfrontPrice" + } + } + }, + "PurchaseRequest":{ + "type":"structure", + "required":[ + "InstanceCount", + "PurchaseToken" + ], + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

" + }, + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token.

" + } + }, + "documentation":"

Describes a request to purchase Scheduled Instances.

" + }, + "PurchaseRequestSet":{ + "type":"list", + "member":{ + "shape":"PurchaseRequest", + "locationName":"PurchaseRequest" + }, + "min":1 + }, + "PurchaseReservedInstancesOfferingRequest":{ + "type":"structure", + "required":[ + "InstanceCount", + "ReservedInstancesOfferingId" + ], + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Reserved Instances to purchase.

" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering to purchase.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "LimitPrice":{ + "shape":"ReservedInstanceLimitPrice", + "documentation":"

Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

", + "locationName":"limitPrice" + }, + "PurchaseTime":{ + "shape":"DateTime", + "documentation":"

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

" + } + }, + "documentation":"

Contains the parameters for PurchaseReservedInstancesOffering.

" + }, + "PurchaseReservedInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The IDs of the purchased Reserved Instances.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Contains the output of PurchaseReservedInstancesOffering.

" + }, + "PurchaseScheduledInstancesRequest":{ + "type":"structure", + "required":["PurchaseRequests"], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PurchaseRequests":{ + "shape":"PurchaseRequestSet", + "documentation":"

The purchase requests.

", + "locationName":"PurchaseRequest" + } + }, + "documentation":"

Contains the parameters for PurchaseScheduledInstances.

" + }, + "PurchaseScheduledInstancesResult":{ + "type":"structure", + "members":{ + "ScheduledInstanceSet":{ + "shape":"PurchasedScheduledInstanceSet", + "documentation":"

Information about the Scheduled Instances.

", + "locationName":"scheduledInstanceSet" + } + }, + "documentation":"

Contains the output of PurchaseScheduledInstances.

" + }, + "PurchaseSet":{ + "type":"list", + "member":{ + "shape":"Purchase", + "locationName":"item" + } + }, + "PurchasedScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "RIProductDescription":{ + "type":"string", + "enum":[ + "Linux/UNIX", + "Linux/UNIX (Amazon VPC)", + "Windows", + "Windows (Amazon VPC)" + ] + }, + "RamdiskId":{"type":"string"}, + "ReasonCodesList":{ + "type":"list", + "member":{ + "shape":"ReportInstanceReasonCodes", + "locationName":"item" + } + }, + "RebootInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The instance IDs.

", + "locationName":"InstanceId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

The amount of the recurring charge.

", + "locationName":"amount" + }, + "Frequency":{ + "shape":"RecurringChargeFrequency", + "documentation":"

The frequency of the recurring charge.

", + "locationName":"frequency" + } + }, + "documentation":"

Describes a recurring charge.

" + }, + "RecurringChargeFrequency":{ + "type":"string", + "enum":["Hourly"] + }, + "RecurringChargesList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"item" + } + }, + "Region":{ + "type":"structure", + "members":{ + "Endpoint":{ + "shape":"String", + "documentation":"

The Region service endpoint.

", + "locationName":"regionEndpoint" + }, + "RegionName":{ + "shape":"String", + "documentation":"

The name of the Region.

", + "locationName":"regionName" + }, + "OptInStatus":{ + "shape":"String", + "documentation":"

The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.

", + "locationName":"optInStatus" + } + }, + "documentation":"

Describes a Region.

" + }, + "RegionList":{ + "type":"list", + "member":{ + "shape":"Region", + "locationName":"item" + } + }, + "RegionNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"RegionName" + } + }, + "RegisterImageRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "ImageLocation":{ + "shape":"String", + "documentation":"

The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.

" + }, + "Architecture":{ + "shape":"ArchitectureValues", + "documentation":"

The architecture of the AMI.

Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.

", + "locationName":"architecture" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for your AMI.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EnaSupport":{ + "shape":"Boolean", + "documentation":"

Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"enaSupport" + }, + "KernelId":{ + "shape":"KernelId", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "Name":{ + "shape":"String", + "documentation":"

A name for your AMI.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)

", + "locationName":"name" + }, + "BillingProducts":{ + "shape":"BillingProductList", + "documentation":"

The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI.

", + "locationName":"BillingProduct" + }, + "RamdiskId":{ + "shape":"RamdiskId", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "RootDeviceName":{ + "shape":"String", + "documentation":"

The device name of the root device volume (for example, /dev/sda1).

", + "locationName":"rootDeviceName" + }, + "SriovNetSupport":{ + "shape":"String", + "documentation":"

Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.

There is no way to disable sriovNetSupport at this time.

This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.

", + "locationName":"sriovNetSupport" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The type of virtualization (hvm | paravirtual).

Default: paravirtual

", + "locationName":"virtualizationType" + } + }, + "documentation":"

Contains the parameters for RegisterImage.

" + }, + "RegisterImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the newly registered AMI.

", + "locationName":"imageId" + } + }, + "documentation":"

Contains the output of RegisterImage.

" + }, + "RejectTransitGatewayVpcAttachmentRequest":{ + "type":"structure", + "required":["TransitGatewayAttachmentId"], + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "RejectTransitGatewayVpcAttachmentResult":{ + "type":"structure", + "members":{ + "TransitGatewayVpcAttachment":{ + "shape":"TransitGatewayVpcAttachment", + "documentation":"

Information about the attachment.

", + "locationName":"transitGatewayVpcAttachment" + } + } + }, + "RejectVpcEndpointConnectionsRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "VpcEndpointIds" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "ServiceId":{ + "shape":"ServiceId", + "documentation":"

The ID of the service.

" + }, + "VpcEndpointIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of one or more VPC endpoints.

", + "locationName":"VpcEndpointId" + } + } + }, + "RejectVpcEndpointConnectionsResult":{ + "type":"structure", + "members":{ + "Unsuccessful":{ + "shape":"UnsuccessfulItemSet", + "documentation":"

Information about the endpoints that were not rejected, if applicable.

", + "locationName":"unsuccessful" + } + } + }, + "RejectVpcPeeringConnectionRequest":{ + "type":"structure", + "required":["VpcPeeringConnectionId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "RejectVpcPeeringConnectionResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, it returns an error.

", + "locationName":"return" + } + } + }, + "ReleaseAddressRequest":{ + "type":"structure", + "members":{ + "AllocationId":{ + "shape":"AllocationId", + "documentation":"

[EC2-VPC] The allocation ID. Required for EC2-VPC.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "ReleaseHostsRequest":{ + "type":"structure", + "required":["HostIds"], + "members":{ + "HostIds":{ + "shape":"RequestHostIdList", + "documentation":"

The IDs of the Dedicated Hosts to release.

", + "locationName":"hostId" + } + } + }, + "ReleaseHostsResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"ResponseHostIdList", + "documentation":"

The IDs of the Dedicated Hosts that were successfully released.

", + "locationName":"successful" + }, + "Unsuccessful":{ + "shape":"UnsuccessfulItemList", + "documentation":"

The IDs of the Dedicated Hosts that could not be released, including an error message.

", + "locationName":"unsuccessful" + } + } + }, + "ReplaceIamInstanceProfileAssociationRequest":{ + "type":"structure", + "required":[ + "IamInstanceProfile", + "AssociationId" + ], + "members":{ + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

" + }, + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the existing IAM instance profile association.

" + } + } + }, + "ReplaceIamInstanceProfileAssociationResult":{ + "type":"structure", + "members":{ + "IamInstanceProfileAssociation":{ + "shape":"IamInstanceProfileAssociation", + "documentation":"

Information about the IAM instance profile association.

", + "locationName":"iamInstanceProfileAssociation" + } + } + }, + "ReplaceNetworkAclAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "NetworkAclId" + ], + "members":{ + "AssociationId":{ + "shape":"NetworkAclAssociationId", + "documentation":"

The ID of the current association between the original network ACL and the subnet.

", + "locationName":"associationId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"

The ID of the new network ACL to associate with the subnet.

", + "locationName":"networkAclId" + } + } + }, + "ReplaceNetworkAclAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceNetworkAclEntryRequest":{ + "type":"structure", + "required":[ + "Egress", + "NetworkAclId", + "Protocol", + "RuleAction", + "RuleNumber" + ], + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "locationName":"cidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Egress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

", + "locationName":"egress" + }, + "IcmpTypeCode":{ + "shape":"IcmpTypeCode", + "documentation":"

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

", + "locationName":"Icmp" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 network range to allow or deny, in CIDR notation (for example 2001:bd8:1234:1a00::/64).

", + "locationName":"ipv6CidrBlock" + }, + "NetworkAclId":{ + "shape":"NetworkAclId", + "documentation":"

The ID of the ACL.

", + "locationName":"networkAclId" + }, + "PortRange":{ + "shape":"PortRange", + "documentation":"

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

", + "locationName":"portRange" + }, + "Protocol":{ + "shape":"String", + "documentation":"

The protocol number. A value of \"-1\" means all protocols. If you specify \"-1\" or a protocol number other than \"6\" (TCP), \"17\" (UDP), or \"1\" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \"58\" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

", + "locationName":"protocol" + }, + "RuleAction":{ + "shape":"RuleAction", + "documentation":"

Indicates whether to allow or deny the traffic that matches the rule.

", + "locationName":"ruleAction" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the entry to replace.

", + "locationName":"ruleNumber" + } + } + }, + "ReplaceRouteRequest":{ + "type":"structure", + "required":["RouteTableId"], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationCidrBlock" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

", + "locationName":"destinationIpv6CidrBlock" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"EgressOnlyInternetGatewayId", + "documentation":"

[IPv6 traffic only] The ID of an egress-only internet gateway.

", + "locationName":"egressOnlyInternetGatewayId" + }, + "GatewayId":{ + "shape":"RouteTableGatewayId", + "documentation":"

The ID of an internet gateway or virtual private gateway.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "NatGatewayId":{ + "shape":"NatGatewayId", + "documentation":"

[IPv4 traffic only] The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "TransitGatewayId":{ + "shape":"TransitGatewayId", + "documentation":"

The ID of a transit gateway.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of a network interface.

", + "locationName":"networkInterfaceId" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "VpcPeeringConnectionId":{ + "shape":"VpcPeeringConnectionId", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + } + }, + "ReplaceRouteTableAssociationRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "RouteTableId" + ], + "members":{ + "AssociationId":{ + "shape":"RouteTableAssociationId", + "documentation":"

The association ID.

", + "locationName":"associationId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "RouteTableId":{ + "shape":"RouteTableId", + "documentation":"

The ID of the new route table to associate with the subnet.

", + "locationName":"routeTableId" + } + } + }, + "ReplaceRouteTableAssociationResult":{ + "type":"structure", + "members":{ + "NewAssociationId":{ + "shape":"String", + "documentation":"

The ID of the new association.

", + "locationName":"newAssociationId" + } + } + }, + "ReplaceTransitGatewayRouteRequest":{ + "type":"structure", + "required":[ + "DestinationCidrBlock", + "TransitGatewayRouteTableId" + ], + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR range used for the destination match. Routing decisions are based on the most specific match.

" + }, + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the route table.

" + }, + "TransitGatewayAttachmentId":{ + "shape":"TransitGatewayAttachmentId", + "documentation":"

The ID of the attachment.

" + }, + "Blackhole":{ + "shape":"Boolean", + "documentation":"

Indicates whether traffic matching this route is to be dropped.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ReplaceTransitGatewayRouteResult":{ + "type":"structure", + "members":{ + "Route":{ + "shape":"TransitGatewayRoute", + "documentation":"

Information about the modified route.

", + "locationName":"route" + } + } + }, + "ReportInstanceReasonCodes":{ + "type":"string", + "enum":[ + "instance-stuck-in-state", + "unresponsive", + "not-accepting-credentials", + "password-not-available", + "performance-network", + "performance-instance-store", + "performance-ebs-volume", + "performance-other", + "other" + ] + }, + "ReportInstanceStatusRequest":{ + "type":"structure", + "required":[ + "Instances", + "ReasonCodes", + "Status" + ], + "members":{ + "Description":{ + "shape":"String", + "documentation":"

Descriptive text about the health state of your instance.

", + "locationName":"description" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state ended.

", + "locationName":"endTime" + }, + "Instances":{ + "shape":"InstanceIdStringList", + "documentation":"

The instances.

", + "locationName":"instanceId" + }, + "ReasonCodes":{ + "shape":"ReasonCodesList", + "documentation":"

The reason codes that describe the health state of your instance.

  • instance-stuck-in-state: My instance is stuck in a state.

  • unresponsive: My instance is unresponsive.

  • not-accepting-credentials: My instance is not accepting my credentials.

  • password-not-available: A password is not available for my instance.

  • performance-network: My instance is experiencing performance problems that I believe are network related.

  • performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.

  • performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.

  • performance-other: My instance is experiencing performance problems.

  • other: [explain using the description parameter]

", + "locationName":"reasonCode" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time at which the reported instance health state began.

", + "locationName":"startTime" + }, + "Status":{ + "shape":"ReportStatusType", + "documentation":"

The status of all instances listed.

", + "locationName":"status" + } + } + }, + "ReportStatusType":{ + "type":"string", + "enum":[ + "ok", + "impaired" + ] + }, + "RequestHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "RequestHostIdSet":{ + "type":"list", + "member":{ + "shape":"HostId", + "locationName":"item" + } + }, + "RequestLaunchTemplateData":{ + "type":"structure", + "members":{ + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

" + }, + "IamInstanceProfile":{ + "shape":"LaunchTemplateIamInstanceProfileSpecificationRequest", + "documentation":"

The IAM instance profile.

" + }, + "BlockDeviceMappings":{ + "shape":"LaunchTemplateBlockDeviceMappingRequestList", + "documentation":"

The block device mapping.

Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.

", + "locationName":"BlockDeviceMapping" + }, + "NetworkInterfaces":{ + "shape":"LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", + "documentation":"

One or more network interfaces. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

", + "locationName":"NetworkInterface" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "Monitoring":{ + "shape":"LaunchTemplatesMonitoringRequest", + "documentation":"

The monitoring for the instance.

" + }, + "Placement":{ + "shape":"LaunchTemplatePlacementRequest", + "documentation":"

The placement for the instance.

" + }, + "RamDiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User Provided Kernels in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows).

" + }, + "TagSpecifications":{ + "shape":"LaunchTemplateTagSpecificationRequestList", + "documentation":"

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

", + "locationName":"TagSpecification" + }, + "ElasticGpuSpecifications":{ + "shape":"ElasticGpuSpecificationList", + "documentation":"

An elastic GPU to associate with the instance.

", + "locationName":"ElasticGpuSpecification" + }, + "ElasticInferenceAccelerators":{ + "shape":"LaunchTemplateElasticInferenceAcceleratorList", + "documentation":"

The elastic inference accelerator for the instance.

", + "locationName":"ElasticInferenceAccelerator" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.

", + "locationName":"SecurityGroupId" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.

", + "locationName":"SecurityGroup" + }, + "InstanceMarketOptions":{ + "shape":"LaunchTemplateInstanceMarketOptionsRequest", + "documentation":"

The market (purchasing) option for the instances.

" + }, + "CreditSpecification":{ + "shape":"CreditSpecificationRequest", + "documentation":"

The credit option for CPU usage of the instance. Valid for T2 or T3 instances only.

" + }, + "CpuOptions":{ + "shape":"LaunchTemplateCpuOptionsRequest", + "documentation":"

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CapacityReservationSpecification":{ + "shape":"LaunchTemplateCapacityReservationSpecificationRequest", + "documentation":"

The Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

" + }, + "LicenseSpecifications":{ + "shape":"LaunchTemplateLicenseSpecificationListRequest", + "documentation":"

The license configurations.

", + "locationName":"LicenseSpecification" + }, + "HibernationOptions":{ + "shape":"LaunchTemplateHibernationOptionsRequest", + "documentation":"

Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + } + }, + "documentation":"

The information to include in the launch template.

" + }, + "RequestSpotFleetRequest":{ + "type":"structure", + "required":["SpotFleetRequestConfig"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration for the Spot Fleet request.

", + "locationName":"spotFleetRequestConfig" + } + }, + "documentation":"

Contains the parameters for RequestSpotFleet.

" + }, + "RequestSpotFleetResponse":{ + "type":"structure", + "members":{ + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + } + }, + "documentation":"

Contains the output of RequestSpotFleet.

" + }, + "RequestSpotInstancesRequest":{ + "type":"structure", + "members":{ + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The user-specified name for a logical grouping of requests.

When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.

If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.

Default: Instances are launched in any available Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.

You can't specify an Availability Zone group or a launch group if you specify a duration.

", + "locationName":"blockDurationMinutes" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.

", + "locationName":"clientToken" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot Instances to launch.

Default: 1

", + "locationName":"instanceCount" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Default: Instances are launched and terminated individually

", + "locationName":"launchGroup" + }, + "LaunchSpecification":{ + "shape":"RequestSpotLaunchSpecification", + "documentation":"

The launch specification.

" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

", + "locationName":"spotPrice" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

Default: one-time

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.

The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

", + "locationName":"validUntil" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + }, + "documentation":"

Contains the parameters for RequestSpotInstances.

" + }, + "RequestSpotInstancesResult":{ + "type":"structure", + "members":{ + "SpotInstanceRequests":{ + "shape":"SpotInstanceRequestList", + "documentation":"

One or more Spot Instance requests.

", + "locationName":"spotInstanceRequestSet" + } + }, + "documentation":"

Contains the output of RequestSpotInstances.

" + }, + "RequestSpotLaunchSpecification":{ + "type":"structure", + "members":{ + "SecurityGroupIds":{ + "shape":"ValueStringList", + "documentation":"

One or more security group IDs.

", + "locationName":"SecurityGroupId" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"SecurityGroup" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.

", + "locationName":"blockDeviceMapping" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

Indicates whether basic or detailed monitoring is enabled for the instance.

Default: Disabled

", + "locationName":"monitoring" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", + "locationName":"NetworkInterface" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information for the instance.

", + "locationName":"placement" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

", + "locationName":"ramdiskId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The IDs of the subnets in which to launch the instance. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", + "locationName":"subnetId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded user data for the instance. User data is limited to 16 KB.

", + "locationName":"userData" + } + }, + "documentation":"

Describes the launch specification for an instance.

" + }, + "Reservation":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupIdentifierList", + "documentation":"

[EC2-Classic only] The security groups.

", + "locationName":"groupSet" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

The instances.

", + "locationName":"instancesSet" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the reservation.

", + "locationName":"ownerId" + }, + "RequesterId":{ + "shape":"String", + "documentation":"

The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).

", + "locationName":"requesterId" + }, + "ReservationId":{ + "shape":"String", + "documentation":"

The ID of the reservation.

", + "locationName":"reservationId" + } + }, + "documentation":"

Describes a reservation.

" + }, + "ReservationList":{ + "type":"list", + "member":{ + "shape":"Reservation", + "locationName":"item" + } + }, + "ReservationState":{ + "type":"string", + "enum":[ + "payment-pending", + "payment-failed", + "active", + "retired" + ] + }, + "ReservationValue":{ + "type":"structure", + "members":{ + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly rate of the reservation.

", + "locationName":"hourlyPrice" + }, + "RemainingTotalValue":{ + "shape":"String", + "documentation":"

The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).

", + "locationName":"remainingTotalValue" + }, + "RemainingUpfrontValue":{ + "shape":"String", + "documentation":"

The remaining upfront cost of the reservation.

", + "locationName":"remainingUpfrontValue" + } + }, + "documentation":"

The cost associated with the Reserved Instance.

" + }, + "ReservedInstanceIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstanceId" + } + }, + "ReservedInstanceLimitPrice":{ + "type":"structure", + "members":{ + "Amount":{ + "shape":"Double", + "documentation":"

Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

", + "locationName":"amount" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + } + }, + "documentation":"

Describes the limit price of a Reserved Instance offering.

" + }, + "ReservedInstanceReservationValue":{ + "type":"structure", + "members":{ + "ReservationValue":{ + "shape":"ReservationValue", + "documentation":"

The total value of the Convertible Reserved Instance that you are exchanging.

", + "locationName":"reservationValue" + }, + "ReservedInstanceId":{ + "shape":"String", + "documentation":"

The ID of the Convertible Reserved Instance that you are exchanging.

", + "locationName":"reservedInstanceId" + } + }, + "documentation":"

The total value of the Convertible Reserved Instance.

" + }, + "ReservedInstanceReservationValueSet":{ + "type":"list", + "member":{ + "shape":"ReservedInstanceReservationValue", + "locationName":"item" + } + }, + "ReservedInstanceState":{ + "type":"string", + "enum":[ + "payment-pending", + "active", + "payment-failed", + "retired", + "queued", + "queued-deleted" + ] + }, + "ReservedInstances":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "End":{ + "shape":"DateTime", + "documentation":"

The time when the Reserved Instance expires.

", + "locationName":"end" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of reservations purchased.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "Start":{ + "shape":"DateTime", + "documentation":"

The date and time the Reserved Instance started.

", + "locationName":"start" + }, + "State":{ + "shape":"ReservedInstanceState", + "documentation":"

The state of the Reserved Instance purchase.

", + "locationName":"state" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

The offering class of the Reserved Instance.

", + "locationName":"offeringClass" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Scope":{ + "shape":"scope", + "documentation":"

The scope of the Reserved Instance.

", + "locationName":"scope" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a Reserved Instance.

" + }, + "ReservedInstancesConfiguration":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the modified Reserved Instances.

", + "locationName":"availabilityZone" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of modified Reserved Instances.

This is a required field for a request.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type for the modified Reserved Instances.

", + "locationName":"instanceType" + }, + "Platform":{ + "shape":"String", + "documentation":"

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

", + "locationName":"platform" + }, + "Scope":{ + "shape":"scope", + "documentation":"

Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.

", + "locationName":"scope" + } + }, + "documentation":"

Describes the configuration settings for the modified Reserved Instances.

" + }, + "ReservedInstancesConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesConfiguration", + "locationName":"item" + } + }, + "ReservedInstancesId":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes the ID of a Reserved Instance.

" + }, + "ReservedInstancesIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesId" + } + }, + "ReservedInstancesList":{ + "type":"list", + "member":{ + "shape":"ReservedInstances", + "locationName":"item" + } + }, + "ReservedInstancesListing":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time the listing was created.

", + "locationName":"createDate" + }, + "InstanceCounts":{ + "shape":"InstanceCountList", + "documentation":"

The number of instances in this state.

", + "locationName":"instanceCounts" + }, + "PriceSchedules":{ + "shape":"PriceScheduleList", + "documentation":"

The price of the Reserved Instance listing.

", + "locationName":"priceSchedules" + }, + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + }, + "ReservedInstancesListingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance listing.

", + "locationName":"reservedInstancesListingId" + }, + "Status":{ + "shape":"ListingStatus", + "documentation":"

The status of the Reserved Instance listing.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the current status of the Reserved Instance listing. The response can be blank.

", + "locationName":"statusMessage" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The last modified timestamp of the listing.

", + "locationName":"updateDate" + } + }, + "documentation":"

Describes a Reserved Instance listing.

" + }, + "ReservedInstancesListingId":{"type":"string"}, + "ReservedInstancesListingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesListing", + "locationName":"item" + } + }, + "ReservedInstancesModification":{ + "type":"structure", + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was created.

", + "locationName":"createDate" + }, + "EffectiveDate":{ + "shape":"DateTime", + "documentation":"

The time for the modification to become effective.

", + "locationName":"effectiveDate" + }, + "ModificationResults":{ + "shape":"ReservedInstancesModificationResultList", + "documentation":"

Contains target configurations along with their corresponding new Reserved Instance IDs.

", + "locationName":"modificationResultSet" + }, + "ReservedInstancesIds":{ + "shape":"ReservedIntancesIds", + "documentation":"

The IDs of one or more Reserved Instances.

", + "locationName":"reservedInstancesSet" + }, + "ReservedInstancesModificationId":{ + "shape":"String", + "documentation":"

A unique ID for the Reserved Instance modification.

", + "locationName":"reservedInstancesModificationId" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the Reserved Instances modification request.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

The reason for the status.

", + "locationName":"statusMessage" + }, + "UpdateDate":{ + "shape":"DateTime", + "documentation":"

The time when the modification request was last updated.

", + "locationName":"updateDate" + } + }, + "documentation":"

Describes a Reserved Instance modification.

" + }, + "ReservedInstancesModificationIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReservedInstancesModificationId" + } + }, + "ReservedInstancesModificationList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModification", + "locationName":"item" + } + }, + "ReservedInstancesModificationResult":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.

", + "locationName":"reservedInstancesId" + }, + "TargetConfiguration":{ + "shape":"ReservedInstancesConfiguration", + "documentation":"

The target Reserved Instances configurations supplied as part of the modification request.

", + "locationName":"targetConfiguration" + } + }, + "documentation":"

Describes the modification request/s.

" + }, + "ReservedInstancesModificationResultList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesModificationResult", + "locationName":"item" + } + }, + "ReservedInstancesOffering":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the Reserved Instance can be used.

", + "locationName":"availabilityZone" + }, + "Duration":{ + "shape":"Long", + "documentation":"

The duration of the Reserved Instance, in seconds.

", + "locationName":"duration" + }, + "FixedPrice":{ + "shape":"Float", + "documentation":"

The purchase price of the Reserved Instance.

", + "locationName":"fixedPrice" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type on which the Reserved Instance can be used.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The Reserved Instance product platform description.

", + "locationName":"productDescription" + }, + "ReservedInstancesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.

", + "locationName":"reservedInstancesOfferingId" + }, + "UsagePrice":{ + "shape":"Float", + "documentation":"

The usage price of the Reserved Instance, per hour.

", + "locationName":"usagePrice" + }, + "CurrencyCode":{ + "shape":"CurrencyCodeValues", + "documentation":"

The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.

", + "locationName":"currencyCode" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance.

", + "locationName":"instanceTenancy" + }, + "Marketplace":{ + "shape":"Boolean", + "documentation":"

Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.

", + "locationName":"marketplace" + }, + "OfferingClass":{ + "shape":"OfferingClassType", + "documentation":"

If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.

", + "locationName":"offeringClass" + }, + "OfferingType":{ + "shape":"OfferingTypeValues", + "documentation":"

The Reserved Instance offering type.

", + "locationName":"offeringType" + }, + "PricingDetails":{ + "shape":"PricingDetailsList", + "documentation":"

The pricing details of the Reserved Instance offering.

", + "locationName":"pricingDetailsSet" + }, + "RecurringCharges":{ + "shape":"RecurringChargesList", + "documentation":"

The recurring charge tag assigned to the resource.

", + "locationName":"recurringCharges" + }, + "Scope":{ + "shape":"scope", + "documentation":"

Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.

", + "locationName":"scope" + } + }, + "documentation":"

Describes a Reserved Instance offering.

" + }, + "ReservedInstancesOfferingIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ReservedInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesOffering", + "locationName":"item" + } + }, + "ReservedIntancesIds":{ + "type":"list", + "member":{ + "shape":"ReservedInstancesId", + "locationName":"item" + } + }, + "ResetEbsDefaultKmsKeyIdRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "ResetEbsDefaultKmsKeyIdResult":{ + "type":"structure", + "members":{ + "KmsKeyId":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the default CMK for EBS encryption by default.

", + "locationName":"kmsKeyId" + } + } + }, + "ResetFpgaImageAttributeName":{ + "type":"string", + "enum":["loadPermission"] + }, + "ResetFpgaImageAttributeRequest":{ + "type":"structure", + "required":["FpgaImageId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "FpgaImageId":{ + "shape":"FpgaImageId", + "documentation":"

The ID of the AFI.

" + }, + "Attribute":{ + "shape":"ResetFpgaImageAttributeName", + "documentation":"

The attribute.

" + } + } + }, + "ResetFpgaImageAttributeResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Is true if the request succeeds, and an error otherwise.

", + "locationName":"return" + } + } + }, + "ResetImageAttributeName":{ + "type":"string", + "enum":["launchPermission"] + }, + "ResetImageAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "ImageId" + ], + "members":{ + "Attribute":{ + "shape":"ResetImageAttributeName", + "documentation":"

The attribute to reset (currently you can only reset the launch permission attribute).

" + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

The ID of the AMI.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for ResetImageAttribute.

" + }, + "ResetInstanceAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "InstanceId" + ], + "members":{ + "Attribute":{ + "shape":"InstanceAttributeName", + "documentation":"

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

", + "locationName":"attribute" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + } + } + }, + "ResetNetworkInterfaceAttributeRequest":{ + "type":"structure", + "required":["NetworkInterfaceId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "SourceDestCheck":{ + "shape":"String", + "documentation":"

The source/destination checking attribute. Resets the value to true.

", + "locationName":"sourceDestCheck" + } + }, + "documentation":"

Contains the parameters for ResetNetworkInterfaceAttribute.

" + }, + "ResetSnapshotAttributeRequest":{ + "type":"structure", + "required":[ + "Attribute", + "SnapshotId" + ], + "members":{ + "Attribute":{ + "shape":"SnapshotAttributeName", + "documentation":"

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the snapshot.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + }, + "documentation":"

Contains the parameters for ResetSnapshotAttribute.

" + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ResourceType":{ + "type":"string", + "enum":[ + "client-vpn-endpoint", + "customer-gateway", + "dedicated-host", + "dhcp-options", + "elastic-ip", + "fleet", + "fpga-image", + "host-reservation", + "image", + "instance", + "internet-gateway", + "launch-template", + "natgateway", + "network-acl", + "network-interface", + "reserved-instances", + "route-table", + "security-group", + "snapshot", + "spot-instances-request", + "subnet", + "traffic-mirror-filter", + "traffic-mirror-session", + "traffic-mirror-target", + "transit-gateway", + "transit-gateway-attachment", + "transit-gateway-route-table", + "volume", + "vpc", + "vpc-peering-connection", + "vpn-connection", + "vpn-gateway" + ] + }, + "ResponseError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"LaunchTemplateErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the error that's returned when you cannot delete a launch template version.

" + }, + "ResponseHostIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ResponseHostIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "ResponseLaunchTemplateData":{ + "type":"structure", + "members":{ + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel, if applicable.

", + "locationName":"kernelId" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O.

", + "locationName":"ebsOptimized" + }, + "IamInstanceProfile":{ + "shape":"LaunchTemplateIamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "BlockDeviceMappings":{ + "shape":"LaunchTemplateBlockDeviceMappingList", + "documentation":"

The block device mappings.

", + "locationName":"blockDeviceMappingSet" + }, + "NetworkInterfaces":{ + "shape":"LaunchTemplateInstanceNetworkInterfaceSpecificationList", + "documentation":"

The network interfaces.

", + "locationName":"networkInterfaceSet" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI that was used to launch the instance.

", + "locationName":"imageId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "Monitoring":{ + "shape":"LaunchTemplatesMonitoring", + "documentation":"

The monitoring for the instance.

", + "locationName":"monitoring" + }, + "Placement":{ + "shape":"LaunchTemplatePlacement", + "documentation":"

The placement of the instance.

", + "locationName":"placement" + }, + "RamDiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk, if applicable.

", + "locationName":"ramDiskId" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If set to true, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.

", + "locationName":"disableApiTermination" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data for the instance.

", + "locationName":"userData" + }, + "TagSpecifications":{ + "shape":"LaunchTemplateTagSpecificationList", + "documentation":"

The tags.

", + "locationName":"tagSpecificationSet" + }, + "ElasticGpuSpecifications":{ + "shape":"ElasticGpuSpecificationResponseList", + "documentation":"

The elastic GPU specification.

", + "locationName":"elasticGpuSpecificationSet" + }, + "ElasticInferenceAccelerators":{ + "shape":"LaunchTemplateElasticInferenceAcceleratorResponseList", + "documentation":"

The elastic inference accelerator for the instance.

", + "locationName":"elasticInferenceAcceleratorSet" + }, + "SecurityGroupIds":{ + "shape":"ValueStringList", + "documentation":"

The security group IDs.

", + "locationName":"securityGroupIdSet" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "documentation":"

The security group names.

", + "locationName":"securityGroupSet" + }, + "InstanceMarketOptions":{ + "shape":"LaunchTemplateInstanceMarketOptions", + "documentation":"

The market (purchasing) option for the instances.

", + "locationName":"instanceMarketOptions" + }, + "CreditSpecification":{ + "shape":"CreditSpecification", + "documentation":"

The credit option for CPU usage of the instance.

", + "locationName":"creditSpecification" + }, + "CpuOptions":{ + "shape":"LaunchTemplateCpuOptions", + "documentation":"

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"cpuOptions" + }, + "CapacityReservationSpecification":{ + "shape":"LaunchTemplateCapacityReservationSpecificationResponse", + "documentation":"

Information about the Capacity Reservation targeting option.

", + "locationName":"capacityReservationSpecification" + }, + "LicenseSpecifications":{ + "shape":"LaunchTemplateLicenseList", + "documentation":"

The license configurations.

", + "locationName":"licenseSet" + }, + "HibernationOptions":{ + "shape":"LaunchTemplateHibernationOptions", + "documentation":"

Indicates whether an instance is configured for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

", + "locationName":"hibernationOptions" + } + }, + "documentation":"

The information for a launch template.

" + }, + "RestorableByStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RestoreAddressToClassicRequest":{ + "type":"structure", + "required":["PublicIp"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + } + } + }, + "RestoreAddressToClassicResult":{ + "type":"structure", + "members":{ + "PublicIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

", + "locationName":"publicIp" + }, + "Status":{ + "shape":"Status", + "documentation":"

The move status for the IP address.

", + "locationName":"status" + } + } + }, + "RevokeClientVpnIngressRequest":{ + "type":"structure", + "required":[ + "ClientVpnEndpointId", + "TargetNetworkCidr" + ], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint with which the authorization rule is associated.

" + }, + "TargetNetworkCidr":{ + "shape":"String", + "documentation":"

The IPv4 address range, in CIDR notation, of the network for which access is being removed.

" + }, + "AccessGroupId":{ + "shape":"String", + "documentation":"

The ID of the Active Directory group for which to revoke access.

" + }, + "RevokeAllGroups":{ + "shape":"Boolean", + "documentation":"

Indicates whether access should be revoked for all clients.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "RevokeClientVpnIngressResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ClientVpnAuthorizationRuleStatus", + "documentation":"

The current state of the authorization rule.

", + "locationName":"status" + } + } + }, + "RevokeSecurityGroupEgressRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.

", + "locationName":"ipPermissions" + }, + "CidrIp":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify the CIDR.

", + "locationName":"cidrIp" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

Not supported. Use a set of IP permissions to specify the port.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify the protocol name or number.

", + "locationName":"ipProtocol" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

Not supported. Use a set of IP permissions to specify the port.

", + "locationName":"toPort" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName":"sourceSecurityGroupName" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

Not supported. Use a set of IP permissions to specify a destination security group.

", + "locationName":"sourceSecurityGroupOwnerId" + } + } + }, + "RevokeSecurityGroupIngressRequest":{ + "type":"structure", + "members":{ + "CidrIp":{ + "shape":"String", + "documentation":"

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

" + }, + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.

" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

" + }, + "SourceSecurityGroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "SourceSecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "Route":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR block used for the destination match.

", + "locationName":"destinationCidrBlock" + }, + "DestinationIpv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block used for the destination match.

", + "locationName":"destinationIpv6CidrBlock" + }, + "DestinationPrefixListId":{ + "shape":"String", + "documentation":"

The prefix of the AWS service.

", + "locationName":"destinationPrefixListId" + }, + "EgressOnlyInternetGatewayId":{ + "shape":"String", + "documentation":"

The ID of the egress-only internet gateway.

", + "locationName":"egressOnlyInternetGatewayId" + }, + "GatewayId":{ + "shape":"String", + "documentation":"

The ID of a gateway attached to your VPC.

", + "locationName":"gatewayId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of a NAT instance in your VPC.

", + "locationName":"instanceId" + }, + "InstanceOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the instance.

", + "locationName":"instanceOwnerId" + }, + "NatGatewayId":{ + "shape":"String", + "documentation":"

The ID of a NAT gateway.

", + "locationName":"natGatewayId" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of a transit gateway.

", + "locationName":"transitGatewayId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "Origin":{ + "shape":"RouteOrigin", + "documentation":"

Describes how the route was created.

  • CreateRouteTable - The route was automatically created when the route table was created.

  • CreateRoute - The route was manually added to the route table.

  • EnableVgwRoutePropagation - The route was propagated by route propagation.

", + "locationName":"origin" + }, + "State":{ + "shape":"RouteState", + "documentation":"

The state of the route. The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).

", + "locationName":"state" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of a VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a route in a route table.

" + }, + "RouteList":{ + "type":"list", + "member":{ + "shape":"Route", + "locationName":"item" + } + }, + "RouteOrigin":{ + "type":"string", + "enum":[ + "CreateRouteTable", + "CreateRoute", + "EnableVgwRoutePropagation" + ] + }, + "RouteState":{ + "type":"string", + "enum":[ + "active", + "blackhole" + ] + }, + "RouteTable":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"RouteTableAssociationList", + "documentation":"

The associations between the route table and one or more subnets.

", + "locationName":"associationSet" + }, + "PropagatingVgws":{ + "shape":"PropagatingVgwList", + "documentation":"

Any virtual private gateway (VGW) propagating routes.

", + "locationName":"propagatingVgwSet" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "Routes":{ + "shape":"RouteList", + "documentation":"

The routes in the route table.

", + "locationName":"routeSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the route table.

", + "locationName":"ownerId" + } + }, + "documentation":"

Describes a route table.

" + }, + "RouteTableAssociation":{ + "type":"structure", + "members":{ + "Main":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the main route table.

", + "locationName":"main" + }, + "RouteTableAssociationId":{ + "shape":"String", + "documentation":"

The ID of the association between a route table and a subnet.

", + "locationName":"routeTableAssociationId" + }, + "RouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table.

", + "locationName":"routeTableId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet. A subnet ID is not returned for an implicit association.

", + "locationName":"subnetId" + } + }, + "documentation":"

Describes an association between a route table and a subnet.

" + }, + "RouteTableAssociationId":{"type":"string"}, + "RouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"RouteTableAssociation", + "locationName":"item" + } + }, + "RouteTableGatewayId":{"type":"string"}, + "RouteTableId":{"type":"string"}, + "RouteTableList":{ + "type":"list", + "member":{ + "shape":"RouteTable", + "locationName":"item" + } + }, + "RuleAction":{ + "type":"string", + "enum":[ + "allow", + "deny" + ] + }, + "RunInstancesMonitoringEnabled":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

", + "locationName":"enabled" + } + }, + "documentation":"

Describes the monitoring of an instance.

" + }, + "RunInstancesRequest":{ + "type":"structure", + "required":[ + "MaxCount", + "MinCount" + ], + "members":{ + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingRequestList", + "documentation":"

The block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

" + }, + "Ipv6Addresses":{ + "shape":"InstanceIpv6AddressList", + "documentation":"

[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

You cannot specify this option and the network interfaces option in the same request.

", + "locationName":"Ipv6Address" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.

If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.

" + }, + "MaxCount":{ + "shape":"Integer", + "documentation":"

The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.

" + }, + "MinCount":{ + "shape":"Integer", + "documentation":"

The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.

Constraints: Between 1 and the maximum number you're allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.

" + }, + "Monitoring":{ + "shape":"RunInstancesMonitoringEnabled", + "documentation":"

Specifies whether detailed monitoring is enabled for the instance.

" + }, + "Placement":{ + "shape":"Placement", + "documentation":"

The placement for the instance.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.

We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud User Guide.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdStringList", + "documentation":"

The IDs of the security groups. You can create a security group using CreateSecurityGroup.

If you specify a network interface, you must specify any security groups as part of the network interface.

", + "locationName":"SecurityGroupId" + }, + "SecurityGroups":{ + "shape":"SecurityGroupStringList", + "documentation":"

[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.

If you specify a network interface, you must specify any security groups as part of the network interface.

Default: Amazon EC2 uses the default security group.

", + "locationName":"SecurityGroup" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

[EC2-VPC] The ID of the subnet to launch the instance into.

If you specify a network interface, you must specify any subnets as part of the network interface.

" + }, + "UserData":{ + "shape":"String", + "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Maximum 64 ASCII characters

", + "locationName":"clientToken" + }, + "DisableApiTermination":{ + "shape":"Boolean", + "documentation":"

If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.

Default: false

", + "locationName":"disableApiTermination" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "InstanceInitiatedShutdownBehavior":{ + "shape":"ShutdownBehavior", + "documentation":"

Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).

Default: stop

", + "locationName":"instanceInitiatedShutdownBehavior" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups and subnets as part of the network interface.

", + "locationName":"networkInterface" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.

Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.

You cannot specify this option and the network interfaces option in the same request.

", + "locationName":"privateIpAddress" + }, + "ElasticGpuSpecification":{ + "shape":"ElasticGpuSpecifications", + "documentation":"

An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ElasticInferenceAccelerators":{ + "shape":"ElasticInferenceAccelerators", + "documentation":"

An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.

", + "locationName":"ElasticInferenceAccelerator" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.

", + "locationName":"TagSpecification" + }, + "LaunchTemplate":{ + "shape":"LaunchTemplateSpecification", + "documentation":"

The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.

" + }, + "InstanceMarketOptions":{ + "shape":"InstanceMarketOptionsRequest", + "documentation":"

The market (purchasing) option for the instances.

For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

" + }, + "CreditSpecification":{ + "shape":"CreditSpecificationRequest", + "documentation":"

The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3 instances)

" + }, + "CpuOptions":{ + "shape":"CpuOptionsRequest", + "documentation":"

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

" + }, + "CapacityReservationSpecification":{ + "shape":"CapacityReservationSpecification", + "documentation":"

Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

" + }, + "HibernationOptions":{ + "shape":"HibernationOptionsRequest", + "documentation":"

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + }, + "LicenseSpecifications":{ + "shape":"LicenseSpecificationListRequest", + "documentation":"

The license configurations.

", + "locationName":"LicenseSpecification" + } + } + }, + "RunScheduledInstancesRequest":{ + "type":"structure", + "required":[ + "LaunchSpecification", + "ScheduledInstanceId" + ], + "members":{ + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

", + "idempotencyToken":true + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

Default: 1

" + }, + "LaunchSpecification":{ + "shape":"ScheduledInstancesLaunchSpecification", + "documentation":"

The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

" + }, + "ScheduledInstanceId":{ + "shape":"ScheduledInstanceId", + "documentation":"

The Scheduled Instance ID.

" + } + }, + "documentation":"

Contains the parameters for RunScheduledInstances.

" + }, + "RunScheduledInstancesResult":{ + "type":"structure", + "members":{ + "InstanceIdSet":{ + "shape":"InstanceIdSet", + "documentation":"

The IDs of the newly launched instances.

", + "locationName":"instanceIdSet" + } + }, + "documentation":"

Contains the output of RunScheduledInstances.

" + }, + "S3Storage":{ + "type":"structure", + "members":{ + "AWSAccessKeyId":{ + "shape":"String", + "documentation":"

The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.

" + }, + "Bucket":{ + "shape":"String", + "documentation":"

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

", + "locationName":"bucket" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The beginning of the file name of the AMI.

", + "locationName":"prefix" + }, + "UploadPolicy":{ + "shape":"Blob", + "documentation":"

An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.

", + "locationName":"uploadPolicy" + }, + "UploadPolicySignature":{ + "shape":"String", + "documentation":"

The signature of the JSON document.

", + "locationName":"uploadPolicySignature" + } + }, + "documentation":"

Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.

" + }, + "ScheduledInstance":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "CreateDate":{ + "shape":"DateTime", + "documentation":"

The date when the Scheduled Instance was purchased.

", + "locationName":"createDate" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances.

", + "locationName":"instanceCount" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "NextSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time for the next schedule to start.

", + "locationName":"nextSlotStartTime" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "PreviousSlotEndTime":{ + "shape":"DateTime", + "documentation":"

The time that the previous schedule ended or will end.

", + "locationName":"previousSlotEndTime" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "ScheduledInstanceId":{ + "shape":"String", + "documentation":"

The Scheduled Instance ID.

", + "locationName":"scheduledInstanceId" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "TermEndDate":{ + "shape":"DateTime", + "documentation":"

The end date for the Scheduled Instance.

", + "locationName":"termEndDate" + }, + "TermStartDate":{ + "shape":"DateTime", + "documentation":"

The start date for the Scheduled Instance.

", + "locationName":"termStartDate" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + } + }, + "documentation":"

Describes a Scheduled Instance.

" + }, + "ScheduledInstanceAvailability":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "AvailableInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of available instances.

", + "locationName":"availableInstanceCount" + }, + "FirstSlotStartTime":{ + "shape":"DateTime", + "documentation":"

The time period for the first schedule to start.

", + "locationName":"firstSlotStartTime" + }, + "HourlyPrice":{ + "shape":"String", + "documentation":"

The hourly price for a single instance.

", + "locationName":"hourlyPrice" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

", + "locationName":"instanceType" + }, + "MaxTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The maximum term. The only possible value is 365 days.

", + "locationName":"maxTermDurationInDays" + }, + "MinTermDurationInDays":{ + "shape":"Integer", + "documentation":"

The minimum term. The only possible value is 365 days.

", + "locationName":"minTermDurationInDays" + }, + "NetworkPlatform":{ + "shape":"String", + "documentation":"

The network platform (EC2-Classic or EC2-VPC).

", + "locationName":"networkPlatform" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform (Linux/UNIX or Windows).

", + "locationName":"platform" + }, + "PurchaseToken":{ + "shape":"String", + "documentation":"

The purchase token. This token expires in two hours.

", + "locationName":"purchaseToken" + }, + "Recurrence":{ + "shape":"ScheduledInstanceRecurrence", + "documentation":"

The schedule recurrence.

", + "locationName":"recurrence" + }, + "SlotDurationInHours":{ + "shape":"Integer", + "documentation":"

The number of hours in the schedule.

", + "locationName":"slotDurationInHours" + }, + "TotalScheduledInstanceHours":{ + "shape":"Integer", + "documentation":"

The total number of hours for a single instance for the entire term.

", + "locationName":"totalScheduledInstanceHours" + } + }, + "documentation":"

Describes a schedule that is available for your Scheduled Instances.

" + }, + "ScheduledInstanceAvailabilitySet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstanceAvailability", + "locationName":"item" + } + }, + "ScheduledInstanceId":{"type":"string"}, + "ScheduledInstanceIdRequestSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ScheduledInstanceId" + } + }, + "ScheduledInstanceRecurrence":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

", + "locationName":"frequency" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.

", + "locationName":"interval" + }, + "OccurrenceDaySet":{ + "shape":"OccurrenceDaySet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).

", + "locationName":"occurrenceDaySet" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month.

", + "locationName":"occurrenceRelativeToEnd" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).

", + "locationName":"occurrenceUnit" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceRecurrenceRequest":{ + "type":"structure", + "members":{ + "Frequency":{ + "shape":"String", + "documentation":"

The frequency (Daily, Weekly, or Monthly).

" + }, + "Interval":{ + "shape":"Integer", + "documentation":"

The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

" + }, + "OccurrenceDays":{ + "shape":"OccurrenceDayRequestSet", + "documentation":"

The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

", + "locationName":"OccurrenceDay" + }, + "OccurrenceRelativeToEnd":{ + "shape":"Boolean", + "documentation":"

Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

" + }, + "OccurrenceUnit":{ + "shape":"String", + "documentation":"

The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

" + } + }, + "documentation":"

Describes the recurring schedule for a Scheduled Instance.

" + }, + "ScheduledInstanceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstance", + "locationName":"item" + } + }, + "ScheduledInstancesBlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name (for example, /dev/sdh or xvdh).

" + }, + "Ebs":{ + "shape":"ScheduledInstancesEbs", + "documentation":"

Parameters used to set up EBS volumes automatically when the instance is launched.

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the block device mapping of the AMI.

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

" + } + }, + "documentation":"

Describes a block device mapping for a Scheduled Instance.

" + }, + "ScheduledInstancesBlockDeviceMappingSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesBlockDeviceMapping", + "locationName":"BlockDeviceMapping" + } + }, + "ScheduledInstancesEbs":{ + "type":"structure", + "members":{ + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is deleted on instance termination.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.

Condition: This parameter is required for requests to create io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.

Default: gp2

" + } + }, + "documentation":"

Describes an EBS volume for a Scheduled Instance.

" + }, + "ScheduledInstancesIamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN).

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + } + }, + "documentation":"

Describes an IAM instance profile for a Scheduled Instance.

" + }, + "ScheduledInstancesIpv6Address":{ + "type":"structure", + "members":{ + "Ipv6Address":{ + "shape":"Ipv6Address", + "documentation":"

The IPv6 address.

" + } + }, + "documentation":"

Describes an IPv6 address.

" + }, + "ScheduledInstancesIpv6AddressList":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesIpv6Address", + "locationName":"Ipv6Address" + } + }, + "ScheduledInstancesLaunchSpecification":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "BlockDeviceMappings":{ + "shape":"ScheduledInstancesBlockDeviceMappingSet", + "documentation":"

The block device mapping entries.

", + "locationName":"BlockDeviceMapping" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.

Default: false

" + }, + "IamInstanceProfile":{ + "shape":"ScheduledInstancesIamInstanceProfile", + "documentation":"

The IAM instance profile.

" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the Amazon Machine Image (AMI).

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type.

" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

" + }, + "Monitoring":{ + "shape":"ScheduledInstancesMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

" + }, + "NetworkInterfaces":{ + "shape":"ScheduledInstancesNetworkInterfaceSet", + "documentation":"

The network interfaces.

", + "locationName":"NetworkInterface" + }, + "Placement":{ + "shape":"ScheduledInstancesPlacement", + "documentation":"

The placement information.

" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk.

" + }, + "SecurityGroupIds":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of the security groups.

", + "locationName":"SecurityGroupId" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet in which to launch the instances.

" + }, + "UserData":{ + "shape":"String", + "documentation":"

The base64-encoded MIME user data.

" + } + }, + "documentation":"

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.

" + }, + "ScheduledInstancesMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether monitoring is enabled.

" + } + }, + "documentation":"

Describes whether monitoring is enabled for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterface":{ + "type":"structure", + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether to delete the interface when the instance is terminated.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

" + }, + "DeviceIndex":{ + "shape":"Integer", + "documentation":"

The index of the device for the network interface attachment.

" + }, + "Groups":{ + "shape":"ScheduledInstancesSecurityGroupIdSet", + "documentation":"

The IDs of the security groups.

", + "locationName":"Group" + }, + "Ipv6AddressCount":{ + "shape":"Integer", + "documentation":"

The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.

" + }, + "Ipv6Addresses":{ + "shape":"ScheduledInstancesIpv6AddressList", + "documentation":"

The specific IPv6 addresses from the subnet range.

", + "locationName":"Ipv6Address" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IPv4 address of the network interface within the subnet.

" + }, + "PrivateIpAddressConfigs":{ + "shape":"PrivateIpAddressConfigSet", + "documentation":"

The private IPv4 addresses.

", + "locationName":"PrivateIpAddressConfig" + }, + "SecondaryPrivateIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of secondary private IPv4 addresses.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

" + } + }, + "documentation":"

Describes a network interface for a Scheduled Instance.

" + }, + "ScheduledInstancesNetworkInterfaceSet":{ + "type":"list", + "member":{ + "shape":"ScheduledInstancesNetworkInterface", + "locationName":"NetworkInterface" + } + }, + "ScheduledInstancesPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

" + } + }, + "documentation":"

Describes the placement for a Scheduled Instance.

" + }, + "ScheduledInstancesPrivateIpAddressConfig":{ + "type":"structure", + "members":{ + "Primary":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The IPv4 address.

" + } + }, + "documentation":"

Describes a private IPv4 address for a Scheduled Instance.

" + }, + "ScheduledInstancesSecurityGroupIdSet":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SearchTransitGatewayRoutesRequest":{ + "type":"structure", + "required":[ + "TransitGatewayRouteTableId", + "Filters" + ], + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"TransitGatewayRouteTableId", + "documentation":"

The ID of the transit gateway route table.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters. The possible values are:

  • attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.

  • attachment.resource-id - The resource id of the transit gateway attachment.

  • attachment.resource-type - The attachment resource type (vpc | vpn).

  • route-search.exact-match - The exact match of the specified filter.

  • route-search.longest-prefix-match - The longest prefix that matches the route.

  • route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.

  • route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.

  • state - The state of the route (active | blackhole).

  • type - The type of route (propagated | static).

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"TransitGatewayMaxResults", + "documentation":"

The maximum number of routes to return.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "SearchTransitGatewayRoutesResult":{ + "type":"structure", + "members":{ + "Routes":{ + "shape":"TransitGatewayRouteList", + "documentation":"

Information about the routes.

", + "locationName":"routeSet" + }, + "AdditionalRoutesAvailable":{ + "shape":"Boolean", + "documentation":"

Indicates whether there are additional routes available.

", + "locationName":"additionalRoutesAvailable" + } + } + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the security group.

", + "locationName":"groupDescription" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The inbound rules associated with the security group.

", + "locationName":"ipPermissions" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the security group.

", + "locationName":"ownerId" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "IpPermissionsEgress":{ + "shape":"IpPermissionList", + "documentation":"

[VPC only] The outbound rules associated with the security group.

", + "locationName":"ipPermissionsEgress" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the security group.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

[VPC only] The ID of the VPC for the security group.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a security group

" + }, + "SecurityGroupIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupIdentifier":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + } + }, + "documentation":"

Describes a security group.

" + }, + "SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"SecurityGroup", + "locationName":"item" + } + }, + "SecurityGroupReference":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

The ID of your security group.

", + "locationName":"groupId" + }, + "ReferencingVpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC with the referencing security group.

", + "locationName":"referencingVpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC with a security group that references your security group.

" + }, + "SecurityGroupReferences":{ + "type":"list", + "member":{ + "shape":"SecurityGroupReference", + "locationName":"item" + } + }, + "SecurityGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroup" + } + }, + "SendDiagnosticInterruptRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "SensitiveUserData":{ + "type":"string", + "sensitive":true + }, + "ServiceConfiguration":{ + "type":"structure", + "members":{ + "ServiceType":{ + "shape":"ServiceTypeDetailSet", + "documentation":"

The type of service.

", + "locationName":"serviceType" + }, + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the service.

", + "locationName":"serviceId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the service.

", + "locationName":"serviceName" + }, + "ServiceState":{ + "shape":"ServiceState", + "documentation":"

The service state.

", + "locationName":"serviceState" + }, + "AvailabilityZones":{ + "shape":"ValueStringList", + "documentation":"

In the Availability Zones in which the service is available.

", + "locationName":"availabilityZoneSet" + }, + "AcceptanceRequired":{ + "shape":"Boolean", + "documentation":"

Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.

", + "locationName":"acceptanceRequired" + }, + "ManagesVpcEndpoints":{ + "shape":"Boolean", + "documentation":"

Indicates whether the service manages it's VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

", + "locationName":"managesVpcEndpoints" + }, + "NetworkLoadBalancerArns":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.

", + "locationName":"networkLoadBalancerArnSet" + }, + "BaseEndpointDnsNames":{ + "shape":"ValueStringList", + "documentation":"

The DNS names for the service.

", + "locationName":"baseEndpointDnsNameSet" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name for the service.

", + "locationName":"privateDnsName" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the service.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a service configuration for a VPC endpoint service.

" + }, + "ServiceConfigurationSet":{ + "type":"list", + "member":{ + "shape":"ServiceConfiguration", + "locationName":"item" + } + }, + "ServiceDetail":{ + "type":"structure", + "members":{ + "ServiceName":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the service.

", + "locationName":"serviceName" + }, + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the endpoint service.

", + "locationName":"serviceId" + }, + "ServiceType":{ + "shape":"ServiceTypeDetailSet", + "documentation":"

The type of service.

", + "locationName":"serviceType" + }, + "AvailabilityZones":{ + "shape":"ValueStringList", + "documentation":"

The Availability Zones in which the service is available.

", + "locationName":"availabilityZoneSet" + }, + "Owner":{ + "shape":"String", + "documentation":"

The AWS account ID of the service owner.

", + "locationName":"owner" + }, + "BaseEndpointDnsNames":{ + "shape":"ValueStringList", + "documentation":"

The DNS names for the service.

", + "locationName":"baseEndpointDnsNameSet" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name for the service.

", + "locationName":"privateDnsName" + }, + "VpcEndpointPolicySupported":{ + "shape":"Boolean", + "documentation":"

Indicates whether the service supports endpoint policies.

", + "locationName":"vpcEndpointPolicySupported" + }, + "AcceptanceRequired":{ + "shape":"Boolean", + "documentation":"

Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.

", + "locationName":"acceptanceRequired" + }, + "ManagesVpcEndpoints":{ + "shape":"Boolean", + "documentation":"

Indicates whether the service manages it's VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.

", + "locationName":"managesVpcEndpoints" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the service.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a VPC endpoint service.

" + }, + "ServiceDetailSet":{ + "type":"list", + "member":{ + "shape":"ServiceDetail", + "locationName":"item" + } + }, + "ServiceId":{"type":"string"}, + "ServiceState":{ + "type":"string", + "enum":[ + "Pending", + "Available", + "Deleting", + "Deleted", + "Failed" + ] + }, + "ServiceType":{ + "type":"string", + "enum":[ + "Interface", + "Gateway" + ] + }, + "ServiceTypeDetail":{ + "type":"structure", + "members":{ + "ServiceType":{ + "shape":"ServiceType", + "documentation":"

The type of service.

", + "locationName":"serviceType" + } + }, + "documentation":"

Describes the type of service for a VPC endpoint.

" + }, + "ServiceTypeDetailSet":{ + "type":"list", + "member":{ + "shape":"ServiceTypeDetail", + "locationName":"item" + } + }, + "ShutdownBehavior":{ + "type":"string", + "enum":[ + "stop", + "terminate" + ] + }, + "SlotDateTimeRangeRequest":{ + "type":"structure", + "required":[ + "EarliestTime", + "LatestTime" + ], + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

" + }, + "SlotStartTimeRangeRequest":{ + "type":"structure", + "members":{ + "EarliestTime":{ + "shape":"DateTime", + "documentation":"

The earliest date and time, in UTC, for the Scheduled Instance to start.

" + }, + "LatestTime":{ + "shape":"DateTime", + "documentation":"

The latest date and time, in UTC, for the Scheduled Instance to start.

" + } + }, + "documentation":"

Describes the time period for a Scheduled Instance to start its first schedule.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "DataEncryptionKeyId":{ + "shape":"String", + "documentation":"

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

", + "locationName":"dataEncryptionKeyId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the snapshot.

", + "locationName":"description" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

", + "locationName":"kmsKeyId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the EBS snapshot owner.

", + "locationName":"ownerId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The progress of the snapshot, as a percentage.

", + "locationName":"progress" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

", + "locationName":"snapshotId" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the snapshot was initiated.

", + "locationName":"startTime" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

The snapshot state.

", + "locationName":"status" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

", + "locationName":"statusMessage" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

", + "locationName":"volumeId" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"volumeSize" + }, + "OwnerAlias":{ + "shape":"String", + "documentation":"

Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.

", + "locationName":"ownerAlias" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the snapshot.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a snapshot.

" + }, + "SnapshotAttributeName":{ + "type":"string", + "enum":[ + "productCodes", + "createVolumePermission" + ] + }, + "SnapshotDetail":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the snapshot.

", + "locationName":"description" + }, + "DeviceName":{ + "shape":"String", + "documentation":"

The block device mapping for the snapshot.

", + "locationName":"deviceName" + }, + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of progress for the task.

", + "locationName":"progress" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status of the snapshot creation.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the snapshot creation.

", + "locationName":"statusMessage" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL used to access the disk image.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + } + }, + "documentation":"

Describes the snapshot created from the imported disk.

" + }, + "SnapshotDetailList":{ + "type":"list", + "member":{ + "shape":"SnapshotDetail", + "locationName":"item" + } + }, + "SnapshotDiskContainer":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the disk image being imported.

" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image being imported.

Valid values: VHD | VMDK

" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

" + }, + "UserBucket":{ + "shape":"UserBucket", + "documentation":"

The S3 bucket for the disk image.

" + } + }, + "documentation":"

The disk container object for the import snapshot request.

" + }, + "SnapshotId":{"type":"string"}, + "SnapshotIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotId" + } + }, + "SnapshotInfo":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

Description specified by the CreateSnapshotRequest that has been applied to all snapshots.

", + "locationName":"description" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Tags associated with this snapshot.

", + "locationName":"tagSet" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

Source volume from which this snapshot was created.

", + "locationName":"volumeId" + }, + "State":{ + "shape":"SnapshotState", + "documentation":"

Current state of the snapshot.

", + "locationName":"state" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

Size of the volume from which this snapshot was created.

", + "locationName":"volumeSize" + }, + "StartTime":{ + "shape":"MillisecondDateTime", + "documentation":"

Time this snapshot was started. This is the same for all snapshots initiated by the same request.

", + "locationName":"startTime" + }, + "Progress":{ + "shape":"String", + "documentation":"

Progress this snapshot has made towards completing.

", + "locationName":"progress" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

Account id used when creating this snapshot.

", + "locationName":"ownerId" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

Snapshot id that can be used to describe this snapshot.

", + "locationName":"snapshotId" + } + }, + "documentation":"

Information about a snapshot.

" + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"item" + } + }, + "SnapshotSet":{ + "type":"list", + "member":{ + "shape":"SnapshotInfo", + "locationName":"item" + } + }, + "SnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error" + ] + }, + "SnapshotTaskDetail":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the snapshot.

", + "locationName":"description" + }, + "DiskImageSize":{ + "shape":"Double", + "documentation":"

The size of the disk in the snapshot, in GiB.

", + "locationName":"diskImageSize" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the snapshot is encrypted.

", + "locationName":"encrypted" + }, + "Format":{ + "shape":"String", + "documentation":"

The format of the disk image from which the snapshot is created.

", + "locationName":"format" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to create the encrypted snapshot.

", + "locationName":"kmsKeyId" + }, + "Progress":{ + "shape":"String", + "documentation":"

The percentage of completion for the import snapshot task.

", + "locationName":"progress" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID of the disk being imported.

", + "locationName":"snapshotId" + }, + "Status":{ + "shape":"String", + "documentation":"

A brief status for the import snapshot task.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A detailed status message for the import snapshot task.

", + "locationName":"statusMessage" + }, + "Url":{ + "shape":"String", + "documentation":"

The URL of the disk image from which the snapshot is created.

", + "locationName":"url" + }, + "UserBucket":{ + "shape":"UserBucketDetails", + "documentation":"

The S3 bucket for the disk image.

", + "locationName":"userBucket" + } + }, + "documentation":"

Details about the import snapshot task.

" + }, + "SpotAllocationStrategy":{ + "type":"string", + "enum":[ + "lowest-price", + "diversified", + "capacity-optimized" + ] + }, + "SpotDatafeedSubscription":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket where the Spot Instance data feed is located.

", + "locationName":"bucket" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the account.

", + "locationName":"ownerId" + }, + "Prefix":{ + "shape":"String", + "documentation":"

The prefix that is prepended to data feed files.

", + "locationName":"prefix" + }, + "State":{ + "shape":"DatafeedSubscriptionState", + "documentation":"

The state of the Spot Instance data feed subscription.

", + "locationName":"state" + } + }, + "documentation":"

Describes the data feed for a Spot Instance.

" + }, + "SpotFleetLaunchSpecification":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"GroupIdentifierList", + "documentation":"

One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.

", + "locationName":"groupSet" + }, + "AddressingType":{ + "shape":"String", + "documentation":"

Deprecated.

", + "locationName":"addressingType" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappingList", + "documentation":"

One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.

", + "locationName":"blockDeviceMapping" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

Default: false

", + "locationName":"ebsOptimized" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfileSpecification", + "documentation":"

The IAM instance profile.

", + "locationName":"iamInstanceProfile" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The ID of the AMI.

", + "locationName":"imageId" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "KernelId":{ + "shape":"String", + "documentation":"

The ID of the kernel.

", + "locationName":"kernelId" + }, + "KeyName":{ + "shape":"String", + "documentation":"

The name of the key pair.

", + "locationName":"keyName" + }, + "Monitoring":{ + "shape":"SpotFleetMonitoring", + "documentation":"

Enable or disable monitoring for the instances.

", + "locationName":"monitoring" + }, + "NetworkInterfaces":{ + "shape":"InstanceNetworkInterfaceSpecificationList", + "documentation":"

One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.

", + "locationName":"networkInterfaceSet" + }, + "Placement":{ + "shape":"SpotPlacement", + "documentation":"

The placement information.

", + "locationName":"placement" + }, + "RamdiskId":{ + "shape":"String", + "documentation":"

The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.

", + "locationName":"ramdiskId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance. If this value is not specified, the default is the Spot price specified for the fleet. To determine the Spot price per unit hour, divide the Spot price by the value of WeightedCapacity.

", + "locationName":"spotPrice" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, \"subnet-1234abcdeexample1, subnet-0987cdef6example2\".

", + "locationName":"subnetId" + }, + "UserData":{ + "shape":"String", + "documentation":"

The Base64-encoded user data that instances use when starting up.

", + "locationName":"userData" + }, + "WeightedCapacity":{ + "shape":"Double", + "documentation":"

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.

If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.

", + "locationName":"weightedCapacity" + }, + "TagSpecifications":{ + "shape":"SpotFleetTagSpecificationList", + "documentation":"

The tags to apply during creation.

", + "locationName":"tagSpecificationSet" + } + }, + "documentation":"

Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.

" + }, + "SpotFleetMonitoring":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Enables monitoring for the instance.

Default: false

", + "locationName":"enabled" + } + }, + "documentation":"

Describes whether monitoring is enabled.

" + }, + "SpotFleetRequestConfig":{ + "type":"structure", + "members":{ + "ActivityStatus":{ + "shape":"ActivityStatus", + "documentation":"

The progress of the Spot Fleet request. If there is an error, the status is error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.

", + "locationName":"activityStatus" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The creation date and time of the request.

", + "locationName":"createTime" + }, + "SpotFleetRequestConfig":{ + "shape":"SpotFleetRequestConfigData", + "documentation":"

The configuration of the Spot Fleet request.

", + "locationName":"spotFleetRequestConfig" + }, + "SpotFleetRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Fleet request.

", + "locationName":"spotFleetRequestId" + }, + "SpotFleetRequestState":{ + "shape":"BatchState", + "documentation":"

The state of the Spot Fleet request.

", + "locationName":"spotFleetRequestState" + } + }, + "documentation":"

Describes a Spot Fleet request.

" + }, + "SpotFleetRequestConfigData":{ + "type":"structure", + "required":[ + "IamFleetRole", + "TargetCapacity" + ], + "members":{ + "AllocationStrategy":{ + "shape":"AllocationStrategy", + "documentation":"

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

", + "locationName":"allocationStrategy" + }, + "OnDemandAllocationStrategy":{ + "shape":"OnDemandAllocationStrategy", + "documentation":"

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

", + "locationName":"onDemandAllocationStrategy" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

", + "locationName":"clientToken" + }, + "ExcessCapacityTerminationPolicy":{ + "shape":"ExcessCapacityTerminationPolicy", + "documentation":"

Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

", + "locationName":"excessCapacityTerminationPolicy" + }, + "FulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

", + "locationName":"fulfilledCapacity" + }, + "OnDemandFulfilledCapacity":{ + "shape":"Double", + "documentation":"

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

", + "locationName":"onDemandFulfilledCapacity" + }, + "IamFleetRole":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.

", + "locationName":"iamFleetRole" + }, + "LaunchSpecifications":{ + "shape":"LaunchSpecsList", + "documentation":"

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

", + "locationName":"launchSpecifications" + }, + "LaunchTemplateConfigs":{ + "shape":"LaunchTemplateConfigList", + "documentation":"

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

", + "locationName":"launchTemplateConfigs" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

", + "locationName":"spotPrice" + }, + "TargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

", + "locationName":"targetCapacity" + }, + "OnDemandTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

", + "locationName":"onDemandTargetCapacity" + }, + "OnDemandMaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

", + "locationName":"onDemandMaxTotalPrice" + }, + "SpotMaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

", + "locationName":"spotMaxTotalPrice" + }, + "TerminateInstancesWithExpiration":{ + "shape":"Boolean", + "documentation":"

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

", + "locationName":"terminateInstancesWithExpiration" + }, + "Type":{ + "shape":"FleetType", + "documentation":"

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

", + "locationName":"validUntil" + }, + "ReplaceUnhealthyInstances":{ + "shape":"Boolean", + "documentation":"

Indicates whether Spot Fleet should replace unhealthy instances.

", + "locationName":"replaceUnhealthyInstances" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

", + "locationName":"instanceInterruptionBehavior" + }, + "LoadBalancersConfig":{ + "shape":"LoadBalancersConfig", + "documentation":"

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

", + "locationName":"loadBalancersConfig" + }, + "InstancePoolsToUseCount":{ + "shape":"Integer", + "documentation":"

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

", + "locationName":"instancePoolsToUseCount" + } + }, + "documentation":"

Describes the configuration of a Spot Fleet request.

" + }, + "SpotFleetRequestConfigSet":{ + "type":"list", + "member":{ + "shape":"SpotFleetRequestConfig", + "locationName":"item" + } + }, + "SpotFleetRequestId":{"type":"string"}, + "SpotFleetTagSpecification":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource. Currently, the only resource type that is supported is instance.

", + "locationName":"resourceType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags.

", + "locationName":"tag" + } + }, + "documentation":"

The tags for a Spot Fleet resource.

" + }, + "SpotFleetTagSpecificationList":{ + "type":"list", + "member":{ + "shape":"SpotFleetTagSpecification", + "locationName":"item" + } + }, + "SpotInstanceInterruptionBehavior":{ + "type":"string", + "enum":[ + "hibernate", + "stop", + "terminate" + ] + }, + "SpotInstanceRequest":{ + "type":"structure", + "members":{ + "ActualBlockHourlyPrice":{ + "shape":"String", + "documentation":"

If you specified a duration and your Spot Instance request was fulfilled, this is the fixed hourly price in effect for the Spot Instance while it runs.

", + "locationName":"actualBlockHourlyPrice" + }, + "AvailabilityZoneGroup":{ + "shape":"String", + "documentation":"

The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

", + "locationName":"availabilityZoneGroup" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The duration for the Spot Instance, in minutes.

", + "locationName":"blockDurationMinutes" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"createTime" + }, + "Fault":{ + "shape":"SpotInstanceStateFault", + "documentation":"

The fault codes for the Spot Instance request, if any.

", + "locationName":"fault" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID, if an instance has been launched to fulfill the Spot Instance request.

", + "locationName":"instanceId" + }, + "LaunchGroup":{ + "shape":"String", + "documentation":"

The instance launch group. Launch groups are Spot Instances that launch together and terminate together.

", + "locationName":"launchGroup" + }, + "LaunchSpecification":{ + "shape":"LaunchSpecification", + "documentation":"

Additional information for launching instances.

", + "locationName":"launchSpecification" + }, + "LaunchedAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the request is launched.

", + "locationName":"launchedAvailabilityZone" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

The product description associated with the Spot Instance.

", + "locationName":"productDescription" + }, + "SpotInstanceRequestId":{ + "shape":"String", + "documentation":"

The ID of the Spot Instance request.

", + "locationName":"spotInstanceRequestId" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per hour that you are willing to pay for a Spot Instance.

", + "locationName":"spotPrice" + }, + "State":{ + "shape":"SpotInstanceState", + "documentation":"

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

", + "locationName":"state" + }, + "Status":{ + "shape":"SpotInstanceStatus", + "documentation":"

The status code and status message describing the Spot Instance request.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "Type":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type.

", + "locationName":"type" + }, + "ValidFrom":{ + "shape":"DateTime", + "documentation":"

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

", + "locationName":"validFrom" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

", + "locationName":"validUntil" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted.

", + "locationName":"instanceInterruptionBehavior" + } + }, + "documentation":"

Describes a Spot Instance request.

" + }, + "SpotInstanceRequestIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SpotInstanceRequestId" + } + }, + "SpotInstanceRequestList":{ + "type":"list", + "member":{ + "shape":"SpotInstanceRequest", + "locationName":"item" + } + }, + "SpotInstanceState":{ + "type":"string", + "enum":[ + "open", + "active", + "closed", + "cancelled", + "failed" + ] + }, + "SpotInstanceStateFault":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the Spot Instance state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the Spot Instance state change.

", + "locationName":"message" + } + }, + "documentation":"

Describes a Spot Instance state change.

" + }, + "SpotInstanceStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The status code. For a list of status codes, see Spot Status Codes in the Amazon EC2 User Guide for Linux Instances.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The description for the status code.

", + "locationName":"message" + }, + "UpdateTime":{ + "shape":"DateTime", + "documentation":"

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"updateTime" + } + }, + "documentation":"

Describes the status of a Spot Instance request.

" + }, + "SpotInstanceType":{ + "type":"string", + "enum":[ + "one-time", + "persistent" + ] + }, + "SpotMarketOptions":{ + "type":"structure", + "members":{ + "MaxPrice":{ + "shape":"String", + "documentation":"

The maximum hourly price you're willing to pay for the Spot Instances. The default is the On-Demand price.

" + }, + "SpotInstanceType":{ + "shape":"SpotInstanceType", + "documentation":"

The Spot Instance request type. For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.

" + }, + "BlockDurationMinutes":{ + "shape":"Integer", + "documentation":"

The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).

" + }, + "ValidUntil":{ + "shape":"DateTime", + "documentation":"

The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached. The default end date is 7 days from the current date.

" + }, + "InstanceInterruptionBehavior":{ + "shape":"InstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

" + } + }, + "documentation":"

The options for Spot Instances.

" + }, + "SpotOptions":{ + "type":"structure", + "members":{ + "AllocationStrategy":{ + "shape":"SpotAllocationStrategy", + "documentation":"

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

", + "locationName":"allocationStrategy" + }, + "InstanceInterruptionBehavior":{ + "shape":"SpotInstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

", + "locationName":"instanceInterruptionBehavior" + }, + "InstancePoolsToUseCount":{ + "shape":"Integer", + "documentation":"

The number of Spot pools across which to allocate your target Spot capacity. Valid only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

", + "locationName":"instancePoolsToUseCount" + }, + "SingleInstanceType":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

", + "locationName":"singleInstanceType" + }, + "SingleAvailabilityZone":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

", + "locationName":"singleAvailabilityZone" + }, + "MinTargetCapacity":{ + "shape":"Integer", + "documentation":"

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

", + "locationName":"minTargetCapacity" + }, + "MaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for Spot Instances that you're willing to pay.

", + "locationName":"maxTotalPrice" + } + }, + "documentation":"

Describes the configuration of Spot Instances in an EC2 Fleet.

" + }, + "SpotOptionsRequest":{ + "type":"structure", + "members":{ + "AllocationStrategy":{ + "shape":"SpotAllocationStrategy", + "documentation":"

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet.

If the allocation strategy is lowest-price, EC2 Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, EC2 Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacity-optimized, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching.

" + }, + "InstanceInterruptionBehavior":{ + "shape":"SpotInstanceInterruptionBehavior", + "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

" + }, + "InstancePoolsToUseCount":{ + "shape":"Integer", + "documentation":"

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

" + }, + "SingleInstanceType":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.

" + }, + "SingleAvailabilityZone":{ + "shape":"Boolean", + "documentation":"

Indicates that the fleet launches all Spot Instances into a single Availability Zone.

" + }, + "MinTargetCapacity":{ + "shape":"Integer", + "documentation":"

The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.

" + }, + "MaxTotalPrice":{ + "shape":"String", + "documentation":"

The maximum amount per hour for Spot Instances that you're willing to pay.

" + } + }, + "documentation":"

Describes the configuration of Spot Instances in an EC2 Fleet request.

" + }, + "SpotPlacement":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, \"us-west-2a, us-west-2b\".

", + "locationName":"availabilityZone" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the placement group.

", + "locationName":"groupName" + }, + "Tenancy":{ + "shape":"Tenancy", + "documentation":"

The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.

", + "locationName":"tenancy" + } + }, + "documentation":"

Describes Spot Instance placement.

" + }, + "SpotPrice":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone.

", + "locationName":"availabilityZone" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The instance type.

", + "locationName":"instanceType" + }, + "ProductDescription":{ + "shape":"RIProductDescription", + "documentation":"

A general description of the AMI.

", + "locationName":"productDescription" + }, + "SpotPrice":{ + "shape":"String", + "documentation":"

The maximum price per hour that you are willing to pay for a Spot Instance.

", + "locationName":"spotPrice" + }, + "Timestamp":{ + "shape":"DateTime", + "documentation":"

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

", + "locationName":"timestamp" + } + }, + "documentation":"

Describes the maximum price per hour that you are willing to pay for a Spot Instance.

" + }, + "SpotPriceHistoryList":{ + "type":"list", + "member":{ + "shape":"SpotPrice", + "locationName":"item" + } + }, + "StaleIpPermission":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"fromPort" + }, + "IpProtocol":{ + "shape":"String", + "documentation":"

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

", + "locationName":"ipProtocol" + }, + "IpRanges":{ + "shape":"IpRanges", + "documentation":"

The IP ranges. Not applicable for stale security group rules.

", + "locationName":"ipRanges" + }, + "PrefixListIds":{ + "shape":"PrefixListIdSet", + "documentation":"

The prefix list IDs for an AWS service. Not applicable for stale security group rules.

", + "locationName":"prefixListIds" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

", + "locationName":"toPort" + }, + "UserIdGroupPairs":{ + "shape":"UserIdGroupPairSet", + "documentation":"

The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

", + "locationName":"groups" + } + }, + "documentation":"

Describes a stale rule in a security group.

" + }, + "StaleIpPermissionSet":{ + "type":"list", + "member":{ + "shape":"StaleIpPermission", + "locationName":"item" + } + }, + "StaleSecurityGroup":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

The description of the security group.

", + "locationName":"description" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group.

", + "locationName":"groupName" + }, + "StaleIpPermissions":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale inbound rules in the security group.

", + "locationName":"staleIpPermissions" + }, + "StaleIpPermissionsEgress":{ + "shape":"StaleIpPermissionSet", + "documentation":"

Information about the stale outbound rules in the security group.

", + "locationName":"staleIpPermissionsEgress" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the security group.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes a stale security group (a security group that contains stale rules).

" + }, + "StaleSecurityGroupSet":{ + "type":"list", + "member":{ + "shape":"StaleSecurityGroup", + "locationName":"item" + } + }, + "StartInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The IDs of the instances.

", + "locationName":"InstanceId" + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

Reserved.

", + "locationName":"additionalInfo" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "StartInstancesResult":{ + "type":"structure", + "members":{ + "StartingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about the started instances.

", + "locationName":"instancesSet" + } + } + }, + "State":{ + "type":"string", + "enum":[ + "PendingAcceptance", + "Pending", + "Available", + "Deleting", + "Deleted", + "Rejected", + "Failed", + "Expired" + ] + }, + "StateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The reason code for the state change.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The message for the state change.

  • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError: An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

  • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.

  • Client.InternalError: A client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

  • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

", + "locationName":"message" + } + }, + "documentation":"

Describes a state change.

" + }, + "Status":{ + "type":"string", + "enum":[ + "MoveInProgress", + "InVpc", + "InClassic" + ] + }, + "StatusName":{ + "type":"string", + "enum":["reachability"] + }, + "StatusType":{ + "type":"string", + "enum":[ + "passed", + "failed", + "insufficient-data", + "initializing" + ] + }, + "StopInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The IDs of the instances.

", + "locationName":"InstanceId" + }, + "Hibernate":{ + "shape":"Boolean", + "documentation":"

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.

Default: false

", + "locationName":"force" + } + } + }, + "StopInstancesResult":{ + "type":"structure", + "members":{ + "StoppingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about the stopped instances.

", + "locationName":"instancesSet" + } + } + }, + "Storage":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Storage", + "documentation":"

An Amazon S3 storage location.

" + } + }, + "documentation":"

Describes the storage location for an instance store-backed AMI.

" + }, + "StorageLocation":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket.

" + }, + "Key":{ + "shape":"String", + "documentation":"

The key.

" + } + }, + "documentation":"

Describes a storage location in Amazon S3.

" + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the subnet.

", + "locationName":"availabilityZone" + }, + "AvailabilityZoneId":{ + "shape":"String", + "documentation":"

The AZ ID of the subnet.

", + "locationName":"availabilityZoneId" + }, + "AvailableIpAddressCount":{ + "shape":"Integer", + "documentation":"

The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.

", + "locationName":"availableIpAddressCount" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR block assigned to the subnet.

", + "locationName":"cidrBlock" + }, + "DefaultForAz":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default subnet for the Availability Zone.

", + "locationName":"defaultForAz" + }, + "MapPublicIpOnLaunch":{ + "shape":"Boolean", + "documentation":"

Indicates whether instances launched in this subnet receive a public IPv4 address.

", + "locationName":"mapPublicIpOnLaunch" + }, + "State":{ + "shape":"SubnetState", + "documentation":"

The current state of the subnet.

", + "locationName":"state" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the subnet.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC the subnet is in.

", + "locationName":"vpcId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the subnet.

", + "locationName":"ownerId" + }, + "AssignIpv6AddressOnCreation":{ + "shape":"Boolean", + "documentation":"

Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.

", + "locationName":"assignIpv6AddressOnCreation" + }, + "Ipv6CidrBlockAssociationSet":{ + "shape":"SubnetIpv6CidrBlockAssociationSet", + "documentation":"

Information about the IPv6 CIDR blocks associated with the subnet.

", + "locationName":"ipv6CidrBlockAssociationSet" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the subnet.

", + "locationName":"tagSet" + }, + "SubnetArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the subnet.

", + "locationName":"subnetArn" + } + }, + "documentation":"

Describes a subnet.

" + }, + "SubnetCidrAssociationId":{"type":"string"}, + "SubnetCidrBlockState":{ + "type":"structure", + "members":{ + "State":{ + "shape":"SubnetCidrBlockStateCode", + "documentation":"

The state of a CIDR block.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A message about the status of the CIDR block, if applicable.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes the state of a CIDR block.

" + }, + "SubnetCidrBlockStateCode":{ + "type":"string", + "enum":[ + "associating", + "associated", + "disassociating", + "disassociated", + "failing", + "failed" + ] + }, + "SubnetId":{"type":"string"}, + "SubnetIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetId" + } + }, + "SubnetIpv6CidrBlockAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID for the CIDR block.

", + "locationName":"associationId" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block.

", + "locationName":"ipv6CidrBlock" + }, + "Ipv6CidrBlockState":{ + "shape":"SubnetCidrBlockState", + "documentation":"

Information about the state of the CIDR block.

", + "locationName":"ipv6CidrBlockState" + } + }, + "documentation":"

Describes an IPv6 CIDR block associated with a subnet.

" + }, + "SubnetIpv6CidrBlockAssociationSet":{ + "type":"list", + "member":{ + "shape":"SubnetIpv6CidrBlockAssociation", + "locationName":"item" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"item" + } + }, + "SubnetState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "SuccessfulInstanceCreditSpecificationItem":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + } + }, + "documentation":"

Describes the T2 or T3 instance whose credit option for CPU usage was successfully modified.

" + }, + "SuccessfulInstanceCreditSpecificationSet":{ + "type":"list", + "member":{ + "shape":"SuccessfulInstanceCreditSpecificationItem", + "locationName":"item" + } + }, + "SuccessfulQueuedPurchaseDeletion":{ + "type":"structure", + "members":{ + "ReservedInstancesId":{ + "shape":"String", + "documentation":"

The ID of the Reserved Instance.

", + "locationName":"reservedInstancesId" + } + }, + "documentation":"

Describes a Reserved Instance whose queued purchase was successfully deleted.

" + }, + "SuccessfulQueuedPurchaseDeletionSet":{ + "type":"list", + "member":{ + "shape":"SuccessfulQueuedPurchaseDeletion", + "locationName":"item" + } + }, + "SummaryStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data", + "not-applicable", + "initializing" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The tag key.

", + "locationName":"key" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag value.

", + "locationName":"value" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagDescriptionList":{ + "type":"list", + "member":{ + "shape":"TagDescription", + "locationName":"item" + } + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"item" + } + }, + "TagSpecification":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | fpga-image | instance | launch-template | snapshot | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume.

To tag a resource after it has been created, see CreateTags.

", + "locationName":"resourceType" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to apply to the resource.

", + "locationName":"Tag" + } + }, + "documentation":"

The tags to apply to a resource when the resource is being created.

" + }, + "TagSpecificationList":{ + "type":"list", + "member":{ + "shape":"TagSpecification", + "locationName":"item" + } + }, + "TargetCapacitySpecification":{ + "type":"structure", + "members":{ + "TotalTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request, filled using DefaultTargetCapacityType.

", + "locationName":"totalTargetCapacity" + }, + "OnDemandTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.

", + "locationName":"onDemandTargetCapacity" + }, + "SpotTargetCapacity":{ + "shape":"Integer", + "documentation":"

The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.

", + "locationName":"spotTargetCapacity" + }, + "DefaultTargetCapacityType":{ + "shape":"DefaultTargetCapacityType", + "documentation":"

The default TotalTargetCapacity, which is either Spot or On-Demand.

", + "locationName":"defaultTargetCapacityType" + } + }, + "documentation":"

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in and

" + }, + "TargetCapacitySpecificationRequest":{ + "type":"structure", + "required":["TotalTargetCapacity"], + "members":{ + "TotalTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of units to request, filled using DefaultTargetCapacityType.

" + }, + "OnDemandTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of On-Demand units to request.

" + }, + "SpotTargetCapacity":{ + "shape":"Integer", + "documentation":"

The number of Spot units to request.

" + }, + "DefaultTargetCapacityType":{ + "shape":"DefaultTargetCapacityType", + "documentation":"

The default TotalTargetCapacity, which is either Spot or On-Demand.

" + } + }, + "documentation":"

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in and .

" + }, + "TargetConfiguration":{ + "type":"structure", + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

", + "locationName":"instanceCount" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The ID of the Convertible Reserved Instance offering.

", + "locationName":"offeringId" + } + }, + "documentation":"

Information about the Convertible Reserved Instance offering.

" + }, + "TargetConfigurationRequest":{ + "type":"structure", + "required":["OfferingId"], + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances the Covertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request

" + }, + "OfferingId":{ + "shape":"String", + "documentation":"

The Convertible Reserved Instance offering ID.

" + } + }, + "documentation":"

Details about the target configuration.

" + }, + "TargetConfigurationRequestSet":{ + "type":"list", + "member":{ + "shape":"TargetConfigurationRequest", + "locationName":"TargetConfigurationRequest" + } + }, + "TargetGroup":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

", + "locationName":"arn" + } + }, + "documentation":"

Describes a load balancer target group.

" + }, + "TargetGroups":{ + "type":"list", + "member":{ + "shape":"TargetGroup", + "locationName":"item" + }, + "max":5, + "min":1 + }, + "TargetGroupsConfig":{ + "type":"structure", + "members":{ + "TargetGroups":{ + "shape":"TargetGroups", + "documentation":"

One or more target groups.

", + "locationName":"targetGroups" + } + }, + "documentation":"

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.

" + }, + "TargetNetwork":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The ID of the association.

", + "locationName":"associationId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC in which the target network (subnet) is located.

", + "locationName":"vpcId" + }, + "TargetNetworkId":{ + "shape":"String", + "documentation":"

The ID of the subnet specified as the target network.

", + "locationName":"targetNetworkId" + }, + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint with which the target network is associated.

", + "locationName":"clientVpnEndpointId" + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"

The current state of the target network association.

", + "locationName":"status" + }, + "SecurityGroups":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the security groups applied to the target network association.

", + "locationName":"securityGroups" + } + }, + "documentation":"

Describes a target network associated with a Client VPN endpoint.

" + }, + "TargetNetworkSet":{ + "type":"list", + "member":{ + "shape":"TargetNetwork", + "locationName":"item" + } + }, + "TargetReservationValue":{ + "type":"structure", + "members":{ + "ReservationValue":{ + "shape":"ReservationValue", + "documentation":"

The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.

", + "locationName":"reservationValue" + }, + "TargetConfiguration":{ + "shape":"TargetConfiguration", + "documentation":"

The configuration of the Convertible Reserved Instances that make up the exchange.

", + "locationName":"targetConfiguration" + } + }, + "documentation":"

The total value of the new Convertible Reserved Instances.

" + }, + "TargetReservationValueSet":{ + "type":"list", + "member":{ + "shape":"TargetReservationValue", + "locationName":"item" + } + }, + "TelemetryStatus":{ + "type":"string", + "enum":[ + "UP", + "DOWN" + ] + }, + "Tenancy":{ + "type":"string", + "enum":[ + "default", + "dedicated", + "host" + ] + }, + "TerminateClientVpnConnectionsRequest":{ + "type":"structure", + "required":["ClientVpnEndpointId"], + "members":{ + "ClientVpnEndpointId":{ + "shape":"ClientVpnEndpointId", + "documentation":"

The ID of the Client VPN endpoint to which the client is connected.

" + }, + "ConnectionId":{ + "shape":"String", + "documentation":"

The ID of the client connection to be terminated.

" + }, + "Username":{ + "shape":"String", + "documentation":"

The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "TerminateClientVpnConnectionsResult":{ + "type":"structure", + "members":{ + "ClientVpnEndpointId":{ + "shape":"String", + "documentation":"

The ID of the Client VPN endpoint.

", + "locationName":"clientVpnEndpointId" + }, + "Username":{ + "shape":"String", + "documentation":"

The user who established the terminated client connections.

", + "locationName":"username" + }, + "ConnectionStatuses":{ + "shape":"TerminateConnectionStatusSet", + "documentation":"

The current state of the client connections.

", + "locationName":"connectionStatuses" + } + } + }, + "TerminateConnectionStatus":{ + "type":"structure", + "members":{ + "ConnectionId":{ + "shape":"String", + "documentation":"

The ID of the client connection.

", + "locationName":"connectionId" + }, + "PreviousStatus":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"

The state of the client connection.

", + "locationName":"previousStatus" + }, + "CurrentStatus":{ + "shape":"ClientVpnConnectionStatus", + "documentation":"

A message about the status of the client connection, if applicable.

", + "locationName":"currentStatus" + } + }, + "documentation":"

Information about a terminated Client VPN endpoint client connection.

" + }, + "TerminateConnectionStatusSet":{ + "type":"list", + "member":{ + "shape":"TerminateConnectionStatus", + "locationName":"item" + } + }, + "TerminateInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The IDs of the instances.

Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.

", + "locationName":"InstanceId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "TerminateInstancesResult":{ + "type":"structure", + "members":{ + "TerminatingInstances":{ + "shape":"InstanceStateChangeList", + "documentation":"

Information about the terminated instances.

", + "locationName":"instancesSet" + } + } + }, + "TrafficDirection":{ + "type":"string", + "enum":[ + "ingress", + "egress" + ] + }, + "TrafficMirrorFilter":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror filter.

", + "locationName":"trafficMirrorFilterId" + }, + "IngressFilterRules":{ + "shape":"TrafficMirrorFilterRuleList", + "documentation":"

Information about the ingress rules that are associated with the Traffic Mirror filter.

", + "locationName":"ingressFilterRuleSet" + }, + "EgressFilterRules":{ + "shape":"TrafficMirrorFilterRuleList", + "documentation":"

Information about the egress rules that are associated with the Traffic Mirror filter.

", + "locationName":"egressFilterRuleSet" + }, + "NetworkServices":{ + "shape":"TrafficMirrorNetworkServiceList", + "documentation":"

The network service traffic that is associated with the Traffic Mirror filter.

", + "locationName":"networkServiceSet" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror filter.

", + "locationName":"description" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags assigned to the Traffic Mirror filter.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes the Traffic Mirror filter.

" + }, + "TrafficMirrorFilterId":{"type":"string"}, + "TrafficMirrorFilterRule":{ + "type":"structure", + "members":{ + "TrafficMirrorFilterRuleId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror rule.

", + "locationName":"trafficMirrorFilterRuleId" + }, + "TrafficMirrorFilterId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror filter that the rule is associated with.

", + "locationName":"trafficMirrorFilterId" + }, + "TrafficDirection":{ + "shape":"TrafficDirection", + "documentation":"

The traffic direction assigned to the Traffic Mirror rule.

", + "locationName":"trafficDirection" + }, + "RuleNumber":{ + "shape":"Integer", + "documentation":"

The rule number of the Traffic Mirror rule.

", + "locationName":"ruleNumber" + }, + "RuleAction":{ + "shape":"TrafficMirrorRuleAction", + "documentation":"

The action assigned to the Traffic Mirror rule.

", + "locationName":"ruleAction" + }, + "Protocol":{ + "shape":"Integer", + "documentation":"

The protocol assigned to the Traffic Mirror rule.

", + "locationName":"protocol" + }, + "DestinationPortRange":{ + "shape":"TrafficMirrorPortRange", + "documentation":"

The destination port range assigned to the Traffic Mirror rule.

", + "locationName":"destinationPortRange" + }, + "SourcePortRange":{ + "shape":"TrafficMirrorPortRange", + "documentation":"

The source port range assigned to the Traffic Mirror rule.

", + "locationName":"sourcePortRange" + }, + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The destination CIDR block assigned to the Traffic Mirror rule.

", + "locationName":"destinationCidrBlock" + }, + "SourceCidrBlock":{ + "shape":"String", + "documentation":"

The source CIDR block assigned to the Traffic Mirror rule.

", + "locationName":"sourceCidrBlock" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror rule.

", + "locationName":"description" + } + }, + "documentation":"

Describes the Traffic Mirror rule.

" + }, + "TrafficMirrorFilterRuleField":{ + "type":"string", + "enum":[ + "destination-port-range", + "source-port-range", + "protocol", + "description" + ] + }, + "TrafficMirrorFilterRuleFieldList":{ + "type":"list", + "member":{"shape":"TrafficMirrorFilterRuleField"} + }, + "TrafficMirrorFilterRuleId":{"type":"string"}, + "TrafficMirrorFilterRuleList":{ + "type":"list", + "member":{ + "shape":"TrafficMirrorFilterRule", + "locationName":"item" + } + }, + "TrafficMirrorFilterSet":{ + "type":"list", + "member":{ + "shape":"TrafficMirrorFilter", + "locationName":"item" + } + }, + "TrafficMirrorNetworkService":{ + "type":"string", + "enum":["amazon-dns"] + }, + "TrafficMirrorNetworkServiceList":{ + "type":"list", + "member":{ + "shape":"TrafficMirrorNetworkService", + "locationName":"item" + } + }, + "TrafficMirrorPortRange":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "locationName":"fromPort" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.

", + "locationName":"toPort" + } + }, + "documentation":"

Describes the Traffic Mirror port range.

" + }, + "TrafficMirrorPortRangeRequest":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"Integer", + "documentation":"

The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + }, + "ToPort":{ + "shape":"Integer", + "documentation":"

The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.

" + } + }, + "documentation":"

Information about the Traffic Mirror filter rule port range.

" + }, + "TrafficMirrorRuleAction":{ + "type":"string", + "enum":[ + "accept", + "reject" + ] + }, + "TrafficMirrorSession":{ + "type":"structure", + "members":{ + "TrafficMirrorSessionId":{ + "shape":"String", + "documentation":"

The ID for the Traffic Mirror session.

", + "locationName":"trafficMirrorSessionId" + }, + "TrafficMirrorTargetId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror target.

", + "locationName":"trafficMirrorTargetId" + }, + "TrafficMirrorFilterId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror filter.

", + "locationName":"trafficMirrorFilterId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror session's network interface.

", + "locationName":"networkInterfaceId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the account that owns the Traffic Mirror session.

", + "locationName":"ownerId" + }, + "PacketLength":{ + "shape":"Integer", + "documentation":"

The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet

", + "locationName":"packetLength" + }, + "SessionNumber":{ + "shape":"Integer", + "documentation":"

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

", + "locationName":"sessionNumber" + }, + "VirtualNetworkId":{ + "shape":"Integer", + "documentation":"

The virtual network ID associated with the Traffic Mirror session.

", + "locationName":"virtualNetworkId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the Traffic Mirror session.

", + "locationName":"description" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags assigned to the Traffic Mirror session.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a Traffic Mirror session.

" + }, + "TrafficMirrorSessionField":{ + "type":"string", + "enum":[ + "packet-length", + "description", + "virtual-network-id" + ] + }, + "TrafficMirrorSessionFieldList":{ + "type":"list", + "member":{"shape":"TrafficMirrorSessionField"} + }, + "TrafficMirrorSessionId":{"type":"string"}, + "TrafficMirrorSessionSet":{ + "type":"list", + "member":{ + "shape":"TrafficMirrorSession", + "locationName":"item" + } + }, + "TrafficMirrorTarget":{ + "type":"structure", + "members":{ + "TrafficMirrorTargetId":{ + "shape":"String", + "documentation":"

The ID of the Traffic Mirror target.

", + "locationName":"trafficMirrorTargetId" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The network interface ID that is attached to the target.

", + "locationName":"networkInterfaceId" + }, + "NetworkLoadBalancerArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Network Load Balancer.

", + "locationName":"networkLoadBalancerArn" + }, + "Type":{ + "shape":"TrafficMirrorTargetType", + "documentation":"

The type of Traffic Mirror target.

", + "locationName":"type" + }, + "Description":{ + "shape":"String", + "documentation":"

Information about the Traffic Mirror target.

", + "locationName":"description" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the account that owns the Traffic Mirror target.

", + "locationName":"ownerId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags assigned to the Traffic Mirror target.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a Traffic Mirror target.

" + }, + "TrafficMirrorTargetId":{"type":"string"}, + "TrafficMirrorTargetSet":{ + "type":"list", + "member":{ + "shape":"TrafficMirrorTarget", + "locationName":"item" + } + }, + "TrafficMirrorTargetType":{ + "type":"string", + "enum":[ + "network-interface", + "network-load-balancer" + ] + }, + "TrafficMirroringMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "TrafficType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "ALL" + ] + }, + "TransitGateway":{ + "type":"structure", + "members":{ + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway.

", + "locationName":"transitGatewayId" + }, + "TransitGatewayArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the transit gateway.

", + "locationName":"transitGatewayArn" + }, + "State":{ + "shape":"TransitGatewayState", + "documentation":"

The state of the transit gateway.

", + "locationName":"state" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account ID that owns the transit gateway.

", + "locationName":"ownerId" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the transit gateway.

", + "locationName":"description" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The creation time.

", + "locationName":"creationTime" + }, + "Options":{ + "shape":"TransitGatewayOptions", + "documentation":"

The transit gateway options.

", + "locationName":"options" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the transit gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a transit gateway.

" + }, + "TransitGatewayAssociation":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway route table.

", + "locationName":"transitGatewayRouteTableId" + }, + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "State":{ + "shape":"TransitGatewayAssociationState", + "documentation":"

The state of the association.

", + "locationName":"state" + } + }, + "documentation":"

Describes an association between a resource attachment and a transit gateway route table.

" + }, + "TransitGatewayAssociationState":{ + "type":"string", + "enum":[ + "associating", + "associated", + "disassociating", + "disassociated" + ] + }, + "TransitGatewayAttachment":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway.

", + "locationName":"transitGatewayId" + }, + "TransitGatewayOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the transit gateway.

", + "locationName":"transitGatewayOwnerId" + }, + "ResourceOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the resource.

", + "locationName":"resourceOwnerId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "State":{ + "shape":"TransitGatewayAttachmentState", + "documentation":"

The attachment state.

", + "locationName":"state" + }, + "Association":{ + "shape":"TransitGatewayAttachmentAssociation", + "documentation":"

The association.

", + "locationName":"association" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The creation time.

", + "locationName":"creationTime" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the attachment.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes an attachment between a resource and a transit gateway.

" + }, + "TransitGatewayAttachmentAssociation":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the route table for the transit gateway.

", + "locationName":"transitGatewayRouteTableId" + }, + "State":{ + "shape":"TransitGatewayAssociationState", + "documentation":"

The state of the association.

", + "locationName":"state" + } + }, + "documentation":"

Describes an association.

" + }, + "TransitGatewayAttachmentId":{"type":"string"}, + "TransitGatewayAttachmentIdStringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TransitGatewayAttachmentList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayAttachment", + "locationName":"item" + } + }, + "TransitGatewayAttachmentPropagation":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the propagation route table.

", + "locationName":"transitGatewayRouteTableId" + }, + "State":{ + "shape":"TransitGatewayPropagationState", + "documentation":"

The state of the propagation route table.

", + "locationName":"state" + } + }, + "documentation":"

Describes a propagation route table.

" + }, + "TransitGatewayAttachmentPropagationList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayAttachmentPropagation", + "locationName":"item" + } + }, + "TransitGatewayAttachmentResourceType":{ + "type":"string", + "enum":[ + "vpc", + "vpn", + "direct-connect-gateway" + ] + }, + "TransitGatewayAttachmentState":{ + "type":"string", + "enum":[ + "pendingAcceptance", + "rollingBack", + "pending", + "available", + "modifying", + "deleting", + "deleted", + "failed", + "rejected", + "rejecting", + "failing" + ] + }, + "TransitGatewayId":{"type":"string"}, + "TransitGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "TransitGatewayList":{ + "type":"list", + "member":{ + "shape":"TransitGateway", + "locationName":"item" + } + }, + "TransitGatewayMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, + "TransitGatewayOptions":{ + "type":"structure", + "members":{ + "AmazonSideAsn":{ + "shape":"Long", + "documentation":"

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

", + "locationName":"amazonSideAsn" + }, + "AutoAcceptSharedAttachments":{ + "shape":"AutoAcceptSharedAttachmentsValue", + "documentation":"

Indicates whether attachment requests are automatically accepted.

", + "locationName":"autoAcceptSharedAttachments" + }, + "DefaultRouteTableAssociation":{ + "shape":"DefaultRouteTableAssociationValue", + "documentation":"

Indicates whether resource attachments are automatically associated with the default association route table.

", + "locationName":"defaultRouteTableAssociation" + }, + "AssociationDefaultRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the default association route table.

", + "locationName":"associationDefaultRouteTableId" + }, + "DefaultRouteTablePropagation":{ + "shape":"DefaultRouteTablePropagationValue", + "documentation":"

Indicates whether resource attachments automatically propagate routes to the default propagation route table.

", + "locationName":"defaultRouteTablePropagation" + }, + "PropagationDefaultRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the default propagation route table.

", + "locationName":"propagationDefaultRouteTableId" + }, + "VpnEcmpSupport":{ + "shape":"VpnEcmpSupportValue", + "documentation":"

Indicates whether Equal Cost Multipath Protocol support is enabled.

", + "locationName":"vpnEcmpSupport" + }, + "DnsSupport":{ + "shape":"DnsSupportValue", + "documentation":"

Indicates whether DNS support is enabled.

", + "locationName":"dnsSupport" + } + }, + "documentation":"

Describes the options for a transit gateway.

" + }, + "TransitGatewayPropagation":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "TransitGatewayRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway route table.

", + "locationName":"transitGatewayRouteTableId" + }, + "State":{ + "shape":"TransitGatewayPropagationState", + "documentation":"

The state.

", + "locationName":"state" + } + }, + "documentation":"

Describes route propagation.

" + }, + "TransitGatewayPropagationState":{ + "type":"string", + "enum":[ + "enabling", + "enabled", + "disabling", + "disabled" + ] + }, + "TransitGatewayRequestOptions":{ + "type":"structure", + "members":{ + "AmazonSideAsn":{ + "shape":"Long", + "documentation":"

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

" + }, + "AutoAcceptSharedAttachments":{ + "shape":"AutoAcceptSharedAttachmentsValue", + "documentation":"

Enable or disable automatic acceptance of attachment requests. The default is disable.

" + }, + "DefaultRouteTableAssociation":{ + "shape":"DefaultRouteTableAssociationValue", + "documentation":"

Enable or disable automatic association with the default association route table. The default is enable.

" + }, + "DefaultRouteTablePropagation":{ + "shape":"DefaultRouteTablePropagationValue", + "documentation":"

Enable or disable automatic propagation of routes to the default propagation route table. The default is enable.

" + }, + "VpnEcmpSupport":{ + "shape":"VpnEcmpSupportValue", + "documentation":"

Enable or disable Equal Cost Multipath Protocol support.

" + }, + "DnsSupport":{ + "shape":"DnsSupportValue", + "documentation":"

Enable or disable DNS support.

" + } + }, + "documentation":"

Describes the options for a transit gateway.

" + }, + "TransitGatewayRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block used for destination matches.

", + "locationName":"destinationCidrBlock" + }, + "TransitGatewayAttachments":{ + "shape":"TransitGatewayRouteAttachmentList", + "documentation":"

The attachments.

", + "locationName":"transitGatewayAttachments" + }, + "Type":{ + "shape":"TransitGatewayRouteType", + "documentation":"

The route type.

", + "locationName":"type" + }, + "State":{ + "shape":"TransitGatewayRouteState", + "documentation":"

The state of the route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a route for a transit gateway route table.

" + }, + "TransitGatewayRouteAttachment":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + } + }, + "documentation":"

Describes a route attachment.

" + }, + "TransitGatewayRouteAttachmentList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayRouteAttachment", + "locationName":"item" + } + }, + "TransitGatewayRouteList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayRoute", + "locationName":"item" + } + }, + "TransitGatewayRouteState":{ + "type":"string", + "enum":[ + "pending", + "active", + "blackhole", + "deleting", + "deleted" + ] + }, + "TransitGatewayRouteTable":{ + "type":"structure", + "members":{ + "TransitGatewayRouteTableId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway route table.

", + "locationName":"transitGatewayRouteTableId" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway.

", + "locationName":"transitGatewayId" + }, + "State":{ + "shape":"TransitGatewayRouteTableState", + "documentation":"

The state of the transit gateway route table.

", + "locationName":"state" + }, + "DefaultAssociationRouteTable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default association route table for the transit gateway.

", + "locationName":"defaultAssociationRouteTable" + }, + "DefaultPropagationRouteTable":{ + "shape":"Boolean", + "documentation":"

Indicates whether this is the default propagation route table for the transit gateway.

", + "locationName":"defaultPropagationRouteTable" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The creation time.

", + "locationName":"creationTime" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the route table.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a transit gateway route table.

" + }, + "TransitGatewayRouteTableAssociation":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The resource type.

", + "locationName":"resourceType" + }, + "State":{ + "shape":"TransitGatewayAssociationState", + "documentation":"

The state of the association.

", + "locationName":"state" + } + }, + "documentation":"

Describes an association between a route table and a resource attachment.

" + }, + "TransitGatewayRouteTableAssociationList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayRouteTableAssociation", + "locationName":"item" + } + }, + "TransitGatewayRouteTableId":{"type":"string"}, + "TransitGatewayRouteTableIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "TransitGatewayRouteTableList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayRouteTable", + "locationName":"item" + } + }, + "TransitGatewayRouteTablePropagation":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceType":{ + "shape":"TransitGatewayAttachmentResourceType", + "documentation":"

The type of resource.

", + "locationName":"resourceType" + }, + "State":{ + "shape":"TransitGatewayPropagationState", + "documentation":"

The state of the resource.

", + "locationName":"state" + } + }, + "documentation":"

Describes a route table propagation.

" + }, + "TransitGatewayRouteTablePropagationList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayRouteTablePropagation", + "locationName":"item" + } + }, + "TransitGatewayRouteTableState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "TransitGatewayRouteType":{ + "type":"string", + "enum":[ + "static", + "propagated" + ] + }, + "TransitGatewayState":{ + "type":"string", + "enum":[ + "pending", + "available", + "modifying", + "deleting", + "deleted" + ] + }, + "TransitGatewayVpcAttachment":{ + "type":"structure", + "members":{ + "TransitGatewayAttachmentId":{ + "shape":"String", + "documentation":"

The ID of the attachment.

", + "locationName":"transitGatewayAttachmentId" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway.

", + "locationName":"transitGatewayId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "VpcOwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the VPC.

", + "locationName":"vpcOwnerId" + }, + "State":{ + "shape":"TransitGatewayAttachmentState", + "documentation":"

The state of the VPC attachment.

", + "locationName":"state" + }, + "SubnetIds":{ + "shape":"ValueStringList", + "documentation":"

The IDs of the subnets.

", + "locationName":"subnetIds" + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

The creation time.

", + "locationName":"creationTime" + }, + "Options":{ + "shape":"TransitGatewayVpcAttachmentOptions", + "documentation":"

The VPC attachment options.

", + "locationName":"options" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the VPC attachment.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a VPC attachment.

" + }, + "TransitGatewayVpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"TransitGatewayVpcAttachment", + "locationName":"item" + } + }, + "TransitGatewayVpcAttachmentOptions":{ + "type":"structure", + "members":{ + "DnsSupport":{ + "shape":"DnsSupportValue", + "documentation":"

Indicates whether DNS support is enabled.

", + "locationName":"dnsSupport" + }, + "Ipv6Support":{ + "shape":"Ipv6SupportValue", + "documentation":"

Indicates whether IPv6 support is enabled.

", + "locationName":"ipv6Support" + } + }, + "documentation":"

Describes the VPC attachment options.

" + }, + "TransportProtocol":{ + "type":"string", + "enum":[ + "tcp", + "udp" + ] + }, + "TunnelOption":{ + "type":"structure", + "members":{ + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The external IP address of the VPN tunnel.

", + "locationName":"outsideIpAddress" + }, + "TunnelInsideCidr":{ + "shape":"String", + "documentation":"

The range of inside IP addresses for the tunnel.

", + "locationName":"tunnelInsideCidr" + }, + "PreSharedKey":{ + "shape":"String", + "documentation":"

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.

", + "locationName":"preSharedKey" + }, + "Phase1LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 1 of the IKE negotiation, in seconds.

", + "locationName":"phase1LifetimeSeconds" + }, + "Phase2LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 2 of the IKE negotiation, in seconds.

", + "locationName":"phase2LifetimeSeconds" + }, + "RekeyMarginTimeSeconds":{ + "shape":"Integer", + "documentation":"

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.

", + "locationName":"rekeyMarginTimeSeconds" + }, + "RekeyFuzzPercentage":{ + "shape":"Integer", + "documentation":"

The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.

", + "locationName":"rekeyFuzzPercentage" + }, + "ReplayWindowSize":{ + "shape":"Integer", + "documentation":"

The number of packets in an IKE replay window.

", + "locationName":"replayWindowSize" + }, + "DpdTimeoutSeconds":{ + "shape":"Integer", + "documentation":"

The number of seconds after which a DPD timeout occurs.

", + "locationName":"dpdTimeoutSeconds" + }, + "Phase1EncryptionAlgorithms":{ + "shape":"Phase1EncryptionAlgorithmsList", + "documentation":"

The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.

", + "locationName":"phase1EncryptionAlgorithmSet" + }, + "Phase2EncryptionAlgorithms":{ + "shape":"Phase2EncryptionAlgorithmsList", + "documentation":"

The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.

", + "locationName":"phase2EncryptionAlgorithmSet" + }, + "Phase1IntegrityAlgorithms":{ + "shape":"Phase1IntegrityAlgorithmsList", + "documentation":"

The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.

", + "locationName":"phase1IntegrityAlgorithmSet" + }, + "Phase2IntegrityAlgorithms":{ + "shape":"Phase2IntegrityAlgorithmsList", + "documentation":"

The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.

", + "locationName":"phase2IntegrityAlgorithmSet" + }, + "Phase1DHGroupNumbers":{ + "shape":"Phase1DHGroupNumbersList", + "documentation":"

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.

", + "locationName":"phase1DHGroupNumberSet" + }, + "Phase2DHGroupNumbers":{ + "shape":"Phase2DHGroupNumbersList", + "documentation":"

The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.

", + "locationName":"phase2DHGroupNumberSet" + }, + "IkeVersions":{ + "shape":"IKEVersionsList", + "documentation":"

The IKE versions that are permitted for the VPN tunnel.

", + "locationName":"ikeVersionSet" + } + }, + "documentation":"

The VPN tunnel options.

" + }, + "TunnelOptionsList":{ + "type":"list", + "member":{ + "shape":"TunnelOption", + "locationName":"item" + } + }, + "UnassignIpv6AddressesRequest":{ + "type":"structure", + "required":[ + "Ipv6Addresses", + "NetworkInterfaceId" + ], + "members":{ + "Ipv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"

The IPv6 addresses to unassign from the network interface.

", + "locationName":"ipv6Addresses" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + } + } + }, + "UnassignIpv6AddressesResult":{ + "type":"structure", + "members":{ + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "UnassignedIpv6Addresses":{ + "shape":"Ipv6AddressList", + "documentation":"

The IPv6 addresses that have been unassigned from the network interface.

", + "locationName":"unassignedIpv6Addresses" + } + } + }, + "UnassignPrivateIpAddressesRequest":{ + "type":"structure", + "required":[ + "NetworkInterfaceId", + "PrivateIpAddresses" + ], + "members":{ + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface.

", + "locationName":"networkInterfaceId" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddressStringList", + "documentation":"

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Contains the parameters for UnassignPrivateIpAddresses.

" + }, + "UnmonitorInstancesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdStringList", + "documentation":"

The IDs of the instances.

", + "locationName":"InstanceId" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", + "locationName":"dryRun" + } + } + }, + "UnmonitorInstancesResult":{ + "type":"structure", + "members":{ + "InstanceMonitorings":{ + "shape":"InstanceMonitoringList", + "documentation":"

The monitoring information.

", + "locationName":"instancesSet" + } + } + }, + "UnsuccessfulInstanceCreditSpecificationErrorCode":{ + "type":"string", + "enum":[ + "InvalidInstanceID.Malformed", + "InvalidInstanceID.NotFound", + "IncorrectInstanceState", + "InstanceCreditSpecification.NotSupported" + ] + }, + "UnsuccessfulInstanceCreditSpecificationItem":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "Error":{ + "shape":"UnsuccessfulInstanceCreditSpecificationItemError", + "documentation":"

The applicable error for the T2 or T3 instance whose credit option for CPU usage was not modified.

", + "locationName":"error" + } + }, + "documentation":"

Describes the T2 or T3 instance whose credit option for CPU usage was not modified.

" + }, + "UnsuccessfulInstanceCreditSpecificationItemError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"UnsuccessfulInstanceCreditSpecificationErrorCode", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The applicable error message.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error for the T2 or T3 instance whose credit option for CPU usage was not modified.

" + }, + "UnsuccessfulInstanceCreditSpecificationSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulInstanceCreditSpecificationItem", + "locationName":"item" + } + }, + "UnsuccessfulItem":{ + "type":"structure", + "members":{ + "Error":{ + "shape":"UnsuccessfulItemError", + "documentation":"

Information about the error.

", + "locationName":"error" + }, + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + } + }, + "documentation":"

Information about items that were not successfully processed in a batch call.

" + }, + "UnsuccessfulItemError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The error code.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

The error message accompanying the error code.

", + "locationName":"message" + } + }, + "documentation":"

Information about the error that occurred. For more information about errors, see Error Codes.

" + }, + "UnsuccessfulItemList":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UnsuccessfulItemSet":{ + "type":"list", + "member":{ + "shape":"UnsuccessfulItem", + "locationName":"item" + } + }, + "UpdateSecurityGroupRuleDescriptionsEgressRequest":{ + "type":"structure", + "required":["IpPermissions"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The IP permissions for the security group rule.

" + } + } + }, + "UpdateSecurityGroupRuleDescriptionsEgressResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, returns an error.

", + "locationName":"return" + } + } + }, + "UpdateSecurityGroupRuleDescriptionsIngressRequest":{ + "type":"structure", + "required":["IpPermissions"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" + }, + "GroupName":{ + "shape":"String", + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + }, + "IpPermissions":{ + "shape":"IpPermissionList", + "documentation":"

The IP permissions for the security group rule.

" + } + } + }, + "UpdateSecurityGroupRuleDescriptionsIngressResult":{ + "type":"structure", + "members":{ + "Return":{ + "shape":"Boolean", + "documentation":"

Returns true if the request succeeds; otherwise, returns an error.

", + "locationName":"return" + } + } + }, + "UserBucket":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The name of the S3 bucket where the disk image is located.

" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserBucketDetails":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"String", + "documentation":"

The S3 bucket from which the disk image was created.

", + "locationName":"s3Bucket" + }, + "S3Key":{ + "shape":"String", + "documentation":"

The file name of the disk image.

", + "locationName":"s3Key" + } + }, + "documentation":"

Describes the S3 bucket for the disk image.

" + }, + "UserData":{ + "type":"structure", + "members":{ + "Data":{ + "shape":"String", + "documentation":"

The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.

", + "locationName":"data" + } + }, + "documentation":"

Describes the user data for an instance.

", + "sensitive":true + }, + "UserGroupStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserGroup" + } + }, + "UserIdGroupPair":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description for the security group rule that references this user ID group pair.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

", + "locationName":"description" + }, + "GroupId":{ + "shape":"String", + "documentation":"

The ID of the security group.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

", + "locationName":"groupName" + }, + "PeeringStatus":{ + "shape":"String", + "documentation":"

The status of a VPC peering connection, if applicable.

", + "locationName":"peeringStatus" + }, + "UserId":{ + "shape":"String", + "documentation":"

The ID of an AWS account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

", + "locationName":"userId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC for the referenced security group, if applicable.

", + "locationName":"vpcId" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection, if applicable.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a security group and AWS account ID pair.

" + }, + "UserIdGroupPairList":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdGroupPairSet":{ + "type":"list", + "member":{ + "shape":"UserIdGroupPair", + "locationName":"item" + } + }, + "UserIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"UserId" + } + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VersionDescription":{ + "type":"string", + "max":255 + }, + "VersionStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VgwTelemetry":{ + "type":"structure", + "members":{ + "AcceptedRouteCount":{ + "shape":"Integer", + "documentation":"

The number of accepted routes.

", + "locationName":"acceptedRouteCount" + }, + "LastStatusChange":{ + "shape":"DateTime", + "documentation":"

The date and time of the last change in status.

", + "locationName":"lastStatusChange" + }, + "OutsideIpAddress":{ + "shape":"String", + "documentation":"

The Internet-routable IP address of the virtual private gateway's outside interface.

", + "locationName":"outsideIpAddress" + }, + "Status":{ + "shape":"TelemetryStatus", + "documentation":"

The status of the VPN tunnel.

", + "locationName":"status" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

If an error occurs, a description of the error.

", + "locationName":"statusMessage" + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.

", + "locationName":"certificateArn" + } + }, + "documentation":"

Describes telemetry for a VPN tunnel.

" + }, + "VgwTelemetryList":{ + "type":"list", + "member":{ + "shape":"VgwTelemetry", + "locationName":"item" + } + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "hvm", + "paravirtual" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "Attachments":{ + "shape":"VolumeAttachmentList", + "documentation":"

Information about the volume attachments.

", + "locationName":"attachmentSet" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone for the volume.

", + "locationName":"availabilityZone" + }, + "CreateTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when volume creation was initiated.

", + "locationName":"createTime" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether the volume is encrypted.

", + "locationName":"encrypted" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

", + "locationName":"kmsKeyId" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

", + "locationName":"size" + }, + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot from which the volume was created, if applicable.

", + "locationName":"snapshotId" + }, + "State":{ + "shape":"VolumeState", + "documentation":"

The volume state.

", + "locationName":"status" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes, in most Regions. The maximum IOPS for io1 of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "locationName":"iops" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the volume.

", + "locationName":"tagSet" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

", + "locationName":"volumeType" + } + }, + "documentation":"

Describes a volume.

" + }, + "VolumeAttachment":{ + "type":"structure", + "members":{ + "AttachTime":{ + "shape":"DateTime", + "documentation":"

The time stamp when the attachment initiated.

", + "locationName":"attachTime" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

", + "locationName":"device" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance.

", + "locationName":"instanceId" + }, + "State":{ + "shape":"VolumeAttachmentState", + "documentation":"

The attachment state of the volume.

", + "locationName":"status" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination.

", + "locationName":"deleteOnTermination" + } + }, + "documentation":"

Describes volume attachment details.

" + }, + "VolumeAttachmentList":{ + "type":"list", + "member":{ + "shape":"VolumeAttachment", + "locationName":"item" + } + }, + "VolumeAttachmentState":{ + "type":"string", + "enum":[ + "attaching", + "attached", + "detaching", + "detached", + "busy" + ] + }, + "VolumeAttributeName":{ + "type":"string", + "enum":[ + "autoEnableIO", + "productCodes" + ] + }, + "VolumeDetail":{ + "type":"structure", + "required":["Size"], + "members":{ + "Size":{ + "shape":"Long", + "documentation":"

The size of the volume, in GiB.

", + "locationName":"size" + } + }, + "documentation":"

Describes an EBS volume.

" + }, + "VolumeId":{"type":"string"}, + "VolumeIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VolumeId" + } + }, + "VolumeList":{ + "type":"list", + "member":{ + "shape":"Volume", + "locationName":"item" + } + }, + "VolumeModification":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The ID of the volume.

", + "locationName":"volumeId" + }, + "ModificationState":{ + "shape":"VolumeModificationState", + "documentation":"

The current modification state. The modification state is null for unmodified volumes.

", + "locationName":"modificationState" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A status message about the modification progress or failure.

", + "locationName":"statusMessage" + }, + "TargetSize":{ + "shape":"Integer", + "documentation":"

The target size of the volume, in GiB.

", + "locationName":"targetSize" + }, + "TargetIops":{ + "shape":"Integer", + "documentation":"

The target IOPS rate of the volume.

", + "locationName":"targetIops" + }, + "TargetVolumeType":{ + "shape":"VolumeType", + "documentation":"

The target EBS volume type of the volume.

", + "locationName":"targetVolumeType" + }, + "OriginalSize":{ + "shape":"Integer", + "documentation":"

The original size of the volume.

", + "locationName":"originalSize" + }, + "OriginalIops":{ + "shape":"Integer", + "documentation":"

The original IOPS rate of the volume.

", + "locationName":"originalIops" + }, + "OriginalVolumeType":{ + "shape":"VolumeType", + "documentation":"

The original EBS volume type of the volume.

", + "locationName":"originalVolumeType" + }, + "Progress":{ + "shape":"Long", + "documentation":"

The modification progress, from 0 to 100 percent complete.

", + "locationName":"progress" + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

The modification start time.

", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

The modification completion or failure time.

", + "locationName":"endTime" + } + }, + "documentation":"

Describes the modification status of an EBS volume.

If the volume has never been modified, some element values will be null.

" + }, + "VolumeModificationList":{ + "type":"list", + "member":{ + "shape":"VolumeModification", + "locationName":"item" + } + }, + "VolumeModificationState":{ + "type":"string", + "enum":[ + "modifying", + "optimizing", + "completed", + "failed" + ] + }, + "VolumeState":{ + "type":"string", + "enum":[ + "creating", + "available", + "in-use", + "deleting", + "deleted", + "error" + ] + }, + "VolumeStatusAction":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code identifying the operation, for example, enable-volume-io.

", + "locationName":"code" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the operation.

", + "locationName":"description" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of the event associated with this operation.

", + "locationName":"eventId" + }, + "EventType":{ + "shape":"String", + "documentation":"

The event type associated with this operation.

", + "locationName":"eventType" + } + }, + "documentation":"

Describes a volume status operation code.

" + }, + "VolumeStatusActionsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusAction", + "locationName":"item" + } + }, + "VolumeStatusDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"VolumeStatusName", + "documentation":"

The name of the volume status.

", + "locationName":"name" + }, + "Status":{ + "shape":"String", + "documentation":"

The intended status of the volume status.

", + "locationName":"status" + } + }, + "documentation":"

Describes a volume status.

" + }, + "VolumeStatusDetailsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusDetails", + "locationName":"item" + } + }, + "VolumeStatusEvent":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"String", + "documentation":"

A description of the event.

", + "locationName":"description" + }, + "EventId":{ + "shape":"String", + "documentation":"

The ID of this event.

", + "locationName":"eventId" + }, + "EventType":{ + "shape":"String", + "documentation":"

The type of this event.

", + "locationName":"eventType" + }, + "NotAfter":{ + "shape":"DateTime", + "documentation":"

The latest end time of the event.

", + "locationName":"notAfter" + }, + "NotBefore":{ + "shape":"DateTime", + "documentation":"

The earliest start time of the event.

", + "locationName":"notBefore" + } + }, + "documentation":"

Describes a volume status event.

" + }, + "VolumeStatusEventsList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusEvent", + "locationName":"item" + } + }, + "VolumeStatusInfo":{ + "type":"structure", + "members":{ + "Details":{ + "shape":"VolumeStatusDetailsList", + "documentation":"

The details of the volume status.

", + "locationName":"details" + }, + "Status":{ + "shape":"VolumeStatusInfoStatus", + "documentation":"

The status of the volume.

", + "locationName":"status" + } + }, + "documentation":"

Describes the status of a volume.

" + }, + "VolumeStatusInfoStatus":{ + "type":"string", + "enum":[ + "ok", + "impaired", + "insufficient-data" + ] + }, + "VolumeStatusItem":{ + "type":"structure", + "members":{ + "Actions":{ + "shape":"VolumeStatusActionsList", + "documentation":"

The details of the operation.

", + "locationName":"actionsSet" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone of the volume.

", + "locationName":"availabilityZone" + }, + "Events":{ + "shape":"VolumeStatusEventsList", + "documentation":"

A list of events associated with the volume.

", + "locationName":"eventsSet" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

", + "locationName":"volumeId" + }, + "VolumeStatus":{ + "shape":"VolumeStatusInfo", + "documentation":"

The volume status.

", + "locationName":"volumeStatus" + } + }, + "documentation":"

Describes the volume status.

" + }, + "VolumeStatusList":{ + "type":"list", + "member":{ + "shape":"VolumeStatusItem", + "locationName":"item" + } + }, + "VolumeStatusName":{ + "type":"string", + "enum":[ + "io-enabled", + "io-performance" + ] + }, + "VolumeType":{ + "type":"string", + "enum":[ + "standard", + "io1", + "gp2", + "sc1", + "st1" + ] + }, + "Vpc":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The primary IPv4 CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "DhcpOptionsId":{ + "shape":"String", + "documentation":"

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

", + "locationName":"dhcpOptionsId" + }, + "State":{ + "shape":"VpcState", + "documentation":"

The current state of the VPC.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the VPC.

", + "locationName":"ownerId" + }, + "InstanceTenancy":{ + "shape":"Tenancy", + "documentation":"

The allowed tenancy of instances launched into the VPC.

", + "locationName":"instanceTenancy" + }, + "Ipv6CidrBlockAssociationSet":{ + "shape":"VpcIpv6CidrBlockAssociationSet", + "documentation":"

Information about the IPv6 CIDR blocks associated with the VPC.

", + "locationName":"ipv6CidrBlockAssociationSet" + }, + "CidrBlockAssociationSet":{ + "shape":"VpcCidrBlockAssociationSet", + "documentation":"

Information about the IPv4 CIDR blocks associated with the VPC.

", + "locationName":"cidrBlockAssociationSet" + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is the default VPC.

", + "locationName":"isDefault" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a VPC.

" + }, + "VpcAttachment":{ + "type":"structure", + "members":{ + "State":{ + "shape":"AttachmentStatus", + "documentation":"

The current state of the attachment.

", + "locationName":"state" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes an attachment between a virtual private gateway and a VPC.

" + }, + "VpcAttachmentList":{ + "type":"list", + "member":{ + "shape":"VpcAttachment", + "locationName":"item" + } + }, + "VpcAttributeName":{ + "type":"string", + "enum":[ + "enableDnsSupport", + "enableDnsHostnames" + ] + }, + "VpcCidrAssociationId":{"type":"string"}, + "VpcCidrBlockAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID for the IPv4 CIDR block.

", + "locationName":"associationId" + }, + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR block.

", + "locationName":"cidrBlock" + }, + "CidrBlockState":{ + "shape":"VpcCidrBlockState", + "documentation":"

Information about the state of the CIDR block.

", + "locationName":"cidrBlockState" + } + }, + "documentation":"

Describes an IPv4 CIDR block associated with a VPC.

" + }, + "VpcCidrBlockAssociationSet":{ + "type":"list", + "member":{ + "shape":"VpcCidrBlockAssociation", + "locationName":"item" + } + }, + "VpcCidrBlockState":{ + "type":"structure", + "members":{ + "State":{ + "shape":"VpcCidrBlockStateCode", + "documentation":"

The state of the CIDR block.

", + "locationName":"state" + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

A message about the status of the CIDR block, if applicable.

", + "locationName":"statusMessage" + } + }, + "documentation":"

Describes the state of a CIDR block.

" + }, + "VpcCidrBlockStateCode":{ + "type":"string", + "enum":[ + "associating", + "associated", + "disassociating", + "disassociated", + "failing", + "failed" + ] + }, + "VpcClassicLink":{ + "type":"structure", + "members":{ + "ClassicLinkEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC is enabled for ClassicLink.

", + "locationName":"classicLinkEnabled" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC.

", + "locationName":"tagSet" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + } + }, + "documentation":"

Describes whether a VPC is enabled for ClassicLink.

" + }, + "VpcClassicLinkIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcClassicLinkList":{ + "type":"list", + "member":{ + "shape":"VpcClassicLink", + "locationName":"item" + } + }, + "VpcEndpoint":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcEndpointType":{ + "shape":"VpcEndpointType", + "documentation":"

The type of endpoint.

", + "locationName":"vpcEndpointType" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC to which the endpoint is associated.

", + "locationName":"vpcId" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the service to which the endpoint is associated.

", + "locationName":"serviceName" + }, + "State":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"state" + }, + "PolicyDocument":{ + "shape":"String", + "documentation":"

The policy document associated with the endpoint, if applicable.

", + "locationName":"policyDocument" + }, + "RouteTableIds":{ + "shape":"ValueStringList", + "documentation":"

(Gateway endpoint) One or more route tables associated with the endpoint.

", + "locationName":"routeTableIdSet" + }, + "SubnetIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more subnets in which the endpoint is located.

", + "locationName":"subnetIdSet" + }, + "Groups":{ + "shape":"GroupIdentifierSet", + "documentation":"

(Interface endpoint) Information about the security groups associated with the network interface.

", + "locationName":"groupSet" + }, + "PrivateDnsEnabled":{ + "shape":"Boolean", + "documentation":"

(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.

", + "locationName":"privateDnsEnabled" + }, + "RequesterManaged":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPC endpoint is being managed by its service.

", + "locationName":"requesterManaged" + }, + "NetworkInterfaceIds":{ + "shape":"ValueStringList", + "documentation":"

(Interface endpoint) One or more network interfaces for the endpoint.

", + "locationName":"networkInterfaceIdSet" + }, + "DnsEntries":{ + "shape":"DnsEntrySet", + "documentation":"

(Interface endpoint) The DNS entries for the endpoint.

", + "locationName":"dnsEntrySet" + }, + "CreationTimestamp":{ + "shape":"MillisecondDateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPC endpoint.

", + "locationName":"tagSet" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the AWS account that owns the VPC endpoint.

", + "locationName":"ownerId" + } + }, + "documentation":"

Describes a VPC endpoint.

" + }, + "VpcEndpointConnection":{ + "type":"structure", + "members":{ + "ServiceId":{ + "shape":"String", + "documentation":"

The ID of the service to which the endpoint is connected.

", + "locationName":"serviceId" + }, + "VpcEndpointId":{ + "shape":"String", + "documentation":"

The ID of the VPC endpoint.

", + "locationName":"vpcEndpointId" + }, + "VpcEndpointOwner":{ + "shape":"String", + "documentation":"

The AWS account ID of the owner of the VPC endpoint.

", + "locationName":"vpcEndpointOwner" + }, + "VpcEndpointState":{ + "shape":"State", + "documentation":"

The state of the VPC endpoint.

", + "locationName":"vpcEndpointState" + }, + "CreationTimestamp":{ + "shape":"MillisecondDateTime", + "documentation":"

The date and time the VPC endpoint was created.

", + "locationName":"creationTimestamp" + }, + "DnsEntries":{ + "shape":"DnsEntrySet", + "documentation":"

The DNS entries for the VPC endpoint.

", + "locationName":"dnsEntrySet" + }, + "NetworkLoadBalancerArns":{ + "shape":"ValueStringList", + "documentation":"

The Amazon Resource Names (ARNs) of the network load balancers for the service.

", + "locationName":"networkLoadBalancerArnSet" + } + }, + "documentation":"

Describes a VPC endpoint connection to a service.

" + }, + "VpcEndpointConnectionSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpointConnection", + "locationName":"item" + } + }, + "VpcEndpointId":{"type":"string"}, + "VpcEndpointSet":{ + "type":"list", + "member":{ + "shape":"VpcEndpoint", + "locationName":"item" + } + }, + "VpcEndpointType":{ + "type":"string", + "enum":[ + "Interface", + "Gateway" + ] + }, + "VpcId":{"type":"string"}, + "VpcIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcId" + } + }, + "VpcIpv6CidrBlockAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"String", + "documentation":"

The association ID for the IPv6 CIDR block.

", + "locationName":"associationId" + }, + "Ipv6CidrBlock":{ + "shape":"String", + "documentation":"

The IPv6 CIDR block.

", + "locationName":"ipv6CidrBlock" + }, + "Ipv6CidrBlockState":{ + "shape":"VpcCidrBlockState", + "documentation":"

Information about the state of the CIDR block.

", + "locationName":"ipv6CidrBlockState" + } + }, + "documentation":"

Describes an IPv6 CIDR block associated with a VPC.

" + }, + "VpcIpv6CidrBlockAssociationSet":{ + "type":"list", + "member":{ + "shape":"VpcIpv6CidrBlockAssociation", + "locationName":"item" + } + }, + "VpcList":{ + "type":"list", + "member":{ + "shape":"Vpc", + "locationName":"item" + } + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "AccepterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "locationName":"accepterVpcInfo" + }, + "ExpirationTime":{ + "shape":"DateTime", + "documentation":"

The time that an unaccepted VPC peering connection will expire.

", + "locationName":"expirationTime" + }, + "RequesterVpcInfo":{ + "shape":"VpcPeeringConnectionVpcInfo", + "documentation":"

Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.

", + "locationName":"requesterVpcInfo" + }, + "Status":{ + "shape":"VpcPeeringConnectionStateReason", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the resource.

", + "locationName":"tagSet" + }, + "VpcPeeringConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPC peering connection.

", + "locationName":"vpcPeeringConnectionId" + } + }, + "documentation":"

Describes a VPC peering connection.

" + }, + "VpcPeeringConnectionId":{"type":"string"}, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{ + "shape":"VpcPeeringConnection", + "locationName":"item" + } + }, + "VpcPeeringConnectionOptionsDescription":{ + "type":"structure", + "members":{ + "AllowDnsResolutionFromRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.

", + "locationName":"allowDnsResolutionFromRemoteVpc" + }, + "AllowEgressFromLocalClassicLinkToRemoteVpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalClassicLinkToRemoteVpc" + }, + "AllowEgressFromLocalVpcToRemoteClassicLink":{ + "shape":"Boolean", + "documentation":"

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

", + "locationName":"allowEgressFromLocalVpcToRemoteClassicLink" + } + }, + "documentation":"

Describes the VPC peering connection options.

" + }, + "VpcPeeringConnectionStateReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"VpcPeeringConnectionStateReasonCode", + "documentation":"

The status of the VPC peering connection.

", + "locationName":"code" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that provides more information about the status, if applicable.

", + "locationName":"message" + } + }, + "documentation":"

Describes the status of a VPC peering connection.

" + }, + "VpcPeeringConnectionStateReasonCode":{ + "type":"string", + "enum":[ + "initiating-request", + "pending-acceptance", + "active", + "deleted", + "rejected", + "failed", + "expired", + "provisioning", + "deleting" + ] + }, + "VpcPeeringConnectionVpcInfo":{ + "type":"structure", + "members":{ + "CidrBlock":{ + "shape":"String", + "documentation":"

The IPv4 CIDR block for the VPC.

", + "locationName":"cidrBlock" + }, + "Ipv6CidrBlockSet":{ + "shape":"Ipv6CidrBlockSet", + "documentation":"

The IPv6 CIDR block for the VPC.

", + "locationName":"ipv6CidrBlockSet" + }, + "CidrBlockSet":{ + "shape":"CidrBlockSet", + "documentation":"

Information about the IPv4 CIDR blocks for the VPC.

", + "locationName":"cidrBlockSet" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the VPC owner.

", + "locationName":"ownerId" + }, + "PeeringOptions":{ + "shape":"VpcPeeringConnectionOptionsDescription", + "documentation":"

Information about the VPC peering connection options for the accepter or requester VPC.

", + "locationName":"peeringOptions" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC.

", + "locationName":"vpcId" + }, + "Region":{ + "shape":"String", + "documentation":"

The Region in which the VPC is located.

", + "locationName":"region" + } + }, + "documentation":"

Describes a VPC in a VPC peering connection.

" + }, + "VpcState":{ + "type":"string", + "enum":[ + "pending", + "available" + ] + }, + "VpcTenancy":{ + "type":"string", + "enum":["default"] + }, + "VpnConnection":{ + "type":"structure", + "members":{ + "CustomerGatewayConfiguration":{ + "shape":"String", + "documentation":"

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

", + "locationName":"customerGatewayConfiguration" + }, + "CustomerGatewayId":{ + "shape":"String", + "documentation":"

The ID of the customer gateway at your end of the VPN connection.

", + "locationName":"customerGatewayId" + }, + "Category":{ + "shape":"String", + "documentation":"

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection.

", + "locationName":"category" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the VPN connection.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection.

", + "locationName":"type" + }, + "VpnConnectionId":{ + "shape":"String", + "documentation":"

The ID of the VPN connection.

", + "locationName":"vpnConnectionId" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway at the AWS side of the VPN connection.

", + "locationName":"vpnGatewayId" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"

The ID of the transit gateway associated with the VPN connection.

", + "locationName":"transitGatewayId" + }, + "Options":{ + "shape":"VpnConnectionOptions", + "documentation":"

The VPN connection options.

", + "locationName":"options" + }, + "Routes":{ + "shape":"VpnStaticRouteList", + "documentation":"

The static routes associated with the VPN connection.

", + "locationName":"routes" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the VPN connection.

", + "locationName":"tagSet" + }, + "VgwTelemetry":{ + "shape":"VgwTelemetryList", + "documentation":"

Information about the VPN tunnel.

", + "locationName":"vgwTelemetry" + } + }, + "documentation":"

Describes a VPN connection.

" + }, + "VpnConnectionId":{"type":"string"}, + "VpnConnectionIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnConnectionId" + } + }, + "VpnConnectionList":{ + "type":"list", + "member":{ + "shape":"VpnConnection", + "locationName":"item" + } + }, + "VpnConnectionOptions":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

", + "locationName":"staticRoutesOnly" + }, + "TunnelOptions":{ + "shape":"TunnelOptionsList", + "documentation":"

Indicates the VPN tunnel options.

", + "locationName":"tunnelOptionSet" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnConnectionOptionsSpecification":{ + "type":"structure", + "members":{ + "StaticRoutesOnly":{ + "shape":"Boolean", + "documentation":"

Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.

Default: false

", + "locationName":"staticRoutesOnly" + }, + "TunnelOptions":{ + "shape":"VpnTunnelOptionsSpecificationsList", + "documentation":"

The tunnel options for the VPN connection.

" + } + }, + "documentation":"

Describes VPN connection options.

" + }, + "VpnEcmpSupportValue":{ + "type":"string", + "enum":[ + "enable", + "disable" + ] + }, + "VpnGateway":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

", + "locationName":"availabilityZone" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the virtual private gateway.

", + "locationName":"state" + }, + "Type":{ + "shape":"GatewayType", + "documentation":"

The type of VPN connection the virtual private gateway supports.

", + "locationName":"type" + }, + "VpcAttachments":{ + "shape":"VpcAttachmentList", + "documentation":"

Any VPCs attached to the virtual private gateway.

", + "locationName":"attachments" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"

The ID of the virtual private gateway.

", + "locationName":"vpnGatewayId" + }, + "AmazonSideAsn":{ + "shape":"Long", + "documentation":"

The private Autonomous System Number (ASN) for the Amazon side of a BGP session.

", + "locationName":"amazonSideAsn" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Any tags assigned to the virtual private gateway.

", + "locationName":"tagSet" + } + }, + "documentation":"

Describes a virtual private gateway.

" + }, + "VpnGatewayId":{"type":"string"}, + "VpnGatewayIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpnGatewayId" + } + }, + "VpnGatewayList":{ + "type":"list", + "member":{ + "shape":"VpnGateway", + "locationName":"item" + } + }, + "VpnProtocol":{ + "type":"string", + "enum":["openvpn"] + }, + "VpnState":{ + "type":"string", + "enum":[ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "VpnStaticRoute":{ + "type":"structure", + "members":{ + "DestinationCidrBlock":{ + "shape":"String", + "documentation":"

The CIDR block associated with the local subnet of the customer data center.

", + "locationName":"destinationCidrBlock" + }, + "Source":{ + "shape":"VpnStaticRouteSource", + "documentation":"

Indicates how the routes were provided.

", + "locationName":"source" + }, + "State":{ + "shape":"VpnState", + "documentation":"

The current state of the static route.

", + "locationName":"state" + } + }, + "documentation":"

Describes a static route for a VPN connection.

" + }, + "VpnStaticRouteList":{ + "type":"list", + "member":{ + "shape":"VpnStaticRoute", + "locationName":"item" + } + }, + "VpnStaticRouteSource":{ + "type":"string", + "enum":["Static"] + }, + "VpnTunnelOptionsSpecification":{ + "type":"structure", + "members":{ + "TunnelInsideCidr":{ + "shape":"String", + "documentation":"

The range of inside IP addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.

Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:

  • 169.254.0.0/30

  • 169.254.1.0/30

  • 169.254.2.0/30

  • 169.254.3.0/30

  • 169.254.4.0/30

  • 169.254.5.0/30

  • 169.254.169.252/30

" + }, + "PreSharedKey":{ + "shape":"String", + "documentation":"

The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.

Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).

" + }, + "Phase1LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 1 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 28,800.

Default: 28800

" + }, + "Phase2LifetimeSeconds":{ + "shape":"Integer", + "documentation":"

The lifetime for phase 2 of the IKE negotiation, in seconds.

Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.

Default: 3600

" + }, + "RekeyMarginTimeSeconds":{ + "shape":"Integer", + "documentation":"

The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.

Constraints: A value between 60 and half of Phase2LifetimeSeconds.

Default: 540

" + }, + "RekeyFuzzPercentage":{ + "shape":"Integer", + "documentation":"

The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.

Constraints: A value between 0 and 100.

Default: 100

" + }, + "ReplayWindowSize":{ + "shape":"Integer", + "documentation":"

The number of packets in an IKE replay window.

Constraints: A value between 64 and 2048.

Default: 1024

" + }, + "DPDTimeoutSeconds":{ + "shape":"Integer", + "documentation":"

The number of seconds after which a DPD timeout occurs.

Constraints: A value between 0 and 30.

Default: 30

" + }, + "Phase1EncryptionAlgorithms":{ + "shape":"Phase1EncryptionAlgorithmsRequestList", + "documentation":"

One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: AES128 | AES256

", + "locationName":"Phase1EncryptionAlgorithm" + }, + "Phase2EncryptionAlgorithms":{ + "shape":"Phase2EncryptionAlgorithmsRequestList", + "documentation":"

One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: AES128 | AES256

", + "locationName":"Phase2EncryptionAlgorithm" + }, + "Phase1IntegrityAlgorithms":{ + "shape":"Phase1IntegrityAlgorithmsRequestList", + "documentation":"

One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: SHA1 | SHA2-256

", + "locationName":"Phase1IntegrityAlgorithm" + }, + "Phase2IntegrityAlgorithms":{ + "shape":"Phase2IntegrityAlgorithmsRequestList", + "documentation":"

One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: SHA1 | SHA2-256

", + "locationName":"Phase2IntegrityAlgorithm" + }, + "Phase1DHGroupNumbers":{ + "shape":"Phase1DHGroupNumbersRequestList", + "documentation":"

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.

Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

", + "locationName":"Phase1DHGroupNumber" + }, + "Phase2DHGroupNumbers":{ + "shape":"Phase2DHGroupNumbersRequestList", + "documentation":"

One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.

Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 22 | 23 | 24

", + "locationName":"Phase2DHGroupNumber" + }, + "IKEVersions":{ + "shape":"IKEVersionsRequestList", + "documentation":"

The IKE versions that are permitted for the VPN tunnel.

Valid values: ikev1 | ikev2

", + "locationName":"IKEVersion" + } + }, + "documentation":"

The tunnel options for a VPN connection.

" + }, + "VpnTunnelOptionsSpecificationsList":{ + "type":"list", + "member":{"shape":"VpnTunnelOptionsSpecification"} + }, + "WithdrawByoipCidrRequest":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The public IPv4 address range, in CIDR notation.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + } + } + }, + "WithdrawByoipCidrResult":{ + "type":"structure", + "members":{ + "ByoipCidr":{ + "shape":"ByoipCidr", + "documentation":"

Information about the address pool.

", + "locationName":"byoipCidr" + } + } + }, + "ZoneIdStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneId" + } + }, + "ZoneNameStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ZoneName" + } + }, + "scope":{ + "type":"string", + "enum":[ + "Availability Zone", + "Region" + ] + } + }, + "documentation":"Amazon Elastic Compute Cloud

Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.

To learn more, see the following resources:

" +} diff --git a/aws/dist/botocore/data/ec2/2016-11-15/waiters-2.json b/aws/dist/botocore/data/ec2/2016-11-15/waiters-2.json new file mode 100644 index 00000000..33ea7b04 --- /dev/null +++ b/aws/dist/botocore/data/ec2/2016-11-15/waiters-2.json @@ -0,0 +1,622 @@ +{ + "version": 2, + "waiters": { + "InstanceExists": { + "delay": 5, + "maxAttempts": 40, + "operation": "DescribeInstances", + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Reservations[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "BundleTaskComplete": { + "delay": 15, + "operation": "DescribeBundleTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "complete", + "matcher": "pathAll", + "state": "success", + "argument": "BundleTasks[].State" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "BundleTasks[].State" + } + ] + }, + "ConversionTaskCancelled": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskCompleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelled", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + }, + { + "expected": "cancelling", + "matcher": "pathAny", + "state": "failure", + "argument": "ConversionTasks[].State" + } + ] + }, + "ConversionTaskDeleted": { + "delay": 15, + "operation": "DescribeConversionTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "ConversionTasks[].State" + } + ] + }, + "CustomerGatewayAvailable": { + "delay": 15, + "operation": "DescribeCustomerGateways", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CustomerGateways[].State" + } + ] + }, + "ExportTaskCancelled": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "cancelled", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ExportTaskCompleted": { + "delay": 15, + "operation": "DescribeExportTasks", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "ExportTasks[].State" + } + ] + }, + "ImageExists": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "matcher": "path", + "expected": true, + "argument": "length(Images[]) > `0`", + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidAMIID.NotFound", + "state": "retry" + } + ] + }, + "ImageAvailable": { + "operation": "DescribeImages", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Images[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Images[].State", + "expected": "failed" + } + ] + }, + "InstanceRunning": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "running", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "shutting-down", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].InstanceStatus.Status", + "expected": "ok" + }, + { + "matcher": "error", + "expected": "InvalidInstanceID.NotFound", + "state": "retry" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Reservations[].Instances[].State.Name" + } + ] + }, + "KeyPairExists": { + "operation": "DescribeKeyPairs", + "delay": 5, + "maxAttempts": 6, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(KeyPairs[].KeyName) > `0`" + }, + { + "expected": "InvalidKeyPair.NotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "NatGatewayAvailable": { + "operation": "DescribeNatGateways", + "delay": 15, + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "NatGateways[].State", + "expected": "available" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "failed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleting" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "NatGateways[].State", + "expected": "deleted" + }, + { + "state": "retry", + "matcher": "error", + "expected": "NatGatewayNotFound" + } + ] + }, + "NetworkInterfaceAvailable": { + "operation": "DescribeNetworkInterfaces", + "delay": 20, + "maxAttempts": 10, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "NetworkInterfaces[].Status" + }, + { + "expected": "InvalidNetworkInterfaceID.NotFound", + "matcher": "error", + "state": "failure" + } + ] + }, + "PasswordDataAvailable": { + "operation": "GetPasswordData", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "length(PasswordData) > `0`", + "expected": true + } + ] + }, + "SnapshotCompleted": { + "delay": 15, + "operation": "DescribeSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "completed", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].State" + } + ] + }, + "SpotInstanceRequestFulfilled": { + "operation": "DescribeSpotInstanceRequests", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "fulfilled" + }, + { + "state": "success", + "matcher": "pathAll", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "request-canceled-and-instance-running" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "schedule-expired" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "canceled-before-fulfillment" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "bad-parameters" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "SpotInstanceRequests[].Status.Code", + "expected": "system-error" + }, + { + "state": "retry", + "matcher": "error", + "expected": "InvalidSpotInstanceRequestID.NotFound" + } + ] + }, + "SubnetAvailable": { + "delay": 15, + "operation": "DescribeSubnets", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Subnets[].State" + } + ] + }, + "SystemStatusOk": { + "operation": "DescribeInstanceStatus", + "maxAttempts": 40, + "delay": 15, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "InstanceStatuses[].SystemStatus.Status", + "expected": "ok" + } + ] + }, + "VolumeAvailable": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VolumeDeleted": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "matcher": "error", + "expected": "InvalidVolume.NotFound", + "state": "success" + } + ] + }, + "VolumeInUse": { + "delay": 15, + "operation": "DescribeVolumes", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "in-use", + "matcher": "pathAll", + "state": "success", + "argument": "Volumes[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Volumes[].State" + } + ] + }, + "VpcAvailable": { + "delay": 15, + "operation": "DescribeVpcs", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Vpcs[].State" + } + ] + }, + "VpcExists": { + "operation": "DescribeVpcs", + "delay": 1, + "maxAttempts": 5, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcID.NotFound", + "state": "retry" + } + ] + }, + "VpnConnectionAvailable": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpnConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpnConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpnConnections[].State" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "VpnConnections[].State" + } + ] + }, + "VpcPeeringConnectionExists": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "retry" + } + ] + }, + "VpcPeeringConnectionDeleted": { + "delay": 15, + "operation": "DescribeVpcPeeringConnections", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "VpcPeeringConnections[].Status.Code" + }, + { + "matcher": "error", + "expected": "InvalidVpcPeeringConnectionID.NotFound", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/ecr/2015-09-21/examples-1.json b/aws/dist/botocore/data/ecr/2015-09-21/examples-1.json new file mode 100644 index 00000000..626e4310 --- /dev/null +++ b/aws/dist/botocore/data/ecr/2015-09-21/examples-1.json @@ -0,0 +1,215 @@ +{ + "version": "1.0", + "examples": { + "BatchDeleteImage": [ + { + "input": { + "imageIds": [ + { + "imageTag": "precise" + } + ], + "repositoryName": "ubuntu" + }, + "output": { + "failures": [ + + ], + "imageIds": [ + { + "imageDigest": "sha256:examplee6d1e504117a17000003d3753086354a38375961f2e665416ef4b1b2f", + "imageTag": "precise" + } + ] + }, + "comments": { + }, + "description": "This example deletes images with the tags precise and trusty in a repository called ubuntu in the default registry for an account.", + "id": "batchdeleteimages-example-1470860541707", + "title": "To delete multiple images" + } + ], + "BatchGetImage": [ + { + "input": { + "imageIds": [ + { + "imageTag": "precise" + } + ], + "repositoryName": "ubuntu" + }, + "output": { + "failures": [ + + ], + "images": [ + { + "imageId": { + "imageDigest": "sha256:example76bdff6d83a09ba2a818f0d00000063724a9ac3ba5019c56f74ebf42a", + "imageTag": "precise" + }, + "imageManifest": "{\n \"schemaVersion\": 1,\n \"name\": \"ubuntu\",\n \"tag\": \"precise\",\n...", + "registryId": "244698725403", + "repositoryName": "ubuntu" + } + ] + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example obtains information for an image with a specified image digest ID from the repository named ubuntu in the current account.", + "id": "batchgetimage-example-1470862771437", + "title": "To obtain multiple images in a single request" + } + ], + "CreateRepository": [ + { + "input": { + "repositoryName": "project-a/nginx-web-app" + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/project-a/nginx-web-app", + "repositoryName": "project-a/nginx-web-app" + } + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example creates a repository called nginx-web-app inside the project-a namespace in the default registry for an account.", + "id": "createrepository-example-1470863688724", + "title": "To create a new repository" + } + ], + "DeleteRepository": [ + { + "input": { + "force": true, + "repositoryName": "ubuntu" + }, + "output": { + "repository": { + "registryId": "012345678901", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678901:repository/ubuntu", + "repositoryName": "ubuntu" + } + }, + "comments": { + "output": { + "imageManifest": "In this example, the imageManifest in the output JSON has been truncated." + } + }, + "description": "This example force deletes a repository named ubuntu in the default registry for an account. The force parameter is required if the repository contains images.", + "id": "deleterepository-example-1470863805703", + "title": "To force delete a repository" + } + ], + "DeleteRepositoryPolicy": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{ ... }", + "registryId": "012345678901", + "repositoryName": "ubuntu" + }, + "comments": { + }, + "description": "This example deletes the policy associated with the repository named ubuntu in the current account.", + "id": "deleterepositorypolicy-example-1470866943748", + "title": "To delete the policy associated with a repository" + } + ], + "DescribeRepositories": [ + { + "input": { + }, + "output": { + "repositories": [ + { + "registryId": "012345678910", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/ubuntu", + "repositoryName": "ubuntu" + }, + { + "registryId": "012345678910", + "repositoryArn": "arn:aws:ecr:us-west-2:012345678910:repository/test", + "repositoryName": "test" + } + ] + }, + "comments": { + "output": { + } + }, + "description": "The following example obtains a list and description of all repositories in the default registry to which the current user has access.", + "id": "describe-repositories-1470856017467", + "title": "To describe all repositories in the current account" + } + ], + "GetAuthorizationToken": [ + { + "input": { + }, + "output": { + "authorizationData": [ + { + "authorizationToken": "QVdTOkN...", + "expiresAt": "1470951892.432", + "proxyEndpoint": "https://012345678901.dkr.ecr.us-west-2.amazonaws.com" + } + ] + }, + "comments": { + }, + "description": "This example gets an authorization token for your default registry.", + "id": "getauthorizationtoken-example-1470867047084", + "title": "To obtain an authorization token" + } + ], + "GetRepositoryPolicy": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "policyText": "{\n \"Version\" : \"2008-10-17\",\n \"Statement\" : [ {\n \"Sid\" : \"new statement\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::012345678901:role/CodeDeployDemo\"\n },\n\"Action\" : [ \"ecr:GetDownloadUrlForLayer\", \"ecr:BatchGetImage\", \"ecr:BatchCheckLayerAvailability\" ]\n } ]\n}", + "registryId": "012345678901", + "repositoryName": "ubuntu" + }, + "comments": { + }, + "description": "This example obtains the repository policy for the repository named ubuntu.", + "id": "getrepositorypolicy-example-1470867669211", + "title": "To get the current policy for a repository" + } + ], + "ListImages": [ + { + "input": { + "repositoryName": "ubuntu" + }, + "output": { + "imageIds": [ + { + "imageDigest": "sha256:764f63476bdff6d83a09ba2a818f0d35757063724a9ac3ba5019c56f74ebf42a", + "imageTag": "precise" + } + ] + }, + "comments": { + }, + "description": "This example lists all of the images in the repository named ubuntu in the default registry in the current account. ", + "id": "listimages-example-1470868161594", + "title": "To list all images in a repository" + } + ] + } +} diff --git a/aws/dist/botocore/data/ecr/2015-09-21/paginators-1.json b/aws/dist/botocore/data/ecr/2015-09-21/paginators-1.json new file mode 100644 index 00000000..bc0ca83b --- /dev/null +++ b/aws/dist/botocore/data/ecr/2015-09-21/paginators-1.json @@ -0,0 +1,48 @@ +{ + "pagination": { + "ListImages": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "imageIds" + }, + "DescribeImages": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "imageDetails" + }, + "DescribeRepositories": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "repositories" + }, + "DescribeImageScanFindings": { + "input_token": "nextToken", + "limit_key": "maxResults", + "non_aggregate_keys": [ + "registryId", + "repositoryName", + "imageId", + "imageScanStatus", + "imageScanFindings" + ], + "output_token": "nextToken", + "result_key": "imageScanFindings.findings" + }, + "GetLifecyclePolicyPreview": { + "input_token": "nextToken", + "limit_key": "maxResults", + "non_aggregate_keys": [ + "registryId", + "repositoryName", + "lifecyclePolicyText", + "status", + "summary" + ], + "output_token": "nextToken", + "result_key": "previewResults" + } + } +} diff --git a/aws/dist/botocore/data/ecr/2015-09-21/service-2.json b/aws/dist/botocore/data/ecr/2015-09-21/service-2.json new file mode 100644 index 00000000..9f4a8310 --- /dev/null +++ b/aws/dist/botocore/data/ecr/2015-09-21/service-2.json @@ -0,0 +1,2438 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-09-21", + "endpointPrefix":"api.ecr", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon ECR", + "serviceFullName":"Amazon EC2 Container Registry", + "serviceId":"ECR", + "signatureVersion":"v4", + "signingName":"ecr", + "targetPrefix":"AmazonEC2ContainerRegistry_V20150921", + "uid":"ecr-2015-09-21" + }, + "operations":{ + "BatchCheckLayerAvailability":{ + "name":"BatchCheckLayerAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchCheckLayerAvailabilityRequest"}, + "output":{"shape":"BatchCheckLayerAvailabilityResponse"}, + "errors":[ + {"shape":"RepositoryNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerException"} + ], + "documentation":"

Check the availability of multiple image layers in a specified registry and repository.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + }, + "BatchDeleteImage":{ + "name":"BatchDeleteImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteImageRequest"}, + "output":{"shape":"BatchDeleteImageResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Deletes a list of specified images within a specified repository. Images are specified with either imageTag or imageDigest.

You can remove a tag from an image by specifying the image's tag in your request. When you remove the last tag from an image, the image is deleted from your repository.

You can completely delete an image (and all of its tags) by specifying the image's digest in your request.

" + }, + "BatchGetImage":{ + "name":"BatchGetImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetImageRequest"}, + "output":{"shape":"BatchGetImageResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Gets detailed information for specified images within a specified repository. Images are specified with either imageTag or imageDigest.

" + }, + "CompleteLayerUpload":{ + "name":"CompleteLayerUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CompleteLayerUploadRequest"}, + "output":{"shape":"CompleteLayerUploadResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"UploadNotFoundException"}, + {"shape":"InvalidLayerException"}, + {"shape":"LayerPartTooSmallException"}, + {"shape":"LayerAlreadyExistsException"}, + {"shape":"EmptyUploadException"} + ], + "documentation":"

Informs Amazon ECR that the image layer upload has completed for a specified registry, repository name, and upload ID. You can optionally provide a sha256 digest of the image layer for data validation purposes.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + }, + "CreateRepository":{ + "name":"CreateRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRepositoryRequest"}, + "output":{"shape":"CreateRepositoryResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"TooManyTagsException"}, + {"shape":"RepositoryAlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an Amazon Elastic Container Registry (Amazon ECR) repository, where users can push and pull Docker images. For more information, see Amazon ECR Repositories in the Amazon Elastic Container Registry User Guide.

" + }, + "DeleteLifecyclePolicy":{ + "name":"DeleteLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLifecyclePolicyRequest"}, + "output":{"shape":"DeleteLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"LifecyclePolicyNotFoundException"} + ], + "documentation":"

Deletes the specified lifecycle policy.

" + }, + "DeleteRepository":{ + "name":"DeleteRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRepositoryRequest"}, + "output":{"shape":"DeleteRepositoryResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"RepositoryNotEmptyException"} + ], + "documentation":"

Deletes an existing image repository. If a repository contains images, you must use the force option to delete it.

" + }, + "DeleteRepositoryPolicy":{ + "name":"DeleteRepositoryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRepositoryPolicyRequest"}, + "output":{"shape":"DeleteRepositoryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"RepositoryPolicyNotFoundException"} + ], + "documentation":"

Deletes the repository policy from a specified repository.

" + }, + "DescribeImageScanFindings":{ + "name":"DescribeImageScanFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImageScanFindingsRequest"}, + "output":{"shape":"DescribeImageScanFindingsResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ImageNotFoundException"}, + {"shape":"ScanNotFoundException"} + ], + "documentation":"

Describes the image scan findings for the specified image.

" + }, + "DescribeImages":{ + "name":"DescribeImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeImagesRequest"}, + "output":{"shape":"DescribeImagesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ImageNotFoundException"} + ], + "documentation":"

Returns metadata about the images in a repository, including image size, image tags, and creation date.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

" + }, + "DescribeRepositories":{ + "name":"DescribeRepositories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRepositoriesRequest"}, + "output":{"shape":"DescribeRepositoriesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Describes image repositories in a registry.

" + }, + "GetAuthorizationToken":{ + "name":"GetAuthorizationToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAuthorizationTokenRequest"}, + "output":{"shape":"GetAuthorizationTokenResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Retrieves a token that is valid for a specified registry for 12 hours. This command allows you to use the docker CLI to push and pull images with Amazon ECR. If you do not specify a registry, the default registry is assumed.

The authorizationToken returned for each registry specified is a base64 encoded string that can be decoded and used in a docker login command to authenticate to a registry. The AWS CLI offers an aws ecr get-login command that simplifies the login process.

" + }, + "GetDownloadUrlForLayer":{ + "name":"GetDownloadUrlForLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDownloadUrlForLayerRequest"}, + "output":{"shape":"GetDownloadUrlForLayerResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LayersNotFoundException"}, + {"shape":"LayerInaccessibleException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + }, + "GetLifecyclePolicy":{ + "name":"GetLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLifecyclePolicyRequest"}, + "output":{"shape":"GetLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"LifecyclePolicyNotFoundException"} + ], + "documentation":"

Retrieves the specified lifecycle policy.

" + }, + "GetLifecyclePolicyPreview":{ + "name":"GetLifecyclePolicyPreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLifecyclePolicyPreviewRequest"}, + "output":{"shape":"GetLifecyclePolicyPreviewResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"LifecyclePolicyPreviewNotFoundException"} + ], + "documentation":"

Retrieves the results of the specified lifecycle policy preview request.

" + }, + "GetRepositoryPolicy":{ + "name":"GetRepositoryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRepositoryPolicyRequest"}, + "output":{"shape":"GetRepositoryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"RepositoryPolicyNotFoundException"} + ], + "documentation":"

Retrieves the repository policy for a specified repository.

" + }, + "InitiateLayerUpload":{ + "name":"InitiateLayerUpload", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InitiateLayerUploadRequest"}, + "output":{"shape":"InitiateLayerUploadResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Notify Amazon ECR that you intend to upload an image layer.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + }, + "ListImages":{ + "name":"ListImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListImagesRequest"}, + "output":{"shape":"ListImagesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Lists all the image IDs for a given repository.

You can filter images based on whether or not they are tagged by setting the tagStatus parameter to TAGGED or UNTAGGED. For example, you can filter your results to return only UNTAGGED images and then pipe that result to a BatchDeleteImage operation to delete them. Or, you can filter your results to return only TAGGED images to list all of the tags in your repository.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ServerException"} + ], + "documentation":"

List the tags for an Amazon ECR resource.

" + }, + "PutImage":{ + "name":"PutImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutImageRequest"}, + "output":{"shape":"PutImageResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ImageAlreadyExistsException"}, + {"shape":"LayersNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ImageTagAlreadyExistsException"} + ], + "documentation":"

Creates or updates the image manifest and tags associated with an image.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + }, + "PutImageScanningConfiguration":{ + "name":"PutImageScanningConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutImageScanningConfigurationRequest"}, + "output":{"shape":"PutImageScanningConfigurationResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Updates the image scanning configuration for a repository.

" + }, + "PutImageTagMutability":{ + "name":"PutImageTagMutability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutImageTagMutabilityRequest"}, + "output":{"shape":"PutImageTagMutabilityResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Updates the image tag mutability settings for a repository.

" + }, + "PutLifecyclePolicy":{ + "name":"PutLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLifecyclePolicyRequest"}, + "output":{"shape":"PutLifecyclePolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see Lifecycle Policy Template.

" + }, + "SetRepositoryPolicy":{ + "name":"SetRepositoryPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetRepositoryPolicyRequest"}, + "output":{"shape":"SetRepositoryPolicyResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"} + ], + "documentation":"

Applies a repository policy on a specified repository to control access permissions. For more information, see Amazon ECR Repository Policies in the Amazon Elastic Container Registry User Guide.

" + }, + "StartImageScan":{ + "name":"StartImageScan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartImageScanRequest"}, + "output":{"shape":"StartImageScanResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ImageNotFoundException"} + ], + "documentation":"

Starts an image vulnerability scan.

" + }, + "StartLifecyclePolicyPreview":{ + "name":"StartLifecyclePolicyPreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartLifecyclePolicyPreviewRequest"}, + "output":{"shape":"StartLifecyclePolicyPreviewResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"LifecyclePolicyNotFoundException"}, + {"shape":"LifecyclePolicyPreviewInProgressException"} + ], + "documentation":"

Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"TooManyTagsException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ServerException"} + ], + "documentation":"

Adds specified tags to a resource with the specified ARN. Existing tags on a resource are not changed if they are not specified in the request parameters.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagParameterException"}, + {"shape":"TooManyTagsException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"ServerException"} + ], + "documentation":"

Deletes specified tags from a resource.

" + }, + "UploadLayerPart":{ + "name":"UploadLayerPart", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadLayerPartRequest"}, + "output":{"shape":"UploadLayerPartResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidLayerPartException"}, + {"shape":"RepositoryNotFoundException"}, + {"shape":"UploadNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Uploads an image layer part to Amazon ECR.

This operation is used by the Amazon ECR proxy, and it is not intended for general use by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" + } + }, + "shapes":{ + "Arn":{"type":"string"}, + "Attribute":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"AttributeKey", + "documentation":"

The attribute key.

" + }, + "value":{ + "shape":"AttributeValue", + "documentation":"

The value assigned to the attribute key.

" + } + }, + "documentation":"

This data type is used in the ImageScanFinding data type.

" + }, + "AttributeKey":{ + "type":"string", + "max":128, + "min":1 + }, + "AttributeList":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":50, + "min":0 + }, + "AttributeValue":{ + "type":"string", + "max":256, + "min":1 + }, + "AuthorizationData":{ + "type":"structure", + "members":{ + "authorizationToken":{ + "shape":"Base64", + "documentation":"

A base64-encoded string that contains authorization data for the specified Amazon ECR registry. When the string is decoded, it is presented in the format user:password for private registry authentication using docker login.

" + }, + "expiresAt":{ + "shape":"ExpirationTimestamp", + "documentation":"

The Unix time in seconds and milliseconds when the authorization token expires. Authorization tokens are valid for 12 hours.

" + }, + "proxyEndpoint":{ + "shape":"ProxyEndpoint", + "documentation":"

The registry URL to use for this authorization token in a docker login command. The Amazon ECR registry URL format is https://aws_account_id.dkr.ecr.region.amazonaws.com. For example, https://012345678910.dkr.ecr.us-east-1.amazonaws.com..

" + } + }, + "documentation":"

An object representing authorization data for an Amazon ECR registry.

" + }, + "AuthorizationDataList":{ + "type":"list", + "member":{"shape":"AuthorizationData"} + }, + "Base64":{ + "type":"string", + "pattern":"^\\S+$" + }, + "BatchCheckLayerAvailabilityRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "layerDigests" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the image layers to check. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that is associated with the image layers to check.

" + }, + "layerDigests":{ + "shape":"BatchedOperationLayerDigestList", + "documentation":"

The digests of the image layers to check.

" + } + } + }, + "BatchCheckLayerAvailabilityResponse":{ + "type":"structure", + "members":{ + "layers":{ + "shape":"LayerList", + "documentation":"

A list of image layer objects corresponding to the image layer references in the request.

" + }, + "failures":{ + "shape":"LayerFailureList", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "BatchDeleteImageRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageIds" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the image to delete. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository that contains the image to delete.

" + }, + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

A list of image ID references that correspond to images to delete. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

" + } + }, + "documentation":"

Deletes specified images within a specified repository. Images are specified with either the imageTag or imageDigest.

" + }, + "BatchDeleteImageResponse":{ + "type":"structure", + "members":{ + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

The image IDs of the deleted images.

" + }, + "failures":{ + "shape":"ImageFailureList", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "BatchGetImageRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageIds" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the images to describe. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository that contains the images to describe.

" + }, + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

A list of image ID references that correspond to images to describe. The format of the imageIds reference is imageTag=tag or imageDigest=digest.

" + }, + "acceptedMediaTypes":{ + "shape":"MediaTypeList", + "documentation":"

The accepted media types for the request.

Valid values: application/vnd.docker.distribution.manifest.v1+json | application/vnd.docker.distribution.manifest.v2+json | application/vnd.oci.image.manifest.v1+json

" + } + } + }, + "BatchGetImageResponse":{ + "type":"structure", + "members":{ + "images":{ + "shape":"ImageList", + "documentation":"

A list of image objects corresponding to the image references in the request.

" + }, + "failures":{ + "shape":"ImageFailureList", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "BatchedOperationLayerDigest":{ + "type":"string", + "max":1000, + "min":0 + }, + "BatchedOperationLayerDigestList":{ + "type":"list", + "member":{"shape":"BatchedOperationLayerDigest"}, + "max":100, + "min":1 + }, + "CompleteLayerUploadRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "uploadId", + "layerDigests" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry to which to upload layers. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to associate with the image layer.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID from a previous InitiateLayerUpload operation to associate with the image layer.

" + }, + "layerDigests":{ + "shape":"LayerDigestList", + "documentation":"

The sha256 digest of the image layer.

" + } + } + }, + "CompleteLayerUploadResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID associated with the layer.

" + }, + "layerDigest":{ + "shape":"LayerDigest", + "documentation":"

The sha256 digest of the image layer.

" + } + } + }, + "CreateRepositoryRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name to use for the repository. The repository name may be specified on its own (such as nginx-web-app) or it can be prepended with a namespace to group the repository into a category (such as project-a/nginx-web-app).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + }, + "imageTagMutability":{ + "shape":"ImageTagMutability", + "documentation":"

The tag mutability setting for the repository. If this parameter is omitted, the default setting of MUTABLE will be used which will allow image tags to be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

" + }, + "imageScanningConfiguration":{ + "shape":"ImageScanningConfiguration", + "documentation":"

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.

" + } + } + }, + "CreateRepositoryResponse":{ + "type":"structure", + "members":{ + "repository":{ + "shape":"Repository", + "documentation":"

The repository that was created.

" + } + } + }, + "CreationTimestamp":{"type":"timestamp"}, + "DeleteLifecyclePolicyRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository.

" + } + } + }, + "DeleteLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON lifecycle policy text.

" + }, + "lastEvaluatedAt":{ + "shape":"EvaluationTimestamp", + "documentation":"

The time stamp of the last time that the lifecycle policy was run.

" + } + } + }, + "DeleteRepositoryPolicyRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository policy to delete. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that is associated with the repository policy to delete.

" + } + } + }, + "DeleteRepositoryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "policyText":{ + "shape":"RepositoryPolicyText", + "documentation":"

The JSON repository policy that was deleted from the repository.

" + } + } + }, + "DeleteRepositoryRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository to delete. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to delete.

" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

If a repository contains images, forces the deletion.

" + } + } + }, + "DeleteRepositoryResponse":{ + "type":"structure", + "members":{ + "repository":{ + "shape":"Repository", + "documentation":"

The repository that was deleted.

" + } + } + }, + "DescribeImageScanFindingsRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageId" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to describe the image scan findings for. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository for the image for which to describe the scan findings.

" + }, + "imageId":{"shape":"ImageIdentifier"}, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated DescribeImageScanFindings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of image scan results returned by DescribeImageScanFindings in paginated output. When this parameter is used, DescribeImageScanFindings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImageScanFindings request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImageScanFindings returns up to 100 results and a nextToken value, if applicable.

" + } + } + }, + "DescribeImageScanFindingsResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "imageId":{"shape":"ImageIdentifier"}, + "imageScanStatus":{ + "shape":"ImageScanStatus", + "documentation":"

The current state of the scan.

" + }, + "imageScanFindings":{ + "shape":"ImageScanFindings", + "documentation":"

The information contained in the image scan findings.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future DescribeImageScanFindings request. When the results of a DescribeImageScanFindings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeImagesFilter":{ + "type":"structure", + "members":{ + "tagStatus":{ + "shape":"TagStatus", + "documentation":"

The tag status with which to filter your DescribeImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

" + } + }, + "documentation":"

An object representing a filter on a DescribeImages operation.

" + }, + "DescribeImagesRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to describe images. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository that contains the images to describe.

" + }, + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

The list of image IDs for the requested repository.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated DescribeImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify images with imageIds.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of repository results returned by DescribeImages in paginated output. When this parameter is used, DescribeImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeImages returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify images with imageIds.

" + }, + "filter":{ + "shape":"DescribeImagesFilter", + "documentation":"

The filter key and value with which to filter your DescribeImages results.

" + } + } + }, + "DescribeImagesResponse":{ + "type":"structure", + "members":{ + "imageDetails":{ + "shape":"ImageDetailList", + "documentation":"

A list of ImageDetail objects that contain data about the image.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future DescribeImages request. When the results of a DescribeImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "DescribeRepositoriesRequest":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repositories to be described. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryNames":{ + "shape":"RepositoryNameList", + "documentation":"

A list of repositories to describe. If this parameter is omitted, then all repositories in a registry are described.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated DescribeRepositories request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return. This option cannot be used when you specify repositories with repositoryNames.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of repository results returned by DescribeRepositories in paginated output. When this parameter is used, DescribeRepositories only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeRepositories request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then DescribeRepositories returns up to 100 results and a nextToken value, if applicable. This option cannot be used when you specify repositories with repositoryNames.

" + } + } + }, + "DescribeRepositoriesResponse":{ + "type":"structure", + "members":{ + "repositories":{ + "shape":"RepositoryList", + "documentation":"

A list of repository objects corresponding to valid repositories.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future DescribeRepositories request. When the results of a DescribeRepositories request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "EmptyUploadException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified layer upload does not contain any layer parts.

", + "exception":true + }, + "EvaluationTimestamp":{"type":"timestamp"}, + "ExceptionMessage":{"type":"string"}, + "ExpirationTimestamp":{"type":"timestamp"}, + "FindingDescription":{"type":"string"}, + "FindingName":{"type":"string"}, + "FindingSeverity":{ + "type":"string", + "enum":[ + "INFORMATIONAL", + "LOW", + "MEDIUM", + "HIGH", + "CRITICAL", + "UNDEFINED" + ] + }, + "FindingSeverityCounts":{ + "type":"map", + "key":{"shape":"FindingSeverity"}, + "value":{"shape":"SeverityCount"} + }, + "ForceFlag":{"type":"boolean"}, + "GetAuthorizationTokenRegistryIdList":{ + "type":"list", + "member":{"shape":"RegistryId"}, + "max":10, + "min":1 + }, + "GetAuthorizationTokenRequest":{ + "type":"structure", + "members":{ + "registryIds":{ + "shape":"GetAuthorizationTokenRegistryIdList", + "documentation":"

A list of AWS account IDs that are associated with the registries for which to get authorization tokens. If you do not specify a registry, the default registry is assumed.

" + } + } + }, + "GetAuthorizationTokenResponse":{ + "type":"structure", + "members":{ + "authorizationData":{ + "shape":"AuthorizationDataList", + "documentation":"

A list of authorization token data objects that correspond to the registryIds values in the request.

" + } + } + }, + "GetDownloadUrlForLayerRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "layerDigest" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the image layer to download. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that is associated with the image layer to download.

" + }, + "layerDigest":{ + "shape":"LayerDigest", + "documentation":"

The digest of the image layer to download.

" + } + } + }, + "GetDownloadUrlForLayerResponse":{ + "type":"structure", + "members":{ + "downloadUrl":{ + "shape":"Url", + "documentation":"

The pre-signed Amazon S3 download URL for the requested layer.

" + }, + "layerDigest":{ + "shape":"LayerDigest", + "documentation":"

The digest of the image layer to download.

" + } + } + }, + "GetLifecyclePolicyPreviewRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository.

" + }, + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

The list of imageIDs to be included.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated
 GetLifecyclePolicyPreviewRequest request where maxResults was used and the
 results exceeded the value of that parameter. Pagination continues from the end of the
 previous results that returned the nextToken value. This value is
 null when there are no more results to return. This option cannot be used when you specify images with imageIds.

" + }, + "maxResults":{ + "shape":"LifecyclePreviewMaxResults", + "documentation":"

The maximum number of repository results returned by GetLifecyclePolicyPreviewRequest in
 paginated output. When this parameter is used, GetLifecyclePolicyPreviewRequest only returns
 maxResults results in a single page along with a nextToken
 response element. The remaining results of the initial request can be seen by sending
 another GetLifecyclePolicyPreviewRequest request with the returned nextToken
 value. This value can be between 1 and 1000. If this
 parameter is not used, then GetLifecyclePolicyPreviewRequest returns up to
 100 results and a nextToken value, if
 applicable. This option cannot be used when you specify images with imageIds.

" + }, + "filter":{ + "shape":"LifecyclePolicyPreviewFilter", + "documentation":"

An optional parameter that filters results based on image tag status and all tags, if tagged.

" + } + } + }, + "GetLifecyclePolicyPreviewResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON lifecycle policy text.

" + }, + "status":{ + "shape":"LifecyclePolicyPreviewStatus", + "documentation":"

The status of the lifecycle policy preview request.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future GetLifecyclePolicyPreview request. When the results of a GetLifecyclePolicyPreview request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "previewResults":{ + "shape":"LifecyclePolicyPreviewResultList", + "documentation":"

The results of the lifecycle policy preview request.

" + }, + "summary":{ + "shape":"LifecyclePolicyPreviewSummary", + "documentation":"

The list of images that is returned as a result of the action.

" + } + } + }, + "GetLifecyclePolicyRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository.

" + } + } + }, + "GetLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON lifecycle policy text.

" + }, + "lastEvaluatedAt":{ + "shape":"EvaluationTimestamp", + "documentation":"

The time stamp of the last time that the lifecycle policy was run.

" + } + } + }, + "GetRepositoryPolicyRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository with the policy to retrieve.

" + } + } + }, + "GetRepositoryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "policyText":{ + "shape":"RepositoryPolicyText", + "documentation":"

The JSON repository policy text associated with the repository.

" + } + } + }, + "Image":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry containing the image.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository associated with the image.

" + }, + "imageId":{ + "shape":"ImageIdentifier", + "documentation":"

An object containing the image tag and image digest associated with an image.

" + }, + "imageManifest":{ + "shape":"ImageManifest", + "documentation":"

The image manifest associated with the image.

" + } + }, + "documentation":"

An object representing an Amazon ECR image.

" + }, + "ImageActionType":{ + "type":"string", + "enum":["EXPIRE"] + }, + "ImageAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified image has already been pushed, and there were no changes to the manifest or image tag after the last push.

", + "exception":true + }, + "ImageCount":{ + "type":"integer", + "min":0 + }, + "ImageDetail":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry to which this image belongs.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to which this image belongs.

" + }, + "imageDigest":{ + "shape":"ImageDigest", + "documentation":"

The sha256 digest of the image manifest.

" + }, + "imageTags":{ + "shape":"ImageTagList", + "documentation":"

The list of tags associated with this image.

" + }, + "imageSizeInBytes":{ + "shape":"ImageSizeInBytes", + "documentation":"

The size, in bytes, of the image in the repository.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

" + }, + "imagePushedAt":{ + "shape":"PushTimestamp", + "documentation":"

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

" + }, + "imageScanStatus":{ + "shape":"ImageScanStatus", + "documentation":"

The current state of the scan.

" + }, + "imageScanFindingsSummary":{ + "shape":"ImageScanFindingsSummary", + "documentation":"

A summary of the last completed image scan.

" + } + }, + "documentation":"

An object that describes an image returned by a DescribeImages operation.

" + }, + "ImageDetailList":{ + "type":"list", + "member":{"shape":"ImageDetail"} + }, + "ImageDigest":{"type":"string"}, + "ImageFailure":{ + "type":"structure", + "members":{ + "imageId":{ + "shape":"ImageIdentifier", + "documentation":"

The image ID associated with the failure.

" + }, + "failureCode":{ + "shape":"ImageFailureCode", + "documentation":"

The code associated with the failure.

" + }, + "failureReason":{ + "shape":"ImageFailureReason", + "documentation":"

The reason for the failure.

" + } + }, + "documentation":"

An object representing an Amazon ECR image failure.

" + }, + "ImageFailureCode":{ + "type":"string", + "enum":[ + "InvalidImageDigest", + "InvalidImageTag", + "ImageTagDoesNotMatchDigest", + "ImageNotFound", + "MissingDigestAndTag" + ] + }, + "ImageFailureList":{ + "type":"list", + "member":{"shape":"ImageFailure"} + }, + "ImageFailureReason":{"type":"string"}, + "ImageIdentifier":{ + "type":"structure", + "members":{ + "imageDigest":{ + "shape":"ImageDigest", + "documentation":"

The sha256 digest of the image manifest.

" + }, + "imageTag":{ + "shape":"ImageTag", + "documentation":"

The tag used for the image.

" + } + }, + "documentation":"

An object with identifying information for an Amazon ECR image.

" + }, + "ImageIdentifierList":{ + "type":"list", + "member":{"shape":"ImageIdentifier"}, + "max":100, + "min":1 + }, + "ImageList":{ + "type":"list", + "member":{"shape":"Image"} + }, + "ImageManifest":{ + "type":"string", + "max":4194304, + "min":1 + }, + "ImageNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The image requested does not exist in the specified repository.

", + "exception":true + }, + "ImageScanFinding":{ + "type":"structure", + "members":{ + "name":{ + "shape":"FindingName", + "documentation":"

The name associated with the finding, usually a CVE number.

" + }, + "description":{ + "shape":"FindingDescription", + "documentation":"

The description of the finding.

" + }, + "uri":{ + "shape":"Url", + "documentation":"

A link containing additional details about the security vulnerability.

" + }, + "severity":{ + "shape":"FindingSeverity", + "documentation":"

The finding severity.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

A collection of attributes of the host from which the finding is generated.

" + } + }, + "documentation":"

Contains information about an image scan finding.

" + }, + "ImageScanFindingList":{ + "type":"list", + "member":{"shape":"ImageScanFinding"} + }, + "ImageScanFindings":{ + "type":"structure", + "members":{ + "imageScanCompletedAt":{ + "shape":"ScanTimestamp", + "documentation":"

The time of the last completed image scan.

" + }, + "vulnerabilitySourceUpdatedAt":{ + "shape":"VulnerabilitySourceUpdateTimestamp", + "documentation":"

The time when the vulnerability data was last scanned.

" + }, + "findings":{ + "shape":"ImageScanFindingList", + "documentation":"

The findings from the image scan.

" + }, + "findingSeverityCounts":{ + "shape":"FindingSeverityCounts", + "documentation":"

The image vulnerability counts, sorted by severity.

" + } + }, + "documentation":"

The details of an image scan.

" + }, + "ImageScanFindingsSummary":{ + "type":"structure", + "members":{ + "imageScanCompletedAt":{ + "shape":"ScanTimestamp", + "documentation":"

The time of the last completed image scan.

" + }, + "vulnerabilitySourceUpdatedAt":{ + "shape":"VulnerabilitySourceUpdateTimestamp", + "documentation":"

The time when the vulnerability data was last scanned.

" + }, + "findingSeverityCounts":{ + "shape":"FindingSeverityCounts", + "documentation":"

The image vulnerability counts, sorted by severity.

" + } + }, + "documentation":"

A summary of the last completed image scan.

" + }, + "ImageScanStatus":{ + "type":"structure", + "members":{ + "status":{ + "shape":"ScanStatus", + "documentation":"

The current state of an image scan.

" + }, + "description":{ + "shape":"ScanStatusDescription", + "documentation":"

The description of the image scan status.

" + } + }, + "documentation":"

The current status of an image scan.

" + }, + "ImageScanningConfiguration":{ + "type":"structure", + "members":{ + "scanOnPush":{ + "shape":"ScanOnPushFlag", + "documentation":"

The setting that determines whether images are scanned after being pushed to a repository. If set to true, images will be scanned after being pushed. If this parameter is not specified, it will default to false and images will not be scanned unless a scan is manually started with the StartImageScan API.

" + } + }, + "documentation":"

The image scanning configuration for a repository.

" + }, + "ImageSizeInBytes":{"type":"long"}, + "ImageTag":{ + "type":"string", + "max":300, + "min":1 + }, + "ImageTagAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.

", + "exception":true + }, + "ImageTagList":{ + "type":"list", + "member":{"shape":"ImageTag"} + }, + "ImageTagMutability":{ + "type":"string", + "enum":[ + "MUTABLE", + "IMMUTABLE" + ] + }, + "InitiateLayerUploadRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry to which you intend to upload layers. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to which you intend to upload layers.

" + } + } + }, + "InitiateLayerUploadResponse":{ + "type":"structure", + "members":{ + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID for the layer upload. This parameter is passed to further UploadLayerPart and CompleteLayerUpload operations.

" + }, + "partSize":{ + "shape":"PartSize", + "documentation":"

The size, in bytes, that Amazon ECR expects future layer part uploads to be.

" + } + } + }, + "InvalidLayerException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The layer digest calculation performed by Amazon ECR upon receipt of the image layer does not match the digest specified.

", + "exception":true + }, + "InvalidLayerPartException":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the exception.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the exception.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID associated with the exception.

" + }, + "lastValidByteReceived":{ + "shape":"PartSize", + "documentation":"

The last valid byte received from the layer part upload that is associated with the exception.

" + }, + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The layer part size is not valid, or the first byte specified is not consecutive to the last byte of a previous layer part upload.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", + "exception":true + }, + "InvalidTagParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

", + "exception":true + }, + "Layer":{ + "type":"structure", + "members":{ + "layerDigest":{ + "shape":"LayerDigest", + "documentation":"

The sha256 digest of the image layer.

" + }, + "layerAvailability":{ + "shape":"LayerAvailability", + "documentation":"

The availability status of the image layer.

" + }, + "layerSize":{ + "shape":"LayerSizeInBytes", + "documentation":"

The size, in bytes, of the image layer.

" + }, + "mediaType":{ + "shape":"MediaType", + "documentation":"

The media type of the layer, such as application/vnd.docker.image.rootfs.diff.tar.gzip or application/vnd.oci.image.layer.v1.tar+gzip.

" + } + }, + "documentation":"

An object representing an Amazon ECR image layer.

" + }, + "LayerAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The image layer already exists in the associated repository.

", + "exception":true + }, + "LayerAvailability":{ + "type":"string", + "enum":[ + "AVAILABLE", + "UNAVAILABLE" + ] + }, + "LayerDigest":{ + "type":"string", + "pattern":"[a-zA-Z0-9-_+.]+:[a-fA-F0-9]+" + }, + "LayerDigestList":{ + "type":"list", + "member":{"shape":"LayerDigest"}, + "max":100, + "min":1 + }, + "LayerFailure":{ + "type":"structure", + "members":{ + "layerDigest":{ + "shape":"BatchedOperationLayerDigest", + "documentation":"

The layer digest associated with the failure.

" + }, + "failureCode":{ + "shape":"LayerFailureCode", + "documentation":"

The failure code associated with the failure.

" + }, + "failureReason":{ + "shape":"LayerFailureReason", + "documentation":"

The reason for the failure.

" + } + }, + "documentation":"

An object representing an Amazon ECR image layer failure.

" + }, + "LayerFailureCode":{ + "type":"string", + "enum":[ + "InvalidLayerDigest", + "MissingLayerDigest" + ] + }, + "LayerFailureList":{ + "type":"list", + "member":{"shape":"LayerFailure"} + }, + "LayerFailureReason":{"type":"string"}, + "LayerInaccessibleException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified layer is not available because it is not associated with an image. Unassociated image layers may be cleaned up at any time.

", + "exception":true + }, + "LayerList":{ + "type":"list", + "member":{"shape":"Layer"} + }, + "LayerPartBlob":{ + "type":"blob", + "max":20971520, + "min":0 + }, + "LayerPartTooSmallException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

Layer parts must be at least 5 MiB in size.

", + "exception":true + }, + "LayerSizeInBytes":{"type":"long"}, + "LayersNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified layers could not be found, or the specified layer is not valid for this repository.

", + "exception":true + }, + "LifecyclePolicyNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The lifecycle policy could not be found, and no policy is set to the repository.

", + "exception":true + }, + "LifecyclePolicyPreviewFilter":{ + "type":"structure", + "members":{ + "tagStatus":{ + "shape":"TagStatus", + "documentation":"

The tag status of the image.

" + } + }, + "documentation":"

The filter for the lifecycle policy preview.

" + }, + "LifecyclePolicyPreviewInProgressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The previous lifecycle policy preview request has not completed. Please try again later.

", + "exception":true + }, + "LifecyclePolicyPreviewNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

There is no dry run for this repository.

", + "exception":true + }, + "LifecyclePolicyPreviewResult":{ + "type":"structure", + "members":{ + "imageTags":{ + "shape":"ImageTagList", + "documentation":"

The list of tags associated with this image.

" + }, + "imageDigest":{ + "shape":"ImageDigest", + "documentation":"

The sha256 digest of the image manifest.

" + }, + "imagePushedAt":{ + "shape":"PushTimestamp", + "documentation":"

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

" + }, + "action":{ + "shape":"LifecyclePolicyRuleAction", + "documentation":"

The type of action to be taken.

" + }, + "appliedRulePriority":{ + "shape":"LifecyclePolicyRulePriority", + "documentation":"

The priority of the applied rule.

" + } + }, + "documentation":"

The result of the lifecycle policy preview.

" + }, + "LifecyclePolicyPreviewResultList":{ + "type":"list", + "member":{"shape":"LifecyclePolicyPreviewResult"} + }, + "LifecyclePolicyPreviewStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETE", + "EXPIRED", + "FAILED" + ] + }, + "LifecyclePolicyPreviewSummary":{ + "type":"structure", + "members":{ + "expiringImageTotalCount":{ + "shape":"ImageCount", + "documentation":"

The number of expiring images.

" + } + }, + "documentation":"

The summary of the lifecycle policy preview request.

" + }, + "LifecyclePolicyRuleAction":{ + "type":"structure", + "members":{ + "type":{ + "shape":"ImageActionType", + "documentation":"

The type of action to be taken.

" + } + }, + "documentation":"

The type of action to be taken.

" + }, + "LifecyclePolicyRulePriority":{ + "type":"integer", + "min":1 + }, + "LifecyclePolicyText":{ + "type":"string", + "max":30720, + "min":100 + }, + "LifecyclePreviewMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The operation did not succeed because it would have exceeded a service limit for your account. For more information, see Amazon ECR Default Service Limits in the Amazon Elastic Container Registry User Guide.

", + "exception":true + }, + "ListImagesFilter":{ + "type":"structure", + "members":{ + "tagStatus":{ + "shape":"TagStatus", + "documentation":"

The tag status with which to filter your ListImages results. You can filter results based on whether they are TAGGED or UNTAGGED.

" + } + }, + "documentation":"

An object representing a filter on a ListImages operation.

" + }, + "ListImagesRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository with image IDs to be listed.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value returned from a previous paginated ListImages request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of image results returned by ListImages in paginated output. When this parameter is used, ListImages only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListImages request with the returned nextToken value. This value can be between 1 and 1000. If this parameter is not used, then ListImages returns up to 100 results and a nextToken value, if applicable.

" + }, + "filter":{ + "shape":"ListImagesFilter", + "documentation":"

The filter key and value with which to filter your ListImages results.

" + } + } + }, + "ListImagesResponse":{ + "type":"structure", + "members":{ + "imageIds":{ + "shape":"ImageIdentifierList", + "documentation":"

The list of image IDs for the requested repository.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The nextToken value to include in a future ListImages request. When the results of a ListImages request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the only supported resource is an Amazon ECR repository.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The tags for the resource.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "MediaType":{"type":"string"}, + "MediaTypeList":{ + "type":"list", + "member":{"shape":"MediaType"}, + "max":100, + "min":1 + }, + "NextToken":{"type":"string"}, + "PartSize":{ + "type":"long", + "min":0 + }, + "ProxyEndpoint":{"type":"string"}, + "PushTimestamp":{"type":"timestamp"}, + "PutImageRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageManifest" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository in which to put the image.

" + }, + "imageManifest":{ + "shape":"ImageManifest", + "documentation":"

The image manifest corresponding to the image to be uploaded.

" + }, + "imageTag":{ + "shape":"ImageTag", + "documentation":"

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.

" + } + } + }, + "PutImageResponse":{ + "type":"structure", + "members":{ + "image":{ + "shape":"Image", + "documentation":"

Details of the image uploaded.

" + } + } + }, + "PutImageScanningConfigurationRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageScanningConfiguration" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to update the image scanning configuration setting. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository in which to update the image scanning configuration setting.

" + }, + "imageScanningConfiguration":{ + "shape":"ImageScanningConfiguration", + "documentation":"

The image scanning configuration for the repository. This setting determines whether images are scanned for known vulnerabilities after being pushed to the repository.

" + } + } + }, + "PutImageScanningConfigurationResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "imageScanningConfiguration":{ + "shape":"ImageScanningConfiguration", + "documentation":"

The image scanning configuration setting for the repository.

" + } + } + }, + "PutImageTagMutabilityRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageTagMutability" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository in which to update the image tag mutability settings.

" + }, + "imageTagMutability":{ + "shape":"ImageTagMutability", + "documentation":"

The tag mutability setting for the repository. If MUTABLE is specified, image tags can be overwritten. If IMMUTABLE is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.

" + } + } + }, + "PutImageTagMutabilityResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "imageTagMutability":{ + "shape":"ImageTagMutability", + "documentation":"

The image tag mutability setting for the repository.

" + } + } + }, + "PutLifecyclePolicyRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "lifecyclePolicyText" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to receive the policy.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON repository policy text to apply to the repository.

" + } + } + }, + "PutLifecyclePolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON repository policy text.

" + } + } + }, + "RegistryId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "Repository":{ + "type":"structure", + "members":{ + "repositoryArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the repository. The ARN contains the arn:aws:ecr namespace, followed by the region of the repository, AWS account ID of the repository owner, repository namespace, and repository name. For example, arn:aws:ecr:region:012345678910:repository/test.

" + }, + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository.

" + }, + "repositoryUri":{ + "shape":"Url", + "documentation":"

The URI for the repository. You can use this URI for Docker push or pull operations.

" + }, + "createdAt":{ + "shape":"CreationTimestamp", + "documentation":"

The date and time, in JavaScript date format, when the repository was created.

" + }, + "imageTagMutability":{ + "shape":"ImageTagMutability", + "documentation":"

The tag mutability setting for the repository.

" + }, + "imageScanningConfiguration":{"shape":"ImageScanningConfiguration"} + }, + "documentation":"

An object representing a repository.

" + }, + "RepositoryAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified repository already exists in the specified registry.

", + "exception":true + }, + "RepositoryList":{ + "type":"list", + "member":{"shape":"Repository"} + }, + "RepositoryName":{ + "type":"string", + "max":256, + "min":2, + "pattern":"(?:[a-z0-9]+(?:[._-][a-z0-9]+)*/)*[a-z0-9]+(?:[._-][a-z0-9]+)*" + }, + "RepositoryNameList":{ + "type":"list", + "member":{"shape":"RepositoryName"}, + "max":100, + "min":1 + }, + "RepositoryNotEmptyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified repository contains images. To delete a repository that contains images, you must force the deletion with the force parameter.

", + "exception":true + }, + "RepositoryNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified repository could not be found. Check the spelling of the specified repository and ensure that you are performing operations on the correct registry.

", + "exception":true + }, + "RepositoryPolicyNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The specified repository and registry combination does not have an associated repository policy.

", + "exception":true + }, + "RepositoryPolicyText":{ + "type":"string", + "max":10240, + "min":0 + }, + "ScanNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified image scan could not be found. Ensure that image scanning is enabled on the repository and try again.

", + "exception":true + }, + "ScanOnPushFlag":{"type":"boolean"}, + "ScanStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETE", + "FAILED" + ] + }, + "ScanStatusDescription":{"type":"string"}, + "ScanTimestamp":{"type":"timestamp"}, + "ServerException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

These errors are usually caused by a server-side issue.

", + "exception":true, + "fault":true + }, + "SetRepositoryPolicyRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "policyText" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to receive the policy.

" + }, + "policyText":{ + "shape":"RepositoryPolicyText", + "documentation":"

The JSON repository policy text to apply to the repository. For more information, see Amazon ECR Repository Policy Examples in the Amazon Elastic Container Registry User Guide.

" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

If the policy you are attempting to set on a repository policy would prevent you from setting another policy in the future, you must force the SetRepositoryPolicy operation. This is intended to prevent accidental repository lock outs.

" + } + } + }, + "SetRepositoryPolicyResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "policyText":{ + "shape":"RepositoryPolicyText", + "documentation":"

The JSON repository policy text applied to the repository.

" + } + } + }, + "SeverityCount":{ + "type":"integer", + "min":0 + }, + "StartImageScanRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "imageId" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository in which to start an image scan request. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository that contains the images to scan.

" + }, + "imageId":{"shape":"ImageIdentifier"} + } + }, + "StartImageScanResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "imageId":{"shape":"ImageIdentifier"}, + "imageScanStatus":{ + "shape":"ImageScanStatus", + "documentation":"

The current state of the scan.

" + } + } + }, + "StartLifecyclePolicyPreviewRequest":{ + "type":"structure", + "required":["repositoryName"], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to be evaluated.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The policy to be evaluated against. If you do not specify a policy, the current policy for the repository is used.

" + } + } + }, + "StartLifecyclePolicyPreviewResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "lifecyclePolicyText":{ + "shape":"LifecyclePolicyText", + "documentation":"

The JSON repository policy text.

" + }, + "status":{ + "shape":"LifecyclePolicyPreviewStatus", + "documentation":"

The status of the lifecycle policy preview request.

" + } + } + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the the resource to which to add tags. Currently, the only supported resource is an Amazon ECR repository.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagStatus":{ + "type":"string", + "enum":[ + "TAGGED", + "UNTAGGED", + "ANY" + ] + }, + "TagValue":{"type":"string"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which to remove tags. Currently, the only supported resource is an Amazon ECR repository.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of the tags to be removed.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UploadId":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "UploadLayerPartRequest":{ + "type":"structure", + "required":[ + "repositoryName", + "uploadId", + "partFirstByte", + "partLastByte", + "layerPartBlob" + ], + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The AWS account ID associated with the registry to which you are uploading layer parts. If you do not specify a registry, the default registry is assumed.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The name of the repository to which you are uploading layer parts.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID from a previous InitiateLayerUpload operation to associate with the layer part upload.

" + }, + "partFirstByte":{ + "shape":"PartSize", + "documentation":"

The integer value of the first byte of the layer part.

" + }, + "partLastByte":{ + "shape":"PartSize", + "documentation":"

The integer value of the last byte of the layer part.

" + }, + "layerPartBlob":{ + "shape":"LayerPartBlob", + "documentation":"

The base64-encoded layer part payload.

" + } + } + }, + "UploadLayerPartResponse":{ + "type":"structure", + "members":{ + "registryId":{ + "shape":"RegistryId", + "documentation":"

The registry ID associated with the request.

" + }, + "repositoryName":{ + "shape":"RepositoryName", + "documentation":"

The repository name associated with the request.

" + }, + "uploadId":{ + "shape":"UploadId", + "documentation":"

The upload ID associated with the request.

" + }, + "lastByteReceived":{ + "shape":"PartSize", + "documentation":"

The integer value of the last byte received in the request.

" + } + } + }, + "UploadNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The error message associated with the exception.

" + } + }, + "documentation":"

The upload could not be found, or the specified upload id is not valid for this repository.

", + "exception":true + }, + "Url":{"type":"string"}, + "VulnerabilitySourceUpdateTimestamp":{"type":"timestamp"} + }, + "documentation":"Amazon Elastic Container Registry

Amazon Elastic Container Registry (Amazon ECR) is a managed Docker registry service. Customers can use the familiar Docker CLI to push, pull, and manage images. Amazon ECR provides a secure, scalable, and reliable registry. Amazon ECR supports private Docker repositories with resource-based permissions using IAM so that specific users or Amazon EC2 instances can access repositories and images. Developers can use the Docker CLI to author and manage images.

" +} diff --git a/aws/dist/botocore/data/ecs/2014-11-13/examples-1.json b/aws/dist/botocore/data/ecs/2014-11-13/examples-1.json new file mode 100644 index 00000000..c14ba44a --- /dev/null +++ b/aws/dist/botocore/data/ecs/2014-11-13/examples-1.json @@ -0,0 +1,883 @@ +{ + "version": "1.0", + "examples": { + "CreateCluster": [ + { + "input": { + "clusterName": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "ACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a cluster in your default region.", + "id": "to-create-a-new-cluster-1472514079365", + "title": "To create a new cluster" + } + ], + "CreateService": [ + { + "input": { + "desiredCount": 10, + "serviceName": "ecs-simple-service", + "taskDefinition": "hello_world" + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:13:47.298Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:13:47.298Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564342348388", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:13:47.298Z" + }, + { + "createdAt": "2016-08-29T15:52:44.481Z", + "desiredCount": 0, + "id": "ecs-svc/9223370564343611322", + "pendingCount": 0, + "runningCount": 0, + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:11:38.941Z" + } + ], + "desiredCount": 10, + "events": [ + + ], + "loadBalancers": [ + + ], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a service in your default region called ``ecs-simple-service``. The service uses the ``hello_world`` task definition and it maintains 10 copies of that task.", + "id": "to-create-a-new-service-1472512584282", + "title": "To create a new service" + }, + { + "input": { + "desiredCount": 10, + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "role": "ecsServiceRole", + "serviceName": "ecs-simple-service-elb", + "taskDefinition": "console-sample-app-static" + }, + "output": { + "service": { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:02:54.884Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:02:54.884Z", + "desiredCount": 10, + "id": "ecs-svc/9223370564343000923", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6", + "updatedAt": "2016-08-29T16:02:54.884Z" + } + ], + "desiredCount": 10, + "events": [ + + ], + "loadBalancers": [ + { + "containerName": "simple-app", + "containerPort": 80, + "loadBalancerName": "EC2Contai-EcsElast-15DCDAURT3ZO2" + } + ], + "pendingCount": 0, + "roleArn": "arn:aws:iam::012345678910:role/ecsServiceRole", + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service-elb", + "serviceName": "ecs-simple-service-elb", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/console-sample-app-static:6" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a service in your default region called ``ecs-simple-service-elb``. The service uses the ``ecs-demo`` task definition and it maintains 10 copies of that task. You must reference an existing load balancer in the same region by its name.", + "id": "to-create-a-new-service-behind-a-load-balancer-1472512484823", + "title": "To create a new service behind a load balancer" + } + ], + "DeleteCluster": [ + { + "input": { + "cluster": "my_cluster" + }, + "output": { + "cluster": { + "activeServicesCount": 0, + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/my_cluster", + "clusterName": "my_cluster", + "pendingTasksCount": 0, + "registeredContainerInstancesCount": 0, + "runningTasksCount": 0, + "status": "INACTIVE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes an empty cluster in your default region.", + "id": "to-delete-an-empty-cluster-1472512705352", + "title": "To delete an empty cluster" + } + ], + "DeleteService": [ + { + "input": { + "service": "my-http-service" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the my-http-service service. The service must have a desired count and running count of 0 before you can delete it.", + "id": "e8183e38-f86e-4390-b811-f74f30a6007d", + "title": "To delete a service" + } + ], + "DeregisterContainerInstance": [ + { + "input": { + "cluster": "default", + "containerInstance": "container_instance_UUID", + "force": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters a container instance from the specified cluster in your default region. If there are still tasks running on the container instance, you must either stop those tasks before deregistering, or use the force option.", + "id": "bf624927-cf64-4f4b-8b7e-c024a4e682f6", + "title": "To deregister a container instance from a cluster" + } + ], + "DescribeClusters": [ + { + "input": { + "clusters": [ + "default" + ] + }, + "output": { + "clusters": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:aws_account_id:cluster/default", + "clusterName": "default", + "status": "ACTIVE" + } + ], + "failures": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified cluster in your default region.", + "id": "ba88d100-9672-4231-80da-a4bd210bf728", + "title": "To describe a cluster" + } + ], + "DescribeContainerInstances": [ + { + "input": { + "cluster": "default", + "containerInstances": [ + "f2756532-8f13-4d53-87c9-aed50dc94cd7" + ] + }, + "output": { + "containerInstances": [ + { + "agentConnected": true, + "containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/f2756532-8f13-4d53-87c9-aed50dc94cd7", + "ec2InstanceId": "i-807f3249", + "pendingTasksCount": 0, + "registeredResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 2048, + "longValue": 0 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 3768, + "longValue": 0 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0.0, + "integerValue": 0, + "longValue": 0, + "stringSetValue": [ + "2376", + "22", + "51678", + "2375" + ] + } + ], + "remainingResources": [ + { + "name": "CPU", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 1948, + "longValue": 0 + }, + { + "name": "MEMORY", + "type": "INTEGER", + "doubleValue": 0.0, + "integerValue": 3668, + "longValue": 0 + }, + { + "name": "PORTS", + "type": "STRINGSET", + "doubleValue": 0.0, + "integerValue": 0, + "longValue": 0, + "stringSetValue": [ + "2376", + "22", + "80", + "51678", + "2375" + ] + } + ], + "runningTasksCount": 1, + "status": "ACTIVE" + } + ], + "failures": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified container instance in your default region, using the container instance UUID as an identifier.", + "id": "c8f439de-eb27-4269-8ca7-2c0a7ba75ab0", + "title": "To describe container instance" + } + ], + "DescribeServices": [ + { + "input": { + "services": [ + "ecs-simple-service" + ] + }, + "output": { + "failures": [ + + ], + "services": [ + { + "clusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/default", + "createdAt": "2016-08-29T16:25:52.130Z", + "deploymentConfiguration": { + "maximumPercent": 200, + "minimumHealthyPercent": 100 + }, + "deployments": [ + { + "createdAt": "2016-08-29T16:25:52.130Z", + "desiredCount": 1, + "id": "ecs-svc/9223370564341623665", + "pendingCount": 0, + "runningCount": 0, + "status": "PRIMARY", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6", + "updatedAt": "2016-08-29T16:25:52.130Z" + } + ], + "desiredCount": 1, + "events": [ + { + "createdAt": "2016-08-29T16:25:58.520Z", + "id": "38c285e5-d335-4b68-8b15-e46dedc8e88d", + "message": "(service ecs-simple-service) was unable to place a task because no container instance met all of its requirements. The closest matching (container-instance 3f4de1c5-ffdd-4954-af7e-75b4be0c8841) is already using a port required by your task. For more information, see the Troubleshooting section of the Amazon ECS Developer Guide." + } + ], + "loadBalancers": [ + + ], + "pendingCount": 0, + "runningCount": 0, + "serviceArn": "arn:aws:ecs:us-east-1:012345678910:service/ecs-simple-service", + "serviceName": "ecs-simple-service", + "status": "ACTIVE", + "taskDefinition": "arn:aws:ecs:us-east-1:012345678910:task-definition/hello_world:6" + } + ] + }, + "comments": { + "input": { + }, + "output": { + "services[0].events[0].message": "In this example, there is a service event that shows unavailable cluster resources." + } + }, + "description": "This example provides descriptive information about the service named ``ecs-simple-service``.", + "id": "to-describe-a-service-1472513256350", + "title": "To describe a service" + } + ], + "DescribeTaskDefinition": [ + { + "input": { + "taskDefinition": "hello_world:8" + }, + "output": { + "taskDefinition": { + "containerDefinitions": [ + { + "name": "wordpress", + "cpu": 10, + "environment": [ + + ], + "essential": true, + "image": "wordpress", + "links": [ + "mysql" + ], + "memory": 500, + "mountPoints": [ + + ], + "portMappings": [ + { + "containerPort": 80, + "hostPort": 80 + } + ], + "volumesFrom": [ + + ] + }, + { + "name": "mysql", + "cpu": 10, + "environment": [ + { + "name": "MYSQL_ROOT_PASSWORD", + "value": "password" + } + ], + "essential": true, + "image": "mysql", + "memory": 500, + "mountPoints": [ + + ], + "portMappings": [ + + ], + "volumesFrom": [ + + ] + } + ], + "family": "hello_world", + "revision": 8, + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/hello_world:8", + "volumes": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified task definition.", + "id": "4c21eeb1-f1da-4a08-8c44-297fc8d0ea88", + "title": "To describe a task definition" + } + ], + "DescribeTasks": [ + { + "input": { + "tasks": [ + "c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + ] + }, + "output": { + "failures": [ + + ], + "tasks": [ + { + "clusterArn": "arn:aws:ecs:::cluster/default", + "containerInstanceArn": "arn:aws:ecs:::container-instance/18f9eda5-27d7-4c19-b133-45adc516e8fb", + "containers": [ + { + "name": "ecs-demo", + "containerArn": "arn:aws:ecs:::container/7c01765b-c588-45b3-8290-4ba38bd6c5a6", + "lastStatus": "RUNNING", + "networkBindings": [ + { + "bindIP": "0.0.0.0", + "containerPort": 80, + "hostPort": 80 + } + ], + "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8" + } + ], + "desiredStatus": "RUNNING", + "lastStatus": "RUNNING", + "overrides": { + "containerOverrides": [ + { + "name": "ecs-demo" + } + ] + }, + "startedBy": "ecs-svc/9223370608528463088", + "taskArn": "arn:aws:ecs:::task/c5cba4eb-5dad-405e-96db-71ef8eefe6a8", + "taskDefinitionArn": "arn:aws:ecs:::task-definition/amazon-ecs-sample:1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example provides a description of the specified task, using the task UUID as an identifier.", + "id": "a90b0cde-f965-4946-b55e-cfd8cc54e827", + "title": "To describe a task" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "clusterArns": [ + "arn:aws:ecs:us-east-1::cluster/test", + "arn:aws:ecs:us-east-1::cluster/default" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your available clusters in your default region.", + "id": "e337d059-134f-4125-ba8e-4f499139facf", + "title": "To list your available clusters" + } + ], + "ListContainerInstances": [ + { + "input": { + "cluster": "default" + }, + "output": { + "containerInstanceArns": [ + "arn:aws:ecs:us-east-1::container-instance/f6bbb147-5370-4ace-8c73-c7181ded911f", + "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your available container instances in the specified cluster in your default region.", + "id": "62a82a94-713c-4e18-8420-1d2b2ba9d484", + "title": "To list your available container instances in a cluster" + } + ], + "ListServices": [ + { + "input": { + }, + "output": { + "serviceArns": [ + "arn:aws:ecs:us-east-1:012345678910:service/my-http-service" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the services running in the default cluster for an account.", + "id": "1d9a8037-4e0e-4234-a528-609656809a3a", + "title": "To list the services in a cluster" + } + ], + "ListTaskDefinitionFamilies": [ + { + "input": { + }, + "output": { + "families": [ + "node-js-app", + "web-timer", + "hpcc", + "hpcc-c4-8xlarge" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your registered task definition families.", + "id": "b5c89769-1d94-4ca2-a79e-8069103c7f75", + "title": "To list your registered task definition families" + }, + { + "input": { + "familyPrefix": "hpcc" + }, + "output": { + "families": [ + "hpcc", + "hpcc-c4-8xlarge" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the task definition revisions that start with \"hpcc\".", + "id": "8a4cf9a6-42c1-4fe3-852d-99ac8968e11b", + "title": "To filter your registered task definition families" + } + ], + "ListTaskDefinitions": [ + { + "input": { + }, + "output": { + "taskDefinitionArns": [ + "arn:aws:ecs:us-east-1::task-definition/sleep300:2", + "arn:aws:ecs:us-east-1::task-definition/sleep360:1", + "arn:aws:ecs:us-east-1::task-definition/wordpress:3", + "arn:aws:ecs:us-east-1::task-definition/wordpress:4", + "arn:aws:ecs:us-east-1::task-definition/wordpress:5", + "arn:aws:ecs:us-east-1::task-definition/wordpress:6" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of your registered task definitions.", + "id": "b381ebaf-7eba-4d60-b99b-7f6ae49d3d60", + "title": "To list your registered task definitions" + }, + { + "input": { + "familyPrefix": "wordpress" + }, + "output": { + "taskDefinitionArns": [ + "arn:aws:ecs:us-east-1::task-definition/wordpress:3", + "arn:aws:ecs:us-east-1::task-definition/wordpress:4", + "arn:aws:ecs:us-east-1::task-definition/wordpress:5", + "arn:aws:ecs:us-east-1::task-definition/wordpress:6" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the task definition revisions of a specified family.", + "id": "734e7afd-753a-4bc2-85d0-badddce10910", + "title": "To list the registered task definitions in a family" + } + ], + "ListTasks": [ + { + "input": { + "cluster": "default" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84", + "arn:aws:ecs:us-east-1:012345678910:task/6b809ef6-c67e-4467-921f-ee261c15a0a1" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all of the tasks in a cluster.", + "id": "9a6ec707-1a77-45d0-b2eb-516b5dd9e924", + "title": "To list the tasks in a cluster" + }, + { + "input": { + "cluster": "default", + "containerInstance": "f6bbb147-5370-4ace-8c73-c7181ded911f" + }, + "output": { + "taskArns": [ + "arn:aws:ecs:us-east-1:012345678910:task/0cc43cdb-3bee-4407-9c26-c0e6ea5bee84" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists the tasks of a specified container instance. Specifying a ``containerInstance`` value limits the results to tasks that belong to that container instance.", + "id": "024bf3b7-9cbb-44e3-848f-9d074e1fecce", + "title": "To list the tasks on a particular container instance" + } + ], + "RegisterTaskDefinition": [ + { + "input": { + "containerDefinitions": [ + { + "name": "sleep", + "command": [ + "sleep", + "360" + ], + "cpu": 10, + "essential": true, + "image": "busybox", + "memory": 10 + } + ], + "family": "sleep360", + "taskRoleArn": "", + "volumes": [ + + ] + }, + "output": { + "taskDefinition": { + "containerDefinitions": [ + { + "name": "sleep", + "command": [ + "sleep", + "360" + ], + "cpu": 10, + "environment": [ + + ], + "essential": true, + "image": "busybox", + "memory": 10, + "mountPoints": [ + + ], + "portMappings": [ + + ], + "volumesFrom": [ + + ] + } + ], + "family": "sleep360", + "revision": 1, + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:19", + "volumes": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers a task definition to the specified family.", + "id": "to-register-a-task-definition-1470764550877", + "title": "To register a task definition" + } + ], + "RunTask": [ + { + "input": { + "cluster": "default", + "taskDefinition": "sleep360:1" + }, + "output": { + "tasks": [ + { + "containerInstanceArn": "arn:aws:ecs:us-east-1::container-instance/ffe3d344-77e2-476c-a4d0-bf560ad50acb", + "containers": [ + { + "name": "sleep", + "containerArn": "arn:aws:ecs:us-east-1::container/58591c8e-be29-4ddf-95aa-ee459d4c59fd", + "lastStatus": "PENDING", + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0" + } + ], + "desiredStatus": "RUNNING", + "lastStatus": "PENDING", + "overrides": { + "containerOverrides": [ + { + "name": "sleep" + } + ] + }, + "taskArn": "arn:aws:ecs:us-east-1::task/a9f21ea7-c9f5-44b1-b8e6-b31f50ed33c0", + "taskDefinitionArn": "arn:aws:ecs:us-east-1::task-definition/sleep360:1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example runs the specified task definition on your default cluster.", + "id": "6f238c83-a133-42cd-ab3d-abeca0560445", + "title": "To run a task on your default cluster" + } + ], + "UpdateService": [ + { + "input": { + "service": "my-http-service", + "taskDefinition": "amazon-ecs-sample" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the my-http-service service to use the amazon-ecs-sample task definition.", + "id": "cc9e8900-0cc2-44d2-8491-64d1d3d37887", + "title": "To change the task definition used in a service" + }, + { + "input": { + "desiredCount": 10, + "service": "my-http-service" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example updates the desired count of the my-http-service service to 10.", + "id": "9581d6c5-02e3-4140-8cc1-5a4301586633", + "title": "To change the number of tasks in a service" + } + ] + } +} diff --git a/aws/dist/botocore/data/ecs/2014-11-13/paginators-1.json b/aws/dist/botocore/data/ecs/2014-11-13/paginators-1.json new file mode 100644 index 00000000..6aa47513 --- /dev/null +++ b/aws/dist/botocore/data/ecs/2014-11-13/paginators-1.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "ListClusters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "clusterArns" + }, + "ListContainerInstances": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "containerInstanceArns" + }, + "ListTaskDefinitions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "taskDefinitionArns" + }, + "ListTaskDefinitionFamilies": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "families" + }, + "ListTasks": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "taskArns" + }, + "ListServices": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "serviceArns" + }, + "ListAccountSettings": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "settings" + }, + "ListAttributes": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "attributes" + } + } +} diff --git a/aws/dist/botocore/data/ecs/2014-11-13/service-2.json b/aws/dist/botocore/data/ecs/2014-11-13/service-2.json new file mode 100644 index 00000000..5ddac9b7 --- /dev/null +++ b/aws/dist/botocore/data/ecs/2014-11-13/service-2.json @@ -0,0 +1,4831 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-13", + "endpointPrefix":"ecs", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon ECS", + "serviceFullName":"Amazon EC2 Container Service", + "serviceId":"ECS", + "signatureVersion":"v4", + "targetPrefix":"AmazonEC2ContainerServiceV20141113", + "uid":"ecs-2014-11-13" + }, + "operations":{ + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.

When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" + }, + "CreateService":{ + "name":"CreateService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServiceRequest"}, + "output":{"shape":"CreateServiceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"PlatformUnknownException"}, + {"shape":"PlatformTaskDefinitionIncompatibilityException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below the desiredCount, Amazon ECS runs another copy of the task in the specified cluster. To update an existing service, see UpdateService.

In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind one or more load balancers. The load balancers distribute traffic across the tasks that are associated with the service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and the container instance that they're hosted on is reported as healthy by the load balancer.

There are two service scheduler strategies available:

  • REPLICA - The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.

  • DAEMON - The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the Amazon Elastic Container Service Developer Guide.

You can optionally specify a deployment configuration for your service. The deployment is triggered by changing properties, such as the task definition or the desired count of a service, with an UpdateService operation. The default value for a replica service for minimumHealthyPercent is 100%. The default value for a daemon service for minimumHealthyPercent is 0%.

If a service is using the ECS deployment controller, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they're in the RUNNING state. Tasks for services that do use a load balancer are considered healthy if they're in the RUNNING state and they're reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the ECS deployment controller, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using either the CODE_DEPLOY or EXTERNAL deployment controller types and tasks that use the EC2 launch type, the minimum healthy percent and maximum percent values are used only to define the lower and upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent and maximum percent values aren't used, although they're currently visible when describing your service.

When creating a service that uses the EXTERNAL deployment controller, you can specify only parameters that aren't controlled at the task set level. The only required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

When the service scheduler launches new tasks, it determines task placement in your cluster using the following logic:

  • Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):

    • Sort the valid container instances, giving priority to instances that have the fewest number of running tasks for this service in their respective Availability Zone. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

" + }, + "CreateTaskSet":{ + "name":"CreateTaskSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTaskSetRequest"}, + "output":{"shape":"CreateTaskSetResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"PlatformUnknownException"}, + {"shape":"PlatformTaskDefinitionIncompatibilityException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"} + ], + "documentation":"

Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "DeleteAccountSetting":{ + "name":"DeleteAccountSetting", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountSettingRequest"}, + "output":{"shape":"DeleteAccountSettingResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Disables an account setting for a specified IAM user, IAM role, or the root user for an account.

" + }, + "DeleteAttributes":{ + "name":"DeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAttributesRequest"}, + "output":{"shape":"DeleteAttributesResponse"}, + "errors":[ + {"shape":"ClusterNotFoundException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Deletes one or more custom attributes from an Amazon ECS resource.

" + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterRequest"}, + "output":{"shape":"DeleteClusterResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ClusterContainsContainerInstancesException"}, + {"shape":"ClusterContainsServicesException"}, + {"shape":"ClusterContainsTasksException"} + ], + "documentation":"

Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.

" + }, + "DeleteService":{ + "name":"DeleteService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceRequest"}, + "output":{"shape":"DeleteServiceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ServiceNotFoundException"} + ], + "documentation":"

Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.

When you delete a service, if there are still running tasks that require cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in the ListServices API operation. After all tasks have transitioned to either STOPPING or STOPPED status, the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with the DescribeServices API operation. However, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices calls on those services return a ServiceNotFoundException error.

If you attempt to create a new service with the same name as an existing service in either ACTIVE or DRAINING status, you receive an error.

" + }, + "DeleteTaskSet":{ + "name":"DeleteTaskSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTaskSetRequest"}, + "output":{"shape":"DeleteTaskSetResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"}, + {"shape":"TaskSetNotFoundException"} + ], + "documentation":"

Deletes a specified task set within a service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "DeregisterContainerInstance":{ + "name":"DeregisterContainerInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterContainerInstanceRequest"}, + "output":{"shape":"DeregisterContainerInstanceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

" + }, + "DeregisterTaskDefinition":{ + "name":"DeregisterTaskDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterTaskDefinitionRequest"}, + "output":{"shape":"DeregisterTaskDefinitionResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.

You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.

At this time, INACTIVE task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.

" + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClustersRequest"}, + "output":{"shape":"DescribeClustersResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Describes one or more of your clusters.

" + }, + "DescribeContainerInstances":{ + "name":"DescribeContainerInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeContainerInstancesRequest"}, + "output":{"shape":"DescribeContainerInstancesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.

" + }, + "DescribeServices":{ + "name":"DescribeServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServicesRequest"}, + "output":{"shape":"DescribeServicesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Describes the specified services running in your cluster.

" + }, + "DescribeTaskDefinition":{ + "name":"DescribeTaskDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTaskDefinitionRequest"}, + "output":{"shape":"DescribeTaskDefinitionResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.

You can only describe INACTIVE task definitions while an active task or service references them.

" + }, + "DescribeTaskSets":{ + "name":"DescribeTaskSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTaskSetsRequest"}, + "output":{"shape":"DescribeTaskSetsResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"} + ], + "documentation":"

Describes the task sets in the specified cluster and service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "DescribeTasks":{ + "name":"DescribeTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTasksRequest"}, + "output":{"shape":"DescribeTasksResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Describes a specified task or tasks.

" + }, + "DiscoverPollEndpoint":{ + "name":"DiscoverPollEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DiscoverPollEndpointRequest"}, + "output":{"shape":"DiscoverPollEndpointResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"} + ], + "documentation":"

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Returns an endpoint for the Amazon ECS agent to poll for updates.

" + }, + "ListAccountSettings":{ + "name":"ListAccountSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountSettingsRequest"}, + "output":{"shape":"ListAccountSettingsResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Lists the account settings for a specified principal.

" + }, + "ListAttributes":{ + "name":"ListAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttributesRequest"}, + "output":{"shape":"ListAttributesResponse"}, + "errors":[ + {"shape":"ClusterNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).

" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClustersRequest"}, + "output":{"shape":"ListClustersResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Returns a list of existing clusters.

" + }, + "ListContainerInstances":{ + "name":"ListContainerInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListContainerInstancesRequest"}, + "output":{"shape":"ListContainerInstancesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" + }, + "ListServices":{ + "name":"ListServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServicesRequest"}, + "output":{"shape":"ListServicesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Lists the services that are running in a specified cluster.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

List the tags for an Amazon ECS resource.

" + }, + "ListTaskDefinitionFamilies":{ + "name":"ListTaskDefinitionFamilies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTaskDefinitionFamiliesRequest"}, + "output":{"shape":"ListTaskDefinitionFamiliesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definition revisions).

You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.

" + }, + "ListTaskDefinitions":{ + "name":"ListTaskDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTaskDefinitionsRequest"}, + "output":{"shape":"ListTaskDefinitionsResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.

" + }, + "ListTasks":{ + "name":"ListTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTasksRequest"}, + "output":{"shape":"ListTasksResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ServiceNotFoundException"} + ], + "documentation":"

Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.

Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.

" + }, + "PutAccountSetting":{ + "name":"PutAccountSetting", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAccountSettingRequest"}, + "output":{"shape":"PutAccountSettingResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Modifies an account setting. Account settings are set on a per-Region basis.

If you change the account setting for the root user, the default settings for all of the IAM users and roles for which no individual account setting has been specified are reset. For more information, see Account Settings in the Amazon Elastic Container Service Developer Guide.

When serviceLongArnFormat, taskLongArnFormat, or containerInstanceLongArnFormat are specified, the Amazon Resource Name (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or the root user for an account is affected. The opt-in and opt-out account setting must be set for each Amazon ECS resource separately. The ARN and resource ID format of a resource will be defined by the opt-in status of the IAM user or role that created the resource. You must enable this setting to use Amazon ECS features such as resource tagging.

When awsvpcTrunking is specified, the elastic network interface (ENI) limit for any new container instances that support the feature is changed. If awsvpcTrunking is enabled, any new container instances that support the feature are launched have the increased ENI limits available to them. For more information, see Elastic Network Interface Trunking in the Amazon Elastic Container Service Developer Guide.

When containerInsights is specified, the default setting indicating whether CloudWatch Container Insights is enabled for your clusters is changed. If containerInsights is enabled, any new clusters that are created will have Container Insights enabled unless you disable it during cluster creation. For more information, see CloudWatch Container Insights in the Amazon Elastic Container Service Developer Guide.

" + }, + "PutAccountSettingDefault":{ + "name":"PutAccountSettingDefault", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAccountSettingDefaultRequest"}, + "output":{"shape":"PutAccountSettingDefaultResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified. Account settings are set on a per-Region basis.

" + }, + "PutAttributes":{ + "name":"PutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAttributesRequest"}, + "output":{"shape":"PutAttributesResponse"}, + "errors":[ + {"shape":"ClusterNotFoundException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"AttributeLimitExceededException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" + }, + "RegisterContainerInstance":{ + "name":"RegisterContainerInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterContainerInstanceRequest"}, + "output":{"shape":"RegisterContainerInstanceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.

" + }, + "RegisterTaskDefinition":{ + "name":"RegisterTaskDefinition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterTaskDefinitionRequest"}, + "output":{"shape":"RegisterTaskDefinitionResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

" + }, + "RunTask":{ + "name":"RunTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunTaskRequest"}, + "output":{"shape":"RunTaskResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"PlatformUnknownException"}, + {"shape":"PlatformTaskDefinitionIncompatibilityException"}, + {"shape":"AccessDeniedException"}, + {"shape":"BlockedException"} + ], + "documentation":"

Starts a new task using the specified task definition.

You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.

The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. Keep this in mind when you carry out an API command that immediately follows a previous API command.

To manage eventual consistency, you can do the following:

  • Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time and increasing gradually up to five minutes of wait time.

  • Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.

" + }, + "StartTask":{ + "name":"StartTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTaskRequest"}, + "output":{"shape":"StartTaskResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Starts a new task from the specified task definition on the specified container instance or instances.

Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks in the Amazon Elastic Container Service Developer Guide.

" + }, + "StopTask":{ + "name":"StopTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTaskRequest"}, + "output":{"shape":"StopTaskResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Stops a running task. Any tags associated with the task will be deleted.

When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM value and a default 30-second timeout, after which the SIGKILL value is sent and the containers are forcibly stopped. If the container handles the SIGTERM value gracefully and exits within 30 seconds from receiving it, no SIGKILL value is sent.

The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

" + }, + "SubmitAttachmentStateChanges":{ + "name":"SubmitAttachmentStateChanges", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubmitAttachmentStateChangesRequest"}, + "output":{"shape":"SubmitAttachmentStateChangesResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that an attachment changed states.

" + }, + "SubmitContainerStateChange":{ + "name":"SubmitContainerStateChange", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubmitContainerStateChangeRequest"}, + "output":{"shape":"SubmitContainerStateChangeResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a container changed states.

" + }, + "SubmitTaskStateChange":{ + "name":"SubmitTaskStateChange", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubmitTaskStateChangeRequest"}, + "output":{"shape":"SubmitTaskStateChangeResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.

Sent to acknowledge that a task changed states.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Deletes specified tags from a resource.

" + }, + "UpdateClusterSettings":{ + "name":"UpdateClusterSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateClusterSettingsRequest"}, + "output":{"shape":"UpdateClusterSettingsResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Modifies the settings to use for a cluster.

" + }, + "UpdateContainerAgent":{ + "name":"UpdateContainerAgent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateContainerAgentRequest"}, + "output":{"shape":"UpdateContainerAgentResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UpdateInProgressException"}, + {"shape":"NoUpdateAvailableException"}, + {"shape":"MissingVersionException"} + ], + "documentation":"

Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.

UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide.

" + }, + "UpdateContainerInstancesState":{ + "name":"UpdateContainerInstancesState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateContainerInstancesStateRequest"}, + "output":{"shape":"UpdateContainerInstancesStateResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"} + ], + "documentation":"

Modifies the status of an Amazon ECS container instance.

Once a container instance has reached an ACTIVE state, you can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.

A container instance cannot be changed to DRAINING until it has reached an ACTIVE status. If the instance is in any other status, an error will be received.

When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.

Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained, provided that the cluster resources required to do this are available. If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.

Any PENDING or RUNNING tasks that do not belong to a service are not affected. You must wait for them to finish or stop them manually.

A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.

When a container instance has been drained, you can set a container instance to ACTIVE status and once it has reached that status the Amazon ECS scheduler can begin scheduling tasks on the instance again.

" + }, + "UpdateService":{ + "name":"UpdateService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceRequest"}, + "output":{"shape":"UpdateServiceResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"}, + {"shape":"PlatformUnknownException"}, + {"shape":"PlatformTaskDefinitionIncompatibilityException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Modifies the parameters of a service.

For services using the rolling update (ECS) deployment controller, the desired count, deployment configuration, network configuration, or task definition used can be updated.

For services using the blue/green (CODE_DEPLOY) deployment controller, only the desired count, deployment configuration, and health check grace period can be updated using this API. If the network configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.

For services using an external deployment controller, you can update only the desired count and health check grace period using this API. If the launch type, load balancer, network configuration, platform version, or task definition need to be updated, you should create a new task set. For more information, see CreateTaskSet.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.

If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.

You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.

  • If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.

  • The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if desiredCount is four tasks, a maximum of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).

When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it determines task placement in your cluster with the following logic:

  • Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).

  • By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):

    • Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.

    • Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:

  • Sort the container instances by the largest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have two, container instances in either zone B or C are considered optimal for termination.

  • Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.

" + }, + "UpdateServicePrimaryTaskSet":{ + "name":"UpdateServicePrimaryTaskSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServicePrimaryTaskSetRequest"}, + "output":{"shape":"UpdateServicePrimaryTaskSetResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"}, + {"shape":"TaskSetNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "UpdateTaskSet":{ + "name":"UpdateTaskSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTaskSetRequest"}, + "output":{"shape":"UpdateTaskSetResponse"}, + "errors":[ + {"shape":"ServerException"}, + {"shape":"ClientException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClusterNotFoundException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceNotFoundException"}, + {"shape":"ServiceNotActiveException"}, + {"shape":"TaskSetNotFoundException"} + ], + "documentation":"

Modifies a task set. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You do not have authorization to perform the requested action.

", + "exception":true + }, + "AgentUpdateStatus":{ + "type":"string", + "enum":[ + "PENDING", + "STAGING", + "STAGED", + "UPDATING", + "UPDATED", + "FAILED" + ] + }, + "AssignPublicIp":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "Attachment":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The unique identifier for the attachment.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of the attachment, such as ElasticNetworkInterface.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, ATTACHED, DETACHING, DETACHED, and DELETED.

" + }, + "details":{ + "shape":"AttachmentDetails", + "documentation":"

Details of the attachment. For elastic network interfaces, this includes the network interface ID, the MAC address, the subnet ID, and the private IPv4 address.

" + } + }, + "documentation":"

An object representing a container instance or task attachment.

" + }, + "AttachmentDetails":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "AttachmentStateChange":{ + "type":"structure", + "required":[ + "attachmentArn", + "status" + ], + "members":{ + "attachmentArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the attachment.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the attachment.

" + } + }, + "documentation":"

An object representing a change in state for a task attachment.

" + }, + "AttachmentStateChanges":{ + "type":"list", + "member":{"shape":"AttachmentStateChange"} + }, + "Attachments":{ + "type":"list", + "member":{"shape":"Attachment"} + }, + "Attribute":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, and periods are allowed.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are allowed.

" + }, + "targetType":{ + "shape":"TargetType", + "documentation":"

The type of the target with which to attach the attribute. This parameter is required if you use the short form ID for a resource instead of the full ARN.

" + }, + "targetId":{ + "shape":"String", + "documentation":"

The ID of the target. You can specify the short form ID for a resource or the full Amazon Resource Name (ARN).

" + } + }, + "documentation":"

An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.

" + }, + "AttributeLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You can apply up to 10 custom attributes per resource. You can view the attributes of a resource with ListAttributes. You can remove existing attributes on a resource with DeleteAttributes.

", + "exception":true + }, + "Attributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "AwsVpcConfiguration":{ + "type":"structure", + "required":["subnets"], + "members":{ + "subnets":{ + "shape":"StringList", + "documentation":"

The subnets associated with the task or service. There is a limit of 16 subnets that can be specified per AwsVpcConfiguration.

All specified subnets must be from the same VPC.

" + }, + "securityGroups":{ + "shape":"StringList", + "documentation":"

The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used. There is a limit of 5 security groups that can be specified per AwsVpcConfiguration.

All specified security groups must be from the same VPC.

" + }, + "assignPublicIp":{ + "shape":"AssignPublicIp", + "documentation":"

Whether the task's elastic network interface receives a public IP address. The default value is DISABLED.

" + } + }, + "documentation":"

An object representing the networking details for a task or service.

" + }, + "BlockedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Your AWS account has been blocked. For more information, contact AWS Support.

", + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BoxedBoolean":{ + "type":"boolean", + "box":true + }, + "BoxedInteger":{ + "type":"integer", + "box":true + }, + "ClientException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.

", + "exception":true + }, + "Cluster":{ + "type":"structure", + "members":{ + "clusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains the arn:aws:ecs namespace, followed by the Region of the cluster, the AWS account ID of the cluster owner, the cluster namespace, and then the cluster name. For example, arn:aws:ecs:region:012345678910:cluster/test.

" + }, + "clusterName":{ + "shape":"String", + "documentation":"

A user-generated string that you use to identify your cluster.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE indicates that you can register container instances with the cluster and the associated instances can accept tasks.

" + }, + "registeredContainerInstancesCount":{ + "shape":"Integer", + "documentation":"

The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.

" + }, + "runningTasksCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the cluster that are in the RUNNING state.

" + }, + "pendingTasksCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the cluster that are in the PENDING state.

" + }, + "activeServicesCount":{ + "shape":"Integer", + "documentation":"

The number of services that are running on the cluster in an ACTIVE state. You can view these services with ListServices.

" + }, + "statistics":{ + "shape":"Statistics", + "documentation":"

Additional information about your clusters that are separated by launch type, including:

  • runningEC2TasksCount

  • RunningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "settings":{ + "shape":"ClusterSettings", + "documentation":"

The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.

" + } + }, + "documentation":"

A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.

" + }, + "ClusterContainsContainerInstancesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot delete a cluster that has registered container instances. First, deregister the container instances before you can delete the cluster. For more information, see DeregisterContainerInstance.

", + "exception":true + }, + "ClusterContainsServicesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot delete a cluster that contains services. First, update the service to reduce its desired task count to 0 and then delete the service. For more information, see UpdateService and DeleteService.

", + "exception":true + }, + "ClusterContainsTasksException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot delete a cluster that has active tasks.

", + "exception":true + }, + "ClusterField":{ + "type":"string", + "enum":[ + "STATISTICS", + "TAGS" + ] + }, + "ClusterFieldList":{ + "type":"list", + "member":{"shape":"ClusterField"} + }, + "ClusterNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified cluster could not be found. You can view your available clusters with ListClusters. Amazon ECS clusters are Region-specific.

", + "exception":true + }, + "ClusterSetting":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ClusterSettingName", + "documentation":"

The name of the cluster setting. The only supported value is containerInsights.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value to set for the cluster setting. The supported values are enabled and disabled. If enabled is specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be disabled unless the containerInsights account setting is enabled. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

" + } + }, + "documentation":"

The settings to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster.

" + }, + "ClusterSettingName":{ + "type":"string", + "enum":["containerInsights"] + }, + "ClusterSettings":{ + "type":"list", + "member":{"shape":"ClusterSetting"} + }, + "Clusters":{ + "type":"list", + "member":{"shape":"Cluster"} + }, + "Compatibility":{ + "type":"string", + "enum":[ + "EC2", + "FARGATE" + ] + }, + "CompatibilityList":{ + "type":"list", + "member":{"shape":"Compatibility"} + }, + "Connectivity":{ + "type":"string", + "enum":[ + "CONNECTED", + "DISCONNECTED" + ] + }, + "Container":{ + "type":"structure", + "members":{ + "containerArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the container.

" + }, + "taskArn":{ + "shape":"String", + "documentation":"

The ARN of the task.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name of the container.

" + }, + "image":{ + "shape":"String", + "documentation":"

The image used for the container.

" + }, + "imageDigest":{ + "shape":"String", + "documentation":"

The container image manifest digest.

The imageDigest is only returned if the container is using an image hosted in Amazon ECR, otherwise it is omitted.

" + }, + "runtimeId":{ + "shape":"String", + "documentation":"

The ID of the Docker container.

" + }, + "lastStatus":{ + "shape":"String", + "documentation":"

The last known status of the container.

" + }, + "exitCode":{ + "shape":"BoxedInteger", + "documentation":"

The exit code returned from the container.

" + }, + "reason":{ + "shape":"String", + "documentation":"

A short (255 max characters) human-readable string to provide additional details about a running or stopped container.

" + }, + "networkBindings":{ + "shape":"NetworkBindings", + "documentation":"

The network bindings associated with the container.

" + }, + "networkInterfaces":{ + "shape":"NetworkInterfaces", + "documentation":"

The network interfaces associated with the container.

" + }, + "healthStatus":{ + "shape":"HealthStatus", + "documentation":"

The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as UNKNOWN.

" + }, + "cpu":{ + "shape":"String", + "documentation":"

The number of CPU units set for the container. The value will be 0 if no value was specified in the container definition when the task definition was registered.

" + }, + "memory":{ + "shape":"String", + "documentation":"

The hard limit (in MiB) of memory set for the container.

" + }, + "memoryReservation":{ + "shape":"String", + "documentation":"

The soft limit (in MiB) of memory set for the container.

" + }, + "gpuIds":{ + "shape":"GpuIds", + "documentation":"

The IDs of each GPU assigned to the container.

" + } + }, + "documentation":"

A Docker container that is part of a task.

" + }, + "ContainerCondition":{ + "type":"string", + "enum":[ + "START", + "COMPLETE", + "SUCCESS", + "HEALTHY" + ] + }, + "ContainerDefinition":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of a container. If you are linking multiple containers together in a task definition, the name of one container can be entered in the links of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name in the Create a container section of the Docker Remote API and the --name option to docker run.

" + }, + "image":{ + "shape":"String", + "documentation":"

The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

  • When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

  • Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

" + }, + "repositoryCredentials":{ + "shape":"RepositoryCredentials", + "documentation":"

The private repository authentication credentials to use.

" + }, + "cpu":{ + "shape":"Integer", + "documentation":"

The number of cpu units reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run.

This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level cpu value.

You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page by 1,024.

For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that is the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task would be guaranteed a minimum of 512 CPU units when needed, and each container could float to higher CPU usage if the other container was not using it, but if both tasks were 100% active all of the time, they would be limited to 512 CPU units.

On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see CPU share constraint in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter is not required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version:

  • Agent versions less than or equal to 1.1.0: Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares.

  • Agent versions greater than or equal to 1.2.0: Null, zero, and CPU values of 1 are passed to Docker as 2.

On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that is described in the task definition.

" + }, + "memory":{ + "shape":"BoxedInteger", + "documentation":"

The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If using the Fargate launch type, this parameter is optional.

If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level memory and memoryReservation value, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

" + }, + "memoryReservation":{ + "shape":"BoxedInteger", + "documentation":"

The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to MemoryReservation in the Create a container section of the Docker Remote API and the --memory-reservation option to docker run.

If a task-level memory value is not specified, you must specify a non-zero integer for one or both of memory or memoryReservation in a container definition. If you specify both, memory must be greater than memoryReservation. If you specify memoryReservation, then that value is subtracted from the available memory resources for the container instance on which the container is placed. Otherwise, the value of memory is used.

For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation of 128 MiB, and a memory hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed.

The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.

" + }, + "links":{ + "shape":"StringList", + "documentation":"

The links parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is bridge. The name:internalName construct is analogous to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to Legacy container links in the Docker documentation. This parameter maps to Links in the Create a container section of the Docker Remote API and the --link option to docker run.

This parameter is not supported for Windows containers.

Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.

" + }, + "portMappings":{ + "shape":"PortMappingList", + "documentation":"

The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic.

For task definitions that use the awsvpc network mode, you should only specify the containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

Port mappings on Windows use the NetNAT gateway address rather than localhost. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself.

This parameter maps to PortBindings in the Create a container section of the Docker Remote API and the --publish option to docker run. If the network mode of a task definition is set to none, then you can't specify port mappings. If the network mode of a task definition is set to host, then host ports must either be undefined or they must match the container port in the port mapping.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the Network Bindings section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the networkBindings section DescribeTasks responses.

" + }, + "essential":{ + "shape":"BoxedBoolean", + "documentation":"

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, then its failure does not affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All tasks must have at least one essential container. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

" + }, + "entryPoint":{ + "shape":"StringList", + "documentation":"

Early versions of the Amazon ECS container agent do not properly handle entryPoint parameters. If you have problems using entryPoint, update your container agent or enter your commands and arguments as command array items instead.

The entry point that is passed to the container. This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.

" + }, + "command":{ + "shape":"StringList", + "documentation":"

The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each argument should be a separated string in the array.

" + }, + "environment":{ + "shape":"EnvironmentVariables", + "documentation":"

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We do not recommend using plaintext environment variables for sensitive information, such as credential data.

" + }, + "mountPoints":{ + "shape":"MountPointList", + "documentation":"

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives.

" + }, + "volumesFrom":{ + "shape":"VolumeFromList", + "documentation":"

Data volumes to mount from another container. This parameter maps to VolumesFrom in the Create a container section of the Docker Remote API and the --volumes-from option to docker run.

" + }, + "linuxParameters":{ + "shape":"LinuxParameters", + "documentation":"

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see KernelCapabilities.

This parameter is not supported for Windows containers.

" + }, + "secrets":{ + "shape":"SecretList", + "documentation":"

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" + }, + "dependsOn":{ + "shape":"ContainerDependencies", + "documentation":"

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later.

" + }, + "startTimeout":{ + "shape":"BoxedInteger", + "documentation":"

Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a COMPLETE, SUCCESS, or HEALTHY status. If a startTimeout value is specified for containerB and it does not reach the desired status within that time then containerA will give up and not start. This results in the task transitioning to a STOPPED state.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to enable a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later.

" + }, + "stopTimeout":{ + "shape":"BoxedInteger", + "documentation":"

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the max stopTimeout value is 2 minutes. This parameter is available for tasks using the Fargate launch type in the Ohio (us-east-2) region only and the task or service requires platform version 1.3.0 or later.

For tasks using the EC2 launch type, the stop timeout value for the container takes precedence over the ECS_CONTAINER_STOP_TIMEOUT container agent configuration parameter, if used. Container instances require at least version 1.26.0 of the container agent to enable a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + }, + "hostname":{ + "shape":"String", + "documentation":"

The hostname to use for your container. This parameter maps to Hostname in the Create a container section of the Docker Remote API and the --hostname option to docker run.

The hostname parameter is not supported if you are using the awsvpc network mode.

" + }, + "user":{ + "shape":"String", + "documentation":"

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

You can use the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gid

  • uid:group

This parameter is not supported for Windows containers.

" + }, + "workingDirectory":{ + "shape":"String", + "documentation":"

The working directory in which to run commands inside the container. This parameter maps to WorkingDir in the Create a container section of the Docker Remote API and the --workdir option to docker run.

" + }, + "disableNetworking":{ + "shape":"BoxedBoolean", + "documentation":"

When this parameter is true, networking is disabled within the container. This parameter maps to NetworkDisabled in the Create a container section of the Docker Remote API.

This parameter is not supported for Windows containers.

" + }, + "privileged":{ + "shape":"BoxedBoolean", + "documentation":"

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + }, + "readonlyRootFilesystem":{ + "shape":"BoxedBoolean", + "documentation":"

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

" + }, + "dnsServers":{ + "shape":"StringList", + "documentation":"

A list of DNS servers that are presented to the container. This parameter maps to Dns in the Create a container section of the Docker Remote API and the --dns option to docker run.

This parameter is not supported for Windows containers.

" + }, + "dnsSearchDomains":{ + "shape":"StringList", + "documentation":"

A list of DNS search domains that are presented to the container. This parameter maps to DnsSearch in the Create a container section of the Docker Remote API and the --dns-search option to docker run.

This parameter is not supported for Windows containers.

" + }, + "extraHosts":{ + "shape":"HostEntryList", + "documentation":"

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This parameter maps to ExtraHosts in the Create a container section of the Docker Remote API and the --add-host option to docker run.

This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.

" + }, + "dockerSecurityOptions":{ + "shape":"StringList", + "documentation":"

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems. This field is not valid for containers in tasks using the Fargate launch type.

This parameter maps to SecurityOpt in the Create a container section of the Docker Remote API and the --security-opt option to docker run.

The Amazon ECS container agent running on a container instance must register with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment variables before containers placed on that instance can use these security options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

This parameter is not supported for Windows containers.

" + }, + "interactive":{ + "shape":"BoxedBoolean", + "documentation":"

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated. This parameter maps to OpenStdin in the Create a container section of the Docker Remote API and the --interactive option to docker run.

" + }, + "pseudoTerminal":{ + "shape":"BoxedBoolean", + "documentation":"

When this parameter is true, a TTY is allocated. This parameter maps to Tty in the Create a container section of the Docker Remote API and the --tty option to docker run.

" + }, + "dockerLabels":{ + "shape":"DockerLabelsMap", + "documentation":"

A key/value map of labels to add to the container. This parameter maps to Labels in the Create a container section of the Docker Remote API and the --label option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + }, + "ulimits":{ + "shape":"UlimitList", + "documentation":"

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run. Valid naming values are displayed in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

" + }, + "logConfiguration":{ + "shape":"LogConfiguration", + "documentation":"

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS Container Agent Configuration in the Amazon Elastic Container Service Developer Guide.

" + }, + "healthCheck":{ + "shape":"HealthCheck", + "documentation":"

The health check command and associated configuration parameters for the container. This parameter maps to HealthCheck in the Create a container section of the Docker Remote API and the HEALTHCHECK parameter of docker run.

" + }, + "systemControls":{ + "shape":"SystemControls", + "documentation":"

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network modes. For tasks that use the awsvpc network mode, the container that is started last determines which systemControls parameters take effect. For tasks that use the host network mode, it changes the container instance's namespaced kernel parameters as well as the containers.

" + }, + "resourceRequirements":{ + "shape":"ResourceRequirements", + "documentation":"

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

" + }, + "firelensConfiguration":{ + "shape":"FirelensConfiguration", + "documentation":"

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "documentation":"

Container definitions are used in task definitions to describe the different containers that are launched as part of a task.

" + }, + "ContainerDefinitions":{ + "type":"list", + "member":{"shape":"ContainerDefinition"} + }, + "ContainerDependencies":{ + "type":"list", + "member":{"shape":"ContainerDependency"} + }, + "ContainerDependency":{ + "type":"structure", + "required":[ + "containerName", + "condition" + ], + "members":{ + "containerName":{ + "shape":"String", + "documentation":"

The name of a container.

" + }, + "condition":{ + "shape":"ContainerCondition", + "documentation":"

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status.

  • HEALTHY - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup.

" + } + }, + "documentation":"

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent to enable container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see Updating the Amazon ECS Container Agent in the Amazon Elastic Container Service Developer Guide. If you are using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ecs-init package. If your container instances are launched from version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

If you are using tasks that use the Fargate launch type, container dependency parameters are not supported.

" + }, + "ContainerInstance":{ + "type":"structure", + "members":{ + "containerInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + }, + "ec2InstanceId":{ + "shape":"String", + "documentation":"

The EC2 instance ID of the container instance.

" + }, + "version":{ + "shape":"Long", + "documentation":"

The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail object) to verify that the version in your event stream is current.

" + }, + "versionInfo":{ + "shape":"VersionInfo", + "documentation":"

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

" + }, + "remainingResources":{ + "shape":"Resources", + "documentation":"

For CPU and memory resource types, this parameter describes the remaining CPU and memory that has not already been allocated to tasks and is therefore available for new tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent (at instance registration time) and any task containers that have reserved port mappings on the host (with the host or bridge network mode). Any port that is not specified here is available for new tasks.

" + }, + "registeredResources":{ + "shape":"Resources", + "documentation":"

For CPU and memory resource types, this parameter describes the amount of each resource that was available on the container instance when the container agent registered it with Amazon ECS. This value represents the total amount of CPU and memory that can be allocated on this container instance to tasks. For port resource types, this parameter describes the ports that were reserved by the Amazon ECS container agent when it registered the container instance with Amazon ECS.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the container instance. The valid values are REGISTERING, REGISTRATION_FAILED, ACTIVE, INACTIVE, DEREGISTERING, or DRAINING.

If your account has opted in to the awsvpcTrunking account setting, then any newly registered container instance will transition to a REGISTERING status while the trunk elastic network interface is provisioned for the instance. If the registration fails, the instance will transition to a REGISTRATION_FAILED status. You can describe the container instance and see the reason for failure in the statusReason parameter. Once the container instance is terminated, the instance transitions to a DEREGISTERING status while the trunk elastic network interface is deprovisioned. The instance then transitions to an INACTIVE status.

The ACTIVE status indicates that the container instance can accept tasks. The DRAINING indicates that new tasks are not placed on the container instance and any service tasks running on the container instance are removed if possible. For more information, see Container Instance Draining in the Amazon Elastic Container Service Developer Guide.

" + }, + "statusReason":{ + "shape":"String", + "documentation":"

The reason that the container instance reached its current status.

" + }, + "agentConnected":{ + "shape":"Boolean", + "documentation":"

This parameter returns true if the agent is connected to Amazon ECS. Registered instances with an agent that may be unhealthy or stopped return false. Only instances connected to an agent can accept placement requests.

" + }, + "runningTasksCount":{ + "shape":"Integer", + "documentation":"

The number of tasks on the container instance that are in the RUNNING status.

" + }, + "pendingTasksCount":{ + "shape":"Integer", + "documentation":"

The number of tasks on the container instance that are in the PENDING status.

" + }, + "agentUpdateStatus":{ + "shape":"AgentUpdateStatus", + "documentation":"

The status of the most recent agent update. If an update has never been requested, this value is NULL.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes set for the container instance, either by the Amazon ECS container agent at instance registration or manually with the PutAttributes operation.

" + }, + "registeredAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the container instance was registered.

" + }, + "attachments":{ + "shape":"Attachments", + "documentation":"

The resources attached to a container instance, such as elastic network interfaces.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + } + }, + "documentation":"

An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.

" + }, + "ContainerInstanceField":{ + "type":"string", + "enum":["TAGS"] + }, + "ContainerInstanceFieldList":{ + "type":"list", + "member":{"shape":"ContainerInstanceField"} + }, + "ContainerInstanceStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "DRAINING", + "REGISTERING", + "DEREGISTERING", + "REGISTRATION_FAILED" + ] + }, + "ContainerInstances":{ + "type":"list", + "member":{"shape":"ContainerInstance"} + }, + "ContainerOverride":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the container that receives the override. This parameter is required if any override is specified.

" + }, + "command":{ + "shape":"StringList", + "documentation":"

The command to send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

" + }, + "environment":{ + "shape":"EnvironmentVariables", + "documentation":"

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition. You must also specify a container name.

" + }, + "cpu":{ + "shape":"BoxedInteger", + "documentation":"

The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

" + }, + "memory":{ + "shape":"BoxedInteger", + "documentation":"

The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

" + }, + "memoryReservation":{ + "shape":"BoxedInteger", + "documentation":"

The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

" + }, + "resourceRequirements":{ + "shape":"ResourceRequirements", + "documentation":"

The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

" + } + }, + "documentation":"

The overrides that should be sent to a container. An empty container override can be passed in. An example of an empty container override would be {\"containerOverrides\": [ ] }. If a non-empty container override is specified, the name parameter must be included.

" + }, + "ContainerOverrides":{ + "type":"list", + "member":{"shape":"ContainerOverride"} + }, + "ContainerStateChange":{ + "type":"structure", + "members":{ + "containerName":{ + "shape":"String", + "documentation":"

The name of the container.

" + }, + "imageDigest":{ + "shape":"String", + "documentation":"

The container image SHA 256 digest.

" + }, + "runtimeId":{ + "shape":"String", + "documentation":"

The ID of the Docker container.

" + }, + "exitCode":{ + "shape":"BoxedInteger", + "documentation":"

The exit code for the container, if the state change is a result of the container exiting.

" + }, + "networkBindings":{ + "shape":"NetworkBindings", + "documentation":"

Any network bindings associated with the container.

" + }, + "reason":{ + "shape":"String", + "documentation":"

The reason for the state change.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the container.

" + } + }, + "documentation":"

An object representing a change in state for a container.

" + }, + "ContainerStateChanges":{ + "type":"list", + "member":{"shape":"ContainerStateChange"} + }, + "Containers":{ + "type":"list", + "member":{"shape":"Container"} + }, + "CreateClusterRequest":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The name of your cluster. If you do not specify a name for your cluster, you create a cluster named default. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "settings":{ + "shape":"ClusterSettings", + "documentation":"

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

" + } + } + }, + "CreateClusterResponse":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"

The full description of your new cluster.

" + } + } + }, + "CreateServiceRequest":{ + "type":"structure", + "required":["serviceName"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service. If you do not specify a cluster, the default cluster is assumed.

" + }, + "serviceName":{ + "shape":"String", + "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used.

A task definition must be specified if the service is using the ECS deployment controller.

" + }, + "loadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

A load balancer object representing the load balancers to use with your service. For more information, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide.

If the service is using the rolling update (ECS) deployment controller and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If the service is using the CODE_DEPLOY deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a targetGroupPair). During a deployment, AWS CodeDeploy determines which task set in your service has the status PRIMARY and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.

After you create a service using the ECS deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the CODE_DEPLOY deployment controller, these values can be changed when updating the service.

For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.

For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.

Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

" + }, + "serviceRegistries":{ + "shape":"ServiceRegistries", + "documentation":"

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see AWS Fargate Platform Versions.

" + }, + "desiredCount":{ + "shape":"BoxedInteger", + "documentation":"

The number of instantiations of the specified task definition to place and keep running on your cluster.

This is required if schedulingStrategy is REPLICA or is not specified. If schedulingStrategy is DAEMON then this is not required.

" + }, + "clientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "role":{ + "shape":"String", + "documentation":"

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, or multiple target groups in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

" + }, + "deploymentConfiguration":{ + "shape":"DeploymentConfiguration", + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" + }, + "placementConstraints":{ + "shape":"PlacementConstraints", + "documentation":"

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

" + }, + "placementStrategy":{ + "shape":"PlacementStrategies", + "documentation":"

The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

" + }, + "healthCheckGracePeriodSeconds":{ + "shape":"BoxedInteger", + "documentation":"

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

" + }, + "schedulingStrategy":{ + "shape":"SchedulingStrategy", + "documentation":"

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service is using the CODE_DEPLOY or EXTERNAL deployment controller types.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.

    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
" + }, + "deploymentController":{ + "shape":"DeploymentController", + "documentation":"

The deployment controller to use for the service.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "enableECSManagedTags":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

" + }, + "propagateTags":{ + "shape":"PropagateTags", + "documentation":"

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.

" + } + } + }, + "CreateServiceResponse":{ + "type":"structure", + "members":{ + "service":{ + "shape":"Service", + "documentation":"

The full description of your service following the create call.

If a service is using the ECS deployment controller, the deploymentController and taskSets parameters will not be returned.

If the service is using the CODE_DEPLOY deployment controller, the deploymentController, taskSets and deployments parameters will be returned, however the deployments parameter will be an empty list.

" + } + } + }, + "CreateTaskSetRequest":{ + "type":"structure", + "required":[ + "service", + "cluster", + "taskDefinition" + ], + "members":{ + "service":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

" + }, + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

" + }, + "externalId":{ + "shape":"String", + "documentation":"

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The task definition for the tasks in the task set to use.

" + }, + "networkConfiguration":{"shape":"NetworkConfiguration"}, + "loadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

" + }, + "serviceRegistries":{ + "shape":"ServiceRegistries", + "documentation":"

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.

" + }, + "scale":{"shape":"Scale"}, + "clientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

" + } + } + }, + "CreateTaskSetResponse":{ + "type":"structure", + "members":{ + "taskSet":{"shape":"TaskSet"} + } + }, + "DeleteAccountSettingRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SettingName", + "documentation":"

The resource name for which to disable the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected.

" + }, + "principalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it disables the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

" + } + } + }, + "DeleteAccountSettingResponse":{ + "type":"structure", + "members":{ + "setting":{ + "shape":"Setting", + "documentation":"

The account setting for the specified principal ARN.

" + } + } + }, + "DeleteAttributesRequest":{ + "type":"structure", + "required":["attributes"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete attributes. If you do not specify a cluster, the default cluster is assumed.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes to delete from your resource. You can specify up to 10 attributes per request. For custom attributes, specify the attribute name and target ID, but do not specify the value. If you specify the target ID using the short form, you must also specify the target type.

" + } + } + }, + "DeleteAttributesResponse":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"Attributes", + "documentation":"

A list of attribute objects that were successfully deleted from your resource.

" + } + } + }, + "DeleteClusterRequest":{ + "type":"structure", + "required":["cluster"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to delete.

" + } + } + }, + "DeleteClusterResponse":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"

The full description of the deleted cluster.

" + } + } + }, + "DeleteServiceRequest":{ + "type":"structure", + "required":["service"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete. If you do not specify a cluster, the default cluster is assumed.

" + }, + "service":{ + "shape":"String", + "documentation":"

The name of the service to delete.

" + }, + "force":{ + "shape":"BoxedBoolean", + "documentation":"

If true, allows you to delete a service even if it has not been scaled down to zero tasks. It is only necessary to use this if the service is using the REPLICA scheduling strategy.

" + } + } + }, + "DeleteServiceResponse":{ + "type":"structure", + "members":{ + "service":{ + "shape":"Service", + "documentation":"

The full description of the deleted service.

" + } + } + }, + "DeleteTaskSetRequest":{ + "type":"structure", + "required":[ + "cluster", + "service", + "taskSet" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in to delete.

" + }, + "service":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to delete.

" + }, + "taskSet":{ + "shape":"String", + "documentation":"

The task set ID or full Amazon Resource Name (ARN) of the task set to delete.

" + }, + "force":{ + "shape":"BoxedBoolean", + "documentation":"

If true, this allows you to delete a task set even if it hasn't been scaled down to zero.

" + } + } + }, + "DeleteTaskSetResponse":{ + "type":"structure", + "members":{ + "taskSet":{"shape":"TaskSet"} + } + }, + "Deployment":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The ID of the deployment.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the deployment. The following describes each state:

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The most recent task definition that was specified for the tasks in the service to use.

" + }, + "desiredCount":{ + "shape":"Integer", + "documentation":"

The most recent desired count of tasks that was specified for the service to deploy or maintain.

" + }, + "pendingCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the deployment that are in the PENDING status.

" + }, + "runningCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the deployment that are in the RUNNING status.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the service deployment was created.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the service deployment was last updated.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

" + } + }, + "documentation":"

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

" + }, + "DeploymentConfiguration":{ + "type":"structure", + "members":{ + "maximumPercent":{ + "shape":"BoxedInteger", + "documentation":"

If a service is using the rolling update (ECS) deployment type, the maximum percent parameter represents an upper limit on the number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desired number of tasks (rounded down to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to define the deployment batch size. For example, if your service has a desired number of four tasks and a maximum percent value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximum percent is 200%.

If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the maximum percent value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service.

" + }, + "minimumHealthyPercent":{ + "shape":"BoxedInteger", + "documentation":"

If a service is using the rolling update (ECS) deployment type, the minimum healthy percent represents a lower limit on the number of tasks in a service that must remain in the RUNNING state during a deployment, as a percentage of the desired number of tasks (rounded up to the nearest integer), and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desired number of four tasks and a minimum healthy percent of 50%, the scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and they are reported as healthy by the load balancer. The default value for minimum healthy percent is 100%.

If a service is using the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum healthy percent value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. If the tasks in the service use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service.

" + } + }, + "documentation":"

Optional deployment parameters that control how many tasks run during a deployment and the ordering of stopping and starting tasks.

" + }, + "DeploymentController":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"DeploymentControllerType", + "documentation":"

The deployment controller type to use.

There are three deployment controller types available:

ECS

The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration.

CODE_DEPLOY

The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a new deployment of a service before sending production traffic to it.

EXTERNAL

The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.

" + } + }, + "documentation":"

The deployment controller to use for the service. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "DeploymentControllerType":{ + "type":"string", + "enum":[ + "ECS", + "CODE_DEPLOY", + "EXTERNAL" + ] + }, + "Deployments":{ + "type":"list", + "member":{"shape":"Deployment"} + }, + "DeregisterContainerInstanceRequest":{ + "type":"structure", + "required":["containerInstance"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

" + }, + "containerInstance":{ + "shape":"String", + "documentation":"

The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + }, + "force":{ + "shape":"BoxedBoolean", + "documentation":"

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

" + } + } + }, + "DeregisterContainerInstanceResponse":{ + "type":"structure", + "members":{ + "containerInstance":{ + "shape":"ContainerInstance", + "documentation":"

The container instance that was deregistered.

" + } + } + }, + "DeregisterTaskDefinitionRequest":{ + "type":"structure", + "required":["taskDefinition"], + "members":{ + "taskDefinition":{ + "shape":"String", + "documentation":"

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a revision.

" + } + } + }, + "DeregisterTaskDefinitionResponse":{ + "type":"structure", + "members":{ + "taskDefinition":{ + "shape":"TaskDefinition", + "documentation":"

The full description of the deregistered task.

" + } + } + }, + "DescribeClustersRequest":{ + "type":"structure", + "members":{ + "clusters":{ + "shape":"StringList", + "documentation":"

A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries. If you do not specify a cluster, the default cluster is assumed.

" + }, + "include":{ + "shape":"ClusterFieldList", + "documentation":"

Additional information about your clusters to be separated by launch type, including:

  • runningEC2TasksCount

  • runningFargateTasksCount

  • pendingEC2TasksCount

  • pendingFargateTasksCount

  • activeEC2ServiceCount

  • activeFargateServiceCount

  • drainingEC2ServiceCount

  • drainingFargateServiceCount

" + } + } + }, + "DescribeClustersResponse":{ + "type":"structure", + "members":{ + "clusters":{ + "shape":"Clusters", + "documentation":"

The list of clusters.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "DescribeContainerInstancesRequest":{ + "type":"structure", + "required":["containerInstances"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance or container instances you are describing were launched in any cluster other than the default cluster.

" + }, + "containerInstances":{ + "shape":"StringList", + "documentation":"

A list of up to 100 container instance IDs or full Amazon Resource Name (ARN) entries.

" + }, + "include":{ + "shape":"ContainerInstanceFieldList", + "documentation":"

Specifies whether you want to see the resource tags for the container instance. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" + } + } + }, + "DescribeContainerInstancesResponse":{ + "type":"structure", + "members":{ + "containerInstances":{ + "shape":"ContainerInstances", + "documentation":"

The list of container instances.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "DescribeServicesRequest":{ + "type":"structure", + "required":["services"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are describing were launched in any cluster other than the default cluster.

" + }, + "services":{ + "shape":"StringList", + "documentation":"

A list of services to describe. You may specify up to 10 services to describe in a single operation.

" + }, + "include":{ + "shape":"ServiceFieldList", + "documentation":"

Specifies whether you want to see the resource tags for the service. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" + } + } + }, + "DescribeServicesResponse":{ + "type":"structure", + "members":{ + "services":{ + "shape":"Services", + "documentation":"

The list of services described.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "DescribeTaskDefinitionRequest":{ + "type":"structure", + "required":["taskDefinition"], + "members":{ + "taskDefinition":{ + "shape":"String", + "documentation":"

The family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to describe.

" + }, + "include":{ + "shape":"TaskDefinitionFieldList", + "documentation":"

Specifies whether to see the resource tags for the task definition. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" + } + } + }, + "DescribeTaskDefinitionResponse":{ + "type":"structure", + "members":{ + "taskDefinition":{ + "shape":"TaskDefinition", + "documentation":"

The full task definition description.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that is applied to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + } + } + }, + "DescribeTaskSetsRequest":{ + "type":"structure", + "required":[ + "cluster", + "service" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task sets exist in.

" + }, + "service":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.

" + }, + "taskSets":{ + "shape":"StringList", + "documentation":"

The ID or full Amazon Resource Name (ARN) of task sets to describe.

" + } + } + }, + "DescribeTaskSetsResponse":{ + "type":"structure", + "members":{ + "taskSets":{ + "shape":"TaskSets", + "documentation":"

The list of task sets described.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "DescribeTasksRequest":{ + "type":"structure", + "required":["tasks"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

" + }, + "tasks":{ + "shape":"StringList", + "documentation":"

A list of up to 100 task IDs or full ARN entries.

" + }, + "include":{ + "shape":"TaskFieldList", + "documentation":"

Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.

" + } + } + }, + "DescribeTasksResponse":{ + "type":"structure", + "members":{ + "tasks":{ + "shape":"Tasks", + "documentation":"

The list of tasks.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "DesiredStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "PENDING", + "STOPPED" + ] + }, + "Device":{ + "type":"structure", + "required":["hostPath"], + "members":{ + "hostPath":{ + "shape":"String", + "documentation":"

The path for the device on the host container instance.

" + }, + "containerPath":{ + "shape":"String", + "documentation":"

The path inside the container at which to expose the host device.

" + }, + "permissions":{ + "shape":"DeviceCgroupPermissions", + "documentation":"

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

" + } + }, + "documentation":"

An object representing a container instance host device.

" + }, + "DeviceCgroupPermission":{ + "type":"string", + "enum":[ + "read", + "write", + "mknod" + ] + }, + "DeviceCgroupPermissions":{ + "type":"list", + "member":{"shape":"DeviceCgroupPermission"} + }, + "DevicesList":{ + "type":"list", + "member":{"shape":"Device"} + }, + "DiscoverPollEndpointRequest":{ + "type":"structure", + "members":{ + "containerInstance":{ + "shape":"String", + "documentation":"

The container instance ID or full ARN of the container instance. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

" + }, + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance belongs.

" + } + } + }, + "DiscoverPollEndpointResponse":{ + "type":"structure", + "members":{ + "endpoint":{ + "shape":"String", + "documentation":"

The endpoint for the Amazon ECS agent to poll.

" + }, + "telemetryEndpoint":{ + "shape":"String", + "documentation":"

The telemetry endpoint for the Amazon ECS agent.

" + } + } + }, + "DockerLabelsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "DockerVolumeConfiguration":{ + "type":"structure", + "members":{ + "scope":{ + "shape":"Scope", + "documentation":"

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.

" + }, + "autoprovision":{ + "shape":"BoxedBoolean", + "documentation":"

If this value is true, the Docker volume is created if it does not already exist.

This field is only used if the scope is shared.

" + }, + "driver":{ + "shape":"String", + "documentation":"

The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use docker plugin ls to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see Docker plugin discovery. This parameter maps to Driver in the Create a volume section of the Docker Remote API and the xxdriver option to docker volume create.

" + }, + "driverOpts":{ + "shape":"StringMap", + "documentation":"

A map of Docker driver-specific options passed through. This parameter maps to DriverOpts in the Create a volume section of the Docker Remote API and the xxopt option to docker volume create.

" + }, + "labels":{ + "shape":"StringMap", + "documentation":"

Custom metadata to add to your Docker volume. This parameter maps to Labels in the Create a volume section of the Docker Remote API and the xxlabel option to docker volume create.

" + } + }, + "documentation":"

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

" + }, + "Double":{"type":"double"}, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "Failure":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the failed resource.

" + }, + "reason":{ + "shape":"String", + "documentation":"

The reason for the failure.

" + } + }, + "documentation":"

A failed resource.

" + }, + "Failures":{ + "type":"list", + "member":{"shape":"Failure"} + }, + "FirelensConfiguration":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"FirelensConfigurationType", + "documentation":"

The log router to use. The valid values are fluentd or fluentbit.

" + }, + "options":{ + "shape":"FirelensConfigurationOptionsMap", + "documentation":"

The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is \"options\":{\"enable-ecs-log-metadata\":\"true|false\"}.

" + } + }, + "documentation":"

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

" + }, + "FirelensConfigurationOptionsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "FirelensConfigurationType":{ + "type":"string", + "enum":[ + "fluentd", + "fluentbit" + ] + }, + "GpuIds":{ + "type":"list", + "member":{"shape":"String"} + }, + "HealthCheck":{ + "type":"structure", + "required":["command"], + "members":{ + "command":{ + "shape":"StringList", + "documentation":"

A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to execute the command arguments directly, or CMD-SHELL to run the command with the container's default shell. For example:

[ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]

An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

" + }, + "interval":{ + "shape":"BoxedInteger", + "documentation":"

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

" + }, + "timeout":{ + "shape":"BoxedInteger", + "documentation":"

The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

" + }, + "retries":{ + "shape":"BoxedInteger", + "documentation":"

The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

" + }, + "startPeriod":{ + "shape":"BoxedInteger", + "documentation":"

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is disabled by default.

If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

" + } + }, + "documentation":"

An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).

The following are notes about container health check support:

  • Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.

  • Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.

  • Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.

" + }, + "HealthStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ] + }, + "HostEntry":{ + "type":"structure", + "required":[ + "hostname", + "ipAddress" + ], + "members":{ + "hostname":{ + "shape":"String", + "documentation":"

The hostname to use in the /etc/hosts entry.

" + }, + "ipAddress":{ + "shape":"String", + "documentation":"

The IP address to use in the /etc/hosts entry.

" + } + }, + "documentation":"

Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.

" + }, + "HostEntryList":{ + "type":"list", + "member":{"shape":"HostEntry"} + }, + "HostVolumeProperties":{ + "type":"structure", + "members":{ + "sourcePath":{ + "shape":"String", + "documentation":"

When the host parameter is used, specify a sourcePath to declare the path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

If you are using the Fargate launch type, the sourcePath parameter is not supported.

" + } + }, + "documentation":"

Details on a container instance bind mount host volume.

" + }, + "InferenceAccelerator":{ + "type":"structure", + "required":[ + "deviceName", + "deviceType" + ], + "members":{ + "deviceName":{ + "shape":"String", + "documentation":"

The Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement.

" + }, + "deviceType":{ + "shape":"String", + "documentation":"

The Elastic Inference accelerator type to use.

" + } + }, + "documentation":"

Details on a Elastic Inference accelerator. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" + }, + "InferenceAcceleratorOverride":{ + "type":"structure", + "members":{ + "deviceName":{ + "shape":"String", + "documentation":"

The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition.

" + }, + "deviceType":{ + "shape":"String", + "documentation":"

The Elastic Inference accelerator type to use.

" + } + }, + "documentation":"

Details on an Elastic Inference accelerator task override. This parameter is used to override the Elastic Inference accelerator specified in the task definition. For more information, see Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" + }, + "InferenceAcceleratorOverrides":{ + "type":"list", + "member":{"shape":"InferenceAcceleratorOverride"} + }, + "InferenceAccelerators":{ + "type":"list", + "member":{"shape":"InferenceAccelerator"} + }, + "Integer":{"type":"integer"}, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", + "exception":true + }, + "IpcMode":{ + "type":"string", + "enum":[ + "host", + "task", + "none" + ] + }, + "KernelCapabilities":{ + "type":"structure", + "members":{ + "add":{ + "shape":"StringList", + "documentation":"

The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to CapAdd in the Create a container section of the Docker Remote API and the --cap-add option to docker run.

If you are using tasks that use the Fargate launch type, the add parameter is not supported.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

" + }, + "drop":{ + "shape":"StringList", + "documentation":"

The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to CapDrop in the Create a container section of the Docker Remote API and the --cap-drop option to docker run.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

" + } + }, + "documentation":"

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) Linux manual page.

" + }, + "KeyValuePair":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the key-value pair. For environment variables, this is the name of the environment variable.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the key-value pair. For environment variables, this is the value of the environment variable.

" + } + }, + "documentation":"

A key-value pair object.

" + }, + "LaunchType":{ + "type":"string", + "enum":[ + "EC2", + "FARGATE" + ] + }, + "LinuxParameters":{ + "type":"structure", + "members":{ + "capabilities":{ + "shape":"KernelCapabilities", + "documentation":"

The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.

If you are using tasks that use the Fargate launch type, capabilities is supported but the add parameter is not supported.

" + }, + "devices":{ + "shape":"DevicesList", + "documentation":"

Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

If you are using tasks that use the Fargate launch type, the devices parameter is not supported.

" + }, + "initProcessEnabled":{ + "shape":"BoxedBoolean", + "documentation":"

Run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + }, + "sharedMemorySize":{ + "shape":"BoxedInteger", + "documentation":"

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

If you are using tasks that use the Fargate launch type, the sharedMemorySize parameter is not supported.

" + }, + "tmpfs":{ + "shape":"TmpfsList", + "documentation":"

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

If you are using tasks that use the Fargate launch type, the tmpfs parameter is not supported.

" + }, + "maxSwap":{ + "shape":"BoxedInteger", + "documentation":"

The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the --memory-swap option to docker run where the value would be the sum of the container memory plus the maxSwap value.

If a maxSwap value of 0 is specified, the container will not use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container will use the swap configuration for the container instance it is running on. A maxSwap value must be set for the swappiness parameter to be used.

If you are using tasks that use the Fargate launch type, the maxSwap parameter is not supported.

" + }, + "swappiness":{ + "shape":"BoxedInteger", + "documentation":"

This allows you to tune a container's memory swappiness behavior. A swappiness value of 0 will cause swapping to not happen unless absolutely necessary. A swappiness value of 100 will cause pages to be swapped very aggressively. Accepted values are whole numbers between 0 and 100. If the swappiness parameter is not specified, a default value of 60 is used. If a value is not specified for maxSwap then this parameter is ignored. This parameter maps to the --memory-swappiness option to docker run.

If you are using tasks that use the Fargate launch type, the swappiness parameter is not supported.

" + } + }, + "documentation":"

Linux-specific options that are applied to the container, such as Linux KernelCapabilities.

" + }, + "ListAccountSettingsRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SettingName", + "documentation":"

The resource name you want to list the account settings for.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the account settings with which to filter results. You must also specify an account setting name to use this parameter.

" + }, + "principalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

" + }, + "effectiveSettings":{ + "shape":"Boolean", + "documentation":"

Specifies whether to return the effective settings. If true, the account settings for the root user or the default setting for the principalArn are returned. If false, the account settings for the principalArn are returned if they are set. Otherwise, no account settings are returned.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListAccountSettings request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of account setting results returned by ListAccountSettings in paginated output. When this parameter is used, ListAccountSettings only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAccountSettings request with the returned nextToken value. This value can be between 1 and 10. If this parameter is not used, then ListAccountSettings returns up to 10 results and a nextToken value if applicable.

" + } + } + }, + "ListAccountSettingsResponse":{ + "type":"structure", + "members":{ + "settings":{ + "shape":"Settings", + "documentation":"

The account settings for the resource.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListAccountSettings request. When the results of a ListAccountSettings request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListAttributesRequest":{ + "type":"structure", + "required":["targetType"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster to list attributes. If you do not specify a cluster, the default cluster is assumed.

" + }, + "targetType":{ + "shape":"TargetType", + "documentation":"

The type of the target with which to list attributes.

" + }, + "attributeName":{ + "shape":"String", + "documentation":"

The name of the attribute with which to filter the results.

" + }, + "attributeValue":{ + "shape":"String", + "documentation":"

The value of the attribute with which to filter results. You must also specify an attribute name to use this parameter.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListAttributes request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of cluster results returned by ListAttributes in paginated output. When this parameter is used, ListAttributes only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListAttributes request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListAttributes returns up to 100 results and a nextToken value if applicable.

" + } + } + }, + "ListAttributesResponse":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"Attributes", + "documentation":"

A list of attribute objects that meet the criteria of the request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListAttributes request. When the results of a ListAttributes request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListClustersRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of cluster results returned by ListClusters in paginated output. When this parameter is used, ListClusters only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListClusters returns up to 100 results and a nextToken value if applicable.

" + } + } + }, + "ListClustersResponse":{ + "type":"structure", + "members":{ + "clusterArns":{ + "shape":"StringList", + "documentation":"

The list of full Amazon Resource Name (ARN) entries for each cluster associated with your account.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListContainerInstancesRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to list. If you do not specify a cluster, the default cluster is assumed.

" + }, + "filter":{ + "shape":"String", + "documentation":"

You can filter the results of a ListContainerInstances operation with cluster query language statements. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListContainerInstances request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of container instance results returned by ListContainerInstances in paginated output. When this parameter is used, ListContainerInstances only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListContainerInstances request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListContainerInstances returns up to 100 results and a nextToken value if applicable.

" + }, + "status":{ + "shape":"ContainerInstanceStatus", + "documentation":"

Filters the container instances by status. For example, if you specify the DRAINING status, the results include only container instances that have been set to DRAINING using UpdateContainerInstancesState. If you do not specify this parameter, the default is to include container instances set to all states other than INACTIVE.

" + } + } + }, + "ListContainerInstancesResponse":{ + "type":"structure", + "members":{ + "containerInstanceArns":{ + "shape":"StringList", + "documentation":"

The list of container instances with full ARN entries for each container instance associated with the specified cluster.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListContainerInstances request. When the results of a ListContainerInstances request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListServicesRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list. If you do not specify a cluster, the default cluster is assumed.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListServices request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of service results returned by ListServices in paginated output. When this parameter is used, ListServices only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListServices request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListServices returns up to 10 results and a nextToken value if applicable.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type for the services to list.

" + }, + "schedulingStrategy":{ + "shape":"SchedulingStrategy", + "documentation":"

The scheduling strategy for services to list.

" + } + } + }, + "ListServicesResponse":{ + "type":"structure", + "members":{ + "serviceArns":{ + "shape":"StringList", + "documentation":"

The list of full ARN entries for each service associated with the specified cluster.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListServices request. When the results of a ListServices request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The tags for the resource.

" + } + } + }, + "ListTaskDefinitionFamiliesRequest":{ + "type":"structure", + "members":{ + "familyPrefix":{ + "shape":"String", + "documentation":"

The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. If you specify a familyPrefix, only task definition family names that begin with the familyPrefix string are returned.

" + }, + "status":{ + "shape":"TaskDefinitionFamilyStatus", + "documentation":"

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListTaskDefinitionFamilies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of task definition family results returned by ListTaskDefinitionFamilies in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitionFamilies request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitionFamilies returns up to 100 results and a nextToken value if applicable.

" + } + } + }, + "ListTaskDefinitionFamiliesResponse":{ + "type":"structure", + "members":{ + "families":{ + "shape":"StringList", + "documentation":"

The list of task definition family names that match the ListTaskDefinitionFamilies request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListTaskDefinitionFamilies request. When the results of a ListTaskDefinitionFamilies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTaskDefinitionsRequest":{ + "type":"structure", + "members":{ + "familyPrefix":{ + "shape":"String", + "documentation":"

The full family name with which to filter the ListTaskDefinitions results. Specifying a familyPrefix limits the listed task definitions to task definition revisions that belong to that family.

" + }, + "status":{ + "shape":"TaskDefinitionStatus", + "documentation":"

The task definition status with which to filter the ListTaskDefinitions results. By default, only ACTIVE task definitions are listed. By setting this parameter to INACTIVE, you can view task definitions that are INACTIVE as long as an active task or service still references them. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

" + }, + "sort":{ + "shape":"SortOrder", + "documentation":"

The order in which to sort the results. Valid values are ASC and DESC. By default (ASC), task definitions are listed lexicographically by family name and in ascending numerical order by revision so that the newest task definitions in a family are listed last. Setting this parameter to DESC reverses the sort order on family name and revision so that the newest task definitions in a family are listed first.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListTaskDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of task definition results returned by ListTaskDefinitions in paginated output. When this parameter is used, ListTaskDefinitions only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTaskDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions returns up to 100 results and a nextToken value if applicable.

" + } + } + }, + "ListTaskDefinitionsResponse":{ + "type":"structure", + "members":{ + "taskDefinitionArns":{ + "shape":"StringList", + "documentation":"

The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListTaskDefinitions request. When the results of a ListTaskDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTasksRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list. If you do not specify a cluster, the default cluster is assumed.

" + }, + "containerInstance":{ + "shape":"String", + "documentation":"

The container instance ID or full ARN of the container instance with which to filter the ListTasks results. Specifying a containerInstance limits the results to tasks that belong to that container instance.

" + }, + "family":{ + "shape":"String", + "documentation":"

The name of the family with which to filter the ListTasks results. Specifying a family limits the results to tasks that belong to that family.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListTasks request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

" + }, + "maxResults":{ + "shape":"BoxedInteger", + "documentation":"

The maximum number of task results returned by ListTasks in paginated output. When this parameter is used, ListTasks only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListTasks request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListTasks returns up to 100 results and a nextToken value if applicable.

" + }, + "startedBy":{ + "shape":"String", + "documentation":"

The startedBy value with which to filter the task results. Specifying a startedBy value limits the results to tasks that were started with that value.

" + }, + "serviceName":{ + "shape":"String", + "documentation":"

The name of the service with which to filter the ListTasks results. Specifying a serviceName limits the results to tasks that belong to that service.

" + }, + "desiredStatus":{ + "shape":"DesiredStatus", + "documentation":"

The task desired status with which to filter the ListTasks results. Specifying a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has set the desired status to STOPPED. This can be useful for debugging tasks that are not starting properly or have died or finished. The default status filter is RUNNING, which shows tasks that Amazon ECS has set the desired status to RUNNING.

Although you can filter results based on a desired status of PENDING, this does not return any results. Amazon ECS never sets the desired status of a task to that value (only a task's lastStatus may have a value of PENDING).

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type for services to list.

" + } + } + }, + "ListTasksResponse":{ + "type":"structure", + "members":{ + "taskArns":{ + "shape":"StringList", + "documentation":"

The list of task ARN entries for the ListTasks request.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListTasks request. When the results of a ListTasks request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "LoadBalancer":{ + "type":"structure", + "members":{ + "targetGroupArn":{ + "shape":"String", + "documentation":"

The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set.

A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a Classic Load Balancer this should be omitted.

For services using the ECS deployment controller, you can specify one or multiple target groups. For more information, see Registering Multiple Target Groups with a Service in the Amazon Elastic Container Service Developer Guide.

For services using the CODE_DEPLOY deployment controller, you are required to define two target groups for the load balancer. For more information, see Blue/Green Deployment with CodeDeploy in the Amazon Elastic Container Service Developer Guide.

If your service's task definition uses the awsvpc network mode (which is required for the Fargate launch type), you must choose ip as the target type, not instance, when creating your target groups because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance.

" + }, + "loadBalancerName":{ + "shape":"String", + "documentation":"

The name of the load balancer to associate with the Amazon ECS service or task set.

A load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer or a Network Load Balancer this should be omitted.

" + }, + "containerName":{ + "shape":"String", + "documentation":"

The name of the container (as it appears in a container definition) to associate with the load balancer.

" + }, + "containerPort":{ + "shape":"BoxedInteger", + "documentation":"

The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.

" + } + }, + "documentation":"

Details on the load balancer or load balancers to use with a service or task set.

" + }, + "LoadBalancers":{ + "type":"list", + "member":{"shape":"LoadBalancer"} + }, + "LogConfiguration":{ + "type":"structure", + "required":["logDriver"], + "members":{ + "logDriver":{ + "shape":"LogDriver", + "documentation":"

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

For tasks using the Fargate launch type, the supported log drivers are awslogs, splunk, and awsfirelens.

For tasks using the EC2 launch type, the supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, splunk, and awsfirelens.

For more information about using the awslogs log driver, see Using the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.

For more information about using the awsfirelens log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + }, + "options":{ + "shape":"LogConfigurationOptionsMap", + "documentation":"

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

" + }, + "secretOptions":{ + "shape":"SecretList", + "documentation":"

The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "documentation":"

Log configuration options to send to a custom log driver for the container.

" + }, + "LogConfigurationOptionsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "LogDriver":{ + "type":"string", + "enum":[ + "json-file", + "syslog", + "journald", + "gelf", + "fluentd", + "awslogs", + "splunk", + "awsfirelens" + ] + }, + "Long":{"type":"long"}, + "MissingVersionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the container instance and does not have enough information to proceed with an update. This could be because the agent running on the container instance is an older or custom version that does not use our version information.

", + "exception":true + }, + "MountPoint":{ + "type":"structure", + "members":{ + "sourceVolume":{ + "shape":"String", + "documentation":"

The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.

" + }, + "containerPath":{ + "shape":"String", + "documentation":"

The path on the container to mount the host volume at.

" + }, + "readOnly":{ + "shape":"BoxedBoolean", + "documentation":"

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

" + } + }, + "documentation":"

Details on a volume mount point that is used in a container definition.

" + }, + "MountPointList":{ + "type":"list", + "member":{"shape":"MountPoint"} + }, + "NetworkBinding":{ + "type":"structure", + "members":{ + "bindIP":{ + "shape":"String", + "documentation":"

The IP address that the container is bound to on the container instance.

" + }, + "containerPort":{ + "shape":"BoxedInteger", + "documentation":"

The port number on the container that is used with the network binding.

" + }, + "hostPort":{ + "shape":"BoxedInteger", + "documentation":"

The port number on the host that is used with the network binding.

" + }, + "protocol":{ + "shape":"TransportProtocol", + "documentation":"

The protocol used for the network binding.

" + } + }, + "documentation":"

Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" + }, + "NetworkBindings":{ + "type":"list", + "member":{"shape":"NetworkBinding"} + }, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "awsvpcConfiguration":{ + "shape":"AwsVpcConfiguration", + "documentation":"

The VPC subnets and security groups associated with a task.

All specified subnets and security groups must be from the same VPC.

" + } + }, + "documentation":"

An object representing the network configuration for a task or service.

" + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "attachmentId":{ + "shape":"String", + "documentation":"

The attachment ID for the network interface.

" + }, + "privateIpv4Address":{ + "shape":"String", + "documentation":"

The private IPv4 address for the network interface.

" + }, + "ipv6Address":{ + "shape":"String", + "documentation":"

The private IPv6 address for the network interface.

" + } + }, + "documentation":"

An object representing the elastic network interface for tasks that use the awsvpc network mode.

" + }, + "NetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "NetworkMode":{ + "type":"string", + "enum":[ + "bridge", + "host", + "awsvpc", + "none" + ] + }, + "NoUpdateAvailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is no update available for this Amazon ECS container agent. This could be because the agent is already running the latest version, or it is so old that there is no update path to the current version.

", + "exception":true + }, + "PidMode":{ + "type":"string", + "enum":[ + "host", + "task" + ] + }, + "PlacementConstraint":{ + "type":"structure", + "members":{ + "type":{ + "shape":"PlacementConstraintType", + "documentation":"

The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

" + }, + "expression":{ + "shape":"String", + "documentation":"

A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "documentation":"

An object representing a constraint on task placement. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

If you are using the Fargate launch type, task placement constraints are not supported.

" + }, + "PlacementConstraintType":{ + "type":"string", + "enum":[ + "distinctInstance", + "memberOf" + ] + }, + "PlacementConstraints":{ + "type":"list", + "member":{"shape":"PlacementConstraint"} + }, + "PlacementStrategies":{ + "type":"list", + "member":{"shape":"PlacementStrategy"} + }, + "PlacementStrategy":{ + "type":"structure", + "members":{ + "type":{ + "shape":"PlacementStrategyType", + "documentation":"

The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

" + }, + "field":{ + "shape":"String", + "documentation":"

The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.

" + } + }, + "documentation":"

The task placement strategy for a task or service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide.

" + }, + "PlacementStrategyType":{ + "type":"string", + "enum":[ + "random", + "spread", + "binpack" + ] + }, + "PlatformDevice":{ + "type":"structure", + "required":[ + "id", + "type" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"

The ID for the GPU(s) on the container instance. The available GPU IDs can also be obtained on the container instance in the /var/lib/ecs/gpu/nvidia_gpu_info.json file.

" + }, + "type":{ + "shape":"PlatformDeviceType", + "documentation":"

The type of device that is available on the container instance. The only supported value is GPU.

" + } + }, + "documentation":"

The devices that are available on the container instance. The only supported device type is a GPU.

" + }, + "PlatformDeviceType":{ + "type":"string", + "enum":["GPU"] + }, + "PlatformDevices":{ + "type":"list", + "member":{"shape":"PlatformDevice"} + }, + "PlatformTaskDefinitionIncompatibilityException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified platform version does not satisfy the task definition's required capabilities.

", + "exception":true + }, + "PlatformUnknownException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified platform version does not exist.

", + "exception":true + }, + "PortMapping":{ + "type":"structure", + "members":{ + "containerPort":{ + "shape":"BoxedInteger", + "documentation":"

The port number on the container that is bound to the user-specified or automatically assigned host port.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort.

If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see hostPort. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

You cannot expose the same container port for multiple protocols. An error will be returned if this is attempted.

" + }, + "hostPort":{ + "shape":"BoxedInteger", + "documentation":"

The port number on the container instance to reserve for your container.

If you are using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort.

If you are using containers in a task with the bridge network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the hostPort (or set it to 0) while specifying a containerPort and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version.

The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under /proc/sys/net/ipv4/ip_local_port_range. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range.

The default ephemeral port range from 49153 through 65535 is always used for Docker versions before 1.6.0.

The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running (after a task stops, the host port is released). The current reserved ports are displayed in the remainingResources of DescribeContainerInstances output. A container instance can have up to 100 reserved ports at a time, including the default reserved ports. Automatically assigned ports don't count toward the 100 reserved ports limit.

" + }, + "protocol":{ + "shape":"TransportProtocol", + "documentation":"

The protocol used for the port mapping. Valid values are tcp and udp. The default is tcp.

" + } + }, + "documentation":"

Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition.

If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.

After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.

" + }, + "PortMappingList":{ + "type":"list", + "member":{"shape":"PortMapping"} + }, + "PropagateTags":{ + "type":"string", + "enum":[ + "TASK_DEFINITION", + "SERVICE" + ] + }, + "ProxyConfiguration":{ + "type":"structure", + "required":["containerName"], + "members":{ + "type":{ + "shape":"ProxyConfigurationType", + "documentation":"

The proxy type. The only supported value is APPMESH.

" + }, + "containerName":{ + "shape":"String", + "documentation":"

The name of the container that will serve as the App Mesh proxy.

" + }, + "properties":{ + "shape":"ProxyConfigurationProperties", + "documentation":"

The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs.

  • IgnoredUID - (Required) The user ID (UID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredGID is specified, this field can be empty.

  • IgnoredGID - (Required) The group ID (GID) of the proxy container as defined by the user parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If IgnoredUID is specified, this field can be empty.

  • AppPorts - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ProxyIngressPort and ProxyEgressPort.

  • ProxyIngressPort - (Required) Specifies the port that incoming traffic to the AppPorts is directed to.

  • ProxyEgressPort - (Required) Specifies the port that outgoing traffic from the AppPorts is directed to.

  • EgressIgnoredPorts - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

  • EgressIgnoredIPs - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ProxyEgressPort. It can be an empty list.

" + } + }, + "documentation":"

The configuration details for the App Mesh proxy.

For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

For tasks using the Fargate launch type, the task or service requires platform version 1.3.0 or later.

" + }, + "ProxyConfigurationProperties":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "ProxyConfigurationType":{ + "type":"string", + "enum":["APPMESH"] + }, + "PutAccountSettingDefaultRequest":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"SettingName", + "documentation":"

The resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the ENI limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

" + }, + "value":{ + "shape":"String", + "documentation":"

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

" + } + } + }, + "PutAccountSettingDefaultResponse":{ + "type":"structure", + "members":{ + "setting":{"shape":"Setting"} + } + }, + "PutAccountSettingRequest":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"SettingName", + "documentation":"

The Amazon ECS resource name for which to modify the account setting. If serviceLongArnFormat is specified, the ARN for your Amazon ECS services is affected. If taskLongArnFormat is specified, the ARN and resource ID for your Amazon ECS tasks is affected. If containerInstanceLongArnFormat is specified, the ARN and resource ID for your Amazon ECS container instances is affected. If awsvpcTrunking is specified, the elastic network interface (ENI) limit for your Amazon ECS container instances is affected. If containerInsights is specified, the default setting for CloudWatch Container Insights for your clusters is affected.

" + }, + "value":{ + "shape":"String", + "documentation":"

The account setting value for the specified principal ARN. Accepted values are enabled and disabled.

" + }, + "principalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you specify the root user, it modifies the account setting for all IAM users, IAM roles, and the root user of the account unless an IAM user or role explicitly overrides these settings. If this field is omitted, the setting is changed only for the authenticated user.

" + } + } + }, + "PutAccountSettingResponse":{ + "type":"structure", + "members":{ + "setting":{ + "shape":"Setting", + "documentation":"

The current account setting for a resource.

" + } + } + }, + "PutAttributesRequest":{ + "type":"structure", + "required":["attributes"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply attributes. If you do not specify a cluster, the default cluster is assumed.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes to apply to your resource. You can specify up to 10 custom attributes per resource. You can specify up to 10 attributes in a single call.

" + } + } + }, + "PutAttributesResponse":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes applied to your resource.

" + } + } + }, + "RegisterContainerInstanceRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container instance. If you do not specify a cluster, the default cluster is assumed.

" + }, + "instanceIdentityDocument":{ + "shape":"String", + "documentation":"

The instance identity document for the EC2 instance to register. This document can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/

" + }, + "instanceIdentityDocumentSignature":{ + "shape":"String", + "documentation":"

The instance identity document signature for the EC2 instance to register. This signature can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/signature/

" + }, + "totalResources":{ + "shape":"Resources", + "documentation":"

The resources available on the instance.

" + }, + "versionInfo":{ + "shape":"VersionInfo", + "documentation":"

The version information for the Amazon ECS container agent and Docker daemon running on the container instance.

" + }, + "containerInstanceArn":{ + "shape":"String", + "documentation":"

The ARN of the container instance (if it was previously registered).

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The container instance attributes that this container instance supports.

" + }, + "platformDevices":{ + "shape":"PlatformDevices", + "documentation":"

The devices that are available on the container instance. The only supported device type is a GPU.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the container instance to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + } + } + }, + "RegisterContainerInstanceResponse":{ + "type":"structure", + "members":{ + "containerInstance":{ + "shape":"ContainerInstance", + "documentation":"

The container instance that was registered.

" + } + } + }, + "RegisterTaskDefinitionRequest":{ + "type":"structure", + "required":[ + "family", + "containerDefinitions" + ], + "members":{ + "family":{ + "shape":"String", + "documentation":"

You must specify a family for a task definition, which allows you to track multiple versions of the same task definition. The family is used as a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.

" + }, + "taskRoleArn":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role. For more information, see IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

" + }, + "executionRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

" + }, + "networkMode":{ + "shape":"NetworkMode", + "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

" + }, + "containerDefinitions":{ + "shape":"ContainerDefinitions", + "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task.

" + }, + "volumes":{ + "shape":"VolumeList", + "documentation":"

A list of volume definitions in JSON format that containers in your task may use.

" + }, + "placementConstraints":{ + "shape":"TaskDefinitionPlacementConstraints", + "documentation":"

An array of placement constraint objects to use for the task. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at runtime).

" + }, + "requiresCompatibilities":{ + "shape":"CompatibilityList", + "documentation":"

The launch type required by the task. If no value is specified, it defaults to EC2.

" + }, + "cpu":{ + "shape":"String", + "documentation":"

The number of CPU units used by the task. It can be expressed as an integer using CPU units, for example 1024, or as a string using vCPUs, for example 1 vCPU or 1 vcpu, in a task definition. String values are converted to an integer indicating the CPU units when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

" + }, + "memory":{ + "shape":"String", + "documentation":"

The amount of memory (in MiB) used by the task. It can be expressed as an integer using MiB, for example 1024, or as a string using GB, for example 1GB or 1 GB, in a task definition. String values are converted to an integer indicating the MiB when the task definition is registered.

Task-level CPU and memory parameters are ignored for Windows containers. We recommend specifying container-level resources for Windows containers.

If using the EC2 launch type, this field is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "pidMode":{ + "shape":"PidMode", + "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + }, + "ipcMode":{ + "shape":"IpcMode", + "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + }, + "proxyConfiguration":{"shape":"ProxyConfiguration"}, + "inferenceAccelerators":{ + "shape":"InferenceAccelerators", + "documentation":"

The Elastic Inference accelerators to use for the containers in the task.

" + } + } + }, + "RegisterTaskDefinitionResponse":{ + "type":"structure", + "members":{ + "taskDefinition":{ + "shape":"TaskDefinition", + "documentation":"

The full description of the registered task definition.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The list of tags associated with the task definition.

" + } + } + }, + "RepositoryCredentials":{ + "type":"structure", + "required":["credentialsParameter"], + "members":{ + "credentialsParameter":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

When you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the same Region as the task that you are launching then you can use either the full ARN or the name of the secret. When you are using the AWS Management Console, you must specify the full ARN of the secret.

" + } + }, + "documentation":"

The repository credentials for private registry authentication.

" + }, + "RequiresAttributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "Resource":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the resource, such as CPU, MEMORY, PORTS, PORTS_UDP, or a user-defined resource.

" + }, + "type":{ + "shape":"String", + "documentation":"

The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET.

" + }, + "doubleValue":{ + "shape":"Double", + "documentation":"

When the doubleValue type is set, the value of the resource must be a double precision floating-point type.

" + }, + "longValue":{ + "shape":"Long", + "documentation":"

When the longValue type is set, the value of the resource must be an extended precision floating-point type.

" + }, + "integerValue":{ + "shape":"Integer", + "documentation":"

When the integerValue type is set, the value of the resource must be an integer.

" + }, + "stringSetValue":{ + "shape":"StringList", + "documentation":"

When the stringSetValue type is set, the value of the resource must be a string type.

" + } + }, + "documentation":"

Describes the resources available for a container instance.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource could not be found.

", + "exception":true + }, + "ResourceRequirement":{ + "type":"structure", + "required":[ + "value", + "type" + ], + "members":{ + "value":{ + "shape":"String", + "documentation":"

The value for the specified resource type.

If the GPU type is used, the value is the number of physical GPUs the Amazon ECS container agent will reserve for the container. The number of GPUs reserved for all containers in a task should not exceed the number of available GPUs on the container instance the task is launched on.

If the InferenceAccelerator type is used, the value should match the deviceName for an InferenceAccelerator specified in a task definition.

" + }, + "type":{ + "shape":"ResourceType", + "documentation":"

The type of resource to assign to a container. The supported values are GPU or InferenceAccelerator.

" + } + }, + "documentation":"

The type and amount of a resource to assign to a container. The supported resource types are GPUs and Elastic Inference accelerators. For more information, see Working with GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the Amazon Elastic Container Service Developer Guide

" + }, + "ResourceRequirements":{ + "type":"list", + "member":{"shape":"ResourceRequirement"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "GPU", + "InferenceAccelerator" + ] + }, + "Resources":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "RunTaskRequest":{ + "type":"structure", + "required":["taskDefinition"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The family and revision (family:revision) or full ARN of the task definition to run. If a revision is not specified, the latest ACTIVE revision is used.

" + }, + "overrides":{ + "shape":"TaskOverride", + "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" + }, + "count":{ + "shape":"BoxedInteger", + "documentation":"

The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks per call.

" + }, + "startedBy":{ + "shape":"String", + "documentation":"

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" + }, + "group":{ + "shape":"String", + "documentation":"

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

" + }, + "placementConstraints":{ + "shape":"PlacementConstraints", + "documentation":"

An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).

" + }, + "placementStrategy":{ + "shape":"PlacementStrategies", + "documentation":"

The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version the task should run. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "enableECSManagedTags":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

" + }, + "propagateTags":{ + "shape":"PropagateTags", + "documentation":"

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

An error will be received if you specify the SERVICE option when running a task.

" + } + } + }, + "RunTaskResponse":{ + "type":"structure", + "members":{ + "tasks":{ + "shape":"Tasks", + "documentation":"

A full description of the tasks that were run. The tasks that were successfully placed on your cluster are described here.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "Scale":{ + "type":"structure", + "members":{ + "value":{ + "shape":"Double", + "documentation":"

The value, specified as a percent total of a service's desiredCount, to scale the task set. Accepted values are numbers between 0 and 100.

" + }, + "unit":{ + "shape":"ScaleUnit", + "documentation":"

The unit of measure for the scale value.

" + } + }, + "documentation":"

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

" + }, + "ScaleUnit":{ + "type":"string", + "enum":["PERCENT"] + }, + "SchedulingStrategy":{ + "type":"string", + "enum":[ + "REPLICA", + "DAEMON" + ] + }, + "Scope":{ + "type":"string", + "enum":[ + "task", + "shared" + ] + }, + "Secret":{ + "type":"structure", + "required":[ + "name", + "valueFrom" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the secret.

" + }, + "valueFrom":{ + "shape":"String", + "documentation":"

The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.

If the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

" + } + }, + "documentation":"

An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

" + }, + "SecretList":{ + "type":"list", + "member":{"shape":"Secret"} + }, + "ServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a server issue.

", + "exception":true, + "fault":true + }, + "Service":{ + "type":"structure", + "members":{ + "serviceArn":{ + "shape":"String", + "documentation":"

The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.

" + }, + "serviceName":{ + "shape":"String", + "documentation":"

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the cluster that hosts the service.

" + }, + "loadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

" + }, + "serviceRegistries":{ + "shape":"ServiceRegistries", + "documentation":"

The details of the service discovery registries to assign to this service. For more information, see Service Discovery.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.

" + }, + "desiredCount":{ + "shape":"Integer", + "documentation":"

The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

" + }, + "runningCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the cluster that are in the RUNNING state.

" + }, + "pendingCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the cluster that are in the PENDING state.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.

" + }, + "deploymentConfiguration":{ + "shape":"DeploymentConfiguration", + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" + }, + "taskSets":{ + "shape":"TaskSets", + "documentation":"

Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

" + }, + "deployments":{ + "shape":"Deployments", + "documentation":"

The current state of deployments for the service.

" + }, + "roleArn":{ + "shape":"String", + "documentation":"

The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.

" + }, + "events":{ + "shape":"ServiceEvents", + "documentation":"

The event stream for your service. A maximum of 100 of the latest events are displayed.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the service was created.

" + }, + "placementConstraints":{ + "shape":"PlacementConstraints", + "documentation":"

The placement constraints for the tasks in the service.

" + }, + "placementStrategy":{ + "shape":"PlacementStrategies", + "documentation":"

The placement strategy that determines how tasks for the service are placed.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

" + }, + "healthCheckGracePeriodSeconds":{ + "shape":"BoxedInteger", + "documentation":"

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

" + }, + "schedulingStrategy":{ + "shape":"SchedulingStrategy", + "documentation":"

The scheduling strategy to use for the service. For more information, see Services.

There are two service scheduler strategies available:

  • REPLICA-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.

  • DAEMON-The daemon scheduling strategy deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.

    Fargate tasks do not support the DAEMON scheduling strategy.
" + }, + "deploymentController":{ + "shape":"DeploymentController", + "documentation":"

The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "createdBy":{ + "shape":"String", + "documentation":"

The principal that created the service.

" + }, + "enableECSManagedTags":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

" + }, + "propagateTags":{ + "shape":"PropagateTags", + "documentation":"

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

" + } + }, + "documentation":"

Details on a service within a cluster

" + }, + "ServiceEvent":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The ID string of the event.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the event was triggered.

" + }, + "message":{ + "shape":"String", + "documentation":"

The event message.

" + } + }, + "documentation":"

Details on an event associated with a service.

" + }, + "ServiceEvents":{ + "type":"list", + "member":{"shape":"ServiceEvent"} + }, + "ServiceField":{ + "type":"string", + "enum":["TAGS"] + }, + "ServiceFieldList":{ + "type":"list", + "member":{"shape":"ServiceField"} + }, + "ServiceNotActiveException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified service is not active. You can't update a service that is inactive. If you have previously deleted a service, you can re-create it with CreateService.

", + "exception":true + }, + "ServiceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified service could not be found. You can view your available services with ListServices. Amazon ECS services are cluster-specific and Region-specific.

", + "exception":true + }, + "ServiceRegistries":{ + "type":"list", + "member":{"shape":"ServiceRegistry"} + }, + "ServiceRegistry":{ + "type":"structure", + "members":{ + "registryArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is AWS Cloud Map. For more information, see CreateService.

" + }, + "port":{ + "shape":"BoxedInteger", + "documentation":"

The port value used if your service discovery service specified an SRV record. This field may be used if both the awsvpc network mode and SRV records are used.

" + }, + "containerName":{ + "shape":"String", + "documentation":"

The container name value, already specified in the task definition, to be used for your service discovery service. If the task definition that your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition that your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

" + }, + "containerPort":{ + "shape":"BoxedInteger", + "documentation":"

The port value, already specified in the task definition, to be used for your service discovery service. If the task definition your service task specifies uses the bridge or host network mode, you must specify a containerName and containerPort combination from the task definition. If the task definition your service task specifies uses the awsvpc network mode and a type SRV DNS record is used, you must specify either a containerName and containerPort combination or a port value, but not both.

" + } + }, + "documentation":"

Details of the service registry.

" + }, + "Services":{ + "type":"list", + "member":{"shape":"Service"} + }, + "Setting":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SettingName", + "documentation":"

The Amazon ECS resource name.

" + }, + "value":{ + "shape":"String", + "documentation":"

Whether the account setting is enabled or disabled for the specified resource.

" + }, + "principalArn":{ + "shape":"String", + "documentation":"

The ARN of the principal, which can be an IAM user, IAM role, or the root user. If this field is omitted, the authenticated user is assumed.

" + } + }, + "documentation":"

The current account setting for a resource.

" + }, + "SettingName":{ + "type":"string", + "enum":[ + "serviceLongArnFormat", + "taskLongArnFormat", + "containerInstanceLongArnFormat", + "awsvpcTrunking", + "containerInsights" + ] + }, + "Settings":{ + "type":"list", + "member":{"shape":"Setting"} + }, + "SortOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "StabilityStatus":{ + "type":"string", + "enum":[ + "STEADY_STATE", + "STABILIZING" + ] + }, + "StartTaskRequest":{ + "type":"structure", + "required":[ + "taskDefinition", + "containerInstances" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The family and revision (family:revision) or full ARN of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

" + }, + "overrides":{ + "shape":"TaskOverride", + "documentation":"

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a command override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an environment override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

" + }, + "containerInstances":{ + "shape":"StringList", + "documentation":"

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

" + }, + "startedBy":{ + "shape":"String", + "documentation":"

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the startedBy parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the startedBy value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" + }, + "group":{ + "shape":"String", + "documentation":"

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "enableECSManagedTags":{ + "shape":"Boolean", + "documentation":"

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

" + }, + "propagateTags":{ + "shape":"PropagateTags", + "documentation":"

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

" + } + } + }, + "StartTaskResponse":{ + "type":"structure", + "members":{ + "tasks":{ + "shape":"Tasks", + "documentation":"

A full description of the tasks that were started. Each task that was successfully placed on your container instances is described.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "Statistics":{ + "type":"list", + "member":{"shape":"KeyValuePair"} + }, + "StopTaskRequest":{ + "type":"structure", + "required":["task"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

" + }, + "task":{ + "shape":"String", + "documentation":"

The task ID or full Amazon Resource Name (ARN) of the task to stop.

" + }, + "reason":{ + "shape":"String", + "documentation":"

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

" + } + } + }, + "StopTaskResponse":{ + "type":"structure", + "members":{ + "task":{ + "shape":"Task", + "documentation":"

The task that was stopped.

" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SubmitAttachmentStateChangesRequest":{ + "type":"structure", + "required":["attachments"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full ARN of the cluster that hosts the container instance the attachment belongs to.

" + }, + "attachments":{ + "shape":"AttachmentStateChanges", + "documentation":"

Any attachments associated with the state change request.

" + } + } + }, + "SubmitAttachmentStateChangesResponse":{ + "type":"structure", + "members":{ + "acknowledgment":{ + "shape":"String", + "documentation":"

Acknowledgement of the state change.

" + } + } + }, + "SubmitContainerStateChangeRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full ARN of the cluster that hosts the container.

" + }, + "task":{ + "shape":"String", + "documentation":"

The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.

" + }, + "containerName":{ + "shape":"String", + "documentation":"

The name of the container.

" + }, + "runtimeId":{ + "shape":"String", + "documentation":"

The ID of the Docker container.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the state change request.

" + }, + "exitCode":{ + "shape":"BoxedInteger", + "documentation":"

The exit code returned for the state change request.

" + }, + "reason":{ + "shape":"String", + "documentation":"

The reason for the state change request.

" + }, + "networkBindings":{ + "shape":"NetworkBindings", + "documentation":"

The network bindings of the container.

" + } + } + }, + "SubmitContainerStateChangeResponse":{ + "type":"structure", + "members":{ + "acknowledgment":{ + "shape":"String", + "documentation":"

Acknowledgement of the state change.

" + } + } + }, + "SubmitTaskStateChangeRequest":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.

" + }, + "task":{ + "shape":"String", + "documentation":"

The task ID or full ARN of the task in the state change request.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the state change request.

" + }, + "reason":{ + "shape":"String", + "documentation":"

The reason for the state change request.

" + }, + "containers":{ + "shape":"ContainerStateChanges", + "documentation":"

Any containers associated with the state change request.

" + }, + "attachments":{ + "shape":"AttachmentStateChanges", + "documentation":"

Any attachments associated with the state change request.

" + }, + "pullStartedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the container image pull began.

" + }, + "pullStoppedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the container image pull completed.

" + }, + "executionStoppedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task execution stopped.

" + } + } + }, + "SubmitTaskStateChangeResponse":{ + "type":"structure", + "members":{ + "acknowledgment":{ + "shape":"String", + "documentation":"

Acknowledgement of the state change.

" + } + } + }, + "SystemControl":{ + "type":"structure", + "members":{ + "namespace":{ + "shape":"String", + "documentation":"

The namespaced kernel parameter for which to set a value.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value for the namespaced kernel parameter specified in namespace.

" + } + }, + "documentation":"

A list of namespaced kernel parameters to set in the container. This parameter maps to Sysctls in the Create a container section of the Docker Remote API and the --sysctl option to docker run.

It is not recommended that you specify network-related systemControls parameters for multiple containers in a single task that also uses either the awsvpc or host network mode for the following reasons:

  • For tasks that use the awsvpc network mode, if you set systemControls for any container, it applies to all containers in the task. If you set different systemControls for multiple containers in a single task, the container that is started last determines which systemControls take effect.

  • For tasks that use the host network mode, the systemControls parameter applies to the container instance's kernel parameter as well as that of all containers of any tasks running on that container instance.

" + }, + "SystemControls":{ + "type":"list", + "member":{"shape":"SystemControl"} + }, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TargetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified target could not be found. You can view your available container instances with ListContainerInstances. Amazon ECS container instances are cluster-specific and Region-specific.

", + "exception":true + }, + "TargetType":{ + "type":"string", + "enum":["container-instance"] + }, + "Task":{ + "type":"structure", + "members":{ + "taskArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the task.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The ARN of the cluster that hosts the task.

" + }, + "taskDefinitionArn":{ + "shape":"String", + "documentation":"

The ARN of the task definition that creates the task.

" + }, + "containerInstanceArn":{ + "shape":"String", + "documentation":"

The ARN of the container instances that host the task.

" + }, + "overrides":{ + "shape":"TaskOverride", + "documentation":"

One or more container overrides.

" + }, + "lastStatus":{ + "shape":"String", + "documentation":"

The last known status of the task. For more information, see Task Lifecycle.

" + }, + "desiredStatus":{ + "shape":"String", + "documentation":"

The desired status of the task. For more information, see Task Lifecycle.

" + }, + "cpu":{ + "shape":"String", + "documentation":"

The number of CPU units used by the task as expressed in a task definition. It can be expressed as an integer using CPU units, for example 1024. It can also be expressed as a string using vCPUs, for example 1 vCPU or 1 vcpu. String values are converted to an integer indicating the CPU units when the task definition is registered.

If you are using the EC2 launch type, this field is optional. Supported values are between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs).

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

" + }, + "memory":{ + "shape":"String", + "documentation":"

The amount of memory (in MiB) used by the task as expressed in a task definition. It can be expressed as an integer using MiB, for example 1024. It can also be expressed as a string using GB, for example 1GB or 1 GB. String values are converted to an integer indicating the MiB when the task definition is registered.

If you are using the EC2 launch type, this field is optional.

If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of supported values for the cpu parameter:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

" + }, + "containers":{ + "shape":"Containers", + "documentation":"

The containers associated with the task.

" + }, + "startedBy":{ + "shape":"String", + "documentation":"

The tag specified when a task is started. If the task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

" + }, + "version":{ + "shape":"Long", + "documentation":"

The version counter for the task. Every time a task experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API actions with the version reported in CloudWatch Events for the task (inside the detail object) to verify that the version in your event stream is current.

" + }, + "stoppedReason":{ + "shape":"String", + "documentation":"

The reason that the task was stopped.

" + }, + "stopCode":{ + "shape":"TaskStopCode", + "documentation":"

The stop code indicating why a task was stopped. The stoppedReason may contain additional details.

" + }, + "connectivity":{ + "shape":"Connectivity", + "documentation":"

The connectivity status of a task.

" + }, + "connectivityAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task last went into CONNECTED status.

" + }, + "pullStartedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the container image pull began.

" + }, + "pullStoppedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the container image pull completed.

" + }, + "executionStoppedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task execution stopped.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task was created (the task entered the PENDING state).

" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task started (the task transitioned from the PENDING state to the RUNNING state).

" + }, + "stoppingAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task stops (transitions from the RUNNING state to STOPPED).

" + }, + "stoppedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task was stopped (the task transitioned from the RUNNING state to the STOPPED state).

" + }, + "group":{ + "shape":"String", + "documentation":"

The name of the task group associated with the task.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type on which your task is running. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version on which your task is running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "attachments":{ + "shape":"Attachments", + "documentation":"

The Elastic Network Adapter associated with the task if the task uses the awsvpc network mode.

" + }, + "healthStatus":{ + "shape":"HealthStatus", + "documentation":"

The health status for the task, which is determined by the health of the essential containers in the task. If all essential containers in the task are reporting as HEALTHY, then the task status also reports as HEALTHY. If any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, then the task status also reports as UNHEALTHY or UNKNOWN, accordingly.

The Amazon ECS container agent does not monitor or report on Docker health checks that are embedded in a container image (such as those specified in a parent image or from the image's Dockerfile) and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

" + }, + "inferenceAccelerators":{ + "shape":"InferenceAccelerators", + "documentation":"

The Elastic Inference accelerator associated with the task.

" + } + }, + "documentation":"

Details on a task in a cluster.

" + }, + "TaskDefinition":{ + "type":"structure", + "members":{ + "taskDefinitionArn":{ + "shape":"String", + "documentation":"

The full Amazon Resource Name (ARN) of the task definition.

" + }, + "containerDefinitions":{ + "shape":"ContainerDefinitions", + "documentation":"

A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" + }, + "family":{ + "shape":"String", + "documentation":"

The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

" + }, + "taskRoleArn":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide.

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see Windows IAM Roles for Tasks in the Amazon Elastic Container Service Developer Guide.

" + }, + "executionRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the task execution role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

" + }, + "networkMode":{ + "shape":"NetworkMode", + "documentation":"

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host. The default Docker network mode is bridge. If you are using the Fargate launch type, the awsvpc network mode is required. If you are using the EC2 launch type, any network mode can be used. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

If the network mode is awsvpc, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the ecs-init package, or AWS Fargate infrastructure support the awsvpc network mode.

If the network mode is host, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

Docker for Windows uses different network modes than Docker for Linux. When you register a task definition with Windows containers, you must not specify a network mode. If you use the console to register a task definition with Windows containers, you must choose the <default> network mode object.

For more information, see Network settings in the Docker run reference.

" + }, + "revision":{ + "shape":"Integer", + "documentation":"

The revision of the task in a particular family. The revision is a version number of a task definition in a family. When you register a task definition for the first time, the revision is 1. Each time that you register a new revision of a task definition in the same family, the revision value always increases by one, even if you have deregistered previous revisions in this family.

" + }, + "volumes":{ + "shape":"VolumeList", + "documentation":"

The list of volume definitions for the task.

If your tasks are using the Fargate launch type, the host and sourcePath parameters are not supported.

For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.

" + }, + "status":{ + "shape":"TaskDefinitionStatus", + "documentation":"

The status of the task definition.

" + }, + "requiresAttributes":{ + "shape":"RequiresAttributes", + "documentation":"

The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.

" + }, + "placementConstraints":{ + "shape":"TaskDefinitionPlacementConstraints", + "documentation":"

An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.

" + }, + "compatibilities":{ + "shape":"CompatibilityList", + "documentation":"

The launch type to use with your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "requiresCompatibilities":{ + "shape":"CompatibilityList", + "documentation":"

The launch type the task requires. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE.

" + }, + "cpu":{ + "shape":"String", + "documentation":"

The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

  • 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

  • 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

  • 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

  • 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

  • 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

" + }, + "memory":{ + "shape":"String", + "documentation":"

The amount (in MiB) of memory used by the task.

If using the EC2 launch type, this field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional.

If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

  • 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

  • 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

  • 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

  • Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

  • Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

" + }, + "pidMode":{ + "shape":"PidMode", + "documentation":"

The process namespace to use for the containers in the task. The valid values are host or task. If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference.

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + }, + "ipcMode":{ + "shape":"IpcMode", + "documentation":"

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none. If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security.

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide.

  • For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.

  • For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks using the Fargate launch type.

" + }, + "proxyConfiguration":{ + "shape":"ProxyConfiguration", + "documentation":"

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to enable a proxy configuration. If your container instances are launched from the Amazon ECS-optimized AMI version 20190301 or later, then they contain the required versions of the container agent and ecs-init. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "documentation":"

The details of a task definition which describes the container and volume definitions of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

" + }, + "TaskDefinitionFamilyStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "ALL" + ] + }, + "TaskDefinitionField":{ + "type":"string", + "enum":["TAGS"] + }, + "TaskDefinitionFieldList":{ + "type":"list", + "member":{"shape":"TaskDefinitionField"} + }, + "TaskDefinitionPlacementConstraint":{ + "type":"structure", + "members":{ + "type":{ + "shape":"TaskDefinitionPlacementConstraintType", + "documentation":"

The type of constraint. The MemberOf constraint restricts selection to be from a group of valid candidates.

" + }, + "expression":{ + "shape":"String", + "documentation":"

A cluster query language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.

" + } + }, + "documentation":"

An object representing a constraint on task placement in the task definition. For more information, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

If you are using the Fargate launch type, task placement constraints are not supported.

" + }, + "TaskDefinitionPlacementConstraintType":{ + "type":"string", + "enum":["memberOf"] + }, + "TaskDefinitionPlacementConstraints":{ + "type":"list", + "member":{"shape":"TaskDefinitionPlacementConstraint"} + }, + "TaskDefinitionStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "TaskField":{ + "type":"string", + "enum":["TAGS"] + }, + "TaskFieldList":{ + "type":"list", + "member":{"shape":"TaskField"} + }, + "TaskOverride":{ + "type":"structure", + "members":{ + "containerOverrides":{ + "shape":"ContainerOverrides", + "documentation":"

One or more container overrides sent to a task.

" + }, + "inferenceAcceleratorOverrides":{ + "shape":"InferenceAcceleratorOverrides", + "documentation":"

The Elastic Inference accelerator override for the task.

" + }, + "taskRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers in this task are granted the permissions that are specified in this role.

" + }, + "executionRoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.

" + } + }, + "documentation":"

The overrides associated with a task.

" + }, + "TaskSet":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

The ID of the task set.

" + }, + "taskSetArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the task set.

" + }, + "serviceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the service the task set exists in.

" + }, + "clusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists in.

" + }, + "startedBy":{ + "shape":"String", + "documentation":"

The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy deployment, the startedBy parameter is CODE_DEPLOY. For a task set created for an external deployment, the startedBy field isn't used.

" + }, + "externalId":{ + "shape":"String", + "documentation":"

The external ID associated with the task set.

If a task set is created by an AWS CodeDeploy deployment, the externalId parameter contains the AWS CodeDeploy deployment ID.

If a task set is created for an external deployment and is associated with a service discovery registry, the externalId parameter contains the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute.

" + }, + "status":{ + "shape":"String", + "documentation":"

The status of the task set. The following describes each state:

PRIMARY

The task set is serving production traffic.

ACTIVE

The task set is not serving production traffic.

DRAINING

The tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The task definition the task set is using.

" + }, + "computedDesiredCount":{ + "shape":"Integer", + "documentation":"

The computed desired count for the task set. This is calculated by multiplying the service's desiredCount by the task set's scale percentage. The result is always rounded up. For example, if the computed desired count is 1.2, it rounds up to 2 tasks.

" + }, + "pendingCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the task set that are in the PENDING status during a deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time or when it is restarted after being in the STOPPED state.

" + }, + "runningCount":{ + "shape":"Integer", + "documentation":"

The number of tasks in the task set that are in the RUNNING status during a deployment. A task in the RUNNING state is running and ready for use.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task set was created.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task set was last updated.

" + }, + "launchType":{ + "shape":"LaunchType", + "documentation":"

The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The network configuration for the task set.

" + }, + "loadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

Details on a load balancer that is used with a task set.

" + }, + "serviceRegistries":{ + "shape":"ServiceRegistries", + "documentation":"

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.

" + }, + "scale":{ + "shape":"Scale", + "documentation":"

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

" + }, + "stabilityStatus":{ + "shape":"StabilityStatus", + "documentation":"

The stability status, which indicates whether the task set has reached a steady state. If the following conditions are met, the task set will be in STEADY_STATE:

  • The task runningCount is equal to the computedDesiredCount.

  • The pendingCount is 0.

  • There are no tasks running on container instances in the DRAINING status.

  • All tasks are reporting a healthy status from the load balancers, service discovery, and container health checks.

If any of those conditions are not met, the stability status returns STABILIZING.

" + }, + "stabilityStatusAt":{ + "shape":"Timestamp", + "documentation":"

The Unix timestamp for when the task set stability status was retrieved.

" + } + }, + "documentation":"

Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic.

" + }, + "TaskSetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified task set could not be found. You can view your available container instances with DescribeTaskSets. Task sets are specific to each cluster, service and Region.

", + "exception":true + }, + "TaskSets":{ + "type":"list", + "member":{"shape":"TaskSet"} + }, + "TaskStopCode":{ + "type":"string", + "enum":[ + "TaskFailedToStart", + "EssentialContainerExited", + "UserInitiated" + ] + }, + "Tasks":{ + "type":"list", + "member":{"shape":"Task"} + }, + "Timestamp":{"type":"timestamp"}, + "Tmpfs":{ + "type":"structure", + "required":[ + "containerPath", + "size" + ], + "members":{ + "containerPath":{ + "shape":"String", + "documentation":"

The absolute file path where the tmpfs volume is to be mounted.

" + }, + "size":{ + "shape":"Integer", + "documentation":"

The size (in MiB) of the tmpfs volume.

" + }, + "mountOptions":{ + "shape":"StringList", + "documentation":"

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

" + } + }, + "documentation":"

The container path, mount options, and size of the tmpfs mount.

" + }, + "TmpfsList":{ + "type":"list", + "member":{"shape":"Tmpfs"} + }, + "TransportProtocol":{ + "type":"string", + "enum":[ + "tcp", + "udp" + ] + }, + "Ulimit":{ + "type":"structure", + "required":[ + "name", + "softLimit", + "hardLimit" + ], + "members":{ + "name":{ + "shape":"UlimitName", + "documentation":"

The type of the ulimit.

" + }, + "softLimit":{ + "shape":"Integer", + "documentation":"

The soft limit for the ulimit type.

" + }, + "hardLimit":{ + "shape":"Integer", + "documentation":"

The hard limit for the ulimit type.

" + } + }, + "documentation":"

The ulimit settings to pass to the container.

" + }, + "UlimitList":{ + "type":"list", + "member":{"shape":"Ulimit"} + }, + "UlimitName":{ + "type":"string", + "enum":[ + "core", + "cpu", + "data", + "fsize", + "locks", + "memlock", + "msgqueue", + "nice", + "nofile", + "nproc", + "rss", + "rtprio", + "rttime", + "sigpending", + "stack" + ] + }, + "UnsupportedFeatureException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified task is not supported in this Region.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.

" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"

The keys of the tags to be removed.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateClusterSettingsRequest":{ + "type":"structure", + "required":[ + "cluster", + "settings" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The name of the cluster to modify the settings for.

" + }, + "settings":{ + "shape":"ClusterSettings", + "documentation":"

The setting to use by default for a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

" + } + } + }, + "UpdateClusterSettingsResponse":{ + "type":"structure", + "members":{ + "cluster":{"shape":"Cluster"} + } + }, + "UpdateContainerAgentRequest":{ + "type":"structure", + "required":["containerInstance"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is running on. If you do not specify a cluster, the default cluster is assumed.

" + }, + "containerInstance":{ + "shape":"String", + "documentation":"

The container instance ID or full ARN entries for the container instance on which you would like to update the Amazon ECS container agent.

" + } + } + }, + "UpdateContainerAgentResponse":{ + "type":"structure", + "members":{ + "containerInstance":{ + "shape":"ContainerInstance", + "documentation":"

The container instance for which the container agent was updated.

" + } + } + }, + "UpdateContainerInstancesStateRequest":{ + "type":"structure", + "required":[ + "containerInstances", + "status" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to update. If you do not specify a cluster, the default cluster is assumed.

" + }, + "containerInstances":{ + "shape":"StringList", + "documentation":"

A list of container instance IDs or full ARN entries.

" + }, + "status":{ + "shape":"ContainerInstanceStatus", + "documentation":"

The container instance state with which to update the container instance. The only valid values for this action are ACTIVE and DRAINING. A container instance can only be updated to DRAINING status once it has reached an ACTIVE state. If a container instance is in REGISTERING, DEREGISTERING, or REGISTRATION_FAILED state you can describe the container instance but will be unable to update the container instance state.

" + } + } + }, + "UpdateContainerInstancesStateResponse":{ + "type":"structure", + "members":{ + "containerInstances":{ + "shape":"ContainerInstances", + "documentation":"

The list of container instances.

" + }, + "failures":{ + "shape":"Failures", + "documentation":"

Any failures associated with the call.

" + } + } + }, + "UpdateInProgressException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is already a current Amazon ECS container agent update in progress on the specified container instance. If the container agent becomes disconnected while it is in a transitional stage, such as PENDING or STAGING, the update process can get stuck in that state. However, when the agent reconnects, it resumes where it stopped previously.

", + "exception":true + }, + "UpdateServicePrimaryTaskSetRequest":{ + "type":"structure", + "required":[ + "cluster", + "service", + "primaryTaskSet" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

" + }, + "service":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

" + }, + "primaryTaskSet":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

" + } + } + }, + "UpdateServicePrimaryTaskSetResponse":{ + "type":"structure", + "members":{ + "taskSet":{"shape":"TaskSet"} + } + }, + "UpdateServiceRequest":{ + "type":"structure", + "required":["service"], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

" + }, + "service":{ + "shape":"String", + "documentation":"

The name of the service to update.

" + }, + "desiredCount":{ + "shape":"BoxedInteger", + "documentation":"

The number of instantiations of the task to place and keep running in your service.

" + }, + "taskDefinition":{ + "shape":"String", + "documentation":"

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

" + }, + "deploymentConfiguration":{ + "shape":"DeploymentConfiguration", + "documentation":"

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

" + }, + "networkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.

Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "forceNewDeployment":{ + "shape":"Boolean", + "documentation":"

Whether to force a new deployment of the service. Deployments are not forced by default. You can use this option to trigger a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (my_image:latest) or to roll Fargate tasks onto a newer platform version.

" + }, + "healthCheckGracePeriodSeconds":{ + "shape":"BoxedInteger", + "documentation":"

The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.

" + } + } + }, + "UpdateServiceResponse":{ + "type":"structure", + "members":{ + "service":{ + "shape":"Service", + "documentation":"

The full description of your service following the update call.

" + } + } + }, + "UpdateTaskSetRequest":{ + "type":"structure", + "required":[ + "cluster", + "service", + "taskSet", + "scale" + ], + "members":{ + "cluster":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

" + }, + "service":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

" + }, + "taskSet":{ + "shape":"String", + "documentation":"

The short name or full Amazon Resource Name (ARN) of the task set to update.

" + }, + "scale":{"shape":"Scale"} + } + }, + "UpdateTaskSetResponse":{ + "type":"structure", + "members":{ + "taskSet":{"shape":"TaskSet"} + } + }, + "VersionInfo":{ + "type":"structure", + "members":{ + "agentVersion":{ + "shape":"String", + "documentation":"

The version number of the Amazon ECS container agent.

" + }, + "agentHash":{ + "shape":"String", + "documentation":"

The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent GitHub repository.

" + }, + "dockerVersion":{ + "shape":"String", + "documentation":"

The Docker version running on the container instance.

" + } + }, + "documentation":"

The Docker and Amazon ECS container agent version information about a container instance.

" + }, + "Volume":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

" + }, + "host":{ + "shape":"HostVolumeProperties", + "documentation":"

This parameter is specified when you are using bind mount host volumes. Bind mount host volumes are supported when you are using either the EC2 or Fargate launch types. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers cannot mount directories on a different drive, and mount point cannot be across drives. For example, you can mount C:\\my\\path:C:\\my\\path and D:\\:D:\\, but not D:\\my\\path:C:\\my\\path or D:\\:C:\\my\\path.

" + }, + "dockerVolumeConfiguration":{ + "shape":"DockerVolumeConfiguration", + "documentation":"

This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the local driver. To use bind mounts, specify a host instead.

" + } + }, + "documentation":"

A data volume used in a task definition. For tasks that use a Docker volume, specify a DockerVolumeConfiguration. For tasks that use a bind mount host volume, specify a host and optional sourcePath. For more information, see Using Data Volumes in Tasks.

" + }, + "VolumeFrom":{ + "type":"structure", + "members":{ + "sourceContainer":{ + "shape":"String", + "documentation":"

The name of another container within the same task definition from which to mount volumes.

" + }, + "readOnly":{ + "shape":"BoxedBoolean", + "documentation":"

If this value is true, the container has read-only access to the volume. If this value is false, then the container can write to the volume. The default value is false.

" + } + }, + "documentation":"

Details on a data volume from another container in the same task definition.

" + }, + "VolumeFromList":{ + "type":"list", + "member":{"shape":"VolumeFrom"} + }, + "VolumeList":{ + "type":"list", + "member":{"shape":"Volume"} + } + }, + "documentation":"Amazon Elastic Container Service

Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types.

Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.

You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.

" +} diff --git a/aws/dist/botocore/data/ecs/2014-11-13/waiters-2.json b/aws/dist/botocore/data/ecs/2014-11-13/waiters-2.json new file mode 100644 index 00000000..8a0b19d8 --- /dev/null +++ b/aws/dist/botocore/data/ecs/2014-11-13/waiters-2.json @@ -0,0 +1,93 @@ +{ + "version": 2, + "waiters": { + "TasksRunning": { + "delay": 6, + "operation": "DescribeTasks", + "maxAttempts": 100, + "acceptors": [ + { + "expected": "STOPPED", + "matcher": "pathAny", + "state": "failure", + "argument": "tasks[].lastStatus" + }, + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "RUNNING", + "matcher": "pathAll", + "state": "success", + "argument": "tasks[].lastStatus" + } + ] + }, + "TasksStopped": { + "delay": 6, + "operation": "DescribeTasks", + "maxAttempts": 100, + "acceptors": [ + { + "expected": "STOPPED", + "matcher": "pathAll", + "state": "success", + "argument": "tasks[].lastStatus" + } + ] + }, + "ServicesStable": { + "delay": 15, + "operation": "DescribeServices", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "DRAINING", + "matcher": "pathAny", + "state": "failure", + "argument": "services[].status" + }, + { + "expected": "INACTIVE", + "matcher": "pathAny", + "state": "failure", + "argument": "services[].status" + }, + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`" + } + ] + }, + "ServicesInactive": { + "delay": 15, + "operation": "DescribeServices", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "MISSING", + "matcher": "pathAny", + "state": "failure", + "argument": "failures[].reason" + }, + { + "expected": "INACTIVE", + "matcher": "pathAny", + "state": "success", + "argument": "services[].status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/efs/2015-02-01/examples-1.json b/aws/dist/botocore/data/efs/2015-02-01/examples-1.json new file mode 100644 index 00000000..4a4b982d --- /dev/null +++ b/aws/dist/botocore/data/efs/2015-02-01/examples-1.json @@ -0,0 +1,222 @@ +{ + "version": "1.0", + "examples": { + "CreateFileSystem": [ + { + "input": { + "CreationToken": "tokenstring", + "PerformanceMode": "generalPurpose" + }, + "output": { + "CreationTime": "1481841524.0", + "CreationToken": "tokenstring", + "FileSystemId": "fs-01234567", + "LifeCycleState": "creating", + "NumberOfMountTargets": 0, + "OwnerId": "012345678912", + "PerformanceMode": "generalPurpose", + "SizeInBytes": { + "Value": 0 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a new file system with the default generalpurpose performance mode.", + "id": "to-create-a-new-file-system-1481840798547", + "title": "To create a new file system" + } + ], + "CreateMountTarget": [ + { + "input": { + "FileSystemId": "fs-01234567", + "SubnetId": "subnet-1234abcd" + }, + "output": { + "FileSystemId": "fs-01234567", + "IpAddress": "192.0.0.2", + "LifeCycleState": "creating", + "MountTargetId": "fsmt-12340abc", + "NetworkInterfaceId": "eni-cedf6789", + "OwnerId": "012345678912", + "SubnetId": "subnet-1234abcd" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a new mount target for an EFS file system.", + "id": "to-create-a-new-mount-target-1481842289329", + "title": "To create a new mount target" + } + ], + "CreateTags": [ + { + "input": { + "FileSystemId": "fs-01234567", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation creates a new tag for an EFS file system.", + "id": "to-create-a-new-tag-1481843409357", + "title": "To create a new tag" + } + ], + "DeleteFileSystem": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "comments": { + }, + "description": "This operation deletes an EFS file system.", + "id": "to-delete-a-file-system-1481847318348", + "title": "To delete a file system" + } + ], + "DeleteMountTarget": [ + { + "input": { + "MountTargetId": "fsmt-12340abc" + }, + "comments": { + }, + "description": "This operation deletes a mount target.", + "id": "to-delete-a-mount-target-1481847635607", + "title": "To delete a mount target" + } + ], + "DeleteTags": [ + { + "input": { + "FileSystemId": "fs-01234567", + "TagKeys": [ + "Name" + ] + }, + "comments": { + }, + "description": "This operation deletes tags for an EFS file system.", + "id": "to-delete-tags-for-an-efs-file-system-1481848189061", + "title": "To delete tags for an EFS file system" + } + ], + "DescribeFileSystems": [ + { + "input": { + }, + "output": { + "FileSystems": [ + { + "CreationTime": "1481841524.0", + "CreationToken": "tokenstring", + "FileSystemId": "fs-01234567", + "LifeCycleState": "available", + "Name": "MyFileSystem", + "NumberOfMountTargets": 1, + "OwnerId": "012345678912", + "PerformanceMode": "generalPurpose", + "SizeInBytes": { + "Value": 6144 + } + } + ] + }, + "comments": { + }, + "description": "This operation describes all of the EFS file systems in an account.", + "id": "to-describe-an-efs-file-system-1481848448460", + "title": "To describe an EFS file system" + } + ], + "DescribeMountTargetSecurityGroups": [ + { + "input": { + "MountTargetId": "fsmt-12340abc" + }, + "output": { + "SecurityGroups": [ + "sg-fghi4567" + ] + }, + "comments": { + }, + "description": "This operation describes all of the security groups for a file system's mount target.", + "id": "to-describe-the-security-groups-for-a-mount-target-1481849317823", + "title": "To describe the security groups for a mount target" + } + ], + "DescribeMountTargets": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "MountTargets": [ + { + "FileSystemId": "fs-01234567", + "IpAddress": "192.0.0.2", + "LifeCycleState": "available", + "MountTargetId": "fsmt-12340abc", + "NetworkInterfaceId": "eni-cedf6789", + "OwnerId": "012345678912", + "SubnetId": "subnet-1234abcd" + } + ] + }, + "comments": { + }, + "description": "This operation describes all of a file system's mount targets.", + "id": "to-describe-the-mount-targets-for-a-file-system-1481849958584", + "title": "To describe the mount targets for a file system" + } + ], + "DescribeTags": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] + }, + "comments": { + }, + "description": "This operation describes all of a file system's tags.", + "id": "to-describe-the-tags-for-a-file-system-1481850497090", + "title": "To describe the tags for a file system" + } + ], + "ModifyMountTargetSecurityGroups": [ + { + "input": { + "MountTargetId": "fsmt-12340abc", + "SecurityGroups": [ + "sg-abcd1234" + ] + }, + "comments": { + }, + "description": "This operation modifies the security groups associated with a mount target for a file system.", + "id": "to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562", + "title": "To modify the security groups associated with a mount target for a file system" + } + ] + } +} diff --git a/aws/dist/botocore/data/efs/2015-02-01/paginators-1.json b/aws/dist/botocore/data/efs/2015-02-01/paginators-1.json new file mode 100644 index 00000000..e8ed53f7 --- /dev/null +++ b/aws/dist/botocore/data/efs/2015-02-01/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeFileSystems": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "FileSystems" + }, + "DescribeMountTargets": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "MountTargets" + }, + "DescribeTags": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/efs/2015-02-01/service-2.json b/aws/dist/botocore/data/efs/2015-02-01/service-2.json new file mode 100644 index 00000000..ea335aa3 --- /dev/null +++ b/aws/dist/botocore/data/efs/2015-02-01/service-2.json @@ -0,0 +1,1138 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-02-01", + "endpointPrefix":"elasticfilesystem", + "protocol":"rest-json", + "serviceAbbreviation":"EFS", + "serviceFullName":"Amazon Elastic File System", + "serviceId":"EFS", + "signatureVersion":"v4", + "uid":"elasticfilesystem-2015-02-01" + }, + "operations":{ + "CreateFileSystem":{ + "name":"CreateFileSystem", + "http":{ + "method":"POST", + "requestUri":"/2015-02-01/file-systems", + "responseCode":201 + }, + "input":{"shape":"CreateFileSystemRequest"}, + "output":{"shape":"FileSystemDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemAlreadyExists"}, + {"shape":"FileSystemLimitExceeded"}, + {"shape":"InsufficientThroughputCapacity"}, + {"shape":"ThroughputLimitExceeded"} + ], + "documentation":"

Creates a new, empty file system. The operation requires a creation token in the request that Amazon EFS uses to ensure idempotent creation (calling the operation with same creation token has no effect). If a file system does not currently exist that is owned by the caller's AWS account with the specified creation token, this operation does the following:

  • Creates a new, empty file system. The file system will have an Amazon EFS assigned ID, and an initial lifecycle state creating.

  • Returns with the description of the created file system.

Otherwise, this operation returns a FileSystemAlreadyExists error with the ID of the existing file system.

For basic use cases, you can use a randomly generated UUID for the creation token.

The idempotent operation allows you to retry a CreateFileSystem call without risk of creating an extra file system. This can happen when an initial call fails in a way that leaves it uncertain whether or not a file system was actually created. An example might be that a transport level timeout occurred or your connection was reset. As long as you use the same creation token, if the initial call had succeeded in creating a file system, the client can learn of its existence from the FileSystemAlreadyExists error.

The CreateFileSystem call returns while the file system's lifecycle state is still creating. You can check the file system creation status by calling the DescribeFileSystems operation, which among other things returns the file system state.

This operation also takes an optional PerformanceMode parameter that you choose for your file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. For more information, see Amazon EFS: Performance Modes.

After the file system is fully created, Amazon EFS sets its lifecycle state to available, at which point you can create one or more mount targets for the file system in your VPC. For more information, see CreateMountTarget. You mount your Amazon EFS file system on an EC2 instances in your VPC by using the mount target. For more information, see Amazon EFS: How it Works.

This operation requires permissions for the elasticfilesystem:CreateFileSystem action.

" + }, + "CreateMountTarget":{ + "name":"CreateMountTarget", + "http":{ + "method":"POST", + "requestUri":"/2015-02-01/mount-targets", + "responseCode":200 + }, + "input":{"shape":"CreateMountTargetRequest"}, + "output":{"shape":"MountTargetDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncorrectFileSystemLifeCycleState"}, + {"shape":"MountTargetConflict"}, + {"shape":"SubnetNotFound"}, + {"shape":"NoFreeAddressesInSubnet"}, + {"shape":"IpAddressInUse"}, + {"shape":"NetworkInterfaceLimitExceeded"}, + {"shape":"SecurityGroupLimitExceeded"}, + {"shape":"SecurityGroupNotFound"}, + {"shape":"UnsupportedAvailabilityZone"} + ], + "documentation":"

Creates a mount target for a file system. You can then mount the file system on EC2 instances by using the mount target.

You can create one mount target in each Availability Zone in your VPC. All EC2 instances in a VPC within a given Availability Zone share a single mount target for a given file system. If you have multiple subnets in an Availability Zone, you create a mount target in one of the subnets. EC2 instances do not need to be in the same subnet as the mount target in order to access their file system. For more information, see Amazon EFS: How it Works.

In the request, you also specify a file system ID for which you are creating the mount target and the file system's lifecycle state must be available. For more information, see DescribeFileSystems.

In the request, you also provide a subnet ID, which determines the following:

  • VPC in which Amazon EFS creates the mount target

  • Availability Zone in which Amazon EFS creates the mount target

  • IP address range from which Amazon EFS selects the IP address of the mount target (if you don't specify an IP address in the request)

After creating the mount target, Amazon EFS returns a response that includes, a MountTargetId and an IpAddress. You use this IP address when mounting the file system in an EC2 instance. You can also use the mount target's DNS name when mounting the file system. The EC2 instance on which you mount the file system by using the mount target can resolve the mount target's DNS name to its IP address. For more information, see How it Works: Implementation Overview.

Note that you can create mount targets for a file system in only one VPC, and there can be only one mount target per Availability Zone. That is, if the file system already has one or more mount targets created for it, the subnet specified in the request to add another mount target must meet the following requirements:

  • Must belong to the same VPC as the subnets of the existing mount targets

  • Must not be in the same Availability Zone as any of the subnets of the existing mount targets

If the request satisfies the requirements, Amazon EFS does the following:

  • Creates a new mount target in the specified subnet.

  • Also creates a new network interface in the subnet as follows:

    • If the request provides an IpAddress, Amazon EFS assigns that IP address to the network interface. Otherwise, Amazon EFS assigns a free address in the subnet (in the same way that the Amazon EC2 CreateNetworkInterface call does when a request does not specify a primary private IP address).

    • If the request provides SecurityGroups, this network interface is associated with those security groups. Otherwise, it belongs to the default security group for the subnet's VPC.

    • Assigns the description Mount target fsmt-id for file system fs-id where fsmt-id is the mount target ID, and fs-id is the FileSystemId.

    • Sets the requesterManaged property of the network interface to true, and the requesterId value to EFS.

    Each Amazon EFS mount target has one corresponding requester-managed EC2 network interface. After the network interface is created, Amazon EFS sets the NetworkInterfaceId field in the mount target's description to the network interface ID, and the IpAddress field to its address. If network interface creation fails, the entire CreateMountTarget operation fails.

The CreateMountTarget call returns only after creating the network interface, but while the mount target state is still creating, you can check the mount target creation status by calling the DescribeMountTargets operation, which among other things returns the mount target state.

We recommend that you create a mount target in each of the Availability Zones. There are cost considerations for using a file system in an Availability Zone through a mount target created in another Availability Zone. For more information, see Amazon EFS. In addition, by always using a mount target local to the instance's Availability Zone, you eliminate a partial failure scenario. If the Availability Zone in which your mount target is created goes down, then you can't access your file system through that mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:CreateMountTarget

This operation also requires permissions for the following Amazon EC2 actions:

  • ec2:DescribeSubnets

  • ec2:DescribeNetworkInterfaces

  • ec2:CreateNetworkInterface

" + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/2015-02-01/create-tags/{FileSystemId}", + "responseCode":204 + }, + "input":{"shape":"CreateTagsRequest"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"} + ], + "documentation":"

Creates or overwrites tags associated with a file system. Each tag is a key-value pair. If a tag key specified in the request already exists on the file system, this operation overwrites its value with the value provided in the request. If you add the Name tag to your file system, Amazon EFS returns it in the response to the DescribeFileSystems operation.

This operation requires permission for the elasticfilesystem:CreateTags action.

" + }, + "DeleteFileSystem":{ + "name":"DeleteFileSystem", + "http":{ + "method":"DELETE", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}", + "responseCode":204 + }, + "input":{"shape":"DeleteFileSystemRequest"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"FileSystemInUse"} + ], + "documentation":"

Deletes a file system, permanently severing access to its contents. Upon return, the file system no longer exists and you can't access any contents of the deleted file system.

You can't delete a file system that is in use. That is, if the file system has any mount targets, you must first delete them. For more information, see DescribeMountTargets and DeleteMountTarget.

The DeleteFileSystem call returns while the file system state is still deleting. You can check the file system deletion status by calling the DescribeFileSystems operation, which returns a list of file systems in your account. If you pass file system ID or creation token for the deleted file system, the DescribeFileSystems returns a 404 FileSystemNotFound error.

This operation requires permissions for the elasticfilesystem:DeleteFileSystem action.

" + }, + "DeleteMountTarget":{ + "name":"DeleteMountTarget", + "http":{ + "method":"DELETE", + "requestUri":"/2015-02-01/mount-targets/{MountTargetId}", + "responseCode":204 + }, + "input":{"shape":"DeleteMountTargetRequest"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"DependencyTimeout"}, + {"shape":"MountTargetNotFound"} + ], + "documentation":"

Deletes the specified mount target.

This operation forcibly breaks any mounts of the file system by using the mount target that is being deleted, which might disrupt instances or applications using those mounts. To avoid applications getting cut off abruptly, you might consider unmounting any mounts of the mount target, if feasible. The operation also deletes the associated network interface. Uncommitted writes might be lost, but breaking a mount target using this operation does not corrupt the file system itself. The file system you created remains. You can mount an EC2 instance in your VPC by using another mount target.

This operation requires permissions for the following action on the file system:

  • elasticfilesystem:DeleteMountTarget

The DeleteMountTarget call returns while the mount target state is still deleting. You can check the mount target deletion by calling the DescribeMountTargets operation, which returns a list of mount target descriptions for the given file system.

The operation also requires permissions for the following Amazon EC2 action on the mount target's network interface:

  • ec2:DeleteNetworkInterface

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/2015-02-01/delete-tags/{FileSystemId}", + "responseCode":204 + }, + "input":{"shape":"DeleteTagsRequest"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"} + ], + "documentation":"

Deletes the specified tags from a file system. If the DeleteTags request includes a tag key that doesn't exist, Amazon EFS ignores it and doesn't cause an error. For more information about tags and related restrictions, see Tag Restrictions in the AWS Billing and Cost Management User Guide.

This operation requires permissions for the elasticfilesystem:DeleteTags action.

" + }, + "DescribeFileSystems":{ + "name":"DescribeFileSystems", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/file-systems", + "responseCode":200 + }, + "input":{"shape":"DescribeFileSystemsRequest"}, + "output":{"shape":"DescribeFileSystemsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"} + ], + "documentation":"

Returns the description of a specific Amazon EFS file system if either the file system CreationToken or the FileSystemId is provided. Otherwise, it returns descriptions of all file systems owned by the caller's AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxItems parameter to limit the number of descriptions in a response. Currently, this number is automatically set to 10. If more file system descriptions remain, Amazon EFS returns a NextMarker, an opaque token, in the response. In this case, you should send a subsequent request with the Marker request parameter set to the value of NextMarker.

To retrieve a list of your file system descriptions, this operation is used in an iterative process, where DescribeFileSystems is called first without the Marker and then the operation continues to call it with the Marker parameter set to the value of the NextMarker from the previous response until the response has no NextMarker.

The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multi-call iteration is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeFileSystems action.

" + }, + "DescribeLifecycleConfiguration":{ + "name":"DescribeLifecycleConfiguration", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration", + "responseCode":200 + }, + "input":{"shape":"DescribeLifecycleConfigurationRequest"}, + "output":{"shape":"LifecycleConfigurationDescription"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"} + ], + "documentation":"

Returns the current LifecycleConfiguration object for the specified Amazon EFS file system. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. For a file system without a LifecycleConfiguration object, the call returns an empty array in the response.

This operation requires permissions for the elasticfilesystem:DescribeLifecycleConfiguration operation.

" + }, + "DescribeMountTargetSecurityGroups":{ + "name":"DescribeMountTargetSecurityGroups", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", + "responseCode":200 + }, + "input":{"shape":"DescribeMountTargetSecurityGroupsRequest"}, + "output":{"shape":"DescribeMountTargetSecurityGroupsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"MountTargetNotFound"}, + {"shape":"IncorrectMountTargetState"} + ], + "documentation":"

Returns the security groups currently in effect for a mount target. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

This operation requires permissions for the following actions:

  • elasticfilesystem:DescribeMountTargetSecurityGroups action on the mount target's file system.

  • ec2:DescribeNetworkInterfaceAttribute action on the mount target's network interface.

" + }, + "DescribeMountTargets":{ + "name":"DescribeMountTargets", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/mount-targets", + "responseCode":200 + }, + "input":{"shape":"DescribeMountTargetsRequest"}, + "output":{"shape":"DescribeMountTargetsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"MountTargetNotFound"} + ], + "documentation":"

Returns the descriptions of all the current mount targets, or a specific mount target, for a file system. When requesting all of the current mount targets, the order of mount targets returned in the response is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeMountTargets action, on either the file system ID that you specify in FileSystemId, or on the file system of the mount target that you specify in MountTargetId.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/tags/{FileSystemId}/", + "responseCode":200 + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"} + ], + "documentation":"

Returns the tags associated with a file system. The order of tags returned in the response of one DescribeTags call and the order of tags returned across the responses of a multiple-call iteration (when using pagination) is unspecified.

This operation requires permissions for the elasticfilesystem:DescribeTags action.

" + }, + "ModifyMountTargetSecurityGroups":{ + "name":"ModifyMountTargetSecurityGroups", + "http":{ + "method":"PUT", + "requestUri":"/2015-02-01/mount-targets/{MountTargetId}/security-groups", + "responseCode":204 + }, + "input":{"shape":"ModifyMountTargetSecurityGroupsRequest"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"MountTargetNotFound"}, + {"shape":"IncorrectMountTargetState"}, + {"shape":"SecurityGroupLimitExceeded"}, + {"shape":"SecurityGroupNotFound"} + ], + "documentation":"

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

The operation requires permissions for the following actions:

  • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

  • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

" + }, + "PutLifecycleConfiguration":{ + "name":"PutLifecycleConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}/lifecycle-configuration", + "responseCode":200 + }, + "input":{"shape":"PutLifecycleConfigurationRequest"}, + "output":{"shape":"LifecycleConfigurationDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncorrectFileSystemLifeCycleState"} + ], + "documentation":"

Enables lifecycle management by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.

Each Amazon EFS file system supports one lifecycle configuration, which applies to all files in the file system. If a LifecycleConfiguration object already exists for the specified file system, a PutLifecycleConfiguration call modifies the existing configuration. A PutLifecycleConfiguration call with an empty LifecyclePolicies array in the request body deletes any existing LifecycleConfiguration and disables lifecycle management.

In the request, specify the following:

  • The ID for the file system for which you are enabling, disabling, or modifying lifecycle management.

  • A LifecyclePolicies array of LifecyclePolicy objects that define when files are moved to the IA storage class. The array can contain only one LifecyclePolicy item.

This operation requires permissions for the elasticfilesystem:PutLifecycleConfiguration operation.

To apply a LifecycleConfiguration object to an encrypted file system, you need the same AWS Key Management Service (AWS KMS) permissions as when you created the encrypted file system.

" + }, + "UpdateFileSystem":{ + "name":"UpdateFileSystem", + "http":{ + "method":"PUT", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}", + "responseCode":202 + }, + "input":{"shape":"UpdateFileSystemRequest"}, + "output":{"shape":"FileSystemDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncorrectFileSystemLifeCycleState"}, + {"shape":"InsufficientThroughputCapacity"}, + {"shape":"InternalServerError"}, + {"shape":"ThroughputLimitExceeded"}, + {"shape":"TooManyRequests"} + ], + "documentation":"

Updates the throughput mode or the amount of provisioned throughput of an existing file system.

" + } + }, + "shapes":{ + "AwsAccountId":{"type":"string"}, + "BadRequest":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateFileSystemRequest":{ + "type":"structure", + "required":["CreationToken"], + "members":{ + "CreationToken":{ + "shape":"CreationToken", + "documentation":"

A string of up to 64 ASCII characters. Amazon EFS uses this to ensure idempotent creation.

" + }, + "PerformanceMode":{ + "shape":"PerformanceMode", + "documentation":"

The performance mode of the file system. We recommend generalPurpose performance mode for most file systems. File systems using the maxIO performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created.

" + }, + "Encrypted":{ + "shape":"Encrypted", + "documentation":"

A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying CreateFileSystemRequest$KmsKeyId for an existing AWS Key Management Service (AWS KMS) customer master key (CMK). If you don't specify a CMK, then the default CMK for Amazon EFS, /aws/elasticfilesystem, is used to protect the encrypted file system.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of the AWS KMS CMK to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault CMK. If this parameter is not specified, the default CMK for Amazon EFS is used. This ID can be in one of the following formats:

  • Key ID - A unique identifier of the key, for example 1234abcd-12ab-34cd-56ef-1234567890ab.

  • ARN - An Amazon Resource Name (ARN) for the key, for example arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.

  • Key alias - A previously created display name for a key, for example alias/projectKey1.

  • Key alias ARN - An ARN for a key alias, for example arn:aws:kms:us-west-2:444455556666:alias/projectKey1.

If KmsKeyId is specified, the CreateFileSystemRequest$Encrypted parameter must be set to true.

" + }, + "ThroughputMode":{ + "shape":"ThroughputMode", + "documentation":"

The throughput mode for the file system to be created. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change. For more, see Specifying Throughput with Provisioned Mode in the Amazon EFS User Guide.

" + }, + "ProvisionedThroughputInMibps":{ + "shape":"ProvisionedThroughputInMibps", + "documentation":"

The throughput, measured in MiB/s, that you want to provision for a file system that you're creating. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The upper limit for throughput is 1024 MiB/s. You can get this limit increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A value that specifies to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a \"Key\":\"Name\",\"Value\":\"{value}\" key-value pair.

" + } + } + }, + "CreateMountTargetRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "SubnetId" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system for which to create the mount target.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet to add the mount target in.

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

Valid IPv4 address within the address range of the specified subnet.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

Up to five VPC security group IDs, of the form sg-xxxxxxxx. These must be for the same VPC as subnet specified.

" + } + }, + "documentation":"

" + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "Tags" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system whose tags you want to modify (String). This operation modifies the tags only, not the file system.

", + "location":"uri", + "locationName":"FileSystemId" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

An array of Tag objects to add. Each Tag object is a key-value pair.

" + } + }, + "documentation":"

" + }, + "CreationToken":{ + "type":"string", + "max":64, + "min":1 + }, + "DeleteFileSystemRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system you want to delete.

", + "location":"uri", + "locationName":"FileSystemId" + } + }, + "documentation":"

" + }, + "DeleteMountTargetRequest":{ + "type":"structure", + "required":["MountTargetId"], + "members":{ + "MountTargetId":{ + "shape":"MountTargetId", + "documentation":"

The ID of the mount target to delete (String).

", + "location":"uri", + "locationName":"MountTargetId" + } + }, + "documentation":"

" + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "TagKeys" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system whose tags you want to delete (String).

", + "location":"uri", + "locationName":"FileSystemId" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of tag keys to delete.

" + } + }, + "documentation":"

" + }, + "DependencyTimeout":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service timed out trying to fulfill the request, and the client should try the call again.

", + "error":{"httpStatusCode":504}, + "exception":true + }, + "DescribeFileSystemsRequest":{ + "type":"structure", + "members":{ + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

(Optional) Specifies the maximum number of file systems to return in the response (integer). Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 file systems.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If present, specifies to continue the list from where the returning call had left off.

", + "location":"querystring", + "locationName":"Marker" + }, + "CreationToken":{ + "shape":"CreationToken", + "documentation":"

(Optional) Restricts the list to the file system with this creation token (String). You specify a creation token when you create an Amazon EFS file system.

", + "location":"querystring", + "locationName":"CreationToken" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

(Optional) ID of the file system whose description you want to retrieve (String).

", + "location":"querystring", + "locationName":"FileSystemId" + } + }, + "documentation":"

" + }, + "DescribeFileSystemsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

Present if provided by caller in the request (String).

" + }, + "FileSystems":{ + "shape":"FileSystemDescriptions", + "documentation":"

An array of file system descriptions.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

Present if there are more file systems than returned in the response (String). You can use the NextMarker in the subsequent request to fetch the descriptions.

" + } + } + }, + "DescribeLifecycleConfigurationRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system whose LifecycleConfiguration object you want to retrieve (String).

", + "location":"uri", + "locationName":"FileSystemId" + } + } + }, + "DescribeMountTargetSecurityGroupsRequest":{ + "type":"structure", + "required":["MountTargetId"], + "members":{ + "MountTargetId":{ + "shape":"MountTargetId", + "documentation":"

The ID of the mount target whose security groups you want to retrieve.

", + "location":"uri", + "locationName":"MountTargetId" + } + }, + "documentation":"

" + }, + "DescribeMountTargetSecurityGroupsResponse":{ + "type":"structure", + "required":["SecurityGroups"], + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

An array of security groups.

" + } + } + }, + "DescribeMountTargetsRequest":{ + "type":"structure", + "members":{ + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

(Optional) Maximum number of mount targets to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 mount targets.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeMountTargets operation (String). If present, it specifies to continue the list from where the previous returning call left off.

", + "location":"querystring", + "locationName":"Marker" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

(Optional) ID of the file system whose mount targets you want to list (String). It must be included in your request if MountTargetId is not included.

", + "location":"querystring", + "locationName":"FileSystemId" + }, + "MountTargetId":{ + "shape":"MountTargetId", + "documentation":"

(Optional) ID of the mount target that you want to have described (String). It must be included in your request if FileSystemId is not included.

", + "location":"querystring", + "locationName":"MountTargetId" + } + }, + "documentation":"

" + }, + "DescribeMountTargetsResponse":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

If the request included the Marker, the response returns that value in this field.

" + }, + "MountTargets":{ + "shape":"MountTargetDescriptions", + "documentation":"

Returns the file system's mount targets as an array of MountTargetDescription objects.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If a value is present, there are more mount targets to return. In a subsequent request, you can provide Marker in your request with this value to retrieve the next set of mount targets.

" + } + }, + "documentation":"

" + }, + "DescribeTagsRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

(Optional) The maximum number of file system tags to return in the response. Currently, this number is automatically set to 10, and other values are ignored. The response is paginated at 10 per page if you have more than 10 tags.

", + "location":"querystring", + "locationName":"MaxItems" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

(Optional) An opaque pagination token returned from a previous DescribeTags operation (String). If present, it specifies to continue the list from where the previous call left off.

", + "location":"querystring", + "locationName":"Marker" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system whose tag set you want to retrieve.

", + "location":"uri", + "locationName":"FileSystemId" + } + }, + "documentation":"

" + }, + "DescribeTagsResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

If the request included a Marker, the response returns that value in this field.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Returns tags associated with the file system as an array of Tag objects.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If a value is present, there are more tags to return. In a subsequent request, you can provide the value of NextMarker as the value of the Marker parameter in your next request to retrieve the next set of tags.

" + } + }, + "documentation":"

" + }, + "Encrypted":{"type":"boolean"}, + "ErrorCode":{ + "type":"string", + "min":1 + }, + "ErrorMessage":{"type":"string"}, + "FileSystemAlreadyExists":{ + "type":"structure", + "required":[ + "ErrorCode", + "FileSystemId" + ], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"}, + "FileSystemId":{"shape":"FileSystemId"} + }, + "documentation":"

Returned if the file system you are trying to create already exists, with the creation token you provided.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FileSystemDescription":{ + "type":"structure", + "required":[ + "OwnerId", + "CreationToken", + "FileSystemId", + "CreationTime", + "LifeCycleState", + "NumberOfMountTargets", + "SizeInBytes", + "PerformanceMode", + "Tags" + ], + "members":{ + "OwnerId":{ + "shape":"AwsAccountId", + "documentation":"

The AWS account that created the file system. If the file system was created by an IAM user, the parent account to which the user belongs is the owner.

" + }, + "CreationToken":{ + "shape":"CreationToken", + "documentation":"

The opaque string specified in the request.

" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system, assigned by Amazon EFS.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

" + }, + "LifeCycleState":{ + "shape":"LifeCycleState", + "documentation":"

The lifecycle phase of the file system.

" + }, + "Name":{ + "shape":"TagValue", + "documentation":"

You can add tags to a file system, including a Name tag. For more information, see CreateFileSystem. If the file system has a Name tag, Amazon EFS returns the value in this field.

" + }, + "NumberOfMountTargets":{ + "shape":"MountTargetCount", + "documentation":"

The current number of mount targets that the file system has. For more information, see CreateMountTarget.

" + }, + "SizeInBytes":{ + "shape":"FileSystemSize", + "documentation":"

The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The Timestamp value is the integer number of seconds since 1970-01-01T00:00:00Z. The SizeInBytes value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, SizeInBytes represents actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not the exact size that the file system was at any point in time.

" + }, + "PerformanceMode":{ + "shape":"PerformanceMode", + "documentation":"

The performance mode of the file system.

" + }, + "Encrypted":{ + "shape":"Encrypted", + "documentation":"

A Boolean value that, if true, indicates that the file system is encrypted.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of an AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the encrypted file system.

" + }, + "ThroughputMode":{ + "shape":"ThroughputMode", + "documentation":"

The throughput mode for a file system. There are two throughput modes to choose from for your file system: bursting and provisioned. If you set ThroughputMode to provisioned, you must also set a value for ProvisionedThroughPutInMibps. You can decrease your file system's throughput in Provisioned Throughput mode or change between the throughput modes as long as it’s been more than 24 hours since the last decrease or throughput mode change.

" + }, + "ProvisionedThroughputInMibps":{ + "shape":"ProvisionedThroughputInMibps", + "documentation":"

The throughput, measured in MiB/s, that you want to provision for a file system. Valid values are 1-1024. Required if ThroughputMode is set to provisioned. The limit on throughput is 1024 MiB/s. You can get these limits increased by contacting AWS Support. For more information, see Amazon EFS Limits That You Can Increase in the Amazon EFS User Guide.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags associated with the file system, presented as an array of Tag objects.

" + } + }, + "documentation":"

A description of the file system.

" + }, + "FileSystemDescriptions":{ + "type":"list", + "member":{"shape":"FileSystemDescription"} + }, + "FileSystemId":{"type":"string"}, + "FileSystemInUse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if a file system has mount targets.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "FileSystemLimitExceeded":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the AWS account has already created the maximum number of file systems allowed per account.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "FileSystemNotFound":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the specified FileSystemId value doesn't exist in the requester's AWS account.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "FileSystemNullableSizeValue":{ + "type":"long", + "min":0 + }, + "FileSystemSize":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{ + "shape":"FileSystemSizeValue", + "documentation":"

The latest known metered size (in bytes) of data stored in the file system.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The time at which the size of data, returned in the Value field, was determined. The value is the integer number of seconds since 1970-01-01T00:00:00Z.

" + }, + "ValueInIA":{ + "shape":"FileSystemNullableSizeValue", + "documentation":"

The latest known metered size (in bytes) of data stored in the Infrequent Access storage class.

" + }, + "ValueInStandard":{ + "shape":"FileSystemNullableSizeValue", + "documentation":"

The latest known metered size (in bytes) of data stored in the Standard storage class.

" + } + }, + "documentation":"

The latest known metered size (in bytes) of data stored in the file system, in its Value field, and the time at which that size was determined in its Timestamp field. The value doesn't represent the size of a consistent snapshot of the file system, but it is eventually consistent when there are no writes to the file system. That is, the value represents the actual size only if the file system is not modified for a period longer than a couple of hours. Otherwise, the value is not necessarily the exact size the file system was at any instant in time.

" + }, + "FileSystemSizeValue":{ + "type":"long", + "min":0 + }, + "IncorrectFileSystemLifeCycleState":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the file system's lifecycle state is not \"available\".

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "IncorrectMountTargetState":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the mount target is not in the correct state for the operation.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "InsufficientThroughputCapacity":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if there's not enough capacity to provision additional throughput. This value might be returned when you try to create a file system in provisioned throughput mode, when you attempt to increase the provisioned throughput of an existing file system, or when you attempt to change an existing file system from bursting to provisioned throughput mode.

", + "error":{"httpStatusCode":503}, + "exception":true + }, + "InternalServerError":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if an error occurred on the server side.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpAddressInUse":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the request specified an IpAddress that is already in use in the subnet.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":1 + }, + "LifeCycleState":{ + "type":"string", + "enum":[ + "creating", + "available", + "updating", + "deleting", + "deleted" + ] + }, + "LifecycleConfigurationDescription":{ + "type":"structure", + "members":{ + "LifecyclePolicies":{ + "shape":"LifecyclePolicies", + "documentation":"

An array of lifecycle management policies. Currently, EFS supports a maximum of one policy per file system.

" + } + } + }, + "LifecyclePolicies":{ + "type":"list", + "member":{"shape":"LifecyclePolicy"} + }, + "LifecyclePolicy":{ + "type":"structure", + "members":{ + "TransitionToIA":{ + "shape":"TransitionToIARules", + "documentation":"

A value that describes the period of time that a file is not accessed, after which it transitions to the IA storage class. Metadata operations such as listing the contents of a directory don't count as file access events.

" + } + }, + "documentation":"

Describes a policy used by EFS lifecycle management to transition files to the Infrequent Access (IA) storage class.

" + }, + "Marker":{"type":"string"}, + "MaxItems":{ + "type":"integer", + "min":1 + }, + "ModifyMountTargetSecurityGroupsRequest":{ + "type":"structure", + "required":["MountTargetId"], + "members":{ + "MountTargetId":{ + "shape":"MountTargetId", + "documentation":"

The ID of the mount target whose security groups you want to modify.

", + "location":"uri", + "locationName":"MountTargetId" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

An array of up to five VPC security group IDs.

" + } + }, + "documentation":"

" + }, + "MountTargetConflict":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the mount target would violate one of the specified restrictions based on the file system's existing mount targets.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "MountTargetCount":{ + "type":"integer", + "min":0 + }, + "MountTargetDescription":{ + "type":"structure", + "required":[ + "MountTargetId", + "FileSystemId", + "SubnetId", + "LifeCycleState" + ], + "members":{ + "OwnerId":{ + "shape":"AwsAccountId", + "documentation":"

AWS account ID that owns the resource.

" + }, + "MountTargetId":{ + "shape":"MountTargetId", + "documentation":"

System-assigned mount target ID.

" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system for which the mount target is intended.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the mount target's subnet.

" + }, + "LifeCycleState":{ + "shape":"LifeCycleState", + "documentation":"

Lifecycle state of the mount target.

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

Address at which the file system can be mounted by using the mount target.

" + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

The ID of the network interface that Amazon EFS created when it created the mount target.

" + } + }, + "documentation":"

Provides a description of a mount target.

" + }, + "MountTargetDescriptions":{ + "type":"list", + "member":{"shape":"MountTargetDescription"} + }, + "MountTargetId":{"type":"string"}, + "MountTargetNotFound":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if there is no mount target with the specified ID found in the caller's account.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NetworkInterfaceId":{"type":"string"}, + "NetworkInterfaceLimitExceeded":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The calling account has reached the limit for elastic network interfaces for the specific AWS Region. The client should try to delete some elastic network interfaces or get the account limit raised. For more information, see Amazon VPC Limits in the Amazon VPC User Guide (see the Network interfaces per VPC entry in the table).

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "NoFreeAddressesInSubnet":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if IpAddress was not specified in the request and there are no free IP addresses in the subnet.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "PerformanceMode":{ + "type":"string", + "enum":[ + "generalPurpose", + "maxIO" + ] + }, + "ProvisionedThroughputInMibps":{ + "type":"double", + "min":1.0 + }, + "PutLifecycleConfigurationRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "LifecyclePolicies" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system for which you are creating the LifecycleConfiguration object (String).

", + "location":"uri", + "locationName":"FileSystemId" + }, + "LifecyclePolicies":{ + "shape":"LifecyclePolicies", + "documentation":"

An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object tells lifecycle management when to transition files from the Standard storage class to the Infrequent Access storage class.

" + } + } + }, + "SecurityGroup":{"type":"string"}, + "SecurityGroupLimitExceeded":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the size of SecurityGroups specified in the request is greater than five.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SecurityGroupNotFound":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if one of the specified security groups doesn't exist in the subnet's VPC.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"}, + "max":5 + }, + "SubnetId":{"type":"string"}, + "SubnetNotFound":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if there is no subnet with ID SubnetId provided in the request.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The tag key (String). The key can't start with aws:.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag key.

" + } + }, + "documentation":"

A tag is a key-value pair. Allowed characters are letters, white space, and numbers that can be represented in UTF-8, and the following characters: + - = . _ : /

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "ThroughputLimitExceeded":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the throughput mode or amount of provisioned throughput can't be changed because the throughput limit of 1024 MiB/s has been reached.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ThroughputMode":{ + "type":"string", + "enum":[ + "bursting", + "provisioned" + ] + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequests":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if you don’t wait at least 24 hours before changing the throughput mode, or decreasing the Provisioned Throughput value.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TransitionToIARules":{ + "type":"string", + "enum":[ + "AFTER_7_DAYS", + "AFTER_14_DAYS", + "AFTER_30_DAYS", + "AFTER_60_DAYS", + "AFTER_90_DAYS" + ] + }, + "UnsupportedAvailabilityZone":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UpdateFileSystemRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system that you want to update.

", + "location":"uri", + "locationName":"FileSystemId" + }, + "ThroughputMode":{ + "shape":"ThroughputMode", + "documentation":"

(Optional) The throughput mode that you want your file system to use. If you're not updating your throughput mode, you don't need to provide this value in your request. If you are changing the ThroughputMode to provisioned, you must also set a value for ProvisionedThroughputInMibps.

" + }, + "ProvisionedThroughputInMibps":{ + "shape":"ProvisionedThroughputInMibps", + "documentation":"

(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.

" + } + } + } + }, + "documentation":"Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.

" +} diff --git a/aws/dist/botocore/data/eks/2017-11-01/paginators-1.json b/aws/dist/botocore/data/eks/2017-11-01/paginators-1.json new file mode 100644 index 00000000..10570b9d --- /dev/null +++ b/aws/dist/botocore/data/eks/2017-11-01/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListClusters": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "clusters" + }, + "ListUpdates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "updateIds" + } + } +} diff --git a/aws/dist/botocore/data/eks/2017-11-01/service-2.json b/aws/dist/botocore/data/eks/2017-11-01/service-2.json new file mode 100644 index 00000000..02c24a91 --- /dev/null +++ b/aws/dist/botocore/data/eks/2017-11-01/service-2.json @@ -0,0 +1,1006 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-01", + "endpointPrefix":"eks", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Amazon EKS", + "serviceFullName":"Amazon Elastic Kubernetes Service", + "serviceId":"EKS", + "signatureVersion":"v4", + "signingName":"eks", + "uid":"eks-2017-11-01" + }, + "operations":{ + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/clusters" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnsupportedAvailabilityZoneException"} + ], + "documentation":"

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

" + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"DELETE", + "requestUri":"/clusters/{name}" + }, + "input":{"shape":"DeleteClusterRequest"}, + "output":{"shape":"DeleteClusterResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.

" + }, + "DescribeCluster":{ + "name":"DescribeCluster", + "http":{ + "method":"GET", + "requestUri":"/clusters/{name}" + }, + "input":{"shape":"DescribeClusterRequest"}, + "output":{"shape":"DescribeClusterResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

" + }, + "DescribeUpdate":{ + "name":"DescribeUpdate", + "http":{ + "method":"GET", + "requestUri":"/clusters/{name}/updates/{updateId}" + }, + "input":{"shape":"DescribeUpdateRequest"}, + "output":{"shape":"DescribeUpdateResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"GET", + "requestUri":"/clusters" + }, + "input":{"shape":"ListClustersRequest"}, + "output":{"shape":"ListClustersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the Amazon EKS clusters in your AWS account in the specified Region.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

List the tags for an Amazon EKS resource.

" + }, + "ListUpdates":{ + "name":"ListUpdates", + "http":{ + "method":"GET", + "requestUri":"/clusters/{name}/updates" + }, + "input":{"shape":"ListUpdatesRequest"}, + "output":{"shape":"ListUpdatesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes specified tags from a resource.

" + }, + "UpdateClusterConfig":{ + "name":"UpdateClusterConfig", + "http":{ + "method":"POST", + "requestUri":"/clusters/{name}/update-config" + }, + "input":{"shape":"UpdateClusterConfigRequest"}, + "output":{"shape":"UpdateClusterConfigResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

" + }, + "UpdateClusterVersion":{ + "name":"UpdateClusterVersion", + "http":{ + "method":"POST", + "requestUri":"/clusters/{name}/updates" + }, + "input":{"shape":"UpdateClusterVersionRequest"}, + "output":{"shape":"UpdateClusterVersionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ClientException"}, + {"shape":"ServerException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

" + } + }, + "shapes":{ + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

This exception is thrown if the request contains a semantic error. The precise meaning will depend on the API, and will be documented in the error message.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BoxedBoolean":{ + "type":"boolean", + "box":true + }, + "Certificate":{ + "type":"structure", + "members":{ + "data":{ + "shape":"String", + "documentation":"

The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

" + } + }, + "documentation":"

An object representing the certificate-authority-data for your cluster.

" + }, + "ClientException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Cluster":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the cluster.

" + }, + "arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the cluster.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix epoch timestamp in seconds for when the cluster was created.

" + }, + "version":{ + "shape":"String", + "documentation":"

The Kubernetes server version for the cluster.

" + }, + "endpoint":{ + "shape":"String", + "documentation":"

The endpoint for your Kubernetes API server.

" + }, + "roleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

" + }, + "resourcesVpcConfig":{ + "shape":"VpcConfigResponse", + "documentation":"

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide.

" + }, + "logging":{ + "shape":"Logging", + "documentation":"

The logging configuration for your cluster.

" + }, + "identity":{ + "shape":"Identity", + "documentation":"

The identity provider information for the cluster.

" + }, + "status":{ + "shape":"ClusterStatus", + "documentation":"

The current status of the cluster.

" + }, + "certificateAuthority":{ + "shape":"Certificate", + "documentation":"

The certificate-authority-data for your cluster.

" + }, + "clientRequestToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

" + }, + "platformVersion":{ + "shape":"String", + "documentation":"

The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the Amazon EKS User Guide .

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

" + } + }, + "documentation":"

An object representing an Amazon EKS cluster.

" + }, + "ClusterName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[0-9A-Za-z][A-Za-z0-9\\-_]*" + }, + "ClusterStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED" + ] + }, + "CreateClusterRequest":{ + "type":"structure", + "required":[ + "name", + "roleArn", + "resourcesVpcConfig" + ], + "members":{ + "name":{ + "shape":"ClusterName", + "documentation":"

The unique name to give to your cluster.

" + }, + "version":{ + "shape":"String", + "documentation":"

The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

" + }, + "roleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

" + }, + "resourcesVpcConfig":{ + "shape":"VpcConfigRequest", + "documentation":"

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups, but we recommend that you use a dedicated security group for your cluster control plane.

" + }, + "logging":{ + "shape":"Logging", + "documentation":"

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

" + }, + "clientRequestToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

" + } + } + }, + "CreateClusterResponse":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"

The full description of your new cluster.

" + } + } + }, + "DeleteClusterRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the cluster to delete.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteClusterResponse":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"

The full description of the cluster to delete.

" + } + } + }, + "DescribeClusterRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the cluster to describe.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DescribeClusterResponse":{ + "type":"structure", + "members":{ + "cluster":{ + "shape":"Cluster", + "documentation":"

The full description of your specified cluster.

" + } + } + }, + "DescribeUpdateRequest":{ + "type":"structure", + "required":[ + "name", + "updateId" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the Amazon EKS cluster to update.

", + "location":"uri", + "locationName":"name" + }, + "updateId":{ + "shape":"String", + "documentation":"

The ID of the update to describe.

", + "location":"uri", + "locationName":"updateId" + } + } + }, + "DescribeUpdateResponse":{ + "type":"structure", + "members":{ + "update":{ + "shape":"Update", + "documentation":"

The full description of the specified update.

" + } + } + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "SubnetNotFound", + "SecurityGroupNotFound", + "EniLimitReached", + "IpNotAvailable", + "AccessDenied", + "OperationNotPermitted", + "VpcIdNotFound", + "Unknown" + ] + }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

A brief description of the error.

  • SubnetNotFound: We couldn't find one of the subnets associated with the cluster.

  • SecurityGroupNotFound: We couldn't find one of the security groups associated with the cluster.

  • EniLimitReached: You have reached the elastic network interface limit for your account.

  • IpNotAvailable: A subnet associated with the cluster doesn't have any free IP addresses.

  • AccessDenied: You don't have permissions to perform the specified operation.

  • OperationNotPermitted: The service role associated with the cluster doesn't have the required access permissions for Amazon EKS.

  • VpcIdNotFound: We couldn't find the VPC associated with the cluster.

" + }, + "errorMessage":{ + "shape":"String", + "documentation":"

A more complete description of the error.

" + }, + "resourceIds":{ + "shape":"StringList", + "documentation":"

An optional field that contains the resource IDs associated with the error.

" + } + }, + "documentation":"

An object representing an error when an asynchronous operation fails.

" + }, + "ErrorDetails":{ + "type":"list", + "member":{"shape":"ErrorDetail"} + }, + "Identity":{ + "type":"structure", + "members":{ + "oidc":{ + "shape":"OIDC", + "documentation":"

The OpenID Connect identity provider information for the cluster.

" + } + }, + "documentation":"

An object representing an identity provider for authentication credentials.

" + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

The specified parameter is invalid. Review the available parameters for the API request.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListClustersRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"ListClustersRequestMaxResults", + "documentation":"

The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListClustersRequestMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListClustersResponse":{ + "type":"structure", + "members":{ + "clusters":{ + "shape":"StringList", + "documentation":"

A list of all of the clusters for your account in the specified Region.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

The tags for the resource.

" + } + } + }, + "ListUpdatesRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the Amazon EKS cluster to list updates for.

", + "location":"uri", + "locationName":"name" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"ListUpdatesRequestMaxResults", + "documentation":"

The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListUpdatesRequestMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ListUpdatesResponse":{ + "type":"structure", + "members":{ + "updateIds":{ + "shape":"StringList", + "documentation":"

A list of all the updates for the specified cluster and Region.

" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "LogSetup":{ + "type":"structure", + "members":{ + "types":{ + "shape":"LogTypes", + "documentation":"

The available cluster control plane log types.

" + }, + "enabled":{ + "shape":"BoxedBoolean", + "documentation":"

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

" + } + }, + "documentation":"

An object representing the enabled or disabled Kubernetes control plane logs for your cluster.

" + }, + "LogSetups":{ + "type":"list", + "member":{"shape":"LogSetup"} + }, + "LogType":{ + "type":"string", + "enum":[ + "api", + "audit", + "authenticator", + "controllerManager", + "scheduler" + ] + }, + "LogTypes":{ + "type":"list", + "member":{"shape":"LogType"} + }, + "Logging":{ + "type":"structure", + "members":{ + "clusterLogging":{ + "shape":"LogSetups", + "documentation":"

The cluster control plane logging configuration for your cluster.

" + } + }, + "documentation":"

An object representing the logging configuration for resources in your cluster.

" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

A service resource associated with the request could not be found. Clients should not retry such requests.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "OIDC":{ + "type":"structure", + "members":{ + "issuer":{ + "shape":"String", + "documentation":"

The issuer URL for the OpenID Connect identity provider.

" + } + }, + "documentation":"

An object representing the OpenID Connect identity provider information for the cluster.

" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

The specified resource is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

You have encountered a service limit on the specified resource.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

The specified resource could not be found. You can view your available clusters with ListClusters. Amazon EKS clusters are Region-specific.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServerException":{ + "type":"structure", + "members":{ + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

These errors are usually caused by a server-side issue.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The service is unavailable. Back off and retry the operation.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Timestamp":{"type":"timestamp"}, + "UnsupportedAvailabilityZoneException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "clusterName":{ + "shape":"String", + "documentation":"

The Amazon EKS cluster associated with the exception.

" + }, + "validZones":{ + "shape":"StringList", + "documentation":"

The supported Availability Zones for your account. Choose subnets in these Availability Zones for your cluster.

" + } + }, + "documentation":"

At least one of your specified cluster subnets is in an Availability Zone that does not support Amazon EKS. The exception output specifies the supported Availability Zones for your account, from which you can choose subnets for your cluster.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of the tags to be removed.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Update":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

A UUID that is used to track the update.

" + }, + "status":{ + "shape":"UpdateStatus", + "documentation":"

The current status of the update.

" + }, + "type":{ + "shape":"UpdateType", + "documentation":"

The type of the update.

" + }, + "params":{ + "shape":"UpdateParams", + "documentation":"

A key-value map that contains the parameters associated with the update.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The Unix epoch timestamp in seconds for when the update was created.

" + }, + "errors":{ + "shape":"ErrorDetails", + "documentation":"

Any errors associated with a Failed update.

" + } + }, + "documentation":"

An object representing an asynchronous update.

" + }, + "UpdateClusterConfigRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the Amazon EKS cluster to update.

", + "location":"uri", + "locationName":"name" + }, + "resourcesVpcConfig":{"shape":"VpcConfigRequest"}, + "logging":{ + "shape":"Logging", + "documentation":"

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.

" + }, + "clientRequestToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "idempotencyToken":true + } + } + }, + "UpdateClusterConfigResponse":{ + "type":"structure", + "members":{ + "update":{"shape":"Update"} + } + }, + "UpdateClusterVersionRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"String", + "documentation":"

The name of the Amazon EKS cluster to update.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"String", + "documentation":"

The desired Kubernetes version following a successful update.

" + }, + "clientRequestToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", + "idempotencyToken":true + } + } + }, + "UpdateClusterVersionResponse":{ + "type":"structure", + "members":{ + "update":{ + "shape":"Update", + "documentation":"

The full description of the specified update

" + } + } + }, + "UpdateParam":{ + "type":"structure", + "members":{ + "type":{ + "shape":"UpdateParamType", + "documentation":"

The keys associated with an update request.

" + }, + "value":{ + "shape":"String", + "documentation":"

The value of the keys submitted as part of an update request.

" + } + }, + "documentation":"

An object representing the details of an update request.

" + }, + "UpdateParamType":{ + "type":"string", + "enum":[ + "Version", + "PlatformVersion", + "EndpointPrivateAccess", + "EndpointPublicAccess", + "ClusterLogging" + ] + }, + "UpdateParams":{ + "type":"list", + "member":{"shape":"UpdateParam"} + }, + "UpdateStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Failed", + "Cancelled", + "Successful" + ] + }, + "UpdateType":{ + "type":"string", + "enum":[ + "VersionUpdate", + "EndpointAccessUpdate", + "LoggingUpdate" + ] + }, + "VpcConfigRequest":{ + "type":"structure", + "members":{ + "subnetIds":{ + "shape":"StringList", + "documentation":"

Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.

" + }, + "securityGroupIds":{ + "shape":"StringList", + "documentation":"

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify a security group, the default security group for your VPC is used.

" + }, + "endpointPublicAccess":{ + "shape":"BoxedBoolean", + "documentation":"

Set this value to false to disable public access for your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can receive only requests from within the cluster VPC. The default value for this parameter is true, which enables public access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

" + }, + "endpointPrivateAccess":{ + "shape":"BoxedBoolean", + "documentation":"

Set this value to true to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is false, which disables private access for your Kubernetes API server. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

" + } + }, + "documentation":"

An object representing the VPC configuration to use for an Amazon EKS cluster.

" + }, + "VpcConfigResponse":{ + "type":"structure", + "members":{ + "subnetIds":{ + "shape":"StringList", + "documentation":"

The subnets associated with your cluster.

" + }, + "securityGroupIds":{ + "shape":"StringList", + "documentation":"

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.

" + }, + "vpcId":{ + "shape":"String", + "documentation":"

The VPC associated with your cluster.

" + }, + "endpointPublicAccess":{ + "shape":"Boolean", + "documentation":"

This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server can receive only requests that originate from within the cluster VPC.

" + }, + "endpointPrivateAccess":{ + "shape":"Boolean", + "documentation":"

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet.

" + } + }, + "documentation":"

An object representing an Amazon EKS cluster VPC configuration response.

" + } + }, + "documentation":"

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

" +} diff --git a/aws/dist/botocore/data/eks/2017-11-01/service-2.sdk-extras.json b/aws/dist/botocore/data/eks/2017-11-01/service-2.sdk-extras.json new file mode 100644 index 00000000..b636c211 --- /dev/null +++ b/aws/dist/botocore/data/eks/2017-11-01/service-2.sdk-extras.json @@ -0,0 +1,8 @@ +{ + "version": 1.0, + "merge": { + "metadata": { + "serviceId":"EKS" + } + } +} diff --git a/aws/dist/botocore/data/eks/2017-11-01/waiters-2.json b/aws/dist/botocore/data/eks/2017-11-01/waiters-2.json new file mode 100644 index 00000000..c325e521 --- /dev/null +++ b/aws/dist/botocore/data/eks/2017-11-01/waiters-2.json @@ -0,0 +1,54 @@ +{ + "version": 2, + "waiters": { + "ClusterActive": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "DELETING", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "FAILED", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "cluster.status" + } + ] + }, + "ClusterDeleted": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "CREATING", + "matcher": "path", + "state": "failure", + "argument": "cluster.status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/elasticache/2014-09-30/paginators-1.json b/aws/dist/botocore/data/elasticache/2014-09-30/paginators-1.json new file mode 100644 index 00000000..8724740d --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2014-09-30/paginators-1.json @@ -0,0 +1,76 @@ +{ + "pagination": { + "DescribeCacheClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheClusters" + }, + "DescribeCacheEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheEngineVersions" + }, + "DescribeCacheParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheParameterGroups" + }, + "DescribeCacheParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeCacheSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSecurityGroups" + }, + "DescribeCacheSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeReservedCacheNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodes" + }, + "DescribeReservedCacheNodesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodesOfferings" + }, + "DescribeReplicationGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReplicationGroups" + }, + "DescribeSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + } + } +} diff --git a/aws/dist/botocore/data/elasticache/2014-09-30/service-2.json b/aws/dist/botocore/data/elasticache/2014-09-30/service-2.json new file mode 100644 index 00000000..33222a9c --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2014-09-30/service-2.json @@ -0,0 +1,5050 @@ +{ + "metadata":{ + "apiVersion":"2014-09-30", + "endpointPrefix":"elasticache", + "serviceFullName":"Amazon ElastiCache", + "serviceId":"ElastiCache", + "signatureVersion":"v4", + "xmlNamespace":"http://elasticache.amazonaws.com/doc/2014-09-30/", + "protocol":"query" + }, + "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers gain all of the benefits of a high-performance, in-memory cache with far less of the administrative burden of launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

", + "operations":{ + "AuthorizeCacheSecurityGroupIngress":{ + "name":"AuthorizeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeCacheSecurityGroupIngressMessage", + "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" + }, + "output":{ + "shape":"AuthorizeCacheSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", + "resultWrapper":"AuthorizeCacheSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The AuthorizeCacheSecurityGroupIngress operation allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopySnapshotMessage", + "documentation":"

Represents the input of a CopySnapshotMessage operation.

" + }, + "output":{ + "shape":"CopySnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"CopySnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidSnapshotStateFault", + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CopySnapshot operation makes a copy of an existing snapshot.

" + }, + "CreateCacheCluster":{ + "name":"CreateCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheClusterMessage", + "documentation":"

Represents the input of a CreateCacheCluster operation.

" + }, + "output":{ + "shape":"CreateCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"CreateCacheClusterResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"CacheClusterAlreadyExistsFault", + "error":{ + "code":"CacheClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a cache cluster with the given identifier.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + { + "shape":"ClusterQuotaForCustomerExceededFault", + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheCluster operation creates a cache cluster. All nodes in the cache cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

" + }, + "CreateCacheParameterGroup":{ + "name":"CreateCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheParameterGroupMessage", + "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CreateCacheParameterGroupResult", + "wrapper":true, + "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

", + "resultWrapper":"CreateCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupQuotaExceededFault", + "error":{ + "code":"CacheParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" + }, + { + "shape":"CacheParameterGroupAlreadyExistsFault", + "error":{ + "code":"CacheParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache parameter group with the requested name already exists.

" + }, + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheParameterGroup operation creates a new cache parameter group. A cache parameter group is a collection of parameters that you apply to all of the nodes in a cache cluster.

" + }, + "CreateCacheSecurityGroup":{ + "name":"CreateCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheSecurityGroupMessage", + "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" + }, + "output":{ + "shape":"CreateCacheSecurityGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", + "resultWrapper":"CreateCacheSecurityGroupResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupAlreadyExistsFault", + "error":{ + "code":"CacheSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache security group with the specified name already exists.

" + }, + { + "shape":"CacheSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.CacheSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateCacheSecurityGroup operation creates a new cache security group. Use a cache security group to control access to one or more cache clusters.

Cache security groups are only used when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC). If you are creating a cache cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" + }, + "CreateCacheSubnetGroup":{ + "name":"CreateCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateCacheSubnetGroupMessage", + "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" + }, + "output":{ + "shape":"CreateCacheSubnetGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
", + "resultWrapper":"CreateCacheSubnetGroupResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupAlreadyExistsFault", + "error":{ + "code":"CacheSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" + }, + { + "shape":"CacheSubnetGroupQuotaExceededFault", + "error":{ + "code":"CacheSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" + }, + { + "shape":"CacheSubnetQuotaExceededFault", + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + } + ], + "documentation":"

The CreateCacheSubnetGroup operation creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "CreateReplicationGroup":{ + "name":"CreateReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateReplicationGroupMessage", + "documentation":"

Represents the input of a CreateReplicationGroup operation.

" + }, + "output":{ + "shape":"CreateReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"CreateReplicationGroupResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"ReplicationGroupAlreadyExistsFault", + "error":{ + "code":"ReplicationGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group already exists.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + { + "shape":"ClusterQuotaForCustomerExceededFault", + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The CreateReplicationGroup operation creates a replication group. A replication group is a collection of cache clusters, where one of the cache clusters is a read/write primary and the others are read-only replicas. Writes to the primary are automatically propagated to the replicas.

When you create a replication group, you must specify an existing cache cluster that is in the primary role. When the replication group has been successfully created, you can add one or more read replica replicas to it, up to a total of five read replicas.

Note: This action is valid only for Redis.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateSnapshotMessage", + "documentation":"

Represents the input of a CreateSnapshot operation.

" + }, + "output":{ + "shape":"CreateSnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"CreateSnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + } + ], + "documentation":"

The CreateSnapshot operation creates a copy of an entire cache cluster at a specific moment in time.

" + }, + "DeleteCacheCluster":{ + "name":"DeleteCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheClusterMessage", + "documentation":"

Represents the input of a DeleteCacheCluster operation.

" + }, + "output":{ + "shape":"DeleteCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"DeleteCacheClusterResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheCluster operation deletes a previously provisioned cache cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cache cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cache cluster; you cannot cancel or revert this operation.

This API cannot be used to delete a cache cluster that is the last read replica of a replication group that has automatic failover mode enabled.

" + }, + "DeleteCacheParameterGroup":{ + "name":"DeleteCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheParameterGroupMessage", + "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" + }, + "errors":[ + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheParameterGroup operation deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

" + }, + "DeleteCacheSecurityGroup":{ + "name":"DeleteCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheSecurityGroupMessage", + "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" + }, + "errors":[ + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteCacheSecurityGroup operation deletes a cache security group.

" + }, + "DeleteCacheSubnetGroup":{ + "name":"DeleteCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteCacheSubnetGroupMessage", + "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" + }, + "errors":[ + { + "shape":"CacheSubnetGroupInUse", + "error":{ + "code":"CacheSubnetGroupInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group is currently in use.

" + }, + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + } + ], + "documentation":"

The DeleteCacheSubnetGroup operation deletes a cache subnet group.

" + }, + "DeleteReplicationGroup":{ + "name":"DeleteReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteReplicationGroupMessage", + "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" + }, + "output":{ + "shape":"DeleteReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"DeleteReplicationGroupResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"SnapshotAlreadyExistsFault", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + { + "shape":"SnapshotFeatureNotSupportedFault", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteReplicationGroup operation deletes an existing cluster. By default, this operation deletes the entire cluster, including the primary node group and all of the read replicas. You can optionally delete only the read replicas, while retaining the primary node group.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteSnapshotMessage", + "documentation":"

Represents the input of a DeleteSnapshot operation.

" + }, + "output":{ + "shape":"DeleteSnapshotResult", + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

", + "resultWrapper":"DeleteSnapshotResult" + }, + "errors":[ + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"InvalidSnapshotStateFault", + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DeleteSnapshot operation deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

" + }, + "DescribeCacheClusters":{ + "name":"DescribeCacheClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheClustersMessage", + "documentation":"

Represents the input of a DescribeCacheClusters operation.

" + }, + "output":{ + "shape":"CacheClusterMessage", + "documentation":"

Represents the output of a DescribeCacheClusters operation.

", + "resultWrapper":"DescribeCacheClustersResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheClusters operation returns information about all provisioned cache clusters if no cache cluster identifier is specified, or about a specific cache cluster if a cache cluster identifier is supplied.

By default, abbreviated information about the cache clusters(s) will be returned. You can use the optional ShowDetails flag to retrieve detailed information about the cache nodes associated with the cache clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.

If the cluster is in the DELETING state, only cluster level information will be displayed.

If cache nodes are currently being added to the cache cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the cache cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cache cluster, no endpoint information for the removed nodes is displayed.

" + }, + "DescribeCacheEngineVersions":{ + "name":"DescribeCacheEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheEngineVersionsMessage", + "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" + }, + "output":{ + "shape":"CacheEngineVersionMessage", + "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

", + "resultWrapper":"DescribeCacheEngineVersionsResult" + }, + "documentation":"

The DescribeCacheEngineVersions operation returns a list of the available cache engines and their versions.

" + }, + "DescribeCacheParameterGroups":{ + "name":"DescribeCacheParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheParameterGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" + }, + "output":{ + "shape":"CacheParameterGroupsMessage", + "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

", + "resultWrapper":"DescribeCacheParameterGroupsResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheParameterGroups operation returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list will contain only the descriptions for that group.

" + }, + "DescribeCacheParameters":{ + "name":"DescribeCacheParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheParametersMessage", + "documentation":"

Represents the input of a DescribeCacheParameters operation.

" + }, + "output":{ + "shape":"CacheParameterGroupDetails", + "documentation":"

Represents the output of a DescribeCacheParameters operation.

", + "resultWrapper":"DescribeCacheParametersResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheParameters operation returns the detailed parameter list for a particular cache parameter group.

" + }, + "DescribeCacheSecurityGroups":{ + "name":"DescribeCacheSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheSecurityGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" + }, + "output":{ + "shape":"CacheSecurityGroupMessage", + "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

", + "resultWrapper":"DescribeCacheSecurityGroupsResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeCacheSecurityGroups operation returns a list of cache security group descriptions. If a cache security group name is specified, the list will contain only the description of that group.

" + }, + "DescribeCacheSubnetGroups":{ + "name":"DescribeCacheSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeCacheSubnetGroupsMessage", + "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" + }, + "output":{ + "shape":"CacheSubnetGroupMessage", + "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

", + "resultWrapper":"DescribeCacheSubnetGroupsResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + } + ], + "documentation":"

The DescribeCacheSubnetGroups operation returns a list of cache subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeEngineDefaultParameters operation returns the default engine and system parameter information for the specified cache engine.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

Represents the input of a DescribeEvents operation.

" + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

Represents the output of a DescribeEvents operation.

", + "resultWrapper":"DescribeEventsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeEvents operation returns events related to cache clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cache cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" + }, + "DescribeReplicationGroups":{ + "name":"DescribeReplicationGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReplicationGroupsMessage", + "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" + }, + "output":{ + "shape":"ReplicationGroupMessage", + "documentation":"

Represents the output of a DescribeReplicationGroups operation.

", + "resultWrapper":"DescribeReplicationGroupsResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReplicationGroups operation returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

" + }, + "DescribeReservedCacheNodes":{ + "name":"DescribeReservedCacheNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedCacheNodesMessage", + "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" + }, + "output":{ + "shape":"ReservedCacheNodeMessage", + "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

", + "resultWrapper":"DescribeReservedCacheNodesResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodeNotFoundFault", + "error":{ + "code":"ReservedCacheNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested reserved cache node was not found.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReservedCacheNodes operation returns information about reserved cache nodes for this account, or about a specified reserved cache node.

" + }, + "DescribeReservedCacheNodesOfferings":{ + "name":"DescribeReservedCacheNodesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedCacheNodesOfferingsMessage", + "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + }, + "output":{ + "shape":"ReservedCacheNodesOfferingMessage", + "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

", + "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodesOfferingNotFoundFault", + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeReservedCacheNodesOfferings operation lists available reserved cache node offerings.

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeSnapshotsMessage", + "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" + }, + "output":{ + "shape":"DescribeSnapshotsListMessage", + "documentation":"

Represents the output of a DescribeSnapshots operation.

", + "resultWrapper":"DescribeSnapshotsResult" + }, + "errors":[ + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"SnapshotNotFoundFault", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The DescribeSnapshots operation returns information about cache cluster snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

" + }, + "ModifyCacheCluster":{ + "name":"ModifyCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheClusterMessage", + "documentation":"

Represents the input of a ModifyCacheCluster operation.

" + }, + "output":{ + "shape":"ModifyCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"ModifyCacheClusterResult" + }, + "errors":[ + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyCacheCluster operation modifies the settings for a cache cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

" + }, + "ModifyCacheParameterGroup":{ + "name":"ModifyCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheParameterGroupMessage", + "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
", + "resultWrapper":"ModifyCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyCacheParameterGroup operation modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + }, + "ModifyCacheSubnetGroup":{ + "name":"ModifyCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyCacheSubnetGroupMessage", + "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" + }, + "output":{ + "shape":"ModifyCacheSubnetGroupResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
", + "resultWrapper":"ModifyCacheSubnetGroupResult" + }, + "errors":[ + { + "shape":"CacheSubnetGroupNotFoundFault", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + { + "shape":"CacheSubnetQuotaExceededFault", + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + { + "shape":"SubnetInUse", + "error":{ + "code":"SubnetInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is being used by another cache subnet group.

" + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + } + ], + "documentation":"

The ModifyCacheSubnetGroup operation modifies an existing cache subnet group.

" + }, + "ModifyReplicationGroup":{ + "name":"ModifyReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyReplicationGroupMessage", + "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" + }, + "output":{ + "shape":"ModifyReplicationGroupResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

", + "resultWrapper":"ModifyReplicationGroupResult" + }, + "errors":[ + { + "shape":"ReplicationGroupNotFoundFault", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + { + "shape":"InvalidReplicationGroupStateFault", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"InsufficientCacheClusterCapacityFault", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + { + "shape":"NodeQuotaForClusterExceededFault", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + { + "shape":"NodeQuotaForCustomerExceededFault", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ModifyReplicationGroup operation modifies the settings for a replication group.

" + }, + "PurchaseReservedCacheNodesOffering":{ + "name":"PurchaseReservedCacheNodesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedCacheNodesOfferingMessage", + "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" + }, + "output":{ + "shape":"PurchaseReservedCacheNodesOfferingResult", + "wrapper":true, + "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

", + "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedCacheNodesOfferingNotFoundFault", + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + { + "shape":"ReservedCacheNodeAlreadyExistsFault", + "error":{ + "code":"ReservedCacheNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a reservation with the given identifier.

" + }, + { + "shape":"ReservedCacheNodeQuotaExceededFault", + "error":{ + "code":"ReservedCacheNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The PurchaseReservedCacheNodesOffering operation allows you to purchase a reserved cache node offering.

" + }, + "RebootCacheCluster":{ + "name":"RebootCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootCacheClusterMessage", + "documentation":"

Represents the input of a RebootCacheCluster operation.

" + }, + "output":{ + "shape":"RebootCacheClusterResult", + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

", + "resultWrapper":"RebootCacheClusterResult" + }, + "errors":[ + { + "shape":"InvalidCacheClusterStateFault", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + { + "shape":"CacheClusterNotFoundFault", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + } + ], + "documentation":"

The RebootCacheCluster operation reboots some, or all, of the cache nodes within a provisioned cache cluster. This API will apply any modified cache parameter groups to the cache cluster. The reboot action takes place as soon as possible, and results in a momentary outage to the cache cluster. During the reboot, the cache cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cache cluster event is created.

" + }, + "ResetCacheParameterGroup":{ + "name":"ResetCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetCacheParameterGroupMessage", + "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" + }, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
", + "resultWrapper":"ResetCacheParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidCacheParameterGroupStateFault", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + { + "shape":"CacheParameterGroupNotFoundFault", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The ResetCacheParameterGroup operation modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

" + }, + "RevokeCacheSecurityGroupIngress":{ + "name":"RevokeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeCacheSecurityGroupIngressMessage", + "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" + }, + "output":{ + "shape":"RevokeCacheSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
", + "resultWrapper":"RevokeCacheSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"CacheSecurityGroupNotFoundFault", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" + }, + { + "shape":"InvalidCacheSecurityGroupStateFault", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + { + "shape":"InvalidParameterCombinationException", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + } + ], + "documentation":"

The RevokeCacheSecurityGroupIngress operation revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

" + } + }, + "shapes":{ + "AZMode":{ + "type":"string", + "enum":[ + "single-az", + "cross-az" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

" + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

" + }, + "AuthorizeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The cache security group which will allow network ingress.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The Amazon EC2 security group to be authorized for ingress to the cache security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" + }, + "AutomaticFailoverStatus":{ + "type":"string", + "enum":[ + "enabled", + "disabled", + "enabling", + "disabling" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

" + } + }, + "wrapper":true, + "documentation":"

Describes an Availability Zone in which the cache cluster is launched.

" + }, + "AvailabilityZonesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "AwsQueryErrorMessage":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CacheCluster":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a cache cluster.

" + }, + "ConfigurationEndpoint":{"shape":"Endpoint"}, + "ClientDownloadLandingPage":{ + "shape":"String", + "documentation":"

The URL of the web page where you can download the latest ElastiCache client library.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the cache cluster.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) to be used for this cache cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine version that is used in this cache cluster.

" + }, + "CacheClusterStatus":{ + "shape":"String", + "documentation":"

The current state of this cache cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cache cluster nodes, restore-failed, or snapshotting.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the cache cluster.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the cache cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range (in UTC) during which weekly system maintenance can occur.

" + }, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "NotificationConfiguration":{"shape":"NotificationConfiguration"}, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroupMembershipList", + "documentation":"

A list of cache security group elements, composed of name and status sub-elements.

" + }, + "CacheParameterGroup":{"shape":"CacheParameterGroupStatus"}, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the cache cluster.

" + }, + "CacheNodes":{ + "shape":"CacheNodeList", + "documentation":"

A list of cache nodes that are members of the cache cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

If true, then minor version patches are applied automatically; if false, then automatic minor version patches are disabled.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupMembershipList", + "documentation":"

A list of VPC Security Groups associated with the cache cluster.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group to which this cache cluster belongs. If this field is empty, the cache cluster is not associated with any replication group.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

Example: 05:00-09:00

" + } + }, + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific cache cluster.

" + }, + "CacheClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a cache cluster with the given identifier.

" + }, + "CacheClusterList":{ + "type":"list", + "member":{ + "shape":"CacheCluster", + "locationName":"CacheCluster" + } + }, + "CacheClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheClusters":{ + "shape":"CacheClusterList", + "documentation":"

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheClusters operation.

" + }, + "CacheClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster ID does not refer to an existing cache cluster.

" + }, + "CacheEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family associated with this cache engine.

" + }, + "CacheEngineDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine.

" + }, + "CacheEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine version.

" + } + }, + "documentation":"

Provides all of the details about a particular cache engine version.

" + }, + "CacheEngineVersionList":{ + "type":"list", + "member":{ + "shape":"CacheEngineVersion", + "locationName":"CacheEngineVersion" + } + }, + "CacheEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheEngineVersions":{ + "shape":"CacheEngineVersionList", + "documentation":"

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

" + }, + "CacheNode":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" + }, + "CacheNodeStatus":{ + "shape":"String", + "documentation":"

The current state of this cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The hostname and IP address for connecting to this cache node.

" + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

The status of the parameter group applied to this cache node.

" + }, + "SourceCacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the primary node to which this read replica node is synchronized. If this field is empty, then this node is not associated with a primary cache cluster.

" + }, + "CustomerAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where this node was created and now resides.

" + } + }, + "documentation":"

Represents an individual cache node within a cache cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

" + }, + "CacheNodeIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheNodeId" + } + }, + "CacheNodeList":{ + "type":"list", + "member":{ + "shape":"CacheNode", + "locationName":"CacheNode" + } + }, + "CacheNodeTypeSpecificParameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter value.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + }, + "CacheNodeTypeSpecificValues":{ + "shape":"CacheNodeTypeSpecificValueList", + "documentation":"

A list of cache node types and their corresponding values for this parameter.

" + } + }, + "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cache cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" + }, + "CacheNodeTypeSpecificParametersList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificParameter", + "locationName":"CacheNodeTypeSpecificParameter" + } + }, + "CacheNodeTypeSpecificValue":{ + "type":"structure", + "members":{ + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for which this value applies.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value for the cache node type.

" + } + }, + "documentation":"

A value that applies only to a certain cache node type.

" + }, + "CacheNodeTypeSpecificValueList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificValue", + "locationName":"CacheNodeTypeSpecificValue" + } + }, + "CacheParameterGroup":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for this cache parameter group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

" + }, + "CacheParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache parameter group with the requested name already exists.

" + }, + "CacheParameterGroupDetails":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter instances.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameters operation.

" + }, + "CacheParameterGroupList":{ + "type":"list", + "member":{ + "shape":"CacheParameterGroup", + "locationName":"CacheParameterGroup" + } + }, + "CacheParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + } + }, + "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup
  • ResetCacheParameterGroup
" + }, + "CacheParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

" + }, + "CacheParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

" + }, + "CacheParameterGroupStatus":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

" + } + }, + "documentation":"

The status of the cache parameter group.

" + }, + "CacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheParameterGroups":{ + "shape":"CacheParameterGroupList", + "documentation":"

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

" + }, + "CacheSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the cache security group owner.

" + }, + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the cache security group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

A list of Amazon EC2 security groups that are associated with this cache security group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress
  • CreateCacheSecurityGroup
  • RevokeCacheSecurityGroupIngress
" + }, + "CacheSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

A cache security group with the specified name already exists.

" + }, + "CacheSecurityGroupMembership":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" + } + }, + "documentation":"

Represents a cache cluster's status within a particular cache security group.

" + }, + "CacheSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroupMembership", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroups", + "documentation":"

A list of cache security groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

" + }, + "CacheSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheSecurityGroupName" + } + }, + "CacheSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

" + }, + "CacheSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.CacheSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

" + }, + "CacheSecurityGroups":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroup", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSubnetGroup":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group.

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description of the cache subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

A list of subnets associated with the cache subnet group.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup
  • ModifyCacheSubnetGroup
" + }, + "CacheSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

" + }, + "CacheSubnetGroupInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group is currently in use.

" + }, + "CacheSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSubnetGroups":{ + "shape":"CacheSubnetGroups", + "documentation":"

A list of cache subnet groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

" + }, + "CacheSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

" + }, + "CacheSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

" + }, + "CacheSubnetGroups":{ + "type":"list", + "member":{ + "shape":"CacheSubnetGroup", + "locationName":"CacheSubnetGroup" + } + }, + "CacheSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

" + }, + "ClusterIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterId" + } + }, + "ClusterQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache clusters per customer.

" + }, + "CopySnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotName", + "TargetSnapshotName" + ], + "members":{ + "SourceSnapshotName":{ + "shape":"String", + "documentation":"

The name of an existing snapshot from which to copy.

" + }, + "TargetSnapshotName":{ + "shape":"String", + "documentation":"

A name for the copied snapshot.

" + } + }, + "documentation":"

Represents the input of a CopySnapshotMessage operation.

" + }, + "CreateCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The node group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group to which this cache cluster should belong. If this parameter is specified, the cache cluster will be added to the specified replication group as a read replica; otherwise, the cache cluster will be a standalone primary that is not part of any replication group.

If the specified replication group is Automatic Failover enabled and the availability zone is not specified, the cache cluster will be created in availability zones that provide the best spread of read replicas across availability zones.

Note: This parameter is only valid if the Engine parameter is redis.

" + }, + "AZMode":{ + "shape":"AZMode", + "documentation":"

Specifies whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached cache clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone in which the cache cluster will be created.

All nodes belonging to this Memcached cache cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

" + }, + "PreferredAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

A list of the Availability Zones in which cache nodes will be created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

Example: One Memcached node in each of three different Availability Zones: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1b&PreferredAvailabilityZones.member.3=us-east-1d

Example: All three Memcached nodes in one Availability Zone: PreferredAvailabilityZones.member.1=us-east-1a&PreferredAvailabilityZones.member.2=us-east-1a&PreferredAvailabilityZones.member.3=us-east-1a

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The initial number of cache nodes that the cache cluster will have.

For Memcached, valid values are between 1 and 20. If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

For Redis, only single-node cache cluster are supported at this time, so the value for this parameter must be 1.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine to be used for this cache cluster.

Valid values for this parameter are:

memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine to be used for this cache cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to associate with this cache cluster. If this argument is omitted, the default parameter group for the specified engine is used.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group to be used for the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of security group names to associate with this cache cluster.

Use this parameter only when you are creating a cache cluster outside of an Amazon Virtual Private Cloud (VPC).

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

One or more VPC security groups associated with the cache cluster.

Use this parameter only when you are creating a cache cluster in an Amazon Virtual Private Cloud (VPC).

" + }, + "SnapshotArns":{ + "shape":"SnapshotArnsList", + "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

Note: This parameter is only valid if the Engine parameter is redis.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which each of the cache nodes will accept connections.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Note: This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" + } + }, + "documentation":"

Represents the input of a CreateCacheCluster operation.

" + }, + "CreateCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "CacheParameterGroupFamily", + "Description" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

A user-specified name for the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family the cache parameter group can be used with.

Valid values are: memcached1.4 | redis2.6 | redis2.8

" + }, + "Description":{ + "shape":"String", + "documentation":"

A user-specified description for the cache parameter group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" + }, + "CreateCacheSecurityGroupMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "Description" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

Example: mysecuritygroup

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the cache security group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" + }, + "CreateCacheSubnetGroupMessage":{ + "type":"structure", + "required":[ + "CacheSubnetGroupName", + "CacheSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of VPC subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" + }, + "CreateReplicationGroupMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "ReplicationGroupDescription" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 20 alphanumeric characters or hyphens.
  • The first character must be a letter.
  • A name cannot end with a hyphen or contain two consecutive hyphens.
" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A user-created description for the replication group.

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The identifier of the cache cluster that will serve as the primary for this replication group. This cache cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters is specified.

" + }, + "AutomaticFailoverEnabled":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails.

If true, automatic failover is enabled for this replication group. If false, automatic failover is disabled for this replication group.

Default: false

" + }, + "NumCacheClusters":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache clusters this replication group will initially have.

If AutomaticFailover is enabled, the value of this parameter must be at least 2.

The maximum permitted value for NumCacheClusters is 6 (primary plus 5 replicas). If you need to exceed this limit, please fill out the ElastiCache Limit Increase Request forrm at http://aws.amazon.com/contact-us/elasticache-node-limit-request.

" + }, + "PreferredCacheClusterAZs":{ + "shape":"AvailabilityZonesList", + "documentation":"

A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important.

Default: system chosen availability zones.

Example: One Redis cache cluster in each of three availability zones. PreferredAvailabilityZones.member.1=us-east-1a PreferredAvailabilityZones.member.2=us-east-1c PreferredAvailabilityZones.member.3=us-east-1d

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the node group.

Valid node types are as follows:

  • General purpose:
    • Current generation: cache.t2.micro, cache.t2.small, cache.t2.medium, cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge
    • Previous generation: cache.t1.micro, cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge
  • Compute optimized: cache.c1.xlarge
  • Memory optimized
    • Current generation: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge
    • Previous generation: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

Notes:

  • All t2 instances are created in an Amazon Virtual Private Cloud (VPC).
  • Redis backup/restore is not supported for t2 instances.
  • Redis Append-only files (AOF) functionality is not supported for t1 or t2 instances.

For a complete listing of cache node types and specifications, see Amazon ElastiCache Product Features and Details and Cache Node Type-Specific Parameters for Memcached or Cache Node Type-Specific Parameters for Redis.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine to be used for the cache clusters in this replication group.

Default: redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cach engine to be used for the cache clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to be used for the replication group.

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to associate with this replication group.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (VPC).

" + }, + "SnapshotArns":{ + "shape":"SnapshotArnsList", + "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file will be used to populate the node group. The Amazon S3 object name in the ARN cannot contain any commas.

Note: This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot from which to restore data into the new node group. The snapshot status changes to restoring while the new node group is being created.

Note: This parameter is only valid if the Engine parameter is redis.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur.

Example: sun:05:00-sun:09:00

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which each member of the replication group will accept connections.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications will be sent.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether minor engine upgrades will be applied automatically to the node group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

Default: true

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Note: This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your node group.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

Note: This parameter is only valid if the Engine parameter is redis.

" + } + }, + "documentation":"

Represents the input of a CreateReplicationGroup operation.

" + }, + "CreateSnapshotMessage":{ + "type":"structure", + "required":[ + "CacheClusterId", + "SnapshotName" + ], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The identifier of an existing cache cluster. The snapshot will be created from this cache cluster.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A name for the snapshot being created.

" + } + }, + "documentation":"

Represents the input of a CreateSnapshot operation.

" + }, + "DeleteCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied name of a final cache cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cache cluster immediately afterward.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheCluster operation.

" + }, + "DeleteCacheParameterGroupMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" + }, + "DeleteCacheSecurityGroupMessage":{ + "type":"structure", + "required":["CacheSecurityGroupName"], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to delete.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" + }, + "DeleteCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" + }, + "DeleteReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the cluster to be deleted. This parameter is not case sensitive.

" + }, + "RetainPrimaryCluster":{ + "shape":"BooleanOptional", + "documentation":"

If set to true, all of the read replicas will be deleted, but the primary node will be retained.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The name of a final node group snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the cluster is immediately deleted.

" + } + }, + "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" + }, + "DeleteSnapshotMessage":{ + "type":"structure", + "required":["SnapshotName"], + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of the snapshot to be deleted.

" + } + }, + "documentation":"

Represents the input of a DeleteSnapshot operation.

" + }, + "DescribeCacheClustersMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cache cluster is returned. This parameter isn't case sensitive.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ShowCacheNodeInfo":{ + "shape":"BooleanOptional", + "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheClusters operation.

" + }, + "DescribeCacheEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The cache engine to return. Valid values: memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The cache engine version to return.

Example: 1.4.14

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group family to return details for.

Constraints:

  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens
" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" + }, + "DescribeCacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" + }, + "DescribeCacheParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Valid values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameters operation.

" + }, + "DescribeCacheSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" + }, + "DescribeCacheSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupFamily"], + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family. Valid values are: memcached1.4 | redis2.6 | redis2.8

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

Valid values are: cache-cluster | cache-parameter-group | cache-security-group | cache-subnet-group

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes' worth of events to retrieve.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEvents operation.

" + }, + "DescribeReplicationGroupsMessage":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" + }, + "DescribeReservedCacheNodesMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" + }, + "DescribeReservedCacheNodesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + }, + "DescribeSnapshotsListMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" + } + }, + "documentation":"

Represents the output of a DescribeSnapshots operation.

" + }, + "DescribeSnapshotsMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cache cluster will be described.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot will be described.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

" + } + }, + "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" + }, + "Double":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EC2 security group owner.

" + } + }, + "documentation":"

Provides ownership and status information for an Amazon EC2 security group.

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

The DNS hostname of the cache node.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port number that the cache engine is listening on.

" + } + }, + "documentation":"

Represents the information required for client programs to connect to a cache node.

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

" + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source of the event. For example, if the event occurred at the cache cluster level, the identifier would be the name of the cache cluster.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the origin of this event - a cache cluster, a parameter group, a security group, etc.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The text of the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

The date and time when the event occurred.

" + } + }, + "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cache cluster, adding or removing a cache node, or rebooting a node.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of events. Each element in the list contains detailed information about one event.

" + } + }, + "documentation":"

Represents the output of a DescribeEvents operation.

" + }, + "InsufficientCacheClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node type is not available in the specified Availability Zone.

" + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidCacheClusterStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache cluster is not in the available state.

" + }, + "InvalidCacheParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache parameter group does not allow the requested action to occur.

" + }, + "InvalidCacheSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the cache security group does not allow deletion.

" + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

Two or more parameters that must not be used together were used together.

" + } + }, + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

Two or more incompatible parameters were specified.

" + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

A parameter value is invalid.

" + } + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The value for a parameter is invalid.

" + }, + "InvalidReplicationGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested replication group is not in the available state.

" + }, + "InvalidSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The current state of the snapshot does not allow the requested action to occur.

" + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

An invalid subnet identifier was specified.

" + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The VPC network is in an invalid state.

" + }, + "ModifyCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier. This value is stored as a lowercase string.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes that the cache cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), then more nodes will be added. If the value is less than the number of existing cache nodes, then nodes will be removed. If the value is equal to the number of current cache nodes, then any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For cache clusters running Redis, the value of NumCacheNodesmust be 1.

Note:
Adding or removing Memcached cache nodes can be applied immediately or as a pending action. See ApplyImmediately.
A pending action to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending actions to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending action to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending action to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending action to add nodes. The customer can modify the previous pending action to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending actions to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cache cluster.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluser call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" + }, + "AZMode":{ + "shape":"AZMode", + "documentation":"

Specifies whether the new nodes in this Memcached cache cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached cache clusters.

" + }, + "NewAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

The list of Availability Zones where the new Memcached cache nodes will be created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes.
    Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.
  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node.
    Specify NumCacheNodes=6 ((3 + 2) + 1)
    • and optionally specify an Availability Zone for the new node.
  • Scenario 3: You want to cancel all pending actions.
    Specify NumCacheNodes=3 to cancel all pending actions.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

Scenarios Pending Operation New Request Results
Scenario-1 Delete Delete The new delete, pending or immediate, replaces the pending delete.
Scenario-2 Delete Create The new create, pending or immediate, replaces the pending delete.
Scenario-3 Create Delete The new delete, pending or immediate, replaces the pending create.
Scenario-4 Create Create The new create is added to the pending create.
Important:
If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.

Example: NewAvailabilityZones.member.1=us-east-1a&NewAvailabilityZones.member.2=us-east-1b&NewAvailabilityZones.member.3=us-east-1d

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize on this cache cluster. This change is asynchronously applied as soon as possible.

This parameter can be used only with clusters that are created outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the cache cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to this cache cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cache cluster.

If false, then changes to the cache cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

If true, then minor engine upgrades will be applied automatically to the cache cluster during the maintenance window.

Valid values: true | false

Default: true

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheCluster operation.

" + }, + "ModifyCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to modify.

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" + }, + "ModifyCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" + }, + "ModifyReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier of the replication group to modify.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A description for the replication group. Maximum length is 255 characters.

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

If this parameter is specified, ElastiCache will promote each of the cache clusters in the specified replication group to the primary role. The nodes of all other cache clusters in the replication group will be read replicas.

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID that will be used as the daily snapshot source for the replication group.

" + }, + "AutomaticFailoverEnabled":{ + "shape":"BooleanOptional", + "documentation":"

Whether a read replica will be automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing cache clusters running outside of an Amazon Virtual Private Cloud (VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the cache clusters in the replication group.

This parameter can be used only with replication group containing cache clusters running in an Amazon Virtual Private Cloud (VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which replication group system maintenance can occur. Note that system maintenance may result in an outage. This change is made immediately. If you are moving this window to the current time, there must be at least 120 minutes between the current time and end of the window to ensure that pending changes are applied.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, then changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the cache clusters in the replication group.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether minor engine upgrades will be applied automatically to all of the clusters in the replication group during the maintenance window. A value of true allows these upgrades to occur; false disables automatic upgrades.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache will retain automatic node group snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the node group specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, then ElastiCache will automatically choose an appropriate time range.

" + } + }, + "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" + }, + "NodeGroup":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"String", + "documentation":"

The identifier for the node group. A replication group contains only one node group; therefore, the node group ID is 0001.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, etc.

" + }, + "PrimaryEndpoint":{"shape":"Endpoint"}, + "NodeGroupMembers":{ + "shape":"NodeGroupMemberList", + "documentation":"

A list containing information about individual nodes within the node group.

" + } + }, + "documentation":"

Represents a collection of cache nodes in a replication group.

" + }, + "NodeGroupList":{ + "type":"list", + "member":{ + "shape":"NodeGroup", + "locationName":"NodeGroup" + } + }, + "NodeGroupMember":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cache cluster to which the node belongs.

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the node within its cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + }, + "ReadEndpoint":{"shape":"Endpoint"}, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the node is located.

" + }, + "CurrentRole":{ + "shape":"String", + "documentation":"

The role that is currently assigned to the node - primary or replica.

" + } + }, + "documentation":"

Represents a single node within a node group.

" + }, + "NodeGroupMemberList":{ + "type":"list", + "member":{ + "shape":"NodeGroupMember", + "locationName":"NodeGroupMember" + } + }, + "NodeQuotaForClusterExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cache cluster.

" + }, + "NodeQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

" + }, + "NodeSnapshot":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier for the node in the source cache cluster.

" + }, + "CacheSize":{ + "shape":"String", + "documentation":"

The size of the cache on the source cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created in the source cache cluster.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" + } + }, + "wrapper":true, + "documentation":"

Represents an individual cache node in a snapshot of a cache cluster.

" + }, + "NodeSnapshotList":{ + "type":"list", + "member":{ + "shape":"NodeSnapshot", + "locationName":"NodeSnapshot" + } + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" + }, + "TopicStatus":{ + "shape":"String", + "documentation":"

The current state of the topic.

" + } + }, + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + } + }, + "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" + }, + "ParameterNameValue":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + } + }, + "documentation":"

Describes a name-value pair that is used to update the value of a parameter.

" + }, + "ParameterNameValueList":{ + "type":"list", + "member":{ + "shape":"ParameterNameValue", + "locationName":"ParameterNameValue" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingAutomaticFailoverStatus":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The new number of cache nodes for the cache cluster.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs that are being removed (or will be removed) from the cache cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The new cache engine version that the cache cluster will run.

" + } + }, + "documentation":"

A group of settings that will be applied to the cache cluster in the future, or that are currently being applied.

" + }, + "PreferredAvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PreferredAvailabilityZone" + } + }, + "PurchaseReservedCacheNodesOfferingMessage":{ + "type":"structure", + "required":["ReservedCacheNodesOfferingId"], + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

A customer-specified identifier to track this reservation.

Example: myreservationID

" + }, + "CacheNodeCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache node instances to reserve.

Default: 1

" + } + }, + "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" + }, + "RebootCacheClusterMessage":{ + "type":"structure", + "required":[ + "CacheClusterId", + "CacheNodeIdsToReboot" + ], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster identifier. This parameter is stored as a lowercase string.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cache cluster, specify all of the cache node IDs.

" + } + }, + "documentation":"

Represents the input of a RebootCacheCluster operation.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The monetary amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "wrapper":true, + "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "ReplicationGroup":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the replication group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, etc.

" + }, + "PendingModifiedValues":{ + "shape":"ReplicationGroupPendingModifiedValues", + "documentation":"

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

" + }, + "MemberClusters":{ + "shape":"ClusterIdList", + "documentation":"

The names of all the cache clusters that are part of this replication group.

" + }, + "NodeGroups":{ + "shape":"NodeGroupList", + "documentation":"

A single element list with information about the nodes in the replication group.

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID that is used as the daily snapshot source for the replication group.

" + }, + "AutomaticFailover":{ + "shape":"AutomaticFailoverStatus", + "documentation":"

Indicates the status of automatic failover for this replication group.

" + } + }, + "wrapper":true, + "documentation":"

Contains all of the attributes of a specific replication group.

" + }, + "ReplicationGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReplicationGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group already exists.

" + }, + "ReplicationGroupList":{ + "type":"list", + "member":{ + "shape":"ReplicationGroup", + "locationName":"ReplicationGroup" + } + }, + "ReplicationGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReplicationGroups":{ + "shape":"ReplicationGroupList", + "documentation":"

A list of replication groups. Each item in the list contains detailed information about one replication group.

" + } + }, + "documentation":"

Represents the output of a DescribeReplicationGroups operation.

" + }, + "ReplicationGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The specified replication group does not exist.

" + }, + "ReplicationGroupPendingModifiedValues":{ + "type":"structure", + "members":{ + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.

" + }, + "AutomaticFailoverStatus":{ + "shape":"PendingAutomaticFailoverStatus", + "documentation":"

Indicates the status of automatic failover for this replication group.

" + } + }, + "documentation":"

The settings to be applied to the replication group, either immediately or during the next maintenance window.

" + }, + "ReservedCacheNode":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache nodes.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved cache node.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved cache node.

" + }, + "CacheNodeCount":{ + "shape":"Integer", + "documentation":"

The number of cache nodes that have been reserved.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved cache node.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved cache node.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved cache node.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + } + }, + "wrapper":true, + "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

" + }, + "ReservedCacheNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a reservation with the given identifier.

" + }, + "ReservedCacheNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNode", + "locationName":"ReservedCacheNode" + } + }, + "ReservedCacheNodeMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodes":{ + "shape":"ReservedCacheNodeList", + "documentation":"

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

" + }, + "ReservedCacheNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested reserved cache node was not found.

" + }, + "ReservedCacheNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

" + }, + "ReservedCacheNodesOffering":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

A unique identifier for the reserved cache node offering.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache node.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering. in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The cache engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + } + }, + "wrapper":true, + "documentation":"

Describes all of the attributes of a reserved cache node offering.

" + }, + "ReservedCacheNodesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNodesOffering", + "locationName":"ReservedCacheNodesOffering" + } + }, + "ReservedCacheNodesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodesOfferings":{ + "shape":"ReservedCacheNodesOfferingList", + "documentation":"

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

" + }, + "ReservedCacheNodesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested cache node offering does not exist.

" + }, + "ResetCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to reset.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

If true, all parameters in the cache parameter group will be reset to default values. If false, no such action occurs.

Valid values: true | false

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names to be reset. If you are not resetting the entire cache parameter group, you must specify at least one parameter name.

" + } + }, + "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" + }, + "RevokeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to revoke ingress from.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group to revoke access from.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" + }, + "SecurityGroupIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupMembership":{ + "type":"structure", + "members":{ + "SecurityGroupId":{ + "shape":"String", + "documentation":"

The identifier of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cache cluster are modified.

" + } + }, + "documentation":"

Represents a single cache security group and its status..

" + }, + "SecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"SecurityGroupMembership"} + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot. For an automatic snapshot, the name is system-generated; for a manual snapshot, this is the user-provided name.

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the source cache cluster.

" + }, + "SnapshotStatus":{ + "shape":"String", + "documentation":"

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the source cache cluster.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) used by the source cache cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine version that is used by the source cache cluster.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the source cache cluster.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the source cache cluster is located.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source cache cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range (in UTC) during which weekly system maintenance can occur on the source cache cluster.

" + }, + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number used by each cache nodes in the source cache cluster.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The cache parameter group that is associated with the source cache cluster.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the source cache cluster.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

For the source cache cluster, indicates whether minor version patches are applied automatically (true) or not (false).

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

For an automatic snapshot, the number of days for which ElastiCache will retain the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cache cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot action.

Important
If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

" + }, + "NodeSnapshots":{ + "shape":"NodeSnapshotList", + "documentation":"

A list of the cache nodes in the source cache cluster.

" + } + }, + "wrapper":true, + "documentation":"

Represents a copy of an entire cache cluster as of the time when the snapshot was taken.

" + }, + "SnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You already have a snapshot with the given name.

" + }, + "SnapshotArnsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotArn" + } + }, + "SnapshotFeatureNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

You attempted one of the following actions:

  • Creating a snapshot of a Redis cache cluster running on a t1.micro cache node.

  • Creating a snapshot of a cache cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

" + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

" + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "cache-cluster", + "cache-parameter-group", + "cache-security-group", + "cache-subnet-group" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

The unique identifier for the subnet

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone associated with the subnet

" + } + }, + "documentation":"

Represents the subnet associated with a cache cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

The requested subnet is being used by another cache subnet group.

" + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "TStamp":{"type":"timestamp"}, + "AuthorizeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "CreateCacheParameterGroupResult":{ + "type":"structure", + "members":{ + "CacheParameterGroup":{"shape":"CacheParameterGroup"} + } + }, + "CreateCacheSecurityGroupResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "CreateCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "CreateReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "CreateSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DeleteCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "DeleteReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "DeleteSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "ModifyCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "ModifyReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "PurchaseReservedCacheNodesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedCacheNode":{"shape":"ReservedCacheNode"} + } + }, + "RebootCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "RevokeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + } + } +} diff --git a/aws/dist/botocore/data/elasticache/2014-09-30/waiters-2.json b/aws/dist/botocore/data/elasticache/2014-09-30/waiters-2.json new file mode 100644 index 00000000..ccb904aa --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2014-09-30/waiters-2.json @@ -0,0 +1,139 @@ +{ + "version": 2, + "waiters": { + "CacheClusterAvailable": { + "delay": 30, + "operation": "DescribeCacheClusters", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "incompatible-network", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "restore-failed", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + } + ] + }, + "CacheClusterDeleted": { + "delay": 30, + "operation": "DescribeCacheClusters", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "CacheClusterNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "CacheClusters[].CacheClusterStatus" + } + ] + }, + "ReplicationGroupAvailable": { + "delay": 30, + "operation": "DescribeReplicationGroups", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "incompatible-network", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "restore-failed", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + } + ] + }, + "ReplicationGroupDeleted": { + "delay": 30, + "operation": "DescribeReplicationGroups", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "ReplicationGroupNotFoundFault", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "ReplicationGroups[].Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/elasticache/2015-02-02/paginators-1.json b/aws/dist/botocore/data/elasticache/2015-02-02/paginators-1.json new file mode 100644 index 00000000..9ee5996e --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2015-02-02/paginators-1.json @@ -0,0 +1,88 @@ +{ + "pagination": { + "DescribeCacheClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheClusters" + }, + "DescribeCacheEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheEngineVersions" + }, + "DescribeCacheParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheParameterGroups" + }, + "DescribeCacheParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeCacheSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSecurityGroups" + }, + "DescribeCacheSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "CacheSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeReservedCacheNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodes" + }, + "DescribeReservedCacheNodesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedCacheNodesOfferings" + }, + "DescribeReplicationGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReplicationGroups" + }, + "DescribeSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + }, + "DescribeServiceUpdates": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ServiceUpdates" + }, + "DescribeUpdateActions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "UpdateActions" + } + } +} diff --git a/aws/dist/botocore/data/elasticache/2015-02-02/service-2.json b/aws/dist/botocore/data/elasticache/2015-02-02/service-2.json new file mode 100644 index 00000000..43631a56 --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2015-02-02/service-2.json @@ -0,0 +1,5118 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-02-02", + "endpointPrefix":"elasticache", + "protocol":"query", + "serviceFullName":"Amazon ElastiCache", + "serviceId":"ElastiCache", + "signatureVersion":"v4", + "uid":"elasticache-2015-02-02", + "xmlNamespace":"http://elasticache.amazonaws.com/doc/2015-02-02/" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"AddTagsToResourceResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"SnapshotNotFoundFault"}, + {"shape":"TagQuotaPerResourceExceeded"}, + {"shape":"InvalidARNFault"} + ], + "documentation":"

Adds up to 50 cost allocation tags to the named resource. A cost allocation tag is a key-value pair where the key and value are case-sensitive. You can use cost allocation tags to categorize and track your AWS costs.

When you apply tags to your ElastiCache resources, AWS generates a cost allocation report as a comma-separated value (CSV) file with your usage and costs aggregated by your tags. You can apply tags that represent business categories (such as cost centers, application names, or owners) to organize your costs across multiple services. For more information, see Using Cost Allocation Tags in Amazon ElastiCache in the ElastiCache User Guide.

" + }, + "AuthorizeCacheSecurityGroupIngress":{ + "name":"AuthorizeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeCacheSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeCacheSecurityGroupIngressResult", + "resultWrapper":"AuthorizeCacheSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"InvalidCacheSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Allows network ingress to a cache security group. Applications using ElastiCache must be running on Amazon EC2, and Amazon EC2 security groups are used as the authorization mechanism.

You cannot authorize ingress from an Amazon EC2 security group in one region to an ElastiCache cluster in another region.

" + }, + "BatchApplyUpdateAction":{ + "name":"BatchApplyUpdateAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchApplyUpdateActionMessage"}, + "output":{ + "shape":"UpdateActionResultsMessage", + "resultWrapper":"BatchApplyUpdateActionResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Apply the service update. For more information on service updates and applying them, see Applying Service Updates.

" + }, + "BatchStopUpdateAction":{ + "name":"BatchStopUpdateAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchStopUpdateActionMessage"}, + "output":{ + "shape":"UpdateActionResultsMessage", + "resultWrapper":"BatchStopUpdateActionResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Stop the service update. For more information on service updates and stopping them, see Stopping Service Updates.

" + }, + "CompleteMigration":{ + "name":"CompleteMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CompleteMigrationMessage"}, + "output":{ + "shape":"CompleteMigrationResponse", + "resultWrapper":"CompleteMigrationResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"ReplicationGroupNotUnderMigrationFault"} + ], + "documentation":"

Complete the migration of data.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotMessage"}, + "output":{ + "shape":"CopySnapshotResult", + "resultWrapper":"CopySnapshotResult" + }, + "errors":[ + {"shape":"SnapshotAlreadyExistsFault"}, + {"shape":"SnapshotNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidSnapshotStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Makes a copy of an existing snapshot.

This operation is valid for Redis only.

Users or groups that have permissions to use the CopySnapshot operation can create their own Amazon S3 buckets and copy snapshots to it. To control access to your snapshots, use an IAM policy to control who has the ability to use the CopySnapshot operation. For more information about using IAM to control the use of ElastiCache operations, see Exporting Snapshots and Authentication & Access Control.

You could receive the following error messages.

Error Messages

  • Error Message: The S3 bucket %s is outside of the region.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s does not exist.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The S3 bucket %s is not owned by the authenticated user.

    Solution: Create an Amazon S3 bucket in the same region as your snapshot. For more information, see Step 1: Create an Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: The authenticated user does not have sufficient permissions to perform the desired activity.

    Solution: Contact your system administrator to get the needed permissions.

  • Error Message: The S3 bucket %s already contains an object with key %s.

    Solution: Give the TargetSnapshotName a new and unique value. If exporting a snapshot, you could alternatively create a new Amazon S3 bucket and use this same value for TargetSnapshotName.

  • Error Message: ElastiCache has not been granted READ permissions %s on the S3 Bucket.

    Solution: Add List and Read permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted WRITE permissions %s on the S3 Bucket.

    Solution: Add Upload/Delete permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

  • Error Message: ElastiCache has not been granted READ_ACP permissions %s on the S3 Bucket.

    Solution: Add View Permissions on the bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the ElastiCache User Guide.

" + }, + "CreateCacheCluster":{ + "name":"CreateCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCacheClusterMessage"}, + "output":{ + "shape":"CreateCacheClusterResult", + "resultWrapper":"CreateCacheClusterResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"CacheClusterAlreadyExistsFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"CacheSubnetGroupNotFoundFault"}, + {"shape":"ClusterQuotaForCustomerExceededFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"TagQuotaPerResourceExceeded"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a cluster. All nodes in the cluster run the same protocol-compliant cache engine software, either Memcached or Redis.

This operation is not supported for Redis (cluster mode enabled) clusters.

" + }, + "CreateCacheParameterGroup":{ + "name":"CreateCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCacheParameterGroupMessage"}, + "output":{ + "shape":"CreateCacheParameterGroupResult", + "resultWrapper":"CreateCacheParameterGroupResult" + }, + "errors":[ + {"shape":"CacheParameterGroupQuotaExceededFault"}, + {"shape":"CacheParameterGroupAlreadyExistsFault"}, + {"shape":"InvalidCacheParameterGroupStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a new Amazon ElastiCache cache parameter group. An ElastiCache cache parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster or replication group using the CacheParameterGroup.

A newly created CacheParameterGroup is an exact duplicate of the default parameter group for the CacheParameterGroupFamily. To customize the newly created CacheParameterGroup you can change the values of specific parameters. For more information, see:

" + }, + "CreateCacheSecurityGroup":{ + "name":"CreateCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCacheSecurityGroupMessage"}, + "output":{ + "shape":"CreateCacheSecurityGroupResult", + "resultWrapper":"CreateCacheSecurityGroupResult" + }, + "errors":[ + {"shape":"CacheSecurityGroupAlreadyExistsFault"}, + {"shape":"CacheSecurityGroupQuotaExceededFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a new cache security group. Use a cache security group to control access to one or more clusters.

Cache security groups are only used when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC). If you are creating a cluster inside of a VPC, use a cache subnet group instead. For more information, see CreateCacheSubnetGroup.

" + }, + "CreateCacheSubnetGroup":{ + "name":"CreateCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCacheSubnetGroupMessage"}, + "output":{ + "shape":"CreateCacheSubnetGroupResult", + "resultWrapper":"CreateCacheSubnetGroupResult" + }, + "errors":[ + {"shape":"CacheSubnetGroupAlreadyExistsFault"}, + {"shape":"CacheSubnetGroupQuotaExceededFault"}, + {"shape":"CacheSubnetQuotaExceededFault"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Creates a new cache subnet group.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "CreateReplicationGroup":{ + "name":"CreateReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReplicationGroupMessage"}, + "output":{ + "shape":"CreateReplicationGroupResult", + "resultWrapper":"CreateReplicationGroupResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"ReplicationGroupAlreadyExistsFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"CacheSubnetGroupNotFoundFault"}, + {"shape":"ClusterQuotaForCustomerExceededFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"TagQuotaPerResourceExceeded"}, + {"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

" + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotMessage"}, + "output":{ + "shape":"CreateSnapshotResult", + "resultWrapper":"CreateSnapshotResult" + }, + "errors":[ + {"shape":"SnapshotAlreadyExistsFault"}, + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"SnapshotFeatureNotSupportedFault"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Creates a copy of an entire cluster or replication group at a specific moment in time.

This operation is valid for Redis only.

" + }, + "DecreaseReplicaCount":{ + "name":"DecreaseReplicaCount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecreaseReplicaCountMessage"}, + "output":{ + "shape":"DecreaseReplicaCountResult", + "resultWrapper":"DecreaseReplicaCountResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"ClusterQuotaForCustomerExceededFault"}, + {"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"ServiceLinkedRoleNotFoundFault"}, + {"shape":"NoOperationFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Dynamically decreases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

" + }, + "DeleteCacheCluster":{ + "name":"DeleteCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCacheClusterMessage"}, + "output":{ + "shape":"DeleteCacheClusterResult", + "resultWrapper":"DeleteCacheClusterResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"SnapshotAlreadyExistsFault"}, + {"shape":"SnapshotFeatureNotSupportedFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes a previously provisioned cluster. DeleteCacheCluster deletes all associated cache nodes, node endpoints and the cluster itself. When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the cluster; you cannot cancel or revert this operation.

This operation is not valid for:

  • Redis (cluster mode enabled) clusters

  • A cluster that is the last read replica of a replication group

  • A node group (shard) that has Multi-AZ mode enabled

  • A cluster from a Redis (cluster mode enabled) replication group

  • A cluster that is not in the available state

" + }, + "DeleteCacheParameterGroup":{ + "name":"DeleteCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCacheParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidCacheParameterGroupStateFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes the specified cache parameter group. You cannot delete a cache parameter group if it is associated with any cache clusters.

" + }, + "DeleteCacheSecurityGroup":{ + "name":"DeleteCacheSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCacheSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidCacheSecurityGroupStateFault"}, + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes a cache security group.

You cannot delete a cache security group if it is associated with any clusters.

" + }, + "DeleteCacheSubnetGroup":{ + "name":"DeleteCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCacheSubnetGroupMessage"}, + "errors":[ + {"shape":"CacheSubnetGroupInUse"}, + {"shape":"CacheSubnetGroupNotFoundFault"} + ], + "documentation":"

Deletes a cache subnet group.

You cannot delete a cache subnet group if it is associated with any clusters.

" + }, + "DeleteReplicationGroup":{ + "name":"DeleteReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReplicationGroupMessage"}, + "output":{ + "shape":"DeleteReplicationGroupResult", + "resultWrapper":"DeleteReplicationGroupResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"SnapshotAlreadyExistsFault"}, + {"shape":"SnapshotFeatureNotSupportedFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes an existing replication group. By default, this operation deletes the entire replication group, including the primary/primaries and all of the read replicas. If the replication group has only one primary, you can optionally delete only the read replicas, while retaining the primary by setting RetainPrimaryCluster=true.

When you receive a successful response from this operation, Amazon ElastiCache immediately begins deleting the selected resources; you cannot cancel or revert this operation.

This operation is valid for Redis only.

" + }, + "DeleteSnapshot":{ + "name":"DeleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotMessage"}, + "output":{ + "shape":"DeleteSnapshotResult", + "resultWrapper":"DeleteSnapshotResult" + }, + "errors":[ + {"shape":"SnapshotNotFoundFault"}, + {"shape":"InvalidSnapshotStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Deletes an existing snapshot. When you receive a successful response from this operation, ElastiCache immediately begins deleting the snapshot; you cannot cancel or revert this operation.

This operation is valid for Redis only.

" + }, + "DescribeCacheClusters":{ + "name":"DescribeCacheClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheClustersMessage"}, + "output":{ + "shape":"CacheClusterMessage", + "resultWrapper":"DescribeCacheClustersResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cache cluster if a cluster identifier is supplied.

By default, abbreviated information about the clusters is returned. You can use the optional ShowCacheNodeInfo flag to retrieve detailed information about the cache nodes associated with the clusters. These details include the DNS address and port for the cache node endpoint.

If the cluster is in the creating state, only cluster-level information is displayed until all of the nodes are successfully provisioned.

If the cluster is in the deleting state, only cluster-level information is displayed.

If cache nodes are currently being added to the cluster, node endpoint information and creation time for the additional nodes are not displayed until they are completely provisioned. When the cluster state is available, the cluster is ready for use.

If cache nodes are currently being removed from the cluster, no endpoint information for the removed nodes is displayed.

" + }, + "DescribeCacheEngineVersions":{ + "name":"DescribeCacheEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheEngineVersionsMessage"}, + "output":{ + "shape":"CacheEngineVersionMessage", + "resultWrapper":"DescribeCacheEngineVersionsResult" + }, + "documentation":"

Returns a list of the available cache engines and their versions.

" + }, + "DescribeCacheParameterGroups":{ + "name":"DescribeCacheParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheParameterGroupsMessage"}, + "output":{ + "shape":"CacheParameterGroupsMessage", + "resultWrapper":"DescribeCacheParameterGroupsResult" + }, + "errors":[ + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns a list of cache parameter group descriptions. If a cache parameter group name is specified, the list contains only the descriptions for that group.

" + }, + "DescribeCacheParameters":{ + "name":"DescribeCacheParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheParametersMessage"}, + "output":{ + "shape":"CacheParameterGroupDetails", + "resultWrapper":"DescribeCacheParametersResult" + }, + "errors":[ + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns the detailed parameter list for a particular cache parameter group.

" + }, + "DescribeCacheSecurityGroups":{ + "name":"DescribeCacheSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheSecurityGroupsMessage"}, + "output":{ + "shape":"CacheSecurityGroupMessage", + "resultWrapper":"DescribeCacheSecurityGroupsResult" + }, + "errors":[ + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

" + }, + "DescribeCacheSubnetGroups":{ + "name":"DescribeCacheSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheSubnetGroupsMessage"}, + "output":{ + "shape":"CacheSubnetGroupMessage", + "resultWrapper":"DescribeCacheSubnetGroupsResult" + }, + "errors":[ + {"shape":"CacheSubnetGroupNotFoundFault"} + ], + "documentation":"

Returns a list of cache subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group. This is applicable only when you have ElastiCache in VPC setup. All ElastiCache clusters now launch in VPC by default.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns the default engine and system parameter information for the specified cache engine.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

" + }, + "DescribeReplicationGroups":{ + "name":"DescribeReplicationGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReplicationGroupsMessage"}, + "output":{ + "shape":"ReplicationGroupMessage", + "resultWrapper":"DescribeReplicationGroupsResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

This operation is valid for Redis only.

" + }, + "DescribeReservedCacheNodes":{ + "name":"DescribeReservedCacheNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedCacheNodesMessage"}, + "output":{ + "shape":"ReservedCacheNodeMessage", + "resultWrapper":"DescribeReservedCacheNodesResult" + }, + "errors":[ + {"shape":"ReservedCacheNodeNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns information about reserved cache nodes for this account, or about a specified reserved cache node.

" + }, + "DescribeReservedCacheNodesOfferings":{ + "name":"DescribeReservedCacheNodesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedCacheNodesOfferingsMessage"}, + "output":{ + "shape":"ReservedCacheNodesOfferingMessage", + "resultWrapper":"DescribeReservedCacheNodesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedCacheNodesOfferingNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Lists available reserved cache node offerings.

" + }, + "DescribeServiceUpdates":{ + "name":"DescribeServiceUpdates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceUpdatesMessage"}, + "output":{ + "shape":"ServiceUpdatesMessage", + "resultWrapper":"DescribeServiceUpdatesResult" + }, + "errors":[ + {"shape":"ServiceUpdateNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns details of the service updates

" + }, + "DescribeSnapshots":{ + "name":"DescribeSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotsMessage"}, + "output":{ + "shape":"DescribeSnapshotsListMessage", + "resultWrapper":"DescribeSnapshotsResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"SnapshotNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns information about cluster or replication group snapshots. By default, DescribeSnapshots lists all of your snapshots; it can optionally describe a single snapshot, or just the snapshots associated with a particular cache cluster.

This operation is valid for Redis only.

" + }, + "DescribeUpdateActions":{ + "name":"DescribeUpdateActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUpdateActionsMessage"}, + "output":{ + "shape":"UpdateActionsMessage", + "resultWrapper":"DescribeUpdateActionsResult" + }, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Returns details of the update actions

" + }, + "IncreaseReplicaCount":{ + "name":"IncreaseReplicaCount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IncreaseReplicaCountMessage"}, + "output":{ + "shape":"IncreaseReplicaCountResult", + "resultWrapper":"IncreaseReplicaCountResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"ClusterQuotaForCustomerExceededFault"}, + {"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"NoOperationFault"}, + {"shape":"InvalidKMSKeyFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Dynamically increases the number of replics in a Redis (cluster mode disabled) replication group or the number of replica nodes in one or more node groups (shards) of a Redis (cluster mode enabled) replication group. This operation is performed with no cluster down time.

" + }, + "ListAllowedNodeTypeModifications":{ + "name":"ListAllowedNodeTypeModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAllowedNodeTypeModificationsMessage"}, + "output":{ + "shape":"AllowedNodeTypeModificationsMessage", + "resultWrapper":"ListAllowedNodeTypeModificationsResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidParameterCombinationException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Lists all available node types that you can scale your Redis cluster's or replication group's current node type.

When you use the ModifyCacheCluster or ModifyReplicationGroup operations to scale your cluster or replication group, the value of the CacheNodeType parameter must be one of the node types returned by this operation.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"SnapshotNotFoundFault"}, + {"shape":"InvalidARNFault"} + ], + "documentation":"

Lists all cost allocation tags currently on the named resource. A cost allocation tag is a key-value pair where the key is case-sensitive and the value is optional. You can use cost allocation tags to categorize and track your AWS costs.

If the cluster is not in the available state, ListTagsForResource returns an error.

You can have a maximum of 50 cost allocation tags on an ElastiCache resource. For more information, see Monitoring Costs with Tags.

" + }, + "ModifyCacheCluster":{ + "name":"ModifyCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCacheClusterMessage"}, + "output":{ + "shape":"ModifyCacheClusterResult", + "resultWrapper":"ModifyCacheClusterResult" + }, + "errors":[ + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidCacheSecurityGroupStateFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the settings for a cluster. You can use this operation to change one or more cluster configuration parameters by specifying the parameters and the new values.

" + }, + "ModifyCacheParameterGroup":{ + "name":"ModifyCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCacheParameterGroupMessage"}, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "resultWrapper":"ModifyCacheParameterGroupResult" + }, + "errors":[ + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidCacheParameterGroupStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the parameters of a cache parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.

" + }, + "ModifyCacheSubnetGroup":{ + "name":"ModifyCacheSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCacheSubnetGroupMessage"}, + "output":{ + "shape":"ModifyCacheSubnetGroupResult", + "resultWrapper":"ModifyCacheSubnetGroupResult" + }, + "errors":[ + {"shape":"CacheSubnetGroupNotFoundFault"}, + {"shape":"CacheSubnetQuotaExceededFault"}, + {"shape":"SubnetInUse"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Modifies an existing cache subnet group.

" + }, + "ModifyReplicationGroup":{ + "name":"ModifyReplicationGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReplicationGroupMessage"}, + "output":{ + "shape":"ModifyReplicationGroupResult", + "resultWrapper":"ModifyReplicationGroupResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidCacheSecurityGroupStateFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"NodeQuotaForClusterExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidKMSKeyFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the settings for a replication group.

For Redis (cluster mode enabled) clusters, this operation cannot be used to change a cluster's node type or engine version. For more information, see:

This operation is valid for Redis only.

" + }, + "ModifyReplicationGroupShardConfiguration":{ + "name":"ModifyReplicationGroupShardConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyReplicationGroupShardConfigurationMessage"}, + "output":{ + "shape":"ModifyReplicationGroupShardConfigurationResult", + "resultWrapper":"ModifyReplicationGroupShardConfigurationResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InsufficientCacheClusterCapacityFault"}, + {"shape":"NodeGroupsPerReplicationGroupQuotaExceededFault"}, + {"shape":"NodeQuotaForCustomerExceededFault"}, + {"shape":"InvalidKMSKeyFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.

" + }, + "PurchaseReservedCacheNodesOffering":{ + "name":"PurchaseReservedCacheNodesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedCacheNodesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedCacheNodesOfferingResult", + "resultWrapper":"PurchaseReservedCacheNodesOfferingResult" + }, + "errors":[ + {"shape":"ReservedCacheNodesOfferingNotFoundFault"}, + {"shape":"ReservedCacheNodeAlreadyExistsFault"}, + {"shape":"ReservedCacheNodeQuotaExceededFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Allows you to purchase a reserved cache node offering.

" + }, + "RebootCacheCluster":{ + "name":"RebootCacheCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootCacheClusterMessage"}, + "output":{ + "shape":"RebootCacheClusterResult", + "resultWrapper":"RebootCacheClusterResult" + }, + "errors":[ + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"CacheClusterNotFoundFault"} + ], + "documentation":"

Reboots some, or all, of the cache nodes within a provisioned cluster. This operation applies any modified cache parameter groups to the cluster. The reboot operation takes place as soon as possible, and results in a momentary outage to the cluster. During the reboot, the cluster status is set to REBOOTING.

The reboot causes the contents of the cache (for each cache node being rebooted) to be lost.

When the reboot is complete, a cluster event is created.

Rebooting a cluster is currently supported on Memcached and Redis (cluster mode disabled) clusters. Rebooting is not supported on Redis (cluster mode enabled) clusters.

If you make changes to parameters that require a Redis (cluster mode enabled) cluster reboot for the changes to be applied, see Rebooting a Cluster for an alternate process.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"RemoveTagsFromResourceResult" + }, + "errors":[ + {"shape":"CacheClusterNotFoundFault"}, + {"shape":"SnapshotNotFoundFault"}, + {"shape":"InvalidARNFault"}, + {"shape":"TagNotFoundFault"} + ], + "documentation":"

Removes the tags identified by the TagKeys list from the named resource.

" + }, + "ResetCacheParameterGroup":{ + "name":"ResetCacheParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetCacheParameterGroupMessage"}, + "output":{ + "shape":"CacheParameterGroupNameMessage", + "resultWrapper":"ResetCacheParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidCacheParameterGroupStateFault"}, + {"shape":"CacheParameterGroupNotFoundFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Modifies the parameters of a cache parameter group to the engine or system default value. You can reset specific parameters by submitting a list of parameter names. To reset the entire cache parameter group, specify the ResetAllParameters and CacheParameterGroupName parameters.

" + }, + "RevokeCacheSecurityGroupIngress":{ + "name":"RevokeCacheSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeCacheSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeCacheSecurityGroupIngressResult", + "resultWrapper":"RevokeCacheSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"CacheSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidCacheSecurityGroupStateFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Revokes ingress from a cache security group. Use this operation to disallow access from an Amazon EC2 security group that had been previously authorized.

" + }, + "StartMigration":{ + "name":"StartMigration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMigrationMessage"}, + "output":{ + "shape":"StartMigrationResponse", + "resultWrapper":"StartMigrationResult" + }, + "errors":[ + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"ReplicationGroupAlreadyUnderMigrationFault"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Start the migration of data.

" + }, + "TestFailover":{ + "name":"TestFailover", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestFailoverMessage"}, + "output":{ + "shape":"TestFailoverResult", + "resultWrapper":"TestFailoverResult" + }, + "errors":[ + {"shape":"APICallRateForCustomerExceededFault"}, + {"shape":"InvalidCacheClusterStateFault"}, + {"shape":"InvalidReplicationGroupStateFault"}, + {"shape":"NodeGroupNotFoundFault"}, + {"shape":"ReplicationGroupNotFoundFault"}, + {"shape":"TestFailoverNotAvailableFault"}, + {"shape":"InvalidKMSKeyFault"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} + ], + "documentation":"

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>

    2. Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed

    3. Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed

    4. Cache cluster message: Recovering cache nodes <node-id>

    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

" + } + }, + "shapes":{ + "APICallRateForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The customer has exceeded the allowed rate of API calls.

", + "error":{ + "code":"APICallRateForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AZMode":{ + "type":"string", + "enum":[ + "single-az", + "cross-az" + ] + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which the tags are to be added, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot. ElastiCache resources are cluster and snapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of cost allocation tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value.

" + } + }, + "documentation":"

Represents the input of an AddTagsToResource operation.

" + }, + "AllowedNodeGroupId":{ + "type":"string", + "max":4, + "min":1, + "pattern":"\\d+" + }, + "AllowedNodeTypeModificationsMessage":{ + "type":"structure", + "members":{ + "ScaleUpModifications":{ + "shape":"NodeTypeList", + "documentation":"

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

When scaling up a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

" + }, + "ScaleDownModifications":{ + "shape":"NodeTypeList", + "documentation":"

A string list, each element of which specifies a cache node type which you can use to scale your cluster or replication group.

When scaling down on a Redis cluster or replication group using ModifyCacheCluster or ModifyReplicationGroup, use a value from this list for the CacheNodeType parameter.

" + } + }, + "documentation":"

Represents the allowed node types you can use to modify your cluster or replication group.

" + }, + "AuthTokenUpdateStatus":{ + "type":"string", + "enum":[ + "SETTING", + "ROTATING" + ] + }, + "AuthTokenUpdateStrategyType":{ + "type":"string", + "enum":[ + "SET", + "ROTATE" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon EC2 security group is already authorized for the specified cache security group.

", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Amazon EC2 security group is not authorized for the specified cache security group.

", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AuthorizeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The cache security group that allows network ingress.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The Amazon EC2 security group to be authorized for ingress to the cache security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of an AuthorizeCacheSecurityGroupIngress operation.

" + }, + "AuthorizeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "AutomaticFailoverStatus":{ + "type":"string", + "enum":[ + "enabled", + "disabled", + "enabling", + "disabling" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the Availability Zone.

" + } + }, + "documentation":"

Describes an Availability Zone in which the cluster is launched.

", + "wrapper":true + }, + "AvailabilityZonesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "AwsQueryErrorMessage":{"type":"string"}, + "BatchApplyUpdateActionMessage":{ + "type":"structure", + "required":["ServiceUpdateName"], + "members":{ + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "CacheClusterIds":{ + "shape":"CacheClusterIdList", + "documentation":"

The cache cluster IDs

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + } + } + }, + "BatchStopUpdateActionMessage":{ + "type":"structure", + "required":["ServiceUpdateName"], + "members":{ + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "CacheClusterIds":{ + "shape":"CacheClusterIdList", + "documentation":"

The cache cluster IDs

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + } + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CacheCluster":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the cluster. This identifier is a unique key that identifies a cluster.

" + }, + "ConfigurationEndpoint":{ + "shape":"Endpoint", + "documentation":"

Represents a Memcached cluster endpoint which, if Automatic Discovery is enabled on the cluster, can be used by an application to connect to any node in the cluster. The configuration endpoint will always have .cfg in it.

Example: mem-3.9dvc4r.cfg.usw2.cache.amazonaws.com:11211

" + }, + "ClientDownloadLandingPage":{ + "shape":"String", + "documentation":"

The URL of the web page where you can download the latest ElastiCache client library.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) to be used for this cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine that is used in this cluster.

" + }, + "CacheClusterStatus":{ + "shape":"String", + "documentation":"

The current state of this cluster, one of the following values: available, creating, deleted, deleting, incompatible-network, modifying, rebooting cluster nodes, restore-failed, or snapshotting.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the cluster is located or \"Multiple\" if the cache nodes are located in different Availability Zones.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "PendingModifiedValues":{"shape":"PendingModifiedValues"}, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroupMembershipList", + "documentation":"

A list of cache security group elements, composed of name and status sub-elements.

" + }, + "CacheParameterGroup":{ + "shape":"CacheParameterGroupStatus", + "documentation":"

Status of the cache parameter group.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the cluster.

" + }, + "CacheNodes":{ + "shape":"CacheNodeList", + "documentation":"

A list of cache nodes that are members of the cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

This parameter is currently disabled.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroupMembershipList", + "documentation":"

A list of VPC Security Groups associated with the cluster.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group to which this cluster belongs. If this field is empty, the cluster is not associated with any replication group.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

Example: 05:00-09:00

" + }, + "AuthTokenEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

" + }, + "AuthTokenLastModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date the auth token was last modified

" + }, + "TransitEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

" + }, + "AtRestEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable at-rest encryption on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

" + } + }, + "documentation":"

Contains all of the attributes of a specific cluster.

", + "wrapper":true + }, + "CacheClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a cluster with the given identifier.

", + "error":{ + "code":"CacheClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheClusterIdList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20 + }, + "CacheClusterList":{ + "type":"list", + "member":{ + "shape":"CacheCluster", + "locationName":"CacheCluster" + } + }, + "CacheClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheClusters":{ + "shape":"CacheClusterList", + "documentation":"

A list of clusters. Each item in the list contains detailed information about one cluster.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheClusters operation.

" + }, + "CacheClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cluster ID does not refer to an existing cluster.

", + "error":{ + "code":"CacheClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CacheEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family associated with this cache engine.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" + }, + "CacheEngineDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine.

" + }, + "CacheEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the cache engine version.

" + } + }, + "documentation":"

Provides all of the details about a particular cache engine version.

" + }, + "CacheEngineVersionList":{ + "type":"list", + "member":{ + "shape":"CacheEngineVersion", + "locationName":"CacheEngineVersion" + } + }, + "CacheEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheEngineVersions":{ + "shape":"CacheEngineVersionList", + "documentation":"

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheEngineVersions operation.

" + }, + "CacheNode":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier. A node ID is a numeric identifier (0001, 0002, etc.). The combination of cluster ID and node ID uniquely identifies every cache node used in a customer's AWS account.

" + }, + "CacheNodeStatus":{ + "shape":"String", + "documentation":"

The current state of this cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The hostname for connecting to this cache node.

" + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

The status of the parameter group applied to this cache node.

" + }, + "SourceCacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the primary node to which this read replica node is synchronized. If this field is empty, this node is not associated with a primary cluster.

" + }, + "CustomerAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where this node was created and now resides.

" + } + }, + "documentation":"

Represents an individual cache node within a cluster. Each cache node runs its own instance of the cluster's protocol-compliant caching software - either Memcached or Redis.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "CacheNodeIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheNodeId" + } + }, + "CacheNodeList":{ + "type":"list", + "member":{ + "shape":"CacheNode", + "locationName":"CacheNode" + } + }, + "CacheNodeTypeSpecificParameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter value.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + }, + "CacheNodeTypeSpecificValues":{ + "shape":"CacheNodeTypeSpecificValueList", + "documentation":"

A list of cache node types and their corresponding values for this parameter.

" + }, + "ChangeType":{ + "shape":"ChangeType", + "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" + } + }, + "documentation":"

A parameter that has a different value for each cache node type it is applied to. For example, in a Redis cluster, a cache.m1.large cache node type would have a larger maxmemory value than a cache.m1.small type.

" + }, + "CacheNodeTypeSpecificParametersList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificParameter", + "locationName":"CacheNodeTypeSpecificParameter" + } + }, + "CacheNodeTypeSpecificValue":{ + "type":"structure", + "members":{ + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for which this value applies.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value for the cache node type.

" + } + }, + "documentation":"

A value that applies only to a certain cache node type.

" + }, + "CacheNodeTypeSpecificValueList":{ + "type":"list", + "member":{ + "shape":"CacheNodeTypeSpecificValue", + "locationName":"CacheNodeTypeSpecificValue" + } + }, + "CacheNodeUpdateStatus":{ + "type":"structure", + "members":{ + "CacheNodeId":{ + "shape":"String", + "documentation":"

The node ID of the cache cluster

" + }, + "NodeUpdateStatus":{ + "shape":"NodeUpdateStatus", + "documentation":"

The update status of the node

" + }, + "NodeDeletionDate":{ + "shape":"TStamp", + "documentation":"

The deletion date of the node

" + }, + "NodeUpdateStartDate":{ + "shape":"TStamp", + "documentation":"

The start date of the update for a node

" + }, + "NodeUpdateEndDate":{ + "shape":"TStamp", + "documentation":"

The end date of the update for a node

" + }, + "NodeUpdateInitiatedBy":{ + "shape":"NodeUpdateInitiatedBy", + "documentation":"

Reflects whether the update was initiated by the customer or automatically applied

" + }, + "NodeUpdateInitiatedDate":{ + "shape":"TStamp", + "documentation":"

The date when the update is triggered

" + }, + "NodeUpdateStatusModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date when the NodeUpdateStatus was last modified>

" + } + }, + "documentation":"

The status of the service update on the cache node

" + }, + "CacheNodeUpdateStatusList":{ + "type":"list", + "member":{ + "shape":"CacheNodeUpdateStatus", + "locationName":"CacheNodeUpdateStatus" + } + }, + "CacheParameterGroup":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family that this cache parameter group is compatible with.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for this cache parameter group.

" + } + }, + "documentation":"

Represents the output of a CreateCacheParameterGroup operation.

", + "wrapper":true + }, + "CacheParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

A cache parameter group with the requested name already exists.

", + "error":{ + "code":"CacheParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheParameterGroupDetails":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter instances.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameters operation.

" + }, + "CacheParameterGroupList":{ + "type":"list", + "member":{ + "shape":"CacheParameterGroup", + "locationName":"CacheParameterGroup" + } + }, + "CacheParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + } + }, + "documentation":"

Represents the output of one of the following operations:

  • ModifyCacheParameterGroup

  • ResetCacheParameterGroup

" + }, + "CacheParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache parameter group name does not refer to an existing cache parameter group.

", + "error":{ + "code":"CacheParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CacheParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the maximum number of cache security groups.

", + "error":{ + "code":"CacheParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheParameterGroupStatus":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of the cache node IDs which need to be rebooted for parameter changes to be applied. A node ID is a numeric identifier (0001, 0002, etc.).

" + } + }, + "documentation":"

Status of the cache parameter group.

" + }, + "CacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheParameterGroups":{ + "shape":"CacheParameterGroupList", + "documentation":"

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheParameterGroups operation.

" + }, + "CacheSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the cache security group owner.

" + }, + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the cache security group.

" + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

A list of Amazon EC2 security groups that are associated with this cache security group.

" + } + }, + "documentation":"

Represents the output of one of the following operations:

  • AuthorizeCacheSecurityGroupIngress

  • CreateCacheSecurityGroup

  • RevokeCacheSecurityGroupIngress

", + "wrapper":true + }, + "CacheSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

A cache security group with the specified name already exists.

", + "error":{ + "code":"CacheSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSecurityGroupMembership":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The membership status in the cache security group. The status changes when a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

" + } + }, + "documentation":"

Represents a cluster's status within a particular cache security group.

" + }, + "CacheSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroupMembership", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSecurityGroups":{ + "shape":"CacheSecurityGroups", + "documentation":"

A list of cache security groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSecurityGroups operation.

" + }, + "CacheSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"CacheSecurityGroupName" + } + }, + "CacheSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache security group name does not refer to an existing cache security group.

", + "error":{ + "code":"CacheSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CacheSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache security groups.

", + "error":{ + "code":"QuotaExceeded.CacheSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSecurityGroups":{ + "type":"list", + "member":{ + "shape":"CacheSecurityGroup", + "locationName":"CacheSecurityGroup" + } + }, + "CacheSubnetGroup":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group.

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description of the cache subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

A list of subnets associated with the cache subnet group.

" + } + }, + "documentation":"

Represents the output of one of the following operations:

  • CreateCacheSubnetGroup

  • ModifyCacheSubnetGroup

", + "wrapper":true + }, + "CacheSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache subnet group name is already in use by an existing cache subnet group.

", + "error":{ + "code":"CacheSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSubnetGroupInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache subnet group is currently in use.

", + "error":{ + "code":"CacheSubnetGroupInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "CacheSubnetGroups":{ + "shape":"CacheSubnetGroups", + "documentation":"

A list of cache subnet groups. Each element in the list contains detailed information about one group.

" + } + }, + "documentation":"

Represents the output of a DescribeCacheSubnetGroups operation.

" + }, + "CacheSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache subnet group name does not refer to an existing cache subnet group.

", + "error":{ + "code":"CacheSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache subnet groups.

", + "error":{ + "code":"CacheSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CacheSubnetGroups":{ + "type":"list", + "member":{ + "shape":"CacheSubnetGroup", + "locationName":"CacheSubnetGroup" + } + }, + "CacheSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of subnets in a cache subnet group.

", + "error":{ + "code":"CacheSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ChangeType":{ + "type":"string", + "enum":[ + "immediate", + "requires-reboot" + ] + }, + "ClusterIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterId" + } + }, + "ClusterQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of clusters per customer.

", + "error":{ + "code":"ClusterQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CompleteMigrationMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group to which data is being migrated.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Forces the migration to stop without ensuring that data is in sync. It is recommended to use this option only to abort the migration and not recommended when application wants to continue migration to ElastiCache.

" + } + } + }, + "CompleteMigrationResponse":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "ConfigureShard":{ + "type":"structure", + "required":[ + "NodeGroupId", + "NewReplicaCount" + ], + "members":{ + "NodeGroupId":{ + "shape":"AllowedNodeGroupId", + "documentation":"

The 4-digit id for the node group you are configuring. For Redis (cluster mode disabled) replication groups, the node group id is always 0001. To find a Redis (cluster mode enabled)'s node group's (shard's) id, see Finding a Shard's Id.

" + }, + "NewReplicaCount":{ + "shape":"Integer", + "documentation":"

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ with Automatic Failover is enabled: 1

    • If Multi-AZ with Automatic Failover is not enable: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" + }, + "PreferredAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

A list of PreferredAvailabilityZone strings that specify which availability zones the replication group's nodes are to be in. The nummber of PreferredAvailabilityZone values must equal the value of NewReplicaCount plus 1 to account for the primary node. If this member of ReplicaConfiguration is omitted, ElastiCache for Redis selects the availability zone for each of the replicas.

" + } + }, + "documentation":"

Node group (shard) configuration options when adding or removing replicas. Each node group (shard) configuration has the following members: NodeGroupId, NewReplicaCount, and PreferredAvailabilityZones.

" + }, + "CopySnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotName", + "TargetSnapshotName" + ], + "members":{ + "SourceSnapshotName":{ + "shape":"String", + "documentation":"

The name of an existing snapshot from which to make a copy.

" + }, + "TargetSnapshotName":{ + "shape":"String", + "documentation":"

A name for the snapshot copy. ElastiCache does not permit overwriting a snapshot, therefore this name must be unique within its context - ElastiCache or an Amazon S3 bucket if exporting.

" + }, + "TargetBucket":{ + "shape":"String", + "documentation":"

The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access.

When using this parameter to export a snapshot, be sure Amazon ElastiCache has the needed permissions to this S3 bucket. For more information, see Step 2: Grant ElastiCache Access to Your Amazon S3 Bucket in the Amazon ElastiCache User Guide.

For more information, see Exporting a Snapshot in the Amazon ElastiCache User Guide.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ID of the KMS key used to encrypt the target snapshot.

" + } + }, + "documentation":"

Represents the input of a CopySnapshotMessage operation.

" + }, + "CopySnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The node group (shard) identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 50 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group.

If the specified replication group is Multi-AZ enabled and the Availability Zone is not specified, the cluster is created in Availability Zones that provide the best spread of read replicas across Availability Zones.

This parameter is only valid if the Engine parameter is redis.

" + }, + "AZMode":{ + "shape":"AZMode", + "documentation":"

Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.

This parameter is only supported for Memcached clusters.

If the AZMode and PreferredAvailabilityZones are not specified, ElastiCache assumes single-az mode.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone in which the cluster is created.

All nodes belonging to this Memcached cluster are placed in the preferred Availability Zone. If you want to create your nodes across multiple Availability Zones, use PreferredAvailabilityZones.

Default: System chosen Availability Zone.

" + }, + "PreferredAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

A list of the Availability Zones in which cache nodes are created. The order of the zones in the list is not important.

This option is only supported on Memcached.

If you are creating your cluster in an Amazon VPC (recommended) you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheNodes.

If you want all the nodes in the same Availability Zone, use PreferredAvailabilityZone instead, or repeat the Availability Zone multiple times in the list.

Default: System chosen Availability Zones.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The initial number of cache nodes that the cluster has.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

If you need more than 20 nodes for your Memcached cluster, please fill out the ElastiCache Limit Increase Request form at http://aws.amazon.com/contact-us/elasticache-node-limit-request/.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine to be used for this cluster.

Valid values for this parameter are: memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine to be used for this cluster. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to associate with this cluster. If this argument is omitted, the default parameter group for the specified engine is used. You cannot use any parameter group which has cluster-enabled='yes' when creating a cluster.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the subnet group to be used for the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of security group names to associate with this cluster.

Use this parameter only when you are creating a cluster outside of an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

One or more VPC security groups associated with the cluster.

Use this parameter only when you are creating a cluster in an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of cost allocation tags to be added to this resource.

" + }, + "SnapshotArns":{ + "shape":"SnapshotArnsList", + "documentation":"

A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Redis RDB snapshot file stored in Amazon S3. The snapshot file is used to populate the node group (shard). The Amazon S3 object name in the ARN cannot contain any commas.

This parameter is only valid if the Engine parameter is redis.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a Redis snapshot from which to restore data into the new node group (shard). The snapshot status changes to restoring while the new node group (shard) is being created.

This parameter is only valid if the Engine parameter is redis.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which each of the cache nodes accepts connections.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

This parameter is currently disabled.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot taken today is retained for 5 days before being deleted.

This parameter is only valid if the Engine parameter is redis.

Default: 0 (i.e., automatic backups are disabled for this cache cluster).

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

" + }, + "AuthToken":{ + "shape":"String", + "documentation":"

Reserved parameter. The password used to access a password protected server.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

" + } + }, + "documentation":"

Represents the input of a CreateCacheCluster operation.

" + }, + "CreateCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "CreateCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "CacheParameterGroupFamily", + "Description" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

A user-specified name for the cache parameter group.

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family that the cache parameter group can be used with.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" + }, + "Description":{ + "shape":"String", + "documentation":"

A user-specified description for the cache parameter group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheParameterGroup operation.

" + }, + "CreateCacheParameterGroupResult":{ + "type":"structure", + "members":{ + "CacheParameterGroup":{"shape":"CacheParameterGroup"} + } + }, + "CreateCacheSecurityGroupMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "Description" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

A name for the cache security group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters. Cannot be the word \"Default\".

Example: mysecuritygroup

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the cache security group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSecurityGroup operation.

" + }, + "CreateCacheSecurityGroupResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "CreateCacheSubnetGroupMessage":{ + "type":"structure", + "required":[ + "CacheSubnetGroupName", + "CacheSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

A name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description for the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

A list of VPC subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a CreateCacheSubnetGroup operation.

" + }, + "CreateCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "CreateReplicationGroupMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "ReplicationGroupDescription" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group identifier. This parameter is stored as a lowercase string.

Constraints:

  • A name must contain from 1 to 40 alphanumeric characters or hyphens.

  • The first character must be a letter.

  • A name cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A user-created description for the replication group.

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The identifier of the cluster that serves as the primary for this replication group. This cluster must already exist and have a status of available.

This parameter is not required if NumCacheClusters, NumNodeGroups, or ReplicasPerNodeGroup is specified.

" + }, + "AutomaticFailoverEnabled":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

If true, Multi-AZ is enabled for this replication group. If false, Multi-AZ is disabled for this replication group.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + }, + "NumCacheClusters":{ + "shape":"IntegerOptional", + "documentation":"

The number of clusters this replication group initially has.

This parameter is not used if there is more than one node group (shard). You should use ReplicasPerNodeGroup instead.

If AutomaticFailoverEnabled is true, the value of this parameter must be at least 2. If AutomaticFailoverEnabled is false you can omit this parameter (it will default to 1), or you can explicitly set it to a value between 2 and 6.

The maximum permitted value for NumCacheClusters is 6 (1 primary plus 5 replicas).

" + }, + "PreferredCacheClusterAZs":{ + "shape":"AvailabilityZonesList", + "documentation":"

A list of EC2 Availability Zones in which the replication group's clusters are created. The order of the Availability Zones in the list is the order in which clusters are allocated. The primary cluster is created in the first AZ in the list.

This parameter is not used if there is more than one node group (shard). You should use NodeGroupConfiguration instead.

If you are creating your replication group in an Amazon VPC (recommended), you can only locate clusters in Availability Zones associated with the subnets in the selected subnet group.

The number of Availability Zones listed must equal the value of NumCacheClusters.

Default: system chosen Availability Zones.

" + }, + "NumNodeGroups":{ + "shape":"IntegerOptional", + "documentation":"

An optional parameter that specifies the number of node groups (shards) for this Redis (cluster mode enabled) replication group. For Redis (cluster mode disabled) either omit this parameter or set it to 1.

Default: 1

" + }, + "ReplicasPerNodeGroup":{ + "shape":"IntegerOptional", + "documentation":"

An optional parameter that specifies the number of replica nodes in each node group (shard). Valid values are 0 to 5.

" + }, + "NodeGroupConfiguration":{ + "shape":"NodeGroupConfigurationList", + "documentation":"

A list of node group (shard) configuration options. Each node group (shard) configuration has the following members: PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount, and Slots.

If you're creating a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group, you can use this parameter to individually configure each node group (shard), or you can omit this parameter. However, when seeding a Redis (cluster mode enabled) cluster from a S3 rdb file, you must configure each node group (shard) using this parameter because you must specify the slots for each node group.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the nodes in the node group (shard).

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine to be used for the clusters in this replication group.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the DescribeCacheEngineVersions operation.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version) in the ElastiCache User Guide, but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used.

If you are restoring to an engine version that is different than the original, you must specify the default version of that version. For example, CacheParameterGroupName=default.redis4.0.

If you are running Redis version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name.

  • To create a Redis (cluster mode disabled) replication group, use CacheParameterGroupName=default.redis3.2.

  • To create a Redis (cluster mode enabled) replication group, use CacheParameterGroupName=default.redis3.2.cluster.on.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to be used for the replication group.

If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see Subnets and Subnet Groups.

" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to associate with this replication group.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

One or more Amazon VPC security groups associated with this replication group.

Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of cost allocation tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key=myKey, Value=myKeyValue. You can include multiple tags as shown following: Key=myKey, Value=myKeyValue Key=mySecondKey, Value=mySecondKeyValue.

" + }, + "SnapshotArns":{ + "shape":"SnapshotArnsList", + "documentation":"

A list of Amazon Resource Names (ARN) that uniquely identify the Redis RDB snapshot files stored in Amazon S3. The snapshot files are used to populate the new replication group. The Amazon S3 object name in the ARN cannot contain any commas. The new replication group will have the number of node groups (console: shards) specified by the parameter NumNodeGroups or the number of node groups configured by NodeGroupConfiguration regardless of the number of ARNs specified here.

Example of an Amazon S3 ARN: arn:aws:s3:::my_bucket/snapshot1.rdb

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot from which to restore data into the new replication group. The snapshot status changes to restoring while the new replication group is being created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which each member of the replication group accepts connections.

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.

The Amazon SNS topic owner must be the same as the cluster owner.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

This parameter is currently disabled.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Default: 0 (i.e., automatic backups are disabled for this cluster).

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" + }, + "AuthToken":{ + "shape":"String", + "documentation":"

Reserved parameter. The password used to access a password protected server.

AuthToken can be specified only on replication groups where TransitEncryptionEnabled is true.

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

Password constraints:

  • Must be only printable ASCII characters.

  • Must be at least 16 characters and no more than 128 characters in length.

  • The only permitted printable special characters are !, &, #, $, ^, <, >, and -. Other printable special characters cannot be used in the AUTH token.

For more information, see AUTH password at http://redis.io/commands/AUTH.

" + }, + "TransitEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

This parameter is valid only if the Engine parameter is redis, the EngineVersion parameter is 3.2.6, 4.x or later, and the cluster is being created in an Amazon VPC.

If you enable in-transit encryption, you must also specify a value for CacheSubnetGroup.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

For HIPAA compliance, you must specify TransitEncryptionEnabled as true, an AuthToken, and a CacheSubnetGroup.

" + }, + "AtRestEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables encryption at rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the replication group is created. To enable encryption at rest on a replication group you must set AtRestEncryptionEnabled to true when you create the replication group.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ID of the KMS key used to encrypt the disk on the cluster.

" + } + }, + "documentation":"

Represents the input of a CreateReplicationGroup operation.

" + }, + "CreateReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "CreateSnapshotMessage":{ + "type":"structure", + "required":["SnapshotName"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier of an existing replication group. The snapshot is created from this replication group.

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The identifier of an existing cluster. The snapshot is created from this cluster.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A name for the snapshot being created.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "documentation":"

Represents the input of a CreateSnapshot operation.

" + }, + "CreateSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CustomerNodeEndpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

The address of the node endpoint

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port of the node endpoint

" + } + }, + "documentation":"

The endpoint from which data should be migrated.

" + }, + "CustomerNodeEndpointList":{ + "type":"list", + "member":{"shape":"CustomerNodeEndpoint"} + }, + "DecreaseReplicaCountMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "ApplyImmediately" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The id of the replication group from which you want to remove replica nodes.

" + }, + "NewReplicaCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ with Automatic Failover is enabled: 1

    • If Multi-AZ with Automatic Failover is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" + }, + "ReplicaConfiguration":{ + "shape":"ReplicaConfigurationList", + "documentation":"

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

" + }, + "ReplicasToRemove":{ + "shape":"RemoveReplicasList", + "documentation":"

A list of the node ids to remove from the replication group or node group (shard).

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If True, the number of replica nodes is decreased immediately. ApplyImmediately=False is not currently supported.

" + } + } + }, + "DecreaseReplicaCountResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "DeleteCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cluster identifier for the cluster to be deleted. This parameter is not case sensitive.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied name of a final cluster snapshot. This is the unique name that identifies the snapshot. ElastiCache creates the snapshot, and then deletes the cluster immediately afterward.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheCluster operation.

" + }, + "DeleteCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "DeleteCacheParameterGroupMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to delete.

The specified cache security group must not be associated with any clusters.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheParameterGroup operation.

" + }, + "DeleteCacheSecurityGroupMessage":{ + "type":"structure", + "required":["CacheSecurityGroupName"], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to delete.

You cannot delete the default security group.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSecurityGroup operation.

" + }, + "DeleteCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to delete.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

" + } + }, + "documentation":"

Represents the input of a DeleteCacheSubnetGroup operation.

" + }, + "DeleteReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the cluster to be deleted. This parameter is not case sensitive.

" + }, + "RetainPrimaryCluster":{ + "shape":"BooleanOptional", + "documentation":"

If set to true, all of the read replicas are deleted, but the primary node is retained.

" + }, + "FinalSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The name of a final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster, rather than one of the replicas; this is to ensure that it captures the freshest data. After the final snapshot is taken, the replication group is immediately deleted.

" + } + }, + "documentation":"

Represents the input of a DeleteReplicationGroup operation.

" + }, + "DeleteReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "DeleteSnapshotMessage":{ + "type":"structure", + "required":["SnapshotName"], + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of the snapshot to be deleted.

" + } + }, + "documentation":"

Represents the input of a DeleteSnapshot operation.

" + }, + "DeleteSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DescribeCacheClustersMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied cluster identifier. If this parameter is specified, only information about that specific cluster is returned. This parameter isn't case sensitive.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ShowCacheNodeInfo":{ + "shape":"BooleanOptional", + "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to retrieve information about the individual cache nodes.

" + }, + "ShowCacheClustersNotInReplicationGroups":{ + "shape":"BooleanOptional", + "documentation":"

An optional flag that can be included in the DescribeCacheCluster request to show only nodes (API/CLI: clusters) that are not members of a replication group. In practice, this mean Memcached and single node Redis clusters.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheClusters operation.

" + }, + "DescribeCacheEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The cache engine to return. Valid values: memcached | redis

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The cache engine version to return.

Example: 1.4.14

" + }, + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group family to return details for.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

Constraints:

  • Must be 1 to 255 alphanumeric characters

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheEngineVersions operation.

" + }, + "DescribeCacheParameterGroupsMessage":{ + "type":"structure", + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameterGroups operation.

" + }, + "DescribeCacheParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific cache parameter group to return details for.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Valid values: user | system | engine-default

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheParameters operation.

" + }, + "DescribeCacheSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSecurityGroups operation.

" + }, + "DescribeCacheSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group to return details for.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeCacheSubnetGroups operation.

" + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["CacheParameterGroupFamily"], + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the cache parameter group family.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEngineDefaultParameters operation.

" + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes worth of events to retrieve.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeEvents operation.

" + }, + "DescribeReplicationGroupsMessage":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReplicationGroups operation.

" + }, + "DescribeReservedCacheNodesMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The reserved cache node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only those reservations matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only those reservations matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodes operation.

" + }, + "DescribeReservedCacheNodesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type filter value. Use this parameter to show only the available offerings matching the specified cache node type.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Duration":{ + "shape":"String", + "documentation":"

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

Valid Values: 1 | 3 | 31536000 | 94608000

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The product description filter value. Use this parameter to show only the available offerings matching the specified product description.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type.

Valid Values: \"Light Utilization\"|\"Medium Utilization\"|\"Heavy Utilization\"

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + }, + "documentation":"

Represents the input of a DescribeReservedCacheNodesOfferings operation.

" + }, + "DescribeServiceUpdatesMessage":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatusList", + "documentation":"

The status of the service update

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeSnapshotsListMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

A list of snapshots. Each item in the list contains detailed information about one snapshot.

" + } + }, + "documentation":"

Represents the output of a DescribeSnapshots operation.

" + }, + "DescribeSnapshotsMessage":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

A user-supplied replication group identifier. If this parameter is specified, only snapshots associated with that specific replication group are described.

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

A user-supplied cluster identifier. If this parameter is specified, only snapshots associated with that specific cluster are described.

" + }, + "SnapshotName":{ + "shape":"String", + "documentation":"

A user-supplied name of the snapshot. If this parameter is specified, only this snapshot are described.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

If set to system, the output shows snapshots that were automatically created by ElastiCache. If set to user the output shows snapshots that were manually created. If omitted, the output shows both automatically and manually created snapshots.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 50

Constraints: minimum 20; maximum 50.

" + }, + "ShowNodeGroupConfig":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value which if true, the node group (shard) configuration is included in the snapshot description.

" + } + }, + "documentation":"

Represents the input of a DescribeSnapshotsMessage operation.

" + }, + "DescribeUpdateActionsMessage":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ReplicationGroupIds":{ + "shape":"ReplicationGroupIdList", + "documentation":"

The replication group IDs

" + }, + "CacheClusterIds":{ + "shape":"CacheClusterIdList", + "documentation":"

The cache cluster IDs

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The Elasticache engine to which the update applies. Either Redis or Memcached

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatusList", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateTimeRange":{ + "shape":"TimeRangeFilter", + "documentation":"

The range of time specified to search for service updates that are in available status

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatusList", + "documentation":"

The status of the update action.

" + }, + "ShowNodeLevelUpdateStatus":{ + "shape":"BooleanOptional", + "documentation":"

Dictates whether to include node level update status in the response

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "Double":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

The status of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account ID of the Amazon EC2 security group owner.

" + } + }, + "documentation":"

Provides ownership and status information for an Amazon EC2 security group.

" + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

The DNS hostname of the cache node.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port number that the cache engine is listening on.

" + } + }, + "documentation":"

Represents the information required for client programs to connect to a cache node.

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "CacheParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the cache parameter group family to which the engine default parameters apply.

Valid values are: memcached1.4 | memcached1.5 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 |

" + }, + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + }, + "CacheNodeTypeSpecificParameters":{ + "shape":"CacheNodeTypeSpecificParametersList", + "documentation":"

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

" + } + }, + "documentation":"

Represents the output of a DescribeEngineDefaultParameters operation.

", + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the origin of this event - a cluster, a parameter group, a security group, etc.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The text of the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

The date and time when the event occurred.

" + } + }, + "documentation":"

Represents a single occurrence of something interesting within the system. Some examples of events are creating a cluster, adding or removing a cache node, or rebooting a node.

" + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of events. Each element in the list contains detailed information about one event.

" + } + }, + "documentation":"

Represents the output of a DescribeEvents operation.

" + }, + "IncreaseReplicaCountMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "ApplyImmediately" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The id of the replication group to which you want to add replica nodes.

" + }, + "NewReplicaCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

" + }, + "ReplicaConfiguration":{ + "shape":"ReplicaConfigurationList", + "documentation":"

A list of ConfigureShard objects that can be used to configure each shard in a Redis (cluster mode enabled) replication group. The ConfigureShard has three members: NewReplicaCount, NodeGroupId, and PreferredAvailabilityZones.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If True, the number of replica nodes is increased immediately. ApplyImmediately=False is not currently supported.

" + } + } + }, + "IncreaseReplicaCountResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "InsufficientCacheClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache node type is not available in the specified Availability Zone. For more information, see InsufficientCacheClusterCapacity in the ElastiCache User Guide.

", + "error":{ + "code":"InsufficientCacheClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidARNFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested Amazon Resource Name (ARN) does not refer to an existing resource.

", + "error":{ + "code":"InvalidARN", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidCacheClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cluster is not in the available state.

", + "error":{ + "code":"InvalidCacheClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidCacheParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The current state of the cache parameter group does not allow the requested operation to occur.

", + "error":{ + "code":"InvalidCacheParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidCacheSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The current state of the cache security group does not allow deletion.

", + "error":{ + "code":"InvalidCacheSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidKMSKeyFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The KMS key supplied is not valid.

", + "error":{ + "code":"InvalidKMSKeyFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterCombinationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

Two or more parameters that must not be used together were used together.

" + } + }, + "documentation":"

Two or more incompatible parameters were specified.

", + "error":{ + "code":"InvalidParameterCombination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "synthetic":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"AwsQueryErrorMessage", + "documentation":"

A parameter value is invalid.

" + } + }, + "documentation":"

The value for a parameter is invalid.

", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "synthetic":true + }, + "InvalidReplicationGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested replication group is not in the available state.

", + "error":{ + "code":"InvalidReplicationGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The current state of the snapshot does not allow the requested operation to occur.

", + "error":{ + "code":"InvalidSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

An invalid subnet identifier was specified.

", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The VPC network is in an invalid state.

", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListAllowedNodeTypeModificationsMessage":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The name of the cluster you want to scale up to a larger node instanced type. ElastiCache uses the cluster id to identify the current node type of this cluster and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The name of the replication group want to scale up to a larger node type. ElastiCache uses the replication group id to identify the current node type being used by this replication group, and from that to create a list of node types you can scale up to.

You must provide a value for either the CacheClusterId or the ReplicationGroupId.

" + } + }, + "documentation":"

The input parameters for the ListAllowedNodeTypeModifications operation.

" + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource for which you want the list of tags, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + } + }, + "documentation":"

The input parameters for the ListTagsForResource operation.

" + }, + "ModifyCacheClusterMessage":{ + "type":"structure", + "required":["CacheClusterId"], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cluster identifier. This value is stored as a lowercase string.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes that the cluster should have. If the value for NumCacheNodes is greater than the sum of the number of current cache nodes and the number of cache nodes pending creation (which may be zero), more nodes are added. If the value is less than the number of existing cache nodes, nodes are removed. If the value is equal to the number of current cache nodes, any pending add or remove requests are canceled.

If you are removing cache nodes, you must use the CacheNodeIdsToRemove parameter to provide the IDs of the specific cache nodes to remove.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

Adding or removing Memcached cache nodes can be applied immediately or as a pending operation (see ApplyImmediately).

A pending operation to modify the number of cache nodes in a cluster during its maintenance window, whether by adding or removing nodes in accordance with the scale out architecture, is not queued. The customer's latest request to add or remove nodes to the cluster overrides any previous pending operations to modify the number of cache nodes in the cluster. For example, a request to remove 2 nodes would override a previous pending operation to remove 3 nodes. Similarly, a request to add 2 nodes would override a previous pending operation to remove 3 nodes and vice versa. As Memcached cache nodes may now be provisioned in different Availability Zones with flexible cache node placement, a request to add nodes does not automatically override a previous pending operation to add nodes. The customer can modify the previous pending operation to add more nodes or explicitly cancel the pending request and retry the new request. To cancel pending operations to modify the number of cache nodes in a cluster, use the ModifyCacheCluster request and set NumCacheNodes equal to the number of cache nodes currently in the cluster.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to be removed. A node ID is a numeric identifier (0001, 0002, etc.). This parameter is only valid when NumCacheNodes is less than the existing number of cache nodes. The number of cache node IDs supplied in this parameter must match the difference between the existing number of cache nodes in the cluster or pending cache nodes, whichever is greater, and the value of NumCacheNodes in the request.

For example: If you have 3 active cache nodes, 7 pending cache nodes, and the number of cache nodes in this ModifyCacheCluster call is 5, you must list 2 (7 - 5) cache node IDs to remove.

" + }, + "AZMode":{ + "shape":"AZMode", + "documentation":"

Specifies whether the new nodes in this Memcached cluster are all created in a single Availability Zone or created across multiple Availability Zones.

Valid values: single-az | cross-az.

This option is only supported for Memcached clusters.

You cannot specify single-az if the Memcached cluster already has cache nodes in different Availability Zones. If cross-az is specified, existing Memcached nodes remain in their current Availability Zone.

Only newly created nodes are located in different Availability Zones.

" + }, + "NewAvailabilityZones":{ + "shape":"PreferredAvailabilityZoneList", + "documentation":"

The list of Availability Zones where the new Memcached cache nodes are created.

This parameter is only valid when NumCacheNodes in the request is greater than the sum of the number of active cache nodes and the number of cache nodes pending creation (which may be zero). The number of Availability Zones supplied in this list must match the cache nodes being added in this request.

This option is only supported on Memcached clusters.

Scenarios:

  • Scenario 1: You have 3 active nodes and wish to add 2 nodes. Specify NumCacheNodes=5 (3 + 2) and optionally specify two Availability Zones for the two new nodes.

  • Scenario 2: You have 3 active nodes and 2 nodes pending creation (from the scenario 1 call) and want to add 1 more node. Specify NumCacheNodes=6 ((3 + 2) + 1) and optionally specify an Availability Zone for the new node.

  • Scenario 3: You want to cancel all pending operations. Specify NumCacheNodes=3 to cancel all pending operations.

The Availability Zone placement of nodes pending creation cannot be modified. If you wish to cancel any nodes pending creation, add 0 nodes by setting NumCacheNodes to the number of current nodes.

If cross-az is specified, existing Memcached nodes remain in their current Availability Zone. Only newly created nodes can be located in different Availability Zones. For guidance on how to move existing Memcached nodes to different Availability Zones, see the Availability Zone Considerations section of Cache Node Considerations for Memcached.

Impact of new add/remove requests upon pending requests

  • Scenario-1

    • Pending Action: Delete

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending delete.

  • Scenario-2

    • Pending Action: Delete

    • New Request: Create

    • Result: The new create, pending or immediate, replaces the pending delete.

  • Scenario-3

    • Pending Action: Create

    • New Request: Delete

    • Result: The new delete, pending or immediate, replaces the pending create.

  • Scenario-4

    • Pending Action: Create

    • New Request: Create

    • Result: The new create is added to the pending create.

      Important: If the new create request is Apply Immediately - Yes, all creates are performed immediately. If the new create request is Apply Immediately - No, all creates are pending.
" + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize on this cluster. This change is asynchronously applied as soon as possible.

You can use this parameter only with clusters that are created outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be \"Default\".

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the cluster.

This parameter can be used only with clusters that are created in an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The Amazon SNS topic owner must be same as the cluster owner.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to this cluster. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the cluster.

If false, changes to the cluster are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

If you perform a ModifyCacheCluster before a pending modification is applied, the pending modification is replaced by the newer modification.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the cache nodes.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster and create it anew with the earlier engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

This parameter is currently disabled.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your cluster.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

A valid cache node type that you want to scale this cluster up to.

" + }, + "AuthToken":{ + "shape":"String", + "documentation":"

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '\"', or '@', '%'

For more information, see AUTH password at AUTH.

" + }, + "AuthTokenUpdateStrategy":{ + "shape":"AuthTokenUpdateStrategyType", + "documentation":"

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

" + } + }, + "documentation":"

Represents the input of a ModifyCacheCluster operation.

" + }, + "ModifyCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "ModifyCacheParameterGroupMessage":{ + "type":"structure", + "required":[ + "CacheParameterGroupName", + "ParameterNameValues" + ], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to modify.

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names and values for the parameter update. You must supply at least one parameter name and value; subsequent arguments are optional. A maximum of 20 parameters may be modified per request.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheParameterGroup operation.

" + }, + "ModifyCacheSubnetGroupMessage":{ + "type":"structure", + "required":["CacheSubnetGroupName"], + "members":{ + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the cache subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 alphanumeric characters or hyphens.

Example: mysubnetgroup

" + }, + "CacheSubnetGroupDescription":{ + "shape":"String", + "documentation":"

A description of the cache subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 subnet IDs for the cache subnet group.

" + } + }, + "documentation":"

Represents the input of a ModifyCacheSubnetGroup operation.

" + }, + "ModifyCacheSubnetGroupResult":{ + "type":"structure", + "members":{ + "CacheSubnetGroup":{"shape":"CacheSubnetGroup"} + } + }, + "ModifyReplicationGroupMessage":{ + "type":"structure", + "required":["ReplicationGroupId"], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier of the replication group to modify.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A description for the replication group. Maximum length is 255 characters.

" + }, + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

For replication groups with a single primary, if this parameter is specified, ElastiCache promotes the specified cluster in the specified replication group to the primary role. The nodes of all other clusters in the replication group are read replicas.

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Redis (cluster mode enabled) replication groups.

" + }, + "AutomaticFailoverEnabled":{ + "shape":"BooleanOptional", + "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + }, + "NodeGroupId":{ + "shape":"String", + "documentation":"

Deprecated. This parameter is not used.

", + "deprecated":true + }, + "CacheSecurityGroupNames":{ + "shape":"CacheSecurityGroupNameList", + "documentation":"

A list of cache security group names to authorize for the clusters in this replication group. This change is asynchronously applied as soon as possible.

This parameter can be used only with replication group containing clusters running outside of an Amazon Virtual Private Cloud (Amazon VPC).

Constraints: Must contain no more than 255 alphanumeric characters. Must not be Default.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIdsList", + "documentation":"

Specifies the VPC Security Groups associated with the clusters in the replication group.

This parameter can be used only with replication group containing clusters running in an Amazon Virtual Private Cloud (Amazon VPC).

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "NotificationTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications are sent.

The Amazon SNS topic owner must be same as the replication group owner.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to apply to all of the clusters in this replication group. This change is asynchronously applied as soon as possible for parameters when the ApplyImmediately parameter is specified as true for this request.

" + }, + "NotificationTopicStatus":{ + "shape":"String", + "documentation":"

The status of the Amazon SNS notification topic for the replication group. Notifications are sent only if the status is active.

Valid values: active | inactive

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

If true, this parameter causes the modifications in this request and any pending modifications to be applied, asynchronously and as soon as possible, regardless of the PreferredMaintenanceWindow setting for the replication group.

If false, changes to the nodes in the replication group are applied on the next maintenance reboot, or the next failure reboot, whichever occurs first.

Valid values: true | false

Default: false

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The upgraded version of the cache engine to be run on the clusters in the replication group.

Important: You can upgrade to a newer engine version (see Selecting a Cache Engine and Version), but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing replication group and create it anew with the earlier engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

This parameter is currently disabled.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic node group (shard) snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of the node group (shard) specified by SnapshottingClusterId.

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

A valid cache node type that you want to scale this replication group to.

" + }, + "AuthToken":{ + "shape":"String", + "documentation":"

Reserved parameter. The password used to access a password protected server. This parameter must be specified with the auth-token-update-strategy parameter. Password constraints:

  • Must be only printable ASCII characters

  • Must be at least 16 characters and no more than 128 characters in length

  • Cannot contain any of the following characters: '/', '\"', or '@', '%'

For more information, see AUTH password at AUTH.

" + }, + "AuthTokenUpdateStrategy":{ + "shape":"AuthTokenUpdateStrategyType", + "documentation":"

Specifies the strategy to use to update the AUTH token. This parameter must be specified with the auth-token parameter. Possible values:

  • Rotate

  • Set

For more information, see Authenticating Users with Redis AUTH

" + } + }, + "documentation":"

Represents the input of a ModifyReplicationGroups operation.

" + }, + "ModifyReplicationGroupResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "ModifyReplicationGroupShardConfigurationMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "NodeGroupCount", + "ApplyImmediately" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The name of the Redis (cluster mode enabled) cluster (replication group) on which the shards are to be configured.

" + }, + "NodeGroupCount":{ + "shape":"Integer", + "documentation":"

The number of node groups (shards) that results from the modification of the shard configuration.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Indicates that the shard reconfiguration process begins immediately. At present, the only permitted value for this parameter is true.

Value: true

" + }, + "ReshardingConfiguration":{ + "shape":"ReshardingConfigurationList", + "documentation":"

Specifies the preferred availability zones for each node group in the cluster. If the value of NodeGroupCount is greater than the current number of node groups (shards), you can use this parameter to specify the preferred availability zones of the cluster's shards. If you omit this parameter ElastiCache selects availability zones for you.

You can specify this parameter only if the value of NodeGroupCount is greater than the current number of node groups (shards).

" + }, + "NodeGroupsToRemove":{ + "shape":"NodeGroupsToRemoveList", + "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRemove is a list of NodeGroupIds to remove from the cluster.

ElastiCache for Redis will attempt to remove all node groups listed by NodeGroupsToRemove from the cluster.

" + }, + "NodeGroupsToRetain":{ + "shape":"NodeGroupsToRetainList", + "documentation":"

If the value of NodeGroupCount is less than the current number of node groups (shards), then either NodeGroupsToRemove or NodeGroupsToRetain is required. NodeGroupsToRetain is a list of NodeGroupIds to retain in the cluster.

ElastiCache for Redis will attempt to remove all node groups except those listed by NodeGroupsToRetain from the cluster.

" + } + }, + "documentation":"

Represents the input for a ModifyReplicationGroupShardConfiguration operation.

" + }, + "ModifyReplicationGroupShardConfigurationResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "NoOperationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The operation was not performed because no changes were required.

", + "error":{ + "code":"NoOperationFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NodeGroup":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"String", + "documentation":"

The identifier for the node group (shard). A Redis (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Redis (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, etc.

" + }, + "PrimaryEndpoint":{ + "shape":"Endpoint", + "documentation":"

The endpoint of the primary node in this node group (shard).

" + }, + "ReaderEndpoint":{ + "shape":"Endpoint", + "documentation":"

The endpoint of the replica nodes in this node group (shard).

" + }, + "Slots":{ + "shape":"String", + "documentation":"

The keyspace for this node group (shard).

" + }, + "NodeGroupMembers":{ + "shape":"NodeGroupMemberList", + "documentation":"

A list containing information about individual nodes within the node group (shard).

" + } + }, + "documentation":"

Represents a collection of cache nodes in a replication group. One node in the node group is the read/write primary node. All the other nodes are read-only Replica nodes.

" + }, + "NodeGroupConfiguration":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"AllowedNodeGroupId", + "documentation":"

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

" + }, + "Slots":{ + "shape":"String", + "documentation":"

A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.

Example: \"0-3999\"

" + }, + "ReplicaCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of read replica nodes in this node group (shard).

" + }, + "PrimaryAvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone where the primary node of this node group (shard) is launched.

" + }, + "ReplicaAvailabilityZones":{ + "shape":"AvailabilityZonesList", + "documentation":"

A list of Availability Zones to be used for the read replicas. The number of Availability Zones in this list must match the value of ReplicaCount or ReplicasPerNodeGroup if not specified.

" + } + }, + "documentation":"

Node group (shard) configuration options. Each node group (shard) configuration has the following: Slots, PrimaryAvailabilityZone, ReplicaAvailabilityZones, ReplicaCount.

" + }, + "NodeGroupConfigurationList":{ + "type":"list", + "member":{ + "shape":"NodeGroupConfiguration", + "locationName":"NodeGroupConfiguration" + } + }, + "NodeGroupList":{ + "type":"list", + "member":{ + "shape":"NodeGroup", + "locationName":"NodeGroup" + } + }, + "NodeGroupMember":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cluster to which the node belongs.

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The ID of the node within its cluster. A node ID is a numeric identifier (0001, 0002, etc.).

" + }, + "ReadEndpoint":{ + "shape":"Endpoint", + "documentation":"

The information required for client programs to connect to a node for read operations. The read endpoint is only applicable on Redis (cluster mode disabled) clusters.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the node is located.

" + }, + "CurrentRole":{ + "shape":"String", + "documentation":"

The role that is currently assigned to the node - primary or replica. This member is only applicable for Redis (cluster mode disabled) replication groups.

" + } + }, + "documentation":"

Represents a single node within a node group (shard).

" + }, + "NodeGroupMemberList":{ + "type":"list", + "member":{ + "shape":"NodeGroupMember", + "locationName":"NodeGroupMember" + } + }, + "NodeGroupMemberUpdateStatus":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cache cluster ID

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The node ID of the cache cluster

" + }, + "NodeUpdateStatus":{ + "shape":"NodeUpdateStatus", + "documentation":"

The update status of the node

" + }, + "NodeDeletionDate":{ + "shape":"TStamp", + "documentation":"

The deletion date of the node

" + }, + "NodeUpdateStartDate":{ + "shape":"TStamp", + "documentation":"

The start date of the update for a node

" + }, + "NodeUpdateEndDate":{ + "shape":"TStamp", + "documentation":"

The end date of the update for a node

" + }, + "NodeUpdateInitiatedBy":{ + "shape":"NodeUpdateInitiatedBy", + "documentation":"

Reflects whether the update was initiated by the customer or automatically applied

" + }, + "NodeUpdateInitiatedDate":{ + "shape":"TStamp", + "documentation":"

The date when the update is triggered

" + }, + "NodeUpdateStatusModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date when the NodeUpdateStatus was last modified

" + } + }, + "documentation":"

The status of the service update on the node group member

" + }, + "NodeGroupMemberUpdateStatusList":{ + "type":"list", + "member":{ + "shape":"NodeGroupMemberUpdateStatus", + "locationName":"NodeGroupMemberUpdateStatus" + } + }, + "NodeGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The node group specified by the NodeGroupId parameter could not be found. Please verify that the node group exists and that you spelled the NodeGroupId value correctly.

", + "error":{ + "code":"NodeGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "NodeGroupUpdateStatus":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"String", + "documentation":"

The ID of the node group

" + }, + "NodeGroupMemberUpdateStatus":{ + "shape":"NodeGroupMemberUpdateStatusList", + "documentation":"

The status of the service update on the node group member

" + } + }, + "documentation":"

The status of the service update on the node group

" + }, + "NodeGroupUpdateStatusList":{ + "type":"list", + "member":{ + "shape":"NodeGroupUpdateStatus", + "locationName":"NodeGroupUpdateStatus" + } + }, + "NodeGroupsPerReplicationGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the maximum allowed number of node groups (shards) in a single replication group. The default maximum is 90

", + "error":{ + "code":"NodeGroupsPerReplicationGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NodeGroupsToRemoveList":{ + "type":"list", + "member":{ + "shape":"AllowedNodeGroupId", + "locationName":"NodeGroupToRemove" + } + }, + "NodeGroupsToRetainList":{ + "type":"list", + "member":{ + "shape":"AllowedNodeGroupId", + "locationName":"NodeGroupToRetain" + } + }, + "NodeQuotaForClusterExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes in a single cluster.

", + "error":{ + "code":"NodeQuotaForClusterExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NodeQuotaForCustomerExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the allowed number of cache nodes per customer.

", + "error":{ + "code":"NodeQuotaForCustomerExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NodeSnapshot":{ + "type":"structure", + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

A unique identifier for the source cluster.

" + }, + "NodeGroupId":{ + "shape":"String", + "documentation":"

A unique identifier for the source node group (shard).

" + }, + "CacheNodeId":{ + "shape":"String", + "documentation":"

The cache node identifier for the node in the source cluster.

" + }, + "NodeGroupConfiguration":{ + "shape":"NodeGroupConfiguration", + "documentation":"

The configuration for the source node group (shard).

" + }, + "CacheSize":{ + "shape":"String", + "documentation":"

The size of the cache on the source cache node.

" + }, + "CacheNodeCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the cache node was created in the source cluster.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source node's metadata and cache data set was obtained for the snapshot.

" + } + }, + "documentation":"

Represents an individual cache node in a snapshot of a cluster.

", + "wrapper":true + }, + "NodeSnapshotList":{ + "type":"list", + "member":{ + "shape":"NodeSnapshot", + "locationName":"NodeSnapshot" + } + }, + "NodeTypeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "NodeUpdateInitiatedBy":{ + "type":"string", + "enum":[ + "system", + "customer" + ] + }, + "NodeUpdateStatus":{ + "type":"string", + "enum":[ + "not-applied", + "waiting-to-start", + "in-progress", + "stopping", + "stopped", + "complete" + ] + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) that identifies the topic.

" + }, + "TopicStatus":{ + "shape":"String", + "documentation":"

The current state of the topic.

" + } + }, + "documentation":"

Describes a notification topic and its status. Notification topics are used for publishing ElastiCache events to subscribers using Amazon Simple Notification Service (SNS).

" + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the parameter.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

The valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

The valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest cache engine version to which the parameter can apply.

" + }, + "ChangeType":{ + "shape":"ChangeType", + "documentation":"

Indicates whether a change to the parameter is applied immediately or requires a reboot for the change to be applied. You can force a reboot or wait until the next maintenance window's reboot. For more information, see Rebooting a Cluster.

" + } + }, + "documentation":"

Describes an individual setting that controls some aspect of ElastiCache behavior.

" + }, + "ParameterNameValue":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

The value of the parameter.

" + } + }, + "documentation":"

Describes a name-value pair that is used to update the value of a parameter.

" + }, + "ParameterNameValueList":{ + "type":"list", + "member":{ + "shape":"ParameterNameValue", + "locationName":"ParameterNameValue" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingAutomaticFailoverStatus":{ + "type":"string", + "enum":[ + "enabled", + "disabled" + ] + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The new number of cache nodes for the cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" + }, + "CacheNodeIdsToRemove":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs that are being removed (or will be removed) from the cluster. A node ID is a 4-digit numeric identifier (0001, 0002, etc.).

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The new cache engine version that the cluster runs.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type that this cluster or replication group is scaled to.

" + }, + "AuthTokenStatus":{ + "shape":"AuthTokenUpdateStatus", + "documentation":"

The auth token status

" + } + }, + "documentation":"

A group of settings that are applied to the cluster in the future, or that are currently being applied.

" + }, + "PreferredAvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"PreferredAvailabilityZone" + } + }, + "ProcessedUpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cache cluster

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatus", + "documentation":"

The status of the update action on the Redis cluster

" + } + }, + "documentation":"

Update action that has been processed for the corresponding apply/stop request

" + }, + "ProcessedUpdateActionList":{ + "type":"list", + "member":{ + "shape":"ProcessedUpdateAction", + "locationName":"ProcessedUpdateAction" + } + }, + "PurchaseReservedCacheNodesOfferingMessage":{ + "type":"structure", + "required":["ReservedCacheNodesOfferingId"], + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

" + }, + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

A customer-specified identifier to track this reservation.

The Reserved Cache Node ID is an unique customer-specified identifier to track this reservation. If this parameter is not specified, ElastiCache automatically generates an identifier for the reservation.

Example: myreservationID

" + }, + "CacheNodeCount":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache node instances to reserve.

Default: 1

" + } + }, + "documentation":"

Represents the input of a PurchaseReservedCacheNodesOffering operation.

" + }, + "PurchaseReservedCacheNodesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedCacheNode":{"shape":"ReservedCacheNode"} + } + }, + "RebootCacheClusterMessage":{ + "type":"structure", + "required":[ + "CacheClusterId", + "CacheNodeIdsToReboot" + ], + "members":{ + "CacheClusterId":{ + "shape":"String", + "documentation":"

The cluster identifier. This parameter is stored as a lowercase string.

" + }, + "CacheNodeIdsToReboot":{ + "shape":"CacheNodeIdsList", + "documentation":"

A list of cache node IDs to reboot. A node ID is a numeric identifier (0001, 0002, etc.). To reboot an entire cluster, specify all of the cache node IDs.

" + } + }, + "documentation":"

Represents the input of a RebootCacheCluster operation.

" + }, + "RebootCacheClusterResult":{ + "type":"structure", + "members":{ + "CacheCluster":{"shape":"CacheCluster"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The monetary amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved cache node, or for a reserved cache node offering.

", + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveReplicasList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want the tags removed, for example arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster or arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

A list of TagKeys identifying the tags you want removed from the named resource.

" + } + }, + "documentation":"

Represents the input of a RemoveTagsFromResource operation.

" + }, + "ReplicaConfigurationList":{ + "type":"list", + "member":{ + "shape":"ConfigureShard", + "locationName":"ConfigureShard" + } + }, + "ReplicationGroup":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The identifier for the replication group.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The user supplied description of the replication group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The current state of this replication group - creating, available, modifying, deleting, create-failed, snapshotting.

" + }, + "PendingModifiedValues":{ + "shape":"ReplicationGroupPendingModifiedValues", + "documentation":"

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

" + }, + "MemberClusters":{ + "shape":"ClusterIdList", + "documentation":"

The names of all the cache clusters that are part of this replication group.

" + }, + "NodeGroups":{ + "shape":"NodeGroupList", + "documentation":"

A list of node groups in this replication group. For Redis (cluster mode disabled) replication groups, this is a single-element list. For Redis (cluster mode enabled) replication groups, the list contains an entry for each node group (shard).

" + }, + "SnapshottingClusterId":{ + "shape":"String", + "documentation":"

The cluster ID that is used as the daily snapshot source for the replication group.

" + }, + "AutomaticFailover":{ + "shape":"AutomaticFailoverStatus", + "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + }, + "ConfigurationEndpoint":{ + "shape":"Endpoint", + "documentation":"

The configuration endpoint for this replication group. Use the configuration endpoint to connect to this replication group.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which ElastiCache retains automatic cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.

If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).

Example: 05:00-09:00

If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.

This parameter is only valid if the Engine parameter is redis.

" + }, + "ClusterEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag indicating whether or not this replication group is cluster enabled; i.e., whether its data can be partitioned across multiple shards (API/CLI: node groups).

Valid values: true | false

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for each node in the replication group.

" + }, + "AuthTokenEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables using an AuthToken (password) when issuing Redis commands.

Default: false

" + }, + "AuthTokenLastModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date the auth token was last modified

" + }, + "TransitEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables in-transit encryption when set to true.

You cannot modify the value of TransitEncryptionEnabled after the cluster is created. To enable in-transit encryption on a cluster you must set TransitEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

" + }, + "AtRestEncryptionEnabled":{ + "shape":"BooleanOptional", + "documentation":"

A flag that enables encryption at-rest when set to true.

You cannot modify the value of AtRestEncryptionEnabled after the cluster is created. To enable encryption at-rest on a cluster you must set AtRestEncryptionEnabled to true when you create a cluster.

Required: Only available when creating a replication group in an Amazon VPC using redis version 3.2.6, 4.x or later.

Default: false

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ID of the KMS key used to encrypt the disk in the cluster.

" + } + }, + "documentation":"

Contains all of the attributes of a specific Redis replication group.

", + "wrapper":true + }, + "ReplicationGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified replication group already exists.

", + "error":{ + "code":"ReplicationGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReplicationGroupAlreadyUnderMigrationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The targeted replication group is not available.

", + "error":{ + "code":"ReplicationGroupAlreadyUnderMigrationFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReplicationGroupIdList":{ + "type":"list", + "member":{"shape":"String"}, + "max":20 + }, + "ReplicationGroupList":{ + "type":"list", + "member":{ + "shape":"ReplicationGroup", + "locationName":"ReplicationGroup" + } + }, + "ReplicationGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReplicationGroups":{ + "shape":"ReplicationGroupList", + "documentation":"

A list of replication groups. Each item in the list contains detailed information about one replication group.

" + } + }, + "documentation":"

Represents the output of a DescribeReplicationGroups operation.

" + }, + "ReplicationGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified replication group does not exist.

", + "error":{ + "code":"ReplicationGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReplicationGroupNotUnderMigrationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The designated replication group is not available for data migration.

", + "error":{ + "code":"ReplicationGroupNotUnderMigrationFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReplicationGroupPendingModifiedValues":{ + "type":"structure", + "members":{ + "PrimaryClusterId":{ + "shape":"String", + "documentation":"

The primary cluster ID that is applied immediately (if --apply-immediately was specified), or during the next maintenance window.

" + }, + "AutomaticFailoverStatus":{ + "shape":"PendingAutomaticFailoverStatus", + "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + }, + "Resharding":{ + "shape":"ReshardingStatus", + "documentation":"

The status of an online resharding operation.

" + }, + "AuthTokenStatus":{ + "shape":"AuthTokenUpdateStatus", + "documentation":"

The auth token status

" + } + }, + "documentation":"

The settings to be applied to the Redis replication group, either immediately or during the next maintenance window.

" + }, + "ReservedCacheNode":{ + "type":"structure", + "members":{ + "ReservedCacheNodeId":{ + "shape":"String", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache nodes.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the reservation in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this reserved cache node.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this reserved cache node.

" + }, + "CacheNodeCount":{ + "shape":"Integer", + "documentation":"

The number of cache nodes that have been reserved.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The description of the reserved cache node.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type of this reserved cache node.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved cache node.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + }, + "ReservationARN":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the reserved cache node.

Example: arn:aws:elasticache:us-east-1:123456789012:reserved-instance:ri-2017-03-27-08-33-25-582

" + } + }, + "documentation":"

Represents the output of a PurchaseReservedCacheNodesOffering operation.

", + "wrapper":true + }, + "ReservedCacheNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a reservation with the given identifier.

", + "error":{ + "code":"ReservedCacheNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedCacheNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNode", + "locationName":"ReservedCacheNode" + } + }, + "ReservedCacheNodeMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodes":{ + "shape":"ReservedCacheNodeList", + "documentation":"

A list of reserved cache nodes. Each element in the list contains detailed information about one node.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodes operation.

" + }, + "ReservedCacheNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested reserved cache node was not found.

", + "error":{ + "code":"ReservedCacheNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedCacheNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the user's cache node quota.

", + "error":{ + "code":"ReservedCacheNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedCacheNodesOffering":{ + "type":"structure", + "members":{ + "ReservedCacheNodesOfferingId":{ + "shape":"String", + "documentation":"

A unique identifier for the reserved cache node offering.

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The cache node type for the reserved cache node.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration of the offering. in seconds.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The fixed price charged for this offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The hourly price charged for this offering.

" + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

The cache engine used by the offering.

" + }, + "OfferingType":{ + "shape":"String", + "documentation":"

The offering type.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The recurring price charged to run this reserved cache node.

" + } + }, + "documentation":"

Describes all of the attributes of a reserved cache node offering.

", + "wrapper":true + }, + "ReservedCacheNodesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedCacheNodesOffering", + "locationName":"ReservedCacheNodesOffering" + } + }, + "ReservedCacheNodesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedCacheNodesOfferings":{ + "shape":"ReservedCacheNodesOfferingList", + "documentation":"

A list of reserved cache node offerings. Each element in the list contains detailed information about one offering.

" + } + }, + "documentation":"

Represents the output of a DescribeReservedCacheNodesOfferings operation.

" + }, + "ReservedCacheNodesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested cache node offering does not exist.

", + "error":{ + "code":"ReservedCacheNodesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetCacheParameterGroupMessage":{ + "type":"structure", + "required":["CacheParameterGroupName"], + "members":{ + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the cache parameter group to reset.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

If true, all parameters in the cache parameter group are reset to their default values. If false, only the parameters listed by ParameterNameValues are reset to their default values.

Valid values: true | false

" + }, + "ParameterNameValues":{ + "shape":"ParameterNameValueList", + "documentation":"

An array of parameter names to reset to their default values. If ResetAllParameters is true, do not use ParameterNameValues. If ResetAllParameters is false, you must specify the name of at least one parameter to reset.

" + } + }, + "documentation":"

Represents the input of a ResetCacheParameterGroup operation.

" + }, + "ReshardingConfiguration":{ + "type":"structure", + "members":{ + "NodeGroupId":{ + "shape":"AllowedNodeGroupId", + "documentation":"

Either the ElastiCache for Redis supplied 4-digit id or a user supplied id for the node group these configuration values apply to.

" + }, + "PreferredAvailabilityZones":{ + "shape":"AvailabilityZonesList", + "documentation":"

A list of preferred availability zones for the nodes in this cluster.

" + } + }, + "documentation":"

A list of PreferredAvailabilityZones objects that specifies the configuration of a node group in the resharded cluster.

" + }, + "ReshardingConfigurationList":{ + "type":"list", + "member":{ + "shape":"ReshardingConfiguration", + "locationName":"ReshardingConfiguration" + } + }, + "ReshardingStatus":{ + "type":"structure", + "members":{ + "SlotMigration":{ + "shape":"SlotMigration", + "documentation":"

Represents the progress of an online resharding operation.

" + } + }, + "documentation":"

The status of an online resharding operation.

" + }, + "RevokeCacheSecurityGroupIngressMessage":{ + "type":"structure", + "required":[ + "CacheSecurityGroupName", + "EC2SecurityGroupName", + "EC2SecurityGroupOwnerId" + ], + "members":{ + "CacheSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the cache security group to revoke ingress from.

" + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 security group to revoke access from.

" + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

The AWS account number of the Amazon EC2 security group owner. Note that this is not the same thing as an AWS access key ID - you must provide a valid AWS account number for this parameter.

" + } + }, + "documentation":"

Represents the input of a RevokeCacheSecurityGroupIngress operation.

" + }, + "RevokeCacheSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "CacheSecurityGroup":{"shape":"CacheSecurityGroup"} + } + }, + "SecurityGroupIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SecurityGroupId" + } + }, + "SecurityGroupMembership":{ + "type":"structure", + "members":{ + "SecurityGroupId":{ + "shape":"String", + "documentation":"

The identifier of the cache security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the cache security group membership. The status changes whenever a cache security group is modified, or when the cache security groups assigned to a cluster are modified.

" + } + }, + "documentation":"

Represents a single cache security group and its status.

" + }, + "SecurityGroupMembershipList":{ + "type":"list", + "member":{"shape":"SecurityGroupMembership"} + }, + "ServiceLinkedRoleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified service linked role (SLR) was not found.

", + "error":{ + "code":"ServiceLinkedRoleNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ServiceUpdate":{ + "type":"structure", + "members":{ + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateReleaseDate":{ + "shape":"TStamp", + "documentation":"

The date when the service update is initially available

" + }, + "ServiceUpdateEndDate":{ + "shape":"TStamp", + "documentation":"

The date after which the service update is no longer available

" + }, + "ServiceUpdateSeverity":{ + "shape":"ServiceUpdateSeverity", + "documentation":"

The severity of the service update

" + }, + "ServiceUpdateRecommendedApplyByDate":{ + "shape":"TStamp", + "documentation":"

The recommendend date to apply the service update in order to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatus", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateDescription":{ + "shape":"String", + "documentation":"

Provides details of the service update

" + }, + "ServiceUpdateType":{ + "shape":"ServiceUpdateType", + "documentation":"

Reflects the nature of the service update

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The Elasticache engine to which the update applies. Either Redis or Memcached

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The Elasticache engine version to which the update applies. Either Redis or Memcached engine version

" + }, + "AutoUpdateAfterRecommendedApplyByDate":{ + "shape":"BooleanOptional", + "documentation":"

Indicates whether the service update will be automatically applied once the recommended apply-by date has expired.

" + }, + "EstimatedUpdateTime":{ + "shape":"String", + "documentation":"

The estimated length of time the service update will take

" + } + }, + "documentation":"

An update that you can apply to your Redis clusters.

" + }, + "ServiceUpdateList":{ + "type":"list", + "member":{ + "shape":"ServiceUpdate", + "locationName":"ServiceUpdate" + } + }, + "ServiceUpdateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The service update doesn't exist

", + "error":{ + "code":"ServiceUpdateNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceUpdateSeverity":{ + "type":"string", + "enum":[ + "critical", + "important", + "medium", + "low" + ] + }, + "ServiceUpdateStatus":{ + "type":"string", + "enum":[ + "available", + "cancelled", + "expired" + ] + }, + "ServiceUpdateStatusList":{ + "type":"list", + "member":{"shape":"ServiceUpdateStatus"}, + "max":3 + }, + "ServiceUpdateType":{ + "type":"string", + "enum":["security-update"] + }, + "ServiceUpdatesMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "ServiceUpdates":{ + "shape":"ServiceUpdateList", + "documentation":"

A list of service updates

" + } + } + }, + "SlaMet":{ + "type":"string", + "enum":[ + "yes", + "no", + "n/a" + ] + }, + "SlotMigration":{ + "type":"structure", + "members":{ + "ProgressPercentage":{ + "shape":"Double", + "documentation":"

The percentage of the slot migration that is complete.

" + } + }, + "documentation":"

Represents the progress of an online resharding operation.

" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotName":{ + "shape":"String", + "documentation":"

The name of a snapshot. For an automatic snapshot, the name is system-generated. For a manual snapshot, this is the user-provided name.

" + }, + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The unique identifier of the source replication group.

" + }, + "ReplicationGroupDescription":{ + "shape":"String", + "documentation":"

A description of the source replication group.

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The user-supplied identifier of the source cluster.

" + }, + "SnapshotStatus":{ + "shape":"String", + "documentation":"

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

" + }, + "SnapshotSource":{ + "shape":"String", + "documentation":"

Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).

" + }, + "CacheNodeType":{ + "shape":"String", + "documentation":"

The name of the compute and memory capacity node type for the source cluster.

The following node types are supported by ElastiCache. Generally speaking, the current generation types provide more memory and computational power at lower cost when compared to their equivalent previous generation counterparts.

  • General purpose:

    • Current generation:

      M5 node types: cache.m5.large, cache.m5.xlarge, cache.m5.2xlarge, cache.m5.4xlarge, cache.m5.12xlarge, cache.m5.24xlarge

      M4 node types: cache.m4.large, cache.m4.xlarge, cache.m4.2xlarge, cache.m4.4xlarge, cache.m4.10xlarge

      T2 node types: cache.t2.micro, cache.t2.small, cache.t2.medium

    • Previous generation: (not recommended)

      T1 node types: cache.t1.micro

      M1 node types: cache.m1.small, cache.m1.medium, cache.m1.large, cache.m1.xlarge

      M3 node types: cache.m3.medium, cache.m3.large, cache.m3.xlarge, cache.m3.2xlarge

  • Compute optimized:

    • Previous generation: (not recommended)

      C1 node types: cache.c1.xlarge

  • Memory optimized:

    • Current generation:

      R5 node types: cache.r5.large, cache.r5.xlarge, cache.r5.2xlarge, cache.r5.4xlarge, cache.r5.12xlarge, cache.r5.24xlarge

      R4 node types: cache.r4.large, cache.r4.xlarge, cache.r4.2xlarge, cache.r4.4xlarge, cache.r4.8xlarge, cache.r4.16xlarge

    • Previous generation: (not recommended)

      M2 node types: cache.m2.xlarge, cache.m2.2xlarge, cache.m2.4xlarge

      R3 node types: cache.r3.large, cache.r3.xlarge, cache.r3.2xlarge, cache.r3.4xlarge, cache.r3.8xlarge

Additional node type info

  • All current generation instance types are created in Amazon VPC by default.

  • Redis append-only files (AOF) are not supported for T1 or T2 instances.

  • Redis Multi-AZ with automatic failover is not supported on T1 instances.

  • Redis configuration variables appendonly and appendfsync are not supported on Redis version 2.8.22 and later.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the cache engine (memcached or redis) used by the source cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the cache engine version that is used by the source cluster.

" + }, + "NumCacheNodes":{ + "shape":"IntegerOptional", + "documentation":"

The number of cache nodes in the source cluster.

For clusters running Redis, this value must be 1. For clusters running Memcached, this value must be between 1 and 20.

" + }, + "PreferredAvailabilityZone":{ + "shape":"String", + "documentation":"

The name of the Availability Zone in which the source cluster is located.

" + }, + "CacheClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

The date and time when the source cluster was created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.

Valid values for ddd are:

  • sun

  • mon

  • tue

  • wed

  • thu

  • fri

  • sat

Example: sun:23:00-mon:01:30

" + }, + "TopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the topic used by the source cluster for publishing notifications.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number used by each cache nodes in the source cluster.

" + }, + "CacheParameterGroupName":{ + "shape":"String", + "documentation":"

The cache parameter group that is associated with the source cluster.

" + }, + "CacheSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the cache subnet group associated with the source cluster.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cluster.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

This parameter is currently disabled.

" + }, + "SnapshotRetentionLimit":{ + "shape":"IntegerOptional", + "documentation":"

For an automatic snapshot, the number of days for which ElastiCache retains the snapshot before deleting it.

For manual snapshots, this field reflects the SnapshotRetentionLimit for the source cluster when the snapshot was created. This field is otherwise ignored: Manual snapshots do not expire, and can only be deleted using the DeleteSnapshot operation.

Important If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off.

" + }, + "SnapshotWindow":{ + "shape":"String", + "documentation":"

The daily time range during which ElastiCache takes daily snapshots of the source cluster.

" + }, + "NumNodeGroups":{ + "shape":"IntegerOptional", + "documentation":"

The number of node groups (shards) in this snapshot. When restoring from a snapshot, the number of node groups (shards) in the snapshot and in the restored replication group must be the same.

" + }, + "AutomaticFailover":{ + "shape":"AutomaticFailoverStatus", + "documentation":"

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + }, + "NodeSnapshots":{ + "shape":"NodeSnapshotList", + "documentation":"

A list of the cache nodes in the source cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The ID of the KMS key used to encrypt the snapshot.

" + } + }, + "documentation":"

Represents a copy of an entire Redis cluster as of the time when the snapshot was taken.

", + "wrapper":true + }, + "SnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You already have a snapshot with the given name.

", + "error":{ + "code":"SnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotArnsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SnapshotArn" + } + }, + "SnapshotFeatureNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You attempted one of the following operations:

  • Creating a snapshot of a Redis cluster running on a cache.t1.micro cache node.

  • Creating a snapshot of a cluster that is running Memcached rather than Redis.

Neither of these are supported by ElastiCache.

", + "error":{ + "code":"SnapshotFeatureNotSupportedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested snapshot name does not refer to an existing snapshot.

", + "error":{ + "code":"SnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would exceed the maximum number of snapshots.

", + "error":{ + "code":"SnapshotQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "cache-cluster", + "cache-parameter-group", + "cache-security-group", + "cache-subnet-group", + "replication-group" + ] + }, + "StartMigrationMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "CustomerNodeEndpointList" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group to which data should be migrated.

" + }, + "CustomerNodeEndpointList":{ + "shape":"CustomerNodeEndpointList", + "documentation":"

List of endpoints from which data should be migrated. For Redis (cluster mode disabled), list should have only one element.

" + } + } + }, + "StartMigrationResponse":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

The unique identifier for the subnet.

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

The Availability Zone associated with the subnet.

" + } + }, + "documentation":"

Represents the subnet associated with a cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with ElastiCache.

" + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested subnet is being used by another cache subnet group.

", + "error":{ + "code":"SubnetInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The key for the tag. May not be null.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The tag's value. May be null.

" + } + }, + "documentation":"

A cost allocation Tag that can be added to an ElastiCache cluster or replication group. Tags are composed of a Key/Value pair. A tag with a null Value is permitted.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

A list of cost allocation tags as key-value pairs.

" + } + }, + "documentation":"

Represents the output from the AddTagsToResource, ListTagsForResource, and RemoveTagsFromResource operations.

" + }, + "TagNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested tag was not found on this resource.

", + "error":{ + "code":"TagNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "TagQuotaPerResourceExceeded":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request cannot be processed because it would cause the resource to have more than the allowed number of tags. The maximum number of tags permitted on a resource is 50.

", + "error":{ + "code":"TagQuotaPerResourceExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TestFailoverMessage":{ + "type":"structure", + "required":[ + "ReplicationGroupId", + "NodeGroupId" + ], + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The name of the replication group (console: cluster) whose automatic failover is being tested by this operation.

" + }, + "NodeGroupId":{ + "shape":"AllowedNodeGroupId", + "documentation":"

The name of the node group (called shard in the console) in this replication group on which automatic failover is to be tested. You may test automatic failover on up to 5 node groups in any rolling 24-hour period.

" + } + } + }, + "TestFailoverNotAvailableFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The TestFailover action is not available.

", + "error":{ + "code":"TestFailoverNotAvailableFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TestFailoverResult":{ + "type":"structure", + "members":{ + "ReplicationGroup":{"shape":"ReplicationGroup"} + } + }, + "TimeRangeFilter":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"TStamp", + "documentation":"

The start time of the time range filter

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end time of the time range filter

" + } + }, + "documentation":"

Filters update actions from the service updates that are in available status during the time range.

" + }, + "UnprocessedUpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The replication group ID

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cache cluster

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ErrorType":{ + "shape":"String", + "documentation":"

The error type for requests that are not processed

" + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

The error message that describes the reason the request was not processed

" + } + }, + "documentation":"

Update action that has failed to be processed for the corresponding apply/stop request

" + }, + "UnprocessedUpdateActionList":{ + "type":"list", + "member":{ + "shape":"UnprocessedUpdateAction", + "locationName":"UnprocessedUpdateAction" + } + }, + "UpdateAction":{ + "type":"structure", + "members":{ + "ReplicationGroupId":{ + "shape":"String", + "documentation":"

The ID of the replication group

" + }, + "CacheClusterId":{ + "shape":"String", + "documentation":"

The ID of the cache cluster

" + }, + "ServiceUpdateName":{ + "shape":"String", + "documentation":"

The unique ID of the service update

" + }, + "ServiceUpdateReleaseDate":{ + "shape":"TStamp", + "documentation":"

The date the update is first available

" + }, + "ServiceUpdateSeverity":{ + "shape":"ServiceUpdateSeverity", + "documentation":"

The severity of the service update

" + }, + "ServiceUpdateStatus":{ + "shape":"ServiceUpdateStatus", + "documentation":"

The status of the service update

" + }, + "ServiceUpdateRecommendedApplyByDate":{ + "shape":"TStamp", + "documentation":"

The recommended date to apply the service update to ensure compliance. For information on compliance, see Self-Service Security Updates for Compliance.

" + }, + "ServiceUpdateType":{ + "shape":"ServiceUpdateType", + "documentation":"

Reflects the nature of the service update

" + }, + "UpdateActionAvailableDate":{ + "shape":"TStamp", + "documentation":"

The date that the service update is available to a replication group

" + }, + "UpdateActionStatus":{ + "shape":"UpdateActionStatus", + "documentation":"

The status of the update action

" + }, + "NodesUpdated":{ + "shape":"String", + "documentation":"

The progress of the service update on the replication group

" + }, + "UpdateActionStatusModifiedDate":{ + "shape":"TStamp", + "documentation":"

The date when the UpdateActionStatus was last modified

" + }, + "SlaMet":{ + "shape":"SlaMet", + "documentation":"

If yes, all nodes in the replication group have been updated by the recommended apply-by date. If no, at least one node in the replication group have not been updated by the recommended apply-by date. If N/A, the replication group was created after the recommended apply-by date.

" + }, + "NodeGroupUpdateStatus":{ + "shape":"NodeGroupUpdateStatusList", + "documentation":"

The status of the service update on the node group

" + }, + "CacheNodeUpdateStatus":{ + "shape":"CacheNodeUpdateStatusList", + "documentation":"

The status of the service update on the cache node

" + }, + "EstimatedUpdateTime":{ + "shape":"String", + "documentation":"

The estimated length of time for the update to complete

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The Elasticache engine to which the update applies. Either Redis or Memcached

" + } + }, + "documentation":"

The status of the service update for a specific replication group

" + }, + "UpdateActionList":{ + "type":"list", + "member":{ + "shape":"UpdateAction", + "locationName":"UpdateAction" + } + }, + "UpdateActionResultsMessage":{ + "type":"structure", + "members":{ + "ProcessedUpdateActions":{ + "shape":"ProcessedUpdateActionList", + "documentation":"

Update actions that have been processed successfully

" + }, + "UnprocessedUpdateActions":{ + "shape":"UnprocessedUpdateActionList", + "documentation":"

Update actions that haven't been processed successfully

" + } + } + }, + "UpdateActionStatus":{ + "type":"string", + "enum":[ + "not-applied", + "waiting-to-start", + "in-progress", + "stopping", + "stopped", + "complete" + ] + }, + "UpdateActionStatusList":{ + "type":"list", + "member":{"shape":"UpdateActionStatus"}, + "max":6 + }, + "UpdateActionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "UpdateActions":{ + "shape":"UpdateActionList", + "documentation":"

Returns a list of update actions

" + } + } + } + }, + "documentation":"Amazon ElastiCache

Amazon ElastiCache is a web service that makes it easier to set up, operate, and scale a distributed cache in the cloud.

With ElastiCache, customers get all of the benefits of a high-performance, in-memory cache with less of the administrative burden involved in launching and managing a distributed cache. The service makes setup, scaling, and cluster failure handling much simpler than in a self-managed cache deployment.

In addition, through integration with Amazon CloudWatch, customers get enhanced visibility into the key performance statistics associated with their cache and can receive alarms if a part of their cache runs hot.

" +} diff --git a/aws/dist/botocore/data/elasticache/2015-02-02/waiters-2.json b/aws/dist/botocore/data/elasticache/2015-02-02/waiters-2.json new file mode 100644 index 00000000..c177d7b9 --- /dev/null +++ b/aws/dist/botocore/data/elasticache/2015-02-02/waiters-2.json @@ -0,0 +1,143 @@ +{ + "version":2, + "waiters":{ + "CacheClusterAvailable":{ + "acceptors":[ + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleted", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleting", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"restore-failed", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache cluster is available.", + "maxAttempts":40, + "operation":"DescribeCacheClusters" + }, + "CacheClusterDeleted":{ + "acceptors":[ + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"deleted", + "matcher":"pathAll", + "state":"success" + }, + { + "expected":"CacheClusterNotFound", + "matcher":"error", + "state":"success" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"creating", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"incompatible-network", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"modifying", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"restore-failed", + "matcher":"pathAny", + "state":"failure" + }, + { + "argument":"CacheClusters[].CacheClusterStatus", + "expected":"snapshotting", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache cluster is deleted.", + "maxAttempts":40, + "operation":"DescribeCacheClusters" + }, + "ReplicationGroupAvailable":{ + "acceptors":[ + { + "argument":"ReplicationGroups[].Status", + "expected":"available", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationGroups[].Status", + "expected":"deleted", + "matcher":"pathAny", + "state":"failure" + } + ], + "delay":15, + "description":"Wait until ElastiCache replication group is available.", + "maxAttempts":40, + "operation":"DescribeReplicationGroups" + }, + "ReplicationGroupDeleted":{ + "acceptors":[ + { + "argument":"ReplicationGroups[].Status", + "expected":"deleted", + "matcher":"pathAll", + "state":"success" + }, + { + "argument":"ReplicationGroups[].Status", + "expected":"available", + "matcher":"pathAny", + "state":"failure" + }, + { + "expected":"ReplicationGroupNotFoundFault", + "matcher":"error", + "state":"success" + } + ], + "delay":15, + "description":"Wait until ElastiCache replication group is deleted.", + "maxAttempts":40, + "operation":"DescribeReplicationGroups" + } + } +} diff --git a/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/examples-1.json b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/examples-1.json new file mode 100644 index 00000000..0fded628 --- /dev/null +++ b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/examples-1.json @@ -0,0 +1,1109 @@ +{ + "version": "1.0", + "examples": { + "AbortEnvironmentUpdate": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following code aborts a running application version deployment for an environment named my-env:", + "id": "to-abort-a-deployment-1456267848227", + "title": "To abort a deployment" + } + ], + "CheckDNSAvailability": [ + { + "input": { + "CNAMEPrefix": "my-cname" + }, + "output": { + "Available": true, + "FullyQualifiedCNAME": "my-cname.us-west-2.elasticbeanstalk.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation checks the availability of the subdomain my-cname:", + "id": "to-check-the-availability-of-a-cname-1456268589537", + "title": "To check the availability of a CNAME" + } + ], + "CreateApplication": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "my application" + }, + "output": { + "Application": { + "ApplicationName": "my-app", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-02-12T18:32:21.181Z", + "DateUpdated": "2015-02-12T18:32:21.181Z", + "Description": "my application" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new application named my-app:", + "id": "to-create-a-new-application-1456268895683", + "title": "To create a new application" + } + ], + "CreateApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "AutoCreateApplication": true, + "Description": "my-app-v1", + "Process": true, + "SourceBundle": { + "S3Bucket": "my-bucket", + "S3Key": "sample.war" + }, + "VersionLabel": "v1" + }, + "output": { + "ApplicationVersion": { + "ApplicationName": "my-app", + "DateCreated": "2015-02-03T23:01:25.412Z", + "DateUpdated": "2015-02-03T23:01:25.412Z", + "Description": "my-app-v1", + "SourceBundle": { + "S3Bucket": "my-bucket", + "S3Key": "sample.war" + }, + "VersionLabel": "v1" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new version (v1) of an application named my-app:", + "id": "to-create-a-new-application-1456268895683", + "title": "To create a new application" + } + ], + "CreateConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentId": "e-rpqsewtp2j", + "TemplateName": "my-app-v1" + }, + "output": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-12T18:40:39Z", + "DateUpdated": "2015-08-12T18:40:39Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "TemplateName": "my-app-v1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:", + "id": "to-create-a-configuration-template-1456269283586", + "title": "To create a configuration template" + } + ], + "CreateEnvironment": [ + { + "input": { + "ApplicationName": "my-app", + "CNAMEPrefix": "my-app", + "EnvironmentName": "my-env", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "VersionLabel": "v1" + }, + "output": { + "ApplicationName": "my-app", + "CNAME": "my-app.elasticbeanstalk.com", + "DateCreated": "2015-02-03T23:04:54.479Z", + "DateUpdated": "2015-02-03T23:04:54.479Z", + "EnvironmentId": "e-izqpassy4h", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Launching", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "v1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new environment for version v1 of a java application named my-app:", + "id": "to-create-a-new-environment-for-an-application-1456269380396", + "title": "To create a new environment for an application" + } + ], + "CreateStorageLocation": [ + { + "output": { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates a new environment for version v1 of a java application named my-app:", + "id": "to-create-a-new-environment-for-an-application-1456269380396", + "title": "To create a new environment for an application" + } + ], + "DeleteApplication": [ + { + "input": { + "ApplicationName": "my-app" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes an application named my-app:", + "id": "to-delete-an-application-1456269699366", + "title": "To delete an application" + } + ], + "DeleteApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "DeleteSourceBundle": true, + "VersionLabel": "22a0-stage-150819_182129" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:", + "id": "to-delete-an-application-version-1456269792956", + "title": "To delete an application version" + } + ], + "DeleteConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "TemplateName": "my-template" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes a configuration template named my-template for an application named my-app:", + "id": "to-delete-a-configuration-template-1456269836701", + "title": "To delete a configuration template" + } + ], + "DeleteEnvironmentConfiguration": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation deletes a draft configuration for an environment named my-env:", + "id": "to-delete-a-draft-configuration-1456269886654", + "title": "To delete a draft configuration" + } + ], + "DescribeApplicationVersions": [ + { + "input": { + "ApplicationName": "my-app", + "VersionLabels": [ + "v2" + ] + }, + "output": { + "ApplicationVersions": [ + { + "ApplicationName": "my-app", + "DateCreated": "2015-07-23T01:32:26.079Z", + "DateUpdated": "2015-07-23T01:32:26.079Z", + "Description": "update cover page", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_224258.war" + }, + "VersionLabel": "v2" + }, + { + "ApplicationName": "my-app", + "DateCreated": "2015-07-23T22:26:10.816Z", + "DateUpdated": "2015-07-23T22:26:10.816Z", + "Description": "initial version", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-015321684451", + "S3Key": "my-app/5026-stage-150723_222618.war" + }, + "VersionLabel": "v1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about an application version labeled v2:", + "id": "to-view-information-about-an-application-version-1456269947428", + "title": "To view information about an application version" + } + ], + "DescribeApplications": [ + { + "input": { + }, + "output": { + "Applications": [ + { + "ApplicationName": "ruby", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T21:05:44.376Z", + "DateUpdated": "2015-08-13T21:05:44.376Z", + "Versions": [ + "Sample Application" + ] + }, + { + "ApplicationName": "pythonsample", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T19:05:43.637Z", + "DateUpdated": "2015-08-13T19:05:43.637Z", + "Description": "Application created from the EB CLI using \"eb init\"", + "Versions": [ + "Sample Application" + ] + }, + { + "ApplicationName": "nodejs-example", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-06T17:50:02.486Z", + "DateUpdated": "2015-08-06T17:50:02.486Z", + "Versions": [ + "add elasticache", + "First Release" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about applications in the current region:", + "id": "to-view-a-list-of-applications-1456270027373", + "title": "To view a list of applications" + } + ], + "DescribeConfigurationOptions": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "output": { + "Options": [ + { + "ChangeSeverity": "NoInterruption", + "DefaultValue": "30", + "MaxValue": 300, + "MinValue": 5, + "Name": "Interval", + "Namespace": "aws:elb:healthcheck", + "UserDefined": false, + "ValueType": "Scalar" + }, + { + "ChangeSeverity": "NoInterruption", + "DefaultValue": "2000000", + "MinValue": 0, + "Name": "LowerThreshold", + "Namespace": "aws:autoscaling:trigger", + "UserDefined": false, + "ValueType": "Scalar" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves descriptions of all available configuration options for an environment named my-env:", + "id": "to-view-configuration-options-for-an-environment-1456276763917", + "title": "To view configuration options for an environment" + } + ], + "DescribeConfigurationSettings": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env" + }, + "output": { + "ConfigurationSettings": [ + { + "ApplicationName": "my-app", + "DateCreated": "2015-08-13T19:16:25Z", + "DateUpdated": "2015-08-13T23:30:07Z", + "DeploymentStatus": "deployed", + "Description": "Environment created from the EB CLI using \"eb create\"", + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:autoscaling:asg", + "OptionName": "Availability Zones", + "ResourceName": "AWSEBAutoScalingGroup", + "Value": "Any" + }, + { + "Namespace": "aws:autoscaling:asg", + "OptionName": "Cooldown", + "ResourceName": "AWSEBAutoScalingGroup", + "Value": "360" + }, + { + "Namespace": "aws:elb:policies", + "OptionName": "ConnectionDrainingTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Value": "20" + }, + { + "Namespace": "aws:elb:policies", + "OptionName": "ConnectionSettingIdleTimeout", + "ResourceName": "AWSEBLoadBalancer", + "Value": "60" + } + ], + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8" + } + ] + }, + "comments": { + "input": { + }, + "output": { + "abbreviated": "Output is abbreviated" + } + }, + "description": "The following operation retrieves configuration settings for an environment named my-env:", + "id": "to-view-configurations-settings-for-an-environment-1456276924537", + "title": "To view configurations settings for an environment" + } + ], + "DescribeEnvironmentHealth": [ + { + "input": { + "AttributeNames": [ + "All" + ], + "EnvironmentName": "my-env" + }, + "output": { + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P10": 0.001, + "P50": 0.001, + "P75": 0.002, + "P85": 0.003, + "P90": 0.003, + "P95": 0.004, + "P99": 0.004, + "P999": 0.004 + }, + "RequestCount": 45, + "StatusCodes": { + "Status2xx": 45, + "Status3xx": 0, + "Status4xx": 0, + "Status5xx": 0 + } + }, + "Causes": [ + + ], + "Color": "Green", + "EnvironmentName": "my-env", + "HealthStatus": "Ok", + "InstancesHealth": { + "Degraded": 0, + "Info": 0, + "NoData": 0, + "Ok": 1, + "Pending": 0, + "Severe": 0, + "Unknown": 0, + "Warning": 0 + }, + "RefreshedAt": "2015-08-20T21:09:18Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves overall health information for an environment named my-env:", + "id": "to-view-environment-health-1456277109510", + "title": "To view environment health" + } + ], + "DescribeEnvironmentResources": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "EnvironmentResources": { + "AutoScalingGroups": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingGroup-QSB2ZO88SXZT" + } + ], + "EnvironmentName": "my-env", + "Instances": [ + { + "Id": "i-0c91c786" + } + ], + "LaunchConfigurations": [ + { + "Name": "awseb-e-qu3fyyjyjs-stack-AWSEBAutoScalingLaunchConfiguration-1UUVQIBC96TQ2" + } + ], + "LoadBalancers": [ + { + "Name": "awseb-e-q-AWSEBLoa-1EEPZ0K98BIF0" + } + ], + "Queues": [ + + ], + "Triggers": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about resources in an environment named my-env:", + "id": "to-view-information-about-the-aws-resources-in-your-environment-1456277206232", + "title": "To view information about the AWS resources in your environment" + } + ], + "DescribeEnvironments": [ + { + "input": { + "EnvironmentNames": [ + "my-env" + ] + }, + "output": { + "Environments": [ + { + "AbortableOperationInProgress": false, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-07T20:48:49.599Z", + "DateUpdated": "2015-08-12T18:16:55.019Z", + "EndpointURL": "awseb-e-w-AWSEBLoa-1483140XB0Q4L-109QXY8121.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-rpqsewtp2j", + "EnvironmentName": "my-env", + "Health": "Green", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Ready", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "7f58-stage-150812_025409" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves information about an environment named my-env:", + "id": "to-view-information-about-an-environment-1456277288662", + "title": "To view information about an environment" + } + ], + "DescribeEvents": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "Events": [ + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-20T07:06:53.535Z", + "Message": "Environment health has transitioned from Info to Ok.", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-20T07:06:02.049Z", + "Message": "Environment update completed successfully.", + "RequestId": "b7f3960b-4709-11e5-ba1e-07e16200da41", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-13T19:16:27.561Z", + "Message": "Using elasticbeanstalk-us-west-2-012445113685 as Amazon S3 storage bucket for environment data.", + "RequestId": "ca8dfbf6-41ef-11e5-988b-651aa638f46b", + "Severity": "INFO" + }, + { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "EventDate": "2015-08-13T19:16:26.581Z", + "Message": "createEnvironment is starting.", + "RequestId": "cdfba8f6-41ef-11e5-988b-65638f41aa6b", + "Severity": "INFO" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves events for an environment named my-env:", + "id": "to-view-events-for-an-environment-1456277367589", + "title": "To view events for an environment" + } + ], + "DescribeInstancesHealth": [ + { + "input": { + "AttributeNames": [ + "All" + ], + "EnvironmentName": "my-env" + }, + "output": { + "InstanceHealthList": [ + { + "ApplicationMetrics": { + "Duration": 10, + "Latency": { + "P10": 0, + "P50": 0.001, + "P75": 0.002, + "P85": 0.003, + "P90": 0.004, + "P95": 0.005, + "P99": 0.006, + "P999": 0.006 + }, + "RequestCount": 48, + "StatusCodes": { + "Status2xx": 47, + "Status3xx": 0, + "Status4xx": 1, + "Status5xx": 0 + } + }, + "Causes": [ + + ], + "Color": "Green", + "HealthStatus": "Ok", + "InstanceId": "i-08691cc7", + "LaunchedAt": "2015-08-13T19:17:09Z", + "System": { + "CPUUtilization": { + "IOWait": 0.2, + "IRQ": 0, + "Idle": 97.8, + "Nice": 0.1, + "SoftIRQ": 0.1, + "System": 0.3, + "User": 1.5 + }, + "LoadAverage": [ + 0, + 0.02, + 0.05 + ] + } + } + ], + "RefreshedAt": "2015-08-20T21:09:08Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves health information for instances in an environment named my-env:", + "id": "to-view-environment-health-1456277424757", + "title": "To view environment health" + } + ], + "ListAvailableSolutionStacks": [ + { + "output": { + "SolutionStackDetails": [ + { + "PermittedFileTypes": [ + "zip" + ], + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Node.js" + } + ], + "SolutionStacks": [ + "64bit Amazon Linux 2015.03 v2.0.0 running Node.js", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.6", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.5", + "64bit Amazon Linux 2015.03 v2.0.0 running PHP 5.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 3.4", + "64bit Amazon Linux 2015.03 v2.0.0 running Python 2.7", + "64bit Amazon Linux 2015.03 v2.0.0 running Python", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.2 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.1 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Puma)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 2.0 (Passenger Standalone)", + "64bit Amazon Linux 2015.03 v2.0.0 running Ruby 1.9.3", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 7", + "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 7 Java 6", + "64bit Windows Server Core 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 R2 running IIS 8.5", + "64bit Windows Server 2012 running IIS 8", + "64bit Windows Server 2008 R2 running IIS 7.5", + "64bit Amazon Linux 2015.03 v2.0.0 running Docker 1.6.2", + "64bit Amazon Linux 2015.03 v2.0.0 running Multi-container Docker 1.6.2 (Generic)", + "64bit Debian jessie v2.0.0 running GlassFish 4.1 Java 8 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running GlassFish 4.0 Java 7 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.4 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Go 1.3 (Preconfigured - Docker)", + "64bit Debian jessie v2.0.0 running Python 3.4 (Preconfigured - Docker)" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:", + "id": "to-view-solution-stacks-1456277504811", + "title": "To view solution stacks" + } + ], + "RebuildEnvironment": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation terminates and recreates the resources in an environment named my-env:", + "id": "to-rebuild-an-environment-1456277600918", + "title": "To rebuild an environment" + } + ], + "RequestEnvironmentInfo": [ + { + "input": { + "EnvironmentName": "my-env", + "InfoType": "tail" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation requests logs from an environment named my-env:", + "id": "to-request-tailed-logs-1456277657045", + "title": "To request tailed logs" + } + ], + "RestartAppServer": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation restarts application servers on all instances in an environment named my-env:", + "id": "to-restart-application-servers-1456277739302", + "title": "To restart application servers" + } + ], + "RetrieveEnvironmentInfo": [ + { + "input": { + "EnvironmentName": "my-env", + "InfoType": "tail" + }, + "output": { + "EnvironmentInfo": [ + { + "Ec2InstanceId": "i-09c1c867", + "InfoType": "tail", + "Message": "https://elasticbeanstalk-us-west-2-0123456789012.s3.amazonaws.com/resources/environments/logs/tail/e-fyqyju3yjs/i-09c1c867/TailLogs-1440109397703.out?AWSAccessKeyId=AKGPT4J56IAJ2EUBL5CQ&Expires=1440195891&Signature=n%2BEalOV6A2HIOx4Rcfb7LT16bBM%3D", + "SampleTimestamp": "2015-08-20T22:23:17.703Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation retrieves a link to logs from an environment named my-env:", + "id": "to-retrieve-tailed-logs-1456277792734", + "title": "To retrieve tailed logs" + } + ], + "SwapEnvironmentCNAMEs": [ + { + "input": { + "DestinationEnvironmentName": "my-env-green", + "SourceEnvironmentName": "my-env-blue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation swaps the assigned subdomains of two environments:", + "id": "to-swap-environment-cnames-1456277839438", + "title": "To swap environment CNAMES" + } + ], + "TerminateEnvironment": [ + { + "input": { + "EnvironmentName": "my-env" + }, + "output": { + "AbortableOperationInProgress": false, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-12T18:52:53.622Z", + "DateUpdated": "2015-08-12T19:05:54.744Z", + "EndpointURL": "awseb-e-f-AWSEBLoa-1I9XUMP4-8492WNUP202574.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-fh2eravpns", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Terminating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation terminates an Elastic Beanstalk environment named my-env:", + "id": "to-terminate-an-environment-1456277888556", + "title": "To terminate an environment" + } + ], + "UpdateApplication": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "my Elastic Beanstalk application" + }, + "output": { + "Application": { + "ApplicationName": "my-app", + "ConfigurationTemplates": [ + + ], + "DateCreated": "2015-08-13T19:15:50.449Z", + "DateUpdated": "2015-08-20T22:34:56.195Z", + "Description": "my Elastic Beanstalk application", + "Versions": [ + "2fba-stage-150819_234450", + "bf07-stage-150820_214945", + "93f8", + "fd7c-stage-150820_000431", + "22a0-stage-150819_185942" + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates the description of an application named my-app:", + "id": "to-change-an-applications-description-1456277957075", + "title": "To change an application's description" + } + ], + "UpdateApplicationVersion": [ + { + "input": { + "ApplicationName": "my-app", + "Description": "new description", + "VersionLabel": "22a0-stage-150819_185942" + }, + "output": { + "ApplicationVersion": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-19T18:59:17.646Z", + "DateUpdated": "2015-08-20T22:53:28.871Z", + "Description": "new description", + "SourceBundle": { + "S3Bucket": "elasticbeanstalk-us-west-2-0123456789012", + "S3Key": "my-app/22a0-stage-150819_185942.war" + }, + "VersionLabel": "22a0-stage-150819_185942" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates the description of an application version named 22a0-stage-150819_185942:", + "id": "to-change-an-application-versions-description-1456278019237", + "title": "To change an application version's description" + } + ], + "UpdateConfigurationTemplate": [ + { + "input": { + "ApplicationName": "my-app", + "OptionsToRemove": [ + { + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "OptionName": "ConfigDocument" + } + ], + "TemplateName": "my-template" + }, + "output": { + "ApplicationName": "my-app", + "DateCreated": "2015-08-20T22:39:31Z", + "DateUpdated": "2015-08-20T22:43:11Z", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "TemplateName": "my-template" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:", + "id": "to-update-a-configuration-template-1456278075300", + "title": "To update a configuration template" + } + ], + "UpdateEnvironment": [ + { + "input": { + "EnvironmentName": "my-env", + "VersionLabel": "v2" + }, + "output": { + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-02-03T23:04:54.453Z", + "DateUpdated": "2015-02-03T23:12:29.119Z", + "EndpointURL": "awseb-e-i-AWSEBLoa-1RDLX6TC9VUAO-0123456789.us-west-2.elb.amazonaws.com", + "EnvironmentId": "e-szqipays4h", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux running Tomcat 7", + "Status": "Updating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "v2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation updates an environment named \"my-env\" to version \"v2\" of the application to which it belongs:", + "id": "to-update-an-environment-to-a-new-version-1456278210718", + "title": "To update an environment to a new version" + }, + { + "input": { + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Interval", + "Value": "15" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "Timeout", + "Value": "8" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "HealthyThreshold", + "Value": "2" + }, + { + "Namespace": "aws:elb:healthcheck", + "OptionName": "UnhealthyThreshold", + "Value": "3" + } + ] + }, + "output": { + "AbortableOperationInProgress": true, + "ApplicationName": "my-app", + "CNAME": "my-env.elasticbeanstalk.com", + "DateCreated": "2015-08-07T20:48:49.599Z", + "DateUpdated": "2015-08-12T18:15:23.804Z", + "EndpointURL": "awseb-e-w-AWSEBLoa-14XB83101Q4L-104QXY80921.sa-east-1.elb.amazonaws.com", + "EnvironmentId": "e-wtp2rpqsej", + "EnvironmentName": "my-env", + "Health": "Grey", + "SolutionStackName": "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8", + "Status": "Updating", + "Tier": { + "Name": "WebServer", + "Type": "Standard", + "Version": " " + }, + "VersionLabel": "7f58-stage-150812_025409" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation configures several options in the aws:elb:loadbalancer namespace:", + "id": "to-configure-option-settings-1456278286349", + "title": "To configure option settings" + } + ], + "ValidateConfigurationSettings": [ + { + "input": { + "ApplicationName": "my-app", + "EnvironmentName": "my-env", + "OptionSettings": [ + { + "Namespace": "aws:elasticbeanstalk:healthreporting:system", + "OptionName": "ConfigDocument", + "Value": "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}" + } + ] + }, + "output": { + "Messages": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation validates a CloudWatch custom metrics config document:", + "id": "to-validate-configuration-settings-1456278393654", + "title": "To validate configuration settings" + } + ] + } +} diff --git a/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json new file mode 100644 index 00000000..4f53c866 --- /dev/null +++ b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "DescribeEvents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeApplicationVersions": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "ApplicationVersions" + }, + "DescribeEnvironmentManagedActionHistory": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "ManagedActionHistoryItems" + }, + "DescribeEnvironments": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "Environments" + }, + "ListPlatformVersions": { + "input_token": "NextToken", + "limit_key": "MaxRecords", + "output_token": "NextToken", + "result_key": "PlatformSummaryList" + } + } +} diff --git a/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/service-2.json b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/service-2.json new file mode 100644 index 00000000..b66e5eab --- /dev/null +++ b/aws/dist/botocore/data/elasticbeanstalk/2010-12-01/service-2.json @@ -0,0 +1,4031 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-12-01", + "endpointPrefix":"elasticbeanstalk", + "protocol":"query", + "serviceAbbreviation":"Elastic Beanstalk", + "serviceFullName":"AWS Elastic Beanstalk", + "serviceId":"Elastic Beanstalk", + "signatureVersion":"v4", + "uid":"elasticbeanstalk-2010-12-01", + "xmlNamespace":"http://elasticbeanstalk.amazonaws.com/docs/2010-12-01/" + }, + "operations":{ + "AbortEnvironmentUpdate":{ + "name":"AbortEnvironmentUpdate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AbortEnvironmentUpdateMessage"}, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Cancels in-progress environment configuration update or application version deployment.

" + }, + "ApplyEnvironmentManagedAction":{ + "name":"ApplyEnvironmentManagedAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyEnvironmentManagedActionRequest"}, + "output":{ + "shape":"ApplyEnvironmentManagedActionResult", + "resultWrapper":"ApplyEnvironmentManagedActionResult" + }, + "errors":[ + {"shape":"ElasticBeanstalkServiceException"}, + {"shape":"ManagedActionInvalidStateException"} + ], + "documentation":"

Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

" + }, + "CheckDNSAvailability":{ + "name":"CheckDNSAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CheckDNSAvailabilityMessage"}, + "output":{ + "shape":"CheckDNSAvailabilityResultMessage", + "resultWrapper":"CheckDNSAvailabilityResult" + }, + "documentation":"

Checks if the specified CNAME is available.

" + }, + "ComposeEnvironments":{ + "name":"ComposeEnvironments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ComposeEnvironmentsMessage"}, + "output":{ + "shape":"EnvironmentDescriptionsMessage", + "resultWrapper":"ComposeEnvironmentsResult" + }, + "errors":[ + {"shape":"TooManyEnvironmentsException"}, + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationMessage"}, + "output":{ + "shape":"ApplicationDescriptionMessage", + "resultWrapper":"CreateApplicationResult" + }, + "errors":[ + {"shape":"TooManyApplicationsException"} + ], + "documentation":"

Creates an application that has one configuration template named default and no application versions.

" + }, + "CreateApplicationVersion":{ + "name":"CreateApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationVersionMessage"}, + "output":{ + "shape":"ApplicationVersionDescriptionMessage", + "resultWrapper":"CreateApplicationVersionResult" + }, + "errors":[ + {"shape":"TooManyApplicationsException"}, + {"shape":"TooManyApplicationVersionsException"}, + {"shape":"InsufficientPrivilegesException"}, + {"shape":"S3LocationNotInServiceRegionException"}, + {"shape":"CodeBuildNotInServiceRegionException"} + ], + "documentation":"

Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

Specify a source bundle in S3 with SourceBundle

Omit both SourceBuildInformation and SourceBundle to use the default sample application.

Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

" + }, + "CreateConfigurationTemplate":{ + "name":"CreateConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConfigurationTemplateMessage"}, + "output":{ + "shape":"ConfigurationSettingsDescription", + "resultWrapper":"CreateConfigurationTemplateResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"TooManyBucketsException"}, + {"shape":"TooManyConfigurationTemplatesException"} + ], + "documentation":"

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Templates aren't associated with any environment. The EnvironmentName response element is always null.

Related Topics

" + }, + "CreateEnvironment":{ + "name":"CreateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEnvironmentMessage"}, + "output":{ + "shape":"EnvironmentDescription", + "resultWrapper":"CreateEnvironmentResult" + }, + "errors":[ + {"shape":"TooManyEnvironmentsException"}, + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Launches an environment for the specified application using the specified configuration.

" + }, + "CreatePlatformVersion":{ + "name":"CreatePlatformVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlatformVersionRequest"}, + "output":{ + "shape":"CreatePlatformVersionResult", + "resultWrapper":"CreatePlatformVersionResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"ElasticBeanstalkServiceException"}, + {"shape":"TooManyPlatformsException"} + ], + "documentation":"

Create a new version of your custom platform.

" + }, + "CreateStorageLocation":{ + "name":"CreateStorageLocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"CreateStorageLocationResultMessage", + "resultWrapper":"CreateStorageLocationResult" + }, + "errors":[ + {"shape":"TooManyBucketsException"}, + {"shape":"S3SubscriptionRequiredException"}, + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationMessage"}, + "errors":[ + {"shape":"OperationInProgressException"} + ], + "documentation":"

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

You cannot delete an application that has a running environment.

" + }, + "DeleteApplicationVersion":{ + "name":"DeleteApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationVersionMessage"}, + "errors":[ + {"shape":"SourceBundleDeletionException"}, + {"shape":"InsufficientPrivilegesException"}, + {"shape":"OperationInProgressException"}, + {"shape":"S3LocationNotInServiceRegionException"} + ], + "documentation":"

Deletes the specified version from the specified application.

You cannot delete an application version that is associated with a running environment.

" + }, + "DeleteConfigurationTemplate":{ + "name":"DeleteConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationTemplateMessage"}, + "errors":[ + {"shape":"OperationInProgressException"} + ], + "documentation":"

Deletes the specified configuration template.

When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

" + }, + "DeleteEnvironmentConfiguration":{ + "name":"DeleteEnvironmentConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEnvironmentConfigurationMessage"}, + "documentation":"

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

" + }, + "DeletePlatformVersion":{ + "name":"DeletePlatformVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlatformVersionRequest"}, + "output":{ + "shape":"DeletePlatformVersionResult", + "resultWrapper":"DeletePlatformVersionResult" + }, + "errors":[ + {"shape":"OperationInProgressException"}, + {"shape":"InsufficientPrivilegesException"}, + {"shape":"ElasticBeanstalkServiceException"}, + {"shape":"PlatformVersionStillReferencedException"} + ], + "documentation":"

Deletes the specified version of a custom platform.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"DescribeAccountAttributesResult", + "resultWrapper":"DescribeAccountAttributesResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

The result currently has one set of attributes—resource quotas.

" + }, + "DescribeApplicationVersions":{ + "name":"DescribeApplicationVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationVersionsMessage"}, + "output":{ + "shape":"ApplicationVersionDescriptionsMessage", + "resultWrapper":"DescribeApplicationVersionsResult" + }, + "documentation":"

Retrieve a list of application versions.

" + }, + "DescribeApplications":{ + "name":"DescribeApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationsMessage"}, + "output":{ + "shape":"ApplicationDescriptionsMessage", + "resultWrapper":"DescribeApplicationsResult" + }, + "documentation":"

Returns the descriptions of existing applications.

" + }, + "DescribeConfigurationOptions":{ + "name":"DescribeConfigurationOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationOptionsMessage"}, + "output":{ + "shape":"ConfigurationOptionsDescription", + "resultWrapper":"DescribeConfigurationOptionsResult" + }, + "errors":[ + {"shape":"TooManyBucketsException"} + ], + "documentation":"

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

" + }, + "DescribeConfigurationSettings":{ + "name":"DescribeConfigurationSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationSettingsMessage"}, + "output":{ + "shape":"ConfigurationSettingsDescriptions", + "resultWrapper":"DescribeConfigurationSettingsResult" + }, + "errors":[ + {"shape":"TooManyBucketsException"} + ], + "documentation":"

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

" + }, + "DescribeEnvironmentHealth":{ + "name":"DescribeEnvironmentHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentHealthRequest"}, + "output":{ + "shape":"DescribeEnvironmentHealthResult", + "resultWrapper":"DescribeEnvironmentHealthResult" + }, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

" + }, + "DescribeEnvironmentManagedActionHistory":{ + "name":"DescribeEnvironmentManagedActionHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentManagedActionHistoryRequest"}, + "output":{ + "shape":"DescribeEnvironmentManagedActionHistoryResult", + "resultWrapper":"DescribeEnvironmentManagedActionHistoryResult" + }, + "errors":[ + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Lists an environment's completed and failed managed actions.

" + }, + "DescribeEnvironmentManagedActions":{ + "name":"DescribeEnvironmentManagedActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentManagedActionsRequest"}, + "output":{ + "shape":"DescribeEnvironmentManagedActionsResult", + "resultWrapper":"DescribeEnvironmentManagedActionsResult" + }, + "errors":[ + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Lists an environment's upcoming and in-progress managed actions.

" + }, + "DescribeEnvironmentResources":{ + "name":"DescribeEnvironmentResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentResourcesMessage"}, + "output":{ + "shape":"EnvironmentResourceDescriptionsMessage", + "resultWrapper":"DescribeEnvironmentResourcesResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Returns AWS resources for this environment.

" + }, + "DescribeEnvironments":{ + "name":"DescribeEnvironments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEnvironmentsMessage"}, + "output":{ + "shape":"EnvironmentDescriptionsMessage", + "resultWrapper":"DescribeEnvironmentsResult" + }, + "documentation":"

Returns descriptions for existing environments.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventDescriptionsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns list of event descriptions matching criteria up to the last 6 weeks.

This action returns the most recent 1,000 events from the specified NextToken.

" + }, + "DescribeInstancesHealth":{ + "name":"DescribeInstancesHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesHealthRequest"}, + "output":{ + "shape":"DescribeInstancesHealthResult", + "resultWrapper":"DescribeInstancesHealthResult" + }, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

" + }, + "DescribePlatformVersion":{ + "name":"DescribePlatformVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlatformVersionRequest"}, + "output":{ + "shape":"DescribePlatformVersionResult", + "resultWrapper":"DescribePlatformVersionResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Describes the version of the platform.

" + }, + "ListAvailableSolutionStacks":{ + "name":"ListAvailableSolutionStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListAvailableSolutionStacksResultMessage", + "resultWrapper":"ListAvailableSolutionStacksResult" + }, + "documentation":"

Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

" + }, + "ListPlatformVersions":{ + "name":"ListPlatformVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPlatformVersionsRequest"}, + "output":{ + "shape":"ListPlatformVersionsResult", + "resultWrapper":"ListPlatformVersionsResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"ElasticBeanstalkServiceException"} + ], + "documentation":"

Lists the available platforms.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"ResourceTagsDescriptionMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceTypeNotSupportedException"} + ], + "documentation":"

Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.

" + }, + "RebuildEnvironment":{ + "name":"RebuildEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebuildEnvironmentMessage"}, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

" + }, + "RequestEnvironmentInfo":{ + "name":"RequestEnvironmentInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestEnvironmentInfoMessage"}, + "documentation":"

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

" + }, + "RestartAppServer":{ + "name":"RestartAppServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestartAppServerMessage"}, + "documentation":"

Causes the environment to restart the application container server running on each Amazon EC2 instance.

" + }, + "RetrieveEnvironmentInfo":{ + "name":"RetrieveEnvironmentInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveEnvironmentInfoMessage"}, + "output":{ + "shape":"RetrieveEnvironmentInfoResultMessage", + "resultWrapper":"RetrieveEnvironmentInfoResult" + }, + "documentation":"

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

" + }, + "SwapEnvironmentCNAMEs":{ + "name":"SwapEnvironmentCNAMEs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SwapEnvironmentCNAMEsMessage"}, + "documentation":"

Swaps the CNAMEs of two environments.

" + }, + "TerminateEnvironment":{ + "name":"TerminateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateEnvironmentMessage"}, + "output":{ + "shape":"EnvironmentDescription", + "resultWrapper":"TerminateEnvironmentResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Terminates the specified environment.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationMessage"}, + "output":{ + "shape":"ApplicationDescriptionMessage", + "resultWrapper":"UpdateApplicationResult" + }, + "documentation":"

Updates the specified application to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

" + }, + "UpdateApplicationResourceLifecycle":{ + "name":"UpdateApplicationResourceLifecycle", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationResourceLifecycleMessage"}, + "output":{ + "shape":"ApplicationResourceLifecycleDescriptionMessage", + "resultWrapper":"UpdateApplicationResourceLifecycleResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"} + ], + "documentation":"

Modifies lifecycle settings for an application.

" + }, + "UpdateApplicationVersion":{ + "name":"UpdateApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationVersionMessage"}, + "output":{ + "shape":"ApplicationVersionDescriptionMessage", + "resultWrapper":"UpdateApplicationVersionResult" + }, + "documentation":"

Updates the specified application version to have the specified properties.

If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

" + }, + "UpdateConfigurationTemplate":{ + "name":"UpdateConfigurationTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConfigurationTemplateMessage"}, + "output":{ + "shape":"ConfigurationSettingsDescription", + "resultWrapper":"UpdateConfigurationTemplateResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"TooManyBucketsException"} + ], + "documentation":"

Updates the specified configuration template to have the specified properties or configuration option values.

If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

" + }, + "UpdateEnvironment":{ + "name":"UpdateEnvironment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEnvironmentMessage"}, + "output":{ + "shape":"EnvironmentDescription", + "resultWrapper":"UpdateEnvironmentResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"TooManyBucketsException"} + ], + "documentation":"

Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

" + }, + "UpdateTagsForResource":{ + "name":"UpdateTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTagsForResourceMessage"}, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"OperationInProgressException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceTypeNotSupportedException"} + ], + "documentation":"

Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.

Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments. For details about environment tagging, see Tagging Resources in Your Elastic Beanstalk Environment.

If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

elasticbeanstalk:AddTags

Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

elasticbeanstalk:RemoveTags

Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

For details about creating a custom user policy, see Creating a Custom User Policy.

" + }, + "ValidateConfigurationSettings":{ + "name":"ValidateConfigurationSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ValidateConfigurationSettingsMessage"}, + "output":{ + "shape":"ConfigurationSettingsValidationMessages", + "resultWrapper":"ValidateConfigurationSettingsResult" + }, + "errors":[ + {"shape":"InsufficientPrivilegesException"}, + {"shape":"TooManyBucketsException"} + ], + "documentation":"

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

" + } + }, + "shapes":{ + "ARN":{"type":"string"}, + "AbortEnvironmentUpdateMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

This specifies the ID of the environment with the in-progress update that you want to cancel.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

This specifies the name of the environment with the in-progress update that you want to cancel.

" + } + }, + "documentation":"

" + }, + "AbortableOperationInProgress":{"type":"boolean"}, + "ActionHistoryStatus":{ + "type":"string", + "enum":[ + "Completed", + "Failed", + "Unknown" + ] + }, + "ActionStatus":{ + "type":"string", + "enum":[ + "Scheduled", + "Pending", + "Running", + "Unknown" + ] + }, + "ActionType":{ + "type":"string", + "enum":[ + "InstanceRefresh", + "PlatformUpdate", + "Unknown" + ] + }, + "ApplicationArn":{"type":"string"}, + "ApplicationDescription":{ + "type":"structure", + "members":{ + "ApplicationArn":{ + "shape":"ApplicationArn", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

User-defined description of the application.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The date when the application was created.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The date when the application was last modified.

" + }, + "Versions":{ + "shape":"VersionLabelsList", + "documentation":"

The names of the versions for this application.

" + }, + "ConfigurationTemplates":{ + "shape":"ConfigurationTemplateNamesList", + "documentation":"

The names of the configuration templates associated with this application.

" + }, + "ResourceLifecycleConfig":{ + "shape":"ApplicationResourceLifecycleConfig", + "documentation":"

The lifecycle settings for the application.

" + } + }, + "documentation":"

Describes the properties of an application.

" + }, + "ApplicationDescriptionList":{ + "type":"list", + "member":{"shape":"ApplicationDescription"} + }, + "ApplicationDescriptionMessage":{ + "type":"structure", + "members":{ + "Application":{ + "shape":"ApplicationDescription", + "documentation":"

The ApplicationDescription of the application.

" + } + }, + "documentation":"

Result message containing a single description of an application.

" + }, + "ApplicationDescriptionsMessage":{ + "type":"structure", + "members":{ + "Applications":{ + "shape":"ApplicationDescriptionList", + "documentation":"

This parameter contains a list of ApplicationDescription.

" + } + }, + "documentation":"

Result message containing a list of application descriptions.

" + }, + "ApplicationMetrics":{ + "type":"structure", + "members":{ + "Duration":{ + "shape":"NullableInteger", + "documentation":"

The amount of time that the metrics cover (usually 10 seconds). For example, you might have 5 requests (request_count) within the most recent time slice of 10 seconds (duration).

" + }, + "RequestCount":{ + "shape":"RequestCount", + "documentation":"

Average number of requests handled by the web server per second over the last 10 seconds.

" + }, + "StatusCodes":{ + "shape":"StatusCodes", + "documentation":"

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response.

" + }, + "Latency":{ + "shape":"Latency", + "documentation":"

Represents the average latency for the slowest X percent of requests over the last 10 seconds. Latencies are in seconds with one millisecond resolution.

" + } + }, + "documentation":"

Application request metrics for an AWS Elastic Beanstalk environment.

" + }, + "ApplicationName":{ + "type":"string", + "max":100, + "min":1 + }, + "ApplicationNamesList":{ + "type":"list", + "member":{"shape":"ApplicationName"} + }, + "ApplicationResourceLifecycleConfig":{ + "type":"structure", + "members":{ + "ServiceRole":{ + "shape":"String", + "documentation":"

The ARN of an IAM service role that Elastic Beanstalk has permission to assume.

The ServiceRole property is required the first time that you provide a VersionLifecycleConfig for the application in one of the supporting calls (CreateApplication or UpdateApplicationResourceLifecycle). After you provide it once, in either one of the calls, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again in subsequent UpdateApplicationResourceLifecycle calls. You can, however, specify it in subsequent calls to change the Service Role to another value.

" + }, + "VersionLifecycleConfig":{ + "shape":"ApplicationVersionLifecycleConfig", + "documentation":"

The application version lifecycle configuration.

" + } + }, + "documentation":"

The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.

" + }, + "ApplicationResourceLifecycleDescriptionMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "ResourceLifecycleConfig":{ + "shape":"ApplicationResourceLifecycleConfig", + "documentation":"

The lifecycle configuration.

" + } + } + }, + "ApplicationVersionArn":{"type":"string"}, + "ApplicationVersionDescription":{ + "type":"structure", + "members":{ + "ApplicationVersionArn":{ + "shape":"ApplicationVersionArn", + "documentation":"

The Amazon Resource Name (ARN) of the application version.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to which the application version belongs.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the application version.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

A unique identifier for the application version.

" + }, + "SourceBuildInformation":{ + "shape":"SourceBuildInformation", + "documentation":"

If the version's source code was retrieved from AWS CodeCommit, the location of the source code for the application version.

" + }, + "BuildArn":{ + "shape":"String", + "documentation":"

Reference to the artifact from the AWS CodeBuild build.

" + }, + "SourceBundle":{ + "shape":"S3Location", + "documentation":"

The storage location of the application version's source bundle in Amazon S3.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The creation date of the application version.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The last modified date of the application version.

" + }, + "Status":{ + "shape":"ApplicationVersionStatus", + "documentation":"

The processing status of the application version. Reflects the state of the application version during its creation. Many of the values are only applicable if you specified True for the Process parameter of the CreateApplicationVersion action. The following list describes the possible values.

  • Unprocessed – Application version wasn't pre-processed or validated. Elastic Beanstalk will validate configuration files during deployment of the application version to an environment.

  • Processing – Elastic Beanstalk is currently processing the application version.

  • Building – Application version is currently undergoing an AWS CodeBuild build.

  • Processed – Elastic Beanstalk was successfully pre-processed and validated.

  • Failed – Either the AWS CodeBuild build failed or configuration files didn't pass validation. This application version isn't usable.

" + } + }, + "documentation":"

Describes the properties of an application version.

" + }, + "ApplicationVersionDescriptionList":{ + "type":"list", + "member":{"shape":"ApplicationVersionDescription"} + }, + "ApplicationVersionDescriptionMessage":{ + "type":"structure", + "members":{ + "ApplicationVersion":{ + "shape":"ApplicationVersionDescription", + "documentation":"

The ApplicationVersionDescription of the application version.

" + } + }, + "documentation":"

Result message wrapping a single description of an application version.

" + }, + "ApplicationVersionDescriptionsMessage":{ + "type":"structure", + "members":{ + "ApplicationVersions":{ + "shape":"ApplicationVersionDescriptionList", + "documentation":"

List of ApplicationVersionDescription objects sorted in order of creation.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

" + } + }, + "documentation":"

Result message wrapping a list of application version descriptions.

" + }, + "ApplicationVersionLifecycleConfig":{ + "type":"structure", + "members":{ + "MaxCountRule":{ + "shape":"MaxCountRule", + "documentation":"

Specify a max count rule to restrict the number of application versions that are retained for an application.

" + }, + "MaxAgeRule":{ + "shape":"MaxAgeRule", + "documentation":"

Specify a max age rule to restrict the length of time that application versions are retained for an application.

" + } + }, + "documentation":"

The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.

When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.

" + }, + "ApplicationVersionProccess":{"type":"boolean"}, + "ApplicationVersionStatus":{ + "type":"string", + "enum":[ + "Processed", + "Unprocessed", + "Failed", + "Processing", + "Building" + ] + }, + "ApplyEnvironmentManagedActionRequest":{ + "type":"structure", + "required":["ActionId"], + "members":{ + "EnvironmentName":{ + "shape":"String", + "documentation":"

The name of the target environment.

" + }, + "EnvironmentId":{ + "shape":"String", + "documentation":"

The environment ID of the target environment.

" + }, + "ActionId":{ + "shape":"String", + "documentation":"

The action ID of the scheduled managed action to execute.

" + } + }, + "documentation":"

Request to execute a scheduled managed action immediately.

" + }, + "ApplyEnvironmentManagedActionResult":{ + "type":"structure", + "members":{ + "ActionId":{ + "shape":"String", + "documentation":"

The action ID of the managed action.

" + }, + "ActionDescription":{ + "shape":"String", + "documentation":"

A description of the managed action.

" + }, + "ActionType":{ + "shape":"ActionType", + "documentation":"

The type of managed action.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the managed action.

" + } + }, + "documentation":"

The result message containing information about the managed action.

" + }, + "AutoCreateApplication":{"type":"boolean"}, + "AutoScalingGroup":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the AutoScalingGroup .

" + } + }, + "documentation":"

Describes an Auto Scaling launch configuration.

" + }, + "AutoScalingGroupList":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"} + }, + "AvailableSolutionStackDetailsList":{ + "type":"list", + "member":{"shape":"SolutionStackDescription"} + }, + "AvailableSolutionStackNamesList":{ + "type":"list", + "member":{"shape":"SolutionStackName"} + }, + "BoxedBoolean":{"type":"boolean"}, + "BoxedInt":{"type":"integer"}, + "BuildConfiguration":{ + "type":"structure", + "required":[ + "CodeBuildServiceRole", + "Image" + ], + "members":{ + "ArtifactName":{ + "shape":"String", + "documentation":"

The name of the artifact of the CodeBuild build. If provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label-artifact-name.zip. If not provided, Elastic Beanstalk stores the build artifact in the S3 location S3-bucket/resources/application-name/codebuild/codebuild-version-label.zip.

" + }, + "CodeBuildServiceRole":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

" + }, + "ComputeType":{ + "shape":"ComputeType", + "documentation":"

Information about the compute resources the build project will use.

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds

  • BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds

" + }, + "Image":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the Docker image to use for this build project.

" + }, + "TimeoutInMinutes":{ + "shape":"BoxedInt", + "documentation":"

How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

" + } + }, + "documentation":"

Settings for an AWS CodeBuild build.

" + }, + "Builder":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"ARN", + "documentation":"

The ARN of the builder.

" + } + }, + "documentation":"

The builder used to build the custom platform.

" + }, + "CPUUtilization":{ + "type":"structure", + "members":{ + "User":{ + "shape":"NullableDouble", + "documentation":"

Percentage of time that the CPU has spent in the User state over the last 10 seconds.

" + }, + "Nice":{ + "shape":"NullableDouble", + "documentation":"

Available on Linux environments only.

Percentage of time that the CPU has spent in the Nice state over the last 10 seconds.

" + }, + "System":{ + "shape":"NullableDouble", + "documentation":"

Available on Linux environments only.

Percentage of time that the CPU has spent in the System state over the last 10 seconds.

" + }, + "Idle":{ + "shape":"NullableDouble", + "documentation":"

Percentage of time that the CPU has spent in the Idle state over the last 10 seconds.

" + }, + "IOWait":{ + "shape":"NullableDouble", + "documentation":"

Available on Linux environments only.

Percentage of time that the CPU has spent in the I/O Wait state over the last 10 seconds.

" + }, + "IRQ":{ + "shape":"NullableDouble", + "documentation":"

Available on Linux environments only.

Percentage of time that the CPU has spent in the IRQ state over the last 10 seconds.

" + }, + "SoftIRQ":{ + "shape":"NullableDouble", + "documentation":"

Available on Linux environments only.

Percentage of time that the CPU has spent in the SoftIRQ state over the last 10 seconds.

" + }, + "Privileged":{ + "shape":"NullableDouble", + "documentation":"

Available on Windows environments only.

Percentage of time that the CPU has spent in the Privileged state over the last 10 seconds.

" + } + }, + "documentation":"

CPU utilization metrics for an instance.

" + }, + "Cause":{ + "type":"string", + "max":255, + "min":1 + }, + "Causes":{ + "type":"list", + "member":{"shape":"Cause"} + }, + "CheckDNSAvailabilityMessage":{ + "type":"structure", + "required":["CNAMEPrefix"], + "members":{ + "CNAMEPrefix":{ + "shape":"DNSCnamePrefix", + "documentation":"

The prefix used when this CNAME is reserved.

" + } + }, + "documentation":"

Results message indicating whether a CNAME is available.

" + }, + "CheckDNSAvailabilityResultMessage":{ + "type":"structure", + "members":{ + "Available":{ + "shape":"CnameAvailability", + "documentation":"

Indicates if the specified CNAME is available:

  • true : The CNAME is available.

  • false : The CNAME is not available.

" + }, + "FullyQualifiedCNAME":{ + "shape":"DNSCname", + "documentation":"

The fully qualified CNAME to reserve when CreateEnvironment is called with the provided prefix.

" + } + }, + "documentation":"

Indicates if the specified CNAME is available.

" + }, + "CnameAvailability":{"type":"boolean"}, + "CodeBuildNotInServiceRegionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

AWS CodeBuild is not available in the specified region.

", + "error":{ + "code":"CodeBuildNotInServiceRegionException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ComposeEnvironmentsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to which the specified source bundles belong.

" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

The name of the group to which the target environments belong. Specify a group name only if the environment name defined in each target environment's manifest ends with a + (plus) character. See Environment Manifest (env.yaml) for details.

" + }, + "VersionLabels":{ + "shape":"VersionLabels", + "documentation":"

A list of version labels, specifying one or more application source bundles that belong to the target application. Each source bundle must include an environment manifest that specifies the name of the environment and the name of the solution stack to use, and optionally can specify environment links to create.

" + } + }, + "documentation":"

Request to create or update a group of environments.

" + }, + "ComputeType":{ + "type":"string", + "enum":[ + "BUILD_GENERAL1_SMALL", + "BUILD_GENERAL1_MEDIUM", + "BUILD_GENERAL1_LARGE" + ] + }, + "ConfigurationDeploymentStatus":{ + "type":"string", + "enum":[ + "deployed", + "pending", + "failed" + ] + }, + "ConfigurationOptionDefaultValue":{"type":"string"}, + "ConfigurationOptionDescription":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "Name":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + }, + "DefaultValue":{ + "shape":"ConfigurationOptionDefaultValue", + "documentation":"

The default value for this configuration option.

" + }, + "ChangeSeverity":{ + "shape":"ConfigurationOptionSeverity", + "documentation":"

An indication of which action is required if the value for this configuration option changes:

  • NoInterruption : There is no interruption to the environment or application availability.

  • RestartEnvironment : The environment is entirely restarted, all AWS resources are deleted and recreated, and the environment is unavailable during the process.

  • RestartApplicationServer : The environment is available the entire time. However, a short application outage occurs when the application servers on the running Amazon EC2 instances are restarted.

" + }, + "UserDefined":{ + "shape":"UserDefinedOption", + "documentation":"

An indication of whether the user defined this configuration option:

  • true : This configuration option was defined by the user. It is a valid choice for specifying if this as an Option to Remove when updating configuration settings.

  • false : This configuration was not defined by the user.

Constraint: You can remove only UserDefined options from a configuration.

Valid Values: true | false

" + }, + "ValueType":{ + "shape":"ConfigurationOptionValueType", + "documentation":"

An indication of which type of values this option has and whether it is allowable to select one or more than one of the possible values:

  • Scalar : Values for this option are a single selection from the possible values, or an unformatted string, or numeric value governed by the MIN/MAX/Regex constraints.

  • List : Values for this option are multiple selections from the possible values.

  • Boolean : Values for this option are either true or false .

  • Json : Values for this option are a JSON representation of a ConfigDocument.

" + }, + "ValueOptions":{ + "shape":"ConfigurationOptionPossibleValues", + "documentation":"

If specified, values for the configuration option are selected from this list.

" + }, + "MinValue":{ + "shape":"OptionRestrictionMinValue", + "documentation":"

If specified, the configuration option must be a numeric value greater than this value.

" + }, + "MaxValue":{ + "shape":"OptionRestrictionMaxValue", + "documentation":"

If specified, the configuration option must be a numeric value less than this value.

" + }, + "MaxLength":{ + "shape":"OptionRestrictionMaxLength", + "documentation":"

If specified, the configuration option must be a string value no longer than this value.

" + }, + "Regex":{ + "shape":"OptionRestrictionRegex", + "documentation":"

If specified, the configuration option must be a string value that satisfies this regular expression.

" + } + }, + "documentation":"

Describes the possible values for a configuration option.

" + }, + "ConfigurationOptionDescriptionsList":{ + "type":"list", + "member":{"shape":"ConfigurationOptionDescription"} + }, + "ConfigurationOptionName":{"type":"string"}, + "ConfigurationOptionPossibleValue":{"type":"string"}, + "ConfigurationOptionPossibleValues":{ + "type":"list", + "member":{"shape":"ConfigurationOptionPossibleValue"} + }, + "ConfigurationOptionSetting":{ + "type":"structure", + "members":{ + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

A unique resource name for a time-based scaling configuration option.

" + }, + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + }, + "Value":{ + "shape":"ConfigurationOptionValue", + "documentation":"

The current value for the configuration option.

" + } + }, + "documentation":"

A specification identifying an individual configuration option along with its current value. For a list of possible option values, go to Option Values in the AWS Elastic Beanstalk Developer Guide.

" + }, + "ConfigurationOptionSettingsList":{ + "type":"list", + "member":{"shape":"ConfigurationOptionSetting"} + }, + "ConfigurationOptionSeverity":{"type":"string"}, + "ConfigurationOptionValue":{"type":"string"}, + "ConfigurationOptionValueType":{ + "type":"string", + "enum":[ + "Scalar", + "List" + ] + }, + "ConfigurationOptionsDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack these configuration options belong to.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "Options":{ + "shape":"ConfigurationOptionDescriptionsList", + "documentation":"

A list of ConfigurationOptionDescription.

" + } + }, + "documentation":"

Describes the settings for a specified configuration set.

" + }, + "ConfigurationSettingsDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack this configuration set uses.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this configuration set.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If not null, the name of the configuration template for this configuration set.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this configuration set.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

If not null, the name of the environment for this configuration set.

" + }, + "DeploymentStatus":{ + "shape":"ConfigurationDeploymentStatus", + "documentation":"

If this configuration set is associated with an environment, the DeploymentStatus parameter indicates the deployment status of this configuration set:

  • null: This configuration is not associated with a running environment.

  • pending: This is a draft configuration that is not deployed to the associated environment but is in the process of deploying.

  • deployed: This is the configuration that is currently deployed to the associated running environment.

  • failed: This is a draft configuration that failed to successfully deploy.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The date (in UTC time) when this configuration set was created.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The date (in UTC time) when this configuration set was last modified.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of the configuration options and their values in this configuration set.

" + } + }, + "documentation":"

Describes the settings for a configuration set.

" + }, + "ConfigurationSettingsDescriptionList":{ + "type":"list", + "member":{"shape":"ConfigurationSettingsDescription"} + }, + "ConfigurationSettingsDescriptions":{ + "type":"structure", + "members":{ + "ConfigurationSettings":{ + "shape":"ConfigurationSettingsDescriptionList", + "documentation":"

A list of ConfigurationSettingsDescription.

" + } + }, + "documentation":"

The results from a request to change the configuration settings of an environment.

" + }, + "ConfigurationSettingsValidationMessages":{ + "type":"structure", + "members":{ + "Messages":{ + "shape":"ValidationMessagesList", + "documentation":"

A list of ValidationMessage.

" + } + }, + "documentation":"

Provides a list of validation messages.

" + }, + "ConfigurationTemplateName":{ + "type":"string", + "max":100, + "min":1 + }, + "ConfigurationTemplateNamesList":{ + "type":"list", + "member":{"shape":"ConfigurationTemplateName"} + }, + "CreateApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

Constraint: This name must be unique within your account. If the specified name already exists, the action returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes the application.

" + }, + "ResourceLifecycleConfig":{ + "shape":"ApplicationResourceLifecycleConfig", + "documentation":"

Specify an application resource lifecycle configuration to prevent your application from accumulating too many versions.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Specifies the tags applied to the application.

Elastic Beanstalk applies these tags only to the application. Environments that you create in the application don't inherit the tags.

" + } + }, + "documentation":"

Request to create an application.

" + }, + "CreateApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application. If no application is found with this name, and AutoCreateApplication is false, returns an InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

A label identifying this version.

Constraint: Must be unique per application. If an application version already exists with this label for the specified application, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this version.

" + }, + "SourceBuildInformation":{ + "shape":"SourceBuildInformation", + "documentation":"

Specify a commit in an AWS CodeCommit Git repository to use as the source code for the application version.

" + }, + "SourceBundle":{ + "shape":"S3Location", + "documentation":"

The Amazon S3 bucket and key that identify the location of the source bundle for this version.

The Amazon S3 bucket must be in the same region as the environment.

Specify a source bundle in S3 or a commit in an AWS CodeCommit repository (with SourceBuildInformation), but not both. If neither SourceBundle nor SourceBuildInformation are provided, Elastic Beanstalk uses a sample application.

" + }, + "BuildConfiguration":{ + "shape":"BuildConfiguration", + "documentation":"

Settings for an AWS CodeBuild build.

" + }, + "AutoCreateApplication":{ + "shape":"AutoCreateApplication", + "documentation":"

Set to true to create an application with the specified name if it doesn't already exist.

" + }, + "Process":{ + "shape":"ApplicationVersionProccess", + "documentation":"

Pre-processes and validates the environment manifest (env.yaml) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment.

You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional.

The Process option validates Elastic Beanstalk configuration files. It doesn't validate your application's configuration files, like proxy server or Docker configuration.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Specifies the tags applied to the application version.

Elastic Beanstalk applies these tags only to the application version. Environments that use the application version don't inherit the tags.

" + } + }, + "documentation":"

" + }, + "CreateConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to associate with this configuration template. If no application is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template.

Constraint: This name must be unique per application.

Default: If a configuration template already exists with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack used by this configuration. The solution stack specifies the operating system, architecture, and application server for a configuration template. It determines the set of configuration options as well as the possible and default values.

Use ListAvailableSolutionStacks to obtain a list of available solution stacks.

A solution stack name or a source configuration parameter must be specified, otherwise AWS Elastic Beanstalk returns an InvalidParameterValue error.

If a solution stack name is not specified and the source configuration parameter is specified, AWS Elastic Beanstalk uses the same solution stack as the source configuration template.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the custom platform.

" + }, + "SourceConfiguration":{ + "shape":"SourceConfiguration", + "documentation":"

If specified, AWS Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in the OptionSettings parameter of this call overrides any values obtained from the SourceConfiguration.

If no configuration template is found, returns an InvalidParameterValue error.

Constraint: If both the solution stack name parameter and the source configuration parameters are specified, the solution stack of the source configuration template must match the specified solution stack name or else AWS Elastic Beanstalk returns an InvalidParameterCombination error.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment used with this configuration template.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this configuration.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration option to the requested value. The new value overrides the value obtained from the solution stack or the source configuration template.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Specifies the tags applied to the configuration template.

" + } + }, + "documentation":"

Request to create a configuration template.

" + }, + "CreateEnvironmentMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that contains the version to be deployed.

If no application is found with this name, CreateEnvironment returns an InvalidParameterValue error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

A unique name for the deployment environment. Used in the application URL.

Constraint: Must be from 4 to 40 characters in length. The name can contain only letters, numbers, and hyphens. It cannot start or end with a hyphen. This name must be unique within a region in your account. If the specified name already exists in the region, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Default: If the CNAME parameter is not specified, the environment name becomes part of the CNAME, and therefore part of the visible URL for your application.

" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name parameter. See Environment Manifest (env.yaml) for details.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this environment.

" + }, + "CNAMEPrefix":{ + "shape":"DNSCnamePrefix", + "documentation":"

If specified, the environment attempts to use this value as the prefix for the CNAME. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

This specifies the tier to use for creating this environment.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Specifies the tags applied to resources in the environment.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The name of the application version to deploy.

If the specified application has no associated application versions, AWS Elastic Beanstalk UpdateEnvironment returns an InvalidParameterValue error.

Default: If not specified, AWS Elastic Beanstalk attempts to launch the sample application in the container.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to use in deployment. If no configuration template is found with this name, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

This is an alternative to specifying a template name. If specified, AWS Elastic Beanstalk sets the configuration values to the default values associated with the specified solution stack.

For a list of current solution stacks, see Elastic Beanstalk Supported Platforms.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk sets the specified configuration options to the requested value in the configuration set for the new environment. These override the values obtained from the solution stack or the configuration template.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

" + } + }, + "documentation":"

" + }, + "CreatePlatformVersionRequest":{ + "type":"structure", + "required":[ + "PlatformName", + "PlatformVersion", + "PlatformDefinitionBundle" + ], + "members":{ + "PlatformName":{ + "shape":"PlatformName", + "documentation":"

The name of your custom platform.

" + }, + "PlatformVersion":{ + "shape":"PlatformVersion", + "documentation":"

The number, such as 1.0.2, for the new platform version.

" + }, + "PlatformDefinitionBundle":{ + "shape":"S3Location", + "documentation":"

The location of the platform definition archive in Amazon S3.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the builder environment.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

The configuration option settings to apply to the builder environment.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Specifies the tags applied to the new platform version.

Elastic Beanstalk applies these tags only to the platform version. Environments that you create using the platform version don't inherit the tags.

" + } + }, + "documentation":"

Request to create a new platform version.

" + }, + "CreatePlatformVersionResult":{ + "type":"structure", + "members":{ + "PlatformSummary":{ + "shape":"PlatformSummary", + "documentation":"

Detailed information about the new version of the custom platform.

" + }, + "Builder":{ + "shape":"Builder", + "documentation":"

The builder used to create the custom platform.

" + } + } + }, + "CreateStorageLocationResultMessage":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The name of the Amazon S3 bucket created.

" + } + }, + "documentation":"

Results of a CreateStorageLocationResult call.

" + }, + "CreationDate":{"type":"timestamp"}, + "CustomAmi":{ + "type":"structure", + "members":{ + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The type of virtualization used to create the custom AMI.

" + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

THe ID of the image used to create the custom AMI.

" + } + }, + "documentation":"

A custom AMI available to platforms.

" + }, + "CustomAmiList":{ + "type":"list", + "member":{"shape":"CustomAmi"} + }, + "DNSCname":{ + "type":"string", + "max":255, + "min":1 + }, + "DNSCnamePrefix":{ + "type":"string", + "max":63, + "min":4 + }, + "DeleteApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete.

" + }, + "TerminateEnvByForce":{ + "shape":"TerminateEnvForce", + "documentation":"

When set to true, running environments will be terminated before deleting the application.

" + } + }, + "documentation":"

Request to delete an application.

" + }, + "DeleteApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to which the version belongs.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The label of the version to delete.

" + }, + "DeleteSourceBundle":{ + "shape":"DeleteSourceBundle", + "documentation":"

Set to true to delete the source bundle from your storage bucket. Otherwise, the application version is deleted only from Elastic Beanstalk and the source bundle remains in Amazon S3.

" + } + }, + "documentation":"

Request to delete an application version.

" + }, + "DeleteConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete the configuration template from.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to delete.

" + } + }, + "documentation":"

Request to delete a configuration template.

" + }, + "DeleteEnvironmentConfigurationMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "EnvironmentName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application the environment is associated with.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to delete the draft configuration from.

" + } + }, + "documentation":"

Request to delete a draft environment configuration.

" + }, + "DeletePlatformVersionRequest":{ + "type":"structure", + "members":{ + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the version of the custom platform.

" + } + } + }, + "DeletePlatformVersionResult":{ + "type":"structure", + "members":{ + "PlatformSummary":{ + "shape":"PlatformSummary", + "documentation":"

Detailed information about the version of the custom platform.

" + } + } + }, + "DeleteSourceBundle":{"type":"boolean"}, + "Deployment":{ + "type":"structure", + "members":{ + "VersionLabel":{ + "shape":"String", + "documentation":"

The version label of the application version in the deployment.

" + }, + "DeploymentId":{ + "shape":"NullableLong", + "documentation":"

The ID of the deployment. This number increases by one each time that you deploy source code or change instance configuration settings.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the deployment:

  • In Progress : The deployment is in progress.

  • Deployed : The deployment succeeded.

  • Failed : The deployment failed.

" + }, + "DeploymentTime":{ + "shape":"DeploymentTimestamp", + "documentation":"

For in-progress deployments, the time that the deployment started.

For completed deployments, the time that the deployment ended.

" + } + }, + "documentation":"

Information about an application version deployment.

" + }, + "DeploymentTimestamp":{"type":"timestamp"}, + "DescribeAccountAttributesResult":{ + "type":"structure", + "members":{ + "ResourceQuotas":{ + "shape":"ResourceQuotas", + "documentation":"

The Elastic Beanstalk resource quotas associated with the calling AWS account.

" + } + } + }, + "DescribeApplicationVersionsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Specify an application name to show only application versions for that application.

" + }, + "VersionLabels":{ + "shape":"VersionLabelsList", + "documentation":"

Specify a version label to show a specific application version.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

For a paginated request. Specify a maximum number of application versions to include in each response.

If no MaxRecords is specified, all available application versions are retrieved in a single response.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

" + } + }, + "documentation":"

Request to describe application versions.

" + }, + "DescribeApplicationsMessage":{ + "type":"structure", + "members":{ + "ApplicationNames":{ + "shape":"ApplicationNamesList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to only include those with the specified names.

" + } + }, + "documentation":"

Request to describe one or more applications.

" + }, + "DescribeConfigurationOptionsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template whose configuration options you want to describe.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment whose configuration options you want to describe.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack whose configuration options you want to describe.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the custom platform.

" + }, + "Options":{ + "shape":"OptionsSpecifierList", + "documentation":"

If specified, restricts the descriptions to only the specified options.

" + } + }, + "documentation":"

Result message containing a list of application version descriptions.

" + }, + "DescribeConfigurationSettingsMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application for the environment or configuration template.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

Result message containing all of the configuration settings for a specified solution stack or configuration template.

" + }, + "DescribeEnvironmentHealthRequest":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

Specify the environment by name.

You must specify either this or an EnvironmentName, or both.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

Specify the environment by ID.

You must specify either this or an EnvironmentName, or both.

" + }, + "AttributeNames":{ + "shape":"EnvironmentHealthAttributes", + "documentation":"

Specify the response elements to return. To retrieve all attributes, set to All. If no attribute names are specified, returns the name of the environment.

" + } + }, + "documentation":"

See the example below to learn how to create a request body.

" + }, + "DescribeEnvironmentHealthResult":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The environment's name.

" + }, + "HealthStatus":{ + "shape":"String", + "documentation":"

The health status of the environment. For example, Ok.

" + }, + "Status":{ + "shape":"EnvironmentHealth", + "documentation":"

The environment's operational status. Ready, Launching, Updating, Terminating, or Terminated.

" + }, + "Color":{ + "shape":"String", + "documentation":"

The health color of the environment.

" + }, + "Causes":{ + "shape":"Causes", + "documentation":"

Descriptions of the data that contributed to the environment's current health status.

" + }, + "ApplicationMetrics":{ + "shape":"ApplicationMetrics", + "documentation":"

Application request metrics for the environment.

" + }, + "InstancesHealth":{ + "shape":"InstanceHealthSummary", + "documentation":"

Summary health information for the instances in the environment.

" + }, + "RefreshedAt":{ + "shape":"RefreshedAt", + "documentation":"

The date and time that the health information was retrieved.

" + } + }, + "documentation":"

Health details for an AWS Elastic Beanstalk environment.

" + }, + "DescribeEnvironmentManagedActionHistoryRequest":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The environment ID of the target environment.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the target environment.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The pagination token returned by a previous request.

" + }, + "MaxItems":{ + "shape":"Integer", + "documentation":"

The maximum number of items to return for a single request.

" + } + }, + "documentation":"

Request to list completed and failed managed actions.

" + }, + "DescribeEnvironmentManagedActionHistoryResult":{ + "type":"structure", + "members":{ + "ManagedActionHistoryItems":{ + "shape":"ManagedActionHistoryItems", + "documentation":"

A list of completed and failed managed actions.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A pagination token that you pass to DescribeEnvironmentManagedActionHistory to get the next page of results.

" + } + }, + "documentation":"

A result message containing a list of completed and failed managed actions.

" + }, + "DescribeEnvironmentManagedActionsRequest":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"String", + "documentation":"

The name of the target environment.

" + }, + "EnvironmentId":{ + "shape":"String", + "documentation":"

The environment ID of the target environment.

" + }, + "Status":{ + "shape":"ActionStatus", + "documentation":"

To show only actions with a particular status, specify a status.

" + } + }, + "documentation":"

Request to list an environment's upcoming and in-progress managed actions.

" + }, + "DescribeEnvironmentManagedActionsResult":{ + "type":"structure", + "members":{ + "ManagedActions":{ + "shape":"ManagedActions", + "documentation":"

A list of upcoming and in-progress managed actions.

" + } + }, + "documentation":"

The result message containing a list of managed actions.

" + }, + "DescribeEnvironmentResourcesMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to retrieve AWS resource usage data.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

Request to describe the resources in an environment.

" + }, + "DescribeEnvironmentsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

" + }, + "EnvironmentIds":{ + "shape":"EnvironmentIdList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

" + }, + "EnvironmentNames":{ + "shape":"EnvironmentNamesList", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

" + }, + "IncludeDeleted":{ + "shape":"IncludeDeleted", + "documentation":"

Indicates whether to include deleted environments:

true: Environments that have been deleted after IncludedDeletedBackTo are displayed.

false: Do not include deleted environments.

" + }, + "IncludedDeletedBackTo":{ + "shape":"IncludeDeletedBackTo", + "documentation":"

If specified when IncludeDeleted is set to true, then environments deleted after this date are displayed.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

For a paginated request. Specify a maximum number of environments to include in each response.

If no MaxRecords is specified, all available environments are retrieved in a single response.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

For a paginated request. Specify a token from a previous response page to retrieve the next response page. All other parameter values must be identical to the ones specified in the initial request.

If no NextToken is specified, the first page is retrieved.

" + } + }, + "documentation":"

Request to describe one or more environments.

" + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the version of the custom platform.

" + }, + "RequestId":{ + "shape":"RequestId", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.

" + }, + "Severity":{ + "shape":"EventSeverity", + "documentation":"

If specified, limits the events returned from this call to include only those with the specified severity or higher.

" + }, + "StartTime":{ + "shape":"TimeFilterStart", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.

" + }, + "EndTime":{ + "shape":"TimeFilterEnd", + "documentation":"

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

" + }, + "MaxRecords":{ + "shape":"MaxRecords", + "documentation":"

Specifies the maximum number of events that can be returned, beginning with the most recent event.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

Pagination token. If specified, the events return the next batch of results.

" + } + }, + "documentation":"

Request to retrieve a list of events for an environment.

" + }, + "DescribeInstancesHealthRequest":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

Specify the AWS Elastic Beanstalk environment by name.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

Specify the AWS Elastic Beanstalk environment by ID.

" + }, + "AttributeNames":{ + "shape":"InstancesHealthAttributes", + "documentation":"

Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no attribute names are specified, returns a list of instances.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Specify the pagination token returned by a previous call.

" + } + }, + "documentation":"

Parameters for a call to DescribeInstancesHealth.

" + }, + "DescribeInstancesHealthResult":{ + "type":"structure", + "members":{ + "InstanceHealthList":{ + "shape":"InstanceHealthList", + "documentation":"

Detailed health information about each instance.

The output differs slightly between Linux and Windows environments. There is a difference in the members that are supported under the <CPUUtilization> type.

" + }, + "RefreshedAt":{ + "shape":"RefreshedAt", + "documentation":"

The date and time that the health information was retrieved.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token for the next page of results, if available.

" + } + }, + "documentation":"

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

" + }, + "DescribePlatformVersionRequest":{ + "type":"structure", + "members":{ + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the version of the platform.

" + } + } + }, + "DescribePlatformVersionResult":{ + "type":"structure", + "members":{ + "PlatformDescription":{ + "shape":"PlatformDescription", + "documentation":"

Detailed information about the version of the platform.

" + } + } + }, + "Description":{ + "type":"string", + "max":200 + }, + "Ec2InstanceId":{"type":"string"}, + "ElasticBeanstalkServiceException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

The exception error message.

" + } + }, + "documentation":"

A generic service exception has occurred.

", + "exception":true + }, + "EndpointURL":{"type":"string"}, + "EnvironmentArn":{"type":"string"}, + "EnvironmentDescription":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of this environment.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of this environment.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this environment.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The application version deployed in this environment.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the SolutionStack deployed with this environment.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template used to originally launch this environment.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

Describes this environment.

" + }, + "EndpointURL":{ + "shape":"EndpointURL", + "documentation":"

For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance.

" + }, + "CNAME":{ + "shape":"DNSCname", + "documentation":"

The URL to the CNAME for this environment.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The creation date for this environment.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The last modified date for this environment.

" + }, + "Status":{ + "shape":"EnvironmentStatus", + "documentation":"

The current operational status of the environment:

  • Launching: Environment is in the process of initial deployment.

  • Updating: Environment is in the process of updating its configuration settings or application version.

  • Ready: Environment is available to have an action performed on it, such as update or terminate.

  • Terminating: Environment is in the shut-down process.

  • Terminated: Environment is not running.

" + }, + "AbortableOperationInProgress":{ + "shape":"AbortableOperationInProgress", + "documentation":"

Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel.

true: There is an update in progress.

false: There are no updates currently in progress.

" + }, + "Health":{ + "shape":"EnvironmentHealth", + "documentation":"

Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:

  • Red: Indicates the environment is not responsive. Occurs when three or more consecutive failures occur for an environment.

  • Yellow: Indicates that something is wrong. Occurs when two consecutive failures occur for an environment.

  • Green: Indicates the environment is healthy and fully functional.

  • Grey: Default health for a new environment. The environment is not fully launched and health checks have not started or health checks are suspended during an UpdateEnvironment or RestartEnvironment request.

Default: Grey

" + }, + "HealthStatus":{ + "shape":"EnvironmentHealthStatus", + "documentation":"

Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses.

" + }, + "Resources":{ + "shape":"EnvironmentResourcesDescription", + "documentation":"

The description of the AWS resources used by this environment.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

Describes the current tier of this environment.

" + }, + "EnvironmentLinks":{ + "shape":"EnvironmentLinks", + "documentation":"

A list of links to other environments in the same group.

" + }, + "EnvironmentArn":{ + "shape":"EnvironmentArn", + "documentation":"

The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN.

" + } + }, + "documentation":"

Describes the properties of an environment.

" + }, + "EnvironmentDescriptionsList":{ + "type":"list", + "member":{"shape":"EnvironmentDescription"} + }, + "EnvironmentDescriptionsMessage":{ + "type":"structure", + "members":{ + "Environments":{ + "shape":"EnvironmentDescriptionsList", + "documentation":"

Returns an EnvironmentDescription list.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

In a paginated request, the token that you can pass in a subsequent request to get the next response page.

" + } + }, + "documentation":"

Result message containing a list of environment descriptions.

" + }, + "EnvironmentHealth":{ + "type":"string", + "enum":[ + "Green", + "Yellow", + "Red", + "Grey" + ] + }, + "EnvironmentHealthAttribute":{ + "type":"string", + "enum":[ + "Status", + "Color", + "Causes", + "ApplicationMetrics", + "InstancesHealth", + "All", + "HealthStatus", + "RefreshedAt" + ] + }, + "EnvironmentHealthAttributes":{ + "type":"list", + "member":{"shape":"EnvironmentHealthAttribute"} + }, + "EnvironmentHealthStatus":{ + "type":"string", + "enum":[ + "NoData", + "Unknown", + "Pending", + "Ok", + "Info", + "Warning", + "Degraded", + "Severe", + "Suspended" + ] + }, + "EnvironmentId":{"type":"string"}, + "EnvironmentIdList":{ + "type":"list", + "member":{"shape":"EnvironmentId"} + }, + "EnvironmentInfoDescription":{ + "type":"structure", + "members":{ + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information retrieved.

" + }, + "Ec2InstanceId":{ + "shape":"Ec2InstanceId", + "documentation":"

The Amazon EC2 Instance ID for this information.

" + }, + "SampleTimestamp":{ + "shape":"SampleTimestamp", + "documentation":"

The time stamp when this information was retrieved.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

The retrieved information. Currently contains a presigned Amazon S3 URL. The files are deleted after 15 minutes.

Anyone in possession of this URL can access the files before they are deleted. Make the URL available only to trusted parties.

" + } + }, + "documentation":"

The information retrieved from the Amazon EC2 instances.

" + }, + "EnvironmentInfoDescriptionList":{ + "type":"list", + "member":{"shape":"EnvironmentInfoDescription"} + }, + "EnvironmentInfoType":{ + "type":"string", + "enum":[ + "tail", + "bundle" + ] + }, + "EnvironmentLink":{ + "type":"structure", + "members":{ + "LinkName":{ + "shape":"String", + "documentation":"

The name of the link.

" + }, + "EnvironmentName":{ + "shape":"String", + "documentation":"

The name of the linked environment (the dependency).

" + } + }, + "documentation":"

A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.

" + }, + "EnvironmentLinks":{ + "type":"list", + "member":{"shape":"EnvironmentLink"} + }, + "EnvironmentName":{ + "type":"string", + "max":40, + "min":4 + }, + "EnvironmentNamesList":{ + "type":"list", + "member":{"shape":"EnvironmentName"} + }, + "EnvironmentResourceDescription":{ + "type":"structure", + "members":{ + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment.

" + }, + "AutoScalingGroups":{ + "shape":"AutoScalingGroupList", + "documentation":"

The AutoScalingGroups used by this environment.

" + }, + "Instances":{ + "shape":"InstanceList", + "documentation":"

The Amazon EC2 instances used by this environment.

" + }, + "LaunchConfigurations":{ + "shape":"LaunchConfigurationList", + "documentation":"

The Auto Scaling launch configurations in use by this environment.

" + }, + "LaunchTemplates":{ + "shape":"LaunchTemplateList", + "documentation":"

The Amazon EC2 launch templates in use by this environment.

" + }, + "LoadBalancers":{ + "shape":"LoadBalancerList", + "documentation":"

The LoadBalancers in use by this environment.

" + }, + "Triggers":{ + "shape":"TriggerList", + "documentation":"

The AutoScaling triggers in use by this environment.

" + }, + "Queues":{ + "shape":"QueueList", + "documentation":"

The queues used by this environment.

" + } + }, + "documentation":"

Describes the AWS resources in use by this environment. This data is live.

" + }, + "EnvironmentResourceDescriptionsMessage":{ + "type":"structure", + "members":{ + "EnvironmentResources":{ + "shape":"EnvironmentResourceDescription", + "documentation":"

A list of EnvironmentResourceDescription.

" + } + }, + "documentation":"

Result message containing a list of environment resource descriptions.

" + }, + "EnvironmentResourcesDescription":{ + "type":"structure", + "members":{ + "LoadBalancer":{ + "shape":"LoadBalancerDescription", + "documentation":"

Describes the LoadBalancer.

" + } + }, + "documentation":"

Describes the AWS resources in use by this environment. This data is not live data.

" + }, + "EnvironmentStatus":{ + "type":"string", + "enum":[ + "Launching", + "Updating", + "Ready", + "Terminating", + "Terminated" + ] + }, + "EnvironmentTier":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of this environment tier.

Valid values:

  • For Web server tier – WebServer

  • For Worker tier – Worker

" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of this environment tier.

Valid values:

  • For Web server tier – Standard

  • For Worker tier – SQS/HTTP

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

This member is deprecated. Any specific version that you set may become out of date. We recommend leaving it unspecified.

" + } + }, + "documentation":"

Describes the properties of an environment tier

" + }, + "EventDate":{"type":"timestamp"}, + "EventDescription":{ + "type":"structure", + "members":{ + "EventDate":{ + "shape":"EventDate", + "documentation":"

The date when the event occurred.

" + }, + "Message":{ + "shape":"EventMessage", + "documentation":"

The event message.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application associated with the event.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The release label for the application version associated with this event.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration associated with this event.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment associated with this event.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "RequestId":{ + "shape":"RequestId", + "documentation":"

The web service request ID for the activity of this event.

" + }, + "Severity":{ + "shape":"EventSeverity", + "documentation":"

The severity level of this event.

" + } + }, + "documentation":"

Describes an event.

" + }, + "EventDescriptionList":{ + "type":"list", + "member":{"shape":"EventDescription"} + }, + "EventDescriptionsMessage":{ + "type":"structure", + "members":{ + "Events":{ + "shape":"EventDescriptionList", + "documentation":"

A list of EventDescription.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If returned, this indicates that there are more results to obtain. Use this token in the next DescribeEvents call to get the next batch of events.

" + } + }, + "documentation":"

Result message wrapping a list of event descriptions.

" + }, + "EventMessage":{"type":"string"}, + "EventSeverity":{ + "type":"string", + "enum":[ + "TRACE", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL" + ] + }, + "ExceptionMessage":{"type":"string"}, + "FailureType":{ + "type":"string", + "enum":[ + "UpdateCancelled", + "CancellationFailed", + "RollbackFailed", + "RollbackSuccessful", + "InternalFailure", + "InvalidEnvironmentState", + "PermissionsError" + ] + }, + "FileTypeExtension":{ + "type":"string", + "max":100, + "min":1 + }, + "ForceTerminate":{"type":"boolean"}, + "GroupName":{ + "type":"string", + "max":19, + "min":1 + }, + "ImageId":{"type":"string"}, + "IncludeDeleted":{"type":"boolean"}, + "IncludeDeletedBackTo":{"type":"timestamp"}, + "Instance":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

The ID of the Amazon EC2 instance.

" + } + }, + "documentation":"

The description of an Amazon EC2 instance.

" + }, + "InstanceHealthList":{ + "type":"list", + "member":{"shape":"SingleInstanceHealth"} + }, + "InstanceHealthSummary":{ + "type":"structure", + "members":{ + "NoData":{ + "shape":"NullableInteger", + "documentation":"

Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.

" + }, + "Unknown":{ + "shape":"NullableInteger", + "documentation":"

Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data on an instance.

" + }, + "Pending":{ + "shape":"NullableInteger", + "documentation":"

Grey. An operation is in progress on an instance within the command timeout.

" + }, + "Ok":{ + "shape":"NullableInteger", + "documentation":"

Green. An instance is passing health checks and the health agent is not reporting any problems.

" + }, + "Info":{ + "shape":"NullableInteger", + "documentation":"

Green. An operation is in progress on an instance.

" + }, + "Warning":{ + "shape":"NullableInteger", + "documentation":"

Yellow. The health agent is reporting a moderate number of request failures or other issues for an instance or environment.

" + }, + "Degraded":{ + "shape":"NullableInteger", + "documentation":"

Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.

" + }, + "Severe":{ + "shape":"NullableInteger", + "documentation":"

Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.

" + } + }, + "documentation":"

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

" + }, + "InstanceId":{ + "type":"string", + "max":255, + "min":1 + }, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstancesHealthAttribute":{ + "type":"string", + "enum":[ + "HealthStatus", + "Color", + "Causes", + "ApplicationMetrics", + "RefreshedAt", + "LaunchedAt", + "System", + "Deployment", + "AvailabilityZone", + "InstanceType", + "All" + ] + }, + "InstancesHealthAttributes":{ + "type":"list", + "member":{"shape":"InstancesHealthAttribute"} + }, + "InsufficientPrivilegesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account does not have sufficient privileges for one or more AWS services.

", + "error":{ + "code":"InsufficientPrivilegesException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "InvalidRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more input parameters is not valid. Please correct the input parameters and try the operation again.

", + "error":{ + "code":"InvalidRequestException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Latency":{ + "type":"structure", + "members":{ + "P999":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

" + }, + "P99":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 1 percent of requests over the last 10 seconds.

" + }, + "P95":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 5 percent of requests over the last 10 seconds.

" + }, + "P90":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 10 percent of requests over the last 10 seconds.

" + }, + "P85":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 15 percent of requests over the last 10 seconds.

" + }, + "P75":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 25 percent of requests over the last 10 seconds.

" + }, + "P50":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 50 percent of requests over the last 10 seconds.

" + }, + "P10":{ + "shape":"NullableDouble", + "documentation":"

The average latency for the slowest 90 percent of requests over the last 10 seconds.

" + } + }, + "documentation":"

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

" + }, + "LaunchConfiguration":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the launch configuration.

" + } + }, + "documentation":"

Describes an Auto Scaling launch configuration.

" + }, + "LaunchConfigurationList":{ + "type":"list", + "member":{"shape":"LaunchConfiguration"} + }, + "LaunchTemplate":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

The ID of the launch template.

" + } + }, + "documentation":"

Describes an Amazon EC2 launch template.

" + }, + "LaunchTemplateList":{ + "type":"list", + "member":{"shape":"LaunchTemplate"} + }, + "LaunchedAt":{"type":"timestamp"}, + "ListAvailableSolutionStacksResultMessage":{ + "type":"structure", + "members":{ + "SolutionStacks":{ + "shape":"AvailableSolutionStackNamesList", + "documentation":"

A list of available solution stacks.

" + }, + "SolutionStackDetails":{ + "shape":"AvailableSolutionStackDetailsList", + "documentation":"

A list of available solution stacks and their SolutionStackDescription.

" + } + }, + "documentation":"

A list of available AWS Elastic Beanstalk solution stacks.

" + }, + "ListPlatformVersionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"PlatformFilters", + "documentation":"

List only the platforms where the platform member value relates to one of the supplied values.

" + }, + "MaxRecords":{ + "shape":"PlatformMaxRecords", + "documentation":"

The maximum number of platform values returned in one call.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

The starting index into the remaining list of platforms. Use the NextToken value from a previous ListPlatformVersion call.

" + } + } + }, + "ListPlatformVersionsResult":{ + "type":"structure", + "members":{ + "PlatformSummaryList":{ + "shape":"PlatformSummaryList", + "documentation":"

Detailed information about the platforms.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

The starting index into the remaining list of platforms. if this value is not null, you can use it in a subsequent ListPlatformVersion call.

" + } + } + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resouce for which a tag list is requested.

Must be the ARN of an Elastic Beanstalk environment.

" + } + } + }, + "Listener":{ + "type":"structure", + "members":{ + "Protocol":{ + "shape":"String", + "documentation":"

The protocol that is used by the Listener.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

The port that is used by the Listener.

" + } + }, + "documentation":"

Describes the properties of a Listener for the LoadBalancer.

" + }, + "LoadAverage":{ + "type":"list", + "member":{"shape":"LoadAverageValue"} + }, + "LoadAverageValue":{"type":"double"}, + "LoadBalancer":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the LoadBalancer.

" + } + }, + "documentation":"

Describes a LoadBalancer.

" + }, + "LoadBalancerDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"String", + "documentation":"

The name of the LoadBalancer.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

The domain name of the LoadBalancer.

" + }, + "Listeners":{ + "shape":"LoadBalancerListenersDescription", + "documentation":"

A list of Listeners used by the LoadBalancer.

" + } + }, + "documentation":"

Describes the details of a LoadBalancer.

" + }, + "LoadBalancerList":{ + "type":"list", + "member":{"shape":"LoadBalancer"} + }, + "LoadBalancerListenersDescription":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "Maintainer":{"type":"string"}, + "ManagedAction":{ + "type":"structure", + "members":{ + "ActionId":{ + "shape":"String", + "documentation":"

A unique identifier for the managed action.

" + }, + "ActionDescription":{ + "shape":"String", + "documentation":"

A description of the managed action.

" + }, + "ActionType":{ + "shape":"ActionType", + "documentation":"

The type of managed action.

" + }, + "Status":{ + "shape":"ActionStatus", + "documentation":"

The status of the managed action. If the action is Scheduled, you can apply it immediately with ApplyEnvironmentManagedAction.

" + }, + "WindowStartTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the maintenance window in which the managed action will execute.

" + } + }, + "documentation":"

The record of an upcoming or in-progress managed action.

" + }, + "ManagedActionHistoryItem":{ + "type":"structure", + "members":{ + "ActionId":{ + "shape":"String", + "documentation":"

A unique identifier for the managed action.

" + }, + "ActionType":{ + "shape":"ActionType", + "documentation":"

The type of the managed action.

" + }, + "ActionDescription":{ + "shape":"String", + "documentation":"

A description of the managed action.

" + }, + "FailureType":{ + "shape":"FailureType", + "documentation":"

If the action failed, the type of failure.

" + }, + "Status":{ + "shape":"ActionHistoryStatus", + "documentation":"

The status of the action.

" + }, + "FailureDescription":{ + "shape":"String", + "documentation":"

If the action failed, a description of the failure.

" + }, + "ExecutedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the action started executing.

" + }, + "FinishedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the action finished executing.

" + } + }, + "documentation":"

The record of a completed or failed managed action.

" + }, + "ManagedActionHistoryItems":{ + "type":"list", + "member":{"shape":"ManagedActionHistoryItem"}, + "max":100, + "min":1 + }, + "ManagedActionInvalidStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Cannot modify the managed action in its current state.

", + "error":{ + "code":"ManagedActionInvalidStateException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ManagedActions":{ + "type":"list", + "member":{"shape":"ManagedAction"}, + "max":100, + "min":1 + }, + "MaxAgeRule":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"BoxedBoolean", + "documentation":"

Specify true to apply the rule, or false to disable it.

" + }, + "MaxAgeInDays":{ + "shape":"BoxedInt", + "documentation":"

Specify the number of days to retain an application versions.

" + }, + "DeleteSourceFromS3":{ + "shape":"BoxedBoolean", + "documentation":"

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

" + } + }, + "documentation":"

A lifecycle rule that deletes application versions after the specified number of days.

" + }, + "MaxCountRule":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"BoxedBoolean", + "documentation":"

Specify true to apply the rule, or false to disable it.

" + }, + "MaxCount":{ + "shape":"BoxedInt", + "documentation":"

Specify the maximum number of application versions to retain.

" + }, + "DeleteSourceFromS3":{ + "shape":"BoxedBoolean", + "documentation":"

Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version.

" + } + }, + "documentation":"

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

" + }, + "MaxRecords":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Message":{"type":"string"}, + "NextToken":{ + "type":"string", + "max":100, + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "NullableDouble":{"type":"double"}, + "NullableInteger":{"type":"integer"}, + "NullableLong":{"type":"long"}, + "OperatingSystemName":{"type":"string"}, + "OperatingSystemVersion":{"type":"string"}, + "OperationInProgressException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.

", + "error":{ + "code":"OperationInProgressFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionNamespace":{"type":"string"}, + "OptionRestrictionMaxLength":{"type":"integer"}, + "OptionRestrictionMaxValue":{"type":"integer"}, + "OptionRestrictionMinValue":{"type":"integer"}, + "OptionRestrictionRegex":{ + "type":"structure", + "members":{ + "Pattern":{ + "shape":"RegexPattern", + "documentation":"

The regular expression pattern that a string configuration option value with this restriction must match.

" + }, + "Label":{ + "shape":"RegexLabel", + "documentation":"

A unique name representing this regular expression.

" + } + }, + "documentation":"

A regular expression representing a restriction on a string configuration option value.

" + }, + "OptionSpecification":{ + "type":"structure", + "members":{ + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

A unique resource name for a time-based scaling configuration option.

" + }, + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

A unique namespace identifying the option's associated AWS resource.

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the configuration option.

" + } + }, + "documentation":"

A specification identifying an individual configuration option.

" + }, + "OptionsSpecifierList":{ + "type":"list", + "member":{"shape":"OptionSpecification"} + }, + "PlatformArn":{"type":"string"}, + "PlatformCategory":{"type":"string"}, + "PlatformDescription":{ + "type":"structure", + "members":{ + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "PlatformOwner":{ + "shape":"PlatformOwner", + "documentation":"

The AWS account ID of the person who created the platform.

" + }, + "PlatformName":{ + "shape":"PlatformName", + "documentation":"

The name of the platform.

" + }, + "PlatformVersion":{ + "shape":"PlatformVersion", + "documentation":"

The version of the platform.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack used by the platform.

" + }, + "PlatformStatus":{ + "shape":"PlatformStatus", + "documentation":"

The status of the platform.

" + }, + "DateCreated":{ + "shape":"CreationDate", + "documentation":"

The date when the platform was created.

" + }, + "DateUpdated":{ + "shape":"UpdateDate", + "documentation":"

The date when the platform was last updated.

" + }, + "PlatformCategory":{ + "shape":"PlatformCategory", + "documentation":"

The category of the platform.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the platform.

" + }, + "Maintainer":{ + "shape":"Maintainer", + "documentation":"

Information about the maintainer of the platform.

" + }, + "OperatingSystemName":{ + "shape":"OperatingSystemName", + "documentation":"

The operating system used by the platform.

" + }, + "OperatingSystemVersion":{ + "shape":"OperatingSystemVersion", + "documentation":"

The version of the operating system used by the platform.

" + }, + "ProgrammingLanguages":{ + "shape":"PlatformProgrammingLanguages", + "documentation":"

The programming languages supported by the platform.

" + }, + "Frameworks":{ + "shape":"PlatformFrameworks", + "documentation":"

The frameworks supported by the platform.

" + }, + "CustomAmiList":{ + "shape":"CustomAmiList", + "documentation":"

The custom AMIs supported by the platform.

" + }, + "SupportedTierList":{ + "shape":"SupportedTierList", + "documentation":"

The tiers supported by the platform.

" + }, + "SupportedAddonList":{ + "shape":"SupportedAddonList", + "documentation":"

The additions supported by the platform.

" + } + }, + "documentation":"

Detailed information about a platform.

" + }, + "PlatformFilter":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"PlatformFilterType", + "documentation":"

The custom platform attribute to which the filter values are applied.

Valid Values: PlatformName | PlatformVersion | PlatformStatus | PlatformOwner

" + }, + "Operator":{ + "shape":"PlatformFilterOperator", + "documentation":"

The operator to apply to the Type with each of the Values.

Valid Values: = (equal to) | != (not equal to) | < (less than) | <= (less than or equal to) | > (greater than) | >= (greater than or equal to) | contains | begins_with | ends_with

" + }, + "Values":{ + "shape":"PlatformFilterValueList", + "documentation":"

The list of values applied to the custom platform attribute.

" + } + }, + "documentation":"

Specify criteria to restrict the results when listing custom platforms.

The filter is evaluated as the expression:

Type Operator Values[i]

" + }, + "PlatformFilterOperator":{"type":"string"}, + "PlatformFilterType":{"type":"string"}, + "PlatformFilterValue":{"type":"string"}, + "PlatformFilterValueList":{ + "type":"list", + "member":{"shape":"PlatformFilterValue"} + }, + "PlatformFilters":{ + "type":"list", + "member":{"shape":"PlatformFilter"} + }, + "PlatformFramework":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the framework.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of the framework.

" + } + }, + "documentation":"

A framework supported by the custom platform.

" + }, + "PlatformFrameworks":{ + "type":"list", + "member":{"shape":"PlatformFramework"} + }, + "PlatformMaxRecords":{ + "type":"integer", + "min":1 + }, + "PlatformName":{"type":"string"}, + "PlatformOwner":{"type":"string"}, + "PlatformProgrammingLanguage":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the programming language.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of the programming language.

" + } + }, + "documentation":"

A programming language supported by the platform.

" + }, + "PlatformProgrammingLanguages":{ + "type":"list", + "member":{"shape":"PlatformProgrammingLanguage"} + }, + "PlatformStatus":{ + "type":"string", + "enum":[ + "Creating", + "Failed", + "Ready", + "Deleting", + "Deleted" + ] + }, + "PlatformSummary":{ + "type":"structure", + "members":{ + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform.

" + }, + "PlatformOwner":{ + "shape":"PlatformOwner", + "documentation":"

The AWS account ID of the person who created the platform.

" + }, + "PlatformStatus":{ + "shape":"PlatformStatus", + "documentation":"

The status of the platform. You can create an environment from the platform once it is ready.

" + }, + "PlatformCategory":{ + "shape":"PlatformCategory", + "documentation":"

The category of platform.

" + }, + "OperatingSystemName":{ + "shape":"OperatingSystemName", + "documentation":"

The operating system used by the platform.

" + }, + "OperatingSystemVersion":{ + "shape":"OperatingSystemVersion", + "documentation":"

The version of the operating system used by the platform.

" + }, + "SupportedTierList":{ + "shape":"SupportedTierList", + "documentation":"

The tiers in which the platform runs.

" + }, + "SupportedAddonList":{ + "shape":"SupportedAddonList", + "documentation":"

The additions associated with the platform.

" + } + }, + "documentation":"

Detailed information about a platform.

" + }, + "PlatformSummaryList":{ + "type":"list", + "member":{"shape":"PlatformSummary"} + }, + "PlatformVersion":{"type":"string"}, + "PlatformVersionStillReferencedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You cannot delete the platform version because there are still environments running on it.

", + "error":{ + "code":"PlatformVersionStillReferencedException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Queue":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the queue.

" + }, + "URL":{ + "shape":"String", + "documentation":"

The URL of the queue.

" + } + }, + "documentation":"

Describes a queue.

" + }, + "QueueList":{ + "type":"list", + "member":{"shape":"Queue"} + }, + "RebuildEnvironmentMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to rebuild.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to rebuild.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

" + }, + "RefreshedAt":{"type":"timestamp"}, + "RegexLabel":{"type":"string"}, + "RegexPattern":{"type":"string"}, + "RequestCount":{"type":"integer"}, + "RequestEnvironmentInfoMessage":{ + "type":"structure", + "required":["InfoType"], + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment of the requested data.

If no such environment is found, RequestEnvironmentInfo returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information to request.

" + } + }, + "documentation":"

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

" + }, + "RequestId":{"type":"string"}, + "ResourceArn":{"type":"string"}, + "ResourceId":{"type":"string"}, + "ResourceName":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A resource doesn't exist for the specified Amazon Resource Name (ARN).

", + "error":{ + "code":"ResourceNotFoundException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ResourceQuota":{ + "type":"structure", + "members":{ + "Maximum":{ + "shape":"BoxedInt", + "documentation":"

The maximum number of instances of this Elastic Beanstalk resource type that an AWS account can use.

" + } + }, + "documentation":"

The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.

" + }, + "ResourceQuotas":{ + "type":"structure", + "members":{ + "ApplicationQuota":{ + "shape":"ResourceQuota", + "documentation":"

The quota for applications in the AWS account.

" + }, + "ApplicationVersionQuota":{ + "shape":"ResourceQuota", + "documentation":"

The quota for application versions in the AWS account.

" + }, + "EnvironmentQuota":{ + "shape":"ResourceQuota", + "documentation":"

The quota for environments in the AWS account.

" + }, + "ConfigurationTemplateQuota":{ + "shape":"ResourceQuota", + "documentation":"

The quota for configuration templates in the AWS account.

" + }, + "CustomPlatformQuota":{ + "shape":"ResourceQuota", + "documentation":"

The quota for custom platforms in the AWS account.

" + } + }, + "documentation":"

A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.

" + }, + "ResourceTagsDescriptionMessage":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resouce for which a tag list was requested.

" + }, + "ResourceTags":{ + "shape":"TagList", + "documentation":"

A list of tag key-value pairs.

" + } + } + }, + "ResourceTypeNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.

", + "error":{ + "code":"ResourceTypeNotSupportedException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "RestartAppServerMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to restart the server for.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + } + }, + "documentation":"

" + }, + "RetrieveEnvironmentInfoMessage":{ + "type":"structure", + "required":["InfoType"], + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the data's environment.

If no such environment is found, returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "InfoType":{ + "shape":"EnvironmentInfoType", + "documentation":"

The type of information to retrieve.

" + } + }, + "documentation":"

Request to download logs retrieved with RequestEnvironmentInfo.

" + }, + "RetrieveEnvironmentInfoResultMessage":{ + "type":"structure", + "members":{ + "EnvironmentInfo":{ + "shape":"EnvironmentInfoDescriptionList", + "documentation":"

The EnvironmentInfoDescription of the environment.

" + } + }, + "documentation":"

Result message containing a description of the requested environment info.

" + }, + "S3Bucket":{ + "type":"string", + "max":255 + }, + "S3Key":{ + "type":"string", + "max":1024 + }, + "S3Location":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The Amazon S3 bucket where the data is located.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The Amazon S3 key where the data is located.

" + } + }, + "documentation":"

The bucket and key of an item stored in Amazon S3.

" + }, + "S3LocationNotInServiceRegionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified S3 bucket does not belong to the S3 region in which the service is running. The following regions are supported:

  • IAD/us-east-1

  • PDX/us-west-2

  • DUB/eu-west-1

", + "error":{ + "code":"S3LocationNotInServiceRegionException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "S3SubscriptionRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account does not have a subscription to Amazon S3.

", + "error":{ + "code":"S3SubscriptionRequiredException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SampleTimestamp":{"type":"timestamp"}, + "SingleInstanceHealth":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the Amazon EC2 instance.

" + }, + "HealthStatus":{ + "shape":"String", + "documentation":"

Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

" + }, + "Color":{ + "shape":"String", + "documentation":"

Represents the color indicator that gives you information about the health of the EC2 instance. For more information, see Health Colors and Statuses.

" + }, + "Causes":{ + "shape":"Causes", + "documentation":"

Represents the causes, which provide more information about the current health status.

" + }, + "LaunchedAt":{ + "shape":"LaunchedAt", + "documentation":"

The time at which the EC2 instance was launched.

" + }, + "ApplicationMetrics":{ + "shape":"ApplicationMetrics", + "documentation":"

Request metrics from your application.

" + }, + "System":{ + "shape":"SystemStatus", + "documentation":"

Operating system metrics from the instance.

" + }, + "Deployment":{ + "shape":"Deployment", + "documentation":"

Information about the most recent deployment to an instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The availability zone in which the instance runs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance's type.

" + } + }, + "documentation":"

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

" + }, + "SolutionStackDescription":{ + "type":"structure", + "members":{ + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

The name of the solution stack.

" + }, + "PermittedFileTypes":{ + "shape":"SolutionStackFileTypeList", + "documentation":"

The permitted file types allowed for a solution stack.

" + } + }, + "documentation":"

Describes the solution stack.

" + }, + "SolutionStackFileTypeList":{ + "type":"list", + "member":{"shape":"FileTypeExtension"} + }, + "SolutionStackName":{"type":"string"}, + "SourceBuildInformation":{ + "type":"structure", + "required":[ + "SourceType", + "SourceRepository", + "SourceLocation" + ], + "members":{ + "SourceType":{ + "shape":"SourceType", + "documentation":"

The type of repository.

  • Git

  • Zip

" + }, + "SourceRepository":{ + "shape":"SourceRepository", + "documentation":"

Location where the repository is stored.

  • CodeCommit

  • S3

" + }, + "SourceLocation":{ + "shape":"SourceLocation", + "documentation":"

The location of the source code, as a formatted string, depending on the value of SourceRepository

  • For CodeCommit, the format is the repository name and commit ID, separated by a forward slash. For example, my-git-repo/265cfa0cf6af46153527f55d6503ec030551f57a.

  • For S3, the format is the S3 bucket name and object key, separated by a forward slash. For example, my-s3-bucket/Folders/my-source-file.

" + } + }, + "documentation":"

Location of the source code for an application version.

" + }, + "SourceBundleDeletionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.

", + "error":{ + "code":"SourceBundleDeletionFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template.

" + } + }, + "documentation":"

A specification for an environment configuration

" + }, + "SourceLocation":{ + "type":"string", + "max":255, + "min":3, + "pattern":".+/.+" + }, + "SourceRepository":{ + "type":"string", + "enum":[ + "CodeCommit", + "S3" + ] + }, + "SourceType":{ + "type":"string", + "enum":[ + "Git", + "Zip" + ] + }, + "StatusCodes":{ + "type":"structure", + "members":{ + "Status2xx":{ + "shape":"NullableInteger", + "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 2xx (200, 201, etc.) status code.

" + }, + "Status3xx":{ + "shape":"NullableInteger", + "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 3xx (300, 301, etc.) status code.

" + }, + "Status4xx":{ + "shape":"NullableInteger", + "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 4xx (400, 401, etc.) status code.

" + }, + "Status5xx":{ + "shape":"NullableInteger", + "documentation":"

The percentage of requests over the last 10 seconds that resulted in a 5xx (500, 501, etc.) status code.

" + } + }, + "documentation":"

Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.

" + }, + "String":{"type":"string"}, + "SupportedAddon":{"type":"string"}, + "SupportedAddonList":{ + "type":"list", + "member":{"shape":"SupportedAddon"} + }, + "SupportedTier":{"type":"string"}, + "SupportedTierList":{ + "type":"list", + "member":{"shape":"SupportedTier"} + }, + "SwapEnvironmentCNAMEsMessage":{ + "type":"structure", + "members":{ + "SourceEnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentId, you must specify the DestinationEnvironmentId.

" + }, + "SourceEnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the source environment.

Condition: You must specify at least the SourceEnvironmentID or the SourceEnvironmentName. You may also specify both. If you specify the SourceEnvironmentName, you must specify the DestinationEnvironmentName.

" + }, + "DestinationEnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentId with the DestinationEnvironmentId.

" + }, + "DestinationEnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the destination environment.

Condition: You must specify at least the DestinationEnvironmentID or the DestinationEnvironmentName. You may also specify both. You must specify the SourceEnvironmentName with the DestinationEnvironmentName.

" + } + }, + "documentation":"

Swaps the CNAMEs of two environments.

" + }, + "SystemStatus":{ + "type":"structure", + "members":{ + "CPUUtilization":{ + "shape":"CPUUtilization", + "documentation":"

CPU utilization metrics for the instance.

" + }, + "LoadAverage":{ + "shape":"LoadAverage", + "documentation":"

Load average in the last 1-minute, 5-minute, and 15-minute periods. For more information, see Operating System Metrics.

" + } + }, + "documentation":"

CPU utilization and load average metrics for an Amazon EC2 instance.

" + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Describes a tag applied to a resource in an environment.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TerminateEnvForce":{"type":"boolean"}, + "TerminateEnvironmentMessage":{ + "type":"structure", + "members":{ + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to terminate.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to terminate.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "TerminateResources":{ + "shape":"TerminateEnvironmentResources", + "documentation":"

Indicates whether the associated AWS resources should shut down when the environment is terminated:

  • true: The specified environment as well as the associated AWS resources, such as Auto Scaling group and LoadBalancer, are terminated.

  • false: AWS Elastic Beanstalk resource management is removed from the environment, but the AWS resources continue to operate.

For more information, see the AWS Elastic Beanstalk User Guide.

Default: true

Valid Values: true | false

" + }, + "ForceTerminate":{ + "shape":"ForceTerminate", + "documentation":"

Terminates the target environment even if another environment in the same group is dependent on it.

" + } + }, + "documentation":"

Request to terminate an environment.

" + }, + "TerminateEnvironmentResources":{"type":"boolean"}, + "TimeFilterEnd":{"type":"timestamp"}, + "TimeFilterStart":{"type":"timestamp"}, + "Timestamp":{"type":"timestamp"}, + "Token":{"type":"string"}, + "TooManyApplicationVersionsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account has reached its limit of application versions.

", + "exception":true + }, + "TooManyApplicationsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account has reached its limit of applications.

", + "error":{ + "code":"TooManyApplicationsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyBucketsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account has reached its limit of Amazon S3 buckets.

", + "error":{ + "code":"TooManyBucketsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyConfigurationTemplatesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account has reached its limit of configuration templates.

", + "error":{ + "code":"TooManyConfigurationTemplatesException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyEnvironmentsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified account has reached its limit of environments.

", + "error":{ + "code":"TooManyEnvironmentsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyPlatformsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the maximum number of allowed platforms associated with the account.

", + "error":{ + "code":"TooManyPlatformsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of tags in the resource would exceed the number of tags that each resource can have.

To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.

", + "error":{ + "code":"TooManyTagsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Trigger":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceId", + "documentation":"

The name of the trigger.

" + } + }, + "documentation":"

Describes a trigger.

" + }, + "TriggerList":{ + "type":"list", + "member":{"shape":"Trigger"} + }, + "UpdateApplicationMessage":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to update. If no such application is found, UpdateApplication returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for the application.

Default: If not specified, AWS Elastic Beanstalk does not update the description.

" + } + }, + "documentation":"

Request to update an application.

" + }, + "UpdateApplicationResourceLifecycleMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "ResourceLifecycleConfig" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "ResourceLifecycleConfig":{ + "shape":"ApplicationResourceLifecycleConfig", + "documentation":"

The lifecycle configuration.

" + } + } + }, + "UpdateApplicationVersionMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "VersionLabel" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with this version.

If no application is found with this name, UpdateApplication returns an InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for this version.

" + } + }, + "documentation":"

" + }, + "UpdateConfigurationTemplateMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "TemplateName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application associated with the configuration template to update.

If no application is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to update.

If no configuration template is found with this name, UpdateConfigurationTemplate returns an InvalidParameterValue error.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A new description for the configuration.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of configuration option settings to update with the new specified option value.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

" + } + }, + "documentation":"

The result message containing the options for the specified solution stack.

" + }, + "UpdateDate":{"type":"timestamp"}, + "UpdateEnvironmentMessage":{ + "type":"structure", + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application with which the environment is associated.

" + }, + "EnvironmentId":{ + "shape":"EnvironmentId", + "documentation":"

The ID of the environment to update.

If no environment with this ID exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to update. If no environment with this name exists, AWS Elastic Beanstalk returns an InvalidParameterValue error.

Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

The name of the group to which the target environment belongs. Specify a group name only if the environment's name is specified in an environment manifest and not with the environment name or environment ID parameters. See Environment Manifest (env.yaml) for details.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

" + }, + "Tier":{ + "shape":"EnvironmentTier", + "documentation":"

This specifies the tier to use to update the environment.

Condition: At this time, if you change the tier version, name, or type, AWS Elastic Beanstalk returns InvalidParameterValue error.

" + }, + "VersionLabel":{ + "shape":"VersionLabel", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys the named application version to the environment. If no such application version is found, returns an InvalidParameterValue error.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

If this parameter is specified, AWS Elastic Beanstalk deploys this configuration template to the environment. If no such configuration template is found, AWS Elastic Beanstalk returns an InvalidParameterValue error.

" + }, + "SolutionStackName":{ + "shape":"SolutionStackName", + "documentation":"

This specifies the platform version that the environment will run after the environment is updated.

" + }, + "PlatformArn":{ + "shape":"PlatformArn", + "documentation":"

The ARN of the platform, if used.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

If specified, AWS Elastic Beanstalk updates the configuration set associated with the running environment and sets the specified configuration options to the requested value.

" + }, + "OptionsToRemove":{ + "shape":"OptionsSpecifierList", + "documentation":"

A list of custom user-defined configuration options to remove from the configuration set for this environment.

" + } + }, + "documentation":"

Request to update an environment.

" + }, + "UpdateTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resouce to be updated.

Must be the ARN of an Elastic Beanstalk environment.

" + }, + "TagsToAdd":{ + "shape":"TagList", + "documentation":"

A list of tags to add or update.

If a key of an existing tag is added, the tag's value is updated.

" + }, + "TagsToRemove":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys to remove.

If a tag key doesn't exist, it is silently ignored.

" + } + } + }, + "UserDefinedOption":{"type":"boolean"}, + "ValidateConfigurationSettingsMessage":{ + "type":"structure", + "required":[ + "ApplicationName", + "OptionSettings" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application that the configuration template or environment belongs to.

" + }, + "TemplateName":{ + "shape":"ConfigurationTemplateName", + "documentation":"

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

" + }, + "EnvironmentName":{ + "shape":"EnvironmentName", + "documentation":"

The name of the environment to validate the settings against.

Condition: You cannot specify both this and a configuration template name.

" + }, + "OptionSettings":{ + "shape":"ConfigurationOptionSettingsList", + "documentation":"

A list of the options and desired values to evaluate.

" + } + }, + "documentation":"

A list of validation messages for a specified configuration template.

" + }, + "ValidationMessage":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ValidationMessageString", + "documentation":"

A message describing the error or warning.

" + }, + "Severity":{ + "shape":"ValidationSeverity", + "documentation":"

An indication of the severity of this message:

  • error: This message indicates that this is not a valid setting for an option.

  • warning: This message is providing information you should take into account.

" + }, + "Namespace":{ + "shape":"OptionNamespace", + "documentation":"

The namespace to which the option belongs.

" + }, + "OptionName":{ + "shape":"ConfigurationOptionName", + "documentation":"

The name of the option.

" + } + }, + "documentation":"

An error or warning for a desired configuration option value.

" + }, + "ValidationMessageString":{"type":"string"}, + "ValidationMessagesList":{ + "type":"list", + "member":{"shape":"ValidationMessage"} + }, + "ValidationSeverity":{ + "type":"string", + "enum":[ + "error", + "warning" + ] + }, + "VersionLabel":{ + "type":"string", + "max":100, + "min":1 + }, + "VersionLabels":{ + "type":"list", + "member":{"shape":"VersionLabel"} + }, + "VersionLabelsList":{ + "type":"list", + "member":{"shape":"VersionLabel"} + }, + "VirtualizationType":{"type":"string"} + }, + "documentation":"AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

" +} diff --git a/aws/dist/botocore/data/elastictranscoder/2012-09-25/examples-1.json b/aws/dist/botocore/data/elastictranscoder/2012-09-25/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/elastictranscoder/2012-09-25/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/elastictranscoder/2012-09-25/paginators-1.json b/aws/dist/botocore/data/elastictranscoder/2012-09-25/paginators-1.json new file mode 100644 index 00000000..5a145d36 --- /dev/null +++ b/aws/dist/botocore/data/elastictranscoder/2012-09-25/paginators-1.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListJobsByPipeline": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListJobsByStatus": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Jobs" + }, + "ListPipelines": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Pipelines" + }, + "ListPresets": { + "input_token": "PageToken", + "output_token": "NextPageToken", + "result_key": "Presets" + } + } +} diff --git a/aws/dist/botocore/data/elastictranscoder/2012-09-25/service-2.json b/aws/dist/botocore/data/elastictranscoder/2012-09-25/service-2.json new file mode 100644 index 00000000..980f4d4d --- /dev/null +++ b/aws/dist/botocore/data/elastictranscoder/2012-09-25/service-2.json @@ -0,0 +1,2337 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-09-25", + "endpointPrefix":"elastictranscoder", + "protocol":"rest-json", + "serviceFullName":"Amazon Elastic Transcoder", + "serviceId":"Elastic Transcoder", + "signatureVersion":"v4", + "uid":"elastictranscoder-2012-09-25" + }, + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/jobs/{Id}", + "responseCode":202 + }, + "input":{"shape":"CancelJobRequest"}, + "output":{"shape":"CancelJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The CancelJob operation cancels an unfinished job.

You can only cancel a job that has a status of Submitted. To prevent a pipeline from starting to process a job while you're getting the job identifier, use UpdatePipelineStatus to temporarily pause the pipeline.

" + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/jobs", + "responseCode":201 + }, + "input":{"shape":"CreateJobRequest"}, + "output":{"shape":"CreateJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.

If you have specified more than one output for your jobs (for example, one output for the Kindle Fire and another output for the Apple iPhone 4s), you currently must use the Elastic Transcoder API to list the jobs (as opposed to the AWS Console).

" + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines", + "responseCode":201 + }, + "input":{"shape":"CreatePipelineRequest"}, + "output":{"shape":"CreatePipelineResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The CreatePipeline operation creates a pipeline with settings that you specify.

" + }, + "CreatePreset":{ + "name":"CreatePreset", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/presets", + "responseCode":201 + }, + "input":{"shape":"CreatePresetRequest"}, + "output":{"shape":"CreatePresetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The CreatePreset operation creates a preset with settings that you specify.

Elastic Transcoder checks the CreatePreset settings to ensure that they meet Elastic Transcoder requirements and to determine whether they comply with H.264 standards. If your settings are not valid for Elastic Transcoder, Elastic Transcoder returns an HTTP 400 response (ValidationException) and does not create the preset. If the settings are valid for Elastic Transcoder but aren't strictly compliant with the H.264 standard, Elastic Transcoder creates the preset and returns a warning message in the response. This helps you determine whether your settings comply with the H.264 standard while giving you greater flexibility with respect to the video that Elastic Transcoder produces.

Elastic Transcoder uses the H.264 video-compression format. For more information, see the International Telecommunication Union publication Recommendation ITU-T H.264: Advanced video coding for generic audiovisual services.

" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/pipelines/{Id}", + "responseCode":202 + }, + "input":{"shape":"DeletePipelineRequest"}, + "output":{"shape":"DeletePipelineResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The DeletePipeline operation removes a pipeline.

You can only delete a pipeline that has never been used or that is not currently in use (doesn't contain any active jobs). If the pipeline is currently in use, DeletePipeline returns an error.

" + }, + "DeletePreset":{ + "name":"DeletePreset", + "http":{ + "method":"DELETE", + "requestUri":"/2012-09-25/presets/{Id}", + "responseCode":202 + }, + "input":{"shape":"DeletePresetRequest"}, + "output":{"shape":"DeletePresetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The DeletePreset operation removes a preset that you've added in an AWS region.

You can't delete the default presets that are included with Elastic Transcoder.

" + }, + "ListJobsByPipeline":{ + "name":"ListJobsByPipeline", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobsByPipeline/{PipelineId}" + }, + "input":{"shape":"ListJobsByPipelineRequest"}, + "output":{"shape":"ListJobsByPipelineResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.

Elastic Transcoder returns all of the jobs currently in the specified pipeline. The response body contains one element for each job that satisfies the search criteria.

" + }, + "ListJobsByStatus":{ + "name":"ListJobsByStatus", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobsByStatus/{Status}" + }, + "input":{"shape":"ListJobsByStatusRequest"}, + "output":{"shape":"ListJobsByStatusResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ListJobsByStatus operation gets a list of jobs that have a specified status. The response body contains one element for each job that satisfies the search criteria.

" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/pipelines" + }, + "input":{"shape":"ListPipelinesRequest"}, + "output":{"shape":"ListPipelinesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ListPipelines operation gets a list of the pipelines associated with the current AWS account.

" + }, + "ListPresets":{ + "name":"ListPresets", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/presets" + }, + "input":{"shape":"ListPresetsRequest"}, + "output":{"shape":"ListPresetsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.

" + }, + "ReadJob":{ + "name":"ReadJob", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/jobs/{Id}" + }, + "input":{"shape":"ReadJobRequest"}, + "output":{"shape":"ReadJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ReadJob operation returns detailed information about a job.

" + }, + "ReadPipeline":{ + "name":"ReadPipeline", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/pipelines/{Id}" + }, + "input":{"shape":"ReadPipelineRequest"}, + "output":{"shape":"ReadPipelineResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ReadPipeline operation gets detailed information about a pipeline.

" + }, + "ReadPreset":{ + "name":"ReadPreset", + "http":{ + "method":"GET", + "requestUri":"/2012-09-25/presets/{Id}" + }, + "input":{"shape":"ReadPresetRequest"}, + "output":{"shape":"ReadPresetResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The ReadPreset operation gets detailed information about a preset.

" + }, + "TestRole":{ + "name":"TestRole", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/roleTests", + "responseCode":200 + }, + "input":{"shape":"TestRoleRequest"}, + "output":{"shape":"TestRoleResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The TestRole operation tests the IAM role used to create the pipeline.

The TestRole action lets you determine whether the IAM role you are using has sufficient permissions to let Elastic Transcoder perform tasks associated with the transcoding process. The action attempts to assume the specified IAM role, checks read access to the input and output buckets, and tries to send a test notification to Amazon SNS topics that you specify.

", + "deprecated":true + }, + "UpdatePipeline":{ + "name":"UpdatePipeline", + "http":{ + "method":"PUT", + "requestUri":"/2012-09-25/pipelines/{Id}", + "responseCode":200 + }, + "input":{"shape":"UpdatePipelineRequest"}, + "output":{"shape":"UpdatePipelineResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Use the UpdatePipeline operation to update settings for a pipeline.

When you change pipeline settings, your changes take effect immediately. Jobs that you have already submitted and that Elastic Transcoder has not started to process are affected in addition to jobs that you submit after you change settings.

" + }, + "UpdatePipelineNotifications":{ + "name":"UpdatePipelineNotifications", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines/{Id}/notifications" + }, + "input":{"shape":"UpdatePipelineNotificationsRequest"}, + "output":{"shape":"UpdatePipelineNotificationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.

When you update notifications for a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "UpdatePipelineStatus":{ + "name":"UpdatePipelineStatus", + "http":{ + "method":"POST", + "requestUri":"/2012-09-25/pipelines/{Id}/status" + }, + "input":{"shape":"UpdatePipelineStatusRequest"}, + "output":{"shape":"UpdatePipelineStatusResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"IncompatibleVersionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.

Changing the pipeline status is useful if you want to cancel one or more jobs. You can't cancel jobs after Elastic Transcoder has started processing them; if you pause the pipeline to which you submitted the jobs, you have more time to get the job IDs for the jobs that you want to cancel, and to send a CancelJob request.

" + } + }, + "shapes":{ + "AccessControl":{ + "type":"string", + "pattern":"(^FullControl$)|(^Read$)|(^ReadAcp$)|(^WriteAcp$)" + }, + "AccessControls":{ + "type":"list", + "member":{"shape":"AccessControl"}, + "max":30 + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

General authentication failure. The request was not signed correctly.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "Artwork":{ + "type":"structure", + "members":{ + "InputKey":{ + "shape":"WatermarkKey", + "documentation":"

The name of the file to be used as album art. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by PipelineId; the InputBucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, cooking/pie.jpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 4096, inclusive.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of the output album art in pixels. If you specify auto, Elastic Transcoder uses 600 as the default value. If you specify a numeric value, enter an even integer between 32 and 3072, inclusive.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of the output album art:

  • Fit: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Fill: Elastic Transcoder scales the output art so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output art and then crops it in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches the output art to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input art and the output art are different, the output art will be distorted.

  • Keep: Elastic Transcoder does not scale the output art. If either dimension of the input art exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output art.

  • ShrinkToFit: Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the art up.

  • ShrinkToFill Elastic Transcoder scales the output art down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the art up.

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add white bars to the top and bottom and/or left and right sides of the output album art to make the total size of the output art match the values that you specified for MaxWidth and MaxHeight.

" + }, + "AlbumArtFormat":{ + "shape":"JpgOrPng", + "documentation":"

The format of album art, if any. Valid formats are .jpg and .png.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your artwork.

" + } + }, + "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20.

To remove artwork or leave the artwork empty, you can either set Artwork to null, or set the Merge Policy to \"Replace\" and use an empty Artwork array.

To pass through existing artwork unchanged, set the Merge Policy to \"Prepend\", \"Append\", or \"Fallback\", and use an empty Artwork array.

" + }, + "Artworks":{ + "type":"list", + "member":{"shape":"Artwork"} + }, + "Ascending":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "AspectRatio":{ + "type":"string", + "pattern":"(^auto$)|(^1:1$)|(^4:3$)|(^3:2$)|(^16:9$)" + }, + "AudioBitDepth":{ + "type":"string", + "pattern":"(^8$)|(^16$)|(^24$)|(^32$)" + }, + "AudioBitOrder":{ + "type":"string", + "pattern":"(^LittleEndian$)" + }, + "AudioBitRate":{ + "type":"string", + "pattern":"^\\d{1,3}$" + }, + "AudioChannels":{ + "type":"string", + "pattern":"(^auto$)|(^0$)|(^1$)|(^2$)" + }, + "AudioCodec":{ + "type":"string", + "pattern":"(^AAC$)|(^vorbis$)|(^mp3$)|(^mp2$)|(^pcm$)|(^flac$)" + }, + "AudioCodecOptions":{ + "type":"structure", + "members":{ + "Profile":{ + "shape":"AudioCodecProfile", + "documentation":"

You can only choose an audio profile when you specify AAC for the value of Audio:Codec.

Specify the AAC profile for the output file. Elastic Transcoder supports the following profiles:

  • auto: If you specify auto, Elastic Transcoder selects the profile based on the bit rate selected for the output file.

  • AAC-LC: The most common AAC profile. Use for bit rates larger than 64 kbps.

  • HE-AAC: Not supported on some older players and devices. Use for bit rates between 40 and 80 kbps.

  • HE-AACv2: Not supported on some players and devices. Use for bit rates less than 48 kbps.

All outputs in a Smooth playlist must have the same value for Profile.

If you created any presets before AAC profiles were added, Elastic Transcoder automatically updated your presets to use AAC-LC. You can change the value as required.

" + }, + "BitDepth":{ + "shape":"AudioBitDepth", + "documentation":"

You can only choose an audio bit depth when you specify flac or pcm for the value of Audio:Codec.

The bit depth of a sample is how many bits of information are included in the audio samples. The higher the bit depth, the better the audio, but the larger the file.

Valid values are 16 and 24.

The most common bit depth is 24.

" + }, + "BitOrder":{ + "shape":"AudioBitOrder", + "documentation":"

You can only choose an audio bit order when you specify pcm for the value of Audio:Codec.

The order the bits of a PCM sample are stored in.

The supported value is LittleEndian.

" + }, + "Signed":{ + "shape":"AudioSigned", + "documentation":"

You can only choose whether an audio sample is signed when you specify pcm for the value of Audio:Codec.

Whether audio samples are represented with negative and positive numbers (signed) or only positive numbers (unsigned).

The supported value is Signed.

" + } + }, + "documentation":"

Options associated with your audio codec.

" + }, + "AudioCodecProfile":{ + "type":"string", + "pattern":"(^auto$)|(^AAC-LC$)|(^HE-AAC$)|(^HE-AACv2$)" + }, + "AudioPackingMode":{ + "type":"string", + "pattern":"(^SingleTrack$)|(^OneChannelPerTrack$)|(^OneChannelPerTrackWithMosTo8Tracks$)" + }, + "AudioParameters":{ + "type":"structure", + "members":{ + "Codec":{ + "shape":"AudioCodec", + "documentation":"

The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

" + }, + "SampleRate":{ + "shape":"AudioSampleRate", + "documentation":"

The sample rate of the audio stream in the output file, in Hertz. Valid values include:

auto, 22050, 32000, 44100, 48000, 96000

If you specify auto, Elastic Transcoder automatically detects the sample rate.

" + }, + "BitRate":{ + "shape":"AudioBitRate", + "documentation":"

The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

" + }, + "Channels":{ + "shape":"AudioChannels", + "documentation":"

The number of audio channels in the output file. The following values are valid:

auto, 0, 1, 2

One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto.

The output of a specific channel value and inputs are as follows:

  • auto channel specified, with any input: Pass through up to eight input channels.

  • 0 channels specified, with any input: Audio omitted from the output.

  • 1 channel specified, with at least one input channel: Mono sound.

  • 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode.

For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode.

" + }, + "AudioPackingMode":{ + "shape":"AudioPackingMode", + "documentation":"

The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

The following values are valid:

SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks

When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers.

The outputs of SingleTrack for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary

  • 2 channels with one track with one channel: One track with two identical channels

  • 2 or auto channels with two tracks with one channel each: One track with two channels

  • 2 or auto channels with one track with two channels: One track with two channels

  • 2 channels with one track with multiple channels: One track with two channels

  • auto channels with one track with one channel: One track with one channel

  • auto channels with one track with multiple channels: One track with multiple channels

When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.

The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary

  • 2 channels with one track with one channel: Two tracks with one identical channel each

  • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each

  • 2 or auto channels with one track with two channels: Two tracks with one channel each

  • 2 channels with one track with multiple channels: Two tracks with one channel each

  • auto channels with one track with one channel: One track with one channel

  • auto channels with one track with multiple channels: Up to eight tracks with one channel each

When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.

The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows:

  • 0 channels with any input: Audio omitted from the output

  • 1, 2, or auto channels with no audio input: Audio omitted from the output

  • 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks

  • 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks

  • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks

  • 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks

  • 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks

  • auto channels with one track with one channel: One track with one channel, plus seven MOS tracks

  • auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all

" + }, + "CodecOptions":{ + "shape":"AudioCodecOptions", + "documentation":"

If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:

auto, AAC-LC, HE-AAC, HE-AACv2

If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

" + } + }, + "documentation":"

Parameters required for transcoding audio.

" + }, + "AudioSampleRate":{ + "type":"string", + "pattern":"(^auto$)|(^22050$)|(^32000$)|(^44100$)|(^48000$)|(^96000$)|(^192000$)" + }, + "AudioSigned":{ + "type":"string", + "pattern":"(^Unsigned$)|(^Signed$)" + }, + "Base64EncodedString":{ + "type":"string", + "pattern":"^$|(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" + }, + "BucketName":{ + "type":"string", + "pattern":"^(\\w|\\.|-){1,255}$" + }, + "CancelJobRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the job that you want to cancel.

To get a list of the jobs (including their jobId) that have a status of Submitted, use the ListJobsByStatus API action.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The CancelJobRequest structure.

" + }, + "CancelJobResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response body contains a JSON object. If the job is successfully canceled, the value of Success is true.

" + }, + "CaptionFormat":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"CaptionFormatFormat", + "documentation":"

The format you specify determines whether Elastic Transcoder generates an embedded or sidecar caption for this output.

  • Valid Embedded Caption Formats:

    • for FLAC: None

    • For MP3: None

    • For MP4: mov-text

    • For MPEG-TS: None

    • For ogg: None

    • For webm: None

  • Valid Sidecar Caption Formats: Elastic Transcoder supports dfxp (first div element only), scc, srt, and webvtt. If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

    • For FMP4: dfxp

    • Non-FMP4 outputs: All sidecar types

    fmp4 captions have an extension of .ismt

" + }, + "Pattern":{ + "shape":"CaptionFormatPattern", + "documentation":"

The prefix for caption filenames, in the form description-{language}, where:

  • description is a description of the video.

  • {language} is a literal value that Elastic Transcoder replaces with the two- or three-letter code for the language of the caption in the output file names.

If you don't include {language} in the file name pattern, Elastic Transcoder automatically appends \"{language}\" to the value that you specify for the description. In addition, Elastic Transcoder automatically appends the count to the end of the segment files.

For example, suppose you're transcoding into srt format. When you enter \"Sydney-{language}-sunrise\", and the language of the captions is English (en), the name of the first caption file is be Sydney-en-sunrise00000.srt.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

" + } + }, + "documentation":"

The file format of the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" + }, + "CaptionFormatFormat":{ + "type":"string", + "pattern":"(^mov-text$)|(^srt$)|(^scc$)|(^webvtt$)|(^dfxp$)|(^cea-708$)" + }, + "CaptionFormatPattern":{ + "type":"string", + "pattern":"(^$)|(^.*\\{language\\}.*$)" + }, + "CaptionFormats":{ + "type":"list", + "member":{"shape":"CaptionFormat"}, + "max":4 + }, + "CaptionMergePolicy":{ + "type":"string", + "pattern":"(^MergeOverride$)|(^MergeRetain$)|(^Override$)" + }, + "CaptionSource":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"LongKey", + "documentation":"

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

" + }, + "Language":{ + "shape":"Key", + "documentation":"

A string that specifies the language of the caption. If you specified multiple inputs with captions, the caption language must match in order to be included in the output. Specify this as one of:

  • 2-character ISO 639-1 code

  • 3-character ISO 639-2 code

For more information on ISO language codes and language names, see the List of ISO 639-1 codes.

" + }, + "TimeOffset":{ + "shape":"TimeOffset", + "documentation":"

For clip generation or captions that do not start at the same time as the associated video file, the TimeOffset tells Elastic Transcoder how much of the video to encode before including captions.

Specify the TimeOffset in the form [+-]SS.sss or [+-]HH:mm:SS.ss.

" + }, + "Label":{ + "shape":"Name", + "documentation":"

The label of the caption shown in the player when choosing a language. We recommend that you put the caption language name here, in the language of the captions.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that Elastic Transcoder needs to decyrpt your caption sources, or that you want Elastic Transcoder to apply to your caption sources.

" + } + }, + "documentation":"

A source file for the input sidecar captions used during the transcoding process.

" + }, + "CaptionSources":{ + "type":"list", + "member":{"shape":"CaptionSource"}, + "max":20 + }, + "Captions":{ + "type":"structure", + "members":{ + "MergePolicy":{ + "shape":"CaptionMergePolicy", + "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.

", + "deprecated":true + }, + "CaptionSources":{ + "shape":"CaptionSources", + "documentation":"

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

", + "deprecated":true + }, + "CaptionFormats":{ + "shape":"CaptionFormats", + "documentation":"

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

" + } + }, + "documentation":"

The captions to be created, if any.

" + }, + "Clip":{ + "type":"structure", + "members":{ + "TimeSpan":{ + "shape":"TimeSpan", + "documentation":"

Settings that determine when a clip begins and how long it lasts.

" + } + }, + "documentation":"

Settings for one clip in a composition. All jobs in a playlist must have the same clip settings.

", + "deprecated":true + }, + "CodecOption":{ + "type":"string", + "max":255, + "min":1 + }, + "CodecOptions":{ + "type":"map", + "key":{"shape":"CodecOption"}, + "value":{"shape":"CodecOption"}, + "max":30 + }, + "Composition":{ + "type":"list", + "member":{"shape":"Clip"}, + "deprecated":true + }, + "CreateJobOutput":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"Key", + "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID. If a file with the specified name already exists in the output bucket, the job fails.

" + }, + "ThumbnailPattern":{ + "shape":"ThumbnailPattern", + "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

  • {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.

    If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

  • Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

  • {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" + }, + "ThumbnailEncryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" + }, + "Rotate":{ + "shape":"Rotate", + "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values: auto, 0, 90, 180, 270. The value auto generally works only if the file that you're transcoding contains rotation metadata.

" + }, + "PresetId":{ + "shape":"Id", + "documentation":"

The Id of the preset to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding.

" + }, + "SegmentDuration":{ + "shape":"FloatString", + "documentation":"

(Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4 and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.

" + }, + "Watermarks":{ + "shape":"JobWatermarks", + "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset for the current output.

" + }, + "AlbumArt":{ + "shape":"JobAlbumArt", + "documentation":"

Information about the album art that you want Elastic Transcoder to add to the file during transcoding. You can specify up to twenty album artworks for each output. Settings for each artwork must be defined in the job for the current output.

" + }, + "Composition":{ + "shape":"Composition", + "documentation":"

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

", + "deprecated":true + }, + "Captions":{ + "shape":"Captions", + "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

You can specify encryption settings for any output files that you want to use for a transcoding job. This includes the output file and any watermarks, thumbnails, album art, or captions that you want to use. You must specify encryption settings for each file individually.

" + } + }, + "documentation":"

The CreateJobOutput structure.

" + }, + "CreateJobOutputs":{ + "type":"list", + "member":{"shape":"CreateJobOutput"}, + "max":30 + }, + "CreateJobPlaylist":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Filename", + "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" + }, + "Format":{ + "shape":"PlaylistFormat", + "documentation":"

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

" + }, + "OutputKeys":{ + "shape":"OutputKeys", + "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

  • If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

    OutputKeyPrefixOutputs:Key

  • If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:

    OutputKeyPrefixOutputs:Key.m3u8

    OutputKeyPrefixOutputs:Key00000.ts

  • If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:

    OutputKeyPrefixOutputs:Key_v4.m3u8

    OutputKeyPrefixOutputs:Key_iframe.m3u8

    OutputKeyPrefixOutputs:Key.ts

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.

If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" + }, + "HlsContentProtection":{ + "shape":"HlsContentProtection", + "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + }, + "PlayReadyDrm":{ + "shape":"PlayReadyDrm", + "documentation":"

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + } + }, + "documentation":"

Information about the master playlist.

" + }, + "CreateJobPlaylists":{ + "type":"list", + "member":{"shape":"CreateJobPlaylist"}, + "max":30 + }, + "CreateJobRequest":{ + "type":"structure", + "required":["PipelineId"], + "members":{ + "PipelineId":{ + "shape":"Id", + "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" + }, + "Input":{ + "shape":"JobInput", + "documentation":"

A section of the request body that provides information about the file that is being transcoded.

" + }, + "Inputs":{ + "shape":"JobInputs", + "documentation":"

A section of the request body that provides information about the files that are being transcoded.

" + }, + "Output":{ + "shape":"CreateJobOutput", + "documentation":"

A section of the request body that provides information about the transcoded (target) file. We strongly recommend that you use the Outputs syntax instead of the Output syntax.

" + }, + "Outputs":{ + "shape":"CreateJobOutputs", + "documentation":"

A section of the request body that provides information about the transcoded (target) files. We recommend that you use the Outputs syntax instead of the Output syntax.

" + }, + "OutputKeyPrefix":{ + "shape":"Key", + "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists.

" + }, + "Playlists":{ + "shape":"CreateJobPlaylists", + "documentation":"

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" + }, + "UserMetadata":{ + "shape":"UserMetadata", + "documentation":"

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

" + } + }, + "documentation":"

The CreateJobRequest structure.

" + }, + "CreateJobResponse":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"Job", + "documentation":"

A section of the response body that provides information about the job that is created.

" + } + }, + "documentation":"

The CreateJobResponse structure.

" + }, + "CreatePipelineRequest":{ + "type":"structure", + "required":[ + "Name", + "InputBucket", + "Role" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters.

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. (Use this, or use ContentConfig:Bucket plus ThumbnailConfig:Bucket.)

Specify this value when all of the following are true:

  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

  • You do not want to specify the permissions that Elastic Transcoder grants to the files.

    When Elastic Transcoder saves files in OutputBucket, it grants full control over the files only to the AWS account that owns the role that is specified by Role.

  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to create the pipeline.

" + }, + "AwsKmsKeyArn":{ + "shape":"KeyArn", + "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.

  • Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition while processing a job in this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

" + }, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" + } + }, + "documentation":"

The CreatePipelineRequest structure.

" + }, + "CreatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline that is created.

" + }, + "Warnings":{ + "shape":"Warnings", + "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" + } + }, + "documentation":"

When you create a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "CreatePresetRequest":{ + "type":"structure", + "required":[ + "Name", + "Container" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the preset.

" + }, + "Container":{ + "shape":"PresetContainer", + "documentation":"

The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

" + }, + "Video":{ + "shape":"VideoParameters", + "documentation":"

A section of the request body that specifies the video parameters.

" + }, + "Audio":{ + "shape":"AudioParameters", + "documentation":"

A section of the request body that specifies the audio parameters.

" + }, + "Thumbnails":{ + "shape":"Thumbnails", + "documentation":"

A section of the request body that specifies the thumbnail parameters, if any.

" + } + }, + "documentation":"

The CreatePresetRequest structure.

" + }, + "CreatePresetResponse":{ + "type":"structure", + "members":{ + "Preset":{ + "shape":"Preset", + "documentation":"

A section of the response body that provides information about the preset that is created.

" + }, + "Warning":{ + "shape":"String", + "documentation":"

If the preset settings don't comply with the standards for the video codec but Elastic Transcoder created the preset, this message explains the reason the preset settings don't meet the standard. Elastic Transcoder created the preset because the settings might produce acceptable output.

" + } + }, + "documentation":"

The CreatePresetResponse structure.

" + }, + "DeletePipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the pipeline that you want to delete.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The DeletePipelineRequest structure.

" + }, + "DeletePipelineResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DeletePipelineResponse structure.

" + }, + "DeletePresetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the preset for which you want to get detailed information.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The DeletePresetRequest structure.

" + }, + "DeletePresetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DeletePresetResponse structure.

" + }, + "Description":{ + "type":"string", + "max":255, + "min":0 + }, + "DetectedProperties":{ + "type":"structure", + "members":{ + "Width":{ + "shape":"NullableInteger", + "documentation":"

The detected width of the input file, in pixels.

" + }, + "Height":{ + "shape":"NullableInteger", + "documentation":"

The detected height of the input file, in pixels.

" + }, + "FrameRate":{ + "shape":"FloatString", + "documentation":"

The detected frame rate of the input file, in frames per second.

" + }, + "FileSize":{ + "shape":"NullableLong", + "documentation":"

The detected file size of the input file, in bytes.

" + }, + "DurationMillis":{ + "shape":"NullableLong", + "documentation":"

The detected duration of the input file, in milliseconds.

" + } + }, + "documentation":"

The detected properties of the input file. Elastic Transcoder identifies these values from the input file.

" + }, + "Digits":{ + "type":"string", + "pattern":"^\\d{1,5}$" + }, + "DigitsOrAuto":{ + "type":"string", + "pattern":"(^auto$)|(^\\d{2,4}$)" + }, + "Encryption":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"EncryptionMode", + "documentation":"

The specific server-side encryption mode that you want Elastic Transcoder to use when decrypting your input files or encrypting your output files. Elastic Transcoder supports the following options:

  • s3: Amazon S3 creates and manages the keys used for encrypting your files.

  • s3-aws-kms: Amazon S3 calls the Amazon Key Management Service, which creates and manages the keys that are used for encrypting your files. If you specify s3-aws-kms and you don't want to use the default key, you must add the AWS-KMS key that you want to use to your pipeline.

  • aes-cbc-pkcs7: A padded cipher-block mode of operation originally used for HLS files.

  • aes-ctr: AES Counter Mode.

  • aes-gcm: AES Galois Counter Mode, a mode of operation that is an authenticated encryption format, meaning that a file, key, or initialization vector that has been tampered with fails the decryption process.

For all three AES options, you must provide the following settings, which must be base64-encoded:

  • Key

  • Key MD5

  • Initialization Vector

For the AES modes, your private encryption keys and your unencrypted data are never stored by AWS; therefore, it is important that you safely manage your encryption keys. If you lose them, you won't be able to unencrypt your data.

" + }, + "Key":{ + "shape":"Base64EncodedString", + "documentation":"

The data encryption key that you want Elastic Transcoder to use to encrypt your output file, or that was used to encrypt your input file. The key must be base64-encoded and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

The key must also be encrypted by using the Amazon Key Management Service.

" + }, + "KeyMd5":{ + "shape":"Base64EncodedString", + "documentation":"

The MD5 digest of the key that you used to encrypt your input file, or that you want Elastic Transcoder to use to encrypt your output file. Elastic Transcoder uses the key digest as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

" + }, + "InitializationVector":{ + "shape":"ZeroTo255String", + "documentation":"

The series of random bits created by a random bit generator, unique for every encryption operation, that you used to encrypt your input files or that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes long before being base64-encoded.

" + } + }, + "documentation":"

The encryption settings, if any, that are used for decrypting your input files or encrypting your output files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file, otherwise you must specify the mode you want Elastic Transcoder to use to encrypt your output files.

" + }, + "EncryptionMode":{ + "type":"string", + "pattern":"(^s3$)|(^s3-aws-kms$)|(^aes-cbc-pkcs7$)|(^aes-ctr$)|(^aes-gcm$)" + }, + "ExceptionMessages":{ + "type":"list", + "member":{"shape":"String"} + }, + "Filename":{ + "type":"string", + "max":255, + "min":1 + }, + "FixedGOP":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "FloatString":{ + "type":"string", + "pattern":"^\\d{1,5}(\\.\\d{0,5})?$" + }, + "FrameRate":{ + "type":"string", + "pattern":"(^auto$)|(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" + }, + "Grantee":{ + "type":"string", + "max":255, + "min":1 + }, + "GranteeType":{ + "type":"string", + "pattern":"(^Canonical$)|(^Email$)|(^Group$)" + }, + "HlsContentProtection":{ + "type":"structure", + "members":{ + "Method":{ + "shape":"HlsContentProtectionMethod", + "documentation":"

The content protection method for your output. The only valid value is: aes-128.

This value is written into the method attribute of the EXT-X-KEY metadata tag in the output playlist.

" + }, + "Key":{ + "shape":"Base64EncodedString", + "documentation":"

If you want Elastic Transcoder to generate a key for you, leave this field blank.

If you choose to supply your own key, you must encrypt the key by using AWS KMS. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

" + }, + "KeyMd5":{ + "shape":"Base64EncodedString", + "documentation":"

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The MD5 digest of the key that you want Elastic Transcoder to use to encrypt your output file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64- encoded.

" + }, + "InitializationVector":{ + "shape":"ZeroTo255String", + "documentation":"

If Elastic Transcoder is generating your key for you, you must leave this field blank.

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your output files. The initialization vector must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

" + }, + "LicenseAcquisitionUrl":{ + "shape":"ZeroTo512String", + "documentation":"

The location of the license key required to decrypt your HLS playlist. The URL must be an absolute path, and is referenced in the URI attribute of the EXT-X-KEY metadata tag in the playlist file.

" + }, + "KeyStoragePolicy":{ + "shape":"KeyStoragePolicy", + "documentation":"

Specify whether you want Elastic Transcoder to write your HLS license key to an Amazon S3 bucket. If you choose WithVariantPlaylists, LicenseAcquisitionUrl must be left blank and Elastic Transcoder writes your data key into the same bucket as the associated playlist.

" + } + }, + "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to your output files.

" + }, + "HlsContentProtectionMethod":{ + "type":"string", + "pattern":"(^aes-128$)" + }, + "HorizontalAlign":{ + "type":"string", + "pattern":"(^Left$)|(^Right$)|(^Center$)" + }, + "Id":{ + "type":"string", + "pattern":"^\\d{13}-\\w{6}$" + }, + "IncompatibleVersionException":{ + "type":"structure", + "members":{ + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "InputCaptions":{ + "type":"structure", + "members":{ + "MergePolicy":{ + "shape":"CaptionMergePolicy", + "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple captions.

  • MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the sidecar captions and ignores the embedded captions for that language.

  • MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output files.

  • Override: Elastic Transcoder transcodes only the sidecar captions that you specify in CaptionSources.

MergePolicy cannot be null.

" + }, + "CaptionSources":{ + "shape":"CaptionSources", + "documentation":"

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

" + } + }, + "documentation":"

The captions to be created, if any.

" + }, + "Interlaced":{ + "type":"string", + "pattern":"(^auto$)|(^true$)|(^false$)" + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Elastic Transcoder encountered an unexpected exception while trying to fulfill the request.

", + "exception":true, + "fault":true + }, + "Job":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier that Elastic Transcoder assigned to the job. You use this value to get settings for the job or to delete the job.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the job.

" + }, + "PipelineId":{ + "shape":"Id", + "documentation":"

The Id of the pipeline that you want Elastic Transcoder to use for transcoding. The pipeline determines several settings, including the Amazon S3 bucket from which Elastic Transcoder gets the files to transcode and the bucket into which Elastic Transcoder puts the transcoded files.

" + }, + "Input":{ + "shape":"JobInput", + "documentation":"

A section of the request or response body that provides information about the file that is being transcoded.

" + }, + "Inputs":{ + "shape":"JobInputs", + "documentation":"

Information about the files that you're transcoding. If you specified multiple files for this job, Elastic Transcoder stitches the files together to make one output.

" + }, + "Output":{ + "shape":"JobOutput", + "documentation":"

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

Outputs recommended instead.

A section of the request or response body that provides information about the transcoded (target) file.

" + }, + "Outputs":{ + "shape":"JobOutputs", + "documentation":"

Information about the output files. We recommend that you use the Outputs syntax for all jobs, even when you want Elastic Transcoder to transcode a file into only one format. Do not use both the Outputs and Output syntaxes in the same request. You can create a maximum of 30 outputs per job.

If you specify more than one output for a job, Elastic Transcoder creates the files for each output in the order in which you specify them in the job.

" + }, + "OutputKeyPrefix":{ + "shape":"Key", + "documentation":"

The value, if any, that you want Elastic Transcoder to prepend to the names of all files that this job creates, including output files, thumbnails, and playlists. We recommend that you add a / or some other delimiter to the end of the OutputKeyPrefix.

" + }, + "Playlists":{ + "shape":"Playlists", + "documentation":"

Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create.

The maximum number of master playlists in a job is 30.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of the job: Submitted, Progressing, Complete, Canceled, or Error.

" + }, + "UserMetadata":{ + "shape":"UserMetadata", + "documentation":"

User-defined metadata that you want to associate with an Elastic Transcoder job. You specify metadata in key/value pairs, and you can add up to 10 key/value pairs per job. Elastic Transcoder does not guarantee that key/value pairs are returned in the same order in which you specify them.

Metadata keys and values must use characters from the following list:

  • 0-9

  • A-Z and a-z

  • Space

  • The following symbols: _.:/=+-%@

" + }, + "Timing":{ + "shape":"Timing", + "documentation":"

Details about the timing of a job.

" + } + }, + "documentation":"

A section of the response body that provides information about the job that is created.

" + }, + "JobAlbumArt":{ + "type":"structure", + "members":{ + "MergePolicy":{ + "shape":"MergePolicy", + "documentation":"

A policy that determines how Elastic Transcoder handles the existence of multiple album artwork files.

  • Replace: The specified album art replaces any existing album art.

  • Prepend: The specified album art is placed in front of any existing album art.

  • Append: The specified album art is placed after any existing album art.

  • Fallback: If the original input file contains artwork, Elastic Transcoder uses that artwork for the output. If the original input does not contain artwork, Elastic Transcoder uses the specified album art file.

" + }, + "Artwork":{ + "shape":"Artworks", + "documentation":"

The file to be used as album art. There can be multiple artworks associated with an audio file, to a maximum of 20. Valid formats are .jpg and .png

" + } + }, + "documentation":"

The .jpg or .png file associated with an audio file.

" + }, + "JobContainer":{ + "type":"string", + "pattern":"(^auto$)|(^3gp$)|(^asf$)|(^avi$)|(^divx$)|(^flv$)|(^mkv$)|(^mov$)|(^mp4$)|(^mpeg$)|(^mpeg-ps$)|(^mpeg-ts$)|(^mxf$)|(^ogg$)|(^ts$)|(^vob$)|(^wav$)|(^webm$)|(^mp3$)|(^m4a$)|(^aac$)" + }, + "JobInput":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"LongKey", + "documentation":"

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + }, + "FrameRate":{ + "shape":"FrameRate", + "documentation":"

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

" + }, + "Resolution":{ + "shape":"Resolution", + "documentation":"

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

" + }, + "Interlaced":{ + "shape":"Interlaced", + "documentation":"

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

" + }, + "Container":{ + "shape":"JobContainer", + "documentation":"

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

" + }, + "TimeSpan":{ + "shape":"TimeSpan", + "documentation":"

Settings for clipping an input. Each input can have different clip settings.

" + }, + "InputCaptions":{ + "shape":"InputCaptions", + "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + }, + "DetectedProperties":{ + "shape":"DetectedProperties", + "documentation":"

The detected properties of the input file.

" + } + }, + "documentation":"

Information about the file that you're transcoding.

" + }, + "JobInputs":{ + "type":"list", + "member":{"shape":"JobInput"}, + "max":200 + }, + "JobOutput":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

A sequential counter, starting with 1, that identifies an output among the outputs from the current job. In the Output syntax, this value is always 1.

" + }, + "Key":{ + "shape":"Key", + "documentation":"

The name to assign to the transcoded file. Elastic Transcoder saves the file in the Amazon S3 bucket specified by the OutputBucket object in the pipeline that is specified by the pipeline ID.

" + }, + "ThumbnailPattern":{ + "shape":"ThumbnailPattern", + "documentation":"

Whether you want Elastic Transcoder to create thumbnails for your videos and, if so, how you want Elastic Transcoder to name the files.

If you don't want Elastic Transcoder to create thumbnails, specify \"\".

If you do want Elastic Transcoder to create thumbnails, specify the information that you want to include in the file name for each thumbnail. You can specify the following values in any sequence:

  • {count} (Required): If you want to create thumbnails, you must include {count} in the ThumbnailPattern object. Wherever you specify {count}, Elastic Transcoder adds a five-digit sequence number (beginning with 00001) to thumbnail file names. The number indicates where a given thumbnail appears in the sequence of thumbnails for a transcoded file.

    If you specify a literal value and/or {resolution} but you omit {count}, Elastic Transcoder returns a validation error and does not create the job.

  • Literal values (Optional): You can specify literal values anywhere in the ThumbnailPattern object. For example, you can include them as a file name prefix or as a delimiter between {resolution} and {count}.

  • {resolution} (Optional): If you want Elastic Transcoder to include the resolution in the file name, include {resolution} in the ThumbnailPattern object.

When creating thumbnails, Elastic Transcoder automatically saves the files in the format (.jpg or .png) that appears in the preset that you specified in the PresetID value of CreateJobOutput. Elastic Transcoder also appends the applicable file name extension.

" + }, + "ThumbnailEncryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

" + }, + "Rotate":{ + "shape":"Rotate", + "documentation":"

The number of degrees clockwise by which you want Elastic Transcoder to rotate the output relative to the input. Enter one of the following values:

auto, 0, 90, 180, 270

The value auto generally works only if the file that you're transcoding contains rotation metadata.

" + }, + "PresetId":{ + "shape":"Id", + "documentation":"

The value of the Id object for the preset that you want to use for this job. The preset determines the audio, video, and thumbnail settings that Elastic Transcoder uses for transcoding. To use a preset that you created, specify the preset ID that Elastic Transcoder returned in the response when you created the preset. You can also use the Elastic Transcoder system presets, which you can get with ListPresets.

" + }, + "SegmentDuration":{ + "shape":"FloatString", + "documentation":"

(Outputs in Fragmented MP4 or MPEG-TS format only.

If you specify a preset in PresetId for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), SegmentDuration is the target maximum duration of each segment in seconds. For HLSv3 format playlists, each media segment is stored in a separate .ts file. For HLSv4, MPEG-DASH, and Smooth playlists, all media segments for an output are stored in a single file. Each segment is approximately the length of the SegmentDuration, though individual segments might be shorter or longer.

The range of valid values is 1 to 60 seconds. If the duration of the video is not evenly divisible by SegmentDuration, the duration of the last segment is the remainder of total length/SegmentDuration.

Elastic Transcoder creates an output-specific playlist for each output HLS output that you specify in OutputKeys. To add an output to the master playlist for this job, include it in the OutputKeys of the associated playlist.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of one output in a job. If you specified only one output for the job, Outputs:Status is always the same as Job:Status. If you specified more than one output:

  • Job:Status and Outputs:Status for all of the outputs is Submitted until Elastic Transcoder starts to process the first output.

  • When Elastic Transcoder starts to process the first output, Outputs:Status for that output and Job:Status both change to Progressing. For each output, the value of Outputs:Status remains Submitted until Elastic Transcoder starts to process the output.

  • Job:Status remains Progressing until all of the outputs reach a terminal status, either Complete or Error.

  • When all of the outputs reach a terminal status, Job:Status changes to Complete only if Outputs:Status for all of the outputs is Complete. If Outputs:Status for one or more outputs is Error, the terminal status for Job:Status is also Error.

The value of Status is one of the following: Submitted, Progressing, Complete, Canceled, or Error.

" + }, + "StatusDetail":{ + "shape":"Description", + "documentation":"

Information that further explains Status.

" + }, + "Duration":{ + "shape":"NullableLong", + "documentation":"

Duration of the output file, in seconds.

" + }, + "Width":{ + "shape":"NullableInteger", + "documentation":"

Specifies the width of the output file in pixels.

" + }, + "Height":{ + "shape":"NullableInteger", + "documentation":"

Height of the output file, in pixels.

" + }, + "FrameRate":{ + "shape":"FloatString", + "documentation":"

Frame rate of the output file, in frames per second.

" + }, + "FileSize":{ + "shape":"NullableLong", + "documentation":"

File size of the output file, in bytes.

" + }, + "DurationMillis":{ + "shape":"NullableLong", + "documentation":"

Duration of the output file, in milliseconds.

" + }, + "Watermarks":{ + "shape":"JobWatermarks", + "documentation":"

Information about the watermarks that you want Elastic Transcoder to add to the video during transcoding. You can specify up to four watermarks for each output. Settings for each watermark must be defined in the preset that you specify in Preset for the current output.

Watermarks are added to the output video in the sequence in which you list them in the job output—the first watermark in the list is added to the output video first, the second watermark in the list is added next, and so on. As a result, if the settings in a preset cause Elastic Transcoder to place all watermarks in the same location, the second watermark that you add covers the first one, the third one covers the second, and the fourth one covers the third.

" + }, + "AlbumArt":{ + "shape":"JobAlbumArt", + "documentation":"

The album art to be associated with the output file, if any.

" + }, + "Composition":{ + "shape":"Composition", + "documentation":"

You can create an output file that contains an excerpt from the input file. This excerpt, called a clip, can come from the beginning, middle, or end of the file. The Composition object contains settings for the clips that make up an output file. For the current release, you can only specify settings for a single clip per output file. The Composition object cannot be null.

", + "deprecated":true + }, + "Captions":{ + "shape":"Captions", + "documentation":"

You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

  • Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.

    Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text

    Valid outputs include: mov-text

    Elastic Transcoder supports a maximum of one embedded format per output.

  • Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.

    Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt

    Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your output files. If you choose to use encryption, you must specify a mode to use. If you choose not to use encryption, Elastic Transcoder writes an unencrypted file to your Amazon S3 bucket.

" + }, + "AppliedColorSpaceConversion":{ + "shape":"String", + "documentation":"

If Elastic Transcoder used a preset with a ColorSpaceConversionMode to transcode the output file, the AppliedColorSpaceConversion parameter shows the conversion used. If no ColorSpaceConversionMode was defined in the preset, this parameter is not be included in the job response.

" + } + }, + "documentation":"

Outputs recommended instead.

If you specified one output for a job, information about that output. If you specified multiple outputs for a job, the Output object lists information about the first output. This duplicates the information that is listed for the first output in the Outputs object.

" + }, + "JobOutputs":{ + "type":"list", + "member":{"shape":"JobOutput"} + }, + "JobStatus":{ + "type":"string", + "pattern":"(^Submitted$)|(^Progressing$)|(^Complete$)|(^Canceled$)|(^Error$)" + }, + "JobWatermark":{ + "type":"structure", + "members":{ + "PresetWatermarkId":{ + "shape":"PresetWatermarkId", + "documentation":"

The ID of the watermark settings that Elastic Transcoder uses to add watermarks to the video during transcoding. The settings are in the preset specified by Preset for the current output. In that preset, the value of Watermarks Id tells Elastic Transcoder which settings to use.

" + }, + "InputKey":{ + "shape":"WatermarkKey", + "documentation":"

The name of the .png or .jpg file that you want to use for the watermark. To determine which Amazon S3 bucket contains the specified file, Elastic Transcoder checks the pipeline specified by Pipeline; the Input Bucket object in that pipeline identifies the bucket.

If the file name includes a prefix, for example, logos/128x64.png, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

" + } + }, + "documentation":"

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

" + }, + "JobWatermarks":{ + "type":"list", + "member":{"shape":"JobWatermark"} + }, + "Jobs":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JpgOrPng":{ + "type":"string", + "pattern":"(^jpg$)|(^png$)" + }, + "Key":{ + "type":"string", + "max":255, + "min":1 + }, + "KeyArn":{ + "type":"string", + "max":255, + "min":0 + }, + "KeyIdGuid":{ + "type":"string", + "pattern":"(^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$)|(^[0-9A-Fa-f]{32}$)" + }, + "KeyStoragePolicy":{ + "type":"string", + "pattern":"(^NoStore$)|(^WithVariantPlaylists$)" + }, + "KeyframesMaxDist":{ + "type":"string", + "pattern":"^\\d{1,6}$" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Too many operations for a given AWS account. For example, the number of pipelines exceeds the maximum allowed.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListJobsByPipelineRequest":{ + "type":"structure", + "required":["PipelineId"], + "members":{ + "PipelineId":{ + "shape":"Id", + "documentation":"

The ID of the pipeline for which you want to get job information.

", + "location":"uri", + "locationName":"PipelineId" + }, + "Ascending":{ + "shape":"Ascending", + "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

", + "location":"querystring", + "locationName":"Ascending" + }, + "PageToken":{ + "shape":"Id", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", + "location":"querystring", + "locationName":"PageToken" + } + }, + "documentation":"

The ListJobsByPipelineRequest structure.

" + }, + "ListJobsByPipelineResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"Jobs", + "documentation":"

An array of Job objects that are in the specified pipeline.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListJobsByPipelineResponse structure.

" + }, + "ListJobsByStatusRequest":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"JobStatus", + "documentation":"

To get information about all of the jobs associated with the current AWS account that have a given status, specify the following status: Submitted, Progressing, Complete, Canceled, or Error.

", + "location":"uri", + "locationName":"Status" + }, + "Ascending":{ + "shape":"Ascending", + "documentation":"

To list jobs in chronological order by the date and time that they were submitted, enter true. To list jobs in reverse chronological order, enter false.

", + "location":"querystring", + "locationName":"Ascending" + }, + "PageToken":{ + "shape":"Id", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", + "location":"querystring", + "locationName":"PageToken" + } + }, + "documentation":"

The ListJobsByStatusRequest structure.

" + }, + "ListJobsByStatusResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"Jobs", + "documentation":"

An array of Job objects that have the specified status.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the jobs in the specified pipeline fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListJobsByStatusResponse structure.

" + }, + "ListPipelinesRequest":{ + "type":"structure", + "members":{ + "Ascending":{ + "shape":"Ascending", + "documentation":"

To list pipelines in chronological order by the date and time that they were created, enter true. To list pipelines in reverse chronological order, enter false.

", + "location":"querystring", + "locationName":"Ascending" + }, + "PageToken":{ + "shape":"Id", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", + "location":"querystring", + "locationName":"PageToken" + } + }, + "documentation":"

The ListPipelineRequest structure.

" + }, + "ListPipelinesResponse":{ + "type":"structure", + "members":{ + "Pipelines":{ + "shape":"Pipelines", + "documentation":"

An array of Pipeline objects.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the pipelines fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

A list of the pipelines associated with the current AWS account.

" + }, + "ListPresetsRequest":{ + "type":"structure", + "members":{ + "Ascending":{ + "shape":"Ascending", + "documentation":"

To list presets in chronological order by the date and time that they were created, enter true. To list presets in reverse chronological order, enter false.

", + "location":"querystring", + "locationName":"Ascending" + }, + "PageToken":{ + "shape":"Id", + "documentation":"

When Elastic Transcoder returns more than one page of results, use pageToken in subsequent GET requests to get each successive page of results.

", + "location":"querystring", + "locationName":"PageToken" + } + }, + "documentation":"

The ListPresetsRequest structure.

" + }, + "ListPresetsResponse":{ + "type":"structure", + "members":{ + "Presets":{ + "shape":"Presets", + "documentation":"

An array of Preset objects.

" + }, + "NextPageToken":{ + "shape":"Id", + "documentation":"

A value that you use to access the second and subsequent pages of results, if any. When the presets fit on one page or when you've reached the last page of results, the value of NextPageToken is null.

" + } + }, + "documentation":"

The ListPresetsResponse structure.

" + }, + "LongKey":{ + "type":"string", + "max":1024, + "min":1 + }, + "MaxFrameRate":{ + "type":"string", + "pattern":"(^10$)|(^15$)|(^23.97$)|(^24$)|(^25$)|(^29.97$)|(^30$)|(^50$)|(^60$)" + }, + "MergePolicy":{ + "type":"string", + "pattern":"(^Replace$)|(^Prepend$)|(^Append$)|(^Fallback$)" + }, + "Name":{ + "type":"string", + "max":40, + "min":1 + }, + "NonEmptyBase64EncodedString":{ + "type":"string", + "pattern":"(^(?:[A-Za-z0-9\\+/]{4})*(?:[A-Za-z0-9\\+/]{2}==|[A-Za-z0-9\\+/]{3}=)?$)" + }, + "Notifications":{ + "type":"structure", + "members":{ + "Progressing":{ + "shape":"SnsTopic", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

" + }, + "Completed":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

" + }, + "Warning":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

" + }, + "Error":{ + "shape":"SnsTopic", + "documentation":"

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

" + } + }, + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic or topics to notify in order to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

" + }, + "NullableInteger":{"type":"integer"}, + "NullableLong":{"type":"long"}, + "OneTo512String":{ + "type":"string", + "max":512, + "min":1 + }, + "Opacity":{ + "type":"string", + "pattern":"^\\d{1,3}(\\.\\d{0,20})?$" + }, + "OutputKeys":{ + "type":"list", + "member":{"shape":"Key"}, + "max":30 + }, + "PaddingPolicy":{ + "type":"string", + "pattern":"(^Pad$)|(^NoPad$)" + }, + "Permission":{ + "type":"structure", + "members":{ + "GranteeType":{ + "shape":"GranteeType", + "documentation":"

The type of value that appears in the Grantee object:

  • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

    A canonical user ID is not the same as an AWS account number.

  • Email: The registered email address of an AWS account.

  • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

" + }, + "Grantee":{ + "shape":"Grantee", + "documentation":"

The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

" + }, + "Access":{ + "shape":"AccessControls", + "documentation":"

The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

  • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

" + } + }, + "documentation":"

The Permission structure.

" + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"}, + "max":30 + }, + "Pipeline":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier for the pipeline. You use this value to identify the pipeline in which you want to perform a variety of operations, such as creating a job or a preset.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the pipeline.

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

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" + }, + "Status":{ + "shape":"PipelineStatus", + "documentation":"

The current status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket from which Elastic Transcoder gets media files for transcoding and the graphics files, if any, that you want to use for watermarks.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files, thumbnails, and playlists. Either you specify this value, or you specify both ContentConfig and ThumbnailConfig.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder uses to transcode jobs for this pipeline.

" + }, + "AwsKmsKeyArn":{ + "shape":"KeyArn", + "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing (optional): The Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process the job.

  • Complete (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

  • Warning (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

  • Error (optional): The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

" + }, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to transcoded files and playlists.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

Information about the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files. Either you specify both ContentConfig and ThumbnailConfig, or you specify OutputBucket.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions: A list of the users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access that you want them to have.

    • GranteeType: The type of value that appears in the Grantee object:

      • Canonical: Either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

        A canonical user ID is not the same as an AWS account number.

      • Email: The registered email address of an AWS account.

      • Group: One of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

    • Grantee: The AWS user or group that you want to have access to thumbnail files.

    • Access: The permission that you want to give to the AWS user that is listed in Grantee. Valid values include:

      • READ: The grantee can read the thumbnails and metadata for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

      • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" + } + }, + "documentation":"

The pipeline (queue) that is used to manage jobs.

" + }, + "PipelineOutputConfig":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you want Elastic Transcoder to save the transcoded files. Specify this value when all of the following are true:

  • You want to save transcoded files, thumbnails (if any), and playlists (if any) together in one bucket.

  • You do not want to specify the users or groups who have access to the transcoded files, thumbnails, and playlists.

  • You do not want to specify the permissions that Elastic Transcoder grants to the files.

  • You want to associate the transcoded files and thumbnails with the Amazon S3 Standard storage class.

If you want to save transcoded files and playlists in one bucket and thumbnails in another bucket, specify which users can access the transcoded files or the permissions the users have, or change the Amazon S3 storage class, omit OutputBucket and specify values for ContentConfig and ThumbnailConfig instead.

" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" + }, + "Permissions":{ + "shape":"Permissions", + "documentation":"

Optional. The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to transcoded files and playlists, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

If you include Permissions, Elastic Transcoder grants only the permissions that you specify. It does not grant full permissions to the owner of the role specified by Role. If you want that user to have full control, you must explicitly grant full control to the user.

If you omit Permissions, Elastic Transcoder grants full control over the transcoded files and playlists to the owner of the role specified by Role, and grants no other permissions to any other user or group.

" + } + }, + "documentation":"

The PipelineOutputConfig structure.

" + }, + "PipelineStatus":{ + "type":"string", + "pattern":"(^Active$)|(^Paused$)" + }, + "Pipelines":{ + "type":"list", + "member":{"shape":"Pipeline"} + }, + "PixelsOrPercent":{ + "type":"string", + "pattern":"(^\\d{1,3}(\\.\\d{0,5})?%$)|(^\\d{1,4}?px$)" + }, + "PlayReadyDrm":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"PlayReadyDrmFormatString", + "documentation":"

The type of DRM, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + }, + "Key":{ + "shape":"NonEmptyBase64EncodedString", + "documentation":"

The DRM key for your file, provided by your DRM license provider. The key must be base64-encoded, and it must be one of the following bit lengths before being base64-encoded:

128, 192, or 256.

The key must also be encrypted by using AWS KMS.

" + }, + "KeyMd5":{ + "shape":"NonEmptyBase64EncodedString", + "documentation":"

The MD5 digest of the key used for DRM on your file, and that you want Elastic Transcoder to use as a checksum to make sure your key was not corrupted in transit. The key MD5 must be base64-encoded, and it must be exactly 16 bytes before being base64-encoded.

" + }, + "KeyId":{ + "shape":"KeyIdGuid", + "documentation":"

The ID for your DRM key, so that your DRM license provider knows which key to provide.

The key ID must be provided in big endian, and Elastic Transcoder converts it to little endian before inserting it into the PlayReady DRM headers. If you are unsure whether your license server provides your key ID in big or little endian, check with your DRM provider.

" + }, + "InitializationVector":{ + "shape":"ZeroTo255String", + "documentation":"

The series of random bits created by a random bit generator, unique for every encryption operation, that you want Elastic Transcoder to use to encrypt your files. The initialization vector must be base64-encoded, and it must be exactly 8 bytes long before being base64-encoded. If no initialization vector is provided, Elastic Transcoder generates one for you.

" + }, + "LicenseAcquisitionUrl":{ + "shape":"OneTo512String", + "documentation":"

The location of the license key required to play DRM content. The URL must be an absolute path, and is referenced by the PlayReady header. The PlayReady header is referenced in the protection header of the client manifest for Smooth Streaming outputs, and in the EXT-X-DXDRM and EXT-XDXDRMINFO metadata tags for HLS playlist outputs. An example URL looks like this: https://www.example.com/exampleKey/

" + } + }, + "documentation":"

The PlayReady DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

PlayReady DRM encrypts your media files using aes-ctr encryption.

If you use DRM for an HLSv3 playlist, your outputs must have a master playlist.

" + }, + "PlayReadyDrmFormatString":{ + "type":"string", + "pattern":"(^microsoft$)|(^discretix-3.0$)" + }, + "Playlist":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Filename", + "documentation":"

The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a / character, the section of the name before the last / must be identical for all Name objects. If you create more than one master playlist, the values of all Name objects must be unique.

Elastic Transcoder automatically appends the relevant file extension to the file name (.m3u8 for HLSv3 and HLSv4 playlists, and .ism and .ismc for Smooth playlists). If you include a file extension in Name, the file name will have two extensions.

" + }, + "Format":{ + "shape":"PlaylistFormat", + "documentation":"

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

" + }, + "OutputKeys":{ + "shape":"OutputKeys", + "documentation":"

For each output in this job that you want to include in a master playlist, the value of the Outputs:Key object.

  • If your output is not HLS or does not have a segment duration set, the name of the output file is a concatenation of OutputKeyPrefix and Outputs:Key:

    OutputKeyPrefixOutputs:Key

  • If your output is HLSv3 and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of .m3u8, and a series of .ts files that include a five-digit sequential counter beginning with 00000:

    OutputKeyPrefixOutputs:Key.m3u8

    OutputKeyPrefixOutputs:Key00000.ts

  • If your output is HLSv4, has a segment duration set, and is included in an HLSv4 playlist, Elastic Transcoder creates an output playlist file with a file extension of _v4.m3u8. If the output is video, Elastic Transcoder also creates an output file with an extension of _iframe.m3u8:

    OutputKeyPrefixOutputs:Key_v4.m3u8

    OutputKeyPrefixOutputs:Key_iframe.m3u8

    OutputKeyPrefixOutputs:Key.ts

Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.

If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For Smooth playlists, the Audio:Profile, Video:Profile, and Video:FrameRate to Video:KeyframesMaxDist ratio must be the same for all outputs.

" + }, + "HlsContentProtection":{ + "shape":"HlsContentProtection", + "documentation":"

The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + }, + "PlayReadyDrm":{ + "shape":"PlayReadyDrm", + "documentation":"

The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.

" + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

The status of the job with which the playlist is associated.

" + }, + "StatusDetail":{ + "shape":"Description", + "documentation":"

Information that further explains the status.

" + } + }, + "documentation":"

Use Only for Fragmented MP4 or MPEG-TS Outputs. If you specify a preset for which the value of Container is fmp4 (Fragmented MP4) or ts (MPEG-TS), Playlists contains information about the master playlists that you want Elastic Transcoder to create. We recommend that you create only one master playlist per output format. The maximum number of master playlists in a job is 30.

" + }, + "PlaylistFormat":{ + "type":"string", + "pattern":"(^HLSv3$)|(^HLSv4$)|(^Smooth$)|(^MPEG-DASH$)" + }, + "Playlists":{ + "type":"list", + "member":{"shape":"Playlist"} + }, + "Preset":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the preset.

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

The name of the preset.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the preset.

" + }, + "Container":{ + "shape":"PresetContainer", + "documentation":"

The container type for the output file. Valid values include flac, flv, fmp4, gif, mp3, mp4, mpg, mxf, oga, ogg, ts, and webm.

" + }, + "Audio":{ + "shape":"AudioParameters", + "documentation":"

A section of the response body that provides information about the audio preset values.

" + }, + "Video":{ + "shape":"VideoParameters", + "documentation":"

A section of the response body that provides information about the video preset values.

" + }, + "Thumbnails":{ + "shape":"Thumbnails", + "documentation":"

A section of the response body that provides information about the thumbnail preset values, if any.

" + }, + "Type":{ + "shape":"PresetType", + "documentation":"

Whether the preset is a default preset provided by Elastic Transcoder (System) or a preset that you have defined (Custom).

" + } + }, + "documentation":"

Presets are templates that contain most of the settings for transcoding media files from one format to another. Elastic Transcoder includes some default presets for common formats, for example, several iPod and iPhone versions. You can also create your own presets for formats that aren't included among the default presets. You specify which preset you want to use when you create a job.

" + }, + "PresetContainer":{ + "type":"string", + "pattern":"(^mp4$)|(^ts$)|(^webm$)|(^mp3$)|(^flac$)|(^oga$)|(^ogg$)|(^fmp4$)|(^mpg$)|(^flv$)|(^gif$)|(^mxf$)|(^wav$)|(^mp2$)" + }, + "PresetType":{ + "type":"string", + "pattern":"(^System$)|(^Custom$)" + }, + "PresetWatermark":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"PresetWatermarkId", + "documentation":"

A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long.

" + }, + "MaxWidth":{ + "shape":"PixelsOrPercent", + "documentation":"

The maximum width of the watermark in one of the following formats:

  • number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxWidth.

  • integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

    If you specify the value in pixels, it must be less than or equal to the value of MaxWidth.

" + }, + "MaxHeight":{ + "shape":"PixelsOrPercent", + "documentation":"

The maximum height of the watermark in one of the following formats:

  • number of pixels (px): The minimum value is 16 pixels, and the maximum value is the value of MaxHeight.

  • integer percentage (%): The range of valid values is 0 to 100. Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the calculation.

If you specify the value in pixels, it must be less than or equal to the value of MaxHeight.

" + }, + "SizingPolicy":{ + "shape":"WatermarkSizingPolicy", + "documentation":"

A value that controls scaling of the watermark:

  • Fit: Elastic Transcoder scales the watermark so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Stretch: Elastic Transcoder stretches the watermark to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the watermark and the values of MaxWidth and MaxHeight are different, the watermark will be distorted.

  • ShrinkToFit: Elastic Transcoder scales the watermark down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the watermark up.

" + }, + "HorizontalAlign":{ + "shape":"HorizontalAlign", + "documentation":"

The horizontal position of the watermark unless you specify a non-zero value for HorizontalOffset:

  • Left: The left edge of the watermark is aligned with the left border of the video.

  • Right: The right edge of the watermark is aligned with the right border of the video.

  • Center: The watermark is centered between the left and right borders.

" + }, + "HorizontalOffset":{ + "shape":"PixelsOrPercent", + "documentation":"

The amount by which you want the horizontal position of the watermark to be offset from the position specified by HorizontalAlign:

  • number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxWidth.

  • integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Left for HorizontalAlign and 5px for HorizontalOffset, the left side of the watermark appears 5 pixels from the left border of the output video.

HorizontalOffset is only valid when the value of HorizontalAlign is Left or Right. If you specify an offset that causes the watermark to extend beyond the left or right border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" + }, + "VerticalAlign":{ + "shape":"VerticalAlign", + "documentation":"

The vertical position of the watermark unless you specify a non-zero value for VerticalOffset:

  • Top: The top edge of the watermark is aligned with the top border of the video.

  • Bottom: The bottom edge of the watermark is aligned with the bottom border of the video.

  • Center: The watermark is centered between the top and bottom borders.

" + }, + "VerticalOffset":{ + "shape":"PixelsOrPercent", + "documentation":"

VerticalOffset

The amount by which you want the vertical position of the watermark to be offset from the position specified by VerticalAlign:

  • number of pixels (px): The minimum value is 0 pixels, and the maximum value is the value of MaxHeight.

  • integer percentage (%): The range of valid values is 0 to 100.

For example, if you specify Top for VerticalAlign and 5px for VerticalOffset, the top of the watermark appears 5 pixels from the top border of the output video.

VerticalOffset is only valid when the value of VerticalAlign is Top or Bottom.

If you specify an offset that causes the watermark to extend beyond the top or bottom border and Elastic Transcoder has not added black bars, the watermark is cropped. If Elastic Transcoder has added black bars, the watermark extends into the black bars. If the watermark extends beyond the black bars, it is cropped.

Use the value of Target to specify whether you want Elastic Transcoder to include the black bars that are added by Elastic Transcoder, if any, in the offset calculation.

" + }, + "Opacity":{ + "shape":"Opacity", + "documentation":"

A percentage that indicates how much you want a watermark to obscure the video in the location where it appears. Valid values are 0 (the watermark is invisible) to 100 (the watermark completely obscures the video in the specified location). The datatype of Opacity is float.

Elastic Transcoder supports transparent .png graphics. If you use a transparent .png, the transparent portion of the video appears as if you had specified a value of 0 for Opacity. The .jpg file format doesn't support transparency.

" + }, + "Target":{ + "shape":"Target", + "documentation":"

A value that determines how Elastic Transcoder interprets values that you specified for HorizontalOffset, VerticalOffset, MaxWidth, and MaxHeight:

  • Content: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video excluding black bars added by Elastic Transcoder, if any.

  • Frame: HorizontalOffset and VerticalOffset values are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any. In addition, MaxWidth and MaxHeight, if specified as a percentage, are calculated based on the borders of the video including black bars added by Elastic Transcoder, if any.

" + } + }, + "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" + }, + "PresetWatermarkId":{ + "type":"string", + "max":40, + "min":1 + }, + "PresetWatermarks":{ + "type":"list", + "member":{"shape":"PresetWatermark"} + }, + "Presets":{ + "type":"list", + "member":{"shape":"Preset"} + }, + "ReadJobRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the job for which you want to get detailed information.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The ReadJobRequest structure.

" + }, + "ReadJobResponse":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"Job", + "documentation":"

A section of the response body that provides information about the job.

" + } + }, + "documentation":"

The ReadJobResponse structure.

" + }, + "ReadPipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the pipeline to read.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The ReadPipelineRequest structure.

" + }, + "ReadPipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline.

" + }, + "Warnings":{ + "shape":"Warnings", + "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" + } + }, + "documentation":"

The ReadPipelineResponse structure.

" + }, + "ReadPresetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the preset for which you want to get detailed information.

", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

The ReadPresetRequest structure.

" + }, + "ReadPresetResponse":{ + "type":"structure", + "members":{ + "Preset":{ + "shape":"Preset", + "documentation":"

A section of the response body that provides information about the preset.

" + } + }, + "documentation":"

The ReadPresetResponse structure.

" + }, + "Resolution":{ + "type":"string", + "pattern":"(^auto$)|(^\\d{1,5}x\\d{1,5}$)" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource you are attempting to change is in use. For example, you are attempting to delete a pipeline that is currently in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested resource does not exist or is not available. For example, the pipeline to which you're trying to add a job doesn't exist or is still being created.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Role":{ + "type":"string", + "pattern":"^arn:aws:iam::\\w{12}:role/.+$" + }, + "Rotate":{ + "type":"string", + "pattern":"(^auto$)|(^0$)|(^90$)|(^180$)|(^270$)" + }, + "SizingPolicy":{ + "type":"string", + "pattern":"(^Fit$)|(^Fill$)|(^Stretch$)|(^Keep$)|(^ShrinkToFit$)|(^ShrinkToFill$)" + }, + "SnsTopic":{ + "type":"string", + "pattern":"(^$)|(^arn:aws:sns:.*:\\w{12}:.+$)" + }, + "SnsTopics":{ + "type":"list", + "member":{"shape":"SnsTopic"}, + "max":30 + }, + "StorageClass":{ + "type":"string", + "pattern":"(^ReducedRedundancy$)|(^Standard$)" + }, + "String":{"type":"string"}, + "Success":{ + "type":"string", + "pattern":"(^true$)|(^false$)" + }, + "Target":{ + "type":"string", + "pattern":"(^Content$)|(^Frame$)" + }, + "TestRoleRequest":{ + "type":"structure", + "required":[ + "Role", + "InputBucket", + "OutputBucket", + "Topics" + ], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket that contains media files to be transcoded. The action attempts to read from this bucket.

" + }, + "OutputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket that Elastic Transcoder writes transcoded media files to. The action attempts to read from this bucket.

" + }, + "Topics":{ + "shape":"SnsTopics", + "documentation":"

The ARNs of one or more Amazon Simple Notification Service (Amazon SNS) topics that you want the action to send a test notification to.

" + } + }, + "documentation":"

The TestRoleRequest structure.

", + "deprecated":true + }, + "TestRoleResponse":{ + "type":"structure", + "members":{ + "Success":{ + "shape":"Success", + "documentation":"

If the operation is successful, this value is true; otherwise, the value is false.

" + }, + "Messages":{ + "shape":"ExceptionMessages", + "documentation":"

If the Success element contains false, this value is an array of one or more error messages that were generated during the test process.

" + } + }, + "documentation":"

The TestRoleResponse structure.

", + "deprecated":true + }, + "ThumbnailPattern":{ + "type":"string", + "pattern":"(^$)|(^.*\\{count\\}.*$)" + }, + "ThumbnailResolution":{ + "type":"string", + "pattern":"^\\d{1,5}x\\d{1,5}$" + }, + "Thumbnails":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"JpgOrPng", + "documentation":"

The format of thumbnails, if any. Valid values are jpg and png.

You specify whether you want Elastic Transcoder to create thumbnails when you create a job.

" + }, + "Interval":{ + "shape":"Digits", + "documentation":"

The approximate number of seconds between thumbnails. Specify an integer value.

" + }, + "Resolution":{ + "shape":"ThumbnailResolution", + "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of thumbnail files in pixels. Specify a value in the format width x height where both values are even integers. The values cannot exceed the width and height that you specified in the Video:Resolution object.

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

To better control resolution and aspect ratio of thumbnails, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, and PaddingPolicy instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The aspect ratio of thumbnails. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the video in the output file.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 4096.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of thumbnails in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 32 and 3072.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of thumbnails:

  • Fit: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings without exceeding the other value.

  • Fill: Elastic Transcoder scales thumbnails so they match the value that you specified in thumbnail MaxWidth or MaxHeight settings and matches or exceeds the other value. Elastic Transcoder centers the image in thumbnails and then crops in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches thumbnails to match the values that you specified for thumbnail MaxWidth and MaxHeight settings. If the relative proportions of the input video and thumbnails are different, the thumbnails will be distorted.

  • Keep: Elastic Transcoder does not scale thumbnails. If either dimension of the input video exceeds the values that you specified for thumbnail MaxWidth and MaxHeight settings, Elastic Transcoder crops the thumbnails.

  • ShrinkToFit: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of thumbnail MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

  • ShrinkToFill: Elastic Transcoder scales thumbnails down so that their dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale thumbnails up.

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of thumbnails to make the total size of the thumbnails match the values that you specified for thumbnail MaxWidth and MaxHeight settings.

" + } + }, + "documentation":"

Thumbnails for videos.

" + }, + "Time":{ + "type":"string", + "pattern":"(^\\d{1,5}(\\.\\d{0,3})?$)|(^([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" + }, + "TimeOffset":{ + "type":"string", + "pattern":"(^[+-]?\\d{1,5}(\\.\\d{0,3})?$)|(^[+-]?([0-1]?[0-9]:|2[0-3]:)?([0-5]?[0-9]:)?[0-5]?[0-9](\\.\\d{0,3})?$)" + }, + "TimeSpan":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Time", + "documentation":"

The place in the input file where you want a clip to start. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder starts at the beginning of the input file.

" + }, + "Duration":{ + "shape":"Time", + "documentation":"

The duration of the clip. The format can be either HH:mm:ss.SSS (maximum value: 23:59:59.999; SSS is thousandths of a second) or sssss.SSS (maximum value: 86399.999). If you don't specify a value, Elastic Transcoder creates an output file from StartTime to the end of the file.

If you specify a value longer than the duration of the input file, Elastic Transcoder transcodes the file and returns a warning message.

" + } + }, + "documentation":"

Settings that determine when a clip begins and how long it lasts.

" + }, + "Timing":{ + "type":"structure", + "members":{ + "SubmitTimeMillis":{ + "shape":"NullableLong", + "documentation":"

The time the job was submitted to Elastic Transcoder, in epoch milliseconds.

" + }, + "StartTimeMillis":{ + "shape":"NullableLong", + "documentation":"

The time the job began transcoding, in epoch milliseconds.

" + }, + "FinishTimeMillis":{ + "shape":"NullableLong", + "documentation":"

The time the job finished transcoding, in epoch milliseconds.

" + } + }, + "documentation":"

Details about the timing of a job.

" + }, + "UpdatePipelineNotificationsRequest":{ + "type":"structure", + "required":[ + "Id", + "Notifications" + ], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the pipeline for which you want to change notification settings.

", + "location":"uri", + "locationName":"Id" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

" + } + }, + "documentation":"

The UpdatePipelineNotificationsRequest structure.

" + }, + "UpdatePipelineNotificationsResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline associated with this notification.

" + } + }, + "documentation":"

The UpdatePipelineNotificationsResponse structure.

" + }, + "UpdatePipelineRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The ID of the pipeline that you want to update.

", + "location":"uri", + "locationName":"Id" + }, + "Name":{ + "shape":"Name", + "documentation":"

The name of the pipeline. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

Constraints: Maximum 40 characters

" + }, + "InputBucket":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket in which you saved the media files that you want to transcode and the graphics that you want to use as watermarks.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to use to transcode jobs for this pipeline.

" + }, + "AwsKmsKeyArn":{ + "shape":"KeyArn", + "documentation":"

The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline.

If you use either s3 or s3-aws-kms as your Encryption:Mode, you don't need to provide a key with your job because a default key, known as an AWS-KMS key, is created for you automatically. You need to provide an AWS-KMS key only if you want to use a non-default AWS-KMS key, or if you are using an Encryption:Mode of aes-cbc-pkcs7, aes-ctr, or aes-gcm.

" + }, + "Notifications":{ + "shape":"Notifications", + "documentation":"

The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify to report job status.

To receive notifications, you must also subscribe to the new topic in the Amazon SNS console.

  • Progressing: The topic ARN for the Amazon Simple Notification Service (Amazon SNS) topic that you want to notify when Elastic Transcoder has started to process jobs that are added to this pipeline. This is the ARN that Amazon SNS returned when you created the topic.

  • Complete: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing a job. This is the ARN that Amazon SNS returned when you created the topic.

  • Warning: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition. This is the ARN that Amazon SNS returned when you created the topic.

  • Error: The topic ARN for the Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition. This is the ARN that Amazon SNS returned when you created the topic.

" + }, + "ContentConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The optional ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists: which bucket to use, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists.

  • Permissions (Optional): The Permissions object specifies which users you want to have access to transcoded files and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • Grantee Type: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution. For more information about canonical user IDs, see Access Control List (ACL) Overview in the Amazon Simple Storage Service Developer Guide. For more information about using CloudFront origin access identities to require that users use CloudFront URLs instead of Amazon S3 URLs, see Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to transcoded files and playlists. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the files that Elastic Transcoder adds to the bucket, including playlists and video files. Valid values include:

    • READ: The grantee can read the objects and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the objects that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the video files and playlists that it stores in your Amazon S3 bucket.

" + }, + "ThumbnailConfig":{ + "shape":"PipelineOutputConfig", + "documentation":"

The ThumbnailConfig object specifies several values, including the Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files, which users you want to have access to the files, the type of access you want users to have, and the storage class that you want to assign to the files.

If you specify values for ContentConfig, you must also specify values for ThumbnailConfig even if you don't want to create thumbnails.

If you specify values for ContentConfig and ThumbnailConfig, omit the OutputBucket object.

  • Bucket: The Amazon S3 bucket in which you want Elastic Transcoder to save thumbnail files.

  • Permissions (Optional): The Permissions object specifies which users and/or predefined Amazon S3 groups you want to have access to thumbnail files, and the type of access you want them to have. You can grant permissions to a maximum of 30 users and/or predefined Amazon S3 groups.

  • GranteeType: Specify the type of value that appears in the Grantee object:

    • Canonical: The value in the Grantee object is either the canonical user ID for an AWS account or an origin access identity for an Amazon CloudFront distribution.

      A canonical user ID is not the same as an AWS account number.

    • Email: The value in the Grantee object is the registered email address of an AWS account.

    • Group: The value in the Grantee object is one of the following predefined Amazon S3 groups: AllUsers, AuthenticatedUsers, or LogDelivery.

  • Grantee: The AWS user or group that you want to have access to thumbnail files. To identify the user or group, you can specify the canonical user ID for an AWS account, an origin access identity for a CloudFront distribution, the registered email address of an AWS account, or a predefined Amazon S3 group.

  • Access: The permission that you want to give to the AWS user that you specified in Grantee. Permissions are granted on the thumbnail files that Elastic Transcoder adds to the bucket. Valid values include:

    • READ: The grantee can read the thumbnails and metadata for objects that Elastic Transcoder adds to the Amazon S3 bucket.

    • READ_ACP: The grantee can read the object ACL for thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • WRITE_ACP: The grantee can write the ACL for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

    • FULL_CONTROL: The grantee has READ, READ_ACP, and WRITE_ACP permissions for the thumbnails that Elastic Transcoder adds to the Amazon S3 bucket.

  • StorageClass: The Amazon S3 storage class, Standard or ReducedRedundancy, that you want Elastic Transcoder to assign to the thumbnails that it stores in your Amazon S3 bucket.

" + } + }, + "documentation":"

The UpdatePipelineRequest structure.

" + }, + "UpdatePipelineResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

The pipeline updated by this UpdatePipelineResponse call.

" + }, + "Warnings":{ + "shape":"Warnings", + "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" + } + }, + "documentation":"

When you update a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "UpdatePipelineStatusRequest":{ + "type":"structure", + "required":[ + "Id", + "Status" + ], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

The identifier of the pipeline to update.

", + "location":"uri", + "locationName":"Id" + }, + "Status":{ + "shape":"PipelineStatus", + "documentation":"

The desired status of the pipeline:

  • Active: The pipeline is processing jobs.

  • Paused: The pipeline is not currently processing jobs.

" + } + }, + "documentation":"

The UpdatePipelineStatusRequest structure.

" + }, + "UpdatePipelineStatusResponse":{ + "type":"structure", + "members":{ + "Pipeline":{ + "shape":"Pipeline", + "documentation":"

A section of the response body that provides information about the pipeline.

" + } + }, + "documentation":"

When you update status for a pipeline, Elastic Transcoder returns the values that you specified in the request.

" + }, + "UserMetadata":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more required parameter values were not provided in the request.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VerticalAlign":{ + "type":"string", + "pattern":"(^Top$)|(^Bottom$)|(^Center$)" + }, + "VideoBitRate":{ + "type":"string", + "pattern":"(^\\d{2,5}$)|(^auto$)" + }, + "VideoCodec":{ + "type":"string", + "pattern":"(^H\\.264$)|(^vp8$)|(^vp9$)|(^mpeg2$)|(^gif$)" + }, + "VideoParameters":{ + "type":"structure", + "members":{ + "Codec":{ + "shape":"VideoCodec", + "documentation":"

The video codec for the output file. Valid values include gif, H.264, mpeg2, vp8, and vp9. You can only specify vp8 and vp9 when the container type is webm, gif when the container type is gif, and mpeg2 when the container type is mpg.

" + }, + "CodecOptions":{ + "shape":"CodecOptions", + "documentation":"

Profile (H.264/VP8/VP9 Only)

The H.264 profile that you want to use for the output file. Elastic Transcoder supports the following profiles:

  • baseline: The profile most commonly used for videoconferencing and for mobile applications.

  • main: The profile used for standard-definition digital TV broadcasts.

  • high: The profile used for high-definition digital TV broadcasts and for Blu-ray discs.

Level (H.264 Only)

The H.264 level that you want to use for the output file. Elastic Transcoder supports the following levels:

1, 1b, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 3, 3.1, 3.2, 4, 4.1

MaxReferenceFrames (H.264 Only)

Applicable only when the value of Video:Codec is H.264. The maximum number of previously decoded frames to use as a reference for decoding future frames. Valid values are integers 0 through 16, but we recommend that you not use a value greater than the following:

Min(Floor(Maximum decoded picture buffer in macroblocks * 256 / (Width in pixels * Height in pixels)), 16)

where Width in pixels and Height in pixels represent either MaxWidth and MaxHeight, or Resolution. Maximum decoded picture buffer in macroblocks depends on the value of the Level object. See the list below. (A macroblock is a block of pixels measuring 16x16.)

  • 1 - 396

  • 1b - 396

  • 1.1 - 900

  • 1.2 - 2376

  • 1.3 - 2376

  • 2 - 2376

  • 2.1 - 4752

  • 2.2 - 8100

  • 3 - 8100

  • 3.1 - 18000

  • 3.2 - 20480

  • 4 - 32768

  • 4.1 - 32768

MaxBitRate (Optional, H.264/MPEG2/VP8/VP9 only)

The maximum number of bits per second in a video buffer; the size of the buffer is specified by BufferSize. Specify a value between 16 and 62,500. You can reduce the bandwidth required to stream a video by reducing the maximum bit rate, but this also reduces the quality of the video.

BufferSize (Optional, H.264/MPEG2/VP8/VP9 only)

The maximum number of bits in any x seconds of the output video. This window is commonly 10 seconds, the standard segment duration when you're using FMP4 or MPEG-TS for the container type of the output video. Specify an integer greater than 0. If you specify MaxBitRate and omit BufferSize, Elastic Transcoder sets BufferSize to 10 times the value of MaxBitRate.

InterlacedMode (Optional, H.264/MPEG2 Only)

The interlace mode for the output video.

Interlaced video is used to double the perceived frame rate for a video by interlacing two fields (one field on every other line, the other field on the other lines) so that the human eye registers multiple pictures per frame. Interlacing reduces the bandwidth required for transmitting a video, but can result in blurred images and flickering.

Valid values include Progressive (no interlacing, top to bottom), TopFirst (top field first), BottomFirst (bottom field first), and Auto.

If InterlaceMode is not specified, Elastic Transcoder uses Progressive for the output. If Auto is specified, Elastic Transcoder interlaces the output.

ColorSpaceConversionMode (Optional, H.264/MPEG2 Only)

The color space conversion Elastic Transcoder applies to the output video. Color spaces are the algorithms used by the computer to store information about how to render color. Bt.601 is the standard for standard definition video, while Bt.709 is the standard for high definition video.

Valid values include None, Bt709toBt601, Bt601toBt709, and Auto.

If you chose Auto for ColorSpaceConversionMode and your output is interlaced, your frame rate is one of 23.97, 24, 25, 29.97, 50, or 60, your SegmentDuration is null, and you are using one of the resolution changes from the list below, Elastic Transcoder applies the following color space conversions:

  • Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709

  • Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder applies Bt601ToBt709

  • HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder applies Bt709ToBt601

  • HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder applies Bt709ToBt601

Elastic Transcoder may change the behavior of the ColorspaceConversionMode Auto mode in the future. All outputs in a playlist must use the same ColorSpaceConversionMode.

If you do not specify a ColorSpaceConversionMode, Elastic Transcoder does not change the color space of a file. If you are unsure what ColorSpaceConversionMode was applied to your output file, you can check the AppliedColorSpaceConversion parameter included in your job response. If your job does not have an AppliedColorSpaceConversion in its response, no ColorSpaceConversionMode was applied.

ChromaSubsampling

The sampling pattern for the chroma (color) channels of the output video. Valid values include yuv420p and yuv422p.

yuv420p samples the chroma information of every other horizontal and every other vertical line, yuv422p samples the color information of every horizontal line and every other vertical line.

LoopCount (Gif Only)

The number of times you want the output gif to loop. Valid values include Infinite and integers between 0 and 100, inclusive.

" + }, + "KeyframesMaxDist":{ + "shape":"KeyframesMaxDist", + "documentation":"

Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8.

The maximum number of frames between key frames. Key frames are fully encoded frames; the frames between key frames are encoded based, in part, on the content of the key frames. The value is an integer formatted as a string; valid values are between 1 (every frame is a key frame) and 100000, inclusive. A higher value results in higher compression but may also discernibly decrease video quality.

For Smooth outputs, the FrameRate must have a constant ratio to the KeyframesMaxDist. This allows Smooth playlists to switch between different quality levels while the file is being played.

For example, an input file can have a FrameRate of 30 with a KeyframesMaxDist of 90. The output file then needs to have a ratio of 1:3. Valid outputs would have FrameRate of 30, 25, and 10, and KeyframesMaxDist of 90, 75, and 30, respectively.

Alternately, this can be achieved by setting FrameRate to auto and having the same values for MaxFrameRate and KeyframesMaxDist.

" + }, + "FixedGOP":{ + "shape":"FixedGOP", + "documentation":"

Applicable only when the value of Video:Codec is one of H.264, MPEG2, or VP8.

Whether to use a fixed value for FixedGOP. Valid values are true and false:

  • true: Elastic Transcoder uses the value of KeyframesMaxDist for the distance between key frames (the number of frames in a group of pictures, or GOP).

  • false: The distance between key frames can vary.

FixedGOP must be set to true for fmp4 containers.

" + }, + "BitRate":{ + "shape":"VideoBitRate", + "documentation":"

The bit rate of the video stream in the output file, in kilobits/second. Valid values depend on the values of Level and Profile. If you specify auto, Elastic Transcoder uses the detected bit rate of the input source. If you specify a value other than auto, we recommend that you specify a value less than or equal to the maximum H.264-compliant value listed for your level and profile:

Level - Maximum video bit rate in kilobits/second (baseline and main Profile) : maximum video bit rate in kilobits/second (high Profile)

  • 1 - 64 : 80

  • 1b - 128 : 160

  • 1.1 - 192 : 240

  • 1.2 - 384 : 480

  • 1.3 - 768 : 960

  • 2 - 2000 : 2500

  • 3 - 10000 : 12500

  • 3.1 - 14000 : 17500

  • 3.2 - 20000 : 25000

  • 4 - 20000 : 25000

  • 4.1 - 50000 : 62500

" + }, + "FrameRate":{ + "shape":"FrameRate", + "documentation":"

The frames per second for the video stream in the output file. Valid values include:

auto, 10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify auto, Elastic Transcoder uses the detected frame rate of the input source. If you specify a frame rate, we recommend that you perform the following calculation:

Frame rate = maximum recommended decoding speed in luma samples/second / (width in pixels * height in pixels)

where:

  • width in pixels and height in pixels represent the Resolution of the output video.

  • maximum recommended decoding speed in Luma samples/second is less than or equal to the maximum value listed in the following table, based on the value that you specified for Level.

The maximum recommended decoding speed in Luma samples/second for each level is described in the following list (Level - Decoding speed):

  • 1 - 380160

  • 1b - 380160

  • 1.1 - 76800

  • 1.2 - 1536000

  • 1.3 - 3041280

  • 2 - 3041280

  • 2.1 - 5068800

  • 2.2 - 5184000

  • 3 - 10368000

  • 3.1 - 27648000

  • 3.2 - 55296000

  • 4 - 62914560

  • 4.1 - 62914560

" + }, + "MaxFrameRate":{ + "shape":"MaxFrameRate", + "documentation":"

If you specify auto for FrameRate, Elastic Transcoder uses the frame rate of the input video for the frame rate of the output video. Specify the maximum frame rate that you want Elastic Transcoder to use when the frame rate of the input video is greater than the desired maximum frame rate of the output video. Valid values include: 10, 15, 23.97, 24, 25, 29.97, 30, 60.

" + }, + "Resolution":{ + "shape":"Resolution", + "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The width and height of the video in the output file, in pixels. Valid values are auto and width x height:

  • auto: Elastic Transcoder attempts to preserve the width and height of the input file, subject to the following rules.

  • width x height : The width and height of the output video in pixels.

Note the following about specifying the width and height:

  • The width must be an even integer between 128 and 4096, inclusive.

  • The height must be an even integer between 96 and 3072, inclusive.

  • If you specify a resolution that is less than the resolution of the input file, Elastic Transcoder rescales the output file to the lower resolution.

  • If you specify a resolution that is greater than the resolution of the input file, Elastic Transcoder rescales the output to the higher resolution.

  • We recommend that you specify a resolution for which the product of width and height is less than or equal to the applicable value in the following list (List - Max width x height value):

    • 1 - 25344

    • 1b - 25344

    • 1.1 - 101376

    • 1.2 - 101376

    • 1.3 - 101376

    • 2 - 101376

    • 2.1 - 202752

    • 2.2 - 404720

    • 3 - 404720

    • 3.1 - 921600

    • 3.2 - 1310720

    • 4 - 2097152

    • 4.1 - 2097152

" + }, + "AspectRatio":{ + "shape":"AspectRatio", + "documentation":"

To better control resolution and aspect ratio of output videos, we recommend that you use the values MaxWidth, MaxHeight, SizingPolicy, PaddingPolicy, and DisplayAspectRatio instead of Resolution and AspectRatio. The two groups of settings are mutually exclusive. Do not use them together.

The display aspect ratio of the video in the output file. Valid values include:

auto, 1:1, 4:3, 3:2, 16:9

If you specify auto, Elastic Transcoder tries to preserve the aspect ratio of the input file.

If you specify an aspect ratio for the output file that differs from aspect ratio of the input file, Elastic Transcoder adds pillarboxing (black bars on the sides) or letterboxing (black bars on the top and bottom) to maintain the aspect ratio of the active region of the video.

" + }, + "MaxWidth":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum width of the output video in pixels. If you specify auto, Elastic Transcoder uses 1920 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 128 and 4096.

" + }, + "MaxHeight":{ + "shape":"DigitsOrAuto", + "documentation":"

The maximum height of the output video in pixels. If you specify auto, Elastic Transcoder uses 1080 (Full HD) as the default value. If you specify a numeric value, enter an even integer between 96 and 3072.

" + }, + "DisplayAspectRatio":{ + "shape":"AspectRatio", + "documentation":"

The value that Elastic Transcoder adds to the metadata in the output file.

" + }, + "SizingPolicy":{ + "shape":"SizingPolicy", + "documentation":"

Specify one of the following values to control scaling of the output video:

  • Fit: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight without exceeding the other value.

  • Fill: Elastic Transcoder scales the output video so it matches the value that you specified in either MaxWidth or MaxHeight and matches or exceeds the other value. Elastic Transcoder centers the output video and then crops it in the dimension (if any) that exceeds the maximum value.

  • Stretch: Elastic Transcoder stretches the output video to match the values that you specified for MaxWidth and MaxHeight. If the relative proportions of the input video and the output video are different, the output video will be distorted.

  • Keep: Elastic Transcoder does not scale the output video. If either dimension of the input video exceeds the values that you specified for MaxWidth and MaxHeight, Elastic Transcoder crops the output video.

  • ShrinkToFit: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without exceeding either value. If you specify this option, Elastic Transcoder does not scale the video up.

  • ShrinkToFill: Elastic Transcoder scales the output video down so that its dimensions match the values that you specified for at least one of MaxWidth and MaxHeight without dropping below either value. If you specify this option, Elastic Transcoder does not scale the video up.

" + }, + "PaddingPolicy":{ + "shape":"PaddingPolicy", + "documentation":"

When you set PaddingPolicy to Pad, Elastic Transcoder may add black bars to the top and bottom and/or left and right sides of the output video to make the total size of the output video match the values that you specified for MaxWidth and MaxHeight.

" + }, + "Watermarks":{ + "shape":"PresetWatermarks", + "documentation":"

Settings for the size, location, and opacity of graphics that you want Elastic Transcoder to overlay over videos that are transcoded using this preset. You can specify settings for up to four watermarks. Watermarks appear in the specified size and location, and with the specified opacity for the duration of the transcoded video.

Watermarks can be in .png or .jpg format. If you want to display a watermark that is not rectangular, use the .png format, which supports transparency.

When you create a job that uses this preset, you specify the .png or .jpg graphics that you want Elastic Transcoder to include in the transcoded videos. You can specify fewer graphics in the job than you specify watermark settings in the preset, which allows you to use the same preset for up to four watermarks that have different dimensions.

" + } + }, + "documentation":"

The VideoParameters structure.

" + }, + "Warning":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

The code of the cross-regional warning.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The message explaining what resources are in a different region from the pipeline.

AWS KMS keys must be in the same region as the pipeline.

" + } + }, + "documentation":"

Elastic Transcoder returns a warning if the resources used by your pipeline are not in the same region as the pipeline.

Using resources in the same region, such as your Amazon S3 buckets, Amazon SNS notification topics, and AWS KMS key, reduces processing time and prevents cross-regional charges.

" + }, + "Warnings":{ + "type":"list", + "member":{"shape":"Warning"} + }, + "WatermarkKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"(^.{1,1020}.jpg$)|(^.{1,1019}.jpeg$)|(^.{1,1020}.png$)" + }, + "WatermarkSizingPolicy":{ + "type":"string", + "pattern":"(^Fit$)|(^Stretch$)|(^ShrinkToFit$)" + }, + "ZeroTo255String":{ + "type":"string", + "max":255, + "min":0 + }, + "ZeroTo512String":{ + "type":"string", + "max":512, + "min":0 + } + }, + "documentation":"AWS Elastic Transcoder Service

The AWS Elastic Transcoder Service.

" +} diff --git a/aws/dist/botocore/data/elastictranscoder/2012-09-25/waiters-2.json b/aws/dist/botocore/data/elastictranscoder/2012-09-25/waiters-2.json new file mode 100644 index 00000000..55c36280 --- /dev/null +++ b/aws/dist/botocore/data/elastictranscoder/2012-09-25/waiters-2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "JobComplete": { + "delay": 30, + "operation": "ReadJob", + "maxAttempts": 120, + "acceptors": [ + { + "expected": "Complete", + "matcher": "path", + "state": "success", + "argument": "Job.Status" + }, + { + "expected": "Canceled", + "matcher": "path", + "state": "failure", + "argument": "Job.Status" + }, + { + "expected": "Error", + "matcher": "path", + "state": "failure", + "argument": "Job.Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/elb/2012-06-01/examples-1.json b/aws/dist/botocore/data/elb/2012-06-01/examples-1.json new file mode 100644 index 00000000..ce50fdd1 --- /dev/null +++ b/aws/dist/botocore/data/elb/2012-06-01/examples-1.json @@ -0,0 +1,1036 @@ +{ + "version": "1.0", + "examples": { + "AddTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ], + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds two tags to the specified load balancer.", + "id": "elb-add-tags-1", + "title": "To add tags to a load balancer" + } + ], + "ApplySecurityGroupsToLoadBalancer": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-fc448899" + ] + }, + "output": { + "SecurityGroups": [ + "sg-fc448899" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates a security group with the specified load balancer in a VPC.", + "id": "elb-apply-security-groups-to-load-balancer-1", + "title": "To associate a security group with a load balancer in a VPC" + } + ], + "AttachLoadBalancerToSubnets": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "Subnets": [ + "subnet-0ecac448" + ] + }, + "output": { + "Subnets": [ + "subnet-15aaab61", + "subnet-0ecac448" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified subnet to the set of configured subnets for the specified load balancer.", + "id": "elb-attach-load-balancer-to-subnets-1", + "title": "To attach subnets to a load balancer" + } + ], + "ConfigureHealthCheck": [ + { + "input": { + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example specifies the health check settings used to evaluate the health of your backend EC2 instances.", + "id": "elb-configure-health-check-1", + "title": "To specify the health check settings for your backend EC2 instances" + } + ], + "CreateAppCookieStickinessPolicy": [ + { + "input": { + "CookieName": "my-app-cookie", + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-app-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example generates a stickiness policy that follows the sticky session lifetimes of the application-generated cookie.", + "id": "elb-create-app-cookie-stickiness-policy-1", + "title": "To generate a stickiness policy for your load balancer" + } + ], + "CreateLBCookieStickinessPolicy": [ + { + "input": { + "CookieExpirationPeriod": 60, + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-duration-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example generates a stickiness policy with sticky session lifetimes controlled by the specified expiration period.", + "id": "elb-create-lb-cookie-stickiness-policy-1", + "title": "To generate a duration-based stickiness policy for your load balancer" + } + ], + "CreateLoadBalancer": [ + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTP listener in a VPC.", + "id": "elb-create-load-balancer-1", + "title": "To create an HTTP load balancer in a VPC" + }, + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTP listener in EC2-Classic.", + "id": "elb-create-load-balancer-2", + "title": "To create an HTTP load balancer in EC2-Classic" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTPS listener in a VPC.", + "id": "elb-create-load-balancer-3", + "title": "To create an HTTPS load balancer in a VPC" + }, + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "DNSName": "my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a load balancer with an HTTPS listener in EC2-Classic.", + "id": "elb-create-load-balancer-4", + "title": "To create an HTTPS load balancer in EC2-Classic" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + "sg-a61988c3" + ], + "Subnets": [ + "subnet-15aaab61" + ] + }, + "output": { + "DNSName": "internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an internal load balancer with an HTTP listener in a VPC.", + "id": "elb-create-load-balancer-5", + "title": "To create an internal load balancer" + } + ], + "CreateLoadBalancerListeners": [ + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a listener for your load balancer at port 80 using the HTTP protocol.", + "id": "elb-create-load-balancer-listeners-1", + "title": "To create an HTTP listener for a load balancer" + }, + { + "input": { + "Listeners": [ + { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a listener for your load balancer at port 443 using the HTTPS protocol.", + "id": "elb-create-load-balancer-listeners-2", + "title": "To create an HTTPS listener for a load balancer" + } + ], + "CreateLoadBalancerPolicy": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "ProxyProtocol", + "AttributeValue": "true" + } + ], + "PolicyName": "my-ProxyProtocol-policy", + "PolicyTypeName": "ProxyProtocolPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a policy that enables Proxy Protocol on the specified load balancer.", + "id": "elb-create-load-balancer-policy-1", + "title": "To create a policy that enables Proxy Protocol on a load balancer" + }, + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "PublicKey", + "AttributeValue": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwAYUjnfyEyXr1pxjhFWBpMlggUcqoi3kl+dS74kj//c6x7ROtusUaeQCTgIUkayttRDWchuqo1pHC1u+n5xxXnBBe2ejbb2WRsKIQ5rXEeixsjFpFsojpSQKkzhVGI6mJVZBJDVKSHmswnwLBdofLhzvllpovBPTHe+o4haAWvDBALJU0pkSI1FecPHcs2hwxf14zHoXy1e2k36A64nXW43wtfx5qcVSIxtCEOjnYRg7RPvybaGfQ+v6Iaxb/+7J5kEvZhTFQId+bSiJImF1FSUT1W1xwzBZPUbcUkkXDj45vC2s3Z8E+Lk7a3uZhvsQHLZnrfuWjBWGWvZ/MhZYgEXAMPLE" + } + ], + "PolicyName": "my-PublicKey-policy", + "PolicyTypeName": "PublicKeyPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a public key policy.", + "id": "elb-create-load-balancer-policy-2", + "title": "To create a public key policy" + }, + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyAttributes": [ + { + "AttributeName": "PublicKeyPolicyName", + "AttributeValue": "my-PublicKey-policy" + } + ], + "PolicyName": "my-authentication-policy", + "PolicyTypeName": "BackendServerAuthenticationPolicyType" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a backend server authentication policy that enables authentication on your backend instance using a public key policy.", + "id": "elb-create-load-balancer-policy-3", + "title": "To create a backend server authentication policy" + } + ], + "DeleteLoadBalancer": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified load balancer.", + "id": "elb-delete-load-balancer-1", + "title": "To delete a load balancer" + } + ], + "DeleteLoadBalancerListeners": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPorts": [ + 80 + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the listener for the specified port from the specified load balancer.", + "id": "elb-delete-load-balancer-listeners-1", + "title": "To delete a listener from your load balancer" + } + ], + "DeleteLoadBalancerPolicy": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyName": "my-duration-cookie-policy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified policy from the specified load balancer. The policy must not be enabled on any listener.", + "id": "elb-delete-load-balancer-policy-1", + "title": "To delete a policy from your load balancer" + } + ], + "DeregisterInstancesFromLoadBalancer": [ + { + "input": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters the specified instance from the specified load balancer.", + "id": "elb-deregister-instances-from-load-balancer-1", + "title": "To deregister instances from a load balancer" + } + ], + "DescribeInstanceHealth": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "InstanceStates": [ + { + "Description": "N/A", + "InstanceId": "i-207d9717", + "ReasonCode": "N/A", + "State": "InService" + }, + { + "Description": "N/A", + "InstanceId": "i-afefb49b", + "ReasonCode": "N/A", + "State": "InService" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the instances for the specified load balancer.", + "id": "elb-describe-instance-health-1", + "title": "To describe the health of the instances for a load balancer" + } + ], + "DescribeLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "AccessLog": { + "Enabled": false + }, + "ConnectionDraining": { + "Enabled": false, + "Timeout": 300 + }, + "ConnectionSettings": { + "IdleTimeout": 60 + }, + "CrossZoneLoadBalancing": { + "Enabled": false + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified load balancer.", + "id": "elb-describe-load-balancer-attributes-1", + "title": "To describe the attributes of a load balancer" + } + ], + "DescribeLoadBalancerPolicies": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "PolicyNames": [ + "my-authentication-policy" + ] + }, + "output": { + "PolicyDescriptions": [ + { + "PolicyAttributeDescriptions": [ + { + "AttributeName": "PublicKeyPolicyName", + "AttributeValue": "my-PublicKey-policy" + } + ], + "PolicyName": "my-authentication-policy", + "PolicyTypeName": "BackendServerAuthenticationPolicyType" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified policy associated with the specified load balancer.", + "id": "elb-describe-load-balancer-policies-1", + "title": "To describe a policy associated with a load balancer" + } + ], + "DescribeLoadBalancerPolicyTypes": [ + { + "input": { + "PolicyTypeNames": [ + "ProxyProtocolPolicyType" + ] + }, + "output": { + "PolicyTypeDescriptions": [ + { + "Description": "Policy that controls whether to include the IP address and port of the originating request for TCP messages. This policy operates on TCP listeners only.", + "PolicyAttributeTypeDescriptions": [ + { + "AttributeName": "ProxyProtocol", + "AttributeType": "Boolean", + "Cardinality": "ONE" + } + ], + "PolicyTypeName": "ProxyProtocolPolicyType" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer policy type.", + "id": "elb-describe-load-balancer-policy-types-1", + "title": "To describe a load balancer policy type defined by Elastic Load Balancing" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "output": { + "LoadBalancerDescriptions": [ + { + "AvailabilityZones": [ + "us-west-2a" + ], + "BackendServerDescriptions": [ + { + "InstancePort": 80, + "PolicyNames": [ + "my-ProxyProtocol-policy" + ] + } + ], + "CanonicalHostedZoneName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "CanonicalHostedZoneNameID": "Z3DZXE0EXAMPLE", + "CreatedTime": "2015-03-19T03:24:02.650Z", + "DNSName": "my-load-balancer-1234567890.us-west-2.elb.amazonaws.com", + "HealthCheck": { + "HealthyThreshold": 2, + "Interval": 30, + "Target": "HTTP:80/png", + "Timeout": 3, + "UnhealthyThreshold": 2 + }, + "Instances": [ + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ], + "ListenerDescriptions": [ + { + "Listener": { + "InstancePort": 80, + "InstanceProtocol": "HTTP", + "LoadBalancerPort": 80, + "Protocol": "HTTP" + }, + "PolicyNames": [ + + ] + }, + { + "Listener": { + "InstancePort": 443, + "InstanceProtocol": "HTTPS", + "LoadBalancerPort": 443, + "Protocol": "HTTPS", + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + }, + "PolicyNames": [ + "ELBSecurityPolicy-2015-03" + ] + } + ], + "LoadBalancerName": "my-load-balancer", + "Policies": { + "AppCookieStickinessPolicies": [ + + ], + "LBCookieStickinessPolicies": [ + { + "CookieExpirationPeriod": 60, + "PolicyName": "my-duration-cookie-policy" + } + ], + "OtherPolicies": [ + "my-PublicKey-policy", + "my-authentication-policy", + "my-SSLNegotiation-policy", + "my-ProxyProtocol-policy", + "ELBSecurityPolicy-2015-03" + ] + }, + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-a61988c3" + ], + "SourceSecurityGroup": { + "GroupName": "my-elb-sg", + "OwnerAlias": "123456789012" + }, + "Subnets": [ + "subnet-15aaab61" + ], + "VPCId": "vpc-a01106c2" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer.", + "id": "elb-describe-load-balancers-1", + "title": "To describe one of your load balancers" + } + ], + "DescribeTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ] + }, + "output": { + "TagDescriptions": [ + { + "LoadBalancerName": "my-load-balancer", + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags for the specified load balancer.", + "id": "elb-describe-tags-1", + "title": "To describe the tags for a load balancer" + } + ], + "DetachLoadBalancerFromSubnets": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "Subnets": [ + "subnet-0ecac448" + ] + }, + "output": { + "Subnets": [ + "subnet-15aaab61" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example detaches the specified load balancer from the specified subnet.", + "id": "elb-detach-load-balancer-from-subnets-1", + "title": "To detach a load balancer from a subnet" + } + ], + "DisableAvailabilityZonesForLoadBalancer": [ + { + "input": { + "AvailabilityZones": [ + "us-west-2a" + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "AvailabilityZones": [ + "us-west-2b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified Availability Zone from the set of Availability Zones for the specified load balancer.", + "id": "elb-disable-availability-zones-for-load-balancer-1", + "title": "To disable an Availability Zone for a load balancer" + } + ], + "EnableAvailabilityZonesForLoadBalancer": [ + { + "input": { + "AvailabilityZones": [ + "us-west-2b" + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "AvailabilityZones": [ + "us-west-2a", + "us-west-2b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified Availability Zone to the specified load balancer.", + "id": "elb-enable-availability-zones-for-load-balancer-1", + "title": "To enable an Availability Zone for a load balancer" + } + ], + "ModifyLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerAttributes": { + "CrossZoneLoadBalancing": { + "Enabled": true + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "CrossZoneLoadBalancing": { + "Enabled": true + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables cross-zone load balancing for the specified load balancer.", + "id": "elb-modify-load-balancer-attributes-1", + "title": "To enable cross-zone load balancing" + }, + { + "input": { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": true, + "Timeout": 300 + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "LoadBalancerAttributes": { + "ConnectionDraining": { + "Enabled": true, + "Timeout": 300 + } + }, + "LoadBalancerName": "my-load-balancer" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables connection draining for the specified load balancer.", + "id": "elb-modify-load-balancer-attributes-2", + "title": "To enable connection draining" + } + ], + "RegisterInstancesWithLoadBalancer": [ + { + "input": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + } + ], + "LoadBalancerName": "my-load-balancer" + }, + "output": { + "Instances": [ + { + "InstanceId": "i-d6f6fae3" + }, + { + "InstanceId": "i-207d9717" + }, + { + "InstanceId": "i-afefb49b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instance with the specified load balancer.", + "id": "elb-register-instances-with-load-balancer-1", + "title": "To register instances with a load balancer" + } + ], + "RemoveTags": [ + { + "input": { + "LoadBalancerNames": [ + "my-load-balancer" + ], + "Tags": [ + { + "Key": "project" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified tag from the specified load balancer.", + "id": "elb-remove-tags-1", + "title": "To remove tags from a load balancer" + } + ], + "SetLoadBalancerListenerSSLCertificate": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPort": 443, + "SSLCertificateId": "arn:aws:iam::123456789012:server-certificate/new-server-cert" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the existing SSL certificate for the specified HTTPS listener.", + "id": "elb-set-load-balancer-listener-ssl-certificate-1", + "title": "To update the SSL certificate for an HTTPS listener" + } + ], + "SetLoadBalancerPoliciesForBackendServer": [ + { + "input": { + "InstancePort": 80, + "LoadBalancerName": "my-load-balancer", + "PolicyNames": [ + "my-ProxyProtocol-policy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the policies that are currently associated with the specified port.", + "id": "elb-set-load-balancer-policies-for-backend-server-1", + "title": "To replace the policies associated with a port for a backend instance" + } + ], + "SetLoadBalancerPoliciesOfListener": [ + { + "input": { + "LoadBalancerName": "my-load-balancer", + "LoadBalancerPort": 80, + "PolicyNames": [ + "my-SSLNegotiation-policy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example replaces the policies that are currently associated with the specified listener.", + "id": "elb-set-load-balancer-policies-of-listener-1", + "title": "To replace the policies associated with a listener" + } + ] + } +} diff --git a/aws/dist/botocore/data/elb/2012-06-01/paginators-1.json b/aws/dist/botocore/data/elb/2012-06-01/paginators-1.json new file mode 100644 index 00000000..b3bd3301 --- /dev/null +++ b/aws/dist/botocore/data/elb/2012-06-01/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeLoadBalancers": { + "input_token": "Marker", + "output_token": "NextMarker", + "result_key": "LoadBalancerDescriptions", + "limit_key": "PageSize" + }, + "DescribeAccountLimits": { + "input_token": "Marker", + "limit_key": "PageSize", + "output_token": "NextMarker", + "result_key": "Limits" + } + } +} diff --git a/aws/dist/botocore/data/elb/2012-06-01/service-2.json b/aws/dist/botocore/data/elb/2012-06-01/service-2.json new file mode 100644 index 00000000..da1a0da7 --- /dev/null +++ b/aws/dist/botocore/data/elb/2012-06-01/service-2.json @@ -0,0 +1,2280 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-06-01", + "endpointPrefix":"elasticloadbalancing", + "protocol":"query", + "serviceFullName":"Elastic Load Balancing", + "serviceId":"Elastic Load Balancing", + "signatureVersion":"v4", + "uid":"elasticloadbalancing-2012-06-01", + "xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2012-06-01/" + }, + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{ + "shape":"AddTagsOutput", + "resultWrapper":"AddTagsResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DuplicateTagKeysException"} + ], + "documentation":"

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "ApplySecurityGroupsToLoadBalancer":{ + "name":"ApplySecurityGroupsToLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplySecurityGroupsToLoadBalancerInput"}, + "output":{ + "shape":"ApplySecurityGroupsToLoadBalancerOutput", + "resultWrapper":"ApplySecurityGroupsToLoadBalancerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"InvalidSecurityGroupException"} + ], + "documentation":"

Associates one or more security groups with your load balancer in a virtual private cloud (VPC). The specified security groups override the previously associated security groups.

For more information, see Security Groups for Load Balancers in a VPC in the Classic Load Balancers Guide.

" + }, + "AttachLoadBalancerToSubnets":{ + "name":"AttachLoadBalancerToSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachLoadBalancerToSubnetsInput"}, + "output":{ + "shape":"AttachLoadBalancerToSubnetsOutput", + "resultWrapper":"AttachLoadBalancerToSubnetsResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"SubnetNotFoundException"}, + {"shape":"InvalidSubnetException"} + ], + "documentation":"

Adds one or more subnets to the set of configured subnets for the specified load balancer.

The load balancer evenly distributes requests across all registered subnets. For more information, see Add or Remove Subnets for Your Load Balancer in a VPC in the Classic Load Balancers Guide.

" + }, + "ConfigureHealthCheck":{ + "name":"ConfigureHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfigureHealthCheckInput"}, + "output":{ + "shape":"ConfigureHealthCheckOutput", + "resultWrapper":"ConfigureHealthCheckResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"} + ], + "documentation":"

Specifies the health check settings to use when evaluating the health state of your EC2 instances.

For more information, see Configure Health Checks for Your Load Balancer in the Classic Load Balancers Guide.

" + }, + "CreateAppCookieStickinessPolicy":{ + "name":"CreateAppCookieStickinessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppCookieStickinessPolicyInput"}, + "output":{ + "shape":"CreateAppCookieStickinessPolicyOutput", + "resultWrapper":"CreateAppCookieStickinessPolicyResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"DuplicatePolicyNameException"}, + {"shape":"TooManyPoliciesException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Generates a stickiness policy with sticky session lifetimes that follow that of an application-generated cookie. This policy can be associated only with HTTP/HTTPS listeners.

This policy is similar to the policy created by CreateLBCookieStickinessPolicy, except that the lifetime of the special Elastic Load Balancing cookie, AWSELB, follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer only inserts a new stickiness cookie when the application response includes a new application cookie.

If the application cookie is explicitly removed or expires, the session stops being sticky until a new application cookie is issued.

For more information, see Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

" + }, + "CreateLBCookieStickinessPolicy":{ + "name":"CreateLBCookieStickinessPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLBCookieStickinessPolicyInput"}, + "output":{ + "shape":"CreateLBCookieStickinessPolicyOutput", + "resultWrapper":"CreateLBCookieStickinessPolicyResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"DuplicatePolicyNameException"}, + {"shape":"TooManyPoliciesException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Generates a stickiness policy with sticky session lifetimes controlled by the lifetime of the browser (user-agent) or a specified expiration period. This policy can be associated only with HTTP/HTTPS listeners.

When a load balancer implements this policy, the load balancer uses a special cookie to track the instance for each request. When the load balancer receives a request, it first checks to see if this cookie is present in the request. If so, the load balancer sends the request to the application server specified in the cookie. If not, the load balancer sends the request to a server that is chosen based on the existing load-balancing algorithm.

A cookie is inserted into the response for binding subsequent requests from the same user to that server. The validity of the cookie is based on the cookie expiration time, which is specified in the policy configuration.

For more information, see Duration-Based Session Stickiness in the Classic Load Balancers Guide.

" + }, + "CreateLoadBalancer":{ + "name":"CreateLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccessPointInput"}, + "output":{ + "shape":"CreateAccessPointOutput", + "resultWrapper":"CreateLoadBalancerResult" + }, + "errors":[ + {"shape":"DuplicateAccessPointNameException"}, + {"shape":"TooManyAccessPointsException"}, + {"shape":"CertificateNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"SubnetNotFoundException"}, + {"shape":"InvalidSubnetException"}, + {"shape":"InvalidSecurityGroupException"}, + {"shape":"InvalidSchemeException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DuplicateTagKeysException"}, + {"shape":"UnsupportedProtocolException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Creates a Classic Load Balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "CreateLoadBalancerListeners":{ + "name":"CreateLoadBalancerListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerListenerInput"}, + "output":{ + "shape":"CreateLoadBalancerListenerOutput", + "resultWrapper":"CreateLoadBalancerListenersResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"DuplicateListenerException"}, + {"shape":"CertificateNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"UnsupportedProtocolException"} + ], + "documentation":"

Creates one or more listeners for the specified load balancer. If a listener with the specified port does not already exist, it is created; otherwise, the properties of the new listener must match the properties of the existing listener.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "CreateLoadBalancerPolicy":{ + "name":"CreateLoadBalancerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerPolicyInput"}, + "output":{ + "shape":"CreateLoadBalancerPolicyOutput", + "resultWrapper":"CreateLoadBalancerPolicyResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"PolicyTypeNotFoundException"}, + {"shape":"DuplicatePolicyNameException"}, + {"shape":"TooManyPoliciesException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Creates a policy with the specified attributes for the specified load balancer.

Policies are settings that are saved for your load balancer and that can be applied to the listener or the application server, depending on the policy type.

" + }, + "DeleteLoadBalancer":{ + "name":"DeleteLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessPointInput"}, + "output":{ + "shape":"DeleteAccessPointOutput", + "resultWrapper":"DeleteLoadBalancerResult" + }, + "documentation":"

Deletes the specified load balancer.

If you are attempting to recreate a load balancer, you must reconfigure all settings. The DNS name associated with a deleted load balancer are no longer usable. The name and associated DNS record of the deleted load balancer no longer exist and traffic sent to any of its IP addresses is no longer delivered to your instances.

If the load balancer does not exist or has already been deleted, the call to DeleteLoadBalancer still succeeds.

" + }, + "DeleteLoadBalancerListeners":{ + "name":"DeleteLoadBalancerListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoadBalancerListenerInput"}, + "output":{ + "shape":"DeleteLoadBalancerListenerOutput", + "resultWrapper":"DeleteLoadBalancerListenersResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"} + ], + "documentation":"

Deletes the specified listeners from the specified load balancer.

" + }, + "DeleteLoadBalancerPolicy":{ + "name":"DeleteLoadBalancerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoadBalancerPolicyInput"}, + "output":{ + "shape":"DeleteLoadBalancerPolicyOutput", + "resultWrapper":"DeleteLoadBalancerPolicyResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Deletes the specified policy from the specified load balancer. This policy must not be enabled for any listeners.

" + }, + "DeregisterInstancesFromLoadBalancer":{ + "name":"DeregisterInstancesFromLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterEndPointsInput"}, + "output":{ + "shape":"DeregisterEndPointsOutput", + "resultWrapper":"DeregisterInstancesFromLoadBalancerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidEndPointException"} + ], + "documentation":"

Deregisters the specified instances from the specified load balancer. After the instance is deregistered, it no longer receives traffic from the load balancer.

You can use DescribeLoadBalancers to verify that the instance is deregistered from the load balancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountLimitsInput"}, + "output":{ + "shape":"DescribeAccountLimitsOutput", + "resultWrapper":"DescribeAccountLimitsResult" + }, + "documentation":"

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "DescribeInstanceHealth":{ + "name":"DescribeInstanceHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndPointStateInput"}, + "output":{ + "shape":"DescribeEndPointStateOutput", + "resultWrapper":"DescribeInstanceHealthResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidEndPointException"} + ], + "documentation":"

Describes the state of the specified instances with respect to the specified load balancer. If no instances are specified, the call describes the state of all instances that are currently registered with the load balancer. If instances are specified, their state is returned even if they are no longer registered with the load balancer. The state of terminated instances is not returned.

" + }, + "DescribeLoadBalancerAttributes":{ + "name":"DescribeLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerAttributesInput"}, + "output":{ + "shape":"DescribeLoadBalancerAttributesOutput", + "resultWrapper":"DescribeLoadBalancerAttributesResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"LoadBalancerAttributeNotFoundException"} + ], + "documentation":"

Describes the attributes for the specified load balancer.

" + }, + "DescribeLoadBalancerPolicies":{ + "name":"DescribeLoadBalancerPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerPoliciesInput"}, + "output":{ + "shape":"DescribeLoadBalancerPoliciesOutput", + "resultWrapper":"DescribeLoadBalancerPoliciesResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"PolicyNotFoundException"} + ], + "documentation":"

Describes the specified policies.

If you specify a load balancer name, the action returns the descriptions of all policies created for the load balancer. If you specify a policy name associated with your load balancer, the action returns the description of that policy. If you don't specify a load balancer name, the action returns descriptions of the specified sample policies, or descriptions of all sample policies. The names of the sample policies have the ELBSample- prefix.

" + }, + "DescribeLoadBalancerPolicyTypes":{ + "name":"DescribeLoadBalancerPolicyTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerPolicyTypesInput"}, + "output":{ + "shape":"DescribeLoadBalancerPolicyTypesOutput", + "resultWrapper":"DescribeLoadBalancerPolicyTypesResult" + }, + "errors":[ + {"shape":"PolicyTypeNotFoundException"} + ], + "documentation":"

Describes the specified load balancer policy types or all load balancer policy types.

The description of each type indicates how it can be used. For example, some policies can be used only with layer 7 listeners, some policies can be used only with layer 4 listeners, and some policies can be used only with your EC2 instances.

You can use CreateLoadBalancerPolicy to create a policy configuration for any of these policy types. Then, depending on the policy type, use either SetLoadBalancerPoliciesOfListener or SetLoadBalancerPoliciesForBackendServer to set the policy.

" + }, + "DescribeLoadBalancers":{ + "name":"DescribeLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccessPointsInput"}, + "output":{ + "shape":"DescribeAccessPointsOutput", + "resultWrapper":"DescribeLoadBalancersResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"DependencyThrottleException"} + ], + "documentation":"

Describes the specified the load balancers. If no load balancers are specified, the call describes all of your load balancers.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsInput"}, + "output":{ + "shape":"DescribeTagsOutput", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"} + ], + "documentation":"

Describes the tags associated with the specified load balancers.

" + }, + "DetachLoadBalancerFromSubnets":{ + "name":"DetachLoadBalancerFromSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachLoadBalancerFromSubnetsInput"}, + "output":{ + "shape":"DetachLoadBalancerFromSubnetsOutput", + "resultWrapper":"DetachLoadBalancerFromSubnetsResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Removes the specified subnets from the set of configured subnets for the load balancer.

After a subnet is removed, all EC2 instances registered with the load balancer in the removed subnet go into the OutOfService state. Then, the load balancer balances the traffic among the remaining routable subnets.

" + }, + "DisableAvailabilityZonesForLoadBalancer":{ + "name":"DisableAvailabilityZonesForLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAvailabilityZonesInput"}, + "output":{ + "shape":"RemoveAvailabilityZonesOutput", + "resultWrapper":"DisableAvailabilityZonesForLoadBalancerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Removes the specified Availability Zones from the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

For load balancers in a non-default VPC, use DetachLoadBalancerFromSubnets.

There must be at least one Availability Zone registered with a load balancer at all times. After an Availability Zone is removed, all instances registered with the load balancer that are in the removed Availability Zone go into the OutOfService state. Then, the load balancer attempts to equally balance the traffic among its remaining Availability Zones.

For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

" + }, + "EnableAvailabilityZonesForLoadBalancer":{ + "name":"EnableAvailabilityZonesForLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAvailabilityZonesInput"}, + "output":{ + "shape":"AddAvailabilityZonesOutput", + "resultWrapper":"EnableAvailabilityZonesForLoadBalancerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"} + ], + "documentation":"

Adds the specified Availability Zones to the set of Availability Zones for the specified load balancer in EC2-Classic or a default VPC.

For load balancers in a non-default VPC, use AttachLoadBalancerToSubnets.

The load balancer evenly distributes requests across all its registered Availability Zones that contain instances. For more information, see Add or Remove Availability Zones in the Classic Load Balancers Guide.

" + }, + "ModifyLoadBalancerAttributes":{ + "name":"ModifyLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyLoadBalancerAttributesInput"}, + "output":{ + "shape":"ModifyLoadBalancerAttributesOutput", + "resultWrapper":"ModifyLoadBalancerAttributesResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"LoadBalancerAttributeNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Modifies the attributes of the specified load balancer.

You can modify the load balancer attributes, such as AccessLogs, ConnectionDraining, and CrossZoneLoadBalancing by either enabling or disabling them. Or, you can modify the load balancer attribute ConnectionSettings by specifying an idle connection timeout value for your load balancer.

For more information, see the following in the Classic Load Balancers Guide:

" + }, + "RegisterInstancesWithLoadBalancer":{ + "name":"RegisterInstancesWithLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterEndPointsInput"}, + "output":{ + "shape":"RegisterEndPointsOutput", + "resultWrapper":"RegisterInstancesWithLoadBalancerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"InvalidEndPointException"} + ], + "documentation":"

Adds the specified instances to the specified load balancer.

The instance must be a running instance in the same network as the load balancer (EC2-Classic or the same VPC). If you have EC2-Classic instances and a load balancer in a VPC with ClassicLink enabled, you can link the EC2-Classic instances to that VPC and then register the linked EC2-Classic instances with the load balancer in the VPC.

Note that RegisterInstanceWithLoadBalancer completes when the request has been registered. Instance registration takes a little time to complete. To check the state of the registered instances, use DescribeLoadBalancers or DescribeInstanceHealth.

After the instance is registered, it starts receiving traffic and requests from the load balancer. Any instance that is not in one of the Availability Zones registered for the load balancer is moved to the OutOfService state. If an Availability Zone is added to the load balancer later, any instances registered with the load balancer move to the InService state.

To deregister instances from a load balancer, use DeregisterInstancesFromLoadBalancer.

For more information, see Register or De-Register EC2 Instances in the Classic Load Balancers Guide.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsInput"}, + "output":{ + "shape":"RemoveTagsOutput", + "resultWrapper":"RemoveTagsResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"} + ], + "documentation":"

Removes one or more tags from the specified load balancer.

" + }, + "SetLoadBalancerListenerSSLCertificate":{ + "name":"SetLoadBalancerListenerSSLCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBalancerListenerSSLCertificateInput"}, + "output":{ + "shape":"SetLoadBalancerListenerSSLCertificateOutput", + "resultWrapper":"SetLoadBalancerListenerSSLCertificateResult" + }, + "errors":[ + {"shape":"CertificateNotFoundException"}, + {"shape":"AccessPointNotFoundException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"UnsupportedProtocolException"} + ], + "documentation":"

Sets the certificate that terminates the specified listener's SSL connections. The specified certificate replaces any prior certificate that was used on the same load balancer and port.

For more information about updating your SSL certificate, see Replace the SSL Certificate for Your Load Balancer in the Classic Load Balancers Guide.

" + }, + "SetLoadBalancerPoliciesForBackendServer":{ + "name":"SetLoadBalancerPoliciesForBackendServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBalancerPoliciesForBackendServerInput"}, + "output":{ + "shape":"SetLoadBalancerPoliciesForBackendServerOutput", + "resultWrapper":"SetLoadBalancerPoliciesForBackendServerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Replaces the set of policies associated with the specified port on which the EC2 instance is listening with a new set of policies. At this time, only the back-end server authentication policy type can be applied to the instance ports; this policy type is composed of multiple public key policies.

Each time you use SetLoadBalancerPoliciesForBackendServer to enable the policies, use the PolicyNames parameter to list the policies that you want to enable.

You can use DescribeLoadBalancers or DescribeLoadBalancerPolicies to verify that the policy is associated with the EC2 instance.

For more information about enabling back-end instance authentication, see Configure Back-end Instance Authentication in the Classic Load Balancers Guide. For more information about Proxy Protocol, see Configure Proxy Protocol Support in the Classic Load Balancers Guide.

" + }, + "SetLoadBalancerPoliciesOfListener":{ + "name":"SetLoadBalancerPoliciesOfListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBalancerPoliciesOfListenerInput"}, + "output":{ + "shape":"SetLoadBalancerPoliciesOfListenerOutput", + "resultWrapper":"SetLoadBalancerPoliciesOfListenerResult" + }, + "errors":[ + {"shape":"AccessPointNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Replaces the current set of policies for the specified load balancer port with the specified set of policies.

To enable back-end server authentication, use SetLoadBalancerPoliciesForBackendServer.

For more information about setting policies, see Update the SSL Negotiation Configuration, Duration-Based Session Stickiness, and Application-Controlled Session Stickiness in the Classic Load Balancers Guide.

" + } + }, + "shapes":{ + "AccessLog":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"AccessLogEnabled", + "documentation":"

Specifies whether access logs are enabled for the load balancer.

" + }, + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"

The name of the Amazon S3 bucket where the access logs are stored.

" + }, + "EmitInterval":{ + "shape":"AccessLogInterval", + "documentation":"

The interval for publishing the access logs. You can specify an interval of either 5 minutes or 60 minutes.

Default: 60 minutes

" + }, + "S3BucketPrefix":{ + "shape":"AccessLogPrefix", + "documentation":"

The logical hierarchy you created for your Amazon S3 bucket, for example my-bucket-prefix/prod. If the prefix is not provided, the log is placed at the root level of the bucket.

" + } + }, + "documentation":"

Information about the AccessLog attribute.

" + }, + "AccessLogEnabled":{"type":"boolean"}, + "AccessLogInterval":{"type":"integer"}, + "AccessLogPrefix":{"type":"string"}, + "AccessPointName":{"type":"string"}, + "AccessPointNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified load balancer does not exist.

", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AccessPointPort":{"type":"integer"}, + "AddAvailabilityZonesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "AvailabilityZones" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The Availability Zones. These must be in the same region as the load balancer.

" + } + }, + "documentation":"

Contains the parameters for EnableAvailabilityZonesForLoadBalancer.

" + }, + "AddAvailabilityZonesOutput":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The updated list of Availability Zones for the load balancer.

" + } + }, + "documentation":"

Contains the output of EnableAvailabilityZonesForLoadBalancer.

" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "LoadBalancerNames", + "Tags" + ], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The name of the load balancer. You can specify one load balancer only.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags.

" + } + }, + "documentation":"

Contains the parameters for AddTags.

" + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of AddTags.

" + }, + "AdditionalAttribute":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"AdditionalAttributeKey", + "documentation":"

This parameter is reserved.

" + }, + "Value":{ + "shape":"AdditionalAttributeValue", + "documentation":"

This parameter is reserved.

" + } + }, + "documentation":"

This data type is reserved.

" + }, + "AdditionalAttributeKey":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9.]+$" + }, + "AdditionalAttributeValue":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9.]+$" + }, + "AdditionalAttributes":{ + "type":"list", + "member":{"shape":"AdditionalAttribute"}, + "max":10 + }, + "AppCookieStickinessPolicies":{ + "type":"list", + "member":{"shape":"AppCookieStickinessPolicy"} + }, + "AppCookieStickinessPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

" + }, + "CookieName":{ + "shape":"CookieName", + "documentation":"

The name of the application cookie used for stickiness.

" + } + }, + "documentation":"

Information about a policy for application-controlled session stickiness.

" + }, + "ApplySecurityGroupsToLoadBalancerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "SecurityGroups" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups to associate with the load balancer. Note that you cannot specify the name of the security group.

" + } + }, + "documentation":"

Contains the parameters for ApplySecurityGroupsToLoadBalancer.

" + }, + "ApplySecurityGroupsToLoadBalancerOutput":{ + "type":"structure", + "members":{ + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups associated with the load balancer.

" + } + }, + "documentation":"

Contains the output of ApplySecurityGroupsToLoadBalancer.

" + }, + "AttachLoadBalancerToSubnetsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Subnets" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the subnets to add. You can add only one subnet per Availability Zone.

" + } + }, + "documentation":"

Contains the parameters for AttachLoaBalancerToSubnets.

" + }, + "AttachLoadBalancerToSubnetsOutput":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the subnets attached to the load balancer.

" + } + }, + "documentation":"

Contains the output of AttachLoadBalancerToSubnets.

" + }, + "AttributeName":{"type":"string"}, + "AttributeType":{"type":"string"}, + "AttributeValue":{"type":"string"}, + "AvailabilityZone":{"type":"string"}, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZone"} + }, + "BackendServerDescription":{ + "type":"structure", + "members":{ + "InstancePort":{ + "shape":"InstancePort", + "documentation":"

The port on which the EC2 instance is listening.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of the policies enabled for the EC2 instance.

" + } + }, + "documentation":"

Information about the configuration of an EC2 instance.

" + }, + "BackendServerDescriptions":{ + "type":"list", + "member":{"shape":"BackendServerDescription"} + }, + "Cardinality":{"type":"string"}, + "CertificateNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified ARN does not refer to a valid SSL certificate in AWS Identity and Access Management (IAM) or AWS Certificate Manager (ACM). Note that if you recently uploaded the certificate to IAM, this error might indicate that the certificate is not fully available yet.

", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConfigureHealthCheckInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "HealthCheck" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

The configuration information.

" + } + }, + "documentation":"

Contains the parameters for ConfigureHealthCheck.

" + }, + "ConfigureHealthCheckOutput":{ + "type":"structure", + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

The updated health check.

" + } + }, + "documentation":"

Contains the output of ConfigureHealthCheck.

" + }, + "ConnectionDraining":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"ConnectionDrainingEnabled", + "documentation":"

Specifies whether connection draining is enabled for the load balancer.

" + }, + "Timeout":{ + "shape":"ConnectionDrainingTimeout", + "documentation":"

The maximum time, in seconds, to keep the existing connections open before deregistering the instances.

" + } + }, + "documentation":"

Information about the ConnectionDraining attribute.

" + }, + "ConnectionDrainingEnabled":{"type":"boolean"}, + "ConnectionDrainingTimeout":{"type":"integer"}, + "ConnectionSettings":{ + "type":"structure", + "required":["IdleTimeout"], + "members":{ + "IdleTimeout":{ + "shape":"IdleTimeout", + "documentation":"

The time, in seconds, that the connection is allowed to be idle (no data has been sent over the connection) before it is closed by the load balancer.

" + } + }, + "documentation":"

Information about the ConnectionSettings attribute.

" + }, + "CookieExpirationPeriod":{"type":"long"}, + "CookieName":{"type":"string"}, + "CreateAccessPointInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Listeners" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.

" + }, + "Listeners":{ + "shape":"Listeners", + "documentation":"

The listeners.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

One or more Availability Zones from the same region as the load balancer.

You must specify at least one Availability Zone.

You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups to assign to the load balancer.

" + }, + "Scheme":{ + "shape":"LoadBalancerScheme", + "documentation":"

The type of a load balancer. Valid only for load balancers in a VPC.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide.

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to assign to the load balancer.

For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

" + } + }, + "documentation":"

Contains the parameters for CreateLoadBalancer.

" + }, + "CreateAccessPointOutput":{ + "type":"structure", + "members":{ + "DNSName":{ + "shape":"DNSName", + "documentation":"

The DNS name of the load balancer.

" + } + }, + "documentation":"

Contains the output for CreateLoadBalancer.

" + }, + "CreateAppCookieStickinessPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName", + "CookieName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

" + }, + "CookieName":{ + "shape":"CookieName", + "documentation":"

The name of the application cookie used for stickiness.

" + } + }, + "documentation":"

Contains the parameters for CreateAppCookieStickinessPolicy.

" + }, + "CreateAppCookieStickinessPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output for CreateAppCookieStickinessPolicy.

" + }, + "CreateLBCookieStickinessPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy being created. Policy names must consist of alphanumeric characters and dashes (-). This name must be unique within the set of policies for this load balancer.

" + }, + "CookieExpirationPeriod":{ + "shape":"CookieExpirationPeriod", + "documentation":"

The time period, in seconds, after which the cookie should be considered stale. If you do not specify this parameter, the default value is 0, which indicates that the sticky session should last for the duration of the browser session.

" + } + }, + "documentation":"

Contains the parameters for CreateLBCookieStickinessPolicy.

" + }, + "CreateLBCookieStickinessPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output for CreateLBCookieStickinessPolicy.

" + }, + "CreateLoadBalancerListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Listeners" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Listeners":{ + "shape":"Listeners", + "documentation":"

The listeners.

" + } + }, + "documentation":"

Contains the parameters for CreateLoadBalancerListeners.

" + }, + "CreateLoadBalancerListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the parameters for CreateLoadBalancerListener.

" + }, + "CreateLoadBalancerPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName", + "PolicyTypeName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the load balancer policy to be created. This name must be unique within the set of policies for this load balancer.

" + }, + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the base policy type. To get the list of policy types, use DescribeLoadBalancerPolicyTypes.

" + }, + "PolicyAttributes":{ + "shape":"PolicyAttributes", + "documentation":"

The policy attributes.

" + } + }, + "documentation":"

Contains the parameters for CreateLoadBalancerPolicy.

" + }, + "CreateLoadBalancerPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of CreateLoadBalancerPolicy.

" + }, + "CreatedTime":{"type":"timestamp"}, + "CrossZoneLoadBalancing":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Enabled":{ + "shape":"CrossZoneLoadBalancingEnabled", + "documentation":"

Specifies whether cross-zone load balancing is enabled for the load balancer.

" + } + }, + "documentation":"

Information about the CrossZoneLoadBalancing attribute.

" + }, + "CrossZoneLoadBalancingEnabled":{"type":"boolean"}, + "DNSName":{"type":"string"}, + "DefaultValue":{"type":"string"}, + "DeleteAccessPointInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + } + }, + "documentation":"

Contains the parameters for DeleteLoadBalancer.

" + }, + "DeleteAccessPointOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of DeleteLoadBalancer.

" + }, + "DeleteLoadBalancerListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPorts" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerPorts":{ + "shape":"Ports", + "documentation":"

The client port numbers of the listeners.

" + } + }, + "documentation":"

Contains the parameters for DeleteLoadBalancerListeners.

" + }, + "DeleteLoadBalancerListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of DeleteLoadBalancerListeners.

" + }, + "DeleteLoadBalancerPolicyInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "PolicyName" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

" + } + }, + "documentation":"

Contains the parameters for DeleteLoadBalancerPolicy.

" + }, + "DeleteLoadBalancerPolicyOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of DeleteLoadBalancerPolicy.

" + }, + "DependencyThrottleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A request made by Elastic Load Balancing to another service exceeds the maximum request rate permitted for your account.

", + "error":{ + "code":"DependencyThrottle", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeregisterEndPointsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Instances" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

The IDs of the instances.

" + } + }, + "documentation":"

Contains the parameters for DeregisterInstancesFromLoadBalancer.

" + }, + "DeregisterEndPointsOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

The remaining instances registered with the load balancer.

" + } + }, + "documentation":"

Contains the output of DeregisterInstancesFromLoadBalancer.

" + }, + "DescribeAccessPointsInput":{ + "type":"structure", + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The names of the load balancers.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call (a number from 1 to 400). The default is 400.

" + } + }, + "documentation":"

Contains the parameters for DescribeLoadBalancers.

" + }, + "DescribeAccessPointsOutput":{ + "type":"structure", + "members":{ + "LoadBalancerDescriptions":{ + "shape":"LoadBalancerDescriptions", + "documentation":"

Information about the load balancers.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" + } + }, + "documentation":"

Contains the parameters for DescribeLoadBalancers.

" + }, + "DescribeAccountLimitsInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeAccountLimitsOutput":{ + "type":"structure", + "members":{ + "Limits":{ + "shape":"Limits", + "documentation":"

Information about the limits.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

" + } + } + }, + "DescribeEndPointStateInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

The IDs of the instances.

" + } + }, + "documentation":"

Contains the parameters for DescribeInstanceHealth.

" + }, + "DescribeEndPointStateOutput":{ + "type":"structure", + "members":{ + "InstanceStates":{ + "shape":"InstanceStates", + "documentation":"

Information about the health of the instances.

" + } + }, + "documentation":"

Contains the output for DescribeInstanceHealth.

" + }, + "DescribeLoadBalancerAttributesInput":{ + "type":"structure", + "required":["LoadBalancerName"], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + } + }, + "documentation":"

Contains the parameters for DescribeLoadBalancerAttributes.

" + }, + "DescribeLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "LoadBalancerAttributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

Information about the load balancer attributes.

" + } + }, + "documentation":"

Contains the output of DescribeLoadBalancerAttributes.

" + }, + "DescribeLoadBalancerPoliciesInput":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of the policies.

" + } + }, + "documentation":"

Contains the parameters for DescribeLoadBalancerPolicies.

" + }, + "DescribeLoadBalancerPoliciesOutput":{ + "type":"structure", + "members":{ + "PolicyDescriptions":{ + "shape":"PolicyDescriptions", + "documentation":"

Information about the policies.

" + } + }, + "documentation":"

Contains the output of DescribeLoadBalancerPolicies.

" + }, + "DescribeLoadBalancerPolicyTypesInput":{ + "type":"structure", + "members":{ + "PolicyTypeNames":{ + "shape":"PolicyTypeNames", + "documentation":"

The names of the policy types. If no names are specified, describes all policy types defined by Elastic Load Balancing.

" + } + }, + "documentation":"

Contains the parameters for DescribeLoadBalancerPolicyTypes.

" + }, + "DescribeLoadBalancerPolicyTypesOutput":{ + "type":"structure", + "members":{ + "PolicyTypeDescriptions":{ + "shape":"PolicyTypeDescriptions", + "documentation":"

Information about the policy types.

" + } + }, + "documentation":"

Contains the output of DescribeLoadBalancerPolicyTypes.

" + }, + "DescribeTagsInput":{ + "type":"structure", + "required":["LoadBalancerNames"], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNamesMax20", + "documentation":"

The names of the load balancers.

" + } + }, + "documentation":"

Contains the parameters for DescribeTags.

" + }, + "DescribeTagsOutput":{ + "type":"structure", + "members":{ + "TagDescriptions":{ + "shape":"TagDescriptions", + "documentation":"

Information about the tags.

" + } + }, + "documentation":"

Contains the output for DescribeTags.

" + }, + "Description":{"type":"string"}, + "DetachLoadBalancerFromSubnetsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Subnets" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the subnets.

" + } + }, + "documentation":"

Contains the parameters for DetachLoadBalancerFromSubnets.

" + }, + "DetachLoadBalancerFromSubnetsOutput":{ + "type":"structure", + "members":{ + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the remaining subnets for the load balancer.

" + } + }, + "documentation":"

Contains the output of DetachLoadBalancerFromSubnets.

" + }, + "DuplicateAccessPointNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified load balancer name already exists for this account.

", + "error":{ + "code":"DuplicateLoadBalancerName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicateListenerException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A listener already exists for the specified load balancer name and port, but with a different instance port, protocol, or SSL certificate.

", + "error":{ + "code":"DuplicateListener", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicatePolicyNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A policy with the specified name already exists for this load balancer.

", + "error":{ + "code":"DuplicatePolicyName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicateTagKeysException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A tag key was specified more than once.

", + "error":{ + "code":"DuplicateTagKeys", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EndPointPort":{"type":"integer"}, + "HealthCheck":{ + "type":"structure", + "required":[ + "Target", + "Interval", + "Timeout", + "UnhealthyThreshold", + "HealthyThreshold" + ], + "members":{ + "Target":{ + "shape":"HealthCheckTarget", + "documentation":"

The instance being checked. The protocol is either TCP, HTTP, HTTPS, or SSL. The range of valid ports is one (1) through 65535.

TCP is the default, specified as a TCP: port pair, for example \"TCP:5000\". In this case, a health check simply attempts to open a TCP connection to the instance on the specified port. Failure to connect within the configured timeout is considered unhealthy.

SSL is also specified as SSL: port pair, for example, SSL:5000.

For HTTP/HTTPS, you must include a ping path in the string. HTTP is specified as a HTTP:port;/;PathToPing; grouping, for example \"HTTP:80/weather/us/wa/seattle\". In this case, a HTTP GET request is issued to the instance on the given port and path. Any answer other than \"200 OK\" within the timeout period is considered unhealthy.

The total length of the HTTP ping target must be 1024 16-bit Unicode characters or less.

" + }, + "Interval":{ + "shape":"HealthCheckInterval", + "documentation":"

The approximate interval, in seconds, between health checks of an individual instance.

" + }, + "Timeout":{ + "shape":"HealthCheckTimeout", + "documentation":"

The amount of time, in seconds, during which no response means a failed health check.

This value must be less than the Interval value.

" + }, + "UnhealthyThreshold":{ + "shape":"UnhealthyThreshold", + "documentation":"

The number of consecutive health check failures required before moving the instance to the Unhealthy state.

" + }, + "HealthyThreshold":{ + "shape":"HealthyThreshold", + "documentation":"

The number of consecutive health checks successes required before moving the instance to the Healthy state.

" + } + }, + "documentation":"

Information about a health check.

" + }, + "HealthCheckInterval":{ + "type":"integer", + "max":300, + "min":5 + }, + "HealthCheckTarget":{"type":"string"}, + "HealthCheckTimeout":{ + "type":"integer", + "max":60, + "min":2 + }, + "HealthyThreshold":{ + "type":"integer", + "max":10, + "min":2 + }, + "IdleTimeout":{ + "type":"integer", + "max":3600, + "min":1 + }, + "Instance":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The instance ID.

" + } + }, + "documentation":"

The ID of an EC2 instance.

" + }, + "InstanceId":{"type":"string"}, + "InstancePort":{ + "type":"integer", + "max":65535, + "min":1 + }, + "InstanceState":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

The ID of the instance.

" + }, + "State":{ + "shape":"State", + "documentation":"

The current state of the instance.

Valid values: InService | OutOfService | Unknown

" + }, + "ReasonCode":{ + "shape":"ReasonCode", + "documentation":"

Information about the cause of OutOfService instances. Specifically, whether the cause is Elastic Load Balancing or the instance.

Valid values: ELB | Instance | N/A

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the instance state. This string can contain one or more of the following messages.

  • N/A

  • A transient error occurred. Please try again later.

  • Instance has failed at least the UnhealthyThreshold number of health checks consecutively.

  • Instance has not passed the configured HealthyThreshold number of health checks consecutively.

  • Instance registration is still in progress.

  • Instance is in the EC2 Availability Zone for which LoadBalancer is not configured to route traffic to.

  • Instance is not currently registered with the LoadBalancer.

  • Instance deregistration currently in progress.

  • Disable Availability Zone is currently in progress.

  • Instance is in pending state.

  • Instance is in stopped state.

  • Instance is in terminated state.

" + } + }, + "documentation":"

Information about the state of an EC2 instance.

" + }, + "InstanceStates":{ + "type":"list", + "member":{"shape":"InstanceState"} + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InvalidConfigurationRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested configuration change is not valid.

", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "InvalidEndPointException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified endpoint is not valid.

", + "error":{ + "code":"InvalidInstance", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSchemeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified value for the schema is not valid. You can only specify a scheme for load balancers in a VPC.

", + "error":{ + "code":"InvalidScheme", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSecurityGroupException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more of the specified security groups do not exist.

", + "error":{ + "code":"InvalidSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified VPC has no associated Internet gateway.

", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LBCookieStickinessPolicies":{ + "type":"list", + "member":{"shape":"LBCookieStickinessPolicy"} + }, + "LBCookieStickinessPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy. This name must be unique within the set of policies for this load balancer.

" + }, + "CookieExpirationPeriod":{ + "shape":"CookieExpirationPeriod", + "documentation":"

The time period, in seconds, after which the cookie should be considered stale. If this parameter is not specified, the stickiness session lasts for the duration of the browser session.

" + } + }, + "documentation":"

Information about a policy for duration-based session stickiness.

" + }, + "Limit":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the limit. The possible values are:

  • classic-listeners

  • classic-load-balancers

  • classic-registered-instances

" + }, + "Max":{ + "shape":"Max", + "documentation":"

The maximum value of the limit.

" + } + }, + "documentation":"

Information about an Elastic Load Balancing resource limit for your AWS account.

" + }, + "Limits":{ + "type":"list", + "member":{"shape":"Limit"} + }, + "Listener":{ + "type":"structure", + "required":[ + "Protocol", + "LoadBalancerPort", + "InstancePort" + ], + "members":{ + "Protocol":{ + "shape":"Protocol", + "documentation":"

The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

" + }, + "InstanceProtocol":{ + "shape":"Protocol", + "documentation":"

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.

If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

" + }, + "InstancePort":{ + "shape":"InstancePort", + "documentation":"

The port on which the instance is listening.

" + }, + "SSLCertificateId":{ + "shape":"SSLCertificateId", + "documentation":"

The Amazon Resource Name (ARN) of the server certificate.

" + } + }, + "documentation":"

Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide.

" + }, + "ListenerDescription":{ + "type":"structure", + "members":{ + "Listener":{ + "shape":"Listener", + "documentation":"

The listener.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The policies. If there are no policies enabled, the list is empty.

" + } + }, + "documentation":"

The policies enabled for a listener.

" + }, + "ListenerDescriptions":{ + "type":"list", + "member":{"shape":"ListenerDescription"} + }, + "ListenerNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The load balancer does not have a listener configured at the specified port.

", + "error":{ + "code":"ListenerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Listeners":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "LoadBalancerAttributeNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified load balancer attribute does not exist.

", + "error":{ + "code":"LoadBalancerAttributeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LoadBalancerAttributes":{ + "type":"structure", + "members":{ + "CrossZoneLoadBalancing":{ + "shape":"CrossZoneLoadBalancing", + "documentation":"

If enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.

For more information, see Configure Cross-Zone Load Balancing in the Classic Load Balancers Guide.

" + }, + "AccessLog":{ + "shape":"AccessLog", + "documentation":"

If enabled, the load balancer captures detailed information of all requests and delivers the information to the Amazon S3 bucket that you specify.

For more information, see Enable Access Logs in the Classic Load Balancers Guide.

" + }, + "ConnectionDraining":{ + "shape":"ConnectionDraining", + "documentation":"

If enabled, the load balancer allows existing requests to complete before the load balancer shifts traffic away from a deregistered or unhealthy instance.

For more information, see Configure Connection Draining in the Classic Load Balancers Guide.

" + }, + "ConnectionSettings":{ + "shape":"ConnectionSettings", + "documentation":"

If enabled, the load balancer allows the connections to remain idle (no data is sent over the connection) for the specified duration.

By default, Elastic Load Balancing maintains a 60-second idle connection timeout for both front-end and back-end connections of your load balancer. For more information, see Configure Idle Connection Timeout in the Classic Load Balancers Guide.

" + }, + "AdditionalAttributes":{ + "shape":"AdditionalAttributes", + "documentation":"

This parameter is reserved.

" + } + }, + "documentation":"

The attributes for a load balancer.

" + }, + "LoadBalancerDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

The DNS name of the load balancer.

" + }, + "CanonicalHostedZoneName":{ + "shape":"DNSName", + "documentation":"

The DNS name of the load balancer.

For more information, see Configure a Custom Domain Name in the Classic Load Balancers Guide.

" + }, + "CanonicalHostedZoneNameID":{ + "shape":"DNSName", + "documentation":"

The ID of the Amazon Route 53 hosted zone for the load balancer.

" + }, + "ListenerDescriptions":{ + "shape":"ListenerDescriptions", + "documentation":"

The listeners for the load balancer.

" + }, + "Policies":{ + "shape":"Policies", + "documentation":"

The policies defined for the load balancer.

" + }, + "BackendServerDescriptions":{ + "shape":"BackendServerDescriptions", + "documentation":"

Information about your EC2 instances.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The Availability Zones for the load balancer.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the subnets for the load balancer.

" + }, + "VPCId":{ + "shape":"VPCId", + "documentation":"

The ID of the VPC for the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

The IDs of the instances for the load balancer.

" + }, + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

Information about the health checks conducted on the load balancer.

" + }, + "SourceSecurityGroup":{ + "shape":"SourceSecurityGroup", + "documentation":"

The security group for the load balancer, which you can use as part of your inbound rules for your registered instances. To only allow traffic from load balancers, add a security group rule that specifies this source security group as the inbound source.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The security groups for the load balancer. Valid only for load balancers in a VPC.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

The date and time the load balancer was created.

" + }, + "Scheme":{ + "shape":"LoadBalancerScheme", + "documentation":"

The type of load balancer. Valid only for load balancers in a VPC.

If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address.

If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.

" + } + }, + "documentation":"

Information about a load balancer.

" + }, + "LoadBalancerDescriptions":{ + "type":"list", + "member":{"shape":"LoadBalancerDescription"} + }, + "LoadBalancerNames":{ + "type":"list", + "member":{"shape":"AccessPointName"} + }, + "LoadBalancerNamesMax20":{ + "type":"list", + "member":{"shape":"AccessPointName"}, + "max":20, + "min":1 + }, + "LoadBalancerScheme":{"type":"string"}, + "Marker":{"type":"string"}, + "Max":{"type":"string"}, + "ModifyLoadBalancerAttributesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerAttributes" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerAttributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

The attributes for the load balancer.

" + } + }, + "documentation":"

Contains the parameters for ModifyLoadBalancerAttributes.

" + }, + "ModifyLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerAttributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

Information about the load balancer attributes.

" + } + }, + "documentation":"

Contains the output of ModifyLoadBalancerAttributes.

" + }, + "Name":{"type":"string"}, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This operation is not allowed.

", + "error":{ + "code":"OperationNotPermitted", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PageSize":{ + "type":"integer", + "max":400, + "min":1 + }, + "Policies":{ + "type":"structure", + "members":{ + "AppCookieStickinessPolicies":{ + "shape":"AppCookieStickinessPolicies", + "documentation":"

The stickiness policies created using CreateAppCookieStickinessPolicy.

" + }, + "LBCookieStickinessPolicies":{ + "shape":"LBCookieStickinessPolicies", + "documentation":"

The stickiness policies created using CreateLBCookieStickinessPolicy.

" + }, + "OtherPolicies":{ + "shape":"PolicyNames", + "documentation":"

The policies other than the stickiness policies.

" + } + }, + "documentation":"

The policies for a load balancer.

" + }, + "PolicyAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + }, + "AttributeValue":{ + "shape":"AttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Information about a policy attribute.

" + }, + "PolicyAttributeDescription":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + }, + "AttributeValue":{ + "shape":"AttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Information about a policy attribute.

" + }, + "PolicyAttributeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyAttributeDescription"} + }, + "PolicyAttributeTypeDescription":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute.

" + }, + "AttributeType":{ + "shape":"AttributeType", + "documentation":"

The type of the attribute. For example, Boolean or Integer.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the attribute.

" + }, + "DefaultValue":{ + "shape":"DefaultValue", + "documentation":"

The default value of the attribute, if applicable.

" + }, + "Cardinality":{ + "shape":"Cardinality", + "documentation":"

The cardinality of the attribute.

Valid values:

  • ONE(1) : Single value required

  • ZERO_OR_ONE(0..1) : Up to one value is allowed

  • ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed

  • ONE_OR_MORE(1..*0) : Required. Multiple values are allowed

" + } + }, + "documentation":"

Information about a policy attribute type.

" + }, + "PolicyAttributeTypeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyAttributeTypeDescription"} + }, + "PolicyAttributes":{ + "type":"list", + "member":{"shape":"PolicyAttribute"} + }, + "PolicyDescription":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

" + }, + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the policy type.

" + }, + "PolicyAttributeDescriptions":{ + "shape":"PolicyAttributeDescriptions", + "documentation":"

The policy attributes.

" + } + }, + "documentation":"

Information about a policy.

" + }, + "PolicyDescriptions":{ + "type":"list", + "member":{"shape":"PolicyDescription"} + }, + "PolicyName":{"type":"string"}, + "PolicyNames":{ + "type":"list", + "member":{"shape":"PolicyName"} + }, + "PolicyNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more of the specified policies do not exist.

", + "error":{ + "code":"PolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PolicyTypeDescription":{ + "type":"structure", + "members":{ + "PolicyTypeName":{ + "shape":"PolicyTypeName", + "documentation":"

The name of the policy type.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the policy type.

" + }, + "PolicyAttributeTypeDescriptions":{ + "shape":"PolicyAttributeTypeDescriptions", + "documentation":"

The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

" + } + }, + "documentation":"

Information about a policy type.

" + }, + "PolicyTypeDescriptions":{ + "type":"list", + "member":{"shape":"PolicyTypeDescription"} + }, + "PolicyTypeName":{"type":"string"}, + "PolicyTypeNames":{ + "type":"list", + "member":{"shape":"PolicyTypeName"} + }, + "PolicyTypeNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more of the specified policy types do not exist.

", + "error":{ + "code":"PolicyTypeNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Ports":{ + "type":"list", + "member":{"shape":"AccessPointPort"} + }, + "Protocol":{"type":"string"}, + "ReasonCode":{"type":"string"}, + "RegisterEndPointsInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "Instances" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Instances":{ + "shape":"Instances", + "documentation":"

The IDs of the instances.

" + } + }, + "documentation":"

Contains the parameters for RegisterInstancesWithLoadBalancer.

" + }, + "RegisterEndPointsOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

The updated list of instances for the load balancer.

" + } + }, + "documentation":"

Contains the output of RegisterInstancesWithLoadBalancer.

" + }, + "RemoveAvailabilityZonesInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "AvailabilityZones" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The Availability Zones.

" + } + }, + "documentation":"

Contains the parameters for DisableAvailabilityZonesForLoadBalancer.

" + }, + "RemoveAvailabilityZonesOutput":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The remaining Availability Zones for the load balancer.

" + } + }, + "documentation":"

Contains the output for DisableAvailabilityZonesForLoadBalancer.

" + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "LoadBalancerNames", + "Tags" + ], + "members":{ + "LoadBalancerNames":{ + "shape":"LoadBalancerNames", + "documentation":"

The name of the load balancer. You can specify a maximum of one load balancer name.

" + }, + "Tags":{ + "shape":"TagKeyList", + "documentation":"

The list of tag keys to remove.

" + } + }, + "documentation":"

Contains the parameters for RemoveTags.

" + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of RemoveTags.

" + }, + "S3BucketName":{"type":"string"}, + "SSLCertificateId":{"type":"string"}, + "SecurityGroupId":{"type":"string"}, + "SecurityGroupName":{"type":"string"}, + "SecurityGroupOwnerAlias":{"type":"string"}, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroupId"} + }, + "SetLoadBalancerListenerSSLCertificateInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPort", + "SSLCertificateId" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

The port that uses the specified SSL certificate.

" + }, + "SSLCertificateId":{ + "shape":"SSLCertificateId", + "documentation":"

The Amazon Resource Name (ARN) of the SSL certificate.

" + } + }, + "documentation":"

Contains the parameters for SetLoadBalancerListenerSSLCertificate.

" + }, + "SetLoadBalancerListenerSSLCertificateOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of SetLoadBalancerListenerSSLCertificate.

" + }, + "SetLoadBalancerPoliciesForBackendServerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "InstancePort", + "PolicyNames" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "InstancePort":{ + "shape":"EndPointPort", + "documentation":"

The port number associated with the EC2 instance.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of the policies. If the list is empty, then all current polices are removed from the EC2 instance.

" + } + }, + "documentation":"

Contains the parameters for SetLoadBalancerPoliciesForBackendServer.

" + }, + "SetLoadBalancerPoliciesForBackendServerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of SetLoadBalancerPoliciesForBackendServer.

" + }, + "SetLoadBalancerPoliciesOfListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerName", + "LoadBalancerPort", + "PolicyNames" + ], + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "LoadBalancerPort":{ + "shape":"AccessPointPort", + "documentation":"

The external port of the load balancer.

" + }, + "PolicyNames":{ + "shape":"PolicyNames", + "documentation":"

The names of the policies. This list must include all policies to be enabled. If you omit a policy that is currently enabled, it is disabled. If the list is empty, all current policies are disabled.

" + } + }, + "documentation":"

Contains the parameters for SetLoadBalancePoliciesOfListener.

" + }, + "SetLoadBalancerPoliciesOfListenerOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Contains the output of SetLoadBalancePoliciesOfListener.

" + }, + "SourceSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerAlias":{ + "shape":"SecurityGroupOwnerAlias", + "documentation":"

The owner of the security group.

" + }, + "GroupName":{ + "shape":"SecurityGroupName", + "documentation":"

The name of the security group.

" + } + }, + "documentation":"

Information about a source security group.

" + }, + "State":{"type":"string"}, + "SubnetId":{"type":"string"}, + "SubnetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

One or more of the specified subnets do not exist.

", + "error":{ + "code":"SubnetNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Information about a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "LoadBalancerName":{ + "shape":"AccessPointName", + "documentation":"

The name of the load balancer.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags.

" + } + }, + "documentation":"

The tags associated with a load balancer.

" + }, + "TagDescriptions":{ + "type":"list", + "member":{"shape":"TagDescription"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKeyOnly"}, + "min":1 + }, + "TagKeyOnly":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The name of the key.

" + } + }, + "documentation":"

The key of a tag.

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TooManyAccessPointsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The quota for the number of load balancers has been reached.

", + "error":{ + "code":"TooManyLoadBalancers", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyPoliciesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The quota for the number of policies for this load balancer has been reached.

", + "error":{ + "code":"TooManyPolicies", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The quota for the number of tags that can be assigned to a load balancer has been reached.

", + "error":{ + "code":"TooManyTags", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnhealthyThreshold":{ + "type":"integer", + "max":10, + "min":2 + }, + "UnsupportedProtocolException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified protocol or signature version is not supported.

", + "error":{ + "code":"UnsupportedProtocol", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VPCId":{"type":"string"} + }, + "documentation":"Elastic Load Balancing

A load balancer can distribute incoming traffic across your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered instances and ensures that it routes traffic only to healthy instances. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer and a protocol and port number for connections from the load balancer to the instances.

Elastic Load Balancing supports three types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. You can select a load balancer based on your application needs. For more information, see the Elastic Load Balancing User Guide.

This reference covers the 2012-06-01 API, which supports Classic Load Balancers. The 2015-12-01 API supports Application Load Balancers and Network Load Balancers.

To get started, create a load balancer with one or more listeners using CreateLoadBalancer. Register your instances with the load balancer using RegisterInstancesWithLoadBalancer.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds with a 200 OK response code.

" +} diff --git a/aws/dist/botocore/data/elb/2012-06-01/waiters-2.json b/aws/dist/botocore/data/elb/2012-06-01/waiters-2.json new file mode 100644 index 00000000..182e070b --- /dev/null +++ b/aws/dist/botocore/data/elb/2012-06-01/waiters-2.json @@ -0,0 +1,54 @@ +{ + "version":2, + "waiters":{ + "InstanceDeregistered": { + "delay": 15, + "operation": "DescribeInstanceHealth", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "OutOfService", + "matcher": "pathAll", + "state": "success", + "argument": "InstanceStates[].State" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "success" + } + ] + }, + "AnyInstanceInService":{ + "acceptors":[ + { + "argument":"InstanceStates[].State", + "expected":"InService", + "matcher":"pathAny", + "state":"success" + } + ], + "delay":15, + "maxAttempts":40, + "operation":"DescribeInstanceHealth" + }, + "InstanceInService":{ + "acceptors":[ + { + "argument":"InstanceStates[].State", + "expected":"InService", + "matcher":"pathAll", + "state":"success" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "retry" + } + ], + "delay":15, + "maxAttempts":40, + "operation":"DescribeInstanceHealth" + } + } +} diff --git a/aws/dist/botocore/data/elbv2/2015-12-01/examples-1.json b/aws/dist/botocore/data/elbv2/2015-12-01/examples-1.json new file mode 100644 index 00000000..508b0991 --- /dev/null +++ b/aws/dist/botocore/data/elbv2/2015-12-01/examples-1.json @@ -0,0 +1,1384 @@ +{ + "version": "1.0", + "examples": { + "AddTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified tags to the specified load balancer.", + "id": "elbv2-add-tags-1", + "title": "To add tags to a load balancer" + } + ], + "CreateListener": [ + { + "input": { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.", + "id": "elbv2-create-listener-1", + "title": "To create an HTTP listener" + }, + { + "input": { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + }, + "output": { + "Listeners": [ + { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).", + "id": "elbv2-create-listener-2", + "title": "To create an HTTPS listener" + } + ], + "CreateLoadBalancer": [ + { + "input": { + "Name": "my-load-balancer", + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:26:12.920Z", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "LoadBalancerName": "my-load-balancer", + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "provisioning" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.", + "id": "elbv2-create-load-balancer-1", + "title": "To create an Internet-facing load balancer" + }, + { + "input": { + "Name": "my-internal-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + + ], + "Subnets": [ + "subnet-b7d581c0", + "subnet-8360a9e7" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:29:48.850Z", + "DNSName": "internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2", + "LoadBalancerName": "my-internal-load-balancer", + "Scheme": "internal", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "provisioning" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an internal load balancer and enables the Availability Zones for the specified subnets.", + "id": "elbv2-create-load-balancer-2", + "title": "To create an internal load balancer" + } + ], + "CreateRule": [ + { + "input": { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "Priority": 10 + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a rule that forwards requests to the specified target group if the URL contains the specified pattern (for example, /img/*).", + "id": "elbv2-create-rule-1", + "title": "To create a rule" + } + ], + "CreateTargetGroup": [ + { + "input": { + "Name": "my-targets", + "Port": 80, + "Protocol": "HTTP", + "VpcId": "vpc-3ac0fb5f" + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPath": "/", + "HealthCheckPort": "traffic-port", + "HealthCheckProtocol": "HTTP", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "Matcher": { + "HttpCode": "200" + }, + "Port": 80, + "Protocol": "HTTP", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "TargetGroupName": "my-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a target group that you can use to route traffic to targets using HTTP on port 80. This target group uses the default health check configuration.", + "id": "elbv2-create-target-group-1", + "title": "To create a target group" + } + ], + "DeleteListener": [ + { + "input": { + "ListenerArn": "arn:aws:elasticloadbalancing:ua-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified listener.", + "id": "elbv2-delete-listener-1", + "title": "To delete a listener" + } + ], + "DeleteLoadBalancer": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified load balancer.", + "id": "elbv2-delete-load-balancer-1", + "title": "To delete a load balancer" + } + ], + "DeleteRule": [ + { + "input": { + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified rule.", + "id": "elbv2-delete-rule-1", + "title": "To delete a rule" + } + ], + "DeleteTargetGroup": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified target group.", + "id": "elbv2-delete-target-group-1", + "title": "To delete a target group" + } + ], + "DeregisterTargets": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deregisters the specified instance from the specified target group.", + "id": "elbv2-deregister-targets-1", + "title": "To deregister a target from a target group" + } + ], + "DescribeListeners": [ + { + "input": { + "ListenerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + ] + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified listener.", + "id": "elbv2-describe-listeners-1", + "title": "To describe a listener" + } + ], + "DescribeLoadBalancerAttributes": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "deletion_protection.enabled", + "Value": "false" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified load balancer.", + "id": "elbv2-describe-load-balancer-attributes-1", + "title": "To describe load balancer attributes" + } + ], + "DescribeLoadBalancers": [ + { + "input": { + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ] + }, + "output": { + "LoadBalancers": [ + { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ], + "CanonicalHostedZoneId": "Z2P70J7EXAMPLE", + "CreatedTime": "2016-03-25T21:26:12.920Z", + "DNSName": "my-load-balancer-424835706.us-west-2.elb.amazonaws.com", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "LoadBalancerName": "my-load-balancer", + "Scheme": "internet-facing", + "SecurityGroups": [ + "sg-5943793c" + ], + "State": { + "Code": "active" + }, + "Type": "application", + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified load balancer.", + "id": "elbv2-describe-load-balancers-1", + "title": "To describe a load balancer" + } + ], + "DescribeRules": [ + { + "input": { + "RuleArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + ] + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified rule.", + "id": "elbv2-describe-rules-1", + "title": "To describe a rule" + } + ], + "DescribeSSLPolicies": [ + { + "input": { + "Names": [ + "ELBSecurityPolicy-2015-05" + ] + }, + "output": { + "SslPolicies": [ + { + "Ciphers": [ + { + "Name": "ECDHE-ECDSA-AES128-GCM-SHA256", + "Priority": 1 + }, + { + "Name": "ECDHE-RSA-AES128-GCM-SHA256", + "Priority": 2 + }, + { + "Name": "ECDHE-ECDSA-AES128-SHA256", + "Priority": 3 + }, + { + "Name": "ECDHE-RSA-AES128-SHA256", + "Priority": 4 + }, + { + "Name": "ECDHE-ECDSA-AES128-SHA", + "Priority": 5 + }, + { + "Name": "ECDHE-RSA-AES128-SHA", + "Priority": 6 + }, + { + "Name": "DHE-RSA-AES128-SHA", + "Priority": 7 + }, + { + "Name": "ECDHE-ECDSA-AES256-GCM-SHA384", + "Priority": 8 + }, + { + "Name": "ECDHE-RSA-AES256-GCM-SHA384", + "Priority": 9 + }, + { + "Name": "ECDHE-ECDSA-AES256-SHA384", + "Priority": 10 + }, + { + "Name": "ECDHE-RSA-AES256-SHA384", + "Priority": 11 + }, + { + "Name": "ECDHE-RSA-AES256-SHA", + "Priority": 12 + }, + { + "Name": "ECDHE-ECDSA-AES256-SHA", + "Priority": 13 + }, + { + "Name": "AES128-GCM-SHA256", + "Priority": 14 + }, + { + "Name": "AES128-SHA256", + "Priority": 15 + }, + { + "Name": "AES128-SHA", + "Priority": 16 + }, + { + "Name": "AES256-GCM-SHA384", + "Priority": 17 + }, + { + "Name": "AES256-SHA256", + "Priority": 18 + }, + { + "Name": "AES256-SHA", + "Priority": 19 + } + ], + "Name": "ELBSecurityPolicy-2015-05", + "SslProtocols": [ + "TLSv1", + "TLSv1.1", + "TLSv1.2" + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified policy used for SSL negotiation.", + "id": "elbv2-describe-ssl-policies-1", + "title": "To describe a policy used for SSL negotiation" + } + ], + "DescribeTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ] + }, + "output": { + "TagDescriptions": [ + { + "ResourceArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Tags": [ + { + "Key": "project", + "Value": "lima" + }, + { + "Key": "department", + "Value": "digital-media" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the tags assigned to the specified load balancer.", + "id": "elbv2-describe-tags-1", + "title": "To describe the tags assigned to a load balancer" + } + ], + "DescribeTargetGroupAttributes": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "Attributes": [ + { + "Key": "stickiness.enabled", + "Value": "false" + }, + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "300" + }, + { + "Key": "stickiness.type", + "Value": "lb_cookie" + }, + { + "Key": "stickiness.lb_cookie.duration_seconds", + "Value": "86400" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the attributes of the specified target group.", + "id": "elbv2-describe-target-group-attributes-1", + "title": "To describe target group attributes" + } + ], + "DescribeTargetGroups": [ + { + "input": { + "TargetGroupArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + ] + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPath": "/", + "HealthCheckPort": "traffic-port", + "HealthCheckProtocol": "HTTP", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Matcher": { + "HttpCode": "200" + }, + "Port": 80, + "Protocol": "HTTP", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "TargetGroupName": "my-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the specified target group.", + "id": "elbv2-describe-target-groups-1", + "title": "To describe a target group" + } + ], + "DescribeTargetHealth": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "TargetHealthDescriptions": [ + { + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "Description": "Given target group is not configured to receive traffic from ELB", + "Reason": "Target.NotInUse", + "State": "unused" + } + }, + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the targets for the specified target group. One target is healthy but the other is not specified in an action, so it can't receive traffic from the load balancer.", + "id": "elbv2-describe-target-health-1", + "title": "To describe the health of the targets for a target group" + }, + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-0f76fade", + "Port": 80 + } + ] + }, + "output": { + "TargetHealthDescriptions": [ + { + "HealthCheckPort": "80", + "Target": { + "Id": "i-0f76fade", + "Port": 80 + }, + "TargetHealth": { + "State": "healthy" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example describes the health of the specified target. This target is healthy.", + "id": "elbv2-describe-target-health-2", + "title": "To describe the health of a target" + } + ], + "ModifyListener": [ + { + "input": { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2" + }, + "output": { + "Listeners": [ + { + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 80, + "Protocol": "HTTP" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the default action for the specified listener.", + "id": "elbv2-modify-listener-1", + "title": "To change the default action for a listener" + }, + { + "input": { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65" + }, + "output": { + "Listeners": [ + { + "Certificates": [ + { + "CertificateArn": "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" + } + ], + "DefaultActions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "ListenerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65", + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Port": 443, + "Protocol": "HTTPS", + "SslPolicy": "ELBSecurityPolicy-2015-05" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the server certificate for the specified HTTPS listener.", + "id": "elbv2-modify-listener-2", + "title": "To change the server certificate" + } + ], + "ModifyLoadBalancerAttributes": [ + { + "input": { + "Attributes": [ + { + "Key": "deletion_protection.enabled", + "Value": "true" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "deletion_protection.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables deletion protection for the specified load balancer.", + "id": "elbv2-modify-load-balancer-attributes-1", + "title": "To enable deletion protection" + }, + { + "input": { + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "idle_timeout.timeout_seconds", + "Value": "30" + }, + { + "Key": "access_logs.s3.enabled", + "Value": "false" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "" + }, + { + "Key": "deletion_protection.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the idle timeout value for the specified load balancer.", + "id": "elbv2-modify-load-balancer-attributes-2", + "title": "To change the idle timeout" + }, + { + "input": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-loadbalancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + } + ], + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + }, + "output": { + "Attributes": [ + { + "Key": "access_logs.s3.enabled", + "Value": "true" + }, + { + "Key": "access_logs.s3.bucket", + "Value": "my-load-balancer-logs" + }, + { + "Key": "access_logs.s3.prefix", + "Value": "myapp" + }, + { + "Key": "idle_timeout.timeout_seconds", + "Value": "60" + }, + { + "Key": "deletion_protection.enabled", + "Value": "false" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables access logs for the specified load balancer. Note that the S3 bucket must exist in the same region as the load balancer and must have a policy attached that grants access to the Elastic Load Balancing service.", + "id": "elbv2-modify-load-balancer-attributes-3", + "title": "To enable access logs" + } + ], + "ModifyRule": [ + { + "input": { + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/images/*" + ] + } + ], + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/images/*" + ] + } + ], + "IsDefault": false, + "Priority": "10", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/9683b2d02a6cabee" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example modifies the condition for the specified rule.", + "id": "elbv2-modify-rule-1", + "title": "To modify a rule" + } + ], + "ModifyTargetGroup": [ + { + "input": { + "HealthCheckPort": "443", + "HealthCheckProtocol": "HTTPS", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f" + }, + "output": { + "TargetGroups": [ + { + "HealthCheckIntervalSeconds": 30, + "HealthCheckPort": "443", + "HealthCheckProtocol": "HTTPS", + "HealthCheckTimeoutSeconds": 5, + "HealthyThresholdCount": 5, + "LoadBalancerArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "Matcher": { + "HttpCode": "200" + }, + "Port": 443, + "Protocol": "HTTPS", + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-https-targets/2453ed029918f21f", + "TargetGroupName": "my-https-targets", + "UnhealthyThresholdCount": 2, + "VpcId": "vpc-3ac0fb5f" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the configuration of the health checks used to evaluate the health of the targets for the specified target group.", + "id": "elbv2-modify-target-group-1", + "title": "To modify the health check configuration for a target group" + } + ], + "ModifyTargetGroupAttributes": [ + { + "input": { + "Attributes": [ + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "600" + } + ], + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067" + }, + "output": { + "Attributes": [ + { + "Key": "stickiness.enabled", + "Value": "false" + }, + { + "Key": "deregistration_delay.timeout_seconds", + "Value": "600" + }, + { + "Key": "stickiness.type", + "Value": "lb_cookie" + }, + { + "Key": "stickiness.lb_cookie.duration_seconds", + "Value": "86400" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the deregistration delay timeout to the specified value for the specified target group.", + "id": "elbv2-modify-target-group-attributes-1", + "title": "To modify the deregistration delay timeout" + } + ], + "RegisterTargets": [ + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Targets": [ + { + "Id": "i-80c8dd94" + }, + { + "Id": "i-ceddcd4d" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instances with the specified target group.", + "id": "elbv2-register-targets-1", + "title": "To register targets with a target group" + }, + { + "input": { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/3bb63f11dfb0faf9", + "Targets": [ + { + "Id": "i-80c8dd94", + "Port": 80 + }, + { + "Id": "i-80c8dd94", + "Port": 766 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example registers the specified instance with the specified target group using multiple ports. This enables you to register ECS containers on the same instance as targets in the target group.", + "id": "elbv2-register-targets-2", + "title": "To register targets with a target group using port overrides" + } + ], + "RemoveTags": [ + { + "input": { + "ResourceArns": [ + "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188" + ], + "TagKeys": [ + "project", + "department" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified tags from the specified load balancer.", + "id": "elbv2-remove-tags-1", + "title": "To remove tags from a load balancer" + } + ], + "SetRulePriorities": [ + { + "input": { + "RulePriorities": [ + { + "Priority": 5, + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + } + ] + }, + "output": { + "Rules": [ + { + "Actions": [ + { + "TargetGroupArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067", + "Type": "forward" + } + ], + "Conditions": [ + { + "Field": "path-pattern", + "Values": [ + "/img/*" + ] + } + ], + "IsDefault": false, + "Priority": "5", + "RuleArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener-rule/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2/1291d13826f405c3" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example sets the priority of the specified rule.", + "id": "elbv2-set-rule-priorities-1", + "title": "To set the rule priority" + } + ], + "SetSecurityGroups": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "SecurityGroups": [ + "sg-5943793c" + ] + }, + "output": { + "SecurityGroupIds": [ + "sg-5943793c" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example associates the specified security group with the specified load balancer.", + "id": "elbv2-set-security-groups-1", + "title": "To associate a security group with a load balancer" + } + ], + "SetSubnets": [ + { + "input": { + "LoadBalancerArn": "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188", + "Subnets": [ + "subnet-8360a9e7", + "subnet-b7d581c0" + ] + }, + "output": { + "AvailabilityZones": [ + { + "SubnetId": "subnet-8360a9e7", + "ZoneName": "us-west-2a" + }, + { + "SubnetId": "subnet-b7d581c0", + "ZoneName": "us-west-2b" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example enables the Availability Zones for the specified subnets for the specified load balancer.", + "id": "elbv2-set-subnets-1", + "title": "To enable Availability Zones for a load balancer" + } + ] + } +} diff --git a/aws/dist/botocore/data/elbv2/2015-12-01/paginators-1.json b/aws/dist/botocore/data/elbv2/2015-12-01/paginators-1.json new file mode 100644 index 00000000..4521f5c2 --- /dev/null +++ b/aws/dist/botocore/data/elbv2/2015-12-01/paginators-1.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "DescribeLoadBalancers": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "PageSize", + "result_key": "LoadBalancers" + }, + "DescribeTargetGroups": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "PageSize", + "result_key": "TargetGroups" + }, + "DescribeListeners": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "PageSize", + "result_key": "Listeners" + }, + "DescribeAccountLimits": { + "input_token": "Marker", + "limit_key": "PageSize", + "output_token": "NextMarker", + "result_key": "Limits" + }, + "DescribeListenerCertificates": { + "input_token": "Marker", + "limit_key": "PageSize", + "output_token": "NextMarker", + "result_key": "Certificates" + }, + "DescribeRules": { + "input_token": "Marker", + "limit_key": "PageSize", + "output_token": "NextMarker", + "result_key": "Rules" + }, + "DescribeSSLPolicies": { + "input_token": "Marker", + "limit_key": "PageSize", + "output_token": "NextMarker", + "result_key": "SslPolicies" + } + } +} diff --git a/aws/dist/botocore/data/elbv2/2015-12-01/service-2.json b/aws/dist/botocore/data/elbv2/2015-12-01/service-2.json new file mode 100644 index 00000000..b94c58a7 --- /dev/null +++ b/aws/dist/botocore/data/elbv2/2015-12-01/service-2.json @@ -0,0 +1,3219 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-12-01", + "endpointPrefix":"elasticloadbalancing", + "protocol":"query", + "serviceAbbreviation":"Elastic Load Balancing v2", + "serviceFullName":"Elastic Load Balancing", + "serviceId":"Elastic Load Balancing v2", + "signatureVersion":"v4", + "uid":"elasticloadbalancingv2-2015-12-01", + "xmlNamespace":"http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" + }, + "operations":{ + "AddListenerCertificates":{ + "name":"AddListenerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddListenerCertificatesInput"}, + "output":{ + "shape":"AddListenerCertificatesOutput", + "resultWrapper":"AddListenerCertificatesResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"}, + {"shape":"TooManyCertificatesException"}, + {"shape":"CertificateNotFoundException"} + ], + "documentation":"

Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener.

For more information, see SSL Certificates in the Application Load Balancers Guide.

" + }, + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{ + "shape":"AddTagsOutput", + "resultWrapper":"AddTagsResult" + }, + "errors":[ + {"shape":"DuplicateTagKeysException"}, + {"shape":"TooManyTagsException"}, + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"} + ], + "documentation":"

Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, and your target groups.

Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.

" + }, + "CreateListener":{ + "name":"CreateListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateListenerInput"}, + "output":{ + "shape":"CreateListenerOutput", + "resultWrapper":"CreateListenerResult" + }, + "errors":[ + {"shape":"DuplicateListenerException"}, + {"shape":"TooManyListenersException"}, + {"shape":"TooManyCertificatesException"}, + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"TargetGroupAssociationLimitException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"IncompatibleProtocolsException"}, + {"shape":"SSLPolicyNotFoundException"}, + {"shape":"CertificateNotFoundException"}, + {"shape":"UnsupportedProtocolException"}, + {"shape":"TooManyRegistrationsForTargetIdException"}, + {"shape":"TooManyTargetsException"}, + {"shape":"TooManyActionsException"}, + {"shape":"InvalidLoadBalancerActionException"} + ], + "documentation":"

Creates a listener for the specified Application Load Balancer or Network Load Balancer.

To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.

" + }, + "CreateLoadBalancer":{ + "name":"CreateLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerInput"}, + "output":{ + "shape":"CreateLoadBalancerOutput", + "resultWrapper":"CreateLoadBalancerResult" + }, + "errors":[ + {"shape":"DuplicateLoadBalancerNameException"}, + {"shape":"TooManyLoadBalancersException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"SubnetNotFoundException"}, + {"shape":"InvalidSubnetException"}, + {"shape":"InvalidSecurityGroupException"}, + {"shape":"InvalidSchemeException"}, + {"shape":"TooManyTagsException"}, + {"shape":"DuplicateTagKeysException"}, + {"shape":"ResourceInUseException"}, + {"shape":"AllocationIdNotFoundException"}, + {"shape":"AvailabilityZoneNotSupportedException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Creates an Application Load Balancer or a Network Load Balancer.

When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.

To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide.

" + }, + "CreateRule":{ + "name":"CreateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleInput"}, + "output":{ + "shape":"CreateRuleOutput", + "resultWrapper":"CreateRuleResult" + }, + "errors":[ + {"shape":"PriorityInUseException"}, + {"shape":"TooManyTargetGroupsException"}, + {"shape":"TooManyRulesException"}, + {"shape":"TargetGroupAssociationLimitException"}, + {"shape":"IncompatibleProtocolsException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"TooManyRegistrationsForTargetIdException"}, + {"shape":"TooManyTargetsException"}, + {"shape":"UnsupportedProtocolException"}, + {"shape":"TooManyActionsException"}, + {"shape":"InvalidLoadBalancerActionException"} + ], + "documentation":"

Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.

To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

" + }, + "CreateTargetGroup":{ + "name":"CreateTargetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTargetGroupInput"}, + "output":{ + "shape":"CreateTargetGroupOutput", + "resultWrapper":"CreateTargetGroupResult" + }, + "errors":[ + {"shape":"DuplicateTargetGroupNameException"}, + {"shape":"TooManyTargetGroupsException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Creates a target group.

To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

To delete a target group, use DeleteTargetGroup.

This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

" + }, + "DeleteListener":{ + "name":"DeleteListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteListenerInput"}, + "output":{ + "shape":"DeleteListenerOutput", + "resultWrapper":"DeleteListenerResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"} + ], + "documentation":"

Deletes the specified listener.

Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.

" + }, + "DeleteLoadBalancer":{ + "name":"DeleteLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoadBalancerInput"}, + "output":{ + "shape":"DeleteLoadBalancerOutput", + "resultWrapper":"DeleteLoadBalancerResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.

You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

" + }, + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleInput"}, + "output":{ + "shape":"DeleteRuleOutput", + "resultWrapper":"DeleteRuleResult" + }, + "errors":[ + {"shape":"RuleNotFoundException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Deletes the specified rule.

" + }, + "DeleteTargetGroup":{ + "name":"DeleteTargetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTargetGroupInput"}, + "output":{ + "shape":"DeleteTargetGroupOutput", + "resultWrapper":"DeleteTargetGroupResult" + }, + "errors":[ + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes the specified target group.

You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.

" + }, + "DeregisterTargets":{ + "name":"DeregisterTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterTargetsInput"}, + "output":{ + "shape":"DeregisterTargetsOutput", + "resultWrapper":"DeregisterTargetsResult" + }, + "errors":[ + {"shape":"TargetGroupNotFoundException"}, + {"shape":"InvalidTargetException"} + ], + "documentation":"

Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

" + }, + "DescribeAccountLimits":{ + "name":"DescribeAccountLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountLimitsInput"}, + "output":{ + "shape":"DescribeAccountLimitsOutput", + "resultWrapper":"DescribeAccountLimitsResult" + }, + "documentation":"

Describes the current Elastic Load Balancing resource limits for your AWS account.

For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.

" + }, + "DescribeListenerCertificates":{ + "name":"DescribeListenerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeListenerCertificatesInput"}, + "output":{ + "shape":"DescribeListenerCertificatesOutput", + "resultWrapper":"DescribeListenerCertificatesResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"} + ], + "documentation":"

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL Certificates in the Application Load Balancers Guide.

" + }, + "DescribeListeners":{ + "name":"DescribeListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeListenersInput"}, + "output":{ + "shape":"DescribeListenersOutput", + "resultWrapper":"DescribeListenersResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"}, + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"UnsupportedProtocolException"} + ], + "documentation":"

Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.

For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.

" + }, + "DescribeLoadBalancerAttributes":{ + "name":"DescribeLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancerAttributesInput"}, + "output":{ + "shape":"DescribeLoadBalancerAttributesOutput", + "resultWrapper":"DescribeLoadBalancerAttributesResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"} + ], + "documentation":"

Describes the attributes for the specified Application Load Balancer or Network Load Balancer.

For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.

" + }, + "DescribeLoadBalancers":{ + "name":"DescribeLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBalancersInput"}, + "output":{ + "shape":"DescribeLoadBalancersOutput", + "resultWrapper":"DescribeLoadBalancersResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"} + ], + "documentation":"

Describes the specified load balancers or all of your load balancers.

To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

" + }, + "DescribeRules":{ + "name":"DescribeRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRulesInput"}, + "output":{ + "shape":"DescribeRulesOutput", + "resultWrapper":"DescribeRulesResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"}, + {"shape":"RuleNotFoundException"}, + {"shape":"UnsupportedProtocolException"} + ], + "documentation":"

Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

" + }, + "DescribeSSLPolicies":{ + "name":"DescribeSSLPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSSLPoliciesInput"}, + "output":{ + "shape":"DescribeSSLPoliciesOutput", + "resultWrapper":"DescribeSSLPoliciesResult" + }, + "errors":[ + {"shape":"SSLPolicyNotFoundException"} + ], + "documentation":"

Describes the specified policies or all policies used for SSL negotiation.

For more information, see Security Policies in the Application Load Balancers Guide.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsInput"}, + "output":{ + "shape":"DescribeTagsOutput", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"RuleNotFoundException"} + ], + "documentation":"

Describes the tags for the specified resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, and target groups.

" + }, + "DescribeTargetGroupAttributes":{ + "name":"DescribeTargetGroupAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTargetGroupAttributesInput"}, + "output":{ + "shape":"DescribeTargetGroupAttributesOutput", + "resultWrapper":"DescribeTargetGroupAttributesResult" + }, + "errors":[ + {"shape":"TargetGroupNotFoundException"} + ], + "documentation":"

Describes the attributes for the specified target group.

For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.

" + }, + "DescribeTargetGroups":{ + "name":"DescribeTargetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTargetGroupsInput"}, + "output":{ + "shape":"DescribeTargetGroupsOutput", + "resultWrapper":"DescribeTargetGroupsResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"} + ], + "documentation":"

Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

" + }, + "DescribeTargetHealth":{ + "name":"DescribeTargetHealth", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTargetHealthInput"}, + "output":{ + "shape":"DescribeTargetHealthOutput", + "resultWrapper":"DescribeTargetHealthResult" + }, + "errors":[ + {"shape":"InvalidTargetException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"HealthUnavailableException"} + ], + "documentation":"

Describes the health of the specified targets or all of your targets.

" + }, + "ModifyListener":{ + "name":"ModifyListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyListenerInput"}, + "output":{ + "shape":"ModifyListenerOutput", + "resultWrapper":"ModifyListenerResult" + }, + "errors":[ + {"shape":"DuplicateListenerException"}, + {"shape":"TooManyListenersException"}, + {"shape":"TooManyCertificatesException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"TargetGroupAssociationLimitException"}, + {"shape":"IncompatibleProtocolsException"}, + {"shape":"SSLPolicyNotFoundException"}, + {"shape":"CertificateNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"UnsupportedProtocolException"}, + {"shape":"TooManyRegistrationsForTargetIdException"}, + {"shape":"TooManyTargetsException"}, + {"shape":"TooManyActionsException"}, + {"shape":"InvalidLoadBalancerActionException"} + ], + "documentation":"

Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

" + }, + "ModifyLoadBalancerAttributes":{ + "name":"ModifyLoadBalancerAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyLoadBalancerAttributesInput"}, + "output":{ + "shape":"ModifyLoadBalancerAttributesOutput", + "resultWrapper":"ModifyLoadBalancerAttributesResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.

If any of the specified attributes can't be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

" + }, + "ModifyRule":{ + "name":"ModifyRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyRuleInput"}, + "output":{ + "shape":"ModifyRuleOutput", + "resultWrapper":"ModifyRuleResult" + }, + "errors":[ + {"shape":"TargetGroupAssociationLimitException"}, + {"shape":"IncompatibleProtocolsException"}, + {"shape":"RuleNotFoundException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"TooManyRegistrationsForTargetIdException"}, + {"shape":"TooManyTargetsException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"UnsupportedProtocolException"}, + {"shape":"TooManyActionsException"}, + {"shape":"InvalidLoadBalancerActionException"} + ], + "documentation":"

Modifies the specified rule.

Any existing properties that you do not modify retain their current values.

To modify the actions for the default rule, use ModifyListener.

" + }, + "ModifyTargetGroup":{ + "name":"ModifyTargetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTargetGroupInput"}, + "output":{ + "shape":"ModifyTargetGroupOutput", + "resultWrapper":"ModifyTargetGroupResult" + }, + "errors":[ + {"shape":"TargetGroupNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Modifies the health checks used when evaluating the health state of the targets in the specified target group.

To monitor the health of the targets, use DescribeTargetHealth.

" + }, + "ModifyTargetGroupAttributes":{ + "name":"ModifyTargetGroupAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyTargetGroupAttributesInput"}, + "output":{ + "shape":"ModifyTargetGroupAttributesOutput", + "resultWrapper":"ModifyTargetGroupAttributesResult" + }, + "errors":[ + {"shape":"TargetGroupNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"} + ], + "documentation":"

Modifies the specified attributes of the specified target group.

" + }, + "RegisterTargets":{ + "name":"RegisterTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterTargetsInput"}, + "output":{ + "shape":"RegisterTargetsOutput", + "resultWrapper":"RegisterTargetsResult" + }, + "errors":[ + {"shape":"TargetGroupNotFoundException"}, + {"shape":"TooManyTargetsException"}, + {"shape":"InvalidTargetException"}, + {"shape":"TooManyRegistrationsForTargetIdException"} + ], + "documentation":"

Registers the specified targets with the specified target group.

If the target is an EC2 instance, it must be in the running state when you register it.

By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.

To remove a target from a target group, use DeregisterTargets.

" + }, + "RemoveListenerCertificates":{ + "name":"RemoveListenerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveListenerCertificatesInput"}, + "output":{ + "shape":"RemoveListenerCertificatesOutput", + "resultWrapper":"RemoveListenerCertificatesResult" + }, + "errors":[ + {"shape":"ListenerNotFoundException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

You can't remove the default certificate for a listener. To replace the default certificate, call ModifyListener.

To list the certificates for your listener, use DescribeListenerCertificates.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsInput"}, + "output":{ + "shape":"RemoveTagsOutput", + "resultWrapper":"RemoveTagsResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"TargetGroupNotFoundException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"RuleNotFoundException"}, + {"shape":"TooManyTagsException"} + ], + "documentation":"

Removes the specified tags from the specified Elastic Load Balancing resource.

To list the current tags for your resources, use DescribeTags.

" + }, + "SetIpAddressType":{ + "name":"SetIpAddressType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIpAddressTypeInput"}, + "output":{ + "shape":"SetIpAddressTypeOutput", + "resultWrapper":"SetIpAddressTypeResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"InvalidSubnetException"} + ], + "documentation":"

Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

" + }, + "SetRulePriorities":{ + "name":"SetRulePriorities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetRulePrioritiesInput"}, + "output":{ + "shape":"SetRulePrioritiesOutput", + "resultWrapper":"SetRulePrioritiesResult" + }, + "errors":[ + {"shape":"RuleNotFoundException"}, + {"shape":"PriorityInUseException"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

Sets the priorities of the specified rules.

You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

" + }, + "SetSecurityGroups":{ + "name":"SetSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSecurityGroupsInput"}, + "output":{ + "shape":"SetSecurityGroupsOutput", + "resultWrapper":"SetSecurityGroupsResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"InvalidSecurityGroupException"} + ], + "documentation":"

Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.

You can't specify a security group for a Network Load Balancer.

" + }, + "SetSubnets":{ + "name":"SetSubnets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSubnetsInput"}, + "output":{ + "shape":"SetSubnetsOutput", + "resultWrapper":"SetSubnetsResult" + }, + "errors":[ + {"shape":"LoadBalancerNotFoundException"}, + {"shape":"InvalidConfigurationRequestException"}, + {"shape":"SubnetNotFoundException"}, + {"shape":"InvalidSubnetException"}, + {"shape":"AllocationIdNotFoundException"}, + {"shape":"AvailabilityZoneNotSupportedException"} + ], + "documentation":"

Enables the Availability Zone for the specified public subnets for the specified Application Load Balancer. The specified subnets replace the previously enabled subnets.

You can't change the subnets for a Network Load Balancer.

" + } + }, + "shapes":{ + "Action":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"ActionTypeEnum", + "documentation":"

The type of action. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

" + }, + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group. Specify only when Type is forward.

" + }, + "AuthenticateOidcConfig":{ + "shape":"AuthenticateOidcActionConfig", + "documentation":"

[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when Type is authenticate-oidc.

" + }, + "AuthenticateCognitoConfig":{ + "shape":"AuthenticateCognitoActionConfig", + "documentation":"

[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when Type is authenticate-cognito.

" + }, + "Order":{ + "shape":"ActionOrder", + "documentation":"

The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. The final action to be performed must be a forward or a fixed-response action.

" + }, + "RedirectConfig":{ + "shape":"RedirectActionConfig", + "documentation":"

[Application Load Balancer] Information for creating a redirect action. Specify only when Type is redirect.

" + }, + "FixedResponseConfig":{ + "shape":"FixedResponseActionConfig", + "documentation":"

[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when Type is fixed-response.

" + } + }, + "documentation":"

Information about an action.

" + }, + "ActionOrder":{ + "type":"integer", + "max":50000, + "min":1 + }, + "ActionTypeEnum":{ + "type":"string", + "enum":[ + "forward", + "authenticate-oidc", + "authenticate-cognito", + "redirect", + "fixed-response" + ] + }, + "Actions":{ + "type":"list", + "member":{"shape":"Action"} + }, + "AddListenerCertificatesInput":{ + "type":"structure", + "required":[ + "ListenerArn", + "Certificates" + ], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

The certificate to add. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

" + } + } + }, + "AddListenerCertificatesOutput":{ + "type":"structure", + "members":{ + "Certificates":{ + "shape":"CertificateList", + "documentation":"

Information about the certificates in the certificate list.

" + } + } + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "ResourceArns", + "Tags" + ], + "members":{ + "ResourceArns":{ + "shape":"ResourceArns", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags. Each resource can have a maximum of 10 tags.

" + } + } + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + } + }, + "AllocationId":{"type":"string"}, + "AllocationIdNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified allocation ID does not exist.

", + "error":{ + "code":"AllocationIdNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthenticateCognitoActionAuthenticationRequestExtraParams":{ + "type":"map", + "key":{"shape":"AuthenticateCognitoActionAuthenticationRequestParamName"}, + "value":{"shape":"AuthenticateCognitoActionAuthenticationRequestParamValue"} + }, + "AuthenticateCognitoActionAuthenticationRequestParamName":{"type":"string"}, + "AuthenticateCognitoActionAuthenticationRequestParamValue":{"type":"string"}, + "AuthenticateCognitoActionConditionalBehaviorEnum":{ + "type":"string", + "enum":[ + "deny", + "allow", + "authenticate" + ] + }, + "AuthenticateCognitoActionConfig":{ + "type":"structure", + "required":[ + "UserPoolArn", + "UserPoolClientId", + "UserPoolDomain" + ], + "members":{ + "UserPoolArn":{ + "shape":"AuthenticateCognitoActionUserPoolArn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Cognito user pool.

" + }, + "UserPoolClientId":{ + "shape":"AuthenticateCognitoActionUserPoolClientId", + "documentation":"

The ID of the Amazon Cognito user pool client.

" + }, + "UserPoolDomain":{ + "shape":"AuthenticateCognitoActionUserPoolDomain", + "documentation":"

The domain prefix or fully-qualified domain name of the Amazon Cognito user pool.

" + }, + "SessionCookieName":{ + "shape":"AuthenticateCognitoActionSessionCookieName", + "documentation":"

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" + }, + "Scope":{ + "shape":"AuthenticateCognitoActionScope", + "documentation":"

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

" + }, + "SessionTimeout":{ + "shape":"AuthenticateCognitoActionSessionTimeout", + "documentation":"

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

" + }, + "AuthenticationRequestExtraParams":{ + "shape":"AuthenticateCognitoActionAuthenticationRequestExtraParams", + "documentation":"

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" + }, + "OnUnauthenticatedRequest":{ + "shape":"AuthenticateCognitoActionConditionalBehaviorEnum", + "documentation":"

The behavior if the user is not authenticated. The following are possible values:

  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

" + } + }, + "documentation":"

Request parameters to use when integrating with Amazon Cognito to authenticate users.

" + }, + "AuthenticateCognitoActionScope":{"type":"string"}, + "AuthenticateCognitoActionSessionCookieName":{"type":"string"}, + "AuthenticateCognitoActionSessionTimeout":{"type":"long"}, + "AuthenticateCognitoActionUserPoolArn":{"type":"string"}, + "AuthenticateCognitoActionUserPoolClientId":{"type":"string"}, + "AuthenticateCognitoActionUserPoolDomain":{"type":"string"}, + "AuthenticateOidcActionAuthenticationRequestExtraParams":{ + "type":"map", + "key":{"shape":"AuthenticateOidcActionAuthenticationRequestParamName"}, + "value":{"shape":"AuthenticateOidcActionAuthenticationRequestParamValue"} + }, + "AuthenticateOidcActionAuthenticationRequestParamName":{"type":"string"}, + "AuthenticateOidcActionAuthenticationRequestParamValue":{"type":"string"}, + "AuthenticateOidcActionAuthorizationEndpoint":{"type":"string"}, + "AuthenticateOidcActionClientId":{"type":"string"}, + "AuthenticateOidcActionClientSecret":{"type":"string"}, + "AuthenticateOidcActionConditionalBehaviorEnum":{ + "type":"string", + "enum":[ + "deny", + "allow", + "authenticate" + ] + }, + "AuthenticateOidcActionConfig":{ + "type":"structure", + "required":[ + "Issuer", + "AuthorizationEndpoint", + "TokenEndpoint", + "UserInfoEndpoint", + "ClientId" + ], + "members":{ + "Issuer":{ + "shape":"AuthenticateOidcActionIssuer", + "documentation":"

The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

" + }, + "AuthorizationEndpoint":{ + "shape":"AuthenticateOidcActionAuthorizationEndpoint", + "documentation":"

The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

" + }, + "TokenEndpoint":{ + "shape":"AuthenticateOidcActionTokenEndpoint", + "documentation":"

The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

" + }, + "UserInfoEndpoint":{ + "shape":"AuthenticateOidcActionUserInfoEndpoint", + "documentation":"

The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.

" + }, + "ClientId":{ + "shape":"AuthenticateOidcActionClientId", + "documentation":"

The OAuth 2.0 client identifier.

" + }, + "ClientSecret":{ + "shape":"AuthenticateOidcActionClientSecret", + "documentation":"

The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set UseExistingClientSecret to true.

" + }, + "SessionCookieName":{ + "shape":"AuthenticateOidcActionSessionCookieName", + "documentation":"

The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.

" + }, + "Scope":{ + "shape":"AuthenticateOidcActionScope", + "documentation":"

The set of user claims to be requested from the IdP. The default is openid.

To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP.

" + }, + "SessionTimeout":{ + "shape":"AuthenticateOidcActionSessionTimeout", + "documentation":"

The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).

" + }, + "AuthenticationRequestExtraParams":{ + "shape":"AuthenticateOidcActionAuthenticationRequestExtraParams", + "documentation":"

The query parameters (up to 10) to include in the redirect request to the authorization endpoint.

" + }, + "OnUnauthenticatedRequest":{ + "shape":"AuthenticateOidcActionConditionalBehaviorEnum", + "documentation":"

The behavior if the user is not authenticated. The following are possible values:

  • deny - Return an HTTP 401 Unauthorized error.

  • allow - Allow the request to be forwarded to the target.

  • authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.

" + }, + "UseExistingClientSecret":{ + "shape":"AuthenticateOidcActionUseExistingClientSecret", + "documentation":"

Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false.

" + } + }, + "documentation":"

Request parameters when using an identity provider (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users.

" + }, + "AuthenticateOidcActionIssuer":{"type":"string"}, + "AuthenticateOidcActionScope":{"type":"string"}, + "AuthenticateOidcActionSessionCookieName":{"type":"string"}, + "AuthenticateOidcActionSessionTimeout":{"type":"long"}, + "AuthenticateOidcActionTokenEndpoint":{"type":"string"}, + "AuthenticateOidcActionUseExistingClientSecret":{"type":"boolean"}, + "AuthenticateOidcActionUserInfoEndpoint":{"type":"string"}, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "ZoneName":{ + "shape":"ZoneName", + "documentation":"

The name of the Availability Zone.

" + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet. You can specify one subnet per Availability Zone.

" + }, + "LoadBalancerAddresses":{ + "shape":"LoadBalancerAddresses", + "documentation":"

[Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create the load balancer.

" + } + }, + "documentation":"

Information about an Availability Zone.

" + }, + "AvailabilityZoneNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified Availability Zone is not supported.

", + "error":{ + "code":"AvailabilityZoneNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZone"} + }, + "CanonicalHostedZoneId":{"type":"string"}, + "Certificate":{ + "type":"structure", + "members":{ + "CertificateArn":{ + "shape":"CertificateArn", + "documentation":"

The Amazon Resource Name (ARN) of the certificate.

" + }, + "IsDefault":{ + "shape":"Default", + "documentation":"

Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

" + } + }, + "documentation":"

Information about an SSL server certificate.

" + }, + "CertificateArn":{"type":"string"}, + "CertificateList":{ + "type":"list", + "member":{"shape":"Certificate"} + }, + "CertificateNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified certificate does not exist.

", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Cipher":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CipherName", + "documentation":"

The name of the cipher.

" + }, + "Priority":{ + "shape":"CipherPriority", + "documentation":"

The priority of the cipher.

" + } + }, + "documentation":"

Information about a cipher used in a policy.

" + }, + "CipherName":{"type":"string"}, + "CipherPriority":{"type":"integer"}, + "Ciphers":{ + "type":"list", + "member":{"shape":"Cipher"} + }, + "ConditionFieldName":{ + "type":"string", + "max":64 + }, + "CreateListenerInput":{ + "type":"structure", + "required":[ + "LoadBalancerArn", + "Protocol", + "Port", + "DefaultActions" + ], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "Protocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP.

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

The port on which the load balancer is listening.

" + }, + "SslPolicy":{ + "shape":"SslPolicyName", + "documentation":"

[HTTPS and TLS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list for the listener, use AddListenerCertificates.

" + }, + "DefaultActions":{ + "shape":"Actions", + "documentation":"

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

" + } + } + }, + "CreateListenerOutput":{ + "type":"structure", + "members":{ + "Listeners":{ + "shape":"Listeners", + "documentation":"

Information about the listener.

" + } + } + }, + "CreateLoadBalancerInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LoadBalancerName", + "documentation":"

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with \"internal-\".

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

" + }, + "SubnetMappings":{ + "shape":"SubnetMappings", + "documentation":"

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your load balancer.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

[Application Load Balancers] The IDs of the security groups for the load balancer.

" + }, + "Scheme":{ + "shape":"LoadBalancerSchemeEnum", + "documentation":"

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags to assign to the load balancer.

" + }, + "Type":{ + "shape":"LoadBalancerTypeEnum", + "documentation":"

The type of load balancer. The default is application.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

[Application Load Balancers] The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4.

" + } + } + }, + "CreateLoadBalancerOutput":{ + "type":"structure", + "members":{ + "LoadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

Information about the load balancer.

" + } + } + }, + "CreateRuleInput":{ + "type":"structure", + "required":[ + "ListenerArn", + "Conditions", + "Priority", + "Actions" + ], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "Conditions":{ + "shape":"RuleConditionList", + "documentation":"

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

" + }, + "Priority":{ + "shape":"RulePriority", + "documentation":"

The rule priority. A listener can't have multiple rules with the same priority.

" + }, + "Actions":{ + "shape":"Actions", + "documentation":"

The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

" + } + } + }, + "CreateRuleOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

Information about the rule.

" + } + } + }, + "CreateTargetGroupInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"TargetGroupName", + "documentation":"

The name of the target group.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen.

" + }, + "Protocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol to use for routing traffic to the targets. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group. If the target is a Lambda function, this parameter does not apply.

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

The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. Otherwise, this parameter is required.

" + }, + "HealthCheckProtocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol the load balancer uses when performing health checks on targets. For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port the load balancer uses when performing health checks on targets. The default is traffic-port, which is the port on which each target receives traffic from the load balancer.

" + }, + "HealthCheckEnabled":{ + "shape":"HealthCheckEnabled", + "documentation":"

Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance or ip, health checks are always enabled and cannot be disabled.

" + }, + "HealthCheckPath":{ + "shape":"Path", + "documentation":"

[HTTP/HTTPS health checks] The ping path that is the destination on the targets for health checks. The default is /.

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target. For HTTP and HTTPS health checks, the range is 5–300 seconds. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is instance or ip, the default is 30 seconds. If the target type is lambda, the default is 35 seconds.

" + }, + "HealthCheckTimeoutSeconds":{ + "shape":"HealthCheckTimeoutSeconds", + "documentation":"

The amount of time, in seconds, during which no response from a target means a failed health check. For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks and 10 seconds for TCP and HTTPS health checks. If the target type is lambda, the default is 30 seconds.

" + }, + "HealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For target groups with a protocol of TCP or TLS, the default is 3. If the target type is lambda, the default is 5.

" + }, + "UnhealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health check failures required before considering a target unhealthy. For target groups with a protocol of HTTP or HTTPS, the default is 2. For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count. If the target type is lambda, the default is 2.

" + }, + "Matcher":{ + "shape":"Matcher", + "documentation":"

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

" + }, + "TargetType":{ + "shape":"TargetTypeEnum", + "documentation":"

The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.

  • instance - Targets are specified by instance ID. This is the default value. If the target group protocol is UDP or TCP_UDP, the target type must be instance.

  • ip - Targets are specified by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.

  • lambda - The target groups contains a single Lambda function.

" + } + } + }, + "CreateTargetGroupOutput":{ + "type":"structure", + "members":{ + "TargetGroups":{ + "shape":"TargetGroups", + "documentation":"

Information about the target group.

" + } + } + }, + "CreatedTime":{"type":"timestamp"}, + "DNSName":{"type":"string"}, + "Default":{"type":"boolean"}, + "DeleteListenerInput":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + } + } + }, + "DeleteListenerOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteLoadBalancerInput":{ + "type":"structure", + "required":["LoadBalancerArn"], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + } + } + }, + "DeleteLoadBalancerOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteRuleInput":{ + "type":"structure", + "required":["RuleArn"], + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + } + } + }, + "DeleteRuleOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteTargetGroupInput":{ + "type":"structure", + "required":["TargetGroupArn"], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + } + } + }, + "DeleteTargetGroupOutput":{ + "type":"structure", + "members":{ + } + }, + "DeregisterTargetsInput":{ + "type":"structure", + "required":[ + "TargetGroupArn", + "Targets" + ], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "Targets":{ + "shape":"TargetDescriptions", + "documentation":"

The targets. If you specified a port override when you registered a target, you must specify both the target ID and the port when you deregister it.

" + } + } + }, + "DeregisterTargetsOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountLimitsInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeAccountLimitsOutput":{ + "type":"structure", + "members":{ + "Limits":{ + "shape":"Limits", + "documentation":"

Information about the limits.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeListenerCertificatesInput":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Names (ARN) of the listener.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeListenerCertificatesOutput":{ + "type":"structure", + "members":{ + "Certificates":{ + "shape":"CertificateList", + "documentation":"

Information about the certificates.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeListenersInput":{ + "type":"structure", + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "ListenerArns":{ + "shape":"ListenerArns", + "documentation":"

The Amazon Resource Names (ARN) of the listeners.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeListenersOutput":{ + "type":"structure", + "members":{ + "Listeners":{ + "shape":"Listeners", + "documentation":"

Information about the listeners.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeLoadBalancerAttributesInput":{ + "type":"structure", + "required":["LoadBalancerArn"], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + } + } + }, + "DescribeLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

Information about the load balancer attributes.

" + } + } + }, + "DescribeLoadBalancersInput":{ + "type":"structure", + "members":{ + "LoadBalancerArns":{ + "shape":"LoadBalancerArns", + "documentation":"

The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load balancers in a single call.

" + }, + "Names":{ + "shape":"LoadBalancerNames", + "documentation":"

The names of the load balancers.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeLoadBalancersOutput":{ + "type":"structure", + "members":{ + "LoadBalancers":{ + "shape":"LoadBalancers", + "documentation":"

Information about the load balancers.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeRulesInput":{ + "type":"structure", + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "RuleArns":{ + "shape":"RuleArns", + "documentation":"

The Amazon Resource Names (ARN) of the rules.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeRulesOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

Information about the rules.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeSSLPoliciesInput":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"SslPolicyNames", + "documentation":"

The names of the policies.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeSSLPoliciesOutput":{ + "type":"structure", + "members":{ + "SslPolicies":{ + "shape":"SslPolicies", + "documentation":"

Information about the policies.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeTagsInput":{ + "type":"structure", + "required":["ResourceArns"], + "members":{ + "ResourceArns":{ + "shape":"ResourceArns", + "documentation":"

The Amazon Resource Names (ARN) of the resources.

" + } + } + }, + "DescribeTagsOutput":{ + "type":"structure", + "members":{ + "TagDescriptions":{ + "shape":"TagDescriptions", + "documentation":"

Information about the tags.

" + } + } + }, + "DescribeTargetGroupAttributesInput":{ + "type":"structure", + "required":["TargetGroupArn"], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + } + } + }, + "DescribeTargetGroupAttributesOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TargetGroupAttributes", + "documentation":"

Information about the target group attributes

" + } + } + }, + "DescribeTargetGroupsInput":{ + "type":"structure", + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "TargetGroupArns":{ + "shape":"TargetGroupArns", + "documentation":"

The Amazon Resource Names (ARN) of the target groups.

" + }, + "Names":{ + "shape":"TargetGroupNames", + "documentation":"

The names of the target groups.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results. (You received this marker from a previous call.)

" + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return with this call.

" + } + } + }, + "DescribeTargetGroupsOutput":{ + "type":"structure", + "members":{ + "TargetGroups":{ + "shape":"TargetGroups", + "documentation":"

Information about the target groups.

" + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

" + } + } + }, + "DescribeTargetHealthInput":{ + "type":"structure", + "required":["TargetGroupArn"], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "Targets":{ + "shape":"TargetDescriptions", + "documentation":"

The targets.

" + } + } + }, + "DescribeTargetHealthOutput":{ + "type":"structure", + "members":{ + "TargetHealthDescriptions":{ + "shape":"TargetHealthDescriptions", + "documentation":"

Information about the health of the targets.

" + } + } + }, + "Description":{"type":"string"}, + "DuplicateListenerException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A listener with the specified port already exists.

", + "error":{ + "code":"DuplicateListener", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicateLoadBalancerNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A load balancer with the specified name already exists.

", + "error":{ + "code":"DuplicateLoadBalancerName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicateTagKeysException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A tag key was specified more than once.

", + "error":{ + "code":"DuplicateTagKeys", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DuplicateTargetGroupNameException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A target group with the specified name already exists.

", + "error":{ + "code":"DuplicateTargetGroupName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "FixedResponseActionConfig":{ + "type":"structure", + "required":["StatusCode"], + "members":{ + "MessageBody":{ + "shape":"FixedResponseActionMessage", + "documentation":"

The message.

" + }, + "StatusCode":{ + "shape":"FixedResponseActionStatusCode", + "documentation":"

The HTTP response code (2XX, 4XX, or 5XX).

" + }, + "ContentType":{ + "shape":"FixedResponseActionContentType", + "documentation":"

The content type.

Valid Values: text/plain | text/css | text/html | application/javascript | application/json

" + } + }, + "documentation":"

Information about an action that returns a custom HTTP response.

" + }, + "FixedResponseActionContentType":{ + "type":"string", + "max":32, + "min":0 + }, + "FixedResponseActionMessage":{ + "type":"string", + "max":1024, + "min":0 + }, + "FixedResponseActionStatusCode":{ + "type":"string", + "pattern":"^(2|4|5)\\d\\d$" + }, + "HealthCheckEnabled":{"type":"boolean"}, + "HealthCheckIntervalSeconds":{ + "type":"integer", + "max":300, + "min":5 + }, + "HealthCheckPort":{"type":"string"}, + "HealthCheckThresholdCount":{ + "type":"integer", + "max":10, + "min":2 + }, + "HealthCheckTimeoutSeconds":{ + "type":"integer", + "max":120, + "min":2 + }, + "HealthUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The health of the specified targets could not be retrieved due to an internal error.

", + "error":{ + "code":"HealthUnavailable", + "httpStatusCode":500 + }, + "exception":true + }, + "HostHeaderConditionConfig":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ListOfString", + "documentation":"

One or more host names. The maximum size of each name is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If you specify multiple strings, the condition is satisfied if one of the strings matches the host name.

" + } + }, + "documentation":"

Information about a host header condition.

" + }, + "HttpCode":{"type":"string"}, + "HttpHeaderConditionConfig":{ + "type":"structure", + "members":{ + "HttpHeaderName":{ + "shape":"HttpHeaderConditionName", + "documentation":"

The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.

You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.

" + }, + "Values":{ + "shape":"ListOfString", + "documentation":"

One or more strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If the same header appears multiple times in the request, we search them in order until a match is found.

If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.

" + } + }, + "documentation":"

Information about an HTTP header condition.

There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

" + }, + "HttpHeaderConditionName":{"type":"string"}, + "HttpRequestMethodConditionConfig":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ListOfString", + "documentation":"

The name of the request method. The maximum size is 40 characters. The allowed characters are A-Z, hyphen (-), and underscore (_). The comparison is case sensitive. Wildcards are not supported; therefore, the method name must be an exact match.

If you specify multiple strings, the condition is satisfied if one of the strings matches the HTTP request method. We recommend that you route GET and HEAD requests in the same way, because the response to a HEAD request may be cached.

" + } + }, + "documentation":"

Information about an HTTP method condition.

HTTP defines a set of request methods, also referred to as HTTP verbs. For more information, see the HTTP Method Registry. You can also define custom HTTP methods.

" + }, + "IncompatibleProtocolsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified configuration is not valid with this protocol.

", + "error":{ + "code":"IncompatibleProtocols", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidConfigurationRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested configuration is not valid.

", + "error":{ + "code":"InvalidConfigurationRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidLoadBalancerActionException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested action is not valid.

", + "error":{ + "code":"InvalidLoadBalancerAction", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSchemeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested scheme is not valid.

", + "error":{ + "code":"InvalidScheme", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSecurityGroupException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified security group does not exist.

", + "error":{ + "code":"InvalidSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified subnet is out of available addresses.

", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTargetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified target does not exist, is not in the same VPC as the target group, or has an unsupported instance type.

", + "error":{ + "code":"InvalidTarget", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpAddressType":{ + "type":"string", + "enum":[ + "ipv4", + "dualstack" + ] + }, + "IsDefault":{"type":"boolean"}, + "Limit":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the limit. The possible values are:

  • application-load-balancers

  • listeners-per-application-load-balancer

  • listeners-per-network-load-balancer

  • network-load-balancers

  • rules-per-application-load-balancer

  • target-groups

  • targets-per-application-load-balancer

  • targets-per-availability-zone-per-network-load-balancer

  • targets-per-network-load-balancer

" + }, + "Max":{ + "shape":"Max", + "documentation":"

The maximum value of the limit.

" + } + }, + "documentation":"

Information about an Elastic Load Balancing resource limit for your AWS account.

" + }, + "Limits":{ + "type":"list", + "member":{"shape":"Limit"} + }, + "ListOfString":{ + "type":"list", + "member":{"shape":"StringValue"} + }, + "Listener":{ + "type":"structure", + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

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

The port on which the load balancer is listening.

" + }, + "Protocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol for connections from clients to the load balancer.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

[HTTPS or TLS listener] The default certificate for the listener.

" + }, + "SslPolicy":{ + "shape":"SslPolicyName", + "documentation":"

[HTTPS or TLS listener] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

" + }, + "DefaultActions":{ + "shape":"Actions", + "documentation":"

The default actions for the listener.

" + } + }, + "documentation":"

Information about a listener.

" + }, + "ListenerArn":{"type":"string"}, + "ListenerArns":{ + "type":"list", + "member":{"shape":"ListenerArn"} + }, + "ListenerNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified listener does not exist.

", + "error":{ + "code":"ListenerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Listeners":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "LoadBalancer":{ + "type":"structure", + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

The public DNS name of the load balancer.

" + }, + "CanonicalHostedZoneId":{ + "shape":"CanonicalHostedZoneId", + "documentation":"

The ID of the Amazon Route 53 hosted zone associated with the load balancer.

" + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

The date and time the load balancer was created.

" + }, + "LoadBalancerName":{ + "shape":"LoadBalancerName", + "documentation":"

The name of the load balancer.

" + }, + "Scheme":{ + "shape":"LoadBalancerSchemeEnum", + "documentation":"

The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can only route requests from clients with access to the VPC for the load balancer.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC for the load balancer.

" + }, + "State":{ + "shape":"LoadBalancerState", + "documentation":"

The state of the load balancer.

" + }, + "Type":{ + "shape":"LoadBalancerTypeEnum", + "documentation":"

The type of load balancer.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

The Availability Zones for the load balancer.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups for the load balancer.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).

" + } + }, + "documentation":"

Information about a load balancer.

" + }, + "LoadBalancerAddress":{ + "type":"structure", + "members":{ + "IpAddress":{ + "shape":"IpAddress", + "documentation":"

The static IP address.

" + }, + "AllocationId":{ + "shape":"AllocationId", + "documentation":"

[Network Load Balancers] The allocation ID of the Elastic IP address.

" + } + }, + "documentation":"

Information about a static IP address for a load balancer.

" + }, + "LoadBalancerAddresses":{ + "type":"list", + "member":{"shape":"LoadBalancerAddress"} + }, + "LoadBalancerArn":{"type":"string"}, + "LoadBalancerArns":{ + "type":"list", + "member":{"shape":"LoadBalancerArn"} + }, + "LoadBalancerAttribute":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"LoadBalancerAttributeKey", + "documentation":"

The name of the attribute.

The following attributes are supported by both Application Load Balancers and Network Load Balancers:

  • access_logs.s3.enabled - Indicates whether access logs are enabled. The value is true or false. The default is false.

  • access_logs.s3.bucket - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket.

  • access_logs.s3.prefix - The prefix for the location in the S3 bucket for the access logs.

  • deletion_protection.enabled - Indicates whether deletion protection is enabled. The value is true or false. The default is false.

The following attributes are supported by only Application Load Balancers:

  • idle_timeout.timeout_seconds - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds.

  • routing.http2.enabled - Indicates whether HTTP/2 is enabled. The value is true or false. The default is true.

The following attributes are supported by only Network Load Balancers:

  • load_balancing.cross_zone.enabled - Indicates whether cross-zone load balancing is enabled. The value is true or false. The default is false.

" + }, + "Value":{ + "shape":"LoadBalancerAttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Information about a load balancer attribute.

" + }, + "LoadBalancerAttributeKey":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9._]+$" + }, + "LoadBalancerAttributeValue":{ + "type":"string", + "max":1024 + }, + "LoadBalancerAttributes":{ + "type":"list", + "member":{"shape":"LoadBalancerAttribute"}, + "max":20 + }, + "LoadBalancerName":{"type":"string"}, + "LoadBalancerNames":{ + "type":"list", + "member":{"shape":"LoadBalancerName"} + }, + "LoadBalancerNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified load balancer does not exist.

", + "error":{ + "code":"LoadBalancerNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LoadBalancerSchemeEnum":{ + "type":"string", + "enum":[ + "internet-facing", + "internal" + ] + }, + "LoadBalancerState":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"LoadBalancerStateEnum", + "documentation":"

The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If the load balancer could not be set up, its state is failed.

" + }, + "Reason":{ + "shape":"StateReason", + "documentation":"

A description of the state.

" + } + }, + "documentation":"

Information about the state of the load balancer.

" + }, + "LoadBalancerStateEnum":{ + "type":"string", + "enum":[ + "active", + "provisioning", + "active_impaired", + "failed" + ] + }, + "LoadBalancerTypeEnum":{ + "type":"string", + "enum":[ + "application", + "network" + ] + }, + "LoadBalancers":{ + "type":"list", + "member":{"shape":"LoadBalancer"} + }, + "Marker":{"type":"string"}, + "Matcher":{ + "type":"structure", + "required":["HttpCode"], + "members":{ + "HttpCode":{ + "shape":"HttpCode", + "documentation":"

The HTTP codes.

For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values (for example, \"200,202\") or a range of values (for example, \"200-299\").

For Network Load Balancers, this is 200–399.

" + } + }, + "documentation":"

Information to use when checking for a successful response from a target.

" + }, + "Max":{"type":"string"}, + "ModifyListenerInput":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

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

The port for connections from clients to the load balancer.

" + }, + "Protocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol for connections from clients to the load balancer. Application Load Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols.

" + }, + "SslPolicy":{ + "shape":"SslPolicyName", + "documentation":"

[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. Set CertificateArn to the certificate ARN but do not set IsDefault.

To create a certificate list, use AddListenerCertificates.

" + }, + "DefaultActions":{ + "shape":"Actions", + "documentation":"

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

" + } + } + }, + "ModifyListenerOutput":{ + "type":"structure", + "members":{ + "Listeners":{ + "shape":"Listeners", + "documentation":"

Information about the modified listener.

" + } + } + }, + "ModifyLoadBalancerAttributesInput":{ + "type":"structure", + "required":[ + "LoadBalancerArn", + "Attributes" + ], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "Attributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

The load balancer attributes.

" + } + } + }, + "ModifyLoadBalancerAttributesOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"LoadBalancerAttributes", + "documentation":"

Information about the load balancer attributes.

" + } + } + }, + "ModifyRuleInput":{ + "type":"structure", + "required":["RuleArn"], + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "Conditions":{ + "shape":"RuleConditionList", + "documentation":"

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

" + }, + "Actions":{ + "shape":"Actions", + "documentation":"

The actions. Each rule must include exactly one of the following types of actions: forward, fixed-response, or redirect.

If the action type is forward, you specify a target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer. The protocol of the target group must be TCP, TLS, UDP, or TCP_UDP for a Network Load Balancer.

[HTTPS listeners] If the action type is authenticate-oidc, you authenticate users through an identity provider that is OpenID Connect (OIDC) compliant.

[HTTPS listeners] If the action type is authenticate-cognito, you authenticate users through the user pools supported by Amazon Cognito.

[Application Load Balancer] If the action type is redirect, you redirect specified client requests from one URL to another.

[Application Load Balancer] If the action type is fixed-response, you drop specified client requests and return a custom HTTP response.

" + } + } + }, + "ModifyRuleOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

Information about the modified rule.

" + } + } + }, + "ModifyTargetGroupAttributesInput":{ + "type":"structure", + "required":[ + "TargetGroupArn", + "Attributes" + ], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "Attributes":{ + "shape":"TargetGroupAttributes", + "documentation":"

The attributes.

" + } + } + }, + "ModifyTargetGroupAttributesOutput":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TargetGroupAttributes", + "documentation":"

Information about the attributes.

" + } + } + }, + "ModifyTargetGroupInput":{ + "type":"structure", + "required":["TargetGroupArn"], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "HealthCheckProtocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol the load balancer uses when performing health checks on targets. The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP. The TLS, UDP, and TCP_UDP protocols are not supported for health checks.

If the protocol of the target group is TCP, you can't modify this setting.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port the load balancer uses when performing health checks on targets.

" + }, + "HealthCheckPath":{ + "shape":"Path", + "documentation":"

[HTTP/HTTPS health checks] The ping path that is the destination for the health check request.

" + }, + "HealthCheckEnabled":{ + "shape":"HealthCheckEnabled", + "documentation":"

Indicates whether health checks are enabled.

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target. For Application Load Balancers, the range is 5 to 300 seconds. For Network Load Balancers, the supported values are 10 or 30 seconds.

If the protocol of the target group is TCP, you can't modify this setting.

" + }, + "HealthCheckTimeoutSeconds":{ + "shape":"HealthCheckTimeoutSeconds", + "documentation":"

[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response means a failed health check.

If the protocol of the target group is TCP, you can't modify this setting.

" + }, + "HealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy.

" + }, + "UnhealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health check failures required before considering the target unhealthy. For Network Load Balancers, this value must be the same as the healthy threshold count.

" + }, + "Matcher":{ + "shape":"Matcher", + "documentation":"

[HTTP/HTTPS health checks] The HTTP codes to use when checking for a successful response from a target.

If the protocol of the target group is TCP, you can't modify this setting.

" + } + } + }, + "ModifyTargetGroupOutput":{ + "type":"structure", + "members":{ + "TargetGroups":{ + "shape":"TargetGroups", + "documentation":"

Information about the modified target group.

" + } + } + }, + "Name":{"type":"string"}, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This operation is not allowed.

", + "error":{ + "code":"OperationNotPermitted", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PageSize":{ + "type":"integer", + "max":400, + "min":1 + }, + "Path":{ + "type":"string", + "max":1024, + "min":1 + }, + "PathPatternConditionConfig":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ListOfString", + "documentation":"

One or more path patterns to compare against the request URL. The maximum size of each string is 128 characters. The comparison is case sensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If you specify multiple strings, the condition is satisfied if one of them matches the request URL. The path pattern is compared only to the path of the URL, not to its query string. To compare against the query string, use QueryStringConditionConfig.

" + } + }, + "documentation":"

Information about a path pattern condition.

" + }, + "Port":{ + "type":"integer", + "max":65535, + "min":1 + }, + "PriorityInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified priority is in use.

", + "error":{ + "code":"PriorityInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ProtocolEnum":{ + "type":"string", + "enum":[ + "HTTP", + "HTTPS", + "TCP", + "TLS", + "UDP", + "TCP_UDP" + ] + }, + "QueryStringConditionConfig":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"QueryStringKeyValuePairList", + "documentation":"

One or more key/value pairs or values to find in the query string. The maximum size of each string is 128 characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query string, you must escape these characters in Values using a '\\' character.

If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the query string.

" + } + }, + "documentation":"

Information about a query string condition.

The query string component of a URI starts after the first '?' character and is terminated by either a '#' character or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed characters are specified by RFC 3986. Any character can be percentage encoded.

" + }, + "QueryStringKeyValuePair":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"StringValue", + "documentation":"

The key. You can omit the key.

" + }, + "Value":{ + "shape":"StringValue", + "documentation":"

The value.

" + } + }, + "documentation":"

Information about a key/value pair.

" + }, + "QueryStringKeyValuePairList":{ + "type":"list", + "member":{"shape":"QueryStringKeyValuePair"} + }, + "RedirectActionConfig":{ + "type":"structure", + "required":["StatusCode"], + "members":{ + "Protocol":{ + "shape":"RedirectActionProtocol", + "documentation":"

The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.

" + }, + "Port":{ + "shape":"RedirectActionPort", + "documentation":"

The port. You can specify a value from 1 to 65535 or #{port}.

" + }, + "Host":{ + "shape":"RedirectActionHost", + "documentation":"

The hostname. This component is not percent-encoded. The hostname can contain #{host}.

" + }, + "Path":{ + "shape":"RedirectActionPath", + "documentation":"

The absolute path, starting with the leading \"/\". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}.

" + }, + "Query":{ + "shape":"RedirectActionQuery", + "documentation":"

The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading \"?\", as it is automatically added. You can specify any of the reserved keywords.

" + }, + "StatusCode":{ + "shape":"RedirectActionStatusCodeEnum", + "documentation":"

The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).

" + } + }, + "documentation":"

Information about a redirect action.

A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values.

You can reuse URI components using the following reserved keywords:

  • #{protocol}

  • #{host}

  • #{port}

  • #{path} (the leading \"/\" is removed)

  • #{query}

For example, you can change the path to \"/new/#{path}\", the hostname to \"example.#{host}\", or the query to \"#{query}&value=xyz\".

" + }, + "RedirectActionHost":{ + "type":"string", + "max":128, + "min":1 + }, + "RedirectActionPath":{ + "type":"string", + "max":128, + "min":1 + }, + "RedirectActionPort":{"type":"string"}, + "RedirectActionProtocol":{ + "type":"string", + "pattern":"^(HTTPS?|#\\{protocol\\})$" + }, + "RedirectActionQuery":{ + "type":"string", + "max":128, + "min":0 + }, + "RedirectActionStatusCodeEnum":{ + "type":"string", + "enum":[ + "HTTP_301", + "HTTP_302" + ] + }, + "RegisterTargetsInput":{ + "type":"structure", + "required":[ + "TargetGroupArn", + "Targets" + ], + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "Targets":{ + "shape":"TargetDescriptions", + "documentation":"

The targets.

To register a target by instance ID, specify the instance ID. To register a target by IP address, specify the IP address. To register a Lambda function, specify the ARN of the Lambda function.

" + } + } + }, + "RegisterTargetsOutput":{ + "type":"structure", + "members":{ + } + }, + "RemoveListenerCertificatesInput":{ + "type":"structure", + "required":[ + "ListenerArn", + "Certificates" + ], + "members":{ + "ListenerArn":{ + "shape":"ListenerArn", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "Certificates":{ + "shape":"CertificateList", + "documentation":"

The certificate to remove. You can specify one certificate per call. Set CertificateArn to the certificate ARN but do not set IsDefault.

" + } + } + }, + "RemoveListenerCertificatesOutput":{ + "type":"structure", + "members":{ + } + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "ResourceArns", + "TagKeys" + ], + "members":{ + "ResourceArns":{ + "shape":"ResourceArns", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

The tag keys for the tags to remove.

" + } + } + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + } + }, + "ResourceArn":{"type":"string"}, + "ResourceArns":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A specified resource is in use.

", + "error":{ + "code":"ResourceInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Rule":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "Priority":{ + "shape":"String", + "documentation":"

The priority.

" + }, + "Conditions":{ + "shape":"RuleConditionList", + "documentation":"

The conditions. Each rule can include zero or one of the following conditions: http-request-method, host-header, path-pattern, and source-ip, and zero or more of the following conditions: http-header and query-string.

" + }, + "Actions":{ + "shape":"Actions", + "documentation":"

The actions. Each rule must include exactly one of the following types of actions: forward, redirect, or fixed-response, and it must be the last action to be performed.

" + }, + "IsDefault":{ + "shape":"IsDefault", + "documentation":"

Indicates whether this is the default rule.

" + } + }, + "documentation":"

Information about a rule.

" + }, + "RuleArn":{"type":"string"}, + "RuleArns":{ + "type":"list", + "member":{"shape":"RuleArn"} + }, + "RuleCondition":{ + "type":"structure", + "members":{ + "Field":{ + "shape":"ConditionFieldName", + "documentation":"

The field in the HTTP request. The following are the possible values:

  • http-header

  • http-request-method

  • host-header

  • path-pattern

  • query-string

  • source-ip

" + }, + "Values":{ + "shape":"ListOfString", + "documentation":"

The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions.

If Field is host-header, you can specify a single host name (for example, my.example.com). A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • - .

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

If Field is path-pattern, you can specify a single path pattern (for example, /img/*). A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

  • A-Z, a-z, 0-9

  • _ - . $ / ~ \" ' @ : +

  • & (using &amp;)

  • * (matches 0 or more characters)

  • ? (matches exactly 1 character)

" + }, + "HostHeaderConfig":{ + "shape":"HostHeaderConditionConfig", + "documentation":"

Information for a host header condition. Specify only when Field is host-header.

" + }, + "PathPatternConfig":{ + "shape":"PathPatternConditionConfig", + "documentation":"

Information for a path pattern condition. Specify only when Field is path-pattern.

" + }, + "HttpHeaderConfig":{ + "shape":"HttpHeaderConditionConfig", + "documentation":"

Information for an HTTP header condition. Specify only when Field is http-header.

" + }, + "QueryStringConfig":{ + "shape":"QueryStringConditionConfig", + "documentation":"

Information for a query string condition. Specify only when Field is query-string.

" + }, + "HttpRequestMethodConfig":{ + "shape":"HttpRequestMethodConditionConfig", + "documentation":"

Information for an HTTP method condition. Specify only when Field is http-request-method.

" + }, + "SourceIpConfig":{ + "shape":"SourceIpConditionConfig", + "documentation":"

Information for a source IP condition. Specify only when Field is source-ip.

" + } + }, + "documentation":"

Information about a condition for a rule.

" + }, + "RuleConditionList":{ + "type":"list", + "member":{"shape":"RuleCondition"} + }, + "RuleNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified rule does not exist.

", + "error":{ + "code":"RuleNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "RulePriority":{ + "type":"integer", + "max":50000, + "min":1 + }, + "RulePriorityList":{ + "type":"list", + "member":{"shape":"RulePriorityPair"} + }, + "RulePriorityPair":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "Priority":{ + "shape":"RulePriority", + "documentation":"

The rule priority.

" + } + }, + "documentation":"

Information about the priorities for the rules for a listener.

" + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"} + }, + "SSLPolicyNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified SSL policy does not exist.

", + "error":{ + "code":"SSLPolicyNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SecurityGroupId":{"type":"string"}, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroupId"} + }, + "SetIpAddressTypeInput":{ + "type":"structure", + "required":[ + "LoadBalancerArn", + "IpAddressType" + ], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The IP address type. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses). Internal load balancers must use ipv4. Network Load Balancers must use ipv4.

" + } + } + }, + "SetIpAddressTypeOutput":{ + "type":"structure", + "members":{ + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The IP address type.

" + } + } + }, + "SetRulePrioritiesInput":{ + "type":"structure", + "required":["RulePriorities"], + "members":{ + "RulePriorities":{ + "shape":"RulePriorityList", + "documentation":"

The rule priorities.

" + } + } + }, + "SetRulePrioritiesOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

Information about the rules.

" + } + } + }, + "SetSecurityGroupsInput":{ + "type":"structure", + "required":[ + "LoadBalancerArn", + "SecurityGroups" + ], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups.

" + } + } + }, + "SetSecurityGroupsOutput":{ + "type":"structure", + "members":{ + "SecurityGroupIds":{ + "shape":"SecurityGroups", + "documentation":"

The IDs of the security groups associated with the load balancer.

" + } + } + }, + "SetSubnetsInput":{ + "type":"structure", + "required":["LoadBalancerArn"], + "members":{ + "LoadBalancerArn":{ + "shape":"LoadBalancerArn", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

" + }, + "SubnetMappings":{ + "shape":"SubnetMappings", + "documentation":"

The IDs of the public subnets. You must specify subnets from at least two Availability Zones. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

You cannot specify Elastic IP addresses for your subnets.

" + } + } + }, + "SetSubnetsOutput":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Information about the subnet and Availability Zone.

" + } + } + }, + "SourceIpConditionConfig":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ListOfString", + "documentation":"

One or more source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported.

If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.

" + } + }, + "documentation":"

Information about a source IP condition.

You can use this condition to route based on the IP address of the source that connects to the load balancer. If a client is behind a proxy, this is the IP address of the proxy not the IP address of the client.

" + }, + "SslPolicies":{ + "type":"list", + "member":{"shape":"SslPolicy"} + }, + "SslPolicy":{ + "type":"structure", + "members":{ + "SslProtocols":{ + "shape":"SslProtocols", + "documentation":"

The protocols.

" + }, + "Ciphers":{ + "shape":"Ciphers", + "documentation":"

The ciphers.

" + }, + "Name":{ + "shape":"SslPolicyName", + "documentation":"

The name of the policy.

" + } + }, + "documentation":"

Information about a policy used for SSL negotiation.

" + }, + "SslPolicyName":{"type":"string"}, + "SslPolicyNames":{ + "type":"list", + "member":{"shape":"SslPolicyName"} + }, + "SslProtocol":{"type":"string"}, + "SslProtocols":{ + "type":"list", + "member":{"shape":"SslProtocol"} + }, + "StateReason":{"type":"string"}, + "String":{"type":"string"}, + "StringValue":{"type":"string"}, + "SubnetId":{"type":"string"}, + "SubnetMapping":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

The ID of the subnet.

" + }, + "AllocationId":{ + "shape":"AllocationId", + "documentation":"

[Network Load Balancers] The allocation ID of the Elastic IP address.

" + } + }, + "documentation":"

Information about a subnet mapping.

" + }, + "SubnetMappings":{ + "type":"list", + "member":{"shape":"SubnetMapping"} + }, + "SubnetNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified subnet does not exist.

", + "error":{ + "code":"SubnetNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Information about a tag.

" + }, + "TagDescription":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Information about the tags.

" + } + }, + "documentation":"

The tags associated with a resource.

" + }, + "TagDescriptions":{ + "type":"list", + "member":{"shape":"TagDescription"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TargetDescription":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TargetId", + "documentation":"

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function.

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

The port on which the target is listening.

" + }, + "AvailabilityZone":{ + "shape":"ZoneName", + "documentation":"

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

This parameter is not supported if the target type of the target group is instance.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

With an Application Load Balancer, if the target type is ip and the IP address is outside the VPC for the target group, the only supported value is all.

If the target type is lambda, this parameter is optional and the only supported value is all.

" + } + }, + "documentation":"

Information about a target.

" + }, + "TargetDescriptions":{ + "type":"list", + "member":{"shape":"TargetDescription"} + }, + "TargetGroup":{ + "type":"structure", + "members":{ + "TargetGroupArn":{ + "shape":"TargetGroupArn", + "documentation":"

The Amazon Resource Name (ARN) of the target group.

" + }, + "TargetGroupName":{ + "shape":"TargetGroupName", + "documentation":"

The name of the target group.

" + }, + "Protocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol to use for routing traffic to the targets.

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

The port on which the targets are listening.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC for the targets.

" + }, + "HealthCheckProtocol":{ + "shape":"ProtocolEnum", + "documentation":"

The protocol to use to connect with the target.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port to use to connect with the target.

" + }, + "HealthCheckEnabled":{ + "shape":"HealthCheckEnabled", + "documentation":"

Indicates whether health checks are enabled.

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The approximate amount of time, in seconds, between health checks of an individual target.

" + }, + "HealthCheckTimeoutSeconds":{ + "shape":"HealthCheckTimeoutSeconds", + "documentation":"

The amount of time, in seconds, during which no response means a failed health check.

" + }, + "HealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health checks successes required before considering an unhealthy target healthy.

" + }, + "UnhealthyThresholdCount":{ + "shape":"HealthCheckThresholdCount", + "documentation":"

The number of consecutive health check failures required before considering the target unhealthy.

" + }, + "HealthCheckPath":{ + "shape":"Path", + "documentation":"

The destination for the health check request.

" + }, + "Matcher":{ + "shape":"Matcher", + "documentation":"

The HTTP codes to use when checking for a successful response from a target.

" + }, + "LoadBalancerArns":{ + "shape":"LoadBalancerArns", + "documentation":"

The Amazon Resource Names (ARN) of the load balancers that route traffic to this target group.

" + }, + "TargetType":{ + "shape":"TargetTypeEnum", + "documentation":"

The type of target that you must specify when registering targets with this target group. The possible values are instance (targets are specified by instance ID) or ip (targets are specified by IP address).

" + } + }, + "documentation":"

Information about a target group.

" + }, + "TargetGroupArn":{"type":"string"}, + "TargetGroupArns":{ + "type":"list", + "member":{"shape":"TargetGroupArn"} + }, + "TargetGroupAssociationLimitException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of load balancers per target group.

", + "error":{ + "code":"TargetGroupAssociationLimit", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TargetGroupAttribute":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TargetGroupAttributeKey", + "documentation":"

The name of the attribute.

The following attribute is supported by both Application Load Balancers and Network Load Balancers:

  • deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.

The following attributes are supported by Application Load Balancers if the target is not a Lambda function:

  • slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives a linearly increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). Slow start mode is disabled by default.

  • stickiness.enabled - Indicates whether sticky sessions are enabled. The value is true or false. The default is false.

  • stickiness.type - The type of sticky sessions. The possible value is lb_cookie.

  • stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).

The following attribute is supported only if the target is a Lambda function.

  • lambda.multi_value_headers.enabled - Indicates whether the request and response headers exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.

The following attribute is supported only by Network Load Balancers:

  • proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false.

" + }, + "Value":{ + "shape":"TargetGroupAttributeValue", + "documentation":"

The value of the attribute.

" + } + }, + "documentation":"

Information about a target group attribute.

" + }, + "TargetGroupAttributeKey":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9._]+$" + }, + "TargetGroupAttributeValue":{"type":"string"}, + "TargetGroupAttributes":{ + "type":"list", + "member":{"shape":"TargetGroupAttribute"} + }, + "TargetGroupName":{"type":"string"}, + "TargetGroupNames":{ + "type":"list", + "member":{"shape":"TargetGroupName"} + }, + "TargetGroupNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified target group does not exist.

", + "error":{ + "code":"TargetGroupNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TargetGroups":{ + "type":"list", + "member":{"shape":"TargetGroup"} + }, + "TargetHealth":{ + "type":"structure", + "members":{ + "State":{ + "shape":"TargetHealthStateEnum", + "documentation":"

The state of the target.

" + }, + "Reason":{ + "shape":"TargetHealthReasonEnum", + "documentation":"

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.

  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Target.Timeout - The health check requests timed out.

  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.

  • Elb.InternalError - The health checks failed due to an internal error.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.

  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.

  • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

  • Target.InvalidState - The target is in the stopped or terminated state.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

" + } + }, + "documentation":"

Information about the current health of a target.

" + }, + "TargetHealthDescription":{ + "type":"structure", + "members":{ + "Target":{ + "shape":"TargetDescription", + "documentation":"

The description of the target.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port to use to connect with the target.

" + }, + "TargetHealth":{ + "shape":"TargetHealth", + "documentation":"

The health information for the target.

" + } + }, + "documentation":"

Information about the health of a target.

" + }, + "TargetHealthDescriptions":{ + "type":"list", + "member":{"shape":"TargetHealthDescription"} + }, + "TargetHealthReasonEnum":{ + "type":"string", + "enum":[ + "Elb.RegistrationInProgress", + "Elb.InitialHealthChecking", + "Target.ResponseCodeMismatch", + "Target.Timeout", + "Target.FailedHealthChecks", + "Target.NotRegistered", + "Target.NotInUse", + "Target.DeregistrationInProgress", + "Target.InvalidState", + "Target.IpUnusable", + "Target.HealthCheckDisabled", + "Elb.InternalError" + ] + }, + "TargetHealthStateEnum":{ + "type":"string", + "enum":[ + "initial", + "healthy", + "unhealthy", + "unused", + "draining", + "unavailable" + ] + }, + "TargetId":{"type":"string"}, + "TargetTypeEnum":{ + "type":"string", + "enum":[ + "instance", + "ip", + "lambda" + ] + }, + "TooManyActionsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of actions per rule.

", + "error":{ + "code":"TooManyActions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyCertificatesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of certificates per load balancer.

", + "error":{ + "code":"TooManyCertificates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyListenersException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of listeners per load balancer.

", + "error":{ + "code":"TooManyListeners", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyLoadBalancersException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of load balancers for your AWS account.

", + "error":{ + "code":"TooManyLoadBalancers", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyRegistrationsForTargetIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of times a target can be registered with a load balancer.

", + "error":{ + "code":"TooManyRegistrationsForTargetId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyRulesException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of rules per load balancer.

", + "error":{ + "code":"TooManyRules", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of tags per load balancer.

", + "error":{ + "code":"TooManyTags", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyTargetGroupsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of target groups for your AWS account.

", + "error":{ + "code":"TooManyTargetGroups", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TooManyTargetsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You've reached the limit on the number of targets.

", + "error":{ + "code":"TooManyTargets", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnsupportedProtocolException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified protocol is not supported.

", + "error":{ + "code":"UnsupportedProtocol", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "VpcId":{"type":"string"}, + "ZoneName":{"type":"string"} + }, + "documentation":"Elastic Load Balancing

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. This reference covers Application Load Balancers and Network Load Balancers.

An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

" +} diff --git a/aws/dist/botocore/data/elbv2/2015-12-01/waiters-2.json b/aws/dist/botocore/data/elbv2/2015-12-01/waiters-2.json new file mode 100644 index 00000000..9f3d77d8 --- /dev/null +++ b/aws/dist/botocore/data/elbv2/2015-12-01/waiters-2.json @@ -0,0 +1,100 @@ +{ + "version": 2, + "waiters": { + "LoadBalancerExists": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "matcher": "status", + "expected": 200, + "state": "success" + }, + { + "matcher": "error", + "expected": "LoadBalancerNotFound", + "state": "retry" + } + ] + }, + "LoadBalancerAvailable": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "LoadBalancers[].State.Code", + "expected": "active" + }, + { + "state": "retry", + "matcher": "pathAny", + "argument": "LoadBalancers[].State.Code", + "expected": "provisioning" + }, + { + "state": "retry", + "matcher": "error", + "expected": "LoadBalancerNotFound" + } + ] + }, + "LoadBalancersDeleted": { + "delay": 15, + "operation": "DescribeLoadBalancers", + "maxAttempts": 40, + "acceptors": [ + { + "state": "retry", + "matcher": "pathAll", + "argument": "LoadBalancers[].State.Code", + "expected": "active" + }, + { + "matcher": "error", + "expected": "LoadBalancerNotFound", + "state": "success" + } + ] + }, + "TargetInService":{ + "delay":15, + "maxAttempts":40, + "operation":"DescribeTargetHealth", + "acceptors":[ + { + "argument":"TargetHealthDescriptions[].TargetHealth.State", + "expected":"healthy", + "matcher":"pathAll", + "state":"success" + }, + { + "matcher": "error", + "expected": "InvalidInstance", + "state": "retry" + } + ] + }, + "TargetDeregistered": { + "delay": 15, + "maxAttempts": 40, + "operation": "DescribeTargetHealth", + "acceptors": [ + { + "matcher": "error", + "expected": "InvalidTarget", + "state": "success" + }, + { + "argument":"TargetHealthDescriptions[].TargetHealth.State", + "expected":"unused", + "matcher":"pathAll", + "state":"success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/emr/2009-03-31/examples-1.json b/aws/dist/botocore/data/emr/2009-03-31/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/emr/2009-03-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/emr/2009-03-31/paginators-1.json b/aws/dist/botocore/data/emr/2009-03-31/paginators-1.json new file mode 100644 index 00000000..023eb7cc --- /dev/null +++ b/aws/dist/botocore/data/emr/2009-03-31/paginators-1.json @@ -0,0 +1,39 @@ +{ + "pagination": { + "ListBootstrapActions": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "BootstrapActions" + }, + "ListClusters": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Clusters" + }, + "ListInstanceGroups": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "InstanceGroups" + }, + "ListInstances": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Instances" + }, + "ListSteps": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "Steps" + }, + "ListInstanceFleets": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "InstanceFleets" + }, + "ListSecurityConfigurations": { + "input_token": "Marker", + "output_token": "Marker", + "result_key": "SecurityConfigurations" + } + } +} diff --git a/aws/dist/botocore/data/emr/2009-03-31/service-2.json b/aws/dist/botocore/data/emr/2009-03-31/service-2.json new file mode 100644 index 00000000..f31c32c7 --- /dev/null +++ b/aws/dist/botocore/data/emr/2009-03-31/service-2.json @@ -0,0 +1,3715 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2009-03-31", + "endpointPrefix":"elasticmapreduce", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon EMR", + "serviceFullName":"Amazon Elastic MapReduce", + "serviceId":"EMR", + "signatureVersion":"v4", + "targetPrefix":"ElasticMapReduce", + "uid":"elasticmapreduce-2009-03-31" + }, + "operations":{ + "AddInstanceFleet":{ + "name":"AddInstanceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddInstanceFleetInput"}, + "output":{"shape":"AddInstanceFleetOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds an instance fleet to a running cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x.

" + }, + "AddInstanceGroups":{ + "name":"AddInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddInstanceGroupsInput"}, + "output":{"shape":"AddInstanceGroupsOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

Adds one or more instance groups to a running cluster.

" + }, + "AddJobFlowSteps":{ + "name":"AddJobFlowSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddJobFlowStepsInput"}, + "output":{"shape":"AddJobFlowStepsOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

AddJobFlowSteps adds new steps to a running cluster. A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using SSH to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

A step specifies the location of a JAR file stored either on the master node of the cluster or in Amazon S3. Each step is performed by the main function of the main class of the JAR file. The main class can be specified either in the manifest of the JAR or by using the MainFunction parameter of the step.

Amazon EMR executes each step in the order listed. For a step to be considered complete, the main function must exit with a zero exit code and all Hadoop jobs started while the step was running must have completed and run successfully.

You can only add steps to a cluster that is in one of the following states: STARTING, BOOTSTRAPPING, RUNNING, or WAITING.

" + }, + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{"shape":"AddTagsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds tags to an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

" + }, + "CancelSteps":{ + "name":"CancelSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelStepsInput"}, + "output":{"shape":"CancelStepsOutput"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Cancels a pending step or steps in a running cluster. Available only in Amazon EMR versions 4.8.0 and later, excluding version 5.0.0. A maximum of 256 steps are allowed in each CancelSteps request. CancelSteps is idempotent but asynchronous; it does not guarantee a step will be canceled, even if the request is successfully submitted. You can only cancel steps that are in a PENDING state.

" + }, + "CreateSecurityConfiguration":{ + "name":"CreateSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityConfigurationInput"}, + "output":{"shape":"CreateSecurityConfigurationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Creates a security configuration, which is stored in the service and can be specified when a cluster is created.

" + }, + "DeleteSecurityConfiguration":{ + "name":"DeleteSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityConfigurationInput"}, + "output":{"shape":"DeleteSecurityConfigurationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes a security configuration.

" + }, + "DescribeCluster":{ + "name":"DescribeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterInput"}, + "output":{"shape":"DescribeClusterOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides cluster-level details including status, hardware and software configuration, VPC settings, and so on.

" + }, + "DescribeJobFlows":{ + "name":"DescribeJobFlows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeJobFlowsInput"}, + "output":{"shape":"DescribeJobFlowsOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

This API is deprecated and will eventually be removed. We recommend you use ListClusters, DescribeCluster, ListSteps, ListInstanceGroups and ListBootstrapActions instead.

DescribeJobFlows returns a list of job flows that match all of the supplied parameters. The parameters can include a list of job flow IDs, job flow states, and restrictions on job flow creation date and time.

Regardless of supplied parameters, only job flows created within the last two months are returned.

If no parameters are supplied, then job flows matching either of the following criteria are returned:

  • Job flows created and completed in the last two weeks

  • Job flows created within the last two months that are in one of the following states: RUNNING, WAITING, SHUTTING_DOWN, STARTING

Amazon EMR can return a maximum of 512 job flow descriptions.

", + "deprecated":true + }, + "DescribeSecurityConfiguration":{ + "name":"DescribeSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecurityConfigurationInput"}, + "output":{"shape":"DescribeSecurityConfigurationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides the details of a security configuration by returning the configuration JSON.

" + }, + "DescribeStep":{ + "name":"DescribeStep", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStepInput"}, + "output":{"shape":"DescribeStepOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides more detail about the cluster step.

" + }, + "GetBlockPublicAccessConfiguration":{ + "name":"GetBlockPublicAccessConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetBlockPublicAccessConfigurationInput"}, + "output":{"shape":"GetBlockPublicAccessConfigurationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns the Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

" + }, + "ListBootstrapActions":{ + "name":"ListBootstrapActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBootstrapActionsInput"}, + "output":{"shape":"ListBootstrapActionsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides information about the bootstrap actions associated with a cluster.

" + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClustersInput"}, + "output":{"shape":"ListClustersOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides the status of all clusters visible to this AWS account. Allows you to filter the list of clusters based on certain criteria; for example, filtering by cluster creation date and time or by status. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListClusters calls.

" + }, + "ListInstanceFleets":{ + "name":"ListInstanceFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceFleetsInput"}, + "output":{"shape":"ListInstanceFleetsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Lists all available details about the instance fleets in a cluster.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "ListInstanceGroups":{ + "name":"ListInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceGroupsInput"}, + "output":{"shape":"ListInstanceGroupsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides all available details about the instance groups in a cluster.

" + }, + "ListInstances":{ + "name":"ListInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstancesInput"}, + "output":{"shape":"ListInstancesOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides information for all active EC2 instances and EC2 instances terminated in the last 30 days, up to a maximum of 2,000. EC2 instances in any of the following states are considered active: AWAITING_FULFILLMENT, PROVISIONING, BOOTSTRAPPING, RUNNING.

" + }, + "ListSecurityConfigurations":{ + "name":"ListSecurityConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSecurityConfigurationsInput"}, + "output":{"shape":"ListSecurityConfigurationsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Lists all the security configurations visible to this account, providing their creation dates and times, and their names. This call returns a maximum of 50 clusters per call, but returns a marker to track the paging of the cluster list across multiple ListSecurityConfigurations calls.

" + }, + "ListSteps":{ + "name":"ListSteps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStepsInput"}, + "output":{"shape":"ListStepsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Provides a list of steps for the cluster in reverse order unless you specify stepIds with the request.

" + }, + "ModifyInstanceFleet":{ + "name":"ModifyInstanceFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceFleetInput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Modifies the target On-Demand and target Spot capacities for the instance fleet with the specified InstanceFleetID within the cluster specified using ClusterID. The call either succeeds or fails atomically.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "ModifyInstanceGroups":{ + "name":"ModifyInstanceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyInstanceGroupsInput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

ModifyInstanceGroups modifies the number of nodes and configuration settings of an instance group. The input parameters include the new target instance count for the group and the instance group ID. The call will either succeed or fail atomically.

" + }, + "PutAutoScalingPolicy":{ + "name":"PutAutoScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAutoScalingPolicyInput"}, + "output":{"shape":"PutAutoScalingPolicyOutput"}, + "documentation":"

Creates or updates an automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric.

" + }, + "PutBlockPublicAccessConfiguration":{ + "name":"PutBlockPublicAccessConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutBlockPublicAccessConfigurationInput"}, + "output":{"shape":"PutBlockPublicAccessConfigurationOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Creates or updates an Amazon EMR block public access configuration for your AWS account in the current Region. For more information see Configure Block Public Access for Amazon EMR in the Amazon EMR Management Guide.

" + }, + "RemoveAutoScalingPolicy":{ + "name":"RemoveAutoScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAutoScalingPolicyInput"}, + "output":{"shape":"RemoveAutoScalingPolicyOutput"}, + "documentation":"

Removes an automatic scaling policy from a specified instance group within an EMR cluster.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsInput"}, + "output":{"shape":"RemoveTagsOutput"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Removes tags from an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

The following example removes the stack tag with value Prod from a cluster:

" + }, + "RunJobFlow":{ + "name":"RunJobFlow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunJobFlowInput"}, + "output":{"shape":"RunJobFlowOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

RunJobFlow creates and starts running a new cluster (job flow). The cluster runs the steps specified. After the steps complete, the cluster stops and the HDFS partition is lost. To prevent loss of data, configure the last step of the job flow to store results in Amazon S3. If the JobFlowInstancesConfig KeepJobFlowAliveWhenNoSteps parameter is set to TRUE, the cluster transitions to the WAITING state rather than shutting down after the steps have completed.

For additional protection, you can set the JobFlowInstancesConfig TerminationProtected parameter to TRUE to lock the cluster and prevent it from being terminated by API call, user intervention, or in the event of a job flow error.

A maximum of 256 steps are allowed in each job flow.

If your cluster is long-running (such as a Hive data warehouse) or complex, you may require more than 256 steps to process your data. You can bypass the 256-step limitation in various ways, including using the SSH shell to connect to the master node and submitting queries directly to the software running on the master node, such as Hive and Hadoop. For more information on how to do this, see Add More than 256 Steps to a Cluster in the Amazon EMR Management Guide.

For long running clusters, we recommend that you periodically store your results.

The instance fleets configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. The RunJobFlow request can contain InstanceFleets parameters or InstanceGroups parameters, but not both.

" + }, + "SetTerminationProtection":{ + "name":"SetTerminationProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTerminationProtectionInput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

SetTerminationProtection locks a cluster (job flow) so the EC2 instances in the cluster cannot be terminated by user intervention, an API call, or in the event of a job-flow error. The cluster still terminates upon successful completion of the job flow. Calling SetTerminationProtection on a cluster is similar to calling the Amazon EC2 DisableAPITermination API on all EC2 instances in a cluster.

SetTerminationProtection is used to prevent accidental termination of a cluster and to ensure that in the event of an error, the instances persist so that you can recover any data stored in their ephemeral instance storage.

To terminate a cluster that has been locked by setting SetTerminationProtection to true, you must first unlock the job flow by a subsequent call to SetTerminationProtection in which you set the value to false.

For more information, seeManaging Cluster Termination in the Amazon EMR Management Guide.

" + }, + "SetVisibleToAllUsers":{ + "name":"SetVisibleToAllUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetVisibleToAllUsersInput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

This member will be deprecated.

Sets whether all AWS Identity and Access Management (IAM) users under your account can access the specified clusters (job flows). This action works on running clusters. You can also set the visibility of a cluster when you launch it using the VisibleToAllUsers parameter of RunJobFlow. The SetVisibleToAllUsers action can be called only by an IAM user who created the cluster or the AWS account that owns the cluster.

" + }, + "TerminateJobFlows":{ + "name":"TerminateJobFlows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateJobFlowsInput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.

The maximum number of clusters allowed is 10. The call to TerminateJobFlows is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.

" + } + }, + "shapes":{ + "ActionOnFailure":{ + "type":"string", + "enum":[ + "TERMINATE_JOB_FLOW", + "TERMINATE_CLUSTER", + "CANCEL_AND_WAIT", + "CONTINUE" + ] + }, + "AddInstanceFleetInput":{ + "type":"structure", + "required":[ + "ClusterId", + "InstanceFleet" + ], + "members":{ + "ClusterId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The unique identifier of the cluster.

" + }, + "InstanceFleet":{ + "shape":"InstanceFleetConfig", + "documentation":"

Specifies the configuration of the instance fleet.

" + } + } + }, + "AddInstanceFleetOutput":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The unique identifier of the cluster.

" + }, + "InstanceFleetId":{ + "shape":"InstanceFleetId", + "documentation":"

The unique identifier of the instance fleet.

" + } + } + }, + "AddInstanceGroupsInput":{ + "type":"structure", + "required":[ + "InstanceGroups", + "JobFlowId" + ], + "members":{ + "InstanceGroups":{ + "shape":"InstanceGroupConfigList", + "documentation":"

Instance groups to add.

" + }, + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Job flow in which to add the instance groups.

" + } + }, + "documentation":"

Input to an AddInstanceGroups call.

" + }, + "AddInstanceGroupsOutput":{ + "type":"structure", + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The job flow ID in which the instance groups are added.

" + }, + "InstanceGroupIds":{ + "shape":"InstanceGroupIdsList", + "documentation":"

Instance group IDs of the newly created instance groups.

" + } + }, + "documentation":"

Output from an AddInstanceGroups call.

" + }, + "AddJobFlowStepsInput":{ + "type":"structure", + "required":[ + "JobFlowId", + "Steps" + ], + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

A string that uniquely identifies the job flow. This identifier is returned by RunJobFlow and can also be obtained from ListClusters.

" + }, + "Steps":{ + "shape":"StepConfigList", + "documentation":"

A list of StepConfig to be executed by the job flow.

" + } + }, + "documentation":"

The input argument to the AddJobFlowSteps operation.

" + }, + "AddJobFlowStepsOutput":{ + "type":"structure", + "members":{ + "StepIds":{ + "shape":"StepIdsList", + "documentation":"

The identifiers of the list of steps added to the job flow.

" + } + }, + "documentation":"

The output for the AddJobFlowSteps operation.

" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

The Amazon EMR resource identifier to which tags will be added. This value must be a cluster identifier.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to associate with a cluster and propagate to EC2 instances. Tags are user-defined key/value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

" + } + }, + "documentation":"

This input identifies a cluster and a list of tags to attach.

" + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

This output indicates the result of adding tags to a resource.

" + }, + "AdjustmentType":{ + "type":"string", + "enum":[ + "CHANGE_IN_CAPACITY", + "PERCENT_CHANGE_IN_CAPACITY", + "EXACT_CAPACITY" + ] + }, + "Application":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the application.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of the application.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

Arguments for Amazon EMR to pass to the application.

" + }, + "AdditionalInfo":{ + "shape":"StringMap", + "documentation":"

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

" + } + }, + "documentation":"

With Amazon EMR release version 4.0 and later, the only accepted parameter is the application name. To pass arguments to applications, you use configuration classifications specified using configuration JSON objects. For more information, see Configuring Applications.

With earlier Amazon EMR releases, the application is any Amazon or third-party software that you can add to the cluster. This structure contains a list of strings that indicates the software to use with the cluster and accepts a user argument list. Amazon EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action argument.

" + }, + "ApplicationList":{ + "type":"list", + "member":{"shape":"Application"} + }, + "ArnType":{ + "type":"string", + "max":2048, + "min":20 + }, + "AutoScalingPolicy":{ + "type":"structure", + "required":[ + "Constraints", + "Rules" + ], + "members":{ + "Constraints":{ + "shape":"ScalingConstraints", + "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" + }, + "Rules":{ + "shape":"ScalingRuleList", + "documentation":"

The scale-in and scale-out rules that comprise the automatic scaling policy.

" + } + }, + "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. An automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" + }, + "AutoScalingPolicyDescription":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"AutoScalingPolicyStatus", + "documentation":"

The status of an automatic scaling policy.

" + }, + "Constraints":{ + "shape":"ScalingConstraints", + "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activity will not cause an instance group to grow above or below these limits.

" + }, + "Rules":{ + "shape":"ScalingRuleList", + "documentation":"

The scale-in and scale-out rules that comprise the automatic scaling policy.

" + } + }, + "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" + }, + "AutoScalingPolicyState":{ + "type":"string", + "enum":[ + "PENDING", + "ATTACHING", + "ATTACHED", + "DETACHING", + "DETACHED", + "FAILED" + ] + }, + "AutoScalingPolicyStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"AutoScalingPolicyStateChangeReasonCode", + "documentation":"

The code indicating the reason for the change in status.USER_REQUEST indicates that the scaling policy status was changed by a user. PROVISION_FAILURE indicates that the status change was because the policy failed to provision. CLEANUP_FAILURE indicates an error.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A friendly, more verbose message that accompanies an automatic scaling policy state change.

" + } + }, + "documentation":"

The reason for an AutoScalingPolicyStatus change.

" + }, + "AutoScalingPolicyStateChangeReasonCode":{ + "type":"string", + "enum":[ + "USER_REQUEST", + "PROVISION_FAILURE", + "CLEANUP_FAILURE" + ] + }, + "AutoScalingPolicyStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"AutoScalingPolicyState", + "documentation":"

Indicates the status of the automatic scaling policy.

" + }, + "StateChangeReason":{ + "shape":"AutoScalingPolicyStateChangeReason", + "documentation":"

The reason for a change in status.

" + } + }, + "documentation":"

The status of an automatic scaling policy.

" + }, + "BlockPublicAccessConfiguration":{ + "type":"structure", + "required":["BlockPublicSecurityGroupRules"], + "members":{ + "BlockPublicSecurityGroupRules":{ + "shape":"Boolean", + "documentation":"

Indicates whether EMR block public access is enabled (true) or disabled (false). By default, the value is false for accounts that have created EMR clusters before July 2019. For accounts created after this, the default is true.

" + }, + "PermittedPublicSecurityGroupRuleRanges":{ + "shape":"PortRanges", + "documentation":"

Specifies ports and port ranges that are permitted to have security group rules that allow inbound traffic from all public sources. For example, if Port 23 (Telnet) is specified for PermittedPublicSecurityGroupRuleRanges, Amazon EMR allows cluster creation if a security group associated with the cluster has a rule that allows inbound traffic on Port 23 from IPv4 0.0.0.0/0 or IPv6 port ::/0 as the source.

By default, Port 22, which is used for SSH access to the cluster EC2 instances, is in the list of PermittedPublicSecurityGroupRuleRanges.

" + } + }, + "documentation":"

A configuration for Amazon EMR block public access. When BlockPublicSecurityGroupRules is set to true, Amazon EMR prevents cluster creation if one of the cluster's security groups has a rule that allows inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges.

" + }, + "BlockPublicAccessConfigurationMetadata":{ + "type":"structure", + "required":[ + "CreationDateTime", + "CreatedByArn" + ], + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time that the configuration was created.

" + }, + "CreatedByArn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name that created or last modified the configuration.

" + } + }, + "documentation":"

Properties that describe the AWS principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.

" + }, + "Boolean":{"type":"boolean"}, + "BooleanObject":{"type":"boolean"}, + "BootstrapActionConfig":{ + "type":"structure", + "required":[ + "Name", + "ScriptBootstrapAction" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the bootstrap action.

" + }, + "ScriptBootstrapAction":{ + "shape":"ScriptBootstrapActionConfig", + "documentation":"

The script run by the bootstrap action.

" + } + }, + "documentation":"

Configuration of a bootstrap action.

" + }, + "BootstrapActionConfigList":{ + "type":"list", + "member":{"shape":"BootstrapActionConfig"} + }, + "BootstrapActionDetail":{ + "type":"structure", + "members":{ + "BootstrapActionConfig":{ + "shape":"BootstrapActionConfig", + "documentation":"

A description of the bootstrap action.

" + } + }, + "documentation":"

Reports the configuration of a bootstrap action in a cluster (job flow).

" + }, + "BootstrapActionDetailList":{ + "type":"list", + "member":{"shape":"BootstrapActionDetail"} + }, + "CancelStepsInfo":{ + "type":"structure", + "members":{ + "StepId":{ + "shape":"StepId", + "documentation":"

The encrypted StepId of a step.

" + }, + "Status":{ + "shape":"CancelStepsRequestStatus", + "documentation":"

The status of a CancelSteps Request. The value may be SUBMITTED or FAILED.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

The reason for the failure if the CancelSteps request fails.

" + } + }, + "documentation":"

Specification of the status of a CancelSteps request. Available only in Amazon EMR version 4.8.0 and later, excluding version 5.0.0.

" + }, + "CancelStepsInfoList":{ + "type":"list", + "member":{"shape":"CancelStepsInfo"} + }, + "CancelStepsInput":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The ClusterID for which specified steps will be canceled. Use RunJobFlow and ListClusters to get ClusterIDs.

" + }, + "StepIds":{ + "shape":"StepIdsList", + "documentation":"

The list of StepIDs to cancel. Use ListSteps to get steps and their states for the specified cluster.

" + } + }, + "documentation":"

The input argument to the CancelSteps operation.

" + }, + "CancelStepsOutput":{ + "type":"structure", + "members":{ + "CancelStepsInfoList":{ + "shape":"CancelStepsInfoList", + "documentation":"

A list of CancelStepsInfo, which shows the status of specified cancel requests for each StepID specified.

" + } + }, + "documentation":"

The output for the CancelSteps operation.

" + }, + "CancelStepsRequestStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "FAILED" + ] + }, + "CloudWatchAlarmDefinition":{ + "type":"structure", + "required":[ + "ComparisonOperator", + "MetricName", + "Period", + "Threshold" + ], + "members":{ + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

Determines how the metric specified by MetricName is compared to the value specified by Threshold.

" + }, + "EvaluationPeriods":{ + "shape":"Integer", + "documentation":"

The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.

" + }, + "MetricName":{ + "shape":"String", + "documentation":"

The name of the CloudWatch metric that is watched to determine an alarm condition.

" + }, + "Namespace":{ + "shape":"String", + "documentation":"

The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.

" + }, + "Period":{ + "shape":"Integer", + "documentation":"

The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.

" + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

The statistic to apply to the metric associated with the alarm. The default is AVERAGE.

" + }, + "Threshold":{ + "shape":"NonNegativeDouble", + "documentation":"

The value against which the specified statistic is compared.

" + }, + "Unit":{ + "shape":"Unit", + "documentation":"

The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.

" + }, + "Dimensions":{ + "shape":"MetricDimensionList", + "documentation":"

A CloudWatch metric dimension.

" + } + }, + "documentation":"

The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

" + }, + "Cluster":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ClusterId", + "documentation":"

The unique identifier for the cluster.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster.

" + }, + "Status":{ + "shape":"ClusterStatus", + "documentation":"

The current status details about the cluster.

" + }, + "Ec2InstanceAttributes":{ + "shape":"Ec2InstanceAttributes", + "documentation":"

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" + }, + "InstanceCollectionType":{ + "shape":"InstanceCollectionType", + "documentation":"

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

" + }, + "LogUri":{ + "shape":"String", + "documentation":"

The path to the Amazon S3 location where logs for this cluster are stored.

" + }, + "RequestedAmiVersion":{ + "shape":"String", + "documentation":"

The AMI version requested for this cluster.

" + }, + "RunningAmiVersion":{ + "shape":"String", + "documentation":"

The AMI version running on this cluster.

" + }, + "ReleaseLabel":{ + "shape":"String", + "documentation":"

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" + }, + "AutoTerminate":{ + "shape":"Boolean", + "documentation":"

Specifies whether the cluster should terminate after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Indicates whether Amazon EMR will lock the cluster to prevent the EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

This member will be deprecated.

Indicates whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and manage the cluster if they have the proper policy permissions set. If this value is false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

" + }, + "Applications":{ + "shape":"ApplicationList", + "documentation":"

The applications installed on this cluster.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags associated with a cluster.

" + }, + "ServiceRole":{ + "shape":"String", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + }, + "NormalizedInstanceHours":{ + "shape":"Integer", + "documentation":"

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + }, + "MasterPublicDnsName":{ + "shape":"String", + "documentation":"

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

Applies only to Amazon EMR releases 4.x and later. The list of Configurations supplied to the EMR cluster.

" + }, + "SecurityConfiguration":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration applied to the cluster.

" + }, + "AutoScalingRole":{ + "shape":"XmlString", + "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" + }, + "ScaleDownBehavior":{ + "shape":"ScaleDownBehavior", + "documentation":"

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + }, + "CustomAmiId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

" + }, + "EbsRootVolumeSize":{ + "shape":"Integer", + "documentation":"

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" + }, + "RepoUpgradeOnBoot":{ + "shape":"RepoUpgradeOnBoot", + "documentation":"

Applies only when CustomAmiID is used. Specifies the type of updates that are applied from the Amazon Linux AMI package repositories when an instance boots using the AMI.

" + }, + "KerberosAttributes":{ + "shape":"KerberosAttributes", + "documentation":"

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" + } + }, + "documentation":"

The detailed description of the cluster.

" + }, + "ClusterId":{"type":"string"}, + "ClusterState":{ + "type":"string", + "enum":[ + "STARTING", + "BOOTSTRAPPING", + "RUNNING", + "WAITING", + "TERMINATING", + "TERMINATED", + "TERMINATED_WITH_ERRORS" + ] + }, + "ClusterStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ClusterStateChangeReasonCode", + "documentation":"

The programmatic code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The descriptive message for the state change reason.

" + } + }, + "documentation":"

The reason that the cluster changed to its current state.

" + }, + "ClusterStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "INSTANCE_FLEET_TIMEOUT", + "BOOTSTRAP_FAILURE", + "USER_REQUEST", + "STEP_FAILURE", + "ALL_STEPS_COMPLETED" + ] + }, + "ClusterStateList":{ + "type":"list", + "member":{"shape":"ClusterState"} + }, + "ClusterStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ClusterState", + "documentation":"

The current state of the cluster.

" + }, + "StateChangeReason":{ + "shape":"ClusterStateChangeReason", + "documentation":"

The reason for the cluster status change.

" + }, + "Timeline":{ + "shape":"ClusterTimeline", + "documentation":"

A timeline that represents the status of a cluster over the lifetime of the cluster.

" + } + }, + "documentation":"

The detailed status of the cluster.

" + }, + "ClusterSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ClusterId", + "documentation":"

The unique identifier for the cluster.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster.

" + }, + "Status":{ + "shape":"ClusterStatus", + "documentation":"

The details about the current status of the cluster.

" + }, + "NormalizedInstanceHours":{ + "shape":"Integer", + "documentation":"

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + } + }, + "documentation":"

The summary description of the cluster.

" + }, + "ClusterSummaryList":{ + "type":"list", + "member":{"shape":"ClusterSummary"} + }, + "ClusterTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the cluster.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster was ready to execute steps.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster was terminated.

" + } + }, + "documentation":"

Represents the timeline of the cluster's lifecycle.

" + }, + "Command":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the command.

" + }, + "ScriptPath":{ + "shape":"String", + "documentation":"

The Amazon S3 location of the command script.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

Arguments for Amazon EMR to pass to the command for execution.

" + } + }, + "documentation":"

An entity describing an executable that runs on a cluster.

" + }, + "CommandList":{ + "type":"list", + "member":{"shape":"Command"} + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GREATER_THAN_OR_EQUAL", + "GREATER_THAN", + "LESS_THAN", + "LESS_THAN_OR_EQUAL" + ] + }, + "Configuration":{ + "type":"structure", + "members":{ + "Classification":{ + "shape":"String", + "documentation":"

The classification within a configuration.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

A list of additional configurations to apply within a configuration object.

" + }, + "Properties":{ + "shape":"StringMap", + "documentation":"

A set of properties specified within a configuration classification.

" + } + }, + "documentation":"

Amazon EMR releases 4.x or later.

An optional configuration specification to be used when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR. A configuration consists of a classification, properties, and optional nested configurations. A classification refers to an application-specific configuration file. Properties are the settings you want to change in that file. For more information, see Configuring Applications.

" + }, + "ConfigurationList":{ + "type":"list", + "member":{"shape":"Configuration"} + }, + "CreateSecurityConfigurationInput":{ + "type":"structure", + "required":[ + "Name", + "SecurityConfiguration" + ], + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + }, + "SecurityConfiguration":{ + "shape":"String", + "documentation":"

The security configuration details in JSON format. For JSON parameters and examples, see Use Security Configurations to Set Up Cluster Security in the Amazon EMR Management Guide.

" + } + } + }, + "CreateSecurityConfigurationOutput":{ + "type":"structure", + "required":[ + "Name", + "CreationDateTime" + ], + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time the security configuration was created.

" + } + } + }, + "Date":{"type":"timestamp"}, + "DeleteSecurityConfigurationInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + } + } + }, + "DeleteSecurityConfigurationOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeClusterInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster to describe.

" + } + }, + "documentation":"

This input determines which cluster to describe.

" + }, + "DescribeClusterOutput":{ + "type":"structure", + "members":{ + "Cluster":{ + "shape":"Cluster", + "documentation":"

This output contains the details for the requested cluster.

" + } + }, + "documentation":"

This output contains the description of the cluster.

" + }, + "DescribeJobFlowsInput":{ + "type":"structure", + "members":{ + "CreatedAfter":{ + "shape":"Date", + "documentation":"

Return only job flows created after this date and time.

" + }, + "CreatedBefore":{ + "shape":"Date", + "documentation":"

Return only job flows created before this date and time.

" + }, + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

Return only job flows whose job flow ID is contained in this list.

" + }, + "JobFlowStates":{ + "shape":"JobFlowExecutionStateList", + "documentation":"

Return only job flows whose state is contained in this list.

" + } + }, + "documentation":"

The input for the DescribeJobFlows operation.

" + }, + "DescribeJobFlowsOutput":{ + "type":"structure", + "members":{ + "JobFlows":{ + "shape":"JobFlowDetailList", + "documentation":"

A list of job flows matching the parameters supplied.

" + } + }, + "documentation":"

The output for the DescribeJobFlows operation.

" + }, + "DescribeSecurityConfigurationInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + } + } + }, + "DescribeSecurityConfigurationOutput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + }, + "SecurityConfiguration":{ + "shape":"String", + "documentation":"

The security configuration details in JSON format.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time the security configuration was created

" + } + } + }, + "DescribeStepInput":{ + "type":"structure", + "required":[ + "ClusterId", + "StepId" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster with steps to describe.

" + }, + "StepId":{ + "shape":"StepId", + "documentation":"

The identifier of the step to describe.

" + } + }, + "documentation":"

This input determines which step to describe.

" + }, + "DescribeStepOutput":{ + "type":"structure", + "members":{ + "Step":{ + "shape":"Step", + "documentation":"

The step details for the requested step identifier.

" + } + }, + "documentation":"

This output contains the description of the cluster step.

" + }, + "EC2InstanceIdsList":{ + "type":"list", + "member":{"shape":"InstanceId"} + }, + "EC2InstanceIdsToTerminateList":{ + "type":"list", + "member":{"shape":"InstanceId"} + }, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "VolumeSpecification":{ + "shape":"VolumeSpecification", + "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name that is exposed to the instance, such as /dev/sdh.

" + } + }, + "documentation":"

Configuration of requested EBS block device associated with the instance group.

" + }, + "EbsBlockDeviceConfig":{ + "type":"structure", + "required":["VolumeSpecification"], + "members":{ + "VolumeSpecification":{ + "shape":"VolumeSpecification", + "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" + }, + "VolumesPerInstance":{ + "shape":"Integer", + "documentation":"

Number of EBS volumes with a specific volume configuration that will be associated with every instance in the instance group

" + } + }, + "documentation":"

Configuration of requested EBS block device associated with the instance group with count of volumes that will be associated to every instance.

" + }, + "EbsBlockDeviceConfigList":{ + "type":"list", + "member":{"shape":"EbsBlockDeviceConfig"} + }, + "EbsBlockDeviceList":{ + "type":"list", + "member":{"shape":"EbsBlockDevice"} + }, + "EbsConfiguration":{ + "type":"structure", + "members":{ + "EbsBlockDeviceConfigs":{ + "shape":"EbsBlockDeviceConfigList", + "documentation":"

An array of Amazon EBS volume specifications attached to a cluster instance.

" + }, + "EbsOptimized":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether an Amazon EBS volume is EBS-optimized.

" + } + }, + "documentation":"

The Amazon EBS configuration of a cluster instance.

" + }, + "EbsVolume":{ + "type":"structure", + "members":{ + "Device":{ + "shape":"String", + "documentation":"

The device name that is exposed to the instance, such as /dev/sdh.

" + }, + "VolumeId":{ + "shape":"String", + "documentation":"

The volume identifier of the EBS volume.

" + } + }, + "documentation":"

EBS block device that's attached to an EC2 instance.

" + }, + "EbsVolumeList":{ + "type":"list", + "member":{"shape":"EbsVolume"} + }, + "Ec2InstanceAttributes":{ + "type":"structure", + "members":{ + "Ec2KeyName":{ + "shape":"String", + "documentation":"

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named \"hadoop\".

" + }, + "Ec2SubnetId":{ + "shape":"String", + "documentation":"

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" + }, + "RequestedEc2SubnetIds":{ + "shape":"XmlStringMaxLen256List", + "documentation":"

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

" + }, + "Ec2AvailabilityZone":{ + "shape":"String", + "documentation":"

The Availability Zone in which the cluster will run.

" + }, + "RequestedEc2AvailabilityZones":{ + "shape":"XmlStringMaxLen256List", + "documentation":"

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

" + }, + "IamInstanceProfile":{ + "shape":"String", + "documentation":"

The IAM role that was specified when the cluster was launched. The EC2 instances of the cluster assume this role.

" + }, + "EmrManagedMasterSecurityGroup":{ + "shape":"String", + "documentation":"

The identifier of the Amazon EC2 security group for the master node.

" + }, + "EmrManagedSlaveSecurityGroup":{ + "shape":"String", + "documentation":"

The identifier of the Amazon EC2 security group for the core and task nodes.

" + }, + "ServiceAccessSecurityGroup":{ + "shape":"String", + "documentation":"

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" + }, + "AdditionalMasterSecurityGroups":{ + "shape":"StringList", + "documentation":"

A list of additional Amazon EC2 security group IDs for the master node.

" + }, + "AdditionalSlaveSecurityGroups":{ + "shape":"StringList", + "documentation":"

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" + } + }, + "documentation":"

Provides information about the EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

" + }, + "ErrorCode":{ + "type":"string", + "max":256, + "min":1 + }, + "ErrorMessage":{"type":"string"}, + "FailureDetails":{ + "type":"structure", + "members":{ + "Reason":{ + "shape":"String", + "documentation":"

The reason for the step failure. In the case where the service cannot successfully determine the root cause of the failure, it returns \"Unknown Error\" as a reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The descriptive message including the error the EMR service has identified as the cause of step failure. This is text from an error log that describes the root cause of the failure.

" + }, + "LogFile":{ + "shape":"String", + "documentation":"

The path to the log file where the step failure root cause was originally recorded.

" + } + }, + "documentation":"

The details of the step failure. The service attempts to detect the root cause for many common failures.

" + }, + "GetBlockPublicAccessConfigurationInput":{ + "type":"structure", + "members":{ + } + }, + "GetBlockPublicAccessConfigurationOutput":{ + "type":"structure", + "required":[ + "BlockPublicAccessConfiguration", + "BlockPublicAccessConfigurationMetadata" + ], + "members":{ + "BlockPublicAccessConfiguration":{ + "shape":"BlockPublicAccessConfiguration", + "documentation":"

A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating the block public access configuration to remove the exception.

" + }, + "BlockPublicAccessConfigurationMetadata":{ + "shape":"BlockPublicAccessConfigurationMetadata", + "documentation":"

Properties that describe the AWS principal that created the BlockPublicAccessConfiguration using the PutBlockPublicAccessConfiguration action as well as the date and time that the configuration was created. Each time a configuration for block public access is updated, Amazon EMR updates this metadata.

" + } + } + }, + "HadoopJarStepConfig":{ + "type":"structure", + "required":["Jar"], + "members":{ + "Properties":{ + "shape":"KeyValueList", + "documentation":"

A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" + }, + "Jar":{ + "shape":"XmlString", + "documentation":"

A path to a JAR file run during the step.

" + }, + "MainClass":{ + "shape":"XmlString", + "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file should specify a Main-Class in its manifest file.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

A list of command line arguments passed to the JAR file's main function when executed.

" + } + }, + "documentation":"

A job flow step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

" + }, + "HadoopStepConfig":{ + "type":"structure", + "members":{ + "Jar":{ + "shape":"String", + "documentation":"

The path to the JAR file that runs during the step.

" + }, + "Properties":{ + "shape":"StringMap", + "documentation":"

The list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.

" + }, + "MainClass":{ + "shape":"String", + "documentation":"

The name of the main class in the specified Java file. If not specified, the JAR file should specify a main class in its manifest file.

" + }, + "Args":{ + "shape":"StringList", + "documentation":"

The list of command line arguments to pass to the JAR file's main function for execution.

" + } + }, + "documentation":"

A cluster step consisting of a JAR file whose main function will be executed. The main function submits a job for Hadoop to execute and waits for the job to finish or fail.

" + }, + "Instance":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InstanceId", + "documentation":"

The unique identifier for the instance in Amazon EMR.

" + }, + "Ec2InstanceId":{ + "shape":"InstanceId", + "documentation":"

The unique identifier of the instance in Amazon EC2.

" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

The public DNS name of the instance.

" + }, + "PublicIpAddress":{ + "shape":"String", + "documentation":"

The public IP address of the instance.

" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

The private DNS name of the instance.

" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

The private IP address of the instance.

" + }, + "Status":{ + "shape":"InstanceStatus", + "documentation":"

The current status of the instance.

" + }, + "InstanceGroupId":{ + "shape":"String", + "documentation":"

The identifier of the instance group to which this instance belongs.

" + }, + "InstanceFleetId":{ + "shape":"InstanceFleetId", + "documentation":"

The unique identifier of the instance fleet to which an EC2 instance belongs.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

The instance purchasing option. Valid values are ON_DEMAND or SPOT.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type, for example m3.xlarge.

" + }, + "EbsVolumes":{ + "shape":"EbsVolumeList", + "documentation":"

The list of EBS volumes that are attached to this instance.

" + } + }, + "documentation":"

Represents an EC2 instance provisioned as part of cluster.

" + }, + "InstanceCollectionType":{ + "type":"string", + "enum":[ + "INSTANCE_FLEET", + "INSTANCE_GROUP" + ] + }, + "InstanceFleet":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InstanceFleetId", + "documentation":"

The unique identifier of the instance fleet.

" + }, + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

A friendly name for the instance fleet.

" + }, + "Status":{ + "shape":"InstanceFleetStatus", + "documentation":"

The current status of the instance fleet.

" + }, + "InstanceFleetType":{ + "shape":"InstanceFleetType", + "documentation":"

The node type that the instance fleet hosts. Valid values are MASTER, CORE, or TASK.

" + }, + "TargetOnDemandCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedOnDemandCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

" + }, + "TargetSpotCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use InstanceFleet$ProvisionedSpotCapacity to determine the Spot capacity units that have been provisioned for the instance fleet.

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

" + }, + "ProvisionedOnDemandCapacity":{ + "shape":"WholeNumber", + "documentation":"

The number of On-Demand units that have been provisioned for the instance fleet to fulfill TargetOnDemandCapacity. This provisioned capacity might be less than or greater than TargetOnDemandCapacity.

" + }, + "ProvisionedSpotCapacity":{ + "shape":"WholeNumber", + "documentation":"

The number of Spot units that have been provisioned for this instance fleet to fulfill TargetSpotCapacity. This provisioned capacity might be less than or greater than TargetSpotCapacity.

" + }, + "InstanceTypeSpecifications":{ + "shape":"InstanceTypeSpecificationList", + "documentation":"

The specification for the instance types that comprise an instance fleet. Up to five unique instance specifications may be defined for each instance fleet.

" + }, + "LaunchSpecifications":{ + "shape":"InstanceFleetProvisioningSpecifications", + "documentation":"

Describes the launch specification for an instance fleet.

" + } + }, + "documentation":"

Describes an instance fleet, which is a group of EC2 instances that host a particular node type (master, core, or task) in an Amazon EMR cluster. Instance fleets can consist of a mix of instance types and On-Demand and Spot instances, which are provisioned to meet a defined target capacity.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetConfig":{ + "type":"structure", + "required":["InstanceFleetType"], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The friendly name of the instance fleet.

" + }, + "InstanceFleetType":{ + "shape":"InstanceFleetType", + "documentation":"

The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.

" + }, + "TargetOnDemandCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of On-Demand units for the instance fleet, which determines how many On-Demand instances to provision. When the instance fleet launches, Amazon EMR tries to provision On-Demand instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When an On-Demand instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

If not specified or set to 0, only Spot instances are provisioned for the instance fleet using TargetSpotCapacity. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

" + }, + "TargetSpotCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by InstanceTypeConfig. Each instance configuration has a specified WeightedCapacity. When a Spot instance is provisioned, the WeightedCapacity units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a WeightedCapacity of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units.

If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of TargetSpotCapacity and TargetOnDemandCapacity should be greater than 0. For a master instance fleet, only one of TargetSpotCapacity and TargetOnDemandCapacity can be specified, and its value must be 1.

" + }, + "InstanceTypeConfigs":{ + "shape":"InstanceTypeConfigList", + "documentation":"

The instance type configurations that define the EC2 instances in the instance fleet.

" + }, + "LaunchSpecifications":{ + "shape":"InstanceFleetProvisioningSpecifications", + "documentation":"

The launch specification for the instance fleet.

" + } + }, + "documentation":"

The configuration that defines an instance fleet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetConfigList":{ + "type":"list", + "member":{"shape":"InstanceFleetConfig"} + }, + "InstanceFleetId":{"type":"string"}, + "InstanceFleetList":{ + "type":"list", + "member":{"shape":"InstanceFleet"} + }, + "InstanceFleetModifyConfig":{ + "type":"structure", + "required":["InstanceFleetId"], + "members":{ + "InstanceFleetId":{ + "shape":"InstanceFleetId", + "documentation":"

A unique identifier for the instance fleet.

" + }, + "TargetOnDemandCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of On-Demand units for the instance fleet. For more information see InstanceFleetConfig$TargetOnDemandCapacity.

" + }, + "TargetSpotCapacity":{ + "shape":"WholeNumber", + "documentation":"

The target capacity of Spot units for the instance fleet. For more information, see InstanceFleetConfig$TargetSpotCapacity.

" + } + }, + "documentation":"

Configuration parameters for an instance fleet modification request.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetProvisioningSpecifications":{ + "type":"structure", + "required":["SpotSpecification"], + "members":{ + "SpotSpecification":{ + "shape":"SpotProvisioningSpecification", + "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

" + } + }, + "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetState":{ + "type":"string", + "enum":[ + "PROVISIONING", + "BOOTSTRAPPING", + "RUNNING", + "RESIZING", + "SUSPENDED", + "TERMINATING", + "TERMINATED" + ] + }, + "InstanceFleetStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"InstanceFleetStateChangeReasonCode", + "documentation":"

A code corresponding to the reason the state change occurred.

" + }, + "Message":{ + "shape":"String", + "documentation":"

An explanatory message.

" + } + }, + "documentation":"

Provides status change reason details for the instance fleet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "CLUSTER_TERMINATED" + ] + }, + "InstanceFleetStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"InstanceFleetState", + "documentation":"

A code representing the instance fleet status.

  • PROVISIONING—The instance fleet is provisioning EC2 resources and is not yet ready to run jobs.

  • BOOTSTRAPPING—EC2 instances and other resources have been provisioned and the bootstrap actions specified for the instances are underway.

  • RUNNING—EC2 instances and other resources are running. They are either executing jobs or waiting to execute jobs.

  • RESIZING—A resize operation is underway. EC2 instances are either being added or removed.

  • SUSPENDED—A resize operation could not complete. Existing EC2 instances are running, but instances can't be added or removed.

  • TERMINATING—The instance fleet is terminating EC2 instances.

  • TERMINATED—The instance fleet is no longer active, and all EC2 instances have been terminated.

" + }, + "StateChangeReason":{ + "shape":"InstanceFleetStateChangeReason", + "documentation":"

Provides status change reason details for the instance fleet.

" + }, + "Timeline":{ + "shape":"InstanceFleetTimeline", + "documentation":"

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

" + } + }, + "documentation":"

The status of the instance fleet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The time and date the instance fleet was created.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The time and date the instance fleet was ready to run jobs.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The time and date the instance fleet terminated.

" + } + }, + "documentation":"

Provides historical timestamps for the instance fleet, including the time of creation, the time it became ready to run jobs, and the time of termination.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceFleetType":{ + "type":"string", + "enum":[ + "MASTER", + "CORE", + "TASK" + ] + }, + "InstanceGroup":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InstanceGroupId", + "documentation":"

The identifier of the instance group.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

" + }, + "InstanceGroupType":{ + "shape":"InstanceGroupType", + "documentation":"

The type of the instance group. Valid values are MASTER, CORE or TASK.

" + }, + "BidPrice":{ + "shape":"String", + "documentation":"

The maximum Spot price your are willing to pay for EC2 instances.

An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type for all instances in the instance group.

" + }, + "RequestedInstanceCount":{ + "shape":"Integer", + "documentation":"

The target number of instances for the instance group.

" + }, + "RunningInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances currently running in this instance group.

" + }, + "Status":{ + "shape":"InstanceGroupStatus", + "documentation":"

The current status of the instance group.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" + }, + "ConfigurationsVersion":{ + "shape":"Long", + "documentation":"

The version number of the requested configuration specification for this instance group.

" + }, + "LastSuccessfullyAppliedConfigurations":{ + "shape":"ConfigurationList", + "documentation":"

A list of configurations that were successfully applied for an instance group last time.

" + }, + "LastSuccessfullyAppliedConfigurationsVersion":{ + "shape":"Long", + "documentation":"

The version number of a configuration specification that was successfully applied for an instance group last time.

" + }, + "EbsBlockDevices":{ + "shape":"EbsBlockDeviceList", + "documentation":"

The EBS block devices that are mapped to this instance group.

" + }, + "EbsOptimized":{ + "shape":"BooleanObject", + "documentation":"

If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

" + }, + "ShrinkPolicy":{ + "shape":"ShrinkPolicy", + "documentation":"

Policy for customizing shrink operations.

" + }, + "AutoScalingPolicy":{ + "shape":"AutoScalingPolicyDescription", + "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" + } + }, + "documentation":"

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

" + }, + "InstanceGroupConfig":{ + "type":"structure", + "required":[ + "InstanceRole", + "InstanceType", + "InstanceCount" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Friendly name given to the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

Market type of the EC2 instances used to create a cluster node.

" + }, + "InstanceRole":{ + "shape":"InstanceRoleType", + "documentation":"

The role of the instance group in the cluster.

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The maximum Spot price your are willing to pay for EC2 instances.

An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specify the maximum spot price in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type for all instances in the instance group.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

Target number of instances for the instance group.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

Amazon EMR releases 4.x or later.

The list of configurations supplied for an EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

" + }, + "EbsConfiguration":{ + "shape":"EbsConfiguration", + "documentation":"

EBS configurations that will be attached to each EC2 instance in the instance group.

" + }, + "AutoScalingPolicy":{ + "shape":"AutoScalingPolicy", + "documentation":"

An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

" + } + }, + "documentation":"

Configuration defining a new instance group.

" + }, + "InstanceGroupConfigList":{ + "type":"list", + "member":{"shape":"InstanceGroupConfig"} + }, + "InstanceGroupDetail":{ + "type":"structure", + "required":[ + "Market", + "InstanceRole", + "InstanceType", + "InstanceRequestCount", + "InstanceRunningCount", + "State", + "CreationDateTime" + ], + "members":{ + "InstanceGroupId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Unique identifier for the instance group.

" + }, + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Friendly name for the instance group.

" + }, + "Market":{ + "shape":"MarketType", + "documentation":"

Market type of the EC2 instances used to create a cluster node.

" + }, + "InstanceRole":{ + "shape":"InstanceRoleType", + "documentation":"

Instance group role in the cluster

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The maximum Spot price your are willing to pay for EC2 instances.

An optional, nullable field that applies if the MarketType for the instance group is specified as SPOT. Specified in USD. If the value is NULL and SPOT is specified, the maximum Spot price is set equal to the On-Demand price.

" + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

EC2 instance type.

" + }, + "InstanceRequestCount":{ + "shape":"Integer", + "documentation":"

Target number of instances to run in the instance group.

" + }, + "InstanceRunningCount":{ + "shape":"Integer", + "documentation":"

Actual count of running instances.

" + }, + "State":{ + "shape":"InstanceGroupState", + "documentation":"

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

Details regarding the state of the instance group.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was created.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was started.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was available to the cluster.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date/time the instance group was terminated.

" + } + }, + "documentation":"

Detailed information about an instance group.

" + }, + "InstanceGroupDetailList":{ + "type":"list", + "member":{"shape":"InstanceGroupDetail"} + }, + "InstanceGroupId":{"type":"string"}, + "InstanceGroupIdsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "InstanceGroupList":{ + "type":"list", + "member":{"shape":"InstanceGroup"} + }, + "InstanceGroupModifyConfig":{ + "type":"structure", + "required":["InstanceGroupId"], + "members":{ + "InstanceGroupId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Unique ID of the instance group to expand or shrink.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

Target size for the instance group.

" + }, + "EC2InstanceIdsToTerminate":{ + "shape":"EC2InstanceIdsToTerminateList", + "documentation":"

The EC2 InstanceIds to terminate. After you terminate the instances, the instance group will not return to its original requested size.

" + }, + "ShrinkPolicy":{ + "shape":"ShrinkPolicy", + "documentation":"

Policy for customizing shrink operations.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

A list of new or modified configurations to apply for an instance group.

" + } + }, + "documentation":"

Modify the size or configurations of an instance group.

" + }, + "InstanceGroupModifyConfigList":{ + "type":"list", + "member":{"shape":"InstanceGroupModifyConfig"} + }, + "InstanceGroupState":{ + "type":"string", + "enum":[ + "PROVISIONING", + "BOOTSTRAPPING", + "RUNNING", + "RECONFIGURING", + "RESIZING", + "SUSPENDED", + "TERMINATING", + "TERMINATED", + "ARRESTED", + "SHUTTING_DOWN", + "ENDED" + ] + }, + "InstanceGroupStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"InstanceGroupStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The status change reason description.

" + } + }, + "documentation":"

The status change reason details for the instance group.

" + }, + "InstanceGroupStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "CLUSTER_TERMINATED" + ] + }, + "InstanceGroupStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"InstanceGroupState", + "documentation":"

The current state of the instance group.

" + }, + "StateChangeReason":{ + "shape":"InstanceGroupStateChangeReason", + "documentation":"

The status change reason details for the instance group.

" + }, + "Timeline":{ + "shape":"InstanceGroupTimeline", + "documentation":"

The timeline of the instance group status over time.

" + } + }, + "documentation":"

The details of the instance group status.

" + }, + "InstanceGroupTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the instance group.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance group became ready to perform tasks.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance group terminated.

" + } + }, + "documentation":"

The timeline of the instance group lifecycle.

" + }, + "InstanceGroupType":{ + "type":"string", + "enum":[ + "MASTER", + "CORE", + "TASK" + ] + }, + "InstanceGroupTypeList":{ + "type":"list", + "member":{"shape":"InstanceGroupType"} + }, + "InstanceId":{"type":"string"}, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstanceResizePolicy":{ + "type":"structure", + "members":{ + "InstancesToTerminate":{ + "shape":"EC2InstanceIdsList", + "documentation":"

Specific list of instances to be terminated when shrinking an instance group.

" + }, + "InstancesToProtect":{ + "shape":"EC2InstanceIdsList", + "documentation":"

Specific list of instances to be protected when shrinking an instance group.

" + }, + "InstanceTerminationTimeout":{ + "shape":"Integer", + "documentation":"

Decommissioning timeout override for the specific list of instances to be terminated.

" + } + }, + "documentation":"

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" + }, + "InstanceRoleType":{ + "type":"string", + "enum":[ + "MASTER", + "CORE", + "TASK" + ] + }, + "InstanceState":{ + "type":"string", + "enum":[ + "AWAITING_FULFILLMENT", + "PROVISIONING", + "BOOTSTRAPPING", + "RUNNING", + "TERMINATED" + ] + }, + "InstanceStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"InstanceStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The status change reason description.

" + } + }, + "documentation":"

The details of the status change reason for the instance.

" + }, + "InstanceStateChangeReasonCode":{ + "type":"string", + "enum":[ + "INTERNAL_ERROR", + "VALIDATION_ERROR", + "INSTANCE_FAILURE", + "BOOTSTRAP_FAILURE", + "CLUSTER_TERMINATED" + ] + }, + "InstanceStateList":{ + "type":"list", + "member":{"shape":"InstanceState"} + }, + "InstanceStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"InstanceState", + "documentation":"

The current state of the instance.

" + }, + "StateChangeReason":{ + "shape":"InstanceStateChangeReason", + "documentation":"

The details of the status change reason for the instance.

" + }, + "Timeline":{ + "shape":"InstanceTimeline", + "documentation":"

The timeline of the instance status over time.

" + } + }, + "documentation":"

The instance status details.

" + }, + "InstanceTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the instance.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance was ready to perform tasks.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the instance was terminated.

" + } + }, + "documentation":"

The timeline of the instance lifecycle.

" + }, + "InstanceType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "InstanceTypeConfig":{ + "type":"structure", + "required":["InstanceType"], + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

An EC2 instance type, such as m3.xlarge.

" + }, + "WeightedCapacity":{ + "shape":"WholeNumber", + "documentation":"

The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. This value is 1 for a master instance fleet, and must be 1 or greater for core and task instance fleets. Defaults to 1 if not specified.

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD. If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" + }, + "BidPriceAsPercentageOfOnDemandPrice":{ + "shape":"NonNegativeDouble", + "documentation":"

The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%). If neither BidPrice nor BidPriceAsPercentageOfOnDemandPrice is provided, BidPriceAsPercentageOfOnDemandPrice defaults to 100%.

" + }, + "EbsConfiguration":{ + "shape":"EbsConfiguration", + "documentation":"

The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software that run on the cluster.

" + } + }, + "documentation":"

An instance type configuration for each instance type in an instance fleet, which determines the EC2 instances Amazon EMR attempts to provision to fulfill On-Demand and Spot target capacities. There can be a maximum of 5 instance type configurations in a fleet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceTypeConfigList":{ + "type":"list", + "member":{"shape":"InstanceTypeConfig"} + }, + "InstanceTypeSpecification":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type, for example m3.xlarge.

" + }, + "WeightedCapacity":{ + "shape":"WholeNumber", + "documentation":"

The number of units that a provisioned instance of this type provides toward fulfilling the target capacities defined in InstanceFleetConfig. Capacity values represent performance characteristics such as vCPUs, memory, or I/O. If not specified, the default value is 1.

" + }, + "BidPrice":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The bid price for each EC2 Spot instance type as defined by InstanceType. Expressed in USD.

" + }, + "BidPriceAsPercentageOfOnDemandPrice":{ + "shape":"NonNegativeDouble", + "documentation":"

The bid price, as a percentage of On-Demand price, for each EC2 Spot instance as defined by InstanceType. Expressed as a number (for example, 20 specifies 20%).

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

A configuration classification that applies when provisioning cluster instances, which can include configurations for applications and software bundled with Amazon EMR.

" + }, + "EbsBlockDevices":{ + "shape":"EbsBlockDeviceList", + "documentation":"

The configuration of Amazon Elastic Block Storage (EBS) attached to each instance as defined by InstanceType.

" + }, + "EbsOptimized":{ + "shape":"BooleanObject", + "documentation":"

Evaluates to TRUE when the specified InstanceType is EBS-optimized.

" + } + }, + "documentation":"

The configuration specification for each instance type in an instance fleet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "InstanceTypeSpecificationList":{ + "type":"list", + "member":{"shape":"InstanceTypeSpecification"} + }, + "Integer":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + }, + "documentation":"

Indicates that an error occurred while processing the request and that the request was not completed.

", + "exception":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with the exception.

" + } + }, + "documentation":"

This exception occurs when there is an internal failure in the EMR service.

", + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code associated with the exception.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with the exception.

" + } + }, + "documentation":"

This exception occurs when there is something wrong with user input.

", + "exception":true + }, + "JobFlowDetail":{ + "type":"structure", + "required":[ + "JobFlowId", + "Name", + "ExecutionStatusDetail", + "Instances" + ], + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The job flow identifier.

" + }, + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the job flow.

" + }, + "LogUri":{ + "shape":"XmlString", + "documentation":"

The location in Amazon S3 where log files for the job are stored.

" + }, + "AmiVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" + }, + "ExecutionStatusDetail":{ + "shape":"JobFlowExecutionStatusDetail", + "documentation":"

Describes the execution status of the job flow.

" + }, + "Instances":{ + "shape":"JobFlowInstancesDetail", + "documentation":"

Describes the Amazon EC2 instances of the job flow.

" + }, + "Steps":{ + "shape":"StepDetailList", + "documentation":"

A list of steps run by the job flow.

" + }, + "BootstrapActions":{ + "shape":"BootstrapActionDetailList", + "documentation":"

A list of the bootstrap actions run by the job flow.

" + }, + "SupportedProducts":{ + "shape":"SupportedProductsList", + "documentation":"

A list of strings set by third party software when the job flow is launched. If you are not using third party software to manage the job flow this value is empty.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

This member will be deprecated.

Specifies whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it. This value can be changed using the SetVisibleToAllUsers action.

" + }, + "JobFlowRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that was specified when the job flow was launched. The EC2 instances of the job flow assume this role.

" + }, + "ServiceRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + }, + "AutoScalingRole":{ + "shape":"XmlString", + "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides a way for the automatic scaling feature to get the required permissions it needs to launch and terminate EC2 instances in an instance group.

" + }, + "ScaleDownBehavior":{ + "shape":"ScaleDownBehavior", + "documentation":"

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + } + }, + "documentation":"

A description of a cluster (job flow).

" + }, + "JobFlowDetailList":{ + "type":"list", + "member":{"shape":"JobFlowDetail"} + }, + "JobFlowExecutionState":{ + "type":"string", + "documentation":"

The type of instance.

", + "enum":[ + "STARTING", + "BOOTSTRAPPING", + "RUNNING", + "WAITING", + "SHUTTING_DOWN", + "TERMINATED", + "COMPLETED", + "FAILED" + ] + }, + "JobFlowExecutionStateList":{ + "type":"list", + "member":{"shape":"JobFlowExecutionState"} + }, + "JobFlowExecutionStatusDetail":{ + "type":"structure", + "required":[ + "State", + "CreationDateTime" + ], + "members":{ + "State":{ + "shape":"JobFlowExecutionState", + "documentation":"

The state of the job flow.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the job flow.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The start date and time of the job flow.

" + }, + "ReadyDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the job flow was ready to start running bootstrap actions.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The completion date and time of the job flow.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

Description of the job flow last changed state.

" + } + }, + "documentation":"

Describes the status of the cluster (job flow).

" + }, + "JobFlowInstancesConfig":{ + "type":"structure", + "members":{ + "MasterInstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type of the master node.

" + }, + "SlaveInstanceType":{ + "shape":"InstanceType", + "documentation":"

The EC2 instance type of the core and task nodes.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of EC2 instances in the cluster.

" + }, + "InstanceGroups":{ + "shape":"InstanceGroupConfigList", + "documentation":"

Configuration for the instance groups in a cluster.

" + }, + "InstanceFleets":{ + "shape":"InstanceFleetConfigList", + "documentation":"

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

Describes the EC2 instances and instance configurations for clusters that use the instance fleet configuration.

" + }, + "Ec2KeyName":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the EC2 key pair that can be used to ssh to the master node as the user called \"hadoop.\"

" + }, + "Placement":{ + "shape":"PlacementType", + "documentation":"

The Availability Zone in which the cluster runs.

" + }, + "KeepJobFlowAliveWhenNoSteps":{ + "shape":"Boolean", + "documentation":"

Specifies whether the cluster should remain available after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Specifies whether to lock the cluster to prevent the Amazon EC2 instances from being terminated by API call, user intervention, or in the event of a job-flow error.

" + }, + "HadoopVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Applies only to Amazon EMR release versions earlier than 4.0. The Hadoop version for the cluster. Valid inputs are \"0.18\" (deprecated), \"0.20\" (deprecated), \"0.20.205\" (deprecated), \"1.0.3\", \"2.2.0\", or \"2.4.0\". If you do not set this value, the default of 0.18 is used, unless the AmiVersion parameter is set in the RunJobFlow call, in which case the default version of Hadoop for that AMI version is used.

" + }, + "Ec2SubnetId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Applies to clusters that use the uniform instance group configuration. To launch the cluster in Amazon Virtual Private Cloud (Amazon VPC), set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value and your account supports EC2-Classic, the cluster launches in EC2-Classic.

" + }, + "Ec2SubnetIds":{ + "shape":"XmlStringMaxLen256List", + "documentation":"

Applies to clusters that use the instance fleet configuration. When multiple EC2 subnet IDs are specified, Amazon EMR evaluates them and launches instances in the optimal subnet.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "EmrManagedMasterSecurityGroup":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The identifier of the Amazon EC2 security group for the master node.

" + }, + "EmrManagedSlaveSecurityGroup":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The identifier of the Amazon EC2 security group for the core and task nodes.

" + }, + "ServiceAccessSecurityGroup":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

" + }, + "AdditionalMasterSecurityGroups":{ + "shape":"SecurityGroupsList", + "documentation":"

A list of additional Amazon EC2 security group IDs for the master node.

" + }, + "AdditionalSlaveSecurityGroups":{ + "shape":"SecurityGroupsList", + "documentation":"

A list of additional Amazon EC2 security group IDs for the core and task nodes.

" + } + }, + "documentation":"

A description of the Amazon EC2 instance on which the cluster (job flow) runs. A valid JobFlowInstancesConfig must contain either InstanceGroups or InstanceFleets, which is the recommended configuration. They cannot be used together. You may also have MasterInstanceType, SlaveInstanceType, and InstanceCount (all three must be present), but we don't recommend this configuration.

" + }, + "JobFlowInstancesDetail":{ + "type":"structure", + "required":[ + "MasterInstanceType", + "SlaveInstanceType", + "InstanceCount" + ], + "members":{ + "MasterInstanceType":{ + "shape":"InstanceType", + "documentation":"

The Amazon EC2 master node instance type.

" + }, + "MasterPublicDnsName":{ + "shape":"XmlString", + "documentation":"

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

" + }, + "MasterInstanceId":{ + "shape":"XmlString", + "documentation":"

The Amazon EC2 instance identifier of the master node.

" + }, + "SlaveInstanceType":{ + "shape":"InstanceType", + "documentation":"

The Amazon EC2 core and task node instance type.

" + }, + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Amazon EC2 instances in the cluster. If the value is 1, the same instance serves as both the master and core and task node. If the value is greater than 1, one instance is the master node and all others are core and task nodes.

" + }, + "InstanceGroups":{ + "shape":"InstanceGroupDetailList", + "documentation":"

Details about the instance groups in a cluster.

" + }, + "NormalizedInstanceHours":{ + "shape":"Integer", + "documentation":"

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour that an m1.small runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

" + }, + "Ec2KeyName":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of an Amazon EC2 key pair that can be used to ssh to the master node.

" + }, + "Ec2SubnetId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

For clusters launched within Amazon Virtual Private Cloud, this is the identifier of the subnet where the cluster was launched.

" + }, + "Placement":{ + "shape":"PlacementType", + "documentation":"

The Amazon EC2 Availability Zone for the cluster.

" + }, + "KeepJobFlowAliveWhenNoSteps":{ + "shape":"Boolean", + "documentation":"

Specifies whether the cluster should remain available after completing all steps.

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

Specifies whether the Amazon EC2 instances in the cluster are protected from termination by API calls, user intervention, or in the event of a job-flow error.

" + }, + "HadoopVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The Hadoop version for the cluster.

" + } + }, + "documentation":"

Specify the type of Amazon EC2 instances that the cluster (job flow) runs on.

" + }, + "KerberosAttributes":{ + "type":"structure", + "required":[ + "Realm", + "KdcAdminPassword" + ], + "members":{ + "Realm":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.

" + }, + "KdcAdminPassword":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.

" + }, + "CrossRealmTrustPrincipalPassword":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.

" + }, + "ADDomainJoinUser":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.

" + }, + "ADDomainJoinPassword":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The Active Directory password for ADDomainJoinUser.

" + } + }, + "documentation":"

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" + }, + "KeyValue":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"XmlString", + "documentation":"

The unique identifier of a key value pair.

" + }, + "Value":{ + "shape":"XmlString", + "documentation":"

The value part of the identified key.

" + } + }, + "documentation":"

A key value pair.

" + }, + "KeyValueList":{ + "type":"list", + "member":{"shape":"KeyValue"} + }, + "ListBootstrapActionsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The cluster identifier for the bootstrap actions to list.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which bootstrap actions to retrieve.

" + }, + "ListBootstrapActionsOutput":{ + "type":"structure", + "members":{ + "BootstrapActions":{ + "shape":"CommandList", + "documentation":"

The bootstrap actions associated with the cluster.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This output contains the bootstrap actions detail.

" + }, + "ListClustersInput":{ + "type":"structure", + "members":{ + "CreatedAfter":{ + "shape":"Date", + "documentation":"

The creation date and time beginning value filter for listing clusters.

" + }, + "CreatedBefore":{ + "shape":"Date", + "documentation":"

The creation date and time end value filter for listing clusters.

" + }, + "ClusterStates":{ + "shape":"ClusterStateList", + "documentation":"

The cluster state filters to apply when listing clusters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines how the ListClusters action filters the list of clusters that it returns.

" + }, + "ListClustersOutput":{ + "type":"structure", + "members":{ + "Clusters":{ + "shape":"ClusterSummaryList", + "documentation":"

The list of clusters for the account based on the given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This contains a ClusterSummaryList with the cluster details; for example, the cluster IDs, names, and status.

" + }, + "ListInstanceFleetsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The unique identifier of the cluster.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListInstanceFleetsOutput":{ + "type":"structure", + "members":{ + "InstanceFleets":{ + "shape":"InstanceFleetList", + "documentation":"

The list of instance fleets for the cluster and given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListInstanceGroupsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the instance groups.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "ListInstanceGroupsOutput":{ + "type":"structure", + "members":{ + "InstanceGroups":{ + "shape":"InstanceGroupList", + "documentation":"

The list of instance groups for the cluster and given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instance groups to retrieve.

" + }, + "ListInstancesInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the instances.

" + }, + "InstanceGroupId":{ + "shape":"InstanceGroupId", + "documentation":"

The identifier of the instance group for which to list the instances.

" + }, + "InstanceGroupTypes":{ + "shape":"InstanceGroupTypeList", + "documentation":"

The type of instance group for which to list the instances.

" + }, + "InstanceFleetId":{ + "shape":"InstanceFleetId", + "documentation":"

The unique identifier of the instance fleet.

" + }, + "InstanceFleetType":{ + "shape":"InstanceFleetType", + "documentation":"

The node type of the instance fleet. For example MASTER, CORE, or TASK.

" + }, + "InstanceStates":{ + "shape":"InstanceStateList", + "documentation":"

A list of instance states that will filter the instances returned with this request.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which instances to list.

" + }, + "ListInstancesOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"InstanceList", + "documentation":"

The list of instances for the cluster and given filters.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This output contains the list of instances.

" + }, + "ListSecurityConfigurationsInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the set of results to retrieve.

" + } + } + }, + "ListSecurityConfigurationsOutput":{ + "type":"structure", + "members":{ + "SecurityConfigurations":{ + "shape":"SecurityConfigurationList", + "documentation":"

The creation date and time, and name, of each security configuration.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

A pagination token that indicates the next set of results to retrieve. Include the marker in the next ListSecurityConfiguration call to retrieve the next page of results, if required.

" + } + } + }, + "ListStepsInput":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The identifier of the cluster for which to list the steps.

" + }, + "StepStates":{ + "shape":"StepStateList", + "documentation":"

The filter to limit the step list based on certain states.

" + }, + "StepIds":{ + "shape":"XmlStringList", + "documentation":"

The filter to limit the step list based on the identifier of the steps.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This input determines which steps to list.

" + }, + "ListStepsOutput":{ + "type":"structure", + "members":{ + "Steps":{ + "shape":"StepSummaryList", + "documentation":"

The filtered list of steps for the cluster.

" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + }, + "documentation":"

This output contains the list of steps returned in reverse order. This means that the last step is the first element in the list.

" + }, + "Long":{"type":"long"}, + "Marker":{"type":"string"}, + "MarketType":{ + "type":"string", + "enum":[ + "ON_DEMAND", + "SPOT" + ] + }, + "MetricDimension":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The dimension name.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The dimension value.

" + } + }, + "documentation":"

A CloudWatch dimension, which is specified using a Key (known as a Name in CloudWatch), Value pair. By default, Amazon EMR uses one dimension whose Key is JobFlowID and Value is a variable representing the cluster ID, which is ${emr.clusterId}. This enables the rule to bootstrap when the cluster ID becomes available.

" + }, + "MetricDimensionList":{ + "type":"list", + "member":{"shape":"MetricDimension"} + }, + "ModifyInstanceFleetInput":{ + "type":"structure", + "required":[ + "ClusterId", + "InstanceFleet" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The unique identifier of the cluster.

" + }, + "InstanceFleet":{ + "shape":"InstanceFleetModifyConfig", + "documentation":"

The unique identifier of the instance fleet.

" + } + } + }, + "ModifyInstanceGroupsInput":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

The ID of the cluster to which the instance group belongs.

" + }, + "InstanceGroups":{ + "shape":"InstanceGroupModifyConfigList", + "documentation":"

Instance groups to change.

" + } + }, + "documentation":"

Change the size of some instance groups.

" + }, + "NewSupportedProductsList":{ + "type":"list", + "member":{"shape":"SupportedProductConfig"} + }, + "NonNegativeDouble":{ + "type":"double", + "min":0.0 + }, + "PlacementType":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"XmlString", + "documentation":"

The Amazon EC2 Availability Zone for the cluster. AvailabilityZone is used for uniform instance groups, while AvailabilityZones (plural) is used for instance fleets.

" + }, + "AvailabilityZones":{ + "shape":"XmlStringMaxLen256List", + "documentation":"

When multiple Availability Zones are specified, Amazon EMR evaluates them and launches instances in the optimal Availability Zone. AvailabilityZones is used for instance fleets, while AvailabilityZone (singular) is used for uniform instance groups.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + } + }, + "documentation":"

The Amazon EC2 Availability Zone configuration of the cluster (job flow).

" + }, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "PortRange":{ + "type":"structure", + "required":["MinRange"], + "members":{ + "MinRange":{ + "shape":"Port", + "documentation":"

The smallest port number in a specified range of port numbers.

" + }, + "MaxRange":{ + "shape":"Port", + "documentation":"

The smallest port number in a specified range of port numbers.

" + } + }, + "documentation":"

A list of port ranges that are permitted to allow inbound traffic from all public IP addresses. To specify a single port, use the same value for MinRange and MaxRange.

" + }, + "PortRanges":{ + "type":"list", + "member":{"shape":"PortRange"} + }, + "PutAutoScalingPolicyInput":{ + "type":"structure", + "required":[ + "ClusterId", + "InstanceGroupId", + "AutoScalingPolicy" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" + }, + "InstanceGroupId":{ + "shape":"InstanceGroupId", + "documentation":"

Specifies the ID of the instance group to which the automatic scaling policy is applied.

" + }, + "AutoScalingPolicy":{ + "shape":"AutoScalingPolicy", + "documentation":"

Specifies the definition of the automatic scaling policy.

" + } + } + }, + "PutAutoScalingPolicyOutput":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" + }, + "InstanceGroupId":{ + "shape":"InstanceGroupId", + "documentation":"

Specifies the ID of the instance group to which the scaling policy is applied.

" + }, + "AutoScalingPolicy":{ + "shape":"AutoScalingPolicyDescription", + "documentation":"

The automatic scaling policy definition.

" + } + } + }, + "PutBlockPublicAccessConfigurationInput":{ + "type":"structure", + "required":["BlockPublicAccessConfiguration"], + "members":{ + "BlockPublicAccessConfiguration":{ + "shape":"BlockPublicAccessConfiguration", + "documentation":"

A configuration for Amazon EMR block public access. The configuration applies to all clusters created in your account for the current Region. The configuration specifies whether block public access is enabled. If block public access is enabled, security groups associated with the cluster cannot have rules that allow inbound traffic from 0.0.0.0/0 or ::/0 on a port, unless the port is specified as an exception using PermittedPublicSecurityGroupRuleRanges in the BlockPublicAccessConfiguration. By default, Port 22 (SSH) is an exception, and public access is allowed on this port. You can change this by updating BlockPublicSecurityGroupRules to remove the exception.

" + } + } + }, + "PutBlockPublicAccessConfigurationOutput":{ + "type":"structure", + "members":{ + } + }, + "RemoveAutoScalingPolicyInput":{ + "type":"structure", + "required":[ + "ClusterId", + "InstanceGroupId" + ], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

Specifies the ID of a cluster. The instance group to which the automatic scaling policy is applied is within this cluster.

" + }, + "InstanceGroupId":{ + "shape":"InstanceGroupId", + "documentation":"

Specifies the ID of the instance group to which the scaling policy is applied.

" + } + } + }, + "RemoveAutoScalingPolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "RemoveTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

The Amazon EMR resource identifier from which tags will be removed. This value must be a cluster identifier.

" + }, + "TagKeys":{ + "shape":"StringList", + "documentation":"

A list of tag keys to remove from a resource.

" + } + }, + "documentation":"

This input identifies a cluster and a list of tags to remove.

" + }, + "RemoveTagsOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

This output indicates the result of removing tags from a resource.

" + }, + "RepoUpgradeOnBoot":{ + "type":"string", + "enum":[ + "SECURITY", + "NONE" + ] + }, + "ResourceId":{"type":"string"}, + "RunJobFlowInput":{ + "type":"structure", + "required":[ + "Name", + "Instances" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the job flow.

" + }, + "LogUri":{ + "shape":"XmlString", + "documentation":"

The location in Amazon S3 to write the log files of the job flow. If a value is not provided, logs are not created.

" + }, + "AdditionalInfo":{ + "shape":"XmlString", + "documentation":"

A JSON string for selecting additional features.

" + }, + "AmiVersion":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Applies only to Amazon EMR AMI versions 3.x and 2.x. For Amazon EMR releases 4.0 and later, ReleaseLabel is used. To specify a custom AMI, use CustomAmiID.

" + }, + "ReleaseLabel":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

" + }, + "Instances":{ + "shape":"JobFlowInstancesConfig", + "documentation":"

A specification of the number and type of Amazon EC2 instances.

" + }, + "Steps":{ + "shape":"StepConfigList", + "documentation":"

A list of steps to run.

" + }, + "BootstrapActions":{ + "shape":"BootstrapActionConfigList", + "documentation":"

A list of bootstrap actions to run before Hadoop starts on the cluster nodes.

" + }, + "SupportedProducts":{ + "shape":"SupportedProductsList", + "documentation":"

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use. For more information, see the Amazon EMR Developer Guide. Currently supported values are:

  • \"mapr-m3\" - launch the job flow using MapR M3 Edition.

  • \"mapr-m5\" - launch the job flow using MapR M5 Edition.

" + }, + "NewSupportedProducts":{ + "shape":"NewSupportedProductsList", + "documentation":"

For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.

A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the Amazon EMR Developer Guide. Supported values are:

  • \"mapr-m3\" - launch the cluster using MapR M3 Edition.

  • \"mapr-m5\" - launch the cluster using MapR M5 Edition.

  • \"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.

  • \"mapr-m7\" - launch the cluster using MapR M7 Edition.

  • \"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform.

  • \"hue\"- launch the cluster with Hue installed.

  • \"spark\" - launch the cluster with Apache Spark installed.

  • \"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.

" + }, + "Applications":{ + "shape":"ApplicationList", + "documentation":"

Applies to Amazon EMR releases 4.0 and later. A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the Amazon EMR Release Guide.

" + }, + "Configurations":{ + "shape":"ConfigurationList", + "documentation":"

For Amazon EMR releases 4.0 and later. The list of configurations supplied for the EMR cluster you are creating.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

This member will be deprecated.

Whether the cluster is visible to all IAM users of the AWS account associated with the cluster. If this value is set to true, all IAM users of that AWS account can view and (if they have the proper policy permissions set) manage the cluster. If it is set to false, only the IAM user that created the cluster can view and manage it.

" + }, + "JobFlowRole":{ + "shape":"XmlString", + "documentation":"

Also called instance profile and EC2 role. An IAM role for an EMR cluster. The EC2 instances of the cluster assume this role. The default role is EMR_EC2_DefaultRole. In order to use the default role, you must have already created it using the CLI or console.

" + }, + "ServiceRole":{ + "shape":"XmlString", + "documentation":"

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

" + }, + "SecurityConfiguration":{ + "shape":"XmlString", + "documentation":"

The name of a security configuration to apply to the cluster.

" + }, + "AutoScalingRole":{ + "shape":"XmlString", + "documentation":"

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group.

" + }, + "ScaleDownBehavior":{ + "shape":"ScaleDownBehavior", + "documentation":"

Specifies the way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR blacklists and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION available only in Amazon EMR version 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

" + }, + "CustomAmiId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

Available only in Amazon EMR version 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI. If specified, Amazon EMR uses this AMI when it launches cluster EC2 instances. For more information about custom AMIs in Amazon EMR, see Using a Custom AMI in the Amazon EMR Management Guide. If omitted, the cluster uses the base Linux AMI for the ReleaseLabel specified. For Amazon EMR versions 2.x and 3.x, use AmiVersion instead.

For information about creating a custom AMI, see Creating an Amazon EBS-Backed Linux AMI in the Amazon Elastic Compute Cloud User Guide for Linux Instances. For information about finding an AMI ID, see Finding a Linux AMI.

" + }, + "EbsRootVolumeSize":{ + "shape":"Integer", + "documentation":"

The size, in GiB, of the EBS root device volume of the Linux AMI that is used for each EC2 instance. Available in Amazon EMR version 4.x and later.

" + }, + "RepoUpgradeOnBoot":{ + "shape":"RepoUpgradeOnBoot", + "documentation":"

Applies only when CustomAmiID is used. Specifies which updates from the Amazon Linux AMI package repositories to apply automatically when the instance boots using the AMI. If omitted, the default is SECURITY, which indicates that only security updates are applied. If NONE is specified, no updates are applied, and all updates must be applied manually.

" + }, + "KerberosAttributes":{ + "shape":"KerberosAttributes", + "documentation":"

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the EMR Management Guide.

" + } + }, + "documentation":"

Input to the RunJobFlow operation.

" + }, + "RunJobFlowOutput":{ + "type":"structure", + "members":{ + "JobFlowId":{ + "shape":"XmlStringMaxLen256", + "documentation":"

An unique identifier for the job flow.

" + } + }, + "documentation":"

The result of the RunJobFlow operation.

" + }, + "ScaleDownBehavior":{ + "type":"string", + "enum":[ + "TERMINATE_AT_INSTANCE_HOUR", + "TERMINATE_AT_TASK_COMPLETION" + ] + }, + "ScalingAction":{ + "type":"structure", + "required":["SimpleScalingPolicyConfiguration"], + "members":{ + "Market":{ + "shape":"MarketType", + "documentation":"

Not available for instance groups. Instance groups use the market type specified for the group.

" + }, + "SimpleScalingPolicyConfiguration":{ + "shape":"SimpleScalingPolicyConfiguration", + "documentation":"

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

" + } + }, + "documentation":"

The type of adjustment the automatic scaling activity makes when triggered, and the periodicity of the adjustment.

" + }, + "ScalingConstraints":{ + "type":"structure", + "required":[ + "MinCapacity", + "MaxCapacity" + ], + "members":{ + "MinCapacity":{ + "shape":"Integer", + "documentation":"

The lower boundary of EC2 instances in an instance group below which scaling activities are not allowed to shrink. Scale-in activities will not terminate instances below this boundary.

" + }, + "MaxCapacity":{ + "shape":"Integer", + "documentation":"

The upper boundary of EC2 instances in an instance group beyond which scaling activities are not allowed to grow. Scale-out activities will not add instances beyond this boundary.

" + } + }, + "documentation":"

The upper and lower EC2 instance limits for an automatic scaling policy. Automatic scaling activities triggered by automatic scaling rules will not cause an instance group to grow above or below these limits.

" + }, + "ScalingRule":{ + "type":"structure", + "required":[ + "Name", + "Action", + "Trigger" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name used to identify an automatic scaling rule. Rule names must be unique within a scaling policy.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A friendly, more verbose description of the automatic scaling rule.

" + }, + "Action":{ + "shape":"ScalingAction", + "documentation":"

The conditions that trigger an automatic scaling activity.

" + }, + "Trigger":{ + "shape":"ScalingTrigger", + "documentation":"

The CloudWatch alarm definition that determines when automatic scaling activity is triggered.

" + } + }, + "documentation":"

A scale-in or scale-out rule that defines scaling activity, including the CloudWatch metric alarm that triggers activity, how EC2 instances are added or removed, and the periodicity of adjustments. The automatic scaling policy for an instance group can comprise one or more automatic scaling rules.

" + }, + "ScalingRuleList":{ + "type":"list", + "member":{"shape":"ScalingRule"} + }, + "ScalingTrigger":{ + "type":"structure", + "required":["CloudWatchAlarmDefinition"], + "members":{ + "CloudWatchAlarmDefinition":{ + "shape":"CloudWatchAlarmDefinition", + "documentation":"

The definition of a CloudWatch metric alarm. When the defined alarm conditions are met along with other trigger parameters, scaling activity begins.

" + } + }, + "documentation":"

The conditions that trigger an automatic scaling activity.

" + }, + "ScriptBootstrapActionConfig":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"XmlString", + "documentation":"

Location of the script to run during a bootstrap action. Can be either a location in Amazon S3 or on a local file system.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

A list of command line arguments to pass to the bootstrap action script.

" + } + }, + "documentation":"

Configuration of the script to run during a bootstrap action.

" + }, + "SecurityConfigurationList":{ + "type":"list", + "member":{"shape":"SecurityConfigurationSummary"} + }, + "SecurityConfigurationSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlString", + "documentation":"

The name of the security configuration.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time the security configuration was created.

" + } + }, + "documentation":"

The creation date and time, and name, of a security configuration.

" + }, + "SecurityGroupsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "SetTerminationProtectionInput":{ + "type":"structure", + "required":[ + "JobFlowIds", + "TerminationProtected" + ], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

A list of strings that uniquely identify the clusters to protect. This identifier is returned by RunJobFlow and can also be obtained from DescribeJobFlows .

" + }, + "TerminationProtected":{ + "shape":"Boolean", + "documentation":"

A Boolean that indicates whether to protect the cluster and prevent the Amazon EC2 instances in the cluster from shutting down due to API calls, user intervention, or job-flow error.

" + } + }, + "documentation":"

The input argument to the TerminationProtection operation.

" + }, + "SetVisibleToAllUsersInput":{ + "type":"structure", + "required":[ + "JobFlowIds", + "VisibleToAllUsers" + ], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

Identifiers of the job flows to receive the new visibility setting.

" + }, + "VisibleToAllUsers":{ + "shape":"Boolean", + "documentation":"

This member will be deprecated.

Whether the specified clusters are visible to all IAM users of the AWS account associated with the cluster. If this value is set to True, all IAM users of that AWS account can view and, if they have the proper IAM policy permissions set, manage the clusters. If it is set to False, only the IAM user that created a cluster can view and manage it.

" + } + }, + "documentation":"

This member will be deprecated.

The input to the SetVisibleToAllUsers action.

" + }, + "ShrinkPolicy":{ + "type":"structure", + "members":{ + "DecommissionTimeout":{ + "shape":"Integer", + "documentation":"

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.

" + }, + "InstanceResizePolicy":{ + "shape":"InstanceResizePolicy", + "documentation":"

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

" + } + }, + "documentation":"

Policy for customizing shrink operations. Allows configuration of decommissioning timeout and targeted instance shrinking.

" + }, + "SimpleScalingPolicyConfiguration":{ + "type":"structure", + "required":["ScalingAdjustment"], + "members":{ + "AdjustmentType":{ + "shape":"AdjustmentType", + "documentation":"

The way in which EC2 instances are added (if ScalingAdjustment is a positive number) or terminated (if ScalingAdjustment is a negative number) each time the scaling activity is triggered. CHANGE_IN_CAPACITY is the default. CHANGE_IN_CAPACITY indicates that the EC2 instance count increments or decrements by ScalingAdjustment, which should be expressed as an integer. PERCENT_CHANGE_IN_CAPACITY indicates the instance count increments or decrements by the percentage specified by ScalingAdjustment, which should be expressed as an integer. For example, 20 indicates an increase in 20% increments of cluster capacity. EXACT_CAPACITY indicates the scaling activity results in an instance group with the number of EC2 instances specified by ScalingAdjustment, which should be expressed as a positive integer.

" + }, + "ScalingAdjustment":{ + "shape":"Integer", + "documentation":"

The amount by which to scale in or scale out, based on the specified AdjustmentType. A positive value adds to the instance group's EC2 instance count while a negative number removes instances. If AdjustmentType is set to EXACT_CAPACITY, the number should only be a positive integer. If AdjustmentType is set to PERCENT_CHANGE_IN_CAPACITY, the value should express the percentage as an integer. For example, -20 indicates a decrease in 20% increments of cluster capacity.

" + }, + "CoolDown":{ + "shape":"Integer", + "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start. The default value is 0.

" + } + }, + "documentation":"

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

" + }, + "SpotProvisioningSpecification":{ + "type":"structure", + "required":[ + "TimeoutDurationMinutes", + "TimeoutAction" + ], + "members":{ + "TimeoutDurationMinutes":{ + "shape":"WholeNumber", + "documentation":"

The spot provisioning timeout period in minutes. If Spot instances are not provisioned within this time period, the TimeOutAction is taken. Minimum value is 5 and maximum value is 1440. The timeout applies only during initial provisioning, when the cluster is first created.

" + }, + "TimeoutAction":{ + "shape":"SpotProvisioningTimeoutAction", + "documentation":"

The action to take when TargetSpotCapacity has not been fulfilled when the TimeoutDurationMinutes has expired; that is, when all Spot instances could not be provisioned within the Spot provisioning timeout. Valid values are TERMINATE_CLUSTER and SWITCH_TO_ON_DEMAND. SWITCH_TO_ON_DEMAND specifies that if no Spot instances are available, On-Demand Instances should be provisioned to fulfill any remaining Spot capacity.

" + }, + "BlockDurationMinutes":{ + "shape":"WholeNumber", + "documentation":"

The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

" + } + }, + "documentation":"

The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + }, + "SpotProvisioningTimeoutAction":{ + "type":"string", + "enum":[ + "SWITCH_TO_ON_DEMAND", + "TERMINATE_CLUSTER" + ] + }, + "Statistic":{ + "type":"string", + "enum":[ + "SAMPLE_COUNT", + "AVERAGE", + "SUM", + "MINIMUM", + "MAXIMUM" + ] + }, + "Step":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"StepId", + "documentation":"

The identifier of the cluster step.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster step.

" + }, + "Config":{ + "shape":"HadoopStepConfig", + "documentation":"

The Hadoop job configuration of the cluster step.

" + }, + "ActionOnFailure":{ + "shape":"ActionOnFailure", + "documentation":"

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" + }, + "Status":{ + "shape":"StepStatus", + "documentation":"

The current execution status details of the cluster step.

" + } + }, + "documentation":"

This represents a step in a cluster.

" + }, + "StepConfig":{ + "type":"structure", + "required":[ + "Name", + "HadoopJarStep" + ], + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the step.

" + }, + "ActionOnFailure":{ + "shape":"ActionOnFailure", + "documentation":"

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is provided for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" + }, + "HadoopJarStep":{ + "shape":"HadoopJarStepConfig", + "documentation":"

The JAR file used for the step.

" + } + }, + "documentation":"

Specification of a cluster (job flow) step.

" + }, + "StepConfigList":{ + "type":"list", + "member":{"shape":"StepConfig"} + }, + "StepDetail":{ + "type":"structure", + "required":[ + "StepConfig", + "ExecutionStatusDetail" + ], + "members":{ + "StepConfig":{ + "shape":"StepConfig", + "documentation":"

The step configuration.

" + }, + "ExecutionStatusDetail":{ + "shape":"StepExecutionStatusDetail", + "documentation":"

The description of the step status.

" + } + }, + "documentation":"

Combines the execution state and configuration of a step.

" + }, + "StepDetailList":{ + "type":"list", + "member":{"shape":"StepDetail"} + }, + "StepExecutionState":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "CONTINUE", + "COMPLETED", + "CANCELLED", + "FAILED", + "INTERRUPTED" + ] + }, + "StepExecutionStatusDetail":{ + "type":"structure", + "required":[ + "State", + "CreationDateTime" + ], + "members":{ + "State":{ + "shape":"StepExecutionState", + "documentation":"

The state of the step.

" + }, + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time of the step.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The start date and time of the step.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The completion date and time of the step.

" + }, + "LastStateChangeReason":{ + "shape":"XmlString", + "documentation":"

A description of the step's current state.

" + } + }, + "documentation":"

The execution state of a step.

" + }, + "StepId":{"type":"string"}, + "StepIdsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "StepState":{ + "type":"string", + "enum":[ + "PENDING", + "CANCEL_PENDING", + "RUNNING", + "COMPLETED", + "CANCELLED", + "FAILED", + "INTERRUPTED" + ] + }, + "StepStateChangeReason":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"StepStateChangeReasonCode", + "documentation":"

The programmable code for the state change reason. Note: Currently, the service provides no code for the state change.

" + }, + "Message":{ + "shape":"String", + "documentation":"

The descriptive message for the state change reason.

" + } + }, + "documentation":"

The details of the step state change reason.

" + }, + "StepStateChangeReasonCode":{ + "type":"string", + "enum":["NONE"] + }, + "StepStateList":{ + "type":"list", + "member":{"shape":"StepState"} + }, + "StepStatus":{ + "type":"structure", + "members":{ + "State":{ + "shape":"StepState", + "documentation":"

The execution state of the cluster step.

" + }, + "StateChangeReason":{ + "shape":"StepStateChangeReason", + "documentation":"

The reason for the step execution status change.

" + }, + "FailureDetails":{ + "shape":"FailureDetails", + "documentation":"

The details for the step failure including reason, message, and log file path where the root cause was identified.

" + }, + "Timeline":{ + "shape":"StepTimeline", + "documentation":"

The timeline of the cluster step status over time.

" + } + }, + "documentation":"

The execution status details of the cluster step.

" + }, + "StepSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"StepId", + "documentation":"

The identifier of the cluster step.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the cluster step.

" + }, + "Config":{ + "shape":"HadoopStepConfig", + "documentation":"

The Hadoop job configuration of the cluster step.

" + }, + "ActionOnFailure":{ + "shape":"ActionOnFailure", + "documentation":"

The action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE. TERMINATE_JOB_FLOW is available for backward compatibility. We recommend using TERMINATE_CLUSTER instead.

" + }, + "Status":{ + "shape":"StepStatus", + "documentation":"

The current execution status details of the cluster step.

" + } + }, + "documentation":"

The summary of the cluster step.

" + }, + "StepSummaryList":{ + "type":"list", + "member":{"shape":"StepSummary"} + }, + "StepTimeline":{ + "type":"structure", + "members":{ + "CreationDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step was created.

" + }, + "StartDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step execution started.

" + }, + "EndDateTime":{ + "shape":"Date", + "documentation":"

The date and time when the cluster step execution completed or failed.

" + } + }, + "documentation":"

The timeline of the cluster step lifecycle.

" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SupportedProductConfig":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"XmlStringMaxLen256", + "documentation":"

The name of the product configuration.

" + }, + "Args":{ + "shape":"XmlStringList", + "documentation":"

The list of user-supplied arguments.

" + } + }, + "documentation":"

The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.

" + }, + "SupportedProductsList":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A user-defined key, which is the minimum required information for a valid tag. For more information, see Tag .

" + }, + "Value":{ + "shape":"String", + "documentation":"

A user-defined value, which is optional in a tag. For more information, see Tag Clusters.

" + } + }, + "documentation":"

A key/value pair containing user-defined metadata that you can associate with an Amazon EMR resource. Tags make it easier to associate clusters in various ways, such as grouping clusters to track your Amazon EMR resource allocation costs. For more information, see Tag Clusters.

" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TerminateJobFlowsInput":{ + "type":"structure", + "required":["JobFlowIds"], + "members":{ + "JobFlowIds":{ + "shape":"XmlStringList", + "documentation":"

A list of job flows to be shutdown.

" + } + }, + "documentation":"

Input to the TerminateJobFlows operation.

" + }, + "Unit":{ + "type":"string", + "enum":[ + "NONE", + "SECONDS", + "MICRO_SECONDS", + "MILLI_SECONDS", + "BYTES", + "KILO_BYTES", + "MEGA_BYTES", + "GIGA_BYTES", + "TERA_BYTES", + "BITS", + "KILO_BITS", + "MEGA_BITS", + "GIGA_BITS", + "TERA_BITS", + "PERCENT", + "COUNT", + "BYTES_PER_SECOND", + "KILO_BYTES_PER_SECOND", + "MEGA_BYTES_PER_SECOND", + "GIGA_BYTES_PER_SECOND", + "TERA_BYTES_PER_SECOND", + "BITS_PER_SECOND", + "KILO_BITS_PER_SECOND", + "MEGA_BITS_PER_SECOND", + "GIGA_BITS_PER_SECOND", + "TERA_BITS_PER_SECOND", + "COUNT_PER_SECOND" + ] + }, + "VolumeSpecification":{ + "type":"structure", + "required":[ + "VolumeType", + "SizeInGB" + ], + "members":{ + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. Volume types supported are gp2, io1, standard.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports.

" + }, + "SizeInGB":{ + "shape":"Integer", + "documentation":"

The volume size, in gibibytes (GiB). This can be a number from 1 - 1024. If the volume type is EBS-optimized, the minimum value is 10.

" + } + }, + "documentation":"

EBS volume specifications such as volume type, IOPS, and size (GiB) that will be requested for the EBS volume attached to an EC2 instance in the cluster.

" + }, + "WholeNumber":{ + "type":"integer", + "min":0 + }, + "XmlString":{ + "type":"string", + "max":10280, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringList":{ + "type":"list", + "member":{"shape":"XmlString"} + }, + "XmlStringMaxLen256":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "XmlStringMaxLen256List":{ + "type":"list", + "member":{"shape":"XmlStringMaxLen256"} + } + }, + "documentation":"

Amazon EMR is a web service that makes it easy to process large amounts of data efficiently. Amazon EMR uses Hadoop processing combined with several AWS products to do tasks such as web indexing, data mining, log file analysis, machine learning, scientific simulation, and data warehousing.

" +} diff --git a/aws/dist/botocore/data/emr/2009-03-31/waiters-2.json b/aws/dist/botocore/data/emr/2009-03-31/waiters-2.json new file mode 100644 index 00000000..abba8c3c --- /dev/null +++ b/aws/dist/botocore/data/emr/2009-03-31/waiters-2.json @@ -0,0 +1,86 @@ +{ + "version": 2, + "waiters": { + "ClusterRunning": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "RUNNING" + }, + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "WAITING" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATING" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED_WITH_ERRORS" + } + ] + }, + "StepComplete": { + "delay": 30, + "operation": "DescribeStep", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "COMPLETED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "FAILED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Step.Status.State", + "expected": "CANCELLED" + } + ] + }, + "ClusterTerminated": { + "delay": 30, + "operation": "DescribeCluster", + "maxAttempts": 60, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED" + }, + { + "state": "failure", + "matcher": "path", + "argument": "Cluster.Status.State", + "expected": "TERMINATED_WITH_ERRORS" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/endpoints.json b/aws/dist/botocore/data/endpoints.json new file mode 100644 index 00000000..a83dd852 --- /dev/null +++ b/aws/dist/botocore/data/endpoints.json @@ -0,0 +1,5600 @@ +{ + "partitions" : [ { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", + "protocols" : [ "https" ], + "signatureVersions" : [ "v4" ] + }, + "dnsSuffix" : "amazonaws.com", + "partition" : "aws", + "partitionName" : "AWS Standard", + "regionRegex" : "^(us|eu|ap|sa|ca|me)\\-\\w+\\-\\d+$", + "regions" : { + "ap-east-1" : { + "description" : "Asia Pacific (Hong Kong)" + }, + "ap-northeast-1" : { + "description" : "Asia Pacific (Tokyo)" + }, + "ap-northeast-2" : { + "description" : "Asia Pacific (Seoul)" + }, + "ap-south-1" : { + "description" : "Asia Pacific (Mumbai)" + }, + "ap-southeast-1" : { + "description" : "Asia Pacific (Singapore)" + }, + "ap-southeast-2" : { + "description" : "Asia Pacific (Sydney)" + }, + "ca-central-1" : { + "description" : "Canada (Central)" + }, + "eu-central-1" : { + "description" : "EU (Frankfurt)" + }, + "eu-north-1" : { + "description" : "EU (Stockholm)" + }, + "eu-west-1" : { + "description" : "EU (Ireland)" + }, + "eu-west-2" : { + "description" : "EU (London)" + }, + "eu-west-3" : { + "description" : "EU (Paris)" + }, + "me-south-1" : { + "description" : "Middle East (Bahrain)" + }, + "sa-east-1" : { + "description" : "South America (Sao Paulo)" + }, + "us-east-1" : { + "description" : "US East (N. Virginia)" + }, + "us-east-2" : { + "description" : "US East (Ohio)" + }, + "us-west-1" : { + "description" : "US West (N. California)" + }, + "us-west-2" : { + "description" : "US West (Oregon)" + } + }, + "services" : { + "a4b" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "acm" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "acm-pca" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "api.ecr" : { + "endpoints" : { + "ap-east-1" : { + "credentialScope" : { + "region" : "ap-east-1" + }, + "hostname" : "api.ecr.ap-east-1.amazonaws.com" + }, + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "api.ecr.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "api.ecr.ap-northeast-2.amazonaws.com" + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "api.ecr.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "api.ecr.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "api.ecr.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "api.ecr.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "api.ecr.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "api.ecr.eu-north-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "api.ecr.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "api.ecr.eu-west-2.amazonaws.com" + }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "api.ecr.eu-west-3.amazonaws.com" + }, + "me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "hostname" : "api.ecr.me-south-1.amazonaws.com" + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "api.ecr.sa-east-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "api.ecr.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "api.ecr.us-east-2.amazonaws.com" + }, + "us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "api.ecr.us-west-1.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "api.ecr.us-west-2.amazonaws.com" + } + } + }, + "api.mediatailor" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "api.pricing" : { + "defaults" : { + "credentialScope" : { + "service" : "pricing" + } + }, + "endpoints" : { + "ap-south-1" : { }, + "us-east-1" : { } + } + }, + "api.sagemaker" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "api-fips.sagemaker.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "api-fips.sagemaker.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "api-fips.sagemaker.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "api-fips.sagemaker.us-west-2.amazonaws.com" + } + } + }, + "apigateway" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "application-autoscaling" : { + "defaults" : { + "credentialScope" : { + "service" : "application-autoscaling" + }, + "hostname" : "autoscaling.{region}.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "appmesh" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "appstream2" : { + "defaults" : { + "credentialScope" : { + "service" : "appstream" + }, + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "appstream2-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "appsync" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "athena" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "autoscaling" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "autoscaling-plans" : { + "defaults" : { + "credentialScope" : { + "service" : "autoscaling-plans" + }, + "hostname" : "autoscaling.{region}.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "backup" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "batch" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "budgets" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "budgets.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "ce" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "ce.us-east-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "chime" : { + "defaults" : { + "protocols" : [ "https" ], + "sslCommonName" : "service.chime.aws.amazon.com" + }, + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "service.chime.aws.amazon.com", + "protocols" : [ "https" ] + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "cloud9" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "clouddirectory" : { + "endpoints" : { + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "cloudformation" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "cloudfront" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "cloudfront.amazonaws.com", + "protocols" : [ "http", "https" ] + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "cloudhsm" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "cloudhsmv2" : { + "defaults" : { + "credentialScope" : { + "service" : "cloudhsm" + } + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "cloudsearch" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "cloudtrail" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "codebuild" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "codebuild-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "codebuild-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "codebuild-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "codebuild-fips.us-west-2.amazonaws.com" + } + } + }, + "codecommit" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "codecommit-fips.ca-central-1.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "codedeploy" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "codedeploy-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "codedeploy-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "codedeploy-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "codedeploy-fips.us-west-2.amazonaws.com" + } + } + }, + "codepipeline" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "codestar" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "cognito-identity" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "cognito-idp" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "cognito-sync" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "comprehend" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "comprehendmedical" : { + "endpoints" : { + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "config" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "connect" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "cur" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "data.iot" : { + "defaults" : { + "credentialScope" : { + "service" : "iotdata" + }, + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "data.mediastore" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "datapipeline" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "datasync" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "datasync-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "datasync-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "datasync-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "datasync-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "dax" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "devicefarm" : { + "endpoints" : { + "us-west-2" : { } + } + }, + "directconnect" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "discovery" : { + "endpoints" : { + "us-west-2" : { } + } + }, + "dms" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "docdb" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "rds.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "rds.ap-northeast-2.amazonaws.com" + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "rds.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "rds.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "rds.ap-southeast-2.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "rds.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "rds.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "rds.eu-west-2.amazonaws.com" + }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "rds.eu-west-3.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "rds.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "rds.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "rds.us-west-2.amazonaws.com" + } + } + }, + "ds" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "dynamodb" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "dynamodb-fips.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "local" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "localhost:8000", + "protocols" : [ "http" ] + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "dynamodb-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "dynamodb-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "dynamodb-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "dynamodb-fips.us-west-2.amazonaws.com" + } + } + }, + "ec2" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "ecs" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elasticache" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "elasticache-fips.us-west-1.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elasticbeanstalk" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elasticfilesystem" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elasticloadbalancing" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elasticmapreduce" : { + "defaults" : { + "protocols" : [ "https" ], + "sslCommonName" : "{region}.{service}.{dnsSuffix}" + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { + "sslCommonName" : "{service}.{region}.{dnsSuffix}" + }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "sslCommonName" : "{service}.{region}.{dnsSuffix}" + }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "elastictranscoder" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "email" : { + "endpoints" : { + "ap-south-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "entitlement.marketplace" : { + "defaults" : { + "credentialScope" : { + "service" : "aws-marketplace" + } + }, + "endpoints" : { + "us-east-1" : { } + } + }, + "es" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "es-fips.us-west-1.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "events" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "firehose" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "fms" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "forecast" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "forecastquery" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "fsx" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "gamelift" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "glacier" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "glue" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "greengrass" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + }, + "isRegionalized" : true + }, + "groundstation" : { + "endpoints" : { + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "guardduty" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "guardduty-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "guardduty-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "guardduty-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "guardduty-fips.us-west-2.amazonaws.com" + } + }, + "isRegionalized" : true + }, + "health" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "iam" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "iam.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "importexport" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1", + "service" : "IngestionService" + }, + "hostname" : "importexport.amazonaws.com", + "signatureVersions" : [ "v2", "v4" ] + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "inspector" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "iot" : { + "defaults" : { + "credentialScope" : { + "service" : "execute-api" + } + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "iotanalytics" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "iotevents" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "ioteventsdata" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "data.iotevents.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "data.iotevents.ap-northeast-2.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "data.iotevents.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "data.iotevents.ap-southeast-2.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "data.iotevents.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "data.iotevents.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "data.iotevents.eu-west-2.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "data.iotevents.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "data.iotevents.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "data.iotevents.us-west-2.amazonaws.com" + } + } + }, + "iotthingsgraph" : { + "defaults" : { + "credentialScope" : { + "service" : "iotthingsgraph" + } + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "kafka" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "kinesis" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "kinesisanalytics" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "kinesisvideo" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "kms" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "lakeformation" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "lambda" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "license-manager" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "lightsail" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "logs" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "machinelearning" : { + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { } + } + }, + "marketplacecommerceanalytics" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "mediaconnect" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "mediaconvert" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "medialive" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "mediapackage" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "mediastore" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "metering.marketplace" : { + "defaults" : { + "credentialScope" : { + "service" : "aws-marketplace" + } + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "mgh" : { + "endpoints" : { + "us-west-2" : { } + } + }, + "mobileanalytics" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "models.lex" : { + "defaults" : { + "credentialScope" : { + "service" : "lex" + } + }, + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "monitoring" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "mq" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "mq-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "mq-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "mq-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "mq-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "mturk-requester" : { + "endpoints" : { + "sandbox" : { + "hostname" : "mturk-requester-sandbox.us-east-1.amazonaws.com" + }, + "us-east-1" : { } + }, + "isRegionalized" : false + }, + "neptune" : { + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "rds.ap-northeast-1.amazonaws.com" + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "rds.ap-northeast-2.amazonaws.com" + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "rds.ap-south-1.amazonaws.com" + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "rds.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "rds.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "rds.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "rds.eu-central-1.amazonaws.com" + }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "rds.eu-north-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "rds.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "rds.eu-west-2.amazonaws.com" + }, + "me-south-1" : { + "credentialScope" : { + "region" : "me-south-1" + }, + "hostname" : "rds.me-south-1.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "rds.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "rds.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "rds.us-west-2.amazonaws.com" + } + } + }, + "oidc" : { + "endpoints" : { + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "oidc.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "oidc.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "oidc.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "oidc.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "oidc.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "oidc.eu-west-2.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "oidc.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "oidc.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "oidc.us-west-2.amazonaws.com" + } + } + }, + "opsworks" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "opsworks-cm" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "organizations" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "organizations.us-east-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "pinpoint" : { + "defaults" : { + "credentialScope" : { + "service" : "mobiletargeting" + } + }, + "endpoints" : { + "ap-south-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "polly" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "portal.sso" : { + "endpoints" : { + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "portal.sso.ap-southeast-1.amazonaws.com" + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "portal.sso.ap-southeast-2.amazonaws.com" + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "portal.sso.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "portal.sso.eu-central-1.amazonaws.com" + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "portal.sso.eu-west-1.amazonaws.com" + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "portal.sso.eu-west-2.amazonaws.com" + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "portal.sso.us-east-1.amazonaws.com" + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "portal.sso.us-east-2.amazonaws.com" + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "portal.sso.us-west-2.amazonaws.com" + } + } + }, + "projects.iot1click" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "qldb" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "ram" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "rds" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "sslCommonName" : "{service}.{dnsSuffix}" + }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "redshift" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "rekognition" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "resource-groups" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "resource-groups-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "resource-groups-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "resource-groups-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "resource-groups-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "robomaker" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "route53" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "route53.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "route53domains" : { + "endpoints" : { + "us-east-1" : { } + } + }, + "route53resolver" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "runtime.lex" : { + "defaults" : { + "credentialScope" : { + "service" : "lex" + } + }, + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "runtime.sagemaker" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "runtime-fips.sagemaker.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "runtime-fips.sagemaker.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "runtime-fips.sagemaker.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "runtime-fips.sagemaker.us-west-2.amazonaws.com" + } + } + }, + "s3" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { + "hostname" : "s3.ap-northeast-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { + "hostname" : "s3.ap-southeast-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "ap-southeast-2" : { + "hostname" : "s3.ap-southeast-2.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { + "hostname" : "s3.eu-west-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "s3-external-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "s3-external-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "sa-east-1" : { + "hostname" : "s3.sa-east-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "us-east-1" : { + "hostname" : "s3.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "us-east-2" : { }, + "us-west-1" : { + "hostname" : "s3.us-west-1.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + }, + "us-west-2" : { + "hostname" : "s3.us-west-2.amazonaws.com", + "signatureVersions" : [ "s3", "s3v4" ] + } + }, + "isRegionalized" : true, + "partitionEndpoint" : "us-east-1" + }, + "s3-control" : { + "defaults" : { + "protocols" : [ "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "ap-northeast-1" : { + "credentialScope" : { + "region" : "ap-northeast-1" + }, + "hostname" : "s3-control.ap-northeast-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "ap-northeast-2" : { + "credentialScope" : { + "region" : "ap-northeast-2" + }, + "hostname" : "s3-control.ap-northeast-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "ap-south-1" : { + "credentialScope" : { + "region" : "ap-south-1" + }, + "hostname" : "s3-control.ap-south-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "ap-southeast-1" : { + "credentialScope" : { + "region" : "ap-southeast-1" + }, + "hostname" : "s3-control.ap-southeast-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "ap-southeast-2" : { + "credentialScope" : { + "region" : "ap-southeast-2" + }, + "hostname" : "s3-control.ap-southeast-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "ca-central-1" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "s3-control.ca-central-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "eu-central-1" : { + "credentialScope" : { + "region" : "eu-central-1" + }, + "hostname" : "s3-control.eu-central-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "eu-north-1" : { + "credentialScope" : { + "region" : "eu-north-1" + }, + "hostname" : "s3-control.eu-north-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "eu-west-1" : { + "credentialScope" : { + "region" : "eu-west-1" + }, + "hostname" : "s3-control.eu-west-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "eu-west-2" : { + "credentialScope" : { + "region" : "eu-west-2" + }, + "hostname" : "s3-control.eu-west-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "eu-west-3" : { + "credentialScope" : { + "region" : "eu-west-3" + }, + "hostname" : "s3-control.eu-west-3.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "sa-east-1" : { + "credentialScope" : { + "region" : "sa-east-1" + }, + "hostname" : "s3-control.sa-east-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "s3-control.us-east-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "s3-control-fips.us-east-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "s3-control.us-east-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "s3-control-fips.us-east-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "s3-control.us-west-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "s3-control-fips.us-west-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "s3-control.us-west-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "s3-control-fips.us-west-2.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + } + } + }, + "savingsplans" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "savingsplans.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "sdb" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "v2" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "hostname" : "sdb.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "secretsmanager" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "secretsmanager-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "secretsmanager-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "secretsmanager-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "secretsmanager-fips.us-west-2.amazonaws.com" + } + } + }, + "securityhub" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "serverlessrepo" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { + "protocols" : [ "https" ] + }, + "ap-northeast-1" : { + "protocols" : [ "https" ] + }, + "ap-northeast-2" : { + "protocols" : [ "https" ] + }, + "ap-south-1" : { + "protocols" : [ "https" ] + }, + "ap-southeast-1" : { + "protocols" : [ "https" ] + }, + "ap-southeast-2" : { + "protocols" : [ "https" ] + }, + "ca-central-1" : { + "protocols" : [ "https" ] + }, + "eu-central-1" : { + "protocols" : [ "https" ] + }, + "eu-north-1" : { + "protocols" : [ "https" ] + }, + "eu-west-1" : { + "protocols" : [ "https" ] + }, + "eu-west-2" : { + "protocols" : [ "https" ] + }, + "eu-west-3" : { + "protocols" : [ "https" ] + }, + "me-south-1" : { + "protocols" : [ "https" ] + }, + "sa-east-1" : { + "protocols" : [ "https" ] + }, + "us-east-1" : { + "protocols" : [ "https" ] + }, + "us-east-2" : { + "protocols" : [ "https" ] + }, + "us-west-1" : { + "protocols" : [ "https" ] + }, + "us-west-2" : { + "protocols" : [ "https" ] + } + } + }, + "servicecatalog" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "servicecatalog-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "servicecatalog-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "servicecatalog-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "servicecatalog-fips.us-west-2.amazonaws.com" + } + } + }, + "servicediscovery" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "session.qldb" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "shield" : { + "defaults" : { + "protocols" : [ "https" ], + "sslCommonName" : "shield.us-east-1.amazonaws.com" + }, + "endpoints" : { + "us-east-1" : { } + }, + "isRegionalized" : false + }, + "sms" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "snowball" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "sns" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "sqs" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "sslCommonName" : "{region}.queue.{dnsSuffix}" + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "sqs-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "sqs-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "sqs-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "sqs-fips.us-west-2.amazonaws.com" + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { + "sslCommonName" : "queue.{dnsSuffix}" + }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "ssm" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "states" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "storagegateway" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + }, + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "ca-central-1-fips" : { + "credentialScope" : { + "region" : "ca-central-1" + }, + "hostname" : "dynamodb-fips.ca-central-1.amazonaws.com" + }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "local" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "localhost:8000", + "protocols" : [ "http" ] + }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "dynamodb-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "dynamodb-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "dynamodb-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "dynamodb-fips.us-west-2.amazonaws.com" + } + } + }, + "sts" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "sts.amazonaws.com" + }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "sts-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "sts-fips.us-east-2.amazonaws.com" + }, + "us-west-1" : { }, + "us-west-1-fips" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "sts-fips.us-west-1.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "sts-fips.us-west-2.amazonaws.com" + } + }, + "partitionEndpoint" : "aws-global" + }, + "support" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "support.us-east-1.amazonaws.com" + } + }, + "partitionEndpoint" : "aws-global" + }, + "swf" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "tagging" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "transcribe" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "transcribestreaming" : { + "endpoints" : { + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, + "transfer" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "translate" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-1-fips" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "translate-fips.us-east-1.amazonaws.com" + }, + "us-east-2" : { }, + "us-east-2-fips" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "translate-fips.us-east-2.amazonaws.com" + }, + "us-west-2" : { }, + "us-west-2-fips" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "translate-fips.us-west-2.amazonaws.com" + } + } + }, + "waf" : { + "endpoints" : { + "aws-global" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "waf.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-global" + }, + "waf-regional" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, + "workdocs" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "workmail" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "workspaces" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, + "xray" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + } + } + }, { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", + "protocols" : [ "https" ], + "signatureVersions" : [ "v4" ] + }, + "dnsSuffix" : "amazonaws.com.cn", + "partition" : "aws-cn", + "partitionName" : "AWS China", + "regionRegex" : "^cn\\-\\w+\\-\\d+$", + "regions" : { + "cn-north-1" : { + "description" : "China (Beijing)" + }, + "cn-northwest-1" : { + "description" : "China (Ningxia)" + } + }, + "services" : { + "api.ecr" : { + "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "api.ecr.cn-north-1.amazonaws.com.cn" + }, + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "api.ecr.cn-northwest-1.amazonaws.com.cn" + } + } + }, + "apigateway" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "application-autoscaling" : { + "defaults" : { + "credentialScope" : { + "service" : "application-autoscaling" + }, + "hostname" : "autoscaling.{region}.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "autoscaling" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "batch" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "cloudformation" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "cloudfront" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "cloudfront.cn-northwest-1.amazonaws.com.cn", + "protocols" : [ "http", "https" ] + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-cn-global" + }, + "cloudtrail" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "codebuild" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "codedeploy" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "cognito-identity" : { + "endpoints" : { + "cn-north-1" : { } + } + }, + "config" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "data.iot" : { + "defaults" : { + "credentialScope" : { + "service" : "iotdata" + }, + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "directconnect" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "dms" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "ds" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "dynamodb" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "ec2" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "ecs" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "elasticache" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "elasticbeanstalk" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "elasticloadbalancing" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "elasticmapreduce" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "es" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "events" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "firehose" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "gamelift" : { + "endpoints" : { + "cn-north-1" : { } + } + }, + "glacier" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "glue" : { + "endpoints" : { + "cn-northwest-1" : { } + } + }, + "greengrass" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { } + }, + "isRegionalized" : true + }, + "iam" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "iam.cn-north-1.amazonaws.com.cn" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-cn-global" + }, + "iot" : { + "defaults" : { + "credentialScope" : { + "service" : "execute-api" + } + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "kinesis" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "kms" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "lambda" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "license-manager" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "logs" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "mediaconvert" : { + "endpoints" : { + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "subscribe.mediaconvert.cn-northwest-1.amazonaws.com.cn" + } + } + }, + "monitoring" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "polly" : { + "endpoints" : { + "cn-northwest-1" : { } + } + }, + "rds" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "redshift" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "s3" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "s3-control" : { + "defaults" : { + "protocols" : [ "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "s3-control.cn-north-1.amazonaws.com.cn", + "signatureVersions" : [ "s3v4" ] + }, + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "s3-control.cn-northwest-1.amazonaws.com.cn", + "signatureVersions" : [ "s3v4" ] + } + } + }, + "sms" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "snowball" : { + "endpoints" : { + "cn-north-1" : { } + } + }, + "sns" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "sqs" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "sslCommonName" : "{region}.queue.{dnsSuffix}" + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "ssm" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "states" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "storagegateway" : { + "endpoints" : { + "cn-north-1" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + }, + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "sts" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "support" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "support.cn-north-1.amazonaws.com.cn" + } + }, + "partitionEndpoint" : "aws-cn-global" + }, + "swf" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "tagging" : { + "endpoints" : { + "cn-north-1" : { }, + "cn-northwest-1" : { } + } + }, + "transcribe" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "cn-north-1" : { + "credentialScope" : { + "region" : "cn-north-1" + }, + "hostname" : "cn.transcribe.cn-north-1.amazonaws.com.cn" + }, + "cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "cn.transcribe.cn-northwest-1.amazonaws.com.cn" + } + } + } + } + }, { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", + "protocols" : [ "https" ], + "signatureVersions" : [ "v4" ] + }, + "dnsSuffix" : "amazonaws.com", + "partition" : "aws-us-gov", + "partitionName" : "AWS GovCloud (US)", + "regionRegex" : "^us\\-gov\\-\\w+\\-\\d+$", + "regions" : { + "us-gov-east-1" : { + "description" : "AWS GovCloud (US-East)" + }, + "us-gov-west-1" : { + "description" : "AWS GovCloud (US)" + } + }, + "services" : { + "acm" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "acm-pca" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "api.ecr" : { + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "api.ecr.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "api.ecr.us-gov-west-1.amazonaws.com" + } + } + }, + "api.sagemaker" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "apigateway" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "application-autoscaling" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "appstream2" : { + "defaults" : { + "credentialScope" : { + "service" : "appstream" + }, + "protocols" : [ "https" ] + }, + "endpoints" : { + "fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "appstream2-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { } + } + }, + "athena" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "autoscaling" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "clouddirectory" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "cloudformation" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "cloudhsm" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "cloudhsmv2" : { + "defaults" : { + "credentialScope" : { + "service" : "cloudhsm" + } + }, + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "cloudtrail" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "codebuild" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "codecommit" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "codedeploy" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "codedeploy-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "codedeploy-fips.us-gov-west-1.amazonaws.com" + } + } + }, + "comprehend" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "config" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "data.iot" : { + "defaults" : { + "credentialScope" : { + "service" : "iotdata" + }, + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "datasync" : { + "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "datasync-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-west-1" : { } + } + }, + "directconnect" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "dms" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "ds" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "dynamodb" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "dynamodb.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "dynamodb.us-gov-west-1.amazonaws.com" + } + } + }, + "ec2" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "ecs" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "elasticache" : { + "endpoints" : { + "fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "elasticache-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "elasticbeanstalk" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "elasticfilesystem" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "elasticloadbalancing" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "elasticmapreduce" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "https" ] + } + } + }, + "es" : { + "endpoints" : { + "fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "es-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "events" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "firehose" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "glacier" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "glue" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "greengrass" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { } + }, + "isRegionalized" : true + }, + "guardduty" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { } + }, + "isRegionalized" : true + }, + "health" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "iam" : { + "endpoints" : { + "aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "iam.us-gov.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-us-gov-global" + }, + "inspector" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "iot" : { + "defaults" : { + "credentialScope" : { + "service" : "execute-api" + } + }, + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "kinesis" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "kms" : { + "endpoints" : { + "ProdFips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "kms-fips.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "lambda" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "license-manager" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "logs" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "mediaconvert" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "metering.marketplace" : { + "defaults" : { + "credentialScope" : { + "service" : "aws-marketplace" + } + }, + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "monitoring" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "neptune" : { + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "rds.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "rds.us-gov-west-1.amazonaws.com" + } + } + }, + "organizations" : { + "endpoints" : { + "aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "organizations.us-gov-west-1.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-us-gov-global" + }, + "polly" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "ram" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "rds" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "redshift" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "rekognition" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "resource-groups" : { + "endpoints" : { + "fips-us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "resource-groups.us-gov-east-1.amazonaws.com" + }, + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "resource-groups.us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "route53" : { + "endpoints" : { + "aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "route53.us-gov.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-us-gov-global" + }, + "route53resolver" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "runtime.sagemaker" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "s3" : { + "defaults" : { + "signatureVersions" : [ "s3", "s3v4" ] + }, + "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "s3-fips-us-gov-west-1.amazonaws.com" + }, + "us-gov-east-1" : { + "hostname" : "s3.us-gov-east-1.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "us-gov-west-1" : { + "hostname" : "s3.us-gov-west-1.amazonaws.com", + "protocols" : [ "http", "https" ] + } + } + }, + "s3-control" : { + "defaults" : { + "protocols" : [ "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "us-gov-east-1" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "s3-control.us-gov-east-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "s3-control-fips.us-gov-east-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "s3-control.us-gov-west-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "s3-control-fips.us-gov-west-1.amazonaws.com", + "signatureVersions" : [ "s3v4" ] + } + } + }, + "secretsmanager" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "secretsmanager-fips.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "secretsmanager-fips.us-gov-west-1.amazonaws.com" + } + } + }, + "serverlessrepo" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-east-1" : { + "protocols" : [ "https" ] + }, + "us-gov-west-1" : { + "protocols" : [ "https" ] + } + } + }, + "servicecatalog" : { + "endpoints" : { + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "servicecatalog-fips.us-gov-west-1.amazonaws.com" + } + } + }, + "sms" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "snowball" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "sns" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "sqs" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { + "protocols" : [ "http", "https" ], + "sslCommonName" : "{region}.queue.{dnsSuffix}" + } + } + }, + "ssm" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "states" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "storagegateway" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + } + }, + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-east-1-fips" : { + "credentialScope" : { + "region" : "us-gov-east-1" + }, + "hostname" : "dynamodb.us-gov-east-1.amazonaws.com" + }, + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "dynamodb.us-gov-west-1.amazonaws.com" + } + } + }, + "sts" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "swf" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "tagging" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, + "transcribe" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "translate" : { + "defaults" : { + "protocols" : [ "https" ] + }, + "endpoints" : { + "us-gov-west-1" : { }, + "us-gov-west-1-fips" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "translate-fips.us-gov-west-1.amazonaws.com" + } + } + }, + "waf-regional" : { + "endpoints" : { + "us-gov-west-1" : { } + } + }, + "workspaces" : { + "endpoints" : { + "us-gov-west-1" : { } + } + } + } + }, { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", + "protocols" : [ "https" ], + "signatureVersions" : [ "v4" ] + }, + "dnsSuffix" : "c2s.ic.gov", + "partition" : "aws-iso", + "partitionName" : "AWS ISO (US)", + "regionRegex" : "^us\\-iso\\-\\w+\\-\\d+$", + "regions" : { + "us-iso-east-1" : { + "description" : "US ISO East" + } + }, + "services" : { + "api.ecr" : { + "endpoints" : { + "us-iso-east-1" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "hostname" : "api.ecr.us-iso-east-1.c2s.ic.gov" + } + } + }, + "api.sagemaker" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "apigateway" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "application-autoscaling" : { + "defaults" : { + "credentialScope" : { + "service" : "application-autoscaling" + }, + "hostname" : "autoscaling.{region}.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "autoscaling" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "cloudformation" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "cloudtrail" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "codedeploy" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "config" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "datapipeline" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "directconnect" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "dms" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "ds" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "dynamodb" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "ec2" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "ecs" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "elasticache" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "elasticloadbalancing" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "elasticmapreduce" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "https" ] + } + } + }, + "events" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "glacier" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "health" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "iam" : { + "endpoints" : { + "aws-iso-global" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "hostname" : "iam.us-iso-east-1.c2s.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-global" + }, + "kinesis" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "kms" : { + "endpoints" : { + "ProdFips" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "hostname" : "kms-fips.us-iso-east-1.c2s.ic.gov" + }, + "us-iso-east-1" : { } + } + }, + "lambda" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "logs" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "monitoring" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "rds" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "redshift" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "route53" : { + "endpoints" : { + "aws-iso-global" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "hostname" : "route53.c2s.ic.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-global" + }, + "runtime.sagemaker" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "s3" : { + "defaults" : { + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "s3v4" ] + } + } + }, + "snowball" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "sns" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "sqs" : { + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "states" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + }, + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-iso-east-1" : { + "protocols" : [ "http", "https" ] + } + } + }, + "sts" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "support" : { + "endpoints" : { + "aws-iso-global" : { + "credentialScope" : { + "region" : "us-iso-east-1" + }, + "hostname" : "support.us-iso-east-1.c2s.ic.gov" + } + }, + "partitionEndpoint" : "aws-iso-global" + }, + "swf" : { + "endpoints" : { + "us-iso-east-1" : { } + } + }, + "workspaces" : { + "endpoints" : { + "us-iso-east-1" : { } + } + } + } + }, { + "defaults" : { + "hostname" : "{service}.{region}.{dnsSuffix}", + "protocols" : [ "https" ], + "signatureVersions" : [ "v4" ] + }, + "dnsSuffix" : "sc2s.sgov.gov", + "partition" : "aws-iso-b", + "partitionName" : "AWS ISOB (US)", + "regionRegex" : "^us\\-isob\\-\\w+\\-\\d+$", + "regions" : { + "us-isob-east-1" : { + "description" : "US ISOB East (Ohio)" + } + }, + "services" : { + "application-autoscaling" : { + "defaults" : { + "credentialScope" : { + "service" : "application-autoscaling" + }, + "hostname" : "autoscaling.{region}.amazonaws.com", + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "autoscaling" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "cloudformation" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "cloudtrail" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "config" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "directconnect" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "dms" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "dynamodb" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "ec2" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "elasticache" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "elasticloadbalancing" : { + "endpoints" : { + "us-isob-east-1" : { + "protocols" : [ "https" ] + } + } + }, + "elasticmapreduce" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "events" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "glacier" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "health" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "iam" : { + "endpoints" : { + "aws-iso-b-global" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "hostname" : "iam.us-isob-east-1.sc2s.sgov.gov" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-iso-b-global" + }, + "kinesis" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "kms" : { + "endpoints" : { + "ProdFips" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "hostname" : "kms-fips.us-isob-east-1.sc2s.sgov.gov" + }, + "us-isob-east-1" : { } + } + }, + "logs" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "monitoring" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "rds" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "redshift" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "s3" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "signatureVersions" : [ "s3v4" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "snowball" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "sns" : { + "defaults" : { + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "sqs" : { + "defaults" : { + "protocols" : [ "http", "https" ], + "sslCommonName" : "{region}.queue.{dnsSuffix}" + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "states" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "streams.dynamodb" : { + "defaults" : { + "credentialScope" : { + "service" : "dynamodb" + }, + "protocols" : [ "http", "https" ] + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "sts" : { + "endpoints" : { + "us-isob-east-1" : { } + } + }, + "support" : { + "endpoints" : { + "aws-iso-b-global" : { + "credentialScope" : { + "region" : "us-isob-east-1" + }, + "hostname" : "support.us-isob-east-1.sc2s.sgov.gov" + } + }, + "partitionEndpoint" : "aws-iso-b-global" + }, + "swf" : { + "endpoints" : { + "us-isob-east-1" : { } + } + } + } + } ], + "version" : 3 +} \ No newline at end of file diff --git a/aws/dist/botocore/data/es/2015-01-01/paginators-1.json b/aws/dist/botocore/data/es/2015-01-01/paginators-1.json new file mode 100644 index 00000000..4c0f24e4 --- /dev/null +++ b/aws/dist/botocore/data/es/2015-01-01/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListElasticsearchInstanceTypes": { + "result_key": "ElasticsearchInstanceTypes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListElasticsearchVersions": { + "result_key": "ElasticsearchVersions", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeReservedElasticsearchInstanceOfferings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ReservedElasticsearchInstanceOfferings" + }, + "DescribeReservedElasticsearchInstances": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ReservedElasticsearchInstances" + }, + "GetUpgradeHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "UpgradeHistories" + } + } +} diff --git a/aws/dist/botocore/data/es/2015-01-01/service-2.json b/aws/dist/botocore/data/es/2015-01-01/service-2.json new file mode 100644 index 00000000..f3ce0530 --- /dev/null +++ b/aws/dist/botocore/data/es/2015-01-01/service-2.json @@ -0,0 +1,2350 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-01-01", + "endpointPrefix":"es", + "protocol":"rest-json", + "serviceFullName":"Amazon Elasticsearch Service", + "serviceId":"Elasticsearch Service", + "signatureVersion":"v4", + "uid":"es-2015-01-01" + }, + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/tags" + }, + "input":{"shape":"AddTagsRequest"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"LimitExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

" + }, + "CancelElasticsearchServiceSoftwareUpdate":{ + "name":"CancelElasticsearchServiceSoftwareUpdate", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/serviceSoftwareUpdate/cancel" + }, + "input":{"shape":"CancelElasticsearchServiceSoftwareUpdateRequest"}, + "output":{"shape":"CancelElasticsearchServiceSoftwareUpdateResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

" + }, + "CreateElasticsearchDomain":{ + "name":"CreateElasticsearchDomain", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/domain" + }, + "input":{"shape":"CreateElasticsearchDomainRequest"}, + "output":{"shape":"CreateElasticsearchDomainResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"}, + {"shape":"InvalidTypeException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" + }, + "DeleteElasticsearchDomain":{ + "name":"DeleteElasticsearchDomain", + "http":{ + "method":"DELETE", + "requestUri":"/2015-01-01/es/domain/{DomainName}" + }, + "input":{"shape":"DeleteElasticsearchDomainRequest"}, + "output":{"shape":"DeleteElasticsearchDomainResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

" + }, + "DeleteElasticsearchServiceRole":{ + "name":"DeleteElasticsearchServiceRole", + "http":{ + "method":"DELETE", + "requestUri":"/2015-01-01/es/role" + }, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

" + }, + "DescribeElasticsearchDomain":{ + "name":"DescribeElasticsearchDomain", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/domain/{DomainName}" + }, + "input":{"shape":"DescribeElasticsearchDomainRequest"}, + "output":{"shape":"DescribeElasticsearchDomainResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

" + }, + "DescribeElasticsearchDomainConfig":{ + "name":"DescribeElasticsearchDomainConfig", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/domain/{DomainName}/config" + }, + "input":{"shape":"DescribeElasticsearchDomainConfigRequest"}, + "output":{"shape":"DescribeElasticsearchDomainConfigResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

" + }, + "DescribeElasticsearchDomains":{ + "name":"DescribeElasticsearchDomains", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/domain-info" + }, + "input":{"shape":"DescribeElasticsearchDomainsRequest"}, + "output":{"shape":"DescribeElasticsearchDomainsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

" + }, + "DescribeElasticsearchInstanceTypeLimits":{ + "name":"DescribeElasticsearchInstanceTypeLimits", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/instanceTypeLimits/{ElasticsearchVersion}/{InstanceType}" + }, + "input":{"shape":"DescribeElasticsearchInstanceTypeLimitsRequest"}, + "output":{"shape":"DescribeElasticsearchInstanceTypeLimitsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"InvalidTypeException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

" + }, + "DescribeReservedElasticsearchInstanceOfferings":{ + "name":"DescribeReservedElasticsearchInstanceOfferings", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/reservedInstanceOfferings" + }, + "input":{"shape":"DescribeReservedElasticsearchInstanceOfferingsRequest"}, + "output":{"shape":"DescribeReservedElasticsearchInstanceOfferingsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Lists available reserved Elasticsearch instance offerings.

" + }, + "DescribeReservedElasticsearchInstances":{ + "name":"DescribeReservedElasticsearchInstances", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/reservedInstances" + }, + "input":{"shape":"DescribeReservedElasticsearchInstancesRequest"}, + "output":{"shape":"DescribeReservedElasticsearchInstancesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"}, + {"shape":"ValidationException"}, + {"shape":"DisabledOperationException"} + ], + "documentation":"

Returns information about reserved Elasticsearch instances for this account.

" + }, + "GetCompatibleElasticsearchVersions":{ + "name":"GetCompatibleElasticsearchVersions", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/compatibleVersions" + }, + "input":{"shape":"GetCompatibleElasticsearchVersionsRequest"}, + "output":{"shape":"GetCompatibleElasticsearchVersionsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

" + }, + "GetUpgradeHistory":{ + "name":"GetUpgradeHistory", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/upgradeDomain/{DomainName}/history" + }, + "input":{"shape":"GetUpgradeHistoryRequest"}, + "output":{"shape":"GetUpgradeHistoryResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

" + }, + "GetUpgradeStatus":{ + "name":"GetUpgradeStatus", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/upgradeDomain/{DomainName}/status" + }, + "input":{"shape":"GetUpgradeStatusRequest"}, + "output":{"shape":"GetUpgradeStatusResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

" + }, + "ListDomainNames":{ + "name":"ListDomainNames", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/domain" + }, + "output":{"shape":"ListDomainNamesResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns the name of all Elasticsearch domains owned by the current user's account.

" + }, + "ListElasticsearchInstanceTypes":{ + "name":"ListElasticsearchInstanceTypes", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/instanceTypes/{ElasticsearchVersion}" + }, + "input":{"shape":"ListElasticsearchInstanceTypesRequest"}, + "output":{"shape":"ListElasticsearchInstanceTypesResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

" + }, + "ListElasticsearchVersions":{ + "name":"ListElasticsearchVersions", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/es/versions" + }, + "input":{"shape":"ListElasticsearchVersionsRequest"}, + "output":{"shape":"ListElasticsearchVersionsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

List all supported Elasticsearch versions

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"GET", + "requestUri":"/2015-01-01/tags/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Returns all tags for the given Elasticsearch domain.

" + }, + "PurchaseReservedElasticsearchInstanceOffering":{ + "name":"PurchaseReservedElasticsearchInstanceOffering", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/purchaseReservedInstanceOffering" + }, + "input":{"shape":"PurchaseReservedElasticsearchInstanceOfferingRequest"}, + "output":{"shape":"PurchaseReservedElasticsearchInstanceOfferingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Allows you to purchase reserved Elasticsearch instances.

" + }, + "RemoveTags":{ + "name":"RemoveTags", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/tags-removal" + }, + "input":{"shape":"RemoveTagsRequest"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Removes the specified set of tags from the specified Elasticsearch domain.

" + }, + "StartElasticsearchServiceSoftwareUpdate":{ + "name":"StartElasticsearchServiceSoftwareUpdate", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/serviceSoftwareUpdate/start" + }, + "input":{"shape":"StartElasticsearchServiceSoftwareUpdateRequest"}, + "output":{"shape":"StartElasticsearchServiceSoftwareUpdateResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Schedules a service software update for an Amazon ES domain.

" + }, + "UpdateElasticsearchDomainConfig":{ + "name":"UpdateElasticsearchDomainConfig", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/domain/{DomainName}/config" + }, + "input":{"shape":"UpdateElasticsearchDomainConfigRequest"}, + "output":{"shape":"UpdateElasticsearchDomainConfigResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"InternalException"}, + {"shape":"InvalidTypeException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

" + }, + "UpgradeElasticsearchDomain":{ + "name":"UpgradeElasticsearchDomain", + "http":{ + "method":"POST", + "requestUri":"/2015-01-01/es/upgradeDomain" + }, + "input":{"shape":"UpgradeElasticsearchDomainRequest"}, + "output":{"shape":"UpgradeElasticsearchDomainResponse"}, + "errors":[ + {"shape":"BaseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"DisabledOperationException"}, + {"shape":"ValidationException"}, + {"shape":"InternalException"} + ], + "documentation":"

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

" + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "documentation":"

The Amazon Resource Name (ARN) of the Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "AccessPoliciesStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"PolicyDocument", + "documentation":"

The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.

" + } + }, + "documentation":"

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

" + }, + "AddTagsRequest":{ + "type":"structure", + "required":[ + "ARN", + "TagList" + ], + "members":{ + "ARN":{ + "shape":"ARN", + "documentation":"

Specify the ARN for which you want to add the tags.

" + }, + "TagList":{ + "shape":"TagList", + "documentation":"

List of Tag that need to be added for the Elasticsearch domain.

" + } + }, + "documentation":"

Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.

" + }, + "AdditionalLimit":{ + "type":"structure", + "members":{ + "LimitName":{ + "shape":"LimitName", + "documentation":"

Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc.
Attributes and their details:

  • MaximumNumberOfDataNodesSupported
    • This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node.
  • MaximumNumberOfDataNodesWithoutMasterNode
    • This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them.

" + }, + "LimitValues":{ + "shape":"LimitValueList", + "documentation":"

Value for given AdditionalLimit$LimitName .

" + } + }, + "documentation":"

List of limits that are specific to a given InstanceType and for each of it's InstanceRole .

" + }, + "AdditionalLimitList":{ + "type":"list", + "member":{"shape":"AdditionalLimit"} + }, + "AdvancedOptions":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "documentation":"

Exposes select native Elasticsearch configuration values from elasticsearch.yml. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

" + }, + "AdvancedOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"AdvancedOptions", + "documentation":"

Specifies the status of advanced options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:

  • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  • Option to specify the percentage of heap space that is allocated to field data. By default, this setting is unbounded.

For more information, see Configuring Advanced Options.

" + }, + "BaseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A description of the error.

" + } + }, + "documentation":"

An error occurred while processing the request.

", + "exception":true + }, + "Boolean":{"type":"boolean"}, + "CancelElasticsearchServiceSoftwareUpdateRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain that you want to stop the latest service software update on.

" + } + }, + "documentation":"

Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.

" + }, + "CancelElasticsearchServiceSoftwareUpdateResponse":{ + "type":"structure", + "members":{ + "ServiceSoftwareOptions":{ + "shape":"ServiceSoftwareOptions", + "documentation":"

The current status of the Elasticsearch service software update.

" + } + }, + "documentation":"

The result of a CancelElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

" + }, + "CloudWatchLogsLogGroupArn":{ + "type":"string", + "documentation":"

ARN of the Cloudwatch log group to which log needs to be published.

" + }, + "CognitoOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specifies the option to enable Cognito for Kibana authentication.

" + }, + "UserPoolId":{ + "shape":"UserPoolId", + "documentation":"

Specifies the Cognito user pool ID for Kibana authentication.

" + }, + "IdentityPoolId":{ + "shape":"IdentityPoolId", + "documentation":"

Specifies the Cognito identity pool ID for Kibana authentication.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

" + } + }, + "documentation":"

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" + }, + "CognitoOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"CognitoOptions", + "documentation":"

Specifies the Cognito options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the Cognito options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the Cognito options for the specified Elasticsearch domain.

" + }, + "CompatibleElasticsearchVersionsList":{ + "type":"list", + "member":{"shape":"CompatibleVersionsMap"} + }, + "CompatibleVersionsMap":{ + "type":"structure", + "members":{ + "SourceVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

The current version of Elasticsearch on which a domain is.

" + }, + "TargetVersions":{"shape":"ElasticsearchVersionList"} + }, + "documentation":"

A map from an ElasticsearchVersion to a list of compatible ElasticsearchVersion s to which the domain can be upgraded.

" + }, + "CreateElasticsearchDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" + }, + "ElasticsearchVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

String of format X.Y to specify version for the Elasticsearch domain eg. \"1.5\" or \"2.3\". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

" + }, + "ElasticsearchClusterConfig":{ + "shape":"ElasticsearchClusterConfig", + "documentation":"

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

" + }, + "EBSOptions":{ + "shape":"EBSOptions", + "documentation":"

Options to enable, disable and specify the type and size of EBS storage volumes.

" + }, + "AccessPolicies":{ + "shape":"PolicyDocument", + "documentation":"

IAM access policy as a JSON-formatted string.

" + }, + "SnapshotOptions":{ + "shape":"SnapshotOptions", + "documentation":"

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

" + }, + "VPCOptions":{ + "shape":"VPCOptions", + "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" + }, + "CognitoOptions":{ + "shape":"CognitoOptions", + "documentation":"

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" + }, + "EncryptionAtRestOptions":{ + "shape":"EncryptionAtRestOptions", + "documentation":"

Specifies the Encryption At Rest Options.

" + }, + "NodeToNodeEncryptionOptions":{ + "shape":"NodeToNodeEncryptionOptions", + "documentation":"

Specifies the NodeToNodeEncryptionOptions.

" + }, + "AdvancedOptions":{ + "shape":"AdvancedOptions", + "documentation":"

Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

" + }, + "LogPublishingOptions":{ + "shape":"LogPublishingOptions", + "documentation":"

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" + }, + "DomainEndpointOptions":{ + "shape":"DomainEndpointOptions", + "documentation":"

Options to specify configuration that will be applied to the domain endpoint.

" + } + } + }, + "CreateElasticsearchDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{ + "shape":"ElasticsearchDomainStatus", + "documentation":"

The status of the newly created Elasticsearch domain.

" + } + }, + "documentation":"

The result of a CreateElasticsearchDomain operation. Contains the status of the newly created Elasticsearch domain.

" + }, + "DeleteElasticsearchDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the Elasticsearch domain that you want to permanently delete.

", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":"

Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.

" + }, + "DeleteElasticsearchDomainResponse":{ + "type":"structure", + "members":{ + "DomainStatus":{ + "shape":"ElasticsearchDomainStatus", + "documentation":"

The status of the Elasticsearch domain being deleted.

" + } + }, + "documentation":"

The result of a DeleteElasticsearchDomain request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.

" + }, + "DeploymentCloseDateTimeStamp":{"type":"timestamp"}, + "DeploymentStatus":{ + "type":"string", + "enum":[ + "PENDING_UPDATE", + "IN_PROGRESS", + "COMPLETED", + "NOT_ELIGIBLE", + "ELIGIBLE" + ] + }, + "DescribeElasticsearchDomainConfigRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The Elasticsearch domain that you want to get information about.

", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":"

Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

" + }, + "DescribeElasticsearchDomainConfigResponse":{ + "type":"structure", + "required":["DomainConfig"], + "members":{ + "DomainConfig":{ + "shape":"ElasticsearchDomainConfig", + "documentation":"

The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.

" + } + }, + "documentation":"

The result of a DescribeElasticsearchDomainConfig request. Contains the configuration information of the requested domain.

" + }, + "DescribeElasticsearchDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the Elasticsearch domain for which you want information.

", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":"

Container for the parameters to the DescribeElasticsearchDomain operation.

" + }, + "DescribeElasticsearchDomainResponse":{ + "type":"structure", + "required":["DomainStatus"], + "members":{ + "DomainStatus":{ + "shape":"ElasticsearchDomainStatus", + "documentation":"

The current status of the Elasticsearch domain.

" + } + }, + "documentation":"

The result of a DescribeElasticsearchDomain request. Contains the status of the domain specified in the request.

" + }, + "DescribeElasticsearchDomainsRequest":{ + "type":"structure", + "required":["DomainNames"], + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"

The Elasticsearch domains for which you want information.

" + } + }, + "documentation":"

Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

" + }, + "DescribeElasticsearchDomainsResponse":{ + "type":"structure", + "required":["DomainStatusList"], + "members":{ + "DomainStatusList":{ + "shape":"ElasticsearchDomainStatusList", + "documentation":"

The status of the domains requested in the DescribeElasticsearchDomains request.

" + } + }, + "documentation":"

The result of a DescribeElasticsearchDomains request. Contains the status of the specified domains or all domains owned by the account.

" + }, + "DescribeElasticsearchInstanceTypeLimitsRequest":{ + "type":"structure", + "required":[ + "InstanceType", + "ElasticsearchVersion" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

", + "location":"querystring", + "locationName":"domainName" + }, + "InstanceType":{ + "shape":"ESPartitionInstanceType", + "documentation":"

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

", + "location":"uri", + "locationName":"InstanceType" + }, + "ElasticsearchVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

Version of Elasticsearch for which Limits are needed.

", + "location":"uri", + "locationName":"ElasticsearchVersion" + } + }, + "documentation":"

Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

" + }, + "DescribeElasticsearchInstanceTypeLimitsResponse":{ + "type":"structure", + "members":{ + "LimitsByRole":{"shape":"LimitsByRole"} + }, + "documentation":"

Container for the parameters received from DescribeElasticsearchInstanceTypeLimits operation.

" + }, + "DescribeReservedElasticsearchInstanceOfferingsRequest":{ + "type":"structure", + "members":{ + "ReservedElasticsearchInstanceOfferingId":{ + "shape":"GUID", + "documentation":"

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

", + "location":"querystring", + "locationName":"offeringId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Set this value to limit the number of results returned. If not specified, defaults to 100.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Container for parameters to DescribeReservedElasticsearchInstanceOfferings

" + }, + "DescribeReservedElasticsearchInstanceOfferingsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedElasticsearchInstanceOfferings":{ + "shape":"ReservedElasticsearchInstanceOfferingList", + "documentation":"

List of reserved Elasticsearch instance offerings

" + } + }, + "documentation":"

Container for results from DescribeReservedElasticsearchInstanceOfferings

" + }, + "DescribeReservedElasticsearchInstancesRequest":{ + "type":"structure", + "members":{ + "ReservedElasticsearchInstanceId":{ + "shape":"GUID", + "documentation":"

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

", + "location":"querystring", + "locationName":"reservationId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Set this value to limit the number of results returned. If not specified, defaults to 100.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Container for parameters to DescribeReservedElasticsearchInstances

" + }, + "DescribeReservedElasticsearchInstancesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

Provides an identifier to allow retrieval of paginated results.

" + }, + "ReservedElasticsearchInstances":{ + "shape":"ReservedElasticsearchInstanceList", + "documentation":"

List of reserved Elasticsearch instances.

" + } + }, + "documentation":"

Container for results from DescribeReservedElasticsearchInstances

" + }, + "DisabledOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An error occured because the client wanted to access a not supported operation. Gives http status code of 409.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DomainEndpointOptions":{ + "type":"structure", + "members":{ + "EnforceHTTPS":{ + "shape":"Boolean", + "documentation":"

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

" + }, + "TLSSecurityPolicy":{ + "shape":"TLSSecurityPolicy", + "documentation":"

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
It can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLSv1.0 and higher.
  • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.2

" + } + }, + "documentation":"

Options to configure endpoint for the Elasticsearch domain.

" + }, + "DomainEndpointOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"DomainEndpointOptions", + "documentation":"

Options to configure endpoint for the Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.

" + } + }, + "documentation":"

The configured endpoint options for the domain and their current status.

" + }, + "DomainId":{ + "type":"string", + "documentation":"

Unique identifier for an Elasticsearch domain.

", + "max":64, + "min":1 + }, + "DomainInfo":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

Specifies the DomainName.

" + } + } + }, + "DomainInfoList":{ + "type":"list", + "member":{"shape":"DomainInfo"}, + "documentation":"

Contains the list of Elasticsearch domain information.

" + }, + "DomainName":{ + "type":"string", + "documentation":"

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

", + "max":28, + "min":3, + "pattern":"[a-z][a-z0-9\\-]+" + }, + "DomainNameList":{ + "type":"list", + "member":{"shape":"DomainName"}, + "documentation":"

A list of Elasticsearch domain names.

" + }, + "Double":{"type":"double"}, + "EBSOptions":{ + "type":"structure", + "members":{ + "EBSEnabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether EBS-based storage is enabled.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

Specifies the volume type for EBS-based storage.

" + }, + "VolumeSize":{ + "shape":"IntegerClass", + "documentation":"

Integer to specify the size of an EBS volume.

" + }, + "Iops":{ + "shape":"IntegerClass", + "documentation":"

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

" + } + }, + "documentation":"

Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.

" + }, + "EBSOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"EBSOptions", + "documentation":"

Specifies the EBS options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the EBS options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the EBS options for the specified Elasticsearch domain.

" + }, + "ESPartitionInstanceType":{ + "type":"string", + "enum":[ + "m3.medium.elasticsearch", + "m3.large.elasticsearch", + "m3.xlarge.elasticsearch", + "m3.2xlarge.elasticsearch", + "m4.large.elasticsearch", + "m4.xlarge.elasticsearch", + "m4.2xlarge.elasticsearch", + "m4.4xlarge.elasticsearch", + "m4.10xlarge.elasticsearch", + "m5.large.elasticsearch", + "m5.xlarge.elasticsearch", + "m5.2xlarge.elasticsearch", + "m5.4xlarge.elasticsearch", + "m5.12xlarge.elasticsearch", + "r5.large.elasticsearch", + "r5.xlarge.elasticsearch", + "r5.2xlarge.elasticsearch", + "r5.4xlarge.elasticsearch", + "r5.12xlarge.elasticsearch", + "c5.large.elasticsearch", + "c5.xlarge.elasticsearch", + "c5.2xlarge.elasticsearch", + "c5.4xlarge.elasticsearch", + "c5.9xlarge.elasticsearch", + "c5.18xlarge.elasticsearch", + "t2.micro.elasticsearch", + "t2.small.elasticsearch", + "t2.medium.elasticsearch", + "r3.large.elasticsearch", + "r3.xlarge.elasticsearch", + "r3.2xlarge.elasticsearch", + "r3.4xlarge.elasticsearch", + "r3.8xlarge.elasticsearch", + "i2.xlarge.elasticsearch", + "i2.2xlarge.elasticsearch", + "d2.xlarge.elasticsearch", + "d2.2xlarge.elasticsearch", + "d2.4xlarge.elasticsearch", + "d2.8xlarge.elasticsearch", + "c4.large.elasticsearch", + "c4.xlarge.elasticsearch", + "c4.2xlarge.elasticsearch", + "c4.4xlarge.elasticsearch", + "c4.8xlarge.elasticsearch", + "r4.large.elasticsearch", + "r4.xlarge.elasticsearch", + "r4.2xlarge.elasticsearch", + "r4.4xlarge.elasticsearch", + "r4.8xlarge.elasticsearch", + "r4.16xlarge.elasticsearch", + "i3.large.elasticsearch", + "i3.xlarge.elasticsearch", + "i3.2xlarge.elasticsearch", + "i3.4xlarge.elasticsearch", + "i3.8xlarge.elasticsearch", + "i3.16xlarge.elasticsearch" + ] + }, + "ElasticsearchClusterConfig":{ + "type":"structure", + "members":{ + "InstanceType":{ + "shape":"ESPartitionInstanceType", + "documentation":"

The instance type for an Elasticsearch cluster.

" + }, + "InstanceCount":{ + "shape":"IntegerClass", + "documentation":"

The number of instances in the specified domain cluster.

" + }, + "DedicatedMasterEnabled":{ + "shape":"Boolean", + "documentation":"

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

" + }, + "ZoneAwarenessEnabled":{ + "shape":"Boolean", + "documentation":"

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

" + }, + "ZoneAwarenessConfig":{ + "shape":"ZoneAwarenessConfig", + "documentation":"

Specifies the zone awareness configuration for a domain when zone awareness is enabled.

" + }, + "DedicatedMasterType":{ + "shape":"ESPartitionInstanceType", + "documentation":"

The instance type for a dedicated master node.

" + }, + "DedicatedMasterCount":{ + "shape":"IntegerClass", + "documentation":"

Total number of dedicated master nodes, active and on standby, for the cluster.

" + } + }, + "documentation":"

Specifies the configuration for the domain cluster, such as the type and number of instances.

" + }, + "ElasticsearchClusterConfigStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"ElasticsearchClusterConfig", + "documentation":"

Specifies the cluster configuration for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the configuration for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Specifies the configuration status for the specified Elasticsearch domain.

" + }, + "ElasticsearchDomainConfig":{ + "type":"structure", + "members":{ + "ElasticsearchVersion":{ + "shape":"ElasticsearchVersionStatus", + "documentation":"

String of format X.Y to specify version for the Elasticsearch domain.

" + }, + "ElasticsearchClusterConfig":{ + "shape":"ElasticsearchClusterConfigStatus", + "documentation":"

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

" + }, + "EBSOptions":{ + "shape":"EBSOptionsStatus", + "documentation":"

Specifies the EBSOptions for the Elasticsearch domain.

" + }, + "AccessPolicies":{ + "shape":"AccessPoliciesStatus", + "documentation":"

IAM access policy as a JSON-formatted string.

" + }, + "SnapshotOptions":{ + "shape":"SnapshotOptionsStatus", + "documentation":"

Specifies the SnapshotOptions for the Elasticsearch domain.

" + }, + "VPCOptions":{ + "shape":"VPCDerivedInfoStatus", + "documentation":"

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" + }, + "CognitoOptions":{ + "shape":"CognitoOptionsStatus", + "documentation":"

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

" + }, + "EncryptionAtRestOptions":{ + "shape":"EncryptionAtRestOptionsStatus", + "documentation":"

Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

" + }, + "NodeToNodeEncryptionOptions":{ + "shape":"NodeToNodeEncryptionOptionsStatus", + "documentation":"

Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

" + }, + "AdvancedOptions":{ + "shape":"AdvancedOptionsStatus", + "documentation":"

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

" + }, + "LogPublishingOptions":{ + "shape":"LogPublishingOptionsStatus", + "documentation":"

Log publishing options for the given domain.

" + }, + "DomainEndpointOptions":{ + "shape":"DomainEndpointOptionsStatus", + "documentation":"

Specifies the DomainEndpointOptions for the Elasticsearch domain.

" + } + }, + "documentation":"

The configuration of an Elasticsearch domain.

" + }, + "ElasticsearchDomainStatus":{ + "type":"structure", + "required":[ + "DomainId", + "DomainName", + "ARN", + "ElasticsearchClusterConfig" + ], + "members":{ + "DomainId":{ + "shape":"DomainId", + "documentation":"

The unique identifier for the specified Elasticsearch domain.

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

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

" + }, + "ARN":{ + "shape":"ARN", + "documentation":"

The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

" + }, + "Created":{ + "shape":"Boolean", + "documentation":"

The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.

" + }, + "Deleted":{ + "shape":"Boolean", + "documentation":"

The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

" + }, + "Endpoint":{ + "shape":"ServiceUrl", + "documentation":"

The Elasticsearch domain endpoint that you use to submit index and search requests.

" + }, + "Endpoints":{ + "shape":"EndpointsMap", + "documentation":"

Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

" + }, + "Processing":{ + "shape":"Boolean", + "documentation":"

The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

" + }, + "UpgradeProcessing":{ + "shape":"Boolean", + "documentation":"

The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.

" + }, + "ElasticsearchVersion":{"shape":"ElasticsearchVersionString"}, + "ElasticsearchClusterConfig":{ + "shape":"ElasticsearchClusterConfig", + "documentation":"

The type and number of instances in the domain cluster.

" + }, + "EBSOptions":{ + "shape":"EBSOptions", + "documentation":"

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

" + }, + "AccessPolicies":{ + "shape":"PolicyDocument", + "documentation":"

IAM access policy as a JSON-formatted string.

" + }, + "SnapshotOptions":{ + "shape":"SnapshotOptions", + "documentation":"

Specifies the status of the SnapshotOptions

" + }, + "VPCOptions":{ + "shape":"VPCDerivedInfo", + "documentation":"

The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" + }, + "CognitoOptions":{ + "shape":"CognitoOptions", + "documentation":"

The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

" + }, + "EncryptionAtRestOptions":{ + "shape":"EncryptionAtRestOptions", + "documentation":"

Specifies the status of the EncryptionAtRestOptions.

" + }, + "NodeToNodeEncryptionOptions":{ + "shape":"NodeToNodeEncryptionOptions", + "documentation":"

Specifies the status of the NodeToNodeEncryptionOptions.

" + }, + "AdvancedOptions":{ + "shape":"AdvancedOptions", + "documentation":"

Specifies the status of the AdvancedOptions

" + }, + "LogPublishingOptions":{ + "shape":"LogPublishingOptions", + "documentation":"

Log publishing options for the given domain.

" + }, + "ServiceSoftwareOptions":{ + "shape":"ServiceSoftwareOptions", + "documentation":"

The current status of the Elasticsearch domain's service software.

" + }, + "DomainEndpointOptions":{ + "shape":"DomainEndpointOptions", + "documentation":"

The current status of the Elasticsearch domain's endpoint options.

" + } + }, + "documentation":"

The current status of an Elasticsearch domain.

" + }, + "ElasticsearchDomainStatusList":{ + "type":"list", + "member":{"shape":"ElasticsearchDomainStatus"}, + "documentation":"

A list that contains the status of each requested Elasticsearch domain.

" + }, + "ElasticsearchInstanceTypeList":{ + "type":"list", + "member":{"shape":"ESPartitionInstanceType"}, + "documentation":"

List of instance types supported by Amazon Elasticsearch service.

" + }, + "ElasticsearchVersionList":{ + "type":"list", + "member":{"shape":"ElasticsearchVersionString"}, + "documentation":"

List of supported elastic search versions.

" + }, + "ElasticsearchVersionStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"ElasticsearchVersionString", + "documentation":"

Specifies the Elasticsearch version for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the Elasticsearch version options for the specified Elasticsearch domain.

" + }, + "ElasticsearchVersionString":{"type":"string"}, + "EncryptionAtRestOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specifies the option to enable Encryption At Rest.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

Specifies the KMS Key ID for Encryption At Rest options.

" + } + }, + "documentation":"

Specifies the Encryption At Rest Options.

" + }, + "EncryptionAtRestOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"EncryptionAtRestOptions", + "documentation":"

Specifies the Encryption At Rest options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the Encryption At Rest options for the specified Elasticsearch domain.

" + }, + "EndpointsMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"ServiceUrl"} + }, + "ErrorMessage":{"type":"string"}, + "GUID":{ + "type":"string", + "pattern":"\\p{XDigit}{8}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{4}-\\p{XDigit}{12}" + }, + "GetCompatibleElasticsearchVersionsRequest":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "location":"querystring", + "locationName":"domainName" + } + }, + "documentation":"

Container for request parameters to GetCompatibleElasticsearchVersions operation.

" + }, + "GetCompatibleElasticsearchVersionsResponse":{ + "type":"structure", + "members":{ + "CompatibleElasticsearchVersions":{ + "shape":"CompatibleElasticsearchVersionsList", + "documentation":"

A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

" + } + }, + "documentation":"

Container for response returned by GetCompatibleElasticsearchVersions operation.

" + }, + "GetUpgradeHistoryRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "location":"uri", + "locationName":"DomainName" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Container for request parameters to GetUpgradeHistory operation.

" + }, + "GetUpgradeHistoryResponse":{ + "type":"structure", + "members":{ + "UpgradeHistories":{ + "shape":"UpgradeHistoryList", + "documentation":"

A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination token that needs to be supplied to the next call to get the next page of results

" + } + }, + "documentation":"

Container for response returned by GetUpgradeHistory operation.

" + }, + "GetUpgradeStatusRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "location":"uri", + "locationName":"DomainName" + } + }, + "documentation":"

Container for request parameters to GetUpgradeStatus operation.

" + }, + "GetUpgradeStatusResponse":{ + "type":"structure", + "members":{ + "UpgradeStep":{ + "shape":"UpgradeStep", + "documentation":"

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

" + }, + "StepStatus":{ + "shape":"UpgradeStatus", + "documentation":"

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

" + }, + "UpgradeName":{ + "shape":"UpgradeName", + "documentation":"

A string that describes the update briefly

" + } + }, + "documentation":"

Container for response returned by GetUpgradeStatus operation.

" + }, + "IdentityPoolId":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+:[0-9a-f-]+" + }, + "InstanceCount":{ + "type":"integer", + "documentation":"

Specifies the number of EC2 instances in the Elasticsearch domain.

", + "min":1 + }, + "InstanceCountLimits":{ + "type":"structure", + "members":{ + "MinimumInstanceCount":{"shape":"MinimumInstanceCount"}, + "MaximumInstanceCount":{"shape":"MaximumInstanceCount"} + }, + "documentation":"

InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

" + }, + "InstanceLimits":{ + "type":"structure", + "members":{ + "InstanceCountLimits":{"shape":"InstanceCountLimits"} + }, + "documentation":"

InstanceLimits represents the list of instance related attributes that are available for given InstanceType.

" + }, + "InstanceRole":{"type":"string"}, + "Integer":{"type":"integer"}, + "IntegerClass":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "Issue":{"type":"string"}, + "Issues":{ + "type":"list", + "member":{"shape":"Issue"} + }, + "KmsKeyId":{ + "type":"string", + "max":500, + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "LimitName":{"type":"string"}, + "LimitValue":{"type":"string"}, + "LimitValueList":{ + "type":"list", + "member":{"shape":"LimitValue"} + }, + "Limits":{ + "type":"structure", + "members":{ + "StorageTypes":{ + "shape":"StorageTypeList", + "documentation":"

StorageType represents the list of storage related types and attributes that are available for given InstanceType.

" + }, + "InstanceLimits":{"shape":"InstanceLimits"}, + "AdditionalLimits":{ + "shape":"AdditionalLimitList", + "documentation":"

List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole .

" + } + }, + "documentation":"

Limits for given InstanceType and for each of it's role.
Limits contains following StorageTypes, InstanceLimits and AdditionalLimits

" + }, + "LimitsByRole":{ + "type":"map", + "key":{"shape":"InstanceRole"}, + "value":{"shape":"Limits"}, + "documentation":"

Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

  • Data: If the given InstanceType is used as Data node
  • Master: If the given InstanceType is used as Master node

" + }, + "ListDomainNamesResponse":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainInfoList", + "documentation":"

List of Elasticsearch domain names.

" + } + }, + "documentation":"

The result of a ListDomainNames operation. Contains the names of all Elasticsearch domains owned by this account.

" + }, + "ListElasticsearchInstanceTypesRequest":{ + "type":"structure", + "required":["ElasticsearchVersion"], + "members":{ + "ElasticsearchVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

", + "location":"uri", + "locationName":"ElasticsearchVersion" + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

", + "location":"querystring", + "locationName":"domainName" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Container for the parameters to the ListElasticsearchInstanceTypes operation.

" + }, + "ListElasticsearchInstanceTypesResponse":{ + "type":"structure", + "members":{ + "ElasticsearchInstanceTypes":{ + "shape":"ElasticsearchInstanceTypeList", + "documentation":"

List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

" + } + }, + "documentation":"

Container for the parameters returned by ListElasticsearchInstanceTypes operation.

" + }, + "ListElasticsearchVersionsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Container for the parameters to the ListElasticsearchVersions operation.

Use MaxResults to control the maximum number of results to retrieve in a single call.

Use NextToken in response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.

" + }, + "ListElasticsearchVersionsResponse":{ + "type":"structure", + "members":{ + "ElasticsearchVersions":{"shape":"ElasticsearchVersionList"}, + "NextToken":{"shape":"NextToken"} + }, + "documentation":"

Container for the parameters for response received from ListElasticsearchVersions operation.

" + }, + "ListTagsRequest":{ + "type":"structure", + "required":["ARN"], + "members":{ + "ARN":{ + "shape":"ARN", + "documentation":"

Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

", + "location":"querystring", + "locationName":"arn" + } + }, + "documentation":"

Container for the parameters to the ListTags operation. Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view are attached.

" + }, + "ListTagsResponse":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

List of Tag for the requested Elasticsearch domain.

" + } + }, + "documentation":"

The result of a ListTags operation. Contains tags for all requested Elasticsearch domains.

" + }, + "LogPublishingOption":{ + "type":"structure", + "members":{ + "CloudWatchLogsLogGroupArn":{"shape":"CloudWatchLogsLogGroupArn"}, + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specifies whether given log publishing option is enabled or not.

" + } + }, + "documentation":"

Log Publishing option that is set for given domain.
Attributes and their details:

  • CloudWatchLogsLogGroupArn: ARN of the Cloudwatch log group to which log needs to be published.
  • Enabled: Whether the log publishing for given log type is enabled or not

" + }, + "LogPublishingOptions":{ + "type":"map", + "key":{"shape":"LogType"}, + "value":{"shape":"LogPublishingOption"} + }, + "LogPublishingOptionsStatus":{ + "type":"structure", + "members":{ + "Options":{ + "shape":"LogPublishingOptions", + "documentation":"

The log publishing options configured for the Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.

" + } + }, + "documentation":"

The configured log publishing options for the domain and their current status.

" + }, + "LogType":{ + "type":"string", + "documentation":"

Type of Log File, it can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
  • ES_APPLICATION_LOGS: Elasticsearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.

", + "enum":[ + "INDEX_SLOW_LOGS", + "SEARCH_SLOW_LOGS", + "ES_APPLICATION_LOGS" + ] + }, + "MaxResults":{ + "type":"integer", + "documentation":"

Set this value to limit the number of results returned.

", + "max":100 + }, + "MaximumInstanceCount":{ + "type":"integer", + "documentation":"

Maximum number of Instances that can be instantiated for given InstanceType.

" + }, + "MinimumInstanceCount":{ + "type":"integer", + "documentation":"

Minimum number of Instances that can be instantiated for given InstanceType.

" + }, + "NextToken":{ + "type":"string", + "documentation":"

Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

" + }, + "NodeToNodeEncryptionOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Specify true to enable node-to-node encryption.

" + } + }, + "documentation":"

Specifies the node-to-node encryption options.

" + }, + "NodeToNodeEncryptionOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"NodeToNodeEncryptionOptions", + "documentation":"

Specifies the node-to-node encryption options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the node-to-node encryption options for the specified Elasticsearch domain.

" + }, + "OptionState":{ + "type":"string", + "documentation":"

The state of a requested change. One of the following:

  • Processing: The request change is still in-process.
  • Active: The request change is processed and deployed to the Elasticsearch domain.
", + "enum":[ + "RequiresIndexDocuments", + "Processing", + "Active" + ] + }, + "OptionStatus":{ + "type":"structure", + "required":[ + "CreationDate", + "UpdateDate", + "State" + ], + "members":{ + "CreationDate":{ + "shape":"UpdateTimestamp", + "documentation":"

Timestamp which tells the creation date for the entity.

" + }, + "UpdateDate":{ + "shape":"UpdateTimestamp", + "documentation":"

Timestamp which tells the last updated time for the entity.

" + }, + "UpdateVersion":{ + "shape":"UIntValue", + "documentation":"

Specifies the latest version for the entity.

" + }, + "State":{ + "shape":"OptionState", + "documentation":"

Provides the OptionState for the Elasticsearch domain.

" + }, + "PendingDeletion":{ + "shape":"Boolean", + "documentation":"

Indicates whether the Elasticsearch domain is being deleted.

" + } + }, + "documentation":"

Provides the current status of the entity.

" + }, + "PolicyDocument":{ + "type":"string", + "documentation":"

Access policy rules for an Elasticsearch domain service endpoints. For more information, see Configuring Access Policies in the Amazon Elasticsearch Service Developer Guide. The maximum size of a policy document is 100 KB.

" + }, + "PurchaseReservedElasticsearchInstanceOfferingRequest":{ + "type":"structure", + "required":[ + "ReservedElasticsearchInstanceOfferingId", + "ReservationName" + ], + "members":{ + "ReservedElasticsearchInstanceOfferingId":{ + "shape":"GUID", + "documentation":"

The ID of the reserved Elasticsearch instance offering to purchase.

" + }, + "ReservationName":{ + "shape":"ReservationToken", + "documentation":"

A customer-specified identifier to track this reservation.

" + }, + "InstanceCount":{ + "shape":"InstanceCount", + "documentation":"

The number of Elasticsearch instances to reserve.

" + } + }, + "documentation":"

Container for parameters to PurchaseReservedElasticsearchInstanceOffering

" + }, + "PurchaseReservedElasticsearchInstanceOfferingResponse":{ + "type":"structure", + "members":{ + "ReservedElasticsearchInstanceId":{ + "shape":"GUID", + "documentation":"

Details of the reserved Elasticsearch instance which was purchased.

" + }, + "ReservationName":{ + "shape":"ReservationToken", + "documentation":"

The customer-specified identifier used to track this reservation.

" + } + }, + "documentation":"

Represents the output of a PurchaseReservedElasticsearchInstanceOffering operation.

" + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

The monetary amount of the recurring charge.

" + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

The frequency of the recurring charge.

" + } + }, + "documentation":"

Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.

" + }, + "RecurringChargeList":{ + "type":"list", + "member":{"shape":"RecurringCharge"} + }, + "RemoveTagsRequest":{ + "type":"structure", + "required":[ + "ARN", + "TagKeys" + ], + "members":{ + "ARN":{ + "shape":"ARN", + "documentation":"

Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

" + }, + "TagKeys":{ + "shape":"StringList", + "documentation":"

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

" + } + }, + "documentation":"

Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.

" + }, + "ReservationToken":{ + "type":"string", + "max":64, + "min":5 + }, + "ReservedElasticsearchInstance":{ + "type":"structure", + "members":{ + "ReservationName":{ + "shape":"ReservationToken", + "documentation":"

The customer-specified identifier to track this reservation.

" + }, + "ReservedElasticsearchInstanceId":{ + "shape":"GUID", + "documentation":"

The unique identifier for the reservation.

" + }, + "ReservedElasticsearchInstanceOfferingId":{ + "shape":"String", + "documentation":"

The offering identifier.

" + }, + "ElasticsearchInstanceType":{ + "shape":"ESPartitionInstanceType", + "documentation":"

The Elasticsearch instance type offered by the reserved instance offering.

" + }, + "StartTime":{ + "shape":"UpdateTimestamp", + "documentation":"

The time the reservation started.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration, in seconds, for which the Elasticsearch instance is reserved.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The rate you are charged for each hour for the domain that is using this reserved instance.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved Elasticsearch instance offering.

" + }, + "ElasticsearchInstanceCount":{ + "shape":"Integer", + "documentation":"

The number of Elasticsearch instances that have been reserved.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the reserved Elasticsearch instance.

" + }, + "PaymentOption":{ + "shape":"ReservedElasticsearchInstancePaymentOption", + "documentation":"

The payment option as defined in the reserved Elasticsearch instance offering.

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The charge to your account regardless of whether you are creating any domains using the instance offering.

" + } + }, + "documentation":"

Details of a reserved Elasticsearch instance.

" + }, + "ReservedElasticsearchInstanceList":{ + "type":"list", + "member":{"shape":"ReservedElasticsearchInstance"} + }, + "ReservedElasticsearchInstanceOffering":{ + "type":"structure", + "members":{ + "ReservedElasticsearchInstanceOfferingId":{ + "shape":"GUID", + "documentation":"

The Elasticsearch reserved instance offering identifier.

" + }, + "ElasticsearchInstanceType":{ + "shape":"ESPartitionInstanceType", + "documentation":"

The Elasticsearch instance type offered by the reserved instance offering.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

" + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

" + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

The rate you are charged for each hour the domain that is using the offering is running.

" + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

The currency code for the reserved Elasticsearch instance offering.

" + }, + "PaymentOption":{ + "shape":"ReservedElasticsearchInstancePaymentOption", + "documentation":"

Payment option for the reserved Elasticsearch instance offering

" + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

The charge to your account regardless of whether you are creating any domains using the instance offering.

" + } + }, + "documentation":"

Details of a reserved Elasticsearch instance offering.

" + }, + "ReservedElasticsearchInstanceOfferingList":{ + "type":"list", + "member":{"shape":"ReservedElasticsearchInstanceOffering"} + }, + "ReservedElasticsearchInstancePaymentOption":{ + "type":"string", + "enum":[ + "ALL_UPFRONT", + "PARTIAL_UPFRONT", + "NO_UPFRONT" + ] + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An exception for creating a resource that already exists. Gives http status code of 400.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "ServiceSoftwareOptions":{ + "type":"structure", + "members":{ + "CurrentVersion":{ + "shape":"String", + "documentation":"

The current service software version that is present on the domain.

" + }, + "NewVersion":{ + "shape":"String", + "documentation":"

The new service software version if one is available.

" + }, + "UpdateAvailable":{ + "shape":"Boolean", + "documentation":"

True if you are able to update you service software version. False if you are not able to update your service software version.

" + }, + "Cancellable":{ + "shape":"Boolean", + "documentation":"

True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

" + }, + "UpdateStatus":{ + "shape":"DeploymentStatus", + "documentation":"

The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the UpdateStatus.

" + }, + "AutomatedUpdateDate":{ + "shape":"DeploymentCloseDateTimeStamp", + "documentation":"

Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

" + } + }, + "documentation":"

The current options of an Elasticsearch domain service software options.

" + }, + "ServiceUrl":{ + "type":"string", + "documentation":"

The endpoint to which service requests are submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.es.amazonaws.com.

" + }, + "SnapshotOptions":{ + "type":"structure", + "members":{ + "AutomatedSnapshotStartHour":{ + "shape":"IntegerClass", + "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

" + } + }, + "documentation":"

Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

" + }, + "SnapshotOptionsStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"SnapshotOptions", + "documentation":"

Specifies the daily snapshot options specified for the Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of a daily automated snapshot.

" + } + }, + "documentation":"

Status of a daily automated snapshot.

" + }, + "StartElasticsearchServiceSoftwareUpdateRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain that you want to update to the latest service software.

" + } + }, + "documentation":"

Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.

" + }, + "StartElasticsearchServiceSoftwareUpdateResponse":{ + "type":"structure", + "members":{ + "ServiceSoftwareOptions":{ + "shape":"ServiceSoftwareOptions", + "documentation":"

The current status of the Elasticsearch service software update.

" + } + }, + "documentation":"

The result of a StartElasticsearchServiceSoftwareUpdate operation. Contains the status of the update.

" + }, + "StartTimestamp":{"type":"timestamp"}, + "StorageSubTypeName":{ + "type":"string", + "documentation":"

SubType of the given storage type. List of available sub-storage options: For \"instance\" storageType we wont have any storageSubType, in case of \"ebs\" storageType we will have following valid storageSubTypes

  1. standard
  2. gp2
  3. io1
Refer VolumeType for more information regarding above EBS storage options.

" + }, + "StorageType":{ + "type":"structure", + "members":{ + "StorageTypeName":{"shape":"StorageTypeName"}, + "StorageSubTypeName":{"shape":"StorageSubTypeName"}, + "StorageTypeLimits":{ + "shape":"StorageTypeLimitList", + "documentation":"

List of limits that are applicable for given storage type.

" + } + }, + "documentation":"

StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.

" + }, + "StorageTypeLimit":{ + "type":"structure", + "members":{ + "LimitName":{ + "shape":"LimitName", + "documentation":"

Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable

  1. MinimumVolumeSize
    2. Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  2. MaximumVolumeSize
    3. Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
  3. MaximumIops
    4. Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
  4. MinimumIops
    5. Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.

" + }, + "LimitValues":{ + "shape":"LimitValueList", + "documentation":"

Values for the StorageTypeLimit$LimitName .

" + } + }, + "documentation":"

Limits that are applicable for given storage type.

" + }, + "StorageTypeLimitList":{ + "type":"list", + "member":{"shape":"StorageTypeLimit"} + }, + "StorageTypeList":{ + "type":"list", + "member":{"shape":"StorageType"} + }, + "StorageTypeName":{ + "type":"string", + "documentation":"

Type of the storage. List of available storage options:

  1. instance
    2. Inbuilt storage available for the given Instance
  2. ebs
    3. Elastic block storage that would be attached to the given Instance

" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TLSSecurityPolicy":{ + "type":"string", + "enum":[ + "Policy-Min-TLS-1-0-2019-07", + "Policy-Min-TLS-1-2-2019-07" + ] + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

" + } + }, + "documentation":"

Specifies a key value pair for a resource tag.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string of length from 1 to 128 characters that specifies the key for a Tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.

", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "documentation":"

A list of Tag

" + }, + "TagValue":{ + "type":"string", + "documentation":"

A string of length from 0 to 256 characters that specifies the value for a Tag. Tag values can be null and do not have to be unique in a tag set.

", + "max":256, + "min":0 + }, + "UIntValue":{ + "type":"integer", + "min":0 + }, + "UpdateElasticsearchDomainConfigRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

The name of the Elasticsearch domain that you are updating.

", + "location":"uri", + "locationName":"DomainName" + }, + "ElasticsearchClusterConfig":{ + "shape":"ElasticsearchClusterConfig", + "documentation":"

The type and number of instances to instantiate for the domain cluster.

" + }, + "EBSOptions":{ + "shape":"EBSOptions", + "documentation":"

Specify the type and size of the EBS volume that you want to use.

" + }, + "SnapshotOptions":{ + "shape":"SnapshotOptions", + "documentation":"

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

" + }, + "VPCOptions":{ + "shape":"VPCOptions", + "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

" + }, + "CognitoOptions":{ + "shape":"CognitoOptions", + "documentation":"

Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

" + }, + "AdvancedOptions":{ + "shape":"AdvancedOptions", + "documentation":"

Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

" + }, + "AccessPolicies":{ + "shape":"PolicyDocument", + "documentation":"

IAM access policy as a JSON-formatted string.

" + }, + "LogPublishingOptions":{ + "shape":"LogPublishingOptions", + "documentation":"

Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

" + }, + "DomainEndpointOptions":{ + "shape":"DomainEndpointOptions", + "documentation":"

Options to specify configuration that will be applied to the domain endpoint.

" + } + }, + "documentation":"

Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

" + }, + "UpdateElasticsearchDomainConfigResponse":{ + "type":"structure", + "required":["DomainConfig"], + "members":{ + "DomainConfig":{ + "shape":"ElasticsearchDomainConfig", + "documentation":"

The status of the updated Elasticsearch domain.

" + } + }, + "documentation":"

The result of an UpdateElasticsearchDomain request. Contains the status of the Elasticsearch domain being updated.

" + }, + "UpdateTimestamp":{"type":"timestamp"}, + "UpgradeElasticsearchDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "TargetVersion" + ], + "members":{ + "DomainName":{"shape":"DomainName"}, + "TargetVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

The version of Elasticsearch that you intend to upgrade the domain to.

" + }, + "PerformCheckOnly":{ + "shape":"Boolean", + "documentation":"

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

" + } + }, + "documentation":"

Container for request parameters to UpgradeElasticsearchDomain operation.

" + }, + "UpgradeElasticsearchDomainResponse":{ + "type":"structure", + "members":{ + "DomainName":{"shape":"DomainName"}, + "TargetVersion":{ + "shape":"ElasticsearchVersionString", + "documentation":"

The version of Elasticsearch that you intend to upgrade the domain to.

" + }, + "PerformCheckOnly":{ + "shape":"Boolean", + "documentation":"

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

" + } + }, + "documentation":"

Container for response returned by UpgradeElasticsearchDomain operation.

" + }, + "UpgradeHistory":{ + "type":"structure", + "members":{ + "UpgradeName":{ + "shape":"UpgradeName", + "documentation":"

A string that describes the update briefly

" + }, + "StartTimestamp":{ + "shape":"StartTimestamp", + "documentation":"

UTC Timestamp at which the Upgrade API call was made in \"yyyy-MM-ddTHH:mm:ssZ\" format.

" + }, + "UpgradeStatus":{ + "shape":"UpgradeStatus", + "documentation":"

The overall status of the update. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

" + }, + "StepsList":{ + "shape":"UpgradeStepsList", + "documentation":"

A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.

" + } + }, + "documentation":"

History of the last 10 Upgrades and Upgrade Eligibility Checks.

" + }, + "UpgradeHistoryList":{ + "type":"list", + "member":{"shape":"UpgradeHistory"} + }, + "UpgradeName":{"type":"string"}, + "UpgradeStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "SUCCEEDED_WITH_ISSUES", + "FAILED" + ] + }, + "UpgradeStep":{ + "type":"string", + "enum":[ + "PRE_UPGRADE_CHECK", + "SNAPSHOT", + "UPGRADE" + ] + }, + "UpgradeStepItem":{ + "type":"structure", + "members":{ + "UpgradeStep":{ + "shape":"UpgradeStep", + "documentation":"

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

  • PreUpgradeCheck
  • Snapshot
  • Upgrade

" + }, + "UpgradeStepStatus":{ + "shape":"UpgradeStatus", + "documentation":"

The status of a particular step during an upgrade. The status can take one of the following values:

  • In Progress
  • Succeeded
  • Succeeded with Issues
  • Failed

" + }, + "Issues":{ + "shape":"Issues", + "documentation":"

A list of strings containing detailed information about the errors encountered in a particular step.

" + }, + "ProgressPercent":{ + "shape":"Double", + "documentation":"

The Floating point value representing progress percentage of a particular step.

" + } + }, + "documentation":"

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

" + }, + "UpgradeStepsList":{ + "type":"list", + "member":{"shape":"UpgradeStepItem"} + }, + "UserPoolId":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+_[0-9a-zA-Z]+" + }, + "VPCDerivedInfo":{ + "type":"structure", + "members":{ + "VPCId":{ + "shape":"String", + "documentation":"

The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

" + }, + "SubnetIds":{ + "shape":"StringList", + "documentation":"

Specifies the subnets for VPC endpoint.

" + }, + "AvailabilityZones":{ + "shape":"StringList", + "documentation":"

The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

" + }, + "SecurityGroupIds":{ + "shape":"StringList", + "documentation":"

Specifies the security groups for VPC endpoint.

" + } + }, + "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" + }, + "VPCDerivedInfoStatus":{ + "type":"structure", + "required":[ + "Options", + "Status" + ], + "members":{ + "Options":{ + "shape":"VPCDerivedInfo", + "documentation":"

Specifies the VPC options for the specified Elasticsearch domain.

" + }, + "Status":{ + "shape":"OptionStatus", + "documentation":"

Specifies the status of the VPC options for the specified Elasticsearch domain.

" + } + }, + "documentation":"

Status of the VPC options for the specified Elasticsearch domain.

" + }, + "VPCOptions":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"StringList", + "documentation":"

Specifies the subnets for VPC endpoint.

" + }, + "SecurityGroupIds":{ + "shape":"StringList", + "documentation":"

Specifies the security groups for VPC endpoint.

" + } + }, + "documentation":"

Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

" + }, + "ValidationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An exception for missing / invalid input fields. Gives http status code of 400.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VolumeType":{ + "type":"string", + "documentation":"

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.

", + "enum":[ + "standard", + "gp2", + "io1" + ] + }, + "ZoneAwarenessConfig":{ + "type":"structure", + "members":{ + "AvailabilityZoneCount":{ + "shape":"IntegerClass", + "documentation":"

An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled

" + } + }, + "documentation":"

Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

" + } + }, + "documentation":"Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

" +} diff --git a/aws/dist/botocore/data/events/2014-02-03/service-2.json b/aws/dist/botocore/data/events/2014-02-03/service-2.json new file mode 100644 index 00000000..cbd4d60d --- /dev/null +++ b/aws/dist/botocore/data/events/2014-02-03/service-2.json @@ -0,0 +1,998 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-02-03", + "endpointPrefix":"events", + "jsonVersion":"1.1", + "serviceFullName":"Amazon CloudWatch Events", + "serviceId":"CloudWatch Events", + "signatureVersion":"v4", + "targetPrefix":"AWSEvents", + "protocol":"json" + }, + "documentation":"

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
  • Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security or availability risks.
  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide.

", + "operations":{ + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteRuleRequest", + "documentation":"

Container for the parameters to the DeleteRule operation.

" + }, + "errors":[ + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.

Note: When you make a change with this action, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.

" + }, + "DescribeRule":{ + "name":"DescribeRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeRuleRequest", + "documentation":"

Container for the parameters to the DescribeRule operation.

" + }, + "output":{ + "shape":"DescribeRuleResponse", + "documentation":"

The result of the DescribeRule operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Describes the details of the specified rule.

" + }, + "DisableRule":{ + "name":"DisableRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DisableRuleRequest", + "documentation":"

Container for the parameters to the DisableRule operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

Note: When you make a change with this action, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.

" + }, + "EnableRule":{ + "name":"EnableRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"EnableRuleRequest", + "documentation":"

Container for the parameters to the EnableRule operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Enables a rule. If the rule does not exist, the operation fails.

Note: When you make a change with this action, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.

" + }, + "ListRuleNamesByTarget":{ + "name":"ListRuleNamesByTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListRuleNamesByTargetRequest", + "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" + }, + "output":{ + "shape":"ListRuleNamesByTargetResponse", + "documentation":"

The result of the ListRuleNamesByTarget operation.

" + }, + "errors":[ + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Lists the names of the rules that the given target is put to. Using this action, you can find out which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat the ListRulesByTarget action until the NextToken in the response is returned as null.

" + }, + "ListRules":{ + "name":"ListRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListRulesRequest", + "documentation":"

Container for the parameters to the ListRules operation.

" + }, + "output":{ + "shape":"ListRulesResponse", + "documentation":"

The result of the ListRules operation.

" + }, + "errors":[ + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat the ListRules action until the NextToken in the response is returned as null.

" + }, + "ListTargetsByRule":{ + "name":"ListTargetsByRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTargetsByRuleRequest", + "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" + }, + "output":{ + "shape":"ListTargetsByRuleResponse", + "documentation":"

The result of the ListTargetsByRule operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Lists of targets assigned to the rule.

" + }, + "PutEvents":{ + "name":"PutEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutEventsRequest", + "documentation":"

Container for the parameters to the PutEvents operation.

" + }, + "output":{ + "shape":"PutEventsResponse", + "documentation":"

The result of the PutEvents operation.

" + }, + "errors":[ + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

" + }, + "PutRule":{ + "name":"PutRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutRuleRequest", + "documentation":"

Container for the parameters to the PutRule operation.

" + }, + "output":{ + "shape":"PutRuleResponse", + "documentation":"

The result of the PutRule operation.

" + }, + "errors":[ + { + "shape":"InvalidEventPatternException", + "exception":true, + "documentation":"

The event pattern is invalid.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" + }, + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.

Note: When you make a change with this action, incoming events might not immediately start matching to new or updated rules. Please allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule will trigger on matching events as well as on a schedule.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" + }, + "PutTargets":{ + "name":"PutTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PutTargetsRequest", + "documentation":"

Container for the parameters to the PutTargets operation.

" + }, + "output":{ + "shape":"PutTargetsResponse", + "documentation":"

The result of the PutTargets operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"LimitExceededException", + "exception":true, + "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Adds target(s) to a rule. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.

Note: When you make a change with this action, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.

" + }, + "RemoveTargets":{ + "name":"RemoveTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTargetsRequest", + "documentation":"

Container for the parameters to the RemoveTargets operation.

" + }, + "output":{ + "shape":"RemoveTargetsResponse", + "documentation":"

The result of the RemoveTargets operation.

" + }, + "errors":[ + { + "shape":"ResourceNotFoundException", + "exception":true, + "documentation":"

The rule does not exist.

" + }, + { + "shape":"ConcurrentModificationException", + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.

Note: When you make a change with this action, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.

" + }, + "TestEventPattern":{ + "name":"TestEventPattern", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"TestEventPatternRequest", + "documentation":"

Container for the parameters to the TestEventPattern operation.

" + }, + "output":{ + "shape":"TestEventPatternResponse", + "documentation":"

The result of the TestEventPattern operation.

" + }, + "errors":[ + { + "shape":"InvalidEventPatternException", + "exception":true, + "documentation":"

The event pattern is invalid.

" + }, + { + "shape":"InternalException", + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + } + ], + "documentation":"

Tests whether an event pattern matches the provided event.

Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

" + } + }, + "shapes":{ + "Boolean":{"type":"boolean"}, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

This exception occurs if there is concurrent modification on rule or target.

" + }, + "DeleteRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule to be deleted.

" + } + }, + "documentation":"

Container for the parameters to the DeleteRule operation.

" + }, + "DescribeRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule you want to describe details for.

" + } + }, + "documentation":"

Container for the parameters to the DescribeRule operation.

" + }, + "DescribeRuleResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The rule's name.

" + }, + "Arn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) associated with the rule.

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

Specifies whether the rule is enabled or disabled.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

The rule's description.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + } + }, + "documentation":"

The result of the DescribeRule operation.

" + }, + "DisableRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule you want to disable.

" + } + }, + "documentation":"

Container for the parameters to the DisableRule operation.

" + }, + "EnableRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule that you want to enable.

" + } + }, + "documentation":"

Container for the parameters to the EnableRule operation.

" + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "EventId":{"type":"string"}, + "EventPattern":{ + "type":"string", + "max":2048 + }, + "EventResource":{"type":"string"}, + "EventResourceList":{ + "type":"list", + "member":{"shape":"EventResource"} + }, + "EventTime":{"type":"timestamp"}, + "Integer":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "fault":true, + "documentation":"

This exception occurs due to unexpected causes.

" + }, + "InvalidEventPatternException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The event pattern is invalid.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

This exception occurs if you try to create more rules or add more targets to a rule than allowed by default.

" + }, + "LimitMax100":{ + "type":"integer", + "min":1, + "max":100 + }, + "ListRuleNamesByTargetRequest":{ + "type":"structure", + "required":["TargetArn"], + "members":{ + "TargetArn":{ + "shape":"TargetArn", + "documentation":"

The Amazon Resource Name (ARN) of the target resource that you want to list the rules for.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + }, + "documentation":"

Container for the parameters to the ListRuleNamesByTarget operation.

" + }, + "ListRuleNamesByTargetResponse":{ + "type":"structure", + "members":{ + "RuleNames":{ + "shape":"RuleNameList", + "documentation":"

List of rules names that can invoke the given target.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates that there are additional results to retrieve.

" + } + }, + "documentation":"

The result of the ListRuleNamesByTarget operation.

" + }, + "ListRulesRequest":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"RuleName", + "documentation":"

The prefix matching the rule name.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + }, + "documentation":"

Container for the parameters to the ListRules operation.

" + }, + "ListRulesResponse":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"RuleResponseList", + "documentation":"

List of rules matching the specified criteria.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates that there are additional results to retrieve.

" + } + }, + "documentation":"

The result of the ListRules operation.

" + }, + "ListTargetsByRuleRequest":{ + "type":"structure", + "required":["Rule"], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule whose targets you want to list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + }, + "documentation":"

Container for the parameters to the ListTargetsByRule operation.

" + }, + "ListTargetsByRuleResponse":{ + "type":"structure", + "members":{ + "Targets":{ + "shape":"TargetList", + "documentation":"

Lists the targets assigned to the rule.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates that there are additional results to retrieve.

" + } + }, + "documentation":"

The result of the ListTargetsByRule operation.

" + }, + "NextToken":{ + "type":"string", + "min":1, + "max":2048 + }, + "PutEventsRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{ + "shape":"PutEventsRequestEntryList", + "documentation":"

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

" + } + }, + "documentation":"

Container for the parameters to the PutEvents operation.

" + }, + "PutEventsRequestEntry":{ + "type":"structure", + "members":{ + "Time":{ + "shape":"EventTime", + "documentation":"

Timestamp of event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call will be used.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the event.

" + }, + "Resources":{ + "shape":"EventResourceList", + "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

" + }, + "DetailType":{ + "shape":"String", + "documentation":"

Free-form string used to decide what fields to expect in the event detail.

" + }, + "Detail":{ + "shape":"String", + "documentation":"

In the JSON sense, an object containing fields, which may also contain nested sub-objects. No constraints are imposed on its contents.

" + } + }, + "documentation":"

Contains information about the event to be used in the PutEvents action.

" + }, + "PutEventsRequestEntryList":{ + "type":"list", + "member":{"shape":"PutEventsRequestEntry"}, + "min":1, + "max":10 + }, + "PutEventsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "Entries":{ + "shape":"PutEventsResultEntryList", + "documentation":"

A list of successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry will have the event ID in it. If not, then the ErrorCode and ErrorMessage can be used to identify the problem with the entry.

" + } + }, + "documentation":"

The result of the PutEvents operation.

" + }, + "PutEventsResultEntry":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"EventId", + "documentation":"

The ID of the event submitted to Amazon CloudWatch Events.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code representing why the event submission failed on this entry.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message explaining why the event submission failed on this entry.

" + } + }, + "documentation":"

A PutEventsResult contains a list of PutEventsResultEntry.

" + }, + "PutEventsResultEntryList":{ + "type":"list", + "member":{"shape":"PutEventsResultEntry"} + }, + "PutRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule that you are creating or updating.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern.

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

Indicates whether the rule is enabled or disabled.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

A description of the rule.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + } + }, + "documentation":"

Container for the parameters to the PutRule operation.

" + }, + "PutRuleResponse":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the rule.

" + } + }, + "documentation":"

The result of the PutRule operation.

" + }, + "PutTargetsRequest":{ + "type":"structure", + "required":[ + "Rule", + "Targets" + ], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule you want to add targets to.

" + }, + "Targets":{ + "shape":"TargetList", + "documentation":"

List of targets you want to update or add to the rule.

" + } + }, + "documentation":"

Container for the parameters to the PutTargets operation.

" + }, + "PutTargetsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "FailedEntries":{ + "shape":"PutTargetsResultEntryList", + "documentation":"

An array of failed target entries.

" + } + }, + "documentation":"

The result of the PutTargets operation.

" + }, + "PutTargetsResultEntry":{ + "type":"structure", + "members":{ + "TargetId":{ + "shape":"TargetId", + "documentation":"

The ID of the target submitted to Amazon CloudWatch Events.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code representing why the target submission failed on this entry.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message explaining why the target submission failed on this entry.

" + } + }, + "documentation":"

A PutTargetsResult contains a list of PutTargetsResultEntry.

" + }, + "PutTargetsResultEntryList":{ + "type":"list", + "member":{"shape":"PutTargetsResultEntry"} + }, + "RemoveTargetsRequest":{ + "type":"structure", + "required":[ + "Rule", + "Ids" + ], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule you want to remove targets from.

" + }, + "Ids":{ + "shape":"TargetIdList", + "documentation":"

The list of target IDs to remove from the rule.

" + } + }, + "documentation":"

Container for the parameters to the RemoveTargets operation.

" + }, + "RemoveTargetsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "FailedEntries":{ + "shape":"RemoveTargetsResultEntryList", + "documentation":"

An array of failed target entries.

" + } + }, + "documentation":"

The result of the RemoveTargets operation.

" + }, + "RemoveTargetsResultEntry":{ + "type":"structure", + "members":{ + "TargetId":{ + "shape":"TargetId", + "documentation":"

The ID of the target requested to be removed by Amazon CloudWatch Events.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code representing why the target removal failed on this entry.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message explaining why the target removal failed on this entry.

" + } + }, + "documentation":"

The ID of the target requested to be removed from the rule by Amazon CloudWatch Events.

" + }, + "RemoveTargetsResultEntryList":{ + "type":"list", + "member":{"shape":"RemoveTargetsResultEntry"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "documentation":"

The rule does not exist.

" + }, + "RoleArn":{ + "type":"string", + "min":1, + "max":1600 + }, + "Rule":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The rule's name.

" + }, + "Arn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern of the rule.

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

The rule's state.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

The description of the rule.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

" + } + }, + "documentation":"

Contains information about a rule in Amazon CloudWatch Events. A ListRulesResult contains a list of Rules.

" + }, + "RuleArn":{ + "type":"string", + "min":1, + "max":1600 + }, + "RuleDescription":{ + "type":"string", + "max":512 + }, + "RuleName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "RuleNameList":{ + "type":"list", + "member":{"shape":"RuleName"} + }, + "RuleResponseList":{ + "type":"list", + "member":{"shape":"Rule"} + }, + "RuleState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "ScheduleExpression":{ + "type":"string", + "max":256 + }, + "String":{"type":"string"}, + "Target":{ + "type":"structure", + "required":[ + "Id", + "Arn" + ], + "members":{ + "Id":{ + "shape":"TargetId", + "documentation":"

The unique target assignment ID.

" + }, + "Arn":{ + "shape":"TargetArn", + "documentation":"

The Amazon Resource Name (ARN) associated of the target.

" + }, + "Input":{ + "shape":"TargetInput", + "documentation":"

Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format.

" + }, + "InputPath":{ + "shape":"TargetInputPath", + "documentation":"

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. For more information about JSON paths, see JSONPath.

" + } + }, + "documentation":"

Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets.

Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:

  • Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
  • InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
  • Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.
" + }, + "TargetArn":{ + "type":"string", + "min":1, + "max":1600 + }, + "TargetId":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "TargetIdList":{ + "type":"list", + "member":{"shape":"TargetId"}, + "min":1, + "max":100 + }, + "TargetInput":{ + "type":"string", + "max":8192 + }, + "TargetInputPath":{ + "type":"string", + "max":256 + }, + "TargetList":{ + "type":"list", + "member":{"shape":"Target"} + }, + "TestEventPatternRequest":{ + "type":"structure", + "required":[ + "EventPattern", + "Event" + ], + "members":{ + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern you want to test.

" + }, + "Event":{ + "shape":"String", + "documentation":"

The event in the JSON format to test against the event pattern.

" + } + }, + "documentation":"

Container for the parameters to the TestEventPattern operation.

" + }, + "TestEventPatternResponse":{ + "type":"structure", + "members":{ + "Result":{ + "shape":"Boolean", + "documentation":"

Indicates whether the event matches the event pattern.

" + } + }, + "documentation":"

The result of the TestEventPattern operation.

" + } + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/events/2015-10-07/examples-1.json b/aws/dist/botocore/data/events/2015-10-07/examples-1.json new file mode 100644 index 00000000..faff7689 --- /dev/null +++ b/aws/dist/botocore/data/events/2015-10-07/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/aws/dist/botocore/data/events/2015-10-07/paginators-1.json b/aws/dist/botocore/data/events/2015-10-07/paginators-1.json new file mode 100644 index 00000000..501a3229 --- /dev/null +++ b/aws/dist/botocore/data/events/2015-10-07/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListRuleNamesByTarget": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "RuleNames" + }, + "ListRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Rules" + }, + "ListTargetsByRule": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "Limit", + "result_key": "Targets" + } + } +} diff --git a/aws/dist/botocore/data/events/2015-10-07/service-2.json b/aws/dist/botocore/data/events/2015-10-07/service-2.json new file mode 100644 index 00000000..5ca6e23b --- /dev/null +++ b/aws/dist/botocore/data/events/2015-10-07/service-2.json @@ -0,0 +1,2155 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-07", + "endpointPrefix":"events", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon EventBridge", + "serviceId":"EventBridge", + "signatureVersion":"v4", + "targetPrefix":"AWSEvents", + "uid":"eventbridge-2015-10-07" + }, + "operations":{ + "ActivateEventSource":{ + "name":"ActivateEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ActivateEventSourceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"}, + {"shape":"InternalException"} + ], + "documentation":"

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

This operation is performed by AWS customers, not by SaaS partners.

" + }, + "CreateEventBus":{ + "name":"CreateEventBus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventBusRequest"}, + "output":{"shape":"CreateEventBusResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"}, + {"shape":"InternalException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your own custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

This operation is used by AWS customers, not by SaaS partners.

" + }, + "CreatePartnerEventSource":{ + "name":"CreatePartnerEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePartnerEventSourceRequest"}, + "output":{"shape":"CreatePartnerEventSourceResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InternalException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Called by an SaaS partner to create a partner event source.

This operation is not used by AWS customers.

Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.

A partner event source creates events based on resources in the SaaS partner's service or application.

An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.

Partner event source names follow this format:

aws.partner/partner_name/event_namespace/event_name

  • partner_name is determined during partner registration and identifies the partner to AWS customers.

  • For event_namespace, we recommend that partners use a string that identifies the AWS customer within the partner's system. This should not be the customer's AWS account ID.

  • event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. This should help AWS customers decide whether to create an event bus to receive these events.

" + }, + "DeactivateEventSource":{ + "name":"DeactivateEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeactivateEventSourceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"}, + {"shape":"InternalException"} + ], + "documentation":"

An AWS customer uses this operation to temporarily stop receiving events from the specified partner event source. The matching event bus isn't deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it's deleted.

To activate a deactivated partner event source, use ActivateEventSource.

" + }, + "DeleteEventBus":{ + "name":"DeleteEventBus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventBusRequest"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

Deletes the specified custom event bus or partner event bus. All rules associated with this event bus are also deleted. You can't delete your account's default event bus.

This operation is performed by AWS customers, not by SaaS partners.

" + }, + "DeletePartnerEventSource":{ + "name":"DeletePartnerEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePartnerEventSourceRequest"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

This operation is used by SaaS partners to delete a partner event source. AWS customers don't use this operation.

When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.

" + }, + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleRequest"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you're sure that the other service isn't still using that rule.

" + }, + "DescribeEventBus":{ + "name":"DescribeEventBus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventBusRequest"}, + "output":{"shape":"DescribeEventBusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

" + }, + "DescribeEventSource":{ + "name":"DescribeEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSourceRequest"}, + "output":{"shape":"DescribeEventSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

This operation lists details about a partner event source that is shared with your account.

This operation is run by AWS customers, not by SaaS partners.

" + }, + "DescribePartnerEventSource":{ + "name":"DescribePartnerEventSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePartnerEventSourceRequest"}, + "output":{"shape":"DescribePartnerEventSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

An SaaS partner can use this operation to list details about a partner event source that they have created.

AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.

" + }, + "DescribeRule":{ + "name":"DescribeRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRuleRequest"}, + "output":{"shape":"DescribeRuleResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

Describes the specified rule.

DescribeRule doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

" + }, + "DisableRule":{ + "name":"DisableRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableRuleRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"} + ], + "documentation":"

Disables the specified rule. A disabled rule won't match any events and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

" + }, + "EnableRule":{ + "name":"EnableRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableRuleRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"} + ], + "documentation":"

Enables the specified rule. If the rule doesn't exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

" + }, + "ListEventBuses":{ + "name":"ListEventBuses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventBusesRequest"}, + "output":{"shape":"ListEventBusesResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

This operation is run by AWS customers, not by SaaS partners.

" + }, + "ListEventSources":{ + "name":"ListEventSources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventSourcesRequest"}, + "output":{"shape":"ListEventSourcesResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.

This operation is run by AWS customers, not by SaaS partners.

" + }, + "ListPartnerEventSourceAccounts":{ + "name":"ListPartnerEventSourceAccounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPartnerEventSourceAccountsRequest"}, + "output":{"shape":"ListPartnerEventSourceAccountsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with.

This operation is used by SaaS partners, not by AWS customers.

" + }, + "ListPartnerEventSources":{ + "name":"ListPartnerEventSources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPartnerEventSourcesRequest"}, + "output":{"shape":"ListPartnerEventSourcesResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

An SaaS partner can use this operation to list all the partner event source names that they have created.

This operation is not used by AWS customers.

" + }, + "ListRuleNamesByTarget":{ + "name":"ListRuleNamesByTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRuleNamesByTargetRequest"}, + "output":{"shape":"ListRuleNamesByTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the rules for the specified target. You can see which rules can invoke a specific target in your account.

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

Lists your EventBridge rules. You can either list all the rules or provide a prefix to match to the rule names.

ListRules doesn't list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

Displays the tags associated with an EventBridge resource. In EventBridge, rules can be tagged.

" + }, + "ListTargetsByRule":{ + "name":"ListTargetsByRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTargetsByRuleRequest"}, + "output":{"shape":"ListTargetsByRuleResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"} + ], + "documentation":"

Lists the targets assigned to the specified rule.

" + }, + "PutEvents":{ + "name":"PutEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutEventsRequest"}, + "output":{"shape":"PutEventsResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

Sends custom events to EventBridge so that they can be matched to rules. These events can be from your custom applications and services.

" + }, + "PutPartnerEvents":{ + "name":"PutPartnerEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPartnerEventsRequest"}, + "output":{"shape":"PutPartnerEventsResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

This is used by SaaS partners to write events to a customer's partner event bus.

AWS customers do not use this operation. Instead, AWS customers can use PutEvents to write custom events from their own applications to an event bus.

" + }, + "PutPermission":{ + "name":"PutPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPermissionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"PolicyLengthExceededException"}, + {"shape":"InternalException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have a rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to an event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as \"*\" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

The permission policy on an event bus can't exceed 10 KB in size.

" + }, + "PutRule":{ + "name":"PutRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRuleRequest"}, + "output":{"shape":"PutRuleResponse"}, + "errors":[ + {"shape":"InvalidEventPatternException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates or updates the specified rule. Rules are enabled by default or based on value of the state. You can disable a rule using DisableRule.

A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

If you're updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments aren't kept. Instead, they're replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match.

In EventBridge, you could create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If you don't write the rule carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions don't refire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

" + }, + "PutTargets":{ + "name":"PutTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutTargetsRequest"}, + "output":{"shape":"PutTargetsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"} + ], + "documentation":"

Adds the specified targets to the specified rule, or updates the targets if they're already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets in EventBridge:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Creating rules with built-in targets is supported only on the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.

If another AWS account is in the same Region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event isn't charged. For more information, see Amazon EventBridge Pricing.

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is nonzero in the response, and each entry in FailedEntries provides the ID of the failed target and the error code.

" + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemovePermissionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

" + }, + "RemoveTargets":{ + "name":"RemoveTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTargetsRequest"}, + "output":{"shape":"RemoveTargetsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"}, + {"shape":"InternalException"} + ], + "documentation":"

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InternalException"}, + {"shape":"ManagedRuleException"} + ], + "documentation":"

Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules can be tagged.

Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.

You can use the TagResource action with a rule that already has tags. If you specify a new tag key for the rule, this tag is appended to the list of tags associated with the rule. If you specify a tag key that is already associated with the rule, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

" + }, + "TestEventPattern":{ + "name":"TestEventPattern", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestEventPatternRequest"}, + "output":{"shape":"TestEventPatternResponse"}, + "errors":[ + {"shape":"InvalidEventPatternException"}, + {"shape":"InternalException"} + ], + "documentation":"

Tests whether the specified event pattern matches the provided event.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event that you want to match.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ManagedRuleException"} + ], + "documentation":"

Removes one or more tags from the specified EventBridge resource. In EventBridge, rules can be tagged.

" + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"\\d{12}" + }, + "Action":{ + "type":"string", + "max":64, + "min":1, + "pattern":"events:[a-zA-Z]+" + }, + "ActivateEventSourceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the partner event source to activate.

" + } + } + }, + "Arn":{ + "type":"string", + "max":1600, + "min":1 + }, + "AssignPublicIp":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "AwsVpcConfiguration":{ + "type":"structure", + "required":["Subnets"], + "members":{ + "Subnets":{ + "shape":"StringList", + "documentation":"

Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.

" + }, + "SecurityGroups":{ + "shape":"StringList", + "documentation":"

Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you don't specify a security group, the default security group for the VPC is used.

" + }, + "AssignPublicIp":{ + "shape":"AssignPublicIp", + "documentation":"

Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE.

" + } + }, + "documentation":"

This structure specifies the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

" + }, + "BatchArrayProperties":{ + "type":"structure", + "members":{ + "Size":{ + "shape":"Integer", + "documentation":"

The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.

" + } + }, + "documentation":"

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

" + }, + "BatchParameters":{ + "type":"structure", + "required":[ + "JobDefinition", + "JobName" + ], + "members":{ + "JobDefinition":{ + "shape":"String", + "documentation":"

The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.

" + }, + "JobName":{ + "shape":"String", + "documentation":"

The name to use for this execution of the job, if the target is an AWS Batch job.

" + }, + "ArrayProperties":{ + "shape":"BatchArrayProperties", + "documentation":"

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

" + }, + "RetryStrategy":{ + "shape":"BatchRetryStrategy", + "documentation":"

The retry strategy to use for failed jobs if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

" + } + }, + "documentation":"

The custom parameters to be used when the target is an AWS Batch job.

" + }, + "BatchRetryStrategy":{ + "type":"structure", + "members":{ + "Attempts":{ + "shape":"Integer", + "documentation":"

The number of times to attempt to retry, if the job fails. Valid values are 1–10.

" + } + }, + "documentation":"

The retry strategy to use for failed jobs if the target is an AWS Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

" + }, + "Boolean":{"type":"boolean"}, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is concurrent modification on a resource.

", + "exception":true + }, + "Condition":{ + "type":"structure", + "required":[ + "Type", + "Key", + "Value" + ], + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The type of condition. Currently, the only supported value is StringEquals.

" + }, + "Key":{ + "shape":"String", + "documentation":"

The key for the condition. Currently, the only supported key is aws:PrincipalOrgID.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value for the key. Currently, this must be the ID of the organization.

" + } + }, + "documentation":"

A JSON string that you can use to limit the event bus permissions that you're granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. The following is an example value for Condition:

'{\"Type\" : \"StringEquals\", \"Key\": \"aws:PrincipalOrgID\", \"Value\": \"o-1234567890\"}'

" + }, + "CreateEventBusRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventBusName", + "documentation":"

The name of the new event bus.

The names of custom event buses can't contain the / character. You can't use the name default for a custom event bus because this name is already used for your account's default event bus.

If this is a partner event bus, the name must exactly match the name of the partner event source that this event bus is matched to. This name will include the / character.

" + }, + "EventSourceName":{ + "shape":"EventSourceName", + "documentation":"

If you're creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

" + } + } + }, + "CreateEventBusResponse":{ + "type":"structure", + "members":{ + "EventBusArn":{ + "shape":"String", + "documentation":"

The ARN of the new event bus.

" + } + } + }, + "CreatePartnerEventSourceRequest":{ + "type":"structure", + "required":[ + "Name", + "Account" + ], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the partner event source. This name must be unique and must be in the format partner_name/event_namespace/event_name . The AWS account that wants to use this partner event source must create a partner event bus with a name that matches the name of the partner event source.

" + }, + "Account":{ + "shape":"AccountId", + "documentation":"

The AWS account ID of the customer who is permitted to create a matching partner event bus for this partner event source.

" + } + } + }, + "CreatePartnerEventSourceResponse":{ + "type":"structure", + "members":{ + "EventSourceArn":{ + "shape":"String", + "documentation":"

The ARN of the partner event source.

" + } + } + }, + "DeactivateEventSourceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the partner event source to deactivate.

" + } + } + }, + "DeleteEventBusRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventBusName", + "documentation":"

The name of the event bus to delete.

" + } + } + }, + "DeletePartnerEventSourceRequest":{ + "type":"structure", + "required":[ + "Name", + "Account" + ], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the event source to delete.

" + }, + "Account":{ + "shape":"AccountId", + "documentation":"

The AWS account ID of the AWS customer that the event source was created for.

" + } + } + }, + "DeleteRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

If this is a managed rule, created by an AWS service on your behalf, you must specify Force as True to delete the rule. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

" + } + } + }, + "DescribeEventBusRequest":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EventBusName", + "documentation":"

The name of the event bus to show details for. If you omit this, the default event bus is displayed.

" + } + } + }, + "DescribeEventBusResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the event bus. Currently, this is always default.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

" + }, + "Policy":{ + "shape":"String", + "documentation":"

The policy that enables the external account to send events to your account.

" + } + } + }, + "DescribeEventSourceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the partner event source to display the details of.

" + } + } + }, + "DescribeEventSourceResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The ARN of the partner event source.

" + }, + "CreatedBy":{ + "shape":"String", + "documentation":"

The name of the SaaS partner that created the event source.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the event source was created.

" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the event source will expire if you don't create a matching event bus.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the partner event source.

" + }, + "State":{ + "shape":"EventSourceState", + "documentation":"

The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.

" + } + } + }, + "DescribePartnerEventSourceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"EventSourceName", + "documentation":"

The name of the event source to display.

" + } + } + }, + "DescribePartnerEventSourceResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The ARN of the event source.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the event source.

" + } + } + }, + "DescribeRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

" + } + } + }, + "DescribeRuleResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "Arn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression: for example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

Specifies whether the rule is enabled or disabled.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

The description of the rule.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + }, + "ManagedBy":{ + "shape":"ManagedBy", + "documentation":"

If this is a managed rule, created by an AWS service on your behalf, this field displays the principal name of the AWS service that created the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule.

" + } + } + }, + "DisableRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

" + } + } + }, + "EcsParameters":{ + "type":"structure", + "required":["TaskDefinitionArn"], + "members":{ + "TaskDefinitionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the task definition to use if the event target is an Amazon ECS task.

" + }, + "TaskCount":{ + "shape":"LimitMin1", + "documentation":"

The number of tasks to create based on TaskDefinition. The default is 1.

" + }, + "LaunchType":{ + "shape":"LaunchType", + "documentation":"

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The FARGATE value is supported only in the Regions where AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.

" + }, + "NetworkConfiguration":{ + "shape":"NetworkConfiguration", + "documentation":"

Use this structure if the ECS task uses the awsvpc network mode. This structure specifies the VPC subnets and security groups associated with the task and whether a public IP address is to be used. This structure is required if LaunchType is FARGATE because the awsvpc mode is required for Fargate tasks.

If you specify NetworkConfiguration when the target ECS task doesn't use the awsvpc network mode, the task fails.

" + }, + "PlatformVersion":{ + "shape":"String", + "documentation":"

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

This structure is used only if LaunchType is FARGATE. For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

" + }, + "Group":{ + "shape":"String", + "documentation":"

Specifies an ECS task group for the task. The maximum length is 255 characters.

" + } + }, + "documentation":"

The custom parameters to be used when the target is an Amazon ECS task.

" + }, + "EnableRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

" + } + } + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "EventBus":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the event bus.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The ARN of the event bus.

" + }, + "Policy":{ + "shape":"String", + "documentation":"

The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus.

" + } + }, + "documentation":"

An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives rules from AWS services. A custom event bus can receive rules from AWS services as well as your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

" + }, + "EventBusList":{ + "type":"list", + "member":{"shape":"EventBus"} + }, + "EventBusName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[/\\.\\-_A-Za-z0-9]+" + }, + "EventId":{"type":"string"}, + "EventPattern":{"type":"string"}, + "EventResource":{"type":"string"}, + "EventResourceList":{ + "type":"list", + "member":{"shape":"EventResource"} + }, + "EventSource":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The ARN of the event source.

" + }, + "CreatedBy":{ + "shape":"String", + "documentation":"

The name of the partner that created the event source.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the event source was created.

" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the event source.

" + }, + "State":{ + "shape":"EventSourceState", + "documentation":"

The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.

" + } + }, + "documentation":"

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

" + }, + "EventSourceList":{ + "type":"list", + "member":{"shape":"EventSource"} + }, + "EventSourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"aws\\.partner(/[\\.\\-_A-Za-z0-9]+){2,}" + }, + "EventSourceNamePrefix":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[/\\.\\-_A-Za-z0-9]+" + }, + "EventSourceState":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "DELETED" + ] + }, + "EventTime":{"type":"timestamp"}, + "InputTransformer":{ + "type":"structure", + "required":["InputTemplate"], + "members":{ + "InputPathsMap":{ + "shape":"TransformerPaths", + "documentation":"

Map of JSON paths to be extracted from the event. You can then insert these in the template in InputTemplate to produce the output to be sent to the target.

InputPathsMap is an array key-value pairs, where each value is a valid JSON path. You can have as many as 10 key-value pairs. You must use JSON dot notation, not bracket notation.

The keys can't start with \"AWS\".

" + }, + "InputTemplate":{ + "shape":"TransformerInput", + "documentation":"

Input template where you specify placeholders that will be filled with the values of the keys from InputPathsMap to customize the data sent to the target. Enclose each InputPathsMaps value in brackets: <value>. The InputTemplate must be valid JSON.

If InputTemplate is a JSON object (surrounded by curly braces), the following restrictions apply:

  • The placeholder can't be used as an object key

  • Object values can't include quote marks

The following example shows the syntax for using InputPathsMap and InputTemplate.

\"InputTransformer\":

{

\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},

\"InputTemplate\": \"<instance> is in state <status>\"

}

To have the InputTemplate include quote marks within a JSON string, escape each quote marks with a slash, as in the following example:

\"InputTransformer\":

{

\"InputPathsMap\": {\"instance\": \"$.detail.instance\",\"status\": \"$.detail.status\"},

\"InputTemplate\": \"<instance> is in state \\\"<status>\\\"\"

}

" + } + }, + "documentation":"

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

" + }, + "InputTransformerPathKey":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[A-Za-z0-9\\_\\-]+" + }, + "Integer":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + }, + "documentation":"

This exception occurs due to unexpected causes.

", + "exception":true, + "fault":true + }, + "InvalidEventPatternException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The event pattern isn't valid.

", + "exception":true + }, + "InvalidStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified state isn't a valid state for an event source.

", + "exception":true + }, + "KinesisParameters":{ + "type":"structure", + "required":["PartitionKeyPath"], + "members":{ + "PartitionKeyPath":{ + "shape":"TargetPartitionKeyPath", + "documentation":"

The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

" + } + }, + "documentation":"

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream so that you can control the shard that the event goes to. If you don't include this parameter, the default is to use the eventId as the partition key.

" + }, + "LaunchType":{ + "type":"string", + "enum":[ + "EC2", + "FARGATE" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You tried to create more resources than is allowed.

", + "exception":true + }, + "LimitMax100":{ + "type":"integer", + "max":100, + "min":1 + }, + "LimitMin1":{ + "type":"integer", + "min":1 + }, + "ListEventBusesRequest":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"EventBusName", + "documentation":"

Specifying this limits the results to only those event buses with names that start with the specified prefix.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to retrieve the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListEventBusesResponse":{ + "type":"structure", + "members":{ + "EventBuses":{ + "shape":"EventBusList", + "documentation":"

This list of event buses.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListEventSourcesRequest":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"EventSourceNamePrefix", + "documentation":"

Specifying this limits the results to only those partner event sources with names that start with the specified prefix.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to retrieve the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListEventSourcesResponse":{ + "type":"structure", + "members":{ + "EventSources":{ + "shape":"EventSourceList", + "documentation":"

The list of event sources.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListPartnerEventSourceAccountsRequest":{ + "type":"structure", + "required":["EventSourceName"], + "members":{ + "EventSourceName":{ + "shape":"EventSourceName", + "documentation":"

The name of the partner event source to display account information about.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

Specifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListPartnerEventSourceAccountsResponse":{ + "type":"structure", + "members":{ + "PartnerEventSourceAccounts":{ + "shape":"PartnerEventSourceAccountList", + "documentation":"

The list of partner event sources returned by the operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListPartnerEventSourcesRequest":{ + "type":"structure", + "required":["NamePrefix"], + "members":{ + "NamePrefix":{ + "shape":"PartnerEventSourceNamePrefix", + "documentation":"

If you specify this, the results are limited to only those partner event sources that start with the string you specify.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to this operation. Specifying this retrieves the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

pecifying this limits the number of results returned by this operation. The operation also returns a NextToken that you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListPartnerEventSourcesResponse":{ + "type":"structure", + "members":{ + "PartnerEventSources":{ + "shape":"PartnerEventSourceList", + "documentation":"

The list of partner event sources returned by the operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token you can use in a subsequent operation to retrieve the next set of results.

" + } + } + }, + "ListRuleNamesByTargetRequest":{ + "type":"structure", + "required":["TargetArn"], + "members":{ + "TargetArn":{ + "shape":"TargetArn", + "documentation":"

The Amazon Resource Name (ARN) of the target resource.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

Limits the results to show only the rules associated with the specified event bus.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to retrieve the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + } + }, + "ListRuleNamesByTargetResponse":{ + "type":"structure", + "members":{ + "RuleNames":{ + "shape":"RuleNameList", + "documentation":"

The names of the rules that can invoke the given target.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" + } + } + }, + "ListRulesRequest":{ + "type":"structure", + "members":{ + "NamePrefix":{ + "shape":"RuleName", + "documentation":"

The prefix matching the rule name.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

Limits the results to show only the rules associated with the specified event bus.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to retrieve the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + } + }, + "ListRulesResponse":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"RuleResponseList", + "documentation":"

The rules that match the specified criteria.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"

The ARN of the rule for which you want to view tags.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The list of tag keys and values associated with the rule that you specified.

" + } + } + }, + "ListTargetsByRuleRequest":{ + "type":"structure", + "required":["Rule"], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token returned by a previous call to retrieve the next set of results.

" + }, + "Limit":{ + "shape":"LimitMax100", + "documentation":"

The maximum number of results to return.

" + } + } + }, + "ListTargetsByRuleResponse":{ + "type":"structure", + "members":{ + "Targets":{ + "shape":"TargetList", + "documentation":"

The targets assigned to the rule.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" + } + } + }, + "ManagedBy":{ + "type":"string", + "max":128, + "min":1 + }, + "ManagedRuleException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An AWS service created this rule on behalf of your account. That service manages it. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You can't modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

", + "exception":true + }, + "MessageGroupId":{"type":"string"}, + "NetworkConfiguration":{ + "type":"structure", + "members":{ + "awsvpcConfiguration":{ + "shape":"AwsVpcConfiguration", + "documentation":"

Use this structure to specify the VPC subnets and security groups for the task and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

" + } + }, + "documentation":"

This structure specifies the network configuration for an ECS task.

" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "NonPartnerEventBusName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "PartnerEventSource":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The ARN of the partner event source.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the partner event source.

" + } + }, + "documentation":"

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that AWS account can receive events from the partner's applications or services.

" + }, + "PartnerEventSourceAccount":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"AccountId", + "documentation":"

The AWS account ID that the partner event source was offered to.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the event source was created.

" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the event source will expire if the AWS account doesn't create a matching event bus for it.

" + }, + "State":{ + "shape":"EventSourceState", + "documentation":"

The state of the event source. If it's ACTIVE, you have already created a matching event bus for this event source, and that event bus is active. If it's PENDING, either you haven't yet created a matching event bus, or that event bus is deactivated. If it's DELETED, you have created a matching event bus, but the event source has since been deleted.

" + } + }, + "documentation":"

The AWS account that a partner event source has been offered to.

" + }, + "PartnerEventSourceAccountList":{ + "type":"list", + "member":{"shape":"PartnerEventSourceAccount"} + }, + "PartnerEventSourceList":{ + "type":"list", + "member":{"shape":"PartnerEventSource"} + }, + "PartnerEventSourceNamePrefix":{ + "type":"string", + "max":256, + "min":1, + "pattern":"aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*" + }, + "PolicyLengthExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The event bus policy is too long. For more information, see the limits.

", + "exception":true + }, + "Principal":{ + "type":"string", + "max":12, + "min":1, + "pattern":"(\\d{12}|\\*)" + }, + "PutEventsRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{ + "shape":"PutEventsRequestEntryList", + "documentation":"

The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.

" + } + } + }, + "PutEventsRequestEntry":{ + "type":"structure", + "members":{ + "Time":{ + "shape":"EventTime", + "documentation":"

The timestamp of the event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call is used.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The source of the event. This field is required.

" + }, + "Resources":{ + "shape":"EventResourceList", + "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including zero, can be present.

" + }, + "DetailType":{ + "shape":"String", + "documentation":"

Free-form string used to decide which fields to expect in the event detail. This field is required.

" + }, + "Detail":{ + "shape":"String", + "documentation":"

A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects.

This field is required.

" + }, + "EventBusName":{ + "shape":"NonPartnerEventBusName", + "documentation":"

The event bus that will receive the event. Only the rules that are associated with this event bus can match the event.

" + } + }, + "documentation":"

Represents an event to be submitted.

" + }, + "PutEventsRequestEntryList":{ + "type":"list", + "member":{"shape":"PutEventsRequestEntry"}, + "max":10, + "min":1 + }, + "PutEventsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "Entries":{ + "shape":"PutEventsResultEntryList", + "documentation":"

The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

" + } + } + }, + "PutEventsResultEntry":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"EventId", + "documentation":"

The ID of the event.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code that indicates why the event submission failed.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message that explains why the event submission failed.

" + } + }, + "documentation":"

Represents an event that failed to be submitted.

" + }, + "PutEventsResultEntryList":{ + "type":"list", + "member":{"shape":"PutEventsResultEntry"} + }, + "PutPartnerEventsRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{ + "shape":"PutPartnerEventsRequestEntryList", + "documentation":"

The list of events to write to the event bus.

" + } + } + }, + "PutPartnerEventsRequestEntry":{ + "type":"structure", + "members":{ + "Time":{ + "shape":"EventTime", + "documentation":"

The date and time of the event.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The event source that is generating the evntry. This field is required.

" + }, + "Resources":{ + "shape":"EventResourceList", + "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), that the event primarily concerns. Any number, including zero, can be present.

" + }, + "DetailType":{ + "shape":"String", + "documentation":"

A free-form string used to decide which fields to expect in the event detail. This field is required.

" + }, + "Detail":{ + "shape":"String", + "documentation":"

A valid JSON object. There is no other schema imposed. The JSON object can contain fields and nested subobjects. This field is required.

" + } + }, + "documentation":"

The details about an event generated by an SaaS partner.

" + }, + "PutPartnerEventsRequestEntryList":{ + "type":"list", + "member":{"shape":"PutPartnerEventsRequestEntry"}, + "max":20, + "min":1 + }, + "PutPartnerEventsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of events from this operation that couldn't be written to the partner event bus.

" + }, + "Entries":{ + "shape":"PutPartnerEventsResultEntryList", + "documentation":"

The list of events from this operation that were successfully written to the partner event bus.

" + } + } + }, + "PutPartnerEventsResultEntry":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"EventId", + "documentation":"

The ID of the event.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code that indicates why the event submission failed.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message that explains why the event submission failed.

" + } + }, + "documentation":"

Represents an event that a partner tried to generate but failed.

" + }, + "PutPartnerEventsResultEntryList":{ + "type":"list", + "member":{"shape":"PutPartnerEventsResultEntry"} + }, + "PutPermissionRequest":{ + "type":"structure", + "required":[ + "Action", + "Principal", + "StatementId" + ], + "members":{ + "EventBusName":{ + "shape":"NonPartnerEventBusName", + "documentation":"

The event bus associated with the rule. If you omit this, the default event bus is used.

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

The action that you're enabling the other account to perform. Currently, this must be events:PutEvents.

" + }, + "Principal":{ + "shape":"Principal", + "documentation":"

The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify \"*\" to permit any account to put events to your default event bus.

If you specify \"*\" without specifying Condition, avoid creating rules that might match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID to receive events from. Rules that have an account field match events sent only from accounts that are listed in the rule's account field.

" + }, + "StatementId":{ + "shape":"StatementId", + "documentation":"

An identifier string for the external account that you're granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.

" + }, + "Condition":{ + "shape":"Condition", + "documentation":"

This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain AWS organization. For more information about AWS Organizations, see What Is AWS Organizations? in the AWS Organizations User Guide.

If you specify Condition with an AWS organization ID and specify \"*\" as the value for Principal, you grant permission to all the accounts in the named organization.

The Condition is a JSON string that must contain Type, Key, and Value fields.

" + } + } + }, + "PutRuleRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule that you're creating or updating.

A rule can't have the same name as another rule in the same Region or on the same event bus.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression: for example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

Indicates whether the rule is enabled or disabled.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

A description of the rule.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The list of key-value pairs to associate with the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus to associate with this rule. If you omit this, the default event bus is used.

" + } + } + }, + "PutRuleResponse":{ + "type":"structure", + "members":{ + "RuleArn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + } + } + }, + "PutTargetsRequest":{ + "type":"structure", + "required":[ + "Rule", + "Targets" + ], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The name of the event bus associated with the rule. If you omit this, the default event bus is used.

" + }, + "Targets":{ + "shape":"TargetList", + "documentation":"

The targets to update or add to the rule.

" + } + } + }, + "PutTargetsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "FailedEntries":{ + "shape":"PutTargetsResultEntryList", + "documentation":"

The failed target entries.

" + } + } + }, + "PutTargetsResultEntry":{ + "type":"structure", + "members":{ + "TargetId":{ + "shape":"TargetId", + "documentation":"

The ID of the target.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message that explains why the target addition failed.

" + } + }, + "documentation":"

Represents a target that failed to be added to a rule.

" + }, + "PutTargetsResultEntryList":{ + "type":"list", + "member":{"shape":"PutTargetsResultEntry"} + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":["StatementId"], + "members":{ + "StatementId":{ + "shape":"StatementId", + "documentation":"

The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

" + }, + "EventBusName":{ + "shape":"NonPartnerEventBusName", + "documentation":"

The name of the event bus to revoke permissions for. If you omit this, the default event bus is used.

" + } + } + }, + "RemoveTargetsRequest":{ + "type":"structure", + "required":[ + "Rule", + "Ids" + ], + "members":{ + "Rule":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The name of the event bus associated with the rule.

" + }, + "Ids":{ + "shape":"TargetIdList", + "documentation":"

The IDs of the targets to remove from the rule.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

If this is a managed rule created by an AWS service on your behalf, you must specify Force as True to remove targets. This parameter is ignored for rules that aren't managed rules. You can check whether a rule is a managed rule by using DescribeRule or ListRules and checking the ManagedBy field of the response.

" + } + } + }, + "RemoveTargetsResponse":{ + "type":"structure", + "members":{ + "FailedEntryCount":{ + "shape":"Integer", + "documentation":"

The number of failed entries.

" + }, + "FailedEntries":{ + "shape":"RemoveTargetsResultEntryList", + "documentation":"

The failed target entries.

" + } + } + }, + "RemoveTargetsResultEntry":{ + "type":"structure", + "members":{ + "TargetId":{ + "shape":"TargetId", + "documentation":"

The ID of the target.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message that explains why the target removal failed.

" + } + }, + "documentation":"

Represents a target that failed to be removed from a rule.

" + }, + "RemoveTargetsResultEntryList":{ + "type":"list", + "member":{"shape":"RemoveTargetsResultEntry"} + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource that you're trying to create already exists.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

An entity that you specified doesn't exist.

", + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "Rule":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "Arn":{ + "shape":"RuleArn", + "documentation":"

The Amazon Resource Name (ARN) of the rule.

" + }, + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern of the rule. For more information, see Event Patterns in the Amazon EventBridge User Guide.

" + }, + "State":{ + "shape":"RuleState", + "documentation":"

The state of the rule.

" + }, + "Description":{ + "shape":"RuleDescription", + "documentation":"

The description of the rule.

" + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

The scheduling expression: for example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the role that is used for target invocation.

" + }, + "ManagedBy":{ + "shape":"ManagedBy", + "documentation":"

If an AWS service created the rule on behalf of your account, this field displays the principal name of the service that created the rule.

" + }, + "EventBusName":{ + "shape":"EventBusName", + "documentation":"

The event bus associated with the rule.

" + } + }, + "documentation":"

Contains information about a rule in Amazon EventBridge.

" + }, + "RuleArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "RuleDescription":{ + "type":"string", + "max":512 + }, + "RuleName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "RuleNameList":{ + "type":"list", + "member":{"shape":"RuleName"} + }, + "RuleResponseList":{ + "type":"list", + "member":{"shape":"Rule"} + }, + "RuleState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "RunCommandParameters":{ + "type":"structure", + "required":["RunCommandTargets"], + "members":{ + "RunCommandTargets":{ + "shape":"RunCommandTargets", + "documentation":"

Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

" + } + }, + "documentation":"

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

" + }, + "RunCommandTarget":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"RunCommandTargetKey", + "documentation":"

Can be either tag: tag-key or InstanceIds.

" + }, + "Values":{ + "shape":"RunCommandTargetValues", + "documentation":"

If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.

" + } + }, + "documentation":"

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key can specify multiple values.

" + }, + "RunCommandTargetKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" + }, + "RunCommandTargetValue":{ + "type":"string", + "max":256, + "min":1 + }, + "RunCommandTargetValues":{ + "type":"list", + "member":{"shape":"RunCommandTargetValue"}, + "max":50, + "min":1 + }, + "RunCommandTargets":{ + "type":"list", + "member":{"shape":"RunCommandTarget"}, + "max":5, + "min":1 + }, + "ScheduleExpression":{ + "type":"string", + "max":256 + }, + "SqsParameters":{ + "type":"structure", + "members":{ + "MessageGroupId":{ + "shape":"MessageGroupId", + "documentation":"

The FIFO message group ID to use as the target.

" + } + }, + "documentation":"

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

" + }, + "StatementId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9-_]+" + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A string that you can use to assign a value. The combination of tag keys and values can help you organize and categorize your resources.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value for the specified tag key.

" + } + }, + "documentation":"

A key-value pair associated with an AWS resource. In EventBridge, rules support tagging.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"

The ARN of the rule that you're adding tags to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The list of key-value pairs to associate with the rule.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Target":{ + "type":"structure", + "required":[ + "Id", + "Arn" + ], + "members":{ + "Id":{ + "shape":"TargetId", + "documentation":"

A name for the target. Use a string that will help you identify the target. Each target associated with a rule must have an Id unique for that rule.

" + }, + "Arn":{ + "shape":"TargetArn", + "documentation":"

The Amazon Resource Name (ARN) of the target.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.

" + }, + "Input":{ + "shape":"TargetInput", + "documentation":"

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

" + }, + "InputPath":{ + "shape":"TargetInputPath", + "documentation":"

The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.

" + }, + "InputTransformer":{ + "shape":"InputTransformer", + "documentation":"

Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.

" + }, + "KinesisParameters":{ + "shape":"KinesisParameters", + "documentation":"

The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.

" + }, + "RunCommandParameters":{ + "shape":"RunCommandParameters", + "documentation":"

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

" + }, + "EcsParameters":{ + "shape":"EcsParameters", + "documentation":"

Contains the Amazon ECS task definition and task count to be used if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.

" + }, + "BatchParameters":{ + "shape":"BatchParameters", + "documentation":"

If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

" + }, + "SqsParameters":{ + "shape":"SqsParameters", + "documentation":"

Contains the message group ID to use when the target is a FIFO queue.

If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

" + } + }, + "documentation":"

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you're setting the event bus of another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

" + }, + "TargetArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "TargetId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\.\\-_A-Za-z0-9]+" + }, + "TargetIdList":{ + "type":"list", + "member":{"shape":"TargetId"}, + "max":100, + "min":1 + }, + "TargetInput":{ + "type":"string", + "max":8192 + }, + "TargetInputPath":{ + "type":"string", + "max":256 + }, + "TargetList":{ + "type":"list", + "member":{"shape":"Target"}, + "max":100, + "min":1 + }, + "TargetPartitionKeyPath":{ + "type":"string", + "max":256 + }, + "TestEventPatternRequest":{ + "type":"structure", + "required":[ + "EventPattern", + "Event" + ], + "members":{ + "EventPattern":{ + "shape":"EventPattern", + "documentation":"

The event pattern. For more information, see Event Patterns in the Amazon EventBridge User Guide.

" + }, + "Event":{ + "shape":"String", + "documentation":"

The event, in JSON format, to test against the event pattern.

" + } + } + }, + "TestEventPatternResponse":{ + "type":"structure", + "members":{ + "Result":{ + "shape":"Boolean", + "documentation":"

Indicates whether the event matches the event pattern.

" + } + } + }, + "Timestamp":{"type":"timestamp"}, + "TransformerInput":{ + "type":"string", + "max":8192, + "min":1 + }, + "TransformerPaths":{ + "type":"map", + "key":{"shape":"InputTransformerPathKey"}, + "value":{"shape":"TargetInputPath"}, + "max":10 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"Arn", + "documentation":"

The ARN of the rule that you're removing tags from.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The list of tag keys to remove from the resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"

Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state

  • Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks

  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

" +} diff --git a/aws/dist/botocore/data/firehose/2015-08-04/examples-1.json b/aws/dist/botocore/data/firehose/2015-08-04/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/firehose/2015-08-04/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/firehose/2015-08-04/paginators-1.json b/aws/dist/botocore/data/firehose/2015-08-04/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/firehose/2015-08-04/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/firehose/2015-08-04/service-2.json b/aws/dist/botocore/data/firehose/2015-08-04/service-2.json new file mode 100644 index 00000000..7b7e3720 --- /dev/null +++ b/aws/dist/botocore/data/firehose/2015-08-04/service-2.json @@ -0,0 +1,2332 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-08-04", + "endpointPrefix":"firehose", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Firehose", + "serviceFullName":"Amazon Kinesis Firehose", + "serviceId":"Firehose", + "signatureVersion":"v4", + "targetPrefix":"Firehose_20150804", + "uid":"firehose-2015-08-04" + }, + "operations":{ + "CreateDeliveryStream":{ + "name":"CreateDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeliveryStreamInput"}, + "output":{"shape":"CreateDeliveryStreamOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates a Kinesis Data Firehose delivery stream.

By default, you can create up to 50 delivery streams per AWS Region.

This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream.

A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter.

A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration.

When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3.

A few notes about Amazon Redshift as a destination:

  • An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter.

  • The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

  • We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions.

Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.

" + }, + "DeleteDeliveryStream":{ + "name":"DeleteDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDeliveryStreamInput"}, + "output":{"shape":"DeleteDeliveryStreamOutput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a delivery stream and its data.

You can delete a delivery stream only if it is in ACTIVE or DELETING state, and not in the CREATING state. While the deletion request is in process, the delivery stream is in the DELETING state.

To check the state of a delivery stream, use DescribeDeliveryStream.

While the delivery stream is DELETING state, the service might continue to accept the records, but it doesn't make any guarantees with respect to delivering the data. Therefore, as a best practice, you should first stop any applications that are sending records before deleting a delivery stream.

" + }, + "DescribeDeliveryStream":{ + "name":"DescribeDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeliveryStreamInput"}, + "output":{"shape":"DescribeDeliveryStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the specified delivery stream and gets the status. For example, after your delivery stream is created, call DescribeDeliveryStream to see whether the delivery stream is ACTIVE and therefore ready for data to be sent to it.

" + }, + "ListDeliveryStreams":{ + "name":"ListDeliveryStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeliveryStreamsInput"}, + "output":{"shape":"ListDeliveryStreamsOutput"}, + "documentation":"

Lists your delivery streams in alphabetical order of their names.

The number of delivery streams might be too large to return using a single call to ListDeliveryStreams. You can limit the number of delivery streams returned, using the Limit parameter. To determine whether there are more delivery streams to list, check the value of HasMoreDeliveryStreams in the output. If there are more delivery streams to list, you can request them by calling this operation again and setting the ExclusiveStartDeliveryStreamName parameter to the name of the last delivery stream returned in the last call.

" + }, + "ListTagsForDeliveryStream":{ + "name":"ListTagsForDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForDeliveryStreamInput"}, + "output":{"shape":"ListTagsForDeliveryStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Lists the tags for the specified delivery stream. This operation has a limit of five transactions per second per account.

" + }, + "PutRecord":{ + "name":"PutRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordInput"}, + "output":{"shape":"PutRecordOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Writes a single data record into an Amazon Kinesis Data Firehose delivery stream. To write multiple data records into a delivery stream, use PutRecordBatch. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it can be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecord operation returns a RecordId, which is a unique string assigned to each record. Producer applications can use this ID for purposes such as auditability and investigation.

If the PutRecord operation throws a ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it tries to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

" + }, + "PutRecordBatch":{ + "name":"PutRecordBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordBatchInput"}, + "output":{"shape":"PutRecordBatchOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Writes multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records. To write single data records into a delivery stream, use PutRecord. Applications using these operations are referred to as producers.

By default, each delivery stream can take in up to 2,000 transactions per second, 5,000 records per second, or 5 MB per second. If you use PutRecord and PutRecordBatch, the limits are an aggregate across these two operations for each delivery stream. For more information about limits, see Amazon Kinesis Data Firehose Limits.

Each PutRecordBatch request supports up to 500 records. Each record in the request can be as large as 1,000 KB (before 64-bit encoding), up to a limit of 4 MB for the entire request. These limits cannot be changed.

You must specify the name of the delivery stream and the data record when using PutRecord. The data record consists of a data blob that can be up to 1,000 KB in size, and any kind of data. For example, it could be a segment from a log file, geographic location data, website clickstream data, and so on.

Kinesis Data Firehose buffers records before delivering them to the destination. To disambiguate the data blobs at the destination, a common solution is to use delimiters in the data, such as a newline (\\n) or some other character unique within the data. This allows the consumer application to parse individual data items when reading the data from the destination.

The PutRecordBatch response includes a count of failed records, FailedPutCount, and an array of responses, RequestResponses. Even if the PutRecordBatch call succeeds, the value of FailedPutCount may be greater than 0, indicating that there are records for which the operation didn't succeed. Each entry in the RequestResponses array provides additional information about the processed record. It directly correlates with a record in the request array using the same ordering, from the top to the bottom. The response array always includes the same number of records as the request array. RequestResponses includes both successfully and unsuccessfully processed records. Kinesis Data Firehose tries to process all records in each PutRecordBatch request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes a RecordId value, which is unique for the record. An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error, and is one of the following values: ServiceUnavailableException or InternalFailure. ErrorMessage provides more detailed information about the error.

If there is an internal server error or a timeout, the write might have completed or it might have failed. If FailedPutCount is greater than 0, retry the request, resending only those records that might have failed processing. This minimizes the possible duplicate records and also reduces the total bytes sent (and corresponding charges). We recommend that you handle any duplicates at the destination.

If PutRecordBatch throws ServiceUnavailableException, back off and retry. If the exception persists, it is possible that the throughput limits have been exceeded for the delivery stream.

Data records sent to Kinesis Data Firehose are stored for 24 hours from the time they are added to a delivery stream as it attempts to send the records to the destination. If the destination is unreachable for more than 24 hours, the data is no longer available.

Don't concatenate two or more base64 strings to form the data fields of your records. Instead, concatenate the raw data, then perform base64 encoding.

" + }, + "StartDeliveryStreamEncryption":{ + "name":"StartDeliveryStreamEncryption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDeliveryStreamEncryptionInput"}, + "output":{"shape":"StartDeliveryStreamEncryptionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Enables server-side encryption (SSE) for the delivery stream.

This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to ENABLING, and then to ENABLED. You can continue to read and write data to your stream while its status is ENABLING, but the data is not encrypted. It can take up to 5 seconds after the encryption status changes to ENABLED before all records written to the delivery stream are encrypted. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.

To check the encryption state of a delivery stream, use DescribeDeliveryStream.

You can only enable SSE for a delivery stream that uses DirectPut as its source.

The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.

" + }, + "StopDeliveryStreamEncryption":{ + "name":"StopDeliveryStreamEncryption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDeliveryStreamEncryptionInput"}, + "output":{"shape":"StopDeliveryStreamEncryptionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Disables server-side encryption (SSE) for the delivery stream.

This operation is asynchronous. It returns immediately. When you invoke it, Kinesis Data Firehose first sets the status of the stream to DISABLING, and then to DISABLED. You can continue to read and write data to your stream while its status is DISABLING. It can take up to 5 seconds after the encryption status changes to DISABLED before all records written to the delivery stream are no longer subject to encryption. To find out whether a record or a batch of records was encrypted, check the response elements PutRecordOutput$Encrypted and PutRecordBatchOutput$Encrypted, respectively.

To check the encryption state of a delivery stream, use DescribeDeliveryStream.

The StartDeliveryStreamEncryption and StopDeliveryStreamEncryption operations have a combined limit of 25 calls per delivery stream per 24 hours. For example, you reach the limit if you call StartDeliveryStreamEncryption 13 times and StopDeliveryStreamEncryption 12 times for the same delivery stream in a 24-hour period.

" + }, + "TagDeliveryStream":{ + "name":"TagDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagDeliveryStreamInput"}, + "output":{"shape":"TagDeliveryStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

Each delivery stream can have up to 50 tags.

This operation has a limit of five transactions per second per account.

" + }, + "UntagDeliveryStream":{ + "name":"UntagDeliveryStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagDeliveryStreamInput"}, + "output":{"shape":"UntagDeliveryStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Removes tags from the specified delivery stream. Removed tags are deleted, and you can't recover them after this operation successfully completes.

If you specify a tag that doesn't exist, the operation ignores it.

This operation has a limit of five transactions per second per account.

" + }, + "UpdateDestination":{ + "name":"UpdateDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDestinationInput"}, + "output":{"shape":"UpdateDestinationOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates the specified destination of the specified delivery stream.

Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.

Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.

If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing EncryptionConfiguration is maintained on the destination.

If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.

Kinesis Data Firehose uses CurrentDeliveryStreamVersionId to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId in the next call.

" + } + }, + "shapes":{ + "AWSKMSKeyARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "BlockSizeBytes":{ + "type":"integer", + "min":67108864 + }, + "BooleanObject":{"type":"boolean"}, + "BucketARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "BufferingHints":{ + "type":"structure", + "members":{ + "SizeInMBs":{ + "shape":"SizeInMBs", + "documentation":"

Buffer incoming data to the specified size, in MiBs, before delivering it to the destination. The default value is 5. This parameter is optional but if you specify a value for it, you must also specify a value for IntervalInSeconds, and vice versa.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MiB/sec, the value should be 10 MiB or higher.

" + }, + "IntervalInSeconds":{ + "shape":"IntervalInSeconds", + "documentation":"

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300. This parameter is optional but if you specify a value for it, you must also specify a value for SizeInMBs, and vice versa.

" + } + }, + "documentation":"

Describes hints for the buffering to perform before delivering data to the destination. These options are treated as hints, and therefore Kinesis Data Firehose might choose to use different values when it is optimal. The SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value for one of them, you must also provide a value for the other.

" + }, + "CloudWatchLoggingOptions":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables CloudWatch logging.

" + }, + "LogGroupName":{ + "shape":"LogGroupName", + "documentation":"

The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.

" + }, + "LogStreamName":{ + "shape":"LogStreamName", + "documentation":"

The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.

" + } + }, + "documentation":"

Describes the Amazon CloudWatch logging options for your delivery stream.

" + }, + "ClusterJDBCURL":{ + "type":"string", + "min":1, + "pattern":"jdbc:(redshift|postgresql)://((?!-)[A-Za-z0-9-]{1,63}(?A message that provides information about the error.

" + } + }, + "documentation":"

Another modification has already happened. Fetch VersionId again and use it to update the destination.

", + "exception":true + }, + "CopyCommand":{ + "type":"structure", + "required":["DataTableName"], + "members":{ + "DataTableName":{ + "shape":"DataTableName", + "documentation":"

The name of the target table. The table must already exist in the database.

" + }, + "DataTableColumns":{ + "shape":"DataTableColumns", + "documentation":"

A comma-separated list of column names.

" + }, + "CopyOptions":{ + "shape":"CopyOptions", + "documentation":"

Optional parameters to use with the Amazon Redshift COPY command. For more information, see the \"Optional Parameters\" section of Amazon Redshift COPY command. Some possible examples that would apply to Kinesis Data Firehose are as follows:

delimiter '\\t' lzop; - fields are delimited with \"\\t\" (TAB character) and compressed using lzop.

delimiter '|' - fields are delimited with \"|\" (this is the default delimiter).

delimiter '|' escape - the delimiter should be escaped.

fixedwidth 'venueid:3,venuename:25,venuecity:12,venuestate:2,venueseats:6' - fields are fixed width in the source, with each width specified after every column in the table.

JSON 's3://mybucket/jsonpaths.txt' - data is in JSON format, and the path specified is the format of the data.

For more examples, see Amazon Redshift COPY command examples.

" + } + }, + "documentation":"

Describes a COPY command for Amazon Redshift.

" + }, + "CopyOptions":{"type":"string"}, + "CreateDeliveryStreamInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream. This name must be unique per AWS account in the same AWS Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.

" + }, + "DeliveryStreamType":{ + "shape":"DeliveryStreamType", + "documentation":"

The delivery stream type. This parameter can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

" + }, + "KinesisStreamSourceConfiguration":{ + "shape":"KinesisStreamSourceConfiguration", + "documentation":"

When a Kinesis data stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis data stream Amazon Resource Name (ARN) and the role ARN for the source stream.

" + }, + "S3DestinationConfiguration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

[Deprecated] The destination in Amazon S3. You can specify only one destination.

", + "deprecated":true + }, + "ExtendedS3DestinationConfiguration":{ + "shape":"ExtendedS3DestinationConfiguration", + "documentation":"

The destination in Amazon S3. You can specify only one destination.

" + }, + "RedshiftDestinationConfiguration":{ + "shape":"RedshiftDestinationConfiguration", + "documentation":"

The destination in Amazon Redshift. You can specify only one destination.

" + }, + "ElasticsearchDestinationConfiguration":{ + "shape":"ElasticsearchDestinationConfiguration", + "documentation":"

The destination in Amazon ES. You can specify only one destination.

" + }, + "SplunkDestinationConfiguration":{ + "shape":"SplunkDestinationConfiguration", + "documentation":"

The destination in Splunk. You can specify only one destination.

" + }, + "Tags":{ + "shape":"TagDeliveryStreamInputTagList", + "documentation":"

A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You can specify up to 50 tags when creating a delivery stream.

" + } + } + }, + "CreateDeliveryStreamOutput":{ + "type":"structure", + "members":{ + "DeliveryStreamARN":{ + "shape":"DeliveryStreamARN", + "documentation":"

The ARN of the delivery stream.

" + } + } + }, + "Data":{ + "type":"blob", + "max":1024000, + "min":0 + }, + "DataFormatConversionConfiguration":{ + "type":"structure", + "members":{ + "SchemaConfiguration":{ + "shape":"SchemaConfiguration", + "documentation":"

Specifies the AWS Glue Data Catalog table that contains the column information.

" + }, + "InputFormatConfiguration":{ + "shape":"InputFormatConfiguration", + "documentation":"

Specifies the deserializer that you want Kinesis Data Firehose to use to convert the format of your data from JSON.

" + }, + "OutputFormatConfiguration":{ + "shape":"OutputFormatConfiguration", + "documentation":"

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data to the Parquet or ORC format.

" + }, + "Enabled":{ + "shape":"BooleanObject", + "documentation":"

Defaults to true. Set it to false if you want to disable format conversion while preserving the configuration details.

" + } + }, + "documentation":"

Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3. Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see Kinesis Data Firehose Record Format Conversion.

" + }, + "DataTableColumns":{"type":"string"}, + "DataTableName":{ + "type":"string", + "min":1 + }, + "DeleteDeliveryStreamInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + } + } + }, + "DeleteDeliveryStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "DeliveryStartTimestamp":{"type":"timestamp"}, + "DeliveryStreamARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "DeliveryStreamDescription":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "DeliveryStreamARN", + "DeliveryStreamStatus", + "DeliveryStreamType", + "VersionId", + "Destinations", + "HasMoreDestinations" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "DeliveryStreamARN":{ + "shape":"DeliveryStreamARN", + "documentation":"

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "DeliveryStreamStatus":{ + "shape":"DeliveryStreamStatus", + "documentation":"

The status of the delivery stream.

" + }, + "DeliveryStreamEncryptionConfiguration":{ + "shape":"DeliveryStreamEncryptionConfiguration", + "documentation":"

Indicates the server-side encryption (SSE) status for the delivery stream.

" + }, + "DeliveryStreamType":{ + "shape":"DeliveryStreamType", + "documentation":"

The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

" + }, + "VersionId":{ + "shape":"DeliveryStreamVersionId", + "documentation":"

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the delivery stream was created.

" + }, + "LastUpdateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the delivery stream was last updated.

" + }, + "Source":{ + "shape":"SourceDescription", + "documentation":"

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

" + }, + "Destinations":{ + "shape":"DestinationDescriptionList", + "documentation":"

The destinations.

" + }, + "HasMoreDestinations":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether there are more destinations available to list.

" + } + }, + "documentation":"

Contains information about a delivery stream.

" + }, + "DeliveryStreamEncryptionConfiguration":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"DeliveryStreamEncryptionStatus", + "documentation":"

For a full description of the different values of this status, see StartDeliveryStreamEncryption and StopDeliveryStreamEncryption.

" + } + }, + "documentation":"

Indicates the server-side encryption (SSE) status for the delivery stream.

" + }, + "DeliveryStreamEncryptionStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "ENABLING", + "DISABLED", + "DISABLING" + ] + }, + "DeliveryStreamName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "DeliveryStreamNameList":{ + "type":"list", + "member":{"shape":"DeliveryStreamName"} + }, + "DeliveryStreamStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE" + ] + }, + "DeliveryStreamType":{ + "type":"string", + "enum":[ + "DirectPut", + "KinesisStreamAsSource" + ] + }, + "DeliveryStreamVersionId":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[0-9]+" + }, + "DescribeDeliveryStreamInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "Limit":{ + "shape":"DescribeDeliveryStreamInputLimit", + "documentation":"

The limit on the number of destinations to return. You can have one destination per delivery stream.

" + }, + "ExclusiveStartDestinationId":{ + "shape":"DestinationId", + "documentation":"

The ID of the destination to start returning the destination information. Kinesis Data Firehose supports one destination per delivery stream.

" + } + } + }, + "DescribeDeliveryStreamInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "DescribeDeliveryStreamOutput":{ + "type":"structure", + "required":["DeliveryStreamDescription"], + "members":{ + "DeliveryStreamDescription":{ + "shape":"DeliveryStreamDescription", + "documentation":"

Information about the delivery stream.

" + } + } + }, + "Deserializer":{ + "type":"structure", + "members":{ + "OpenXJsonSerDe":{ + "shape":"OpenXJsonSerDe", + "documentation":"

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

" + }, + "HiveJsonSerDe":{ + "shape":"HiveJsonSerDe", + "documentation":"

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

" + } + }, + "documentation":"

The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON. Kinesis Data Firehose then serializes the data to its final format using the Serializer. Kinesis Data Firehose supports two types of deserializers: the Apache Hive JSON SerDe and the OpenX JSON SerDe.

" + }, + "DestinationDescription":{ + "type":"structure", + "required":["DestinationId"], + "members":{ + "DestinationId":{ + "shape":"DestinationId", + "documentation":"

The ID of the destination.

" + }, + "S3DestinationDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

[Deprecated] The destination in Amazon S3.

" + }, + "ExtendedS3DestinationDescription":{ + "shape":"ExtendedS3DestinationDescription", + "documentation":"

The destination in Amazon S3.

" + }, + "RedshiftDestinationDescription":{ + "shape":"RedshiftDestinationDescription", + "documentation":"

The destination in Amazon Redshift.

" + }, + "ElasticsearchDestinationDescription":{ + "shape":"ElasticsearchDestinationDescription", + "documentation":"

The destination in Amazon ES.

" + }, + "SplunkDestinationDescription":{ + "shape":"SplunkDestinationDescription", + "documentation":"

The destination in Splunk.

" + } + }, + "documentation":"

Describes the destination for a delivery stream.

" + }, + "DestinationDescriptionList":{ + "type":"list", + "member":{"shape":"DestinationDescription"} + }, + "DestinationId":{ + "type":"string", + "max":100, + "min":1 + }, + "ElasticsearchBufferingHints":{ + "type":"structure", + "members":{ + "IntervalInSeconds":{ + "shape":"ElasticsearchBufferingIntervalInSeconds", + "documentation":"

Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).

" + }, + "SizeInMBs":{ + "shape":"ElasticsearchBufferingSizeInMBs", + "documentation":"

Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.

We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.

" + } + }, + "documentation":"

Describes the buffering to perform before delivering data to the Amazon ES destination.

" + }, + "ElasticsearchBufferingIntervalInSeconds":{ + "type":"integer", + "max":900, + "min":60 + }, + "ElasticsearchBufferingSizeInMBs":{ + "type":"integer", + "max":100, + "min":1 + }, + "ElasticsearchClusterEndpoint":{ + "type":"string", + "max":512, + "min":1, + "pattern":"https:.*" + }, + "ElasticsearchDestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "IndexName", + "S3Configuration" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "DomainARN":{ + "shape":"ElasticsearchDomainARN", + "documentation":"

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

" + }, + "ClusterEndpoint":{ + "shape":"ElasticsearchClusterEndpoint", + "documentation":"

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

" + }, + "IndexName":{ + "shape":"ElasticsearchIndexName", + "documentation":"

The Elasticsearch index name.

" + }, + "TypeName":{ + "shape":"ElasticsearchTypeName", + "documentation":"

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.

For Elasticsearch 7.x, don't specify a TypeName.

" + }, + "IndexRotationPeriod":{ + "shape":"ElasticsearchIndexRotationPeriod", + "documentation":"

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. The default value is OneDay.

" + }, + "BufferingHints":{ + "shape":"ElasticsearchBufferingHints", + "documentation":"

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

" + }, + "RetryOptions":{ + "shape":"ElasticsearchRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

" + }, + "S3BackupMode":{ + "shape":"ElasticsearchS3BackupMode", + "documentation":"

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly.

" + }, + "S3Configuration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

The configuration for the backup Amazon S3 location.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes the configuration of a destination in Amazon ES.

" + }, + "ElasticsearchDestinationDescription":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "DomainARN":{ + "shape":"ElasticsearchDomainARN", + "documentation":"

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

" + }, + "ClusterEndpoint":{ + "shape":"ElasticsearchClusterEndpoint", + "documentation":"

The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

" + }, + "IndexName":{ + "shape":"ElasticsearchIndexName", + "documentation":"

The Elasticsearch index name.

" + }, + "TypeName":{ + "shape":"ElasticsearchTypeName", + "documentation":"

The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.

" + }, + "IndexRotationPeriod":{ + "shape":"ElasticsearchIndexRotationPeriod", + "documentation":"

The Elasticsearch index rotation period

" + }, + "BufferingHints":{ + "shape":"ElasticsearchBufferingHints", + "documentation":"

The buffering options.

" + }, + "RetryOptions":{ + "shape":"ElasticsearchRetryOptions", + "documentation":"

The Amazon ES retry options.

" + }, + "S3BackupMode":{ + "shape":"ElasticsearchS3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3DestinationDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

The Amazon S3 destination.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options.

" + } + }, + "documentation":"

The destination description in Amazon ES.

" + }, + "ElasticsearchDestinationUpdate":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "DomainARN":{ + "shape":"ElasticsearchDomainARN", + "documentation":"

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

" + }, + "ClusterEndpoint":{ + "shape":"ElasticsearchClusterEndpoint", + "documentation":"

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

" + }, + "IndexName":{ + "shape":"ElasticsearchIndexName", + "documentation":"

The Elasticsearch index name.

" + }, + "TypeName":{ + "shape":"ElasticsearchTypeName", + "documentation":"

The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

" + }, + "IndexRotationPeriod":{ + "shape":"ElasticsearchIndexRotationPeriod", + "documentation":"

The Elasticsearch index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay.

" + }, + "BufferingHints":{ + "shape":"ElasticsearchBufferingHints", + "documentation":"

The buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

" + }, + "RetryOptions":{ + "shape":"ElasticsearchRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

" + }, + "S3Update":{ + "shape":"S3DestinationUpdate", + "documentation":"

The Amazon S3 destination.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes an update for a destination in Amazon ES.

" + }, + "ElasticsearchDomainARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "ElasticsearchIndexName":{ + "type":"string", + "max":80, + "min":1 + }, + "ElasticsearchIndexRotationPeriod":{ + "type":"string", + "enum":[ + "NoRotation", + "OneHour", + "OneDay", + "OneWeek", + "OneMonth" + ] + }, + "ElasticsearchRetryDurationInSeconds":{ + "type":"integer", + "max":7200, + "min":0 + }, + "ElasticsearchRetryOptions":{ + "type":"structure", + "members":{ + "DurationInSeconds":{ + "shape":"ElasticsearchRetryDurationInSeconds", + "documentation":"

After an initial failure to deliver to Amazon ES, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

" + } + }, + "documentation":"

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES.

" + }, + "ElasticsearchS3BackupMode":{ + "type":"string", + "enum":[ + "FailedDocumentsOnly", + "AllDocuments" + ] + }, + "ElasticsearchTypeName":{ + "type":"string", + "max":100, + "min":0 + }, + "EncryptionConfiguration":{ + "type":"structure", + "members":{ + "NoEncryptionConfig":{ + "shape":"NoEncryptionConfig", + "documentation":"

Specifically override existing encryption information to ensure that no encryption is used.

" + }, + "KMSEncryptionConfig":{ + "shape":"KMSEncryptionConfig", + "documentation":"

The encryption key.

" + } + }, + "documentation":"

Describes the encryption for a destination in Amazon S3.

" + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "ErrorOutputPrefix":{"type":"string"}, + "ExtendedS3DestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "BucketARN" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"S3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3BackupConfiguration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

The configuration for backup in Amazon S3.

" + }, + "DataFormatConversionConfiguration":{ + "shape":"DataFormatConversionConfiguration", + "documentation":"

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

" + } + }, + "documentation":"

Describes the configuration of a destination in Amazon S3.

" + }, + "ExtendedS3DestinationDescription":{ + "type":"structure", + "required":[ + "RoleARN", + "BucketARN", + "BufferingHints", + "CompressionFormat", + "EncryptionConfiguration" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"S3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3BackupDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

The configuration for backup in Amazon S3.

" + }, + "DataFormatConversionConfiguration":{ + "shape":"DataFormatConversionConfiguration", + "documentation":"

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

" + } + }, + "documentation":"

Describes a destination in Amazon S3.

" + }, + "ExtendedS3DestinationUpdate":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"S3BackupMode", + "documentation":"

Enables or disables Amazon S3 backup mode.

" + }, + "S3BackupUpdate":{ + "shape":"S3DestinationUpdate", + "documentation":"

The Amazon S3 destination for backup.

" + }, + "DataFormatConversionConfiguration":{ + "shape":"DataFormatConversionConfiguration", + "documentation":"

The serializer, deserializer, and schema for converting data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.

" + } + }, + "documentation":"

Describes an update for a destination in Amazon S3.

" + }, + "HECAcknowledgmentTimeoutInSeconds":{ + "type":"integer", + "max":600, + "min":180 + }, + "HECEndpoint":{"type":"string"}, + "HECEndpointType":{ + "type":"string", + "enum":[ + "Raw", + "Event" + ] + }, + "HECToken":{"type":"string"}, + "HiveJsonSerDe":{ + "type":"structure", + "members":{ + "TimestampFormats":{ + "shape":"ListOfNonEmptyStrings", + "documentation":"

Indicates how you want Kinesis Data Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see Class DateTimeFormat. You can also use the special value millis to parse timestamps in epoch milliseconds. If you don't specify a format, Kinesis Data Firehose uses java.sql.Timestamp::valueOf by default.

" + } + }, + "documentation":"

The native Hive / HCatalog JsonSerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.

" + }, + "InputFormatConfiguration":{ + "type":"structure", + "members":{ + "Deserializer":{ + "shape":"Deserializer", + "documentation":"

Specifies which deserializer to use. You can choose either the Apache Hive JSON SerDe or the OpenX JSON SerDe. If both are non-null, the server rejects the request.

" + } + }, + "documentation":"

Specifies the deserializer you want to use to convert the format of the input data.

" + }, + "IntervalInSeconds":{ + "type":"integer", + "max":900, + "min":60 + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The specified input parameter has a value that is not valid.

", + "exception":true + }, + "KMSEncryptionConfig":{ + "type":"structure", + "required":["AWSKMSKeyARN"], + "members":{ + "AWSKMSKeyARN":{ + "shape":"AWSKMSKeyARN", + "documentation":"

The Amazon Resource Name (ARN) of the encryption key. Must belong to the same AWS Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + } + }, + "documentation":"

Describes an encryption key for a destination in Amazon S3.

" + }, + "KinesisStreamARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "KinesisStreamSourceConfiguration":{ + "type":"structure", + "required":[ + "KinesisStreamARN", + "RoleARN" + ], + "members":{ + "KinesisStreamARN":{ + "shape":"KinesisStreamARN", + "documentation":"

The ARN of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the role that provides access to the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.

" + } + }, + "documentation":"

The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream.

" + }, + "KinesisStreamSourceDescription":{ + "type":"structure", + "members":{ + "KinesisStreamARN":{ + "shape":"KinesisStreamARN", + "documentation":"

The Amazon Resource Name (ARN) of the source Kinesis data stream. For more information, see Amazon Kinesis Data Streams ARN Format.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the role used by the source Kinesis data stream. For more information, see AWS Identity and Access Management (IAM) ARN Format.

" + }, + "DeliveryStartTimestamp":{ + "shape":"DeliveryStartTimestamp", + "documentation":"

Kinesis Data Firehose starts retrieving records from the Kinesis data stream starting with this timestamp.

" + } + }, + "documentation":"

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

You have already reached the limit for a requested resource.

", + "exception":true + }, + "ListDeliveryStreamsInput":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"ListDeliveryStreamsInputLimit", + "documentation":"

The maximum number of delivery streams to list. The default value is 10.

" + }, + "DeliveryStreamType":{ + "shape":"DeliveryStreamType", + "documentation":"

The delivery stream type. This can be one of the following values:

  • DirectPut: Provider applications access the delivery stream directly.

  • KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

This parameter is optional. If this parameter is omitted, delivery streams of all types are returned.

" + }, + "ExclusiveStartDeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The list of delivery streams returned by this call to ListDeliveryStreams will start with the delivery stream whose name comes alphabetically immediately after the name you specify in ExclusiveStartDeliveryStreamName.

" + } + } + }, + "ListDeliveryStreamsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListDeliveryStreamsOutput":{ + "type":"structure", + "required":[ + "DeliveryStreamNames", + "HasMoreDeliveryStreams" + ], + "members":{ + "DeliveryStreamNames":{ + "shape":"DeliveryStreamNameList", + "documentation":"

The names of the delivery streams.

" + }, + "HasMoreDeliveryStreams":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether there are more delivery streams available to list.

" + } + } + }, + "ListOfNonEmptyStrings":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "ListOfNonEmptyStringsWithoutWhitespace":{ + "type":"list", + "member":{"shape":"NonEmptyStringWithoutWhitespace"} + }, + "ListTagsForDeliveryStreamInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream whose tags you want to list.

" + }, + "ExclusiveStartTagKey":{ + "shape":"TagKey", + "documentation":"

The key to use as the starting point for the list of tags. If you set this parameter, ListTagsForDeliveryStream gets all tags that occur after ExclusiveStartTagKey.

" + }, + "Limit":{ + "shape":"ListTagsForDeliveryStreamInputLimit", + "documentation":"

The number of tags to return. If this number is less than the total number of tags associated with the delivery stream, HasMoreTags is set to true in the response. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

" + } + } + }, + "ListTagsForDeliveryStreamInputLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListTagsForDeliveryStreamOutput":{ + "type":"structure", + "required":[ + "Tags", + "HasMoreTags" + ], + "members":{ + "Tags":{ + "shape":"ListTagsForDeliveryStreamOutputTagList", + "documentation":"

A list of tags associated with DeliveryStreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

" + }, + "HasMoreTags":{ + "shape":"BooleanObject", + "documentation":"

If this is true in the response, more tags are available. To list the remaining tags, set ExclusiveStartTagKey to the key of the last tag returned and call ListTagsForDeliveryStream again.

" + } + } + }, + "ListTagsForDeliveryStreamOutputTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "LogGroupName":{"type":"string"}, + "LogStreamName":{"type":"string"}, + "NoEncryptionConfig":{ + "type":"string", + "enum":["NoEncryption"] + }, + "NonEmptyString":{ + "type":"string", + "pattern":"^(?!\\s*$).+" + }, + "NonEmptyStringWithoutWhitespace":{ + "type":"string", + "pattern":"^\\S+$" + }, + "NonNegativeIntegerObject":{ + "type":"integer", + "min":0 + }, + "OpenXJsonSerDe":{ + "type":"structure", + "members":{ + "ConvertDotsInJsonKeysToUnderscores":{ + "shape":"BooleanObject", + "documentation":"

When set to true, specifies that the names of the keys include dots and that you want Kinesis Data Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is \"a.b\", you can define the column name to be \"a_b\" when using this option.

The default is false.

" + }, + "CaseInsensitive":{ + "shape":"BooleanObject", + "documentation":"

When set to true, which is the default, Kinesis Data Firehose converts JSON keys to lowercase before deserializing them.

" + }, + "ColumnToJsonKeyMappings":{ + "shape":"ColumnToJsonKeyMappings", + "documentation":"

Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, timestamp is a Hive keyword. If you have a JSON key named timestamp, set this parameter to {\"ts\": \"timestamp\"} to map this key to a column named ts.

" + } + }, + "documentation":"

The OpenX SerDe. Used by Kinesis Data Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.

" + }, + "OrcCompression":{ + "type":"string", + "enum":[ + "NONE", + "ZLIB", + "SNAPPY" + ] + }, + "OrcFormatVersion":{ + "type":"string", + "enum":[ + "V0_11", + "V0_12" + ] + }, + "OrcRowIndexStride":{ + "type":"integer", + "min":1000 + }, + "OrcSerDe":{ + "type":"structure", + "members":{ + "StripeSizeBytes":{ + "shape":"OrcStripeSizeBytes", + "documentation":"

The number of bytes in each stripe. The default is 64 MiB and the minimum is 8 MiB.

" + }, + "BlockSizeBytes":{ + "shape":"BlockSizeBytes", + "documentation":"

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" + }, + "RowIndexStride":{ + "shape":"OrcRowIndexStride", + "documentation":"

The number of rows between index entries. The default is 10,000 and the minimum is 1,000.

" + }, + "EnablePadding":{ + "shape":"BooleanObject", + "documentation":"

Set this to true to indicate that you want stripes to be padded to the HDFS block boundaries. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is false.

" + }, + "PaddingTolerance":{ + "shape":"Proportion", + "documentation":"

A number between 0 and 1 that defines the tolerance for block padding as a decimal fraction of stripe size. The default value is 0.05, which means 5 percent of stripe size.

For the default values of 64 MiB ORC stripes and 256 MiB HDFS blocks, the default block padding tolerance of 5 percent reserves a maximum of 3.2 MiB for padding within the 256 MiB block. In such a case, if the available size within the block is more than 3.2 MiB, a new, smaller stripe is inserted to fit within that space. This ensures that no stripe crosses block boundaries and causes remote reads within a node-local task.

Kinesis Data Firehose ignores this parameter when OrcSerDe$EnablePadding is false.

" + }, + "Compression":{ + "shape":"OrcCompression", + "documentation":"

The compression code to use over data blocks. The default is SNAPPY.

" + }, + "BloomFilterColumns":{ + "shape":"ListOfNonEmptyStringsWithoutWhitespace", + "documentation":"

The column names for which you want Kinesis Data Firehose to create bloom filters. The default is null.

" + }, + "BloomFilterFalsePositiveProbability":{ + "shape":"Proportion", + "documentation":"

The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.

" + }, + "DictionaryKeyThreshold":{ + "shape":"Proportion", + "documentation":"

Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.

" + }, + "FormatVersion":{ + "shape":"OrcFormatVersion", + "documentation":"

The version of the file to write. The possible values are V0_11 and V0_12. The default is V0_12.

" + } + }, + "documentation":"

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

" + }, + "OrcStripeSizeBytes":{ + "type":"integer", + "min":8388608 + }, + "OutputFormatConfiguration":{ + "type":"structure", + "members":{ + "Serializer":{ + "shape":"Serializer", + "documentation":"

Specifies which serializer to use. You can choose either the ORC SerDe or the Parquet SerDe. If both are non-null, the server rejects the request.

" + } + }, + "documentation":"

Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.

" + }, + "ParquetCompression":{ + "type":"string", + "enum":[ + "UNCOMPRESSED", + "GZIP", + "SNAPPY" + ] + }, + "ParquetPageSizeBytes":{ + "type":"integer", + "min":65536 + }, + "ParquetSerDe":{ + "type":"structure", + "members":{ + "BlockSizeBytes":{ + "shape":"BlockSizeBytes", + "documentation":"

The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Kinesis Data Firehose uses this value for padding calculations.

" + }, + "PageSizeBytes":{ + "shape":"ParquetPageSizeBytes", + "documentation":"

The Parquet page size. Column chunks are divided into pages. A page is conceptually an indivisible unit (in terms of compression and encoding). The minimum value is 64 KiB and the default is 1 MiB.

" + }, + "Compression":{ + "shape":"ParquetCompression", + "documentation":"

The compression code to use over data blocks. The possible values are UNCOMPRESSED, SNAPPY, and GZIP, with the default being SNAPPY. Use SNAPPY for higher decompression speed. Use GZIP if the compression ration is more important than speed.

" + }, + "EnableDictionaryCompression":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether to enable dictionary compression.

" + }, + "MaxPaddingBytes":{ + "shape":"NonNegativeIntegerObject", + "documentation":"

The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.

" + }, + "WriterVersion":{ + "shape":"ParquetWriterVersion", + "documentation":"

Indicates the version of row format to output. The possible values are V1 and V2. The default is V1.

" + } + }, + "documentation":"

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

" + }, + "ParquetWriterVersion":{ + "type":"string", + "enum":[ + "V1", + "V2" + ] + }, + "Password":{ + "type":"string", + "min":6, + "sensitive":true + }, + "Prefix":{"type":"string"}, + "ProcessingConfiguration":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"BooleanObject", + "documentation":"

Enables or disables data processing.

" + }, + "Processors":{ + "shape":"ProcessorList", + "documentation":"

The data processors.

" + } + }, + "documentation":"

Describes a data processing configuration.

" + }, + "Processor":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"ProcessorType", + "documentation":"

The type of processor.

" + }, + "Parameters":{ + "shape":"ProcessorParameterList", + "documentation":"

The processor parameters.

" + } + }, + "documentation":"

Describes a data processor.

" + }, + "ProcessorList":{ + "type":"list", + "member":{"shape":"Processor"} + }, + "ProcessorParameter":{ + "type":"structure", + "required":[ + "ParameterName", + "ParameterValue" + ], + "members":{ + "ParameterName":{ + "shape":"ProcessorParameterName", + "documentation":"

The name of the parameter.

" + }, + "ParameterValue":{ + "shape":"ProcessorParameterValue", + "documentation":"

The parameter value.

" + } + }, + "documentation":"

Describes the processor parameter.

" + }, + "ProcessorParameterList":{ + "type":"list", + "member":{"shape":"ProcessorParameter"} + }, + "ProcessorParameterName":{ + "type":"string", + "enum":[ + "LambdaArn", + "NumberOfRetries", + "RoleArn", + "BufferSizeInMBs", + "BufferIntervalInSeconds" + ] + }, + "ProcessorParameterValue":{ + "type":"string", + "max":512, + "min":1 + }, + "ProcessorType":{ + "type":"string", + "enum":["Lambda"] + }, + "Proportion":{ + "type":"double", + "max":1, + "min":0 + }, + "PutRecordBatchInput":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "Records" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "Records":{ + "shape":"PutRecordBatchRequestEntryList", + "documentation":"

One or more records.

" + } + } + }, + "PutRecordBatchOutput":{ + "type":"structure", + "required":[ + "FailedPutCount", + "RequestResponses" + ], + "members":{ + "FailedPutCount":{ + "shape":"NonNegativeIntegerObject", + "documentation":"

The number of records that might have failed processing. This number might be greater than 0 even if the PutRecordBatch call succeeds. Check FailedPutCount to determine whether there are records that you need to resend.

" + }, + "Encrypted":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether server-side encryption (SSE) was enabled during this operation.

" + }, + "RequestResponses":{ + "shape":"PutRecordBatchResponseEntryList", + "documentation":"

The results array. For each record, the index of the response element is the same as the index used in the request array.

" + } + } + }, + "PutRecordBatchRequestEntryList":{ + "type":"list", + "member":{"shape":"Record"}, + "max":500, + "min":1 + }, + "PutRecordBatchResponseEntry":{ + "type":"structure", + "members":{ + "RecordId":{ + "shape":"PutResponseRecordId", + "documentation":"

The ID of the record.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code for an individual record result.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message for an individual record result.

" + } + }, + "documentation":"

Contains the result for an individual record from a PutRecordBatch request. If the record is successfully added to your delivery stream, it receives a record ID. If the record fails to be added to your delivery stream, the result includes an error code and an error message.

" + }, + "PutRecordBatchResponseEntryList":{ + "type":"list", + "member":{"shape":"PutRecordBatchResponseEntry"}, + "max":500, + "min":1 + }, + "PutRecordInput":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "Record" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "Record":{ + "shape":"Record", + "documentation":"

The record.

" + } + } + }, + "PutRecordOutput":{ + "type":"structure", + "required":["RecordId"], + "members":{ + "RecordId":{ + "shape":"PutResponseRecordId", + "documentation":"

The ID of the record.

" + }, + "Encrypted":{ + "shape":"BooleanObject", + "documentation":"

Indicates whether server-side encryption (SSE) was enabled during this operation.

" + } + } + }, + "PutResponseRecordId":{ + "type":"string", + "min":1 + }, + "Record":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"Data", + "documentation":"

The data blob, which is base64-encoded when the blob is serialized. The maximum size of the data blob, before base64-encoding, is 1,000 KiB.

" + } + }, + "documentation":"

The unit of data in a delivery stream.

" + }, + "RedshiftDestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "ClusterJDBCURL", + "CopyCommand", + "Username", + "Password", + "S3Configuration" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ClusterJDBCURL":{ + "shape":"ClusterJDBCURL", + "documentation":"

The database connection string.

" + }, + "CopyCommand":{ + "shape":"CopyCommand", + "documentation":"

The COPY command.

" + }, + "Username":{ + "shape":"Username", + "documentation":"

The name of the user.

" + }, + "Password":{ + "shape":"Password", + "documentation":"

The user password.

" + }, + "RetryOptions":{ + "shape":"RedshiftRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" + }, + "S3Configuration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

The configuration for the intermediate Amazon S3 location from which Amazon Redshift obtains data. Restrictions are described in the topic for CreateDeliveryStream.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"RedshiftS3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3BackupConfiguration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

The configuration for backup in Amazon S3.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes the configuration of a destination in Amazon Redshift.

" + }, + "RedshiftDestinationDescription":{ + "type":"structure", + "required":[ + "RoleARN", + "ClusterJDBCURL", + "CopyCommand", + "Username", + "S3DestinationDescription" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ClusterJDBCURL":{ + "shape":"ClusterJDBCURL", + "documentation":"

The database connection string.

" + }, + "CopyCommand":{ + "shape":"CopyCommand", + "documentation":"

The COPY command.

" + }, + "Username":{ + "shape":"Username", + "documentation":"

The name of the user.

" + }, + "RetryOptions":{ + "shape":"RedshiftRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" + }, + "S3DestinationDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

The Amazon S3 destination.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"RedshiftS3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3BackupDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

The configuration for backup in Amazon S3.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes a destination in Amazon Redshift.

" + }, + "RedshiftDestinationUpdate":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ClusterJDBCURL":{ + "shape":"ClusterJDBCURL", + "documentation":"

The database connection string.

" + }, + "CopyCommand":{ + "shape":"CopyCommand", + "documentation":"

The COPY command.

" + }, + "Username":{ + "shape":"Username", + "documentation":"

The name of the user.

" + }, + "Password":{ + "shape":"Password", + "documentation":"

The user password.

" + }, + "RetryOptions":{ + "shape":"RedshiftRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

" + }, + "S3Update":{ + "shape":"S3DestinationUpdate", + "documentation":"

The Amazon S3 destination.

The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationUpdate.S3Update because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "S3BackupMode":{ + "shape":"RedshiftS3BackupMode", + "documentation":"

The Amazon S3 backup mode.

" + }, + "S3BackupUpdate":{ + "shape":"S3DestinationUpdate", + "documentation":"

The Amazon S3 destination for backup.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes an update for a destination in Amazon Redshift.

" + }, + "RedshiftRetryDurationInSeconds":{ + "type":"integer", + "max":7200, + "min":0 + }, + "RedshiftRetryOptions":{ + "type":"structure", + "members":{ + "DurationInSeconds":{ + "shape":"RedshiftRetryDurationInSeconds", + "documentation":"

The length of time during which Kinesis Data Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Kinesis Data Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

" + } + }, + "documentation":"

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.

" + }, + "RedshiftS3BackupMode":{ + "type":"string", + "enum":[ + "Disabled", + "Enabled" + ] + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The resource is already in use and not available for this operation.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The specified resource could not be found.

", + "exception":true + }, + "RoleARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "S3BackupMode":{ + "type":"string", + "enum":[ + "Disabled", + "Enabled" + ] + }, + "S3DestinationConfiguration":{ + "type":"structure", + "required":[ + "RoleARN", + "BucketARN" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes the configuration of a destination in Amazon S3.

" + }, + "S3DestinationDescription":{ + "type":"structure", + "required":[ + "RoleARN", + "BucketARN", + "BufferingHints", + "CompressionFormat", + "EncryptionConfiguration" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes a destination in Amazon S3.

" + }, + "S3DestinationUpdate":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The Amazon Resource Name (ARN) of the AWS credentials. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

The \"YYYY/MM/DD/HH\" time format prefix is automatically used for delivered Amazon S3 files. You can also specify a custom prefix, as described in Custom Prefixes for Amazon S3 Objects.

" + }, + "ErrorOutputPrefix":{ + "shape":"ErrorOutputPrefix", + "documentation":"

A prefix that Kinesis Data Firehose evaluates and adds to failed records before writing them to S3. This prefix appears immediately following the bucket name. For information about how to specify this prefix, see Custom Prefixes for Amazon S3 Objects.

" + }, + "BufferingHints":{ + "shape":"BufferingHints", + "documentation":"

The buffering option. If no value is specified, BufferingHints object default values are used.

" + }, + "CompressionFormat":{ + "shape":"CompressionFormat", + "documentation":"

The compression format. If no value is specified, the default is UNCOMPRESSED.

The compression formats SNAPPY or ZIP cannot be specified for Amazon Redshift destinations because they are not supported by the Amazon Redshift COPY operation that reads from the S3 bucket.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration. If no value is specified, the default is no encryption.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes an update for a destination in Amazon S3.

" + }, + "SchemaConfiguration":{ + "type":"structure", + "members":{ + "RoleARN":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

" + }, + "CatalogId":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

Specifies the name of the AWS Glue database that contains the schema for the output data.

" + }, + "TableName":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

" + }, + "Region":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

If you don't specify an AWS Region, the default is the current Region.

" + }, + "VersionId":{ + "shape":"NonEmptyStringWithoutWhitespace", + "documentation":"

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

" + } + }, + "documentation":"

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

" + }, + "Serializer":{ + "type":"structure", + "members":{ + "ParquetSerDe":{ + "shape":"ParquetSerDe", + "documentation":"

A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see Apache Parquet.

" + }, + "OrcSerDe":{ + "shape":"OrcSerDe", + "documentation":"

A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see Apache ORC.

" + } + }, + "documentation":"

The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3. Kinesis Data Firehose supports two types of serializers: the ORC SerDe and the Parquet SerDe.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The service is unavailable. Back off and retry the operation. If you continue to see the exception, throughput limits for the delivery stream may have been exceeded. For more information about limits and how to request an increase, see Amazon Kinesis Data Firehose Limits.

", + "exception":true, + "fault":true + }, + "SizeInMBs":{ + "type":"integer", + "max":128, + "min":1 + }, + "SourceDescription":{ + "type":"structure", + "members":{ + "KinesisStreamSourceDescription":{ + "shape":"KinesisStreamSourceDescription", + "documentation":"

The KinesisStreamSourceDescription value for the source Kinesis data stream.

" + } + }, + "documentation":"

Details about a Kinesis data stream used as the source for a Kinesis Data Firehose delivery stream.

" + }, + "SplunkDestinationConfiguration":{ + "type":"structure", + "required":[ + "HECEndpoint", + "HECEndpointType", + "HECToken", + "S3Configuration" + ], + "members":{ + "HECEndpoint":{ + "shape":"HECEndpoint", + "documentation":"

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

" + }, + "HECEndpointType":{ + "shape":"HECEndpointType", + "documentation":"

This type can be either \"Raw\" or \"Event.\"

" + }, + "HECToken":{ + "shape":"HECToken", + "documentation":"

This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

" + }, + "HECAcknowledgmentTimeoutInSeconds":{ + "shape":"HECAcknowledgmentTimeoutInSeconds", + "documentation":"

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

" + }, + "RetryOptions":{ + "shape":"SplunkRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

" + }, + "S3BackupMode":{ + "shape":"SplunkS3BackupMode", + "documentation":"

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

" + }, + "S3Configuration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

The configuration for the backup Amazon S3 location.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes the configuration of a destination in Splunk.

" + }, + "SplunkDestinationDescription":{ + "type":"structure", + "members":{ + "HECEndpoint":{ + "shape":"HECEndpoint", + "documentation":"

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

" + }, + "HECEndpointType":{ + "shape":"HECEndpointType", + "documentation":"

This type can be either \"Raw\" or \"Event.\"

" + }, + "HECToken":{ + "shape":"HECToken", + "documentation":"

A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

" + }, + "HECAcknowledgmentTimeoutInSeconds":{ + "shape":"HECAcknowledgmentTimeoutInSeconds", + "documentation":"

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

" + }, + "RetryOptions":{ + "shape":"SplunkRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

" + }, + "S3BackupMode":{ + "shape":"SplunkS3BackupMode", + "documentation":"

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

" + }, + "S3DestinationDescription":{ + "shape":"S3DestinationDescription", + "documentation":"

The Amazon S3 destination.>

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes a destination in Splunk.

" + }, + "SplunkDestinationUpdate":{ + "type":"structure", + "members":{ + "HECEndpoint":{ + "shape":"HECEndpoint", + "documentation":"

The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.

" + }, + "HECEndpointType":{ + "shape":"HECEndpointType", + "documentation":"

This type can be either \"Raw\" or \"Event.\"

" + }, + "HECToken":{ + "shape":"HECToken", + "documentation":"

A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

" + }, + "HECAcknowledgmentTimeoutInSeconds":{ + "shape":"HECAcknowledgmentTimeoutInSeconds", + "documentation":"

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

" + }, + "RetryOptions":{ + "shape":"SplunkRetryOptions", + "documentation":"

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.

" + }, + "S3BackupMode":{ + "shape":"SplunkS3BackupMode", + "documentation":"

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

" + }, + "S3Update":{ + "shape":"S3DestinationUpdate", + "documentation":"

Your update to the configuration of the backup Amazon S3 location.

" + }, + "ProcessingConfiguration":{ + "shape":"ProcessingConfiguration", + "documentation":"

The data processing configuration.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

The Amazon CloudWatch logging options for your delivery stream.

" + } + }, + "documentation":"

Describes an update for a destination in Splunk.

" + }, + "SplunkRetryDurationInSeconds":{ + "type":"integer", + "max":7200, + "min":0 + }, + "SplunkRetryOptions":{ + "type":"structure", + "members":{ + "DurationInSeconds":{ + "shape":"SplunkRetryDurationInSeconds", + "documentation":"

The total amount of time that Kinesis Data Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Kinesis Data Firehose waits for acknowledgment from Splunk after each attempt.

" + } + }, + "documentation":"

Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk, or if it doesn't receive an acknowledgment from Splunk.

" + }, + "SplunkS3BackupMode":{ + "type":"string", + "enum":[ + "FailedEventsOnly", + "AllEvents" + ] + }, + "StartDeliveryStreamEncryptionInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream for which you want to enable server-side encryption (SSE).

" + } + } + }, + "StartDeliveryStreamEncryptionOutput":{ + "type":"structure", + "members":{ + } + }, + "StopDeliveryStreamEncryptionInput":{ + "type":"structure", + "required":["DeliveryStreamName"], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream for which you want to disable server-side encryption (SSE).

" + } + } + }, + "StopDeliveryStreamEncryptionOutput":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

An optional string, which you can use to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + } + }, + "documentation":"

Metadata that you can assign to a delivery stream, consisting of a key-value pair.

" + }, + "TagDeliveryStreamInput":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "Tags" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream to which you want to add the tags.

" + }, + "Tags":{ + "shape":"TagDeliveryStreamInputTagList", + "documentation":"

A set of key-value pairs to use to create the tags.

" + } + } + }, + "TagDeliveryStreamInputTagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagDeliveryStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "UntagDeliveryStreamInput":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "TagKeys" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys. Each corresponding tag is removed from the delivery stream.

" + } + } + }, + "UntagDeliveryStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateDestinationInput":{ + "type":"structure", + "required":[ + "DeliveryStreamName", + "CurrentDeliveryStreamVersionId", + "DestinationId" + ], + "members":{ + "DeliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the delivery stream.

" + }, + "CurrentDeliveryStreamVersionId":{ + "shape":"DeliveryStreamVersionId", + "documentation":"

Obtain this value from the VersionId result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId value is updated. The service then performs a merge of the old configuration with the new configuration.

" + }, + "DestinationId":{ + "shape":"DestinationId", + "documentation":"

The ID of the destination.

" + }, + "S3DestinationUpdate":{ + "shape":"S3DestinationUpdate", + "documentation":"

[Deprecated] Describes an update for a destination in Amazon S3.

", + "deprecated":true + }, + "ExtendedS3DestinationUpdate":{ + "shape":"ExtendedS3DestinationUpdate", + "documentation":"

Describes an update for a destination in Amazon S3.

" + }, + "RedshiftDestinationUpdate":{ + "shape":"RedshiftDestinationUpdate", + "documentation":"

Describes an update for a destination in Amazon Redshift.

" + }, + "ElasticsearchDestinationUpdate":{ + "shape":"ElasticsearchDestinationUpdate", + "documentation":"

Describes an update for a destination in Amazon ES.

" + }, + "SplunkDestinationUpdate":{ + "shape":"SplunkDestinationUpdate", + "documentation":"

Describes an update for a destination in Splunk.

" + } + } + }, + "UpdateDestinationOutput":{ + "type":"structure", + "members":{ + } + }, + "Username":{ + "type":"string", + "min":1, + "sensitive":true + } + }, + "documentation":"Amazon Kinesis Data Firehose API Reference

Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon Elasticsearch Service (Amazon ES), Amazon Redshift, and Splunk.

" +} diff --git a/aws/dist/botocore/data/fms/2018-01-01/paginators-1.json b/aws/dist/botocore/data/fms/2018-01-01/paginators-1.json new file mode 100644 index 00000000..d72296c5 --- /dev/null +++ b/aws/dist/botocore/data/fms/2018-01-01/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListComplianceStatus": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PolicyComplianceStatusList" + }, + "ListMemberAccounts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MemberAccounts" + }, + "ListPolicies": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PolicyList" + } + } +} diff --git a/aws/dist/botocore/data/fms/2018-01-01/service-2.json b/aws/dist/botocore/data/fms/2018-01-01/service-2.json new file mode 100644 index 00000000..fb1368c8 --- /dev/null +++ b/aws/dist/botocore/data/fms/2018-01-01/service-2.json @@ -0,0 +1,976 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-01-01", + "endpointPrefix":"fms", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"FMS", + "serviceFullName":"Firewall Management Service", + "serviceId":"FMS", + "signatureVersion":"v4", + "targetPrefix":"AWSFMS_20180101", + "uid":"fms-2018-01-01" + }, + "operations":{ + "AssociateAdminAccount":{ + "name":"AssociateAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateAdminAccountRequest"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Sets the AWS Firewall Manager administrator account. AWS Firewall Manager must be associated with the master account of your AWS organization or associated with a member account that has the appropriate permissions. If the account ID that you submit is not an AWS Organizations master account, AWS Firewall Manager will set the appropriate permissions for the given member account.

The account that you associate with AWS Firewall Manager is called the AWS Firewall Manager administrator account.

" + }, + "DeleteNotificationChannel":{ + "name":"DeleteNotificationChannel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNotificationChannelRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Deletes an AWS Firewall Manager association with the IAM role and the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Permanently deletes an AWS Firewall Manager policy.

" + }, + "DisassociateAdminAccount":{ + "name":"DisassociateAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateAdminAccountRequest"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Disassociates the account that has been set as the AWS Firewall Manager administrator account. To set a different account as the administrator account, you must submit an AssociateAdminAccount request.

" + }, + "GetAdminAccount":{ + "name":"GetAdminAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAdminAccountRequest"}, + "output":{"shape":"GetAdminAccountResponse"}, + "errors":[ + {"shape":"InvalidOperationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns the AWS Organizations master account that is associated with AWS Firewall Manager as the AWS Firewall Manager administrator.

" + }, + "GetComplianceDetail":{ + "name":"GetComplianceDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetComplianceDetailRequest"}, + "output":{"shape":"GetComplianceDetailResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns detailed compliance information about the specified member account. Details include resources that are in and out of compliance with the specified policy. Resources are considered noncompliant for AWS WAF and Shield Advanced policies if the specified policy has not been applied to them. Resources are considered noncompliant for security group policies if they are in scope of the policy, they violate one or more of the policy rules, and remediation is disabled or not possible.

" + }, + "GetNotificationChannel":{ + "name":"GetNotificationChannel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNotificationChannelRequest"}, + "output":{"shape":"GetNotificationChannelResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Information about the Amazon Simple Notification Service (SNS) topic that is used to record AWS Firewall Manager SNS logs.

" + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidTypeException"} + ], + "documentation":"

Returns information about the specified AWS Firewall Manager policy.

" + }, + "GetProtectionStatus":{ + "name":"GetProtectionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProtectionStatusRequest"}, + "output":{"shape":"GetProtectionStatusResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

If you created a Shield Advanced policy, returns policy-level attack summary information in the event of a potential DDoS attack. Other policy types are currently unsupported.

" + }, + "ListComplianceStatus":{ + "name":"ListComplianceStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComplianceStatusRequest"}, + "output":{"shape":"ListComplianceStatusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns an array of PolicyComplianceStatus objects in the response. Use PolicyComplianceStatus to get a summary of which member accounts are protected by the specified policy.

" + }, + "ListMemberAccounts":{ + "name":"ListMemberAccounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMemberAccountsRequest"}, + "output":{"shape":"ListMemberAccountsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns a MemberAccounts object that lists the member accounts in the administrator's AWS organization.

The ListMemberAccounts must be submitted by the account that is set as the AWS Firewall Manager administrator.

" + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{"shape":"ListPoliciesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Returns an array of PolicySummary objects in the response.

" + }, + "PutNotificationChannel":{ + "name":"PutNotificationChannel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutNotificationChannelRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InternalErrorException"} + ], + "documentation":"

Designates the IAM role and Amazon Simple Notification Service (SNS) topic that AWS Firewall Manager uses to record SNS logs.

" + }, + "PutPolicy":{ + "name":"PutPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPolicyRequest"}, + "output":{"shape":"PutPolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalErrorException"}, + {"shape":"InvalidTypeException"} + ], + "documentation":"

Creates an AWS Firewall Manager policy.

Firewall Manager provides the following types of policies:

  • A Shield Advanced policy, which applies Shield Advanced protection to specified accounts and resources

  • An AWS WAF policy, which contains a rule group and defines which resources are to be protected by that rule group

  • A security group policy, which manages VPC security groups across your AWS organization.

Each policy is specific to one of the three types. If you want to enforce more than one policy type across accounts, you can create multiple policies. You can create multiple policies for each type.

You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more information about subscribing to Shield Advanced, see CreateSubscription.

" + } + }, + "shapes":{ + "AWSAccountId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[0-9]+$" + }, + "AccountRoleStatus":{ + "type":"string", + "enum":[ + "READY", + "CREATING", + "PENDING_DELETION", + "DELETING", + "DELETED" + ] + }, + "AssociateAdminAccountRequest":{ + "type":"structure", + "required":["AdminAccount"], + "members":{ + "AdminAccount":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account ID to associate with AWS Firewall Manager as the AWS Firewall Manager administrator account. This can be an AWS Organizations master account or a member account. For more information about AWS Organizations and master accounts, see Managing the AWS Accounts in Your Organization.

" + } + } + }, + "Boolean":{"type":"boolean"}, + "ComplianceViolator":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

The resource ID.

" + }, + "ViolationReason":{ + "shape":"ViolationReason", + "documentation":"

The reason that the resource is not protected by the policy.

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

The resource type. This is in the format shown in the AWS Resource Types Reference. For example: AWS::ElasticLoadBalancingV2::LoadBalancer or AWS::CloudFront::Distribution.

" + } + }, + "documentation":"

Details of the resource that is not protected by the policy.

" + }, + "ComplianceViolators":{ + "type":"list", + "member":{"shape":"ComplianceViolator"} + }, + "CustomerPolicyScopeId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "CustomerPolicyScopeIdList":{ + "type":"list", + "member":{"shape":"CustomerPolicyScopeId"} + }, + "CustomerPolicyScopeIdType":{ + "type":"string", + "enum":["ACCOUNT"] + }, + "CustomerPolicyScopeMap":{ + "type":"map", + "key":{"shape":"CustomerPolicyScopeIdType"}, + "value":{"shape":"CustomerPolicyScopeIdList"} + }, + "DeleteNotificationChannelRequest":{ + "type":"structure", + "members":{ + } + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the policy that you want to delete. PolicyId is returned by PutPolicy and by ListPolicies.

" + }, + "DeleteAllPolicyResources":{ + "shape":"Boolean", + "documentation":"

If True, the request performs cleanup according to the policy type.

For AWS WAF and Shield Advanced policies, the cleanup does the following:

  • Deletes rule groups created by AWS Firewall Manager

  • Removes web ACLs from in-scope resources

  • Deletes web ACLs that contain no rules or rule groups

For security group policies, the cleanup does the following for each security group in the policy:

  • Disassociates the security group from in-scope resources

  • Deletes the security group if it was created through Firewall Manager and if it's no longer associated with any resources through another policy

After the cleanup, in-scope resources are no longer protected by web ACLs in this policy. Protection of out-of-scope resources remains unchanged. Scope is determined by tags that you create and accounts that you associate with the policy. When creating the policy, if you specify that only resources in specific accounts or with specific tags are in scope of the policy, those accounts and resources are handled by the policy. All others are out of scope. If you don't specify tags or accounts, all resources are in scope.

" + } + } + }, + "DependentServiceName":{ + "type":"string", + "enum":[ + "AWSCONFIG", + "AWSWAF", + "AWSSHIELD_ADVANCED", + "AWSVPC" + ] + }, + "DetailedInfo":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "DisassociateAdminAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "ErrorMessage":{"type":"string"}, + "EvaluationResult":{ + "type":"structure", + "members":{ + "ComplianceStatus":{ + "shape":"PolicyComplianceStatusType", + "documentation":"

Describes an AWS account's compliance with the AWS Firewall Manager policy.

" + }, + "ViolatorCount":{ + "shape":"ResourceCount", + "documentation":"

The number of resources that are noncompliant with the specified policy. For AWS WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn't comply with the rules of the policy and remediation is disabled or not possible.

" + }, + "EvaluationLimitExceeded":{ + "shape":"Boolean", + "documentation":"

Indicates that over 100 resources are noncompliant with the AWS Firewall Manager policy.

" + } + }, + "documentation":"

Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don't comply with the policy.

" + }, + "EvaluationResults":{ + "type":"list", + "member":{"shape":"EvaluationResult"} + }, + "GetAdminAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAdminAccountResponse":{ + "type":"structure", + "members":{ + "AdminAccount":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that is set as the AWS Firewall Manager administrator.

" + }, + "RoleStatus":{ + "shape":"AccountRoleStatus", + "documentation":"

The status of the AWS account that you set as the AWS Firewall Manager administrator.

" + } + } + }, + "GetComplianceDetailRequest":{ + "type":"structure", + "required":[ + "PolicyId", + "MemberAccount" + ], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the policy that you want to get the details for. PolicyId is returned by PutPolicy and by ListPolicies.

" + }, + "MemberAccount":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that owns the resources that you want to get the details for.

" + } + } + }, + "GetComplianceDetailResponse":{ + "type":"structure", + "members":{ + "PolicyComplianceDetail":{ + "shape":"PolicyComplianceDetail", + "documentation":"

Information about the resources and the policy that you specified in the GetComplianceDetail request.

" + } + } + }, + "GetNotificationChannelRequest":{ + "type":"structure", + "members":{ + } + }, + "GetNotificationChannelResponse":{ + "type":"structure", + "members":{ + "SnsTopicArn":{ + "shape":"ResourceArn", + "documentation":"

The SNS topic that records AWS Firewall Manager activity.

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

The IAM role that is used by AWS Firewall Manager to record activity to SNS.

" + } + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the AWS Firewall Manager policy that you want the details for.

" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

Information about the specified AWS Firewall Manager policy.

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

The Amazon Resource Name (ARN) of the specified policy.

" + } + } + }, + "GetProtectionStatusRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the policy for which you want to get the attack information.

" + }, + "MemberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that is in scope of the policy that you want to get the details for.

" + }, + "StartTime":{ + "shape":"TimeStamp", + "documentation":"

The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

" + }, + "EndTime":{ + "shape":"TimeStamp", + "documentation":"

The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"

Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

" + } + } + }, + "GetProtectionStatusResponse":{ + "type":"structure", + "members":{ + "AdminAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The ID of the AWS Firewall administrator account for this policy.

" + }, + "ServiceType":{ + "shape":"SecurityServiceType", + "documentation":"

The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.

" + }, + "Data":{ + "shape":"ProtectionData", + "documentation":"

Details about the attack, including the following:

  • Attack type

  • Account ID

  • ARN of the resource attacked

  • Start time of the attack

  • End time of the attack (ongoing attacks will not have an end time)

The details are in JSON format.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

AWS SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

" + } + } + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The operation failed because of a system problem, even though the request was valid. Retry your request.

", + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The parameters of the request were invalid.

", + "exception":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The operation failed because there was nothing to do. For example, you might have submitted an AssociateAdminAccount request, but the account ID that you submitted was already set as the AWS Firewall Manager administrator.

", + "exception":true + }, + "InvalidTypeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The value of the Type parameter is invalid.

", + "exception":true + }, + "IssueInfoMap":{ + "type":"map", + "key":{"shape":"DependentServiceName"}, + "value":{"shape":"DetailedInfo"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an AWS account. For more information, see Firewall Manager Limits in the AWS WAF Developer Guide.

", + "exception":true + }, + "ListComplianceStatusRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the AWS Firewall Manager policy that you want the details for.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you specify a value for MaxResults and you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicyComplianceStatus objects. For the second and subsequent ListComplianceStatus requests, specify the value of NextToken from the previous response to get information about another batch of PolicyComplianceStatus objects.

" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"

Specifies the number of PolicyComplianceStatus objects that you want AWS Firewall Manager to return for this request. If you have more PolicyComplianceStatus objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicyComplianceStatus objects.

" + } + } + }, + "ListComplianceStatusResponse":{ + "type":"structure", + "members":{ + "PolicyComplianceStatusList":{ + "shape":"PolicyComplianceStatusList", + "documentation":"

An array of PolicyComplianceStatus objects.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you have more PolicyComplianceStatus objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicyComplianceStatus objects, submit another ListComplianceStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

" + } + } + }, + "ListMemberAccountsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you specify a value for MaxResults and you have more account IDs than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of IDs. For the second and subsequent ListMemberAccountsRequest requests, specify the value of NextToken from the previous response to get information about another batch of member account IDs.

" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"

Specifies the number of member account IDs that you want AWS Firewall Manager to return for this request. If you have more IDs than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of member account IDs.

" + } + } + }, + "ListMemberAccountsResponse":{ + "type":"structure", + "members":{ + "MemberAccounts":{ + "shape":"MemberAccounts", + "documentation":"

An array of account IDs.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you have more member account IDs than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more IDs, submit another ListMemberAccounts request, and specify the NextToken value from the response in the NextToken value in the next request.

" + } + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you specify a value for MaxResults and you have more PolicySummary objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response that allows you to list another group of PolicySummary objects. For the second and subsequent ListPolicies requests, specify the value of NextToken from the previous response to get information about another batch of PolicySummary objects.

" + }, + "MaxResults":{ + "shape":"PaginationMaxResults", + "documentation":"

Specifies the number of PolicySummary objects that you want AWS Firewall Manager to return for this request. If you have more PolicySummary objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of PolicySummary objects.

" + } + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "PolicyList":{ + "shape":"PolicySummaryList", + "documentation":"

An array of PolicySummary objects.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

If you have more PolicySummary objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more PolicySummary objects, submit another ListPolicies request, and specify the NextToken value from the response in the NextToken value in the next request.

" + } + } + }, + "ManagedServiceData":{ + "type":"string", + "max":1024, + "min":1 + }, + "MemberAccounts":{ + "type":"list", + "member":{"shape":"AWSAccountId"} + }, + "PaginationMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "PaginationToken":{ + "type":"string", + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Policy":{ + "type":"structure", + "required":[ + "PolicyName", + "SecurityServicePolicyData", + "ResourceType", + "ExcludeResourceTags", + "RemediationEnabled" + ], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the AWS Firewall Manager policy.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The friendly name of the AWS Firewall Manager policy.

" + }, + "PolicyUpdateToken":{ + "shape":"PolicyUpdateToken", + "documentation":"

A unique identifier for each update to the policy. When issuing a PutPolicy request, the PolicyUpdateToken in the request must match the PolicyUpdateToken of the current policy version. To get the PolicyUpdateToken of the current policy version, use a GetPolicy request.

" + }, + "SecurityServicePolicyData":{ + "shape":"SecurityServicePolicyData", + "documentation":"

Details about the security service that is being used to protect the resources.

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

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup.

" + }, + "ResourceTypeList":{ + "shape":"ResourceTypeList", + "documentation":"

An array of ResourceType.

" + }, + "ResourceTags":{ + "shape":"ResourceTags", + "documentation":"

An array of ResourceTag objects.

" + }, + "ExcludeResourceTags":{ + "shape":"Boolean", + "documentation":"

If set to True, resources with the tags that are specified in the ResourceTag array are not in scope of the policy. If set to False, and the ResourceTag array is not null, only resources with the specified tags are in scope of the policy.

" + }, + "RemediationEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates if the policy should be automatically applied to new resources.

" + }, + "IncludeMap":{ + "shape":"CustomerPolicyScopeMap", + "documentation":"

Specifies the AWS account IDs to include in the policy. If IncludeMap is null, all accounts in the organization in AWS Organizations are included in the policy. If IncludeMap is not null, only values listed in IncludeMap are included in the policy.

The key to the map is ACCOUNT. For example, a valid IncludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.

" + }, + "ExcludeMap":{ + "shape":"CustomerPolicyScopeMap", + "documentation":"

Specifies the AWS account IDs to exclude from the policy. The IncludeMap values are evaluated first, with all the appropriate account IDs added to the policy. Then the accounts listed in ExcludeMap are removed, resulting in the final list of accounts to add to the policy.

The key to the map is ACCOUNT. For example, a valid ExcludeMap would be {“ACCOUNT” : [“accountID1”, “accountID2”]}.

" + } + }, + "documentation":"

An AWS Firewall Manager policy.

" + }, + "PolicyComplianceDetail":{ + "type":"structure", + "members":{ + "PolicyOwner":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that created the AWS Firewall Manager policy.

" + }, + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the AWS Firewall Manager policy.

" + }, + "MemberAccount":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account ID.

" + }, + "Violators":{ + "shape":"ComplianceViolators", + "documentation":"

An array of resources that aren't protected by the AWS WAF or Shield Advanced policy or that aren't in compliance with the security group policy.

" + }, + "EvaluationLimitExceeded":{ + "shape":"Boolean", + "documentation":"

Indicates if over 100 resources are noncompliant with the AWS Firewall Manager policy.

" + }, + "ExpiredAt":{ + "shape":"TimeStamp", + "documentation":"

A timestamp that indicates when the returned information should be considered out of date.

" + }, + "IssueInfoMap":{ + "shape":"IssueInfoMap", + "documentation":"

Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

" + } + }, + "documentation":"

Describes the noncompliant resources in a member account for a specific AWS Firewall Manager policy. A maximum of 100 entries are displayed. If more than 100 resources are noncompliant, EvaluationLimitExceeded is set to True.

" + }, + "PolicyComplianceStatus":{ + "type":"structure", + "members":{ + "PolicyOwner":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that created the AWS Firewall Manager policy.

" + }, + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the AWS Firewall Manager policy.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The friendly name of the AWS Firewall Manager policy.

" + }, + "MemberAccount":{ + "shape":"AWSAccountId", + "documentation":"

The member account ID.

" + }, + "EvaluationResults":{ + "shape":"EvaluationResults", + "documentation":"

An array of EvaluationResult objects.

" + }, + "LastUpdated":{ + "shape":"TimeStamp", + "documentation":"

Timestamp of the last update to the EvaluationResult objects.

" + }, + "IssueInfoMap":{ + "shape":"IssueInfoMap", + "documentation":"

Details about problems with dependent services, such as AWS WAF or AWS Config, that are causing a resource to be noncompliant. The details include the name of the dependent service and the error message received that indicates the problem with the service.

" + } + }, + "documentation":"

Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for AWS WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

" + }, + "PolicyComplianceStatusList":{ + "type":"list", + "member":{"shape":"PolicyComplianceStatus"} + }, + "PolicyComplianceStatusType":{ + "type":"string", + "enum":[ + "COMPLIANT", + "NON_COMPLIANT" + ] + }, + "PolicyId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[a-z0-9A-Z-]{36}$" + }, + "PolicySummary":{ + "type":"structure", + "members":{ + "PolicyArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the specified policy.

" + }, + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The ID of the specified policy.

" + }, + "PolicyName":{ + "shape":"ResourceName", + "documentation":"

The friendly name of the specified policy.

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

The type of resource protected by or in scope of the policy. This is in the format shown in the AWS Resource Types Reference. For AWS WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup.

" + }, + "SecurityServiceType":{ + "shape":"SecurityServiceType", + "documentation":"

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy.

" + }, + "RemediationEnabled":{ + "shape":"Boolean", + "documentation":"

Indicates if the policy should be automatically applied to new resources.

" + } + }, + "documentation":"

Details of the AWS Firewall Manager policy.

" + }, + "PolicySummaryList":{ + "type":"list", + "member":{"shape":"PolicySummary"} + }, + "PolicyUpdateToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "ProtectionData":{"type":"string"}, + "PutNotificationChannelRequest":{ + "type":"structure", + "required":[ + "SnsTopicArn", + "SnsRoleName" + ], + "members":{ + "SnsTopicArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic that collects notifications from AWS Firewall Manager.

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

The Amazon Resource Name (ARN) of the IAM role that allows Amazon SNS to record AWS Firewall Manager activity.

" + } + } + }, + "PutPolicyRequest":{ + "type":"structure", + "required":["Policy"], + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

The details of the AWS Firewall Manager policy to be created.

" + } + } + }, + "PutPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

The details of the AWS Firewall Manager policy that was created.

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

The Amazon Resource Name (ARN) of the policy that was created.

" + } + } + }, + "ResourceArn":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "ResourceCount":{ + "type":"long", + "min":0 + }, + "ResourceId":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "ResourceName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource was not found.

", + "exception":true + }, + "ResourceTag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The resource tag key.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The resource tag value.

" + } + }, + "documentation":"

The resource tags that AWS Firewall Manager uses to determine if a particular resource should be included or excluded from the AWS Firewall Manager policy. Tags enable you to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value. Firewall Manager combines the tags with \"AND\" so that, if you add more than one tag to a policy scope, a resource must have all the specified tags to be included or excluded. For more information, see Working with Tag Editor.

" + }, + "ResourceTags":{ + "type":"list", + "member":{"shape":"ResourceTag"}, + "max":8, + "min":0 + }, + "ResourceType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "ResourceTypeList":{ + "type":"list", + "member":{"shape":"ResourceType"} + }, + "SecurityServicePolicyData":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"SecurityServiceType", + "documentation":"

The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an AWS WAF policy, a Shield Advanced policy, or a security group policy. For security group policies, Firewall Manager supports one security group for each common policy and for each content audit policy. This is an adjustable limit that you can increase by contacting AWS Support.

" + }, + "ManagedServiceData":{ + "shape":"ManagedServiceData", + "documentation":"

Details about the service that are specific to the service type, in JSON format. For service type SHIELD_ADVANCED, this is an empty string.

  • Example: WAF

    ManagedServiceData\": \"{\\\"type\\\": \\\"WAF\\\", \\\"ruleGroups\\\": [{\\\"id\\\": \\\"12345678-1bcd-9012-efga-0987654321ab\\\", \\\"overrideAction\\\" : {\\\"type\\\": \\\"COUNT\\\"}}], \\\"defaultAction\\\": {\\\"type\\\": \\\"BLOCK\\\"}}

  • Example: SECURITY_GROUPS_COMMON

    \"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_COMMON\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_COMMON\\\",\\\"revertManualSecurityGroupChanges\\\":false,\\\"exclusiveResourceSecurityGroupManagement\\\":false,\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd\\\"}]}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}

  • Example: SECURITY_GROUPS_CONTENT_AUDIT

    \"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_CONTENT_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_CONTENT_AUDIT\\\",\\\"securityGroups\\\":[{\\\"id\\\":\\\" sg-000e55995d61a06bd \\\"}],\\\"securityGroupAction\\\":{\\\"type\\\":\\\"ALLOW\\\"}}\"},\"RemediationEnabled\":false,\"ResourceType\":\"AWS::EC2::NetworkInterface\"}

    The security group action for content audit can be ALLOW or DENY. For ALLOW, all in-scope security group rules must be within the allowed range of the policy's security group rules. For DENY, all in-scope security group rules must not contain a value or a range that matches a rule value or range in the policy security group.

  • Example: SECURITY_GROUPS_USAGE_AUDIT

    \"SecurityServicePolicyData\":{\"Type\":\"SECURITY_GROUPS_USAGE_AUDIT\",\"ManagedServiceData\":\"{\\\"type\\\":\\\"SECURITY_GROUPS_USAGE_AUDIT\\\",\\\"deleteUnusedSecurityGroups\\\":true,\\\"coalesceRedundantSecurityGroups\\\":true}\"},\"RemediationEnabled\":false,\"Resou rceType\":\"AWS::EC2::SecurityGroup\"}

" + } + }, + "documentation":"

Details about the security service that is being used to protect the resources.

" + }, + "SecurityServiceType":{ + "type":"string", + "enum":[ + "WAF", + "SHIELD_ADVANCED", + "SECURITY_GROUPS_COMMON", + "SECURITY_GROUPS_CONTENT_AUDIT", + "SECURITY_GROUPS_USAGE_AUDIT" + ] + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagValue":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TimeStamp":{"type":"timestamp"}, + "ViolationReason":{ + "type":"string", + "enum":[ + "WEB_ACL_MISSING_RULE_GROUP", + "RESOURCE_MISSING_WEB_ACL", + "RESOURCE_INCORRECT_WEB_ACL", + "RESOURCE_MISSING_SHIELD_PROTECTION", + "RESOURCE_MISSING_WEB_ACL_OR_SHIELD_PROTECTION", + "RESOURCE_MISSING_SECURITY_GROUP", + "RESOURCE_VIOLATES_AUDIT_SECURITY_GROUP", + "SECURITY_GROUP_UNUSED", + "SECURITY_GROUP_REDUNDANT" + ] + } + }, + "documentation":"AWS Firewall Manager

This is the AWS Firewall Manager API Reference. This guide is for developers who need detailed information about the AWS Firewall Manager API actions, data types, and errors. For detailed information about AWS Firewall Manager features, see the AWS Firewall Manager Developer Guide.

" +} diff --git a/aws/dist/botocore/data/forecast/2018-06-26/paginators-1.json b/aws/dist/botocore/data/forecast/2018-06-26/paginators-1.json new file mode 100644 index 00000000..1c63777f --- /dev/null +++ b/aws/dist/botocore/data/forecast/2018-06-26/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListDatasetGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DatasetGroups" + }, + "ListDatasetImportJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DatasetImportJobs" + }, + "ListDatasets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Datasets" + }, + "ListForecastExportJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ForecastExportJobs" + }, + "ListForecasts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Forecasts" + }, + "ListPredictors": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Predictors" + } + } +} diff --git a/aws/dist/botocore/data/forecast/2018-06-26/service-2.json b/aws/dist/botocore/data/forecast/2018-06-26/service-2.json new file mode 100644 index 00000000..b1dc0fd3 --- /dev/null +++ b/aws/dist/botocore/data/forecast/2018-06-26/service-2.json @@ -0,0 +1,2149 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-06-26", + "endpointPrefix":"forecast", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Forecast Service", + "serviceId":"forecast", + "signatureVersion":"v4", + "signingName":"forecast", + "targetPrefix":"AmazonForecast", + "uid":"forecast-2018-06-26" + }, + "operations":{ + "CreateDataset":{ + "name":"CreateDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetRequest"}, + "output":{"shape":"CreateDatasetResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected. Amazon Forecast uses this information when training the model and generating a forecast.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields of the dataset, including the field name and data type.

After creating a dataset, you import your training data into the dataset and add the dataset to a dataset group. You then use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

" + }, + "CreateDatasetGroup":{ + "name":"CreateDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetGroupRequest"}, + "output":{"shape":"CreateDatasetGroupResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an Amazon Forecast dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or you can add datasets later with the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can create a predictor using the dataset group. Use the DescribeDatasetGroup operation to get the status.

" + }, + "CreateDatasetImportJob":{ + "name":"CreateDatasetImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetImportJobRequest"}, + "output":{"shape":"CreateDatasetImportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles.

Two properties of the training data are optionally specified:

  • The delimiter that separates the data fields.

    The default delimiter is a comma (,), which is the only supported delimiter in this release.

  • The format of timestamps.

    If the format is not specified, Amazon Forecast expects the format to be \"yyyy-MM-dd HH:mm:ss\".

When Amazon Forecast uploads your training data, it verifies that the data was collected at the DataFrequency specified when the target dataset was created. For more information, see CreateDataset and howitworks-datasets-groups. Amazon Forecast also verifies the delimiter and timestamp format.

You can use the ListDatasetImportJobs operation to get a list of all your dataset import jobs, filtered by specified criteria.

To get a list of all your dataset import jobs, filtered by the specified criteria, use the ListDatasetGroups operation.

" + }, + "CreateForecast":{ + "name":"CreateForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateForecastRequest"}, + "output":{"shape":"CreateForecastResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3), use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon, specified in the CreatePredictor request, multiplied by the DataFrequency, specified in the CreateDataset request. When you query a forecast, you can request a specific date range within the complete forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

" + }, + "CreateForecastExportJob":{ + "name":"CreateForecastExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateForecastExportJobRequest"}, + "output":{"shape":"CreateForecastExportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. Use the DescribeForecastExportJob operation to get the status.

" + }, + "CreatePredictor":{ + "name":"CreatePredictor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePredictorRequest"}, + "output":{"shape":"CreatePredictorResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an Amazon Forecast predictor.

In the request, you provide a dataset group and either specify an algorithm or let Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the chosen algorithm to train a model using the latest version of the datasets in the specified dataset group. The result is called a predictor. You then generate a forecast using the CreateForecast operation.

After training a model, the CreatePredictor operation also evaluates it. To see the evaluation metrics, use the GetAccuracyMetrics operation. Always review the evaluation metrics before deciding to use the predictor to generate a forecast.

Optionally, you can specify a featurization configuration to fill and aggragate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

AutoML

If you set PerformAutoML to true, Amazon Forecast evaluates each algorithm and chooses the one that minimizes the objective function. The objective function is defined as the mean of the weighted p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

  • AlgorithmArn

  • HPOConfig

  • PerformHPO

  • TrainingParameters

To get a list of all your predictors, use the ListPredictors operation.

The Status of the predictor must be ACTIVE, signifying that training has completed, before you can use the predictor to create a forecast. Use the DescribePredictor operation to get the status.

" + }, + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatasetRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes an Amazon Forecast dataset created using the CreateDataset operation. To be deleted, the dataset must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDataset operation to get the status.

", + "idempotent":true + }, + "DeleteDatasetGroup":{ + "name":"DeleteDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatasetGroupRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a dataset group created using the CreateDatasetGroup operation. To be deleted, the dataset group must have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. Use the DescribeDatasetGroup operation to get the status.

The operation deletes only the dataset group, not the datasets in the group.

", + "idempotent":true + }, + "DeleteDatasetImportJob":{ + "name":"DeleteDatasetImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatasetImportJobRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a dataset import job created using the CreateDatasetImportJob operation. To be deleted, the import job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeDatasetImportJob operation to get the status.

", + "idempotent":true + }, + "DeleteForecast":{ + "name":"DeleteForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteForecastRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a forecast created using the CreateForecast operation. To be deleted, the forecast must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecast operation to get the status.

You can't delete a forecast while it is being exported.

", + "idempotent":true + }, + "DeleteForecastExportJob":{ + "name":"DeleteForecastExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteForecastExportJobRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a forecast export job created using the CreateForecastExportJob operation. To be deleted, the export job must have a status of ACTIVE or CREATE_FAILED. Use the DescribeForecastExportJob operation to get the status.

", + "idempotent":true + }, + "DeletePredictor":{ + "name":"DeletePredictor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePredictorRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a predictor created using the CreatePredictor operation. To be deleted, the predictor must have a status of ACTIVE or CREATE_FAILED. Use the DescribePredictor operation to get the status.

Any forecasts generated by the predictor will no longer be available.

", + "idempotent":true + }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the properties provided by the user in the CreateDataset request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • Status

", + "idempotent":true + }, + "DescribeDatasetGroup":{ + "name":"DescribeDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetGroupRequest"}, + "output":{"shape":"DescribeDatasetGroupResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the properties provided by the user in the CreateDatasetGroup request, this operation includes the following properties:

  • DatasetArns - The datasets belonging to the group.

  • CreationTime

  • LastModificationTime

  • Status

", + "idempotent":true + }, + "DescribeDatasetImportJob":{ + "name":"DescribeDatasetImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetImportJobRequest"}, + "output":{"shape":"DescribeDatasetImportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the properties provided by the user in the CreateDatasetImportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • DataSize

  • FieldStatistics

  • Status

  • Message - If an error occurred, information about the error.

", + "idempotent":true + }, + "DescribeForecast":{ + "name":"DescribeForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeForecastRequest"}, + "output":{"shape":"DescribeForecastResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided by the user in the CreateForecast request, this operation includes the following properties:

  • DatasetGroupArn - The dataset group that provided the training data.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

", + "idempotent":true + }, + "DescribeForecastExportJob":{ + "name":"DescribeForecastExportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeForecastExportJobRequest"}, + "output":{"shape":"DescribeForecastExportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation includes the following properties:

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

", + "idempotent":true + }, + "DescribePredictor":{ + "name":"DescribePredictor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePredictorRequest"}, + "output":{"shape":"DescribePredictorResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided by the user in the CreatePredictor request, this operation includes the following properties:

  • DatasetImportJobArns - The dataset import jobs used to import training data.

  • AutoMLAlgorithmArns - If AutoML is performed, the algorithms evaluated.

  • CreationTime

  • LastModificationTime

  • Status

  • Message - If an error occurred, information about the error.

", + "idempotent":true + }, + "GetAccuracyMetrics":{ + "name":"GetAccuracyMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccuracyMetricsRequest"}, + "output":{"shape":"GetAccuracyMetricsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast.

Metrics are generated for each backtest window evaluated. For more information, see EvaluationParameters.

The parameters of the filling method determine which items contribute to the metrics. If zero is specified, all items contribute. If nan is specified, only those items that have complete data in the range being evaluated contribute. For more information, see FeaturizationMethod.

For an example of how to train a model and review metrics, see getting-started.

", + "idempotent":true + }, + "ListDatasetGroups":{ + "name":"ListDatasetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetGroupsRequest"}, + "output":{"shape":"ListDatasetGroupsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDatasetGroup operation.

", + "idempotent":true + }, + "ListDatasetImportJobs":{ + "name":"ListDatasetImportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetImportJobsRequest"}, + "output":{"shape":"ListDatasetImportJobsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

", + "idempotent":true + }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeDataset operation.

", + "idempotent":true + }, + "ListForecastExportJobs":{ + "name":"ListForecastExportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListForecastExportJobsRequest"}, + "output":{"shape":"ListForecastExportJobsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecastExportJob operation. The list can be filtered using an array of Filter objects.

", + "idempotent":true + }, + "ListForecasts":{ + "name":"ListForecasts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListForecastsRequest"}, + "output":{"shape":"ListForecastsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of forecasts created using the CreateForecast operation. For each forecast, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribeForecast operation. The list can be filtered using an array of Filter objects.

", + "idempotent":true + }, + "ListPredictors":{ + "name":"ListPredictors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPredictorsRequest"}, + "output":{"shape":"ListPredictorsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of predictors created using the CreatePredictor operation. For each predictor, a summary of its properties, including its Amazon Resource Name (ARN), is returned. You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. The list can be filtered using an array of Filter objects.

", + "idempotent":true + }, + "UpdateDatasetGroup":{ + "name":"UpdateDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDatasetGroupRequest"}, + "output":{"shape":"UpdateDatasetGroupResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Replaces any existing datasets in the dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before creating a predictor using the dataset group. Use the DescribeDatasetGroup operation to get the status.

", + "idempotent":true + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$" + }, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "AttributeType":{ + "type":"string", + "enum":[ + "string", + "integer", + "float", + "timestamp" + ] + }, + "Boolean":{"type":"boolean"}, + "CategoricalParameterRange":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the categorical hyperparameter to tune.

" + }, + "Values":{ + "shape":"Values", + "documentation":"

A list of the tunable categories for the hyperparameter.

" + } + }, + "documentation":"

Specifies a categorical hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" + }, + "CategoricalParameterRanges":{ + "type":"list", + "member":{"shape":"CategoricalParameterRange"}, + "max":20, + "min":1 + }, + "ContinuousParameterRange":{ + "type":"structure", + "required":[ + "Name", + "MaxValue", + "MinValue" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the hyperparameter to tune.

" + }, + "MaxValue":{ + "shape":"Double", + "documentation":"

The maximum tunable value of the hyperparameter.

" + }, + "MinValue":{ + "shape":"Double", + "documentation":"

The minimum tunable value of the hyperparameter.

" + }, + "ScalingType":{ + "shape":"ScalingType", + "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

" + } + }, + "documentation":"

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" + }, + "ContinuousParameterRanges":{ + "type":"list", + "member":{"shape":"ContinuousParameterRange"}, + "max":20, + "min":1 + }, + "CreateDatasetGroupRequest":{ + "type":"structure", + "required":[ + "DatasetGroupName", + "Domain" + ], + "members":{ + "DatasetGroupName":{ + "shape":"Name", + "documentation":"

A name for the dataset group.

" + }, + "Domain":{ + "shape":"Domain", + "documentation":"

The domain associated with the dataset group. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

" + }, + "DatasetArns":{ + "shape":"ArnList", + "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

" + } + } + }, + "CreateDatasetGroupResponse":{ + "type":"structure", + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + } + } + }, + "CreateDatasetImportJobRequest":{ + "type":"structure", + "required":[ + "DatasetImportJobName", + "DatasetArn", + "DataSource" + ], + "members":{ + "DatasetImportJobName":{ + "shape":"Name", + "documentation":"

The name for the dataset import job. It is recommended to include the current timestamp in the name to guard against getting a ResourceAlreadyExistsException exception, for example, 20190721DatasetImport.

" + }, + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

" + }, + "DataSource":{ + "shape":"DataSource", + "documentation":"

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

" + }, + "TimestampFormat":{ + "shape":"TimestampFormat", + "documentation":"

The format of timestamps in the dataset. Two formats are supported, dependent on the DataFrequency specified when the dataset was created.

  • \"yyyy-MM-dd\"

    For data frequencies: Y, M, W, and D

  • \"yyyy-MM-dd HH:mm:ss\"

    For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

" + } + } + }, + "CreateDatasetImportJobResponse":{ + "type":"structure", + "members":{ + "DatasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" + } + } + }, + "CreateDatasetRequest":{ + "type":"structure", + "required":[ + "DatasetName", + "Domain", + "DatasetType", + "Schema" + ], + "members":{ + "DatasetName":{ + "shape":"Name", + "documentation":"

A name for the dataset.

" + }, + "Domain":{ + "shape":"Domain", + "documentation":"

The domain associated with the dataset. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"

The dataset type. Valid values depend on the chosen Domain.

" + }, + "DataFrequency":{ + "shape":"Frequency", + "documentation":"

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes.

" + }, + "Schema":{ + "shape":"Schema", + "documentation":"

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

" + }, + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + } + } + }, + "CreateDatasetResponse":{ + "type":"structure", + "members":{ + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" + } + } + }, + "CreateForecastExportJobRequest":{ + "type":"structure", + "required":[ + "ForecastExportJobName", + "ForecastArn", + "Destination" + ], + "members":{ + "ForecastExportJobName":{ + "shape":"Name", + "documentation":"

The name for the forecast export job.

" + }, + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast that you want to export.

" + }, + "Destination":{ + "shape":"DataDestination", + "documentation":"

The path to the Amazon S3 bucket where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the bucket.

" + } + } + }, + "CreateForecastExportJobResponse":{ + "type":"structure", + "members":{ + "ForecastExportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the export job.

" + } + } + }, + "CreateForecastRequest":{ + "type":"structure", + "required":[ + "ForecastName", + "PredictorArn" + ], + "members":{ + "ForecastName":{ + "shape":"Name", + "documentation":"

The name for the forecast.

" + }, + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

" + } + } + }, + "CreateForecastResponse":{ + "type":"structure", + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast.

" + } + } + }, + "CreatePredictorRequest":{ + "type":"structure", + "required":[ + "PredictorName", + "ForecastHorizon", + "InputDataConfig", + "FeaturizationConfig" + ], + "members":{ + "PredictorName":{ + "shape":"Name", + "documentation":"

A name for the predictor.

" + }, + "AlgorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if PerformAutoML is not set to true.

Supported algorithms

  • arn:aws:forecast:::algorithm/ARIMA

  • arn:aws:forecast:::algorithm/Deep_AR_Plus

    - supports hyperparameter optimization (HPO)

  • arn:aws:forecast:::algorithm/ETS

  • arn:aws:forecast:::algorithm/NPTS

  • arn:aws:forecast:::algorithm/Prophet

" + }, + "ForecastHorizon":{ + "shape":"Integer", + "documentation":"

Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.

For example, if you configure a dataset for daily data collection (using the DataFrequency parameter of the CreateDataset operation) and set the forecast horizon to 10, the model returns predictions for 10 days.

" + }, + "PerformAutoML":{ + "shape":"Boolean", + "documentation":"

Whether to perform AutoML. The default value is false. In this case, you are required to specify an algorithm.

If you want Amazon Forecast to evaluate the algorithms it provides and choose the best algorithm and configuration for your training dataset, set PerformAutoML to true. This is a good option if you aren't sure which algorithm is suitable for your application.

" + }, + "PerformHPO":{ + "shape":"Boolean", + "documentation":"

Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as a hyperparameter tuning job.

The default value is false. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.

To override the default values, set PerformHPO to true and supply the HyperParameterTuningJobConfig object. The tuning job specifies an objective metric, the hyperparameters to optimize, and the valid range for each hyperparameter.

The following algorithms support HPO:

  • DeepAR+

" + }, + "TrainingParameters":{ + "shape":"TrainingParameters", + "documentation":"

The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in aws-forecast-choosing-recipes.

" + }, + "EvaluationParameters":{ + "shape":"EvaluationParameters", + "documentation":"

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

" + }, + "HPOConfig":{ + "shape":"HyperParameterTuningJobConfig", + "documentation":"

Provides hyperparameter override values for the algorithm. If you don't provide this parameter, Amazon Forecast uses default values. The individual algorithms specify which hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Describes the dataset group that contains the data to use to train the predictor.

" + }, + "FeaturizationConfig":{ + "shape":"FeaturizationConfig", + "documentation":"

The featurization configuration.

" + }, + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + } + } + }, + "CreatePredictorResponse":{ + "type":"structure", + "members":{ + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the predictor.

" + } + } + }, + "DataDestination":{ + "type":"structure", + "required":["S3Config"], + "members":{ + "S3Config":{ + "shape":"S3Config", + "documentation":"

The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

" + } + }, + "documentation":"

The destination of an exported forecast and credentials to access the location. This object is submitted in the CreateForecastExportJob request.

" + }, + "DataSource":{ + "type":"structure", + "required":["S3Config"], + "members":{ + "S3Config":{ + "shape":"S3Config", + "documentation":"

The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

" + } + }, + "documentation":"

The source of your training data and credentials to access the data. This object is submitted in the CreateDatasetImportJob request.

" + }, + "DatasetGroupSummary":{ + "type":"structure", + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "DatasetGroupName":{ + "shape":"Name", + "documentation":"

The name of the dataset group.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the datase group was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current query time.

" + } + }, + "documentation":"

Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the listed DatasetGroupArn.

" + }, + "DatasetGroups":{ + "type":"list", + "member":{"shape":"DatasetGroupSummary"} + }, + "DatasetImportJobSummary":{ + "type":"structure", + "members":{ + "DatasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" + }, + "DatasetImportJobName":{ + "shape":"Name", + "documentation":"

The name of the dataset import job.

" + }, + "DataSource":{ + "shape":"DataSource", + "documentation":"

The location of the Amazon S3 bucket that contains the training data.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset import job was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Dependent on the status as follows:

  • CREATE_PENDING - same as CreationTime

  • CREATE_IN_PROGRESS - the current timestamp

  • ACTIVE or CREATE_FAILED - when the job finished or failed

" + } + }, + "documentation":"

Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the listed DatasetImportJobArn.

" + }, + "DatasetImportJobs":{ + "type":"list", + "member":{"shape":"DatasetImportJobSummary"} + }, + "DatasetSummary":{ + "type":"structure", + "members":{ + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" + }, + "DatasetName":{ + "shape":"Name", + "documentation":"

The name of the dataset.

" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"

The dataset type.

" + }, + "Domain":{ + "shape":"Domain", + "documentation":"

The domain associated with the dataset.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset is created, LastModificationTime is the same as CreationTime. After a CreateDatasetImportJob operation is called, LastModificationTime is when the import job finished or failed. While data is being imported to the dataset, LastModificationTime is the current query time.

" + } + }, + "documentation":"

Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the listed DatasetArn.

" + }, + "DatasetType":{ + "type":"string", + "enum":[ + "TARGET_TIME_SERIES", + "RELATED_TIME_SERIES", + "ITEM_METADATA" + ] + }, + "Datasets":{ + "type":"list", + "member":{"shape":"DatasetSummary"} + }, + "DeleteDatasetGroupRequest":{ + "type":"structure", + "required":["DatasetGroupArn"], + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group to delete.

" + } + } + }, + "DeleteDatasetImportJobRequest":{ + "type":"structure", + "required":["DatasetImportJobArn"], + "members":{ + "DatasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job to delete.

" + } + } + }, + "DeleteDatasetRequest":{ + "type":"structure", + "required":["DatasetArn"], + "members":{ + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset to delete.

" + } + } + }, + "DeleteForecastExportJobRequest":{ + "type":"structure", + "required":["ForecastExportJobArn"], + "members":{ + "ForecastExportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast export job to delete.

" + } + } + }, + "DeleteForecastRequest":{ + "type":"structure", + "required":["ForecastArn"], + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast to delete.

" + } + } + }, + "DeletePredictorRequest":{ + "type":"structure", + "required":["PredictorArn"], + "members":{ + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the predictor to delete.

" + } + } + }, + "DescribeDatasetGroupRequest":{ + "type":"structure", + "required":["DatasetGroupArn"], + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + } + } + }, + "DescribeDatasetGroupResponse":{ + "type":"structure", + "members":{ + "DatasetGroupName":{ + "shape":"Name", + "documentation":"

The name of the dataset group.

" + }, + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset group.

" + }, + "DatasetArns":{ + "shape":"ArnList", + "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

" + }, + "Domain":{ + "shape":"Domain", + "documentation":"

The domain associated with the dataset group. The Domain and DatasetType that you choose determine the fields that must be present in the training data that you import to the dataset. For example, if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon Forecast requires item_id, timestamp, and demand fields to be present in your data. For more information, see howitworks-datasets-groups.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the dataset group. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply when the UpdateDatasetGroup operation is called.

The Status of the dataset group must be ACTIVE before creating a predictor using the dataset group.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset group was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current query time.

" + } + } + }, + "DescribeDatasetImportJobRequest":{ + "type":"structure", + "required":["DatasetImportJobArn"], + "members":{ + "DatasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" + } + } + }, + "DescribeDatasetImportJobResponse":{ + "type":"structure", + "members":{ + "DatasetImportJobName":{ + "shape":"Name", + "documentation":"

The name of the dataset import job.

" + }, + "DatasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset import job.

" + }, + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

" + }, + "TimestampFormat":{ + "shape":"TimestampFormat", + "documentation":"

The format of timestamps in the dataset. Two formats are supported dependent on the DataFrequency specified when the dataset was created.

  • \"yyyy-MM-dd\"

    For data frequencies: Y, M, W, and D

  • \"yyyy-MM-dd HH:mm:ss\"

    For data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

" + }, + "DataSource":{ + "shape":"DataSource", + "documentation":"

The location of the training data to import. The training data must be stored in an Amazon S3 bucket.

" + }, + "FieldStatistics":{ + "shape":"FieldStatistics", + "documentation":"

Statistical information about each field in the input data.

" + }, + "DataSize":{ + "shape":"Double", + "documentation":"

The size of the dataset in gigabytes (GB) after completion of the import job.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

" + }, + "Message":{ + "shape":"Message", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset import job was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Dependent on the status as follows:

  • CREATE_PENDING - same as CreationTime

  • CREATE_IN_PROGRESS - the current timestamp

  • ACTIVE or CREATE_FAILED - when the job finished or failed

" + } + } + }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":["DatasetArn"], + "members":{ + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" + } + } + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "DatasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" + }, + "DatasetName":{ + "shape":"Name", + "documentation":"

The name of the dataset.

" + }, + "Domain":{ + "shape":"Domain", + "documentation":"

The dataset domain.

" + }, + "DatasetType":{ + "shape":"DatasetType", + "documentation":"

The dataset type.

" + }, + "DataFrequency":{ + "shape":"Frequency", + "documentation":"

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"M\" indicates every month and \"30min\" indicates every 30 minutes.

" + }, + "Schema":{ + "shape":"Schema", + "documentation":"

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

" + }, + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the dataset. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation. During this time, the status reflects the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

The Status of the dataset must be ACTIVE before you can import training data.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the dataset is created, LastModificationTime is the same as CreationTime. After a CreateDatasetImportJob operation is called, LastModificationTime is when the import job finished or failed. While data is being imported to the dataset, LastModificationTime is the current query time.

" + } + } + }, + "DescribeForecastExportJobRequest":{ + "type":"structure", + "required":["ForecastExportJobArn"], + "members":{ + "ForecastExportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast export job.

" + } + } + }, + "DescribeForecastExportJobResponse":{ + "type":"structure", + "members":{ + "ForecastExportJobArn":{ + "shape":"Arn", + "documentation":"

The ARN of the forecast export job.

" + }, + "ForecastExportJobName":{ + "shape":"Name", + "documentation":"

The name of the forecast export job.

" + }, + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the exported forecast.

" + }, + "Destination":{ + "shape":"DataDestination", + "documentation":"

The path to the AWS S3 bucket where the forecast is exported.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the forecast export job. One of the following states:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the forecast export job was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the last successful export job finished.

" + } + } + }, + "DescribeForecastRequest":{ + "type":"structure", + "required":["ForecastArn"], + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast.

" + } + } + }, + "DescribeForecastResponse":{ + "type":"structure", + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The same forecast ARN as given in the request.

" + }, + "ForecastName":{ + "shape":"Name", + "documentation":"

The name of the forecast.

" + }, + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The ARN of the predictor used to generate the forecast.

" + }, + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset group that provided the data used to train the predictor.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the forecast creation task was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

" + } + } + }, + "DescribePredictorRequest":{ + "type":"structure", + "required":["PredictorArn"], + "members":{ + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the predictor that you want information about.

" + } + } + }, + "DescribePredictorResponse":{ + "type":"structure", + "members":{ + "PredictorArn":{ + "shape":"Name", + "documentation":"

The ARN of the predictor.

" + }, + "PredictorName":{ + "shape":"Name", + "documentation":"

The name of the predictor.

" + }, + "AlgorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm used for model training.

" + }, + "ForecastHorizon":{ + "shape":"Integer", + "documentation":"

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

" + }, + "PerformAutoML":{ + "shape":"Boolean", + "documentation":"

Whether the predictor is set to perform AutoML.

" + }, + "PerformHPO":{ + "shape":"Boolean", + "documentation":"

Whether the predictor is set to perform HPO.

" + }, + "TrainingParameters":{ + "shape":"TrainingParameters", + "documentation":"

The training parameters to override for model training. The parameters that you can override are listed in the individual algorithms in aws-forecast-choosing-recipes.

" + }, + "EvaluationParameters":{ + "shape":"EvaluationParameters", + "documentation":"

Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

" + }, + "HPOConfig":{ + "shape":"HyperParameterTuningJobConfig", + "documentation":"

The hyperparameter override values for the algorithm.

" + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

Describes the dataset group that contains the data to use to train the predictor.

" + }, + "FeaturizationConfig":{ + "shape":"FeaturizationConfig", + "documentation":"

The featurization configuration.

" + }, + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + }, + "DatasetImportJobArns":{ + "shape":"ArnList", + "documentation":"

An array of ARNs of the dataset import jobs used to import training data for the predictor.

" + }, + "AutoMLAlgorithmArns":{ + "shape":"ArnList", + "documentation":"

When PerformAutoML is specified, the ARN of the chosen algorithm.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The Status of the predictor must be ACTIVE before using the predictor to create a forecast.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the model training task was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

" + } + } + }, + "Domain":{ + "type":"string", + "enum":[ + "RETAIL", + "CUSTOM", + "INVENTORY_PLANNING", + "EC2_CAPACITY", + "WORK_FORCE", + "WEB_TRAFFIC", + "METRICS" + ] + }, + "Double":{"type":"double"}, + "EncryptionConfig":{ + "type":"structure", + "required":[ + "RoleArn", + "KMSKeyArn" + ], + "members":{ + "RoleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the AWS KMS key.

Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an InvalidInputException is thrown.

" + }, + "KMSKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

" + } + }, + "documentation":"

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. This object is optionally submitted in the CreateDataset and CreatePredictor requests.

" + }, + "ErrorMessage":{"type":"string"}, + "EvaluationParameters":{ + "type":"structure", + "members":{ + "NumberOfBacktestWindows":{ + "shape":"Integer", + "documentation":"

The number of times to split the input data. The default is 1. The range is 1 through 5.

" + }, + "BackTestWindowOffset":{ + "shape":"Integer", + "documentation":"

The point from the end of the dataset where you want to split the data for model training and evaluation. The value is specified as the number of data points.

" + } + }, + "documentation":"

Parameters that define how to split a dataset into training data and testing data, and the number of iterations to perform. These parameters are specified in the predefined algorithms and can be overridden in the CreatePredictor request.

For example, suppose that you have a dataset with data collection frequency set to every day and you have 200 days worth of data (that is, 200 data points). Now suppose that you set the NumberOfBacktestWindows to 2 and the BackTestWindowOffset parameter to 20. The algorithm splits the data twice. The first time, the algorithm trains the model using the first 180 data points and uses the last 20 data points for evaluation. The second time, the algorithm trains the model using the first 160 data points and uses the last 40 data points for evaluation.

" + }, + "EvaluationResult":{ + "type":"structure", + "members":{ + "AlgorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

" + }, + "TestWindows":{ + "shape":"TestWindows", + "documentation":"

The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.

" + } + }, + "documentation":"

The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics response.

" + }, + "EvaluationType":{ + "type":"string", + "enum":[ + "SUMMARY", + "COMPUTED" + ] + }, + "Featurization":{ + "type":"structure", + "required":["AttributeName"], + "members":{ + "AttributeName":{ + "shape":"Name", + "documentation":"

The name of the schema attribute specifying the data field to be featurized. In this release, only the target field of the TARGET_TIME_SERIES dataset type is supported. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value.

" + }, + "FeaturizationPipeline":{ + "shape":"FeaturizationPipeline", + "documentation":"

An array FeaturizationMethod objects that specifies the feature transformation methods. For this release, the number of methods is limited to one.

" + } + }, + "documentation":"

Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

For example:

{

\"AttributeName\": \"demand\",

FeaturizationPipeline [ {

\"FeaturizationMethodName\": \"filling\",

\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}

} ]

}

" + }, + "FeaturizationConfig":{ + "type":"structure", + "required":["ForecastFrequency"], + "members":{ + "ForecastFrequency":{ + "shape":"Frequency", + "documentation":"

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

" + }, + "ForecastDimensions":{ + "shape":"ForecastDimensions", + "documentation":"

An array of dimension (field) names that specify how to group the generated forecast.

For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

" + }, + "Featurizations":{ + "shape":"Featurizations", + "documentation":"

An array of featurization (transformation) information for the fields of a dataset. In this release, only a single featurization is supported.

" + } + }, + "documentation":"

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES dataset before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.

" + }, + "FeaturizationMethod":{ + "type":"structure", + "required":["FeaturizationMethodName"], + "members":{ + "FeaturizationMethodName":{ + "shape":"FeaturizationMethodName", + "documentation":"

The name of the method. In this release, \"filling\" is the only supported method.

" + }, + "FeaturizationMethodParameters":{ + "shape":"FeaturizationMethodParameters", + "documentation":"

The method parameters (key-value pairs). Specify these to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

  • aggregation: sum, avg, first, min, max

  • frontfill: none

  • middlefill: zero, nan (not a number)

  • backfill: zero, nan

" + } + }, + "documentation":"

Provides information about a method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object. If FeaturizationMethodParameters isn't specified, Amazon Forecast uses default parameters.

For example:

{

\"FeaturizationMethodName\": \"filling\",

\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}

}

" + }, + "FeaturizationMethodName":{ + "type":"string", + "enum":["filling"] + }, + "FeaturizationMethodParameters":{ + "type":"map", + "key":{"shape":"ParameterKey"}, + "value":{"shape":"ParameterValue"}, + "max":20, + "min":1 + }, + "FeaturizationPipeline":{ + "type":"list", + "member":{"shape":"FeaturizationMethod"}, + "max":1, + "min":1 + }, + "Featurizations":{ + "type":"list", + "member":{"shape":"Featurization"}, + "max":1, + "min":1 + }, + "FieldStatistics":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Statistics"} + }, + "Filter":{ + "type":"structure", + "required":[ + "Key", + "Value", + "Condition" + ], + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The name of the parameter to filter on.

" + }, + "Value":{ + "shape":"Arn", + "documentation":"

A valid value for Key.

" + }, + "Condition":{ + "shape":"FilterConditionString", + "documentation":"

The condition to apply.

" + } + }, + "documentation":"

Describes a filter for choosing a subset of objects. Each filter consists of a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, the objects that match the statement. The match statement consists of a key and a value.

" + }, + "FilterConditionString":{ + "type":"string", + "enum":[ + "IS", + "IS_NOT" + ] + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "ForecastDimensions":{ + "type":"list", + "member":{"shape":"Name"}, + "max":5, + "min":1 + }, + "ForecastExportJobSummary":{ + "type":"structure", + "members":{ + "ForecastExportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast export job.

" + }, + "ForecastExportJobName":{ + "shape":"Name", + "documentation":"

The name of the forecast export job.

" + }, + "Destination":{ + "shape":"DataDestination", + "documentation":"

The path to the S3 bucket where the forecast is stored.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the forecast export job. One of the following states:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the forecast export job was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

When the last successful export job finished.

" + } + }, + "documentation":"

Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn.

" + }, + "ForecastExportJobs":{ + "type":"list", + "member":{"shape":"ForecastExportJobSummary"} + }, + "ForecastSummary":{ + "type":"structure", + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The ARN of the forecast.

" + }, + "ForecastName":{ + "shape":"Name", + "documentation":"

The name of the forecast.

" + }, + "PredictorArn":{ + "shape":"String", + "documentation":"

The ARN of the predictor used to generate the forecast.

" + }, + "DatasetGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that provided the data used to train the predictor.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the forecast. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the forecast creation task was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

" + } + }, + "documentation":"

Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the listed ForecastArn.

" + }, + "Forecasts":{ + "type":"list", + "member":{"shape":"ForecastSummary"} + }, + "Frequency":{ + "type":"string", + "pattern":"^Y|M|W|D|H|30min|15min|10min|5min|1min$" + }, + "GetAccuracyMetricsRequest":{ + "type":"structure", + "required":["PredictorArn"], + "members":{ + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the predictor to get metrics for.

" + } + } + }, + "GetAccuracyMetricsResponse":{ + "type":"structure", + "members":{ + "PredictorEvaluationResults":{ + "shape":"PredictorEvaluationResults", + "documentation":"

An array of results from evaluating the predictor.

" + } + } + }, + "HyperParameterTuningJobConfig":{ + "type":"structure", + "members":{ + "ParameterRanges":{ + "shape":"ParameterRanges", + "documentation":"

Specifies the ranges of valid values for the hyperparameters.

" + } + }, + "documentation":"

Configuration information for a hyperparameter tuning job. This object is specified in the CreatePredictor request.

A hyperparameter is a parameter that governs the model training process and is set before training starts. This is as opposed to a model parameter that is determined during training. The values of the hyperparameters have an effect on the chosen model parameters.

A hyperparameter tuning job is the process of choosing the optimum set of hyperparameter values that optimize a specified metric. This is accomplished by running many training jobs over a range of hyperparameter values. The optimum set of values is dependent on the algorithm, the training data, and the given metric objective.

" + }, + "InputDataConfig":{ + "type":"structure", + "required":["DatasetGroupArn"], + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "SupplementaryFeatures":{ + "shape":"SupplementaryFeatures", + "documentation":"

An array of supplementary features. For this release, the only supported feature is a holiday calendar.

" + } + }, + "documentation":"

The data used to train a predictor. The data includes a dataset group and any supplementary features. This object is specified in the CreatePredictor request.

" + }, + "Integer":{"type":"integer"}, + "IntegerParameterRange":{ + "type":"structure", + "required":[ + "Name", + "MaxValue", + "MinValue" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the hyperparameter to tune.

" + }, + "MaxValue":{ + "shape":"Integer", + "documentation":"

The maximum tunable value of the hyperparameter.

" + }, + "MinValue":{ + "shape":"Integer", + "documentation":"

The minimum tunable value of the hyperparameter.

" + }, + "ScalingType":{ + "shape":"ScalingType", + "documentation":"

The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

Auto

Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.

Linear

Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

Logarithmic

Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

Logarithmic scaling works only for ranges that have only values greater than 0.

ReverseLogarithmic

Not supported for IntegerParameterRange.

Reverse logarithmic scaling works only for ranges that are entirely within the range 0 <= x < 1.0.

" + } + }, + "documentation":"

Specifies an integer hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

" + }, + "IntegerParameterRanges":{ + "type":"list", + "member":{"shape":"IntegerParameterRange"}, + "max":20, + "min":1 + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

We can't process the request because it includes an invalid value or a value that exceeds the valid range.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The token is not valid. Tokens expire after 24 hours.

", + "exception":true + }, + "KMSKeyArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws:kms:.*:key/.*" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The limit on the number of requests per second has been exceeded.

", + "exception":true + }, + "ListDatasetGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + } + } + }, + "ListDatasetGroupsResponse":{ + "type":"structure", + "members":{ + "DatasetGroups":{ + "shape":"DatasetGroups", + "documentation":"

An array of objects that summarize each dataset group's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "ListDatasetImportJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, Name is the only valid key, which filters on the DatasetImportJobName property.

  • Condition - IS or IS_NOT

  • Key - Name

  • Value - the value to match

For example, to list all dataset import jobs named my_dataset_import_job, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_dataset_import_job\" } ]

" + } + } + }, + "ListDatasetImportJobsResponse":{ + "type":"structure", + "members":{ + "DatasetImportJobs":{ + "shape":"DatasetImportJobs", + "documentation":"

An array of objects that summarize each dataset import job's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "ListDatasetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + } + } + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "Datasets":{ + "shape":"Datasets", + "documentation":"

An array of objects that summarize each dataset's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "ListForecastExportJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, Name is the only valid key, which filters on the ForecastExportJobName property.

  • Condition - IS or IS_NOT

  • Key - Name

  • Value - the value to match

For example, to list all forecast export jobs named my_forecast_export_job, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_forecast_export_job\" } ]

" + } + } + }, + "ListForecastExportJobsResponse":{ + "type":"structure", + "members":{ + "ForecastExportJobs":{ + "shape":"ForecastExportJobs", + "documentation":"

An array of objects that summarize each export job's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "ListForecastsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, Name is the only valid key, which filters on the ForecastName property.

  • Condition - IS or IS_NOT

  • Key - Name

  • Value - the value to match

For example, to list all forecasts named my_forecast, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_forecast\" } ]

" + } + } + }, + "ListForecastsResponse":{ + "type":"structure", + "members":{ + "Forecasts":{ + "shape":"Forecasts", + "documentation":"

An array of objects that summarize each forecast's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "ListPredictorsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of items to return in the response.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude, respectively, from the list, the predictors that match the statement. The match statement consists of a key and a value. In this release, Name is the only valid key, which filters on the PredictorName property.

  • Condition - IS or IS_NOT

  • Key - Name

  • Value - the value to match

For example, to list all predictors named my_predictor, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Name\", \"Value\": \"my_predictor\" } ]

" + } + } + }, + "ListPredictorsResponse":{ + "type":"structure", + "members":{ + "Predictors":{ + "shape":"Predictors", + "documentation":"

An array of objects that summarize each predictor's properties.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Message":{"type":"string"}, + "Metrics":{ + "type":"structure", + "members":{ + "RMSE":{ + "shape":"Double", + "documentation":"

The root mean square error (RMSE).

" + }, + "WeightedQuantileLosses":{ + "shape":"WeightedQuantileLosses", + "documentation":"

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

" + } + }, + "documentation":"

Provides metrics used to evaluate the performance of a predictor. This object is part of the WindowSummary object.

" + }, + "Name":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_]*" + }, + "NextToken":{ + "type":"string", + "max":3000, + "min":1 + }, + "ParameterKey":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\\]+$" + }, + "ParameterRanges":{ + "type":"structure", + "members":{ + "CategoricalParameterRanges":{ + "shape":"CategoricalParameterRanges", + "documentation":"

Specifies the tunable range for each categorical hyperparameter.

" + }, + "ContinuousParameterRanges":{ + "shape":"ContinuousParameterRanges", + "documentation":"

Specifies the tunable range for each continuous hyperparameter.

" + }, + "IntegerParameterRanges":{ + "shape":"IntegerParameterRanges", + "documentation":"

Specifies the tunable range for each integer hyperparameter.

" + } + }, + "documentation":"

Specifies the categorical, continuous, and integer hyperparameters, and their ranges of tunable values. The range of tunable values determines which values that a hyperparameter tuning job can choose for the specified hyperparameter. This object is part of the HyperParameterTuningJobConfig object.

" + }, + "ParameterValue":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\[\\]\\,\\\"\\\\\\s]+$" + }, + "PredictorEvaluationResults":{ + "type":"list", + "member":{"shape":"EvaluationResult"} + }, + "PredictorSummary":{ + "type":"structure", + "members":{ + "PredictorArn":{ + "shape":"Arn", + "documentation":"

The ARN of the predictor.

" + }, + "PredictorName":{ + "shape":"Name", + "documentation":"

The name of the predictor.

" + }, + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the predictor. States include:

  • ACTIVE

  • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

  • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

  • UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED

The Status of the predictor must be ACTIVE before using the predictor to create a forecast.

" + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, an informational message about the error.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

When the model training task was created.

" + }, + "LastModificationTime":{ + "shape":"Timestamp", + "documentation":"

Initially, the same as CreationTime (status is CREATE_PENDING). Updated when training starts (status changed to CREATE_IN_PROGRESS), and when training is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).

" + } + }, + "documentation":"

Provides a summary of the predictor properties used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn.

" + }, + "Predictors":{ + "type":"list", + "member":{"shape":"PredictorSummary"} + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

There is already a resource with that Amazon Resource Name (ARN). Try again with a different ARN.

", + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource is in use.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.

", + "exception":true + }, + "S3Config":{ + "type":"structure", + "required":[ + "Path", + "RoleArn" + ], + "members":{ + "Path":{ + "shape":"S3Path", + "documentation":"

The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) in an Amazon S3 bucket.

" + }, + "RoleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or file(s).

Cross-account pass role is not allowed. If you pass a role that doesn't belong to your account, an InvalidInputException is thrown.

" + }, + "KMSKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.

" + } + }, + "documentation":"

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob and CreateForecastExportJob requests.

" + }, + "S3Path":{ + "type":"string", + "pattern":"^s3://.+$" + }, + "ScalingType":{ + "type":"string", + "enum":[ + "Auto", + "Linear", + "Logarithmic", + "ReverseLogarithmic" + ] + }, + "Schema":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"SchemaAttributes", + "documentation":"

An array of attributes specifying the name and type of each field in a dataset.

" + } + }, + "documentation":"

Defines the fields of a dataset. This object is specified in the CreateDataset request.

" + }, + "SchemaAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"Name", + "documentation":"

The name of the dataset field.

" + }, + "AttributeType":{ + "shape":"AttributeType", + "documentation":"

The data type of the field.

" + } + }, + "documentation":"

An attribute of a schema, which defines a field of a dataset. A schema attribute is required for every field in a dataset. The Schema object contains an array of SchemaAttribute objects.

" + }, + "SchemaAttributes":{ + "type":"list", + "member":{"shape":"SchemaAttribute"} + }, + "Statistics":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"Integer", + "documentation":"

The number of values in the field.

" + }, + "CountDistinct":{ + "shape":"Integer", + "documentation":"

The number of distinct values in the field.

" + }, + "CountNull":{ + "shape":"Integer", + "documentation":"

The number of null values in the field.

" + }, + "CountNan":{ + "shape":"Integer", + "documentation":"

The number of NAN (not a number) values in the field.

" + }, + "Min":{ + "shape":"String", + "documentation":"

For a numeric field, the minimum value in the field.

" + }, + "Max":{ + "shape":"String", + "documentation":"

For a numeric field, the maximum value in the field.

" + }, + "Avg":{ + "shape":"Double", + "documentation":"

For a numeric field, the average value in the field.

" + }, + "Stddev":{ + "shape":"Double", + "documentation":"

For a numeric field, the standard deviation.

" + } + }, + "documentation":"

Provides statistics for each data field imported to an Amazon Forecast dataset with the CreateDatasetImportJob operation.

" + }, + "Status":{ + "type":"string", + "max":256 + }, + "String":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\_]+$" + }, + "SupplementaryFeature":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The name of the feature. This must be \"holiday\".

" + }, + "Value":{ + "shape":"Value", + "documentation":"

One of the following 2 letter country codes:

  • \"AU\" - AUSTRALIA

  • \"DE\" - GERMANY

  • \"JP\" - JAPAN

  • \"US\" - UNITED_STATES

  • \"UK\" - UNITED_KINGDOM

" + } + }, + "documentation":"

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.

For this release, the only supported feature is a holiday calendar. If the calendar is used, all data should belong to the same country as the calendar. For the calendar data, see http://jollyday.sourceforge.net/data.html.

" + }, + "SupplementaryFeatures":{ + "type":"list", + "member":{"shape":"SupplementaryFeature"}, + "max":1, + "min":1 + }, + "TestWindows":{ + "type":"list", + "member":{"shape":"WindowSummary"} + }, + "Timestamp":{"type":"timestamp"}, + "TimestampFormat":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\-\\:\\.\\,\\'\\s]+$" + }, + "TrainingParameters":{ + "type":"map", + "key":{"shape":"ParameterKey"}, + "value":{"shape":"ParameterValue"}, + "max":100, + "min":0 + }, + "UpdateDatasetGroupRequest":{ + "type":"structure", + "required":[ + "DatasetGroupArn", + "DatasetArns" + ], + "members":{ + "DatasetGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset group.

" + }, + "DatasetArns":{ + "shape":"ArnList", + "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets to add to the dataset group.

" + } + } + }, + "UpdateDatasetGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "Value":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\_\\-]+$" + }, + "Values":{ + "type":"list", + "member":{"shape":"Value"}, + "max":20, + "min":1 + }, + "WeightedQuantileLoss":{ + "type":"structure", + "members":{ + "Quantile":{ + "shape":"Double", + "documentation":"

The quantile. Quantiles divide a probability distribution into regions of equal probability. For example, if the distribution was divided into 5 regions of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8.

" + }, + "LossValue":{ + "shape":"Double", + "documentation":"

The difference between the predicted value and actual value over the quantile, weighted (normalized) by dividing by the sum over all quantiles.

" + } + }, + "documentation":"

The weighted loss value for a quantile. This object is part of the Metrics object.

" + }, + "WeightedQuantileLosses":{ + "type":"list", + "member":{"shape":"WeightedQuantileLoss"} + }, + "WindowSummary":{ + "type":"structure", + "members":{ + "TestWindowStart":{ + "shape":"Timestamp", + "documentation":"

The timestamp that defines the start of the window.

" + }, + "TestWindowEnd":{ + "shape":"Timestamp", + "documentation":"

The timestamp that defines the end of the window.

" + }, + "ItemCount":{ + "shape":"Integer", + "documentation":"

The number of data points within the window.

" + }, + "EvaluationType":{ + "shape":"EvaluationType", + "documentation":"

The type of evaluation.

  • SUMMARY - The average metrics across all windows.

  • COMPUTED - The metrics for the specified window.

" + }, + "Metrics":{"shape":"Metrics"} + }, + "documentation":"

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.

" + } + }, + "documentation":"

Provides APIs for creating and managing Amazon Forecast resources.

" +} diff --git a/aws/dist/botocore/data/forecastquery/2018-06-26/paginators-1.json b/aws/dist/botocore/data/forecastquery/2018-06-26/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/forecastquery/2018-06-26/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/forecastquery/2018-06-26/service-2.json b/aws/dist/botocore/data/forecastquery/2018-06-26/service-2.json new file mode 100644 index 00000000..94aac8e5 --- /dev/null +++ b/aws/dist/botocore/data/forecastquery/2018-06-26/service-2.json @@ -0,0 +1,190 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-06-26", + "endpointPrefix":"forecastquery", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Forecast Query Service", + "serviceId":"forecastquery", + "signatureVersion":"v4", + "signingName":"forecast", + "targetPrefix":"AmazonForecastRuntime", + "uid":"forecastquery-2018-06-26" + }, + "operations":{ + "QueryForecast":{ + "name":"QueryForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"QueryForecastRequest"}, + "output":{"shape":"QueryForecastResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Retrieves a forecast filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, the complete date range of the filtered forecast is returned. Optionally, you can request a specific date range within the forecast.

The forecasts generated by Amazon Forecast are in the same timezone as the dataset that was used to create the predictor.

" + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":256, + "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" + }, + "AttributeName":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9\\_\\-]+$" + }, + "AttributeValue":{ + "type":"string", + "max":256 + }, + "DataPoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The timestamp of the specific forecast.

" + }, + "Value":{ + "shape":"Double", + "documentation":"

The forecast value.

" + } + }, + "documentation":"

The forecast value for a specific date. Part of the Forecast object.

" + }, + "DateTime":{ + "type":"string", + "max":20, + "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" + }, + "Double":{"type":"double"}, + "ErrorMessage":{"type":"string"}, + "Filters":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "max":50, + "min":1 + }, + "Forecast":{ + "type":"structure", + "members":{ + "Predictions":{ + "shape":"Predictions", + "documentation":"

The forecast.

The string of the string to array map is one of the following values:

  • mean

  • p10

  • p50

  • p90

" + } + }, + "documentation":"

Provides information about a forecast. Returned as part of the QueryForecast response.

" + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The value that you provided was invalid or too long.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The token is not valid. Tokens expire after 24 hours.

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The limit on the number of requests per second has been exceeded.

", + "exception":true + }, + "NextToken":{ + "type":"string", + "max":3000, + "min":1 + }, + "Predictions":{ + "type":"map", + "key":{"shape":"Statistic"}, + "value":{"shape":"TimeSeries"} + }, + "QueryForecastRequest":{ + "type":"structure", + "required":[ + "ForecastArn", + "Filters" + ], + "members":{ + "ForecastArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the forecast to query.

" + }, + "StartDate":{ + "shape":"DateTime", + "documentation":"

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format) For example, \"1970-01-01T00:00:00Z.\"

" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss'Z' (ISO 8601 format). For example, \"1970-01-01T00:00:00Z.\"

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

The filtering criteria to apply when retrieving the forecast. For example:

  • To get a forecast for a specific item specify the following:

    {\"item_id\" : \"client_1\"}

  • To get a forecast for a specific item sold in a specific location, specify the following:

    {\"item_id\" : \"client_1\", \"location\" : \"ny\"}

  • To get a forecast for all blue items sold in a specific location, specify the following:

    { \"location\" : \"ny\", \"color\":\"blue\"}

To get the full forecast, use the operation.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

" + } + } + }, + "QueryForecastResponse":{ + "type":"structure", + "members":{ + "Forecast":{ + "shape":"Forecast", + "documentation":"

The forecast.

" + } + } + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource is in use.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

We can't find that resource. Check the information that you've provided and try again.

", + "exception":true + }, + "Statistic":{ + "type":"string", + "max":4 + }, + "TimeSeries":{ + "type":"list", + "member":{"shape":"DataPoint"} + }, + "Timestamp":{ + "type":"string", + "max":20, + "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$" + } + }, + "documentation":"

Provides APIs for creating and managing Amazon Forecast resources.

" +} diff --git a/aws/dist/botocore/data/fsx/2018-03-01/paginators-1.json b/aws/dist/botocore/data/fsx/2018-03-01/paginators-1.json new file mode 100644 index 00000000..863c57a3 --- /dev/null +++ b/aws/dist/botocore/data/fsx/2018-03-01/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeBackups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Backups" + }, + "DescribeFileSystems": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FileSystems" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/fsx/2018-03-01/service-2.json b/aws/dist/botocore/data/fsx/2018-03-01/service-2.json new file mode 100644 index 00000000..79834835 --- /dev/null +++ b/aws/dist/botocore/data/fsx/2018-03-01/service-2.json @@ -0,0 +1,1554 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-03-01", + "endpointPrefix":"fsx", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon FSx", + "serviceId":"FSx", + "signatureVersion":"v4", + "targetPrefix":"AWSSimbaAPIService_v20180301", + "uid":"fsx-2018-03-01" + }, + "operations":{ + "CreateBackup":{ + "name":"CreateBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBackupRequest"}, + "output":{"shape":"CreateBackupResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"UnsupportedOperation"}, + {"shape":"FileSystemNotFound"}, + {"shape":"BackupInProgress"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

", + "idempotent":true + }, + "CreateFileSystem":{ + "name":"CreateFileSystem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFileSystemRequest"}, + "output":{"shape":"CreateFileSystemResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"ActiveDirectoryError"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InvalidImportPath"}, + {"shape":"InvalidExportPath"}, + {"shape":"InvalidNetworkSettings"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"MissingFileSystemConfiguration"} + ], + "documentation":"

Creates a new, empty Amazon FSx file system.

If a file system with the specified client request token exists and the parameters match, CreateFileSystem returns the description of the existing file system. If a file system specified client request token exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, CreateFileSystem does the following:

  • Creates a new, empty Amazon FSx file system with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

This operation requires a client request token in the request that Amazon FSx uses to ensure idempotent creation. This means that calling the operation multiple times with the same client request token has no effect. By using the idempotent operation, you can retry a CreateFileSystem operation without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystem call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

" + }, + "CreateFileSystemFromBackup":{ + "name":"CreateFileSystemFromBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFileSystemFromBackupRequest"}, + "output":{"shape":"CreateFileSystemFromBackupResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"ActiveDirectoryError"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InvalidNetworkSettings"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"BackupNotFound"}, + {"shape":"InternalServerError"}, + {"shape":"MissingFileSystemConfiguration"} + ], + "documentation":"

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

" + }, + "DeleteBackup":{ + "name":"DeleteBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBackupRequest"}, + "output":{"shape":"DeleteBackupResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"BackupInProgress"}, + {"shape":"BackupNotFound"}, + {"shape":"BackupRestoring"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

", + "idempotent":true + }, + "DeleteFileSystem":{ + "name":"DeleteFileSystem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFileSystemRequest"}, + "output":{"shape":"DeleteFileSystemResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"ServiceLimitExceeded"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes a file system, deleting its contents. After deletion, the file system no longer exists, and its data is gone. Any existing automatic backups will also be deleted.

By default, when you delete an Amazon FSx for Windows File Server file system, a final backup is created upon deletion. This final backup is not subject to the file system's retention policy, and must be manually deleted.

The DeleteFileSystem action returns while the file system has the DELETING status. You can check the file system deletion status by calling the DescribeFileSystems action, which returns a list of file systems in your account. If you pass the file system ID for a deleted file system, the DescribeFileSystems returns a FileSystemNotFound error.

The data in a deleted file system is also deleted and can't be recovered by any means.

", + "idempotent":true + }, + "DescribeBackups":{ + "name":"DescribeBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBackupsRequest"}, + "output":{"shape":"DescribeBackupsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"BackupNotFound"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

" + }, + "DescribeFileSystems":{ + "name":"DescribeFileSystems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFileSystemsRequest"}, + "output":{"shape":"DescribeFileSystemsResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFound"}, + {"shape":"NotServiceResourceError"}, + {"shape":"ResourceDoesNotSupportTagging"} + ], + "documentation":"

Lists tags for an Amazon FSx file systems and backups in the case of Amazon FSx for Windows File Server.

When retrieving all tags, you can optionally specify the MaxResults parameter to limit the number of tags in a response. If more tags remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your tags. ListTagsForResource is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of tags returned in the response of one ListTagsForResource call and the order of tags returned across the responses of a multi-call iteration is unspecified.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFound"}, + {"shape":"NotServiceResourceError"}, + {"shape":"ResourceDoesNotSupportTagging"} + ], + "documentation":"

Tags an Amazon FSx resource.

", + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"InternalServerError"}, + {"shape":"ResourceNotFound"}, + {"shape":"NotServiceResourceError"}, + {"shape":"ResourceDoesNotSupportTagging"} + ], + "documentation":"

This action removes a tag from an Amazon FSx resource.

", + "idempotent":true + }, + "UpdateFileSystem":{ + "name":"UpdateFileSystem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFileSystemRequest"}, + "output":{"shape":"UpdateFileSystemResponse"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"UnsupportedOperation"}, + {"shape":"IncompatibleParameterError"}, + {"shape":"InternalServerError"}, + {"shape":"FileSystemNotFound"}, + {"shape":"MissingFileSystemConfiguration"} + ], + "documentation":"

Updates a file system configuration.

" + } + }, + "shapes":{ + "AWSAccountId":{ + "type":"string", + "documentation":"

An AWS account ID. This ID is a 12-digit number that you use to construct Amazon Resource Names (ARNs) for resources.

", + "max":12, + "min":12, + "pattern":"^\\d{12}$" + }, + "ActiveDirectoryBackupAttributes":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"ActiveDirectoryFullyQualifiedName", + "documentation":"

The fully qualified domain name of the self-managed AD directory.

" + }, + "ActiveDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.

" + } + }, + "documentation":"

The Microsoft AD attributes of the Amazon FSx for Windows File Server file system.

" + }, + "ActiveDirectoryError":{ + "type":"structure", + "required":["ActiveDirectoryId"], + "members":{ + "ActiveDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The directory ID of the directory that an error pertains to.

" + }, + "Type":{ + "shape":"ActiveDirectoryErrorType", + "documentation":"

The type of Active Directory error.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An Active Directory error.

", + "exception":true + }, + "ActiveDirectoryErrorType":{ + "type":"string", + "documentation":"

The type of error relating to Microsoft Active Directory. NOT_FOUND means that no directory was found by specifying the given directory. INCOMPATIBLE_MODE means that the directory specified is not a Microsoft AD directory. WRONG_VPC means that the specified directory isn't accessible from the specified VPC. WRONG_STAGE means that the specified directory isn't currently in the ACTIVE state.

", + "enum":[ + "DOMAIN_NOT_FOUND", + "INCOMPATIBLE_DOMAIN_MODE", + "WRONG_VPC", + "INVALID_DOMAIN_STAGE" + ] + }, + "ActiveDirectoryFullyQualifiedName":{"type":"string"}, + "ArchivePath":{ + "type":"string", + "max":900, + "min":3 + }, + "AutomaticBackupRetentionDays":{ + "type":"integer", + "documentation":"

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

", + "max":35, + "min":0 + }, + "Backup":{ + "type":"structure", + "required":[ + "BackupId", + "Lifecycle", + "Type", + "CreationTime", + "FileSystem" + ], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup.

" + }, + "Lifecycle":{ + "shape":"BackupLifecycle", + "documentation":"

The lifecycle status of the backup.

" + }, + "FailureDetails":{ + "shape":"BackupFailureDetails", + "documentation":"

Details explaining any failures that occur when creating a backup.

" + }, + "Type":{ + "shape":"BackupType", + "documentation":"

The type of the backup.

" + }, + "ProgressPercent":{"shape":"ProgressPercent"}, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The time when a particular backup was created.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt this backup's data.

" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) for the backup resource.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

Tags associated with a particular file system.

" + }, + "FileSystem":{ + "shape":"FileSystem", + "documentation":"

Metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

" + }, + "DirectoryInformation":{ + "shape":"ActiveDirectoryBackupAttributes", + "documentation":"

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

" + } + }, + "documentation":"

A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.

" + }, + "BackupFailureDetails":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ErrorMessage", + "documentation":"

A message describing the backup creation failure.

" + } + }, + "documentation":"

If backup creation fails, this structure contains the details of that failure.

" + }, + "BackupId":{ + "type":"string", + "documentation":"

The ID of the backup. Specifies the backup to use if you're creating a file system from an existing backup.

", + "max":128, + "min":12, + "pattern":"^(backup-[0-9a-f]{8,})$" + }, + "BackupIds":{ + "type":"list", + "member":{"shape":"BackupId"}, + "documentation":"

A list of backup IDs.

", + "max":50 + }, + "BackupInProgress":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Another backup is already under way. Wait for completion before initiating additional backups of this file system.

", + "exception":true + }, + "BackupLifecycle":{ + "type":"string", + "documentation":"

The lifecycle status of the backup.

", + "enum":[ + "AVAILABLE", + "CREATING", + "DELETED", + "FAILED" + ] + }, + "BackupNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

No Amazon FSx backups were found based upon the supplied parameters.

", + "exception":true + }, + "BackupRestoring":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of a file system being restored from the backup.

" + } + }, + "documentation":"

You can't delete a backup while it's being used to restore a file system.

", + "exception":true + }, + "BackupType":{ + "type":"string", + "documentation":"

The type of the backup.

", + "enum":[ + "AUTOMATIC", + "USER_INITIATED" + ] + }, + "Backups":{ + "type":"list", + "member":{"shape":"Backup"}, + "documentation":"

A list of backups.

", + "max":50 + }, + "BadRequest":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A generic error indicating a failure with a client request.

", + "exception":true + }, + "ClientRequestToken":{ + "type":"string", + "documentation":"

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "max":255, + "min":1, + "pattern":"[A-za-z0-9_.-]{0,255}$" + }, + "CreateBackupRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system to back up.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "idempotencyToken":true + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name.

" + } + }, + "documentation":"

The request object for the CreateBackup operation.

" + }, + "CreateBackupResponse":{ + "type":"structure", + "members":{ + "Backup":{ + "shape":"Backup", + "documentation":"

A description of the backup.

" + } + }, + "documentation":"

The response object for the CreateBackup operation.

" + }, + "CreateFileSystemFromBackupRequest":{ + "type":"structure", + "required":[ + "BackupId", + "SubnetIds" + ], + "members":{ + "BackupId":{"shape":"BackupId"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "idempotencyToken":true + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of IDs for the subnets that the file system will be accessible from. Currently, you can specify only one subnet. The file server is also launched in that subnet's Availability Zone.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups apply to all network interfaces. This value isn't returned in later describe requests.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to be applied to the file system at file system creation. The key value of the Name tag appears in the console as the file system name.

" + }, + "WindowsConfiguration":{ + "shape":"CreateFileSystemWindowsConfiguration", + "documentation":"

The configuration for this Microsoft Windows file system.

" + } + }, + "documentation":"

The request object for the CreateFileSystemFromBackup operation.

" + }, + "CreateFileSystemFromBackupResponse":{ + "type":"structure", + "members":{ + "FileSystem":{ + "shape":"FileSystem", + "documentation":"

A description of the file system.

" + } + }, + "documentation":"

The response object for the CreateFileSystemFromBackup operation.

" + }, + "CreateFileSystemLustreConfiguration":{ + "type":"structure", + "members":{ + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The preferred time to perform weekly maintenance, in the UTC time zone.

" + }, + "ImportPath":{ + "shape":"ArchivePath", + "documentation":"

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you're using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix. If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

" + }, + "ExportPath":{ + "shape":"ArchivePath", + "documentation":"

(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp]. The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z.

The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath. If you only specify a bucket name, such as s3://import-bucket, you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix], Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket.

" + }, + "ImportedFileChunkSize":{ + "shape":"Megabytes", + "documentation":"

(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The chunk size default is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

" + } + }, + "documentation":"

The Lustre configuration for the file system being created. This value is required if FileSystemType is set to LUSTRE.

" + }, + "CreateFileSystemRequest":{ + "type":"structure", + "required":[ + "FileSystemType", + "StorageCapacity", + "SubnetIds" + ], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "idempotencyToken":true + }, + "FileSystemType":{ + "shape":"FileSystemType", + "documentation":"

The type of Amazon FSx file system to create.

" + }, + "StorageCapacity":{ + "shape":"StorageCapacity", + "documentation":"

The storage capacity of the file system being created.

For Windows file systems, the storage capacity has a minimum of 300 GiB, and a maximum of 65,536 GiB.

For Lustre file systems, the storage capacity has a minimum of 3,600 GiB. Storage capacity is provisioned in increments of 3,600 GiB.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The IDs of the subnets that the file system will be accessible from. File systems support only one subnet. The file server is also launched in that subnet's Availability Zone.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn't returned in later requests to describe the file system.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to apply to the file system being created. The key value of the Name tag appears in the console as the file system name.

" + }, + "KmsKeyId":{"shape":"KmsKeyId"}, + "WindowsConfiguration":{ + "shape":"CreateFileSystemWindowsConfiguration", + "documentation":"

The Microsoft Windows configuration for the file system being created. This value is required if FileSystemType is set to WINDOWS.

" + }, + "LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"} + }, + "documentation":"

The request object used to create a new Amazon FSx file system.

" + }, + "CreateFileSystemResponse":{ + "type":"structure", + "members":{ + "FileSystem":{ + "shape":"FileSystem", + "documentation":"

The configuration of the file system that was created.

" + } + }, + "documentation":"

The response object returned after the file system is created.

" + }, + "CreateFileSystemWindowsConfiguration":{ + "type":"structure", + "required":["ThroughputCapacity"], + "members":{ + "ActiveDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it's created.

" + }, + "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryConfiguration"}, + "ThroughputCapacity":{ + "shape":"MegabytesPerSecond", + "documentation":"

The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to the nth increments, between 2^3 (8) and 2^11 (2048).

" + }, + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone.

" + }, + "DailyAutomaticBackupStartTime":{ + "shape":"DailyTime", + "documentation":"

The preferred time to take daily automatic backups, formatted HH:MM in the UTC time zone.

" + }, + "AutomaticBackupRetentionDays":{ + "shape":"AutomaticBackupRetentionDays", + "documentation":"

The number of days to retain automatic backups. The default is to retain backups for 7 days. Setting this value to 0 disables the creation of automatic backups. The maximum retention period for backups is 35 days.

" + }, + "CopyTagsToBackups":{ + "shape":"Flag", + "documentation":"

A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.

" + } + }, + "documentation":"

The configuration object for the Microsoft Windows file system used in CreateFileSystem and CreateFileSystemFromBackup operations.

" + }, + "CreationTime":{ + "type":"timestamp", + "documentation":"

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

" + }, + "DNSName":{ + "type":"string", + "documentation":"

The Domain Name Service (DNS) name for the file system. You can mount your file system using its DNS name.

", + "max":275, + "min":16, + "pattern":"^(fsi?-[0-9a-f]{8,}\\..{4,253})$" + }, + "DailyTime":{ + "type":"string", + "documentation":"

A recurring daily time, in the format HH:MM. HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

", + "max":5, + "min":5, + "pattern":"^([01]\\d|2[0-3]):?([0-5]\\d)$" + }, + "DataRepositoryConfiguration":{ + "type":"structure", + "members":{ + "ImportPath":{ + "shape":"ArchivePath", + "documentation":"

The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example s3://import-bucket/optional-prefix. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system.

" + }, + "ExportPath":{ + "shape":"ArchivePath", + "documentation":"

The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3.

" + }, + "ImportedFileChunkSize":{ + "shape":"Megabytes", + "documentation":"

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

" + } + }, + "documentation":"

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

" + }, + "DeleteBackupRequest":{ + "type":"structure", + "required":["BackupId"], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup you want to delete.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", + "idempotencyToken":true + } + }, + "documentation":"

The request object for DeleteBackup operation.

" + }, + "DeleteBackupResponse":{ + "type":"structure", + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup deleted.

" + }, + "Lifecycle":{ + "shape":"BackupLifecycle", + "documentation":"

The lifecycle of the backup. Should be DELETED.

" + } + }, + "documentation":"

The response object for DeleteBackup operation.

" + }, + "DeleteFileSystemRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system you want to delete.

" + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", + "idempotencyToken":true + }, + "WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"} + }, + "documentation":"

The request object for DeleteFileSystem operation.

" + }, + "DeleteFileSystemResponse":{ + "type":"structure", + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The ID of the file system being deleted.

" + }, + "Lifecycle":{ + "shape":"FileSystemLifecycle", + "documentation":"

The file system lifecycle for the deletion request. Should be DELETING.

" + }, + "WindowsResponse":{"shape":"DeleteFileSystemWindowsResponse"} + }, + "documentation":"

The response object for the DeleteFileSystem operation.

" + }, + "DeleteFileSystemWindowsConfiguration":{ + "type":"structure", + "members":{ + "SkipFinalBackup":{ + "shape":"Flag", + "documentation":"

By default, Amazon FSx for Windows takes a final backup on your behalf when the DeleteFileSystem operation is invoked. Doing this helps protect you from data loss, and we highly recommend taking the final backup. If you want to skip this backup, use this flag to do so.

" + }, + "FinalBackupTags":{ + "shape":"Tags", + "documentation":"

A set of tags for your final backup.

" + } + }, + "documentation":"

The configuration object for the Microsoft Windows file system used in the DeleteFileSystem operation.

" + }, + "DeleteFileSystemWindowsResponse":{ + "type":"structure", + "members":{ + "FinalBackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the final backup for this file system.

" + }, + "FinalBackupTags":{ + "shape":"Tags", + "documentation":"

The set of tags applied to the final backup.

" + } + }, + "documentation":"

The response object for the Microsoft Windows file system used in the DeleteFileSystem operation.

" + }, + "DescribeBackupsRequest":{ + "type":"structure", + "members":{ + "BackupIds":{ + "shape":"BackupIds", + "documentation":"

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

(Optional) Filters structure. Supported names are file-system-id and backup-type.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

" + } + }, + "documentation":"

The request object for DescribeBackups operation.

" + }, + "DescribeBackupsResponse":{ + "type":"structure", + "members":{ + "Backups":{ + "shape":"Backups", + "documentation":"

Any array of backups.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

This is present if there are more backups than returned in the response (String). You can use the NextToken value in the later request to fetch the backups.

" + } + }, + "documentation":"

Response object for DescribeBackups operation.

" + }, + "DescribeFileSystemsRequest":{ + "type":"structure", + "members":{ + "FileSystemIds":{ + "shape":"FileSystemIds", + "documentation":"

(Optional) IDs of the file systems whose descriptions you want to retrieve (String).

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.

" + } + }, + "documentation":"

The request object for DescribeFileSystems operation.

" + }, + "DescribeFileSystemsResponse":{ + "type":"structure", + "members":{ + "FileSystems":{ + "shape":"FileSystems", + "documentation":"

An array of file system descriptions.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Present if there are more file systems than returned in the response (String). You can use the NextToken value in the later request to fetch the descriptions.

" + } + }, + "documentation":"

The response object for DescribeFileSystems operation.

" + }, + "DirectoryId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^d-[0-9a-f]{10}$" + }, + "DirectoryPassword":{ + "type":"string", + "max":256, + "min":1, + "sensitive":true + }, + "DirectoryUserName":{ + "type":"string", + "max":256, + "min":1 + }, + "DnsIps":{ + "type":"list", + "member":{"shape":"IpAddress"}, + "max":2, + "min":1 + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

A detailed error message.

", + "max":256, + "min":1 + }, + "FileSystem":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account that created the file system. If the file system was created by an AWS Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs is the owner.

" + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

" + }, + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

The system-generated, unique 17-digit ID of the file system.

" + }, + "FileSystemType":{ + "shape":"FileSystemType", + "documentation":"

The type of Amazon FSx file system, either LUSTRE or WINDOWS.

" + }, + "Lifecycle":{ + "shape":"FileSystemLifecycle", + "documentation":"

The lifecycle status of the file system:

  • AVAILABLE indicates that the file system is reachable and available for use.

  • CREATING indicates that Amazon FSx is in the process of creating the new file system.

  • DELETING indicates that Amazon FSx is in the process of deleting the file system.

  • FAILED indicates that Amazon FSx was not able to create the file system.

  • MISCONFIGURED indicates that the file system is in a failed but recoverable state.

  • UPDATING indicates that the file system is undergoing a customer initiated update.

" + }, + "FailureDetails":{"shape":"FileSystemFailureDetails"}, + "StorageCapacity":{ + "shape":"StorageCapacity", + "documentation":"

The storage capacity of the file system in gigabytes (GB).

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the primary VPC for the file system.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The ID of the subnet to contain the endpoint for the file system. One and only one is supported. The file system is launched in the Availability Zone associated with this subnet.

" + }, + "NetworkInterfaceIds":{ + "shape":"NetworkInterfaceIds", + "documentation":"

The IDs of the elastic network interface from which a specific file system is accessible. The elastic network interface is automatically created in the same VPC that the Amazon FSx file system was created in. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide.

For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one.

" + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

The DNS name for the file system.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data for an Amazon FSx for Windows File Server file system.

" + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) for the file system resource.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to associate with the file system. For more information, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

" + }, + "WindowsConfiguration":{ + "shape":"WindowsFileSystemConfiguration", + "documentation":"

The configuration for this Microsoft Windows file system.

" + }, + "LustreConfiguration":{"shape":"LustreFileSystemConfiguration"} + }, + "documentation":"

A description of a specific Amazon FSx file system.

" + }, + "FileSystemAdministratorsGroupName":{ + "type":"string", + "max":256, + "min":1 + }, + "FileSystemFailureDetails":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"ErrorMessage", + "documentation":"

A message describing any failures that occurred during file system creation.

" + } + }, + "documentation":"

A structure providing details of any failures that occur when creating the file system has failed.

" + }, + "FileSystemId":{ + "type":"string", + "documentation":"

The globally unique ID of the file system, assigned by Amazon FSx.

", + "max":21, + "min":11, + "pattern":"^(fs-[0-9a-f]{8,})$" + }, + "FileSystemIds":{ + "type":"list", + "member":{"shape":"FileSystemId"}, + "documentation":"

A list of FileSystemIds.

", + "max":50 + }, + "FileSystemLifecycle":{ + "type":"string", + "documentation":"

The lifecycle status of the file system.

", + "enum":[ + "AVAILABLE", + "CREATING", + "FAILED", + "DELETING", + "MISCONFIGURED", + "UPDATING" + ] + }, + "FileSystemMaintenanceOperation":{ + "type":"string", + "documentation":"

An enumeration specifying the currently ongoing maintenance operation.

", + "enum":[ + "PATCHING", + "BACKING_UP" + ] + }, + "FileSystemMaintenanceOperations":{ + "type":"list", + "member":{"shape":"FileSystemMaintenanceOperation"}, + "documentation":"

A list of maintenance operations.

", + "max":20 + }, + "FileSystemNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

No Amazon FSx file systems were found based upon supplied parameters.

", + "exception":true + }, + "FileSystemType":{ + "type":"string", + "documentation":"

The type of file system.

", + "enum":[ + "WINDOWS", + "LUSTRE" + ] + }, + "FileSystems":{ + "type":"list", + "member":{"shape":"FileSystem"}, + "documentation":"

A list of file systems.

", + "max":50 + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

The name for this filter.

" + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

The values of the filter. These are all the values for any of the applied filters.

" + } + }, + "documentation":"

A filter used to restrict the results of describe calls. You can use multiple filters to return results that meet all applied filter requirements.

" + }, + "FilterName":{ + "type":"string", + "documentation":"

The name for a filter.

", + "enum":[ + "file-system-id", + "backup-type" + ] + }, + "FilterValue":{ + "type":"string", + "documentation":"

The value for a filter.

", + "max":128, + "min":1, + "pattern":"^[0-9a-zA-Z\\*\\.\\\\/\\?\\-\\_]*$" + }, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"}, + "documentation":"

A list of filter values.

", + "max":20 + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"}, + "documentation":"

A list of Filter elements.

", + "max":10 + }, + "Flag":{"type":"boolean"}, + "IncompatibleParameterError":{ + "type":"structure", + "required":["Parameter"], + "members":{ + "Parameter":{ + "shape":"Parameter", + "documentation":"

A parameter that is incompatible with the earlier request.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

", + "exception":true + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A generic error indicating a server-side failure.

", + "exception":true, + "fault":true + }, + "InvalidExportPath":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The path provided for data repository export isn't valid.

", + "exception":true + }, + "InvalidImportPath":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The path provided for data repository import isn't valid.

", + "exception":true + }, + "InvalidNetworkSettings":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "InvalidSubnetId":{"shape":"SubnetId"}, + "InvalidSecurityGroupId":{"shape":"SecurityGroupId"} + }, + "documentation":"

One or more network settings specified in the request are invalid. InvalidVpcId means that the ID passed for the virtual private cloud (VPC) is invalid. InvalidSubnetIds returns the list of IDs for subnets that are either invalid or not part of the VPC specified. InvalidSecurityGroupIds returns the list of IDs for security groups that are either invalid or not part of the VPC specified.

", + "exception":true + }, + "IpAddress":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$" + }, + "KmsKeyId":{ + "type":"string", + "documentation":"

The ID of your AWS Key Management Service (AWS KMS) key. This ID is used to encrypt the data in your file system at rest. For more information, see Encrypt in the AWS Key Management Service API Reference.

", + "max":2048, + "min":1, + "pattern":"^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|arn:aws[a-z-]{0,7}:kms:[a-z]{2}-[a-z-]{4,}-\\d+:\\d{12}:(key|alias)\\/([a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}|[a-zA-Z0-9:\\/_-]+)|alias\\/[a-zA-Z0-9:\\/_-]+$" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the Amazon FSx resource that will have its tags listed.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

(Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

" + } + }, + "documentation":"

The request object for ListTagsForResource operation.

" + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags on the resource.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

This is present if there are more tags than returned in the response (String). You can use the NextToken value in the later request to fetch the tags.

" + } + }, + "documentation":"

The response object for ListTagsForResource operation.

" + }, + "LustreFileSystemConfiguration":{ + "type":"structure", + "members":{ + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The UTC time that you want to begin your weekly maintenance window.

" + }, + "DataRepositoryConfiguration":{"shape":"DataRepositoryConfiguration"} + }, + "documentation":"

The configuration for the Amazon FSx for Lustre file system.

" + }, + "MaxResults":{ + "type":"integer", + "documentation":"

The maximum number of resources to return in the response. This value must be an integer greater than zero.

", + "min":1 + }, + "Megabytes":{ + "type":"integer", + "max":512000, + "min":1 + }, + "MegabytesPerSecond":{ + "type":"integer", + "documentation":"

Sustained throughput of an Amazon FSx file system in MBps.

", + "max":2048, + "min":8 + }, + "MissingFileSystemConfiguration":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

File system configuration is required for this operation.

", + "exception":true + }, + "NetworkInterfaceId":{ + "type":"string", + "documentation":"

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.

", + "max":21, + "min":12, + "pattern":"^(eni-[0-9a-f]{8,})$" + }, + "NetworkInterfaceIds":{ + "type":"list", + "member":{"shape":"NetworkInterfaceId"}, + "documentation":"

A list of network interface IDs.

", + "max":50 + }, + "NextToken":{ + "type":"string", + "documentation":"

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

", + "max":255, + "min":1, + "pattern":"^(?:[A-Za-z0-9+\\/]{4})*(?:[A-Za-z0-9+\\/]{2}==|[A-Za-z0-9+\\/]{3}=)?$" + }, + "NotServiceResourceError":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the non-Amazon FSx resource.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource specified for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

", + "exception":true + }, + "OrganizationalUnitDistinguishedName":{ + "type":"string", + "max":2000, + "min":1 + }, + "Parameter":{ + "type":"string", + "documentation":"

The name of a parameter for the request. Parameter names are returned in PascalCase.

", + "min":1 + }, + "ProgressPercent":{ + "type":"integer", + "documentation":"

The current percent of progress of an asynchronous task.

", + "max":100, + "min":0 + }, + "ResourceARN":{ + "type":"string", + "documentation":"

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

", + "max":512, + "min":8, + "pattern":"^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" + }, + "ResourceDoesNotSupportTagging":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the resource that doesn't support tagging.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource specified does not support tagging.

", + "exception":true + }, + "ResourceNotFound":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The resource ARN of the resource that can't be found.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource specified by the Amazon Resource Name (ARN) can't be found.

", + "exception":true + }, + "SecurityGroupId":{ + "type":"string", + "documentation":"

The ID of your Amazon EC2 security group. This ID is used to control network access to the endpoint that Amazon FSx creates on your behalf in each subnet. For more information, see Amazon EC2 Security Groups for Linux Instances in the Amazon EC2 User Guide.

", + "max":20, + "min":11, + "pattern":"^(sg-[0-9a-f]{8,})$" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "documentation":"

A list of security group IDs.

", + "max":50 + }, + "SelfManagedActiveDirectoryAttributes":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"ActiveDirectoryFullyQualifiedName", + "documentation":"

The fully qualified domain name of the self-managed AD directory.

" + }, + "OrganizationalUnitDistinguishedName":{ + "shape":"OrganizationalUnitDistinguishedName", + "documentation":"

The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server instance is joined.

" + }, + "FileSystemAdministratorsGroup":{ + "shape":"FileSystemAdministratorsGroupName", + "documentation":"

The name of the domain group whose members have administrative privileges for the FSx file system.

" + }, + "UserName":{ + "shape":"DirectoryUserName", + "documentation":"

The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain.

" + }, + "DnsIps":{ + "shape":"DnsIps", + "documentation":"

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

" + } + }, + "documentation":"

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server instance is joined.

" + }, + "SelfManagedActiveDirectoryConfiguration":{ + "type":"structure", + "required":[ + "DomainName", + "UserName", + "Password", + "DnsIps" + ], + "members":{ + "DomainName":{ + "shape":"ActiveDirectoryFullyQualifiedName", + "documentation":"

The fully qualified domain name of the self-managed AD directory, such as corp.example.com.

" + }, + "OrganizationalUnitDistinguishedName":{ + "shape":"OrganizationalUnitDistinguishedName", + "documentation":"

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory that the Windows File Server instance will join. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com. To learn more, see RFC 2253. If none is provided, the FSx file system is created in the default location of your self-managed AD directory.

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

" + }, + "FileSystemAdministratorsGroup":{ + "shape":"FileSystemAdministratorsGroupName", + "documentation":"

(Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, and setting audit controls (audit ACLs) on files and folders. The group that you specify must already exist in your domain. If you don't provide one, your AD domain's Domain Admins group is used.

" + }, + "UserName":{ + "shape":"DirectoryUserName", + "documentation":"

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName, or in the default location of your AD domain.

" + }, + "Password":{ + "shape":"DirectoryPassword", + "documentation":"

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

" + }, + "DnsIps":{ + "shape":"DnsIps", + "documentation":"

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range as the one in which your Amazon FSx file system is being created, or in the private IP version 4 (Iv4) address ranges, as specified in RFC 1918:

  • 10.0.0.0 - 10.255.255.255 (10/8 prefix)

  • 172.16.0.0 - 172.31.255.255 (172.16/12 prefix)

  • 192.168.0.0 - 192.168.255.255 (192.168/16 prefix)

" + } + }, + "documentation":"

The configuration that Amazon FSx uses to join the Windows File Server instance to your self-managed (including on-premises) Microsoft Active Directory (AD) directory.

" + }, + "SelfManagedActiveDirectoryConfigurationUpdates":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"DirectoryUserName", + "documentation":"

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName.

" + }, + "Password":{ + "shape":"DirectoryPassword", + "documentation":"

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

" + }, + "DnsIps":{ + "shape":"DnsIps", + "documentation":"

A list of up to two IP addresses of DNS servers or domain controllers in the self-managed AD directory.

" + } + }, + "documentation":"

The configuration that Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft Active Directory (AD) directory.

" + }, + "ServiceLimit":{ + "type":"string", + "documentation":"

The types of limits on your service utilization. Limits include file system count, total throughput capacity, total storage, and total user-initiated backups. These limits apply for a specific account in a specific AWS Region. You can increase some of them by contacting AWS Support.

", + "enum":[ + "FILE_SYSTEM_COUNT", + "TOTAL_THROUGHPUT_CAPACITY", + "TOTAL_STORAGE", + "TOTAL_USER_INITIATED_BACKUPS" + ] + }, + "ServiceLimitExceeded":{ + "type":"structure", + "required":["Limit"], + "members":{ + "Limit":{ + "shape":"ServiceLimit", + "documentation":"

Enumeration of the service limit that was exceeded.

" + }, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting AWS Support.

", + "exception":true + }, + "StorageCapacity":{ + "type":"integer", + "documentation":"

The storage capacity for your Amazon FSx file system, in gibibytes.

", + "min":1 + }, + "SubnetId":{ + "type":"string", + "documentation":"

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

", + "max":24, + "min":15, + "pattern":"^(subnet-[0-9a-f]{8,})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "documentation":"

A list of subnet IDs. Currently, you can specify only one subnet ID in a call to the CreateFileSystem operation.

", + "max":50 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

" + } + }, + "documentation":"

Specifies a key-value pair for a resource tag.

" + }, + "TagKey":{ + "type":"string", + "documentation":"

A string of 1 to 128 characters that specifies the key for a tag. Tag keys must be unique for the resource to which they are attached.

", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "documentation":"

A list of TagKey values, with a maximum of 50 elements.

", + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one specified in this parameter.

" + } + }, + "documentation":"

The request object for the TagResource operation.

" + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response object for the TagResource operation.

" + }, + "TagValue":{ + "type":"string", + "documentation":"

A string of 0 to 256 characters that specifies the value for a tag. Tag values can be null and don't have to be unique in a tag set.

", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "documentation":"

A list of Tag values, with a maximum of 50 elements.

", + "max":50, + "min":1 + }, + "UnsupportedOperation":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An error occured.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the Amazon FSx resource to untag.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

" + } + }, + "documentation":"

The request object for UntagResource action.

" + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The response object for UntagResource action.

" + }, + "UpdateFileSystemLustreConfiguration":{ + "type":"structure", + "members":{ + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The preferred time to perform weekly maintenance, in the UTC time zone.

" + } + }, + "documentation":"

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

" + }, + "UpdateFileSystemRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{"shape":"FileSystemId"}, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "idempotencyToken":true + }, + "WindowsConfiguration":{ + "shape":"UpdateFileSystemWindowsConfiguration", + "documentation":"

The configuration update for this Microsoft Windows file system. The only supported options are for backup and maintenance and for self-managed Active Directory configuration.

" + }, + "LustreConfiguration":{"shape":"UpdateFileSystemLustreConfiguration"} + }, + "documentation":"

The request object for the UpdateFileSystem operation.

" + }, + "UpdateFileSystemResponse":{ + "type":"structure", + "members":{ + "FileSystem":{ + "shape":"FileSystem", + "documentation":"

A description of the file system that was updated.

" + } + }, + "documentation":"

The response object for the UpdateFileSystem operation.

" + }, + "UpdateFileSystemWindowsConfiguration":{ + "type":"structure", + "members":{ + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The preferred time to perform weekly maintenance, in the UTC time zone.

" + }, + "DailyAutomaticBackupStartTime":{ + "shape":"DailyTime", + "documentation":"

The preferred time to take daily automatic backups, in the UTC time zone.

" + }, + "AutomaticBackupRetentionDays":{ + "shape":"AutomaticBackupRetentionDays", + "documentation":"

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

" + }, + "SelfManagedActiveDirectoryConfiguration":{ + "shape":"SelfManagedActiveDirectoryConfigurationUpdates", + "documentation":"

The configuration Amazon FSx uses to join the Windows File Server instance to the self-managed Microsoft AD directory.

" + } + }, + "documentation":"

Updates the Microsoft Windows configuration for an existing Amazon FSx for Windows File Server file system. Amazon FSx overwrites existing properties with non-null values provided in the request. If you don't specify a non-null value for a property, that property is not updated.

" + }, + "VpcId":{ + "type":"string", + "documentation":"

The ID of your virtual private cloud (VPC). For more information, see VPC and Subnets in the Amazon VPC User Guide.

", + "max":21, + "min":12, + "pattern":"^(vpc-[0-9a-f]{8,})$" + }, + "WeeklyTime":{ + "type":"string", + "documentation":"

A recurring weekly time, in the format D:HH:MM.

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia.

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

", + "max":7, + "min":7, + "pattern":"^[1-7]:([01]\\d|2[0-3]):?([0-5]\\d)$" + }, + "WindowsFileSystemConfiguration":{ + "type":"structure", + "members":{ + "ActiveDirectoryId":{ + "shape":"DirectoryId", + "documentation":"

The ID for an existing Microsoft Active Directory instance that the file system should join when it's created.

" + }, + "SelfManagedActiveDirectoryConfiguration":{"shape":"SelfManagedActiveDirectoryAttributes"}, + "ThroughputCapacity":{ + "shape":"MegabytesPerSecond", + "documentation":"

The throughput of an Amazon FSx file system, measured in megabytes per second.

" + }, + "MaintenanceOperationsInProgress":{ + "shape":"FileSystemMaintenanceOperations", + "documentation":"

The list of maintenance operations in progress for this file system.

" + }, + "WeeklyMaintenanceStartTime":{ + "shape":"WeeklyTime", + "documentation":"

The preferred time to perform weekly maintenance, in the UTC time zone.

" + }, + "DailyAutomaticBackupStartTime":{ + "shape":"DailyTime", + "documentation":"

The preferred time to take daily automatic backups, in the UTC time zone.

" + }, + "AutomaticBackupRetentionDays":{ + "shape":"AutomaticBackupRetentionDays", + "documentation":"

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

" + }, + "CopyTagsToBackups":{ + "shape":"Flag", + "documentation":"

A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups.

" + } + }, + "documentation":"

The configuration for this Microsoft Windows file system.

" + } + }, + "documentation":"

Amazon FSx is a fully managed service that makes it easy for storage and application administrators to launch and use shared file storage.

" +} diff --git a/aws/dist/botocore/data/gamelift/2015-10-01/examples-1.json b/aws/dist/botocore/data/gamelift/2015-10-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/gamelift/2015-10-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/gamelift/2015-10-01/paginators-1.json b/aws/dist/botocore/data/gamelift/2015-10-01/paginators-1.json new file mode 100644 index 00000000..270e8408 --- /dev/null +++ b/aws/dist/botocore/data/gamelift/2015-10-01/paginators-1.json @@ -0,0 +1,100 @@ +{ + "pagination": { + "DescribeFleetAttributes": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "FleetAttributes" + }, + "DescribeFleetCapacity": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "FleetCapacity" + }, + "DescribeFleetEvents": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Events" + }, + "DescribeFleetUtilization": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "FleetUtilization" + }, + "DescribeGameSessionDetails": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "GameSessionDetails" + }, + "DescribeGameSessionQueues": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "GameSessionQueues" + }, + "DescribeGameSessions": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "GameSessions" + }, + "DescribeInstances": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Instances" + }, + "DescribeMatchmakingConfigurations": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Configurations" + }, + "DescribeMatchmakingRuleSets": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "RuleSets" + }, + "DescribePlayerSessions": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "PlayerSessions" + }, + "DescribeScalingPolicies": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "ScalingPolicies" + }, + "ListAliases": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Aliases" + }, + "ListBuilds": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "Builds" + }, + "ListFleets": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "FleetIds" + }, + "SearchGameSessions": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "GameSessions" + } + } +} diff --git a/aws/dist/botocore/data/gamelift/2015-10-01/service-2.json b/aws/dist/botocore/data/gamelift/2015-10-01/service-2.json new file mode 100644 index 00000000..77649c76 --- /dev/null +++ b/aws/dist/botocore/data/gamelift/2015-10-01/service-2.json @@ -0,0 +1,5399 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-10-01", + "endpointPrefix":"gamelift", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon GameLift", + "serviceId":"GameLift", + "signatureVersion":"v4", + "targetPrefix":"GameLift", + "uid":"gamelift-2015-10-01" + }, + "operations":{ + "AcceptMatch":{ + "name":"AcceptMatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptMatchInput"}, + "output":{"shape":"AcceptMatchOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING, where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where one or more players rejected the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to respond, the ticket status is set to CANCELLED, and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Learn more

Add FlexMatch to a Game Client

FlexMatch Events Reference

Related operations

" + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasInput"}, + "output":{"shape":"CreateAliasOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update.

Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site.

To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling UpdateAlias.

" + }, + "CreateBuild":{ + "name":"CreateBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBuildInput"}, + "output":{"shape":"CreateBuildOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location.

Game server binaries must be combined into a .zip file for use with Amazon GameLift.

To create new builds quickly and easily, use the AWS CLI command upload-build . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions.

The CreateBuild operation should be used only when you need to manually upload your build files, as in the following scenarios:

  • Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. To create a new build record using files in your Amazon S3 bucket, call CreateBuild and specify a build name, operating system, and the storage location of your game build.

  • Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call CreateBuild with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic Uploading Objects). You can upload files to a location only once.

If successful, this operation creates a new build record with a unique build ID and places it in INITIALIZED status. You can use DescribeBuild to check the status of your build. A build must be in READY status before it can be used to create fleets.

Learn more

Uploading Your Game

Create a Build with Files in Amazon S3

Related operations

" + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFleetInput"}, + "output":{"shape":"CreateFleetOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Creates a new fleet to run your game servers. whether they are custom game builds or Realtime Servers with game-specific script. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can host multiple game sessions. When creating a fleet, you choose the hardware specifications, set some configuration options, and specify the game server to deploy on the new fleet.

To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type and fleet type (spot or on-demand), (3) the build ID for your game build or script ID if using Realtime Servers, and (4) a run-time configuration, which determines how game servers will run on each instance in the fleet.

When creating a Realtime Servers fleet, we recommend using a minimal version of the Realtime script (see this working code example ). This will make it much easier to troubleshoot any fleet creation issues. Once the fleet is active, you can update your Realtime script as needed.

If the CreateFleet call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events:

  • Creates a fleet record. Status: NEW.

  • Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console.

    Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance.

  • Downloads the game build or Realtime script to the new instance and installs it. Statuses: DOWNLOADING, VALIDATING, BUILDING.

  • Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds. Status: ACTIVATING.

  • Sets the fleet's status to ACTIVE as soon as one server process is ready to host a game session.

Learn more

Working with Fleets

Debug Fleet Creation Issues

Related operations

" + }, + "CreateGameSession":{ + "name":"CreateGameSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGameSessionInput"}, + "output":{"shape":"CreateGameSessionOutput"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidFleetStatusException"}, + {"shape":"TerminalRoutingStrategyException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"FleetCapacityExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an ACTIVE status before a game session can be created in it.

To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a GameSession object is returned containing the game session properties and other settings you specified.

Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change.

Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request.

Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using UpdateGameSession to change the game session's player session creation policy.

Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call GetGameSessionLogUrl to download the log files.

Available in Amazon GameLift Local.

" + }, + "CreateGameSessionQueue":{ + "name":"CreateGameSessionQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGameSessionQueueInput"}, + "output":{"shape":"CreateGameSessionQueueOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call StartGameSessionPlacement and reference the queue name.

Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience.

Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc.

To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned.

" + }, + "CreateMatchmakingConfiguration":{ + "name":"CreateMatchmakingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMatchmakingConfigurationInput"}, + "output":{"shape":"CreateMatchmakingConfigurationOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration. Since notifications promise only \"best effort\" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

Learn more

Design a FlexMatch Matchmaker

Setting up Notifications for Matchmaking

Related operations

" + }, + "CreateMatchmakingRuleSet":{ + "name":"CreateMatchmakingRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMatchmakingRuleSetInput"}, + "output":{"shape":"CreateMatchmakingRuleSetOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a MatchmakingConfiguration.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Related operations

" + }, + "CreatePlayerSession":{ + "name":"CreatePlayerSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlayerSessionInput"}, + "output":{"shape":"CreatePlayerSessionOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidGameSessionStatusException"}, + {"shape":"GameSessionFullException"}, + {"shape":"TerminalRoutingStrategyException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Reserves an open player slot in an active game session. Before a player can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a group of players to a game session, use CreatePlayerSessions. When the player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player.

To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, a slot is reserved in the game session for the player and a new PlayerSession object is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

" + }, + "CreatePlayerSessions":{ + "name":"CreatePlayerSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlayerSessionsInput"}, + "output":{"shape":"CreatePlayerSessionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidGameSessionStatusException"}, + {"shape":"GameSessionFullException"}, + {"shape":"TerminalRoutingStrategyException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Reserves open slots in a game session for a group of players. Before players can be added, a game session must have an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot. To add a single player to a game session, use CreatePlayerSession. When a player connects to the game server and references a player session ID, the game server contacts the Amazon GameLift service to validate the player reservation and accept the player.

To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, a slot is reserved in the game session for each player and a set of new PlayerSession objects is returned. Player sessions cannot be updated.

Available in Amazon GameLift Local.

" + }, + "CreateScript":{ + "name":"CreateScript", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateScriptInput"}, + "output":{"shape":"CreateScriptOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that provide configuration settings and optional custom game logic for your game. The script is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is executed during an active game session.

To create a new script record, specify a script name and provide the script file(s). The script files and all dependencies must be zipped into a single file. You can pull the zip file from either of these locations:

  • A locally available directory. Use the ZipFile parameter for this option.

  • An Amazon Simple Storage Service (Amazon S3) bucket under your AWS account. Use the StorageLocation parameter for this option. You'll need to have an Identity Access Management (IAM) role that allows the Amazon GameLift service to access your S3 bucket.

If the call is successful, a new script record is created with a unique script ID. If the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3 bucket and the script record's storage location reflects this location. If the script file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as needed for deployment.

Learn more

Amazon GameLift Realtime Servers

Set Up a Role for Amazon GameLift Access

Related operations

" + }, + "CreateVpcPeeringAuthorization":{ + "name":"CreateVpcPeeringAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringAuthorizationInput"}, + "output":{"shape":"CreateVpcPeeringAuthorizationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Requests authorization to create or delete a peer connection between the VPC for your Amazon GameLift fleet and a virtual private cloud (VPC) in your AWS account. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. Once you've received authorization, call CreateVpcPeeringConnection to establish the peering connection. For more information, see VPC Peering with Amazon GameLift Fleets.

You can peer with VPCs that are owned by any AWS account you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions.

To request authorization to create a connection, call this operation from the AWS account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable your game servers to retrieve data from a DynamoDB table, use the account that manages that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you want to peer with, and (2) the ID of the AWS account that you use to manage Amazon GameLift. If successful, VPC peering is authorized for the specified VPC.

To request authorization to delete a connection, call this operation from the AWS account with the VPC that is peered with your Amazon GameLift fleet. Identify the following values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the AWS account that you use to manage Amazon GameLift.

The authorization remains valid for 24 hours unless it is canceled by a call to DeleteVpcPeeringAuthorization. You must create or delete the peering connection while the authorization is valid.

" + }, + "CreateVpcPeeringConnection":{ + "name":"CreateVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVpcPeeringConnectionInput"}, + "output":{"shape":"CreateVpcPeeringConnectionOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Establishes a VPC peering connection between a virtual private cloud (VPC) in an AWS account with the VPC for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate directly with other AWS resources. You can peer with VPCs in any AWS account that you have access to, including the account that you use to manage your Amazon GameLift fleets. You cannot peer with VPCs that are in different regions. For more information, see VPC Peering with Amazon GameLift Fleets.

Before calling this operation to establish the peering connection, you first need to call CreateVpcPeeringAuthorization and identify the VPC you want to peer with. Once the authorization for the specified VPC is issued, you have 24 hours to establish the connection. These two operations handle all tasks necessary to peer the two VPCs, including acceptance, updating routing tables, etc.

To establish the connection, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you want to be enable a VPC peering connection for; (2) The AWS account with the VPC that you want to peer with; and (3) The ID of the VPC you want to peer with. This operation is asynchronous. If successful, a VpcPeeringConnection request is created. You can use continuous polling to track the request's status using DescribeVpcPeeringConnections, or by monitoring fleet events for success or failure using DescribeFleetEvents.

" + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAliasInput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes an alias. This action removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

" + }, + "DeleteBuild":{ + "name":"DeleteBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBuildInput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes a build. This action permanently deletes the build record and any uploaded build files.

To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.

Learn more

Working with Builds

Related operations

" + }, + "DeleteFleet":{ + "name":"DeleteFleet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFleetInput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidFleetStatusException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.

If the fleet being deleted has a VPC peering connection, you first need to get a valid authorization (good for 24 hours) by calling CreateVpcPeeringAuthorization. You do not need to explicitly delete the VPC peering connection--this is done as part of the delete fleet process.

This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.

Learn more

Working with Fleets.

Related operations

" + }, + "DeleteGameSessionQueue":{ + "name":"DeleteGameSessionQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGameSessionQueueInput"}, + "output":{"shape":"DeleteGameSessionQueueOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Deletes a game session queue. This action means that any StartGameSessionPlacement requests that reference this queue will fail. To delete a queue, specify the queue name.

" + }, + "DeleteMatchmakingConfiguration":{ + "name":"DeleteMatchmakingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMatchmakingConfigurationInput"}, + "output":{"shape":"DeleteMatchmakingConfigurationOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Permanently removes a FlexMatch matchmaking configuration. To delete, specify the configuration name. A matchmaking configuration cannot be deleted if it is being used in any active matchmaking tickets.

Related operations

" + }, + "DeleteMatchmakingRuleSet":{ + "name":"DeleteMatchmakingRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMatchmakingRuleSetInput"}, + "output":{"shape":"DeleteMatchmakingRuleSetOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

Related operations

" + }, + "DeleteScalingPolicy":{ + "name":"DeleteScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScalingPolicyInput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.

To temporarily suspend scaling policies, call StopFleetActions. This operation suspends all policies for the fleet.

" + }, + "DeleteScript":{ + "name":"DeleteScript", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteScriptInput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes a Realtime script. This action permanently deletes the script record. If script files were uploaded, they are also deleted (files stored in an S3 bucket are not deleted).

To delete a script, specify the script ID. Before deleting a script, be sure to terminate all fleets that are deployed with the script being deleted. Fleet instances periodically check for script updates, and if the script record no longer exists, the instance will go into an error state and be unable to host game sessions.

Learn more

Amazon GameLift Realtime Servers

Related operations

" + }, + "DeleteVpcPeeringAuthorization":{ + "name":"DeleteVpcPeeringAuthorization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringAuthorizationInput"}, + "output":{"shape":"DeleteVpcPeeringAuthorizationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Cancels a pending VPC peering authorization for the specified VPC. If you need to delete an existing VPC peering connection, call DeleteVpcPeeringConnection.

" + }, + "DeleteVpcPeeringConnection":{ + "name":"DeleteVpcPeeringConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVpcPeeringConnectionInput"}, + "output":{"shape":"DeleteVpcPeeringConnectionOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Removes a VPC peering connection. To delete the connection, you must have a valid authorization for the VPC peering connection that you want to delete. You can check for an authorization by calling DescribeVpcPeeringAuthorizations or request a new one using CreateVpcPeeringAuthorization.

Once a valid authorization exists, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID and fleet ID. If successful, the connection is removed.

" + }, + "DescribeAlias":{ + "name":"DescribeAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAliasInput"}, + "output":{"shape":"DescribeAliasOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves properties for an alias. This operation returns all alias metadata and settings. To get an alias's target fleet ID only, use ResolveAlias.

To get alias properties, specify the alias ID. If successful, the requested alias record is returned.

" + }, + "DescribeBuild":{ + "name":"DescribeBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBuildInput"}, + "output":{"shape":"DescribeBuildOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves properties for a build. To request a build record, specify a build ID. If successful, an object containing the build properties is returned.

Learn more

Working with Builds

Related operations

" + }, + "DescribeEC2InstanceLimits":{ + "name":"DescribeEC2InstanceLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEC2InstanceLimitsInput"}, + "output":{"shape":"DescribeEC2InstanceLimitsOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves the following information for the specified EC2 instance type:

  • maximum number of instances allowed per AWS account (service limit)

  • current usage level for the AWS account

Service limits vary depending on region. Available regions for Amazon GameLift can be found in the AWS Management Console for Amazon GameLift (see the drop-down list in the upper right corner).

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeFleetAttributes":{ + "name":"DescribeFleetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetAttributesInput"}, + "output":{"shape":"DescribeFleetAttributesOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeFleetCapacity":{ + "name":"DescribeFleetCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetCapacityInput"}, + "output":{"shape":"DescribeFleetCapacityOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeFleetEvents":{ + "name":"DescribeFleetEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetEventsInput"}, + "output":{"shape":"DescribeFleetEventsOutput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeFleetPortSettings":{ + "name":"DescribeFleetPortSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetPortSettingsInput"}, + "output":{"shape":"DescribeFleetPortSettingsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeFleetUtilization":{ + "name":"DescribeFleetUtilization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFleetUtilizationInput"}, + "output":{"shape":"DescribeFleetUtilizationOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.

Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeGameSessionDetails":{ + "name":"DescribeGameSessionDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionDetailsInput"}, + "output":{"shape":"DescribeGameSessionDetailsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TerminalRoutingStrategyException"} + ], + "documentation":"

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId or GameSessionArn to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.

" + }, + "DescribeGameSessionPlacement":{ + "name":"DescribeGameSessionPlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionPlacementInput"}, + "output":{"shape":"DescribeGameSessionPlacementOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves properties and current status of a game session placement request. To get game session placement details, specify the placement ID. If successful, a GameSessionPlacement object is returned.

" + }, + "DescribeGameSessionQueues":{ + "name":"DescribeGameSessionQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionQueuesInput"}, + "output":{"shape":"DescribeGameSessionQueuesOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the region.

" + }, + "DescribeGameSessions":{ + "name":"DescribeGameSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGameSessionsInput"}, + "output":{"shape":"DescribeGameSessionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TerminalRoutingStrategyException"} + ], + "documentation":"

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails.

To get game sessions, specify one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each game session matching the request.

Available in Amazon GameLift Local.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesInput"}, + "output":{"shape":"DescribeInstancesOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves information about a fleet's instances, including instance IDs. Use this action to get details on all instances in the fleet or get details on one specific instance.

To get a specific instance, specify fleet ID and instance ID. To get all instances in a fleet, specify a fleet ID only. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, an Instance object is returned for each result.

" + }, + "DescribeMatchmaking":{ + "name":"DescribeMatchmaking", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMatchmakingInput"}, + "output":{"shape":"DescribeMatchmakingOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking.

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

Learn more

Add FlexMatch to a Game Client

Set Up FlexMatch Event Notification

Related operations

" + }, + "DescribeMatchmakingConfigurations":{ + "name":"DescribeMatchmakingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMatchmakingConfigurationsInput"}, + "output":{"shape":"DescribeMatchmakingConfigurationsOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Retrieves the details of FlexMatch matchmaking configurations. With this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Learn more

Setting Up FlexMatch Matchmakers

Related operations

" + }, + "DescribeMatchmakingRuleSets":{ + "name":"DescribeMatchmakingRuleSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMatchmakingRuleSetsInput"}, + "output":{"shape":"DescribeMatchmakingRuleSetsOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

Related operations

" + }, + "DescribePlayerSessions":{ + "name":"DescribePlayerSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePlayerSessionsInput"}, + "output":{"shape":"DescribePlayerSessionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId to request properties for a specific player session; (2) provide a GameSessionId to request properties for all player sessions in the specified game session; (3) provide a PlayerId to request properties for all player sessions of a specified player.

To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.

Available in Amazon GameLift Local.

" + }, + "DescribeRuntimeConfiguration":{ + "name":"DescribeRuntimeConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRuntimeConfigurationInput"}, + "output":{"shape":"DescribeRuntimeConfigurationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Retrieves the current run-time configuration for the specified fleet. The run-time configuration tells Amazon GameLift how to launch server processes on instances in the fleet.

Learn more

Working with Fleets.

Related operations

" + }, + "DescribeScalingPolicies":{ + "name":"DescribeScalingPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScalingPoliciesInput"}, + "output":{"shape":"DescribeScalingPoliciesOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves all scaling policies applied to a fleet.

To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.

A fleet may have all of its scaling policies suspended (StopFleetActions). This action does not affect the status of the scaling policies, which remains ACTIVE. To see whether a fleet's scaling policies are in force or suspended, call DescribeFleetAttributes and check the stopped actions.

" + }, + "DescribeScript":{ + "name":"DescribeScript", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeScriptInput"}, + "output":{"shape":"DescribeScriptOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieves properties for a Realtime script.

To request a script record, specify the script ID. If successful, an object containing the script properties is returned.

Learn more

Amazon GameLift Realtime Servers

Related operations

" + }, + "DescribeVpcPeeringAuthorizations":{ + "name":"DescribeVpcPeeringAuthorizations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringAuthorizationsInput"}, + "output":{"shape":"DescribeVpcPeeringAuthorizationsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves valid VPC peering authorizations that are pending for the AWS account. This operation returns all VPC peering authorizations and requests for peering. This includes those initiated and received by this account.

" + }, + "DescribeVpcPeeringConnections":{ + "name":"DescribeVpcPeeringConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVpcPeeringConnectionsInput"}, + "output":{"shape":"DescribeVpcPeeringConnectionsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves information on VPC peering connections. Use this operation to get peering information for all fleets or for one specific fleet ID.

To retrieve connection information, call this operation from the AWS account that is used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to retrieve all connection records. If successful, the retrieved information includes both active and pending connections. Active connections identify the IpV4 CIDR block that the VPC uses to connect.

" + }, + "GetGameSessionLogUrl":{ + "name":"GetGameSessionLogUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGameSessionLogUrlInput"}, + "output":{"shape":"GetGameSessionLogUrlOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3 and retains them for 14 days. Use this URL to download the logs.

See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.

 " + }, + "GetInstanceAccess":{ + "name":"GetInstanceAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceAccessInput"}, + "output":{"shape":"GetInstanceAccessOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Requests remote access to a fleet instance. Remote access is useful for debugging, gathering benchmarking data, or watching activity in real time.

Access requires credentials that match the operating system of the instance. For a Windows instance, Amazon GameLift returns a user name and password as strings for use with a Windows Remote Desktop client. For a Linux instance, Amazon GameLift returns a user name and RSA private key, also as strings, for use with an SSH client. The private key must be saved in the proper format to a .pem file before using. If you're making this request using the AWS CLI, saving the secret can be handled as part of the GetInstanceAccess request. (See the example later in this topic). For more information on remote access, see Remotely Accessing an Instance.

To request access to a specific instance, specify the IDs of both the instance and the fleet it belongs to. You can retrieve a fleet's instance IDs by calling DescribeInstances. If successful, an InstanceAccess object is returned containing the instance's IP address and a set of credentials.

" + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesInput"}, + "output":{"shape":"ListAliasesOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves all aliases for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.

Returned aliases are not listed in any particular order.

 " + }, + "ListBuilds":{ + "name":"ListBuilds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBuildsInput"}, + "output":{"shape":"ListBuildsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.

Build records are not listed in any particular order.

Learn more

Working with Builds

Related operations

" + }, + "ListFleets":{ + "name":"ListFleets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFleetsInput"}, + "output":{"shape":"ListFleetsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Retrieves a collection of fleet records for this AWS account. You can filter the result set to find only those fleets that are deployed with a specific build or script. Use the pagination parameters to retrieve results in sequential pages.

Fleet records are not listed in a particular order.

Learn more

Set Up Fleets.

Related operations

" + }, + "ListScripts":{ + "name":"ListScripts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListScriptsInput"}, + "output":{"shape":"ListScriptsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves script records for all Realtime scripts that are associated with the AWS account in use.

Learn more

Amazon GameLift Realtime Servers

Related operations

" + }, + "PutScalingPolicy":{ + "name":"PutScalingPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutScalingPolicyInput"}, + "output":{"shape":"PutScalingPolicyOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Creates or updates a scaling policy for a fleet. Scaling policies are used to automatically scale a fleet's hosting capacity to meet player demand. An active scaling policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's capacity when a certain threshold is reached. There are two types of scaling policies: target-based and rule-based. Use a target-based policy to quickly and efficiently manage fleet scaling; this option is the most commonly used. Use rule-based policies when you need to exert fine-grained control over auto-scaling.

Fleets can have multiple scaling policies of each type in force at the same time; you can have one target-based policy, one or multiple rule-based scaling policies, or both. We recommend caution, however, because multiple auto-scaling policies can have unintended consequences.

You can temporarily suspend all scaling policies for a fleet by calling StopFleetActions with the fleet action AUTO_SCALING. To resume scaling policies, call StartFleetActions with the same fleet action. To stop just one scaling policy--or to permanently remove it, you must delete the policy with DeleteScalingPolicy.

Learn more about how to work with auto-scaling in Set Up Fleet Automatic Scaling.

Target-based policy

A target-based policy tracks a single metric: PercentAvailableGameSessions. This metric tells us how much of a fleet's hosting capacity is ready to host game sessions but is not currently in use. This is the fleet's buffer; it measures the additional player demand that the fleet could handle at current capacity. With a target-based policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is needed to maintain that target.

For example, you might choose to maintain a 10% buffer for a fleet that has the capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action whenever the fleet's available capacity falls below or rises above 10 game sessions. Amazon GameLift will start new instances or stop unused instances in order to return to the 10% buffer.

To create or update a target-based policy, specify a fleet ID and name, and set the policy type to \"TargetBased\". Specify the metric to track (PercentAvailableGameSessions) and reference a TargetConfiguration object with your desired buffer value. Exclude all other parameters. On a successful request, the policy name is returned. The scaling policy is automatically in force as soon as it's successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

Rule-based policy

A rule-based policy tracks specified fleet metric, sets a threshold value, and specifies the type of action to initiate when triggered. With a rule-based policy, you can select from several available fleet metrics. Each policy specifies whether to scale up or scale down (and by how much), so you need one policy for each type of action.

For example, a policy may make the following statement: \"If the percentage of idle instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity by 10%.\"

A policy's rule statement has the following structure:

If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].

To implement the example, the rule statement would look like this:

If [PercentIdleInstances] is [GreaterThanThreshold] [20] for [15] minutes, then [PercentChangeInCapacity] to/by [10].

To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the policy type to \"RuleBased\". Specify the parameter values for a policy rule statement. On a successful request, the policy name is returned. Scaling policies are automatically in force as soon as they're successfully created. If the fleet's auto-scaling actions are temporarily suspended, the new policy will be in force once the fleet actions are restarted.

" + }, + "RequestUploadCredentials":{ + "name":"RequestUploadCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestUploadCredentialsInput"}, + "output":{"shape":"RequestUploadCredentialsOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves a fresh set of credentials for use when uploading a new set of game build files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see CreateBuild.

To request new credentials, specify the build ID as returned with an initial CreateBuild request. If successful, a new set of credentials are returned, along with the S3 storage location associated with the build ID.

Learn more

Uploading Your Game

Related operations

" + }, + "ResolveAlias":{ + "name":"ResolveAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveAliasInput"}, + "output":{"shape":"ResolveAliasOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"TerminalRoutingStrategyException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Retrieves the fleet ID that a specified alias is currently pointing to.

" + }, + "SearchGameSessions":{ + "name":"SearchGameSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchGameSessionsInput"}, + "output":{"shape":"SearchGameSessionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TerminalRoutingStrategyException"} + ], + "documentation":"

Retrieves all active game sessions that match a set of search criteria and sorts them in a specified order. You can search or sort by the following game session attributes:

  • gameSessionId -- Unique identifier for the game session. You can use either a GameSessionId or GameSessionArn value.

  • gameSessionName -- Name assigned to a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession. Game session names do not need to be unique to a game session.

  • gameSessionProperties -- Custom data defined in a game session's GameProperty parameter. GameProperty values are stored as key:value pairs; the filter expression must indicate the key and a string to search the data values for. For example, to search for game sessions with custom data containing the key:value pair \"gameMode:brawl\", specify the following: gameSessionProperties.gameMode = \"brawl\". All custom data values are searched as strings.

  • maximumSessions -- Maximum number of player sessions allowed for a game session. This value is set when requesting a new game session with CreateGameSession or updating with UpdateGameSession.

  • creationTimeMillis -- Value indicating when a game session was created. It is expressed in Unix time as milliseconds.

  • playerSessionCount -- Number of players currently connected to a game session. This value changes rapidly as players join the session or drop out.

  • hasAvailablePlayerSessions -- Boolean value indicating whether a game session has reached its maximum number of players. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join.

Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.

To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. If successful, a collection of GameSession objects matching the request is returned. Use the pagination parameters to retrieve results as a set of sequential pages.

You can search for game sessions one fleet at a time only. To find game sessions across multiple fleets, you must search each fleet separately and combine the results. This search feature finds only game sessions that are in ACTIVE status. To locate games in statuses other than active, use DescribeGameSessionDetails.

" + }, + "StartFleetActions":{ + "name":"StartFleetActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFleetActionsInput"}, + "output":{"shape":"StartFleetActionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Resumes activity on a fleet that was suspended with StopFleetActions. Currently, this operation is used to restart a fleet's auto-scaling activity.

To start fleet actions, specify the fleet ID and the type of actions to restart. When auto-scaling fleet actions are restarted, Amazon GameLift once again initiates scaling events as triggered by the fleet's scaling policies. If actions on the fleet were never stopped, this operation will have no effect. You can view a fleet's stopped actions using DescribeFleetAttributes.

Learn more

Working with Fleets.

Related operations

" + }, + "StartGameSessionPlacement":{ + "name":"StartGameSessionPlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartGameSessionPlacementInput"}, + "output":{"shape":"StartGameSessionPlacementOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Places a request for a new game session in a queue (see CreateGameSessionQueue). When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.

A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.

When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.

Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each region's average lag for all players and reorders to get the best game play across all players.

To place a new game session request, specify the following:

  • The queue name and a set of game session properties and settings

  • A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request

  • (Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)

  • Latency data for all players (if you want to optimize game play for the players)

If successful, a new game session placement is created.

To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.

" + }, + "StartMatchBackfill":{ + "name":"StartMatchBackfill", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMatchBackfillInput"}, + "output":{"shape":"StartMatchBackfillOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed.

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works.

Learn more

Backfill Existing Games with FlexMatch

How GameLift FlexMatch Works

Related operations

" + }, + "StartMatchmaking":{ + "name":"StartMatchmaking", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMatchmakingInput"}, + "output":{"shape":"StartMatchmakingOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules, and starts a new game for the matched players. Each matchmaking request specifies the type of match to build (team configuration, rules for an acceptable match, etc.). The request also specifies the players to find a match for and where to host the new game session for optimal performance. A matchmaking request might start with a single player or a group of players who want to play together. FlexMatch finds additional players as needed to fill the match. Match type, rules, and the queue used to place a new game session are defined in a MatchmakingConfiguration.

To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration, and include the players to be matched. You must also include a set of player attributes relevant for the matchmaking configuration. If successful, a matchmaking ticket is returned with status set to QUEUED. Track the status of the ticket to respond as needed and acquire game session connection information for successfully completed matches.

Tracking ticket status -- A couple of options are available for tracking the status of matchmaking requests:

  • Polling -- Call DescribeMatchmaking. This operation returns the full ticket object, including current status and (for completed tickets) game session connection info. We recommend polling no more than once every 10 seconds.

  • Notifications -- Get event notifications for changes in ticket status using Amazon Simple Notification Service (SNS). Notifications are easy to set up (see CreateMatchmakingConfiguration) and typically deliver match status changes faster and more efficiently than polling. We recommend that you use polling to back up to notifications (since delivery is not guaranteed) and call DescribeMatchmaking only when notifications are not received within 30 seconds.

Processing a matchmaking request -- FlexMatch handles a matchmaking request as follows:

  1. Your client code submits a StartMatchmaking request for one or more players and tracks the status of the request ticket.

  2. FlexMatch uses this ticket and others in process to build an acceptable match. When a potential match is identified, all tickets in the proposed match are advanced to the next status.

  3. If the match requires player acceptance (set in the matchmaking configuration), the tickets move into status REQUIRES_ACCEPTANCE. This status triggers your client code to solicit acceptance from all players in every ticket involved in the match, and then call AcceptMatch for each player. If any player rejects or fails to accept the match before a specified timeout, the proposed match is dropped (see AcceptMatch for more details).

  4. Once a match is proposed and accepted, the matchmaking tickets move into status PLACING. FlexMatch locates resources for a new game session using the game session queue (set in the matchmaking configuration) and creates the game session based on the match data.

  5. When the match is successfully placed, the matchmaking tickets move into COMPLETED status. Connection information (including game session endpoint and player session) is added to the matchmaking tickets. Matched players can use the connection information to join the game.

Learn more

Add FlexMatch to a Game Client

Set Up FlexMatch Event Notification

FlexMatch Integration Roadmap

How GameLift FlexMatch Works

Related operations

" + }, + "StopFleetActions":{ + "name":"StopFleetActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopFleetActionsInput"}, + "output":{"shape":"StopFleetActionsOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Suspends activity on a fleet. Currently, this operation is used to stop a fleet's auto-scaling activity. It is used to temporarily stop scaling events triggered by the fleet's scaling policies. The policies can be retained and auto-scaling activity can be restarted using StartFleetActions. You can view a fleet's stopped actions using DescribeFleetAttributes.

To stop fleet actions, specify the fleet ID and the type of actions to suspend. When auto-scaling fleet actions are stopped, Amazon GameLift no longer initiates scaling events except to maintain the fleet's desired instances setting (FleetCapacity. Changes to the fleet's capacity must be done manually using UpdateFleetCapacity.

Learn more

Working with Fleets.

Related operations

" + }, + "StopGameSessionPlacement":{ + "name":"StopGameSessionPlacement", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopGameSessionPlacementInput"}, + "output":{"shape":"StopGameSessionPlacementOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

" + }, + "StopMatchmaking":{ + "name":"StopMatchmaking", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopMatchmakingInput"}, + "output":{"shape":"StopMatchmakingOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the action is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a Game Client

Related operations

" + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAliasInput"}, + "output":{"shape":"UpdateAliasOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.

" + }, + "UpdateBuild":{ + "name":"UpdateBuild", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBuildInput"}, + "output":{"shape":"UpdateBuildOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.

Learn more

Working with Builds

Related operations

" + }, + "UpdateFleetAttributes":{ + "name":"UpdateFleetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetAttributesInput"}, + "output":{"shape":"UpdateFleetAttributesOutput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidFleetStatusException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values that you want to change. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

" + }, + "UpdateFleetCapacity":{ + "name":"UpdateFleetCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetCapacityInput"}, + "output":{"shape":"UpdateFleetCapacityOutput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidFleetStatusException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.

Specify minimum and maximum number of instances. Amazon GameLift will not change fleet capacity to values fall outside of this range. This is particularly important when using auto-scaling (see PutScalingPolicy) to allow capacity to adjust based on player demand while imposing limits on automatic adjustments.

To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.

Learn more

Working with Fleets.

Related operations

" + }, + "UpdateFleetPortSettings":{ + "name":"UpdateFleetPortSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFleetPortSettingsInput"}, + "output":{"shape":"UpdateFleetPortSettingsOutput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidFleetStatusException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.

Learn more

Working with Fleets.

Related operations

" + }, + "UpdateGameSession":{ + "name":"UpdateGameSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGameSessionInput"}, + "output":{"shape":"UpdateGameSessionOutput"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InvalidGameSessionStatusException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.

" + }, + "UpdateGameSessionQueue":{ + "name":"UpdateGameSessionQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGameSessionQueueInput"}, + "output":{"shape":"UpdateGameSessionQueueOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Updates settings for a game session queue, which determines how new game session requests in the queue are processed. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

" + }, + "UpdateMatchmakingConfiguration":{ + "name":"UpdateMatchmakingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMatchmakingConfigurationInput"}, + "output":{"shape":"UpdateMatchmakingConfigurationOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"} + ], + "documentation":"

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more

Design a FlexMatch Matchmaker

Related operations

" + }, + "UpdateRuntimeConfiguration":{ + "name":"UpdateRuntimeConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuntimeConfigurationInput"}, + "output":{"shape":"UpdateRuntimeConfigurationOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidFleetStatusException"} + ], + "documentation":"

Updates the current run-time configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on instances in the fleet. You can update a fleet's run-time configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.

To update run-time configuration, specify the fleet ID and provide a RuntimeConfiguration object with an updated set of server process configurations.

Each instance in a Amazon GameLift fleet checks regularly for an updated run-time configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; run-time configuration changes are applied gradually as existing processes shut down and new processes are launched during Amazon GameLift's normal process recycling activity.

Learn more

Working with Fleets.

Related operations

" + }, + "UpdateScript":{ + "name":"UpdateScript", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateScriptInput"}, + "output":{"shape":"UpdateScriptOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Updates Realtime script metadata and content.

To update script metadata, specify the script ID and provide updated name and/or version values.

To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the Version parameter to track updates to the script.

If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.

Learn more

Amazon GameLift Realtime Servers

Related operations

" + }, + "ValidateMatchmakingRuleSet":{ + "name":"ValidateMatchmakingRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ValidateMatchmakingRuleSetInput"}, + "output":{"shape":"ValidateMatchmakingRuleSetOutput"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"UnsupportedRegionException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set is using syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set JSON string.

Learn more

Related operations

" + } + }, + "shapes":{ + "AcceptMatchInput":{ + "type":"structure", + "required":[ + "TicketId", + "PlayerIds", + "AcceptanceType" + ], + "members":{ + "TicketId":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

" + }, + "PlayerIds":{ + "shape":"StringList", + "documentation":"

Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

" + }, + "AcceptanceType":{ + "shape":"AcceptanceType", + "documentation":"

Player response to the proposed match.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "AcceptMatchOutput":{ + "type":"structure", + "members":{ + } + }, + "AcceptanceType":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT" + ] + }, + "Alias":{ + "type":"structure", + "members":{ + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for an alias; alias IDs are unique within a region.

" + }, + "Name":{ + "shape":"NonBlankAndLengthConstraintString", + "documentation":"

Descriptive label that is associated with an alias. Alias names do not need to be unique.

" + }, + "AliasArn":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for an alias; alias ARNs are unique across all regions.

" + }, + "Description":{ + "shape":"FreeText", + "documentation":"

Human-readable description of an alias.

" + }, + "RoutingStrategy":{ + "shape":"RoutingStrategy", + "documentation":"

Alias configuration for the alias, including routing type and settings.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "documentation":"

Properties describing a fleet alias.

" + }, + "AliasId":{ + "type":"string", + "pattern":"^alias-\\S+" + }, + "AliasList":{ + "type":"list", + "member":{"shape":"Alias"} + }, + "ArnStringModel":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9:/-]+" + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "S":{ + "shape":"NonZeroAndMaxString", + "documentation":"

For single string values. Maximum string length is 100 characters.

" + }, + "N":{ + "shape":"DoubleObject", + "documentation":"

For number values, expressed as double.

" + }, + "SL":{ + "shape":"StringList", + "documentation":"

For a list of up to 10 strings. Maximum length for each string is 100 characters. Duplicate values are not recognized; all occurrences of the repeated value after the first of a repeated value are ignored.

" + }, + "SDM":{ + "shape":"StringDoubleMap", + "documentation":"

For a map of up to 10 data type:value pairs. Maximum length for each string value is 100 characters.

" + } + }, + "documentation":"

Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each AttributeValue object can use only one of the available properties.

" + }, + "AwsCredentials":{ + "type":"structure", + "members":{ + "AccessKeyId":{ + "shape":"NonEmptyString", + "documentation":"

Temporary key allowing access to the Amazon GameLift S3 account.

" + }, + "SecretAccessKey":{ + "shape":"NonEmptyString", + "documentation":"

Temporary secret key allowing access to the Amazon GameLift S3 account.

" + }, + "SessionToken":{ + "shape":"NonEmptyString", + "documentation":"

Token used to associate a specific build ID with the files uploaded using these credentials.

" + } + }, + "documentation":"

Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

", + "sensitive":true + }, + "BackfillMode":{ + "type":"string", + "enum":[ + "AUTOMATIC", + "MANUAL" + ] + }, + "BooleanModel":{"type":"boolean"}, + "Build":{ + "type":"structure", + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build.

" + }, + "Name":{ + "shape":"FreeText", + "documentation":"

Descriptive label that is associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

" + }, + "Version":{ + "shape":"FreeText", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique. This value can be set using CreateBuild or UpdateBuild.

" + }, + "Status":{ + "shape":"BuildStatus", + "documentation":"

Current status of the build.

Possible build statuses include the following:

  • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED -- The game build upload failed. You cannot create new fleets for this build.

" + }, + "SizeOnDisk":{ + "shape":"PositiveLong", + "documentation":"

File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.

" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "documentation":"

Properties describing a custom game build.

Related operations

" + }, + "BuildId":{ + "type":"string", + "pattern":"^build-\\S+" + }, + "BuildList":{ + "type":"list", + "member":{"shape":"Build"} + }, + "BuildStatus":{ + "type":"string", + "enum":[ + "INITIALIZED", + "READY", + "FAILED" + ] + }, + "CertificateConfiguration":{ + "type":"structure", + "required":["CertificateType"], + "members":{ + "CertificateType":{"shape":"CertificateType"} + } + }, + "CertificateType":{ + "type":"string", + "enum":[ + "DISABLED", + "GENERATED" + ] + }, + "ComparisonOperatorType":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

", + "exception":true + }, + "CreateAliasInput":{ + "type":"structure", + "required":[ + "Name", + "RoutingStrategy" + ], + "members":{ + "Name":{ + "shape":"NonBlankAndLengthConstraintString", + "documentation":"

Descriptive label that is associated with an alias. Alias names do not need to be unique.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Human-readable description of an alias.

" + }, + "RoutingStrategy":{ + "shape":"RoutingStrategy", + "documentation":"

Object that specifies the fleet and routing type to use for the alias.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{ + "shape":"Alias", + "documentation":"

Object that describes the newly created alias record.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateBuildInput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a build. Build names do not need to be unique. You can use UpdateBuild to change this value later.

" + }, + "Version":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateBuild to change this value later.

" + }, + "StorageLocation":{ + "shape":"S3Location", + "documentation":"

Information indicating where your game build files are stored. Use this parameter only when creating a build with files stored in an Amazon S3 bucket that you own. The storage location must specify an Amazon S3 bucket name and key, as well as a the ARN for a role that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket must be in the same region that you want to create a new build in.

" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build. If your game build contains multiple executables, they all must run on the same operating system. If an operating system is not specified when creating a build, Amazon GameLift uses the default value (WINDOWS_2012). This value cannot be changed later.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateBuildOutput":{ + "type":"structure", + "members":{ + "Build":{ + "shape":"Build", + "documentation":"

The newly created build record, including a unique build ID and status.

" + }, + "UploadCredentials":{ + "shape":"AwsCredentials", + "documentation":"

This element is returned only when the operation is called without a storage location. It contains credentials to use when you are uploading a build file to an Amazon S3 bucket that is owned by Amazon GameLift. Credentials have a limited life span. To refresh these credentials, call RequestUploadCredentials.

" + }, + "StorageLocation":{ + "shape":"S3Location", + "documentation":"

Amazon S3 location for your game build file, including bucket name and key.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateFleetInput":{ + "type":"structure", + "required":[ + "Name", + "EC2InstanceType" + ], + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Human-readable description of a fleet.

" + }, + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to be deployed on the new fleet. The custom game server build must have been successfully uploaded to Amazon GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.

" + }, + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script to be deployed on the new fleet. The Realtime script must have been successfully uploaded to Amazon GameLift. This fleet setting cannot be changed once the fleet is created.

" + }, + "ServerLaunchPath":{ + "shape":"NonZeroAndMaxString", + "documentation":"

This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

" + }, + "ServerLaunchParameters":{ + "shape":"NonZeroAndMaxString", + "documentation":"

This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a run-time configuration will continue to work.)

" + }, + "LogPaths":{ + "shape":"StringList", + "documentation":"

This parameter is no longer used. Instead, to specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API ProcessReady() and specify one or more directory paths in logParameters. See more information in the Server API Reference.

" + }, + "EC2InstanceType":{ + "shape":"EC2InstanceType", + "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" + }, + "EC2InboundPermissions":{ + "shape":"IpPermissionsList", + "documentation":"

Range of IP addresses and port settings that permit inbound traffic to access game sessions that running on the fleet. For fleets using a custom game build, this parameter is required before game sessions running on the fleet can accept connections. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges for use by the Realtime servers. You can specify multiple permission settings or add more by updating the fleet.

" + }, + "NewGameSessionProtectionPolicy":{ + "shape":"ProtectionPolicy", + "documentation":"

Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" + }, + "RuntimeConfiguration":{ + "shape":"RuntimeConfiguration", + "documentation":"

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The run-time configuration lists the types of server processes to run on an instance and includes the following configuration settings: the server executable or launch script file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration.

" + }, + "ResourceCreationLimitPolicy":{ + "shape":"ResourceCreationLimitPolicy", + "documentation":"

Policy that limits the number of game sessions an individual player can create over a span of time for this fleet.

" + }, + "MetricGroups":{ + "shape":"MetricGroupList", + "documentation":"

Name of an Amazon CloudWatch metric group to add this fleet to. A metric group aggregates the metrics for all fleets in the group. Specify an existing metric group name, or provide a new name to create a new metric group. A fleet can only be included in one metric group at a time.

" + }, + "PeerVpcAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + }, + "FleetType":{ + "shape":"FleetType", + "documentation":"

Indicates whether to use on-demand instances or spot instances for this fleet. If empty, the default is ON_DEMAND. Both categories of instances use identical hardware and configurations based on the instance type selected for this fleet. Learn more about On-Demand versus Spot Instances.

" + }, + "InstanceRoleArn":{ + "shape":"NonEmptyString", + "documentation":"

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

" + }, + "CertificateConfiguration":{"shape":"CertificateConfiguration"} + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateFleetOutput":{ + "type":"structure", + "members":{ + "FleetAttributes":{ + "shape":"FleetAttributes", + "documentation":"

Properties for the newly created fleet.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateGameSessionInput":{ + "type":"structure", + "required":["MaximumPlayerSessionCount"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

" + }, + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for an alias associated with the fleet to create a game session in. Each request must reference either a fleet ID or alias ID, but not both.

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a game session. Session names do not need to be unique.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + }, + "CreatorId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player or entity creating the game session. This ID is used to enforce a resource protection policy (if one exists) that limits the number of concurrent active game sessions one player can have.

" + }, + "GameSessionId":{ + "shape":"IdStringModel", + "documentation":"

This parameter is no longer preferred. Please use IdempotencyToken instead. Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.)

" + }, + "IdempotencyToken":{ + "shape":"IdStringModel", + "documentation":"

Custom string that uniquely identifies a request for a new game session. Maximum token length is 48 characters. If provided, this string is included in the new game session's ID. (A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.) Idempotency tokens remain in use for 30 days after a game session has ended; game session objects are retained for this time period and then deleted.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateGameSessionOutput":{ + "type":"structure", + "members":{ + "GameSession":{ + "shape":"GameSession", + "documentation":"

Object that describes the newly created game session record.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateGameSessionQueueInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"GameSessionQueueName", + "documentation":"

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

" + }, + "TimeoutInSeconds":{ + "shape":"WholeNumber", + "documentation":"

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" + }, + "PlayerLatencyPolicies":{ + "shape":"PlayerLatencyPolicyList", + "documentation":"

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. A player latency policy must set a value for MaximumIndividualPlayerLatencyMilliseconds; if none is set, this API requests will fail.

" + }, + "Destinations":{ + "shape":"GameSessionQueueDestinationList", + "documentation":"

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateGameSessionQueueOutput":{ + "type":"structure", + "members":{ + "GameSessionQueue":{ + "shape":"GameSessionQueue", + "documentation":"

Object that describes the newly created game session queue.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateMatchmakingConfigurationInput":{ + "type":"structure", + "required":[ + "Name", + "GameSessionQueueArns", + "RequestTimeoutSeconds", + "AcceptanceRequired", + "RuleSetName" + ], + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Meaningful description of the matchmaking configuration.

" + }, + "GameSessionQueueArns":{ + "shape":"QueueArnsList", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

" + }, + "RequestTimeoutSeconds":{ + "shape":"MatchmakingRequestTimeoutInteger", + "documentation":"

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

" + }, + "AcceptanceTimeoutSeconds":{ + "shape":"MatchmakingAcceptanceTimeoutInteger", + "documentation":"

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

" + }, + "AcceptanceRequired":{ + "shape":"BooleanModel", + "documentation":"

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

" + }, + "RuleSetName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

" + }, + "NotificationTarget":{ + "shape":"SnsArnStringModel", + "documentation":"

SNS topic ARN that is set up to receive matchmaking notifications.

" + }, + "AdditionalPlayerCount":{ + "shape":"WholeNumber", + "documentation":"

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

" + }, + "CustomEventData":{ + "shape":"CustomEventData", + "documentation":"

Information to be added to all events related to this matchmaking configuration.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "BackfillMode":{ + "shape":"BackfillMode", + "documentation":"

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateMatchmakingConfigurationOutput":{ + "type":"structure", + "members":{ + "Configuration":{ + "shape":"MatchmakingConfiguration", + "documentation":"

Object that describes the newly created matchmaking configuration.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateMatchmakingRuleSetInput":{ + "type":"structure", + "required":[ + "Name", + "RuleSetBody" + ], + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. (Note: The rule set name is different from the optional \"name\" field in the rule set body.)

" + }, + "RuleSetBody":{ + "shape":"RuleSetBody", + "documentation":"

Collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateMatchmakingRuleSetOutput":{ + "type":"structure", + "required":["RuleSet"], + "members":{ + "RuleSet":{ + "shape":"MatchmakingRuleSet", + "documentation":"

Object that describes the newly created matchmaking rule set.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreatePlayerSessionInput":{ + "type":"structure", + "required":[ + "GameSessionId", + "PlayerId" + ], + "members":{ + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to add a player to.

" + }, + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player. Player IDs are developer-defined.

" + }, + "PlayerData":{ + "shape":"PlayerData", + "documentation":"

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreatePlayerSessionOutput":{ + "type":"structure", + "members":{ + "PlayerSession":{ + "shape":"PlayerSession", + "documentation":"

Object that describes the newly created player session record.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreatePlayerSessionsInput":{ + "type":"structure", + "required":[ + "GameSessionId", + "PlayerIds" + ], + "members":{ + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to add players to.

" + }, + "PlayerIds":{ + "shape":"PlayerIdList", + "documentation":"

List of unique identifiers for the players to be added.

" + }, + "PlayerDataMap":{ + "shape":"PlayerDataMap", + "documentation":"

Map of string pairs, each specifying a player ID and a set of developer-defined information related to the player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. Player data strings for player IDs not included in the PlayerIds parameter are ignored.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreatePlayerSessionsOutput":{ + "type":"structure", + "members":{ + "PlayerSessions":{ + "shape":"PlayerSessionList", + "documentation":"

Collection of player session objects created for the added players.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateScriptInput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

" + }, + "Version":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

" + }, + "StorageLocation":{ + "shape":"S3Location", + "documentation":"

Location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

" + }, + "ZipFile":{ + "shape":"ZipBlob", + "documentation":"

Data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

" + } + } + }, + "CreateScriptOutput":{ + "type":"structure", + "members":{ + "Script":{ + "shape":"Script", + "documentation":"

The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

" + } + } + }, + "CreateVpcPeeringAuthorizationInput":{ + "type":"structure", + "required":[ + "GameLiftAwsAccountId", + "PeerVpcId" + ], + "members":{ + "GameLiftAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateVpcPeeringAuthorizationOutput":{ + "type":"structure", + "members":{ + "VpcPeeringAuthorization":{ + "shape":"VpcPeeringAuthorization", + "documentation":"

Details on the requested VPC peering authorization, including expiration.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "CreateVpcPeeringConnectionInput":{ + "type":"structure", + "required":[ + "FleetId", + "PeerVpcAwsAccountId", + "PeerVpcId" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet. This tells Amazon GameLift which GameLift VPC to peer with.

" + }, + "PeerVpcAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the AWS account with the VPC that you want to peer your Amazon GameLift fleet with. You can find your Account ID in the AWS Management Console under account settings.

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "CreateVpcPeeringConnectionOutput":{ + "type":"structure", + "members":{ + } + }, + "CustomEventData":{ + "type":"string", + "max":256, + "min":0 + }, + "DeleteAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to delete.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to delete.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteFleetInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to be deleted.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteGameSessionQueueInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"GameSessionQueueName", + "documentation":"

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteGameSessionQueueOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteMatchmakingConfigurationInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking configuration

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteMatchmakingConfigurationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteMatchmakingRuleSetInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set to be deleted. (Note: The rule set name is different from the optional \"name\" field in the rule set body.)

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteMatchmakingRuleSetOutput":{ + "type":"structure", + "members":{ + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DeleteScalingPolicyInput":{ + "type":"structure", + "required":[ + "Name", + "FleetId" + ], + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

" + }, + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to be deleted.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteScriptInput":{ + "type":"structure", + "required":["ScriptId"], + "members":{ + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script to delete.

" + } + } + }, + "DeleteVpcPeeringAuthorizationInput":{ + "type":"structure", + "required":[ + "GameLiftAwsAccountId", + "PeerVpcId" + ], + "members":{ + "GameLiftAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteVpcPeeringAuthorizationOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteVpcPeeringConnectionInput":{ + "type":"structure", + "required":[ + "FleetId", + "VpcPeeringConnectionId" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet. This value must match the fleet ID referenced in the VPC peering connection record.

" + }, + "VpcPeeringConnectionId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC peering connection. This value is included in the VpcPeeringConnection object, which can be retrieved by calling DescribeVpcPeeringConnections.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DeleteVpcPeeringConnectionOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to retrieve.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{ + "shape":"Alias", + "documentation":"

Object that contains the requested alias.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to retrieve properties for.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeBuildOutput":{ + "type":"structure", + "members":{ + "Build":{ + "shape":"Build", + "documentation":"

Set of properties describing the requested build.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeEC2InstanceLimitsInput":{ + "type":"structure", + "members":{ + "EC2InstanceType":{ + "shape":"EC2InstanceType", + "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeEC2InstanceLimitsOutput":{ + "type":"structure", + "members":{ + "EC2InstanceLimits":{ + "shape":"EC2InstanceLimitList", + "documentation":"

Object that contains the maximum number of instances for the specified instance type.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeFleetAttributesInput":{ + "type":"structure", + "members":{ + "FleetIds":{ + "shape":"FleetIdList", + "documentation":"

Unique identifier for a fleet(s) to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeFleetAttributesOutput":{ + "type":"structure", + "members":{ + "FleetAttributes":{ + "shape":"FleetAttributesList", + "documentation":"

Collection of objects containing attribute metadata for each requested fleet ID.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeFleetCapacityInput":{ + "type":"structure", + "members":{ + "FleetIds":{ + "shape":"FleetIdList", + "documentation":"

Unique identifier for a fleet(s) to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeFleetCapacityOutput":{ + "type":"structure", + "members":{ + "FleetCapacity":{ + "shape":"FleetCapacityList", + "documentation":"

Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeFleetEventsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to get event logs for.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\").

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeFleetEventsOutput":{ + "type":"structure", + "members":{ + "Events":{ + "shape":"EventList", + "documentation":"

Collection of objects containing event log entries for the specified fleet.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeFleetPortSettingsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to retrieve port settings for.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeFleetPortSettingsOutput":{ + "type":"structure", + "members":{ + "InboundPermissions":{ + "shape":"IpPermissionsList", + "documentation":"

Object that contains port settings for the requested fleet ID.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeFleetUtilizationInput":{ + "type":"structure", + "members":{ + "FleetIds":{ + "shape":"FleetIdList", + "documentation":"

Unique identifier for a fleet(s) to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeFleetUtilizationOutput":{ + "type":"structure", + "members":{ + "FleetUtilization":{ + "shape":"FleetUtilizationList", + "documentation":"

Collection of objects containing utilization information for each requested fleet ID.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeGameSessionDetailsInput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to retrieve all game sessions active on the fleet.

" + }, + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to retrieve.

" + }, + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

" + }, + "StatusFilter":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeGameSessionDetailsOutput":{ + "type":"structure", + "members":{ + "GameSessionDetails":{ + "shape":"GameSessionDetailList", + "documentation":"

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeGameSessionPlacementInput":{ + "type":"structure", + "required":["PlacementId"], + "members":{ + "PlacementId":{ + "shape":"IdStringModel", + "documentation":"

Unique identifier for a game session placement to retrieve.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeGameSessionPlacementOutput":{ + "type":"structure", + "members":{ + "GameSessionPlacement":{ + "shape":"GameSessionPlacement", + "documentation":"

Object that describes the requested game session placement.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeGameSessionQueuesInput":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"GameSessionQueueNameList", + "documentation":"

List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeGameSessionQueuesOutput":{ + "type":"structure", + "members":{ + "GameSessionQueues":{ + "shape":"GameSessionQueueList", + "documentation":"

Collection of objects that describes the requested game session queues.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeGameSessionsInput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to retrieve all game sessions for.

" + }, + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

" + }, + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

" + }, + "StatusFilter":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeGameSessionsOutput":{ + "type":"structure", + "members":{ + "GameSessions":{ + "shape":"GameSessionList", + "documentation":"

Collection of objects containing game session properties for each session matching the request.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeInstancesInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to retrieve instance information for.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeInstancesOutput":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"InstanceList", + "documentation":"

Collection of objects containing properties for each instance returned.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeMatchmakingConfigurationsInput":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"MatchmakingIdList", + "documentation":"

Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.

" + }, + "RuleSetName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeMatchmakingConfigurationsOutput":{ + "type":"structure", + "members":{ + "Configurations":{ + "shape":"MatchmakingConfigurationList", + "documentation":"

Collection of requested matchmaking configuration objects.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeMatchmakingInput":{ + "type":"structure", + "required":["TicketIds"], + "members":{ + "TicketIds":{ + "shape":"MatchmakingIdList", + "documentation":"

Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeMatchmakingOutput":{ + "type":"structure", + "members":{ + "TicketList":{ + "shape":"MatchmakingTicketList", + "documentation":"

Collection of existing matchmaking ticket objects matching the request.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeMatchmakingRuleSetsInput":{ + "type":"structure", + "members":{ + "Names":{ + "shape":"MatchmakingRuleSetNameList", + "documentation":"

List of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional \"name\" field in the rule set body.)

" + }, + "Limit":{ + "shape":"RuleSetLimit", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeMatchmakingRuleSetsOutput":{ + "type":"structure", + "required":["RuleSets"], + "members":{ + "RuleSets":{ + "shape":"MatchmakingRuleSetList", + "documentation":"

Collection of requested matchmaking rule set objects.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribePlayerSessionsInput":{ + "type":"structure", + "members":{ + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to retrieve player sessions for.

" + }, + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player to retrieve player sessions for.

" + }, + "PlayerSessionId":{ + "shape":"PlayerSessionId", + "documentation":"

Unique identifier for a player session to retrieve.

" + }, + "PlayerSessionStatusFilter":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Player session status to filter results on.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribePlayerSessionsOutput":{ + "type":"structure", + "members":{ + "PlayerSessions":{ + "shape":"PlayerSessionList", + "documentation":"

Collection of objects containing properties for each player session that matches the request.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeRuntimeConfigurationInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to get the run-time configuration for.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeRuntimeConfigurationOutput":{ + "type":"structure", + "members":{ + "RuntimeConfiguration":{ + "shape":"RuntimeConfiguration", + "documentation":"

Instructions describing how server processes should be launched and maintained on each instance in the fleet.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeScalingPoliciesInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to retrieve scaling policies for.

" + }, + "StatusFilter":{ + "shape":"ScalingStatusType", + "documentation":"

Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.

  • ACTIVE -- The scaling policy is currently in force.

  • UPDATEREQUESTED -- A request to update the scaling policy has been received.

  • UPDATING -- A change is being made to the scaling policy.

  • DELETEREQUESTED -- A request to delete the scaling policy has been received.

  • DELETING -- The scaling policy is being deleted.

  • DELETED -- The scaling policy has been deleted.

  • ERROR -- An error occurred in creating the policy. It should be removed and recreated.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeScalingPoliciesOutput":{ + "type":"structure", + "members":{ + "ScalingPolicies":{ + "shape":"ScalingPolicyList", + "documentation":"

Collection of objects containing the scaling policies matching the request.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DescribeScriptInput":{ + "type":"structure", + "required":["ScriptId"], + "members":{ + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script to retrieve properties for.

" + } + } + }, + "DescribeScriptOutput":{ + "type":"structure", + "members":{ + "Script":{ + "shape":"Script", + "documentation":"

Set of properties describing the requested script.

" + } + } + }, + "DescribeVpcPeeringAuthorizationsInput":{ + "type":"structure", + "members":{ + } + }, + "DescribeVpcPeeringAuthorizationsOutput":{ + "type":"structure", + "members":{ + "VpcPeeringAuthorizations":{ + "shape":"VpcPeeringAuthorizationList", + "documentation":"

Collection of objects that describe all valid VPC peering operations for the current AWS account.

" + } + } + }, + "DescribeVpcPeeringConnectionsInput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "DescribeVpcPeeringConnectionsOutput":{ + "type":"structure", + "members":{ + "VpcPeeringConnections":{ + "shape":"VpcPeeringConnectionList", + "documentation":"

Collection of VPC peering connection records that match the request.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "DesiredPlayerSession":{ + "type":"structure", + "members":{ + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player to associate with the player session.

" + }, + "PlayerData":{ + "shape":"PlayerData", + "documentation":"

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" + } + }, + "documentation":"

Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.

" + }, + "DesiredPlayerSessionList":{ + "type":"list", + "member":{"shape":"DesiredPlayerSession"} + }, + "DnsName":{"type":"string"}, + "Double":{"type":"double"}, + "DoubleObject":{"type":"double"}, + "EC2InstanceCounts":{ + "type":"structure", + "members":{ + "DESIRED":{ + "shape":"WholeNumber", + "documentation":"

Ideal number of active instances in the fleet.

" + }, + "MINIMUM":{ + "shape":"WholeNumber", + "documentation":"

Minimum value allowed for the fleet's instance count.

" + }, + "MAXIMUM":{ + "shape":"WholeNumber", + "documentation":"

Maximum value allowed for the fleet's instance count.

" + }, + "PENDING":{ + "shape":"WholeNumber", + "documentation":"

Number of instances in the fleet that are starting but not yet active.

" + }, + "ACTIVE":{ + "shape":"WholeNumber", + "documentation":"

Actual number of active instances in the fleet.

" + }, + "IDLE":{ + "shape":"WholeNumber", + "documentation":"

Number of active instances in the fleet that are not currently hosting a game session.

" + }, + "TERMINATING":{ + "shape":"WholeNumber", + "documentation":"

Number of instances in the fleet that are no longer active but haven't yet been terminated.

" + } + }, + "documentation":"

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

" + }, + "EC2InstanceLimit":{ + "type":"structure", + "members":{ + "EC2InstanceType":{ + "shape":"EC2InstanceType", + "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" + }, + "CurrentInstances":{ + "shape":"WholeNumber", + "documentation":"

Number of instances of the specified type that are currently in use by this AWS account.

" + }, + "InstanceLimit":{ + "shape":"WholeNumber", + "documentation":"

Number of instances allowed.

" + } + }, + "documentation":"

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

" + }, + "EC2InstanceLimitList":{ + "type":"list", + "member":{"shape":"EC2InstanceLimit"} + }, + "EC2InstanceType":{ + "type":"string", + "enum":[ + "t2.micro", + "t2.small", + "t2.medium", + "t2.large", + "c3.large", + "c3.xlarge", + "c3.2xlarge", + "c3.4xlarge", + "c3.8xlarge", + "c4.large", + "c4.xlarge", + "c4.2xlarge", + "c4.4xlarge", + "c4.8xlarge", + "c5.large", + "c5.xlarge", + "c5.2xlarge", + "c5.4xlarge", + "c5.9xlarge", + "c5.12xlarge", + "c5.18xlarge", + "c5.24xlarge", + "r3.large", + "r3.xlarge", + "r3.2xlarge", + "r3.4xlarge", + "r3.8xlarge", + "r4.large", + "r4.xlarge", + "r4.2xlarge", + "r4.4xlarge", + "r4.8xlarge", + "r4.16xlarge", + "r5.large", + "r5.xlarge", + "r5.2xlarge", + "r5.4xlarge", + "r5.8xlarge", + "r5.12xlarge", + "r5.16xlarge", + "r5.24xlarge", + "m3.medium", + "m3.large", + "m3.xlarge", + "m3.2xlarge", + "m4.large", + "m4.xlarge", + "m4.2xlarge", + "m4.4xlarge", + "m4.10xlarge", + "m5.large", + "m5.xlarge", + "m5.2xlarge", + "m5.4xlarge", + "m5.8xlarge", + "m5.12xlarge", + "m5.16xlarge", + "m5.24xlarge" + ] + }, + "Event":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a fleet event.

" + }, + "ResourceId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for an event resource, such as a fleet ID.

" + }, + "EventCode":{ + "shape":"EventCode", + "documentation":"

Type of event being logged. The following events are currently in use:

Fleet creation events:

  • FLEET_CREATED -- A fleet record was successfully created with a status of NEW. Event messaging includes the fleet ID.

  • FLEET_STATE_DOWNLOADING -- Fleet status changed from NEW to DOWNLOADING. The compressed build has started downloading to a fleet instance for installation.

  • FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet instance.

  • FLEET_CREATION_EXTRACTING_BUILD – The game server build was successfully downloaded to an instance, and the build files are now being extracted from the uploaded build and saved to an instance. Failure at this stage prevents a fleet from moving to ACTIVE status. Logs for this stage display a list of the files that are extracted and saved on the instance. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_CREATION_RUNNING_INSTALLER – The game server build files were successfully extracted, and the Amazon GameLift is now running the build's install script (if one is included). Failure in this stage prevents a fleet from moving to ACTIVE status. Logs for this stage list the installation steps and whether or not the install completed successfully. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful, and the Amazon GameLift is now verifying that the game server launch paths, which are specified in the fleet's run-time configuration, exist. If any listed launch path exists, Amazon GameLift tries to launch a game server process and waits for the process to report ready. Failures in this stage prevent a fleet from moving to ACTIVE status. Logs for this stage list the launch paths in the run-time configuration and indicate whether each is found. Access the logs by using the URL in PreSignedLogUrl.

  • FLEET_STATE_VALIDATING -- Fleet status changed from DOWNLOADING to VALIDATING.

  • FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the run-time configuration failed because the executable specified in a launch path does not exist on the instance.

  • FLEET_STATE_BUILDING -- Fleet status changed from VALIDATING to BUILDING.

  • FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the run-time configuration failed because the executable specified in a launch path failed to run on the fleet instance.

  • FLEET_STATE_ACTIVATING -- Fleet status changed from BUILDING to ACTIVATING.

  • FLEET_ACTIVATION_FAILED - The fleet failed to successfully complete one of the steps in the fleet activation process. This event code indicates that the game build was successfully downloaded to a fleet instance, built, and validated, but was not able to start a server process. A possible reason for failure is that the game server is not reporting \"process ready\" to the Amazon GameLift service.

  • FLEET_STATE_ACTIVE -- The fleet's status changed from ACTIVATING to ACTIVE. The fleet is now ready to host game sessions.

VPC peering events:

  • FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established between the VPC for an Amazon GameLift fleet and a VPC in your AWS account.

  • FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed. Event details and status information (see DescribeVpcPeeringConnections) provide additional detail. A common reason for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4 addresses. To resolve this, change the CIDR block for the VPC in your AWS account. For more information on VPC peering failures, see https://docs.aws.amazon.com/AmazonVPC/latest/PeeringGuide/invalid-peering-configurations.html

  • FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully deleted.

Spot instance events:

  • INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a two-minute notification.

Other fleet events:

  • FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings (desired instances, minimum/maximum scaling limits). Event messaging includes the new capacity settings.

  • FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the fleet's game session protection policy setting. Event messaging includes both the old and new policy setting.

  • FLEET_DELETED -- A request to delete a fleet was initiated.

  • GENERIC_EVENT -- An unspecified event has occurred.

" + }, + "Message":{ + "shape":"NonEmptyString", + "documentation":"

Additional information related to the event.

" + }, + "EventTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "PreSignedLogUrl":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Location of stored logs with additional detail that is related to the event. This is useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet creation logs through the Amazon GameLift console.

" + } + }, + "documentation":"

Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.

" + }, + "EventCode":{ + "type":"string", + "enum":[ + "GENERIC_EVENT", + "FLEET_CREATED", + "FLEET_DELETED", + "FLEET_SCALING_EVENT", + "FLEET_STATE_DOWNLOADING", + "FLEET_STATE_VALIDATING", + "FLEET_STATE_BUILDING", + "FLEET_STATE_ACTIVATING", + "FLEET_STATE_ACTIVE", + "FLEET_STATE_ERROR", + "FLEET_INITIALIZATION_FAILED", + "FLEET_BINARY_DOWNLOAD_FAILED", + "FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND", + "FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE", + "FLEET_VALIDATION_TIMED_OUT", + "FLEET_ACTIVATION_FAILED", + "FLEET_ACTIVATION_FAILED_NO_INSTANCES", + "FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED", + "SERVER_PROCESS_INVALID_PATH", + "SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT", + "SERVER_PROCESS_PROCESS_READY_TIMEOUT", + "SERVER_PROCESS_CRASHED", + "SERVER_PROCESS_TERMINATED_UNHEALTHY", + "SERVER_PROCESS_FORCE_TERMINATED", + "SERVER_PROCESS_PROCESS_EXIT_TIMEOUT", + "GAME_SESSION_ACTIVATION_TIMEOUT", + "FLEET_CREATION_EXTRACTING_BUILD", + "FLEET_CREATION_RUNNING_INSTALLER", + "FLEET_CREATION_VALIDATING_RUNTIME_CONFIG", + "FLEET_VPC_PEERING_SUCCEEDED", + "FLEET_VPC_PEERING_FAILED", + "FLEET_VPC_PEERING_DELETED", + "INSTANCE_INTERRUPTED" + ] + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "FleetAction":{ + "type":"string", + "enum":["AUTO_SCALING"] + }, + "FleetActionList":{ + "type":"list", + "member":{"shape":"FleetAction"}, + "max":1, + "min":1 + }, + "FleetAttributes":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet.

" + }, + "FleetArn":{ + "shape":"ArnStringModel", + "documentation":"

Identifier for a fleet that is unique across all regions.

" + }, + "FleetType":{ + "shape":"FleetType", + "documentation":"

Indicates whether the fleet uses on-demand or spot instances. A spot instance in use may be interrupted with a two-minute notification.

" + }, + "InstanceType":{ + "shape":"EC2InstanceType", + "documentation":"

EC2 instance type indicating the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. See Amazon EC2 Instance Types for detailed descriptions.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Human-readable description of the fleet.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "TerminationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "Status":{ + "shape":"FleetStatus", + "documentation":"

Current status of the fleet.

Possible fleet statuses include the following:

  • NEW -- A new fleet has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE -- Hosts can now accept game sessions.

  • ERROR -- An error occurred when downloading, validating, building, or activating the fleet.

  • DELETING -- Hosts are responding to a delete fleet request.

  • TERMINATED -- The fleet no longer exists.

" + }, + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build.

" + }, + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script.

" + }, + "ServerLaunchPath":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Path to a game server executable in the fleet's build, specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.

" + }, + "ServerLaunchParameters":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Game server launch parameters specified for fleets created before 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.

" + }, + "LogPaths":{ + "shape":"StringList", + "documentation":"

Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, Amazon GameLift automatically uploads logs that are stored on each instance at C:\\game\\logs (for Windows) or /local/game/logs (for Linux). Use the Amazon GameLift console to access stored logs.

" + }, + "NewGameSessionProtectionPolicy":{ + "shape":"ProtectionPolicy", + "documentation":"

Type of game session protection to set for all new instances started in the fleet.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.

" + }, + "ResourceCreationLimitPolicy":{ + "shape":"ResourceCreationLimitPolicy", + "documentation":"

Fleet policy to limit the number of game sessions an individual player can create over a span of time.

" + }, + "MetricGroups":{ + "shape":"MetricGroupList", + "documentation":"

Names of metric groups that this fleet is included in. In Amazon CloudWatch, you can view metrics for an individual fleet or aggregated metrics for fleets that are in a fleet metric group. A fleet can be included in only one metric group at a time.

" + }, + "StoppedActions":{ + "shape":"FleetActionList", + "documentation":"

List of fleet actions that have been suspended using StopFleetActions. This includes auto-scaling.

" + }, + "InstanceRoleArn":{ + "shape":"NonEmptyString", + "documentation":"

Unique identifier for an AWS IAM role that manages access to your AWS services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, daemons (background processes). Create a role or look up a role's ARN using the IAM dashboard in the AWS Management Console. Learn more about using on-box credentials for your game servers at Access external resources from a game server.

" + }, + "CertificateConfiguration":{"shape":"CertificateConfiguration"} + }, + "documentation":"

General properties describing a fleet.

" + }, + "FleetAttributesList":{ + "type":"list", + "member":{"shape":"FleetAttributes"} + }, + "FleetCapacity":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet.

" + }, + "InstanceType":{ + "shape":"EC2InstanceType", + "documentation":"

Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. Amazon GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.

" + }, + "InstanceCounts":{ + "shape":"EC2InstanceCounts", + "documentation":"

Current status of fleet capacity.

" + } + }, + "documentation":"

Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.

" + }, + "FleetCapacityExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The specified fleet has no available instances to fulfill a CreateGameSession request. Clients can retry such requests immediately or after a waiting period.

", + "exception":true + }, + "FleetCapacityList":{ + "type":"list", + "member":{"shape":"FleetCapacity"} + }, + "FleetId":{ + "type":"string", + "pattern":"^fleet-\\S+" + }, + "FleetIdList":{ + "type":"list", + "member":{"shape":"FleetId"}, + "min":1 + }, + "FleetStatus":{ + "type":"string", + "enum":[ + "NEW", + "DOWNLOADING", + "VALIDATING", + "BUILDING", + "ACTIVATING", + "ACTIVE", + "DELETING", + "ERROR", + "TERMINATED" + ] + }, + "FleetType":{ + "type":"string", + "enum":[ + "ON_DEMAND", + "SPOT" + ] + }, + "FleetUtilization":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet.

" + }, + "ActiveServerProcessCount":{ + "shape":"WholeNumber", + "documentation":"

Number of server processes in an ACTIVE status currently running across all instances in the fleet

" + }, + "ActiveGameSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Number of active game sessions currently being hosted on all instances in the fleet.

" + }, + "CurrentPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Number of active player sessions currently being hosted on all instances in the fleet.

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.

" + } + }, + "documentation":"

Current status of fleet utilization, including the number of game and player sessions being hosted.

" + }, + "FleetUtilizationList":{ + "type":"list", + "member":{"shape":"FleetUtilization"} + }, + "Float":{"type":"float"}, + "FreeText":{"type":"string"}, + "GameProperty":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"GamePropertyKey", + "documentation":"

Game property identifier.

" + }, + "Value":{ + "shape":"GamePropertyValue", + "documentation":"

Game property value.

" + } + }, + "documentation":"

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide.

" + }, + "GamePropertyKey":{ + "type":"string", + "max":32 + }, + "GamePropertyList":{ + "type":"list", + "member":{"shape":"GameProperty"}, + "max":16 + }, + "GamePropertyValue":{ + "type":"string", + "max":96 + }, + "GameSession":{ + "type":"structure", + "members":{ + "GameSessionId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the game session. A game session ARN has the following format: arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a game session. Session names do not need to be unique.

" + }, + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that the game session is running on.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "TerminationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "CurrentPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Number of players currently in the game session.

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" + }, + "Status":{ + "shape":"GameSessionStatus", + "documentation":"

Current status of the game session. A game session must have an ACTIVE status to have player sessions.

" + }, + "StatusReason":{ + "shape":"GameSessionStatusReason", + "documentation":"

Provides additional information about game session status. INTERRUPTED indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). You can search for active game sessions based on this custom data with SearchGameSessions.

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

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + }, + "DnsName":{"shape":"DnsName"}, + "Port":{ + "shape":"PortNumber", + "documentation":"

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + }, + "PlayerSessionCreationPolicy":{ + "shape":"PlayerSessionCreationPolicy", + "documentation":"

Indicates whether or not the game session is accepting new players.

" + }, + "CreatorId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + }, + "MatchmakerData":{ + "shape":"MatchmakerData", + "documentation":"

Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see StartMatchBackfill).

" + } + }, + "documentation":"

Properties describing a game session.

A game session in ACTIVE status can host players. When a game session ends, its status is set to TERMINATED.

Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.

" + }, + "GameSessionActivationTimeoutSeconds":{ + "type":"integer", + "max":600, + "min":1 + }, + "GameSessionConnectionInfo":{ + "type":"structure", + "members":{ + "GameSessionArn":{ + "shape":"ArnStringModel", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

" + }, + "IpAddress":{ + "shape":"StringModel", + "documentation":"

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + }, + "DnsName":{"shape":"DnsName"}, + "Port":{ + "shape":"PositiveInteger", + "documentation":"

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + }, + "MatchedPlayerSessions":{ + "shape":"MatchedPlayerSessionList", + "documentation":"

Collection of player session IDs, one for each player ID that was included in the original matchmaking request.

" + } + }, + "documentation":"

Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

" + }, + "GameSessionData":{ + "type":"string", + "max":4096, + "min":1 + }, + "GameSessionDetail":{ + "type":"structure", + "members":{ + "GameSession":{ + "shape":"GameSession", + "documentation":"

Object that describes a game session.

" + }, + "ProtectionPolicy":{ + "shape":"ProtectionPolicy", + "documentation":"

Current status of protection for the game session.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" + } + }, + "documentation":"

A game session's properties plus the protection policy currently in force.

" + }, + "GameSessionDetailList":{ + "type":"list", + "member":{"shape":"GameSessionDetail"} + }, + "GameSessionFullException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.

", + "exception":true + }, + "GameSessionList":{ + "type":"list", + "member":{"shape":"GameSession"} + }, + "GameSessionPlacement":{ + "type":"structure", + "members":{ + "PlacementId":{ + "shape":"IdStringModel", + "documentation":"

Unique identifier for a game session placement.

" + }, + "GameSessionQueueName":{ + "shape":"GameSessionQueueName", + "documentation":"

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

" + }, + "Status":{ + "shape":"GameSessionPlacementState", + "documentation":"

Current status of the game session placement request.

  • PENDING -- The placement request is currently in the queue waiting to be processed.

  • FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.

  • CANCELLED -- The placement request was canceled with a call to StopGameSessionPlacement.

  • TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" + }, + "GameSessionName":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a game session. Session names do not need to be unique.

" + }, + "GameSessionId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the game session. This value is set once the new game session is placed (placement status is FULFILLED).

" + }, + "GameSessionArn":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all regions. You can use this value as a GameSessionId value as needed.

" + }, + "GameSessionRegion":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Name of the region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).

" + }, + "PlayerLatencies":{ + "shape":"PlayerLatencyList", + "documentation":"

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this request was completed, canceled, or timed out.

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

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

" + }, + "DnsName":{"shape":"DnsName"}, + "Port":{ + "shape":"PortNumber", + "documentation":"

Port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED).

" + }, + "PlacedPlayerSessions":{ + "shape":"PlacedPlayerSessionList", + "documentation":"

Collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID. Retrieve full player sessions by calling DescribePlayerSessions with the player session ID.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + }, + "MatchmakerData":{ + "shape":"MatchmakerData", + "documentation":"

Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.

" + } + }, + "documentation":"

Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.

Game session placement-related operations include:

" + }, + "GameSessionPlacementState":{ + "type":"string", + "enum":[ + "PENDING", + "FULFILLED", + "CANCELLED", + "TIMED_OUT", + "FAILED" + ] + }, + "GameSessionQueue":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"GameSessionQueueName", + "documentation":"

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

" + }, + "GameSessionQueueArn":{ + "shape":"ArnStringModel", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>.

" + }, + "TimeoutInSeconds":{ + "shape":"WholeNumber", + "documentation":"

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" + }, + "PlayerLatencyPolicies":{ + "shape":"PlayerLatencyPolicyList", + "documentation":"

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement.

" + }, + "Destinations":{ + "shape":"GameSessionQueueDestinationList", + "documentation":"

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order.

" + } + }, + "documentation":"

Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:

  • The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.

  • The length of time that placement requests can wait in the queue before timing out.

  • A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.

" + }, + "GameSessionQueueDestination":{ + "type":"structure", + "members":{ + "DestinationArn":{ + "shape":"ArnStringModel", + "documentation":"

Amazon Resource Name (ARN) assigned to fleet or fleet alias. ARNs, which include a fleet ID or alias ID and a region name, provide a unique identifier across all regions.

" + } + }, + "documentation":"

Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.

" + }, + "GameSessionQueueDestinationList":{ + "type":"list", + "member":{"shape":"GameSessionQueueDestination"} + }, + "GameSessionQueueList":{ + "type":"list", + "member":{"shape":"GameSessionQueue"} + }, + "GameSessionQueueName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "GameSessionQueueNameList":{ + "type":"list", + "member":{"shape":"GameSessionQueueName"} + }, + "GameSessionStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "ACTIVATING", + "TERMINATED", + "TERMINATING", + "ERROR" + ] + }, + "GameSessionStatusReason":{ + "type":"string", + "enum":["INTERRUPTED"] + }, + "GetGameSessionLogUrlInput":{ + "type":"structure", + "required":["GameSessionId"], + "members":{ + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to get logs for.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "GetGameSessionLogUrlOutput":{ + "type":"structure", + "members":{ + "PreSignedUrl":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Location of the requested game session logs, available for download. This URL is valid for 15 minutes, after which S3 will reject any download request using this URL. You can request a new URL any time within the 14-day period that the logs are retained.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "GetInstanceAccessInput":{ + "type":"structure", + "required":[ + "FleetId", + "InstanceId" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that contains the instance you want access to. The fleet can be in any of the following statuses: ACTIVATING, ACTIVE, or ERROR. Fleets with an ERROR status may be accessible for a short time before they are deleted.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Unique identifier for an instance you want to get access to. You can access an instance in any status.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "GetInstanceAccessOutput":{ + "type":"structure", + "members":{ + "InstanceAccess":{ + "shape":"InstanceAccess", + "documentation":"

Object that contains connection information for a fleet instance, including IP address and access credentials.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "IdStringModel":{ + "type":"string", + "max":48, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.

", + "exception":true + }, + "Instance":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that the instance is in.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Unique identifier for an instance.

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

IP address assigned to the instance.

" + }, + "DnsName":{"shape":"DnsName"}, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

Operating system that is running on this instance.

" + }, + "Type":{ + "shape":"EC2InstanceType", + "documentation":"

EC2 instance type that defines the computing resources of this instance.

" + }, + "Status":{ + "shape":"InstanceStatus", + "documentation":"

Current status of the instance. Possible statuses include the following:

  • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "documentation":"

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.

" + }, + "InstanceAccess":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet containing the instance being accessed.

" + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

Unique identifier for an instance being accessed.

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

IP address assigned to the instance.

" + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

Operating system that is running on the instance.

" + }, + "Credentials":{ + "shape":"InstanceCredentials", + "documentation":"

Credentials required to access the instance.

" + } + }, + "documentation":"

Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.

" + }, + "InstanceCredentials":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"NonEmptyString", + "documentation":"

User login string.

" + }, + "Secret":{ + "shape":"NonEmptyString", + "documentation":"

Secret string. For Windows instances, the secret is a password for use with Windows Remote Desktop. For Linux instances, it is a private key (which must be saved as a .pem file) for use with SSH.

" + } + }, + "documentation":"

Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.

", + "sensitive":true + }, + "InstanceId":{ + "type":"string", + "pattern":"[a-zA-Z0-9\\.-]+" + }, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstanceStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "TERMINATING" + ] + }, + "Integer":{"type":"integer"}, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

", + "exception":true, + "fault":true + }, + "InvalidFleetStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.

", + "exception":true + }, + "InvalidGameSessionStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

", + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpPermission":{ + "type":"structure", + "required":[ + "FromPort", + "ToPort", + "IpRange", + "Protocol" + ], + "members":{ + "FromPort":{ + "shape":"PortNumber", + "documentation":"

Starting value for a range of allowed port numbers.

" + }, + "ToPort":{ + "shape":"PortNumber", + "documentation":"

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

" + }, + "IpRange":{ + "shape":"NonBlankString", + "documentation":"

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".

" + }, + "Protocol":{ + "shape":"IpProtocol", + "documentation":"

Network communication protocol used by the fleet.

" + } + }, + "documentation":"

A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an Amazon GameLift. New game sessions that are started on the fleet are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. For fleets created with a custom game server, the ranges reflect the server's game session assignments. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP for use by the Realtime servers.

" + }, + "IpPermissionsList":{ + "type":"list", + "member":{"shape":"IpPermission"}, + "max":50 + }, + "IpProtocol":{ + "type":"string", + "enum":[ + "TCP", + "UDP" + ] + }, + "LatencyMap":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"PositiveInteger"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.

", + "exception":true + }, + "ListAliasesInput":{ + "type":"structure", + "members":{ + "RoutingStrategyType":{ + "shape":"RoutingStrategyType", + "documentation":"

Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty.

Possible routing types include the following:

  • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

" + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

Descriptive label that is associated with an alias. Alias names do not need to be unique.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "ListAliasesOutput":{ + "type":"structure", + "members":{ + "Aliases":{ + "shape":"AliasList", + "documentation":"

Collection of alias records that match the list request.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ListBuildsInput":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BuildStatus", + "documentation":"

Build status to filter results by. To retrieve all builds, leave this parameter empty.

Possible build statuses include the following:

  • INITIALIZED -- A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this status. When a build is successfully created, the build status is set to this value.

  • READY -- The game build has been successfully uploaded. You can now create new fleets for this build.

  • FAILED -- The game build upload failed. You cannot create new fleets for this build.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "ListBuildsOutput":{ + "type":"structure", + "members":{ + "Builds":{ + "shape":"BuildList", + "documentation":"

Collection of build records that match the request.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ListFleetsInput":{ + "type":"structure", + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.

" + }, + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script to return fleets for. Use this parameter to return only fleets using the specified script. To retrieve all fleets, leave this parameter empty.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "ListFleetsOutput":{ + "type":"structure", + "members":{ + "FleetIds":{ + "shape":"FleetIdList", + "documentation":"

Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, or DescribeFleetUtilization.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ListScriptsInput":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + } + }, + "ListScriptsOutput":{ + "type":"structure", + "members":{ + "Scripts":{ + "shape":"ScriptList", + "documentation":"

Set of properties describing the requested script.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + } + }, + "MatchedPlayerSession":{ + "type":"structure", + "members":{ + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player

" + }, + "PlayerSessionId":{ + "shape":"PlayerSessionId", + "documentation":"

Unique identifier for a player session

" + } + }, + "documentation":"

Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.

When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.

" + }, + "MatchedPlayerSessionList":{ + "type":"list", + "member":{"shape":"MatchedPlayerSession"} + }, + "MatchmakerData":{ + "type":"string", + "max":390000, + "min":1 + }, + "MatchmakingAcceptanceTimeoutInteger":{ + "type":"integer", + "max":600, + "min":1 + }, + "MatchmakingConfiguration":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with matchmaking configuration.

" + }, + "GameSessionQueueArns":{ + "shape":"QueueArnsList", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

" + }, + "RequestTimeoutSeconds":{ + "shape":"MatchmakingRequestTimeoutInteger", + "documentation":"

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

" + }, + "AcceptanceTimeoutSeconds":{ + "shape":"MatchmakingAcceptanceTimeoutInteger", + "documentation":"

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

" + }, + "AcceptanceRequired":{ + "shape":"BooleanModel", + "documentation":"

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

" + }, + "RuleSetName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

" + }, + "NotificationTarget":{ + "shape":"SnsArnStringModel", + "documentation":"

SNS topic ARN that is set up to receive matchmaking notifications.

" + }, + "AdditionalPlayerCount":{ + "shape":"WholeNumber", + "documentation":"

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

" + }, + "CustomEventData":{ + "shape":"CustomEventData", + "documentation":"

Information to attach to all events related to the matchmaking configuration.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "BackfillMode":{ + "shape":"BackfillMode", + "documentation":"

Method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates StartMatchBackfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

" + } + }, + "documentation":"

Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.

" + }, + "MatchmakingConfigurationList":{ + "type":"list", + "member":{"shape":"MatchmakingConfiguration"} + }, + "MatchmakingConfigurationStatus":{ + "type":"string", + "enum":[ + "CANCELLED", + "COMPLETED", + "FAILED", + "PLACING", + "QUEUED", + "REQUIRES_ACCEPTANCE", + "SEARCHING", + "TIMED_OUT" + ] + }, + "MatchmakingIdList":{ + "type":"list", + "member":{"shape":"MatchmakingIdStringModel"} + }, + "MatchmakingIdStringModel":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9-\\.]*" + }, + "MatchmakingRequestTimeoutInteger":{ + "type":"integer", + "max":43200, + "min":1 + }, + "MatchmakingRuleSet":{ + "type":"structure", + "required":["RuleSetBody"], + "members":{ + "RuleSetName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set

" + }, + "RuleSetBody":{ + "shape":"RuleSetBody", + "documentation":"

Collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "documentation":"

Set of rule statements, used with FlexMatch, that determine how to build your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.

A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set.

  • Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.

  • Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.

  • Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.

  • Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.

" + }, + "MatchmakingRuleSetList":{ + "type":"list", + "member":{"shape":"MatchmakingRuleSet"} + }, + "MatchmakingRuleSetNameList":{ + "type":"list", + "member":{"shape":"MatchmakingIdStringModel"}, + "max":10, + "min":1 + }, + "MatchmakingTicket":{ + "type":"structure", + "members":{ + "TicketId":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking ticket.

" + }, + "ConfigurationName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Name of the MatchmakingConfiguration that is used with this ticket. Matchmaking configurations determine how players are grouped into a match and how a new game session is created for the match.

" + }, + "Status":{ + "shape":"MatchmakingConfigurationStatus", + "documentation":"

Current status of the matchmaking request.

  • QUEUED -- The matchmaking request has been received and is currently waiting to be processed.

  • SEARCHING -- The matchmaking request is currently being processed.

  • REQUIRES_ACCEPTANCE -- A match has been proposed and the players must accept the match (see AcceptMatch). This status is used only with requests that use a matchmaking configuration with a player acceptance requirement.

  • PLACING -- The FlexMatch engine has matched players and is in the process of placing a new game session for the match.

  • COMPLETED -- Players have been matched and a game session is ready to host the players. A ticket in this state contains the necessary connection information for players.

  • FAILED -- The matchmaking request was not completed.

  • CANCELLED -- The matchmaking request was canceled. This may be the result of a call to StopMatchmaking or a proposed match that one or more players failed to accept.

  • TIMED_OUT -- The matchmaking request was not successful within the duration specified in the matchmaking configuration.

Matchmaking requests that fail to successfully complete (statuses FAILED, CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.

" + }, + "StatusReason":{ + "shape":"StringModel", + "documentation":"

Code to explain the current status. For example, a status reason may indicate when a ticket has returned to SEARCHING status after a proposed match fails to receive player acceptances.

" + }, + "StatusMessage":{ + "shape":"StringModel", + "documentation":"

Additional information about the current status.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this matchmaking request was received. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this matchmaking request stopped being processed due to success, failure, or cancellation. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "Players":{ + "shape":"PlayerList", + "documentation":"

A set of Player objects, each representing a player to find matches for. Players are identified by a unique player ID and may include latency data for use during matchmaking. If the ticket is in status COMPLETED, the Player objects include the team the players were assigned to in the resulting match.

" + }, + "GameSessionConnectionInfo":{ + "shape":"GameSessionConnectionInfo", + "documentation":"

Identifier and connection information of the game session created for the match. This information is added to the ticket only after the matchmaking request has been successfully completed.

" + }, + "EstimatedWaitTime":{ + "shape":"WholeNumber", + "documentation":"

Average amount of time (in seconds) that players are currently waiting for a match. If there is not enough recent data, this property may be empty.

" + } + }, + "documentation":"

Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.

" + }, + "MatchmakingTicketList":{ + "type":"list", + "member":{"shape":"MatchmakingTicket"} + }, + "MaxConcurrentGameSessionActivations":{ + "type":"integer", + "max":2147483647, + "min":1 + }, + "MetricGroup":{ + "type":"string", + "max":255, + "min":1 + }, + "MetricGroupList":{ + "type":"list", + "member":{"shape":"MetricGroup"}, + "max":1 + }, + "MetricName":{ + "type":"string", + "enum":[ + "ActivatingGameSessions", + "ActiveGameSessions", + "ActiveInstances", + "AvailableGameSessions", + "AvailablePlayerSessions", + "CurrentPlayerSessions", + "IdleInstances", + "PercentAvailableGameSessions", + "PercentIdleInstances", + "QueueDepth", + "WaitTime" + ] + }, + "NonBlankAndLengthConstraintString":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "NonBlankString":{ + "type":"string", + "pattern":"[^\\s]+" + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "NonZeroAndMaxString":{ + "type":"string", + "max":1024, + "min":1 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

A service resource associated with the request could not be found. Clients should not retry such requests.

", + "exception":true + }, + "OperatingSystem":{ + "type":"string", + "enum":[ + "WINDOWS_2012", + "AMAZON_LINUX", + "AMAZON_LINUX_2" + ] + }, + "PlacedPlayerSession":{ + "type":"structure", + "members":{ + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player that is associated with this player session.

" + }, + "PlayerSessionId":{ + "shape":"PlayerSessionId", + "documentation":"

Unique identifier for a player session.

" + } + }, + "documentation":"

Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.

" + }, + "PlacedPlayerSessionList":{ + "type":"list", + "member":{"shape":"PlacedPlayerSession"} + }, + "Player":{ + "type":"structure", + "members":{ + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player

" + }, + "PlayerAttributes":{ + "shape":"PlayerAttributeMap", + "documentation":"

Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: \"PlayerAttributes\": {\"skill\": {\"N\": \"23\"}, \"gameMode\": {\"S\": \"deathmatch\"}}.

" + }, + "Team":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

" + }, + "LatencyInMs":{ + "shape":"LatencyMap", + "documentation":"

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.

If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.

" + } + }, + "documentation":"

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

" + }, + "PlayerAttributeMap":{ + "type":"map", + "key":{"shape":"NonZeroAndMaxString"}, + "value":{"shape":"AttributeValue"} + }, + "PlayerData":{ + "type":"string", + "max":2048, + "min":1 + }, + "PlayerDataMap":{ + "type":"map", + "key":{"shape":"NonZeroAndMaxString"}, + "value":{"shape":"PlayerData"} + }, + "PlayerIdList":{ + "type":"list", + "member":{"shape":"NonZeroAndMaxString"}, + "max":25, + "min":1 + }, + "PlayerLatency":{ + "type":"structure", + "members":{ + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player associated with the latency data.

" + }, + "RegionIdentifier":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Name of the region that is associated with the latency value.

" + }, + "LatencyInMilliseconds":{ + "shape":"Float", + "documentation":"

Amount of time that represents the time lag experienced by the player when connected to the specified region.

" + } + }, + "documentation":"

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.

" + }, + "PlayerLatencyList":{ + "type":"list", + "member":{"shape":"PlayerLatency"} + }, + "PlayerLatencyPolicy":{ + "type":"structure", + "members":{ + "MaximumIndividualPlayerLatencyMilliseconds":{ + "shape":"WholeNumber", + "documentation":"

The maximum latency value that is allowed for any player, in milliseconds. All policies must have a value set for this property.

" + }, + "PolicyDurationSeconds":{ + "shape":"WholeNumber", + "documentation":"

The length of time, in seconds, that the policy is enforced while placing a new game session. A null value for this property means that the policy is enforced until the queue times out.

" + } + }, + "documentation":"

Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.

" + }, + "PlayerLatencyPolicyList":{ + "type":"list", + "member":{"shape":"PlayerLatencyPolicy"} + }, + "PlayerList":{ + "type":"list", + "member":{"shape":"Player"} + }, + "PlayerSession":{ + "type":"structure", + "members":{ + "PlayerSessionId":{ + "shape":"PlayerSessionId", + "documentation":"

Unique identifier for a player session.

" + }, + "PlayerId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a player that is associated with this player session.

" + }, + "GameSessionId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the game session that the player session is connected to.

" + }, + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that the player's game session is running on.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "TerminationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "Status":{ + "shape":"PlayerSessionStatus", + "documentation":"

Current status of the player session.

Possible player session statuses include the following:

  • RESERVED -- The player session request has been received, but the player has not yet connected to the server process and/or been validated.

  • ACTIVE -- The player has been validated by the server process and is currently connected.

  • COMPLETED -- The player connection has been dropped.

  • TIMEDOUT -- A player session request was received, but the player did not connect and/or was not validated within the timeout limit (60 seconds).

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

IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.

" + }, + "DnsName":{"shape":"DnsName"}, + "Port":{ + "shape":"PortNumber", + "documentation":"

Port number for the game session. To connect to a Amazon GameLift server process, an app needs both the IP address and port number.

" + }, + "PlayerData":{ + "shape":"PlayerData", + "documentation":"

Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.

" + } + }, + "documentation":"

Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status RESERVED) or actual player activity in a game session (status ACTIVE). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.

When a player disconnects, the player session status changes to COMPLETED. Once the session ends, the player session object is retained for 30 days and then removed.

" + }, + "PlayerSessionCreationPolicy":{ + "type":"string", + "enum":[ + "ACCEPT_ALL", + "DENY_ALL" + ] + }, + "PlayerSessionId":{ + "type":"string", + "pattern":"^psess-\\S+" + }, + "PlayerSessionList":{ + "type":"list", + "member":{"shape":"PlayerSession"} + }, + "PlayerSessionStatus":{ + "type":"string", + "enum":[ + "RESERVED", + "ACTIVE", + "COMPLETED", + "TIMEDOUT" + ] + }, + "PolicyType":{ + "type":"string", + "enum":[ + "RuleBased", + "TargetBased" + ] + }, + "PortNumber":{ + "type":"integer", + "max":60000, + "min":1 + }, + "PositiveInteger":{ + "type":"integer", + "min":1 + }, + "PositiveLong":{ + "type":"long", + "min":1 + }, + "ProtectionPolicy":{ + "type":"string", + "enum":[ + "NoProtection", + "FullProtection" + ] + }, + "PutScalingPolicyInput":{ + "type":"structure", + "required":[ + "Name", + "FleetId", + "MetricName" + ], + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.

" + }, + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to apply this policy to. The fleet cannot be in any of the following statuses: ERROR or DELETING.

" + }, + "ScalingAdjustment":{ + "shape":"Integer", + "documentation":"

Amount of adjustment to make, based on the scaling adjustment type.

" + }, + "ScalingAdjustmentType":{ + "shape":"ScalingAdjustmentType", + "documentation":"

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

  • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity -- set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of \"-10\" scales the fleet down by 10%.

" + }, + "Threshold":{ + "shape":"Double", + "documentation":"

Metric value used to trigger a scaling event.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperatorType", + "documentation":"

Comparison operator to use when measuring the metric against the threshold value.

" + }, + "EvaluationPeriods":{ + "shape":"PositiveInteger", + "documentation":"

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

  • ActivatingGameSessions -- Game sessions in the process of being created.

  • ActiveGameSessions -- Game sessions that are currently running.

  • ActiveInstances -- Fleet instances that are currently running at least one game session.

  • AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

  • AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

  • CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

  • IdleInstances -- Active instances that are currently hosting zero game sessions.

  • PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

  • PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

  • QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

  • WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

" + }, + "TargetConfiguration":{ + "shape":"TargetConfiguration", + "documentation":"

Object that contains settings for a target-based scaling policy.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "PutScalingPolicyOutput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "QueueArnsList":{ + "type":"list", + "member":{"shape":"ArnStringModel"} + }, + "RequestUploadCredentialsInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to get credentials for.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "RequestUploadCredentialsOutput":{ + "type":"structure", + "members":{ + "UploadCredentials":{ + "shape":"AwsCredentials", + "documentation":"

AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.

" + }, + "StorageLocation":{ + "shape":"S3Location", + "documentation":"

Amazon S3 path and key, identifying where the game build files are stored.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ResolveAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for the alias you want to resolve.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "ResolveAliasOutput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Fleet identifier that is associated with the requested alias.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ResourceCreationLimitPolicy":{ + "type":"structure", + "members":{ + "NewGameSessionsPerCreator":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of game sessions that an individual can create during the policy period.

" + }, + "PolicyPeriodInMinutes":{ + "shape":"WholeNumber", + "documentation":"

Time span used in evaluating the resource creation limit policy.

" + } + }, + "documentation":"

Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: \"An individual player can create a maximum number of new game sessions within a specified time period\".

The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than 10 game sessions in the past 60 minutes.

" + }, + "RoutingStrategy":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"RoutingStrategyType", + "documentation":"

Type of routing strategy.

Possible routing types include the following:

  • SIMPLE -- The alias resolves to one specific fleet. Use this type when routing to active fleets.

  • TERMINAL -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

" + }, + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that the alias points to.

" + }, + "Message":{ + "shape":"FreeText", + "documentation":"

Message text to be used with a terminal routing strategy.

" + } + }, + "documentation":"

Routing configuration for a fleet alias.

" + }, + "RoutingStrategyType":{ + "type":"string", + "enum":[ + "SIMPLE", + "TERMINAL" + ] + }, + "RuleSetBody":{ + "type":"string", + "max":65535, + "min":1 + }, + "RuleSetLimit":{ + "type":"integer", + "max":10, + "min":1 + }, + "RuntimeConfiguration":{ + "type":"structure", + "members":{ + "ServerProcesses":{ + "shape":"ServerProcessList", + "documentation":"

Collection of server process configurations that describe which server processes to run on each instance in a fleet.

" + }, + "MaxConcurrentGameSessionActivations":{ + "shape":"MaxConcurrentGameSessionActivations", + "documentation":"

Maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.

" + }, + "GameSessionActivationTimeoutSeconds":{ + "shape":"GameSessionActivationTimeoutSeconds", + "documentation":"

Maximum amount of time (in seconds) that a game session can remain in status ACTIVATING. If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED.

" + } + }, + "documentation":"

A collection of server process configurations that describe what processes to run on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instance in the fleet starts the specified server processes and continues to start new processes as existing processes end. An instance regularly checks for an updated run-time configuration.

The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Learn more about Running Multiple Processes on a Fleet .

A Amazon GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes in a run-time configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object.

" + }, + "S3Location":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"NonEmptyString", + "documentation":"

Amazon S3 bucket identifier. This is the name of the S3 bucket.

" + }, + "Key":{ + "shape":"NonEmptyString", + "documentation":"

Name of the zip file containing the build files or script files.

" + }, + "RoleArn":{ + "shape":"NonEmptyString", + "documentation":"

Amazon Resource Name (ARN) for an IAM role that allows Amazon GameLift to access the S3 bucket.

" + }, + "ObjectVersion":{ + "shape":"NonEmptyString", + "documentation":"

Version of the file, if object versioning is turned on for the bucket. Amazon GameLift uses this information when retrieving files from an S3 bucket that you own. Use this parameter to specify a specific version of the file; if not set, the latest version of the file is retrieved.

" + } + }, + "documentation":"

Location in Amazon Simple Storage Service (Amazon S3) where build or script files are stored for access by Amazon GameLift. This location is specified in CreateBuild, CreateScript, and UpdateScript requests.

" + }, + "ScalingAdjustmentType":{ + "type":"string", + "enum":[ + "ChangeInCapacity", + "ExactCapacity", + "PercentChangeInCapacity" + ] + }, + "ScalingPolicy":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that is associated with this scaling policy.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a scaling policy. Policy names do not need to be unique.

" + }, + "Status":{ + "shape":"ScalingStatusType", + "documentation":"

Current status of the scaling policy. The scaling policy can be in force only when in an ACTIVE status. Scaling policies can be suspended for individual fleets (see StopFleetActions; if suspended for a fleet, the policy status does not change. View a fleet's stopped actions by calling DescribeFleetCapacity.

  • ACTIVE -- The scaling policy can be used for auto-scaling a fleet.

  • UPDATE_REQUESTED -- A request to update the scaling policy has been received.

  • UPDATING -- A change is being made to the scaling policy.

  • DELETE_REQUESTED -- A request to delete the scaling policy has been received.

  • DELETING -- The scaling policy is being deleted.

  • DELETED -- The scaling policy has been deleted.

  • ERROR -- An error occurred in creating the policy. It should be removed and recreated.

" + }, + "ScalingAdjustment":{ + "shape":"Integer", + "documentation":"

Amount of adjustment to make, based on the scaling adjustment type.

" + }, + "ScalingAdjustmentType":{ + "shape":"ScalingAdjustmentType", + "documentation":"

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

  • ChangeInCapacity -- add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.

  • ExactCapacity -- set the instance count to the scaling adjustment value.

  • PercentChangeInCapacity -- increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperatorType", + "documentation":"

Comparison operator to use when measuring a metric against the threshold value.

" + }, + "Threshold":{ + "shape":"Double", + "documentation":"

Metric value used to trigger a scaling event.

" + }, + "EvaluationPeriods":{ + "shape":"PositiveInteger", + "documentation":"

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

" + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For detailed descriptions of fleet metrics, see Monitor Amazon GameLift with Amazon CloudWatch.

  • ActivatingGameSessions -- Game sessions in the process of being created.

  • ActiveGameSessions -- Game sessions that are currently running.

  • ActiveInstances -- Fleet instances that are currently running at least one game session.

  • AvailableGameSessions -- Additional game sessions that fleet could host simultaneously, given current capacity.

  • AvailablePlayerSessions -- Empty player slots in currently active game sessions. This includes game sessions that are not currently accepting players. Reserved player slots are not included.

  • CurrentPlayerSessions -- Player slots in active game sessions that are being used by a player or are reserved for a player.

  • IdleInstances -- Active instances that are currently hosting zero game sessions.

  • PercentAvailableGameSessions -- Unused percentage of the total number of game sessions that a fleet could host simultaneously, given current capacity. Use this metric for a target-based scaling policy.

  • PercentIdleInstances -- Percentage of the total number of active instances that are hosting zero game sessions.

  • QueueDepth -- Pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

  • WaitTime -- Current wait time for pending game session placement requests, in any queue, where the current fleet is the top-priority destination.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

Type of scaling policy to create. For a target-based policy, set the parameter MetricName to 'PercentAvailableGameSessions' and specify a TargetConfiguration. For a rule-based policy set the following parameters: MetricName, ComparisonOperator, Threshold, EvaluationPeriods, ScalingAdjustmentType, and ScalingAdjustment.

" + }, + "TargetConfiguration":{ + "shape":"TargetConfiguration", + "documentation":"

Object that contains settings for a target-based scaling policy.

" + } + }, + "documentation":"

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

" + }, + "ScalingPolicyList":{ + "type":"list", + "member":{"shape":"ScalingPolicy"} + }, + "ScalingStatusType":{ + "type":"string", + "enum":[ + "ACTIVE", + "UPDATE_REQUESTED", + "UPDATING", + "DELETE_REQUESTED", + "DELETING", + "DELETED", + "ERROR" + ] + }, + "Script":{ + "type":"structure", + "members":{ + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a script. Script names do not need to be unique.

" + }, + "Version":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique.

" + }, + "SizeOnDisk":{ + "shape":"PositiveLong", + "documentation":"

File size of the uploaded Realtime script, expressed in bytes. When files are uploaded from an S3 location, this value remains at \"0\".

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "StorageLocation":{"shape":"S3Location"} + }, + "documentation":"

Properties describing a Realtime script.

Related operations

" + }, + "ScriptId":{ + "type":"string", + "pattern":"^script-\\S+|^arn:.*script-\\S+" + }, + "ScriptList":{ + "type":"list", + "member":{"shape":"Script"} + }, + "SearchGameSessionsInput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

" + }, + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for an alias associated with the fleet to search for active game sessions. Each request must reference either a fleet ID or alias ID, but not both.

" + }, + "FilterExpression":{ + "shape":"NonZeroAndMaxString", + "documentation":"

String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.

A filter expression can contain one or multiple conditions. Each condition consists of the following:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

  • Comparator -- Valid comparators are: =, <>, <, >, <=, >=.

  • Value -- Value to be searched for. Values may be numbers, boolean values (true/false) or strings depending on the operand. String values are case sensitive and must be enclosed in single quotes. Special characters must be escaped. Boolean and string values can only be used with the comparators = and <>. For example, the following filter expression searches on gameSessionName: \"FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\".

To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).

Session search evaluates conditions from left to right using the following precedence rules:

  1. =, <>, <, >, <=, >=

  2. Parentheses

  3. NOT

  4. AND

  5. OR

For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".

" + }, + "SortExpression":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:

  • Operand -- Name of a game session attribute. Valid values are gameSessionName, gameSessionId, gameSessionProperties, maximumSessions, creationTimeMillis, playerSessionCount, hasAvailablePlayerSessions.

  • Order -- Valid sort orders are ASC (ascending) and DESC (descending).

For example, this sort expression returns the oldest active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value for the sort operand are returned at the end of the list.

" + }, + "Limit":{ + "shape":"PositiveInteger", + "documentation":"

Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "SearchGameSessionsOutput":{ + "type":"structure", + "members":{ + "GameSessions":{ + "shape":"GameSessionList", + "documentation":"

Collection of objects containing game session properties for each session matching the request.

" + }, + "NextToken":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "ServerProcess":{ + "type":"structure", + "required":[ + "LaunchPath", + "ConcurrentExecutions" + ], + "members":{ + "LaunchPath":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:\\game. Example: \"C:\\game\\MyGame\\server.exe\"

  • Linux: /local/game. Examples: \"/local/game/MyGame/server.exe\" or \"/local/game/MyRealtimeScript.js\"

" + }, + "Parameters":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Optional list of parameters to pass to the server executable or Realtime script on launch.

" + }, + "ConcurrentExecutions":{ + "shape":"PositiveInteger", + "documentation":"

Number of server processes using this configuration to run concurrently on an instance.

" + } + }, + "documentation":"

A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration .

" + }, + "ServerProcessList":{ + "type":"list", + "member":{"shape":"ServerProcess"}, + "max":50, + "min":1 + }, + "SnsArnStringModel":{ + "type":"string", + "max":300, + "min":0, + "pattern":"[a-zA-Z0-9:_/-]*" + }, + "StartFleetActionsInput":{ + "type":"structure", + "required":[ + "FleetId", + "Actions" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet

" + }, + "Actions":{ + "shape":"FleetActionList", + "documentation":"

List of actions to restart on the fleet.

" + } + } + }, + "StartFleetActionsOutput":{ + "type":"structure", + "members":{ + } + }, + "StartGameSessionPlacementInput":{ + "type":"structure", + "required":[ + "PlacementId", + "GameSessionQueueName", + "MaximumPlayerSessionCount" + ], + "members":{ + "PlacementId":{ + "shape":"IdStringModel", + "documentation":"

Unique identifier to assign to the new game session placement. This value is developer-defined. The value must be unique across all regions and cannot be reused unless you are resubmitting a canceled or timed-out placement request.

" + }, + "GameSessionQueueName":{ + "shape":"GameSessionQueueName", + "documentation":"

Name of the queue to use to place the new game session.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" + }, + "GameSessionName":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a game session. Session names do not need to be unique.

" + }, + "PlayerLatencies":{ + "shape":"PlayerLatencyList", + "documentation":"

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. This information is used to try to place the new game session where it can offer the best possible gameplay experience for the players.

" + }, + "DesiredPlayerSessions":{ + "shape":"DesiredPlayerSessionList", + "documentation":"

Set of information on each player to create a player session for.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "StartGameSessionPlacementOutput":{ + "type":"structure", + "members":{ + "GameSessionPlacement":{ + "shape":"GameSessionPlacement", + "documentation":"

Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "StartMatchBackfillInput":{ + "type":"structure", + "required":[ + "ConfigurationName", + "GameSessionArn", + "Players" + ], + "members":{ + "TicketId":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

" + }, + "ConfigurationName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value \"arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4\", the matchmaking configuration name is \"MM-4v4\".) Use only the name for this parameter.

" + }, + "GameSessionArn":{ + "shape":"ArnStringModel", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it.

" + }, + "Players":{ + "shape":"PlayerList", + "documentation":"

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

  • PlayerID, PlayerAttributes, Team -\\\\- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

  • LatencyInMs -\\\\- If the matchmaker uses player latency, include a latency value, in milliseconds, for the region that the game session is currently in. Do not include latency values for any other region.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "StartMatchBackfillOutput":{ + "type":"structure", + "members":{ + "MatchmakingTicket":{ + "shape":"MatchmakingTicket", + "documentation":"

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "StartMatchmakingInput":{ + "type":"structure", + "required":[ + "ConfigurationName", + "Players" + ], + "members":{ + "TicketId":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results.

" + }, + "ConfigurationName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same region as this request.

" + }, + "Players":{ + "shape":"PlayerList", + "documentation":"

Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, Player objects contain the name of the team the player is assigned to.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "StartMatchmakingOutput":{ + "type":"structure", + "members":{ + "MatchmakingTicket":{ + "shape":"MatchmakingTicket", + "documentation":"

Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "StopFleetActionsInput":{ + "type":"structure", + "required":[ + "FleetId", + "Actions" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet

" + }, + "Actions":{ + "shape":"FleetActionList", + "documentation":"

List of actions to suspend on the fleet.

" + } + } + }, + "StopFleetActionsOutput":{ + "type":"structure", + "members":{ + } + }, + "StopGameSessionPlacementInput":{ + "type":"structure", + "required":["PlacementId"], + "members":{ + "PlacementId":{ + "shape":"IdStringModel", + "documentation":"

Unique identifier for a game session placement to cancel.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "StopGameSessionPlacementOutput":{ + "type":"structure", + "members":{ + "GameSessionPlacement":{ + "shape":"GameSessionPlacement", + "documentation":"

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "StopMatchmakingInput":{ + "type":"structure", + "required":["TicketId"], + "members":{ + "TicketId":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking ticket.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "StopMatchmakingOutput":{ + "type":"structure", + "members":{ + } + }, + "StringDoubleMap":{ + "type":"map", + "key":{"shape":"NonZeroAndMaxString"}, + "value":{"shape":"DoubleObject"} + }, + "StringList":{ + "type":"list", + "member":{"shape":"NonZeroAndMaxString"} + }, + "StringModel":{"type":"string"}, + "TargetConfiguration":{ + "type":"structure", + "required":["TargetValue"], + "members":{ + "TargetValue":{ + "shape":"Double", + "documentation":"

Desired value to use with a target-based scaling policy. The value must be relevant for whatever metric the scaling policy is using. For example, in a policy using the metric PercentAvailableGameSessions, the target value should be the preferred size of the fleet's buffer (the percent of capacity that should be idle and ready for new game sessions).

" + } + }, + "documentation":"

Settings for a target-based scaling policy (see ScalingPolicy. A target-based policy tracks a particular fleet metric specifies a target value for the metric. As player usage changes, the policy triggers Amazon GameLift to adjust capacity so that the metric returns to the target value. The target configuration specifies settings as needed for the target based policy, including the target value.

" + }, + "TerminalRoutingStrategyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The client failed authentication. Clients should not retry such requests.

", + "exception":true + }, + "UnsupportedRegionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"} + }, + "documentation":"

The requested operation is not supported in the region specified.

", + "exception":true + }, + "UpdateAliasInput":{ + "type":"structure", + "required":["AliasId"], + "members":{ + "AliasId":{ + "shape":"AliasId", + "documentation":"

Unique identifier for a fleet alias. Specify the alias you want to update.

" + }, + "Name":{ + "shape":"NonBlankAndLengthConstraintString", + "documentation":"

Descriptive label that is associated with an alias. Alias names do not need to be unique.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Human-readable description of an alias.

" + }, + "RoutingStrategy":{ + "shape":"RoutingStrategy", + "documentation":"

Object that specifies the fleet and routing type to use for the alias.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateAliasOutput":{ + "type":"structure", + "members":{ + "Alias":{ + "shape":"Alias", + "documentation":"

Object that contains the updated alias configuration.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateBuildInput":{ + "type":"structure", + "required":["BuildId"], + "members":{ + "BuildId":{ + "shape":"BuildId", + "documentation":"

Unique identifier for a build to update.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a build. Build names do not need to be unique.

" + }, + "Version":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateBuildOutput":{ + "type":"structure", + "members":{ + "Build":{ + "shape":"Build", + "documentation":"

Object that contains the updated build record.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateFleetAttributesInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to update attribute metadata for.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a fleet. Fleet names do not need to be unique.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Human-readable description of a fleet.

" + }, + "NewGameSessionProtectionPolicy":{ + "shape":"ProtectionPolicy", + "documentation":"

Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" + }, + "ResourceCreationLimitPolicy":{ + "shape":"ResourceCreationLimitPolicy", + "documentation":"

Policy that limits the number of game sessions an individual player can create over a span of time.

" + }, + "MetricGroups":{ + "shape":"MetricGroupList", + "documentation":"

Names of metric groups to include this fleet in. Amazon CloudWatch uses a fleet metric group is to aggregate metrics from multiple fleets. Use an existing metric group name to add this fleet to the group. Or use a new name to create a new metric group. A fleet can only be included in one metric group at a time.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateFleetAttributesOutput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that was updated.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateFleetCapacityInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to update capacity for.

" + }, + "DesiredInstances":{ + "shape":"WholeNumber", + "documentation":"

Number of EC2 instances you want this fleet to host.

" + }, + "MinSize":{ + "shape":"WholeNumber", + "documentation":"

Minimum value allowed for the fleet's instance count. Default if not set is 0.

" + }, + "MaxSize":{ + "shape":"WholeNumber", + "documentation":"

Maximum value allowed for the fleet's instance count. Default if not set is 1.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateFleetCapacityOutput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that was updated.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateFleetPortSettingsInput":{ + "type":"structure", + "required":["FleetId"], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to update port settings for.

" + }, + "InboundPermissionAuthorizations":{ + "shape":"IpPermissionsList", + "documentation":"

Collection of port settings to be added to the fleet record.

" + }, + "InboundPermissionRevocations":{ + "shape":"IpPermissionsList", + "documentation":"

Collection of port settings to be removed from the fleet record.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateFleetPortSettingsOutput":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet that was updated.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateGameSessionInput":{ + "type":"structure", + "required":["GameSessionId"], + "members":{ + "GameSessionId":{ + "shape":"ArnStringModel", + "documentation":"

Unique identifier for the game session to update.

" + }, + "MaximumPlayerSessionCount":{ + "shape":"WholeNumber", + "documentation":"

Maximum number of players that can be connected simultaneously to the game session.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a game session. Session names do not need to be unique.

" + }, + "PlayerSessionCreationPolicy":{ + "shape":"PlayerSessionCreationPolicy", + "documentation":"

Policy determining whether or not the game session accepts new players.

" + }, + "ProtectionPolicy":{ + "shape":"ProtectionPolicy", + "documentation":"

Game session protection policy to apply to this game session only.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateGameSessionOutput":{ + "type":"structure", + "members":{ + "GameSession":{ + "shape":"GameSession", + "documentation":"

Object that contains the updated game session metadata.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateGameSessionQueueInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"GameSessionQueueName", + "documentation":"

Descriptive label that is associated with game session queue. Queue names must be unique within each region.

" + }, + "TimeoutInSeconds":{ + "shape":"WholeNumber", + "documentation":"

Maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a TIMED_OUT status.

" + }, + "PlayerLatencyPolicies":{ + "shape":"PlayerLatencyPolicyList", + "documentation":"

Collection of latency policies to apply when processing game sessions placement requests with player latency information. Multiple policies are evaluated in order of the maximum latency value, starting with the lowest latency values. With just one policy, it is enforced at the start of the game session placement for the duration period. With multiple policies, each policy is enforced consecutively for its duration period. For example, a queue might enforce a 60-second policy followed by a 120-second policy, and then no policy for the remainder of the placement. When updating policies, provide a complete collection of policies.

" + }, + "Destinations":{ + "shape":"GameSessionQueueDestinationList", + "documentation":"

List of fleets that can be used to fulfill game session placement requests in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. Destinations are listed in default preference order. When updating this list, provide a complete list of destinations.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateGameSessionQueueOutput":{ + "type":"structure", + "members":{ + "GameSessionQueue":{ + "shape":"GameSessionQueue", + "documentation":"

Object that describes the newly updated game session queue.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateMatchmakingConfigurationInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking configuration to update.

" + }, + "Description":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with matchmaking configuration.

" + }, + "GameSessionQueueArns":{ + "shape":"QueueArnsList", + "documentation":"

Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

" + }, + "RequestTimeoutSeconds":{ + "shape":"MatchmakingRequestTimeoutInteger", + "documentation":"

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

" + }, + "AcceptanceTimeoutSeconds":{ + "shape":"MatchmakingAcceptanceTimeoutInteger", + "documentation":"

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

" + }, + "AcceptanceRequired":{ + "shape":"BooleanModel", + "documentation":"

Flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

" + }, + "RuleSetName":{ + "shape":"MatchmakingIdStringModel", + "documentation":"

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

" + }, + "NotificationTarget":{ + "shape":"SnsArnStringModel", + "documentation":"

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

" + }, + "AdditionalPlayerCount":{ + "shape":"WholeNumber", + "documentation":"

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

" + }, + "CustomEventData":{ + "shape":"CustomEventData", + "documentation":"

Information to add to all events related to the matchmaking configuration.

" + }, + "GameProperties":{ + "shape":"GamePropertyList", + "documentation":"

Set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "GameSessionData":{ + "shape":"GameSessionData", + "documentation":"

Set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.

" + }, + "BackfillMode":{ + "shape":"BackfillMode", + "documentation":"

Method used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateMatchmakingConfigurationOutput":{ + "type":"structure", + "members":{ + "Configuration":{ + "shape":"MatchmakingConfiguration", + "documentation":"

Object that describes the updated matchmaking configuration.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateRuntimeConfigurationInput":{ + "type":"structure", + "required":[ + "FleetId", + "RuntimeConfiguration" + ], + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet to update run-time configuration for.

" + }, + "RuntimeConfiguration":{ + "shape":"RuntimeConfiguration", + "documentation":"

Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The run-time configuration lists the types of server processes to run on an instance and includes the following configuration settings: the server executable or launch script file, launch parameters, and the number of processes to run concurrently on each instance. A CreateFleet request must include a run-time configuration with at least one server process configuration.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "UpdateRuntimeConfigurationOutput":{ + "type":"structure", + "members":{ + "RuntimeConfiguration":{ + "shape":"RuntimeConfiguration", + "documentation":"

The run-time configuration currently in force. If the update was successful, this object matches the one in the request.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "UpdateScriptInput":{ + "type":"structure", + "required":["ScriptId"], + "members":{ + "ScriptId":{ + "shape":"ScriptId", + "documentation":"

Unique identifier for a Realtime script to update.

" + }, + "Name":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Descriptive label that is associated with a script. Script names do not need to be unique.

" + }, + "Version":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Version that is associated with a build or script. Version strings do not need to be unique.

" + }, + "StorageLocation":{ + "shape":"S3Location", + "documentation":"

Location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the \"key\"), and a role ARN that allows Amazon GameLift to access the Amazon S3 storage location. The S3 bucket must be in the same region where you want to create a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version.

" + }, + "ZipFile":{ + "shape":"ZipBlob", + "documentation":"

Data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string \"fileb://\" to indicate that the file data is a binary object. For example: --zip-file fileb://myRealtimeScript.zip.

" + } + } + }, + "UpdateScriptOutput":{ + "type":"structure", + "members":{ + "Script":{ + "shape":"Script", + "documentation":"

The newly created script record with a unique script ID. The new script's storage location reflects an Amazon S3 location: (1) If the script was uploaded from an S3 bucket under your account, the storage location reflects the information that was provided in the CreateScript request; (2) If the script file was uploaded from a local zip file, the storage location reflects an S3 location controls by the Amazon GameLift service.

" + } + } + }, + "ValidateMatchmakingRuleSetInput":{ + "type":"structure", + "required":["RuleSetBody"], + "members":{ + "RuleSetBody":{ + "shape":"RuleSetBody", + "documentation":"

Collection of matchmaking rules to validate, formatted as a JSON string.

" + } + }, + "documentation":"

Represents the input for a request action.

" + }, + "ValidateMatchmakingRuleSetOutput":{ + "type":"structure", + "members":{ + "Valid":{ + "shape":"BooleanModel", + "documentation":"

Response indicating whether the rule set is valid.

" + } + }, + "documentation":"

Represents the returned data in response to a request action.

" + }, + "VpcPeeringAuthorization":{ + "type":"structure", + "members":{ + "GameLiftAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the AWS account that you use to manage your Amazon GameLift fleet. You can find your Account ID in the AWS Management Console under account settings.

" + }, + "PeerVpcAwsAccountId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this authorization was issued. Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + }, + "ExpirationTime":{ + "shape":"Timestamp", + "documentation":"

Time stamp indicating when this authorization expires (24 hours after issuance). Format is a number expressed in Unix time as milliseconds (for example \"1469498468.057\").

" + } + }, + "documentation":"

Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.

" + }, + "VpcPeeringAuthorizationList":{ + "type":"list", + "member":{"shape":"VpcPeeringAuthorization"} + }, + "VpcPeeringConnection":{ + "type":"structure", + "members":{ + "FleetId":{ + "shape":"FleetId", + "documentation":"

Unique identifier for a fleet. This ID determines the ID of the Amazon GameLift VPC for your fleet.

" + }, + "IpV4CidrBlock":{ + "shape":"NonZeroAndMaxString", + "documentation":"

CIDR block of IPv4 addresses assigned to the VPC peering connection for the GameLift VPC. The peered VPC also has an IPv4 CIDR block associated with it; these blocks cannot overlap or the peering connection cannot be created.

" + }, + "VpcPeeringConnectionId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier that is automatically assigned to the connection record. This ID is referenced in VPC peering connection events, and is used when deleting a connection with DeleteVpcPeeringConnection.

" + }, + "Status":{ + "shape":"VpcPeeringConnectionStatus", + "documentation":"

Object that contains status information about the connection. Status indicates if a connection is pending, successful, or failed.

" + }, + "PeerVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same region where your fleet is deployed. Look up a VPC ID using the VPC Dashboard in the AWS Management Console. Learn more about VPC peering in VPC Peering with Amazon GameLift Fleets.

" + }, + "GameLiftVpcId":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Unique identifier for the VPC that contains the Amazon GameLift fleet for this connection. This VPC is managed by Amazon GameLift and does not appear in your AWS account.

" + } + }, + "documentation":"

Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.

" + }, + "VpcPeeringConnectionList":{ + "type":"list", + "member":{"shape":"VpcPeeringConnection"} + }, + "VpcPeeringConnectionStatus":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Code indicating the status of a VPC peering connection.

" + }, + "Message":{ + "shape":"NonZeroAndMaxString", + "documentation":"

Additional messaging associated with the connection status.

" + } + }, + "documentation":"

Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.

" + }, + "WholeNumber":{ + "type":"integer", + "min":0 + }, + "ZipBlob":{ + "type":"blob", + "max":5000000 + } + }, + "documentation":"Amazon GameLift Service

Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.

When setting up hosting resources, you can deploy your custom game server or use the Amazon GameLift Realtime Servers. Realtime Servers gives you the ability to quickly stand up lightweight, efficient game servers with the core Amazon GameLift infrastructure already built in.

Get Amazon GameLift Tools and Resources

This reference guide describes the low-level service API for Amazon GameLift and provides links to language-specific SDK reference topics. See also Amazon GameLift Tools and Resources.

API Summary

The Amazon GameLift service API includes two key sets of actions:

  • Manage game sessions and player access -- Integrate this functionality into game client services in order to create new game sessions, retrieve information on existing game sessions; reserve a player slot in a game session, request matchmaking, etc.

  • Configure and manage game server resources -- Manage your Amazon GameLift hosting resources, including builds, scripts, fleets, queues, and aliases. Set up matchmakers, configure auto-scaling, retrieve game logs, and get hosting and game metrics.

Task-based list of API actions

" +} diff --git a/aws/dist/botocore/data/glacier/2012-06-01/examples-1.json b/aws/dist/botocore/data/glacier/2012-06-01/examples-1.json new file mode 100644 index 00000000..7ecea259 --- /dev/null +++ b/aws/dist/botocore/data/glacier/2012-06-01/examples-1.json @@ -0,0 +1,806 @@ +{ + "version": "1.0", + "examples": { + "AbortMultipartUpload": [ + { + "input": { + "accountId": "-", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes an in-progress multipart upload to a vault named my-vault:", + "id": "f3d907f6-e71c-420c-8f71-502346a2c48a", + "title": "To abort a multipart upload identified by the upload ID" + } + ], + "AbortVaultLock": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example aborts the vault locking process if the vault lock is not in the Locked state for the vault named examplevault.", + "id": "to-abort-a-vault-lock-1481839357947", + "title": "To abort a vault lock" + } + ], + "AddTagsToVault": [ + { + "input": { + "Tags": { + "examplekey1": "examplevalue1", + "examplekey2": "examplevalue2" + }, + "accountId": "-", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example adds two tags to a my-vault.", + "id": "add-tags-to-vault-post-tags-add-1481663457694", + "title": "To add tags to a vault" + } + ], + "CompleteMultipartUpload": [ + { + "input": { + "accountId": "-", + "archiveSize": "3145728", + "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "my-vault" + }, + "output": { + "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", + "checksum": "9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "location": "/111122223333/vaults/my-vault/archives/NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example completes a multipart upload for a 3 MiB archive.", + "id": "272aa0b8-e44c-4a64-add2-ad905a37984d", + "title": "To complete a multipart upload" + } + ], + "CompleteVaultLock": [ + { + "input": { + "accountId": "-", + "lockId": "AE863rKkWZU53SLW5be4DUcW", + "vaultName": "example-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state.", + "id": "to-complete-a-vault-lock-1481839721312", + "title": "To complete a vault lock" + } + ], + "CreateVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "location": "/111122223333/vaults/my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new vault named my-vault.", + "id": "1dc0313d-ace1-4e6c-9d13-1ec7813b14b7", + "title": "To create a new vault" + } + ], + "DeleteArchive": [ + { + "input": { + "accountId": "-", + "archiveId": "NkbByEejwEggmBz2fTHgJrg0XBoDfjP4q6iu87-TjhqG6eGoOY9Z8i1_AUyUsuhPAdTqLHy8pTl5nfCFJmDl2yEZONi5L26Omw12vcs01MNGntHEQL8MBfGlqrEXAMPLEArchiveId", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the archive specified by the archive ID.", + "id": "delete-archive-1481667809463", + "title": "To delete an archive" + } + ], + "DeleteVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes a vault named my-vault:", + "id": "7f7f000b-4bdb-40d2-91e6-7c902f60f60f", + "title": "To delete a vault" + } + ], + "DeleteVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the access policy associated with the vault named examplevault.", + "id": "to-delete-the-vault-access-policy-1481840424677", + "title": "To delete the vault access policy" + } + ], + "DeleteVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example deletes the notification configuration set for the vault named examplevault.", + "id": "to-delete-the-notification-configuration-set-for-a-vault-1481840646090", + "title": "To delete the notification configuration set for a vault" + } + ], + "DescribeJob": [ + { + "input": { + "accountId": "-", + "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4Cn", + "vaultName": "my-vault" + }, + "output": { + "Action": "InventoryRetrieval", + "Completed": false, + "CreationDate": "2015-07-17T20:23:41.616Z", + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example returns information about the previously initiated job specified by the job ID.", + "id": "to-get-information-about-a-job-you-previously-initiated-1481840928592", + "title": "To get information about a previously initiated job" + } + ], + "DescribeVault": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "CreationDate": "2016-09-23T19:27:18.665Z", + "NumberOfArchives": 0, + "SizeInBytes": 0, + "VaultARN": "arn:aws:glacier:us-west-2:111122223333:vaults/my-vault", + "VaultName": "my-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves data about a vault named my-vault.", + "id": "3c1c6e9d-f5a2-427a-aa6a-f439eacfc05f", + "title": "To retrieve information about a vault" + } + ], + "GetDataRetrievalPolicy": [ + { + "input": { + "accountId": "-" + }, + "output": { + "Policy": { + "Rules": [ + { + "BytesPerHour": 10737418240, + "Strategy": "BytesPerHour" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example returns the current data retrieval policy for the account.", + "id": "to-get-the-current-data-retrieval-policy-for-the-account-1481851580439", + "title": "To get the current data retrieval policy for an account" + } + ], + "GetJobOutput": [ + { + "input": { + "accountId": "-", + "jobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "range": "", + "vaultName": "my-vaul" + }, + "output": { + "acceptRanges": "bytes", + "body": "inventory-data", + "contentType": "application/json", + "status": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example downloads the output of a previously initiated inventory retrieval job that is identified by the job ID.", + "id": "to-get-the-output-of-a-previously-initiated-job-1481848550859", + "title": "To get the output of a previously initiated job" + } + ], + "GetVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "vaultName": "example-vault" + }, + "output": { + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the access-policy set on the vault named example-vault.", + "id": "to--get-the-access-policy-set-on-the-vault-1481936004590", + "title": "To get the access-policy set on the vault" + } + ], + "GetVaultLock": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "CreationDate": "exampledate", + "ExpirationDate": "exampledate", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}", + "State": "InProgress" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the attributes from the lock-policy subresource set on the vault named examplevault.", + "id": "to-retrieve-vault-lock-policy-related-attributes-that-are-set-on-a-vault-1481851363097", + "title": "To retrieve vault lock-policy related attributes that are set on a vault" + } + ], + "GetVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "vaultNotificationConfig": { + "Events": [ + "InventoryRetrievalCompleted", + "ArchiveRetrievalCompleted" + ], + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example retrieves the notification-configuration for the vault named my-vault.", + "id": "to-get-the-notification-configuration-for-the-specified-vault-1481918746677", + "title": "To get the notification-configuration for the specified vault" + } + ], + "InitiateJob": [ + { + "input": { + "accountId": "-", + "jobParameters": { + "Description": "My inventory job", + "Format": "CSV", + "SNSTopic": "arn:aws:sns:us-west-2:111111111111:Glacier-InventoryRetrieval-topic-Example", + "Type": "inventory-retrieval" + }, + "vaultName": "examplevault" + }, + "output": { + "jobId": " HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID", + "location": "/111122223333/vaults/examplevault/jobs/HkF9p6o7yjhFx-K3CGl6fuSm6VzW9T7esGQfco8nUXVYwS0jlb5gq1JZ55yHgt5vP54ZShjoQzQVVh7vEXAMPLEjobID" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates an inventory-retrieval job for the vault named examplevault.", + "id": "to-initiate-an-inventory-retrieval-job-1482186883826", + "title": "To initiate an inventory-retrieval job" + } + ], + "InitiateMultipartUpload": [ + { + "input": { + "accountId": "-", + "partSize": "1048576", + "vaultName": "my-vault" + }, + "output": { + "location": "/111122223333/vaults/my-vault/multipart-uploads/19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates a multipart upload to a vault named my-vault with a part size of 1 MiB (1024 x 1024 bytes) per file.", + "id": "72f2db19-3d93-4c74-b2ed-38703baacf49", + "title": "To initiate a multipart upload" + } + ], + "InitiateVaultLock": [ + { + "input": { + "accountId": "-", + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-vault-lock\",\"Effect\":\"Deny\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\",\"Condition\":{\"NumericLessThanEquals\":{\"glacier:ArchiveAgeinDays\":\"365\"}}}]}" + }, + "vaultName": "my-vault" + }, + "output": { + "lockId": "AE863rKkWZU53SLW5be4DUcW" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example initiates the vault locking process for the vault named my-vault.", + "id": "to-initiate-the-vault-locking-process-1481919693394", + "title": "To initiate the vault locking process" + } + ], + "ListJobs": [ + { + "input": { + "accountId": "-", + "vaultName": "my-vault" + }, + "output": { + "JobList": [ + { + "Action": "ArchiveRetrieval", + "ArchiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "ArchiveSHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "ArchiveSizeInBytes": 3145728, + "Completed": false, + "CreationDate": "2015-07-17T21:16:13.840Z", + "JobDescription": "Retrieve archive on 2015-07-17", + "JobId": "l7IL5-EkXyEY9Ws95fClzIbk2O5uLYaFdAYOi-azsX_Z8V6NH4yERHzars8wTKYQMX6nBDI9cMNHzyZJO59-8N9aHWav", + "RetrievalByteRange": "0-3145727", + "SHA256TreeHash": "9628195fcdbcbbe76cdde932d4646fa7de5f219fb39823836d81f0cc0e18aa67", + "SNSTopic": "arn:aws:sns:us-west-2:0123456789012:my-vault", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + }, + { + "Action": "InventoryRetrieval", + "Completed": false, + "CreationDate": "2015-07-17T20:23:41.616Z", + "InventoryRetrievalParameters": { + "Format": "JSON" + }, + "JobId": "zbxcm3Z_3z5UkoroF7SuZKrxgGoDc3RloGduS7Eg-RO47Yc6FxsdGBgf_Q2DK5Ejh18CnTS5XW4_XqlNHS61dsO4CnMW", + "StatusCode": "InProgress", + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists jobs for the vault named my-vault.", + "id": "to-list-jobs-for-a-vault-1481920530537", + "title": "To list jobs for a vault" + } + ], + "ListMultipartUploads": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "Marker": "null", + "UploadsList": [ + { + "ArchiveDescription": "archive 1", + "CreationDate": "2012-03-19T23:20:59.130Z", + "MultipartUploadId": "xsQdFIRsfJr20CW2AbZBKpRZAFTZSJIMtL2hYf8mvp8dM0m4RUzlaqoEye6g3h3ecqB_zqwB7zLDMeSWhwo65re4C4Ev", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + }, + { + "ArchiveDescription": "archive 2", + "CreationDate": "2012-04-01T15:00:00.000Z", + "MultipartUploadId": "nPyGOnyFcx67qqX7E-0tSGiRi88hHMOwOxR-_jNyM6RjVMFfV29lFqZ3rNsSaWBugg6OP92pRtufeHdQH7ClIpSF6uJc", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + }, + { + "ArchiveDescription": "archive 3", + "CreationDate": "2012-03-20T17:03:43.221Z", + "MultipartUploadId": "qt-RBst_7yO8gVIonIBsAxr2t-db0pE4s8MNeGjKjGdNpuU-cdSAcqG62guwV9r5jh5mLyFPzFEitTpNE7iQfHiu1XoV", + "PartSizeInBytes": 4194304, + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/examplevault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the in-progress multipart uploads for the vault named examplevault.", + "id": "to-list-all-the-in-progress-multipart-uploads-for-a-vault-1481935250590", + "title": "To list all the in-progress multipart uploads for a vault" + } + ], + "ListParts": [ + { + "input": { + "accountId": "-", + "uploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", + "vaultName": "examplevault" + }, + "output": { + "ArchiveDescription": "archive description", + "CreationDate": "2012-03-20T17:03:43.221Z", + "Marker": "null", + "MultipartUploadId": "OW2fM5iVylEpFEMM9_HpKowRapC3vn5sSL39_396UW9zLFUWVrnRHaPjUJddQ5OxSHVXjYtrN47NBZ-khxOjyEXAMPLE", + "PartSizeInBytes": 4194304, + "Parts": [ + { + "RangeInBytes": "0-4194303", + "SHA256TreeHash": "01d34dabf7be316472c93b1ef80721f5d4" + }, + { + "RangeInBytes": "4194304-8388607", + "SHA256TreeHash": "0195875365afda349fc21c84c099987164" + } + ], + "VaultARN": "arn:aws:glacier:us-west-2:012345678901:vaults/demo1-vault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the parts of a multipart upload.", + "id": "to-list-the-parts-of-an-archive-that-have-been-uploaded-in-a-multipart-upload-1481921767590", + "title": "To list the parts of an archive that have been uploaded in a multipart upload" + } + ], + "ListProvisionedCapacity": [ + { + "input": { + "accountId": "-" + }, + "output": { + "ProvisionedCapacityList": [ + { + "CapacityId": "zSaq7NzHFQDANTfQkDen4V7z", + "ExpirationDate": "2016-12-12T00:00:00.000Z", + "StartDate": "2016-11-11T20:11:51.095Z" + }, + { + "CapacityId": "yXaq7NzHFQNADTfQkDen4V7z", + "ExpirationDate": "2017-01-15T00:00:00.000Z", + "StartDate": "2016-12-13T20:11:51.095Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists the provisioned capacity units for an account.", + "id": "to-list-the-provisioned-capacity-units-for-an-account-1481923656130", + "title": "To list the provisioned capacity units for an account" + } + ], + "ListTagsForVault": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault" + }, + "output": { + "Tags": { + "date": "july2015", + "id": "1234" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all the tags attached to the vault examplevault.", + "id": "list-tags-for-vault-1481755839720", + "title": "To list the tags for a vault" + } + ], + "ListVaults": [ + { + "input": { + "accountId": "-", + "limit": "", + "marker": "" + }, + "output": { + "VaultList": [ + { + "CreationDate": "2015-04-06T21:23:45.708Z", + "LastInventoryDate": "2015-04-07T00:26:19.028Z", + "NumberOfArchives": 1, + "SizeInBytes": 3178496, + "VaultARN": "arn:aws:glacier:us-west-2:0123456789012:vaults/my-vault", + "VaultName": "my-vault" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example lists all vaults owned by the specified AWS account.", + "id": "list-vaults-1481753006990", + "title": "To list all vaults owned by the calling user's account" + } + ], + "PurchaseProvisionedCapacity": [ + { + "input": { + "accountId": "-" + }, + "output": { + "capacityId": "zSaq7NzHFQDANTfQkDen4V7z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example purchases provisioned capacity unit for an AWS account.", + "id": "to-purchases-a-provisioned-capacity-unit-for-an-aws-account-1481927446662", + "title": "To purchases a provisioned capacity unit for an AWS account" + } + ], + "RemoveTagsFromVault": [ + { + "input": { + "TagKeys": [ + "examplekey1", + "examplekey2" + ], + "accountId": "-", + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example removes two tags from the vault named examplevault.", + "id": "remove-tags-from-vault-1481754998801", + "title": "To remove tags from a vault" + } + ], + "SetDataRetrievalPolicy": [ + { + "input": { + "Policy": { + "Rules": [ + { + "BytesPerHour": 10737418240, + "Strategy": "BytesPerHour" + } + ] + }, + "accountId": "-" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example sets and then enacts a data retrieval policy.", + "id": "to-set-and-then-enact-a-data-retrieval-policy--1481928352408", + "title": "To set and then enact a data retrieval policy " + } + ], + "SetVaultAccessPolicy": [ + { + "input": { + "accountId": "-", + "policy": { + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Define-owner-access-rights\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::999999999999:root\"},\"Action\":\"glacier:DeleteArchive\",\"Resource\":\"arn:aws:glacier:us-west-2:999999999999:vaults/examplevault\"}]}" + }, + "vaultName": "examplevault" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example configures an access policy for the vault named examplevault.", + "id": "to--set-the-access-policy-on-a-vault-1482185872517", + "title": "To set the access-policy on a vault" + } + ], + "SetVaultNotifications": [ + { + "input": { + "accountId": "-", + "vaultName": "examplevault", + "vaultNotificationConfig": { + "Events": [ + "ArchiveRetrievalCompleted", + "InventoryRetrievalCompleted" + ], + "SNSTopic": "arn:aws:sns:us-west-2:012345678901:mytopic" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example sets the examplevault notification configuration.", + "id": "to-configure-a-vault-to-post-a-message-to-an-amazon-simple-notification-service-amazon-sns-topic-when-jobs-complete-1482186397475", + "title": "To configure a vault to post a message to an Amazon SNS topic when jobs complete" + } + ], + "UploadArchive": [ + { + "input": { + "accountId": "-", + "archiveDescription": "", + "body": "example-data-to-upload", + "checksum": "", + "vaultName": "my-vault" + }, + "output": { + "archiveId": "kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw", + "checksum": "969fb39823836d81f0cc028195fcdbcbbe76cdde932d4646fa7de5f21e18aa67", + "location": "/0123456789012/vaults/my-vault/archives/kKB7ymWJVpPSwhGP6ycSOAekp9ZYe_--zM_mw6k76ZFGEIWQX-ybtRDvc2VkPSDtfKmQrj0IRQLSGsNuDp-AJVlu2ccmDSyDUmZwKbwbpAdGATGDiB3hHO0bjbGehXTcApVud_wyDw" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example adds an archive to a vault.", + "id": "upload-archive-1481668510494", + "title": "To upload an archive" + } + ], + "UploadMultipartPart": [ + { + "input": { + "accountId": "-", + "body": "part1", + "checksum": "c06f7cd4baacb087002a99a5f48bf953", + "range": "bytes 0-1048575/*", + "uploadId": "19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ", + "vaultName": "examplevault" + }, + "output": { + "checksum": "c06f7cd4baacb087002a99a5f48bf953" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The example uploads the first 1 MiB (1024 x 1024 bytes) part of an archive.", + "id": "to-upload-the-first-part-of-an-archive-1481835899519", + "title": "To upload the first part of an archive" + } + ] + } +} diff --git a/aws/dist/botocore/data/glacier/2012-06-01/paginators-1.json b/aws/dist/botocore/data/glacier/2012-06-01/paginators-1.json new file mode 100644 index 00000000..69691437 --- /dev/null +++ b/aws/dist/botocore/data/glacier/2012-06-01/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "JobList" + }, + "ListMultipartUploads": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "UploadsList" + }, + "ListParts": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "Parts" + }, + "ListVaults": { + "input_token": "marker", + "output_token": "Marker", + "limit_key": "limit", + "result_key": "VaultList" + } + } +} diff --git a/aws/dist/botocore/data/glacier/2012-06-01/service-2.json b/aws/dist/botocore/data/glacier/2012-06-01/service-2.json new file mode 100644 index 00000000..acf169f2 --- /dev/null +++ b/aws/dist/botocore/data/glacier/2012-06-01/service-2.json @@ -0,0 +1,2580 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-06-01", + "checksumFormat":"sha256", + "endpointPrefix":"glacier", + "protocol":"rest-json", + "serviceFullName":"Amazon Glacier", + "serviceId":"Glacier", + "signatureVersion":"v4", + "uid":"glacier-2012-06-01" + }, + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{"shape":"AbortMultipartUploadInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation aborts a multipart upload identified by the upload ID.

After the Abort Multipart Upload request succeeds, you cannot upload any more parts to the multipart upload or complete the multipart upload. Aborting a completed upload fails. However, aborting an already-aborted upload will succeed, for a short time. For more information about uploading a part and completing a multipart upload, see UploadMultipartPart and CompleteMultipartUpload.

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Working with Archives in Amazon S3 Glacier and Abort Multipart Upload in the Amazon Glacier Developer Guide.

" + }, + "AbortVaultLock":{ + "name":"AbortVaultLock", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode":204 + }, + "input":{"shape":"AbortVaultLockInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation aborts the vault locking process if the vault lock is not in the Locked state. If the vault lock is in the Locked state when this operation is requested, the operation returns an AccessDeniedException error. Aborting the vault locking process removes the vault lock policy from the specified vault.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can get the state of a vault lock by calling GetVaultLock. For more information about the vault locking process, see Amazon Glacier Vault Lock. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

This operation is idempotent. You can successfully invoke this operation multiple times, if the vault lock is in the InProgress state or if there is no policy associated with the vault.

" + }, + "AddTagsToVault":{ + "name":"AddTagsToVault", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=add", + "responseCode":204 + }, + "input":{"shape":"AddTagsToVaultInput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation adds the specified tags to a vault. Each tag is composed of a key and a value. Each vault can have up to 10 tags. If your request would cause the tag limit for the vault to be exceeded, the operation throws the LimitExceededException error. If a tag already exists on the vault under a specified key, the existing key value will be overwritten. For more information about tags, see Tagging Amazon S3 Glacier Resources.

" + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":201 + }, + "input":{"shape":"CompleteMultipartUploadInput"}, + "output":{"shape":"ArchiveCreationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

You call this operation to inform Amazon S3 Glacier (Glacier) that all the archive parts have been uploaded and that Glacier can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource. Using the URI path, you can then access the archive. After you upload an archive, you should save the archive ID returned to retrieve the archive at a later point. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

In the request, you must include the computed SHA256 tree hash of the entire archive you have uploaded. For information about computing a SHA256 tree hash, see Computing Checksums. On the server side, Glacier also constructs the SHA256 tree hash of the assembled archive. If the values match, Glacier saves the archive to the vault; otherwise, it returns an error, and the operation fails. The ListParts operation returns a list of parts uploaded for a specific multipart upload. It includes checksum information for each uploaded part that can be used to debug a bad checksum issue.

Additionally, Glacier also checks for any missing content ranges when assembling the archive, if missing content ranges are found, Glacier returns an error and the operation fails.

Complete Multipart Upload is an idempotent operation. After your first successful complete multipart upload, if you call the operation again within a short period, the operation will succeed and return the same archive ID. This is useful in the event you experience a network issue that causes an aborted connection or receive a 500 server error, in which case you can repeat your Complete Multipart Upload request and get the same archive ID without creating duplicate archives. Note, however, that after the multipart upload completes, you cannot call the List Parts operation and the multipart upload will not appear in List Multipart Uploads response, even if idempotent complete is possible.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Complete Multipart Upload in the Amazon Glacier Developer Guide.

" + }, + "CompleteVaultLock":{ + "name":"CompleteVaultLock", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy/{lockId}", + "responseCode":204 + }, + "input":{"shape":"CompleteVaultLockInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation completes the vault locking process by transitioning the vault lock from the InProgress state to the Locked state, which causes the vault lock policy to become unchangeable. A vault lock is put into the InProgress state by calling InitiateVaultLock. You can obtain the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

This operation is idempotent. This request is always successful if the vault lock is in the Locked state and the provided lock ID matches the lock ID originally used to lock the vault.

If an invalid lock ID is passed in the request when the vault lock is in the Locked state, the operation returns an AccessDeniedException error. If an invalid lock ID is passed in the request when the vault lock is in the InProgress state, the operation throws an InvalidParameter error.

" + }, + "CreateVault":{ + "name":"CreateVault", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":201 + }, + "input":{"shape":"CreateVaultInput"}, + "output":{"shape":"CreateVaultOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

This operation creates a new vault with the specified name. The name of the vault must be unique within a region for an AWS account. You can create up to 1,000 vaults per account. If you need to create more vaults, contact Amazon S3 Glacier.

You must use the following guidelines when naming a vault.

  • Names can be between 1 and 255 characters long.

  • Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Creating a Vault in Amazon Glacier and Create Vault in the Amazon Glacier Developer Guide.

" + }, + "DeleteArchive":{ + "name":"DeleteArchive", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/archives/{archiveId}", + "responseCode":204 + }, + "input":{"shape":"DeleteArchiveInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation deletes an archive from a vault. Subsequent requests to initiate a retrieval of this archive will fail. Archive retrievals that are in progress for this archive ID may or may not succeed according to the following scenarios:

  • If the archive retrieval job is actively preparing the data for download when Amazon S3 Glacier receives the delete archive request, the archival retrieval operation might fail.

  • If the archive retrieval job has successfully prepared the archive for download when Amazon S3 Glacier receives the delete archive request, you will be able to download the output.

This operation is idempotent. Attempting to delete an already-deleted archive does not result in an error.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Deleting an Archive in Amazon Glacier and Delete Archive in the Amazon Glacier Developer Guide.

" + }, + "DeleteVault":{ + "name":"DeleteVault", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation deletes a vault. Amazon S3 Glacier will delete a vault only if there are no archives in the vault as of the last inventory and there have been no writes to the vault since the last inventory. If either of these conditions is not satisfied, the vault deletion fails (that is, the vault is not removed) and Amazon S3 Glacier returns an error. You can use DescribeVault to return the number of archives in a vault, and you can use Initiate a Job (POST jobs) to initiate a new inventory retrieval for a vault. The inventory contains the archive IDs you use to delete archives using Delete Archive (DELETE archive).

This operation is idempotent.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Deleting a Vault in Amazon Glacier and Delete Vault in the Amazon S3 Glacier Developer Guide.

" + }, + "DeleteVaultAccessPolicy":{ + "name":"DeleteVaultAccessPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultAccessPolicyInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation deletes the access policy associated with the specified vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely remove the access policy, and you might still see the effect of the policy for a short time after you send the delete request.

This operation is idempotent. You can invoke delete multiple times, even if there is no policy associated with the vault. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" + }, + "DeleteVaultNotifications":{ + "name":"DeleteVaultNotifications", + "http":{ + "method":"DELETE", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVaultNotificationsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation deletes the notification configuration set for a vault. The operation is eventually consistent; that is, it might take some time for Amazon S3 Glacier to completely disable the notifications and you might still receive some notifications for a short time after you send the delete request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Delete Vault Notification Configuration in the Amazon S3 Glacier Developer Guide.

" + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}" + }, + "input":{"shape":"DescribeJobInput"}, + "output":{"shape":"GlacierJobDescription"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon S3 Glacier (Glacier) completes the job. For more information about initiating a job, see InitiateJob.

This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For more information about using this operation, see the documentation for the underlying REST API Describe Job in the Amazon Glacier Developer Guide.

" + }, + "DescribeVault":{ + "name":"DescribeVault", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}" + }, + "input":{"shape":"DescribeVaultInput"}, + "output":{"shape":"DescribeVaultOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation returns information about a vault, including the vault's Amazon Resource Name (ARN), the date the vault was created, the number of archives it contains, and the total size of all the archives in the vault. The number of archives and their total size are as of the last inventory generation. This means that if you add or remove an archive from a vault, and then immediately use Describe Vault, the change in contents will not be immediately reflected. If you want to retrieve the latest inventory of the vault, use InitiateJob. Amazon S3 Glacier generates vault inventories approximately daily. For more information, see Downloading a Vault Inventory in Amazon S3 Glacier.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and Describe Vault in the Amazon Glacier Developer Guide.

" + }, + "GetDataRetrievalPolicy":{ + "name":"GetDataRetrievalPolicy", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/policies/data-retrieval" + }, + "input":{"shape":"GetDataRetrievalPolicyInput"}, + "output":{"shape":"GetDataRetrievalPolicyOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation returns the current data retrieval policy for the account and region specified in the GET request. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

" + }, + "GetJobOutput":{ + "name":"GetJobOutput", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs/{jobId}/output" + }, + "input":{"shape":"GetJobOutputInput"}, + "output":{"shape":"GetJobOutputOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation downloads the output of the job you initiated using InitiateJob. Depending on the job type you specified when you initiated the job, the output will be either the content of an archive or a vault inventory.

You can download all the job output or download a portion of the output by specifying a byte range. In the case of an archive retrieval job, depending on the byte range you specify, Amazon S3 Glacier (Glacier) returns the checksum for the portion of the data. You can compute the checksum on the client and verify that the values match to ensure the portion you downloaded is the correct data.

A job ID will not expire for at least 24 hours after Glacier completes the job. That a byte range. For both archive and inventory retrieval jobs, you should verify the downloaded size against the size returned in the headers from the Get Job Output response.

For archive retrieval jobs, you should also verify that the size is what you expected. If you download a portion of the output, the expected size is based on the range of bytes you specified. For example, if you specify a range of bytes=0-1048575, you should verify your download size is 1,048,576 bytes. If you download an entire archive, the expected size is the size of the archive when you uploaded it to Amazon S3 Glacier The expected size is also returned in the headers from the Get Job Output response.

In the case of an archive retrieval job, depending on the byte range you specify, Glacier returns the checksum for the portion of the data. To ensure the portion you downloaded is the correct data, compute the checksum on the client, verify that the values match, and verify that the size is what you expected.

A job ID does not expire for at least 24 hours after Glacier completes the job. That is, you can download the job output within the 24 hours period after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Downloading a Vault Inventory, Downloading an Archive, and Get Job Output

" + }, + "GetVaultAccessPolicy":{ + "name":"GetVaultAccessPolicy", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy" + }, + "input":{"shape":"GetVaultAccessPolicyInput"}, + "output":{"shape":"GetVaultAccessPolicyOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation retrieves the access-policy subresource set on the vault; for more information on setting this subresource, see Set Vault Access Policy (PUT access-policy). If there is no access policy set on the vault, the operation returns a 404 Not found error. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" + }, + "GetVaultLock":{ + "name":"GetVaultLock", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy" + }, + "input":{"shape":"GetVaultLockInput"}, + "output":{"shape":"GetVaultLockOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation retrieves the following attributes from the lock-policy subresource set on the specified vault:

  • The vault lock policy set on the vault.

  • The state of the vault lock, which is either InProgess or Locked.

  • When the lock ID expires. The lock ID is used to complete the vault locking process.

  • When the vault lock was initiated and put into the InProgress state.

A vault lock is put into the InProgress state by calling InitiateVaultLock. A vault lock is put into the Locked state by calling CompleteVaultLock. You can abort the vault locking process by calling AbortVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If there is no vault lock policy set on the vault, the operation returns a 404 Not found error. For more information about vault lock policies, Amazon Glacier Access Control with Vault Lock Policies.

" + }, + "GetVaultNotifications":{ + "name":"GetVaultNotifications", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration" + }, + "input":{"shape":"GetVaultNotificationsInput"}, + "output":{"shape":"GetVaultNotificationsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation retrieves the notification-configuration subresource of the specified vault.

For information about setting a notification configuration on a vault, see SetVaultNotifications. If a notification configuration for a vault is not set, the operation returns a 404 Not Found error. For more information about vault notifications, see Configuring Vault Notifications in Amazon S3 Glacier.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Get Vault Notification Configuration in the Amazon Glacier Developer Guide.

" + }, + "InitiateJob":{ + "name":"InitiateJob", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs", + "responseCode":202 + }, + "input":{"shape":"InitiateJobInput"}, + "output":{"shape":"InitiateJobOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"PolicyEnforcedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"InsufficientCapacityException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation initiates a job of the specified type, which can be a select, an archival retrieval, or a vault retrieval. For more information about using this operation, see the documentation for the underlying REST API Initiate a Job.

" + }, + "InitiateMultipartUpload":{ + "name":"InitiateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads", + "responseCode":201 + }, + "input":{"shape":"InitiateMultipartUploadInput"}, + "output":{"shape":"InitiateMultipartUploadOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation initiates a multipart upload. Amazon S3 Glacier creates a multipart upload resource and returns its ID in the response. The multipart upload ID is used in subsequent requests to upload parts of an archive (see UploadMultipartPart).

When you initiate a multipart upload, you specify the part size in number of bytes. The part size must be a megabyte (1024 KB) multiplied by a power of 2-for example, 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB.

Every part you upload to this resource (see UploadMultipartPart), except the last one, must have the same size. The last one can be the same size or smaller. For example, suppose you want to upload a 16.2 MB file. If you initiate the multipart upload with a part size of 4 MB, you will upload four parts of 4 MB each and one part of 0.2 MB.

You don't need to know the size of the archive when you start a multipart upload because Amazon S3 Glacier does not require you to specify the overall archive size.

After you complete the multipart upload, Amazon S3 Glacier (Glacier) removes the multipart upload resource referenced by the ID. Glacier also removes the multipart upload resource if you cancel the multipart upload or it may be removed if there is no activity for a period of 24 hours.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Initiate Multipart Upload in the Amazon Glacier Developer Guide.

" + }, + "InitiateVaultLock":{ + "name":"InitiateVaultLock", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/lock-policy", + "responseCode":201 + }, + "input":{"shape":"InitiateVaultLockInput"}, + "output":{"shape":"InitiateVaultLockOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation initiates the vault locking process by doing the following:

  • Installing a vault lock policy on the specified vault.

  • Setting the lock state of vault lock to InProgress.

  • Returning a lock ID, which is used to complete the vault locking process.

You can set one vault lock policy for each vault and this policy can be up to 20 KB in size. For more information about vault lock policies, see Amazon Glacier Access Control with Vault Lock Policies.

You must complete the vault locking process within 24 hours after the vault lock enters the InProgress state. After the 24 hour window ends, the lock ID expires, the vault automatically exits the InProgress state, and the vault lock policy is removed from the vault. You call CompleteVaultLock to complete the vault locking process by setting the state of the vault lock to Locked.

After a vault lock is in the Locked state, you cannot initiate a new vault lock for the vault.

You can abort the vault locking process by calling AbortVaultLock. You can get the state of the vault lock by calling GetVaultLock. For more information about the vault locking process, Amazon Glacier Vault Lock.

If this operation is called when the vault lock is in the InProgress state, the operation returns an AccessDeniedException error. When the vault lock is in the InProgress state you must call AbortVaultLock before you can initiate a new vault lock policy.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/jobs" + }, + "input":{"shape":"ListJobsInput"}, + "output":{"shape":"ListJobsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists jobs for a vault, including jobs that are in-progress and jobs that have recently finished. The List Job operation returns a list of these jobs sorted by job initiation time.

Amazon Glacier retains recently completed jobs for a period before deleting them; however, it eventually removes completed jobs. The output of completed jobs can be retrieved. Retaining completed jobs for a period of time after they have completed enables you to get a job output in the event you miss the job completion notification or your first attempt to download it fails. For example, suppose you start an archive retrieval job to download an archive. After the job completes, you start to download the archive but encounter a network error. In this scenario, you can retry and download the archive while the job exists.

The List Jobs operation supports pagination. You should always check the response Marker field. If there are no more jobs to list, the Marker field is set to null. If there are more jobs to list, the Marker field is set to a non-null value, which you can use to continue the pagination of the list. To return a list of jobs that begins at a specific job, set the marker request parameter to the Marker value for that job that you obtained from a previous List Jobs request.

You can set a maximum limit for the number of jobs returned in the response by specifying the limit parameter in the request. The default limit is 50. The number of jobs returned might be fewer than the limit, but the number of returned jobs never exceeds the limit.

Additionally, you can filter the jobs list returned by specifying the optional statuscode parameter or completed parameter, or both. Using the statuscode parameter, you can specify to return only jobs that match either the InProgress, Succeeded, or Failed status. Using the completed parameter, you can specify to return only jobs that were completed (true) or jobs that were not completed (false).

For more information about using this operation, see the documentation for the underlying REST API List Jobs.

" + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads" + }, + "input":{"shape":"ListMultipartUploadsInput"}, + "output":{"shape":"ListMultipartUploadsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 50 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide.

" + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}" + }, + "input":{"shape":"ListPartsInput"}, + "output":{"shape":"ListPartsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists the parts of an archive that have been uploaded in a specific multipart upload. You can make this request at any time during an in-progress multipart upload before you complete the upload (see CompleteMultipartUpload. List Parts returns an error for completed uploads. The list returned in the List Parts response is sorted by part range.

The List Parts operation supports pagination. By default, this operation returns up to 50 uploaded parts in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null. To return a list of parts that begins at a specific part, set the marker request parameter to the value you obtained from a previous List Parts request. You can also limit the number of parts returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and the underlying REST API, see Working with Archives in Amazon S3 Glacier and List Parts in the Amazon Glacier Developer Guide.

" + }, + "ListProvisionedCapacity":{ + "name":"ListProvisionedCapacity", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/provisioned-capacity" + }, + "input":{"shape":"ListProvisionedCapacityInput"}, + "output":{"shape":"ListProvisionedCapacityOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists the provisioned capacity units for the specified AWS account.

" + }, + "ListTagsForVault":{ + "name":"ListTagsForVault", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults/{vaultName}/tags" + }, + "input":{"shape":"ListTagsForVaultInput"}, + "output":{"shape":"ListTagsForVaultOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists all the tags attached to a vault. The operation returns an empty map if there are no tags. For more information about tags, see Tagging Amazon S3 Glacier Resources.

" + }, + "ListVaults":{ + "name":"ListVaults", + "http":{ + "method":"GET", + "requestUri":"/{accountId}/vaults" + }, + "input":{"shape":"ListVaultsInput"}, + "output":{"shape":"ListVaultsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 10 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null. To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Retrieving Vault Metadata in Amazon S3 Glacier and List Vaults in the Amazon Glacier Developer Guide.

" + }, + "PurchaseProvisionedCapacity":{ + "name":"PurchaseProvisionedCapacity", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/provisioned-capacity", + "responseCode":201 + }, + "input":{"shape":"PurchaseProvisionedCapacityInput"}, + "output":{"shape":"PurchaseProvisionedCapacityOutput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation purchases a provisioned capacity unit for an AWS account.

" + }, + "RemoveTagsFromVault":{ + "name":"RemoveTagsFromVault", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/tags?operation=remove", + "responseCode":204 + }, + "input":{"shape":"RemoveTagsFromVaultInput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation removes one or more tags from the set of tags attached to a vault. For more information about tags, see Tagging Amazon S3 Glacier Resources. This operation is idempotent. The operation will be successful, even if there are no tags attached to the vault.

" + }, + "SetDataRetrievalPolicy":{ + "name":"SetDataRetrievalPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/policies/data-retrieval", + "responseCode":204 + }, + "input":{"shape":"SetDataRetrievalPolicyInput"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation sets and then enacts a data retrieval policy in the region specified in the PUT request. You can set one policy per region for an AWS account. The policy is enacted within a few minutes of a successful PUT operation.

The set policy operation does not affect retrieval jobs that were in progress before the policy was enacted. For more information about data retrieval policies, see Amazon Glacier Data Retrieval Policies.

" + }, + "SetVaultAccessPolicy":{ + "name":"SetVaultAccessPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/access-policy", + "responseCode":204 + }, + "input":{"shape":"SetVaultAccessPolicyInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation configures an access policy for a vault and will overwrite an existing policy. To configure a vault access policy, send a PUT request to the access-policy subresource of the vault. An access policy is specific to a vault and is also called a vault subresource. You can set one access policy per vault and the policy can be up to 20 KB in size. For more information about vault access policies, see Amazon Glacier Access Control with Vault Access Policies.

" + }, + "SetVaultNotifications":{ + "name":"SetVaultNotifications", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/notification-configuration", + "responseCode":204 + }, + "input":{"shape":"SetVaultNotificationsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation configures notifications that will be sent when specific events happen to a vault. By default, you don't get any notifications.

To configure vault notifications, send a PUT request to the notification-configuration subresource of the vault. The request should include a JSON document that provides an Amazon SNS topic and specific events for which you want Amazon S3 Glacier to send notifications to the topic.

Amazon SNS topics must grant permission to the vault to be allowed to publish notifications to the topic. You can configure a vault to publish a notification for the following vault events:

  • ArchiveRetrievalCompleted This event occurs when a job that was initiated for an archive retrieval is completed (InitiateJob). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from DescribeJob.

  • InventoryRetrievalCompleted This event occurs when a job that was initiated for an inventory retrieval is completed (InitiateJob). The status of the completed job can be \"Succeeded\" or \"Failed\". The notification sent to the SNS topic is the same output as returned from DescribeJob.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Configuring Vault Notifications in Amazon S3 Glacier and Set Vault Notification Configuration in the Amazon Glacier Developer Guide.

" + }, + "UploadArchive":{ + "name":"UploadArchive", + "http":{ + "method":"POST", + "requestUri":"/{accountId}/vaults/{vaultName}/archives", + "responseCode":201 + }, + "input":{"shape":"UploadArchiveInput"}, + "output":{"shape":"ArchiveCreationOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation adds an archive to a vault. This is a synchronous operation, and for a successful upload, your data is durably persisted. Amazon S3 Glacier returns the archive ID in the x-amz-archive-id header of the response.

You must use the archive ID to access your data in Amazon S3 Glacier. After you upload an archive, you should save the archive ID returned so that you can retrieve or delete the archive later. Besides saving the archive ID, you can also index it and give it a friendly name to allow for better searching. You can also use the optional archive description field to specify how the archive is referred to in an external index of archives, such as you might create in Amazon DynamoDB. You can also get the vault inventory to obtain a list of archive IDs in a vault. For more information, see InitiateJob.

You must provide a SHA256 tree hash of the data you are uploading. For information about computing a SHA256 tree hash, see Computing Checksums.

You can optionally specify an archive description of up to 1,024 printable ASCII characters. You can get the archive description when you either retrieve the archive or get the vault inventory. For more information, see InitiateJob. Amazon Glacier does not interpret the description in any way. An archive description does not need to be unique. You cannot use the description to retrieve or sort the archive list.

Archives are immutable. After you upload an archive, you cannot edit the archive or its description.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading an Archive in Amazon Glacier and Upload Archive in the Amazon Glacier Developer Guide.

" + }, + "UploadMultipartPart":{ + "name":"UploadMultipartPart", + "http":{ + "method":"PUT", + "requestUri":"/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}", + "responseCode":204 + }, + "input":{"shape":"UploadMultipartPartInput"}, + "output":{"shape":"UploadMultipartPartOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"MissingParameterValueException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This operation uploads a part of an archive. You can upload archive parts in any order. You can also upload them in parallel. You can upload up to 10,000 parts for a multipart upload.

Amazon Glacier rejects your upload part request if any of the following conditions is true:

  • SHA256 tree hash does not matchTo ensure that part data is not corrupted in transmission, you compute a SHA256 tree hash of the part and include it in your request. Upon receiving the part data, Amazon S3 Glacier also computes a SHA256 tree hash. If these hash values don't match, the operation fails. For information about computing a SHA256 tree hash, see Computing Checksums.

  • Part size does not matchThe size of each part except the last must match the size specified in the corresponding InitiateMultipartUpload request. The size of the last part must be the same size as, or smaller than, the specified size.

    If you upload a part whose size is smaller than the part size you specified in your initiate multipart upload request and that part is not the last part, then the upload part request will succeed. However, the subsequent Complete Multipart Upload request will fail.

  • Range does not alignThe byte range value in the request does not align with the part size specified in the corresponding initiate request. For example, if you specify a part size of 4194304 bytes (4 MB), then 0 to 4194303 bytes (4 MB - 1) and 4194304 (4 MB) to 8388607 (8 MB - 1) are valid part ranges. However, if you set a range value of 2 MB to 6 MB, the range does not align with the part size and the upload will fail.

This operation is idempotent. If you upload the same part multiple times, the data included in the most recent request overwrites the previously uploaded data.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM).

For conceptual information and underlying REST API, see Uploading Large Archives in Parts (Multipart Upload) and Upload Part in the Amazon Glacier Developer Guide.

" + } + }, + "shapes":{ + "AbortMultipartUploadInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "documentation":"

The upload ID of the multipart upload to delete.

", + "location":"uri", + "locationName":"uploadId" + } + }, + "documentation":"

Provides options to abort a multipart upload identified by the upload ID.

For information about the underlying REST API, see Abort Multipart Upload. For conceptual information, see Working with Archives in Amazon S3 Glacier.

" + }, + "AbortVaultLockInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

The input values for AbortVaultLock.

" + }, + "AccessControlPolicyList":{ + "type":"list", + "member":{"shape":"Grant"} + }, + "ActionCode":{ + "type":"string", + "enum":[ + "ArchiveRetrieval", + "InventoryRetrieval", + "Select" + ] + }, + "AddTagsToVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to add to the vault. Each tag is composed of a key and a value. The value can be an empty string.

" + } + }, + "documentation":"

The input values for AddTagsToVault.

" + }, + "ArchiveCreationOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "documentation":"

The relative URI path of the newly added archive resource.

", + "location":"header", + "locationName":"Location" + }, + "checksum":{ + "shape":"string", + "documentation":"

The checksum of the archive computed by Amazon S3 Glacier.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "archiveId":{ + "shape":"string", + "documentation":"

The ID of the archive. This value is also included as part of the location.

", + "location":"header", + "locationName":"x-amz-archive-id" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

For information about the underlying REST API, see Upload Archive. For conceptual information, see Working with Archives in Amazon S3 Glacier.

" + }, + "CSVInput":{ + "type":"structure", + "members":{ + "FileHeaderInfo":{ + "shape":"FileHeaderInfo", + "documentation":"

Describes the first line of input. Valid values are None, Ignore, and Use.

" + }, + "Comments":{ + "shape":"string", + "documentation":"

A single character used to indicate that a row should be ignored when the character is present at the start of that row.

" + }, + "QuoteEscapeCharacter":{ + "shape":"string", + "documentation":"

A single character used for escaping the quotation-mark character inside an already escaped value.

" + }, + "RecordDelimiter":{ + "shape":"string", + "documentation":"

A value used to separate individual records from each other.

" + }, + "FieldDelimiter":{ + "shape":"string", + "documentation":"

A value used to separate individual fields from each other within a record.

" + }, + "QuoteCharacter":{ + "shape":"string", + "documentation":"

A value used as an escape character where the field delimiter is part of the value.

" + } + }, + "documentation":"

Contains information about the comma-separated value (CSV) file to select from.

" + }, + "CSVOutput":{ + "type":"structure", + "members":{ + "QuoteFields":{ + "shape":"QuoteFields", + "documentation":"

A value that indicates whether all output fields should be contained within quotation marks.

" + }, + "QuoteEscapeCharacter":{ + "shape":"string", + "documentation":"

A single character used for escaping the quotation-mark character inside an already escaped value.

" + }, + "RecordDelimiter":{ + "shape":"string", + "documentation":"

A value used to separate individual records from each other.

" + }, + "FieldDelimiter":{ + "shape":"string", + "documentation":"

A value used to separate individual fields from each other within a record.

" + }, + "QuoteCharacter":{ + "shape":"string", + "documentation":"

A value used as an escape character where the field delimiter is part of the value.

" + } + }, + "documentation":"

Contains information about the comma-separated value (CSV) file that the job results are stored in.

" + }, + "CannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "aws-exec-read", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control" + ] + }, + "CompleteMultipartUploadInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "documentation":"

The upload ID of the multipart upload.

", + "location":"uri", + "locationName":"uploadId" + }, + "archiveSize":{ + "shape":"string", + "documentation":"

The total size, in bytes, of the entire archive. This value should be the sum of all the sizes of the individual parts that you uploaded.

", + "location":"header", + "locationName":"x-amz-archive-size" + }, + "checksum":{ + "shape":"string", + "documentation":"

The SHA256 tree hash of the entire archive. It is the tree hash of SHA256 tree hash of the individual parts. If the value you specify in the request does not match the SHA256 tree hash of the final assembled archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an error and the request fails.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + } + }, + "documentation":"

Provides options to complete a multipart upload operation. This informs Amazon Glacier that all the archive parts have been uploaded and Amazon S3 Glacier (Glacier) can now assemble the archive from the uploaded parts. After assembling and saving the archive to the vault, Glacier returns the URI path of the newly created archive resource.

" + }, + "CompleteVaultLockInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "lockId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "lockId":{ + "shape":"string", + "documentation":"

The lockId value is the lock ID obtained from a InitiateVaultLock request.

", + "location":"uri", + "locationName":"lockId" + } + }, + "documentation":"

The input values for CompleteVaultLock.

" + }, + "CreateVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Provides options to create a vault.

" + }, + "CreateVaultOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "documentation":"

The URI of the vault that was created.

", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "DataRetrievalPolicy":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"DataRetrievalRulesList", + "documentation":"

The policy rule. Although this is a list type, currently there must be only one rule, which contains a Strategy field and optionally a BytesPerHour field.

" + } + }, + "documentation":"

Data retrieval policy.

" + }, + "DataRetrievalRule":{ + "type":"structure", + "members":{ + "Strategy":{ + "shape":"string", + "documentation":"

The type of data retrieval policy to set.

Valid values: BytesPerHour|FreeTier|None

" + }, + "BytesPerHour":{ + "shape":"NullableLong", + "documentation":"

The maximum number of bytes that can be retrieved in an hour.

This field is required only if the value of the Strategy field is BytesPerHour. Your PUT operation will be rejected if the Strategy field is not set to BytesPerHour and you set this field.

" + } + }, + "documentation":"

Data retrieval policy rule.

" + }, + "DataRetrievalRulesList":{ + "type":"list", + "member":{"shape":"DataRetrievalRule"} + }, + "DateTime":{"type":"string"}, + "DeleteArchiveInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "archiveId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "archiveId":{ + "shape":"string", + "documentation":"

The ID of the archive to delete.

", + "location":"uri", + "locationName":"archiveId" + } + }, + "documentation":"

Provides options for deleting an archive from an Amazon S3 Glacier vault.

" + }, + "DeleteVaultAccessPolicyInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

DeleteVaultAccessPolicy input.

" + }, + "DeleteVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Provides options for deleting a vault from Amazon S3 Glacier.

" + }, + "DeleteVaultNotificationsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Provides options for deleting a vault notification configuration from an Amazon Glacier vault.

" + }, + "DescribeJobInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "jobId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "jobId":{ + "shape":"string", + "documentation":"

The ID of the job to describe.

", + "location":"uri", + "locationName":"jobId" + } + }, + "documentation":"

Provides options for retrieving a job description.

" + }, + "DescribeVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Provides options for retrieving metadata for a specific vault in Amazon Glacier.

" + }, + "DescribeVaultOutput":{ + "type":"structure", + "members":{ + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault.

" + }, + "VaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The Universal Coordinated Time (UTC) date when the vault was created. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

" + }, + "LastInventoryDate":{ + "shape":"string", + "documentation":"

The Universal Coordinated Time (UTC) date when Amazon S3 Glacier completed the last vault inventory. This value should be a string in the ISO 8601 date format, for example 2012-03-20T17:03:43.221Z.

" + }, + "NumberOfArchives":{ + "shape":"long", + "documentation":"

The number of archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

" + }, + "SizeInBytes":{ + "shape":"long", + "documentation":"

Total size, in bytes, of the archives in the vault as of the last inventory date. This field will return null if an inventory has not yet run on the vault, for example if you just created the vault.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "Encryption":{ + "type":"structure", + "members":{ + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The server-side encryption algorithm used when storing job results in Amazon S3, for example AES256 or aws:kms.

" + }, + "KMSKeyId":{ + "shape":"string", + "documentation":"

The AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS fail if not made by using Secure Sockets Layer (SSL) or Signature Version 4.

" + }, + "KMSContext":{ + "shape":"string", + "documentation":"

Optional. If the encryption type is aws:kms, you can use this value to specify the encryption context for the job results.

" + } + }, + "documentation":"

Contains information about the encryption used to store the job results in Amazon S3.

" + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "aws:kms", + "AES256" + ] + }, + "ExpressionType":{ + "type":"string", + "enum":["SQL"] + }, + "FileHeaderInfo":{ + "type":"string", + "enum":[ + "USE", + "IGNORE", + "NONE" + ] + }, + "GetDataRetrievalPolicyInput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + } + }, + "documentation":"

Input for GetDataRetrievalPolicy.

" + }, + "GetDataRetrievalPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"DataRetrievalPolicy", + "documentation":"

Contains the returned data retrieval policy in JSON format.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to the GetDataRetrievalPolicy request.

" + }, + "GetJobOutputInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "jobId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "jobId":{ + "shape":"string", + "documentation":"

The job ID whose data is downloaded.

", + "location":"uri", + "locationName":"jobId" + }, + "range":{ + "shape":"string", + "documentation":"

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify the range as bytes=0-1048575. By default, this operation downloads the entire output.

If the job output is large, then you can use a range to retrieve a portion of the output. This allows you to download the entire output in smaller chunks of bytes. For example, suppose you have 1 GB of job output you want to download and you decide to download 128 MB chunks of data at a time, which is a total of eight Get Job Output requests. You use the following process to download the job output:

  1. Download a 128 MB chunk of output by specifying the appropriate byte range. Verify that all 128 MB of data was received.

  2. Along with the data, the response includes a SHA256 tree hash of the payload. You compute the checksum of the payload on the client and compare it with the checksum you received in the response to ensure you received all the expected data.

  3. Repeat steps 1 and 2 for all the eight 128 MB chunks of output data, each time specifying the appropriate byte range.

  4. After downloading all the parts of the job output, you have a list of eight checksum values. Compute the tree hash of these values to find the checksum of the entire output. Using the DescribeJob API, obtain job information of the job that provided you the output. The response includes the checksum of the entire archive stored in Amazon S3 Glacier. You compare this value with the checksum you computed to ensure you have downloaded the entire archive content with no errors.

", + "location":"header", + "locationName":"Range" + } + }, + "documentation":"

Provides options for downloading output of an Amazon S3 Glacier job.

" + }, + "GetJobOutputOutput":{ + "type":"structure", + "members":{ + "body":{ + "shape":"Stream", + "documentation":"

The job data, either archive data or inventory data.

" + }, + "checksum":{ + "shape":"string", + "documentation":"

The checksum of the data in the response. This header is returned only when retrieving the output for an archive retrieval job. Furthermore, this header appears only under the following conditions:

  • You get the entire range of the archive.

  • You request a range to return of the archive that starts and ends on a multiple of 1 MB. For example, if you have an 3.1 MB archive and you specify a range to return that starts at 1 MB and ends at 2 MB, then the x-amz-sha256-tree-hash is returned as a response header.

  • You request a range of the archive to return that starts on a multiple of 1 MB and goes to the end of the archive. For example, if you have a 3.1 MB archive and you specify a range that starts at 2 MB and ends at 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is returned as a response header.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "status":{ + "shape":"httpstatus", + "documentation":"

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

", + "location":"statusCode" + }, + "contentRange":{ + "shape":"string", + "documentation":"

The range of bytes returned by Amazon S3 Glacier. If only partial output is downloaded, the response provides the range of bytes Amazon S3 Glacier returned. For example, bytes 0-1048575/8388608 returns the first 1 MB from 8 MB.

", + "location":"header", + "locationName":"Content-Range" + }, + "acceptRanges":{ + "shape":"string", + "documentation":"

Indicates the range units accepted. For more information, see RFC2616.

", + "location":"header", + "locationName":"Accept-Ranges" + }, + "contentType":{ + "shape":"string", + "documentation":"

The Content-Type depends on whether the job output is an archive or a vault inventory. For archive data, the Content-Type is application/octet-stream. For vault inventory, if you requested CSV format when you initiated the job, the Content-Type is text/csv. Otherwise, by default, vault inventory is returned as JSON, and the Content-Type is application/json.

", + "location":"header", + "locationName":"Content-Type" + }, + "archiveDescription":{ + "shape":"string", + "documentation":"

The description of an archive.

", + "location":"header", + "locationName":"x-amz-archive-description" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

", + "payload":"body" + }, + "GetVaultAccessPolicyInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Input for GetVaultAccessPolicy.

" + }, + "GetVaultAccessPolicyOutput":{ + "type":"structure", + "members":{ + "policy":{ + "shape":"VaultAccessPolicy", + "documentation":"

Contains the returned vault access policy as a JSON string.

" + } + }, + "documentation":"

Output for GetVaultAccessPolicy.

", + "payload":"policy" + }, + "GetVaultLockInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

The input values for GetVaultLock.

" + }, + "GetVaultLockOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"string", + "documentation":"

The vault lock policy as a JSON string, which uses \"\\\" as an escape character.

" + }, + "State":{ + "shape":"string", + "documentation":"

The state of the vault lock. InProgress or Locked.

" + }, + "ExpirationDate":{ + "shape":"string", + "documentation":"

The UTC date and time at which the lock ID expires. This value can be null if the vault lock is in a Locked state.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC date and time at which the vault lock was put into the InProgress state.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "GetVaultNotificationsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

Provides options for retrieving the notification configuration set on an Amazon Glacier vault.

" + }, + "GetVaultNotificationsOutput":{ + "type":"structure", + "members":{ + "vaultNotificationConfig":{ + "shape":"VaultNotificationConfig", + "documentation":"

Returns the notification configuration set on the vault.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

", + "payload":"vaultNotificationConfig" + }, + "GlacierJobDescription":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"string", + "documentation":"

An opaque string that identifies an Amazon S3 Glacier job.

" + }, + "JobDescription":{ + "shape":"string", + "documentation":"

The job description provided when initiating the job.

" + }, + "Action":{ + "shape":"ActionCode", + "documentation":"

The job type. This value is either ArchiveRetrieval, InventoryRetrieval, or Select.

" + }, + "ArchiveId":{ + "shape":"string", + "documentation":"

The archive ID requested for a select job or archive retrieval. Otherwise, this field is null.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault from which an archive retrieval was requested.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC date when the job was created. This value is a string representation of ISO 8601 date format, for example \"2012-03-20T17:03:43.221Z\".

" + }, + "Completed":{ + "shape":"boolean", + "documentation":"

The job status. When a job is completed, you get the job's output using Get Job Output (GET output).

" + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

" + }, + "StatusMessage":{ + "shape":"string", + "documentation":"

A friendly message that describes the job status.

" + }, + "ArchiveSizeInBytes":{ + "shape":"Size", + "documentation":"

For an archive retrieval job, this value is the size in bytes of the archive being requested for download. For an inventory retrieval or select job, this value is null.

" + }, + "InventorySizeInBytes":{ + "shape":"Size", + "documentation":"

For an inventory retrieval job, this value is the size in bytes of the inventory requested for download. For an archive retrieval or select job, this value is null.

" + }, + "SNSTopic":{ + "shape":"string", + "documentation":"

An Amazon SNS topic that receives notification.

" + }, + "CompletionDate":{ + "shape":"string", + "documentation":"

The UTC time that the job request completed. While the job is in progress, the value is null.

" + }, + "SHA256TreeHash":{ + "shape":"string", + "documentation":"

For an archive retrieval job, this value is the checksum of the archive. Otherwise, this value is null.

The SHA256 tree hash value for the requested range of an archive. If the InitiateJob request for an archive specified a tree-hash aligned range, then this field returns a value.

If the whole archive is retrieved, this value is the same as the ArchiveSHA256TreeHash value.

This field is null for the following:

  • Archive retrieval jobs that specify a range that is not tree-hash aligned

  • Archival jobs that specify a range that is equal to the whole archive, when the job status is InProgress

  • Inventory jobs

  • Select jobs

" + }, + "ArchiveSHA256TreeHash":{ + "shape":"string", + "documentation":"

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval or select jobs, this field is null.

" + }, + "RetrievalByteRange":{ + "shape":"string", + "documentation":"

The retrieved byte range for archive retrieval jobs in the form StartByteValue-EndByteValue. If no range was specified in the archive retrieval, then the whole archive is retrieved. In this case, StartByteValue equals 0 and EndByteValue equals the size of the archive minus 1. For inventory retrieval or select jobs, this field is null.

" + }, + "Tier":{ + "shape":"string", + "documentation":"

The tier to use for a select or an archive retrieval. Valid values are Expedited, Standard, or Bulk. Standard is the default.

" + }, + "InventoryRetrievalParameters":{ + "shape":"InventoryRetrievalJobDescription", + "documentation":"

Parameters used for range inventory retrieval.

" + }, + "JobOutputPath":{ + "shape":"string", + "documentation":"

Contains the job output location.

" + }, + "SelectParameters":{ + "shape":"SelectParameters", + "documentation":"

Contains the parameters used for a select.

" + }, + "OutputLocation":{ + "shape":"OutputLocation", + "documentation":"

Contains the location where the data from the select job is stored.

" + } + }, + "documentation":"

Contains the description of an Amazon S3 Glacier job.

" + }, + "Grant":{ + "type":"structure", + "members":{ + "Grantee":{ + "shape":"Grantee", + "documentation":"

The grantee.

" + }, + "Permission":{ + "shape":"Permission", + "documentation":"

Specifies the permission given to the grantee.

" + } + }, + "documentation":"

Contains information about a grant.

" + }, + "Grantee":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"Type", + "documentation":"

Type of grantee

" + }, + "DisplayName":{ + "shape":"string", + "documentation":"

Screen name of the grantee.

" + }, + "URI":{ + "shape":"string", + "documentation":"

URI of the grantee group.

" + }, + "ID":{ + "shape":"string", + "documentation":"

The canonical user ID of the grantee.

" + }, + "EmailAddress":{ + "shape":"string", + "documentation":"

Email address of the grantee.

" + } + }, + "documentation":"

Contains information about the grantee.

" + }, + "InitiateJobInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "jobParameters":{ + "shape":"JobParameters", + "documentation":"

Provides options for specifying job information.

" + } + }, + "documentation":"

Provides options for initiating an Amazon S3 Glacier job.

", + "payload":"jobParameters" + }, + "InitiateJobOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "documentation":"

The relative URI path of the job.

", + "location":"header", + "locationName":"Location" + }, + "jobId":{ + "shape":"string", + "documentation":"

The ID of the job.

", + "location":"header", + "locationName":"x-amz-job-id" + }, + "jobOutputPath":{ + "shape":"string", + "documentation":"

The path to the location of where the select results are stored.

", + "location":"header", + "locationName":"x-amz-job-output-path" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "InitiateMultipartUploadInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "archiveDescription":{ + "shape":"string", + "documentation":"

The archive description that you are uploading in parts.

The part size must be a megabyte (1024 KB) multiplied by a power of 2, for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8 MB), and so on. The minimum allowable part size is 1 MB, and the maximum is 4 GB (4096 MB).

", + "location":"header", + "locationName":"x-amz-archive-description" + }, + "partSize":{ + "shape":"string", + "documentation":"

The size of each part except the last, in bytes. The last part can be smaller than this part size.

", + "location":"header", + "locationName":"x-amz-part-size" + } + }, + "documentation":"

Provides options for initiating a multipart upload to an Amazon S3 Glacier vault.

" + }, + "InitiateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "location":{ + "shape":"string", + "documentation":"

The relative URI path of the multipart upload ID Amazon S3 Glacier created.

", + "location":"header", + "locationName":"Location" + }, + "uploadId":{ + "shape":"string", + "documentation":"

The ID of the multipart upload. This value is also included as part of the location.

", + "location":"header", + "locationName":"x-amz-multipart-upload-id" + } + }, + "documentation":"

The Amazon S3 Glacier response to your request.

" + }, + "InitiateVaultLockInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "policy":{ + "shape":"VaultLockPolicy", + "documentation":"

The vault lock policy as a JSON string, which uses \"\\\" as an escape character.

" + } + }, + "documentation":"

The input values for InitiateVaultLock.

", + "payload":"policy" + }, + "InitiateVaultLockOutput":{ + "type":"structure", + "members":{ + "lockId":{ + "shape":"string", + "documentation":"

The lock ID, which is used to complete the vault locking process.

", + "location":"header", + "locationName":"x-amz-lock-id" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "InputSerialization":{ + "type":"structure", + "members":{ + "csv":{ + "shape":"CSVInput", + "documentation":"

Describes the serialization of a CSV-encoded object.

" + } + }, + "documentation":"

Describes how the archive is serialized.

" + }, + "InsufficientCapacityException":{ + "type":"structure", + "members":{ + "type":{"shape":"string"}, + "code":{"shape":"string"}, + "message":{"shape":"string"} + }, + "documentation":"

Returned if there is insufficient capacity to process this expedited request. This error only applies to expedited retrievals and not to standard or bulk retrievals.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if a parameter of the request is incorrectly specified.

" + } + }, + "documentation":"

Returned if a parameter of the request is incorrectly specified.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InventoryRetrievalJobDescription":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"string", + "documentation":"

The output format for the vault inventory list, which is set by the InitiateJob request when initiating a job to retrieve a vault inventory. Valid values are CSV and JSON.

" + }, + "StartDate":{ + "shape":"DateTime", + "documentation":"

The start of the date range in Universal Coordinated Time (UTC) for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" + }, + "Limit":{ + "shape":"string", + "documentation":"

The maximum number of inventory items returned per vault inventory retrieval request. This limit is set when initiating the job with the a InitiateJob request.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null. For more information, see Range Inventory Retrieval.

" + } + }, + "documentation":"

Describes the options for a range inventory retrieval job.

" + }, + "InventoryRetrievalJobInput":{ + "type":"structure", + "members":{ + "StartDate":{ + "shape":"string", + "documentation":"

The start of the date range in UTC for vault inventory retrieval that includes archives created on or after this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" + }, + "EndDate":{ + "shape":"string", + "documentation":"

The end of the date range in UTC for vault inventory retrieval that includes archives created before this date. This value should be a string in the ISO 8601 date format, for example 2013-03-20T17:03:43Z.

" + }, + "Limit":{ + "shape":"string", + "documentation":"

Specifies the maximum number of inventory items returned per vault inventory retrieval request. Valid values are greater than or equal to 1.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the vault inventory retrieval results. You use the marker in a new InitiateJob request to obtain additional inventory items. If there are no more inventory items, this value is null.

" + } + }, + "documentation":"

Provides options for specifying a range inventory retrieval job.

" + }, + "JobList":{ + "type":"list", + "member":{"shape":"GlacierJobDescription"} + }, + "JobParameters":{ + "type":"structure", + "members":{ + "Format":{ + "shape":"string", + "documentation":"

When initiating a job to retrieve a vault inventory, you can optionally add this parameter to your request to specify the output format. If you are initiating an inventory job and do not specify a Format field, JSON is the default format. Valid values are \"CSV\" and \"JSON\".

" + }, + "Type":{ + "shape":"string", + "documentation":"

The job type. You can initiate a job to perform a select query on an archive, retrieve an archive, or get an inventory of a vault. Valid values are \"select\", \"archive-retrieval\" and \"inventory-retrieval\".

" + }, + "ArchiveId":{ + "shape":"string", + "documentation":"

The ID of the archive that you want to retrieve. This field is required only if Type is set to select or archive-retrievalcode>. An error occurs if you specify this request parameter for an inventory retrieval job request.

" + }, + "Description":{ + "shape":"string", + "documentation":"

The optional description for the job. The description must be less than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII without control codes-specifically, ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

" + }, + "SNSTopic":{ + "shape":"string", + "documentation":"

The Amazon SNS topic ARN to which Amazon S3 Glacier sends a notification when the job is completed and the output is ready for you to download. The specified topic publishes the notification to its subscribers. The SNS topic must exist.

" + }, + "RetrievalByteRange":{ + "shape":"string", + "documentation":"

The byte range to retrieve for an archive retrieval. in the form \"StartByteValue-EndByteValue\" If not specified, the whole archive is retrieved. If specified, the byte range must be megabyte (1024*1024) aligned which means that StartByteValue must be divisible by 1 MB and EndByteValue plus 1 must be divisible by 1 MB or be the end of the archive specified as the archive byte size value minus 1. If RetrievalByteRange is not megabyte aligned, this operation returns a 400 response.

An error occurs if you specify this field for an inventory retrieval job request.

" + }, + "Tier":{ + "shape":"string", + "documentation":"

The tier to use for a select or an archive retrieval job. Valid values are Expedited, Standard, or Bulk. Standard is the default.

" + }, + "InventoryRetrievalParameters":{ + "shape":"InventoryRetrievalJobInput", + "documentation":"

Input parameters used for range inventory retrieval.

" + }, + "SelectParameters":{ + "shape":"SelectParameters", + "documentation":"

Contains the parameters that define a job.

" + }, + "OutputLocation":{ + "shape":"OutputLocation", + "documentation":"

Contains information about the location where the select job results are stored.

" + } + }, + "documentation":"

Provides options for defining a job.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if the request results in a vault limit or tags limit being exceeded.

" + } + }, + "documentation":"

Returned if the request results in a vault or account limit being exceeded.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListJobsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "limit":{ + "shape":"string", + "documentation":"

The maximum number of jobs to be returned. The default limit is 50. The number of jobs returned might be fewer than the specified limit, but the number of returned jobs never exceeds the limit.

", + "location":"querystring", + "locationName":"limit" + }, + "marker":{ + "shape":"string", + "documentation":"

An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of results started in a previous List Jobs request.

", + "location":"querystring", + "locationName":"marker" + }, + "statuscode":{ + "shape":"string", + "documentation":"

The type of job status to return. You can specify the following values: InProgress, Succeeded, or Failed.

", + "location":"querystring", + "locationName":"statuscode" + }, + "completed":{ + "shape":"string", + "documentation":"

The state of the jobs to return. You can specify true or false.

", + "location":"querystring", + "locationName":"completed" + } + }, + "documentation":"

Provides options for retrieving a job list for an Amazon S3 Glacier vault.

" + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "JobList":{ + "shape":"JobList", + "documentation":"

A list of job objects. Each job object contains metadata describing the job.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string used for pagination that specifies the job at which the listing of jobs should begin. You get the marker value from a previous List Jobs response. You only need to include the marker if you are continuing the pagination of the results started in a previous List Jobs request.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "ListMultipartUploadsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "marker":{ + "shape":"string", + "documentation":"

An opaque string used for pagination. This value specifies the upload at which the listing of uploads should begin. Get the marker value from a previous List Uploads response. You need only include the marker if you are continuing the pagination of results started in a previous List Uploads request.

", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "documentation":"

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 50 uploads.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Provides options for retrieving list of in-progress multipart uploads for an Amazon Glacier vault.

" + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "UploadsList":{ + "shape":"UploadsList", + "documentation":"

A list of in-progress multipart uploads.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Multipart Uploads request to obtain more uploads in the list. If there are no more uploads, this value is null.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "ListPartsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "documentation":"

The upload ID of the multipart upload.

", + "location":"uri", + "locationName":"uploadId" + }, + "marker":{ + "shape":"string", + "documentation":"

An opaque string used for pagination. This value specifies the part at which the listing of parts should begin. Get the marker value from the response of a previous List Parts response. You need only include the marker if you are continuing the pagination of results started in a previous List Parts request.

", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "documentation":"

The maximum number of parts to be returned. The default limit is 50. The number of parts returned might be fewer than the specified limit, but the number of returned parts never exceeds the limit.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

" + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "MultipartUploadId":{ + "shape":"string", + "documentation":"

The ID of the upload to which the parts are associated.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

" + }, + "ArchiveDescription":{ + "shape":"string", + "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" + }, + "PartSizeInBytes":{ + "shape":"long", + "documentation":"

The part size in bytes. This is the same value that you specified in the Initiate Multipart Upload request.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC time at which the multipart upload was initiated.

" + }, + "Parts":{ + "shape":"PartList", + "documentation":"

A list of the part sizes of the multipart upload. Each object in the array contains a RangeBytes and sha256-tree-hash name/value pair.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

An opaque string that represents where to continue pagination of the results. You use the marker in a new List Parts request to obtain more jobs in the list. If there are no more parts, this value is null.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "ListProvisionedCapacityInput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + } + } + }, + "ListProvisionedCapacityOutput":{ + "type":"structure", + "members":{ + "ProvisionedCapacityList":{ + "shape":"ProvisionedCapacityList", + "documentation":"

The response body contains the following JSON fields.

" + } + } + }, + "ListTagsForVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + } + }, + "documentation":"

The input value for ListTagsForVaultInput.

" + }, + "ListTagsForVaultOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags attached to the vault. Each tag is composed of a key and a value.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "ListVaultsInput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "marker":{ + "shape":"string", + "documentation":"

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

", + "location":"querystring", + "locationName":"marker" + }, + "limit":{ + "shape":"string", + "documentation":"

The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

", + "location":"querystring", + "locationName":"limit" + } + }, + "documentation":"

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

" + }, + "ListVaultsOutput":{ + "type":"structure", + "members":{ + "VaultList":{ + "shape":"VaultList", + "documentation":"

List of vaults.

" + }, + "Marker":{ + "shape":"string", + "documentation":"

The vault ARN at which to continue pagination of the results. You use the marker in another List Vaults request to obtain more vaults in the list.

" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "MissingParameterValueException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client.

" + }, + "code":{ + "shape":"string", + "documentation":"

400 Bad Request

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if no authentication data is found for the request.

" + } + }, + "documentation":"

Returned if a required header or parameter is missing from the request.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotificationEventList":{ + "type":"list", + "member":{"shape":"string"} + }, + "NullableLong":{"type":"long"}, + "OutputLocation":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Location", + "documentation":"

Describes an S3 location that will receive the results of the job request.

" + } + }, + "documentation":"

Contains information about the location where the select job results are stored.

" + }, + "OutputSerialization":{ + "type":"structure", + "members":{ + "csv":{ + "shape":"CSVOutput", + "documentation":"

Describes the serialization of CSV-encoded query results.

" + } + }, + "documentation":"

Describes how the select output is serialized.

" + }, + "PartList":{ + "type":"list", + "member":{"shape":"PartListElement"} + }, + "PartListElement":{ + "type":"structure", + "members":{ + "RangeInBytes":{ + "shape":"string", + "documentation":"

The byte range of a part, inclusive of the upper value of the range.

" + }, + "SHA256TreeHash":{ + "shape":"string", + "documentation":"

The SHA256 tree hash value that Amazon S3 Glacier calculated for the part. This field is never null.

" + } + }, + "documentation":"

A list of the part sizes of the multipart upload.

" + }, + "Permission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "WRITE", + "WRITE_ACP", + "READ", + "READ_ACP" + ] + }, + "PolicyEnforcedException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

PolicyEnforcedException

" + }, + "message":{ + "shape":"string", + "documentation":"

InitiateJob request denied by current data retrieval policy.

" + } + }, + "documentation":"

Returned if a retrieval job would exceed the current data policy's retrieval rate limit. For more information about data retrieval policies,

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ProvisionedCapacityDescription":{ + "type":"structure", + "members":{ + "CapacityId":{ + "shape":"string", + "documentation":"

The ID that identifies the provisioned capacity unit.

" + }, + "StartDate":{ + "shape":"string", + "documentation":"

The date that the provisioned capacity unit was purchased, in Universal Coordinated Time (UTC).

" + }, + "ExpirationDate":{ + "shape":"string", + "documentation":"

The date that the provisioned capacity unit expires, in Universal Coordinated Time (UTC).

" + } + }, + "documentation":"

The definition for a provisioned capacity unit.

" + }, + "ProvisionedCapacityList":{ + "type":"list", + "member":{"shape":"ProvisionedCapacityDescription"} + }, + "PurchaseProvisionedCapacityInput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, don't include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + } + } + }, + "PurchaseProvisionedCapacityOutput":{ + "type":"structure", + "members":{ + "capacityId":{ + "shape":"string", + "documentation":"

The ID that identifies the provisioned capacity unit.

", + "location":"header", + "locationName":"x-amz-capacity-id" + } + } + }, + "QuoteFields":{ + "type":"string", + "enum":[ + "ALWAYS", + "ASNEEDED" + ] + }, + "RemoveTagsFromVaultInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys. Each corresponding tag is removed from the vault.

" + } + }, + "documentation":"

The input value for RemoveTagsFromVaultInput.

" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

408 Request Timeout

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.

" + } + }, + "documentation":"

Returned if, when uploading an archive, Amazon S3 Glacier times out while receiving the upload.

", + "error":{"httpStatusCode":408}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Client

" + }, + "code":{ + "shape":"string", + "documentation":"

404 Not Found

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

" + } + }, + "documentation":"

Returned if the specified resource (such as a vault, upload ID, or job ID) doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "S3Location":{ + "type":"structure", + "members":{ + "BucketName":{ + "shape":"string", + "documentation":"

The name of the Amazon S3 bucket where the job results are stored.

" + }, + "Prefix":{ + "shape":"string", + "documentation":"

The prefix that is prepended to the results for this request.

" + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

Contains information about the encryption used to store the job results in Amazon S3.

" + }, + "CannedACL":{ + "shape":"CannedACL", + "documentation":"

The canned access control list (ACL) to apply to the job results.

" + }, + "AccessControlList":{ + "shape":"AccessControlPolicyList", + "documentation":"

A list of grants that control access to the staged results.

" + }, + "Tagging":{ + "shape":"hashmap", + "documentation":"

The tag-set that is applied to the job results.

" + }, + "UserMetadata":{ + "shape":"hashmap", + "documentation":"

A map of metadata to store with the job results in Amazon S3.

" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

The storage class used to store the job results.

" + } + }, + "documentation":"

Contains information about the location in Amazon S3 where the select job results are stored.

" + }, + "SelectParameters":{ + "type":"structure", + "members":{ + "InputSerialization":{ + "shape":"InputSerialization", + "documentation":"

Describes the serialization format of the object.

" + }, + "ExpressionType":{ + "shape":"ExpressionType", + "documentation":"

The type of the provided expression, for example SQL.

" + }, + "Expression":{ + "shape":"string", + "documentation":"

The expression that is used to select the object.

" + }, + "OutputSerialization":{ + "shape":"OutputSerialization", + "documentation":"

Describes how the results of the select job are serialized.

" + } + }, + "documentation":"

Contains information about the parameters used for a select.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "type":{ + "shape":"string", + "documentation":"

Server

" + }, + "code":{ + "shape":"string", + "documentation":"

500 Internal Server Error

" + }, + "message":{ + "shape":"string", + "documentation":"

Returned if the service cannot complete the request.

" + } + }, + "documentation":"

Returned if the service cannot complete the request.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "SetDataRetrievalPolicyInput":{ + "type":"structure", + "required":["accountId"], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "Policy":{ + "shape":"DataRetrievalPolicy", + "documentation":"

The data retrieval policy in JSON format.

" + } + }, + "documentation":"

SetDataRetrievalPolicy input.

" + }, + "SetVaultAccessPolicyInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "policy":{ + "shape":"VaultAccessPolicy", + "documentation":"

The vault access policy as a JSON string.

" + } + }, + "documentation":"

SetVaultAccessPolicy input.

", + "payload":"policy" + }, + "SetVaultNotificationsInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "vaultNotificationConfig":{ + "shape":"VaultNotificationConfig", + "documentation":"

Provides options for specifying notification configuration.

" + } + }, + "documentation":"

Provides options to configure notifications that will be sent when specific events happen to a vault.

", + "payload":"vaultNotificationConfig" + }, + "Size":{"type":"long"}, + "StatusCode":{ + "type":"string", + "enum":[ + "InProgress", + "Succeeded", + "Failed" + ] + }, + "StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "STANDARD_IA" + ] + }, + "Stream":{ + "type":"blob", + "streaming":true + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"string"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagValue":{"type":"string"}, + "Type":{ + "type":"string", + "enum":[ + "AmazonCustomerByEmail", + "CanonicalUser", + "Group" + ] + }, + "UploadArchiveInput":{ + "type":"structure", + "required":[ + "vaultName", + "accountId" + ], + "members":{ + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "archiveDescription":{ + "shape":"string", + "documentation":"

The optional description of the archive you are uploading.

", + "location":"header", + "locationName":"x-amz-archive-description" + }, + "checksum":{ + "shape":"string", + "documentation":"

The SHA256 tree hash of the data being uploaded.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "body":{ + "shape":"Stream", + "documentation":"

The data to upload.

" + } + }, + "documentation":"

Provides options to add an archive to a vault.

", + "payload":"body" + }, + "UploadListElement":{ + "type":"structure", + "members":{ + "MultipartUploadId":{ + "shape":"string", + "documentation":"

The ID of a multipart upload.

" + }, + "VaultARN":{ + "shape":"string", + "documentation":"

The Amazon Resource Name (ARN) of the vault that contains the archive.

" + }, + "ArchiveDescription":{ + "shape":"string", + "documentation":"

The description of the archive that was specified in the Initiate Multipart Upload request.

" + }, + "PartSizeInBytes":{ + "shape":"long", + "documentation":"

The part size, in bytes, specified in the Initiate Multipart Upload request. This is the size of all the parts in the upload except the last part, which may be smaller than this size.

" + }, + "CreationDate":{ + "shape":"string", + "documentation":"

The UTC time at which the multipart upload was initiated.

" + } + }, + "documentation":"

A list of in-progress multipart uploads for a vault.

" + }, + "UploadMultipartPartInput":{ + "type":"structure", + "required":[ + "accountId", + "vaultName", + "uploadId" + ], + "members":{ + "accountId":{ + "shape":"string", + "documentation":"

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon S3 Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens ('-') in the ID.

", + "location":"uri", + "locationName":"accountId" + }, + "vaultName":{ + "shape":"string", + "documentation":"

The name of the vault.

", + "location":"uri", + "locationName":"vaultName" + }, + "uploadId":{ + "shape":"string", + "documentation":"

The upload ID of the multipart upload.

", + "location":"uri", + "locationName":"uploadId" + }, + "checksum":{ + "shape":"string", + "documentation":"

The SHA256 tree hash of the data being uploaded.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + }, + "range":{ + "shape":"string", + "documentation":"

Identifies the range of bytes in the assembled archive that will be uploaded in this part. Amazon S3 Glacier uses this information to assemble the archive in the proper sequence. The format of this header follows RFC 2616. An example header is Content-Range:bytes 0-4194303/*.

", + "location":"header", + "locationName":"Content-Range" + }, + "body":{ + "shape":"Stream", + "documentation":"

The data to upload.

" + } + }, + "documentation":"

Provides options to upload a part of an archive in a multipart upload operation.

", + "payload":"body" + }, + "UploadMultipartPartOutput":{ + "type":"structure", + "members":{ + "checksum":{ + "shape":"string", + "documentation":"

The SHA256 tree hash that Amazon S3 Glacier computed for the uploaded part.

", + "location":"header", + "locationName":"x-amz-sha256-tree-hash" + } + }, + "documentation":"

Contains the Amazon S3 Glacier response to your request.

" + }, + "UploadsList":{ + "type":"list", + "member":{"shape":"UploadListElement"} + }, + "VaultAccessPolicy":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"string", + "documentation":"

The vault access policy.

" + } + }, + "documentation":"

Contains the vault access policy.

" + }, + "VaultList":{ + "type":"list", + "member":{"shape":"DescribeVaultOutput"} + }, + "VaultLockPolicy":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"string", + "documentation":"

The vault lock policy.

" + } + }, + "documentation":"

Contains the vault lock policy.

" + }, + "VaultNotificationConfig":{ + "type":"structure", + "members":{ + "SNSTopic":{ + "shape":"string", + "documentation":"

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

" + }, + "Events":{ + "shape":"NotificationEventList", + "documentation":"

A list of one or more events for which Amazon S3 Glacier will send a notification to the specified Amazon SNS topic.

" + } + }, + "documentation":"

Represents a vault's notification configuration.

" + }, + "boolean":{"type":"boolean"}, + "hashmap":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"} + }, + "httpstatus":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + }, + "documentation":"

Amazon S3 Glacier (Glacier) is a storage solution for \"cold data.\"

Glacier is an extremely low-cost storage service that provides secure, durable, and easy-to-use storage for data backup and archival. With Glacier, customers can store their data cost effectively for months, years, or decades. Glacier also enables customers to offload the administrative burdens of operating and scaling storage to AWS, so they don't have to worry about capacity planning, hardware provisioning, data replication, hardware failure and recovery, or time-consuming hardware migrations.

Glacier is a great storage choice when low storage cost is paramount and your data is rarely retrieved. If your application requires fast or frequent access to your data, consider using Amazon S3. For more information, see Amazon Simple Storage Service (Amazon S3).

You can store any kind of data in any format. There is no maximum limit on the total amount of data you can store in Glacier.

If you are a first-time user of Glacier, we recommend that you begin by reading the following sections in the Amazon S3 Glacier Developer Guide:

  • What is Amazon S3 Glacier - This section of the Developer Guide describes the underlying data model, the operations it supports, and the AWS SDKs that you can use to interact with the service.

  • Getting Started with Amazon S3 Glacier - The Getting Started section walks you through the process of creating a vault, uploading archives, creating jobs to download archives, retrieving the job output, and deleting archives.

" +} diff --git a/aws/dist/botocore/data/glacier/2012-06-01/waiters-2.json b/aws/dist/botocore/data/glacier/2012-06-01/waiters-2.json new file mode 100644 index 00000000..07a64a05 --- /dev/null +++ b/aws/dist/botocore/data/glacier/2012-06-01/waiters-2.json @@ -0,0 +1,39 @@ +{ + "version": 2, + "waiters": { + "VaultExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + }, + "VaultNotExists": { + "operation": "DescribeVault", + "delay": 3, + "maxAttempts": 15, + "acceptors": [ + { + "state": "retry", + "matcher": "status", + "expected": 200 + }, + { + "state": "success", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/globalaccelerator/2018-08-08/paginators-1.json b/aws/dist/botocore/data/globalaccelerator/2018-08-08/paginators-1.json new file mode 100644 index 00000000..ed79e0ad --- /dev/null +++ b/aws/dist/botocore/data/globalaccelerator/2018-08-08/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListAccelerators": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Accelerators" + }, + "ListEndpointGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EndpointGroups" + }, + "ListListeners": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Listeners" + } + } +} diff --git a/aws/dist/botocore/data/globalaccelerator/2018-08-08/service-2.json b/aws/dist/botocore/data/globalaccelerator/2018-08-08/service-2.json new file mode 100644 index 00000000..2ebe607c --- /dev/null +++ b/aws/dist/botocore/data/globalaccelerator/2018-08-08/service-2.json @@ -0,0 +1,1181 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-08-08", + "endpointPrefix":"globalaccelerator", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Global Accelerator", + "serviceId":"Global Accelerator", + "signatureVersion":"v4", + "signingName":"globalaccelerator", + "targetPrefix":"GlobalAccelerator_V20180706", + "uid":"globalaccelerator-2018-08-08" + }, + "operations":{ + "CreateAccelerator":{ + "name":"CreateAccelerator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAcceleratorRequest"}, + "output":{"shape":"CreateAcceleratorResponse"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Create an accelerator. An accelerator includes one or more listeners that process inbound connections and direct traffic to one or more endpoint groups, each of which includes endpoints, such as Network Load Balancers. To see an AWS CLI example of creating an accelerator, scroll down to Example.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

" + }, + "CreateEndpointGroup":{ + "name":"CreateEndpointGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointGroupRequest"}, + "output":{"shape":"CreateEndpointGroupResponse"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"EndpointGroupAlreadyExistsException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one AWS Region. To see an AWS CLI example of creating an endpoint group, scroll down to Example.

" + }, + "CreateListener":{ + "name":"CreateListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateListenerRequest"}, + "output":{"shape":"CreateListenerResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InvalidPortRangeException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Create a listener to process inbound connections from clients to an accelerator. Connections arrive to assigned static IP addresses on a port, port range, or list of port ranges that you specify. To see an AWS CLI example of creating a listener, scroll down to Example.

" + }, + "DeleteAccelerator":{ + "name":"DeleteAccelerator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAcceleratorRequest"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"AcceleratorNotDisabledException"}, + {"shape":"AssociatedListenerFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Delete an accelerator. Note: before you can delete an accelerator, you must disable it and remove all dependent resources (listeners and endpoint groups).

" + }, + "DeleteEndpointGroup":{ + "name":"DeleteEndpointGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointGroupRequest"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"EndpointGroupNotFoundException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Delete an endpoint group from a listener.

" + }, + "DeleteListener":{ + "name":"DeleteListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteListenerRequest"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"AssociatedEndpointGroupFoundException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Delete a listener from an accelerator.

" + }, + "DescribeAccelerator":{ + "name":"DescribeAccelerator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAcceleratorRequest"}, + "output":{"shape":"DescribeAcceleratorResponse"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Describe an accelerator. To see an AWS CLI example of describing an accelerator, scroll down to Example.

" + }, + "DescribeAcceleratorAttributes":{ + "name":"DescribeAcceleratorAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAcceleratorAttributesRequest"}, + "output":{"shape":"DescribeAcceleratorAttributesResponse"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Describe the attributes of an accelerator.

" + }, + "DescribeEndpointGroup":{ + "name":"DescribeEndpointGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointGroupRequest"}, + "output":{"shape":"DescribeEndpointGroupResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"EndpointGroupNotFoundException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Describe an endpoint group.

" + }, + "DescribeListener":{ + "name":"DescribeListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeListenerRequest"}, + "output":{"shape":"DescribeListenerResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Describe a listener.

" + }, + "ListAccelerators":{ + "name":"ListAccelerators", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAcceleratorsRequest"}, + "output":{"shape":"ListAcceleratorsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

List the accelerators for an AWS account.

" + }, + "ListEndpointGroups":{ + "name":"ListEndpointGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEndpointGroupsRequest"}, + "output":{"shape":"ListEndpointGroupsResponse"}, + "errors":[ + {"shape":"ListenerNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

List the endpoint groups that are associated with a listener.

" + }, + "ListListeners":{ + "name":"ListListeners", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListListenersRequest"}, + "output":{"shape":"ListListenersResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

List the listeners for an accelerator.

" + }, + "UpdateAccelerator":{ + "name":"UpdateAccelerator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAcceleratorRequest"}, + "output":{"shape":"UpdateAcceleratorResponse"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Update an accelerator. To see an AWS CLI example of updating an accelerator, scroll down to Example.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

" + }, + "UpdateAcceleratorAttributes":{ + "name":"UpdateAcceleratorAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAcceleratorAttributesRequest"}, + "output":{"shape":"UpdateAcceleratorAttributesResponse"}, + "errors":[ + {"shape":"AcceleratorNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Update the attributes for an accelerator. To see an AWS CLI example of updating an accelerator to enable flow logs, scroll down to Example.

" + }, + "UpdateEndpointGroup":{ + "name":"UpdateEndpointGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEndpointGroupRequest"}, + "output":{"shape":"UpdateEndpointGroupResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"EndpointGroupNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Update an endpoint group. To see an AWS CLI example of updating an endpoint group, scroll down to Example.

" + }, + "UpdateListener":{ + "name":"UpdateListener", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateListenerRequest"}, + "output":{"shape":"UpdateListenerResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidPortRangeException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Update a listener.

" + } + }, + "shapes":{ + "Accelerator":{ + "type":"structure", + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator.

" + }, + "Name":{ + "shape":"GenericString", + "documentation":"

The name of the accelerator. The name must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The value for the address type must be IPv4.

" + }, + "Enabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether the accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, accelerator can be deleted.

" + }, + "IpSets":{ + "shape":"IpSets", + "documentation":"

The static IP addresses that Global Accelerator associates with the accelerator.

" + }, + "DnsName":{ + "shape":"GenericString", + "documentation":"

The Domain Name System (DNS) name that Global Accelerator creates that points to your accelerator's static IP addresses.

The naming convention for the DNS name is: a lower case letter a, followed by a 16-bit random hex string, followed by .awsglobalaccelerator.com. For example: a1234567890abcdef.awsglobalaccelerator.com.

For more information about the default DNS name, see Support for DNS Addressing in Global Accelerator in the AWS Global Accelerator Developer Guide.

" + }, + "Status":{ + "shape":"AcceleratorStatus", + "documentation":"

Describes the deployment status of the accelerator.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the accelerator was created.

" + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the accelerator was last modified.

" + } + }, + "documentation":"

An accelerator is a complex type that includes one or more listeners that process inbound connections and then direct traffic to one or more endpoint groups, each of which includes endpoints, such as load balancers.

" + }, + "AcceleratorAttributes":{ + "type":"structure", + "members":{ + "FlowLogsEnabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

" + }, + "FlowLogsS3Bucket":{ + "shape":"GenericString", + "documentation":"

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

" + }, + "FlowLogsS3Prefix":{ + "shape":"GenericString", + "documentation":"

The prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.

" + } + }, + "documentation":"

Attributes of an accelerator.

" + }, + "AcceleratorNotDisabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The accelerator that you specified could not be disabled.

", + "exception":true + }, + "AcceleratorNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The accelerator that you specified doesn't exist.

", + "exception":true + }, + "AcceleratorStatus":{ + "type":"string", + "enum":[ + "DEPLOYED", + "IN_PROGRESS" + ] + }, + "Accelerators":{ + "type":"list", + "member":{"shape":"Accelerator"} + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You don't have access permission.

", + "exception":true + }, + "AssociatedEndpointGroupFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The listener that you specified has an endpoint group associated with it. You must remove all dependent resources from a listener before you can delete it.

", + "exception":true + }, + "AssociatedListenerFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The accelerator that you specified has a listener associated with it. You must remove all dependent resources from an accelerator before you can delete it.

", + "exception":true + }, + "ClientAffinity":{ + "type":"string", + "enum":[ + "NONE", + "SOURCE_IP" + ] + }, + "CreateAcceleratorRequest":{ + "type":"structure", + "required":[ + "Name", + "IdempotencyToken" + ], + "members":{ + "Name":{ + "shape":"GenericString", + "documentation":"

The name of an accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The value for the address type must be IPv4.

" + }, + "Enabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of an accelerator.

" + } + } + }, + "CreateAcceleratorResponse":{ + "type":"structure", + "members":{ + "Accelerator":{ + "shape":"Accelerator", + "documentation":"

The accelerator that is created by specifying a listener and the supported IP address types.

" + } + } + }, + "CreateEndpointGroupRequest":{ + "type":"structure", + "required":[ + "ListenerArn", + "EndpointGroupRegion", + "IdempotencyToken" + ], + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "EndpointGroupRegion":{ + "shape":"GenericString", + "documentation":"

The name of the AWS Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

" + }, + "EndpointConfigurations":{ + "shape":"EndpointConfigurations", + "documentation":"

The list of endpoint objects.

" + }, + "TrafficDialPercentage":{ + "shape":"TrafficDialPercentage", + "documentation":"

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If listener port is a list of ports, Global Accelerator uses the first port in the list.

" + }, + "HealthCheckProtocol":{ + "shape":"HealthCheckProtocol", + "documentation":"

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

" + }, + "HealthCheckPath":{ + "shape":"GenericString", + "documentation":"

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

" + }, + "ThresholdCount":{ + "shape":"ThresholdCount", + "documentation":"

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

" + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

" + } + } + }, + "CreateEndpointGroupResponse":{ + "type":"structure", + "members":{ + "EndpointGroup":{ + "shape":"EndpointGroup", + "documentation":"

The information about the endpoint group that was created.

" + } + } + }, + "CreateListenerRequest":{ + "type":"structure", + "required":[ + "AcceleratorArn", + "PortRanges", + "Protocol", + "IdempotencyToken" + ], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of your accelerator.

" + }, + "PortRanges":{ + "shape":"PortRanges", + "documentation":"

The list of port ranges to support for connections from clients to your accelerator.

" + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"

The protocol for connections from clients to your accelerator.

" + }, + "ClientAffinity":{ + "shape":"ClientAffinity", + "documentation":"

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

" + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

" + } + } + }, + "CreateListenerResponse":{ + "type":"structure", + "members":{ + "Listener":{ + "shape":"Listener", + "documentation":"

The listener that you've created.

" + } + } + }, + "DeleteAcceleratorRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of an accelerator.

" + } + } + }, + "DeleteEndpointGroupRequest":{ + "type":"structure", + "required":["EndpointGroupArn"], + "members":{ + "EndpointGroupArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint group to delete.

" + } + } + }, + "DeleteListenerRequest":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + } + } + }, + "DescribeAcceleratorAttributesRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator with the attributes that you want to describe.

" + } + } + }, + "DescribeAcceleratorAttributesResponse":{ + "type":"structure", + "members":{ + "AcceleratorAttributes":{ + "shape":"AcceleratorAttributes", + "documentation":"

The attributes of the accelerator.

" + } + } + }, + "DescribeAcceleratorRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator to describe.

" + } + } + }, + "DescribeAcceleratorResponse":{ + "type":"structure", + "members":{ + "Accelerator":{ + "shape":"Accelerator", + "documentation":"

The description of the accelerator.

" + } + } + }, + "DescribeEndpointGroupRequest":{ + "type":"structure", + "required":["EndpointGroupArn"], + "members":{ + "EndpointGroupArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint group to describe.

" + } + } + }, + "DescribeEndpointGroupResponse":{ + "type":"structure", + "members":{ + "EndpointGroup":{ + "shape":"EndpointGroup", + "documentation":"

The description of an endpoint group.

" + } + } + }, + "DescribeListenerRequest":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener to describe.

" + } + } + }, + "DescribeListenerResponse":{ + "type":"structure", + "members":{ + "Listener":{ + "shape":"Listener", + "documentation":"

The description of a listener.

" + } + } + }, + "EndpointConfiguration":{ + "type":"structure", + "members":{ + "EndpointId":{ + "shape":"GenericString", + "documentation":"

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID.

" + }, + "Weight":{ + "shape":"EndpointWeight", + "documentation":"

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

" + }, + "ClientIPPreservationEnabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" + } + }, + "documentation":"

A complex type for endpoints.

" + }, + "EndpointConfigurations":{ + "type":"list", + "member":{"shape":"EndpointConfiguration"}, + "max":10, + "min":0 + }, + "EndpointDescription":{ + "type":"structure", + "members":{ + "EndpointId":{ + "shape":"GenericString", + "documentation":"

An ID for the endpoint. If the endpoint is a Network Load Balancer or Application Load Balancer, this is the Amazon Resource Name (ARN) of the resource. If the endpoint is an Elastic IP address, this is the Elastic IP address allocation ID. An Application Load Balancer can be either internal or internet-facing.

" + }, + "Weight":{ + "shape":"EndpointWeight", + "documentation":"

The weight associated with the endpoint. When you add weights to endpoints, you configure AWS Global Accelerator to route traffic based on proportions that you specify. For example, you might specify endpoint weights of 4, 5, 5, and 6 (sum=20). The result is that 4/20 of your traffic, on average, is routed to the first endpoint, 5/20 is routed both to the second and third endpoints, and 6/20 is routed to the last endpoint. For more information, see Endpoint Weights in the AWS Global Accelerator Developer Guide.

" + }, + "HealthState":{ + "shape":"HealthState", + "documentation":"

The health status of the endpoint.

" + }, + "HealthReason":{ + "shape":"GenericString", + "documentation":"

The reason code associated with why the endpoint is not healthy. If the endpoint state is healthy, a reason code is not provided.

If the endpoint state is unhealthy, the reason code can be one of the following values:

  • Timeout: The health check requests to the endpoint are timing out before returning a status.

  • Failed: The health check failed, for example because the endpoint response was invalid (malformed).

If the endpoint state is initial, the reason code can be one of the following values:

  • ProvisioningInProgress: The endpoint is in the process of being provisioned.

  • InitialHealthChecking: Global Accelerator is still setting up the minimum number of health checks for the endpoint that are required to determine its health status.

" + }, + "ClientIPPreservationEnabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether client IP address preservation is enabled for an Application Load Balancer endpoint. The value is true or false. The default value is true for new accelerators.

If the value is set to true, the client's IP address is preserved in the X-Forwarded-For request header as traffic travels to applications on the Application Load Balancer endpoint fronted by the accelerator.

For more information, see Viewing Client IP Addresses in AWS Global Accelerator in the AWS Global Accelerator Developer Guide.

" + } + }, + "documentation":"

A complex type for an endpoint. Each endpoint group can include one or more endpoints, such as load balancers.

" + }, + "EndpointDescriptions":{ + "type":"list", + "member":{"shape":"EndpointDescription"} + }, + "EndpointGroup":{ + "type":"structure", + "members":{ + "EndpointGroupArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint group.

" + }, + "EndpointGroupRegion":{ + "shape":"GenericString", + "documentation":"

The AWS Region that this endpoint group belongs.

" + }, + "EndpointDescriptions":{ + "shape":"EndpointDescriptions", + "documentation":"

The list of endpoint objects.

" + }, + "TrafficDialPercentage":{ + "shape":"TrafficDialPercentage", + "documentation":"

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group.

The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.

" + }, + "HealthCheckProtocol":{ + "shape":"HealthCheckProtocol", + "documentation":"

The protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP.

" + }, + "HealthCheckPath":{ + "shape":"GenericString", + "documentation":"

If the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/).

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.

" + }, + "ThresholdCount":{ + "shape":"ThresholdCount", + "documentation":"

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

" + } + }, + "documentation":"

A complex type for the endpoint group. An AWS Region can have only one endpoint group for a specific listener.

" + }, + "EndpointGroupAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The endpoint group that you specified already exists.

", + "exception":true + }, + "EndpointGroupNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The endpoint group that you specified doesn't exist.

", + "exception":true + }, + "EndpointGroups":{ + "type":"list", + "member":{"shape":"EndpointGroup"} + }, + "EndpointWeight":{ + "type":"integer", + "max":255, + "min":0 + }, + "ErrorMessage":{"type":"string"}, + "GenericBoolean":{"type":"boolean"}, + "GenericString":{ + "type":"string", + "max":255 + }, + "HealthCheckIntervalSeconds":{ + "type":"integer", + "max":30, + "min":10 + }, + "HealthCheckPort":{ + "type":"integer", + "max":65535, + "min":1 + }, + "HealthCheckProtocol":{ + "type":"string", + "enum":[ + "TCP", + "HTTP", + "HTTPS" + ] + }, + "HealthState":{ + "type":"string", + "enum":[ + "INITIAL", + "HEALTHY", + "UNHEALTHY" + ] + }, + "IdempotencyToken":{ + "type":"string", + "max":255 + }, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

There was an internal error for AWS Global Accelerator.

", + "exception":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An argument that you specified is invalid.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

There isn't another item to return.

", + "exception":true + }, + "InvalidPortRangeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

", + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpAddressType":{ + "type":"string", + "enum":["IPV4"] + }, + "IpAddresses":{ + "type":"list", + "member":{"shape":"IpAddress"}, + "max":2, + "min":0 + }, + "IpSet":{ + "type":"structure", + "members":{ + "IpFamily":{ + "shape":"GenericString", + "documentation":"

The types of IP addresses included in this IP set.

" + }, + "IpAddresses":{ + "shape":"IpAddresses", + "documentation":"

The array of IP addresses in the IP address set. An IP address set can have a maximum of two IP addresses.

" + } + }, + "documentation":"

A complex type for the set of IP addresses for an accelerator.

" + }, + "IpSets":{ + "type":"list", + "member":{"shape":"IpSet"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Processing your request would cause you to exceed an AWS Global Accelerator limit.

", + "exception":true + }, + "ListAcceleratorsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of Global Accelerator objects that you want to return with this call. The default value is 10.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "ListAcceleratorsResponse":{ + "type":"structure", + "members":{ + "Accelerators":{ + "shape":"Accelerators", + "documentation":"

The list of accelerators for a customer account.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "ListEndpointGroupsRequest":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of endpoint group objects that you want to return with this call. The default value is 10.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "ListEndpointGroupsResponse":{ + "type":"structure", + "members":{ + "EndpointGroups":{ + "shape":"EndpointGroups", + "documentation":"

The list of the endpoint groups associated with a listener.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "ListListenersRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The number of listener objects that you want to return with this call. The default value is 10.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "ListListenersResponse":{ + "type":"structure", + "members":{ + "Listeners":{ + "shape":"Listeners", + "documentation":"

The list of listeners for an accelerator.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The token for the next set of results. You receive this token from a previous call.

" + } + } + }, + "Listener":{ + "type":"structure", + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener.

" + }, + "PortRanges":{ + "shape":"PortRanges", + "documentation":"

The list of port ranges for the connections from clients to the accelerator.

" + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"

The protocol for the connections from clients to the accelerator.

" + }, + "ClientAffinity":{ + "shape":"ClientAffinity", + "documentation":"

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

" + } + }, + "documentation":"

A complex type for a listener.

" + }, + "ListenerNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The listener that you specified doesn't exist.

", + "exception":true + }, + "Listeners":{ + "type":"list", + "member":{"shape":"Listener"} + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "PortNumber":{ + "type":"integer", + "max":65535, + "min":1 + }, + "PortRange":{ + "type":"structure", + "members":{ + "FromPort":{ + "shape":"PortNumber", + "documentation":"

The first port in the range of ports, inclusive.

" + }, + "ToPort":{ + "shape":"PortNumber", + "documentation":"

The last port in the range of ports, inclusive.

" + } + }, + "documentation":"

A complex type for a range of ports for a listener.

" + }, + "PortRanges":{ + "type":"list", + "member":{"shape":"PortRange"}, + "max":10, + "min":1 + }, + "Protocol":{ + "type":"string", + "enum":[ + "TCP", + "UDP" + ] + }, + "ThresholdCount":{ + "type":"integer", + "max":10, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TrafficDialPercentage":{ + "type":"float", + "max":100, + "min":0 + }, + "UpdateAcceleratorAttributesRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator that you want to update.

" + }, + "FlowLogsEnabled":{ + "shape":"GenericBoolean", + "documentation":"

Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

" + }, + "FlowLogsS3Bucket":{ + "shape":"GenericString", + "documentation":"

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

" + }, + "FlowLogsS3Prefix":{ + "shape":"GenericString", + "documentation":"

Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. If you don’t specify a prefix, the flow logs are stored in the root of the bucket.

" + } + } + }, + "UpdateAcceleratorAttributesResponse":{ + "type":"structure", + "members":{ + "AcceleratorAttributes":{ + "shape":"AcceleratorAttributes", + "documentation":"

Updated attributes for the accelerator.

" + } + } + }, + "UpdateAcceleratorRequest":{ + "type":"structure", + "required":["AcceleratorArn"], + "members":{ + "AcceleratorArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the accelerator to update.

" + }, + "Name":{ + "shape":"GenericString", + "documentation":"

The name of the accelerator. The name can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens (-), and must not begin or end with a hyphen.

" + }, + "IpAddressType":{ + "shape":"IpAddressType", + "documentation":"

The value for the address type must be IPv4.

" + }, + "Enabled":{ + "shape":"GenericBoolean", + "documentation":"

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

" + } + } + }, + "UpdateAcceleratorResponse":{ + "type":"structure", + "members":{ + "Accelerator":{ + "shape":"Accelerator", + "documentation":"

Information about the updated accelerator.

" + } + } + }, + "UpdateEndpointGroupRequest":{ + "type":"structure", + "required":["EndpointGroupArn"], + "members":{ + "EndpointGroupArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the endpoint group.

" + }, + "EndpointConfigurations":{ + "shape":"EndpointConfigurations", + "documentation":"

The list of endpoint objects.

" + }, + "TrafficDialPercentage":{ + "shape":"TrafficDialPercentage", + "documentation":"

The percentage of traffic to send to an AWS Region. Additional traffic is distributed to other endpoint groups for this listener.

Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing.

The default value is 100.

" + }, + "HealthCheckPort":{ + "shape":"HealthCheckPort", + "documentation":"

The port that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default port is the listener port that this endpoint group is associated with. If the listener port is a list of ports, Global Accelerator uses the first port in the list.

" + }, + "HealthCheckProtocol":{ + "shape":"HealthCheckProtocol", + "documentation":"

The protocol that AWS Global Accelerator uses to check the health of endpoints that are part of this endpoint group. The default value is TCP.

" + }, + "HealthCheckPath":{ + "shape":"GenericString", + "documentation":"

If the protocol is HTTP/S, then this specifies the path that is the destination for health check targets. The default value is slash (/).

" + }, + "HealthCheckIntervalSeconds":{ + "shape":"HealthCheckIntervalSeconds", + "documentation":"

The time—10 seconds or 30 seconds—between each health check for an endpoint. The default value is 30.

" + }, + "ThresholdCount":{ + "shape":"ThresholdCount", + "documentation":"

The number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.

" + } + } + }, + "UpdateEndpointGroupResponse":{ + "type":"structure", + "members":{ + "EndpointGroup":{ + "shape":"EndpointGroup", + "documentation":"

The information about the endpoint group that was updated.

" + } + } + }, + "UpdateListenerRequest":{ + "type":"structure", + "required":["ListenerArn"], + "members":{ + "ListenerArn":{ + "shape":"GenericString", + "documentation":"

The Amazon Resource Name (ARN) of the listener to update.

" + }, + "PortRanges":{ + "shape":"PortRanges", + "documentation":"

The updated list of port ranges for the connections from clients to the accelerator.

" + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"

The updated protocol for the connections from clients to the accelerator.

" + }, + "ClientAffinity":{ + "shape":"ClientAffinity", + "documentation":"

Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Clienty affinity gives you control over whether to always route each client to the same specific endpoint.

AWS Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the \"five-tuple\" (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the \"two-tuple\" (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

The default value is NONE.

" + } + } + }, + "UpdateListenerResponse":{ + "type":"structure", + "members":{ + "Listener":{ + "shape":"Listener", + "documentation":"

Information for the updated listener.

" + } + } + } + }, + "documentation":"AWS Global Accelerator

This is the AWS Global Accelerator API Reference. This guide is for developers who need detailed information about AWS Global Accelerator API actions, data types, and errors. For more information about Global Accelerator features, see the AWS Global Accelerator Developer Guide.

AWS Global Accelerator is a network layer service in which you create accelerators to improve availability and performance for internet applications used by a global audience.

You must specify the US-West-2 (Oregon) Region to create or update accelerators.

Global Accelerator provides you with static IP addresses that you associate with your accelerator. These IP addresses are anycast from the AWS edge network and distribute incoming application traffic across multiple endpoint resources in multiple AWS Regions, which increases the availability of your applications. Endpoints can be Elastic IP addresses, Network Load Balancers, and Application Load Balancers that are located in one AWS Region or multiple Regions.

Global Accelerator uses the AWS global network to route traffic to the optimal regional endpoint based on health, client location, and policies that you configure. The service reacts instantly to changes in health or configuration to ensure that internet traffic from clients is directed to only healthy endpoints.

Global Accelerator includes components that work together to help you improve performance and availability for your applications:

Static IP address

AWS Global Accelerator provides you with a set of static IP addresses which are anycast from the AWS edge network and serve as the single fixed entry points for your clients. If you already have Elastic Load Balancing or Elastic IP address resources set up for your applications, you can easily add those to Global Accelerator to allow the resources to be accessed by a Global Accelerator static IP address.

Accelerator

An accelerator directs traffic to optimal endpoints over the AWS global network to improve availability and performance for your internet applications that have a global audience. Each accelerator includes one or more listeners.

Network zone

A network zone services the static IP addresses for your accelerator from a unique IP subnet. Similar to an AWS Availability Zone, a network zone is an isolated unit with its own set of physical infrastructure. When you configure an accelerator, Global Accelerator allocates two IPv4 addresses for it. If one IP address from a network zone becomes unavailable due to IP address blocking by certain client networks, or network disruptions, then client applications can retry on the healthy static IP address from the other isolated network zone.

Listener

A listener processes inbound connections from clients to Global Accelerator, based on the protocol and port that you configure. Each listener has one or more endpoint groups associated with it, and traffic is forwarded to endpoints in one of the groups. You associate endpoint groups with listeners by specifying the Regions that you want to distribute traffic to. Traffic is distributed to optimal endpoints within the endpoint groups associated with a listener.

Endpoint group

Each endpoint group is associated with a specific AWS Region. Endpoint groups include one or more endpoints in the Region. You can increase or reduce the percentage of traffic that would be otherwise directed to an endpoint group by adjusting a setting called a traffic dial. The traffic dial lets you easily do performance testing or blue/green deployment testing for new releases across different AWS Regions, for example.

Endpoint

An endpoint is an Elastic IP address, Network Load Balancer, or Application Load Balancer. Traffic is routed to endpoints based on several factors, including the geo-proximity to the user, the health of the endpoint, and the configuration options that you choose, such as endpoint weights. For each endpoint, you can configure weights, which are numbers that you can use to specify the proportion of traffic to route to each one. This can be useful, for example, to do performance testing within a Region.

" +} diff --git a/aws/dist/botocore/data/glue/2017-03-31/paginators-1.json b/aws/dist/botocore/data/glue/2017-03-31/paginators-1.json new file mode 100644 index 00000000..9ef561c9 --- /dev/null +++ b/aws/dist/botocore/data/glue/2017-03-31/paginators-1.json @@ -0,0 +1,88 @@ +{ + "pagination": { + "GetJobs": { + "result_key": "Jobs", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetPartitions": { + "result_key": "Partitions", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetDatabases": { + "result_key": "DatabaseList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetClassifiers": { + "result_key": "Classifiers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetTableVersions": { + "result_key": "TableVersions", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetCrawlers": { + "result_key": "Crawlers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetDevEndpoints": { + "result_key": "DevEndpoints", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetJobRuns": { + "result_key": "JobRuns", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetTriggers": { + "result_key": "Triggers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetTables": { + "result_key": "TableList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetUserDefinedFunctions": { + "result_key": "UserDefinedFunctions", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetCrawlerMetrics": { + "result_key": "CrawlerMetricsList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetConnections": { + "result_key": "ConnectionList", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetSecurityConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecurityConfigurations" + } + } +} diff --git a/aws/dist/botocore/data/glue/2017-03-31/service-2.json b/aws/dist/botocore/data/glue/2017-03-31/service-2.json new file mode 100644 index 00000000..25704c65 --- /dev/null +++ b/aws/dist/botocore/data/glue/2017-03-31/service-2.json @@ -0,0 +1,9879 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-03-31", + "endpointPrefix":"glue", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Glue", + "serviceId":"Glue", + "signatureVersion":"v4", + "targetPrefix":"AWSGlue", + "uid":"glue-2017-03-31" + }, + "operations":{ + "BatchCreatePartition":{ + "name":"BatchCreatePartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchCreatePartitionRequest"}, + "output":{"shape":"BatchCreatePartitionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates one or more partitions in a batch operation.

" + }, + "BatchDeleteConnection":{ + "name":"BatchDeleteConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteConnectionRequest"}, + "output":{"shape":"BatchDeleteConnectionResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a list of connection definitions from the Data Catalog.

" + }, + "BatchDeletePartition":{ + "name":"BatchDeletePartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeletePartitionRequest"}, + "output":{"shape":"BatchDeletePartitionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes one or more partitions in a batch operation.

" + }, + "BatchDeleteTable":{ + "name":"BatchDeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteTableRequest"}, + "output":{"shape":"BatchDeleteTableResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes multiple tables at once.

After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.

To ensure the immediate deletion of all related resources, before calling BatchDeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.

" + }, + "BatchDeleteTableVersion":{ + "name":"BatchDeleteTableVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteTableVersionRequest"}, + "output":{"shape":"BatchDeleteTableVersionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a specified batch of versions of a table.

" + }, + "BatchGetCrawlers":{ + "name":"BatchGetCrawlers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetCrawlersRequest"}, + "output":{"shape":"BatchGetCrawlersResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Returns a list of resource metadata for a given list of crawler names. After calling the ListCrawlers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

" + }, + "BatchGetDevEndpoints":{ + "name":"BatchGetDevEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetDevEndpointsRequest"}, + "output":{"shape":"BatchGetDevEndpointsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of resource metadata for a given list of development endpoint names. After calling the ListDevEndpoints operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

" + }, + "BatchGetJobs":{ + "name":"BatchGetJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetJobsRequest"}, + "output":{"shape":"BatchGetJobsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of resource metadata for a given list of job names. After calling the ListJobs operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

" + }, + "BatchGetPartition":{ + "name":"BatchGetPartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetPartitionRequest"}, + "output":{"shape":"BatchGetPartitionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves partitions in a batch request.

" + }, + "BatchGetTriggers":{ + "name":"BatchGetTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetTriggersRequest"}, + "output":{"shape":"BatchGetTriggersResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of resource metadata for a given list of trigger names. After calling the ListTriggers operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

" + }, + "BatchGetWorkflows":{ + "name":"BatchGetWorkflows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGetWorkflowsRequest"}, + "output":{"shape":"BatchGetWorkflowsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Returns a list of resource metadata for a given list of workflow names. After calling the ListWorkflows operation, you can call this operation to access the data to which you have been granted permissions. This operation supports all IAM permissions, including permission conditions that uses tags.

" + }, + "BatchStopJobRun":{ + "name":"BatchStopJobRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchStopJobRunRequest"}, + "output":{"shape":"BatchStopJobRunResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Stops one or more job runs for a specified job definition.

" + }, + "CancelMLTaskRun":{ + "name":"CancelMLTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelMLTaskRunRequest"}, + "output":{"shape":"CancelMLTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Cancels (stops) a task run. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can cancel a machine learning task run at any time by calling CancelMLTaskRun with a task run's parent transform's TransformID and the task run's TaskRunId.

" + }, + "CreateClassifier":{ + "name":"CreateClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClassifierRequest"}, + "output":{"shape":"CreateClassifierResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Creates a classifier in the user's account. This can be a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field of the request is present.

" + }, + "CreateConnection":{ + "name":"CreateConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConnectionRequest"}, + "output":{"shape":"CreateConnectionResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates a connection definition in the Data Catalog.

" + }, + "CreateCrawler":{ + "name":"CreateCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCrawlerRequest"}, + "output":{"shape":"CreateCrawlerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"} + ], + "documentation":"

Creates a new crawler with specified targets, role, configuration, and optional schedule. At least one crawl target must be specified, in the s3Targets field, the jdbcTargets field, or the DynamoDBTargets field.

" + }, + "CreateDatabase":{ + "name":"CreateDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatabaseRequest"}, + "output":{"shape":"CreateDatabaseResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates a new database in a Data Catalog.

" + }, + "CreateDevEndpoint":{ + "name":"CreateDevEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDevEndpointRequest"}, + "output":{"shape":"CreateDevEndpointResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNumberLimitExceededException"} + ], + "documentation":"

Creates a new development endpoint.

" + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateJobRequest"}, + "output":{"shape":"CreateJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a new job definition.

" + }, + "CreateMLTransform":{ + "name":"CreateMLTransform", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMLTransformRequest"}, + "output":{"shape":"CreateMLTransformResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

Creates an AWS Glue machine learning transform. This operation creates the transform and all the necessary parameters to train it.

Call this operation as the first step in the process of using a machine learning transform (such as the FindMatches transform) for deduplicating data. You can provide an optional Description, in addition to the parameters that you want to use for your algorithm.

You must also specify certain parameters for the tasks that AWS Glue runs on your behalf as part of learning from your data and creating a high-quality machine learning transform. These parameters include Role, and optionally, AllocatedCapacity, Timeout, and MaxRetries. For more information, see Jobs.

" + }, + "CreatePartition":{ + "name":"CreatePartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePartitionRequest"}, + "output":{"shape":"CreatePartitionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates a new partition.

" + }, + "CreateScript":{ + "name":"CreateScript", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateScriptRequest"}, + "output":{"shape":"CreateScriptResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Transforms a directed acyclic graph (DAG) into code.

" + }, + "CreateSecurityConfiguration":{ + "name":"CreateSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecurityConfigurationRequest"}, + "output":{"shape":"CreateSecurityConfigurationResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"} + ], + "documentation":"

Creates a new security configuration. A security configuration is a set of security properties that can be used by AWS Glue. You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue, see Encrypting Data Written by Crawlers, Jobs, and Development Endpoints.

" + }, + "CreateTable":{ + "name":"CreateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTableRequest"}, + "output":{"shape":"CreateTableResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates a new table definition in the Data Catalog.

" + }, + "CreateTrigger":{ + "name":"CreateTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTriggerRequest"}, + "output":{"shape":"CreateTriggerResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a new trigger.

" + }, + "CreateUserDefinedFunction":{ + "name":"CreateUserDefinedFunction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserDefinedFunctionRequest"}, + "output":{"shape":"CreateUserDefinedFunctionResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates a new function definition in the Data Catalog.

" + }, + "CreateWorkflow":{ + "name":"CreateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkflowRequest"}, + "output":{"shape":"CreateWorkflowResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates a new workflow.

" + }, + "DeleteClassifier":{ + "name":"DeleteClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClassifierRequest"}, + "output":{"shape":"DeleteClassifierResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Removes a classifier from the Data Catalog.

" + }, + "DeleteConnection":{ + "name":"DeleteConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConnectionRequest"}, + "output":{"shape":"DeleteConnectionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a connection from the Data Catalog.

" + }, + "DeleteCrawler":{ + "name":"DeleteCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCrawlerRequest"}, + "output":{"shape":"DeleteCrawlerResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"CrawlerRunningException"}, + {"shape":"SchedulerTransitioningException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Removes a specified crawler from the AWS Glue Data Catalog, unless the crawler state is RUNNING.

" + }, + "DeleteDatabase":{ + "name":"DeleteDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatabaseRequest"}, + "output":{"shape":"DeleteDatabaseResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Removes a specified database from a Data Catalog.

After completing this operation, you no longer have access to the tables (and all table versions and partitions that might belong to the tables) and the user-defined functions in the deleted database. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.

To ensure the immediate deletion of all related resources, before calling DeleteDatabase, use DeleteTableVersion or BatchDeleteTableVersion, DeletePartition or BatchDeletePartition, DeleteUserDefinedFunction, and DeleteTable or BatchDeleteTable, to delete any resources that belong to the database.

" + }, + "DeleteDevEndpoint":{ + "name":"DeleteDevEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDevEndpointRequest"}, + "output":{"shape":"DeleteDevEndpointResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Deletes a specified development endpoint.

" + }, + "DeleteJob":{ + "name":"DeleteJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteJobRequest"}, + "output":{"shape":"DeleteJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a specified job definition. If the job definition is not found, no exception is thrown.

" + }, + "DeleteMLTransform":{ + "name":"DeleteMLTransform", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMLTransformRequest"}, + "output":{"shape":"DeleteMLTransformResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Deletes an AWS Glue machine learning transform. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue. If you no longer need a transform, you can delete it by calling DeleteMLTransforms. However, any AWS Glue jobs that still reference the deleted transform will no longer succeed.

" + }, + "DeletePartition":{ + "name":"DeletePartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePartitionRequest"}, + "output":{"shape":"DeletePartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a specified partition.

" + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConditionCheckFailureException"} + ], + "documentation":"

Deletes a specified policy.

" + }, + "DeleteSecurityConfiguration":{ + "name":"DeleteSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecurityConfigurationRequest"}, + "output":{"shape":"DeleteSecurityConfigurationResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a specified security configuration.

" + }, + "DeleteTable":{ + "name":"DeleteTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTableRequest"}, + "output":{"shape":"DeleteTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Removes a table definition from the Data Catalog.

After completing this operation, you no longer have access to the table versions and partitions that belong to the deleted table. AWS Glue deletes these \"orphaned\" resources asynchronously in a timely manner, at the discretion of the service.

To ensure the immediate deletion of all related resources, before calling DeleteTable, use DeleteTableVersion or BatchDeleteTableVersion, and DeletePartition or BatchDeletePartition, to delete any resources that belong to the table.

" + }, + "DeleteTableVersion":{ + "name":"DeleteTableVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTableVersionRequest"}, + "output":{"shape":"DeleteTableVersionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes a specified version of a table.

" + }, + "DeleteTrigger":{ + "name":"DeleteTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTriggerRequest"}, + "output":{"shape":"DeleteTriggerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a specified trigger. If the trigger is not found, no exception is thrown.

" + }, + "DeleteUserDefinedFunction":{ + "name":"DeleteUserDefinedFunction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserDefinedFunctionRequest"}, + "output":{"shape":"DeleteUserDefinedFunctionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Deletes an existing function definition from the Data Catalog.

" + }, + "DeleteWorkflow":{ + "name":"DeleteWorkflow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkflowRequest"}, + "output":{"shape":"DeleteWorkflowResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes a workflow.

" + }, + "GetCatalogImportStatus":{ + "name":"GetCatalogImportStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCatalogImportStatusRequest"}, + "output":{"shape":"GetCatalogImportStatusResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the status of a migration operation.

" + }, + "GetClassifier":{ + "name":"GetClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetClassifierRequest"}, + "output":{"shape":"GetClassifierResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieve a classifier by name.

" + }, + "GetClassifiers":{ + "name":"GetClassifiers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetClassifiersRequest"}, + "output":{"shape":"GetClassifiersResponse"}, + "errors":[ + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Lists all classifier objects in the Data Catalog.

" + }, + "GetConnection":{ + "name":"GetConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConnectionRequest"}, + "output":{"shape":"GetConnectionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves a connection definition from the Data Catalog.

" + }, + "GetConnections":{ + "name":"GetConnections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConnectionsRequest"}, + "output":{"shape":"GetConnectionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves a list of connection definitions from the Data Catalog.

" + }, + "GetCrawler":{ + "name":"GetCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCrawlerRequest"}, + "output":{"shape":"GetCrawlerResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves metadata for a specified crawler.

" + }, + "GetCrawlerMetrics":{ + "name":"GetCrawlerMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCrawlerMetricsRequest"}, + "output":{"shape":"GetCrawlerMetricsResponse"}, + "errors":[ + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves metrics about specified crawlers.

" + }, + "GetCrawlers":{ + "name":"GetCrawlers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCrawlersRequest"}, + "output":{"shape":"GetCrawlersResponse"}, + "errors":[ + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves metadata for all crawlers defined in the customer account.

" + }, + "GetDataCatalogEncryptionSettings":{ + "name":"GetDataCatalogEncryptionSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDataCatalogEncryptionSettingsRequest"}, + "output":{"shape":"GetDataCatalogEncryptionSettingsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the security configuration for a specified catalog.

" + }, + "GetDatabase":{ + "name":"GetDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDatabaseRequest"}, + "output":{"shape":"GetDatabaseResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves the definition of a specified database.

" + }, + "GetDatabases":{ + "name":"GetDatabases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDatabasesRequest"}, + "output":{"shape":"GetDatabasesResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves all databases defined in a given Data Catalog.

" + }, + "GetDataflowGraph":{ + "name":"GetDataflowGraph", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDataflowGraphRequest"}, + "output":{"shape":"GetDataflowGraphResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Transforms a Python script into a directed acyclic graph (DAG).

" + }, + "GetDevEndpoint":{ + "name":"GetDevEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDevEndpointRequest"}, + "output":{"shape":"GetDevEndpointResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Retrieves information about a specified development endpoint.

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address, and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

" + }, + "GetDevEndpoints":{ + "name":"GetDevEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDevEndpointsRequest"}, + "output":{"shape":"GetDevEndpointsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Retrieves all the development endpoints in this AWS account.

When you create a development endpoint in a virtual private cloud (VPC), AWS Glue returns only a private IP address and the public IP address field is not populated. When you create a non-VPC development endpoint, AWS Glue returns only a public IP address.

" + }, + "GetJob":{ + "name":"GetJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobRequest"}, + "output":{"shape":"GetJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves an existing job definition.

" + }, + "GetJobBookmark":{ + "name":"GetJobBookmark", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobBookmarkRequest"}, + "output":{"shape":"GetJobBookmarkResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns information on a job bookmark entry.

" + }, + "GetJobRun":{ + "name":"GetJobRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobRunRequest"}, + "output":{"shape":"GetJobRunResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the metadata for a given job run.

" + }, + "GetJobRuns":{ + "name":"GetJobRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobRunsRequest"}, + "output":{"shape":"GetJobRunsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves metadata for all runs of a given job definition.

" + }, + "GetJobs":{ + "name":"GetJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobsRequest"}, + "output":{"shape":"GetJobsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves all current job definitions.

" + }, + "GetMLTaskRun":{ + "name":"GetMLTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLTaskRunRequest"}, + "output":{"shape":"GetMLTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Gets details for a specific task run on a machine learning transform. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can check the stats of any task run by calling GetMLTaskRun with the TaskRunID and its parent transform's TransformID.

" + }, + "GetMLTaskRuns":{ + "name":"GetMLTaskRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLTaskRunsRequest"}, + "output":{"shape":"GetMLTaskRunsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Gets a list of runs for a machine learning transform. Machine learning task runs are asynchronous tasks that AWS Glue runs on your behalf as part of various machine learning workflows. You can get a sortable, filterable list of machine learning task runs by calling GetMLTaskRuns with their parent transform's TransformID and other optional parameters as documented in this section.

This operation returns a list of historic runs and must be paginated.

" + }, + "GetMLTransform":{ + "name":"GetMLTransform", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLTransformRequest"}, + "output":{"shape":"GetMLTransformResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Gets an AWS Glue machine learning transform artifact and all its corresponding metadata. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue. You can retrieve their metadata by calling GetMLTransform.

" + }, + "GetMLTransforms":{ + "name":"GetMLTransforms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLTransformsRequest"}, + "output":{"shape":"GetMLTransformsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Gets a sortable, filterable list of existing AWS Glue machine learning transforms. Machine learning transforms are a special type of transform that use machine learning to learn the details of the transformation to be performed by learning from examples provided by humans. These transformations are then saved by AWS Glue, and you can retrieve their metadata by calling GetMLTransforms.

" + }, + "GetMapping":{ + "name":"GetMapping", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMappingRequest"}, + "output":{"shape":"GetMappingResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Creates mappings.

" + }, + "GetPartition":{ + "name":"GetPartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPartitionRequest"}, + "output":{"shape":"GetPartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves information about a specified partition.

" + }, + "GetPartitions":{ + "name":"GetPartitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPartitionsRequest"}, + "output":{"shape":"GetPartitionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves information about the partitions in a table.

" + }, + "GetPlan":{ + "name":"GetPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPlanRequest"}, + "output":{"shape":"GetPlanResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Gets code to perform a specified mapping.

" + }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Retrieves a specified resource policy.

" + }, + "GetSecurityConfiguration":{ + "name":"GetSecurityConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSecurityConfigurationRequest"}, + "output":{"shape":"GetSecurityConfigurationResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves a specified security configuration.

" + }, + "GetSecurityConfigurations":{ + "name":"GetSecurityConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSecurityConfigurationsRequest"}, + "output":{"shape":"GetSecurityConfigurationsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves a list of all security configurations.

" + }, + "GetTable":{ + "name":"GetTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableRequest"}, + "output":{"shape":"GetTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves the Table definition in a Data Catalog for a specified table.

" + }, + "GetTableVersion":{ + "name":"GetTableVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableVersionRequest"}, + "output":{"shape":"GetTableVersionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves a specified version of a table.

" + }, + "GetTableVersions":{ + "name":"GetTableVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTableVersionsRequest"}, + "output":{"shape":"GetTableVersionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves a list of strings that identify available versions of a specified table.

" + }, + "GetTables":{ + "name":"GetTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTablesRequest"}, + "output":{"shape":"GetTablesResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves the definitions of some or all of the tables in a given Database.

" + }, + "GetTags":{ + "name":"GetTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTagsRequest"}, + "output":{"shape":"GetTagsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Retrieves a list of tags associated with a resource.

" + }, + "GetTrigger":{ + "name":"GetTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTriggerRequest"}, + "output":{"shape":"GetTriggerResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the definition of a trigger.

" + }, + "GetTriggers":{ + "name":"GetTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTriggersRequest"}, + "output":{"shape":"GetTriggersResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Gets all the triggers associated with a job.

" + }, + "GetUserDefinedFunction":{ + "name":"GetUserDefinedFunction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserDefinedFunctionRequest"}, + "output":{"shape":"GetUserDefinedFunctionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves a specified function definition from the Data Catalog.

" + }, + "GetUserDefinedFunctions":{ + "name":"GetUserDefinedFunctions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserDefinedFunctionsRequest"}, + "output":{"shape":"GetUserDefinedFunctionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves multiple function definitions from the Data Catalog.

" + }, + "GetWorkflow":{ + "name":"GetWorkflow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowRequest"}, + "output":{"shape":"GetWorkflowResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves resource metadata for a workflow.

" + }, + "GetWorkflowRun":{ + "name":"GetWorkflowRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowRunRequest"}, + "output":{"shape":"GetWorkflowRunResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the metadata for a given workflow run.

" + }, + "GetWorkflowRunProperties":{ + "name":"GetWorkflowRunProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowRunPropertiesRequest"}, + "output":{"shape":"GetWorkflowRunPropertiesResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the workflow run properties which were set during the run.

" + }, + "GetWorkflowRuns":{ + "name":"GetWorkflowRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowRunsRequest"}, + "output":{"shape":"GetWorkflowRunsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves metadata for all runs of a given workflow.

" + }, + "ImportCatalogToGlue":{ + "name":"ImportCatalogToGlue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportCatalogToGlueRequest"}, + "output":{"shape":"ImportCatalogToGlueResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Imports an existing Amazon Athena Data Catalog to AWS Glue

" + }, + "ListCrawlers":{ + "name":"ListCrawlers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCrawlersRequest"}, + "output":{"shape":"ListCrawlersResponse"}, + "errors":[ + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the names of all crawler resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

" + }, + "ListDevEndpoints":{ + "name":"ListDevEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDevEndpointsRequest"}, + "output":{"shape":"ListDevEndpointsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the names of all DevEndpoint resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the names of all job resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

" + }, + "ListTriggers":{ + "name":"ListTriggers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTriggersRequest"}, + "output":{"shape":"ListTriggersResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Retrieves the names of all trigger resources in this AWS account, or the resources with the specified tag. This operation allows you to see which resources are available in your account, and their names.

This operation takes the optional Tags field, which you can use as a filter on the response so that tagged resources can be retrieved as a group. If you choose to use tags filtering, only resources with the tag are retrieved.

" + }, + "ListWorkflows":{ + "name":"ListWorkflows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkflowsRequest"}, + "output":{"shape":"ListWorkflowsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Lists names of workflows created in the account.

" + }, + "PutDataCatalogEncryptionSettings":{ + "name":"PutDataCatalogEncryptionSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDataCatalogEncryptionSettingsRequest"}, + "output":{"shape":"PutDataCatalogEncryptionSettingsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Sets the security configuration for a specified catalog. After the configuration has been set, the specified encryption is applied to every catalog write thereafter.

" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConditionCheckFailureException"} + ], + "documentation":"

Sets the Data Catalog resource policy for access control.

" + }, + "PutWorkflowRunProperties":{ + "name":"PutWorkflowRunProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutWorkflowRunPropertiesRequest"}, + "output":{"shape":"PutWorkflowRunPropertiesResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Puts the specified workflow run properties for the given workflow run. If a property already exists for the specified run, then it overrides the value otherwise adds the property to existing properties.

" + }, + "ResetJobBookmark":{ + "name":"ResetJobBookmark", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetJobBookmarkRequest"}, + "output":{"shape":"ResetJobBookmarkResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Resets a bookmark entry.

" + }, + "SearchTables":{ + "name":"SearchTables", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchTablesRequest"}, + "output":{"shape":"SearchTablesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Searches a set of tables based on properties in the table metadata as well as on the parent database. You can search against text or filter conditions.

You can only get tables that you have access to based on the security policies defined in Lake Formation. You need at least a read-only access to the table for it to be returned. If you do not have access to all the columns in the table, these columns will not be searched against when returning the list of tables back to you. If you have access to the columns but not the data in the columns, those columns and the associated metadata for those columns will be included in the search.

" + }, + "StartCrawler":{ + "name":"StartCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartCrawlerRequest"}, + "output":{"shape":"StartCrawlerResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"CrawlerRunningException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Starts a crawl using the specified crawler, regardless of what is scheduled. If the crawler is already running, returns a CrawlerRunningException.

" + }, + "StartCrawlerSchedule":{ + "name":"StartCrawlerSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartCrawlerScheduleRequest"}, + "output":{"shape":"StartCrawlerScheduleResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"SchedulerRunningException"}, + {"shape":"SchedulerTransitioningException"}, + {"shape":"NoScheduleException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Changes the schedule state of the specified crawler to SCHEDULED, unless the crawler is already running or the schedule state is already SCHEDULED.

" + }, + "StartExportLabelsTaskRun":{ + "name":"StartExportLabelsTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartExportLabelsTaskRunRequest"}, + "output":{"shape":"StartExportLabelsTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Begins an asynchronous task to export all labeled data for a particular transform. This task is the only label-related API call that is not part of the typical active learning workflow. You typically use StartExportLabelsTaskRun when you want to work with all of your existing labels at the same time, such as when you want to remove or change labels that were previously submitted as truth. This API operation accepts the TransformId whose labels you want to export and an Amazon Simple Storage Service (Amazon S3) path to export the labels to. The operation returns a TaskRunId. You can check on the status of your task run by calling the GetMLTaskRun API.

" + }, + "StartImportLabelsTaskRun":{ + "name":"StartImportLabelsTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartImportLabelsTaskRunRequest"}, + "output":{"shape":"StartImportLabelsTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Enables you to provide additional labels (examples of truth) to be used to teach the machine learning transform and improve its quality. This API operation is generally used as part of the active learning workflow that starts with the StartMLLabelingSetGenerationTaskRun call and that ultimately results in improving the quality of your machine learning transform.

After the StartMLLabelingSetGenerationTaskRun finishes, AWS Glue machine learning will have generated a series of questions for humans to answer. (Answering these questions is often called 'labeling' in the machine learning workflows). In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?” After the labeling process is finished, users upload their answers/labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform use the new and improved labels and perform a higher-quality transformation.

By default, StartMLLabelingSetGenerationTaskRun continually learns from and combines all labels that you upload unless you set Replace to true. If you set Replace to true, StartImportLabelsTaskRun deletes and forgets all previously uploaded labels and learns only from the exact set that you upload. Replacing labels can be helpful if you realize that you previously uploaded incorrect labels, and you believe that they are having a negative effect on your transform quality.

You can check on the status of your task run by calling the GetMLTaskRun operation.

" + }, + "StartJobRun":{ + "name":"StartJobRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartJobRunRequest"}, + "output":{"shape":"StartJobRunResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentRunsExceededException"} + ], + "documentation":"

Starts a job run using a job definition.

" + }, + "StartMLEvaluationTaskRun":{ + "name":"StartMLEvaluationTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMLEvaluationTaskRunRequest"}, + "output":{"shape":"StartMLEvaluationTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"ConcurrentRunsExceededException"}, + {"shape":"MLTransformNotReadyException"} + ], + "documentation":"

Starts a task to estimate the quality of the transform.

When you provide label sets as examples of truth, AWS Glue machine learning uses some of those examples to learn from them. The rest of the labels are used as a test to estimate quality.

Returns a unique identifier for the run. You can call GetMLTaskRun to get more information about the stats of the EvaluationTaskRun.

" + }, + "StartMLLabelingSetGenerationTaskRun":{ + "name":"StartMLLabelingSetGenerationTaskRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMLLabelingSetGenerationTaskRunRequest"}, + "output":{"shape":"StartMLLabelingSetGenerationTaskRunResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"ConcurrentRunsExceededException"} + ], + "documentation":"

Starts the active learning workflow for your machine learning transform to improve the transform's quality by generating label sets and adding labels.

When the StartMLLabelingSetGenerationTaskRun finishes, AWS Glue will have generated a \"labeling set\" or a set of questions for humans to answer.

In the case of the FindMatches transform, these questions are of the form, “What is the correct way to group these rows together into groups composed entirely of matching records?”

After the labeling process is finished, you can upload your labels with a call to StartImportLabelsTaskRun. After StartImportLabelsTaskRun finishes, all future runs of the machine learning transform will use the new and improved labels and perform a higher-quality transformation.

" + }, + "StartTrigger":{ + "name":"StartTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTriggerRequest"}, + "output":{"shape":"StartTriggerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentRunsExceededException"} + ], + "documentation":"

Starts an existing trigger. See Triggering Jobs for information about how different types of trigger are started.

" + }, + "StartWorkflowRun":{ + "name":"StartWorkflowRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkflowRunRequest"}, + "output":{"shape":"StartWorkflowRunResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"ConcurrentRunsExceededException"} + ], + "documentation":"

Starts a new run of the specified workflow.

" + }, + "StopCrawler":{ + "name":"StopCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopCrawlerRequest"}, + "output":{"shape":"StopCrawlerResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"CrawlerNotRunningException"}, + {"shape":"CrawlerStoppingException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

If the specified crawler is running, stops the crawl.

" + }, + "StopCrawlerSchedule":{ + "name":"StopCrawlerSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopCrawlerScheduleRequest"}, + "output":{"shape":"StopCrawlerScheduleResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"SchedulerNotRunningException"}, + {"shape":"SchedulerTransitioningException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Sets the schedule state of the specified crawler to NOT_SCHEDULED, but does not stop the crawler if it is already running.

" + }, + "StopTrigger":{ + "name":"StopTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTriggerRequest"}, + "output":{"shape":"StopTriggerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Stops a specified trigger.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Adds tags to a resource. A tag is a label you can assign to an AWS resource. In AWS Glue, you can tag only certain resources. For information about what resources you can tag, see AWS Tags in AWS Glue.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Removes tags from a resource.

" + }, + "UpdateClassifier":{ + "name":"UpdateClassifier", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateClassifierRequest"}, + "output":{"shape":"UpdateClassifierResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"VersionMismatchException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).

" + }, + "UpdateConnection":{ + "name":"UpdateConnection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConnectionRequest"}, + "output":{"shape":"UpdateConnectionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Updates a connection definition in the Data Catalog.

" + }, + "UpdateCrawler":{ + "name":"UpdateCrawler", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCrawlerRequest"}, + "output":{"shape":"UpdateCrawlerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"VersionMismatchException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"CrawlerRunningException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Updates a crawler. If a crawler is running, you must stop it using StopCrawler before updating it.

" + }, + "UpdateCrawlerSchedule":{ + "name":"UpdateCrawlerSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCrawlerScheduleRequest"}, + "output":{"shape":"UpdateCrawlerScheduleResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"VersionMismatchException"}, + {"shape":"SchedulerTransitioningException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Updates the schedule of a crawler using a cron expression.

" + }, + "UpdateDatabase":{ + "name":"UpdateDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDatabaseRequest"}, + "output":{"shape":"UpdateDatabaseResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Updates an existing database definition in a Data Catalog.

" + }, + "UpdateDevEndpoint":{ + "name":"UpdateDevEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDevEndpointRequest"}, + "output":{"shape":"UpdateDevEndpointResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates a specified development endpoint.

" + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateJobRequest"}, + "output":{"shape":"UpdateJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates an existing job definition.

" + }, + "UpdateMLTransform":{ + "name":"UpdateMLTransform", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMLTransformRequest"}, + "output":{"shape":"UpdateMLTransformResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Updates an existing machine learning transform. Call this operation to tune the algorithm parameters to achieve better results.

After calling this operation, you can call the StartMLEvaluationTaskRun operation to assess how well your new parameters achieved your goals (such as improving the quality of your machine learning transform, or making it more cost-effective).

" + }, + "UpdatePartition":{ + "name":"UpdatePartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePartitionRequest"}, + "output":{"shape":"UpdatePartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Updates a partition.

" + }, + "UpdateTable":{ + "name":"UpdateTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTableRequest"}, + "output":{"shape":"UpdateTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNumberLimitExceededException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Updates a metadata table in the Data Catalog.

" + }, + "UpdateTrigger":{ + "name":"UpdateTrigger", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTriggerRequest"}, + "output":{"shape":"UpdateTriggerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates a trigger definition.

" + }, + "UpdateUserDefinedFunction":{ + "name":"UpdateUserDefinedFunction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserDefinedFunctionRequest"}, + "output":{"shape":"UpdateUserDefinedFunctionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Updates an existing function definition in the Data Catalog.

" + }, + "UpdateWorkflow":{ + "name":"UpdateWorkflow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkflowRequest"}, + "output":{"shape":"UpdateWorkflowResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Updates an existing workflow.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

Access to a resource was denied.

", + "exception":true + }, + "Action":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of a job to be executed.

" + }, + "Arguments":{ + "shape":"GenericMap", + "documentation":"

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this action.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies configuration properties of a job run notification.

" + }, + "CrawlerName":{ + "shape":"NameString", + "documentation":"

The name of the crawler to be used with this action.

" + } + }, + "documentation":"

Defines an action to be initiated by a trigger.

" + }, + "ActionList":{ + "type":"list", + "member":{"shape":"Action"} + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A resource to be created or added already exists.

", + "exception":true + }, + "AttemptCount":{"type":"integer"}, + "BatchCreatePartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionInputList" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the catalog in which the partition is to be created. Currently, this should be the AWS account ID.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the metadata database in which the partition is to be created.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the metadata table in which the partition is to be created.

" + }, + "PartitionInputList":{ + "shape":"PartitionInputList", + "documentation":"

A list of PartitionInput structures that define the partitions to be created.

" + } + } + }, + "BatchCreatePartitionResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"PartitionErrors", + "documentation":"

The errors encountered when trying to create the requested partitions.

" + } + } + }, + "BatchDeleteConnectionRequest":{ + "type":"structure", + "required":["ConnectionNameList"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

" + }, + "ConnectionNameList":{ + "shape":"DeleteConnectionNameList", + "documentation":"

A list of names of the connections to delete.

" + } + } + }, + "BatchDeleteConnectionResponse":{ + "type":"structure", + "members":{ + "Succeeded":{ + "shape":"NameStringList", + "documentation":"

A list of names of the connection definitions that were successfully deleted.

" + }, + "Errors":{ + "shape":"ErrorByName", + "documentation":"

A map of the names of connections that were not successfully deleted to error details.

" + } + } + }, + "BatchDeletePartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionsToDelete" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the table in question resides.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table that contains the partitions to be deleted.

" + }, + "PartitionsToDelete":{ + "shape":"BatchDeletePartitionValueList", + "documentation":"

A list of PartitionInput structures that define the partitions to be deleted.

" + } + } + }, + "BatchDeletePartitionResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"PartitionErrors", + "documentation":"

The errors encountered when trying to delete the requested partitions.

" + } + } + }, + "BatchDeletePartitionValueList":{ + "type":"list", + "member":{"shape":"PartitionValueList"}, + "max":25, + "min":0 + }, + "BatchDeleteTableNameList":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":100, + "min":0 + }, + "BatchDeleteTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TablesToDelete" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the tables to delete reside. For Hive compatibility, this name is entirely lowercase.

" + }, + "TablesToDelete":{ + "shape":"BatchDeleteTableNameList", + "documentation":"

A list of the table to delete.

" + } + } + }, + "BatchDeleteTableResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"TableErrors", + "documentation":"

A list of errors encountered in attempting to delete the specified tables.

" + } + } + }, + "BatchDeleteTableVersionList":{ + "type":"list", + "member":{"shape":"VersionString"}, + "max":100, + "min":0 + }, + "BatchDeleteTableVersionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "VersionIds" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table. For Hive compatibility, this name is entirely lowercase.

" + }, + "VersionIds":{ + "shape":"BatchDeleteTableVersionList", + "documentation":"

A list of the IDs of versions to be deleted. A VersionId is a string representation of an integer. Each version is incremented by 1.

" + } + } + }, + "BatchDeleteTableVersionResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"TableVersionErrors", + "documentation":"

A list of errors encountered while trying to delete the specified table versions.

" + } + } + }, + "BatchGetCrawlersRequest":{ + "type":"structure", + "required":["CrawlerNames"], + "members":{ + "CrawlerNames":{ + "shape":"CrawlerNameList", + "documentation":"

A list of crawler names, which might be the names returned from the ListCrawlers operation.

" + } + } + }, + "BatchGetCrawlersResponse":{ + "type":"structure", + "members":{ + "Crawlers":{ + "shape":"CrawlerList", + "documentation":"

A list of crawler definitions.

" + }, + "CrawlersNotFound":{ + "shape":"CrawlerNameList", + "documentation":"

A list of names of crawlers that were not found.

" + } + } + }, + "BatchGetDevEndpointsRequest":{ + "type":"structure", + "required":["DevEndpointNames"], + "members":{ + "DevEndpointNames":{ + "shape":"DevEndpointNames", + "documentation":"

The list of DevEndpoint names, which might be the names returned from the ListDevEndpoint operation.

" + } + } + }, + "BatchGetDevEndpointsResponse":{ + "type":"structure", + "members":{ + "DevEndpoints":{ + "shape":"DevEndpointList", + "documentation":"

A list of DevEndpoint definitions.

" + }, + "DevEndpointsNotFound":{ + "shape":"DevEndpointNames", + "documentation":"

A list of DevEndpoints not found.

" + } + } + }, + "BatchGetJobsRequest":{ + "type":"structure", + "required":["JobNames"], + "members":{ + "JobNames":{ + "shape":"JobNameList", + "documentation":"

A list of job names, which might be the names returned from the ListJobs operation.

" + } + } + }, + "BatchGetJobsResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"JobList", + "documentation":"

A list of job definitions.

" + }, + "JobsNotFound":{ + "shape":"JobNameList", + "documentation":"

A list of names of jobs not found.

" + } + } + }, + "BatchGetPartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionsToGet" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "PartitionsToGet":{ + "shape":"BatchGetPartitionValueList", + "documentation":"

A list of partition values identifying the partitions to retrieve.

" + } + } + }, + "BatchGetPartitionResponse":{ + "type":"structure", + "members":{ + "Partitions":{ + "shape":"PartitionList", + "documentation":"

A list of the requested partitions.

" + }, + "UnprocessedKeys":{ + "shape":"BatchGetPartitionValueList", + "documentation":"

A list of the partition values in the request for which partitions were not returned.

" + } + } + }, + "BatchGetPartitionValueList":{ + "type":"list", + "member":{"shape":"PartitionValueList"}, + "max":1000, + "min":0 + }, + "BatchGetTriggersRequest":{ + "type":"structure", + "required":["TriggerNames"], + "members":{ + "TriggerNames":{ + "shape":"TriggerNameList", + "documentation":"

A list of trigger names, which may be the names returned from the ListTriggers operation.

" + } + } + }, + "BatchGetTriggersResponse":{ + "type":"structure", + "members":{ + "Triggers":{ + "shape":"TriggerList", + "documentation":"

A list of trigger definitions.

" + }, + "TriggersNotFound":{ + "shape":"TriggerNameList", + "documentation":"

A list of names of triggers not found.

" + } + } + }, + "BatchGetWorkflowsRequest":{ + "type":"structure", + "required":["Names"], + "members":{ + "Names":{ + "shape":"WorkflowNames", + "documentation":"

A list of workflow names, which may be the names returned from the ListWorkflows operation.

" + }, + "IncludeGraph":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether to include a graph when returning the workflow resource metadata.

" + } + } + }, + "BatchGetWorkflowsResponse":{ + "type":"structure", + "members":{ + "Workflows":{ + "shape":"Workflows", + "documentation":"

A list of workflow resource metadata.

" + }, + "MissingWorkflows":{ + "shape":"WorkflowNames", + "documentation":"

A list of names of workflows not found.

" + } + } + }, + "BatchStopJobRunError":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition that is used in the job run in question.

" + }, + "JobRunId":{ + "shape":"IdString", + "documentation":"

The JobRunId of the job run in question.

" + }, + "ErrorDetail":{ + "shape":"ErrorDetail", + "documentation":"

Specifies details about the error that was encountered.

" + } + }, + "documentation":"

Records an error that occurred when attempting to stop a specified job run.

" + }, + "BatchStopJobRunErrorList":{ + "type":"list", + "member":{"shape":"BatchStopJobRunError"} + }, + "BatchStopJobRunJobRunIdList":{ + "type":"list", + "member":{"shape":"IdString"}, + "max":25, + "min":1 + }, + "BatchStopJobRunRequest":{ + "type":"structure", + "required":[ + "JobName", + "JobRunIds" + ], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition for which to stop job runs.

" + }, + "JobRunIds":{ + "shape":"BatchStopJobRunJobRunIdList", + "documentation":"

A list of the JobRunIds that should be stopped for that job definition.

" + } + } + }, + "BatchStopJobRunResponse":{ + "type":"structure", + "members":{ + "SuccessfulSubmissions":{ + "shape":"BatchStopJobRunSuccessfulSubmissionList", + "documentation":"

A list of the JobRuns that were successfully submitted for stopping.

" + }, + "Errors":{ + "shape":"BatchStopJobRunErrorList", + "documentation":"

A list of the errors that were encountered in trying to stop JobRuns, including the JobRunId for which each error was encountered and details about the error.

" + } + } + }, + "BatchStopJobRunSuccessfulSubmission":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition used in the job run that was stopped.

" + }, + "JobRunId":{ + "shape":"IdString", + "documentation":"

The JobRunId of the job run that was stopped.

" + } + }, + "documentation":"

Records a successful request to stop a specified JobRun.

" + }, + "BatchStopJobRunSuccessfulSubmissionList":{ + "type":"list", + "member":{"shape":"BatchStopJobRunSuccessfulSubmission"} + }, + "Boolean":{"type":"boolean"}, + "BooleanNullable":{"type":"boolean"}, + "BooleanValue":{"type":"boolean"}, + "BoundedPartitionValueList":{ + "type":"list", + "member":{"shape":"ValueString"}, + "max":100, + "min":0 + }, + "CancelMLTaskRunRequest":{ + "type":"structure", + "required":[ + "TransformId", + "TaskRunId" + ], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "TaskRunId":{ + "shape":"HashString", + "documentation":"

A unique identifier for the task run.

" + } + } + }, + "CancelMLTaskRunResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier for the task run.

" + }, + "Status":{ + "shape":"TaskStatusType", + "documentation":"

The status for this run.

" + } + } + }, + "CatalogEncryptionMode":{ + "type":"string", + "enum":[ + "DISABLED", + "SSE-KMS" + ] + }, + "CatalogEntries":{ + "type":"list", + "member":{"shape":"CatalogEntry"} + }, + "CatalogEntry":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName" + ], + "members":{ + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in which the table metadata resides.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table in question.

" + } + }, + "documentation":"

Specifies a table definition in the AWS Glue Data Catalog.

" + }, + "CatalogIdString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "CatalogImportStatus":{ + "type":"structure", + "members":{ + "ImportCompleted":{ + "shape":"Boolean", + "documentation":"

True if the migration has completed, or False otherwise.

" + }, + "ImportTime":{ + "shape":"Timestamp", + "documentation":"

The time that the migration was started.

" + }, + "ImportedBy":{ + "shape":"NameString", + "documentation":"

The name of the person who initiated the migration.

" + } + }, + "documentation":"

A structure containing migration status information.

" + }, + "CatalogTablesList":{ + "type":"list", + "member":{"shape":"NameString"}, + "min":1 + }, + "CatalogTarget":{ + "type":"structure", + "required":[ + "DatabaseName", + "Tables" + ], + "members":{ + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the database to be synchronized.

" + }, + "Tables":{ + "shape":"CatalogTablesList", + "documentation":"

A list of the tables to be synchronized.

" + } + }, + "documentation":"

Specifies an AWS Glue Data Catalog target.

" + }, + "CatalogTargetList":{ + "type":"list", + "member":{"shape":"CatalogTarget"} + }, + "Classification":{"type":"string"}, + "Classifier":{ + "type":"structure", + "members":{ + "GrokClassifier":{ + "shape":"GrokClassifier", + "documentation":"

A classifier that uses grok.

" + }, + "XMLClassifier":{ + "shape":"XMLClassifier", + "documentation":"

A classifier for XML content.

" + }, + "JsonClassifier":{ + "shape":"JsonClassifier", + "documentation":"

A classifier for JSON content.

" + }, + "CsvClassifier":{ + "shape":"CsvClassifier", + "documentation":"

A classifier for comma-separated values (CSV).

" + } + }, + "documentation":"

Classifiers are triggered during a crawl task. A classifier checks whether a given file is in a format it can handle. If it is, the classifier creates a schema in the form of a StructType object that matches that data format.

You can use the standard classifiers that AWS Glue provides, or you can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier can be a grok classifier, an XML classifier, a JSON classifier, or a custom CSV classifier, as specified in one of the fields in the Classifier object.

" + }, + "ClassifierList":{ + "type":"list", + "member":{"shape":"Classifier"} + }, + "ClassifierNameList":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "CloudWatchEncryption":{ + "type":"structure", + "members":{ + "CloudWatchEncryptionMode":{ + "shape":"CloudWatchEncryptionMode", + "documentation":"

The encryption mode to use for CloudWatch data.

" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" + } + }, + "documentation":"

Specifies how Amazon CloudWatch data should be encrypted.

" + }, + "CloudWatchEncryptionMode":{ + "type":"string", + "enum":[ + "DISABLED", + "SSE-KMS" + ] + }, + "CodeGenArgName":{"type":"string"}, + "CodeGenArgValue":{"type":"string"}, + "CodeGenEdge":{ + "type":"structure", + "required":[ + "Source", + "Target" + ], + "members":{ + "Source":{ + "shape":"CodeGenIdentifier", + "documentation":"

The ID of the node at which the edge starts.

" + }, + "Target":{ + "shape":"CodeGenIdentifier", + "documentation":"

The ID of the node at which the edge ends.

" + }, + "TargetParameter":{ + "shape":"CodeGenArgName", + "documentation":"

The target of the edge.

" + } + }, + "documentation":"

Represents a directional edge in a directed acyclic graph (DAG).

" + }, + "CodeGenIdentifier":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[A-Za-z_][A-Za-z0-9_]*" + }, + "CodeGenNode":{ + "type":"structure", + "required":[ + "Id", + "NodeType", + "Args" + ], + "members":{ + "Id":{ + "shape":"CodeGenIdentifier", + "documentation":"

A node identifier that is unique within the node's graph.

" + }, + "NodeType":{ + "shape":"CodeGenNodeType", + "documentation":"

The type of node that this is.

" + }, + "Args":{ + "shape":"CodeGenNodeArgs", + "documentation":"

Properties of the node, in the form of name-value pairs.

" + }, + "LineNumber":{ + "shape":"Integer", + "documentation":"

The line number of the node.

" + } + }, + "documentation":"

Represents a node in a directed acyclic graph (DAG)

" + }, + "CodeGenNodeArg":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"CodeGenArgName", + "documentation":"

The name of the argument or property.

" + }, + "Value":{ + "shape":"CodeGenArgValue", + "documentation":"

The value of the argument or property.

" + }, + "Param":{ + "shape":"Boolean", + "documentation":"

True if the value is used as a parameter.

" + } + }, + "documentation":"

An argument or property of a node.

" + }, + "CodeGenNodeArgs":{ + "type":"list", + "member":{"shape":"CodeGenNodeArg"}, + "max":50, + "min":0 + }, + "CodeGenNodeType":{"type":"string"}, + "Column":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the Column.

" + }, + "Type":{ + "shape":"ColumnTypeString", + "documentation":"

The data type of the Column.

" + }, + "Comment":{ + "shape":"CommentString", + "documentation":"

A free-form text comment.

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define properties associated with the column.

" + } + }, + "documentation":"

A column in a Table.

" + }, + "ColumnList":{ + "type":"list", + "member":{"shape":"Column"} + }, + "ColumnNameString":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "ColumnTypeString":{ + "type":"string", + "max":131072, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "ColumnValueStringList":{ + "type":"list", + "member":{"shape":"ColumnValuesString"} + }, + "ColumnValuesString":{"type":"string"}, + "CommentString":{ + "type":"string", + "max":255, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "Comparator":{ + "type":"string", + "enum":[ + "EQUALS", + "GREATER_THAN", + "LESS_THAN", + "GREATER_THAN_EQUALS", + "LESS_THAN_EQUALS" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

Two processes are trying to modify a resource simultaneously.

", + "exception":true + }, + "ConcurrentRunsExceededException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

Too many jobs are being run concurrently.

", + "exception":true + }, + "Condition":{ + "type":"structure", + "members":{ + "LogicalOperator":{ + "shape":"LogicalOperator", + "documentation":"

A logical operator.

" + }, + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

" + }, + "State":{ + "shape":"JobRunState", + "documentation":"

The condition state. Currently, the values supported are SUCCEEDED, STOPPED, TIMEOUT, and FAILED.

" + }, + "CrawlerName":{ + "shape":"NameString", + "documentation":"

The name of the crawler to which this condition applies.

" + }, + "CrawlState":{ + "shape":"CrawlState", + "documentation":"

The state of the crawler to which this condition applies.

" + } + }, + "documentation":"

Defines a condition under which a trigger fires.

" + }, + "ConditionCheckFailureException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A specified condition was not satisfied.

", + "exception":true + }, + "ConditionList":{ + "type":"list", + "member":{"shape":"Condition"} + }, + "ConfusionMatrix":{ + "type":"structure", + "members":{ + "NumTruePositives":{ + "shape":"RecordsCount", + "documentation":"

The number of matches in the data that the transform correctly found, in the confusion matrix for your transform.

" + }, + "NumFalsePositives":{ + "shape":"RecordsCount", + "documentation":"

The number of nonmatches in the data that the transform incorrectly classified as a match, in the confusion matrix for your transform.

" + }, + "NumTrueNegatives":{ + "shape":"RecordsCount", + "documentation":"

The number of nonmatches in the data that the transform correctly rejected, in the confusion matrix for your transform.

" + }, + "NumFalseNegatives":{ + "shape":"RecordsCount", + "documentation":"

The number of matches in the data that the transform didn't find, in the confusion matrix for your transform.

" + } + }, + "documentation":"

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

For more information, see Confusion matrix in Wikipedia.

" + }, + "Connection":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the connection definition.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The description of the connection.

" + }, + "ConnectionType":{ + "shape":"ConnectionType", + "documentation":"

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

" + }, + "MatchCriteria":{ + "shape":"MatchCriteria", + "documentation":"

A list of criteria that can be used in selecting this connection.

" + }, + "ConnectionProperties":{ + "shape":"ConnectionProperties", + "documentation":"

These key-value pairs define parameters for the connection:

  • HOST - The host URI: either the fully qualified domain name (FQDN) or the IPv4 address of the database host.

  • PORT - The port number, between 1024 and 65535, of the port on which the database host is listening for database connections.

  • USER_NAME - The name under which to log in to the database. The value string for USER_NAME is \"USERNAME\".

  • PASSWORD - A password, if one is used, for the user name.

  • ENCRYPTED_PASSWORD - When you enable connection password protection by setting ConnectionPasswordEncryption in the Data Catalog encryption settings, this field stores the encrypted password.

  • JDBC_DRIVER_JAR_URI - The Amazon Simple Storage Service (Amazon S3) path of the JAR file that contains the JDBC driver to use.

  • JDBC_DRIVER_CLASS_NAME - The class name of the JDBC driver to use.

  • JDBC_ENGINE - The name of the JDBC engine to use.

  • JDBC_ENGINE_VERSION - The version of the JDBC engine to use.

  • CONFIG_FILES - (Reserved for future use.)

  • INSTANCE_ID - The instance ID to use.

  • JDBC_CONNECTION_URL - The URL for the JDBC connection.

  • JDBC_ENFORCE_SSL - A Boolean string (true, false) specifying whether Secure Sockets Layer (SSL) with hostname matching is enforced for the JDBC connection on the client. The default is false.

  • CUSTOM_JDBC_CERT - An Amazon S3 location specifying the customer's root certificate. AWS Glue uses this root certificate to validate the customer’s certificate when connecting to the customer database. AWS Glue only handles X.509 certificates. The certificate provided must be DER-encoded and supplied in Base64 encoding PEM format.

  • SKIP_CUSTOM_JDBC_CERT_VALIDATION - By default, this is false. AWS Glue validates the Signature algorithm and Subject Public Key Algorithm for the customer certificate. The only permitted algorithms for the Signature algorithm are SHA256withRSA, SHA384withRSA or SHA512withRSA. For the Subject Public Key Algorithm, the key length must be at least 2048. You can set the value of this property to true to skip AWS Glue’s validation of the customer certificate.

  • CUSTOM_JDBC_CERT_STRING - A custom JDBC certificate string which is used for domain match or distinguished name match to prevent a man-in-the-middle attack. In Oracle database, this is used as the SSL_SERVER_CERT_DN; in Microsoft SQL Server, this is used as the hostNameInCertificate.

" + }, + "PhysicalConnectionRequirements":{ + "shape":"PhysicalConnectionRequirements", + "documentation":"

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to make this connection successfully.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that this connection definition was created.

" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"

The last time that this connection definition was updated.

" + }, + "LastUpdatedBy":{ + "shape":"NameString", + "documentation":"

The user, group, or role that last updated this connection definition.

" + } + }, + "documentation":"

Defines a connection to a data source.

" + }, + "ConnectionInput":{ + "type":"structure", + "required":[ + "Name", + "ConnectionType", + "ConnectionProperties" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the connection.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The description of the connection.

" + }, + "ConnectionType":{ + "shape":"ConnectionType", + "documentation":"

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

" + }, + "MatchCriteria":{ + "shape":"MatchCriteria", + "documentation":"

A list of criteria that can be used in selecting this connection.

" + }, + "ConnectionProperties":{ + "shape":"ConnectionProperties", + "documentation":"

These key-value pairs define parameters for the connection.

" + }, + "PhysicalConnectionRequirements":{ + "shape":"PhysicalConnectionRequirements", + "documentation":"

A map of physical connection requirements, such as virtual private cloud (VPC) and SecurityGroup, that are needed to successfully make this connection.

" + } + }, + "documentation":"

A structure that is used to specify a connection to create or update.

" + }, + "ConnectionList":{ + "type":"list", + "member":{"shape":"Connection"} + }, + "ConnectionName":{"type":"string"}, + "ConnectionPasswordEncryption":{ + "type":"structure", + "required":["ReturnConnectionPasswordEncrypted"], + "members":{ + "ReturnConnectionPasswordEncrypted":{ + "shape":"Boolean", + "documentation":"

When the ReturnConnectionPasswordEncrypted flag is set to \"true\", passwords remain encrypted in the responses of GetConnection and GetConnections. This encryption takes effect independently from catalog encryption.

" + }, + "AwsKmsKeyId":{ + "shape":"NameString", + "documentation":"

An AWS KMS key that is used to encrypt the connection password.

If connection password protection is enabled, the caller of CreateConnection and UpdateConnection needs at least kms:Encrypt permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog.

You can set the decrypt permission to enable or restrict access on the password key according to your security requirements.

" + } + }, + "documentation":"

The data structure used by the Data Catalog to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

When a CreationConnection request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.

This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.

" + }, + "ConnectionProperties":{ + "type":"map", + "key":{"shape":"ConnectionPropertyKey"}, + "value":{"shape":"ValueString"}, + "max":100, + "min":0 + }, + "ConnectionPropertyKey":{ + "type":"string", + "enum":[ + "HOST", + "PORT", + "USERNAME", + "PASSWORD", + "ENCRYPTED_PASSWORD", + "JDBC_DRIVER_JAR_URI", + "JDBC_DRIVER_CLASS_NAME", + "JDBC_ENGINE", + "JDBC_ENGINE_VERSION", + "CONFIG_FILES", + "INSTANCE_ID", + "JDBC_CONNECTION_URL", + "JDBC_ENFORCE_SSL", + "CUSTOM_JDBC_CERT", + "SKIP_CUSTOM_JDBC_CERT_VALIDATION", + "CUSTOM_JDBC_CERT_STRING" + ] + }, + "ConnectionType":{ + "type":"string", + "enum":[ + "JDBC", + "SFTP" + ] + }, + "ConnectionsList":{ + "type":"structure", + "members":{ + "Connections":{ + "shape":"OrchestrationStringList", + "documentation":"

A list of connections used by the job.

" + } + }, + "documentation":"

Specifies the connections used by a job.

" + }, + "Crawl":{ + "type":"structure", + "members":{ + "State":{ + "shape":"CrawlState", + "documentation":"

The state of the crawler.

" + }, + "StartedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time on which the crawl started.

" + }, + "CompletedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time on which the crawl completed.

" + }, + "ErrorMessage":{ + "shape":"DescriptionString", + "documentation":"

The error message associated with the crawl.

" + }, + "LogGroup":{ + "shape":"LogGroup", + "documentation":"

The log group associated with the crawl.

" + }, + "LogStream":{ + "shape":"LogStream", + "documentation":"

The log stream associated with the crawl.

" + } + }, + "documentation":"

The details of a crawl in the workflow.

" + }, + "CrawlList":{ + "type":"list", + "member":{"shape":"Crawl"} + }, + "CrawlState":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "CANCELLED", + "FAILED" + ] + }, + "Crawler":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the crawler.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data.

" + }, + "Targets":{ + "shape":"CrawlerTargets", + "documentation":"

A collection of targets to crawl.

" + }, + "DatabaseName":{ + "shape":"DatabaseName", + "documentation":"

The name of the database in which the crawler's output is stored.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the crawler.

" + }, + "Classifiers":{ + "shape":"ClassifierNameList", + "documentation":"

A list of UTF-8 strings that specify the custom classifiers that are associated with the crawler.

" + }, + "SchemaChangePolicy":{ + "shape":"SchemaChangePolicy", + "documentation":"

The policy that specifies update and delete behaviors for the crawler.

" + }, + "State":{ + "shape":"CrawlerState", + "documentation":"

Indicates whether the crawler is running, or whether a run is pending.

" + }, + "TablePrefix":{ + "shape":"TablePrefix", + "documentation":"

The prefix added to the names of tables that are created.

" + }, + "Schedule":{ + "shape":"Schedule", + "documentation":"

For scheduled crawlers, the schedule when the crawler runs.

" + }, + "CrawlElapsedTime":{ + "shape":"MillisecondsCount", + "documentation":"

If the crawler is running, contains the total time elapsed since the last crawl began.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that the crawler was created.

" + }, + "LastUpdated":{ + "shape":"Timestamp", + "documentation":"

The time that the crawler was last updated.

" + }, + "LastCrawl":{ + "shape":"LastCrawlInfo", + "documentation":"

The status of the last crawl, and potentially error information if an error occurred.

" + }, + "Version":{ + "shape":"VersionId", + "documentation":"

The version of the crawler.

" + }, + "Configuration":{ + "shape":"CrawlerConfiguration", + "documentation":"

Crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

" + }, + "CrawlerSecurityConfiguration":{ + "shape":"CrawlerSecurityConfiguration", + "documentation":"

The name of the SecurityConfiguration structure to be used by this crawler.

" + } + }, + "documentation":"

Specifies a crawler program that examines a data source and uses classifiers to try to determine its schema. If successful, the crawler records metadata concerning the data source in the AWS Glue Data Catalog.

" + }, + "CrawlerConfiguration":{"type":"string"}, + "CrawlerList":{ + "type":"list", + "member":{"shape":"Crawler"} + }, + "CrawlerMetrics":{ + "type":"structure", + "members":{ + "CrawlerName":{ + "shape":"NameString", + "documentation":"

The name of the crawler.

" + }, + "TimeLeftSeconds":{ + "shape":"NonNegativeDouble", + "documentation":"

The estimated time left to complete a running crawl.

" + }, + "StillEstimating":{ + "shape":"Boolean", + "documentation":"

True if the crawler is still estimating how long it will take to complete this run.

" + }, + "LastRuntimeSeconds":{ + "shape":"NonNegativeDouble", + "documentation":"

The duration of the crawler's most recent run, in seconds.

" + }, + "MedianRuntimeSeconds":{ + "shape":"NonNegativeDouble", + "documentation":"

The median duration of this crawler's runs, in seconds.

" + }, + "TablesCreated":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of tables created by this crawler.

" + }, + "TablesUpdated":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of tables updated by this crawler.

" + }, + "TablesDeleted":{ + "shape":"NonNegativeInteger", + "documentation":"

The number of tables deleted by this crawler.

" + } + }, + "documentation":"

Metrics for a specified crawler.

" + }, + "CrawlerMetricsList":{ + "type":"list", + "member":{"shape":"CrawlerMetrics"} + }, + "CrawlerNameList":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":100, + "min":0 + }, + "CrawlerNodeDetails":{ + "type":"structure", + "members":{ + "Crawls":{ + "shape":"CrawlList", + "documentation":"

A list of crawls represented by the crawl node.

" + } + }, + "documentation":"

The details of a Crawler node present in the workflow.

" + }, + "CrawlerNotRunningException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The specified crawler is not running.

", + "exception":true + }, + "CrawlerRunningException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The operation cannot be performed because the crawler is already running.

", + "exception":true + }, + "CrawlerSecurityConfiguration":{ + "type":"string", + "max":128, + "min":0 + }, + "CrawlerState":{ + "type":"string", + "enum":[ + "READY", + "RUNNING", + "STOPPING" + ] + }, + "CrawlerStoppingException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The specified crawler is stopping.

", + "exception":true + }, + "CrawlerTargets":{ + "type":"structure", + "members":{ + "S3Targets":{ + "shape":"S3TargetList", + "documentation":"

Specifies Amazon Simple Storage Service (Amazon S3) targets.

" + }, + "JdbcTargets":{ + "shape":"JdbcTargetList", + "documentation":"

Specifies JDBC targets.

" + }, + "DynamoDBTargets":{ + "shape":"DynamoDBTargetList", + "documentation":"

Specifies Amazon DynamoDB targets.

" + }, + "CatalogTargets":{ + "shape":"CatalogTargetList", + "documentation":"

Specifies AWS Glue Data Catalog targets.

" + } + }, + "documentation":"

Specifies data stores to crawl.

" + }, + "CreateClassifierRequest":{ + "type":"structure", + "members":{ + "GrokClassifier":{ + "shape":"CreateGrokClassifierRequest", + "documentation":"

A GrokClassifier object specifying the classifier to create.

" + }, + "XMLClassifier":{ + "shape":"CreateXMLClassifierRequest", + "documentation":"

An XMLClassifier object specifying the classifier to create.

" + }, + "JsonClassifier":{ + "shape":"CreateJsonClassifierRequest", + "documentation":"

A JsonClassifier object specifying the classifier to create.

" + }, + "CsvClassifier":{ + "shape":"CreateCsvClassifierRequest", + "documentation":"

A CsvClassifier object specifying the classifier to create.

" + } + } + }, + "CreateClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateConnectionRequest":{ + "type":"structure", + "required":["ConnectionInput"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which to create the connection. If none is provided, the AWS account ID is used by default.

" + }, + "ConnectionInput":{ + "shape":"ConnectionInput", + "documentation":"

A ConnectionInput object defining the connection to create.

" + } + } + }, + "CreateConnectionResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateCrawlerRequest":{ + "type":"structure", + "required":[ + "Name", + "Role", + "Targets" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the new crawler.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM role or Amazon Resource Name (ARN) of an IAM role used by the new crawler to access customer resources.

" + }, + "DatabaseName":{ + "shape":"DatabaseName", + "documentation":"

The AWS Glue database where results are written, such as: arn:aws:daylight:us-east-1::database/sometable/*.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the new crawler.

" + }, + "Targets":{ + "shape":"CrawlerTargets", + "documentation":"

A list of collection of targets to crawl.

" + }, + "Schedule":{ + "shape":"CronExpression", + "documentation":"

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

" + }, + "Classifiers":{ + "shape":"ClassifierNameList", + "documentation":"

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

" + }, + "TablePrefix":{ + "shape":"TablePrefix", + "documentation":"

The table prefix used for catalog tables that are created.

" + }, + "SchemaChangePolicy":{ + "shape":"SchemaChangePolicy", + "documentation":"

The policy for the crawler's update and deletion behavior.

" + }, + "Configuration":{ + "shape":"CrawlerConfiguration", + "documentation":"

The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

" + }, + "CrawlerSecurityConfiguration":{ + "shape":"CrawlerSecurityConfiguration", + "documentation":"

The name of the SecurityConfiguration structure to be used by this crawler.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

The tags to use with this crawler request. You can use tags to limit access to the crawler. For more information, see AWS Tags in AWS Glue.

" + } + } + }, + "CreateCrawlerResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateCsvClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "Delimiter":{ + "shape":"CsvColumnDelimiter", + "documentation":"

A custom symbol to denote what separates each column entry in the row.

" + }, + "QuoteSymbol":{ + "shape":"CsvQuoteSymbol", + "documentation":"

A custom symbol to denote what combines content into a single column value. Must be different from the column delimiter.

" + }, + "ContainsHeader":{ + "shape":"CsvHeaderOption", + "documentation":"

Indicates whether the CSV file contains a header.

" + }, + "Header":{ + "shape":"CsvHeader", + "documentation":"

A list of strings representing column names.

" + }, + "DisableValueTrimming":{ + "shape":"NullableBoolean", + "documentation":"

Specifies not to trim values before identifying the type of column values. The default value is true.

" + }, + "AllowSingleColumn":{ + "shape":"NullableBoolean", + "documentation":"

Enables the processing of files that contain only one column.

" + } + }, + "documentation":"

Specifies a custom CSV classifier for CreateClassifier to create.

" + }, + "CreateDatabaseRequest":{ + "type":"structure", + "required":["DatabaseInput"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which to create the database. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseInput":{ + "shape":"DatabaseInput", + "documentation":"

The metadata for the database.

" + } + } + }, + "CreateDatabaseResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateDevEndpointRequest":{ + "type":"structure", + "required":[ + "EndpointName", + "RoleArn" + ], + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

The name to be assigned to the new DevEndpoint.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The IAM role for the DevEndpoint.

" + }, + "SecurityGroupIds":{ + "shape":"StringList", + "documentation":"

Security group IDs for the security groups to be used by the new DevEndpoint.

" + }, + "SubnetId":{ + "shape":"GenericString", + "documentation":"

The subnet ID for the new DevEndpoint to use.

" + }, + "PublicKey":{ + "shape":"GenericString", + "documentation":"

The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.

" + }, + "PublicKeys":{ + "shape":"PublicKeysList", + "documentation":"

A list of public keys to be used by the development endpoints for authentication. The use of this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

" + }, + "NumberOfNodes":{ + "shape":"IntegerValue", + "documentation":"

The number of AWS Glue Data Processing Units (DPUs) to allocate to this DevEndpoint.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated to the development endpoint.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "ExtraPythonLibsS3Path":{ + "shape":"GenericString", + "documentation":"

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not yet supported.

" + }, + "ExtraJarsS3Path":{ + "shape":"GenericString", + "documentation":"

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this DevEndpoint.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

The tags to use with this DevEndpoint. You may use tags to limit access to the DevEndpoint. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + }, + "Arguments":{ + "shape":"MapValue", + "documentation":"

A map of arguments used to configure the DevEndpoint.

" + } + } + }, + "CreateDevEndpointResponse":{ + "type":"structure", + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

The name assigned to the new DevEndpoint.

" + }, + "Status":{ + "shape":"GenericString", + "documentation":"

The current status of the new DevEndpoint.

" + }, + "SecurityGroupIds":{ + "shape":"StringList", + "documentation":"

The security groups assigned to the new DevEndpoint.

" + }, + "SubnetId":{ + "shape":"GenericString", + "documentation":"

The subnet ID assigned to the new DevEndpoint.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the role assigned to the new DevEndpoint.

" + }, + "YarnEndpointAddress":{ + "shape":"GenericString", + "documentation":"

The address of the YARN endpoint used by this DevEndpoint.

" + }, + "ZeppelinRemoteSparkInterpreterPort":{ + "shape":"IntegerValue", + "documentation":"

The Apache Zeppelin port for the remote Apache Spark interpreter.

" + }, + "NumberOfNodes":{ + "shape":"IntegerValue", + "documentation":"

The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated to the development endpoint. May be a value of Standard, G.1X, or G.2X.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated to the development endpoint.

" + }, + "AvailabilityZone":{ + "shape":"GenericString", + "documentation":"

The AWS Availability Zone where this DevEndpoint is located.

" + }, + "VpcId":{ + "shape":"GenericString", + "documentation":"

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" + }, + "ExtraPythonLibsS3Path":{ + "shape":"GenericString", + "documentation":"

The paths to one or more Python libraries in an S3 bucket that will be loaded in your DevEndpoint.

" + }, + "ExtraJarsS3Path":{ + "shape":"GenericString", + "documentation":"

Path to one or more Java .jar files in an S3 bucket that will be loaded in your DevEndpoint.

" + }, + "FailureReason":{ + "shape":"GenericString", + "documentation":"

The reason for a current failure in this DevEndpoint.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure being used with this DevEndpoint.

" + }, + "CreatedTimestamp":{ + "shape":"TimestampValue", + "documentation":"

The point in time at which this DevEndpoint was created.

" + }, + "Arguments":{ + "shape":"MapValue", + "documentation":"

The map of arguments used to configure this DevEndpoint.

Valid arguments are:

  • \"--enable-glue-datacatalog\": \"\"

  • \"GLUE_PYTHON_VERSION\": \"3\"

  • \"GLUE_PYTHON_VERSION\": \"2\"

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + } + } + }, + "CreateGrokClassifierRequest":{ + "type":"structure", + "required":[ + "Classification", + "Name", + "GrokPattern" + ], + "members":{ + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the new classifier.

" + }, + "GrokPattern":{ + "shape":"GrokPattern", + "documentation":"

The grok pattern used by this classifier.

" + }, + "CustomPatterns":{ + "shape":"CustomPatterns", + "documentation":"

Optional custom grok patterns used by this classifier.

" + } + }, + "documentation":"

Specifies a grok classifier for CreateClassifier to create.

" + }, + "CreateJobRequest":{ + "type":"structure", + "required":[ + "Name", + "Role", + "Command" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name you assign to this job definition. It must be unique in your account.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

Description of the job being defined.

" + }, + "LogUri":{ + "shape":"UriString", + "documentation":"

This field is reserved for future use.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

" + }, + "ExecutionProperty":{ + "shape":"ExecutionProperty", + "documentation":"

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

" + }, + "Command":{ + "shape":"JobCommand", + "documentation":"

The JobCommand that executes this job.

" + }, + "DefaultArguments":{ + "shape":"GenericMap", + "documentation":"

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "Connections":{ + "shape":"ConnectionsList", + "documentation":"

The connections used for this job.

" + }, + "MaxRetries":{ + "shape":"MaxRetries", + "documentation":"

The maximum number of times to retry this job if it fails.

" + }, + "AllocatedCapacity":{ + "shape":"IntegerValue", + "documentation":"

This parameter is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use MaxCapacity instead." + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this job.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies configuration properties of a job notification.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

" + } + } + }, + "CreateJobResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The unique name that was provided for this job definition.

" + } + } + }, + "CreateJsonClassifierRequest":{ + "type":"structure", + "required":[ + "Name", + "JsonPath" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "JsonPath":{ + "shape":"JsonPath", + "documentation":"

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + } + }, + "documentation":"

Specifies a JSON classifier for CreateClassifier to create.

" + }, + "CreateMLTransformRequest":{ + "type":"structure", + "required":[ + "Name", + "InputRecordTables", + "Parameters", + "Role" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The unique name that you give the transform when you create it.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the machine learning transform that is being defined. The default is an empty string.

" + }, + "InputRecordTables":{ + "shape":"GlueTables", + "documentation":"

A list of AWS Glue table definitions used by the transform.

" + }, + "Parameters":{ + "shape":"TransformParameters", + "documentation":"

The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Ensure that this role has permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries that are used by the task run for this transform.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when this task runs.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The timeout of the task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxRetries":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of times to retry a task for this transform after a task run fails.

" + } + } + }, + "CreateMLTransformResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

A unique identifier that is generated for the transform.

" + } + } + }, + "CreatePartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The AWS account ID of the catalog in which the partition is to be created.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the metadata database in which the partition is to be created.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the metadata table in which the partition is to be created.

" + }, + "PartitionInput":{ + "shape":"PartitionInput", + "documentation":"

A PartitionInput structure defining the partition to be created.

" + } + } + }, + "CreatePartitionResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateScriptRequest":{ + "type":"structure", + "members":{ + "DagNodes":{ + "shape":"DagNodes", + "documentation":"

A list of the nodes in the DAG.

" + }, + "DagEdges":{ + "shape":"DagEdges", + "documentation":"

A list of the edges in the DAG.

" + }, + "Language":{ + "shape":"Language", + "documentation":"

The programming language of the resulting code from the DAG.

" + } + } + }, + "CreateScriptResponse":{ + "type":"structure", + "members":{ + "PythonScript":{ + "shape":"PythonScript", + "documentation":"

The Python script generated from the DAG.

" + }, + "ScalaCode":{ + "shape":"ScalaCode", + "documentation":"

The Scala code generated from the DAG.

" + } + } + }, + "CreateSecurityConfigurationRequest":{ + "type":"structure", + "required":[ + "Name", + "EncryptionConfiguration" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name for the new security configuration.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration for the new security configuration.

" + } + } + }, + "CreateSecurityConfigurationResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name assigned to the new security configuration.

" + }, + "CreatedTimestamp":{ + "shape":"TimestampValue", + "documentation":"

The time at which the new security configuration was created.

" + } + } + }, + "CreateTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which to create the Table. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The catalog database in which to create the new table. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableInput":{ + "shape":"TableInput", + "documentation":"

The TableInput object that defines the metadata table to create in the catalog.

" + } + } + }, + "CreateTableResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateTriggerRequest":{ + "type":"structure", + "required":[ + "Name", + "Type", + "Actions" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger.

" + }, + "WorkflowName":{ + "shape":"NameString", + "documentation":"

The name of the workflow associated with the trigger.

" + }, + "Type":{ + "shape":"TriggerType", + "documentation":"

The type of the new trigger.

" + }, + "Schedule":{ + "shape":"GenericString", + "documentation":"

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

This field is required when the trigger type is SCHEDULED.

" + }, + "Predicate":{ + "shape":"Predicate", + "documentation":"

A predicate to specify when the new trigger should fire.

This field is required when the trigger type is CONDITIONAL.

" + }, + "Actions":{ + "shape":"ActionList", + "documentation":"

The actions initiated by this trigger when it fires.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the new trigger.

" + }, + "StartOnCreation":{ + "shape":"BooleanValue", + "documentation":"

Set to true to start SCHEDULED and CONDITIONAL triggers when created. True is not supported for ON_DEMAND triggers.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.

" + } + } + }, + "CreateTriggerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger.

" + } + } + }, + "CreateUserDefinedFunctionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "FunctionInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which to create the function. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which to create the function.

" + }, + "FunctionInput":{ + "shape":"UserDefinedFunctionInput", + "documentation":"

A FunctionInput object that defines the function to create in the Data Catalog.

" + } + } + }, + "CreateUserDefinedFunctionResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateWorkflowRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name to be assigned to the workflow. It should be unique within your account.

" + }, + "Description":{ + "shape":"GenericString", + "documentation":"

A description of the workflow.

" + }, + "DefaultRunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

A collection of properties to be used as part of each execution of the workflow.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

The tags to be used with this workflow.

" + } + } + }, + "CreateWorkflowResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the workflow which was provided as part of the request.

" + } + } + }, + "CreateXMLClassifierRequest":{ + "type":"structure", + "required":[ + "Classification", + "Name" + ], + "members":{ + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "RowTag":{ + "shape":"RowTag", + "documentation":"

The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a=\"A\" item_b=\"B\"></row> is okay, but <row item_a=\"A\" item_b=\"B\" /> is not).

" + } + }, + "documentation":"

Specifies an XML classifier for CreateClassifier to create.

" + }, + "CronExpression":{"type":"string"}, + "CsvClassifier":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was registered.

" + }, + "LastUpdated":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was last updated.

" + }, + "Version":{ + "shape":"VersionId", + "documentation":"

The version of this classifier.

" + }, + "Delimiter":{ + "shape":"CsvColumnDelimiter", + "documentation":"

A custom symbol to denote what separates each column entry in the row.

" + }, + "QuoteSymbol":{ + "shape":"CsvQuoteSymbol", + "documentation":"

A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

" + }, + "ContainsHeader":{ + "shape":"CsvHeaderOption", + "documentation":"

Indicates whether the CSV file contains a header.

" + }, + "Header":{ + "shape":"CsvHeader", + "documentation":"

A list of strings representing column names.

" + }, + "DisableValueTrimming":{ + "shape":"NullableBoolean", + "documentation":"

Specifies not to trim values before identifying the type of column values. The default value is true.

" + }, + "AllowSingleColumn":{ + "shape":"NullableBoolean", + "documentation":"

Enables the processing of files that contain only one column.

" + } + }, + "documentation":"

A classifier for custom CSV content.

" + }, + "CsvColumnDelimiter":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[^\\r\\n]" + }, + "CsvHeader":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "CsvHeaderOption":{ + "type":"string", + "enum":[ + "UNKNOWN", + "PRESENT", + "ABSENT" + ] + }, + "CsvQuoteSymbol":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[^\\r\\n]" + }, + "CustomPatterns":{ + "type":"string", + "max":16000, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "DagEdges":{ + "type":"list", + "member":{"shape":"CodeGenEdge"} + }, + "DagNodes":{ + "type":"list", + "member":{"shape":"CodeGenNode"} + }, + "DataCatalogEncryptionSettings":{ + "type":"structure", + "members":{ + "EncryptionAtRest":{ + "shape":"EncryptionAtRest", + "documentation":"

Specifies the encryption-at-rest configuration for the Data Catalog.

" + }, + "ConnectionPasswordEncryption":{ + "shape":"ConnectionPasswordEncryption", + "documentation":"

When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of CreateConnection or UpdateConnection and store it in the ENCRYPTED_PASSWORD field in the connection properties. You can enable catalog encryption or only password encryption.

" + } + }, + "documentation":"

Contains configuration information for maintaining Data Catalog security.

" + }, + "DataLakePrincipal":{ + "type":"structure", + "members":{ + "DataLakePrincipalIdentifier":{ + "shape":"DataLakePrincipalString", + "documentation":"

An identifier for the AWS Lake Formation principal.

" + } + }, + "documentation":"

The AWS Lake Formation principal.

" + }, + "DataLakePrincipalString":{ + "type":"string", + "max":255, + "min":1 + }, + "Database":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the database.

" + }, + "LocationUri":{ + "shape":"URI", + "documentation":"

The location of the database (for example, an HDFS path).

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define parameters and properties of the database.

" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the metadata database was created in the catalog.

" + }, + "CreateTableDefaultPermissions":{ + "shape":"PrincipalPermissionsList", + "documentation":"

Creates a set of default permissions on the table for principals.

" + } + }, + "documentation":"

The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.

" + }, + "DatabaseInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the database.

" + }, + "LocationUri":{ + "shape":"URI", + "documentation":"

The location of the database (for example, an HDFS path).

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define parameters and properties of the database.

These key-value pairs define parameters and properties of the database.

" + }, + "CreateTableDefaultPermissions":{ + "shape":"PrincipalPermissionsList", + "documentation":"

Creates a set of default permissions on the table for principals.

" + } + }, + "documentation":"

The structure used to create or update a database.

" + }, + "DatabaseList":{ + "type":"list", + "member":{"shape":"Database"} + }, + "DatabaseName":{"type":"string"}, + "DeleteBehavior":{ + "type":"string", + "enum":[ + "LOG", + "DELETE_FROM_DATABASE", + "DEPRECATE_IN_DATABASE" + ] + }, + "DeleteClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the classifier to remove.

" + } + } + }, + "DeleteClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteConnectionNameList":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":25, + "min":0 + }, + "DeleteConnectionRequest":{ + "type":"structure", + "required":["ConnectionName"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

" + }, + "ConnectionName":{ + "shape":"NameString", + "documentation":"

The name of the connection to delete.

" + } + } + }, + "DeleteConnectionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteCrawlerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the crawler to remove.

" + } + } + }, + "DeleteCrawlerResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDatabaseRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by default.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database to delete. For Hive compatibility, this must be all lowercase.

" + } + } + }, + "DeleteDatabaseResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDevEndpointRequest":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

The name of the DevEndpoint.

" + } + } + }, + "DeleteDevEndpointResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteJobRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition to delete.

" + } + } + }, + "DeleteJobResponse":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition that was deleted.

" + } + } + }, + "DeleteMLTransformRequest":{ + "type":"structure", + "required":["TransformId"], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the transform to delete.

" + } + } + }, + "DeleteMLTransformResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the transform that was deleted.

" + } + } + }, + "DeletePartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValues" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partition to be deleted resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the table in question resides.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table that contains the partition to be deleted.

" + }, + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

The values that define the partition.

" + } + } + }, + "DeletePartitionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "members":{ + "PolicyHashCondition":{ + "shape":"HashString", + "documentation":"

The hash value returned when this policy was set.

" + } + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSecurityConfigurationRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the security configuration to delete.

" + } + } + }, + "DeleteSecurityConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "Name" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the table to be deleted. For Hive compatibility, this name is entirely lowercase.

" + } + } + }, + "DeleteTableResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTableVersionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "VersionId" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table. For Hive compatibility, this name is entirely lowercase.

" + }, + "VersionId":{ + "shape":"VersionString", + "documentation":"

The ID of the table version to be deleted. A VersionID is a string representation of an integer. Each version is incremented by 1.

" + } + } + }, + "DeleteTableVersionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteTriggerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger to delete.

" + } + } + }, + "DeleteTriggerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger that was deleted.

" + } + } + }, + "DeleteUserDefinedFunctionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "FunctionName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the function to be deleted is located. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the function is located.

" + }, + "FunctionName":{ + "shape":"NameString", + "documentation":"

The name of the function definition to be deleted.

" + } + } + }, + "DeleteUserDefinedFunctionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkflowRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow to be deleted.

" + } + } + }, + "DeleteWorkflowResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow specified in input.

" + } + } + }, + "DescriptionString":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "DescriptionStringRemovable":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "DevEndpoint":{ + "type":"structure", + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

The name of the DevEndpoint.

" + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role used in this DevEndpoint.

" + }, + "SecurityGroupIds":{ + "shape":"StringList", + "documentation":"

A list of security group identifiers used in this DevEndpoint.

" + }, + "SubnetId":{ + "shape":"GenericString", + "documentation":"

The subnet ID for this DevEndpoint.

" + }, + "YarnEndpointAddress":{ + "shape":"GenericString", + "documentation":"

The YARN endpoint address used by this DevEndpoint.

" + }, + "PrivateAddress":{ + "shape":"GenericString", + "documentation":"

A private IP address to access the DevEndpoint within a VPC if the DevEndpoint is created within one. The PrivateAddress field is present only when you create the DevEndpoint within your VPC.

" + }, + "ZeppelinRemoteSparkInterpreterPort":{ + "shape":"IntegerValue", + "documentation":"

The Apache Zeppelin port for the remote Apache Spark interpreter.

" + }, + "PublicAddress":{ + "shape":"GenericString", + "documentation":"

The public IP address used by this DevEndpoint. The PublicAddress field is present only when you create a non-virtual private cloud (VPC) DevEndpoint.

" + }, + "Status":{ + "shape":"GenericString", + "documentation":"

The current status of this DevEndpoint.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated to the development endpoint. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Known issue: when a development endpoint is created with the G.2X WorkerType configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for running your ETL scripts on development endpoints.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Development endpoints that are created without specifying a Glue version default to Glue 0.9.

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated to the development endpoint.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "NumberOfNodes":{ + "shape":"IntegerValue", + "documentation":"

The number of AWS Glue Data Processing Units (DPUs) allocated to this DevEndpoint.

" + }, + "AvailabilityZone":{ + "shape":"GenericString", + "documentation":"

The AWS Availability Zone where this DevEndpoint is located.

" + }, + "VpcId":{ + "shape":"GenericString", + "documentation":"

The ID of the virtual private cloud (VPC) used by this DevEndpoint.

" + }, + "ExtraPythonLibsS3Path":{ + "shape":"GenericString", + "documentation":"

The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.

" + }, + "ExtraJarsS3Path":{ + "shape":"GenericString", + "documentation":"

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

You can only use pure Java/Scala libraries with a DevEndpoint.

" + }, + "FailureReason":{ + "shape":"GenericString", + "documentation":"

The reason for a current failure in this DevEndpoint.

" + }, + "LastUpdateStatus":{ + "shape":"GenericString", + "documentation":"

The status of the last update.

" + }, + "CreatedTimestamp":{ + "shape":"TimestampValue", + "documentation":"

The point in time at which this DevEndpoint was created.

" + }, + "LastModifiedTimestamp":{ + "shape":"TimestampValue", + "documentation":"

The point in time at which this DevEndpoint was last modified.

" + }, + "PublicKey":{ + "shape":"GenericString", + "documentation":"

The public key to be used by this DevEndpoint for authentication. This attribute is provided for backward compatibility because the recommended attribute to use is public keys.

" + }, + "PublicKeys":{ + "shape":"PublicKeysList", + "documentation":"

A list of public keys to be used by the DevEndpoints for authentication. Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client.

If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the UpdateDevEndpoint API operation with the public key content in the deletePublicKeys attribute, and the list of new keys in the addPublicKeys attribute.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this DevEndpoint.

" + }, + "Arguments":{ + "shape":"MapValue", + "documentation":"

A map of arguments used to configure the DevEndpoint.

Valid arguments are:

  • \"--enable-glue-datacatalog\": \"\"

  • \"GLUE_PYTHON_VERSION\": \"3\"

  • \"GLUE_PYTHON_VERSION\": \"2\"

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + } + }, + "documentation":"

A development endpoint where a developer can remotely debug extract, transform, and load (ETL) scripts.

" + }, + "DevEndpointCustomLibraries":{ + "type":"structure", + "members":{ + "ExtraPythonLibsS3Path":{ + "shape":"GenericString", + "documentation":"

The paths to one or more Python libraries in an Amazon Simple Storage Service (Amazon S3) bucket that should be loaded in your DevEndpoint. Multiple values must be complete paths separated by a comma.

You can only use pure Python libraries with a DevEndpoint. Libraries that rely on C extensions, such as the pandas Python data analysis library, are not currently supported.

" + }, + "ExtraJarsS3Path":{ + "shape":"GenericString", + "documentation":"

The path to one or more Java .jar files in an S3 bucket that should be loaded in your DevEndpoint.

You can only use pure Java/Scala libraries with a DevEndpoint.

" + } + }, + "documentation":"

Custom libraries to be loaded into a development endpoint.

" + }, + "DevEndpointList":{ + "type":"list", + "member":{"shape":"DevEndpoint"} + }, + "DevEndpointNameList":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "DevEndpointNames":{ + "type":"list", + "member":{"shape":"GenericString"}, + "max":25, + "min":1 + }, + "DynamoDBTarget":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"Path", + "documentation":"

The name of the DynamoDB table to crawl.

" + } + }, + "documentation":"

Specifies an Amazon DynamoDB table to crawl.

" + }, + "DynamoDBTargetList":{ + "type":"list", + "member":{"shape":"DynamoDBTarget"} + }, + "Edge":{ + "type":"structure", + "members":{ + "SourceId":{ + "shape":"NameString", + "documentation":"

The unique of the node within the workflow where the edge starts.

" + }, + "DestinationId":{ + "shape":"NameString", + "documentation":"

The unique of the node within the workflow where the edge ends.

" + } + }, + "documentation":"

An edge represents a directed connection between two AWS Glue components which are part of the workflow the edge belongs to.

" + }, + "EdgeList":{ + "type":"list", + "member":{"shape":"Edge"} + }, + "EncryptionAtRest":{ + "type":"structure", + "required":["CatalogEncryptionMode"], + "members":{ + "CatalogEncryptionMode":{ + "shape":"CatalogEncryptionMode", + "documentation":"

The encryption-at-rest mode for encrypting Data Catalog data.

" + }, + "SseAwsKmsKeyId":{ + "shape":"NameString", + "documentation":"

The ID of the AWS KMS key to use for encryption at rest.

" + } + }, + "documentation":"

Specifies the encryption-at-rest configuration for the Data Catalog.

" + }, + "EncryptionConfiguration":{ + "type":"structure", + "members":{ + "S3Encryption":{ + "shape":"S3EncryptionList", + "documentation":"

The encryption configuration for Amazon Simple Storage Service (Amazon S3) data.

" + }, + "CloudWatchEncryption":{ + "shape":"CloudWatchEncryption", + "documentation":"

The encryption configuration for Amazon CloudWatch.

" + }, + "JobBookmarksEncryption":{ + "shape":"JobBookmarksEncryption", + "documentation":"

The encryption configuration for job bookmarks.

" + } + }, + "documentation":"

Specifies an encryption configuration.

" + }, + "EntityNotFoundException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A specified entity does not exist

", + "exception":true + }, + "ErrorByName":{ + "type":"map", + "key":{"shape":"NameString"}, + "value":{"shape":"ErrorDetail"} + }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"NameString", + "documentation":"

The code associated with this error.

" + }, + "ErrorMessage":{ + "shape":"DescriptionString", + "documentation":"

A message describing the error.

" + } + }, + "documentation":"

Contains details about an error.

" + }, + "ErrorString":{"type":"string"}, + "EvaluationMetrics":{ + "type":"structure", + "required":["TransformType"], + "members":{ + "TransformType":{ + "shape":"TransformType", + "documentation":"

The type of machine learning transform.

" + }, + "FindMatchesMetrics":{ + "shape":"FindMatchesMetrics", + "documentation":"

The evaluation metrics for the find matches algorithm.

" + } + }, + "documentation":"

Evaluation metrics provide an estimate of the quality of your machine learning transform.

" + }, + "ExecutionProperty":{ + "type":"structure", + "members":{ + "MaxConcurrentRuns":{ + "shape":"MaxConcurrentRuns", + "documentation":"

The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

" + } + }, + "documentation":"

An execution property of a job.

" + }, + "ExecutionTime":{"type":"integer"}, + "ExistCondition":{ + "type":"string", + "enum":[ + "MUST_EXIST", + "NOT_EXIST", + "NONE" + ] + }, + "ExportLabelsTaskRunProperties":{ + "type":"structure", + "members":{ + "OutputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where you will export the labels.

" + } + }, + "documentation":"

Specifies configuration properties for an exporting labels task run.

" + }, + "FieldType":{"type":"string"}, + "FilterString":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "FindMatchesMetrics":{ + "type":"structure", + "members":{ + "AreaUnderPRCurve":{ + "shape":"GenericBoundedDouble", + "documentation":"

The area under the precision/recall curve (AUPRC) is a single number measuring the overall quality of the transform, that is independent of the choice made for precision vs. recall. Higher values indicate that you have a more attractive precision vs. recall tradeoff.

For more information, see Precision and recall in Wikipedia.

" + }, + "Precision":{ + "shape":"GenericBoundedDouble", + "documentation":"

The precision metric indicates when often your transform is correct when it predicts a match. Specifically, it measures how well the transform finds true positives from the total true positives possible.

For more information, see Precision and recall in Wikipedia.

" + }, + "Recall":{ + "shape":"GenericBoundedDouble", + "documentation":"

The recall metric indicates that for an actual match, how often your transform predicts the match. Specifically, it measures how well the transform finds true positives from the total records in the source data.

For more information, see Precision and recall in Wikipedia.

" + }, + "F1":{ + "shape":"GenericBoundedDouble", + "documentation":"

The maximum F1 metric indicates the transform's accuracy between 0 and 1, where 1 is the best accuracy.

For more information, see F1 score in Wikipedia.

" + }, + "ConfusionMatrix":{ + "shape":"ConfusionMatrix", + "documentation":"

The confusion matrix shows you what your transform is predicting accurately and what types of errors it is making.

For more information, see Confusion matrix in Wikipedia.

" + } + }, + "documentation":"

The evaluation metrics for the find matches algorithm. The quality of your machine learning transform is measured by getting your transform to predict some matches and comparing the results to known matches from the same dataset. The quality metrics are based on a subset of your data, so they are not precise.

" + }, + "FindMatchesParameters":{ + "type":"structure", + "members":{ + "PrimaryKeyColumnName":{ + "shape":"ColumnNameString", + "documentation":"

The name of a column that uniquely identifies rows in the source table. Used to help identify matching records.

" + }, + "PrecisionRecallTradeoff":{ + "shape":"GenericBoundedDouble", + "documentation":"

The value selected when tuning your transform for a balance between precision and recall. A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision.

The precision metric indicates how often your model is correct when it predicts a match.

The recall metric indicates that for an actual match, how often your model predicts the match.

" + }, + "AccuracyCostTradeoff":{ + "shape":"GenericBoundedDouble", + "documentation":"

The value that is selected when tuning your transform for a balance between accuracy and cost. A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate FindMatches transform, sometimes with unacceptable accuracy.

Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall.

Cost measures how many compute resources, and thus money, are consumed to run the transform.

" + }, + "EnforceProvidedLabels":{ + "shape":"NullableBoolean", + "documentation":"

The value to switch on or off to force the output to match the provided labels from users. If the value is True, the find matches transform forces the output to match the provided labels. The results override the normal conflation results. If the value is False, the find matches transform does not ensure all the labels provided are respected, and the results rely on the trained model.

Note that setting this value to true may increase the conflation execution time.

" + } + }, + "documentation":"

The parameters to configure the find matches transform.

" + }, + "FindMatchesTaskRunProperties":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"HashString", + "documentation":"

The job ID for the Find Matches task run.

" + }, + "JobName":{ + "shape":"NameString", + "documentation":"

The name assigned to the job for the Find Matches task run.

" + }, + "JobRunId":{ + "shape":"HashString", + "documentation":"

The job run ID for the Find Matches task run.

" + } + }, + "documentation":"

Specifies configuration properties for a Find Matches task run.

" + }, + "FormatString":{ + "type":"string", + "max":128, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "GenericBoundedDouble":{ + "type":"double", + "box":true, + "max":1.0, + "min":0.0 + }, + "GenericMap":{ + "type":"map", + "key":{"shape":"GenericString"}, + "value":{"shape":"GenericString"} + }, + "GenericString":{"type":"string"}, + "GetCatalogImportStatusRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the catalog to migrate. Currently, this should be the AWS account ID.

" + } + } + }, + "GetCatalogImportStatusResponse":{ + "type":"structure", + "members":{ + "ImportStatus":{ + "shape":"CatalogImportStatus", + "documentation":"

The status of the specified catalog migration.

" + } + } + }, + "GetClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the classifier to retrieve.

" + } + } + }, + "GetClassifierResponse":{ + "type":"structure", + "members":{ + "Classifier":{ + "shape":"Classifier", + "documentation":"

The requested classifier.

" + } + } + }, + "GetClassifiersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The size of the list to return (optional).

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

An optional continuation token.

" + } + } + }, + "GetClassifiersResponse":{ + "type":"structure", + "members":{ + "Classifiers":{ + "shape":"ClassifierList", + "documentation":"

The requested list of classifier objects.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token.

" + } + } + }, + "GetConnectionRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the connection definition to retrieve.

" + }, + "HidePassword":{ + "shape":"Boolean", + "documentation":"

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

" + } + } + }, + "GetConnectionResponse":{ + "type":"structure", + "members":{ + "Connection":{ + "shape":"Connection", + "documentation":"

The requested connection definition.

" + } + } + }, + "GetConnectionsFilter":{ + "type":"structure", + "members":{ + "MatchCriteria":{ + "shape":"MatchCriteria", + "documentation":"

A criteria string that must match the criteria recorded in the connection definition for that connection definition to be returned.

" + }, + "ConnectionType":{ + "shape":"ConnectionType", + "documentation":"

The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.

" + } + }, + "documentation":"

Filters the connection definitions that are returned by the GetConnections API operation.

" + }, + "GetConnectionsRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the connections reside. If none is provided, the AWS account ID is used by default.

" + }, + "Filter":{ + "shape":"GetConnectionsFilter", + "documentation":"

A filter that controls which connections are returned.

" + }, + "HidePassword":{ + "shape":"Boolean", + "documentation":"

Allows you to retrieve the connection metadata without returning the password. For instance, the AWS Glue console uses this flag to retrieve the connection, and does not display the password. Set this parameter when the caller might not have permission to use the AWS KMS key to decrypt the password, but it does have permission to access the rest of the connection properties.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of connections to return in one response.

" + } + } + }, + "GetConnectionsResponse":{ + "type":"structure", + "members":{ + "ConnectionList":{ + "shape":"ConnectionList", + "documentation":"

A list of requested connection definitions.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the list of connections returned does not include the last of the filtered connections.

" + } + } + }, + "GetCrawlerMetricsRequest":{ + "type":"structure", + "members":{ + "CrawlerNameList":{ + "shape":"CrawlerNameList", + "documentation":"

A list of the names of crawlers about which to retrieve metrics.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation call.

" + } + } + }, + "GetCrawlerMetricsResponse":{ + "type":"structure", + "members":{ + "CrawlerMetricsList":{ + "shape":"CrawlerMetricsList", + "documentation":"

A list of metrics for the specified crawler.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the returned list does not contain the last metric available.

" + } + } + }, + "GetCrawlerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the crawler to retrieve metadata for.

" + } + } + }, + "GetCrawlerResponse":{ + "type":"structure", + "members":{ + "Crawler":{ + "shape":"Crawler", + "documentation":"

The metadata for the specified crawler.

" + } + } + }, + "GetCrawlersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The number of crawlers to return on each call.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation request.

" + } + } + }, + "GetCrawlersResponse":{ + "type":"structure", + "members":{ + "Crawlers":{ + "shape":"CrawlerList", + "documentation":"

A list of crawler metadata.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the returned list has not reached the end of those defined in this customer account.

" + } + } + }, + "GetDataCatalogEncryptionSettingsRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog to retrieve the security configuration for. If none is provided, the AWS account ID is used by default.

" + } + } + }, + "GetDataCatalogEncryptionSettingsResponse":{ + "type":"structure", + "members":{ + "DataCatalogEncryptionSettings":{ + "shape":"DataCatalogEncryptionSettings", + "documentation":"

The requested security configuration.

" + } + } + }, + "GetDatabaseRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the database resides. If none is provided, the AWS account ID is used by default.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database to retrieve. For Hive compatibility, this should be all lowercase.

" + } + } + }, + "GetDatabaseResponse":{ + "type":"structure", + "members":{ + "Database":{ + "shape":"Database", + "documentation":"

The definition of the specified database in the Data Catalog.

" + } + } + }, + "GetDatabasesRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog from which to retrieve Databases. If none is provided, the AWS account ID is used by default.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of databases to return in one response.

" + } + } + }, + "GetDatabasesResponse":{ + "type":"structure", + "required":["DatabaseList"], + "members":{ + "DatabaseList":{ + "shape":"DatabaseList", + "documentation":"

A list of Database objects from the specified catalog.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token for paginating the returned list of tokens, returned if the current segment of the list is not the last.

" + } + } + }, + "GetDataflowGraphRequest":{ + "type":"structure", + "members":{ + "PythonScript":{ + "shape":"PythonScript", + "documentation":"

The Python script to transform.

" + } + } + }, + "GetDataflowGraphResponse":{ + "type":"structure", + "members":{ + "DagNodes":{ + "shape":"DagNodes", + "documentation":"

A list of the nodes in the resulting DAG.

" + }, + "DagEdges":{ + "shape":"DagEdges", + "documentation":"

A list of the edges in the resulting DAG.

" + } + } + }, + "GetDevEndpointRequest":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

Name of the DevEndpoint to retrieve information for.

" + } + } + }, + "GetDevEndpointResponse":{ + "type":"structure", + "members":{ + "DevEndpoint":{ + "shape":"DevEndpoint", + "documentation":"

A DevEndpoint definition.

" + } + } + }, + "GetDevEndpointsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of information to return.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation call.

" + } + } + }, + "GetDevEndpointsResponse":{ + "type":"structure", + "members":{ + "DevEndpoints":{ + "shape":"DevEndpointList", + "documentation":"

A list of DevEndpoint definitions.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all DevEndpoint definitions have yet been returned.

" + } + } + }, + "GetJobBookmarkRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

The name of the job in question.

" + }, + "RunId":{ + "shape":"RunId", + "documentation":"

The unique run identifier associated with this job run.

" + } + } + }, + "GetJobBookmarkResponse":{ + "type":"structure", + "members":{ + "JobBookmarkEntry":{ + "shape":"JobBookmarkEntry", + "documentation":"

A structure that defines a point that a job can resume processing.

" + } + } + }, + "GetJobRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition to retrieve.

" + } + } + }, + "GetJobResponse":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"Job", + "documentation":"

The requested job definition.

" + } + } + }, + "GetJobRunRequest":{ + "type":"structure", + "required":[ + "JobName", + "RunId" + ], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

Name of the job definition being run.

" + }, + "RunId":{ + "shape":"IdString", + "documentation":"

The ID of the job run.

" + }, + "PredecessorsIncluded":{ + "shape":"BooleanValue", + "documentation":"

True if a list of predecessor runs should be returned.

" + } + } + }, + "GetJobRunResponse":{ + "type":"structure", + "members":{ + "JobRun":{ + "shape":"JobRun", + "documentation":"

The requested job-run metadata.

" + } + } + }, + "GetJobRunsRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition for which to retrieve all job runs.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of the response.

" + } + } + }, + "GetJobRunsResponse":{ + "type":"structure", + "members":{ + "JobRuns":{ + "shape":"JobRunList", + "documentation":"

A list of job-run metadata objects.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all requested job runs have been returned.

" + } + } + }, + "GetJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of the response.

" + } + } + }, + "GetJobsResponse":{ + "type":"structure", + "members":{ + "Jobs":{ + "shape":"JobList", + "documentation":"

A list of job definitions.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all job definitions have yet been returned.

" + } + } + }, + "GetMLTaskRunRequest":{ + "type":"structure", + "required":[ + "TransformId", + "TaskRunId" + ], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the task run.

" + } + } + }, + "GetMLTaskRunResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the task run.

" + }, + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique run identifier associated with this run.

" + }, + "Status":{ + "shape":"TaskStatusType", + "documentation":"

The status for this task run.

" + }, + "LogGroupName":{ + "shape":"GenericString", + "documentation":"

The names of the log groups that are associated with the task run.

" + }, + "Properties":{ + "shape":"TaskRunProperties", + "documentation":"

The list of properties that are associated with the task run.

" + }, + "ErrorString":{ + "shape":"GenericString", + "documentation":"

The error strings that are associated with the task run.

" + }, + "StartedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time when this task run started.

" + }, + "LastModifiedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time when this task run was last modified.

" + }, + "CompletedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time when this task run was completed.

" + }, + "ExecutionTime":{ + "shape":"ExecutionTime", + "documentation":"

The amount of time (in seconds) that the task run consumed resources.

" + } + } + }, + "GetMLTaskRunsRequest":{ + "type":"structure", + "required":["TransformId"], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

A token for pagination of the results. The default is empty.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return.

" + }, + "Filter":{ + "shape":"TaskRunFilterCriteria", + "documentation":"

The filter criteria, in the TaskRunFilterCriteria structure, for the task run.

" + }, + "Sort":{ + "shape":"TaskRunSortCriteria", + "documentation":"

The sorting criteria, in the TaskRunSortCriteria structure, for the task run.

" + } + } + }, + "GetMLTaskRunsResponse":{ + "type":"structure", + "members":{ + "TaskRuns":{ + "shape":"TaskRunList", + "documentation":"

A list of task runs that are associated with the transform.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

A pagination token, if more results are available.

" + } + } + }, + "GetMLTransformRequest":{ + "type":"structure", + "required":["TransformId"], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the transform, generated at the time that the transform was created.

" + } + } + }, + "GetMLTransformResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the transform, generated at the time that the transform was created.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The unique name given to the transform when it was created.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the transform.

" + }, + "Status":{ + "shape":"TransformStatusType", + "documentation":"

The last known status of the transform (to indicate whether it can be used or not). One of \"NOT_READY\", \"READY\", or \"DELETING\".

" + }, + "CreatedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time when the transform was created.

" + }, + "LastModifiedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time when the transform was last modified.

" + }, + "InputRecordTables":{ + "shape":"GlueTables", + "documentation":"

A list of AWS Glue table definitions used by the transform.

" + }, + "Parameters":{ + "shape":"TransformParameters", + "documentation":"

The configuration parameters that are specific to the algorithm used.

" + }, + "EvaluationMetrics":{ + "shape":"EvaluationMetrics", + "documentation":"

The latest evaluation metrics.

" + }, + "LabelCount":{ + "shape":"LabelCount", + "documentation":"

The number of labels available for this transform.

" + }, + "Schema":{ + "shape":"TransformSchema", + "documentation":"

The Map<Column, Type> object that represents the schema that this transform accepts. Has an upper bound of 100 columns.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when this task runs.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxRetries":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of times to retry a task for this transform after a task run fails.

" + } + } + }, + "GetMLTransformsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

A paginated token to offset the results.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return.

" + }, + "Filter":{ + "shape":"TransformFilterCriteria", + "documentation":"

The filter transformation criteria.

" + }, + "Sort":{ + "shape":"TransformSortCriteria", + "documentation":"

The sorting criteria.

" + } + } + }, + "GetMLTransformsResponse":{ + "type":"structure", + "required":["Transforms"], + "members":{ + "Transforms":{ + "shape":"TransformList", + "documentation":"

A list of machine learning transforms.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

A pagination token, if more results are available.

" + } + } + }, + "GetMappingRequest":{ + "type":"structure", + "required":["Source"], + "members":{ + "Source":{ + "shape":"CatalogEntry", + "documentation":"

Specifies the source table.

" + }, + "Sinks":{ + "shape":"CatalogEntries", + "documentation":"

A list of target tables.

" + }, + "Location":{ + "shape":"Location", + "documentation":"

Parameters for the mapping.

" + } + } + }, + "GetMappingResponse":{ + "type":"structure", + "required":["Mapping"], + "members":{ + "Mapping":{ + "shape":"MappingList", + "documentation":"

A list of mappings to the specified targets.

" + } + } + }, + "GetPartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValues" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partition in question resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partition resides.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partition's table.

" + }, + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

The values that define the partition.

" + } + } + }, + "GetPartitionResponse":{ + "type":"structure", + "members":{ + "Partition":{ + "shape":"Partition", + "documentation":"

The requested information, in the form of a Partition object.

" + } + } + }, + "GetPartitionsRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "Expression":{ + "shape":"PredicateString", + "documentation":"

An expression that filters the partitions to be returned.

The expression uses SQL syntax similar to the SQL WHERE filter clause. The SQL statement parser JSQLParser parses the expression.

Operators: The following are the operators that you can use in the Expression API call:

=

Checks whether the values of the two operands are equal; if yes, then the condition becomes true.

Example: Assume 'variable a' holds 10 and 'variable b' holds 20.

(a = b) is not true.

< >

Checks whether the values of two operands are equal; if the values are not equal, then the condition becomes true.

Example: (a < > b) is true.

>

Checks whether the value of the left operand is greater than the value of the right operand; if yes, then the condition becomes true.

Example: (a > b) is not true.

<

Checks whether the value of the left operand is less than the value of the right operand; if yes, then the condition becomes true.

Example: (a < b) is true.

>=

Checks whether the value of the left operand is greater than or equal to the value of the right operand; if yes, then the condition becomes true.

Example: (a >= b) is not true.

<=

Checks whether the value of the left operand is less than or equal to the value of the right operand; if yes, then the condition becomes true.

Example: (a <= b) is true.

AND, OR, IN, BETWEEN, LIKE, NOT, IS NULL

Logical operators.

Supported Partition Key Types: The following are the supported partition keys.

  • string

  • date

  • timestamp

  • int

  • bigint

  • long

  • tinyint

  • smallint

  • decimal

If an invalid type is encountered, an exception is thrown.

The following list shows the valid operators on each type. When you define a crawler, the partitionKey type is created as a STRING, to be compatible with the catalog partitions.

Sample API Call:

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve these partitions.

" + }, + "Segment":{ + "shape":"Segment", + "documentation":"

The segment of the table's partitions to scan in this request.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of partitions to return in a single response.

" + } + } + }, + "GetPartitionsResponse":{ + "type":"structure", + "members":{ + "Partitions":{ + "shape":"PartitionList", + "documentation":"

A list of requested partitions.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the returned list of partitions does not include the last one.

" + } + } + }, + "GetPlanRequest":{ + "type":"structure", + "required":[ + "Mapping", + "Source" + ], + "members":{ + "Mapping":{ + "shape":"MappingList", + "documentation":"

The list of mappings from a source table to target tables.

" + }, + "Source":{ + "shape":"CatalogEntry", + "documentation":"

The source table.

" + }, + "Sinks":{ + "shape":"CatalogEntries", + "documentation":"

The target tables.

" + }, + "Location":{ + "shape":"Location", + "documentation":"

The parameters for the mapping.

" + }, + "Language":{ + "shape":"Language", + "documentation":"

The programming language of the code to perform the mapping.

" + } + } + }, + "GetPlanResponse":{ + "type":"structure", + "members":{ + "PythonScript":{ + "shape":"PythonScript", + "documentation":"

A Python script to perform the mapping.

" + }, + "ScalaCode":{ + "shape":"ScalaCode", + "documentation":"

The Scala code to perform the mapping.

" + } + } + }, + "GetResourcePolicyRequest":{ + "type":"structure", + "members":{ + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "PolicyInJson":{ + "shape":"PolicyJsonString", + "documentation":"

Contains the requested policy document, in JSON format.

" + }, + "PolicyHash":{ + "shape":"HashString", + "documentation":"

Contains the hash value associated with this policy.

" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"

The date and time at which the policy was created.

" + }, + "UpdateTime":{ + "shape":"Timestamp", + "documentation":"

The date and time at which the policy was last updated.

" + } + } + }, + "GetSecurityConfigurationRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the security configuration to retrieve.

" + } + } + }, + "GetSecurityConfigurationResponse":{ + "type":"structure", + "members":{ + "SecurityConfiguration":{ + "shape":"SecurityConfiguration", + "documentation":"

The requested security configuration.

" + } + } + }, + "GetSecurityConfigurationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation call.

" + } + } + }, + "GetSecurityConfigurationsResponse":{ + "type":"structure", + "members":{ + "SecurityConfigurations":{ + "shape":"SecurityConfigurationList", + "documentation":"

A list of security configurations.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if there are more security configurations to return.

" + } + } + }, + "GetTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "Name" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the table for which to retrieve the definition. For Hive compatibility, this name is entirely lowercase.

" + } + } + }, + "GetTableResponse":{ + "type":"structure", + "members":{ + "Table":{ + "shape":"Table", + "documentation":"

The Table object that defines the specified table.

" + } + } + }, + "GetTableVersionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table. For Hive compatibility, this name is entirely lowercase.

" + }, + "VersionId":{ + "shape":"VersionString", + "documentation":"

The ID value of the table version to be retrieved. A VersionID is a string representation of an integer. Each version is incremented by 1.

" + } + } + }, + "GetTableVersionResponse":{ + "type":"structure", + "members":{ + "TableVersion":{ + "shape":"TableVersion", + "documentation":"

The requested table version.

" + } + } + }, + "GetTableVersionsList":{ + "type":"list", + "member":{"shape":"TableVersion"} + }, + "GetTableVersionsRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in the catalog in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table. For Hive compatibility, this name is entirely lowercase.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of table versions to return in one response.

" + } + } + }, + "GetTableVersionsResponse":{ + "type":"structure", + "members":{ + "TableVersions":{ + "shape":"GetTableVersionsList", + "documentation":"

A list of strings identifying available versions of the specified table.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the list of available versions does not include the last one.

" + } + } + }, + "GetTablesRequest":{ + "type":"structure", + "required":["DatabaseName"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the tables reside. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The database in the catalog whose tables to list. For Hive compatibility, this name is entirely lowercase.

" + }, + "Expression":{ + "shape":"FilterString", + "documentation":"

A regular expression pattern. If present, only those tables whose names match the pattern are returned.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, included if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of tables to return in a single response.

" + } + } + }, + "GetTablesResponse":{ + "type":"structure", + "members":{ + "TableList":{ + "shape":"TableList", + "documentation":"

A list of the requested Table objects.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, present if the current list segment is not the last.

" + } + } + }, + "GetTagsRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource for which to retrieve tags.

" + } + } + }, + "GetTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagsMap", + "documentation":"

The requested tags.

" + } + } + }, + "GetTriggerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger to retrieve.

" + } + } + }, + "GetTriggerResponse":{ + "type":"structure", + "members":{ + "Trigger":{ + "shape":"Trigger", + "documentation":"

The requested trigger definition.

" + } + } + }, + "GetTriggersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "DependentJobName":{ + "shape":"NameString", + "documentation":"

The name of the job to retrieve triggers for. The trigger that can start this job is returned, and if there is no such trigger, all triggers are returned.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of the response.

" + } + } + }, + "GetTriggersResponse":{ + "type":"structure", + "members":{ + "Triggers":{ + "shape":"TriggerList", + "documentation":"

A list of triggers for the specified job.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all the requested triggers have yet been returned.

" + } + } + }, + "GetUserDefinedFunctionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "FunctionName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the function to be retrieved is located. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the function is located.

" + }, + "FunctionName":{ + "shape":"NameString", + "documentation":"

The name of the function.

" + } + } + }, + "GetUserDefinedFunctionResponse":{ + "type":"structure", + "members":{ + "UserDefinedFunction":{ + "shape":"UserDefinedFunction", + "documentation":"

The requested function definition.

" + } + } + }, + "GetUserDefinedFunctionsRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "Pattern" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the functions to be retrieved are located. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the functions are located.

" + }, + "Pattern":{ + "shape":"NameString", + "documentation":"

An optional function-name pattern string that filters the function definitions returned.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation call.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of functions to return in one response.

" + } + } + }, + "GetUserDefinedFunctionsResponse":{ + "type":"structure", + "members":{ + "UserDefinedFunctions":{ + "shape":"UserDefinedFunctionList", + "documentation":"

A list of requested function definitions.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the list of functions returned does not include the last requested function.

" + } + } + }, + "GetWorkflowRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the workflow to retrieve.

" + }, + "IncludeGraph":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether to include a graph when returning the workflow resource metadata.

" + } + } + }, + "GetWorkflowResponse":{ + "type":"structure", + "members":{ + "Workflow":{ + "shape":"Workflow", + "documentation":"

The resource metadata for the workflow.

" + } + } + }, + "GetWorkflowRunPropertiesRequest":{ + "type":"structure", + "required":[ + "Name", + "RunId" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow which was run.

" + }, + "RunId":{ + "shape":"IdString", + "documentation":"

The ID of the workflow run whose run properties should be returned.

" + } + } + }, + "GetWorkflowRunPropertiesResponse":{ + "type":"structure", + "members":{ + "RunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

The workflow run properties which were set during the specified run.

" + } + } + }, + "GetWorkflowRunRequest":{ + "type":"structure", + "required":[ + "Name", + "RunId" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow being run.

" + }, + "RunId":{ + "shape":"IdString", + "documentation":"

The ID of the workflow run.

" + }, + "IncludeGraph":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether to include the workflow graph in response or not.

" + } + } + }, + "GetWorkflowRunResponse":{ + "type":"structure", + "members":{ + "Run":{ + "shape":"WorkflowRun", + "documentation":"

The requested workflow run metadata.

" + } + } + }, + "GetWorkflowRunsRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow whose metadata of runs should be returned.

" + }, + "IncludeGraph":{ + "shape":"NullableBoolean", + "documentation":"

Specifies whether to include the workflow graph in response or not.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

The maximum size of the response.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of workflow runs to be included in the response.

" + } + } + }, + "GetWorkflowRunsResponse":{ + "type":"structure", + "members":{ + "Runs":{ + "shape":"WorkflowRuns", + "documentation":"

A list of workflow run metadata objects.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all requested workflow runs have been returned.

" + } + } + }, + "GlueEncryptionException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

An encryption operation failed.

", + "exception":true + }, + "GlueResourceArn":{ + "type":"string", + "max":10240, + "min":1, + "pattern":"arn:aws:glue:.*" + }, + "GlueTable":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName" + ], + "members":{ + "DatabaseName":{ + "shape":"NameString", + "documentation":"

A database name in the AWS Glue Data Catalog.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

A table name in the AWS Glue Data Catalog.

" + }, + "CatalogId":{ + "shape":"NameString", + "documentation":"

A unique identifier for the AWS Glue Data Catalog.

" + }, + "ConnectionName":{ + "shape":"NameString", + "documentation":"

The name of the connection to the AWS Glue Data Catalog.

" + } + }, + "documentation":"

The database and table in the AWS Glue Data Catalog that is used for input or output data.

" + }, + "GlueTables":{ + "type":"list", + "member":{"shape":"GlueTable"}, + "max":10, + "min":0 + }, + "GlueVersionString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^\\w+\\.\\w+$" + }, + "GrokClassifier":{ + "type":"structure", + "required":[ + "Name", + "Classification", + "GrokPattern" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was registered.

" + }, + "LastUpdated":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was last updated.

" + }, + "Version":{ + "shape":"VersionId", + "documentation":"

The version of this classifier.

" + }, + "GrokPattern":{ + "shape":"GrokPattern", + "documentation":"

The grok pattern applied to a data store by this classifier. For more information, see built-in patterns in Writing Custom Classifiers.

" + }, + "CustomPatterns":{ + "shape":"CustomPatterns", + "documentation":"

Optional custom grok patterns defined by this classifier. For more information, see custom patterns in Writing Custom Classifiers.

" + } + }, + "documentation":"

A classifier that uses grok patterns.

" + }, + "GrokPattern":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\t]*" + }, + "HashString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "IdString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The same unique identifier was associated with two different records.

", + "exception":true + }, + "ImportCatalogToGlueRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the catalog to import. Currently, this should be the AWS account ID.

" + } + } + }, + "ImportCatalogToGlueResponse":{ + "type":"structure", + "members":{ + } + }, + "ImportLabelsTaskRunProperties":{ + "type":"structure", + "members":{ + "InputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) path from where you will import the labels.

" + }, + "Replace":{ + "shape":"ReplaceBoolean", + "documentation":"

Indicates whether to overwrite your existing labels.

" + } + }, + "documentation":"

Specifies configuration properties for an importing labels task run.

" + }, + "Integer":{"type":"integer"}, + "IntegerFlag":{ + "type":"integer", + "max":1, + "min":0 + }, + "IntegerValue":{"type":"integer"}, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

An internal service error occurred.

", + "exception":true, + "fault":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The input provided was not valid.

", + "exception":true + }, + "JdbcTarget":{ + "type":"structure", + "members":{ + "ConnectionName":{ + "shape":"ConnectionName", + "documentation":"

The name of the connection to use to connect to the JDBC target.

" + }, + "Path":{ + "shape":"Path", + "documentation":"

The path of the JDBC target.

" + }, + "Exclusions":{ + "shape":"PathList", + "documentation":"

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

" + } + }, + "documentation":"

Specifies a JDBC data store to crawl.

" + }, + "JdbcTargetList":{ + "type":"list", + "member":{"shape":"JdbcTarget"} + }, + "Job":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name you assign to this job definition.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the job.

" + }, + "LogUri":{ + "shape":"UriString", + "documentation":"

This field is reserved for future use.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

" + }, + "CreatedOn":{ + "shape":"TimestampValue", + "documentation":"

The time and date that this job definition was created.

" + }, + "LastModifiedOn":{ + "shape":"TimestampValue", + "documentation":"

The last point in time when this job definition was modified.

" + }, + "ExecutionProperty":{ + "shape":"ExecutionProperty", + "documentation":"

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

" + }, + "Command":{ + "shape":"JobCommand", + "documentation":"

The JobCommand that executes this job.

" + }, + "DefaultArguments":{ + "shape":"GenericMap", + "documentation":"

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "Connections":{ + "shape":"ConnectionsList", + "documentation":"

The connections used for this job.

" + }, + "MaxRetries":{ + "shape":"MaxRetries", + "documentation":"

The maximum number of times to retry this job after a JobRun fails.

" + }, + "AllocatedCapacity":{ + "shape":"IntegerValue", + "documentation":"

This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) allocated to runs of this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use MaxCapacity instead." + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this job.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies configuration properties of a job notification.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + } + }, + "documentation":"

Specifies a job definition.

" + }, + "JobBookmarkEntry":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

The name of the job in question.

" + }, + "Version":{ + "shape":"IntegerValue", + "documentation":"

The version of the job.

" + }, + "Run":{ + "shape":"IntegerValue", + "documentation":"

The run ID number.

" + }, + "Attempt":{ + "shape":"IntegerValue", + "documentation":"

The attempt ID number.

" + }, + "PreviousRunId":{ + "shape":"RunId", + "documentation":"

The unique run identifier associated with the previous job run.

" + }, + "RunId":{ + "shape":"RunId", + "documentation":"

The run ID number.

" + }, + "JobBookmark":{ + "shape":"JsonValue", + "documentation":"

The bookmark itself.

" + } + }, + "documentation":"

Defines a point that a job can resume processing.

" + }, + "JobBookmarksEncryption":{ + "type":"structure", + "members":{ + "JobBookmarksEncryptionMode":{ + "shape":"JobBookmarksEncryptionMode", + "documentation":"

The encryption mode to use for job bookmarks data.

" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" + } + }, + "documentation":"

Specifies how job bookmark data should be encrypted.

" + }, + "JobBookmarksEncryptionMode":{ + "type":"string", + "enum":[ + "DISABLED", + "CSE-KMS" + ] + }, + "JobCommand":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"GenericString", + "documentation":"

The name of the job command. For an Apache Spark ETL job, this must be glueetl. For a Python shell job, it must be pythonshell.

" + }, + "ScriptLocation":{ + "shape":"ScriptLocationString", + "documentation":"

Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job.

" + }, + "PythonVersion":{ + "shape":"PythonVersionString", + "documentation":"

The Python version being used to execute a Python shell job. Allowed values are 2 or 3.

" + } + }, + "documentation":"

Specifies code executed when a job is run.

" + }, + "JobList":{ + "type":"list", + "member":{"shape":"Job"} + }, + "JobName":{"type":"string"}, + "JobNameList":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "JobNodeDetails":{ + "type":"structure", + "members":{ + "JobRuns":{ + "shape":"JobRunList", + "documentation":"

The information for the job runs represented by the job node.

" + } + }, + "documentation":"

The details of a Job node present in the workflow.

" + }, + "JobRun":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdString", + "documentation":"

The ID of this job run.

" + }, + "Attempt":{ + "shape":"AttemptCount", + "documentation":"

The number of the attempt to run this job.

" + }, + "PreviousRunId":{ + "shape":"IdString", + "documentation":"

The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.

" + }, + "TriggerName":{ + "shape":"NameString", + "documentation":"

The name of the trigger that started this job run.

" + }, + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition being used in this run.

" + }, + "StartedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time at which this job run was started.

" + }, + "LastModifiedOn":{ + "shape":"TimestampValue", + "documentation":"

The last time that this job run was modified.

" + }, + "CompletedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time that this job run completed.

" + }, + "JobRunState":{ + "shape":"JobRunState", + "documentation":"

The current state of the job run.

" + }, + "Arguments":{ + "shape":"GenericMap", + "documentation":"

The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "ErrorMessage":{ + "shape":"ErrorString", + "documentation":"

An error message associated with this job run.

" + }, + "PredecessorRuns":{ + "shape":"PredecessorList", + "documentation":"

A list of predecessors to this job run.

" + }, + "AllocatedCapacity":{ + "shape":"IntegerValue", + "documentation":"

This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use MaxCapacity instead." + }, + "ExecutionTime":{ + "shape":"ExecutionTime", + "documentation":"

The amount of time (in seconds) that the job run consumed resources.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this job run.

" + }, + "LogGroupName":{ + "shape":"GenericString", + "documentation":"

The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using AWS KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies configuration properties of a job run notification.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

" + } + }, + "documentation":"

Contains information about a job run.

" + }, + "JobRunList":{ + "type":"list", + "member":{"shape":"JobRun"} + }, + "JobRunState":{ + "type":"string", + "enum":[ + "STARTING", + "RUNNING", + "STOPPING", + "STOPPED", + "SUCCEEDED", + "FAILED", + "TIMEOUT" + ] + }, + "JobUpdate":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"DescriptionString", + "documentation":"

Description of the job being defined.

" + }, + "LogUri":{ + "shape":"UriString", + "documentation":"

This field is reserved for future use.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role associated with this job (required).

" + }, + "ExecutionProperty":{ + "shape":"ExecutionProperty", + "documentation":"

An ExecutionProperty specifying the maximum number of concurrent runs allowed for this job.

" + }, + "Command":{ + "shape":"JobCommand", + "documentation":"

The JobCommand that executes this job (required).

" + }, + "DefaultArguments":{ + "shape":"GenericMap", + "documentation":"

The default arguments for this job.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "Connections":{ + "shape":"ConnectionsList", + "documentation":"

The connections used for this job.

" + }, + "MaxRetries":{ + "shape":"MaxRetries", + "documentation":"

The maximum number of times to retry this job if it fails.

" + }, + "AllocatedCapacity":{ + "shape":"IntegerValue", + "documentation":"

This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this job. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use MaxCapacity instead." + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this job.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies the configuration properties of a job notification.

" + }, + "GlueVersion":{ + "shape":"GlueVersionString", + "documentation":"

Glue version determines the versions of Apache Spark and Python that AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

" + } + }, + "documentation":"

Specifies information used to update an existing job definition. The previous job definition is completely overwritten by this information.

" + }, + "JsonClassifier":{ + "type":"structure", + "required":[ + "Name", + "JsonPath" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was registered.

" + }, + "LastUpdated":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was last updated.

" + }, + "Version":{ + "shape":"VersionId", + "documentation":"

The version of this classifier.

" + }, + "JsonPath":{ + "shape":"JsonPath", + "documentation":"

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + } + }, + "documentation":"

A classifier for JSON content.

" + }, + "JsonPath":{"type":"string"}, + "JsonValue":{"type":"string"}, + "KeyString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "KmsKeyArn":{ + "type":"string", + "pattern":"arn:aws:kms:.*" + }, + "LabelCount":{"type":"integer"}, + "LabelingSetGenerationTaskRunProperties":{ + "type":"structure", + "members":{ + "OutputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where you will generate the labeling set.

" + } + }, + "documentation":"

Specifies configuration properties for a labeling set generation task run.

" + }, + "Language":{ + "type":"string", + "enum":[ + "PYTHON", + "SCALA" + ] + }, + "LastCrawlInfo":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"LastCrawlStatus", + "documentation":"

Status of the last crawl.

" + }, + "ErrorMessage":{ + "shape":"DescriptionString", + "documentation":"

If an error occurred, the error information about the last crawl.

" + }, + "LogGroup":{ + "shape":"LogGroup", + "documentation":"

The log group for the last crawl.

" + }, + "LogStream":{ + "shape":"LogStream", + "documentation":"

The log stream for the last crawl.

" + }, + "MessagePrefix":{ + "shape":"MessagePrefix", + "documentation":"

The prefix for a message about this crawl.

" + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the crawl started.

" + } + }, + "documentation":"

Status and error information about the most recent crawl.

" + }, + "LastCrawlStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "CANCELLED", + "FAILED" + ] + }, + "ListCrawlersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

Specifies to return only these tagged resources.

" + } + } + }, + "ListCrawlersResponse":{ + "type":"structure", + "members":{ + "CrawlerNames":{ + "shape":"CrawlerNameList", + "documentation":"

The names of all crawlers in the account, or the crawlers with the specified tags.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the returned list does not contain the last metric available.

" + } + } + }, + "ListDevEndpointsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

Specifies to return only these tagged resources.

" + } + } + }, + "ListDevEndpointsResponse":{ + "type":"structure", + "members":{ + "DevEndpointNames":{ + "shape":"DevEndpointNameList", + "documentation":"

The names of all the DevEndpoints in the account, or the DevEndpoints with the specified tags.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if the returned list does not contain the last metric available.

" + } + } + }, + "ListJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

Specifies to return only these tagged resources.

" + } + } + }, + "ListJobsResponse":{ + "type":"structure", + "members":{ + "JobNames":{ + "shape":"JobNameList", + "documentation":"

The names of all jobs in the account, or the jobs with the specified tags.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if the returned list does not contain the last metric available.

" + } + } + }, + "ListTriggersRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "DependentJobName":{ + "shape":"NameString", + "documentation":"

The name of the job for which to retrieve triggers. The trigger that can start this job is returned. If there is no such trigger, all triggers are returned.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + }, + "Tags":{ + "shape":"TagsMap", + "documentation":"

Specifies to return only these tagged resources.

" + } + } + }, + "ListTriggersResponse":{ + "type":"structure", + "members":{ + "TriggerNames":{ + "shape":"TriggerNameList", + "documentation":"

The names of all triggers in the account, or the triggers with the specified tags.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if the returned list does not contain the last metric available.

" + } + } + }, + "ListWorkflowsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + } + } + }, + "ListWorkflowsResponse":{ + "type":"structure", + "members":{ + "Workflows":{ + "shape":"WorkflowNames", + "documentation":"

List of names of workflows in the account.

" + }, + "NextToken":{ + "shape":"GenericString", + "documentation":"

A continuation token, if not all workflow names have been returned.

" + } + } + }, + "Location":{ + "type":"structure", + "members":{ + "Jdbc":{ + "shape":"CodeGenNodeArgs", + "documentation":"

A JDBC location.

" + }, + "S3":{ + "shape":"CodeGenNodeArgs", + "documentation":"

An Amazon Simple Storage Service (Amazon S3) location.

" + }, + "DynamoDB":{ + "shape":"CodeGenNodeArgs", + "documentation":"

An Amazon DynamoDB table location.

" + } + }, + "documentation":"

The location of resources.

" + }, + "LocationMap":{ + "type":"map", + "key":{"shape":"ColumnValuesString"}, + "value":{"shape":"ColumnValuesString"} + }, + "LocationString":{ + "type":"string", + "max":2056, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "LogGroup":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "LogStream":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "Logical":{ + "type":"string", + "enum":[ + "AND", + "ANY" + ] + }, + "LogicalOperator":{ + "type":"string", + "enum":["EQUALS"] + }, + "MLTransform":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique transform ID that is generated for the machine learning transform. The ID is guaranteed to be unique and does not change.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

A user-defined name for the machine learning transform. Names are not guaranteed unique and can be changed at any time.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A user-defined, long-form description text for the machine learning transform. Descriptions are not guaranteed to be unique and can be changed at any time.

" + }, + "Status":{ + "shape":"TransformStatusType", + "documentation":"

The current status of the machine learning transform.

" + }, + "CreatedOn":{ + "shape":"Timestamp", + "documentation":"

A timestamp. The time and date that this machine learning transform was created.

" + }, + "LastModifiedOn":{ + "shape":"Timestamp", + "documentation":"

A timestamp. The last point in time when this machine learning transform was modified.

" + }, + "InputRecordTables":{ + "shape":"GlueTables", + "documentation":"

A list of AWS Glue table definitions used by the transform.

" + }, + "Parameters":{ + "shape":"TransformParameters", + "documentation":"

A TransformParameters object. You can use parameters to tune (customize) the behavior of the machine learning transform by specifying what data it learns from and your preference on various tradeoffs (such as precious vs. recall, or accuracy vs. cost).

" + }, + "EvaluationMetrics":{ + "shape":"EvaluationMetrics", + "documentation":"

An EvaluationMetrics object. Evaluation metrics provide an estimate of the quality of your machine learning transform.

" + }, + "LabelCount":{ + "shape":"LabelCount", + "documentation":"

A count identifier for the labeling files generated by AWS Glue for this transform. As you create a better transform, you can iteratively download, label, and upload the labeling file.

" + }, + "Schema":{ + "shape":"TransformSchema", + "documentation":"

A map of key-value pairs representing the columns and data types that this transform can run against. Has an upper bound of 100 columns.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a task of this transform runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a task of the transform runs.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The timeout in minutes of the machine learning transform.

" + }, + "MaxRetries":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of times to retry after an MLTaskRun of the machine learning transform fails.

" + } + }, + "documentation":"

A structure for a machine learning transform.

" + }, + "MLTransformNotReadyException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The machine learning transform is not ready to run.

", + "exception":true + }, + "MapValue":{ + "type":"map", + "key":{"shape":"GenericString"}, + "value":{"shape":"GenericString"}, + "max":100, + "min":0 + }, + "MappingEntry":{ + "type":"structure", + "members":{ + "SourceTable":{ + "shape":"TableName", + "documentation":"

The name of the source table.

" + }, + "SourcePath":{ + "shape":"SchemaPathString", + "documentation":"

The source path.

" + }, + "SourceType":{ + "shape":"FieldType", + "documentation":"

The source type.

" + }, + "TargetTable":{ + "shape":"TableName", + "documentation":"

The target table.

" + }, + "TargetPath":{ + "shape":"SchemaPathString", + "documentation":"

The target path.

" + }, + "TargetType":{ + "shape":"FieldType", + "documentation":"

The target type.

" + } + }, + "documentation":"

Defines a mapping.

" + }, + "MappingList":{ + "type":"list", + "member":{"shape":"MappingEntry"} + }, + "MatchCriteria":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":10, + "min":0 + }, + "MaxConcurrentRuns":{"type":"integer"}, + "MaxRetries":{"type":"integer"}, + "MessagePrefix":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "MessageString":{"type":"string"}, + "MillisecondsCount":{"type":"long"}, + "NameString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "NameStringList":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "NoScheduleException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

There is no applicable schedule.

", + "exception":true + }, + "Node":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"NodeType", + "documentation":"

The type of AWS Glue component represented by the node.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the AWS Glue component represented by the node.

" + }, + "UniqueId":{ + "shape":"NameString", + "documentation":"

The unique Id assigned to the node within the workflow.

" + }, + "TriggerDetails":{ + "shape":"TriggerNodeDetails", + "documentation":"

Details of the Trigger when the node represents a Trigger.

" + }, + "JobDetails":{ + "shape":"JobNodeDetails", + "documentation":"

Details of the Job when the node represents a Job.

" + }, + "CrawlerDetails":{ + "shape":"CrawlerNodeDetails", + "documentation":"

Details of the crawler when the node represents a crawler.

" + } + }, + "documentation":"

A node represents an AWS Glue component like Trigger, Job etc. which is part of a workflow.

" + }, + "NodeList":{ + "type":"list", + "member":{"shape":"Node"} + }, + "NodeType":{ + "type":"string", + "enum":[ + "CRAWLER", + "JOB", + "TRIGGER" + ] + }, + "NonNegativeDouble":{ + "type":"double", + "min":0.0 + }, + "NonNegativeInteger":{ + "type":"integer", + "min":0 + }, + "NotificationProperty":{ + "type":"structure", + "members":{ + "NotifyDelayAfter":{ + "shape":"NotifyDelayAfter", + "documentation":"

After a job run starts, the number of minutes to wait before sending a job run delay notification.

" + } + }, + "documentation":"

Specifies configuration properties of a notification.

" + }, + "NotifyDelayAfter":{ + "type":"integer", + "box":true, + "min":1 + }, + "NullableBoolean":{ + "type":"boolean", + "box":true + }, + "NullableDouble":{ + "type":"double", + "box":true + }, + "NullableInteger":{ + "type":"integer", + "box":true + }, + "OperationTimeoutException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The operation timed out.

", + "exception":true + }, + "OrchestrationStringList":{ + "type":"list", + "member":{"shape":"GenericString"} + }, + "Order":{ + "type":"structure", + "required":[ + "Column", + "SortOrder" + ], + "members":{ + "Column":{ + "shape":"NameString", + "documentation":"

The name of the column.

" + }, + "SortOrder":{ + "shape":"IntegerFlag", + "documentation":"

Indicates that the column is sorted in ascending order (== 1), or in descending order (==0).

" + } + }, + "documentation":"

Specifies the sort order of a sorted column.

" + }, + "OrderList":{ + "type":"list", + "member":{"shape":"Order"} + }, + "PageSize":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "PaginationToken":{"type":"string"}, + "ParametersMap":{ + "type":"map", + "key":{"shape":"KeyString"}, + "value":{"shape":"ParametersMapValue"} + }, + "ParametersMapValue":{ + "type":"string", + "max":512000 + }, + "Partition":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ValueStringList", + "documentation":"

The values of the partition.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which to create the partition.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the database table in which to create the partition.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the partition was created.

" + }, + "LastAccessTime":{ + "shape":"Timestamp", + "documentation":"

The last time at which the partition was accessed.

" + }, + "StorageDescriptor":{ + "shape":"StorageDescriptor", + "documentation":"

Provides information about the physical location where the partition is stored.

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define partition parameters.

" + }, + "LastAnalyzedTime":{ + "shape":"Timestamp", + "documentation":"

The last time at which column statistics were computed for this partition.

" + } + }, + "documentation":"

Represents a slice of table data.

" + }, + "PartitionError":{ + "type":"structure", + "members":{ + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

The values that define the partition.

" + }, + "ErrorDetail":{ + "shape":"ErrorDetail", + "documentation":"

The details about the partition error.

" + } + }, + "documentation":"

Contains information about a partition error.

" + }, + "PartitionErrors":{ + "type":"list", + "member":{"shape":"PartitionError"} + }, + "PartitionInput":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ValueStringList", + "documentation":"

The values of the partition. Although this parameter is not required by the SDK, you must specify this parameter for a valid input.

The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys.

" + }, + "LastAccessTime":{ + "shape":"Timestamp", + "documentation":"

The last time at which the partition was accessed.

" + }, + "StorageDescriptor":{ + "shape":"StorageDescriptor", + "documentation":"

Provides information about the physical location where the partition is stored.

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define partition parameters.

" + }, + "LastAnalyzedTime":{ + "shape":"Timestamp", + "documentation":"

The last time at which column statistics were computed for this partition.

" + } + }, + "documentation":"

The structure used to create and update a partition.

" + }, + "PartitionInputList":{ + "type":"list", + "member":{"shape":"PartitionInput"}, + "max":100, + "min":0 + }, + "PartitionList":{ + "type":"list", + "member":{"shape":"Partition"} + }, + "PartitionValueList":{ + "type":"structure", + "required":["Values"], + "members":{ + "Values":{ + "shape":"ValueStringList", + "documentation":"

The list of values.

" + } + }, + "documentation":"

Contains a list of values defining partitions.

" + }, + "Path":{"type":"string"}, + "PathList":{ + "type":"list", + "member":{"shape":"Path"} + }, + "Permission":{ + "type":"string", + "enum":[ + "ALL", + "SELECT", + "ALTER", + "DROP", + "DELETE", + "INSERT", + "CREATE_DATABASE", + "CREATE_TABLE", + "DATA_LOCATION_ACCESS" + ] + }, + "PermissionList":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "PhysicalConnectionRequirements":{ + "type":"structure", + "members":{ + "SubnetId":{ + "shape":"NameString", + "documentation":"

The subnet ID used by the connection.

" + }, + "SecurityGroupIdList":{ + "shape":"SecurityGroupIdList", + "documentation":"

The security group ID list used by the connection.

" + }, + "AvailabilityZone":{ + "shape":"NameString", + "documentation":"

The connection's Availability Zone. This field is redundant because the specified subnet implies the Availability Zone to be used. Currently the field must be populated, but it will be deprecated in the future.

" + } + }, + "documentation":"

Specifies the physical requirements for a connection.

" + }, + "PolicyJsonString":{ + "type":"string", + "max":10240, + "min":2 + }, + "Predecessor":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition used by the predecessor job run.

" + }, + "RunId":{ + "shape":"IdString", + "documentation":"

The job-run ID of the predecessor job run.

" + } + }, + "documentation":"

A job run that was used in the predicate of a conditional trigger that triggered this job run.

" + }, + "PredecessorList":{ + "type":"list", + "member":{"shape":"Predecessor"} + }, + "Predicate":{ + "type":"structure", + "members":{ + "Logical":{ + "shape":"Logical", + "documentation":"

An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

" + }, + "Conditions":{ + "shape":"ConditionList", + "documentation":"

A list of the conditions that determine when the trigger will fire.

" + } + }, + "documentation":"

Defines the predicate of the trigger, which determines when it fires.

" + }, + "PredicateString":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "PrincipalPermissions":{ + "type":"structure", + "members":{ + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The principal who is granted permissions.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions that are granted to the principal.

" + } + }, + "documentation":"

Permissions granted to a principal.

" + }, + "PrincipalPermissionsList":{ + "type":"list", + "member":{"shape":"PrincipalPermissions"} + }, + "PrincipalType":{ + "type":"string", + "enum":[ + "USER", + "ROLE", + "GROUP" + ] + }, + "PropertyPredicate":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ValueString", + "documentation":"

The key of the property.

" + }, + "Value":{ + "shape":"ValueString", + "documentation":"

The value of the property.

" + }, + "Comparator":{ + "shape":"Comparator", + "documentation":"

The comparator used to compare this property to others.

" + } + }, + "documentation":"

Defines a property predicate.

" + }, + "PublicKeysList":{ + "type":"list", + "member":{"shape":"GenericString"}, + "max":5 + }, + "PutDataCatalogEncryptionSettingsRequest":{ + "type":"structure", + "required":["DataCatalogEncryptionSettings"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default.

" + }, + "DataCatalogEncryptionSettings":{ + "shape":"DataCatalogEncryptionSettings", + "documentation":"

The security configuration to set.

" + } + } + }, + "PutDataCatalogEncryptionSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":["PolicyInJson"], + "members":{ + "PolicyInJson":{ + "shape":"PolicyJsonString", + "documentation":"

Contains the policy document to set, in JSON format.

" + }, + "PolicyHashCondition":{ + "shape":"HashString", + "documentation":"

The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.

" + }, + "PolicyExistsCondition":{ + "shape":"ExistCondition", + "documentation":"

A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call will not depend on the existence of a policy.

" + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "PolicyHash":{ + "shape":"HashString", + "documentation":"

A hash of the policy that has just been set. This must be included in a subsequent call that overwrites or updates this policy.

" + } + } + }, + "PutWorkflowRunPropertiesRequest":{ + "type":"structure", + "required":[ + "Name", + "RunId", + "RunProperties" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow which was run.

" + }, + "RunId":{ + "shape":"IdString", + "documentation":"

The ID of the workflow run for which the run properties should be updated.

" + }, + "RunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

The properties to put for the specified run.

" + } + } + }, + "PutWorkflowRunPropertiesResponse":{ + "type":"structure", + "members":{ + } + }, + "PythonScript":{"type":"string"}, + "PythonVersionString":{ + "type":"string", + "pattern":"^[2-3]$" + }, + "RecordsCount":{ + "type":"long", + "box":true + }, + "ReplaceBoolean":{"type":"boolean"}, + "ResetJobBookmarkRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"JobName", + "documentation":"

The name of the job in question.

" + }, + "RunId":{ + "shape":"RunId", + "documentation":"

The unique run identifier associated with this job run.

" + } + } + }, + "ResetJobBookmarkResponse":{ + "type":"structure", + "members":{ + "JobBookmarkEntry":{ + "shape":"JobBookmarkEntry", + "documentation":"

The reset bookmark entry.

" + } + } + }, + "ResourceNumberLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A resource numerical limit was exceeded.

", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "JAR", + "FILE", + "ARCHIVE" + ] + }, + "ResourceUri":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The type of the resource.

" + }, + "Uri":{ + "shape":"URI", + "documentation":"

The URI for accessing the resource.

" + } + }, + "documentation":"

The URIs for function resources.

" + }, + "ResourceUriList":{ + "type":"list", + "member":{"shape":"ResourceUri"}, + "max":1000, + "min":0 + }, + "Role":{"type":"string"}, + "RoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::\\d{12}:role/.*" + }, + "RoleString":{"type":"string"}, + "RowTag":{"type":"string"}, + "RunId":{"type":"string"}, + "S3Encryption":{ + "type":"structure", + "members":{ + "S3EncryptionMode":{ + "shape":"S3EncryptionMode", + "documentation":"

The encryption mode to use for Amazon S3 data.

" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data.

" + } + }, + "documentation":"

Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.

" + }, + "S3EncryptionList":{ + "type":"list", + "member":{"shape":"S3Encryption"} + }, + "S3EncryptionMode":{ + "type":"string", + "enum":[ + "DISABLED", + "SSE-KMS", + "SSE-S3" + ] + }, + "S3Target":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"Path", + "documentation":"

The path to the Amazon S3 target.

" + }, + "Exclusions":{ + "shape":"PathList", + "documentation":"

A list of glob patterns used to exclude from the crawl. For more information, see Catalog Tables with a Crawler.

" + } + }, + "documentation":"

Specifies a data store in Amazon Simple Storage Service (Amazon S3).

" + }, + "S3TargetList":{ + "type":"list", + "member":{"shape":"S3Target"} + }, + "ScalaCode":{"type":"string"}, + "Schedule":{ + "type":"structure", + "members":{ + "ScheduleExpression":{ + "shape":"CronExpression", + "documentation":"

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

" + }, + "State":{ + "shape":"ScheduleState", + "documentation":"

The state of the schedule.

" + } + }, + "documentation":"

A scheduling object using a cron statement to schedule an event.

" + }, + "ScheduleState":{ + "type":"string", + "enum":[ + "SCHEDULED", + "NOT_SCHEDULED", + "TRANSITIONING" + ] + }, + "SchedulerNotRunningException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The specified scheduler is not running.

", + "exception":true + }, + "SchedulerRunningException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The specified scheduler is already running.

", + "exception":true + }, + "SchedulerTransitioningException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The specified scheduler is transitioning.

", + "exception":true + }, + "SchemaChangePolicy":{ + "type":"structure", + "members":{ + "UpdateBehavior":{ + "shape":"UpdateBehavior", + "documentation":"

The update behavior when the crawler finds a changed schema.

" + }, + "DeleteBehavior":{ + "shape":"DeleteBehavior", + "documentation":"

The deletion behavior when the crawler finds a deleted object.

" + } + }, + "documentation":"

A policy that specifies update and deletion behaviors for the crawler.

" + }, + "SchemaColumn":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ColumnNameString", + "documentation":"

The name of the column.

" + }, + "DataType":{ + "shape":"ColumnTypeString", + "documentation":"

The type of data in the column.

" + } + }, + "documentation":"

A key-value pair representing a column and data type that this transform can run against. The Schema parameter of the MLTransform may contain up to 100 of these structures.

" + }, + "SchemaPathString":{"type":"string"}, + "ScriptLocationString":{"type":"string"}, + "SearchPropertyPredicates":{ + "type":"list", + "member":{"shape":"PropertyPredicate"} + }, + "SearchTablesRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

A unique identifier, consisting of account_id/datalake.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, included if this is a continuation call.

" + }, + "Filters":{ + "shape":"SearchPropertyPredicates", + "documentation":"

A list of key-value pairs, and a comparator used to filter the search results. Returns all entities matching the predicate.

" + }, + "SearchText":{ + "shape":"ValueString", + "documentation":"

A string used for a text search.

Specifying a value in quotes filters based on an exact match to the value.

" + }, + "SortCriteria":{ + "shape":"SortCriteria", + "documentation":"

A list of criteria for sorting the results by a field name, in an ascending or descending order.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of tables to return in a single response.

" + } + } + }, + "SearchTablesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, present if the current list segment is not the last.

" + }, + "TableList":{ + "shape":"TableList", + "documentation":"

A list of the requested Table objects. The SearchTables response returns only the tables that you have access to.

" + } + } + }, + "SecurityConfiguration":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the security configuration.

" + }, + "CreatedTimeStamp":{ + "shape":"TimestampValue", + "documentation":"

The time at which this security configuration was created.

" + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

The encryption configuration associated with this security configuration.

" + } + }, + "documentation":"

Specifies a security configuration.

" + }, + "SecurityConfigurationList":{ + "type":"list", + "member":{"shape":"SecurityConfiguration"} + }, + "SecurityGroupIdList":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":50, + "min":0 + }, + "Segment":{ + "type":"structure", + "required":[ + "SegmentNumber", + "TotalSegments" + ], + "members":{ + "SegmentNumber":{ + "shape":"NonNegativeInteger", + "documentation":"

The zero-based index number of the segment. For example, if the total number of segments is 4, SegmentNumber values range from 0 through 3.

" + }, + "TotalSegments":{ + "shape":"TotalSegmentsInteger", + "documentation":"

The total number of segments.

" + } + }, + "documentation":"

Defines a non-overlapping region of a table's partitions, allowing multiple requests to be executed in parallel.

" + }, + "SerDeInfo":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the SerDe.

" + }, + "SerializationLibrary":{ + "shape":"NameString", + "documentation":"

Usually the class that implements the SerDe. An example is org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe.

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define initialization parameters for the SerDe.

" + } + }, + "documentation":"

Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.

" + }, + "SkewedInfo":{ + "type":"structure", + "members":{ + "SkewedColumnNames":{ + "shape":"NameStringList", + "documentation":"

A list of names of columns that contain skewed values.

" + }, + "SkewedColumnValues":{ + "shape":"ColumnValueStringList", + "documentation":"

A list of values that appear so frequently as to be considered skewed.

" + }, + "SkewedColumnValueLocationMaps":{ + "shape":"LocationMap", + "documentation":"

A mapping of skewed values to the columns that contain them.

" + } + }, + "documentation":"

Specifies skewed values in a table. Skewed values are those that occur with very high frequency.

" + }, + "Sort":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "SortCriteria":{ + "type":"list", + "member":{"shape":"SortCriterion"}, + "max":1, + "min":0 + }, + "SortCriterion":{ + "type":"structure", + "members":{ + "FieldName":{ + "shape":"ValueString", + "documentation":"

The name of the field on which to sort.

" + }, + "Sort":{ + "shape":"Sort", + "documentation":"

An ascending or descending sort.

" + } + }, + "documentation":"

Specifies a field to sort by and a sort order.

" + }, + "SortDirectionType":{ + "type":"string", + "enum":[ + "DESCENDING", + "ASCENDING" + ] + }, + "StartCrawlerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the crawler to start.

" + } + } + }, + "StartCrawlerResponse":{ + "type":"structure", + "members":{ + } + }, + "StartCrawlerScheduleRequest":{ + "type":"structure", + "required":["CrawlerName"], + "members":{ + "CrawlerName":{ + "shape":"NameString", + "documentation":"

Name of the crawler to schedule.

" + } + } + }, + "StartCrawlerScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "StartExportLabelsTaskRunRequest":{ + "type":"structure", + "required":[ + "TransformId", + "OutputS3Path" + ], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "OutputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon S3 path where you export the labels.

" + } + } + }, + "StartExportLabelsTaskRunResponse":{ + "type":"structure", + "members":{ + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier for the task run.

" + } + } + }, + "StartImportLabelsTaskRunRequest":{ + "type":"structure", + "required":[ + "TransformId", + "InputS3Path" + ], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "InputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) path from where you import the labels.

" + }, + "ReplaceAllLabels":{ + "shape":"ReplaceBoolean", + "documentation":"

Indicates whether to overwrite your existing labels.

" + } + } + }, + "StartImportLabelsTaskRunResponse":{ + "type":"structure", + "members":{ + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier for the task run.

" + } + } + }, + "StartJobRunRequest":{ + "type":"structure", + "required":["JobName"], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition to use.

" + }, + "JobRunId":{ + "shape":"IdString", + "documentation":"

The ID of a previous JobRun to retry.

" + }, + "Arguments":{ + "shape":"GenericMap", + "documentation":"

The job arguments specifically for this run. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling AWS Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that AWS Glue consumes to set up your job, see the Special Parameters Used by AWS Glue topic in the developer guide.

" + }, + "AllocatedCapacity":{ + "shape":"IntegerValue", + "documentation":"

This field is deprecated. Use MaxCapacity instead.

The number of AWS Glue data processing units (DPUs) to allocate to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

", + "deprecated":true, + "deprecatedMessage":"This property is deprecated, use MaxCapacity instead." + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job, or an Apache Spark ETL job:

  • When you specify a Python shell job (JobCommand.Name=\"pythonshell\"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.

  • When you specify an Apache Spark ETL job (JobCommand.Name=\"glueetl\"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

" + }, + "SecurityConfiguration":{ + "shape":"NameString", + "documentation":"

The name of the SecurityConfiguration structure to be used with this job run.

" + }, + "NotificationProperty":{ + "shape":"NotificationProperty", + "documentation":"

Specifies configuration properties of a job run notification.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

" + } + } + }, + "StartJobRunResponse":{ + "type":"structure", + "members":{ + "JobRunId":{ + "shape":"IdString", + "documentation":"

The ID assigned to this job run.

" + } + } + }, + "StartMLEvaluationTaskRunRequest":{ + "type":"structure", + "required":["TransformId"], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + } + } + }, + "StartMLEvaluationTaskRunResponse":{ + "type":"structure", + "members":{ + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier associated with this run.

" + } + } + }, + "StartMLLabelingSetGenerationTaskRunRequest":{ + "type":"structure", + "required":[ + "TransformId", + "OutputS3Path" + ], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier of the machine learning transform.

" + }, + "OutputS3Path":{ + "shape":"UriString", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) path where you generate the labeling set.

" + } + } + }, + "StartMLLabelingSetGenerationTaskRunResponse":{ + "type":"structure", + "members":{ + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique run identifier that is associated with this task run.

" + } + } + }, + "StartTriggerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger to start.

" + } + } + }, + "StartTriggerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger that was started.

" + } + } + }, + "StartWorkflowRunRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the workflow to start.

" + } + } + }, + "StartWorkflowRunResponse":{ + "type":"structure", + "members":{ + "RunId":{ + "shape":"IdString", + "documentation":"

An Id for the new run.

" + } + } + }, + "StopCrawlerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the crawler to stop.

" + } + } + }, + "StopCrawlerResponse":{ + "type":"structure", + "members":{ + } + }, + "StopCrawlerScheduleRequest":{ + "type":"structure", + "required":["CrawlerName"], + "members":{ + "CrawlerName":{ + "shape":"NameString", + "documentation":"

Name of the crawler whose schedule state to set.

" + } + } + }, + "StopCrawlerScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "StopTriggerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger to stop.

" + } + } + }, + "StopTriggerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger that was stopped.

" + } + } + }, + "StorageDescriptor":{ + "type":"structure", + "members":{ + "Columns":{ + "shape":"ColumnList", + "documentation":"

A list of the Columns in the table.

" + }, + "Location":{ + "shape":"LocationString", + "documentation":"

The physical location of the table. By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name.

" + }, + "InputFormat":{ + "shape":"FormatString", + "documentation":"

The input format: SequenceFileInputFormat (binary), or TextInputFormat, or a custom format.

" + }, + "OutputFormat":{ + "shape":"FormatString", + "documentation":"

The output format: SequenceFileOutputFormat (binary), or IgnoreKeyTextOutputFormat, or a custom format.

" + }, + "Compressed":{ + "shape":"Boolean", + "documentation":"

True if the data in the table is compressed, or False if not.

" + }, + "NumberOfBuckets":{ + "shape":"Integer", + "documentation":"

Must be specified if the table contains any dimension columns.

" + }, + "SerdeInfo":{ + "shape":"SerDeInfo", + "documentation":"

The serialization/deserialization (SerDe) information.

" + }, + "BucketColumns":{ + "shape":"NameStringList", + "documentation":"

A list of reducer grouping columns, clustering columns, and bucketing columns in the table.

" + }, + "SortColumns":{ + "shape":"OrderList", + "documentation":"

A list specifying the sort order of each bucket in the table.

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

The user-supplied properties in key-value form.

" + }, + "SkewedInfo":{ + "shape":"SkewedInfo", + "documentation":"

The information about values that appear frequently in a column (skewed values).

" + }, + "StoredAsSubDirectories":{ + "shape":"Boolean", + "documentation":"

True if the table data is stored in subdirectories, or False if not.

" + } + }, + "documentation":"

Describes the physical storage of table data.

" + }, + "StringList":{ + "type":"list", + "member":{"shape":"GenericString"} + }, + "Table":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The table name. For Hive compatibility, this must be entirely lowercase.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the database where the table metadata resides. For Hive compatibility, this must be all lowercase.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the table.

" + }, + "Owner":{ + "shape":"NameString", + "documentation":"

The owner of the table.

" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"

The time when the table definition was created in the Data Catalog.

" + }, + "UpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time that the table was updated.

" + }, + "LastAccessTime":{ + "shape":"Timestamp", + "documentation":"

The last time that the table was accessed. This is usually taken from HDFS, and might not be reliable.

" + }, + "LastAnalyzedTime":{ + "shape":"Timestamp", + "documentation":"

The last time that column statistics were computed for this table.

" + }, + "Retention":{ + "shape":"NonNegativeInteger", + "documentation":"

The retention time for this table.

" + }, + "StorageDescriptor":{ + "shape":"StorageDescriptor", + "documentation":"

A storage descriptor containing information about the physical storage of this table.

" + }, + "PartitionKeys":{ + "shape":"ColumnList", + "documentation":"

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

\"PartitionKeys\": []

" + }, + "ViewOriginalText":{ + "shape":"ViewTextString", + "documentation":"

If the table is a view, the original text of the view; otherwise null.

" + }, + "ViewExpandedText":{ + "shape":"ViewTextString", + "documentation":"

If the table is a view, the expanded text of the view; otherwise null.

" + }, + "TableType":{ + "shape":"TableTypeString", + "documentation":"

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define properties associated with the table.

" + }, + "CreatedBy":{ + "shape":"NameString", + "documentation":"

The person or entity who created the table.

" + }, + "IsRegisteredWithLakeFormation":{ + "shape":"Boolean", + "documentation":"

Indicates whether the table has been registered with AWS Lake Formation.

" + } + }, + "documentation":"

Represents a collection of related data organized in columns and rows.

" + }, + "TableError":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table. For Hive compatibility, this must be entirely lowercase.

" + }, + "ErrorDetail":{ + "shape":"ErrorDetail", + "documentation":"

The details about the error.

" + } + }, + "documentation":"

An error record for table operations.

" + }, + "TableErrors":{ + "type":"list", + "member":{"shape":"TableError"} + }, + "TableInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The table name. For Hive compatibility, this is folded to lowercase when it is stored.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the table.

" + }, + "Owner":{ + "shape":"NameString", + "documentation":"

The table owner.

" + }, + "LastAccessTime":{ + "shape":"Timestamp", + "documentation":"

The last time that the table was accessed.

" + }, + "LastAnalyzedTime":{ + "shape":"Timestamp", + "documentation":"

The last time that column statistics were computed for this table.

" + }, + "Retention":{ + "shape":"NonNegativeInteger", + "documentation":"

The retention time for this table.

" + }, + "StorageDescriptor":{ + "shape":"StorageDescriptor", + "documentation":"

A storage descriptor containing information about the physical storage of this table.

" + }, + "PartitionKeys":{ + "shape":"ColumnList", + "documentation":"

A list of columns by which the table is partitioned. Only primitive types are supported as partition keys.

When you create a table used by Amazon Athena, and you do not specify any partitionKeys, you must at least set the value of partitionKeys to an empty list. For example:

\"PartitionKeys\": []

" + }, + "ViewOriginalText":{ + "shape":"ViewTextString", + "documentation":"

If the table is a view, the original text of the view; otherwise null.

" + }, + "ViewExpandedText":{ + "shape":"ViewTextString", + "documentation":"

If the table is a view, the expanded text of the view; otherwise null.

" + }, + "TableType":{ + "shape":"TableTypeString", + "documentation":"

The type of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.).

" + }, + "Parameters":{ + "shape":"ParametersMap", + "documentation":"

These key-value pairs define properties associated with the table.

" + } + }, + "documentation":"

A structure used to define a table.

" + }, + "TableList":{ + "type":"list", + "member":{"shape":"Table"} + }, + "TableName":{"type":"string"}, + "TablePrefix":{ + "type":"string", + "max":128, + "min":0 + }, + "TableTypeString":{ + "type":"string", + "max":255 + }, + "TableVersion":{ + "type":"structure", + "members":{ + "Table":{ + "shape":"Table", + "documentation":"

The table in question.

" + }, + "VersionId":{ + "shape":"VersionString", + "documentation":"

The ID value that identifies this table version. A VersionId is a string representation of an integer. Each version is incremented by 1.

" + } + }, + "documentation":"

Specifies a version of a table.

" + }, + "TableVersionError":{ + "type":"structure", + "members":{ + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table in question.

" + }, + "VersionId":{ + "shape":"VersionString", + "documentation":"

The ID value of the version in question. A VersionID is a string representation of an integer. Each version is incremented by 1.

" + }, + "ErrorDetail":{ + "shape":"ErrorDetail", + "documentation":"

The details about the error.

" + } + }, + "documentation":"

An error record for table-version operations.

" + }, + "TableVersionErrors":{ + "type":"list", + "member":{"shape":"TableVersionError"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeysList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagsToAdd" + ], + "members":{ + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The ARN of the AWS Glue resource to which to add the tags. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern.

" + }, + "TagsToAdd":{ + "shape":"TagsMap", + "documentation":"

Tags to add to this resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TagsMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TaskRun":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier for the transform.

" + }, + "TaskRunId":{ + "shape":"HashString", + "documentation":"

The unique identifier for this task run.

" + }, + "Status":{ + "shape":"TaskStatusType", + "documentation":"

The current status of the requested task run.

" + }, + "LogGroupName":{ + "shape":"GenericString", + "documentation":"

The names of the log group for secure logging, associated with this task run.

" + }, + "Properties":{ + "shape":"TaskRunProperties", + "documentation":"

Specifies configuration properties associated with this task run.

" + }, + "ErrorString":{ + "shape":"GenericString", + "documentation":"

The list of error strings associated with this task run.

" + }, + "StartedOn":{ + "shape":"Timestamp", + "documentation":"

The date and time that this task run started.

" + }, + "LastModifiedOn":{ + "shape":"Timestamp", + "documentation":"

The last point in time that the requested task run was updated.

" + }, + "CompletedOn":{ + "shape":"Timestamp", + "documentation":"

The last point in time that the requested task run was completed.

" + }, + "ExecutionTime":{ + "shape":"ExecutionTime", + "documentation":"

The amount of time (in seconds) that the task run consumed resources.

" + } + }, + "documentation":"

The sampling parameters that are associated with the machine learning transform.

" + }, + "TaskRunFilterCriteria":{ + "type":"structure", + "members":{ + "TaskRunType":{ + "shape":"TaskType", + "documentation":"

The type of task run.

" + }, + "Status":{ + "shape":"TaskStatusType", + "documentation":"

The current status of the task run.

" + }, + "StartedBefore":{ + "shape":"Timestamp", + "documentation":"

Filter on task runs started before this date.

" + }, + "StartedAfter":{ + "shape":"Timestamp", + "documentation":"

Filter on task runs started after this date.

" + } + }, + "documentation":"

The criteria that are used to filter the task runs for the machine learning transform.

" + }, + "TaskRunList":{ + "type":"list", + "member":{"shape":"TaskRun"} + }, + "TaskRunProperties":{ + "type":"structure", + "members":{ + "TaskType":{ + "shape":"TaskType", + "documentation":"

The type of task run.

" + }, + "ImportLabelsTaskRunProperties":{ + "shape":"ImportLabelsTaskRunProperties", + "documentation":"

The configuration properties for an importing labels task run.

" + }, + "ExportLabelsTaskRunProperties":{ + "shape":"ExportLabelsTaskRunProperties", + "documentation":"

The configuration properties for an exporting labels task run.

" + }, + "LabelingSetGenerationTaskRunProperties":{ + "shape":"LabelingSetGenerationTaskRunProperties", + "documentation":"

The configuration properties for a labeling set generation task run.

" + }, + "FindMatchesTaskRunProperties":{ + "shape":"FindMatchesTaskRunProperties", + "documentation":"

The configuration properties for a find matches task run.

" + } + }, + "documentation":"

The configuration properties for the task run.

" + }, + "TaskRunSortColumnType":{ + "type":"string", + "enum":[ + "TASK_RUN_TYPE", + "STATUS", + "STARTED" + ] + }, + "TaskRunSortCriteria":{ + "type":"structure", + "required":[ + "Column", + "SortDirection" + ], + "members":{ + "Column":{ + "shape":"TaskRunSortColumnType", + "documentation":"

The column to be used to sort the list of task runs for the machine learning transform.

" + }, + "SortDirection":{ + "shape":"SortDirectionType", + "documentation":"

The sort direction to be used to sort the list of task runs for the machine learning transform.

" + } + }, + "documentation":"

The sorting criteria that are used to sort the list of task runs for the machine learning transform.

" + }, + "TaskStatusType":{ + "type":"string", + "enum":[ + "STARTING", + "RUNNING", + "STOPPING", + "STOPPED", + "SUCCEEDED", + "FAILED", + "TIMEOUT" + ] + }, + "TaskType":{ + "type":"string", + "enum":[ + "EVALUATION", + "LABELING_SET_GENERATION", + "IMPORT_LABELS", + "EXPORT_LABELS", + "FIND_MATCHES" + ] + }, + "Timeout":{ + "type":"integer", + "box":true, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TimestampValue":{"type":"timestamp"}, + "Token":{"type":"string"}, + "TotalSegmentsInteger":{ + "type":"integer", + "max":10, + "min":1 + }, + "TransformFilterCriteria":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

A unique transform name that is used to filter the machine learning transforms.

" + }, + "TransformType":{ + "shape":"TransformType", + "documentation":"

The type of machine learning transform that is used to filter the machine learning transforms.

" + }, + "Status":{ + "shape":"TransformStatusType", + "documentation":"

Filters the list of machine learning transforms by the last known status of the transforms (to indicate whether a transform can be used or not). One of \"NOT_READY\", \"READY\", or \"DELETING\".

" + }, + "CreatedBefore":{ + "shape":"Timestamp", + "documentation":"

The time and date before which the transforms were created.

" + }, + "CreatedAfter":{ + "shape":"Timestamp", + "documentation":"

The time and date after which the transforms were created.

" + }, + "LastModifiedBefore":{ + "shape":"Timestamp", + "documentation":"

Filter on transforms last modified before this date.

" + }, + "LastModifiedAfter":{ + "shape":"Timestamp", + "documentation":"

Filter on transforms last modified after this date.

" + }, + "Schema":{ + "shape":"TransformSchema", + "documentation":"

Filters on datasets with a specific schema. The Map<Column, Type> object is an array of key-value pairs representing the schema this transform accepts, where Column is the name of a column, and Type is the type of the data such as an integer or string. Has an upper bound of 100 columns.

" + } + }, + "documentation":"

The criteria used to filter the machine learning transforms.

" + }, + "TransformList":{ + "type":"list", + "member":{"shape":"MLTransform"} + }, + "TransformParameters":{ + "type":"structure", + "required":["TransformType"], + "members":{ + "TransformType":{ + "shape":"TransformType", + "documentation":"

The type of machine learning transform.

For information about the types of machine learning transforms, see Creating Machine Learning Transforms.

" + }, + "FindMatchesParameters":{ + "shape":"FindMatchesParameters", + "documentation":"

The parameters for the find matches algorithm.

" + } + }, + "documentation":"

The algorithm-specific parameters that are associated with the machine learning transform.

" + }, + "TransformSchema":{ + "type":"list", + "member":{"shape":"SchemaColumn"}, + "max":100 + }, + "TransformSortColumnType":{ + "type":"string", + "enum":[ + "NAME", + "TRANSFORM_TYPE", + "STATUS", + "CREATED", + "LAST_MODIFIED" + ] + }, + "TransformSortCriteria":{ + "type":"structure", + "required":[ + "Column", + "SortDirection" + ], + "members":{ + "Column":{ + "shape":"TransformSortColumnType", + "documentation":"

The column to be used in the sorting criteria that are associated with the machine learning transform.

" + }, + "SortDirection":{ + "shape":"SortDirectionType", + "documentation":"

The sort direction to be used in the sorting criteria that are associated with the machine learning transform.

" + } + }, + "documentation":"

The sorting criteria that are associated with the machine learning transform.

" + }, + "TransformStatusType":{ + "type":"string", + "enum":[ + "NOT_READY", + "READY", + "DELETING" + ] + }, + "TransformType":{ + "type":"string", + "enum":["FIND_MATCHES"] + }, + "Trigger":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger.

" + }, + "WorkflowName":{ + "shape":"NameString", + "documentation":"

The name of the workflow associated with the trigger.

" + }, + "Id":{ + "shape":"IdString", + "documentation":"

Reserved for future use.

" + }, + "Type":{ + "shape":"TriggerType", + "documentation":"

The type of trigger that this is.

" + }, + "State":{ + "shape":"TriggerState", + "documentation":"

The current state of the trigger.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of this trigger.

" + }, + "Schedule":{ + "shape":"GenericString", + "documentation":"

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

" + }, + "Actions":{ + "shape":"ActionList", + "documentation":"

The actions initiated by this trigger.

" + }, + "Predicate":{ + "shape":"Predicate", + "documentation":"

The predicate of this trigger, which defines when it will fire.

" + } + }, + "documentation":"

Information about a specific trigger.

" + }, + "TriggerList":{ + "type":"list", + "member":{"shape":"Trigger"} + }, + "TriggerNameList":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "TriggerNodeDetails":{ + "type":"structure", + "members":{ + "Trigger":{ + "shape":"Trigger", + "documentation":"

The information of the trigger represented by the trigger node.

" + } + }, + "documentation":"

The details of a Trigger node present in the workflow.

" + }, + "TriggerState":{ + "type":"string", + "enum":[ + "CREATING", + "CREATED", + "ACTIVATING", + "ACTIVATED", + "DEACTIVATING", + "DEACTIVATED", + "DELETING", + "UPDATING" + ] + }, + "TriggerType":{ + "type":"string", + "enum":[ + "SCHEDULED", + "CONDITIONAL", + "ON_DEMAND" + ] + }, + "TriggerUpdate":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Reserved for future use.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of this trigger.

" + }, + "Schedule":{ + "shape":"GenericString", + "documentation":"

A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

" + }, + "Actions":{ + "shape":"ActionList", + "documentation":"

The actions initiated by this trigger.

" + }, + "Predicate":{ + "shape":"Predicate", + "documentation":"

The predicate of this trigger, which defines when it will fire.

" + } + }, + "documentation":"

A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.

" + }, + "URI":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagsToRemove" + ], + "members":{ + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which to remove the tags.

" + }, + "TagsToRemove":{ + "shape":"TagKeysList", + "documentation":"

Tags to remove from this resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateBehavior":{ + "type":"string", + "enum":[ + "LOG", + "UPDATE_IN_DATABASE" + ] + }, + "UpdateClassifierRequest":{ + "type":"structure", + "members":{ + "GrokClassifier":{ + "shape":"UpdateGrokClassifierRequest", + "documentation":"

A GrokClassifier object with updated fields.

" + }, + "XMLClassifier":{ + "shape":"UpdateXMLClassifierRequest", + "documentation":"

An XMLClassifier object with updated fields.

" + }, + "JsonClassifier":{ + "shape":"UpdateJsonClassifierRequest", + "documentation":"

A JsonClassifier object with updated fields.

" + }, + "CsvClassifier":{ + "shape":"UpdateCsvClassifierRequest", + "documentation":"

A CsvClassifier object with updated fields.

" + } + } + }, + "UpdateClassifierResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateConnectionRequest":{ + "type":"structure", + "required":[ + "Name", + "ConnectionInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the connection resides. If none is provided, the AWS account ID is used by default.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the connection definition to update.

" + }, + "ConnectionInput":{ + "shape":"ConnectionInput", + "documentation":"

A ConnectionInput object that redefines the connection in question.

" + } + } + }, + "UpdateConnectionResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCrawlerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the new crawler.

" + }, + "Role":{ + "shape":"Role", + "documentation":"

The IAM role or Amazon Resource Name (ARN) of an IAM role that is used by the new crawler to access customer resources.

" + }, + "DatabaseName":{ + "shape":"DatabaseName", + "documentation":"

The AWS Glue database where results are stored, such as: arn:aws:daylight:us-east-1::database/sometable/*.

" + }, + "Description":{ + "shape":"DescriptionStringRemovable", + "documentation":"

A description of the new crawler.

" + }, + "Targets":{ + "shape":"CrawlerTargets", + "documentation":"

A list of targets to crawl.

" + }, + "Schedule":{ + "shape":"CronExpression", + "documentation":"

A cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

" + }, + "Classifiers":{ + "shape":"ClassifierNameList", + "documentation":"

A list of custom classifiers that the user has registered. By default, all built-in classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification.

" + }, + "TablePrefix":{ + "shape":"TablePrefix", + "documentation":"

The table prefix used for catalog tables that are created.

" + }, + "SchemaChangePolicy":{ + "shape":"SchemaChangePolicy", + "documentation":"

The policy for the crawler's update and deletion behavior.

" + }, + "Configuration":{ + "shape":"CrawlerConfiguration", + "documentation":"

The crawler configuration information. This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see Configuring a Crawler.

" + }, + "CrawlerSecurityConfiguration":{ + "shape":"CrawlerSecurityConfiguration", + "documentation":"

The name of the SecurityConfiguration structure to be used by this crawler.

" + } + } + }, + "UpdateCrawlerResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCrawlerScheduleRequest":{ + "type":"structure", + "required":["CrawlerName"], + "members":{ + "CrawlerName":{ + "shape":"NameString", + "documentation":"

The name of the crawler whose schedule to update.

" + }, + "Schedule":{ + "shape":"CronExpression", + "documentation":"

The updated cron expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, specify cron(15 12 * * ? *).

" + } + } + }, + "UpdateCrawlerScheduleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCsvClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "Delimiter":{ + "shape":"CsvColumnDelimiter", + "documentation":"

A custom symbol to denote what separates each column entry in the row.

" + }, + "QuoteSymbol":{ + "shape":"CsvQuoteSymbol", + "documentation":"

A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter.

" + }, + "ContainsHeader":{ + "shape":"CsvHeaderOption", + "documentation":"

Indicates whether the CSV file contains a header.

" + }, + "Header":{ + "shape":"CsvHeader", + "documentation":"

A list of strings representing column names.

" + }, + "DisableValueTrimming":{ + "shape":"NullableBoolean", + "documentation":"

Specifies not to trim values before identifying the type of column values. The default value is true.

" + }, + "AllowSingleColumn":{ + "shape":"NullableBoolean", + "documentation":"

Enables the processing of files that contain only one column.

" + } + }, + "documentation":"

Specifies a custom CSV classifier to be updated.

" + }, + "UpdateDatabaseRequest":{ + "type":"structure", + "required":[ + "Name", + "DatabaseInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the metadata database resides. If none is provided, the AWS account ID is used by default.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database to update in the catalog. For Hive compatibility, this is folded to lowercase.

" + }, + "DatabaseInput":{ + "shape":"DatabaseInput", + "documentation":"

A DatabaseInput object specifying the new definition of the metadata database in the catalog.

" + } + } + }, + "UpdateDatabaseResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDevEndpointRequest":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"GenericString", + "documentation":"

The name of the DevEndpoint to be updated.

" + }, + "PublicKey":{ + "shape":"GenericString", + "documentation":"

The public key for the DevEndpoint to use.

" + }, + "AddPublicKeys":{ + "shape":"PublicKeysList", + "documentation":"

The list of public keys for the DevEndpoint to use.

" + }, + "DeletePublicKeys":{ + "shape":"PublicKeysList", + "documentation":"

The list of public keys to be deleted from the DevEndpoint.

" + }, + "CustomLibraries":{ + "shape":"DevEndpointCustomLibraries", + "documentation":"

Custom Python or Java libraries to be loaded in the DevEndpoint.

" + }, + "UpdateEtlLibraries":{ + "shape":"BooleanValue", + "documentation":"

True if the list of custom libraries to be loaded in the development endpoint needs to be updated, or False if otherwise.

" + }, + "DeleteArguments":{ + "shape":"StringList", + "documentation":"

The list of argument keys to be deleted from the map of arguments used to configure the DevEndpoint.

" + }, + "AddArguments":{ + "shape":"MapValue", + "documentation":"

The map of arguments to add the map of arguments used to configure the DevEndpoint.

Valid arguments are:

  • \"--enable-glue-datacatalog\": \"\"

  • \"GLUE_PYTHON_VERSION\": \"3\"

  • \"GLUE_PYTHON_VERSION\": \"2\"

You can specify a version of Python support for development endpoints by using the Arguments parameter in the CreateDevEndpoint or UpdateDevEndpoint APIs. If no arguments are provided, the version defaults to Python 2.

" + } + } + }, + "UpdateDevEndpointResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateGrokClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the GrokClassifier.

" + }, + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, Amazon CloudWatch Logs, and so on.

" + }, + "GrokPattern":{ + "shape":"GrokPattern", + "documentation":"

The grok pattern used by this classifier.

" + }, + "CustomPatterns":{ + "shape":"CustomPatterns", + "documentation":"

Optional custom grok patterns used by this classifier.

" + } + }, + "documentation":"

Specifies a grok classifier to update when passed to UpdateClassifier.

" + }, + "UpdateJobRequest":{ + "type":"structure", + "required":[ + "JobName", + "JobUpdate" + ], + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

The name of the job definition to update.

" + }, + "JobUpdate":{ + "shape":"JobUpdate", + "documentation":"

Specifies the values with which to update the job definition.

" + } + } + }, + "UpdateJobResponse":{ + "type":"structure", + "members":{ + "JobName":{ + "shape":"NameString", + "documentation":"

Returns the name of the updated job definition.

" + } + } + }, + "UpdateJsonClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "JsonPath":{ + "shape":"JsonPath", + "documentation":"

A JsonPath string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in Writing JsonPath Custom Classifiers.

" + } + }, + "documentation":"

Specifies a JSON classifier to be updated.

" + }, + "UpdateMLTransformRequest":{ + "type":"structure", + "required":["TransformId"], + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

A unique identifier that was generated when the transform was created.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The unique name that you gave the transform when you created it.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description of the transform. The default is an empty string.

" + }, + "Parameters":{ + "shape":"TransformParameters", + "documentation":"

The configuration parameters that are specific to the transform type (algorithm) used. Conditionally dependent on the transform type.

" + }, + "Role":{ + "shape":"RoleString", + "documentation":"

The name or Amazon Resource Name (ARN) of the IAM role with the required permissions.

" + }, + "MaxCapacity":{ + "shape":"NullableDouble", + "documentation":"

The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the AWS Glue pricing page.

When the WorkerType field is set to a value other than Standard, the MaxCapacity field is set automatically and becomes read-only.

" + }, + "WorkerType":{ + "shape":"WorkerType", + "documentation":"

The type of predefined worker that is allocated when this task runs. Accepts a value of Standard, G.1X, or G.2X.

  • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.

  • For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.

  • For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.

" + }, + "NumberOfWorkers":{ + "shape":"NullableInteger", + "documentation":"

The number of workers of a defined workerType that are allocated when this task runs.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The timeout for a task run for this transform in minutes. This is the maximum time that a task run for this transform can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

" + }, + "MaxRetries":{ + "shape":"NullableInteger", + "documentation":"

The maximum number of times to retry a task for this transform after a task run fails.

" + } + } + }, + "UpdateMLTransformResponse":{ + "type":"structure", + "members":{ + "TransformId":{ + "shape":"HashString", + "documentation":"

The unique identifier for the transform that was updated.

" + } + } + }, + "UpdatePartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValueList", + "PartitionInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partition to be updated resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the table in question resides.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the table in which the partition to be updated is located.

" + }, + "PartitionValueList":{ + "shape":"BoundedPartitionValueList", + "documentation":"

A list of the values defining the partition.

" + }, + "PartitionInput":{ + "shape":"PartitionInput", + "documentation":"

The new partition object to update the partition to.

" + } + } + }, + "UpdatePartitionResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the table resides. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database in which the table resides. For Hive compatibility, this name is entirely lowercase.

" + }, + "TableInput":{ + "shape":"TableInput", + "documentation":"

An updated TableInput object to define the metadata table in the catalog.

" + }, + "SkipArchive":{ + "shape":"BooleanNullable", + "documentation":"

By default, UpdateTable always creates an archived version of the table before updating it. However, if skipArchive is set to true, UpdateTable does not create the archived version.

" + } + } + }, + "UpdateTableResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateTriggerRequest":{ + "type":"structure", + "required":[ + "Name", + "TriggerUpdate" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the trigger to update.

" + }, + "TriggerUpdate":{ + "shape":"TriggerUpdate", + "documentation":"

The new values with which to update the trigger.

" + } + } + }, + "UpdateTriggerResponse":{ + "type":"structure", + "members":{ + "Trigger":{ + "shape":"Trigger", + "documentation":"

The resulting trigger definition.

" + } + } + }, + "UpdateUserDefinedFunctionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "FunctionName", + "FunctionInput" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the function to be updated is located. If none is provided, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the function to be updated is located.

" + }, + "FunctionName":{ + "shape":"NameString", + "documentation":"

The name of the function.

" + }, + "FunctionInput":{ + "shape":"UserDefinedFunctionInput", + "documentation":"

A FunctionInput object that redefines the function in the Data Catalog.

" + } + } + }, + "UpdateUserDefinedFunctionResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateWorkflowRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow to be updated.

" + }, + "Description":{ + "shape":"GenericString", + "documentation":"

The description of the workflow.

" + }, + "DefaultRunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

A collection of properties to be used as part of each execution of the workflow.

" + } + } + }, + "UpdateWorkflowResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the workflow which was specified in input.

" + } + } + }, + "UpdateXMLClassifierRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches.

" + }, + "RowTag":{ + "shape":"RowTag", + "documentation":"

The XML tag designating the element that contains each record in an XML document being parsed. This cannot identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a=\"A\" item_b=\"B\"></row> is okay, but <row item_a=\"A\" item_b=\"B\" /> is not).

" + } + }, + "documentation":"

Specifies an XML classifier to be updated.

" + }, + "UriString":{"type":"string"}, + "UserDefinedFunction":{ + "type":"structure", + "members":{ + "FunctionName":{ + "shape":"NameString", + "documentation":"

The name of the function.

" + }, + "ClassName":{ + "shape":"NameString", + "documentation":"

The Java class that contains the function code.

" + }, + "OwnerName":{ + "shape":"NameString", + "documentation":"

The owner of the function.

" + }, + "OwnerType":{ + "shape":"PrincipalType", + "documentation":"

The owner type.

" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the function was created.

" + }, + "ResourceUris":{ + "shape":"ResourceUriList", + "documentation":"

The resource URIs for the function.

" + } + }, + "documentation":"

Represents the equivalent of a Hive user-defined function (UDF) definition.

" + }, + "UserDefinedFunctionInput":{ + "type":"structure", + "members":{ + "FunctionName":{ + "shape":"NameString", + "documentation":"

The name of the function.

" + }, + "ClassName":{ + "shape":"NameString", + "documentation":"

The Java class that contains the function code.

" + }, + "OwnerName":{ + "shape":"NameString", + "documentation":"

The owner of the function.

" + }, + "OwnerType":{ + "shape":"PrincipalType", + "documentation":"

The owner type.

" + }, + "ResourceUris":{ + "shape":"ResourceUriList", + "documentation":"

The resource URIs for the function.

" + } + }, + "documentation":"

A structure used to create or update a user-defined function.

" + }, + "UserDefinedFunctionList":{ + "type":"list", + "member":{"shape":"UserDefinedFunction"} + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A value could not be validated.

", + "exception":true + }, + "ValueString":{ + "type":"string", + "max":1024 + }, + "ValueStringList":{ + "type":"list", + "member":{"shape":"ValueString"} + }, + "VersionId":{"type":"long"}, + "VersionMismatchException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

There was a version conflict.

", + "exception":true + }, + "VersionString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "ViewTextString":{ + "type":"string", + "max":409600 + }, + "WorkerType":{ + "type":"string", + "enum":[ + "Standard", + "G.1X", + "G.2X" + ] + }, + "Workflow":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the workflow representing the flow.

" + }, + "Description":{ + "shape":"GenericString", + "documentation":"

A description of the workflow.

" + }, + "DefaultRunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

A collection of properties to be used as part of each execution of the workflow.

" + }, + "CreatedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time when the workflow was created.

" + }, + "LastModifiedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time when the workflow was last modified.

" + }, + "LastRun":{ + "shape":"WorkflowRun", + "documentation":"

The information about the last execution of the workflow.

" + }, + "Graph":{ + "shape":"WorkflowGraph", + "documentation":"

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

" + } + }, + "documentation":"

A workflow represents a flow in which AWS Glue components should be executed to complete a logical task.

" + }, + "WorkflowGraph":{ + "type":"structure", + "members":{ + "Nodes":{ + "shape":"NodeList", + "documentation":"

A list of the the AWS Glue components belong to the workflow represented as nodes.

" + }, + "Edges":{ + "shape":"EdgeList", + "documentation":"

A list of all the directed connections between the nodes belonging to the workflow.

" + } + }, + "documentation":"

A workflow graph represents the complete workflow containing all the AWS Glue components present in the workflow and all the directed connections between them.

" + }, + "WorkflowNames":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":25, + "min":1 + }, + "WorkflowRun":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

Name of the workflow which was executed.

" + }, + "WorkflowRunId":{ + "shape":"IdString", + "documentation":"

The ID of this workflow run.

" + }, + "WorkflowRunProperties":{ + "shape":"WorkflowRunProperties", + "documentation":"

The workflow run properties which were set during the run.

" + }, + "StartedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time when the workflow run was started.

" + }, + "CompletedOn":{ + "shape":"TimestampValue", + "documentation":"

The date and time when the workflow run completed.

" + }, + "Status":{ + "shape":"WorkflowRunStatus", + "documentation":"

The status of the workflow run.

" + }, + "Statistics":{ + "shape":"WorkflowRunStatistics", + "documentation":"

The statistics of the run.

" + }, + "Graph":{ + "shape":"WorkflowGraph", + "documentation":"

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

" + } + }, + "documentation":"

A workflow run is an execution of a workflow providing all the runtime information.

" + }, + "WorkflowRunProperties":{ + "type":"map", + "key":{"shape":"IdString"}, + "value":{"shape":"GenericString"} + }, + "WorkflowRunStatistics":{ + "type":"structure", + "members":{ + "TotalActions":{ + "shape":"IntegerValue", + "documentation":"

Total number of Actions in the workflow run.

" + }, + "TimeoutActions":{ + "shape":"IntegerValue", + "documentation":"

Total number of Actions which timed out.

" + }, + "FailedActions":{ + "shape":"IntegerValue", + "documentation":"

Total number of Actions which have failed.

" + }, + "StoppedActions":{ + "shape":"IntegerValue", + "documentation":"

Total number of Actions which have stopped.

" + }, + "SucceededActions":{ + "shape":"IntegerValue", + "documentation":"

Total number of Actions which have succeeded.

" + }, + "RunningActions":{ + "shape":"IntegerValue", + "documentation":"

Total number Actions in running state.

" + } + }, + "documentation":"

Workflow run statistics provides statistics about the workflow run.

" + }, + "WorkflowRunStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "COMPLETED" + ] + }, + "WorkflowRuns":{ + "type":"list", + "member":{"shape":"WorkflowRun"}, + "max":1000, + "min":1 + }, + "Workflows":{ + "type":"list", + "member":{"shape":"Workflow"}, + "max":25, + "min":1 + }, + "XMLClassifier":{ + "type":"structure", + "required":[ + "Name", + "Classification" + ], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the classifier.

" + }, + "Classification":{ + "shape":"Classification", + "documentation":"

An identifier of the data format that the classifier matches.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was registered.

" + }, + "LastUpdated":{ + "shape":"Timestamp", + "documentation":"

The time that this classifier was last updated.

" + }, + "Version":{ + "shape":"VersionId", + "documentation":"

The version of this classifier.

" + }, + "RowTag":{ + "shape":"RowTag", + "documentation":"

The XML tag designating the element that contains each record in an XML document being parsed. This can't identify a self-closing element (closed by />). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, <row item_a=\"A\" item_b=\"B\"></row> is okay, but <row item_a=\"A\" item_b=\"B\" /> is not).

" + } + }, + "documentation":"

A classifier for XML content.

" + } + }, + "documentation":"AWS Glue

Defines the public endpoint for the AWS Glue service.

" +} diff --git a/aws/dist/botocore/data/greengrass/2017-06-07/paginators-1.json b/aws/dist/botocore/data/greengrass/2017-06-07/paginators-1.json new file mode 100644 index 00000000..303b4384 --- /dev/null +++ b/aws/dist/botocore/data/greengrass/2017-06-07/paginators-1.json @@ -0,0 +1,118 @@ +{ + "pagination": { + "ListBulkDeploymentDetailedReports": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Deployments" + }, + "ListBulkDeployments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BulkDeployments" + }, + "ListConnectorDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListConnectorDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListCoreDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListCoreDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListDeployments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Deployments" + }, + "ListDeviceDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListDeviceDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListFunctionDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListFunctionDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListGroupVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Groups" + }, + "ListLoggerDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListLoggerDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListResourceDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListResourceDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + }, + "ListSubscriptionDefinitionVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListSubscriptionDefinitions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Definitions" + } + } +} diff --git a/aws/dist/botocore/data/greengrass/2017-06-07/service-2.json b/aws/dist/botocore/data/greengrass/2017-06-07/service-2.json new file mode 100644 index 00000000..8e0b8868 --- /dev/null +++ b/aws/dist/botocore/data/greengrass/2017-06-07/service-2.json @@ -0,0 +1,6021 @@ +{ + "metadata" : { + "apiVersion" : "2017-06-07", + "endpointPrefix" : "greengrass", + "signingName" : "greengrass", + "serviceFullName" : "AWS Greengrass", + "serviceId" : "Greengrass", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "greengrass-2017-06-07", + "signatureVersion" : "v4" + }, + "operations" : { + "AssociateRoleToGroup" : { + "name" : "AssociateRoleToGroup", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/groups/{GroupId}/role", + "responseCode" : 200 + }, + "input" : { + "shape" : "AssociateRoleToGroupRequest" + }, + "output" : { + "shape" : "AssociateRoleToGroupResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud." + }, + "AssociateServiceRoleToAccount" : { + "name" : "AssociateServiceRoleToAccount", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/servicerole", + "responseCode" : 200 + }, + "input" : { + "shape" : "AssociateServiceRoleToAccountRequest" + }, + "output" : { + "shape" : "AssociateServiceRoleToAccountResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Associates a role with your account. AWS IoT Greengrass will use the role to access your Lambda functions and AWS IoT resources. This is necessary for deployments to succeed. The role must have at least minimum permissions in the policy ''AWSGreengrassResourceAccessRolePolicy''." + }, + "CreateConnectorDefinition" : { + "name" : "CreateConnectorDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/connectors", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConnectorDefinitionRequest" + }, + "output" : { + "shape" : "CreateConnectorDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a connector definition. You may provide the initial version of the connector definition now or use ''CreateConnectorDefinitionVersion'' at a later time." + }, + "CreateConnectorDefinitionVersion" : { + "name" : "CreateConnectorDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConnectorDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateConnectorDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a connector definition which has already been defined." + }, + "CreateCoreDefinition" : { + "name" : "CreateCoreDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/cores", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateCoreDefinitionRequest" + }, + "output" : { + "shape" : "CreateCoreDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a core definition. You may provide the initial version of the core definition now or use ''CreateCoreDefinitionVersion'' at a later time. Greengrass groups must each contain exactly one Greengrass core." + }, + "CreateCoreDefinitionVersion" : { + "name" : "CreateCoreDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateCoreDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateCoreDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core." + }, + "CreateDeployment" : { + "name" : "CreateDeployment", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/groups/{GroupId}/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateDeploymentRequest" + }, + "output" : { + "shape" : "CreateDeploymentResponse", + "documentation" : "Success. The group was deployed." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a deployment. ''CreateDeployment'' requests are idempotent with respect to the ''X-Amzn-Client-Token'' token and the request parameters." + }, + "CreateDeviceDefinition" : { + "name" : "CreateDeviceDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/devices", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateDeviceDefinitionRequest" + }, + "output" : { + "shape" : "CreateDeviceDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a device definition. You may provide the initial version of the device definition now or use ''CreateDeviceDefinitionVersion'' at a later time." + }, + "CreateDeviceDefinitionVersion" : { + "name" : "CreateDeviceDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateDeviceDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateDeviceDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a device definition that has already been defined." + }, + "CreateFunctionDefinition" : { + "name" : "CreateFunctionDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/functions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateFunctionDefinitionRequest" + }, + "output" : { + "shape" : "CreateFunctionDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a Lambda function definition which contains a list of Lambda functions and their configurations to be used in a group. You can create an initial version of the definition by providing a list of Lambda functions and their configurations now, or use ''CreateFunctionDefinitionVersion'' later." + }, + "CreateFunctionDefinitionVersion" : { + "name" : "CreateFunctionDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateFunctionDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateFunctionDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a Lambda function definition that has already been defined." + }, + "CreateGroup" : { + "name" : "CreateGroup", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/groups", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateGroupRequest" + }, + "output" : { + "shape" : "CreateGroupResponse", + "documentation" : "Success. The group was created." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a group. You may provide the initial version of the group or use ''CreateGroupVersion'' at a later time. Tip: You can use the ''gg_group_setup'' package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups." + }, + "CreateGroupCertificateAuthority" : { + "name" : "CreateGroupCertificateAuthority", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/groups/{GroupId}/certificateauthorities", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateGroupCertificateAuthorityRequest" + }, + "output" : { + "shape" : "CreateGroupCertificateAuthorityResponse", + "documentation" : "Success. The response body contains the new active CA ARN." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Creates a CA for the group. If a CA already exists, it will rotate the existing CA." + }, + "CreateGroupVersion" : { + "name" : "CreateGroupVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/groups/{GroupId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateGroupVersionRequest" + }, + "output" : { + "shape" : "CreateGroupVersionResponse", + "documentation" : "Success. The response contains information about the group version." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a group which has already been defined." + }, + "CreateLoggerDefinition" : { + "name" : "CreateLoggerDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/loggers", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateLoggerDefinitionRequest" + }, + "output" : { + "shape" : "CreateLoggerDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a logger definition. You may provide the initial version of the logger definition now or use ''CreateLoggerDefinitionVersion'' at a later time." + }, + "CreateLoggerDefinitionVersion" : { + "name" : "CreateLoggerDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateLoggerDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateLoggerDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a logger definition that has already been defined." + }, + "CreateResourceDefinition" : { + "name" : "CreateResourceDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/resources", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateResourceDefinitionRequest" + }, + "output" : { + "shape" : "CreateResourceDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a resource definition which contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use ''CreateResourceDefinitionVersion'' later." + }, + "CreateResourceDefinitionVersion" : { + "name" : "CreateResourceDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateResourceDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateResourceDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a resource definition that has already been defined." + }, + "CreateSoftwareUpdateJob" : { + "name" : "CreateSoftwareUpdateJob", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/updates", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateSoftwareUpdateJobRequest" + }, + "output" : { + "shape" : "CreateSoftwareUpdateJobResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA Agent as well as the Greengrass core software. It makes use of the IoT Jobs feature which provides additional commands to manage a Greengrass core software update job." + }, + "CreateSubscriptionDefinition" : { + "name" : "CreateSubscriptionDefinition", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/subscriptions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateSubscriptionDefinitionRequest" + }, + "output" : { + "shape" : "CreateSubscriptionDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a subscription definition. You may provide the initial version of the subscription definition now or use ''CreateSubscriptionDefinitionVersion'' at a later time." + }, + "CreateSubscriptionDefinitionVersion" : { + "name" : "CreateSubscriptionDefinitionVersion", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateSubscriptionDefinitionVersionRequest" + }, + "output" : { + "shape" : "CreateSubscriptionDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Creates a version of a subscription definition which has already been defined." + }, + "DeleteConnectorDefinition" : { + "name" : "DeleteConnectorDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteConnectorDefinitionRequest" + }, + "output" : { + "shape" : "DeleteConnectorDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a connector definition." + }, + "DeleteCoreDefinition" : { + "name" : "DeleteCoreDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteCoreDefinitionRequest" + }, + "output" : { + "shape" : "DeleteCoreDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a core definition." + }, + "DeleteDeviceDefinition" : { + "name" : "DeleteDeviceDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteDeviceDefinitionRequest" + }, + "output" : { + "shape" : "DeleteDeviceDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a device definition." + }, + "DeleteFunctionDefinition" : { + "name" : "DeleteFunctionDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteFunctionDefinitionRequest" + }, + "output" : { + "shape" : "DeleteFunctionDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a Lambda function definition." + }, + "DeleteGroup" : { + "name" : "DeleteGroup", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/groups/{GroupId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteGroupRequest" + }, + "output" : { + "shape" : "DeleteGroupResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a group." + }, + "DeleteLoggerDefinition" : { + "name" : "DeleteLoggerDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteLoggerDefinitionRequest" + }, + "output" : { + "shape" : "DeleteLoggerDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a logger definition." + }, + "DeleteResourceDefinition" : { + "name" : "DeleteResourceDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteResourceDefinitionRequest" + }, + "output" : { + "shape" : "DeleteResourceDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a resource definition." + }, + "DeleteSubscriptionDefinition" : { + "name" : "DeleteSubscriptionDefinition", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteSubscriptionDefinitionRequest" + }, + "output" : { + "shape" : "DeleteSubscriptionDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deletes a subscription definition." + }, + "DisassociateRoleFromGroup" : { + "name" : "DisassociateRoleFromGroup", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/groups/{GroupId}/role", + "responseCode" : 200 + }, + "input" : { + "shape" : "DisassociateRoleFromGroupRequest" + }, + "output" : { + "shape" : "DisassociateRoleFromGroupResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Disassociates the role from a group." + }, + "DisassociateServiceRoleFromAccount" : { + "name" : "DisassociateServiceRoleFromAccount", + "http" : { + "method" : "DELETE", + "requestUri" : "/greengrass/servicerole", + "responseCode" : 200 + }, + "input" : { + "shape" : "DisassociateServiceRoleFromAccountRequest" + }, + "output" : { + "shape" : "DisassociateServiceRoleFromAccountResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Disassociates the service role from your account. Without a service role, deployments will not work." + }, + "GetAssociatedRole" : { + "name" : "GetAssociatedRole", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/role", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetAssociatedRoleRequest" + }, + "output" : { + "shape" : "GetAssociatedRoleResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retrieves the role associated with a particular group." + }, + "GetBulkDeploymentStatus" : { + "name" : "GetBulkDeploymentStatus", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/bulk/deployments/{BulkDeploymentId}/status", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetBulkDeploymentStatusRequest" + }, + "output" : { + "shape" : "GetBulkDeploymentStatusResponse", + "documentation" : "Success. The response body contains the status of the bulk deployment." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Returns the status of a bulk deployment." + }, + "GetConnectivityInfo" : { + "name" : "GetConnectivityInfo", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/things/{ThingName}/connectivityInfo", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConnectivityInfoRequest" + }, + "output" : { + "shape" : "GetConnectivityInfoResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retrieves the connectivity information for a core." + }, + "GetConnectorDefinition" : { + "name" : "GetConnectorDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConnectorDefinitionRequest" + }, + "output" : { + "shape" : "GetConnectorDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a connector definition." + }, + "GetConnectorDefinitionVersion" : { + "name" : "GetConnectorDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions/{ConnectorDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConnectorDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetConnectorDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services." + }, + "GetCoreDefinition" : { + "name" : "GetCoreDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetCoreDefinitionRequest" + }, + "output" : { + "shape" : "GetCoreDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a core definition version." + }, + "GetCoreDefinitionVersion" : { + "name" : "GetCoreDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}/versions/{CoreDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetCoreDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetCoreDefinitionVersionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a core definition version." + }, + "GetDeploymentStatus" : { + "name" : "GetDeploymentStatus", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/deployments/{DeploymentId}/status", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeploymentStatusRequest" + }, + "output" : { + "shape" : "GetDeploymentStatusResponse", + "documentation" : "Success. The response body contains the status of the deployment for the group." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Returns the status of a deployment." + }, + "GetDeviceDefinition" : { + "name" : "GetDeviceDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeviceDefinitionRequest" + }, + "output" : { + "shape" : "GetDeviceDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a device definition." + }, + "GetDeviceDefinitionVersion" : { + "name" : "GetDeviceDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}/versions/{DeviceDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeviceDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetDeviceDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a device definition version." + }, + "GetFunctionDefinition" : { + "name" : "GetFunctionDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetFunctionDefinitionRequest" + }, + "output" : { + "shape" : "GetFunctionDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a Lambda function definition, including its creation time and latest version." + }, + "GetFunctionDefinitionVersion" : { + "name" : "GetFunctionDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}/versions/{FunctionDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetFunctionDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetFunctionDefinitionVersionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations." + }, + "GetGroup" : { + "name" : "GetGroup", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetGroupRequest" + }, + "output" : { + "shape" : "GetGroupResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a group." + }, + "GetGroupCertificateAuthority" : { + "name" : "GetGroupCertificateAuthority", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/certificateauthorities/{CertificateAuthorityId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetGroupCertificateAuthorityRequest" + }, + "output" : { + "shape" : "GetGroupCertificateAuthorityResponse", + "documentation" : "Success. The response body contains the PKI Configuration." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retreives the CA associated with a group. Returns the public key of the CA." + }, + "GetGroupCertificateConfiguration" : { + "name" : "GetGroupCertificateConfiguration", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetGroupCertificateConfigurationRequest" + }, + "output" : { + "shape" : "GetGroupCertificateConfigurationResponse", + "documentation" : "Success. The response body contains the PKI Configuration." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retrieves the current configuration for the CA used by the group." + }, + "GetGroupVersion" : { + "name" : "GetGroupVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/versions/{GroupVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetGroupVersionRequest" + }, + "output" : { + "shape" : "GetGroupVersionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a group version." + }, + "GetLoggerDefinition" : { + "name" : "GetLoggerDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetLoggerDefinitionRequest" + }, + "output" : { + "shape" : "GetLoggerDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a logger definition." + }, + "GetLoggerDefinitionVersion" : { + "name" : "GetLoggerDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}/versions/{LoggerDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetLoggerDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetLoggerDefinitionVersionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a logger definition version." + }, + "GetResourceDefinition" : { + "name" : "GetResourceDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetResourceDefinitionRequest" + }, + "output" : { + "shape" : "GetResourceDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a resource definition, including its creation time and latest version." + }, + "GetResourceDefinitionVersion" : { + "name" : "GetResourceDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}/versions/{ResourceDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetResourceDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetResourceDefinitionVersionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a resource definition version, including which resources are included in the version." + }, + "GetServiceRoleForAccount" : { + "name" : "GetServiceRoleForAccount", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/servicerole", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetServiceRoleForAccountRequest" + }, + "output" : { + "shape" : "GetServiceRoleForAccountResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retrieves the service role that is attached to your account." + }, + "GetSubscriptionDefinition" : { + "name" : "GetSubscriptionDefinition", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetSubscriptionDefinitionRequest" + }, + "output" : { + "shape" : "GetSubscriptionDefinitionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a subscription definition." + }, + "GetSubscriptionDefinitionVersion" : { + "name" : "GetSubscriptionDefinitionVersion", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions/{SubscriptionDefinitionVersionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetSubscriptionDefinitionVersionRequest" + }, + "output" : { + "shape" : "GetSubscriptionDefinitionVersionResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves information about a subscription definition version." + }, + "ListBulkDeploymentDetailedReports" : { + "name" : "ListBulkDeploymentDetailedReports", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/bulk/deployments/{BulkDeploymentId}/detailed-reports", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListBulkDeploymentDetailedReportsRequest" + }, + "output" : { + "shape" : "ListBulkDeploymentDetailedReportsResponse", + "documentation" : "Success. The response body contains the list of deployments for the given group." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status." + }, + "ListBulkDeployments" : { + "name" : "ListBulkDeployments", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/bulk/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListBulkDeploymentsRequest" + }, + "output" : { + "shape" : "ListBulkDeploymentsResponse", + "documentation" : "Success. The response body contains the list of bulk deployments." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Returns a list of bulk deployments." + }, + "ListConnectorDefinitionVersions" : { + "name" : "ListConnectorDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListConnectorDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListConnectorDefinitionVersionsResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services." + }, + "ListConnectorDefinitions" : { + "name" : "ListConnectorDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/connectors", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListConnectorDefinitionsRequest" + }, + "output" : { + "shape" : "ListConnectorDefinitionsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of connector definitions." + }, + "ListCoreDefinitionVersions" : { + "name" : "ListCoreDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListCoreDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListCoreDefinitionVersionsResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a core definition." + }, + "ListCoreDefinitions" : { + "name" : "ListCoreDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/cores", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListCoreDefinitionsRequest" + }, + "output" : { + "shape" : "ListCoreDefinitionsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of core definitions." + }, + "ListDeployments" : { + "name" : "ListDeployments", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListDeploymentsRequest" + }, + "output" : { + "shape" : "ListDeploymentsResponse", + "documentation" : "Success. The response body contains the list of deployments for the given group." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Returns a history of deployments for the group." + }, + "ListDeviceDefinitionVersions" : { + "name" : "ListDeviceDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListDeviceDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListDeviceDefinitionVersionsResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a device definition." + }, + "ListDeviceDefinitions" : { + "name" : "ListDeviceDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/devices", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListDeviceDefinitionsRequest" + }, + "output" : { + "shape" : "ListDeviceDefinitionsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of device definitions." + }, + "ListFunctionDefinitionVersions" : { + "name" : "ListFunctionDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListFunctionDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListFunctionDefinitionVersionsResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a Lambda function definition." + }, + "ListFunctionDefinitions" : { + "name" : "ListFunctionDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/functions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListFunctionDefinitionsRequest" + }, + "output" : { + "shape" : "ListFunctionDefinitionsResponse", + "documentation" : "Success. The response contains the IDs of all the Greengrass Lambda function definitions in this account." + }, + "errors" : [ ], + "documentation" : "Retrieves a list of Lambda function definitions." + }, + "ListGroupCertificateAuthorities" : { + "name" : "ListGroupCertificateAuthorities", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/certificateauthorities", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListGroupCertificateAuthoritiesRequest" + }, + "output" : { + "shape" : "ListGroupCertificateAuthoritiesResponse", + "documentation" : "Success. The response body contains the PKI Configuration." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Retrieves the current CAs for a group." + }, + "ListGroupVersions" : { + "name" : "ListGroupVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups/{GroupId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListGroupVersionsRequest" + }, + "output" : { + "shape" : "ListGroupVersionsResponse", + "documentation" : "Success. The response contains the list of versions and metadata for the given group." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a group." + }, + "ListGroups" : { + "name" : "ListGroups", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/groups", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListGroupsRequest" + }, + "output" : { + "shape" : "ListGroupsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of groups." + }, + "ListLoggerDefinitionVersions" : { + "name" : "ListLoggerDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListLoggerDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListLoggerDefinitionVersionsResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a logger definition." + }, + "ListLoggerDefinitions" : { + "name" : "ListLoggerDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/loggers", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListLoggerDefinitionsRequest" + }, + "output" : { + "shape" : "ListLoggerDefinitionsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of logger definitions." + }, + "ListResourceDefinitionVersions" : { + "name" : "ListResourceDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListResourceDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListResourceDefinitionVersionsResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a resource definition." + }, + "ListResourceDefinitions" : { + "name" : "ListResourceDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/resources", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListResourceDefinitionsRequest" + }, + "output" : { + "shape" : "ListResourceDefinitionsResponse", + "documentation" : "The IDs of all the Greengrass resource definitions in this account." + }, + "errors" : [ ], + "documentation" : "Retrieves a list of resource definitions." + }, + "ListSubscriptionDefinitionVersions" : { + "name" : "ListSubscriptionDefinitionVersions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListSubscriptionDefinitionVersionsRequest" + }, + "output" : { + "shape" : "ListSubscriptionDefinitionVersionsResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Lists the versions of a subscription definition." + }, + "ListSubscriptionDefinitions" : { + "name" : "ListSubscriptionDefinitions", + "http" : { + "method" : "GET", + "requestUri" : "/greengrass/definition/subscriptions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListSubscriptionDefinitionsRequest" + }, + "output" : { + "shape" : "ListSubscriptionDefinitionsResponse" + }, + "errors" : [ ], + "documentation" : "Retrieves a list of subscription definitions." + }, + "ListTagsForResource" : { + "name" : "ListTagsForResource", + "http" : { + "method" : "GET", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListTagsForResourceRequest" + }, + "output" : { + "shape" : "ListTagsForResourceResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Retrieves a list of resource tags for a resource arn." + }, + "ResetDeployments" : { + "name" : "ResetDeployments", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/groups/{GroupId}/deployments/$reset", + "responseCode" : 200 + }, + "input" : { + "shape" : "ResetDeploymentsRequest" + }, + "output" : { + "shape" : "ResetDeploymentsResponse", + "documentation" : "Success. The group's deployments were reset." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Resets a group's deployments." + }, + "StartBulkDeployment" : { + "name" : "StartBulkDeployment", + "http" : { + "method" : "POST", + "requestUri" : "/greengrass/bulk/deployments", + "responseCode" : 200 + }, + "input" : { + "shape" : "StartBulkDeploymentRequest" + }, + "output" : { + "shape" : "StartBulkDeploymentResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Deploys multiple groups in one operation. This action starts the bulk deployment of a specified set of group versions. Each group version deployment will be triggered with an adaptive rate that has a fixed upper limit. We recommend that you include an ''X-Amzn-Client-Token'' token in every ''StartBulkDeployment'' request. These requests are idempotent with respect to the token and the request parameters." + }, + "StopBulkDeployment" : { + "name" : "StopBulkDeployment", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/bulk/deployments/{BulkDeploymentId}/$stop", + "responseCode" : 200 + }, + "input" : { + "shape" : "StopBulkDeploymentRequest" + }, + "output" : { + "shape" : "StopBulkDeploymentResponse", + "documentation" : "Success. The bulk deployment is being stopped." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments." + }, + "TagResource" : { + "name" : "TagResource", + "http" : { + "method" : "POST", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "TagResourceRequest" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Adds tags to a Greengrass resource. Valid resources are 'Group', 'ConnectorDefinition', 'CoreDefinition', 'DeviceDefinition', 'FunctionDefinition', 'LoggerDefinition', 'SubscriptionDefinition', 'ResourceDefinition', and 'BulkDeployment'." + }, + "UntagResource" : { + "name" : "UntagResource", + "http" : { + "method" : "DELETE", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "UntagResourceRequest" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Remove resource tags from a Greengrass Resource." + }, + "UpdateConnectivityInfo" : { + "name" : "UpdateConnectivityInfo", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/things/{ThingName}/connectivityInfo", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateConnectivityInfoRequest" + }, + "output" : { + "shape" : "UpdateConnectivityInfoResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Updates the connectivity information for the core. Any devices that belong to the group which has this core will receive this information in order to find the location of the core and connect to it." + }, + "UpdateConnectorDefinition" : { + "name" : "UpdateConnectorDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/connectors/{ConnectorDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateConnectorDefinitionRequest" + }, + "output" : { + "shape" : "UpdateConnectorDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a connector definition." + }, + "UpdateCoreDefinition" : { + "name" : "UpdateCoreDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/cores/{CoreDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateCoreDefinitionRequest" + }, + "output" : { + "shape" : "UpdateCoreDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a core definition." + }, + "UpdateDeviceDefinition" : { + "name" : "UpdateDeviceDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/devices/{DeviceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDeviceDefinitionRequest" + }, + "output" : { + "shape" : "UpdateDeviceDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a device definition." + }, + "UpdateFunctionDefinition" : { + "name" : "UpdateFunctionDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/functions/{FunctionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateFunctionDefinitionRequest" + }, + "output" : { + "shape" : "UpdateFunctionDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a Lambda function definition." + }, + "UpdateGroup" : { + "name" : "UpdateGroup", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/groups/{GroupId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateGroupRequest" + }, + "output" : { + "shape" : "UpdateGroupResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a group." + }, + "UpdateGroupCertificateConfiguration" : { + "name" : "UpdateGroupCertificateConfiguration", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/groups/{GroupId}/certificateauthorities/configuration/expiry", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateGroupCertificateConfigurationRequest" + }, + "output" : { + "shape" : "UpdateGroupCertificateConfigurationResponse", + "documentation" : "Success. The response body contains the PKI Configuration." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + }, { + "shape" : "InternalServerErrorException", + "documentation" : "server error" + } ], + "documentation" : "Updates the Certificate expiry time for a group." + }, + "UpdateLoggerDefinition" : { + "name" : "UpdateLoggerDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/loggers/{LoggerDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateLoggerDefinitionRequest" + }, + "output" : { + "shape" : "UpdateLoggerDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a logger definition." + }, + "UpdateResourceDefinition" : { + "name" : "UpdateResourceDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/resources/{ResourceDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateResourceDefinitionRequest" + }, + "output" : { + "shape" : "UpdateResourceDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a resource definition." + }, + "UpdateSubscriptionDefinition" : { + "name" : "UpdateSubscriptionDefinition", + "http" : { + "method" : "PUT", + "requestUri" : "/greengrass/definition/subscriptions/{SubscriptionDefinitionId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateSubscriptionDefinitionRequest" + }, + "output" : { + "shape" : "UpdateSubscriptionDefinitionResponse", + "documentation" : "success" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "invalid request" + } ], + "documentation" : "Updates a subscription definition." + } + }, + "shapes" : { + "AssociateRoleToGroupRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "RoleArn" : { + "shape" : "__string", + "documentation" : "The ARN of the role you wish to associate with this group. The existence of the role is not validated." + } + }, + "required" : [ "GroupId", "RoleArn" ] + }, + "AssociateRoleToGroupResponse" : { + "type" : "structure", + "members" : { + "AssociatedAt" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the role ARN was associated with the group." + } + } + }, + "AssociateServiceRoleToAccountRequest" : { + "type" : "structure", + "members" : { + "RoleArn" : { + "shape" : "__string", + "documentation" : "The ARN of the service role you wish to associate with your account." + } + }, + "required" : [ "RoleArn" ] + }, + "AssociateServiceRoleToAccountResponse" : { + "type" : "structure", + "members" : { + "AssociatedAt" : { + "shape" : "__string", + "documentation" : "The time when the service role was associated with the account." + } + } + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Details about the error." + }, + "Message" : { + "shape" : "__string", + "documentation" : "A message containing information about the error." + } + }, + "documentation" : "General error information.", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "BulkDeployment" : { + "type" : "structure", + "members" : { + "BulkDeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the bulk deployment." + }, + "BulkDeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the bulk deployment." + }, + "CreatedAt" : { + "shape" : "__string", + "documentation" : "The time, in ISO format, when the deployment was created." + } + }, + "documentation" : "Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state." + }, + "BulkDeploymentMetrics" : { + "type" : "structure", + "members" : { + "InvalidInputRecords" : { + "shape" : "__integer", + "documentation" : "The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version." + }, + "RecordsProcessed" : { + "shape" : "__integer", + "documentation" : "The total number of group records from the input file that have been processed so far, or attempted." + }, + "RetryAttempts" : { + "shape" : "__integer", + "documentation" : "The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. ''StartBulkDeployment'' retries a group deployment up to five times." + } + }, + "documentation" : "Relevant metrics on input records processed during bulk deployment." + }, + "BulkDeploymentResult" : { + "type" : "structure", + "members" : { + "CreatedAt" : { + "shape" : "__string", + "documentation" : "The time, in ISO format, when the deployment was created." + }, + "DeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the group deployment." + }, + "DeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the group deployment." + }, + "DeploymentStatus" : { + "shape" : "__string", + "documentation" : "The current status of the group deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''." + }, + "DeploymentType" : { + "shape" : "DeploymentType", + "documentation" : "The type of the deployment." + }, + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Details about the error." + }, + "ErrorMessage" : { + "shape" : "__string", + "documentation" : "The error message for a failed deployment" + }, + "GroupArn" : { + "shape" : "__string", + "documentation" : "The ARN of the Greengrass group." + } + }, + "documentation" : "Information about an individual group deployment in a bulk deployment operation." + }, + "BulkDeploymentResults" : { + "type" : "list", + "member" : { + "shape" : "BulkDeploymentResult" + } + }, + "BulkDeploymentStatus" : { + "type" : "string", + "documentation" : "The current status of the bulk deployment.", + "enum" : [ "Initializing", "Running", "Completed", "Stopping", "Stopped", "Failed" ] + }, + "BulkDeployments" : { + "type" : "list", + "member" : { + "shape" : "BulkDeployment" + } + }, + "ConnectivityInfo" : { + "type" : "structure", + "members" : { + "HostAddress" : { + "shape" : "__string", + "documentation" : "The endpoint for the Greengrass core. Can be an IP address or DNS." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the connectivity information." + }, + "Metadata" : { + "shape" : "__string", + "documentation" : "Metadata for this endpoint." + }, + "PortNumber" : { + "shape" : "__integer", + "documentation" : "The port of the Greengrass core. Usually 8883." + } + }, + "documentation" : "Information about a Greengrass core's connectivity." + }, + "Connector" : { + "type" : "structure", + "members" : { + "ConnectorArn" : { + "shape" : "__string", + "documentation" : "The ARN of the connector." + }, + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Max length is 128 characters with pattern [a-zA-Z0-9:_-]+." + }, + "Parameters" : { + "shape" : "__mapOf__string", + "documentation" : "The parameters or configuration that the connector uses." + } + }, + "documentation" : "Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.", + "required" : [ "ConnectorArn", "Id" ] + }, + "ConnectorDefinitionVersion" : { + "type" : "structure", + "members" : { + "Connectors" : { + "shape" : "__listOfConnector", + "documentation" : "A list of references to connectors in this version, with their corresponding configuration settings." + } + }, + "documentation" : "Information about the connector definition version, which is a container for connectors." + }, + "Core" : { + "type" : "structure", + "members" : { + "CertificateArn" : { + "shape" : "__string", + "documentation" : "The ARN of the certificate associated with the core." + }, + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''." + }, + "SyncShadow" : { + "shape" : "__boolean", + "documentation" : "If true, the core's local shadow is automatically synced with the cloud." + }, + "ThingArn" : { + "shape" : "__string", + "documentation" : "The ARN of the thing which is the core." + } + }, + "documentation" : "Information about a core.", + "required" : [ "ThingArn", "Id", "CertificateArn" ] + }, + "CoreDefinitionVersion" : { + "type" : "structure", + "members" : { + "Cores" : { + "shape" : "__listOfCore", + "documentation" : "A list of cores in the core definition version." + } + }, + "documentation" : "Information about a core definition version." + }, + "CreateConnectorDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "ConnectorDefinitionVersion", + "documentation" : "Information about the initial version of the connector definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the connector definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateConnectorDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateConnectorDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + }, + "Connectors" : { + "shape" : "__listOfConnector", + "documentation" : "A list of references to connectors in this version, with their corresponding configuration settings." + } + }, + "required" : [ "ConnectorDefinitionId" ] + }, + "CreateConnectorDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateCoreDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "CoreDefinitionVersion", + "documentation" : "Information about the initial version of the core definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the core definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + }, + "documentation" : "Information needed to create a core definition." + }, + "CreateCoreDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateCoreDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + }, + "Cores" : { + "shape" : "__listOfCore", + "documentation" : "A list of cores in the core definition version." + } + }, + "required" : [ "CoreDefinitionId" ] + }, + "CreateCoreDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateDeploymentRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "DeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the deployment if you wish to redeploy a previous deployment." + }, + "DeploymentType" : { + "shape" : "DeploymentType", + "documentation" : "The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "GroupVersionId" : { + "shape" : "__string", + "documentation" : "The ID of the group version to be deployed." + } + }, + "required" : [ "GroupId", "DeploymentType" ] + }, + "CreateDeploymentResponse" : { + "type" : "structure", + "members" : { + "DeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the deployment." + }, + "DeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the deployment." + } + } + }, + "CreateDeviceDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "DeviceDefinitionVersion", + "documentation" : "Information about the initial version of the device definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the device definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateDeviceDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateDeviceDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + }, + "Devices" : { + "shape" : "__listOfDevice", + "documentation" : "A list of devices in the definition version." + } + }, + "required" : [ "DeviceDefinitionId" ] + }, + "CreateDeviceDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateFunctionDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "FunctionDefinitionVersion", + "documentation" : "Information about the initial version of the function definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the function definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateFunctionDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateFunctionDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "DefaultConfig" : { + "shape" : "FunctionDefaultConfig", + "documentation" : "The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings." + }, + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + }, + "Functions" : { + "shape" : "__listOfFunction", + "documentation" : "A list of Lambda functions in this function definition version." + } + }, + "documentation" : "Information needed to create a function definition version.", + "required" : [ "FunctionDefinitionId" ] + }, + "CreateFunctionDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateGroupCertificateAuthorityRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "CreateGroupCertificateAuthorityResponse" : { + "type" : "structure", + "members" : { + "GroupCertificateAuthorityArn" : { + "shape" : "__string", + "documentation" : "The ARN of the group certificate authority." + } + } + }, + "CreateGroupRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "GroupVersion", + "documentation" : "Information about the initial version of the group." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the group." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateGroupResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateGroupVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "ConnectorDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the connector definition version for this group." + }, + "CoreDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the core definition version for this group." + }, + "DeviceDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the device definition version for this group." + }, + "FunctionDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the function definition version for this group." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "LoggerDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the logger definition version for this group." + }, + "ResourceDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the resource definition version for this group." + }, + "SubscriptionDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the subscription definition version for this group." + } + }, + "required" : [ "GroupId" ] + }, + "CreateGroupVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateLoggerDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "LoggerDefinitionVersion", + "documentation" : "Information about the initial version of the logger definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the logger definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateLoggerDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateLoggerDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + }, + "Loggers" : { + "shape" : "__listOfLogger", + "documentation" : "A list of loggers." + } + }, + "required" : [ "LoggerDefinitionId" ] + }, + "CreateLoggerDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateResourceDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "ResourceDefinitionVersion", + "documentation" : "Information about the initial version of the resource definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the resource definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateResourceDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateResourceDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + }, + "Resources" : { + "shape" : "__listOfResource", + "documentation" : "A list of resources." + } + }, + "required" : [ "ResourceDefinitionId" ] + }, + "CreateResourceDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "CreateSoftwareUpdateJobRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "S3UrlSignerRole" : { + "shape" : "S3UrlSignerRole" + }, + "SoftwareToUpdate" : { + "shape" : "SoftwareToUpdate" + }, + "UpdateAgentLogLevel" : { + "shape" : "UpdateAgentLogLevel" + }, + "UpdateTargets" : { + "shape" : "UpdateTargets" + }, + "UpdateTargetsArchitecture" : { + "shape" : "UpdateTargetsArchitecture" + }, + "UpdateTargetsOperatingSystem" : { + "shape" : "UpdateTargetsOperatingSystem" + } + }, + "required" : [ "S3UrlSignerRole", "UpdateTargetsArchitecture", "SoftwareToUpdate", "UpdateTargets", "UpdateTargetsOperatingSystem" ] + }, + "CreateSoftwareUpdateJobResponse" : { + "type" : "structure", + "members" : { + "IotJobArn" : { + "shape" : "__string", + "documentation" : "The IoT Job ARN corresponding to this update." + }, + "IotJobId" : { + "shape" : "__string", + "documentation" : "The IoT Job Id corresponding to this update." + }, + "PlatformSoftwareVersion" : { + "shape" : "__string", + "documentation" : "The software version installed on the device or devices after the update." + } + } + }, + "CreateSubscriptionDefinitionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "InitialVersion" : { + "shape" : "SubscriptionDefinitionVersion", + "documentation" : "Information about the initial version of the subscription definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the subscription definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + } + }, + "CreateSubscriptionDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + } + }, + "CreateSubscriptionDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + }, + "Subscriptions" : { + "shape" : "__listOfSubscription", + "documentation" : "A list of subscriptions." + } + }, + "required" : [ "SubscriptionDefinitionId" ] + }, + "CreateSubscriptionDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The unique ID of the version." + } + } + }, + "DefinitionInformation" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "Tags" : { + "shape" : "Tags", + "locationName" : "tags", + "documentation" : "Tag(s) attached to the resource arn." + } + }, + "documentation" : "Information about a definition." + }, + "DeleteConnectorDefinitionRequest" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + } + }, + "required" : [ "ConnectorDefinitionId" ] + }, + "DeleteConnectorDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteCoreDefinitionRequest" : { + "type" : "structure", + "members" : { + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + } + }, + "required" : [ "CoreDefinitionId" ] + }, + "DeleteCoreDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteDeviceDefinitionRequest" : { + "type" : "structure", + "members" : { + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + } + }, + "required" : [ "DeviceDefinitionId" ] + }, + "DeleteDeviceDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteFunctionDefinitionRequest" : { + "type" : "structure", + "members" : { + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + } + }, + "required" : [ "FunctionDefinitionId" ] + }, + "DeleteFunctionDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteGroupRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "DeleteGroupResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteLoggerDefinitionRequest" : { + "type" : "structure", + "members" : { + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + } + }, + "required" : [ "LoggerDefinitionId" ] + }, + "DeleteLoggerDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteResourceDefinitionRequest" : { + "type" : "structure", + "members" : { + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + } + }, + "required" : [ "ResourceDefinitionId" ] + }, + "DeleteResourceDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "DeleteSubscriptionDefinitionRequest" : { + "type" : "structure", + "members" : { + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + } + }, + "required" : [ "SubscriptionDefinitionId" ] + }, + "DeleteSubscriptionDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "Deployment" : { + "type" : "structure", + "members" : { + "CreatedAt" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the deployment was created." + }, + "DeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the deployment." + }, + "DeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the deployment." + }, + "DeploymentType" : { + "shape" : "DeploymentType", + "documentation" : "The type of the deployment." + }, + "GroupArn" : { + "shape" : "__string", + "documentation" : "The ARN of the group for this deployment." + } + }, + "documentation" : "Information about a deployment." + }, + "DeploymentType" : { + "type" : "string", + "documentation" : "The type of deployment. When used for ''CreateDeployment'', only ''NewDeployment'' and ''Redeployment'' are valid.", + "enum" : [ "NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment" ] + }, + "Deployments" : { + "type" : "list", + "member" : { + "shape" : "Deployment" + } + }, + "Device" : { + "type" : "structure", + "members" : { + "CertificateArn" : { + "shape" : "__string", + "documentation" : "The ARN of the certificate associated with the device." + }, + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''." + }, + "SyncShadow" : { + "shape" : "__boolean", + "documentation" : "If true, the device's local shadow will be automatically synced with the cloud." + }, + "ThingArn" : { + "shape" : "__string", + "documentation" : "The thing ARN of the device." + } + }, + "documentation" : "Information about a device.", + "required" : [ "ThingArn", "Id", "CertificateArn" ] + }, + "DeviceDefinitionVersion" : { + "type" : "structure", + "members" : { + "Devices" : { + "shape" : "__listOfDevice", + "documentation" : "A list of devices in the definition version." + } + }, + "documentation" : "Information about a device definition version." + }, + "DisassociateRoleFromGroupRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "DisassociateRoleFromGroupResponse" : { + "type" : "structure", + "members" : { + "DisassociatedAt" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the role was disassociated from the group." + } + } + }, + "DisassociateServiceRoleFromAccountRequest" : { + "type" : "structure", + "members" : { } + }, + "DisassociateServiceRoleFromAccountResponse" : { + "type" : "structure", + "members" : { + "DisassociatedAt" : { + "shape" : "__string", + "documentation" : "The time when the service role was disassociated from the account." + } + } + }, + "Empty" : { + "type" : "structure", + "members" : { }, + "documentation" : "Empty" + }, + "EncodingType" : { + "type" : "string", + "enum" : [ "binary", "json" ] + }, + "ErrorDetail" : { + "type" : "structure", + "members" : { + "DetailedErrorCode" : { + "shape" : "__string", + "documentation" : "A detailed error code." + }, + "DetailedErrorMessage" : { + "shape" : "__string", + "documentation" : "A detailed error message." + } + }, + "documentation" : "Details about the error." + }, + "ErrorDetails" : { + "type" : "list", + "documentation" : "A list of error details.", + "member" : { + "shape" : "ErrorDetail" + } + }, + "Function" : { + "type" : "structure", + "members" : { + "FunctionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the Lambda function." + }, + "FunctionConfiguration" : { + "shape" : "FunctionConfiguration", + "documentation" : "The configuration of the Lambda function." + }, + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''." + } + }, + "documentation" : "Information about a Lambda function.", + "required" : [ "Id" ] + }, + "FunctionConfiguration" : { + "type" : "structure", + "members" : { + "EncodingType" : { + "shape" : "EncodingType", + "documentation" : "The expected encoding type of the input payload for the function. The default is ''json''." + }, + "Environment" : { + "shape" : "FunctionConfigurationEnvironment", + "documentation" : "The environment configuration of the function." + }, + "ExecArgs" : { + "shape" : "__string", + "documentation" : "The execution arguments." + }, + "Executable" : { + "shape" : "__string", + "documentation" : "The name of the function executable." + }, + "MemorySize" : { + "shape" : "__integer", + "documentation" : "The memory size, in KB, which the function requires. This setting is not applicable and should be cleared when you run the Lambda function without containerization." + }, + "Pinned" : { + "shape" : "__boolean", + "documentation" : "True if the function is pinned. Pinned means the function is long-lived and starts when the core starts." + }, + "Timeout" : { + "shape" : "__integer", + "documentation" : "The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request." + } + }, + "documentation" : "The configuration of the Lambda function." + }, + "FunctionConfigurationEnvironment" : { + "type" : "structure", + "members" : { + "AccessSysfs" : { + "shape" : "__boolean", + "documentation" : "If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container." + }, + "Execution" : { + "shape" : "FunctionExecutionConfig", + "documentation" : "Configuration related to executing the Lambda function" + }, + "ResourceAccessPolicies" : { + "shape" : "__listOfResourceAccessPolicy", + "documentation" : "A list of the resources, with their permissions, to which the Lambda function will be granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies apply only when you run the Lambda function in a Greengrass container." + }, + "Variables" : { + "shape" : "__mapOf__string", + "documentation" : "Environment variables for the Lambda function's configuration." + } + }, + "documentation" : "The environment configuration of the function." + }, + "FunctionDefaultConfig" : { + "type" : "structure", + "members" : { + "Execution" : { + "shape" : "FunctionDefaultExecutionConfig" + } + }, + "documentation" : "The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings." + }, + "FunctionDefaultExecutionConfig" : { + "type" : "structure", + "members" : { + "IsolationMode" : { + "shape" : "FunctionIsolationMode" + }, + "RunAs" : { + "shape" : "FunctionRunAsConfig" + } + }, + "documentation" : "Configuration information that specifies how a Lambda function runs. " + }, + "FunctionDefinitionVersion" : { + "type" : "structure", + "members" : { + "DefaultConfig" : { + "shape" : "FunctionDefaultConfig", + "documentation" : "The default configuration that applies to all Lambda functions in this function definition version. Individual Lambda functions can override these settings." + }, + "Functions" : { + "shape" : "__listOfFunction", + "documentation" : "A list of Lambda functions in this function definition version." + } + }, + "documentation" : "Information about a function definition version." + }, + "FunctionExecutionConfig" : { + "type" : "structure", + "members" : { + "IsolationMode" : { + "shape" : "FunctionIsolationMode" + }, + "RunAs" : { + "shape" : "FunctionRunAsConfig" + } + }, + "documentation" : "Configuration information that specifies how a Lambda function runs. " + }, + "FunctionIsolationMode" : { + "type" : "string", + "documentation" : "Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.", + "enum" : [ "GreengrassContainer", "NoContainer" ] + }, + "FunctionRunAsConfig" : { + "type" : "structure", + "members" : { + "Gid" : { + "shape" : "__integer", + "documentation" : "The group ID whose permissions are used to run a Lambda function." + }, + "Uid" : { + "shape" : "__integer", + "documentation" : "The user ID whose permissions are used to run a Lambda function." + } + }, + "documentation" : "Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. We recommend that you avoid running as root unless absolutely necessary to minimize the risk of unintended changes or malicious attacks. To run as root, you must set ''IsolationMode'' to ''NoContainer'' and update config.json in ''greengrass-root/config'' to set ''allowFunctionsToRunAsRoot'' to ''yes''." + }, + "GeneralError" : { + "type" : "structure", + "members" : { + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Details about the error." + }, + "Message" : { + "shape" : "__string", + "documentation" : "A message containing information about the error." + } + }, + "documentation" : "General error information." + }, + "GetAssociatedRoleRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "GetAssociatedRoleResponse" : { + "type" : "structure", + "members" : { + "AssociatedAt" : { + "shape" : "__string", + "documentation" : "The time when the role was associated with the group." + }, + "RoleArn" : { + "shape" : "__string", + "documentation" : "The ARN of the role that is associated with the group." + } + } + }, + "GetBulkDeploymentStatusRequest" : { + "type" : "structure", + "members" : { + "BulkDeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "BulkDeploymentId", + "documentation" : "The ID of the bulk deployment." + } + }, + "required" : [ "BulkDeploymentId" ] + }, + "GetBulkDeploymentStatusResponse" : { + "type" : "structure", + "members" : { + "BulkDeploymentMetrics" : { + "shape" : "BulkDeploymentMetrics", + "documentation" : "Relevant metrics on input records processed during bulk deployment." + }, + "BulkDeploymentStatus" : { + "shape" : "BulkDeploymentStatus", + "documentation" : "The status of the bulk deployment." + }, + "CreatedAt" : { + "shape" : "__string", + "documentation" : "The time, in ISO format, when the deployment was created." + }, + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Error details" + }, + "ErrorMessage" : { + "shape" : "__string", + "documentation" : "Error message" + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetConnectivityInfoRequest" : { + "type" : "structure", + "members" : { + "ThingName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ThingName", + "documentation" : "The thing name." + } + }, + "required" : [ "ThingName" ] + }, + "GetConnectivityInfoResponse" : { + "type" : "structure", + "members" : { + "ConnectivityInfo" : { + "shape" : "__listOfConnectivityInfo", + "documentation" : "Connectivity info list." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "A message about the connectivity info request." + } + } + }, + "GetConnectorDefinitionRequest" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + } + }, + "required" : [ "ConnectorDefinitionId" ] + }, + "GetConnectorDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetConnectorDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + }, + "ConnectorDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionVersionId", + "documentation" : "The ID of the connector definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListConnectorDefinitionVersions'' requests. If the version is the last one that was associated with a connector definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "ConnectorDefinitionId", "ConnectorDefinitionVersionId" ] + }, + "GetConnectorDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the connector definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the connector definition version was created." + }, + "Definition" : { + "shape" : "ConnectorDefinitionVersion", + "documentation" : "Information about the connector definition version." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the connector definition version." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the connector definition version." + } + } + }, + "GetCoreDefinitionRequest" : { + "type" : "structure", + "members" : { + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + } + }, + "required" : [ "CoreDefinitionId" ] + }, + "GetCoreDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetCoreDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + }, + "CoreDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionVersionId", + "documentation" : "The ID of the core definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListCoreDefinitionVersions'' requests. If the version is the last one that was associated with a core definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + } + }, + "required" : [ "CoreDefinitionId", "CoreDefinitionVersionId" ] + }, + "GetCoreDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the core definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the core definition version was created." + }, + "Definition" : { + "shape" : "CoreDefinitionVersion", + "documentation" : "Information about the core definition version." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the core definition version." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the core definition version." + } + } + }, + "GetDeploymentStatusRequest" : { + "type" : "structure", + "members" : { + "DeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeploymentId", + "documentation" : "The ID of the deployment." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId", "DeploymentId" ] + }, + "GetDeploymentStatusResponse" : { + "type" : "structure", + "members" : { + "DeploymentStatus" : { + "shape" : "__string", + "documentation" : "The status of the deployment: ''InProgress'', ''Building'', ''Success'', or ''Failure''." + }, + "DeploymentType" : { + "shape" : "DeploymentType", + "documentation" : "The type of the deployment." + }, + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Error details" + }, + "ErrorMessage" : { + "shape" : "__string", + "documentation" : "Error message" + }, + "UpdatedAt" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the deployment status was updated." + } + } + }, + "GetDeviceDefinitionRequest" : { + "type" : "structure", + "members" : { + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + } + }, + "required" : [ "DeviceDefinitionId" ] + }, + "GetDeviceDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetDeviceDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + }, + "DeviceDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionVersionId", + "documentation" : "The ID of the device definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListDeviceDefinitionVersions'' requests. If the version is the last one that was associated with a device definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "DeviceDefinitionVersionId", "DeviceDefinitionId" ] + }, + "GetDeviceDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the device definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the device definition version was created." + }, + "Definition" : { + "shape" : "DeviceDefinitionVersion", + "documentation" : "Information about the device definition version." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the device definition version." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the device definition version." + } + } + }, + "GetFunctionDefinitionRequest" : { + "type" : "structure", + "members" : { + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + } + }, + "required" : [ "FunctionDefinitionId" ] + }, + "GetFunctionDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetFunctionDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + }, + "FunctionDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionVersionId", + "documentation" : "The ID of the function definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListFunctionDefinitionVersions'' requests. If the version is the last one that was associated with a function definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "FunctionDefinitionId", "FunctionDefinitionVersionId" ] + }, + "GetFunctionDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the function definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the function definition version was created." + }, + "Definition" : { + "shape" : "FunctionDefinitionVersion", + "documentation" : "Information on the definition." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the function definition version." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the function definition version." + } + } + }, + "GetGroupCertificateAuthorityRequest" : { + "type" : "structure", + "members" : { + "CertificateAuthorityId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CertificateAuthorityId", + "documentation" : "The ID of the certificate authority." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "CertificateAuthorityId", "GroupId" ] + }, + "GetGroupCertificateAuthorityResponse" : { + "type" : "structure", + "members" : { + "GroupCertificateAuthorityArn" : { + "shape" : "__string", + "documentation" : "The ARN of the certificate authority for the group." + }, + "GroupCertificateAuthorityId" : { + "shape" : "__string", + "documentation" : "The ID of the certificate authority for the group." + }, + "PemEncodedCertificate" : { + "shape" : "__string", + "documentation" : "The PEM encoded certificate for the group." + } + } + }, + "GetGroupCertificateConfigurationRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "GetGroupCertificateConfigurationResponse" : { + "type" : "structure", + "members" : { + "CertificateAuthorityExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate authority expires, in milliseconds." + }, + "CertificateExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate expires, in milliseconds." + }, + "GroupId" : { + "shape" : "__string", + "documentation" : "The ID of the group certificate configuration." + } + } + }, + "GetGroupRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "GetGroupResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetGroupVersionRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "GroupVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupVersionId", + "documentation" : "The ID of the group version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListGroupVersions'' requests. If the version is the last one that was associated with a group, the value also maps to the ''LatestVersion'' property of the corresponding ''GroupInformation'' object." + } + }, + "required" : [ "GroupVersionId", "GroupId" ] + }, + "GetGroupVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the group version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the group version was created." + }, + "Definition" : { + "shape" : "GroupVersion", + "documentation" : "Information about the group version definition." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the group that the version is associated with." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The ID of the group version." + } + } + }, + "GetLoggerDefinitionRequest" : { + "type" : "structure", + "members" : { + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + } + }, + "required" : [ "LoggerDefinitionId" ] + }, + "GetLoggerDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetLoggerDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + }, + "LoggerDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionVersionId", + "documentation" : "The ID of the logger definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListLoggerDefinitionVersions'' requests. If the version is the last one that was associated with a logger definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "LoggerDefinitionVersionId", "LoggerDefinitionId" ] + }, + "GetLoggerDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the logger definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the logger definition version was created." + }, + "Definition" : { + "shape" : "LoggerDefinitionVersion", + "documentation" : "Information about the logger definition version." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the logger definition version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the logger definition version." + } + } + }, + "GetResourceDefinitionRequest" : { + "type" : "structure", + "members" : { + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + } + }, + "required" : [ "ResourceDefinitionId" ] + }, + "GetResourceDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetResourceDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + }, + "ResourceDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionVersionId", + "documentation" : "The ID of the resource definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListResourceDefinitionVersions'' requests. If the version is the last one that was associated with a resource definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + } + }, + "required" : [ "ResourceDefinitionVersionId", "ResourceDefinitionId" ] + }, + "GetResourceDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "Arn of the resource definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the resource definition version was created." + }, + "Definition" : { + "shape" : "ResourceDefinitionVersion", + "documentation" : "Information about the definition." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the resource definition version." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the resource definition version." + } + } + }, + "GetServiceRoleForAccountRequest" : { + "type" : "structure", + "members" : { } + }, + "GetServiceRoleForAccountResponse" : { + "type" : "structure", + "members" : { + "AssociatedAt" : { + "shape" : "__string", + "documentation" : "The time when the service role was associated with the account." + }, + "RoleArn" : { + "shape" : "__string", + "documentation" : "The ARN of the role which is associated with the account." + } + } + }, + "GetSubscriptionDefinitionRequest" : { + "type" : "structure", + "members" : { + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + } + }, + "required" : [ "SubscriptionDefinitionId" ] + }, + "GetSubscriptionDefinitionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the definition." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the definition." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the definition was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the definition." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) attached to the resource arn." + } + } + }, + "GetSubscriptionDefinitionVersionRequest" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + }, + "SubscriptionDefinitionVersionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionVersionId", + "documentation" : "The ID of the subscription definition version. This value maps to the ''Version'' property of the corresponding ''VersionInformation'' object, which is returned by ''ListSubscriptionDefinitionVersions'' requests. If the version is the last one that was associated with a subscription definition, the value also maps to the ''LatestVersion'' property of the corresponding ''DefinitionInformation'' object." + } + }, + "required" : [ "SubscriptionDefinitionId", "SubscriptionDefinitionVersionId" ] + }, + "GetSubscriptionDefinitionVersionResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the subscription definition version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the subscription definition version was created." + }, + "Definition" : { + "shape" : "SubscriptionDefinitionVersion", + "documentation" : "Information about the subscription definition version." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the subscription definition version." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The version of the subscription definition version." + } + } + }, + "GroupCertificateAuthorityProperties" : { + "type" : "structure", + "members" : { + "GroupCertificateAuthorityArn" : { + "shape" : "__string", + "documentation" : "The ARN of the certificate authority for the group." + }, + "GroupCertificateAuthorityId" : { + "shape" : "__string", + "documentation" : "The ID of the certificate authority for the group." + } + }, + "documentation" : "Information about a certificate authority for a group." + }, + "GroupCertificateConfiguration" : { + "type" : "structure", + "members" : { + "CertificateAuthorityExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate authority expires, in milliseconds." + }, + "CertificateExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate expires, in milliseconds." + }, + "GroupId" : { + "shape" : "__string", + "documentation" : "The ID of the group certificate configuration." + } + }, + "documentation" : "Information about a group certificate configuration." + }, + "GroupInformation" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the group." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the group was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the group." + }, + "LastUpdatedTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the group was last updated." + }, + "LatestVersion" : { + "shape" : "__string", + "documentation" : "The ID of the latest version associated with the group." + }, + "LatestVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the latest version associated with the group." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the group." + } + }, + "documentation" : "Information about a group." + }, + "GroupOwnerSetting" : { + "type" : "structure", + "members" : { + "AutoAddGroupOwner" : { + "shape" : "__boolean", + "documentation" : "If true, AWS IoT Greengrass automatically adds the specified Linux OS group owner of the resource to the Lambda process privileges. Thus the Lambda process will have the file access permissions of the added Linux group." + }, + "GroupOwner" : { + "shape" : "__string", + "documentation" : "The name of the Linux OS group whose privileges will be added to the Lambda process. This field is optional." + } + }, + "documentation" : "Group owner related settings for local resources." + }, + "GroupVersion" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the connector definition version for this group." + }, + "CoreDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the core definition version for this group." + }, + "DeviceDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the device definition version for this group." + }, + "FunctionDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the function definition version for this group." + }, + "LoggerDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the logger definition version for this group." + }, + "ResourceDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the resource definition version for this group." + }, + "SubscriptionDefinitionVersionArn" : { + "shape" : "__string", + "documentation" : "The ARN of the subscription definition version for this group." + } + }, + "documentation" : "Information about a group version." + }, + "InternalServerErrorException" : { + "type" : "structure", + "members" : { + "ErrorDetails" : { + "shape" : "ErrorDetails", + "documentation" : "Details about the error." + }, + "Message" : { + "shape" : "__string", + "documentation" : "A message containing information about the error." + } + }, + "documentation" : "General error information.", + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "ListBulkDeploymentDetailedReportsRequest" : { + "type" : "structure", + "members" : { + "BulkDeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "BulkDeploymentId", + "documentation" : "The ID of the bulk deployment." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "BulkDeploymentId" ] + }, + "ListBulkDeploymentDetailedReportsResponse" : { + "type" : "structure", + "members" : { + "Deployments" : { + "shape" : "BulkDeploymentResults", + "documentation" : "A list of the individual group deployments in the bulk deployment operation." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListBulkDeploymentsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListBulkDeploymentsResponse" : { + "type" : "structure", + "members" : { + "BulkDeployments" : { + "shape" : "BulkDeployments", + "documentation" : "A list of bulk deployments." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListConnectorDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "ConnectorDefinitionId" ] + }, + "ListConnectorDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListConnectorDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListConnectorDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListCoreDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "CoreDefinitionId" ] + }, + "ListCoreDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListCoreDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListCoreDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "documentation" : "A list of definitions." + }, + "ListDeploymentsRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "GroupId" ] + }, + "ListDeploymentsResponse" : { + "type" : "structure", + "members" : { + "Deployments" : { + "shape" : "Deployments", + "documentation" : "A list of deployments for the requested groups." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListDeviceDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "DeviceDefinitionId" ] + }, + "ListDeviceDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListDeviceDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListDeviceDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListFunctionDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "FunctionDefinitionId" ] + }, + "ListFunctionDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListFunctionDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListFunctionDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListGroupCertificateAuthoritiesRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "ListGroupCertificateAuthoritiesResponse" : { + "type" : "structure", + "members" : { + "GroupCertificateAuthorities" : { + "shape" : "__listOfGroupCertificateAuthorityProperties", + "documentation" : "A list of certificate authorities associated with the group." + } + } + }, + "ListGroupVersionsRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "GroupId" ] + }, + "ListGroupVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListGroupsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListGroupsResponse" : { + "type" : "structure", + "members" : { + "Groups" : { + "shape" : "__listOfGroupInformation", + "documentation" : "Information about a group." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListLoggerDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + }, + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + }, + "required" : [ "LoggerDefinitionId" ] + }, + "ListLoggerDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListLoggerDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListLoggerDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListResourceDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + } + }, + "required" : [ "ResourceDefinitionId" ] + }, + "ListResourceDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListResourceDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListResourceDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListSubscriptionDefinitionVersionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + } + }, + "required" : [ "SubscriptionDefinitionId" ] + }, + "ListSubscriptionDefinitionVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + } + }, + "ListSubscriptionDefinitionsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "MaxResults", + "documentation" : "The maximum number of results to be returned per request." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListSubscriptionDefinitionsResponse" : { + "type" : "structure", + "members" : { + "Definitions" : { + "shape" : "__listOfDefinitionInformation", + "documentation" : "Information about a definition." + }, + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + } + } + }, + "ListTagsForResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource." + } + }, + "required" : [ "ResourceArn" ] + }, + "ListTagsForResourceResponse" : { + "type" : "structure", + "members" : { + "tags" : { + "shape" : "Tags" + } + } + }, + "ListVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "documentation" : "The token for the next set of results, or ''null'' if there are no additional results." + }, + "Versions" : { + "shape" : "__listOfVersionInformation", + "documentation" : "Information about a version." + } + }, + "documentation" : "A list of versions." + }, + "LocalDeviceResourceData" : { + "type" : "structure", + "members" : { + "GroupOwnerSetting" : { + "shape" : "GroupOwnerSetting", + "documentation" : "Group/owner related settings for local resources." + }, + "SourcePath" : { + "shape" : "__string", + "documentation" : "The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under ''/dev''." + } + }, + "documentation" : "Attributes that define a local device resource." + }, + "LocalVolumeResourceData" : { + "type" : "structure", + "members" : { + "DestinationPath" : { + "shape" : "__string", + "documentation" : "The absolute local path of the resource inside the Lambda environment." + }, + "GroupOwnerSetting" : { + "shape" : "GroupOwnerSetting", + "documentation" : "Allows you to configure additional group privileges for the Lambda process. This field is optional." + }, + "SourcePath" : { + "shape" : "__string", + "documentation" : "The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with ''/sys''." + } + }, + "documentation" : "Attributes that define a local volume resource." + }, + "Logger" : { + "type" : "structure", + "members" : { + "Component" : { + "shape" : "LoggerComponent", + "documentation" : "The component that will be subject to logging." + }, + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''." + }, + "Level" : { + "shape" : "LoggerLevel", + "documentation" : "The level of the logs." + }, + "Space" : { + "shape" : "__integer", + "documentation" : "The amount of file space, in KB, to use if the local file system is used for logging purposes." + }, + "Type" : { + "shape" : "LoggerType", + "documentation" : "The type of log output which will be used." + } + }, + "documentation" : "Information about a logger", + "required" : [ "Type", "Level", "Id", "Component" ] + }, + "LoggerComponent" : { + "type" : "string", + "enum" : [ "GreengrassSystem", "Lambda" ] + }, + "LoggerDefinitionVersion" : { + "type" : "structure", + "members" : { + "Loggers" : { + "shape" : "__listOfLogger", + "documentation" : "A list of loggers." + } + }, + "documentation" : "Information about a logger definition version." + }, + "LoggerLevel" : { + "type" : "string", + "enum" : [ "DEBUG", "INFO", "WARN", "ERROR", "FATAL" ] + }, + "LoggerType" : { + "type" : "string", + "enum" : [ "FileSystem", "AWSCloudWatch" ] + }, + "Permission" : { + "type" : "string", + "documentation" : "The type of permission a function has to access a resource.", + "enum" : [ "ro", "rw" ] + }, + "ResetDeploymentsRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "Force" : { + "shape" : "__boolean", + "documentation" : "If true, performs a best-effort only core reset." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "documentation" : "Information needed to reset deployments.", + "required" : [ "GroupId" ] + }, + "ResetDeploymentsResponse" : { + "type" : "structure", + "members" : { + "DeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the deployment." + }, + "DeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the deployment." + } + } + }, + "Resource" : { + "type" : "structure", + "members" : { + "Id" : { + "shape" : "__string", + "documentation" : "The resource ID, used to refer to a resource in the Lambda function configuration. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Max length 128 characters with pattern ''[a-zA-Z0-9:_-]+''. This must be unique within a Greengrass group." + }, + "ResourceDataContainer" : { + "shape" : "ResourceDataContainer", + "documentation" : "A container of data for all resource types." + } + }, + "documentation" : "Information about a resource.", + "required" : [ "ResourceDataContainer", "Id", "Name" ] + }, + "ResourceAccessPolicy" : { + "type" : "structure", + "members" : { + "Permission" : { + "shape" : "Permission", + "documentation" : "The permissions that the Lambda function has to the resource. Can be one of ''rw'' (read/write) or ''ro'' (read-only)." + }, + "ResourceId" : { + "shape" : "__string", + "documentation" : "The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)" + } + }, + "documentation" : "A policy used by the function to access a resource.", + "required" : [ "ResourceId" ] + }, + "ResourceDataContainer" : { + "type" : "structure", + "members" : { + "LocalDeviceResourceData" : { + "shape" : "LocalDeviceResourceData", + "documentation" : "Attributes that define the local device resource." + }, + "LocalVolumeResourceData" : { + "shape" : "LocalVolumeResourceData", + "documentation" : "Attributes that define the local volume resource." + }, + "S3MachineLearningModelResourceData" : { + "shape" : "S3MachineLearningModelResourceData", + "documentation" : "Attributes that define an Amazon S3 machine learning resource." + }, + "SageMakerMachineLearningModelResourceData" : { + "shape" : "SageMakerMachineLearningModelResourceData", + "documentation" : "Attributes that define an Amazon SageMaker machine learning resource." + }, + "SecretsManagerSecretResourceData" : { + "shape" : "SecretsManagerSecretResourceData", + "documentation" : "Attributes that define a secret resource, which references a secret from AWS Secrets Manager." + } + }, + "documentation" : "A container for resource data. The container takes only one of the following supported resource data types: ''LocalDeviceResourceData'', ''LocalVolumeResourceData'', ''SageMakerMachineLearningModelResourceData'', ''S3MachineLearningModelResourceData'', ''SecretsManagerSecretResourceData''." + }, + "ResourceDefinitionVersion" : { + "type" : "structure", + "members" : { + "Resources" : { + "shape" : "__listOfResource", + "documentation" : "A list of resources." + } + }, + "documentation" : "Information about a resource definition version." + }, + "S3MachineLearningModelResourceData" : { + "type" : "structure", + "members" : { + "DestinationPath" : { + "shape" : "__string", + "documentation" : "The absolute local path of the resource inside the Lambda environment." + }, + "S3Uri" : { + "shape" : "__string", + "documentation" : "The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format." + } + }, + "documentation" : "Attributes that define an Amazon S3 machine learning resource." + }, + "S3UrlSignerRole" : { + "type" : "string", + "documentation" : "The IAM Role that Greengrass will use to create pre-signed URLs pointing towards the update artifact." + }, + "SageMakerMachineLearningModelResourceData" : { + "type" : "structure", + "members" : { + "DestinationPath" : { + "shape" : "__string", + "documentation" : "The absolute local path of the resource inside the Lambda environment." + }, + "SageMakerJobArn" : { + "shape" : "__string", + "documentation" : "The ARN of the Amazon SageMaker training job that represents the source model." + } + }, + "documentation" : "Attributes that define an Amazon SageMaker machine learning resource." + }, + "SecretsManagerSecretResourceData" : { + "type" : "structure", + "members" : { + "ARN" : { + "shape" : "__string", + "documentation" : "The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the ''AWSCURRENT'' staging label) is included by default." + }, + "AdditionalStagingLabelsToDownload" : { + "shape" : "__listOf__string", + "documentation" : "Optional. The staging labels whose values you want to make available on the core, in addition to ''AWSCURRENT''." + } + }, + "documentation" : "Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions." + }, + "SoftwareToUpdate" : { + "type" : "string", + "documentation" : "The piece of software on the Greengrass core that will be updated.", + "enum" : [ "core", "ota_agent" ] + }, + "StartBulkDeploymentRequest" : { + "type" : "structure", + "members" : { + "AmznClientToken" : { + "shape" : "__string", + "location" : "header", + "locationName" : "X-Amzn-Client-Token", + "documentation" : "A client token used to correlate requests and responses." + }, + "ExecutionRoleArn" : { + "shape" : "__string", + "documentation" : "The ARN of the execution role to associate with the bulk deployment operation. This IAM role must allow the ''greengrass:CreateDeployment'' action for all group versions that are listed in the input file. This IAM role must have access to the S3 bucket containing the input file." + }, + "InputFileUri" : { + "shape" : "__string", + "documentation" : "The URI of the input file contained in the S3 bucket. The execution role must have ''getObject'' permissions on this bucket to access the input file. The input file is a JSON-serialized, line delimited file with UTF-8 encoding that provides a list of group and version IDs and the deployment type. This file must be less than 100 MB. Currently, AWS IoT Greengrass supports only ''NewDeployment'' deployment types." + }, + "tags" : { + "shape" : "Tags", + "documentation" : "Tag(s) to add to the new resource." + } + }, + "required" : [ "ExecutionRoleArn", "InputFileUri" ] + }, + "StartBulkDeploymentResponse" : { + "type" : "structure", + "members" : { + "BulkDeploymentArn" : { + "shape" : "__string", + "documentation" : "The ARN of the bulk deployment." + }, + "BulkDeploymentId" : { + "shape" : "__string", + "documentation" : "The ID of the bulk deployment." + } + } + }, + "StopBulkDeploymentRequest" : { + "type" : "structure", + "members" : { + "BulkDeploymentId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "BulkDeploymentId", + "documentation" : "The ID of the bulk deployment." + } + }, + "required" : [ "BulkDeploymentId" ] + }, + "StopBulkDeploymentResponse" : { + "type" : "structure", + "members" : { } + }, + "Subscription" : { + "type" : "structure", + "members" : { + "Id" : { + "shape" : "__string", + "documentation" : "A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Max length is 128 characters with pattern ''[a-zA-Z0-9:_-]+''." + }, + "Source" : { + "shape" : "__string", + "documentation" : "The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'." + }, + "Subject" : { + "shape" : "__string", + "documentation" : "The MQTT topic used to route the message." + }, + "Target" : { + "shape" : "__string", + "documentation" : "Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'." + } + }, + "documentation" : "Information about a subscription.", + "required" : [ "Target", "Id", "Subject", "Source" ] + }, + "SubscriptionDefinitionVersion" : { + "type" : "structure", + "members" : { + "Subscriptions" : { + "shape" : "__listOfSubscription", + "documentation" : "A list of subscriptions." + } + }, + "documentation" : "Information about a subscription definition version." + }, + "TagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource." + }, + "tags" : { + "shape" : "Tags" + } + }, + "documentation" : "A map of the key-value pairs for the resource tag.", + "required" : [ "ResourceArn" ] + }, + "Tags" : { + "type" : "map", + "documentation" : "The key-value pair for the resource tag.", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "UntagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource." + }, + "TagKeys" : { + "shape" : "__listOf__string", + "location" : "querystring", + "locationName" : "tagKeys", + "documentation" : "An array of tag keys to delete" + } + }, + "required" : [ "TagKeys", "ResourceArn" ] + }, + "UpdateAgentLogLevel" : { + "type" : "string", + "documentation" : "The minimum level of log statements that should be logged by the OTA Agent during an update.", + "enum" : [ "NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARN", "ERROR", "FATAL" ] + }, + "UpdateConnectivityInfoRequest" : { + "type" : "structure", + "members" : { + "ConnectivityInfo" : { + "shape" : "__listOfConnectivityInfo", + "documentation" : "A list of connectivity info." + }, + "ThingName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ThingName", + "documentation" : "The thing name." + } + }, + "documentation" : "Connectivity information.", + "required" : [ "ThingName" ] + }, + "UpdateConnectivityInfoResponse" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "A message about the connectivity info update request." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The new version of the connectivity info." + } + } + }, + "UpdateConnectorDefinitionRequest" : { + "type" : "structure", + "members" : { + "ConnectorDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConnectorDefinitionId", + "documentation" : "The ID of the connector definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "ConnectorDefinitionId" ] + }, + "UpdateConnectorDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateCoreDefinitionRequest" : { + "type" : "structure", + "members" : { + "CoreDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "CoreDefinitionId", + "documentation" : "The ID of the core definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "CoreDefinitionId" ] + }, + "UpdateCoreDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateDeviceDefinitionRequest" : { + "type" : "structure", + "members" : { + "DeviceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "DeviceDefinitionId", + "documentation" : "The ID of the device definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "DeviceDefinitionId" ] + }, + "UpdateDeviceDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateFunctionDefinitionRequest" : { + "type" : "structure", + "members" : { + "FunctionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "FunctionDefinitionId", + "documentation" : "The ID of the Lambda function definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "FunctionDefinitionId" ] + }, + "UpdateFunctionDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateGroupCertificateConfigurationRequest" : { + "type" : "structure", + "members" : { + "CertificateExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate expires, in milliseconds." + }, + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + } + }, + "required" : [ "GroupId" ] + }, + "UpdateGroupCertificateConfigurationResponse" : { + "type" : "structure", + "members" : { + "CertificateAuthorityExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate authority expires, in milliseconds." + }, + "CertificateExpiryInMilliseconds" : { + "shape" : "__string", + "documentation" : "The amount of time remaining before the certificate expires, in milliseconds." + }, + "GroupId" : { + "shape" : "__string", + "documentation" : "The ID of the group certificate configuration." + } + } + }, + "UpdateGroupRequest" : { + "type" : "structure", + "members" : { + "GroupId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "GroupId", + "documentation" : "The ID of the Greengrass group." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "GroupId" ] + }, + "UpdateGroupResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateLoggerDefinitionRequest" : { + "type" : "structure", + "members" : { + "LoggerDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "LoggerDefinitionId", + "documentation" : "The ID of the logger definition." + }, + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + } + }, + "required" : [ "LoggerDefinitionId" ] + }, + "UpdateLoggerDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateResourceDefinitionRequest" : { + "type" : "structure", + "members" : { + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "ResourceDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ResourceDefinitionId", + "documentation" : "The ID of the resource definition." + } + }, + "required" : [ "ResourceDefinitionId" ] + }, + "UpdateResourceDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateSubscriptionDefinitionRequest" : { + "type" : "structure", + "members" : { + "Name" : { + "shape" : "__string", + "documentation" : "The name of the definition." + }, + "SubscriptionDefinitionId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "SubscriptionDefinitionId", + "documentation" : "The ID of the subscription definition." + } + }, + "required" : [ "SubscriptionDefinitionId" ] + }, + "UpdateSubscriptionDefinitionResponse" : { + "type" : "structure", + "members" : { } + }, + "UpdateTargets" : { + "type" : "list", + "documentation" : "The ARNs of the targets (IoT things or IoT thing groups) that this update will be applied to.", + "member" : { + "shape" : "__string" + } + }, + "UpdateTargetsArchitecture" : { + "type" : "string", + "documentation" : "The architecture of the cores which are the targets of an update.", + "enum" : [ "armv6l", "armv7l", "x86_64", "aarch64", "openwrt" ] + }, + "UpdateTargetsOperatingSystem" : { + "type" : "string", + "documentation" : "The operating system of the cores which are the targets of an update.", + "enum" : [ "ubuntu", "raspbian", "amazon_linux" ] + }, + "VersionInformation" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "documentation" : "The ARN of the version." + }, + "CreationTimestamp" : { + "shape" : "__string", + "documentation" : "The time, in milliseconds since the epoch, when the version was created." + }, + "Id" : { + "shape" : "__string", + "documentation" : "The ID of the parent definition that the version is associated with." + }, + "Version" : { + "shape" : "__string", + "documentation" : "The ID of the version." + } + }, + "documentation" : "Information about a version." + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__listOfConnectivityInfo" : { + "type" : "list", + "member" : { + "shape" : "ConnectivityInfo" + } + }, + "__listOfConnector" : { + "type" : "list", + "member" : { + "shape" : "Connector" + } + }, + "__listOfCore" : { + "type" : "list", + "member" : { + "shape" : "Core" + } + }, + "__listOfDefinitionInformation" : { + "type" : "list", + "member" : { + "shape" : "DefinitionInformation" + } + }, + "__listOfDevice" : { + "type" : "list", + "member" : { + "shape" : "Device" + } + }, + "__listOfFunction" : { + "type" : "list", + "member" : { + "shape" : "Function" + } + }, + "__listOfGroupCertificateAuthorityProperties" : { + "type" : "list", + "member" : { + "shape" : "GroupCertificateAuthorityProperties" + } + }, + "__listOfGroupInformation" : { + "type" : "list", + "member" : { + "shape" : "GroupInformation" + } + }, + "__listOfLogger" : { + "type" : "list", + "member" : { + "shape" : "Logger" + } + }, + "__listOfResource" : { + "type" : "list", + "member" : { + "shape" : "Resource" + } + }, + "__listOfResourceAccessPolicy" : { + "type" : "list", + "member" : { + "shape" : "ResourceAccessPolicy" + } + }, + "__listOfSubscription" : { + "type" : "list", + "member" : { + "shape" : "Subscription" + } + }, + "__listOfVersionInformation" : { + "type" : "list", + "member" : { + "shape" : "VersionInformation" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__mapOf__string" : { + "type" : "map", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "documentation" : "AWS IoT Greengrass seamlessly extends AWS onto physical devices so they can act locally on the data they generate, while still using the cloud for management, analytics, and durable storage. AWS IoT Greengrass ensures your devices can respond quickly to local events and operate with intermittent connectivity. AWS IoT Greengrass minimizes the cost of transmitting data to the cloud by allowing you to author AWS Lambda functions that execute locally." +} \ No newline at end of file diff --git a/aws/dist/botocore/data/groundstation/2019-05-23/paginators-1.json b/aws/dist/botocore/data/groundstation/2019-05-23/paginators-1.json new file mode 100644 index 00000000..57a762b2 --- /dev/null +++ b/aws/dist/botocore/data/groundstation/2019-05-23/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListConfigs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "configList" + }, + "ListContacts": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "contactList" + }, + "ListDataflowEndpointGroups": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "dataflowEndpointGroupList" + }, + "ListMissionProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "missionProfileList" + }, + "ListGroundStations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "groundStationList" + }, + "ListSatellites": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "satellites" + } + } +} diff --git a/aws/dist/botocore/data/groundstation/2019-05-23/service-2.json b/aws/dist/botocore/data/groundstation/2019-05-23/service-2.json new file mode 100644 index 00000000..e5d3cc13 --- /dev/null +++ b/aws/dist/botocore/data/groundstation/2019-05-23/service-2.json @@ -0,0 +1,2355 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-05-23", + "endpointPrefix": "groundstation", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS Ground Station", + "serviceId": "GroundStation", + "signatureVersion": "v4", + "signingName": "groundstation", + "uid": "groundstation-2019-05-23" + }, + "documentation": "

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that\n enables you to control satellite communications, downlink and process satellite data, and\n scale your satellite operations efficiently and cost-effectively without having\n to build or manage your own ground station infrastructure.

", + "operations": { + "CancelContact": { + "name": "CancelContact", + "http": { + "method": "DELETE", + "requestUri": "/contact/{contactId}", + "responseCode": 200 + }, + "input": { + "shape": "CancelContactRequest" + }, + "output": { + "shape": "ContactIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Cancels a contact with a specified contact ID.

", + "idempotent": true + }, + "CreateConfig": { + "name": "CreateConfig", + "http": { + "method": "POST", + "requestUri": "/config", + "responseCode": 200 + }, + "input": { + "shape": "CreateConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Creates a Config with the specified configData parameters.

\n

Only one type of configData can be specified.

" + }, + "CreateDataflowEndpointGroup": { + "name": "CreateDataflowEndpointGroup", + "http": { + "method": "POST", + "requestUri": "/dataflowEndpointGroup", + "responseCode": 200 + }, + "input": { + "shape": "CreateDataflowEndpointGroupRequest" + }, + "output": { + "shape": "DataflowEndpointGroupIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

\n

The name field in each endpoint is used in your mission profile DataflowEndpointConfig \n to specify which endpoints to use during a contact.

\n

When a contact uses multiple DataflowEndpointConfig objects, each Config \n must match a DataflowEndpoint in the same group.

" + }, + "CreateMissionProfile": { + "name": "CreateMissionProfile", + "http": { + "method": "POST", + "requestUri": "/missionprofile", + "responseCode": 200 + }, + "input": { + "shape": "CreateMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Creates a mission profile.

\n

\n dataflowEdges is a list of lists of strings. Each lower level list of strings\n has two elements: a from ARN and a to ARN.

" + }, + "DeleteConfig": { + "name": "DeleteConfig", + "http": { + "method": "DELETE", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Deletes a Config.

", + "idempotent": true + }, + "DeleteDataflowEndpointGroup": { + "name": "DeleteDataflowEndpointGroup", + "http": { + "method": "DELETE", + "requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteDataflowEndpointGroupRequest" + }, + "output": { + "shape": "DataflowEndpointGroupIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Deletes a dataflow endpoint group.

", + "idempotent": true + }, + "DeleteMissionProfile": { + "name": "DeleteMissionProfile", + "http": { + "method": "DELETE", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Deletes a mission profile.

", + "idempotent": true + }, + "DescribeContact": { + "name": "DescribeContact", + "http": { + "method": "GET", + "requestUri": "/contact/{contactId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeContactRequest" + }, + "output": { + "shape": "DescribeContactResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Describes an existing contact.

" + }, + "GetConfig": { + "name": "GetConfig", + "http": { + "method": "GET", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "GetConfigRequest" + }, + "output": { + "shape": "GetConfigResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns Config information.

\n

Only one Config response can be returned.

" + }, + "GetDataflowEndpointGroup": { + "name": "GetDataflowEndpointGroup", + "http": { + "method": "GET", + "requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "GetDataflowEndpointGroupRequest" + }, + "output": { + "shape": "GetDataflowEndpointGroupResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns the dataflow endpoint group.

" + }, + "GetMissionProfile": { + "name": "GetMissionProfile", + "http": { + "method": "GET", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "GetMissionProfileRequest" + }, + "output": { + "shape": "GetMissionProfileResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a mission profile.

" + }, + "ListConfigs": { + "name": "ListConfigs", + "http": { + "method": "GET", + "requestUri": "/config", + "responseCode": 200 + }, + "input": { + "shape": "ListConfigsRequest" + }, + "output": { + "shape": "ListConfigsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of Config objects.

" + }, + "ListContacts": { + "name": "ListContacts", + "http": { + "method": "POST", + "requestUri": "/contacts", + "responseCode": 200 + }, + "input": { + "shape": "ListContactsRequest" + }, + "output": { + "shape": "ListContactsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of contacts.

\n

If statusList contains AVAILABLE, the request must include\n groundstation, missionprofileArn, and satelliteArn.\n

" + }, + "ListDataflowEndpointGroups": { + "name": "ListDataflowEndpointGroups", + "http": { + "method": "GET", + "requestUri": "/dataflowEndpointGroup", + "responseCode": 200 + }, + "input": { + "shape": "ListDataflowEndpointGroupsRequest" + }, + "output": { + "shape": "ListDataflowEndpointGroupsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of DataflowEndpoint groups.

" + }, + "ListMissionProfiles": { + "name": "ListMissionProfiles", + "http": { + "method": "GET", + "requestUri": "/missionprofile", + "responseCode": 200 + }, + "input": { + "shape": "ListMissionProfilesRequest" + }, + "output": { + "shape": "ListMissionProfilesResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of mission profiles.

" + }, + "ReserveContact": { + "name": "ReserveContact", + "http": { + "method": "POST", + "requestUri": "/contact", + "responseCode": 200 + }, + "input": { + "shape": "ReserveContactRequest" + }, + "output": { + "shape": "ContactIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Reserves a contact using specified parameters.

" + }, + "UpdateConfig": { + "name": "UpdateConfig", + "http": { + "method": "PUT", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Updates the Config used when scheduling contacts.

\n

Updating a Config will not update the execution parameters\n for existing future contacts scheduled with this Config.

", + "idempotent": true + }, + "UpdateMissionProfile": { + "name": "UpdateMissionProfile", + "http": { + "method": "PUT", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Updates a mission profile.

\n

Updating a mission profile will not update the execution parameters\n for existing future contacts.

", + "idempotent": true + }, + "GetMinuteUsage": { + "name": "GetMinuteUsage", + "http": { + "method": "POST", + "requestUri": "/minute-usage", + "responseCode": 200 + }, + "input": { + "shape": "GetMinuteUsageRequest" + }, + "output": { + "shape": "GetMinuteUsageResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns the number of minutes used by account.

" + }, + "GetSatellite": { + "name": "GetSatellite", + "http": { + "method": "GET", + "requestUri": "/satellite/{satelliteId}", + "responseCode": 200 + }, + "input": { + "shape": "GetSatelliteRequest" + }, + "output": { + "shape": "GetSatelliteResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a satellite.

" + }, + "ListGroundStations": { + "name": "ListGroundStations", + "http": { + "method": "GET", + "requestUri": "/groundstation", + "responseCode": 200 + }, + "input": { + "shape": "ListGroundStationsRequest" + }, + "output": { + "shape": "ListGroundStationsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of ground stations.

" + }, + "ListSatellites": { + "name": "ListSatellites", + "http": { + "method": "GET", + "requestUri": "/satellite", + "responseCode": 200 + }, + "input": { + "shape": "ListSatellitesRequest" + }, + "output": { + "shape": "ListSatellitesResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of satellites.

" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Returns a list of tags or a specified resource.

" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Assigns a tag to a resource.

" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "

Deassigns a resource tag.

", + "idempotent": true + } + }, + "shapes": { + "UpdateConfigRequest": { + "type": "structure", + "required": [ + "configData", + "configId", + "configType", + "name" + ], + "members": { + "configData": { + "shape": "ConfigTypeData", + "documentation": "

Parameters for a Config.

" + }, + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

", + "location": "uri", + "locationName": "configType" + }, + "name": { + "shape": "SafeName", + "documentation": "

Name of a Config.

" + } + }, + "documentation": "

" + }, + "ConfigTypeData": { + "type": "structure", + "members": { + "antennaDownlinkConfig": { + "shape": "AntennaDownlinkConfig", + "documentation": "

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

" + }, + "antennaDownlinkDemodDecodeConfig": { + "shape": "AntennaDownlinkDemodDecodeConfig", + "documentation": "

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

" + }, + "antennaUplinkConfig": { + "shape": "AntennaUplinkConfig", + "documentation": "

Information about how AWS Ground Station should configure an antenna for uplink during a contact.

" + }, + "dataflowEndpointConfig": { + "shape": "DataflowEndpointConfig", + "documentation": "

Information about the dataflow endpoint Config.

" + }, + "trackingConfig": { + "shape": "TrackingConfig", + "documentation": "

Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.

" + }, + "uplinkEchoConfig": { + "shape": "UplinkEchoConfig", + "documentation": "

Information about an uplink echo Config.

\n

Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

" + } + }, + "documentation": "

Object containing the parameters for a Config.

\n

See the subtype definitions for what each type of Config contains.

" + }, + "noradSatelliteID": { + "type": "integer", + "min": 1, + "max": 99999 + }, + "GroundStationData": { + "type": "structure", + "members": { + "groundStationId": { + "shape": "String", + "documentation": "

ID of a ground station.

" + }, + "groundStationName": { + "shape": "String", + "documentation": "

Name of a ground station.

" + }, + "region": { + "shape": "String", + "documentation": "

Ground station Region.

" + } + }, + "documentation": "

Information about the ground station data.

" + }, + "GetConfigRequest": { + "type": "structure", + "required": [ + "configId", + "configType" + ], + "members": { + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

", + "location": "uri", + "locationName": "configType" + } + }, + "documentation": "

" + }, + "GroundStationList": { + "type": "list", + "member": { + "shape": "GroundStationData" + } + }, + "SecurityGroupIdList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "EndpointDetails": { + "type": "structure", + "members": { + "endpoint": { + "shape": "DataflowEndpoint", + "documentation": "

A dataflow endpoint.

" + }, + "securityDetails": { + "shape": "SecurityDetails", + "documentation": "

Endpoint security details.

" + } + }, + "documentation": "

Information about the endpoint details.

" + }, + "DataflowEndpointGroupArn": { + "type": "string" + }, + "GetMinuteUsageResponse": { + "type": "structure", + "members": { + "estimatedMinutesRemaining": { + "shape": "Integer", + "documentation": "

Estimated number of minutes remaining for an account, specific to the month being requested.

" + }, + "isReservedMinutesCustomer": { + "shape": "Boolean", + "documentation": "

Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

" + }, + "totalReservedMinuteAllocation": { + "shape": "Integer", + "documentation": "

Total number of reserved minutes allocated, specific to the month being requested.

" + }, + "totalScheduledMinutes": { + "shape": "Integer", + "documentation": "

Total scheduled minutes for an account, specific to the month being requested.

" + }, + "upcomingMinutesScheduled": { + "shape": "Integer", + "documentation": "

Upcoming minutes scheduled for an account, specific to the month being requested.

" + } + }, + "documentation": "

" + }, + "MissionProfileListItem": { + "type": "structure", + "members": { + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "missionProfileId": { + "shape": "String", + "documentation": "

ID of a mission profile.

" + }, + "name": { + "shape": "String", + "documentation": "

Name of a mission profile.

" + }, + "region": { + "shape": "String", + "documentation": "

Region of a mission profile.

" + } + }, + "documentation": "

Item in a list of mission profiles.

" + }, + "SatelliteList": { + "type": "list", + "member": { + "shape": "SatelliteListItem" + } + }, + "ListDataflowEndpointGroupsResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupList": { + "shape": "DataflowEndpointGroupList", + "documentation": "

A list of dataflow endpoint groups.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

" + } + }, + "documentation": "

" + }, + "AntennaDownlinkDemodDecodeConfig": { + "type": "structure", + "required": [ + "decodeConfig", + "demodulationConfig", + "spectrumConfig" + ], + "members": { + "decodeConfig": { + "shape": "DecodeConfig", + "documentation": "

Information about the decode Config.

" + }, + "demodulationConfig": { + "shape": "DemodulationConfig", + "documentation": "

Information about the demodulation Config.

" + }, + "spectrumConfig": { + "shape": "SpectrumConfig", + "documentation": "

Information about the spectral Config.

" + } + }, + "documentation": "

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

" + }, + "MissionProfileIdResponse": { + "type": "structure", + "members": { + "missionProfileId": { + "shape": "String", + "documentation": "

ID of a mission profile.

" + } + }, + "documentation": "

" + }, + "SubnetList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "Polarization": { + "type": "string", + "enum": [ + "LEFT_HAND", + "NONE", + "RIGHT_HAND" + ] + }, + "ConfigList": { + "type": "list", + "member": { + "shape": "ConfigListItem" + } + }, + "AntennaUplinkConfig": { + "type": "structure", + "required": [ + "spectrumConfig", + "targetEirp" + ], + "members": { + "spectrumConfig": { + "shape": "UplinkSpectrumConfig", + "documentation": "

Information about the uplink spectral Config.

" + }, + "targetEirp": { + "shape": "Eirp", + "documentation": "

EIRP of the target.

" + } + }, + "documentation": "

Information about the uplink Config of an antenna.

" + }, + "Integer": { + "type": "integer", + "box": true + }, + "AntennaDownlinkConfig": { + "type": "structure", + "required": [ + "spectrumConfig" + ], + "members": { + "spectrumConfig": { + "shape": "SpectrumConfig", + "documentation": "

Object that describes a spectral Config.

" + } + }, + "documentation": "

Information about how AWS Ground Station should configure an\n antenna for downlink during a contact.

" + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "EndpointStatus": { + "type": "string", + "enum": [ + "created", + "creating", + "deleted", + "deleting", + "failed" + ] + }, + "UplinkEchoConfig": { + "type": "structure", + "required": [ + "antennaUplinkConfigArn", + "enabled" + ], + "members": { + "antennaUplinkConfigArn": { + "shape": "ConfigArn", + "documentation": "

ARN of an uplink Config.

" + }, + "enabled": { + "shape": "Boolean", + "documentation": "

Whether or not an uplink Config is enabled.

" + } + }, + "documentation": "

Information about an uplink echo Config.

\n

Parameters from the AntennaUplinkConfig, corresponding to the \n specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig \n is used in a contact.

" + }, + "DecodeConfig": { + "type": "structure", + "required": [ + "unvalidatedJSON" + ], + "members": { + "unvalidatedJSON": { + "shape": "JsonString", + "documentation": "

Unvalidated JSON of a decode Config.

" + } + }, + "documentation": "

Information about the decode Config.

" + }, + "DeleteDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "dataflowEndpointGroupId" + ], + "members": { + "dataflowEndpointGroupId": { + "shape": "String", + "documentation": "

ID of a dataflow endpoint group.

", + "location": "uri", + "locationName": "dataflowEndpointGroupId" + } + }, + "documentation": "

" + }, + "ContactStatus": { + "type": "string", + "enum": [ + "AVAILABLE", + "AWS_CANCELLED", + "CANCELLED", + "COMPLETED", + "FAILED", + "FAILED_TO_SCHEDULE", + "PASS", + "POSTPASS", + "PREPASS", + "SCHEDULED", + "SCHEDULING" + ] + }, + "MissionProfileList": { + "type": "list", + "member": { + "shape": "MissionProfileListItem" + } + }, + "CreateConfigRequest": { + "type": "structure", + "required": [ + "configData", + "name" + ], + "members": { + "configData": { + "shape": "ConfigTypeData", + "documentation": "

Parameters of a Config.

" + }, + "name": { + "shape": "SafeName", + "documentation": "

Name of a Config.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a Config.

" + } + }, + "documentation": "

" + }, + "Frequency": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "FrequencyUnits", + "documentation": "

Frequency units.

" + }, + "value": { + "shape": "Double", + "documentation": "

Frequency value.

" + } + }, + "documentation": "

Object that describes the frequency.

" + }, + "UntagResourceResponse": { + "type": "structure", + "members": { }, + "documentation": "

" + }, + "ConfigIdResponse": { + "type": "structure", + "members": { + "configArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a Config.

" + }, + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

" + } + }, + "documentation": "

" + }, + "SecurityDetails": { + "type": "structure", + "required": [ + "roleArn", + "securityGroupIds", + "subnetIds" + ], + "members": { + "roleArn": { + "shape": "RoleArn", + "documentation": "

ARN to a role needed for connecting streams to your instances.

" + }, + "securityGroupIds": { + "shape": "SecurityGroupIdList", + "documentation": "

The security groups to attach to the elastic network interfaces.

" + }, + "subnetIds": { + "shape": "SubnetList", + "documentation": "

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

" + } + }, + "documentation": "

Information about endpoints.

" + }, + "TrackingConfig": { + "type": "structure", + "required": [ + "autotrack" + ], + "members": { + "autotrack": { + "shape": "Criticality", + "documentation": "

Current setting for autotrack.

" + } + }, + "documentation": "

Object that determines whether tracking should be used during a contact\n executed with this Config in the mission profile.

" + }, + "CreateDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "endpointDetails" + ], + "members": { + "endpointDetails": { + "shape": "EndpointDetailsList", + "documentation": "

Endpoint details of each endpoint in the dataflow endpoint group.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags of a dataflow endpoint group.

" + } + }, + "documentation": "

" + }, + "Elevation": { + "type": "structure", + "required": [ + "unit", + "value" + ], + "members": { + "unit": { + "shape": "AngleUnits", + "documentation": "

Elevation angle units.

" + }, + "value": { + "shape": "Double", + "documentation": "

Elevation angle value.

" + } + }, + "documentation": "

Elevation angle of the satellite in the sky during a contact.

" + }, + "JsonString": { + "type": "string", + "min": 2, + "max": 8192 + }, + "GetSatelliteRequest": { + "type": "structure", + "required": [ + "satelliteId" + ], + "members": { + "satelliteId": { + "shape": "String", + "documentation": "

UUID of a satellite.

", + "location": "uri", + "locationName": "satelliteId" + } + }, + "documentation": "

" + }, + "CancelContactRequest": { + "type": "structure", + "required": [ + "contactId" + ], + "members": { + "contactId": { + "shape": "String", + "documentation": "

UUID of a contact.

", + "location": "uri", + "locationName": "contactId" + } + }, + "documentation": "

" + }, + "UplinkSpectrumConfig": { + "type": "structure", + "required": [ + "centerFrequency" + ], + "members": { + "centerFrequency": { + "shape": "Frequency", + "documentation": "

Center frequency of an uplink spectral Config.

" + }, + "polarization": { + "shape": "Polarization", + "documentation": "

Polarization of an uplink spectral Config.

" + } + }, + "documentation": "

Information about the uplink spectral Config.

" + }, + "UntagResourceRequest": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "shape": "String", + "documentation": "

ARN of a resource.

", + "location": "uri", + "locationName": "resourceArn" + }, + "tagKeys": { + "shape": "TagKeys", + "documentation": "

Keys of a resource tag.

", + "location": "querystring", + "locationName": "tagKeys" + } + }, + "documentation": "

" + }, + "satelliteArn": { + "type": "string" + }, + "GetMissionProfileResponse": { + "type": "structure", + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList", + "documentation": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

" + }, + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "missionProfileId": { + "shape": "String", + "documentation": "

ID of a mission profile.

" + }, + "name": { + "shape": "String", + "documentation": "

Name of a mission profile.

" + }, + "region": { + "shape": "String", + "documentation": "

Region of a mission profile.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a mission profile.

" + }, + "trackingConfigArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a tracking Config.

" + } + }, + "documentation": "

" + }, + "ContactIdResponse": { + "type": "structure", + "members": { + "contactId": { + "shape": "String", + "documentation": "

UUID of a contact.

" + } + }, + "documentation": "

" + }, + "EndpointDetailsList": { + "type": "list", + "member": { + "shape": "EndpointDetails" + } + }, + "ListGroundStationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of ground stations returned.

", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token that can be supplied in the next call to get the next page of ground stations.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "

" + }, + "InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + }, + "parameterName": { + "shape": "String", + "documentation": "

" + } + }, + "documentation": "

One or more parameters are not valid.

", + "exception": true, + "error": { + "code": "InvalidParameterException", + "httpStatusCode": 431, + "senderFault": true + } + }, + "DependencyException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + }, + "parameterName": { + "shape": "String", + "documentation": "

" + } + }, + "documentation": "

Dependency encountered an error.

", + "exception": true, + "error": { + "code": "DependencyException", + "httpStatusCode": 531, + "fault": true + } + }, + "DescribeContactRequest": { + "type": "structure", + "required": [ + "contactId" + ], + "members": { + "contactId": { + "shape": "String", + "documentation": "

UUID of a contact.

", + "location": "uri", + "locationName": "contactId" + } + }, + "documentation": "

" + }, + "ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "documentation": "

Resource was not found.

", + "exception": true, + "error": { + "code": "ResourceNotFoundException", + "httpStatusCode": 434, + "senderFault": true + } + }, + "Timestamp": { + "type": "timestamp" + }, + "DeleteConfigRequest": { + "type": "structure", + "required": [ + "configId", + "configType" + ], + "members": { + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

", + "location": "uri", + "locationName": "configType" + } + }, + "documentation": "

" + }, + "BandwidthUnits": { + "type": "string", + "enum": [ + "GHz", + "MHz", + "kHz" + ] + }, + "SpectrumConfig": { + "type": "structure", + "required": [ + "bandwidth", + "centerFrequency" + ], + "members": { + "bandwidth": { + "shape": "FrequencyBandwidth", + "documentation": "

Bandwidth of a spectral Config.

" + }, + "centerFrequency": { + "shape": "Frequency", + "documentation": "

Center frequency of a spectral Config.

" + }, + "polarization": { + "shape": "Polarization", + "documentation": "

Polarization of a spectral Config.

" + } + }, + "documentation": "

Object that describes a spectral Config.

" + }, + "DemodulationConfig": { + "type": "structure", + "required": [ + "unvalidatedJSON" + ], + "members": { + "unvalidatedJSON": { + "shape": "JsonString", + "documentation": "

Unvalidated JSON of a demodulation Config.

" + } + }, + "documentation": "

Information about the demodulation Config.

" + }, + "ListMissionProfilesResponse": { + "type": "structure", + "members": { + "missionProfileList": { + "shape": "MissionProfileList", + "documentation": "

List of mission profiles

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.

" + } + }, + "documentation": "

" + }, + "ListConfigsResponse": { + "type": "structure", + "members": { + "configList": { + "shape": "ConfigList", + "documentation": "

List of Config items.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.

" + } + }, + "documentation": "

" + }, + "DataflowEdge": { + "type": "list", + "member": { + "shape": "ConfigArn" + }, + "min": 2, + "max": 2 + }, + "SafeName": { + "type": "string", + "min": 1, + "max": 256, + "pattern": "^[ a-zA-Z0-9_:-]+$" + }, + "Eirp": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "EirpUnits", + "documentation": "

Units of an EIRP.

" + }, + "value": { + "shape": "Double", + "documentation": "

Value of an EIRP.

" + } + }, + "documentation": "

Object that represents EIRP.

" + }, + "RoleArn": { + "type": "string" + }, + "ListMissionProfilesRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of mission profiles returned.

", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "

" + }, + "GetSatelliteResponse": { + "type": "structure", + "members": { + "dateCreated": { + "shape": "Timestamp", + "documentation": "

When a satellite was created.

" + }, + "lastUpdated": { + "shape": "Timestamp", + "documentation": "

When a satellite was last updated.

" + }, + "noradSatelliteID": { + "shape": "noradSatelliteID", + "documentation": "

NORAD satellite ID number.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite.

" + }, + "satelliteId": { + "shape": "Uuid", + "documentation": "

UUID of a satellite.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a satellite.

" + } + }, + "documentation": "

" + }, + "StatusList": { + "type": "list", + "member": { + "shape": "ContactStatus" + } + }, + "ListContactsRequest": { + "type": "structure", + "required": [ + "endTime", + "startTime", + "statusList" + ], + "members": { + "endTime": { + "shape": "Timestamp", + "documentation": "

End time of a contact.

" + }, + "groundStation": { + "shape": "String", + "documentation": "

Name of a ground station.

" + }, + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of contacts returned.

" + }, + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite.

" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "

Start time of a contact.

" + }, + "statusList": { + "shape": "StatusList", + "documentation": "

Status of a contact reservation.

" + } + }, + "documentation": "

" + }, + "ContactData": { + "type": "structure", + "members": { + "contactId": { + "shape": "String", + "documentation": "

UUID of a contact.

" + }, + "contactStatus": { + "shape": "ContactStatus", + "documentation": "

Status of a contact.

" + }, + "endTime": { + "shape": "Timestamp", + "documentation": "

End time of a contact.

" + }, + "errorMessage": { + "shape": "String", + "documentation": "

Error message of a contact.

" + }, + "groundStation": { + "shape": "String", + "documentation": "

Name of a ground station.

" + }, + "maximumElevation": { + "shape": "Elevation", + "documentation": "

Maximum elevation angle of a contact.

" + }, + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "postPassEndTime": { + "shape": "Timestamp", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "prePassStartTime": { + "shape": "Timestamp", + "documentation": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite.

" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "

Start time of a contact.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a contact.

" + } + }, + "documentation": "

Data describing a contact.

" + }, + "ListGroundStationsResponse": { + "type": "structure", + "members": { + "groundStationList": { + "shape": "GroundStationList", + "documentation": "

List of ground stations.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token that can be supplied in the next call to get the next page of ground stations.

" + } + }, + "documentation": "

" + }, + "DataflowEndpoint": { + "type": "structure", + "members": { + "address": { + "shape": "SocketAddress", + "documentation": "

Socket address of a dataflow endpoint.

" + }, + "name": { + "shape": "SafeName", + "documentation": "

Name of a dataflow endpoint.

" + }, + "status": { + "shape": "EndpointStatus", + "documentation": "

Status of a dataflow endpoint.

" + } + }, + "documentation": "

Information about a dataflow endpoint.

" + }, + "ListConfigsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of Configs returned.

", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "

" + }, + "SocketAddress": { + "type": "structure", + "required": [ + "name", + "port" + ], + "members": { + "name": { + "shape": "String", + "documentation": "

Name of a socket address.

" + }, + "port": { + "shape": "Integer", + "documentation": "

Port of a socket address.

" + } + }, + "documentation": "

Information about the socket address.

" + }, + "GetConfigResponse": { + "type": "structure", + "required": [ + "configArn", + "configData", + "configId", + "name" + ], + "members": { + "configArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a Config\n

" + }, + "configData": { + "shape": "ConfigTypeData", + "documentation": "

Data elements in a Config.

" + }, + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

" + }, + "name": { + "shape": "String", + "documentation": "

Name of a Config.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a Config.

" + } + }, + "documentation": "

" + }, + "TagsMap": { + "type": "map", + "key": { + "shape": "String" + }, + "value": { + "shape": "String" + } + }, + "TagResourceResponse": { + "type": "structure", + "members": { }, + "documentation": "

" + }, + "DeleteMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "missionProfileId": { + "shape": "String", + "documentation": "

UUID of a mission profile.

", + "location": "uri", + "locationName": "missionProfileId" + } + }, + "documentation": "

" + }, + "DataflowEndpointGroupList": { + "type": "list", + "member": { + "shape": "DataflowEndpointListItem" + } + }, + "ContactList": { + "type": "list", + "member": { + "shape": "ContactData" + } + }, + "DurationInSeconds": { + "type": "integer", + "min": 1, + "max": 21600 + }, + "SatelliteListItem": { + "type": "structure", + "members": { + "noradSatelliteID": { + "shape": "noradSatelliteID", + "documentation": "

NORAD satellite ID number.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite.

" + }, + "satelliteId": { + "shape": "Uuid", + "documentation": "

ID of a satellite.

" + } + }, + "documentation": "

Item in a list of satellites.

" + }, + "GetMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "missionProfileId": { + "shape": "String", + "documentation": "

UUID of a mission profile.

", + "location": "uri", + "locationName": "missionProfileId" + } + }, + "documentation": "

" + }, + "Double": { + "type": "double", + "box": true + }, + "ListSatellitesResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "String", + "documentation": "

Next token that can be supplied in the next call to get the next page of satellites.

" + }, + "satellites": { + "shape": "SatelliteList", + "documentation": "

List of satellites.

" + } + }, + "documentation": "

" + }, + "CreateMissionProfileRequest": { + "type": "structure", + "required": [ + "dataflowEdges", + "minimumViableContactDurationSeconds", + "name", + "trackingConfigArn" + ], + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList", + "documentation": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

" + }, + "name": { + "shape": "SafeName", + "documentation": "

Name of a mission profile.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a mission profile.

" + }, + "trackingConfigArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a tracking Config.

" + } + }, + "documentation": "

" + }, + "ReserveContactRequest": { + "type": "structure", + "required": [ + "endTime", + "groundStation", + "missionProfileArn", + "satelliteArn", + "startTime" + ], + "members": { + "endTime": { + "shape": "Timestamp", + "documentation": "

End time of a contact.

" + }, + "groundStation": { + "shape": "String", + "documentation": "

Name of a ground station.

" + }, + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite

" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "

Start time of a contact.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a contact.

" + } + }, + "documentation": "

" + }, + "DataflowEndpointConfig": { + "type": "structure", + "required": [ + "dataflowEndpointName" + ], + "members": { + "dataflowEndpointName": { + "shape": "String", + "documentation": "

Name of a dataflow endpoint.

" + } + }, + "documentation": "

Information about the dataflow endpoint Config.

" + }, + "Uuid": { + "type": "string", + "min": 1, + "max": 128, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a resource.

" + } + }, + "documentation": "

" + }, + "MissionProfileArn": { + "type": "string" + }, + "ListContactsResponse": { + "type": "structure", + "members": { + "contactList": { + "shape": "ContactList", + "documentation": "

List of contacts.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

" + } + }, + "documentation": "

" + }, + "DataflowEdgeList": { + "type": "list", + "member": { + "shape": "DataflowEdge" + } + }, + "DescribeContactResponse": { + "type": "structure", + "members": { + "contactId": { + "shape": "String", + "documentation": "

UUID of a contact.

" + }, + "contactStatus": { + "shape": "ContactStatus", + "documentation": "

Status of a contact.

" + }, + "endTime": { + "shape": "Timestamp", + "documentation": "

End time of a contact.

" + }, + "errorMessage": { + "shape": "String", + "documentation": "

Error message for a contact.

" + }, + "groundStation": { + "shape": "String", + "documentation": "

Ground station for a contact.

" + }, + "maximumElevation": { + "shape": "Elevation", + "documentation": "

Maximum elevation angle of a contact.

" + }, + "missionProfileArn": { + "shape": "MissionProfileArn", + "documentation": "

ARN of a mission profile.

" + }, + "postPassEndTime": { + "shape": "Timestamp", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "prePassStartTime": { + "shape": "Timestamp", + "documentation": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

" + }, + "satelliteArn": { + "shape": "satelliteArn", + "documentation": "

ARN of a satellite.

" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "

Start time of a contact.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a contact.

" + } + }, + "documentation": "

" + }, + "ConfigListItem": { + "type": "structure", + "members": { + "configArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a Config.

" + }, + "configId": { + "shape": "String", + "documentation": "

UUID of a Config.

" + }, + "configType": { + "shape": "ConfigCapabilityType", + "documentation": "

Type of a Config.

" + }, + "name": { + "shape": "String", + "documentation": "

Name of a Config.

" + } + }, + "documentation": "

An item in a list of Config objects.

" + }, + "ListTagsForResourceRequest": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "shape": "String", + "documentation": "

ARN of a resource.

", + "location": "uri", + "locationName": "resourceArn" + } + }, + "documentation": "

" + }, + "ListDataflowEndpointGroupsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of dataflow endpoint groups returned.

", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "

" + }, + "FrequencyBandwidth": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "BandwidthUnits", + "documentation": "

Frequency bandwidth units.

" + }, + "value": { + "shape": "Double", + "documentation": "

Frequency bandwidth value.

" + } + }, + "documentation": "

Object that describes the frequency bandwidth.

" + }, + "String": { + "type": "string" + }, + "ListSatellitesRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "documentation": "

Maximum number of satellites returned.

", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "documentation": "

Next token that can be supplied in the next call to get the next page of satellites.

", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "

" + }, + "UpdateMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList", + "documentation": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds", + "documentation": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

" + }, + "missionProfileId": { + "shape": "String", + "documentation": "

ID of a mission profile.

", + "location": "uri", + "locationName": "missionProfileId" + }, + "name": { + "shape": "SafeName", + "documentation": "

Name of a mission profile.

" + }, + "trackingConfigArn": { + "shape": "ConfigArn", + "documentation": "

ARN of a tracking Config.

" + } + }, + "documentation": "

" + }, + "FrequencyUnits": { + "type": "string", + "enum": [ + "GHz", + "MHz", + "kHz" + ] + }, + "TagResourceRequest": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "shape": "String", + "documentation": "

ARN of a resource tag.

", + "location": "uri", + "locationName": "resourceArn" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a resource.

" + } + }, + "documentation": "

" + }, + "Criticality": { + "type": "string", + "enum": [ + "PREFERRED", + "REMOVED", + "REQUIRED" + ] + }, + "ConfigCapabilityType": { + "type": "string", + "enum": [ + "antenna-downlink", + "antenna-downlink-demod-decode", + "antenna-uplink", + "dataflow-endpoint", + "tracking", + "uplink-echo" + ] + }, + "TagKeys": { + "type": "list", + "member": { + "shape": "String" + } + }, + "AngleUnits": { + "type": "string", + "enum": [ + "DEGREE_ANGLE", + "RADIAN" + ] + }, + "DataflowEndpointListItem": { + "type": "structure", + "members": { + "dataflowEndpointGroupArn": { + "shape": "DataflowEndpointGroupArn", + "documentation": "

ARN of a dataflow endpoint group.

" + }, + "dataflowEndpointGroupId": { + "shape": "String", + "documentation": "

UUID of a dataflow endpoint group.

" + } + }, + "documentation": "

Item in a list of DataflowEndpoint groups.

" + }, + "GetDataflowEndpointGroupResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupArn": { + "shape": "DataflowEndpointGroupArn", + "documentation": "

ARN of a dataflow endpoint group.

" + }, + "dataflowEndpointGroupId": { + "shape": "String", + "documentation": "

UUID of a dataflow endpoint group.

" + }, + "endpointsDetails": { + "shape": "EndpointDetailsList", + "documentation": "

Details of a dataflow endpoint.

" + }, + "tags": { + "shape": "TagsMap", + "documentation": "

Tags assigned to a dataflow endpoint group.

" + } + }, + "documentation": "

" + }, + "GetDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "dataflowEndpointGroupId" + ], + "members": { + "dataflowEndpointGroupId": { + "shape": "String", + "documentation": "

UUID of a dataflow endpoint group.

", + "location": "uri", + "locationName": "dataflowEndpointGroupId" + } + }, + "documentation": "

" + }, + "ConfigArn": { + "type": "string" + }, + "GetMinuteUsageRequest": { + "type": "structure", + "required": [ + "month", + "year" + ], + "members": { + "month": { + "shape": "Integer", + "documentation": "

The month being requested, with a value of 1-12.

" + }, + "year": { + "shape": "Integer", + "documentation": "

The year being requested, in the format of YYYY.

" + } + }, + "documentation": "

" + }, + "DataflowEndpointGroupIdResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupId": { + "shape": "String", + "documentation": "

ID of a dataflow endpoint group.

" + } + }, + "documentation": "

" + }, + "EirpUnits": { + "type": "string", + "enum": [ + "dBW" + ] + } + } +} diff --git a/aws/dist/botocore/data/guardduty/2017-11-28/paginators-1.json b/aws/dist/botocore/data/guardduty/2017-11-28/paginators-1.json new file mode 100644 index 00000000..92a10d33 --- /dev/null +++ b/aws/dist/botocore/data/guardduty/2017-11-28/paginators-1.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "ListDetectors": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DetectorIds" + }, + "ListFindings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FindingIds" + }, + "ListIPSets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "IpSetIds" + }, + "ListThreatIntelSets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ThreatIntelSetIds" + }, + "ListInvitations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Invitations" + }, + "ListMembers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Members" + }, + "ListFilters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "FilterNames" + } + } +} diff --git a/aws/dist/botocore/data/guardduty/2017-11-28/service-2.json b/aws/dist/botocore/data/guardduty/2017-11-28/service-2.json new file mode 100644 index 00000000..222c5b91 --- /dev/null +++ b/aws/dist/botocore/data/guardduty/2017-11-28/service-2.json @@ -0,0 +1,3615 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-28", + "endpointPrefix":"guardduty", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon GuardDuty", + "serviceId":"GuardDuty", + "signatureVersion":"v4", + "signingName":"guardduty", + "uid":"guardduty-2017-11-28" + }, + "operations":{ + "AcceptInvitation":{ + "name":"AcceptInvitation", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/master", + "responseCode":200 + }, + "input":{"shape":"AcceptInvitationRequest"}, + "output":{"shape":"AcceptInvitationResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Accepts the invitation to be monitored by a master GuardDuty account.

" + }, + "ArchiveFindings":{ + "name":"ArchiveFindings", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/archive", + "responseCode":200 + }, + "input":{"shape":"ArchiveFindingsRequest"}, + "output":{"shape":"ArchiveFindingsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Archives GuardDuty findings specified by the list of finding IDs.

Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.

" + }, + "CreateDetector":{ + "name":"CreateDetector", + "http":{ + "method":"POST", + "requestUri":"/detector", + "responseCode":200 + }, + "input":{"shape":"CreateDetectorRequest"}, + "output":{"shape":"CreateDetectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.

" + }, + "CreateFilter":{ + "name":"CreateFilter", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/filter", + "responseCode":200 + }, + "input":{"shape":"CreateFilterRequest"}, + "output":{"shape":"CreateFilterResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Creates a filter using the specified finding criteria.

" + }, + "CreateIPSet":{ + "name":"CreateIPSet", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/ipset", + "responseCode":200 + }, + "input":{"shape":"CreateIPSetRequest"}, + "output":{"shape":"CreateIPSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications.

" + }, + "CreateMembers":{ + "name":"CreateMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member", + "responseCode":200 + }, + "input":{"shape":"CreateMembersRequest"}, + "output":{"shape":"CreateMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.

" + }, + "CreateSampleFindings":{ + "name":"CreateSampleFindings", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/create", + "responseCode":200 + }, + "input":{"shape":"CreateSampleFindingsRequest"}, + "output":{"shape":"CreateSampleFindingsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes, the API generates example findings of all supported finding types.

" + }, + "CreateThreatIntelSet":{ + "name":"CreateThreatIntelSet", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/threatintelset", + "responseCode":200 + }, + "input":{"shape":"CreateThreatIntelSetRequest"}, + "output":{"shape":"CreateThreatIntelSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets.

" + }, + "DeclineInvitations":{ + "name":"DeclineInvitations", + "http":{ + "method":"POST", + "requestUri":"/invitation/decline", + "responseCode":200 + }, + "input":{"shape":"DeclineInvitationsRequest"}, + "output":{"shape":"DeclineInvitationsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Declines invitations sent to the current member account by AWS account specified by their account IDs.

" + }, + "DeleteDetector":{ + "name":"DeleteDetector", + "http":{ + "method":"DELETE", + "requestUri":"/detector/{detectorId}", + "responseCode":200 + }, + "input":{"shape":"DeleteDetectorRequest"}, + "output":{"shape":"DeleteDetectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes a Amazon GuardDuty detector specified by the detector ID.

" + }, + "DeleteFilter":{ + "name":"DeleteFilter", + "http":{ + "method":"DELETE", + "requestUri":"/detector/{detectorId}/filter/{filterName}", + "responseCode":200 + }, + "input":{"shape":"DeleteFilterRequest"}, + "output":{"shape":"DeleteFilterResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes the filter specified by the filter name.

" + }, + "DeleteIPSet":{ + "name":"DeleteIPSet", + "http":{ + "method":"DELETE", + "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", + "responseCode":200 + }, + "input":{"shape":"DeleteIPSetRequest"}, + "output":{"shape":"DeleteIPSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes the IPSet specified by the IPSet ID.

" + }, + "DeleteInvitations":{ + "name":"DeleteInvitations", + "http":{ + "method":"POST", + "requestUri":"/invitation/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteInvitationsRequest"}, + "output":{"shape":"DeleteInvitationsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.

" + }, + "DeleteMembers":{ + "name":"DeleteMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/delete", + "responseCode":200 + }, + "input":{"shape":"DeleteMembersRequest"}, + "output":{"shape":"DeleteMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

" + }, + "DeleteThreatIntelSet":{ + "name":"DeleteThreatIntelSet", + "http":{ + "method":"DELETE", + "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode":200 + }, + "input":{"shape":"DeleteThreatIntelSetRequest"}, + "output":{"shape":"DeleteThreatIntelSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Deletes ThreatIntelSet specified by the ThreatIntelSet ID.

" + }, + "DisassociateFromMasterAccount":{ + "name":"DisassociateFromMasterAccount", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/master/disassociate", + "responseCode":200 + }, + "input":{"shape":"DisassociateFromMasterAccountRequest"}, + "output":{"shape":"DisassociateFromMasterAccountResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Disassociates the current GuardDuty member account from its master account.

" + }, + "DisassociateMembers":{ + "name":"DisassociateMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/disassociate", + "responseCode":200 + }, + "input":{"shape":"DisassociateMembersRequest"}, + "output":{"shape":"DisassociateMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

" + }, + "GetDetector":{ + "name":"GetDetector", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}", + "responseCode":200 + }, + "input":{"shape":"GetDetectorRequest"}, + "output":{"shape":"GetDetectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Retrieves an Amazon GuardDuty detector specified by the detectorId.

" + }, + "GetFilter":{ + "name":"GetFilter", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/filter/{filterName}", + "responseCode":200 + }, + "input":{"shape":"GetFilterRequest"}, + "output":{"shape":"GetFilterResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Returns the details of the filter specified by the filter name.

" + }, + "GetFindings":{ + "name":"GetFindings", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/get", + "responseCode":200 + }, + "input":{"shape":"GetFindingsRequest"}, + "output":{"shape":"GetFindingsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Describes Amazon GuardDuty findings specified by finding IDs.

" + }, + "GetFindingsStatistics":{ + "name":"GetFindingsStatistics", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/statistics", + "responseCode":200 + }, + "input":{"shape":"GetFindingsStatisticsRequest"}, + "output":{"shape":"GetFindingsStatisticsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists Amazon GuardDuty findings' statistics for the specified detector ID.

" + }, + "GetIPSet":{ + "name":"GetIPSet", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", + "responseCode":200 + }, + "input":{"shape":"GetIPSetRequest"}, + "output":{"shape":"GetIPSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Retrieves the IPSet specified by the IPSet ID.

" + }, + "GetInvitationsCount":{ + "name":"GetInvitationsCount", + "http":{ + "method":"GET", + "requestUri":"/invitation/count", + "responseCode":200 + }, + "input":{"shape":"GetInvitationsCountRequest"}, + "output":{"shape":"GetInvitationsCountResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

" + }, + "GetMasterAccount":{ + "name":"GetMasterAccount", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/master", + "responseCode":200 + }, + "input":{"shape":"GetMasterAccountRequest"}, + "output":{"shape":"GetMasterAccountResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Provides the details for the GuardDuty master account associated with the current GuardDuty member account.

" + }, + "GetMembers":{ + "name":"GetMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/get", + "responseCode":200 + }, + "input":{"shape":"GetMembersRequest"}, + "output":{"shape":"GetMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

" + }, + "GetThreatIntelSet":{ + "name":"GetThreatIntelSet", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode":200 + }, + "input":{"shape":"GetThreatIntelSetRequest"}, + "output":{"shape":"GetThreatIntelSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

" + }, + "InviteMembers":{ + "name":"InviteMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/invite", + "responseCode":200 + }, + "input":{"shape":"InviteMembersRequest"}, + "output":{"shape":"InviteMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.

" + }, + "ListDetectors":{ + "name":"ListDetectors", + "http":{ + "method":"GET", + "requestUri":"/detector", + "responseCode":200 + }, + "input":{"shape":"ListDetectorsRequest"}, + "output":{"shape":"ListDetectorsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

" + }, + "ListFilters":{ + "name":"ListFilters", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/filter", + "responseCode":200 + }, + "input":{"shape":"ListFiltersRequest"}, + "output":{"shape":"ListFiltersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Returns a paginated list of the current filters.

" + }, + "ListFindings":{ + "name":"ListFindings", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings", + "responseCode":200 + }, + "input":{"shape":"ListFindingsRequest"}, + "output":{"shape":"ListFindingsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists Amazon GuardDuty findings for the specified detector ID.

" + }, + "ListIPSets":{ + "name":"ListIPSets", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/ipset", + "responseCode":200 + }, + "input":{"shape":"ListIPSetsRequest"}, + "output":{"shape":"ListIPSetsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists the IPSets of the GuardDuty service specified by the detector ID.

" + }, + "ListInvitations":{ + "name":"ListInvitations", + "http":{ + "method":"GET", + "requestUri":"/invitation", + "responseCode":200 + }, + "input":{"shape":"ListInvitationsRequest"}, + "output":{"shape":"ListInvitationsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists all GuardDuty membership invitations that were sent to the current AWS account.

" + }, + "ListMembers":{ + "name":"ListMembers", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/member", + "responseCode":200 + }, + "input":{"shape":"ListMembersRequest"}, + "output":{"shape":"ListMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists details about all member accounts for the current GuardDuty master account.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and Threat Intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource..

" + }, + "ListThreatIntelSets":{ + "name":"ListThreatIntelSets", + "http":{ + "method":"GET", + "requestUri":"/detector/{detectorId}/threatintelset", + "responseCode":200 + }, + "input":{"shape":"ListThreatIntelSetsRequest"}, + "output":{"shape":"ListThreatIntelSetsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.

" + }, + "StartMonitoringMembers":{ + "name":"StartMonitoringMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/start", + "responseCode":200 + }, + "input":{"shape":"StartMonitoringMembersRequest"}, + "output":{"shape":"StartMonitoringMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers.

" + }, + "StopMonitoringMembers":{ + "name":"StopMonitoringMembers", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/member/stop", + "responseCode":200 + }, + "input":{"shape":"StopMonitoringMembersRequest"}, + "output":{"shape":"StopMonitoringMembersResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members’ findings.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Adds tags to a resource.

" + }, + "UnarchiveFindings":{ + "name":"UnarchiveFindings", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/unarchive", + "responseCode":200 + }, + "input":{"shape":"UnarchiveFindingsRequest"}, + "output":{"shape":"UnarchiveFindingsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Unarchives Amazon GuardDuty findings specified by the list of finding IDs.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Removes tags from a resource.

" + }, + "UpdateDetector":{ + "name":"UpdateDetector", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDetectorRequest"}, + "output":{"shape":"UpdateDetectorResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Updates an Amazon GuardDuty detector specified by the detectorId.

" + }, + "UpdateFilter":{ + "name":"UpdateFilter", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/filter/{filterName}", + "responseCode":200 + }, + "input":{"shape":"UpdateFilterRequest"}, + "output":{"shape":"UpdateFilterResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Updates the filter specified by the filter name.

" + }, + "UpdateFindingsFeedback":{ + "name":"UpdateFindingsFeedback", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/findings/feedback", + "responseCode":200 + }, + "input":{"shape":"UpdateFindingsFeedbackRequest"}, + "output":{"shape":"UpdateFindingsFeedbackResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Marks specified Amazon GuardDuty findings as useful or not useful.

" + }, + "UpdateIPSet":{ + "name":"UpdateIPSet", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/ipset/{ipSetId}", + "responseCode":200 + }, + "input":{"shape":"UpdateIPSetRequest"}, + "output":{"shape":"UpdateIPSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Updates the IPSet specified by the IPSet ID.

" + }, + "UpdateThreatIntelSet":{ + "name":"UpdateThreatIntelSet", + "http":{ + "method":"POST", + "requestUri":"/detector/{detectorId}/threatintelset/{threatIntelSetId}", + "responseCode":200 + }, + "input":{"shape":"UpdateThreatIntelSetRequest"}, + "output":{"shape":"UpdateThreatIntelSetResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

Updates the ThreatIntelSet specified by ThreatIntelSet ID.

" + } + }, + "shapes":{ + "AcceptInvitationRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "MasterId", + "InvitationId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty member account.

", + "location":"uri", + "locationName":"detectorId" + }, + "MasterId":{ + "shape":"String", + "documentation":"

The account ID of the master GuardDuty account whose invitation you're accepting.

", + "locationName":"masterId" + }, + "InvitationId":{ + "shape":"String", + "documentation":"

This value is used to validate the master account to the member account.

", + "locationName":"invitationId" + } + } + }, + "AcceptInvitationResponse":{ + "type":"structure", + "members":{ + } + }, + "AccessKeyDetails":{ + "type":"structure", + "members":{ + "AccessKeyId":{ + "shape":"String", + "documentation":"

Access key ID of the user.

", + "locationName":"accessKeyId" + }, + "PrincipalId":{ + "shape":"String", + "documentation":"

The principal ID of the user.

", + "locationName":"principalId" + }, + "UserName":{ + "shape":"String", + "documentation":"

The name of the user.

", + "locationName":"userName" + }, + "UserType":{ + "shape":"String", + "documentation":"

The type of the user.

", + "locationName":"userType" + } + }, + "documentation":"

Contains information about the access keys.

" + }, + "AccountDetail":{ + "type":"structure", + "required":[ + "AccountId", + "Email" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

Member account ID.

", + "locationName":"accountId" + }, + "Email":{ + "shape":"Email", + "documentation":"

Member account's email address.

", + "locationName":"email" + } + }, + "documentation":"

Contains information about the account.

" + }, + "AccountDetails":{ + "type":"list", + "member":{"shape":"AccountDetail"}, + "max":50, + "min":1 + }, + "AccountId":{ + "type":"string", + "max":12, + "min":12 + }, + "AccountIds":{ + "type":"list", + "member":{"shape":"AccountId"}, + "max":50, + "min":1 + }, + "Action":{ + "type":"structure", + "members":{ + "ActionType":{ + "shape":"String", + "documentation":"

GuardDuty Finding activity type.

", + "locationName":"actionType" + }, + "AwsApiCallAction":{ + "shape":"AwsApiCallAction", + "documentation":"

Information about the AWS_API_CALL action described in this finding.

", + "locationName":"awsApiCallAction" + }, + "DnsRequestAction":{ + "shape":"DnsRequestAction", + "documentation":"

Information about the DNS_REQUEST action described in this finding.

", + "locationName":"dnsRequestAction" + }, + "NetworkConnectionAction":{ + "shape":"NetworkConnectionAction", + "documentation":"

Information about the NETWORK_CONNECTION action described in this finding.

", + "locationName":"networkConnectionAction" + }, + "PortProbeAction":{ + "shape":"PortProbeAction", + "documentation":"

Information about the PORT_PROBE action described in this finding.

", + "locationName":"portProbeAction" + } + }, + "documentation":"

Contains information about action.

" + }, + "ArchiveFindingsRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FindingIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings you want to archive.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingIds":{ + "shape":"FindingIds", + "documentation":"

IDs of the findings that you want to archive.

", + "locationName":"findingIds" + } + } + }, + "ArchiveFindingsResponse":{ + "type":"structure", + "members":{ + } + }, + "AwsApiCallAction":{ + "type":"structure", + "members":{ + "Api":{ + "shape":"String", + "documentation":"

AWS API name.

", + "locationName":"api" + }, + "CallerType":{ + "shape":"String", + "documentation":"

AWS API caller type.

", + "locationName":"callerType" + }, + "DomainDetails":{ + "shape":"DomainDetails", + "documentation":"

Domain information for the AWS API call.

", + "locationName":"domainDetails" + }, + "RemoteIpDetails":{ + "shape":"RemoteIpDetails", + "documentation":"

Remote IP information of the connection.

", + "locationName":"remoteIpDetails" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

AWS service name whose API was invoked.

", + "locationName":"serviceName" + } + }, + "documentation":"

Contains information about the API operation.

" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + }, + "Type":{ + "shape":"String", + "documentation":"

The error type.

", + "locationName":"__type" + } + }, + "documentation":"

Bad request exception object.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Boolean":{"type":"boolean"}, + "City":{ + "type":"structure", + "members":{ + "CityName":{ + "shape":"String", + "documentation":"

City name of the remote IP address.

", + "locationName":"cityName" + } + }, + "documentation":"

Contains information about the city associated with the IP address.

" + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":0 + }, + "Condition":{ + "type":"structure", + "members":{ + "Eq":{ + "shape":"Eq", + "documentation":"

Deprecated. Represents the equal condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"eq" + }, + "Neq":{ + "shape":"Neq", + "documentation":"

Deprecated. Represents the not equal condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"neq" + }, + "Gt":{ + "shape":"Integer", + "documentation":"

Deprecated. Represents a greater than condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"gt" + }, + "Gte":{ + "shape":"Integer", + "documentation":"

Deprecated. Represents a greater than equal condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"gte" + }, + "Lt":{ + "shape":"Integer", + "documentation":"

Deprecated. Represents a less than condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"lt" + }, + "Lte":{ + "shape":"Integer", + "documentation":"

Deprecated. Represents a less than equal condition to be applied to a single field when querying for findings.

", + "deprecated":true, + "locationName":"lte" + }, + "Equals":{ + "shape":"Equals", + "documentation":"

Represents an equal condition to be applied to a single field when querying for findings.

", + "locationName":"equals" + }, + "NotEquals":{ + "shape":"NotEquals", + "documentation":"

Represents an not equal condition to be applied to a single field when querying for findings.

", + "locationName":"notEquals" + }, + "GreaterThan":{ + "shape":"Long", + "documentation":"

Represents a greater than condition to be applied to a single field when querying for findings.

", + "locationName":"greaterThan" + }, + "GreaterThanOrEqual":{ + "shape":"Long", + "documentation":"

Represents a greater than equal condition to be applied to a single field when querying for findings.

", + "locationName":"greaterThanOrEqual" + }, + "LessThan":{ + "shape":"Long", + "documentation":"

Represents a less than condition to be applied to a single field when querying for findings.

", + "locationName":"lessThan" + }, + "LessThanOrEqual":{ + "shape":"Long", + "documentation":"

Represents a less than equal condition to be applied to a single field when querying for findings.

", + "locationName":"lessThanOrEqual" + } + }, + "documentation":"

Contains information about the condition.

" + }, + "CountBySeverity":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Integer"} + }, + "Country":{ + "type":"structure", + "members":{ + "CountryCode":{ + "shape":"String", + "documentation":"

Country code of the remote IP address.

", + "locationName":"countryCode" + }, + "CountryName":{ + "shape":"String", + "documentation":"

Country name of the remote IP address.

", + "locationName":"countryName" + } + }, + "documentation":"

Contains information about the country.

" + }, + "CreateDetectorRequest":{ + "type":"structure", + "required":["Enable"], + "members":{ + "Enable":{ + "shape":"Boolean", + "documentation":"

A boolean value that specifies whether the detector is to be enabled.

", + "locationName":"enable" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

The idempotency token for the create request.

", + "idempotencyToken":true, + "locationName":"clientToken" + }, + "FindingPublishingFrequency":{ + "shape":"FindingPublishingFrequency", + "documentation":"

A enum value that specifies how frequently customer got Finding updates published.

", + "locationName":"findingPublishingFrequency" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to be added to a new detector resource.

", + "locationName":"tags" + } + } + }, + "CreateDetectorResponse":{ + "type":"structure", + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the created detector.

", + "locationName":"detectorId" + } + } + }, + "CreateFilterRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "Name", + "FindingCriteria" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account for which you want to create a filter.

", + "location":"uri", + "locationName":"detectorId" + }, + "Name":{ + "shape":"FilterName", + "documentation":"

The name of the filter.

", + "locationName":"name" + }, + "Description":{ + "shape":"FilterDescription", + "documentation":"

The description of the filter.

", + "locationName":"description" + }, + "Action":{ + "shape":"FilterAction", + "documentation":"

Specifies the action that is to be applied to the findings that match the filter.

", + "locationName":"action" + }, + "Rank":{ + "shape":"FilterRank", + "documentation":"

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

", + "locationName":"rank" + }, + "FindingCriteria":{ + "shape":"FindingCriteria", + "documentation":"

Represents the criteria to be used in the filter for querying findings.

", + "locationName":"findingCriteria" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

The idempotency token for the create request.

", + "idempotencyToken":true, + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to be added to a new filter resource.

", + "locationName":"tags" + } + } + }, + "CreateFilterResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

The name of the successfully created filter.

", + "locationName":"name" + } + } + }, + "CreateIPSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "Name", + "Format", + "Location", + "Activate" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account for which you want to create an IPSet.

", + "location":"uri", + "locationName":"detectorId" + }, + "Name":{ + "shape":"Name", + "documentation":"

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

", + "locationName":"name" + }, + "Format":{ + "shape":"IpSetFormat", + "documentation":"

The format of the file that contains the IPSet.

", + "locationName":"format" + }, + "Location":{ + "shape":"Location", + "documentation":"

The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

", + "locationName":"location" + }, + "Activate":{ + "shape":"Boolean", + "documentation":"

A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

", + "locationName":"activate" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

The idempotency token for the create request.

", + "idempotencyToken":true, + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to be added to a new IP set resource.

", + "locationName":"tags" + } + } + }, + "CreateIPSetResponse":{ + "type":"structure", + "required":["IpSetId"], + "members":{ + "IpSetId":{ + "shape":"String", + "documentation":"

The ID of the IPSet resource.

", + "locationName":"ipSetId" + } + } + }, + "CreateMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountDetails" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account with which you want to associate member accounts.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountDetails":{ + "shape":"AccountDetails", + "documentation":"

A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account.

", + "locationName":"accountDetails" + } + } + }, + "CreateMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "CreateSampleFindingsRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector to create sample findings for.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingTypes":{ + "shape":"FindingTypes", + "documentation":"

Types of sample findings that you want to generate.

", + "locationName":"findingTypes" + } + } + }, + "CreateSampleFindingsResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateThreatIntelSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "Name", + "Format", + "Location", + "Activate" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account for which you want to create a threatIntelSet.

", + "location":"uri", + "locationName":"detectorId" + }, + "Name":{ + "shape":"Name", + "documentation":"

A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.

", + "locationName":"name" + }, + "Format":{ + "shape":"ThreatIntelSetFormat", + "documentation":"

The format of the file that contains the ThreatIntelSet.

", + "locationName":"format" + }, + "Location":{ + "shape":"Location", + "documentation":"

The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).

", + "locationName":"location" + }, + "Activate":{ + "shape":"Boolean", + "documentation":"

A boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

", + "locationName":"activate" + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

The idempotency token for the create request.

", + "idempotencyToken":true, + "locationName":"clientToken" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to be added to a new Threat List resource.

", + "locationName":"tags" + } + } + }, + "CreateThreatIntelSetResponse":{ + "type":"structure", + "required":["ThreatIntelSetId"], + "members":{ + "ThreatIntelSetId":{ + "shape":"String", + "documentation":"

The ID of the ThreatIntelSet resource.

", + "locationName":"threatIntelSetId" + } + } + }, + "Criterion":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Condition"} + }, + "DeclineInvitationsRequest":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from.

", + "locationName":"accountIds" + } + } + }, + "DeclineInvitationsResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "DeleteDetectorRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector that you want to delete.

", + "location":"uri", + "locationName":"detectorId" + } + } + }, + "DeleteDetectorResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteFilterRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FilterName" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the filter is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "FilterName":{ + "shape":"String", + "documentation":"

The name of the filter you want to delete.

", + "location":"uri", + "locationName":"filterName" + } + } + }, + "DeleteFilterResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteIPSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "IpSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the ipSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "IpSetId":{ + "shape":"String", + "documentation":"

The unique ID of the ipSet you want to delete.

", + "location":"uri", + "locationName":"ipSetId" + } + } + }, + "DeleteIPSetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteInvitationsRequest":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from.

", + "locationName":"accountIds" + } + } + }, + "DeleteInvitationsResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "DeleteMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account whose members you want to delete.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the GuardDuty member accounts that you want to delete.

", + "locationName":"accountIds" + } + } + }, + "DeleteMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

The accounts that could not be processed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "DeleteThreatIntelSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "ThreatIntelSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the threatIntelSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "ThreatIntelSetId":{ + "shape":"String", + "documentation":"

The unique ID of the threatIntelSet you want to delete.

", + "location":"uri", + "locationName":"threatIntelSetId" + } + } + }, + "DeleteThreatIntelSetResponse":{ + "type":"structure", + "members":{ + } + }, + "DetectorId":{ + "type":"string", + "max":300, + "min":1 + }, + "DetectorIds":{ + "type":"list", + "member":{"shape":"DetectorId"}, + "max":50, + "min":0 + }, + "DetectorStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ], + "max":300, + "min":1 + }, + "DisassociateFromMasterAccountRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty member account.

", + "location":"uri", + "locationName":"detectorId" + } + } + }, + "DisassociateFromMasterAccountResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account whose members you want to disassociate from master.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.

", + "locationName":"accountIds" + } + } + }, + "DisassociateMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "DnsRequestAction":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"String", + "documentation":"

Domain information for the DNS request.

", + "locationName":"domain" + } + }, + "documentation":"

Contains information about the DNS request.

" + }, + "DomainDetails":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"String", + "documentation":"

Domain information for the AWS API call.

", + "locationName":"domain" + } + }, + "documentation":"

Contains information about the domain.

" + }, + "Double":{"type":"double"}, + "Email":{ + "type":"string", + "max":64, + "min":1 + }, + "Eq":{ + "type":"list", + "member":{"shape":"String"} + }, + "Equals":{ + "type":"list", + "member":{"shape":"String"} + }, + "Evidence":{ + "type":"structure", + "members":{ + "ThreatIntelligenceDetails":{ + "shape":"ThreatIntelligenceDetails", + "documentation":"

A list of threat intelligence details related to the evidence.

", + "locationName":"threatIntelligenceDetails" + } + }, + "documentation":"

Contains information about the reason that the finding was generated.

" + }, + "Feedback":{ + "type":"string", + "enum":[ + "USEFUL", + "NOT_USEFUL" + ] + }, + "FilterAction":{ + "type":"string", + "enum":[ + "NOOP", + "ARCHIVE" + ], + "max":300, + "min":1 + }, + "FilterDescription":{ + "type":"string", + "max":512, + "min":0 + }, + "FilterName":{ + "type":"string", + "max":64, + "min":3 + }, + "FilterNames":{ + "type":"list", + "member":{"shape":"FilterName"}, + "max":50, + "min":0 + }, + "FilterRank":{ + "type":"integer", + "max":100, + "min":1 + }, + "Finding":{ + "type":"structure", + "required":[ + "AccountId", + "Arn", + "CreatedAt", + "Id", + "Region", + "Resource", + "SchemaVersion", + "Severity", + "Type", + "UpdatedAt" + ], + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

The ID of the account in which the finding was generated.

", + "locationName":"accountId" + }, + "Arn":{ + "shape":"String", + "documentation":"

The ARN for the finding.

", + "locationName":"arn" + }, + "Confidence":{ + "shape":"Double", + "documentation":"

The confidence score for the finding.

", + "locationName":"confidence" + }, + "CreatedAt":{ + "shape":"String", + "documentation":"

The time and date at which the finding was created.

", + "locationName":"createdAt" + }, + "Description":{ + "shape":"String", + "documentation":"

The description of the finding.

", + "locationName":"description" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of the finding.

", + "locationName":"id" + }, + "Partition":{ + "shape":"String", + "documentation":"

The partition associated with the finding.

", + "locationName":"partition" + }, + "Region":{ + "shape":"String", + "documentation":"

The Region in which the finding was generated.

", + "locationName":"region" + }, + "Resource":{ + "shape":"Resource", + "locationName":"resource" + }, + "SchemaVersion":{ + "shape":"String", + "documentation":"

The version of the schema used for the finding.

", + "locationName":"schemaVersion" + }, + "Service":{ + "shape":"Service", + "locationName":"service" + }, + "Severity":{ + "shape":"Double", + "documentation":"

The severity of the finding.

", + "locationName":"severity" + }, + "Title":{ + "shape":"String", + "documentation":"

The title for the finding.

", + "locationName":"title" + }, + "Type":{ + "shape":"FindingType", + "documentation":"

The type of the finding.

", + "locationName":"type" + }, + "UpdatedAt":{ + "shape":"String", + "documentation":"

The time and date at which the finding was laste updated.

", + "locationName":"updatedAt" + } + }, + "documentation":"

Contains information about the finding.

" + }, + "FindingCriteria":{ + "type":"structure", + "members":{ + "Criterion":{ + "shape":"Criterion", + "documentation":"

Represents a map of finding properties that match specified conditions and values when querying findings.

", + "locationName":"criterion" + } + }, + "documentation":"

Contains finding criteria information.

" + }, + "FindingId":{ + "type":"string", + "max":300, + "min":1 + }, + "FindingIds":{ + "type":"list", + "member":{"shape":"FindingId"}, + "max":50, + "min":0 + }, + "FindingPublishingFrequency":{ + "type":"string", + "enum":[ + "FIFTEEN_MINUTES", + "ONE_HOUR", + "SIX_HOURS" + ] + }, + "FindingStatisticType":{ + "type":"string", + "enum":["COUNT_BY_SEVERITY"] + }, + "FindingStatisticTypes":{ + "type":"list", + "member":{"shape":"FindingStatisticType"}, + "max":10, + "min":0 + }, + "FindingStatistics":{ + "type":"structure", + "members":{ + "CountBySeverity":{ + "shape":"CountBySeverity", + "documentation":"

Represents a map of severity to count statistic for a set of findings

", + "locationName":"countBySeverity" + } + }, + "documentation":"

Contains information about finding statistics.

" + }, + "FindingType":{ + "type":"string", + "max":50, + "min":1 + }, + "FindingTypes":{ + "type":"list", + "member":{"shape":"FindingType"}, + "max":50, + "min":0 + }, + "Findings":{ + "type":"list", + "member":{"shape":"Finding"}, + "max":50, + "min":0 + }, + "GeoLocation":{ + "type":"structure", + "members":{ + "Lat":{ + "shape":"Double", + "documentation":"

Latitude information of remote IP address.

", + "locationName":"lat" + }, + "Lon":{ + "shape":"Double", + "documentation":"

Longitude information of remote IP address.

", + "locationName":"lon" + } + }, + "documentation":"

Contains information about the

" + }, + "GetDetectorRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector that you want to get.

", + "location":"uri", + "locationName":"detectorId" + } + } + }, + "GetDetectorResponse":{ + "type":"structure", + "required":[ + "ServiceRole", + "Status" + ], + "members":{ + "CreatedAt":{ + "shape":"String", + "documentation":"

Detector creation timestamp.

", + "locationName":"createdAt" + }, + "FindingPublishingFrequency":{ + "shape":"FindingPublishingFrequency", + "documentation":"

Finding publishing frequency.

", + "locationName":"findingPublishingFrequency" + }, + "ServiceRole":{ + "shape":"String", + "documentation":"

The GuardDuty service role.

", + "locationName":"serviceRole" + }, + "Status":{ + "shape":"DetectorStatus", + "documentation":"

The detector status.

", + "locationName":"status" + }, + "UpdatedAt":{ + "shape":"String", + "documentation":"

Detector last update timestamp.

", + "locationName":"updatedAt" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags of the detector resource.

", + "locationName":"tags" + } + } + }, + "GetFilterRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FilterName" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the filter is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "FilterName":{ + "shape":"String", + "documentation":"

The name of the filter you want to get.

", + "location":"uri", + "locationName":"filterName" + } + } + }, + "GetFilterResponse":{ + "type":"structure", + "required":[ + "Name", + "Action", + "FindingCriteria" + ], + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

The name of the filter.

", + "locationName":"name" + }, + "Description":{ + "shape":"FilterDescription", + "documentation":"

The description of the filter.

", + "locationName":"description" + }, + "Action":{ + "shape":"FilterAction", + "documentation":"

Specifies the action that is to be applied to the findings that match the filter.

", + "locationName":"action" + }, + "Rank":{ + "shape":"FilterRank", + "documentation":"

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

", + "locationName":"rank" + }, + "FindingCriteria":{ + "shape":"FindingCriteria", + "documentation":"

Represents the criteria to be used in the filter for querying findings.

", + "locationName":"findingCriteria" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags of the filter resource.

", + "locationName":"tags" + } + } + }, + "GetFindingsRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FindingIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingIds":{ + "shape":"FindingIds", + "documentation":"

IDs of the findings that you want to retrieve.

", + "locationName":"findingIds" + }, + "SortCriteria":{ + "shape":"SortCriteria", + "documentation":"

Represents the criteria used for sorting findings.

", + "locationName":"sortCriteria" + } + } + }, + "GetFindingsResponse":{ + "type":"structure", + "required":["Findings"], + "members":{ + "Findings":{ + "shape":"Findings", + "documentation":"

A list of findings.

", + "locationName":"findings" + } + } + }, + "GetFindingsStatisticsRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FindingStatisticTypes" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingStatisticTypes":{ + "shape":"FindingStatisticTypes", + "documentation":"

Types of finding statistics to retrieve.

", + "locationName":"findingStatisticTypes" + }, + "FindingCriteria":{ + "shape":"FindingCriteria", + "documentation":"

Represents the criteria used for querying findings.

", + "locationName":"findingCriteria" + } + } + }, + "GetFindingsStatisticsResponse":{ + "type":"structure", + "required":["FindingStatistics"], + "members":{ + "FindingStatistics":{ + "shape":"FindingStatistics", + "documentation":"

Finding statistics object.

", + "locationName":"findingStatistics" + } + } + }, + "GetIPSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "IpSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the ipSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "IpSetId":{ + "shape":"String", + "documentation":"

The unique ID of the ipSet you want to get.

", + "location":"uri", + "locationName":"ipSetId" + } + } + }, + "GetIPSetResponse":{ + "type":"structure", + "required":[ + "Name", + "Format", + "Location", + "Status" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

", + "locationName":"name" + }, + "Format":{ + "shape":"IpSetFormat", + "documentation":"

The format of the file that contains the IPSet.

", + "locationName":"format" + }, + "Location":{ + "shape":"Location", + "documentation":"

The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

", + "locationName":"location" + }, + "Status":{ + "shape":"IpSetStatus", + "documentation":"

The status of ipSet file uploaded.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags of the IP set resource.

", + "locationName":"tags" + } + } + }, + "GetInvitationsCountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetInvitationsCountResponse":{ + "type":"structure", + "members":{ + "InvitationsCount":{ + "shape":"Integer", + "documentation":"

The number of received invitations.

", + "locationName":"invitationsCount" + } + } + }, + "GetMasterAccountRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty member account.

", + "location":"uri", + "locationName":"detectorId" + } + } + }, + "GetMasterAccountResponse":{ + "type":"structure", + "required":["Master"], + "members":{ + "Master":{ + "shape":"Master", + "documentation":"

Master account details.

", + "locationName":"master" + } + } + }, + "GetMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the GuardDuty member accounts that you want to describe.

", + "locationName":"accountIds" + } + } + }, + "GetMembersResponse":{ + "type":"structure", + "required":[ + "Members", + "UnprocessedAccounts" + ], + "members":{ + "Members":{ + "shape":"Members", + "documentation":"

A list of members.

", + "locationName":"members" + }, + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "GetThreatIntelSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "ThreatIntelSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the threatIntelSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "ThreatIntelSetId":{ + "shape":"String", + "documentation":"

The unique ID of the threatIntelSet you want to get.

", + "location":"uri", + "locationName":"threatIntelSetId" + } + } + }, + "GetThreatIntelSetResponse":{ + "type":"structure", + "required":[ + "Name", + "Format", + "Location", + "Status" + ], + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

A user-friendly ThreatIntelSet name that is displayed in all finding generated by activity that involves IP addresses included in this ThreatIntelSet.

", + "locationName":"name" + }, + "Format":{ + "shape":"ThreatIntelSetFormat", + "documentation":"

The format of the threatIntelSet.

", + "locationName":"format" + }, + "Location":{ + "shape":"Location", + "documentation":"

The URI of the file that contains the ThreatIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).

", + "locationName":"location" + }, + "Status":{ + "shape":"ThreatIntelSetStatus", + "documentation":"

The status of threatIntelSet file uploaded.

", + "locationName":"status" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags of the Threat List resource.

", + "locationName":"tags" + } + } + }, + "GuardDutyArn":{ + "type":"string", + "pattern":"^arn:[A-Za-z_.-]{1,20}:guardduty:[A-Za-z0-9_/.-]{0,63}:\\d+:detector/[A-Za-z0-9_/.-]{32,264}$" + }, + "IamInstanceProfile":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

AWS EC2 instance profile ARN.

", + "locationName":"arn" + }, + "Id":{ + "shape":"String", + "documentation":"

AWS EC2 instance profile ID.

", + "locationName":"id" + } + }, + "documentation":"

Contains information about the instance profile.

" + }, + "InstanceDetails":{ + "type":"structure", + "members":{ + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The availability zone of the EC2 instance.

", + "locationName":"availabilityZone" + }, + "IamInstanceProfile":{ + "shape":"IamInstanceProfile", + "documentation":"

The profile information of the EC2 instance.

", + "locationName":"iamInstanceProfile" + }, + "ImageDescription":{ + "shape":"String", + "documentation":"

The image description of the EC2 instance.

", + "locationName":"imageDescription" + }, + "ImageId":{ + "shape":"String", + "documentation":"

The image ID of the EC2 instance.

", + "locationName":"imageId" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the EC2 instance.

", + "locationName":"instanceId" + }, + "InstanceState":{ + "shape":"String", + "documentation":"

The state of the EC2 instance.

", + "locationName":"instanceState" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The type of the EC2 instance.

", + "locationName":"instanceType" + }, + "LaunchTime":{ + "shape":"String", + "documentation":"

The launch time of the EC2 instance.

", + "locationName":"launchTime" + }, + "NetworkInterfaces":{ + "shape":"NetworkInterfaces", + "documentation":"

The network interface information of the EC2 instance.

", + "locationName":"networkInterfaces" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform of the EC2 instance.

", + "locationName":"platform" + }, + "ProductCodes":{ + "shape":"ProductCodes", + "documentation":"

The product code of the EC2 instance.

", + "locationName":"productCodes" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags of the EC2 instance.

", + "locationName":"tags" + } + }, + "documentation":"

Contains information about the details of an instance.

" + }, + "Integer":{"type":"integer"}, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

The error message.

", + "locationName":"message" + }, + "Type":{ + "shape":"String", + "documentation":"

The error type.

", + "locationName":"__type" + } + }, + "documentation":"

Internal server error exception object.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "Invitation":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

Inviter account ID

", + "locationName":"accountId" + }, + "InvitationId":{ + "shape":"String", + "documentation":"

This value is used to validate the inviter account to the member account.

", + "locationName":"invitationId" + }, + "RelationshipStatus":{ + "shape":"String", + "documentation":"

The status of the relationship between the inviter and invitee accounts.

", + "locationName":"relationshipStatus" + }, + "InvitedAt":{ + "shape":"String", + "documentation":"

Timestamp at which the invitation was sent

", + "locationName":"invitedAt" + } + }, + "documentation":"

Contains information about the invitation.

" + }, + "Invitations":{ + "type":"list", + "member":{"shape":"Invitation"}, + "max":50, + "min":0 + }, + "InviteMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account with which you want to invite members.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the accounts that you want to invite to GuardDuty as members.

", + "locationName":"accountIds" + }, + "DisableEmailNotification":{ + "shape":"Boolean", + "documentation":"

A boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.

", + "locationName":"disableEmailNotification" + }, + "Message":{ + "shape":"String", + "documentation":"

The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.

", + "locationName":"message" + } + } + }, + "InviteMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "IpSetFormat":{ + "type":"string", + "enum":[ + "TXT", + "STIX", + "OTX_CSV", + "ALIEN_VAULT", + "PROOF_POINT", + "FIRE_EYE" + ], + "max":300, + "min":1 + }, + "IpSetIds":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":0 + }, + "IpSetStatus":{ + "type":"string", + "enum":[ + "INACTIVE", + "ACTIVATING", + "ACTIVE", + "DEACTIVATING", + "ERROR", + "DELETE_PENDING", + "DELETED" + ], + "max":300, + "min":1 + }, + "Ipv6Addresses":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListDetectorsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListDetectorsResponse":{ + "type":"structure", + "required":["DetectorIds"], + "members":{ + "DetectorIds":{ + "shape":"DetectorIds", + "documentation":"

A list of detector Ids.

", + "locationName":"detectorIds" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListFiltersRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the filter is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListFiltersResponse":{ + "type":"structure", + "required":["FilterNames"], + "members":{ + "FilterNames":{ + "shape":"FilterNames", + "documentation":"

A list of filter names

", + "locationName":"filterNames" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListFindingsRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings you want to list.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingCriteria":{ + "shape":"FindingCriteria", + "documentation":"

Represents the criteria used for querying findings.

", + "locationName":"findingCriteria" + }, + "SortCriteria":{ + "shape":"SortCriteria", + "documentation":"

Represents the criteria used for sorting findings.

", + "locationName":"sortCriteria" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "locationName":"nextToken" + } + } + }, + "ListFindingsResponse":{ + "type":"structure", + "required":["FindingIds"], + "members":{ + "FindingIds":{ + "shape":"FindingIds", + "documentation":"

The IDs of the findings you are listing.

", + "locationName":"findingIds" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListIPSetsRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the ipSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListIPSetsResponse":{ + "type":"structure", + "required":["IpSetIds"], + "members":{ + "IpSetIds":{ + "shape":"IpSetIds", + "documentation":"

The IDs of the IPSet resources.

", + "locationName":"ipSetIds" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListInvitationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListInvitationsResponse":{ + "type":"structure", + "members":{ + "Invitations":{ + "shape":"Invitations", + "documentation":"

A list of invitation descriptions.

", + "locationName":"invitations" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListMembersRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the member is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + }, + "OnlyAssociated":{ + "shape":"String", + "documentation":"

Specifies whether to only return associated members or to return all members (including members which haven't been invited yet or have been disassociated).

", + "location":"querystring", + "locationName":"onlyAssociated" + } + } + }, + "ListMembersResponse":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"Members", + "documentation":"

A list of members.

", + "locationName":"members" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"GuardDutyArn", + "documentation":"

The Amazon Resource Name (ARN) for the given GuardDuty resource

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags associated with the resource.

", + "locationName":"tags" + } + } + }, + "ListThreatIntelSetsRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector the threatIntelSet is associated with.

", + "location":"uri", + "locationName":"detectorId" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"String", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListThreatIntelSetsResponse":{ + "type":"structure", + "required":["ThreatIntelSetIds"], + "members":{ + "ThreatIntelSetIds":{ + "shape":"ThreatIntelSetIds", + "documentation":"

The IDs of the ThreatIntelSet resources.

", + "locationName":"threatIntelSetIds" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Pagination parameter to be used on the next list operation to retrieve more items.

", + "locationName":"nextToken" + } + } + }, + "LocalPortDetails":{ + "type":"structure", + "members":{ + "Port":{ + "shape":"Integer", + "documentation":"

Port number of the local connection.

", + "locationName":"port" + }, + "PortName":{ + "shape":"String", + "documentation":"

Port name of the local connection.

", + "locationName":"portName" + } + }, + "documentation":"

Contains information about the port for the local connection.

" + }, + "Location":{ + "type":"string", + "max":300, + "min":1 + }, + "Long":{"type":"long"}, + "Master":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The ID of the account used as the Master account.

", + "locationName":"accountId" + }, + "InvitationId":{ + "shape":"String", + "documentation":"

This value is used to validate the master account to the member account.

", + "locationName":"invitationId" + }, + "RelationshipStatus":{ + "shape":"String", + "documentation":"

The status of the relationship between the master and member accounts.

", + "locationName":"relationshipStatus" + }, + "InvitedAt":{ + "shape":"String", + "documentation":"

Timestamp at which the invitation was sent.

", + "locationName":"invitedAt" + } + }, + "documentation":"

Contains information about the Master account and invitation.

" + }, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "Member":{ + "type":"structure", + "required":[ + "AccountId", + "MasterId", + "Email", + "RelationshipStatus", + "UpdatedAt" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

Member account ID.

", + "locationName":"accountId" + }, + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

Member account's detector ID.

", + "locationName":"detectorId" + }, + "MasterId":{ + "shape":"String", + "documentation":"

Master account ID.

", + "locationName":"masterId" + }, + "Email":{ + "shape":"Email", + "documentation":"

Member account's email address.

", + "locationName":"email" + }, + "RelationshipStatus":{ + "shape":"String", + "documentation":"

The status of the relationship between the member and the master.

", + "locationName":"relationshipStatus" + }, + "InvitedAt":{ + "shape":"String", + "documentation":"

Timestamp at which the invitation was sent

", + "locationName":"invitedAt" + }, + "UpdatedAt":{ + "shape":"String", + "documentation":"

Member last updated timestamp.

", + "locationName":"updatedAt" + } + }, + "documentation":"

Continas information about the member account

" + }, + "Members":{ + "type":"list", + "member":{"shape":"Member"}, + "max":50, + "min":0 + }, + "Name":{ + "type":"string", + "max":300, + "min":1 + }, + "Neq":{ + "type":"list", + "member":{"shape":"String"} + }, + "NetworkConnectionAction":{ + "type":"structure", + "members":{ + "Blocked":{ + "shape":"Boolean", + "documentation":"

Network connection blocked information.

", + "locationName":"blocked" + }, + "ConnectionDirection":{ + "shape":"String", + "documentation":"

Network connection direction.

", + "locationName":"connectionDirection" + }, + "LocalPortDetails":{ + "shape":"LocalPortDetails", + "documentation":"

Local port information of the connection.

", + "locationName":"localPortDetails" + }, + "Protocol":{ + "shape":"String", + "documentation":"

Network connection protocol.

", + "locationName":"protocol" + }, + "RemoteIpDetails":{ + "shape":"RemoteIpDetails", + "documentation":"

Remote IP information of the connection.

", + "locationName":"remoteIpDetails" + }, + "RemotePortDetails":{ + "shape":"RemotePortDetails", + "documentation":"

Remote port information of the connection.

", + "locationName":"remotePortDetails" + } + }, + "documentation":"

Contains information about the network connection.

" + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "Ipv6Addresses":{ + "shape":"Ipv6Addresses", + "documentation":"

A list of EC2 instance IPv6 address information.

", + "locationName":"ipv6Addresses" + }, + "NetworkInterfaceId":{ + "shape":"String", + "documentation":"

The ID of the network interface

", + "locationName":"networkInterfaceId" + }, + "PrivateDnsName":{ + "shape":"String", + "documentation":"

Private DNS name of the EC2 instance.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

Private IP address of the EC2 instance.

", + "locationName":"privateIpAddress" + }, + "PrivateIpAddresses":{ + "shape":"PrivateIpAddresses", + "documentation":"

Other private IP address information of the EC2 instance.

", + "locationName":"privateIpAddresses" + }, + "PublicDnsName":{ + "shape":"String", + "documentation":"

Public DNS name of the EC2 instance.

", + "locationName":"publicDnsName" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

Public IP address of the EC2 instance.

", + "locationName":"publicIp" + }, + "SecurityGroups":{ + "shape":"SecurityGroups", + "documentation":"

Security groups associated with the EC2 instance.

", + "locationName":"securityGroups" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The subnet ID of the EC2 instance.

", + "locationName":"subnetId" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC ID of the EC2 instance.

", + "locationName":"vpcId" + } + }, + "documentation":"

Contains information about the network interface.

" + }, + "NetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "NotEquals":{ + "type":"list", + "member":{"shape":"String"} + }, + "OrderBy":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "Organization":{ + "type":"structure", + "members":{ + "Asn":{ + "shape":"String", + "documentation":"

Autonomous system number of the internet provider of the remote IP address.

", + "locationName":"asn" + }, + "AsnOrg":{ + "shape":"String", + "documentation":"

Organization that registered this ASN.

", + "locationName":"asnOrg" + }, + "Isp":{ + "shape":"String", + "documentation":"

ISP information for the internet provider.

", + "locationName":"isp" + }, + "Org":{ + "shape":"String", + "documentation":"

Name of the internet provider.

", + "locationName":"org" + } + }, + "documentation":"

Continas information about the organization.

" + }, + "PortProbeAction":{ + "type":"structure", + "members":{ + "Blocked":{ + "shape":"Boolean", + "documentation":"

Port probe blocked information.

", + "locationName":"blocked" + }, + "PortProbeDetails":{ + "shape":"PortProbeDetails", + "documentation":"

A list of port probe details objects.

", + "locationName":"portProbeDetails" + } + }, + "documentation":"

Contains information about the port probe.

" + }, + "PortProbeDetail":{ + "type":"structure", + "members":{ + "LocalPortDetails":{ + "shape":"LocalPortDetails", + "documentation":"

Local port information of the connection.

", + "locationName":"localPortDetails" + }, + "RemoteIpDetails":{ + "shape":"RemoteIpDetails", + "documentation":"

Remote IP information of the connection.

", + "locationName":"remoteIpDetails" + } + }, + "documentation":"

Contains information about the port probe details.

" + }, + "PortProbeDetails":{ + "type":"list", + "member":{"shape":"PortProbeDetail"} + }, + "PrivateIpAddressDetails":{ + "type":"structure", + "members":{ + "PrivateDnsName":{ + "shape":"String", + "documentation":"

Private DNS name of the EC2 instance.

", + "locationName":"privateDnsName" + }, + "PrivateIpAddress":{ + "shape":"String", + "documentation":"

Private IP address of the EC2 instance.

", + "locationName":"privateIpAddress" + } + }, + "documentation":"

Contains information about the private IP address.

" + }, + "PrivateIpAddresses":{ + "type":"list", + "member":{"shape":"PrivateIpAddressDetails"} + }, + "ProductCode":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"String", + "documentation":"

Product code information.

", + "locationName":"code" + }, + "ProductType":{ + "shape":"String", + "documentation":"

Product code type.

", + "locationName":"productType" + } + }, + "documentation":"

Contains information about the product code.

" + }, + "ProductCodes":{ + "type":"list", + "member":{"shape":"ProductCode"} + }, + "RemoteIpDetails":{ + "type":"structure", + "members":{ + "City":{ + "shape":"City", + "documentation":"

City information of the remote IP address.

", + "locationName":"city" + }, + "Country":{ + "shape":"Country", + "documentation":"

Country code of the remote IP address.

", + "locationName":"country" + }, + "GeoLocation":{ + "shape":"GeoLocation", + "documentation":"

Location information of the remote IP address.

", + "locationName":"geoLocation" + }, + "IpAddressV4":{ + "shape":"String", + "documentation":"

IPV4 remote address of the connection.

", + "locationName":"ipAddressV4" + }, + "Organization":{ + "shape":"Organization", + "documentation":"

ISP Organization information of the remote IP address.

", + "locationName":"organization" + } + }, + "documentation":"

Continas information about the remote IP address.

" + }, + "RemotePortDetails":{ + "type":"structure", + "members":{ + "Port":{ + "shape":"Integer", + "documentation":"

Port number of the remote connection.

", + "locationName":"port" + }, + "PortName":{ + "shape":"String", + "documentation":"

Port name of the remote connection.

", + "locationName":"portName" + } + }, + "documentation":"

Contains information about the remote port.

" + }, + "Resource":{ + "type":"structure", + "members":{ + "AccessKeyDetails":{ + "shape":"AccessKeyDetails", + "documentation":"

The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.

", + "locationName":"accessKeyDetails" + }, + "InstanceDetails":{ + "shape":"InstanceDetails", + "documentation":"

The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.

", + "locationName":"instanceDetails" + }, + "ResourceType":{ + "shape":"String", + "documentation":"

The type of the AWS resource.

", + "locationName":"resourceType" + } + }, + "documentation":"

Contains information about the resource.

" + }, + "SecurityGroup":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"String", + "documentation":"

EC2 instance's security group ID.

", + "locationName":"groupId" + }, + "GroupName":{ + "shape":"String", + "documentation":"

EC2 instance's security group name.

", + "locationName":"groupName" + } + }, + "documentation":"

Contains information about the security group.

" + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"} + }, + "Service":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"Action", + "documentation":"

Information about the activity described in a finding.

", + "locationName":"action" + }, + "Evidence":{ + "shape":"Evidence", + "documentation":"

An evidence object associated with the service.

", + "locationName":"evidence" + }, + "Archived":{ + "shape":"Boolean", + "documentation":"

Indicates whether this finding is archived.

", + "locationName":"archived" + }, + "Count":{ + "shape":"Integer", + "documentation":"

Total count of the occurrences of this finding type.

", + "locationName":"count" + }, + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

Detector ID for the GuardDuty service.

", + "locationName":"detectorId" + }, + "EventFirstSeen":{ + "shape":"String", + "documentation":"

First seen timestamp of the activity that prompted GuardDuty to generate this finding.

", + "locationName":"eventFirstSeen" + }, + "EventLastSeen":{ + "shape":"String", + "documentation":"

Last seen timestamp of the activity that prompted GuardDuty to generate this finding.

", + "locationName":"eventLastSeen" + }, + "ResourceRole":{ + "shape":"String", + "documentation":"

Resource role information for this finding.

", + "locationName":"resourceRole" + }, + "ServiceName":{ + "shape":"String", + "documentation":"

The name of the AWS service (GuardDuty) that generated a finding.

", + "locationName":"serviceName" + }, + "UserFeedback":{ + "shape":"String", + "documentation":"

Feedback left about the finding.

", + "locationName":"userFeedback" + } + }, + "documentation":"

Contains information about the service.

" + }, + "SortCriteria":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

Represents the finding attribute (for example, accountId) by which to sort findings.

", + "locationName":"attributeName" + }, + "OrderBy":{ + "shape":"OrderBy", + "documentation":"

Order by which the sorted findings are to be displayed.

", + "locationName":"orderBy" + } + }, + "documentation":"

Contains information about the criteria for sorting.

" + }, + "StartMonitoringMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account whom you want to re-enable to monitor members' findings.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the GuardDuty member accounts whose findings you want the master account to monitor.

", + "locationName":"accountIds" + } + } + }, + "StartMonitoringMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "StopMonitoringMembersRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "AccountIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector of the GuardDuty account that you want to stop from monitor members' findings.

", + "location":"uri", + "locationName":"detectorId" + }, + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring.

", + "locationName":"accountIds" + } + } + }, + "StopMonitoringMembersResponse":{ + "type":"structure", + "required":["UnprocessedAccounts"], + "members":{ + "UnprocessedAccounts":{ + "shape":"UnprocessedAccounts", + "documentation":"

A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.

", + "locationName":"unprocessedAccounts" + } + } + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

EC2 instance tag key.

", + "locationName":"key" + }, + "Value":{ + "shape":"String", + "documentation":"

EC2 instance tag value.

", + "locationName":"value" + } + }, + "documentation":"

Contains information about the tag associated with the resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"GuardDutyArn", + "documentation":"

The Amazon Resource Name (ARN) for the given GuardDuty resource

", + "location":"uri", + "locationName":"resourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

The tags to be added to a resource.

", + "locationName":"tags" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "ThreatIntelSetFormat":{ + "type":"string", + "enum":[ + "TXT", + "STIX", + "OTX_CSV", + "ALIEN_VAULT", + "PROOF_POINT", + "FIRE_EYE" + ], + "max":300, + "min":1 + }, + "ThreatIntelSetIds":{ + "type":"list", + "member":{"shape":"String"}, + "max":50, + "min":0 + }, + "ThreatIntelSetStatus":{ + "type":"string", + "enum":[ + "INACTIVE", + "ACTIVATING", + "ACTIVE", + "DEACTIVATING", + "ERROR", + "DELETE_PENDING", + "DELETED" + ], + "max":300, + "min":1 + }, + "ThreatIntelligenceDetail":{ + "type":"structure", + "members":{ + "ThreatListName":{ + "shape":"String", + "documentation":"

The name of the threat intelligence list that triggered the finding.

", + "locationName":"threatListName" + }, + "ThreatNames":{ + "shape":"ThreatNames", + "documentation":"

A list of names of the threats in the threat intelligence list that triggered the finding.

", + "locationName":"threatNames" + } + }, + "documentation":"

An instance of a threat intelligence detail that constitutes evidence for the finding.

" + }, + "ThreatIntelligenceDetails":{ + "type":"list", + "member":{"shape":"ThreatIntelligenceDetail"} + }, + "ThreatNames":{ + "type":"list", + "member":{"shape":"String"} + }, + "UnarchiveFindingsRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FindingIds" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings you want to unarchive.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingIds":{ + "shape":"FindingIds", + "documentation":"

IDs of the findings that you want to unarchive.

", + "locationName":"findingIds" + } + } + }, + "UnarchiveFindingsResponse":{ + "type":"structure", + "members":{ + } + }, + "UnprocessedAccount":{ + "type":"structure", + "required":[ + "AccountId", + "Result" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

AWS Account ID.

", + "locationName":"accountId" + }, + "Result":{ + "shape":"String", + "documentation":"

A reason why the account hasn't been processed.

", + "locationName":"result" + } + }, + "documentation":"

Contains information about the accounts that were not processed.

" + }, + "UnprocessedAccounts":{ + "type":"list", + "member":{"shape":"UnprocessedAccount"}, + "max":50, + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"GuardDutyArn", + "documentation":"

The Amazon Resource Name (ARN) for the given GuardDuty resource

", + "location":"uri", + "locationName":"resourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tag keys to remove from a resource.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDetectorRequest":{ + "type":"structure", + "required":["DetectorId"], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector that you want to update.

", + "location":"uri", + "locationName":"detectorId" + }, + "Enable":{ + "shape":"Boolean", + "documentation":"

Updated boolean value for the detector that specifies whether the detector is enabled.

", + "locationName":"enable" + }, + "FindingPublishingFrequency":{ + "shape":"FindingPublishingFrequency", + "documentation":"

A enum value that specifies how frequently customer got Finding updates published.

", + "locationName":"findingPublishingFrequency" + } + } + }, + "UpdateDetectorResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateFilterRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FilterName" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.

", + "location":"uri", + "locationName":"detectorId" + }, + "FilterName":{ + "shape":"String", + "documentation":"

The name of the filter.

", + "location":"uri", + "locationName":"filterName" + }, + "Description":{ + "shape":"FilterDescription", + "documentation":"

The description of the filter.

", + "locationName":"description" + }, + "Action":{ + "shape":"FilterAction", + "documentation":"

Specifies the action that is to be applied to the findings that match the filter.

", + "locationName":"action" + }, + "Rank":{ + "shape":"FilterRank", + "documentation":"

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

", + "locationName":"rank" + }, + "FindingCriteria":{ + "shape":"FindingCriteria", + "documentation":"

Represents the criteria to be used in the filter for querying findings.

", + "locationName":"findingCriteria" + } + } + }, + "UpdateFilterResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

The name of the filter.

", + "locationName":"name" + } + } + }, + "UpdateFindingsFeedbackRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "FindingIds", + "Feedback" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The ID of the detector that specifies the GuardDuty service whose findings you want to mark as useful or not useful.

", + "location":"uri", + "locationName":"detectorId" + }, + "FindingIds":{ + "shape":"FindingIds", + "documentation":"

IDs of the findings that you want to mark as useful or not useful.

", + "locationName":"findingIds" + }, + "Feedback":{ + "shape":"Feedback", + "documentation":"

Valid values: USEFUL | NOT_USEFUL

", + "locationName":"feedback" + }, + "Comments":{ + "shape":"String", + "documentation":"

Additional feedback about the GuardDuty findings.

", + "locationName":"comments" + } + } + }, + "UpdateFindingsFeedbackResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateIPSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "IpSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The detectorID that specifies the GuardDuty service whose IPSet you want to update.

", + "location":"uri", + "locationName":"detectorId" + }, + "IpSetId":{ + "shape":"String", + "documentation":"

The unique ID that specifies the IPSet that you want to update.

", + "location":"uri", + "locationName":"ipSetId" + }, + "Name":{ + "shape":"Name", + "documentation":"

The unique ID that specifies the IPSet that you want to update.

", + "locationName":"name" + }, + "Location":{ + "shape":"Location", + "documentation":"

The updated URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key).

", + "locationName":"location" + }, + "Activate":{ + "shape":"Boolean", + "documentation":"

The updated boolean value that specifies whether the IPSet is active or not.

", + "locationName":"activate" + } + } + }, + "UpdateIPSetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateThreatIntelSetRequest":{ + "type":"structure", + "required":[ + "DetectorId", + "ThreatIntelSetId" + ], + "members":{ + "DetectorId":{ + "shape":"DetectorId", + "documentation":"

The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.

", + "location":"uri", + "locationName":"detectorId" + }, + "ThreatIntelSetId":{ + "shape":"String", + "documentation":"

The unique ID that specifies the ThreatIntelSet that you want to update.

", + "location":"uri", + "locationName":"threatIntelSetId" + }, + "Name":{ + "shape":"Name", + "documentation":"

The unique ID that specifies the ThreatIntelSet that you want to update.

", + "locationName":"name" + }, + "Location":{ + "shape":"Location", + "documentation":"

The updated URI of the file that contains the ThreateIntelSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

", + "locationName":"location" + }, + "Activate":{ + "shape":"Boolean", + "documentation":"

The updated boolean value that specifies whether the ThreateIntelSet is active or not.

", + "locationName":"activate" + } + } + }, + "UpdateThreatIntelSetResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"

Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.

" +} diff --git a/aws/dist/botocore/data/health/2016-08-04/examples-1.json b/aws/dist/botocore/data/health/2016-08-04/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/health/2016-08-04/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/health/2016-08-04/paginators-1.json b/aws/dist/botocore/data/health/2016-08-04/paginators-1.json new file mode 100644 index 00000000..dcf401ad --- /dev/null +++ b/aws/dist/botocore/data/health/2016-08-04/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeAffectedEntities": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "entities" + }, + "DescribeEventAggregates": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "eventAggregates" + }, + "DescribeEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "events" + }, + "DescribeEventTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "eventTypes" + } + } +} diff --git a/aws/dist/botocore/data/health/2016-08-04/service-2.json b/aws/dist/botocore/data/health/2016-08-04/service-2.json new file mode 100644 index 00000000..00f4bbc4 --- /dev/null +++ b/aws/dist/botocore/data/health/2016-08-04/service-2.json @@ -0,0 +1,830 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-08-04", + "endpointPrefix":"health", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWSHealth", + "serviceFullName":"AWS Health APIs and Notifications", + "serviceId":"Health", + "signatureVersion":"v4", + "targetPrefix":"AWSHealth_20160804", + "uid":"health-2016-08-04" + }, + "operations":{ + "DescribeAffectedEntities":{ + "name":"DescribeAffectedEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAffectedEntitiesRequest"}, + "output":{"shape":"DescribeAffectedEntitiesResponse"}, + "errors":[ + {"shape":"InvalidPaginationToken"}, + {"shape":"UnsupportedLocale"} + ], + "documentation":"

Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.

At least one event ARN is required. Results are sorted by the lastUpdatedTime of the entity, starting with the most recent.

", + "idempotent":true + }, + "DescribeEntityAggregates":{ + "name":"DescribeEntityAggregates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEntityAggregatesRequest"}, + "output":{"shape":"DescribeEntityAggregatesResponse"}, + "documentation":"

Returns the number of entities that are affected by each of the specified events. If no events are specified, the counts of all affected entities are returned.

", + "idempotent":true + }, + "DescribeEventAggregates":{ + "name":"DescribeEventAggregates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventAggregatesRequest"}, + "output":{"shape":"DescribeEventAggregatesResponse"}, + "errors":[ + {"shape":"InvalidPaginationToken"} + ], + "documentation":"

Returns the number of events of each event type (issue, scheduled change, and account notification). If no filter is specified, the counts of all events in each category are returned.

", + "idempotent":true + }, + "DescribeEventDetails":{ + "name":"DescribeEventDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventDetailsRequest"}, + "output":{"shape":"DescribeEventDetailsResponse"}, + "errors":[ + {"shape":"UnsupportedLocale"} + ], + "documentation":"

Returns detailed information about one or more specified events. Information includes standard event data (region, service, etc., as returned by DescribeEvents), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the DescribeAffectedEntities operation.

If a specified event cannot be retrieved, an error message is returned for that event.

", + "idempotent":true + }, + "DescribeEventTypes":{ + "name":"DescribeEventTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventTypesRequest"}, + "output":{"shape":"DescribeEventTypesResponse"}, + "errors":[ + {"shape":"InvalidPaginationToken"}, + {"shape":"UnsupportedLocale"} + ], + "documentation":"

Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.

", + "idempotent":true + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsRequest"}, + "output":{"shape":"DescribeEventsResponse"}, + "errors":[ + {"shape":"InvalidPaginationToken"}, + {"shape":"UnsupportedLocale"} + ], + "documentation":"

Returns information about events that meet the specified filter criteria. Events are returned in a summary form and do not include the detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the DescribeEventDetails and DescribeAffectedEntities operations.

If no filter criteria are specified, all events are returned. Results are sorted by lastModifiedTime, starting with the most recent.

", + "idempotent":true + } + }, + "shapes":{ + "AffectedEntity":{ + "type":"structure", + "members":{ + "entityArn":{ + "shape":"entityArn", + "documentation":"

The unique identifier for the entity. Format: arn:aws:health:entity-region:aws-account:entity/entity-id . Example: arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K

" + }, + "eventArn":{ + "shape":"eventArn", + "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

" + }, + "entityValue":{ + "shape":"entityValue", + "documentation":"

The ID of the affected entity.

" + }, + "entityUrl":{"shape":"entityUrl"}, + "awsAccountId":{ + "shape":"accountId", + "documentation":"

The 12-digit AWS account number that contains the affected entity.

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

The most recent time that the entity was updated.

" + }, + "statusCode":{ + "shape":"entityStatusCode", + "documentation":"

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

" + }, + "tags":{ + "shape":"tagSet", + "documentation":"

A map of entity tags attached to the affected entity.

" + } + }, + "documentation":"

Information about an entity that is affected by a Health event.

" + }, + "DateTimeRange":{ + "type":"structure", + "members":{ + "from":{ + "shape":"timestamp", + "documentation":"

The starting date and time of a time range.

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

The ending date and time of a time range.

" + } + }, + "documentation":"

A range of dates and times that is used by the EventFilter and EntityFilter objects. If from is set and to is set: match items where the timestamp (startTime, endTime, or lastUpdatedTime) is between from and to inclusive. If from is set and to is not set: match items where the timestamp value is equal to or after from. If from is not set and to is set: match items where the timestamp value is equal to or before to.

" + }, + "DescribeAffectedEntitiesRequest":{ + "type":"structure", + "required":["filter"], + "members":{ + "filter":{ + "shape":"EntityFilter", + "documentation":"

Values to narrow the results returned. At least one event ARN is required.

" + }, + "locale":{ + "shape":"locale", + "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + }, + "maxResults":{ + "shape":"maxResults", + "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + } + } + }, + "DescribeAffectedEntitiesResponse":{ + "type":"structure", + "members":{ + "entities":{ + "shape":"EntityList", + "documentation":"

The entities that match the filter criteria.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + } + } + }, + "DescribeEntityAggregatesRequest":{ + "type":"structure", + "members":{ + "eventArns":{ + "shape":"EventArnsList", + "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"

" + } + } + }, + "DescribeEntityAggregatesResponse":{ + "type":"structure", + "members":{ + "entityAggregates":{ + "shape":"EntityAggregateList", + "documentation":"

The number of entities that are affected by each of the specified events.

" + } + } + }, + "DescribeEventAggregatesRequest":{ + "type":"structure", + "required":["aggregateField"], + "members":{ + "filter":{ + "shape":"EventFilter", + "documentation":"

Values to narrow the results returned.

" + }, + "aggregateField":{ + "shape":"eventAggregateField", + "documentation":"

The only currently supported value is eventTypeCategory.

" + }, + "maxResults":{ + "shape":"maxResults", + "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + } + } + }, + "DescribeEventAggregatesResponse":{ + "type":"structure", + "members":{ + "eventAggregates":{ + "shape":"EventAggregateList", + "documentation":"

The number of events in each category that meet the optional filter criteria.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + } + } + }, + "DescribeEventDetailsFailedSet":{ + "type":"list", + "member":{"shape":"EventDetailsErrorItem"} + }, + "DescribeEventDetailsRequest":{ + "type":"structure", + "required":["eventArns"], + "members":{ + "eventArns":{ + "shape":"eventArnList", + "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"

" + }, + "locale":{ + "shape":"locale", + "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + } + } + }, + "DescribeEventDetailsResponse":{ + "type":"structure", + "members":{ + "successfulSet":{ + "shape":"DescribeEventDetailsSuccessfulSet", + "documentation":"

Information about the events that could be retrieved.

" + }, + "failedSet":{ + "shape":"DescribeEventDetailsFailedSet", + "documentation":"

Error messages for any events that could not be retrieved.

" + } + } + }, + "DescribeEventDetailsSuccessfulSet":{ + "type":"list", + "member":{"shape":"EventDetails"} + }, + "DescribeEventTypesRequest":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"EventTypeFilter", + "documentation":"

Values to narrow the results returned.

" + }, + "locale":{ + "shape":"locale", + "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + }, + "maxResults":{ + "shape":"maxResults", + "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + } + } + }, + "DescribeEventTypesResponse":{ + "type":"structure", + "members":{ + "eventTypes":{ + "shape":"EventTypeList", + "documentation":"

A list of event types that match the filter criteria. Event types have a category (issue, accountNotification, or scheduledChange), a service (for example, EC2, RDS, DATAPIPELINE, BILLING), and a code (in the format AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + } + } + }, + "DescribeEventsRequest":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"EventFilter", + "documentation":"

Values to narrow the results returned.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + }, + "maxResults":{ + "shape":"maxResults", + "documentation":"

The maximum number of items to return in one batch, between 10 and 100, inclusive.

" + }, + "locale":{ + "shape":"locale", + "documentation":"

The locale (language) to return information in. English (en) is the default and the only supported value at this time.

" + } + } + }, + "DescribeEventsResponse":{ + "type":"structure", + "members":{ + "events":{ + "shape":"EventList", + "documentation":"

The events that match the specified filter criteria.

" + }, + "nextToken":{ + "shape":"nextToken", + "documentation":"

If the results of a search are large, only a portion of the results are returned, and a nextToken pagination token is returned in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When all results have been returned, the response does not contain a pagination token value.

" + } + } + }, + "EntityAggregate":{ + "type":"structure", + "members":{ + "eventArn":{ + "shape":"eventArn", + "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

" + }, + "count":{ + "shape":"count", + "documentation":"

The number entities that match the criteria for the specified events.

" + } + }, + "documentation":"

The number of entities that are affected by one or more events. Returned by the DescribeEntityAggregates operation.

" + }, + "EntityAggregateList":{ + "type":"list", + "member":{"shape":"EntityAggregate"} + }, + "EntityFilter":{ + "type":"structure", + "required":["eventArns"], + "members":{ + "eventArns":{ + "shape":"eventArnList", + "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"

" + }, + "entityArns":{ + "shape":"entityArnList", + "documentation":"

A list of entity ARNs (unique identifiers).

" + }, + "entityValues":{ + "shape":"entityValueList", + "documentation":"

A list of IDs for affected entities.

" + }, + "lastUpdatedTimes":{ + "shape":"dateTimeRangeList", + "documentation":"

A list of the most recent dates and times that the entity was updated.

" + }, + "tags":{ + "shape":"tagFilter", + "documentation":"

A map of entity tags attached to the affected entity.

" + }, + "statusCodes":{ + "shape":"entityStatusCodeList", + "documentation":"

A list of entity status codes (IMPAIRED, UNIMPAIRED, or UNKNOWN).

" + } + }, + "documentation":"

The values to use to filter results from the DescribeAffectedEntities operation.

" + }, + "EntityList":{ + "type":"list", + "member":{"shape":"AffectedEntity"} + }, + "Event":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"eventArn", + "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

" + }, + "service":{ + "shape":"service", + "documentation":"

The AWS service that is affected by the event. For example, EC2, RDS.

" + }, + "eventTypeCode":{ + "shape":"eventTypeCode", + "documentation":"

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + }, + "eventTypeCategory":{ + "shape":"eventTypeCategory", + "documentation":"

The category of the event. Possible values are issue, scheduledChange, and accountNotification.

" + }, + "region":{ + "shape":"region", + "documentation":"

The AWS region name of the event.

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

The AWS Availability Zone of the event. For example, us-east-1a.

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

The date and time that the event began.

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

The date and time that the event ended.

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

The most recent date and time that the event was updated.

" + }, + "statusCode":{ + "shape":"eventStatusCode", + "documentation":"

The most recent status of the event. Possible values are open, closed, and upcoming.

" + } + }, + "documentation":"

Summary information about an event, returned by the DescribeEvents operation. The DescribeEventDetails operation also returns this information, as well as the EventDescription and additional event metadata.

" + }, + "EventAggregate":{ + "type":"structure", + "members":{ + "aggregateValue":{ + "shape":"aggregateValue", + "documentation":"

The issue type for the associated count.

" + }, + "count":{ + "shape":"count", + "documentation":"

The number of events of the associated issue type.

" + } + }, + "documentation":"

The number of events of each issue type. Returned by the DescribeEventAggregates operation.

" + }, + "EventAggregateList":{ + "type":"list", + "member":{"shape":"EventAggregate"} + }, + "EventArnsList":{ + "type":"list", + "member":{"shape":"eventArn"}, + "max":50, + "min":1 + }, + "EventDescription":{ + "type":"structure", + "members":{ + "latestDescription":{ + "shape":"eventDescription", + "documentation":"

The most recent description of the event.

" + } + }, + "documentation":"

The detailed description of the event. Included in the information returned by the DescribeEventDetails operation.

" + }, + "EventDetails":{ + "type":"structure", + "members":{ + "event":{ + "shape":"Event", + "documentation":"

Summary information about the event.

" + }, + "eventDescription":{ + "shape":"EventDescription", + "documentation":"

The most recent description of the event.

" + }, + "eventMetadata":{ + "shape":"eventMetadata", + "documentation":"

Additional metadata about the event.

" + } + }, + "documentation":"

Detailed information about an event. A combination of an Event object, an EventDescription object, and additional metadata about the event. Returned by the DescribeEventDetails operation.

" + }, + "EventDetailsErrorItem":{ + "type":"structure", + "members":{ + "eventArn":{ + "shape":"eventArn", + "documentation":"

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

" + }, + "errorName":{ + "shape":"string", + "documentation":"

The name of the error.

" + }, + "errorMessage":{ + "shape":"string", + "documentation":"

A message that describes the error.

" + } + }, + "documentation":"

Error information returned when a DescribeEventDetails operation cannot find a specified event.

" + }, + "EventFilter":{ + "type":"structure", + "members":{ + "eventArns":{ + "shape":"eventArnList", + "documentation":"

A list of event ARNs (unique identifiers). For example: \"arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-CDE456\", \"arn:aws:health:us-west-1::event/EBS/AWS_EBS_LOST_VOLUME/AWS_EBS_LOST_VOLUME_CHI789_JKL101\"

" + }, + "eventTypeCodes":{ + "shape":"eventTypeList", + "documentation":"

A list of unique identifiers for event types. For example, \"AWS_EC2_SYSTEM_MAINTENANCE_EVENT\",\"AWS_RDS_MAINTENANCE_SCHEDULED\"

" + }, + "services":{ + "shape":"serviceList", + "documentation":"

The AWS services associated with the event. For example, EC2, RDS.

" + }, + "regions":{ + "shape":"regionList", + "documentation":"

A list of AWS regions.

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

A list of AWS availability zones.

" + }, + "startTimes":{ + "shape":"dateTimeRangeList", + "documentation":"

A list of dates and times that the event began.

" + }, + "endTimes":{ + "shape":"dateTimeRangeList", + "documentation":"

A list of dates and times that the event ended.

" + }, + "lastUpdatedTimes":{ + "shape":"dateTimeRangeList", + "documentation":"

A list of dates and times that the event was last updated.

" + }, + "entityArns":{ + "shape":"entityArnList", + "documentation":"

A list of entity ARNs (unique identifiers).

" + }, + "entityValues":{ + "shape":"entityValueList", + "documentation":"

A list of entity identifiers, such as EC2 instance IDs (i-34ab692e) or EBS volumes (vol-426ab23e).

" + }, + "eventTypeCategories":{ + "shape":"eventTypeCategoryList", + "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" + }, + "tags":{ + "shape":"tagFilter", + "documentation":"

A map of entity tags attached to the affected entity.

" + }, + "eventStatusCodes":{ + "shape":"eventStatusCodeList", + "documentation":"

A list of event status codes.

" + } + }, + "documentation":"

The values to use to filter results from the DescribeEvents and DescribeEventAggregates operations.

" + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"} + }, + "EventType":{ + "type":"structure", + "members":{ + "service":{ + "shape":"service", + "documentation":"

The AWS service that is affected by the event. For example, EC2, RDS.

" + }, + "code":{ + "shape":"eventTypeCode", + "documentation":"

The unique identifier for the event type. The format is AWS_SERVICE_DESCRIPTION ; for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT.

" + }, + "category":{ + "shape":"eventTypeCategory", + "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" + } + }, + "documentation":"

Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, issue), the service (for example, EC2), and the event type code (for example, AWS_EC2_SYSTEM_MAINTENANCE_EVENT).

" + }, + "EventTypeCategoryList":{ + "type":"list", + "member":{"shape":"eventTypeCategory"}, + "max":10, + "min":1 + }, + "EventTypeCodeList":{ + "type":"list", + "member":{"shape":"eventTypeCode"}, + "max":10, + "min":1 + }, + "EventTypeFilter":{ + "type":"structure", + "members":{ + "eventTypeCodes":{ + "shape":"EventTypeCodeList", + "documentation":"

A list of event type codes.

" + }, + "services":{ + "shape":"serviceList", + "documentation":"

The AWS services associated with the event. For example, EC2, RDS.

" + }, + "eventTypeCategories":{ + "shape":"EventTypeCategoryList", + "documentation":"

A list of event type category codes (issue, scheduledChange, or accountNotification).

" + } + }, + "documentation":"

The values to use to filter results from the DescribeEventTypes operation.

" + }, + "EventTypeList":{ + "type":"list", + "member":{"shape":"EventType"} + }, + "InvalidPaginationToken":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

The specified pagination token (nextToken) is not valid.

", + "exception":true + }, + "UnsupportedLocale":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

The specified locale is not supported.

", + "exception":true + }, + "accountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "aggregateValue":{"type":"string"}, + "availabilityZone":{ + "type":"string", + "pattern":"[a-z]{2}\\-[0-9a-z\\-]{4,16}" + }, + "availabilityZones":{ + "type":"list", + "member":{"shape":"availabilityZone"} + }, + "count":{"type":"integer"}, + "dateTimeRangeList":{ + "type":"list", + "member":{"shape":"DateTimeRange"}, + "max":10, + "min":1 + }, + "entityArn":{ + "type":"string", + "max":1600 + }, + "entityArnList":{ + "type":"list", + "member":{"shape":"entityArn"}, + "max":100, + "min":1 + }, + "entityStatusCode":{ + "type":"string", + "enum":[ + "IMPAIRED", + "UNIMPAIRED", + "UNKNOWN" + ] + }, + "entityStatusCodeList":{ + "type":"list", + "member":{"shape":"entityStatusCode"}, + "max":3, + "min":1 + }, + "entityUrl":{ + "type":"string", + "pattern":"https?://.+\\.(amazon\\.com|amazonaws\\.com|amazonaws\\.cn|c2s\\.ic\\.gov|sc2s\\.sgov\\.gov|amazonaws-us-gov.com)/.*" + }, + "entityValue":{ + "type":"string", + "max":256 + }, + "entityValueList":{ + "type":"list", + "member":{"shape":"entityValue"}, + "max":100, + "min":1 + }, + "eventAggregateField":{ + "type":"string", + "enum":["eventTypeCategory"] + }, + "eventArn":{ + "type":"string", + "max":1600, + "pattern":"arn:aws(-[a-z]+(-[a-z]+)?)?:health:[^:]*:[^:]*:event(?:/[\\w-]+){3}" + }, + "eventArnList":{ + "type":"list", + "member":{"shape":"eventArn"}, + "max":10, + "min":1 + }, + "eventDescription":{"type":"string"}, + "eventMetadata":{ + "type":"map", + "key":{"shape":"metadataKey"}, + "value":{"shape":"metadataValue"} + }, + "eventStatusCode":{ + "type":"string", + "enum":[ + "open", + "closed", + "upcoming" + ] + }, + "eventStatusCodeList":{ + "type":"list", + "member":{"shape":"eventStatusCode"}, + "max":6, + "min":1 + }, + "eventType":{ + "type":"string", + "max":100, + "min":3 + }, + "eventTypeCategory":{ + "type":"string", + "enum":[ + "issue", + "accountNotification", + "scheduledChange", + "investigation" + ], + "max":255, + "min":3 + }, + "eventTypeCategoryList":{ + "type":"list", + "member":{"shape":"eventTypeCategory"}, + "max":10, + "min":1 + }, + "eventTypeCode":{ + "type":"string", + "max":100, + "min":3 + }, + "eventTypeList":{ + "type":"list", + "member":{"shape":"eventType"}, + "max":10, + "min":1 + }, + "locale":{ + "type":"string", + "max":256, + "min":2 + }, + "maxResults":{ + "type":"integer", + "max":100, + "min":10 + }, + "metadataKey":{"type":"string"}, + "metadataValue":{ + "type":"string", + "max":10240 + }, + "nextToken":{ + "type":"string", + "pattern":"[a-zA-Z0-9=/+_.-]{4,512}" + }, + "region":{ + "type":"string", + "pattern":"[^:/]{2,25}" + }, + "regionList":{ + "type":"list", + "member":{"shape":"region"}, + "max":10, + "min":1 + }, + "service":{ + "type":"string", + "max":30, + "min":2 + }, + "serviceList":{ + "type":"list", + "member":{"shape":"service"}, + "max":10, + "min":1 + }, + "string":{"type":"string"}, + "tagFilter":{ + "type":"list", + "member":{"shape":"tagSet"}, + "max":50 + }, + "tagKey":{ + "type":"string", + "max":127 + }, + "tagSet":{ + "type":"map", + "key":{"shape":"tagKey"}, + "value":{"shape":"tagValue"}, + "max":50 + }, + "tagValue":{ + "type":"string", + "max":255 + }, + "timestamp":{"type":"timestamp"} + }, + "documentation":"AWS Health

The AWS Health API provides programmatic access to the AWS Health information that is presented in the AWS Personal Health Dashboard. You can get information about events that affect your AWS resources:

In addition, these operations provide information about event types and summary counts of events or affected entities:

The Health API requires a Business or Enterprise support plan from AWS Support. Calling the Health API from an account that does not have a Business or Enterprise support plan causes a SubscriptionRequiredException.

For authentication of requests, AWS Health uses the Signature Version 4 Signing Process.

See the AWS Health User Guide for information about how to use the API.

Service Endpoint

The HTTP endpoint for the AWS Health API is:

  • https://health.us-east-1.amazonaws.com

" +} diff --git a/aws/dist/botocore/data/iam/2010-05-08/examples-1.json b/aws/dist/botocore/data/iam/2010-05-08/examples-1.json new file mode 100644 index 00000000..f23d8ebf --- /dev/null +++ b/aws/dist/botocore/data/iam/2010-05-08/examples-1.json @@ -0,0 +1,1191 @@ +{ + "version": "1.0", + "examples": { + "AddClientIDToOpenIDConnectProvider": [ + { + "input": { + "ClientID": "my-application-ID", + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following add-client-id-to-open-id-connect-provider command adds the client ID my-application-ID to the OIDC provider named server.example.com:", + "id": "028e91f4-e2a6-4d59-9e3b-4965a3fb19be", + "title": "To add a client ID (audience) to an Open-ID Connect (OIDC) provider" + } + ], + "AddRoleToInstanceProfile": [ + { + "input": { + "InstanceProfileName": "Webserver", + "RoleName": "S3Access" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds the role named S3Access to the instance profile named Webserver:", + "id": "c107fac3-edb6-4827-8a71-8863ec91c81f", + "title": "To add a role to an instance profile" + } + ], + "AddUserToGroup": [ + { + "input": { + "GroupName": "Admins", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds an IAM user named Bob to the IAM group named Admins:", + "id": "619c7e6b-09f8-4036-857b-51a6ea5027ca", + "title": "To add a user to an IAM group" + } + ], + "AttachGroupPolicy": [ + { + "input": { + "GroupName": "Finance", + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM group named Finance.", + "id": "87551489-86f0-45db-9889-759936778f2b", + "title": "To attach a managed policy to an IAM group" + } + ], + "AttachRolePolicy": [ + { + "input": { + "PolicyArn": "arn:aws:iam::aws:policy/ReadOnlyAccess", + "RoleName": "ReadOnlyRole" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named ReadOnlyAccess to the IAM role named ReadOnlyRole.", + "id": "3e1b8c7c-99c8-4fc4-a20c-131fe3f22c7e", + "title": "To attach a managed policy to an IAM role" + } + ], + "AttachUserPolicy": [ + { + "input": { + "PolicyArn": "arn:aws:iam::aws:policy/AdministratorAccess", + "UserName": "Alice" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches the AWS managed policy named AdministratorAccess to the IAM user named Alice.", + "id": "1372ebd8-9475-4b1a-a479-23b6fd4b8b3e", + "title": "To attach a managed policy to an IAM user" + } + ], + "ChangePassword": [ + { + "input": { + "NewPassword": "]35d/{pB9Fo9wJ", + "OldPassword": "3s0K_;xh4~8XXI" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the password for the current IAM user.", + "id": "3a80c66f-bffb-46df-947c-1e8fa583b470", + "title": "To change the password for your IAM user" + } + ], + "CreateAccessKey": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "AccessKey": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "CreateDate": "2015-03-09T18:39:23.411Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "Status": "Active", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an access key (access key ID and secret access key) for the IAM user named Bob.", + "id": "1fbb3211-4cf2-41db-8c20-ba58d9f5802d", + "title": "To create an access key for an IAM user" + } + ], + "CreateAccountAlias": [ + { + "input": { + "AccountAlias": "examplecorp" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command associates the alias examplecorp to your AWS account.", + "id": "5adaf6fb-94fc-4ca2-b825-2fbc2062add1", + "title": "To create an account alias" + } + ], + "CreateGroup": [ + { + "input": { + "GroupName": "Admins" + }, + "output": { + "Group": { + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2015-03-09T20:30:24.940Z", + "GroupId": "AIDGPMS9RO4H3FEXAMPLE", + "GroupName": "Admins", + "Path": "/" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an IAM group named Admins.", + "id": "d5da2a90-5e69-4ef7-8ae8-4c33dc21fd21", + "title": "To create an IAM group" + } + ], + "CreateInstanceProfile": [ + { + "input": { + "InstanceProfileName": "Webserver" + }, + "output": { + "InstanceProfile": { + "Arn": "arn:aws:iam::123456789012:instance-profile/Webserver", + "CreateDate": "2015-03-09T20:33:19.626Z", + "InstanceProfileId": "AIPAJMBYC7DLSPEXAMPLE", + "InstanceProfileName": "Webserver", + "Path": "/", + "Roles": [ + + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates an instance profile named Webserver that is ready to have a role attached and then be associated with an EC2 instance.", + "id": "5d84e6ae-5921-4e39-8454-10232cd9ff9a", + "title": "To create an instance profile" + } + ], + "CreateLoginProfile": [ + { + "input": { + "Password": "h]6EszR}vJ*m", + "PasswordResetRequired": true, + "UserName": "Bob" + }, + "output": { + "LoginProfile": { + "CreateDate": "2015-03-10T20:55:40.274Z", + "PasswordResetRequired": true, + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes IAM user Bob's password and sets the flag that required Bob to change the password the next time he signs in.", + "id": "c63795bc-3444-40b3-89df-83c474ef88be", + "title": "To create an instance profile" + } + ], + "CreateOpenIDConnectProvider": [ + { + "input": { + "ClientIDList": [ + "my-application-id" + ], + "ThumbprintList": [ + "3768084dfb3d2b68b7897bf5f565da8efEXAMPLE" + ], + "Url": "https://server.example.com" + }, + "output": { + "OpenIDConnectProviderArn": "arn:aws:iam::123456789012:oidc-provider/server.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example defines a new OIDC provider in IAM with a client ID of my-application-id and pointing at the server with a URL of https://server.example.com.", + "id": "4e4a6bff-cc97-4406-922e-0ab4a82cdb63", + "title": "To create an instance profile" + } + ], + "CreateRole": [ + { + "input": { + "AssumeRolePolicyDocument": "", + "Path": "/", + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-06-07T20:43:32.821Z", + "Path": "/", + "RoleId": "AKIAIOSFODNN7EXAMPLE", + "RoleName": "Test-Role" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates a role named Test-Role and attaches a trust policy to it that is provided as a URL-encoded JSON string.", + "id": "eaaa4b5f-51f1-4f73-b0d3-30127040eff8", + "title": "To create an IAM role" + } + ], + "CreateUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "Arn": "arn:aws:iam::123456789012:user/Bob", + "CreateDate": "2013-06-08T03:20:41.270Z", + "Path": "/", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following create-user command creates an IAM user named Bob in the current account.", + "id": "eb15f90b-e5f5-4af8-a594-e4e82b181a62", + "title": "To create an IAM user" + } + ], + "DeleteAccessKey": [ + { + "input": { + "AccessKeyId": "AKIDPMS9RO4H3FEXAMPLE", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes one access key (access key ID and secret access key) assigned to the IAM user named Bob.", + "id": "61a785a7-d30a-415a-ae18-ab9236e56871", + "title": "To delete an access key for an IAM user" + } + ], + "DeleteAccountAlias": [ + { + "input": { + "AccountAlias": "mycompany" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the alias mycompany from the current AWS account:", + "id": "7abeca65-04a8-4500-a890-47f1092bf766", + "title": "To delete an account alias" + } + ], + "DeleteAccountPasswordPolicy": [ + { + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the password policy from the current AWS account:", + "id": "9ddf755e-495c-49bc-ae3b-ea6cc9b8ebcf", + "title": "To delete the current account password policy" + } + ], + "DeleteGroupPolicy": [ + { + "input": { + "GroupName": "Admins", + "PolicyName": "ExamplePolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the policy named ExamplePolicy from the group named Admins:", + "id": "e683f2bd-98a4-4fe0-bb66-33169c692d4a", + "title": "To delete a policy from an IAM group" + } + ], + "DeleteInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the instance profile named ExampleInstanceProfile", + "id": "12d74fb8-3433-49db-8171-a1fc764e354d", + "title": "To delete an instance profile" + } + ], + "DeleteLoginProfile": [ + { + "input": { + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the password for the IAM user named Bob.", + "id": "1fe57059-fc73-42e2-b992-517b7d573b5c", + "title": "To delete a password for an IAM user" + } + ], + "DeleteRole": [ + { + "input": { + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the role named Test-Role.", + "id": "053cdf74-9bda-44b8-bdbb-140fd5a32603", + "title": "To delete an IAM role" + } + ], + "DeleteRolePolicy": [ + { + "input": { + "PolicyName": "ExamplePolicy", + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the policy named ExamplePolicy from the role named Test-Role.", + "id": "9c667336-fde3-462c-b8f3-950800821e27", + "title": "To remove a policy from an IAM role" + } + ], + "DeleteSigningCertificate": [ + { + "input": { + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "UserName": "Anika" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deletes the specified signing certificate for the IAM user named Anika.", + "id": "e3357586-ba9c-4070-b35b-d1a899b71987", + "title": "To delete a signing certificate for an IAM user" + } + ], + "DeleteUser": [ + { + "input": { + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the IAM user named Bob from the current account.", + "id": "a13dc3f9-59fe-42d9-abbb-fb98b204fdf0", + "title": "To delete an IAM user" + } + ], + "DeleteUserPolicy": [ + { + "input": { + "PolicyName": "ExamplePolicy", + "UserName": "Juan" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following delete-user-policy command removes the specified policy from the IAM user named Juan:", + "id": "34f07ddc-9bc1-4f52-bc59-cd0a3ccd06c8", + "title": "To remove a policy from an IAM user" + } + ], + "DeleteVirtualMFADevice": [ + { + "input": { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleName" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following delete-virtual-mfa-device command removes the specified MFA device from the current AWS account.", + "id": "2933b08b-dbe7-4b89-b8c1-fdf75feea1ee", + "title": "To remove a virtual MFA device" + } + ], + "GetAccountPasswordPolicy": [ + { + "output": { + "PasswordPolicy": { + "AllowUsersToChangePassword": false, + "ExpirePasswords": false, + "HardExpiry": false, + "MaxPasswordAge": 90, + "MinimumPasswordLength": 8, + "PasswordReusePrevention": 12, + "RequireLowercaseCharacters": false, + "RequireNumbers": true, + "RequireSymbols": true, + "RequireUppercaseCharacters": false + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command displays details about the password policy for the current AWS account.", + "id": "5e4598c7-c425-431f-8af1-19073b3c4a5f", + "title": "To see the current account password policy" + } + ], + "GetAccountSummary": [ + { + "output": { + "SummaryMap": { + "AccessKeysPerUserQuota": 2, + "AccountAccessKeysPresent": 1, + "AccountMFAEnabled": 0, + "AccountSigningCertificatesPresent": 0, + "AttachedPoliciesPerGroupQuota": 10, + "AttachedPoliciesPerRoleQuota": 10, + "AttachedPoliciesPerUserQuota": 10, + "GroupPolicySizeQuota": 5120, + "Groups": 15, + "GroupsPerUserQuota": 10, + "GroupsQuota": 100, + "MFADevices": 6, + "MFADevicesInUse": 3, + "Policies": 8, + "PoliciesQuota": 1000, + "PolicySizeQuota": 5120, + "PolicyVersionsInUse": 22, + "PolicyVersionsInUseQuota": 10000, + "ServerCertificates": 1, + "ServerCertificatesQuota": 20, + "SigningCertificatesPerUserQuota": 2, + "UserPolicySizeQuota": 2048, + "Users": 27, + "UsersQuota": 5000, + "VersionsPerPolicyQuota": 5 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command returns information about the IAM entity quotas and usage in the current AWS account.", + "id": "9d8447af-f344-45de-8219-2cebc3cce7f2", + "title": "To get information about IAM entity quotas and usage in the current account" + } + ], + "GetInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile" + }, + "output": { + "InstanceProfile": { + "Arn": "arn:aws:iam::336924118301:instance-profile/ExampleInstanceProfile", + "CreateDate": "2013-06-12T23:52:02Z", + "InstanceProfileId": "AID2MAB8DPLSRHEXAMPLE", + "InstanceProfileName": "ExampleInstanceProfile", + "Path": "/", + "Roles": [ + { + "Arn": "arn:aws:iam::336924118301:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-01-09T06:33:26Z", + "Path": "/", + "RoleId": "AIDGPMS9RO4H3FEXAMPLE", + "RoleName": "Test-Role" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the instance profile named ExampleInstanceProfile.", + "id": "463b9ba5-18cc-4608-9ccb-5a7c6b6e5fe7", + "title": "To get information about an instance profile" + } + ], + "GetLoginProfile": [ + { + "input": { + "UserName": "Anika" + }, + "output": { + "LoginProfile": { + "CreateDate": "2012-09-21T23:03:39Z", + "UserName": "Anika" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the password for the IAM user named Anika.", + "id": "d6b580cc-909f-4925-9caa-d425cbc1ad47", + "title": "To get password information for an IAM user" + } + ], + "GetRole": [ + { + "input": { + "RoleName": "Test-Role" + }, + "output": { + "Role": { + "Arn": "arn:aws:iam::123456789012:role/Test-Role", + "AssumeRolePolicyDocument": "", + "CreateDate": "2013-04-18T05:01:58Z", + "Path": "/", + "RoleId": "AIDIODR4TAW7CSEXAMPLE", + "RoleName": "Test-Role" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the role named Test-Role.", + "id": "5b7d03a6-340c-472d-aa77-56425950d8b0", + "title": "To get information about an IAM role" + } + ], + "GetUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "User": { + "Arn": "arn:aws:iam::123456789012:user/Bob", + "CreateDate": "2012-09-21T23:03:13Z", + "Path": "/", + "UserId": "AKIAIOSFODNN7EXAMPLE", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command gets information about the IAM user named Bob.", + "id": "ede000a1-9e4c-40db-bd0a-d4f95e41a6ab", + "title": "To get information about an IAM user" + } + ], + "ListAccessKeys": [ + { + "input": { + "UserName": "Alice" + }, + "output": { + "AccessKeyMetadata": [ + { + "AccessKeyId": "AKIA111111111EXAMPLE", + "CreateDate": "2016-12-01T22:19:58Z", + "Status": "Active", + "UserName": "Alice" + }, + { + "AccessKeyId": "AKIA222222222EXAMPLE", + "CreateDate": "2016-12-01T22:20:01Z", + "Status": "Active", + "UserName": "Alice" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the access keys IDs for the IAM user named Alice.", + "id": "15571463-ebea-411a-a021-1c76bd2a3625", + "title": "To list the access key IDs for an IAM user" + } + ], + "ListAccountAliases": [ + { + "input": { + }, + "output": { + "AccountAliases": [ + "exmaple-corporation" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the aliases for the current account.", + "id": "e27b457a-16f9-4e05-a006-3df7b3472741", + "title": "To list account aliases" + } + ], + "ListGroupPolicies": [ + { + "input": { + "GroupName": "Admins" + }, + "output": { + "PolicyNames": [ + "AdminRoot", + "KeyPolicy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the names of in-line policies that are embedded in the IAM group named Admins.", + "id": "02de5095-2410-4d3a-ac1b-cc40234af68f", + "title": "To list the in-line policies for an IAM group" + } + ], + "ListGroups": [ + { + "input": { + }, + "output": { + "Groups": [ + { + "Arn": "arn:aws:iam::123456789012:group/Admins", + "CreateDate": "2016-12-15T21:40:08.121Z", + "GroupId": "AGPA1111111111EXAMPLE", + "GroupName": "Admins", + "Path": "/division_abc/subdivision_xyz/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP22222222222EXAMPLE", + "GroupName": "Test", + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI3333333333EXAMPLE", + "GroupName": "Managers", + "Path": "/division_abc/subdivision_xyz/product_1234/" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the IAM groups in the current account:", + "id": "b3ab1380-2a21-42fb-8e85-503f65512c66", + "title": "To list the IAM groups for the current account" + } + ], + "ListGroupsForUser": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "Groups": [ + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/engineering/Test", + "CreateDate": "2016-11-30T14:10:01.156Z", + "GroupId": "AGP2111111111EXAMPLE", + "GroupName": "Test", + "Path": "/division_abc/subdivision_xyz/product_1234/engineering/" + }, + { + "Arn": "arn:aws:iam::123456789012:group/division_abc/subdivision_xyz/product_1234/Managers", + "CreateDate": "2016-06-12T20:14:52.032Z", + "GroupId": "AGPI222222222SEXAMPLE", + "GroupName": "Managers", + "Path": "/division_abc/subdivision_xyz/product_1234/" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command displays the groups that the IAM user named Bob belongs to.", + "id": "278ec2ee-fc28-4136-83fb-433af0ae46a2", + "title": "To list the groups that an IAM user belongs to" + } + ], + "ListSigningCertificates": [ + { + "input": { + "UserName": "Bob" + }, + "output": { + "Certificates": [ + { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "Status": "Active", + "UploadDate": "2013-06-06T21:40:08Z", + "UserName": "Bob" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the signing certificates for the IAM user named Bob.", + "id": "b4c10256-4fc9-457e-b3fd-4a110d4d73dc", + "title": "To list the signing certificates for an IAM user" + } + ], + "ListUsers": [ + { + "input": { + }, + "output": { + "Users": [ + { + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Juan", + "CreateDate": "2012-09-05T19:38:48Z", + "PasswordLastUsed": "2016-09-08T21:47:36Z", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserId": "AID2MAB8DPLSRHEXAMPLE", + "UserName": "Juan" + }, + { + "Arn": "arn:aws:iam::123456789012:user/division_abc/subdivision_xyz/engineering/Anika", + "CreateDate": "2014-04-09T15:43:45Z", + "PasswordLastUsed": "2016-09-24T16:18:07Z", + "Path": "/division_abc/subdivision_xyz/engineering/", + "UserId": "AIDIODR4TAW7CSEXAMPLE", + "UserName": "Anika" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the IAM users in the current account.", + "id": "9edfbd73-03d8-4d8a-9a79-76c85e8c8298", + "title": "To list IAM users" + } + ], + "ListVirtualMFADevices": [ + { + "input": { + }, + "output": { + "VirtualMFADevices": [ + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/ExampleMFADevice" + }, + { + "SerialNumber": "arn:aws:iam::123456789012:mfa/Juan" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command lists the virtual MFA devices that have been configured for the current account.", + "id": "54f9ac18-5100-4070-bec4-fe5f612710d5", + "title": "To list virtual MFA devices" + } + ], + "PutGroupPolicy": [ + { + "input": { + "GroupName": "Admins", + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", + "PolicyName": "AllPerms" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds a policy named AllPerms to the IAM group named Admins.", + "id": "4bc17418-758f-4d0f-ab0c-4d00265fec2e", + "title": "To add a policy to a group" + } + ], + "PutRolePolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}}", + "PolicyName": "S3AccessPolicy", + "RoleName": "S3Access" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command adds a permissions policy to the role named Test-Role.", + "id": "de62fd00-46c7-4601-9e0d-71d5fbb11ecb", + "title": "To attach a permissions policy to an IAM role" + } + ], + "PutUserPolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":{\"Effect\":\"Allow\",\"Action\":\"*\",\"Resource\":\"*\"}}", + "PolicyName": "AllAccessPolicy", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command attaches a policy to the IAM user named Bob.", + "id": "2551ffc6-3576-4d39-823f-30b60bffc2c7", + "title": "To attach a policy to an IAM user" + } + ], + "RemoveRoleFromInstanceProfile": [ + { + "input": { + "InstanceProfileName": "ExampleInstanceProfile", + "RoleName": "Test-Role" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the role named Test-Role from the instance profile named ExampleInstanceProfile.", + "id": "6d9f46f1-9f4a-4873-b403-51a85c5c627c", + "title": "To remove a role from an instance profile" + } + ], + "RemoveUserFromGroup": [ + { + "input": { + "GroupName": "Admins", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command removes the user named Bob from the IAM group named Admins.", + "id": "fb54d5b4-0caf-41d8-af0e-10a84413f174", + "title": "To remove a user from an IAM group" + } + ], + "UpdateAccessKey": [ + { + "input": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Status": "Inactive", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command deactivates the specified access key (access key ID and secret access key) for the IAM user named Bob.", + "id": "02b556fd-e673-49b7-ab6b-f2f9035967d0", + "title": "To activate or deactivate an access key for an IAM user" + } + ], + "UpdateAccountPasswordPolicy": [ + { + "input": { + "MinimumPasswordLength": 8, + "RequireNumbers": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command sets the password policy to require a minimum length of eight characters and to require one or more numbers in the password:", + "id": "c263a1af-37dc-4423-8dba-9790284ef5e0", + "title": "To set or change the current account password policy" + } + ], + "UpdateAssumeRolePolicy": [ + { + "input": { + "PolicyDocument": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":[\"ec2.amazonaws.com\"]},\"Action\":[\"sts:AssumeRole\"]}]}", + "RoleName": "S3AccessForEC2Instances" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command updates the role trust policy for the role named Test-Role:", + "id": "c9150063-d953-4e99-9576-9685872006c6", + "title": "To update the trust policy for an IAM role" + } + ], + "UpdateGroup": [ + { + "input": { + "GroupName": "Test", + "NewGroupName": "Test-1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the name of the IAM group Test to Test-1.", + "id": "f0cf1662-91ae-4278-a80e-7db54256ccba", + "title": "To rename an IAM group" + } + ], + "UpdateLoginProfile": [ + { + "input": { + "Password": "SomeKindOfPassword123!@#", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command creates or changes the password for the IAM user named Bob.", + "id": "036d9498-ecdb-4ed6-a8d8-366c383d1487", + "title": "To change the password for an IAM user" + } + ], + "UpdateSigningCertificate": [ + { + "input": { + "CertificateId": "TA7SMP42TDN5Z26OBPJE7EXAMPLE", + "Status": "Inactive", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the status of a signing certificate for a user named Bob to Inactive.", + "id": "829aee7b-efc5-4b3b-84a5-7f899b38018d", + "title": "To change the active status of a signing certificate for an IAM user" + } + ], + "UpdateUser": [ + { + "input": { + "NewUserName": "Robert", + "UserName": "Bob" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command changes the name of the IAM user Bob to Robert. It does not change the user's path.", + "id": "275d53ed-347a-44e6-b7d0-a96276154352", + "title": "To change an IAM user's name" + } + ], + "UploadServerCertificate": [ + { + "input": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "Path": "/company/servercerts/", + "PrivateKey": "-----BEGIN DSA PRIVATE KEY----------END DSA PRIVATE KEY-----", + "ServerCertificateName": "ProdServerCert" + }, + "output": { + "ServerCertificateMetadata": { + "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert", + "Expiration": "2012-05-08T01:02:03.004Z", + "Path": "/company/servercerts/", + "ServerCertificateId": "ASCA1111111111EXAMPLE", + "ServerCertificateName": "ProdServerCert", + "UploadDate": "2010-05-08T01:02:03.004Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following upload-server-certificate command uploads a server certificate to your AWS account:", + "id": "06eab6d1-ebf2-4bd9-839d-f7508b9a38b6", + "title": "To upload a server certificate to your AWS account" + } + ], + "UploadSigningCertificate": [ + { + "input": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "UserName": "Bob" + }, + "output": { + "Certificate": { + "CertificateBody": "-----BEGIN CERTIFICATE----------END CERTIFICATE-----", + "CertificateId": "ID123456789012345EXAMPLE", + "Status": "Active", + "UploadDate": "2015-06-06T21:40:08.121Z", + "UserName": "Bob" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following command uploads a signing certificate for the IAM user named Bob.", + "id": "e67489b6-7b73-4e30-9ed3-9a9e0231e458", + "title": "To upload a signing certificate for an IAM user" + } + ] + } +} diff --git a/aws/dist/botocore/data/iam/2010-05-08/paginators-1.json b/aws/dist/botocore/data/iam/2010-05-08/paginators-1.json new file mode 100644 index 00000000..83e78d89 --- /dev/null +++ b/aws/dist/botocore/data/iam/2010-05-08/paginators-1.json @@ -0,0 +1,198 @@ +{ + "pagination": { + "GetAccountAuthorizationDetails": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "UserDetailList", + "GroupDetailList", + "RoleDetailList", + "Policies" + ] + }, + "GetGroup": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users", + "non_aggregate_keys": [ + "Group" + ] + }, + "ListAccessKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccessKeyMetadata" + }, + "ListAccountAliases": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AccountAliases" + }, + "ListAttachedGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListAttachedUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "AttachedPolicies" + }, + "ListEntitiesForPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": [ + "PolicyGroups", + "PolicyUsers", + "PolicyRoles" + ] + }, + "ListGroupPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListGroups": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListGroupsForUser": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Groups" + }, + "ListInstanceProfiles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListInstanceProfilesForRole": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "InstanceProfiles" + }, + "ListMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "MFADevices" + }, + "ListPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Policies" + }, + "ListPolicyVersions": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Versions" + }, + "ListRolePolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListRoles": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Roles" + }, + "ListServerCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "ServerCertificateMetadataList" + }, + "ListSigningCertificates": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Certificates" + }, + "ListSSHPublicKeys": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "SSHPublicKeys" + }, + "ListUserPolicies": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "PolicyNames" + }, + "ListUsers": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "Users" + }, + "ListVirtualMFADevices": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "VirtualMFADevices" + }, + "SimulateCustomPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + }, + "SimulatePrincipalPolicy": { + "input_token": "Marker", + "limit_key": "MaxItems", + "more_results": "IsTruncated", + "output_token": "Marker", + "result_key": "EvaluationResults" + } + } +} diff --git a/aws/dist/botocore/data/iam/2010-05-08/service-2.json b/aws/dist/botocore/data/iam/2010-05-08/service-2.json new file mode 100644 index 00000000..34eaaf22 --- /dev/null +++ b/aws/dist/botocore/data/iam/2010-05-08/service-2.json @@ -0,0 +1,8241 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-05-08", + "endpointPrefix":"iam", + "globalEndpoint":"iam.amazonaws.com", + "protocol":"query", + "serviceAbbreviation":"IAM", + "serviceFullName":"AWS Identity and Access Management", + "serviceId":"IAM", + "signatureVersion":"v4", + "uid":"iam-2010-05-08", + "xmlNamespace":"https://iam.amazonaws.com/doc/2010-05-08/" + }, + "operations":{ + "AddClientIDToOpenIDConnectProvider":{ + "name":"AddClientIDToOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddClientIDToOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

" + }, + "AddRoleToInstanceProfile":{ + "name":"AddRoleToInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this API must be granted the PassRole permission on the IAM role by a permissions policy.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" + }, + "AddUserToGroup":{ + "name":"AddUserToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUserToGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds the specified user to the specified group.

" + }, + "AttachGroupPolicy":{ + "name":"AttachGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotAttachableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Attaches the specified managed policy to the specified IAM group.

You use this API to attach a managed policy to a group. To embed an inline policy in a group, use PutGroupPolicy.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "AttachRolePolicy":{ + "name":"AttachRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"PolicyNotAttachableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Attaches the specified managed policy to the specified IAM role. When you attach a managed policy to a role, the managed policy becomes part of the role's permission (access) policy.

You cannot use a managed policy as the role's trust policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy.

Use this API to attach a managed policy to a role. To embed an inline policy in a role, use PutRolePolicy. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "AttachUserPolicy":{ + "name":"AttachUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotAttachableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Attaches the specified managed policy to the specified user.

You use this API to attach a managed policy to a user. To embed an inline policy in a user, use PutUserPolicy.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "ChangePassword":{ + "name":"ChangePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangePasswordRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidUserTypeException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Changes the password of the IAM user who is calling this operation. The AWS account root user password is not affected by this operation.

To change the password for a different user, see UpdateLoginProfile. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

" + }, + "CreateAccessKey":{ + "name":"CreateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccessKeyRequest"}, + "output":{ + "shape":"CreateAccessKeyResponse", + "resultWrapper":"CreateAccessKeyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users.

For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

" + }, + "CreateAccountAlias":{ + "name":"CreateAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccountAliasRequest"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an alias for your AWS account. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{ + "shape":"CreateGroupResponse", + "resultWrapper":"CreateGroupResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.

" + }, + "CreateInstanceProfile":{ + "name":"CreateInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceProfileRequest"}, + "output":{ + "shape":"CreateInstanceProfileResponse", + "resultWrapper":"CreateInstanceProfileResult" + }, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.

" + }, + "CreateLoginProfile":{ + "name":"CreateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoginProfileRequest"}, + "output":{ + "shape":"CreateLoginProfileResponse", + "resultWrapper":"CreateLoginProfileResult" + }, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a password for the specified user, giving the user the ability to access AWS services through the AWS Management Console. For more information about managing passwords, see Managing Passwords in the IAM User Guide.

" + }, + "CreateOpenIDConnectProvider":{ + "name":"CreateOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOpenIDConnectProviderRequest"}, + "output":{ + "shape":"CreateOpenIDConnectProviderResponse", + "resultWrapper":"CreateOpenIDConnectProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC).

The OIDC provider that you create with this operation can be used as a principal in a role's trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.

When you create the IAM OIDC provider, you specify the following:

  • The URL of the OIDC identity provider (IdP) to trust

  • A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider

  • A list of thumbprints of the server certificate(s) that the IdP uses

You get all of this information from the OIDC IdP that you want to use to access AWS.

The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.

" + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{ + "shape":"CreatePolicyResponse", + "resultWrapper":"CreatePolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new managed policy for your AWS account.

This operation creates a policy version with a version identifier of v1 and sets v1 as the policy's default version. For more information about policy versions, see Versioning for Managed Policies in the IAM User Guide.

For more information about managed policies in general, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "CreatePolicyVersion":{ + "name":"CreatePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePolicyVersionRequest"}, + "output":{ + "shape":"CreatePolicyVersionResponse", + "resultWrapper":"CreatePolicyVersionResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new version of the specified managed policy. To update a managed policy, you create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must delete an existing version using DeletePolicyVersion before you create a new version.

Optionally, you can set the new version as the policy's default version. The default version is the version that is in effect for the IAM users, groups, and roles to which the policy is attached.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + }, + "CreateRole":{ + "name":"CreateRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRoleRequest"}, + "output":{ + "shape":"CreateRoleResponse", + "resultWrapper":"CreateRoleResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new role for your AWS account. For more information about roles, go to IAM Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.

" + }, + "CreateSAMLProvider":{ + "name":"CreateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSAMLProviderRequest"}, + "output":{ + "shape":"CreateSAMLProviderResponse", + "resultWrapper":"CreateSAMLProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role's trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the AWS Management Console or one that supports API access to AWS.

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization's IdP.

This operation requires Signature Version 4.

For more information, see Enabling SAML 2.0 Federated Users to Access the AWS Management Console and About SAML 2.0-based Federation in the IAM User Guide.

" + }, + "CreateServiceLinkedRole":{ + "name":"CreateServiceLinkedRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServiceLinkedRoleRequest"}, + "output":{ + "shape":"CreateServiceLinkedRoleResponse", + "resultWrapper":"CreateServiceLinkedRoleResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using Service-Linked Roles in the IAM User Guide.

To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.

" + }, + "CreateServiceSpecificCredential":{ + "name":"CreateServiceSpecificCredential", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServiceSpecificCredentialRequest"}, + "output":{ + "shape":"CreateServiceSpecificCredentialResponse", + "resultWrapper":"CreateServiceSpecificCredentialResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceNotSupportedException"} + ], + "documentation":"

Generates a set of credentials consisting of a user name and password that can be used to access the service specified in the request. These credentials are generated by IAM, and can be used only for the specified service.

You can have a maximum of two sets of service-specific credentials for each supported service per user.

The only supported service at this time is AWS CodeCommit.

You can reset the password to a new service-generated value by calling ResetServiceSpecificCredential.

For more information about service-specific credentials, see Using IAM with AWS CodeCommit: Git Credentials, SSH Keys, and AWS Access Keys in the IAM User Guide.

" + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{ + "shape":"CreateUserResponse", + "resultWrapper":"CreateUserResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new IAM user for your AWS account.

For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.

" + }, + "CreateVirtualMFADevice":{ + "name":"CreateVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVirtualMFADeviceRequest"}, + "output":{ + "shape":"CreateVirtualMFADeviceResponse", + "resultWrapper":"CreateVirtualMFADeviceResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

" + }, + "DeactivateMFADevice":{ + "name":"DeactivateMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeactivateMFADeviceRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deactivates the specified MFA device and removes it from association with the user name for which it was originally enabled.

For more information about creating and working with virtual MFA devices, go to Enabling a Virtual Multi-factor Authentication (MFA) Device in the IAM User Guide.

" + }, + "DeleteAccessKey":{ + "name":"DeleteAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccessKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the access key pair associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

" + }, + "DeleteAccountAlias":{ + "name":"DeleteAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAccountAliasRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified AWS account alias. For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" + }, + "DeleteAccountPasswordPolicy":{ + "name":"DeleteAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the password policy for the AWS account. There are no parameters.

" + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified IAM group. The group must not contain any users or have any attached policies.

" + }, + "DeleteGroupPolicy":{ + "name":"DeleteGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM group.

A group can also have managed policies attached to it. To detach a managed policy from a group, use DetachGroupPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DeleteInstanceProfile":{ + "name":"DeleteInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified instance profile. The instance profile must not have an associated role.

Make sure that you do not have any Amazon EC2 instances running with the instance profile you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

For more information about instance profiles, go to About Instance Profiles.

" + }, + "DeleteLoginProfile":{ + "name":"DeleteLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoginProfileRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the password for the specified IAM user, which terminates the user's ability to access AWS services through the AWS Management Console.

Deleting a user's password does not prevent a user from accessing AWS through the command line interface or the API. To prevent all user access, you must also either make any access keys inactive or delete them. For more information about making keys inactive or deleting them, see UpdateAccessKey and DeleteAccessKey.

" + }, + "DeleteOpenIDConnectProvider":{ + "name":"DeleteOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes an OpenID Connect identity provider (IdP) resource object in IAM.

Deleting an IAM OIDC provider resource does not update any roles that reference the provider as a principal in their trust policies. Any attempt to assume a role that references a deleted provider fails.

This operation is idempotent; it does not fail or return an error if you call the operation for a provider that does not exist.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified managed policy.

Before you can delete a managed policy, you must first detach the policy from all users, groups, and roles that it is attached to. In addition, you must delete all the policy's versions. The following steps describe the process for deleting a managed policy:

  • Detach the policy from all users, groups, and roles that the policy is attached to, using the DetachUserPolicy, DetachGroupPolicy, or DetachRolePolicy API operations. To list all the users, groups, and roles that a policy is attached to, use ListEntitiesForPolicy.

  • Delete all versions of the policy using DeletePolicyVersion. To list the policy's versions, use ListPolicyVersions. You cannot use DeletePolicyVersion to delete the version that is marked as the default version. You delete the policy's default version in the next step of the process.

  • Delete the policy (this automatically deletes the policy's default version) using this API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DeletePolicyVersion":{ + "name":"DeletePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyVersionRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified version from the specified managed policy.

You cannot delete the default version from a policy using this API. To delete the default version from a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

For information about versions for managed policies, see Versioning for Managed Policies in the IAM User Guide.

" + }, + "DeleteRole":{ + "name":"DeleteRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRoleRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified role. The role must not have any policies attached. For more information about roles, go to Working with Roles.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to delete. Deleting a role or instance profile that is associated with a running instance will break any applications running on the instance.

" + }, + "DeleteRolePermissionsBoundary":{ + "name":"DeleteRolePermissionsBoundary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRolePermissionsBoundaryRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the permissions boundary for the specified IAM role.

Deleting the permissions boundary for a role might increase its permissions. For example, it might allow anyone who assumes the role to perform all the actions granted in its permissions policies.

" + }, + "DeleteRolePolicy":{ + "name":"DeleteRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM role.

A role can also have managed policies attached to it. To detach a managed policy from a role, use DetachRolePolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DeleteSAMLProvider":{ + "name":"DeleteSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSAMLProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes a SAML provider resource in IAM.

Deleting the provider resource from IAM does not update any roles that reference the SAML provider resource's ARN as a principal in their trust policies. Any attempt to assume a role that references a non-existent provider resource ARN fails.

This operation requires Signature Version 4.

" + }, + "DeleteSSHPublicKey":{ + "name":"DeleteSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSSHPublicKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Deletes the specified SSH public key.

The SSH public key deleted by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" + }, + "DeleteServerCertificate":{ + "name":"DeleteServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified server certificate.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, go to DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

" + }, + "DeleteServiceLinkedRole":{ + "name":"DeleteServiceLinkedRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceLinkedRoleRequest"}, + "output":{ + "shape":"DeleteServiceLinkedRoleResponse", + "resultWrapper":"DeleteServiceLinkedRoleResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Submits a service-linked role deletion request and returns a DeletionTaskId, which you can use to check the status of the deletion. Before you call this operation, confirm that the role has no active sessions and that any resources used by the role in the linked service are deleted. If you call this operation more than once for the same service-linked role and an earlier deletion task is not complete, then the DeletionTaskId of the earlier request is returned.

If you submit a deletion request for a service-linked role whose linked service is still accessing a resource, then the deletion task fails. If it fails, the GetServiceLinkedRoleDeletionStatus API operation returns the reason for the failure, usually including the resources that must be deleted. To delete the service-linked role, you must first remove those resources from the linked service and then submit the deletion request again. Resources are specific to the service that is linked to the role. For more information about removing resources from a service, see the AWS documentation for your service.

For more information about service-linked roles, see Roles Terms and Concepts: AWS Service-Linked Role in the IAM User Guide.

" + }, + "DeleteServiceSpecificCredential":{ + "name":"DeleteServiceSpecificCredential", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceSpecificCredentialRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Deletes the specified service-specific credential.

" + }, + "DeleteSigningCertificate":{ + "name":"DeleteSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSigningCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes a signing certificate associated with the specified IAM user.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated IAM users.

" + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified IAM user. Unlike the AWS Management Console, when you delete a user programmatically, you must delete the items attached to the user manually, or the deletion fails. For more information, see Deleting an IAM User. Before attempting to delete a user, remove the following items:

" + }, + "DeleteUserPermissionsBoundary":{ + "name":"DeleteUserPermissionsBoundary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPermissionsBoundaryRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the permissions boundary for the specified IAM user.

Deleting the permissions boundary for a user might increase its permissions by allowing the user to perform all the actions granted in its permissions policies.

" + }, + "DeleteUserPolicy":{ + "name":"DeleteUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the specified inline policy that is embedded in the specified IAM user.

A user can also have managed policies attached to it. To detach a managed policy from a user, use DetachUserPolicy. For more information about policies, refer to Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DeleteVirtualMFADevice":{ + "name":"DeleteVirtualMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVirtualMFADeviceRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"DeleteConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes a virtual MFA device.

You must deactivate a user's virtual MFA device before you can delete it. For information about deactivating MFA devices, see DeactivateMFADevice.

" + }, + "DetachGroupPolicy":{ + "name":"DetachGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachGroupPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified managed policy from the specified IAM group.

A group can also have inline policies embedded with it. To delete an inline policy, use the DeleteGroupPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DetachRolePolicy":{ + "name":"DetachRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified managed policy from the specified role.

A role can also have inline policies embedded with it. To delete an inline policy, use the DeleteRolePolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "DetachUserPolicy":{ + "name":"DetachUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachUserPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified managed policy from the specified user.

A user can also have inline policies embedded with it. To delete an inline policy, use the DeleteUserPolicy API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "EnableMFADevice":{ + "name":"EnableMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableMFADeviceRequest"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"InvalidAuthenticationCodeException"}, + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Enables the specified MFA device and associates it with the specified IAM user. When enabled, the MFA device is required for every subsequent login by the IAM user associated with the device.

" + }, + "GenerateCredentialReport":{ + "name":"GenerateCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GenerateCredentialReportResponse", + "resultWrapper":"GenerateCredentialReportResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Generates a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

" + }, + "GenerateOrganizationsAccessReport":{ + "name":"GenerateOrganizationsAccessReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateOrganizationsAccessReportRequest"}, + "output":{ + "shape":"GenerateOrganizationsAccessReportResponse", + "resultWrapper":"GenerateOrganizationsAccessReportResult" + }, + "errors":[ + {"shape":"ReportGenerationLimitExceededException"} + ], + "documentation":"

Generates a report for service last accessed data for AWS Organizations. You can generate a report for any entities (organization root, organizational unit, or account) or policies in your organization.

To call this operation, you must be signed in using your AWS Organizations master account credentials. You can use your long-term IAM user or root user credentials, or temporary credentials from assuming an IAM role. SCPs must be enabled for your organization root. You must have the required IAM and AWS Organizations permissions. For more information, see Refining Permissions Using Service Last Accessed Data in the IAM User Guide.

You can generate a service last accessed data report for entities by specifying only the entity's path. This data includes a list of services that are allowed by any service control policies (SCPs) that apply to the entity.

You can generate a service last accessed data report for a policy by specifying an entity's path and an optional AWS Organizations policy ID. This data includes a list of services that are allowed by the specified SCP.

For each service in both report types, the data includes the most recent account activity that the policy allows to account principals in the entity or the entity's children. For important information about the data, reporting period, permissions required, troubleshooting, and supported Regions see Reducing Permissions Using Service Last Accessed Data in the IAM User Guide.

The data includes all attempts to access AWS, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that an account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide.

This operation returns a JobId. Use this parameter in the GetOrganizationsAccessReport operation to check the status of the report generation. To check the status of this request, use the JobId parameter in the GetOrganizationsAccessReport operation and test the JobStatus response parameter. When the job is complete, you can retrieve the report.

To generate a service last accessed data report for entities, specify an entity path without specifying the optional AWS Organizations policy ID. The type of entity that you specify determines the data returned in the report.

  • Root – When you specify the organizations root as the entity, the resulting report lists all of the services allowed by SCPs that are attached to your root. For each service, the report includes data for all accounts in your organization except the master account, because the master account is not limited by SCPs.

  • OU – When you specify an organizational unit (OU) as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the OU and its parents. For each service, the report includes data for all accounts in the OU or its children. This data excludes the master account, because the master account is not limited by SCPs.

  • Master account – When you specify the master account, the resulting report lists all AWS services, because the master account is not limited by SCPs. For each service, the report includes data for only the master account.

  • Account – When you specify another account as the entity, the resulting report lists all of the services allowed by SCPs that are attached to the account and its parents. For each service, the report includes data for only the specified account.

To generate a service last accessed data report for policies, specify an entity path and the optional AWS Organizations policy ID. The type of entity that you specify determines the data returned for each service.

  • Root – When you specify the root entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in your organization to which the SCP applies. This data excludes the master account, because the master account is not limited by SCPs. If the SCP is not attached to any entities in the organization, then the report will return a list of services with no data.

  • OU – When you specify an OU entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for all accounts in the OU or its children to which the SCP applies. This means that other accounts outside the OU that are affected by the SCP might not be included in the data. This data excludes the master account, because the master account is not limited by SCPs. If the SCP is not attached to the OU or one of its children, the report will return a list of services with no data.

  • Master account – When you specify the master account, the resulting report lists all AWS services, because the master account is not limited by SCPs. If you specify a policy ID in the CLI or API, the policy is ignored. For each service, the report includes data for only the master account.

  • Account – When you specify another account entity and a policy ID, the resulting report lists all of the services that are allowed by the specified SCP. For each service, the report includes data for only the specified account. This means that other accounts in the organization that are affected by the SCP might not be included in the data. If the SCP is not attached to the account, the report will return a list of services with no data.

Service last accessed data does not use other policy types when determining whether a principal could access a service. These other policy types include identity-based policies, resource-based policies, access control lists, IAM permissions boundaries, and STS assume role policies. It only applies SCP logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.

For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide.

" + }, + "GenerateServiceLastAccessedDetails":{ + "name":"GenerateServiceLastAccessedDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateServiceLastAccessedDetailsRequest"}, + "output":{ + "shape":"GenerateServiceLastAccessedDetailsResponse", + "resultWrapper":"GenerateServiceLastAccessedDetailsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Generates a report that includes details about when an IAM resource (user, group, role, or policy) was last used in an attempt to access AWS services. Recent activity usually appears within four hours. IAM reports activity for the last 365 days, or less if your Region began supporting this feature within the last year. For more information, see Regions Where Data Is Tracked.

The service last accessed data includes all attempts to access an AWS API, not just the successful ones. This includes all attempts that were made using the AWS Management Console, the AWS API through any of the SDKs, or any of the command line tools. An unexpected entry in the service last accessed data does not mean that your account has been compromised, because the request might have been denied. Refer to your CloudTrail logs as the authoritative source for information about all API calls and whether they were successful or denied access. For more information, see Logging IAM Events with CloudTrail in the IAM User Guide.

The GenerateServiceLastAccessedDetails operation returns a JobId. Use this parameter in the following operations to retrieve the following details from your report:

  • GetServiceLastAccessedDetails – Use this operation for users, groups, roles, or policies to list every AWS service that the resource could access using permissions policies. For each service, the response includes information about the most recent access attempt.

  • GetServiceLastAccessedDetailsWithEntities – Use this operation for groups and policies to list information about the associated entities (users or roles) that attempted to access a specific AWS service.

To check the status of the GenerateServiceLastAccessedDetails request, use the JobId parameter in the same operations and test the JobStatus response parameter.

For additional information about the permissions policies that allow an identity (user, group, or role) to access specific services, use the ListPoliciesGrantingServiceAccess operation.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.

For more information about service last accessed data, see Reducing Policy Scope by Viewing User Activity in the IAM User Guide.

" + }, + "GetAccessKeyLastUsed":{ + "name":"GetAccessKeyLastUsed", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessKeyLastUsedRequest"}, + "output":{ + "shape":"GetAccessKeyLastUsedResponse", + "resultWrapper":"GetAccessKeyLastUsedResult" + }, + "documentation":"

Retrieves information about when the specified access key was last used. The information includes the date and time of last use, along with the AWS service and Region that were specified in the last request made with that key.

" + }, + "GetAccountAuthorizationDetails":{ + "name":"GetAccountAuthorizationDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountAuthorizationDetailsRequest"}, + "output":{ + "shape":"GetAccountAuthorizationDetailsResponse", + "resultWrapper":"GetAccountAuthorizationDetailsResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about all IAM users, groups, roles, and policies in your AWS account, including their relationships to one another. Use this API to obtain a snapshot of the configuration of IAM permissions (users, groups, roles, and policies) in your account.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

You can optionally filter the results using the Filter parameter. You can paginate the results using the MaxItems and Marker parameters.

" + }, + "GetAccountPasswordPolicy":{ + "name":"GetAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountPasswordPolicyResponse", + "resultWrapper":"GetAccountPasswordPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the password policy for the AWS account. For more information about using a password policy, go to Managing an IAM Password Policy.

" + }, + "GetAccountSummary":{ + "name":"GetAccountSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountSummaryResponse", + "resultWrapper":"GetAccountSummaryResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about IAM entity usage and IAM quotas in the AWS account.

For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.

" + }, + "GetContextKeysForCustomPolicy":{ + "name":"GetContextKeysForCustomPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContextKeysForCustomPolicyRequest"}, + "output":{ + "shape":"GetContextKeysForPolicyResponse", + "resultWrapper":"GetContextKeysForCustomPolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets a list of all of the context keys referenced in the input policies. The policies are supplied as a list of one or more strings. To get the context keys from policies associated with an IAM user, group, or role, use GetContextKeysForPrincipalPolicy.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value specified in an IAM policy. Use GetContextKeysForCustomPolicy to understand what key names and values you must supply when you call SimulateCustomPolicy. Note that all parameters are shown in unencoded form here for clarity but must be URL encoded to be included as a part of a real HTML request.

" + }, + "GetContextKeysForPrincipalPolicy":{ + "name":"GetContextKeysForPrincipalPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContextKeysForPrincipalPolicyRequest"}, + "output":{ + "shape":"GetContextKeysForPolicyResponse", + "resultWrapper":"GetContextKeysForPrincipalPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Gets a list of all of the context keys referenced in all the IAM policies that are attached to the specified IAM entity. The entity can be an IAM user, group, or role. If you specify a user, then the request also includes all of the policies attached to groups that the user is a member of.

You can optionally include a list of one or more additional policies, specified as strings. If you want to include only a list of policies by string, use GetContextKeysForCustomPolicy instead.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use GetContextKeysForCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. Context keys can be evaluated by testing against a value in an IAM policy. Use GetContextKeysForPrincipalPolicy to understand what key names and values you must supply when you call SimulatePrincipalPolicy.

" + }, + "GetCredentialReport":{ + "name":"GetCredentialReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetCredentialReportResponse", + "resultWrapper":"GetCredentialReportResult" + }, + "errors":[ + {"shape":"CredentialReportNotPresentException"}, + {"shape":"CredentialReportExpiredException"}, + {"shape":"CredentialReportNotReadyException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves a credential report for the AWS account. For more information about the credential report, see Getting Credential Reports in the IAM User Guide.

" + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{ + "shape":"GetGroupResponse", + "resultWrapper":"GetGroupResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

" + }, + "GetGroupPolicy":{ + "name":"GetGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGroupPolicyRequest"}, + "output":{ + "shape":"GetGroupPolicyResponse", + "resultWrapper":"GetGroupPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM group.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM group can also have managed policies attached to it. To retrieve a managed policy document that is attached to a group, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "GetInstanceProfile":{ + "name":"GetInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceProfileRequest"}, + "output":{ + "shape":"GetInstanceProfileResponse", + "resultWrapper":"GetInstanceProfileResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see About Instance Profiles in the IAM User Guide.

" + }, + "GetLoginProfile":{ + "name":"GetLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoginProfileRequest"}, + "output":{ + "shape":"GetLoginProfileResponse", + "resultWrapper":"GetLoginProfileResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the user name and password-creation date for the specified IAM user. If the user has not been assigned a password, the operation returns a 404 (NoSuchEntity) error.

" + }, + "GetOpenIDConnectProvider":{ + "name":"GetOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpenIDConnectProviderRequest"}, + "output":{ + "shape":"GetOpenIDConnectProviderResponse", + "resultWrapper":"GetOpenIDConnectProviderResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Returns information about the specified OpenID Connect (OIDC) provider resource object in IAM.

" + }, + "GetOrganizationsAccessReport":{ + "name":"GetOrganizationsAccessReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOrganizationsAccessReportRequest"}, + "output":{ + "shape":"GetOrganizationsAccessReportResponse", + "resultWrapper":"GetOrganizationsAccessReportResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Retrieves the service last accessed data report for AWS Organizations that was previously generated using the GenerateOrganizationsAccessReport operation. This operation retrieves the status of your report job and the report contents.

Depending on the parameters that you passed when you generated the report, the data returned could include different information. For details, see GenerateOrganizationsAccessReport.

To call this operation, you must be signed in to the master account in your organization. SCPs must be enabled for your organization root. You must have permissions to perform this operation. For more information, see Refining Permissions Using Service Last Accessed Data in the IAM User Guide.

For each service that principals in an account (root users, IAM users, or IAM roles) could access using SCPs, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, it returns the reason that it failed.

By default, the list is sorted by service namespace.

" + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{ + "shape":"GetPolicyResponse", + "resultWrapper":"GetPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified managed policy, including the policy's default version and the total number of IAM users, groups, and roles to which the policy is attached. To retrieve the list of the specific users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API. This API returns metadata about the policy. To retrieve the actual policy document for a specific version of the policy, use GetPolicyVersion.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded with an IAM user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "GetPolicyVersion":{ + "name":"GetPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPolicyVersionRequest"}, + "output":{ + "shape":"GetPolicyVersionResponse", + "resultWrapper":"GetPolicyVersionResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified version of the specified managed policy, including the policy document.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

To list the available versions for a policy, use ListPolicyVersions.

This API retrieves information about managed policies. To retrieve information about an inline policy that is embedded in a user, group, or role, use the GetUserPolicy, GetGroupPolicy, or GetRolePolicy API.

For more information about the types of policies, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + }, + "GetRole":{ + "name":"GetRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRoleRequest"}, + "output":{ + "shape":"GetRoleResponse", + "resultWrapper":"GetRoleResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified role, including the role's path, GUID, ARN, and the role's trust policy that grants permission to assume the role. For more information about roles, see Working with Roles.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

" + }, + "GetRolePolicy":{ + "name":"GetRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRolePolicyRequest"}, + "output":{ + "shape":"GetRolePolicyResponse", + "resultWrapper":"GetRolePolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the specified inline policy document that is embedded with the specified IAM role.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM role can also have managed policies attached to it. To retrieve a managed policy document that is attached to a role, use GetPolicy to determine the policy's default version, then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For more information about roles, see Using Roles to Delegate Permissions and Federate Identities.

" + }, + "GetSAMLProvider":{ + "name":"GetSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSAMLProviderRequest"}, + "output":{ + "shape":"GetSAMLProviderResponse", + "resultWrapper":"GetSAMLProviderResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Returns the SAML provider metadocument that was uploaded when the IAM SAML provider resource object was created or updated.

This operation requires Signature Version 4.

" + }, + "GetSSHPublicKey":{ + "name":"GetSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSSHPublicKeyRequest"}, + "output":{ + "shape":"GetSSHPublicKeyResponse", + "resultWrapper":"GetSSHPublicKeyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"UnrecognizedPublicKeyEncodingException"} + ], + "documentation":"

Retrieves the specified SSH public key, including metadata about the key.

The SSH public key retrieved by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" + }, + "GetServerCertificate":{ + "name":"GetServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServerCertificateRequest"}, + "output":{ + "shape":"GetServerCertificateResponse", + "resultWrapper":"GetServerCertificateResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM.

" + }, + "GetServiceLastAccessedDetails":{ + "name":"GetServiceLastAccessedDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceLastAccessedDetailsRequest"}, + "output":{ + "shape":"GetServiceLastAccessedDetailsResponse", + "resultWrapper":"GetServiceLastAccessedDetailsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Retrieves a service last accessed report that was created using the GenerateServiceLastAccessedDetails operation. You can use the JobId parameter in GetServiceLastAccessedDetails to retrieve the status of your report job. When the report is complete, you can retrieve the generated report. The report includes a list of AWS services that the resource (user, group, role, or managed policy) can access.

Service last accessed data does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.

For each service that the resource could access using permissions policies, the operation returns details about the most recent access attempt. If there was no attempt, the service is listed without details about the most recent attempt to access the service. If the operation fails, the GetServiceLastAccessedDetails operation returns the reason that it failed.

The GetServiceLastAccessedDetails operation returns a list of services. This list includes the number of entities that have attempted to access the service and the date and time of the last attempt. It also returns the ARN of the following entity, depending on the resource ARN that you used to generate the report:

  • User – Returns the user ARN that you used to generate the report

  • Group – Returns the ARN of the group member (user) that last attempted to access the service

  • Role – Returns the role ARN that you used to generate the report

  • Policy – Returns the ARN of the user or role that last used the policy to attempt to access the service

By default, the list is sorted by service namespace.

" + }, + "GetServiceLastAccessedDetailsWithEntities":{ + "name":"GetServiceLastAccessedDetailsWithEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceLastAccessedDetailsWithEntitiesRequest"}, + "output":{ + "shape":"GetServiceLastAccessedDetailsWithEntitiesResponse", + "resultWrapper":"GetServiceLastAccessedDetailsWithEntitiesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

After you generate a group or policy report using the GenerateServiceLastAccessedDetails operation, you can use the JobId parameter in GetServiceLastAccessedDetailsWithEntities. This operation retrieves the status of your report job and a list of entities that could have used group or policy permissions to access the specified service.

  • Group – For a group report, this operation returns a list of users in the group that could have used the group’s policies in an attempt to access the service.

  • Policy – For a policy report, this operation returns a list of entities (users or roles) that could have used the policy in an attempt to access the service.

You can also use this operation for user or role reports to retrieve details about those entities.

If the operation fails, the GetServiceLastAccessedDetailsWithEntities operation returns the reason that it failed.

By default, the list of associated entities is sorted by date, with the most recent access listed first.

" + }, + "GetServiceLinkedRoleDeletionStatus":{ + "name":"GetServiceLinkedRoleDeletionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceLinkedRoleDeletionStatusRequest"}, + "output":{ + "shape":"GetServiceLinkedRoleDeletionStatusResponse", + "resultWrapper":"GetServiceLinkedRoleDeletionStatusResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the status of your service-linked role deletion. After you use the DeleteServiceLinkedRole API operation to submit a service-linked role for deletion, you can use the DeletionTaskId parameter in GetServiceLinkedRoleDeletionStatus to check the status of the deletion. If the deletion fails, this operation returns the reason that it failed, if that information is returned by the service.

" + }, + "GetUser":{ + "name":"GetUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserRequest"}, + "output":{ + "shape":"GetUserResponse", + "resultWrapper":"GetUserResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves information about the specified IAM user, including the user's creation date, path, unique ID, and ARN.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID used to sign the request to this API.

" + }, + "GetUserPolicy":{ + "name":"GetUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUserPolicyRequest"}, + "output":{ + "shape":"GetUserPolicyResponse", + "resultWrapper":"GetUserPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Retrieves the specified inline policy document that is embedded in the specified IAM user.

Policies returned by this API are URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

An IAM user can also have managed policies attached to it. To retrieve a managed policy document that is attached to a user, use GetPolicy to determine the policy's default version. Then use GetPolicyVersion to retrieve the policy document.

For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "ListAccessKeys":{ + "name":"ListAccessKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccessKeysRequest"}, + "output":{ + "shape":"ListAccessKeysResponse", + "resultWrapper":"ListAccessKeysResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Returns information about the access key IDs associated with the specified IAM user. If there is none, the operation returns an empty list.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation.

" + }, + "ListAccountAliases":{ + "name":"ListAccountAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountAliasesRequest"}, + "output":{ + "shape":"ListAccountAliasesResponse", + "resultWrapper":"ListAccountAliasesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the account alias associated with the AWS account (Note: you can have only one). For information about using an AWS account alias, see Using an Alias for Your AWS Account ID in the IAM User Guide.

" + }, + "ListAttachedGroupPolicies":{ + "name":"ListAttachedGroupPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedGroupPoliciesRequest"}, + "output":{ + "shape":"ListAttachedGroupPoliciesResponse", + "resultWrapper":"ListAttachedGroupPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists all managed policies that are attached to the specified IAM group.

An IAM group can also have inline policies embedded with it. To list the inline policies for a group, use the ListGroupPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

" + }, + "ListAttachedRolePolicies":{ + "name":"ListAttachedRolePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedRolePoliciesRequest"}, + "output":{ + "shape":"ListAttachedRolePoliciesResponse", + "resultWrapper":"ListAttachedRolePoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists all managed policies that are attached to the specified IAM role.

An IAM role can also have inline policies embedded with it. To list the inline policies for a role, use the ListRolePolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified role (or none that match the specified path prefix), the operation returns an empty list.

" + }, + "ListAttachedUserPolicies":{ + "name":"ListAttachedUserPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedUserPoliciesRequest"}, + "output":{ + "shape":"ListAttachedUserPoliciesResponse", + "resultWrapper":"ListAttachedUserPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists all managed policies that are attached to the specified IAM user.

An IAM user can also have inline policies embedded with it. To list the inline policies for a user, use the ListUserPolicies API. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. You can use the PathPrefix parameter to limit the list of policies to only those matching the specified path prefix. If there are no policies attached to the specified group (or none that match the specified path prefix), the operation returns an empty list.

" + }, + "ListEntitiesForPolicy":{ + "name":"ListEntitiesForPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEntitiesForPolicyRequest"}, + "output":{ + "shape":"ListEntitiesForPolicyResponse", + "resultWrapper":"ListEntitiesForPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists all IAM users, groups, and roles that the specified managed policy is attached to.

You can use the optional EntityFilter parameter to limit the results to a particular type of entity (users, groups, or roles). For example, to list only the roles that are attached to the specified policy, set EntityFilter to Role.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListGroupPolicies":{ + "name":"ListGroupPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupPoliciesRequest"}, + "output":{ + "shape":"ListGroupPoliciesResponse", + "resultWrapper":"ListGroupPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM group.

An IAM group can also have managed policies attached to it. To list the managed policies that are attached to a group, use ListAttachedGroupPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified group, the operation returns an empty list.

" + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{ + "shape":"ListGroupsResponse", + "resultWrapper":"ListGroupsResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the IAM groups that have the specified path prefix.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListGroupsForUser":{ + "name":"ListGroupsForUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsForUserRequest"}, + "output":{ + "shape":"ListGroupsForUserResponse", + "resultWrapper":"ListGroupsForUserResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the IAM groups that the specified IAM user belongs to.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListInstanceProfiles":{ + "name":"ListInstanceProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesRequest"}, + "output":{ + "shape":"ListInstanceProfilesResponse", + "resultWrapper":"ListInstanceProfilesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the instance profiles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListInstanceProfilesForRole":{ + "name":"ListInstanceProfilesForRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstanceProfilesForRoleRequest"}, + "output":{ + "shape":"ListInstanceProfilesForRoleResponse", + "resultWrapper":"ListInstanceProfilesForRoleResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the instance profiles that have the specified associated IAM role. If there are none, the operation returns an empty list. For more information about instance profiles, go to About Instance Profiles.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListMFADevices":{ + "name":"ListMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMFADevicesRequest"}, + "output":{ + "shape":"ListMFADevicesResponse", + "resultWrapper":"ListMFADevicesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the MFA devices for an IAM user. If the request includes a IAM user name, then this operation lists all the MFA devices associated with the specified user. If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request for this API.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListOpenIDConnectProviders":{ + "name":"ListOpenIDConnectProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpenIDConnectProvidersRequest"}, + "output":{ + "shape":"ListOpenIDConnectProvidersResponse", + "resultWrapper":"ListOpenIDConnectProvidersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists information about the IAM OpenID Connect (OIDC) provider resource objects defined in the AWS account.

" + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{ + "shape":"ListPoliciesResponse", + "resultWrapper":"ListPoliciesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists all the managed policies that are available in your AWS account, including your own customer-defined managed policies and all AWS managed policies.

You can filter the list of policies that is returned using the optional OnlyAttached, Scope, and PathPrefix parameters. For example, to list only the customer managed policies in your AWS account, set Scope to Local. To list only AWS managed policies, set Scope to AWS.

You can paginate the results using the MaxItems and Marker parameters.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "ListPoliciesGrantingServiceAccess":{ + "name":"ListPoliciesGrantingServiceAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesGrantingServiceAccessRequest"}, + "output":{ + "shape":"ListPoliciesGrantingServiceAccessResponse", + "resultWrapper":"ListPoliciesGrantingServiceAccessResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Retrieves a list of policies that the IAM identity (user, group, or role) can use to access each specified service.

This operation does not use other policy types when determining whether a resource could access a service. These other policy types include resource-based policies, access control lists, AWS Organizations policies, IAM permissions boundaries, and AWS STS assume role policies. It only applies permissions policy logic. For more about the evaluation of policy types, see Evaluating Policies in the IAM User Guide.

The list of policies returned by the operation depends on the ARN of the identity that you provide.

  • User – The list of policies includes the managed and inline policies that are attached to the user directly. The list also includes any additional managed and inline policies that are attached to the group to which the user belongs.

  • Group – The list of policies includes only the managed and inline policies that are attached to the group directly. Policies that are attached to the group’s user are not included.

  • Role – The list of policies includes only the managed and inline policies that are attached to the role.

For each managed policy, this operation returns the ARN and policy name. For each inline policy, it returns the policy name and the entity to which it is attached. Inline policies do not have an ARN. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide.

Policies that are attached to users and roles as permissions boundaries are not returned. To view which managed policy is currently used to set the permissions boundary for a user or role, use the GetUser or GetRole operations.

" + }, + "ListPolicyVersions":{ + "name":"ListPolicyVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPolicyVersionsRequest"}, + "output":{ + "shape":"ListPolicyVersionsResponse", + "resultWrapper":"ListPolicyVersionsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists information about the versions of the specified managed policy, including the version that is currently set as the policy's default version.

For more information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "ListRolePolicies":{ + "name":"ListRolePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolePoliciesRequest"}, + "output":{ + "shape":"ListRolePoliciesResponse", + "resultWrapper":"ListRolePoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the names of the inline policies that are embedded in the specified IAM role.

An IAM role can also have managed policies attached to it. To list the managed policies that are attached to a role, use ListAttachedRolePolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified role, the operation returns an empty list.

" + }, + "ListRoleTags":{ + "name":"ListRoleTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRoleTagsRequest"}, + "output":{ + "shape":"ListRoleTagsResponse", + "resultWrapper":"ListRoleTagsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the tags that are attached to the specified role. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "ListRoles":{ + "name":"ListRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRolesRequest"}, + "output":{ + "shape":"ListRolesResponse", + "resultWrapper":"ListRolesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the IAM roles that have the specified path prefix. If there are none, the operation returns an empty list. For more information about roles, go to Working with Roles.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListSAMLProviders":{ + "name":"ListSAMLProviders", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSAMLProvidersRequest"}, + "output":{ + "shape":"ListSAMLProvidersResponse", + "resultWrapper":"ListSAMLProvidersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the SAML provider resource objects defined in IAM in the account.

This operation requires Signature Version 4.

" + }, + "ListSSHPublicKeys":{ + "name":"ListSSHPublicKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSSHPublicKeysRequest"}, + "output":{ + "shape":"ListSSHPublicKeysResponse", + "resultWrapper":"ListSSHPublicKeysResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Returns information about the SSH public keys associated with the specified IAM user. If none exists, the operation returns an empty list.

The SSH public keys returned by this operation are used only for authenticating the IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

Although each user is limited to a small number of keys, you can still paginate the results using the MaxItems and Marker parameters.

" + }, + "ListServerCertificates":{ + "name":"ListServerCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServerCertificatesRequest"}, + "output":{ + "shape":"ListServerCertificatesResponse", + "resultWrapper":"ListServerCertificatesResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the server certificates stored in IAM that have the specified path prefix. If none exist, the operation returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.

" + }, + "ListServiceSpecificCredentials":{ + "name":"ListServiceSpecificCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceSpecificCredentialsRequest"}, + "output":{ + "shape":"ListServiceSpecificCredentialsResponse", + "resultWrapper":"ListServiceSpecificCredentialsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceNotSupportedException"} + ], + "documentation":"

Returns information about the service-specific credentials associated with the specified IAM user. If none exists, the operation returns an empty list. The service-specific credentials returned by this operation are used only for authenticating the IAM user to a specific service. For more information about using service-specific credentials to authenticate to an AWS service, see Set Up service-specific credentials in the AWS CodeCommit User Guide.

" + }, + "ListSigningCertificates":{ + "name":"ListSigningCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSigningCertificatesRequest"}, + "output":{ + "shape":"ListSigningCertificatesResponse", + "resultWrapper":"ListSigningCertificatesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Returns information about the signing certificates associated with the specified IAM user. If none exists, the operation returns an empty list.

Although each user is limited to a small number of signing certificates, you can still paginate the results using the MaxItems and Marker parameters.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request for this API. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

" + }, + "ListUserPolicies":{ + "name":"ListUserPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserPoliciesRequest"}, + "output":{ + "shape":"ListUserPoliciesResponse", + "resultWrapper":"ListUserPoliciesResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the names of the inline policies embedded in the specified IAM user.

An IAM user can also have managed policies attached to it. To list the managed policies that are attached to a user, use ListAttachedUserPolicies. For more information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

You can paginate the results using the MaxItems and Marker parameters. If there are no inline policies embedded with the specified user, the operation returns an empty list.

" + }, + "ListUserTags":{ + "name":"ListUserTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUserTagsRequest"}, + "output":{ + "shape":"ListUserTagsResponse", + "resultWrapper":"ListUserTagsResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the tags that are attached to the specified user. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{ + "shape":"ListUsersResponse", + "resultWrapper":"ListUsersResult" + }, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Lists the IAM users that have the specified path prefix. If no path prefix is specified, the operation returns all users in the AWS account. If there are none, the operation returns an empty list.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "ListVirtualMFADevices":{ + "name":"ListVirtualMFADevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVirtualMFADevicesRequest"}, + "output":{ + "shape":"ListVirtualMFADevicesResponse", + "resultWrapper":"ListVirtualMFADevicesResult" + }, + "documentation":"

Lists the virtual MFA devices defined in the AWS account by assignment status. If you do not specify an assignment status, the operation returns a list of all virtual MFA devices. Assignment status can be Assigned, Unassigned, or Any.

You can paginate the results using the MaxItems and Marker parameters.

" + }, + "PutGroupPolicy":{ + "name":"PutGroupPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutGroupPolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM group.

A user can also have managed policies attached to it. To attach a managed policy to a group, use AttachGroupPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a group, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutGroupPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" + }, + "PutRolePermissionsBoundary":{ + "name":"PutRolePermissionsBoundary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRolePermissionsBoundaryRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"PolicyNotAttachableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds or updates the policy that is specified as the IAM role's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a role. Use the boundary to control the maximum permissions that the role can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the role.

You cannot set the boundary for a service-linked role.

Policies used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the role. To learn how the effective permissions for a role are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide.

" + }, + "PutRolePolicy":{ + "name":"PutRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRolePolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM role.

When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role, using CreateRole. You can update a role's trust policy using UpdateAssumeRolePolicy. For more information about IAM roles, go to Using Roles to Delegate Permissions and Federate Identities.

A role can also have a managed policy attached to it. To attach a managed policy to a role, use AttachRolePolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed with a role, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutRolePolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" + }, + "PutUserPermissionsBoundary":{ + "name":"PutUserPermissionsBoundary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutUserPermissionsBoundaryRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotAttachableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds or updates the policy that is specified as the IAM user's permissions boundary. You can use an AWS managed policy or a customer managed policy to set the boundary for a user. Use the boundary to control the maximum permissions that the user can have. Setting a permissions boundary is an advanced feature that can affect the permissions for the user.

Policies that are used as permissions boundaries do not provide permissions. You must also attach a permissions policy to the user. To learn how the effective permissions for a user are evaluated, see IAM JSON Policy Evaluation Logic in the IAM User Guide.

" + }, + "PutUserPolicy":{ + "name":"PutUserPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutUserPolicyRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds or updates an inline policy document that is embedded in the specified IAM user.

An IAM user can also have a managed policy attached to it. To attach a managed policy to a user, use AttachUserPolicy. To create a new managed policy, use CreatePolicy. For information about policies, see Managed Policies and Inline Policies in the IAM User Guide.

For information about limits on the number of inline policies that you can embed in a user, see Limitations on IAM Entities in the IAM User Guide.

Because policy documents can be large, you should use POST rather than GET when calling PutUserPolicy. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" + }, + "RemoveClientIDFromOpenIDConnectProvider":{ + "name":"RemoveClientIDFromOpenIDConnectProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveClientIDFromOpenIDConnectProviderRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified client ID (also known as audience) from the list of client IDs registered for the specified IAM OpenID Connect (OIDC) provider resource object.

This operation is idempotent; it does not fail or return an error if you try to remove a client ID that does not exist.

" + }, + "RemoveRoleFromInstanceProfile":{ + "name":"RemoveRoleFromInstanceProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromInstanceProfileRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified IAM role from the specified EC2 instance profile.

Make sure that you do not have any Amazon EC2 instances running with the role you are about to remove from the instance profile. Removing a role from an instance profile that is associated with a running instance might break any applications running on the instance.

For more information about IAM roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" + }, + "RemoveUserFromGroup":{ + "name":"RemoveUserFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveUserFromGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified user from the specified group.

" + }, + "ResetServiceSpecificCredential":{ + "name":"ResetServiceSpecificCredential", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetServiceSpecificCredentialRequest"}, + "output":{ + "shape":"ResetServiceSpecificCredentialResponse", + "resultWrapper":"ResetServiceSpecificCredentialResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Resets the password for a service-specific credential. The new password is AWS generated and cryptographically strong. It cannot be configured by the user. Resetting the password immediately invalidates the previous password associated with this user.

" + }, + "ResyncMFADevice":{ + "name":"ResyncMFADevice", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResyncMFADeviceRequest"}, + "errors":[ + {"shape":"InvalidAuthenticationCodeException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Synchronizes the specified MFA device with its IAM resource object on the AWS servers.

For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

" + }, + "SetDefaultPolicyVersion":{ + "name":"SetDefaultPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetDefaultPolicyVersionRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Sets the specified version of the specified policy as the policy's default (operative) version.

This operation affects all users, groups, and roles that the policy is attached to. To list the users, groups, and roles that the policy is attached to, use the ListEntitiesForPolicy API.

For information about managed policies, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "SetSecurityTokenServicePreferences":{ + "name":"SetSecurityTokenServicePreferences", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSecurityTokenServicePreferencesRequest"}, + "errors":[ + {"shape":"ServiceFailureException"} + ], + "documentation":"

Sets the specified version of the global endpoint token as the token version used for the AWS account.

By default, AWS Security Token Service (STS) is available as a global service, and all STS requests go to a single endpoint at https://sts.amazonaws.com. AWS recommends using Regional STS endpoints to reduce latency, build in redundancy, and increase session token availability. For information about Regional endpoints for STS, see AWS Regions and Endpoints in the AWS General Reference.

If you make an STS call to the global endpoint, the resulting session tokens might be valid in some Regions but not others. It depends on the version that is set in this operation. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens. For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide.

To view the current session token version, see the GlobalEndpointTokenVersion entry in the response of the GetAccountSummary operation.

" + }, + "SimulateCustomPolicy":{ + "name":"SimulateCustomPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SimulateCustomPolicyRequest"}, + "output":{ + "shape":"SimulatePolicyResponse", + "resultWrapper":"SimulateCustomPolicyResult" + }, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"PolicyEvaluationException"} + ], + "documentation":"

Simulate how a set of IAM policies and optionally a resource-based policy works with a list of API operations and AWS resources to determine the policies' effective permissions. The policies are provided as strings.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

If you want to simulate existing policies attached to an IAM user, group, or role, use SimulatePrincipalPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForCustomPolicy.

If the output is long, you can use MaxItems and Marker parameters to paginate the results.

" + }, + "SimulatePrincipalPolicy":{ + "name":"SimulatePrincipalPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SimulatePrincipalPolicyRequest"}, + "output":{ + "shape":"SimulatePolicyResponse", + "resultWrapper":"SimulatePrincipalPolicyResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyEvaluationException"} + ], + "documentation":"

Simulate how a set of IAM policies attached to an IAM entity works with a list of API operations and AWS resources to determine the policies' effective permissions. The entity can be an IAM user, group, or role. If you specify a user, then the simulation also includes all of the policies that are attached to groups that the user belongs to.

You can optionally include a list of one or more additional policies specified as strings to include in the simulation. If you want to simulate only policies specified as strings, use SimulateCustomPolicy instead.

You can also optionally include one resource-based policy to be evaluated with each of the resources included in the simulation.

The simulation does not perform the API operations; it only checks the authorization to determine if the simulated policies allow or deny the operations.

Note: This API discloses information about the permissions granted to other users. If you do not want users to see other user's permissions, then consider allowing them to use SimulateCustomPolicy instead.

Context keys are variables maintained by AWS and its services that provide details about the context of an API query request. You can use the Condition element of an IAM policy to evaluate context keys. To get the list of context keys that the policies require for correct simulation, use GetContextKeysForPrincipalPolicy.

If the output is long, you can use the MaxItems and Marker parameters to paginate the results.

" + }, + "TagRole":{ + "name":"TagRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagRoleRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds one or more tags to an IAM role. The role can be a regular role or a service-linked role. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM user or role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which AWS resources.

  • Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role.

  • AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "TagUser":{ + "name":"TagUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagUserRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Adds one or more tags to an IAM user. If a tag with the same key name already exists, then that tag is overwritten with the new value.

A tag consists of a key name and an associated value. By assigning tags to your resources, you can do the following:

  • Administrative grouping and discovery - Attach tags to resources to aid in organization and search. For example, you could search for all resources with the key name Project and the value MyImportantProject. Or search for all resources with the key name Cost Center and the value 41200.

  • Access control - Reference tags in IAM user-based and resource-based policies. You can use tags to restrict access to only an IAM requesting user or to a role that has a specified tag attached. You can also restrict access to only those resources that have a certain tag attached. For examples of policies that show how to use tags to control access, see Control Access Using IAM Tags in the IAM User Guide.

  • Cost allocation - Use tags to help track which individuals and teams are using which AWS resources.

  • Make sure that you have no invalid tags and that you do not exceed the allowed number of tags per role. In either case, the entire request fails and no tags are added to the role.

  • AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "UntagRole":{ + "name":"UntagRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagRoleRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified tags from the role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "UntagUser":{ + "name":"UntagUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagUserRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Removes the specified tags from the user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "UpdateAccessKey":{ + "name":"UpdateAccessKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccessKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Changes the status of the specified access key from Active to Inactive, or vice versa. This operation can be used to disable a user's key as part of a key rotation workflow.

If the UserName is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

For information about rotating keys, see Managing Keys and Certificates in the IAM User Guide.

" + }, + "UpdateAccountPasswordPolicy":{ + "name":"UpdateAccountPasswordPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccountPasswordPolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the password policy settings for the AWS account.

  • This operation does not support partial updates. No parameters are required, but if you do not specify a parameter, that parameter's value reverts to its default value. See the Request Parameters section for each parameter's default value. Also note that some parameters do not allow the default parameter to be explicitly set. Instead, to invoke the default value, do not include that parameter when you invoke the operation.

For more information about using a password policy, see Managing an IAM Password Policy in the IAM User Guide.

" + }, + "UpdateAssumeRolePolicy":{ + "name":"UpdateAssumeRolePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssumeRolePolicyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the policy that grants an IAM entity permission to assume a role. This is typically referred to as the \"role trust policy\". For more information about roles, go to Using Roles to Delegate Permissions and Federate Identities.

" + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGroupRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the name and/or the path of the specified IAM group.

You should understand the implications of changing a group's path or name. For more information, see Renaming Users and Groups in the IAM User Guide.

The person making the request (the principal), must have permission to change the role group with the old name and the new name. For example, to change the group named Managers to MGRs, the principal must have a policy that allows them to update both groups. If the principal has permission to update the Managers group, but not the MGRs group, then the update fails. For more information about permissions, see Access Management.

" + }, + "UpdateLoginProfile":{ + "name":"UpdateLoginProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLoginProfileRequest"}, + "errors":[ + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"PasswordPolicyViolationException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Changes the password for the specified IAM user.

IAM users can change their own passwords by calling ChangePassword. For more information about modifying passwords, see Managing Passwords in the IAM User Guide.

" + }, + "UpdateOpenIDConnectProviderThumbprint":{ + "name":"UpdateOpenIDConnectProviderThumbprint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateOpenIDConnectProviderThumbprintRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Replaces the existing list of server certificate thumbprints associated with an OpenID Connect (OIDC) provider resource object with a new list of thumbprints.

The list that you pass with this operation completely replaces the existing list of thumbprints. (The lists are not merged.)

Typically, you need to update a thumbprint only when the identity provider's certificate changes, which occurs rarely. However, if the provider's certificate does change, any attempt to assume an IAM role that specifies the OIDC provider as a principal fails until the certificate thumbprint is updated.

Trust for the OIDC provider is derived from the provider's certificate and is validated by the thumbprint. Therefore, it is best to limit access to the UpdateOpenIDConnectProviderThumbprint operation to highly privileged users.

" + }, + "UpdateRole":{ + "name":"UpdateRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRoleRequest"}, + "output":{ + "shape":"UpdateRoleResponse", + "resultWrapper":"UpdateRoleResult" + }, + "errors":[ + {"shape":"UnmodifiableEntityException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the description or maximum session duration setting of a role.

" + }, + "UpdateRoleDescription":{ + "name":"UpdateRoleDescription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRoleDescriptionRequest"}, + "output":{ + "shape":"UpdateRoleDescriptionResponse", + "resultWrapper":"UpdateRoleDescriptionResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"UnmodifiableEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Use UpdateRole instead.

Modifies only the description of a role. This operation performs the same function as the Description parameter in the UpdateRole operation.

" + }, + "UpdateSAMLProvider":{ + "name":"UpdateSAMLProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSAMLProviderRequest"}, + "output":{ + "shape":"UpdateSAMLProviderResponse", + "resultWrapper":"UpdateSAMLProviderResult" + }, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the metadata document for an existing SAML provider resource object.

This operation requires Signature Version 4.

" + }, + "UpdateSSHPublicKey":{ + "name":"UpdateSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSSHPublicKeyRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Sets the status of an IAM user's SSH public key to active or inactive. SSH public keys that are inactive cannot be used for authentication. This operation can be used to disable a user's SSH public key as part of a key rotation work flow.

The SSH public key affected by this operation is used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" + }, + "UpdateServerCertificate":{ + "name":"UpdateServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the name and/or the path of the specified server certificate stored in IAM.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.

You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a Server Certificate in the IAM User Guide.

The person making the request (the principal), must have permission to change the server certificate with the old name and the new name. For example, to change the certificate named ProductionCert to ProdCert, the principal must have a policy that allows them to update both certificates. If the principal has permission to update the ProductionCert group, but not the ProdCert certificate, then the update fails. For more information about permissions, see Access Management in the IAM User Guide.

" + }, + "UpdateServiceSpecificCredential":{ + "name":"UpdateServiceSpecificCredential", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceSpecificCredentialRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Sets the status of a service-specific credential to Active or Inactive. Service-specific credentials that are inactive cannot be used for authentication to the service. This operation can be used to disable a user's service-specific credential as part of a credential rotation work flow.

" + }, + "UpdateSigningCertificate":{ + "name":"UpdateSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSigningCertificateRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

" + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserRequest"}, + "errors":[ + {"shape":"NoSuchEntityException"}, + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"EntityTemporarilyUnmodifiableException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Updates the name and/or the path of the specified IAM user.

You should understand the implications of changing an IAM user's path or name. For more information, see Renaming an IAM User and Renaming an IAM Group in the IAM User Guide.

To change a user name, the requester must have appropriate permissions on both the source object and the target object. For example, to change Bob to Robert, the entity making the request must have permission on Bob and Robert, or must have permission on all (*). For more information about permissions, see Permissions and Policies.

" + }, + "UploadSSHPublicKey":{ + "name":"UploadSSHPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadSSHPublicKeyRequest"}, + "output":{ + "shape":"UploadSSHPublicKeyResponse", + "resultWrapper":"UploadSSHPublicKeyResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidPublicKeyException"}, + {"shape":"DuplicateSSHPublicKeyException"}, + {"shape":"UnrecognizedPublicKeyEncodingException"} + ], + "documentation":"

Uploads an SSH public key and associates it with the specified IAM user.

The SSH public key uploaded by this operation can be used only for authenticating the associated IAM user to an AWS CodeCommit repository. For more information about using SSH keys to authenticate to an AWS CodeCommit repository, see Set up AWS CodeCommit for SSH Connections in the AWS CodeCommit User Guide.

" + }, + "UploadServerCertificate":{ + "name":"UploadServerCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadServerCertificateRequest"}, + "output":{ + "shape":"UploadServerCertificateResponse", + "resultWrapper":"UploadServerCertificateResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedCertificateException"}, + {"shape":"KeyPairMismatchException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Uploads a server certificate entity for the AWS account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use AWS Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to AWS resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the AWS Certificate Manager User Guide.

For more information about working with server certificates, see Working with Server Certificates in the IAM User Guide. This topic includes a list of AWS services that can use the server certificates that you manage with IAM.

For information about the number of server certificates you can upload, see Limitations on IAM Entities and Objects in the IAM User Guide.

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Calling the API by Making HTTP Query Requests in the IAM User Guide.

" + }, + "UploadSigningCertificate":{ + "name":"UploadSigningCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadSigningCertificateRequest"}, + "output":{ + "shape":"UploadSigningCertificateResponse", + "resultWrapper":"UploadSigningCertificateResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"MalformedCertificateException"}, + {"shape":"InvalidCertificateException"}, + {"shape":"DuplicateCertificateException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some AWS services use X.509 signing certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

If the UserName is not specified, the IAM user name is determined implicitly based on the AWS access key ID used to sign the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials even if the AWS account has no associated users.

Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about using the Query API with IAM, go to Making Query Requests in the IAM User Guide.

" + } + }, + "shapes":{ + "AccessDetail":{ + "type":"structure", + "required":[ + "ServiceName", + "ServiceNamespace" + ], + "members":{ + "ServiceName":{ + "shape":"serviceNameType", + "documentation":"

The name of the service in which access was attempted.

" + }, + "ServiceNamespace":{ + "shape":"serviceNamespaceType", + "documentation":"

The namespace of the service in which access was attempted.

To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

" + }, + "Region":{ + "shape":"stringType", + "documentation":"

The Region where the last service access attempt occurred.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

" + }, + "EntityPath":{ + "shape":"organizationsEntityPathType", + "documentation":"

The path of the Organizations entity (root, organizational unit, or account) from which an authenticated principal last attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals (IAM users, IAM roles, or root users) in the reported Organizations entity attempted to access the service within the reporting period.

" + }, + "LastAuthenticatedTime":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when an authenticated principal most recently attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no principals in the reported Organizations entity attempted to access the service within the reporting period.

" + }, + "TotalAuthenticatedEntities":{ + "shape":"integerType", + "documentation":"

The number of accounts with authenticated principals (root users, IAM users, and IAM roles) that attempted to access the service in the reporting period.

" + } + }, + "documentation":"

An object that contains details about when a principal in the reported AWS Organizations entity last attempted to access an AWS service. A principal can be an IAM user, an IAM role, or the AWS account root user within the reported Organizations entity.

This data type is a response element in the GetOrganizationsAccessReport operation.

" + }, + "AccessDetails":{ + "type":"list", + "member":{"shape":"AccessDetail"} + }, + "AccessKey":{ + "type":"structure", + "required":[ + "UserName", + "AccessKeyId", + "Status", + "SecretAccessKey" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user that the access key is associated with.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The ID for this access key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the access key. Active means that the key is valid for API calls, while Inactive means it is not.

" + }, + "SecretAccessKey":{ + "shape":"accessKeySecretType", + "documentation":"

The secret key used to sign requests.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the access key was created.

" + } + }, + "documentation":"

Contains information about an AWS access key.

This data type is used as a response element in the CreateAccessKey and ListAccessKeys operations.

The SecretAccessKey value is returned only in response to CreateAccessKey. You can get a secret access key only when you first create an access key; you cannot recover the secret access key later. If you lose a secret access key, you must create a new access key.

" + }, + "AccessKeyLastUsed":{ + "type":"structure", + "required":[ + "LastUsedDate", + "ServiceName", + "Region" + ], + "members":{ + "LastUsedDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

" + }, + "ServiceName":{ + "shape":"stringType", + "documentation":"

The name of the AWS service with which this access key was most recently used. The value of this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM started tracking this information.

  • There is no sign-in data associated with the user.

" + }, + "Region":{ + "shape":"stringType", + "documentation":"

The AWS Region where this access key was most recently used. The value for this field is \"N/A\" in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

For more information about AWS Regions, see Regions and Endpoints in the Amazon Web Services General Reference.

" + } + }, + "documentation":"

Contains information about the last time an AWS access key was used since IAM began tracking this information on April 22, 2015.

This data type is used as a response element in the GetAccessKeyLastUsed operation.

" + }, + "AccessKeyMetadata":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user that the key is associated with.

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The ID for this access key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the access key was created.

" + } + }, + "documentation":"

Contains information about an AWS access key, without its secret key.

This data type is used as a response element in the ListAccessKeys operation.

" + }, + "ActionNameListType":{ + "type":"list", + "member":{"shape":"ActionNameType"} + }, + "ActionNameType":{ + "type":"string", + "max":128, + "min":3 + }, + "AddClientIDToOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

" + }, + "ClientID":{ + "shape":"clientIDType", + "documentation":"

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

" + } + } + }, + "AddRoleToInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "AddUserToGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to add.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "ArnListType":{ + "type":"list", + "member":{"shape":"arnType"} + }, + "AttachGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyArn" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name (friendly name, not ARN) of the group to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "AttachRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyArn" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) of the role to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "AttachUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyArn" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM user to attach the policy to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "AttachedPermissionsBoundary":{ + "type":"structure", + "members":{ + "PermissionsBoundaryType":{ + "shape":"PermissionsBoundaryAttachmentType", + "documentation":"

The permissions boundary usage type that indicates what type of IAM resource is used as the permissions boundary for an entity. This data type can only have a value of Policy.

" + }, + "PermissionsBoundaryArn":{ + "shape":"arnType", + "documentation":"

The ARN of the policy used to set the permissions boundary for the user or role.

" + } + }, + "documentation":"

Contains information about an attached permissions boundary.

An attached permissions boundary is a managed policy that has been attached to a user or role to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "AttachedPolicy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The friendly name of the attached policy.

" + }, + "PolicyArn":{"shape":"arnType"} + }, + "documentation":"

Contains information about an attached policy.

An attached policy is a managed policy that has been attached to a user, group, or role. This data type is used as a response element in the ListAttachedGroupPolicies, ListAttachedRolePolicies, ListAttachedUserPolicies, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "BootstrapDatum":{ + "type":"blob", + "sensitive":true + }, + "ChangePasswordRequest":{ + "type":"structure", + "required":[ + "OldPassword", + "NewPassword" + ], + "members":{ + "OldPassword":{ + "shape":"passwordType", + "documentation":"

The IAM user's current password.

" + }, + "NewPassword":{ + "shape":"passwordType", + "documentation":"

The new password. The new password must conform to the AWS account's password policy, if one exists.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

" + } + } + }, + "ColumnNumber":{"type":"integer"}, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ConcurrentModificationMessage"} + }, + "documentation":"

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

", + "error":{ + "code":"ConcurrentModification", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ConcurrentModificationMessage":{"type":"string"}, + "ContextEntry":{ + "type":"structure", + "members":{ + "ContextKeyName":{ + "shape":"ContextKeyNameType", + "documentation":"

The full name of a condition context key, including the service prefix. For example, aws:SourceIp or s3:VersionId.

" + }, + "ContextKeyValues":{ + "shape":"ContextKeyValueListType", + "documentation":"

The value (or values, if the condition context key supports multiple values) to provide to the simulation when the key is referenced by a Condition element in an input policy.

" + }, + "ContextKeyType":{ + "shape":"ContextKeyTypeEnum", + "documentation":"

The data type of the value (or values) specified in the ContextKeyValues parameter.

" + } + }, + "documentation":"

Contains information about a condition context key. It includes the name of the key and specifies the value (or values, if the context key supports multiple values) to use in the simulation. This information is used when evaluating the Condition elements of the input policies.

This data type is used as an input parameter to SimulateCustomPolicy and SimulatePrincipalPolicy .

" + }, + "ContextEntryListType":{ + "type":"list", + "member":{"shape":"ContextEntry"} + }, + "ContextKeyNameType":{ + "type":"string", + "max":256, + "min":5 + }, + "ContextKeyNamesResultListType":{ + "type":"list", + "member":{"shape":"ContextKeyNameType"} + }, + "ContextKeyTypeEnum":{ + "type":"string", + "enum":[ + "string", + "stringList", + "numeric", + "numericList", + "boolean", + "booleanList", + "ip", + "ipList", + "binary", + "binaryList", + "date", + "dateList" + ] + }, + "ContextKeyValueListType":{ + "type":"list", + "member":{"shape":"ContextKeyValueType"} + }, + "ContextKeyValueType":{"type":"string"}, + "CreateAccessKeyRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user that the new key will belong to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "CreateAccessKeyResponse":{ + "type":"structure", + "required":["AccessKey"], + "members":{ + "AccessKey":{ + "shape":"AccessKey", + "documentation":"

A structure with details about the access key.

" + } + }, + "documentation":"

Contains the response to a successful CreateAccessKey request.

" + }, + "CreateAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{ + "shape":"accountAliasType", + "documentation":"

The account alias to create.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" + } + } + }, + "CreateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to create. Do not include the path in this value.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + } + } + }, + "CreateGroupResponse":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

A structure containing details about the new group.

" + } + }, + "documentation":"

Contains the response to a successful CreateGroup request.

" + }, + "CreateInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name of the instance profile to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Path":{ + "shape":"pathType", + "documentation":"

The path to the instance profile. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + } + } + }, + "CreateInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

A structure containing details about the new instance profile.

" + } + }, + "documentation":"

Contains the response to a successful CreateInstanceProfile request.

" + }, + "CreateLoginProfileRequest":{ + "type":"structure", + "required":[ + "UserName", + "Password" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user to create a password for. The user must already exist.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Password":{ + "shape":"passwordType", + "documentation":"

The new password for the user.

The regex pattern that is used to validate this parameter is a string of characters. That string can include almost any printable ASCII character from the space (\\u0020) through the end of the ASCII character range (\\u00FF). You can also include the tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D) characters. Any of these characters are valid in a password. However, many tools, such as the AWS Management Console, might restrict the ability to type certain characters because they have special meaning within that tool.

" + }, + "PasswordResetRequired":{ + "shape":"booleanType", + "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" + } + } + }, + "CreateLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{ + "shape":"LoginProfile", + "documentation":"

A structure containing the user name and password create date.

" + } + }, + "documentation":"

Contains the response to a successful CreateLoginProfile request.

" + }, + "CreateOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "Url", + "ThumbprintList" + ], + "members":{ + "Url":{ + "shape":"OpenIDConnectProviderUrlType", + "documentation":"

The URL of the identity provider. The URL must begin with https:// and should correspond to the iss claim in the provider's OpenID Connect ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like https://server.example.org or https://example.com.

You cannot register the same provider multiple times in a single AWS account. If you try to submit a URL that has already been used for an OpenID Connect provider in the AWS account, you will get an error.

" + }, + "ClientIDList":{ + "shape":"clientIDListType", + "documentation":"

A list of client IDs (also known as audiences). When a mobile or web app registers with an OpenID Connect provider, they establish a value that identifies the application. (This is the value that's sent as the client_id parameter on OAuth requests.)

You can register multiple client IDs with the same provider. For example, you might have multiple applications that use the same OIDC provider. You cannot register more than 100 client IDs with a single IAM OIDC provider.

There is no defined format for a client ID. The CreateOpenIDConnectProviderRequest operation accepts client IDs up to 255 characters long.

" + }, + "ThumbprintList":{ + "shape":"thumbprintListType", + "documentation":"

A list of server certificate thumbprints for the OpenID Connect (OIDC) identity provider's server certificates. Typically this list includes only one entry. However, IAM lets you have up to five thumbprints for an OIDC provider. This lets you maintain multiple thumbprints if the identity provider is rotating certificates.

The server certificate thumbprint is the hex-encoded SHA-1 hash value of the X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

You must provide at least one thumbprint when creating an IAM OIDC provider. For example, assume that the OIDC provider is server.example.com and the provider stores its keys at https://keys.server.example.com/openid-connect. In that case, the thumbprint string would be the hex-encoded SHA-1 hash value of the certificate used by https://keys.server.example.com.

For more information about obtaining the OIDC provider's thumbprint, see Obtaining the Thumbprint for an OpenID Connect Provider in the IAM User Guide.

" + } + } + }, + "CreateOpenIDConnectProviderResponse":{ + "type":"structure", + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

" + } + }, + "documentation":"

Contains the response to a successful CreateOpenIDConnectProvider request.

" + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "PolicyName", + "PolicyDocument" + ], + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The friendly name of the policy.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + }, + "Path":{ + "shape":"policyPathType", + "documentation":"

The path for the policy.

For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The JSON policy document that you want to use as the content for the new policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "Description":{ + "shape":"policyDescriptionType", + "documentation":"

A friendly description of the policy.

Typically used to store information about the permissions defined in the policy. For example, \"Grants access to production DynamoDB tables.\"

The policy description is immutable. After a value is assigned, it cannot be changed.

" + } + } + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

A structure containing details about the new policy.

" + } + }, + "documentation":"

Contains the response to a successful CreatePolicy request.

" + }, + "CreatePolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "PolicyDocument" + ], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The JSON policy document that you want to use as the content for this new version of the policy.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "SetAsDefault":{ + "shape":"booleanType", + "documentation":"

Specifies whether to set this version as the policy's default version.

When this parameter is true, the new policy version becomes the operative version. That is, it becomes the version that is in effect for the IAM users, groups, and roles that the policy is attached to.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + } + } + }, + "CreatePolicyVersionResponse":{ + "type":"structure", + "members":{ + "PolicyVersion":{ + "shape":"PolicyVersion", + "documentation":"

A structure containing details about the new policy version.

" + } + }, + "documentation":"

Contains the response to a successful CreatePolicyVersion request.

" + }, + "CreateRoleRequest":{ + "type":"structure", + "required":[ + "RoleName", + "AssumeRolePolicyDocument" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + }, + "AssumeRolePolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The trust relationship policy document that grants an entity permission to assume the role.

In IAM, you must provide a JSON policy that has been converted to a string. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

Upon success, the response includes the same trust policy in JSON format.

" + }, + "Description":{ + "shape":"roleDescriptionType", + "documentation":"

A description of the role.

" + }, + "MaxSessionDuration":{ + "shape":"roleMaxSessionDurationType", + "documentation":"

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

" + }, + "PermissionsBoundary":{ + "shape":"arnType", + "documentation":"

The ARN of the policy that is used to set the permissions boundary for the role.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that you want to attach to the newly created role. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per role, then the entire request fails and the role is not created.

" + } + } + }, + "CreateRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

A structure containing details about the new role.

" + } + }, + "documentation":"

Contains the response to a successful CreateRole request.

" + }, + "CreateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "Name" + ], + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

For more information, see About SAML 2.0-based Federation in the IAM User Guide

" + }, + "Name":{ + "shape":"SAMLProviderNameType", + "documentation":"

The name of the provider to create.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "CreateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

" + } + }, + "documentation":"

Contains the response to a successful CreateSAMLProvider request.

" + }, + "CreateServiceLinkedRoleRequest":{ + "type":"structure", + "required":["AWSServiceName"], + "members":{ + "AWSServiceName":{ + "shape":"groupNameType", + "documentation":"

The service principal for the AWS service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: elasticbeanstalk.amazonaws.com.

Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see AWS Services That Work with IAM in the IAM User Guide. Look for the services that have Yes in the Service-Linked Role column. Choose the Yes link to view the service-linked role documentation for that service.

" + }, + "Description":{ + "shape":"roleDescriptionType", + "documentation":"

The description of the role.

" + }, + "CustomSuffix":{ + "shape":"customSuffixType", + "documentation":"

A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different CustomSuffix for each request. Otherwise the request fails with a duplicate role name error. For example, you could add -1 or -debug to the suffix.

Some services do not support the CustomSuffix parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

" + } + } + }, + "CreateServiceLinkedRoleResponse":{ + "type":"structure", + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

A Role object that contains details about the newly created role.

" + } + } + }, + "CreateServiceSpecificCredentialRequest":{ + "type":"structure", + "required":[ + "UserName", + "ServiceName" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user that is to be associated with the credentials. The new service-specific credentials have the same permissions as the associated user except that they can be used only to access the specified service.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "ServiceName":{ + "shape":"serviceName", + "documentation":"

The name of the AWS service that is to be associated with the credentials. The service you specify here is the only service that can be accessed using these credentials.

" + } + } + }, + "CreateServiceSpecificCredentialResponse":{ + "type":"structure", + "members":{ + "ServiceSpecificCredential":{ + "shape":"ServiceSpecificCredential", + "documentation":"

A structure that contains information about the newly created service-specific credential.

This is the only time that the password for this credential set is available. It cannot be recovered later. Instead, you must reset the password with ResetServiceSpecificCredential.

" + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the user name. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user to create.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + }, + "PermissionsBoundary":{ + "shape":"arnType", + "documentation":"

The ARN of the policy that is used to set the permissions boundary for the user.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that you want to attach to the newly created user. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

If any one of the tags is invalid or if you exceed the allowed number of tags per user, then the entire request fails and the user is not created.

" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

A structure with details about the new IAM user.

" + } + }, + "documentation":"

Contains the response to a successful CreateUser request.

" + }, + "CreateVirtualMFADeviceRequest":{ + "type":"structure", + "required":["VirtualMFADeviceName"], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "VirtualMFADeviceName":{ + "shape":"virtualMFADeviceName", + "documentation":"

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "CreateVirtualMFADeviceResponse":{ + "type":"structure", + "required":["VirtualMFADevice"], + "members":{ + "VirtualMFADevice":{ + "shape":"VirtualMFADevice", + "documentation":"

A structure containing details about the new virtual MFA device.

" + } + }, + "documentation":"

Contains the response to a successful CreateVirtualMFADevice request.

" + }, + "CredentialReportExpiredException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportExpiredExceptionMessage"} + }, + "documentation":"

The request was rejected because the most recent credential report has expired. To generate a new credential report, use GenerateCredentialReport. For more information about credential report expiration, see Getting Credential Reports in the IAM User Guide.

", + "error":{ + "code":"ReportExpired", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true + }, + "CredentialReportNotPresentException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotPresentExceptionMessage"} + }, + "documentation":"

The request was rejected because the credential report does not exist. To generate a credential report, use GenerateCredentialReport.

", + "error":{ + "code":"ReportNotPresent", + "httpStatusCode":410, + "senderFault":true + }, + "exception":true + }, + "CredentialReportNotReadyException":{ + "type":"structure", + "members":{ + "message":{"shape":"credentialReportNotReadyExceptionMessage"} + }, + "documentation":"

The request was rejected because the credential report is still being generated.

", + "error":{ + "code":"ReportInProgress", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DeactivateMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user whose MFA device you want to deactivate.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" + } + } + }, + "DeleteAccessKeyRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user whose access key pair you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The access key ID for the access key ID and secret access key you want to delete.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + } + } + }, + "DeleteAccountAliasRequest":{ + "type":"structure", + "required":["AccountAlias"], + "members":{ + "AccountAlias":{ + "shape":"accountAliasType", + "documentation":"

The name of the account alias to delete.

This parameter allows (through its regex pattern) a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

" + } + } + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"deleteConflictMessage"} + }, + "documentation":"

The request was rejected because it attempted to delete a resource that has attached subordinate entities. The error message describes these entities.

", + "error":{ + "code":"DeleteConflict", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "DeleteGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name (friendly name, not ARN) identifying the group that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the IAM group to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name of the instance profile to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user whose password you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteOpenIDConnectProviderRequest":{ + "type":"structure", + "required":["OpenIDConnectProviderArn"], + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders operation.

" + } + } + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "DeletePolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "VersionId":{ + "shape":"policyVersionIdType", + "documentation":"

The policy version to delete.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + } + } + }, + "DeleteRolePermissionsBoundaryRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM role from which you want to remove the permissions boundary.

" + } + } + }, + "DeleteRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the inline policy to delete from the specified IAM role.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to delete.

" + } + } + }, + "DeleteSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SSHPublicKeyId":{ + "shape":"publicKeyIdType", + "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + } + } + }, + "DeleteServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteServiceLinkedRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the service-linked role to be deleted.

" + } + } + }, + "DeleteServiceLinkedRoleResponse":{ + "type":"structure", + "required":["DeletionTaskId"], + "members":{ + "DeletionTaskId":{ + "shape":"DeletionTaskIdType", + "documentation":"

The deletion task identifier that you can use to check the status of the deletion. This identifier is returned in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

" + } + } + }, + "DeleteServiceSpecificCredentialRequest":{ + "type":"structure", + "required":["ServiceSpecificCredentialId"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "ServiceSpecificCredentialId":{ + "shape":"serviceSpecificCredentialId", + "documentation":"

The unique identifier of the service-specific credential. You can get this value by calling ListServiceSpecificCredentials.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + } + } + }, + "DeleteSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateId"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

" + } + } + }, + "DeleteUserPermissionsBoundaryRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM user from which you want to remove the permissions boundary.

" + } + } + }, + "DeleteUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name identifying the policy document to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "DeleteVirtualMFADeviceRequest":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the same as the ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" + } + } + }, + "DeletionTaskFailureReasonType":{ + "type":"structure", + "members":{ + "Reason":{ + "shape":"ReasonType", + "documentation":"

A short description of the reason that the service-linked role deletion failed.

" + }, + "RoleUsageList":{ + "shape":"RoleUsageListType", + "documentation":"

A list of objects that contains details about the service-linked role deletion failure, if that information is returned by the service. If the service-linked role has active sessions or if any resources that were used by the role have not been deleted from the linked service, the role can't be deleted. This parameter includes a list of the resources that are associated with the role and the Region in which the resources are being used.

" + } + }, + "documentation":"

The reason that the service-linked role deletion failed.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" + }, + "DeletionTaskIdType":{ + "type":"string", + "max":1000, + "min":1 + }, + "DeletionTaskStatusType":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "IN_PROGRESS", + "FAILED", + "NOT_STARTED" + ] + }, + "DetachGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyArn" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM group to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "DetachRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyArn" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM role to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "DetachUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyArn" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM user to detach the policy from.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "DuplicateCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"duplicateCertificateMessage"} + }, + "documentation":"

The request was rejected because the same certificate is associated with an IAM user in the account.

", + "error":{ + "code":"DuplicateCertificate", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "DuplicateSSHPublicKeyException":{ + "type":"structure", + "members":{ + "message":{"shape":"duplicateSSHPublicKeyMessage"} + }, + "documentation":"

The request was rejected because the SSH public key is already associated with the specified IAM user.

", + "error":{ + "code":"DuplicateSSHPublicKey", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EnableMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user for whom you want to enable the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@:/-

" + }, + "AuthenticationCode1":{ + "shape":"authenticationCodeType", + "documentation":"

An authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

" + }, + "AuthenticationCode2":{ + "shape":"authenticationCodeType", + "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a string of six digits.

Submit your request immediately after generating the authentication codes. If you generate the codes and then wait too long to submit the request, the MFA device successfully associates with the user but the MFA device becomes out of sync. This happens because time-based one-time passwords (TOTP) expire after a short period of time. If this happens, you can resync the device.

" + } + } + }, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityAlreadyExistsMessage"} + }, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

", + "error":{ + "code":"EntityAlreadyExists", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "EntityDetails":{ + "type":"structure", + "required":["EntityInfo"], + "members":{ + "EntityInfo":{ + "shape":"EntityInfo", + "documentation":"

The EntityInfo object that contains details about the entity (user or role).

" + }, + "LastAuthenticated":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the authenticated entity last attempted to access AWS. AWS does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

" + } + }, + "documentation":"

An object that contains details about when the IAM entities (users or roles) were last used in an attempt to access the specified AWS service.

This data type is a response element in the GetServiceLastAccessedDetailsWithEntities operation.

" + }, + "EntityInfo":{ + "type":"structure", + "required":[ + "Arn", + "Name", + "Type", + "Id" + ], + "members":{ + "Arn":{"shape":"arnType"}, + "Name":{ + "shape":"userNameType", + "documentation":"

The name of the entity (user or role).

" + }, + "Type":{ + "shape":"policyOwnerEntityType", + "documentation":"

The type of entity (user or role).

" + }, + "Id":{ + "shape":"idType", + "documentation":"

The identifier of the entity (user or role).

" + }, + "Path":{ + "shape":"pathType", + "documentation":"

The path to the entity (user or role). For more information about paths, see IAM Identifiers in the Using IAM guide.

" + } + }, + "documentation":"

Contains details about the specified entity (user or role).

This data type is an element of the EntityDetails object.

" + }, + "EntityTemporarilyUnmodifiableException":{ + "type":"structure", + "members":{ + "message":{"shape":"entityTemporarilyUnmodifiableMessage"} + }, + "documentation":"

The request was rejected because it referenced an entity that is temporarily unmodifiable, such as a user name that was deleted and then recreated. The error indicates that the request is likely to succeed if you try again after waiting several minutes. The error message describes the entity.

", + "error":{ + "code":"EntityTemporarilyUnmodifiable", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "EntityType":{ + "type":"string", + "enum":[ + "User", + "Role", + "Group", + "LocalManagedPolicy", + "AWSManagedPolicy" + ] + }, + "ErrorDetails":{ + "type":"structure", + "required":[ + "Message", + "Code" + ], + "members":{ + "Message":{ + "shape":"stringType", + "documentation":"

Detailed information about the reason that the operation failed.

" + }, + "Code":{ + "shape":"stringType", + "documentation":"

The error code associated with the operation failure.

" + } + }, + "documentation":"

Contains information about the reason that the operation failed.

This data type is used as a response element in the GetOrganizationsAccessReport, GetServiceLastAccessedDetails, and GetServiceLastAccessedDetailsWithEntities operations.

" + }, + "EvalDecisionDetailsType":{ + "type":"map", + "key":{"shape":"EvalDecisionSourceType"}, + "value":{"shape":"PolicyEvaluationDecisionType"} + }, + "EvalDecisionSourceType":{ + "type":"string", + "max":256, + "min":3 + }, + "EvaluationResult":{ + "type":"structure", + "required":[ + "EvalActionName", + "EvalDecision" + ], + "members":{ + "EvalActionName":{ + "shape":"ActionNameType", + "documentation":"

The name of the API operation tested on the indicated resource.

" + }, + "EvalResourceName":{ + "shape":"ResourceNameType", + "documentation":"

The ARN of the resource that the indicated API operation was tested on.

" + }, + "EvalDecision":{ + "shape":"PolicyEvaluationDecisionType", + "documentation":"

The result of the simulation.

" + }, + "MatchedStatements":{ + "shape":"StatementListType", + "documentation":"

A list of the statements in the input policies that determine the result for this scenario. Remember that even if multiple statements allow the operation on the resource, if only one statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

" + }, + "MissingContextValues":{ + "shape":"ContextKeyNamesResultListType", + "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when the resource in a simulation is \"*\", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" + }, + "OrganizationsDecisionDetail":{ + "shape":"OrganizationsDecisionDetail", + "documentation":"

A structure that details how Organizations and its service control policies affect the results of the simulation. Only applies if the simulated user's account is part of an organization.

" + }, + "EvalDecisionDetails":{ + "shape":"EvalDecisionDetailsType", + "documentation":"

Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access. See How IAM Roles Differ from Resource-based Policies

" + }, + "ResourceSpecificResults":{ + "shape":"ResourceSpecificResultListType", + "documentation":"

The individual results of the simulation of the API operation specified in EvalActionName on each resource.

" + } + }, + "documentation":"

Contains the results of a simulation.

This data type is used by the return parameter of SimulateCustomPolicy and SimulatePrincipalPolicy .

" + }, + "EvaluationResultsListType":{ + "type":"list", + "member":{"shape":"EvaluationResult"} + }, + "GenerateCredentialReportResponse":{ + "type":"structure", + "members":{ + "State":{ + "shape":"ReportStateType", + "documentation":"

Information about the state of the credential report.

" + }, + "Description":{ + "shape":"ReportStateDescriptionType", + "documentation":"

Information about the credential report.

" + } + }, + "documentation":"

Contains the response to a successful GenerateCredentialReport request.

" + }, + "GenerateOrganizationsAccessReportRequest":{ + "type":"structure", + "required":["EntityPath"], + "members":{ + "EntityPath":{ + "shape":"organizationsEntityPathType", + "documentation":"

The path of the AWS Organizations entity (root, OU, or account). You can build an entity path using the known structure of your organization. For example, assume that your account ID is 123456789012 and its parent OU ID is ou-rge0-awsabcde. The organization root ID is r-f6g7h8i9j0example and your organization ID is o-a1b2c3d4e5. Your entity path is o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-rge0-awsabcde/123456789012.

" + }, + "OrganizationsPolicyId":{ + "shape":"organizationsPolicyIdType", + "documentation":"

The identifier of the AWS Organizations service control policy (SCP). This parameter is optional.

This ID is used to generate information about when an account principal that is limited by the SCP attempted to access an AWS service.

" + } + } + }, + "GenerateOrganizationsAccessReportResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"jobIDType", + "documentation":"

The job identifier that you can use in the GetOrganizationsAccessReport operation.

" + } + } + }, + "GenerateServiceLastAccessedDetailsRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"arnType", + "documentation":"

The ARN of the IAM resource (user, group, role, or managed policy) used to generate information about when the resource was last used in an attempt to access an AWS service.

" + } + } + }, + "GenerateServiceLastAccessedDetailsResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"jobIDType", + "documentation":"

The job ID that you can use in the GetServiceLastAccessedDetails or GetServiceLastAccessedDetailsWithEntities operations.

" + } + } + }, + "GetAccessKeyLastUsedRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The identifier of an access key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + } + } + }, + "GetAccessKeyLastUsedResponse":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the AWS IAM user that owns this access key.

" + }, + "AccessKeyLastUsed":{ + "shape":"AccessKeyLastUsed", + "documentation":"

Contains information about the last time the access key was used.

" + } + }, + "documentation":"

Contains the response to a successful GetAccessKeyLastUsed request. It is also returned as a member of the AccessKeyMetaData structure returned by the ListAccessKeys action.

" + }, + "GetAccountAuthorizationDetailsRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"entityListType", + "documentation":"

A list of entity types used to filter the results. Only the entities that match the types you specify are included in the output. Use the value LocalManagedPolicy to include customer managed policies.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + } + } + }, + "GetAccountAuthorizationDetailsResponse":{ + "type":"structure", + "members":{ + "UserDetailList":{ + "shape":"userDetailListType", + "documentation":"

A list containing information about IAM users.

" + }, + "GroupDetailList":{ + "shape":"groupDetailListType", + "documentation":"

A list containing information about IAM groups.

" + }, + "RoleDetailList":{ + "shape":"roleDetailListType", + "documentation":"

A list containing information about IAM roles.

" + }, + "Policies":{ + "shape":"ManagedPolicyDetailListType", + "documentation":"

A list containing information about managed policies.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful GetAccountAuthorizationDetails request.

" + }, + "GetAccountPasswordPolicyResponse":{ + "type":"structure", + "required":["PasswordPolicy"], + "members":{ + "PasswordPolicy":{ + "shape":"PasswordPolicy", + "documentation":"

A structure that contains details about the account's password policy.

" + } + }, + "documentation":"

Contains the response to a successful GetAccountPasswordPolicy request.

" + }, + "GetAccountSummaryResponse":{ + "type":"structure", + "members":{ + "SummaryMap":{ + "shape":"summaryMapType", + "documentation":"

A set of key–value pairs containing information about IAM entity usage and IAM quotas.

" + } + }, + "documentation":"

Contains the response to a successful GetAccountSummary request.

" + }, + "GetContextKeysForCustomPolicyRequest":{ + "type":"structure", + "required":["PolicyInputList"], + "members":{ + "PolicyInputList":{ + "shape":"SimulationPolicyListType", + "documentation":"

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "GetContextKeysForPolicyResponse":{ + "type":"structure", + "members":{ + "ContextKeyNames":{ + "shape":"ContextKeyNamesResultListType", + "documentation":"

The list of context keys that are referenced in the input policies.

" + } + }, + "documentation":"

Contains the response to a successful GetContextKeysForPrincipalPolicy or GetContextKeysForCustomPolicy request.

" + }, + "GetContextKeysForPrincipalPolicyRequest":{ + "type":"structure", + "required":["PolicySourceArn"], + "members":{ + "PolicySourceArn":{ + "shape":"arnType", + "documentation":"

The ARN of a user, group, or role whose policies contain the context keys that you want listed. If you specify a user, the list includes context keys that are found in all policies that are attached to the user. The list also includes all groups that the user is a member of. If you pick a group or a role, then it includes only those context keys that are found in policies attached to that entity. Note that all parameters are shown in unencoded form here for clarity, but must be URL encoded to be included as a part of a real HTML request.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "PolicyInputList":{ + "shape":"SimulationPolicyListType", + "documentation":"

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "GetCredentialReportResponse":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"ReportContentType", + "documentation":"

Contains the credential report. The report is Base64-encoded.

" + }, + "ReportFormat":{ + "shape":"ReportFormatType", + "documentation":"

The format (MIME type) of the credential report.

" + }, + "GeneratedTime":{ + "shape":"dateType", + "documentation":"

The date and time when the credential report was created, in ISO 8601 date-time format.

" + } + }, + "documentation":"

Contains the response to a successful GetCredentialReport request.

" + }, + "GetGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetGroupPolicyResponse":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The group the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" + } + }, + "documentation":"

Contains the response to a successful GetGroupPolicy request.

" + }, + "GetGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "GetGroupResponse":{ + "type":"structure", + "required":[ + "Group", + "Users" + ], + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

A structure that contains details about the group.

" + }, + "Users":{ + "shape":"userListType", + "documentation":"

A list of users in the group.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful GetGroup request.

" + }, + "GetInstanceProfileRequest":{ + "type":"structure", + "required":["InstanceProfileName"], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name of the instance profile to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetInstanceProfileResponse":{ + "type":"structure", + "required":["InstanceProfile"], + "members":{ + "InstanceProfile":{ + "shape":"InstanceProfile", + "documentation":"

A structure containing details about the instance profile.

" + } + }, + "documentation":"

Contains the response to a successful GetInstanceProfile request.

" + }, + "GetLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user whose login profile you want to retrieve.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetLoginProfileResponse":{ + "type":"structure", + "required":["LoginProfile"], + "members":{ + "LoginProfile":{ + "shape":"LoginProfile", + "documentation":"

A structure containing the user name and password create date for the user.

" + } + }, + "documentation":"

Contains the response to a successful GetLoginProfile request.

" + }, + "GetOpenIDConnectProviderRequest":{ + "type":"structure", + "required":["OpenIDConnectProviderArn"], + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "GetOpenIDConnectProviderResponse":{ + "type":"structure", + "members":{ + "Url":{ + "shape":"OpenIDConnectProviderUrlType", + "documentation":"

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

" + }, + "ClientIDList":{ + "shape":"clientIDListType", + "documentation":"

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" + }, + "ThumbprintList":{ + "shape":"thumbprintListType", + "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time when the IAM OIDC provider resource object was created in the AWS account.

" + } + }, + "documentation":"

Contains the response to a successful GetOpenIDConnectProvider request.

" + }, + "GetOrganizationsAccessReportRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"jobIDType", + "documentation":"

The identifier of the request generated by the GenerateOrganizationsAccessReport operation.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "SortKey":{ + "shape":"sortKeyType", + "documentation":"

The key that is used to sort the results. If you choose the namespace key, the results are returned in alphabetical order. If you choose the time key, the results are sorted numerically by the date and time.

" + } + } + }, + "GetOrganizationsAccessReportResponse":{ + "type":"structure", + "required":[ + "JobStatus", + "JobCreationDate" + ], + "members":{ + "JobStatus":{ + "shape":"jobStatusType", + "documentation":"

The status of the job.

" + }, + "JobCreationDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" + }, + "JobCompletionDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" + }, + "NumberOfServicesAccessible":{ + "shape":"integerType", + "documentation":"

The number of services that the applicable SCPs allow account principals to access.

" + }, + "NumberOfServicesNotAccessed":{ + "shape":"integerType", + "documentation":"

The number of services that account principals are allowed but did not attempt to access.

" + }, + "AccessDetails":{ + "shape":"AccessDetails", + "documentation":"

An object that contains details about the most recent attempt to access the service.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + }, + "ErrorDetails":{"shape":"ErrorDetails"} + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

A structure containing details about the policy.

" + } + }, + "documentation":"

Contains the response to a successful GetPolicy request.

" + }, + "GetPolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "VersionId":{ + "shape":"policyVersionIdType", + "documentation":"

Identifies the policy version to retrieve.

This parameter allows (through its regex pattern) a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

" + } + } + }, + "GetPolicyVersionResponse":{ + "type":"structure", + "members":{ + "PolicyVersion":{ + "shape":"PolicyVersion", + "documentation":"

A structure containing details about the policy version.

" + } + }, + "documentation":"

Contains the response to a successful GetPolicyVersion request.

" + }, + "GetRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role associated with the policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetRolePolicyResponse":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The role the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" + } + }, + "documentation":"

Contains the response to a successful GetRolePolicy request.

" + }, + "GetRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the IAM role to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetRoleResponse":{ + "type":"structure", + "required":["Role"], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

A structure containing details about the IAM role.

" + } + }, + "documentation":"

Contains the response to a successful GetRole request.

" + }, + "GetSAMLProviderRequest":{ + "type":"structure", + "required":["SAMLProviderArn"], + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "GetSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

The XML metadata document that includes information about an identity provider.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time when the SAML provider was created.

" + }, + "ValidUntil":{ + "shape":"dateType", + "documentation":"

The expiration date and time for the SAML provider.

" + } + }, + "documentation":"

Contains the response to a successful GetSAMLProvider request.

" + }, + "GetSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Encoding" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SSHPublicKeyId":{ + "shape":"publicKeyIdType", + "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + }, + "Encoding":{ + "shape":"encodingType", + "documentation":"

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

" + } + } + }, + "GetSSHPublicKeyResponse":{ + "type":"structure", + "members":{ + "SSHPublicKey":{ + "shape":"SSHPublicKey", + "documentation":"

A structure containing details about the SSH public key.

" + } + }, + "documentation":"

Contains the response to a successful GetSSHPublicKey request.

" + }, + "GetServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate you want to retrieve information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetServerCertificateResponse":{ + "type":"structure", + "required":["ServerCertificate"], + "members":{ + "ServerCertificate":{ + "shape":"ServerCertificate", + "documentation":"

A structure containing details about the server certificate.

" + } + }, + "documentation":"

Contains the response to a successful GetServerCertificate request.

" + }, + "GetServiceLastAccessedDetailsRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"jobIDType", + "documentation":"

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + } + } + }, + "GetServiceLastAccessedDetailsResponse":{ + "type":"structure", + "required":[ + "JobStatus", + "JobCreationDate", + "ServicesLastAccessed", + "JobCompletionDate" + ], + "members":{ + "JobStatus":{ + "shape":"jobStatusType", + "documentation":"

The status of the job.

" + }, + "JobCreationDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" + }, + "ServicesLastAccessed":{ + "shape":"ServicesLastAccessed", + "documentation":"

A ServiceLastAccessed object that contains details about the most recent attempt to access the service.

" + }, + "JobCompletionDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + }, + "Error":{ + "shape":"ErrorDetails", + "documentation":"

An object that contains details about the reason the operation failed.

" + } + } + }, + "GetServiceLastAccessedDetailsWithEntitiesRequest":{ + "type":"structure", + "required":[ + "JobId", + "ServiceNamespace" + ], + "members":{ + "JobId":{ + "shape":"jobIDType", + "documentation":"

The ID of the request generated by the GenerateServiceLastAccessedDetails operation.

" + }, + "ServiceNamespace":{ + "shape":"serviceNamespaceType", + "documentation":"

The service namespace for an AWS service. Provide the service namespace to learn when the IAM entity last attempted to access the specified service.

To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + } + } + }, + "GetServiceLastAccessedDetailsWithEntitiesResponse":{ + "type":"structure", + "required":[ + "JobStatus", + "JobCreationDate", + "JobCompletionDate", + "EntityDetailsList" + ], + "members":{ + "JobStatus":{ + "shape":"jobStatusType", + "documentation":"

The status of the job.

" + }, + "JobCreationDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the report job was created.

" + }, + "JobCompletionDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the generated report job was completed or failed.

This field is null if the job is still in progress, as indicated by a job status value of IN_PROGRESS.

" + }, + "EntityDetailsList":{ + "shape":"entityDetailsListType", + "documentation":"

An EntityDetailsList object that contains details about when an IAM entity (user or role) used group or policy permissions in an attempt to access the specified AWS service.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + }, + "Error":{ + "shape":"ErrorDetails", + "documentation":"

An object that contains details about the reason the operation failed.

" + } + } + }, + "GetServiceLinkedRoleDeletionStatusRequest":{ + "type":"structure", + "required":["DeletionTaskId"], + "members":{ + "DeletionTaskId":{ + "shape":"DeletionTaskIdType", + "documentation":"

The deletion task identifier. This identifier is returned by the DeleteServiceLinkedRole operation in the format task/aws-service-role/<service-principal-name>/<role-name>/<task-uuid>.

" + } + } + }, + "GetServiceLinkedRoleDeletionStatusResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"DeletionTaskStatusType", + "documentation":"

The status of the deletion.

" + }, + "Reason":{ + "shape":"DeletionTaskFailureReasonType", + "documentation":"

An object that contains details about the reason the deletion failed.

" + } + } + }, + "GetUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user who the policy is associated with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document to get.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetUserPolicyResponse":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The user the policy is associated with.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

IAM stores policies in JSON format. However, resources that were created using AWS CloudFormation templates can be formatted in YAML. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

" + } + }, + "documentation":"

Contains the response to a successful GetUserPolicy request.

" + }, + "GetUserRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to get information about.

This parameter is optional. If it is not included, it defaults to the user making the request. This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "GetUserResponse":{ + "type":"structure", + "required":["User"], + "members":{ + "User":{ + "shape":"User", + "documentation":"

A structure containing details about the IAM user.

Due to a service issue, password last used data does not include password use from May 3, 2018 22:50 PDT to May 23, 2018 14:08 PDT. This affects last sign-in dates shown in the IAM console and password last used dates in the IAM credential report, and returned by this GetUser API. If users signed in during the affected time, the password last used date that is returned is the date the user last signed in before May 3, 2018. For users that signed in after May 23, 2018 14:08 PDT, the returned password last used date is accurate.

You can use password last used information to identify unused credentials for deletion. For example, you might delete users who did not sign in to AWS in the last 90 days. In cases like this, we recommend that you adjust your evaluation window to include dates after May 23, 2018. Alternatively, if your users use access keys to access AWS programmatically you can refer to access key last used information because it is accurate for all dates.

" + } + }, + "documentation":"

Contains the response to a successful GetUser request.

" + }, + "Group":{ + "type":"structure", + "required":[ + "Path", + "GroupName", + "GroupId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The friendly name that identifies the group.

" + }, + "GroupId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the group. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" + } + }, + "documentation":"

Contains information about an IAM group entity.

This data type is used as a response element in the following operations:

" + }, + "GroupDetail":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The friendly name that identifies the group.

" + }, + "GroupId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{"shape":"arnType"}, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the group was created.

" + }, + "GroupPolicyList":{ + "shape":"policyDetailListType", + "documentation":"

A list of the inline policies embedded in the group.

" + }, + "AttachedManagedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of the managed policies attached to the group.

" + } + }, + "documentation":"

Contains information about an IAM group, including all of the group's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + }, + "InstanceProfile":{ + "type":"structure", + "required":[ + "Path", + "InstanceProfileName", + "InstanceProfileId", + "Arn", + "CreateDate", + "Roles" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name identifying the instance profile.

" + }, + "InstanceProfileId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the instance profile. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the instance profile. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the instance profile was created.

" + }, + "Roles":{ + "shape":"roleListType", + "documentation":"

The role associated with the instance profile.

" + } + }, + "documentation":"

Contains information about an instance profile.

This data type is used as a response element in the following operations:

" + }, + "InvalidAuthenticationCodeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidAuthenticationCodeMessage"} + }, + "documentation":"

The request was rejected because the authentication code was not recognized. The error message describes the specific error.

", + "error":{ + "code":"InvalidAuthenticationCode", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InvalidCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidCertificateMessage"} + }, + "documentation":"

The request was rejected because the certificate is invalid.

", + "error":{ + "code":"InvalidCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidInputMessage"} + }, + "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", + "error":{ + "code":"InvalidInput", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidPublicKeyException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidPublicKeyMessage"} + }, + "documentation":"

The request was rejected because the public key is malformed or otherwise invalid.

", + "error":{ + "code":"InvalidPublicKey", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidUserTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidUserTypeMessage"} + }, + "documentation":"

The request was rejected because the type of user for the transaction was incorrect.

", + "error":{ + "code":"InvalidUserType", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyPairMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"keyPairMismatchMessage"} + }, + "documentation":"

The request was rejected because the public key certificate and the private key do not match.

", + "error":{ + "code":"KeyPairMismatch", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"limitExceededMessage"} + }, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "LineNumber":{"type":"integer"}, + "ListAccessKeysRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListAccessKeysResponse":{ + "type":"structure", + "required":["AccessKeyMetadata"], + "members":{ + "AccessKeyMetadata":{ + "shape":"accessKeyMetadataListType", + "documentation":"

A list of objects containing metadata about the access keys.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListAccessKeys request.

" + }, + "ListAccountAliasesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListAccountAliasesResponse":{ + "type":"structure", + "required":["AccountAliases"], + "members":{ + "AccountAliases":{ + "shape":"accountAliasListType", + "documentation":"

A list of aliases associated with the account. AWS supports only one alias per account.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListAccountAliases request.

" + }, + "ListAttachedGroupPoliciesRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name (friendly name, not ARN) of the group to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PathPrefix":{ + "shape":"policyPathType", + "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListAttachedGroupPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of the attached policies.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListAttachedGroupPolicies request.

" + }, + "ListAttachedRolePoliciesRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) of the role to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PathPrefix":{ + "shape":"policyPathType", + "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListAttachedRolePoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of the attached policies.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListAttachedRolePolicies request.

" + }, + "ListAttachedUserPoliciesRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) of the user to list attached policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PathPrefix":{ + "shape":"policyPathType", + "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListAttachedUserPoliciesResponse":{ + "type":"structure", + "members":{ + "AttachedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of the attached policies.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListAttachedUserPolicies request.

" + }, + "ListEntitiesForPolicyRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "EntityFilter":{ + "shape":"EntityType", + "documentation":"

The entity type to use for filtering the results.

For example, when EntityFilter is Role, only the roles that are attached to the specified policy are returned. This parameter is optional. If it is not included, all attached entities (users, groups, and roles) are returned. The argument for this parameter must be one of the valid values listed below.

" + }, + "PathPrefix":{ + "shape":"pathType", + "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all entities.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "PolicyUsageFilter":{ + "shape":"PolicyUsageType", + "documentation":"

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListEntitiesForPolicyResponse":{ + "type":"structure", + "members":{ + "PolicyGroups":{ + "shape":"PolicyGroupListType", + "documentation":"

A list of IAM groups that the policy is attached to.

" + }, + "PolicyUsers":{ + "shape":"PolicyUserListType", + "documentation":"

A list of IAM users that the policy is attached to.

" + }, + "PolicyRoles":{ + "shape":"PolicyRoleListType", + "documentation":"

A list of IAM roles that the policy is attached to.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListEntitiesForPolicy request.

" + }, + "ListGroupPoliciesRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListGroupPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListGroupPolicies request.

" + }, + "ListGroupsForUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to list groups for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListGroupsForUserResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{ + "shape":"groupListType", + "documentation":"

A list of groups.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListGroupsForUser request.

" + }, + "ListGroupsRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all groups whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all groups. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "required":["Groups"], + "members":{ + "Groups":{ + "shape":"groupListType", + "documentation":"

A list of groups.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListGroups request.

" + }, + "ListInstanceProfilesForRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to list instance profiles for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListInstanceProfilesForRoleResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{ + "shape":"instanceProfileListType", + "documentation":"

A list of instance profiles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListInstanceProfilesForRole request.

" + }, + "ListInstanceProfilesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all instance profiles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all instance profiles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListInstanceProfilesResponse":{ + "type":"structure", + "required":["InstanceProfiles"], + "members":{ + "InstanceProfiles":{ + "shape":"instanceProfileListType", + "documentation":"

A list of instance profiles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListInstanceProfiles request.

" + }, + "ListMFADevicesRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user whose MFA devices you want to list.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListMFADevicesResponse":{ + "type":"structure", + "required":["MFADevices"], + "members":{ + "MFADevices":{ + "shape":"mfaDeviceListType", + "documentation":"

A list of MFA devices.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListMFADevices request.

" + }, + "ListOpenIDConnectProvidersRequest":{ + "type":"structure", + "members":{ + } + }, + "ListOpenIDConnectProvidersResponse":{ + "type":"structure", + "members":{ + "OpenIDConnectProviderList":{ + "shape":"OpenIDConnectProviderListType", + "documentation":"

The list of IAM OIDC provider resource objects defined in the AWS account.

" + } + }, + "documentation":"

Contains the response to a successful ListOpenIDConnectProviders request.

" + }, + "ListPoliciesGrantingServiceAccessEntry":{ + "type":"structure", + "members":{ + "ServiceNamespace":{ + "shape":"serviceNamespaceType", + "documentation":"

The namespace of the service that was accessed.

To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

" + }, + "Policies":{ + "shape":"policyGrantingServiceAccessListType", + "documentation":"

The PoliciesGrantingServiceAccess object that contains details about the policy.

" + } + }, + "documentation":"

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is used as a response element in the ListPoliciesGrantingServiceAccess operation.

" + }, + "ListPoliciesGrantingServiceAccessRequest":{ + "type":"structure", + "required":[ + "Arn", + "ServiceNamespaces" + ], + "members":{ + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The ARN of the IAM identity (user, group, or role) whose policies you want to list.

" + }, + "ServiceNamespaces":{ + "shape":"serviceNamespaceListType", + "documentation":"

The service namespace for the AWS services whose policies you want to list.

To learn the service namespace for a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "ListPoliciesGrantingServiceAccessResponse":{ + "type":"structure", + "required":["PoliciesGrantingServiceAccess"], + "members":{ + "PoliciesGrantingServiceAccess":{ + "shape":"listPolicyGrantingServiceAccessResponseListType", + "documentation":"

A ListPoliciesGrantingServiceAccess object that contains details about the permissions policies attached to the specified identity (user, group, or role).

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "Scope":{ + "shape":"policyScopeType", + "documentation":"

The scope to use for filtering the results.

To list only AWS managed policies, set Scope to AWS. To list only the customer managed policies in your AWS account, set Scope to Local.

This parameter is optional. If it is not included, or if it is set to All, all policies are returned.

" + }, + "OnlyAttached":{ + "shape":"booleanType", + "documentation":"

A flag to filter the results to only the attached policies.

When OnlyAttached is true, the returned list contains only the policies that are attached to an IAM user, group, or role. When OnlyAttached is false, or when the parameter is not included, all policies are returned.

" + }, + "PathPrefix":{ + "shape":"policyPathType", + "documentation":"

The path prefix for filtering the results. This parameter is optional. If it is not included, it defaults to a slash (/), listing all policies. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "PolicyUsageFilter":{ + "shape":"PolicyUsageType", + "documentation":"

The policy usage method to use for filtering the results.

To list only permissions policies, set PolicyUsageFilter to PermissionsPolicy. To list only the policies used to set permissions boundaries, set the value to PermissionsBoundary.

This parameter is optional. If it is not included, all policies are returned.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "Policies":{ + "shape":"policyListType", + "documentation":"

A list of policies.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListPolicies request.

" + }, + "ListPolicyVersionsRequest":{ + "type":"structure", + "required":["PolicyArn"], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListPolicyVersionsResponse":{ + "type":"structure", + "members":{ + "Versions":{ + "shape":"policyDocumentVersionListType", + "documentation":"

A list of policy versions.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListPolicyVersions request.

" + }, + "ListRolePoliciesRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListRolePoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListRolePolicies request.

" + }, + "ListRoleTagsRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the IAM role for which you want to see the list of tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when more results are available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListRoleTagsResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"tagListType", + "documentation":"

The list of tags currently that is attached to the role. Each tag consists of a key name and an associated value. If no tags are attached to the specified role, the response contains an empty list.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can use the Marker request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the MaxItems number of results even when more results are available. Check IsTruncated after every call to ensure that you receive all of your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + } + }, + "ListRolesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example, the prefix /application_abc/component_xyz/ gets all roles whose path starts with /application_abc/component_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all roles. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListRolesResponse":{ + "type":"structure", + "required":["Roles"], + "members":{ + "Roles":{ + "shape":"roleListType", + "documentation":"

A list of roles.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListRoles request.

" + }, + "ListSAMLProvidersRequest":{ + "type":"structure", + "members":{ + } + }, + "ListSAMLProvidersResponse":{ + "type":"structure", + "members":{ + "SAMLProviderList":{ + "shape":"SAMLProviderListType", + "documentation":"

The list of SAML provider resource objects defined in IAM for this AWS account.

" + } + }, + "documentation":"

Contains the response to a successful ListSAMLProviders request.

" + }, + "ListSSHPublicKeysRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user to list SSH public keys for. If none is specified, the UserName field is determined implicitly based on the AWS access key used to sign the request.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListSSHPublicKeysResponse":{ + "type":"structure", + "members":{ + "SSHPublicKeys":{ + "shape":"SSHPublicKeyListType", + "documentation":"

A list of the SSH public keys assigned to IAM user.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListSSHPublicKeys request.

" + }, + "ListServerCertificatesRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /company/servercerts would get all server certificates for which the path starts with /company/servercerts.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListServerCertificatesResponse":{ + "type":"structure", + "required":["ServerCertificateMetadataList"], + "members":{ + "ServerCertificateMetadataList":{ + "shape":"serverCertificateMetadataListType", + "documentation":"

A list of server certificates.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListServerCertificates request.

" + }, + "ListServiceSpecificCredentialsRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user whose service-specific credentials you want information about. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "ServiceName":{ + "shape":"serviceName", + "documentation":"

Filters the returned results to only those for the specified AWS service. If not specified, then AWS returns service-specific credentials for all services.

" + } + } + }, + "ListServiceSpecificCredentialsResponse":{ + "type":"structure", + "members":{ + "ServiceSpecificCredentials":{ + "shape":"ServiceSpecificCredentialsListType", + "documentation":"

A list of structures that each contain details about a service-specific credential.

" + } + } + }, + "ListSigningCertificatesRequest":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user whose signing certificates you want to examine.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListSigningCertificatesResponse":{ + "type":"structure", + "required":["Certificates"], + "members":{ + "Certificates":{ + "shape":"certificateListType", + "documentation":"

A list of the user's signing certificate information.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListSigningCertificates request.

" + }, + "ListUserPoliciesRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to list policies for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListUserPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"policyNameListType", + "documentation":"

A list of policy names.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListUserPolicies request.

" + }, + "ListUserTagsRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user whose tags you want to see.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

(Optional) Use this only when paginating results to indicate the maximum number of items that you want in the response. If additional items exist beyond the maximum that you specify, the IsTruncated response element is true.

If you do not include this parameter, it defaults to 100. Note that IAM might return fewer results, even when more results are available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListUserTagsResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"tagListType", + "documentation":"

The list of tags that are currently attached to the user. Each tag consists of a key name and an associated value. If no tags are attached to the specified user, the response contains an empty list.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can use the Marker request parameter to make a subsequent pagination request that retrieves more items. Note that IAM might return fewer than the MaxItems number of results even when more results are available. Check IsTruncated after every call to ensure that you receive all of your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "members":{ + "PathPrefix":{ + "shape":"pathPrefixType", + "documentation":"

The path prefix for filtering the results. For example: /division_abc/subdivision_xyz/, which would get all user names whose path starts with /division_abc/subdivision_xyz/.

This parameter is optional. If it is not included, it defaults to a slash (/), listing all user names. This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "required":["Users"], + "members":{ + "Users":{ + "shape":"userListType", + "documentation":"

A list of users.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListUsers request.

" + }, + "ListVirtualMFADevicesRequest":{ + "type":"structure", + "members":{ + "AssignmentStatus":{ + "shape":"assignmentStatusType", + "documentation":"

The status (Unassigned or Assigned) of the devices to list. If you do not specify an AssignmentStatus, the operation defaults to Any, which lists both assigned and unassigned virtual MFA devices.,

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + } + } + }, + "ListVirtualMFADevicesResponse":{ + "type":"structure", + "required":["VirtualMFADevices"], + "members":{ + "VirtualMFADevices":{ + "shape":"virtualMFADeviceListType", + "documentation":"

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful ListVirtualMFADevices request.

" + }, + "LoginProfile":{ + "type":"structure", + "required":[ + "UserName", + "CreateDate" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user, which can be used for signing in to the AWS Management Console.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date when the password for the user was created.

" + }, + "PasswordResetRequired":{ + "shape":"booleanType", + "documentation":"

Specifies whether the user is required to set a new password on next sign-in.

" + } + }, + "documentation":"

Contains the user name and password create date for a user.

This data type is used as a response element in the CreateLoginProfile and GetLoginProfile operations.

" + }, + "MFADevice":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "EnableDate" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The user with whom the MFA device is associated.

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

" + }, + "EnableDate":{ + "shape":"dateType", + "documentation":"

The date when the MFA device was enabled for the user.

" + } + }, + "documentation":"

Contains information about an MFA device.

This data type is used as a response element in the ListMFADevices operation.

" + }, + "MalformedCertificateException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedCertificateMessage"} + }, + "documentation":"

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

", + "error":{ + "code":"MalformedCertificate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedPolicyDocumentMessage"} + }, + "documentation":"

The request was rejected because the policy document was malformed. The error message describes the specific error.

", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ManagedPolicyDetail":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The friendly name (not ARN) identifying the policy.

" + }, + "PolicyId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{"shape":"arnType"}, + "Path":{ + "shape":"policyPathType", + "documentation":"

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "DefaultVersionId":{ + "shape":"policyVersionIdType", + "documentation":"

The identifier for the version of the policy that is set as the default (operative) version.

For more information about policy versions, see Versioning for Managed Policies in the Using IAM guide.

" + }, + "AttachmentCount":{ + "shape":"attachmentCountType", + "documentation":"

The number of principal entities (users, groups, and roles) that the policy is attached to.

" + }, + "PermissionsBoundaryUsageCount":{ + "shape":"attachmentCountType", + "documentation":"

The number of entities (users and roles) for which the policy is used as the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "IsAttachable":{ + "shape":"booleanType", + "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" + }, + "Description":{ + "shape":"policyDescriptionType", + "documentation":"

A friendly description of the policy.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" + }, + "UpdateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" + }, + "PolicyVersionList":{ + "shape":"policyDocumentVersionListType", + "documentation":"

A list containing information about the versions of the policy.

" + } + }, + "documentation":"

Contains information about a managed policy, including the policy's ARN, versions, and the number of principal entities (users, groups, and roles) that the policy is attached to.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

For more information about managed policies, see Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "ManagedPolicyDetailListType":{ + "type":"list", + "member":{"shape":"ManagedPolicyDetail"} + }, + "NoSuchEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"noSuchEntityMessage"} + }, + "documentation":"

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

", + "error":{ + "code":"NoSuchEntity", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OpenIDConnectProviderListEntry":{ + "type":"structure", + "members":{ + "Arn":{"shape":"arnType"} + }, + "documentation":"

Contains the Amazon Resource Name (ARN) for an IAM OpenID Connect provider.

" + }, + "OpenIDConnectProviderListType":{ + "type":"list", + "member":{"shape":"OpenIDConnectProviderListEntry"}, + "documentation":"

Contains a list of IAM OpenID Connect providers.

" + }, + "OpenIDConnectProviderUrlType":{ + "type":"string", + "documentation":"

Contains a URL that specifies the endpoint for an OpenID Connect provider.

", + "max":255, + "min":1 + }, + "OrganizationsDecisionDetail":{ + "type":"structure", + "members":{ + "AllowedByOrganizations":{ + "shape":"booleanType", + "documentation":"

Specifies whether the simulated operation is allowed by the Organizations service control policies that impact the simulated user's account.

" + } + }, + "documentation":"

Contains information about the effect that Organizations has on a policy simulation.

" + }, + "PasswordPolicy":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{ + "shape":"minimumPasswordLengthType", + "documentation":"

Minimum length to require for IAM user passwords.

" + }, + "RequireSymbols":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require symbols for IAM user passwords.

" + }, + "RequireNumbers":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require numbers for IAM user passwords.

" + }, + "RequireUppercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require uppercase characters for IAM user passwords.

" + }, + "RequireLowercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether to require lowercase characters for IAM user passwords.

" + }, + "AllowUsersToChangePassword":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM users are allowed to change their own password.

" + }, + "ExpirePasswords":{ + "shape":"booleanType", + "documentation":"

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

" + }, + "MaxPasswordAge":{ + "shape":"maxPasswordAgeType", + "documentation":"

The number of days that an IAM user password is valid.

" + }, + "PasswordReusePrevention":{ + "shape":"passwordReusePreventionType", + "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

" + }, + "HardExpiry":{ + "shape":"booleanObjectType", + "documentation":"

Specifies whether IAM users are prevented from setting a new password after their password has expired.

" + } + }, + "documentation":"

Contains information about the account password policy.

This data type is used as a response element in the GetAccountPasswordPolicy operation.

" + }, + "PasswordPolicyViolationException":{ + "type":"structure", + "members":{ + "message":{"shape":"passwordPolicyViolationMessage"} + }, + "documentation":"

The request was rejected because the provided password did not meet the requirements imposed by the account password policy.

", + "error":{ + "code":"PasswordPolicyViolation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PermissionsBoundaryAttachmentType":{ + "type":"string", + "enum":["PermissionsBoundaryPolicy"] + }, + "Policy":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The friendly name (not ARN) identifying the policy.

" + }, + "PolicyId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{"shape":"arnType"}, + "Path":{ + "shape":"policyPathType", + "documentation":"

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "DefaultVersionId":{ + "shape":"policyVersionIdType", + "documentation":"

The identifier for the version of the policy that is set as the default version.

" + }, + "AttachmentCount":{ + "shape":"attachmentCountType", + "documentation":"

The number of entities (users, groups, and roles) that the policy is attached to.

" + }, + "PermissionsBoundaryUsageCount":{ + "shape":"attachmentCountType", + "documentation":"

The number of entities (users and roles) for which the policy is used to set the permissions boundary.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "IsAttachable":{ + "shape":"booleanType", + "documentation":"

Specifies whether the policy can be attached to an IAM user, group, or role.

" + }, + "Description":{ + "shape":"policyDescriptionType", + "documentation":"

A friendly description of the policy.

This element is included in the response to the GetPolicy operation. It is not included in the response to the ListPolicies operation.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was created.

" + }, + "UpdateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the policy was last updated.

When a policy has only one version, this field contains the date and time when the policy was created. When a policy has more than one version, this field contains the date and time when the most recent policy version was created.

" + } + }, + "documentation":"

Contains information about a managed policy.

This data type is used as a response element in the CreatePolicy, GetPolicy, and ListPolicies operations.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "PolicyDetail":{ + "type":"structure", + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy.

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

" + } + }, + "documentation":"

Contains information about an IAM policy, including the policy document.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + }, + "PolicyEvaluationDecisionType":{ + "type":"string", + "enum":[ + "allowed", + "explicitDeny", + "implicitDeny" + ] + }, + "PolicyEvaluationException":{ + "type":"structure", + "members":{ + "message":{"shape":"policyEvaluationErrorMessage"} + }, + "documentation":"

The request failed because a provided policy could not be successfully evaluated. An additional detailed message indicates the source of the failure.

", + "error":{ + "code":"PolicyEvaluation", + "httpStatusCode":500 + }, + "exception":true + }, + "PolicyGrantingServiceAccess":{ + "type":"structure", + "required":[ + "PolicyName", + "PolicyType" + ], + "members":{ + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The policy name.

" + }, + "PolicyType":{ + "shape":"policyType", + "documentation":"

The policy type. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "PolicyArn":{"shape":"arnType"}, + "EntityType":{ + "shape":"policyOwnerEntityType", + "documentation":"

The type of entity (user or role) that used the policy to access the service to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide.

" + }, + "EntityName":{ + "shape":"entityNameType", + "documentation":"

The name of the entity (user or role) to which the inline policy is attached.

This field is null for managed policies. For more information about these policy types, see Managed Policies and Inline Policies in the IAM User Guide.

" + } + }, + "documentation":"

Contains details about the permissions policies that are attached to the specified identity (user, group, or role).

This data type is an element of the ListPoliciesGrantingServiceAccessEntry object.

" + }, + "PolicyGroup":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name (friendly name, not ARN) identifying the group.

" + }, + "GroupId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about a group that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "PolicyGroupListType":{ + "type":"list", + "member":{"shape":"PolicyGroup"} + }, + "PolicyIdentifierType":{"type":"string"}, + "PolicyNotAttachableException":{ + "type":"structure", + "members":{ + "message":{"shape":"policyNotAttachableMessage"} + }, + "documentation":"

The request failed because AWS service role policies can only be attached to the service-linked role for that service.

", + "error":{ + "code":"PolicyNotAttachable", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PolicyRole":{ + "type":"structure", + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) identifying the role.

" + }, + "RoleId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about a role that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "PolicyRoleListType":{ + "type":"list", + "member":{"shape":"PolicyRole"} + }, + "PolicySourceType":{ + "type":"string", + "enum":[ + "user", + "group", + "role", + "aws-managed", + "user-managed", + "resource", + "none" + ] + }, + "PolicyUsageType":{ + "type":"string", + "documentation":"

The policy usage type that indicates whether the policy is used as a permissions policy or as the permissions boundary for an entity.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

", + "enum":[ + "PermissionsPolicy", + "PermissionsBoundary" + ] + }, + "PolicyUser":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) identifying the user.

" + }, + "UserId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about a user that a managed policy is attached to.

This data type is used as a response element in the ListEntitiesForPolicy operation.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "PolicyUserListType":{ + "type":"list", + "member":{"shape":"PolicyUser"} + }, + "PolicyVersion":{ + "type":"structure", + "members":{ + "Document":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

" + }, + "VersionId":{ + "shape":"policyVersionIdType", + "documentation":"

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

" + }, + "IsDefaultVersion":{ + "shape":"booleanType", + "documentation":"

Specifies whether the policy version is set as the policy's default version.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the policy version was created.

" + } + }, + "documentation":"

Contains information about a version of a managed policy.

This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion, ListPolicyVersions, and GetAccountAuthorizationDetails operations.

For more information about managed policies, refer to Managed Policies and Inline Policies in the Using IAM guide.

" + }, + "Position":{ + "type":"structure", + "members":{ + "Line":{ + "shape":"LineNumber", + "documentation":"

The line containing the specified position in the document.

" + }, + "Column":{ + "shape":"ColumnNumber", + "documentation":"

The column in the line containing the specified position in the document.

" + } + }, + "documentation":"

Contains the row and column of a location of a Statement element in a policy document.

This data type is used as a member of the Statement type.

" + }, + "PutGroupPolicyRequest":{ + "type":"structure", + "required":[ + "GroupName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "PutRolePermissionsBoundaryRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PermissionsBoundary" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM role for which you want to set the permissions boundary.

" + }, + "PermissionsBoundary":{ + "shape":"arnType", + "documentation":"

The ARN of the policy that is used to set the permissions boundary for the role.

" + } + } + }, + "PutRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "PutUserPermissionsBoundaryRequest":{ + "type":"structure", + "required":[ + "UserName", + "PermissionsBoundary" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name (friendly name, not ARN) of the IAM user for which you want to set the permissions boundary.

" + }, + "PermissionsBoundary":{ + "shape":"arnType", + "documentation":"

The ARN of the policy that is used to set the permissions boundary for the user.

" + } + } + }, + "PutUserPolicyRequest":{ + "type":"structure", + "required":[ + "UserName", + "PolicyName", + "PolicyDocument" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to associate the policy with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyName":{ + "shape":"policyNameType", + "documentation":"

The name of the policy document.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "ReasonType":{ + "type":"string", + "max":1000 + }, + "RegionNameType":{ + "type":"string", + "max":100, + "min":1 + }, + "RemoveClientIDFromOpenIDConnectProviderRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ClientID" + ], + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "ClientID":{ + "shape":"clientIDType", + "documentation":"

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

" + } + } + }, + "RemoveRoleFromInstanceProfileRequest":{ + "type":"structure", + "required":[ + "InstanceProfileName", + "RoleName" + ], + "members":{ + "InstanceProfileName":{ + "shape":"instanceProfileNameType", + "documentation":"

The name of the instance profile to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "RemoveUserFromGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "UserName" + ], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user to remove.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "ReportContentType":{"type":"blob"}, + "ReportFormatType":{ + "type":"string", + "enum":["text/csv"] + }, + "ReportGenerationLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"reportGenerationLimitExceededMessage"} + }, + "documentation":"

The request failed because the maximum number of concurrent requests for this account are already running.

", + "error":{ + "code":"ReportGenerationLimitExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ReportStateDescriptionType":{"type":"string"}, + "ReportStateType":{ + "type":"string", + "enum":[ + "STARTED", + "INPROGRESS", + "COMPLETE" + ] + }, + "ResetServiceSpecificCredentialRequest":{ + "type":"structure", + "required":["ServiceSpecificCredentialId"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the service-specific credential. If this value is not specified, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "ServiceSpecificCredentialId":{ + "shape":"serviceSpecificCredentialId", + "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + } + } + }, + "ResetServiceSpecificCredentialResponse":{ + "type":"structure", + "members":{ + "ServiceSpecificCredential":{ + "shape":"ServiceSpecificCredential", + "documentation":"

A structure with details about the updated service-specific credential, including the new password.

This is the only time that you can access the password. You cannot recover the password later, but you can reset it again.

" + } + } + }, + "ResourceHandlingOptionType":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceNameListType":{ + "type":"list", + "member":{"shape":"ResourceNameType"} + }, + "ResourceNameType":{ + "type":"string", + "max":2048, + "min":1 + }, + "ResourceSpecificResult":{ + "type":"structure", + "required":[ + "EvalResourceName", + "EvalResourceDecision" + ], + "members":{ + "EvalResourceName":{ + "shape":"ResourceNameType", + "documentation":"

The name of the simulated resource, in Amazon Resource Name (ARN) format.

" + }, + "EvalResourceDecision":{ + "shape":"PolicyEvaluationDecisionType", + "documentation":"

The result of the simulation of the simulated API operation on the resource specified in EvalResourceName.

" + }, + "MatchedStatements":{ + "shape":"StatementListType", + "documentation":"

A list of the statements in the input policies that determine the result for this part of the simulation. Remember that even if multiple statements allow the operation on the resource, if any statement denies that operation, then the explicit deny overrides any allow. In addition, the deny statement is the only entry included in the result.

" + }, + "MissingContextValues":{ + "shape":"ContextKeyNamesResultListType", + "documentation":"

A list of context keys that are required by the included input policies but that were not provided by one of the input parameters. This list is used when a list of ARNs is included in the ResourceArns parameter instead of \"*\". If you do not specify individual resources, by setting ResourceArns to \"*\" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

" + }, + "EvalDecisionDetails":{ + "shape":"EvalDecisionDetailsType", + "documentation":"

Additional details about the results of the evaluation decision. When there are both IAM policies and resource policies, this parameter explains how each set of policies contributes to the final evaluation decision. When simulating cross-account access to a resource, both the resource-based policy and the caller's IAM policy must grant access.

" + } + }, + "documentation":"

Contains the result of the simulation of a single API operation call on a single resource.

This data type is used by a member of the EvaluationResult data type.

" + }, + "ResourceSpecificResultListType":{ + "type":"list", + "member":{"shape":"ResourceSpecificResult"} + }, + "ResyncMFADeviceRequest":{ + "type":"structure", + "required":[ + "UserName", + "SerialNumber", + "AuthenticationCode1", + "AuthenticationCode2" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user whose MFA device you want to resynchronize.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

Serial number that uniquely identifies the MFA device.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "AuthenticationCode1":{ + "shape":"authenticationCodeType", + "documentation":"

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" + }, + "AuthenticationCode2":{ + "shape":"authenticationCodeType", + "documentation":"

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

" + } + } + }, + "Role":{ + "type":"structure", + "required":[ + "Path", + "RoleName", + "RoleId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The friendly name that identifies the role.

" + }, + "RoleId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM Identifiers in the IAM User Guide guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" + }, + "AssumeRolePolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy that grants an entity permission to assume the role.

" + }, + "Description":{ + "shape":"roleDescriptionType", + "documentation":"

A description of the role that you provide.

" + }, + "MaxSessionDuration":{ + "shape":"roleMaxSessionDurationType", + "documentation":"

The maximum session duration (in seconds) for the specified role. Anyone who uses the AWS CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.

" + }, + "PermissionsBoundary":{ + "shape":"AttachedPermissionsBoundary", + "documentation":"

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

" + }, + "RoleDetail":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The friendly name that identifies the role.

" + }, + "RoleId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{"shape":"arnType"}, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the role was created.

" + }, + "AssumeRolePolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The trust policy that grants permission to assume the role.

" + }, + "InstanceProfileList":{ + "shape":"instanceProfileListType", + "documentation":"

A list of instance profiles that contain this role.

" + }, + "RolePolicyList":{ + "shape":"policyDetailListType", + "documentation":"

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

" + }, + "AttachedManagedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

" + }, + "PermissionsBoundary":{ + "shape":"AttachedPermissionsBoundary", + "documentation":"

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that are attached to the specified role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about an IAM role, including all of the role's policies.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + }, + "RoleUsageListType":{ + "type":"list", + "member":{"shape":"RoleUsageType"} + }, + "RoleUsageType":{ + "type":"structure", + "members":{ + "Region":{ + "shape":"RegionNameType", + "documentation":"

The name of the Region where the service-linked role is being used.

" + }, + "Resources":{ + "shape":"ArnListType", + "documentation":"

The name of the resource that is using the service-linked role.

" + } + }, + "documentation":"

An object that contains details about how a service-linked role is used, if that information is returned by the service.

This data type is used as a response element in the GetServiceLinkedRoleDeletionStatus operation.

" + }, + "SAMLMetadataDocumentType":{ + "type":"string", + "max":10000000, + "min":1000 + }, + "SAMLProviderListEntry":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider.

" + }, + "ValidUntil":{ + "shape":"dateType", + "documentation":"

The expiration date and time for the SAML provider.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time when the SAML provider was created.

" + } + }, + "documentation":"

Contains the list of SAML providers for this account.

" + }, + "SAMLProviderListType":{ + "type":"list", + "member":{"shape":"SAMLProviderListEntry"} + }, + "SAMLProviderNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w._-]+" + }, + "SSHPublicKey":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Fingerprint", + "SSHPublicKeyBody", + "Status" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the SSH public key.

" + }, + "SSHPublicKeyId":{ + "shape":"publicKeyIdType", + "documentation":"

The unique identifier for the SSH public key.

" + }, + "Fingerprint":{ + "shape":"publicKeyFingerprintType", + "documentation":"

The MD5 message digest of the SSH public key.

" + }, + "SSHPublicKeyBody":{ + "shape":"publicKeyMaterialType", + "documentation":"

The SSH public key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" + } + }, + "documentation":"

Contains information about an SSH public key.

This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.

" + }, + "SSHPublicKeyListType":{ + "type":"list", + "member":{"shape":"SSHPublicKeyMetadata"} + }, + "SSHPublicKeyMetadata":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Status", + "UploadDate" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the SSH public key.

" + }, + "SSHPublicKeyId":{ + "shape":"publicKeyIdType", + "documentation":"

The unique identifier for the SSH public key.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the SSH public key was uploaded.

" + } + }, + "documentation":"

Contains information about an SSH public key, without the key's body or fingerprint.

This data type is used as a response element in the ListSSHPublicKeys operation.

" + }, + "ServerCertificate":{ + "type":"structure", + "required":[ + "ServerCertificateMetadata", + "CertificateBody" + ], + "members":{ + "ServerCertificateMetadata":{ + "shape":"ServerCertificateMetadata", + "documentation":"

The meta information of the server certificate, such as its name, path, ID, and ARN.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the public key certificate.

" + }, + "CertificateChain":{ + "shape":"certificateChainType", + "documentation":"

The contents of the public key certificate chain.

" + } + }, + "documentation":"

Contains information about a server certificate.

This data type is used as a response element in the GetServerCertificate operation.

" + }, + "ServerCertificateMetadata":{ + "type":"structure", + "required":[ + "Path", + "ServerCertificateName", + "ServerCertificateId", + "Arn" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name that identifies the server certificate.

" + }, + "ServerCertificateId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the server certificate. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see IAM Identifiers in the Using IAM guide.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date when the server certificate was uploaded.

" + }, + "Expiration":{ + "shape":"dateType", + "documentation":"

The date on which the certificate is set to expire.

" + } + }, + "documentation":"

Contains information about a server certificate without its certificate body, certificate chain, and private key.

This data type is used as a response element in the UploadServerCertificate and ListServerCertificates operations.

" + }, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"serviceFailureExceptionMessage"} + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", + "error":{ + "code":"ServiceFailure", + "httpStatusCode":500 + }, + "exception":true + }, + "ServiceLastAccessed":{ + "type":"structure", + "required":[ + "ServiceName", + "ServiceNamespace" + ], + "members":{ + "ServiceName":{ + "shape":"serviceNameType", + "documentation":"

The name of the service in which access was attempted.

" + }, + "LastAuthenticated":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when an authenticated entity most recently attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

" + }, + "ServiceNamespace":{ + "shape":"serviceNamespaceType", + "documentation":"

The namespace of the service in which access was attempted.

To learn the service namespace of a service, go to Actions, Resources, and Condition Keys for AWS Services in the IAM User Guide. Choose the name of the service to view details for that service. In the first paragraph, find the service prefix. For example, (service prefix: a4b). For more information about service namespaces, see AWS Service Namespaces in the AWS General Reference.

" + }, + "LastAuthenticatedEntity":{ + "shape":"arnType", + "documentation":"

The ARN of the authenticated entity (user or role) that last attempted to access the service. AWS does not report unauthenticated requests.

This field is null if no IAM entities attempted to access the service within the reporting period.

" + }, + "TotalAuthenticatedEntities":{ + "shape":"integerType", + "documentation":"

The total number of authenticated principals (root user, IAM users, or IAM roles) that have attempted to access the service.

This field is null if no principals attempted to access the service within the reporting period.

" + } + }, + "documentation":"

Contains details about the most recent attempt to access the service.

This data type is used as a response element in the GetServiceLastAccessedDetails operation.

" + }, + "ServiceNotSupportedException":{ + "type":"structure", + "members":{ + "message":{"shape":"serviceNotSupportedMessage"} + }, + "documentation":"

The specified service does not support service-specific credentials.

", + "error":{ + "code":"NotSupportedService", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceSpecificCredential":{ + "type":"structure", + "required":[ + "CreateDate", + "ServiceName", + "ServiceUserName", + "ServicePassword", + "ServiceSpecificCredentialId", + "UserName", + "Status" + ], + "members":{ + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" + }, + "ServiceName":{ + "shape":"serviceName", + "documentation":"

The name of the service associated with the service-specific credential.

" + }, + "ServiceUserName":{ + "shape":"serviceUserName", + "documentation":"

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the AWS account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

" + }, + "ServicePassword":{ + "shape":"servicePassword", + "documentation":"

The generated password for the service-specific credential.

" + }, + "ServiceSpecificCredentialId":{ + "shape":"serviceSpecificCredentialId", + "documentation":"

The unique identifier for the service-specific credential.

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the service-specific credential.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

" + } + }, + "documentation":"

Contains the details of a service-specific credential.

" + }, + "ServiceSpecificCredentialMetadata":{ + "type":"structure", + "required":[ + "UserName", + "Status", + "ServiceUserName", + "CreateDate", + "ServiceSpecificCredentialId", + "ServiceName" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the service-specific credential.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

" + }, + "ServiceUserName":{ + "shape":"serviceUserName", + "documentation":"

The generated user name for the service-specific credential.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

" + }, + "ServiceSpecificCredentialId":{ + "shape":"serviceSpecificCredentialId", + "documentation":"

The unique identifier for the service-specific credential.

" + }, + "ServiceName":{ + "shape":"serviceName", + "documentation":"

The name of the service associated with the service-specific credential.

" + } + }, + "documentation":"

Contains additional details about a service-specific credential.

" + }, + "ServiceSpecificCredentialsListType":{ + "type":"list", + "member":{"shape":"ServiceSpecificCredentialMetadata"} + }, + "ServicesLastAccessed":{ + "type":"list", + "member":{"shape":"ServiceLastAccessed"} + }, + "SetDefaultPolicyVersionRequest":{ + "type":"structure", + "required":[ + "PolicyArn", + "VersionId" + ], + "members":{ + "PolicyArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "VersionId":{ + "shape":"policyVersionIdType", + "documentation":"

The version of the policy to set as the default (operative) version.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

" + } + } + }, + "SetSecurityTokenServicePreferencesRequest":{ + "type":"structure", + "required":["GlobalEndpointTokenVersion"], + "members":{ + "GlobalEndpointTokenVersion":{ + "shape":"globalEndpointTokenVersion", + "documentation":"

The version of the global endpoint token. Version 1 tokens are valid only in AWS Regions that are available by default. These tokens do not work in manually enabled Regions, such as Asia Pacific (Hong Kong). Version 2 tokens are valid in all Regions. However, version 2 tokens are longer and might affect systems where you temporarily store tokens.

For information, see Activating and Deactivating STS in an AWS Region in the IAM User Guide.

" + } + } + }, + "SigningCertificate":{ + "type":"structure", + "required":[ + "UserName", + "CertificateId", + "CertificateBody", + "Status" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user the signing certificate is associated with.

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

The ID for the signing certificate.

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the signing certificate.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

" + }, + "UploadDate":{ + "shape":"dateType", + "documentation":"

The date when the signing certificate was uploaded.

" + } + }, + "documentation":"

Contains information about an X.509 signing certificate.

This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.

" + }, + "SimulateCustomPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyInputList", + "ActionNames" + ], + "members":{ + "PolicyInputList":{ + "shape":"SimulationPolicyListType", + "documentation":"

A list of policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy. Do not include any resource-based policies in this parameter. Any resource-based policy must be submitted with the ResourcePolicy parameter. The policies cannot be \"scope-down\" policies, such as you could include in a call to GetFederationToken or one of the AssumeRole API operations. In other words, do not use policies designed to restrict what a user can do while using the temporary credentials.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "ActionNames":{ + "shape":"ActionNameListType", + "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated against each resource. Each operation must include the service identifier, such as iam:CreateUser. This operation does not support using wildcards (*) in an action name.

" + }, + "ResourceArns":{ + "shape":"ResourceNameListType", + "documentation":"

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

If you include a ResourcePolicy, then it must be applicable to all of the resources included in the simulation or you receive an invalid input error.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "ResourcePolicy":{ + "shape":"policyDocumentType", + "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "ResourceOwner":{ + "shape":"ResourceNameType", + "documentation":"

An ARN representing the AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

The ARN for an account uses the following syntax: arn:aws:iam::AWS-account-ID:root. For example, to represent the account with the 112233445566 ID, use the following ARN: arn:aws:iam::112233445566-ID:root.

" + }, + "CallerArn":{ + "shape":"ResourceNameType", + "documentation":"

The ARN of the IAM user that you want to use as the simulated caller of the API operations. CallerArn is required if you include a ResourcePolicy so that the policy's Principal element has a value to use in evaluating the policy.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

" + }, + "ContextEntries":{ + "shape":"ContextEntryListType", + "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

" + }, + "ResourceHandlingOption":{ + "shape":"ResourceHandlingOptionType", + "documentation":"

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security-group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network-interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security-group

  • EC2-Classic-EBS

    instance, image, security-group, volume

  • EC2-VPC-InstanceStore

    instance, image, security-group, network-interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security-group, network-interface, subnet

  • EC2-VPC-EBS

    instance, image, security-group, network-interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security-group, network-interface, subnet, volume

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + } + } + }, + "SimulatePolicyResponse":{ + "type":"structure", + "members":{ + "EvaluationResults":{ + "shape":"EvaluationResultsListType", + "documentation":"

The results of the simulation.

" + }, + "IsTruncated":{ + "shape":"booleanType", + "documentation":"

A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

" + }, + "Marker":{ + "shape":"responseMarkerType", + "documentation":"

When IsTruncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent pagination request.

" + } + }, + "documentation":"

Contains the response to a successful SimulatePrincipalPolicy or SimulateCustomPolicy request.

" + }, + "SimulatePrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "PolicySourceArn", + "ActionNames" + ], + "members":{ + "PolicySourceArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of a user, group, or role whose policies you want to include in the simulation. If you specify a user, group, or role, the simulation includes all policies that are associated with that entity. If you specify a user, the simulation also includes all policies that are attached to any groups the user belongs to.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "PolicyInputList":{ + "shape":"SimulationPolicyListType", + "documentation":"

An optional list of additional policy documents to include in the simulation. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "ActionNames":{ + "shape":"ActionNameListType", + "documentation":"

A list of names of API operations to evaluate in the simulation. Each operation is evaluated for each resource. Each operation must include the service identifier, such as iam:CreateUser.

" + }, + "ResourceArns":{ + "shape":"ResourceNameListType", + "documentation":"

A list of ARNs of AWS resources to include in the simulation. If this parameter is not provided, then the value defaults to * (all resources). Each API in the ActionNames parameter is evaluated for each resource in this list. The simulation determines the access result (allowed or denied) of each combination and reports it in the response.

The simulation does not automatically retrieve policies for the specified resources. If you want to include a resource policy in the simulation, then you must include the policy as a string in the ResourcePolicy parameter.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "ResourcePolicy":{ + "shape":"policyDocumentType", + "documentation":"

A resource-based policy to include in the simulation provided as a string. Each resource in the simulation is treated as if it had this policy attached. You can include only one resource-based policy in a simulation.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "ResourceOwner":{ + "shape":"ResourceNameType", + "documentation":"

An AWS account ID that specifies the owner of any simulated resource that does not identify its owner in the resource ARN. Examples of resource ARNs include an S3 bucket or object. If ResourceOwner is specified, it is also used as the account owner of any ResourcePolicy included in the simulation. If the ResourceOwner parameter is not specified, then the owner of the resources and the resource policy defaults to the account of the identity provided in CallerArn. This parameter is required only if you specify a resource-based policy and account that owns the resource is different from the account that owns the simulated calling user CallerArn.

" + }, + "CallerArn":{ + "shape":"ResourceNameType", + "documentation":"

The ARN of the IAM user that you want to specify as the simulated caller of the API operations. If you do not specify a CallerArn, it defaults to the ARN of the user that you specify in PolicySourceArn, if you specified a user. If you include both a PolicySourceArn (for example, arn:aws:iam::123456789012:user/David) and a CallerArn (for example, arn:aws:iam::123456789012:user/Bob), the result is that you simulate calling the API operations as Bob, as if Bob had David's policies.

You can specify only the ARN of an IAM user. You cannot specify the ARN of an assumed role, federated user, or a service principal.

CallerArn is required if you include a ResourcePolicy and the PolicySourceArn is not the ARN for an IAM user. This is required so that the resource-based policy's Principal element has a value to use in evaluating the policy.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "ContextEntries":{ + "shape":"ContextEntryListType", + "documentation":"

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permissions policies, the corresponding value is supplied.

" + }, + "ResourceHandlingOption":{ + "shape":"ResourceHandlingOptionType", + "documentation":"

Specifies the type of simulation to run. Different API operations that support resource-based policies require different combinations of resources. By specifying the type of simulation to run, you enable the policy simulator to enforce the presence of the required resources to ensure reliable simulation results. If your simulation does not match one of the following scenarios, then you can omit this parameter. The following list shows each of the supported scenario values and the resources that you must define to run the simulation.

Each of the EC2 scenarios requires that you specify instance, image, and security group resources. If your scenario includes an EBS volume, then you must specify that volume as a resource. If the EC2 scenario includes VPC, then you must supply the network interface resource. If it includes an IP subnet, then you must specify the subnet resource. For more information on the EC2 scenario options, see Supported Platforms in the Amazon EC2 User Guide.

  • EC2-Classic-InstanceStore

    instance, image, security group

  • EC2-Classic-EBS

    instance, image, security group, volume

  • EC2-VPC-InstanceStore

    instance, image, security group, network interface

  • EC2-VPC-InstanceStore-Subnet

    instance, image, security group, network interface, subnet

  • EC2-VPC-EBS

    instance, image, security group, network interface, volume

  • EC2-VPC-EBS-Subnet

    instance, image, security group, network interface, subnet, volume

" + }, + "MaxItems":{ + "shape":"maxItemsType", + "documentation":"

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

" + }, + "Marker":{ + "shape":"markerType", + "documentation":"

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.

" + } + } + }, + "SimulationPolicyListType":{ + "type":"list", + "member":{"shape":"policyDocumentType"} + }, + "Statement":{ + "type":"structure", + "members":{ + "SourcePolicyId":{ + "shape":"PolicyIdentifierType", + "documentation":"

The identifier of the policy that was provided as an input.

" + }, + "SourcePolicyType":{ + "shape":"PolicySourceType", + "documentation":"

The type of the policy.

" + }, + "StartPosition":{ + "shape":"Position", + "documentation":"

The row and column of the beginning of the Statement in an IAM policy.

" + }, + "EndPosition":{ + "shape":"Position", + "documentation":"

The row and column of the end of a Statement in an IAM policy.

" + } + }, + "documentation":"

Contains a reference to a Statement element in a policy document that determines the result of the simulation.

This data type is used by the MatchedStatements member of the EvaluationResult type.

" + }, + "StatementListType":{ + "type":"list", + "member":{"shape":"Statement"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"tagKeyType", + "documentation":"

The key name that can be used to look up or retrieve the associated value. For example, Department or Cost Center are common choices.

" + }, + "Value":{ + "shape":"tagValueType", + "documentation":"

The value associated with this tag. For example, tags with a key name of Department could have values such as Human Resources, Accounting, and Support. Tags with a key name of Cost Center might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.

AWS always interprets the tag Value as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.

" + } + }, + "documentation":"

A structure that represents user-provided metadata that can be associated with a resource such as an IAM user or role. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + }, + "TagRoleRequest":{ + "type":"structure", + "required":[ + "RoleName", + "Tags" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role that you want to add tags to.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

The list of tags that you want to attach to the role. Each tag consists of a key name and an associated value. You can specify this with a JSON string.

" + } + } + }, + "TagUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "Tags" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user that you want to add tags to.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

The list of tags that you want to attach to the user. Each tag consists of a key name and an associated value.

" + } + } + }, + "UnmodifiableEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"unmodifiableEntityMessage"} + }, + "documentation":"

The request was rejected because only the service that depends on the service-linked role can modify or delete the role on your behalf. The error message includes the name of the service that depends on this service-linked role. You must request the change through that service.

", + "error":{ + "code":"UnmodifiableEntity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnrecognizedPublicKeyEncodingException":{ + "type":"structure", + "members":{ + "message":{"shape":"unrecognizedPublicKeyEncodingMessage"} + }, + "documentation":"

The request was rejected because the public key encoding format is unsupported or unrecognized.

", + "error":{ + "code":"UnrecognizedPublicKeyEncoding", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagRoleRequest":{ + "type":"structure", + "required":[ + "RoleName", + "TagKeys" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the IAM role from which you want to remove tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "TagKeys":{ + "shape":"tagKeyListType", + "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified role.

" + } + } + }, + "UntagUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "TagKeys" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user from which you want to remove tags.

This parameter accepts (through its regex pattern) a string of characters that consist of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

" + }, + "TagKeys":{ + "shape":"tagKeyListType", + "documentation":"

A list of key names as a simple array of strings. The tags with matching keys are removed from the specified user.

" + } + } + }, + "UpdateAccessKeyRequest":{ + "type":"structure", + "required":[ + "AccessKeyId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user whose key you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

The access key ID of the secret access key you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status you want to assign to the secret access key. Active means that the key can be used for API calls to AWS, while Inactive means that the key cannot be used.

" + } + } + }, + "UpdateAccountPasswordPolicyRequest":{ + "type":"structure", + "members":{ + "MinimumPasswordLength":{ + "shape":"minimumPasswordLengthType", + "documentation":"

The minimum number of characters allowed in an IAM user password.

If you do not specify a value for this parameter, then the operation uses the default value of 6.

" + }, + "RequireSymbols":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one symbol character.

" + }, + "RequireNumbers":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one numeric character.

" + }, + "RequireUppercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one uppercase character.

" + }, + "RequireLowercaseCharacters":{ + "shape":"booleanType", + "documentation":"

Specifies whether IAM user passwords must contain at least one lowercase character from the ISO basic Latin alphabet (a to z).

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that passwords do not require at least one lowercase character.

" + }, + "AllowUsersToChangePassword":{ + "shape":"booleanType", + "documentation":"

Allows all IAM users in your account to use the AWS Management Console to change their own passwords. For more information, see Letting IAM Users Change Their Own Passwords in the IAM User Guide.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users in the account do not automatically have permissions to change their own password.

" + }, + "MaxPasswordAge":{ + "shape":"maxPasswordAgeType", + "documentation":"

The number of days that an IAM user password is valid.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM user passwords never expire.

" + }, + "PasswordReusePrevention":{ + "shape":"passwordReusePreventionType", + "documentation":"

Specifies the number of previous passwords that IAM users are prevented from reusing.

If you do not specify a value for this parameter, then the operation uses the default value of 0. The result is that IAM users are not prevented from reusing previous passwords.

" + }, + "HardExpiry":{ + "shape":"booleanObjectType", + "documentation":"

Prevents IAM users from setting a new password after their password has expired. The IAM user cannot be accessed until an administrator resets the password.

If you do not specify a value for this parameter, then the operation uses the default value of false. The result is that IAM users can change their passwords after they expire and continue to sign in as the user.

" + } + } + }, + "UpdateAssumeRolePolicyRequest":{ + "type":"structure", + "required":[ + "RoleName", + "PolicyDocument" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role to update with the new policy.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "PolicyDocument":{ + "shape":"policyDocumentType", + "documentation":"

The policy that grants an entity permission to assume the role.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"groupNameType", + "documentation":"

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

New path for the IAM group. Only include this if changing the group's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "NewGroupName":{ + "shape":"groupNameType", + "documentation":"

New name for the IAM group. Only include this if changing the group's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + } + } + }, + "UpdateLoginProfileRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the user whose password you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "Password":{ + "shape":"passwordType", + "documentation":"

The new password for the specified IAM user.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.

" + }, + "PasswordResetRequired":{ + "shape":"booleanObjectType", + "documentation":"

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

" + } + } + }, + "UpdateOpenIDConnectProviderThumbprintRequest":{ + "type":"structure", + "required":[ + "OpenIDConnectProviderArn", + "ThumbprintList" + ], + "members":{ + "OpenIDConnectProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + }, + "ThumbprintList":{ + "shape":"thumbprintListType", + "documentation":"

A list of certificate thumbprints that are associated with the specified IAM OpenID Connect provider. For more information, see CreateOpenIDConnectProvider.

" + } + } + }, + "UpdateRoleDescriptionRequest":{ + "type":"structure", + "required":[ + "RoleName", + "Description" + ], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role that you want to modify.

" + }, + "Description":{ + "shape":"roleDescriptionType", + "documentation":"

The new description that you want to apply to the specified role.

" + } + } + }, + "UpdateRoleDescriptionResponse":{ + "type":"structure", + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

A structure that contains details about the modified role.

" + } + } + }, + "UpdateRoleRequest":{ + "type":"structure", + "required":["RoleName"], + "members":{ + "RoleName":{ + "shape":"roleNameType", + "documentation":"

The name of the role that you want to modify.

" + }, + "Description":{ + "shape":"roleDescriptionType", + "documentation":"

The new description that you want to apply to the specified role.

" + }, + "MaxSessionDuration":{ + "shape":"roleMaxSessionDurationType", + "documentation":"

The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 1 hour to 12 hours.

Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter. If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

" + } + } + }, + "UpdateRoleResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateSAMLProviderRequest":{ + "type":"structure", + "required":[ + "SAMLMetadataDocument", + "SAMLProviderArn" + ], + "members":{ + "SAMLMetadataDocument":{ + "shape":"SAMLMetadataDocumentType", + "documentation":"

An XML document generated by an identity provider (IdP) that supports SAML 2.0. The document includes the issuer's name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that are received from the IdP. You must generate the metadata document using the identity management software that is used as your organization's IdP.

" + }, + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider to update.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

" + } + } + }, + "UpdateSAMLProviderResponse":{ + "type":"structure", + "members":{ + "SAMLProviderArn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) of the SAML provider that was updated.

" + } + }, + "documentation":"

Contains the response to a successful UpdateSAMLProvider request.

" + }, + "UpdateSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the SSH public key.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SSHPublicKeyId":{ + "shape":"publicKeyIdType", + "documentation":"

The unique identifier for the SSH public key.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status to assign to the SSH public key. Active means that the key can be used for authentication with an AWS CodeCommit repository. Inactive means that the key cannot be used.

" + } + } + }, + "UpdateServerCertificateRequest":{ + "type":"structure", + "required":["ServerCertificateName"], + "members":{ + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name of the server certificate that you want to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

The new path for the server certificate. Include this only if you are updating the server certificate's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "NewServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The new name for the server certificate. Include this only if you are updating the server certificate's name. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + } + } + }, + "UpdateServiceSpecificCredentialRequest":{ + "type":"structure", + "required":[ + "ServiceSpecificCredentialId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user associated with the service-specific credential. If you do not specify this value, then the operation assumes the user whose credentials are used to call the operation.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "ServiceSpecificCredentialId":{ + "shape":"serviceSpecificCredentialId", + "documentation":"

The unique identifier of the service-specific credential.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status to be assigned to the service-specific credential.

" + } + } + }, + "UpdateSigningCertificateRequest":{ + "type":"structure", + "required":[ + "CertificateId", + "Status" + ], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the IAM user the signing certificate belongs to.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "CertificateId":{ + "shape":"certificateIdType", + "documentation":"

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

" + }, + "Status":{ + "shape":"statusType", + "documentation":"

The status you want to assign to the certificate. Active means that the certificate can be used for API calls to AWS Inactive means that the certificate cannot be used.

" + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["UserName"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

Name of the user to update. If you're changing the name of the user, this is the original user name.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "NewPath":{ + "shape":"pathType", + "documentation":"

New path for the IAM user. Include this parameter only if you're changing the user's path.

This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

" + }, + "NewUserName":{ + "shape":"userNameType", + "documentation":"

New name for the user. Include this parameter only if you're changing the user's name.

IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case. For example, you cannot create resources named both \"MyResource\" and \"myresource\".

" + } + } + }, + "UploadSSHPublicKeyRequest":{ + "type":"structure", + "required":[ + "UserName", + "SSHPublicKeyBody" + ], + "members":{ + "UserName":{ + "shape":"userNameType", + "documentation":"

The name of the IAM user to associate the SSH public key with.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "SSHPublicKeyBody":{ + "shape":"publicKeyMaterialType", + "documentation":"

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format. The minimum bit-length of the public key is 2048 bits. For example, you can generate a 2048-bit key, and the resulting PEM file is 1679 bytes long.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "UploadSSHPublicKeyResponse":{ + "type":"structure", + "members":{ + "SSHPublicKey":{ + "shape":"SSHPublicKey", + "documentation":"

Contains information about the SSH public key.

" + } + }, + "documentation":"

Contains the response to a successful UploadSSHPublicKey request.

" + }, + "UploadServerCertificateRequest":{ + "type":"structure", + "required":[ + "ServerCertificateName", + "CertificateBody", + "PrivateKey" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path for the server certificate. For more information about paths, see IAM Identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (\\u0021) through the DEL character (\\u007F), including most punctuation characters, digits, and upper and lowercased letters.

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

" + }, + "ServerCertificateName":{ + "shape":"serverCertificateNameType", + "documentation":"

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the public key certificate in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "PrivateKey":{ + "shape":"privateKeyType", + "documentation":"

The contents of the private key in PEM-encoded format.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + }, + "CertificateChain":{ + "shape":"certificateChainType", + "documentation":"

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "UploadServerCertificateResponse":{ + "type":"structure", + "members":{ + "ServerCertificateMetadata":{ + "shape":"ServerCertificateMetadata", + "documentation":"

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

" + } + }, + "documentation":"

Contains the response to a successful UploadServerCertificate request.

" + }, + "UploadSigningCertificateRequest":{ + "type":"structure", + "required":["CertificateBody"], + "members":{ + "UserName":{ + "shape":"existingUserNameType", + "documentation":"

The name of the user the signing certificate is for.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

" + }, + "CertificateBody":{ + "shape":"certificateBodyType", + "documentation":"

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \\u00FF)

  • The special characters tab (\\u0009), line feed (\\u000A), and carriage return (\\u000D)

" + } + } + }, + "UploadSigningCertificateResponse":{ + "type":"structure", + "required":["Certificate"], + "members":{ + "Certificate":{ + "shape":"SigningCertificate", + "documentation":"

Information about the certificate.

" + } + }, + "documentation":"

Contains the response to a successful UploadSigningCertificate request.

" + }, + "User":{ + "type":"structure", + "required":[ + "Path", + "UserName", + "UserId", + "Arn", + "CreateDate" + ], + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

The friendly name identifying the user.

" + }, + "UserId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{ + "shape":"arnType", + "documentation":"

The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the Using IAM guide.

" + }, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" + }, + "PasswordLastUsed":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the user's password was last used to sign in to an AWS website. For a list of AWS websites that capture a user's last sign-in time, see the Credential Reports topic in the Using IAM guide. If a password is used more than once in a five-minute span, only the first use is returned in this field. If the field is null (no value), then it indicates that they never signed in with a password. This can be because:

  • The user never had a password.

  • A password exists but has not been used since IAM started tracking this information on October 20, 2014.

A null value does not mean that the user never had a password. Also, if the user does not currently have a password, but had one in the past, then this field contains the date and time the most recent password was used.

This value is returned only in the GetUser and ListUsers operations.

" + }, + "PermissionsBoundary":{ + "shape":"AttachedPermissionsBoundary", + "documentation":"

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about an IAM user entity.

This data type is used as a response element in the following operations:

" + }, + "UserDetail":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"pathType", + "documentation":"

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

" + }, + "UserName":{ + "shape":"userNameType", + "documentation":"

The friendly name identifying the user.

" + }, + "UserId":{ + "shape":"idType", + "documentation":"

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

" + }, + "Arn":{"shape":"arnType"}, + "CreateDate":{ + "shape":"dateType", + "documentation":"

The date and time, in ISO 8601 date-time format, when the user was created.

" + }, + "UserPolicyList":{ + "shape":"policyDetailListType", + "documentation":"

A list of the inline policies embedded in the user.

" + }, + "GroupList":{ + "shape":"groupNameListType", + "documentation":"

A list of IAM groups that the user is in.

" + }, + "AttachedManagedPolicies":{ + "shape":"attachedPoliciesListType", + "documentation":"

A list of the managed policies attached to the user.

" + }, + "PermissionsBoundary":{ + "shape":"AttachedPermissionsBoundary", + "documentation":"

The ARN of the policy used to set the permissions boundary for the user.

For more information about permissions boundaries, see Permissions Boundaries for IAM Identities in the IAM User Guide.

" + }, + "Tags":{ + "shape":"tagListType", + "documentation":"

A list of tags that are associated with the specified user. For more information about tagging, see Tagging IAM Identities in the IAM User Guide.

" + } + }, + "documentation":"

Contains information about an IAM user, including all the user's policies and all the IAM groups the user is in.

This data type is used as a response element in the GetAccountAuthorizationDetails operation.

" + }, + "VirtualMFADevice":{ + "type":"structure", + "required":["SerialNumber"], + "members":{ + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

The serial number associated with VirtualMFADevice.

" + }, + "Base32StringSeed":{ + "shape":"BootstrapDatum", + "documentation":"

The base32 seed defined as specified in RFC3548. The Base32StringSeed is base64-encoded.

" + }, + "QRCodePNG":{ + "shape":"BootstrapDatum", + "documentation":"

A QR code PNG image that encodes otpauth://totp/$virtualMFADeviceName@$AccountName?secret=$Base32String where $virtualMFADeviceName is one of the create call arguments. AccountName is the user name if set (otherwise, the account ID otherwise), and Base32String is the seed in base32 format. The Base32String value is base64-encoded.

" + }, + "User":{ + "shape":"User", + "documentation":"

The IAM user associated with this virtual MFA device.

" + }, + "EnableDate":{ + "shape":"dateType", + "documentation":"

The date and time on which the virtual MFA device was enabled.

" + } + }, + "documentation":"

Contains information about a virtual MFA device.

" + }, + "accessKeyIdType":{ + "type":"string", + "max":128, + "min":16, + "pattern":"[\\w]+" + }, + "accessKeyMetadataListType":{ + "type":"list", + "member":{"shape":"AccessKeyMetadata"}, + "documentation":"

Contains a list of access key metadata.

This data type is used as a response element in the ListAccessKeys operation.

" + }, + "accessKeySecretType":{ + "type":"string", + "sensitive":true + }, + "accountAliasListType":{ + "type":"list", + "member":{"shape":"accountAliasType"} + }, + "accountAliasType":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$" + }, + "arnType":{ + "type":"string", + "documentation":"

The Amazon Resource Name (ARN). ARNs are unique identifiers for AWS resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

", + "max":2048, + "min":20 + }, + "assignmentStatusType":{ + "type":"string", + "enum":[ + "Assigned", + "Unassigned", + "Any" + ] + }, + "attachedPoliciesListType":{ + "type":"list", + "member":{"shape":"AttachedPolicy"} + }, + "attachmentCountType":{"type":"integer"}, + "authenticationCodeType":{ + "type":"string", + "max":6, + "min":6, + "pattern":"[\\d]+" + }, + "booleanObjectType":{ + "type":"boolean", + "box":true + }, + "booleanType":{"type":"boolean"}, + "certificateBodyType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "certificateChainType":{ + "type":"string", + "max":2097152, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "certificateIdType":{ + "type":"string", + "max":128, + "min":24, + "pattern":"[\\w]+" + }, + "certificateListType":{ + "type":"list", + "member":{"shape":"SigningCertificate"}, + "documentation":"

Contains a list of signing certificates.

This data type is used as a response element in the ListSigningCertificates operation.

" + }, + "clientIDListType":{ + "type":"list", + "member":{"shape":"clientIDType"} + }, + "clientIDType":{ + "type":"string", + "max":255, + "min":1 + }, + "credentialReportExpiredExceptionMessage":{"type":"string"}, + "credentialReportNotPresentExceptionMessage":{"type":"string"}, + "credentialReportNotReadyExceptionMessage":{"type":"string"}, + "customSuffixType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "dateType":{"type":"timestamp"}, + "deleteConflictMessage":{"type":"string"}, + "duplicateCertificateMessage":{"type":"string"}, + "duplicateSSHPublicKeyMessage":{"type":"string"}, + "encodingType":{ + "type":"string", + "enum":[ + "SSH", + "PEM" + ] + }, + "entityAlreadyExistsMessage":{"type":"string"}, + "entityDetailsListType":{ + "type":"list", + "member":{"shape":"EntityDetails"} + }, + "entityListType":{ + "type":"list", + "member":{"shape":"EntityType"} + }, + "entityNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "entityTemporarilyUnmodifiableMessage":{"type":"string"}, + "existingUserNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "globalEndpointTokenVersion":{ + "type":"string", + "enum":[ + "v1Token", + "v2Token" + ] + }, + "groupDetailListType":{ + "type":"list", + "member":{"shape":"GroupDetail"} + }, + "groupListType":{ + "type":"list", + "member":{"shape":"Group"}, + "documentation":"

Contains a list of IAM groups.

This data type is used as a response element in the ListGroups operation.

" + }, + "groupNameListType":{ + "type":"list", + "member":{"shape":"groupNameType"} + }, + "groupNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "idType":{ + "type":"string", + "max":128, + "min":16, + "pattern":"[\\w]+" + }, + "instanceProfileListType":{ + "type":"list", + "member":{"shape":"InstanceProfile"}, + "documentation":"

Contains a list of instance profiles.

" + }, + "instanceProfileNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "integerType":{"type":"integer"}, + "invalidAuthenticationCodeMessage":{"type":"string"}, + "invalidCertificateMessage":{"type":"string"}, + "invalidInputMessage":{"type":"string"}, + "invalidPublicKeyMessage":{"type":"string"}, + "invalidUserTypeMessage":{"type":"string"}, + "jobIDType":{ + "type":"string", + "max":36, + "min":36 + }, + "jobStatusType":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED" + ] + }, + "keyPairMismatchMessage":{"type":"string"}, + "limitExceededMessage":{"type":"string"}, + "listPolicyGrantingServiceAccessResponseListType":{ + "type":"list", + "member":{"shape":"ListPoliciesGrantingServiceAccessEntry"} + }, + "malformedCertificateMessage":{"type":"string"}, + "malformedPolicyDocumentMessage":{"type":"string"}, + "markerType":{ + "type":"string", + "max":320, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "maxItemsType":{ + "type":"integer", + "max":1000, + "min":1 + }, + "maxPasswordAgeType":{ + "type":"integer", + "box":true, + "max":1095, + "min":1 + }, + "mfaDeviceListType":{ + "type":"list", + "member":{"shape":"MFADevice"}, + "documentation":"

Contains a list of MFA devices.

This data type is used as a response element in the ListMFADevices and ListVirtualMFADevices operations.

" + }, + "minimumPasswordLengthType":{ + "type":"integer", + "max":128, + "min":6 + }, + "noSuchEntityMessage":{"type":"string"}, + "organizationsEntityPathType":{ + "type":"string", + "max":427, + "min":19, + "pattern":"^o-[0-9a-z]{10,32}\\/r-[0-9a-z]{4,32}[0-9a-z-\\/]*" + }, + "organizationsPolicyIdType":{ + "type":"string", + "pattern":"^p-[0-9a-zA-Z_]{8,128}$" + }, + "passwordPolicyViolationMessage":{"type":"string"}, + "passwordReusePreventionType":{ + "type":"integer", + "box":true, + "max":24, + "min":1 + }, + "passwordType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "sensitive":true + }, + "pathPrefixType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"\\u002F[\\u0021-\\u007F]*" + }, + "pathType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"(\\u002F)|(\\u002F[\\u0021-\\u007F]+\\u002F)" + }, + "policyDescriptionType":{ + "type":"string", + "max":1000 + }, + "policyDetailListType":{ + "type":"list", + "member":{"shape":"PolicyDetail"} + }, + "policyDocumentType":{ + "type":"string", + "max":131072, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "policyDocumentVersionListType":{ + "type":"list", + "member":{"shape":"PolicyVersion"} + }, + "policyEvaluationErrorMessage":{"type":"string"}, + "policyGrantingServiceAccessListType":{ + "type":"list", + "member":{"shape":"PolicyGrantingServiceAccess"} + }, + "policyListType":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "policyNameListType":{ + "type":"list", + "member":{"shape":"policyNameType"}, + "documentation":"

Contains a list of policy names.

This data type is used as a response element in the ListPolicies operation.

" + }, + "policyNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "policyNotAttachableMessage":{"type":"string"}, + "policyOwnerEntityType":{ + "type":"string", + "enum":[ + "USER", + "ROLE", + "GROUP" + ] + }, + "policyPathType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"((/[A-Za-z0-9\\.,\\+@=_-]+)*)/" + }, + "policyScopeType":{ + "type":"string", + "enum":[ + "All", + "AWS", + "Local" + ] + }, + "policyType":{ + "type":"string", + "enum":[ + "INLINE", + "MANAGED" + ] + }, + "policyVersionIdType":{ + "type":"string", + "pattern":"v[1-9][0-9]*(\\.[A-Za-z0-9-]*)?" + }, + "privateKeyType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+", + "sensitive":true + }, + "publicKeyFingerprintType":{ + "type":"string", + "max":48, + "min":48, + "pattern":"[:\\w]+" + }, + "publicKeyIdType":{ + "type":"string", + "max":128, + "min":20, + "pattern":"[\\w]+" + }, + "publicKeyMaterialType":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "reportGenerationLimitExceededMessage":{"type":"string"}, + "responseMarkerType":{"type":"string"}, + "roleDescriptionType":{ + "type":"string", + "max":1000, + "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" + }, + "roleDetailListType":{ + "type":"list", + "member":{"shape":"RoleDetail"} + }, + "roleListType":{ + "type":"list", + "member":{"shape":"Role"}, + "documentation":"

Contains a list of IAM roles.

This data type is used as a response element in the ListRoles operation.

" + }, + "roleMaxSessionDurationType":{ + "type":"integer", + "max":43200, + "min":3600 + }, + "roleNameType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "serialNumberType":{ + "type":"string", + "max":256, + "min":9, + "pattern":"[\\w+=/:,.@-]+" + }, + "serverCertificateMetadataListType":{ + "type":"list", + "member":{"shape":"ServerCertificateMetadata"} + }, + "serverCertificateNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "serviceFailureExceptionMessage":{"type":"string"}, + "serviceName":{"type":"string"}, + "serviceNameType":{"type":"string"}, + "serviceNamespaceListType":{ + "type":"list", + "member":{"shape":"serviceNamespaceType"}, + "max":200, + "min":1 + }, + "serviceNamespaceType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w-]*" + }, + "serviceNotSupportedMessage":{"type":"string"}, + "servicePassword":{ + "type":"string", + "sensitive":true + }, + "serviceSpecificCredentialId":{ + "type":"string", + "max":128, + "min":20, + "pattern":"[\\w]+" + }, + "serviceUserName":{ + "type":"string", + "max":200, + "min":17, + "pattern":"[\\w+=,.@-]+" + }, + "sortKeyType":{ + "type":"string", + "enum":[ + "SERVICE_NAMESPACE_ASCENDING", + "SERVICE_NAMESPACE_DESCENDING", + "LAST_AUTHENTICATED_TIME_ASCENDING", + "LAST_AUTHENTICATED_TIME_DESCENDING" + ] + }, + "statusType":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "stringType":{"type":"string"}, + "summaryKeyType":{ + "type":"string", + "enum":[ + "Users", + "UsersQuota", + "Groups", + "GroupsQuota", + "ServerCertificates", + "ServerCertificatesQuota", + "UserPolicySizeQuota", + "GroupPolicySizeQuota", + "GroupsPerUserQuota", + "SigningCertificatesPerUserQuota", + "AccessKeysPerUserQuota", + "MFADevices", + "MFADevicesInUse", + "AccountMFAEnabled", + "AccountAccessKeysPresent", + "AccountSigningCertificatesPresent", + "AttachedPoliciesPerGroupQuota", + "AttachedPoliciesPerRoleQuota", + "AttachedPoliciesPerUserQuota", + "Policies", + "PoliciesQuota", + "PolicySizeQuota", + "PolicyVersionsInUse", + "PolicyVersionsInUseQuota", + "VersionsPerPolicyQuota", + "GlobalEndpointTokenVersion" + ] + }, + "summaryMapType":{ + "type":"map", + "key":{"shape":"summaryKeyType"}, + "value":{"shape":"summaryValueType"} + }, + "summaryValueType":{"type":"integer"}, + "tagKeyListType":{ + "type":"list", + "member":{"shape":"tagKeyType"}, + "max":50 + }, + "tagKeyType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+" + }, + "tagListType":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50 + }, + "tagValueType":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*" + }, + "thumbprintListType":{ + "type":"list", + "member":{"shape":"thumbprintType"}, + "documentation":"

Contains a list of thumbprints of identity provider server certificates.

" + }, + "thumbprintType":{ + "type":"string", + "documentation":"

Contains a thumbprint for an identity provider's server certificate.

The identity provider's server certificate thumbprint is the hex-encoded SHA-1 hash value of the self-signed X.509 certificate used by the domain where the OpenID Connect provider makes its keys available. It is always a 40-character string.

", + "max":40, + "min":40 + }, + "unmodifiableEntityMessage":{"type":"string"}, + "unrecognizedPublicKeyEncodingMessage":{"type":"string"}, + "userDetailListType":{ + "type":"list", + "member":{"shape":"UserDetail"} + }, + "userListType":{ + "type":"list", + "member":{"shape":"User"}, + "documentation":"

Contains a list of users.

This data type is used as a response element in the GetGroup and ListUsers operations.

" + }, + "userNameType":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "virtualMFADeviceListType":{ + "type":"list", + "member":{"shape":"VirtualMFADevice"} + }, + "virtualMFADeviceName":{ + "type":"string", + "min":1, + "pattern":"[\\w+=,.@-]+" + } + }, + "documentation":"AWS Identity and Access Management

AWS Identity and Access Management (IAM) is a web service that you can use to manage users and user permissions under your AWS account. This guide provides descriptions of IAM actions that you can call programmatically. For general information about IAM, see AWS Identity and Access Management (IAM). For the user guide for IAM, see Using IAM.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to IAM and AWS. For example, the SDKs take care of tasks such as cryptographically signing requests (see below), managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

We recommend that you use the AWS SDKs to make programmatic API calls to IAM. However, you can also use the IAM Query API to make direct calls to the IAM web service. To learn more about the IAM Query API, see Making Query Requests in the Using IAM guide. IAM supports GET and POST requests for all actions. That is, the API does not require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Signing Requests

Requests must be signed using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account access key ID and secret access key for everyday work with IAM. You can use the access key ID and secret access key for an IAM user or you can use the AWS Security Token Service to generate temporary security credentials and use those to sign requests.

To sign requests, we recommend that you use Signature Version 4. If you have an existing application that uses Signature Version 2, you do not have to update it to use Signature Version 4. However, some operations now require Signature Version 4. The documentation for operations that require version 4 indicate this requirement.

Additional Resources

For more information, see the following:

  • AWS Security Credentials. This topic provides general information about the types of credentials used for accessing AWS.

  • IAM Best Practices. This topic presents a list of suggestions for using the IAM service to help secure your AWS resources.

  • Signing AWS API Requests. This set of topics walk you through the process of signing a request using an access key ID and secret access key.

" +} diff --git a/aws/dist/botocore/data/iam/2010-05-08/waiters-2.json b/aws/dist/botocore/data/iam/2010-05-08/waiters-2.json new file mode 100644 index 00000000..62480415 --- /dev/null +++ b/aws/dist/botocore/data/iam/2010-05-08/waiters-2.json @@ -0,0 +1,73 @@ +{ + "version": 2, + "waiters": { + "InstanceProfileExists": { + "delay": 1, + "operation": "GetInstanceProfile", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "state": "retry", + "matcher": "status", + "expected": 404 + } + ] + }, + "UserExists": { + "delay": 1, + "operation": "GetUser", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + }, + "RoleExists": { + "delay": 1, + "operation": "GetRole", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + }, + "PolicyExists": { + "delay": 1, + "operation": "GetPolicy", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "NoSuchEntity" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/importexport/2010-06-01/paginators-1.json b/aws/dist/botocore/data/importexport/2010-06-01/paginators-1.json new file mode 100644 index 00000000..702385ea --- /dev/null +++ b/aws/dist/botocore/data/importexport/2010-06-01/paginators-1.json @@ -0,0 +1,11 @@ +{ + "pagination": { + "ListJobs": { + "input_token": "Marker", + "output_token": "Jobs[-1].JobId", + "more_results": "IsTruncated", + "limit_key": "MaxJobs", + "result_key": "Jobs" + } + } +} diff --git a/aws/dist/botocore/data/importexport/2010-06-01/service-2.json b/aws/dist/botocore/data/importexport/2010-06-01/service-2.json new file mode 100644 index 00000000..64d0ad11 --- /dev/null +++ b/aws/dist/botocore/data/importexport/2010-06-01/service-2.json @@ -0,0 +1,898 @@ +{ + "version":"2.0", + "metadata":{ + "uid":"importexport-2010-06-01", + "apiVersion":"2010-06-01", + "endpointPrefix":"importexport", + "globalEndpoint":"importexport.amazonaws.com", + "serviceFullName":"AWS Import/Export", + "serviceId":"ImportExport", + "signatureVersion":"v2", + "xmlNamespace":"http://importexport.amazonaws.com/doc/2010-06-01/", + "protocol":"query" + }, + "documentation":"AWS Import/Export Service AWS Import/Export accelerates transferring large amounts of data between the AWS cloud and portable storage devices that you mail to us. AWS Import/Export transfers data directly onto and off of your storage devices using Amazon's high-speed internal network and bypassing the Internet. For large data sets, AWS Import/Export is often faster than Internet transfer and more cost effective than upgrading your connectivity.", + "operations":{ + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CancelJob" + }, + "input":{ + "shape":"CancelJobInput", + "documentation":"Input structure for the CancelJob operation." + }, + "output":{ + "shape":"CancelJobOutput", + "documentation":"Output structure for the CancelJob operation.", + "resultWrapper":"CancelJobResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"UnableToCancelJobIdException", + "exception":true, + "documentation":"AWS Import/Export cannot cancel the job" + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + } + ], + "documentation":"This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete." + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=CreateJob" + }, + "input":{ + "shape":"CreateJobInput", + "documentation":"Input structure for the CreateJob operation." + }, + "output":{ + "shape":"CreateJobOutput", + "documentation":"Output structure for the CreateJob operation.", + "resultWrapper":"CreateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidAddressException", + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + { + "shape":"InvalidManifestFieldException", + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + { + "shape":"MissingManifestFieldException", + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + { + "shape":"NoSuchBucketException", + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." + }, + { + "shape":"MissingCustomsException", + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + { + "shape":"InvalidCustomsException", + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidFileSystemException", + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + { + "shape":"MultipleRegionsException", + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." + }, + { + "shape":"BucketPermissionException", + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + { + "shape":"MalformedManifestException", + "exception":true, + "documentation":"Your manifest is not well-formed." + }, + { + "shape":"CreateJobQuotaExceededException", + "exception":true, + "documentation":"Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case." + }, + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + } + ], + "documentation":"This operation initiates the process of scheduling an upload or download of your data. You include in the request a manifest that describes the data transfer specifics. The response to the request includes a job ID, which you can use in other operations, a signature that you use to identify your storage device, and the address where you should ship your storage device." + }, + "GetShippingLabel":{ + "name":"GetShippingLabel", + "http":{ + "method":"POST", + "requestUri":"/?Operation=GetShippingLabel" + }, + "input":{"shape":"GetShippingLabelInput"}, + "output":{ + "shape":"GetShippingLabelOutput", + "resultWrapper":"GetShippingLabelResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidAddressException", + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + } + ], + "documentation":"This operation generates a pre-paid UPS shipping label that you will use to ship your device to AWS for processing." + }, + "GetStatus":{ + "name":"GetStatus", + "http":{ + "method":"POST", + "requestUri":"/?Operation=GetStatus" + }, + "input":{ + "shape":"GetStatusInput", + "documentation":"Input structure for the GetStatus operation." + }, + "output":{ + "shape":"GetStatusOutput", + "documentation":"Output structure for the GetStatus operation.", + "resultWrapper":"GetStatusResult" + }, + "errors":[ + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + } + ], + "documentation":"This operation returns information about a job, including where the job is in the processing pipeline, the status of the results, and the signature value associated with the job. You can only return information about jobs you own." + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/?Operation=ListJobs" + }, + "input":{ + "shape":"ListJobsInput", + "documentation":"Input structure for the ListJobs operation." + }, + "output":{ + "shape":"ListJobsOutput", + "documentation":"Output structure for the ListJobs operation.", + "resultWrapper":"ListJobsResult" + }, + "errors":[ + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + } + ], + "documentation":"This operation returns the jobs associated with the requester. AWS Import/Export lists the jobs in reverse chronological order based on the date of creation. For example if Job Test1 was created 2009Dec30 and Test2 was created 2010Feb05, the ListJobs operation would return Test2 followed by Test1." + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"POST", + "requestUri":"/?Operation=UpdateJob" + }, + "input":{ + "shape":"UpdateJobInput", + "documentation":"Input structure for the UpateJob operation." + }, + "output":{ + "shape":"UpdateJobOutput", + "documentation":"Output structure for the UpateJob operation.", + "resultWrapper":"UpdateJobResult" + }, + "errors":[ + { + "shape":"MissingParameterException", + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + { + "shape":"InvalidParameterException", + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + { + "shape":"InvalidAccessKeyIdException", + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + { + "shape":"InvalidAddressException", + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + { + "shape":"InvalidManifestFieldException", + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidJobIdException", + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + { + "shape":"MissingManifestFieldException", + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + { + "shape":"NoSuchBucketException", + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." + }, + { + "shape":"ExpiredJobIdException", + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + { + "shape":"CanceledJobIdException", + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + { + "shape":"MissingCustomsException", + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + { + "shape":"InvalidCustomsException", + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + { + "shape":"InvalidFileSystemException", + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + { + "shape":"MultipleRegionsException", + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." + }, + { + "shape":"BucketPermissionException", + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + { + "shape":"MalformedManifestException", + "exception":true, + "documentation":"Your manifest is not well-formed." + }, + { + "shape":"UnableToUpdateJobIdException", + "exception":true, + "documentation":"AWS Import/Export cannot update the job" + }, + { + "shape":"InvalidVersionException", + "exception":true, + "documentation":"The client tool version is invalid." + } + ], + "documentation":"You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own." + } + }, + "shapes":{ + "APIVersion":{ + "type":"string", + "documentation":"Specifies the version of the client tool." + }, + "Artifact":{ + "type":"structure", + "members":{ + "Description":{"shape":"Description"}, + "URL":{"shape":"URL"} + }, + "documentation":"A discrete item that contains the description and URL of an artifact (such as a PDF)." + }, + "ArtifactList":{ + "type":"list", + "member":{"shape":"Artifact"}, + "documentation":"A collection of artifacts." + }, + "BucketPermissionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The account specified does not have the appropriate bucket permissions." + }, + "CancelJobInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"}, + "APIVersion":{"shape":"APIVersion"} + }, + "documentation":"Input structure for the CancelJob operation." + }, + "CancelJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"} + }, + "documentation":"Output structure for the CancelJob operation." + }, + "CanceledJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The specified job ID has been canceled and is no longer valid." + }, + "Carrier":{ + "type":"string", + "documentation":"Name of the shipping company. This value is included when the LocationCode is \"Returned\"." + }, + "CreateJobInput":{ + "type":"structure", + "required":[ + "JobType", + "Manifest", + "ValidateOnly" + ], + "members":{ + "JobType":{"shape":"JobType"}, + "Manifest":{"shape":"Manifest"}, + "ManifestAddendum":{"shape":"ManifestAddendum"}, + "ValidateOnly":{"shape":"ValidateOnly"}, + "APIVersion":{"shape":"APIVersion"} + }, + "documentation":"Input structure for the CreateJob operation." + }, + "CreateJobOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"SignatureFileContents"}, + "WarningMessage":{"shape":"WarningMessage"}, + "ArtifactList":{"shape":"ArtifactList"} + }, + "documentation":"Output structure for the CreateJob operation." + }, + "CreateJobQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Each account can create only a certain number of jobs per day. If you need to create more than this, please contact awsimportexport@amazon.com to explain your particular use case." + }, + "CreationDate":{ + "type":"timestamp", + "documentation":"Timestamp of the CreateJob request in ISO8601 date format. For example \"2010-03-28T20:27:35Z\"." + }, + "CurrentManifest":{ + "type":"string", + "documentation":"The last manifest submitted, which will be used to process the job." + }, + "Description":{ + "type":"string", + "documentation":"The associated description for this object." + }, + "ErrorCount":{ + "type":"integer", + "documentation":"Number of errors. We return this value when the ProgressCode is Success or SuccessWithErrors." + }, + "ErrorMessage":{ + "type":"string", + "documentation":"The human-readable description of a particular error." + }, + "ExpiredJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Indicates that the specified job has expired out of the system." + }, + "GenericString":{"type":"string"}, + "GetShippingLabelInput":{ + "type":"structure", + "required":["jobIds"], + "members":{ + "jobIds":{"shape":"JobIdList"}, + "name":{"shape":"name"}, + "company":{"shape":"company"}, + "phoneNumber":{"shape":"phoneNumber"}, + "country":{"shape":"country"}, + "stateOrProvince":{"shape":"stateOrProvince"}, + "city":{"shape":"city"}, + "postalCode":{"shape":"postalCode"}, + "street1":{"shape":"street1"}, + "street2":{"shape":"street2"}, + "street3":{"shape":"street3"}, + "APIVersion":{"shape":"APIVersion"} + } + }, + "GetShippingLabelOutput":{ + "type":"structure", + "members":{ + "ShippingLabelURL":{"shape":"GenericString"}, + "Warning":{"shape":"GenericString"} + } + }, + "GetStatusInput":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"}, + "APIVersion":{"shape":"APIVersion"} + }, + "documentation":"Input structure for the GetStatus operation." + }, + "GetStatusOutput":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobType":{"shape":"JobType"}, + "LocationCode":{"shape":"LocationCode"}, + "LocationMessage":{"shape":"LocationMessage"}, + "ProgressCode":{"shape":"ProgressCode"}, + "ProgressMessage":{"shape":"ProgressMessage"}, + "Carrier":{"shape":"Carrier"}, + "TrackingNumber":{"shape":"TrackingNumber"}, + "LogBucket":{"shape":"LogBucket"}, + "LogKey":{"shape":"LogKey"}, + "ErrorCount":{"shape":"ErrorCount"}, + "Signature":{"shape":"Signature"}, + "SignatureFileContents":{"shape":"Signature"}, + "CurrentManifest":{"shape":"CurrentManifest"}, + "CreationDate":{"shape":"CreationDate"}, + "ArtifactList":{"shape":"ArtifactList"} + }, + "documentation":"Output structure for the GetStatus operation." + }, + "InvalidAccessKeyIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The AWS Access Key ID specified in the request did not match the manifest's accessKeyId value. The manifest and the request authentication must use the same AWS Access Key ID." + }, + "InvalidAddressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The address specified in the manifest is invalid." + }, + "InvalidCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more customs parameters was invalid. Please correct and resubmit." + }, + "InvalidFileSystemException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"File system specified in export manifest is invalid." + }, + "InvalidJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The JOBID was missing, not found, or not associated with the AWS account." + }, + "InvalidManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more manifest fields was invalid. Please correct and resubmit." + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more parameters had an invalid value." + }, + "InvalidVersionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The client tool version is invalid." + }, + "IsCanceled":{ + "type":"boolean", + "documentation":"Indicates whether the job was canceled." + }, + "IsTruncated":{ + "type":"boolean", + "documentation":"Indicates whether the list of jobs was truncated. If true, then call ListJobs again using the last JobId element as the marker." + }, + "Job":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "CreationDate":{"shape":"CreationDate"}, + "IsCanceled":{"shape":"IsCanceled"}, + "JobType":{"shape":"JobType"} + }, + "documentation":"Representation of a job returned by the ListJobs operation." + }, + "JobId":{ + "type":"string", + "documentation":"A unique identifier which refers to a particular job." + }, + "JobIdList":{ + "type":"list", + "member":{"shape":"GenericString"} + }, + "JobType":{ + "type":"string", + "enum":[ + "Import", + "Export" + ], + "documentation":"Specifies whether the job to initiate is an import or export job." + }, + "JobsList":{ + "type":"list", + "member":{"shape":"Job"}, + "documentation":"A list container for Jobs returned by the ListJobs operation." + }, + "ListJobsInput":{ + "type":"structure", + "members":{ + "MaxJobs":{"shape":"MaxJobs"}, + "Marker":{"shape":"Marker"}, + "APIVersion":{"shape":"APIVersion"} + }, + "documentation":"Input structure for the ListJobs operation." + }, + "ListJobsOutput":{ + "type":"structure", + "members":{ + "Jobs":{"shape":"JobsList"}, + "IsTruncated":{"shape":"IsTruncated"} + }, + "documentation":"Output structure for the ListJobs operation." + }, + "LocationCode":{ + "type":"string", + "documentation":"A token representing the location of the storage device, such as \"AtAWS\"." + }, + "LocationMessage":{ + "type":"string", + "documentation":"A more human readable form of the physical location of the storage device." + }, + "LogBucket":{ + "type":"string", + "documentation":"Amazon S3 bucket for user logs." + }, + "LogKey":{ + "type":"string", + "documentation":"The key where the user logs were stored." + }, + "MalformedManifestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Your manifest is not well-formed." + }, + "Manifest":{ + "type":"string", + "documentation":"The UTF-8 encoded text of the manifest file." + }, + "ManifestAddendum":{ + "type":"string", + "documentation":"For internal use only." + }, + "Marker":{ + "type":"string", + "documentation":"Specifies the JOBID to start after when listing the jobs created with your account. AWS Import/Export lists your jobs in reverse chronological order. See MaxJobs." + }, + "MaxJobs":{ + "type":"integer", + "documentation":"Sets the maximum number of jobs returned in the response. If there are additional jobs that were not returned because MaxJobs was exceeded, the response contains <IsTruncated>true</IsTruncated>. To return the additional jobs, see Marker." + }, + "MissingCustomsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required customs parameters was missing from the manifest." + }, + "MissingManifestFieldException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required fields were missing from the manifest file. Please correct and resubmit." + }, + "MissingParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"One or more required parameters was missing from the request." + }, + "MultipleRegionsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"Your manifest file contained buckets from multiple regions. A job is restricted to buckets from one region. Please correct and resubmit." + }, + "NoSuchBucketException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"The specified bucket does not exist. Create the specified bucket or change the manifest's bucket, exportBucket, or logBucket field to a bucket that the account, as specified by the manifest's Access Key ID, has write permissions to." + }, + "ProgressCode":{ + "type":"string", + "documentation":"A token representing the state of the job, such as \"Started\"." + }, + "ProgressMessage":{ + "type":"string", + "documentation":"A more human readable form of the job status." + }, + "Signature":{ + "type":"string", + "documentation":"An encrypted code used to authenticate the request and response, for example, \"DV+TpDfx1/TdSE9ktyK9k/bDTVI=\". Only use this value is you want to create the signature file yourself. Generally you should use the SignatureFileContents value." + }, + "SignatureFileContents":{ + "type":"string", + "documentation":"The actual text of the SIGNATURE file to be written to disk." + }, + "Success":{ + "type":"boolean", + "documentation":"Specifies whether (true) or not (false) AWS Import/Export updated your job." + }, + "TrackingNumber":{ + "type":"string", + "documentation":"The shipping tracking number assigned by AWS Import/Export to the storage device when it's returned to you. We return this value when the LocationCode is \"Returned\"." + }, + "URL":{ + "type":"string", + "documentation":"The URL for a given Artifact." + }, + "UnableToCancelJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"AWS Import/Export cannot cancel the job" + }, + "UnableToUpdateJobIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "documentation":"AWS Import/Export cannot update the job" + }, + "UpdateJobInput":{ + "type":"structure", + "required":[ + "JobId", + "Manifest", + "JobType", + "ValidateOnly" + ], + "members":{ + "JobId":{"shape":"JobId"}, + "Manifest":{"shape":"Manifest"}, + "JobType":{"shape":"JobType"}, + "ValidateOnly":{"shape":"ValidateOnly"}, + "APIVersion":{"shape":"APIVersion"} + }, + "documentation":"Input structure for the UpateJob operation." + }, + "UpdateJobOutput":{ + "type":"structure", + "members":{ + "Success":{"shape":"Success"}, + "WarningMessage":{"shape":"WarningMessage"}, + "ArtifactList":{"shape":"ArtifactList"} + }, + "documentation":"Output structure for the UpateJob operation." + }, + "ValidateOnly":{ + "type":"boolean", + "documentation":"Validate the manifest and parameter values in the request but do not actually create a job." + }, + "WarningMessage":{ + "type":"string", + "documentation":"An optional message notifying you of non-fatal issues with the job, such as use of an incompatible Amazon S3 bucket name." + }, + "city":{ + "type":"string", + "documentation":"Specifies the name of your city for the return address." + }, + "company":{ + "type":"string", + "documentation":"Specifies the name of the company that will ship this package." + }, + "country":{ + "type":"string", + "documentation":"Specifies the name of your country for the return address." + }, + "name":{ + "type":"string", + "documentation":"Specifies the name of the person responsible for shipping this package." + }, + "phoneNumber":{ + "type":"string", + "documentation":"Specifies the phone number of the person responsible for shipping this package." + }, + "postalCode":{ + "type":"string", + "documentation":"Specifies the postal code for the return address." + }, + "stateOrProvince":{ + "type":"string", + "documentation":"Specifies the name of your state or your province for the return address." + }, + "street1":{ + "type":"string", + "documentation":"Specifies the first part of the street address for the return address, for example 1234 Main Street." + }, + "street2":{ + "type":"string", + "documentation":"Specifies the optional second part of the street address for the return address, for example Suite 100." + }, + "street3":{ + "type":"string", + "documentation":"Specifies the optional third part of the street address for the return address, for example c/o Jane Doe." + } + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/inspector/2015-08-18/service-2.json b/aws/dist/botocore/data/inspector/2015-08-18/service-2.json new file mode 100644 index 00000000..e0c5637d --- /dev/null +++ b/aws/dist/botocore/data/inspector/2015-08-18/service-2.json @@ -0,0 +1,2101 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-08-18", + "endpointPrefix":"inspector", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Inspector", + "serviceId":"Inspector", + "signatureVersion":"v4", + "targetPrefix":"InspectorService" + }, + "operations":{ + "AddAttributesToFindings":{ + "name":"AddAttributesToFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAttributesToFindingsRequest"}, + "output":{"shape":"AddAttributesToFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Assigns attributes (key and value pair) to the findings specified by the findings' ARNs.

" + }, + "AttachAssessmentAndRulesPackage":{ + "name":"AttachAssessmentAndRulesPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachAssessmentAndRulesPackageRequest"}, + "output":{"shape":"AttachAssessmentAndRulesPackageResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Attaches the rules package specified by the rules package ARN to the assessment specified by the assessment ARN.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Creates a new application using the resource group ARN generated by CreateResourceGroup. You can create up to 50 applications per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Inspector Applications.

" + }, + "CreateAssessment":{ + "name":"CreateAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssessmentRequest"}, + "output":{"shape":"CreateAssessmentResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Creates an assessment for the application specified by the application ARN. You can create up to 500 assessments per AWS account.

" + }, + "CreateResourceGroup":{ + "name":"CreateResourceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceGroupRequest"}, + "output":{"shape":"CreateResourceGroupResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Inspector application. The created resource group is then used to create an Inspector application.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Deletes the application specified by the application ARN.

" + }, + "DeleteAssessment":{ + "name":"DeleteAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentRequest"}, + "output":{"shape":"DeleteAssessmentResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"OperationInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Deletes the assessment specified by the assessment ARN.

" + }, + "DeleteRun":{ + "name":"DeleteRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRunRequest"}, + "output":{"shape":"DeleteRunResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Deletes the assessment run specified by the run ARN.

" + }, + "DescribeApplication":{ + "name":"DescribeApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationRequest"}, + "output":{"shape":"DescribeApplicationResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the application specified by the application ARN.

" + }, + "DescribeAssessment":{ + "name":"DescribeAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentRequest"}, + "output":{"shape":"DescribeAssessmentResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the assessment specified by the assessment ARN.

" + }, + "DescribeCrossAccountAccessRole":{ + "name":"DescribeCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeCrossAccountAccessRoleResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Describes the IAM role that enables Inspector to access your AWS account.

" + }, + "DescribeFinding":{ + "name":"DescribeFinding", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFindingRequest"}, + "output":{"shape":"DescribeFindingResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the finding specified by the finding ARN.

" + }, + "DescribeResourceGroup":{ + "name":"DescribeResourceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceGroupRequest"}, + "output":{"shape":"DescribeResourceGroupResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the resource group specified by the resource group ARN.

" + }, + "DescribeRulesPackage":{ + "name":"DescribeRulesPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRulesPackageRequest"}, + "output":{"shape":"DescribeRulesPackageResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the rules package specified by the rules package ARN.

" + }, + "DescribeRun":{ + "name":"DescribeRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRunRequest"}, + "output":{"shape":"DescribeRunResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Describes the assessment run specified by the run ARN.

" + }, + "DetachAssessmentAndRulesPackage":{ + "name":"DetachAssessmentAndRulesPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachAssessmentAndRulesPackageRequest"}, + "output":{"shape":"DetachAssessmentAndRulesPackageResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Detaches the rules package specified by the rules package ARN from the assessment specified by the assessment ARN.

" + }, + "GetAssessmentTelemetry":{ + "name":"GetAssessmentTelemetry", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAssessmentTelemetryRequest"}, + "output":{"shape":"GetAssessmentTelemetryResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Returns the metadata about the telemetry (application behavioral data) for the assessment specified by the assessment ARN.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the ARNs of the applications within this AWS account. For more information about applications, see Inspector Applications.

" + }, + "ListAssessmentAgents":{ + "name":"ListAssessmentAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentAgentsRequest"}, + "output":{"shape":"ListAssessmentAgentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the agents of the assessment specified by the assessment ARN.

" + }, + "ListAssessments":{ + "name":"ListAssessments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentsRequest"}, + "output":{"shape":"ListAssessmentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the assessments corresponding to applications specified by the applications' ARNs.

" + }, + "ListAttachedAssessments":{ + "name":"ListAttachedAssessments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedAssessmentsRequest"}, + "output":{"shape":"ListAttachedAssessmentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the assessments attached to the rules package specified by the rules package ARN.

" + }, + "ListAttachedRulesPackages":{ + "name":"ListAttachedRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttachedRulesPackagesRequest"}, + "output":{"shape":"ListAttachedRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the rules packages attached to the assessment specified by the assessment ARN.

" + }, + "ListFindings":{ + "name":"ListFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFindingsRequest"}, + "output":{"shape":"ListFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists findings generated by the assessment run specified by the run ARNs.

" + }, + "ListRulesPackages":{ + "name":"ListRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesPackagesRequest"}, + "output":{"shape":"ListRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists all available Inspector rules packages.

" + }, + "ListRuns":{ + "name":"ListRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRunsRequest"}, + "output":{"shape":"ListRunsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the assessment runs associated with the assessments specified by the assessment ARNs.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists all tags associated with a resource.

" + }, + "LocalizeText":{ + "name":"LocalizeText", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LocalizeTextRequest"}, + "output":{"shape":"LocalizeTextResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Translates a textual identifier into a user-readable text in a specified locale.

" + }, + "PreviewAgentsForResourceGroup":{ + "name":"PreviewAgentsForResourceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PreviewAgentsForResourceGroupRequest"}, + "output":{"shape":"PreviewAgentsForResourceGroupResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"} + ], + "documentation":"

Previews the agents installed on the EC2 instances that are included in the application created with the specified resource group.

" + }, + "RegisterCrossAccountAccessRole":{ + "name":"RegisterCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterCrossAccountAccessRoleRequest"}, + "output":{"shape":"RegisterCrossAccountAccessRoleResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidCrossAccountRoleException"} + ], + "documentation":"

Register the role that Inspector uses to list your EC2 instances during the assessment.

" + }, + "RemoveAttributesFromFindings":{ + "name":"RemoveAttributesFromFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAttributesFromFindingsRequest"}, + "output":{"shape":"RemoveAttributesFromFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Removes the entire attribute (key and value pair) from the findings specified by the finding ARNs where an attribute with the specified key exists.

" + }, + "RunAssessment":{ + "name":"RunAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RunAssessmentRequest"}, + "output":{"shape":"RunAssessmentResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Starts the analysis of the application’s behavior against selected rule packages for the assessment specified by the assessment ARN.

" + }, + "SetTagsForResource":{ + "name":"SetTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTagsForResourceRequest"}, + "output":{"shape":"SetTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Sets tags (key and value pairs) to the assessment specified by the assessment ARN.

" + }, + "StartDataCollection":{ + "name":"StartDataCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDataCollectionRequest"}, + "output":{"shape":"StartDataCollectionResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"} + ], + "documentation":"

Starts data collection for the assessment specified by the assessment ARN. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

" + }, + "StopDataCollection":{ + "name":"StopDataCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDataCollectionRequest"}, + "output":{"shape":"StopDataCollectionResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Stop data collection for the assessment specified by the assessment ARN.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Updates application specified by the application ARN.

" + }, + "UpdateAssessment":{ + "name":"UpdateAssessment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssessmentRequest"}, + "output":{"shape":"UpdateAssessmentResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Updates the assessment specified by the assessment ARN.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "AddAttributesToFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributes" + ], + "members":{ + "findingArns":{ + "shape":"ArnList", + "documentation":"

The ARNs specifying the findings that you want to assign attributes to.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

The array of attributes that you want to assign to specified findings.

" + } + } + }, + "AddAttributesToFindingsResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Agent":{ + "type":"structure", + "members":{ + "agentId":{ + "shape":"AgentId", + "documentation":"

The EC2 instance ID where the agent is installed.

" + }, + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment that is associated with the agent.

" + }, + "agentHealth":{ + "shape":"AgentHealth", + "documentation":"

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

" + }, + "agentHealthCode":{ + "shape":"AgentHealthCode", + "documentation":"

The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.

" + }, + "agentHealthDetails":{ + "shape":"AgentHealthDetails", + "documentation":"

The description for the agent health code.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

This data type property is currently not used.

" + }, + "accountId":{ + "shape":"AwsAccount", + "documentation":"

AWS account of the EC2 instance where the agent is installed.

" + }, + "telemetry":{ + "shape":"TelemetryList", + "documentation":"

The Inspector application data metrics collected by the agent.

" + } + }, + "documentation":"

Contains information about an Inspector agent. This data type is used as a response element in the ListAssessmentAgents action.

" + }, + "AgentHealth":{"type":"string"}, + "AgentHealthCode":{"type":"string"}, + "AgentHealthDetails":{"type":"string"}, + "AgentHealthList":{ + "type":"list", + "member":{"shape":"AgentHealth"} + }, + "AgentId":{"type":"string"}, + "AgentList":{ + "type":"list", + "member":{"shape":"Agent"} + }, + "AgentPreview":{ + "type":"structure", + "members":{ + "agentId":{ + "shape":"AgentId", + "documentation":"

The id of the EC2 instance where the agent is intalled.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

The autoscaling group for the EC2 instance where the agent is installed.

" + } + }, + "documentation":"

This data type is used as a response element in the PreviewAgentsForResourceGroup action.

" + }, + "AgentPreviewList":{ + "type":"list", + "member":{"shape":"AgentPreview"} + }, + "AgentsFilter":{ + "type":"structure", + "members":{ + "agentHealthList":{ + "shape":"AgentHealthList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the agentHealth property of the Agent data type.

" + } + }, + "documentation":"

This data type is used as a response element in the ListAssessmentAgents action.

" + }, + "Application":{ + "type":"structure", + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the Inspector application.

" + }, + "applicationName":{ + "shape":"Name", + "documentation":"

The name of the Inspector application.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the resource group that is associated with the application.

" + } + }, + "documentation":"

Contains information about an Inspector application.

This data type is used as the response element in the DescribeApplication action.

" + }, + "ApplicationsFilter":{ + "type":"structure", + "members":{ + "applicationNamePatterns":{ + "shape":"NamePatternList", + "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.

" + } + }, + "documentation":"

This data type is used as the request parameter in the ListApplications action.

" + }, + "Arn":{"type":"string"}, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "Assessment":{ + "type":"structure", + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment.

" + }, + "assessmentName":{ + "shape":"Name", + "documentation":"

The name of the assessment.

" + }, + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN of the application that corresponds to this assessment.

" + }, + "assessmentState":{ + "shape":"AssessmentState", + "documentation":"

The state of the assessment. Values can be set to Created, Collecting Data, Stopping, and Completed.

" + }, + "failureMessage":{ + "shape":"FailureMessage", + "documentation":"

This data type property is not currently used.

" + }, + "dataCollected":{ + "shape":"Bool", + "documentation":"

Boolean value (true or false) specifying whether the data collection process is completed.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The assessment start time.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The assessment end time.

" + }, + "durationInSeconds":{ + "shape":"Duration", + "documentation":"

The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" + }, + "userAttributesForFindings":{ + "shape":"AttributeList", + "documentation":"

The user-defined attributes that are assigned to every generated finding.

" + } + }, + "documentation":"

Contains information about an Inspector assessment.

This data type is used as the response element in the DescribeAssessment action.

" + }, + "AssessmentState":{"type":"string"}, + "AssessmentStateList":{ + "type":"list", + "member":{"shape":"AssessmentState"} + }, + "AssessmentsFilter":{ + "type":"structure", + "members":{ + "assessmentNamePatterns":{ + "shape":"NamePatternList", + "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.

" + }, + "assessmentStates":{ + "shape":"AssessmentStateList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.

" + }, + "dataCollected":{ + "shape":"Bool", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.

" + }, + "startTimeRange":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the Assessment data type.

" + }, + "endTimeRange":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the endTime property of the Assessment data type.

" + }, + "durationRange":{ + "shape":"DurationRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the Assessment data type.

" + } + }, + "documentation":"

This data type is used as the request parameter in the ListAssessments and ListAttachedAssessments actions.

" + }, + "AttachAssessmentAndRulesPackageRequest":{ + "type":"structure", + "required":[ + "assessmentArn", + "rulesPackageArn" + ], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment to which you want to attach a rules package.

" + }, + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the rules package that you want to attach to the assessment.

" + } + } + }, + "AttachAssessmentAndRulesPackageResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Attribute":{ + "type":"structure", + "members":{ + "key":{ + "shape":"AttributeKey", + "documentation":"

The attribute key.

" + }, + "value":{ + "shape":"AttributeValue", + "documentation":"

The value assigned to the attribute key.

" + } + }, + "documentation":"

This data type is used as a response element in the AddAttributesToFindings action and a request parameter in the CreateAssessment action.

" + }, + "AttributeKey":{"type":"string"}, + "AttributeKeyList":{ + "type":"list", + "member":{"shape":"AttributeKey"} + }, + "AttributeList":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "AttributeValue":{"type":"string"}, + "AutoScalingGroup":{"type":"string"}, + "AwsAccount":{"type":"string"}, + "Bool":{"type":"boolean"}, + "CreateApplicationRequest":{ + "type":"structure", + "required":[ + "applicationName", + "resourceGroupArn" + ], + "members":{ + "applicationName":{ + "shape":"Name", + "documentation":"

The user-defined name identifying the application that you want to create. The name must be unique within the AWS account.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the resource group that is used to create the application.

" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the application that is created.

" + } + } + }, + "CreateAssessmentRequest":{ + "type":"structure", + "required":[ + "applicationArn", + "assessmentName", + "durationInSeconds" + ], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the application for which you want to create an assessment.

" + }, + "assessmentName":{ + "shape":"Name", + "documentation":"

The user-defined name identifying the assessment that you want to create. You can create several assessments for an application. The names of the assessments corresponding to a particular application must be unique.

" + }, + "durationInSeconds":{ + "shape":"Duration", + "documentation":"

The duration of the assessment in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" + }, + "userAttributesForFindings":{ + "shape":"AttributeList", + "documentation":"

The user-defined attributes that are assigned to every finding generated by running this assessment.

" + } + } + }, + "CreateAssessmentResponse":{ + "type":"structure", + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment that is created.

" + } + } + }, + "CreateResourceGroupRequest":{ + "type":"structure", + "required":["resourceGroupTags"], + "members":{ + "resourceGroupTags":{ + "shape":"ResourceGroupTags", + "documentation":"

A collection of keys and an array of possible values in JSON format.

For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]

" + } + } + }, + "CreateResourceGroupResponse":{ + "type":"structure", + "members":{ + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the resource group that is created.

" + } + } + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":["applicationArn"], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the application that you want to delete.

" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "DeleteAssessmentRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment that you want to delete.

" + } + } + }, + "DeleteAssessmentResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "DeleteRunRequest":{ + "type":"structure", + "required":["runArn"], + "members":{ + "runArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment run that you want to delete.

" + } + } + }, + "DeleteRunResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "DescribeApplicationRequest":{ + "type":"structure", + "required":["applicationArn"], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the application that you want to describe.

" + } + } + }, + "DescribeApplicationResponse":{ + "type":"structure", + "members":{ + "application":{ + "shape":"Application", + "documentation":"

Information about the application.

" + } + } + }, + "DescribeAssessmentRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment that you want to describe.

" + } + } + }, + "DescribeAssessmentResponse":{ + "type":"structure", + "members":{ + "assessment":{ + "shape":"Assessment", + "documentation":"

Information about the assessment.

" + } + } + }, + "DescribeCrossAccountAccessRoleResponse":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the IAM role that Inspector uses to access your AWS account.

" + }, + "valid":{ + "shape":"Bool", + "documentation":"

A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Inspector to access your AWS account.

" + } + } + }, + "DescribeFindingRequest":{ + "type":"structure", + "required":["findingArn"], + "members":{ + "findingArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the finding that you want to describe.

" + } + } + }, + "DescribeFindingResponse":{ + "type":"structure", + "members":{ + "finding":{ + "shape":"Finding", + "documentation":"

Information about the finding.

" + } + } + }, + "DescribeResourceGroupRequest":{ + "type":"structure", + "required":["resourceGroupArn"], + "members":{ + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the resource group that you want to describe.

" + } + } + }, + "DescribeResourceGroupResponse":{ + "type":"structure", + "members":{ + "resourceGroup":{ + "shape":"ResourceGroup", + "documentation":"

Information about the resource group.

" + } + } + }, + "DescribeRulesPackageRequest":{ + "type":"structure", + "required":["rulesPackageArn"], + "members":{ + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the rules package that you want to describe.

" + } + } + }, + "DescribeRulesPackageResponse":{ + "type":"structure", + "members":{ + "rulesPackage":{ + "shape":"RulesPackage", + "documentation":"

Information about the rules package.

" + } + } + }, + "DescribeRunRequest":{ + "type":"structure", + "required":["runArn"], + "members":{ + "runArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment run that you want to describe.

" + } + } + }, + "DescribeRunResponse":{ + "type":"structure", + "members":{ + "run":{ + "shape":"Run", + "documentation":"

Information about the assessment run.

" + } + } + }, + "DetachAssessmentAndRulesPackageRequest":{ + "type":"structure", + "required":[ + "assessmentArn", + "rulesPackageArn" + ], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment from which you want to detach a rules package.

" + }, + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the rules package that you want to detach from the assessment.

" + } + } + }, + "DetachAssessmentAndRulesPackageResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Duration":{"type":"integer"}, + "DurationRange":{ + "type":"structure", + "members":{ + "minimum":{ + "shape":"Duration", + "documentation":"

The minimum value of the duration range. Must be greater than zero.

" + }, + "maximum":{ + "shape":"Duration", + "documentation":"

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

" + } + }, + "documentation":"

This data type is used in the AssessmentsFilter data type.

" + }, + "FailureMessage":{"type":"string"}, + "Finding":{ + "type":"structure", + "members":{ + "findingArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the finding.

" + }, + "runArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that generated the finding.

" + }, + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the rules package that is used to generate the finding.

" + }, + "ruleName":{ + "shape":"Name", + "documentation":"

The rule name that is used to generate the finding.

" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"

The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.

" + }, + "severity":{ + "shape":"Severity", + "documentation":"

The finding severity. Values can be set to High, Medium, Low, and Informational.

" + }, + "finding":{ + "shape":"LocalizedText", + "documentation":"

A short description that identifies the finding.

" + }, + "description":{ + "shape":"LocalizedText", + "documentation":"

The description of the finding.

" + }, + "recommendation":{ + "shape":"LocalizedText", + "documentation":"

The recommendation for the finding.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

The system-defined attributes for the finding.

" + }, + "userAttributes":{ + "shape":"AttributeList", + "documentation":"

The user-defined attributes that are assigned to the finding.

" + } + }, + "documentation":"

Contains information about an Inspector finding.

This data type is used as the response element in the DescribeFinding action.

" + }, + "FindingsFilter":{ + "type":"structure", + "members":{ + "rulesPackageArns":{ + "shape":"ArnList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

" + }, + "ruleNames":{ + "shape":"NameList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

" + }, + "severities":{ + "shape":"SeverityList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.

" + }, + "userAttributes":{ + "shape":"AttributeList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.

" + } + }, + "documentation":"

This data type is used as a request parameter in the ListFindings action.

" + }, + "GetAssessmentTelemetryRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment the telemetry of which you want to obtain.

" + } + } + }, + "GetAssessmentTelemetryResponse":{ + "type":"structure", + "members":{ + "telemetry":{ + "shape":"TelemetryList", + "documentation":"

Telemetry details.

" + } + } + }, + "Integer":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + }, + "exception":true, + "fault":true + }, + "InvalidCrossAccountRoleException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"ApplicationsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListApplications action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "members":{ + "applicationArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the applications returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListAssessmentAgentsRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment whose agents you want to list.

" + }, + "filter":{ + "shape":"AgentsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessmentAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentAgentsResponse":{ + "type":"structure", + "members":{ + "agentList":{ + "shape":"AgentList", + "documentation":"

A list of ARNs specifying the agents returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListAssessmentsRequest":{ + "type":"structure", + "members":{ + "applicationArns":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the applications the assessments of which you want to list.

" + }, + "filter":{ + "shape":"AssessmentsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentsResponse":{ + "type":"structure", + "members":{ + "assessmentArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the assessments returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListAttachedAssessmentsRequest":{ + "type":"structure", + "required":["rulesPackageArn"], + "members":{ + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the rules package whose assessments you want to list.

" + }, + "filter":{ + "shape":"AssessmentsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedAssessments action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAttachedAssessmentsResponse":{ + "type":"structure", + "members":{ + "assessmentArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the assessments returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListAttachedRulesPackagesRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the assessment whose rules packages you want to list.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListAttachedRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAttachedRulesPackagesResponse":{ + "type":"structure", + "members":{ + "rulesPackageArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the rules packages returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListFindingsRequest":{ + "type":"structure", + "members":{ + "runArns":{ + "shape":"ArnList", + "documentation":"

The ARNs of the assessment runs that generate the findings that you want to list.

" + }, + "filter":{ + "shape":"FindingsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListFindingsResponse":{ + "type":"structure", + "members":{ + "findingArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the findings returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListRulesPackagesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListRulesPackagesResponse":{ + "type":"structure", + "members":{ + "rulesPackageArnList":{ + "shape":"ArnList", + "documentation":"

The list of ARNs specifying the rules packages returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListRunsRequest":{ + "type":"structure", + "members":{ + "assessmentArns":{ + "shape":"ArnList", + "documentation":"

The ARNs specifying the assessments whose runs you want to list.

" + }, + "filter":{ + "shape":"RunsFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the ListRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListRunsResponse":{ + "type":"structure", + "members":{ + "runArnList":{ + "shape":"ArnList", + "documentation":"

A list of ARNs specifying the assessment runs returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the resource whose tags you want to list.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tagList":{ + "shape":"TagList", + "documentation":"

A collection of key and value pairs.

" + } + } + }, + "Locale":{"type":"string"}, + "LocalizeTextRequest":{ + "type":"structure", + "required":[ + "localizedTexts", + "locale" + ], + "members":{ + "localizedTexts":{ + "shape":"LocalizedTextList", + "documentation":"

A list of textual identifiers.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The locale that you want to translate a textual identifier into.

" + } + } + }, + "LocalizeTextResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + }, + "results":{ + "shape":"TextList", + "documentation":"

The resulting list of user-readable texts.

" + } + } + }, + "LocalizedFacility":{"type":"string"}, + "LocalizedText":{ + "type":"structure", + "members":{ + "key":{ + "shape":"LocalizedTextKey", + "documentation":"

The facility and id properties of the LocalizedTextKey data type.

" + }, + "parameters":{ + "shape":"ParameterList", + "documentation":"

Values for the dynamic elements of the string specified by the textual identifier.

" + } + }, + "documentation":"

The textual identifier. This data type is used as the request parameter in the LocalizeText action.

" + }, + "LocalizedTextId":{"type":"string"}, + "LocalizedTextKey":{ + "type":"structure", + "members":{ + "facility":{ + "shape":"LocalizedFacility", + "documentation":"

The module response source of the text.

" + }, + "id":{ + "shape":"LocalizedTextId", + "documentation":"

Part of the module response source of the text.

" + } + }, + "documentation":"

This data type is used in the LocalizedText data type.

" + }, + "LocalizedTextList":{ + "type":"list", + "member":{"shape":"LocalizedText"} + }, + "Long":{"type":"long"}, + "Message":{"type":"string"}, + "MessageType":{"type":"string"}, + "MessageTypeTelemetry":{ + "type":"structure", + "members":{ + "messageType":{ + "shape":"MessageType", + "documentation":"

A specific type of behavioral data that is collected by the agent.

" + }, + "count":{ + "shape":"Long", + "documentation":"

The number of times that the behavioral data is collected by the agent during an assessment.

" + }, + "dataSize":{ + "shape":"Long", + "documentation":"

The total size of the behavioral data that is collected by the agent during an assessment.

" + } + }, + "documentation":"

This data type is used in the Telemetry data type.

This is metadata about the behavioral data collected by the Inspector agent on your EC2 instances during an assessment and passed to the Inspector service for analysis.

" + }, + "MessageTypeTelemetryList":{ + "type":"list", + "member":{"shape":"MessageTypeTelemetry"} + }, + "Name":{"type":"string"}, + "NameList":{ + "type":"list", + "member":{"shape":"Name"} + }, + "NamePattern":{"type":"string"}, + "NamePatternList":{ + "type":"list", + "member":{"shape":"NamePattern"} + }, + "NoSuchEntityException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "OperationInProgressException":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "PaginationToken":{"type":"string"}, + "Parameter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the variable that is being replaced.

" + }, + "value":{ + "shape":"ParameterValue", + "documentation":"

The value assigned to the variable that is being replaced.

" + } + }, + "documentation":"

This data type is used in the LocalizedText data type.

" + }, + "ParameterList":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "ParameterName":{"type":"string"}, + "ParameterValue":{"type":"string"}, + "PreviewAgentsForResourceGroupRequest":{ + "type":"structure", + "required":["resourceGroupArn"], + "members":{ + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource group that is used to create an application.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to 'null' on your first call to the PreviewAgentsForResourceGroup action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"Integer", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "PreviewAgentsForResourceGroupResponse":{ + "type":"structure", + "members":{ + "agentPreviewList":{ + "shape":"AgentPreviewList", + "documentation":"

The resulting list of agents.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to 'null'.

" + } + } + }, + "RegisterCrossAccountAccessRoleRequest":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{ + "shape":"Arn", + "documentation":"The ARN of the IAM role that Inspector uses to list your EC2 instances during the assessment." + } + } + }, + "RegisterCrossAccountAccessRoleResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "RemoveAttributesFromFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributeKeys" + ], + "members":{ + "findingArns":{ + "shape":"ArnList", + "documentation":"

The ARNs specifying the findings that you want to remove attributes from.

" + }, + "attributeKeys":{ + "shape":"AttributeKeyList", + "documentation":"

The array of attribute keys that you want to remove from specified findings.

" + } + } + }, + "RemoveAttributesFromFindingsResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "ResourceGroup":{ + "type":"structure", + "members":{ + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource group.

" + }, + "resourceGroupTags":{ + "shape":"ResourceGroupTags", + "documentation":"

The tags (key and value pairs) of the resource group.

This data type property is used in the CreateResourceGroup action.

A collection of keys and an array of possible values in JSON format.

For example, [{ \"key1\" : [\"Value1\",\"Value2\"]},{\"Key2\": [\"Value3\"]}]

" + } + }, + "documentation":"

Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that comprise the application.

This data type is used as the response element in the DescribeResourceGroup action.

" + }, + "ResourceGroupTags":{"type":"string"}, + "RulesPackage":{ + "type":"structure", + "members":{ + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the rules package.

" + }, + "rulesPackageName":{ + "shape":"Name", + "documentation":"

The name of the rules package.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version id of the rules package.

" + }, + "provider":{ + "shape":"Name", + "documentation":"

The provider of the rules package.

" + }, + "description":{ + "shape":"LocalizedText", + "documentation":"

The description of the rules package.

" + } + }, + "documentation":"

Contains information about an Inspector rules package.

This data type is used as the response element in the DescribeRulesPackage action.

" + }, + "Run":{ + "type":"structure", + "members":{ + "runArn":{ + "shape":"Arn", + "documentation":"

The ARN of the run.

" + }, + "runName":{ + "shape":"Name", + "documentation":"

The auto-generated name for the run.

" + }, + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment that is associated with the run.

" + }, + "runState":{ + "shape":"RunState", + "documentation":"

The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.

" + }, + "rulesPackages":{ + "shape":"ArnList", + "documentation":"

Rules packages selected for the run of the assessment.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

Run creation time that corresponds to the data collection completion time or failure.

" + }, + "completionTime":{ + "shape":"Timestamp", + "documentation":"

Run completion time that corresponds to the rules packages evaluation completion time or failure.

" + } + }, + "documentation":"

A snapshot of an Inspector assessment that contains the assessment's findings.

This data type is used as the response element in the DescribeRun action.

" + }, + "RunAssessmentRequest":{ + "type":"structure", + "required":[ + "assessmentArn", + "runName" + ], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment that you want to run.

" + }, + "runName":{ + "shape":"Name", + "documentation":"

A name specifying the run of the assessment.

" + } + } + }, + "RunAssessmentResponse":{ + "type":"structure", + "members":{ + "runArn":{ + "shape":"Arn", + "documentation":"

The ARN specifying the run of the assessment.

" + } + } + }, + "RunState":{"type":"string"}, + "RunStateList":{ + "type":"list", + "member":{"shape":"RunState"} + }, + "RunsFilter":{ + "type":"structure", + "members":{ + "runNamePatterns":{ + "shape":"NamePatternList", + "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.

" + }, + "runStates":{ + "shape":"RunStateList", + "documentation":"

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.

" + }, + "rulesPackages":{ + "shape":"ArnList", + "documentation":"

For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.

" + }, + "creationTime":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the creationTime property of the Run data type.

" + }, + "completionTime":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completionTime property of the Run data type.

" + } + }, + "documentation":"

This data type is used as the request parameter in the ListRuns action.

" + }, + "SetTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment that you want to set tags to.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

A collection of key and value pairs that you want to set to an assessment.

" + } + } + }, + "SetTagsForResourceResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Severity":{"type":"string"}, + "SeverityList":{ + "type":"list", + "member":{"shape":"Severity"} + }, + "StartDataCollectionRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment for which you want to start the data collection process.

" + } + } + }, + "StartDataCollectionResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "StopDataCollectionRequest":{ + "type":"structure", + "required":["assessmentArn"], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment for which you want to stop the data collection process.

" + } + } + }, + "StopDataCollectionResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The tag key.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value assigned to a tag key.

" + } + }, + "documentation":"

A key and value pair.

This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

" + }, + "TagKey":{"type":"string"}, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{"type":"string"}, + "Telemetry":{ + "type":"structure", + "members":{ + "status":{ + "shape":"TelemetryStatus", + "documentation":"

The category of the individual metrics that together constitute the telemetry that Inspector received from the agent.

" + }, + "messageTypeTelemetries":{ + "shape":"MessageTypeTelemetryList", + "documentation":"

Counts of individual metrics received by Inspector from the agent.

" + } + }, + "documentation":"

The metadata about the Inspector application data metrics collected by the agent.

This data type is used as the response element in the GetAssessmentTelemetry action.

" + }, + "TelemetryList":{ + "type":"list", + "member":{"shape":"Telemetry"} + }, + "TelemetryStatus":{"type":"string"}, + "Text":{"type":"string"}, + "TextList":{ + "type":"list", + "member":{"shape":"Text"} + }, + "Timestamp":{"type":"timestamp"}, + "TimestampRange":{ + "type":"structure", + "members":{ + "minimum":{ + "shape":"Timestamp", + "documentation":"

The minimum value of the timestamp range.

" + }, + "maximum":{ + "shape":"Timestamp", + "documentation":"

The maximum value of the timestamp range.

" + } + }, + "documentation":"

This data type is used in the AssessmentsFilter and RunsFilter data types.

" + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":[ + "applicationArn", + "applicationName", + "resourceGroupArn" + ], + "members":{ + "applicationArn":{ + "shape":"Arn", + "documentation":"

Application ARN that you want to update.

" + }, + "applicationName":{ + "shape":"Name", + "documentation":"

Application name that you want to update.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The resource group ARN that you want to update.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "UpdateAssessmentRequest":{ + "type":"structure", + "required":[ + "assessmentArn", + "assessmentName", + "durationInSeconds" + ], + "members":{ + "assessmentArn":{ + "shape":"Arn", + "documentation":"

Asessment ARN that you want to update.

" + }, + "assessmentName":{ + "shape":"Name", + "documentation":"

Assessment name that you want to update.

" + }, + "durationInSeconds":{ + "shape":"Duration", + "documentation":"

Assessment duration in seconds that you want to update. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" + } + } + }, + "UpdateAssessmentResponse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"Message", + "documentation":"

Confirmation details of the action performed.

" + } + } + }, + "Version":{"type":"string"} + }, + "documentation":"Amazon Inspector

Amazon Inspector enables you to analyze the behavior of the applications you run in AWS and to identify potential security issues. For more information, see Amazon Inspector User Guide.

" +} diff --git a/aws/dist/botocore/data/inspector/2016-02-16/examples-1.json b/aws/dist/botocore/data/inspector/2016-02-16/examples-1.json new file mode 100644 index 00000000..24fcb7a9 --- /dev/null +++ b/aws/dist/botocore/data/inspector/2016-02-16/examples-1.json @@ -0,0 +1,1140 @@ +{ + "version": "1.0", + "examples": { + "AddAttributesToFindings": [ + { + "input": { + "attributes": [ + { + "key": "Example", + "value": "example" + } + ], + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU" + ] + }, + "output": { + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.", + "id": "add-attributes-to-findings-1481063856401", + "title": "Add attributes to findings" + } + ], + "CreateAssessmentTarget": [ + { + "input": { + "assessmentTargetName": "ExampleAssessmentTarget", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" + }, + "output": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account.", + "id": "create-assessment-target-1481063953657", + "title": "Create assessment target" + } + ], + "CreateAssessmentTemplate": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", + "assessmentTemplateName": "ExampleAssessmentTemplate", + "durationInSeconds": 180, + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-11B9DBXp" + ], + "userAttributesForFindings": [ + { + "key": "Example", + "value": "example" + } + ] + }, + "output": { + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates an assessment template for the assessment target that is specified by the ARN of the assessment target.", + "id": "create-assessment-template-1481064046719", + "title": "Create assessment template" + } + ], + "CreateResourceGroup": [ + { + "input": { + "resourceGroupTags": [ + { + "key": "Name", + "value": "example" + } + ] + }, + "output": { + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-AB6DMKnv" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. ", + "id": "create-resource-group-1481064169037", + "title": "Create resource group" + } + ], + "DeleteAssessmentRun": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment run that is specified by the ARN of the assessment run.", + "id": "delete-assessment-run-1481064251629", + "title": "Delete assessment run" + } + ], + "DeleteAssessmentTarget": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment target that is specified by the ARN of the assessment target.", + "id": "delete-assessment-target-1481064309029", + "title": "Delete assessment target" + } + ], + "DeleteAssessmentTemplate": [ + { + "input": { + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the assessment template that is specified by the ARN of the assessment template.", + "id": "delete-assessment-template-1481064364074", + "title": "Delete assessment template" + } + ], + "DescribeAssessmentRuns": [ + { + "input": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + ] + }, + "output": { + "assessmentRuns": [ + { + "name": "Run 1 for ExampleAssessmentTemplate", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "completedAt": "1458680301.4", + "createdAt": "1458680170.035", + "dataCollected": true, + "durationInSeconds": 3600, + "notifications": [ + + ], + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "startedAt": "1458680170.161", + "state": "COMPLETED", + "stateChangedAt": "1458680301.4", + "stateChanges": [ + { + "state": "CREATED", + "stateChangedAt": "1458680170.035" + }, + { + "state": "START_DATA_COLLECTION_PENDING", + "stateChangedAt": "1458680170.065" + }, + { + "state": "START_DATA_COLLECTION_IN_PROGRESS", + "stateChangedAt": "1458680170.096" + }, + { + "state": "COLLECTING_DATA", + "stateChangedAt": "1458680170.161" + }, + { + "state": "STOP_DATA_COLLECTION_PENDING", + "stateChangedAt": "1458680239.883" + }, + { + "state": "DATA_COLLECTED", + "stateChangedAt": "1458680299.847" + }, + { + "state": "EVALUATING_RULES", + "stateChangedAt": "1458680300.099" + }, + { + "state": "COMPLETED", + "stateChangedAt": "1458680301.4" + } + ], + "userAttributesForFindings": [ + + ] + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "describte-assessment-runs-1481064424352", + "title": "Describte assessment runs" + } + ], + "DescribeAssessmentTargets": [ + { + "input": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ] + }, + "output": { + "assessmentTargets": [ + { + "name": "ExampleAssessmentTarget", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": "1458074191.459", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "updatedAt": "1458074191.459" + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment targets that are specified by the ARNs of the assessment targets.", + "id": "describte-assessment-targets-1481064527735", + "title": "Describte assessment targets" + } + ], + "DescribeAssessmentTemplates": [ + { + "input": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw" + ] + }, + "output": { + "assessmentTemplates": [ + { + "name": "ExampleAssessmentTemplate", + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq", + "createdAt": "1458074191.844", + "durationInSeconds": 3600, + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP" + ], + "userAttributesForFindings": [ + + ] + } + ], + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the assessment templates that are specified by the ARNs of the assessment templates.", + "id": "describte-assessment-templates-1481064606829", + "title": "Describte assessment templates" + } + ], + "DescribeCrossAccountAccessRole": [ + { + "output": { + "registeredAt": "1458069182.826", + "roleArn": "arn:aws:iam::123456789012:role/inspector", + "valid": true + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the IAM role that enables Amazon Inspector to access your AWS account.", + "id": "describte-cross-account-access-role-1481064682267", + "title": "Describte cross account access role" + } + ], + "DescribeFindings": [ + { + "input": { + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4" + ] + }, + "output": { + "failedItems": { + }, + "findings": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "assetAttributes": { + "ipv4Addresses": [ + + ], + "schemaVersion": 1 + }, + "assetType": "ec2-instance", + "attributes": [ + + ], + "confidence": 10, + "createdAt": "1458680301.37", + "description": "Amazon Inspector did not find any potential security issues during this assessment.", + "indicatorOfCompromise": false, + "numericSeverity": 0, + "recommendation": "No remediation needed.", + "schemaVersion": 1, + "service": "Inspector", + "serviceAttributes": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "rulesPackageArn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-X1KXtawP", + "schemaVersion": 1 + }, + "severity": "Informational", + "title": "No potential security issues found", + "updatedAt": "1458680301.37", + "userAttributes": [ + + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the findings that are specified by the ARNs of the findings.", + "id": "describte-findings-1481064771803", + "title": "Describe findings" + } + ], + "DescribeResourceGroups": [ + { + "input": { + "resourceGroupArns": [ + "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI" + ] + }, + "output": { + "failedItems": { + }, + "resourceGroups": [ + { + "arn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-PyGXopAI", + "createdAt": "1458074191.098", + "tags": [ + { + "key": "Name", + "value": "example" + } + ] + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the resource groups that are specified by the ARNs of the resource groups.", + "id": "describe-resource-groups-1481065787743", + "title": "Describe resource groups" + } + ], + "DescribeRulesPackages": [ + { + "input": { + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ" + ] + }, + "output": { + "failedItems": { + }, + "rulesPackages": [ + { + "version": "1.1", + "name": "Security Best Practices", + "arn": "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", + "description": "The rules in this package help determine whether your systems are configured securely.", + "provider": "Amazon Web Services, Inc." + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the rules packages that are specified by the ARNs of the rules packages.", + "id": "describe-rules-packages-1481069641979", + "title": "Describe rules packages" + } + ], + "GetTelemetryMetadata": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + }, + "output": { + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Information about the data that is collected for the specified assessment run.", + "id": "get-telemetry-metadata-1481066021297", + "title": "Get telemetry metadata" + } + ], + "ListAssessmentRunAgents": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "maxResults": 123 + }, + "output": { + "assessmentRunAgents": [ + { + "agentHealth": "HEALTHY", + "agentHealthCode": "RUNNING", + "agentId": "i-49113b93", + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "telemetryMetadata": [ + { + "count": 2, + "dataSize": 345, + "messageType": "InspectorDuplicateProcess" + }, + { + "count": 3, + "dataSize": 255, + "messageType": "InspectorTimeEventMsg" + }, + { + "count": 4, + "dataSize": 1082, + "messageType": "InspectorNetworkInterface" + }, + { + "count": 2, + "dataSize": 349, + "messageType": "InspectorDnsEntry" + }, + { + "count": 11, + "dataSize": 2514, + "messageType": "InspectorDirectoryInfoMsg" + }, + { + "count": 1, + "dataSize": 179, + "messageType": "InspectorTcpV6ListeningPort" + }, + { + "count": 101, + "dataSize": 10949, + "messageType": "InspectorTerminal" + }, + { + "count": 26, + "dataSize": 5916, + "messageType": "InspectorUser" + }, + { + "count": 282, + "dataSize": 32148, + "messageType": "InspectorDynamicallyLoadedCodeModule" + }, + { + "count": 18, + "dataSize": 10172, + "messageType": "InspectorCreateProcess" + }, + { + "count": 3, + "dataSize": 8001, + "messageType": "InspectorProcessPerformance" + }, + { + "count": 1, + "dataSize": 360, + "messageType": "InspectorOperatingSystem" + }, + { + "count": 6, + "dataSize": 546, + "messageType": "InspectorStopProcess" + }, + { + "count": 1, + "dataSize": 1553, + "messageType": "InspectorInstanceMetaData" + }, + { + "count": 2, + "dataSize": 434, + "messageType": "InspectorTcpV4Connection" + }, + { + "count": 474, + "dataSize": 2960322, + "messageType": "InspectorPackageInfo" + }, + { + "count": 3, + "dataSize": 2235, + "messageType": "InspectorSystemPerformance" + }, + { + "count": 105, + "dataSize": 46048, + "messageType": "InspectorCodeModule" + }, + { + "count": 1, + "dataSize": 182, + "messageType": "InspectorUdpV6ListeningPort" + }, + { + "count": 2, + "dataSize": 371, + "messageType": "InspectorUdpV4ListeningPort" + }, + { + "count": 18, + "dataSize": 8362, + "messageType": "InspectorKernelModule" + }, + { + "count": 29, + "dataSize": 48788, + "messageType": "InspectorConfigurationInfo" + }, + { + "count": 1, + "dataSize": 79, + "messageType": "InspectorMonitoringStart" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgBegin" + }, + { + "count": 51, + "dataSize": 4593, + "messageType": "InspectorGroup" + }, + { + "count": 1, + "dataSize": 184, + "messageType": "InspectorTcpV4ListeningPort" + }, + { + "count": 1159, + "dataSize": 3146579, + "messageType": "Total" + }, + { + "count": 5, + "dataSize": 0, + "messageType": "InspectorSplitMsgEnd" + }, + { + "count": 1, + "dataSize": 612, + "messageType": "InspectorLoadImageInProcess" + } + ] + } + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "list-assessment-run-agents-1481918140642", + "title": "List assessment run agents" + } + ], + "ListAssessmentRuns": [ + { + "input": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw" + ], + "maxResults": 123 + }, + "output": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.", + "id": "list-assessment-runs-1481066340844", + "title": "List assessment runs" + } + ], + "ListAssessmentTargets": [ + { + "input": { + "maxResults": 123 + }, + "output": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the ARNs of the assessment targets within this AWS account. ", + "id": "list-assessment-targets-1481066540849", + "title": "List assessment targets" + } + ], + "ListAssessmentTemplates": [ + { + "input": { + "assessmentTargetArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + ], + "maxResults": 123 + }, + "output": { + "assessmentTemplateArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-Uza6ihLh" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.", + "id": "list-assessment-templates-1481066623520", + "title": "List assessment templates" + } + ], + "ListEventSubscriptions": [ + { + "input": { + "maxResults": 123, + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0" + }, + "output": { + "nextToken": "1", + "subscriptions": [ + { + "eventSubscriptions": [ + { + "event": "ASSESSMENT_RUN_COMPLETED", + "subscribedAt": "1459455440.867" + } + ], + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. ", + "id": "list-event-subscriptions-1481068376945", + "title": "List event subscriptions" + } + ], + "ListFindings": [ + { + "input": { + "assessmentRunArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE" + ], + "maxResults": 123 + }, + "output": { + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-MKkpXXPE/finding/0-HwPnsDm4", + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-4r1V2mAw/run/0-v5D6fI3v/finding/0-tyvmqBLy" + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.", + "id": "list-findings-1481066840611", + "title": "List findings" + } + ], + "ListRulesPackages": [ + { + "input": { + "maxResults": 123 + }, + "output": { + "nextToken": "1", + "rulesPackageArns": [ + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-9hgA516p", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-H5hpSawc", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-JJOtZiqQ", + "arn:aws:inspector:us-west-2:758058086616:rulespackage/0-vg5GGHSD" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all available Amazon Inspector rules packages.", + "id": "list-rules-packages-1481066954883", + "title": "List rules packages" + } + ], + "ListTagsForResource": [ + { + "input": { + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-gcwFliYu" + }, + "output": { + "tags": [ + { + "key": "Name", + "value": "Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists all tags associated with an assessment template.", + "id": "list-tags-for-resource-1481067025240", + "title": "List tags for resource" + } + ], + "PreviewAgents": [ + { + "input": { + "maxResults": 123, + "previewAgentsArn": "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq" + }, + "output": { + "agentPreviews": [ + { + "agentId": "i-49113b93" + } + ], + "nextToken": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Previews the agents installed on the EC2 instances that are part of the specified assessment target.", + "id": "preview-agents-1481067101888", + "title": "Preview agents" + } + ], + "RegisterCrossAccountAccessRole": [ + { + "input": { + "roleArn": "arn:aws:iam::123456789012:role/inspector" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Registers the IAM role that Amazon Inspector uses to list your EC2 instances at the start of the assessment run or when you call the PreviewAgents action.", + "id": "register-cross-account-access-role-1481067178301", + "title": "Register cross account access role" + } + ], + "RemoveAttributesFromFindings": [ + { + "input": { + "attributeKeys": [ + "key=Example,value=example" + ], + "findingArns": [ + "arn:aws:inspector:us-west-2:123456789012:target/0-0kFIPusq/template/0-8l1VIE0D/run/0-Z02cjjug/finding/0-T8yM9mEU" + ] + }, + "output": { + "failedItems": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.", + "id": "remove-attributes-from-findings-1481067246548", + "title": "Remove attributes from findings" + } + ], + "SetTagsForResource": [ + { + "input": { + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "tags": [ + { + "key": "Example", + "value": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.", + "id": "set-tags-for-resource-1481067329646", + "title": "Set tags for resource" + } + ], + "StartAssessmentRun": [ + { + "input": { + "assessmentRunName": "examplerun", + "assessmentTemplateArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T" + }, + "output": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-jOoroxyY" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.", + "id": "start-assessment-run-1481067407484", + "title": "Start assessment run" + } + ], + "StopAssessmentRun": [ + { + "input": { + "assessmentRunArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-it5r2S4T/run/0-11LMTAVe" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stops the assessment run that is specified by the ARN of the assessment run.", + "id": "stop-assessment-run-1481067502857", + "title": "Stop assessment run" + } + ], + "SubscribeToEvent": [ + { + "input": { + "event": "ASSESSMENT_RUN_COMPLETED", + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.", + "id": "subscribe-to-event-1481067686031", + "title": "Subscribe to event" + } + ], + "UnsubscribeFromEvent": [ + { + "input": { + "event": "ASSESSMENT_RUN_COMPLETED", + "resourceArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX/template/0-7sbz2Kz0", + "topicArn": "arn:aws:sns:us-west-2:123456789012:exampletopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.", + "id": "unsubscribe-from-event-1481067781705", + "title": "Unsubscribe from event" + } + ], + "UpdateAssessmentTarget": [ + { + "input": { + "assessmentTargetArn": "arn:aws:inspector:us-west-2:123456789012:target/0-nvgVhaxX", + "assessmentTargetName": "Example", + "resourceGroupArn": "arn:aws:inspector:us-west-2:123456789012:resourcegroup/0-yNbgL5Pt" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the assessment target that is specified by the ARN of the assessment target.", + "id": "update-assessment-target-1481067866692", + "title": "Update assessment target" + } + ] + } +} diff --git a/aws/dist/botocore/data/inspector/2016-02-16/paginators-1.json b/aws/dist/botocore/data/inspector/2016-02-16/paginators-1.json new file mode 100644 index 00000000..8dec0410 --- /dev/null +++ b/aws/dist/botocore/data/inspector/2016-02-16/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "ListFindings": { + "result_key": "findingArns", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentTemplates": { + "result_key": "assessmentTemplateArns", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "PreviewAgents": { + "result_key": "agentPreviews", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListEventSubscriptions": { + "result_key": "subscriptions", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListRulesPackages": { + "result_key": "rulesPackageArns", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentRunAgents": { + "result_key": "assessmentRunAgents", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentRuns": { + "result_key": "assessmentRunArns", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListAssessmentTargets": { + "result_key": "assessmentTargetArns", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListExclusions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "exclusionArns" + } + } +} diff --git a/aws/dist/botocore/data/inspector/2016-02-16/service-2.json b/aws/dist/botocore/data/inspector/2016-02-16/service-2.json new file mode 100644 index 00000000..629fb4ae --- /dev/null +++ b/aws/dist/botocore/data/inspector/2016-02-16/service-2.json @@ -0,0 +1,3417 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-02-16", + "endpointPrefix":"inspector", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Inspector", + "serviceId":"Inspector", + "signatureVersion":"v4", + "targetPrefix":"InspectorService", + "uid":"inspector-2016-02-16" + }, + "operations":{ + "AddAttributesToFindings":{ + "name":"AddAttributesToFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAttributesToFindingsRequest"}, + "output":{"shape":"AddAttributesToFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Assigns attributes (key and value pairs) to the findings that are specified by the ARNs of the findings.

" + }, + "CreateAssessmentTarget":{ + "name":"CreateAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssessmentTargetRequest"}, + "output":{"shape":"CreateAssessmentTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Creates a new assessment target using the ARN of the resource group that is generated by CreateResourceGroup. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments. You can create up to 50 assessment targets per AWS account. You can run up to 500 concurrent agents per AWS account. For more information, see Amazon Inspector Assessment Targets.

" + }, + "CreateAssessmentTemplate":{ + "name":"CreateAssessmentTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssessmentTemplateRequest"}, + "output":{"shape":"CreateAssessmentTemplateResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Creates an assessment template for the assessment target that is specified by the ARN of the assessment target. If the service-linked role isn’t already registered, this action also creates and registers a service-linked role to grant Amazon Inspector access to AWS Services needed to perform security assessments.

" + }, + "CreateExclusionsPreview":{ + "name":"CreateExclusionsPreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExclusionsPreviewRequest"}, + "output":{"shape":"CreateExclusionsPreviewResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"PreviewGenerationInProgressException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Starts the generation of an exclusions preview for the specified assessment template. The exclusions preview lists the potential exclusions (ExclusionPreview) that Inspector can detect before it runs the assessment.

" + }, + "CreateResourceGroup":{ + "name":"CreateResourceGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceGroupRequest"}, + "output":{"shape":"CreateResourceGroupResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Creates a resource group using the specified set of tags (key and value pairs) that are used to select the EC2 instances to be included in an Amazon Inspector assessment target. The created resource group is then used to create an Amazon Inspector assessment target. For more information, see CreateAssessmentTarget.

" + }, + "DeleteAssessmentRun":{ + "name":"DeleteAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentRunRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Deletes the assessment run that is specified by the ARN of the assessment run.

" + }, + "DeleteAssessmentTarget":{ + "name":"DeleteAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentTargetRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Deletes the assessment target that is specified by the ARN of the assessment target.

" + }, + "DeleteAssessmentTemplate":{ + "name":"DeleteAssessmentTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssessmentTemplateRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Deletes the assessment template that is specified by the ARN of the assessment template.

" + }, + "DescribeAssessmentRuns":{ + "name":"DescribeAssessmentRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentRunsRequest"}, + "output":{"shape":"DescribeAssessmentRunsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the assessment runs that are specified by the ARNs of the assessment runs.

" + }, + "DescribeAssessmentTargets":{ + "name":"DescribeAssessmentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentTargetsRequest"}, + "output":{"shape":"DescribeAssessmentTargetsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the assessment targets that are specified by the ARNs of the assessment targets.

" + }, + "DescribeAssessmentTemplates":{ + "name":"DescribeAssessmentTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssessmentTemplatesRequest"}, + "output":{"shape":"DescribeAssessmentTemplatesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the assessment templates that are specified by the ARNs of the assessment templates.

" + }, + "DescribeCrossAccountAccessRole":{ + "name":"DescribeCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeCrossAccountAccessRoleResponse"}, + "errors":[ + {"shape":"InternalException"} + ], + "documentation":"

Describes the IAM role that enables Amazon Inspector to access your AWS account.

" + }, + "DescribeExclusions":{ + "name":"DescribeExclusions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExclusionsRequest"}, + "output":{"shape":"DescribeExclusionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the exclusions that are specified by the exclusions' ARNs.

" + }, + "DescribeFindings":{ + "name":"DescribeFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFindingsRequest"}, + "output":{"shape":"DescribeFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the findings that are specified by the ARNs of the findings.

" + }, + "DescribeResourceGroups":{ + "name":"DescribeResourceGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceGroupsRequest"}, + "output":{"shape":"DescribeResourceGroupsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the resource groups that are specified by the ARNs of the resource groups.

" + }, + "DescribeRulesPackages":{ + "name":"DescribeRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRulesPackagesRequest"}, + "output":{"shape":"DescribeRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Describes the rules packages that are specified by the ARNs of the rules packages.

" + }, + "GetAssessmentReport":{ + "name":"GetAssessmentReport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAssessmentReportRequest"}, + "output":{"shape":"GetAssessmentReportResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"AssessmentRunInProgressException"}, + {"shape":"UnsupportedFeatureException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Produces an assessment report that includes detailed and comprehensive results of a specified assessment run.

" + }, + "GetExclusionsPreview":{ + "name":"GetExclusionsPreview", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetExclusionsPreviewRequest"}, + "output":{"shape":"GetExclusionsPreviewResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Retrieves the exclusions preview (a list of ExclusionPreview objects) specified by the preview token. You can obtain the preview token by running the CreateExclusionsPreview API.

" + }, + "GetTelemetryMetadata":{ + "name":"GetTelemetryMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTelemetryMetadataRequest"}, + "output":{"shape":"GetTelemetryMetadataResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Information about the data that is collected for the specified assessment run.

" + }, + "ListAssessmentRunAgents":{ + "name":"ListAssessmentRunAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentRunAgentsRequest"}, + "output":{"shape":"ListAssessmentRunAgentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the agents of the assessment runs that are specified by the ARNs of the assessment runs.

" + }, + "ListAssessmentRuns":{ + "name":"ListAssessmentRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentRunsRequest"}, + "output":{"shape":"ListAssessmentRunsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the assessment runs that correspond to the assessment templates that are specified by the ARNs of the assessment templates.

" + }, + "ListAssessmentTargets":{ + "name":"ListAssessmentTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentTargetsRequest"}, + "output":{"shape":"ListAssessmentTargetsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists the ARNs of the assessment targets within this AWS account. For more information about assessment targets, see Amazon Inspector Assessment Targets.

" + }, + "ListAssessmentTemplates":{ + "name":"ListAssessmentTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssessmentTemplatesRequest"}, + "output":{"shape":"ListAssessmentTemplatesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists the assessment templates that correspond to the assessment targets that are specified by the ARNs of the assessment targets.

" + }, + "ListEventSubscriptions":{ + "name":"ListEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventSubscriptionsRequest"}, + "output":{"shape":"ListEventSubscriptionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists all the event subscriptions for the assessment template that is specified by the ARN of the assessment template. For more information, see SubscribeToEvent and UnsubscribeFromEvent.

" + }, + "ListExclusions":{ + "name":"ListExclusions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExclusionsRequest"}, + "output":{"shape":"ListExclusionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

List exclusions that are generated by the assessment run.

" + }, + "ListFindings":{ + "name":"ListFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFindingsRequest"}, + "output":{"shape":"ListFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists findings that are generated by the assessment runs that are specified by the ARNs of the assessment runs.

" + }, + "ListRulesPackages":{ + "name":"ListRulesPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesPackagesRequest"}, + "output":{"shape":"ListRulesPackagesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Lists all available Amazon Inspector rules packages.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"} + ], + "documentation":"

Lists all tags associated with an assessment template.

" + }, + "PreviewAgents":{ + "name":"PreviewAgents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PreviewAgentsRequest"}, + "output":{"shape":"PreviewAgentsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"} + ], + "documentation":"

Previews the agents installed on the EC2 instances that are part of the specified assessment target.

" + }, + "RegisterCrossAccountAccessRole":{ + "name":"RegisterCrossAccountAccessRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterCrossAccountAccessRoleRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidCrossAccountRoleException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Registers the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

" + }, + "RemoveAttributesFromFindings":{ + "name":"RemoveAttributesFromFindings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAttributesFromFindingsRequest"}, + "output":{"shape":"RemoveAttributesFromFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Removes entire attributes (key and value pairs) from the findings that are specified by the ARNs of the findings where an attribute with the specified key exists.

" + }, + "SetTagsForResource":{ + "name":"SetTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTagsForResourceRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Sets tags (key and value pairs) to the assessment template that is specified by the ARN of the assessment template.

" + }, + "StartAssessmentRun":{ + "name":"StartAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAssessmentRunRequest"}, + "output":{"shape":"StartAssessmentRunResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"InvalidCrossAccountRoleException"}, + {"shape":"AgentsAlreadyRunningAssessmentException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Starts the assessment run specified by the ARN of the assessment template. For this API to function properly, you must not exceed the limit of running up to 500 concurrent agents per AWS account.

" + }, + "StopAssessmentRun":{ + "name":"StopAssessmentRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAssessmentRunRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Stops the assessment run that is specified by the ARN of the assessment run.

" + }, + "SubscribeToEvent":{ + "name":"SubscribeToEvent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubscribeToEventRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Enables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

" + }, + "UnsubscribeFromEvent":{ + "name":"UnsubscribeFromEvent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnsubscribeFromEventRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Disables the process of sending Amazon Simple Notification Service (SNS) notifications about a specified event to a specified SNS topic.

" + }, + "UpdateAssessmentTarget":{ + "name":"UpdateAssessmentTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssessmentTargetRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchEntityException"}, + {"shape":"ServiceTemporarilyUnavailableException"} + ], + "documentation":"

Updates the assessment target that is specified by the ARN of the assessment target.

If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

" + } + }, + "shapes":{ + "AccessDeniedErrorCode":{ + "type":"string", + "enum":[ + "ACCESS_DENIED_TO_ASSESSMENT_TARGET", + "ACCESS_DENIED_TO_ASSESSMENT_TEMPLATE", + "ACCESS_DENIED_TO_ASSESSMENT_RUN", + "ACCESS_DENIED_TO_FINDING", + "ACCESS_DENIED_TO_RESOURCE_GROUP", + "ACCESS_DENIED_TO_RULES_PACKAGE", + "ACCESS_DENIED_TO_SNS_TOPIC", + "ACCESS_DENIED_TO_IAM_ROLE" + ] + }, + "AccessDeniedException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "errorCode":{ + "shape":"AccessDeniedErrorCode", + "documentation":"

Code that indicates the type of error that is generated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

You do not have required permissions to access the requested resource.

", + "exception":true + }, + "AddAttributesToFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributes" + ], + "members":{ + "findingArns":{ + "shape":"AddRemoveAttributesFindingArnList", + "documentation":"

The ARNs that specify the findings that you want to assign attributes to.

" + }, + "attributes":{ + "shape":"UserAttributeList", + "documentation":"

The array of attributes that you want to assign to specified findings.

" + } + } + }, + "AddAttributesToFindingsResponse":{ + "type":"structure", + "required":["failedItems"], + "members":{ + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Attribute details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "AddRemoveAttributesFindingArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "AgentAlreadyRunningAssessment":{ + "type":"structure", + "required":[ + "agentId", + "assessmentRunArn" + ], + "members":{ + "agentId":{ + "shape":"AgentId", + "documentation":"

ID of the agent that is running on an EC2 instance that is already participating in another started assessment run.

" + }, + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that has already been started.

" + } + }, + "documentation":"

Used in the exception error that is thrown if you start an assessment run for an assessment target that includes an EC2 instance that is already participating in another started assessment run.

" + }, + "AgentAlreadyRunningAssessmentList":{ + "type":"list", + "member":{"shape":"AgentAlreadyRunningAssessment"}, + "max":10, + "min":1 + }, + "AgentFilter":{ + "type":"structure", + "required":[ + "agentHealths", + "agentHealthCodes" + ], + "members":{ + "agentHealths":{ + "shape":"AgentHealthList", + "documentation":"

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

" + }, + "agentHealthCodes":{ + "shape":"AgentHealthCodeList", + "documentation":"

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector agent. This data type is used as a request parameter in the ListAssessmentRunAgents action.

" + }, + "AgentHealth":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ] + }, + "AgentHealthCode":{ + "type":"string", + "enum":[ + "IDLE", + "RUNNING", + "SHUTDOWN", + "UNHEALTHY", + "THROTTLED", + "UNKNOWN" + ] + }, + "AgentHealthCodeList":{ + "type":"list", + "member":{"shape":"AgentHealthCode"}, + "max":10, + "min":0 + }, + "AgentHealthList":{ + "type":"list", + "member":{"shape":"AgentHealth"}, + "max":10, + "min":0 + }, + "AgentId":{ + "type":"string", + "max":128, + "min":1 + }, + "AgentIdList":{ + "type":"list", + "member":{"shape":"AgentId"}, + "max":99, + "min":0 + }, + "AgentPreview":{ + "type":"structure", + "required":["agentId"], + "members":{ + "hostname":{ + "shape":"Hostname", + "documentation":"

The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.

" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"

The ID of the EC2 instance where the agent is installed.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

The Auto Scaling group for the EC2 instance where the agent is installed.

" + }, + "agentHealth":{ + "shape":"AgentHealth", + "documentation":"

The health status of the Amazon Inspector Agent.

" + }, + "agentVersion":{ + "shape":"AgentVersion", + "documentation":"

The version of the Amazon Inspector Agent.

" + }, + "operatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

" + }, + "kernelVersion":{ + "shape":"KernelVersion", + "documentation":"

The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

" + }, + "ipv4Address":{ + "shape":"Ipv4Address", + "documentation":"

The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.

" + } + }, + "documentation":"

Used as a response element in the PreviewAgents action.

" + }, + "AgentPreviewList":{ + "type":"list", + "member":{"shape":"AgentPreview"}, + "max":100, + "min":0 + }, + "AgentVersion":{ + "type":"string", + "max":128, + "min":1 + }, + "AgentsAlreadyRunningAssessmentException":{ + "type":"structure", + "required":[ + "message", + "agents", + "agentsTruncated", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "agents":{ + "shape":"AgentAlreadyRunningAssessmentList", + "documentation":"

" + }, + "agentsTruncated":{ + "shape":"Bool", + "documentation":"

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

You started an assessment run, but one of the instances is already participating in another assessment run.

", + "exception":true + }, + "AmiId":{ + "type":"string", + "max":256, + "min":0 + }, + "Arn":{ + "type":"string", + "max":300, + "min":1 + }, + "ArnCount":{"type":"integer"}, + "AssessmentRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":1 + }, + "AssessmentRun":{ + "type":"structure", + "required":[ + "arn", + "name", + "assessmentTemplateArn", + "state", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "createdAt", + "stateChangedAt", + "dataCollected", + "stateChanges", + "notifications", + "findingCounts" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run.

" + }, + "name":{ + "shape":"AssessmentRunName", + "documentation":"

The auto-generated name for the assessment run.

" + }, + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template that is associated with the assessment run.

" + }, + "state":{ + "shape":"AssessmentRunState", + "documentation":"

The state of the assessment run.

" + }, + "durationInSeconds":{ + "shape":"AssessmentRunDuration", + "documentation":"

The duration of the assessment run.

" + }, + "rulesPackageArns":{ + "shape":"AssessmentRulesPackageArnList", + "documentation":"

The rules packages selected for the assessment run.

" + }, + "userAttributesForFindings":{ + "shape":"UserAttributeList", + "documentation":"

The user-defined attributes that are assigned to every generated finding.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time when StartAssessmentRun was called.

" + }, + "startedAt":{ + "shape":"Timestamp", + "documentation":"

The time when StartAssessmentRun was called.

" + }, + "completedAt":{ + "shape":"Timestamp", + "documentation":"

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

" + }, + "stateChangedAt":{ + "shape":"Timestamp", + "documentation":"

The last time when the assessment run's state changed.

" + }, + "dataCollected":{ + "shape":"Bool", + "documentation":"

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

" + }, + "stateChanges":{ + "shape":"AssessmentRunStateChangeList", + "documentation":"

A list of the assessment run state changes.

" + }, + "notifications":{ + "shape":"AssessmentRunNotificationList", + "documentation":"

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

" + }, + "findingCounts":{ + "shape":"AssessmentRunFindingCounts", + "documentation":"

Provides a total count of generated findings per severity.

" + } + }, + "documentation":"

A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .

Used as the response element in the DescribeAssessmentRuns action.

" + }, + "AssessmentRunAgent":{ + "type":"structure", + "required":[ + "agentId", + "assessmentRunArn", + "agentHealth", + "agentHealthCode", + "telemetryMetadata" + ], + "members":{ + "agentId":{ + "shape":"AgentId", + "documentation":"

The AWS account of the EC2 instance where the agent is installed.

" + }, + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that is associated with the agent.

" + }, + "agentHealth":{ + "shape":"AgentHealth", + "documentation":"

The current health state of the agent.

" + }, + "agentHealthCode":{ + "shape":"AgentHealthCode", + "documentation":"

The detailed health state of the agent.

" + }, + "agentHealthDetails":{ + "shape":"Message", + "documentation":"

The description for the agent health code.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

The Auto Scaling group of the EC2 instance that is specified by the agent ID.

" + }, + "telemetryMetadata":{ + "shape":"TelemetryMetadataList", + "documentation":"

The Amazon Inspector application data metrics that are collected by the agent.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector agent. This data type is used as a response element in the ListAssessmentRunAgents action.

" + }, + "AssessmentRunAgentList":{ + "type":"list", + "member":{"shape":"AssessmentRunAgent"}, + "max":500, + "min":0 + }, + "AssessmentRunDuration":{ + "type":"integer", + "max":86400, + "min":180 + }, + "AssessmentRunFilter":{ + "type":"structure", + "members":{ + "namePattern":{ + "shape":"NamePattern", + "documentation":"

For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.

" + }, + "states":{ + "shape":"AssessmentRunStateList", + "documentation":"

For a record to match a filter, one of the values specified for this data type property must be the exact match of the value of the assessmentRunState property of the AssessmentRun data type.

" + }, + "durationRange":{ + "shape":"DurationRange", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentRun data type.

" + }, + "rulesPackageArns":{ + "shape":"FilterRulesPackageArnList", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the rulesPackages property of the AssessmentRun data type.

" + }, + "startTimeRange":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the AssessmentRun data type.

" + }, + "completionTimeRange":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completedAt property of the AssessmentRun data type.

" + }, + "stateChangeTimeRange":{ + "shape":"TimestampRange", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.

" + } + }, + "documentation":"

Used as the request parameter in the ListAssessmentRuns action.

" + }, + "AssessmentRunFindingCounts":{ + "type":"map", + "key":{"shape":"Severity"}, + "value":{"shape":"FindingCount"} + }, + "AssessmentRunInProgressArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "AssessmentRunInProgressException":{ + "type":"structure", + "required":[ + "message", + "assessmentRunArns", + "assessmentRunArnsTruncated", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "assessmentRunArns":{ + "shape":"AssessmentRunInProgressArnList", + "documentation":"

The ARNs of the assessment runs that are currently in progress.

" + }, + "assessmentRunArnsTruncated":{ + "shape":"Bool", + "documentation":"

Boolean value that indicates whether the ARN list of the assessment runs is truncated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

You cannot perform a specified action if an assessment run is currently in progress.

", + "exception":true + }, + "AssessmentRunList":{ + "type":"list", + "member":{"shape":"AssessmentRun"}, + "max":10, + "min":0 + }, + "AssessmentRunName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentRunNotification":{ + "type":"structure", + "required":[ + "date", + "event", + "error" + ], + "members":{ + "date":{ + "shape":"Timestamp", + "documentation":"

The date of the notification.

" + }, + "event":{ + "shape":"InspectorEvent", + "documentation":"

The event for which a notification is sent.

" + }, + "message":{ + "shape":"Message", + "documentation":"

The message included in the notification.

" + }, + "error":{ + "shape":"Bool", + "documentation":"

The Boolean value that specifies whether the notification represents an error.

" + }, + "snsTopicArn":{ + "shape":"Arn", + "documentation":"

The SNS topic to which the SNS notification is sent.

" + }, + "snsPublishStatusCode":{ + "shape":"AssessmentRunNotificationSnsStatusCode", + "documentation":"

The status code of the SNS notification.

" + } + }, + "documentation":"

Used as one of the elements of the AssessmentRun data type.

" + }, + "AssessmentRunNotificationList":{ + "type":"list", + "member":{"shape":"AssessmentRunNotification"}, + "max":50, + "min":0 + }, + "AssessmentRunNotificationSnsStatusCode":{ + "type":"string", + "enum":[ + "SUCCESS", + "TOPIC_DOES_NOT_EXIST", + "ACCESS_DENIED", + "INTERNAL_ERROR" + ] + }, + "AssessmentRunState":{ + "type":"string", + "enum":[ + "CREATED", + "START_DATA_COLLECTION_PENDING", + "START_DATA_COLLECTION_IN_PROGRESS", + "COLLECTING_DATA", + "STOP_DATA_COLLECTION_PENDING", + "DATA_COLLECTED", + "START_EVALUATING_RULES_PENDING", + "EVALUATING_RULES", + "FAILED", + "ERROR", + "COMPLETED", + "COMPLETED_WITH_ERRORS", + "CANCELED" + ] + }, + "AssessmentRunStateChange":{ + "type":"structure", + "required":[ + "stateChangedAt", + "state" + ], + "members":{ + "stateChangedAt":{ + "shape":"Timestamp", + "documentation":"

The last time the assessment run state changed.

" + }, + "state":{ + "shape":"AssessmentRunState", + "documentation":"

The assessment run state.

" + } + }, + "documentation":"

Used as one of the elements of the AssessmentRun data type.

" + }, + "AssessmentRunStateChangeList":{ + "type":"list", + "member":{"shape":"AssessmentRunStateChange"}, + "max":50, + "min":0 + }, + "AssessmentRunStateList":{ + "type":"list", + "member":{"shape":"AssessmentRunState"}, + "max":50, + "min":0 + }, + "AssessmentTarget":{ + "type":"structure", + "required":[ + "arn", + "name", + "createdAt", + "updatedAt" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the Amazon Inspector assessment target.

" + }, + "name":{ + "shape":"AssessmentTargetName", + "documentation":"

The name of the Amazon Inspector assessment target.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the resource group that is associated with the assessment target.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time at which the assessment target is created.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The time at which UpdateAssessmentTarget is called.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector application. This data type is used as the response element in the DescribeAssessmentTargets action.

" + }, + "AssessmentTargetFilter":{ + "type":"structure", + "members":{ + "assessmentTargetNamePattern":{ + "shape":"NamePattern", + "documentation":"

For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTargetName property of the AssessmentTarget data type.

" + } + }, + "documentation":"

Used as the request parameter in the ListAssessmentTargets action.

" + }, + "AssessmentTargetList":{ + "type":"list", + "member":{"shape":"AssessmentTarget"}, + "max":10, + "min":0 + }, + "AssessmentTargetName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentTemplate":{ + "type":"structure", + "required":[ + "arn", + "name", + "assessmentTargetArn", + "durationInSeconds", + "rulesPackageArns", + "userAttributesForFindings", + "assessmentRunCount", + "createdAt" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template.

" + }, + "name":{ + "shape":"AssessmentTemplateName", + "documentation":"

The name of the assessment template.

" + }, + "assessmentTargetArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment target that corresponds to this assessment template.

" + }, + "durationInSeconds":{ + "shape":"AssessmentRunDuration", + "documentation":"

The duration in seconds specified for this assessment template. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

" + }, + "rulesPackageArns":{ + "shape":"AssessmentTemplateRulesPackageArnList", + "documentation":"

The rules packages that are specified for this assessment template.

" + }, + "userAttributesForFindings":{ + "shape":"UserAttributeList", + "documentation":"

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

" + }, + "lastAssessmentRunArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the most recent assessment run associated with this assessment template. This value exists only when the value of assessmentRunCount is greaterpa than zero.

" + }, + "assessmentRunCount":{ + "shape":"ArnCount", + "documentation":"

The number of existing assessment runs associated with this assessment template. This value can be zero or a positive integer.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time at which the assessment template is created.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector assessment template. This data type is used as the response element in the DescribeAssessmentTemplates action.

" + }, + "AssessmentTemplateFilter":{ + "type":"structure", + "members":{ + "namePattern":{ + "shape":"NamePattern", + "documentation":"

For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type.

" + }, + "durationRange":{ + "shape":"DurationRange", + "documentation":"

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the AssessmentTemplate data type.

" + }, + "rulesPackageArns":{ + "shape":"FilterRulesPackageArnList", + "documentation":"

For a record to match a filter, the values that are specified for this data type property must be contained in the list of values of the rulesPackageArns property of the AssessmentTemplate data type.

" + } + }, + "documentation":"

Used as the request parameter in the ListAssessmentTemplates action.

" + }, + "AssessmentTemplateList":{ + "type":"list", + "member":{"shape":"AssessmentTemplate"}, + "max":10, + "min":0 + }, + "AssessmentTemplateName":{ + "type":"string", + "max":140, + "min":1 + }, + "AssessmentTemplateRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "AssetAttributes":{ + "type":"structure", + "required":["schemaVersion"], + "members":{ + "schemaVersion":{ + "shape":"NumericVersion", + "documentation":"

The schema version of this data type.

" + }, + "agentId":{ + "shape":"AgentId", + "documentation":"

The ID of the agent that is installed on the EC2 instance where the finding is generated.

" + }, + "autoScalingGroup":{ + "shape":"AutoScalingGroup", + "documentation":"

The Auto Scaling group of the EC2 instance where the finding is generated.

" + }, + "amiId":{ + "shape":"AmiId", + "documentation":"

The ID of the Amazon Machine Image (AMI) that is installed on the EC2 instance where the finding is generated.

" + }, + "hostname":{ + "shape":"Hostname", + "documentation":"

The hostname of the EC2 instance where the finding is generated.

" + }, + "ipv4Addresses":{ + "shape":"Ipv4AddressList", + "documentation":"

The list of IP v4 addresses of the EC2 instance where the finding is generated.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The tags related to the EC2 instance where the finding is generated.

" + }, + "networkInterfaces":{ + "shape":"NetworkInterfaces", + "documentation":"

An array of the network interfaces interacting with the EC2 instance where the finding is generated.

" + } + }, + "documentation":"

A collection of attributes of the host from which the finding is generated.

" + }, + "AssetType":{ + "type":"string", + "enum":["ec2-instance"] + }, + "Attribute":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"AttributeKey", + "documentation":"

The attribute key.

" + }, + "value":{ + "shape":"AttributeValue", + "documentation":"

The value assigned to the attribute key.

" + } + }, + "documentation":"

This data type is used as a request parameter in the AddAttributesToFindings and CreateAssessmentTemplate actions.

" + }, + "AttributeKey":{ + "type":"string", + "max":128, + "min":1 + }, + "AttributeList":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":50, + "min":0 + }, + "AttributeValue":{ + "type":"string", + "max":256, + "min":1 + }, + "AutoScalingGroup":{ + "type":"string", + "max":256, + "min":1 + }, + "AutoScalingGroupList":{ + "type":"list", + "member":{"shape":"AutoScalingGroup"}, + "max":20, + "min":0 + }, + "BatchDescribeArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":10, + "min":1 + }, + "BatchDescribeExclusionsArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":100, + "min":1 + }, + "Bool":{"type":"boolean"}, + "CreateAssessmentTargetRequest":{ + "type":"structure", + "required":["assessmentTargetName"], + "members":{ + "assessmentTargetName":{ + "shape":"AssessmentTargetName", + "documentation":"

The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the resource group that is used to create the assessment target. If resourceGroupArn is not specified, all EC2 instances in the current AWS account and region are included in the assessment target.

" + } + } + }, + "CreateAssessmentTargetResponse":{ + "type":"structure", + "required":["assessmentTargetArn"], + "members":{ + "assessmentTargetArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment target that is created.

" + } + } + }, + "CreateAssessmentTemplateRequest":{ + "type":"structure", + "required":[ + "assessmentTargetArn", + "assessmentTemplateName", + "durationInSeconds", + "rulesPackageArns" + ], + "members":{ + "assessmentTargetArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment target for which you want to create the assessment template.

" + }, + "assessmentTemplateName":{ + "shape":"AssessmentTemplateName", + "documentation":"

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond to a particular assessment target must be unique.

" + }, + "durationInSeconds":{ + "shape":"AssessmentRunDuration", + "documentation":"

The duration of the assessment run in seconds.

" + }, + "rulesPackageArns":{ + "shape":"AssessmentTemplateRulesPackageArnList", + "documentation":"

The ARNs that specify the rules packages that you want to attach to the assessment template.

" + }, + "userAttributesForFindings":{ + "shape":"UserAttributeList", + "documentation":"

The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template. An attribute is a key and value pair (an Attribute object). Within an assessment template, each key must be unique.

" + } + } + }, + "CreateAssessmentTemplateResponse":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment template that is created.

" + } + } + }, + "CreateExclusionsPreviewRequest":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment template for which you want to create an exclusions preview.

" + } + } + }, + "CreateExclusionsPreviewResponse":{ + "type":"structure", + "required":["previewToken"], + "members":{ + "previewToken":{ + "shape":"UUID", + "documentation":"

Specifies the unique identifier of the requested exclusions preview. You can use the unique identifier to retrieve the exclusions preview when running the GetExclusionsPreview API.

" + } + } + }, + "CreateResourceGroupRequest":{ + "type":"structure", + "required":["resourceGroupTags"], + "members":{ + "resourceGroupTags":{ + "shape":"ResourceGroupTags", + "documentation":"

A collection of keys and an array of possible values, '[{\"key\":\"key1\",\"values\":[\"Value1\",\"Value2\"]},{\"key\":\"Key2\",\"values\":[\"Value3\"]}]'.

For example,'[{\"key\":\"Name\",\"values\":[\"TestEC2Instance\"]}]'.

" + } + } + }, + "CreateResourceGroupResponse":{ + "type":"structure", + "required":["resourceGroupArn"], + "members":{ + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the resource group that is created.

" + } + } + }, + "DeleteAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment run that you want to delete.

" + } + } + }, + "DeleteAssessmentTargetRequest":{ + "type":"structure", + "required":["assessmentTargetArn"], + "members":{ + "assessmentTargetArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment target that you want to delete.

" + } + } + }, + "DeleteAssessmentTemplateRequest":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment template that you want to delete.

" + } + } + }, + "DescribeAssessmentRunsRequest":{ + "type":"structure", + "required":["assessmentRunArns"], + "members":{ + "assessmentRunArns":{ + "shape":"BatchDescribeArnList", + "documentation":"

The ARN that specifies the assessment run that you want to describe.

" + } + } + }, + "DescribeAssessmentRunsResponse":{ + "type":"structure", + "required":[ + "assessmentRuns", + "failedItems" + ], + "members":{ + "assessmentRuns":{ + "shape":"AssessmentRunList", + "documentation":"

Information about the assessment run.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Assessment run details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeAssessmentTargetsRequest":{ + "type":"structure", + "required":["assessmentTargetArns"], + "members":{ + "assessmentTargetArns":{ + "shape":"BatchDescribeArnList", + "documentation":"

The ARNs that specifies the assessment targets that you want to describe.

" + } + } + }, + "DescribeAssessmentTargetsResponse":{ + "type":"structure", + "required":[ + "assessmentTargets", + "failedItems" + ], + "members":{ + "assessmentTargets":{ + "shape":"AssessmentTargetList", + "documentation":"

Information about the assessment targets.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Assessment target details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeAssessmentTemplatesRequest":{ + "type":"structure", + "required":["assessmentTemplateArns"], + "members":{ + "assessmentTemplateArns":{"shape":"BatchDescribeArnList"} + } + }, + "DescribeAssessmentTemplatesResponse":{ + "type":"structure", + "required":[ + "assessmentTemplates", + "failedItems" + ], + "members":{ + "assessmentTemplates":{ + "shape":"AssessmentTemplateList", + "documentation":"

Information about the assessment templates.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Assessment template details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeCrossAccountAccessRoleResponse":{ + "type":"structure", + "required":[ + "roleArn", + "valid", + "registeredAt" + ], + "members":{ + "roleArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the IAM role that Amazon Inspector uses to access your AWS account.

" + }, + "valid":{ + "shape":"Bool", + "documentation":"

A Boolean value that specifies whether the IAM role has the necessary policies attached to enable Amazon Inspector to access your AWS account.

" + }, + "registeredAt":{ + "shape":"Timestamp", + "documentation":"

The date when the cross-account access role was registered.

" + } + } + }, + "DescribeExclusionsRequest":{ + "type":"structure", + "required":["exclusionArns"], + "members":{ + "exclusionArns":{ + "shape":"BatchDescribeExclusionsArnList", + "documentation":"

The list of ARNs that specify the exclusions that you want to describe.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The locale into which you want to translate the exclusion's title, description, and recommendation.

" + } + } + }, + "DescribeExclusionsResponse":{ + "type":"structure", + "required":[ + "exclusions", + "failedItems" + ], + "members":{ + "exclusions":{ + "shape":"ExclusionMap", + "documentation":"

Information about the exclusions.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Exclusion details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeFindingsRequest":{ + "type":"structure", + "required":["findingArns"], + "members":{ + "findingArns":{ + "shape":"BatchDescribeArnList", + "documentation":"

The ARN that specifies the finding that you want to describe.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.

" + } + } + }, + "DescribeFindingsResponse":{ + "type":"structure", + "required":[ + "findings", + "failedItems" + ], + "members":{ + "findings":{ + "shape":"FindingList", + "documentation":"

Information about the finding.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Finding details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeResourceGroupsRequest":{ + "type":"structure", + "required":["resourceGroupArns"], + "members":{ + "resourceGroupArns":{ + "shape":"BatchDescribeArnList", + "documentation":"

The ARN that specifies the resource group that you want to describe.

" + } + } + }, + "DescribeResourceGroupsResponse":{ + "type":"structure", + "required":[ + "resourceGroups", + "failedItems" + ], + "members":{ + "resourceGroups":{ + "shape":"ResourceGroupList", + "documentation":"

Information about a resource group.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Resource group details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DescribeRulesPackagesRequest":{ + "type":"structure", + "required":["rulesPackageArns"], + "members":{ + "rulesPackageArns":{ + "shape":"BatchDescribeArnList", + "documentation":"

The ARN that specifies the rules package that you want to describe.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The locale that you want to translate a rules package description into.

" + } + } + }, + "DescribeRulesPackagesResponse":{ + "type":"structure", + "required":[ + "rulesPackages", + "failedItems" + ], + "members":{ + "rulesPackages":{ + "shape":"RulesPackageList", + "documentation":"

Information about the rules package.

" + }, + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Rules package details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "DurationRange":{ + "type":"structure", + "members":{ + "minSeconds":{ + "shape":"AssessmentRunDuration", + "documentation":"

The minimum value of the duration range. Must be greater than zero.

" + }, + "maxSeconds":{ + "shape":"AssessmentRunDuration", + "documentation":"

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

" + } + }, + "documentation":"

This data type is used in the AssessmentTemplateFilter data type.

" + }, + "ErrorMessage":{ + "type":"string", + "max":1000, + "min":0 + }, + "EventSubscription":{ + "type":"structure", + "required":[ + "event", + "subscribedAt" + ], + "members":{ + "event":{ + "shape":"InspectorEvent", + "documentation":"

The event for which Amazon Simple Notification Service (SNS) notifications are sent.

" + }, + "subscribedAt":{ + "shape":"Timestamp", + "documentation":"

The time at which SubscribeToEvent is called.

" + } + }, + "documentation":"

This data type is used in the Subscription data type.

" + }, + "EventSubscriptionList":{ + "type":"list", + "member":{"shape":"EventSubscription"}, + "max":50, + "min":1 + }, + "Exclusion":{ + "type":"structure", + "required":[ + "arn", + "title", + "description", + "recommendation", + "scopes" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the exclusion.

" + }, + "title":{ + "shape":"Text", + "documentation":"

The name of the exclusion.

" + }, + "description":{ + "shape":"Text", + "documentation":"

The description of the exclusion.

" + }, + "recommendation":{ + "shape":"Text", + "documentation":"

The recommendation for the exclusion.

" + }, + "scopes":{ + "shape":"ScopeList", + "documentation":"

The AWS resources for which the exclusion pertains.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

The system-defined attributes for the exclusion.

" + } + }, + "documentation":"

Contains information about what was excluded from an assessment run.

" + }, + "ExclusionMap":{ + "type":"map", + "key":{"shape":"Arn"}, + "value":{"shape":"Exclusion"}, + "max":100, + "min":1 + }, + "ExclusionPreview":{ + "type":"structure", + "required":[ + "title", + "description", + "recommendation", + "scopes" + ], + "members":{ + "title":{ + "shape":"Text", + "documentation":"

The name of the exclusion preview.

" + }, + "description":{ + "shape":"Text", + "documentation":"

The description of the exclusion preview.

" + }, + "recommendation":{ + "shape":"Text", + "documentation":"

The recommendation for the exclusion preview.

" + }, + "scopes":{ + "shape":"ScopeList", + "documentation":"

The AWS resources for which the exclusion preview pertains.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

The system-defined attributes for the exclusion preview.

" + } + }, + "documentation":"

Contains information about what is excluded from an assessment run given the current state of the assessment template.

" + }, + "ExclusionPreviewList":{ + "type":"list", + "member":{"shape":"ExclusionPreview"}, + "max":100, + "min":0 + }, + "FailedItemDetails":{ + "type":"structure", + "required":[ + "failureCode", + "retryable" + ], + "members":{ + "failureCode":{ + "shape":"FailedItemErrorCode", + "documentation":"

The status code of a failed item.

" + }, + "retryable":{ + "shape":"Bool", + "documentation":"

Indicates whether you can immediately retry a request for this item for a specified resource.

" + } + }, + "documentation":"

Includes details about the failed items.

" + }, + "FailedItemErrorCode":{ + "type":"string", + "enum":[ + "INVALID_ARN", + "DUPLICATE_ARN", + "ITEM_DOES_NOT_EXIST", + "ACCESS_DENIED", + "LIMIT_EXCEEDED", + "INTERNAL_ERROR" + ] + }, + "FailedItems":{ + "type":"map", + "key":{"shape":"Arn"}, + "value":{"shape":"FailedItemDetails"} + }, + "FilterRulesPackageArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "Finding":{ + "type":"structure", + "required":[ + "arn", + "attributes", + "userAttributes", + "createdAt", + "updatedAt" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the finding.

" + }, + "schemaVersion":{ + "shape":"NumericVersion", + "documentation":"

The schema version of this data type.

" + }, + "service":{ + "shape":"ServiceName", + "documentation":"

The data element is set to \"Inspector\".

" + }, + "serviceAttributes":{ + "shape":"InspectorServiceAttributes", + "documentation":"

This data type is used in the Finding data type.

" + }, + "assetType":{ + "shape":"AssetType", + "documentation":"

The type of the host from which the finding is generated.

" + }, + "assetAttributes":{ + "shape":"AssetAttributes", + "documentation":"

A collection of attributes of the host from which the finding is generated.

" + }, + "id":{ + "shape":"FindingId", + "documentation":"

The ID of the finding.

" + }, + "title":{ + "shape":"Text", + "documentation":"

The name of the finding.

" + }, + "description":{ + "shape":"Text", + "documentation":"

The description of the finding.

" + }, + "recommendation":{ + "shape":"Text", + "documentation":"

The recommendation for the finding.

" + }, + "severity":{ + "shape":"Severity", + "documentation":"

The finding severity. Values can be set to High, Medium, Low, and Informational.

" + }, + "numericSeverity":{ + "shape":"NumericSeverity", + "documentation":"

The numeric value of the finding severity.

" + }, + "confidence":{ + "shape":"IocConfidence", + "documentation":"

This data element is currently not used.

" + }, + "indicatorOfCompromise":{ + "shape":"Bool", + "documentation":"

This data element is currently not used.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

The system-defined attributes for the finding.

" + }, + "userAttributes":{ + "shape":"UserAttributeList", + "documentation":"

The user-defined attributes that are assigned to the finding.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time when the finding was generated.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The time when AddAttributesToFindings is called.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector finding. This data type is used as the response element in the DescribeFindings action.

" + }, + "FindingCount":{"type":"integer"}, + "FindingFilter":{ + "type":"structure", + "members":{ + "agentIds":{ + "shape":"AgentIdList", + "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type.

" + }, + "autoScalingGroups":{ + "shape":"AutoScalingGroupList", + "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type.

" + }, + "ruleNames":{ + "shape":"RuleNameList", + "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

" + }, + "severities":{ + "shape":"SeverityList", + "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

" + }, + "rulesPackageArns":{ + "shape":"FilterRulesPackageArnList", + "documentation":"

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

" + }, + "attributes":{ + "shape":"AttributeList", + "documentation":"

For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type.

" + }, + "userAttributes":{ + "shape":"AttributeList", + "documentation":"

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type.

" + }, + "creationTimeRange":{ + "shape":"TimestampRange", + "documentation":"

The time range during which the finding is generated.

" + } + }, + "documentation":"

This data type is used as a request parameter in the ListFindings action.

" + }, + "FindingId":{ + "type":"string", + "max":128, + "min":0 + }, + "FindingList":{ + "type":"list", + "member":{"shape":"Finding"}, + "max":100, + "min":0 + }, + "GetAssessmentReportRequest":{ + "type":"structure", + "required":[ + "assessmentRunArn", + "reportFileFormat", + "reportType" + ], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment run for which you want to generate a report.

" + }, + "reportFileFormat":{ + "shape":"ReportFileFormat", + "documentation":"

Specifies the file format (html or pdf) of the assessment report that you want to generate.

" + }, + "reportType":{ + "shape":"ReportType", + "documentation":"

Specifies the type of the assessment report that you want to generate. There are two types of assessment reports: a finding report and a full report. For more information, see Assessment Reports.

" + } + } + }, + "GetAssessmentReportResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"ReportStatus", + "documentation":"

Specifies the status of the request to generate an assessment report.

" + }, + "url":{ + "shape":"Url", + "documentation":"

Specifies the URL where you can find the generated assessment report. This parameter is only returned if the report is successfully generated.

" + } + } + }, + "GetExclusionsPreviewRequest":{ + "type":"structure", + "required":[ + "assessmentTemplateArn", + "previewToken" + ], + "members":{ + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment template for which the exclusions preview was requested.

" + }, + "previewToken":{ + "shape":"UUID", + "documentation":"

The unique identifier associated of the exclusions preview.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the GetExclusionsPreviewRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The locale into which you want to translate the exclusion's title, description, and recommendation.

" + } + } + }, + "GetExclusionsPreviewResponse":{ + "type":"structure", + "required":["previewStatus"], + "members":{ + "previewStatus":{ + "shape":"PreviewStatus", + "documentation":"

Specifies the status of the request to generate an exclusions preview.

" + }, + "exclusionPreviews":{ + "shape":"ExclusionPreviewList", + "documentation":"

Information about the exclusions included in the preview.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "GetTelemetryMetadataRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment run that has the telemetry data that you want to obtain.

" + } + } + }, + "GetTelemetryMetadataResponse":{ + "type":"structure", + "required":["telemetryMetadata"], + "members":{ + "telemetryMetadata":{ + "shape":"TelemetryMetadataList", + "documentation":"

Telemetry details.

" + } + } + }, + "Hostname":{ + "type":"string", + "max":256, + "min":0 + }, + "InspectorEvent":{ + "type":"string", + "enum":[ + "ASSESSMENT_RUN_STARTED", + "ASSESSMENT_RUN_COMPLETED", + "ASSESSMENT_RUN_STATE_CHANGED", + "FINDING_REPORTED", + "OTHER" + ] + }, + "InspectorServiceAttributes":{ + "type":"structure", + "required":["schemaVersion"], + "members":{ + "schemaVersion":{ + "shape":"NumericVersion", + "documentation":"

The schema version of this data type.

" + }, + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run during which the finding is generated.

" + }, + "rulesPackageArn":{ + "shape":"Arn", + "documentation":"

The ARN of the rules package that is used to generate the finding.

" + } + }, + "documentation":"

This data type is used in the Finding data type.

" + }, + "InternalException":{ + "type":"structure", + "required":[ + "message", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

Internal server error.

", + "exception":true, + "fault":true + }, + "InvalidCrossAccountRoleErrorCode":{ + "type":"string", + "enum":[ + "ROLE_DOES_NOT_EXIST_OR_INVALID_TRUST_RELATIONSHIP", + "ROLE_DOES_NOT_HAVE_CORRECT_POLICY" + ] + }, + "InvalidCrossAccountRoleException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "errorCode":{ + "shape":"InvalidCrossAccountRoleErrorCode", + "documentation":"

Code that indicates the type of error that is generated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

Amazon Inspector cannot assume the cross-account role that it needs to list your EC2 instances during the assessment run.

", + "exception":true + }, + "InvalidInputErrorCode":{ + "type":"string", + "enum":[ + "INVALID_ASSESSMENT_TARGET_ARN", + "INVALID_ASSESSMENT_TEMPLATE_ARN", + "INVALID_ASSESSMENT_RUN_ARN", + "INVALID_FINDING_ARN", + "INVALID_RESOURCE_GROUP_ARN", + "INVALID_RULES_PACKAGE_ARN", + "INVALID_RESOURCE_ARN", + "INVALID_SNS_TOPIC_ARN", + "INVALID_IAM_ROLE_ARN", + "INVALID_ASSESSMENT_TARGET_NAME", + "INVALID_ASSESSMENT_TARGET_NAME_PATTERN", + "INVALID_ASSESSMENT_TEMPLATE_NAME", + "INVALID_ASSESSMENT_TEMPLATE_NAME_PATTERN", + "INVALID_ASSESSMENT_TEMPLATE_DURATION", + "INVALID_ASSESSMENT_TEMPLATE_DURATION_RANGE", + "INVALID_ASSESSMENT_RUN_DURATION_RANGE", + "INVALID_ASSESSMENT_RUN_START_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_COMPLETION_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_STATE_CHANGE_TIME_RANGE", + "INVALID_ASSESSMENT_RUN_STATE", + "INVALID_TAG", + "INVALID_TAG_KEY", + "INVALID_TAG_VALUE", + "INVALID_RESOURCE_GROUP_TAG_KEY", + "INVALID_RESOURCE_GROUP_TAG_VALUE", + "INVALID_ATTRIBUTE", + "INVALID_USER_ATTRIBUTE", + "INVALID_USER_ATTRIBUTE_KEY", + "INVALID_USER_ATTRIBUTE_VALUE", + "INVALID_PAGINATION_TOKEN", + "INVALID_MAX_RESULTS", + "INVALID_AGENT_ID", + "INVALID_AUTO_SCALING_GROUP", + "INVALID_RULE_NAME", + "INVALID_SEVERITY", + "INVALID_LOCALE", + "INVALID_EVENT", + "ASSESSMENT_TARGET_NAME_ALREADY_TAKEN", + "ASSESSMENT_TEMPLATE_NAME_ALREADY_TAKEN", + "INVALID_NUMBER_OF_ASSESSMENT_TARGET_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_TEMPLATE_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_RUN_ARNS", + "INVALID_NUMBER_OF_FINDING_ARNS", + "INVALID_NUMBER_OF_RESOURCE_GROUP_ARNS", + "INVALID_NUMBER_OF_RULES_PACKAGE_ARNS", + "INVALID_NUMBER_OF_ASSESSMENT_RUN_STATES", + "INVALID_NUMBER_OF_TAGS", + "INVALID_NUMBER_OF_RESOURCE_GROUP_TAGS", + "INVALID_NUMBER_OF_ATTRIBUTES", + "INVALID_NUMBER_OF_USER_ATTRIBUTES", + "INVALID_NUMBER_OF_AGENT_IDS", + "INVALID_NUMBER_OF_AUTO_SCALING_GROUPS", + "INVALID_NUMBER_OF_RULE_NAMES", + "INVALID_NUMBER_OF_SEVERITIES" + ] + }, + "InvalidInputException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "errorCode":{ + "shape":"InvalidInputErrorCode", + "documentation":"

Code that indicates the type of error that is generated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", + "exception":true + }, + "IocConfidence":{ + "type":"integer", + "max":10, + "min":0 + }, + "Ipv4Address":{ + "type":"string", + "max":15, + "min":7 + }, + "Ipv4AddressList":{ + "type":"list", + "member":{"shape":"Ipv4Address"}, + "max":50, + "min":0 + }, + "Ipv6Addresses":{ + "type":"list", + "member":{"shape":"Text"} + }, + "KernelVersion":{ + "type":"string", + "max":128, + "min":1 + }, + "LimitExceededErrorCode":{ + "type":"string", + "enum":[ + "ASSESSMENT_TARGET_LIMIT_EXCEEDED", + "ASSESSMENT_TEMPLATE_LIMIT_EXCEEDED", + "ASSESSMENT_RUN_LIMIT_EXCEEDED", + "RESOURCE_GROUP_LIMIT_EXCEEDED", + "EVENT_SUBSCRIPTION_LIMIT_EXCEEDED" + ] + }, + "LimitExceededException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "errorCode":{ + "shape":"LimitExceededErrorCode", + "documentation":"

Code that indicates the type of error that is generated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

", + "exception":true + }, + "ListAssessmentRunAgentsRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment run whose agents you want to list.

" + }, + "filter":{ + "shape":"AgentFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRunAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentRunAgentsResponse":{ + "type":"structure", + "required":["assessmentRunAgents"], + "members":{ + "assessmentRunAgents":{ + "shape":"AssessmentRunAgentList", + "documentation":"

A list of ARNs that specifies the agents returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListAssessmentRunsRequest":{ + "type":"structure", + "members":{ + "assessmentTemplateArns":{ + "shape":"ListParentArnList", + "documentation":"

The ARNs that specify the assessment templates whose assessment runs you want to list.

" + }, + "filter":{ + "shape":"AssessmentRunFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentRuns action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentRunsResponse":{ + "type":"structure", + "required":["assessmentRunArns"], + "members":{ + "assessmentRunArns":{ + "shape":"ListReturnedArnList", + "documentation":"

A list of ARNs that specifies the assessment runs that are returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListAssessmentTargetsRequest":{ + "type":"structure", + "members":{ + "filter":{ + "shape":"AssessmentTargetFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTargets action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentTargetsResponse":{ + "type":"structure", + "required":["assessmentTargetArns"], + "members":{ + "assessmentTargetArns":{ + "shape":"ListReturnedArnList", + "documentation":"

A list of ARNs that specifies the assessment targets that are returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListAssessmentTemplatesRequest":{ + "type":"structure", + "members":{ + "assessmentTargetArns":{ + "shape":"ListParentArnList", + "documentation":"

A list of ARNs that specifies the assessment targets whose assessment templates you want to list.

" + }, + "filter":{ + "shape":"AssessmentTemplateFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListAssessmentTemplates action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListAssessmentTemplatesResponse":{ + "type":"structure", + "required":["assessmentTemplateArns"], + "members":{ + "assessmentTemplateArns":{ + "shape":"ListReturnedArnList", + "documentation":"

A list of ARNs that specifies the assessment templates returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListEventSubscriptionsMaxResults":{"type":"integer"}, + "ListEventSubscriptionsRequest":{ + "type":"structure", + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template for which you want to list the existing event subscriptions.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListEventSubscriptions action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListEventSubscriptionsMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListEventSubscriptionsResponse":{ + "type":"structure", + "required":["subscriptions"], + "members":{ + "subscriptions":{ + "shape":"SubscriptionList", + "documentation":"

Details of the returned event subscriptions.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListExclusionsRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that generated the exclusions that you want to list.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListExclusionsRequest action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 100. The maximum value is 500.

" + } + } + }, + "ListExclusionsResponse":{ + "type":"structure", + "required":["exclusionArns"], + "members":{ + "exclusionArns":{ + "shape":"ListReturnedArnList", + "documentation":"

A list of exclusions' ARNs returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameters is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListFindingsRequest":{ + "type":"structure", + "members":{ + "assessmentRunArns":{ + "shape":"ListParentArnList", + "documentation":"

The ARNs of the assessment runs that generate the findings that you want to list.

" + }, + "filter":{ + "shape":"FindingFilter", + "documentation":"

You can use this parameter to specify a subset of data to be included in the action's response.

For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListFindings action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListFindingsResponse":{ + "type":"structure", + "required":["findingArns"], + "members":{ + "findingArns":{ + "shape":"ListReturnedArnList", + "documentation":"

A list of ARNs that specifies the findings returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListMaxResults":{"type":"integer"}, + "ListParentArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":50, + "min":0 + }, + "ListReturnedArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":100, + "min":0 + }, + "ListRulesPackagesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListRulesPackages action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"ListMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "ListRulesPackagesResponse":{ + "type":"structure", + "required":["rulesPackageArns"], + "members":{ + "rulesPackageArns":{ + "shape":"ListReturnedArnList", + "documentation":"

The list of ARNs that specifies the rules packages returned by the action.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN that specifies the assessment template whose tags you want to list.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

A collection of key and value pairs.

" + } + } + }, + "Locale":{ + "type":"string", + "enum":["EN_US"] + }, + "Long":{"type":"long"}, + "Message":{ + "type":"string", + "max":1000, + "min":0 + }, + "MessageType":{ + "type":"string", + "max":300, + "min":1 + }, + "NamePattern":{ + "type":"string", + "max":140, + "min":1 + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "networkInterfaceId":{ + "shape":"Text", + "documentation":"

The ID of the network interface.

" + }, + "subnetId":{ + "shape":"Text", + "documentation":"

The ID of a subnet associated with the network interface.

" + }, + "vpcId":{ + "shape":"Text", + "documentation":"

The ID of a VPC associated with the network interface.

" + }, + "privateDnsName":{ + "shape":"Text", + "documentation":"

The name of a private DNS associated with the network interface.

" + }, + "privateIpAddress":{ + "shape":"Text", + "documentation":"

The private IP address associated with the network interface.

" + }, + "privateIpAddresses":{ + "shape":"PrivateIpAddresses", + "documentation":"

A list of the private IP addresses associated with the network interface. Includes the privateDnsName and privateIpAddress.

" + }, + "publicDnsName":{ + "shape":"Text", + "documentation":"

The name of a public DNS associated with the network interface.

" + }, + "publicIp":{ + "shape":"Text", + "documentation":"

The public IP address from which the network interface is reachable.

" + }, + "ipv6Addresses":{ + "shape":"Ipv6Addresses", + "documentation":"

The IP addresses associated with the network interface.

" + }, + "securityGroups":{ + "shape":"SecurityGroups", + "documentation":"

A list of the security groups associated with the network interface. Includes the groupId and groupName.

" + } + }, + "documentation":"

Contains information about the network interfaces interacting with an EC2 instance. This data type is used as one of the elements of the AssetAttributes data type.

" + }, + "NetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "NoSuchEntityErrorCode":{ + "type":"string", + "enum":[ + "ASSESSMENT_TARGET_DOES_NOT_EXIST", + "ASSESSMENT_TEMPLATE_DOES_NOT_EXIST", + "ASSESSMENT_RUN_DOES_NOT_EXIST", + "FINDING_DOES_NOT_EXIST", + "RESOURCE_GROUP_DOES_NOT_EXIST", + "RULES_PACKAGE_DOES_NOT_EXIST", + "SNS_TOPIC_DOES_NOT_EXIST", + "IAM_ROLE_DOES_NOT_EXIST" + ] + }, + "NoSuchEntityException":{ + "type":"structure", + "required":[ + "message", + "errorCode", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "errorCode":{ + "shape":"NoSuchEntityErrorCode", + "documentation":"

Code that indicates the type of error that is generated.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can immediately retry your request.

" + } + }, + "documentation":"

The request was rejected because it referenced an entity that does not exist. The error code describes the entity.

", + "exception":true + }, + "NumericSeverity":{ + "type":"double", + "max":10.0, + "min":0.0 + }, + "NumericVersion":{ + "type":"integer", + "min":0 + }, + "OperatingSystem":{ + "type":"string", + "max":256, + "min":1 + }, + "PaginationToken":{ + "type":"string", + "max":300, + "min":1 + }, + "PreviewAgentsMaxResults":{"type":"integer"}, + "PreviewAgentsRequest":{ + "type":"structure", + "required":["previewAgentsArn"], + "members":{ + "previewAgentsArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment target whose agents you want to preview.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the PreviewAgents action. Subsequent calls to the action fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"PreviewAgentsMaxResults", + "documentation":"

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 10. The maximum value is 500.

" + } + } + }, + "PreviewAgentsResponse":{ + "type":"structure", + "required":["agentPreviews"], + "members":{ + "agentPreviews":{ + "shape":"AgentPreviewList", + "documentation":"

The resulting list of agents.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "PreviewGenerationInProgressException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request is rejected. The specified assessment template is currently generating an exclusions preview.

", + "exception":true + }, + "PreviewStatus":{ + "type":"string", + "enum":[ + "WORK_IN_PROGRESS", + "COMPLETED" + ] + }, + "PrivateIp":{ + "type":"structure", + "members":{ + "privateDnsName":{ + "shape":"Text", + "documentation":"

The DNS name of the private IP address.

" + }, + "privateIpAddress":{ + "shape":"Text", + "documentation":"

The full IP address of the network inteface.

" + } + }, + "documentation":"

Contains information about a private IP address associated with a network interface. This data type is used as a response element in the DescribeFindings action.

" + }, + "PrivateIpAddresses":{ + "type":"list", + "member":{"shape":"PrivateIp"} + }, + "ProviderName":{ + "type":"string", + "max":1000, + "min":0 + }, + "RegisterCrossAccountAccessRoleRequest":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the IAM role that grants Amazon Inspector access to AWS Services needed to perform security assessments.

" + } + } + }, + "RemoveAttributesFromFindingsRequest":{ + "type":"structure", + "required":[ + "findingArns", + "attributeKeys" + ], + "members":{ + "findingArns":{ + "shape":"AddRemoveAttributesFindingArnList", + "documentation":"

The ARNs that specify the findings that you want to remove attributes from.

" + }, + "attributeKeys":{ + "shape":"UserAttributeKeyList", + "documentation":"

The array of attribute keys that you want to remove from specified findings.

" + } + } + }, + "RemoveAttributesFromFindingsResponse":{ + "type":"structure", + "required":["failedItems"], + "members":{ + "failedItems":{ + "shape":"FailedItems", + "documentation":"

Attributes details that cannot be described. An error code is provided for each failed item.

" + } + } + }, + "ReportFileFormat":{ + "type":"string", + "enum":[ + "HTML", + "PDF" + ] + }, + "ReportStatus":{ + "type":"string", + "enum":[ + "WORK_IN_PROGRESS", + "FAILED", + "COMPLETED" + ] + }, + "ReportType":{ + "type":"string", + "enum":[ + "FINDING", + "FULL" + ] + }, + "ResourceGroup":{ + "type":"structure", + "required":[ + "arn", + "tags", + "createdAt" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource group.

" + }, + "tags":{ + "shape":"ResourceGroupTags", + "documentation":"

The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time at which resource group is created.

" + } + }, + "documentation":"

Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that make up the assessment target. This data type is used as the response element in the DescribeResourceGroups action.

" + }, + "ResourceGroupList":{ + "type":"list", + "member":{"shape":"ResourceGroup"}, + "max":10, + "min":0 + }, + "ResourceGroupTag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

A tag key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The value assigned to a tag key.

" + } + }, + "documentation":"

This data type is used as one of the elements of the ResourceGroup data type.

" + }, + "ResourceGroupTags":{ + "type":"list", + "member":{"shape":"ResourceGroupTag"}, + "max":10, + "min":1 + }, + "RuleName":{ + "type":"string", + "max":1000 + }, + "RuleNameList":{ + "type":"list", + "member":{"shape":"RuleName"}, + "max":50, + "min":0 + }, + "RulesPackage":{ + "type":"structure", + "required":[ + "arn", + "name", + "version", + "provider" + ], + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the rules package.

" + }, + "name":{ + "shape":"RulesPackageName", + "documentation":"

The name of the rules package.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version ID of the rules package.

" + }, + "provider":{ + "shape":"ProviderName", + "documentation":"

The provider of the rules package.

" + }, + "description":{ + "shape":"Text", + "documentation":"

The description of the rules package.

" + } + }, + "documentation":"

Contains information about an Amazon Inspector rules package. This data type is used as the response element in the DescribeRulesPackages action.

" + }, + "RulesPackageList":{ + "type":"list", + "member":{"shape":"RulesPackage"}, + "max":10, + "min":0 + }, + "RulesPackageName":{ + "type":"string", + "max":1000, + "min":0 + }, + "Scope":{ + "type":"structure", + "members":{ + "key":{ + "shape":"ScopeType", + "documentation":"

The type of the scope.

" + }, + "value":{ + "shape":"ScopeValue", + "documentation":"

The resource identifier for the specified scope type.

" + } + }, + "documentation":"

This data type contains key-value pairs that identify various Amazon resources.

" + }, + "ScopeList":{ + "type":"list", + "member":{"shape":"Scope"}, + "min":1 + }, + "ScopeType":{ + "type":"string", + "enum":[ + "INSTANCE_ID", + "RULES_PACKAGE_ARN" + ] + }, + "ScopeValue":{"type":"string"}, + "SecurityGroup":{ + "type":"structure", + "members":{ + "groupName":{ + "shape":"Text", + "documentation":"

The name of the security group.

" + }, + "groupId":{ + "shape":"Text", + "documentation":"

The ID of the security group.

" + } + }, + "documentation":"

Contains information about a security group associated with a network interface. This data type is used as one of the elements of the NetworkInterface data type.

" + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"SecurityGroup"} + }, + "ServiceName":{ + "type":"string", + "max":128, + "min":0 + }, + "ServiceTemporarilyUnavailableException":{ + "type":"structure", + "required":[ + "message", + "canRetry" + ], + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Details of the exception error.

" + }, + "canRetry":{ + "shape":"Bool", + "documentation":"

You can wait and then retry your request.

" + } + }, + "documentation":"

The serice is temporary unavailable.

", + "exception":true + }, + "SetTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template that you want to set tags to.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

A collection of key and value pairs that you want to set to the assessment template.

" + } + } + }, + "Severity":{ + "type":"string", + "enum":[ + "Low", + "Medium", + "High", + "Informational", + "Undefined" + ] + }, + "SeverityList":{ + "type":"list", + "member":{"shape":"Severity"}, + "max":50, + "min":0 + }, + "StartAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentTemplateArn"], + "members":{ + "assessmentTemplateArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template of the assessment run that you want to start.

" + }, + "assessmentRunName":{ + "shape":"AssessmentRunName", + "documentation":"

You can specify the name for the assessment run. The name must be unique for the assessment template whose ARN is used to start the assessment run.

" + } + } + }, + "StartAssessmentRunResponse":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that has been started.

" + } + } + }, + "StopAction":{ + "type":"string", + "enum":[ + "START_EVALUATION", + "SKIP_EVALUATION" + ] + }, + "StopAssessmentRunRequest":{ + "type":"structure", + "required":["assessmentRunArn"], + "members":{ + "assessmentRunArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment run that you want to stop.

" + }, + "stopAction":{ + "shape":"StopAction", + "documentation":"

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

" + } + } + }, + "SubscribeToEventRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "event", + "topicArn" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template that is used during the event for which you want to receive SNS notifications.

" + }, + "event":{ + "shape":"InspectorEvent", + "documentation":"

The event for which you want to receive SNS notifications.

" + }, + "topicArn":{ + "shape":"Arn", + "documentation":"

The ARN of the SNS topic to which the SNS notifications are sent.

" + } + } + }, + "Subscription":{ + "type":"structure", + "required":[ + "resourceArn", + "topicArn", + "eventSubscriptions" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template that is used during the event for which the SNS notification is sent.

" + }, + "topicArn":{ + "shape":"Arn", + "documentation":"

The ARN of the Amazon Simple Notification Service (SNS) topic to which the SNS notifications are sent.

" + }, + "eventSubscriptions":{ + "shape":"EventSubscriptionList", + "documentation":"

The list of existing event subscriptions.

" + } + }, + "documentation":"

This data type is used as a response element in the ListEventSubscriptions action.

" + }, + "SubscriptionList":{ + "type":"list", + "member":{"shape":"Subscription"}, + "max":50, + "min":0 + }, + "Tag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

A tag key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

A value assigned to a tag key.

" + } + }, + "documentation":"

A key and value pair. This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":10, + "min":0 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TelemetryMetadata":{ + "type":"structure", + "required":[ + "messageType", + "count" + ], + "members":{ + "messageType":{ + "shape":"MessageType", + "documentation":"

A specific type of behavioral data that is collected by the agent.

" + }, + "count":{ + "shape":"Long", + "documentation":"

The count of messages that the agent sends to the Amazon Inspector service.

" + }, + "dataSize":{ + "shape":"Long", + "documentation":"

The data size of messages that the agent sends to the Amazon Inspector service.

" + } + }, + "documentation":"

The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the GetTelemetryMetadata action.

" + }, + "TelemetryMetadataList":{ + "type":"list", + "member":{"shape":"TelemetryMetadata"}, + "max":5000, + "min":0 + }, + "Text":{ + "type":"string", + "max":20000, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "TimestampRange":{ + "type":"structure", + "members":{ + "beginDate":{ + "shape":"Timestamp", + "documentation":"

The minimum value of the timestamp range.

" + }, + "endDate":{ + "shape":"Timestamp", + "documentation":"

The maximum value of the timestamp range.

" + } + }, + "documentation":"

This data type is used in the AssessmentRunFilter data type.

" + }, + "UUID":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "UnsubscribeFromEventRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "event", + "topicArn" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment template that is used during the event for which you want to stop receiving SNS notifications.

" + }, + "event":{ + "shape":"InspectorEvent", + "documentation":"

The event for which you want to stop receiving SNS notifications.

" + }, + "topicArn":{ + "shape":"Arn", + "documentation":"

The ARN of the SNS topic to which SNS notifications are sent.

" + } + } + }, + "UnsupportedFeatureException":{ + "type":"structure", + "required":[ + "message", + "canRetry" + ], + "members":{ + "message":{"shape":"ErrorMessage"}, + "canRetry":{"shape":"Bool"} + }, + "documentation":"

Used by the GetAssessmentReport API. The request was rejected because you tried to generate a report for an assessment run that existed before reporting was supported in Amazon Inspector. You can only generate reports for assessment runs that took place or will take place after generating reports in Amazon Inspector became available.

", + "exception":true + }, + "UpdateAssessmentTargetRequest":{ + "type":"structure", + "required":[ + "assessmentTargetArn", + "assessmentTargetName" + ], + "members":{ + "assessmentTargetArn":{ + "shape":"Arn", + "documentation":"

The ARN of the assessment target that you want to update.

" + }, + "assessmentTargetName":{ + "shape":"AssessmentTargetName", + "documentation":"

The name of the assessment target that you want to update.

" + }, + "resourceGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the resource group that is used to specify the new resource group to associate with the assessment target.

" + } + } + }, + "Url":{ + "type":"string", + "max":2048 + }, + "UserAttributeKeyList":{ + "type":"list", + "member":{"shape":"AttributeKey"}, + "max":10, + "min":0 + }, + "UserAttributeList":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":10, + "min":0 + }, + "Version":{ + "type":"string", + "max":1000, + "min":0 + } + }, + "documentation":"Amazon Inspector

Amazon Inspector enables you to analyze the behavior of your AWS resources and to identify potential security issues. For more information, see Amazon Inspector User Guide.

" +} diff --git a/aws/dist/botocore/data/iot-data/2015-05-28/service-2.json b/aws/dist/botocore/data/iot-data/2015-05-28/service-2.json new file mode 100644 index 00000000..88fba6cd --- /dev/null +++ b/aws/dist/botocore/data/iot-data/2015-05-28/service-2.json @@ -0,0 +1,337 @@ +{ + "version":"2.0", + "metadata":{ + "uid":"iot-data-2015-05-28", + "apiVersion":"2015-05-28", + "endpointPrefix":"data.iot", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Data Plane", + "serviceId":"IoT Data Plane", + "signatureVersion":"v4", + "signingName":"iotdata" + }, + "operations":{ + "DeleteThingShadow":{ + "name":"DeleteThingShadow", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"DeleteThingShadowRequest"}, + "output":{"shape":"DeleteThingShadowResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ], + "documentation":"

Deletes the thing shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

" + }, + "GetThingShadow":{ + "name":"GetThingShadow", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"GetThingShadowRequest"}, + "output":{"shape":"GetThingShadowResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ], + "documentation":"

Gets the thing shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

" + }, + "Publish":{ + "name":"Publish", + "http":{ + "method":"POST", + "requestUri":"/topics/{topic}" + }, + "input":{"shape":"PublishRequest"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"MethodNotAllowedException"} + ], + "documentation":"

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

" + }, + "UpdateThingShadow":{ + "name":"UpdateThingShadow", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}/shadow" + }, + "input":{"shape":"UpdateThingShadowRequest"}, + "output":{"shape":"UpdateThingShadowResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"RequestEntityTooLargeException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"UnsupportedDocumentEncodingException"} + ], + "documentation":"

Updates the thing shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

" + } + }, + "shapes":{ + "ConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The specified version does not match the version of the document.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeleteThingShadowRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + } + }, + "documentation":"

The input for the DeleteThingShadow operation.

" + }, + "DeleteThingShadowResponse":{ + "type":"structure", + "required":["payload"], + "members":{ + "payload":{ + "shape":"JsonDocument", + "documentation":"

The state information, in JSON format.

" + } + }, + "documentation":"

The output from the DeleteThingShadow operation.

", + "payload":"payload" + }, + "ErrorMessage":{"type":"string"}, + "GetThingShadowRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + } + }, + "documentation":"

The input for the GetThingShadow operation.

" + }, + "GetThingShadowResponse":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"JsonDocument", + "documentation":"

The state information, in JSON format.

" + } + }, + "documentation":"

The output from the GetThingShadow operation.

", + "payload":"payload" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An unexpected error has occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "JsonDocument":{"type":"blob"}, + "MethodNotAllowedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The specified combination of HTTP verb and URI is not supported.

", + "error":{"httpStatusCode":405}, + "exception":true + }, + "Payload":{"type":"blob"}, + "PublishRequest":{ + "type":"structure", + "required":["topic"], + "members":{ + "topic":{ + "shape":"Topic", + "documentation":"

The name of the MQTT topic.

", + "location":"uri", + "locationName":"topic" + }, + "qos":{ + "shape":"Qos", + "documentation":"

The Quality of Service (QoS) level.

", + "location":"querystring", + "locationName":"qos" + }, + "payload":{ + "shape":"Payload", + "documentation":"

The state information, in JSON format.

" + } + }, + "documentation":"

The input for the Publish operation.

", + "payload":"payload" + }, + "Qos":{ + "type":"integer", + "max":1, + "min":0 + }, + "RequestEntityTooLargeException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The payload exceeds the maximum size allowed.

", + "error":{"httpStatusCode":413}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The specified resource does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The service is temporarily unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "ThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The rate exceeds the limit.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Topic":{"type":"string"}, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

You are not authorized to perform this operation.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UnsupportedDocumentEncodingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The document encoding is not supported.

", + "error":{"httpStatusCode":415}, + "exception":true + }, + "UpdateThingShadowRequest":{ + "type":"structure", + "required":[ + "thingName", + "payload" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + }, + "payload":{ + "shape":"JsonDocument", + "documentation":"

The state information, in JSON format.

" + } + }, + "documentation":"

The input for the UpdateThingShadow operation.

", + "payload":"payload" + }, + "UpdateThingShadowResponse":{ + "type":"structure", + "members":{ + "payload":{ + "shape":"JsonDocument", + "documentation":"

The state information, in JSON format.

" + } + }, + "documentation":"

The output from the UpdateThingShadow operation.

", + "payload":"payload" + }, + "errorMessage":{"type":"string"} + }, + "documentation":"AWS IoT

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. It implements a broker for applications and things to publish messages over HTTP (Publish) and retrieve, update, and delete thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

" +} diff --git a/aws/dist/botocore/data/iot-jobs-data/2017-09-29/paginators-1.json b/aws/dist/botocore/data/iot-jobs-data/2017-09-29/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/iot-jobs-data/2017-09-29/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/iot-jobs-data/2017-09-29/service-2.json b/aws/dist/botocore/data/iot-jobs-data/2017-09-29/service-2.json new file mode 100644 index 00000000..935bb64e --- /dev/null +++ b/aws/dist/botocore/data/iot-jobs-data/2017-09-29/service-2.json @@ -0,0 +1,494 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-29", + "endpointPrefix":"data.jobs.iot", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Jobs Data Plane", + "serviceId":"IoT Jobs Data Plane", + "signatureVersion":"v4", + "signingName":"iot-jobs-data", + "uid":"iot-jobs-data-2017-09-29" + }, + "operations":{ + "DescribeJobExecution":{ + "name":"DescribeJobExecution", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/jobs/{jobId}" + }, + "input":{"shape":"DescribeJobExecutionRequest"}, + "output":{"shape":"DescribeJobExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"CertificateValidationException"}, + {"shape":"TerminalStateException"} + ], + "documentation":"

Gets details of a job execution.

" + }, + "GetPendingJobExecutions":{ + "name":"GetPendingJobExecutions", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/jobs" + }, + "input":{"shape":"GetPendingJobExecutionsRequest"}, + "output":{"shape":"GetPendingJobExecutionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"CertificateValidationException"} + ], + "documentation":"

Gets the list of all jobs for a thing that are not in a terminal status.

" + }, + "StartNextPendingJobExecution":{ + "name":"StartNextPendingJobExecution", + "http":{ + "method":"PUT", + "requestUri":"/things/{thingName}/jobs/$next" + }, + "input":{"shape":"StartNextPendingJobExecutionRequest"}, + "output":{"shape":"StartNextPendingJobExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"CertificateValidationException"} + ], + "documentation":"

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

" + }, + "UpdateJobExecution":{ + "name":"UpdateJobExecution", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}/jobs/{jobId}" + }, + "input":{"shape":"UpdateJobExecutionRequest"}, + "output":{"shape":"UpdateJobExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"CertificateValidationException"}, + {"shape":"InvalidStateTransitionException"} + ], + "documentation":"

Updates the status of a job execution.

" + } + }, + "shapes":{ + "ApproximateSecondsBeforeTimedOut":{"type":"long"}, + "BinaryBlob":{"type":"blob"}, + "CertificateValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Additional information about the exception.

" + } + }, + "documentation":"

The certificate is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "DescribeJobExecutionJobId":{ + "type":"string", + "pattern":"[a-zA-Z0-9_-]+|^\\$next" + }, + "DescribeJobExecutionRequest":{ + "type":"structure", + "required":[ + "jobId", + "thingName" + ], + "members":{ + "jobId":{ + "shape":"DescribeJobExecutionJobId", + "documentation":"

The unique identifier assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing name associated with the device the job execution is running on.

", + "location":"uri", + "locationName":"thingName" + }, + "includeJobDocument":{ + "shape":"IncludeJobDocument", + "documentation":"

Optional. When set to true, the response contains the job document. The default is false.

", + "location":"querystring", + "locationName":"includeJobDocument" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.

", + "location":"querystring", + "locationName":"executionNumber" + } + } + }, + "DescribeJobExecutionResponse":{ + "type":"structure", + "members":{ + "execution":{ + "shape":"JobExecution", + "documentation":"

Contains data about a job execution.

" + } + } + }, + "DetailsKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "DetailsMap":{ + "type":"map", + "key":{"shape":"DetailsKey"}, + "value":{"shape":"DetailsValue"} + }, + "DetailsValue":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[^\\p{C}]*+" + }, + "ExecutionNumber":{"type":"long"}, + "ExpectedVersion":{"type":"long"}, + "GetPendingJobExecutionsRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing that is executing the job.

", + "location":"uri", + "locationName":"thingName" + } + } + }, + "GetPendingJobExecutionsResponse":{ + "type":"structure", + "members":{ + "inProgressJobs":{ + "shape":"JobExecutionSummaryList", + "documentation":"

A list of JobExecutionSummary objects with status IN_PROGRESS.

" + }, + "queuedJobs":{ + "shape":"JobExecutionSummaryList", + "documentation":"

A list of JobExecutionSummary objects with status QUEUED.

" + } + } + }, + "IncludeExecutionState":{"type":"boolean"}, + "IncludeJobDocument":{"type":"boolean"}, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidStateTransitionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

An update attempted to change the job execution to a state that is invalid because of the job execution's current state (for example, an attempt to change a request in state SUCCESS to state IN_PROGRESS). In this case, the body of the error message also contains the executionState field.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "JobDocument":{ + "type":"string", + "max":32768 + }, + "JobExecution":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing that is executing the job.

" + }, + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\", \"REJECTED\", or \"REMOVED\".

" + }, + "statusDetails":{ + "shape":"DetailsMap", + "documentation":"

A collection of name/value pairs that describe the status of the job execution.

" + }, + "queuedAt":{ + "shape":"QueuedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution was enqueued.

" + }, + "startedAt":{ + "shape":"StartedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution was started.

" + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution was last updated.

" + }, + "approximateSecondsBeforeTimedOut":{ + "shape":"ApproximateSecondsBeforeTimedOut", + "documentation":"

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

" + }, + "versionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

" + }, + "jobDocument":{ + "shape":"JobDocument", + "documentation":"

The content of the job document.

" + } + }, + "documentation":"

Contains data about a job execution.

" + }, + "JobExecutionState":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The status of the job execution. Can be one of: \"QUEUED\", \"IN_PROGRESS\", \"FAILED\", \"SUCCESS\", \"CANCELED\", \"REJECTED\", or \"REMOVED\".

" + }, + "statusDetails":{ + "shape":"DetailsMap", + "documentation":"

A collection of name/value pairs that describe the status of the job execution.

" + }, + "versionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

" + } + }, + "documentation":"

Contains data about the state of a job execution.

" + }, + "JobExecutionStatus":{ + "type":"string", + "enum":[ + "QUEUED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "TIMED_OUT", + "REJECTED", + "REMOVED", + "CANCELED" + ] + }, + "JobExecutionSummary":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "queuedAt":{ + "shape":"QueuedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution was enqueued.

" + }, + "startedAt":{ + "shape":"StartedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution started.

" + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

The time, in milliseconds since the epoch, when the job execution was last updated.

" + }, + "versionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

A number that identifies a particular job execution on a particular device.

" + } + }, + "documentation":"

Contains a subset of information about a job execution.

" + }, + "JobExecutionSummaryList":{ + "type":"list", + "member":{"shape":"JobExecutionSummary"} + }, + "JobId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "LastUpdatedAt":{"type":"long"}, + "QueuedAt":{"type":"long"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The specified resource does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The service is temporarily unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "StartNextPendingJobExecutionRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing associated with the device.

", + "location":"uri", + "locationName":"thingName" + }, + "statusDetails":{ + "shape":"DetailsMap", + "documentation":"

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

" + }, + "stepTimeoutInMinutes":{ + "shape":"StepTimeoutInMinutes", + "documentation":"

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

" + } + } + }, + "StartNextPendingJobExecutionResponse":{ + "type":"structure", + "members":{ + "execution":{ + "shape":"JobExecution", + "documentation":"

A JobExecution object.

" + } + } + }, + "StartedAt":{"type":"long"}, + "StepTimeoutInMinutes":{"type":"long"}, + "TerminalStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The job is in a terminal state.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "ThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message associated with the exception.

" + }, + "payload":{ + "shape":"BinaryBlob", + "documentation":"

The payload associated with the exception.

" + } + }, + "documentation":"

The rate exceeds the limit.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UpdateJobExecutionRequest":{ + "type":"structure", + "required":[ + "jobId", + "thingName", + "status" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing associated with the device.

", + "location":"uri", + "locationName":"thingName" + }, + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

" + }, + "statusDetails":{ + "shape":"DetailsMap", + "documentation":"

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

" + }, + "stepTimeoutInMinutes":{ + "shape":"StepTimeoutInMinutes", + "documentation":"

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

" + }, + "expectedVersion":{ + "shape":"ExpectedVersion", + "documentation":"

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

" + }, + "includeJobExecutionState":{ + "shape":"IncludeExecutionState", + "documentation":"

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

" + }, + "includeJobDocument":{ + "shape":"IncludeJobDocument", + "documentation":"

Optional. When set to true, the response contains the job document. The default is false.

" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

Optional. A number that identifies a particular job execution on a particular device.

" + } + } + }, + "UpdateJobExecutionResponse":{ + "type":"structure", + "members":{ + "executionState":{ + "shape":"JobExecutionState", + "documentation":"

A JobExecutionState object.

" + }, + "jobDocument":{ + "shape":"JobDocument", + "documentation":"

The contents of the Job Documents.

" + } + } + }, + "VersionNumber":{"type":"long"}, + "errorMessage":{"type":"string"} + }, + "documentation":"

AWS IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to AWS IoT. For example, you can define a job that instructs a set of devices to download and install application or firmware updates, reboot, rotate certificates, or perform remote troubleshooting operations.

To create a job, you make a job document which is a description of the remote operations to be performed, and you specify a list of targets that should perform the operations. The targets can be individual things, thing groups or both.

AWS IoT Jobs sends a message to inform the targets that a job is available. The target starts the execution of the job by downloading the job document, performing the operations it specifies, and reporting its progress to AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job

" +} diff --git a/aws/dist/botocore/data/iot/2015-05-28/examples-1.json b/aws/dist/botocore/data/iot/2015-05-28/examples-1.json new file mode 100644 index 00000000..faff7689 --- /dev/null +++ b/aws/dist/botocore/data/iot/2015-05-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/aws/dist/botocore/data/iot/2015-05-28/paginators-1.json b/aws/dist/botocore/data/iot/2015-05-28/paginators-1.json new file mode 100644 index 00000000..8d7fefb5 --- /dev/null +++ b/aws/dist/botocore/data/iot/2015-05-28/paginators-1.json @@ -0,0 +1,225 @@ +{ + "pagination": { + "ListCACertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListCertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListCertificatesByCA": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "certificates" + }, + "ListOutgoingCertificates": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "outgoingCertificates" + }, + "ListPolicies": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "policies" + }, + "ListPolicyPrincipals": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "principals" + }, + "ListPrincipalPolicies": { + "input_token": "marker", + "output_token": "nextMarker", + "limit_key": "pageSize", + "result_key": "policies" + }, + "ListPrincipalThings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "things" + }, + "ListThingTypes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "thingTypes" + }, + "ListThings": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "things" + }, + "ListTopicRules": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "rules" + }, + "ListActiveViolations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "activeViolations" + }, + "ListAttachedPolicies": { + "input_token": "marker", + "limit_key": "pageSize", + "output_token": "nextMarker", + "result_key": "policies" + }, + "ListAuditFindings": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "findings" + }, + "ListAuditTasks": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "tasks" + }, + "ListAuthorizers": { + "input_token": "marker", + "limit_key": "pageSize", + "output_token": "nextMarker", + "result_key": "authorizers" + }, + "ListBillingGroups": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "billingGroups" + }, + "ListIndices": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "indexNames" + }, + "ListJobExecutionsForJob": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "executionSummaries" + }, + "ListJobExecutionsForThing": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "executionSummaries" + }, + "ListJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobs" + }, + "ListOTAUpdates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "otaUpdates" + }, + "ListRoleAliases": { + "input_token": "marker", + "limit_key": "pageSize", + "output_token": "nextMarker", + "result_key": "roleAliases" + }, + "ListScheduledAudits": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "scheduledAudits" + }, + "ListSecurityProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "securityProfileIdentifiers" + }, + "ListSecurityProfilesForTarget": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "securityProfileTargetMappings" + }, + "ListStreams": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "streams" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "tags" + }, + "ListTargetsForPolicy": { + "input_token": "marker", + "limit_key": "pageSize", + "output_token": "nextMarker", + "result_key": "targets" + }, + "ListTargetsForSecurityProfile": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "securityProfileTargets" + }, + "ListThingGroups": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "thingGroups" + }, + "ListThingGroupsForThing": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "thingGroups" + }, + "ListThingRegistrationTasks": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "taskIds" + }, + "ListThingsInBillingGroup": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "things" + }, + "ListThingsInThingGroup": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "things" + }, + "ListV2LoggingLevels": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "logTargetConfigurations" + }, + "ListViolationEvents": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "violationEvents" + } + } +} diff --git a/aws/dist/botocore/data/iot/2015-05-28/service-2.json b/aws/dist/botocore/data/iot/2015-05-28/service-2.json new file mode 100644 index 00000000..40a69df8 --- /dev/null +++ b/aws/dist/botocore/data/iot/2015-05-28/service-2.json @@ -0,0 +1,13503 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-05-28", + "endpointPrefix":"iot", + "protocol":"rest-json", + "serviceFullName":"AWS IoT", + "serviceId":"IoT", + "signatureVersion":"v4", + "signingName":"execute-api", + "uid":"iot-2015-05-28" + }, + "operations":{ + "AcceptCertificateTransfer":{ + "name":"AcceptCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/accept-certificate-transfer/{certificateId}" + }, + "input":{"shape":"AcceptCertificateTransferRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TransferAlreadyCompletedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Accepts a pending certificate transfer. The default state of the certificate is INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

" + }, + "AddThingToBillingGroup":{ + "name":"AddThingToBillingGroup", + "http":{ + "method":"PUT", + "requestUri":"/billing-groups/addThingToBillingGroup" + }, + "input":{"shape":"AddThingToBillingGroupRequest"}, + "output":{"shape":"AddThingToBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds a thing to a billing group.

" + }, + "AddThingToThingGroup":{ + "name":"AddThingToThingGroup", + "http":{ + "method":"PUT", + "requestUri":"/thing-groups/addThingToThingGroup" + }, + "input":{"shape":"AddThingToThingGroupRequest"}, + "output":{"shape":"AddThingToThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds a thing to a thing group.

" + }, + "AssociateTargetsWithJob":{ + "name":"AssociateTargetsWithJob", + "http":{ + "method":"POST", + "requestUri":"/jobs/{jobId}/targets" + }, + "input":{"shape":"AssociateTargetsWithJobRequest"}, + "output":{"shape":"AssociateTargetsWithJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Associates a group with a continuous job. The following criteria must be met:

  • The job must have been created with the targetSelection field set to \"CONTINUOUS\".

  • The job status must currently be \"IN_PROGRESS\".

  • The total number of targets associated with a job must not exceed 100.

" + }, + "AttachPolicy":{ + "name":"AttachPolicy", + "http":{ + "method":"PUT", + "requestUri":"/target-policies/{policyName}" + }, + "input":{"shape":"AttachPolicyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Attaches a policy to the specified target.

" + }, + "AttachPrincipalPolicy":{ + "name":"AttachPrincipalPolicy", + "http":{ + "method":"PUT", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"AttachPrincipalPolicyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Attaches the specified policy to the specified principal (certificate or other credential).

Note: This API is deprecated. Please use AttachPolicy instead.

", + "deprecated":true + }, + "AttachSecurityProfile":{ + "name":"AttachSecurityProfile", + "http":{ + "method":"PUT", + "requestUri":"/security-profiles/{securityProfileName}/targets" + }, + "input":{"shape":"AttachSecurityProfileRequest"}, + "output":{"shape":"AttachSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Associates a Device Defender security profile with a thing group or this account. Each thing group or account can have up to five security profiles associated with it.

" + }, + "AttachThingPrincipal":{ + "name":"AttachThingPrincipal", + "http":{ + "method":"PUT", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"AttachThingPrincipalRequest"}, + "output":{"shape":"AttachThingPrincipalResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Attaches the specified principal to the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

" + }, + "CancelAuditMitigationActionsTask":{ + "name":"CancelAuditMitigationActionsTask", + "http":{ + "method":"PUT", + "requestUri":"/audit/mitigationactions/tasks/{taskId}/cancel" + }, + "input":{"shape":"CancelAuditMitigationActionsTaskRequest"}, + "output":{"shape":"CancelAuditMitigationActionsTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Cancels a mitigation action task that is in progress. If the task is not in progress, an InvalidRequestException occurs.

" + }, + "CancelAuditTask":{ + "name":"CancelAuditTask", + "http":{ + "method":"PUT", + "requestUri":"/audit/tasks/{taskId}/cancel" + }, + "input":{"shape":"CancelAuditTaskRequest"}, + "output":{"shape":"CancelAuditTaskResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Cancels an audit that is in progress. The audit can be either scheduled or on-demand. If the audit is not in progress, an \"InvalidRequestException\" occurs.

" + }, + "CancelCertificateTransfer":{ + "name":"CancelCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/cancel-certificate-transfer/{certificateId}" + }, + "input":{"shape":"CancelCertificateTransferRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TransferAlreadyCompletedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Cancels a pending transfer for the specified certificate.

Note Only the transfer source account can use this operation to cancel a transfer. (Transfer destinations can use RejectCertificateTransfer instead.) After transfer, AWS IoT returns the certificate to the source account in the INACTIVE state. After the destination account has accepted the transfer, the transfer cannot be cancelled.

After a certificate transfer is cancelled, the status of the certificate changes from PENDING_TRANSFER to INACTIVE.

" + }, + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"PUT", + "requestUri":"/jobs/{jobId}/cancel" + }, + "input":{"shape":"CancelJobRequest"}, + "output":{"shape":"CancelJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Cancels a job.

" + }, + "CancelJobExecution":{ + "name":"CancelJobExecution", + "http":{ + "method":"PUT", + "requestUri":"/things/{thingName}/jobs/{jobId}/cancel" + }, + "input":{"shape":"CancelJobExecutionRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"VersionConflictException"} + ], + "documentation":"

Cancels the execution of a job for a given thing.

" + }, + "ClearDefaultAuthorizer":{ + "name":"ClearDefaultAuthorizer", + "http":{ + "method":"DELETE", + "requestUri":"/default-authorizer" + }, + "input":{"shape":"ClearDefaultAuthorizerRequest"}, + "output":{"shape":"ClearDefaultAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Clears the default authorizer.

" + }, + "CreateAuthorizer":{ + "name":"CreateAuthorizer", + "http":{ + "method":"POST", + "requestUri":"/authorizer/{authorizerName}" + }, + "input":{"shape":"CreateAuthorizerRequest"}, + "output":{"shape":"CreateAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates an authorizer.

" + }, + "CreateBillingGroup":{ + "name":"CreateBillingGroup", + "http":{ + "method":"POST", + "requestUri":"/billing-groups/{billingGroupName}" + }, + "input":{"shape":"CreateBillingGroupRequest"}, + "output":{"shape":"CreateBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a billing group.

" + }, + "CreateCertificateFromCsr":{ + "name":"CreateCertificateFromCsr", + "http":{ + "method":"POST", + "requestUri":"/certificates" + }, + "input":{"shape":"CreateCertificateFromCsrRequest"}, + "output":{"shape":"CreateCertificateFromCsrResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates an X.509 certificate using the specified certificate signing request.

Note: The CSR must include a public key that is either an RSA key with a length of at least 2048 bits or an ECC key from NIST P-256 or NIST P-384 curves.

Note: Reusing the same certificate signing request (CSR) results in a distinct certificate.

You can create multiple certificates in a batch by creating a directory, copying multiple .csr files into that directory, and then specifying that directory on the command line. The following commands show how to create a batch of certificates given a batch of CSRs.

Assuming a set of CSRs are located inside of the directory my-csr-directory:

On Linux and OS X, the command is:

$ ls my-csr-directory/ | xargs -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

This command lists all of the CSRs in my-csr-directory and pipes each CSR file name to the aws iot create-certificate-from-csr AWS CLI command to create a certificate for the corresponding CSR.

The aws iot create-certificate-from-csr part of the command can also be run in parallel to speed up the certificate creation process:

$ ls my-csr-directory/ | xargs -P 10 -I {} aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/{}

On Windows PowerShell, the command to create certificates for all CSRs in my-csr-directory is:

> ls -Name my-csr-directory | %{aws iot create-certificate-from-csr --certificate-signing-request file://my-csr-directory/$_}

On a Windows command prompt, the command to create certificates for all CSRs in my-csr-directory is:

> forfiles /p my-csr-directory /c \"cmd /c aws iot create-certificate-from-csr --certificate-signing-request file://@path\"

" + }, + "CreateDynamicThingGroup":{ + "name":"CreateDynamicThingGroup", + "http":{ + "method":"POST", + "requestUri":"/dynamic-thing-groups/{thingGroupName}" + }, + "input":{"shape":"CreateDynamicThingGroupRequest"}, + "output":{"shape":"CreateDynamicThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"InvalidQueryException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a dynamic thing group.

" + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"PUT", + "requestUri":"/jobs/{jobId}" + }, + "input":{"shape":"CreateJobRequest"}, + "output":{"shape":"CreateJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a job.

" + }, + "CreateKeysAndCertificate":{ + "name":"CreateKeysAndCertificate", + "http":{ + "method":"POST", + "requestUri":"/keys-and-certificate" + }, + "input":{"shape":"CreateKeysAndCertificateRequest"}, + "output":{"shape":"CreateKeysAndCertificateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a 2048-bit RSA key pair and issues an X.509 certificate using the issued public key.

Note This is the only time AWS IoT issues the private key for this certificate, so it is important to keep it in a secure location.

" + }, + "CreateMitigationAction":{ + "name":"CreateMitigationAction", + "http":{ + "method":"POST", + "requestUri":"/mitigationactions/actions/{actionName}" + }, + "input":{"shape":"CreateMitigationActionRequest"}, + "output":{"shape":"CreateMitigationActionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Defines an action that can be applied to audit findings by using StartAuditMitigationActionsTask. Each mitigation action can apply only one type of change.

" + }, + "CreateOTAUpdate":{ + "name":"CreateOTAUpdate", + "http":{ + "method":"POST", + "requestUri":"/otaUpdates/{otaUpdateId}" + }, + "input":{"shape":"CreateOTAUpdateRequest"}, + "output":{"shape":"CreateOTAUpdateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates an AWS IoT OTAUpdate on a target group of things or groups.

" + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{"shape":"CreatePolicyResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"MalformedPolicyException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates an AWS IoT policy.

The created policy is the default version for the policy. This operation creates a policy version with a version identifier of 1 and sets 1 as the policy's default version.

" + }, + "CreatePolicyVersion":{ + "name":"CreatePolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"CreatePolicyVersionRequest"}, + "output":{"shape":"CreatePolicyVersionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"MalformedPolicyException"}, + {"shape":"VersionsLimitExceededException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a new version of the specified AWS IoT policy. To update a policy, create a new policy version. A managed policy can have up to five versions. If the policy has five versions, you must use DeletePolicyVersion to delete an existing version before you create a new one.

Optionally, you can set the new version as the policy's default version. The default version is the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

" + }, + "CreateRoleAlias":{ + "name":"CreateRoleAlias", + "http":{ + "method":"POST", + "requestUri":"/role-aliases/{roleAlias}" + }, + "input":{"shape":"CreateRoleAliasRequest"}, + "output":{"shape":"CreateRoleAliasResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a role alias.

" + }, + "CreateScheduledAudit":{ + "name":"CreateScheduledAudit", + "http":{ + "method":"POST", + "requestUri":"/audit/scheduledaudits/{scheduledAuditName}" + }, + "input":{"shape":"CreateScheduledAuditRequest"}, + "output":{"shape":"CreateScheduledAuditResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a scheduled audit that is run at a specified time interval.

" + }, + "CreateSecurityProfile":{ + "name":"CreateSecurityProfile", + "http":{ + "method":"POST", + "requestUri":"/security-profiles/{securityProfileName}" + }, + "input":{"shape":"CreateSecurityProfileRequest"}, + "output":{"shape":"CreateSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a Device Defender security profile.

" + }, + "CreateStream":{ + "name":"CreateStream", + "http":{ + "method":"POST", + "requestUri":"/streams/{streamId}" + }, + "input":{"shape":"CreateStreamRequest"}, + "output":{"shape":"CreateStreamResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a stream for delivering one or more large files in chunks over MQTT. A stream transports data bytes in chunks or blocks packaged as MQTT messages from a source like S3. You can have one or more files associated with a stream. The total size of a file associated with the stream cannot exceed more than 2 MB. The stream will be created with version 0. If a stream is created with the same streamID as a stream that existed and was deleted within last 90 days, we will resurrect that old stream by incrementing the version by 1.

" + }, + "CreateThing":{ + "name":"CreateThing", + "http":{ + "method":"POST", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"CreateThingRequest"}, + "output":{"shape":"CreateThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a thing record in the registry. If this call is made multiple times using the same thing name and configuration, the call will succeed. If this call is made with the same thing name but different configuration a ResourceAlreadyExistsException is thrown.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

" + }, + "CreateThingGroup":{ + "name":"CreateThingGroup", + "http":{ + "method":"POST", + "requestUri":"/thing-groups/{thingGroupName}" + }, + "input":{"shape":"CreateThingGroupRequest"}, + "output":{"shape":"CreateThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Create a thing group.

This is a control plane operation. See Authorization for information about authorizing control plane actions.

" + }, + "CreateThingType":{ + "name":"CreateThingType", + "http":{ + "method":"POST", + "requestUri":"/thing-types/{thingTypeName}" + }, + "input":{"shape":"CreateThingTypeRequest"}, + "output":{"shape":"CreateThingTypeResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

Creates a new thing type.

" + }, + "CreateTopicRule":{ + "name":"CreateTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"CreateTopicRuleRequest"}, + "errors":[ + {"shape":"SqlParseException"}, + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ConflictingResourceUpdateException"} + ], + "documentation":"

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

" + }, + "DeleteAccountAuditConfiguration":{ + "name":"DeleteAccountAuditConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/audit/configuration" + }, + "input":{"shape":"DeleteAccountAuditConfigurationRequest"}, + "output":{"shape":"DeleteAccountAuditConfigurationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Restores the default settings for Device Defender audits for this account. Any configuration data you entered is deleted and all audit checks are reset to disabled.

" + }, + "DeleteAuthorizer":{ + "name":"DeleteAuthorizer", + "http":{ + "method":"DELETE", + "requestUri":"/authorizer/{authorizerName}" + }, + "input":{"shape":"DeleteAuthorizerRequest"}, + "output":{"shape":"DeleteAuthorizerResponse"}, + "errors":[ + {"shape":"DeleteConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes an authorizer.

" + }, + "DeleteBillingGroup":{ + "name":"DeleteBillingGroup", + "http":{ + "method":"DELETE", + "requestUri":"/billing-groups/{billingGroupName}" + }, + "input":{"shape":"DeleteBillingGroupRequest"}, + "output":{"shape":"DeleteBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the billing group.

" + }, + "DeleteCACertificate":{ + "name":"DeleteCACertificate", + "http":{ + "method":"DELETE", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"DeleteCACertificateRequest"}, + "output":{"shape":"DeleteCACertificateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"CertificateStateException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a registered CA certificate.

" + }, + "DeleteCertificate":{ + "name":"DeleteCertificate", + "http":{ + "method":"DELETE", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DeleteCertificateRequest"}, + "errors":[ + {"shape":"CertificateStateException"}, + {"shape":"DeleteConflictException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the specified certificate.

A certificate cannot be deleted if it has a policy or IoT thing attached to it or if its status is set to ACTIVE. To delete a certificate, first use the DetachPrincipalPolicy API to detach all policies. Next, use the UpdateCertificate API to set the certificate to the INACTIVE status.

" + }, + "DeleteDynamicThingGroup":{ + "name":"DeleteDynamicThingGroup", + "http":{ + "method":"DELETE", + "requestUri":"/dynamic-thing-groups/{thingGroupName}" + }, + "input":{"shape":"DeleteDynamicThingGroupRequest"}, + "output":{"shape":"DeleteDynamicThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a dynamic thing group.

" + }, + "DeleteJob":{ + "name":"DeleteJob", + "http":{ + "method":"DELETE", + "requestUri":"/jobs/{jobId}" + }, + "input":{"shape":"DeleteJobRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes a job and its related job executions.

Deleting a job may take time, depending on the number of job executions created for the job and various other factors. While the job is being deleted, the status of the job will be shown as \"DELETION_IN_PROGRESS\". Attempting to delete or cancel a job whose status is already \"DELETION_IN_PROGRESS\" will result in an error.

Only 10 jobs may have status \"DELETION_IN_PROGRESS\" at the same time, or a LimitExceededException will occur.

" + }, + "DeleteJobExecution":{ + "name":"DeleteJobExecution", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}" + }, + "input":{"shape":"DeleteJobExecutionRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes a job execution.

" + }, + "DeleteMitigationAction":{ + "name":"DeleteMitigationAction", + "http":{ + "method":"DELETE", + "requestUri":"/mitigationactions/actions/{actionName}" + }, + "input":{"shape":"DeleteMitigationActionRequest"}, + "output":{"shape":"DeleteMitigationActionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a defined mitigation action from your AWS account.

" + }, + "DeleteOTAUpdate":{ + "name":"DeleteOTAUpdate", + "http":{ + "method":"DELETE", + "requestUri":"/otaUpdates/{otaUpdateId}" + }, + "input":{"shape":"DeleteOTAUpdateRequest"}, + "output":{"shape":"DeleteOTAUpdateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"VersionConflictException"} + ], + "documentation":"

Delete an OTA update.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + {"shape":"DeleteConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the specified policy.

A policy cannot be deleted if it has non-default versions or it is attached to any certificate.

To delete a policy, use the DeletePolicyVersion API to delete all non-default versions of the policy; use the DetachPrincipalPolicy API to detach the policy from any certificate; and then use the DeletePolicy API to delete the policy.

When a policy is deleted using DeletePolicy, its default version is deleted with it.

" + }, + "DeletePolicyVersion":{ + "name":"DeletePolicyVersion", + "http":{ + "method":"DELETE", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"DeletePolicyVersionRequest"}, + "errors":[ + {"shape":"DeleteConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the specified version of the specified policy. You cannot delete the default version of a policy using this API. To delete the default version of a policy, use DeletePolicy. To find out which version of a policy is marked as the default version, use ListPolicyVersions.

" + }, + "DeleteRegistrationCode":{ + "name":"DeleteRegistrationCode", + "http":{ + "method":"DELETE", + "requestUri":"/registrationcode" + }, + "input":{"shape":"DeleteRegistrationCodeRequest"}, + "output":{"shape":"DeleteRegistrationCodeResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a CA certificate registration code.

" + }, + "DeleteRoleAlias":{ + "name":"DeleteRoleAlias", + "http":{ + "method":"DELETE", + "requestUri":"/role-aliases/{roleAlias}" + }, + "input":{"shape":"DeleteRoleAliasRequest"}, + "output":{"shape":"DeleteRoleAliasResponse"}, + "errors":[ + {"shape":"DeleteConflictException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a role alias

" + }, + "DeleteScheduledAudit":{ + "name":"DeleteScheduledAudit", + "http":{ + "method":"DELETE", + "requestUri":"/audit/scheduledaudits/{scheduledAuditName}" + }, + "input":{"shape":"DeleteScheduledAuditRequest"}, + "output":{"shape":"DeleteScheduledAuditResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a scheduled audit.

" + }, + "DeleteSecurityProfile":{ + "name":"DeleteSecurityProfile", + "http":{ + "method":"DELETE", + "requestUri":"/security-profiles/{securityProfileName}" + }, + "input":{"shape":"DeleteSecurityProfileRequest"}, + "output":{"shape":"DeleteSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"VersionConflictException"} + ], + "documentation":"

Deletes a Device Defender security profile.

" + }, + "DeleteStream":{ + "name":"DeleteStream", + "http":{ + "method":"DELETE", + "requestUri":"/streams/{streamId}" + }, + "input":{"shape":"DeleteStreamRequest"}, + "output":{"shape":"DeleteStreamResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DeleteConflictException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a stream.

" + }, + "DeleteThing":{ + "name":"DeleteThing", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DeleteThingRequest"}, + "output":{"shape":"DeleteThingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"VersionConflictException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the specified thing. Returns successfully with no error if the deletion is successful or you specify a thing that doesn't exist.

" + }, + "DeleteThingGroup":{ + "name":"DeleteThingGroup", + "http":{ + "method":"DELETE", + "requestUri":"/thing-groups/{thingGroupName}" + }, + "input":{"shape":"DeleteThingGroupRequest"}, + "output":{"shape":"DeleteThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a thing group.

" + }, + "DeleteThingType":{ + "name":"DeleteThingType", + "http":{ + "method":"DELETE", + "requestUri":"/thing-types/{thingTypeName}" + }, + "input":{"shape":"DeleteThingTypeRequest"}, + "output":{"shape":"DeleteThingTypeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the specified thing type. You cannot delete a thing type if it has things associated with it. To delete a thing type, first mark it as deprecated by calling DeprecateThingType, then remove any associated things by calling UpdateThing to change the thing type on any associated thing, and finally use DeleteThingType to delete the thing type.

" + }, + "DeleteTopicRule":{ + "name":"DeleteTopicRule", + "http":{ + "method":"DELETE", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"DeleteTopicRuleRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ConflictingResourceUpdateException"} + ], + "documentation":"

Deletes the rule.

" + }, + "DeleteV2LoggingLevel":{ + "name":"DeleteV2LoggingLevel", + "http":{ + "method":"DELETE", + "requestUri":"/v2LoggingLevel" + }, + "input":{"shape":"DeleteV2LoggingLevelRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes a logging level.

" + }, + "DeprecateThingType":{ + "name":"DeprecateThingType", + "http":{ + "method":"POST", + "requestUri":"/thing-types/{thingTypeName}/deprecate" + }, + "input":{"shape":"DeprecateThingTypeRequest"}, + "output":{"shape":"DeprecateThingTypeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deprecates a thing type. You can not associate new things with deprecated thing type.

" + }, + "DescribeAccountAuditConfiguration":{ + "name":"DescribeAccountAuditConfiguration", + "http":{ + "method":"GET", + "requestUri":"/audit/configuration" + }, + "input":{"shape":"DescribeAccountAuditConfigurationRequest"}, + "output":{"shape":"DescribeAccountAuditConfigurationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

" + }, + "DescribeAuditFinding":{ + "name":"DescribeAuditFinding", + "http":{ + "method":"GET", + "requestUri":"/audit/findings/{findingId}" + }, + "input":{"shape":"DescribeAuditFindingRequest"}, + "output":{"shape":"DescribeAuditFindingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a single audit finding. Properties include the reason for noncompliance, the severity of the issue, and when the audit that returned the finding was started.

" + }, + "DescribeAuditMitigationActionsTask":{ + "name":"DescribeAuditMitigationActionsTask", + "http":{ + "method":"GET", + "requestUri":"/audit/mitigationactions/tasks/{taskId}" + }, + "input":{"shape":"DescribeAuditMitigationActionsTaskRequest"}, + "output":{"shape":"DescribeAuditMitigationActionsTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about an audit mitigation task that is used to apply mitigation actions to a set of audit findings. Properties include the actions being applied, the audit checks to which they're being applied, the task status, and aggregated task statistics.

" + }, + "DescribeAuditTask":{ + "name":"DescribeAuditTask", + "http":{ + "method":"GET", + "requestUri":"/audit/tasks/{taskId}" + }, + "input":{"shape":"DescribeAuditTaskRequest"}, + "output":{"shape":"DescribeAuditTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a Device Defender audit.

" + }, + "DescribeAuthorizer":{ + "name":"DescribeAuthorizer", + "http":{ + "method":"GET", + "requestUri":"/authorizer/{authorizerName}" + }, + "input":{"shape":"DescribeAuthorizerRequest"}, + "output":{"shape":"DescribeAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Describes an authorizer.

" + }, + "DescribeBillingGroup":{ + "name":"DescribeBillingGroup", + "http":{ + "method":"GET", + "requestUri":"/billing-groups/{billingGroupName}" + }, + "input":{"shape":"DescribeBillingGroupRequest"}, + "output":{"shape":"DescribeBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a billing group.

" + }, + "DescribeCACertificate":{ + "name":"DescribeCACertificate", + "http":{ + "method":"GET", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"DescribeCACertificateRequest"}, + "output":{"shape":"DescribeCACertificateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a registered CA certificate.

" + }, + "DescribeCertificate":{ + "name":"DescribeCertificate", + "http":{ + "method":"GET", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"DescribeCertificateRequest"}, + "output":{"shape":"DescribeCertificateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets information about the specified certificate.

" + }, + "DescribeDefaultAuthorizer":{ + "name":"DescribeDefaultAuthorizer", + "http":{ + "method":"GET", + "requestUri":"/default-authorizer" + }, + "input":{"shape":"DescribeDefaultAuthorizerRequest"}, + "output":{"shape":"DescribeDefaultAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Describes the default authorizer.

" + }, + "DescribeEndpoint":{ + "name":"DescribeEndpoint", + "http":{ + "method":"GET", + "requestUri":"/endpoint" + }, + "input":{"shape":"DescribeEndpointRequest"}, + "output":{"shape":"DescribeEndpointResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Returns a unique endpoint specific to the AWS account making the call.

" + }, + "DescribeEventConfigurations":{ + "name":"DescribeEventConfigurations", + "http":{ + "method":"GET", + "requestUri":"/event-configurations" + }, + "input":{"shape":"DescribeEventConfigurationsRequest"}, + "output":{"shape":"DescribeEventConfigurationsResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Describes event configurations.

" + }, + "DescribeIndex":{ + "name":"DescribeIndex", + "http":{ + "method":"GET", + "requestUri":"/indices/{indexName}" + }, + "input":{"shape":"DescribeIndexRequest"}, + "output":{"shape":"DescribeIndexResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a search index.

" + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"GET", + "requestUri":"/jobs/{jobId}" + }, + "input":{"shape":"DescribeJobRequest"}, + "output":{"shape":"DescribeJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Describes a job.

" + }, + "DescribeJobExecution":{ + "name":"DescribeJobExecution", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/jobs/{jobId}" + }, + "input":{"shape":"DescribeJobExecutionRequest"}, + "output":{"shape":"DescribeJobExecutionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Describes a job execution.

" + }, + "DescribeMitigationAction":{ + "name":"DescribeMitigationAction", + "http":{ + "method":"GET", + "requestUri":"/mitigationactions/actions/{actionName}" + }, + "input":{"shape":"DescribeMitigationActionRequest"}, + "output":{"shape":"DescribeMitigationActionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a mitigation action.

" + }, + "DescribeRoleAlias":{ + "name":"DescribeRoleAlias", + "http":{ + "method":"GET", + "requestUri":"/role-aliases/{roleAlias}" + }, + "input":{"shape":"DescribeRoleAliasRequest"}, + "output":{"shape":"DescribeRoleAliasResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a role alias.

" + }, + "DescribeScheduledAudit":{ + "name":"DescribeScheduledAudit", + "http":{ + "method":"GET", + "requestUri":"/audit/scheduledaudits/{scheduledAuditName}" + }, + "input":{"shape":"DescribeScheduledAuditRequest"}, + "output":{"shape":"DescribeScheduledAuditResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a scheduled audit.

" + }, + "DescribeSecurityProfile":{ + "name":"DescribeSecurityProfile", + "http":{ + "method":"GET", + "requestUri":"/security-profiles/{securityProfileName}" + }, + "input":{"shape":"DescribeSecurityProfileRequest"}, + "output":{"shape":"DescribeSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a Device Defender security profile.

" + }, + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"GET", + "requestUri":"/streams/{streamId}" + }, + "input":{"shape":"DescribeStreamRequest"}, + "output":{"shape":"DescribeStreamResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about a stream.

" + }, + "DescribeThing":{ + "name":"DescribeThing", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"DescribeThingRequest"}, + "output":{"shape":"DescribeThingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about the specified thing.

" + }, + "DescribeThingGroup":{ + "name":"DescribeThingGroup", + "http":{ + "method":"GET", + "requestUri":"/thing-groups/{thingGroupName}" + }, + "input":{"shape":"DescribeThingGroupRequest"}, + "output":{"shape":"DescribeThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describe a thing group.

" + }, + "DescribeThingRegistrationTask":{ + "name":"DescribeThingRegistrationTask", + "http":{ + "method":"GET", + "requestUri":"/thing-registration-tasks/{taskId}" + }, + "input":{"shape":"DescribeThingRegistrationTaskRequest"}, + "output":{"shape":"DescribeThingRegistrationTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a bulk thing provisioning task.

" + }, + "DescribeThingType":{ + "name":"DescribeThingType", + "http":{ + "method":"GET", + "requestUri":"/thing-types/{thingTypeName}" + }, + "input":{"shape":"DescribeThingTypeRequest"}, + "output":{"shape":"DescribeThingTypeResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about the specified thing type.

" + }, + "DetachPolicy":{ + "name":"DetachPolicy", + "http":{ + "method":"POST", + "requestUri":"/target-policies/{policyName}" + }, + "input":{"shape":"DetachPolicyRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Detaches a policy from the specified target.

" + }, + "DetachPrincipalPolicy":{ + "name":"DetachPrincipalPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/principal-policies/{policyName}" + }, + "input":{"shape":"DetachPrincipalPolicyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Removes the specified policy from the specified certificate.

Note: This API is deprecated. Please use DetachPolicy instead.

", + "deprecated":true + }, + "DetachSecurityProfile":{ + "name":"DetachSecurityProfile", + "http":{ + "method":"DELETE", + "requestUri":"/security-profiles/{securityProfileName}/targets" + }, + "input":{"shape":"DetachSecurityProfileRequest"}, + "output":{"shape":"DetachSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Disassociates a Device Defender security profile from a thing group or from this account.

" + }, + "DetachThingPrincipal":{ + "name":"DetachThingPrincipal", + "http":{ + "method":"DELETE", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"DetachThingPrincipalRequest"}, + "output":{"shape":"DetachThingPrincipalResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Detaches the specified principal from the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

This call is asynchronous. It might take several seconds for the detachment to propagate.

" + }, + "DisableTopicRule":{ + "name":"DisableTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}/disable" + }, + "input":{"shape":"DisableTopicRuleRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ConflictingResourceUpdateException"} + ], + "documentation":"

Disables the rule.

" + }, + "EnableTopicRule":{ + "name":"EnableTopicRule", + "http":{ + "method":"POST", + "requestUri":"/rules/{ruleName}/enable" + }, + "input":{"shape":"EnableTopicRuleRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ConflictingResourceUpdateException"} + ], + "documentation":"

Enables the rule.

" + }, + "GetEffectivePolicies":{ + "name":"GetEffectivePolicies", + "http":{ + "method":"POST", + "requestUri":"/effective-policies" + }, + "input":{"shape":"GetEffectivePoliciesRequest"}, + "output":{"shape":"GetEffectivePoliciesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Gets a list of the policies that have an effect on the authorization behavior of the specified device when it connects to the AWS IoT device gateway.

" + }, + "GetIndexingConfiguration":{ + "name":"GetIndexingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/indexing/config" + }, + "input":{"shape":"GetIndexingConfigurationRequest"}, + "output":{"shape":"GetIndexingConfigurationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets the search configuration.

" + }, + "GetJobDocument":{ + "name":"GetJobDocument", + "http":{ + "method":"GET", + "requestUri":"/jobs/{jobId}/job-document" + }, + "input":{"shape":"GetJobDocumentRequest"}, + "output":{"shape":"GetJobDocumentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Gets a job document.

" + }, + "GetLoggingOptions":{ + "name":"GetLoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"GetLoggingOptionsRequest"}, + "output":{"shape":"GetLoggingOptionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Gets the logging options.

NOTE: use of this command is not recommended. Use GetV2LoggingOptions instead.

" + }, + "GetOTAUpdate":{ + "name":"GetOTAUpdate", + "http":{ + "method":"GET", + "requestUri":"/otaUpdates/{otaUpdateId}" + }, + "input":{"shape":"GetOTAUpdateRequest"}, + "output":{"shape":"GetOTAUpdateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets an OTA update.

" + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}" + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about the specified policy with the policy document of the default version.

" + }, + "GetPolicyVersion":{ + "name":"GetPolicyVersion", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"GetPolicyVersionRequest"}, + "output":{"shape":"GetPolicyVersionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets information about the specified policy version.

" + }, + "GetRegistrationCode":{ + "name":"GetRegistrationCode", + "http":{ + "method":"GET", + "requestUri":"/registrationcode" + }, + "input":{"shape":"GetRegistrationCodeRequest"}, + "output":{"shape":"GetRegistrationCodeResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Gets a registration code used to register a CA certificate with AWS IoT.

" + }, + "GetStatistics":{ + "name":"GetStatistics", + "http":{ + "method":"POST", + "requestUri":"/indices/statistics" + }, + "input":{"shape":"GetStatisticsRequest"}, + "output":{"shape":"GetStatisticsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidQueryException"}, + {"shape":"InvalidAggregationException"}, + {"shape":"IndexNotReadyException"} + ], + "documentation":"

Gets statistics about things that match the specified query.

" + }, + "GetTopicRule":{ + "name":"GetTopicRule", + "http":{ + "method":"GET", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"GetTopicRuleRequest"}, + "output":{"shape":"GetTopicRuleResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"} + ], + "documentation":"

Gets information about the rule.

" + }, + "GetV2LoggingOptions":{ + "name":"GetV2LoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/v2LoggingOptions" + }, + "input":{"shape":"GetV2LoggingOptionsRequest"}, + "output":{"shape":"GetV2LoggingOptionsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"NotConfiguredException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Gets the fine grained logging options.

" + }, + "ListActiveViolations":{ + "name":"ListActiveViolations", + "http":{ + "method":"GET", + "requestUri":"/active-violations" + }, + "input":{"shape":"ListActiveViolationsRequest"}, + "output":{"shape":"ListActiveViolationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the active violations for a given Device Defender security profile.

" + }, + "ListAttachedPolicies":{ + "name":"ListAttachedPolicies", + "http":{ + "method":"POST", + "requestUri":"/attached-policies/{target}" + }, + "input":{"shape":"ListAttachedPoliciesRequest"}, + "output":{"shape":"ListAttachedPoliciesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Lists the policies attached to the specified thing group.

" + }, + "ListAuditFindings":{ + "name":"ListAuditFindings", + "http":{ + "method":"POST", + "requestUri":"/audit/findings" + }, + "input":{"shape":"ListAuditFindingsRequest"}, + "output":{"shape":"ListAuditFindingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 180 days.)

" + }, + "ListAuditMitigationActionsExecutions":{ + "name":"ListAuditMitigationActionsExecutions", + "http":{ + "method":"GET", + "requestUri":"/audit/mitigationactions/executions" + }, + "input":{"shape":"ListAuditMitigationActionsExecutionsRequest"}, + "output":{"shape":"ListAuditMitigationActionsExecutionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets the status of audit mitigation action tasks that were executed.

" + }, + "ListAuditMitigationActionsTasks":{ + "name":"ListAuditMitigationActionsTasks", + "http":{ + "method":"GET", + "requestUri":"/audit/mitigationactions/tasks" + }, + "input":{"shape":"ListAuditMitigationActionsTasksRequest"}, + "output":{"shape":"ListAuditMitigationActionsTasksResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets a list of audit mitigation action tasks that match the specified filters.

" + }, + "ListAuditTasks":{ + "name":"ListAuditTasks", + "http":{ + "method":"GET", + "requestUri":"/audit/tasks" + }, + "input":{"shape":"ListAuditTasksRequest"}, + "output":{"shape":"ListAuditTasksResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the Device Defender audits that have been performed during a given time period.

" + }, + "ListAuthorizers":{ + "name":"ListAuthorizers", + "http":{ + "method":"GET", + "requestUri":"/authorizers/" + }, + "input":{"shape":"ListAuthorizersRequest"}, + "output":{"shape":"ListAuthorizersResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the authorizers registered in your account.

" + }, + "ListBillingGroups":{ + "name":"ListBillingGroups", + "http":{ + "method":"GET", + "requestUri":"/billing-groups" + }, + "input":{"shape":"ListBillingGroupsRequest"}, + "output":{"shape":"ListBillingGroupsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Lists the billing groups you have created.

" + }, + "ListCACertificates":{ + "name":"ListCACertificates", + "http":{ + "method":"GET", + "requestUri":"/cacertificates" + }, + "input":{"shape":"ListCACertificatesRequest"}, + "output":{"shape":"ListCACertificatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the CA certificates registered for your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

" + }, + "ListCertificates":{ + "name":"ListCertificates", + "http":{ + "method":"GET", + "requestUri":"/certificates" + }, + "input":{"shape":"ListCertificatesRequest"}, + "output":{"shape":"ListCertificatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the certificates registered in your AWS account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

" + }, + "ListCertificatesByCA":{ + "name":"ListCertificatesByCA", + "http":{ + "method":"GET", + "requestUri":"/certificates-by-ca/{caCertificateId}" + }, + "input":{"shape":"ListCertificatesByCARequest"}, + "output":{"shape":"ListCertificatesByCAResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

List the device certificates signed by the specified CA certificate.

" + }, + "ListIndices":{ + "name":"ListIndices", + "http":{ + "method":"GET", + "requestUri":"/indices" + }, + "input":{"shape":"ListIndicesRequest"}, + "output":{"shape":"ListIndicesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the search indices.

" + }, + "ListJobExecutionsForJob":{ + "name":"ListJobExecutionsForJob", + "http":{ + "method":"GET", + "requestUri":"/jobs/{jobId}/things" + }, + "input":{"shape":"ListJobExecutionsForJobRequest"}, + "output":{"shape":"ListJobExecutionsForJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the job executions for a job.

" + }, + "ListJobExecutionsForThing":{ + "name":"ListJobExecutionsForThing", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/jobs" + }, + "input":{"shape":"ListJobExecutionsForThingRequest"}, + "output":{"shape":"ListJobExecutionsForThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the job executions for the specified thing.

" + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/jobs" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists jobs.

" + }, + "ListMitigationActions":{ + "name":"ListMitigationActions", + "http":{ + "method":"GET", + "requestUri":"/mitigationactions/actions" + }, + "input":{"shape":"ListMitigationActionsRequest"}, + "output":{"shape":"ListMitigationActionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets a list of all mitigation actions that match the specified filter criteria.

" + }, + "ListOTAUpdates":{ + "name":"ListOTAUpdates", + "http":{ + "method":"GET", + "requestUri":"/otaUpdates" + }, + "input":{"shape":"ListOTAUpdatesRequest"}, + "output":{"shape":"ListOTAUpdatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists OTA updates.

" + }, + "ListOutgoingCertificates":{ + "name":"ListOutgoingCertificates", + "http":{ + "method":"GET", + "requestUri":"/certificates-out-going" + }, + "input":{"shape":"ListOutgoingCertificatesRequest"}, + "output":{"shape":"ListOutgoingCertificatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists certificates that are being transferred but not yet accepted.

" + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"GET", + "requestUri":"/policies" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{"shape":"ListPoliciesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists your policies.

" + }, + "ListPolicyPrincipals":{ + "name":"ListPolicyPrincipals", + "http":{ + "method":"GET", + "requestUri":"/policy-principals" + }, + "input":{"shape":"ListPolicyPrincipalsRequest"}, + "output":{"shape":"ListPolicyPrincipalsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the principals associated with the specified policy.

Note: This API is deprecated. Please use ListTargetsForPolicy instead.

", + "deprecated":true + }, + "ListPolicyVersions":{ + "name":"ListPolicyVersions", + "http":{ + "method":"GET", + "requestUri":"/policies/{policyName}/version" + }, + "input":{"shape":"ListPolicyVersionsRequest"}, + "output":{"shape":"ListPolicyVersionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the versions of the specified policy and identifies the default version.

" + }, + "ListPrincipalPolicies":{ + "name":"ListPrincipalPolicies", + "http":{ + "method":"GET", + "requestUri":"/principal-policies" + }, + "input":{"shape":"ListPrincipalPoliciesRequest"}, + "output":{"shape":"ListPrincipalPoliciesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the policies attached to the specified principal. If you use an Cognito identity, the ID must be in AmazonCognito Identity format.

Note: This API is deprecated. Please use ListAttachedPolicies instead.

", + "deprecated":true + }, + "ListPrincipalThings":{ + "name":"ListPrincipalThings", + "http":{ + "method":"GET", + "requestUri":"/principals/things" + }, + "input":{"shape":"ListPrincipalThingsRequest"}, + "output":{"shape":"ListPrincipalThingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the things associated with the specified principal. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

" + }, + "ListRoleAliases":{ + "name":"ListRoleAliases", + "http":{ + "method":"GET", + "requestUri":"/role-aliases" + }, + "input":{"shape":"ListRoleAliasesRequest"}, + "output":{"shape":"ListRoleAliasesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the role aliases registered in your account.

" + }, + "ListScheduledAudits":{ + "name":"ListScheduledAudits", + "http":{ + "method":"GET", + "requestUri":"/audit/scheduledaudits" + }, + "input":{"shape":"ListScheduledAuditsRequest"}, + "output":{"shape":"ListScheduledAuditsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all of your scheduled audits.

" + }, + "ListSecurityProfiles":{ + "name":"ListSecurityProfiles", + "http":{ + "method":"GET", + "requestUri":"/security-profiles" + }, + "input":{"shape":"ListSecurityProfilesRequest"}, + "output":{"shape":"ListSecurityProfilesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the Device Defender security profiles you have created. You can use filters to list only those security profiles associated with a thing group or only those associated with your account.

" + }, + "ListSecurityProfilesForTarget":{ + "name":"ListSecurityProfilesForTarget", + "http":{ + "method":"GET", + "requestUri":"/security-profiles-for-target" + }, + "input":{"shape":"ListSecurityProfilesForTargetRequest"}, + "output":{"shape":"ListSecurityProfilesForTargetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the Device Defender security profiles attached to a target (thing group).

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"GET", + "requestUri":"/streams" + }, + "input":{"shape":"ListStreamsRequest"}, + "output":{"shape":"ListStreamsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all of the streams in your AWS account.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Lists the tags (metadata) you have assigned to the resource.

" + }, + "ListTargetsForPolicy":{ + "name":"ListTargetsForPolicy", + "http":{ + "method":"POST", + "requestUri":"/policy-targets/{policyName}" + }, + "input":{"shape":"ListTargetsForPolicyRequest"}, + "output":{"shape":"ListTargetsForPolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

List targets for the specified policy.

" + }, + "ListTargetsForSecurityProfile":{ + "name":"ListTargetsForSecurityProfile", + "http":{ + "method":"GET", + "requestUri":"/security-profiles/{securityProfileName}/targets" + }, + "input":{"shape":"ListTargetsForSecurityProfileRequest"}, + "output":{"shape":"ListTargetsForSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the targets (thing groups) associated with a given Device Defender security profile.

" + }, + "ListThingGroups":{ + "name":"ListThingGroups", + "http":{ + "method":"GET", + "requestUri":"/thing-groups" + }, + "input":{"shape":"ListThingGroupsRequest"}, + "output":{"shape":"ListThingGroupsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List the thing groups in your account.

" + }, + "ListThingGroupsForThing":{ + "name":"ListThingGroupsForThing", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/thing-groups" + }, + "input":{"shape":"ListThingGroupsForThingRequest"}, + "output":{"shape":"ListThingGroupsForThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List the thing groups to which the specified thing belongs.

" + }, + "ListThingPrincipals":{ + "name":"ListThingPrincipals", + "http":{ + "method":"GET", + "requestUri":"/things/{thingName}/principals" + }, + "input":{"shape":"ListThingPrincipalsRequest"}, + "output":{"shape":"ListThingPrincipalsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the principals associated with the specified thing. A principal can be X.509 certificates, IAM users, groups, and roles, Amazon Cognito identities or federated identities.

" + }, + "ListThingRegistrationTaskReports":{ + "name":"ListThingRegistrationTaskReports", + "http":{ + "method":"GET", + "requestUri":"/thing-registration-tasks/{taskId}/reports" + }, + "input":{"shape":"ListThingRegistrationTaskReportsRequest"}, + "output":{"shape":"ListThingRegistrationTaskReportsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Information about the thing registration tasks.

" + }, + "ListThingRegistrationTasks":{ + "name":"ListThingRegistrationTasks", + "http":{ + "method":"GET", + "requestUri":"/thing-registration-tasks" + }, + "input":{"shape":"ListThingRegistrationTasksRequest"}, + "output":{"shape":"ListThingRegistrationTasksResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

List bulk thing provisioning tasks.

" + }, + "ListThingTypes":{ + "name":"ListThingTypes", + "http":{ + "method":"GET", + "requestUri":"/thing-types" + }, + "input":{"shape":"ListThingTypesRequest"}, + "output":{"shape":"ListThingTypesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the existing thing types.

" + }, + "ListThings":{ + "name":"ListThings", + "http":{ + "method":"GET", + "requestUri":"/things" + }, + "input":{"shape":"ListThingsRequest"}, + "output":{"shape":"ListThingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists your things. Use the attributeName and attributeValue parameters to filter your things. For example, calling ListThings with attributeName=Color and attributeValue=Red retrieves all things in the registry that contain an attribute Color with the value Red.

" + }, + "ListThingsInBillingGroup":{ + "name":"ListThingsInBillingGroup", + "http":{ + "method":"GET", + "requestUri":"/billing-groups/{billingGroupName}/things" + }, + "input":{"shape":"ListThingsInBillingGroupRequest"}, + "output":{"shape":"ListThingsInBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Lists the things you have added to the given billing group.

" + }, + "ListThingsInThingGroup":{ + "name":"ListThingsInThingGroup", + "http":{ + "method":"GET", + "requestUri":"/thing-groups/{thingGroupName}/things" + }, + "input":{"shape":"ListThingsInThingGroupRequest"}, + "output":{"shape":"ListThingsInThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the things in the specified group.

" + }, + "ListTopicRules":{ + "name":"ListTopicRules", + "http":{ + "method":"GET", + "requestUri":"/rules" + }, + "input":{"shape":"ListTopicRulesRequest"}, + "output":{"shape":"ListTopicRulesResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the rules for the specific topic.

" + }, + "ListV2LoggingLevels":{ + "name":"ListV2LoggingLevels", + "http":{ + "method":"GET", + "requestUri":"/v2LoggingLevel" + }, + "input":{"shape":"ListV2LoggingLevelsRequest"}, + "output":{"shape":"ListV2LoggingLevelsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"NotConfiguredException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists logging levels.

" + }, + "ListViolationEvents":{ + "name":"ListViolationEvents", + "http":{ + "method":"GET", + "requestUri":"/violation-events" + }, + "input":{"shape":"ListViolationEventsRequest"}, + "output":{"shape":"ListViolationEventsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

" + }, + "RegisterCACertificate":{ + "name":"RegisterCACertificate", + "http":{ + "method":"POST", + "requestUri":"/cacertificate" + }, + "input":{"shape":"RegisterCACertificateRequest"}, + "output":{"shape":"RegisterCACertificateResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"RegistrationCodeValidationException"}, + {"shape":"InvalidRequestException"}, + {"shape":"CertificateValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Registers a CA certificate with AWS IoT. This CA certificate can then be used to sign device certificates, which can be then registered with AWS IoT. You can register up to 10 CA certificates per AWS account that have the same subject field. This enables you to have up to 10 certificate authorities sign your device certificates. If you have more than one CA certificate registered, make sure you pass the CA certificate when you register your device certificates with the RegisterCertificate API.

" + }, + "RegisterCertificate":{ + "name":"RegisterCertificate", + "http":{ + "method":"POST", + "requestUri":"/certificate/register" + }, + "input":{"shape":"RegisterCertificateRequest"}, + "output":{"shape":"RegisterCertificateResponse"}, + "errors":[ + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"CertificateValidationException"}, + {"shape":"CertificateStateException"}, + {"shape":"CertificateConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Registers a device certificate with AWS IoT. If you have more than one CA certificate that has the same subject field, you must specify the CA certificate that was used to sign the device certificate being registered.

" + }, + "RegisterThing":{ + "name":"RegisterThing", + "http":{ + "method":"POST", + "requestUri":"/things" + }, + "input":{"shape":"RegisterThingRequest"}, + "output":{"shape":"RegisterThingResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ThrottlingException"}, + {"shape":"ConflictingResourceUpdateException"}, + {"shape":"ResourceRegistrationFailureException"} + ], + "documentation":"

Provisions a thing.

" + }, + "RejectCertificateTransfer":{ + "name":"RejectCertificateTransfer", + "http":{ + "method":"PATCH", + "requestUri":"/reject-certificate-transfer/{certificateId}" + }, + "input":{"shape":"RejectCertificateTransferRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TransferAlreadyCompletedException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Rejects a pending certificate transfer. After AWS IoT rejects a certificate transfer, the certificate status changes from PENDING_TRANSFER to INACTIVE.

To check for pending certificate transfers, call ListCertificates to enumerate your certificates.

This operation can only be called by the transfer destination. After it is called, the certificate will be returned to the source's account in the INACTIVE state.

" + }, + "RemoveThingFromBillingGroup":{ + "name":"RemoveThingFromBillingGroup", + "http":{ + "method":"PUT", + "requestUri":"/billing-groups/removeThingFromBillingGroup" + }, + "input":{"shape":"RemoveThingFromBillingGroupRequest"}, + "output":{"shape":"RemoveThingFromBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes the given thing from the billing group.

" + }, + "RemoveThingFromThingGroup":{ + "name":"RemoveThingFromThingGroup", + "http":{ + "method":"PUT", + "requestUri":"/thing-groups/removeThingFromThingGroup" + }, + "input":{"shape":"RemoveThingFromThingGroupRequest"}, + "output":{"shape":"RemoveThingFromThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Remove the specified thing from the specified group.

" + }, + "ReplaceTopicRule":{ + "name":"ReplaceTopicRule", + "http":{ + "method":"PATCH", + "requestUri":"/rules/{ruleName}" + }, + "input":{"shape":"ReplaceTopicRuleRequest"}, + "errors":[ + {"shape":"SqlParseException"}, + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ConflictingResourceUpdateException"} + ], + "documentation":"

Replaces the rule. You must specify all parameters for the new rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule.

" + }, + "SearchIndex":{ + "name":"SearchIndex", + "http":{ + "method":"POST", + "requestUri":"/indices/search" + }, + "input":{"shape":"SearchIndexRequest"}, + "output":{"shape":"SearchIndexResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidQueryException"}, + {"shape":"IndexNotReadyException"} + ], + "documentation":"

The query search index.

" + }, + "SetDefaultAuthorizer":{ + "name":"SetDefaultAuthorizer", + "http":{ + "method":"POST", + "requestUri":"/default-authorizer" + }, + "input":{"shape":"SetDefaultAuthorizerRequest"}, + "output":{"shape":"SetDefaultAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

Sets the default authorizer. This will be used if a websocket connection is made without specifying an authorizer.

" + }, + "SetDefaultPolicyVersion":{ + "name":"SetDefaultPolicyVersion", + "http":{ + "method":"PATCH", + "requestUri":"/policies/{policyName}/version/{policyVersionId}" + }, + "input":{"shape":"SetDefaultPolicyVersionRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Sets the specified version of the specified policy as the policy's default (operative) version. This action affects all certificates to which the policy is attached. To list the principals the policy is attached to, use the ListPrincipalPolicy API.

" + }, + "SetLoggingOptions":{ + "name":"SetLoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/loggingOptions" + }, + "input":{"shape":"SetLoggingOptionsRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets the logging options.

NOTE: use of this command is not recommended. Use SetV2LoggingOptions instead.

" + }, + "SetV2LoggingLevel":{ + "name":"SetV2LoggingLevel", + "http":{ + "method":"POST", + "requestUri":"/v2LoggingLevel" + }, + "input":{"shape":"SetV2LoggingLevelRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"NotConfiguredException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets the logging level.

" + }, + "SetV2LoggingOptions":{ + "name":"SetV2LoggingOptions", + "http":{ + "method":"POST", + "requestUri":"/v2LoggingOptions" + }, + "input":{"shape":"SetV2LoggingOptionsRequest"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets the logging options for the V2 logging service.

" + }, + "StartAuditMitigationActionsTask":{ + "name":"StartAuditMitigationActionsTask", + "http":{ + "method":"POST", + "requestUri":"/audit/mitigationactions/tasks/{taskId}" + }, + "input":{"shape":"StartAuditMitigationActionsTaskRequest"}, + "output":{"shape":"StartAuditMitigationActionsTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TaskAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Starts a task that applies a set of mitigation actions to the specified target.

" + }, + "StartOnDemandAuditTask":{ + "name":"StartOnDemandAuditTask", + "http":{ + "method":"POST", + "requestUri":"/audit/tasks" + }, + "input":{"shape":"StartOnDemandAuditTaskRequest"}, + "output":{"shape":"StartOnDemandAuditTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Starts an on-demand Device Defender audit.

" + }, + "StartThingRegistrationTask":{ + "name":"StartThingRegistrationTask", + "http":{ + "method":"POST", + "requestUri":"/thing-registration-tasks" + }, + "input":{"shape":"StartThingRegistrationTaskRequest"}, + "output":{"shape":"StartThingRegistrationTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a bulk thing provisioning task.

" + }, + "StopThingRegistrationTask":{ + "name":"StopThingRegistrationTask", + "http":{ + "method":"PUT", + "requestUri":"/thing-registration-tasks/{taskId}/cancel" + }, + "input":{"shape":"StopThingRegistrationTaskRequest"}, + "output":{"shape":"StopThingRegistrationTaskResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Cancels a bulk thing provisioning task.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

" + }, + "TestAuthorization":{ + "name":"TestAuthorization", + "http":{ + "method":"POST", + "requestUri":"/test-authorization" + }, + "input":{"shape":"TestAuthorizationRequest"}, + "output":{"shape":"TestAuthorizationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Tests if a specified principal is authorized to perform an AWS IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the AWS IoT device gateway.

" + }, + "TestInvokeAuthorizer":{ + "name":"TestInvokeAuthorizer", + "http":{ + "method":"POST", + "requestUri":"/authorizer/{authorizerName}/test" + }, + "input":{"shape":"TestInvokeAuthorizerRequest"}, + "output":{"shape":"TestInvokeAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"InvalidResponseException"} + ], + "documentation":"

Tests a custom authorization behavior by invoking a specified custom authorizer. Use this to test and debug the custom authorization behavior of devices that connect to the AWS IoT device gateway.

" + }, + "TransferCertificate":{ + "name":"TransferCertificate", + "http":{ + "method":"PATCH", + "requestUri":"/transfer-certificate/{certificateId}" + }, + "input":{"shape":"TransferCertificateRequest"}, + "output":{"shape":"TransferCertificateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"CertificateStateException"}, + {"shape":"TransferConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Transfers the specified certificate to the specified AWS account.

You can cancel the transfer until it is acknowledged by the recipient.

No notification is sent to the transfer destination's account. It is up to the caller to notify the transfer target.

The certificate being transferred must not be in the ACTIVE state. You can use the UpdateCertificate API to deactivate it.

The certificate must not have any policies attached to it. You can use the DetachPrincipalPolicy API to detach them.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/untag" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Removes the given tags (metadata) from the resource.

" + }, + "UpdateAccountAuditConfiguration":{ + "name":"UpdateAccountAuditConfiguration", + "http":{ + "method":"PATCH", + "requestUri":"/audit/configuration" + }, + "input":{"shape":"UpdateAccountAuditConfigurationRequest"}, + "output":{"shape":"UpdateAccountAuditConfigurationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Configures or reconfigures the Device Defender audit settings for this account. Settings include how audit notifications are sent and which audit checks are enabled or disabled.

" + }, + "UpdateAuthorizer":{ + "name":"UpdateAuthorizer", + "http":{ + "method":"PUT", + "requestUri":"/authorizer/{authorizerName}" + }, + "input":{"shape":"UpdateAuthorizerRequest"}, + "output":{"shape":"UpdateAuthorizerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates an authorizer.

" + }, + "UpdateBillingGroup":{ + "name":"UpdateBillingGroup", + "http":{ + "method":"PATCH", + "requestUri":"/billing-groups/{billingGroupName}" + }, + "input":{"shape":"UpdateBillingGroupRequest"}, + "output":{"shape":"UpdateBillingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates information about the billing group.

" + }, + "UpdateCACertificate":{ + "name":"UpdateCACertificate", + "http":{ + "method":"PUT", + "requestUri":"/cacertificate/{caCertificateId}" + }, + "input":{"shape":"UpdateCACertificateRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a registered CA certificate.

" + }, + "UpdateCertificate":{ + "name":"UpdateCertificate", + "http":{ + "method":"PUT", + "requestUri":"/certificates/{certificateId}" + }, + "input":{"shape":"UpdateCertificateRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"CertificateStateException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the status of the specified certificate. This operation is idempotent.

Moving a certificate from the ACTIVE state (including REVOKED) will not disconnect currently connected devices, but these devices will be unable to reconnect.

The ACTIVE state is required to authenticate devices connecting to AWS IoT using a certificate.

" + }, + "UpdateDynamicThingGroup":{ + "name":"UpdateDynamicThingGroup", + "http":{ + "method":"PATCH", + "requestUri":"/dynamic-thing-groups/{thingGroupName}" + }, + "input":{"shape":"UpdateDynamicThingGroupRequest"}, + "output":{"shape":"UpdateDynamicThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidQueryException"} + ], + "documentation":"

Updates a dynamic thing group.

" + }, + "UpdateEventConfigurations":{ + "name":"UpdateEventConfigurations", + "http":{ + "method":"PATCH", + "requestUri":"/event-configurations" + }, + "input":{"shape":"UpdateEventConfigurationsRequest"}, + "output":{"shape":"UpdateEventConfigurationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Updates the event configurations.

" + }, + "UpdateIndexingConfiguration":{ + "name":"UpdateIndexingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/indexing/config" + }, + "input":{"shape":"UpdateIndexingConfigurationRequest"}, + "output":{"shape":"UpdateIndexingConfigurationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the search configuration.

" + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"PATCH", + "requestUri":"/jobs/{jobId}" + }, + "input":{"shape":"UpdateJobRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Updates supported fields of the specified job.

" + }, + "UpdateMitigationAction":{ + "name":"UpdateMitigationAction", + "http":{ + "method":"PATCH", + "requestUri":"/mitigationactions/actions/{actionName}" + }, + "input":{"shape":"UpdateMitigationActionRequest"}, + "output":{"shape":"UpdateMitigationActionResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the definition for the specified mitigation action.

" + }, + "UpdateRoleAlias":{ + "name":"UpdateRoleAlias", + "http":{ + "method":"PUT", + "requestUri":"/role-aliases/{roleAlias}" + }, + "input":{"shape":"UpdateRoleAliasRequest"}, + "output":{"shape":"UpdateRoleAliasResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a role alias.

" + }, + "UpdateScheduledAudit":{ + "name":"UpdateScheduledAudit", + "http":{ + "method":"PATCH", + "requestUri":"/audit/scheduledaudits/{scheduledAuditName}" + }, + "input":{"shape":"UpdateScheduledAuditRequest"}, + "output":{"shape":"UpdateScheduledAuditResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

" + }, + "UpdateSecurityProfile":{ + "name":"UpdateSecurityProfile", + "http":{ + "method":"PATCH", + "requestUri":"/security-profiles/{securityProfileName}" + }, + "input":{"shape":"UpdateSecurityProfileRequest"}, + "output":{"shape":"UpdateSecurityProfileResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a Device Defender security profile.

" + }, + "UpdateStream":{ + "name":"UpdateStream", + "http":{ + "method":"PUT", + "requestUri":"/streams/{streamId}" + }, + "input":{"shape":"UpdateStreamRequest"}, + "output":{"shape":"UpdateStreamResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates an existing stream. The stream version will be incremented by one.

" + }, + "UpdateThing":{ + "name":"UpdateThing", + "http":{ + "method":"PATCH", + "requestUri":"/things/{thingName}" + }, + "input":{"shape":"UpdateThingRequest"}, + "output":{"shape":"UpdateThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnauthorizedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the data for a thing.

" + }, + "UpdateThingGroup":{ + "name":"UpdateThingGroup", + "http":{ + "method":"PATCH", + "requestUri":"/thing-groups/{thingGroupName}" + }, + "input":{"shape":"UpdateThingGroupRequest"}, + "output":{"shape":"UpdateThingGroupResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"VersionConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Update a thing group.

" + }, + "UpdateThingGroupsForThing":{ + "name":"UpdateThingGroupsForThing", + "http":{ + "method":"PUT", + "requestUri":"/thing-groups/updateThingGroupsForThing" + }, + "input":{"shape":"UpdateThingGroupsForThingRequest"}, + "output":{"shape":"UpdateThingGroupsForThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the groups to which the thing belongs.

" + }, + "ValidateSecurityProfileBehaviors":{ + "name":"ValidateSecurityProfileBehaviors", + "http":{ + "method":"POST", + "requestUri":"/security-profile-behaviors/validate" + }, + "input":{"shape":"ValidateSecurityProfileBehaviorsRequest"}, + "output":{"shape":"ValidateSecurityProfileBehaviorsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Validates a Device Defender security profile behaviors specification.

" + } + }, + "shapes":{ + "AbortAction":{ + "type":"string", + "enum":["CANCEL"] + }, + "AbortConfig":{ + "type":"structure", + "required":["criteriaList"], + "members":{ + "criteriaList":{ + "shape":"AbortCriteriaList", + "documentation":"

The list of abort criteria to define rules to abort the job.

" + } + }, + "documentation":"

Details of abort criteria to abort the job.

" + }, + "AbortCriteria":{ + "type":"structure", + "required":[ + "failureType", + "action", + "thresholdPercentage", + "minNumberOfExecutedThings" + ], + "members":{ + "failureType":{ + "shape":"JobExecutionFailureType", + "documentation":"

The type of job execution failure to define a rule to initiate a job abort.

" + }, + "action":{ + "shape":"AbortAction", + "documentation":"

The type of abort action to initiate a job abort.

" + }, + "thresholdPercentage":{ + "shape":"AbortThresholdPercentage", + "documentation":"

The threshold as a percentage of the total number of executed things that will initiate a job abort.

AWS IoT supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).

" + }, + "minNumberOfExecutedThings":{ + "shape":"MinimumNumberOfExecutedThings", + "documentation":"

Minimum number of executed things before evaluating an abort rule.

" + } + }, + "documentation":"

Details of abort criteria to define rules to abort the job.

" + }, + "AbortCriteriaList":{ + "type":"list", + "member":{"shape":"AbortCriteria"}, + "min":1 + }, + "AbortThresholdPercentage":{ + "type":"double", + "max":100 + }, + "AcceptCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + }, + "setAsActive":{ + "shape":"SetAsActive", + "documentation":"

Specifies whether the certificate is active.

", + "location":"querystring", + "locationName":"setAsActive" + } + }, + "documentation":"

The input for the AcceptCertificateTransfer operation.

" + }, + "Action":{ + "type":"structure", + "members":{ + "dynamoDB":{ + "shape":"DynamoDBAction", + "documentation":"

Write to a DynamoDB table.

" + }, + "dynamoDBv2":{ + "shape":"DynamoDBv2Action", + "documentation":"

Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

" + }, + "lambda":{ + "shape":"LambdaAction", + "documentation":"

Invoke a Lambda function.

" + }, + "sns":{ + "shape":"SnsAction", + "documentation":"

Publish to an Amazon SNS topic.

" + }, + "sqs":{ + "shape":"SqsAction", + "documentation":"

Publish to an Amazon SQS queue.

" + }, + "kinesis":{ + "shape":"KinesisAction", + "documentation":"

Write data to an Amazon Kinesis stream.

" + }, + "republish":{ + "shape":"RepublishAction", + "documentation":"

Publish to another MQTT topic.

" + }, + "s3":{ + "shape":"S3Action", + "documentation":"

Write to an Amazon S3 bucket.

" + }, + "firehose":{ + "shape":"FirehoseAction", + "documentation":"

Write to an Amazon Kinesis Firehose stream.

" + }, + "cloudwatchMetric":{ + "shape":"CloudwatchMetricAction", + "documentation":"

Capture a CloudWatch metric.

" + }, + "cloudwatchAlarm":{ + "shape":"CloudwatchAlarmAction", + "documentation":"

Change the state of a CloudWatch alarm.

" + }, + "elasticsearch":{ + "shape":"ElasticsearchAction", + "documentation":"

Write data to an Amazon Elasticsearch Service domain.

" + }, + "salesforce":{ + "shape":"SalesforceAction", + "documentation":"

Send a message to a Salesforce IoT Cloud Input Stream.

" + }, + "iotAnalytics":{ + "shape":"IotAnalyticsAction", + "documentation":"

Sends message data to an AWS IoT Analytics channel.

" + }, + "iotEvents":{ + "shape":"IotEventsAction", + "documentation":"

Sends an input to an AWS IoT Events detector.

" + }, + "stepFunctions":{ + "shape":"StepFunctionsAction", + "documentation":"

Starts execution of a Step Functions state machine.

" + } + }, + "documentation":"

Describes the actions associated with a rule.

" + }, + "ActionList":{ + "type":"list", + "member":{"shape":"Action"}, + "max":10, + "min":0 + }, + "ActionType":{ + "type":"string", + "enum":[ + "PUBLISH", + "SUBSCRIBE", + "RECEIVE", + "CONNECT" + ] + }, + "ActiveViolation":{ + "type":"structure", + "members":{ + "violationId":{ + "shape":"ViolationId", + "documentation":"

The ID of the active violation.

" + }, + "thingName":{ + "shape":"DeviceDefenderThingName", + "documentation":"

The name of the thing responsible for the active violation.

" + }, + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The security profile whose behavior is in violation.

" + }, + "behavior":{ + "shape":"Behavior", + "documentation":"

The behavior which is being violated.

" + }, + "lastViolationValue":{ + "shape":"MetricValue", + "documentation":"

The value of the metric (the measurement) which caused the most recent violation.

" + }, + "lastViolationTime":{ + "shape":"Timestamp", + "documentation":"

The time the most recent violation occurred.

" + }, + "violationStartTime":{ + "shape":"Timestamp", + "documentation":"

The time the violation started.

" + } + }, + "documentation":"

Information about an active Device Defender security profile behavior violation.

" + }, + "ActiveViolations":{ + "type":"list", + "member":{"shape":"ActiveViolation"} + }, + "AddThingToBillingGroupRequest":{ + "type":"structure", + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

" + }, + "billingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"

The ARN of the billing group.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to be added to the billing group.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing to be added to the billing group.

" + } + } + }, + "AddThingToBillingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "AddThingToThingGroupRequest":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the group to which you are adding a thing.

" + }, + "thingGroupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The ARN of the group to which you are adding a thing.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to add to a group.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing to add to a group.

" + }, + "overrideDynamicGroups":{ + "shape":"OverrideDynamicGroups", + "documentation":"

Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

" + } + } + }, + "AddThingToThingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "AddThingsToThingGroupParams":{ + "type":"structure", + "required":["thingGroupNames"], + "members":{ + "thingGroupNames":{ + "shape":"ThingGroupNames", + "documentation":"

The list of groups to which you want to add the things that triggered the mitigation action. You can add a thing to a maximum of 10 groups, but you cannot add a thing to more than one group in the same hierarchy.

" + }, + "overrideDynamicGroups":{ + "shape":"OverrideDynamicGroups", + "documentation":"

Specifies if this mitigation action can move the things that triggered the mitigation action even if they are part of one or more dynamic things groups.

" + } + }, + "documentation":"

Parameters used when defining a mitigation action that move a set of things to a thing group.

" + }, + "AdditionalMetricsToRetainList":{ + "type":"list", + "member":{"shape":"BehaviorMetric"} + }, + "AdditionalParameterMap":{ + "type":"map", + "key":{"shape":"AttributeKey"}, + "value":{"shape":"Value"} + }, + "AggregationField":{ + "type":"string", + "min":1 + }, + "AlarmName":{"type":"string"}, + "AlertTarget":{ + "type":"structure", + "required":[ + "alertTargetArn", + "roleArn" + ], + "members":{ + "alertTargetArn":{ + "shape":"AlertTargetArn", + "documentation":"

The ARN of the notification target to which alerts are sent.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that grants permission to send alerts to the notification target.

" + } + }, + "documentation":"

A structure containing the alert target ARN and the role ARN.

" + }, + "AlertTargetArn":{"type":"string"}, + "AlertTargetType":{ + "type":"string", + "documentation":"

The type of alert target: one of \"SNS\".

", + "enum":["SNS"] + }, + "AlertTargets":{ + "type":"map", + "key":{"shape":"AlertTargetType"}, + "value":{"shape":"AlertTarget"} + }, + "AllowAutoRegistration":{"type":"boolean"}, + "Allowed":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

A list of policies that allowed the authentication.

" + } + }, + "documentation":"

Contains information that allowed the authorization.

" + }, + "ApproximateSecondsBeforeTimedOut":{"type":"long"}, + "AscendingOrder":{"type":"boolean"}, + "AssociateTargetsWithJobRequest":{ + "type":"structure", + "required":[ + "targets", + "jobId" + ], + "members":{ + "targets":{ + "shape":"JobTargets", + "documentation":"

A list of thing group ARNs that define the targets of the job.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "comment":{ + "shape":"Comment", + "documentation":"

An optional comment string describing why the job was associated with the targets.

" + } + } + }, + "AssociateTargetsWithJobResponse":{ + "type":"structure", + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

An ARN identifying the job.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

A short text description of the job.

" + } + } + }, + "AttachPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "target" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy to attach.

", + "location":"uri", + "locationName":"policyName" + }, + "target":{ + "shape":"PolicyTarget", + "documentation":"

The identity to which the policy is attached.

" + } + } + }, + "AttachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "documentation":"

The principal, which can be a certificate ARN (as returned from the CreateCertificate operation) or an Amazon Cognito ID.

", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + }, + "documentation":"

The input for the AttachPrincipalPolicy operation.

" + }, + "AttachSecurityProfileRequest":{ + "type":"structure", + "required":[ + "securityProfileName", + "securityProfileTargetArn" + ], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The security profile that is attached.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "securityProfileTargetArn":{ + "shape":"SecurityProfileTargetArn", + "documentation":"

The ARN of the target (thing group) to which the security profile is attached.

", + "location":"querystring", + "locationName":"securityProfileTargetArn" + } + } + }, + "AttachSecurityProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "AttachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "documentation":"

The principal, such as a certificate or other credential.

", + "location":"header", + "locationName":"x-amzn-principal" + } + }, + "documentation":"

The input for the AttachThingPrincipal operation.

" + }, + "AttachThingPrincipalResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output from the AttachThingPrincipal operation.

" + }, + "AttributeKey":{"type":"string"}, + "AttributeName":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9_.,@/:#-]+" + }, + "AttributePayload":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"Attributes", + "documentation":"

A JSON string containing up to three key-value pair in JSON format. For example:

{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}

" + }, + "merge":{ + "shape":"Flag", + "documentation":"

Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.

To remove an attribute, call UpdateThing with an empty attribute value.

The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.

" + } + }, + "documentation":"

The attribute payload.

" + }, + "AttributeValue":{ + "type":"string", + "max":800, + "pattern":"[a-zA-Z0-9_.,@/:#-]*" + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "AttributesMap":{ + "type":"map", + "key":{"shape":"AttributeKey"}, + "value":{"shape":"Value"} + }, + "AuditCheckConfiguration":{ + "type":"structure", + "members":{ + "enabled":{ + "shape":"Enabled", + "documentation":"

True if this audit check is enabled for this account.

" + } + }, + "documentation":"

Which audit checks are enabled and disabled for this account.

" + }, + "AuditCheckConfigurations":{ + "type":"map", + "key":{"shape":"AuditCheckName"}, + "value":{"shape":"AuditCheckConfiguration"} + }, + "AuditCheckDetails":{ + "type":"structure", + "members":{ + "checkRunStatus":{ + "shape":"AuditCheckRunStatus", + "documentation":"

The completion status of this check. One of \"IN_PROGRESS\", \"WAITING_FOR_DATA_COLLECTION\", \"CANCELED\", \"COMPLETED_COMPLIANT\", \"COMPLETED_NON_COMPLIANT\", or \"FAILED\".

" + }, + "checkCompliant":{ + "shape":"CheckCompliant", + "documentation":"

True if the check is complete and found all resources compliant.

" + }, + "totalResourcesCount":{ + "shape":"TotalResourcesCount", + "documentation":"

The number of resources on which the check was performed.

" + }, + "nonCompliantResourcesCount":{ + "shape":"NonCompliantResourcesCount", + "documentation":"

The number of resources that were found noncompliant during the check.

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The code of any error encountered when this check is performed during this audit. One of \"INSUFFICIENT_PERMISSIONS\" or \"AUDIT_CHECK_DISABLED\".

" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with any error encountered when this check is performed during this audit.

" + } + }, + "documentation":"

Information about the audit check.

" + }, + "AuditCheckName":{ + "type":"string", + "documentation":"

An audit check name. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

" + }, + "AuditCheckRunStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "WAITING_FOR_DATA_COLLECTION", + "CANCELED", + "COMPLETED_COMPLIANT", + "COMPLETED_NON_COMPLIANT", + "FAILED" + ] + }, + "AuditCheckToActionsMapping":{ + "type":"map", + "key":{"shape":"AuditCheckName"}, + "value":{"shape":"MitigationActionNameList"} + }, + "AuditCheckToReasonCodeFilter":{ + "type":"map", + "key":{"shape":"AuditCheckName"}, + "value":{"shape":"ReasonForNonComplianceCodes"} + }, + "AuditDetails":{ + "type":"map", + "key":{"shape":"AuditCheckName"}, + "value":{"shape":"AuditCheckDetails"} + }, + "AuditFinding":{ + "type":"structure", + "members":{ + "findingId":{ + "shape":"FindingId", + "documentation":"

A unique identifier for this set of audit findings. This identifier is used to apply mitigation tasks to one or more sets of findings.

" + }, + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

The ID of the audit that generated this result (finding).

" + }, + "checkName":{ + "shape":"AuditCheckName", + "documentation":"

The audit check that generated this result.

" + }, + "taskStartTime":{ + "shape":"Timestamp", + "documentation":"

The time the audit started.

" + }, + "findingTime":{ + "shape":"Timestamp", + "documentation":"

The time the result (finding) was discovered.

" + }, + "severity":{ + "shape":"AuditFindingSeverity", + "documentation":"

The severity of the result (finding).

" + }, + "nonCompliantResource":{ + "shape":"NonCompliantResource", + "documentation":"

The resource that was found to be noncompliant with the audit check.

" + }, + "relatedResources":{ + "shape":"RelatedResources", + "documentation":"

The list of related resources.

" + }, + "reasonForNonCompliance":{ + "shape":"ReasonForNonCompliance", + "documentation":"

The reason the resource was noncompliant.

" + }, + "reasonForNonComplianceCode":{ + "shape":"ReasonForNonComplianceCode", + "documentation":"

A code that indicates the reason that the resource was noncompliant.

" + } + }, + "documentation":"

The findings (results) of the audit.

" + }, + "AuditFindingSeverity":{ + "type":"string", + "enum":[ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ] + }, + "AuditFindings":{ + "type":"list", + "member":{"shape":"AuditFinding"} + }, + "AuditFrequency":{ + "type":"string", + "enum":[ + "DAILY", + "WEEKLY", + "BIWEEKLY", + "MONTHLY" + ] + }, + "AuditMitigationActionExecutionMetadata":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

The unique identifier for the task that applies the mitigation action.

" + }, + "findingId":{ + "shape":"FindingId", + "documentation":"

The unique identifier for the findings to which the task and associated mitigation action are applied.

" + }, + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The friendly name of the mitigation action being applied by the task.

" + }, + "actionId":{ + "shape":"MitigationActionId", + "documentation":"

The unique identifier for the mitigation action being applied by the task.

" + }, + "status":{ + "shape":"AuditMitigationActionsExecutionStatus", + "documentation":"

The current status of the task being executed.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the task was started.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the task was completed or canceled. Blank if the task is still running.

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

If an error occurred, the code that indicates which type of error occurred.

" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

If an error occurred, a message that describes the error.

" + } + }, + "documentation":"

Returned by ListAuditMitigationActionsTask, this object contains information that describes a mitigation action that has been started.

" + }, + "AuditMitigationActionExecutionMetadataList":{ + "type":"list", + "member":{"shape":"AuditMitigationActionExecutionMetadata"} + }, + "AuditMitigationActionsExecutionStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "CANCELED", + "SKIPPED", + "PENDING" + ] + }, + "AuditMitigationActionsTaskId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "AuditMitigationActionsTaskMetadata":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

The unique identifier for the task.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The time at which the audit mitigation actions task was started.

" + }, + "taskStatus":{ + "shape":"AuditMitigationActionsTaskStatus", + "documentation":"

The current state of the audit mitigation actions task.

" + } + }, + "documentation":"

Information about an audit mitigation actions task that is returned by ListAuditMitigationActionsTasks.

" + }, + "AuditMitigationActionsTaskMetadataList":{ + "type":"list", + "member":{"shape":"AuditMitigationActionsTaskMetadata"} + }, + "AuditMitigationActionsTaskStatistics":{ + "type":"map", + "key":{"shape":"AuditCheckName"}, + "value":{"shape":"TaskStatisticsForAuditCheck"} + }, + "AuditMitigationActionsTaskStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "CANCELED" + ] + }, + "AuditMitigationActionsTaskTarget":{ + "type":"structure", + "members":{ + "auditTaskId":{ + "shape":"AuditTaskId", + "documentation":"

If the task will apply a mitigation action to findings from a specific audit, this value uniquely identifies the audit.

" + }, + "findingIds":{ + "shape":"FindingIds", + "documentation":"

If the task will apply a mitigation action to one or more listed findings, this value uniquely identifies those findings.

" + }, + "auditCheckToReasonCodeFilter":{ + "shape":"AuditCheckToReasonCodeFilter", + "documentation":"

Specifies a filter in the form of an audit check and set of reason codes that identify the findings from the audit to which the audit mitigation actions task apply.

" + } + }, + "documentation":"

Used in MitigationActionParams, this information identifies the target findings to which the mitigation actions are applied. Only one entry appears.

" + }, + "AuditNotificationTarget":{ + "type":"structure", + "members":{ + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The ARN of the target (SNS topic) to which audit notifications are sent.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that grants permission to send notifications to the target.

" + }, + "enabled":{ + "shape":"Enabled", + "documentation":"

True if notifications to the target are enabled.

" + } + }, + "documentation":"

Information about the targets to which audit notifications are sent.

" + }, + "AuditNotificationTargetConfigurations":{ + "type":"map", + "key":{"shape":"AuditNotificationType"}, + "value":{"shape":"AuditNotificationTarget"} + }, + "AuditNotificationType":{ + "type":"string", + "enum":["SNS"] + }, + "AuditTaskId":{ + "type":"string", + "max":40, + "min":1, + "pattern":"[a-zA-Z0-9\\-]+" + }, + "AuditTaskMetadata":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

The ID of this audit.

" + }, + "taskStatus":{ + "shape":"AuditTaskStatus", + "documentation":"

The status of this audit. One of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

" + }, + "taskType":{ + "shape":"AuditTaskType", + "documentation":"

The type of this audit. One of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" + } + }, + "documentation":"

The audits that were performed.

" + }, + "AuditTaskMetadataList":{ + "type":"list", + "member":{"shape":"AuditTaskMetadata"} + }, + "AuditTaskStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "FAILED", + "CANCELED" + ] + }, + "AuditTaskType":{ + "type":"string", + "enum":[ + "ON_DEMAND_AUDIT_TASK", + "SCHEDULED_AUDIT_TASK" + ] + }, + "AuthDecision":{ + "type":"string", + "enum":[ + "ALLOWED", + "EXPLICIT_DENY", + "IMPLICIT_DENY" + ] + }, + "AuthInfo":{ + "type":"structure", + "members":{ + "actionType":{ + "shape":"ActionType", + "documentation":"

The type of action for which the principal is being authorized.

" + }, + "resources":{ + "shape":"Resources", + "documentation":"

The resources for which the principal is being authorized to perform the specified action.

" + } + }, + "documentation":"

A collection of authorization information.

" + }, + "AuthInfos":{ + "type":"list", + "member":{"shape":"AuthInfo"}, + "max":10, + "min":1 + }, + "AuthResult":{ + "type":"structure", + "members":{ + "authInfo":{ + "shape":"AuthInfo", + "documentation":"

Authorization information.

" + }, + "allowed":{ + "shape":"Allowed", + "documentation":"

The policies and statements that allowed the specified action.

" + }, + "denied":{ + "shape":"Denied", + "documentation":"

The policies and statements that denied the specified action.

" + }, + "authDecision":{ + "shape":"AuthDecision", + "documentation":"

The final authorization decision of this scenario. Multiple statements are taken into account when determining the authorization decision. An explicit deny statement can override multiple allow statements.

" + }, + "missingContextValues":{ + "shape":"MissingContextValues", + "documentation":"

Contains any missing context values found while evaluating policy.

" + } + }, + "documentation":"

The authorizer result.

" + }, + "AuthResults":{ + "type":"list", + "member":{"shape":"AuthResult"} + }, + "AuthorizerArn":{"type":"string"}, + "AuthorizerDescription":{ + "type":"structure", + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

" + }, + "authorizerArn":{ + "shape":"AuthorizerArn", + "documentation":"

The authorizer ARN.

" + }, + "authorizerFunctionArn":{ + "shape":"AuthorizerFunctionArn", + "documentation":"

The authorizer's Lambda function ARN.

" + }, + "tokenKeyName":{ + "shape":"TokenKeyName", + "documentation":"

The key used to extract the token from the HTTP headers.

" + }, + "tokenSigningPublicKeys":{ + "shape":"PublicKeyMap", + "documentation":"

The public keys used to validate the token signature returned by your custom authentication service.

" + }, + "status":{ + "shape":"AuthorizerStatus", + "documentation":"

The status of the authorizer.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The UNIX timestamp of when the authorizer was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The UNIX timestamp of when the authorizer was last updated.

" + } + }, + "documentation":"

The authorizer description.

" + }, + "AuthorizerFunctionArn":{"type":"string"}, + "AuthorizerName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w=,@-]+" + }, + "AuthorizerStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "AuthorizerSummary":{ + "type":"structure", + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

" + }, + "authorizerArn":{ + "shape":"AuthorizerArn", + "documentation":"

The authorizer ARN.

" + } + }, + "documentation":"

The authorizer summary.

" + }, + "Authorizers":{ + "type":"list", + "member":{"shape":"AuthorizerSummary"} + }, + "AutoRegistrationStatus":{ + "type":"string", + "enum":[ + "ENABLE", + "DISABLE" + ] + }, + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"[0-9]+" + }, + "AwsArn":{"type":"string"}, + "AwsIotJobArn":{"type":"string"}, + "AwsIotJobId":{"type":"string"}, + "AwsIotSqlVersion":{"type":"string"}, + "AwsJobExecutionsRolloutConfig":{ + "type":"structure", + "members":{ + "maximumPerMinute":{ + "shape":"MaximumPerMinute", + "documentation":"

The maximum number of OTA update job executions started per minute.

" + } + }, + "documentation":"

Configuration for the rollout of OTA updates.

" + }, + "Behavior":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"BehaviorName", + "documentation":"

The name you have given to the behavior.

" + }, + "metric":{ + "shape":"BehaviorMetric", + "documentation":"

What is measured by the behavior.

" + }, + "criteria":{ + "shape":"BehaviorCriteria", + "documentation":"

The criteria that determine if a device is behaving normally in regard to the metric.

" + } + }, + "documentation":"

A Device Defender security profile behavior.

" + }, + "BehaviorCriteria":{ + "type":"structure", + "members":{ + "comparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

The operator that relates the thing measured (metric) to the criteria (containing a value or statisticalThreshold).

" + }, + "value":{ + "shape":"MetricValue", + "documentation":"

The value to be compared with the metric.

" + }, + "durationSeconds":{ + "shape":"DurationSeconds", + "documentation":"

Use this to specify the time duration over which the behavior is evaluated, for those criteria which have a time dimension (for example, NUM_MESSAGES_SENT). For a statisticalThreshhold metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank.

" + }, + "consecutiveDatapointsToAlarm":{ + "shape":"ConsecutiveDatapointsToAlarm", + "documentation":"

If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.

" + }, + "consecutiveDatapointsToClear":{ + "shape":"ConsecutiveDatapointsToClear", + "documentation":"

If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.

" + }, + "statisticalThreshold":{ + "shape":"StatisticalThreshold", + "documentation":"

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

" + } + }, + "documentation":"

The criteria by which the behavior is determined to be normal.

" + }, + "BehaviorMetric":{"type":"string"}, + "BehaviorName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "Behaviors":{ + "type":"list", + "member":{"shape":"Behavior"}, + "max":100 + }, + "BillingGroupArn":{"type":"string"}, + "BillingGroupDescription":{ + "type":"string", + "max":2028, + "pattern":"[\\p{Graph}\\x20]*" + }, + "BillingGroupId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9\\-]+" + }, + "BillingGroupMetadata":{ + "type":"structure", + "members":{ + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The date the billing group was created.

" + } + }, + "documentation":"

Additional information about the billing group.

" + }, + "BillingGroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "BillingGroupNameAndArnList":{ + "type":"list", + "member":{"shape":"GroupNameAndArn"} + }, + "BillingGroupProperties":{ + "type":"structure", + "members":{ + "billingGroupDescription":{ + "shape":"BillingGroupDescription", + "documentation":"

The description of the billing group.

" + } + }, + "documentation":"

The properties of a billing group.

" + }, + "Boolean":{"type":"boolean"}, + "BucketName":{"type":"string"}, + "CACertificate":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The ARN of the CA certificate.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the CA certificate.

" + }, + "status":{ + "shape":"CACertificateStatus", + "documentation":"

The status of the CA certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date the CA certificate was created.

" + } + }, + "documentation":"

A CA certificate.

" + }, + "CACertificateDescription":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The CA certificate ARN.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The CA certificate ID.

" + }, + "status":{ + "shape":"CACertificateStatus", + "documentation":"

The status of a CA certificate.

" + }, + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

The CA certificate data, in PEM format.

" + }, + "ownedBy":{ + "shape":"AwsAccountId", + "documentation":"

The owner of the CA certificate.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date the CA certificate was created.

" + }, + "autoRegistrationStatus":{ + "shape":"AutoRegistrationStatus", + "documentation":"

Whether the CA certificate configured for auto registration of device certificates. Valid values are \"ENABLE\" and \"DISABLE\"

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the CA certificate was last modified.

" + }, + "customerVersion":{ + "shape":"CustomerVersion", + "documentation":"

The customer version of the CA certificate.

" + }, + "generationId":{ + "shape":"GenerationId", + "documentation":"

The generation ID of the CA certificate.

" + }, + "validity":{ + "shape":"CertificateValidity", + "documentation":"

When the CA certificate is valid.

" + } + }, + "documentation":"

Describes a CA certificate.

" + }, + "CACertificateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "CACertificateUpdateAction":{ + "type":"string", + "enum":["DEACTIVATE"] + }, + "CACertificates":{ + "type":"list", + "member":{"shape":"CACertificate"} + }, + "CancelAuditMitigationActionsTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

The unique identifier for the task that you want to cancel.

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "CancelAuditMitigationActionsTaskResponse":{ + "type":"structure", + "members":{ + } + }, + "CancelAuditTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

The ID of the audit you want to cancel. You can only cancel an audit that is \"IN_PROGRESS\".

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "CancelAuditTaskResponse":{ + "type":"structure", + "members":{ + } + }, + "CancelCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + } + }, + "documentation":"

The input for the CancelCertificateTransfer operation.

" + }, + "CancelJobExecutionRequest":{ + "type":"structure", + "required":[ + "jobId", + "thingName" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The ID of the job to be canceled.

", + "location":"uri", + "locationName":"jobId" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing whose execution of the job will be canceled.

", + "location":"uri", + "locationName":"thingName" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

(Optional) If true the job execution will be canceled if it has status IN_PROGRESS or QUEUED, otherwise the job execution will be canceled only if it has status QUEUED. If you attempt to cancel a job execution that is IN_PROGRESS, and you do not set force to true, then an InvalidStateTransitionException will be thrown. The default is false.

Canceling a job execution which is \"IN_PROGRESS\", will cause the device to be unable to update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

", + "location":"querystring", + "locationName":"force" + }, + "expectedVersion":{ + "shape":"ExpectedVersion", + "documentation":"

(Optional) The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

" + }, + "statusDetails":{ + "shape":"DetailsMap", + "documentation":"

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged. You can specify at most 10 name/value pairs.

" + } + } + }, + "CancelJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "reasonCode":{ + "shape":"ReasonCode", + "documentation":"

(Optional)A reason code string that explains why the job was canceled.

" + }, + "comment":{ + "shape":"Comment", + "documentation":"

An optional comment string describing why the job was canceled.

" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

(Optional) If true job executions with status \"IN_PROGRESS\" and \"QUEUED\" are canceled, otherwise only job executions with status \"QUEUED\" are canceled. The default is false.

Canceling a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

", + "location":"querystring", + "locationName":"force" + } + } + }, + "CancelJobResponse":{ + "type":"structure", + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

The job ARN.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

A short text description of the job.

" + } + } + }, + "CanceledChecksCount":{"type":"integer"}, + "CanceledFindingsCount":{"type":"long"}, + "CanceledThings":{"type":"integer"}, + "CannedAccessControlList":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "aws-exec-read", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control", + "log-delivery-write" + ] + }, + "Certificate":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The ARN of the certificate.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

" + }, + "status":{ + "shape":"CertificateStatus", + "documentation":"

The status of the certificate.

The status value REGISTER_INACTIVE is deprecated and should not be used.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date and time the certificate was created.

" + } + }, + "documentation":"

Information about a certificate.

" + }, + "CertificateArn":{"type":"string"}, + "CertificateConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

Unable to verify the CA certificate used to sign the device certificate you are attempting to register. This is happens when you have registered more than one CA certificate that has the same subject field and public key.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CertificateDescription":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The ARN of the certificate.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate.

" + }, + "caCertificateId":{ + "shape":"CertificateId", + "documentation":"

The certificate ID of the CA certificate used to sign this certificate.

" + }, + "status":{ + "shape":"CertificateStatus", + "documentation":"

The status of the certificate.

" + }, + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

The certificate data, in PEM format.

" + }, + "ownedBy":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that owns the certificate.

" + }, + "previousOwnedBy":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account of the previous owner of the certificate.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date and time the certificate was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date and time the certificate was last modified.

" + }, + "customerVersion":{ + "shape":"CustomerVersion", + "documentation":"

The customer version of the certificate.

" + }, + "transferData":{ + "shape":"TransferData", + "documentation":"

The transfer data.

" + }, + "generationId":{ + "shape":"GenerationId", + "documentation":"

The generation ID of the certificate.

" + }, + "validity":{ + "shape":"CertificateValidity", + "documentation":"

When the certificate is valid.

" + } + }, + "documentation":"

Describes a certificate.

" + }, + "CertificateId":{ + "type":"string", + "max":64, + "min":64, + "pattern":"(0x)?[a-fA-F0-9]+" + }, + "CertificateName":{"type":"string"}, + "CertificatePathOnDevice":{"type":"string"}, + "CertificatePem":{ + "type":"string", + "documentation":"

The PEM of a certificate.

", + "max":65536, + "min":1 + }, + "CertificateSigningRequest":{ + "type":"string", + "min":1 + }, + "CertificateStateException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The certificate operation is not allowed.

", + "error":{"httpStatusCode":406}, + "exception":true + }, + "CertificateStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "REVOKED", + "PENDING_TRANSFER", + "REGISTER_INACTIVE", + "PENDING_ACTIVATION" + ] + }, + "CertificateValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Additional information about the exception.

" + } + }, + "documentation":"

The certificate is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CertificateValidity":{ + "type":"structure", + "members":{ + "notBefore":{ + "shape":"DateType", + "documentation":"

The certificate is not valid before this date.

" + }, + "notAfter":{ + "shape":"DateType", + "documentation":"

The certificate is not valid after this date.

" + } + }, + "documentation":"

When the certificate is valid.

" + }, + "Certificates":{ + "type":"list", + "member":{"shape":"Certificate"} + }, + "ChannelName":{"type":"string"}, + "CheckCompliant":{"type":"boolean"}, + "Cidr":{ + "type":"string", + "max":43, + "min":2, + "pattern":"[a-fA-F0-9:\\.\\/]+" + }, + "Cidrs":{ + "type":"list", + "member":{"shape":"Cidr"} + }, + "ClearDefaultAuthorizerRequest":{ + "type":"structure", + "members":{ + } + }, + "ClearDefaultAuthorizerResponse":{ + "type":"structure", + "members":{ + } + }, + "ClientId":{"type":"string"}, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "CloudwatchAlarmAction":{ + "type":"structure", + "required":[ + "roleArn", + "alarmName", + "stateReason", + "stateValue" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The IAM role that allows access to the CloudWatch alarm.

" + }, + "alarmName":{ + "shape":"AlarmName", + "documentation":"

The CloudWatch alarm name.

" + }, + "stateReason":{ + "shape":"StateReason", + "documentation":"

The reason for the alarm change.

" + }, + "stateValue":{ + "shape":"StateValue", + "documentation":"

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

" + } + }, + "documentation":"

Describes an action that updates a CloudWatch alarm.

" + }, + "CloudwatchMetricAction":{ + "type":"structure", + "required":[ + "roleArn", + "metricNamespace", + "metricName", + "metricValue", + "metricUnit" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The IAM role that allows access to the CloudWatch metric.

" + }, + "metricNamespace":{ + "shape":"String", + "documentation":"

The CloudWatch metric namespace name.

" + }, + "metricName":{ + "shape":"String", + "documentation":"

The CloudWatch metric name.

" + }, + "metricValue":{ + "shape":"String", + "documentation":"

The CloudWatch metric value.

" + }, + "metricUnit":{ + "shape":"String", + "documentation":"

The metric unit supported by CloudWatch.

" + }, + "metricTimestamp":{ + "shape":"String", + "documentation":"

An optional Unix timestamp.

" + } + }, + "documentation":"

Describes an action that captures a CloudWatch metric.

" + }, + "Code":{"type":"string"}, + "CodeSigning":{ + "type":"structure", + "members":{ + "awsSignerJobId":{ + "shape":"SigningJobId", + "documentation":"

The ID of the AWSSignerJob which was created to sign the file.

" + }, + "startSigningJobParameter":{ + "shape":"StartSigningJobParameter", + "documentation":"

Describes the code-signing job.

" + }, + "customCodeSigning":{ + "shape":"CustomCodeSigning", + "documentation":"

A custom method for code signing a file.

" + } + }, + "documentation":"

Describes the method to use when code signing a file.

" + }, + "CodeSigningCertificateChain":{ + "type":"structure", + "members":{ + "certificateName":{ + "shape":"CertificateName", + "documentation":"

The name of the certificate.

" + }, + "inlineDocument":{ + "shape":"InlineDocument", + "documentation":"

A base64 encoded binary representation of the code signing certificate chain.

" + } + }, + "documentation":"

Describes the certificate chain being used when code signing a file.

" + }, + "CodeSigningSignature":{ + "type":"structure", + "members":{ + "inlineDocument":{ + "shape":"Signature", + "documentation":"

A base64 encoded binary representation of the code signing signature.

" + } + }, + "documentation":"

Describes the signature for a file.

" + }, + "CognitoIdentityPoolId":{"type":"string"}, + "Comment":{ + "type":"string", + "max":2028, + "pattern":"[^\\p{C}]+" + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "less-than", + "less-than-equals", + "greater-than", + "greater-than-equals", + "in-cidr-set", + "not-in-cidr-set", + "in-port-set", + "not-in-port-set" + ] + }, + "CompliantChecksCount":{"type":"integer"}, + "Configuration":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Enabled", + "documentation":"

True to enable the configuration.

" + } + }, + "documentation":"

Configuration.

" + }, + "ConflictingResourceUpdateException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

A conflicting resource update exception. This exception is thrown when two pending updates cause a conflict.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConnectivityTimestamp":{"type":"long"}, + "ConsecutiveDatapointsToAlarm":{ + "type":"integer", + "max":10, + "min":1 + }, + "ConsecutiveDatapointsToClear":{ + "type":"integer", + "max":10, + "min":1 + }, + "Count":{"type":"integer"}, + "CreateAuthorizerRequest":{ + "type":"structure", + "required":[ + "authorizerName", + "authorizerFunctionArn", + "tokenKeyName", + "tokenSigningPublicKeys" + ], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

", + "location":"uri", + "locationName":"authorizerName" + }, + "authorizerFunctionArn":{ + "shape":"AuthorizerFunctionArn", + "documentation":"

The ARN of the authorizer's Lambda function.

" + }, + "tokenKeyName":{ + "shape":"TokenKeyName", + "documentation":"

The name of the token key used to extract the token from the HTTP headers.

" + }, + "tokenSigningPublicKeys":{ + "shape":"PublicKeyMap", + "documentation":"

The public keys used to verify the digital signature returned by your custom authentication service.

" + }, + "status":{ + "shape":"AuthorizerStatus", + "documentation":"

The status of the create authorizer request.

" + } + } + }, + "CreateAuthorizerResponse":{ + "type":"structure", + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer's name.

" + }, + "authorizerArn":{ + "shape":"AuthorizerArn", + "documentation":"

The authorizer ARN.

" + } + } + }, + "CreateBillingGroupRequest":{ + "type":"structure", + "required":["billingGroupName"], + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name you wish to give to the billing group.

", + "location":"uri", + "locationName":"billingGroupName" + }, + "billingGroupProperties":{ + "shape":"BillingGroupProperties", + "documentation":"

The properties of the billing group.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the billing group.

" + } + } + }, + "CreateBillingGroupResponse":{ + "type":"structure", + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name you gave to the billing group.

" + }, + "billingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"

The ARN of the billing group.

" + }, + "billingGroupId":{ + "shape":"BillingGroupId", + "documentation":"

The ID of the billing group.

" + } + } + }, + "CreateCertificateFromCsrRequest":{ + "type":"structure", + "required":["certificateSigningRequest"], + "members":{ + "certificateSigningRequest":{ + "shape":"CertificateSigningRequest", + "documentation":"

The certificate signing request (CSR).

" + }, + "setAsActive":{ + "shape":"SetAsActive", + "documentation":"

Specifies whether the certificate is active.

", + "location":"querystring", + "locationName":"setAsActive" + } + }, + "documentation":"

The input for the CreateCertificateFromCsr operation.

" + }, + "CreateCertificateFromCsrResponse":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The Amazon Resource Name (ARN) of the certificate. You can use the ARN as a principal for policy operations.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. Certificate management operations only take a certificateId.

" + }, + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

The certificate data, in PEM format.

" + } + }, + "documentation":"

The output from the CreateCertificateFromCsr operation.

" + }, + "CreateDynamicThingGroupRequest":{ + "type":"structure", + "required":[ + "thingGroupName", + "queryString" + ], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The dynamic thing group name to create.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "thingGroupProperties":{ + "shape":"ThingGroupProperties", + "documentation":"

The dynamic thing group properties.

" + }, + "indexName":{ + "shape":"IndexName", + "documentation":"

The dynamic thing group index name.

Currently one index is supported: \"AWS_Things\".

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The dynamic thing group search query string.

See Query Syntax for information about query string syntax.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The dynamic thing group query version.

Currently one query version is supported: \"2017-09-30\". If not specified, the query version defaults to this value.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the dynamic thing group.

" + } + } + }, + "CreateDynamicThingGroupResponse":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The dynamic thing group name.

" + }, + "thingGroupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The dynamic thing group ARN.

" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

The dynamic thing group ID.

" + }, + "indexName":{ + "shape":"IndexName", + "documentation":"

The dynamic thing group index name.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The dynamic thing group search query string.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The dynamic thing group query version.

" + } + } + }, + "CreateJobRequest":{ + "type":"structure", + "required":[ + "jobId", + "targets" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

A job identifier which must be unique for your AWS account. We recommend using a UUID. Alpha-numeric characters, \"-\" and \"_\" are valid for use here.

", + "location":"uri", + "locationName":"jobId" + }, + "targets":{ + "shape":"JobTargets", + "documentation":"

A list of things and thing groups to which the job should be sent.

" + }, + "documentSource":{ + "shape":"JobDocumentSource", + "documentation":"

An S3 link to the job document.

" + }, + "document":{ + "shape":"JobDocument", + "documentation":"

The job document.

If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.

The placeholder link is of the following form:

${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}

where bucket is your bucket name and key is the object in the bucket to which you are linking.

" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

A short text description of the job.

" + }, + "presignedUrlConfig":{ + "shape":"PresignedUrlConfig", + "documentation":"

Configuration information for pre-signed S3 URLs.

" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

" + }, + "jobExecutionsRolloutConfig":{ + "shape":"JobExecutionsRolloutConfig", + "documentation":"

Allows you to create a staged rollout of the job.

" + }, + "abortConfig":{ + "shape":"AbortConfig", + "documentation":"

Allows you to create criteria to abort a job.

" + }, + "timeoutConfig":{ + "shape":"TimeoutConfig", + "documentation":"

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the job.

" + } + } + }, + "CreateJobResponse":{ + "type":"structure", + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

The job ARN.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job.

" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

The job description.

" + } + } + }, + "CreateKeysAndCertificateRequest":{ + "type":"structure", + "members":{ + "setAsActive":{ + "shape":"SetAsActive", + "documentation":"

Specifies whether the certificate is active.

", + "location":"querystring", + "locationName":"setAsActive" + } + }, + "documentation":"

The input for the CreateKeysAndCertificate operation.

" + }, + "CreateKeysAndCertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The ARN of the certificate.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. AWS IoT issues a default subject name for the certificate (for example, AWS IoT Certificate).

" + }, + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

The certificate data, in PEM format.

" + }, + "keyPair":{ + "shape":"KeyPair", + "documentation":"

The generated key pair.

" + } + }, + "documentation":"

The output of the CreateKeysAndCertificate operation.

" + }, + "CreateMitigationActionRequest":{ + "type":"structure", + "required":[ + "actionName", + "roleArn", + "actionParams" + ], + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

A friendly name for the action. Choose a friendly name that accurately describes the action (for example, EnableLoggingAction).

", + "location":"uri", + "locationName":"actionName" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that is used to apply the mitigation action.

" + }, + "actionParams":{ + "shape":"MitigationActionParams", + "documentation":"

Defines the type of action and the parameters for that action.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata that can be used to manage the mitigation action.

" + } + } + }, + "CreateMitigationActionResponse":{ + "type":"structure", + "members":{ + "actionArn":{ + "shape":"MitigationActionArn", + "documentation":"

The ARN for the new mitigation action.

" + }, + "actionId":{ + "shape":"MitigationActionId", + "documentation":"

A unique identifier for the new mitigation action.

" + } + } + }, + "CreateOTAUpdateRequest":{ + "type":"structure", + "required":[ + "otaUpdateId", + "targets", + "files", + "roleArn" + ], + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The ID of the OTA update to be created.

", + "location":"uri", + "locationName":"otaUpdateId" + }, + "description":{ + "shape":"OTAUpdateDescription", + "documentation":"

The description of the OTA update.

" + }, + "targets":{ + "shape":"Targets", + "documentation":"

The targeted devices to receive OTA updates.

" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.

" + }, + "awsJobExecutionsRolloutConfig":{ + "shape":"AwsJobExecutionsRolloutConfig", + "documentation":"

Configuration for the rollout of OTA updates.

" + }, + "files":{ + "shape":"OTAUpdateFiles", + "documentation":"

The files to be streamed by the OTA update.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The IAM role that allows access to the AWS IoT Jobs service.

" + }, + "additionalParameters":{ + "shape":"AdditionalParameterMap", + "documentation":"

A list of additional OTA update parameters which are name-value pairs.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage updates.

" + } + } + }, + "CreateOTAUpdateResponse":{ + "type":"structure", + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The OTA update ID.

" + }, + "awsIotJobId":{ + "shape":"AwsIotJobId", + "documentation":"

The AWS IoT job ID associated with the OTA update.

" + }, + "otaUpdateArn":{ + "shape":"OTAUpdateArn", + "documentation":"

The OTA update ARN.

" + }, + "awsIotJobArn":{ + "shape":"AwsIotJobArn", + "documentation":"

The AWS IoT job ARN associated with the OTA update.

" + }, + "otaUpdateStatus":{ + "shape":"OTAUpdateStatus", + "documentation":"

The OTA update status.

" + } + } + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy. policyDocument must have a minimum length of 1, with a maximum length of 2048, excluding whitespace.

" + } + }, + "documentation":"

The input for the CreatePolicy operation.

" + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

" + }, + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy.

" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

" + } + }, + "documentation":"

The output from the CreatePolicy operation.

" + }, + "CreatePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyDocument" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespace.

" + }, + "setAsDefault":{ + "shape":"SetAsDefault", + "documentation":"

Specifies whether the policy version is set as the default. When this parameter is true, the new policy version becomes the operative version (that is, the version that is in effect for the certificates to which the policy is attached).

", + "location":"querystring", + "locationName":"setAsDefault" + } + }, + "documentation":"

The input for the CreatePolicyVersion operation.

" + }, + "CreatePolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy.

" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

" + }, + "isDefaultVersion":{ + "shape":"IsDefaultVersion", + "documentation":"

Specifies whether the policy version is the default.

" + } + }, + "documentation":"

The output of the CreatePolicyVersion operation.

" + }, + "CreateRoleAliasRequest":{ + "type":"structure", + "required":[ + "roleAlias", + "roleArn" + ], + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias that points to a role ARN. This allows you to change the role without having to update the device.

", + "location":"uri", + "locationName":"roleAlias" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The role ARN.

" + }, + "credentialDurationSeconds":{ + "shape":"CredentialDurationSeconds", + "documentation":"

How long (in seconds) the credentials will be valid.

" + } + } + }, + "CreateRoleAliasResponse":{ + "type":"structure", + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias.

" + }, + "roleAliasArn":{ + "shape":"RoleAliasArn", + "documentation":"

The role alias ARN.

" + } + } + }, + "CreateScheduledAuditRequest":{ + "type":"structure", + "required":[ + "frequency", + "targetCheckNames", + "scheduledAuditName" + ], + "members":{ + "frequency":{ + "shape":"AuditFrequency", + "documentation":"

How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\" or \"MONTHLY\". The start time of each audit is determined by the system.

" + }, + "dayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.

" + }, + "dayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".

" + }, + "targetCheckNames":{ + "shape":"TargetAuditCheckNames", + "documentation":"

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

" + }, + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name you want to give to the scheduled audit. (Max. 128 chars)

", + "location":"uri", + "locationName":"scheduledAuditName" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata that can be used to manage the scheduled audit.

" + } + } + }, + "CreateScheduledAuditResponse":{ + "type":"structure", + "members":{ + "scheduledAuditArn":{ + "shape":"ScheduledAuditArn", + "documentation":"

The ARN of the scheduled audit.

" + } + } + }, + "CreateSecurityProfileRequest":{ + "type":"structure", + "required":["securityProfileName"], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name you are giving to the security profile.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "securityProfileDescription":{ + "shape":"SecurityProfileDescription", + "documentation":"

A description of the security profile.

" + }, + "behaviors":{ + "shape":"Behaviors", + "documentation":"

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + }, + "alertTargets":{ + "shape":"AlertTargets", + "documentation":"

Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.

" + }, + "additionalMetricsToRetain":{ + "shape":"AdditionalMetricsToRetainList", + "documentation":"

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata that can be used to manage the security profile.

" + } + } + }, + "CreateSecurityProfileResponse":{ + "type":"structure", + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name you gave to the security profile.

" + }, + "securityProfileArn":{ + "shape":"SecurityProfileArn", + "documentation":"

The ARN of the security profile.

" + } + } + }, + "CreateStreamRequest":{ + "type":"structure", + "required":[ + "streamId", + "files", + "roleArn" + ], + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

", + "location":"uri", + "locationName":"streamId" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

A description of the stream.

" + }, + "files":{ + "shape":"StreamFiles", + "documentation":"

The files to stream.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

An IAM role that allows the IoT service principal assumes to access your S3 files.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage streams.

" + } + } + }, + "CreateStreamResponse":{ + "type":"structure", + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

" + }, + "streamArn":{ + "shape":"StreamArn", + "documentation":"

The stream ARN.

" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

A description of the stream.

" + }, + "streamVersion":{ + "shape":"StreamVersion", + "documentation":"

The version of the stream.

" + } + } + }, + "CreateThingGroupRequest":{ + "type":"structure", + "required":["thingGroupName"], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The thing group name to create.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "parentGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the parent thing group.

" + }, + "thingGroupProperties":{ + "shape":"ThingGroupProperties", + "documentation":"

The thing group properties.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the thing group.

" + } + } + }, + "CreateThingGroupResponse":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The thing group name.

" + }, + "thingGroupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The thing group ARN.

" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

The thing group ID.

" + } + } + }, + "CreateThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to create.

", + "location":"uri", + "locationName":"thingName" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type associated with the new thing.

" + }, + "attributePayload":{ + "shape":"AttributePayload", + "documentation":"

The attribute payload, which consists of up to three name/value pairs in a JSON document. For example:

{\\\"attributes\\\":{\\\"string1\\\":\\\"string2\\\"}}

" + }, + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group the thing will be added to.

" + } + }, + "documentation":"

The input for the CreateThing operation.

" + }, + "CreateThingResponse":{ + "type":"structure", + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the new thing.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the new thing.

" + }, + "thingId":{ + "shape":"ThingId", + "documentation":"

The thing ID.

" + } + }, + "documentation":"

The output of the CreateThing operation.

" + }, + "CreateThingTypeRequest":{ + "type":"structure", + "required":["thingTypeName"], + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

", + "location":"uri", + "locationName":"thingTypeName" + }, + "thingTypeProperties":{ + "shape":"ThingTypeProperties", + "documentation":"

The ThingTypeProperties for the thing type to create. It contains information about the new thing type including a description, and a list of searchable thing attribute names.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the thing type.

" + } + }, + "documentation":"

The input for the CreateThingType operation.

" + }, + "CreateThingTypeResponse":{ + "type":"structure", + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

" + }, + "thingTypeArn":{ + "shape":"ThingTypeArn", + "documentation":"

The Amazon Resource Name (ARN) of the thing type.

" + }, + "thingTypeId":{ + "shape":"ThingTypeId", + "documentation":"

The thing type ID.

" + } + }, + "documentation":"

The output of the CreateThingType operation.

" + }, + "CreateTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{ + "shape":"TopicRulePayload", + "documentation":"

The rule payload.

" + }, + "tags":{ + "shape":"String", + "documentation":"

Metadata which can be used to manage the topic rule.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: --tags \"key1=value1&key2=value2...\"

For the cli-input-json file use format: \"tags\": \"key1=value1&key2=value2...\"

", + "location":"header", + "locationName":"x-amz-tagging" + } + }, + "documentation":"

The input for the CreateTopicRule operation.

", + "payload":"topicRulePayload" + }, + "CreatedAtDate":{"type":"timestamp"}, + "CreationDate":{"type":"timestamp"}, + "CredentialDurationSeconds":{ + "type":"integer", + "max":3600, + "min":900 + }, + "CustomCodeSigning":{ + "type":"structure", + "members":{ + "signature":{ + "shape":"CodeSigningSignature", + "documentation":"

The signature for the file.

" + }, + "certificateChain":{ + "shape":"CodeSigningCertificateChain", + "documentation":"

The certificate chain.

" + }, + "hashAlgorithm":{ + "shape":"HashAlgorithm", + "documentation":"

The hash algorithm used to code sign the file.

" + }, + "signatureAlgorithm":{ + "shape":"SignatureAlgorithm", + "documentation":"

The signature algorithm used to code sign the file.

" + } + }, + "documentation":"

Describes a custom method used to code sign a file.

" + }, + "CustomerVersion":{ + "type":"integer", + "min":1 + }, + "DateType":{"type":"timestamp"}, + "DayOfMonth":{ + "type":"string", + "pattern":"^([1-9]|[12][0-9]|3[01])$|^LAST$" + }, + "DayOfWeek":{ + "type":"string", + "enum":[ + "SUN", + "MON", + "TUE", + "WED", + "THU", + "FRI", + "SAT" + ] + }, + "DeleteAccountAuditConfigurationRequest":{ + "type":"structure", + "members":{ + "deleteScheduledAudits":{ + "shape":"DeleteScheduledAudits", + "documentation":"

If true, all scheduled audits are deleted.

", + "location":"querystring", + "locationName":"deleteScheduledAudits" + } + } + }, + "DeleteAccountAuditConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAdditionalMetricsToRetain":{"type":"boolean"}, + "DeleteAlertTargets":{"type":"boolean"}, + "DeleteAuthorizerRequest":{ + "type":"structure", + "required":["authorizerName"], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The name of the authorizer to delete.

", + "location":"uri", + "locationName":"authorizerName" + } + } + }, + "DeleteAuthorizerResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteBehaviors":{"type":"boolean"}, + "DeleteBillingGroupRequest":{ + "type":"structure", + "required":["billingGroupName"], + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

", + "location":"uri", + "locationName":"billingGroupName" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the DeleteBillingGroup request is rejected with a VersionConflictException.

", + "location":"querystring", + "locationName":"expectedVersion" + } + } + }, + "DeleteBillingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteCACertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate to delete. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"caCertificateId" + } + }, + "documentation":"

Input for the DeleteCACertificate operation.

" + }, + "DeleteCACertificateResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteCACertificate operation.

" + }, + "DeleteCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + }, + "forceDelete":{ + "shape":"ForceDelete", + "documentation":"

Forces the deletion of a certificate if it is inactive and is not attached to an IoT thing.

", + "location":"querystring", + "locationName":"forceDelete" + } + }, + "documentation":"

The input for the DeleteCertificate operation.

" + }, + "DeleteConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

You can't delete the resource because it is attached to one or more resources.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeleteDynamicThingGroupRequest":{ + "type":"structure", + "required":["thingGroupName"], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the dynamic thing group to delete.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the dynamic thing group to delete.

", + "location":"querystring", + "locationName":"expectedVersion" + } + } + }, + "DeleteDynamicThingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteJobExecutionRequest":{ + "type":"structure", + "required":[ + "jobId", + "thingName", + "executionNumber" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The ID of the job whose execution on a particular device will be deleted.

", + "location":"uri", + "locationName":"jobId" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing whose job execution will be deleted.

", + "location":"uri", + "locationName":"thingName" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

The ID of the job execution to be deleted. The executionNumber refers to the execution of a particular job on a particular device.

Note that once a job execution is deleted, the executionNumber may be reused by IoT, so be sure you get and use the correct value here.

", + "location":"uri", + "locationName":"executionNumber" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

(Optional) When true, you can delete a job execution which is \"IN_PROGRESS\". Otherwise, you can only delete a job execution which is in a terminal state (\"SUCCEEDED\", \"FAILED\", \"REJECTED\", \"REMOVED\" or \"CANCELED\") or an exception will occur. The default is false.

Deleting a job execution which is \"IN_PROGRESS\", will cause the device to be unable to access job information or update the job execution status. Use caution and ensure that the device is able to recover to a valid state.

", + "location":"querystring", + "locationName":"force" + } + } + }, + "DeleteJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The ID of the job to be deleted.

After a job deletion is completed, you may reuse this jobId when you create a new job. However, this is not recommended, and you must ensure that your devices are not using the jobId to refer to the deleted job.

", + "location":"uri", + "locationName":"jobId" + }, + "force":{ + "shape":"ForceFlag", + "documentation":"

(Optional) When true, you can delete a job which is \"IN_PROGRESS\". Otherwise, you can only delete a job which is in a terminal state (\"COMPLETED\" or \"CANCELED\") or an exception will occur. The default is false.

Deleting a job which is \"IN_PROGRESS\", will cause a device which is executing the job to be unable to access job information or update the job execution status. Use caution and ensure that each device executing a job which is deleted is able to recover to a valid state.

", + "location":"querystring", + "locationName":"force" + } + } + }, + "DeleteMitigationActionRequest":{ + "type":"structure", + "required":["actionName"], + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The name of the mitigation action that you want to delete.

", + "location":"uri", + "locationName":"actionName" + } + } + }, + "DeleteMitigationActionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteOTAUpdateRequest":{ + "type":"structure", + "required":["otaUpdateId"], + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The OTA update ID to delete.

", + "location":"uri", + "locationName":"otaUpdateId" + }, + "deleteStream":{ + "shape":"DeleteStream", + "documentation":"

Specifies if the stream associated with an OTA update should be deleted when the OTA update is deleted.

", + "location":"querystring", + "locationName":"deleteStream" + }, + "forceDeleteAWSJob":{ + "shape":"ForceDeleteAWSJob", + "documentation":"

Specifies if the AWS Job associated with the OTA update should be deleted with the OTA update is deleted.

", + "location":"querystring", + "locationName":"forceDeleteAWSJob" + } + } + }, + "DeleteOTAUpdateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy to delete.

", + "location":"uri", + "locationName":"policyName" + } + }, + "documentation":"

The input for the DeletePolicy operation.

" + }, + "DeletePolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

", + "location":"uri", + "locationName":"policyVersionId" + } + }, + "documentation":"

The input for the DeletePolicyVersion operation.

" + }, + "DeleteRegistrationCodeRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input for the DeleteRegistrationCode operation.

" + }, + "DeleteRegistrationCodeResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteRegistrationCode operation.

" + }, + "DeleteRoleAliasRequest":{ + "type":"structure", + "required":["roleAlias"], + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias to delete.

", + "location":"uri", + "locationName":"roleAlias" + } + } + }, + "DeleteRoleAliasResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteScheduledAuditRequest":{ + "type":"structure", + "required":["scheduledAuditName"], + "members":{ + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit you want to delete.

", + "location":"uri", + "locationName":"scheduledAuditName" + } + } + }, + "DeleteScheduledAuditResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteScheduledAudits":{"type":"boolean"}, + "DeleteSecurityProfileRequest":{ + "type":"structure", + "required":["securityProfileName"], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile to be deleted.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

", + "location":"querystring", + "locationName":"expectedVersion" + } + } + }, + "DeleteSecurityProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteStream":{"type":"boolean"}, + "DeleteStreamRequest":{ + "type":"structure", + "required":["streamId"], + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

", + "location":"uri", + "locationName":"streamId" + } + } + }, + "DeleteStreamResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteThingGroupRequest":{ + "type":"structure", + "required":["thingGroupName"], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the thing group to delete.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the thing group to delete.

", + "location":"querystring", + "locationName":"expectedVersion" + } + } + }, + "DeleteThingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to delete.

", + "location":"uri", + "locationName":"thingName" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the DeleteThing request is rejected with a VersionConflictException.

", + "location":"querystring", + "locationName":"expectedVersion" + } + }, + "documentation":"

The input for the DeleteThing operation.

" + }, + "DeleteThingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output of the DeleteThing operation.

" + }, + "DeleteThingTypeRequest":{ + "type":"structure", + "required":["thingTypeName"], + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

", + "location":"uri", + "locationName":"thingTypeName" + } + }, + "documentation":"

The input for the DeleteThingType operation.

" + }, + "DeleteThingTypeResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeleteThingType operation.

" + }, + "DeleteTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

", + "location":"uri", + "locationName":"ruleName" + } + }, + "documentation":"

The input for the DeleteTopicRule operation.

" + }, + "DeleteV2LoggingLevelRequest":{ + "type":"structure", + "required":[ + "targetType", + "targetName" + ], + "members":{ + "targetType":{ + "shape":"LogTargetType", + "documentation":"

The type of resource for which you are configuring logging. Must be THING_Group.

", + "location":"querystring", + "locationName":"targetType" + }, + "targetName":{ + "shape":"LogTargetName", + "documentation":"

The name of the resource for which you are configuring logging.

", + "location":"querystring", + "locationName":"targetName" + } + } + }, + "DeliveryStreamName":{"type":"string"}, + "Denied":{ + "type":"structure", + "members":{ + "implicitDeny":{ + "shape":"ImplicitDeny", + "documentation":"

Information that implicitly denies the authorization. When a policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

" + }, + "explicitDeny":{ + "shape":"ExplicitDeny", + "documentation":"

Information that explicitly denies the authorization.

" + } + }, + "documentation":"

Contains information that denied the authorization.

" + }, + "DeprecateThingTypeRequest":{ + "type":"structure", + "required":["thingTypeName"], + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type to deprecate.

", + "location":"uri", + "locationName":"thingTypeName" + }, + "undoDeprecate":{ + "shape":"UndoDeprecate", + "documentation":"

Whether to undeprecate a deprecated thing type. If true, the thing type will not be deprecated anymore and you can associate it with things.

" + } + }, + "documentation":"

The input for the DeprecateThingType operation.

" + }, + "DeprecateThingTypeResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output for the DeprecateThingType operation.

" + }, + "DeprecationDate":{"type":"timestamp"}, + "DescribeAccountAuditConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountAuditConfigurationResponse":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

On the first call to UpdateAccountAuditConfiguration, this parameter is required.

" + }, + "auditNotificationTargetConfigurations":{ + "shape":"AuditNotificationTargetConfigurations", + "documentation":"

Information about the targets to which audit notifications are sent for this account.

" + }, + "auditCheckConfigurations":{ + "shape":"AuditCheckConfigurations", + "documentation":"

Which audit checks are enabled and disabled for this account.

" + } + } + }, + "DescribeAuditFindingRequest":{ + "type":"structure", + "required":["findingId"], + "members":{ + "findingId":{ + "shape":"FindingId", + "documentation":"

A unique identifier for a single audit finding. You can use this identifier to apply mitigation actions to the finding.

", + "location":"uri", + "locationName":"findingId" + } + } + }, + "DescribeAuditFindingResponse":{ + "type":"structure", + "members":{ + "finding":{"shape":"AuditFinding"} + } + }, + "DescribeAuditMitigationActionsTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

The unique identifier for the audit mitigation task.

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "DescribeAuditMitigationActionsTaskResponse":{ + "type":"structure", + "members":{ + "taskStatus":{ + "shape":"AuditMitigationActionsTaskStatus", + "documentation":"

The current status of the task.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the task was started.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The date and time when the task was completed or canceled.

" + }, + "taskStatistics":{ + "shape":"AuditMitigationActionsTaskStatistics", + "documentation":"

Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

" + }, + "target":{ + "shape":"AuditMitigationActionsTaskTarget", + "documentation":"

Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

" + }, + "auditCheckToActionsMapping":{ + "shape":"AuditCheckToActionsMapping", + "documentation":"

Specifies the mitigation actions that should be applied to specific audit checks.

" + }, + "actionsDefinition":{ + "shape":"MitigationActionList", + "documentation":"

Specifies the mitigation actions and their parameters that are applied as part of this task.

" + } + } + }, + "DescribeAuditTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

The ID of the audit whose information you want to get.

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "DescribeAuditTaskResponse":{ + "type":"structure", + "members":{ + "taskStatus":{ + "shape":"AuditTaskStatus", + "documentation":"

The status of the audit: one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

" + }, + "taskType":{ + "shape":"AuditTaskType", + "documentation":"

The type of audit: \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED_AUDIT_TASK\".

" + }, + "taskStartTime":{ + "shape":"Timestamp", + "documentation":"

The time the audit started.

" + }, + "taskStatistics":{ + "shape":"TaskStatistics", + "documentation":"

Statistical information about the audit.

" + }, + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit (only if the audit was a scheduled audit).

" + }, + "auditDetails":{ + "shape":"AuditDetails", + "documentation":"

Detailed information about each check performed during this audit.

" + } + } + }, + "DescribeAuthorizerRequest":{ + "type":"structure", + "required":["authorizerName"], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The name of the authorizer to describe.

", + "location":"uri", + "locationName":"authorizerName" + } + } + }, + "DescribeAuthorizerResponse":{ + "type":"structure", + "members":{ + "authorizerDescription":{ + "shape":"AuthorizerDescription", + "documentation":"

The authorizer description.

" + } + } + }, + "DescribeBillingGroupRequest":{ + "type":"structure", + "required":["billingGroupName"], + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

", + "location":"uri", + "locationName":"billingGroupName" + } + } + }, + "DescribeBillingGroupResponse":{ + "type":"structure", + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

" + }, + "billingGroupId":{ + "shape":"BillingGroupId", + "documentation":"

The ID of the billing group.

" + }, + "billingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"

The ARN of the billing group.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the billing group.

" + }, + "billingGroupProperties":{ + "shape":"BillingGroupProperties", + "documentation":"

The properties of the billing group.

" + }, + "billingGroupMetadata":{ + "shape":"BillingGroupMetadata", + "documentation":"

Additional information about the billing group.

" + } + } + }, + "DescribeCACertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The CA certificate identifier.

", + "location":"uri", + "locationName":"caCertificateId" + } + }, + "documentation":"

The input for the DescribeCACertificate operation.

" + }, + "DescribeCACertificateResponse":{ + "type":"structure", + "members":{ + "certificateDescription":{ + "shape":"CACertificateDescription", + "documentation":"

The CA certificate description.

" + }, + "registrationConfig":{ + "shape":"RegistrationConfig", + "documentation":"

Information about the registration configuration.

" + } + }, + "documentation":"

The output from the DescribeCACertificate operation.

" + }, + "DescribeCertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + } + }, + "documentation":"

The input for the DescribeCertificate operation.

" + }, + "DescribeCertificateResponse":{ + "type":"structure", + "members":{ + "certificateDescription":{ + "shape":"CertificateDescription", + "documentation":"

The description of the certificate.

" + } + }, + "documentation":"

The output of the DescribeCertificate operation.

" + }, + "DescribeDefaultAuthorizerRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeDefaultAuthorizerResponse":{ + "type":"structure", + "members":{ + "authorizerDescription":{ + "shape":"AuthorizerDescription", + "documentation":"

The default authorizer's description.

" + } + } + }, + "DescribeEndpointRequest":{ + "type":"structure", + "members":{ + "endpointType":{ + "shape":"EndpointType", + "documentation":"

The endpoint type. Valid endpoint types include:

  • iot:Data - Returns a VeriSign signed data endpoint.

  • iot:Data-ATS - Returns an ATS signed data endpoint.

  • iot:CredentialProvider - Returns an AWS IoT credentials provider API endpoint.

  • iot:Jobs - Returns an AWS IoT device management Jobs API endpoint.

", + "location":"querystring", + "locationName":"endpointType" + } + }, + "documentation":"

The input for the DescribeEndpoint operation.

" + }, + "DescribeEndpointResponse":{ + "type":"structure", + "members":{ + "endpointAddress":{ + "shape":"EndpointAddress", + "documentation":"

The endpoint. The format of the endpoint is as follows: identifier.iot.region.amazonaws.com.

" + } + }, + "documentation":"

The output from the DescribeEndpoint operation.

" + }, + "DescribeEventConfigurationsRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeEventConfigurationsResponse":{ + "type":"structure", + "members":{ + "eventConfigurations":{ + "shape":"EventConfigurations", + "documentation":"

The event configurations.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The creation date of the event configuration.

" + }, + "lastModifiedDate":{ + "shape":"LastModifiedDate", + "documentation":"

The date the event configurations were last modified.

" + } + } + }, + "DescribeIndexRequest":{ + "type":"structure", + "required":["indexName"], + "members":{ + "indexName":{ + "shape":"IndexName", + "documentation":"

The index name.

", + "location":"uri", + "locationName":"indexName" + } + } + }, + "DescribeIndexResponse":{ + "type":"structure", + "members":{ + "indexName":{ + "shape":"IndexName", + "documentation":"

The index name.

" + }, + "indexStatus":{ + "shape":"IndexStatus", + "documentation":"

The index status.

" + }, + "schema":{ + "shape":"IndexSchema", + "documentation":"

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

  • REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

" + } + } + }, + "DescribeJobExecutionRequest":{ + "type":"structure", + "required":[ + "jobId", + "thingName" + ], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing on which the job execution is running.

", + "location":"uri", + "locationName":"thingName" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

A string (consisting of the digits \"0\" through \"9\" which is used to specify a particular job execution on a particular device.

", + "location":"querystring", + "locationName":"executionNumber" + } + } + }, + "DescribeJobExecutionResponse":{ + "type":"structure", + "members":{ + "execution":{ + "shape":"JobExecution", + "documentation":"

Information about the job execution.

" + } + } + }, + "DescribeJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + } + } + }, + "DescribeJobResponse":{ + "type":"structure", + "members":{ + "documentSource":{ + "shape":"JobDocumentSource", + "documentation":"

An S3 link to the job document.

" + }, + "job":{ + "shape":"Job", + "documentation":"

Information about the job.

" + } + } + }, + "DescribeMitigationActionRequest":{ + "type":"structure", + "required":["actionName"], + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The friendly name that uniquely identifies the mitigation action.

", + "location":"uri", + "locationName":"actionName" + } + } + }, + "DescribeMitigationActionResponse":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The friendly name that uniquely identifies the mitigation action.

" + }, + "actionType":{ + "shape":"MitigationActionType", + "documentation":"

The type of mitigation action.

" + }, + "actionArn":{ + "shape":"MitigationActionArn", + "documentation":"

The ARN that identifies this migration action.

" + }, + "actionId":{ + "shape":"MitigationActionId", + "documentation":"

A unique identifier for this action.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role used to apply this action.

" + }, + "actionParams":{ + "shape":"MitigationActionParams", + "documentation":"

Parameters that control how the mitigation action is applied, specific to the type of mitigation action.

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time when the mitigation action was added to your AWS account.

" + }, + "lastModifiedDate":{ + "shape":"Timestamp", + "documentation":"

The date and time when the mitigation action was last changed.

" + } + } + }, + "DescribeRoleAliasRequest":{ + "type":"structure", + "required":["roleAlias"], + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias to describe.

", + "location":"uri", + "locationName":"roleAlias" + } + } + }, + "DescribeRoleAliasResponse":{ + "type":"structure", + "members":{ + "roleAliasDescription":{ + "shape":"RoleAliasDescription", + "documentation":"

The role alias description.

" + } + } + }, + "DescribeScheduledAuditRequest":{ + "type":"structure", + "required":["scheduledAuditName"], + "members":{ + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit whose information you want to get.

", + "location":"uri", + "locationName":"scheduledAuditName" + } + } + }, + "DescribeScheduledAuditResponse":{ + "type":"structure", + "members":{ + "frequency":{ + "shape":"AuditFrequency", + "documentation":"

How often the scheduled audit takes place. One of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by the system.

" + }, + "dayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

The day of the month on which the scheduled audit takes place. Will be \"1\" through \"31\" or \"LAST\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.

" + }, + "dayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

The day of the week on which the scheduled audit takes place. One of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\".

" + }, + "targetCheckNames":{ + "shape":"TargetAuditCheckNames", + "documentation":"

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

" + }, + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit.

" + }, + "scheduledAuditArn":{ + "shape":"ScheduledAuditArn", + "documentation":"

The ARN of the scheduled audit.

" + } + } + }, + "DescribeSecurityProfileRequest":{ + "type":"structure", + "required":["securityProfileName"], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile whose information you want to get.

", + "location":"uri", + "locationName":"securityProfileName" + } + } + }, + "DescribeSecurityProfileResponse":{ + "type":"structure", + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile.

" + }, + "securityProfileArn":{ + "shape":"SecurityProfileArn", + "documentation":"

The ARN of the security profile.

" + }, + "securityProfileDescription":{ + "shape":"SecurityProfileDescription", + "documentation":"

A description of the security profile (associated with the security profile when it was created or updated).

" + }, + "behaviors":{ + "shape":"Behaviors", + "documentation":"

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + }, + "alertTargets":{ + "shape":"AlertTargets", + "documentation":"

Where the alerts are sent. (Alerts are always sent to the console.)

" + }, + "additionalMetricsToRetain":{ + "shape":"AdditionalMetricsToRetainList", + "documentation":"

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the security profile. A new version is generated whenever the security profile is updated.

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

The time the security profile was created.

" + }, + "lastModifiedDate":{ + "shape":"Timestamp", + "documentation":"

The time the security profile was last modified.

" + } + } + }, + "DescribeStreamRequest":{ + "type":"structure", + "required":["streamId"], + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

", + "location":"uri", + "locationName":"streamId" + } + } + }, + "DescribeStreamResponse":{ + "type":"structure", + "members":{ + "streamInfo":{ + "shape":"StreamInfo", + "documentation":"

Information about the stream.

" + } + } + }, + "DescribeThingGroupRequest":{ + "type":"structure", + "required":["thingGroupName"], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the thing group.

", + "location":"uri", + "locationName":"thingGroupName" + } + } + }, + "DescribeThingGroupResponse":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the thing group.

" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

The thing group ID.

" + }, + "thingGroupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The thing group ARN.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the thing group.

" + }, + "thingGroupProperties":{ + "shape":"ThingGroupProperties", + "documentation":"

The thing group properties.

" + }, + "thingGroupMetadata":{ + "shape":"ThingGroupMetadata", + "documentation":"

Thing group metadata.

" + }, + "indexName":{ + "shape":"IndexName", + "documentation":"

The dynamic thing group index name.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The dynamic thing group search query string.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The dynamic thing group query version.

" + }, + "status":{ + "shape":"DynamicGroupStatus", + "documentation":"

The dynamic thing group status.

" + } + } + }, + "DescribeThingRegistrationTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"

The task ID.

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "DescribeThingRegistrationTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"

The task ID.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The task creation date.

" + }, + "lastModifiedDate":{ + "shape":"LastModifiedDate", + "documentation":"

The date when the task was last modified.

" + }, + "templateBody":{ + "shape":"TemplateBody", + "documentation":"

The task's template.

" + }, + "inputFileBucket":{ + "shape":"RegistryS3BucketName", + "documentation":"

The S3 bucket that contains the input file.

" + }, + "inputFileKey":{ + "shape":"RegistryS3KeyName", + "documentation":"

The input file key.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The role ARN that grants access to the input file bucket.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the bulk thing provisioning task.

" + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

The message.

" + }, + "successCount":{ + "shape":"Count", + "documentation":"

The number of things successfully provisioned.

" + }, + "failureCount":{ + "shape":"Count", + "documentation":"

The number of things that failed to be provisioned.

" + }, + "percentageProgress":{ + "shape":"Percentage", + "documentation":"

The progress of the bulk provisioning task expressed as a percentage.

" + } + } + }, + "DescribeThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + } + }, + "documentation":"

The input for the DescribeThing operation.

" + }, + "DescribeThingResponse":{ + "type":"structure", + "members":{ + "defaultClientId":{ + "shape":"ClientId", + "documentation":"

The default client ID.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

" + }, + "thingId":{ + "shape":"ThingId", + "documentation":"

The ID of the thing to describe.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing to describe.

" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The thing type name.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The thing attributes.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The current version of the thing record in the registry.

To avoid unintentional changes to the information in the registry, you can pass the version information in the expectedVersion parameter of the UpdateThing and DeleteThing calls.

" + }, + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group the thing belongs to.

" + } + }, + "documentation":"

The output from the DescribeThing operation.

" + }, + "DescribeThingTypeRequest":{ + "type":"structure", + "required":["thingTypeName"], + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

", + "location":"uri", + "locationName":"thingTypeName" + } + }, + "documentation":"

The input for the DescribeThingType operation.

" + }, + "DescribeThingTypeResponse":{ + "type":"structure", + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

" + }, + "thingTypeId":{ + "shape":"ThingTypeId", + "documentation":"

The thing type ID.

" + }, + "thingTypeArn":{ + "shape":"ThingTypeArn", + "documentation":"

The thing type ARN.

" + }, + "thingTypeProperties":{ + "shape":"ThingTypeProperties", + "documentation":"

The ThingTypeProperties contains information about the thing type including description, and a list of searchable thing attribute names.

" + }, + "thingTypeMetadata":{ + "shape":"ThingTypeMetadata", + "documentation":"

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

" + } + }, + "documentation":"

The output for the DescribeThingType operation.

" + }, + "Description":{"type":"string"}, + "Destination":{ + "type":"structure", + "members":{ + "s3Destination":{ + "shape":"S3Destination", + "documentation":"

Describes the location in S3 of the updated firmware.

" + } + }, + "documentation":"

Describes the location of the updated firmware.

" + }, + "DetachPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "target" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy to detach.

", + "location":"uri", + "locationName":"policyName" + }, + "target":{ + "shape":"PolicyTarget", + "documentation":"

The target from which the policy will be detached.

" + } + } + }, + "DetachPrincipalPolicyRequest":{ + "type":"structure", + "required":[ + "policyName", + "principal" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy to detach.

", + "location":"uri", + "locationName":"policyName" + }, + "principal":{ + "shape":"Principal", + "documentation":"

The principal.

If the principal is a certificate, specify the certificate ARN. If the principal is an Amazon Cognito identity, specify the identity ID.

", + "location":"header", + "locationName":"x-amzn-iot-principal" + } + }, + "documentation":"

The input for the DetachPrincipalPolicy operation.

" + }, + "DetachSecurityProfileRequest":{ + "type":"structure", + "required":[ + "securityProfileName", + "securityProfileTargetArn" + ], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The security profile that is detached.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "securityProfileTargetArn":{ + "shape":"SecurityProfileTargetArn", + "documentation":"

The ARN of the thing group from which the security profile is detached.

", + "location":"querystring", + "locationName":"securityProfileTargetArn" + } + } + }, + "DetachSecurityProfileResponse":{ + "type":"structure", + "members":{ + } + }, + "DetachThingPrincipalRequest":{ + "type":"structure", + "required":[ + "thingName", + "principal" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + }, + "principal":{ + "shape":"Principal", + "documentation":"

If the principal is a certificate, this value must be ARN of the certificate. If the principal is an Amazon Cognito identity, this value must be the ID of the Amazon Cognito identity.

", + "location":"header", + "locationName":"x-amzn-principal" + } + }, + "documentation":"

The input for the DetachThingPrincipal operation.

" + }, + "DetachThingPrincipalResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output from the DetachThingPrincipal operation.

" + }, + "DetailsKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "DetailsMap":{ + "type":"map", + "key":{"shape":"DetailsKey"}, + "value":{"shape":"DetailsValue"} + }, + "DetailsValue":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[^\\p{C}]*+" + }, + "DeviceCertificateUpdateAction":{ + "type":"string", + "enum":["DEACTIVATE"] + }, + "DeviceDefenderThingName":{ + "type":"string", + "max":128, + "min":1 + }, + "DisableAllLogs":{"type":"boolean"}, + "DisableTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule to disable.

", + "location":"uri", + "locationName":"ruleName" + } + }, + "documentation":"

The input for the DisableTopicRuleRequest operation.

" + }, + "DurationSeconds":{"type":"integer"}, + "DynamicGroupStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "BUILDING", + "REBUILDING" + ] + }, + "DynamoDBAction":{ + "type":"structure", + "required":[ + "tableName", + "roleArn", + "hashKeyField", + "hashKeyValue" + ], + "members":{ + "tableName":{ + "shape":"TableName", + "documentation":"

The name of the DynamoDB table.

" + }, + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access to the DynamoDB table.

" + }, + "operation":{ + "shape":"DynamoOperation", + "documentation":"

The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.

" + }, + "hashKeyField":{ + "shape":"HashKeyField", + "documentation":"

The hash key name.

" + }, + "hashKeyValue":{ + "shape":"HashKeyValue", + "documentation":"

The hash key value.

" + }, + "hashKeyType":{ + "shape":"DynamoKeyType", + "documentation":"

The hash key type. Valid values are \"STRING\" or \"NUMBER\"

" + }, + "rangeKeyField":{ + "shape":"RangeKeyField", + "documentation":"

The range key name.

" + }, + "rangeKeyValue":{ + "shape":"RangeKeyValue", + "documentation":"

The range key value.

" + }, + "rangeKeyType":{ + "shape":"DynamoKeyType", + "documentation":"

The range key type. Valid values are \"STRING\" or \"NUMBER\"

" + }, + "payloadField":{ + "shape":"PayloadField", + "documentation":"

The action payload. This name can be customized.

" + } + }, + "documentation":"

Describes an action to write to a DynamoDB table.

The tableName, hashKeyField, and rangeKeyField values must match the values used when you created the table.

The hashKeyValue and rangeKeyvalue fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${sql-expression}.

You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:

\"hashKeyValue\": \"${topic(3)}\"

The following field uses the timestamp:

\"rangeKeyValue\": \"${timestamp()}\"

" + }, + "DynamoDBv2Action":{ + "type":"structure", + "required":[ + "roleArn", + "putItem" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access to the DynamoDB table.

" + }, + "putItem":{ + "shape":"PutItemInput", + "documentation":"

Specifies the DynamoDB table to which the message data will be written. For example:

{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }

Each attribute in the message payload will be written to a separate column in the DynamoDB database.

" + } + }, + "documentation":"

Describes an action to write to a DynamoDB table.

This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.

" + }, + "DynamoKeyType":{ + "type":"string", + "enum":[ + "STRING", + "NUMBER" + ] + }, + "DynamoOperation":{"type":"string"}, + "EffectivePolicies":{ + "type":"list", + "member":{"shape":"EffectivePolicy"} + }, + "EffectivePolicy":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

" + }, + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The IAM policy document.

" + } + }, + "documentation":"

The policy that has the effect on the authorization results.

" + }, + "ElasticsearchAction":{ + "type":"structure", + "required":[ + "roleArn", + "endpoint", + "index", + "type", + "id" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The IAM role ARN that has access to Elasticsearch.

" + }, + "endpoint":{ + "shape":"ElasticsearchEndpoint", + "documentation":"

The endpoint of your Elasticsearch domain.

" + }, + "index":{ + "shape":"ElasticsearchIndex", + "documentation":"

The Elasticsearch index where you want to store your data.

" + }, + "type":{ + "shape":"ElasticsearchType", + "documentation":"

The type of document you are storing.

" + }, + "id":{ + "shape":"ElasticsearchId", + "documentation":"

The unique identifier for the document you are storing.

" + } + }, + "documentation":"

Describes an action that writes data to an Amazon Elasticsearch Service domain.

" + }, + "ElasticsearchEndpoint":{ + "type":"string", + "pattern":"https?://.*" + }, + "ElasticsearchId":{"type":"string"}, + "ElasticsearchIndex":{"type":"string"}, + "ElasticsearchType":{"type":"string"}, + "EnableIoTLoggingParams":{ + "type":"structure", + "required":[ + "roleArnForLogging", + "logLevel" + ], + "members":{ + "roleArnForLogging":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role used for logging.

" + }, + "logLevel":{ + "shape":"LogLevel", + "documentation":"

Specifies the types of information to be logged.

" + } + }, + "documentation":"

Parameters used when defining a mitigation action that enable AWS IoT logging.

" + }, + "EnableTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the topic rule to enable.

", + "location":"uri", + "locationName":"ruleName" + } + }, + "documentation":"

The input for the EnableTopicRuleRequest operation.

" + }, + "Enabled":{"type":"boolean"}, + "EndpointAddress":{"type":"string"}, + "EndpointType":{"type":"string"}, + "ErrorCode":{"type":"string"}, + "ErrorInfo":{ + "type":"structure", + "members":{ + "code":{ + "shape":"Code", + "documentation":"

The error code.

" + }, + "message":{ + "shape":"OTAUpdateErrorMessage", + "documentation":"

The error message.

" + } + }, + "documentation":"

Error information.

" + }, + "ErrorMessage":{ + "type":"string", + "max":2048 + }, + "EvaluationStatistic":{ + "type":"string", + "pattern":"(p0|p0\\.1|p0\\.01|p1|p10|p50|p90|p99|p99\\.9|p99\\.99|p100)" + }, + "EventConfigurations":{ + "type":"map", + "key":{"shape":"EventType"}, + "value":{"shape":"Configuration"} + }, + "EventType":{ + "type":"string", + "enum":[ + "THING", + "THING_GROUP", + "THING_TYPE", + "THING_GROUP_MEMBERSHIP", + "THING_GROUP_HIERARCHY", + "THING_TYPE_ASSOCIATION", + "JOB", + "JOB_EXECUTION", + "POLICY", + "CERTIFICATE", + "CA_CERTIFICATE" + ] + }, + "ExecutionNamePrefix":{"type":"string"}, + "ExecutionNumber":{"type":"long"}, + "ExpectedVersion":{"type":"long"}, + "ExpiresInSec":{ + "type":"long", + "max":3600, + "min":60 + }, + "ExplicitDeny":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

The policies that denied the authorization.

" + } + }, + "documentation":"

Information that explicitly denies authorization.

" + }, + "ExponentialRolloutRate":{ + "type":"structure", + "required":[ + "baseRatePerMinute", + "incrementFactor", + "rateIncreaseCriteria" + ], + "members":{ + "baseRatePerMinute":{ + "shape":"RolloutRatePerMinute", + "documentation":"

The minimum number of things that will be notified of a pending job, per minute at the start of job rollout. This parameter allows you to define the initial rate of rollout.

" + }, + "incrementFactor":{ + "shape":"IncrementFactor", + "documentation":"

The exponential factor to increase the rate of rollout for a job.

" + }, + "rateIncreaseCriteria":{ + "shape":"RateIncreaseCriteria", + "documentation":"

The criteria to initiate the increase in rate of rollout for a job.

AWS IoT supports up to one digit after the decimal (for example, 1.5, but not 1.55).

" + } + }, + "documentation":"

Allows you to create an exponential rate of rollout for a job.

" + }, + "FailedChecksCount":{"type":"integer"}, + "FailedFindingsCount":{"type":"long"}, + "FailedThings":{"type":"integer"}, + "FileId":{ + "type":"integer", + "max":255, + "min":0 + }, + "FileLocation":{ + "type":"structure", + "members":{ + "stream":{ + "shape":"Stream", + "documentation":"

The stream that contains the OTA update.

" + }, + "s3Location":{ + "shape":"S3Location", + "documentation":"

The location of the updated firmware in S3.

" + } + }, + "documentation":"

The location of the OTA update.

" + }, + "FileName":{"type":"string"}, + "FindingId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "FindingIds":{ + "type":"list", + "member":{"shape":"FindingId"}, + "max":25, + "min":1 + }, + "FirehoseAction":{ + "type":"structure", + "required":[ + "roleArn", + "deliveryStreamName" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The IAM role that grants access to the Amazon Kinesis Firehose stream.

" + }, + "deliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The delivery stream name.

" + }, + "separator":{ + "shape":"FirehoseSeparator", + "documentation":"

A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).

" + } + }, + "documentation":"

Describes an action that writes data to an Amazon Kinesis Firehose stream.

" + }, + "FirehoseSeparator":{ + "type":"string", + "pattern":"([\\n\\t])|(\\r\\n)|(,)" + }, + "Flag":{"type":"boolean"}, + "ForceDelete":{"type":"boolean"}, + "ForceDeleteAWSJob":{"type":"boolean"}, + "ForceFlag":{"type":"boolean"}, + "Forced":{"type":"boolean"}, + "FunctionArn":{"type":"string"}, + "GEMaxResults":{ + "type":"integer", + "max":10000, + "min":1 + }, + "GenerationId":{"type":"string"}, + "GetEffectivePoliciesRequest":{ + "type":"structure", + "members":{ + "principal":{ + "shape":"Principal", + "documentation":"

The principal.

" + }, + "cognitoIdentityPoolId":{ + "shape":"CognitoIdentityPoolId", + "documentation":"

The Cognito identity pool ID.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing name.

", + "location":"querystring", + "locationName":"thingName" + } + } + }, + "GetEffectivePoliciesResponse":{ + "type":"structure", + "members":{ + "effectivePolicies":{ + "shape":"EffectivePolicies", + "documentation":"

The effective policies.

" + } + } + }, + "GetIndexingConfigurationRequest":{ + "type":"structure", + "members":{ + } + }, + "GetIndexingConfigurationResponse":{ + "type":"structure", + "members":{ + "thingIndexingConfiguration":{ + "shape":"ThingIndexingConfiguration", + "documentation":"

Thing indexing configuration.

" + }, + "thingGroupIndexingConfiguration":{ + "shape":"ThingGroupIndexingConfiguration", + "documentation":"

The index configuration.

" + } + } + }, + "GetJobDocumentRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + } + } + }, + "GetJobDocumentResponse":{ + "type":"structure", + "members":{ + "document":{ + "shape":"JobDocument", + "documentation":"

The job document content.

" + } + } + }, + "GetLoggingOptionsRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input for the GetLoggingOptions operation.

" + }, + "GetLoggingOptionsResponse":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "logLevel":{ + "shape":"LogLevel", + "documentation":"

The logging level.

" + } + }, + "documentation":"

The output from the GetLoggingOptions operation.

" + }, + "GetOTAUpdateRequest":{ + "type":"structure", + "required":["otaUpdateId"], + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The OTA update ID.

", + "location":"uri", + "locationName":"otaUpdateId" + } + } + }, + "GetOTAUpdateResponse":{ + "type":"structure", + "members":{ + "otaUpdateInfo":{ + "shape":"OTAUpdateInfo", + "documentation":"

The OTA update info.

" + } + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

", + "location":"uri", + "locationName":"policyName" + } + }, + "documentation":"

The input for the GetPolicy operation.

" + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

" + }, + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy.

" + }, + "defaultVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The default policy version ID.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date the policy was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the policy was last modified.

" + }, + "generationId":{ + "shape":"GenerationId", + "documentation":"

The generation ID of the policy.

" + } + }, + "documentation":"

The output from the GetPolicy operation.

" + }, + "GetPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

", + "location":"uri", + "locationName":"policyVersionId" + } + }, + "documentation":"

The input for the GetPolicyVersion operation.

" + }, + "GetPolicyVersionResponse":{ + "type":"structure", + "members":{ + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + }, + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The JSON document that describes the policy.

" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

" + }, + "isDefaultVersion":{ + "shape":"IsDefaultVersion", + "documentation":"

Specifies whether the policy version is the default.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date the policy version was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date the policy version was last modified.

" + }, + "generationId":{ + "shape":"GenerationId", + "documentation":"

The generation ID of the policy version.

" + } + }, + "documentation":"

The output from the GetPolicyVersion operation.

" + }, + "GetRegistrationCodeRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input to the GetRegistrationCode operation.

" + }, + "GetRegistrationCodeResponse":{ + "type":"structure", + "members":{ + "registrationCode":{ + "shape":"RegistrationCode", + "documentation":"

The CA certificate registration code.

" + } + }, + "documentation":"

The output from the GetRegistrationCode operation.

" + }, + "GetStatisticsRequest":{ + "type":"structure", + "required":["queryString"], + "members":{ + "indexName":{ + "shape":"IndexName", + "documentation":"

The name of the index to search. The default value is AWS_Things.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The query used to search. You can specify \"*\" for the query string to get the count of all indexed things in your AWS account.

" + }, + "aggregationField":{ + "shape":"AggregationField", + "documentation":"

The aggregation field name. Currently not supported.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The version of the query used to search.

" + } + } + }, + "GetStatisticsResponse":{ + "type":"structure", + "members":{ + "statistics":{ + "shape":"Statistics", + "documentation":"

The statistics returned by the Fleet Indexing service based on the query and aggregation field.

" + } + } + }, + "GetTopicRuleRequest":{ + "type":"structure", + "required":["ruleName"], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

", + "location":"uri", + "locationName":"ruleName" + } + }, + "documentation":"

The input for the GetTopicRule operation.

" + }, + "GetTopicRuleResponse":{ + "type":"structure", + "members":{ + "ruleArn":{ + "shape":"RuleArn", + "documentation":"

The rule ARN.

" + }, + "rule":{ + "shape":"TopicRule", + "documentation":"

The rule.

" + } + }, + "documentation":"

The output from the GetTopicRule operation.

" + }, + "GetV2LoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetV2LoggingOptionsResponse":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The IAM role ARN AWS IoT uses to write to your CloudWatch logs.

" + }, + "defaultLogLevel":{ + "shape":"LogLevel", + "documentation":"

The default log level.

" + }, + "disableAllLogs":{ + "shape":"DisableAllLogs", + "documentation":"

Disables all logs.

" + } + } + }, + "GroupNameAndArn":{ + "type":"structure", + "members":{ + "groupName":{ + "shape":"ThingGroupName", + "documentation":"

The group name.

" + }, + "groupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The group ARN.

" + } + }, + "documentation":"

The name and ARN of a group.

" + }, + "HashAlgorithm":{"type":"string"}, + "HashKeyField":{"type":"string"}, + "HashKeyValue":{"type":"string"}, + "ImplicitDeny":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

Policies that don't contain a matching allow or deny statement for the specified action on the specified resource.

" + } + }, + "documentation":"

Information that implicitly denies authorization. When policy doesn't explicitly deny or allow an action on a resource it is considered an implicit deny.

" + }, + "InProgressChecksCount":{"type":"integer"}, + "InProgressThings":{"type":"integer"}, + "InProgressTimeoutInMinutes":{"type":"long"}, + "IncrementFactor":{ + "type":"double", + "max":5, + "min":1 + }, + "IndexName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "IndexNamesList":{ + "type":"list", + "member":{"shape":"IndexName"} + }, + "IndexNotReadyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The index is not ready.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IndexSchema":{"type":"string"}, + "IndexStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "BUILDING", + "REBUILDING" + ] + }, + "InlineDocument":{"type":"string"}, + "InputName":{ + "type":"string", + "max":128, + "min":1 + }, + "InternalException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An unexpected error has occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An unexpected error has occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidAggregationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The aggregation is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidQueryException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The query is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResponseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The response is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidStateTransitionException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An attempt was made to change to an invalid state, for example by deleting a job or a job execution which is \"IN_PROGRESS\" without setting the force parameter.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "IotAnalyticsAction":{ + "type":"structure", + "members":{ + "channelArn":{ + "shape":"AwsArn", + "documentation":"

(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.

" + }, + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the IoT Analytics channel to which message data will be sent.

" + }, + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).

" + } + }, + "documentation":"

Sends message data to an AWS IoT Analytics channel.

" + }, + "IotEventsAction":{ + "type":"structure", + "required":[ + "inputName", + "roleArn" + ], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the AWS IoT Events input.

" + }, + "messageId":{ + "shape":"MessageId", + "documentation":"

[Optional] Use this to ensure that only one input (message) with a given messageId will be processed by an AWS IoT Events detector.

" + }, + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. (\"Action\":\"iotevents:BatchPutMessage\").

" + } + }, + "documentation":"

Sends an input to an AWS IoT Events detector.

" + }, + "IsAuthenticated":{"type":"boolean"}, + "IsDefaultVersion":{"type":"boolean"}, + "IsDisabled":{"type":"boolean"}, + "Job":{ + "type":"structure", + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

" + }, + "forceCanceled":{ + "shape":"Forced", + "documentation":"

Will be true if the job was canceled with the optional force parameter set to true.

" + }, + "reasonCode":{ + "shape":"ReasonCode", + "documentation":"

If the job was updated, provides the reason code for the update.

" + }, + "comment":{ + "shape":"Comment", + "documentation":"

If the job was updated, describes the reason for the update.

" + }, + "targets":{ + "shape":"JobTargets", + "documentation":"

A list of IoT things and thing groups to which the job should be sent.

" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

A short text description of the job.

" + }, + "presignedUrlConfig":{ + "shape":"PresignedUrlConfig", + "documentation":"

Configuration for pre-signed S3 URLs.

" + }, + "jobExecutionsRolloutConfig":{ + "shape":"JobExecutionsRolloutConfig", + "documentation":"

Allows you to create a staged rollout of a job.

" + }, + "abortConfig":{ + "shape":"AbortConfig", + "documentation":"

Configuration for criteria to abort the job.

" + }, + "createdAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job was created.

" + }, + "lastUpdatedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job was last updated.

" + }, + "completedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job was completed.

" + }, + "jobProcessDetails":{ + "shape":"JobProcessDetails", + "documentation":"

Details about the job process.

" + }, + "timeoutConfig":{ + "shape":"TimeoutConfig", + "documentation":"

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

" + } + }, + "documentation":"

The Job object contains details about a job.

" + }, + "JobArn":{"type":"string"}, + "JobDescription":{ + "type":"string", + "max":2028, + "pattern":"[^\\p{C}]+" + }, + "JobDocument":{ + "type":"string", + "max":32768 + }, + "JobDocumentSource":{ + "type":"string", + "max":1350, + "min":1 + }, + "JobExecution":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to the job when it was created.

" + }, + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

" + }, + "forceCanceled":{ + "shape":"Forced", + "documentation":"

Will be true if the job execution was canceled with the optional force parameter set to true.

" + }, + "statusDetails":{ + "shape":"JobExecutionStatusDetails", + "documentation":"

A collection of name/value pairs that describe the status of the job execution.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing on which the job execution is running.

" + }, + "queuedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution was queued.

" + }, + "startedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution started.

" + }, + "lastUpdatedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution was last updated.

" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

" + }, + "versionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

" + }, + "approximateSecondsBeforeTimedOut":{ + "shape":"ApproximateSecondsBeforeTimedOut", + "documentation":"

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

" + } + }, + "documentation":"

The job execution object represents the execution of a job on a particular device.

" + }, + "JobExecutionFailureType":{ + "type":"string", + "enum":[ + "FAILED", + "REJECTED", + "TIMED_OUT", + "ALL" + ] + }, + "JobExecutionStatus":{ + "type":"string", + "enum":[ + "QUEUED", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "TIMED_OUT", + "REJECTED", + "REMOVED", + "CANCELED" + ] + }, + "JobExecutionStatusDetails":{ + "type":"structure", + "members":{ + "detailsMap":{ + "shape":"DetailsMap", + "documentation":"

The job execution status.

" + } + }, + "documentation":"

Details of the job execution status.

" + }, + "JobExecutionSummary":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The status of the job execution.

" + }, + "queuedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution was queued.

" + }, + "startedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution started.

" + }, + "lastUpdatedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job execution was last updated.

" + }, + "executionNumber":{ + "shape":"ExecutionNumber", + "documentation":"

A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device. It can be used later in commands which return or update job execution information.

" + } + }, + "documentation":"

The job execution summary.

" + }, + "JobExecutionSummaryForJob":{ + "type":"structure", + "members":{ + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing on which the job execution is running.

" + }, + "jobExecutionSummary":{ + "shape":"JobExecutionSummary", + "documentation":"

Contains a subset of information about a job execution.

" + } + }, + "documentation":"

Contains a summary of information about job executions for a specific job.

" + }, + "JobExecutionSummaryForJobList":{ + "type":"list", + "member":{"shape":"JobExecutionSummaryForJob"} + }, + "JobExecutionSummaryForThing":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "jobExecutionSummary":{ + "shape":"JobExecutionSummary", + "documentation":"

Contains a subset of information about a job execution.

" + } + }, + "documentation":"

The job execution summary for a thing.

" + }, + "JobExecutionSummaryForThingList":{ + "type":"list", + "member":{"shape":"JobExecutionSummaryForThing"} + }, + "JobExecutionsRolloutConfig":{ + "type":"structure", + "members":{ + "maximumPerMinute":{ + "shape":"MaxJobExecutionsPerMin", + "documentation":"

The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.

" + }, + "exponentialRate":{ + "shape":"ExponentialRolloutRate", + "documentation":"

The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.

" + } + }, + "documentation":"

Allows you to create a staged rollout of a job.

" + }, + "JobId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "JobProcessDetails":{ + "type":"structure", + "members":{ + "processingTargets":{ + "shape":"ProcessingTargetNameList", + "documentation":"

The target devices to which the job execution is being rolled out. This value will be null after the job execution has finished rolling out to all the target devices.

" + }, + "numberOfCanceledThings":{ + "shape":"CanceledThings", + "documentation":"

The number of things that cancelled the job.

" + }, + "numberOfSucceededThings":{ + "shape":"SucceededThings", + "documentation":"

The number of things which successfully completed the job.

" + }, + "numberOfFailedThings":{ + "shape":"FailedThings", + "documentation":"

The number of things that failed executing the job.

" + }, + "numberOfRejectedThings":{ + "shape":"RejectedThings", + "documentation":"

The number of things that rejected the job.

" + }, + "numberOfQueuedThings":{ + "shape":"QueuedThings", + "documentation":"

The number of things that are awaiting execution of the job.

" + }, + "numberOfInProgressThings":{ + "shape":"InProgressThings", + "documentation":"

The number of things currently executing the job.

" + }, + "numberOfRemovedThings":{ + "shape":"RemovedThings", + "documentation":"

The number of things that are no longer scheduled to execute the job because they have been deleted or have been removed from the group that was a target of the job.

" + }, + "numberOfTimedOutThings":{ + "shape":"TimedOutThings", + "documentation":"

The number of things whose job execution status is TIMED_OUT.

" + } + }, + "documentation":"

The job process details.

" + }, + "JobStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "CANCELED", + "COMPLETED", + "DELETION_IN_PROGRESS" + ] + }, + "JobSummary":{ + "type":"structure", + "members":{ + "jobArn":{ + "shape":"JobArn", + "documentation":"

The job ARN.

" + }, + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

The ID of the thing group.

" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

" + }, + "status":{ + "shape":"JobStatus", + "documentation":"

The job summary status.

" + }, + "createdAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job was created.

" + }, + "lastUpdatedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job was last updated.

" + }, + "completedAt":{ + "shape":"DateType", + "documentation":"

The time, in seconds since the epoch, when the job completed.

" + } + }, + "documentation":"

The job summary.

" + }, + "JobSummaryList":{ + "type":"list", + "member":{"shape":"JobSummary"} + }, + "JobTargets":{ + "type":"list", + "member":{"shape":"TargetArn"}, + "min":1 + }, + "JsonDocument":{"type":"string"}, + "Key":{"type":"string"}, + "KeyName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "KeyPair":{ + "type":"structure", + "members":{ + "PublicKey":{ + "shape":"PublicKey", + "documentation":"

The public key.

" + }, + "PrivateKey":{ + "shape":"PrivateKey", + "documentation":"

The private key.

" + } + }, + "documentation":"

Describes a key pair.

" + }, + "KeyValue":{ + "type":"string", + "max":5120 + }, + "KinesisAction":{ + "type":"structure", + "required":[ + "roleArn", + "streamName" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

" + }, + "streamName":{ + "shape":"StreamName", + "documentation":"

The name of the Amazon Kinesis stream.

" + }, + "partitionKey":{ + "shape":"PartitionKey", + "documentation":"

The partition key.

" + } + }, + "documentation":"

Describes an action to write data to an Amazon Kinesis stream.

" + }, + "LambdaAction":{ + "type":"structure", + "required":["functionArn"], + "members":{ + "functionArn":{ + "shape":"FunctionArn", + "documentation":"

The ARN of the Lambda function.

" + } + }, + "documentation":"

Describes an action to invoke a Lambda function.

" + }, + "LaserMaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "LastModifiedDate":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

A limit has been exceeded.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "ListActiveViolationsRequest":{ + "type":"structure", + "members":{ + "thingName":{ + "shape":"DeviceDefenderThingName", + "documentation":"

The name of the thing whose active violations are listed.

", + "location":"querystring", + "locationName":"thingName" + }, + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the Device Defender security profile for which violations are listed.

", + "location":"querystring", + "locationName":"securityProfileName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListActiveViolationsResponse":{ + "type":"structure", + "members":{ + "activeViolations":{ + "shape":"ActiveViolations", + "documentation":"

The list of active violations.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListAttachedPoliciesRequest":{ + "type":"structure", + "required":["target"], + "members":{ + "target":{ + "shape":"PolicyTarget", + "documentation":"

The group or principal for which the policies will be listed.

", + "location":"uri", + "locationName":"target" + }, + "recursive":{ + "shape":"Recursive", + "documentation":"

When true, recursively list attached policies.

", + "location":"querystring", + "locationName":"recursive" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to be returned per request.

", + "location":"querystring", + "locationName":"pageSize" + } + } + }, + "ListAttachedPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

The policies.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The token to retrieve the next set of results, or ``null`` if there are no more results.

" + } + } + }, + "ListAuditFindingsRequest":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

" + }, + "checkName":{ + "shape":"AuditCheckName", + "documentation":"

A filter to limit results to the findings for the specified audit check.

" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Information identifying the noncompliant resource.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

" + } + } + }, + "ListAuditFindingsResponse":{ + "type":"structure", + "members":{ + "findings":{ + "shape":"AuditFindings", + "documentation":"

The findings (results) of the audit.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListAuditMitigationActionsExecutionsRequest":{ + "type":"structure", + "required":[ + "taskId", + "findingId" + ], + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

Specify this filter to limit results to actions for a specific audit mitigation actions task.

", + "location":"querystring", + "locationName":"taskId" + }, + "actionStatus":{ + "shape":"AuditMitigationActionsExecutionStatus", + "documentation":"

Specify this filter to limit results to those with a specific status.

", + "location":"querystring", + "locationName":"actionStatus" + }, + "findingId":{ + "shape":"FindingId", + "documentation":"

Specify this filter to limit results to those that were applied to a specific audit finding.

", + "location":"querystring", + "locationName":"findingId" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAuditMitigationActionsExecutionsResponse":{ + "type":"structure", + "members":{ + "actionsExecutions":{ + "shape":"AuditMitigationActionExecutionMetadataList", + "documentation":"

A set of task execution results based on the input parameters. Details include the mitigation action applied, start time, and task status.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + } + } + }, + "ListAuditMitigationActionsTasksRequest":{ + "type":"structure", + "required":[ + "startTime", + "endTime" + ], + "members":{ + "auditTaskId":{ + "shape":"AuditTaskId", + "documentation":"

Specify this filter to limit results to tasks that were applied to results for a specific audit.

", + "location":"querystring", + "locationName":"auditTaskId" + }, + "findingId":{ + "shape":"FindingId", + "documentation":"

Specify this filter to limit results to tasks that were applied to a specific audit finding.

", + "location":"querystring", + "locationName":"findingId" + }, + "taskStatus":{ + "shape":"AuditMitigationActionsTaskStatus", + "documentation":"

Specify this filter to limit results to tasks that are in a specific state.

", + "location":"querystring", + "locationName":"taskStatus" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

Specify this filter to limit results to tasks that began on or after a specific date and time.

", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

Specify this filter to limit results to tasks that were completed or canceled on or before a specific date and time.

", + "location":"querystring", + "locationName":"endTime" + } + } + }, + "ListAuditMitigationActionsTasksResponse":{ + "type":"structure", + "members":{ + "tasks":{ + "shape":"AuditMitigationActionsTaskMetadataList", + "documentation":"

The collection of audit mitigation tasks that matched the filter criteria.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + } + } + }, + "ListAuditTasksRequest":{ + "type":"structure", + "required":[ + "startTime", + "endTime" + ], + "members":{ + "startTime":{ + "shape":"Timestamp", + "documentation":"

The beginning of the time period. Audit information is retained for a limited time (180 days). Requesting a start time prior to what is retained results in an \"InvalidRequestException\".

", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end of the time period.

", + "location":"querystring", + "locationName":"endTime" + }, + "taskType":{ + "shape":"AuditTaskType", + "documentation":"

A filter to limit the output to the specified type of audit: can be one of \"ON_DEMAND_AUDIT_TASK\" or \"SCHEDULED__AUDIT_TASK\".

", + "location":"querystring", + "locationName":"taskType" + }, + "taskStatus":{ + "shape":"AuditTaskStatus", + "documentation":"

A filter to limit the output to audits with the specified completion status: can be one of \"IN_PROGRESS\", \"COMPLETED\", \"FAILED\", or \"CANCELED\".

", + "location":"querystring", + "locationName":"taskStatus" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListAuditTasksResponse":{ + "type":"structure", + "members":{ + "tasks":{ + "shape":"AuditTaskMetadataList", + "documentation":"

The audits that were performed during the specified time period.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListAuthorizersRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Return the list of authorizers in ascending alphabetical order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + }, + "status":{ + "shape":"AuthorizerStatus", + "documentation":"

The status of the list authorizers request.

", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListAuthorizersResponse":{ + "type":"structure", + "members":{ + "authorizers":{ + "shape":"Authorizers", + "documentation":"

The authorizers.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

" + } + } + }, + "ListBillingGroupsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return per request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "namePrefixFilter":{ + "shape":"BillingGroupName", + "documentation":"

Limit the results to billing groups whose names have the given prefix.

", + "location":"querystring", + "locationName":"namePrefixFilter" + } + } + }, + "ListBillingGroupsResponse":{ + "type":"structure", + "members":{ + "billingGroups":{ + "shape":"BillingGroupNameAndArnList", + "documentation":"

The list of billing groups.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListCACertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Determines the order of the results.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

Input for the ListCACertificates operation.

" + }, + "ListCACertificatesResponse":{ + "type":"structure", + "members":{ + "certificates":{ + "shape":"CACertificates", + "documentation":"

The CA certificates registered in your AWS account.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The current position within the list of CA certificates.

" + } + }, + "documentation":"

The output from the ListCACertificates operation.

" + }, + "ListCertificatesByCARequest":{ + "type":"structure", + "required":["caCertificateId"], + "members":{ + "caCertificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

", + "location":"uri", + "locationName":"caCertificateId" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input to the ListCertificatesByCA operation.

" + }, + "ListCertificatesByCAResponse":{ + "type":"structure", + "members":{ + "certificates":{ + "shape":"Certificates", + "documentation":"

The device certificates signed by the specified CA certificate.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output of the ListCertificatesByCA operation.

" + }, + "ListCertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input for the ListCertificates operation.

" + }, + "ListCertificatesResponse":{ + "type":"structure", + "members":{ + "certificates":{ + "shape":"Certificates", + "documentation":"

The descriptions of the certificates.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output of the ListCertificates operation.

" + }, + "ListIndicesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"QueryMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListIndicesResponse":{ + "type":"structure", + "members":{ + "indexNames":{ + "shape":"IndexNamesList", + "documentation":"

The index names.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListJobExecutionsForJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The unique identifier you assigned to this job when it was created.

", + "location":"uri", + "locationName":"jobId" + }, + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

The status of the job.

", + "location":"querystring", + "locationName":"status" + }, + "maxResults":{ + "shape":"LaserMaxResults", + "documentation":"

The maximum number of results to be returned per request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListJobExecutionsForJobResponse":{ + "type":"structure", + "members":{ + "executionSummaries":{ + "shape":"JobExecutionSummaryForJobList", + "documentation":"

A list of job execution summaries.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "ListJobExecutionsForThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing name.

", + "location":"uri", + "locationName":"thingName" + }, + "status":{ + "shape":"JobExecutionStatus", + "documentation":"

An optional filter that lets you search for jobs that have the specified status.

", + "location":"querystring", + "locationName":"status" + }, + "maxResults":{ + "shape":"LaserMaxResults", + "documentation":"

The maximum number of results to be returned per request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListJobExecutionsForThingResponse":{ + "type":"structure", + "members":{ + "executionSummaries":{ + "shape":"JobExecutionSummaryForThingList", + "documentation":"

A list of job execution summaries.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "ListJobsRequest":{ + "type":"structure", + "members":{ + "status":{ + "shape":"JobStatus", + "documentation":"

An optional filter that lets you search for jobs that have the specified status.

", + "location":"querystring", + "locationName":"status" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

", + "location":"querystring", + "locationName":"targetSelection" + }, + "maxResults":{ + "shape":"LaserMaxResults", + "documentation":"

The maximum number of results to return per request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

A filter that limits the returned jobs to those for the specified group.

", + "location":"querystring", + "locationName":"thingGroupName" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

A filter that limits the returned jobs to those for the specified group.

", + "location":"querystring", + "locationName":"thingGroupId" + } + } + }, + "ListJobsResponse":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"JobSummaryList", + "documentation":"

A list of jobs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "ListMitigationActionsRequest":{ + "type":"structure", + "members":{ + "actionType":{ + "shape":"MitigationActionType", + "documentation":"

Specify a value to limit the result to mitigation actions with a specific action type.

", + "location":"querystring", + "locationName":"actionType" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMitigationActionsResponse":{ + "type":"structure", + "members":{ + "actionIdentifiers":{ + "shape":"MitigationActionIdentifierList", + "documentation":"

A set of actions that matched the specified filter criteria.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

" + } + } + }, + "ListOTAUpdatesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "otaUpdateStatus":{ + "shape":"OTAUpdateStatus", + "documentation":"

The OTA update job status.

", + "location":"querystring", + "locationName":"otaUpdateStatus" + } + } + }, + "ListOTAUpdatesResponse":{ + "type":"structure", + "members":{ + "otaUpdates":{ + "shape":"OTAUpdatesSummary", + "documentation":"

A list of OTA update jobs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to use to get the next set of results.

" + } + } + }, + "ListOutgoingCertificatesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input to the ListOutgoingCertificates operation.

" + }, + "ListOutgoingCertificatesResponse":{ + "type":"structure", + "members":{ + "outgoingCertificates":{ + "shape":"OutgoingCertificates", + "documentation":"

The certificates that are being transferred but not yet accepted.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

" + } + }, + "documentation":"

The output from the ListOutgoingCertificates operation.

" + }, + "ListPoliciesRequest":{ + "type":"structure", + "members":{ + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If true, the results are returned in ascending creation order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input for the ListPolicies operation.

" + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

The descriptions of the policies.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output from the ListPolicies operation.

" + }, + "ListPolicyPrincipalsRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"header", + "locationName":"x-amzn-iot-policy" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If true, the results are returned in ascending creation order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input for the ListPolicyPrincipals operation.

" + }, + "ListPolicyPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{ + "shape":"Principals", + "documentation":"

The descriptions of the principals.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output from the ListPolicyPrincipals operation.

" + }, + "ListPolicyVersionsRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + } + }, + "documentation":"

The input for the ListPolicyVersions operation.

" + }, + "ListPolicyVersionsResponse":{ + "type":"structure", + "members":{ + "policyVersions":{ + "shape":"PolicyVersions", + "documentation":"

The policy versions.

" + } + }, + "documentation":"

The output from the ListPolicyVersions operation.

" + }, + "ListPrincipalPoliciesRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "principal":{ + "shape":"Principal", + "documentation":"

The principal.

", + "location":"header", + "locationName":"x-amzn-iot-principal" + }, + "marker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The result page size.

", + "location":"querystring", + "locationName":"pageSize" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Specifies the order for results. If true, results are returned in ascending creation order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + }, + "documentation":"

The input for the ListPrincipalPolicies operation.

" + }, + "ListPrincipalPoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"Policies", + "documentation":"

The policies.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

The marker for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output from the ListPrincipalPolicies operation.

" + }, + "ListPrincipalThingsRequest":{ + "type":"structure", + "required":["principal"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return in this operation.

", + "location":"querystring", + "locationName":"maxResults" + }, + "principal":{ + "shape":"Principal", + "documentation":"

The principal.

", + "location":"header", + "locationName":"x-amzn-principal" + } + }, + "documentation":"

The input for the ListPrincipalThings operation.

" + }, + "ListPrincipalThingsResponse":{ + "type":"structure", + "members":{ + "things":{ + "shape":"ThingNameList", + "documentation":"

The things.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output from the ListPrincipalThings operation.

" + }, + "ListRoleAliasesRequest":{ + "type":"structure", + "members":{ + "pageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"pageSize" + }, + "marker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Return the list of role aliases in ascending alphabetical order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListRoleAliasesResponse":{ + "type":"structure", + "members":{ + "roleAliases":{ + "shape":"RoleAliases", + "documentation":"

The role aliases.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

" + } + } + }, + "ListScheduledAuditsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time. The default is 25.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListScheduledAuditsResponse":{ + "type":"structure", + "members":{ + "scheduledAudits":{ + "shape":"ScheduledAuditMetadataList", + "documentation":"

The list of scheduled audits.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListSecurityProfilesForTargetRequest":{ + "type":"structure", + "required":["securityProfileTargetArn"], + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + }, + "recursive":{ + "shape":"Recursive", + "documentation":"

If true, return child groups too.

", + "location":"querystring", + "locationName":"recursive" + }, + "securityProfileTargetArn":{ + "shape":"SecurityProfileTargetArn", + "documentation":"

The ARN of the target (thing group) whose attached security profiles you want to get.

", + "location":"querystring", + "locationName":"securityProfileTargetArn" + } + } + }, + "ListSecurityProfilesForTargetResponse":{ + "type":"structure", + "members":{ + "securityProfileTargetMappings":{ + "shape":"SecurityProfileTargetMappings", + "documentation":"

A list of security profiles and their associated targets.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListSecurityProfilesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListSecurityProfilesResponse":{ + "type":"structure", + "members":{ + "securityProfileIdentifiers":{ + "shape":"SecurityProfileIdentifiers", + "documentation":"

A list of security profile identifiers (names and ARNs).

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListStreamsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at a time.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to get the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "ascendingOrder":{ + "shape":"AscendingOrder", + "documentation":"

Set to true to return the list of streams in ascending order.

", + "location":"querystring", + "locationName":"isAscendingOrder" + } + } + }, + "ListStreamsResponse":{ + "type":"structure", + "members":{ + "streams":{ + "shape":"StreamsSummary", + "documentation":"

A list of streams.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to get the next set of results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource.

", + "location":"querystring", + "locationName":"resourceArn" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The list of tags assigned to the resource.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListTargetsForPolicyRequest":{ + "type":"structure", + "required":["policyName"], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + }, + "marker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

", + "location":"querystring", + "locationName":"marker" + }, + "pageSize":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"pageSize" + } + } + }, + "ListTargetsForPolicyResponse":{ + "type":"structure", + "members":{ + "targets":{ + "shape":"PolicyTargets", + "documentation":"

The policy targets.

" + }, + "nextMarker":{ + "shape":"Marker", + "documentation":"

A marker used to get the next set of results.

" + } + } + }, + "ListTargetsForSecurityProfileRequest":{ + "type":"structure", + "required":["securityProfileName"], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The security profile.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListTargetsForSecurityProfileResponse":{ + "type":"structure", + "members":{ + "securityProfileTargets":{ + "shape":"SecurityProfileTargets", + "documentation":"

The thing groups to which the security profile is attached.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingGroupsForThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing name.

", + "location":"uri", + "locationName":"thingName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListThingGroupsForThingResponse":{ + "type":"structure", + "members":{ + "thingGroups":{ + "shape":"ThingGroupNameAndArnList", + "documentation":"

The thing groups.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingGroupsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + }, + "parentGroup":{ + "shape":"ThingGroupName", + "documentation":"

A filter that limits the results to those with the specified parent group.

", + "location":"querystring", + "locationName":"parentGroup" + }, + "namePrefixFilter":{ + "shape":"ThingGroupName", + "documentation":"

A filter that limits the results to those with the specified name prefix.

", + "location":"querystring", + "locationName":"namePrefixFilter" + }, + "recursive":{ + "shape":"RecursiveWithoutDefault", + "documentation":"

If true, return child groups as well.

", + "location":"querystring", + "locationName":"recursive" + } + } + }, + "ListThingGroupsResponse":{ + "type":"structure", + "members":{ + "thingGroups":{ + "shape":"ThingGroupNameAndArnList", + "documentation":"

The thing groups.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingPrincipalsRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

", + "location":"uri", + "locationName":"thingName" + } + }, + "documentation":"

The input for the ListThingPrincipal operation.

" + }, + "ListThingPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{ + "shape":"Principals", + "documentation":"

The principals associated with the thing.

" + } + }, + "documentation":"

The output from the ListThingPrincipals operation.

" + }, + "ListThingRegistrationTaskReportsRequest":{ + "type":"structure", + "required":[ + "taskId", + "reportType" + ], + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"

The id of the task.

", + "location":"uri", + "locationName":"taskId" + }, + "reportType":{ + "shape":"ReportType", + "documentation":"

The type of task report.

", + "location":"querystring", + "locationName":"reportType" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return per request.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListThingRegistrationTaskReportsResponse":{ + "type":"structure", + "members":{ + "resourceLinks":{ + "shape":"S3FileUrlList", + "documentation":"

Links to the task resources.

" + }, + "reportType":{ + "shape":"ReportType", + "documentation":"

The type of task report.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingRegistrationTasksRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the bulk thing provisioning task.

", + "location":"querystring", + "locationName":"status" + } + } + }, + "ListThingRegistrationTasksResponse":{ + "type":"structure", + "members":{ + "taskIds":{ + "shape":"TaskIdList", + "documentation":"

A list of bulk thing provisioning task IDs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingTypesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return in this operation.

", + "location":"querystring", + "locationName":"maxResults" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

", + "location":"querystring", + "locationName":"thingTypeName" + } + }, + "documentation":"

The input for the ListThingTypes operation.

" + }, + "ListThingTypesResponse":{ + "type":"structure", + "members":{ + "thingTypes":{ + "shape":"ThingTypeList", + "documentation":"

The thing types.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output for the ListThingTypes operation.

" + }, + "ListThingsInBillingGroupRequest":{ + "type":"structure", + "required":["billingGroupName"], + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

", + "location":"uri", + "locationName":"billingGroupName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return per request.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListThingsInBillingGroupResponse":{ + "type":"structure", + "members":{ + "things":{ + "shape":"ThingNameList", + "documentation":"

A list of things in the billing group.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingsInThingGroupRequest":{ + "type":"structure", + "required":["thingGroupName"], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The thing group name.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "recursive":{ + "shape":"Recursive", + "documentation":"

When true, list things in this thing group and in all child groups as well.

", + "location":"querystring", + "locationName":"recursive" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListThingsInThingGroupResponse":{ + "type":"structure", + "members":{ + "things":{ + "shape":"ThingNameList", + "documentation":"

The things in the specified thing group.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListThingsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"RegistryMaxResults", + "documentation":"

The maximum number of results to return in this operation.

", + "location":"querystring", + "locationName":"maxResults" + }, + "attributeName":{ + "shape":"AttributeName", + "documentation":"

The attribute name used to search for things.

", + "location":"querystring", + "locationName":"attributeName" + }, + "attributeValue":{ + "shape":"AttributeValue", + "documentation":"

The attribute value used to search for things.

", + "location":"querystring", + "locationName":"attributeValue" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type used to search for things.

", + "location":"querystring", + "locationName":"thingTypeName" + } + }, + "documentation":"

The input for the ListThings operation.

" + }, + "ListThingsResponse":{ + "type":"structure", + "members":{ + "things":{ + "shape":"ThingAttributeList", + "documentation":"

The things.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + }, + "documentation":"

The output from the ListThings operation.

" + }, + "ListTopicRulesRequest":{ + "type":"structure", + "members":{ + "topic":{ + "shape":"Topic", + "documentation":"

The topic.

", + "location":"querystring", + "locationName":"topic" + }, + "maxResults":{ + "shape":"GEMaxResults", + "documentation":"

The maximum number of results to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to retrieve the next value.

", + "location":"querystring", + "locationName":"nextToken" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "documentation":"

Specifies whether the rule is disabled.

", + "location":"querystring", + "locationName":"ruleDisabled" + } + }, + "documentation":"

The input for the ListTopicRules operation.

" + }, + "ListTopicRulesResponse":{ + "type":"structure", + "members":{ + "rules":{ + "shape":"TopicRuleList", + "documentation":"

The rules.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to retrieve the next value.

" + } + }, + "documentation":"

The output from the ListTopicRules operation.

" + }, + "ListV2LoggingLevelsRequest":{ + "type":"structure", + "members":{ + "targetType":{ + "shape":"LogTargetType", + "documentation":"

The type of resource for which you are configuring logging. Must be THING_Group.

", + "location":"querystring", + "locationName":"targetType" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"SkyfallMaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListV2LoggingLevelsResponse":{ + "type":"structure", + "members":{ + "logTargetConfigurations":{ + "shape":"LogTargetConfigurations", + "documentation":"

The logging configuration for a target.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + } + } + }, + "ListViolationEventsRequest":{ + "type":"structure", + "required":[ + "startTime", + "endTime" + ], + "members":{ + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time for the alerts to be listed.

", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time for the alerts to be listed.

", + "location":"querystring", + "locationName":"endTime" + }, + "thingName":{ + "shape":"DeviceDefenderThingName", + "documentation":"

A filter to limit results to those alerts caused by the specified thing.

", + "location":"querystring", + "locationName":"thingName" + }, + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

A filter to limit results to those alerts generated by the specified security profile.

", + "location":"querystring", + "locationName":"securityProfileName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListViolationEventsResponse":{ + "type":"structure", + "members":{ + "violationEvents":{ + "shape":"ViolationEvents", + "documentation":"

The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "LogLevel":{ + "type":"string", + "enum":[ + "DEBUG", + "INFO", + "ERROR", + "WARN", + "DISABLED" + ] + }, + "LogTarget":{ + "type":"structure", + "required":["targetType"], + "members":{ + "targetType":{ + "shape":"LogTargetType", + "documentation":"

The target type.

" + }, + "targetName":{ + "shape":"LogTargetName", + "documentation":"

The target name.

" + } + }, + "documentation":"

A log target.

" + }, + "LogTargetConfiguration":{ + "type":"structure", + "members":{ + "logTarget":{ + "shape":"LogTarget", + "documentation":"

A log target

" + }, + "logLevel":{ + "shape":"LogLevel", + "documentation":"

The logging level.

" + } + }, + "documentation":"

The target configuration.

" + }, + "LogTargetConfigurations":{ + "type":"list", + "member":{"shape":"LogTargetConfiguration"} + }, + "LogTargetName":{"type":"string"}, + "LogTargetType":{ + "type":"string", + "enum":[ + "DEFAULT", + "THING_GROUP" + ] + }, + "LoggingOptionsPayload":{ + "type":"structure", + "required":["roleArn"], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "logLevel":{ + "shape":"LogLevel", + "documentation":"

The log level.

" + } + }, + "documentation":"

Describes the logging options payload.

" + }, + "MalformedPolicyException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The policy documentation is not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Marker":{ + "type":"string", + "pattern":"[A-Za-z0-9+/]+={0,2}" + }, + "MaxJobExecutionsPerMin":{ + "type":"integer", + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "MaximumPerMinute":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Message":{ + "type":"string", + "max":128 + }, + "MessageFormat":{ + "type":"string", + "enum":[ + "RAW", + "JSON" + ] + }, + "MessageId":{ + "type":"string", + "max":128 + }, + "MetricValue":{ + "type":"structure", + "members":{ + "count":{ + "shape":"UnsignedLong", + "documentation":"

If the comparisonOperator calls for a numeric value, use this to specify that numeric value to be compared with the metric.

" + }, + "cidrs":{ + "shape":"Cidrs", + "documentation":"

If the comparisonOperator calls for a set of CIDRs, use this to specify that set to be compared with the metric.

" + }, + "ports":{ + "shape":"Ports", + "documentation":"

If the comparisonOperator calls for a set of ports, use this to specify that set to be compared with the metric.

" + } + }, + "documentation":"

The value to be compared with the metric.

" + }, + "MinimumNumberOfExecutedThings":{ + "type":"integer", + "min":1 + }, + "MissingContextValue":{"type":"string"}, + "MissingContextValues":{ + "type":"list", + "member":{"shape":"MissingContextValue"} + }, + "MitigationAction":{ + "type":"structure", + "members":{ + "name":{ + "shape":"MitigationActionName", + "documentation":"

A user-friendly name for the mitigation action.

" + }, + "id":{ + "shape":"MitigationActionId", + "documentation":"

A unique identifier for the mitigation action.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The IAM role ARN used to apply this mitigation action.

" + }, + "actionParams":{ + "shape":"MitigationActionParams", + "documentation":"

The set of parameters for this mitigation action. The parameters vary, depending on the kind of action you apply.

" + } + }, + "documentation":"

Describes which changes should be applied as part of a mitigation action.

" + }, + "MitigationActionArn":{"type":"string"}, + "MitigationActionId":{"type":"string"}, + "MitigationActionIdentifier":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The friendly name of the mitigation action.

" + }, + "actionArn":{ + "shape":"MitigationActionArn", + "documentation":"

The IAM role ARN used to apply this mitigation action.

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

The date when this mitigation action was created.

" + } + }, + "documentation":"

Information that identifies a mitigation action. This information is returned by ListMitigationActions.

" + }, + "MitigationActionIdentifierList":{ + "type":"list", + "member":{"shape":"MitigationActionIdentifier"} + }, + "MitigationActionList":{ + "type":"list", + "member":{"shape":"MitigationAction"} + }, + "MitigationActionName":{ + "type":"string", + "max":128, + "pattern":"[a-zA-Z0-9_-]+" + }, + "MitigationActionNameList":{ + "type":"list", + "member":{"shape":"MitigationActionName"}, + "max":5, + "min":1 + }, + "MitigationActionParams":{ + "type":"structure", + "members":{ + "updateDeviceCertificateParams":{ + "shape":"UpdateDeviceCertificateParams", + "documentation":"

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

" + }, + "updateCACertificateParams":{ + "shape":"UpdateCACertificateParams", + "documentation":"

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" + }, + "addThingsToThingGroupParams":{ + "shape":"AddThingsToThingGroupParams", + "documentation":"

Parameters to define a mitigation action that moves devices associated with a certificate to one or more specified thing groups, typically for quarantine.

" + }, + "replaceDefaultPolicyVersionParams":{ + "shape":"ReplaceDefaultPolicyVersionParams", + "documentation":"

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" + }, + "enableIoTLoggingParams":{ + "shape":"EnableIoTLoggingParams", + "documentation":"

Parameters to define a mitigation action that enables AWS IoT logging at a specified level of detail.

" + }, + "publishFindingToSnsParams":{ + "shape":"PublishFindingToSnsParams", + "documentation":"

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

" + } + }, + "documentation":"

The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mitigation action).

" + }, + "MitigationActionType":{ + "type":"string", + "enum":[ + "UPDATE_DEVICE_CERTIFICATE", + "UPDATE_CA_CERTIFICATE", + "ADD_THINGS_TO_THING_GROUP", + "REPLACE_DEFAULT_POLICY_VERSION", + "ENABLE_IOT_LOGGING", + "PUBLISH_FINDING_TO_SNS" + ] + }, + "NextToken":{"type":"string"}, + "NonCompliantChecksCount":{"type":"integer"}, + "NonCompliantResource":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of the noncompliant resource.

" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Information that identifies the noncompliant resource.

" + }, + "additionalInfo":{ + "shape":"StringMap", + "documentation":"

Other information about the noncompliant resource.

" + } + }, + "documentation":"

Information about the resource that was noncompliant with the audit check.

" + }, + "NonCompliantResourcesCount":{"type":"long"}, + "NotConfiguredException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The resource is not configured.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NumberOfThings":{ + "type":"integer", + "min":1 + }, + "OTAUpdateArn":{"type":"string"}, + "OTAUpdateDescription":{ + "type":"string", + "max":2028, + "pattern":"[^\\p{C}]+" + }, + "OTAUpdateErrorMessage":{"type":"string"}, + "OTAUpdateFile":{ + "type":"structure", + "members":{ + "fileName":{ + "shape":"FileName", + "documentation":"

The name of the file.

" + }, + "fileVersion":{ + "shape":"OTAUpdateFileVersion", + "documentation":"

The file version.

" + }, + "fileLocation":{ + "shape":"FileLocation", + "documentation":"

The location of the updated firmware.

" + }, + "codeSigning":{ + "shape":"CodeSigning", + "documentation":"

The code signing method of the file.

" + }, + "attributes":{ + "shape":"AttributesMap", + "documentation":"

A list of name/attribute pairs.

" + } + }, + "documentation":"

Describes a file to be associated with an OTA update.

" + }, + "OTAUpdateFileVersion":{"type":"string"}, + "OTAUpdateFiles":{ + "type":"list", + "member":{"shape":"OTAUpdateFile"}, + "max":50, + "min":1 + }, + "OTAUpdateId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "OTAUpdateInfo":{ + "type":"structure", + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The OTA update ID.

" + }, + "otaUpdateArn":{ + "shape":"OTAUpdateArn", + "documentation":"

The OTA update ARN.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date when the OTA update was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The date when the OTA update was last updated.

" + }, + "description":{ + "shape":"OTAUpdateDescription", + "documentation":"

A description of the OTA update.

" + }, + "targets":{ + "shape":"Targets", + "documentation":"

The targets of the OTA update.

" + }, + "awsJobExecutionsRolloutConfig":{ + "shape":"AwsJobExecutionsRolloutConfig", + "documentation":"

Configuration for the rollout of OTA updates.

" + }, + "targetSelection":{ + "shape":"TargetSelection", + "documentation":"

Specifies whether the OTA update will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the OTA update (SNAPSHOT). If continuous, the OTA update may also be run on a thing when a change is detected in a target. For example, an OTA update will run on a thing when the thing is added to a target group, even after the OTA update was completed by all things originally in the group.

" + }, + "otaUpdateFiles":{ + "shape":"OTAUpdateFiles", + "documentation":"

A list of files associated with the OTA update.

" + }, + "otaUpdateStatus":{ + "shape":"OTAUpdateStatus", + "documentation":"

The status of the OTA update.

" + }, + "awsIotJobId":{ + "shape":"AwsIotJobId", + "documentation":"

The AWS IoT job ID associated with the OTA update.

" + }, + "awsIotJobArn":{ + "shape":"AwsIotJobArn", + "documentation":"

The AWS IoT job ARN associated with the OTA update.

" + }, + "errorInfo":{ + "shape":"ErrorInfo", + "documentation":"

Error information associated with the OTA update.

" + }, + "additionalParameters":{ + "shape":"AdditionalParameterMap", + "documentation":"

A collection of name/value pairs

" + } + }, + "documentation":"

Information about an OTA update.

" + }, + "OTAUpdateStatus":{ + "type":"string", + "enum":[ + "CREATE_PENDING", + "CREATE_IN_PROGRESS", + "CREATE_COMPLETE", + "CREATE_FAILED" + ] + }, + "OTAUpdateSummary":{ + "type":"structure", + "members":{ + "otaUpdateId":{ + "shape":"OTAUpdateId", + "documentation":"

The OTA update ID.

" + }, + "otaUpdateArn":{ + "shape":"OTAUpdateArn", + "documentation":"

The OTA update ARN.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The date when the OTA update was created.

" + } + }, + "documentation":"

An OTA update summary.

" + }, + "OTAUpdatesSummary":{ + "type":"list", + "member":{"shape":"OTAUpdateSummary"} + }, + "OptionalVersion":{"type":"long"}, + "OutgoingCertificate":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The certificate ARN.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The certificate ID.

" + }, + "transferredTo":{ + "shape":"AwsAccountId", + "documentation":"

The AWS account to which the transfer was made.

" + }, + "transferDate":{ + "shape":"DateType", + "documentation":"

The date the transfer was initiated.

" + }, + "transferMessage":{ + "shape":"Message", + "documentation":"

The transfer message.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The certificate creation date.

" + } + }, + "documentation":"

A certificate that has been transferred but not yet accepted.

" + }, + "OutgoingCertificates":{ + "type":"list", + "member":{"shape":"OutgoingCertificate"} + }, + "OverrideDynamicGroups":{"type":"boolean"}, + "PageSize":{ + "type":"integer", + "max":250, + "min":1 + }, + "Parameter":{"type":"string"}, + "Parameters":{ + "type":"map", + "key":{"shape":"Parameter"}, + "value":{"shape":"Value"} + }, + "PartitionKey":{"type":"string"}, + "PayloadField":{"type":"string"}, + "Percentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "Platform":{"type":"string"}, + "Policies":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "Policy":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

" + }, + "policyArn":{ + "shape":"PolicyArn", + "documentation":"

The policy ARN.

" + } + }, + "documentation":"

Describes an AWS IoT policy.

" + }, + "PolicyArn":{"type":"string"}, + "PolicyDocument":{"type":"string"}, + "PolicyDocuments":{ + "type":"list", + "member":{"shape":"PolicyDocument"} + }, + "PolicyName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]+" + }, + "PolicyNames":{ + "type":"list", + "member":{"shape":"PolicyName"} + }, + "PolicyTarget":{"type":"string"}, + "PolicyTargets":{ + "type":"list", + "member":{"shape":"PolicyTarget"} + }, + "PolicyTemplateName":{ + "type":"string", + "enum":["BLANK_POLICY"] + }, + "PolicyVersion":{ + "type":"structure", + "members":{ + "versionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

" + }, + "isDefaultVersion":{ + "shape":"IsDefaultVersion", + "documentation":"

Specifies whether the policy version is the default.

" + }, + "createDate":{ + "shape":"DateType", + "documentation":"

The date and time the policy was created.

" + } + }, + "documentation":"

Describes a policy version.

" + }, + "PolicyVersionId":{ + "type":"string", + "pattern":"[0-9]+" + }, + "PolicyVersionIdentifier":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy.

" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The ID of the version of the policy associated with the resource.

" + } + }, + "documentation":"

Information about the version of the policy associated with the resource.

" + }, + "PolicyVersions":{ + "type":"list", + "member":{"shape":"PolicyVersion"} + }, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "Ports":{ + "type":"list", + "member":{"shape":"Port"} + }, + "Prefix":{"type":"string"}, + "PresignedUrlConfig":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role that grants grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.

" + }, + "expiresInSec":{ + "shape":"ExpiresInSec", + "documentation":"

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.

" + } + }, + "documentation":"

Configuration for pre-signed S3 URLs.

" + }, + "Principal":{"type":"string"}, + "PrincipalArn":{"type":"string"}, + "PrincipalId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9]+" + }, + "Principals":{ + "type":"list", + "member":{"shape":"PrincipalArn"} + }, + "PrivateKey":{ + "type":"string", + "min":1, + "sensitive":true + }, + "ProcessingTargetName":{"type":"string"}, + "ProcessingTargetNameList":{ + "type":"list", + "member":{"shape":"ProcessingTargetName"} + }, + "PublicKey":{ + "type":"string", + "min":1 + }, + "PublicKeyMap":{ + "type":"map", + "key":{"shape":"KeyName"}, + "value":{"shape":"KeyValue"} + }, + "PublishFindingToSnsParams":{ + "type":"structure", + "required":["topicArn"], + "members":{ + "topicArn":{ + "shape":"SnsTopicArn", + "documentation":"

The ARN of the topic to which you want to publish the findings.

" + } + }, + "documentation":"

Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS messages.

" + }, + "PutItemInput":{ + "type":"structure", + "required":["tableName"], + "members":{ + "tableName":{ + "shape":"TableName", + "documentation":"

The table where the message data will be written.

" + } + }, + "documentation":"

The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.

" + }, + "Qos":{ + "type":"integer", + "max":1, + "min":0 + }, + "QueryMaxResults":{ + "type":"integer", + "max":500, + "min":1 + }, + "QueryString":{ + "type":"string", + "min":1 + }, + "QueryVersion":{"type":"string"}, + "QueueUrl":{"type":"string"}, + "QueuedThings":{"type":"integer"}, + "RangeKeyField":{"type":"string"}, + "RangeKeyValue":{"type":"string"}, + "RateIncreaseCriteria":{ + "type":"structure", + "members":{ + "numberOfNotifiedThings":{ + "shape":"NumberOfThings", + "documentation":"

The threshold for number of notified things that will initiate the increase in rate of rollout.

" + }, + "numberOfSucceededThings":{ + "shape":"NumberOfThings", + "documentation":"

The threshold for number of succeeded things that will initiate the increase in rate of rollout.

" + } + }, + "documentation":"

Allows you to define a criteria to initiate the increase in rate of rollout for a job.

" + }, + "ReasonCode":{ + "type":"string", + "max":128, + "pattern":"[\\p{Upper}\\p{Digit}_]+" + }, + "ReasonForNonCompliance":{"type":"string"}, + "ReasonForNonComplianceCode":{"type":"string"}, + "ReasonForNonComplianceCodes":{ + "type":"list", + "member":{"shape":"ReasonForNonComplianceCode"}, + "max":25, + "min":1 + }, + "Recursive":{"type":"boolean"}, + "RecursiveWithoutDefault":{"type":"boolean"}, + "RegisterCACertificateRequest":{ + "type":"structure", + "required":[ + "caCertificate", + "verificationCertificate" + ], + "members":{ + "caCertificate":{ + "shape":"CertificatePem", + "documentation":"

The CA certificate.

" + }, + "verificationCertificate":{ + "shape":"CertificatePem", + "documentation":"

The private key verification certificate.

" + }, + "setAsActive":{ + "shape":"SetAsActive", + "documentation":"

A boolean value that specifies if the CA certificate is set to active.

", + "location":"querystring", + "locationName":"setAsActive" + }, + "allowAutoRegistration":{ + "shape":"AllowAutoRegistration", + "documentation":"

Allows this CA certificate to be used for auto registration of device certificates.

", + "location":"querystring", + "locationName":"allowAutoRegistration" + }, + "registrationConfig":{ + "shape":"RegistrationConfig", + "documentation":"

Information about the registration configuration.

" + } + }, + "documentation":"

The input to the RegisterCACertificate operation.

" + }, + "RegisterCACertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The CA certificate ARN.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The CA certificate identifier.

" + } + }, + "documentation":"

The output from the RegisterCACertificateResponse operation.

" + }, + "RegisterCertificateRequest":{ + "type":"structure", + "required":["certificatePem"], + "members":{ + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

The certificate data, in PEM format.

" + }, + "caCertificatePem":{ + "shape":"CertificatePem", + "documentation":"

The CA certificate used to sign the device certificate being registered.

" + }, + "setAsActive":{ + "shape":"SetAsActiveFlag", + "documentation":"

A boolean value that specifies if the certificate is set to active.

", + "deprecated":true, + "location":"querystring", + "locationName":"setAsActive" + }, + "status":{ + "shape":"CertificateStatus", + "documentation":"

The status of the register certificate request.

" + } + }, + "documentation":"

The input to the RegisterCertificate operation.

" + }, + "RegisterCertificateResponse":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

The certificate ARN.

" + }, + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The certificate identifier.

" + } + }, + "documentation":"

The output from the RegisterCertificate operation.

" + }, + "RegisterThingRequest":{ + "type":"structure", + "required":["templateBody"], + "members":{ + "templateBody":{ + "shape":"TemplateBody", + "documentation":"

The provisioning template. See Programmatic Provisioning for more information.

" + }, + "parameters":{ + "shape":"Parameters", + "documentation":"

The parameters for provisioning a thing. See Programmatic Provisioning for more information.

" + } + } + }, + "RegisterThingResponse":{ + "type":"structure", + "members":{ + "certificatePem":{ + "shape":"CertificatePem", + "documentation":"

.

" + }, + "resourceArns":{ + "shape":"ResourceArns", + "documentation":"

ARNs for the generated resources.

" + } + } + }, + "RegistrationCode":{ + "type":"string", + "max":64, + "min":64, + "pattern":"(0x)?[a-fA-F0-9]+" + }, + "RegistrationCodeValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

Additional information about the exception.

" + } + }, + "documentation":"

The registration code is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "RegistrationConfig":{ + "type":"structure", + "members":{ + "templateBody":{ + "shape":"TemplateBody", + "documentation":"

The template body.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role.

" + } + }, + "documentation":"

The registration configuration.

" + }, + "RegistryMaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "RegistryS3BucketName":{ + "type":"string", + "max":256, + "min":3, + "pattern":"[a-zA-Z0-9._-]+" + }, + "RegistryS3KeyName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[a-zA-Z0-9!_.*'()-\\/]+" + }, + "RejectCertificateTransferRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + }, + "rejectReason":{ + "shape":"Message", + "documentation":"

The reason the certificate transfer was rejected.

" + } + }, + "documentation":"

The input for the RejectCertificateTransfer operation.

" + }, + "RejectedThings":{"type":"integer"}, + "RelatedResource":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource.

" + }, + "resourceIdentifier":{ + "shape":"ResourceIdentifier", + "documentation":"

Information that identifies the resource.

" + }, + "additionalInfo":{ + "shape":"StringMap", + "documentation":"

Other information about the resource.

" + } + }, + "documentation":"

Information about a related resource.

" + }, + "RelatedResources":{ + "type":"list", + "member":{"shape":"RelatedResource"} + }, + "RemoveAutoRegistration":{"type":"boolean"}, + "RemoveThingFromBillingGroupRequest":{ + "type":"structure", + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

" + }, + "billingGroupArn":{ + "shape":"BillingGroupArn", + "documentation":"

The ARN of the billing group.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to be removed from the billing group.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing to be removed from the billing group.

" + } + } + }, + "RemoveThingFromBillingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "RemoveThingFromThingGroupRequest":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The group name.

" + }, + "thingGroupArn":{ + "shape":"ThingGroupArn", + "documentation":"

The group ARN.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to remove from the group.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing to remove from the group.

" + } + } + }, + "RemoveThingFromThingGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "RemoveThingType":{"type":"boolean"}, + "RemovedThings":{"type":"integer"}, + "ReplaceDefaultPolicyVersionParams":{ + "type":"structure", + "required":["templateName"], + "members":{ + "templateName":{ + "shape":"PolicyTemplateName", + "documentation":"

The name of the template to be applied. The only supported value is BLANK_POLICY.

" + } + }, + "documentation":"

Parameters to define a mitigation action that adds a blank policy to restrict permissions.

" + }, + "ReplaceTopicRuleRequest":{ + "type":"structure", + "required":[ + "ruleName", + "topicRulePayload" + ], + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

", + "location":"uri", + "locationName":"ruleName" + }, + "topicRulePayload":{ + "shape":"TopicRulePayload", + "documentation":"

The rule payload.

" + } + }, + "documentation":"

The input for the ReplaceTopicRule operation.

", + "payload":"topicRulePayload" + }, + "ReportType":{ + "type":"string", + "enum":[ + "ERRORS", + "RESULTS" + ] + }, + "RepublishAction":{ + "type":"structure", + "required":[ + "roleArn", + "topic" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "topic":{ + "shape":"TopicPattern", + "documentation":"

The name of the MQTT topic.

" + }, + "qos":{ + "shape":"Qos", + "documentation":"

The Quality of Service (QoS) level to use when republishing messages.

" + } + }, + "documentation":"

Describes an action to republish to another topic.

" + }, + "Resource":{"type":"string"}, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + }, + "resourceId":{ + "shape":"resourceId", + "documentation":"

The ID of the resource that caused the exception.

" + }, + "resourceArn":{ + "shape":"resourceArn", + "documentation":"

The ARN of the resource that caused the exception.

" + } + }, + "documentation":"

The resource already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceArn":{"type":"string"}, + "ResourceArns":{ + "type":"map", + "key":{"shape":"ResourceLogicalId"}, + "value":{"shape":"ResourceArn"} + }, + "ResourceIdentifier":{ + "type":"structure", + "members":{ + "deviceCertificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate attached to the resource.

" + }, + "caCertificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the CA certificate used to authorize the certificate.

" + }, + "cognitoIdentityPoolId":{ + "shape":"CognitoIdentityPoolId", + "documentation":"

The ID of the Amazon Cognito identity pool.

" + }, + "clientId":{ + "shape":"ClientId", + "documentation":"

The client ID.

" + }, + "policyVersionIdentifier":{ + "shape":"PolicyVersionIdentifier", + "documentation":"

The version of the policy associated with the resource.

" + }, + "account":{ + "shape":"AwsAccountId", + "documentation":"

The account with which the resource is associated.

" + } + }, + "documentation":"

Information that identifies the noncompliant resource.

" + }, + "ResourceLogicalId":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The specified resource does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceRegistrationFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The resource registration failed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "DEVICE_CERTIFICATE", + "CA_CERTIFICATE", + "IOT_POLICY", + "COGNITO_IDENTITY_POOL", + "CLIENT_ID", + "ACCOUNT_SETTINGS" + ] + }, + "Resources":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "RoleAlias":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w=,@-]+" + }, + "RoleAliasArn":{"type":"string"}, + "RoleAliasDescription":{ + "type":"structure", + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias.

" + }, + "roleAliasArn":{ + "shape":"RoleAliasArn", + "documentation":"

The ARN of the role alias.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The role ARN.

" + }, + "owner":{ + "shape":"AwsAccountId", + "documentation":"

The role alias owner.

" + }, + "credentialDurationSeconds":{ + "shape":"CredentialDurationSeconds", + "documentation":"

The number of seconds for which the credential is valid.

" + }, + "creationDate":{ + "shape":"DateType", + "documentation":"

The UNIX timestamp of when the role alias was created.

" + }, + "lastModifiedDate":{ + "shape":"DateType", + "documentation":"

The UNIX timestamp of when the role alias was last modified.

" + } + }, + "documentation":"

Role alias description.

" + }, + "RoleAliases":{ + "type":"list", + "member":{"shape":"RoleAlias"} + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "RolloutRatePerMinute":{ + "type":"integer", + "max":1000, + "min":1 + }, + "RuleArn":{"type":"string"}, + "RuleName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "S3Action":{ + "type":"structure", + "required":[ + "roleArn", + "bucketName", + "key" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "bucketName":{ + "shape":"BucketName", + "documentation":"

The Amazon S3 bucket.

" + }, + "key":{ + "shape":"Key", + "documentation":"

The object key.

" + }, + "cannedAcl":{ + "shape":"CannedAccessControlList", + "documentation":"

The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.

" + } + }, + "documentation":"

Describes an action to write data to an Amazon S3 bucket.

" + }, + "S3Bucket":{ + "type":"string", + "min":1 + }, + "S3Destination":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"S3Bucket", + "documentation":"

The S3 bucket that contains the updated firmware.

" + }, + "prefix":{ + "shape":"Prefix", + "documentation":"

The S3 prefix.

" + } + }, + "documentation":"

Describes the location of updated firmware in S3.

" + }, + "S3FileUrl":{ + "type":"string", + "max":65535 + }, + "S3FileUrlList":{ + "type":"list", + "member":{"shape":"S3FileUrl"} + }, + "S3Key":{ + "type":"string", + "min":1 + }, + "S3Location":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"S3Bucket", + "documentation":"

The S3 bucket.

" + }, + "key":{ + "shape":"S3Key", + "documentation":"

The S3 key.

" + }, + "version":{ + "shape":"S3Version", + "documentation":"

The S3 bucket version.

" + } + }, + "documentation":"

The S3 location.

" + }, + "S3Version":{"type":"string"}, + "SQL":{"type":"string"}, + "SalesforceAction":{ + "type":"structure", + "required":[ + "token", + "url" + ], + "members":{ + "token":{ + "shape":"SalesforceToken", + "documentation":"

The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

" + }, + "url":{ + "shape":"SalesforceEndpoint", + "documentation":"

The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.

" + } + }, + "documentation":"

Describes an action to write a message to a Salesforce IoT Cloud Input Stream.

" + }, + "SalesforceEndpoint":{ + "type":"string", + "max":2000, + "pattern":"https://ingestion-[a-zA-Z0-9]{1,12}\\.[a-zA-Z0-9]+\\.((sfdc-matrix\\.net)|(sfdcnow\\.com))/streams/\\w{1,20}/\\w{1,20}/event" + }, + "SalesforceToken":{ + "type":"string", + "min":40 + }, + "ScheduledAuditArn":{"type":"string"}, + "ScheduledAuditMetadata":{ + "type":"structure", + "members":{ + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit.

" + }, + "scheduledAuditArn":{ + "shape":"ScheduledAuditArn", + "documentation":"

The ARN of the scheduled audit.

" + }, + "frequency":{ + "shape":"AuditFrequency", + "documentation":"

How often the scheduled audit occurs.

" + }, + "dayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

The day of the month on which the scheduled audit is run (if the frequency is \"MONTHLY\"). If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.

" + }, + "dayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

The day of the week on which the scheduled audit is run (if the frequency is \"WEEKLY\" or \"BIWEEKLY\").

" + } + }, + "documentation":"

Information about the scheduled audit.

" + }, + "ScheduledAuditMetadataList":{ + "type":"list", + "member":{"shape":"ScheduledAuditMetadata"} + }, + "ScheduledAuditName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "SearchIndexRequest":{ + "type":"structure", + "required":["queryString"], + "members":{ + "indexName":{ + "shape":"IndexName", + "documentation":"

The search index name.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The search query string.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + }, + "maxResults":{ + "shape":"QueryMaxResults", + "documentation":"

The maximum number of results to return at one time.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The query version.

" + } + } + }, + "SearchIndexResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to get the next set of results, or null if there are no additional results.

" + }, + "things":{ + "shape":"ThingDocumentList", + "documentation":"

The things that match the search query.

" + }, + "thingGroups":{ + "shape":"ThingGroupDocumentList", + "documentation":"

The thing groups that match the search query.

" + } + } + }, + "SearchableAttributes":{ + "type":"list", + "member":{"shape":"AttributeName"} + }, + "Seconds":{"type":"integer"}, + "SecurityProfileArn":{"type":"string"}, + "SecurityProfileDescription":{ + "type":"string", + "max":1000, + "pattern":"[\\p{Graph}\\x20]*" + }, + "SecurityProfileIdentifier":{ + "type":"structure", + "required":[ + "name", + "arn" + ], + "members":{ + "name":{ + "shape":"SecurityProfileName", + "documentation":"

The name you have given to the security profile.

" + }, + "arn":{ + "shape":"SecurityProfileArn", + "documentation":"

The ARN of the security profile.

" + } + }, + "documentation":"

Identifying information for a Device Defender security profile.

" + }, + "SecurityProfileIdentifiers":{ + "type":"list", + "member":{"shape":"SecurityProfileIdentifier"} + }, + "SecurityProfileName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "SecurityProfileTarget":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"SecurityProfileTargetArn", + "documentation":"

The ARN of the security profile.

" + } + }, + "documentation":"

A target to which an alert is sent when a security profile behavior is violated.

" + }, + "SecurityProfileTargetArn":{"type":"string"}, + "SecurityProfileTargetMapping":{ + "type":"structure", + "members":{ + "securityProfileIdentifier":{ + "shape":"SecurityProfileIdentifier", + "documentation":"

Information that identifies the security profile.

" + }, + "target":{ + "shape":"SecurityProfileTarget", + "documentation":"

Information about the target (thing group) associated with the security profile.

" + } + }, + "documentation":"

Information about a security profile and the target associated with it.

" + }, + "SecurityProfileTargetMappings":{ + "type":"list", + "member":{"shape":"SecurityProfileTargetMapping"} + }, + "SecurityProfileTargets":{ + "type":"list", + "member":{"shape":"SecurityProfileTarget"} + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The service is temporarily unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SetAsActive":{"type":"boolean"}, + "SetAsActiveFlag":{"type":"boolean"}, + "SetAsDefault":{"type":"boolean"}, + "SetDefaultAuthorizerRequest":{ + "type":"structure", + "required":["authorizerName"], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

" + } + } + }, + "SetDefaultAuthorizerResponse":{ + "type":"structure", + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

" + }, + "authorizerArn":{ + "shape":"AuthorizerArn", + "documentation":"

The authorizer ARN.

" + } + } + }, + "SetDefaultPolicyVersionRequest":{ + "type":"structure", + "required":[ + "policyName", + "policyVersionId" + ], + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The policy name.

", + "location":"uri", + "locationName":"policyName" + }, + "policyVersionId":{ + "shape":"PolicyVersionId", + "documentation":"

The policy version ID.

", + "location":"uri", + "locationName":"policyVersionId" + } + }, + "documentation":"

The input for the SetDefaultPolicyVersion operation.

" + }, + "SetLoggingOptionsRequest":{ + "type":"structure", + "required":["loggingOptionsPayload"], + "members":{ + "loggingOptionsPayload":{ + "shape":"LoggingOptionsPayload", + "documentation":"

The logging options payload.

" + } + }, + "documentation":"

The input for the SetLoggingOptions operation.

", + "payload":"loggingOptionsPayload" + }, + "SetV2LoggingLevelRequest":{ + "type":"structure", + "required":[ + "logTarget", + "logLevel" + ], + "members":{ + "logTarget":{ + "shape":"LogTarget", + "documentation":"

The log target.

" + }, + "logLevel":{ + "shape":"LogLevel", + "documentation":"

The log level.

" + } + } + }, + "SetV2LoggingOptionsRequest":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the role that allows IoT to write to Cloudwatch logs.

" + }, + "defaultLogLevel":{ + "shape":"LogLevel", + "documentation":"

The default logging level.

" + }, + "disableAllLogs":{ + "shape":"DisableAllLogs", + "documentation":"

If true all logs are disabled. The default is false.

" + } + } + }, + "Signature":{"type":"blob"}, + "SignatureAlgorithm":{"type":"string"}, + "SigningJobId":{"type":"string"}, + "SigningProfileName":{"type":"string"}, + "SigningProfileParameter":{ + "type":"structure", + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

Certificate ARN.

" + }, + "platform":{ + "shape":"Platform", + "documentation":"

The hardware platform of your device.

" + }, + "certificatePathOnDevice":{ + "shape":"CertificatePathOnDevice", + "documentation":"

The location of the code-signing certificate on your device.

" + } + }, + "documentation":"

Describes the code-signing profile.

" + }, + "SkippedFindingsCount":{"type":"long"}, + "SkyfallMaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "SnsAction":{ + "type":"structure", + "required":[ + "targetArn", + "roleArn" + ], + "members":{ + "targetArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the SNS topic.

" + }, + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "messageFormat":{ + "shape":"MessageFormat", + "documentation":"

(Optional) The message format of the message to publish. Accepted values are \"JSON\" and \"RAW\". The default value of the attribute is \"RAW\". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.

" + } + }, + "documentation":"

Describes an action to publish to an Amazon SNS topic.

" + }, + "SnsTopicArn":{ + "type":"string", + "max":350 + }, + "SqlParseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The Rule-SQL expression can't be parsed correctly.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SqsAction":{ + "type":"structure", + "required":[ + "roleArn", + "queueUrl" + ], + "members":{ + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the IAM role that grants access.

" + }, + "queueUrl":{ + "shape":"QueueUrl", + "documentation":"

The URL of the Amazon SQS queue.

" + }, + "useBase64":{ + "shape":"UseBase64", + "documentation":"

Specifies whether to use Base64 encoding.

" + } + }, + "documentation":"

Describes an action to publish data to an Amazon SQS queue.

" + }, + "StartAuditMitigationActionsTaskRequest":{ + "type":"structure", + "required":[ + "taskId", + "target", + "auditCheckToActionsMapping", + "clientRequestToken" + ], + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

A unique identifier for the task. You can use this identifier to check the status of the task or to cancel it.

", + "location":"uri", + "locationName":"taskId" + }, + "target":{ + "shape":"AuditMitigationActionsTaskTarget", + "documentation":"

Specifies the audit findings to which the mitigation actions are applied. You can apply them to a type of audit check, to all findings from an audit, or to a speecific set of findings.

" + }, + "auditCheckToActionsMapping":{ + "shape":"AuditCheckToActionsMapping", + "documentation":"

For an audit check, specifies which mitigation actions to apply. Those actions must be defined in your AWS account.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

Each audit mitigation task must have a unique client request token. If you try to start a new task with the same token as a task that already exists, an exception occurs. If you omit this value, a unique client request token is generated automatically.

", + "idempotencyToken":true + } + } + }, + "StartAuditMitigationActionsTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditMitigationActionsTaskId", + "documentation":"

The unique identifier for the audit mitigation task. This matches the taskId that you specified in the request.

" + } + } + }, + "StartOnDemandAuditTaskRequest":{ + "type":"structure", + "required":["targetCheckNames"], + "members":{ + "targetCheckNames":{ + "shape":"TargetAuditCheckNames", + "documentation":"

Which checks are performed during the audit. The checks you specify must be enabled for your account or an exception occurs. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or UpdateAccountAuditConfiguration to select which checks are enabled.

" + } + } + }, + "StartOnDemandAuditTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"AuditTaskId", + "documentation":"

The ID of the on-demand audit you started.

" + } + } + }, + "StartSigningJobParameter":{ + "type":"structure", + "members":{ + "signingProfileParameter":{ + "shape":"SigningProfileParameter", + "documentation":"

Describes the code-signing profile.

" + }, + "signingProfileName":{ + "shape":"SigningProfileName", + "documentation":"

The code-signing profile name.

" + }, + "destination":{ + "shape":"Destination", + "documentation":"

The location to write the code-signed file.

" + } + }, + "documentation":"

Information required to start a signing job.

" + }, + "StartThingRegistrationTaskRequest":{ + "type":"structure", + "required":[ + "templateBody", + "inputFileBucket", + "inputFileKey", + "roleArn" + ], + "members":{ + "templateBody":{ + "shape":"TemplateBody", + "documentation":"

The provisioning template.

" + }, + "inputFileBucket":{ + "shape":"RegistryS3BucketName", + "documentation":"

The S3 bucket that contains the input file.

" + }, + "inputFileKey":{ + "shape":"RegistryS3KeyName", + "documentation":"

The name of input file within the S3 bucket. This file contains a newline delimited JSON file. Each line contains the parameter values to provision one device (thing).

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The IAM role ARN that grants permission the input file.

" + } + } + }, + "StartThingRegistrationTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"

The bulk thing provisioning task ID.

" + } + } + }, + "StateMachineName":{"type":"string"}, + "StateReason":{"type":"string"}, + "StateValue":{"type":"string"}, + "StatisticalThreshold":{ + "type":"structure", + "members":{ + "statistic":{ + "shape":"EvaluationStatistic", + "documentation":"

The percentile which resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period (durationSeconds) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below (comparisonOperator) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.

" + } + }, + "documentation":"

A statistical ranking (percentile) which indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.

" + }, + "Statistics":{ + "type":"structure", + "members":{ + "count":{ + "shape":"Count", + "documentation":"

The count of things that match the query.

" + } + }, + "documentation":"

A map of key-value pairs for all supported statistics. Currently, only count is supported.

" + }, + "Status":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Failed", + "Cancelled", + "Cancelling" + ] + }, + "StepFunctionsAction":{ + "type":"structure", + "required":[ + "stateMachineName", + "roleArn" + ], + "members":{ + "executionNamePrefix":{ + "shape":"ExecutionNamePrefix", + "documentation":"

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.

" + }, + "stateMachineName":{ + "shape":"StateMachineName", + "documentation":"

The name of the Step Functions state machine whose execution will be started.

" + }, + "roleArn":{ + "shape":"AwsArn", + "documentation":"

The ARN of the role that grants IoT permission to start execution of a state machine (\"Action\":\"states:StartExecution\").

" + } + }, + "documentation":"

Starts execution of a Step Functions state machine.

" + }, + "StopThingRegistrationTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"TaskId", + "documentation":"

The bulk thing provisioning task ID.

", + "location":"uri", + "locationName":"taskId" + } + } + }, + "StopThingRegistrationTaskResponse":{ + "type":"structure", + "members":{ + } + }, + "Stream":{ + "type":"structure", + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

" + }, + "fileId":{ + "shape":"FileId", + "documentation":"

The ID of a file associated with a stream.

" + } + }, + "documentation":"

Describes a group of files that can be streamed.

" + }, + "StreamArn":{"type":"string"}, + "StreamDescription":{ + "type":"string", + "max":2028, + "pattern":"[^\\p{C}]+" + }, + "StreamFile":{ + "type":"structure", + "members":{ + "fileId":{ + "shape":"FileId", + "documentation":"

The file ID.

" + }, + "s3Location":{ + "shape":"S3Location", + "documentation":"

The location of the file in S3.

" + } + }, + "documentation":"

Represents a file to stream.

" + }, + "StreamFiles":{ + "type":"list", + "member":{"shape":"StreamFile"}, + "max":50, + "min":1 + }, + "StreamId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "StreamInfo":{ + "type":"structure", + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

" + }, + "streamArn":{ + "shape":"StreamArn", + "documentation":"

The stream ARN.

" + }, + "streamVersion":{ + "shape":"StreamVersion", + "documentation":"

The stream version.

" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

The description of the stream.

" + }, + "files":{ + "shape":"StreamFiles", + "documentation":"

The files to stream.

" + }, + "createdAt":{ + "shape":"DateType", + "documentation":"

The date when the stream was created.

" + }, + "lastUpdatedAt":{ + "shape":"DateType", + "documentation":"

The date when the stream was last updated.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

An IAM role AWS IoT assumes to access your S3 files.

" + } + }, + "documentation":"

Information about a stream.

" + }, + "StreamName":{"type":"string"}, + "StreamSummary":{ + "type":"structure", + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

" + }, + "streamArn":{ + "shape":"StreamArn", + "documentation":"

The stream ARN.

" + }, + "streamVersion":{ + "shape":"StreamVersion", + "documentation":"

The stream version.

" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

A description of the stream.

" + } + }, + "documentation":"

A summary of a stream.

" + }, + "StreamVersion":{ + "type":"integer", + "max":65535, + "min":0 + }, + "StreamsSummary":{ + "type":"list", + "member":{"shape":"StreamSummary"} + }, + "String":{"type":"string"}, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "SucceededFindingsCount":{"type":"long"}, + "SucceededThings":{"type":"integer"}, + "TableName":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The tag's key.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

A set of key/value pairs that are used to manage the resource.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The new or modified tags for the resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "Target":{"type":"string"}, + "TargetArn":{"type":"string"}, + "TargetAuditCheckNames":{ + "type":"list", + "member":{"shape":"AuditCheckName"} + }, + "TargetSelection":{ + "type":"string", + "enum":[ + "CONTINUOUS", + "SNAPSHOT" + ] + }, + "Targets":{ + "type":"list", + "member":{"shape":"Target"}, + "min":1 + }, + "TaskAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

This exception occurs if you attempt to start a task with the same task-id as an existing task but with a different clientRequestToken.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TaskId":{ + "type":"string", + "max":40 + }, + "TaskIdList":{ + "type":"list", + "member":{"shape":"TaskId"} + }, + "TaskStatistics":{ + "type":"structure", + "members":{ + "totalChecks":{ + "shape":"TotalChecksCount", + "documentation":"

The number of checks in this audit.

" + }, + "inProgressChecks":{ + "shape":"InProgressChecksCount", + "documentation":"

The number of checks in progress.

" + }, + "waitingForDataCollectionChecks":{ + "shape":"WaitingForDataCollectionChecksCount", + "documentation":"

The number of checks waiting for data collection.

" + }, + "compliantChecks":{ + "shape":"CompliantChecksCount", + "documentation":"

The number of checks that found compliant resources.

" + }, + "nonCompliantChecks":{ + "shape":"NonCompliantChecksCount", + "documentation":"

The number of checks that found noncompliant resources.

" + }, + "failedChecks":{ + "shape":"FailedChecksCount", + "documentation":"

The number of checks.

" + }, + "canceledChecks":{ + "shape":"CanceledChecksCount", + "documentation":"

The number of checks that did not run because the audit was canceled.

" + } + }, + "documentation":"

Statistics for the checks performed during the audit.

" + }, + "TaskStatisticsForAuditCheck":{ + "type":"structure", + "members":{ + "totalFindingsCount":{ + "shape":"TotalFindingsCount", + "documentation":"

The total number of findings to which a task is being applied.

" + }, + "failedFindingsCount":{ + "shape":"FailedFindingsCount", + "documentation":"

The number of findings for which at least one of the actions failed when applied.

" + }, + "succeededFindingsCount":{ + "shape":"SucceededFindingsCount", + "documentation":"

The number of findings for which all mitigation actions succeeded when applied.

" + }, + "skippedFindingsCount":{ + "shape":"SkippedFindingsCount", + "documentation":"

The number of findings skipped because of filter conditions provided in the parameters to the command.

" + }, + "canceledFindingsCount":{ + "shape":"CanceledFindingsCount", + "documentation":"

The number of findings to which the mitigation action task was canceled when applied.

" + } + }, + "documentation":"

Provides summary counts of how many tasks for findings are in a particular state. This information is included in the response from DescribeAuditMitigationActionsTask.

" + }, + "TemplateBody":{"type":"string"}, + "TestAuthorizationRequest":{ + "type":"structure", + "required":["authInfos"], + "members":{ + "principal":{ + "shape":"Principal", + "documentation":"

The principal.

" + }, + "cognitoIdentityPoolId":{ + "shape":"CognitoIdentityPoolId", + "documentation":"

The Cognito identity pool ID.

" + }, + "authInfos":{ + "shape":"AuthInfos", + "documentation":"

A list of authorization info objects. Simulating authorization will create a response for each authInfo object in the list.

" + }, + "clientId":{ + "shape":"ClientId", + "documentation":"

The MQTT client ID.

", + "location":"querystring", + "locationName":"clientId" + }, + "policyNamesToAdd":{ + "shape":"PolicyNames", + "documentation":"

When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.

" + }, + "policyNamesToSkip":{ + "shape":"PolicyNames", + "documentation":"

When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.

" + } + } + }, + "TestAuthorizationResponse":{ + "type":"structure", + "members":{ + "authResults":{ + "shape":"AuthResults", + "documentation":"

The authentication results.

" + } + } + }, + "TestInvokeAuthorizerRequest":{ + "type":"structure", + "required":[ + "authorizerName", + "token", + "tokenSignature" + ], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The custom authorizer name.

", + "location":"uri", + "locationName":"authorizerName" + }, + "token":{ + "shape":"Token", + "documentation":"

The token returned by your custom authentication service.

" + }, + "tokenSignature":{ + "shape":"TokenSignature", + "documentation":"

The signature made with the token and your custom authentication service's private key.

" + } + } + }, + "TestInvokeAuthorizerResponse":{ + "type":"structure", + "members":{ + "isAuthenticated":{ + "shape":"IsAuthenticated", + "documentation":"

True if the token is authenticated, otherwise false.

" + }, + "principalId":{ + "shape":"PrincipalId", + "documentation":"

The principal ID.

" + }, + "policyDocuments":{ + "shape":"PolicyDocuments", + "documentation":"

IAM policy documents.

" + }, + "refreshAfterInSeconds":{ + "shape":"Seconds", + "documentation":"

The number of seconds after which the temporary credentials are refreshed.

" + }, + "disconnectAfterInSeconds":{ + "shape":"Seconds", + "documentation":"

The number of seconds after which the connection is terminated.

" + } + } + }, + "ThingArn":{"type":"string"}, + "ThingAttribute":{ + "type":"structure", + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type, if the thing has been associated with a type.

" + }, + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The thing ARN.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

A list of thing attributes which are name-value pairs.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the thing record in the registry.

" + } + }, + "documentation":"

The properties of the thing, including thing name, thing type name, and a list of thing attributes.

" + }, + "ThingAttributeList":{ + "type":"list", + "member":{"shape":"ThingAttribute"} + }, + "ThingConnectivity":{ + "type":"structure", + "members":{ + "connected":{ + "shape":"Boolean", + "documentation":"

True if the thing is connected to the AWS IoT service; false if it is not connected.

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

The epoch time (in milliseconds) when the thing last connected or disconnected. If the thing has been disconnected for more than a few weeks, the time value might be missing.

" + } + }, + "documentation":"

The connectivity status of the thing.

" + }, + "ThingConnectivityIndexingMode":{ + "type":"string", + "enum":[ + "OFF", + "STATUS" + ] + }, + "ThingDocument":{ + "type":"structure", + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing name.

" + }, + "thingId":{ + "shape":"ThingId", + "documentation":"

The thing ID.

" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The thing type name.

" + }, + "thingGroupNames":{ + "shape":"ThingGroupNameList", + "documentation":"

Thing group names.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes.

" + }, + "shadow":{ + "shape":"JsonDocument", + "documentation":"

The shadow.

" + }, + "connectivity":{ + "shape":"ThingConnectivity", + "documentation":"

Indicates whether the thing is connected to the AWS IoT service.

" + } + }, + "documentation":"

The thing search index document.

" + }, + "ThingDocumentList":{ + "type":"list", + "member":{"shape":"ThingDocument"} + }, + "ThingGroupArn":{"type":"string"}, + "ThingGroupDescription":{ + "type":"string", + "max":2028, + "pattern":"[\\p{Graph}\\x20]*" + }, + "ThingGroupDocument":{ + "type":"structure", + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The thing group name.

" + }, + "thingGroupId":{ + "shape":"ThingGroupId", + "documentation":"

The thing group ID.

" + }, + "thingGroupDescription":{ + "shape":"ThingGroupDescription", + "documentation":"

The thing group description.

" + }, + "attributes":{ + "shape":"Attributes", + "documentation":"

The thing group attributes.

" + }, + "parentGroupNames":{ + "shape":"ThingGroupNameList", + "documentation":"

Parent group names.

" + } + }, + "documentation":"

The thing group search index document.

" + }, + "ThingGroupDocumentList":{ + "type":"list", + "member":{"shape":"ThingGroupDocument"} + }, + "ThingGroupId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9\\-]+" + }, + "ThingGroupIndexingConfiguration":{ + "type":"structure", + "required":["thingGroupIndexingMode"], + "members":{ + "thingGroupIndexingMode":{ + "shape":"ThingGroupIndexingMode", + "documentation":"

Thing group indexing mode.

" + } + }, + "documentation":"

Thing group indexing configuration.

" + }, + "ThingGroupIndexingMode":{ + "type":"string", + "enum":[ + "OFF", + "ON" + ] + }, + "ThingGroupList":{ + "type":"list", + "member":{"shape":"ThingGroupName"} + }, + "ThingGroupMetadata":{ + "type":"structure", + "members":{ + "parentGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The parent thing group name.

" + }, + "rootToParentThingGroups":{ + "shape":"ThingGroupNameAndArnList", + "documentation":"

The root parent thing group.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The UNIX timestamp of when the thing group was created.

" + } + }, + "documentation":"

Thing group metadata.

" + }, + "ThingGroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "ThingGroupNameAndArnList":{ + "type":"list", + "member":{"shape":"GroupNameAndArn"} + }, + "ThingGroupNameList":{ + "type":"list", + "member":{"shape":"ThingGroupName"} + }, + "ThingGroupNames":{ + "type":"list", + "member":{"shape":"ThingGroupName"}, + "max":10, + "min":1 + }, + "ThingGroupProperties":{ + "type":"structure", + "members":{ + "thingGroupDescription":{ + "shape":"ThingGroupDescription", + "documentation":"

The thing group description.

" + }, + "attributePayload":{ + "shape":"AttributePayload", + "documentation":"

The thing group attributes in JSON format.

" + } + }, + "documentation":"

Thing group properties.

" + }, + "ThingId":{"type":"string"}, + "ThingIndexingConfiguration":{ + "type":"structure", + "required":["thingIndexingMode"], + "members":{ + "thingIndexingMode":{ + "shape":"ThingIndexingMode", + "documentation":"

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index contains registry data only.

  • REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.

  • OFF - Thing indexing is disabled.

" + }, + "thingConnectivityIndexingMode":{ + "shape":"ThingConnectivityIndexingMode", + "documentation":"

Thing connectivity indexing mode. Valid values are:

  • STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.

  • OFF - Thing connectivity status indexing is disabled.

" + } + }, + "documentation":"

The thing indexing configuration. For more information, see Managing Thing Indexing.

" + }, + "ThingIndexingMode":{ + "type":"string", + "enum":[ + "OFF", + "REGISTRY", + "REGISTRY_AND_SHADOW" + ] + }, + "ThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "ThingNameList":{ + "type":"list", + "member":{"shape":"ThingName"} + }, + "ThingTypeArn":{"type":"string"}, + "ThingTypeDefinition":{ + "type":"structure", + "members":{ + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

" + }, + "thingTypeArn":{ + "shape":"ThingTypeArn", + "documentation":"

The thing type ARN.

" + }, + "thingTypeProperties":{ + "shape":"ThingTypeProperties", + "documentation":"

The ThingTypeProperties for the thing type.

" + }, + "thingTypeMetadata":{ + "shape":"ThingTypeMetadata", + "documentation":"

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when it was deprecated.

" + } + }, + "documentation":"

The definition of the thing type, including thing type name and description.

" + }, + "ThingTypeDescription":{ + "type":"string", + "max":2028, + "pattern":"[\\p{Graph}\\x20]*" + }, + "ThingTypeId":{"type":"string"}, + "ThingTypeList":{ + "type":"list", + "member":{"shape":"ThingTypeDefinition"} + }, + "ThingTypeMetadata":{ + "type":"structure", + "members":{ + "deprecated":{ + "shape":"Boolean", + "documentation":"

Whether the thing type is deprecated. If true, no new things could be associated with this type.

" + }, + "deprecationDate":{ + "shape":"DeprecationDate", + "documentation":"

The date and time when the thing type was deprecated.

" + }, + "creationDate":{ + "shape":"CreationDate", + "documentation":"

The date and time when the thing type was created.

" + } + }, + "documentation":"

The ThingTypeMetadata contains additional information about the thing type including: creation date and time, a value indicating whether the thing type is deprecated, and a date and time when time was deprecated.

" + }, + "ThingTypeName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "ThingTypeProperties":{ + "type":"structure", + "members":{ + "thingTypeDescription":{ + "shape":"ThingTypeDescription", + "documentation":"

The description of the thing type.

" + }, + "searchableAttributes":{ + "shape":"SearchableAttributes", + "documentation":"

A list of searchable thing attribute names.

" + } + }, + "documentation":"

The ThingTypeProperties contains information about the thing type including: a thing type description, and a list of searchable thing attribute names.

" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The rate exceeds the limit.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimedOutThings":{"type":"integer"}, + "TimeoutConfig":{ + "type":"structure", + "members":{ + "inProgressTimeoutInMinutes":{ + "shape":"InProgressTimeoutInMinutes", + "documentation":"

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

" + } + }, + "documentation":"

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

" + }, + "Timestamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "max":6144, + "min":1 + }, + "TokenKeyName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_-]+" + }, + "TokenSignature":{ + "type":"string", + "max":2560, + "min":1, + "pattern":"[A-Za-z0-9+/]+={0,2}" + }, + "Topic":{"type":"string"}, + "TopicPattern":{"type":"string"}, + "TopicRule":{ + "type":"structure", + "members":{ + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "sql":{ + "shape":"SQL", + "documentation":"

The SQL statement used to query the topic. When using a SQL query with multiple lines, be sure to escape the newline characters.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the rule.

" + }, + "createdAt":{ + "shape":"CreatedAtDate", + "documentation":"

The date and time the rule was created.

" + }, + "actions":{ + "shape":"ActionList", + "documentation":"

The actions associated with the rule.

" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "documentation":"

Specifies whether the rule is disabled.

" + }, + "awsIotSqlVersion":{ + "shape":"AwsIotSqlVersion", + "documentation":"

The version of the SQL rules engine to use when evaluating the rule.

" + }, + "errorAction":{ + "shape":"Action", + "documentation":"

The action to perform when an error occurs.

" + } + }, + "documentation":"

Describes a rule.

" + }, + "TopicRuleList":{ + "type":"list", + "member":{"shape":"TopicRuleListItem"} + }, + "TopicRuleListItem":{ + "type":"structure", + "members":{ + "ruleArn":{ + "shape":"RuleArn", + "documentation":"

The rule ARN.

" + }, + "ruleName":{ + "shape":"RuleName", + "documentation":"

The name of the rule.

" + }, + "topicPattern":{ + "shape":"TopicPattern", + "documentation":"

The pattern for the topic names that apply.

" + }, + "createdAt":{ + "shape":"CreatedAtDate", + "documentation":"

The date and time the rule was created.

" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "documentation":"

Specifies whether the rule is disabled.

" + } + }, + "documentation":"

Describes a rule.

" + }, + "TopicRulePayload":{ + "type":"structure", + "required":[ + "sql", + "actions" + ], + "members":{ + "sql":{ + "shape":"SQL", + "documentation":"

The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the rule.

" + }, + "actions":{ + "shape":"ActionList", + "documentation":"

The actions associated with the rule.

" + }, + "ruleDisabled":{ + "shape":"IsDisabled", + "documentation":"

Specifies whether the rule is disabled.

" + }, + "awsIotSqlVersion":{ + "shape":"AwsIotSqlVersion", + "documentation":"

The version of the SQL rules engine to use when evaluating the rule.

" + }, + "errorAction":{ + "shape":"Action", + "documentation":"

The action to take when an error occurs.

" + } + }, + "documentation":"

Describes a rule.

" + }, + "TotalChecksCount":{"type":"integer"}, + "TotalFindingsCount":{"type":"long"}, + "TotalResourcesCount":{"type":"long"}, + "TransferAlreadyCompletedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

You can't revert the certificate transfer because the transfer is already complete.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "TransferCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "targetAwsAccount" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + }, + "targetAwsAccount":{ + "shape":"AwsAccountId", + "documentation":"

The AWS account.

", + "location":"querystring", + "locationName":"targetAwsAccount" + }, + "transferMessage":{ + "shape":"Message", + "documentation":"

The transfer message.

" + } + }, + "documentation":"

The input for the TransferCertificate operation.

" + }, + "TransferCertificateResponse":{ + "type":"structure", + "members":{ + "transferredCertificateArn":{ + "shape":"CertificateArn", + "documentation":"

The ARN of the certificate.

" + } + }, + "documentation":"

The output from the TransferCertificate operation.

" + }, + "TransferConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

You can't transfer the certificate because authorization policies are still attached.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "TransferData":{ + "type":"structure", + "members":{ + "transferMessage":{ + "shape":"Message", + "documentation":"

The transfer message.

" + }, + "rejectReason":{ + "shape":"Message", + "documentation":"

The reason why the transfer was rejected.

" + }, + "transferDate":{ + "shape":"DateType", + "documentation":"

The date the transfer took place.

" + }, + "acceptDate":{ + "shape":"DateType", + "documentation":"

The date the transfer was accepted.

" + }, + "rejectDate":{ + "shape":"DateType", + "documentation":"

The date the transfer was rejected.

" + } + }, + "documentation":"

Data used to transfer a certificate to an AWS account.

" + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

You are not authorized to perform this operation.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UndoDeprecate":{"type":"boolean"}, + "UnsignedLong":{ + "type":"long", + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of the keys of the tags to be removed from the resource.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAccountAuditConfigurationRequest":{ + "type":"structure", + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that grants permission to AWS IoT to access information about your devices, policies, certificates and other items as required when performing an audit.

" + }, + "auditNotificationTargetConfigurations":{ + "shape":"AuditNotificationTargetConfigurations", + "documentation":"

Information about the targets to which audit notifications are sent.

" + }, + "auditCheckConfigurations":{ + "shape":"AuditCheckConfigurations", + "documentation":"

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it is used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

" + } + } + }, + "UpdateAccountAuditConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateAuthorizerRequest":{ + "type":"structure", + "required":["authorizerName"], + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

", + "location":"uri", + "locationName":"authorizerName" + }, + "authorizerFunctionArn":{ + "shape":"AuthorizerFunctionArn", + "documentation":"

The ARN of the authorizer's Lambda function.

" + }, + "tokenKeyName":{ + "shape":"TokenKeyName", + "documentation":"

The key used to extract the token from the HTTP headers.

" + }, + "tokenSigningPublicKeys":{ + "shape":"PublicKeyMap", + "documentation":"

The public keys used to verify the token signature.

" + }, + "status":{ + "shape":"AuthorizerStatus", + "documentation":"

The status of the update authorizer request.

" + } + } + }, + "UpdateAuthorizerResponse":{ + "type":"structure", + "members":{ + "authorizerName":{ + "shape":"AuthorizerName", + "documentation":"

The authorizer name.

" + }, + "authorizerArn":{ + "shape":"AuthorizerArn", + "documentation":"

The authorizer ARN.

" + } + } + }, + "UpdateBillingGroupRequest":{ + "type":"structure", + "required":[ + "billingGroupName", + "billingGroupProperties" + ], + "members":{ + "billingGroupName":{ + "shape":"BillingGroupName", + "documentation":"

The name of the billing group.

", + "location":"uri", + "locationName":"billingGroupName" + }, + "billingGroupProperties":{ + "shape":"BillingGroupProperties", + "documentation":"

The properties of the billing group.

" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the billing group. If the version of the billing group does not match the expected version specified in the request, the UpdateBillingGroup request is rejected with a VersionConflictException.

" + } + } + }, + "UpdateBillingGroupResponse":{ + "type":"structure", + "members":{ + "version":{ + "shape":"Version", + "documentation":"

The latest version of the billing group.

" + } + } + }, + "UpdateCACertificateParams":{ + "type":"structure", + "required":["action"], + "members":{ + "action":{ + "shape":"CACertificateUpdateAction", + "documentation":"

The action that you want to apply to the CA cerrtificate. The only supported value is DEACTIVATE.

" + } + }, + "documentation":"

Parameters to define a mitigation action that changes the state of the CA certificate to inactive.

" + }, + "UpdateCACertificateRequest":{ + "type":"structure", + "required":["certificateId"], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The CA certificate identifier.

", + "location":"uri", + "locationName":"caCertificateId" + }, + "newStatus":{ + "shape":"CACertificateStatus", + "documentation":"

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

", + "location":"querystring", + "locationName":"newStatus" + }, + "newAutoRegistrationStatus":{ + "shape":"AutoRegistrationStatus", + "documentation":"

The new value for the auto registration status. Valid values are: \"ENABLE\" or \"DISABLE\".

", + "location":"querystring", + "locationName":"newAutoRegistrationStatus" + }, + "registrationConfig":{ + "shape":"RegistrationConfig", + "documentation":"

Information about the registration configuration.

" + }, + "removeAutoRegistration":{ + "shape":"RemoveAutoRegistration", + "documentation":"

If true, removes auto registration.

" + } + }, + "documentation":"

The input to the UpdateCACertificate operation.

" + }, + "UpdateCertificateRequest":{ + "type":"structure", + "required":[ + "certificateId", + "newStatus" + ], + "members":{ + "certificateId":{ + "shape":"CertificateId", + "documentation":"

The ID of the certificate. (The last part of the certificate ARN contains the certificate ID.)

", + "location":"uri", + "locationName":"certificateId" + }, + "newStatus":{ + "shape":"CertificateStatus", + "documentation":"

The new status.

Note: Setting the status to PENDING_TRANSFER will result in an exception being thrown. PENDING_TRANSFER is a status used internally by AWS IoT. It is not intended for developer use.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

", + "location":"querystring", + "locationName":"newStatus" + } + }, + "documentation":"

The input for the UpdateCertificate operation.

" + }, + "UpdateDeviceCertificateParams":{ + "type":"structure", + "required":["action"], + "members":{ + "action":{ + "shape":"DeviceCertificateUpdateAction", + "documentation":"

The action that you want to apply to the device cerrtificate. The only supported value is DEACTIVATE.

" + } + }, + "documentation":"

Parameters to define a mitigation action that changes the state of the device certificate to inactive.

" + }, + "UpdateDynamicThingGroupRequest":{ + "type":"structure", + "required":[ + "thingGroupName", + "thingGroupProperties" + ], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The name of the dynamic thing group to update.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "thingGroupProperties":{ + "shape":"ThingGroupProperties", + "documentation":"

The dynamic thing group properties to update.

" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the dynamic thing group to update.

" + }, + "indexName":{ + "shape":"IndexName", + "documentation":"

The dynamic thing group index to update.

Currently one index is supported: 'AWS_Things'.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The dynamic thing group search query string to update.

" + }, + "queryVersion":{ + "shape":"QueryVersion", + "documentation":"

The dynamic thing group query version to update.

Currently one query version is supported: \"2017-09-30\". If not specified, the query version defaults to this value.

" + } + } + }, + "UpdateDynamicThingGroupResponse":{ + "type":"structure", + "members":{ + "version":{ + "shape":"Version", + "documentation":"

The dynamic thing group version.

" + } + } + }, + "UpdateEventConfigurationsRequest":{ + "type":"structure", + "members":{ + "eventConfigurations":{ + "shape":"EventConfigurations", + "documentation":"

The new event configuration values.

" + } + } + }, + "UpdateEventConfigurationsResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateIndexingConfigurationRequest":{ + "type":"structure", + "members":{ + "thingIndexingConfiguration":{ + "shape":"ThingIndexingConfiguration", + "documentation":"

Thing indexing configuration.

" + }, + "thingGroupIndexingConfiguration":{ + "shape":"ThingGroupIndexingConfiguration", + "documentation":"

Thing group indexing configuration.

" + } + } + }, + "UpdateIndexingConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

The ID of the job to be updated.

", + "location":"uri", + "locationName":"jobId" + }, + "description":{ + "shape":"JobDescription", + "documentation":"

A short text description of the job.

" + }, + "presignedUrlConfig":{ + "shape":"PresignedUrlConfig", + "documentation":"

Configuration information for pre-signed S3 URLs.

" + }, + "jobExecutionsRolloutConfig":{ + "shape":"JobExecutionsRolloutConfig", + "documentation":"

Allows you to create a staged rollout of the job.

" + }, + "abortConfig":{ + "shape":"AbortConfig", + "documentation":"

Allows you to create criteria to abort a job.

" + }, + "timeoutConfig":{ + "shape":"TimeoutConfig", + "documentation":"

Specifies the amount of time each device has to finish its execution of the job. The timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the time expires, it will be automatically set to TIMED_OUT.

" + } + } + }, + "UpdateMitigationActionRequest":{ + "type":"structure", + "required":["actionName"], + "members":{ + "actionName":{ + "shape":"MitigationActionName", + "documentation":"

The friendly name for the mitigation action. You can't change the name by using UpdateMitigationAction. Instead, you must delete and re-create the mitigation action with the new name.

", + "location":"uri", + "locationName":"actionName" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that is used to apply the mitigation action.

" + }, + "actionParams":{ + "shape":"MitigationActionParams", + "documentation":"

Defines the type of action and the parameters for that action.

" + } + } + }, + "UpdateMitigationActionResponse":{ + "type":"structure", + "members":{ + "actionArn":{ + "shape":"MitigationActionArn", + "documentation":"

The ARN for the new mitigation action.

" + }, + "actionId":{ + "shape":"MitigationActionId", + "documentation":"

A unique identifier for the mitigation action.

" + } + } + }, + "UpdateRoleAliasRequest":{ + "type":"structure", + "required":["roleAlias"], + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias to update.

", + "location":"uri", + "locationName":"roleAlias" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The role ARN.

" + }, + "credentialDurationSeconds":{ + "shape":"CredentialDurationSeconds", + "documentation":"

The number of seconds the credential will be valid.

" + } + } + }, + "UpdateRoleAliasResponse":{ + "type":"structure", + "members":{ + "roleAlias":{ + "shape":"RoleAlias", + "documentation":"

The role alias.

" + }, + "roleAliasArn":{ + "shape":"RoleAliasArn", + "documentation":"

The role alias ARN.

" + } + } + }, + "UpdateScheduledAuditRequest":{ + "type":"structure", + "required":["scheduledAuditName"], + "members":{ + "frequency":{ + "shape":"AuditFrequency", + "documentation":"

How often the scheduled audit takes place. Can be one of \"DAILY\", \"WEEKLY\", \"BIWEEKLY\", or \"MONTHLY\". The start time of each audit is determined by the system.

" + }, + "dayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

The day of the month on which the scheduled audit takes place. Can be \"1\" through \"31\" or \"LAST\". This field is required if the \"frequency\" parameter is set to \"MONTHLY\". If days 29-31 are specified, and the month does not have that many days, the audit takes place on the \"LAST\" day of the month.

" + }, + "dayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

The day of the week on which the scheduled audit takes place. Can be one of \"SUN\", \"MON\", \"TUE\", \"WED\", \"THU\", \"FRI\", or \"SAT\". This field is required if the \"frequency\" parameter is set to \"WEEKLY\" or \"BIWEEKLY\".

" + }, + "targetCheckNames":{ + "shape":"TargetAuditCheckNames", + "documentation":"

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

" + }, + "scheduledAuditName":{ + "shape":"ScheduledAuditName", + "documentation":"

The name of the scheduled audit. (Max. 128 chars)

", + "location":"uri", + "locationName":"scheduledAuditName" + } + } + }, + "UpdateScheduledAuditResponse":{ + "type":"structure", + "members":{ + "scheduledAuditArn":{ + "shape":"ScheduledAuditArn", + "documentation":"

The ARN of the scheduled audit.

" + } + } + }, + "UpdateSecurityProfileRequest":{ + "type":"structure", + "required":["securityProfileName"], + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile you want to update.

", + "location":"uri", + "locationName":"securityProfileName" + }, + "securityProfileDescription":{ + "shape":"SecurityProfileDescription", + "documentation":"

A description of the security profile.

" + }, + "behaviors":{ + "shape":"Behaviors", + "documentation":"

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + }, + "alertTargets":{ + "shape":"AlertTargets", + "documentation":"

Where the alerts are sent. (Alerts are always sent to the console.)

" + }, + "additionalMetricsToRetain":{ + "shape":"AdditionalMetricsToRetainList", + "documentation":"

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.

" + }, + "deleteBehaviors":{ + "shape":"DeleteBehaviors", + "documentation":"

If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.

" + }, + "deleteAlertTargets":{ + "shape":"DeleteAlertTargets", + "documentation":"

If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.

" + }, + "deleteAdditionalMetricsToRetain":{ + "shape":"DeleteAdditionalMetricsToRetain", + "documentation":"

If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.

" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.

", + "location":"querystring", + "locationName":"expectedVersion" + } + } + }, + "UpdateSecurityProfileResponse":{ + "type":"structure", + "members":{ + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile that was updated.

" + }, + "securityProfileArn":{ + "shape":"SecurityProfileArn", + "documentation":"

The ARN of the security profile that was updated.

" + }, + "securityProfileDescription":{ + "shape":"SecurityProfileDescription", + "documentation":"

The description of the security profile.

" + }, + "behaviors":{ + "shape":"Behaviors", + "documentation":"

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + }, + "alertTargets":{ + "shape":"AlertTargets", + "documentation":"

Where the alerts are sent. (Alerts are always sent to the console.)

" + }, + "additionalMetricsToRetain":{ + "shape":"AdditionalMetricsToRetainList", + "documentation":"

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The updated version of the security profile.

" + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

The time the security profile was created.

" + }, + "lastModifiedDate":{ + "shape":"Timestamp", + "documentation":"

The time the security profile was last modified.

" + } + } + }, + "UpdateStreamRequest":{ + "type":"structure", + "required":["streamId"], + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

", + "location":"uri", + "locationName":"streamId" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

The description of the stream.

" + }, + "files":{ + "shape":"StreamFiles", + "documentation":"

The files associated with the stream.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

An IAM role that allows the IoT service principal assumes to access your S3 files.

" + } + } + }, + "UpdateStreamResponse":{ + "type":"structure", + "members":{ + "streamId":{ + "shape":"StreamId", + "documentation":"

The stream ID.

" + }, + "streamArn":{ + "shape":"StreamArn", + "documentation":"

The stream ARN.

" + }, + "description":{ + "shape":"StreamDescription", + "documentation":"

A description of the stream.

" + }, + "streamVersion":{ + "shape":"StreamVersion", + "documentation":"

The stream version.

" + } + } + }, + "UpdateThingGroupRequest":{ + "type":"structure", + "required":[ + "thingGroupName", + "thingGroupProperties" + ], + "members":{ + "thingGroupName":{ + "shape":"ThingGroupName", + "documentation":"

The thing group to update.

", + "location":"uri", + "locationName":"thingGroupName" + }, + "thingGroupProperties":{ + "shape":"ThingGroupProperties", + "documentation":"

The thing group properties.

" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the thing group. If this does not match the version of the thing group being updated, the update will fail.

" + } + } + }, + "UpdateThingGroupResponse":{ + "type":"structure", + "members":{ + "version":{ + "shape":"Version", + "documentation":"

The version of the updated thing group.

" + } + } + }, + "UpdateThingGroupsForThingRequest":{ + "type":"structure", + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The thing whose group memberships will be updated.

" + }, + "thingGroupsToAdd":{ + "shape":"ThingGroupList", + "documentation":"

The groups to which the thing will be added.

" + }, + "thingGroupsToRemove":{ + "shape":"ThingGroupList", + "documentation":"

The groups from which the thing will be removed.

" + }, + "overrideDynamicGroups":{ + "shape":"OverrideDynamicGroups", + "documentation":"

Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group.

" + } + } + }, + "UpdateThingGroupsForThingResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateThingRequest":{ + "type":"structure", + "required":["thingName"], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to update.

", + "location":"uri", + "locationName":"thingName" + }, + "thingTypeName":{ + "shape":"ThingTypeName", + "documentation":"

The name of the thing type.

" + }, + "attributePayload":{ + "shape":"AttributePayload", + "documentation":"

A list of thing attributes, a JSON string containing name-value pairs. For example:

{\\\"attributes\\\":{\\\"name1\\\":\\\"value2\\\"}}

This data is used to add new attributes or update existing attributes.

" + }, + "expectedVersion":{ + "shape":"OptionalVersion", + "documentation":"

The expected version of the thing record in the registry. If the version of the record in the registry does not match the expected version specified in the request, the UpdateThing request is rejected with a VersionConflictException.

" + }, + "removeThingType":{ + "shape":"RemoveThingType", + "documentation":"

Remove a thing type association. If true, the association is removed.

" + } + }, + "documentation":"

The input for the UpdateThing operation.

" + }, + "UpdateThingResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The output from the UpdateThing operation.

" + }, + "UseBase64":{"type":"boolean"}, + "Valid":{"type":"boolean"}, + "ValidateSecurityProfileBehaviorsRequest":{ + "type":"structure", + "required":["behaviors"], + "members":{ + "behaviors":{ + "shape":"Behaviors", + "documentation":"

Specifies the behaviors that, when violated by a device (thing), cause an alert.

" + } + } + }, + "ValidateSecurityProfileBehaviorsResponse":{ + "type":"structure", + "members":{ + "valid":{ + "shape":"Valid", + "documentation":"

True if the behaviors were valid.

" + }, + "validationErrors":{ + "shape":"ValidationErrors", + "documentation":"

The list of any errors found in the behaviors.

" + } + } + }, + "ValidationError":{ + "type":"structure", + "members":{ + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The description of an error found in the behaviors.

" + } + }, + "documentation":"

Information about an error found in a behavior specification.

" + }, + "ValidationErrors":{ + "type":"list", + "member":{"shape":"ValidationError"} + }, + "Value":{"type":"string"}, + "Version":{"type":"long"}, + "VersionConflictException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An exception thrown when the version of an entity specified with the expectedVersion parameter does not match the latest version in the system.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "VersionNumber":{"type":"long"}, + "VersionsLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The number of policy versions exceeds the limit.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ViolationEvent":{ + "type":"structure", + "members":{ + "violationId":{ + "shape":"ViolationId", + "documentation":"

The ID of the violation event.

" + }, + "thingName":{ + "shape":"DeviceDefenderThingName", + "documentation":"

The name of the thing responsible for the violation event.

" + }, + "securityProfileName":{ + "shape":"SecurityProfileName", + "documentation":"

The name of the security profile whose behavior was violated.

" + }, + "behavior":{ + "shape":"Behavior", + "documentation":"

The behavior which was violated.

" + }, + "metricValue":{ + "shape":"MetricValue", + "documentation":"

The value of the metric (the measurement).

" + }, + "violationEventType":{ + "shape":"ViolationEventType", + "documentation":"

The type of violation event.

" + }, + "violationEventTime":{ + "shape":"Timestamp", + "documentation":"

The time the violation event occurred.

" + } + }, + "documentation":"

Information about a Device Defender security profile behavior violation.

" + }, + "ViolationEventType":{ + "type":"string", + "enum":[ + "in-alarm", + "alarm-cleared", + "alarm-invalidated" + ] + }, + "ViolationEvents":{ + "type":"list", + "member":{"shape":"ViolationEvent"} + }, + "ViolationId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9\\-]+" + }, + "WaitingForDataCollectionChecksCount":{"type":"integer"}, + "errorMessage":{"type":"string"}, + "resourceArn":{"type":"string"}, + "resourceId":{"type":"string"} + }, + "documentation":"AWS IoT

AWS IoT provides secure, bi-directional communication between Internet-connected devices (such as sensors, actuators, embedded devices, or smart appliances) and the AWS cloud. You can discover your custom IoT-Data endpoint to communicate with, configure rules for data processing and integration with other services, organize resources associated with each device (Registry), configure logging, and create and manage policies and credentials to authenticate devices.

For more information about how AWS IoT works, see the Developer Guide.

For information about how to use the credentials provider for AWS IoT, see Authorizing Direct Calls to AWS Services.

" +} diff --git a/aws/dist/botocore/data/iot1click-devices/2018-05-14/paginators-1.json b/aws/dist/botocore/data/iot1click-devices/2018-05-14/paginators-1.json new file mode 100644 index 00000000..237e5581 --- /dev/null +++ b/aws/dist/botocore/data/iot1click-devices/2018-05-14/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListDeviceEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Events" + }, + "ListDevices": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Devices" + } + } +} diff --git a/aws/dist/botocore/data/iot1click-devices/2018-05-14/service-2.json b/aws/dist/botocore/data/iot1click-devices/2018-05-14/service-2.json new file mode 100644 index 00000000..0d454760 --- /dev/null +++ b/aws/dist/botocore/data/iot1click-devices/2018-05-14/service-2.json @@ -0,0 +1,1042 @@ +{ + "metadata" : { + "apiVersion" : "2018-05-14", + "endpointPrefix" : "devices.iot1click", + "signingName" : "iot1click", + "serviceFullName" : "AWS IoT 1-Click Devices Service", + "serviceId" : "IoT 1Click Devices Service", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "devices-2018-05-14", + "signatureVersion" : "v4" + }, + "operations" : { + "ClaimDevicesByClaimCode" : { + "name" : "ClaimDevicesByClaimCode", + "http" : { + "method" : "PUT", + "requestUri" : "/claims/{claimCode}", + "responseCode" : 200 + }, + "input" : { + "shape" : "ClaimDevicesByClaimCodeRequest" + }, + "output" : { + "shape" : "ClaimDevicesByClaimCodeResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + }, { + "shape" : "ForbiddenException", + "documentation" : "

403 response

" + } ], + "documentation" : "

Adds device(s) to your account (i.e., claim one or more devices) if and only if you\n received a claim code with the device(s).

" + }, + "DescribeDevice" : { + "name" : "DescribeDevice", + "http" : { + "method" : "GET", + "requestUri" : "/devices/{deviceId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeDeviceRequest" + }, + "output" : { + "shape" : "DescribeDeviceResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Given a device ID, returns a DescribeDeviceResponse object describing the\n details of the device.

" + }, + "FinalizeDeviceClaim" : { + "name" : "FinalizeDeviceClaim", + "http" : { + "method" : "PUT", + "requestUri" : "/devices/{deviceId}/finalize-claim", + "responseCode" : 200 + }, + "input" : { + "shape" : "FinalizeDeviceClaimRequest" + }, + "output" : { + "shape" : "FinalizeDeviceClaimResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + }, { + "shape" : "PreconditionFailedException", + "documentation" : "

412 response

" + }, { + "shape" : "ResourceConflictException", + "documentation" : "

409 response

" + } ], + "documentation" : "

Given a device ID, finalizes the claim request for the associated device.

\n

Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.

\n " + }, + "GetDeviceMethods" : { + "name" : "GetDeviceMethods", + "http" : { + "method" : "GET", + "requestUri" : "/devices/{deviceId}/methods", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetDeviceMethodsRequest" + }, + "output" : { + "shape" : "GetDeviceMethodsResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Given a device ID, returns the invokable methods associated with the device.

" + }, + "InitiateDeviceClaim" : { + "name" : "InitiateDeviceClaim", + "http" : { + "method" : "PUT", + "requestUri" : "/devices/{deviceId}/initiate-claim", + "responseCode" : 200 + }, + "input" : { + "shape" : "InitiateDeviceClaimRequest" + }, + "output" : { + "shape" : "InitiateDeviceClaimResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + }, { + "shape" : "ResourceConflictException", + "documentation" : "

409 response

" + } ], + "documentation" : "

Given a device ID, initiates a claim request for the associated device.

\n

Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.

\n " + }, + "InvokeDeviceMethod" : { + "name" : "InvokeDeviceMethod", + "http" : { + "method" : "POST", + "requestUri" : "/devices/{deviceId}/methods", + "responseCode" : 200 + }, + "input" : { + "shape" : "InvokeDeviceMethodRequest" + }, + "output" : { + "shape" : "InvokeDeviceMethodResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "PreconditionFailedException", + "documentation" : "

412 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + }, { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "RangeNotSatisfiableException", + "documentation" : "

416 response

" + }, { + "shape" : "ResourceConflictException", + "documentation" : "

409 response

" + } ], + "documentation" : "

Given a device ID, issues a request to invoke a named device method (with possible\n parameters). See the \"Example POST\" code snippet below.

" + }, + "ListDeviceEvents" : { + "name" : "ListDeviceEvents", + "http" : { + "method" : "GET", + "requestUri" : "/devices/{deviceId}/events", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListDeviceEventsRequest" + }, + "output" : { + "shape" : "ListDeviceEventsResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "RangeNotSatisfiableException", + "documentation" : "

416 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Using a device ID, returns a DeviceEventsResponse object containing an\n array of events for the device.

" + }, + "ListDevices" : { + "name" : "ListDevices", + "http" : { + "method" : "GET", + "requestUri" : "/devices", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListDevicesRequest" + }, + "output" : { + "shape" : "ListDevicesResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "RangeNotSatisfiableException", + "documentation" : "

416 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Lists the 1-Click compatible devices associated with your AWS account.

" + }, + "ListTagsForResource" : { + "name" : "ListTagsForResource", + "http" : { + "method" : "GET", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListTagsForResourceRequest" + }, + "output" : { + "shape" : "ListTagsForResourceResponse" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Lists the tags associated with the specified resource ARN.

" + }, + "TagResource" : { + "name" : "TagResource", + "http" : { + "method" : "POST", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "TagResourceRequest" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per\n resource.

" + }, + "UnclaimDevice" : { + "name" : "UnclaimDevice", + "http" : { + "method" : "PUT", + "requestUri" : "/devices/{deviceId}/unclaim", + "responseCode" : 200 + }, + "input" : { + "shape" : "UnclaimDeviceRequest" + }, + "output" : { + "shape" : "UnclaimDeviceResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Disassociates a device from your AWS account using its device ID.

" + }, + "UntagResource" : { + "name" : "UntagResource", + "http" : { + "method" : "DELETE", + "requestUri" : "/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "UntagResourceRequest" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Using tag keys, deletes the tags (key/value pairs) associated with the specified\n resource ARN.

" + }, + "UpdateDeviceState" : { + "name" : "UpdateDeviceState", + "http" : { + "method" : "PUT", + "requestUri" : "/devices/{deviceId}/state", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateDeviceStateRequest" + }, + "output" : { + "shape" : "UpdateDeviceStateResponse", + "documentation" : "

200 response

" + }, + "errors" : [ { + "shape" : "ResourceNotFoundException", + "documentation" : "

404 response

" + }, { + "shape" : "InvalidRequestException", + "documentation" : "

400 response

" + }, { + "shape" : "InternalFailureException", + "documentation" : "

500 response

" + } ], + "documentation" : "

Using a Boolean value (true or false), this operation\n enables or disables the device given a device ID.

" + } + }, + "shapes" : { + "Attributes" : { + "type" : "structure", + "members" : { } + }, + "ClaimDevicesByClaimCodeRequest" : { + "type" : "structure", + "members" : { + "ClaimCode" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "claimCode", + "documentation" : "

The claim code, starting with \"C-\", as provided by the device manufacturer.

" + } + }, + "required" : [ "ClaimCode" ] + }, + "ClaimDevicesByClaimCodeResponse" : { + "type" : "structure", + "members" : { + "ClaimCode" : { + "shape" : "__stringMin12Max40", + "locationName" : "claimCode", + "documentation" : "

The claim code provided by the device manufacturer.

" + }, + "Total" : { + "shape" : "__integer", + "locationName" : "total", + "documentation" : "

The total number of devices associated with the claim code that has been processed in\n the claim request.

" + } + } + }, + "DescribeDeviceRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + } + }, + "required" : [ "DeviceId" ] + }, + "DescribeDeviceResponse" : { + "type" : "structure", + "members" : { + "DeviceDescription" : { + "shape" : "DeviceDescription", + "locationName" : "deviceDescription", + "documentation" : "

Device details.

" + } + } + }, + "Device" : { + "type" : "structure", + "members" : { + "Attributes" : { + "shape" : "Attributes", + "locationName" : "attributes", + "documentation" : "

The user specified attributes associated with the device for an event.

" + }, + "DeviceId" : { + "shape" : "__string", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "Type" : { + "shape" : "__string", + "locationName" : "type", + "documentation" : "

The device type, such as \"button\".

" + } + } + }, + "DeviceAttributes" : { + "type" : "map", + "documentation" : "

\n DeviceAttributes is a string-to-string map specified by the user.

", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "DeviceClaimResponse" : { + "type" : "structure", + "members" : { + "State" : { + "shape" : "__string", + "locationName" : "state", + "documentation" : "

The device's final claim state.

" + } + } + }, + "DeviceDescription" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "

The ARN of the device.

" + }, + "Attributes" : { + "shape" : "DeviceAttributes", + "locationName" : "attributes", + "documentation" : "

An array of zero or more elements of DeviceAttribute objects providing\n user specified device attributes.

" + }, + "DeviceId" : { + "shape" : "__string", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "Enabled" : { + "shape" : "__boolean", + "locationName" : "enabled", + "documentation" : "

A Boolean value indicating whether or not the device is enabled.

" + }, + "RemainingLife" : { + "shape" : "__doubleMin0Max100", + "locationName" : "remainingLife", + "documentation" : "

A value between 0 and 1 inclusive, representing the fraction of life remaining for the\n device.

" + }, + "Type" : { + "shape" : "__string", + "locationName" : "type", + "documentation" : "

The type of the device, such as \"button\".

" + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "

The tags currently associated with the AWS IoT 1-Click device.

" + } + } + }, + "DeviceEvent" : { + "type" : "structure", + "members" : { + "Device" : { + "shape" : "Device", + "locationName" : "device", + "documentation" : "

An object representing the device associated with the event.

" + }, + "StdEvent" : { + "shape" : "__string", + "locationName" : "stdEvent", + "documentation" : "

A serialized JSON object representing the device-type specific event.

" + } + } + }, + "DeviceEventsResponse" : { + "type" : "structure", + "members" : { + "Events" : { + "shape" : "__listOfDeviceEvent", + "locationName" : "events", + "documentation" : "

An array of zero or more elements describing the event(s) associated with the\n device.

" + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

The token to retrieve the next set of results.

" + } + } + }, + "DeviceMethod" : { + "type" : "structure", + "members" : { + "DeviceType" : { + "shape" : "__string", + "locationName" : "deviceType", + "documentation" : "

The type of the device, such as \"button\".

" + }, + "MethodName" : { + "shape" : "__string", + "locationName" : "methodName", + "documentation" : "

The name of the method applicable to the deviceType.

" + } + } + }, + "Empty" : { + "type" : "structure", + "members" : { }, + "documentation" : "

On success, an empty object is returned.

" + }, + "FinalizeDeviceClaimRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "

A collection of key/value pairs defining the resource tags. For example, {\n \"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS\n Tagging Strategies.

\n \n

" + } + }, + "required" : [ "DeviceId" ] + }, + "FinalizeDeviceClaimResponse" : { + "type" : "structure", + "members" : { + "State" : { + "shape" : "__string", + "locationName" : "state", + "documentation" : "

The device's final claim state.

" + } + } + }, + "ForbiddenException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

403

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

The 403 error message returned by the web server.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 403 + } + }, + "GetDeviceMethodsRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + } + }, + "required" : [ "DeviceId" ] + }, + "GetDeviceMethodsResponse" : { + "type" : "structure", + "members" : { + "DeviceMethods" : { + "shape" : "__listOfDeviceMethod", + "locationName" : "deviceMethods", + "documentation" : "

List of available device APIs.

" + } + } + }, + "InitiateDeviceClaimRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + } + }, + "required" : [ "DeviceId" ] + }, + "InitiateDeviceClaimResponse" : { + "type" : "structure", + "members" : { + "State" : { + "shape" : "__string", + "locationName" : "state", + "documentation" : "

The device's final claim state.

" + } + } + }, + "InternalFailureException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

500

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

The 500 error message returned by the web server.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "InvalidRequestException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

400

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

The 400 error message returned by the web server.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "InvokeDeviceMethodRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "DeviceMethod" : { + "shape" : "DeviceMethod", + "locationName" : "deviceMethod", + "documentation" : "

The device method to invoke.

" + }, + "DeviceMethodParameters" : { + "shape" : "__string", + "locationName" : "deviceMethodParameters", + "documentation" : "

A JSON encoded string containing the device method request parameters.

" + } + }, + "required" : [ "DeviceId" ] + }, + "InvokeDeviceMethodResponse" : { + "type" : "structure", + "members" : { + "DeviceMethodResponse" : { + "shape" : "__string", + "locationName" : "deviceMethodResponse", + "documentation" : "

A JSON encoded string containing the device method response.

" + } + } + }, + "ListDeviceEventsRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "FromTimeStamp" : { + "shape" : "__timestampIso8601", + "location" : "querystring", + "locationName" : "fromTimeStamp", + "documentation" : "

The start date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n

" + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of results to return per request. If not set, a default value of\n 100 is used.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The token to retrieve the next set of results.

" + }, + "ToTimeStamp" : { + "shape" : "__timestampIso8601", + "location" : "querystring", + "locationName" : "toTimeStamp", + "documentation" : "

The end date for the device event query, in ISO8061 format. For example,\n 2018-03-28T15:45:12.880Z\n

" + } + }, + "required" : [ "DeviceId", "FromTimeStamp", "ToTimeStamp" ] + }, + "ListDeviceEventsResponse" : { + "type" : "structure", + "members" : { + "Events" : { + "shape" : "__listOfDeviceEvent", + "locationName" : "events", + "documentation" : "

An array of zero or more elements describing the event(s) associated with the\n device.

" + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

The token to retrieve the next set of results.

" + } + } + }, + "ListDevicesRequest" : { + "type" : "structure", + "members" : { + "DeviceType" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "deviceType", + "documentation" : "

The type of the device, such as \"button\".

" + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "

The maximum number of results to return per request. If not set, a default value of\n 100 is used.

" + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

The token to retrieve the next set of results.

" + } + } + }, + "ListDevicesResponse" : { + "type" : "structure", + "members" : { + "Devices" : { + "shape" : "__listOfDeviceDescription", + "locationName" : "devices", + "documentation" : "

A list of devices.

" + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

The token to retrieve the next set of results.

" + } + } + }, + "ListTagsForResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "

The ARN of the resource.

" + } + }, + "required" : [ "ResourceArn" ] + }, + "ListTagsForResourceResponse" : { + "type" : "structure", + "members" : { + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "

A collection of key/value pairs defining the resource tags. For example, {\n \"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS\n Tagging Strategies.

\n \n

" + } + } + }, + "MaxResults" : { + "type" : "integer", + "min" : 1, + "max" : 250 + }, + "PreconditionFailedException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

412

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

An error message explaining the error or its remedy.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 412 + } + }, + "RangeNotSatisfiableException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

416

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

The requested number of results specified by nextToken cannot be\n satisfied.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 416 + } + }, + "ResourceConflictException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

409

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

An error message explaining the error or its remedy.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "ResourceNotFoundException" : { + "type" : "structure", + "members" : { + "Code" : { + "shape" : "__string", + "locationName" : "code", + "documentation" : "

404

" + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

The requested device could not be found.

" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "TagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "

The ARN of the resource.

" + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "

A collection of key/value pairs defining the resource tags. For example, {\n \"tags\": {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS\n Tagging Strategies.

\n \n

" + } + }, + "required" : [ "ResourceArn", "Tags" ] + }, + "UnclaimDeviceRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + } + }, + "required" : [ "DeviceId" ] + }, + "UnclaimDeviceResponse" : { + "type" : "structure", + "members" : { + "State" : { + "shape" : "__string", + "locationName" : "state", + "documentation" : "

The device's final claim state.

" + } + } + }, + "UntagResourceRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "

The ARN of the resource.

" + }, + "TagKeys" : { + "shape" : "__listOf__string", + "location" : "querystring", + "locationName" : "tagKeys", + "documentation" : "

A collections of tag keys. For example, {\"key1\",\"key2\"}

" + } + }, + "required" : [ "TagKeys", "ResourceArn" ] + }, + "UpdateDeviceStateRequest" : { + "type" : "structure", + "members" : { + "DeviceId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "deviceId", + "documentation" : "

The unique identifier of the device.

" + }, + "Enabled" : { + "shape" : "__boolean", + "locationName" : "enabled", + "documentation" : "

If true, the device is enabled. If false, the device is\n disabled.

" + } + }, + "required" : [ "DeviceId" ] + }, + "UpdateDeviceStateResponse" : { + "type" : "structure", + "members" : { } + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__doubleMin0Max100" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__listOfDeviceDescription" : { + "type" : "list", + "member" : { + "shape" : "DeviceDescription" + } + }, + "__listOfDeviceEvent" : { + "type" : "list", + "member" : { + "shape" : "DeviceEvent" + } + }, + "__listOfDeviceMethod" : { + "type" : "list", + "member" : { + "shape" : "DeviceMethod" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__mapOf__string" : { + "type" : "map", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "__string" : { + "type" : "string" + }, + "__stringMin12Max40" : { + "type" : "string", + "min" : 12, + "max" : 40 + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "documentation" : "

Describes all of the AWS IoT 1-Click device-related API operations for the service.\n Also provides sample requests, responses, and errors for the supported web services\n protocols.

" +} \ No newline at end of file diff --git a/aws/dist/botocore/data/iot1click-projects/2018-05-14/paginators-1.json b/aws/dist/botocore/data/iot1click-projects/2018-05-14/paginators-1.json new file mode 100644 index 00000000..d17d5df6 --- /dev/null +++ b/aws/dist/botocore/data/iot1click-projects/2018-05-14/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListPlacements": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "placements" + }, + "ListProjects": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "projects" + } + } +} diff --git a/aws/dist/botocore/data/iot1click-projects/2018-05-14/service-2.json b/aws/dist/botocore/data/iot1click-projects/2018-05-14/service-2.json new file mode 100644 index 00000000..229e3f01 --- /dev/null +++ b/aws/dist/botocore/data/iot1click-projects/2018-05-14/service-2.json @@ -0,0 +1,1070 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-14", + "endpointPrefix":"projects.iot1click", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"AWS IoT 1-Click Projects", + "serviceFullName":"AWS IoT 1-Click Projects Service", + "serviceId":"IoT 1Click Projects", + "signatureVersion":"v4", + "signingName":"iot1click", + "uid":"iot1click-projects-2018-05-14" + }, + "operations":{ + "AssociateDeviceWithPlacement":{ + "name":"AssociateDeviceWithPlacement", + "http":{ + "method":"PUT", + "requestUri":"/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}" + }, + "input":{"shape":"AssociateDeviceWithPlacementRequest"}, + "output":{"shape":"AssociateDeviceWithPlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Associates a physical device with a placement.

" + }, + "CreatePlacement":{ + "name":"CreatePlacement", + "http":{ + "method":"POST", + "requestUri":"/projects/{projectName}/placements" + }, + "input":{"shape":"CreatePlacementRequest"}, + "output":{"shape":"CreatePlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceConflictException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates an empty placement.

" + }, + "CreateProject":{ + "name":"CreateProject", + "http":{ + "method":"POST", + "requestUri":"/projects" + }, + "input":{"shape":"CreateProjectRequest"}, + "output":{"shape":"CreateProjectResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceConflictException"} + ], + "documentation":"

Creates an empty project with a placement template. A project contains zero or more placements that adhere to the placement template defined in the project.

" + }, + "DeletePlacement":{ + "name":"DeletePlacement", + "http":{ + "method":"DELETE", + "requestUri":"/projects/{projectName}/placements/{placementName}" + }, + "input":{"shape":"DeletePlacementRequest"}, + "output":{"shape":"DeletePlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes a placement. To delete a placement, it must not have any devices associated with it.

When you delete a placement, all associated data becomes irretrievable.

" + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"DELETE", + "requestUri":"/projects/{projectName}" + }, + "input":{"shape":"DeleteProjectRequest"}, + "output":{"shape":"DeleteProjectResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes a project. To delete a project, it must not have any placements associated with it.

When you delete a project, all associated data becomes irretrievable.

" + }, + "DescribePlacement":{ + "name":"DescribePlacement", + "http":{ + "method":"GET", + "requestUri":"/projects/{projectName}/placements/{placementName}" + }, + "input":{"shape":"DescribePlacementRequest"}, + "output":{"shape":"DescribePlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a placement in a project.

" + }, + "DescribeProject":{ + "name":"DescribeProject", + "http":{ + "method":"GET", + "requestUri":"/projects/{projectName}" + }, + "input":{"shape":"DescribeProjectRequest"}, + "output":{"shape":"DescribeProjectResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns an object describing a project.

" + }, + "DisassociateDeviceFromPlacement":{ + "name":"DisassociateDeviceFromPlacement", + "http":{ + "method":"DELETE", + "requestUri":"/projects/{projectName}/placements/{placementName}/devices/{deviceTemplateName}" + }, + "input":{"shape":"DisassociateDeviceFromPlacementRequest"}, + "output":{"shape":"DisassociateDeviceFromPlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Removes a physical device from a placement.

" + }, + "GetDevicesInPlacement":{ + "name":"GetDevicesInPlacement", + "http":{ + "method":"GET", + "requestUri":"/projects/{projectName}/placements/{placementName}/devices" + }, + "input":{"shape":"GetDevicesInPlacementRequest"}, + "output":{"shape":"GetDevicesInPlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns an object enumerating the devices in a placement.

" + }, + "ListPlacements":{ + "name":"ListPlacements", + "http":{ + "method":"GET", + "requestUri":"/projects/{projectName}/placements" + }, + "input":{"shape":"ListPlacementsRequest"}, + "output":{"shape":"ListPlacementsResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the placement(s) of a project.

" + }, + "ListProjects":{ + "name":"ListProjects", + "http":{ + "method":"GET", + "requestUri":"/projects" + }, + "input":{"shape":"ListProjectsRequest"}, + "output":{"shape":"ListProjectsResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Lists the AWS IoT 1-Click project(s) associated with your AWS account and region.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the tags (metadata key/value pairs) which you have assigned to the resource.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates or modifies tags for a resource. Tags are key/value pairs (metadata) that can be used to manage a resource. For more information, see AWS Tagging Strategies.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes one or more tags (metadata key/value pairs) from a resource.

" + }, + "UpdatePlacement":{ + "name":"UpdatePlacement", + "http":{ + "method":"PUT", + "requestUri":"/projects/{projectName}/placements/{placementName}" + }, + "input":{"shape":"UpdatePlacementRequest"}, + "output":{"shape":"UpdatePlacementResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Updates a placement with the given attributes. To clear an attribute, pass an empty value (i.e., \"\").

" + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"PUT", + "requestUri":"/projects/{projectName}" + }, + "input":{"shape":"UpdateProjectRequest"}, + "output":{"shape":"UpdateProjectResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Updates a project associated with your AWS account and region. With the exception of device template names, you can pass just the values that need to be updated because the update request will change only the values that are provided. To clear a value, pass the empty string (i.e., \"\").

" + } + }, + "shapes":{ + "AssociateDeviceWithPlacementRequest":{ + "type":"structure", + "required":[ + "projectName", + "placementName", + "deviceId", + "deviceTemplateName" + ], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project containing the placement in which to associate the device.

", + "location":"uri", + "locationName":"projectName" + }, + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement in which to associate the device.

", + "location":"uri", + "locationName":"placementName" + }, + "deviceId":{ + "shape":"DeviceId", + "documentation":"

The ID of the physical device to be associated with the given placement in the project. Note that a mandatory 4 character prefix is required for all deviceId values.

" + }, + "deviceTemplateName":{ + "shape":"DeviceTemplateName", + "documentation":"

The device template name to associate with the device ID.

", + "location":"uri", + "locationName":"deviceTemplateName" + } + } + }, + "AssociateDeviceWithPlacementResponse":{ + "type":"structure", + "members":{ + } + }, + "AttributeDefaultValue":{ + "type":"string", + "max":800 + }, + "AttributeName":{ + "type":"string", + "max":128, + "min":1 + }, + "AttributeValue":{ + "type":"string", + "max":800 + }, + "Code":{"type":"string"}, + "CreatePlacementRequest":{ + "type":"structure", + "required":[ + "placementName", + "projectName" + ], + "members":{ + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement to be created.

" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project in which to create the placement.

", + "location":"uri", + "locationName":"projectName" + }, + "attributes":{ + "shape":"PlacementAttributeMap", + "documentation":"

Optional user-defined key/value pairs providing contextual data (such as location or function) for the placement.

" + } + } + }, + "CreatePlacementResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateProjectRequest":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project to create.

" + }, + "description":{ + "shape":"Description", + "documentation":"

An optional description for the project.

" + }, + "placementTemplate":{ + "shape":"PlacementTemplate", + "documentation":"

The schema defining the placement to be created. A placement template defines placement default attributes and device templates. You cannot add or remove device templates after the project has been created. However, you can update callbackOverrides for the device templates using the UpdateProject API.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

Optional tags (metadata key/value pairs) to be associated with the project. For example, { {\"key1\": \"value1\", \"key2\": \"value2\"} }. For more information, see AWS Tagging Strategies.

" + } + } + }, + "CreateProjectResponse":{ + "type":"structure", + "members":{ + } + }, + "DefaultPlacementAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeDefaultValue"} + }, + "DeletePlacementRequest":{ + "type":"structure", + "required":[ + "placementName", + "projectName" + ], + "members":{ + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the empty placement to delete.

", + "location":"uri", + "locationName":"placementName" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The project containing the empty placement to delete.

", + "location":"uri", + "locationName":"projectName" + } + } + }, + "DeletePlacementResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteProjectRequest":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the empty project to delete.

", + "location":"uri", + "locationName":"projectName" + } + } + }, + "DeleteProjectResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribePlacementRequest":{ + "type":"structure", + "required":[ + "placementName", + "projectName" + ], + "members":{ + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement within a project.

", + "location":"uri", + "locationName":"placementName" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The project containing the placement to be described.

", + "location":"uri", + "locationName":"projectName" + } + } + }, + "DescribePlacementResponse":{ + "type":"structure", + "required":["placement"], + "members":{ + "placement":{ + "shape":"PlacementDescription", + "documentation":"

An object describing the placement.

" + } + } + }, + "DescribeProjectRequest":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project to be described.

", + "location":"uri", + "locationName":"projectName" + } + } + }, + "DescribeProjectResponse":{ + "type":"structure", + "required":["project"], + "members":{ + "project":{ + "shape":"ProjectDescription", + "documentation":"

An object describing the project.

" + } + } + }, + "Description":{ + "type":"string", + "max":500, + "min":0 + }, + "DeviceCallbackKey":{ + "type":"string", + "max":128, + "min":1 + }, + "DeviceCallbackOverrideMap":{ + "type":"map", + "key":{"shape":"DeviceCallbackKey"}, + "value":{"shape":"DeviceCallbackValue"} + }, + "DeviceCallbackValue":{ + "type":"string", + "max":200 + }, + "DeviceId":{ + "type":"string", + "max":32, + "min":1 + }, + "DeviceMap":{ + "type":"map", + "key":{"shape":"DeviceTemplateName"}, + "value":{"shape":"DeviceId"} + }, + "DeviceTemplate":{ + "type":"structure", + "members":{ + "deviceType":{ + "shape":"DeviceType", + "documentation":"

The device type, which currently must be \"button\".

" + }, + "callbackOverrides":{ + "shape":"DeviceCallbackOverrideMap", + "documentation":"

An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

" + } + }, + "documentation":"

An object representing a device for a placement template (see PlacementTemplate).

" + }, + "DeviceTemplateMap":{ + "type":"map", + "key":{"shape":"DeviceTemplateName"}, + "value":{"shape":"DeviceTemplate"} + }, + "DeviceTemplateName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "DeviceType":{ + "type":"string", + "max":128 + }, + "DisassociateDeviceFromPlacementRequest":{ + "type":"structure", + "required":[ + "projectName", + "placementName", + "deviceTemplateName" + ], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project that contains the placement.

", + "location":"uri", + "locationName":"projectName" + }, + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement that the device should be removed from.

", + "location":"uri", + "locationName":"placementName" + }, + "deviceTemplateName":{ + "shape":"DeviceTemplateName", + "documentation":"

The device ID that should be removed from the placement.

", + "location":"uri", + "locationName":"deviceTemplateName" + } + } + }, + "DisassociateDeviceFromPlacementResponse":{ + "type":"structure", + "members":{ + } + }, + "GetDevicesInPlacementRequest":{ + "type":"structure", + "required":[ + "projectName", + "placementName" + ], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project containing the placement.

", + "location":"uri", + "locationName":"projectName" + }, + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement to get the devices from.

", + "location":"uri", + "locationName":"placementName" + } + } + }, + "GetDevicesInPlacementResponse":{ + "type":"structure", + "required":["devices"], + "members":{ + "devices":{ + "shape":"DeviceMap", + "documentation":"

An object containing the devices (zero or more) within the placement.

" + } + } + }, + "InternalFailureException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"Message"} + }, + "documentation":"

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"Message"} + }, + "documentation":"

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListPlacementsRequest":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The project containing the placements to be listed.

", + "location":"uri", + "locationName":"projectName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per request. If not set, a default value of 100 is used.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPlacementsResponse":{ + "type":"structure", + "required":["placements"], + "members":{ + "placements":{ + "shape":"PlacementSummaryList", + "documentation":"

An object listing the requested placements.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

" + } + } + }, + "ListProjectsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return per request. If not set, a default value of 100 is used.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListProjectsResponse":{ + "type":"structure", + "required":["projects"], + "members":{ + "projects":{ + "shape":"ProjectSummaryList", + "documentation":"

An object containing the list of projects.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token used to retrieve the next set of results - will be effectively empty if there are no further results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ProjectArn", + "documentation":"

The ARN of the resource whose tags you want to list.

", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

The tags (metadata key/value pairs) which you have assigned to the resource.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "Message":{"type":"string"}, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "PlacementAttributeMap":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "PlacementDescription":{ + "type":"structure", + "required":[ + "projectName", + "placementName", + "attributes", + "createdDate", + "updatedDate" + ], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project containing the placement.

" + }, + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement.

" + }, + "attributes":{ + "shape":"PlacementAttributeMap", + "documentation":"

The user-defined attributes associated with the placement.

" + }, + "createdDate":{ + "shape":"Time", + "documentation":"

The date when the placement was initially created, in UNIX epoch time format.

" + }, + "updatedDate":{ + "shape":"Time", + "documentation":"

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

" + } + }, + "documentation":"

An object describing a project's placement.

" + }, + "PlacementName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "PlacementSummary":{ + "type":"structure", + "required":[ + "projectName", + "placementName", + "createdDate", + "updatedDate" + ], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project containing the placement.

" + }, + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement being summarized.

" + }, + "createdDate":{ + "shape":"Time", + "documentation":"

The date when the placement was originally created, in UNIX epoch time format.

" + }, + "updatedDate":{ + "shape":"Time", + "documentation":"

The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then createdDate and updatedDate are the same.

" + } + }, + "documentation":"

An object providing summary information for a particular placement.

" + }, + "PlacementSummaryList":{ + "type":"list", + "member":{"shape":"PlacementSummary"} + }, + "PlacementTemplate":{ + "type":"structure", + "members":{ + "defaultAttributes":{ + "shape":"DefaultPlacementAttributeMap", + "documentation":"

The default attributes (key/value pairs) to be applied to all placements using this template.

" + }, + "deviceTemplates":{ + "shape":"DeviceTemplateMap", + "documentation":"

An object specifying the DeviceTemplate for all placements using this (PlacementTemplate) template.

" + } + }, + "documentation":"

An object defining the template for a placement.

" + }, + "ProjectArn":{ + "type":"string", + "pattern":"^arn:aws:iot1click:[A-Za-z0-9_/.-]{0,63}:\\d+:projects/[0-9A-Za-z_-]{1,128}$" + }, + "ProjectDescription":{ + "type":"structure", + "required":[ + "projectName", + "createdDate", + "updatedDate" + ], + "members":{ + "arn":{ + "shape":"ProjectArn", + "documentation":"

The ARN of the project.

" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project for which to obtain information from.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the project.

" + }, + "createdDate":{ + "shape":"Time", + "documentation":"

The date when the project was originally created, in UNIX epoch time format.

" + }, + "updatedDate":{ + "shape":"Time", + "documentation":"

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

" + }, + "placementTemplate":{ + "shape":"PlacementTemplate", + "documentation":"

An object describing the project's placement specifications.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags (metadata key/value pairs) associated with the project.

" + } + }, + "documentation":"

An object providing detailed information for a particular project associated with an AWS account and region.

" + }, + "ProjectName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9A-Za-z_-]+$" + }, + "ProjectSummary":{ + "type":"structure", + "required":[ + "projectName", + "createdDate", + "updatedDate" + ], + "members":{ + "arn":{ + "shape":"ProjectArn", + "documentation":"

The ARN of the project.

" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project being summarized.

" + }, + "createdDate":{ + "shape":"Time", + "documentation":"

The date when the project was originally created, in UNIX epoch time format.

" + }, + "updatedDate":{ + "shape":"Time", + "documentation":"

The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The tags (metadata key/value pairs) associated with the project.

" + } + }, + "documentation":"

An object providing summary information for a particular project for an associated AWS account and region.

" + }, + "ProjectSummaryList":{ + "type":"list", + "member":{"shape":"ProjectSummary"} + }, + "ResourceConflictException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"Message"} + }, + "documentation":"

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"Message"} + }, + "documentation":"

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ProjectArn", + "documentation":"

The ARN of the resouce for which tag(s) should be added or modified.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

The new or modifying tag(s) for the resource. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Time":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "required":[ + "code", + "message" + ], + "members":{ + "code":{"shape":"Code"}, + "message":{"shape":"Message"} + }, + "documentation":"

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ProjectArn", + "documentation":"

The ARN of the resource whose tag you want to remove.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of those tags which you want to remove.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePlacementRequest":{ + "type":"structure", + "required":[ + "placementName", + "projectName" + ], + "members":{ + "placementName":{ + "shape":"PlacementName", + "documentation":"

The name of the placement to update.

", + "location":"uri", + "locationName":"placementName" + }, + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project containing the placement to be updated.

", + "location":"uri", + "locationName":"projectName" + }, + "attributes":{ + "shape":"PlacementAttributeMap", + "documentation":"

The user-defined object of attributes used to update the placement. The maximum number of key/value pairs is 50.

" + } + } + }, + "UpdatePlacementResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateProjectRequest":{ + "type":"structure", + "required":["projectName"], + "members":{ + "projectName":{ + "shape":"ProjectName", + "documentation":"

The name of the project to be updated.

", + "location":"uri", + "locationName":"projectName" + }, + "description":{ + "shape":"Description", + "documentation":"

An optional user-defined description for the project.

" + }, + "placementTemplate":{ + "shape":"PlacementTemplate", + "documentation":"

An object defining the project update. Once a project has been created, you cannot add device template names to the project. However, for a given placementTemplate, you can update the associated callbackOverrides for the device definition using this API.

" + } + } + }, + "UpdateProjectResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"

The AWS IoT 1-Click Projects API Reference

" +} diff --git a/aws/dist/botocore/data/iotanalytics/2017-11-27/paginators-1.json b/aws/dist/botocore/data/iotanalytics/2017-11-27/paginators-1.json new file mode 100644 index 00000000..d1bfaaaa --- /dev/null +++ b/aws/dist/botocore/data/iotanalytics/2017-11-27/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListChannels": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "channelSummaries" + }, + "ListDatasetContents": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datasetContentSummaries" + }, + "ListDatasets": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datasetSummaries" + }, + "ListDatastores": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datastoreSummaries" + }, + "ListPipelines": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "pipelineSummaries" + } + } +} diff --git a/aws/dist/botocore/data/iotanalytics/2017-11-27/service-2.json b/aws/dist/botocore/data/iotanalytics/2017-11-27/service-2.json new file mode 100644 index 00000000..3b4e4914 --- /dev/null +++ b/aws/dist/botocore/data/iotanalytics/2017-11-27/service-2.json @@ -0,0 +1,3148 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-27", + "endpointPrefix":"iotanalytics", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Analytics", + "serviceId":"IoTAnalytics", + "signatureVersion":"v4", + "signingName":"iotanalytics", + "uid":"iotanalytics-2017-11-27" + }, + "operations":{ + "BatchPutMessage":{ + "name":"BatchPutMessage", + "http":{ + "method":"POST", + "requestUri":"/messages/batch", + "responseCode":200 + }, + "input":{"shape":"BatchPutMessageRequest"}, + "output":{"shape":"BatchPutMessageResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Sends messages to a channel.

" + }, + "CancelPipelineReprocessing":{ + "name":"CancelPipelineReprocessing", + "http":{ + "method":"DELETE", + "requestUri":"/pipelines/{pipelineName}/reprocessing/{reprocessingId}" + }, + "input":{"shape":"CancelPipelineReprocessingRequest"}, + "output":{"shape":"CancelPipelineReprocessingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Cancels the reprocessing of data through the pipeline.

" + }, + "CreateChannel":{ + "name":"CreateChannel", + "http":{ + "method":"POST", + "requestUri":"/channels", + "responseCode":201 + }, + "input":{"shape":"CreateChannelRequest"}, + "output":{"shape":"CreateChannelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a channel. A channel collects data from an MQTT topic and archives the raw, unprocessed messages before publishing the data to a pipeline.

" + }, + "CreateDataset":{ + "name":"CreateDataset", + "http":{ + "method":"POST", + "requestUri":"/datasets", + "responseCode":201 + }, + "input":{"shape":"CreateDatasetRequest"}, + "output":{"shape":"CreateDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a data set. A data set stores data retrieved from a data store by applying a \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application). This operation creates the skeleton of a data set. The data set can be populated manually by calling \"CreateDatasetContent\" or automatically according to a \"trigger\" you specify.

" + }, + "CreateDatasetContent":{ + "name":"CreateDatasetContent", + "http":{ + "method":"POST", + "requestUri":"/datasets/{datasetName}/content" + }, + "input":{"shape":"CreateDatasetContentRequest"}, + "output":{"shape":"CreateDatasetContentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Creates the content of a data set by applying a \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application).

" + }, + "CreateDatastore":{ + "name":"CreateDatastore", + "http":{ + "method":"POST", + "requestUri":"/datastores", + "responseCode":201 + }, + "input":{"shape":"CreateDatastoreRequest"}, + "output":{"shape":"CreateDatastoreResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a data store, which is a repository for messages.

" + }, + "CreatePipeline":{ + "name":"CreatePipeline", + "http":{ + "method":"POST", + "requestUri":"/pipelines", + "responseCode":201 + }, + "input":{"shape":"CreatePipelineRequest"}, + "output":{"shape":"CreatePipelineResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a pipeline. A pipeline consumes messages from a channel and allows you to process the messages before storing them in a data store. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

" + }, + "DeleteChannel":{ + "name":"DeleteChannel", + "http":{ + "method":"DELETE", + "requestUri":"/channels/{channelName}", + "responseCode":204 + }, + "input":{"shape":"DeleteChannelRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the specified channel.

" + }, + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"DELETE", + "requestUri":"/datasets/{datasetName}", + "responseCode":204 + }, + "input":{"shape":"DeleteDatasetRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the specified data set.

You do not have to delete the content of the data set before you perform this operation.

" + }, + "DeleteDatasetContent":{ + "name":"DeleteDatasetContent", + "http":{ + "method":"DELETE", + "requestUri":"/datasets/{datasetName}/content", + "responseCode":204 + }, + "input":{"shape":"DeleteDatasetContentRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the content of the specified data set.

" + }, + "DeleteDatastore":{ + "name":"DeleteDatastore", + "http":{ + "method":"DELETE", + "requestUri":"/datastores/{datastoreName}", + "responseCode":204 + }, + "input":{"shape":"DeleteDatastoreRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the specified data store.

" + }, + "DeletePipeline":{ + "name":"DeletePipeline", + "http":{ + "method":"DELETE", + "requestUri":"/pipelines/{pipelineName}", + "responseCode":204 + }, + "input":{"shape":"DeletePipelineRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the specified pipeline.

" + }, + "DescribeChannel":{ + "name":"DescribeChannel", + "http":{ + "method":"GET", + "requestUri":"/channels/{channelName}" + }, + "input":{"shape":"DescribeChannelRequest"}, + "output":{"shape":"DescribeChannelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves information about a channel.

" + }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"GET", + "requestUri":"/datasets/{datasetName}" + }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves information about a data set.

" + }, + "DescribeDatastore":{ + "name":"DescribeDatastore", + "http":{ + "method":"GET", + "requestUri":"/datastores/{datastoreName}" + }, + "input":{"shape":"DescribeDatastoreRequest"}, + "output":{"shape":"DescribeDatastoreResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves information about a data store.

" + }, + "DescribeLoggingOptions":{ + "name":"DescribeLoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/logging" + }, + "input":{"shape":"DescribeLoggingOptionsRequest"}, + "output":{"shape":"DescribeLoggingOptionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves the current settings of the AWS IoT Analytics logging options.

" + }, + "DescribePipeline":{ + "name":"DescribePipeline", + "http":{ + "method":"GET", + "requestUri":"/pipelines/{pipelineName}" + }, + "input":{"shape":"DescribePipelineRequest"}, + "output":{"shape":"DescribePipelineResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves information about a pipeline.

" + }, + "GetDatasetContent":{ + "name":"GetDatasetContent", + "http":{ + "method":"GET", + "requestUri":"/datasets/{datasetName}/content" + }, + "input":{"shape":"GetDatasetContentRequest"}, + "output":{"shape":"GetDatasetContentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves the contents of a data set as pre-signed URIs.

" + }, + "ListChannels":{ + "name":"ListChannels", + "http":{ + "method":"GET", + "requestUri":"/channels" + }, + "input":{"shape":"ListChannelsRequest"}, + "output":{"shape":"ListChannelsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves a list of channels.

" + }, + "ListDatasetContents":{ + "name":"ListDatasetContents", + "http":{ + "method":"GET", + "requestUri":"/datasets/{datasetName}/contents" + }, + "input":{"shape":"ListDatasetContentsRequest"}, + "output":{"shape":"ListDatasetContentsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists information about data set contents that have been created.

" + }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"GET", + "requestUri":"/datasets" + }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves information about data sets.

" + }, + "ListDatastores":{ + "name":"ListDatastores", + "http":{ + "method":"GET", + "requestUri":"/datastores" + }, + "input":{"shape":"ListDatastoresRequest"}, + "output":{"shape":"ListDatastoresResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves a list of data stores.

" + }, + "ListPipelines":{ + "name":"ListPipelines", + "http":{ + "method":"GET", + "requestUri":"/pipelines" + }, + "input":{"shape":"ListPipelinesRequest"}, + "output":{"shape":"ListPipelinesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves a list of pipelines.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the tags (metadata) which you have assigned to the resource.

" + }, + "PutLoggingOptions":{ + "name":"PutLoggingOptions", + "http":{ + "method":"PUT", + "requestUri":"/logging" + }, + "input":{"shape":"PutLoggingOptionsRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Sets or updates the AWS IoT Analytics logging options.

Note that if you update the value of any loggingOptions field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy) it takes up to 5 minutes for that change to take effect.

" + }, + "RunPipelineActivity":{ + "name":"RunPipelineActivity", + "http":{ + "method":"POST", + "requestUri":"/pipelineactivities/run" + }, + "input":{"shape":"RunPipelineActivityRequest"}, + "output":{"shape":"RunPipelineActivityResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Simulates the results of running a pipeline activity on a message payload.

" + }, + "SampleChannelData":{ + "name":"SampleChannelData", + "http":{ + "method":"GET", + "requestUri":"/channels/{channelName}/sample" + }, + "input":{"shape":"SampleChannelDataRequest"}, + "output":{"shape":"SampleChannelDataResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Retrieves a sample of messages from the specified channel ingested during the specified timeframe. Up to 10 messages can be retrieved.

" + }, + "StartPipelineReprocessing":{ + "name":"StartPipelineReprocessing", + "http":{ + "method":"POST", + "requestUri":"/pipelines/{pipelineName}/reprocessing" + }, + "input":{"shape":"StartPipelineReprocessingRequest"}, + "output":{"shape":"StartPipelineReprocessingResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Starts the reprocessing of raw message data through the pipeline.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes the given tags (metadata) from the resource.

" + }, + "UpdateChannel":{ + "name":"UpdateChannel", + "http":{ + "method":"PUT", + "requestUri":"/channels/{channelName}" + }, + "input":{"shape":"UpdateChannelRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Updates the settings of a channel.

" + }, + "UpdateDataset":{ + "name":"UpdateDataset", + "http":{ + "method":"PUT", + "requestUri":"/datasets/{datasetName}" + }, + "input":{"shape":"UpdateDatasetRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Updates the settings of a data set.

" + }, + "UpdateDatastore":{ + "name":"UpdateDatastore", + "http":{ + "method":"PUT", + "requestUri":"/datastores/{datastoreName}" + }, + "input":{"shape":"UpdateDatastoreRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Updates the settings of a data store.

" + }, + "UpdatePipeline":{ + "name":"UpdatePipeline", + "http":{ + "method":"PUT", + "requestUri":"/pipelines/{pipelineName}" + }, + "input":{"shape":"UpdatePipelineRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Updates the settings of a pipeline. You must specify both a channel and a datastore activity and, optionally, as many as 23 additional activities in the pipelineActivities array.

" + } + }, + "shapes":{ + "ActivityBatchSize":{ + "type":"integer", + "max":1000, + "min":1 + }, + "ActivityName":{ + "type":"string", + "max":128, + "min":1 + }, + "AddAttributesActivity":{ + "type":"structure", + "required":[ + "name", + "attributes" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'addAttributes' activity.

" + }, + "attributes":{ + "shape":"AttributeNameMapping", + "documentation":"

A list of 1-50 \"AttributeNameMapping\" objects that map an existing attribute to a new attribute.

The existing attributes remain in the message, so if you want to remove the originals, use \"RemoveAttributeActivity\".

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that adds other attributes based on existing attributes in the message.

" + }, + "AttributeName":{ + "type":"string", + "max":256, + "min":1 + }, + "AttributeNameMapping":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeName"}, + "max":50, + "min":1 + }, + "AttributeNames":{ + "type":"list", + "member":{"shape":"AttributeName"}, + "max":50, + "min":1 + }, + "BatchPutMessageErrorEntries":{ + "type":"list", + "member":{"shape":"BatchPutMessageErrorEntry"} + }, + "BatchPutMessageErrorEntry":{ + "type":"structure", + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The ID of the message that caused the error. (See the value corresponding to the \"messageId\" key in the message object.)

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The code associated with the error.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The message associated with the error.

" + } + }, + "documentation":"

Contains informations about errors.

" + }, + "BatchPutMessageRequest":{ + "type":"structure", + "required":[ + "channelName", + "messages" + ], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel where the messages are sent.

" + }, + "messages":{ + "shape":"Messages", + "documentation":"

The list of messages to be sent. Each message has format: '{ \"messageId\": \"string\", \"payload\": \"string\"}'.

Note that the field names of message payloads (data) that you send to AWS IoT Analytics:

  • Must contain only alphanumeric characters and undescores (_); no other special characters are allowed.

  • Must begin with an alphabetic character or single underscore (_).

  • Cannot contain hyphens (-).

  • In regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".

  • Cannot be greater than 255 characters.

  • Are case-insensitive. (Fields named \"foo\" and \"FOO\" in the same payload are considered duplicates.)

For example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29}, {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.

" + } + } + }, + "BatchPutMessageResponse":{ + "type":"structure", + "members":{ + "batchPutMessageErrorEntries":{ + "shape":"BatchPutMessageErrorEntries", + "documentation":"

A list of any errors encountered when sending the messages to the channel.

" + } + } + }, + "BucketKeyExpression":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9!_.*'()/{}:-]*$" + }, + "BucketName":{ + "type":"string", + "max":255, + "min":3, + "pattern":"^[a-zA-Z0-9.\\-_]*$" + }, + "CancelPipelineReprocessingRequest":{ + "type":"structure", + "required":[ + "pipelineName", + "reprocessingId" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of pipeline for which data reprocessing is canceled.

", + "location":"uri", + "locationName":"pipelineName" + }, + "reprocessingId":{ + "shape":"ReprocessingId", + "documentation":"

The ID of the reprocessing task (returned by \"StartPipelineReprocessing\").

", + "location":"uri", + "locationName":"reprocessingId" + } + } + }, + "CancelPipelineReprocessingResponse":{ + "type":"structure", + "members":{ + } + }, + "Channel":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ChannelName", + "documentation":"

The name of the channel.

" + }, + "storage":{ + "shape":"ChannelStorage", + "documentation":"

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation of the channel.

" + }, + "arn":{ + "shape":"ChannelArn", + "documentation":"

The ARN of the channel.

" + }, + "status":{ + "shape":"ChannelStatus", + "documentation":"

The status of the channel.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the channel.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the channel was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

When the channel was last updated.

" + } + }, + "documentation":"

A collection of data from an MQTT topic. Channels archive the raw, unprocessed messages before publishing the data to a pipeline.

" + }, + "ChannelActivity":{ + "type":"structure", + "required":[ + "name", + "channelName" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'channel' activity.

" + }, + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel from which the messages are processed.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

The activity that determines the source of the messages to be processed.

" + }, + "ChannelArn":{"type":"string"}, + "ChannelName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "ChannelStatistics":{ + "type":"structure", + "members":{ + "size":{ + "shape":"EstimatedResourceSize", + "documentation":"

The estimated size of the channel.

" + } + }, + "documentation":"

Statistics information about the channel.

" + }, + "ChannelStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING" + ] + }, + "ChannelStorage":{ + "type":"structure", + "members":{ + "serviceManagedS3":{ + "shape":"ServiceManagedChannelS3Storage", + "documentation":"

Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

" + }, + "customerManagedS3":{ + "shape":"CustomerManagedChannelS3Storage", + "documentation":"

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

" + } + }, + "documentation":"

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation of the channel.

" + }, + "ChannelStorageSummary":{ + "type":"structure", + "members":{ + "serviceManagedS3":{ + "shape":"ServiceManagedChannelS3StorageSummary", + "documentation":"

Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.

" + }, + "customerManagedS3":{ + "shape":"CustomerManagedChannelS3StorageSummary", + "documentation":"

Used to store channel data in an S3 bucket that you manage.

" + } + }, + "documentation":"

Where channel data is stored.

" + }, + "ChannelSummaries":{ + "type":"list", + "member":{"shape":"ChannelSummary"} + }, + "ChannelSummary":{ + "type":"structure", + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel.

" + }, + "channelStorage":{ + "shape":"ChannelStorageSummary", + "documentation":"

Where channel data is stored.

" + }, + "status":{ + "shape":"ChannelStatus", + "documentation":"

The status of the channel.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the channel was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the channel was updated.

" + } + }, + "documentation":"

A summary of information about a channel.

" + }, + "ComputeType":{ + "type":"string", + "enum":[ + "ACU_1", + "ACU_2" + ] + }, + "ContainerDatasetAction":{ + "type":"structure", + "required":[ + "image", + "executionRoleArn", + "resourceConfiguration" + ], + "members":{ + "image":{ + "shape":"Image", + "documentation":"

The ARN of the Docker container stored in your account. The Docker container contains an application and needed support libraries and is used to generate data set contents.

" + }, + "executionRoleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which gives permission to the system to access needed resources in order to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set contents which are the input to the containerized application.

" + }, + "resourceConfiguration":{ + "shape":"ResourceConfiguration", + "documentation":"

Configuration of the resource which executes the \"containerAction\".

" + }, + "variables":{ + "shape":"Variables", + "documentation":"

The values of variables used within the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \"outputFileUriValue\".

" + } + }, + "documentation":"

Information needed to run the \"containerAction\" to produce data set contents.

" + }, + "CreateChannelRequest":{ + "type":"structure", + "required":["channelName"], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel.

" + }, + "channelStorage":{ + "shape":"ChannelStorage", + "documentation":"

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation of the channel.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the channel. When \"customerManagedS3\" storage is selected, this parameter is ignored.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the channel.

" + } + } + }, + "CreateChannelResponse":{ + "type":"structure", + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel.

" + }, + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

The ARN of the channel.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the channel.

" + } + } + }, + "CreateDatasetContentRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set.

", + "location":"uri", + "locationName":"datasetName" + } + } + }, + "CreateDatasetContentResponse":{ + "type":"structure", + "members":{ + "versionId":{ + "shape":"DatasetContentVersion", + "documentation":"

The version ID of the data set contents which are being created.

" + } + } + }, + "CreateDatasetRequest":{ + "type":"structure", + "required":[ + "datasetName", + "actions" + ], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set.

" + }, + "actions":{ + "shape":"DatasetActions", + "documentation":"

A list of actions that create the data set contents.

" + }, + "triggers":{ + "shape":"DatasetTriggers", + "documentation":"

A list of triggers. A trigger causes data set contents to be populated at a specified time interval or when another data set's contents are created. The list of triggers can be empty or contain up to five DataSetTrigger objects.

" + }, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"

When data set contents are created they are delivered to destinations specified here.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

[Optional] How long, in days, versions of data set contents are kept for the data set. If not specified or set to null, versions of data set contents are retained for at most 90 days. The number of versions of data set contents retained is determined by the versioningConfiguration parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" + }, + "versioningConfiguration":{ + "shape":"VersioningConfiguration", + "documentation":"

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the \"retentionPeriod\" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the data set.

" + } + } + }, + "CreateDatasetResponse":{ + "type":"structure", + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set.

" + }, + "datasetArn":{ + "shape":"DatasetArn", + "documentation":"

The ARN of the data set.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, data set contents are kept for the data set.

" + } + } + }, + "CreateDatastoreRequest":{ + "type":"structure", + "required":["datastoreName"], + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store.

" + }, + "datastoreStorage":{ + "shape":"DatastoreStorage", + "documentation":"

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data store is created.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage is selected, this parameter is ignored.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the data store.

" + } + } + }, + "CreateDatastoreResponse":{ + "type":"structure", + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store.

" + }, + "datastoreArn":{ + "shape":"DatastoreArn", + "documentation":"

The ARN of the data store.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the data store.

" + } + } + }, + "CreatePipelineRequest":{ + "type":"structure", + "required":[ + "pipelineName", + "pipelineActivities" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline.

" + }, + "pipelineActivities":{ + "shape":"PipelineActivities", + "documentation":"

A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example:

pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

Metadata which can be used to manage the pipeline.

" + } + } + }, + "CreatePipelineResponse":{ + "type":"structure", + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline.

" + }, + "pipelineArn":{ + "shape":"PipelineArn", + "documentation":"

The ARN of the pipeline.

" + } + } + }, + "CustomerManagedChannelS3Storage":{ + "type":"structure", + "required":[ + "bucket", + "roleArn" + ], + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

The name of the Amazon S3 bucket in which channel data is stored.

" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

[Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a '/'.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

" + } + }, + "documentation":"

Use this to store channel data in an S3 bucket that you manage. If customer managed storage is selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

" + }, + "CustomerManagedChannelS3StorageSummary":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

The name of the Amazon S3 bucket in which channel data is stored.

" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

[Optional] The prefix used to create the keys of the channel data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a '/'.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

" + } + }, + "documentation":"

Used to store channel data in an S3 bucket that you manage.

" + }, + "CustomerManagedDatastoreS3Storage":{ + "type":"structure", + "required":[ + "bucket", + "roleArn" + ], + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

The name of the Amazon S3 bucket in which data store data is stored.

" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

[Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a '/'.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

" + } + }, + "documentation":"

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

" + }, + "CustomerManagedDatastoreS3StorageSummary":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

The name of the Amazon S3 bucket in which data store data is stored.

" + }, + "keyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

[Optional] The prefix used to create the keys of the data store data objects. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a '/'.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.

" + } + }, + "documentation":"

Used to store data store data in an S3 bucket that you manage.

" + }, + "Dataset":{ + "type":"structure", + "members":{ + "name":{ + "shape":"DatasetName", + "documentation":"

The name of the data set.

" + }, + "arn":{ + "shape":"DatasetArn", + "documentation":"

The ARN of the data set.

" + }, + "actions":{ + "shape":"DatasetActions", + "documentation":"

The \"DatasetAction\" objects that automatically create the data set contents.

" + }, + "triggers":{ + "shape":"DatasetTriggers", + "documentation":"

The \"DatasetTrigger\" objects that specify when the data set is automatically updated.

" + }, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"

When data set contents are created they are delivered to destinations specified here.

" + }, + "status":{ + "shape":"DatasetStatus", + "documentation":"

The status of the data set.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the data set was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the data set was updated.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

[Optional] How long, in days, message data is kept for the data set.

" + }, + "versioningConfiguration":{ + "shape":"VersioningConfiguration", + "documentation":"

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the \"retentionPeriod\" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" + } + }, + "documentation":"

Information about a data set.

" + }, + "DatasetAction":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"DatasetActionName", + "documentation":"

The name of the data set action by which data set contents are automatically created.

" + }, + "queryAction":{ + "shape":"SqlQueryDatasetAction", + "documentation":"

An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.

" + }, + "containerAction":{ + "shape":"ContainerDatasetAction", + "documentation":"

Information which allows the system to run a containerized application in order to create the data set contents. The application must be in a Docker container along with any needed support libraries.

" + } + }, + "documentation":"

A \"DatasetAction\" object that specifies how data set contents are automatically created.

" + }, + "DatasetActionName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "DatasetActionSummaries":{ + "type":"list", + "member":{"shape":"DatasetActionSummary"}, + "max":1, + "min":1 + }, + "DatasetActionSummary":{ + "type":"structure", + "members":{ + "actionName":{ + "shape":"DatasetActionName", + "documentation":"

The name of the action which automatically creates the data set's contents.

" + }, + "actionType":{ + "shape":"DatasetActionType", + "documentation":"

The type of action by which the data set's contents are automatically created.

" + } + }, + "documentation":"

Information about the action which automatically creates the data set's contents.

" + }, + "DatasetActionType":{ + "type":"string", + "enum":[ + "QUERY", + "CONTAINER" + ] + }, + "DatasetActions":{ + "type":"list", + "member":{"shape":"DatasetAction"}, + "max":1, + "min":1 + }, + "DatasetArn":{"type":"string"}, + "DatasetContentDeliveryDestination":{ + "type":"structure", + "members":{ + "iotEventsDestinationConfiguration":{ + "shape":"IotEventsDestinationConfiguration", + "documentation":"

Configuration information for delivery of data set contents to AWS IoT Events.

" + }, + "s3DestinationConfiguration":{ + "shape":"S3DestinationConfiguration", + "documentation":"

Configuration information for delivery of data set contents to Amazon S3.

" + } + }, + "documentation":"

The destination to which data set contents are delivered.

" + }, + "DatasetContentDeliveryRule":{ + "type":"structure", + "required":["destination"], + "members":{ + "entryName":{ + "shape":"EntryName", + "documentation":"

The name of the data set content delivery rules entry.

" + }, + "destination":{ + "shape":"DatasetContentDeliveryDestination", + "documentation":"

The destination to which data set contents are delivered.

" + } + }, + "documentation":"

When data set contents are created they are delivered to destination specified here.

" + }, + "DatasetContentDeliveryRules":{ + "type":"list", + "member":{"shape":"DatasetContentDeliveryRule"}, + "max":20, + "min":0 + }, + "DatasetContentState":{ + "type":"string", + "enum":[ + "CREATING", + "SUCCEEDED", + "FAILED" + ] + }, + "DatasetContentStatus":{ + "type":"structure", + "members":{ + "state":{ + "shape":"DatasetContentState", + "documentation":"

The state of the data set contents. Can be one of \"READY\", \"CREATING\", \"SUCCEEDED\" or \"FAILED\".

" + }, + "reason":{ + "shape":"Reason", + "documentation":"

The reason the data set contents are in this state.

" + } + }, + "documentation":"

The state of the data set contents and the reason they are in this state.

" + }, + "DatasetContentSummaries":{ + "type":"list", + "member":{"shape":"DatasetContentSummary"} + }, + "DatasetContentSummary":{ + "type":"structure", + "members":{ + "version":{ + "shape":"DatasetContentVersion", + "documentation":"

The version of the data set contents.

" + }, + "status":{ + "shape":"DatasetContentStatus", + "documentation":"

The status of the data set contents.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The actual time the creation of the data set contents was started.

" + }, + "scheduleTime":{ + "shape":"Timestamp", + "documentation":"

The time the creation of the data set contents was scheduled to start.

" + }, + "completionTime":{ + "shape":"Timestamp", + "documentation":"

The time the dataset content status was updated to SUCCEEDED or FAILED.

" + } + }, + "documentation":"

Summary information about data set contents.

" + }, + "DatasetContentVersion":{ + "type":"string", + "max":36, + "min":7 + }, + "DatasetContentVersionValue":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose latest contents are used as input to the notebook or application.

" + } + }, + "documentation":"

The data set whose latest contents are used as input to the notebook or application.

" + }, + "DatasetEntries":{ + "type":"list", + "member":{"shape":"DatasetEntry"} + }, + "DatasetEntry":{ + "type":"structure", + "members":{ + "entryName":{ + "shape":"EntryName", + "documentation":"

The name of the data set item.

" + }, + "dataURI":{ + "shape":"PresignedURI", + "documentation":"

The pre-signed URI of the data set item.

" + } + }, + "documentation":"

The reference to a data set entry.

" + }, + "DatasetName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "DatasetStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING" + ] + }, + "DatasetSummaries":{ + "type":"list", + "member":{"shape":"DatasetSummary"} + }, + "DatasetSummary":{ + "type":"structure", + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set.

" + }, + "status":{ + "shape":"DatasetStatus", + "documentation":"

The status of the data set.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the data set was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the data set was updated.

" + }, + "triggers":{ + "shape":"DatasetTriggers", + "documentation":"

A list of triggers. A trigger causes data set content to be populated at a specified time interval or when another data set is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects

" + }, + "actions":{ + "shape":"DatasetActionSummaries", + "documentation":"

A list of \"DataActionSummary\" objects.

" + } + }, + "documentation":"

A summary of information about a data set.

" + }, + "DatasetTrigger":{ + "type":"structure", + "members":{ + "schedule":{ + "shape":"Schedule", + "documentation":"

The \"Schedule\" when the trigger is initiated.

" + }, + "dataset":{ + "shape":"TriggeringDataset", + "documentation":"

The data set whose content creation triggers the creation of this data set's contents.

" + } + }, + "documentation":"

The \"DatasetTrigger\" that specifies when the data set is automatically updated.

" + }, + "DatasetTriggers":{ + "type":"list", + "member":{"shape":"DatasetTrigger"}, + "max":5, + "min":0 + }, + "Datastore":{ + "type":"structure", + "members":{ + "name":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store.

" + }, + "storage":{ + "shape":"DatastoreStorage", + "documentation":"

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data store is created.

" + }, + "arn":{ + "shape":"DatastoreArn", + "documentation":"

The ARN of the data store.

" + }, + "status":{ + "shape":"DatastoreStatus", + "documentation":"

The status of a data store:

CREATING

The data store is being created.

ACTIVE

The data store has been created and can be used.

DELETING

The data store is being deleted.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage is selected, this parameter is ignored.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the data store was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the data store was updated.

" + } + }, + "documentation":"

Information about a data store.

" + }, + "DatastoreActivity":{ + "type":"structure", + "required":[ + "name", + "datastoreName" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'datastore' activity.

" + }, + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store where processed messages are stored.

" + } + }, + "documentation":"

The 'datastore' activity that specifies where to store the processed data.

" + }, + "DatastoreArn":{"type":"string"}, + "DatastoreName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "DatastoreStatistics":{ + "type":"structure", + "members":{ + "size":{ + "shape":"EstimatedResourceSize", + "documentation":"

The estimated size of the data store.

" + } + }, + "documentation":"

Statistical information about the data store.

" + }, + "DatastoreStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING" + ] + }, + "DatastoreStorage":{ + "type":"structure", + "members":{ + "serviceManagedS3":{ + "shape":"ServiceManagedDatastoreS3Storage", + "documentation":"

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

" + }, + "customerManagedS3":{ + "shape":"CustomerManagedDatastoreS3Storage", + "documentation":"

Use this to store data store data in an S3 bucket that you manage. When customer managed storage is selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

" + } + }, + "documentation":"

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data store is created.

" + }, + "DatastoreStorageSummary":{ + "type":"structure", + "members":{ + "serviceManagedS3":{ + "shape":"ServiceManagedDatastoreS3StorageSummary", + "documentation":"

Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

" + }, + "customerManagedS3":{ + "shape":"CustomerManagedDatastoreS3StorageSummary", + "documentation":"

Used to store data store data in an S3 bucket that you manage.

" + } + }, + "documentation":"

Where data store data is stored.

" + }, + "DatastoreSummaries":{ + "type":"list", + "member":{"shape":"DatastoreSummary"} + }, + "DatastoreSummary":{ + "type":"structure", + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store.

" + }, + "datastoreStorage":{ + "shape":"DatastoreStorageSummary", + "documentation":"

Where data store data is stored.

" + }, + "status":{ + "shape":"DatastoreStatus", + "documentation":"

The status of the data store.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the data store was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the data store was updated.

" + } + }, + "documentation":"

A summary of information about a data store.

" + }, + "DeleteChannelRequest":{ + "type":"structure", + "required":["channelName"], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel to delete.

", + "location":"uri", + "locationName":"channelName" + } + } + }, + "DeleteDatasetContentRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose content is deleted.

", + "location":"uri", + "locationName":"datasetName" + }, + "versionId":{ + "shape":"DatasetContentVersion", + "documentation":"

The version of the data set whose content is deleted. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to delete the latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.

", + "location":"querystring", + "locationName":"versionId" + } + } + }, + "DeleteDatasetRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set to delete.

", + "location":"uri", + "locationName":"datasetName" + } + } + }, + "DeleteDatastoreRequest":{ + "type":"structure", + "required":["datastoreName"], + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store to delete.

", + "location":"uri", + "locationName":"datastoreName" + } + } + }, + "DeletePipelineRequest":{ + "type":"structure", + "required":["pipelineName"], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline to delete.

", + "location":"uri", + "locationName":"pipelineName" + } + } + }, + "DeltaTime":{ + "type":"structure", + "required":[ + "offsetSeconds", + "timeExpression" + ], + "members":{ + "offsetSeconds":{ + "shape":"OffsetSeconds", + "documentation":"

The number of seconds of estimated \"in flight\" lag time of message data. When you create data set contents using message data from a specified time frame, some message data may still be \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this field to make allowances for the \"in flight\" time of your message data, so that data not processed from a previous time frame will be included with the next time frame. Without this, missed message data would be excluded from processing during the next time frame as well, because its timestamp places it within the previous time frame.

" + }, + "timeExpression":{ + "shape":"TimeExpression", + "documentation":"

An expression by which the time of the message data may be determined. This may be the name of a timestamp field, or a SQL expression which is used to derive the time the message data was generated.

" + } + }, + "documentation":"

Used to limit data to that which has arrived since the last execution of the action.

" + }, + "DescribeChannelRequest":{ + "type":"structure", + "required":["channelName"], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel whose information is retrieved.

", + "location":"uri", + "locationName":"channelName" + }, + "includeStatistics":{ + "shape":"IncludeStatisticsFlag", + "documentation":"

If true, additional statistical information about the channel is included in the response. This feature cannot be used with a channel whose S3 storage is customer-managed.

", + "location":"querystring", + "locationName":"includeStatistics" + } + } + }, + "DescribeChannelResponse":{ + "type":"structure", + "members":{ + "channel":{ + "shape":"Channel", + "documentation":"

An object that contains information about the channel.

" + }, + "statistics":{ + "shape":"ChannelStatistics", + "documentation":"

Statistics about the channel. Included if the 'includeStatistics' parameter is set to true in the request.

" + } + } + }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose information is retrieved.

", + "location":"uri", + "locationName":"datasetName" + } + } + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "dataset":{ + "shape":"Dataset", + "documentation":"

An object that contains information about the data set.

" + } + } + }, + "DescribeDatastoreRequest":{ + "type":"structure", + "required":["datastoreName"], + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store

", + "location":"uri", + "locationName":"datastoreName" + }, + "includeStatistics":{ + "shape":"IncludeStatisticsFlag", + "documentation":"

If true, additional statistical information about the data store is included in the response. This feature cannot be used with a data store whose S3 storage is customer-managed.

", + "location":"querystring", + "locationName":"includeStatistics" + } + } + }, + "DescribeDatastoreResponse":{ + "type":"structure", + "members":{ + "datastore":{ + "shape":"Datastore", + "documentation":"

Information about the data store.

" + }, + "statistics":{ + "shape":"DatastoreStatistics", + "documentation":"

Additional statistical information about the data store. Included if the 'includeStatistics' parameter is set to true in the request.

" + } + } + }, + "DescribeLoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeLoggingOptionsResponse":{ + "type":"structure", + "members":{ + "loggingOptions":{ + "shape":"LoggingOptions", + "documentation":"

The current settings of the AWS IoT Analytics logging options.

" + } + } + }, + "DescribePipelineRequest":{ + "type":"structure", + "required":["pipelineName"], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline whose information is retrieved.

", + "location":"uri", + "locationName":"pipelineName" + } + } + }, + "DescribePipelineResponse":{ + "type":"structure", + "members":{ + "pipeline":{ + "shape":"Pipeline", + "documentation":"

A \"Pipeline\" object that contains information about the pipeline.

" + } + } + }, + "DeviceRegistryEnrichActivity":{ + "type":"structure", + "required":[ + "name", + "attribute", + "thingName", + "roleArn" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'deviceRegistryEnrich' activity.

" + }, + "attribute":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute that is added to the message.

" + }, + "thingName":{ + "shape":"AttributeName", + "documentation":"

The name of the IoT device whose registry information is added to the message.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that allows access to the device's registry information.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that adds data from the AWS IoT device registry to your message.

" + }, + "DeviceShadowEnrichActivity":{ + "type":"structure", + "required":[ + "name", + "attribute", + "thingName", + "roleArn" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'deviceShadowEnrich' activity.

" + }, + "attribute":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute that is added to the message.

" + }, + "thingName":{ + "shape":"AttributeName", + "documentation":"

The name of the IoT device whose shadow information is added to the message.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that allows access to the device's shadow.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that adds information from the AWS IoT Device Shadows service to a message.

" + }, + "DoubleValue":{"type":"double"}, + "EndTime":{"type":"timestamp"}, + "EntryName":{"type":"string"}, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "EstimatedResourceSize":{ + "type":"structure", + "members":{ + "estimatedSizeInBytes":{ + "shape":"SizeInBytes", + "documentation":"

The estimated size of the resource in bytes.

" + }, + "estimatedOn":{ + "shape":"Timestamp", + "documentation":"

The time when the estimate of the size of the resource was made.

" + } + }, + "documentation":"

The estimated size of the resource.

" + }, + "FilterActivity":{ + "type":"structure", + "required":[ + "name", + "filter" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'filter' activity.

" + }, + "filter":{ + "shape":"FilterExpression", + "documentation":"

An expression that looks like a SQL WHERE clause that must return a Boolean value.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that filters a message based on its attributes.

" + }, + "FilterExpression":{ + "type":"string", + "max":256, + "min":1 + }, + "GetDatasetContentRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose contents are retrieved.

", + "location":"uri", + "locationName":"datasetName" + }, + "versionId":{ + "shape":"DatasetContentVersion", + "documentation":"

The version of the data set whose contents are retrieved. You can also use the strings \"$LATEST\" or \"$LATEST_SUCCEEDED\" to retrieve the contents of the latest or latest successfully completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.

", + "location":"querystring", + "locationName":"versionId" + } + } + }, + "GetDatasetContentResponse":{ + "type":"structure", + "members":{ + "entries":{ + "shape":"DatasetEntries", + "documentation":"

A list of \"DatasetEntry\" objects.

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

The time when the request was made.

" + }, + "status":{ + "shape":"DatasetContentStatus", + "documentation":"

The status of the data set content.

" + } + } + }, + "GlueConfiguration":{ + "type":"structure", + "required":[ + "tableName", + "databaseName" + ], + "members":{ + "tableName":{ + "shape":"GlueTableName", + "documentation":"

The name of the table in your AWS Glue Data Catalog which is used to perform the ETL (extract, transform and load) operations. (An AWS Glue Data Catalog table contains partitioned data and descriptions of data sources and targets.)

" + }, + "databaseName":{ + "shape":"GlueDatabaseName", + "documentation":"

The name of the database in your AWS Glue Data Catalog in which the table is located. (An AWS Glue Data Catalog database contains Glue Data tables.)

" + } + }, + "documentation":"

Configuration information for coordination with the AWS Glue ETL (extract, transform and load) service.

" + }, + "GlueDatabaseName":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "GlueTableName":{ + "type":"string", + "max":150, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "Image":{ + "type":"string", + "max":255 + }, + "IncludeStatisticsFlag":{"type":"boolean"}, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

There was an internal failure.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The request was not valid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IotEventsDestinationConfiguration":{ + "type":"structure", + "required":[ + "inputName", + "roleArn" + ], + "members":{ + "inputName":{ + "shape":"IotEventsInputName", + "documentation":"

The name of the AWS IoT Events input to which data set contents are delivered.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents to an AWS IoT Events input.

" + } + }, + "documentation":"

Configuration information for delivery of data set contents to AWS IoT Events.

" + }, + "IotEventsInputName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "LambdaActivity":{ + "type":"structure", + "required":[ + "name", + "lambdaName", + "batchSize" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'lambda' activity.

" + }, + "lambdaName":{ + "shape":"LambdaName", + "documentation":"

The name of the Lambda function that is run on the message.

" + }, + "batchSize":{ + "shape":"ActivityBatchSize", + "documentation":"

The number of messages passed to the Lambda function for processing.

The AWS Lambda function must be able to process all of these messages within five minutes, which is the maximum timeout duration for Lambda functions.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that runs a Lambda function to modify the message.

" + }, + "LambdaName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The command caused an internal limit to be exceeded.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "ListChannelsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in this request.

The default value is 100.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListChannelsResponse":{ + "type":"structure", + "members":{ + "channelSummaries":{ + "shape":"ChannelSummaries", + "documentation":"

A list of \"ChannelSummary\" objects.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results, or null if there are no more results.

" + } + } + }, + "ListDatasetContentsRequest":{ + "type":"structure", + "required":["datasetName"], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose contents information you want to list.

", + "location":"uri", + "locationName":"datasetName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in this request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "scheduledOnOrAfter":{ + "shape":"Timestamp", + "documentation":"

A filter to limit results to those data set contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

", + "location":"querystring", + "locationName":"scheduledOnOrAfter" + }, + "scheduledBefore":{ + "shape":"Timestamp", + "documentation":"

A filter to limit results to those data set contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)

", + "location":"querystring", + "locationName":"scheduledBefore" + } + } + }, + "ListDatasetContentsResponse":{ + "type":"structure", + "members":{ + "datasetContentSummaries":{ + "shape":"DatasetContentSummaries", + "documentation":"

Summary information about data set contents that have been created.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results, or null if there are no more results.

" + } + } + }, + "ListDatasetsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in this request.

The default value is 100.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "datasetSummaries":{ + "shape":"DatasetSummaries", + "documentation":"

A list of \"DatasetSummary\" objects.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results, or null if there are no more results.

" + } + } + }, + "ListDatastoresRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in this request.

The default value is 100.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDatastoresResponse":{ + "type":"structure", + "members":{ + "datastoreSummaries":{ + "shape":"DatastoreSummaries", + "documentation":"

A list of \"DatastoreSummary\" objects.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results, or null if there are no more results.

" + } + } + }, + "ListPipelinesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in this request.

The default value is 100.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListPipelinesResponse":{ + "type":"structure", + "members":{ + "pipelineSummaries":{ + "shape":"PipelineSummaries", + "documentation":"

A list of \"PipelineSummary\" objects.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to retrieve the next set of results, or null if there are no more results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource whose tags you want to list.

", + "location":"querystring", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

The tags (metadata) which you have assigned to the resource.

" + } + } + }, + "LogResult":{"type":"string"}, + "LoggingEnabled":{"type":"boolean"}, + "LoggingLevel":{ + "type":"string", + "enum":["ERROR"] + }, + "LoggingOptions":{ + "type":"structure", + "required":[ + "roleArn", + "level", + "enabled" + ], + "members":{ + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that grants permission to AWS IoT Analytics to perform logging.

" + }, + "level":{ + "shape":"LoggingLevel", + "documentation":"

The logging level. Currently, only \"ERROR\" is supported.

" + }, + "enabled":{ + "shape":"LoggingEnabled", + "documentation":"

If true, logging is enabled for AWS IoT Analytics.

" + } + }, + "documentation":"

Information about logging options.

" + }, + "MathActivity":{ + "type":"structure", + "required":[ + "name", + "attribute", + "math" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'math' activity.

" + }, + "attribute":{ + "shape":"AttributeName", + "documentation":"

The name of the attribute that contains the result of the math operation.

" + }, + "math":{ + "shape":"MathExpression", + "documentation":"

An expression that uses one or more existing attributes and must return an integer value.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that computes an arithmetic expression using the message's attributes.

" + }, + "MathExpression":{ + "type":"string", + "max":256, + "min":1 + }, + "MaxMessages":{ + "type":"integer", + "max":10, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "MaxVersions":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Message":{ + "type":"structure", + "required":[ + "messageId", + "payload" + ], + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The ID you wish to assign to the message. Each \"messageId\" must be unique within each batch sent.

" + }, + "payload":{ + "shape":"MessagePayload", + "documentation":"

The payload of the message. This may be a JSON string or a Base64-encoded string representing binary data (in which case you must decode it by means of a pipeline activity).

" + } + }, + "documentation":"

Information about a message.

" + }, + "MessageId":{ + "type":"string", + "max":128, + "min":1 + }, + "MessagePayload":{"type":"blob"}, + "MessagePayloads":{ + "type":"list", + "member":{"shape":"MessagePayload"}, + "max":10, + "min":1 + }, + "Messages":{ + "type":"list", + "member":{"shape":"Message"} + }, + "NextToken":{"type":"string"}, + "OffsetSeconds":{"type":"integer"}, + "OutputFileName":{ + "type":"string", + "pattern":"[\\w\\.-]{1,255}" + }, + "OutputFileUriValue":{ + "type":"structure", + "required":["fileName"], + "members":{ + "fileName":{ + "shape":"OutputFileName", + "documentation":"

The URI of the location where data set contents are stored, usually the URI of a file in an S3 bucket.

" + } + }, + "documentation":"

The value of the variable as a structure that specifies an output file URI.

" + }, + "Pipeline":{ + "type":"structure", + "members":{ + "name":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline.

" + }, + "arn":{ + "shape":"PipelineArn", + "documentation":"

The ARN of the pipeline.

" + }, + "activities":{ + "shape":"PipelineActivities", + "documentation":"

The activities that perform transformations on the messages.

" + }, + "reprocessingSummaries":{ + "shape":"ReprocessingSummaries", + "documentation":"

A summary of information about the pipeline reprocessing.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the pipeline was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the pipeline was updated.

" + } + }, + "documentation":"

Contains information about a pipeline.

" + }, + "PipelineActivities":{ + "type":"list", + "member":{"shape":"PipelineActivity"}, + "max":25, + "min":1 + }, + "PipelineActivity":{ + "type":"structure", + "members":{ + "channel":{ + "shape":"ChannelActivity", + "documentation":"

Determines the source of the messages to be processed.

" + }, + "lambda":{ + "shape":"LambdaActivity", + "documentation":"

Runs a Lambda function to modify the message.

" + }, + "datastore":{ + "shape":"DatastoreActivity", + "documentation":"

Specifies where to store the processed message data.

" + }, + "addAttributes":{ + "shape":"AddAttributesActivity", + "documentation":"

Adds other attributes based on existing attributes in the message.

" + }, + "removeAttributes":{ + "shape":"RemoveAttributesActivity", + "documentation":"

Removes attributes from a message.

" + }, + "selectAttributes":{ + "shape":"SelectAttributesActivity", + "documentation":"

Creates a new message using only the specified attributes from the original message.

" + }, + "filter":{ + "shape":"FilterActivity", + "documentation":"

Filters a message based on its attributes.

" + }, + "math":{ + "shape":"MathActivity", + "documentation":"

Computes an arithmetic expression using the message's attributes and adds it to the message.

" + }, + "deviceRegistryEnrich":{ + "shape":"DeviceRegistryEnrichActivity", + "documentation":"

Adds data from the AWS IoT device registry to your message.

" + }, + "deviceShadowEnrich":{ + "shape":"DeviceShadowEnrichActivity", + "documentation":"

Adds information from the AWS IoT Device Shadows service to a message.

" + } + }, + "documentation":"

An activity that performs a transformation on a message.

" + }, + "PipelineArn":{"type":"string"}, + "PipelineName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_]+$" + }, + "PipelineSummaries":{ + "type":"list", + "member":{"shape":"PipelineSummary"} + }, + "PipelineSummary":{ + "type":"structure", + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline.

" + }, + "reprocessingSummaries":{ + "shape":"ReprocessingSummaries", + "documentation":"

A summary of information about the pipeline reprocessing.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

When the pipeline was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

When the pipeline was last updated.

" + } + }, + "documentation":"

A summary of information about a pipeline.

" + }, + "PresignedURI":{"type":"string"}, + "PutLoggingOptionsRequest":{ + "type":"structure", + "required":["loggingOptions"], + "members":{ + "loggingOptions":{ + "shape":"LoggingOptions", + "documentation":"

The new values of the AWS IoT Analytics logging options.

" + } + } + }, + "QueryFilter":{ + "type":"structure", + "members":{ + "deltaTime":{ + "shape":"DeltaTime", + "documentation":"

Used to limit data to that which has arrived since the last execution of the action.

" + } + }, + "documentation":"

Information which is used to filter message data, to segregate it according to the time frame in which it arrives.

" + }, + "QueryFilters":{ + "type":"list", + "member":{"shape":"QueryFilter"}, + "max":1, + "min":0 + }, + "Reason":{"type":"string"}, + "RemoveAttributesActivity":{ + "type":"structure", + "required":[ + "name", + "attributes" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'removeAttributes' activity.

" + }, + "attributes":{ + "shape":"AttributeNames", + "documentation":"

A list of 1-50 attributes to remove from the message.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

An activity that removes attributes from a message.

" + }, + "ReprocessingId":{"type":"string"}, + "ReprocessingStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "CANCELLED", + "FAILED" + ] + }, + "ReprocessingSummaries":{ + "type":"list", + "member":{"shape":"ReprocessingSummary"} + }, + "ReprocessingSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"ReprocessingId", + "documentation":"

The 'reprocessingId' returned by \"StartPipelineReprocessing\".

" + }, + "status":{ + "shape":"ReprocessingStatus", + "documentation":"

The status of the pipeline reprocessing.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the pipeline reprocessing was created.

" + } + }, + "documentation":"

Information about pipeline reprocessing.

" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"}, + "resourceId":{ + "shape":"resourceId", + "documentation":"

The ID of the resource.

" + }, + "resourceArn":{ + "shape":"resourceArn", + "documentation":"

The ARN of the resource.

" + } + }, + "documentation":"

A resource with the same name already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "ResourceConfiguration":{ + "type":"structure", + "required":[ + "computeType", + "volumeSizeInGB" + ], + "members":{ + "computeType":{ + "shape":"ComputeType", + "documentation":"

The type of the compute resource used to execute the \"containerAction\". Possible values are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).

" + }, + "volumeSizeInGB":{ + "shape":"VolumeSizeInGB", + "documentation":"

The size (in GB) of the persistent storage available to the resource instance used to execute the \"containerAction\" (min: 1, max: 50).

" + } + }, + "documentation":"

The configuration of the resource used to execute the \"containerAction\".

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

A resource with the specified name could not be found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RetentionPeriod":{ + "type":"structure", + "members":{ + "unlimited":{ + "shape":"UnlimitedRetentionPeriod", + "documentation":"

If true, message data is kept indefinitely.

" + }, + "numberOfDays":{ + "shape":"RetentionPeriodInDays", + "documentation":"

The number of days that message data is kept. The \"unlimited\" parameter must be false.

" + } + }, + "documentation":"

How long, in days, message data is kept.

" + }, + "RetentionPeriodInDays":{ + "type":"integer", + "min":1 + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "RunPipelineActivityRequest":{ + "type":"structure", + "required":[ + "pipelineActivity", + "payloads" + ], + "members":{ + "pipelineActivity":{ + "shape":"PipelineActivity", + "documentation":"

The pipeline activity that is run. This must not be a 'channel' activity or a 'datastore' activity because these activities are used in a pipeline only to load the original message and to store the (possibly) transformed message. If a 'lambda' activity is specified, only short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be used.

" + }, + "payloads":{ + "shape":"MessagePayloads", + "documentation":"

The sample message payloads on which the pipeline activity is run.

" + } + } + }, + "RunPipelineActivityResponse":{ + "type":"structure", + "members":{ + "payloads":{ + "shape":"MessagePayloads", + "documentation":"

The enriched or transformed sample message payloads as base64-encoded strings. (The results of running the pipeline activity on each input sample message payload, encoded in base64.)

" + }, + "logResult":{ + "shape":"LogResult", + "documentation":"

In case the pipeline activity fails, the log message that is generated.

" + } + } + }, + "S3DestinationConfiguration":{ + "type":"structure", + "required":[ + "bucket", + "key", + "roleArn" + ], + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

The name of the Amazon S3 bucket to which data set contents are delivered.

" + }, + "key":{ + "shape":"BucketKeyExpression", + "documentation":"

The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). To produce a unique key, you can use \"!{iotanalytics:scheduledTime}\" to insert the time of the scheduled SQL query run, or \"!{iotanalytics:versioned} to insert a unique hash identifying the data set, for example: \"/DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv\".

" + }, + "glueConfiguration":{ + "shape":"GlueConfiguration", + "documentation":"

Configuration information for coordination with the AWS Glue ETL (extract, transform and load) service.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

" + } + }, + "documentation":"

Configuration information for delivery of data set contents to Amazon S3.

" + }, + "S3KeyPrefix":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9!_.*'()/{}:-]*/$" + }, + "SampleChannelDataRequest":{ + "type":"structure", + "required":["channelName"], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel whose message samples are retrieved.

", + "location":"uri", + "locationName":"channelName" + }, + "maxMessages":{ + "shape":"MaxMessages", + "documentation":"

The number of sample messages to be retrieved. The limit is 10, the default is also 10.

", + "location":"querystring", + "locationName":"maxMessages" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"

The start of the time window from which sample messages are retrieved.

", + "location":"querystring", + "locationName":"startTime" + }, + "endTime":{ + "shape":"EndTime", + "documentation":"

The end of the time window from which sample messages are retrieved.

", + "location":"querystring", + "locationName":"endTime" + } + } + }, + "SampleChannelDataResponse":{ + "type":"structure", + "members":{ + "payloads":{ + "shape":"MessagePayloads", + "documentation":"

The list of message samples. Each sample message is returned as a base64-encoded string.

" + } + } + }, + "Schedule":{ + "type":"structure", + "members":{ + "expression":{ + "shape":"ScheduleExpression", + "documentation":"

The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.

" + } + }, + "documentation":"

The schedule for when to trigger an update.

" + }, + "ScheduleExpression":{"type":"string"}, + "SelectAttributesActivity":{ + "type":"structure", + "required":[ + "name", + "attributes" + ], + "members":{ + "name":{ + "shape":"ActivityName", + "documentation":"

The name of the 'selectAttributes' activity.

" + }, + "attributes":{ + "shape":"AttributeNames", + "documentation":"

A list of the attributes to select from the message.

" + }, + "next":{ + "shape":"ActivityName", + "documentation":"

The next activity in the pipeline.

" + } + }, + "documentation":"

Creates a new message using only the specified attributes from the original message.

" + }, + "ServiceManagedChannelS3Storage":{ + "type":"structure", + "members":{ + }, + "documentation":"

Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the channel.

" + }, + "ServiceManagedChannelS3StorageSummary":{ + "type":"structure", + "members":{ + }, + "documentation":"

Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.

" + }, + "ServiceManagedDatastoreS3Storage":{ + "type":"structure", + "members":{ + }, + "documentation":"

Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service. The choice of service-managed or customer-managed S3 storage cannot be changed after creation of the data store.

" + }, + "ServiceManagedDatastoreS3StorageSummary":{ + "type":"structure", + "members":{ + }, + "documentation":"

Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The service is temporarily unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SizeInBytes":{"type":"double"}, + "SqlQuery":{"type":"string"}, + "SqlQueryDatasetAction":{ + "type":"structure", + "required":["sqlQuery"], + "members":{ + "sqlQuery":{ + "shape":"SqlQuery", + "documentation":"

A SQL query string.

" + }, + "filters":{ + "shape":"QueryFilters", + "documentation":"

Pre-filters applied to message data.

" + } + }, + "documentation":"

The SQL query to modify the message.

" + }, + "StartPipelineReprocessingRequest":{ + "type":"structure", + "required":["pipelineName"], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline on which to start reprocessing.

", + "location":"uri", + "locationName":"pipelineName" + }, + "startTime":{ + "shape":"StartTime", + "documentation":"

The start time (inclusive) of raw message data that is reprocessed.

" + }, + "endTime":{ + "shape":"EndTime", + "documentation":"

The end time (exclusive) of raw message data that is reprocessed.

" + } + } + }, + "StartPipelineReprocessingResponse":{ + "type":"structure", + "members":{ + "reprocessingId":{ + "shape":"ReprocessingId", + "documentation":"

The ID of the pipeline reprocessing activity that was started.

" + } + } + }, + "StartTime":{"type":"timestamp"}, + "StringValue":{ + "type":"string", + "max":1024, + "min":0 + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The tag's key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

A set of key/value pairs which are used to manage the resource.

" + }, + "TagKey":{ + "type":"string", + "max":256, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource whose tags you want to modify.

", + "location":"querystring", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The new or modified tags for the resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The request was denied due to request throttling.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimeExpression":{"type":"string"}, + "Timestamp":{"type":"timestamp"}, + "TriggeringDataset":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DatasetName", + "documentation":"

The name of the data set whose content generation triggers the new data set content generation.

" + } + }, + "documentation":"

Information about the data set whose content generation triggers the new data set content generation.

" + }, + "UnlimitedRetentionPeriod":{"type":"boolean"}, + "UnlimitedVersioning":{"type":"boolean"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource whose tags you want to remove.

", + "location":"querystring", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The keys of those tags which you want to remove.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateChannelRequest":{ + "type":"structure", + "required":["channelName"], + "members":{ + "channelName":{ + "shape":"ChannelName", + "documentation":"

The name of the channel to be updated.

", + "location":"uri", + "locationName":"channelName" + }, + "channelStorage":{ + "shape":"ChannelStorage", + "documentation":"

Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation of the channel.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the channel. The retention period cannot be updated if the channel's S3 storage is customer-managed.

" + } + } + }, + "UpdateDatasetRequest":{ + "type":"structure", + "required":[ + "datasetName", + "actions" + ], + "members":{ + "datasetName":{ + "shape":"DatasetName", + "documentation":"

The name of the data set to update.

", + "location":"uri", + "locationName":"datasetName" + }, + "actions":{ + "shape":"DatasetActions", + "documentation":"

A list of \"DatasetAction\" objects.

" + }, + "triggers":{ + "shape":"DatasetTriggers", + "documentation":"

A list of \"DatasetTrigger\" objects. The list can be empty or can contain up to five DataSetTrigger objects.

" + }, + "contentDeliveryRules":{ + "shape":"DatasetContentDeliveryRules", + "documentation":"

When data set contents are created they are delivered to destinations specified here.

" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, data set contents are kept for the data set.

" + }, + "versioningConfiguration":{ + "shape":"VersioningConfiguration", + "documentation":"

[Optional] How many versions of data set contents are kept. If not specified or set to null, only the latest version plus the latest succeeded version (if they are different) are kept for the time period specified by the \"retentionPeriod\" parameter. (For more information, see https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)

" + } + } + }, + "UpdateDatastoreRequest":{ + "type":"structure", + "required":["datastoreName"], + "members":{ + "datastoreName":{ + "shape":"DatastoreName", + "documentation":"

The name of the data store to be updated.

", + "location":"uri", + "locationName":"datastoreName" + }, + "retentionPeriod":{ + "shape":"RetentionPeriod", + "documentation":"

How long, in days, message data is kept for the data store. The retention period cannot be updated if the data store's S3 storage is customer-managed.

" + }, + "datastoreStorage":{ + "shape":"DatastoreStorage", + "documentation":"

Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data store is created.

" + } + } + }, + "UpdatePipelineRequest":{ + "type":"structure", + "required":[ + "pipelineName", + "pipelineActivities" + ], + "members":{ + "pipelineName":{ + "shape":"PipelineName", + "documentation":"

The name of the pipeline to update.

", + "location":"uri", + "locationName":"pipelineName" + }, + "pipelineActivities":{ + "shape":"PipelineActivities", + "documentation":"

A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, such as removing, renaming or adding message attributes; filtering messages based on attribute values; invoking your Lambda functions on messages for advanced processing; or performing mathematical transformations to normalize device data.

The list can be 2-25 PipelineActivity objects and must contain both a channel and a datastore activity. Each entry in the list must contain only one activity, for example:

pipelineActivities = [ { \"channel\": { ... } }, { \"lambda\": { ... } }, ... ]

" + } + } + }, + "Variable":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"VariableName", + "documentation":"

The name of the variable.

" + }, + "stringValue":{ + "shape":"StringValue", + "documentation":"

The value of the variable as a string.

" + }, + "doubleValue":{ + "shape":"DoubleValue", + "documentation":"

The value of the variable as a double (numeric).

", + "box":true + }, + "datasetContentVersionValue":{ + "shape":"DatasetContentVersionValue", + "documentation":"

The value of the variable as a structure that specifies a data set content version.

" + }, + "outputFileUriValue":{ + "shape":"OutputFileUriValue", + "documentation":"

The value of the variable as a structure that specifies an output file URI.

" + } + }, + "documentation":"

An instance of a variable to be passed to the \"containerAction\" execution. Each variable must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \"outputFileUriValue\".

" + }, + "VariableName":{ + "type":"string", + "max":256, + "min":1 + }, + "Variables":{ + "type":"list", + "member":{"shape":"Variable"}, + "max":50, + "min":0 + }, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "unlimited":{ + "shape":"UnlimitedVersioning", + "documentation":"

If true, unlimited versions of data set contents will be kept.

" + }, + "maxVersions":{ + "shape":"MaxVersions", + "documentation":"

How many versions of data set contents will be kept. The \"unlimited\" parameter must be false.

" + } + }, + "documentation":"

Information about the versioning of data set contents.

" + }, + "VolumeSizeInGB":{ + "type":"integer", + "max":50, + "min":1 + }, + "errorMessage":{"type":"string"}, + "resourceArn":{"type":"string"}, + "resourceId":{"type":"string"} + }, + "documentation":"

AWS IoT Analytics allows you to collect large amounts of device data, process messages, and store them. You can then query the data and run sophisticated analytics on it. AWS IoT Analytics enables advanced data exploration through integration with Jupyter Notebooks and data visualization through integration with Amazon QuickSight.

Traditional analytics and business intelligence tools are designed to process structured data. IoT data often comes from devices that record noisy processes (such as temperature, motion, or sound). As a result the data from these devices can have significant gaps, corrupted messages, and false readings that must be cleaned up before analysis can occur. Also, IoT data is often only meaningful in the context of other data from external sources.

AWS IoT Analytics automates the steps required to analyze data from IoT devices. AWS IoT Analytics filters, transforms, and enriches IoT data before storing it in a time-series data store for analysis. You can set up the service to collect only the data you need from your devices, apply mathematical transforms to process the data, and enrich the data with device-specific metadata such as device type and location before storing it. Then, you can analyze your data by running queries using the built-in SQL query engine, or perform more complex analytics and machine learning inference. AWS IoT Analytics includes pre-built models for common IoT use cases so you can answer questions like which devices are about to fail or which customers are at risk of abandoning their wearable devices.

" +} diff --git a/aws/dist/botocore/data/iotevents-data/2018-10-23/paginators-1.json b/aws/dist/botocore/data/iotevents-data/2018-10-23/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/iotevents-data/2018-10-23/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/iotevents-data/2018-10-23/service-2.json b/aws/dist/botocore/data/iotevents-data/2018-10-23/service-2.json new file mode 100644 index 00000000..52b92e43 --- /dev/null +++ b/aws/dist/botocore/data/iotevents-data/2018-10-23/service-2.json @@ -0,0 +1,639 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-10-23", + "endpointPrefix":"data.iotevents", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Events Data", + "serviceId":"IoT Events Data", + "signatureVersion":"v4", + "signingName":"ioteventsdata", + "uid":"iotevents-data-2018-10-23" + }, + "operations":{ + "BatchPutMessage":{ + "name":"BatchPutMessage", + "http":{ + "method":"POST", + "requestUri":"/inputs/messages", + "responseCode":200 + }, + "input":{"shape":"BatchPutMessageRequest"}, + "output":{"shape":"BatchPutMessageResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Sends a set of messages to the AWS IoT Events system. Each message payload is transformed into the input you specify (\"inputName\") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

" + }, + "BatchUpdateDetector":{ + "name":"BatchUpdateDetector", + "http":{ + "method":"POST", + "requestUri":"/detectors", + "responseCode":200 + }, + "input":{"shape":"BatchUpdateDetectorRequest"}, + "output":{"shape":"BatchUpdateDetectorResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

" + }, + "DescribeDetector":{ + "name":"DescribeDetector", + "http":{ + "method":"GET", + "requestUri":"/detectors/{detectorModelName}/keyValues/" + }, + "input":{"shape":"DescribeDetectorRequest"}, + "output":{"shape":"DescribeDetectorResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns information about the specified detector (instance).

" + }, + "ListDetectors":{ + "name":"ListDetectors", + "http":{ + "method":"GET", + "requestUri":"/detectors/{detectorModelName}" + }, + "input":{"shape":"ListDetectorsRequest"}, + "output":{"shape":"ListDetectorsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists detectors (the instances of a detector model).

" + } + }, + "shapes":{ + "BatchPutMessageErrorEntries":{ + "type":"list", + "member":{"shape":"BatchPutMessageErrorEntry"} + }, + "BatchPutMessageErrorEntry":{ + "type":"structure", + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The ID of the message that caused the error. (See the value corresponding to the \"messageId\" key in the \"message\" object.)

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The code associated with the error.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

More information about the error.

" + } + }, + "documentation":"

Contains information about the errors encountered.

" + }, + "BatchPutMessageRequest":{ + "type":"structure", + "required":["messages"], + "members":{ + "messages":{ + "shape":"Messages", + "documentation":"

The list of messages to send. Each message has the following format: '{ \"messageId\": \"string\", \"inputName\": \"string\", \"payload\": \"string\"}'

" + } + } + }, + "BatchPutMessageResponse":{ + "type":"structure", + "members":{ + "BatchPutMessageErrorEntries":{ + "shape":"BatchPutMessageErrorEntries", + "documentation":"

A list of any errors encountered when sending the messages.

" + } + } + }, + "BatchUpdateDetectorErrorEntries":{ + "type":"list", + "member":{"shape":"BatchUpdateDetectorErrorEntry"} + }, + "BatchUpdateDetectorErrorEntry":{ + "type":"structure", + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The \"messageId\" of the update request that caused the error. (The value of the \"messageId\" in the update request \"Detector\" object.)

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The code of the error.

" + }, + "errorMessage":{ + "shape":"ErrorMessage", + "documentation":"

A message describing the error.

" + } + }, + "documentation":"

Information about the error that occured when attempting to update a detector.

" + }, + "BatchUpdateDetectorRequest":{ + "type":"structure", + "required":["detectors"], + "members":{ + "detectors":{ + "shape":"UpdateDetectorRequests", + "documentation":"

The list of detectors (instances) to update, along with the values to update.

" + } + } + }, + "BatchUpdateDetectorResponse":{ + "type":"structure", + "members":{ + "batchUpdateDetectorErrorEntries":{ + "shape":"BatchUpdateDetectorErrorEntries", + "documentation":"

A list of those detector updates that resulted in errors. (If an error is listed here, the specific update did not occur.)

" + } + } + }, + "DescribeDetectorRequest":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model whose detectors (instances) you want information about.

", + "location":"uri", + "locationName":"detectorModelName" + }, + "keyValue":{ + "shape":"KeyValue", + "documentation":"

A filter used to limit results to detectors (instances) created because of the given key ID.

", + "location":"querystring", + "locationName":"keyValue" + } + } + }, + "DescribeDetectorResponse":{ + "type":"structure", + "members":{ + "detector":{ + "shape":"Detector", + "documentation":"

Information about the detector (instance).

" + } + } + }, + "Detector":{ + "type":"structure", + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model that created this detector (instance).

" + }, + "keyValue":{ + "shape":"KeyValue", + "documentation":"

The value of the key (identifying the device or system) that caused the creation of this detector (instance).

" + }, + "detectorModelVersion":{ + "shape":"DetectorModelVersion", + "documentation":"

The version of the detector model that created this detector (instance).

" + }, + "state":{ + "shape":"DetectorState", + "documentation":"

The current state of the detector (instance).

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector (instance) was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector (instance) was last updated.

" + } + }, + "documentation":"

Information about the detector (instance).

" + }, + "DetectorModelName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "DetectorModelVersion":{ + "type":"string", + "max":128, + "min":1 + }, + "DetectorState":{ + "type":"structure", + "required":[ + "stateName", + "variables", + "timers" + ], + "members":{ + "stateName":{ + "shape":"StateName", + "documentation":"

The name of the state.

" + }, + "variables":{ + "shape":"Variables", + "documentation":"

The current values of the detector's variables.

" + }, + "timers":{ + "shape":"Timers", + "documentation":"

The current state of the detector's timers.

" + } + }, + "documentation":"

Information about the current state of the detector instance.

" + }, + "DetectorStateDefinition":{ + "type":"structure", + "required":[ + "stateName", + "variables", + "timers" + ], + "members":{ + "stateName":{ + "shape":"StateName", + "documentation":"

The name of the new state of the detector (instance).

" + }, + "variables":{ + "shape":"VariableDefinitions", + "documentation":"

The new values of the detector's variables. Any variable whose value isn't specified is cleared.

" + }, + "timers":{ + "shape":"TimerDefinitions", + "documentation":"

The new values of the detector's timers. Any timer whose value isn't specified is cleared, and its timeout event won't occur.

" + } + }, + "documentation":"

The new state, variable values, and timer settings of the detector (instance).

" + }, + "DetectorStateSummary":{ + "type":"structure", + "members":{ + "stateName":{ + "shape":"StateName", + "documentation":"

The name of the state.

" + } + }, + "documentation":"

Information about the detector state.

" + }, + "DetectorSummaries":{ + "type":"list", + "member":{"shape":"DetectorSummary"} + }, + "DetectorSummary":{ + "type":"structure", + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model that created this detector (instance).

" + }, + "keyValue":{ + "shape":"KeyValue", + "documentation":"

The value of the key (identifying the device or system) that caused the creation of this detector (instance).

" + }, + "detectorModelVersion":{ + "shape":"DetectorModelVersion", + "documentation":"

The version of the detector model that created this detector (instance).

" + }, + "state":{ + "shape":"DetectorStateSummary", + "documentation":"

The current state of the detector (instance).

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector (instance) was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector (instance) was last updated.

" + } + }, + "documentation":"

Information about the detector (instance).

" + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "ResourceNotFoundException", + "InvalidRequestException", + "InternalFailureException", + "ServiceUnavailableException", + "ThrottlingException" + ] + }, + "ErrorMessage":{"type":"string"}, + "InputName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An internal failure occured.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request was invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "KeyValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-_:]+$" + }, + "ListDetectorsRequest":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model whose detectors (instances) are listed.

", + "location":"uri", + "locationName":"detectorModelName" + }, + "stateName":{ + "shape":"StateName", + "documentation":"

A filter that limits results to those detectors (instances) in the given state.

", + "location":"querystring", + "locationName":"stateName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDetectorsResponse":{ + "type":"structure", + "members":{ + "detectorSummaries":{ + "shape":"DetectorSummaries", + "documentation":"

A list of summary information about the detectors (instances).

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "Message":{ + "type":"structure", + "required":[ + "messageId", + "inputName", + "payload" + ], + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The ID to assign to the message. Within each batch sent, each \"messageId\" must be unique.

" + }, + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input into which the message payload is transformed.

" + }, + "payload":{ + "shape":"Payload", + "documentation":"

The payload of the message. This can be a JSON string or a Base-64-encoded string representing binary data (in which case you must decode it).

" + } + }, + "documentation":"

Information about a message.

" + }, + "MessageId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "Messages":{ + "type":"list", + "member":{"shape":"Message"}, + "min":1 + }, + "NextToken":{"type":"string"}, + "Payload":{"type":"blob"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The resource was not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Seconds":{"type":"integer"}, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The service is currently unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "StateName":{ + "type":"string", + "max":128, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request could not be completed due to throttling.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Timer":{ + "type":"structure", + "required":[ + "name", + "timestamp" + ], + "members":{ + "name":{ + "shape":"TimerName", + "documentation":"

The name of the timer.

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

The number of seconds which have elapsed on the timer.

" + } + }, + "documentation":"

The current state of a timer.

" + }, + "TimerDefinition":{ + "type":"structure", + "required":[ + "name", + "seconds" + ], + "members":{ + "name":{ + "shape":"TimerName", + "documentation":"

The name of the timer.

" + }, + "seconds":{ + "shape":"Seconds", + "documentation":"

The new setting of the timer (the number of seconds before the timer elapses).

" + } + }, + "documentation":"

The new setting of a timer.

" + }, + "TimerDefinitions":{ + "type":"list", + "member":{"shape":"TimerDefinition"} + }, + "TimerName":{ + "type":"string", + "max":128, + "min":1 + }, + "Timers":{ + "type":"list", + "member":{"shape":"Timer"} + }, + "Timestamp":{"type":"timestamp"}, + "UpdateDetectorRequest":{ + "type":"structure", + "required":[ + "messageId", + "detectorModelName", + "state" + ], + "members":{ + "messageId":{ + "shape":"MessageId", + "documentation":"

The ID to assign to the detector update \"message\". Each \"messageId\" must be unique within each batch sent.

" + }, + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model that created the detectors (instances).

" + }, + "keyValue":{ + "shape":"KeyValue", + "documentation":"

The value of the input key attribute (identifying the device or system) that caused the creation of this detector (instance).

" + }, + "state":{ + "shape":"DetectorStateDefinition", + "documentation":"

The new state, variable values, and timer settings of the detector (instance).

" + } + }, + "documentation":"

Information used to update the detector (instance).

" + }, + "UpdateDetectorRequests":{ + "type":"list", + "member":{"shape":"UpdateDetectorRequest"}, + "min":1 + }, + "Variable":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"VariableName", + "documentation":"

The name of the variable.

" + }, + "value":{ + "shape":"VariableValue", + "documentation":"

The current value of the variable.

" + } + }, + "documentation":"

The current state of the variable.

" + }, + "VariableDefinition":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"VariableName", + "documentation":"

The name of the variable.

" + }, + "value":{ + "shape":"VariableValue", + "documentation":"

The new value of the variable.

" + } + }, + "documentation":"

The new value of the variable.

" + }, + "VariableDefinitions":{ + "type":"list", + "member":{"shape":"VariableDefinition"} + }, + "VariableName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "VariableValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "Variables":{ + "type":"list", + "member":{"shape":"Variable"} + }, + "errorMessage":{"type":"string"} + }, + "documentation":"

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events Data API commands enable you to send inputs to detectors, list detectors, and view or update a detector's status.

" +} diff --git a/aws/dist/botocore/data/iotevents/2018-07-27/paginators-1.json b/aws/dist/botocore/data/iotevents/2018-07-27/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/iotevents/2018-07-27/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/iotevents/2018-07-27/service-2.json b/aws/dist/botocore/data/iotevents/2018-07-27/service-2.json new file mode 100644 index 00000000..c33fc28f --- /dev/null +++ b/aws/dist/botocore/data/iotevents/2018-07-27/service-2.json @@ -0,0 +1,1614 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-07-27", + "endpointPrefix":"iotevents", + "protocol":"rest-json", + "serviceFullName":"AWS IoT Events", + "serviceId":"IoT Events", + "signatureVersion":"v4", + "signingName":"iotevents", + "uid":"iotevents-2018-07-27" + }, + "operations":{ + "CreateDetectorModel":{ + "name":"CreateDetectorModel", + "http":{ + "method":"POST", + "requestUri":"/detector-models" + }, + "input":{"shape":"CreateDetectorModelRequest"}, + "output":{"shape":"CreateDetectorModelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a detector model.

" + }, + "CreateInput":{ + "name":"CreateInput", + "http":{ + "method":"POST", + "requestUri":"/inputs", + "responseCode":201 + }, + "input":{"shape":"CreateInputRequest"}, + "output":{"shape":"CreateInputResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

Creates an input.

" + }, + "DeleteDetectorModel":{ + "name":"DeleteDetectorModel", + "http":{ + "method":"DELETE", + "requestUri":"/detector-models/{detectorModelName}", + "responseCode":204 + }, + "input":{"shape":"DeleteDetectorModelRequest"}, + "output":{"shape":"DeleteDetectorModelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes a detector model. Any active instances of the detector model are also deleted.

" + }, + "DeleteInput":{ + "name":"DeleteInput", + "http":{ + "method":"DELETE", + "requestUri":"/inputs/{inputName}" + }, + "input":{"shape":"DeleteInputRequest"}, + "output":{"shape":"DeleteInputResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes an input.

" + }, + "DescribeDetectorModel":{ + "name":"DescribeDetectorModel", + "http":{ + "method":"GET", + "requestUri":"/detector-models/{detectorModelName}" + }, + "input":{"shape":"DescribeDetectorModelRequest"}, + "output":{"shape":"DescribeDetectorModelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Describes a detector model. If the \"version\" parameter is not specified, information about the latest version is returned.

" + }, + "DescribeInput":{ + "name":"DescribeInput", + "http":{ + "method":"GET", + "requestUri":"/inputs/{inputName}" + }, + "input":{"shape":"DescribeInputRequest"}, + "output":{"shape":"DescribeInputResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Describes an input.

" + }, + "DescribeLoggingOptions":{ + "name":"DescribeLoggingOptions", + "http":{ + "method":"GET", + "requestUri":"/logging" + }, + "input":{"shape":"DescribeLoggingOptionsRequest"}, + "output":{"shape":"DescribeLoggingOptionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Retrieves the current settings of the AWS IoT Events logging options.

" + }, + "ListDetectorModelVersions":{ + "name":"ListDetectorModelVersions", + "http":{ + "method":"GET", + "requestUri":"/detector-models/{detectorModelName}/versions" + }, + "input":{"shape":"ListDetectorModelVersionsRequest"}, + "output":{"shape":"ListDetectorModelVersionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

" + }, + "ListDetectorModels":{ + "name":"ListDetectorModels", + "http":{ + "method":"GET", + "requestUri":"/detector-models" + }, + "input":{"shape":"ListDetectorModelsRequest"}, + "output":{"shape":"ListDetectorModelsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

" + }, + "ListInputs":{ + "name":"ListInputs", + "http":{ + "method":"GET", + "requestUri":"/inputs" + }, + "input":{"shape":"ListInputsRequest"}, + "output":{"shape":"ListInputsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the inputs you have created.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists the tags (metadata) you have assigned to the resource.

" + }, + "PutLoggingOptions":{ + "name":"PutLoggingOptions", + "http":{ + "method":"PUT", + "requestUri":"/logging" + }, + "input":{"shape":"PutLoggingOptionsRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Sets or updates the AWS IoT Events logging options.

If you update the value of any \"loggingOptions\" field, it takes up to one minute for the change to take effect. Also, if you change the policy attached to the role you specified in the \"roleArn\" field (for example, to correct an invalid policy) it takes up to five minutes for that change to take effect.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Removes the given tags (metadata) from the resource.

" + }, + "UpdateDetectorModel":{ + "name":"UpdateDetectorModel", + "http":{ + "method":"POST", + "requestUri":"/detector-models/{detectorModelName}" + }, + "input":{"shape":"UpdateDetectorModelRequest"}, + "output":{"shape":"UpdateDetectorModelResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

" + }, + "UpdateInput":{ + "name":"UpdateInput", + "http":{ + "method":"PUT", + "requestUri":"/inputs/{inputName}" + }, + "input":{"shape":"UpdateInputRequest"}, + "output":{"shape":"UpdateInputResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Updates an input.

" + } + }, + "shapes":{ + "Action":{ + "type":"structure", + "members":{ + "setVariable":{ + "shape":"SetVariableAction", + "documentation":"

Sets a variable to a specified value.

" + }, + "sns":{ + "shape":"SNSTopicPublishAction", + "documentation":"

Sends an Amazon SNS message.

" + }, + "iotTopicPublish":{ + "shape":"IotTopicPublishAction", + "documentation":"

Publishes an MQTT message with the given topic to the AWS IoT message broker.

" + }, + "setTimer":{ + "shape":"SetTimerAction", + "documentation":"

Information needed to set the timer.

" + }, + "clearTimer":{ + "shape":"ClearTimerAction", + "documentation":"

Information needed to clear the timer.

" + }, + "resetTimer":{ + "shape":"ResetTimerAction", + "documentation":"

Information needed to reset the timer.

" + }, + "lambda":{ + "shape":"LambdaAction", + "documentation":"

Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.

" + }, + "iotEvents":{ + "shape":"IotEventsAction", + "documentation":"

Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action.

" + }, + "sqs":{ + "shape":"SqsAction", + "documentation":"

Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.

" + }, + "firehose":{ + "shape":"FirehoseAction", + "documentation":"

Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream.

" + } + }, + "documentation":"

An action to be performed when the \"condition\" is TRUE.

" + }, + "Actions":{ + "type":"list", + "member":{"shape":"Action"} + }, + "AmazonResourceName":{ + "type":"string", + "max":2048, + "min":1 + }, + "Attribute":{ + "type":"structure", + "required":["jsonPath"], + "members":{ + "jsonPath":{ + "shape":"AttributeJsonPath", + "documentation":"

An expression that specifies an attribute-value pair in a JSON structure. Use this to specify an attribute from the JSON payload that is made available by the input. Inputs are derived from messages sent to the AWS IoT Events system (BatchPutMessage). Each such message contains a JSON payload, and the attribute (and its paired value) specified here are available for use in the \"condition\" expressions used by detectors.

Syntax: <field-name>.<field-name>...

" + } + }, + "documentation":"

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the condition expressions used by detectors.

" + }, + "AttributeJsonPath":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^((`[\\w\\- ]+`)|([\\w\\-]+))(\\.((`[\\w- ]+`)|([\\w\\-]+)))*$" + }, + "Attributes":{ + "type":"list", + "member":{"shape":"Attribute"}, + "max":200, + "min":1 + }, + "ClearTimerAction":{ + "type":"structure", + "required":["timerName"], + "members":{ + "timerName":{ + "shape":"TimerName", + "documentation":"

The name of the timer to clear.

" + } + }, + "documentation":"

Information needed to clear the timer.

" + }, + "Condition":{ + "type":"string", + "max":512 + }, + "CreateDetectorModelRequest":{ + "type":"structure", + "required":[ + "detectorModelName", + "detectorModelDefinition", + "roleArn" + ], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

" + }, + "detectorModelDefinition":{ + "shape":"DetectorModelDefinition", + "documentation":"

Information that defines how the detectors operate.

" + }, + "detectorModelDescription":{ + "shape":"DetectorModelDescription", + "documentation":"

A brief description of the detector model.

" + }, + "key":{ + "shape":"AttributeJsonPath", + "documentation":"

The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.

" + }, + "roleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Metadata that can be used to manage the detector model.

" + }, + "evaluationMethod":{ + "shape":"EvaluationMethod", + "documentation":"

When set to SERIAL, variables are updated and event conditions evaluated in the order that the events are defined. When set to BATCH, variables are updated and events performed only after all event conditions are evaluated.

" + } + } + }, + "CreateDetectorModelResponse":{ + "type":"structure", + "members":{ + "detectorModelConfiguration":{ + "shape":"DetectorModelConfiguration", + "documentation":"

Information about how the detector model is configured.

" + } + } + }, + "CreateInputRequest":{ + "type":"structure", + "required":[ + "inputName", + "inputDefinition" + ], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name you want to give to the input.

" + }, + "inputDescription":{ + "shape":"InputDescription", + "documentation":"

A brief description of the input.

" + }, + "inputDefinition":{ + "shape":"InputDefinition", + "documentation":"

The definition of the input.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Metadata that can be used to manage the input.

" + } + } + }, + "CreateInputResponse":{ + "type":"structure", + "members":{ + "inputConfiguration":{ + "shape":"InputConfiguration", + "documentation":"

Information about the configuration of the input.

" + } + } + }, + "DeleteDetectorModelRequest":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model to be deleted.

", + "location":"uri", + "locationName":"detectorModelName" + } + } + }, + "DeleteDetectorModelResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteInputRequest":{ + "type":"structure", + "required":["inputName"], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input to delete.

", + "location":"uri", + "locationName":"inputName" + } + } + }, + "DeleteInputResponse":{ + "type":"structure", + "members":{ + } + }, + "DeliveryStreamName":{"type":"string"}, + "DescribeDetectorModelRequest":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

", + "location":"uri", + "locationName":"detectorModelName" + }, + "detectorModelVersion":{ + "shape":"DetectorModelVersion", + "documentation":"

The version of the detector model.

", + "location":"querystring", + "locationName":"version" + } + } + }, + "DescribeDetectorModelResponse":{ + "type":"structure", + "members":{ + "detectorModel":{ + "shape":"DetectorModel", + "documentation":"

Information about the detector model.

" + } + } + }, + "DescribeInputRequest":{ + "type":"structure", + "required":["inputName"], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input.

", + "location":"uri", + "locationName":"inputName" + } + } + }, + "DescribeInputResponse":{ + "type":"structure", + "members":{ + "input":{ + "shape":"Input", + "documentation":"

Information about the input.

" + } + } + }, + "DescribeLoggingOptionsRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeLoggingOptionsResponse":{ + "type":"structure", + "members":{ + "loggingOptions":{ + "shape":"LoggingOptions", + "documentation":"

The current settings of the AWS IoT Events logging options.

" + } + } + }, + "DetectorDebugOption":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

" + }, + "keyValue":{ + "shape":"KeyValue", + "documentation":"

The value of the input attribute key used to create the detector (the instance of the detector model).

" + } + }, + "documentation":"

The detector model and the specific detectors (instances) for which the logging level is given.

" + }, + "DetectorDebugOptions":{ + "type":"list", + "member":{"shape":"DetectorDebugOption"}, + "min":1 + }, + "DetectorModel":{ + "type":"structure", + "members":{ + "detectorModelDefinition":{ + "shape":"DetectorModelDefinition", + "documentation":"

Information that defines how a detector operates.

" + }, + "detectorModelConfiguration":{ + "shape":"DetectorModelConfiguration", + "documentation":"

Information about how the detector is configured.

" + } + }, + "documentation":"

Information about the detector model.

" + }, + "DetectorModelArn":{"type":"string"}, + "DetectorModelConfiguration":{ + "type":"structure", + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

" + }, + "detectorModelVersion":{ + "shape":"DetectorModelVersion", + "documentation":"

The version of the detector model.

" + }, + "detectorModelDescription":{ + "shape":"DetectorModelDescription", + "documentation":"

A brief description of the detector model.

" + }, + "detectorModelArn":{ + "shape":"DetectorModelArn", + "documentation":"

The ARN of the detector model.

" + }, + "roleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector model was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector model was last updated.

" + }, + "status":{ + "shape":"DetectorModelVersionStatus", + "documentation":"

The status of the detector model.

" + }, + "key":{ + "shape":"AttributeJsonPath", + "documentation":"

The input attribute key used to identify a device or system to create a detector (an instance of the detector model) and then to route each input received to the appropriate detector (instance). This parameter uses a JSON-path expression to specify the attribute-value pair in the message payload of each input that is used to identify the device associated with the input.

" + }, + "evaluationMethod":{ + "shape":"EvaluationMethod", + "documentation":"

When set to SERIAL, variables are updated and event conditions evaluated in the order that the events are defined. When set to BATCH, variables are updated and events performed only after all event conditions are evaluated.

" + } + }, + "documentation":"

Information about how the detector model is configured.

" + }, + "DetectorModelDefinition":{ + "type":"structure", + "required":[ + "states", + "initialStateName" + ], + "members":{ + "states":{ + "shape":"States", + "documentation":"

Information about the states of the detector.

" + }, + "initialStateName":{ + "shape":"StateName", + "documentation":"

The state that is entered at the creation of each detector (instance).

" + } + }, + "documentation":"

Information that defines how a detector operates.

" + }, + "DetectorModelDescription":{ + "type":"string", + "max":128 + }, + "DetectorModelName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_-]+$" + }, + "DetectorModelSummaries":{ + "type":"list", + "member":{"shape":"DetectorModelSummary"} + }, + "DetectorModelSummary":{ + "type":"structure", + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

" + }, + "detectorModelDescription":{ + "shape":"DetectorModelDescription", + "documentation":"

A brief description of the detector model.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector model was created.

" + } + }, + "documentation":"

Information about the detector model.

" + }, + "DetectorModelVersion":{ + "type":"string", + "max":128, + "min":1 + }, + "DetectorModelVersionStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "ACTIVATING", + "INACTIVE", + "DEPRECATED", + "DRAFT", + "PAUSED", + "FAILED" + ] + }, + "DetectorModelVersionSummaries":{ + "type":"list", + "member":{"shape":"DetectorModelVersionSummary"} + }, + "DetectorModelVersionSummary":{ + "type":"structure", + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model.

" + }, + "detectorModelVersion":{ + "shape":"DetectorModelVersion", + "documentation":"

The ID of the detector model version.

" + }, + "detectorModelArn":{ + "shape":"DetectorModelArn", + "documentation":"

The ARN of the detector model version.

" + }, + "roleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the role that grants the detector model permission to perform its tasks.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the detector model version was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the detector model version was updated.

" + }, + "status":{ + "shape":"DetectorModelVersionStatus", + "documentation":"

The status of the detector model version.

" + }, + "evaluationMethod":{ + "shape":"EvaluationMethod", + "documentation":"

When set to SERIAL, variables are updated and event conditions evaluated in the order that the events are defined. When set to BATCH, variables are updated and events performed only after all event conditions are evaluated.

" + } + }, + "documentation":"

Information about the detector model version.

" + }, + "EvaluationMethod":{ + "type":"string", + "enum":[ + "BATCH", + "SERIAL" + ] + }, + "Event":{ + "type":"structure", + "required":["eventName"], + "members":{ + "eventName":{ + "shape":"EventName", + "documentation":"

The name of the event.

" + }, + "condition":{ + "shape":"Condition", + "documentation":"

[Optional] The Boolean expression that when TRUE causes the \"actions\" to be performed. If not present, the actions are performed (=TRUE); if the expression result is not a Boolean value, the actions are NOT performed (=FALSE).

" + }, + "actions":{ + "shape":"Actions", + "documentation":"

The actions to be performed.

" + } + }, + "documentation":"

Specifies the \"actions\" to be performed when the \"condition\" evaluates to TRUE.

" + }, + "EventName":{ + "type":"string", + "max":128 + }, + "Events":{ + "type":"list", + "member":{"shape":"Event"} + }, + "FirehoseAction":{ + "type":"structure", + "required":["deliveryStreamName"], + "members":{ + "deliveryStreamName":{ + "shape":"DeliveryStreamName", + "documentation":"

The name of the Kinesis Data Firehose delivery stream where the data is written.

" + }, + "separator":{ + "shape":"FirehoseSeparator", + "documentation":"

A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\\n' (newline), '\\t' (tab), '\\r\\n' (Windows newline), ',' (comma).

" + } + }, + "documentation":"

Sends information about the detector model instance and the event which triggered the action to a Kinesis Data Firehose delivery stream.

" + }, + "FirehoseSeparator":{ + "type":"string", + "pattern":"([\\n\\t])|(\\r\\n)|(,)" + }, + "Input":{ + "type":"structure", + "members":{ + "inputConfiguration":{ + "shape":"InputConfiguration", + "documentation":"

Information about the configuration of an input.

" + }, + "inputDefinition":{ + "shape":"InputDefinition", + "documentation":"

The definition of the input.

" + } + }, + "documentation":"

Information about the input.

" + }, + "InputArn":{"type":"string"}, + "InputConfiguration":{ + "type":"structure", + "required":[ + "inputName", + "inputArn", + "creationTime", + "lastUpdateTime", + "status" + ], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input.

" + }, + "inputDescription":{ + "shape":"InputDescription", + "documentation":"

A brief description of the input.

" + }, + "inputArn":{ + "shape":"InputArn", + "documentation":"

The ARN of the input.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the input was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the input was updated.

" + }, + "status":{ + "shape":"InputStatus", + "documentation":"

The status of the input.

" + } + }, + "documentation":"

Information about the configuration of an input.

" + }, + "InputDefinition":{ + "type":"structure", + "required":["attributes"], + "members":{ + "attributes":{ + "shape":"Attributes", + "documentation":"

The attributes from the JSON payload that are made available by the input. Inputs are derived from messages sent to the AWS IoT Events system using BatchPutMessage. Each such message contains a JSON payload, and those attributes (and their paired values) specified here are available for use in the \"condition\" expressions used by detectors that monitor this input.

" + } + }, + "documentation":"

The definition of the input.

" + }, + "InputDescription":{ + "type":"string", + "max":128 + }, + "InputName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "InputStatus":{ + "type":"string", + "enum":[ + "CREATING", + "UPDATING", + "ACTIVE", + "DELETING" + ] + }, + "InputSummaries":{ + "type":"list", + "member":{"shape":"InputSummary"} + }, + "InputSummary":{ + "type":"structure", + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input.

" + }, + "inputDescription":{ + "shape":"InputDescription", + "documentation":"

A brief description of the input.

" + }, + "inputArn":{ + "shape":"InputArn", + "documentation":"

The ARN of the input.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The time the input was created.

" + }, + "lastUpdateTime":{ + "shape":"Timestamp", + "documentation":"

The last time the input was updated.

" + }, + "status":{ + "shape":"InputStatus", + "documentation":"

The status of the input.

" + } + }, + "documentation":"

Information about the input.

" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

An internal failure occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request was invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IotEventsAction":{ + "type":"structure", + "required":["inputName"], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the AWS IoT Events input where the data is sent.

" + } + }, + "documentation":"

Sends an IoT Events input, passing in information about the detector model instance and the event which triggered the action.

" + }, + "IotTopicPublishAction":{ + "type":"structure", + "required":["mqttTopic"], + "members":{ + "mqttTopic":{ + "shape":"MQTTTopic", + "documentation":"

The MQTT topic of the message.

" + } + }, + "documentation":"

Information required to publish the MQTT message via the AWS IoT message broker.

" + }, + "KeyValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9\\-_:]+$" + }, + "LambdaAction":{ + "type":"structure", + "required":["functionArn"], + "members":{ + "functionArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the AWS Lambda function which is executed.

" + } + }, + "documentation":"

Calls an AWS Lambda function, passing in information about the detector model instance and the event which triggered the action.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

A limit was exceeded.

", + "error":{"httpStatusCode":410}, + "exception":true + }, + "ListDetectorModelVersionsRequest":{ + "type":"structure", + "required":["detectorModelName"], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model whose versions are returned.

", + "location":"uri", + "locationName":"detectorModelName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDetectorModelVersionsResponse":{ + "type":"structure", + "members":{ + "detectorModelVersionSummaries":{ + "shape":"DetectorModelVersionSummaries", + "documentation":"

Summary information about the detector model versions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListDetectorModelsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDetectorModelsResponse":{ + "type":"structure", + "members":{ + "detectorModelSummaries":{ + "shape":"DetectorModelSummaries", + "documentation":"

Summary information about the detector models.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListInputsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return at one time.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListInputsResponse":{ + "type":"structure", + "members":{ + "inputSummaries":{ + "shape":"InputSummaries", + "documentation":"

Summary information about the inputs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token to retrieve the next set of results, or null if there are no additional results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the resource.

", + "location":"querystring", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The list of tags assigned to the resource.

" + } + } + }, + "LoggingEnabled":{"type":"boolean"}, + "LoggingLevel":{ + "type":"string", + "enum":[ + "ERROR", + "INFO", + "DEBUG" + ] + }, + "LoggingOptions":{ + "type":"structure", + "required":[ + "roleArn", + "level", + "enabled" + ], + "members":{ + "roleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the role that grants permission to AWS IoT Events to perform logging.

" + }, + "level":{ + "shape":"LoggingLevel", + "documentation":"

The logging level.

" + }, + "enabled":{ + "shape":"LoggingEnabled", + "documentation":"

If TRUE, logging is enabled for AWS IoT Events.

" + }, + "detectorDebugOptions":{ + "shape":"DetectorDebugOptions", + "documentation":"

Information that identifies those detector models and their detectors (instances) for which the logging level is given.

" + } + }, + "documentation":"

The values of the AWS IoT Events logging options.

" + }, + "MQTTTopic":{ + "type":"string", + "max":128, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "NextToken":{"type":"string"}, + "OnEnterLifecycle":{ + "type":"structure", + "members":{ + "events":{ + "shape":"Events", + "documentation":"

Specifies the actions that are performed when the state is entered and the \"condition\" is TRUE.

" + } + }, + "documentation":"

When entering this state, perform these actions if the condition is TRUE.

" + }, + "OnExitLifecycle":{ + "type":"structure", + "members":{ + "events":{ + "shape":"Events", + "documentation":"

Specifies the \"actions\" that are performed when the state is exited and the \"condition\" is TRUE.

" + } + }, + "documentation":"

When exiting this state, perform these \"actions\" if the specified \"condition\" is TRUE.

" + }, + "OnInputLifecycle":{ + "type":"structure", + "members":{ + "events":{ + "shape":"Events", + "documentation":"

Specifies the actions performed when the \"condition\" evaluates to TRUE.

" + }, + "transitionEvents":{ + "shape":"TransitionEvents", + "documentation":"

Specifies the actions performed, and the next state entered, when a \"condition\" evaluates to TRUE.

" + } + }, + "documentation":"

Specifies the actions performed when the \"condition\" evaluates to TRUE.

" + }, + "PutLoggingOptionsRequest":{ + "type":"structure", + "required":["loggingOptions"], + "members":{ + "loggingOptions":{ + "shape":"LoggingOptions", + "documentation":"

The new values of the AWS IoT Events logging options.

" + } + } + }, + "QueueUrl":{"type":"string"}, + "ResetTimerAction":{ + "type":"structure", + "required":["timerName"], + "members":{ + "timerName":{ + "shape":"TimerName", + "documentation":"

The name of the timer to reset.

" + } + }, + "documentation":"

Information needed to reset the timer.

" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + }, + "resourceId":{ + "shape":"resourceId", + "documentation":"

The ID of the resource.

" + }, + "resourceArn":{ + "shape":"resourceArn", + "documentation":"

The ARN of the resource.

" + } + }, + "documentation":"

The resource already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The resource is in use.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The resource was not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "SNSTopicPublishAction":{ + "type":"structure", + "required":["targetArn"], + "members":{ + "targetArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the Amazon SNS target where the message is sent.

" + } + }, + "documentation":"

Information required to publish the Amazon SNS message.

" + }, + "Seconds":{"type":"integer"}, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The service is currently unavailable.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SetTimerAction":{ + "type":"structure", + "required":[ + "timerName", + "seconds" + ], + "members":{ + "timerName":{ + "shape":"TimerName", + "documentation":"

The name of the timer.

" + }, + "seconds":{ + "shape":"Seconds", + "documentation":"

The number of seconds until the timer expires. The minimum value is 60 seconds to ensure accuracy.

" + } + }, + "documentation":"

Information needed to set the timer.

" + }, + "SetVariableAction":{ + "type":"structure", + "required":[ + "variableName", + "value" + ], + "members":{ + "variableName":{ + "shape":"VariableName", + "documentation":"

The name of the variable.

" + }, + "value":{ + "shape":"VariableValue", + "documentation":"

The new value of the variable.

" + } + }, + "documentation":"

Information about the variable and its new value.

" + }, + "SqsAction":{ + "type":"structure", + "required":["queueUrl"], + "members":{ + "queueUrl":{ + "shape":"QueueUrl", + "documentation":"

The URL of the Amazon SQS queue where the data is written.

" + }, + "useBase64":{ + "shape":"UseBase64", + "documentation":"

Set this to TRUE if you want the data to be Base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.

" + } + }, + "documentation":"

Sends information about the detector model instance and the event which triggered the action to an Amazon SQS queue.

" + }, + "State":{ + "type":"structure", + "required":["stateName"], + "members":{ + "stateName":{ + "shape":"StateName", + "documentation":"

The name of the state.

" + }, + "onInput":{ + "shape":"OnInputLifecycle", + "documentation":"

When an input is received and the \"condition\" is TRUE, perform the specified \"actions\".

" + }, + "onEnter":{ + "shape":"OnEnterLifecycle", + "documentation":"

When entering this state, perform these \"actions\" if the \"condition\" is TRUE.

" + }, + "onExit":{ + "shape":"OnExitLifecycle", + "documentation":"

When exiting this state, perform these \"actions\" if the specified \"condition\" is TRUE.

" + } + }, + "documentation":"

Information that defines a state of a detector.

" + }, + "StateName":{ + "type":"string", + "max":128, + "min":1 + }, + "States":{ + "type":"list", + "member":{"shape":"State"}, + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The tag's key.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The tag's value.

" + } + }, + "documentation":"

Metadata that can be used to manage the resource.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the resource.

", + "location":"querystring", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The new or modified tags for the resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The request could not be completed due to throttling.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimerName":{ + "type":"string", + "max":128, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TransitionEvent":{ + "type":"structure", + "required":[ + "eventName", + "condition", + "nextState" + ], + "members":{ + "eventName":{ + "shape":"EventName", + "documentation":"

The name of the transition event.

" + }, + "condition":{ + "shape":"Condition", + "documentation":"

[Required] A Boolean expression that when TRUE causes the actions to be performed and the \"nextState\" to be entered.

" + }, + "actions":{ + "shape":"Actions", + "documentation":"

The actions to be performed.

" + }, + "nextState":{ + "shape":"StateName", + "documentation":"

The next state to enter.

" + } + }, + "documentation":"

Specifies the actions performed and the next state entered when a \"condition\" evaluates to TRUE.

" + }, + "TransitionEvents":{ + "type":"list", + "member":{"shape":"TransitionEvent"} + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"errorMessage", + "documentation":"

The message for the exception.

" + } + }, + "documentation":"

The requested operation is not supported.

", + "error":{"httpStatusCode":501}, + "exception":true, + "fault":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the resource.

", + "location":"querystring", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of the keys of the tags to be removed from the resource.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDetectorModelRequest":{ + "type":"structure", + "required":[ + "detectorModelName", + "detectorModelDefinition", + "roleArn" + ], + "members":{ + "detectorModelName":{ + "shape":"DetectorModelName", + "documentation":"

The name of the detector model that is updated.

", + "location":"uri", + "locationName":"detectorModelName" + }, + "detectorModelDefinition":{ + "shape":"DetectorModelDefinition", + "documentation":"

Information that defines how a detector operates.

" + }, + "detectorModelDescription":{ + "shape":"DetectorModelDescription", + "documentation":"

A brief description of the detector model.

" + }, + "roleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The ARN of the role that grants permission to AWS IoT Events to perform its operations.

" + }, + "evaluationMethod":{ + "shape":"EvaluationMethod", + "documentation":"

When set to SERIAL, variables are updated and event conditions evaluated in the order that the events are defined. When set to BATCH, variables are updated and events performed only after all event conditions are evaluated.

" + } + } + }, + "UpdateDetectorModelResponse":{ + "type":"structure", + "members":{ + "detectorModelConfiguration":{ + "shape":"DetectorModelConfiguration", + "documentation":"

Information about how the detector model is configured.

" + } + } + }, + "UpdateInputRequest":{ + "type":"structure", + "required":[ + "inputName", + "inputDefinition" + ], + "members":{ + "inputName":{ + "shape":"InputName", + "documentation":"

The name of the input you want to update.

", + "location":"uri", + "locationName":"inputName" + }, + "inputDescription":{ + "shape":"InputDescription", + "documentation":"

A brief description of the input.

" + }, + "inputDefinition":{ + "shape":"InputDefinition", + "documentation":"

The definition of the input.

" + } + } + }, + "UpdateInputResponse":{ + "type":"structure", + "members":{ + "inputConfiguration":{ + "shape":"InputConfiguration", + "documentation":"

Information about the configuration of the input.

" + } + } + }, + "UseBase64":{"type":"boolean"}, + "VariableName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "VariableValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "errorMessage":{"type":"string"}, + "resourceArn":{"type":"string"}, + "resourceId":{"type":"string"} + }, + "documentation":"

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. AWS IoT Events API commands enable you to create, read, update and delete inputs and detector models, and to list their versions.

" +} diff --git a/aws/dist/botocore/data/iotthingsgraph/2018-09-06/paginators-1.json b/aws/dist/botocore/data/iotthingsgraph/2018-09-06/paginators-1.json new file mode 100644 index 00000000..bc92f846 --- /dev/null +++ b/aws/dist/botocore/data/iotthingsgraph/2018-09-06/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "GetFlowTemplateRevisions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "GetSystemTemplateRevisions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "ListFlowExecutionMessages": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "messages" + }, + "ListTagsForResource": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "tags" + }, + "SearchEntities": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "descriptions" + }, + "SearchFlowExecutions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "SearchFlowTemplates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "SearchSystemInstances": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "SearchSystemTemplates": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "summaries" + }, + "SearchThings": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "things" + } + } +} diff --git a/aws/dist/botocore/data/iotthingsgraph/2018-09-06/service-2.json b/aws/dist/botocore/data/iotthingsgraph/2018-09-06/service-2.json new file mode 100644 index 00000000..ae9915b8 --- /dev/null +++ b/aws/dist/botocore/data/iotthingsgraph/2018-09-06/service-2.json @@ -0,0 +1,2218 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-09-06", + "endpointPrefix":"iotthingsgraph", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS IoT Things Graph", + "serviceId":"IoTThingsGraph", + "signatureVersion":"v4", + "signingName":"iotthingsgraph", + "targetPrefix":"IotThingsGraphFrontEndService", + "uid":"iotthingsgraph-2018-09-06" + }, + "operations":{ + "AssociateEntityToThing":{ + "name":"AssociateEntityToThing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateEntityToThingRequest"}, + "output":{"shape":"AssociateEntityToThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Associates a device with a concrete thing that is in the user's registry.

A thing can be associated with only one device at a time. If you associate a thing with a new device id, its previous association will be removed.

" + }, + "CreateFlowTemplate":{ + "name":"CreateFlowTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateFlowTemplateRequest"}, + "output":{"shape":"CreateFlowTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a workflow template. Workflows can be created only in the user's namespace. (The public namespace contains only entities.) The workflow can contain only entities in the specified namespace. The workflow is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

" + }, + "CreateSystemInstance":{ + "name":"CreateSystemInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSystemInstanceRequest"}, + "output":{"shape":"CreateSystemInstanceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a system instance.

This action validates the system instance, prepares the deployment-related resources. For Greengrass deployments, it updates the Greengrass group that is specified by the greengrassGroupName parameter. It also adds a file to the S3 bucket specified by the s3BucketName parameter. You need to call DeploySystemInstance after running this action.

For Greengrass deployments, since this action modifies and adds resources to a Greengrass group and an S3 bucket on the caller's behalf, the calling identity must have write permissions to both the specified Greengrass group and S3 bucket. Otherwise, the call will fail with an authorization error.

For cloud deployments, this action requires a flowActionsRoleArn value. This is an IAM role that has permissions to access AWS services, such as AWS Lambda and AWS IoT, that the flow uses when it executes.

If the definition document doesn't specify a version of the user's namespace, the latest version will be used by default.

" + }, + "CreateSystemTemplate":{ + "name":"CreateSystemTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSystemTemplateRequest"}, + "output":{"shape":"CreateSystemTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a system. The system is validated against the entities in the latest version of the user's namespace unless another namespace version is specified in the request.

" + }, + "DeleteFlowTemplate":{ + "name":"DeleteFlowTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFlowTemplateRequest"}, + "output":{"shape":"DeleteFlowTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a workflow. Any new system or deployment that contains this workflow will fail to update or deploy. Existing deployments that contain the workflow will continue to run (since they use a snapshot of the workflow taken at the time of deployment).

" + }, + "DeleteNamespace":{ + "name":"DeleteNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNamespaceRequest"}, + "output":{"shape":"DeleteNamespaceResponse"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Deletes the specified namespace. This action deletes all of the entities in the namespace. Delete the systems and flows that use entities in the namespace before performing this action.

" + }, + "DeleteSystemInstance":{ + "name":"DeleteSystemInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSystemInstanceRequest"}, + "output":{"shape":"DeleteSystemInstanceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a system instance. Only system instances that have never been deployed, or that have been undeployed can be deleted.

Users can create a new system instance that has the same ID as a deleted system instance.

" + }, + "DeleteSystemTemplate":{ + "name":"DeleteSystemTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSystemTemplateRequest"}, + "output":{"shape":"DeleteSystemTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a system. New deployments can't contain the system after its deletion. Existing deployments that contain the system will continue to work because they use a snapshot of the system that is taken when it is deployed.

" + }, + "DeploySystemInstance":{ + "name":"DeploySystemInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeploySystemInstanceRequest"}, + "output":{"shape":"DeploySystemInstanceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Greengrass and Cloud Deployments

Deploys the system instance to the target specified in CreateSystemInstance.

Greengrass Deployments

If the system or any workflows and entities have been updated before this action is called, then the deployment will create a new Amazon Simple Storage Service resource file and then deploy it.

Since this action creates a Greengrass deployment on the caller's behalf, the calling identity must have write permissions to the specified Greengrass group. Otherwise, the call will fail with an authorization error.

For information about the artifacts that get added to your Greengrass core device when you use this API, see AWS IoT Things Graph and AWS IoT Greengrass.

" + }, + "DeprecateFlowTemplate":{ + "name":"DeprecateFlowTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateFlowTemplateRequest"}, + "output":{"shape":"DeprecateFlowTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deprecates the specified workflow. This action marks the workflow for deletion. Deprecated flows can't be deployed, but existing deployments will continue to run.

" + }, + "DeprecateSystemTemplate":{ + "name":"DeprecateSystemTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateSystemTemplateRequest"}, + "output":{"shape":"DeprecateSystemTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deprecates the specified system.

" + }, + "DescribeNamespace":{ + "name":"DescribeNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNamespaceRequest"}, + "output":{"shape":"DescribeNamespaceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Gets the latest version of the user's namespace and the public version that it is tracking.

" + }, + "DissociateEntityFromThing":{ + "name":"DissociateEntityFromThing", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DissociateEntityFromThingRequest"}, + "output":{"shape":"DissociateEntityFromThingResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Dissociates a device entity from a concrete thing. The action takes only the type of the entity that you need to dissociate because only one entity of a particular type can be associated with a thing.

" + }, + "GetEntities":{ + "name":"GetEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEntitiesRequest"}, + "output":{"shape":"GetEntitiesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Gets definitions of the specified entities. Uses the latest version of the user's namespace by default. This API returns the following TDM entities.

  • Properties

  • States

  • Events

  • Actions

  • Capabilities

  • Mappings

  • Devices

  • Device Models

  • Services

This action doesn't return definitions for systems, flows, and deployments.

" + }, + "GetFlowTemplate":{ + "name":"GetFlowTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFlowTemplateRequest"}, + "output":{"shape":"GetFlowTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets the latest version of the DefinitionDocument and FlowTemplateSummary for the specified workflow.

" + }, + "GetFlowTemplateRevisions":{ + "name":"GetFlowTemplateRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFlowTemplateRevisionsRequest"}, + "output":{"shape":"GetFlowTemplateRevisionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets revisions of the specified workflow. Only the last 100 revisions are stored. If the workflow has been deprecated, this action will return revisions that occurred before the deprecation. This action won't work for workflows that have been deleted.

" + }, + "GetNamespaceDeletionStatus":{ + "name":"GetNamespaceDeletionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNamespaceDeletionStatusRequest"}, + "output":{"shape":"GetNamespaceDeletionStatusResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Gets the status of a namespace deletion task.

" + }, + "GetSystemInstance":{ + "name":"GetSystemInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSystemInstanceRequest"}, + "output":{"shape":"GetSystemInstanceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets a system instance.

" + }, + "GetSystemTemplate":{ + "name":"GetSystemTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSystemTemplateRequest"}, + "output":{"shape":"GetSystemTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets a system.

" + }, + "GetSystemTemplateRevisions":{ + "name":"GetSystemTemplateRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSystemTemplateRevisionsRequest"}, + "output":{"shape":"GetSystemTemplateRevisionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets revisions made to the specified system template. Only the previous 100 revisions are stored. If the system has been deprecated, this action will return the revisions that occurred before its deprecation. This action won't work with systems that have been deleted.

" + }, + "GetUploadStatus":{ + "name":"GetUploadStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetUploadStatusRequest"}, + "output":{"shape":"GetUploadStatusResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Gets the status of the specified upload.

" + }, + "ListFlowExecutionMessages":{ + "name":"ListFlowExecutionMessages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFlowExecutionMessagesRequest"}, + "output":{"shape":"ListFlowExecutionMessagesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of objects that contain information about events in a flow execution.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all tags on an AWS IoT Things Graph resource.

" + }, + "SearchEntities":{ + "name":"SearchEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchEntitiesRequest"}, + "output":{"shape":"SearchEntitiesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Searches for entities of the specified type. You can search for entities in your namespace and the public namespace that you're tracking.

" + }, + "SearchFlowExecutions":{ + "name":"SearchFlowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchFlowExecutionsRequest"}, + "output":{"shape":"SearchFlowExecutionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Searches for AWS IoT Things Graph workflow execution instances.

" + }, + "SearchFlowTemplates":{ + "name":"SearchFlowTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchFlowTemplatesRequest"}, + "output":{"shape":"SearchFlowTemplatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Searches for summary information about workflows.

" + }, + "SearchSystemInstances":{ + "name":"SearchSystemInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchSystemInstancesRequest"}, + "output":{"shape":"SearchSystemInstancesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Searches for system instances in the user's account.

" + }, + "SearchSystemTemplates":{ + "name":"SearchSystemTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchSystemTemplatesRequest"}, + "output":{"shape":"SearchSystemTemplatesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Searches for summary information about systems in the user's account. You can filter by the ID of a workflow to return only systems that use the specified workflow.

" + }, + "SearchThings":{ + "name":"SearchThings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchThingsRequest"}, + "output":{"shape":"SearchThingsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Searches for things associated with the specified entity. You can search by both device and device model.

For example, if two different devices, camera1 and camera2, implement the camera device model, the user can associate thing1 to camera1 and thing2 to camera2. SearchThings(camera2) will return only thing2, but SearchThings(camera) will return both thing1 and thing2.

This action searches for exact matches and doesn't perform partial text matching.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a tag for the specified resource.

" + }, + "UndeploySystemInstance":{ + "name":"UndeploySystemInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UndeploySystemInstanceRequest"}, + "output":{"shape":"UndeploySystemInstanceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Removes a system instance from its target (Cloud or Greengrass).

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Removes a tag from the specified resource.

" + }, + "UpdateFlowTemplate":{ + "name":"UpdateFlowTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateFlowTemplateRequest"}, + "output":{"shape":"UpdateFlowTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the specified workflow. All deployed systems and system instances that use the workflow will see the changes in the flow when it is redeployed. If you don't want this behavior, copy the workflow (creating a new workflow with a different ID), and update the copy. The workflow can contain only entities in the specified namespace.

" + }, + "UpdateSystemTemplate":{ + "name":"UpdateSystemTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSystemTemplateRequest"}, + "output":{"shape":"UpdateSystemTemplateResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the specified system. You don't need to run this action after updating a workflow. Any deployment that uses the system will see the changes in the system when it is redeployed.

" + }, + "UploadEntityDefinitions":{ + "name":"UploadEntityDefinitions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UploadEntityDefinitionsRequest"}, + "output":{"shape":"UploadEntityDefinitionsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalFailureException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Asynchronously uploads one or more entity definitions to the user's namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user's namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

The IDs for all of the entities should be in URN format. Each entity must be in the user's namespace. Users can't create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

" + } + }, + "shapes":{ + "Arn":{"type":"string"}, + "AssociateEntityToThingRequest":{ + "type":"structure", + "required":[ + "thingName", + "entityId" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to which the entity is to be associated.

" + }, + "entityId":{ + "shape":"Urn", + "documentation":"

The ID of the device to be associated with the thing.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + } + } + }, + "AssociateEntityToThingResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateFlowTemplateRequest":{ + "type":"structure", + "required":["definition"], + "members":{ + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The workflow DefinitionDocument.

" + }, + "compatibleNamespaceVersion":{ + "shape":"Version", + "documentation":"

The namespace version in which the workflow is to be created.

If no value is specified, the latest version is used by default.

" + } + } + }, + "CreateFlowTemplateResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"FlowTemplateSummary", + "documentation":"

The summary object that describes the created workflow.

" + } + } + }, + "CreateSystemInstanceRequest":{ + "type":"structure", + "required":[ + "definition", + "target" + ], + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

Metadata, consisting of key-value pairs, that can be used to categorize your system instances.

" + }, + "definition":{"shape":"DefinitionDocument"}, + "target":{ + "shape":"DeploymentTarget", + "documentation":"

The target type of the deployment. Valid values are GREENGRASS and CLOUD.

" + }, + "greengrassGroupName":{ + "shape":"GroupName", + "documentation":"

The name of the Greengrass group where the system instance will be deployed. This value is required if the value of the target parameter is GREENGRASS.

" + }, + "s3BucketName":{ + "shape":"S3BucketName", + "documentation":"

The name of the Amazon Simple Storage Service bucket that will be used to store and deploy the system instance's resource file. This value is required if the value of the target parameter is GREENGRASS.

" + }, + "metricsConfiguration":{"shape":"MetricsConfiguration"}, + "flowActionsRoleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that AWS IoT Things Graph will assume when it executes the flow. This role must have read and write access to AWS Lambda and AWS IoT and any other AWS services that the flow uses when it executes. This value is required if the value of the target parameter is CLOUD.

" + } + } + }, + "CreateSystemInstanceResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemInstanceSummary", + "documentation":"

The summary object that describes the new system instance.

" + } + } + }, + "CreateSystemTemplateRequest":{ + "type":"structure", + "required":["definition"], + "members":{ + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The DefinitionDocument used to create the system.

" + }, + "compatibleNamespaceVersion":{ + "shape":"Version", + "documentation":"

The namespace version in which the system is to be created.

If no value is specified, the latest version is used by default.

" + } + } + }, + "CreateSystemTemplateResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemTemplateSummary", + "documentation":"

The summary object that describes the created system.

" + } + } + }, + "DefinitionDocument":{ + "type":"structure", + "required":[ + "language", + "text" + ], + "members":{ + "language":{ + "shape":"DefinitionLanguage", + "documentation":"

The language used to define the entity. GRAPHQL is the only valid value.

" + }, + "text":{ + "shape":"DefinitionText", + "documentation":"

The GraphQL text that defines the entity.

" + } + }, + "documentation":"

A document that defines an entity.

" + }, + "DefinitionLanguage":{ + "type":"string", + "enum":["GRAPHQL"] + }, + "DefinitionText":{ + "type":"string", + "max":1048576 + }, + "DeleteFlowTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

" + } + } + }, + "DeleteFlowTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNamespaceRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteNamespaceResponse":{ + "type":"structure", + "members":{ + "namespaceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the namespace to be deleted.

" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the namespace to be deleted.

" + } + } + }, + "DeleteSystemInstanceRequest":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system instance to be deleted.

" + } + } + }, + "DeleteSystemInstanceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSystemTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

" + } + } + }, + "DeleteSystemTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DependencyRevision":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow or system.

" + }, + "revisionNumber":{ + "shape":"Version", + "documentation":"

The revision number of the workflow or system.

" + } + }, + "documentation":"

An object that contains the ID and revision number of a workflow or system that is part of a deployment.

" + }, + "DependencyRevisions":{ + "type":"list", + "member":{"shape":"DependencyRevision"} + }, + "DeploySystemInstanceRequest":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system instance. This value is returned by the CreateSystemInstance action.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

" + } + } + }, + "DeploySystemInstanceResponse":{ + "type":"structure", + "required":["summary"], + "members":{ + "summary":{ + "shape":"SystemInstanceSummary", + "documentation":"

An object that contains summary information about a system instance that was deployed.

" + }, + "greengrassDeploymentId":{ + "shape":"GreengrassDeploymentId", + "documentation":"

The ID of the Greengrass deployment used to deploy the system instance.

" + } + } + }, + "DeploymentTarget":{ + "type":"string", + "enum":[ + "GREENGRASS", + "CLOUD" + ] + }, + "DeprecateExistingEntities":{"type":"boolean"}, + "DeprecateFlowTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow to be deleted.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

" + } + } + }, + "DeprecateFlowTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeprecateSystemTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system to delete.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

" + } + } + }, + "DeprecateSystemTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeNamespaceRequest":{ + "type":"structure", + "members":{ + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the user's namespace. Set this to aws to get the public namespace.

" + } + } + }, + "DescribeNamespaceResponse":{ + "type":"structure", + "members":{ + "namespaceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the namespace.

" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the namespace.

" + }, + "trackingNamespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the public namespace that the latest namespace version is tracking.

" + }, + "trackingNamespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the public namespace that the latest version is tracking.

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace to describe.

" + } + } + }, + "DissociateEntityFromThingRequest":{ + "type":"structure", + "required":[ + "thingName", + "entityType" + ], + "members":{ + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing to disassociate.

" + }, + "entityType":{ + "shape":"EntityType", + "documentation":"

The entity type from which to disassociate the thing.

" + } + } + }, + "DissociateEntityFromThingResponse":{ + "type":"structure", + "members":{ + } + }, + "Enabled":{"type":"boolean"}, + "EntityDescription":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The entity ID.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The entity ARN.

" + }, + "type":{ + "shape":"EntityType", + "documentation":"

The entity type.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The time at which the entity was created.

" + }, + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The definition document of the entity.

" + } + }, + "documentation":"

Describes the properties of an entity.

" + }, + "EntityDescriptions":{ + "type":"list", + "member":{"shape":"EntityDescription"} + }, + "EntityFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"EntityFilterName", + "documentation":"

The name of the entity search filter field. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

" + }, + "value":{ + "shape":"EntityFilterValues", + "documentation":"

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } + }, + "documentation":"

An object that filters an entity search. Multiple filters function as OR criteria in the search. For example a search that includes a NAMESPACE and a REFERENCED_ENTITY_ID filter searches for entities in the specified namespace that use the entity specified by the value of REFERENCED_ENTITY_ID.

" + }, + "EntityFilterName":{ + "type":"string", + "enum":[ + "NAME", + "NAMESPACE", + "SEMANTIC_TYPE_PATH", + "REFERENCED_ENTITY_ID" + ] + }, + "EntityFilterValue":{"type":"string"}, + "EntityFilterValues":{ + "type":"list", + "member":{"shape":"EntityFilterValue"} + }, + "EntityFilters":{ + "type":"list", + "member":{"shape":"EntityFilter"} + }, + "EntityType":{ + "type":"string", + "enum":[ + "DEVICE", + "SERVICE", + "DEVICE_MODEL", + "CAPABILITY", + "STATE", + "ACTION", + "EVENT", + "PROPERTY", + "MAPPING", + "ENUM" + ] + }, + "EntityTypes":{ + "type":"list", + "member":{"shape":"EntityType"} + }, + "ErrorMessage":{ + "type":"string", + "max":2048 + }, + "FlowExecutionEventType":{ + "type":"string", + "enum":[ + "EXECUTION_STARTED", + "EXECUTION_FAILED", + "EXECUTION_ABORTED", + "EXECUTION_SUCCEEDED", + "STEP_STARTED", + "STEP_FAILED", + "STEP_SUCCEEDED", + "ACTIVITY_SCHEDULED", + "ACTIVITY_STARTED", + "ACTIVITY_FAILED", + "ACTIVITY_SUCCEEDED", + "START_FLOW_EXECUTION_TASK", + "SCHEDULE_NEXT_READY_STEPS_TASK", + "THING_ACTION_TASK", + "THING_ACTION_TASK_FAILED", + "THING_ACTION_TASK_SUCCEEDED", + "ACKNOWLEDGE_TASK_MESSAGE" + ] + }, + "FlowExecutionId":{"type":"string"}, + "FlowExecutionMessage":{ + "type":"structure", + "members":{ + "messageId":{ + "shape":"FlowExecutionMessageId", + "documentation":"

The unique identifier of the message.

" + }, + "eventType":{ + "shape":"FlowExecutionEventType", + "documentation":"

The type of flow event .

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

The date and time when the message was last updated.

" + }, + "payload":{ + "shape":"FlowExecutionMessagePayload", + "documentation":"

A string containing information about the flow event.

" + } + }, + "documentation":"

An object that contains information about a flow event.

" + }, + "FlowExecutionMessageId":{"type":"string"}, + "FlowExecutionMessagePayload":{"type":"string"}, + "FlowExecutionMessages":{ + "type":"list", + "member":{"shape":"FlowExecutionMessage"} + }, + "FlowExecutionStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "ABORTED", + "SUCCEEDED", + "FAILED" + ] + }, + "FlowExecutionSummaries":{ + "type":"list", + "member":{"shape":"FlowExecutionSummary"} + }, + "FlowExecutionSummary":{ + "type":"structure", + "members":{ + "flowExecutionId":{ + "shape":"FlowExecutionId", + "documentation":"

The ID of the flow execution.

" + }, + "status":{ + "shape":"FlowExecutionStatus", + "documentation":"

The current status of the flow execution.

" + }, + "systemInstanceId":{ + "shape":"Urn", + "documentation":"

The ID of the system instance that contains the flow.

" + }, + "flowTemplateId":{ + "shape":"Urn", + "documentation":"

The ID of the flow.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The date and time when the flow execution summary was created.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The date and time when the flow execution summary was last updated.

" + } + }, + "documentation":"

An object that contains summary information about a flow execution.

" + }, + "FlowTemplateDescription":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"FlowTemplateSummary", + "documentation":"

An object that contains summary information about a workflow.

" + }, + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

A workflow's definition document.

" + }, + "validatedNamespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace against which the workflow was validated. Use this value in your system instance.

" + } + }, + "documentation":"

An object that contains a workflow's definition and summary information.

" + }, + "FlowTemplateFilter":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"FlowTemplateFilterName", + "documentation":"

The name of the search filter field.

" + }, + "value":{ + "shape":"FlowTemplateFilterValues", + "documentation":"

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } + }, + "documentation":"

An object that filters a workflow search.

" + }, + "FlowTemplateFilterName":{ + "type":"string", + "enum":["DEVICE_MODEL_ID"] + }, + "FlowTemplateFilterValue":{ + "type":"string", + "pattern":"^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\\p{Alnum}_]+(/[\\p{Alnum}_]+)*):([\\p{Alpha}]*):([\\p{Alnum}_]+(/[\\p{Alnum}_]+)*)$" + }, + "FlowTemplateFilterValues":{ + "type":"list", + "member":{"shape":"FlowTemplateFilterValue"} + }, + "FlowTemplateFilters":{ + "type":"list", + "member":{"shape":"FlowTemplateFilter"} + }, + "FlowTemplateSummaries":{ + "type":"list", + "member":{"shape":"FlowTemplateSummary"} + }, + "FlowTemplateSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the workflow.

" + }, + "revisionNumber":{ + "shape":"Version", + "documentation":"

The revision number of the workflow.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The date when the workflow was created.

" + } + }, + "documentation":"

An object that contains summary information about a workflow.

" + }, + "GetEntitiesRequest":{ + "type":"structure", + "required":["ids"], + "members":{ + "ids":{ + "shape":"Urns", + "documentation":"

An array of entity IDs.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + } + } + }, + "GetEntitiesResponse":{ + "type":"structure", + "members":{ + "descriptions":{ + "shape":"EntityDescriptions", + "documentation":"

An array of descriptions for the specified entities.

" + } + } + }, + "GetFlowTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

" + }, + "revisionNumber":{ + "shape":"Version", + "documentation":"

The number of the workflow revision to retrieve.

" + } + } + }, + "GetFlowTemplateResponse":{ + "type":"structure", + "members":{ + "description":{ + "shape":"FlowTemplateDescription", + "documentation":"

The object that describes the specified workflow.

" + } + } + }, + "GetFlowTemplateRevisionsRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "GetFlowTemplateRevisionsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"FlowTemplateSummaries", + "documentation":"

An array of objects that provide summary data about each revision.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "GetNamespaceDeletionStatusRequest":{ + "type":"structure", + "members":{ + } + }, + "GetNamespaceDeletionStatusResponse":{ + "type":"structure", + "members":{ + "namespaceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the namespace that is being deleted.

" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the namespace that is being deleted.

" + }, + "status":{ + "shape":"NamespaceDeletionStatus", + "documentation":"

The status of the deletion request.

" + }, + "errorCode":{ + "shape":"NamespaceDeletionStatusErrorCodes", + "documentation":"

An error code returned by the namespace deletion task.

" + }, + "errorMessage":{ + "shape":"String", + "documentation":"

An error code returned by the namespace deletion task.

" + } + } + }, + "GetSystemInstanceRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system deployment instance. This value is returned by CreateSystemInstance.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:deployment:DEPLOYMENTNAME

" + } + } + }, + "GetSystemInstanceResponse":{ + "type":"structure", + "members":{ + "description":{ + "shape":"SystemInstanceDescription", + "documentation":"

An object that describes the system instance.

" + } + } + }, + "GetSystemTemplateRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system to get. This ID must be in the user's namespace.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

" + }, + "revisionNumber":{ + "shape":"Version", + "documentation":"

The number that specifies the revision of the system to get.

" + } + } + }, + "GetSystemTemplateResponse":{ + "type":"structure", + "members":{ + "description":{ + "shape":"SystemTemplateDescription", + "documentation":"

An object that contains summary data about the system.

" + } + } + }, + "GetSystemTemplateRevisionsRequest":{ + "type":"structure", + "required":["id"], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system template.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "GetSystemTemplateRevisionsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"SystemTemplateSummaries", + "documentation":"

An array of objects that contain summary data about the system template revisions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "GetUploadStatusRequest":{ + "type":"structure", + "required":["uploadId"], + "members":{ + "uploadId":{ + "shape":"UploadId", + "documentation":"

The ID of the upload. This value is returned by the UploadEntityDefinitions action.

" + } + } + }, + "GetUploadStatusResponse":{ + "type":"structure", + "required":[ + "uploadId", + "uploadStatus", + "createdDate" + ], + "members":{ + "uploadId":{ + "shape":"UploadId", + "documentation":"

The ID of the upload.

" + }, + "uploadStatus":{ + "shape":"UploadStatus", + "documentation":"

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

" + }, + "namespaceArn":{ + "shape":"Arn", + "documentation":"

The ARN of the upload.

" + }, + "namespaceName":{ + "shape":"NamespaceName", + "documentation":"

The name of the upload's namespace.

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + }, + "failureReason":{ + "shape":"StringList", + "documentation":"

The reason for an upload failure.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date at which the upload was created.

" + } + } + }, + "GreengrassDeploymentId":{"type":"string"}, + "GreengrassGroupId":{"type":"string"}, + "GreengrassGroupVersionId":{"type":"string"}, + "GroupName":{"type":"string"}, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true, + "fault":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "ListFlowExecutionMessagesRequest":{ + "type":"structure", + "required":["flowExecutionId"], + "members":{ + "flowExecutionId":{ + "shape":"FlowExecutionId", + "documentation":"

The ID of the flow execution.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "ListFlowExecutionMessagesResponse":{ + "type":"structure", + "members":{ + "messages":{ + "shape":"FlowExecutionMessages", + "documentation":"

A list of objects that contain information about events in the specified flow execution.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of tags to return.

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

The Amazon Resource Name (ARN) of the resource whose tags are to be returned.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token that specifies the next page of results to return.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token that specifies the next page of results to return.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":250, + "min":1 + }, + "MetricsConfiguration":{ + "type":"structure", + "members":{ + "cloudMetricEnabled":{ + "shape":"Enabled", + "documentation":"

A Boolean that specifies whether cloud metrics are collected.

" + }, + "metricRuleRoleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the role that is used to collect cloud metrics.

" + } + }, + "documentation":"

An object that specifies whether cloud metrics are collected in a deployment and, if so, what role is used to collect metrics.

" + }, + "NamespaceDeletionStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "NamespaceDeletionStatusErrorCodes":{ + "type":"string", + "enum":["VALIDATION_FAILED"] + }, + "NamespaceName":{ + "type":"string", + "max":128 + }, + "NextToken":{"type":"string"}, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "S3BucketName":{"type":"string"}, + "SearchEntitiesRequest":{ + "type":"structure", + "required":["entityTypes"], + "members":{ + "entityTypes":{ + "shape":"EntityTypes", + "documentation":"

The entity types for which to search.

" + }, + "filters":{ + "shape":"EntityFilters", + "documentation":"

Optional filter to apply to the search. Valid filters are NAME NAMESPACE, SEMANTIC_TYPE_PATH and REFERENCED_ENTITY_ID. REFERENCED_ENTITY_ID filters on entities that are used by the entity in the result set. For example, you can filter on the ID of a property that is used in a state.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + } + } + }, + "SearchEntitiesResponse":{ + "type":"structure", + "members":{ + "descriptions":{ + "shape":"EntityDescriptions", + "documentation":"

An array of descriptions for each entity returned in the search result.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "SearchFlowExecutionsRequest":{ + "type":"structure", + "required":["systemInstanceId"], + "members":{ + "systemInstanceId":{ + "shape":"Urn", + "documentation":"

The ID of the system instance that contains the flow.

" + }, + "flowExecutionId":{ + "shape":"FlowExecutionId", + "documentation":"

The ID of a flow execution.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The date and time of the earliest flow execution to return.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The date and time of the latest flow execution to return.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "SearchFlowExecutionsResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"FlowExecutionSummaries", + "documentation":"

An array of objects that contain summary information about each workflow execution in the result set.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "SearchFlowTemplatesRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"FlowTemplateFilters", + "documentation":"

An array of objects that limit the result set. The only valid filter is DEVICE_MODEL_ID.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "SearchFlowTemplatesResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"FlowTemplateSummaries", + "documentation":"

An array of objects that contain summary information about each workflow in the result set.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "SearchSystemInstancesRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"SystemInstanceFilters", + "documentation":"

Optional filter to apply to the search. Valid filters are SYSTEM_TEMPLATE_ID, STATUS, and GREENGRASS_GROUP_NAME.

Multiple filters function as OR criteria in the query. Multiple values passed inside the filter function as AND criteria.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "SearchSystemInstancesResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"SystemInstanceSummaries", + "documentation":"

An array of objects that contain summary data abour the system instances in the result set.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "SearchSystemTemplatesRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"SystemTemplateFilters", + "documentation":"

An array of filters that limit the result set. The only valid filter is FLOW_TEMPLATE_ID.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + } + } + }, + "SearchSystemTemplatesResponse":{ + "type":"structure", + "members":{ + "summaries":{ + "shape":"SystemTemplateSummaries", + "documentation":"

An array of objects that contain summary information about each system deployment in the result set.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "SearchThingsRequest":{ + "type":"structure", + "required":["entityId"], + "members":{ + "entityId":{ + "shape":"Urn", + "documentation":"

The ID of the entity to which the things are associated.

The IDs should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:device:DEVICENAME

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string that specifies the next page of results. Use this when you're paginating results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to return in the response.

" + }, + "namespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

" + } + } + }, + "SearchThingsResponse":{ + "type":"structure", + "members":{ + "things":{ + "shape":"Things", + "documentation":"

An array of things in the result set.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The string to specify as nextToken when you request the next page of results.

" + } + } + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SyncWithPublicNamespace":{"type":"boolean"}, + "SystemInstanceDeploymentStatus":{ + "type":"string", + "enum":[ + "NOT_DEPLOYED", + "BOOTSTRAP", + "DEPLOY_IN_PROGRESS", + "DEPLOYED_IN_TARGET", + "UNDEPLOY_IN_PROGRESS", + "FAILED", + "PENDING_DELETE", + "DELETED_IN_TARGET" + ] + }, + "SystemInstanceDescription":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemInstanceSummary", + "documentation":"

An object that contains summary information about a system instance.

" + }, + "definition":{"shape":"DefinitionDocument"}, + "s3BucketName":{ + "shape":"S3BucketName", + "documentation":"

The Amazon Simple Storage Service bucket where information about a system instance is stored.

" + }, + "metricsConfiguration":{"shape":"MetricsConfiguration"}, + "validatedNamespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace against which the system instance was validated.

" + }, + "validatedDependencyRevisions":{ + "shape":"DependencyRevisions", + "documentation":"

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

" + }, + "flowActionsRoleArn":{ + "shape":"RoleArn", + "documentation":"

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

" + } + }, + "documentation":"

An object that contains a system instance definition and summary information.

" + }, + "SystemInstanceFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SystemInstanceFilterName", + "documentation":"

The name of the search filter field.

" + }, + "value":{ + "shape":"SystemInstanceFilterValues", + "documentation":"

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } + }, + "documentation":"

An object that filters a system instance search. Multiple filters function as OR criteria in the search. For example a search that includes a GREENGRASS_GROUP_NAME and a STATUS filter searches for system instances in the specified Greengrass group that have the specified status.

" + }, + "SystemInstanceFilterName":{ + "type":"string", + "enum":[ + "SYSTEM_TEMPLATE_ID", + "STATUS", + "GREENGRASS_GROUP_NAME" + ] + }, + "SystemInstanceFilterValue":{"type":"string"}, + "SystemInstanceFilterValues":{ + "type":"list", + "member":{"shape":"SystemInstanceFilterValue"} + }, + "SystemInstanceFilters":{ + "type":"list", + "member":{"shape":"SystemInstanceFilter"} + }, + "SystemInstanceSummaries":{ + "type":"list", + "member":{"shape":"SystemInstanceSummary"} + }, + "SystemInstanceSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system instance.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the system instance.

" + }, + "status":{ + "shape":"SystemInstanceDeploymentStatus", + "documentation":"

The status of the system instance.

" + }, + "target":{ + "shape":"DeploymentTarget", + "documentation":"

The target of the system instance.

" + }, + "greengrassGroupName":{ + "shape":"GroupName", + "documentation":"

The ID of the Greengrass group where the system instance is deployed.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The date when the system instance was created.

" + }, + "updatedAt":{ + "shape":"Timestamp", + "documentation":"

The date and time when the system instance was last updated.

" + }, + "greengrassGroupId":{ + "shape":"GreengrassGroupId", + "documentation":"

The ID of the Greengrass group where the system instance is deployed.

" + }, + "greengrassGroupVersionId":{ + "shape":"GreengrassGroupVersionId", + "documentation":"

The version of the Greengrass group where the system instance is deployed.

" + } + }, + "documentation":"

An object that contains summary information about a system instance.

" + }, + "SystemTemplateDescription":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemTemplateSummary", + "documentation":"

An object that contains summary information about a system.

" + }, + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The definition document of a system.

" + }, + "validatedNamespaceVersion":{ + "shape":"Version", + "documentation":"

The namespace version against which the system was validated. Use this value in your system instance.

" + } + }, + "documentation":"

An object that contains a system's definition document and summary information.

" + }, + "SystemTemplateFilter":{ + "type":"structure", + "required":[ + "name", + "value" + ], + "members":{ + "name":{ + "shape":"SystemTemplateFilterName", + "documentation":"

The name of the system search filter field.

" + }, + "value":{ + "shape":"SystemTemplateFilterValues", + "documentation":"

An array of string values for the search filter field. Multiple values function as AND criteria in the search.

" + } + }, + "documentation":"

An object that filters a system search.

" + }, + "SystemTemplateFilterName":{ + "type":"string", + "enum":["FLOW_TEMPLATE_ID"] + }, + "SystemTemplateFilterValue":{ + "type":"string", + "pattern":"^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\\p{Alnum}_]+(/[\\p{Alnum}_]+)*):([\\p{Alpha}]*):([\\p{Alnum}_]+(/[\\p{Alnum}_]+)*)$" + }, + "SystemTemplateFilterValues":{ + "type":"list", + "member":{"shape":"SystemTemplateFilterValue"} + }, + "SystemTemplateFilters":{ + "type":"list", + "member":{"shape":"SystemTemplateFilter"} + }, + "SystemTemplateSummaries":{ + "type":"list", + "member":{"shape":"SystemTemplateSummary"} + }, + "SystemTemplateSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of the system.

" + }, + "revisionNumber":{ + "shape":"Version", + "documentation":"

The revision number of the system.

" + }, + "createdAt":{ + "shape":"Timestamp", + "documentation":"

The date when the system was created.

" + } + }, + "documentation":"

An object that contains information about a system.

" + }, + "Tag":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length.

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length.

" + } + }, + "documentation":"

Metadata assigned to an AWS IoT Things Graph resource consisting of a key-value pair.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags are returned.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

A list of tags to add to the resource.>

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Thing":{ + "type":"structure", + "members":{ + "thingArn":{ + "shape":"ThingArn", + "documentation":"

The ARN of the thing.

" + }, + "thingName":{ + "shape":"ThingName", + "documentation":"

The name of the thing.

" + } + }, + "documentation":"

An AWS IoT thing.

" + }, + "ThingArn":{"type":"string"}, + "ThingName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9:_-]+" + }, + "Things":{ + "type":"list", + "member":{"shape":"Thing"} + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UndeploySystemInstanceRequest":{ + "type":"structure", + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system instance to remove from its target.

" + } + } + }, + "UndeploySystemInstanceResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemInstanceSummary", + "documentation":"

An object that contains summary information about the system instance that was removed from its target.

" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource whose tags are to be removed.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag key names to remove from the resource. You don't specify the value. Both the key and its associated value are removed.

This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateFlowTemplateRequest":{ + "type":"structure", + "required":[ + "id", + "definition" + ], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the workflow to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:workflow:WORKFLOWNAME

" + }, + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The DefinitionDocument that contains the updated workflow definition.

" + }, + "compatibleNamespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace.

If no value is specified, the latest version is used by default. Use the GetFlowTemplateRevisions if you want to find earlier revisions of the flow to update.

" + } + } + }, + "UpdateFlowTemplateResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"FlowTemplateSummary", + "documentation":"

An object containing summary information about the updated workflow.

" + } + } + }, + "UpdateSystemTemplateRequest":{ + "type":"structure", + "required":[ + "id", + "definition" + ], + "members":{ + "id":{ + "shape":"Urn", + "documentation":"

The ID of the system to be updated.

The ID should be in the following format.

urn:tdm:REGION/ACCOUNT ID/default:system:SYSTEMNAME

" + }, + "definition":{ + "shape":"DefinitionDocument", + "documentation":"

The DefinitionDocument that contains the updated system definition.

" + }, + "compatibleNamespaceVersion":{ + "shape":"Version", + "documentation":"

The version of the user's namespace. Defaults to the latest version of the user's namespace.

If no value is specified, the latest version is used by default.

" + } + } + }, + "UpdateSystemTemplateResponse":{ + "type":"structure", + "members":{ + "summary":{ + "shape":"SystemTemplateSummary", + "documentation":"

An object containing summary information about the updated system.

" + } + } + }, + "UploadEntityDefinitionsRequest":{ + "type":"structure", + "members":{ + "document":{ + "shape":"DefinitionDocument", + "documentation":"

The DefinitionDocument that defines the updated entities.

" + }, + "syncWithPublicNamespace":{ + "shape":"SyncWithPublicNamespace", + "documentation":"

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

" + }, + "deprecateExistingEntities":{ + "shape":"DeprecateExistingEntities", + "documentation":"

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

" + } + } + }, + "UploadEntityDefinitionsResponse":{ + "type":"structure", + "required":["uploadId"], + "members":{ + "uploadId":{ + "shape":"UploadId", + "documentation":"

The ID that specifies the upload action. You can use this to track the status of the upload.

" + } + } + }, + "UploadId":{ + "type":"string", + "max":40, + "min":1 + }, + "UploadStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "Urn":{ + "type":"string", + "max":160, + "pattern":"^urn:tdm:(([a-z]{2}-(gov-)?[a-z]{4,9}-[0-9]{1,3}/[0-9]+/)*[\\p{Alnum}_]+(/[\\p{Alnum}_]+)*):([\\p{Alpha}]*):([\\p{Alnum}_]+(/[\\p{Alnum}_]+)*)$" + }, + "Urns":{ + "type":"list", + "member":{"shape":"Urn"}, + "max":25, + "min":0 + }, + "Version":{"type":"long"} + }, + "documentation":"AWS IoT Things Graph

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.

For more information about how AWS IoT Things Graph works, see the User Guide.

" +} diff --git a/aws/dist/botocore/data/kafka/2018-11-14/paginators-1.json b/aws/dist/botocore/data/kafka/2018-11-14/paginators-1.json new file mode 100644 index 00000000..075d2aff --- /dev/null +++ b/aws/dist/botocore/data/kafka/2018-11-14/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListClusters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClusterInfoList" + }, + "ListNodes": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NodeInfoList" + }, + "ListConfigurations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Configurations" + }, + "ListClusterOperations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ClusterOperationInfoList" + }, + "ListConfigurationRevisions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Revisions" + } + } +} diff --git a/aws/dist/botocore/data/kafka/2018-11-14/service-2.json b/aws/dist/botocore/data/kafka/2018-11-14/service-2.json new file mode 100644 index 00000000..c43cf454 --- /dev/null +++ b/aws/dist/botocore/data/kafka/2018-11-14/service-2.json @@ -0,0 +1,2297 @@ +{ + "metadata": { + "apiVersion": "2018-11-14", + "endpointPrefix": "kafka", + "signingName": "kafka", + "serviceFullName": "Managed Streaming for Kafka", + "serviceAbbreviation": "Kafka", + "serviceId": "Kafka", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "kafka-2018-11-14", + "signatureVersion": "v4" + }, + "operations": { + "CreateCluster": { + "name": "CreateCluster", + "http": { + "method": "POST", + "requestUri": "/v1/clusters", + "responseCode": 200 + }, + "input": { + "shape": "CreateClusterRequest" + }, + "output": { + "shape": "CreateClusterResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + }, + { + "shape": "ConflictException", + "documentation": "\n

This cluster name already exists. Retry your request using another name.

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

Creates a new MSK cluster.

\n " + }, + "CreateConfiguration": { + "name": "CreateConfiguration", + "http": { + "method": "POST", + "requestUri": "/v1/configurations", + "responseCode": 200 + }, + "input": { + "shape": "CreateConfigurationRequest" + }, + "output": { + "shape": "CreateConfigurationResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "TooManyRequestsException", + "documentation": "\n

429 response

\n " + }, + { + "shape": "ConflictException", + "documentation": "\n

This cluster name already exists. Retry your request using another name.

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

Creates a new MSK configuration.

\n " + }, + "DeleteCluster": { + "name": "DeleteCluster", + "http": { + "method": "DELETE", + "requestUri": "/v1/clusters/{clusterArn}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteClusterRequest" + }, + "output": { + "shape": "DeleteClusterResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Deletes the MSK cluster specified by the Amazon Resource Name (ARN) in the request.

\n " + }, + "DescribeCluster": { + "name": "DescribeCluster", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeClusterRequest" + }, + "output": { + "shape": "DescribeClusterResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a description of the MSK cluster whose Amazon Resource Name (ARN) is specified in the request.

\n " + }, + "DescribeClusterOperation": { + "name": "DescribeClusterOperation", + "http": { + "method": "GET", + "requestUri": "/v1/operations/{clusterOperationArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeClusterOperationRequest" + }, + "output": { + "shape": "DescribeClusterOperationResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a description of the cluster operation specified by the ARN.

\n " + }, + "DescribeConfiguration": { + "name": "DescribeConfiguration", + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{arn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeConfigurationRequest" + }, + "output": { + "shape": "DescribeConfigurationResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

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

Returns a description of this MSK configuration.

\n " + }, + "DescribeConfigurationRevision": { + "name": "DescribeConfigurationRevision", + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{arn}/revisions/{revision}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeConfigurationRevisionRequest" + }, + "output": { + "shape": "DescribeConfigurationRevisionResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

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

Returns a description of this revision of the configuration.

\n " + }, + "GetBootstrapBrokers": { + "name": "GetBootstrapBrokers", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/bootstrap-brokers", + "responseCode": 200 + }, + "input": { + "shape": "GetBootstrapBrokersRequest" + }, + "output": { + "shape": "GetBootstrapBrokersResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ConflictException", + "documentation": "\n

This cluster name already exists. Retry your request using another name.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

A list of brokers that a client application can use to bootstrap.

\n " + }, + "ListClusterOperations": { + "name": "ListClusterOperations", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/operations", + "responseCode": 200 + }, + "input": { + "shape": "ListClusterOperationsRequest" + }, + "output": { + "shape": "ListClusterOperationsResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a list of all the operations that have been performed on the specified MSK cluster.

\n " + }, + "ListClusters": { + "name": "ListClusters", + "http": { + "method": "GET", + "requestUri": "/v1/clusters", + "responseCode": 200 + }, + "input": { + "shape": "ListClustersRequest" + }, + "output": { + "shape": "ListClustersResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a list of all the MSK clusters in the current Region.

\n " + }, + "ListConfigurationRevisions": { + "name": "ListConfigurationRevisions", + "http": { + "method": "GET", + "requestUri": "/v1/configurations/{arn}/revisions", + "responseCode": 200 + }, + "input": { + "shape": "ListConfigurationRevisionsRequest" + }, + "output": { + "shape": "ListConfigurationRevisionsResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

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

Returns a list of all the MSK configurations in this Region.

\n " + }, + "ListConfigurations": { + "name": "ListConfigurations", + "http": { + "method": "GET", + "requestUri": "/v1/configurations", + "responseCode": 200 + }, + "input": { + "shape": "ListConfigurationsRequest" + }, + "output": { + "shape": "ListConfigurationsResponse", + "documentation": "\n

200 response

\n " + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a list of all the MSK configurations in this Region.

\n " + }, + "ListNodes": { + "name": "ListNodes", + "http": { + "method": "GET", + "requestUri": "/v1/clusters/{clusterArn}/nodes", + "responseCode": 200 + }, + "input": { + "shape": "ListNodesRequest" + }, + "output": { + "shape": "ListNodesResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Returns a list of the broker nodes in the cluster.

\n " + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse", + "documentation": "\n

Success response.

\n " + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

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

Returns a list of the tags associated with the specified resource.

\n " + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

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

Adds tags to the specified MSK resource.

\n " + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

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

Removes the tags associated with the keys that are provided in the query.

\n " + }, + "UpdateBrokerCount": { + "name": "UpdateBrokerCount", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/nodes/count", + "responseCode": 200 + }, + "input": { + "shape": "UpdateBrokerCountRequest" + }, + "output": { + "shape": "UpdateBrokerCountResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Updates the number of broker nodes in the cluster.

\n " + }, + "UpdateBrokerStorage": { + "name": "UpdateBrokerStorage", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/nodes/storage", + "responseCode": 200 + }, + "input": { + "shape": "UpdateBrokerStorageRequest" + }, + "output": { + "shape": "UpdateBrokerStorageResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

\n " + }, + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

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

Updates the EBS storage associated with MSK brokers.

\n " + }, + "UpdateClusterConfiguration": { + "name": "UpdateClusterConfiguration", + "http": { + "method": "PUT", + "requestUri": "/v1/clusters/{clusterArn}/configuration", + "responseCode": 200 + }, + "input": { + "shape": "UpdateClusterConfigurationRequest" + }, + "output": { + "shape": "UpdateClusterConfigurationResponse", + "documentation": "\n

Successful response.

\n " + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "\n

The request isn't valid because the input is incorrect. Correct your input and then submit it again.

\n " + }, + { + "shape": "UnauthorizedException", + "documentation": "\n

The request is not authorized. The provided credentials couldn't be validated.

\n " + }, + { + "shape": "InternalServerErrorException", + "documentation": "\n

There was an unexpected internal server error. Retrying your request might resolve the issue.

\n " + }, + { + "shape": "ForbiddenException", + "documentation": "\n

Access forbidden. Check your credentials and then retry your request.

\n " + }, + { + "shape": "NotFoundException", + "documentation": "\n

The resource could not be found due to incorrect input. Correct the input, then retry the request.

\n " + }, + { + "shape": "ServiceUnavailableException", + "documentation": "\n

503 response

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

Updates the cluster with the configuration that is specified in the request body.

\n " + } + }, + "shapes": { + "BadRequestException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 400 + } + }, + "BrokerAZDistribution": { + "type": "string", + "documentation": "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

\n ", + "enum": [ + "DEFAULT" + ] + }, + "BrokerEBSVolumeInfo": { + "type": "structure", + "members": { + "KafkaBrokerNodeId": { + "shape": "__string", + "locationName": "kafkaBrokerNodeId", + "documentation": "\n

The ID of the broker to update.

\n " + }, + "VolumeSizeGB": { + "shape": "__integer", + "locationName": "volumeSizeGB", + "documentation": "\n

Size of the EBS volume to update.

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

Specifies the EBS volume upgrade information. The broker identifier must be set to the keyword ALL. This means the changes apply to all the brokers in the cluster.

\n ", + "required": [ + "VolumeSizeGB", + "KafkaBrokerNodeId" + ] + }, + "BrokerNodeGroupInfo": { + "type": "structure", + "members": { + "BrokerAZDistribution": { + "shape": "BrokerAZDistribution", + "locationName": "brokerAZDistribution", + "documentation": "\n

The distribution of broker nodes across Availability Zones. This is an optional parameter. If you don't specify it, Amazon MSK gives it the value DEFAULT. You can also explicitly set this parameter to the value DEFAULT. No other values are currently allowed.

\n

Amazon MSK distributes the broker nodes evenly across the Availability Zones that correspond to the subnets you provide when you create the cluster.

\n " + }, + "ClientSubnets": { + "shape": "__listOf__string", + "locationName": "clientSubnets", + "documentation": "\n

The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data. Client subnets can't be in Availability Zone us-east-1e.

\n " + }, + "InstanceType": { + "shape": "__stringMin5Max32", + "locationName": "instanceType", + "documentation": "\n

The type of Amazon EC2 instances to use for Kafka brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge,\nkafka.m5.4xlarge, kafka.m5.12xlarge, and kafka.m5.24xlarge.

\n " + }, + "SecurityGroups": { + "shape": "__listOf__string", + "locationName": "securityGroups", + "documentation": "\n

The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.

\n " + }, + "StorageInfo": { + "shape": "StorageInfo", + "locationName": "storageInfo", + "documentation": "\n

Contains information about storage volumes attached to MSK broker nodes.

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

Describes the setup to be used for Kafka broker nodes in the cluster.

\n ", + "required": [ + "ClientSubnets", + "InstanceType" + ] + }, + "BrokerNodeInfo": { + "type": "structure", + "members": { + "AttachedENIId": { + "shape": "__string", + "locationName": "attachedENIId", + "documentation": "\n

The attached elastic network interface of the broker.

\n " + }, + "BrokerId": { + "shape": "__double", + "locationName": "brokerId", + "documentation": "\n

The ID of the broker.

\n " + }, + "ClientSubnet": { + "shape": "__string", + "locationName": "clientSubnet", + "documentation": "\n

The client subnet to which this broker node belongs.

\n " + }, + "ClientVpcIpAddress": { + "shape": "__string", + "locationName": "clientVpcIpAddress", + "documentation": "\n

The virtual private cloud (VPC) of the client.

\n " + }, + "CurrentBrokerSoftwareInfo": { + "shape": "BrokerSoftwareInfo", + "locationName": "currentBrokerSoftwareInfo", + "documentation": "\n

Information about the version of software currently deployed on the Kafka brokers in the cluster.

\n " + }, + "Endpoints": { + "shape": "__listOf__string", + "locationName": "endpoints", + "documentation": "\n

Endpoints for accessing the broker.

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

BrokerNodeInfo

\n " + }, + "BrokerSoftwareInfo": { + "type": "structure", + "members": { + "ConfigurationArn": { + "shape": "__string", + "locationName": "configurationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the configuration used for the cluster. This field isn't visible in this preview release.

\n " + }, + "ConfigurationRevision": { + "shape": "__long", + "locationName": "configurationRevision", + "documentation": "\n

The revision of the configuration to use. This field isn't visible in this preview release.

\n " + }, + "KafkaVersion": { + "shape": "__string", + "locationName": "kafkaVersion", + "documentation": "\n

The version of Apache Kafka.

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

Information about the current software installed on the cluster.

\n " + }, + "ClientAuthentication": { + "type": "structure", + "members": { + "Tls": { + "shape": "Tls", + "locationName": "tls", + "documentation": "\n

Details for ClientAuthentication using TLS.

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

Includes all client authentication information.

\n " + }, + "ClientBroker": { + "type": "string", + "documentation": "\n

Client-broker encryption in transit setting.

\n ", + "enum": [ + "TLS", + "TLS_PLAINTEXT", + "PLAINTEXT" + ] + }, + "ClusterInfo": { + "type": "structure", + "members": { + "ActiveOperationArn": { + "shape": "__string", + "locationName": "activeOperationArn", + "documentation": "\n

Arn of active cluster operation.

\n " + }, + "BrokerNodeGroupInfo": { + "shape": "BrokerNodeGroupInfo", + "locationName": "brokerNodeGroupInfo", + "documentation": "\n

Information about the broker nodes.

\n " + }, + "ClientAuthentication": { + "shape": "ClientAuthentication", + "locationName": "clientAuthentication", + "documentation": "\n

Includes all client authentication information.

\n " + }, + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "ClusterName": { + "shape": "__string", + "locationName": "clusterName", + "documentation": "\n

The name of the cluster.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the cluster was created.

\n " + }, + "CurrentBrokerSoftwareInfo": { + "shape": "BrokerSoftwareInfo", + "locationName": "currentBrokerSoftwareInfo", + "documentation": "\n

Information about the version of software currently deployed on the Kafka brokers in the cluster.

\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\n

The current version of the MSK cluster.

\n " + }, + "EncryptionInfo": { + "shape": "EncryptionInfo", + "locationName": "encryptionInfo", + "documentation": "\n

Includes all encryption-related information.

\n " + }, + "EnhancedMonitoring": { + "shape": "EnhancedMonitoring", + "locationName": "enhancedMonitoring", + "documentation": "\n

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

\n " + }, + "NumberOfBrokerNodes": { + "shape": "__integer", + "locationName": "numberOfBrokerNodes", + "documentation": "\n

The number of broker nodes in the cluster.

\n " + }, + "State": { + "shape": "ClusterState", + "locationName": "state", + "documentation": "\n

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

\n " + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "\n

Tags attached to the cluster.

\n " + }, + "ZookeeperConnectString": { + "shape": "__string", + "locationName": "zookeeperConnectString", + "documentation": "\n

The connection string to use to connect to the Apache ZooKeeper cluster.

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

Returns information about a cluster.

\n " + }, + "ClusterOperationInfo": { + "type": "structure", + "members": { + "ClientRequestId": { + "shape": "__string", + "locationName": "clientRequestId", + "documentation": "\n

The ID of the API request that triggered this operation.

\n " + }, + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

ARN of the cluster.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time that the operation was created.

\n " + }, + "EndTime": { + "shape": "__timestampIso8601", + "locationName": "endTime", + "documentation": "\n

The time at which the operation finished.

\n " + }, + "ErrorInfo": { + "shape": "ErrorInfo", + "locationName": "errorInfo", + "documentation": "\n

Describes the error if the operation fails.

\n " + }, + "OperationArn": { + "shape": "__string", + "locationName": "operationArn", + "documentation": "\n

ARN of the cluster operation.

\n " + }, + "OperationState": { + "shape": "__string", + "locationName": "operationState", + "documentation": "\n

State of the cluster operation.

\n " + }, + "OperationType": { + "shape": "__string", + "locationName": "operationType", + "documentation": "\n

Type of the cluster operation.

\n " + }, + "SourceClusterInfo": { + "shape": "MutableClusterInfo", + "locationName": "sourceClusterInfo", + "documentation": "\n

Information about cluster attributes before a cluster is updated.

\n " + }, + "TargetClusterInfo": { + "shape": "MutableClusterInfo", + "locationName": "targetClusterInfo", + "documentation": "\n

Information about cluster attributes after a cluster is updated.

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

Returns information about a cluster operation.

\n " + }, + "ClusterState": { + "type": "string", + "documentation": "\n

The state of a Kafka cluster.

\n ", + "enum": [ + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "FAILED" + ] + }, + "Configuration": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the configuration was created.

\n " + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "\n

The description of the configuration.

\n " + }, + "KafkaVersions": { + "shape": "__listOf__string", + "locationName": "kafkaVersions", + "documentation": "\n

An array of the versions of Apache Kafka with which you can use this MSK configuration. You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this array.

\n " + }, + "LatestRevision": { + "shape": "ConfigurationRevision", + "locationName": "latestRevision", + "documentation": "\n

Latest revision of the configuration.

\n " + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "\n

The name of the configuration.

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

Represents an MSK Configuration.

\n ", + "required": [ + "Description", + "LatestRevision", + "CreationTime", + "KafkaVersions", + "Arn", + "Name" + ] + }, + "ConfigurationInfo": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "\n

ARN of the configuration to use.

\n " + }, + "Revision": { + "shape": "__long", + "locationName": "revision", + "documentation": "\n

The revision of the configuration to use.

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

Specifies the configuration to use for the brokers.

\n ", + "required": [ + "Revision", + "Arn" + ] + }, + "ConfigurationRevision": { + "type": "structure", + "members": { + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the configuration revision was created.

\n " + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "\n

The description of the configuration revision.

\n " + }, + "Revision": { + "shape": "__long", + "locationName": "revision", + "documentation": "\n

The revision number.

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

Describes a configuration revision.

\n ", + "required": [ + "Revision", + "CreationTime" + ] + }, + "ConflictException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 409 + } + }, + "CreateClusterRequest": { + "type": "structure", + "members": { + "BrokerNodeGroupInfo": { + "shape": "BrokerNodeGroupInfo", + "locationName": "brokerNodeGroupInfo", + "documentation": "\n

Information about the broker nodes in the cluster.

\n " + }, + "ClientAuthentication": { + "shape": "ClientAuthentication", + "locationName": "clientAuthentication", + "documentation": "\n

Includes all client authentication related information.

\n " + }, + "ClusterName": { + "shape": "__stringMin1Max64", + "locationName": "clusterName", + "documentation": "\n

The name of the cluster.

\n " + }, + "ConfigurationInfo": { + "shape": "ConfigurationInfo", + "locationName": "configurationInfo", + "documentation": "\n

Represents the configuration that you want MSK to use for the brokers in a cluster.

\n " + }, + "EncryptionInfo": { + "shape": "EncryptionInfo", + "locationName": "encryptionInfo", + "documentation": "\n

Includes all encryption-related information.

\n " + }, + "EnhancedMonitoring": { + "shape": "EnhancedMonitoring", + "locationName": "enhancedMonitoring", + "documentation": "\n

Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.

\n " + }, + "KafkaVersion": { + "shape": "__stringMin1Max128", + "locationName": "kafkaVersion", + "documentation": "\n

The version of Apache Kafka.

\n " + }, + "NumberOfBrokerNodes": { + "shape": "__integerMin1Max15", + "locationName": "numberOfBrokerNodes", + "documentation": "\n

The number of broker nodes in the cluster.

\n " + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "\n

Create tags when creating the cluster.

\n " + } + }, + "required": [ + "BrokerNodeGroupInfo", + "KafkaVersion", + "NumberOfBrokerNodes", + "ClusterName" + ] + }, + "CreateClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " + }, + "ClusterName": { + "shape": "__string", + "locationName": "clusterName", + "documentation": "\n

The name of the MSK cluster.

\n " + }, + "State": { + "shape": "ClusterState", + "locationName": "state", + "documentation": "\n

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

\n " + } + } + }, + "CreateConfigurationRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "\n

The description of the configuration.

\n " + }, + "KafkaVersions": { + "shape": "__listOf__string", + "locationName": "kafkaVersions", + "documentation": "\n

The versions of Apache Kafka with which you can use this MSK configuration.

\n " + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "\n

The name of the configuration.

\n " + }, + "ServerProperties": { + "shape": "__blob", + "locationName": "serverProperties", + "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " + } + }, + "required": [ + "ServerProperties", + "KafkaVersions", + "Name" + ] + }, + "CreateConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the configuration was created.

\n " + }, + "LatestRevision": { + "shape": "ConfigurationRevision", + "locationName": "latestRevision", + "documentation": "\n

Latest revision of the configuration.

\n " + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "\n

The name of the configuration.

\n " + } + } + }, + "DeleteClusterRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "CurrentVersion": { + "shape": "__string", + "location": "querystring", + "locationName": "currentVersion", + "documentation": "\n

The current version of the MSK cluster.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "DeleteClusterResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " + }, + "State": { + "shape": "ClusterState", + "locationName": "state", + "documentation": "\n

The state of the cluster. The possible states are CREATING, ACTIVE, and FAILED.

\n " + } + } + }, + "DescribeClusterOperationRequest": { + "type": "structure", + "members": { + "ClusterOperationArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the MSK cluster operation.

\n " + } + }, + "required": [ + "ClusterOperationArn" + ] + }, + "DescribeClusterOperationResponse": { + "type": "structure", + "members": { + "ClusterOperationInfo": { + "shape": "ClusterOperationInfo", + "locationName": "clusterOperationInfo", + "documentation": "\n

Cluster operation information

\n " + } + } + }, + "DescribeClusterRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "DescribeClusterResponse": { + "type": "structure", + "members": { + "ClusterInfo": { + "shape": "ClusterInfo", + "locationName": "clusterInfo", + "documentation": "\n

The cluster information.

\n " + } + } + }, + "DescribeConfigurationRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "location": "uri", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " + } + }, + "required": [ + "Arn" + ] + }, + "DescribeConfigurationResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the configuration was created.

\n " + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "\n

The description of the configuration.

\n " + }, + "KafkaVersions": { + "shape": "__listOf__string", + "locationName": "kafkaVersions", + "documentation": "\n

The versions of Apache Kafka with which you can use this MSK configuration.

\n " + }, + "LatestRevision": { + "shape": "ConfigurationRevision", + "locationName": "latestRevision", + "documentation": "\n

Latest revision of the configuration.

\n " + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "\n

The name of the configuration.

\n " + } + } + }, + "DescribeConfigurationRevisionRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "location": "uri", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " + }, + "Revision": { + "shape": "__long", + "location": "uri", + "locationName": "revision", + "documentation": "\n

A string that uniquely identifies a revision of an MSK configuration.

\n " + } + }, + "required": [ + "Revision", + "Arn" + ] + }, + "DescribeConfigurationRevisionResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) of the configuration.

\n " + }, + "CreationTime": { + "shape": "__timestampIso8601", + "locationName": "creationTime", + "documentation": "\n

The time when the configuration was created.

\n " + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "\n

The description of the configuration.

\n " + }, + "Revision": { + "shape": "__long", + "locationName": "revision", + "documentation": "\n

The revision number.

\n " + }, + "ServerProperties": { + "shape": "__blob", + "locationName": "serverProperties", + "documentation": "\n

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. \n When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.properties can be in plaintext.

\n " + } + } + }, + "EBSStorageInfo": { + "type": "structure", + "members": { + "VolumeSize": { + "shape": "__integerMin1Max16384", + "locationName": "volumeSize", + "documentation": "\n

The size in GiB of the EBS volume for the data drive on each broker node.

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

Contains information about the EBS storage volumes attached to Kafka broker nodes.

\n " + }, + "EncryptionAtRest": { + "type": "structure", + "members": { + "DataVolumeKMSKeyId": { + "shape": "__string", + "locationName": "dataVolumeKMSKeyId", + "documentation": "\n

The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.

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

The data-volume encryption details.

\n ", + "required": [ + "DataVolumeKMSKeyId" + ] + }, + "EncryptionInTransit": { + "type": "structure", + "members": { + "ClientBroker": { + "shape": "ClientBroker", + "locationName": "clientBroker", + "documentation": "\n

Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values.

\n

\n TLS means that client-broker communication is enabled with TLS only.

\n

\n TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.

\n

\n PLAINTEXT means that client-broker communication is enabled in plaintext only.

\n

The default value is TLS_PLAINTEXT.

\n " + }, + "InCluster": { + "shape": "__boolean", + "locationName": "inCluster", + "documentation": "\n

When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.

\n

The default value is true.

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

The settings for encrypting data in transit.

\n " + }, + "EncryptionInfo": { + "type": "structure", + "members": { + "EncryptionAtRest": { + "shape": "EncryptionAtRest", + "locationName": "encryptionAtRest", + "documentation": "\n

The data-volume encryption details.

\n " + }, + "EncryptionInTransit": { + "shape": "EncryptionInTransit", + "locationName": "encryptionInTransit", + "documentation": "\n

The details for encryption in transit.

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

Includes encryption-related information, such as the AWS KMS key used for encrypting data at rest and whether you want MSK to encrypt your data in transit.

\n " + }, + "EnhancedMonitoring": { + "type": "string", + "documentation": "\n

Specifies which metrics are gathered for the MSK cluster. This property has three possible values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER. For a list of the metrics associated with each of these three levels of monitoring, see Monitoring.

\n ", + "enum": [ + "DEFAULT", + "PER_BROKER", + "PER_TOPIC_PER_BROKER" + ] + }, + "Error": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n " + }, + "ErrorInfo": { + "type": "structure", + "members": { + "ErrorCode": { + "shape": "__string", + "locationName": "errorCode", + "documentation": "\n

A number describing the error programmatically.

\n " + }, + "ErrorString": { + "shape": "__string", + "locationName": "errorString", + "documentation": "\n

An optional field to provide more details about the error.

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

Returns information about an error state of the cluster.

\n " + }, + "ForbiddenException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 403 + } + }, + "GetBootstrapBrokersRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "GetBootstrapBrokersResponse": { + "type": "structure", + "members": { + "BootstrapBrokerString": { + "shape": "__string", + "locationName": "bootstrapBrokerString", + "documentation": "\n

A string containing one or more hostname:port pairs.

\n " + }, + "BootstrapBrokerStringTls": { + "shape": "__string", + "locationName": "bootstrapBrokerStringTls", + "documentation": "\n

A string containing one or more DNS names (or IP) and TLS port pairs.

\n " + } + } + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 500 + } + }, + "ListClusterOperationsRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "ListClusterOperationsResponse": { + "type": "structure", + "members": { + "ClusterOperationInfoList": { + "shape": "__listOfClusterOperationInfo", + "locationName": "clusterOperationInfoList", + "documentation": "\n

An array of cluster operation information objects.

\n " + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\n

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

\n " + } + } + }, + "ListClustersRequest": { + "type": "structure", + "members": { + "ClusterNameFilter": { + "shape": "__string", + "location": "querystring", + "locationName": "clusterNameFilter", + "documentation": "\n

Specify a prefix of the name of the clusters that you want to list. The service lists all the clusters whose names start with this prefix.

\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " + } + } + }, + "ListClustersResponse": { + "type": "structure", + "members": { + "ClusterInfoList": { + "shape": "__listOfClusterInfo", + "locationName": "clusterInfoList", + "documentation": "\n

Information on each of the MSK clusters in the response.

\n " + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. \n To get another batch of clusters, provide this token in your next request.

\n " + } + } + }, + "ListConfigurationRevisionsRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "location": "uri", + "locationName": "arn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies an MSK configuration and all of its revisions.

\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " + } + }, + "required": [ + "Arn" + ] + }, + "ListConfigurationRevisionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\n

Paginated results marker.

\n " + }, + "Revisions": { + "shape": "__listOfConfigurationRevision", + "locationName": "revisions", + "documentation": "\n

List of ConfigurationRevision objects.

\n " + } + } + }, + "ListConfigurationsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " + } + } + }, + "ListConfigurationsResponse": { + "type": "structure", + "members": { + "Configurations": { + "shape": "__listOfConfiguration", + "locationName": "configurations", + "documentation": "\n

An array of MSK configurations.

\n " + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of a ListConfigurations operation is truncated, the call returns NextToken in the response. \n To get another batch of configurations, provide this token in your next request.

\n " + } + } + }, + "ListNodesRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "\n

The maximum number of results to return in the response. If there are more results, the response includes a NextToken parameter.

\n " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of the operation is truncated, the call returns NextToken in the response. \n To get the next batch, provide this token in your next request.

\n " + } + }, + "required": [ + "ClusterArn" + ] + }, + "ListNodesResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "\n

The paginated results marker. When the result of a ListNodes operation is truncated, the call returns NextToken in the response. \n To get another batch of nodes, provide this token in your next request.

\n " + }, + "NodeInfoList": { + "shape": "__listOfNodeInfo", + "locationName": "nodeInfoList", + "documentation": "\n

List containing a NodeInfo object.

\n " + } + } + }, + "ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " + } + }, + "required": [ + "ResourceArn" + ] + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "\n

The key-value pair for the resource tag.

\n " + } + } + }, + "MaxResults": { + "type": "integer", + "min": 1, + "max": 100 + }, + "MutableClusterInfo": { + "type": "structure", + "members": { + "BrokerEBSVolumeInfo": { + "shape": "__listOfBrokerEBSVolumeInfo", + "locationName": "brokerEBSVolumeInfo", + "documentation": "\n

Specifies the size of the EBS volume and the ID of the associated broker.

\n " + }, + "ConfigurationInfo": { + "shape": "ConfigurationInfo", + "locationName": "configurationInfo", + "documentation": "\n

Information about the changes in the configuration of the brokers.

\n " + }, + "NumberOfBrokerNodes": { + "shape": "__integer", + "locationName": "numberOfBrokerNodes", + "documentation": "\n

The number of broker nodes in the cluster.

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

Information about cluster attributes that can be updated via update APIs.

\n " + }, + "NodeInfo": { + "type": "structure", + "members": { + "AddedToClusterTime": { + "shape": "__string", + "locationName": "addedToClusterTime", + "documentation": "\n

The start time.

\n " + }, + "BrokerNodeInfo": { + "shape": "BrokerNodeInfo", + "locationName": "brokerNodeInfo", + "documentation": "\n

The broker node info.

\n " + }, + "InstanceType": { + "shape": "__string", + "locationName": "instanceType", + "documentation": "\n

The instance type.

\n " + }, + "NodeARN": { + "shape": "__string", + "locationName": "nodeARN", + "documentation": "\n

The Amazon Resource Name (ARN) of the node.

\n " + }, + "NodeType": { + "shape": "NodeType", + "locationName": "nodeType", + "documentation": "\n

The node type.

\n " + }, + "ZookeeperNodeInfo": { + "shape": "ZookeeperNodeInfo", + "locationName": "zookeeperNodeInfo", + "documentation": "\n

The ZookeeperNodeInfo.

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

The node information object.

\n " + }, + "NodeType": { + "type": "string", + "documentation": "\n

The broker or Zookeeper node.

\n ", + "enum": [ + "BROKER" + ] + }, + "NotFoundException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 404 + } + }, + "ServiceUnavailableException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 503 + } + }, + "StorageInfo": { + "type": "structure", + "members": { + "EbsStorageInfo": { + "shape": "EBSStorageInfo", + "locationName": "ebsStorageInfo", + "documentation": "\n

EBS volume information.

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

Contains information about storage volumes attached to MSK broker nodes.

\n " + }, + "TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "\n

The key-value pair for the resource tag.

\n " + } + }, + "required": [ + "ResourceArn", + "Tags" + ] + }, + "Tls": { + "type": "structure", + "members": { + "CertificateAuthorityArnList": { + "shape": "__listOf__string", + "locationName": "certificateAuthorityArnList", + "documentation": "\n

List of ACM Certificate Authority ARNs.

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

Details for client authentication using TLS.

\n " + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 429 + } + }, + "UnauthorizedException": { + "type": "structure", + "members": { + "InvalidParameter": { + "shape": "__string", + "locationName": "invalidParameter", + "documentation": "\n

The parameter that caused the error.

\n " + }, + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "\n

The description of the error.

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

Returns information about an error.

\n ", + "exception": true, + "error": { + "httpStatusCode": 401 + } + }, + "UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the resource that's associated with the tags.

\n " + }, + "TagKeys": { + "shape": "__listOf__string", + "location": "querystring", + "locationName": "tagKeys", + "documentation": "\n

Tag keys must be unique for a given cluster. In addition, the following restrictions apply:

\n
    \n
  • \n

    Each tag key must be unique. If you add a tag with a key that's already in\n use, your new tag overwrites the existing key-value pair.

    \n
    • \n
  • \n

    You can't start a tag key with aws: because this prefix is reserved for use\n by AWS. AWS creates tags that begin with this prefix on your behalf, but\n you can't edit or delete them.

    \n
    • \n
  • \n

    Tag keys must be between 1 and 128 Unicode characters in length.

    \n
    • \n
  • \n

    Tag keys must consist of the following characters: Unicode letters, digits,\n white space, and the following special characters: _ . / = + -\n @.

    \n
    • \n
\n " + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + }, + "UpdateBrokerCountRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\n

The version of cluster to update from. A successful operation will then generate a new version.

\n " + }, + "TargetNumberOfBrokerNodes": { + "shape": "__integerMin1Max15", + "locationName": "targetNumberOfBrokerNodes", + "documentation": "\n

The number of broker nodes that you want the cluster to have after this operation completes successfully.

\n " + } + }, + "required": [ + "ClusterArn", + "CurrentVersion", + "TargetNumberOfBrokerNodes" + ] + }, + "UpdateBrokerCountResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + } + }, + "UpdateBrokerStorageRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\n

The version of cluster to update from. A successful operation will then generate a new version.

\n " + }, + "TargetBrokerEBSVolumeInfo": { + "shape": "__listOfBrokerEBSVolumeInfo", + "locationName": "targetBrokerEBSVolumeInfo", + "documentation": "\n

Describes the target volume size and the ID of the broker to apply the update to.

\n " + } + }, + "required": [ + "ClusterArn", + "TargetBrokerEBSVolumeInfo", + "CurrentVersion" + ] + }, + "UpdateBrokerStorageResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + } + }, + "UpdateClusterConfigurationRequest": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "location": "uri", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

\n " + }, + "ConfigurationInfo": { + "shape": "ConfigurationInfo", + "locationName": "configurationInfo", + "documentation": "\n

Represents the configuration that you want MSK to use for the brokers in a cluster.

\n " + }, + "CurrentVersion": { + "shape": "__string", + "locationName": "currentVersion", + "documentation": "\n

The version of the cluster that needs to be updated.

\n " + } + }, + "required": [ + "ClusterArn", + "CurrentVersion", + "ConfigurationInfo" + ] + }, + "UpdateClusterConfigurationResponse": { + "type": "structure", + "members": { + "ClusterArn": { + "shape": "__string", + "locationName": "clusterArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster.

\n " + }, + "ClusterOperationArn": { + "shape": "__string", + "locationName": "clusterOperationArn", + "documentation": "\n

The Amazon Resource Name (ARN) of the cluster operation.

\n " + } + } + }, + "ZookeeperNodeInfo": { + "type": "structure", + "members": { + "AttachedENIId": { + "shape": "__string", + "locationName": "attachedENIId", + "documentation": "\n

The attached elastic network interface of the broker.

\n " + }, + "ClientVpcIpAddress": { + "shape": "__string", + "locationName": "clientVpcIpAddress", + "documentation": "\n

The virtual private cloud (VPC) IP address of the client.

\n " + }, + "Endpoints": { + "shape": "__listOf__string", + "locationName": "endpoints", + "documentation": "\n

Endpoints for accessing the ZooKeeper.

\n " + }, + "ZookeeperId": { + "shape": "__double", + "locationName": "zookeeperId", + "documentation": "\n

The role-specific ID for Zookeeper.

\n " + }, + "ZookeeperVersion": { + "shape": "__string", + "locationName": "zookeeperVersion", + "documentation": "\n

The version of Zookeeper.

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

Zookeeper node information.

\n " + }, + "__boolean": { + "type": "boolean" + }, + "__blob": { + "type": "blob" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__integerMin1Max15": { + "type": "integer", + "min": 1, + "max": 15 + }, + "__integerMin1Max16384": { + "type": "integer", + "min": 1, + "max": 16384 + }, + "__listOfBrokerEBSVolumeInfo": { + "type": "list", + "member": { + "shape": "BrokerEBSVolumeInfo" + } + }, + "__listOfClusterInfo": { + "type": "list", + "member": { + "shape": "ClusterInfo" + } + }, + "__listOfClusterOperationInfo": { + "type": "list", + "member": { + "shape": "ClusterOperationInfo" + } + }, + "__listOfConfiguration": { + "type": "list", + "member": { + "shape": "Configuration" + } + }, + "__listOfConfigurationRevision": { + "type": "list", + "member": { + "shape": "ConfigurationRevision" + } + }, + "__listOfNodeInfo": { + "type": "list", + "member": { + "shape": "NodeInfo" + } + }, + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" + } + }, + "__long": { + "type": "long" + }, + "__mapOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + }, + "__stringMin1Max128": { + "type": "string", + "min": 1, + "max": 128 + }, + "__stringMin1Max64": { + "type": "string", + "min": 1, + "max": 64 + }, + "__stringMin5Max32": { + "type": "string", + "min": 5, + "max": 32 + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" + } + }, + "documentation": "\n

The operations for managing an Amazon MSK cluster.

\n " +} \ No newline at end of file diff --git a/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json b/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json new file mode 100644 index 00000000..f5e4d732 --- /dev/null +++ b/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListFragments": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Fragments" + } + } +} diff --git a/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json b/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json new file mode 100644 index 00000000..f6227da0 --- /dev/null +++ b/aws/dist/botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json @@ -0,0 +1,574 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-30", + "endpointPrefix":"kinesisvideo", + "protocol":"rest-json", + "serviceAbbreviation":"Kinesis Video Archived Media", + "serviceFullName":"Amazon Kinesis Video Streams Archived Media", + "serviceId":"Kinesis Video Archived Media", + "signatureVersion":"v4", + "uid":"kinesis-video-archived-media-2017-09-30" + }, + "operations":{ + "GetDASHStreamingSessionURL":{ + "name":"GetDASHStreamingSessionURL", + "http":{ + "method":"POST", + "requestUri":"/getDASHStreamingSessionURL" + }, + "input":{"shape":"GetDASHStreamingSessionURLInput"}, + "output":{"shape":"GetDASHStreamingSessionURLOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UnsupportedStreamMediaTypeException"}, + {"shape":"NoDataRetentionException"}, + {"shape":"MissingCodecPrivateDataException"}, + {"shape":"InvalidCodecPrivateDataException"} + ], + "documentation":"

Retrieves an MPEG Dynamic Adaptive Streaming over HTTP (DASH) URL for the stream. You can then open the URL in a media player to view the stream contents.

Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

An Amazon Kinesis video stream has the following requirements for providing data through MPEG-DASH:

  • The media must contain h.264 or h.265 encoded video and, optionally, AAC or G.711 encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEGH/ISO/HEVC (for H.265). Optionally, the codec ID of track 2 should be A_AAC (for AAC) or A_MS/ACM (for G.711).

  • Data retention must be greater than 0.

  • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format and HEVC for H.265 format. For more information, see MPEG-4 specification ISO/IEC 14496-15. For information about adapting stream data to a given format, see NAL Adaptation Flags.

  • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7) or the MS Wave format.

The following procedure shows how to use MPEG-DASH with Kinesis Video Streams:

  1. Get an endpoint using GetDataEndpoint, specifying GET_DASH_STREAMING_SESSION_URL for the APIName parameter.

  2. Retrieve the MPEG-DASH URL using GetDASHStreamingSessionURL. Kinesis Video Streams creates an MPEG-DASH streaming session to be used for accessing content in a stream using the MPEG-DASH protocol. GetDASHStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's MPEG-DASH manifest (the root resource needed for streaming with MPEG-DASH).

    Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

    The media that is made available through the manifest consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

  3. Provide the URL (containing the encrypted session token) for the MPEG-DASH manifest to a media player that supports the MPEG-DASH protocol. Kinesis Video Streams makes the initialization fragment and media fragments available through the manifest URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain encoded video frames or encoded audio samples.

  4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

    • GetDASHManifest: Retrieves an MPEG DASH manifest, which contains the metadata for the media that you want to playback.

    • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the \"fytp\" and \"moov\" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

      The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

    • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the \"moof\" and \"mdat\" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps.

      After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video.

      Data retrieved with this action is billable. See Pricing for details.

The following restrictions apply to MPEG-DASH sessions:

  • A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

  • A Kinesis video stream can have a maximum of ten active MPEG-DASH streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active MPEG-DASH sessions does not count against the active GetMedia connection limit.

    The maximum limits for active HLS and MPEG-DASH streaming sessions are independent of each other.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

" + }, + "GetHLSStreamingSessionURL":{ + "name":"GetHLSStreamingSessionURL", + "http":{ + "method":"POST", + "requestUri":"/getHLSStreamingSessionURL" + }, + "input":{"shape":"GetHLSStreamingSessionURLInput"}, + "output":{"shape":"GetHLSStreamingSessionURLOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"UnsupportedStreamMediaTypeException"}, + {"shape":"NoDataRetentionException"}, + {"shape":"MissingCodecPrivateDataException"}, + {"shape":"InvalidCodecPrivateDataException"} + ], + "documentation":"

Retrieves an HTTP Live Streaming (HLS) URL for the stream. You can then open the URL in a browser or media player to view the stream contents.

Both the StreamName and the StreamARN parameters are optional, but you must specify either the StreamName or the StreamARN when invoking this API operation.

An Amazon Kinesis video stream has the following requirements for providing data through HLS:

  • The media must contain h.264 or h.265 encoded video and, optionally, AAC encoded audio. Specifically, the codec ID of track 1 should be V_MPEG/ISO/AVC (for h.264) or V_MPEG/ISO/HEVC (for h.265). Optionally, the codec ID of track 2 should be A_AAC.

  • Data retention must be greater than 0.

  • The video track of each fragment must contain codec private data in the Advanced Video Coding (AVC) for H.264 format or HEVC for H.265 format (MPEG-4 specification ISO/IEC 14496-15). For information about adapting stream data to a given format, see NAL Adaptation Flags.

  • The audio track (if present) of each fragment must contain codec private data in the AAC format (AAC specification ISO/IEC 13818-7).

Kinesis Video Streams HLS sessions contain fragments in the fragmented MPEG-4 form (also called fMP4 or CMAF) or the MPEG-2 form (also called TS chunks, which the HLS specification also supports). For more information about HLS fragment types, see the HLS specification.

The following procedure shows how to use HLS with Kinesis Video Streams:

  1. Get an endpoint using GetDataEndpoint, specifying GET_HLS_STREAMING_SESSION_URL for the APIName parameter.

  2. Retrieve the HLS URL using GetHLSStreamingSessionURL. Kinesis Video Streams creates an HLS streaming session to be used for accessing content in a stream using the HLS protocol. GetHLSStreamingSessionURL returns an authenticated URL (that includes an encrypted session token) for the session's HLS master playlist (the root resource needed for streaming with HLS).

    Don't share or store this token where an unauthorized entity could access it. The token provides access to the content of the stream. Safeguard the token with the same measures that you would use with your AWS credentials.

    The media that is made available through the playlist consists only of the requested stream, time range, and format. No other media data (such as frames outside the requested window or alternate bitrates) is made available.

  3. Provide the URL (containing the encrypted session token) for the HLS master playlist to a media player that supports the HLS protocol. Kinesis Video Streams makes the HLS media playlist, initialization fragment, and media fragments available through the master playlist URL. The initialization fragment contains the codec private data for the stream, and other data needed to set up the video or audio decoder and renderer. The media fragments contain H.264-encoded video frames or AAC-encoded audio samples.

  4. The media player receives the authenticated URL and requests stream metadata and media data normally. When the media player requests data, it calls the following actions:

    • GetHLSMasterPlaylist: Retrieves an HLS master playlist, which contains a URL for the GetHLSMediaPlaylist action for each track, and additional metadata for the media player, including estimated bitrate and resolution.

    • GetHLSMediaPlaylist: Retrieves an HLS media playlist, which contains a URL to access the MP4 initialization fragment with the GetMP4InitFragment action, and URLs to access the MP4 media fragments with the GetMP4MediaFragment actions. The HLS media playlist also contains metadata about the stream that the player needs to play it, such as whether the PlaybackMode is LIVE or ON_DEMAND. The HLS media playlist is typically static for sessions with a PlaybackType of ON_DEMAND. The HLS media playlist is continually updated with new fragments for sessions with a PlaybackType of LIVE. There is a distinct HLS media playlist for the video track and the audio track (if applicable) that contains MP4 media URLs for the specific track.

    • GetMP4InitFragment: Retrieves the MP4 initialization fragment. The media player typically loads the initialization fragment before loading any media fragments. This fragment contains the \"fytp\" and \"moov\" MP4 atoms, and the child atoms that are needed to initialize the media player decoder.

      The initialization fragment does not correspond to a fragment in a Kinesis video stream. It contains only the codec private data for the stream and respective track, which the media player needs to decode the media frames.

    • GetMP4MediaFragment: Retrieves MP4 media fragments. These fragments contain the \"moof\" and \"mdat\" MP4 atoms and their child atoms, containing the encoded fragment's media frames and their timestamps.

      After the first media fragment is made available in a streaming session, any fragments that don't contain the same codec private data cause an error to be returned when those different media fragments are loaded. Therefore, the codec private data should not change between fragments in a session. This also means that the session fails if the fragments in a stream change from having only video to having both audio and video.

      Data retrieved with this action is billable. See Pricing for details.

    • GetTSFragment: Retrieves MPEG TS fragments containing both initialization and media data for all tracks in the stream.

      If the ContainerFormat is MPEG_TS, this API is used instead of GetMP4InitFragment and GetMP4MediaFragment to retrieve stream media.

      Data retrieved with this action is billable. For more information, see Kinesis Video Streams pricing.

The following restrictions apply to HLS sessions:

  • A streaming session URL should not be shared between players. The service might throttle a session if multiple media players are sharing it. For connection limits, see Kinesis Video Streams Limits.

  • A Kinesis video stream can have a maximum of ten active HLS streaming sessions. If a new session is created when the maximum number of sessions is already active, the oldest (earliest created) session is closed. The number of active GetMedia connections on a Kinesis video stream does not count against this limit, and the number of active HLS sessions does not count against the active GetMedia connection limit.

    The maximum limits for active HLS and MPEG-DASH streaming sessions are independent of each other.

You can monitor the amount of data that the media player consumes by monitoring the GetMP4MediaFragment.OutgoingBytes Amazon CloudWatch metric. For information about using CloudWatch to monitor Kinesis Video Streams, see Monitoring Kinesis Video Streams. For pricing information, see Amazon Kinesis Video Streams Pricing and AWS Pricing. Charges for both HLS sessions and outgoing AWS data apply.

For more information about HLS, see HTTP Live Streaming on the Apple Developer site.

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

" + }, + "GetMediaForFragmentList":{ + "name":"GetMediaForFragmentList", + "http":{ + "method":"POST", + "requestUri":"/getMediaForFragmentList" + }, + "input":{"shape":"GetMediaForFragmentListInput"}, + "output":{"shape":"GetMediaForFragmentListOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Gets media for a list of fragments (specified by fragment number) from the archived data in an Amazon Kinesis video stream.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMediaForFragmentList requests to this endpoint using the --endpoint-url parameter.

The following limits apply when using the GetMediaForFragmentList API:

  • A client can call GetMediaForFragmentList up to five times per second per stream.

  • Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

" + }, + "ListFragments":{ + "name":"ListFragments", + "http":{ + "method":"POST", + "requestUri":"/listFragments" + }, + "input":{"shape":"ListFragmentsInput"}, + "output":{"shape":"ListFragmentsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Returns a list of Fragment objects from the specified stream and timestamp range within the archived data.

Listing fragments is eventually consistent. This means that even if the producer receives an acknowledgment that a fragment is persisted, the result might not be returned immediately from a request to ListFragments. However, results are typically available in less than one second.

You must first call the GetDataEndpoint API to get an endpoint. Then send the ListFragments requests to this endpoint using the --endpoint-url parameter.

If an error is thrown after invoking a Kinesis Video Streams archived media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

" + } + }, + "shapes":{ + "ClientLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ContainerFormat":{ + "type":"string", + "enum":[ + "FRAGMENTED_MP4", + "MPEG_TS" + ] + }, + "ContentType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_\\.\\-]+$" + }, + "DASHDisplayFragmentNumber":{ + "type":"string", + "enum":[ + "ALWAYS", + "NEVER" + ] + }, + "DASHDisplayFragmentTimestamp":{ + "type":"string", + "enum":[ + "ALWAYS", + "NEVER" + ] + }, + "DASHFragmentSelector":{ + "type":"structure", + "members":{ + "FragmentSelectorType":{ + "shape":"DASHFragmentSelectorType", + "documentation":"

The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetDASHStreamingSessionURLInput$MaxManifestFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the MPEG-DASH manifest will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetDASHStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the MPEG-DASH manifest. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

" + }, + "TimestampRange":{ + "shape":"DASHTimestampRange", + "documentation":"

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

" + } + }, + "documentation":"

Contains the range of timestamps for the requested media, and the source of the timestamps.

" + }, + "DASHFragmentSelectorType":{ + "type":"string", + "enum":[ + "PRODUCER_TIMESTAMP", + "SERVER_TIMESTAMP" + ] + }, + "DASHPlaybackMode":{ + "type":"string", + "enum":[ + "LIVE", + "LIVE_REPLAY", + "ON_DEMAND" + ] + }, + "DASHStreamingSessionURL":{"type":"string"}, + "DASHTimestampRange":{ + "type":"structure", + "members":{ + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"

The start of the timestamp range for the requested media.

If the DASHTimestampRange value is specified, the StartTimestamp value is required.

This value is inclusive. Fragments that start before the StartTimestamp and continue past it are included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"

The end of the timestamp range for the requested media. This value must be within 3 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value.

If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

" + } + }, + "documentation":"

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

The values in the DASHimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

" + }, + "ErrorMessage":{"type":"string"}, + "Expires":{ + "type":"integer", + "max":43200, + "min":300 + }, + "Fragment":{ + "type":"structure", + "members":{ + "FragmentNumber":{ + "shape":"String", + "documentation":"

The unique identifier of the fragment. This value monotonically increases based on the ingestion order.

" + }, + "FragmentSizeInBytes":{ + "shape":"Long", + "documentation":"

The total fragment size, including information about the fragment and contained media data.

" + }, + "ProducerTimestamp":{ + "shape":"Timestamp", + "documentation":"

The timestamp from the producer corresponding to the fragment.

" + }, + "ServerTimestamp":{ + "shape":"Timestamp", + "documentation":"

The timestamp from the AWS server corresponding to the fragment.

" + }, + "FragmentLengthInMilliseconds":{ + "shape":"Long", + "documentation":"

The playback duration or other time value associated with the fragment.

" + } + }, + "documentation":"

Represents a segment of video or other time-delimited data.

" + }, + "FragmentList":{ + "type":"list", + "member":{"shape":"Fragment"} + }, + "FragmentNumberList":{ + "type":"list", + "member":{"shape":"FragmentNumberString"}, + "max":1000, + "min":1 + }, + "FragmentNumberString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9]+$" + }, + "FragmentSelector":{ + "type":"structure", + "required":[ + "FragmentSelectorType", + "TimestampRange" + ], + "members":{ + "FragmentSelectorType":{ + "shape":"FragmentSelectorType", + "documentation":"

The origin of the timestamps to use (Server or Producer).

" + }, + "TimestampRange":{ + "shape":"TimestampRange", + "documentation":"

The range of timestamps to return.

" + } + }, + "documentation":"

Describes the timestamp range and timestamp origin of a range of fragments.

Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, if a stream contains fragments with the following start timestamps:

  • 00:00:00

  • 00:00:02

  • 00:00:04

  • 00:00:06

A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.

" + }, + "FragmentSelectorType":{ + "type":"string", + "enum":[ + "PRODUCER_TIMESTAMP", + "SERVER_TIMESTAMP" + ] + }, + "GetDASHStreamingSessionURLInput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream for which to retrieve the MPEG-DASH manifest URL.

You must specify either the StreamName or the StreamARN.

" + }, + "PlaybackMode":{ + "shape":"DASHPlaybackMode", + "documentation":"

Whether to retrieve live, live replay, or archived, on-demand data.

Features of the three types of sessions include the following:

  • LIVE : For sessions of this type, the MPEG-DASH manifest is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new manifest on a one-second interval. When this type of session is played in a media player, the user interface typically displays a \"live\" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an MPEG-DASH manifest, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the MPEG-DASH manifest if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the manifest, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the MPEG-DASH manifest is updated similarly to how it is updated for LIVE mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the manifest every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the MPEG-DASH manifest contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The manifest must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the MPEG-DASH manifest. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the MPEG-DASH manifest. This can lead to unexpected behavior in the media player.

The default is LIVE.

" + }, + "DisplayFragmentTimestamp":{ + "shape":"DASHDisplayFragmentTimestamp", + "documentation":"

Per the MPEG-DASH specification, the wall-clock time of fragments in the manifest file can be derived using attributes in the manifest itself. However, typically, MPEG-DASH compatible media players do not properly handle gaps in the media timeline. Kinesis Video Streams adjusts the media timeline in the manifest file to enable playback of media with discontinuities. Therefore, the wall-clock time derived from the manifest file may be inaccurate. If DisplayFragmentTimestamp is set to ALWAYS, the accurate fragment timestamp is added to each S element in the manifest file with the attribute name “kvs:ts”. A custom MPEG-DASH media player is necessary to leverage this custom attribute.

The default value is NEVER. When DASHFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when DASHFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

" + }, + "DisplayFragmentNumber":{ + "shape":"DASHDisplayFragmentNumber", + "documentation":"

Fragments are identified in the manifest file based on their sequence number in the session. If DisplayFragmentNumber is set to ALWAYS, the Kinesis Video Streams fragment number is added to each S element in the manifest file with the attribute name “kvs:fn”. These fragment numbers can be used for logging or for use with other APIs (e.g. GetMedia and GetMediaForFragmentList). A custom MPEG-DASH media player is necessary to leverage these this custom attribute.

The default value is NEVER.

" + }, + "DASHFragmentSelector":{ + "shape":"DASHFragmentSelector", + "documentation":"

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetDashManifest, GetMP4InitFragment, or GetMP4MediaFragment can be made for that session.

The default is 300 (5 minutes).

" + }, + "MaxManifestFragmentResults":{ + "shape":"PageLimit", + "documentation":"

The maximum number of fragments that are returned in the MPEG-DASH manifest.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live MPEG-DASH manifest, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live MPEG-DASH manifest have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.

" + } + } + }, + "GetDASHStreamingSessionURLOutput":{ + "type":"structure", + "members":{ + "DASHStreamingSessionURL":{ + "shape":"DASHStreamingSessionURL", + "documentation":"

The URL (containing the session token) that a media player can use to retrieve the MPEG-DASH manifest.

" + } + } + }, + "GetHLSStreamingSessionURLInput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream for which to retrieve the HLS master playlist URL.

You must specify either the StreamName or the StreamARN.

" + }, + "PlaybackMode":{ + "shape":"HLSPlaybackMode", + "documentation":"

Whether to retrieve live, live replay, or archived, on-demand data.

Features of the three types of sessions include the following:

  • LIVE : For sessions of this type, the HLS media playlist is continually updated with the latest fragments as they become available. We recommend that the media player retrieve a new playlist on a one-second interval. When this type of session is played in a media player, the user interface typically displays a \"live\" notification, with no scrubber control for choosing the position in the playback window to display.

    In LIVE mode, the newest available fragments are included in an HLS media playlist, even if there is a gap between fragments (that is, if a fragment is missing). A gap like this might cause a media player to halt or cause a jump in playback. In this mode, fragments are not added to the HLS media playlist if they are older than the newest fragment in the playlist. If the missing fragment becomes available after a subsequent fragment is added to the playlist, the older fragment is not added, and the gap is not filled.

  • LIVE_REPLAY : For sessions of this type, the HLS media playlist is updated similarly to how it is updated for LIVE mode except that it starts by including fragments from a given start time. Instead of fragments being added as they are ingested, fragments are added as the duration of the next fragment elapses. For example, if the fragments in the session are two seconds long, then a new fragment is added to the media playlist every two seconds. This mode is useful to be able to start playback from when an event is detected and continue live streaming media that has not yet been ingested as of the time of the session creation. This mode is also useful to stream previously archived media without being limited by the 1,000 fragment limit in the ON_DEMAND mode.

  • ON_DEMAND : For sessions of this type, the HLS media playlist contains all the fragments for the session, up to the number that is specified in MaxMediaPlaylistFragmentResults. The playlist must be retrieved only once for each session. When this type of session is played in a media player, the user interface typically displays a scrubber control for choosing the position in the playback window to display.

In all playback modes, if FragmentSelectorType is PRODUCER_TIMESTAMP, and if there are multiple fragments with the same start timestamp, the fragment that has the larger fragment number (that is, the newer fragment) is included in the HLS media playlist. The other fragments are not included. Fragments that have different timestamps but have overlapping durations are still included in the HLS media playlist. This can lead to unexpected behavior in the media player.

The default is LIVE.

" + }, + "HLSFragmentSelector":{ + "shape":"HLSFragmentSelector", + "documentation":"

The time range of the requested fragment and the source of the timestamps.

This parameter is required if PlaybackMode is ON_DEMAND or LIVE_REPLAY. This parameter is optional if PlaybackMode is LIVE. If PlaybackMode is LIVE, the FragmentSelectorType can be set, but the TimestampRange should not be set. If PlaybackMode is ON_DEMAND or LIVE_REPLAY, both FragmentSelectorType and TimestampRange must be set.

" + }, + "ContainerFormat":{ + "shape":"ContainerFormat", + "documentation":"

Specifies which format should be used for packaging the media. Specifying the FRAGMENTED_MP4 container format packages the media into MP4 fragments (fMP4 or CMAF). This is the recommended packaging because there is minimal packaging overhead. The other container format option is MPEG_TS. HLS has supported MPEG TS chunks since it was released and is sometimes the only supported packaging on older HLS players. MPEG TS typically has a 5-25 percent packaging overhead. This means MPEG TS typically requires 5-25 percent more bandwidth and cost than fMP4.

The default is FRAGMENTED_MP4.

" + }, + "DiscontinuityMode":{ + "shape":"HLSDiscontinuityMode", + "documentation":"

Specifies when flags marking discontinuities between fragments are added to the media playlists.

Media players typically build a timeline of media content to play, based on the timestamps of each fragment. This means that if there is any overlap or gap between fragments (as is typical if HLSFragmentSelector is set to SERVER_TIMESTAMP), the media player timeline will also have small gaps between fragments in some places, and will overwrite frames in other places. Gaps in the media player timeline can cause playback to stall and overlaps can cause playback to be jittery. When there are discontinuity flags between fragments, the media player is expected to reset the timeline, resulting in the next fragment being played immediately after the previous fragment.

The following modes are supported:

  • ALWAYS: a discontinuity marker is placed between every fragment in the HLS media playlist. It is recommended to use a value of ALWAYS if the fragment timestamps are not accurate.

  • NEVER: no discontinuity markers are placed anywhere. It is recommended to use a value of NEVER to ensure the media player timeline most accurately maps to the producer timestamps.

  • ON_DISCONTIUNITY: a discontinuity marker is placed between fragments that have a gap or overlap of more than 50 milliseconds. For most playback scenarios, it is recommended to use a value of ON_DISCONTINUITY so that the media player timeline is only reset when there is a significant issue with the media timeline (e.g. a missing fragment).

The default is ALWAYS when HLSFragmentSelector is set to SERVER_TIMESTAMP, and NEVER when it is set to PRODUCER_TIMESTAMP.

" + }, + "DisplayFragmentTimestamp":{ + "shape":"HLSDisplayFragmentTimestamp", + "documentation":"

Specifies when the fragment start timestamps should be included in the HLS media playlist. Typically, media players report the playhead position as a time relative to the start of the first fragment in the playback session. However, when the start timestamps are included in the HLS media playlist, some media players might report the current playhead as an absolute time based on the fragment timestamps. This can be useful for creating a playback experience that shows viewers the wall-clock time of the media.

The default is NEVER. When HLSFragmentSelector is SERVER_TIMESTAMP, the timestamps will be the server start timestamps. Similarly, when HLSFragmentSelector is PRODUCER_TIMESTAMP, the timestamps will be the producer start timestamps.

" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

The time in seconds until the requested session expires. This value can be between 300 (5 minutes) and 43200 (12 hours).

When a session expires, no new calls to GetHLSMasterPlaylist, GetHLSMediaPlaylist, GetMP4InitFragment, GetMP4MediaFragment, or GetTSFragment can be made for that session.

The default is 300 (5 minutes).

" + }, + "MaxMediaPlaylistFragmentResults":{ + "shape":"PageLimit", + "documentation":"

The maximum number of fragments that are returned in the HLS media playlists.

When the PlaybackMode is LIVE, the most recent fragments are returned up to this value. When the PlaybackMode is ON_DEMAND, the oldest fragments are returned, up to this maximum number.

When there are a higher number of fragments available in a live HLS media playlist, video players often buffer content before starting playback. Increasing the buffer size increases the playback latency, but it decreases the likelihood that rebuffering will occur during playback. We recommend that a live HLS media playlist have a minimum of 3 fragments and a maximum of 10 fragments.

The default is 5 fragments if PlaybackMode is LIVE or LIVE_REPLAY, and 1,000 if PlaybackMode is ON_DEMAND.

The maximum value of 1,000 fragments corresponds to more than 16 minutes of video on streams with 1-second fragments, and more than 2 1/2 hours of video on streams with 10-second fragments.

" + } + } + }, + "GetHLSStreamingSessionURLOutput":{ + "type":"structure", + "members":{ + "HLSStreamingSessionURL":{ + "shape":"HLSStreamingSessionURL", + "documentation":"

The URL (containing the session token) that a media player can use to retrieve the HLS master playlist.

" + } + } + }, + "GetMediaForFragmentListInput":{ + "type":"structure", + "required":[ + "StreamName", + "Fragments" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream from which to retrieve fragment media.

" + }, + "Fragments":{ + "shape":"FragmentNumberList", + "documentation":"

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

" + } + } + }, + "GetMediaForFragmentListOutput":{ + "type":"structure", + "members":{ + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the requested media.

", + "location":"header", + "locationName":"Content-Type" + }, + "Payload":{ + "shape":"Payload", + "documentation":"

The payload that Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see PutMedia. The chunks that Kinesis Video Streams returns in the GetMediaForFragmentList call also include the following additional Matroska (MKV) tags:

  • AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

  • AWS_KINESISVIDEO_SERVER_SIDE_TIMESTAMP - Server-side timestamp of the fragment.

  • AWS_KINESISVIDEO_PRODUCER_SIDE_TIMESTAMP - Producer-side timestamp of the fragment.

The following tags will be included if an exception occurs:

  • AWS_KINESISVIDEO_FRAGMENT_NUMBER - The number of the fragment that threw the exception

  • AWS_KINESISVIDEO_EXCEPTION_ERROR_CODE - The integer code of the exception

  • AWS_KINESISVIDEO_EXCEPTION_MESSAGE - A text description of the exception

" + } + }, + "payload":"Payload" + }, + "HLSDiscontinuityMode":{ + "type":"string", + "enum":[ + "ALWAYS", + "NEVER", + "ON_DISCONTINUITY" + ] + }, + "HLSDisplayFragmentTimestamp":{ + "type":"string", + "enum":[ + "ALWAYS", + "NEVER" + ] + }, + "HLSFragmentSelector":{ + "type":"structure", + "members":{ + "FragmentSelectorType":{ + "shape":"HLSFragmentSelectorType", + "documentation":"

The source of the timestamps for the requested media.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is ON_DEMAND or LIVE_REPLAY, the first fragment ingested with a producer timestamp within the specified FragmentSelector$TimestampRange is included in the media playlist. In addition, the fragments with producer timestamps within the TimestampRange ingested immediately following the first fragment (up to the GetHLSStreamingSessionURLInput$MaxMediaPlaylistFragmentResults value) are included.

Fragments that have duplicate producer timestamps are deduplicated. This means that if producers are producing a stream of fragments with producer timestamps that are approximately equal to the true clock time, the HLS media playlists will contain all of the fragments within the requested timestamp range. If some fragments are ingested within the same time range and very different points in time, only the oldest ingested collection of fragments are returned.

When FragmentSelectorType is set to PRODUCER_TIMESTAMP and GetHLSStreamingSessionURLInput$PlaybackMode is LIVE, the producer timestamps are used in the MP4 fragments and for deduplication. But the most recently ingested fragments based on server timestamps are included in the HLS media playlist. This means that even if fragments ingested in the past have producer timestamps with values now, they are not included in the HLS media playlist.

The default is SERVER_TIMESTAMP.

" + }, + "TimestampRange":{ + "shape":"HLSTimestampRange", + "documentation":"

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

" + } + }, + "documentation":"

Contains the range of timestamps for the requested media, and the source of the timestamps.

" + }, + "HLSFragmentSelectorType":{ + "type":"string", + "enum":[ + "PRODUCER_TIMESTAMP", + "SERVER_TIMESTAMP" + ] + }, + "HLSPlaybackMode":{ + "type":"string", + "enum":[ + "LIVE", + "LIVE_REPLAY", + "ON_DEMAND" + ] + }, + "HLSStreamingSessionURL":{"type":"string"}, + "HLSTimestampRange":{ + "type":"structure", + "members":{ + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"

The start of the timestamp range for the requested media.

If the HLSTimestampRange value is specified, the StartTimestamp value is required.

This value is inclusive. Fragments that start before the StartTimestamp and continue past it are included in the session. If FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later than the stream head.

" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"

The end of the timestamp range for the requested media. This value must be within 3 hours of the specified StartTimestamp, and it must be later than the StartTimestamp value.

If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the past.

The EndTimestamp value is required for ON_DEMAND mode, but optional for LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then the session will continue to include newly ingested fragments until the session expires.

This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. Fragments that start before the EndTimestamp value and continue past it are included in the session.

" + } + }, + "documentation":"

The start and end of the timestamp range for the requested media.

This value should not be present if PlaybackType is LIVE.

The values in the HLSTimestampRange are inclusive. Fragments that begin before the start time but continue past it, or fragments that begin before the end time but continue past it, are included in the session.

" + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidCodecPrivateDataException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The codec private data in at least one of the tracks of the video stream is not valid for this operation.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListFragmentsInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream from which to retrieve a fragment list.

" + }, + "MaxResults":{ + "shape":"PageLimit", + "documentation":"

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

" + }, + "FragmentSelector":{ + "shape":"FragmentSelector", + "documentation":"

Describes the timestamp range and timestamp origin for the range of fragments to return.

" + } + } + }, + "ListFragmentsOutput":{ + "type":"structure", + "members":{ + "Fragments":{ + "shape":"FragmentList", + "documentation":"

A list of archived Fragment objects from the stream that meet the selector criteria. Results are in no specific order, even across pages.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

If the returned list is truncated, the operation returns this token to use to retrieve the next page of results. This value is null when there are no more results to return.

" + } + } + }, + "Long":{"type":"long"}, + "MissingCodecPrivateDataException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

No codec private data was found in at least one of tracks of the video stream.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NoDataRetentionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A streaming session was requested for a stream that does not retain data (that is, has a DataRetentionInHours of 0).

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "PageLimit":{ + "type":"long", + "max":1000, + "min":1 + }, + "Payload":{ + "type":"blob", + "streaming":true + }, + "ResourceARN":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

GetMedia throws this error when Kinesis Video Streams can't find the stream that you specified.

GetHLSStreamingSessionURL and GetDASHStreamingSessionURL throw this error if a session with a PlaybackMode of ON_DEMAND or LIVE_REPLAYis requested for a stream that has no fragments within the requested time range, or if a session with a PlaybackMode of LIVE is requested for a stream that has no fragments within the last 30 seconds.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "StreamName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "String":{ + "type":"string", + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TimestampRange":{ + "type":"structure", + "required":[ + "StartTimestamp", + "EndTimestamp" + ], + "members":{ + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"

The starting timestamp in the range of timestamps for which to return fragments.

" + }, + "EndTimestamp":{ + "shape":"Timestamp", + "documentation":"

The ending timestamp in the range of timestamps for which to return fragments.

" + } + }, + "documentation":"

The range of timestamps for which to return fragments.

" + }, + "UnsupportedStreamMediaTypeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The type of the media (for example, h.264 or h.265 video or ACC or G.711 audio) could not be determined from the codec IDs of the tracks in the first fragment for a playback session. The codec ID for track 1 should be V_MPEG/ISO/AVC and, optionally, the codec ID for track 2 should be A_AAC.

", + "error":{"httpStatusCode":400}, + "exception":true + } + }, + "documentation":"

" +} diff --git a/aws/dist/botocore/data/kinesis-video-media/2017-09-30/paginators-1.json b/aws/dist/botocore/data/kinesis-video-media/2017-09-30/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/kinesis-video-media/2017-09-30/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/kinesis-video-media/2017-09-30/service-2.json b/aws/dist/botocore/data/kinesis-video-media/2017-09-30/service-2.json new file mode 100644 index 00000000..fde7ddcc --- /dev/null +++ b/aws/dist/botocore/data/kinesis-video-media/2017-09-30/service-2.json @@ -0,0 +1,194 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-30", + "endpointPrefix":"kinesisvideo", + "protocol":"rest-json", + "serviceAbbreviation":"Kinesis Video Media", + "serviceFullName":"Amazon Kinesis Video Streams Media", + "serviceId":"Kinesis Video Media", + "signatureVersion":"v4", + "uid":"kinesis-video-media-2017-09-30" + }, + "operations":{ + "GetMedia":{ + "name":"GetMedia", + "http":{ + "method":"POST", + "requestUri":"/getMedia" + }, + "input":{"shape":"GetMediaInput"}, + "output":{"shape":"GetMediaOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidEndpointException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"ConnectionLimitExceededException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Use this API to retrieve media content from a Kinesis video stream. In the request, you identify the stream name or stream Amazon Resource Name (ARN), and the starting chunk. Kinesis Video Streams then returns a stream of chunks in order by fragment number.

You must first call the GetDataEndpoint API to get an endpoint. Then send the GetMedia requests to this endpoint using the --endpoint-url parameter.

When you put media data (fragments) on a stream, Kinesis Video Streams stores each incoming fragment and related metadata in what is called a \"chunk.\" For more information, see PutMedia. The GetMedia API returns a stream of these chunks starting from the chunk that you specify in the request.

The following limits apply when using the GetMedia API:

  • A client can call GetMedia up to five times per second per stream.

  • Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMedia session.

If an error is thrown after invoking a Kinesis Video Streams media API, in addition to the HTTP status code and the response body, it includes the following pieces of information:

  • x-amz-ErrorType HTTP header – contains a more specific error type in addition to what the HTTP status code provides.

  • x-amz-RequestId HTTP header – if you want to report an issue to AWS, the support team can better diagnose the problem if given the Request Id.

Both the HTTP status code and the ErrorType header can be utilized to make programmatic decisions about whether errors are retry-able and under what conditions, as well as provide information on what actions the client programmer might need to take in order to successfully try again.

For more information, see the Errors section at the bottom of this topic, as well as Common Errors.

" + } + }, + "shapes":{ + "ClientLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConnectionLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client connections.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ContentType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_\\.\\-]+$" + }, + "ContinuationToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[a-zA-Z0-9_\\.\\-]+$" + }, + "ErrorMessage":{"type":"string"}, + "FragmentNumberString":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[0-9]+$" + }, + "GetMediaInput":{ + "type":"structure", + "required":["StartSelector"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The Kinesis video stream name from where you want to get the media content. If you don't specify the streamName, you must specify the streamARN.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the stream from where you want to get the media content. If you don't specify the streamARN, you must specify the streamName.

" + }, + "StartSelector":{ + "shape":"StartSelector", + "documentation":"

Identifies the starting chunk to get from the specified stream.

" + } + } + }, + "GetMediaOutput":{ + "type":"structure", + "members":{ + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the requested media.

", + "location":"header", + "locationName":"Content-Type" + }, + "Payload":{ + "shape":"Payload", + "documentation":"

The payload Kinesis Video Streams returns is a sequence of chunks from the specified stream. For information about the chunks, see . The chunks that Kinesis Video Streams returns in the GetMedia call also include the following additional Matroska (MKV) tags:

  • AWS_KINESISVIDEO_CONTINUATION_TOKEN (UTF-8 string) - In the event your GetMedia call terminates, you can use this continuation token in your next request to get the next chunk where the last request terminated.

  • AWS_KINESISVIDEO_MILLIS_BEHIND_NOW (UTF-8 string) - Client applications can use this tag value to determine how far behind the chunk returned in the response is from the latest chunk on the stream.

  • AWS_KINESISVIDEO_FRAGMENT_NUMBER - Fragment number returned in the chunk.

  • AWS_KINESISVIDEO_SERVER_TIMESTAMP - Server timestamp of the fragment.

  • AWS_KINESISVIDEO_PRODUCER_TIMESTAMP - Producer timestamp of the fragment.

The following tags will be present if an error occurs:

  • AWS_KINESISVIDEO_ERROR_CODE - String description of an error that caused GetMedia to stop.

  • AWS_KINESISVIDEO_ERROR_ID: Integer code of the error.

The error codes are as follows:

  • 3002 - Error writing to the stream

  • 4000 - Requested fragment is not found

  • 4500 - Access denied for the stream's KMS key

  • 4501 - Stream's KMS key is disabled

  • 4502 - Validation error on the stream's KMS key

  • 4503 - KMS key specified in the stream is unavailable

  • 4504 - Invalid usage of the KMS key specified in the stream

  • 4505 - Invalid state of the KMS key specified in the stream

  • 4506 - Unable to find the KMS key specified in the stream

  • 5000 - Internal error

" + } + }, + "payload":"Payload" + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The value for this input parameter is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidEndpointException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Status Code: 400, Caller used wrong endpoint to write data to a stream. On receiving such an exception, the user must call GetDataEndpoint with AccessMode set to \"READ\" and use the endpoint Kinesis Video returns in the next GetMedia call.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "Payload":{ + "type":"blob", + "streaming":true + }, + "ResourceARN":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Status Code: 404, The stream with the given name does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "StartSelector":{ + "type":"structure", + "required":["StartSelectorType"], + "members":{ + "StartSelectorType":{ + "shape":"StartSelectorType", + "documentation":"

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

  • NOW - Start with the latest chunk on the stream.

  • EARLIEST - Start with earliest available chunk on the stream.

  • FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the AfterFragmentNumber parameter.

  • PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server timestamp. You specify the timestamp by adding StartTimestamp.

  • CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

" + }, + "AfterFragmentNumber":{ + "shape":"FragmentNumberString", + "documentation":"

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

" + }, + "StartTimestamp":{ + "shape":"Timestamp", + "documentation":"

A timestamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified timestamp.

" + }, + "ContinuationToken":{ + "shape":"ContinuationToken", + "documentation":"

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

" + } + }, + "documentation":"

Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk:

  • Choose the latest (or oldest) chunk.

  • Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or timestamp (server or producer).

  • Each chunk's metadata includes a continuation token as a Matroska (MKV) tag (AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

" + }, + "StartSelectorType":{ + "type":"string", + "enum":[ + "FRAGMENT_NUMBER", + "SERVER_TIMESTAMP", + "PRODUCER_TIMESTAMP", + "NOW", + "EARLIEST", + "CONTINUATION_TOKEN" + ] + }, + "StreamName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "Timestamp":{"type":"timestamp"} + }, + "documentation":"

" +} diff --git a/aws/dist/botocore/data/kinesis/2013-12-02/examples-1.json b/aws/dist/botocore/data/kinesis/2013-12-02/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/kinesis/2013-12-02/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/kinesis/2013-12-02/paginators-1.json b/aws/dist/botocore/data/kinesis/2013-12-02/paginators-1.json new file mode 100644 index 00000000..a88324d3 --- /dev/null +++ b/aws/dist/botocore/data/kinesis/2013-12-02/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "DescribeStream": { + "input_token": "ExclusiveStartShardId", + "limit_key": "Limit", + "more_results": "StreamDescription.HasMoreShards", + "output_token": "StreamDescription.Shards[-1].ShardId", + "result_key": "StreamDescription.Shards", + "non_aggregate_keys": [ + "StreamDescription.StreamARN", + "StreamDescription.StreamName", + "StreamDescription.StreamStatus", + "StreamDescription.RetentionPeriodHours", + "StreamDescription.EnhancedMonitoring", + "StreamDescription.EncryptionType", + "StreamDescription.KeyId", + "StreamDescription.StreamCreationTimestamp" + ] + }, + "ListStreams": { + "input_token": "ExclusiveStartStreamName", + "limit_key": "Limit", + "more_results": "HasMoreStreams", + "output_token": "StreamNames[-1]", + "result_key": "StreamNames" + }, + "ListShards": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Shards" + }, + "ListStreamConsumers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Consumers" + } + } +} diff --git a/aws/dist/botocore/data/kinesis/2013-12-02/service-2.json b/aws/dist/botocore/data/kinesis/2013-12-02/service-2.json new file mode 100644 index 00000000..21eb2c60 --- /dev/null +++ b/aws/dist/botocore/data/kinesis/2013-12-02/service-2.json @@ -0,0 +1,2005 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-12-02", + "endpointPrefix":"kinesis", + "jsonVersion":"1.1", + "protocol":"json", + "protocolSettings":{"h2":"eventstream"}, + "serviceAbbreviation":"Kinesis", + "serviceFullName":"Amazon Kinesis", + "serviceId":"Kinesis", + "signatureVersion":"v4", + "targetPrefix":"Kinesis_20131202", + "uid":"kinesis-2013-12-02" + }, + "operations":{ + "AddTagsToStream":{ + "name":"AddTagsToStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Adds or updates tags for the specified Kinesis data stream. Each time you invoke this operation, you can specify up to 10 tags. If you want to add more than 10 tags to your stream, you can invoke this operation multiple times. In total, each stream can have up to 50 tags.

If tags have already been assigned to the stream, AddTagsToStream overwrites any existing tags that correspond to the specified tag keys.

AddTagsToStream has a limit of five transactions per second per account.

" + }, + "CreateStream":{ + "name":"CreateStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStreamInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or producers. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.

You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards.

The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.

CreateStream is an asynchronous operation. Upon receiving a CreateStream request, Kinesis Data Streams immediately returns and sets the stream status to CREATING. After the stream is created, Kinesis Data Streams sets the stream status to ACTIVE. You should perform read and write operations only on an ACTIVE stream.

You receive a LimitExceededException when making a CreateStream request when you try to do one of the following:

  • Have more than five streams in the CREATING state at any point in time.

  • Create more shards than are authorized for your account.

For the default shard limit for an AWS account, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

You can use DescribeStream to check the stream status, which is returned in StreamStatus.

CreateStream has a limit of five transactions per second per account.

" + }, + "DecreaseStreamRetentionPeriod":{ + "name":"DecreaseStreamRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecreaseStreamRetentionPeriodInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.

This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.

" + }, + "DeleteStream":{ + "name":"DeleteStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception ResourceNotFoundException.

If the stream is in the ACTIVE state, you can delete it. After a DeleteStream request, the specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

Note: Kinesis Data Streams might continue to accept data read and write operations, such as PutRecord, PutRecords, and GetRecords, on a stream in the DELETING state until the stream deletion is complete.

When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.

You can use the DescribeStream operation to check the state of the stream, which is returned in StreamStatus.

DeleteStream has a limit of five transactions per second per account.

" + }, + "DeregisterStreamConsumer":{ + "name":"DeregisterStreamConsumer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterStreamConsumerInput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

To deregister a consumer, provide its ARN. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its name and ARN.

This operation has a limit of five transactions per second per account.

" + }, + "DescribeLimits":{ + "name":"DescribeLimits", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLimitsInput"}, + "output":{"shape":"DescribeLimitsOutput"}, + "errors":[ + {"shape":"LimitExceededException"} + ], + "documentation":"

Describes the shard limits and usage for the account.

If you update your account limits, the old limits might be returned for a few minutes.

This operation has a limit of one transaction per second per account.

" + }, + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamInput"}, + "output":{"shape":"DescribeStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Describes the specified Kinesis data stream.

The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.

You can limit the number of shards returned by each call. For more information, see Retrieving Shards from a Stream in the Amazon Kinesis Data Streams Developer Guide.

There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.

This operation has a limit of 10 transactions per second per account.

" + }, + "DescribeStreamConsumer":{ + "name":"DescribeStreamConsumer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamConsumerInput"}, + "output":{"shape":"DescribeStreamConsumerOutput"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

To get the description of a registered consumer, provide the ARN of the consumer. Alternatively, you can provide the ARN of the data stream and the name you gave the consumer when you registered it. You may also provide all three parameters, as long as they don't conflict with each other. If you don't know the name or ARN of the consumer that you want to describe, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream.

This operation has a limit of 20 transactions per second per account.

" + }, + "DescribeStreamSummary":{ + "name":"DescribeStreamSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamSummaryInput"}, + "output":{"shape":"DescribeStreamSummaryOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Provides a summarized description of the specified Kinesis data stream without the shard list.

The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count.

" + }, + "DisableEnhancedMonitoring":{ + "name":"DisableEnhancedMonitoring", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableEnhancedMonitoringInput"}, + "output":{"shape":"EnhancedMonitoringOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disables enhanced monitoring.

" + }, + "EnableEnhancedMonitoring":{ + "name":"EnableEnhancedMonitoring", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableEnhancedMonitoringInput"}, + "output":{"shape":"EnhancedMonitoringOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Enables enhanced Kinesis data stream monitoring for shard-level metrics.

" + }, + "GetRecords":{ + "name":"GetRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRecordsInput"}, + "output":{"shape":"GetRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ExpiredIteratorException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"KMSOptInRequired"}, + {"shape":"KMSThrottlingException"} + ], + "documentation":"

Gets data records from a Kinesis data stream's shard.

Specify a shard iterator using the ShardIterator parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, GetRecords returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.

You can scale by provisioning multiple shards per stream while considering service limits (for more information, see Amazon Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call GetRecords in a loop. Use GetShardIterator to get the shard iterator to specify in the first GetRecords call. GetRecords returns a new shard iterator in NextShardIterator. Specify the shard iterator returned in NextShardIterator in subsequent calls to GetRecords. If the shard has been closed, the shard iterator can't return more data and GetRecords returns null in NextShardIterator. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.

Each data record can be up to 1 MiB in size, and each shard can read up to 2 MiB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the Limit parameter to specify the maximum number of records that GetRecords can return. Consider your average record size when determining this limit. The maximum number of records that can be returned per call is 10,000.

The size of the data returned by GetRecords varies depending on the utilization of the shard. The maximum size of data that GetRecords can return is 10 MiB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw ProvisionedThroughputExceededException. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next 1 second throw ProvisionedThroughputExceededException. GetRecords doesn't return any data when it throws an exception. For this reason, we recommend that you wait 1 second between calls to GetRecords. However, it's possible that the application will get exceptions for longer than 1 second.

To detect whether the application is falling behind in processing, you can use the MillisBehindLatest response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see Monitoring in the Amazon Kinesis Data Streams Developer Guide).

Each Amazon Kinesis record includes a value, ApproximateArrivalTimestamp, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with PutRecords). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.

This operation has a limit of five transactions per second per account.

" + }, + "GetShardIterator":{ + "name":"GetShardIterator", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetShardIteratorInput"}, + "output":{"shape":"GetShardIteratorOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

Gets an Amazon Kinesis shard iterator. A shard iterator expires 5 minutes after it is returned to the requester.

A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.

You must specify the shard iterator type. For example, you can set the ShardIteratorType parameter to read exactly from the position denoted by a specific sequence number by using the AT_SEQUENCE_NUMBER shard iterator type. Alternatively, the parameter can read right after the sequence number by using the AFTER_SEQUENCE_NUMBER shard iterator type, using sequence numbers returned by earlier calls to PutRecord, PutRecords, GetRecords, or DescribeStream. In the request, you can specify the shard iterator type AT_TIMESTAMP to read records from an arbitrary point in time, TRIM_HORIZON to cause ShardIterator to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or LATEST so that you always read the most recent data in the shard.

When you read repeatedly from a stream, use a GetShardIterator request to get the first shard iterator for use in your first GetRecords request and for subsequent reads use the shard iterator returned by the GetRecords request in NextShardIterator. A new shard iterator is returned by every GetRecords request in NextShardIterator, which you use in the ShardIterator parameter of the next GetRecords request.

If a GetShardIterator request is made too often, you receive a ProvisionedThroughputExceededException. For more information about throughput limits, see GetRecords, and Streams Limits in the Amazon Kinesis Data Streams Developer Guide.

If the shard is closed, GetShardIterator returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using SplitShard or MergeShards.

GetShardIterator has a limit of five transactions per second per account per open shard.

" + }, + "IncreaseStreamRetentionPeriod":{ + "name":"IncreaseStreamRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IncreaseStreamRetentionPeriodInput"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).

If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.

" + }, + "ListShards":{ + "name":"ListShards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListShardsInput"}, + "output":{"shape":"ListShardsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Lists the shards in a stream and provides information about each shard. This operation has a limit of 100 transactions per second per data stream.

This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see Controlling Access to Amazon Kinesis Data Streams Resources Using IAM.

" + }, + "ListStreamConsumers":{ + "name":"ListStreamConsumers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamConsumersInput"}, + "output":{"shape":"ListStreamConsumersOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ExpiredNextTokenException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Lists the consumers registered to receive data from a stream using enhanced fan-out, and provides information about each consumer.

This operation has a limit of 10 transactions per second per account.

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamsInput"}, + "output":{"shape":"ListStreamsOutput"}, + "errors":[ + {"shape":"LimitExceededException"} + ], + "documentation":"

Lists your Kinesis data streams.

The number of streams may be too large to return from a single call to ListStreams. You can limit the number of returned streams using the Limit parameter. If you do not specify a value for the Limit parameter, Kinesis Data Streams uses the default limit, which is currently 10.

You can detect if there are more streams available to list by using the HasMoreStreams flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the ListStreams request in the ExclusiveStartStreamName parameter in a subsequent request to ListStreams. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list.

ListStreams has a limit of five transactions per second per account.

" + }, + "ListTagsForStream":{ + "name":"ListTagsForStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForStreamInput"}, + "output":{"shape":"ListTagsForStreamOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.

" + }, + "MergeShards":{ + "name":"MergeShards", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MergeShardsInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.

MergeShards is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see Merge Two Shards in the Amazon Kinesis Data Streams Developer Guide.

If the stream is in the ACTIVE state, you can call MergeShards. If a stream is in the CREATING, UPDATING, or DELETING state, MergeShards returns a ResourceInUseException. If the specified stream does not exist, MergeShards returns a ResourceNotFoundException.

You can use DescribeStream to check the state of the stream, which is returned in StreamStatus.

MergeShards is an asynchronous operation. Upon receiving a MergeShards request, Amazon Kinesis Data Streams immediately returns a response and sets the StreamStatus to UPDATING. After the operation is completed, Kinesis Data Streams sets the StreamStatus to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You use DescribeStream to determine the shard IDs that are specified in the MergeShards request.

If you try to operate on too many streams in parallel using CreateStream, DeleteStream, MergeShards, or SplitShard, you receive a LimitExceededException.

MergeShards has a limit of five transactions per second per account.

" + }, + "PutRecord":{ + "name":"PutRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordInput"}, + "output":{"shape":"PutRecordOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"KMSOptInRequired"}, + {"shape":"KMSThrottlingException"} + ], + "documentation":"

Writes a single data record into an Amazon Kinesis data stream. Call PutRecord to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.

Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the ExplicitHashKey parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

PutRecord returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.

Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the SequenceNumberForOrdering parameter. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

If a PutRecord request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, PutRecord throws ProvisionedThroughputExceededException.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" + }, + "PutRecords":{ + "name":"PutRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRecordsInput"}, + "output":{"shape":"PutRecordsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"KMSOptInRequired"}, + {"shape":"KMSThrottlingException"} + ], + "documentation":"

Writes multiple data records into a Kinesis data stream in a single call (also referred to as a PutRecords request). Use this operation to send data into the stream for data ingestion and processing.

Each PutRecords request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.

You must specify the name of the stream that captures, stores, and transports the data; and an array of request Records, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.

The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.

The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see Adding Data to a Stream in the Amazon Kinesis Data Streams Developer Guide.

Each record in the Records array may include an optional parameter, ExplicitHashKey, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

The PutRecords response includes an array of response Records. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response Records array always includes the same number of records as the request array.

The response Records array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each PutRecords request. A single record failure does not stop the processing of subsequent records.

A successfully processed record includes ShardId and SequenceNumber values. The ShardId parameter identifies the shard in the stream where the record is stored. The SequenceNumber parameter is an identifier assigned to the put record, unique to all records in the stream.

An unsuccessfully processed record includes ErrorCode and ErrorMessage values. ErrorCode reflects the type of error and can be one of the following values: ProvisionedThroughputExceededException or InternalFailure. ErrorMessage provides more detailed information about the ProvisionedThroughputExceededException exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see Adding Multiple Records with PutRecords in the Amazon Kinesis Data Streams Developer Guide.

By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use IncreaseStreamRetentionPeriod or DecreaseStreamRetentionPeriod to modify this retention period.

" + }, + "RegisterStreamConsumer":{ + "name":"RegisterStreamConsumer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterStreamConsumerInput"}, + "output":{"shape":"RegisterStreamConsumerOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers a consumer with a Kinesis data stream. When you use this operation, the consumer you register can read data from the stream at a rate of up to 2 MiB per second. This rate is unaffected by the total number of consumers that read from the same stream.

You can register up to 5 consumers per stream. A given consumer can only be registered with one stream.

This operation has a limit of five transactions per second per account.

" + }, + "RemoveTagsFromStream":{ + "name":"RemoveTagsFromStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromStreamInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.

If you specify a tag that does not exist, it is ignored.

RemoveTagsFromStream has a limit of five transactions per second per account.

" + }, + "SplitShard":{ + "name":"SplitShard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SplitShardInput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. SplitShard is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested.

You can also use SplitShard when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call SplitShard to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing.

You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see Split a Shard in the Amazon Kinesis Data Streams Developer Guide.

You can use DescribeStream to determine the shard ID and hash key values for the ShardToSplit and NewStartingHashKey parameters that are specified in the SplitShard request.

SplitShard is an asynchronous operation. Upon receiving a SplitShard request, Kinesis Data Streams immediately returns a response and sets the stream status to UPDATING. After the operation is completed, Kinesis Data Streams sets the stream status to ACTIVE. Read and write operations continue to work while the stream is in the UPDATING state.

You can use DescribeStream to check the status of the stream, which is returned in StreamStatus. If the stream is in the ACTIVE state, you can call SplitShard. If a stream is in CREATING or UPDATING or DELETING states, DescribeStream returns a ResourceInUseException.

If the specified stream does not exist, DescribeStream returns a ResourceNotFoundException. If you try to create more shards than are authorized for your account, you receive a LimitExceededException.

For the default shard limit for an AWS account, see Kinesis Data Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To increase this limit, contact AWS Support.

If you try to operate on too many streams simultaneously using CreateStream, DeleteStream, MergeShards, and/or SplitShard, you receive a LimitExceededException.

SplitShard has a limit of five transactions per second per account.

" + }, + "StartStreamEncryption":{ + "name":"StartStreamEncryption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartStreamEncryptionInput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"KMSOptInRequired"}, + {"shape":"KMSThrottlingException"} + ], + "documentation":"

Enables or updates server-side encryption using an AWS KMS key for a specified stream.

Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.

" + }, + "StopStreamEncryption":{ + "name":"StopStreamEncryption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStreamEncryptionInput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disables server-side encryption for a specified stream.

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.

API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.

" + }, + "SubscribeToShard":{ + "name":"SubscribeToShard", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubscribeToShardInput"}, + "output":{"shape":"SubscribeToShardOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Call this operation from your consumer after you call RegisterStreamConsumer to register the consumer with Kinesis Data Streams. If the call succeeds, your consumer starts receiving events of type SubscribeToShardEvent for up to 5 minutes, after which time you need to call SubscribeToShard again to renew the subscription if you want to continue to receive records.

You can make one call to SubscribeToShard per second per ConsumerARN. If your call succeeds, and then you call the operation again less than 5 seconds later, the second call generates a ResourceInUseException. If you call the operation a second time more than 5 seconds after the first call succeeds, the second call succeeds and the first connection gets shut down.

" + }, + "UpdateShardCount":{ + "name":"UpdateShardCount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateShardCountInput"}, + "output":{"shape":"UpdateShardCountOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates the shard count of the specified stream to the specified number of shards.

Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is UPDATING.

To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.

This operation has the following default limits. By default, you cannot do the following:

  • Scale more than twice per rolling 24-hour period per stream

  • Scale up to more than double your current shard count for a stream

  • Scale down below half your current shard count for a stream

  • Scale up to more than 500 shards in a stream

  • Scale a stream with more than 500 shards down unless the result is less than 500 shards

  • Scale up to more than the shard limit for your account

For the default limits for an AWS account, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the limits form.

" + } + }, + "shapes":{ + "AddTagsToStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "Tags" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

A set of up to 10 key-value pairs to use to create the tags.

" + } + }, + "documentation":"

Represents the input for AddTagsToStream.

" + }, + "BooleanObject":{"type":"boolean"}, + "Consumer":{ + "type":"structure", + "required":[ + "ConsumerName", + "ConsumerARN", + "ConsumerStatus", + "ConsumerCreationTimestamp" + ], + "members":{ + "ConsumerName":{ + "shape":"ConsumerName", + "documentation":"

The name of the consumer is something you choose when you register the consumer.

" + }, + "ConsumerARN":{ + "shape":"ConsumerARN", + "documentation":"

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

" + }, + "ConsumerStatus":{ + "shape":"ConsumerStatus", + "documentation":"

A consumer can't read data while in the CREATING or DELETING states.

" + }, + "ConsumerCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

" + } + }, + "documentation":"

An object that represents the details of the consumer you registered.

" + }, + "ConsumerARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^(arn):aws.*:kinesis:.*:\\d{12}:.*stream\\/[a-zA-Z0-9_.-]+\\/consumer\\/[a-zA-Z0-9_.-]+:[0-9]+" + }, + "ConsumerCountObject":{ + "type":"integer", + "max":1000000, + "min":0 + }, + "ConsumerDescription":{ + "type":"structure", + "required":[ + "ConsumerName", + "ConsumerARN", + "ConsumerStatus", + "ConsumerCreationTimestamp", + "StreamARN" + ], + "members":{ + "ConsumerName":{ + "shape":"ConsumerName", + "documentation":"

The name of the consumer is something you choose when you register the consumer.

" + }, + "ConsumerARN":{ + "shape":"ConsumerARN", + "documentation":"

When you register a consumer, Kinesis Data Streams generates an ARN for it. You need this ARN to be able to call SubscribeToShard.

If you delete a consumer and then create a new one with the same name, it won't have the same ARN. That's because consumer ARNs contain the creation timestamp. This is important to keep in mind if you have IAM policies that reference consumer ARNs.

" + }, + "ConsumerStatus":{ + "shape":"ConsumerStatus", + "documentation":"

A consumer can't read data while in the CREATING or DELETING states.

" + }, + "ConsumerCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

" + }, + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The ARN of the stream with which you registered the consumer.

" + } + }, + "documentation":"

An object that represents the details of a registered consumer.

" + }, + "ConsumerList":{ + "type":"list", + "member":{"shape":"Consumer"} + }, + "ConsumerName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ConsumerStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE" + ] + }, + "CreateStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardCount" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.

" + }, + "ShardCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The number of shards that the stream will use. The throughput of the stream is a function of the number of shards; more shards are required for greater provisioned throughput.

DefaultShardLimit;

" + } + }, + "documentation":"

Represents the input for CreateStream.

" + }, + "Data":{ + "type":"blob", + "max":1048576, + "min":0 + }, + "DecreaseStreamRetentionPeriodInput":{ + "type":"structure", + "required":[ + "StreamName", + "RetentionPeriodHours" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to modify.

" + }, + "RetentionPeriodHours":{ + "shape":"RetentionPeriodHours", + "documentation":"

The new retention period of the stream, in hours. Must be less than the current retention period.

" + } + }, + "documentation":"

Represents the input for DecreaseStreamRetentionPeriod.

" + }, + "DeleteStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to delete.

" + }, + "EnforceConsumerDeletion":{ + "shape":"BooleanObject", + "documentation":"

If this parameter is unset (null) or if you set it to false, and the stream has registered consumers, the call to DeleteStream fails with a ResourceInUseException.

" + } + }, + "documentation":"

Represents the input for DeleteStream.

" + }, + "DeregisterStreamConsumerInput":{ + "type":"structure", + "members":{ + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ConsumerName":{ + "shape":"ConsumerName", + "documentation":"

The name that you gave to the consumer.

" + }, + "ConsumerARN":{ + "shape":"ConsumerARN", + "documentation":"

The ARN returned by Kinesis Data Streams when you registered the consumer. If you don't know the ARN of the consumer that you want to deregister, you can use the ListStreamConsumers operation to get a list of the descriptions of all the consumers that are currently registered with a given data stream. The description of a consumer contains its ARN.

" + } + } + }, + "DescribeLimitsInput":{ + "type":"structure", + "members":{ + } + }, + "DescribeLimitsOutput":{ + "type":"structure", + "required":[ + "ShardLimit", + "OpenShardCount" + ], + "members":{ + "ShardLimit":{ + "shape":"ShardCountObject", + "documentation":"

The maximum number of shards.

" + }, + "OpenShardCount":{ + "shape":"ShardCountObject", + "documentation":"

The number of open shards.

" + } + } + }, + "DescribeStreamConsumerInput":{ + "type":"structure", + "members":{ + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The ARN of the Kinesis data stream that the consumer is registered with. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ConsumerName":{ + "shape":"ConsumerName", + "documentation":"

The name that you gave to the consumer.

" + }, + "ConsumerARN":{ + "shape":"ConsumerARN", + "documentation":"

The ARN returned by Kinesis Data Streams when you registered the consumer.

" + } + } + }, + "DescribeStreamConsumerOutput":{ + "type":"structure", + "required":["ConsumerDescription"], + "members":{ + "ConsumerDescription":{ + "shape":"ConsumerDescription", + "documentation":"

An object that represents the details of the consumer.

" + } + } + }, + "DescribeStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to describe.

" + }, + "Limit":{ + "shape":"DescribeStreamInputLimit", + "documentation":"

The maximum number of shards to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 shards are returned.

" + }, + "ExclusiveStartShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to start with.

" + } + }, + "documentation":"

Represents the input for DescribeStream.

" + }, + "DescribeStreamInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "DescribeStreamOutput":{ + "type":"structure", + "required":["StreamDescription"], + "members":{ + "StreamDescription":{ + "shape":"StreamDescription", + "documentation":"

The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.

" + } + }, + "documentation":"

Represents the output for DescribeStream.

" + }, + "DescribeStreamSummaryInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to describe.

" + } + } + }, + "DescribeStreamSummaryOutput":{ + "type":"structure", + "required":["StreamDescriptionSummary"], + "members":{ + "StreamDescriptionSummary":{ + "shape":"StreamDescriptionSummary", + "documentation":"

A StreamDescriptionSummary containing information about the stream.

" + } + } + }, + "DisableEnhancedMonitoringInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardLevelMetrics" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the Kinesis data stream for which to disable enhanced monitoring.

" + }, + "ShardLevelMetrics":{ + "shape":"MetricsNameList", + "documentation":"

List of shard-level metrics to disable.

The following are the valid shard-level metrics. The value \"ALL\" disables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

" + } + }, + "documentation":"

Represents the input for DisableEnhancedMonitoring.

" + }, + "EnableEnhancedMonitoringInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardLevelMetrics" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for which to enable enhanced monitoring.

" + }, + "ShardLevelMetrics":{ + "shape":"MetricsNameList", + "documentation":"

List of shard-level metrics to enable.

The following are the valid shard-level metrics. The value \"ALL\" enables every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

" + } + }, + "documentation":"

Represents the input for EnableEnhancedMonitoring.

" + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "NONE", + "KMS" + ] + }, + "EnhancedMetrics":{ + "type":"structure", + "members":{ + "ShardLevelMetrics":{ + "shape":"MetricsNameList", + "documentation":"

List of shard-level metrics.

The following are the valid shard-level metrics. The value \"ALL\" enhances every metric.

  • IncomingBytes

  • IncomingRecords

  • OutgoingBytes

  • OutgoingRecords

  • WriteProvisionedThroughputExceeded

  • ReadProvisionedThroughputExceeded

  • IteratorAgeMilliseconds

  • ALL

For more information, see Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch in the Amazon Kinesis Data Streams Developer Guide.

" + } + }, + "documentation":"

Represents enhanced metrics types.

" + }, + "EnhancedMonitoringList":{ + "type":"list", + "member":{"shape":"EnhancedMetrics"} + }, + "EnhancedMonitoringOutput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the Kinesis data stream.

" + }, + "CurrentShardLevelMetrics":{ + "shape":"MetricsNameList", + "documentation":"

Represents the current state of the metrics that are in the enhanced state before the operation.

" + }, + "DesiredShardLevelMetrics":{ + "shape":"MetricsNameList", + "documentation":"

Represents the list of all the metrics that would be in the enhanced state after the operation.

" + } + }, + "documentation":"

Represents the output for EnableEnhancedMonitoring and DisableEnhancedMonitoring.

" + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "ExpiredIteratorException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The provided iterator exceeds the maximum age allowed.

", + "exception":true + }, + "ExpiredNextTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The pagination token passed to the operation is expired.

", + "exception":true + }, + "GetRecordsInput":{ + "type":"structure", + "required":["ShardIterator"], + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The position in the shard from which you want to start sequentially reading data records. A shard iterator specifies this position using the sequence number of a data record in the shard.

" + }, + "Limit":{ + "shape":"GetRecordsInputLimit", + "documentation":"

The maximum number of records to return. Specify a value of up to 10,000. If you specify a value that is greater than 10,000, GetRecords throws InvalidArgumentException.

" + } + }, + "documentation":"

Represents the input for GetRecords.

" + }, + "GetRecordsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "GetRecordsOutput":{ + "type":"structure", + "required":["Records"], + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"

The data records retrieved from the shard.

" + }, + "NextShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The next position in the shard from which to start sequentially reading data records. If set to null, the shard has been closed and the requested iterator does not return any more data.

" + }, + "MillisBehindLatest":{ + "shape":"MillisBehindLatest", + "documentation":"

The number of milliseconds the GetRecords response is from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

" + } + }, + "documentation":"

Represents the output for GetRecords.

" + }, + "GetShardIteratorInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardId", + "ShardIteratorType" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the Amazon Kinesis data stream.

" + }, + "ShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the Kinesis Data Streams shard to get the iterator for.

" + }, + "ShardIteratorType":{ + "shape":"ShardIteratorType", + "documentation":"

Determines how the shard iterator is used to start reading data records from the shard.

The following are the valid Amazon Kinesis shard iterator types:

  • AT_SEQUENCE_NUMBER - Start reading from the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AFTER_SEQUENCE_NUMBER - Start reading right after the position denoted by a specific sequence number, provided in the value StartingSequenceNumber.

  • AT_TIMESTAMP - Start reading from the position denoted by a specific time stamp, provided in the value Timestamp.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard.

  • LATEST - Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.

" + }, + "StartingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number of the data record in the shard from which to start reading. Used with shard iterator type AT_SEQUENCE_NUMBER and AFTER_SEQUENCE_NUMBER.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

The time stamp of the data record from which to start reading. Used with shard iterator type AT_TIMESTAMP. A time stamp is the Unix epoch date with precision in milliseconds. For example, 2016-04-04T19:58:46.480-00:00 or 1459799926.480. If a record with this exact time stamp does not exist, the iterator returned is for the next (later) record. If the time stamp is older than the current trim horizon, the iterator returned is for the oldest untrimmed data record (TRIM_HORIZON).

" + } + }, + "documentation":"

Represents the input for GetShardIterator.

" + }, + "GetShardIteratorOutput":{ + "type":"structure", + "members":{ + "ShardIterator":{ + "shape":"ShardIterator", + "documentation":"

The position in the shard from which to start reading data records sequentially. A shard iterator specifies this position using the sequence number of a data record in a shard.

" + } + }, + "documentation":"

Represents the output for GetShardIterator.

" + }, + "HashKey":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,38})" + }, + "HashKeyRange":{ + "type":"structure", + "required":[ + "StartingHashKey", + "EndingHashKey" + ], + "members":{ + "StartingHashKey":{ + "shape":"HashKey", + "documentation":"

The starting hash key of the hash key range.

" + }, + "EndingHashKey":{ + "shape":"HashKey", + "documentation":"

The ending hash key of the hash key range.

" + } + }, + "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" + }, + "IncreaseStreamRetentionPeriodInput":{ + "type":"structure", + "required":[ + "StreamName", + "RetentionPeriodHours" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to modify.

" + }, + "RetentionPeriodHours":{ + "shape":"RetentionPeriodHours", + "documentation":"

The new retention period of the stream, in hours. Must be more than the current retention period.

" + } + }, + "documentation":"

Represents the input for IncreaseStreamRetentionPeriod.

" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true, + "fault":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

A specified parameter exceeds its restrictions, is not supported, or can't be used. For more information, see the returned message.

", + "exception":true + }, + "KMSAccessDeniedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The ciphertext references a key that doesn't exist or that you don't have access to.

", + "exception":true + }, + "KMSDisabledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The request was rejected because the specified customer master key (CMK) isn't enabled.

", + "exception":true + }, + "KMSInvalidStateException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

", + "exception":true + }, + "KMSNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The request was rejected because the specified entity or resource can't be found.

", + "exception":true + }, + "KMSOptInRequired":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The AWS access key ID needs a subscription for the service.

", + "exception":true + }, + "KMSThrottlingException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

", + "exception":true + }, + "KeyId":{ + "type":"string", + "max":2048, + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

", + "exception":true + }, + "ListShardsInput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the data stream whose shards you want to list.

You cannot specify this parameter if you specify the NextToken parameter.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of shards that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListShards operation.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

" + }, + "ExclusiveStartShardId":{ + "shape":"ShardId", + "documentation":"

Specify this parameter to indicate that you want to list the shards starting with the shard whose ID immediately follows ExclusiveStartShardId.

If you don't specify this parameter, the default behavior is for ListShards to list the shards starting with the first one in the stream.

You cannot specify this parameter if you specify NextToken.

" + }, + "MaxResults":{ + "shape":"ListShardsInputLimit", + "documentation":"

The maximum number of shards to return in a single call to ListShards. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.

When the number of shards to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListShards to list the next set of shards.

" + }, + "StreamCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.

You cannot specify this parameter if you specify the NextToken parameter.

" + } + } + }, + "ListShardsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListShardsOutput":{ + "type":"structure", + "members":{ + "Shards":{ + "shape":"ShardList", + "documentation":"

An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

When the number of shards in the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of shards in the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListShards to list the next set of shards. For more information about the use of this pagination token when calling the ListShards operation, see ListShardsInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListShards, you have 300 seconds to use that value. If you specify an expired token in a call to ListShards, you get ExpiredNextTokenException.

" + } + } + }, + "ListStreamConsumersInput":{ + "type":"structure", + "required":["StreamARN"], + "members":{ + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The ARN of the Kinesis data stream for which you want to list the registered consumers. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of consumers that are registered with the data stream, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers.

Don't specify StreamName or StreamCreationTimestamp if you specify NextToken because the latter unambiguously identifies the stream.

You can optionally specify a value for the MaxResults parameter when you specify NextToken. If you specify a MaxResults value that is less than the number of consumers that the operation returns if you don't specify MaxResults, the response will contain a new NextToken value. You can use the new NextToken value in a subsequent call to the ListStreamConsumers operation to list the next set of consumers.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

" + }, + "MaxResults":{ + "shape":"ListStreamConsumersInputLimit", + "documentation":"

The maximum number of consumers that you want a single call of ListStreamConsumers to return.

" + }, + "StreamCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the consumers for.

You can't specify this parameter if you specify the NextToken parameter.

" + } + } + }, + "ListStreamConsumersInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListStreamConsumersOutput":{ + "type":"structure", + "members":{ + "Consumers":{ + "shape":"ConsumerList", + "documentation":"

An array of JSON objects. Each object represents one registered consumer.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

When the number of consumers that are registered with the data stream is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of registered consumers, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListStreamConsumers to list the next set of registered consumers. For more information about the use of this pagination token when calling the ListStreamConsumers operation, see ListStreamConsumersInput$NextToken.

Tokens expire after 300 seconds. When you obtain a value for NextToken in the response to a call to ListStreamConsumers, you have 300 seconds to use that value. If you specify an expired token in a call to ListStreamConsumers, you get ExpiredNextTokenException.

" + } + } + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"ListStreamsInputLimit", + "documentation":"

The maximum number of streams to list.

" + }, + "ExclusiveStartStreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to start the list with.

" + } + }, + "documentation":"

Represents the input for ListStreams.

" + }, + "ListStreamsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListStreamsOutput":{ + "type":"structure", + "required":[ + "StreamNames", + "HasMoreStreams" + ], + "members":{ + "StreamNames":{ + "shape":"StreamNameList", + "documentation":"

The names of the streams that are associated with the AWS account making the ListStreams request.

" + }, + "HasMoreStreams":{ + "shape":"BooleanObject", + "documentation":"

If set to true, there are more streams available to list.

" + } + }, + "documentation":"

Represents the output for ListStreams.

" + }, + "ListTagsForStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "ExclusiveStartTagKey":{ + "shape":"TagKey", + "documentation":"

The key to use as the starting point for the list of tags. If this parameter is set, ListTagsForStream gets all tags that occur after ExclusiveStartTagKey.

" + }, + "Limit":{ + "shape":"ListTagsForStreamInputLimit", + "documentation":"

The number of tags to return. If this number is less than the total number of tags associated with the stream, HasMoreTags is set to true. To list additional tags, set ExclusiveStartTagKey to the last key in the response.

" + } + }, + "documentation":"

Represents the input for ListTagsForStream.

" + }, + "ListTagsForStreamInputLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListTagsForStreamOutput":{ + "type":"structure", + "required":[ + "Tags", + "HasMoreTags" + ], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

" + }, + "HasMoreTags":{ + "shape":"BooleanObject", + "documentation":"

If set to true, more tags are available. To request additional tags, set ExclusiveStartTagKey to the key of the last tag returned.

" + } + }, + "documentation":"

Represents the output for ListTagsForStream.

" + }, + "MergeShardsInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToMerge", + "AdjacentShardToMerge" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for the merge.

" + }, + "ShardToMerge":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to combine with the adjacent shard for the merge.

" + }, + "AdjacentShardToMerge":{ + "shape":"ShardId", + "documentation":"

The shard ID of the adjacent shard for the merge.

" + } + }, + "documentation":"

Represents the input for MergeShards.

" + }, + "MetricsName":{ + "type":"string", + "enum":[ + "IncomingBytes", + "IncomingRecords", + "OutgoingBytes", + "OutgoingRecords", + "WriteProvisionedThroughputExceeded", + "ReadProvisionedThroughputExceeded", + "IteratorAgeMilliseconds", + "ALL" + ] + }, + "MetricsNameList":{ + "type":"list", + "member":{"shape":"MetricsName"}, + "max":7, + "min":1 + }, + "MillisBehindLatest":{ + "type":"long", + "min":0 + }, + "NextToken":{ + "type":"string", + "max":1048576, + "min":1 + }, + "PartitionKey":{ + "type":"string", + "max":256, + "min":1 + }, + "PositiveIntegerObject":{ + "type":"integer", + "max":100000, + "min":1 + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see Streams Limits in the Amazon Kinesis Data Streams Developer Guide, and Error Retries and Exponential Backoff in AWS in the AWS General Reference.

", + "exception":true + }, + "PutRecordInput":{ + "type":"structure", + "required":[ + "StreamName", + "Data", + "PartitionKey" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream to put the data record into.

" + }, + "Data":{ + "shape":"Data", + "documentation":"

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" + }, + "PartitionKey":{ + "shape":"PartitionKey", + "documentation":"

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

" + }, + "ExplicitHashKey":{ + "shape":"HashKey", + "documentation":"

The hash value used to explicitly determine the shard the data record is assigned to by overriding the partition key hash.

" + }, + "SequenceNumberForOrdering":{ + "shape":"SequenceNumber", + "documentation":"

Guarantees strictly increasing sequence numbers, for puts from the same client and to the same partition key. Usage: set the SequenceNumberForOrdering of record n to the sequence number of record n-1 (as returned in the result when putting record n-1). If this parameter is not set, records are coarsely ordered based on arrival time.

" + } + }, + "documentation":"

Represents the input for PutRecord.

" + }, + "PutRecordOutput":{ + "type":"structure", + "required":[ + "ShardId", + "SequenceNumber" + ], + "members":{ + "ShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard where the data record was placed.

" + }, + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number identifier that was assigned to the put data record. The sequence number for the record is unique across all records in the stream. A sequence number is the identifier associated with every record put into the stream.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type to use on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

" + } + }, + "documentation":"

Represents the output for PutRecord.

" + }, + "PutRecordsInput":{ + "type":"structure", + "required":[ + "Records", + "StreamName" + ], + "members":{ + "Records":{ + "shape":"PutRecordsRequestEntryList", + "documentation":"

The records associated with the request.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

The stream name associated with the request.

" + } + }, + "documentation":"

A PutRecords request.

" + }, + "PutRecordsOutput":{ + "type":"structure", + "required":["Records"], + "members":{ + "FailedRecordCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The number of unsuccessfully processed records in a PutRecords request.

" + }, + "Records":{ + "shape":"PutRecordsResultEntryList", + "documentation":"

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type used on the records. This parameter can be one of the following values:

  • NONE: Do not encrypt the records.

  • KMS: Use server-side encryption on the records using a customer-managed AWS KMS key.

" + } + }, + "documentation":"

PutRecords results.

" + }, + "PutRecordsRequestEntry":{ + "type":"structure", + "required":[ + "Data", + "PartitionKey" + ], + "members":{ + "Data":{ + "shape":"Data", + "documentation":"

The data blob to put into the record, which is base64-encoded when the blob is serialized. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" + }, + "ExplicitHashKey":{ + "shape":"HashKey", + "documentation":"

The hash value used to determine explicitly the shard that the data record is assigned to by overriding the partition key hash.

" + }, + "PartitionKey":{ + "shape":"PartitionKey", + "documentation":"

Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.

" + } + }, + "documentation":"

Represents the output for PutRecords.

" + }, + "PutRecordsRequestEntryList":{ + "type":"list", + "member":{"shape":"PutRecordsRequestEntry"}, + "max":500, + "min":1 + }, + "PutRecordsResultEntry":{ + "type":"structure", + "members":{ + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The sequence number for an individual record result.

" + }, + "ShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID for an individual record result.

" + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message \"Internal Service Failure\".

" + } + }, + "documentation":"

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

" + }, + "PutRecordsResultEntryList":{ + "type":"list", + "member":{"shape":"PutRecordsResultEntry"}, + "max":500, + "min":1 + }, + "Record":{ + "type":"structure", + "required":[ + "SequenceNumber", + "Data", + "PartitionKey" + ], + "members":{ + "SequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The unique identifier of the record within its shard.

" + }, + "ApproximateArrivalTimestamp":{ + "shape":"Timestamp", + "documentation":"

The approximate time that the record was inserted into the stream.

" + }, + "Data":{ + "shape":"Data", + "documentation":"

The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).

" + }, + "PartitionKey":{ + "shape":"PartitionKey", + "documentation":"

Identifies which shard in the stream the data record is assigned to.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type used on the record. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

" + } + }, + "documentation":"

The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.

" + }, + "RecordList":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RegisterStreamConsumerInput":{ + "type":"structure", + "required":[ + "StreamARN", + "ConsumerName" + ], + "members":{ + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The ARN of the Kinesis data stream that you want to register the consumer with. For more info, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

" + }, + "ConsumerName":{ + "shape":"ConsumerName", + "documentation":"

For a given Kinesis data stream, each consumer must have a unique name. However, consumer names don't have to be unique across data streams.

" + } + } + }, + "RegisterStreamConsumerOutput":{ + "type":"structure", + "required":["Consumer"], + "members":{ + "Consumer":{ + "shape":"Consumer", + "documentation":"

An object that represents the details of the consumer you registered. When you register a consumer, it gets an ARN that is generated by Kinesis Data Streams.

" + } + } + }, + "RemoveTagsFromStreamInput":{ + "type":"structure", + "required":[ + "StreamName", + "TagKeys" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys. Each corresponding tag is removed from the stream.

" + } + }, + "documentation":"

Represents the input for RemoveTagsFromStream.

" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The resource is not available for this operation. For successful operation, the resource must be in the ACTIVE state.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

A message that provides information about the error.

" + } + }, + "documentation":"

The requested resource could not be found. The stream might not be specified correctly.

", + "exception":true + }, + "RetentionPeriodHours":{ + "type":"integer", + "max":168, + "min":1 + }, + "ScalingType":{ + "type":"string", + "enum":["UNIFORM_SCALING"] + }, + "SequenceNumber":{ + "type":"string", + "pattern":"0|([1-9]\\d{0,128})" + }, + "SequenceNumberRange":{ + "type":"structure", + "required":["StartingSequenceNumber"], + "members":{ + "StartingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The starting sequence number for the range.

" + }, + "EndingSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

" + } + }, + "documentation":"

The range of possible sequence numbers for the shard.

" + }, + "Shard":{ + "type":"structure", + "required":[ + "ShardId", + "HashKeyRange", + "SequenceNumberRange" + ], + "members":{ + "ShardId":{ + "shape":"ShardId", + "documentation":"

The unique identifier of the shard within the stream.

" + }, + "ParentShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard's parent.

" + }, + "AdjacentParentShardId":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard adjacent to the shard's parent.

" + }, + "HashKeyRange":{ + "shape":"HashKeyRange", + "documentation":"

The range of possible hash key values for the shard, which is a set of ordered contiguous positive integers.

" + }, + "SequenceNumberRange":{ + "shape":"SequenceNumberRange", + "documentation":"

The range of possible sequence numbers for the shard.

" + } + }, + "documentation":"

A uniquely identified group of data records in a Kinesis data stream.

" + }, + "ShardCountObject":{ + "type":"integer", + "max":1000000, + "min":0 + }, + "ShardId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ShardIterator":{ + "type":"string", + "max":512, + "min":1 + }, + "ShardIteratorType":{ + "type":"string", + "enum":[ + "AT_SEQUENCE_NUMBER", + "AFTER_SEQUENCE_NUMBER", + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ] + }, + "ShardList":{ + "type":"list", + "member":{"shape":"Shard"} + }, + "SplitShardInput":{ + "type":"structure", + "required":[ + "StreamName", + "ShardToSplit", + "NewStartingHashKey" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for the shard split.

" + }, + "ShardToSplit":{ + "shape":"ShardId", + "documentation":"

The shard ID of the shard to split.

" + }, + "NewStartingHashKey":{ + "shape":"HashKey", + "documentation":"

A hash key value for the starting hash key of one of the child shards created by the split. The hash key range for a given shard constitutes a set of ordered contiguous positive integers. The value for NewStartingHashKey must be in the range of hash keys being mapped into the shard. The NewStartingHashKey hash key value and all higher hash key values in hash key range are distributed to one of the child shards. All the lower hash key values in the range are distributed to the other child shard.

" + } + }, + "documentation":"

Represents the input for SplitShard.

" + }, + "StartStreamEncryptionInput":{ + "type":"structure", + "required":[ + "StreamName", + "EncryptionType", + "KeyId" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream for which to start encrypting records.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type to use. The only valid value is KMS.

" + }, + "KeyId":{ + "shape":"KeyId", + "documentation":"

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

" + } + } + }, + "StartingPosition":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{"shape":"ShardIteratorType"}, + "SequenceNumber":{"shape":"SequenceNumber"}, + "Timestamp":{"shape":"Timestamp"} + } + }, + "StopStreamEncryptionInput":{ + "type":"structure", + "required":[ + "StreamName", + "EncryptionType", + "KeyId" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream on which to stop encrypting records.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type. The only valid value is KMS.

" + }, + "KeyId":{ + "shape":"KeyId", + "documentation":"

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

" + } + } + }, + "StreamARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws.*:kinesis:.*:\\d{12}:stream/.*" + }, + "StreamDescription":{ + "type":"structure", + "required":[ + "StreamName", + "StreamARN", + "StreamStatus", + "Shards", + "HasMoreShards", + "RetentionPeriodHours", + "StreamCreationTimestamp", + "EnhancedMonitoring" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream being described.

" + }, + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The Amazon Resource Name (ARN) for the stream being described.

" + }, + "StreamStatus":{ + "shape":"StreamStatus", + "documentation":"

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

" + }, + "Shards":{ + "shape":"ShardList", + "documentation":"

The shards that comprise the stream.

" + }, + "HasMoreShards":{ + "shape":"BooleanObject", + "documentation":"

If set to true, more shards in the stream are available to describe.

" + }, + "RetentionPeriodHours":{ + "shape":"RetentionPeriodHours", + "documentation":"

The current retention period, in hours.

" + }, + "StreamCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The approximate time that the stream was created.

" + }, + "EnhancedMonitoring":{ + "shape":"EnhancedMonitoringList", + "documentation":"

Represents the current enhanced monitoring settings of the stream.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

" + }, + "KeyId":{ + "shape":"KeyId", + "documentation":"

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

" + } + }, + "documentation":"

Represents the output for DescribeStream.

" + }, + "StreamDescriptionSummary":{ + "type":"structure", + "required":[ + "StreamName", + "StreamARN", + "StreamStatus", + "RetentionPeriodHours", + "StreamCreationTimestamp", + "EnhancedMonitoring", + "OpenShardCount" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream being described.

" + }, + "StreamARN":{ + "shape":"StreamARN", + "documentation":"

The Amazon Resource Name (ARN) for the stream being described.

" + }, + "StreamStatus":{ + "shape":"StreamStatus", + "documentation":"

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

" + }, + "RetentionPeriodHours":{ + "shape":"PositiveIntegerObject", + "documentation":"

The current retention period, in hours.

" + }, + "StreamCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The approximate time that the stream was created.

" + }, + "EnhancedMonitoring":{ + "shape":"EnhancedMonitoringList", + "documentation":"

Represents the current enhanced monitoring settings of the stream.

" + }, + "EncryptionType":{ + "shape":"EncryptionType", + "documentation":"

The encryption type used. This value is one of the following:

  • KMS

  • NONE

" + }, + "KeyId":{ + "shape":"KeyId", + "documentation":"

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

" + }, + "OpenShardCount":{ + "shape":"ShardCountObject", + "documentation":"

The number of open shards in the stream.

" + }, + "ConsumerCount":{ + "shape":"ConsumerCountObject", + "documentation":"

The number of enhanced fan-out consumers registered with the stream.

" + } + }, + "documentation":"

Represents the output for DescribeStreamSummary

" + }, + "StreamName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "StreamNameList":{ + "type":"list", + "member":{"shape":"StreamName"} + }, + "StreamStatus":{ + "type":"string", + "enum":[ + "CREATING", + "DELETING", + "ACTIVE", + "UPDATING" + ] + }, + "SubscribeToShardEvent":{ + "type":"structure", + "required":[ + "Records", + "ContinuationSequenceNumber", + "MillisBehindLatest" + ], + "members":{ + "Records":{ + "shape":"RecordList", + "documentation":"

" + }, + "ContinuationSequenceNumber":{ + "shape":"SequenceNumber", + "documentation":"

Use this as StartingSequenceNumber in the next call to SubscribeToShard.

" + }, + "MillisBehindLatest":{ + "shape":"MillisBehindLatest", + "documentation":"

The number of milliseconds the read records are from the tip of the stream, indicating how far behind current time the consumer is. A value of zero indicates that record processing is caught up, and there are no new records to process at this moment.

" + } + }, + "documentation":"

After you call SubscribeToShard, Kinesis Data Streams sends events of this type to your consumer.

", + "event":true + }, + "SubscribeToShardEventStream":{ + "type":"structure", + "required":["SubscribeToShardEvent"], + "members":{ + "SubscribeToShardEvent":{"shape":"SubscribeToShardEvent"}, + "ResourceNotFoundException":{"shape":"ResourceNotFoundException"}, + "ResourceInUseException":{"shape":"ResourceInUseException"}, + "KMSDisabledException":{"shape":"KMSDisabledException"}, + "KMSInvalidStateException":{"shape":"KMSInvalidStateException"}, + "KMSAccessDeniedException":{"shape":"KMSAccessDeniedException"}, + "KMSNotFoundException":{"shape":"KMSNotFoundException"}, + "KMSOptInRequired":{"shape":"KMSOptInRequired"}, + "KMSThrottlingException":{"shape":"KMSThrottlingException"}, + "InternalFailureException":{"shape":"InternalFailureException"} + }, + "eventstream":true + }, + "SubscribeToShardInput":{ + "type":"structure", + "required":[ + "ConsumerARN", + "ShardId", + "StartingPosition" + ], + "members":{ + "ConsumerARN":{ + "shape":"ConsumerARN", + "documentation":"

For this parameter, use the value you obtained when you called RegisterStreamConsumer.

" + }, + "ShardId":{ + "shape":"ShardId", + "documentation":"

The ID of the shard you want to subscribe to. To see a list of all the shards for a given stream, use ListShards.

" + }, + "StartingPosition":{"shape":"StartingPosition"} + } + }, + "SubscribeToShardOutput":{ + "type":"structure", + "required":["EventStream"], + "members":{ + "EventStream":{ + "shape":"SubscribeToShardEventStream", + "documentation":"

The event stream that your consumer can use to read records from the shard.

" + } + } + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A unique identifier for the tag. Maximum length: 128 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

An optional string, typically used to describe or define the tag. Maximum length: 256 characters. Valid characters: Unicode letters, digits, white space, _ . / = + - % @

" + } + }, + "documentation":"

Metadata assigned to the stream, consisting of a key-value pair.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":0 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "UpdateShardCountInput":{ + "type":"structure", + "required":[ + "StreamName", + "TargetShardCount", + "ScalingType" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "TargetShardCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The new number of shards.

" + }, + "ScalingType":{ + "shape":"ScalingType", + "documentation":"

The scaling type. Uniform scaling creates shards of equal size.

" + } + } + }, + "UpdateShardCountOutput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "CurrentShardCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The current number of shards.

" + }, + "TargetShardCount":{ + "shape":"PositiveIntegerObject", + "documentation":"

The updated number of shards.

" + } + } + } + }, + "documentation":"Amazon Kinesis Data Streams Service API Reference

Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.

" +} diff --git a/aws/dist/botocore/data/kinesis/2013-12-02/waiters-2.json b/aws/dist/botocore/data/kinesis/2013-12-02/waiters-2.json new file mode 100644 index 00000000..d61efe43 --- /dev/null +++ b/aws/dist/botocore/data/kinesis/2013-12-02/waiters-2.json @@ -0,0 +1,30 @@ +{ + "version": 2, + "waiters": { + "StreamExists": { + "delay": 10, + "operation": "DescribeStream", + "maxAttempts": 18, + "acceptors": [ + { + "expected": "ACTIVE", + "matcher": "path", + "state": "success", + "argument": "StreamDescription.StreamStatus" + } + ] + }, + "StreamNotExists": { + "delay": 10, + "operation": "DescribeStream", + "maxAttempts": 18, + "acceptors": [ + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/kinesisanalytics/2015-08-14/examples-1.json b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/kinesisanalytics/2015-08-14/paginators-1.json b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/kinesisanalytics/2015-08-14/service-2.json b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/service-2.json new file mode 100644 index 00000000..b808a99b --- /dev/null +++ b/aws/dist/botocore/data/kinesisanalytics/2015-08-14/service-2.json @@ -0,0 +1,2292 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-08-14", + "endpointPrefix":"kinesisanalytics", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Kinesis Analytics", + "serviceFullName":"Amazon Kinesis Analytics", + "serviceId":"Kinesis Analytics", + "signatureVersion":"v4", + "targetPrefix":"KinesisAnalytics_20150814", + "uid":"kinesisanalytics-2015-08-14" + }, + "operations":{ + "AddApplicationCloudWatchLoggingOption":{ + "name":"AddApplicationCloudWatchLoggingOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationCloudWatchLoggingOptionRequest"}, + "output":{"shape":"AddApplicationCloudWatchLoggingOptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a CloudWatch log stream to monitor application configuration errors. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

" + }, + "AddApplicationInput":{ + "name":"AddApplicationInput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationInputRequest"}, + "output":{"shape":"AddApplicationInputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"CodeValidationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a streaming source to your Amazon Kinesis application. For conceptual information, see Configuring Application Input.

You can add a streaming source either when you create an application or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

This operation requires permissions to perform the kinesisanalytics:AddApplicationInput action.

" + }, + "AddApplicationInputProcessingConfiguration":{ + "name":"AddApplicationInputProcessingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationInputProcessingConfigurationRequest"}, + "output":{"shape":"AddApplicationInputProcessingConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds an InputProcessingConfiguration to an application. An input processor preprocesses records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.

" + }, + "AddApplicationOutput":{ + "name":"AddApplicationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationOutputRequest"}, + "output":{"shape":"AddApplicationOutputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds an external destination to your Amazon Kinesis Analytics application.

If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination).

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

For the limits on the number of application inputs and outputs you can configure, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

" + }, + "AddApplicationReferenceDataSource":{ + "name":"AddApplicationReferenceDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationReferenceDataSourceRequest"}, + "output":{"shape":"AddApplicationReferenceDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Adds a reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input. For the limits on data sources you can add to your application, see Limits.

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"CodeValidationException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Creates an Amazon Kinesis Analytics application. You can configure each application with one streaming source as input, application code to process the input, and up to three destinations where you want Amazon Kinesis Analytics to write the output data from your application. For an overview, see How it Works.

In the input configuration, you map the streaming source to an in-application stream, which you can think of as a constantly updating table. In the mapping, you must provide a schema for the in-application stream and map each data column in the in-application stream to a data element in the streaming source.

Your application code is one or more SQL statements that read input data, transform it, and generate output. Your application code can create one or more SQL artifacts like SQL streams or pumps.

In the output configuration, you can configure the application to write data from in-application streams created in your applications to up to three destinations.

To read data from your source stream or write data to destination streams, Amazon Kinesis Analytics needs your permissions. You grant these permissions by creating IAM roles. This operation requires permissions to perform the kinesisanalytics:CreateApplication action.

For introductory exercises to create an Amazon Kinesis Analytics application, see Getting Started.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes the specified application. Amazon Kinesis Analytics halts application execution and deletes the application, including any application artifacts (such as in-application streams, reference table, and application code).

This operation requires permissions to perform the kinesisanalytics:DeleteApplication action.

" + }, + "DeleteApplicationCloudWatchLoggingOption":{ + "name":"DeleteApplicationCloudWatchLoggingOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationCloudWatchLoggingOptionRequest"}, + "output":{"shape":"DeleteApplicationCloudWatchLoggingOptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes a CloudWatch log stream from an application. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

" + }, + "DeleteApplicationInputProcessingConfiguration":{ + "name":"DeleteApplicationInputProcessingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationInputProcessingConfigurationRequest"}, + "output":{"shape":"DeleteApplicationInputProcessingConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes an InputProcessingConfiguration from an input.

" + }, + "DeleteApplicationOutput":{ + "name":"DeleteApplicationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationOutputRequest"}, + "output":{"shape":"DeleteApplicationOutputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes output destination configuration from your application configuration. Amazon Kinesis Analytics will no longer write data from the corresponding in-application stream to the external output destination.

This operation requires permissions to perform the kinesisanalytics:DeleteApplicationOutput action.

" + }, + "DeleteApplicationReferenceDataSource":{ + "name":"DeleteApplicationReferenceDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationReferenceDataSourceRequest"}, + "output":{"shape":"DeleteApplicationReferenceDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Deletes a reference data source configuration from the specified application configuration.

If the application is running, Amazon Kinesis Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

This operation requires permissions to perform the kinesisanalytics.DeleteApplicationReferenceDataSource action.

" + }, + "DescribeApplication":{ + "name":"DescribeApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationRequest"}, + "output":{"shape":"DescribeApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns information about a specific Amazon Kinesis Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.

" + }, + "DiscoverInputSchema":{ + "name":"DiscoverInputSchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DiscoverInputSchemaRequest"}, + "output":{"shape":"DiscoverInputSchemaResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"UnableToDetectSchemaException"}, + {"shape":"ResourceProvisionedThroughputExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Infers a schema by evaluating sample records on the specified streaming source (Amazon Kinesis stream or Amazon Kinesis Firehose delivery stream) or S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. For conceptual information, see Configuring Application Input. Note that when you create an application using the Amazon Kinesis Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

This operation requires permissions to perform the kinesisanalytics:DiscoverInputSchema action.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Returns a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Retrieves the list of key-value tags assigned to the application. For more information, see Using Tagging.

" + }, + "StartApplication":{ + "name":"StartApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartApplicationRequest"}, + "output":{"shape":"StartApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidApplicationConfigurationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Starts the specified Amazon Kinesis Analytics application. After creating an application, you must exclusively call this operation to start your application.

After the application starts, it begins consuming the input data, processes it, and writes the output to the configured destination.

The application status must be READY for you to start an application. You can get the application status in the console or using the DescribeApplication operation.

After you start the application, you can stop the application from processing the input by calling the StopApplication operation.

This operation requires permissions to perform the kinesisanalytics:StartApplication action.

" + }, + "StopApplication":{ + "name":"StopApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopApplicationRequest"}, + "output":{"shape":"StopApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Stops the application from processing input data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state. After the application is stopped, Amazon Kinesis Analytics stops reading data from the input, the application stops processing data, and there is no output written to the destination.

This operation requires permissions to perform the kinesisanalytics:StopApplication action.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes one or more tags from a Kinesis Analytics application. For more information, see Using Tagging.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"CodeValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Updates an existing Amazon Kinesis Analytics application. Using this API, you can update application code, input configuration, and output configuration.

Note that Amazon Kinesis Analytics updates the CurrentApplicationVersionId each time you update your application.

This operation requires permission for the kinesisanalytics:UpdateApplication action.

" + } + }, + "shapes":{ + "AddApplicationCloudWatchLoggingOptionRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOption" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The Kinesis Analytics application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the Kinesis Analytics application.

" + }, + "CloudWatchLoggingOption":{ + "shape":"CloudWatchLoggingOption", + "documentation":"

Provides the CloudWatch log stream Amazon Resource Name (ARN) and the IAM role ARN. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

" + } + } + }, + "AddApplicationCloudWatchLoggingOptionResponse":{ + "type":"structure", + "members":{ + } + }, + "AddApplicationInputProcessingConfigurationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId", + "InputProcessingConfiguration" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application to which you want to add the input processing configuration.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "InputId":{ + "shape":"Id", + "documentation":"

The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration to add to the application.

" + } + } + }, + "AddApplicationInputProcessingConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "AddApplicationInputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "Input" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of your existing Amazon Kinesis Analytics application to which you want to add the streaming source.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Current version of your Amazon Kinesis Analytics application. You can use the DescribeApplication operation to find the current application version.

" + }, + "Input":{ + "shape":"Input", + "documentation":"

The Input to add.

" + } + }, + "documentation":"

" + }, + "AddApplicationInputResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "AddApplicationOutputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "Output" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application to which you want to add the output configuration.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "Output":{ + "shape":"Output", + "documentation":"

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

" + } + }, + "documentation":"

" + }, + "AddApplicationOutputResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "AddApplicationReferenceDataSourceRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceDataSource" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of an existing application.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "ReferenceDataSource":{ + "shape":"ReferenceDataSource", + "documentation":"

The reference data source can be an object in your Amazon S3 bucket. Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.

" + } + }, + "documentation":"

" + }, + "AddApplicationReferenceDataSourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "ApplicationCode":{ + "type":"string", + "max":102400, + "min":0 + }, + "ApplicationDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ApplicationDetail":{ + "type":"structure", + "required":[ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus", + "ApplicationVersionId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application.

" + }, + "ApplicationDescription":{ + "shape":"ApplicationDescription", + "documentation":"

Description of the application.

" + }, + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the application.

" + }, + "ApplicationStatus":{ + "shape":"ApplicationStatus", + "documentation":"

Status of the application.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time stamp when the application version was created.

" + }, + "LastUpdateTimestamp":{ + "shape":"Timestamp", + "documentation":"

Time stamp when the application was last updated.

" + }, + "InputDescriptions":{ + "shape":"InputDescriptions", + "documentation":"

Describes the application input configuration. For more information, see Configuring Application Input.

" + }, + "OutputDescriptions":{ + "shape":"OutputDescriptions", + "documentation":"

Describes the application output configuration. For more information, see Configuring Application Output.

" + }, + "ReferenceDataSourceDescriptions":{ + "shape":"ReferenceDataSourceDescriptions", + "documentation":"

Describes reference data sources configured for the application. For more information, see Configuring Application Input.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "shape":"CloudWatchLoggingOptionDescriptions", + "documentation":"

Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

" + }, + "ApplicationCode":{ + "shape":"ApplicationCode", + "documentation":"

Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Provides the current application version.

" + } + }, + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

" + }, + "ApplicationName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ApplicationStatus":{ + "type":"string", + "enum":[ + "DELETING", + "STARTING", + "STOPPING", + "READY", + "RUNNING", + "UPDATING" + ] + }, + "ApplicationSummaries":{ + "type":"list", + "member":{"shape":"ApplicationSummary"} + }, + "ApplicationSummary":{ + "type":"structure", + "required":[ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application.

" + }, + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the application.

" + }, + "ApplicationStatus":{ + "shape":"ApplicationStatus", + "documentation":"

Status of the application.

" + } + }, + "documentation":"

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

" + }, + "ApplicationUpdate":{ + "type":"structure", + "members":{ + "InputUpdates":{ + "shape":"InputUpdates", + "documentation":"

Describes application input configuration updates.

" + }, + "ApplicationCodeUpdate":{ + "shape":"ApplicationCode", + "documentation":"

Describes application code updates.

" + }, + "OutputUpdates":{ + "shape":"OutputUpdates", + "documentation":"

Describes application output configuration updates.

" + }, + "ReferenceDataSourceUpdates":{ + "shape":"ReferenceDataSourceUpdates", + "documentation":"

Describes application reference data source updates.

" + }, + "CloudWatchLoggingOptionUpdates":{ + "shape":"CloudWatchLoggingOptionUpdates", + "documentation":"

Describes application CloudWatch logging option updates.

" + } + }, + "documentation":"

Describes updates to apply to an existing Amazon Kinesis Analytics application.

" + }, + "ApplicationVersionId":{ + "type":"long", + "max":999999999, + "min":1 + }, + "BooleanObject":{"type":"boolean"}, + "BucketARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "CSVMappingParameters":{ + "type":"structure", + "required":[ + "RecordRowDelimiter", + "RecordColumnDelimiter" + ], + "members":{ + "RecordRowDelimiter":{ + "shape":"RecordRowDelimiter", + "documentation":"

Row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter.

" + }, + "RecordColumnDelimiter":{ + "shape":"RecordColumnDelimiter", + "documentation":"

Column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.

" + } + }, + "documentation":"

Provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:

\"name1\", \"address1\"

\"name2\", \"address2\"

" + }, + "CloudWatchLoggingOption":{ + "type":"structure", + "required":[ + "LogStreamARN", + "RoleARN" + ], + "members":{ + "LogStreamARN":{ + "shape":"LogStreamARN", + "documentation":"

ARN of the CloudWatch log to receive application messages.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role that is used must have the PutLogEvents policy action enabled.

" + } + }, + "documentation":"

Provides a description of CloudWatch logging options, including the log stream Amazon Resource Name (ARN) and the role ARN.

" + }, + "CloudWatchLoggingOptionDescription":{ + "type":"structure", + "required":[ + "LogStreamARN", + "RoleARN" + ], + "members":{ + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

ID of the CloudWatch logging option description.

" + }, + "LogStreamARN":{ + "shape":"LogStreamARN", + "documentation":"

ARN of the CloudWatch log to receive application messages.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.

" + } + }, + "documentation":"

Description of the CloudWatch logging option.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOptionDescription"} + }, + "CloudWatchLoggingOptionUpdate":{ + "type":"structure", + "required":["CloudWatchLoggingOptionId"], + "members":{ + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

ID of the CloudWatch logging option to update

" + }, + "LogStreamARNUpdate":{ + "shape":"LogStreamARN", + "documentation":"

ARN of the CloudWatch log to receive application messages.

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

IAM ARN of the role to use to send application messages. Note: To write application messages to CloudWatch, the IAM role used must have the PutLogEvents policy action enabled.

" + } + }, + "documentation":"

Describes CloudWatch logging option updates.

" + }, + "CloudWatchLoggingOptionUpdates":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOptionUpdate"} + }, + "CloudWatchLoggingOptions":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOption"} + }, + "CodeValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

Test

" + } + }, + "documentation":"

User-provided application code (query) is invalid. This can be a simple syntax error.

", + "exception":true + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Exception thrown as a result of concurrent modification to an application. For example, two individuals attempting to edit the same application at the same time.

", + "exception":true + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of your Amazon Kinesis Analytics application (for example, sample-app).

" + }, + "ApplicationDescription":{ + "shape":"ApplicationDescription", + "documentation":"

Summary description of the application.

" + }, + "Inputs":{ + "shape":"Inputs", + "documentation":"

Use this parameter to configure the application input.

You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).

For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.

To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.

" + }, + "Outputs":{ + "shape":"Outputs", + "documentation":"

You can configure application output to write data from any of the in-application streams to up to three destinations.

These destinations can be Amazon Kinesis streams, Amazon Kinesis Firehose delivery streams, AWS Lambda destinations, or any combination of the three.

In the configuration, you specify the in-application stream name, the destination stream or Lambda function Amazon Resource Name (ARN), and the format to use when writing data. You must also provide an IAM role that Amazon Kinesis Analytics can assume to write to the destination stream or Lambda function on your behalf.

In the output configuration, you also provide the output stream or Lambda function ARN. For stream destinations, you provide the format of data in the stream (for example, JSON, CSV). You also must provide an IAM role that Amazon Kinesis Analytics can assume to write to the stream or Lambda function on your behalf.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

Use this parameter to configure a CloudWatch log stream to monitor application configuration errors. For more information, see Working with Amazon CloudWatch Logs.

" + }, + "ApplicationCode":{ + "shape":"ApplicationCode", + "documentation":"

One or more SQL statements that read input data, transform it, and generate output. For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code.

You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.

Note that the application code must create the streams with names specified in the Outputs. For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2, then your application code must create these streams.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

" + } + }, + "documentation":"

TBD

" + }, + "CreateApplicationResponse":{ + "type":"structure", + "required":["ApplicationSummary"], + "members":{ + "ApplicationSummary":{ + "shape":"ApplicationSummary", + "documentation":"

In response to your CreateApplication request, Amazon Kinesis Analytics returns a response with a summary of the application it created, including the application Amazon Resource Name (ARN), name, and status.

" + } + }, + "documentation":"

TBD

" + }, + "DeleteApplicationCloudWatchLoggingOptionRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOptionId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The Kinesis Analytics application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the Kinesis Analytics application.

" + }, + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

The CloudWatchLoggingOptionId of the CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

" + } + } + }, + "DeleteApplicationCloudWatchLoggingOptionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationInputProcessingConfigurationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The Kinesis Analytics application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the Kinesis Analytics application.

" + }, + "InputId":{ + "shape":"Id", + "documentation":"

The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

" + } + } + }, + "DeleteApplicationInputProcessingConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationOutputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "OutputId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Amazon Kinesis Analytics application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Amazon Kinesis Analytics application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "OutputId":{ + "shape":"Id", + "documentation":"

The ID of the configuration to delete. Each output configuration that is added to the application, either when the application is created or later using the AddApplicationOutput operation, has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

" + } + }, + "documentation":"

" + }, + "DeleteApplicationOutputResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "DeleteApplicationReferenceDataSourceRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of an existing application.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Version of the application. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "ReferenceId":{ + "shape":"Id", + "documentation":"

ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Amazon Kinesis Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

" + } + } + }, + "DeleteApplicationReferenceDataSourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CreateTimestamp" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the Amazon Kinesis Analytics application to delete.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

You can use the DescribeApplication operation to get this value.

" + } + }, + "documentation":"

" + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "DescribeApplicationRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application.

" + } + }, + "documentation":"

" + }, + "DescribeApplicationResponse":{ + "type":"structure", + "required":["ApplicationDetail"], + "members":{ + "ApplicationDetail":{ + "shape":"ApplicationDetail", + "documentation":"

Provides a description of the application, such as the application Amazon Resource Name (ARN), status, latest version, and input and output configuration details.

" + } + }, + "documentation":"

" + }, + "DestinationSchema":{ + "type":"structure", + "required":["RecordFormatType"], + "members":{ + "RecordFormatType":{ + "shape":"RecordFormatType", + "documentation":"

Specifies the format of the records on the output stream.

" + } + }, + "documentation":"

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" + }, + "DiscoverInputSchemaRequest":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the streaming source.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

Point at which you want Amazon Kinesis Analytics to start reading records from the specified streaming source discovery purposes.

" + }, + "S3Configuration":{ + "shape":"S3Configuration", + "documentation":"

Specify this parameter to discover a schema from data in an Amazon S3 object.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

" + } + } + }, + "DiscoverInputSchemaResponse":{ + "type":"structure", + "members":{ + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

Schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

" + }, + "ParsedInputRecords":{ + "shape":"ParsedInputRecords", + "documentation":"

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" + }, + "ProcessedInputRecords":{ + "shape":"ProcessedInputRecords", + "documentation":"

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

" + }, + "RawInputRecords":{ + "shape":"RawInputRecords", + "documentation":"

Raw stream data that was sampled to infer the schema.

" + } + }, + "documentation":"

" + }, + "ErrorMessage":{"type":"string"}, + "FileKey":{ + "type":"string", + "max":1024, + "min":1 + }, + "Id":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "InAppStreamName":{ + "type":"string", + "max":32, + "min":1 + }, + "InAppStreamNames":{ + "type":"list", + "member":{"shape":"InAppStreamName"} + }, + "InAppTableName":{ + "type":"string", + "max":32, + "min":1 + }, + "Input":{ + "type":"structure", + "required":[ + "NamePrefix", + "InputSchema" + ], + "members":{ + "NamePrefix":{ + "shape":"InAppStreamName", + "documentation":"

Name prefix to use when creating an in-application stream. Suppose that you specify a prefix \"MyInApplicationStream.\" Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names \"MyInApplicationStream_001,\" \"MyInApplicationStream_002,\" and so on.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

" + }, + "KinesisStreamsInput":{ + "shape":"KinesisStreamsInput", + "documentation":"

If the streaming source is an Amazon Kinesis stream, identifies the stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

" + }, + "KinesisFirehoseInput":{ + "shape":"KinesisFirehoseInput", + "documentation":"

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

" + }, + "InputParallelism":{ + "shape":"InputParallelism", + "documentation":"

Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

(see Configuring Application Input.

" + }, + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

" + } + }, + "documentation":"

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two. For more information, see Configuring Application Input.

" + }, + "InputConfiguration":{ + "type":"structure", + "required":[ + "Id", + "InputStartingPositionConfiguration" + ], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

Input source ID. You can get this ID by calling the DescribeApplication operation.

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

Point at which you want the application to start processing records from the streaming source.

" + } + }, + "documentation":"

When you start your application, you provide this configuration, which identifies the input source and the point in the input source at which you want the application to start processing records.

" + }, + "InputConfigurations":{ + "type":"list", + "member":{"shape":"InputConfiguration"} + }, + "InputDescription":{ + "type":"structure", + "members":{ + "InputId":{ + "shape":"Id", + "documentation":"

Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

" + }, + "NamePrefix":{ + "shape":"InAppStreamName", + "documentation":"

In-application name prefix.

" + }, + "InAppStreamNames":{ + "shape":"InAppStreamNames", + "documentation":"

Returns the in-application stream names that are mapped to the stream source.

" + }, + "InputProcessingConfigurationDescription":{ + "shape":"InputProcessingConfigurationDescription", + "documentation":"

The description of the preprocessor that executes on records in this input before the application's code is run.

" + }, + "KinesisStreamsInputDescription":{ + "shape":"KinesisStreamsInputDescription", + "documentation":"

If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" + }, + "KinesisFirehoseInputDescription":{ + "shape":"KinesisFirehoseInputDescription", + "documentation":"

If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

" + }, + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

" + }, + "InputParallelism":{ + "shape":"InputParallelism", + "documentation":"

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

Point at which the application is configured to read from the input stream.

" + } + }, + "documentation":"

Describes the application input configuration. For more information, see Configuring Application Input.

" + }, + "InputDescriptions":{ + "type":"list", + "member":{"shape":"InputDescription"} + }, + "InputLambdaProcessor":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the AWS Lambda function that operates on records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that is used to access the AWS Lambda function.

" + } + }, + "documentation":"

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.

" + }, + "InputLambdaProcessorDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the AWS Lambda function that is used to preprocess the records in the stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that is used to access the AWS Lambda function.

" + } + }, + "documentation":"

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda expression.

" + }, + "InputLambdaProcessorUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

The ARN of the new IAM role that is used to access the AWS Lambda function.

" + } + }, + "documentation":"

Represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.

" + }, + "InputParallelism":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"InputParallelismCount", + "documentation":"

Number of in-application streams to create. For more information, see Limits.

" + } + }, + "documentation":"

Describes the number of in-application streams to create for a given streaming source. For information about parallelism, see Configuring Application Input.

" + }, + "InputParallelismCount":{ + "type":"integer", + "max":64, + "min":1 + }, + "InputParallelismUpdate":{ + "type":"structure", + "members":{ + "CountUpdate":{ + "shape":"InputParallelismCount", + "documentation":"

Number of in-application streams to create for the specified streaming source.

" + } + }, + "documentation":"

Provides updates to the parallelism count.

" + }, + "InputProcessingConfiguration":{ + "type":"structure", + "required":["InputLambdaProcessor"], + "members":{ + "InputLambdaProcessor":{ + "shape":"InputLambdaProcessor", + "documentation":"

The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

" + } + }, + "documentation":"

Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda.

" + }, + "InputProcessingConfigurationDescription":{ + "type":"structure", + "members":{ + "InputLambdaProcessorDescription":{ + "shape":"InputLambdaProcessorDescription", + "documentation":"

Provides configuration information about the associated InputLambdaProcessorDescription.

" + } + }, + "documentation":"

Provides configuration information about an input processor. Currently, the only input processor available is AWS Lambda.

" + }, + "InputProcessingConfigurationUpdate":{ + "type":"structure", + "required":["InputLambdaProcessorUpdate"], + "members":{ + "InputLambdaProcessorUpdate":{ + "shape":"InputLambdaProcessorUpdate", + "documentation":"

Provides update information for an InputLambdaProcessor.

" + } + }, + "documentation":"

Describes updates to an InputProcessingConfiguration.

" + }, + "InputSchemaUpdate":{ + "type":"structure", + "members":{ + "RecordFormatUpdate":{ + "shape":"RecordFormat", + "documentation":"

Specifies the format of the records on the streaming source.

" + }, + "RecordEncodingUpdate":{ + "shape":"RecordEncoding", + "documentation":"

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" + }, + "RecordColumnUpdates":{ + "shape":"RecordColumns", + "documentation":"

A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.

" + } + }, + "documentation":"

Describes updates for the application's input schema.

" + }, + "InputStartingPosition":{ + "type":"string", + "enum":[ + "NOW", + "TRIM_HORIZON", + "LAST_STOPPED_POINT" + ] + }, + "InputStartingPositionConfiguration":{ + "type":"structure", + "members":{ + "InputStartingPosition":{ + "shape":"InputStartingPosition", + "documentation":"

The starting position on the stream.

  • NOW - Start reading just after the most recent record in the stream, start at the request time stamp that the customer issued.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Firehose delivery stream.

  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

" + } + }, + "documentation":"

Describes the point at which the application reads from the streaming source.

" + }, + "InputUpdate":{ + "type":"structure", + "required":["InputId"], + "members":{ + "InputId":{ + "shape":"Id", + "documentation":"

Input ID of the application input to be updated.

" + }, + "NamePrefixUpdate":{ + "shape":"InAppStreamName", + "documentation":"

Name prefix for in-application streams that Amazon Kinesis Analytics creates for the specific streaming source.

" + }, + "InputProcessingConfigurationUpdate":{ + "shape":"InputProcessingConfigurationUpdate", + "documentation":"

Describes updates for an input processing configuration.

" + }, + "KinesisStreamsInputUpdate":{ + "shape":"KinesisStreamsInputUpdate", + "documentation":"

If an Amazon Kinesis stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN) and IAM role ARN.

" + }, + "KinesisFirehoseInputUpdate":{ + "shape":"KinesisFirehoseInputUpdate", + "documentation":"

If an Amazon Kinesis Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN and IAM role ARN.

" + }, + "InputSchemaUpdate":{ + "shape":"InputSchemaUpdate", + "documentation":"

Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.

" + }, + "InputParallelismUpdate":{ + "shape":"InputParallelismUpdate", + "documentation":"

Describes the parallelism updates (the number in-application streams Amazon Kinesis Analytics creates for the specific streaming source).

" + } + }, + "documentation":"

Describes updates to a specific input configuration (identified by the InputId of an application).

" + }, + "InputUpdates":{ + "type":"list", + "member":{"shape":"InputUpdate"} + }, + "Inputs":{ + "type":"list", + "member":{"shape":"Input"} + }, + "InvalidApplicationConfigurationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

test

" + } + }, + "documentation":"

User-provided application configuration is not valid.

", + "exception":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Specified input parameter value is invalid.

", + "exception":true + }, + "JSONMappingParameters":{ + "type":"structure", + "required":["RecordRowPath"], + "members":{ + "RecordRowPath":{ + "shape":"RecordRowPath", + "documentation":"

Path to the top-level parent that contains the records.

" + } + }, + "documentation":"

Provides additional mapping information when JSON is the record format on the streaming source.

" + }, + "KinesisAnalyticsARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws:kinesisanalytics:[a-z]{2}-[a-z]+-\\d{1}+:\\d{12}+:application/[a-zA-Z0-9_.-]{1,128}" + }, + "KinesisFirehoseInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the input delivery stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.

" + } + }, + "documentation":"

Identifies an Amazon Kinesis Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

" + }, + "KinesisFirehoseInputDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics assumes to access the stream.

" + } + }, + "documentation":"

Describes the Amazon Kinesis Firehose delivery stream that is configured as the streaming source in the application input configuration.

" + }, + "KinesisFirehoseInputUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the input Amazon Kinesis Firehose delivery stream to read.

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When updating application input configuration, provides information about an Amazon Kinesis Firehose delivery stream as the streaming source.

" + }, + "KinesisFirehoseOutput":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the destination Amazon Kinesis Firehose delivery stream to write to.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.

" + }, + "KinesisFirehoseOutputDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" + } + }, + "documentation":"

For an application output, describes the Amazon Kinesis Firehose delivery stream configured as its destination.

" + }, + "KinesisFirehoseOutputUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis Firehose delivery stream to write to.

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis Firehose delivery stream configured as the destination.

" + }, + "KinesisStreamsInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the input Amazon Kinesis stream to read.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

Identifies an Amazon Kinesis stream as the streaming source. You provide the stream's Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

" + }, + "KinesisStreamsInputDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" + } + }, + "documentation":"

Describes the Amazon Kinesis stream that is configured as the streaming source in the application input configuration.

" + }, + "KinesisStreamsInputUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the input Amazon Kinesis stream to read.

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When updating application input configuration, provides information about an Amazon Kinesis stream as the streaming source.

" + }, + "KinesisStreamsOutput":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

ARN of the destination Amazon Kinesis stream to write to.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When configuring application output, identifies an Amazon Kinesis stream as the destination. You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.

" + }, + "KinesisStreamsOutputDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream.

" + } + }, + "documentation":"

For an application output, describes the Amazon Kinesis stream configured as its destination.

" + }, + "KinesisStreamsOutputUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the Amazon Kinesis stream where you want to write the output.

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When updating an output configuration using the UpdateApplication operation, provides information about an Amazon Kinesis stream configured as the destination.

" + }, + "LambdaOutput":{ + "type":"structure", + "required":[ + "ResourceARN", + "RoleARN" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the destination Lambda function to write to.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When configuring application output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.

" + }, + "LambdaOutputDescription":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the destination Lambda function.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function.

" + } + }, + "documentation":"

For an application output, describes the AWS Lambda function configured as its destination.

" + }, + "LambdaOutputUpdate":{ + "type":"structure", + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

Amazon Resource Name (ARN) of the destination Lambda function.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + }, + "RoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

" + } + }, + "documentation":"

When updating an output configuration using the UpdateApplication operation, provides information about an AWS Lambda function configured as the destination.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Exceeded the number of applications allowed.

", + "exception":true + }, + "ListApplicationsInputLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"ListApplicationsInputLimit", + "documentation":"

Maximum number of applications to list.

" + }, + "ExclusiveStartApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

" + } + }, + "documentation":"

" + }, + "ListApplicationsResponse":{ + "type":"structure", + "required":[ + "ApplicationSummaries", + "HasMoreApplications" + ], + "members":{ + "ApplicationSummaries":{ + "shape":"ApplicationSummaries", + "documentation":"

List of ApplicationSummary objects.

" + }, + "HasMoreApplications":{ + "shape":"BooleanObject", + "documentation":"

Returns true if there are more applications to retrieve.

" + } + }, + "documentation":"

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the application for which to retrieve tags.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value tags assigned to the application.

" + } + } + }, + "LogStreamARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "MappingParameters":{ + "type":"structure", + "members":{ + "JSONMappingParameters":{ + "shape":"JSONMappingParameters", + "documentation":"

Provides additional mapping information when JSON is the record format on the streaming source.

" + }, + "CSVMappingParameters":{ + "shape":"CSVMappingParameters", + "documentation":"

Provides additional mapping information when the record format uses delimiters (for example, CSV).

" + } + }, + "documentation":"

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

" + }, + "Output":{ + "type":"structure", + "required":[ + "Name", + "DestinationSchema" + ], + "members":{ + "Name":{ + "shape":"InAppStreamName", + "documentation":"

Name of the in-application stream.

" + }, + "KinesisStreamsOutput":{ + "shape":"KinesisStreamsOutput", + "documentation":"

Identifies an Amazon Kinesis stream as the destination.

" + }, + "KinesisFirehoseOutput":{ + "shape":"KinesisFirehoseOutput", + "documentation":"

Identifies an Amazon Kinesis Firehose delivery stream as the destination.

" + }, + "LambdaOutput":{ + "shape":"LambdaOutput", + "documentation":"

Identifies an AWS Lambda function as the destination.

" + }, + "DestinationSchema":{ + "shape":"DestinationSchema", + "documentation":"

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" + } + }, + "documentation":"

Describes application output configuration in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

For limits on how many destinations an application can write and other limitations, see Limits.

" + }, + "OutputDescription":{ + "type":"structure", + "members":{ + "OutputId":{ + "shape":"Id", + "documentation":"

A unique identifier for the output configuration.

" + }, + "Name":{ + "shape":"InAppStreamName", + "documentation":"

Name of the in-application stream configured as output.

" + }, + "KinesisStreamsOutputDescription":{ + "shape":"KinesisStreamsOutputDescription", + "documentation":"

Describes Amazon Kinesis stream configured as the destination where output is written.

" + }, + "KinesisFirehoseOutputDescription":{ + "shape":"KinesisFirehoseOutputDescription", + "documentation":"

Describes the Amazon Kinesis Firehose delivery stream configured as the destination where output is written.

" + }, + "LambdaOutputDescription":{ + "shape":"LambdaOutputDescription", + "documentation":"

Describes the AWS Lambda function configured as the destination where output is written.

" + }, + "DestinationSchema":{ + "shape":"DestinationSchema", + "documentation":"

Data format used for writing data to the destination.

" + } + }, + "documentation":"

Describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

" + }, + "OutputDescriptions":{ + "type":"list", + "member":{"shape":"OutputDescription"} + }, + "OutputUpdate":{ + "type":"structure", + "required":["OutputId"], + "members":{ + "OutputId":{ + "shape":"Id", + "documentation":"

Identifies the specific output configuration that you want to update.

" + }, + "NameUpdate":{ + "shape":"InAppStreamName", + "documentation":"

If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

" + }, + "KinesisStreamsOutputUpdate":{ + "shape":"KinesisStreamsOutputUpdate", + "documentation":"

Describes an Amazon Kinesis stream as the destination for the output.

" + }, + "KinesisFirehoseOutputUpdate":{ + "shape":"KinesisFirehoseOutputUpdate", + "documentation":"

Describes an Amazon Kinesis Firehose delivery stream as the destination for the output.

" + }, + "LambdaOutputUpdate":{ + "shape":"LambdaOutputUpdate", + "documentation":"

Describes an AWS Lambda function as the destination for the output.

" + }, + "DestinationSchemaUpdate":{ + "shape":"DestinationSchema", + "documentation":"

Describes the data format when records are written to the destination. For more information, see Configuring Application Output.

" + } + }, + "documentation":"

Describes updates to the output configuration identified by the OutputId.

" + }, + "OutputUpdates":{ + "type":"list", + "member":{"shape":"OutputUpdate"} + }, + "Outputs":{ + "type":"list", + "member":{"shape":"Output"} + }, + "ParsedInputRecord":{ + "type":"list", + "member":{"shape":"ParsedInputRecordField"} + }, + "ParsedInputRecordField":{"type":"string"}, + "ParsedInputRecords":{ + "type":"list", + "member":{"shape":"ParsedInputRecord"} + }, + "ProcessedInputRecord":{"type":"string"}, + "ProcessedInputRecords":{ + "type":"list", + "member":{"shape":"ProcessedInputRecord"} + }, + "RawInputRecord":{"type":"string"}, + "RawInputRecords":{ + "type":"list", + "member":{"shape":"RawInputRecord"} + }, + "RecordColumn":{ + "type":"structure", + "required":[ + "Name", + "SqlType" + ], + "members":{ + "Name":{ + "shape":"RecordColumnName", + "documentation":"

Name of the column created in the in-application input stream or reference table.

" + }, + "Mapping":{ + "shape":"RecordColumnMapping", + "documentation":"

Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON.

" + }, + "SqlType":{ + "shape":"RecordColumnSqlType", + "documentation":"

Type of column created in the in-application input stream or reference table.

" + } + }, + "documentation":"

Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

" + }, + "RecordColumnDelimiter":{ + "type":"string", + "min":1 + }, + "RecordColumnMapping":{"type":"string"}, + "RecordColumnName":{"type":"string"}, + "RecordColumnSqlType":{ + "type":"string", + "min":1 + }, + "RecordColumns":{ + "type":"list", + "member":{"shape":"RecordColumn"}, + "max":1000, + "min":1 + }, + "RecordEncoding":{ + "type":"string", + "pattern":"UTF-8" + }, + "RecordFormat":{ + "type":"structure", + "required":["RecordFormatType"], + "members":{ + "RecordFormatType":{ + "shape":"RecordFormatType", + "documentation":"

The type of record format.

" + }, + "MappingParameters":{ + "shape":"MappingParameters", + "documentation":"

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

" + } + }, + "documentation":"

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

" + }, + "RecordFormatType":{ + "type":"string", + "enum":[ + "JSON", + "CSV" + ] + }, + "RecordRowDelimiter":{ + "type":"string", + "min":1 + }, + "RecordRowPath":{ + "type":"string", + "min":1 + }, + "ReferenceDataSource":{ + "type":"structure", + "required":[ + "TableName", + "ReferenceSchema" + ], + "members":{ + "TableName":{ + "shape":"InAppTableName", + "documentation":"

Name of the in-application table to create.

" + }, + "S3ReferenceDataSource":{ + "shape":"S3ReferenceDataSource", + "documentation":"

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + }, + "ReferenceSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

" + }, + "ReferenceDataSourceDescription":{ + "type":"structure", + "required":[ + "ReferenceId", + "TableName", + "S3ReferenceDataSourceDescription" + ], + "members":{ + "ReferenceId":{ + "shape":"Id", + "documentation":"

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

" + }, + "TableName":{ + "shape":"InAppTableName", + "documentation":"

The in-application table name created by the specific reference data source configuration.

" + }, + "S3ReferenceDataSourceDescription":{ + "shape":"S3ReferenceDataSourceDescription", + "documentation":"

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

" + }, + "ReferenceSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

Describes the reference data source configured for an application.

" + }, + "ReferenceDataSourceDescriptions":{ + "type":"list", + "member":{"shape":"ReferenceDataSourceDescription"} + }, + "ReferenceDataSourceUpdate":{ + "type":"structure", + "required":["ReferenceId"], + "members":{ + "ReferenceId":{ + "shape":"Id", + "documentation":"

ID of the reference data source being updated. You can use the DescribeApplication operation to get this value.

" + }, + "TableNameUpdate":{ + "shape":"InAppTableName", + "documentation":"

In-application table name that is created by this update.

" + }, + "S3ReferenceDataSourceUpdate":{ + "shape":"S3ReferenceDataSourceUpdate", + "documentation":"

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" + }, + "ReferenceSchemaUpdate":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

When you update a reference data source configuration for an application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

" + }, + "ReferenceDataSourceUpdates":{ + "type":"list", + "member":{"shape":"ReferenceDataSourceUpdate"} + }, + "ResourceARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Application is not available for this operation.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

" + } + }, + "documentation":"

Specified application can't be found.

", + "exception":true + }, + "ResourceProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

", + "exception":true + }, + "RoleARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "S3Configuration":{ + "type":"structure", + "required":[ + "RoleARN", + "BucketARN", + "FileKey" + ], + "members":{ + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

IAM ARN of the role used to access the data.

" + }, + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

ARN of the S3 bucket that contains the data.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

The name of the object that contains the data.

" + } + }, + "documentation":"

Provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket, the ARN of the IAM role that is used to access the bucket, and the name of the Amazon S3 object that contains the data.

" + }, + "S3ReferenceDataSource":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey", + "ReferenceRoleARN" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

Object key name containing reference data.

" + }, + "ReferenceRoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

" + } + }, + "documentation":"

Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + }, + "S3ReferenceDataSourceDescription":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey", + "ReferenceRoleARN" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

Amazon S3 object key name.

" + }, + "ReferenceRoleARN":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

" + } + }, + "documentation":"

Provides the bucket name and object key name that stores the reference data.

" + }, + "S3ReferenceDataSourceUpdate":{ + "type":"structure", + "members":{ + "BucketARNUpdate":{ + "shape":"BucketARN", + "documentation":"

Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKeyUpdate":{ + "shape":"FileKey", + "documentation":"

Object key name.

" + }, + "ReferenceRoleARNUpdate":{ + "shape":"RoleARN", + "documentation":"

ARN of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application.

" + } + }, + "documentation":"

Describes the S3 bucket name, object key name, and IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service is unavailable. Back off and retry the operation.

", + "exception":true, + "fault":true + }, + "SourceSchema":{ + "type":"structure", + "required":[ + "RecordFormat", + "RecordColumns" + ], + "members":{ + "RecordFormat":{ + "shape":"RecordFormat", + "documentation":"

Specifies the format of the records on the streaming source.

" + }, + "RecordEncoding":{ + "shape":"RecordEncoding", + "documentation":"

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" + }, + "RecordColumns":{ + "shape":"RecordColumns", + "documentation":"

A list of RecordColumn objects.

" + } + }, + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + }, + "StartApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "InputConfigurations" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the application.

" + }, + "InputConfigurations":{ + "shape":"InputConfigurations", + "documentation":"

Identifies the specific input, by ID, that the application starts consuming. Amazon Kinesis Analytics starts reading the streaming source associated with the input. You can also specify where in the streaming source you want Amazon Kinesis Analytics to start reading.

" + } + }, + "documentation":"

" + }, + "StartApplicationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "StopApplicationRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the running application to stop.

" + } + }, + "documentation":"

" + }, + "StopApplicationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

" + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the key-value tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the key-value tag. The value is optional.

" + } + }, + "documentation":"

A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the application to assign the tags.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value tags to assign to the application.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

", + "exception":true + }, + "UnableToDetectSchemaException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "RawInputRecords":{"shape":"RawInputRecords"}, + "ProcessedInputRecords":{"shape":"ProcessedInputRecords"} + }, + "documentation":"

Data format is not valid. Amazon Kinesis Analytics is not able to detect schema for the given streaming source.

", + "exception":true + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the Kinesis Analytics application from which to remove the tags.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of keys of tags to remove from the specified application.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "ApplicationUpdate" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

Name of the Amazon Kinesis Analytics application to update.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version ID. You can use the DescribeApplication operation to get this value.

" + }, + "ApplicationUpdate":{ + "shape":"ApplicationUpdate", + "documentation":"

Describes application updates.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"Amazon Kinesis Analytics

Overview

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

This is the Amazon Kinesis Analytics v1 API Reference. The Amazon Kinesis Analytics Developer Guide provides additional information.

" +} diff --git a/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/paginators-1.json b/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/paginators-1.json new file mode 100644 index 00000000..70052cd3 --- /dev/null +++ b/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListApplicationSnapshots": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "SnapshotSummaries" + }, + "ListApplications": { + "input_token": "NextToken", + "limit_key": "Limit", + "output_token": "NextToken", + "result_key": "ApplicationSummaries" + } + } +} diff --git a/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json b/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json new file mode 100644 index 00000000..eaecff58 --- /dev/null +++ b/aws/dist/botocore/data/kinesisanalyticsv2/2018-05-23/service-2.json @@ -0,0 +1,3312 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-23", + "endpointPrefix":"kinesisanalytics", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Kinesis Analytics V2", + "serviceFullName":"Amazon Kinesis Analytics", + "serviceId":"Kinesis Analytics V2", + "signatureVersion":"v4", + "signingName":"kinesisanalytics", + "targetPrefix":"KinesisAnalytics_20180523", + "uid":"kinesisanalyticsv2-2018-05-23" + }, + "operations":{ + "AddApplicationCloudWatchLoggingOption":{ + "name":"AddApplicationCloudWatchLoggingOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationCloudWatchLoggingOptionRequest"}, + "output":{"shape":"AddApplicationCloudWatchLoggingOptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidApplicationConfigurationException"} + ], + "documentation":"

Adds an Amazon CloudWatch log stream to monitor application configuration errors.

" + }, + "AddApplicationInput":{ + "name":"AddApplicationInput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationInputRequest"}, + "output":{"shape":"AddApplicationInputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"CodeValidationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds a streaming source to your SQL-based Amazon Kinesis Data Analytics application.

You can add a streaming source when you create an application, or you can use this operation to add a streaming source after you create an application. For more information, see CreateApplication.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

" + }, + "AddApplicationInputProcessingConfiguration":{ + "name":"AddApplicationInputProcessingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationInputProcessingConfigurationRequest"}, + "output":{"shape":"AddApplicationInputProcessingConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds an InputProcessingConfiguration to an SQL-based Kinesis Data Analytics application. An input processor pre-processes records on the input stream before the application's SQL code executes. Currently, the only input processor available is AWS Lambda.

" + }, + "AddApplicationOutput":{ + "name":"AddApplicationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationOutputRequest"}, + "output":{"shape":"AddApplicationOutputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.

You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors.

Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication operation to find the current application version.

" + }, + "AddApplicationReferenceDataSource":{ + "name":"AddApplicationReferenceDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddApplicationReferenceDataSourceRequest"}, + "output":{"shape":"AddApplicationReferenceDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Adds a reference data source to an existing SQL-based Amazon Kinesis Data Analytics application.

Kinesis Data Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in an Amazon S3 object maps to columns in the resulting in-application table.

" + }, + "CreateApplication":{ + "name":"CreateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationRequest"}, + "output":{"shape":"CreateApplicationResponse"}, + "errors":[ + {"shape":"CodeValidationException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidRequestException"}, + {"shape":"TooManyTagsException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Creates an Amazon Kinesis Data Analytics application. For information about creating a Kinesis Data Analytics application, see Creating an Application.

" + }, + "CreateApplicationSnapshot":{ + "name":"CreateApplicationSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateApplicationSnapshotRequest"}, + "output":{"shape":"CreateApplicationSnapshotResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Creates a snapshot of the application's state data.

" + }, + "DeleteApplication":{ + "name":"DeleteApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationRequest"}, + "output":{"shape":"DeleteApplicationResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidApplicationConfigurationException"} + ], + "documentation":"

Deletes the specified application. Kinesis Data Analytics halts application execution and deletes the application.

" + }, + "DeleteApplicationCloudWatchLoggingOption":{ + "name":"DeleteApplicationCloudWatchLoggingOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationCloudWatchLoggingOptionRequest"}, + "output":{"shape":"DeleteApplicationCloudWatchLoggingOptionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidApplicationConfigurationException"} + ], + "documentation":"

Deletes an Amazon CloudWatch log stream from an Amazon Kinesis Data Analytics application.

" + }, + "DeleteApplicationInputProcessingConfiguration":{ + "name":"DeleteApplicationInputProcessingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationInputProcessingConfigurationRequest"}, + "output":{"shape":"DeleteApplicationInputProcessingConfigurationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes an InputProcessingConfiguration from an input.

" + }, + "DeleteApplicationOutput":{ + "name":"DeleteApplicationOutput", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationOutputRequest"}, + "output":{"shape":"DeleteApplicationOutputResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes the output destination configuration from your SQL-based Amazon Kinesis Data Analytics application's configuration. Kinesis Data Analytics will no longer write data from the corresponding in-application stream to the external output destination.

" + }, + "DeleteApplicationReferenceDataSource":{ + "name":"DeleteApplicationReferenceDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationReferenceDataSourceRequest"}, + "output":{"shape":"DeleteApplicationReferenceDataSourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Deletes a reference data source configuration from the specified SQL-based Amazon Kinesis Data Analytics application's configuration.

If the application is running, Kinesis Data Analytics immediately removes the in-application table that you created using the AddApplicationReferenceDataSource operation.

" + }, + "DeleteApplicationSnapshot":{ + "name":"DeleteApplicationSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteApplicationSnapshotRequest"}, + "output":{"shape":"DeleteApplicationSnapshotResponse"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a snapshot of application state.

" + }, + "DescribeApplication":{ + "name":"DescribeApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationRequest"}, + "output":{"shape":"DescribeApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns information about a specific Amazon Kinesis Data Analytics application.

If you want to retrieve a list of all applications in your account, use the ListApplications operation.

" + }, + "DescribeApplicationSnapshot":{ + "name":"DescribeApplicationSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationSnapshotRequest"}, + "output":{"shape":"DescribeApplicationSnapshotResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Returns information about a snapshot of application state data.

" + }, + "DiscoverInputSchema":{ + "name":"DiscoverInputSchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DiscoverInputSchemaRequest"}, + "output":{"shape":"DiscoverInputSchemaResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"UnableToDetectSchemaException"}, + {"shape":"ResourceProvisionedThroughputExceededException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Infers a schema for an SQL-based Amazon Kinesis Data Analytics application by evaluating sample records on the specified streaming source (Kinesis data stream or Kinesis Data Firehose delivery stream) or Amazon S3 object. In the response, the operation returns the inferred schema and also the sample records that the operation used to infer the schema.

You can use the inferred schema when configuring a streaming source for your application. When you create an application using the Kinesis Data Analytics console, the console uses this operation to infer a schema and show it in the console user interface.

" + }, + "ListApplicationSnapshots":{ + "name":"ListApplicationSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationSnapshotsRequest"}, + "output":{"shape":"ListApplicationSnapshotsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Lists information about the current application snapshots.

" + }, + "ListApplications":{ + "name":"ListApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListApplicationsRequest"}, + "output":{"shape":"ListApplicationsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"} + ], + "documentation":"

Returns a list of Amazon Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.

If you want detailed information about a specific application, use DescribeApplication.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Retrieves the list of key-value tags assigned to the application.

" + }, + "StartApplication":{ + "name":"StartApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartApplicationRequest"}, + "output":{"shape":"StartApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidApplicationConfigurationException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Starts the specified Amazon Kinesis Data Analytics application. After creating an application, you must exclusively call this operation to start your application.

" + }, + "StopApplication":{ + "name":"StopApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopApplicationRequest"}, + "output":{"shape":"StopApplicationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidApplicationConfigurationException"} + ], + "documentation":"

Stops the application from processing data. You can stop an application only if it is in the running state. You can use the DescribeApplication operation to find the application state.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Adds one or more key-value tags to a Kinesis Analytics application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TooManyTagsException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Removes one or more tags from a Kinesis Analytics application.

" + }, + "UpdateApplication":{ + "name":"UpdateApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateApplicationRequest"}, + "output":{"shape":"UpdateApplicationResponse"}, + "errors":[ + {"shape":"CodeValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidApplicationConfigurationException"} + ], + "documentation":"

Updates an existing Amazon Kinesis Data Analytics application. Using this operation, you can update application code, input configuration, and output configuration.

Kinesis Data Analytics updates the ApplicationVersionId each time you update your application.

" + } + }, + "shapes":{ + "AddApplicationCloudWatchLoggingOptionRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOption" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The Kinesis Data Analytics application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the Kinesis Data Analytics application. You can retrieve the application version ID using DescribeApplication.

" + }, + "CloudWatchLoggingOption":{ + "shape":"CloudWatchLoggingOption", + "documentation":"

Provides the Amazon CloudWatch log stream Amazon Resource Name (ARN).

" + } + } + }, + "AddApplicationCloudWatchLoggingOptionResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application's ARN.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The new version ID of the Kinesis Data Analytics application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "shape":"CloudWatchLoggingOptionDescriptions", + "documentation":"

The descriptions of the current CloudWatch logging options for the Kinesis Data Analytics application.

" + } + } + }, + "AddApplicationInputProcessingConfigurationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId", + "InputProcessingConfiguration" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to which you want to add the input processing configuration.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version of the application to which you want to add the input processing configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "InputId":{ + "shape":"Id", + "documentation":"

The ID of the input configuration to add the input processing configuration to. You can get a list of the input IDs for an application using the DescribeApplication operation.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration to add to the application.

" + } + } + }, + "AddApplicationInputProcessingConfigurationResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Provides the current application version.

" + }, + "InputId":{ + "shape":"Id", + "documentation":"

The input ID that is associated with the application input. This is the ID that Amazon Kinesis Data Analytics assigns to each input configuration that you add to your application.

" + }, + "InputProcessingConfigurationDescription":{ + "shape":"InputProcessingConfigurationDescription", + "documentation":"

The description of the preprocessor that executes on records in this input before the application's code is run.

" + } + } + }, + "AddApplicationInputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "Input" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of your existing application to which you want to add the streaming source.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current version of your application. You can use the DescribeApplication operation to find the current application version.

" + }, + "Input":{ + "shape":"Input", + "documentation":"

The Input to add.

" + } + } + }, + "AddApplicationInputResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Provides the current application version.

" + }, + "InputDescriptions":{ + "shape":"InputDescriptions", + "documentation":"

Describes the application input configuration.

" + } + } + }, + "AddApplicationOutputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "Output" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to which you want to add the output configuration.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version of the application to which you want to add the output configuration. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "Output":{ + "shape":"Output", + "documentation":"

An array of objects, each describing one output configuration. In the output configuration, you specify the name of an in-application stream, a destination (that is, a Kinesis data stream, a Kinesis Data Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

" + } + } + }, + "AddApplicationOutputResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application Amazon Resource Name (ARN).

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The updated application version ID. Kinesis Data Analytics increments this ID when the application is updated.

" + }, + "OutputDescriptions":{ + "shape":"OutputDescriptions", + "documentation":"

Describes the application output configuration. For more information, see Configuring Application Output.

" + } + } + }, + "AddApplicationReferenceDataSourceRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceDataSource" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version of the application for which you are adding the reference data source. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "ReferenceDataSource":{ + "shape":"ReferenceDataSource", + "documentation":"

The reference data source can be an object in your Amazon S3 bucket. Kinesis Data Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created.

" + } + } + }, + "AddApplicationReferenceDataSourceResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application Amazon Resource Name (ARN).

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The updated application version ID. Amazon Kinesis Data Analytics increments this ID when the application is updated.

" + }, + "ReferenceDataSourceDescriptions":{ + "shape":"ReferenceDataSourceDescriptions", + "documentation":"

Describes reference data sources configured for the application.

" + } + } + }, + "ApplicationCodeConfiguration":{ + "type":"structure", + "required":["CodeContentType"], + "members":{ + "CodeContent":{ + "shape":"CodeContent", + "documentation":"

The location and type of the application code.

" + }, + "CodeContentType":{ + "shape":"CodeContentType", + "documentation":"

Specifies whether the code content is in text or zip format.

" + } + }, + "documentation":"

Describes code configuration for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationCodeConfigurationDescription":{ + "type":"structure", + "required":["CodeContentType"], + "members":{ + "CodeContentType":{ + "shape":"CodeContentType", + "documentation":"

Specifies whether the code content is in text or zip format.

" + }, + "CodeContentDescription":{ + "shape":"CodeContentDescription", + "documentation":"

Describes details about the location and format of the application code.

" + } + }, + "documentation":"

Describes code configuration for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationCodeConfigurationUpdate":{ + "type":"structure", + "members":{ + "CodeContentTypeUpdate":{ + "shape":"CodeContentType", + "documentation":"

Describes updates to the code content type.

" + }, + "CodeContentUpdate":{ + "shape":"CodeContentUpdate", + "documentation":"

Describes updates to the code content of an application.

" + } + }, + "documentation":"

Describes updates to a Java-based Amazon Kinesis Data Analytics application.

" + }, + "ApplicationConfiguration":{ + "type":"structure", + "required":["ApplicationCodeConfiguration"], + "members":{ + "SqlApplicationConfiguration":{ + "shape":"SqlApplicationConfiguration", + "documentation":"

The creation and update parameters for an SQL-based Kinesis Data Analytics application.

" + }, + "FlinkApplicationConfiguration":{ + "shape":"FlinkApplicationConfiguration", + "documentation":"

The creation and update parameters for a Java-based Kinesis Data Analytics application.

" + }, + "EnvironmentProperties":{ + "shape":"EnvironmentProperties", + "documentation":"

Describes execution properties for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationCodeConfiguration":{ + "shape":"ApplicationCodeConfiguration", + "documentation":"

The code location and type parameters for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationSnapshotConfiguration":{ + "shape":"ApplicationSnapshotConfiguration", + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Specifies the creation parameters for an Amazon Kinesis Data Analytics application.

" + }, + "ApplicationConfigurationDescription":{ + "type":"structure", + "members":{ + "SqlApplicationConfigurationDescription":{ + "shape":"SqlApplicationConfigurationDescription", + "documentation":"

The details about inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application.

" + }, + "ApplicationCodeConfigurationDescription":{ + "shape":"ApplicationCodeConfigurationDescription", + "documentation":"

The details about the application code for a Java-based Kinesis Data Analytics application.

" + }, + "RunConfigurationDescription":{ + "shape":"RunConfigurationDescription", + "documentation":"

The details about the starting properties for a Kinesis Data Analytics application.

" + }, + "FlinkApplicationConfigurationDescription":{ + "shape":"FlinkApplicationConfigurationDescription", + "documentation":"

The details about a Java-based Kinesis Data Analytics application.

" + }, + "EnvironmentPropertyDescriptions":{ + "shape":"EnvironmentPropertyDescriptions", + "documentation":"

Describes execution properties for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationSnapshotConfigurationDescription":{ + "shape":"ApplicationSnapshotConfigurationDescription", + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Describes details about the application code and starting parameters for an Amazon Kinesis Data Analytics application.

" + }, + "ApplicationConfigurationUpdate":{ + "type":"structure", + "members":{ + "SqlApplicationConfigurationUpdate":{ + "shape":"SqlApplicationConfigurationUpdate", + "documentation":"

Describes updates to an SQL-based Kinesis Data Analytics application's configuration.

" + }, + "ApplicationCodeConfigurationUpdate":{ + "shape":"ApplicationCodeConfigurationUpdate", + "documentation":"

Describes updates to a Java-based Kinesis Data Analytics application's code configuration.

" + }, + "FlinkApplicationConfigurationUpdate":{ + "shape":"FlinkApplicationConfigurationUpdate", + "documentation":"

Describes updates to a Java-based Kinesis Data Analytics application's configuration.

" + }, + "EnvironmentPropertyUpdates":{ + "shape":"EnvironmentPropertyUpdates", + "documentation":"

Describes updates to the environment properties for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationSnapshotConfigurationUpdate":{ + "shape":"ApplicationSnapshotConfigurationUpdate", + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Describes updates to an application's configuration.

" + }, + "ApplicationDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ApplicationDetail":{ + "type":"structure", + "required":[ + "ApplicationARN", + "ApplicationName", + "RuntimeEnvironment", + "ApplicationStatus", + "ApplicationVersionId" + ], + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the application.

" + }, + "ApplicationDescription":{ + "shape":"ApplicationDescription", + "documentation":"

The description of the application.

" + }, + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "RuntimeEnvironment":{ + "shape":"RuntimeEnvironment", + "documentation":"

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

" + }, + "ServiceExecutionRole":{ + "shape":"RoleARN", + "documentation":"

Specifies the IAM role that the application uses to access external resources.

" + }, + "ApplicationStatus":{ + "shape":"ApplicationStatus", + "documentation":"

The status of the application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The current timestamp when the application was created.

" + }, + "LastUpdateTimestamp":{ + "shape":"Timestamp", + "documentation":"

The current timestamp when the application was last updated.

" + }, + "ApplicationConfigurationDescription":{ + "shape":"ApplicationConfigurationDescription", + "documentation":"

Provides details about the application's SQL or Java code and starting parameters.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "shape":"CloudWatchLoggingOptionDescriptions", + "documentation":"

Describes the application Amazon CloudWatch logging options.

" + } + }, + "documentation":"

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

" + }, + "ApplicationName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "ApplicationRestoreConfiguration":{ + "type":"structure", + "required":["ApplicationRestoreType"], + "members":{ + "ApplicationRestoreType":{ + "shape":"ApplicationRestoreType", + "documentation":"

Specifies how the application should be restored.

" + }, + "SnapshotName":{ + "shape":"SnapshotName", + "documentation":"

The identifier of an existing snapshot of application state to use to restart an application. The application uses this value if RESTORE_FROM_CUSTOM_SNAPSHOT is specified for the ApplicationRestoreType.

" + } + }, + "documentation":"

Specifies the method and snapshot to use when restarting an application using previously saved application state.

" + }, + "ApplicationRestoreType":{ + "type":"string", + "enum":[ + "SKIP_RESTORE_FROM_SNAPSHOT", + "RESTORE_FROM_LATEST_SNAPSHOT", + "RESTORE_FROM_CUSTOM_SNAPSHOT" + ] + }, + "ApplicationSnapshotConfiguration":{ + "type":"structure", + "required":["SnapshotsEnabled"], + "members":{ + "SnapshotsEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationSnapshotConfigurationDescription":{ + "type":"structure", + "required":["SnapshotsEnabled"], + "members":{ + "SnapshotsEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Describes whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationSnapshotConfigurationUpdate":{ + "type":"structure", + "required":["SnapshotsEnabledUpdate"], + "members":{ + "SnapshotsEnabledUpdate":{ + "shape":"BooleanObject", + "documentation":"

Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + } + }, + "documentation":"

Describes updates to whether snapshots are enabled for a Java-based Kinesis Data Analytics application.

" + }, + "ApplicationStatus":{ + "type":"string", + "enum":[ + "DELETING", + "STARTING", + "STOPPING", + "READY", + "RUNNING", + "UPDATING" + ] + }, + "ApplicationSummaries":{ + "type":"list", + "member":{"shape":"ApplicationSummary"} + }, + "ApplicationSummary":{ + "type":"structure", + "required":[ + "ApplicationName", + "ApplicationARN", + "ApplicationStatus", + "ApplicationVersionId", + "RuntimeEnvironment" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the application.

" + }, + "ApplicationStatus":{ + "shape":"ApplicationStatus", + "documentation":"

The status of the application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

Provides the current application version.

" + }, + "RuntimeEnvironment":{ + "shape":"RuntimeEnvironment", + "documentation":"

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

" + } + }, + "documentation":"

Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.

" + }, + "ApplicationVersionId":{ + "type":"long", + "max":999999999, + "min":1 + }, + "BooleanObject":{"type":"boolean"}, + "BucketARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "CSVMappingParameters":{ + "type":"structure", + "required":[ + "RecordRowDelimiter", + "RecordColumnDelimiter" + ], + "members":{ + "RecordRowDelimiter":{ + "shape":"RecordRowDelimiter", + "documentation":"

The row delimiter. For example, in a CSV format, '\\n' is the typical row delimiter.

" + }, + "RecordColumnDelimiter":{ + "shape":"RecordColumnDelimiter", + "documentation":"

The column delimiter. For example, in a CSV format, a comma (\",\") is the typical column delimiter.

" + } + }, + "documentation":"

For an SQL-based application, provides additional mapping information when the record format uses delimiters, such as CSV. For example, the following sample records use CSV format, where the records use the '\\n' as the row delimiter and a comma (\",\") as the column delimiter:

\"name1\", \"address1\"

\"name2\", \"address2\"

" + }, + "CheckpointConfiguration":{ + "type":"structure", + "required":["ConfigurationType"], + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether the application uses Amazon Kinesis Data Analytics' default checkpointing behavior.

" + }, + "CheckpointingEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.

" + }, + "CheckpointInterval":{ + "shape":"CheckpointInterval", + "documentation":"

Describes the interval in milliseconds between checkpoint operations.

" + }, + "MinPauseBetweenCheckpoints":{ + "shape":"MinPauseBetweenCheckpoints", + "documentation":"

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start. If a checkpoint operation takes longer than the CheckpointInterval, the application otherwise performs continual checkpoint operations. For more information, see Tuning Checkpointing in the Apache Flink Documentation.

" + } + }, + "documentation":"

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

" + }, + "CheckpointConfigurationDescription":{ + "type":"structure", + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether the application uses the default checkpointing behavior in Kinesis Data Analytics.

" + }, + "CheckpointingEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether checkpointing is enabled for a Java-based Kinesis Data Analytics application.

" + }, + "CheckpointInterval":{ + "shape":"CheckpointInterval", + "documentation":"

Describes the interval in milliseconds between checkpoint operations.

" + }, + "MinPauseBetweenCheckpoints":{ + "shape":"MinPauseBetweenCheckpoints", + "documentation":"

Describes the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

" + } + }, + "documentation":"

Describes checkpointing parameters for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "CheckpointConfigurationUpdate":{ + "type":"structure", + "members":{ + "ConfigurationTypeUpdate":{ + "shape":"ConfigurationType", + "documentation":"

Describes updates to whether the application uses the default checkpointing behavior of Kinesis Data Analytics.

" + }, + "CheckpointingEnabledUpdate":{ + "shape":"BooleanObject", + "documentation":"

Describes updates to whether checkpointing is enabled for an application.

" + }, + "CheckpointIntervalUpdate":{ + "shape":"CheckpointInterval", + "documentation":"

Describes updates to the interval in milliseconds between checkpoint operations.

" + }, + "MinPauseBetweenCheckpointsUpdate":{ + "shape":"MinPauseBetweenCheckpoints", + "documentation":"

Describes updates to the minimum time in milliseconds after a checkpoint operation completes that a new checkpoint operation can start.

" + } + }, + "documentation":"

Describes updates to the checkpointing parameters for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "CheckpointInterval":{ + "type":"long", + "min":0 + }, + "CloudWatchLoggingOption":{ + "type":"structure", + "required":["LogStreamARN"], + "members":{ + "LogStreamARN":{ + "shape":"LogStreamARN", + "documentation":"

The ARN of the CloudWatch log to receive application messages.

" + } + }, + "documentation":"

Provides a description of Amazon CloudWatch logging options, including the log stream Amazon Resource Name (ARN).

" + }, + "CloudWatchLoggingOptionDescription":{ + "type":"structure", + "required":["LogStreamARN"], + "members":{ + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

The ID of the CloudWatch logging option description.

" + }, + "LogStreamARN":{ + "shape":"LogStreamARN", + "documentation":"

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The IAM ARN of the role to use to send application messages.

Provided for backward compatibility. Applications created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

Describes the Amazon CloudWatch logging option.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOptionDescription"} + }, + "CloudWatchLoggingOptionUpdate":{ + "type":"structure", + "required":["CloudWatchLoggingOptionId"], + "members":{ + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

The ID of the CloudWatch logging option to update

" + }, + "LogStreamARNUpdate":{ + "shape":"LogStreamARN", + "documentation":"

The Amazon Resource Name (ARN) of the CloudWatch log to receive application messages.

" + } + }, + "documentation":"

Describes the Amazon CloudWatch logging option updates.

" + }, + "CloudWatchLoggingOptionUpdates":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOptionUpdate"} + }, + "CloudWatchLoggingOptions":{ + "type":"list", + "member":{"shape":"CloudWatchLoggingOption"} + }, + "CodeContent":{ + "type":"structure", + "members":{ + "TextContent":{ + "shape":"TextContent", + "documentation":"

The text-format code for a Java-based Kinesis Data Analytics application.

" + }, + "ZipFileContent":{ + "shape":"ZipFileContent", + "documentation":"

The zip-format code for a Java-based Kinesis Data Analytics application.

" + }, + "S3ContentLocation":{ + "shape":"S3ContentLocation", + "documentation":"

Information about the Amazon S3 bucket containing the application code.

" + } + }, + "documentation":"

Specifies either the application code, or the location of the application code, for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "CodeContentDescription":{ + "type":"structure", + "members":{ + "TextContent":{ + "shape":"TextContent", + "documentation":"

The text-format code

" + }, + "CodeMD5":{ + "shape":"CodeMD5", + "documentation":"

The checksum that can be used to validate zip-format code.

" + }, + "CodeSize":{ + "shape":"CodeSize", + "documentation":"

The size in bytes of the application code. Can be used to validate zip-format code.

" + }, + "S3ApplicationCodeLocationDescription":{ + "shape":"S3ApplicationCodeLocationDescription", + "documentation":"

The S3 bucket Amazon Resource Name (ARN), file key, and object version of the application code stored in Amazon S3.

" + } + }, + "documentation":"

Describes details about the application code for a Java-based Kinesis Data Analytics application.

" + }, + "CodeContentType":{ + "type":"string", + "enum":[ + "PLAINTEXT", + "ZIPFILE" + ] + }, + "CodeContentUpdate":{ + "type":"structure", + "members":{ + "TextContentUpdate":{ + "shape":"TextContent", + "documentation":"

Describes an update to the text code for an application.

" + }, + "ZipFileContentUpdate":{ + "shape":"ZipFileContent", + "documentation":"

Describes an update to the zipped code for an application.

" + }, + "S3ContentLocationUpdate":{ + "shape":"S3ContentLocationUpdate", + "documentation":"

Describes an update to the location of code for an application.

" + } + }, + "documentation":"

Describes an update to the code of a Java-based Kinesis Data Analytics application.

" + }, + "CodeMD5":{ + "type":"string", + "max":128, + "min":128 + }, + "CodeSize":{ + "type":"long", + "max":52428800, + "min":0 + }, + "CodeValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The user-provided application code (query) is not valid. This can be a simple syntax error.

", + "exception":true + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

", + "exception":true + }, + "ConfigurationType":{ + "type":"string", + "enum":[ + "DEFAULT", + "CUSTOM" + ] + }, + "CreateApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "RuntimeEnvironment", + "ServiceExecutionRole" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of your application (for example, sample-app).

" + }, + "ApplicationDescription":{ + "shape":"ApplicationDescription", + "documentation":"

A summary description of the application.

" + }, + "RuntimeEnvironment":{ + "shape":"RuntimeEnvironment", + "documentation":"

The runtime environment for the application (SQL-1.0 or FLINK-1_6).

" + }, + "ServiceExecutionRole":{ + "shape":"RoleARN", + "documentation":"

The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

" + }, + "ApplicationConfiguration":{ + "shape":"ApplicationConfiguration", + "documentation":"

Use this parameter to configure the application.

" + }, + "CloudWatchLoggingOptions":{ + "shape":"CloudWatchLoggingOptions", + "documentation":"

Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management Guide.

" + } + } + }, + "CreateApplicationResponse":{ + "type":"structure", + "required":["ApplicationDetail"], + "members":{ + "ApplicationDetail":{ + "shape":"ApplicationDetail", + "documentation":"

In response to your CreateApplication request, Kinesis Data Analytics returns a response with details of the application it created.

" + } + } + }, + "CreateApplicationSnapshotRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "SnapshotName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application

" + }, + "SnapshotName":{ + "shape":"SnapshotName", + "documentation":"

An identifier for the application snapshot.

" + } + } + }, + "CreateApplicationSnapshotResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationCloudWatchLoggingOptionRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "CloudWatchLoggingOptionId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the application. You can retrieve the application version ID using DescribeApplication.

" + }, + "CloudWatchLoggingOptionId":{ + "shape":"Id", + "documentation":"

The CloudWatchLoggingOptionId of the Amazon CloudWatch logging option to delete. You can get the CloudWatchLoggingOptionId by using the DescribeApplication operation.

" + } + } + }, + "DeleteApplicationCloudWatchLoggingOptionResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application's Amazon Resource Name (ARN).

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The version ID of the application. Kinesis Data Analytics updates the ApplicationVersionId each time you change the CloudWatch logging options.

" + }, + "CloudWatchLoggingOptionDescriptions":{ + "shape":"CloudWatchLoggingOptionDescriptions", + "documentation":"

The descriptions of the remaining CloudWatch logging options for the application.

" + } + } + }, + "DeleteApplicationInputProcessingConfigurationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "InputId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "InputId":{ + "shape":"Id", + "documentation":"

The ID of the input configuration from which to delete the input processing configuration. You can get a list of the input IDs for an application by using the DescribeApplication operation.

" + } + } + }, + "DeleteApplicationInputProcessingConfigurationResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the application.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version ID.

" + } + } + }, + "DeleteApplicationOutputRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "OutputId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The application name.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "OutputId":{ + "shape":"Id", + "documentation":"

The ID of the configuration to delete. Each output configuration that is added to the application (either when the application is created or later) using the AddApplicationOutput operation has a unique ID. You need to provide the ID to uniquely identify the output configuration that you want to delete from the application configuration. You can use the DescribeApplication operation to get the specific OutputId.

" + } + } + }, + "DeleteApplicationOutputResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application Amazon Resource Name (ARN).

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version ID.

" + } + } + }, + "DeleteApplicationReferenceDataSourceRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId", + "ReferenceId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version. You can use the DescribeApplication operation to get the current application version. If the version specified is not the current version, the ConcurrentModificationException is returned.

" + }, + "ReferenceId":{ + "shape":"Id", + "documentation":"

The ID of the reference data source. When you add a reference data source to your application using the AddApplicationReferenceDataSource, Kinesis Data Analytics assigns an ID. You can use the DescribeApplication operation to get the reference ID.

" + } + } + }, + "DeleteApplicationReferenceDataSourceResponse":{ + "type":"structure", + "members":{ + "ApplicationARN":{ + "shape":"ResourceARN", + "documentation":"

The application Amazon Resource Name (ARN).

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The updated version ID of the application.

" + } + } + }, + "DeleteApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CreateTimestamp" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to delete.

" + }, + "CreateTimestamp":{ + "shape":"Timestamp", + "documentation":"

Use the DescribeApplication operation to get this value.

" + } + } + }, + "DeleteApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteApplicationSnapshotRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "SnapshotName", + "SnapshotCreationTimestamp" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application.

" + }, + "SnapshotName":{ + "shape":"SnapshotName", + "documentation":"

The identifier for the snapshot delete.

" + }, + "SnapshotCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The creation timestamp of the application snapshot to delete. You can retrieve this value using or .

" + } + } + }, + "DeleteApplicationSnapshotResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeApplicationRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "IncludeAdditionalDetails":{ + "shape":"BooleanObject", + "documentation":"

Displays verbose information about a Kinesis Data Analytics application, including the application's job plan.

" + } + } + }, + "DescribeApplicationResponse":{ + "type":"structure", + "required":["ApplicationDetail"], + "members":{ + "ApplicationDetail":{ + "shape":"ApplicationDetail", + "documentation":"

Provides a description of the application, such as the application's Amazon Resource Name (ARN), status, and latest version.

" + } + } + }, + "DescribeApplicationSnapshotRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "SnapshotName" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application.

" + }, + "SnapshotName":{ + "shape":"SnapshotName", + "documentation":"

The identifier of an application snapshot. You can retrieve this value using .

" + } + } + }, + "DescribeApplicationSnapshotResponse":{ + "type":"structure", + "required":["SnapshotDetails"], + "members":{ + "SnapshotDetails":{ + "shape":"SnapshotDetails", + "documentation":"

An object containing information about the application snapshot.

" + } + } + }, + "DestinationSchema":{ + "type":"structure", + "required":["RecordFormatType"], + "members":{ + "RecordFormatType":{ + "shape":"RecordFormatType", + "documentation":"

Specifies the format of the records on the output stream.

" + } + }, + "documentation":"

Describes the data format when records are written to the destination in an SQL-based Amazon Kinesis Data Analytics application.

" + }, + "DiscoverInputSchemaRequest":{ + "type":"structure", + "required":["ServiceExecutionRole"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the streaming source.

" + }, + "ServiceExecutionRole":{ + "shape":"RoleARN", + "documentation":"

The ARN of the role that is used to access the streaming source.

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

The point at which you want Kinesis Data Analytics to start reading records from the specified streaming source discovery purposes.

" + }, + "S3Configuration":{ + "shape":"S3Configuration", + "documentation":"

Specify this parameter to discover a schema from data in an Amazon S3 object.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration to use to preprocess the records before discovering the schema of the records.

" + } + } + }, + "DiscoverInputSchemaResponse":{ + "type":"structure", + "members":{ + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

The schema inferred from the streaming source. It identifies the format of the data in the streaming source and how each data element maps to corresponding columns in the in-application stream that you can create.

" + }, + "ParsedInputRecords":{ + "shape":"ParsedInputRecords", + "documentation":"

An array of elements, where each element corresponds to a row in a stream record (a stream record can have more than one row).

" + }, + "ProcessedInputRecords":{ + "shape":"ProcessedInputRecords", + "documentation":"

The stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

" + }, + "RawInputRecords":{ + "shape":"RawInputRecords", + "documentation":"

The raw stream data that was sampled to infer the schema.

" + } + } + }, + "EnvironmentProperties":{ + "type":"structure", + "required":["PropertyGroups"], + "members":{ + "PropertyGroups":{ + "shape":"PropertyGroups", + "documentation":"

Describes the execution property groups.

" + } + }, + "documentation":"

Describes execution properties for a Java-based Kinesis Data Analytics application.

" + }, + "EnvironmentPropertyDescriptions":{ + "type":"structure", + "members":{ + "PropertyGroupDescriptions":{ + "shape":"PropertyGroups", + "documentation":"

Describes the execution property groups.

" + } + }, + "documentation":"

Describes the execution properties for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "EnvironmentPropertyUpdates":{ + "type":"structure", + "required":["PropertyGroups"], + "members":{ + "PropertyGroups":{ + "shape":"PropertyGroups", + "documentation":"

Describes updates to the execution property groups.

" + } + }, + "documentation":"

Describes updates to the execution property groups for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "ErrorMessage":{"type":"string"}, + "FileKey":{ + "type":"string", + "max":1024, + "min":1 + }, + "FlinkApplicationConfiguration":{ + "type":"structure", + "members":{ + "CheckpointConfiguration":{ + "shape":"CheckpointConfiguration", + "documentation":"

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance. For more information, see Checkpoints for Fault Tolerance in the Apache Flink Documentation.

" + }, + "MonitoringConfiguration":{ + "shape":"MonitoringConfiguration", + "documentation":"

Describes configuration parameters for Amazon CloudWatch logging for an application.

" + }, + "ParallelismConfiguration":{ + "shape":"ParallelismConfiguration", + "documentation":"

Describes parameters for how an application executes multiple tasks simultaneously.

" + } + }, + "documentation":"

Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "FlinkApplicationConfigurationDescription":{ + "type":"structure", + "members":{ + "CheckpointConfigurationDescription":{ + "shape":"CheckpointConfigurationDescription", + "documentation":"

Describes an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

" + }, + "MonitoringConfigurationDescription":{ + "shape":"MonitoringConfigurationDescription", + "documentation":"

Describes configuration parameters for Amazon CloudWatch logging for an application.

" + }, + "ParallelismConfigurationDescription":{ + "shape":"ParallelismConfigurationDescription", + "documentation":"

Describes parameters for how an application executes multiple tasks simultaneously.

" + }, + "JobPlanDescription":{ + "shape":"JobPlanDescription", + "documentation":"

The job plan for an application. For more information about the job plan, see Jobs and Scheduling in the Apache Flink Documentation. To retrieve the job plan for the application, use the DescribeApplicationRequest$IncludeAdditionalDetails parameter of the DescribeApplication operation.

" + } + }, + "documentation":"

Describes configuration parameters for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "FlinkApplicationConfigurationUpdate":{ + "type":"structure", + "members":{ + "CheckpointConfigurationUpdate":{ + "shape":"CheckpointConfigurationUpdate", + "documentation":"

Describes updates to an application's checkpointing configuration. Checkpointing is the process of persisting application state for fault tolerance.

" + }, + "MonitoringConfigurationUpdate":{ + "shape":"MonitoringConfigurationUpdate", + "documentation":"

Describes updates to the configuration parameters for Amazon CloudWatch logging for an application.

" + }, + "ParallelismConfigurationUpdate":{ + "shape":"ParallelismConfigurationUpdate", + "documentation":"

Describes updates to the parameters for how an application executes multiple tasks simultaneously.

" + } + }, + "documentation":"

Describes updates to the configuration parameters for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "Id":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "InAppStreamName":{ + "type":"string", + "max":32, + "min":1 + }, + "InAppStreamNames":{ + "type":"list", + "member":{"shape":"InAppStreamName"} + }, + "InAppTableName":{ + "type":"string", + "max":32, + "min":1 + }, + "Input":{ + "type":"structure", + "required":[ + "NamePrefix", + "InputSchema" + ], + "members":{ + "NamePrefix":{ + "shape":"InAppStreamName", + "documentation":"

The name prefix to use when creating an in-application stream. Suppose that you specify a prefix \"MyInApplicationStream.\" Kinesis Data Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with the names \"MyInApplicationStream_001,\" \"MyInApplicationStream_002,\" and so on.

" + }, + "InputProcessingConfiguration":{ + "shape":"InputProcessingConfiguration", + "documentation":"

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application's SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor.

" + }, + "KinesisStreamsInput":{ + "shape":"KinesisStreamsInput", + "documentation":"

If the streaming source is an Amazon Kinesis data stream, identifies the stream's Amazon Resource Name (ARN).

" + }, + "KinesisFirehoseInput":{ + "shape":"KinesisFirehoseInput", + "documentation":"

If the streaming source is an Amazon Kinesis Data Firehose delivery stream, identifies the delivery stream's ARN.

" + }, + "InputParallelism":{ + "shape":"InputParallelism", + "documentation":"

Describes the number of in-application streams to create.

" + }, + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

" + } + }, + "documentation":"

When you configure the application input for an SQL-based Amazon Kinesis Data Analytics application, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

" + }, + "InputDescription":{ + "type":"structure", + "members":{ + "InputId":{ + "shape":"Id", + "documentation":"

The input ID that is associated with the application input. This is the ID that Kinesis Data Analytics assigns to each input configuration that you add to your application.

" + }, + "NamePrefix":{ + "shape":"InAppStreamName", + "documentation":"

The in-application name prefix.

" + }, + "InAppStreamNames":{ + "shape":"InAppStreamNames", + "documentation":"

Returns the in-application stream names that are mapped to the stream source.

" + }, + "InputProcessingConfigurationDescription":{ + "shape":"InputProcessingConfigurationDescription", + "documentation":"

The description of the preprocessor that executes on records in this input before the application's code is run.

" + }, + "KinesisStreamsInputDescription":{ + "shape":"KinesisStreamsInputDescription", + "documentation":"

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

" + }, + "KinesisFirehoseInputDescription":{ + "shape":"KinesisFirehoseInputDescription", + "documentation":"

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

" + }, + "InputSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

" + }, + "InputParallelism":{ + "shape":"InputParallelism", + "documentation":"

Describes the configured parallelism (number of in-application streams mapped to the streaming source).

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

The point at which the application is configured to read from the input stream.

" + } + }, + "documentation":"

Describes the application input configuration for an SQL-based Amazon Kinesis Data Analytics application.

" + }, + "InputDescriptions":{ + "type":"list", + "member":{"shape":"InputDescription"} + }, + "InputLambdaProcessor":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the AWS Lambda function that operates on records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + } + }, + "documentation":"

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream in an SQL-based Amazon Kinesis Data Analytics application.

" + }, + "InputLambdaProcessorDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the AWS Lambda function that is used to preprocess the records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that is used to access the AWS Lambda function.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, an object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream.

" + }, + "InputLambdaProcessorUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the new AWS Lambda function that is used to preprocess the records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, represents an update to the InputLambdaProcessor that is used to preprocess the records in the stream.

" + }, + "InputParallelism":{ + "type":"structure", + "members":{ + "Count":{ + "shape":"InputParallelismCount", + "documentation":"

The number of in-application streams to create.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the number of in-application streams to create for a given streaming source.

" + }, + "InputParallelismCount":{ + "type":"integer", + "max":64, + "min":1 + }, + "InputParallelismUpdate":{ + "type":"structure", + "required":["CountUpdate"], + "members":{ + "CountUpdate":{ + "shape":"InputParallelismCount", + "documentation":"

The number of in-application streams to create for the specified streaming source.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, provides updates to the parallelism count.

" + }, + "InputProcessingConfiguration":{ + "type":"structure", + "required":["InputLambdaProcessor"], + "members":{ + "InputLambdaProcessor":{ + "shape":"InputLambdaProcessor", + "documentation":"

The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes a processor that is used to preprocess the records in the stream before being processed by your application code. Currently, the only input processor available is AWS Lambda.

" + }, + "InputProcessingConfigurationDescription":{ + "type":"structure", + "members":{ + "InputLambdaProcessorDescription":{ + "shape":"InputLambdaProcessorDescription", + "documentation":"

Provides configuration information about the associated InputLambdaProcessorDescription

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, provides the configuration information about an input processor. Currently, the only input processor available is AWS Lambda.

" + }, + "InputProcessingConfigurationUpdate":{ + "type":"structure", + "required":["InputLambdaProcessorUpdate"], + "members":{ + "InputLambdaProcessorUpdate":{ + "shape":"InputLambdaProcessorUpdate", + "documentation":"

Provides update information for an InputLambdaProcessor.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to an InputProcessingConfiguration.

" + }, + "InputSchemaUpdate":{ + "type":"structure", + "members":{ + "RecordFormatUpdate":{ + "shape":"RecordFormat", + "documentation":"

Specifies the format of the records on the streaming source.

" + }, + "RecordEncodingUpdate":{ + "shape":"RecordEncoding", + "documentation":"

Specifies the encoding of the records in the streaming source; for example, UTF-8.

" + }, + "RecordColumnUpdates":{ + "shape":"RecordColumns", + "documentation":"

A list of RecordColumn objects. Each object describes the mapping of the streaming source element to the corresponding column in the in-application stream.

" + } + }, + "documentation":"

Describes updates for an SQL-based Amazon Kinesis Data Analytics application's input schema.

" + }, + "InputStartingPosition":{ + "type":"string", + "enum":[ + "NOW", + "TRIM_HORIZON", + "LAST_STOPPED_POINT" + ] + }, + "InputStartingPositionConfiguration":{ + "type":"structure", + "members":{ + "InputStartingPosition":{ + "shape":"InputStartingPosition", + "documentation":"

The starting position on the stream.

  • NOW - Start reading just after the most recent record in the stream, and start at the request timestamp that the customer issued.

  • TRIM_HORIZON - Start reading at the last untrimmed record in the stream, which is the oldest record available in the stream. This option is not available for an Amazon Kinesis Data Firehose delivery stream.

  • LAST_STOPPED_POINT - Resume reading from where the application last stopped reading.

" + } + }, + "documentation":"

Describes the point at which the application reads from the streaming source.

" + }, + "InputUpdate":{ + "type":"structure", + "required":["InputId"], + "members":{ + "InputId":{ + "shape":"Id", + "documentation":"

The input ID of the application input to be updated.

" + }, + "NamePrefixUpdate":{ + "shape":"InAppStreamName", + "documentation":"

The name prefix for in-application streams that Kinesis Data Analytics creates for the specific streaming source.

" + }, + "InputProcessingConfigurationUpdate":{ + "shape":"InputProcessingConfigurationUpdate", + "documentation":"

Describes updates to an InputProcessingConfiguration.

" + }, + "KinesisStreamsInputUpdate":{ + "shape":"KinesisStreamsInputUpdate", + "documentation":"

If a Kinesis data stream is the streaming source to be updated, provides an updated stream Amazon Resource Name (ARN).

" + }, + "KinesisFirehoseInputUpdate":{ + "shape":"KinesisFirehoseInputUpdate", + "documentation":"

If a Kinesis Data Firehose delivery stream is the streaming source to be updated, provides an updated stream ARN.

" + }, + "InputSchemaUpdate":{ + "shape":"InputSchemaUpdate", + "documentation":"

Describes the data format on the streaming source, and how record elements on the streaming source map to columns of the in-application stream that is created.

" + }, + "InputParallelismUpdate":{ + "shape":"InputParallelismUpdate", + "documentation":"

Describes the parallelism updates (the number of in-application streams Kinesis Data Analytics creates for the specific streaming source).

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to a specific input configuration (identified by the InputId of an application).

" + }, + "InputUpdates":{ + "type":"list", + "member":{"shape":"InputUpdate"} + }, + "Inputs":{ + "type":"list", + "member":{"shape":"Input"} + }, + "InvalidApplicationConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The user-provided application configuration is not valid.

", + "exception":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified input parameter value is not valid.

", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request JSON is not valid for the operation.

", + "exception":true + }, + "JSONMappingParameters":{ + "type":"structure", + "required":["RecordRowPath"], + "members":{ + "RecordRowPath":{ + "shape":"RecordRowPath", + "documentation":"

The path to the top-level parent that contains the records.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.

" + }, + "JobPlanDescription":{"type":"string"}, + "KinesisAnalyticsARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws:kinesisanalytics:[a-z]{2}-[a-z]+-\\d{1}+:\\d{12}+:application/[a-zA-Z0-9_.-]{1,128}" + }, + "KinesisFirehoseInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the delivery stream.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, identifies a Kinesis Data Firehose delivery stream as the streaming source. You provide the delivery stream's Amazon Resource Name (ARN).

" + }, + "KinesisFirehoseInputDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the delivery stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics assumes to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

Describes the Amazon Kinesis Data Firehose delivery stream that is configured as the streaming source in the application input configuration.

" + }, + "KinesisFirehoseInputUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the input delivery stream to read.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, when updating application input configuration, provides information about a Kinesis Data Firehose delivery stream as the streaming source.

" + }, + "KinesisFirehoseOutput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the destination delivery stream to write to.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination. You provide the stream Amazon Resource Name (ARN) of the delivery stream.

" + }, + "KinesisFirehoseOutputDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the delivery stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application's output, describes the Kinesis Data Firehose delivery stream that is configured as its destination.

" + }, + "KinesisFirehoseOutputUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the delivery stream to write to.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, when updating an output configuration using the UpdateApplication operation, provides information about a Kinesis Data Firehose delivery stream that is configured as the destination.

" + }, + "KinesisStreamsInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the input Kinesis data stream to read.

" + } + }, + "documentation":"

Identifies an Amazon Kinesis data stream as the streaming source. You provide the stream's Amazon Resource Name (ARN).

" + }, + "KinesisStreamsInputDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the Kinesis data stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the Kinesis data stream that is configured as the streaming source in the application input configuration.

" + }, + "KinesisStreamsInputUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the input Kinesis data stream to read.

" + } + }, + "documentation":"

When you update the input configuration for an SQL-based Amazon Kinesis Data Analytics application, provides information about an Amazon Kinesis stream as the streaming source.

" + }, + "KinesisStreamsOutput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the destination Kinesis data stream to write to.

" + } + }, + "documentation":"

When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination. You provide the stream Amazon Resource Name (ARN).

" + }, + "KinesisStreamsOutputDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the Kinesis data stream.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics can assume to access the stream.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application's output, describes the Kinesis data stream that is configured as its destination.

" + }, + "KinesisStreamsOutputUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the Kinesis data stream where you want to write the output.

" + } + }, + "documentation":"

When you update an SQL-based Amazon Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about a Kinesis data stream that is configured as the destination.

" + }, + "LambdaOutput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the destination Lambda function to write to.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + } + }, + "documentation":"

When you configure an SQL-based Amazon Kinesis Data Analytics application's output, identifies an AWS Lambda function as the destination. You provide the function Amazon Resource Name (ARN) of the Lambda function.

" + }, + "LambdaOutputDescription":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the destination Lambda function.

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics can assume to write to the destination function.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application output, describes the AWS Lambda function that is configured as its destination.

" + }, + "LambdaOutputUpdate":{ + "type":"structure", + "required":["ResourceARNUpdate"], + "members":{ + "ResourceARNUpdate":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the destination AWS Lambda function.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

" + } + }, + "documentation":"

When you update an SQL-based Amazon Kinesis Data Analytics application's output configuration using the UpdateApplication operation, provides information about an AWS Lambda function that is configured as the destination.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The number of allowed resources has been exceeded.

", + "exception":true + }, + "ListApplicationSnapshotsRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of an existing application.

" + }, + "Limit":{ + "shape":"ListSnapshotsInputLimit", + "documentation":"

The maximum number of application snapshots to list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + } + } + }, + "ListApplicationSnapshotsResponse":{ + "type":"structure", + "members":{ + "SnapshotSummaries":{ + "shape":"SnapshotSummaries", + "documentation":"

A collection of objects containing information about the application snapshots.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of results, or null if there are no additional results.

" + } + } + }, + "ListApplicationsInputLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListApplicationsRequest":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"ListApplicationsInputLimit", + "documentation":"

The maximum number of applications to list.

" + }, + "NextToken":{ + "shape":"ApplicationName", + "documentation":"

If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.

" + } + } + }, + "ListApplicationsResponse":{ + "type":"structure", + "required":["ApplicationSummaries"], + "members":{ + "ApplicationSummaries":{ + "shape":"ApplicationSummaries", + "documentation":"

A list of ApplicationSummary objects.

" + }, + "NextToken":{ + "shape":"ApplicationName", + "documentation":"

The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the AWS Command Line Interface's Pagination Options.

" + } + } + }, + "ListSnapshotsInputLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the application for which to retrieve tags.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value tags assigned to the application.

" + } + } + }, + "LogLevel":{ + "type":"string", + "enum":[ + "INFO", + "WARN", + "ERROR", + "DEBUG" + ] + }, + "LogStreamARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "MappingParameters":{ + "type":"structure", + "members":{ + "JSONMappingParameters":{ + "shape":"JSONMappingParameters", + "documentation":"

Provides additional mapping information when JSON is the record format on the streaming source.

" + }, + "CSVMappingParameters":{ + "shape":"CSVMappingParameters", + "documentation":"

Provides additional mapping information when the record format uses delimiters (for example, CSV).

" + } + }, + "documentation":"

When you configure an SQL-based Amazon Kinesis Data Analytics application's input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

" + }, + "MetricsLevel":{ + "type":"string", + "enum":[ + "APPLICATION", + "TASK", + "OPERATOR", + "PARALLELISM" + ] + }, + "MinPauseBetweenCheckpoints":{ + "type":"long", + "min":0 + }, + "MonitoringConfiguration":{ + "type":"structure", + "required":["ConfigurationType"], + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether to use the default CloudWatch logging configuration for an application.

" + }, + "MetricsLevel":{ + "shape":"MetricsLevel", + "documentation":"

Describes the granularity of the CloudWatch Logs for an application.

" + }, + "LogLevel":{ + "shape":"LogLevel", + "documentation":"

Describes the verbosity of the CloudWatch Logs for an application.

" + } + }, + "documentation":"

Describes configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application. For more information about CloudWatch logging, see Monitoring.

" + }, + "MonitoringConfigurationDescription":{ + "type":"structure", + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether to use the default CloudWatch logging configuration for an application.

" + }, + "MetricsLevel":{ + "shape":"MetricsLevel", + "documentation":"

Describes the granularity of the CloudWatch Logs for an application.

" + }, + "LogLevel":{ + "shape":"LogLevel", + "documentation":"

Describes the verbosity of the CloudWatch Logs for an application.

" + } + }, + "documentation":"

Describes configuration parameters for CloudWatch logging for a Java-based Kinesis Data Analytics application.

" + }, + "MonitoringConfigurationUpdate":{ + "type":"structure", + "members":{ + "ConfigurationTypeUpdate":{ + "shape":"ConfigurationType", + "documentation":"

Describes updates to whether to use the default CloudWatch logging configuration for an application.

" + }, + "MetricsLevelUpdate":{ + "shape":"MetricsLevel", + "documentation":"

Describes updates to the granularity of the CloudWatch Logs for an application.

" + }, + "LogLevelUpdate":{ + "shape":"LogLevel", + "documentation":"

Describes updates to the verbosity of the CloudWatch Logs for an application.

" + } + }, + "documentation":"

Describes updates to configuration parameters for Amazon CloudWatch logging for a Java-based Kinesis Data Analytics application.

" + }, + "NextToken":{ + "type":"string", + "max":512, + "min":1 + }, + "ObjectVersion":{"type":"string"}, + "Output":{ + "type":"structure", + "required":[ + "Name", + "DestinationSchema" + ], + "members":{ + "Name":{ + "shape":"InAppStreamName", + "documentation":"

The name of the in-application stream.

" + }, + "KinesisStreamsOutput":{ + "shape":"KinesisStreamsOutput", + "documentation":"

Identifies an Amazon Kinesis data stream as the destination.

" + }, + "KinesisFirehoseOutput":{ + "shape":"KinesisFirehoseOutput", + "documentation":"

Identifies an Amazon Kinesis Data Firehose delivery stream as the destination.

" + }, + "LambdaOutput":{ + "shape":"LambdaOutput", + "documentation":"

Identifies an AWS Lambda function as the destination.

" + }, + "DestinationSchema":{ + "shape":"DestinationSchema", + "documentation":"

Describes the data format when records are written to the destination.

" + } + }, + "documentation":"

Describes an SQL-based Amazon Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

" + }, + "OutputDescription":{ + "type":"structure", + "members":{ + "OutputId":{ + "shape":"Id", + "documentation":"

A unique identifier for the output configuration.

" + }, + "Name":{ + "shape":"InAppStreamName", + "documentation":"

The name of the in-application stream that is configured as output.

" + }, + "KinesisStreamsOutputDescription":{ + "shape":"KinesisStreamsOutputDescription", + "documentation":"

Describes the Kinesis data stream that is configured as the destination where output is written.

" + }, + "KinesisFirehoseOutputDescription":{ + "shape":"KinesisFirehoseOutputDescription", + "documentation":"

Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

" + }, + "LambdaOutputDescription":{ + "shape":"LambdaOutputDescription", + "documentation":"

Describes the Lambda function that is configured as the destination where output is written.

" + }, + "DestinationSchema":{ + "shape":"DestinationSchema", + "documentation":"

The data format used for writing data to the destination.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

" + }, + "OutputDescriptions":{ + "type":"list", + "member":{"shape":"OutputDescription"} + }, + "OutputUpdate":{ + "type":"structure", + "required":["OutputId"], + "members":{ + "OutputId":{ + "shape":"Id", + "documentation":"

Identifies the specific output configuration that you want to update.

" + }, + "NameUpdate":{ + "shape":"InAppStreamName", + "documentation":"

If you want to specify a different in-application stream for this output configuration, use this field to specify the new in-application stream name.

" + }, + "KinesisStreamsOutputUpdate":{ + "shape":"KinesisStreamsOutputUpdate", + "documentation":"

Describes a Kinesis data stream as the destination for the output.

" + }, + "KinesisFirehoseOutputUpdate":{ + "shape":"KinesisFirehoseOutputUpdate", + "documentation":"

Describes a Kinesis Data Firehose delivery stream as the destination for the output.

" + }, + "LambdaOutputUpdate":{ + "shape":"LambdaOutputUpdate", + "documentation":"

Describes an AWS Lambda function as the destination for the output.

" + }, + "DestinationSchemaUpdate":{ + "shape":"DestinationSchema", + "documentation":"

Describes the data format when records are written to the destination.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes updates to the output configuration identified by the OutputId.

" + }, + "OutputUpdates":{ + "type":"list", + "member":{"shape":"OutputUpdate"} + }, + "Outputs":{ + "type":"list", + "member":{"shape":"Output"} + }, + "Parallelism":{ + "type":"integer", + "min":1 + }, + "ParallelismConfiguration":{ + "type":"structure", + "required":["ConfigurationType"], + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

" + }, + "Parallelism":{ + "shape":"Parallelism", + "documentation":"

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform. The Kinesis Data Analytics service can increase this number automatically if ParallelismConfiguration$AutoScalingEnabled is set to true.

" + }, + "ParallelismPerKPU":{ + "shape":"ParallelismPerKPU", + "documentation":"

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application. For more information about KPUs, see Amazon Kinesis Data Analytics Pricing.

" + }, + "AutoScalingEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" + } + }, + "documentation":"

Describes parameters for how a Java-based Amazon Kinesis Data Analytics application executes multiple tasks simultaneously. For more information about parallelism, see Parallel Execution in the Apache Flink Documentation.

" + }, + "ParallelismConfigurationDescription":{ + "type":"structure", + "members":{ + "ConfigurationType":{ + "shape":"ConfigurationType", + "documentation":"

Describes whether the application uses the default parallelism for the Kinesis Data Analytics service.

" + }, + "Parallelism":{ + "shape":"Parallelism", + "documentation":"

Describes the initial number of parallel tasks that a Java-based Kinesis Data Analytics application can perform.

" + }, + "ParallelismPerKPU":{ + "shape":"ParallelismPerKPU", + "documentation":"

Describes the number of parallel tasks that a Java-based Kinesis Data Analytics application can perform per Kinesis Processing Unit (KPU) used by the application.

" + }, + "CurrentParallelism":{ + "shape":"Parallelism", + "documentation":"

Describes the current number of parallel tasks that a Java-based Kinesis Data Analytics application can perform.

" + }, + "AutoScalingEnabled":{ + "shape":"BooleanObject", + "documentation":"

Describes whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" + } + }, + "documentation":"

Describes parameters for how a Java-based Kinesis Data Analytics application executes multiple tasks simultaneously.

" + }, + "ParallelismConfigurationUpdate":{ + "type":"structure", + "members":{ + "ConfigurationTypeUpdate":{ + "shape":"ConfigurationType", + "documentation":"

Describes updates to whether the application uses the default parallelism for the Kinesis Data Analytics service, or if a custom parallelism is used.

" + }, + "ParallelismUpdate":{ + "shape":"Parallelism", + "documentation":"

Describes updates to the initial number of parallel tasks an application can perform.

" + }, + "ParallelismPerKPUUpdate":{ + "shape":"ParallelismPerKPU", + "documentation":"

Describes updates to the number of parallel tasks an application can perform per Kinesis Processing Unit (KPU) used by the application.

" + }, + "AutoScalingEnabledUpdate":{ + "shape":"BooleanObject", + "documentation":"

Describes updates to whether the Kinesis Data Analytics service can increase the parallelism of the application in response to increased throughput.

" + } + }, + "documentation":"

Describes updates to parameters for how a Java-based Kinesis Data Analytics application executes multiple tasks simultaneously.

" + }, + "ParallelismPerKPU":{ + "type":"integer", + "min":1 + }, + "ParsedInputRecord":{ + "type":"list", + "member":{"shape":"ParsedInputRecordField"} + }, + "ParsedInputRecordField":{"type":"string"}, + "ParsedInputRecords":{ + "type":"list", + "member":{"shape":"ParsedInputRecord"} + }, + "ProcessedInputRecord":{"type":"string"}, + "ProcessedInputRecords":{ + "type":"list", + "member":{"shape":"ProcessedInputRecord"} + }, + "PropertyGroup":{ + "type":"structure", + "required":[ + "PropertyGroupId", + "PropertyMap" + ], + "members":{ + "PropertyGroupId":{ + "shape":"Id", + "documentation":"

Describes the key of an application execution property key-value pair.

" + }, + "PropertyMap":{ + "shape":"PropertyMap", + "documentation":"

Describes the value of an application execution property key-value pair.

" + } + }, + "documentation":"

Property key-value pairs passed into a Java-based Kinesis Data Analytics application.

" + }, + "PropertyGroups":{ + "type":"list", + "member":{"shape":"PropertyGroup"}, + "max":50 + }, + "PropertyKey":{ + "type":"string", + "max":2048, + "min":1 + }, + "PropertyMap":{ + "type":"map", + "key":{"shape":"PropertyKey"}, + "value":{"shape":"PropertyValue"}, + "max":50, + "min":1 + }, + "PropertyValue":{ + "type":"string", + "max":2048, + "min":1 + }, + "RawInputRecord":{"type":"string"}, + "RawInputRecords":{ + "type":"list", + "member":{"shape":"RawInputRecord"} + }, + "RecordColumn":{ + "type":"structure", + "required":[ + "Name", + "SqlType" + ], + "members":{ + "Name":{ + "shape":"RecordColumnName", + "documentation":"

The name of the column that is created in the in-application input stream or reference table.

" + }, + "Mapping":{ + "shape":"RecordColumnMapping", + "documentation":"

A reference to the data element in the streaming input or the reference data source.

" + }, + "SqlType":{ + "shape":"RecordColumnSqlType", + "documentation":"

The type of column created in the in-application input stream or reference table.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

" + }, + "RecordColumnDelimiter":{ + "type":"string", + "min":1 + }, + "RecordColumnMapping":{"type":"string"}, + "RecordColumnName":{"type":"string"}, + "RecordColumnSqlType":{ + "type":"string", + "min":1 + }, + "RecordColumns":{ + "type":"list", + "member":{"shape":"RecordColumn"}, + "max":1000, + "min":1 + }, + "RecordEncoding":{ + "type":"string", + "pattern":"UTF-8" + }, + "RecordFormat":{ + "type":"structure", + "required":["RecordFormatType"], + "members":{ + "RecordFormatType":{ + "shape":"RecordFormatType", + "documentation":"

The type of record format.

" + }, + "MappingParameters":{ + "shape":"MappingParameters", + "documentation":"

When you configure application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

" + }, + "RecordFormatType":{ + "type":"string", + "enum":[ + "JSON", + "CSV" + ] + }, + "RecordRowDelimiter":{ + "type":"string", + "min":1 + }, + "RecordRowPath":{ + "type":"string", + "min":1 + }, + "ReferenceDataSource":{ + "type":"structure", + "required":[ + "TableName", + "ReferenceSchema" + ], + "members":{ + "TableName":{ + "shape":"InAppTableName", + "documentation":"

The name of the in-application table to create.

" + }, + "S3ReferenceDataSource":{ + "shape":"S3ReferenceDataSource", + "documentation":"

Identifies the S3 bucket and object that contains the reference data. A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + }, + "ReferenceSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

" + }, + "ReferenceDataSourceDescription":{ + "type":"structure", + "required":[ + "ReferenceId", + "TableName", + "S3ReferenceDataSourceDescription" + ], + "members":{ + "ReferenceId":{ + "shape":"Id", + "documentation":"

The ID of the reference data source. This is the ID that Kinesis Data Analytics assigns when you add the reference data source to your application using the CreateApplication or UpdateApplication operation.

" + }, + "TableName":{ + "shape":"InAppTableName", + "documentation":"

The in-application table name created by the specific reference data source configuration.

" + }, + "S3ReferenceDataSourceDescription":{ + "shape":"S3ReferenceDataSourceDescription", + "documentation":"

Provides the Amazon S3 bucket name, the object key name that contains the reference data.

" + }, + "ReferenceSchema":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the reference data source configured for an application.

" + }, + "ReferenceDataSourceDescriptions":{ + "type":"list", + "member":{"shape":"ReferenceDataSourceDescription"} + }, + "ReferenceDataSourceUpdate":{ + "type":"structure", + "required":["ReferenceId"], + "members":{ + "ReferenceId":{ + "shape":"Id", + "documentation":"

The ID of the reference data source that is being updated. You can use the DescribeApplication operation to get this value.

" + }, + "TableNameUpdate":{ + "shape":"InAppTableName", + "documentation":"

The in-application table name that is created by this update.

" + }, + "S3ReferenceDataSourceUpdate":{ + "shape":"S3ReferenceDataSourceUpdate", + "documentation":"

Describes the S3 bucket name, object key name, and IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf and populate the in-application reference table.

" + }, + "ReferenceSchemaUpdate":{ + "shape":"SourceSchema", + "documentation":"

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + } + }, + "documentation":"

When you update a reference data source configuration for a SQL-based Amazon Kinesis Data Analytics application, this object provides all the updated values (such as the source bucket name and object key name), the in-application table name that is created, and updated mapping information that maps the data in the Amazon S3 object to the in-application reference table that is created.

" + }, + "ReferenceDataSourceUpdates":{ + "type":"list", + "member":{"shape":"ReferenceDataSourceUpdate"} + }, + "ReferenceDataSources":{ + "type":"list", + "member":{"shape":"ReferenceDataSource"} + }, + "ResourceARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:.*" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The application is not available for this operation.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Specified application can't be found.

", + "exception":true + }, + "ResourceProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Discovery failed to get a record from the streaming source because of the Amazon Kinesis Streams ProvisionedThroughputExceededException. For more information, see GetRecords in the Amazon Kinesis Streams API Reference.

", + "exception":true + }, + "RoleARN":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "RunConfiguration":{ + "type":"structure", + "members":{ + "SqlRunConfigurations":{ + "shape":"SqlRunConfigurations", + "documentation":"

Describes the starting parameters for an SQL-based Kinesis Data Analytics application.

" + }, + "ApplicationRestoreConfiguration":{ + "shape":"ApplicationRestoreConfiguration", + "documentation":"

Describes the restore behavior of a restarting application.

" + } + }, + "documentation":"

Describes the starting parameters for an Amazon Kinesis Data Analytics application.

" + }, + "RunConfigurationDescription":{ + "type":"structure", + "members":{ + "ApplicationRestoreConfigurationDescription":{ + "shape":"ApplicationRestoreConfiguration", + "documentation":"

Describes the restore behavior of a restarting application.

" + } + }, + "documentation":"

Describes the starting properties for a Kinesis Data Analytics application.

" + }, + "RunConfigurationUpdate":{ + "type":"structure", + "members":{ + "ApplicationRestoreConfiguration":{ + "shape":"ApplicationRestoreConfiguration", + "documentation":"

Describes updates to the restore behavior of a restarting application.

" + } + }, + "documentation":"

Describes the updates to the starting parameters for a Kinesis Data Analytics application.

" + }, + "RuntimeEnvironment":{ + "type":"string", + "enum":[ + "SQL-1_0", + "FLINK-1_6" + ] + }, + "S3ApplicationCodeLocationDescription":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

The file key for the object containing the application code.

" + }, + "ObjectVersion":{ + "shape":"ObjectVersion", + "documentation":"

The version of the object containing the application code.

" + } + }, + "documentation":"

Describes the location of a Java-based Amazon Kinesis Data Analytics application's code stored in an S3 bucket.

" + }, + "S3Configuration":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The ARN of the S3 bucket that contains the data.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

The name of the object that contains the data.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, provides a description of an Amazon S3 data source, including the Amazon Resource Name (ARN) of the S3 bucket and the name of the Amazon S3 object that contains the data.

" + }, + "S3ContentLocation":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The Amazon Resource Name (ARN) for the S3 bucket containing the application code.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

The file key for the object containing the application code.

" + }, + "ObjectVersion":{ + "shape":"ObjectVersion", + "documentation":"

The version of the object containing the application code.

" + } + }, + "documentation":"

For a Java-based Amazon Kinesis Data Analytics application, provides a description of an Amazon S3 object, including the Amazon Resource Name (ARN) of the S3 bucket, the name of the Amazon S3 object that contains the data, and the version number of the Amazon S3 object that contains the data.

" + }, + "S3ContentLocationUpdate":{ + "type":"structure", + "members":{ + "BucketARNUpdate":{ + "shape":"BucketARN", + "documentation":"

The new Amazon Resource Name (ARN) for the S3 bucket containing the application code.

" + }, + "FileKeyUpdate":{ + "shape":"FileKey", + "documentation":"

The new file key for the object containing the application code.

" + }, + "ObjectVersionUpdate":{ + "shape":"ObjectVersion", + "documentation":"

The new version of the object containing the application code.

" + } + }, + "documentation":"

Describes an update for the Amazon S3 code content location for a Java-based Amazon Kinesis Data Analytics application.

" + }, + "S3ReferenceDataSource":{ + "type":"structure", + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

The object key name containing the reference data.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.

A Kinesis Data Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

" + }, + "S3ReferenceDataSourceDescription":{ + "type":"structure", + "required":[ + "BucketARN", + "FileKey" + ], + "members":{ + "BucketARN":{ + "shape":"BucketARN", + "documentation":"

The Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKey":{ + "shape":"FileKey", + "documentation":"

Amazon S3 object key name.

" + }, + "ReferenceRoleARN":{ + "shape":"RoleARN", + "documentation":"

The ARN of the IAM role that Kinesis Data Analytics can assume to read the Amazon S3 object on your behalf to populate the in-application reference table.

Provided for backward compatibility. Applications that are created with the current API version have an application-level service execution role rather than a resource-level role.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, provides the bucket name and object key name that stores the reference data.

" + }, + "S3ReferenceDataSourceUpdate":{ + "type":"structure", + "members":{ + "BucketARNUpdate":{ + "shape":"BucketARN", + "documentation":"

The Amazon Resource Name (ARN) of the S3 bucket.

" + }, + "FileKeyUpdate":{ + "shape":"FileKey", + "documentation":"

The object key name.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the Amazon S3 bucket name and object key name for an in-application reference table.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service cannot complete the request.

", + "exception":true, + "fault":true + }, + "SnapshotDetails":{ + "type":"structure", + "required":[ + "SnapshotName", + "SnapshotStatus", + "ApplicationVersionId" + ], + "members":{ + "SnapshotName":{ + "shape":"SnapshotName", + "documentation":"

The identifier for the application snapshot.

" + }, + "SnapshotStatus":{ + "shape":"SnapshotStatus", + "documentation":"

The status of the application snapshot.

" + }, + "ApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version ID when the snapshot was created.

" + }, + "SnapshotCreationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The timestamp of the application snapshot.

" + } + }, + "documentation":"

Provides details about a snapshot of application state.

" + }, + "SnapshotName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "SnapshotStatus":{ + "type":"string", + "enum":[ + "CREATING", + "READY", + "DELETING", + "FAILED" + ] + }, + "SnapshotSummaries":{ + "type":"list", + "member":{"shape":"SnapshotDetails"} + }, + "SourceSchema":{ + "type":"structure", + "required":[ + "RecordFormat", + "RecordColumns" + ], + "members":{ + "RecordFormat":{ + "shape":"RecordFormat", + "documentation":"

Specifies the format of the records on the streaming source.

" + }, + "RecordEncoding":{ + "shape":"RecordEncoding", + "documentation":"

Specifies the encoding of the records in the streaming source. For example, UTF-8.

" + }, + "RecordColumns":{ + "shape":"RecordColumns", + "documentation":"

A list of RecordColumn objects.

" + } + }, + "documentation":"

For an SQL-based Amazon Kinesis Data Analytics application, describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

" + }, + "SqlApplicationConfiguration":{ + "type":"structure", + "members":{ + "Inputs":{ + "shape":"Inputs", + "documentation":"

The array of Input objects describing the input streams used by the application.

" + }, + "Outputs":{ + "shape":"Outputs", + "documentation":"

The array of Output objects describing the destination streams used by the application.

" + }, + "ReferenceDataSources":{ + "shape":"ReferenceDataSources", + "documentation":"

The array of ReferenceDataSource objects describing the reference data sources used by the application.

" + } + }, + "documentation":"

Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application.

" + }, + "SqlApplicationConfigurationDescription":{ + "type":"structure", + "members":{ + "InputDescriptions":{ + "shape":"InputDescriptions", + "documentation":"

The array of InputDescription objects describing the input streams used by the application.

" + }, + "OutputDescriptions":{ + "shape":"OutputDescriptions", + "documentation":"

The array of OutputDescription objects describing the destination streams used by the application.

" + }, + "ReferenceDataSourceDescriptions":{ + "shape":"ReferenceDataSourceDescriptions", + "documentation":"

The array of ReferenceDataSourceDescription objects describing the reference data sources used by the application.

" + } + }, + "documentation":"

Describes the inputs, outputs, and reference data sources for an SQL-based Kinesis Data Analytics application.

" + }, + "SqlApplicationConfigurationUpdate":{ + "type":"structure", + "members":{ + "InputUpdates":{ + "shape":"InputUpdates", + "documentation":"

The array of InputUpdate objects describing the new input streams used by the application.

" + }, + "OutputUpdates":{ + "shape":"OutputUpdates", + "documentation":"

The array of OutputUpdate objects describing the new destination streams used by the application.

" + }, + "ReferenceDataSourceUpdates":{ + "shape":"ReferenceDataSourceUpdates", + "documentation":"

The array of ReferenceDataSourceUpdate objects describing the new reference data sources used by the application.

" + } + }, + "documentation":"

Describes updates to the input streams, destination streams, and reference data sources for an SQL-based Kinesis Data Analytics application.

" + }, + "SqlRunConfiguration":{ + "type":"structure", + "required":[ + "InputId", + "InputStartingPositionConfiguration" + ], + "members":{ + "InputId":{ + "shape":"Id", + "documentation":"

The input source ID. You can get this ID by calling the DescribeApplication operation.

" + }, + "InputStartingPositionConfiguration":{ + "shape":"InputStartingPositionConfiguration", + "documentation":"

The point at which you want the application to start processing records from the streaming source.

" + } + }, + "documentation":"

Describes the starting parameters for an SQL-based Kinesis Data Analytics application.

" + }, + "SqlRunConfigurations":{ + "type":"list", + "member":{"shape":"SqlRunConfiguration"} + }, + "StartApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "RunConfiguration" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application.

" + }, + "RunConfiguration":{ + "shape":"RunConfiguration", + "documentation":"

Identifies the run configuration (start parameters) of a Kinesis Data Analytics application.

" + } + } + }, + "StartApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "StopApplicationRequest":{ + "type":"structure", + "required":["ApplicationName"], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the running application to stop.

" + } + } + }, + "StopApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the key-value tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the key-value tag. The value is optional.

" + } + }, + "documentation":"

A key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management Guide.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the application to assign the tags.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The key-value tags to assign to the application.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":1 + }, + "TextContent":{ + "type":"string", + "max":102400, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Application created with too many tags, or too many tags added to an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50.

", + "exception":true + }, + "UnableToDetectSchemaException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "RawInputRecords":{ + "shape":"RawInputRecords", + "documentation":"

Raw stream data that was sampled to infer the schema.

" + }, + "ProcessedInputRecords":{ + "shape":"ProcessedInputRecords", + "documentation":"

Stream data that was modified by the processor specified in the InputProcessingConfiguration parameter.

" + } + }, + "documentation":"

The data format is not valid. Amazon Kinesis Data Analytics cannot detect the schema for the given streaming source.

", + "exception":true + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"KinesisAnalyticsARN", + "documentation":"

The ARN of the Kinesis Analytics application from which to remove the tags.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of keys of tags to remove from the specified application.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateApplicationRequest":{ + "type":"structure", + "required":[ + "ApplicationName", + "CurrentApplicationVersionId" + ], + "members":{ + "ApplicationName":{ + "shape":"ApplicationName", + "documentation":"

The name of the application to update.

" + }, + "CurrentApplicationVersionId":{ + "shape":"ApplicationVersionId", + "documentation":"

The current application version ID. You can retrieve the application version ID using DescribeApplication.

" + }, + "ApplicationConfigurationUpdate":{ + "shape":"ApplicationConfigurationUpdate", + "documentation":"

Describes application configuration updates.

" + }, + "ServiceExecutionRoleUpdate":{ + "shape":"RoleARN", + "documentation":"

Describes updates to the service execution role.

" + }, + "RunConfigurationUpdate":{ + "shape":"RunConfigurationUpdate", + "documentation":"

Describes updates to the application's starting parameters.

" + }, + "CloudWatchLoggingOptionUpdates":{ + "shape":"CloudWatchLoggingOptionUpdates", + "documentation":"

Describes application Amazon CloudWatch logging option updates. You can only update existing CloudWatch logging options with this action. To add a new CloudWatch logging option, use AddApplicationCloudWatchLoggingOption.

" + } + } + }, + "UpdateApplicationResponse":{ + "type":"structure", + "required":["ApplicationDetail"], + "members":{ + "ApplicationDetail":{ + "shape":"ApplicationDetail", + "documentation":"

Describes application updates.

" + } + } + }, + "ZipFileContent":{ + "type":"blob", + "max":52428800, + "min":0 + } + }, + "documentation":"

Amazon Kinesis Data Analytics is a fully managed service that you can use to process and analyze streaming data using SQL or Java. The service enables you to quickly author and run SQL or Java code against streaming sources to perform time series analytics, feed real-time dashboards, and create real-time metrics.

" +} diff --git a/aws/dist/botocore/data/kinesisvideo/2017-09-30/paginators-1.json b/aws/dist/botocore/data/kinesisvideo/2017-09-30/paginators-1.json new file mode 100644 index 00000000..bb58205d --- /dev/null +++ b/aws/dist/botocore/data/kinesisvideo/2017-09-30/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListStreams": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StreamInfoList" + } + } +} diff --git a/aws/dist/botocore/data/kinesisvideo/2017-09-30/service-2.json b/aws/dist/botocore/data/kinesisvideo/2017-09-30/service-2.json new file mode 100644 index 00000000..88eb1aca --- /dev/null +++ b/aws/dist/botocore/data/kinesisvideo/2017-09-30/service-2.json @@ -0,0 +1,736 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-30", + "endpointPrefix":"kinesisvideo", + "protocol":"rest-json", + "serviceAbbreviation":"Kinesis Video", + "serviceFullName":"Amazon Kinesis Video Streams", + "serviceId":"Kinesis Video", + "signatureVersion":"v4", + "uid":"kinesisvideo-2017-09-30" + }, + "operations":{ + "CreateStream":{ + "name":"CreateStream", + "http":{ + "method":"POST", + "requestUri":"/createStream" + }, + "input":{"shape":"CreateStreamInput"}, + "output":{"shape":"CreateStreamOutput"}, + "errors":[ + {"shape":"AccountStreamLimitExceededException"}, + {"shape":"DeviceStreamLimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidDeviceException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"TagsPerResourceExceededLimitException"} + ], + "documentation":"

Creates a new Kinesis video stream.

When you create a new stream, Kinesis Video Streams assigns it a version number. When you change the stream's metadata, Kinesis Video Streams updates the version.

CreateStream is an asynchronous operation.

For information about how the service works, see How it Works.

You must have permissions for the KinesisVideo:CreateStream action.

" + }, + "DeleteStream":{ + "name":"DeleteStream", + "http":{ + "method":"POST", + "requestUri":"/deleteStream" + }, + "input":{"shape":"DeleteStreamInput"}, + "output":{"shape":"DeleteStreamOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"VersionMismatchException"} + ], + "documentation":"

Deletes a Kinesis video stream and the data contained in the stream.

This method marks the stream for deletion, and makes the data in the stream inaccessible immediately.

To ensure that you have the latest version of the stream before deleting it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

This operation requires permission for the KinesisVideo:DeleteStream action.

" + }, + "DescribeStream":{ + "name":"DescribeStream", + "http":{ + "method":"POST", + "requestUri":"/describeStream" + }, + "input":{"shape":"DescribeStreamInput"}, + "output":{"shape":"DescribeStreamOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Returns the most current information about the specified stream. You must specify either the StreamName or the StreamARN.

" + }, + "GetDataEndpoint":{ + "name":"GetDataEndpoint", + "http":{ + "method":"POST", + "requestUri":"/getDataEndpoint" + }, + "input":{"shape":"GetDataEndpointInput"}, + "output":{"shape":"GetDataEndpointOutput"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ClientLimitExceededException"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Gets an endpoint for a specified stream for either reading or writing. Use this endpoint in your application to read from the specified stream (using the GetMedia or GetMediaForFragmentList operations) or write to it (using the PutMedia operation).

The returned endpoint does not have the API name appended. The client needs to add the API name to the returned endpoint.

In the request, specify the stream either by StreamName or StreamARN.

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/listStreams" + }, + "input":{"shape":"ListStreamsInput"}, + "output":{"shape":"ListStreamsOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

Returns an array of StreamInfo objects. Each object describes a stream. To retrieve only streams that satisfy a specific condition, you can specify a StreamNameCondition.

" + }, + "ListTagsForStream":{ + "name":"ListTagsForStream", + "http":{ + "method":"POST", + "requestUri":"/listTagsForStream" + }, + "input":{"shape":"ListTagsForStreamInput"}, + "output":{"shape":"ListTagsForStreamOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidResourceFormatException"} + ], + "documentation":"

Returns a list of tags associated with the specified stream.

In the request, you must specify either the StreamName or the StreamARN.

" + }, + "TagStream":{ + "name":"TagStream", + "http":{ + "method":"POST", + "requestUri":"/tagStream" + }, + "input":{"shape":"TagStreamInput"}, + "output":{"shape":"TagStreamOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidResourceFormatException"}, + {"shape":"TagsPerResourceExceededLimitException"} + ], + "documentation":"

Adds one or more tags to a stream. A tag is a key-value pair (the value is optional) that you can define and assign to AWS resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

You must provide either the StreamName or the StreamARN.

This operation requires permission for the KinesisVideo:TagStream action.

Kinesis video streams support up to 50 tags.

" + }, + "UntagStream":{ + "name":"UntagStream", + "http":{ + "method":"POST", + "requestUri":"/untagStream" + }, + "input":{"shape":"UntagStreamInput"}, + "output":{"shape":"UntagStreamOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidResourceFormatException"} + ], + "documentation":"

Removes one or more tags from a stream. In the request, specify only a tag key or keys; don't specify the value. If you specify a tag key that does not exist, it's ignored.

In the request, you must provide the StreamName or StreamARN.

" + }, + "UpdateDataRetention":{ + "name":"UpdateDataRetention", + "http":{ + "method":"POST", + "requestUri":"/updateDataRetention" + }, + "input":{"shape":"UpdateDataRetentionInput"}, + "output":{"shape":"UpdateDataRetentionOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"VersionMismatchException"} + ], + "documentation":"

Increases or decreases the stream's data retention period by the value that you specify. To indicate whether you want to increase or decrease the data retention period, specify the Operation parameter in the request body. In the request, you must specify either the StreamName or the StreamARN.

The retention period that you specify replaces the current value.

This operation requires permission for the KinesisVideo:UpdateDataRetention action.

Changing the data retention period affects the data in the stream as follows:

  • If the data retention period is increased, existing data is retained for the new retention period. For example, if the data retention period is increased from one hour to seven hours, all existing data is retained for seven hours.

  • If the data retention period is decreased, existing data is retained for the new retention period. For example, if the data retention period is decreased from seven hours to one hour, all existing data is retained for one hour, and any data older than one hour is deleted immediately.

" + }, + "UpdateStream":{ + "name":"UpdateStream", + "http":{ + "method":"POST", + "requestUri":"/updateStream" + }, + "input":{"shape":"UpdateStreamInput"}, + "output":{"shape":"UpdateStreamOutput"}, + "errors":[ + {"shape":"ClientLimitExceededException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"NotAuthorizedException"}, + {"shape":"VersionMismatchException"} + ], + "documentation":"

Updates stream metadata, such as the device name and media type.

You must provide the stream name or the Amazon Resource Name (ARN) of the stream.

To make sure that you have the latest version of the stream before updating it, you can specify the stream version. Kinesis Video Streams assigns a version to each stream. When you update a stream, Kinesis Video Streams assigns a new version number. To get the latest stream version, use the DescribeStream API.

UpdateStream is an asynchronous operation, and takes time to complete.

" + } + }, + "shapes":{ + "APIName":{ + "type":"string", + "enum":[ + "PUT_MEDIA", + "GET_MEDIA", + "LIST_FRAGMENTS", + "GET_MEDIA_FOR_FRAGMENT_LIST", + "GET_HLS_STREAMING_SESSION_URL", + "GET_DASH_STREAMING_SESSION_URL" + ] + }, + "AccountStreamLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The number of streams created for the account is too high.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ClientLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ComparisonOperator":{ + "type":"string", + "enum":["BEGINS_WITH"] + }, + "CreateStreamInput":{ + "type":"structure", + "required":["StreamName"], + "members":{ + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

" + }, + "MediaType":{ + "shape":"MediaType", + "documentation":"

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements for guidelines.

This parameter is optional; the default value is null (or empty in JSON).

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey.

" + }, + "DataRetentionInHours":{ + "shape":"DataRetentionInHours", + "documentation":"

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

" + }, + "Tags":{ + "shape":"ResourceTags", + "documentation":"

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

" + } + } + }, + "CreateStreamOutput":{ + "type":"structure", + "members":{ + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream.

" + } + } + }, + "DataEndpoint":{"type":"string"}, + "DataRetentionChangeInHours":{ + "type":"integer", + "min":1 + }, + "DataRetentionInHours":{ + "type":"integer", + "min":0 + }, + "DeleteStreamInput":{ + "type":"structure", + "required":["StreamARN"], + "members":{ + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream that you want to delete.

" + }, + "CurrentVersion":{ + "shape":"Version", + "documentation":"

Optional: The version of the stream that you want to delete.

Specify the version as a safeguard to ensure that your are deleting the correct stream. To get the stream version, use the DescribeStream API.

If not specified, only the CreationTime is checked before deleting the stream.

" + } + } + }, + "DeleteStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeStreamInput":{ + "type":"structure", + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream.

" + } + } + }, + "DescribeStreamOutput":{ + "type":"structure", + "members":{ + "StreamInfo":{ + "shape":"StreamInfo", + "documentation":"

An object that describes the stream.

" + } + } + }, + "DeviceName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "DeviceStreamLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Not implemented.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "GetDataEndpointInput":{ + "type":"structure", + "required":["APIName"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamARN in the request.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream that you want to get the endpoint for. You must specify either this parameter or a StreamName in the request.

" + }, + "APIName":{ + "shape":"APIName", + "documentation":"

The name of the API action for which to get an endpoint.

" + } + } + }, + "GetDataEndpointOutput":{ + "type":"structure", + "members":{ + "DataEndpoint":{ + "shape":"DataEndpoint", + "documentation":"

The endpoint value. To read data from the stream or to write data to it, specify this endpoint in your application.

" + } + } + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The value for this input parameter is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidDeviceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Not implemented.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResourceFormatException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The format of the StreamARN is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":1 + }, + "ListStreamsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListStreamsInputLimit", + "documentation":"

The maximum number of streams to return in the response. The default is 10,000.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If you specify this parameter, when the result of a ListStreams operation is truncated, the call returns the NextToken in the response. To get another batch of streams, provide this token in your next request.

" + }, + "StreamNameCondition":{ + "shape":"StreamNameCondition", + "documentation":"

Optional: Returns only streams that satisfy a specific condition. Currently, you can specify only the prefix of a stream name as a condition.

" + } + } + }, + "ListStreamsInputLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ListStreamsOutput":{ + "type":"structure", + "members":{ + "StreamInfoList":{ + "shape":"StreamInfoList", + "documentation":"

An array of StreamInfo objects.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, the call returns this element with a token. To get the next batch of streams, use this token in your next request.

" + } + } + }, + "ListTagsForStreamInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If you specify this parameter and the result of a ListTagsForStream call is truncated, the response includes a token that you can use in the next request to fetch the next batch of tags.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream that you want to list tags for.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream that you want to list tags for.

" + } + } + }, + "ListTagsForStreamOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

If you specify this parameter and the result of a ListTags call is truncated, the response includes a token that you can use in the next request to fetch the next set of tags.

" + }, + "Tags":{ + "shape":"ResourceTags", + "documentation":"

A map of tag keys and values associated with the specified stream.

" + } + } + }, + "MediaType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+(,[\\w\\-\\.\\+]+/[\\w\\-\\.\\+]+)*" + }, + "NextToken":{ + "type":"string", + "max":512, + "min":0 + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The caller is not authorized to perform this operation.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "ResourceARN":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:aws:kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+" + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The stream is currently not available for this operation.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Amazon Kinesis Video Streams can't find the stream that you specified.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceTags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "Status":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING" + ] + }, + "StreamInfo":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of the device that is associated with the stream.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream.

" + }, + "MediaType":{ + "shape":"MediaType", + "documentation":"

The MediaType of the stream.

" + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video Streams uses to encrypt data on the stream.

" + }, + "Version":{ + "shape":"Version", + "documentation":"

The version of the stream.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the stream.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

A time stamp that indicates when the stream was created.

" + }, + "DataRetentionInHours":{ + "shape":"DataRetentionInHours", + "documentation":"

How long the stream retains data, in hours.

" + } + }, + "documentation":"

An object describing a Kinesis video stream.

" + }, + "StreamInfoList":{ + "type":"list", + "member":{"shape":"StreamInfo"} + }, + "StreamName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "StreamNameCondition":{ + "type":"structure", + "members":{ + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

A comparison operator. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

" + }, + "ComparisonValue":{ + "shape":"StreamName", + "documentation":"

A value to compare.

" + } + }, + "documentation":"

Specifies the condition that streams must satisfy to be returned when you list streams (see the ListStreams API). A condition has a comparison operation and a value. Currently, you can specify only the BEGINS_WITH operator, which finds streams whose names start with a given prefix.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagStreamInput":{ + "type":"structure", + "required":["Tags"], + "members":{ + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to add the tag or tags to.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream that you want to add the tag or tags to.

" + }, + "Tags":{ + "shape":"ResourceTags", + "documentation":"

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

" + } + } + }, + "TagStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TagsPerResourceExceededLimitException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You have exceeded the limit of tags that you can associate with the resource. Kinesis video streams support up to 50 tags.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UntagStreamInput":{ + "type":"structure", + "required":["TagKeyList"], + "members":{ + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream that you want to remove tags from.

" + }, + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream that you want to remove tags from.

" + }, + "TagKeyList":{ + "shape":"TagKeyList", + "documentation":"

A list of the keys of the tags that you want to remove.

" + } + } + }, + "UntagStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateDataRetentionInput":{ + "type":"structure", + "required":[ + "CurrentVersion", + "Operation", + "DataRetentionChangeInHours" + ], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream whose retention period you want to change.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The Amazon Resource Name (ARN) of the stream whose retention period you want to change.

" + }, + "CurrentVersion":{ + "shape":"Version", + "documentation":"

The version of the stream whose retention period you want to change. To get the version, call either the DescribeStream or the ListStreams API.

" + }, + "Operation":{ + "shape":"UpdateDataRetentionOperation", + "documentation":"

Indicates whether you want to increase or decrease the retention period.

" + }, + "DataRetentionChangeInHours":{ + "shape":"DataRetentionChangeInHours", + "documentation":"

The retention period, in hours. The value you specify replaces the current value. The maximum value for this parameter is 87600 (ten years).

" + } + } + }, + "UpdateDataRetentionOperation":{ + "type":"string", + "enum":[ + "INCREASE_DATA_RETENTION", + "DECREASE_DATA_RETENTION" + ] + }, + "UpdateDataRetentionOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateStreamInput":{ + "type":"structure", + "required":["CurrentVersion"], + "members":{ + "StreamName":{ + "shape":"StreamName", + "documentation":"

The name of the stream whose metadata you want to update.

The stream name is an identifier for the stream, and must be unique for each account and region.

" + }, + "StreamARN":{ + "shape":"ResourceARN", + "documentation":"

The ARN of the stream whose metadata you want to update.

" + }, + "CurrentVersion":{ + "shape":"Version", + "documentation":"

The version of the stream whose metadata you want to update.

" + }, + "DeviceName":{ + "shape":"DeviceName", + "documentation":"

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

" + }, + "MediaType":{ + "shape":"MediaType", + "documentation":"

The stream's media type. Use MediaType to specify the type of content that the stream contains to the consumers of the stream. For more information about media types, see Media Types. If you choose to specify the MediaType, see Naming Requirements.

To play video on the console, you must specify the correct video type. For example, if the video in the stream is H.264, specify video/h264 as the MediaType.

" + } + } + }, + "UpdateStreamOutput":{ + "type":"structure", + "members":{ + } + }, + "Version":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9]+" + }, + "VersionMismatchException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The stream version that you specified is not the latest version. To get the latest version, use the DescribeStream API.

", + "error":{"httpStatusCode":400}, + "exception":true + } + }, + "documentation":"

" +} diff --git a/aws/dist/botocore/data/kms/2014-11-01/examples-1.json b/aws/dist/botocore/data/kms/2014-11-01/examples-1.json new file mode 100644 index 00000000..feafe0b1 --- /dev/null +++ b/aws/dist/botocore/data/kms/2014-11-01/examples-1.json @@ -0,0 +1,815 @@ +{ + "version": "1.0", + "examples": { + "CancelKeyDeletion": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose deletion you are canceling. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyId": "The ARN of the CMK whose deletion you canceled." + } + }, + "description": "The following example cancels deletion of the specified CMK.", + "id": "to-cancel-deletion-of-a-cmk-1477428535102", + "title": "To cancel deletion of a customer master key (CMK)" + } + ], + "CreateAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "AliasName": "The alias to create. Aliases must begin with 'alias/'. Do not use aliases that begin with 'alias/aws' because they are reserved for use by AWS.", + "TargetKeyId": "The identifier of the CMK whose alias you are creating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example creates an alias for the specified customer master key (CMK).", + "id": "to-create-an-alias-1477505685119", + "title": "To create an alias" + } + ], + "CreateGrant": [ + { + "input": { + "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "Decrypt" + ] + }, + "output": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "GrantToken": "AQpAM2RhZTk1MGMyNTk2ZmZmMzEyYWVhOWViN2I1MWM4Mzc0MWFiYjc0ZDE1ODkyNGFlNTIzODZhMzgyZjBlNGY3NiKIAgEBAgB4Pa6VDCWW__MSrqnre1HIN0Grt00ViSSuUjhqOC8OT3YAAADfMIHcBgkqhkiG9w0BBwaggc4wgcsCAQAwgcUGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMmqLyBTAegIn9XlK5AgEQgIGXZQjkBcl1dykDdqZBUQ6L1OfUivQy7JVYO2-ZJP7m6f1g8GzV47HX5phdtONAP7K_HQIflcgpkoCqd_fUnE114mSmiagWkbQ5sqAVV3ov-VeqgrvMe5ZFEWLMSluvBAqdjHEdMIkHMlhlj4ENZbzBfo9Wxk8b8SnwP4kc4gGivedzFXo-dwN8fxjjq_ZZ9JFOj2ijIbj5FyogDCN0drOfi8RORSEuCEmPvjFRMFAwcmwFkN2NPp89amA" + }, + "comments": { + "input": { + "GranteePrincipal": "The identity that is given permission to perform the operations specified in the grant.", + "KeyId": "The identifier of the CMK to which the grant applies. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Operations": "A list of operations that the grant allows." + }, + "output": { + "GrantId": "The unique identifier of the grant.", + "GrantToken": "The grant token." + } + }, + "description": "The following example creates a grant that allows the specified IAM role to encrypt data with the specified customer master key (CMK).", + "id": "to-create-a-grant-1477972226782", + "title": "To create a grant" + } + ], + "CreateKey": [ + { + "output": { + "KeyMetadata": { + "AWSAccountId": "111122223333", + "Arn": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": "2016-11-01T10:15:42-07:00", + "Description": "", + "Enabled": true, + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyState": "Enabled", + "KeyUsage": "ENCRYPT_DECRYPT", + "Origin": "AWS_KMS" + } + }, + "comments": { + "output": { + "KeyMetadata": "An object that contains information about the CMK created by this operation." + } + }, + "description": "The following example creates a CMK.", + "id": "to-create-a-cmk-1478028992966", + "title": "To create a customer master key (CMK)" + } + ], + "Decrypt": [ + { + "input": { + "CiphertextBlob": "" + }, + "output": { + "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "comments": { + "input": { + "CiphertextBlob": "The encrypted data (ciphertext)." + }, + "output": { + "KeyId": "The Amazon Resource Name (ARN) of the CMK that was used to decrypt the data.", + "Plaintext": "The decrypted (plaintext) data." + } + }, + "description": "The following example decrypts data that was encrypted with a customer master key (CMK) in AWS KMS.", + "id": "to-decrypt-data-1478281622886", + "title": "To decrypt data" + } + ], + "DeleteAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias" + }, + "comments": { + "input": { + "AliasName": "The alias to delete." + } + }, + "description": "The following example deletes the specified alias.", + "id": "to-delete-an-alias-1478285209338", + "title": "To delete an alias" + } + ], + "DeleteImportedKeyMaterial": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example deletes the imported key material from the specified customer master key (CMK).", + "id": "to-delete-imported-key-material-1478561674507", + "title": "To delete imported key material" + } + ], + "DescribeKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyMetadata": { + "AWSAccountId": "111122223333", + "Arn": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "CreationDate": "2015-10-12T11:45:07-07:00", + "Description": "", + "Enabled": true, + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "KeyState": "Enabled", + "KeyUsage": "ENCRYPT_DECRYPT", + "Origin": "AWS_KMS" + } + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK that you want information about. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyMetadata": "An object that contains information about the specified CMK." + } + }, + "description": "The following example returns information (metadata) about the specified CMK.", + "id": "to-obtain-information-about-a-cmk-1478565820907", + "title": "To obtain information about a customer master key (CMK)" + } + ], + "DisableKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to disable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example disables the specified CMK.", + "id": "to-disable-a-cmk-1478566583659", + "title": "To disable a customer master key (CMK)" + } + ], + "DisableKeyRotation": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material will no longer be rotated. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example disables automatic annual rotation of the key material for the specified CMK.", + "id": "to-disable-automatic-rotation-of-key-material-1478624396092", + "title": "To disable automatic rotation of key material" + } + ], + "EnableKey": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to enable. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example enables the specified CMK.", + "id": "to-enable-a-cmk-1478627501129", + "title": "To enable a customer master key (CMK)" + } + ], + "EnableKeyRotation": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material will be rotated annually. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example enables automatic annual rotation of the key material for the specified CMK.", + "id": "to-enable-automatic-rotation-of-key-material-1478629109677", + "title": "To enable automatic rotation of key material" + } + ], + "Encrypt": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use for encryption. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "Plaintext": "The data to encrypt." + }, + "output": { + "CiphertextBlob": "The encrypted data (ciphertext).", + "KeyId": "The ARN of the CMK that was used to encrypt the data." + } + }, + "description": "The following example encrypts data with the specified customer master key (CMK).", + "id": "to-encrypt-data-1478906026012", + "title": "To encrypt data" + } + ], + "GenerateDataKey": [ + { + "input": { + "KeyId": "alias/ExampleAlias", + "KeySpec": "AES_256" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Plaintext": "" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "KeySpec": "Specifies the type of data key to return." + }, + "output": { + "CiphertextBlob": "The encrypted data key.", + "KeyId": "The ARN of the CMK that was used to encrypt the data key.", + "Plaintext": "The unencrypted (plaintext) data key." + } + }, + "description": "The following example generates a 256-bit symmetric data encryption key (data key) in two formats. One is the unencrypted (plainext) data key, and the other is the data key encrypted with the specified customer master key (CMK).", + "id": "to-generate-a-data-key-1478912956062", + "title": "To generate a data key" + } + ], + "GenerateDataKeyWithoutPlaintext": [ + { + "input": { + "KeyId": "alias/ExampleAlias", + "KeySpec": "AES_256" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to use to encrypt the data key. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK.", + "KeySpec": "Specifies the type of data key to return." + }, + "output": { + "CiphertextBlob": "The encrypted data key.", + "KeyId": "The ARN of the CMK that was used to encrypt the data key." + } + }, + "description": "The following example generates an encrypted copy of a 256-bit symmetric data encryption key (data key). The data key is encrypted with the specified customer master key (CMK).", + "id": "to-generate-an-encrypted-data-key-1478914121134", + "title": "To generate an encrypted data key" + } + ], + "GenerateRandom": [ + { + "input": { + "NumberOfBytes": 32 + }, + "output": { + "Plaintext": "" + }, + "comments": { + "input": { + "NumberOfBytes": "The length of the random data, specified in number of bytes." + }, + "output": { + "Plaintext": "The random data." + } + }, + "description": "The following example uses AWS KMS to generate 32 bytes of random data.", + "id": "to-generate-random-data-1479163645600", + "title": "To generate random data" + } + ], + "GetKeyPolicy": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "PolicyName": "default" + }, + "output": { + "Policy": "{\n \"Version\" : \"2012-10-17\",\n \"Id\" : \"key-default-1\",\n \"Statement\" : [ {\n \"Sid\" : \"Enable IAM User Permissions\",\n \"Effect\" : \"Allow\",\n \"Principal\" : {\n \"AWS\" : \"arn:aws:iam::111122223333:root\"\n },\n \"Action\" : \"kms:*\",\n \"Resource\" : \"*\"\n } ]\n}" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key policy you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "PolicyName": "The name of the key policy to retrieve." + }, + "output": { + "Policy": "The key policy document." + } + }, + "description": "The following example retrieves the key policy for the specified customer master key (CMK).", + "id": "to-retrieve-a-key-policy-1479170128325", + "title": "To retrieve a key policy" + } + ], + "GetKeyRotationStatus": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "KeyRotationEnabled": true + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key material rotation status you want to retrieve. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "KeyRotationEnabled": "A boolean that indicates the key material rotation status. Returns true when automatic annual rotation of the key material is enabled, or false when it is not." + } + }, + "description": "The following example retrieves the status of automatic annual rotation of the key material for the specified CMK.", + "id": "to-retrieve-the-rotation-status-for-a-cmk-1479172287408", + "title": "To retrieve the rotation status for a customer master key (CMK)" + } + ], + "GetParametersForImport": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "WrappingAlgorithm": "RSAES_OAEP_SHA_1", + "WrappingKeySpec": "RSA_2048" + }, + "output": { + "ImportToken": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "ParametersValidTo": "2016-12-01T14:52:17-08:00", + "PublicKey": "" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK for which to retrieve the public key and import token. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "WrappingAlgorithm": "The algorithm that you will use to encrypt the key material before importing it.", + "WrappingKeySpec": "The type of wrapping key (public key) to return in the response." + }, + "output": { + "ImportToken": "The import token to send with a subsequent ImportKeyMaterial request.", + "KeyId": "The ARN of the CMK for which you are retrieving the public key and import token. This is the same CMK specified in the request.", + "ParametersValidTo": "The time at which the import token and public key are no longer valid.", + "PublicKey": "The public key to use to encrypt the key material before importing it." + } + }, + "description": "The following example retrieves the public key and import token for the specified CMK.", + "id": "to-retrieve-the-public-key-and-import-token-for-a-cmk-1480626483211", + "title": "To retrieve the public key and import token for a customer master key (CMK)" + } + ], + "ImportKeyMaterial": [ + { + "input": { + "EncryptedKeyMaterial": "", + "ExpirationModel": "KEY_MATERIAL_DOES_NOT_EXPIRE", + "ImportToken": "", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "EncryptedKeyMaterial": "The encrypted key material to import.", + "ExpirationModel": "A value that specifies whether the key material expires.", + "ImportToken": "The import token that you received in the response to a previous GetParametersForImport request.", + "KeyId": "The identifier of the CMK to import the key material into. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example imports key material into the specified CMK.", + "id": "to-import-key-material-into-a-cmk-1480630551969", + "title": "To import key material into a customer master key (CMK)" + } + ], + "ListAliases": [ + { + "output": { + "Aliases": [ + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/acm", + "AliasName": "alias/aws/acm", + "TargetKeyId": "da03f6f7-d279-427a-9cae-de48d07e5b66" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/ebs", + "AliasName": "alias/aws/ebs", + "TargetKeyId": "25a217e7-7170-4b8c-8bf6-045ea5f70e5b" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/rds", + "AliasName": "alias/aws/rds", + "TargetKeyId": "7ec3104e-c3f2-4b5c-bf42-bfc4772c6685" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/redshift", + "AliasName": "alias/aws/redshift", + "TargetKeyId": "08f7a25a-69e2-4fb5-8f10-393db27326fa" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/aws/s3", + "AliasName": "alias/aws/s3", + "TargetKeyId": "d2b0f1a3-580d-4f79-b836-bc983be8cfa5" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example1", + "AliasName": "alias/example1", + "TargetKeyId": "4da1e216-62d0-46c5-a7c0-5f3a3d2f8046" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example2", + "AliasName": "alias/example2", + "TargetKeyId": "f32fef59-2cc2-445b-8573-2d73328acbee" + }, + { + "AliasArn": "arn:aws:kms:us-east-2:111122223333:alias/example3", + "AliasName": "alias/example3", + "TargetKeyId": "1374ef38-d34e-4d5f-b2c9-4e0daee38855" + } + ], + "Truncated": false + }, + "comments": { + "output": { + "Aliases": "A list of aliases, including the key ID of the customer master key (CMK) that each alias refers to.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists aliases.", + "id": "to-list-aliases-1480729693349", + "title": "To list aliases" + } + ], + "ListGrants": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "Grants": [ + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "91ad875e49b04a9d1f3bdeb84d821f9db6ea95e1098813f6d47f0c65fbe2a172", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "a5d67d3e207a8fc1f4928749ee3e52eb0440493a8b9cf05bbfad91655b056200", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "c541aaf05d90cb78846a73b346fc43e65be28b7163129488c738e0c9e0628f4f", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + }, + { + "CreationDate": "2016-10-25T14:37:41-07:00", + "GrantId": "dd2052c67b4c76ee45caf1dc6a1e2d24e8dc744a51b36ae2f067dc540ce0105c", + "GranteePrincipal": "acm.us-east-2.amazonaws.com", + "IssuingAccount": "arn:aws:iam::111122223333:root", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Encrypt", + "ReEncryptFrom", + "ReEncryptTo" + ], + "RetiringPrincipal": "acm.us-east-2.amazonaws.com" + } + ], + "Truncated": true + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose grants you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "Grants": "A list of grants.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists grants for the specified CMK.", + "id": "to-list-grants-for-a-cmk-1481067365389", + "title": "To list grants for a customer master key (CMK)" + } + ], + "ListKeyPolicies": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "output": { + "PolicyNames": [ + "default" + ], + "Truncated": false + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK whose key policies you want to list. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + }, + "output": { + "PolicyNames": "A list of key policy names.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists key policies for the specified CMK.", + "id": "to-list-key-policies-for-a-cmk-1481069780998", + "title": "To list key policies for a customer master key (CMK)" + } + ], + "ListKeys": [ + { + "output": { + "Keys": [ + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/0d990263-018e-4e65-a703-eff731de951e", + "KeyId": "0d990263-018e-4e65-a703-eff731de951e" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/144be297-0ae1-44ac-9c8f-93cd8c82f841", + "KeyId": "144be297-0ae1-44ac-9c8f-93cd8c82f841" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/21184251-b765-428e-b852-2c7353e72571", + "KeyId": "21184251-b765-428e-b852-2c7353e72571" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/214fe92f-5b03-4ae1-b350-db2a45dbe10c", + "KeyId": "214fe92f-5b03-4ae1-b350-db2a45dbe10c" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/339963f2-e523-49d3-af24-a0fe752aa458", + "KeyId": "339963f2-e523-49d3-af24-a0fe752aa458" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/b776a44b-df37-4438-9be4-a27494e4271a", + "KeyId": "b776a44b-df37-4438-9be4-a27494e4271a" + }, + { + "KeyArn": "arn:aws:kms:us-east-2:111122223333:key/deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb", + "KeyId": "deaf6c9e-cf2c-46a6-bf6d-0b6d487cffbb" + } + ], + "Truncated": false + }, + "comments": { + "output": { + "Keys": "A list of CMKs, including the key ID and Amazon Resource Name (ARN) of each one.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists CMKs.", + "id": "to-list-cmks-1481071643069", + "title": "To list customer master keys (CMKs)" + } + ], + "ListRetirableGrants": [ + { + "input": { + "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole" + }, + "output": { + "Grants": [ + { + "CreationDate": "2016-12-07T11:09:35-08:00", + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "GranteePrincipal": "arn:aws:iam::111122223333:role/ExampleRole", + "IssuingAccount": "arn:aws:iam::444455556666:root", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab", + "Operations": [ + "Decrypt", + "Encrypt" + ], + "RetiringPrincipal": "arn:aws:iam::111122223333:role/ExampleRole" + } + ], + "Truncated": false + }, + "comments": { + "input": { + "RetiringPrincipal": "The retiring principal whose grants you want to list. Use the Amazon Resource Name (ARN) of an AWS principal such as an AWS account (root), IAM user, federated user, or assumed role user." + }, + "output": { + "Grants": "A list of grants that the specified principal can retire.", + "Truncated": "A boolean that indicates whether there are more items in the list. Returns true when there are more items, or false when there are not." + } + }, + "description": "The following example lists the grants that the specified principal (identity) can retire.", + "id": "to-list-grants-that-the-specified-principal-can-retire-1481140499620", + "title": "To list grants that the specified principal can retire" + } + ], + "PutKeyPolicy": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "Policy": "{\n \"Version\": \"2012-10-17\",\n \"Id\": \"custom-policy-2016-12-07\",\n \"Statement\": [\n {\n \"Sid\": \"Enable IAM User Permissions\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:root\"\n },\n \"Action\": \"kms:*\",\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow access for Key Administrators\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": [\n \"arn:aws:iam::111122223333:user/ExampleAdminUser\",\n \"arn:aws:iam::111122223333:role/ExampleAdminRole\"\n ]\n },\n \"Action\": [\n \"kms:Create*\",\n \"kms:Describe*\",\n \"kms:Enable*\",\n \"kms:List*\",\n \"kms:Put*\",\n \"kms:Update*\",\n \"kms:Revoke*\",\n \"kms:Disable*\",\n \"kms:Get*\",\n \"kms:Delete*\",\n \"kms:ScheduleKeyDeletion\",\n \"kms:CancelKeyDeletion\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow use of the key\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:Encrypt\",\n \"kms:Decrypt\",\n \"kms:ReEncrypt*\",\n \"kms:GenerateDataKey*\",\n \"kms:DescribeKey\"\n ],\n \"Resource\": \"*\"\n },\n {\n \"Sid\": \"Allow attachment of persistent resources\",\n \"Effect\": \"Allow\",\n \"Principal\": {\n \"AWS\": \"arn:aws:iam::111122223333:role/ExamplePowerUserRole\"\n },\n \"Action\": [\n \"kms:CreateGrant\",\n \"kms:ListGrants\",\n \"kms:RevokeGrant\"\n ],\n \"Resource\": \"*\",\n \"Condition\": {\n \"Bool\": {\n \"kms:GrantIsForAWSResource\": \"true\"\n }\n }\n }\n ]\n}\n", + "PolicyName": "default" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to attach the key policy to. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "Policy": "The key policy document.", + "PolicyName": "The name of the key policy." + } + }, + "description": "The following example attaches a key policy to the specified CMK.", + "id": "to-attach-a-key-policy-to-a-cmk-1481147345018", + "title": "To attach a key policy to a customer master key (CMK)" + } + ], + "ReEncrypt": [ + { + "input": { + "CiphertextBlob": "", + "DestinationKeyId": "0987dcba-09fe-87dc-65ba-ab0987654321" + }, + "output": { + "CiphertextBlob": "", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/0987dcba-09fe-87dc-65ba-ab0987654321", + "SourceKeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "CiphertextBlob": "The data to reencrypt.", + "DestinationKeyId": "The identifier of the CMK to use to reencrypt the data. You can use the key ID or Amazon Resource Name (ARN) of the CMK, or the name or ARN of an alias that refers to the CMK." + }, + "output": { + "CiphertextBlob": "The reencrypted data.", + "KeyId": "The ARN of the CMK that was used to reencrypt the data.", + "SourceKeyId": "The ARN of the CMK that was used to originally encrypt the data." + } + }, + "description": "The following example reencrypts data with the specified CMK.", + "id": "to-reencrypt-data-1481230358001", + "title": "To reencrypt data" + } + ], + "RetireGrant": [ + { + "input": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "KeyId": "arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "GrantId": "The identifier of the grant to retire.", + "KeyId": "The Amazon Resource Name (ARN) of the customer master key (CMK) associated with the grant." + } + }, + "description": "The following example retires a grant.", + "id": "to-retire-a-grant-1481327028297", + "title": "To retire a grant" + } + ], + "RevokeGrant": [ + { + "input": { + "GrantId": "0c237476b39f8bc44e45212e08498fbe3151305030726c0590dd8d3e9f3d6a60", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "GrantId": "The identifier of the grant to revoke.", + "KeyId": "The identifier of the customer master key (CMK) associated with the grant. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example revokes a grant.", + "id": "to-revoke-a-grant-1481329549302", + "title": "To revoke a grant" + } + ], + "ScheduleKeyDeletion": [ + { + "input": { + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab", + "PendingWindowInDays": 7 + }, + "output": { + "DeletionDate": "2016-12-17T16:00:00-08:00", + "KeyId": "arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "KeyId": "The identifier of the CMK to schedule for deletion. You can use the key ID or the Amazon Resource Name (ARN) of the CMK.", + "PendingWindowInDays": "The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the CMK." + }, + "output": { + "DeletionDate": "The date and time after which AWS KMS deletes the CMK.", + "KeyId": "The ARN of the CMK that is scheduled for deletion." + } + }, + "description": "The following example schedules the specified CMK for deletion.", + "id": "to-schedule-a-cmk-for-deletion-1481331111094", + "title": "To schedule a customer master key (CMK) for deletion" + } + ], + "UpdateAlias": [ + { + "input": { + "AliasName": "alias/ExampleAlias", + "TargetKeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "AliasName": "The alias to update.", + "TargetKeyId": "The identifier of the CMK that the alias will refer to after this operation succeeds. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example updates the specified alias to refer to the specified customer master key (CMK).", + "id": "to-update-an-alias-1481572726920", + "title": "To update an alias" + } + ], + "UpdateKeyDescription": [ + { + "input": { + "Description": "Example description that indicates the intended use of this CMK.", + "KeyId": "1234abcd-12ab-34cd-56ef-1234567890ab" + }, + "comments": { + "input": { + "Description": "The updated description.", + "KeyId": "The identifier of the CMK whose description you are updating. You can use the key ID or the Amazon Resource Name (ARN) of the CMK." + } + }, + "description": "The following example updates the description of the specified CMK.", + "id": "to-update-the-description-of-a-cmk-1481574808619", + "title": "To update the description of a customer master key (CMK)" + } + ] + } +} diff --git a/aws/dist/botocore/data/kms/2014-11-01/paginators-1.json b/aws/dist/botocore/data/kms/2014-11-01/paginators-1.json new file mode 100644 index 00000000..522d171f --- /dev/null +++ b/aws/dist/botocore/data/kms/2014-11-01/paginators-1.json @@ -0,0 +1,32 @@ +{ + "pagination": { + "ListAliases": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Aliases" + }, + "ListGrants": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Grants" + }, + "ListKeyPolicies": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "PolicyNames" + }, + "ListKeys": { + "limit_key": "Limit", + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "Truncated", + "result_key": "Keys" + } + } +} diff --git a/aws/dist/botocore/data/kms/2014-11-01/service-2.json b/aws/dist/botocore/data/kms/2014-11-01/service-2.json new file mode 100644 index 00000000..715b236d --- /dev/null +++ b/aws/dist/botocore/data/kms/2014-11-01/service-2.json @@ -0,0 +1,2502 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-01", + "endpointPrefix":"kms", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"KMS", + "serviceFullName":"AWS Key Management Service", + "serviceId":"KMS", + "signatureVersion":"v4", + "targetPrefix":"TrentService", + "uid":"kms-2014-11-01" + }, + "operations":{ + "CancelKeyDeletion":{ + "name":"CancelKeyDeletion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelKeyDeletionRequest"}, + "output":{"shape":"CancelKeyDeletionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Cancels the deletion of a customer master key (CMK). When this operation is successful, the CMK is set to the Disabled state. To enable a CMK, use EnableKey. You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling and canceling deletion of a CMK, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "ConnectCustomKeyStore":{ + "name":"ConnectCustomKeyStore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConnectCustomKeyStoreRequest"}, + "output":{"shape":"ConnectCustomKeyStoreResponse"}, + "errors":[ + {"shape":"CloudHsmClusterNotActiveException"}, + {"shape":"CustomKeyStoreInvalidStateException"}, + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"CloudHsmClusterInvalidConfigurationException"} + ], + "documentation":"

Connects or reconnects a custom key store to its associated AWS CloudHSM cluster.

The custom key store must be connected before you can create customer master keys (CMKs) in the key store or use the CMKs it contains. You can disconnect and reconnect a custom key store at any time.

To connect a custom key store, its associated AWS CloudHSM cluster must have at least one active HSM. To get the number of active HSMs in a cluster, use the DescribeClusters operation. To add HSMs to the cluster, use the CreateHsm operation.

The connection process can take an extended amount of time to complete; up to 20 minutes. This operation starts the connection process, but it does not wait for it to complete. When it succeeds, this operation quickly returns an HTTP 200 response and a JSON object with no properties. However, this response does not indicate that the custom key store is connected. To get the connection state of the custom key store, use the DescribeCustomKeyStores operation.

During the connection process, AWS KMS finds the AWS CloudHSM cluster that is associated with the custom key store, creates the connection infrastructure, connects to the cluster, logs into the AWS CloudHSM client as the kmsuser crypto user (CU), and rotates its password.

The ConnectCustomKeyStore operation might fail for various reasons. To find the reason, use the DescribeCustomKeyStores operation and see the ConnectionErrorCode in the response. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

To fix the failure, use the DisconnectCustomKeyStore operation to disconnect the custom key store, correct the error, use the UpdateCustomKeyStore operation if necessary, and then use ConnectCustomKeyStore again.

If you are having trouble connecting or disconnecting a custom key store, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

" + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasRequest"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidAliasNameException"}, + {"shape":"KMSInternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Creates a display name for a customer managed customer master key (CMK). You can use an alias to identify a CMK in selected operations, such as Encrypt and GenerateDataKey.

Each CMK can have multiple aliases, but each alias points to only one CMK. The alias name must be unique in the AWS account and region. To simplify code that runs in multiple regions, use the same alias name, but point it to a different CMK in each region.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

The alias and the CMK it is mapped to must be in the same AWS account and the same region. You cannot perform this operation on an alias in a different AWS account.

To map an existing alias to a different CMK, call UpdateAlias.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "CreateCustomKeyStore":{ + "name":"CreateCustomKeyStore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomKeyStoreRequest"}, + "output":{"shape":"CreateCustomKeyStoreResponse"}, + "errors":[ + {"shape":"CloudHsmClusterInUseException"}, + {"shape":"CustomKeyStoreNameInUseException"}, + {"shape":"CloudHsmClusterNotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"CloudHsmClusterNotActiveException"}, + {"shape":"IncorrectTrustAnchorException"}, + {"shape":"CloudHsmClusterInvalidConfigurationException"} + ], + "documentation":"

Creates a custom key store that is associated with an AWS CloudHSM cluster that you own and manage.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

Before you create the custom key store, you must assemble the required elements, including an AWS CloudHSM cluster that fulfills the requirements for a custom key store. For details about the required elements, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide.

When the operation completes successfully, it returns the ID of the new custom key store. Before you can use your new custom key store, you need to use the ConnectCustomKeyStore operation to connect the new key store to its AWS CloudHSM cluster. Even if you are not going to use your custom key store immediately, you might want to connect it to verify that all settings are correct and then disconnect it until you are ready to use it.

For help with failures, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

" + }, + "CreateGrant":{ + "name":"CreateGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGrantRequest"}, + "output":{"shape":"CreateGrantResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidArnException"}, + {"shape":"KMSInternalException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"LimitExceededException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Adds a grant to a customer master key (CMK). The grant allows the grantee principal to use the CMK when the conditions specified in the grant are met. When setting permissions, grants are an alternative to key policies.

To create a grant that allows a cryptographic operation only when the encryption context in the operation request matches or includes a specified encryption context, use the Constraints parameter. For details, see GrantConstraints.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter. For more information about grants, see Grants in the AWS Key Management Service Developer Guide .

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "CreateKey":{ + "name":"CreateKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateKeyRequest"}, + "output":{"shape":"CreateKeyResponse"}, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidArnException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"KMSInternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"TagException"}, + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"CustomKeyStoreInvalidStateException"}, + {"shape":"CloudHsmClusterInvalidConfigurationException"} + ], + "documentation":"

Creates a customer managed customer master key (CMK) in your AWS account.

You can use a CMK to encrypt small amounts of data (up to 4096 bytes) directly. But CMKs are more commonly used to encrypt the data keys that are used to encrypt data.

To create a CMK for imported key material, use the Origin parameter with a value of EXTERNAL.

To create a CMK in a custom key store, use the CustomKeyStoreId parameter to specify the custom key store. You must also use the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs in different Availability Zones in the AWS Region.

You cannot use this operation to create a CMK in a different AWS account.

" + }, + "Decrypt":{ + "name":"Decrypt", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecryptRequest"}, + "output":{"shape":"DecryptResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"InvalidCiphertextException"}, + {"shape":"KeyUnavailableException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Decrypts ciphertext. Ciphertext is plaintext that has been previously encrypted by using any of the following operations:

Whenever possible, use key policies to give users permission to call the Decrypt operation on the CMK, instead of IAM policies. Otherwise, you might create an IAM user policy that gives the user Decrypt permission on all CMKs. This user could decrypt ciphertext that was encrypted by CMKs in other accounts if the key policy for the cross-account CMK permits it. If you must use an IAM policy for Decrypt permissions, limit the user to particular CMKs or particular trusted accounts.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAliasRequest"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Deletes the specified alias. You cannot perform this operation on an alias in a different AWS account.

Because an alias is not a property of a CMK, you can delete and change the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs, use the ListAliases operation.

Each CMK can have multiple aliases. To change the alias of a CMK, use DeleteAlias to delete the current alias and CreateAlias to create a new alias. To associate an existing alias with a different customer master key (CMK), call UpdateAlias.

" + }, + "DeleteCustomKeyStore":{ + "name":"DeleteCustomKeyStore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomKeyStoreRequest"}, + "output":{"shape":"DeleteCustomKeyStoreResponse"}, + "errors":[ + {"shape":"CustomKeyStoreHasCMKsException"}, + {"shape":"CustomKeyStoreInvalidStateException"}, + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"KMSInternalException"} + ], + "documentation":"

Deletes a custom key store. This operation does not delete the AWS CloudHSM cluster that is associated with the custom key store, or affect any users or keys in the cluster.

The custom key store that you delete cannot contain any AWS KMS customer master keys (CMKs). Before deleting the key store, verify that you will never need to use any of the CMKs in the key store for any cryptographic operations. Then, use ScheduleKeyDeletion to delete the AWS KMS customer master keys (CMKs) from the key store. When the scheduled waiting period expires, the ScheduleKeyDeletion operation deletes the CMKs. Then it makes a best effort to delete the key material from the associated cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.

After all CMKs are deleted from AWS KMS, use DisconnectCustomKeyStore to disconnect the key store from AWS KMS. Then, you can delete the custom key store.

Instead of deleting the custom key store, consider using DisconnectCustomKeyStore to disconnect it from AWS KMS. While the key store is disconnected, you cannot create or use the CMKs in the key store. But, you do not need to delete CMKs and you can reconnect a disconnected custom key store at any time.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

" + }, + "DeleteImportedKeyMaterial":{ + "name":"DeleteImportedKeyMaterial", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteImportedKeyMaterialRequest"}, + "errors":[ + {"shape":"InvalidArnException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

When the specified CMK is in the PendingDeletion state, this operation does not change the CMK's state. Otherwise, it changes the CMK's state to PendingImport.

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "DescribeCustomKeyStores":{ + "name":"DescribeCustomKeyStores", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomKeyStoresRequest"}, + "output":{"shape":"DescribeCustomKeyStoresResponse"}, + "errors":[ + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"KMSInternalException"} + ], + "documentation":"

Gets information about custom key stores in the account and region.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

By default, this operation returns information about all custom key stores in the account and region. To get only information about a particular custom key store, use either the CustomKeyStoreName or CustomKeyStoreId parameter (but not both).

To determine whether the custom key store is connected to its AWS CloudHSM cluster, use the ConnectionState element in the response. If an attempt to connect the custom key store failed, the ConnectionState value is FAILED and the ConnectionErrorCode element in the response indicates the cause of the failure. For help interpreting the ConnectionErrorCode, see CustomKeyStoresListEntry.

Custom key stores have a DISCONNECTED connection state if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If your custom key store state is CONNECTED but you are having trouble using it, make sure that its associated AWS CloudHSM cluster is active and contains the minimum number of HSMs required for the operation, if any.

For help repairing your custom key store, see the Troubleshooting Custom Key Stores topic in the AWS Key Management Service Developer Guide.

" + }, + "DescribeKey":{ + "name":"DescribeKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeKeyRequest"}, + "output":{"shape":"DescribeKeyResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"} + ], + "documentation":"

Provides detailed information about the specified customer master key (CMK).

You can use DescribeKey on a predefined AWS alias, that is, an AWS alias with no key ID. When you do, AWS KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

" + }, + "DisableKey":{ + "name":"DisableKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableKeyRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Sets the state of a customer master key (CMK) to disabled, thereby preventing its use for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide .

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "DisableKeyRotation":{ + "name":"DisableKeyRotation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableKeyRotationRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Disables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "DisconnectCustomKeyStore":{ + "name":"DisconnectCustomKeyStore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisconnectCustomKeyStoreRequest"}, + "output":{"shape":"DisconnectCustomKeyStoreResponse"}, + "errors":[ + {"shape":"CustomKeyStoreInvalidStateException"}, + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"KMSInternalException"} + ], + "documentation":"

Disconnects the custom key store from its associated AWS CloudHSM cluster. While a custom key store is disconnected, you can manage the custom key store and its customer master keys (CMKs), but you cannot create or use CMKs in the custom key store. You can reconnect the custom key store at any time.

While a custom key store is disconnected, all attempts to create customer master keys (CMKs) in the custom key store or to use existing CMKs in cryptographic operations will fail. This action can prevent users from storing and accessing sensitive data.

To find the connection state of a custom key store, use the DescribeCustomKeyStores operation. To reconnect a custom key store, use the ConnectCustomKeyStore operation.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

" + }, + "EnableKey":{ + "name":"EnableKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableKeyRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Sets the key state of a customer master key (CMK) to enabled. This allows you to use the CMK for cryptographic operations. You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "EnableKeyRotation":{ + "name":"EnableKeyRotation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableKeyRotationRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Enables automatic rotation of the key material for the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

You cannot enable automatic rotation of CMKs with imported key material or CMKs in a custom key store.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "Encrypt":{ + "name":"Encrypt", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EncryptRequest"}, + "output":{"shape":"EncryptResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"KeyUnavailableException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidKeyUsageException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Encrypts plaintext into ciphertext by using a customer master key (CMK). The Encrypt operation has two primary use cases:

  • You can encrypt up to 4 kilobytes (4096 bytes) of arbitrary data such as an RSA key, a database password, or other sensitive information.

  • You can use the Encrypt operation to move encrypted data from one AWS region to another. In the first region, generate a data key and use the plaintext key to encrypt the data. Then, in the new region, call the Encrypt method on same plaintext data key. Now, you can safely move the encrypted data and encrypted data key to the new region, and decrypt in the new region when necessary.

You don't need use this operation to encrypt a data key within a region. The GenerateDataKey and GenerateDataKeyWithoutPlaintext operations return an encrypted data key.

Also, you don't need to use this operation to encrypt data in your application. You can use the plaintext and encrypted data keys that the GenerateDataKey operation returns.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

" + }, + "GenerateDataKey":{ + "name":"GenerateDataKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateDataKeyRequest"}, + "output":{"shape":"GenerateDataKeyResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"KeyUnavailableException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidKeyUsageException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Generates a unique data key. This operation returns a plaintext copy of the data key and a copy that is encrypted under a customer master key (CMK) that you specify. You can use the plaintext key to encrypt your data outside of KMS and store the encrypted data key with the encrypted data.

GenerateDataKey returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.

To generate a data key, you need to specify the customer master key (CMK) that will be used to encrypt the data key. You must also specify the length of the data key using either the KeySpec or NumberOfBytes field (but not both). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use KeySpec. To perform this operation on a CMK in a different AWS account, specify the key ARN or alias ARN in the value of the KeyId parameter.

You will find the plaintext copy of the data key in the Plaintext field of the response, and the encrypted copy of the data key in the CiphertextBlob field.

We recommend that you use the following pattern to encrypt data locally in your application:

  1. Use the GenerateDataKey operation to get a data encryption key.

  2. Use the plaintext data key (returned in the Plaintext field of the response) to encrypt data locally, then erase the plaintext data key from memory.

  3. Store the encrypted data key (returned in the CiphertextBlob field of the response) alongside the locally encrypted data.

To decrypt data locally:

  1. Use the Decrypt operation to decrypt the encrypted data key. The operation returns a plaintext copy of the data key.

  2. Use the plaintext data key to decrypt data locally, then erase the plaintext data key from memory.

To get only an encrypted copy of the data key, use GenerateDataKeyWithoutPlaintext. To get a cryptographically secure random byte string, use GenerateRandom.

You can use the optional encryption context to add additional security to your encryption operation. When you specify an EncryptionContext in the GenerateDataKey operation, you must specify the same encryption context (a case-sensitive exact match) in your request to Decrypt the data key. Otherwise, the request to decrypt fails with an InvalidCiphertextException. For more information, see Encryption Context in the AWS Key Management Service Developer Guide .

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "GenerateDataKeyWithoutPlaintext":{ + "name":"GenerateDataKeyWithoutPlaintext", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateDataKeyWithoutPlaintextRequest"}, + "output":{"shape":"GenerateDataKeyWithoutPlaintextResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"KeyUnavailableException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidKeyUsageException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Generates a unique data key. This operation returns a data key that is encrypted under a customer master key (CMK) that you specify. GenerateDataKeyWithoutPlaintext is identical to GenerateDataKey except that returns only the encrypted copy of the data key.

Like GenerateDataKey, GenerateDataKeyWithoutPlaintext returns a unique data key for each request. The bytes in the key are not related to the caller or CMK that is used to encrypt the data key.

This operation is useful for systems that need to encrypt data at some point, but not immediately. When you need to encrypt the data, you call the Decrypt operation on the encrypted copy of the key.

It's also useful in distributed systems with different levels of trust. For example, you might store encrypted data in containers. One component of your system creates new containers and stores an encrypted data key with each container. Then, a different component puts the data into the containers. That component first decrypts the data key, uses the plaintext data key to encrypt data, puts the encrypted data into the container, and then destroys the plaintext data key. In this system, the component that creates the containers never sees the plaintext data key.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "GenerateRandom":{ + "name":"GenerateRandom", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateRandomRequest"}, + "output":{"shape":"GenerateRandomResponse"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"CustomKeyStoreInvalidStateException"} + ], + "documentation":"

Returns a random byte string that is cryptographically secure.

By default, the random byte string is generated in AWS KMS. To generate the byte string in the AWS CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.

For more information about entropy and random number generation, see the AWS Key Management Service Cryptographic Details whitepaper.

" + }, + "GetKeyPolicy":{ + "name":"GetKeyPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetKeyPolicyRequest"}, + "output":{"shape":"GetKeyPolicyResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

" + }, + "GetKeyRotationStatus":{ + "name":"GetKeyRotationStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetKeyRotationStatusRequest"}, + "output":{"shape":"GetKeyRotationStatusResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

  • Disabled: The key rotation status does not change when you disable a CMK. However, while the CMK is disabled, AWS KMS does not rotate the backing key.

  • Pending deletion: While a CMK is pending deletion, its key rotation status is false and AWS KMS does not rotate the backing key. If you cancel the deletion, the original key rotation status is restored.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

" + }, + "GetParametersForImport":{ + "name":"GetParametersForImport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParametersForImportRequest"}, + "output":{"shape":"GetParametersForImportResponse"}, + "errors":[ + {"shape":"InvalidArnException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Returns the items you need in order to import key material into AWS KMS from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

You must specify the key ID of the customer master key (CMK) into which you will import key material. This CMK's Origin must be EXTERNAL. You must also specify the wrapping algorithm and type of wrapping key (public key) that you will use to encrypt the key material. You cannot perform this operation on a CMK in a different AWS account.

This operation returns a public key and an import token. Use the public key to encrypt the key material. Store the import token to send with a subsequent ImportKeyMaterial request. The public key and import token from the same response must be used together. These items are valid for 24 hours. When they expire, they cannot be used for a subsequent ImportKeyMaterial request. To get new ones, send another GetParametersForImport request.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "ImportKeyMaterial":{ + "name":"ImportKeyMaterial", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportKeyMaterialRequest"}, + "output":{"shape":"ImportKeyMaterialResponse"}, + "errors":[ + {"shape":"InvalidArnException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"InvalidCiphertextException"}, + {"shape":"IncorrectKeyMaterialException"}, + {"shape":"ExpiredImportTokenException"}, + {"shape":"InvalidImportTokenException"} + ], + "documentation":"

Imports key material into an existing AWS KMS customer master key (CMK) that was created without key material. You cannot perform this operation on a CMK in a different AWS account. For more information about creating CMKs with no key material and then importing key material, see Importing Key Material in the AWS Key Management Service Developer Guide.

Before using this operation, call GetParametersForImport. Its response includes a public key and an import token. Use the public key to encrypt the key material. Then, submit the import token from the same GetParametersForImport response.

When calling this operation, you must specify the following values:

  • The key ID or key ARN of a CMK with no key material. Its Origin must be EXTERNAL.

    To create a CMK with no key material, call CreateKey and set the value of its Origin parameter to EXTERNAL. To get the Origin of a CMK, call DescribeKey.)

  • The encrypted key material. To get the public key to encrypt the key material, call GetParametersForImport.

  • The import token that GetParametersForImport returned. This token and the public key used to encrypt the key material must have come from the same response.

  • Whether the key material expires and if so, when. If you set an expiration date, you can change it only by reimporting the same key material and specifying a new expiration date. If the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. To use the CMK again, you must reimport the same key material.

When this operation is successful, the key state of the CMK changes from PendingImport to Enabled, and you can use the CMK. After you successfully import key material into a CMK, you can reimport the same key material into that CMK, but you cannot import different key material.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidMarkerException"}, + {"shape":"KMSInternalException"}, + {"shape":"InvalidArnException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Gets a list of aliases in the caller's AWS account and region. You cannot list aliases in other accounts. For more information about aliases, see CreateAlias.

By default, the ListAliases command returns all aliases in the account and region. To get only the aliases that point to a particular customer master key (CMK), use the KeyId parameter.

The ListAliases response can include aliases that you created and associated with your customer managed CMKs, and aliases that AWS created and associated with AWS managed CMKs in your account. You can recognize AWS aliases because their names have the format aws/<service-name>, such as aws/dynamodb.

The response might also include aliases that have no TargetKeyId field. These are predefined aliases that AWS has created but has not yet associated with a CMK. Aliases that AWS creates in your account, including predefined aliases, do not count against your AWS KMS aliases limit.

" + }, + "ListGrants":{ + "name":"ListGrants", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGrantsRequest"}, + "output":{"shape":"ListGrantsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidMarkerException"}, + {"shape":"InvalidArnException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Gets a list of all grants for the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

" + }, + "ListKeyPolicies":{ + "name":"ListKeyPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListKeyPoliciesRequest"}, + "output":{"shape":"ListKeyPoliciesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Gets the names of the key policies that are attached to a customer master key (CMK). This operation is designed to get policy names that you can use in a GetKeyPolicy operation. However, the only valid policy name is default. You cannot perform this operation on a CMK in a different AWS account.

" + }, + "ListKeys":{ + "name":"ListKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListKeysRequest"}, + "output":{"shape":"ListKeysResponse"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"InvalidMarkerException"} + ], + "documentation":"

Gets a list of all customer master keys (CMKs) in the caller's AWS account and region.

" + }, + "ListResourceTags":{ + "name":"ListResourceTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceTagsRequest"}, + "output":{"shape":"ListResourceTagsResponse"}, + "errors":[ + {"shape":"KMSInternalException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidMarkerException"} + ], + "documentation":"

Returns a list of all tags for the specified customer master key (CMK).

You cannot perform this operation on a CMK in a different AWS account.

" + }, + "ListRetirableGrants":{ + "name":"ListRetirableGrants", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRetirableGrantsRequest"}, + "output":{"shape":"ListGrantsResponse"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidMarkerException"}, + {"shape":"InvalidArnException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"} + ], + "documentation":"

Returns a list of all grants for which the grant's RetiringPrincipal matches the one specified.

A typical use is to list all grants that you are able to retire. To retire a grant, use RetireGrant.

" + }, + "PutKeyPolicy":{ + "name":"PutKeyPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutKeyPolicyRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"UnsupportedOperationException"}, + {"shape":"KMSInternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Attaches a key policy to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

For more information about key policies, see Key Policies in the AWS Key Management Service Developer Guide.

" + }, + "ReEncrypt":{ + "name":"ReEncrypt", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReEncryptRequest"}, + "output":{"shape":"ReEncryptResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DisabledException"}, + {"shape":"InvalidCiphertextException"}, + {"shape":"KeyUnavailableException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidKeyUsageException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Encrypts data on the server side with a new customer master key (CMK) without exposing the plaintext of the data on the client side. The data is first decrypted and then reencrypted. You can also use this operation to change the encryption context of a ciphertext.

You can reencrypt data using CMKs in different AWS accounts.

Unlike other operations, ReEncrypt is authorized twice, once as ReEncryptFrom on the source CMK and once as ReEncryptTo on the destination CMK. We recommend that you include the \"kms:ReEncrypt*\" permission in your key policies to permit reencryption from or to the CMK. This permission is automatically included in the key policy when you create a CMK through the console. But you must include it manually when you create a CMK programmatically or when you set a key policy with the PutKeyPolicy operation.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "RetireGrant":{ + "name":"RetireGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetireGrantRequest"}, + "errors":[ + {"shape":"InvalidArnException"}, + {"shape":"InvalidGrantTokenException"}, + {"shape":"InvalidGrantIdException"}, + {"shape":"NotFoundException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Retires a grant. To clean up, you can retire a grant when you're done using it. You should revoke a grant when you intend to actively deny operations that depend on it. The following are permitted to call this API:

  • The AWS account (root user) under which the grant was created

  • The RetiringPrincipal, if present in the grant

  • The GranteePrincipal, if RetireGrant is an operation specified in the grant

You must identify the grant to retire by its grant token or by a combination of the grant ID and the Amazon Resource Name (ARN) of the customer master key (CMK). A grant token is a unique variable-length base64-encoded string. A grant ID is a 64 character unique identifier of a grant. The CreateGrant operation returns both.

" + }, + "RevokeGrant":{ + "name":"RevokeGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeGrantRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"InvalidArnException"}, + {"shape":"InvalidGrantIdException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Revokes the specified grant for the specified customer master key (CMK). You can revoke a grant to actively deny operations that depend on it.

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

" + }, + "ScheduleKeyDeletion":{ + "name":"ScheduleKeyDeletion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScheduleKeyDeletionRequest"}, + "output":{"shape":"ScheduleKeyDeletionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Schedules the deletion of a customer master key (CMK). You may provide a waiting period, specified in days, before deletion occurs. If you do not provide a waiting period, the default period of 30 days is used. When this operation is successful, the key state of the CMK changes to PendingDeletion. Before the waiting period ends, you can use CancelKeyDeletion to cancel the deletion of the CMK. After the waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with it, including all aliases that refer to it.

Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is unrecoverable. To prevent the use of a CMK without deleting it, use DisableKey.

If you schedule deletion of a CMK from a custom key store, when the waiting period expires, ScheduleKeyDeletion deletes the CMK from AWS KMS. Then AWS KMS makes a best effort to delete the key material from the associated AWS CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups.

You cannot perform this operation on a CMK in a different AWS account.

For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"KMSInternalException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"LimitExceededException"}, + {"shape":"TagException"} + ], + "documentation":"

Adds or edits tags for a customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

You can only use a tag key once for each CMK. If you use the tag key again, AWS KMS replaces the current tag value with the specified value.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"KMSInternalException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"TagException"} + ], + "documentation":"

Removes the specified tags from the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAliasRequest"}, + "errors":[ + {"shape":"DependencyTimeoutException"}, + {"shape":"NotFoundException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Associates an existing alias with a different customer master key (CMK). Each CMK can have multiple aliases, but the aliases must be unique within the account and region. You cannot perform this operation on an alias in a different AWS account.

This operation works only on existing aliases. To change the alias of a CMK to a new value, use CreateAlias to create a new alias and DeleteAlias to delete the old alias.

Because an alias is not a property of a CMK, you can create, update, and delete the aliases of a CMK without affecting the CMK. Also, aliases do not appear in the response from the DescribeKey operation. To get the aliases of all CMKs in the account, use the ListAliases operation.

The alias name must begin with alias/ followed by a name, such as alias/ExampleAlias. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "UpdateCustomKeyStore":{ + "name":"UpdateCustomKeyStore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCustomKeyStoreRequest"}, + "output":{"shape":"UpdateCustomKeyStoreResponse"}, + "errors":[ + {"shape":"CustomKeyStoreNotFoundException"}, + {"shape":"CloudHsmClusterNotFoundException"}, + {"shape":"CloudHsmClusterNotRelatedException"}, + {"shape":"CustomKeyStoreInvalidStateException"}, + {"shape":"KMSInternalException"}, + {"shape":"CloudHsmClusterNotActiveException"}, + {"shape":"CloudHsmClusterInvalidConfigurationException"} + ], + "documentation":"

Changes the properties of a custom key store. Use the CustomKeyStoreId parameter to identify the custom key store you want to edit. Use the remaining parameters to change the properties of the custom key store.

You can only update a custom key store that is disconnected. To disconnect the custom key store, use DisconnectCustomKeyStore. To reconnect the custom key store after the update completes, use ConnectCustomKeyStore. To find the connection state of a custom key store, use the DescribeCustomKeyStores operation.

Use the parameters of UpdateCustomKeyStore to edit your keystore settings.

  • Use the NewCustomKeyStoreName parameter to change the friendly name of the custom key store to the value that you specify.

  • Use the KeyStorePassword parameter tell AWS KMS the current password of the kmsuser crypto user (CU) in the associated AWS CloudHSM cluster. You can use this parameter to fix connection failures that occur when AWS KMS cannot log into the associated cluster because the kmsuser password has changed. This value does not change the password in the AWS CloudHSM cluster.

  • Use the CloudHsmClusterId parameter to associate the custom key store with a different, but related, AWS CloudHSM cluster. You can use this parameter to repair a custom key store if its AWS CloudHSM cluster becomes corrupted or is deleted, or when you need to create or restore a cluster from a backup.

If the operation succeeds, it returns a JSON object with no properties.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

" + }, + "UpdateKeyDescription":{ + "name":"UpdateKeyDescription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateKeyDescriptionRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"InvalidArnException"}, + {"shape":"DependencyTimeoutException"}, + {"shape":"KMSInternalException"}, + {"shape":"KMSInvalidStateException"} + ], + "documentation":"

Updates the description of a customer master key (CMK). To see the description of a CMK, use DescribeKey.

You cannot perform this operation on a CMK in a different AWS account.

The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + } + }, + "shapes":{ + "AWSAccountIdType":{"type":"string"}, + "AlgorithmSpec":{ + "type":"string", + "enum":[ + "RSAES_PKCS1_V1_5", + "RSAES_OAEP_SHA_1", + "RSAES_OAEP_SHA_256" + ] + }, + "AliasList":{ + "type":"list", + "member":{"shape":"AliasListEntry"} + }, + "AliasListEntry":{ + "type":"structure", + "members":{ + "AliasName":{ + "shape":"AliasNameType", + "documentation":"

String that contains the alias. This value begins with alias/.

" + }, + "AliasArn":{ + "shape":"ArnType", + "documentation":"

String that contains the key ARN.

" + }, + "TargetKeyId":{ + "shape":"KeyIdType", + "documentation":"

String that contains the key identifier referred to by the alias.

" + } + }, + "documentation":"

Contains information about an alias.

" + }, + "AliasNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9:/_-]+$" + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because it attempted to create a resource that already exists.

", + "exception":true + }, + "ArnType":{ + "type":"string", + "max":2048, + "min":20 + }, + "BooleanType":{"type":"boolean"}, + "CancelKeyDeletionRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier for the customer master key (CMK) for which to cancel deletion.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "CancelKeyDeletionResponse":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier of the master key for which deletion is canceled.

" + } + } + }, + "CiphertextType":{ + "type":"blob", + "max":6144, + "min":1 + }, + "CloudHsmClusterIdType":{ + "type":"string", + "max":24, + "min":19 + }, + "CloudHsmClusterInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified AWS CloudHSM cluster is already associated with a custom key store or it shares a backup history with a cluster that is associated with a custom key store. Each custom key store must be associated with a different AWS CloudHSM cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

", + "exception":true + }, + "CloudHsmClusterInvalidConfigurationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the associated AWS CloudHSM cluster did not meet the configuration requirements for a custom key store.

  • The cluster must be configured with private subnets in at least two different Availability Zones in the Region.

  • The security group for the cluster (cloudhsm-cluster-<cluster-id>-sg) must include inbound rules and outbound rules that allow TCP traffic on ports 2223-2225. The Source in the inbound rules and the Destination in the outbound rules must match the security group ID. These rules are set by default when you create the cluster. Do not delete or change them. To get information about a particular security group, use the DescribeSecurityGroups operation.

  • The cluster must contain at least as many HSMs as the operation requires. To add HSMs, use the AWS CloudHSM CreateHsm operation.

    For the CreateCustomKeyStore, UpdateCustomKeyStore, and CreateKey operations, the AWS CloudHSM cluster must have at least two active HSMs, each in a different Availability Zone. For the ConnectCustomKeyStore operation, the AWS CloudHSM must contain at least one active HSM.

For information about the requirements for an AWS CloudHSM cluster that is associated with a custom key store, see Assemble the Prerequisites in the AWS Key Management Service Developer Guide. For information about creating a private subnet for an AWS CloudHSM cluster, see Create a Private Subnet in the AWS CloudHSM User Guide. For information about cluster security groups, see Configure a Default Security Group in the AWS CloudHSM User Guide .

", + "exception":true + }, + "CloudHsmClusterNotActiveException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the AWS CloudHSM cluster that is associated with the custom key store is not active. Initialize and activate the cluster and try the command again. For detailed instructions, see Getting Started in the AWS CloudHSM User Guide.

", + "exception":true + }, + "CloudHsmClusterNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID. Retry the request with a different cluster ID.

", + "exception":true + }, + "CloudHsmClusterNotRelatedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified AWS CloudHSM cluster has a different cluster certificate than the original cluster. You cannot use the operation to specify an unrelated cluster.

Specify a cluster that shares a backup history with the original cluster. This includes clusters that were created from a backup of the current cluster, and clusters that were created from the same backup that produced the current cluster.

Clusters that share a backup history have the same cluster certificate. To view the cluster certificate of a cluster, use the DescribeClusters operation.

", + "exception":true + }, + "ConnectCustomKeyStoreRequest":{ + "type":"structure", + "required":["CustomKeyStoreId"], + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Enter the key store ID of the custom key store that you want to connect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + } + } + }, + "ConnectCustomKeyStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "ConnectionErrorCodeType":{ + "type":"string", + "enum":[ + "INVALID_CREDENTIALS", + "CLUSTER_NOT_FOUND", + "NETWORK_ERRORS", + "INTERNAL_ERROR", + "INSUFFICIENT_CLOUDHSM_HSMS", + "USER_LOCKED_OUT" + ] + }, + "ConnectionStateType":{ + "type":"string", + "enum":[ + "CONNECTED", + "CONNECTING", + "FAILED", + "DISCONNECTED", + "DISCONNECTING" + ] + }, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "AliasName", + "TargetKeyId" + ], + "members":{ + "AliasName":{ + "shape":"AliasNameType", + "documentation":"

Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed CMKs.

" + }, + "TargetKeyId":{ + "shape":"KeyIdType", + "documentation":"

Identifies the CMK to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.

" + } + } + }, + "CreateCustomKeyStoreRequest":{ + "type":"structure", + "required":[ + "CustomKeyStoreName", + "CloudHsmClusterId", + "TrustAnchorCertificate", + "KeyStorePassword" + ], + "members":{ + "CustomKeyStoreName":{ + "shape":"CustomKeyStoreNameType", + "documentation":"

Specifies a friendly name for the custom key store. The name must be unique in your AWS account.

" + }, + "CloudHsmClusterId":{ + "shape":"CloudHsmClusterIdType", + "documentation":"

Identifies the AWS CloudHSM cluster for the custom key store. Enter the cluster ID of any active AWS CloudHSM cluster that is not already associated with a custom key store. To find the cluster ID, use the DescribeClusters operation.

" + }, + "TrustAnchorCertificate":{ + "shape":"TrustAnchorCertificateType", + "documentation":"

Enter the content of the trust anchor certificate for the cluster. This is the content of the customerCA.crt file that you created when you initialized the cluster.

" + }, + "KeyStorePassword":{ + "shape":"KeyStorePasswordType", + "documentation":"

Enter the password of the kmsuser crypto user (CU) account in the specified AWS CloudHSM cluster. AWS KMS logs into the cluster as this user to manage key material on your behalf.

This parameter tells AWS KMS the kmsuser account password; it does not change the password in the AWS CloudHSM cluster.

" + } + } + }, + "CreateCustomKeyStoreResponse":{ + "type":"structure", + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

A unique identifier for the new custom key store.

" + } + } + }, + "CreateGrantRequest":{ + "type":"structure", + "required":[ + "KeyId", + "GranteePrincipal", + "Operations" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier for the customer master key (CMK) that the grant applies to.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "GranteePrincipal":{ + "shape":"PrincipalIdType", + "documentation":"

The principal that is given permission to perform the operations that the grant permits.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, IAM roles, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

" + }, + "RetiringPrincipal":{ + "shape":"PrincipalIdType", + "documentation":"

The principal that is given permission to retire the grant by using RetireGrant operation.

To specify the principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax to use for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the AWS General Reference.

" + }, + "Operations":{ + "shape":"GrantOperationList", + "documentation":"

A list of operations that the grant permits.

" + }, + "Constraints":{ + "shape":"GrantConstraints", + "documentation":"

Allows a cryptographic operation only when the encryption context matches or includes the encryption context specified in this structure. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide .

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + }, + "Name":{ + "shape":"GrantNameType", + "documentation":"

A friendly name for identifying the grant. Use this value to prevent the unintended creation of duplicate grants when retrying this request.

When this value is absent, all CreateGrant requests result in a new grant with a unique GrantId even if all the supplied parameters are identical. This can result in unintended duplicates when you retry the CreateGrant request.

When this value is present, you can retry a CreateGrant request with identical parameters; if the grant already exists, the original GrantId is returned without creating a new grant. Note that the returned grant token is unique with every CreateGrant request, even when a duplicate GrantId is returned. All grant tokens obtained in this way can be used interchangeably.

" + } + } + }, + "CreateGrantResponse":{ + "type":"structure", + "members":{ + "GrantToken":{ + "shape":"GrantTokenType", + "documentation":"

The grant token.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + }, + "GrantId":{ + "shape":"GrantIdType", + "documentation":"

The unique identifier for the grant.

You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.

" + } + } + }, + "CreateKeyRequest":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyType", + "documentation":"

The key policy to attach to the CMK.

If you provide a key policy, it must meet the following criteria:

  • If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide .

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.

If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.

The key policy size limit is 32 kilobytes (32768 bytes).

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

" + }, + "KeyUsage":{ + "shape":"KeyUsageType", + "documentation":"

The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.

" + }, + "Origin":{ + "shape":"OriginType", + "documentation":"

The source of the key material for the CMK. You cannot change the origin after you create the CMK.

The default is AWS_KMS, which means AWS KMS creates the key material in its own key store.

When the parameter value is EXTERNAL, AWS KMS creates a CMK without key material so that you can import key material from your existing key management infrastructure. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide.

When the parameter value is AWS_CLOUDHSM, AWS KMS creates the CMK in an AWS KMS custom key store and creates its key material in the associated AWS CloudHSM cluster. You must also use the CustomKeyStoreId parameter to identify the custom key store.

" + }, + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Creates the CMK in the specified custom key store and the key material in its associated AWS CloudHSM cluster. To create a CMK in a custom key store, you must also specify the Origin parameter with a value of AWS_CLOUDHSM. The AWS CloudHSM cluster that is associated with the custom key store must have at least two active HSMs, each in a different Availability Zone in the Region.

To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

The response includes the custom key store ID and the ID of the AWS CloudHSM cluster.

This operation is part of the Custom Key Store feature feature in AWS KMS, which combines the convenience and extensive integration of AWS KMS with the isolation and control of a single-tenant key store.

" + }, + "BypassPolicyLockoutSafetyCheck":{ + "shape":"BooleanType", + "documentation":"

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide .

Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

Use this parameter to tag the CMK when it is created. Alternately, you can omit this parameter and instead tag the CMK after it is created using TagResource.

" + } + } + }, + "CreateKeyResponse":{ + "type":"structure", + "members":{ + "KeyMetadata":{ + "shape":"KeyMetadata", + "documentation":"

Metadata associated with the CMK.

" + } + } + }, + "CustomKeyStoreHasCMKsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the custom key store contains AWS KMS customer master keys (CMKs). After verifying that you do not need to use the CMKs, use the ScheduleKeyDeletion operation to delete the CMKs. After they are deleted, you can delete the custom key store.

", + "exception":true + }, + "CustomKeyStoreIdType":{ + "type":"string", + "max":64, + "min":1 + }, + "CustomKeyStoreInvalidStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because of the ConnectionState of the custom key store. To get the ConnectionState of a custom key store, use the DescribeCustomKeyStores operation.

This exception is thrown under the following conditions:

  • You requested the CreateKey or GenerateRandom operation in a custom key store that is not connected. These operations are valid only when the custom key store ConnectionState is CONNECTED.

  • You requested the UpdateCustomKeyStore or DeleteCustomKeyStore operation on a custom key store that is not disconnected. This operation is valid only when the custom key store ConnectionState is DISCONNECTED.

  • You requested the ConnectCustomKeyStore operation on a custom key store with a ConnectionState of DISCONNECTING or FAILED. This operation is valid for all other ConnectionState values.

", + "exception":true + }, + "CustomKeyStoreNameInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified custom key store name is already assigned to another custom key store in the account. Try again with a custom key store name that is unique in the account.

", + "exception":true + }, + "CustomKeyStoreNameType":{ + "type":"string", + "max":256, + "min":1 + }, + "CustomKeyStoreNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because AWS KMS cannot find a custom key store with the specified key store name or ID.

", + "exception":true + }, + "CustomKeyStoresList":{ + "type":"list", + "member":{"shape":"CustomKeyStoresListEntry"} + }, + "CustomKeyStoresListEntry":{ + "type":"structure", + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

A unique identifier for the custom key store.

" + }, + "CustomKeyStoreName":{ + "shape":"CustomKeyStoreNameType", + "documentation":"

The user-specified friendly name for the custom key store.

" + }, + "CloudHsmClusterId":{ + "shape":"CloudHsmClusterIdType", + "documentation":"

A unique identifier for the AWS CloudHSM cluster that is associated with the custom key store.

" + }, + "TrustAnchorCertificate":{ + "shape":"TrustAnchorCertificateType", + "documentation":"

The trust anchor certificate of the associated AWS CloudHSM cluster. When you initialize the cluster, you create this certificate and save it in the customerCA.crt file.

" + }, + "ConnectionState":{ + "shape":"ConnectionStateType", + "documentation":"

Indicates whether the custom key store is connected to its AWS CloudHSM cluster.

You can create and use CMKs in your custom key stores only when its connection state is CONNECTED.

The value is DISCONNECTED if the key store has never been connected or you use the DisconnectCustomKeyStore operation to disconnect it. If the value is CONNECTED but you are having trouble using the custom key store, make sure that its associated AWS CloudHSM cluster is active and contains at least one active HSM.

A value of FAILED indicates that an attempt to connect was unsuccessful. For help resolving a connection failure, see Troubleshooting a Custom Key Store in the AWS Key Management Service Developer Guide.

" + }, + "ConnectionErrorCode":{ + "shape":"ConnectionErrorCodeType", + "documentation":"

Describes the connection error. Valid values are:

  • CLUSTER_NOT_FOUND - AWS KMS cannot find the AWS CloudHSM cluster with the specified cluster ID.

  • INSUFFICIENT_CLOUDHSM_HSMS - The associated AWS CloudHSM cluster does not contain any active HSMs. To connect a custom key store to its AWS CloudHSM cluster, the cluster must contain at least one active HSM.

  • INTERNAL_ERROR - AWS KMS could not complete the request due to an internal error. Retry the request. For ConnectCustomKeyStore requests, disconnect the custom key store before trying to connect again.

  • INVALID_CREDENTIALS - AWS KMS does not have the correct password for the kmsuser crypto user in the AWS CloudHSM cluster.

  • NETWORK_ERRORS - Network errors are preventing AWS KMS from connecting to the custom key store.

  • USER_LOCKED_OUT - The kmsuser CU account is locked out of the associated AWS CloudHSM cluster due to too many failed password attempts. Before you can connect your custom key store to its AWS CloudHSM cluster, you must change the kmsuser account password and update the password value for the custom key store.

For help with connection failures, see Troubleshooting Custom Key Stores in the AWS Key Management Service Developer Guide.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date and time when the custom key store was created.

" + } + }, + "documentation":"

Contains information about each custom key store in the custom key store list.

" + }, + "DataKeySpec":{ + "type":"string", + "enum":[ + "AES_256", + "AES_128" + ] + }, + "DateType":{"type":"timestamp"}, + "DecryptRequest":{ + "type":"structure", + "required":["CiphertextBlob"], + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

Ciphertext to be decrypted. The blob includes metadata.

" + }, + "EncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

The encryption context. If this was specified in the Encrypt function, it must be specified here or the decryption operation will fail. For more information, see Encryption Context.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "DecryptResponse":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

ARN of the key used to perform the decryption. This value is returned if no errors are encountered during the operation.

" + }, + "Plaintext":{ + "shape":"PlaintextType", + "documentation":"

Decrypted plaintext data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + } + } + }, + "DeleteAliasRequest":{ + "type":"structure", + "required":["AliasName"], + "members":{ + "AliasName":{ + "shape":"AliasNameType", + "documentation":"

The alias to be deleted. The alias name must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

" + } + } + }, + "DeleteCustomKeyStoreRequest":{ + "type":"structure", + "required":["CustomKeyStoreId"], + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Enter the ID of the custom key store you want to delete. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + } + } + }, + "DeleteCustomKeyStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteImportedKeyMaterialRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

Identifies the CMK from which you are deleting imported key material. The Origin of the CMK must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "DependencyTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The system timed out while trying to fulfill the request. The request can be retried.

", + "exception":true, + "fault":true + }, + "DescribeCustomKeyStoresRequest":{ + "type":"structure", + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Gets only information about the specified custom key store. Enter the key store ID.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

" + }, + "CustomKeyStoreName":{ + "shape":"CustomKeyStoreNameType", + "documentation":"

Gets only information about the specified custom key store. Enter the friendly name of the custom key store.

By default, this operation gets information about all custom key stores in the account and region. To limit the output to a particular custom key store, you can use either the CustomKeyStoreId or CustomKeyStoreName parameter, but not both.

" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + } + } + }, + "DescribeCustomKeyStoresResponse":{ + "type":"structure", + "members":{ + "CustomKeyStores":{ + "shape":"CustomKeyStoresList", + "documentation":"

Contains metadata about each custom key store.

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "DescribeKeyRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

Describes the specified customer master key (CMK).

If you specify a predefined AWS alias (an AWS alias with no key ID), KMS associates the alias with an AWS managed CMK and returns its KeyId and Arn in the response.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "DescribeKeyResponse":{ + "type":"structure", + "members":{ + "KeyMetadata":{ + "shape":"KeyMetadata", + "documentation":"

Metadata associated with the key.

" + } + } + }, + "DescriptionType":{ + "type":"string", + "max":8192, + "min":0 + }, + "DisableKeyRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "DisableKeyRotationRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "DisabledException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified CMK is not enabled.

", + "exception":true + }, + "DisconnectCustomKeyStoreRequest":{ + "type":"structure", + "required":["CustomKeyStoreId"], + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Enter the ID of the custom key store you want to disconnect. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + } + } + }, + "DisconnectCustomKeyStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "EnableKeyRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "EnableKeyRotationRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "EncryptRequest":{ + "type":"structure", + "required":[ + "KeyId", + "Plaintext" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + }, + "Plaintext":{ + "shape":"PlaintextType", + "documentation":"

Data to be encrypted.

" + }, + "EncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

Name-value pair that specifies the encryption context to be used for authenticated encryption. If used here, the same value must be supplied to the Decrypt API or decryption will fail. For more information, see Encryption Context.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "EncryptResponse":{ + "type":"structure", + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

The encrypted plaintext. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The ID of the key used during encryption.

" + } + } + }, + "EncryptionContextKey":{"type":"string"}, + "EncryptionContextType":{ + "type":"map", + "key":{"shape":"EncryptionContextKey"}, + "value":{"shape":"EncryptionContextValue"} + }, + "EncryptionContextValue":{"type":"string"}, + "ErrorMessageType":{"type":"string"}, + "ExpirationModelType":{ + "type":"string", + "enum":[ + "KEY_MATERIAL_EXPIRES", + "KEY_MATERIAL_DOES_NOT_EXPIRE" + ] + }, + "ExpiredImportTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the provided import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

", + "exception":true + }, + "GenerateDataKeyRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

An identifier for the CMK that encrypts the data key.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + }, + "EncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" + }, + "NumberOfBytes":{ + "shape":"NumberOfBytesType", + "documentation":"

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

" + }, + "KeySpec":{ + "shape":"DataKeySpec", + "documentation":"

The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "GenerateDataKeyResponse":{ + "type":"structure", + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

The encrypted copy of the data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + }, + "Plaintext":{ + "shape":"PlaintextType", + "documentation":"

The plaintext data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded. Use this data key to encrypt your data outside of KMS. Then, remove it from memory as soon as possible.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the CMK that encrypted the data key.

" + } + } + }, + "GenerateDataKeyWithoutPlaintextRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the customer master key (CMK) that encrypts the data key.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + }, + "EncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

A set of key-value pairs that represents additional authenticated data.

For more information, see Encryption Context in the AWS Key Management Service Developer Guide.

" + }, + "KeySpec":{ + "shape":"DataKeySpec", + "documentation":"

The length of the data key. Use AES_128 to generate a 128-bit symmetric key, or AES_256 to generate a 256-bit symmetric key.

" + }, + "NumberOfBytes":{ + "shape":"NumberOfBytesType", + "documentation":"

The length of the data key in bytes. For example, use the value 64 to generate a 512-bit data key (64 bytes is 512 bits). For common key lengths (128-bit and 256-bit symmetric keys), we recommend that you use the KeySpec field instead of this one.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "GenerateDataKeyWithoutPlaintextResponse":{ + "type":"structure", + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

The encrypted data key. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the CMK that encrypted the data key.

" + } + } + }, + "GenerateRandomRequest":{ + "type":"structure", + "members":{ + "NumberOfBytes":{ + "shape":"NumberOfBytesType", + "documentation":"

The length of the byte string.

" + }, + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + } + } + }, + "GenerateRandomResponse":{ + "type":"structure", + "members":{ + "Plaintext":{ + "shape":"PlaintextType", + "documentation":"

The random byte string. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + } + } + }, + "GetKeyPolicyRequest":{ + "type":"structure", + "required":[ + "KeyId", + "PolicyName" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "PolicyName":{ + "shape":"PolicyNameType", + "documentation":"

Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

" + } + } + }, + "GetKeyPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyType", + "documentation":"

A key policy document in JSON format.

" + } + } + }, + "GetKeyRotationStatusRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "GetKeyRotationStatusResponse":{ + "type":"structure", + "members":{ + "KeyRotationEnabled":{ + "shape":"BooleanType", + "documentation":"

A Boolean value that specifies whether key rotation is enabled.

" + } + } + }, + "GetParametersForImportRequest":{ + "type":"structure", + "required":[ + "KeyId", + "WrappingAlgorithm", + "WrappingKeySpec" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the CMK into which you will import key material. The CMK's Origin must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "WrappingAlgorithm":{ + "shape":"AlgorithmSpec", + "documentation":"

The algorithm you will use to encrypt the key material before importing it with ImportKeyMaterial. For more information, see Encrypt the Key Material in the AWS Key Management Service Developer Guide.

" + }, + "WrappingKeySpec":{ + "shape":"WrappingKeySpec", + "documentation":"

The type of wrapping key (public key) to return in the response. Only 2048-bit RSA public keys are supported.

" + } + } + }, + "GetParametersForImportResponse":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the CMK to use in a subsequent ImportKeyMaterial request. This is the same CMK specified in the GetParametersForImport request.

" + }, + "ImportToken":{ + "shape":"CiphertextType", + "documentation":"

The import token to send in a subsequent ImportKeyMaterial request.

" + }, + "PublicKey":{ + "shape":"PlaintextType", + "documentation":"

The public key to use to encrypt the key material before importing it with ImportKeyMaterial.

" + }, + "ParametersValidTo":{ + "shape":"DateType", + "documentation":"

The time at which the import token and public key are no longer valid. After this time, you cannot use them to make an ImportKeyMaterial request and you must send another GetParametersForImport request to get new ones.

" + } + } + }, + "GrantConstraints":{ + "type":"structure", + "members":{ + "EncryptionContextSubset":{ + "shape":"EncryptionContextType", + "documentation":"

A list of key-value pairs that must be included in the encryption context of the cryptographic operation request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.

" + }, + "EncryptionContextEquals":{ + "shape":"EncryptionContextType", + "documentation":"

A list of key-value pairs that must match the encryption context in the cryptographic operation request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.

" + } + }, + "documentation":"

Use this structure to allow cryptographic operations in the grant only when the operation request includes the specified encryption context.

AWS KMS applies the grant constraints only when the grant allows a cryptographic operation that accepts an encryption context as input, such as the following.

AWS KMS does not apply the grant constraints to other operations, such as DescribeKey or ScheduleKeyDeletion.

In a cryptographic operation, the encryption context in the decryption operation must be an exact, case-sensitive match for the keys and values in the encryption context of the encryption operation. Only the order of the pairs can vary.

However, in a grant constraint, the key in each key-value pair is not case sensitive, but the value is case sensitive.

To avoid confusion, do not use multiple encryption context pairs that differ only by case. To require a fully case-sensitive encryption context, use the kms:EncryptionContext: and kms:EncryptionContextKeys conditions in an IAM or key policy. For details, see kms:EncryptionContext: in the AWS Key Management Service Developer Guide .

" + }, + "GrantIdType":{ + "type":"string", + "max":128, + "min":1 + }, + "GrantList":{ + "type":"list", + "member":{"shape":"GrantListEntry"} + }, + "GrantListEntry":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier for the customer master key (CMK) to which the grant applies.

" + }, + "GrantId":{ + "shape":"GrantIdType", + "documentation":"

The unique identifier for the grant.

" + }, + "Name":{ + "shape":"GrantNameType", + "documentation":"

The friendly name that identifies the grant. If a name was provided in the CreateGrant request, that name is returned. Otherwise this value is null.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date and time when the grant was created.

" + }, + "GranteePrincipal":{ + "shape":"PrincipalIdType", + "documentation":"

The principal that receives the grant's permissions.

" + }, + "RetiringPrincipal":{ + "shape":"PrincipalIdType", + "documentation":"

The principal that can retire the grant.

" + }, + "IssuingAccount":{ + "shape":"PrincipalIdType", + "documentation":"

The AWS account under which the grant was issued.

" + }, + "Operations":{ + "shape":"GrantOperationList", + "documentation":"

The list of operations permitted by the grant.

" + }, + "Constraints":{ + "shape":"GrantConstraints", + "documentation":"

A list of key-value pairs that must be present in the encryption context of certain subsequent operations that the grant allows.

" + } + }, + "documentation":"

Contains information about an entry in a list of grants.

" + }, + "GrantNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9:/_-]+$" + }, + "GrantOperation":{ + "type":"string", + "enum":[ + "Decrypt", + "Encrypt", + "GenerateDataKey", + "GenerateDataKeyWithoutPlaintext", + "ReEncryptFrom", + "ReEncryptTo", + "CreateGrant", + "RetireGrant", + "DescribeKey" + ] + }, + "GrantOperationList":{ + "type":"list", + "member":{"shape":"GrantOperation"} + }, + "GrantTokenList":{ + "type":"list", + "member":{"shape":"GrantTokenType"}, + "max":10, + "min":0 + }, + "GrantTokenType":{ + "type":"string", + "max":8192, + "min":1 + }, + "ImportKeyMaterialRequest":{ + "type":"structure", + "required":[ + "KeyId", + "ImportToken", + "EncryptedKeyMaterial" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The identifier of the CMK to import the key material into. The CMK's Origin must be EXTERNAL.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "ImportToken":{ + "shape":"CiphertextType", + "documentation":"

The import token that you received in the response to a previous GetParametersForImport request. It must be from the same response that contained the public key that you used to encrypt the key material.

" + }, + "EncryptedKeyMaterial":{ + "shape":"CiphertextType", + "documentation":"

The encrypted key material to import. It must be encrypted with the public key that you received in the response to a previous GetParametersForImport request, using the wrapping algorithm that you specified in that request.

" + }, + "ValidTo":{ + "shape":"DateType", + "documentation":"

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. You must omit this parameter when the ExpirationModel parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE. Otherwise it is required.

" + }, + "ExpirationModel":{ + "shape":"ExpirationModelType", + "documentation":"

Specifies whether the key material expires. The default is KEY_MATERIAL_EXPIRES, in which case you must include the ValidTo parameter. When this parameter is set to KEY_MATERIAL_DOES_NOT_EXPIRE, you must omit the ValidTo parameter.

" + } + } + }, + "ImportKeyMaterialResponse":{ + "type":"structure", + "members":{ + } + }, + "IncorrectKeyMaterialException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).

", + "exception":true + }, + "IncorrectTrustAnchorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the trust anchor certificate in the request is not the trust anchor certificate for the specified AWS CloudHSM cluster.

When you initialize the cluster, you create the trust anchor certificate and save it in the customerCA.crt file.

", + "exception":true + }, + "InvalidAliasNameException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified alias name is not valid.

", + "exception":true + }, + "InvalidArnException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because a specified ARN, or an ARN in a key policy, is not valid.

", + "exception":true + }, + "InvalidCiphertextException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.

", + "exception":true + }, + "InvalidGrantIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified GrantId is not valid.

", + "exception":true + }, + "InvalidGrantTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified grant token is not valid.

", + "exception":true + }, + "InvalidImportTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).

", + "exception":true + }, + "InvalidKeyUsageException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified KeySpec value is not valid.

", + "exception":true + }, + "InvalidMarkerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the marker that specifies where pagination should next begin is not valid.

", + "exception":true + }, + "KMSInternalException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because an internal exception occurred. The request can be retried.

", + "exception":true, + "fault":true + }, + "KMSInvalidStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the state of the specified resource is not valid for this request.

For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

", + "exception":true + }, + "KeyIdType":{ + "type":"string", + "max":2048, + "min":1 + }, + "KeyList":{ + "type":"list", + "member":{"shape":"KeyListEntry"} + }, + "KeyListEntry":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

Unique identifier of the key.

" + }, + "KeyArn":{ + "shape":"ArnType", + "documentation":"

ARN of the key.

" + } + }, + "documentation":"

Contains information about each entry in the key list.

" + }, + "KeyManagerType":{ + "type":"string", + "enum":[ + "AWS", + "CUSTOMER" + ] + }, + "KeyMetadata":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "AWSAccountId":{ + "shape":"AWSAccountIdType", + "documentation":"

The twelve-digit account ID of the AWS account that owns the CMK.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The globally unique identifier for the CMK.

" + }, + "Arn":{ + "shape":"ArnType", + "documentation":"

The Amazon Resource Name (ARN) of the CMK. For examples, see AWS Key Management Service (AWS KMS) in the Example ARNs section of the AWS General Reference.

" + }, + "CreationDate":{ + "shape":"DateType", + "documentation":"

The date and time when the CMK was created.

" + }, + "Enabled":{ + "shape":"BooleanType", + "documentation":"

Specifies whether the CMK is enabled. When KeyState is Enabled this value is true, otherwise it is false.

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

The description of the CMK.

" + }, + "KeyUsage":{ + "shape":"KeyUsageType", + "documentation":"

The cryptographic operations for which you can use the CMK. The only valid value is ENCRYPT_DECRYPT, which means you can use the CMK to encrypt and decrypt data.

" + }, + "KeyState":{ + "shape":"KeyState", + "documentation":"

The state of the CMK.

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

" + }, + "DeletionDate":{ + "shape":"DateType", + "documentation":"

The date and time after which AWS KMS deletes the CMK. This value is present only when KeyState is PendingDeletion.

" + }, + "ValidTo":{ + "shape":"DateType", + "documentation":"

The time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. This value is present only for CMKs whose Origin is EXTERNAL and whose ExpirationModel is KEY_MATERIAL_EXPIRES, otherwise this value is omitted.

" + }, + "Origin":{ + "shape":"OriginType", + "documentation":"

The source of the CMK's key material. When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.

" + }, + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

A unique identifier for the custom key store that contains the CMK. This value is present only when the CMK is created in a custom key store.

" + }, + "CloudHsmClusterId":{ + "shape":"CloudHsmClusterIdType", + "documentation":"

The cluster ID of the AWS CloudHSM cluster that contains the key material for the CMK. When you create a CMK in a custom key store, AWS KMS creates the key material for the CMK in the associated AWS CloudHSM cluster. This value is present only when the CMK is created in a custom key store.

" + }, + "ExpirationModel":{ + "shape":"ExpirationModelType", + "documentation":"

Specifies whether the CMK's key material expires. This value is present only when Origin is EXTERNAL, otherwise this value is omitted.

" + }, + "KeyManager":{ + "shape":"KeyManagerType", + "documentation":"

The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed. For more information about the difference, see Customer Master Keys in the AWS Key Management Service Developer Guide.

" + } + }, + "documentation":"

Contains metadata about a customer master key (CMK).

This data type is used as a response element for the CreateKey and DescribeKey operations.

" + }, + "KeyState":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled", + "PendingDeletion", + "PendingImport", + "Unavailable" + ] + }, + "KeyStorePasswordType":{ + "type":"string", + "min":1, + "sensitive":true + }, + "KeyUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified CMK was not available. The request can be retried.

", + "exception":true, + "fault":true + }, + "KeyUsageType":{ + "type":"string", + "enum":["ENCRYPT_DECRYPT"] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.

", + "exception":true + }, + "LimitType":{ + "type":"integer", + "max":1000, + "min":1 + }, + "ListAliasesRequest":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

Lists only aliases that refer to the specified CMK. The value of this parameter can be the ID or Amazon Resource Name (ARN) of a CMK in the caller's account and region. You cannot use an alias name or alias ARN in this value.

This parameter is optional. If you omit it, ListAliases returns all aliases in the account and region.

" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "Aliases":{ + "shape":"AliasList", + "documentation":"

A list of aliases.

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "ListGrantsRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + } + } + }, + "ListGrantsResponse":{ + "type":"structure", + "members":{ + "Grants":{ + "shape":"GrantList", + "documentation":"

A list of grants.

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "ListKeyPoliciesRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

Only one policy can be attached to a key.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + } + } + }, + "ListKeyPoliciesResponse":{ + "type":"structure", + "members":{ + "PolicyNames":{ + "shape":"PolicyNameList", + "documentation":"

A list of key policy names. The only valid value is default.

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "ListKeysRequest":{ + "type":"structure", + "members":{ + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + } + } + }, + "ListKeysResponse":{ + "type":"structure", + "members":{ + "Keys":{ + "shape":"KeyList", + "documentation":"

A list of customer master keys (CMKs).

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "ListResourceTagsRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 50, inclusive. If you do not include a value, it defaults to 50.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Do not attempt to construct this value. Use only the value of NextMarker from the truncated response you just received.

" + } + } + }, + "ListResourceTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags. Each tag consists of a tag key and a tag value.

" + }, + "NextMarker":{ + "shape":"MarkerType", + "documentation":"

When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

Do not assume or infer any information from this value.

" + }, + "Truncated":{ + "shape":"BooleanType", + "documentation":"

A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

" + } + } + }, + "ListRetirableGrantsRequest":{ + "type":"structure", + "required":["RetiringPrincipal"], + "members":{ + "Limit":{ + "shape":"LimitType", + "documentation":"

Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not return more than the specified number of items, but it might return fewer.

This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.

" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

" + }, + "RetiringPrincipal":{ + "shape":"PrincipalIdType", + "documentation":"

The retiring principal for which to list grants.

To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals include AWS accounts (root), IAM users, federated users, and assumed role users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section of the Amazon Web Services General Reference.

" + } + } + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified policy is not syntactically or semantically correct.

", + "exception":true + }, + "MarkerType":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\u0020-\\u00FF]*" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because the specified entity or resource could not be found.

", + "exception":true + }, + "NumberOfBytesType":{ + "type":"integer", + "max":1024, + "min":1 + }, + "OriginType":{ + "type":"string", + "enum":[ + "AWS_KMS", + "EXTERNAL", + "AWS_CLOUDHSM" + ] + }, + "PendingWindowInDaysType":{ + "type":"integer", + "max":365, + "min":1 + }, + "PlaintextType":{ + "type":"blob", + "max":4096, + "min":1, + "sensitive":true + }, + "PolicyNameList":{ + "type":"list", + "member":{"shape":"PolicyNameType"} + }, + "PolicyNameType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w]+" + }, + "PolicyType":{ + "type":"string", + "max":131072, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "PrincipalIdType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[\\w+=,.@:/-]+$" + }, + "PutKeyPolicyRequest":{ + "type":"structure", + "required":[ + "KeyId", + "PolicyName", + "Policy" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "PolicyName":{ + "shape":"PolicyNameType", + "documentation":"

The name of the key policy. The only valid value is default.

" + }, + "Policy":{ + "shape":"PolicyType", + "documentation":"

The key policy to attach to the CMK.

The key policy must meet the following criteria:

  • If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must allow the principal that is making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the risk that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the AWS Key Management Service Developer Guide.

  • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the AWS Identity and Access Management User Guide.

The key policy size limit is 32 kilobytes (32768 bytes).

" + }, + "BypassPolicyLockoutSafetyCheck":{ + "shape":"BooleanType", + "documentation":"

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the risk that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

" + } + } + }, + "ReEncryptRequest":{ + "type":"structure", + "required":[ + "CiphertextBlob", + "DestinationKeyId" + ], + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

Ciphertext of the data to reencrypt.

" + }, + "SourceEncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

" + }, + "DestinationKeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the CMK that is used to reencrypt the data.

To specify a CMK, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. When using an alias name, prefix it with \"alias/\". To specify a CMK in a different AWS account, you must use the key ARN or alias ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

  • Alias name: alias/ExampleAlias

  • Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

" + }, + "DestinationEncryptionContext":{ + "shape":"EncryptionContextType", + "documentation":"

Encryption context to use when the data is reencrypted.

" + }, + "GrantTokens":{ + "shape":"GrantTokenList", + "documentation":"

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

" + } + } + }, + "ReEncryptResponse":{ + "type":"structure", + "members":{ + "CiphertextBlob":{ + "shape":"CiphertextType", + "documentation":"

The reencrypted data. When you use the HTTP API or the AWS CLI, the value is Base64-encoded. Otherwise, it is not encoded.

" + }, + "SourceKeyId":{ + "shape":"KeyIdType", + "documentation":"

Unique identifier of the CMK used to originally encrypt the data.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

Unique identifier of the CMK used to reencrypt the data.

" + } + } + }, + "RetireGrantRequest":{ + "type":"structure", + "members":{ + "GrantToken":{ + "shape":"GrantTokenType", + "documentation":"

Token that identifies the grant to be retired.

" + }, + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The Amazon Resource Name (ARN) of the CMK associated with the grant.

For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab

" + }, + "GrantId":{ + "shape":"GrantIdType", + "documentation":"

Unique identifier of the grant to retire. The grant ID is returned in the response to a CreateGrant operation.

  • Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

" + } + } + }, + "RevokeGrantRequest":{ + "type":"structure", + "required":[ + "KeyId", + "GrantId" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key associated with the grant.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "GrantId":{ + "shape":"GrantIdType", + "documentation":"

Identifier of the grant to be revoked.

" + } + } + }, + "ScheduleKeyDeletionRequest":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier of the customer master key (CMK) to delete.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "PendingWindowInDays":{ + "shape":"PendingWindowInDaysType", + "documentation":"

The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK).

This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.

" + } + } + }, + "ScheduleKeyDeletionResponse":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

" + }, + "DeletionDate":{ + "shape":"DateType", + "documentation":"

The date and time after which AWS KMS deletes the customer master key (CMK).

" + } + } + }, + "Tag":{ + "type":"structure", + "required":[ + "TagKey", + "TagValue" + ], + "members":{ + "TagKey":{ + "shape":"TagKeyType", + "documentation":"

The key of the tag.

" + }, + "TagValue":{ + "shape":"TagValueType", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings.

For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

" + }, + "TagException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because one or more tags are not valid.

", + "exception":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKeyType"} + }, + "TagKeyType":{ + "type":"string", + "max":128, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "KeyId", + "Tags" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the CMK you are tagging.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

One or more tags. Each tag consists of a tag key and a tag value.

" + } + } + }, + "TagValueType":{ + "type":"string", + "max":256, + "min":0 + }, + "TrustAnchorCertificateType":{ + "type":"string", + "max":5000, + "min":1 + }, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessageType"} + }, + "documentation":"

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "KeyId", + "TagKeys" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the CMK from which you are removing tags.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

One or more tag keys. Specify only the tag keys, not the tag values.

" + } + } + }, + "UpdateAliasRequest":{ + "type":"structure", + "required":[ + "AliasName", + "TargetKeyId" + ], + "members":{ + "AliasName":{ + "shape":"AliasNameType", + "documentation":"

Specifies the name of the alias to change. This value must begin with alias/ followed by the alias name, such as alias/ExampleAlias.

" + }, + "TargetKeyId":{ + "shape":"KeyIdType", + "documentation":"

Unique identifier of the customer master key (CMK) to be mapped to the alias. When the update operation completes, the alias will point to this CMK.

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

To verify that the alias is mapped to the correct CMK, use ListAliases.

" + } + } + }, + "UpdateCustomKeyStoreRequest":{ + "type":"structure", + "required":["CustomKeyStoreId"], + "members":{ + "CustomKeyStoreId":{ + "shape":"CustomKeyStoreIdType", + "documentation":"

Identifies the custom key store that you want to update. Enter the ID of the custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

" + }, + "NewCustomKeyStoreName":{ + "shape":"CustomKeyStoreNameType", + "documentation":"

Changes the friendly name of the custom key store to the value that you specify. The custom key store name must be unique in the AWS account.

" + }, + "KeyStorePassword":{ + "shape":"KeyStorePasswordType", + "documentation":"

Enter the current password of the kmsuser crypto user (CU) in the AWS CloudHSM cluster that is associated with the custom key store.

This parameter tells AWS KMS the current password of the kmsuser crypto user (CU). It does not set or change the password of any users in the AWS CloudHSM cluster.

" + }, + "CloudHsmClusterId":{ + "shape":"CloudHsmClusterIdType", + "documentation":"

Associates the custom key store with a related AWS CloudHSM cluster.

Enter the cluster ID of the cluster that you used to create the custom key store or a cluster that shares a backup history and has the same cluster certificate as the original cluster. You cannot use this parameter to associate a custom key store with an unrelated cluster. In addition, the replacement cluster must fulfill the requirements for a cluster associated with a custom key store. To view the cluster certificate of a cluster, use the DescribeClusters operation.

" + } + } + }, + "UpdateCustomKeyStoreResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateKeyDescriptionRequest":{ + "type":"structure", + "required":[ + "KeyId", + "Description" + ], + "members":{ + "KeyId":{ + "shape":"KeyIdType", + "documentation":"

A unique identifier for the customer master key (CMK).

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

For example:

  • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.

" + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

New description for the CMK.

" + } + } + }, + "WrappingKeySpec":{ + "type":"string", + "enum":["RSA_2048"] + } + }, + "documentation":"AWS Key Management Service

AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide .

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, macOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS.

Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes.

Signing Requests

Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user. You can also use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests.

All AWS KMS operations require Signature Version 4.

Logging API Requests

AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

Additional Resources

For more information about credentials and request signing, see the following:

Commonly Used API Operations

Of the API operations discussed in this guide, the following will prove the most useful for most applications. You will likely perform operations other than these, such as creating keys and assigning policies, by using the console.

" +} diff --git a/aws/dist/botocore/data/lakeformation/2017-03-31/paginators-1.json b/aws/dist/botocore/data/lakeformation/2017-03-31/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/lakeformation/2017-03-31/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/lakeformation/2017-03-31/service-2.json b/aws/dist/botocore/data/lakeformation/2017-03-31/service-2.json new file mode 100644 index 00000000..428af939 --- /dev/null +++ b/aws/dist/botocore/data/lakeformation/2017-03-31/service-2.json @@ -0,0 +1,1020 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-03-31", + "endpointPrefix":"lakeformation", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Lake Formation", + "serviceId":"LakeFormation", + "signatureVersion":"v4", + "signingName":"lakeformation", + "targetPrefix":"AWSLakeFormation", + "uid":"lakeformation-2017-03-31" + }, + "operations":{ + "BatchGrantPermissions":{ + "name":"BatchGrantPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchGrantPermissionsRequest"}, + "output":{"shape":"BatchGrantPermissionsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Batch operation to grant permissions to the principal.

" + }, + "BatchRevokePermissions":{ + "name":"BatchRevokePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchRevokePermissionsRequest"}, + "output":{"shape":"BatchRevokePermissionsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Batch operation to revoke permissions from the principal.

" + }, + "DeregisterResource":{ + "name":"DeregisterResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterResourceRequest"}, + "output":{"shape":"DeregisterResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Deregisters the resource as managed by the Data Catalog.

When you deregister a path, Lake Formation removes the path from the inline policy attached to your service-linked role.

" + }, + "DescribeResource":{ + "name":"DescribeResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceRequest"}, + "output":{"shape":"DescribeResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Retrieves the current data access role for the given resource registered in AWS Lake Formation.

" + }, + "GetDataLakeSettings":{ + "name":"GetDataLakeSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDataLakeSettingsRequest"}, + "output":{"shape":"GetDataLakeSettingsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

The AWS Lake Formation principal.

" + }, + "GetEffectivePermissionsForPath":{ + "name":"GetEffectivePermissionsForPath", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEffectivePermissionsForPathRequest"}, + "output":{"shape":"GetEffectivePermissionsForPathResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Returns the permissions for a specified table or database resource located at a path in Amazon S3.

" + }, + "GrantPermissions":{ + "name":"GrantPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GrantPermissionsRequest"}, + "output":{"shape":"GrantPermissionsResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

" + }, + "ListPermissions":{ + "name":"ListPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPermissionsRequest"}, + "output":{"shape":"ListPermissionsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

" + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesRequest"}, + "output":{"shape":"ListResourcesResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"} + ], + "documentation":"

Lists the resources registered to be managed by the Data Catalog.

" + }, + "PutDataLakeSettings":{ + "name":"PutDataLakeSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDataLakeSettingsRequest"}, + "output":{"shape":"PutDataLakeSettingsResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

The AWS Lake Formation principal.

" + }, + "RegisterResource":{ + "name":"RegisterResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterResourceRequest"}, + "output":{"shape":"RegisterResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"AlreadyExistsException"} + ], + "documentation":"

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

" + }, + "RevokePermissions":{ + "name":"RevokePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokePermissionsRequest"}, + "output":{"shape":"RevokePermissionsResponse"}, + "errors":[ + {"shape":"ConcurrentModificationException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Revokes permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

" + }, + "UpdateResource":{ + "name":"UpdateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResourceRequest"}, + "output":{"shape":"UpdateResourceResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

Updates the data access role used for vending access to the given (registered) resource in AWS Lake Formation.

" + } + }, + "shapes":{ + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A resource to be created or added already exists.

", + "exception":true + }, + "BatchGrantPermissionsRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Entries":{ + "shape":"BatchPermissionsRequestEntryList", + "documentation":"

A list of up to 20 entries for resource permissions to be granted by batch operation to the principal.

" + } + } + }, + "BatchGrantPermissionsResponse":{ + "type":"structure", + "members":{ + "Failures":{ + "shape":"BatchPermissionsFailureList", + "documentation":"

A list of failures to grant permissions to the resources.

" + } + } + }, + "BatchPermissionsFailureEntry":{ + "type":"structure", + "members":{ + "RequestEntry":{ + "shape":"BatchPermissionsRequestEntry", + "documentation":"

An identifier for an entry of the batch request.

" + }, + "Error":{ + "shape":"ErrorDetail", + "documentation":"

An error message that applies to the failure of the entry.

" + } + }, + "documentation":"

A list of failures when performing a batch grant or batch revoke operation.

" + }, + "BatchPermissionsFailureList":{ + "type":"list", + "member":{"shape":"BatchPermissionsFailureEntry"} + }, + "BatchPermissionsRequestEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Identifier", + "documentation":"

A unique identifier for the batch permissions request entry.

" + }, + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The principal to be granted a permission.

" + }, + "Resource":{ + "shape":"Resource", + "documentation":"

The resource to which the principal is to be granted a permission.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions to be granted.

" + }, + "PermissionsWithGrantOption":{ + "shape":"PermissionList", + "documentation":"

Indicates if the option to pass permissions is granted.

" + } + }, + "documentation":"

A permission to a resource granted by batch operation to the principal.

" + }, + "BatchPermissionsRequestEntryList":{ + "type":"list", + "member":{"shape":"BatchPermissionsRequestEntry"} + }, + "BatchRevokePermissionsRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Entries":{ + "shape":"BatchPermissionsRequestEntryList", + "documentation":"

A list of up to 20 entries for resource permissions to be revoked by batch operation to the principal.

" + } + } + }, + "BatchRevokePermissionsResponse":{ + "type":"structure", + "members":{ + "Failures":{ + "shape":"BatchPermissionsFailureList", + "documentation":"

A list of failures to revoke permissions to the resources.

" + } + } + }, + "CatalogIdString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "CatalogResource":{ + "type":"structure", + "members":{ + }, + "documentation":"

A structure for the catalog object.

" + }, + "ColumnNames":{ + "type":"list", + "member":{"shape":"NameString"} + }, + "ColumnWildcard":{ + "type":"structure", + "members":{ + "ExcludedColumnNames":{ + "shape":"ColumnNames", + "documentation":"

Excludes column names. Any column with this name will be excluded.

" + } + }, + "documentation":"

A wildcard object, consisting of an optional list of excluded column names or indexes.

" + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT", + "CONTAINS", + "NOT_CONTAINS", + "BEGINS_WITH", + "IN", + "BETWEEN" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

Two processes are trying to modify a resource simultaneously.

", + "exception":true + }, + "DataLakePrincipal":{ + "type":"structure", + "members":{ + "DataLakePrincipalIdentifier":{ + "shape":"DataLakePrincipalString", + "documentation":"

An identifier for the AWS Lake Formation principal.

" + } + }, + "documentation":"

The AWS Lake Formation principal.

" + }, + "DataLakePrincipalList":{ + "type":"list", + "member":{"shape":"DataLakePrincipal"}, + "max":10, + "min":0 + }, + "DataLakePrincipalString":{ + "type":"string", + "max":255, + "min":1 + }, + "DataLakeResourceType":{ + "type":"string", + "enum":[ + "CATALOG", + "DATABASE", + "TABLE", + "DATA_LOCATION" + ] + }, + "DataLakeSettings":{ + "type":"structure", + "members":{ + "DataLakeAdmins":{ + "shape":"DataLakePrincipalList", + "documentation":"

A list of AWS Lake Formation principals.

" + }, + "CreateDatabaseDefaultPermissions":{ + "shape":"PrincipalPermissionsList", + "documentation":"

A list of up to three principal permissions entries for default create database permissions.

" + }, + "CreateTableDefaultPermissions":{ + "shape":"PrincipalPermissionsList", + "documentation":"

A list of up to three principal permissions entries for default create table permissions.

" + } + }, + "documentation":"

The AWS Lake Formation principal.

" + }, + "DataLocationResource":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

" + } + }, + "documentation":"

A structure for a data location object where permissions are granted or revoked.

" + }, + "DatabaseResource":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameString", + "documentation":"

The name of the database resource. Unique to the Data Catalog.

" + } + }, + "documentation":"

A structure for the database object.

" + }, + "DeregisterResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to deregister.

" + } + } + }, + "DeregisterResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The resource ARN.

" + } + } + }, + "DescribeResourceResponse":{ + "type":"structure", + "members":{ + "ResourceInfo":{ + "shape":"ResourceInfo", + "documentation":"

A structure containing information about an AWS Lake Formation resource.

" + } + } + }, + "DescriptionString":{ + "type":"string", + "max":2048, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*" + }, + "EntityNotFoundException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

A specified entity does not exist

", + "exception":true + }, + "ErrorDetail":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"NameString", + "documentation":"

The code associated with this error.

" + }, + "ErrorMessage":{ + "shape":"DescriptionString", + "documentation":"

A message describing the error.

" + } + }, + "documentation":"

Contains details about an error.

" + }, + "FieldNameString":{ + "type":"string", + "enum":[ + "RESOURCE_ARN", + "ROLE_ARN", + "LAST_MODIFIED" + ] + }, + "FilterCondition":{ + "type":"structure", + "members":{ + "Field":{ + "shape":"FieldNameString", + "documentation":"

The field to filter in the filter condition.

" + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

The comparison operator used in the filter condition.

" + }, + "StringValueList":{ + "shape":"StringValueList", + "documentation":"

A string with values used in evaluating the filter condition.

" + } + }, + "documentation":"

This structure describes the filtering of columns in a table based on a filter condition.

" + }, + "FilterConditionList":{ + "type":"list", + "member":{"shape":"FilterCondition"}, + "max":20, + "min":1 + }, + "GetDataLakeSettingsRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + } + } + }, + "GetDataLakeSettingsResponse":{ + "type":"structure", + "members":{ + "DataLakeSettings":{ + "shape":"DataLakeSettings", + "documentation":"

A list of AWS Lake Formation principals.

" + } + } + }, + "GetEffectivePermissionsForPathRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

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

The Amazon Resource Name (ARN) of the resource for which you want to get permissions.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve this list.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return.

" + } + } + }, + "GetEffectivePermissionsForPathResponse":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"PrincipalResourcePermissionsList", + "documentation":"

A list of the permissions for the specified table or database resource located at the path in Amazon S3.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve this list.

" + } + } + }, + "GrantPermissionsRequest":{ + "type":"structure", + "required":[ + "Principal", + "Resource", + "Permissions" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles, and they are defined by their principal type and their ARN.

Note that if you define a resource with a particular ARN, then later delete, and recreate a resource with that same ARN, the resource maintains the permissions already granted.

" + }, + "Resource":{ + "shape":"Resource", + "documentation":"

The resource to which permissions are to be granted. Resources in AWS Lake Formation are the Data Catalog, databases, and tables.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions granted to the principal on the resource. AWS Lake Formation defines privileges to grant and revoke access to metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3. AWS Lake Formation requires that each principal be authorized to perform a specific task on AWS Lake Formation resources.

" + }, + "PermissionsWithGrantOption":{ + "shape":"PermissionList", + "documentation":"

Indicates a list of the granted permissions that the principal may pass to other users. These permissions may only be a subset of the permissions granted in the Privileges.

" + } + } + }, + "GrantPermissionsResponse":{ + "type":"structure", + "members":{ + } + }, + "IAMRoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::[0-9]*:role/.*" + }, + "Identifier":{ + "type":"string", + "max":255, + "min":1 + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

An internal service error occurred.

", + "exception":true, + "fault":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The input provided was not valid.

", + "exception":true + }, + "LastModifiedTimestamp":{"type":"timestamp"}, + "ListPermissionsRequest":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

Specifies a principal to filter the permissions returned.

" + }, + "ResourceType":{ + "shape":"DataLakeResourceType", + "documentation":"

Specifies a resource type to filter the permissions returned.

" + }, + "Resource":{ + "shape":"Resource", + "documentation":"

A resource where you will get a list of the principal permissions.

This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve this list.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of results to return.

" + } + } + }, + "ListPermissionsResponse":{ + "type":"structure", + "members":{ + "PrincipalResourcePermissions":{ + "shape":"PrincipalResourcePermissionsList", + "documentation":"

A list of principals and their permissions on the resource for the specified principal and resource types.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve this list.

" + } + } + }, + "ListResourcesRequest":{ + "type":"structure", + "members":{ + "FilterConditionList":{ + "shape":"FilterConditionList", + "documentation":"

Any applicable row-level and/or column-level filtering conditions for the resources.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum number of resource results.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve these resources.

" + } + } + }, + "ListResourcesResponse":{ + "type":"structure", + "members":{ + "ResourceInfoList":{ + "shape":"ResourceInfoList", + "documentation":"

A summary of the data lake resources.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is not the first call to retrieve these resources.

" + } + } + }, + "MessageString":{"type":"string"}, + "NameString":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, + "NullableBoolean":{ + "type":"boolean", + "box":true + }, + "OperationTimeoutException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"MessageString", + "documentation":"

A message describing the problem.

" + } + }, + "documentation":"

The operation timed out.

", + "exception":true + }, + "PageSize":{ + "type":"integer", + "box":true, + "max":1000, + "min":1 + }, + "Permission":{ + "type":"string", + "enum":[ + "ALL", + "SELECT", + "ALTER", + "DROP", + "DELETE", + "INSERT", + "CREATE_DATABASE", + "CREATE_TABLE", + "DATA_LOCATION_ACCESS" + ] + }, + "PermissionList":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "PrincipalPermissions":{ + "type":"structure", + "members":{ + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The principal who is granted permissions.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions that are granted to the principal.

" + } + }, + "documentation":"

Permissions granted to a principal.

" + }, + "PrincipalPermissionsList":{ + "type":"list", + "member":{"shape":"PrincipalPermissions"} + }, + "PrincipalResourcePermissions":{ + "type":"structure", + "members":{ + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The Data Lake principal to be granted or revoked permissions.

" + }, + "Resource":{ + "shape":"Resource", + "documentation":"

The resource where permissions are to be granted or revoked.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions to be granted or revoked on the resource.

" + }, + "PermissionsWithGrantOption":{ + "shape":"PermissionList", + "documentation":"

Indicates whether to grant the ability to grant permissions (as a subset of permissions granted).

" + } + }, + "documentation":"

The permissions granted or revoked on a resource.

" + }, + "PrincipalResourcePermissionsList":{ + "type":"list", + "member":{"shape":"PrincipalResourcePermissions"} + }, + "PutDataLakeSettingsRequest":{ + "type":"structure", + "required":["DataLakeSettings"], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "DataLakeSettings":{ + "shape":"DataLakeSettings", + "documentation":"

A list of AWS Lake Formation principals.

" + } + } + }, + "PutDataLakeSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "RegisterResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to register.

" + }, + "UseServiceLinkedRole":{ + "shape":"NullableBoolean", + "documentation":"

Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog.

" + }, + "RoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

The identifier for the role.

" + } + } + }, + "RegisterResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "Resource":{ + "type":"structure", + "members":{ + "Catalog":{ + "shape":"CatalogResource", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Database":{ + "shape":"DatabaseResource", + "documentation":"

The database for the resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database permissions to a principal.

" + }, + "Table":{ + "shape":"TableResource", + "documentation":"

The table for the resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" + }, + "TableWithColumns":{ + "shape":"TableWithColumnsResource", + "documentation":"

The table with columns for the resource. A principal with permissions to this resource can select metadata from the columns of a table in the Data Catalog and the underlying data in Amazon S3.

" + }, + "DataLocation":{ + "shape":"DataLocationResource", + "documentation":"

The location of an Amazon S3 path where permissions are granted or revoked.

" + } + }, + "documentation":"

A structure for the resource.

" + }, + "ResourceArnString":{"type":"string"}, + "ResourceInfo":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ResourceArnString", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "RoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

The IAM role that registered a resource.

" + }, + "LastModified":{ + "shape":"LastModifiedTimestamp", + "documentation":"

The date and time the resource was last modified.

" + } + }, + "documentation":"

A structure containing information about an AWS Lake Formation resource.

" + }, + "ResourceInfoList":{ + "type":"list", + "member":{"shape":"ResourceInfo"} + }, + "RevokePermissionsRequest":{ + "type":"structure", + "required":[ + "Principal", + "Resource", + "Permissions" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your AWS Lake Formation environment.

" + }, + "Principal":{ + "shape":"DataLakePrincipal", + "documentation":"

The principal to be revoked permissions on the resource.

" + }, + "Resource":{ + "shape":"Resource", + "documentation":"

The resource to which permissions are to be revoked.

" + }, + "Permissions":{ + "shape":"PermissionList", + "documentation":"

The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.

" + }, + "PermissionsWithGrantOption":{ + "shape":"PermissionList", + "documentation":"

Indicates a list of permissions for which to revoke the grant option allowing the principal to pass permissions to other principals.

" + } + } + }, + "RevokePermissionsResponse":{ + "type":"structure", + "members":{ + } + }, + "StringValue":{"type":"string"}, + "StringValueList":{ + "type":"list", + "member":{"shape":"StringValue"} + }, + "TableResource":{ + "type":"structure", + "required":[ + "DatabaseName", + "Name" + ], + "members":{ + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the table.

" + } + }, + "documentation":"

A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" + }, + "TableWithColumnsResource":{ + "type":"structure", + "members":{ + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the table resource. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" + }, + "ColumnNames":{ + "shape":"ColumnNames", + "documentation":"

The list of column names for the table. At least one of ColumnNames or ColumnWildcard is required.

" + }, + "ColumnWildcard":{ + "shape":"ColumnWildcard", + "documentation":"

A wildcard specified by a ColumnWildcard object. At least one of ColumnNames or ColumnWildcard is required.

" + } + }, + "documentation":"

A structure for a table with columns object. This object is only used when granting a SELECT permission.

This object must take a value for at least one of ColumnsNames, ColumnsIndexes, or ColumnsWildcard.

" + }, + "Token":{"type":"string"}, + "UpdateResourceRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "ResourceArn" + ], + "members":{ + "RoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

The new role to use for the given resource registered in AWS Lake Formation.

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

The resource ARN.

" + } + } + }, + "UpdateResourceResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"AWS Lake Formation

Defines the public endpoint for the AWS Lake Formation service.

" +} diff --git a/aws/dist/botocore/data/lambda/2014-11-11/service-2.json b/aws/dist/botocore/data/lambda/2014-11-11/service-2.json new file mode 100644 index 00000000..53e50010 --- /dev/null +++ b/aws/dist/botocore/data/lambda/2014-11-11/service-2.json @@ -0,0 +1,874 @@ +{ + "metadata":{ + "apiVersion":"2014-11-11", + "endpointPrefix":"lambda", + "serviceFullName":"AWS Lambda", + "serviceId":"Lambda", + "signatureVersion":"v4", + "protocol":"rest-json" + }, + "documentation":"AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, go to What is AWS Lambda, and for information about how the service works, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

", + "operations":{ + "AddEventSource":{ + "name":"AddEventSource", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/event-source-mappings/" + }, + "input":{"shape":"AddEventSourceRequest"}, + "output":{ + "shape":"EventSourceConfiguration", + "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + } + ], + "documentation":"

Identifies a stream as an event source for an AWS Lambda function. It can be either an Amazon Kinesis stream or a Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

Each event source, such as a Kinesis stream, can only be associated with one AWS Lambda function. If you call AddEventSource for an event source that is already mapped to another AWS Lambda function, the existing mapping is updated to call the new function instead of the old one.

This operation requires permission for the iam:PassRole action for the IAM role. It also requires permission for the lambda:AddEventSource action.

" + }, + "DeleteFunction":{ + "name":"DeleteFunction", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":204 + }, + "input":{"shape":"DeleteFunctionRequest"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + } + ], + "documentation":"

Deletes the specified Lambda function code and configuration.

This operation requires permission for the lambda:DeleteFunction action.

" + }, + "GetEventSource":{ + "name":"GetEventSource", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/event-source-mappings/{UUID}", + "responseCode":200 + }, + "input":{"shape":"GetEventSourceRequest"}, + "output":{ + "shape":"EventSourceConfiguration", + "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + } + ], + "documentation":"

Returns configuration information for the specified event source mapping (see AddEventSource).

This operation requires permission for the lambda:GetEventSource action.

" + }, + "GetFunction":{ + "name":"GetFunction", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":200 + }, + "input":{"shape":"GetFunctionRequest"}, + "output":{ + "shape":"GetFunctionResponse", + "documentation":"

This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + } + ], + "documentation":"

Returns the configuration information of the Lambda function and a presigned URL link to the .zip file you uploaded with UploadFunction so you can download the .zip file. Note that the URL is valid for up to 10 minutes. The configuration information is the same information you provided as parameters when uploading the function.

This operation requires permission for the lambda:GetFunction action.

" + }, + "GetFunctionConfiguration":{ + "name":"GetFunctionConfiguration", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"GetFunctionConfigurationRequest"}, + "output":{ + "shape":"FunctionConfiguration", + "documentation":"

A complex type that describes function metadata.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + } + ], + "documentation":"

Returns the configuration information of the Lambda function. This the same information you provided as parameters when uploading the function by using UploadFunction.

This operation requires permission for the lambda:GetFunctionConfiguration operation.

" + }, + "InvokeAsync":{ + "name":"InvokeAsync", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode":202 + }, + "input":{"shape":"InvokeAsyncRequest"}, + "output":{ + "shape":"InvokeAsyncResponse", + "documentation":"

Upon success, it returns empty response. Otherwise, throws an exception.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + { + "shape":"InvalidRequestContentException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request body could not be parsed as JSON.

" + } + ], + "documentation":"

Submits an invocation request to AWS Lambda. Upon receiving the request, Lambda executes the specified function asynchronously. To see the logs generated by the Lambda function execution, see the CloudWatch logs console.

This operation requires permission for the lambda:InvokeAsync action.

" + }, + "ListEventSources":{ + "name":"ListEventSources", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/event-source-mappings/", + "responseCode":200 + }, + "input":{"shape":"ListEventSourcesRequest"}, + "output":{ + "shape":"ListEventSourcesResponse", + "documentation":"

Contains a list of event sources (see API_EventSourceConfiguration)

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + } + ], + "documentation":"

Returns a list of event source mappings you created using the AddEventSource (see AddEventSource), where you identify a stream as event source. This list does not include Amazon S3 event sources.

For each mapping, the API returns configuration information. You can optionally specify filters to retrieve specific event source mappings.

This operation requires permission for the lambda:ListEventSources action.

" + }, + "ListFunctions":{ + "name":"ListFunctions", + "http":{ + "method":"GET", + "requestUri":"/2014-11-13/functions/", + "responseCode":200 + }, + "input":{"shape":"ListFunctionsRequest"}, + "output":{ + "shape":"ListFunctionsResponse", + "documentation":"

Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + } + ], + "documentation":"

Returns a list of your Lambda functions. For each function, the response includes the function configuration information. You must use GetFunction to retrieve the code for your function.

This operation requires permission for the lambda:ListFunctions action.

" + }, + "RemoveEventSource":{ + "name":"RemoveEventSource", + "http":{ + "method":"DELETE", + "requestUri":"/2014-11-13/event-source-mappings/{UUID}", + "responseCode":204 + }, + "input":{"shape":"RemoveEventSourceRequest"}, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + } + ], + "documentation":"

Removes an event source mapping. This means AWS Lambda will no longer invoke the function for events in the associated source.

This operation requires permission for the lambda:RemoveEventSource action.

" + }, + "UpdateFunctionConfiguration":{ + "name":"UpdateFunctionConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-13/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionConfigurationRequest"}, + "output":{ + "shape":"FunctionConfiguration", + "documentation":"

A complex type that describes function metadata.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + } + ], + "documentation":"

Updates the configuration parameters for the specified Lambda function by using the values provided in the request. You provide only the parameters you want to change. This operation must only be used on an existing Lambda function and cannot be used to update the function's code.

This operation requires permission for the lambda:UpdateFunctionConfiguration action.

" + }, + "UploadFunction":{ + "name":"UploadFunction", + "http":{ + "method":"PUT", + "requestUri":"/2014-11-13/functions/{FunctionName}", + "responseCode":201 + }, + "input":{"shape":"UploadFunctionRequest"}, + "output":{ + "shape":"FunctionConfiguration", + "documentation":"

A complex type that describes function metadata.

" + }, + "errors":[ + { + "shape":"ServiceException", + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + { + "shape":"InvalidParameterValueException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + } + ], + "documentation":"

Creates a new Lambda function or updates an existing function. The function metadata is created from the request parameters, and the code for the function is provided by a .zip file in the request body. If the function name already exists, the existing Lambda function is updated with the new code and metadata.

This operation requires permission for the lambda:UploadFunction action.

" + } + }, + "shapes":{ + "AddEventSourceRequest":{ + "type":"structure", + "required":[ + "EventSource", + "FunctionName", + "Role" + ], + "members":{ + "EventSource":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

" + }, + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

" + }, + "BatchSize":{ + "shape":"Integer", + "documentation":"

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

" + }, + "Parameters":{ + "shape":"Map", + "documentation":"

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: \"TRIM_HORIZON\" and \"LATEST\". The default value is \"TRIM_HORIZON\". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

" + } + } + }, + "Blob":{ + "type":"blob", + "streaming":true + }, + "DeleteFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The Lambda function to delete.

" + } + } + }, + "Description":{ + "type":"string", + "min":0, + "max":256 + }, + "EventSourceConfiguration":{ + "type":"structure", + "members":{ + "UUID":{ + "shape":"String", + "documentation":"

The AWS Lambda assigned opaque identifier for the mapping.

" + }, + "BatchSize":{ + "shape":"Integer", + "documentation":"

The largest number of records that AWS Lambda will POST in the invocation request to your function.

" + }, + "EventSource":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

" + }, + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The Lambda function to invoke when AWS Lambda detects an event on the stream.

" + }, + "Parameters":{ + "shape":"Map", + "documentation":"

The map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.

" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

" + }, + "LastModified":{ + "shape":"Timestamp", + "documentation":"

The UTC time string indicating the last time the event mapping was updated.

" + }, + "IsActive":{ + "shape":"Boolean", + "documentation":"

Indicates whether the event source mapping is currently honored. Events are only processes if IsActive is true.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The description of the health of the event source mapping. Valid values are: \"PENDING\", \"OK\", and \"PROBLEM:message\". Initially this staus is \"PENDING\". When AWS Lambda begins processing events, it changes the status to \"OK\".

" + } + }, + "documentation":"

Describes mapping between an Amazon Kinesis stream and a Lambda function.

" + }, + "EventSourceList":{ + "type":"list", + "member":{"shape":"EventSourceConfiguration"} + }, + "FunctionArn":{ + "type":"string", + "pattern":"arn:aws:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(\\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?" + }, + "FunctionCodeLocation":{ + "type":"structure", + "members":{ + "RepositoryType":{ + "shape":"String", + "documentation":"

The repository from which you can download the function.

" + }, + "Location":{ + "shape":"String", + "documentation":"

The presigned URL you can use to download the function's .zip file that you previously uploaded. The URL is valid for up to 10 minutes.

" + } + }, + "documentation":"

The object for the Lambda function location.

" + }, + "FunctionConfiguration":{ + "type":"structure", + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the function.

" + }, + "FunctionARN":{ + "shape":"FunctionArn", + "documentation":"

The Amazon Resource Name (ARN) assigned to the function.

" + }, + "ConfigurationId":{ + "shape":"String", + "documentation":"

A Lambda-assigned unique identifier for the current function code and related configuration.

" + }, + "Runtime":{ + "shape":"Runtime", + "documentation":"

The runtime environment for the Lambda function.

" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

" + }, + "Handler":{ + "shape":"Handler", + "documentation":"

The function Lambda calls to begin executing your function.

" + }, + "Mode":{ + "shape":"Mode", + "documentation":"

The type of the Lambda function you uploaded.

" + }, + "CodeSize":{ + "shape":"Long", + "documentation":"

The size, in bytes, of the function .zip file you uploaded.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The user-provided description.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "documentation":"

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

" + }, + "LastModified":{ + "shape":"Timestamp", + "documentation":"

The timestamp of the last time you updated the function.

" + } + }, + "documentation":"

A complex type that describes function metadata.

" + }, + "FunctionList":{ + "type":"list", + "member":{"shape":"FunctionConfiguration"} + }, + "FunctionName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-zA-Z0-9-_]+" + }, + "GetEventSourceRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID", + "documentation":"

The AWS Lambda assigned ID of the event source mapping.

" + } + } + }, + "GetFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The name of the Lambda function for which you want to retrieve the configuration information.

" + } + } + }, + "GetFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The Lambda function name.

" + } + } + }, + "GetFunctionResponse":{ + "type":"structure", + "members":{ + "Configuration":{"shape":"FunctionConfiguration"}, + "Code":{"shape":"FunctionCodeLocation"} + }, + "documentation":"

This response contains the object for AWS Lambda function location (see API_FunctionCodeLocation

" + }, + "Handler":{ + "type":"string", + "pattern":"[a-zA-Z0-9./\\-_]+" + }, + "HttpStatus":{"type":"integer"}, + "Integer":{"type":"integer"}, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the UploadFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

" + }, + "InvalidRequestContentException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The request body could not be parsed as JSON.

" + }, + "InvokeAsyncRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "InvokeArgs" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The Lambda function name.

" + }, + "InvokeArgs":{ + "shape":"Blob", + "documentation":"

JSON that you want to provide to your Lambda function as input.

" + } + }, + "payload":"InvokeArgs" + }, + "InvokeAsyncResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"HttpStatus", + "location":"statusCode", + "documentation":"

It will be 202 upon success.

" + } + }, + "documentation":"

Upon success, it returns empty response. Otherwise, throws an exception.

" + }, + "ListEventSourcesRequest":{ + "type":"structure", + "members":{ + "EventSourceArn":{ + "shape":"String", + "location":"querystring", + "locationName":"EventSource", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis stream.

" + }, + "FunctionName":{ + "shape":"FunctionName", + "location":"querystring", + "locationName":"FunctionName", + "documentation":"

The name of the AWS Lambda function.

" + }, + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker", + "documentation":"

Optional string. An opaque pagination token returned from a previous ListEventSources operation. If present, specifies to continue the list from where the returning call left off.

" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"

Optional integer. Specifies the maximum number of event sources to return in response. This value must be greater than 0.

" + } + } + }, + "ListEventSourcesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

A string, present if there are more event source mappings.

" + }, + "EventSources":{ + "shape":"EventSourceList", + "documentation":"

An arrary of EventSourceConfiguration objects.

" + } + }, + "documentation":"

Contains a list of event sources (see API_EventSourceConfiguration)

" + }, + "ListFunctionsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "location":"querystring", + "locationName":"Marker", + "documentation":"

Optional string. An opaque pagination token returned from a previous ListFunctions operation. If present, indicates where to continue the listing.

" + }, + "MaxItems":{ + "shape":"MaxListItems", + "location":"querystring", + "locationName":"MaxItems", + "documentation":"

Optional integer. Specifies the maximum number of AWS Lambda functions to return in response. This parameter value must be greater than 0.

" + } + } + }, + "ListFunctionsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

A string, present if there are more functions.

" + }, + "Functions":{ + "shape":"FunctionList", + "documentation":"

A list of Lambda functions.

" + } + }, + "documentation":"

Contains a list of AWS Lambda function configurations (see API_FunctionConfiguration.

" + }, + "Long":{"type":"long"}, + "Map":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MaxListItems":{ + "type":"integer", + "min":1, + "max":10000 + }, + "MemorySize":{ + "type":"integer", + "min":128, + "max":1024 + }, + "Mode":{ + "type":"string", + "enum":["event"] + }, + "RemoveEventSourceRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "location":"uri", + "locationName":"UUID", + "documentation":"

The event source mapping ID.

" + } + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

The function or the event source specified in the request does not exist.

" + }, + "RoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "Runtime":{ + "type":"string", + "enum":["nodejs"] + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "documentation":"

The AWS Lambda service encountered an internal error.

" + }, + "String":{"type":"string"}, + "Timeout":{ + "type":"integer", + "min":1, + "max":60 + }, + "Timestamp":{"type":"string"}, + "UpdateFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The name of the Lambda function.

" + }, + "Role":{ + "shape":"RoleArn", + "location":"querystring", + "locationName":"Role", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

" + }, + "Handler":{ + "shape":"Handler", + "location":"querystring", + "locationName":"Handler", + "documentation":"

The function that Lambda calls to begin executing your function. For Node.js, it is the module-name.export value in your function.

" + }, + "Description":{ + "shape":"Description", + "location":"querystring", + "locationName":"Description", + "documentation":"

A short user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

" + }, + "Timeout":{ + "shape":"Timeout", + "location":"querystring", + "locationName":"Timeout", + "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "location":"querystring", + "locationName":"MemorySize", + "documentation":"

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" + } + } + }, + "UploadFunctionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "FunctionZip", + "Runtime", + "Role", + "Handler", + "Mode" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "location":"uri", + "locationName":"FunctionName", + "documentation":"

The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.

" + }, + "FunctionZip":{ + "shape":"Blob", + "documentation":"

A .zip file containing your packaged source code. For more information about creating a .zip file, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

" + }, + "Runtime":{ + "shape":"Runtime", + "location":"querystring", + "locationName":"Runtime", + "documentation":"

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only \"nodejs\" as the runtime.

" + }, + "Role":{ + "shape":"RoleArn", + "location":"querystring", + "locationName":"Role", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

" + }, + "Handler":{ + "shape":"Handler", + "location":"querystring", + "locationName":"Handler", + "documentation":"

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

" + }, + "Mode":{ + "shape":"Mode", + "location":"querystring", + "locationName":"Mode", + "documentation":"

How the Lambda function will be invoked. Lambda supports only the \"event\" mode.

" + }, + "Description":{ + "shape":"Description", + "location":"querystring", + "locationName":"Description", + "documentation":"

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

" + }, + "Timeout":{ + "shape":"Timeout", + "location":"querystring", + "locationName":"Timeout", + "documentation":"

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "location":"querystring", + "locationName":"MemorySize", + "documentation":"

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

" + } + }, + "payload":"FunctionZip" + }, + "Boolean":{"type":"boolean"} + } +} diff --git a/aws/dist/botocore/data/lambda/2015-03-31/examples-1.json b/aws/dist/botocore/data/lambda/2015-03-31/examples-1.json new file mode 100644 index 00000000..9aea28ad --- /dev/null +++ b/aws/dist/botocore/data/lambda/2015-03-31/examples-1.json @@ -0,0 +1,614 @@ +{ + "version": "1.0", + "examples": { + "AddPermission": [ + { + "input": { + "Action": "lambda:InvokeFunction", + "FunctionName": "MyFunction", + "Principal": "s3.amazonaws.com", + "SourceAccount": "123456789012", + "SourceArn": "arn:aws:s3:::examplebucket/*", + "StatementId": "ID-1" + }, + "output": { + "Statement": "ID-1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a permission for an S3 bucket to invoke a Lambda function.", + "id": "add-permission-1474651469455", + "title": "add-permission" + } + ], + "CreateFunction": [ + { + "input": { + "Code": { + }, + "Description": "", + "FunctionName": "MyFunction", + "Handler": "souce_file.handler_name", + "MemorySize": 128, + "Publish": true, + "Role": "arn:aws:iam::123456789012:role/service-role/role-name", + "Runtime": "nodejs4.3", + "Timeout": 15, + "VpcConfig": { + } + }, + "output": { + "CodeSha256": "", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:MyFunction", + "FunctionName": "MyFunction", + "Handler": "source_file.handler_name", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/service-role/role-name", + "Runtime": "nodejs4.3", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + "Handler": "is of the form of the name of your source file and then name of your function handler", + "Role": "replace with the actual arn of the execution role you created" + }, + "output": { + } + }, + "description": "This example creates a Lambda function.", + "id": "create-function-1474653449931", + "title": "create-function" + } + ], + "DeleteAlias": [ + { + "input": { + "FunctionName": "myFunction", + "Name": "alias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function alias", + "id": "to-delete-a-lambda-function-alias-1481660370804", + "title": "To delete a Lambda function alias" + } + ], + "DeleteEventSourceMapping": [ + { + "input": { + "UUID": "12345kxodurf3443" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:s3:::examplebucket/*", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "12345kxodurf3443" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function event source mapping", + "id": "to-delete-a-lambda-function-event-source-mapping-1481658973862", + "title": "To delete a Lambda function event source mapping" + } + ], + "DeleteFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Lambda function", + "id": "to-delete-a-lambda-function-1481648553696", + "title": "To delete a Lambda function" + } + ], + "GetAccountSettings": [ + { + "input": { + }, + "output": { + "AccountLimit": { + }, + "AccountUsage": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda customer's account settings", + "id": "to-retrieves-a-lambda-customers-account-settings-1481657495274", + "title": "To retrieves a Lambda customer's account settings" + } + ], + "GetAlias": [ + { + "input": { + "FunctionName": "myFunction", + "Name": "myFunctionAlias" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunctionAlias", + "Description": "", + "FunctionVersion": "1", + "Name": "myFunctionAlias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function alias", + "id": "to-retrieve-a-lambda-function-alias-1481648742254", + "title": "To retrieve a Lambda function alias" + } + ], + "GetEventSourceMapping": [ + { + "input": { + "UUID": "123489-xxxxx-kdla8d89d7" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:iam::123456789012:eventsource", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "123489-xxxxx-kdla8d89d7" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "Code": { + "Location": "somelocation", + "RepositoryType": "S3" + }, + "Configuration": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 262, + "Description": "A starter AWS Lambda function.", + "Environment": { + "Variables": { + "S3_BUCKET": "test" + } + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "nodejs4.3", + "Timeout": 3, + "Version": "$LATEST", + "VpcConfig": { + "SecurityGroupIds": [ + + ], + "SubnetIds": [ + + ] + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetFunctionConfiguration": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "DeadLetterConfig": { + }, + "Description": "", + "Environment": { + }, + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "KMSKeyArn": "", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's event source mapping", + "id": "to-retrieve-a-lambda-functions-event-source-mapping-1481661622799", + "title": "To retrieve a Lambda function's event source mapping" + } + ], + "GetPolicy": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1" + }, + "output": { + "Policy": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function policy", + "id": "to-retrieve-a-lambda-function-policy-1481649319053", + "title": "To retrieve a Lambda function policy" + } + ], + "Invoke": [ + { + "input": { + "ClientContext": "MyApp", + "FunctionName": "MyFunction", + "InvocationType": "Event", + "LogType": "Tail", + "Payload": "fileb://file-path/input.json", + "Qualifier": "1" + }, + "output": { + "FunctionError": "", + "LogResult": "", + "Payload": "?", + "StatusCode": 123 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation invokes a Lambda function", + "id": "to-invoke-a-lambda-function-1481659683915", + "title": "To invoke a Lambda function" + } + ], + "InvokeAsync": [ + { + "input": { + "FunctionName": "myFunction", + "InvokeArgs": "fileb://file-path/input.json" + }, + "output": { + "Status": 123 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation invokes a Lambda function asynchronously", + "id": "to-invoke-a-lambda-function-asynchronously-1481649694923", + "title": "To invoke a Lambda function asynchronously" + } + ], + "ListAliases": [ + { + "input": { + "FunctionName": "myFunction", + "FunctionVersion": "1", + "Marker": "", + "MaxItems": 123 + }, + "output": { + "Aliases": [ + + ], + "NextMarker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function's aliases", + "id": "to-retrieve-a-lambda-function-aliases-1481650199732", + "title": "To retrieve a Lambda function aliases" + } + ], + "ListFunctions": [ + { + "input": { + "Marker": "", + "MaxItems": 123 + }, + "output": { + "Functions": [ + + ], + "NextMarker": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda functions", + "id": "to-retrieve-a-list-of-lambda-functions-1481650507425", + "title": "To retrieve a list of Lambda functions" + } + ], + "ListVersionsByFunction": [ + { + "input": { + "FunctionName": "myFunction", + "Marker": "", + "MaxItems": 123 + }, + "output": { + "NextMarker": "", + "Versions": [ + + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation retrieves a Lambda function versions", + "id": "to-retrieve-a-list-of-lambda-function-versions-1481650603750", + "title": "To retrieve a list of Lambda function versions" + } + ], + "PublishVersion": [ + { + "input": { + "CodeSha256": "", + "Description": "", + "FunctionName": "myFunction" + }, + "output": { + "CodeSha256": "", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction:1", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation publishes a version of a Lambda function", + "id": "to-publish-a-version-of-a-lambda-function-1481650704986", + "title": "To publish a version of a Lambda function" + } + ], + "RemovePermission": [ + { + "input": { + "FunctionName": "myFunction", + "Qualifier": "1", + "StatementId": "role-statement-id" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation removes a Lambda function's permissions", + "id": "to-remove-a-lambda-functions-permissions-1481661337021", + "title": "To remove a Lambda function's permissions" + } + ], + "UpdateAlias": [ + { + "input": { + "Description": "", + "FunctionName": "myFunction", + "FunctionVersion": "1", + "Name": "functionAlias" + }, + "output": { + "AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:functionAlias", + "Description": "", + "FunctionVersion": "1", + "Name": "functionAlias" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function alias", + "id": "to-update-a-lambda-function-alias-1481650817950", + "title": "To update a Lambda function alias" + } + ], + "UpdateEventSourceMapping": [ + { + "input": { + "BatchSize": 123, + "Enabled": true, + "FunctionName": "myFunction", + "UUID": "1234xCy789012" + }, + "output": { + "BatchSize": 123, + "EventSourceArn": "arn:aws:s3:::examplebucket/*", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "LastModified": "2016-11-21T19:49:20.006+0000", + "LastProcessingResult": "", + "State": "", + "StateTransitionReason": "", + "UUID": "1234xCy789012" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function event source mapping", + "id": "to-update-a-lambda-function-event-source-mapping-1481650907413", + "title": "To update a Lambda function event source mapping" + } + ], + "UpdateFunctionCode": [ + { + "input": { + "FunctionName": "myFunction", + "Publish": true, + "S3Bucket": "myBucket", + "S3Key": "myKey", + "S3ObjectVersion": "1", + "ZipFile": "fileb://file-path/file.zip" + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function's code", + "id": "to-update-a-lambda-functions-code-1481650992672", + "title": "To update a Lambda function's code" + } + ], + "UpdateFunctionConfiguration": [ + { + "input": { + "Description": "", + "FunctionName": "myFunction", + "Handler": "index.handler", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "VpcConfig": { + } + }, + "output": { + "CodeSha256": "LQT+0DHxxxxcfwLyQjzoEFKZtdqQjHXanlSdfXBlEW0VA=", + "CodeSize": 123, + "Description": "", + "FunctionArn": "arn:aws:lambda:us-west-2:123456789012:function:myFunction", + "FunctionName": "myFunction", + "Handler": "index.handler", + "LastModified": "2016-11-21T19:49:20.006+0000", + "MemorySize": 128, + "Role": "arn:aws:iam::123456789012:role/lambda_basic_execution", + "Runtime": "python2.7", + "Timeout": 123, + "Version": "1", + "VpcConfig": { + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation updates a Lambda function's configuration", + "id": "to-update-a-lambda-functions-configuration-1481651096447", + "title": "To update a Lambda function's configuration" + } + ] + } +} diff --git a/aws/dist/botocore/data/lambda/2015-03-31/paginators-1.json b/aws/dist/botocore/data/lambda/2015-03-31/paginators-1.json new file mode 100644 index 00000000..c7918f89 --- /dev/null +++ b/aws/dist/botocore/data/lambda/2015-03-31/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListEventSourceMappings": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "EventSourceMappings" + }, + "ListFunctions": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Functions" + }, + "ListAliases": { + "input_token": "Marker", + "output_token": "NextMarker", + "limit_key": "MaxItems", + "result_key": "Aliases" + }, + "ListLayerVersions": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextMarker", + "result_key": "LayerVersions" + }, + "ListLayers": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextMarker", + "result_key": "Layers" + }, + "ListVersionsByFunction": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextMarker", + "result_key": "Versions" + } + } +} diff --git a/aws/dist/botocore/data/lambda/2015-03-31/service-2.json b/aws/dist/botocore/data/lambda/2015-03-31/service-2.json new file mode 100644 index 00000000..8301e2d9 --- /dev/null +++ b/aws/dist/botocore/data/lambda/2015-03-31/service-2.json @@ -0,0 +1,3144 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-03-31", + "endpointPrefix":"lambda", + "protocol":"rest-json", + "serviceFullName":"AWS Lambda", + "serviceId":"Lambda", + "signatureVersion":"v4", + "uid":"lambda-2015-03-31" + }, + "operations":{ + "AddLayerVersionPermission":{ + "name":"AddLayerVersionPermission", + "http":{ + "method":"POST", + "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "responseCode":201 + }, + "input":{"shape":"AddLayerVersionPermissionRequest"}, + "output":{"shape":"AddLayerVersionPermissionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"PolicyLengthExceededException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Adds permissions to the resource-based policy of a version of an AWS Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all AWS accounts, or all accounts in an organization.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

" + }, + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", + "responseCode":201 + }, + "input":{"shape":"AddPermissionRequest"}, + "output":{"shape":"AddPermissionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"PolicyLengthExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Grants an AWS service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function.

To grant permission to another account, specify the account ID as the Principal. For AWS services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For AWS services, you can also specify the ARN or owning account of the associated resource as the SourceArn or SourceAccount. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This action adds a statement to a resource-based permission policy for the function. For more information about function policies, see Lambda Function Policies.

" + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":201 + }, + "input":{"shape":"CreateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

" + }, + "CreateEventSourceMapping":{ + "name":"CreateEventSourceMapping", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/event-source-mappings/", + "responseCode":202 + }, + "input":{"shape":"CreateEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a mapping between an event source and an AWS Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics.

" + }, + "CreateFunction":{ + "name":"CreateFunction", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions", + "responseCode":201 + }, + "input":{"shape":"CreateFunctionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceConflictException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"} + ], + "documentation":"

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package contains your function code. The execution role grants the function permission to use AWS services, such as Amazon CloudWatch Logs for log streaming and AWS X-Ray for request tracing.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

If another account or an AWS service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other AWS services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.

" + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":204 + }, + "input":{"shape":"DeleteAliasRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes a Lambda function alias.

" + }, + "DeleteEventSourceMapping":{ + "name":"DeleteEventSourceMapping", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":202 + }, + "input":{"shape":"DeleteEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

" + }, + "DeleteFunction":{ + "name":"DeleteFunction", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}", + "responseCode":204 + }, + "input":{"shape":"DeleteFunctionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceConflictException"} + ], + "documentation":"

Deletes a Lambda function. To delete a specific function version, use the Qualifier parameter. Otherwise, all versions and aliases are deleted.

To delete Lambda event source mappings that invoke a function, use DeleteEventSourceMapping. For AWS services and resources that invoke your function directly, delete the trigger in the service where you originally configured it.

" + }, + "DeleteFunctionConcurrency":{ + "name":"DeleteFunctionConcurrency", + "http":{ + "method":"DELETE", + "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", + "responseCode":204 + }, + "input":{"shape":"DeleteFunctionConcurrencyRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Removes a concurrent execution limit from a function.

" + }, + "DeleteLayerVersion":{ + "name":"DeleteLayerVersion", + "http":{ + "method":"DELETE", + "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "responseCode":204 + }, + "input":{"shape":"DeleteLayerVersionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes a version of an AWS Lambda layer. Deleted versions can no longer be viewed or added to functions. To avoid breaking functions, a copy of the version remains in Lambda until no functions refer to it.

" + }, + "GetAccountSettings":{ + "name":"GetAccountSettings", + "http":{ + "method":"GET", + "requestUri":"/2016-08-19/account-settings/", + "responseCode":200 + }, + "input":{"shape":"GetAccountSettingsRequest"}, + "output":{"shape":"GetAccountSettingsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Retrieves details about your account's limits and usage in an AWS Region.

" + }, + "GetAlias":{ + "name":"GetAlias", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"GetAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns details about a Lambda function alias.

" + }, + "GetEventSourceMapping":{ + "name":"GetEventSourceMapping", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":200 + }, + "input":{"shape":"GetEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns details about an event source mapping. You can get the identifier of a mapping from the output of ListEventSourceMappings.

" + }, + "GetFunction":{ + "name":"GetFunction", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}", + "responseCode":200 + }, + "input":{"shape":"GetFunctionRequest"}, + "output":{"shape":"GetFunctionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns information about the function or function version, with a link to download the deployment package that's valid for 10 minutes. If you specify a function version, only details that are specific to that version are returned.

" + }, + "GetFunctionConfiguration":{ + "name":"GetFunctionConfiguration", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"GetFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the version-specific settings of a Lambda function or version. The output includes only options that can vary between versions of a function. To modify these settings, use UpdateFunctionConfiguration.

To get all of a function's details, including function-level settings, use GetFunction.

" + }, + "GetLayerVersion":{ + "name":"GetLayerVersion", + "http":{ + "method":"GET", + "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}", + "responseCode":200 + }, + "input":{"shape":"GetLayerVersionRequest"}, + "output":{"shape":"GetLayerVersionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

" + }, + "GetLayerVersionByArn":{ + "name":"GetLayerVersionByArn", + "http":{ + "method":"GET", + "requestUri":"/2018-10-31/layers?find=LayerVersion", + "responseCode":200 + }, + "input":{"shape":"GetLayerVersionByArnRequest"}, + "output":{"shape":"GetLayerVersionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns information about a version of an AWS Lambda layer, with a link to download the layer archive that's valid for 10 minutes.

" + }, + "GetLayerVersionPolicy":{ + "name":"GetLayerVersionPolicy", + "http":{ + "method":"GET", + "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy", + "responseCode":200 + }, + "input":{"shape":"GetLayerVersionPolicyRequest"}, + "output":{"shape":"GetLayerVersionPolicyResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the permission policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.

" + }, + "GetPolicy":{ + "name":"GetPolicy", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy", + "responseCode":200 + }, + "input":{"shape":"GetPolicyRequest"}, + "output":{"shape":"GetPolicyResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns the resource-based IAM policy for a function, version, or alias.

" + }, + "Invoke":{ + "name":"Invoke", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/invocations" + }, + "input":{"shape":"InvocationRequest"}, + "output":{"shape":"InvocationResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestContentException"}, + {"shape":"RequestTooLargeException"}, + {"shape":"UnsupportedMediaTypeException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"EC2UnexpectedException"}, + {"shape":"SubnetIPAddressLimitReachedException"}, + {"shape":"ENILimitReachedException"}, + {"shape":"EC2ThrottledException"}, + {"shape":"EC2AccessDeniedException"}, + {"shape":"InvalidSubnetIDException"}, + {"shape":"InvalidSecurityGroupIDException"}, + {"shape":"InvalidZipFileException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"InvalidRuntimeException"} + ], + "documentation":"

Invokes a Lambda function. You can invoke a function synchronously (and wait for the response), or asynchronously. To invoke a function asynchronously, set InvocationType to Event.

For synchronous invocation, details about the function response, including errors, are included in the response body and headers. For either invocation type, you can find more information in the execution log and trace. To record function errors for asynchronous invocations, configure your function with a dead letter queue.

When an error occurs, your function may be invoked multiple times. Retry behavior varies by error type, client, event source, and invocation type. For example, if you invoke a function asynchronously and it returns an error, Lambda executes the function up to two more times. For more information, see Retry Behavior.

The status code in the API response doesn't reflect function errors. Error codes are reserved for errors that prevent your function from executing, such as permissions errors, limit errors, or issues with your function's code and configuration. For example, Lambda returns TooManyRequestsException if executing the function would cause you to exceed a concurrency limit at either the account level (ConcurrentInvocationLimitExceeded) or function level (ReservedFunctionConcurrentInvocationLimitExceeded).

For functions with a long timeout, your client might be disconnected during synchronous invocation while it waits for a response. Configure your HTTP client, SDK, firewall, proxy, or operating system to allow for long connections with timeout or keep-alive settings.

This operation requires permission for the lambda:InvokeFunction action.

" + }, + "InvokeAsync":{ + "name":"InvokeAsync", + "http":{ + "method":"POST", + "requestUri":"/2014-11-13/functions/{FunctionName}/invoke-async/", + "responseCode":202 + }, + "input":{"shape":"InvokeAsyncRequest"}, + "output":{"shape":"InvokeAsyncResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestContentException"}, + {"shape":"InvalidRuntimeException"} + ], + "documentation":"

For asynchronous function invocation, use Invoke.

Invokes a function asynchronously.

", + "deprecated":true + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases", + "responseCode":200 + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns a list of aliases for a Lambda function.

" + }, + "ListEventSourceMappings":{ + "name":"ListEventSourceMappings", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/event-source-mappings/", + "responseCode":200 + }, + "input":{"shape":"ListEventSourceMappingsRequest"}, + "output":{"shape":"ListEventSourceMappingsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists event source mappings. Specify an EventSourceArn to only show event source mappings for a single event source.

" + }, + "ListFunctions":{ + "name":"ListFunctions", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/", + "responseCode":200 + }, + "input":{"shape":"ListFunctionsRequest"}, + "output":{"shape":"ListFunctionsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"} + ], + "documentation":"

Returns a list of Lambda functions, with the version-specific configuration of each.

Set FunctionVersion to ALL to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use GetFunction.

" + }, + "ListLayerVersions":{ + "name":"ListLayerVersions", + "http":{ + "method":"GET", + "requestUri":"/2018-10-31/layers/{LayerName}/versions", + "responseCode":200 + }, + "input":{"shape":"ListLayerVersionsRequest"}, + "output":{"shape":"ListLayerVersionsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the versions of an AWS Lambda layer. Versions that have been deleted aren't listed. Specify a runtime identifier to list only versions that indicate that they're compatible with that runtime.

" + }, + "ListLayers":{ + "name":"ListLayers", + "http":{ + "method":"GET", + "requestUri":"/2018-10-31/layers", + "responseCode":200 + }, + "input":{"shape":"ListLayersRequest"}, + "output":{"shape":"ListLayersResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists AWS Lambda layers and shows information about the latest version of each. Specify a runtime identifier to list only layers that indicate that they're compatible with that runtime.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"GET", + "requestUri":"/2017-03-31/tags/{ARN}" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns a function's tags. You can also view tags with GetFunction.

" + }, + "ListVersionsByFunction":{ + "name":"ListVersionsByFunction", + "http":{ + "method":"GET", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":200 + }, + "input":{"shape":"ListVersionsByFunctionRequest"}, + "output":{"shape":"ListVersionsByFunctionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns a list of versions, with the version-specific configuration of each.

" + }, + "PublishLayerVersion":{ + "name":"PublishLayerVersion", + "http":{ + "method":"POST", + "requestUri":"/2018-10-31/layers/{LayerName}/versions", + "responseCode":201 + }, + "input":{"shape":"PublishLayerVersionRequest"}, + "output":{"shape":"PublishLayerVersionResponse"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"CodeStorageExceededException"} + ], + "documentation":"

Creates an AWS Lambda layer from a ZIP archive. Each time you call PublishLayerVersion with the same version name, a new version is created.

Add layers to your function with CreateFunction or UpdateFunctionConfiguration.

" + }, + "PublishVersion":{ + "name":"PublishVersion", + "http":{ + "method":"POST", + "requestUri":"/2015-03-31/functions/{FunctionName}/versions", + "responseCode":201 + }, + "input":{"shape":"PublishVersionRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates a version from the current code and configuration of a function. Use versions to create a snapshot of your function code and configuration that doesn't change.

AWS Lambda doesn't publish a version if the function's configuration and code haven't changed since the last version. Use UpdateFunctionCode or UpdateFunctionConfiguration to update the function before publishing a version.

Clients can invoke versions directly or with an alias. To create an alias, use CreateAlias.

" + }, + "PutFunctionConcurrency":{ + "name":"PutFunctionConcurrency", + "http":{ + "method":"PUT", + "requestUri":"/2017-10-31/functions/{FunctionName}/concurrency", + "responseCode":200 + }, + "input":{"shape":"PutFunctionConcurrencyRequest"}, + "output":{"shape":"Concurrency"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Sets the maximum number of simultaneous executions for a function, and reserves capacity for that concurrency level.

Concurrency settings apply to the function as a whole, including all published versions and the unpublished version. Reserving concurrency both ensures that your function has capacity to process the specified number of events simultaneously, and prevents it from scaling beyond that level. Use GetFunction to see the current setting for a function.

Use GetAccountSettings to see your regional concurrency limit. You can reserve concurrency for as many functions as you like, as long as you leave at least 100 simultaneous executions unreserved for functions that aren't configured with a per-function limit. For more information, see Managing Concurrency.

" + }, + "RemoveLayerVersionPermission":{ + "name":"RemoveLayerVersionPermission", + "http":{ + "method":"DELETE", + "requestUri":"/2018-10-31/layers/{LayerName}/versions/{VersionNumber}/policy/{StatementId}", + "responseCode":204 + }, + "input":{"shape":"RemoveLayerVersionPermissionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Removes a statement from the permissions policy for a version of an AWS Lambda layer. For more information, see AddLayerVersionPermission.

" + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"DELETE", + "requestUri":"/2015-03-31/functions/{FunctionName}/policy/{StatementId}", + "responseCode":204 + }, + "input":{"shape":"RemovePermissionRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Revokes function-use permission from an AWS service or another account. You can get the ID of the statement from the output of GetPolicy.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/2017-03-31/tags/{ARN}", + "responseCode":204 + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Adds tags to a function.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/2017-03-31/tags/{ARN}", + "responseCode":204 + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Removes tags from a function.

" + }, + "UpdateAlias":{ + "name":"UpdateAlias", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/aliases/{Name}", + "responseCode":200 + }, + "input":{"shape":"UpdateAliasRequest"}, + "output":{"shape":"AliasConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Updates the configuration of a Lambda function alias.

" + }, + "UpdateEventSourceMapping":{ + "name":"UpdateEventSourceMapping", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/event-source-mappings/{UUID}", + "responseCode":202 + }, + "input":{"shape":"UpdateEventSourceMappingRequest"}, + "output":{"shape":"EventSourceMappingConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceConflictException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Updates an event source mapping. You can change the function that AWS Lambda invokes, or pause invocation and resume later from the same location.

" + }, + "UpdateFunctionCode":{ + "name":"UpdateFunctionCode", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/code", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionCodeRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"CodeStorageExceededException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Updates a Lambda function's code.

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

" + }, + "UpdateFunctionConfiguration":{ + "name":"UpdateFunctionConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/2015-03-31/functions/{FunctionName}/configuration", + "responseCode":200 + }, + "input":{"shape":"UpdateFunctionConfigurationRequest"}, + "output":{"shape":"FunctionConfiguration"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceConflictException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Modify the version-specific settings of a Lambda function.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or AWS service, use AddPermission.

" + } + }, + "shapes":{ + "AccountLimit":{ + "type":"structure", + "members":{ + "TotalCodeSize":{ + "shape":"Long", + "documentation":"

The amount of storage space that you can use for all deployment packages and layer archives.

" + }, + "CodeSizeUnzipped":{ + "shape":"Long", + "documentation":"

The maximum size of your function's code and layers when they're extracted.

" + }, + "CodeSizeZipped":{ + "shape":"Long", + "documentation":"

The maximum size of a deployment package when it's uploaded directly to AWS Lambda. Use Amazon S3 for larger files.

" + }, + "ConcurrentExecutions":{ + "shape":"Integer", + "documentation":"

The maximum number of simultaneous function executions.

" + }, + "UnreservedConcurrentExecutions":{ + "shape":"UnreservedConcurrentExecutions", + "documentation":"

The maximum number of simultaneous function executions, minus the capacity that's reserved for individual functions with PutFunctionConcurrency.

" + } + }, + "documentation":"

Limits that are related to concurrency and code storage. All file and storage sizes are in bytes.

" + }, + "AccountUsage":{ + "type":"structure", + "members":{ + "TotalCodeSize":{ + "shape":"Long", + "documentation":"

The amount of storage space, in bytes, that's being used by deployment packages and layer archives.

" + }, + "FunctionCount":{ + "shape":"Long", + "documentation":"

The number of Lambda functions.

" + } + }, + "documentation":"

The number of functions and amount of storage in use.

" + }, + "Action":{ + "type":"string", + "pattern":"(lambda:[*]|lambda:[a-zA-Z]+|[*])" + }, + "AddLayerVersionPermissionRequest":{ + "type":"structure", + "required":[ + "LayerName", + "VersionNumber", + "StatementId", + "Action", + "Principal" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "VersionNumber":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

", + "location":"uri", + "locationName":"VersionNumber" + }, + "StatementId":{ + "shape":"StatementId", + "documentation":"

An identifier that distinguishes the policy from others on the same layer version.

" + }, + "Action":{ + "shape":"LayerPermissionAllowedAction", + "documentation":"

The API action that grants access to the layer. For example, lambda:GetLayerVersion.

" + }, + "Principal":{ + "shape":"LayerPermissionAllowedPrincipal", + "documentation":"

An account ID, or * to grant permission to all AWS accounts.

" + }, + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

With the principal set to *, grant permission to all accounts in the specified organization.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", + "location":"querystring", + "locationName":"RevisionId" + } + } + }, + "AddLayerVersionPermissionResponse":{ + "type":"structure", + "members":{ + "Statement":{ + "shape":"String", + "documentation":"

The permission statement.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

A unique identifier for the current revision of the policy.

" + } + } + }, + "AddPermissionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "StatementId", + "Action", + "Principal" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "StatementId":{ + "shape":"StatementId", + "documentation":"

A statement identifier that differentiates the statement from others in the same policy.

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

The action that the principal can use on the function. For example, lambda:InvokeFunction or lambda:GetFunction.

" + }, + "Principal":{ + "shape":"Principal", + "documentation":"

The AWS service or account that invokes the function. If you specify a service, use SourceArn or SourceAccount to limit who can invoke the function through that service.

" + }, + "SourceArn":{ + "shape":"Arn", + "documentation":"

For AWS services, the ARN of the AWS resource that invokes the function. For example, an Amazon S3 bucket or Amazon SNS topic.

" + }, + "SourceAccount":{ + "shape":"SourceOwner", + "documentation":"

For AWS services, the ID of the account that owns the resource. Use this instead of SourceArn to grant permission to resources that are owned by another account (for example, all of an account's Amazon S3 buckets). Or use it together with SourceArn to ensure that the resource is owned by the specified account. For example, an Amazon S3 bucket could be deleted by its owner and recreated by another account.

" + }, + "EventSourceToken":{ + "shape":"EventSourceToken", + "documentation":"

For Alexa Smart Home functions, a token that must be supplied by the invoker.

" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to add permissions to a published version of the function.

", + "location":"querystring", + "locationName":"Qualifier" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

" + } + } + }, + "AddPermissionResponse":{ + "type":"structure", + "members":{ + "Statement":{ + "shape":"String", + "documentation":"

The permission statement that's added to the function policy.

" + } + } + }, + "AdditionalVersion":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[0-9]+" + }, + "AdditionalVersionWeights":{ + "type":"map", + "key":{"shape":"AdditionalVersion"}, + "value":{"shape":"Weight"} + }, + "Alias":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_]+)" + }, + "AliasConfiguration":{ + "type":"structure", + "members":{ + "AliasArn":{ + "shape":"FunctionArn", + "documentation":"

The Amazon Resource Name (ARN) of the alias.

" + }, + "Name":{ + "shape":"Alias", + "documentation":"

The name of the alias.

" + }, + "FunctionVersion":{ + "shape":"Version", + "documentation":"

The function version that the alias invokes.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the alias.

" + }, + "RoutingConfig":{ + "shape":"AliasRoutingConfiguration", + "documentation":"

The routing configuration of the alias.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

A unique identifier that changes when you update the alias.

" + } + }, + "documentation":"

Provides configuration information about a Lambda function alias.

" + }, + "AliasList":{ + "type":"list", + "member":{"shape":"AliasConfiguration"} + }, + "AliasRoutingConfiguration":{ + "type":"structure", + "members":{ + "AdditionalVersionWeights":{ + "shape":"AdditionalVersionWeights", + "documentation":"

The name of the second alias, and the percentage of traffic that's routed to it.

" + } + }, + "documentation":"

The traffic-shifting configuration of a Lambda function alias.

" + }, + "Arn":{ + "type":"string", + "pattern":"arn:(aws[a-zA-Z0-9-]*):([a-zA-Z0-9\\-])+:([a-z]{2}(-gov)?-[a-z]+-\\d{1})?:(\\d{12})?:(.*)" + }, + "BatchSize":{ + "type":"integer", + "max":10000, + "min":1 + }, + "Blob":{ + "type":"blob", + "sensitive":true + }, + "BlobStream":{ + "type":"blob", + "streaming":true + }, + "Boolean":{"type":"boolean"}, + "CodeStorageExceededException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The exception type.

" + }, + "message":{"shape":"String"} + }, + "documentation":"

You have exceeded your maximum total code size per account. Learn more

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CompatibleRuntimes":{ + "type":"list", + "member":{"shape":"Runtime"}, + "max":5 + }, + "Concurrency":{ + "type":"structure", + "members":{ + "ReservedConcurrentExecutions":{ + "shape":"ReservedConcurrentExecutions", + "documentation":"

The number of concurrent executions that are reserved for this function. For more information, see Managing Concurrency.

" + } + } + }, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name", + "FunctionVersion" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "documentation":"

The name of the alias.

" + }, + "FunctionVersion":{ + "shape":"Version", + "documentation":"

The function version that the alias invokes.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the alias.

" + }, + "RoutingConfig":{ + "shape":"AliasRoutingConfiguration", + "documentation":"

The routing configuration of the alias.

" + } + } + }, + "CreateEventSourceMappingRequest":{ + "type":"structure", + "required":[ + "EventSourceArn", + "FunctionName" + ], + "members":{ + "EventSourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis - The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams - The ARN of the stream.

  • Amazon Simple Queue Service - The ARN of the queue.

" + }, + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

Disables the event source mapping to pause polling and invocation.

" + }, + "BatchSize":{ + "shape":"BatchSize", + "documentation":"

The maximum number of items to retrieve in a single batch.

  • Amazon Kinesis - Default 100. Max 10,000.

  • Amazon DynamoDB Streams - Default 100. Max 1,000.

  • Amazon Simple Queue Service - Default 10. Max 10.

" + }, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "StartingPosition":{ + "shape":"EventSourcePosition", + "documentation":"

The position in a stream from which to start reading. Required for Amazon Kinesis and Amazon DynamoDB Streams sources. AT_TIMESTAMP is only supported for Amazon Kinesis streams.

" + }, + "StartingPositionTimestamp":{ + "shape":"Date", + "documentation":"

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading.

" + } + } + }, + "CreateFunctionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Runtime", + "Role", + "Handler", + "Code" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

" + }, + "Runtime":{ + "shape":"Runtime", + "documentation":"

The identifier of the function's runtime.

" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the function's execution role.

" + }, + "Handler":{ + "shape":"Handler", + "documentation":"

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.

" + }, + "Code":{ + "shape":"FunctionCode", + "documentation":"

The code for the function.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the function.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "documentation":"

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" + }, + "Publish":{ + "shape":"Boolean", + "documentation":"

Set to true to publish the first version of the function during creation.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.

" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

" + }, + "Environment":{ + "shape":"Environment", + "documentation":"

Environment variables that are accessible from function code during execution.

" + }, + "KMSKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

" + }, + "TracingConfig":{ + "shape":"TracingConfig", + "documentation":"

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags to apply to the function.

" + }, + "Layers":{ + "shape":"LayerList", + "documentation":"

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + } + } + }, + "Date":{"type":"timestamp"}, + "DeadLetterConfig":{ + "type":"structure", + "members":{ + "TargetArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic.

" + } + }, + "documentation":"

The dead letter queue for failed asynchronous invocations.

" + }, + "DeleteAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "documentation":"

The name of the alias.

", + "location":"uri", + "locationName":"Name" + } + } + }, + "DeleteEventSourceMappingRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "documentation":"

The identifier of the event source mapping.

", + "location":"uri", + "locationName":"UUID" + } + } + }, + "DeleteFunctionConcurrencyRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + } + } + }, + "DeleteFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function or version.

Name formats

  • Function name - my-function (name-only), my-function:1 (with version).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version to delete. You can't delete a version that's referenced by an alias.

", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "DeleteLayerVersionRequest":{ + "type":"structure", + "required":[ + "LayerName", + "VersionNumber" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "VersionNumber":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

", + "location":"uri", + "locationName":"VersionNumber" + } + } + }, + "Description":{ + "type":"string", + "max":256, + "min":0 + }, + "EC2AccessDeniedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

Need additional permissions to configure VPC settings.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "EC2ThrottledException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

AWS Lambda was throttled by Amazon EC2 during Lambda function initialization using the execution role provided for the Lambda function.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "EC2UnexpectedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"}, + "EC2ErrorCode":{"shape":"String"} + }, + "documentation":"

AWS Lambda received an unexpected EC2 client exception while setting up for the Lambda function.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "ENILimitReachedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

AWS Lambda was not able to create an Elastic Network Interface (ENI) in the VPC, specified as part of Lambda function configuration, because the limit for network interfaces has been reached.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "Enabled":{"type":"boolean"}, + "Environment":{ + "type":"structure", + "members":{ + "Variables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment variable key-value pairs.

" + } + }, + "documentation":"

A function's environment variable settings.

" + }, + "EnvironmentError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"String", + "documentation":"

The error code.

" + }, + "Message":{ + "shape":"SensitiveString", + "documentation":"

The error message.

" + } + }, + "documentation":"

Error messages for environment variables that couldn't be applied.

" + }, + "EnvironmentResponse":{ + "type":"structure", + "members":{ + "Variables":{ + "shape":"EnvironmentVariables", + "documentation":"

Environment variable key-value pairs.

" + }, + "Error":{ + "shape":"EnvironmentError", + "documentation":"

Error messages for environment variables that couldn't be applied.

" + } + }, + "documentation":"

The results of a configuration update that applied environment variables.

" + }, + "EnvironmentVariableName":{ + "type":"string", + "pattern":"[a-zA-Z]([a-zA-Z0-9_])+", + "sensitive":true + }, + "EnvironmentVariableValue":{ + "type":"string", + "sensitive":true + }, + "EnvironmentVariables":{ + "type":"map", + "key":{"shape":"EnvironmentVariableName"}, + "value":{"shape":"EnvironmentVariableValue"}, + "sensitive":true + }, + "EventSourceMappingConfiguration":{ + "type":"structure", + "members":{ + "UUID":{ + "shape":"String", + "documentation":"

The identifier of the event source mapping.

" + }, + "BatchSize":{ + "shape":"BatchSize", + "documentation":"

The maximum number of items to retrieve in a single batch.

" + }, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"}, + "EventSourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event source.

" + }, + "FunctionArn":{ + "shape":"FunctionArn", + "documentation":"

The ARN of the Lambda function.

" + }, + "LastModified":{ + "shape":"Date", + "documentation":"

The date that the event source mapping was last updated.

" + }, + "LastProcessingResult":{ + "shape":"String", + "documentation":"

The result of the last AWS Lambda invocation of your Lambda function.

" + }, + "State":{ + "shape":"String", + "documentation":"

The state of the event source mapping. It can be one of the following: Creating, Enabling, Enabled, Disabling, Disabled, Updating, or Deleting.

" + }, + "StateTransitionReason":{ + "shape":"String", + "documentation":"

The cause of the last state change, either User initiated or Lambda initiated.

" + } + }, + "documentation":"

A mapping between an AWS resource and an AWS Lambda function. See CreateEventSourceMapping for details.

" + }, + "EventSourceMappingsList":{ + "type":"list", + "member":{"shape":"EventSourceMappingConfiguration"} + }, + "EventSourcePosition":{ + "type":"string", + "enum":[ + "TRIM_HORIZON", + "LATEST", + "AT_TIMESTAMP" + ] + }, + "EventSourceToken":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9._\\-]+" + }, + "FunctionArn":{ + "type":"string", + "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "FunctionCode":{ + "type":"structure", + "members":{ + "ZipFile":{ + "shape":"Blob", + "documentation":"

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

" + }, + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The Amazon S3 key of the deployment package.

" + }, + "S3ObjectVersion":{ + "shape":"S3ObjectVersion", + "documentation":"

For versioned objects, the version of the deployment package object to use.

" + } + }, + "documentation":"

The code for the Lambda function. You can specify either an object in Amazon S3, or upload a deployment package directly.

" + }, + "FunctionCodeLocation":{ + "type":"structure", + "members":{ + "RepositoryType":{ + "shape":"String", + "documentation":"

The service that's hosting the file.

" + }, + "Location":{ + "shape":"String", + "documentation":"

A presigned URL that you can use to download the deployment package.

" + } + }, + "documentation":"

Details about a function's deployment package.

" + }, + "FunctionConfiguration":{ + "type":"structure", + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the function.

" + }, + "FunctionArn":{ + "shape":"NameSpacedFunctionArn", + "documentation":"

The function's Amazon Resource Name (ARN).

" + }, + "Runtime":{ + "shape":"Runtime", + "documentation":"

The runtime environment for the Lambda function.

" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The function's execution role.

" + }, + "Handler":{ + "shape":"Handler", + "documentation":"

The function that Lambda calls to begin executing your function.

" + }, + "CodeSize":{ + "shape":"Long", + "documentation":"

The size of the function's deployment package, in bytes.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The function's description.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The amount of time that Lambda allows a function to run before stopping it.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "documentation":"

The memory that's allocated to the function.

" + }, + "LastModified":{ + "shape":"Timestamp", + "documentation":"

The date and time that the function was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + }, + "CodeSha256":{ + "shape":"String", + "documentation":"

The SHA256 hash of the function's deployment package.

" + }, + "Version":{ + "shape":"Version", + "documentation":"

The version of the Lambda function.

" + }, + "VpcConfig":{ + "shape":"VpcConfigResponse", + "documentation":"

The function's networking configuration.

" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"

The function's dead letter queue.

" + }, + "Environment":{ + "shape":"EnvironmentResponse", + "documentation":"

The function's environment variables.

" + }, + "KMSKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer-managed CMK.

" + }, + "TracingConfig":{ + "shape":"TracingConfigResponse", + "documentation":"

The function's AWS X-Ray tracing configuration.

" + }, + "MasterArn":{ + "shape":"FunctionArn", + "documentation":"

For Lambda@Edge functions, the ARN of the master function.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

The latest updated revision of the function or alias.

" + }, + "Layers":{ + "shape":"LayersReferenceList", + "documentation":"

The function's layers.

" + } + }, + "documentation":"

Details about a function's configuration.

" + }, + "FunctionList":{ + "type":"list", + "member":{"shape":"FunctionConfiguration"} + }, + "FunctionName":{ + "type":"string", + "max":140, + "min":1, + "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "FunctionVersion":{ + "type":"string", + "enum":["ALL"] + }, + "GetAccountSettingsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAccountSettingsResponse":{ + "type":"structure", + "members":{ + "AccountLimit":{ + "shape":"AccountLimit", + "documentation":"

Limits that are related to concurrency and code storage.

" + }, + "AccountUsage":{ + "shape":"AccountUsage", + "documentation":"

The number of functions and amount of storage in use.

" + } + } + }, + "GetAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "documentation":"

The name of the alias.

", + "location":"uri", + "locationName":"Name" + } + } + }, + "GetEventSourceMappingRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "documentation":"

The identifier of the event source mapping.

", + "location":"uri", + "locationName":"UUID" + } + } + }, + "GetFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to get details about a published version of the function.

", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to get details about a published version of the function.

", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetFunctionResponse":{ + "type":"structure", + "members":{ + "Configuration":{ + "shape":"FunctionConfiguration", + "documentation":"

The configuration of the function or version.

" + }, + "Code":{ + "shape":"FunctionCodeLocation", + "documentation":"

The deployment package of the function or version.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The function's tags.

" + }, + "Concurrency":{ + "shape":"Concurrency", + "documentation":"

The function's reserved concurrency.

" + } + } + }, + "GetLayerVersionByArnRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"LayerVersionArn", + "documentation":"

The ARN of the layer version.

", + "location":"querystring", + "locationName":"Arn" + } + } + }, + "GetLayerVersionPolicyRequest":{ + "type":"structure", + "required":[ + "LayerName", + "VersionNumber" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "VersionNumber":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

", + "location":"uri", + "locationName":"VersionNumber" + } + } + }, + "GetLayerVersionPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"String", + "documentation":"

The policy document.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

A unique identifier for the current revision of the policy.

" + } + } + }, + "GetLayerVersionRequest":{ + "type":"structure", + "required":[ + "LayerName", + "VersionNumber" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "VersionNumber":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

", + "location":"uri", + "locationName":"VersionNumber" + } + } + }, + "GetLayerVersionResponse":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"LayerVersionContentOutput", + "documentation":"

Details about the layer version.

" + }, + "LayerArn":{ + "shape":"LayerArn", + "documentation":"

The ARN of the layer.

" + }, + "LayerVersionArn":{ + "shape":"LayerVersionArn", + "documentation":"

The ARN of the layer version.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the version.

" + }, + "CreatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + }, + "Version":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

" + }, + "CompatibleRuntimes":{ + "shape":"CompatibleRuntimes", + "documentation":"

The layer's compatible runtimes.

" + }, + "LicenseInfo":{ + "shape":"LicenseInfo", + "documentation":"

The layer's software license.

" + } + } + }, + "GetPolicyRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to get the policy for that resource.

", + "location":"querystring", + "locationName":"Qualifier" + } + } + }, + "GetPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"String", + "documentation":"

The resource-based policy.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

A unique identifier for the current revision of the policy.

" + } + } + }, + "Handler":{ + "type":"string", + "max":128, + "pattern":"[^\\s]+" + }, + "HttpStatus":{"type":"integer"}, + "Integer":{"type":"integer"}, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The exception type.

" + }, + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

One of the parameters in the request is invalid. For example, if you provided an IAM role for AWS Lambda to assume in the CreateFunction or the UpdateFunctionConfiguration API, that AWS Lambda is unable to assume you will get this exception.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestContentException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The exception type.

" + }, + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

The request body could not be parsed as JSON.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRuntimeException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

The runtime or runtime version specified is not supported.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvalidSecurityGroupIDException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

The Security Group ID provided in the Lambda function VPC configuration is invalid.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvalidSubnetIDException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

The Subnet ID provided in the Lambda function VPC configuration is invalid.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvalidZipFileException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

AWS Lambda could not unzip the deployment package.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "InvocationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "InvocationType":{ + "shape":"InvocationType", + "documentation":"

Choose from the following options.

  • RequestResponse (default) - Invoke the function synchronously. Keep the connection open until the function returns a response or times out. The API response includes the function response and additional data.

  • Event - Invoke the function asynchronously. Send events that fail multiple times to the function's dead-letter queue (if it's configured). The API response only includes a status code.

  • DryRun - Validate parameter values and verify that the user or role has permission to invoke the function.

", + "location":"header", + "locationName":"X-Amz-Invocation-Type" + }, + "LogType":{ + "shape":"LogType", + "documentation":"

Set to Tail to include the execution log in the response.

", + "location":"header", + "locationName":"X-Amz-Log-Type" + }, + "ClientContext":{ + "shape":"String", + "documentation":"

Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object.

", + "location":"header", + "locationName":"X-Amz-Client-Context" + }, + "Payload":{ + "shape":"Blob", + "documentation":"

The JSON that you want to provide to your Lambda function as input.

" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to invoke a published version of the function.

", + "location":"querystring", + "locationName":"Qualifier" + } + }, + "payload":"Payload" + }, + "InvocationResponse":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"Integer", + "documentation":"

The HTTP status code is in the 200 range for a successful request. For the RequestResponse invocation type, this status code is 200. For the Event invocation type, this status code is 202. For the DryRun invocation type, the status code is 204.

", + "location":"statusCode" + }, + "FunctionError":{ + "shape":"String", + "documentation":"

If present, indicates that an error occurred during function execution. Details about the error are included in the response payload.

  • Handled - The runtime caught an error thrown by the function and formatted it into a JSON document.

  • Unhandled - The runtime didn't handle the error. For example, the function ran out of memory or timed out.

", + "location":"header", + "locationName":"X-Amz-Function-Error" + }, + "LogResult":{ + "shape":"String", + "documentation":"

The last 4 KB of the execution log, which is base64 encoded.

", + "location":"header", + "locationName":"X-Amz-Log-Result" + }, + "Payload":{ + "shape":"Blob", + "documentation":"

The response from the function, or an error object.

" + }, + "ExecutedVersion":{ + "shape":"Version", + "documentation":"

The version of the function that executed. When you invoke a function with an alias, this indicates which version the alias resolved to.

", + "location":"header", + "locationName":"X-Amz-Executed-Version" + } + }, + "payload":"Payload" + }, + "InvocationType":{ + "type":"string", + "enum":[ + "Event", + "RequestResponse", + "DryRun" + ] + }, + "InvokeAsyncRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "InvokeArgs" + ], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "InvokeArgs":{ + "shape":"BlobStream", + "documentation":"

The JSON that you want to provide to your Lambda function as input.

" + } + }, + "deprecated":true, + "payload":"InvokeArgs" + }, + "InvokeAsyncResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"HttpStatus", + "documentation":"

The status code.

", + "location":"statusCode" + } + }, + "documentation":"

A success response (202 Accepted) indicates that the request is queued for invocation.

", + "deprecated":true + }, + "KMSAccessDeniedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

Lambda was unable to decrypt the environment variables because KMS access was denied. Check the Lambda function's KMS permissions.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "KMSDisabledException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key used is disabled. Check the Lambda function's KMS key settings.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "KMSInvalidStateException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key used is in an invalid state for Decrypt. Check the function's KMS key settings.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "KMSKeyArn":{ + "type":"string", + "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" + }, + "KMSNotFoundException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

Lambda was unable to decrypt the environment variables because the KMS key was not found. Check the function's KMS key settings.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "Layer":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"LayerVersionArn", + "documentation":"

The Amazon Resource Name (ARN) of the function layer.

" + }, + "CodeSize":{ + "shape":"Long", + "documentation":"

The size of the layer archive in bytes.

" + } + }, + "documentation":"

An AWS Lambda layer.

" + }, + "LayerArn":{ + "type":"string", + "max":140, + "min":1, + "pattern":"arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+" + }, + "LayerList":{ + "type":"list", + "member":{"shape":"LayerVersionArn"} + }, + "LayerName":{ + "type":"string", + "max":140, + "min":1, + "pattern":"(arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+)|[a-zA-Z0-9-_]+" + }, + "LayerPermissionAllowedAction":{ + "type":"string", + "pattern":"lambda:GetLayerVersion" + }, + "LayerPermissionAllowedPrincipal":{ + "type":"string", + "pattern":"\\d{12}|\\*|arn:(aws[a-zA-Z-]*):iam::\\d{12}:root" + }, + "LayerVersionArn":{ + "type":"string", + "max":140, + "min":1, + "pattern":"arn:[a-zA-Z0-9-]+:lambda:[a-zA-Z0-9-]+:\\d{12}:layer:[a-zA-Z0-9-_]+:[0-9]+" + }, + "LayerVersionContentInput":{ + "type":"structure", + "members":{ + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

The Amazon S3 bucket of the layer archive.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The Amazon S3 key of the layer archive.

" + }, + "S3ObjectVersion":{ + "shape":"S3ObjectVersion", + "documentation":"

For versioned objects, the version of the layer archive object to use.

" + }, + "ZipFile":{ + "shape":"Blob", + "documentation":"

The base64-encoded contents of the layer archive. AWS SDK and AWS CLI clients handle the encoding for you.

" + } + }, + "documentation":"

A ZIP archive that contains the contents of an AWS Lambda layer. You can specify either an Amazon S3 location, or upload a layer archive directly.

" + }, + "LayerVersionContentOutput":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"String", + "documentation":"

A link to the layer archive in Amazon S3 that is valid for 10 minutes.

" + }, + "CodeSha256":{ + "shape":"String", + "documentation":"

The SHA-256 hash of the layer archive.

" + }, + "CodeSize":{ + "shape":"Long", + "documentation":"

The size of the layer archive in bytes.

" + } + }, + "documentation":"

Details about a version of an AWS Lambda layer.

" + }, + "LayerVersionNumber":{"type":"long"}, + "LayerVersionsList":{ + "type":"list", + "member":{"shape":"LayerVersionsListItem"} + }, + "LayerVersionsListItem":{ + "type":"structure", + "members":{ + "LayerVersionArn":{ + "shape":"LayerVersionArn", + "documentation":"

The ARN of the layer version.

" + }, + "Version":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the version.

" + }, + "CreatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the version was created, in ISO 8601 format. For example, 2018-11-27T15:10:45.123+0000.

" + }, + "CompatibleRuntimes":{ + "shape":"CompatibleRuntimes", + "documentation":"

The layer's compatible runtimes.

" + }, + "LicenseInfo":{ + "shape":"LicenseInfo", + "documentation":"

The layer's open-source license.

" + } + }, + "documentation":"

Details about a version of an AWS Lambda layer.

" + }, + "LayersList":{ + "type":"list", + "member":{"shape":"LayersListItem"} + }, + "LayersListItem":{ + "type":"structure", + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name of the layer.

" + }, + "LayerArn":{ + "shape":"LayerArn", + "documentation":"

The Amazon Resource Name (ARN) of the function layer.

" + }, + "LatestMatchingVersion":{ + "shape":"LayerVersionsListItem", + "documentation":"

The newest version of the layer.

" + } + }, + "documentation":"

Details about an AWS Lambda layer.

" + }, + "LayersReferenceList":{ + "type":"list", + "member":{"shape":"Layer"} + }, + "LicenseInfo":{ + "type":"string", + "max":512 + }, + "ListAliasesRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "FunctionVersion":{ + "shape":"Version", + "documentation":"

Specify a function version to only list aliases that invoke that version.

", + "location":"querystring", + "locationName":"FunctionVersion" + }, + "Marker":{ + "shape":"String", + "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "documentation":"

Limit the number of aliases returned.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

The pagination token that's included if more results are available.

" + }, + "Aliases":{ + "shape":"AliasList", + "documentation":"

A list of aliases.

" + } + } + }, + "ListEventSourceMappingsRequest":{ + "type":"structure", + "members":{ + "EventSourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event source.

  • Amazon Kinesis - The ARN of the data stream or a stream consumer.

  • Amazon DynamoDB Streams - The ARN of the stream.

  • Amazon Simple Queue Service - The ARN of the queue.

", + "location":"querystring", + "locationName":"EventSourceArn" + }, + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

", + "location":"querystring", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "documentation":"

A pagination token returned by a previous call.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "documentation":"

The maximum number of event source mappings to return.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListEventSourceMappingsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

A pagination token that's returned when the response doesn't contain all event source mappings.

" + }, + "EventSourceMappings":{ + "shape":"EventSourceMappingsList", + "documentation":"

A list of event source mappings.

" + } + } + }, + "ListFunctionsRequest":{ + "type":"structure", + "members":{ + "MasterRegion":{ + "shape":"MasterRegion", + "documentation":"

For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-2 or ALL. If specified, you must set FunctionVersion to ALL.

", + "location":"querystring", + "locationName":"MasterRegion" + }, + "FunctionVersion":{ + "shape":"FunctionVersion", + "documentation":"

Set to ALL to include entries for all published versions of each function.

", + "location":"querystring", + "locationName":"FunctionVersion" + }, + "Marker":{ + "shape":"String", + "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "documentation":"

Specify a value between 1 and 50 to limit the number of functions in the response.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListFunctionsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

The pagination token that's included if more results are available.

" + }, + "Functions":{ + "shape":"FunctionList", + "documentation":"

A list of Lambda functions.

" + } + }, + "documentation":"

A list of Lambda functions.

" + }, + "ListLayerVersionsRequest":{ + "type":"structure", + "required":["LayerName"], + "members":{ + "CompatibleRuntime":{ + "shape":"Runtime", + "documentation":"

A runtime identifier. For example, go1.x.

", + "location":"querystring", + "locationName":"CompatibleRuntime" + }, + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "Marker":{ + "shape":"String", + "documentation":"

A pagination token returned by a previous call.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxLayerListItems", + "documentation":"

The maximum number of versions to return.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListLayerVersionsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

A pagination token returned when the response doesn't contain all versions.

" + }, + "LayerVersions":{ + "shape":"LayerVersionsList", + "documentation":"

A list of versions.

" + } + } + }, + "ListLayersRequest":{ + "type":"structure", + "members":{ + "CompatibleRuntime":{ + "shape":"Runtime", + "documentation":"

A runtime identifier. For example, go1.x.

", + "location":"querystring", + "locationName":"CompatibleRuntime" + }, + "Marker":{ + "shape":"String", + "documentation":"

A pagination token returned by a previous call.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxLayerListItems", + "documentation":"

The maximum number of layers to return.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListLayersResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

A pagination token returned when the response doesn't contain all layers.

" + }, + "Layers":{ + "shape":"LayersList", + "documentation":"

A list of function layers.

" + } + } + }, + "ListTagsRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"FunctionArn", + "documentation":"

The function's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"ARN" + } + } + }, + "ListTagsResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The function's tags.

" + } + } + }, + "ListVersionsByFunctionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"NamespacedFunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Marker":{ + "shape":"String", + "documentation":"

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

", + "location":"querystring", + "locationName":"Marker" + }, + "MaxItems":{ + "shape":"MaxListItems", + "documentation":"

Limit the number of versions that are returned.

", + "location":"querystring", + "locationName":"MaxItems" + } + } + }, + "ListVersionsByFunctionResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"String", + "documentation":"

The pagination token that's included if more results are available.

" + }, + "Versions":{ + "shape":"FunctionList", + "documentation":"

A list of Lambda function versions.

" + } + } + }, + "LogType":{ + "type":"string", + "enum":[ + "None", + "Tail" + ] + }, + "Long":{"type":"long"}, + "MasterRegion":{ + "type":"string", + "pattern":"ALL|[a-z]{2}(-gov)?-[a-z]+-\\d{1}" + }, + "MaxLayerListItems":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxListItems":{ + "type":"integer", + "max":10000, + "min":1 + }, + "MaximumBatchingWindowInSeconds":{ + "type":"integer", + "max":300, + "min":0 + }, + "MemorySize":{ + "type":"integer", + "max":3008, + "min":128 + }, + "NameSpacedFunctionArn":{ + "type":"string", + "pattern":"arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "NamespacedFunctionName":{ + "type":"string", + "max":170, + "min":1, + "pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}(-gov)?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_\\.]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "NamespacedStatementId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"([a-zA-Z0-9-_.]+)" + }, + "OrganizationId":{ + "type":"string", + "pattern":"o-[a-z0-9]{10,32}" + }, + "PolicyLengthExceededException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "documentation":"

The permissions policy for the resource is too large. Learn more

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The exception type.

" + }, + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

The RevisionId provided does not match the latest RevisionId for the Lambda function or alias. Call the GetFunction or the GetAlias API to retrieve the latest RevisionId for your resource.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "Principal":{ + "type":"string", + "pattern":".*" + }, + "PublishLayerVersionRequest":{ + "type":"structure", + "required":[ + "LayerName", + "Content" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the version.

" + }, + "Content":{ + "shape":"LayerVersionContentInput", + "documentation":"

The function layer archive.

" + }, + "CompatibleRuntimes":{ + "shape":"CompatibleRuntimes", + "documentation":"

A list of compatible function runtimes. Used for filtering with ListLayers and ListLayerVersions.

" + }, + "LicenseInfo":{ + "shape":"LicenseInfo", + "documentation":"

The layer's software license. It can be any of the following:

  • An SPDX license identifier. For example, MIT.

  • The URL of a license hosted on the internet. For example, https://opensource.org/licenses/MIT.

  • The full text of the license.

" + } + } + }, + "PublishLayerVersionResponse":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"LayerVersionContentOutput", + "documentation":"

Details about the layer version.

" + }, + "LayerArn":{ + "shape":"LayerArn", + "documentation":"

The ARN of the layer.

" + }, + "LayerVersionArn":{ + "shape":"LayerVersionArn", + "documentation":"

The ARN of the layer version.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

The description of the version.

" + }, + "CreatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the layer version was created, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

" + }, + "Version":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

" + }, + "CompatibleRuntimes":{ + "shape":"CompatibleRuntimes", + "documentation":"

The layer's compatible runtimes.

" + }, + "LicenseInfo":{ + "shape":"LicenseInfo", + "documentation":"

The layer's software license.

" + } + } + }, + "PublishVersionRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "CodeSha256":{ + "shape":"String", + "documentation":"

Only publish a version if the hash value matches the value that's specified. Use this option to avoid publishing a version if the function code has changed since you last updated it. You can get the hash for the version that you uploaded from the output of UpdateFunctionCode.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description for the version to override the description in the function configuration.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid publishing a version if the function configuration has changed since you last updated it.

" + } + } + }, + "PutFunctionConcurrencyRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "ReservedConcurrentExecutions" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "ReservedConcurrentExecutions":{ + "shape":"ReservedConcurrentExecutions", + "documentation":"

The number of simultaneous executions to reserve for the function.

" + } + } + }, + "Qualifier":{ + "type":"string", + "max":128, + "min":1, + "pattern":"(|[a-zA-Z0-9$_-]+)" + }, + "RemoveLayerVersionPermissionRequest":{ + "type":"structure", + "required":[ + "LayerName", + "VersionNumber", + "StatementId" + ], + "members":{ + "LayerName":{ + "shape":"LayerName", + "documentation":"

The name or Amazon Resource Name (ARN) of the layer.

", + "location":"uri", + "locationName":"LayerName" + }, + "VersionNumber":{ + "shape":"LayerVersionNumber", + "documentation":"

The version number.

", + "location":"uri", + "locationName":"VersionNumber" + }, + "StatementId":{ + "shape":"StatementId", + "documentation":"

The identifier that was specified when the statement was added.

", + "location":"uri", + "locationName":"StatementId" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the policy if the revision ID matches the ID specified. Use this option to avoid modifying a policy that has changed since you last read it.

", + "location":"querystring", + "locationName":"RevisionId" + } + } + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "StatementId" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function, version, or alias.

Name formats

  • Function name - my-function (name-only), my-function:v1 (with alias).

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "StatementId":{ + "shape":"NamespacedStatementId", + "documentation":"

Statement ID of the permission to remove.

", + "location":"uri", + "locationName":"StatementId" + }, + "Qualifier":{ + "shape":"Qualifier", + "documentation":"

Specify a version or alias to remove permissions from a published version of the function.

", + "location":"querystring", + "locationName":"Qualifier" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the policy if the revision ID matches the ID that's specified. Use this option to avoid modifying a policy that has changed since you last read it.

", + "location":"querystring", + "locationName":"RevisionId" + } + } + }, + "RequestTooLargeException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "documentation":"

The request payload exceeded the Invoke request body JSON input limit. For more information, see Limits.

", + "error":{"httpStatusCode":413}, + "exception":true + }, + "ReservedConcurrentExecutions":{ + "type":"integer", + "min":0 + }, + "ResourceArn":{ + "type":"string", + "pattern":"(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()" + }, + "ResourceConflictException":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The exception type.

" + }, + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

The resource already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

The operation conflicts with the resource's availability. For example, you attempted to update an EventSource Mapping in CREATING, or tried to delete a EventSource mapping currently in the UPDATING state.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

The resource (for example, a Lambda function or access policy statement) specified in the request does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoleArn":{ + "type":"string", + "pattern":"arn:(aws[a-zA-Z-]*)?:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "Runtime":{ + "type":"string", + "enum":[ + "nodejs", + "nodejs4.3", + "nodejs6.10", + "nodejs8.10", + "nodejs10.x", + "java8", + "python2.7", + "python3.6", + "python3.7", + "dotnetcore1.0", + "dotnetcore2.0", + "dotnetcore2.1", + "nodejs4.3-edge", + "go1.x", + "ruby2.5", + "provided" + ] + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^[0-9A-Za-z\\.\\-_]*(?The AWS Lambda service encountered an internal error.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "SourceOwner":{ + "type":"string", + "pattern":"\\d{12}" + }, + "StatementId":{ + "type":"string", + "max":100, + "min":1, + "pattern":"([a-zA-Z0-9-_]+)" + }, + "String":{"type":"string"}, + "SubnetIPAddressLimitReachedException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

AWS Lambda was not able to set up VPC access for the Lambda function because one or more configured subnets has no available IP addresses.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "SubnetId":{"type":"string"}, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16 + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"FunctionArn", + "documentation":"

The function's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"ARN" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A list of tags to apply to the function.

" + } + } + }, + "TagValue":{"type":"string"}, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "ThrottleReason":{ + "type":"string", + "enum":[ + "ConcurrentInvocationLimitExceeded", + "FunctionInvocationRateLimitExceeded", + "ReservedFunctionConcurrentInvocationLimitExceeded", + "ReservedFunctionInvocationRateLimitExceeded", + "CallerRateLimitExceeded" + ] + }, + "Timeout":{ + "type":"integer", + "min":1 + }, + "Timestamp":{"type":"string"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "documentation":"

The number of seconds the caller should wait before retrying.

", + "location":"header", + "locationName":"Retry-After" + }, + "Type":{"shape":"String"}, + "message":{"shape":"String"}, + "Reason":{"shape":"ThrottleReason"} + }, + "documentation":"

Request throughput limit exceeded.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TracingConfig":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"TracingMode", + "documentation":"

The tracing mode.

" + } + }, + "documentation":"

The function's AWS X-Ray tracing configuration.

" + }, + "TracingConfigResponse":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"TracingMode", + "documentation":"

The tracing mode.

" + } + }, + "documentation":"

The function's AWS X-Ray tracing configuration.

" + }, + "TracingMode":{ + "type":"string", + "enum":[ + "Active", + "PassThrough" + ] + }, + "UnreservedConcurrentExecutions":{ + "type":"integer", + "min":0 + }, + "UnsupportedMediaTypeException":{ + "type":"structure", + "members":{ + "Type":{"shape":"String"}, + "message":{"shape":"String"} + }, + "documentation":"

The content type of the Invoke request body is not JSON.

", + "error":{"httpStatusCode":415}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"FunctionArn", + "documentation":"

The function's Amazon Resource Name (ARN).

", + "location":"uri", + "locationName":"ARN" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A list of tag keys to remove from the function.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UpdateAliasRequest":{ + "type":"structure", + "required":[ + "FunctionName", + "Name" + ], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Name":{ + "shape":"Alias", + "documentation":"

The name of the alias.

", + "location":"uri", + "locationName":"Name" + }, + "FunctionVersion":{ + "shape":"Version", + "documentation":"

The function version that the alias invokes.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the alias.

" + }, + "RoutingConfig":{ + "shape":"AliasRoutingConfiguration", + "documentation":"

The routing configuration of the alias.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the alias if the revision ID matches the ID that's specified. Use this option to avoid modifying an alias that has changed since you last read it.

" + } + } + }, + "UpdateEventSourceMappingRequest":{ + "type":"structure", + "required":["UUID"], + "members":{ + "UUID":{ + "shape":"String", + "documentation":"

The identifier of the event source mapping.

", + "location":"uri", + "locationName":"UUID" + }, + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - MyFunction.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.

  • Version or Alias ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction:PROD.

  • Partial ARN - 123456789012:function:MyFunction.

The length constraint applies only to the full ARN. If you specify only the function name, it's limited to 64 characters in length.

" + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

Disables the event source mapping to pause polling and invocation.

" + }, + "BatchSize":{ + "shape":"BatchSize", + "documentation":"

The maximum number of items to retrieve in a single batch.

  • Amazon Kinesis - Default 100. Max 10,000.

  • Amazon DynamoDB Streams - Default 100. Max 1,000.

  • Amazon Simple Queue Service - Default 10. Max 10.

" + }, + "MaximumBatchingWindowInSeconds":{"shape":"MaximumBatchingWindowInSeconds"} + } + }, + "UpdateFunctionCodeRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "ZipFile":{ + "shape":"Blob", + "documentation":"

The base64-encoded contents of the deployment package. AWS SDK and AWS CLI clients handle the encoding for you.

" + }, + "S3Bucket":{ + "shape":"S3Bucket", + "documentation":"

An Amazon S3 bucket in the same AWS Region as your function. The bucket can be in a different AWS account.

" + }, + "S3Key":{ + "shape":"S3Key", + "documentation":"

The Amazon S3 key of the deployment package.

" + }, + "S3ObjectVersion":{ + "shape":"S3ObjectVersion", + "documentation":"

For versioned objects, the version of the deployment package object to use.

" + }, + "Publish":{ + "shape":"Boolean", + "documentation":"

Set to true to publish a new version of the function after updating the code. This has the same effect as calling PublishVersion separately.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Set to true to validate the request parameters and access permissions without modifying the function code.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" + } + } + }, + "UpdateFunctionConfigurationRequest":{ + "type":"structure", + "required":["FunctionName"], + "members":{ + "FunctionName":{ + "shape":"FunctionName", + "documentation":"

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

", + "location":"uri", + "locationName":"FunctionName" + }, + "Role":{ + "shape":"RoleArn", + "documentation":"

The Amazon Resource Name (ARN) of the function's execution role.

" + }, + "Handler":{ + "shape":"Handler", + "documentation":"

The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description of the function.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.

" + }, + "MemorySize":{ + "shape":"MemorySize", + "documentation":"

The amount of memory that your function has access to. Increasing the function's memory also increases its CPU allocation. The default value is 128 MB. The value must be a multiple of 64 MB.

" + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.

" + }, + "Environment":{ + "shape":"Environment", + "documentation":"

Environment variables that are accessible from function code during execution.

" + }, + "Runtime":{ + "shape":"Runtime", + "documentation":"

The identifier of the function's runtime.

" + }, + "DeadLetterConfig":{ + "shape":"DeadLetterConfig", + "documentation":"

A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.

" + }, + "KMSKeyArn":{ + "shape":"KMSKeyArn", + "documentation":"

The ARN of the AWS Key Management Service (AWS KMS) key that's used to encrypt your function's environment variables. If it's not provided, AWS Lambda uses a default service key.

" + }, + "TracingConfig":{ + "shape":"TracingConfig", + "documentation":"

Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.

" + }, + "RevisionId":{ + "shape":"String", + "documentation":"

Only update the function if the revision ID matches the ID that's specified. Use this option to avoid modifying a function that has changed since you last read it.

" + }, + "Layers":{ + "shape":"LayerList", + "documentation":"

A list of function layers to add to the function's execution environment. Specify each layer by its ARN, including the version.

" + } + } + }, + "Version":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"(\\$LATEST|[0-9]+)" + }, + "VpcConfig":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of VPC subnet IDs.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of VPC security groups IDs.

" + } + }, + "documentation":"

The VPC security groups and subnets that are attached to a Lambda function.

" + }, + "VpcConfigResponse":{ + "type":"structure", + "members":{ + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

A list of VPC subnet IDs.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

A list of VPC security groups IDs.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the VPC.

" + } + }, + "documentation":"

The VPC security groups and subnets that are attached to a Lambda function.

" + }, + "VpcId":{"type":"string"}, + "Weight":{ + "type":"double", + "max":1.0, + "min":0.0 + } + }, + "documentation":"AWS Lambda

Overview

This is the AWS Lambda API Reference. The AWS Lambda Developer Guide provides additional information. For the service overview, see What is AWS Lambda, and for information about how the service works, see AWS Lambda: How it Works in the AWS Lambda Developer Guide.

" +} diff --git a/aws/dist/botocore/data/lambda/2015-03-31/waiters-2.json b/aws/dist/botocore/data/lambda/2015-03-31/waiters-2.json new file mode 100644 index 00000000..07d1ab25 --- /dev/null +++ b/aws/dist/botocore/data/lambda/2015-03-31/waiters-2.json @@ -0,0 +1,22 @@ +{ + "version": 2, + "waiters": { + "FunctionExists": { + "delay": 1, + "operation": "GetFunction", + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "status", + "expected": 200 + }, + { + "state": "retry", + "matcher": "error", + "expected": "ResourceNotFoundException" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/lex-models/2017-04-19/paginators-1.json b/aws/dist/botocore/data/lex-models/2017-04-19/paginators-1.json new file mode 100644 index 00000000..02d23082 --- /dev/null +++ b/aws/dist/botocore/data/lex-models/2017-04-19/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "GetSlotTypeVersions": { + "result_key": "slotTypes", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetSlotTypes": { + "result_key": "slotTypes", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetIntents": { + "result_key": "intents", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBotChannelAssociations": { + "result_key": "botChannelAssociations", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBots": { + "result_key": "bots", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBuiltinSlotTypes": { + "result_key": "slotTypes", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetIntentVersions": { + "result_key": "intents", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBotAliases": { + "result_key": "BotAliases", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBuiltinIntents": { + "result_key": "intents", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "GetBotVersions": { + "result_key": "bots", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/aws/dist/botocore/data/lex-models/2017-04-19/service-2.json b/aws/dist/botocore/data/lex-models/2017-04-19/service-2.json new file mode 100644 index 00000000..63d4a087 --- /dev/null +++ b/aws/dist/botocore/data/lex-models/2017-04-19/service-2.json @@ -0,0 +1,3271 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-04-19", + "endpointPrefix":"models.lex", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Lex Model Building Service", + "serviceId":"Lex Model Building Service", + "signatureVersion":"v4", + "signingName":"lex", + "uid":"lex-models-2017-04-19" + }, + "operations":{ + "CreateBotVersion":{ + "name":"CreateBotVersion", + "http":{ + "method":"POST", + "requestUri":"/bots/{name}/versions", + "responseCode":201 + }, + "input":{"shape":"CreateBotVersionRequest"}, + "output":{"shape":"CreateBotVersionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates a new version of the bot based on the $LATEST version. If the $LATEST version of this resource hasn't changed since you created the last version, Amazon Lex doesn't create a new version. It returns the last created version.

You can update only the $LATEST version of the bot. You can't update the numbered versions that you create with the CreateBotVersion operation.

When you create the first version of a bot, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permission for the lex:CreateBotVersion action.

" + }, + "CreateIntentVersion":{ + "name":"CreateIntentVersion", + "http":{ + "method":"POST", + "requestUri":"/intents/{name}/versions", + "responseCode":201 + }, + "input":{"shape":"CreateIntentVersionRequest"}, + "output":{"shape":"CreateIntentVersionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates a new version of an intent based on the $LATEST version of the intent. If the $LATEST version of this intent hasn't changed since you last updated it, Amazon Lex doesn't create a new version. It returns the last version you created.

You can update only the $LATEST version of the intent. You can't update the numbered versions that you create with the CreateIntentVersion operation.

When you create a version of an intent, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions to perform the lex:CreateIntentVersion action.

" + }, + "CreateSlotTypeVersion":{ + "name":"CreateSlotTypeVersion", + "http":{ + "method":"POST", + "requestUri":"/slottypes/{name}/versions", + "responseCode":201 + }, + "input":{"shape":"CreateSlotTypeVersionRequest"}, + "output":{"shape":"CreateSlotTypeVersionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates a new version of a slot type based on the $LATEST version of the specified slot type. If the $LATEST version of this resource has not changed since the last version that you created, Amazon Lex doesn't create a new version. It returns the last version that you created.

You can update only the $LATEST version of a slot type. You can't update the numbered versions that you create with the CreateSlotTypeVersion operation.

When you create a version of a slot type, Amazon Lex sets the version to 1. Subsequent versions increment by 1. For more information, see versioning-intro.

This operation requires permissions for the lex:CreateSlotTypeVersion action.

" + }, + "DeleteBot":{ + "name":"DeleteBot", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{name}", + "responseCode":204 + }, + "input":{"shape":"DeleteBotRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes all versions of the bot, including the $LATEST version. To delete a specific version of the bot, use the DeleteBotVersion operation.

If a bot has an alias, you can't delete it. Instead, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the alias that refers to the bot. To remove the reference to the bot, delete the alias. If you get the same exception again, delete the referring alias until the DeleteBot operation is successful.

This operation requires permissions for the lex:DeleteBot action.

" + }, + "DeleteBotAlias":{ + "name":"DeleteBotAlias", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botName}/aliases/{name}", + "responseCode":204 + }, + "input":{"shape":"DeleteBotAliasRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes an alias for the specified bot.

You can't delete an alias that is used in the association between a bot and a messaging channel. If an alias is used in a channel association, the DeleteBot operation returns a ResourceInUseException exception that includes a reference to the channel association that refers to the bot. You can remove the reference to the alias by deleting the channel association. If you get the same exception again, delete the referring association until the DeleteBotAlias operation is successful.

" + }, + "DeleteBotChannelAssociation":{ + "name":"DeleteBotChannelAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botName}/aliases/{aliasName}/channels/{name}", + "responseCode":204 + }, + "input":{"shape":"DeleteBotChannelAssociationRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Deletes the association between an Amazon Lex bot and a messaging platform.

This operation requires permission for the lex:DeleteBotChannelAssociation action.

" + }, + "DeleteBotVersion":{ + "name":"DeleteBotVersion", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{name}/versions/{version}", + "responseCode":204 + }, + "input":{"shape":"DeleteBotVersionRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a specific version of a bot. To delete all versions of a bot, use the DeleteBot operation.

This operation requires permissions for the lex:DeleteBotVersion action.

" + }, + "DeleteIntent":{ + "name":"DeleteIntent", + "http":{ + "method":"DELETE", + "requestUri":"/intents/{name}", + "responseCode":204 + }, + "input":{"shape":"DeleteIntentRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes all versions of the intent, including the $LATEST version. To delete a specific version of the intent, use the DeleteIntentVersion operation.

You can delete a version of an intent only if it is not referenced. To delete an intent that is referred to in one or more bots (see how-it-works), you must remove those references first.

If you get the ResourceInUseException exception, it provides an example reference that shows where the intent is referenced. To remove the reference to the intent, either update the bot or delete it. If you get the same exception when you attempt to delete the intent again, repeat until the intent has no references and the call to DeleteIntent is successful.

This operation requires permission for the lex:DeleteIntent action.

" + }, + "DeleteIntentVersion":{ + "name":"DeleteIntentVersion", + "http":{ + "method":"DELETE", + "requestUri":"/intents/{name}/versions/{version}", + "responseCode":204 + }, + "input":{"shape":"DeleteIntentVersionRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a specific version of an intent. To delete all versions of a intent, use the DeleteIntent operation.

This operation requires permissions for the lex:DeleteIntentVersion action.

" + }, + "DeleteSlotType":{ + "name":"DeleteSlotType", + "http":{ + "method":"DELETE", + "requestUri":"/slottypes/{name}", + "responseCode":204 + }, + "input":{"shape":"DeleteSlotTypeRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes all versions of the slot type, including the $LATEST version. To delete a specific version of the slot type, use the DeleteSlotTypeVersion operation.

You can delete a version of a slot type only if it is not referenced. To delete a slot type that is referred to in one or more intents, you must remove those references first.

If you get the ResourceInUseException exception, the exception provides an example reference that shows the intent where the slot type is referenced. To remove the reference to the slot type, either update the intent or delete it. If you get the same exception when you attempt to delete the slot type again, repeat until the slot type has no references and the DeleteSlotType call is successful.

This operation requires permission for the lex:DeleteSlotType action.

" + }, + "DeleteSlotTypeVersion":{ + "name":"DeleteSlotTypeVersion", + "http":{ + "method":"DELETE", + "requestUri":"/slottypes/{name}/version/{version}", + "responseCode":204 + }, + "input":{"shape":"DeleteSlotTypeVersionRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a specific version of a slot type. To delete all versions of a slot type, use the DeleteSlotType operation.

This operation requires permissions for the lex:DeleteSlotTypeVersion action.

" + }, + "DeleteUtterances":{ + "name":"DeleteUtterances", + "http":{ + "method":"DELETE", + "requestUri":"/bots/{botName}/utterances/{userId}", + "responseCode":204 + }, + "input":{"shape":"DeleteUtterancesRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the GetUtterancesView operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.

Use the DeleteStoredUtterances operation to manually delete stored utterances for a specific user.

This operation requires permissions for the lex:DeleteUtterances action.

" + }, + "GetBot":{ + "name":"GetBot", + "http":{ + "method":"GET", + "requestUri":"/bots/{name}/versions/{versionoralias}", + "responseCode":200 + }, + "input":{"shape":"GetBotRequest"}, + "output":{"shape":"GetBotResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns metadata information for a specific bot. You must provide the bot name and the bot version or alias.

This operation requires permissions for the lex:GetBot action.

" + }, + "GetBotAlias":{ + "name":"GetBotAlias", + "http":{ + "method":"GET", + "requestUri":"/bots/{botName}/aliases/{name}", + "responseCode":200 + }, + "input":{"shape":"GetBotAliasRequest"}, + "output":{"shape":"GetBotAliasResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns information about an Amazon Lex bot alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:GetBotAlias action.

" + }, + "GetBotAliases":{ + "name":"GetBotAliases", + "http":{ + "method":"GET", + "requestUri":"/bots/{botName}/aliases/", + "responseCode":200 + }, + "input":{"shape":"GetBotAliasesRequest"}, + "output":{"shape":"GetBotAliasesResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns a list of aliases for a specified Amazon Lex bot.

This operation requires permissions for the lex:GetBotAliases action.

" + }, + "GetBotChannelAssociation":{ + "name":"GetBotChannelAssociation", + "http":{ + "method":"GET", + "requestUri":"/bots/{botName}/aliases/{aliasName}/channels/{name}", + "responseCode":200 + }, + "input":{"shape":"GetBotChannelAssociationRequest"}, + "output":{"shape":"GetBotChannelAssociationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns information about the association between an Amazon Lex bot and a messaging platform.

This operation requires permissions for the lex:GetBotChannelAssociation action.

" + }, + "GetBotChannelAssociations":{ + "name":"GetBotChannelAssociations", + "http":{ + "method":"GET", + "requestUri":"/bots/{botName}/aliases/{aliasName}/channels/", + "responseCode":200 + }, + "input":{"shape":"GetBotChannelAssociationsRequest"}, + "output":{"shape":"GetBotChannelAssociationsResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns a list of all of the channels associated with the specified bot.

The GetBotChannelAssociations operation requires permissions for the lex:GetBotChannelAssociations action.

" + }, + "GetBotVersions":{ + "name":"GetBotVersions", + "http":{ + "method":"GET", + "requestUri":"/bots/{name}/versions/", + "responseCode":200 + }, + "input":{"shape":"GetBotVersionsRequest"}, + "output":{"shape":"GetBotVersionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets information about all of the versions of a bot.

The GetBotVersions operation returns a BotMetadata object for each version of a bot. For example, if a bot has three numbered versions, the GetBotVersions operation returns four BotMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetBotVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetBotVersions action.

" + }, + "GetBots":{ + "name":"GetBots", + "http":{ + "method":"GET", + "requestUri":"/bots/", + "responseCode":200 + }, + "input":{"shape":"GetBotsRequest"}, + "output":{"shape":"GetBotsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns bot information as follows:

  • If you provide the nameContains field, the response includes information for the $LATEST version of all bots whose name contains the specified string.

  • If you don't specify the nameContains field, the operation returns information about the $LATEST version of all of your bots.

This operation requires permission for the lex:GetBots action.

" + }, + "GetBuiltinIntent":{ + "name":"GetBuiltinIntent", + "http":{ + "method":"GET", + "requestUri":"/builtins/intents/{signature}", + "responseCode":200 + }, + "input":{"shape":"GetBuiltinIntentRequest"}, + "output":{"shape":"GetBuiltinIntentResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns information about a built-in intent.

This operation requires permission for the lex:GetBuiltinIntent action.

" + }, + "GetBuiltinIntents":{ + "name":"GetBuiltinIntents", + "http":{ + "method":"GET", + "requestUri":"/builtins/intents/", + "responseCode":200 + }, + "input":{"shape":"GetBuiltinIntentsRequest"}, + "output":{"shape":"GetBuiltinIntentsResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets a list of built-in intents that meet the specified criteria.

This operation requires permission for the lex:GetBuiltinIntents action.

" + }, + "GetBuiltinSlotTypes":{ + "name":"GetBuiltinSlotTypes", + "http":{ + "method":"GET", + "requestUri":"/builtins/slottypes/", + "responseCode":200 + }, + "input":{"shape":"GetBuiltinSlotTypesRequest"}, + "output":{"shape":"GetBuiltinSlotTypesResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets a list of built-in slot types that meet the specified criteria.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

This operation requires permission for the lex:GetBuiltInSlotTypes action.

" + }, + "GetExport":{ + "name":"GetExport", + "http":{ + "method":"GET", + "requestUri":"/exports/", + "responseCode":200 + }, + "input":{"shape":"GetExportRequest"}, + "output":{"shape":"GetExportResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Exports the contents of a Amazon Lex resource in a specified format.

" + }, + "GetImport":{ + "name":"GetImport", + "http":{ + "method":"GET", + "requestUri":"/imports/{importId}", + "responseCode":200 + }, + "input":{"shape":"GetImportRequest"}, + "output":{"shape":"GetImportResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets information about an import job started with the StartImport operation.

" + }, + "GetIntent":{ + "name":"GetIntent", + "http":{ + "method":"GET", + "requestUri":"/intents/{name}/versions/{version}", + "responseCode":200 + }, + "input":{"shape":"GetIntentRequest"}, + "output":{"shape":"GetIntentResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

" + }, + "GetIntentVersions":{ + "name":"GetIntentVersions", + "http":{ + "method":"GET", + "requestUri":"/intents/{name}/versions/", + "responseCode":200 + }, + "input":{"shape":"GetIntentVersionsRequest"}, + "output":{"shape":"GetIntentVersionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets information about all of the versions of an intent.

The GetIntentVersions operation returns an IntentMetadata object for each version of an intent. For example, if an intent has three numbered versions, the GetIntentVersions operation returns four IntentMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetIntentVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetIntentVersions action.

" + }, + "GetIntents":{ + "name":"GetIntents", + "http":{ + "method":"GET", + "requestUri":"/intents/", + "responseCode":200 + }, + "input":{"shape":"GetIntentsRequest"}, + "output":{"shape":"GetIntentsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns intent information as follows:

  • If you specify the nameContains field, returns the $LATEST version of all intents that contain the specified string.

  • If you don't specify the nameContains field, returns information about the $LATEST version of all intents.

The operation requires permission for the lex:GetIntents action.

" + }, + "GetSlotType":{ + "name":"GetSlotType", + "http":{ + "method":"GET", + "requestUri":"/slottypes/{name}/versions/{version}", + "responseCode":200 + }, + "input":{"shape":"GetSlotTypeRequest"}, + "output":{"shape":"GetSlotTypeResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns information about a specific version of a slot type. In addition to specifying the slot type name, you must specify the slot type version.

This operation requires permissions for the lex:GetSlotType action.

" + }, + "GetSlotTypeVersions":{ + "name":"GetSlotTypeVersions", + "http":{ + "method":"GET", + "requestUri":"/slottypes/{name}/versions/", + "responseCode":200 + }, + "input":{"shape":"GetSlotTypeVersionsRequest"}, + "output":{"shape":"GetSlotTypeVersionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Gets information about all versions of a slot type.

The GetSlotTypeVersions operation returns a SlotTypeMetadata object for each version of a slot type. For example, if a slot type has three numbered versions, the GetSlotTypeVersions operation returns four SlotTypeMetadata objects in the response, one for each numbered version and one for the $LATEST version.

The GetSlotTypeVersions operation always returns at least one version, the $LATEST version.

This operation requires permissions for the lex:GetSlotTypeVersions action.

" + }, + "GetSlotTypes":{ + "name":"GetSlotTypes", + "http":{ + "method":"GET", + "requestUri":"/slottypes/", + "responseCode":200 + }, + "input":{"shape":"GetSlotTypesRequest"}, + "output":{"shape":"GetSlotTypesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns slot type information as follows:

  • If you specify the nameContains field, returns the $LATEST version of all slot types that contain the specified string.

  • If you don't specify the nameContains field, returns information about the $LATEST version of all slot types.

The operation requires permission for the lex:GetSlotTypes action.

" + }, + "GetUtterancesView":{ + "name":"GetUtterancesView", + "http":{ + "method":"GET", + "requestUri":"/bots/{botname}/utterances?view=aggregation", + "responseCode":200 + }, + "input":{"shape":"GetUtterancesViewRequest"}, + "output":{"shape":"GetUtterancesViewResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Use the GetUtterancesView operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.

For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the GetUtterancesView operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the OrderFlowers intent so that your bot recognizes that utterance.

After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions.

Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.

This operation requires permissions for the lex:GetUtterancesView action.

" + }, + "PutBot":{ + "name":"PutBot", + "http":{ + "method":"PUT", + "requestUri":"/bots/{name}/versions/$LATEST", + "responseCode":200 + }, + "input":{"shape":"PutBotRequest"}, + "output":{"shape":"PutBotResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the response FAILED. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see how-it-works.

If you specify the name of an existing bot, the fields in the request replace the existing values in the $LATEST version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the idleTTLInSeconds and privacySettings fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.

This operation requires permissions for the lex:PutBot action. For more information, see auth-and-access-control.

" + }, + "PutBotAlias":{ + "name":"PutBotAlias", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botName}/aliases/{name}", + "responseCode":200 + }, + "input":{"shape":"PutBotAliasRequest"}, + "output":{"shape":"PutBotAliasResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates an alias for the specified version of the bot or replaces an alias for the specified bot. To change the version of the bot that the alias points to, replace the alias. For more information about aliases, see versioning-aliases.

This operation requires permissions for the lex:PutBotAlias action.

" + }, + "PutIntent":{ + "name":"PutIntent", + "http":{ + "method":"PUT", + "requestUri":"/intents/{name}/versions/$LATEST", + "responseCode":200 + }, + "input":{"shape":"PutIntentRequest"}, + "output":{"shape":"PutIntentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates an intent or replaces an existing intent.

To define the interaction between the user and your bot, you use one or more intents. For a pizza ordering bot, for example, you would create an OrderPizza intent.

To create an intent or replace an existing intent, you must provide the following:

  • Intent name. For example, OrderPizza.

  • Sample utterances. For example, \"Can I order a pizza, please.\" and \"I want to order a pizza.\"

  • Information to be gathered. You specify slot types for the information that your bot will request from the user. You can specify standard slot types, such as a date or a time, or custom slot types such as the size and crust of a pizza.

  • How the intent will be fulfilled. You can provide a Lambda function or configure the intent to return the intent information to the client application. If you use a Lambda function, when all of the intent information is available, Amazon Lex invokes your Lambda function. If you configure your intent to return the intent information to the client application.

You can specify other optional information in the request, such as:

  • A confirmation prompt to ask the user to confirm an intent. For example, \"Shall I order your pizza?\"

  • A conclusion statement to send to the user after the intent has been fulfilled. For example, \"I placed your pizza order.\"

  • A follow-up prompt that asks the user for additional activity. For example, asking \"Do you want to order a drink with your pizza?\"

If you specify an existing intent name to update the intent, Amazon Lex replaces the values in the $LATEST version of the intent with the values in the request. Amazon Lex removes fields that you don't provide in the request. If you don't specify the required fields, Amazon Lex throws an exception. When you update the $LATEST version of an intent, the status field of any bot that uses the $LATEST version of the intent is set to NOT_BUILT.

For more information, see how-it-works.

This operation requires permissions for the lex:PutIntent action.

" + }, + "PutSlotType":{ + "name":"PutSlotType", + "http":{ + "method":"PUT", + "requestUri":"/slottypes/{name}/versions/$LATEST", + "responseCode":200 + }, + "input":{"shape":"PutSlotTypeRequest"}, + "output":{"shape":"PutSlotTypeResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"}, + {"shape":"PreconditionFailedException"} + ], + "documentation":"

Creates a custom slot type or replaces an existing custom slot type.

To create a custom slot type, specify a name for the slot type and a set of enumeration values, which are the values that a slot of this type can assume. For more information, see how-it-works.

If you specify the name of an existing slot type, the fields in the request replace the existing values in the $LATEST version of the slot type. Amazon Lex removes the fields that you don't provide in the request. If you don't specify required fields, Amazon Lex throws an exception. When you update the $LATEST version of a slot type, if a bot uses the $LATEST version of an intent that contains the slot type, the bot's status field is set to NOT_BUILT.

This operation requires permissions for the lex:PutSlotType action.

" + }, + "StartImport":{ + "name":"StartImport", + "http":{ + "method":"POST", + "requestUri":"/imports/", + "responseCode":201 + }, + "input":{"shape":"StartImportRequest"}, + "output":{"shape":"StartImportResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Starts a job to import a resource to Amazon Lex.

" + } + }, + "shapes":{ + "AliasName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([A-Za-z]_?)+$" + }, + "AliasNameOrListAll":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^(-|^([A-Za-z]_?)+$)$" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Blob":{"type":"blob"}, + "Boolean":{"type":"boolean"}, + "BotAliasMetadata":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the bot alias.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot alias.

" + }, + "botVersion":{ + "shape":"Version", + "documentation":"

The version of the Amazon Lex bot to which the alias points.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot to which the alias points.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was updated. When you create a resource, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was created.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the bot alias.

" + } + }, + "documentation":"

Provides information about a bot alias.

" + }, + "BotAliasMetadataList":{ + "type":"list", + "member":{"shape":"BotAliasMetadata"} + }, + "BotChannelAssociation":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotChannelName", + "documentation":"

The name of the association between the bot and the channel.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A text description of the association you are creating.

" + }, + "botAlias":{ + "shape":"AliasName", + "documentation":"

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot to which this association is being made.

Currently, Amazon Lex supports associations with Facebook and Slack, and Twilio.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the association between the Amazon Lex bot and the channel was created.

" + }, + "type":{ + "shape":"ChannelType", + "documentation":"

Specifies the type of association by indicating the type of channel being established between the Amazon Lex bot and the external messaging platform.

" + }, + "botConfiguration":{ + "shape":"ChannelConfigurationMap", + "documentation":"

Provides information necessary to communicate with the messaging platform.

" + }, + "status":{ + "shape":"ChannelStatus", + "documentation":"

The status of the bot channel.

  • CREATED - The channel has been created and is ready for use.

  • IN_PROGRESS - Channel creation is in progress.

  • FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex provides the reason that it failed to create the association.

" + } + }, + "documentation":"

Represents an association between an Amazon Lex bot and an external messaging platform.

" + }, + "BotChannelAssociationList":{ + "type":"list", + "member":{"shape":"BotChannelAssociation"} + }, + "BotChannelName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([A-Za-z]_?)+$" + }, + "BotMetadata":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the bot.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was updated. When you create a bot, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the bot. For a new bot, the version is always $LATEST.

" + } + }, + "documentation":"

Provides information about a bot. .

" + }, + "BotMetadataList":{ + "type":"list", + "member":{"shape":"BotMetadata"} + }, + "BotName":{ + "type":"string", + "max":50, + "min":2, + "pattern":"^([A-Za-z]_?)+$" + }, + "BotVersions":{ + "type":"list", + "member":{"shape":"Version"}, + "max":5, + "min":1 + }, + "BuiltinIntentMetadata":{ + "type":"structure", + "members":{ + "signature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

A unique identifier for the built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

" + }, + "supportedLocales":{ + "shape":"LocaleList", + "documentation":"

A list of identifiers for the locales that the intent supports.

" + } + }, + "documentation":"

Provides metadata for a built-in intent.

" + }, + "BuiltinIntentMetadataList":{ + "type":"list", + "member":{"shape":"BuiltinIntentMetadata"} + }, + "BuiltinIntentSignature":{"type":"string"}, + "BuiltinIntentSlot":{ + "type":"structure", + "members":{ + "name":{ + "shape":"String", + "documentation":"

A list of the slots defined for the intent.

" + } + }, + "documentation":"

Provides information about a slot used in a built-in intent.

" + }, + "BuiltinIntentSlotList":{ + "type":"list", + "member":{"shape":"BuiltinIntentSlot"} + }, + "BuiltinSlotTypeMetadata":{ + "type":"structure", + "members":{ + "signature":{ + "shape":"BuiltinSlotTypeSignature", + "documentation":"

A unique identifier for the built-in slot type. To find the signature for a slot type, see Slot Type Reference in the Alexa Skills Kit.

" + }, + "supportedLocales":{ + "shape":"LocaleList", + "documentation":"

A list of target locales for the slot.

" + } + }, + "documentation":"

Provides information about a built in slot type.

" + }, + "BuiltinSlotTypeMetadataList":{ + "type":"list", + "member":{"shape":"BuiltinSlotTypeMetadata"} + }, + "BuiltinSlotTypeSignature":{"type":"string"}, + "ChannelConfigurationMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "max":10, + "min":1, + "sensitive":true + }, + "ChannelStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "CREATED", + "FAILED" + ] + }, + "ChannelType":{ + "type":"string", + "enum":[ + "Facebook", + "Slack", + "Twilio-Sms", + "Kik" + ] + }, + "CodeHook":{ + "type":"structure", + "required":[ + "uri", + "messageVersion" + ], + "members":{ + "uri":{ + "shape":"LambdaARN", + "documentation":"

The Amazon Resource Name (ARN) of the Lambda function.

" + }, + "messageVersion":{ + "shape":"MessageVersion", + "documentation":"

The version of the request-response that you want Amazon Lex to use to invoke your Lambda function. For more information, see using-lambda.

" + } + }, + "documentation":"

Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..

" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

There was a conflict processing the request. Try your request again.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ContentString":{ + "type":"string", + "max":1000, + "min":1 + }, + "ContentType":{ + "type":"string", + "enum":[ + "PlainText", + "SSML", + "CustomPayload" + ] + }, + "Count":{"type":"integer"}, + "CreateBotVersionRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot that you want to create a new version of. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "checksum":{ + "shape":"String", + "documentation":"

Identifies a specific revision of the $LATEST version of the bot. If you specify a checksum and the $LATEST version of the bot has a different checksum, a PreconditionFailedException exception is returned and Amazon Lex doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

" + } + } + }, + "CreateBotVersionResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot.

" + }, + "intents":{ + "shape":"IntentList", + "documentation":"

An array of Intent objects. For more information, see PutBot.

" + }, + "clarificationPrompt":{ + "shape":"Prompt", + "documentation":"

The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

" + }, + "abortStatement":{ + "shape":"Statement", + "documentation":"

The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

" + }, + "status":{ + "shape":"Status", + "documentation":"

When you send a request to create or update a bot, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date when the $LATEST version of this bot was updated.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date when the bot version was created.

" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

" + }, + "voiceId":{ + "shape":"String", + "documentation":"

The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum identifying the version of the bot that was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the bot.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

Specifies the target locale for the bot.

" + }, + "childDirected":{ + "shape":"Boolean", + "documentation":"

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

" + } + } + }, + "CreateIntentVersionRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent that you want to create a new version of. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the $LATEST version of the intent that should be used to create the new version. If you specify a checksum and the $LATEST version of the intent has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish a new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

" + } + } + }, + "CreateIntentVersionResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the intent.

" + }, + "slots":{ + "shape":"SlotList", + "documentation":"

An array of slot types that defines the information required to fulfill the intent.

" + }, + "sampleUtterances":{ + "shape":"IntentUtteranceList", + "documentation":"

An array of sample utterances configured for the intent.

" + }, + "confirmationPrompt":{ + "shape":"Prompt", + "documentation":"

If defined, the prompt that Amazon Lex uses to confirm the user's intent before fulfilling it.

" + }, + "rejectionStatement":{ + "shape":"Statement", + "documentation":"

If the user answers \"no\" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + }, + "followUpPrompt":{ + "shape":"FollowUpPrompt", + "documentation":"

If defined, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

" + }, + "conclusionStatement":{ + "shape":"Statement", + "documentation":"

After the Lambda function specified in the fulfillmentActivity field fulfills the intent, Amazon Lex conveys this statement to the user.

" + }, + "dialogCodeHook":{ + "shape":"CodeHook", + "documentation":"

If defined, Amazon Lex invokes this Lambda function for each user input.

" + }, + "fulfillmentActivity":{ + "shape":"FulfillmentActivity", + "documentation":"

Describes how the intent is fulfilled.

" + }, + "parentIntentSignature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

A unique identifier for a built-in intent.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was updated.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version number assigned to the new version of the intent.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the intent version created.

" + } + } + }, + "CreateSlotTypeVersionRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type that you want to create a new version for. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum for the $LATEST version of the slot type that you want to publish. If you specify a checksum and the $LATEST version of the slot type has a different checksum, Amazon Lex returns a PreconditionFailedException exception and doesn't publish the new version. If you don't specify a checksum, Amazon Lex publishes the $LATEST version.

" + } + } + }, + "CreateSlotTypeVersionResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot type.

" + }, + "enumerationValues":{ + "shape":"EnumerationValues", + "documentation":"

A list of EnumerationValue objects that defines the values that the slot type can take.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version assigned to the new slot type version.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the $LATEST version of the slot type.

" + }, + "valueSelectionStrategy":{ + "shape":"SlotValueSelectionStrategy", + "documentation":"

The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.

" + } + } + }, + "CustomOrBuiltinSlotTypeName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^((AMAZON\\.)_?|[A-Za-z]_?)+" + }, + "DeleteBotAliasRequest":{ + "type":"structure", + "required":[ + "name", + "botName" + ], + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the alias to delete. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that the alias points to.

", + "location":"uri", + "locationName":"botName" + } + } + }, + "DeleteBotChannelAssociationRequest":{ + "type":"structure", + "required":[ + "name", + "botName", + "botAlias" + ], + "members":{ + "name":{ + "shape":"BotChannelName", + "documentation":"

The name of the association. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"AliasName", + "documentation":"

An alias that points to the specific version of the Amazon Lex bot to which this association is being made.

", + "location":"uri", + "locationName":"aliasName" + } + } + }, + "DeleteBotRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteBotVersionRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"

The version of the bot to delete. You cannot delete the $LATEST version of the bot. To delete the $LATEST version, use the DeleteBot operation.

", + "location":"uri", + "locationName":"version" + } + } + }, + "DeleteIntentRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteIntentVersionRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"

The version of the intent to delete. You cannot delete the $LATEST version of the intent. To delete the $LATEST version, use the DeleteIntent operation.

", + "location":"uri", + "locationName":"version" + } + } + }, + "DeleteSlotTypeRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteSlotTypeVersionRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"

The version of the slot type to delete. You cannot delete the $LATEST version of the slot type. To delete the $LATEST version, use the DeleteSlotType operation.

", + "location":"uri", + "locationName":"version" + } + } + }, + "DeleteUtterancesRequest":{ + "type":"structure", + "required":[ + "botName", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that stored the utterances.

", + "location":"uri", + "locationName":"botName" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The unique identifier for the user that made the utterances. This is the user ID that was sent in the PostContent or PostText operation request that contained the utterance.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "Description":{ + "type":"string", + "max":200, + "min":0 + }, + "EnumerationValue":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"Value", + "documentation":"

The value of the slot type.

" + }, + "synonyms":{ + "shape":"SynonymList", + "documentation":"

Additional values related to the slot type value.

" + } + }, + "documentation":"

Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.

For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values

  • thick

  • thin

  • stuffed

" + }, + "EnumerationValues":{ + "type":"list", + "member":{"shape":"EnumerationValue"}, + "max":10000, + "min":1 + }, + "ExportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "READY", + "FAILED" + ] + }, + "ExportType":{ + "type":"string", + "enum":[ + "ALEXA_SKILLS_KIT", + "LEX" + ] + }, + "FollowUpPrompt":{ + "type":"structure", + "required":[ + "prompt", + "rejectionStatement" + ], + "members":{ + "prompt":{ + "shape":"Prompt", + "documentation":"

Prompts for information from the user.

" + }, + "rejectionStatement":{ + "shape":"Statement", + "documentation":"

If the user answers \"no\" to the question defined in the prompt field, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + } + }, + "documentation":"

A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.

" + }, + "FulfillmentActivity":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"FulfillmentActivityType", + "documentation":"

How the intent should be fulfilled, either by running a Lambda function or by returning the slot data to the client application.

" + }, + "codeHook":{ + "shape":"CodeHook", + "documentation":"

A description of the Lambda function that is run to fulfill the intent.

" + } + }, + "documentation":"

Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.

Consider the following examples:

  • In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.

  • In a gaming application, when a user says \"pick up a rock,\" this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.

" + }, + "FulfillmentActivityType":{ + "type":"string", + "enum":[ + "ReturnIntent", + "CodeHook" + ] + }, + "GetBotAliasRequest":{ + "type":"structure", + "required":[ + "name", + "botName" + ], + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the bot alias. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot.

", + "location":"uri", + "locationName":"botName" + } + } + }, + "GetBotAliasResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the bot alias.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot alias.

" + }, + "botVersion":{ + "shape":"Version", + "documentation":"

The version of the bot that the alias points to.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that the alias points to.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was created.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the bot alias.

" + } + } + }, + "GetBotAliasesRequest":{ + "type":"structure", + "required":["botName"], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot.

", + "location":"uri", + "locationName":"botName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of aliases to return in the response. The default is 50. .

", + "location":"querystring", + "locationName":"maxResults" + }, + "nameContains":{ + "shape":"AliasName", + "documentation":"

Substring to match in bot alias names. An alias will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "location":"querystring", + "locationName":"nameContains" + } + } + }, + "GetBotAliasesResponse":{ + "type":"structure", + "members":{ + "BotAliases":{ + "shape":"BotAliasMetadataList", + "documentation":"

An array of BotAliasMetadata objects, each describing a bot alias.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching next page of aliases. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of aliases, specify the pagination token in the next request.

" + } + } + }, + "GetBotChannelAssociationRequest":{ + "type":"structure", + "required":[ + "name", + "botName", + "botAlias" + ], + "members":{ + "name":{ + "shape":"BotChannelName", + "documentation":"

The name of the association between the bot and the channel. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"AliasName", + "documentation":"

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

", + "location":"uri", + "locationName":"aliasName" + } + } + }, + "GetBotChannelAssociationResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotChannelName", + "documentation":"

The name of the association between the bot and the channel.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the association between the bot and the channel.

" + }, + "botAlias":{ + "shape":"AliasName", + "documentation":"

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the association between the bot and the channel was created.

" + }, + "type":{ + "shape":"ChannelType", + "documentation":"

The type of the messaging platform.

" + }, + "botConfiguration":{ + "shape":"ChannelConfigurationMap", + "documentation":"

Provides information that the messaging platform needs to communicate with the Amazon Lex bot.

" + }, + "status":{ + "shape":"ChannelStatus", + "documentation":"

The status of the bot channel.

  • CREATED - The channel has been created and is ready for use.

  • IN_PROGRESS - Channel creation is in progress.

  • FAILED - There was an error creating the channel. For information about the reason for the failure, see the failureReason field.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex provides the reason that it failed to create the association.

" + } + } + }, + "GetBotChannelAssociationsRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot in the association.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"AliasNameOrListAll", + "documentation":"

An alias pointing to the specific version of the Amazon Lex bot to which this association is being made.

", + "location":"uri", + "locationName":"aliasName" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of associations to return in the response. The default is 50.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nameContains":{ + "shape":"BotChannelName", + "documentation":"

Substring to match in channel association names. An association will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\" To return all bot channel associations, use a hyphen (\"-\") as the nameContains parameter.

", + "location":"querystring", + "locationName":"nameContains" + } + } + }, + "GetBotChannelAssociationsResponse":{ + "type":"structure", + "members":{ + "botChannelAssociations":{ + "shape":"BotChannelAssociationList", + "documentation":"

An array of objects, one for each association, that provides information about the Amazon Lex bot and its association with the channel.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of associations. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of associations, specify the pagination token in the next request.

" + } + } + }, + "GetBotRequest":{ + "type":"structure", + "required":[ + "name", + "versionOrAlias" + ], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "versionOrAlias":{ + "shape":"String", + "documentation":"

The version or alias of the bot.

", + "location":"uri", + "locationName":"versionoralias" + } + } + }, + "GetBotResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot.

" + }, + "intents":{ + "shape":"IntentList", + "documentation":"

An array of intent objects. For more information, see PutBot.

" + }, + "clarificationPrompt":{ + "shape":"Prompt", + "documentation":"

The message Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.

" + }, + "abortStatement":{ + "shape":"Statement", + "documentation":"

The message that Amazon Lex returns when the user elects to end the conversation without completing it. For more information, see PutBot.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the bot. If the bot is ready to run, the status is READY. If there was a problem with building the bot, the status is FAILED and the failureReason explains why the bot did not build. If the bot was saved but not built, the status is NOT BUILT.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex explains why it failed to build the bot.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was created.

" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

" + }, + "voiceId":{ + "shape":"String", + "documentation":"

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the bot used to identify a specific revision of the bot's $LATEST version.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the bot. For a new bot, the version is always $LATEST.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The target locale for the bot.

" + }, + "childDirected":{ + "shape":"Boolean", + "documentation":"

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

" + } + } + }, + "GetBotVersionsRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot for which versions should be returned.

", + "location":"uri", + "locationName":"name" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of bot versions to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "GetBotVersionsResponse":{ + "type":"structure", + "members":{ + "bots":{ + "shape":"BotMetadataList", + "documentation":"

An array of BotMetadata objects, one for each numbered version of the bot plus one for the $LATEST version.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of bot versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

" + } + } + }, + "GetBotsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of bots. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of bots, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of bots to return in the response that the request will return. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nameContains":{ + "shape":"BotName", + "documentation":"

Substring to match in bot names. A bot will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "location":"querystring", + "locationName":"nameContains" + } + } + }, + "GetBotsResponse":{ + "type":"structure", + "members":{ + "bots":{ + "shape":"BotMetadataList", + "documentation":"

An array of botMetadata objects, with one entry for each bot.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of bots.

" + } + } + }, + "GetBuiltinIntentRequest":{ + "type":"structure", + "required":["signature"], + "members":{ + "signature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

The unique identifier for a built-in intent. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

", + "location":"uri", + "locationName":"signature" + } + } + }, + "GetBuiltinIntentResponse":{ + "type":"structure", + "members":{ + "signature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

The unique identifier for a built-in intent.

" + }, + "supportedLocales":{ + "shape":"LocaleList", + "documentation":"

A list of locales that the intent supports.

" + }, + "slots":{ + "shape":"BuiltinIntentSlotList", + "documentation":"

An array of BuiltinIntentSlot objects, one entry for each slot type in the intent.

" + } + } + }, + "GetBuiltinIntentsRequest":{ + "type":"structure", + "members":{ + "locale":{ + "shape":"Locale", + "documentation":"

A list of locales that the intent supports.

", + "location":"querystring", + "locationName":"locale" + }, + "signatureContains":{ + "shape":"String", + "documentation":"

Substring to match in built-in intent signatures. An intent will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\" To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

", + "location":"querystring", + "locationName":"signatureContains" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of intents. If this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, use the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of intents to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "GetBuiltinIntentsResponse":{ + "type":"structure", + "members":{ + "intents":{ + "shape":"BuiltinIntentMetadataList", + "documentation":"

An array of builtinIntentMetadata objects, one for each intent in the response.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

" + } + } + }, + "GetBuiltinSlotTypesRequest":{ + "type":"structure", + "members":{ + "locale":{ + "shape":"Locale", + "documentation":"

A list of locales that the slot type supports.

", + "location":"querystring", + "locationName":"locale" + }, + "signatureContains":{ + "shape":"String", + "documentation":"

Substring to match in built-in slot type signatures. A slot type will be returned if any part of its signature matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "location":"querystring", + "locationName":"signatureContains" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of slot types, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of slot types to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "GetBuiltinSlotTypesResponse":{ + "type":"structure", + "members":{ + "slotTypes":{ + "shape":"BuiltinSlotTypeMetadataList", + "documentation":"

An array of BuiltInSlotTypeMetadata objects, one entry for each slot type returned.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, the response includes a pagination token that you can use in your next request to fetch the next page of slot types.

" + } + } + }, + "GetExportRequest":{ + "type":"structure", + "required":[ + "name", + "version", + "resourceType", + "exportType" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the bot to export.

", + "location":"querystring", + "locationName":"name" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"

The version of the bot to export.

", + "location":"querystring", + "locationName":"version" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource to export.

", + "location":"querystring", + "locationName":"resourceType" + }, + "exportType":{ + "shape":"ExportType", + "documentation":"

The format of the exported data.

", + "location":"querystring", + "locationName":"exportType" + } + } + }, + "GetExportResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the bot being exported.

" + }, + "version":{ + "shape":"NumericalVersion", + "documentation":"

The version of the bot being exported.

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

The type of the exported resource.

" + }, + "exportType":{ + "shape":"ExportType", + "documentation":"

The format of the exported data.

" + }, + "exportStatus":{ + "shape":"ExportStatus", + "documentation":"

The status of the export.

  • IN_PROGRESS - The export is in progress.

  • READY - The export is complete.

  • FAILED - The export could not be completed.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex provides the reason that it failed to export the resource.

" + }, + "url":{ + "shape":"String", + "documentation":"

An S3 pre-signed URL that provides the location of the exported resource. The exported resource is a ZIP archive that contains the exported resource in JSON format. The structure of the archive may change. Your code should not rely on the archive structure.

" + } + } + }, + "GetImportRequest":{ + "type":"structure", + "required":["importId"], + "members":{ + "importId":{ + "shape":"String", + "documentation":"

The identifier of the import job information to return.

", + "location":"uri", + "locationName":"importId" + } + } + }, + "GetImportResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name given to the import job.

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

The type of resource imported.

" + }, + "mergeStrategy":{ + "shape":"MergeStrategy", + "documentation":"

The action taken when there was a conflict between an existing resource and a resource in the import file.

" + }, + "importId":{ + "shape":"String", + "documentation":"

The identifier for the specific import job.

" + }, + "importStatus":{ + "shape":"ImportStatus", + "documentation":"

The status of the import job. If the status is FAILED, you can get the reason for the failure from the failureReason field.

" + }, + "failureReason":{ + "shape":"StringList", + "documentation":"

A string that describes why an import job failed to complete.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

A timestamp for the date and time that the import job was created.

" + } + } + }, + "GetIntentRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the intent.

", + "location":"uri", + "locationName":"version" + } + } + }, + "GetIntentResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the intent.

" + }, + "slots":{ + "shape":"SlotList", + "documentation":"

An array of intent slots configured for the intent.

" + }, + "sampleUtterances":{ + "shape":"IntentUtteranceList", + "documentation":"

An array of sample utterances configured for the intent.

" + }, + "confirmationPrompt":{ + "shape":"Prompt", + "documentation":"

If defined in the bot, Amazon Lex uses prompt to confirm the intent before fulfilling the user's request. For more information, see PutIntent.

" + }, + "rejectionStatement":{ + "shape":"Statement", + "documentation":"

If the user answers \"no\" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + }, + "followUpPrompt":{ + "shape":"FollowUpPrompt", + "documentation":"

If defined in the bot, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled. For more information, see PutIntent.

" + }, + "conclusionStatement":{ + "shape":"Statement", + "documentation":"

After the Lambda function specified in the fulfillmentActivity element fulfills the intent, Amazon Lex conveys this statement to the user.

" + }, + "dialogCodeHook":{ + "shape":"CodeHook", + "documentation":"

If defined in the bot, Amazon Amazon Lex invokes this Lambda function for each user input. For more information, see PutIntent.

" + }, + "fulfillmentActivity":{ + "shape":"FulfillmentActivity", + "documentation":"

Describes how the intent is fulfilled. For more information, see PutIntent.

" + }, + "parentIntentSignature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

A unique identifier for a built-in intent.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the intent.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the intent.

" + } + } + }, + "GetIntentVersionsRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent for which versions should be returned.

", + "location":"uri", + "locationName":"name" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of intent versions to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "GetIntentVersionsResponse":{ + "type":"structure", + "members":{ + "intents":{ + "shape":"IntentMetadataList", + "documentation":"

An array of IntentMetadata objects, one for each numbered version of the intent plus one for the $LATEST version.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of intent versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

" + } + } + }, + "GetIntentsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of intents. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of intents, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of intents to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nameContains":{ + "shape":"IntentName", + "documentation":"

Substring to match in intent names. An intent will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "location":"querystring", + "locationName":"nameContains" + } + } + }, + "GetIntentsResponse":{ + "type":"structure", + "members":{ + "intents":{ + "shape":"IntentMetadataList", + "documentation":"

An array of Intent objects. For more information, see PutBot.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, the response includes a pagination token that you can specify in your next request to fetch the next page of intents.

" + } + } + }, + "GetSlotTypeRequest":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type. The name is case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the slot type.

", + "location":"uri", + "locationName":"version" + } + } + }, + "GetSlotTypeResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot type.

" + }, + "enumerationValues":{ + "shape":"EnumerationValues", + "documentation":"

A list of EnumerationValue objects that defines the values that the slot type can take.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was updated. When you create a resource, the creation date and last update date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the slot type.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the $LATEST version of the slot type.

" + }, + "valueSelectionStrategy":{ + "shape":"SlotValueSelectionStrategy", + "documentation":"

The strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.

" + } + } + }, + "GetSlotTypeVersionsRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type for which versions should be returned.

", + "location":"uri", + "locationName":"name" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of slot type versions to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "GetSlotTypeVersionsResponse":{ + "type":"structure", + "members":{ + "slotTypes":{ + "shape":"SlotTypeMetadataList", + "documentation":"

An array of SlotTypeMetadata objects, one for each numbered version of the slot type plus one for the $LATEST version.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token for fetching the next page of slot type versions. If the response to this call is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of versions, specify the pagination token in the next request.

" + } + } + }, + "GetSlotTypesRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

A pagination token that fetches the next page of slot types. If the response to this API call is truncated, Amazon Lex returns a pagination token in the response. To fetch next page of slot types, specify the pagination token in the next request.

", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of slot types to return in the response. The default is 10.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nameContains":{ + "shape":"SlotTypeName", + "documentation":"

Substring to match in slot type names. A slot type will be returned if any part of its name matches the substring. For example, \"xyz\" matches both \"xyzabc\" and \"abcxyz.\"

", + "location":"querystring", + "locationName":"nameContains" + } + } + }, + "GetSlotTypesResponse":{ + "type":"structure", + "members":{ + "slotTypes":{ + "shape":"SlotTypeMetadataList", + "documentation":"

An array of objects, one for each slot type, that provides information such as the name of the slot type, the version, and a description.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

If the response is truncated, it includes a pagination token that you can specify in your next request to fetch the next page of slot types.

" + } + } + }, + "GetUtterancesViewRequest":{ + "type":"structure", + "required":[ + "botName", + "botVersions", + "statusType" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot for which utterance information should be returned.

", + "location":"uri", + "locationName":"botname" + }, + "botVersions":{ + "shape":"BotVersions", + "documentation":"

An array of bot versions for which utterance information should be returned. The limit is 5 versions per request.

", + "location":"querystring", + "locationName":"bot_versions" + }, + "statusType":{ + "shape":"StatusType", + "documentation":"

To return utterances that were recognized and handled, useDetected. To return utterances that were not recognized, use Missed.

", + "location":"querystring", + "locationName":"status_type" + } + } + }, + "GetUtterancesViewResponse":{ + "type":"structure", + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot for which utterance information was returned.

" + }, + "utterances":{ + "shape":"ListsOfUtterances", + "documentation":"

An array of UtteranceList objects, each containing a list of UtteranceData objects describing the utterances that were processed by your bot. The response contains a maximum of 100 UtteranceData objects for each version.

" + } + } + }, + "GroupNumber":{ + "type":"integer", + "box":true, + "max":5, + "min":1 + }, + "ImportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETE", + "FAILED" + ] + }, + "Intent":{ + "type":"structure", + "required":[ + "intentName", + "intentVersion" + ], + "members":{ + "intentName":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "intentVersion":{ + "shape":"Version", + "documentation":"

The version of the intent.

" + } + }, + "documentation":"

Identifies the specific version of an intent.

" + }, + "IntentList":{ + "type":"list", + "member":{"shape":"Intent"} + }, + "IntentMetadata":{ + "type":"structure", + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the intent.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was updated. When you create an intent, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the intent.

" + } + }, + "documentation":"

Provides information about an intent.

" + }, + "IntentMetadataList":{ + "type":"list", + "member":{"shape":"IntentMetadata"} + }, + "IntentName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([A-Za-z]_?)+$" + }, + "IntentUtteranceList":{ + "type":"list", + "member":{"shape":"Utterance"}, + "max":1500, + "min":0 + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

An internal Amazon Lex error occurred. Try your request again.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LambdaARN":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws:lambda:[a-z]+-[a-z]+-[0-9]:[0-9]{12}:function:[a-zA-Z0-9-_]+(/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})?(:[a-zA-Z0-9-_]+)?" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"String"} + }, + "documentation":"

The request exceeded a limit. Try your request again.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListOfUtterance":{ + "type":"list", + "member":{"shape":"UtteranceData"} + }, + "ListsOfUtterances":{ + "type":"list", + "member":{"shape":"UtteranceList"} + }, + "Locale":{ + "type":"string", + "enum":[ + "en-US", + "en-GB", + "de-DE" + ] + }, + "LocaleList":{ + "type":"list", + "member":{"shape":"Locale"} + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MergeStrategy":{ + "type":"string", + "enum":[ + "OVERWRITE_LATEST", + "FAIL_ON_CONFLICT" + ] + }, + "Message":{ + "type":"structure", + "required":[ + "contentType", + "content" + ], + "members":{ + "contentType":{ + "shape":"ContentType", + "documentation":"

The content type of the message string.

" + }, + "content":{ + "shape":"ContentString", + "documentation":"

The text of the message.

" + }, + "groupNumber":{ + "shape":"GroupNumber", + "documentation":"

Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.

" + } + }, + "documentation":"

The message object that provides the message text and its type.

" + }, + "MessageList":{ + "type":"list", + "member":{"shape":"Message"}, + "max":15, + "min":1 + }, + "MessageVersion":{ + "type":"string", + "max":5, + "min":1 + }, + "Name":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[a-zA-Z_]+" + }, + "NextToken":{"type":"string"}, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The resource specified in the request was not found. Check the resource and try again.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NumericalVersion":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[0-9]+" + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

", + "error":{"httpStatusCode":412}, + "exception":true + }, + "Priority":{ + "type":"integer", + "max":100, + "min":0 + }, + "ProcessBehavior":{ + "type":"string", + "enum":[ + "SAVE", + "BUILD" + ] + }, + "Prompt":{ + "type":"structure", + "required":[ + "messages", + "maxAttempts" + ], + "members":{ + "messages":{ + "shape":"MessageList", + "documentation":"

An array of objects, each of which provides a message string and its type. You can specify the message string in plain text or in Speech Synthesis Markup Language (SSML).

" + }, + "maxAttempts":{ + "shape":"PromptMaxAttempts", + "documentation":"

The number of times to prompt the user for information.

" + }, + "responseCard":{ + "shape":"ResponseCard", + "documentation":"

A response card. Amazon Lex uses this prompt at runtime, in the PostText API response. It substitutes session attributes and slot values for placeholders in the response card. For more information, see ex-resp-card.

" + } + }, + "documentation":"

Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

" + }, + "PromptMaxAttempts":{ + "type":"integer", + "max":5, + "min":1 + }, + "PutBotAliasRequest":{ + "type":"structure", + "required":[ + "name", + "botVersion", + "botName" + ], + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the alias. The name is not case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the alias.

" + }, + "botVersion":{ + "shape":"Version", + "documentation":"

The version of the bot.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot.

", + "location":"uri", + "locationName":"botName" + }, + "checksum":{ + "shape":"String", + "documentation":"

Identifies a specific revision of the $LATEST version.

When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

" + } + } + }, + "PutBotAliasResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AliasName", + "documentation":"

The name of the alias.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the alias.

" + }, + "botVersion":{ + "shape":"Version", + "documentation":"

The version of the bot that the alias points to.

" + }, + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that the alias points to.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot alias was created.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

The checksum for the current version of the alias.

" + } + } + }, + "PutBotRequest":{ + "type":"structure", + "required":[ + "name", + "locale", + "childDirected" + ], + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot. The name is not case sensitive.

", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot.

" + }, + "intents":{ + "shape":"IntentList", + "documentation":"

An array of Intent objects. Each intent represents a command that a user can express. For example, a pizza ordering bot might support an OrderPizza intent. For more information, see how-it-works.

" + }, + "clarificationPrompt":{ + "shape":"Prompt", + "documentation":"

When Amazon Lex doesn't understand the user's intent, it uses this message to get clarification. To specify how many times Amazon Lex should repeate the clarification prompt, use the maxAttempts field. If Amazon Lex still doesn't understand, it sends the message in the abortStatement field.

When you create a clarification prompt, make sure that it suggests the correct response from the user. for example, for a bot that orders pizza and drinks, you might create this clarification prompt: \"What would you like to do? You can say 'Order a pizza' or 'Order a drink.'\"

" + }, + "abortStatement":{ + "shape":"Statement", + "documentation":"

When Amazon Lex can't understand the user's input in context, it tries to elicit the information a few times. After that, Amazon Lex sends the message defined in abortStatement to the user, and then aborts the conversation. To set the number of retries, use the valueElicitationPrompt field for the slot type.

For example, in a pizza ordering bot, Amazon Lex might ask a user \"What type of crust would you like?\" If the user's response is not one of the expected responses (for example, \"thin crust, \"deep dish,\" etc.), Amazon Lex tries to elicit a correct response a few more times.

For example, in a pizza ordering application, OrderPizza might be one of the intents. This intent might require the CrustType slot. You specify the valueElicitationPrompt field when you create the CrustType slot.

" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"

The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.

A user interaction session remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Lex deletes any data provided before the timeout.

For example, suppose that a user chooses the OrderPizza intent, but gets sidetracked halfway through placing an order. If the user doesn't complete the order within the specified time, Amazon Lex discards the slot information that it gathered, and the user must start over.

If you don't include the idleSessionTTLInSeconds element in a PutBot operation request, Amazon Lex uses the default value. This is also true if the request replaces an existing bot.

The default is 300 seconds (5 minutes).

" + }, + "voiceId":{ + "shape":"String", + "documentation":"

The Amazon Polly voice ID that you want Amazon Lex to use for voice interactions with the user. The locale configured for the voice must match the locale of the bot. For more information, see Available Voices in the Amazon Polly Developer Guide.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Identifies a specific revision of the $LATEST version.

When you create a new bot, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a bot, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

" + }, + "processBehavior":{ + "shape":"ProcessBehavior", + "documentation":"

If you set the processBehavior element to BUILD, Amazon Lex builds the bot so that it can be run. If you set the element to SAVE Amazon Lex saves the bot, but doesn't build it.

If you don't specify this value, the default value is BUILD.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

Specifies the target locale for the bot. Any intent used in the bot must be compatible with the locale of the bot.

The default is en-US.

" + }, + "childDirected":{ + "shape":"Boolean", + "documentation":"

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "PutBotResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"BotName", + "documentation":"

The name of the bot.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the bot.

" + }, + "intents":{ + "shape":"IntentList", + "documentation":"

An array of Intent objects. For more information, see PutBot.

" + }, + "clarificationPrompt":{ + "shape":"Prompt", + "documentation":"

The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

" + }, + "abortStatement":{ + "shape":"Statement", + "documentation":"

The message that Amazon Lex uses to abort a conversation. For more information, see PutBot.

" + }, + "status":{ + "shape":"Status", + "documentation":"

When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING. After Amazon Lex builds the bot, it sets status to READY. If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

When you set processBehaviorto SAVE, Amazon Lex sets the status code to NOT BUILT.

" + }, + "failureReason":{ + "shape":"String", + "documentation":"

If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the bot was created.

" + }, + "idleSessionTTLInSeconds":{ + "shape":"SessionTTL", + "documentation":"

The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

" + }, + "voiceId":{ + "shape":"String", + "documentation":"

The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the bot that you created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the bot. For a new bot, the version is always $LATEST.

" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The target locale for the bot.

" + }, + "childDirected":{ + "shape":"Boolean", + "documentation":"

For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "PutIntentRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent. The name is not case sensitive.

The name can't match a built-in intent name, or a built-in intent name with \"AMAZON.\" removed. For example, because there is a built-in intent called AMAZON.HelpIntent, you can't create a custom intent called HelpIntent.

For a list of built-in intents, see Standard Built-in Intents in the Alexa Skills Kit.

", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the intent.

" + }, + "slots":{ + "shape":"SlotList", + "documentation":"

An array of intent slots. At runtime, Amazon Lex elicits required slot values from the user using prompts defined in the slots. For more information, see how-it-works.

" + }, + "sampleUtterances":{ + "shape":"IntentUtteranceList", + "documentation":"

An array of utterances (strings) that a user might say to signal the intent. For example, \"I want {PizzaSize} pizza\", \"Order {Quantity} {PizzaSize} pizzas\".

In each utterance, a slot name is enclosed in curly braces.

" + }, + "confirmationPrompt":{ + "shape":"Prompt", + "documentation":"

Prompts the user to confirm the intent. This question should have a yes or no answer.

Amazon Lex uses this prompt to ensure that the user acknowledges that the intent is ready for fulfillment. For example, with the OrderPizza intent, you might want to confirm that the order is correct before placing it. For other intents, such as intents that simply respond to user questions, you might not need to ask the user for confirmation before providing the information.

You you must provide both the rejectionStatement and the confirmationPrompt, or neither.

" + }, + "rejectionStatement":{ + "shape":"Statement", + "documentation":"

When the user answers \"no\" to the question defined in confirmationPrompt, Amazon Lex responds with this statement to acknowledge that the intent was canceled.

You must provide both the rejectionStatement and the confirmationPrompt, or neither.

" + }, + "followUpPrompt":{ + "shape":"FollowUpPrompt", + "documentation":"

Amazon Lex uses this prompt to solicit additional activity after fulfilling an intent. For example, after the OrderPizza intent is fulfilled, you might prompt the user to order a drink.

The action that Amazon Lex takes depends on the user's response, as follows:

  • If the user says \"Yes\" it responds with the clarification prompt that is configured for the bot.

  • if the user says \"Yes\" and continues with an utterance that triggers an intent it starts a conversation for the intent.

  • If the user says \"No\" it responds with the rejection statement configured for the the follow-up prompt.

  • If it doesn't recognize the utterance it repeats the follow-up prompt again.

The followUpPrompt field and the conclusionStatement field are mutually exclusive. You can specify only one.

" + }, + "conclusionStatement":{ + "shape":"Statement", + "documentation":"

The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function.

This element is relevant only if you provide a Lambda function in the fulfillmentActivity. If you return the intent to the client application, you can't specify this element.

The followUpPrompt and conclusionStatement are mutually exclusive. You can specify only one.

" + }, + "dialogCodeHook":{ + "shape":"CodeHook", + "documentation":"

Specifies a Lambda function to invoke for each user input. You can invoke this Lambda function to personalize user interaction.

For example, suppose your bot determines that the user is John. Your Lambda function might retrieve John's information from a backend database and prepopulate some of the values. For example, if you find that John is gluten intolerant, you might set the corresponding intent slot, GlutenIntolerant, to true. You might find John's phone number and set the corresponding session attribute.

" + }, + "fulfillmentActivity":{ + "shape":"FulfillmentActivity", + "documentation":"

Required. Describes how the intent is fulfilled. For example, after a user provides all of the information for a pizza order, fulfillmentActivity defines how the bot places an order with a local pizza store.

You might configure Amazon Lex to return all of the intent information to the client application, or direct it to invoke a Lambda function that can process the intent (for example, place an order with a pizzeria).

" + }, + "parentIntentSignature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

A unique identifier for the built-in intent to base this intent on. To find the signature for an intent, see Standard Built-in Intents in the Alexa Skills Kit.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Identifies a specific revision of the $LATEST version.

When you create a new intent, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a intent, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "PutIntentResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the intent.

" + }, + "slots":{ + "shape":"SlotList", + "documentation":"

An array of intent slots that are configured for the intent.

" + }, + "sampleUtterances":{ + "shape":"IntentUtteranceList", + "documentation":"

An array of sample utterances that are configured for the intent.

" + }, + "confirmationPrompt":{ + "shape":"Prompt", + "documentation":"

If defined in the intent, Amazon Lex prompts the user to confirm the intent before fulfilling it.

" + }, + "rejectionStatement":{ + "shape":"Statement", + "documentation":"

If the user answers \"no\" to the question defined in confirmationPrompt Amazon Lex responds with this statement to acknowledge that the intent was canceled.

" + }, + "followUpPrompt":{ + "shape":"FollowUpPrompt", + "documentation":"

If defined in the intent, Amazon Lex uses this prompt to solicit additional user activity after the intent is fulfilled.

" + }, + "conclusionStatement":{ + "shape":"Statement", + "documentation":"

After the Lambda function specified in thefulfillmentActivityintent fulfills the intent, Amazon Lex conveys this statement to the user.

" + }, + "dialogCodeHook":{ + "shape":"CodeHook", + "documentation":"

If defined in the intent, Amazon Lex invokes this Lambda function for each user input.

" + }, + "fulfillmentActivity":{ + "shape":"FulfillmentActivity", + "documentation":"

If defined in the intent, Amazon Lex invokes this Lambda function to fulfill the intent after the user provides all of the information required by the intent.

" + }, + "parentIntentSignature":{ + "shape":"BuiltinIntentSignature", + "documentation":"

A unique identifier for the built-in intent that this intent is based on.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was updated. When you create a resource, the creation date and last update dates are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the intent was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the intent. For a new intent, the version is always $LATEST.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the $LATESTversion of the intent created or updated.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "PutSlotTypeRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type. The name is not case sensitive.

The name can't match a built-in slot type name, or a built-in slot type name with \"AMAZON.\" removed. For example, because there is a built-in slot type called AMAZON.DATE, you can't create a custom slot type called DATE.

For a list of built-in slot types, see Slot Type Reference in the Alexa Skills Kit.

", + "location":"uri", + "locationName":"name" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot type.

" + }, + "enumerationValues":{ + "shape":"EnumerationValues", + "documentation":"

A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot.

When Amazon Lex resolves a slot value, it generates a resolution list that contains up to five possible values for the slot. If you are using a Lambda function, this resolution list is passed to the function. If you are not using a Lambda function you can choose to return the value that the user entered or the first value in the resolution list as the slot value. The valueSelectionStrategy field indicates the option to use.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Identifies a specific revision of the $LATEST version.

When you create a new slot type, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

When you want to update a slot type, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

" + }, + "valueSelectionStrategy":{ + "shape":"SlotValueSelectionStrategy", + "documentation":"

Determines the slot resolution strategy that Amazon Lex uses to return slot type values. The field can be set to one of the following values:

  • ORIGINAL_VALUE - Returns the value entered by the user, if the user value is similar to the slot value.

  • TOP_RESOLUTION - If there is a resolution list for the slot, return the first value in the resolution list as the slot type value. If there is no resolution list, null is returned.

If you don't specify the valueSelectionStrategy, the default is ORIGINAL_VALUE.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "PutSlotTypeResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot type.

" + }, + "enumerationValues":{ + "shape":"EnumerationValues", + "documentation":"

A list of EnumerationValue objects that defines the values that the slot type can take.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was updated. When you create a slot type, the creation date and last update date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the slot type. For a new slot type, the version is always $LATEST.

" + }, + "checksum":{ + "shape":"String", + "documentation":"

Checksum of the $LATEST version of the slot type.

" + }, + "valueSelectionStrategy":{ + "shape":"SlotValueSelectionStrategy", + "documentation":"

The slot resolution strategy that Amazon Lex uses to determine the value of the slot. For more information, see PutSlotType.

" + }, + "createVersion":{"shape":"Boolean"} + } + }, + "ReferenceType":{ + "type":"string", + "enum":[ + "Intent", + "Bot", + "BotAlias", + "BotChannel" + ] + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "referenceType":{"shape":"ReferenceType"}, + "exampleReference":{"shape":"ResourceReference"} + }, + "documentation":"

The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

The body of the exception contains a JSON object that describes the resource.

{ \"resourceType\": BOT | BOTALIAS | BOTCHANNEL | INTENT,

\"resourceReference\": {

\"name\": string, \"version\": string } }

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceReference":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the resource that is using the resource that you are trying to delete.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the resource that is using the resource that you are trying to delete.

" + } + }, + "documentation":"

Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the ResourceInUseException exception.

" + }, + "ResourceType":{ + "type":"string", + "enum":[ + "BOT", + "INTENT", + "SLOT_TYPE" + ] + }, + "ResponseCard":{ + "type":"string", + "max":50000, + "min":1 + }, + "SessionTTL":{ + "type":"integer", + "max":86400, + "min":60 + }, + "Slot":{ + "type":"structure", + "required":[ + "name", + "slotConstraint" + ], + "members":{ + "name":{ + "shape":"SlotName", + "documentation":"

The name of the slot.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot.

" + }, + "slotConstraint":{ + "shape":"SlotConstraint", + "documentation":"

Specifies whether the slot is required or optional.

" + }, + "slotType":{ + "shape":"CustomOrBuiltinSlotTypeName", + "documentation":"

The type of the slot, either a custom slot type that you defined or one of the built-in slot types.

" + }, + "slotTypeVersion":{ + "shape":"Version", + "documentation":"

The version of the slot type.

" + }, + "valueElicitationPrompt":{ + "shape":"Prompt", + "documentation":"

The prompt that Amazon Lex uses to elicit the slot value from the user.

" + }, + "priority":{ + "shape":"Priority", + "documentation":"

Directs Lex the order in which to elicit this slot value from the user. For example, if the intent has two slots with priorities 1 and 2, AWS Lex first elicits a value for the slot with priority 1.

If multiple slots share the same priority, the order in which Lex elicits values is arbitrary.

" + }, + "sampleUtterances":{ + "shape":"SlotUtteranceList", + "documentation":"

If you know a specific pattern with which users might respond to an Amazon Lex request for a slot value, you can provide those utterances to improve accuracy. This is optional. In most cases, Amazon Lex is capable of understanding user utterances.

" + }, + "responseCard":{ + "shape":"ResponseCard", + "documentation":"

A set of possible responses for the slot type used by text-based clients. A user chooses an option from the response card, instead of using text to reply.

" + } + }, + "documentation":"

Identifies the version of a specific slot.

" + }, + "SlotConstraint":{ + "type":"string", + "enum":[ + "Required", + "Optional" + ] + }, + "SlotList":{ + "type":"list", + "member":{"shape":"Slot"}, + "max":100, + "min":0 + }, + "SlotName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([A-Za-z](-|_|.)?)+$" + }, + "SlotTypeMetadata":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SlotTypeName", + "documentation":"

The name of the slot type.

" + }, + "description":{ + "shape":"Description", + "documentation":"

A description of the slot type.

" + }, + "lastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was updated. When you create a resource, the creation date and last updated date are the same.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

The date that the slot type was created.

" + }, + "version":{ + "shape":"Version", + "documentation":"

The version of the slot type.

" + } + }, + "documentation":"

Provides information about a slot type..

" + }, + "SlotTypeMetadataList":{ + "type":"list", + "member":{"shape":"SlotTypeMetadata"} + }, + "SlotTypeName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^([A-Za-z]_?)+$" + }, + "SlotUtteranceList":{ + "type":"list", + "member":{"shape":"Utterance"}, + "max":10, + "min":0 + }, + "SlotValueSelectionStrategy":{ + "type":"string", + "enum":[ + "ORIGINAL_VALUE", + "TOP_RESOLUTION" + ] + }, + "StartImportRequest":{ + "type":"structure", + "required":[ + "payload", + "resourceType", + "mergeStrategy" + ], + "members":{ + "payload":{ + "shape":"Blob", + "documentation":"

A zip archive in binary format. The archive should contain one file, a JSON file containing the resource to import. The resource should match the type specified in the resourceType field.

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

Specifies the type of resource to export. Each resource also exports any resources that it depends on.

  • A bot exports dependent intents.

  • An intent exports dependent slot types.

" + }, + "mergeStrategy":{ + "shape":"MergeStrategy", + "documentation":"

Specifies the action that the StartImport operation should take when there is an existing resource with the same name.

  • FAIL_ON_CONFLICT - The import operation is stopped on the first conflict between a resource in the import file and an existing resource. The name of the resource causing the conflict is in the failureReason field of the response to the GetImport operation.

    OVERWRITE_LATEST - The import operation proceeds even if there is a conflict with an existing resource. The $LASTEST version of the existing resource is overwritten with the data from the import file.

" + } + } + }, + "StartImportResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name given to the import job.

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

The type of resource to import.

" + }, + "mergeStrategy":{ + "shape":"MergeStrategy", + "documentation":"

The action to take when there is a merge conflict.

" + }, + "importId":{ + "shape":"String", + "documentation":"

The identifier for the specific import job.

" + }, + "importStatus":{ + "shape":"ImportStatus", + "documentation":"

The status of the import job. If the status is FAILED, you can get the reason for the failure using the GetImport operation.

" + }, + "createdDate":{ + "shape":"Timestamp", + "documentation":"

A timestamp for the date and time that the import job was requested.

" + } + } + }, + "Statement":{ + "type":"structure", + "required":["messages"], + "members":{ + "messages":{ + "shape":"MessageList", + "documentation":"

A collection of message objects.

" + }, + "responseCard":{ + "shape":"ResponseCard", + "documentation":"

At runtime, if the client is using the PostText API, Amazon Lex includes the response card in the response. It substitutes all of the session attributes and slot values for placeholders in the response card.

" + } + }, + "documentation":"

A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.

" + }, + "Status":{ + "type":"string", + "enum":[ + "BUILDING", + "READY", + "READY_BASIC_TESTING", + "FAILED", + "NOT_BUILT" + ] + }, + "StatusType":{ + "type":"string", + "enum":[ + "Detected", + "Missed" + ] + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SynonymList":{ + "type":"list", + "member":{"shape":"Value"} + }, + "Timestamp":{"type":"timestamp"}, + "UserId":{ + "type":"string", + "max":100, + "min":2 + }, + "Utterance":{ + "type":"string", + "max":200, + "min":1 + }, + "UtteranceData":{ + "type":"structure", + "members":{ + "utteranceString":{ + "shape":"UtteranceString", + "documentation":"

The text that was entered by the user or the text representation of an audio clip.

" + }, + "count":{ + "shape":"Count", + "documentation":"

The number of times that the utterance was processed.

" + }, + "distinctUsers":{ + "shape":"Count", + "documentation":"

The total number of individuals that used the utterance.

" + }, + "firstUtteredDate":{ + "shape":"Timestamp", + "documentation":"

The date that the utterance was first recorded.

" + }, + "lastUtteredDate":{ + "shape":"Timestamp", + "documentation":"

The date that the utterance was last recorded.

" + } + }, + "documentation":"

Provides information about a single utterance that was made to your bot.

" + }, + "UtteranceList":{ + "type":"structure", + "members":{ + "botVersion":{ + "shape":"Version", + "documentation":"

The version of the bot that processed the list.

" + }, + "utterances":{ + "shape":"ListOfUtterance", + "documentation":"

One or more UtteranceData objects that contain information about the utterances that have been made to a bot. The maximum number of object is 100.

" + } + }, + "documentation":"

Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.

" + }, + "UtteranceString":{ + "type":"string", + "max":2000, + "min":1 + }, + "Value":{ + "type":"string", + "max":140, + "min":1 + }, + "Version":{ + "type":"string", + "max":64, + "min":1, + "pattern":"\\$LATEST|[0-9]+" + } + }, + "documentation":"Amazon Lex Build-Time Actions

Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.

" +} diff --git a/aws/dist/botocore/data/lex-runtime/2016-11-28/paginators-1.json b/aws/dist/botocore/data/lex-runtime/2016-11-28/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/lex-runtime/2016-11-28/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/lex-runtime/2016-11-28/service-2.json b/aws/dist/botocore/data/lex-runtime/2016-11-28/service-2.json new file mode 100644 index 00000000..7aeeee13 --- /dev/null +++ b/aws/dist/botocore/data/lex-runtime/2016-11-28/service-2.json @@ -0,0 +1,901 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-28", + "endpointPrefix":"runtime.lex", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Lex Runtime Service", + "serviceId":"Lex Runtime Service", + "signatureVersion":"v4", + "signingName":"lex", + "uid":"runtime.lex-2016-11-28" + }, + "operations":{ + "DeleteSession":{ + "name":"DeleteSession", + "http":{ + "method":"DELETE", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session" + }, + "input":{"shape":"DeleteSessionRequest"}, + "output":{"shape":"DeleteSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Removes session information for a specified bot, alias, and user ID.

" + }, + "GetSession":{ + "name":"GetSession", + "http":{ + "method":"GET", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session/" + }, + "input":{"shape":"GetSessionRequest"}, + "output":{"shape":"GetSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Returns session information for a specified bot, alias, and user ID.

" + }, + "PostContent":{ + "name":"PostContent", + "http":{ + "method":"POST", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/content" + }, + "input":{"shape":"PostContentRequest"}, + "output":{"shape":"PostContentResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"}, + {"shape":"UnsupportedMediaTypeException"}, + {"shape":"NotAcceptableException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"LoopDetectedException"} + ], + "documentation":"

Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.

The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.

In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:

  • For a user input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\".

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: \"Order the pizza?\".

  • After the user replies \"Yes\" to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".

Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • x-amz-lex-dialog-state header set to ElicitSlot

    • x-amz-lex-intent-name header set to the intent name in the current context

    • x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information

    • x-amz-lex-slots header set to a map of slots configured for the intent with their current values

  • If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted.

  • If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.

In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.

", + "authtype":"v4-unsigned-body" + }, + "PostText":{ + "name":"PostText", + "http":{ + "method":"POST", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/text" + }, + "input":{"shape":"PostTextRequest"}, + "output":{"shape":"PostTextResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"}, + {"shape":"LoopDetectedException"} + ], + "documentation":"

Sends user input to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.

In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:

  • For a user input \"I would like a pizza\", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\"

  • After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation \"Proceed with the pizza order?\".

  • After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".

Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a \"yes\" or \"no\" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:

  • If the message is to elicit slot data, Amazon Lex returns the following context information:

    • dialogState set to ElicitSlot

    • intentName set to the intent name in the current context

    • slotToElicit set to the slot name for which the message is eliciting information

    • slots set to a map of slots, configured for the intent, with currently known values

  • If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.

  • If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.

In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.

" + }, + "PutSession":{ + "name":"PutSession", + "http":{ + "method":"POST", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session" + }, + "input":{"shape":"PutSessionRequest"}, + "output":{"shape":"PutSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"}, + {"shape":"NotAcceptableException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"} + ], + "documentation":"

Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.

For more information, see Managing Sessions.

" + } + }, + "shapes":{ + "Accept":{"type":"string"}, + "AttributesString":{ + "type":"string", + "sensitive":true + }, + "BadGatewayException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Either the Amazon Lex bot is still building, or one of the dependent services (Amazon Polly, AWS Lambda) failed with an internal service error.

", + "error":{"httpStatusCode":502}, + "exception":true + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

Request validation failed, there is no usable message in the context, or the bot build failed, is still in progress, or contains unbuilt changes.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BlobStream":{ + "type":"blob", + "streaming":true + }, + "BotAlias":{"type":"string"}, + "BotName":{"type":"string"}, + "Button":{ + "type":"structure", + "required":[ + "text", + "value" + ], + "members":{ + "text":{ + "shape":"ButtonTextStringWithLength", + "documentation":"

Text that is visible to the user on the button.

" + }, + "value":{ + "shape":"ButtonValueStringWithLength", + "documentation":"

The value sent to Amazon Lex when a user chooses the button. For example, consider button text \"NYC.\" When the user chooses the button, the value sent can be \"New York City.\"

" + } + }, + "documentation":"

Represents an option to be shown on the client platform (Facebook, Slack, etc.)

" + }, + "ButtonTextStringWithLength":{ + "type":"string", + "max":15, + "min":1 + }, + "ButtonValueStringWithLength":{ + "type":"string", + "max":1000, + "min":1 + }, + "ConfirmationStatus":{ + "type":"string", + "enum":[ + "None", + "Confirmed", + "Denied" + ] + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

Two clients are using the same AWS account, Amazon Lex bot, and user ID.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ContentType":{ + "type":"string", + "enum":["application/vnd.amazonaws.card.generic"] + }, + "DeleteSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that contains the session data.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

The alias in use for the bot that contains the session data.

", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The identifier of the user associated with the session data.

", + "location":"uri", + "locationName":"userId" + } + } + }, + "DeleteSessionResponse":{ + "type":"structure", + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot associated with the session data.

" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

The alias in use for the bot associated with the session data.

" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The ID of the client application user.

" + }, + "sessionId":{ + "shape":"String", + "documentation":"

The unique identifier for the session.

" + } + } + }, + "DependencyFailedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,

  • If Amazon Lex does not have sufficient permissions to call a Lambda function.

  • If a Lambda function takes longer than 30 seconds to execute.

  • If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.

", + "error":{"httpStatusCode":424}, + "exception":true + }, + "DialogAction":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"DialogActionType", + "documentation":"

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"

  • Close - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.

  • Delegate - The next action is determined by Amazon Lex.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

" + }, + "intentName":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "slots":{ + "shape":"StringMap", + "documentation":"

Map of the slots that have been gathered and their values.

" + }, + "slotToElicit":{ + "shape":"String", + "documentation":"

The name of the slot that should be elicited from the user.

" + }, + "fulfillmentState":{ + "shape":"FulfillmentState", + "documentation":"

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

" + }, + "message":{ + "shape":"Text", + "documentation":"

The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.

" + }, + "messageFormat":{ + "shape":"MessageFormatType", + "documentation":"

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.

" + } + }, + "documentation":"

Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.

" + }, + "DialogActionType":{ + "type":"string", + "enum":[ + "ElicitIntent", + "ConfirmIntent", + "ElicitSlot", + "Close", + "Delegate" + ] + }, + "DialogState":{ + "type":"string", + "enum":[ + "ElicitIntent", + "ConfirmIntent", + "ElicitSlot", + "Fulfilled", + "ReadyForFulfillment", + "Failed" + ] + }, + "ErrorMessage":{"type":"string"}, + "FulfillmentState":{ + "type":"string", + "enum":[ + "Fulfilled", + "Failed", + "ReadyForFulfillment" + ] + }, + "GenericAttachment":{ + "type":"structure", + "members":{ + "title":{ + "shape":"StringWithLength", + "documentation":"

The title of the option.

" + }, + "subTitle":{ + "shape":"StringWithLength", + "documentation":"

The subtitle shown below the title.

" + }, + "attachmentLinkUrl":{ + "shape":"StringUrlWithLength", + "documentation":"

The URL of an attachment to the response card.

" + }, + "imageUrl":{ + "shape":"StringUrlWithLength", + "documentation":"

The URL of an image that is displayed to the user.

" + }, + "buttons":{ + "shape":"listOfButtons", + "documentation":"

The list of options to show to the user.

" + } + }, + "documentation":"

Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.

" + }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that contains the session data.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

The alias in use for the bot that contains the session data.

", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

", + "location":"uri", + "locationName":"userId" + }, + "checkpointLabelFilter":{ + "shape":"IntentSummaryCheckpointLabel", + "documentation":"

A string used to filter the intents returned in the recentIntentSummaryView structure.

When you specify a filter, only intents with their checkpointLabel field set to that string are returned.

", + "location":"querystring", + "locationName":"checkpointLabelFilter" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "recentIntentSummaryView":{ + "shape":"IntentSummaryList", + "documentation":"

An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.

If you set the checkpointLabelFilter parameter in the request, the array contains only the intents with the specified label.

" + }, + "sessionAttributes":{ + "shape":"StringMap", + "documentation":"

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

" + }, + "sessionId":{ + "shape":"String", + "documentation":"

A unique identifier for the session.

" + }, + "dialogAction":{ + "shape":"DialogAction", + "documentation":"

Describes the current state of the bot.

" + } + } + }, + "HttpContentType":{"type":"string"}, + "IntentName":{"type":"string"}, + "IntentSummary":{ + "type":"structure", + "required":["dialogActionType"], + "members":{ + "intentName":{ + "shape":"IntentName", + "documentation":"

The name of the intent.

" + }, + "checkpointLabel":{ + "shape":"IntentSummaryCheckpointLabel", + "documentation":"

A user-defined label that identifies a particular intent. You can use this label to return to a previous intent.

Use the checkpointLabelFilter parameter of the GetSessionRequest operation to filter the intents returned by the operation to those with only the specified label.

" + }, + "slots":{ + "shape":"StringMap", + "documentation":"

Map of the slots that have been gathered and their values.

" + }, + "confirmationStatus":{ + "shape":"ConfirmationStatus", + "documentation":"

The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:

  • Confirmed - The user has responded \"Yes\" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.

  • Denied - The user has responded \"No\" to the confirmation prompt.

  • None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.

" + }, + "dialogActionType":{ + "shape":"DialogActionType", + "documentation":"

The next action that the bot should take in its interaction with the user. The possible values are:

  • ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"

  • Close - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.

  • ElicitIntent - The next action is to determine the intent that the user wants to fulfill.

  • ElicitSlot - The next action is to elicit a slot value from the user.

" + }, + "fulfillmentState":{ + "shape":"FulfillmentState", + "documentation":"

The fulfillment state of the intent. The possible values are:

  • Failed - The Lambda function associated with the intent failed to fulfill the intent.

  • Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.

  • ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.

" + }, + "slotToElicit":{ + "shape":"String", + "documentation":"

The next slot to elicit from the user. If there is not slot to elicit, the field is blank.

" + } + }, + "documentation":"

Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.

" + }, + "IntentSummaryCheckpointLabel":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9-]+" + }, + "IntentSummaryList":{ + "type":"list", + "member":{"shape":"IntentSummary"}, + "max":3, + "min":0 + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

Internal service error. Retry the call.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"String", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"String"} + }, + "documentation":"

Exceeded a limit.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "LoopDetectedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

This exception is not used.

", + "error":{"httpStatusCode":508}, + "exception":true + }, + "MessageFormatType":{ + "type":"string", + "enum":[ + "PlainText", + "CustomPayload", + "SSML", + "Composite" + ] + }, + "NotAcceptableException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The accept header in the request does not have a valid value.

", + "error":{"httpStatusCode":406}, + "exception":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The resource (such as the Amazon Lex bot or an alias) that is referred to is not found.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "PostContentRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId", + "contentType", + "inputStream" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

Name of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

Alias of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

", + "location":"uri", + "locationName":"userId" + }, + "sessionAttributes":{ + "shape":"AttributesString", + "documentation":"

You pass this value as the x-amz-lex-session-attributes HTTP header.

Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.

For more information, see Setting Session Attributes.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-session-attributes" + }, + "requestAttributes":{ + "shape":"AttributesString", + "documentation":"

You pass this value as the x-amz-lex-request-attributes HTTP header.

Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-request-attributes" + }, + "contentType":{ + "shape":"HttpContentType", + "documentation":"

You pass this value as the Content-Type HTTP header.

Indicates the audio format or text. The header value must start with one of the following prefixes:

  • PCM format, audio data must be in little-endian byte order.

    • audio/l16; rate=16000; channels=1

    • audio/x-l16; sample-rate=16000; channel-count=1

    • audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false

  • Opus format

    • audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4

  • Text format

    • text/plain; charset=utf-8

", + "location":"header", + "locationName":"Content-Type" + }, + "accept":{ + "shape":"Accept", + "documentation":"

You pass this value as the Accept HTTP header.

The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.

  • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

  • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

  • If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • text/plain; charset=utf-8

    • audio/* (defaults to mpeg)

", + "location":"header", + "locationName":"Accept" + }, + "inputStream":{ + "shape":"BlobStream", + "documentation":"

User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.

You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.

" + } + }, + "payload":"inputStream" + }, + "PostContentResponse":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"HttpContentType", + "documentation":"

Content type as specified in the Accept HTTP header in the request.

", + "location":"header", + "locationName":"Content-Type" + }, + "intentName":{ + "shape":"IntentName", + "documentation":"

Current user intent that Amazon Lex is aware of.

", + "location":"header", + "locationName":"x-amz-lex-intent-name" + }, + "slots":{ + "shape":"String", + "documentation":"

Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-slots" + }, + "sessionAttributes":{ + "shape":"String", + "documentation":"

Map of key/value pairs representing the session-specific context information.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-session-attributes" + }, + "message":{ + "shape":"Text", + "documentation":"

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

", + "location":"header", + "locationName":"x-amz-lex-message" + }, + "messageFormat":{ + "shape":"MessageFormatType", + "documentation":"

The format of the response message. One of the following values:

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

", + "location":"header", + "locationName":"x-amz-lex-message-format" + }, + "dialogState":{ + "shape":"DialogState", + "documentation":"

Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

  • ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:

    For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.

  • ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response.

    For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple \"yes\" or \"no\" response, a user might respond with additional information. For example, \"yes, but make it a thick crust pizza\" or \"no, I want to order a drink.\" Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).

  • ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

    For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately.

  • Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the request.

  • Failed - Conveys that the conversation with the user failed.

    This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.

", + "location":"header", + "locationName":"x-amz-lex-dialog-state" + }, + "slotToElicit":{ + "shape":"String", + "documentation":"

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

", + "location":"header", + "locationName":"x-amz-lex-slot-to-elicit" + }, + "inputTranscript":{ + "shape":"String", + "documentation":"

The text used to process the request.

If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.

", + "location":"header", + "locationName":"x-amz-lex-input-transcript" + }, + "audioStream":{ + "shape":"BlobStream", + "documentation":"

The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.

" + } + }, + "payload":"audioStream" + }, + "PostTextRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId", + "inputText" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

The alias of the Amazon Lex bot.

", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.

To decide the user ID to use for your application, consider the following factors.

  • The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.

  • If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.

  • If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.

  • A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.

", + "location":"uri", + "locationName":"userId" + }, + "sessionAttributes":{ + "shape":"StringMap", + "documentation":"

Application-specific information passed between Amazon Lex and a client application.

For more information, see Setting Session Attributes.

" + }, + "requestAttributes":{ + "shape":"StringMap", + "documentation":"

Request-specific information passed between Amazon Lex and a client application.

The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.

For more information, see Setting Request Attributes.

" + }, + "inputText":{ + "shape":"Text", + "documentation":"

The text that the user entered (Amazon Lex interprets this text).

" + } + } + }, + "PostTextResponse":{ + "type":"structure", + "members":{ + "intentName":{ + "shape":"IntentName", + "documentation":"

The current user intent that Amazon Lex is aware of.

" + }, + "slots":{ + "shape":"StringMap", + "documentation":"

The intent slots that Amazon Lex detected from the user input in the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.

" + }, + "sessionAttributes":{ + "shape":"StringMap", + "documentation":"

A map of key-value pairs representing the session-specific context information.

" + }, + "message":{ + "shape":"Text", + "documentation":"

The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.

If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.

When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.

If the Lambda function returns a message, Amazon Lex passes it to the client in its response.

" + }, + "messageFormat":{ + "shape":"MessageFormatType", + "documentation":"

The format of the response message. One of the following values:

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format defined by the Lambda function.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

" + }, + "dialogState":{ + "shape":"DialogState", + "documentation":"

Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.

  • ElicitIntent - Amazon Lex wants to elicit user intent.

    For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.

  • ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response.

    For example, Amazon Lex wants user confirmation before fulfilling an intent.

    Instead of a simple \"yes\" or \"no,\" a user might respond with additional information. For example, \"yes, but make it thick crust pizza\" or \"no, I want to order a drink\". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).

  • ElicitSlot - Amazon Lex is expecting a slot value for the current intent.

    For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately.

  • Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

  • Failed - Conveys that the conversation with the user failed.

    This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.

" + }, + "slotToElicit":{ + "shape":"String", + "documentation":"

If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

" + }, + "responseCard":{ + "shape":"ResponseCard", + "documentation":"

Represents the options that the user has to respond to the current prompt. Response Card can come from the bot configuration (in the Amazon Lex console, choose the settings button next to a slot) or from a code hook (Lambda function).

" + } + } + }, + "PutSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "documentation":"

The name of the bot that contains the session data.

", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "documentation":"

The alias in use for the bot that contains the session data.

", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.

", + "location":"uri", + "locationName":"userId" + }, + "sessionAttributes":{ + "shape":"StringMap", + "documentation":"

Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.

" + }, + "dialogAction":{ + "shape":"DialogAction", + "documentation":"

Sets the next action that the bot should take to fulfill the conversation.

" + }, + "recentIntentSummaryView":{ + "shape":"IntentSummaryList", + "documentation":"

A summary of the recent intents for the bot. You can use the intent summary view to set a checkpoint label on an intent and modify attributes of intents. You can also use it to remove or add intent summary objects to the list.

An intent that you modify or add to the list must make sense for the bot. For example, the intent name must be valid for the bot. You must provide valid values for:

  • intentName

  • slot names

  • slotToElict

If you send the recentIntentSummaryView parameter in a PutSession request, the contents of the new summary view replaces the old summary view. For example, if a GetSession request returns three intents in the summary view and you call PutSession with one intent in the summary view, the next call to GetSession will only return one intent.

" + }, + "accept":{ + "shape":"Accept", + "documentation":"

The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.

  • If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.

  • If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.

  • If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.

  • The following are the accepted values:

    • audio/mpeg

    • audio/ogg

    • audio/pcm

    • audio/* (defaults to mpeg)

    • text/plain; charset=utf-8

", + "location":"header", + "locationName":"Accept" + } + } + }, + "PutSessionResponse":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"HttpContentType", + "documentation":"

Content type as specified in the Accept HTTP header in the request.

", + "location":"header", + "locationName":"Content-Type" + }, + "intentName":{ + "shape":"IntentName", + "documentation":"

The name of the current intent.

", + "location":"header", + "locationName":"x-amz-lex-intent-name" + }, + "slots":{ + "shape":"String", + "documentation":"

Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.

Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-slots" + }, + "sessionAttributes":{ + "shape":"String", + "documentation":"

Map of key/value pairs representing session-specific context information.

", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-session-attributes" + }, + "message":{ + "shape":"Text", + "documentation":"

The next message that should be presented to the user.

", + "location":"header", + "locationName":"x-amz-lex-message" + }, + "messageFormat":{ + "shape":"MessageFormatType", + "documentation":"

The format of the response message. One of the following values:

  • PlainText - The message contains plain UTF-8 text.

  • CustomPayload - The message is a custom format for the client.

  • SSML - The message contains text formatted for voice output.

  • Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.

", + "location":"header", + "locationName":"x-amz-lex-message-format" + }, + "dialogState":{ + "shape":"DialogState", + "documentation":"

  • ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response to confirm the intent before fulfilling an intent.

  • ElicitIntent - Amazon Lex wants to elicit the user's intent.

  • ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.

  • Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.

  • Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.

  • ReadyForFulfillment - Conveys that the client has to fulfill the intent.

", + "location":"header", + "locationName":"x-amz-lex-dialog-state" + }, + "slotToElicit":{ + "shape":"String", + "documentation":"

If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.

", + "location":"header", + "locationName":"x-amz-lex-slot-to-elicit" + }, + "audioStream":{ + "shape":"BlobStream", + "documentation":"

The audio version of the message to convey to the user.

" + }, + "sessionId":{ + "shape":"String", + "documentation":"

A unique identifier for the session.

", + "location":"header", + "locationName":"x-amz-lex-session-id" + } + }, + "payload":"audioStream" + }, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The input speech is too long.

", + "error":{"httpStatusCode":408}, + "exception":true + }, + "ResponseCard":{ + "type":"structure", + "members":{ + "version":{ + "shape":"String", + "documentation":"

The version of the response card format.

" + }, + "contentType":{ + "shape":"ContentType", + "documentation":"

The content type of the response.

" + }, + "genericAttachments":{ + "shape":"genericAttachmentList", + "documentation":"

An array of attachment objects representing options.

" + } + }, + "documentation":"

If you configure a response card when creating your bots, Amazon Lex substitutes the session attributes and slot values that are available, and then returns it. The response card can also come from a Lambda function ( dialogCodeHook and fulfillmentActivity on an intent).

" + }, + "String":{"type":"string"}, + "StringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"}, + "sensitive":true + }, + "StringUrlWithLength":{ + "type":"string", + "max":2048, + "min":1 + }, + "StringWithLength":{ + "type":"string", + "max":80, + "min":1 + }, + "Text":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "UnsupportedMediaTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

The Content-Type header (PostContent API) has an invalid value.

", + "error":{"httpStatusCode":415}, + "exception":true + }, + "UserId":{ + "type":"string", + "max":100, + "min":2, + "pattern":"[0-9a-zA-Z._:-]+" + }, + "genericAttachmentList":{ + "type":"list", + "member":{"shape":"GenericAttachment"}, + "max":10, + "min":0 + }, + "listOfButtons":{ + "type":"list", + "member":{"shape":"Button"}, + "max":5, + "min":0 + } + }, + "documentation":"

Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says \"I want pizza\", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .

" +} diff --git a/aws/dist/botocore/data/license-manager/2018-08-01/paginators-1.json b/aws/dist/botocore/data/license-manager/2018-08-01/paginators-1.json new file mode 100644 index 00000000..03a3ca4d --- /dev/null +++ b/aws/dist/botocore/data/license-manager/2018-08-01/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListAssociationsForLicenseConfiguration": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LicenseConfigurationAssociations" + }, + "ListLicenseConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LicenseConfigurations" + }, + "ListLicenseSpecificationsForResource": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LicenseSpecifications" + }, + "ListResourceInventory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ResourceInventoryList" + }, + "ListUsageForLicenseConfiguration": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LicenseConfigurationUsageList" + } + } +} diff --git a/aws/dist/botocore/data/license-manager/2018-08-01/service-2.json b/aws/dist/botocore/data/license-manager/2018-08-01/service-2.json new file mode 100644 index 00000000..ec74e61a --- /dev/null +++ b/aws/dist/botocore/data/license-manager/2018-08-01/service-2.json @@ -0,0 +1,1168 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-08-01", + "endpointPrefix":"license-manager", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS License Manager", + "serviceId":"License Manager", + "signatureVersion":"v4", + "targetPrefix":"AWSLicenseManager", + "uid":"license-manager-2018-08-01" + }, + "operations":{ + "CreateLicenseConfiguration":{ + "name":"CreateLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLicenseConfigurationRequest"}, + "output":{"shape":"CreateLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Creates a new license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used.

" + }, + "DeleteLicenseConfiguration":{ + "name":"DeleteLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLicenseConfigurationRequest"}, + "output":{"shape":"DeleteLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Deletes an existing license configuration. This action fails if the configuration is in use.

" + }, + "GetLicenseConfiguration":{ + "name":"GetLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLicenseConfigurationRequest"}, + "output":{"shape":"GetLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Returns a detailed description of a license configuration.

" + }, + "GetServiceSettings":{ + "name":"GetServiceSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceSettingsRequest"}, + "output":{"shape":"GetServiceSettingsResponse"}, + "errors":[ + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Gets License Manager settings for a region. Exposes the configured S3 bucket, SNS topic, etc., for inspection.

" + }, + "ListAssociationsForLicenseConfiguration":{ + "name":"ListAssociationsForLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociationsForLicenseConfigurationRequest"}, + "output":{"shape":"ListAssociationsForLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"FilterLimitExceededException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Lists the resource associations for a license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance may not consume a license (depending on the license rules). Use this operation to find all resources associated with a license configuration.

" + }, + "ListLicenseConfigurations":{ + "name":"ListLicenseConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLicenseConfigurationsRequest"}, + "output":{"shape":"ListLicenseConfigurationsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"FilterLimitExceededException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Lists license configuration objects for an account, each containing the name, description, license type, and other license terms modeled from a license agreement.

" + }, + "ListLicenseSpecificationsForResource":{ + "name":"ListLicenseSpecificationsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLicenseSpecificationsForResourceRequest"}, + "output":{"shape":"ListLicenseSpecificationsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Returns the license configuration for a resource.

" + }, + "ListResourceInventory":{ + "name":"ListResourceInventory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceInventoryRequest"}, + "output":{"shape":"ListResourceInventoryResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"FilterLimitExceededException"}, + {"shape":"FailedDependencyException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Returns a detailed list of resources.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Lists tags attached to a resource.

" + }, + "ListUsageForLicenseConfiguration":{ + "name":"ListUsageForLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsageForLicenseConfigurationRequest"}, + "output":{"shape":"ListUsageForLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"FilterLimitExceededException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Attach one of more tags to any resource.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Remove tags from a resource.

" + }, + "UpdateLicenseConfiguration":{ + "name":"UpdateLicenseConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLicenseConfigurationRequest"}, + "output":{"shape":"UpdateLicenseConfigurationResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Modifies the attributes of an existing license configuration object. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (Instances, cores, sockets, VCPUs), tenancy (shared or Dedicated Host), host affinity (how long a VM is associated with a host), the number of licenses purchased and used.

" + }, + "UpdateLicenseSpecificationsForResource":{ + "name":"UpdateLicenseSpecificationsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLicenseSpecificationsForResourceRequest"}, + "output":{"shape":"UpdateLicenseSpecificationsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"LicenseUsageException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Adds or removes license configurations for a specified AWS resource. This operation currently supports updating the license specifications of AMIs, instances, and hosts. Launch templates and AWS CloudFormation templates are not managed from this operation as those resources send the license configurations directly to a resource creation operation, such as RunInstances.

" + }, + "UpdateServiceSettings":{ + "name":"UpdateServiceSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceSettingsRequest"}, + "output":{"shape":"UpdateServiceSettingsResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"ServerInternalException"}, + {"shape":"AuthorizationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"RateLimitExceededException"} + ], + "documentation":"

Updates License Manager service settings.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

Access to resource denied.

", + "exception":true + }, + "AuthorizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

The AWS user account does not have permission to perform the action. Check the IAM policy associated with this account.

", + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BoxBoolean":{"type":"boolean"}, + "BoxInteger":{"type":"integer"}, + "BoxLong":{"type":"long"}, + "ConsumedLicenseSummary":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Resource type of the resource consuming a license (instance, host, or AMI).

" + }, + "ConsumedLicenses":{ + "shape":"BoxLong", + "documentation":"

Number of licenses consumed by a resource.

" + } + }, + "documentation":"

Details about license consumption.

" + }, + "ConsumedLicenseSummaryList":{ + "type":"list", + "member":{"shape":"ConsumedLicenseSummary"} + }, + "CreateLicenseConfigurationRequest":{ + "type":"structure", + "required":[ + "Name", + "LicenseCountingType" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

Name of the license configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Human-friendly description of the license configuration.

" + }, + "LicenseCountingType":{ + "shape":"LicenseCountingType", + "documentation":"

Dimension to use to track the license inventory.

" + }, + "LicenseCount":{ + "shape":"BoxLong", + "documentation":"

Number of licenses managed by the license configuration.

" + }, + "LicenseCountHardLimit":{ + "shape":"BoxBoolean", + "documentation":"

Flag indicating whether hard or soft license enforcement is used. Exceeding a hard limit results in the blocked deployment of new instances.

" + }, + "LicenseRules":{ + "shape":"StringList", + "documentation":"

Array of configured License Manager rules.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags .

" + } + } + }, + "CreateLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the license configuration object after its creation.

" + } + } + }, + "DateTime":{"type":"timestamp"}, + "DeleteLicenseConfigurationRequest":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

Unique ID of the configuration object to delete.

" + } + } + }, + "DeleteLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "FailedDependencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

A dependency required to run the API is missing.

", + "exception":true, + "fault":true + }, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

Name of the filter. Filter names are case-sensitive.

" + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

One or more filter values. Filter values are case-sensitive.

" + } + }, + "documentation":"

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs. The filters supported by a Describe operation are documented with the Describe operation.

" + }, + "FilterLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

The request uses too many filters or too many filter values.

", + "exception":true + }, + "FilterName":{"type":"string"}, + "FilterValue":{"type":"string"}, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"} + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetLicenseConfigurationRequest":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the license configuration being requested.

" + } + } + }, + "GetLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + "LicenseConfigurationId":{ + "shape":"String", + "documentation":"

Unique ID for the license configuration.

" + }, + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the license configuration requested.

" + }, + "Name":{ + "shape":"String", + "documentation":"

Name of the license configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Description of the license configuration.

" + }, + "LicenseCountingType":{ + "shape":"LicenseCountingType", + "documentation":"

Dimension on which the licenses are counted (for example, instances, cores, sockets, or VCPUs).

" + }, + "LicenseRules":{ + "shape":"StringList", + "documentation":"

List of flexible text strings designating license rules.

" + }, + "LicenseCount":{ + "shape":"BoxLong", + "documentation":"

Number of available licenses.

" + }, + "LicenseCountHardLimit":{ + "shape":"BoxBoolean", + "documentation":"

Sets the number of available licenses as a hard limit.

" + }, + "ConsumedLicenses":{ + "shape":"BoxLong", + "documentation":"

Number of licenses assigned to resources.

" + }, + "Status":{ + "shape":"String", + "documentation":"

License configuration status (active, etc.).

" + }, + "OwnerAccountId":{ + "shape":"String", + "documentation":"

Owner account ID for the license configuration.

" + }, + "ConsumedLicenseSummaryList":{ + "shape":"ConsumedLicenseSummaryList", + "documentation":"

List of summaries for consumed licenses used by various resources.

" + }, + "ManagedResourceSummaryList":{ + "shape":"ManagedResourceSummaryList", + "documentation":"

List of summaries of managed resources.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

List of tags attached to the license configuration.

" + } + } + }, + "GetServiceSettingsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetServiceSettingsResponse":{ + "type":"structure", + "members":{ + "S3BucketArn":{ + "shape":"String", + "documentation":"

Regional S3 bucket path for storing reports, license trail event data, discovery data, etc.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

SNS topic configured to receive notifications from License Manager.

" + }, + "OrganizationConfiguration":{ + "shape":"OrganizationConfiguration", + "documentation":"

Indicates whether AWS Organizations has been integrated with License Manager for cross-account discovery.

" + }, + "EnableCrossAccountsDiscovery":{ + "shape":"BoxBoolean", + "documentation":"

Indicates whether cross-account discovery has been enabled.

" + } + } + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

One or more parameter values are not valid.

", + "exception":true, + "synthetic":true + }, + "InvalidResourceStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

License Manager cannot allocate a license to a resource because of its state.

For example, you cannot allocate a license to an instance in the process of shutting down.

", + "exception":true + }, + "InventoryFilter":{ + "type":"structure", + "required":[ + "Name", + "Condition" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the filter.

" + }, + "Condition":{ + "shape":"InventoryFilterCondition", + "documentation":"

The condition of the filter.

" + }, + "Value":{ + "shape":"String", + "documentation":"

Value of the filter.

" + } + }, + "documentation":"

An inventory filter object.

" + }, + "InventoryFilterCondition":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "BEGINS_WITH", + "CONTAINS" + ] + }, + "InventoryFilterList":{ + "type":"list", + "member":{"shape":"InventoryFilter"} + }, + "LicenseConfiguration":{ + "type":"structure", + "members":{ + "LicenseConfigurationId":{ + "shape":"String", + "documentation":"

Unique ID of the LicenseConfiguration object.

" + }, + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the LicenseConfiguration object.

" + }, + "Name":{ + "shape":"String", + "documentation":"

Name of the license configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Description of the license configuration.

" + }, + "LicenseCountingType":{ + "shape":"LicenseCountingType", + "documentation":"

Dimension to use to track license inventory.

" + }, + "LicenseRules":{ + "shape":"StringList", + "documentation":"

Array of configured License Manager rules.

" + }, + "LicenseCount":{ + "shape":"BoxLong", + "documentation":"

Number of licenses managed by the license configuration.

" + }, + "LicenseCountHardLimit":{ + "shape":"BoxBoolean", + "documentation":"

Sets the number of available licenses as a hard limit.

" + }, + "ConsumedLicenses":{ + "shape":"BoxLong", + "documentation":"

Number of licenses consumed.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Status of the license configuration.

" + }, + "OwnerAccountId":{ + "shape":"String", + "documentation":"

Account ID of the license configuration's owner.

" + }, + "ConsumedLicenseSummaryList":{ + "shape":"ConsumedLicenseSummaryList", + "documentation":"

List of summaries for licenses consumed by various resources.

" + }, + "ManagedResourceSummaryList":{ + "shape":"ManagedResourceSummaryList", + "documentation":"

List of summaries for managed resources.

" + } + }, + "documentation":"

A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or VCPU), tenancy (shared tenancy, Amazon EC2 Dedicated Instance, Amazon EC2 Dedicated Host, or any of these), host affinity (how long a VM must be associated with a host), the number of licenses purchased and used.

" + }, + "LicenseConfigurationAssociation":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN of the resource associated with the license configuration.

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

Type of server resource.

" + }, + "ResourceOwnerId":{ + "shape":"String", + "documentation":"

ID of the AWS account that owns the resource consuming licenses.

" + }, + "AssociationTime":{ + "shape":"DateTime", + "documentation":"

Time when the license configuration was associated with the resource.

" + } + }, + "documentation":"

Describes a server resource that is associated with a license configuration.

" + }, + "LicenseConfigurationAssociations":{ + "type":"list", + "member":{"shape":"LicenseConfigurationAssociation"} + }, + "LicenseConfigurationStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "DISABLED" + ] + }, + "LicenseConfigurationUsage":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN of the resource associated with a license configuration.

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

Type of resource associated with athe license configuration.

" + }, + "ResourceStatus":{ + "shape":"String", + "documentation":"

Status of a resource associated with the license configuration.

" + }, + "ResourceOwnerId":{ + "shape":"String", + "documentation":"

ID of the account that owns a resource that is associated with the license configuration.

" + }, + "AssociationTime":{ + "shape":"DateTime", + "documentation":"

Time when the license configuration was initially associated with a resource.

" + }, + "ConsumedLicenses":{ + "shape":"BoxLong", + "documentation":"

Number of licenses consumed out of the total provisioned in the license configuration.

" + } + }, + "documentation":"

Contains details of the usage of each resource from the license pool.

" + }, + "LicenseConfigurationUsageList":{ + "type":"list", + "member":{"shape":"LicenseConfigurationUsage"} + }, + "LicenseConfigurations":{ + "type":"list", + "member":{"shape":"LicenseConfiguration"} + }, + "LicenseCountingType":{ + "type":"string", + "enum":[ + "vCPU", + "Instance", + "Core", + "Socket" + ] + }, + "LicenseSpecification":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the LicenseConfiguration object.

" + } + }, + "documentation":"

Object used for associating a license configuration with a resource.

" + }, + "LicenseSpecifications":{ + "type":"list", + "member":{"shape":"LicenseSpecification"} + }, + "LicenseUsageException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

You do not have enough licenses available to support a new resource launch.

", + "exception":true + }, + "ListAssociationsForLicenseConfigurationRequest":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of a LicenseConfiguration object.

" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"

Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListAssociationsForLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + "LicenseConfigurationAssociations":{ + "shape":"LicenseConfigurationAssociations", + "documentation":"

Lists association objects for the license configuration, each containing the association time, number of consumed licenses, resource ARN, resource ID, account ID that owns the resource, resource size, and resource type.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListLicenseConfigurationsRequest":{ + "type":"structure", + "members":{ + "LicenseConfigurationArns":{ + "shape":"StringList", + "documentation":"

An array of ARNs for the calling account’s license configurations.

" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"

Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

One or more filters.

" + } + } + }, + "ListLicenseConfigurationsResponse":{ + "type":"structure", + "members":{ + "LicenseConfigurations":{ + "shape":"LicenseConfigurations", + "documentation":"

Array of license configuration objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListLicenseSpecificationsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN of an AMI or Amazon EC2 instance that has an associated license configuration.

" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"

Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListLicenseSpecificationsForResourceResponse":{ + "type":"structure", + "members":{ + "LicenseSpecifications":{ + "shape":"LicenseSpecifications", + "documentation":"

License configurations associated with a resource.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListResourceInventoryRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"

Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + }, + "Filters":{ + "shape":"InventoryFilterList", + "documentation":"

One or more filters.

" + } + } + }, + "ListResourceInventoryResponse":{ + "type":"structure", + "members":{ + "ResourceInventoryList":{ + "shape":"ResourceInventoryList", + "documentation":"

The detailed list of resources.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN for the resource.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

List of tags attached to the resource.

" + } + } + }, + "ListUsageForLicenseConfigurationRequest":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN of the targeted LicenseConfiguration object.

" + }, + "MaxResults":{ + "shape":"BoxInteger", + "documentation":"

Maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + }, + "Filters":{ + "shape":"Filters", + "documentation":"

List of filters to apply.

" + } + } + }, + "ListUsageForLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + "LicenseConfigurationUsageList":{ + "shape":"LicenseConfigurationUsageList", + "documentation":"

An array of LicenseConfigurationUsage objects.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

Token for the next set of results.

" + } + } + }, + "ManagedResourceSummary":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Type of resource associated with a license (instance, host, or AMI).

" + }, + "AssociationCount":{ + "shape":"BoxLong", + "documentation":"

Number of resources associated with licenses.

" + } + }, + "documentation":"

Summary for a resource.

" + }, + "ManagedResourceSummaryList":{ + "type":"list", + "member":{"shape":"ManagedResourceSummary"} + }, + "Message":{"type":"string"}, + "OrganizationConfiguration":{ + "type":"structure", + "required":["EnableIntegration"], + "members":{ + "EnableIntegration":{ + "shape":"Boolean", + "documentation":"

Flag to activate AWS Organization integration.

" + } + }, + "documentation":"

Object containing configuration information for AWS Organizations.

" + }, + "RateLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

Too many requests have been submitted. Try again after a brief wait.

", + "exception":true + }, + "ResourceInventory":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

Unique ID of the resource.

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

The type of resource.

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

The ARN of the resource.

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The platform of the resource.

" + }, + "PlatformVersion":{ + "shape":"String", + "documentation":"

Platform version of the resource in the inventory.

" + }, + "ResourceOwningAccountId":{ + "shape":"String", + "documentation":"

Unique ID of the account that owns the resource.

" + } + }, + "documentation":"

A set of attributes that describe a resource.

" + }, + "ResourceInventoryList":{ + "type":"list", + "member":{"shape":"ResourceInventory"} + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

Your resource limits have been exceeded.

", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "EC2_INSTANCE", + "EC2_HOST", + "EC2_AMI" + ] + }, + "ServerInternalException":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

The server experienced an internal error. Try again.

", + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

Key for the resource tag.

" + }, + "Value":{ + "shape":"String", + "documentation":"

Value for the resource tag.

" + } + }, + "documentation":"

Tag for a resource in a key-value format.

" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

Resource of the ARN to be tagged.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

Names of the tags to attach to the resource.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN of the resource.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

List keys identifying tags to remove.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLicenseConfigurationRequest":{ + "type":"structure", + "required":["LicenseConfigurationArn"], + "members":{ + "LicenseConfigurationArn":{ + "shape":"String", + "documentation":"

ARN for a license configuration.

" + }, + "LicenseConfigurationStatus":{ + "shape":"LicenseConfigurationStatus", + "documentation":"

New status of the license configuration (ACTIVE or INACTIVE).

" + }, + "LicenseRules":{ + "shape":"StringList", + "documentation":"

List of flexible text strings designating license rules.

" + }, + "LicenseCount":{ + "shape":"BoxLong", + "documentation":"

New number of licenses managed by the license configuration.

" + }, + "LicenseCountHardLimit":{ + "shape":"BoxBoolean", + "documentation":"

Sets the number of available licenses as a hard limit.

" + }, + "Name":{ + "shape":"String", + "documentation":"

New name of the license configuration.

" + }, + "Description":{ + "shape":"String", + "documentation":"

New human-friendly description of the license configuration.

" + } + } + }, + "UpdateLicenseConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLicenseSpecificationsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

ARN for an AWS server resource.

" + }, + "AddLicenseSpecifications":{ + "shape":"LicenseSpecifications", + "documentation":"

License configuration ARNs to be added to a resource.

" + }, + "RemoveLicenseSpecifications":{ + "shape":"LicenseSpecifications", + "documentation":"

License configuration ARNs to be removed from a resource.

" + } + } + }, + "UpdateLicenseSpecificationsForResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateServiceSettingsRequest":{ + "type":"structure", + "members":{ + "S3BucketArn":{ + "shape":"String", + "documentation":"

ARN of the Amazon S3 bucket where License Manager information is stored.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

ARN of the Amazon SNS topic used for License Manager alerts.

" + }, + "OrganizationConfiguration":{ + "shape":"OrganizationConfiguration", + "documentation":"

Integrates AWS Organizations with License Manager for cross-account discovery.

" + }, + "EnableCrossAccountsDiscovery":{ + "shape":"BoxBoolean", + "documentation":"

Activates cross-account discovery.

" + } + } + }, + "UpdateServiceSettingsResponse":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":" AWS License Manager

This is the AWS License Manager API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for License Manager. The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

" +} diff --git a/aws/dist/botocore/data/lightsail/2016-11-28/examples-1.json b/aws/dist/botocore/data/lightsail/2016-11-28/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/lightsail/2016-11-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/lightsail/2016-11-28/paginators-1.json b/aws/dist/botocore/data/lightsail/2016-11-28/paginators-1.json new file mode 100644 index 00000000..fbea9383 --- /dev/null +++ b/aws/dist/botocore/data/lightsail/2016-11-28/paginators-1.json @@ -0,0 +1,104 @@ +{ + "pagination": { + "GetActiveNames": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "activeNames" + }, + "GetBlueprints": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "blueprints" + }, + "GetBundles": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "bundles" + }, + "GetDomains": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "domains" + }, + "GetInstanceSnapshots": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "instanceSnapshots" + }, + "GetInstances": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "instances" + }, + "GetKeyPairs": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "keyPairs" + }, + "GetOperations": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "operations" + }, + "GetStaticIps": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "staticIps" + }, + "GetCloudFormationStackRecords": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "cloudFormationStackRecords" + }, + "GetDiskSnapshots": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "diskSnapshots" + }, + "GetDisks": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "disks" + }, + "GetExportSnapshotRecords": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "exportSnapshotRecords" + }, + "GetLoadBalancers": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "loadBalancers" + }, + "GetRelationalDatabaseBlueprints": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "blueprints" + }, + "GetRelationalDatabaseBundles": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "bundles" + }, + "GetRelationalDatabaseEvents": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "relationalDatabaseEvents" + }, + "GetRelationalDatabaseParameters": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "parameters" + }, + "GetRelationalDatabaseSnapshots": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "relationalDatabaseSnapshots" + }, + "GetRelationalDatabases": { + "input_token": "pageToken", + "output_token": "nextPageToken", + "result_key": "relationalDatabases" + } + } +} diff --git a/aws/dist/botocore/data/lightsail/2016-11-28/service-2.json b/aws/dist/botocore/data/lightsail/2016-11-28/service-2.json new file mode 100644 index 00000000..b0fa5749 --- /dev/null +++ b/aws/dist/botocore/data/lightsail/2016-11-28/service-2.json @@ -0,0 +1,7487 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-28", + "endpointPrefix":"lightsail", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Lightsail", + "serviceId":"Lightsail", + "signatureVersion":"v4", + "targetPrefix":"Lightsail_20161128", + "uid":"lightsail-2016-11-28" + }, + "operations":{ + "AllocateStaticIp":{ + "name":"AllocateStaticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AllocateStaticIpRequest"}, + "output":{"shape":"AllocateStaticIpResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Allocates a static IP address.

" + }, + "AttachDisk":{ + "name":"AttachDisk", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachDiskRequest"}, + "output":{"shape":"AttachDiskResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

The attach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.

" + }, + "AttachInstancesToLoadBalancer":{ + "name":"AttachInstancesToLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachInstancesToLoadBalancerRequest"}, + "output":{"shape":"AttachInstancesToLoadBalancerResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Attaches one or more Lightsail instances to a load balancer.

After some time, the instances are attached to the load balancer and the health check status is available.

The attach instances to load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

" + }, + "AttachLoadBalancerTlsCertificate":{ + "name":"AttachLoadBalancerTlsCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachLoadBalancerTlsCertificateRequest"}, + "output":{"shape":"AttachLoadBalancerTlsCertificateResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the attach load balancer tls certificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

The attach load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

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

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

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

Closes the public ports on a specific Amazon Lightsail instance.

The close instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

" + }, + "CopySnapshot":{ + "name":"CopySnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopySnapshotRequest"}, + "output":{"shape":"CopySnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Copies a manual instance or disk snapshot as another manual snapshot, or copies an automatic instance or disk snapshot as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

Database snapshots cannot be copied at this time.

" + }, + "CreateCloudFormationStack":{ + "name":"CreateCloudFormationStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCloudFormationStackRequest"}, + "output":{"shape":"CreateCloudFormationStackResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the get cloud formation stack records operation to get a list of the CloudFormation stacks created.

Wait until after your new Amazon EC2 instance is created before running the create cloud formation stack operation again with the same export snapshot record.

" + }, + "CreateDisk":{ + "name":"CreateDisk", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDiskRequest"}, + "output":{"shape":"CreateDiskResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

" + }, + "CreateDiskFromSnapshot":{ + "name":"CreateDiskFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDiskFromSnapshotRequest"}, + "output":{"shape":"CreateDiskFromSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (e.g., us-east-2a).

The create disk from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.

" + }, + "CreateDiskSnapshot":{ + "name":"CreateDiskSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDiskSnapshotRequest"}, + "output":{"shape":"CreateDiskSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the instance name parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.

The create disk snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

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

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

The create domain operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

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

Creates one of the following entry records associated with the domain: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The create domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.

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

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

The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

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

Creates one or more Amazon Lightsail instances.

The create instances operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

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

Creates one or more new instances from a manual or automatic snapshot of an instance.

The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.

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

Creates an SSH key pair.

The create key pair operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

" + }, + "CreateLoadBalancer":{ + "name":"CreateLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerRequest"}, + "output":{"shape":"CreateLoadBalancerResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account.

When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation.

The create load balancer operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

" + }, + "CreateLoadBalancerTlsCertificate":{ + "name":"CreateLoadBalancerTlsCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLoadBalancerTlsCertificateRequest"}, + "output":{"shape":"CreateLoadBalancerTlsCertificateResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a Lightsail load balancer TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

The create load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

" + }, + "CreateRelationalDatabase":{ + "name":"CreateRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRelationalDatabaseRequest"}, + "output":{"shape":"CreateRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a new database in Amazon Lightsail.

The create relational database operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

" + }, + "CreateRelationalDatabaseFromSnapshot":{ + "name":"CreateRelationalDatabaseFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRelationalDatabaseFromSnapshotRequest"}, + "output":{"shape":"CreateRelationalDatabaseFromSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a new database from an existing database snapshot in Amazon Lightsail.

You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a different plan, such as a high availability or standard plan.

The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identified by relationalDatabaseSnapshotName. For more information, see the Lightsail Dev Guide.

" + }, + "CreateRelationalDatabaseSnapshot":{ + "name":"CreateRelationalDatabaseSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRelationalDatabaseSnapshotRequest"}, + "output":{"shape":"CreateRelationalDatabaseSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database.

The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteAutoSnapshot":{ + "name":"DeleteAutoSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAutoSnapshotRequest"}, + "output":{"shape":"DeleteAutoSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes an automatic snapshot for an instance or disk.

" + }, + "DeleteDisk":{ + "name":"DeleteDisk", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDiskRequest"}, + "output":{"shape":"DeleteDiskResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

The delete disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteDiskSnapshot":{ + "name":"DeleteDiskSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDiskSnapshotRequest"}, + "output":{"shape":"DeleteDiskSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes the specified disk snapshot.

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identified by disk snapshot name. For more information, see the Lightsail Dev Guide.

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

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

The delete domain operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.

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

Deletes a specific domain entry.

The delete domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.

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

Deletes an Amazon Lightsail instance.

The delete instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

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

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

The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identified by instance snapshot name. For more information, see the Lightsail Dev Guide.

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

Deletes a specific SSH key pair.

The delete key pair operation supports tag-based access control via resource tags applied to the resource identified by key pair name. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteKnownHostKeys":{ + "name":"DeleteKnownHostKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteKnownHostKeysRequest"}, + "output":{"shape":"DeleteKnownHostKeysResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes the known host key or certificate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch.

Perform this operation only if you were expecting the host key or certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client.

" + }, + "DeleteLoadBalancer":{ + "name":"DeleteLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoadBalancerRequest"}, + "output":{"shape":"DeleteLoadBalancerResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

The delete load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteLoadBalancerTlsCertificate":{ + "name":"DeleteLoadBalancerTlsCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoadBalancerTlsCertificateRequest"}, + "output":{"shape":"DeleteLoadBalancerTlsCertificateResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes an SSL/TLS certificate associated with a Lightsail load balancer.

The delete load balancer tls certificate operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteRelationalDatabase":{ + "name":"DeleteRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRelationalDatabaseRequest"}, + "output":{"shape":"DeleteRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes a database in Amazon Lightsail.

The delete relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

" + }, + "DeleteRelationalDatabaseSnapshot":{ + "name":"DeleteRelationalDatabaseSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRelationalDatabaseSnapshotRequest"}, + "output":{"shape":"DeleteRelationalDatabaseSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes a database snapshot in Amazon Lightsail.

The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

" + }, + "DetachDisk":{ + "name":"DetachDisk", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachDiskRequest"}, + "output":{"shape":"DetachDiskResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.

The detach disk operation supports tag-based access control via resource tags applied to the resource identified by disk name. For more information, see the Lightsail Dev Guide.

" + }, + "DetachInstancesFromLoadBalancer":{ + "name":"DetachInstancesFromLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachInstancesFromLoadBalancerRequest"}, + "output":{"shape":"DetachInstancesFromLoadBalancerResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Detaches the specified instances from a Lightsail load balancer.

This operation waits until the instances are no longer needed before they are detached from the load balancer.

The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

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

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

" + }, + "DisableAddOn":{ + "name":"DisableAddOn", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableAddOnRequest"}, + "output":{"shape":"DisableAddOnResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Disables an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

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

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

" + }, + "EnableAddOn":{ + "name":"EnableAddOn", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAddOnRequest"}, + "output":{"shape":"EnableAddOnResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the Lightsail Dev Guide.

" + }, + "ExportSnapshot":{ + "name":"ExportSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportSnapshotRequest"}, + "output":{"shape":"ExportSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances.

Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot.

The export snapshot operation supports tag-based access control via resource tags applied to the resource identified by source snapshot name. For more information, see the Lightsail Dev Guide.

Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2.

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

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

" + }, + "GetAutoSnapshots":{ + "name":"GetAutoSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAutoSnapshotsRequest"}, + "output":{"shape":"GetAutoSnapshotsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the available automatic snapshots for the specified resource name. For more information, see the Lightsail Dev Guide.

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

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

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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

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

" + }, + "GetCloudFormationStackRecords":{ + "name":"GetCloudFormationStackRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCloudFormationStackRecordsRequest"}, + "output":{"shape":"GetCloudFormationStackRecordsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the CloudFormation stack record created as a result of the create cloud formation stack operation.

An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot.

" + }, + "GetDisk":{ + "name":"GetDisk", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDiskRequest"}, + "output":{"shape":"GetDiskResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about a specific block storage disk.

" + }, + "GetDiskSnapshot":{ + "name":"GetDiskSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDiskSnapshotRequest"}, + "output":{"shape":"GetDiskSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about a specific block storage disk snapshot.

" + }, + "GetDiskSnapshots":{ + "name":"GetDiskSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDiskSnapshotsRequest"}, + "output":{"shape":"GetDiskSnapshotsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about all block storage disk snapshots in your AWS account and region.

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

" + }, + "GetDisks":{ + "name":"GetDisks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDisksRequest"}, + "output":{"shape":"GetDisksResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about all block storage disks in your AWS account and region.

If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

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

Returns information about a specific domain recordset.

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

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

" + }, + "GetExportSnapshotRecords":{ + "name":"GetExportSnapshotRecords", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetExportSnapshotRecordsRequest"}, + "output":{"shape":"GetExportSnapshotRecordsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the export snapshot record created as a result of the export snapshot operation.

An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the create cloud formation stack operation.

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

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

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

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

The get instance access details operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

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

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

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

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

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

Returns information about a specific instance snapshot.

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

Returns all instance snapshots for the user's account.

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

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

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

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

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

Returns information about a specific key pair.

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

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

" + }, + "GetLoadBalancer":{ + "name":"GetLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoadBalancerRequest"}, + "output":{"shape":"GetLoadBalancerResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about the specified Lightsail load balancer.

" + }, + "GetLoadBalancerMetricData":{ + "name":"GetLoadBalancerMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoadBalancerMetricDataRequest"}, + "output":{"shape":"GetLoadBalancerMetricDataResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about health metrics for your Lightsail load balancer.

" + }, + "GetLoadBalancerTlsCertificates":{ + "name":"GetLoadBalancerTlsCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoadBalancerTlsCertificatesRequest"}, + "output":{"shape":"GetLoadBalancerTlsCertificatesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

You can have a maximum of 2 certificates associated with a Lightsail load balancer. One is active and the other is inactive.

" + }, + "GetLoadBalancers":{ + "name":"GetLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoadBalancersRequest"}, + "output":{"shape":"GetLoadBalancersResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about all load balancers in an account.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

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

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

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

Returns information about all operations.

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

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

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

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

Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region.

" + }, + "GetRelationalDatabase":{ + "name":"GetRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseRequest"}, + "output":{"shape":"GetRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about a specific database in Amazon Lightsail.

" + }, + "GetRelationalDatabaseBlueprints":{ + "name":"GetRelationalDatabaseBlueprints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseBlueprintsRequest"}, + "output":{"shape":"GetRelationalDatabaseBlueprintsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database.

You can use a blueprint ID to create a new database that runs a specific database engine.

" + }, + "GetRelationalDatabaseBundles":{ + "name":"GetRelationalDatabaseBundles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseBundlesRequest"}, + "output":{"shape":"GetRelationalDatabaseBundlesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.

You can use a bundle ID to create a new database with explicit performance specifications.

" + }, + "GetRelationalDatabaseEvents":{ + "name":"GetRelationalDatabaseEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseEventsRequest"}, + "output":{"shape":"GetRelationalDatabaseEventsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns a list of events for a specific database in Amazon Lightsail.

" + }, + "GetRelationalDatabaseLogEvents":{ + "name":"GetRelationalDatabaseLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseLogEventsRequest"}, + "output":{"shape":"GetRelationalDatabaseLogEventsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns a list of log events for a database in Amazon Lightsail.

" + }, + "GetRelationalDatabaseLogStreams":{ + "name":"GetRelationalDatabaseLogStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseLogStreamsRequest"}, + "output":{"shape":"GetRelationalDatabaseLogStreamsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns a list of available log streams for a specific database in Amazon Lightsail.

" + }, + "GetRelationalDatabaseMasterUserPassword":{ + "name":"GetRelationalDatabaseMasterUserPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseMasterUserPasswordRequest"}, + "output":{"shape":"GetRelationalDatabaseMasterUserPasswordResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the current, previous, or pending versions of the master user password for a Lightsail database.

The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName.

" + }, + "GetRelationalDatabaseMetricData":{ + "name":"GetRelationalDatabaseMetricData", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseMetricDataRequest"}, + "output":{"shape":"GetRelationalDatabaseMetricDataResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns the data points of the specified metric for a database in Amazon Lightsail.

" + }, + "GetRelationalDatabaseParameters":{ + "name":"GetRelationalDatabaseParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseParametersRequest"}, + "output":{"shape":"GetRelationalDatabaseParametersResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific database in Amazon Lightsail.

In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modifiable, the allowed values, and the data types.

" + }, + "GetRelationalDatabaseSnapshot":{ + "name":"GetRelationalDatabaseSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseSnapshotRequest"}, + "output":{"shape":"GetRelationalDatabaseSnapshotResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about a specific database snapshot in Amazon Lightsail.

" + }, + "GetRelationalDatabaseSnapshots":{ + "name":"GetRelationalDatabaseSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabaseSnapshotsRequest"}, + "output":{"shape":"GetRelationalDatabaseSnapshotsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about all of your database snapshots in Amazon Lightsail.

" + }, + "GetRelationalDatabases":{ + "name":"GetRelationalDatabases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRelationalDatabasesRequest"}, + "output":{"shape":"GetRelationalDatabasesResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Returns information about all of your databases in Amazon Lightsail.

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

Returns information about a specific static IP.

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

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

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

Imports a public SSH key from a specific key pair.

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

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

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

Adds public ports to an Amazon Lightsail instance.

The open instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

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

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

" + }, + "PutInstancePublicPorts":{ + "name":"PutInstancePublicPorts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutInstancePublicPortsRequest"}, + "output":{"shape":"PutInstancePublicPortsResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.

The put instance public ports operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

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

Restarts a specific instance.

The reboot instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

" + }, + "RebootRelationalDatabase":{ + "name":"RebootRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootRelationalDatabaseRequest"}, + "output":{"shape":"RebootRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Restarts a specific database in Amazon Lightsail.

The reboot relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

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

Deletes a specific static IP from your account.

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

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

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.

The start instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

" + }, + "StartRelationalDatabase":{ + "name":"StartRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartRelationalDatabaseRequest"}, + "output":{"shape":"StartRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Starts a specific database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation.

The start relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

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

Stops a specific Amazon Lightsail instance that is currently running.

When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Lightsail Dev Guide.

The stop instance operation supports tag-based access control via resource tags applied to the resource identified by instance name. For more information, see the Lightsail Dev Guide.

" + }, + "StopRelationalDatabase":{ + "name":"StopRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopRelationalDatabaseRequest"}, + "output":{"shape":"StopRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Stops a specific database that is currently running in Amazon Lightsail.

The stop relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the Lightsail Dev Guide.

The tag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.

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

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

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.

The untag resource operation supports tag-based access control via request tags and resource tags applied to the resource identified by resource name. For more information, see the Lightsail Dev Guide.

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

Updates a domain recordset after it is created.

The update domain entry operation supports tag-based access control via resource tags applied to the resource identified by domain name. For more information, see the Lightsail Dev Guide.

" + }, + "UpdateLoadBalancerAttribute":{ + "name":"UpdateLoadBalancerAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLoadBalancerAttributeRequest"}, + "output":{"shape":"UpdateLoadBalancerAttributeResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Updates the specified attribute for a load balancer. You can only update one attribute at a time.

The update load balancer attribute operation supports tag-based access control via resource tags applied to the resource identified by load balancer name. For more information, see the Lightsail Dev Guide.

" + }, + "UpdateRelationalDatabase":{ + "name":"UpdateRelationalDatabase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRelationalDatabaseRequest"}, + "output":{"shape":"UpdateRelationalDatabaseResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Allows the update of one or more attributes of a database in Amazon Lightsail.

Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.

The update relational database operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

" + }, + "UpdateRelationalDatabaseParameters":{ + "name":"UpdateRelationalDatabaseParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRelationalDatabaseParametersRequest"}, + "output":{"shape":"UpdateRelationalDatabaseParametersResult"}, + "errors":[ + {"shape":"ServiceException"}, + {"shape":"InvalidInputException"}, + {"shape":"NotFoundException"}, + {"shape":"OperationFailureException"}, + {"shape":"AccessDeniedException"}, + {"shape":"AccountSetupInProgressException"}, + {"shape":"UnauthenticatedException"} + ], + "documentation":"

Allows the update of one or more parameters of a database in Amazon Lightsail.

Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which paramater updates are applied: dynamic or pending-reboot. Parameters marked with a dynamic apply type are applied immediately. Parameters marked with a pending-reboot apply type are applied only after the database is rebooted using the reboot relational database operation.

The update relational database parameters operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the Lightsail Dev Guide.

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

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

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

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

", + "exception":true + }, + "AddOn":{ + "type":"structure", + "members":{ + "name":{ + "shape":"string", + "documentation":"

The name of the add-on.

" + }, + "status":{ + "shape":"string", + "documentation":"

The status of the add-on.

" + }, + "snapshotTimeOfDay":{ + "shape":"TimeOfDay", + "documentation":"

The daily time when an automatic snapshot is created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

" + }, + "nextSnapshotTimeOfDay":{ + "shape":"TimeOfDay", + "documentation":"

The next daily time an automatic snapshot will be created.

The time shown is in HH:00 format, and in Coordinated Universal Time (UTC).

The snapshot is automatically created between the time shown and up to 45 minutes after.

" + } + }, + "documentation":"

Describes an add-on that is enabled for an Amazon Lightsail resource.

" + }, + "AddOnList":{ + "type":"list", + "member":{"shape":"AddOn"} + }, + "AddOnRequest":{ + "type":"structure", + "required":["addOnType"], + "members":{ + "addOnType":{ + "shape":"AddOnType", + "documentation":"

The add-on type.

" + }, + "autoSnapshotAddOnRequest":{ + "shape":"AutoSnapshotAddOnRequest", + "documentation":"

An object that represents additional parameters when enabling or modifying the automatic snapshot add-on.

" + } + }, + "documentation":"

Describes a request to enable, modify, or disable an add-on for an Amazon Lightsail resource.

An additional cost may be associated with enabling add-ons. For more information, see the Lightsail pricing page.

" + }, + "AddOnRequestList":{ + "type":"list", + "member":{"shape":"AddOnRequest"} + }, + "AddOnType":{ + "type":"string", + "enum":["AutoSnapshot"] + }, + "AllocateStaticIpRequest":{ + "type":"structure", + "required":["staticIpName"], + "members":{ + "staticIpName":{ + "shape":"ResourceName", + "documentation":"

The name of the static IP address.

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

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

" + } + } + }, + "AttachDiskRequest":{ + "type":"structure", + "required":[ + "diskName", + "instanceName", + "diskPath" + ], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique Lightsail disk name (e.g., my-disk).

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

The name of the Lightsail instance where you want to utilize the storage disk.

" + }, + "diskPath":{ + "shape":"NonEmptyString", + "documentation":"

The disk path to expose to the instance (e.g., /dev/xvdf).

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

An object describing the API operations.

" + } + } + }, + "AttachInstancesToLoadBalancerRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "instanceNames" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer.

" + }, + "instanceNames":{ + "shape":"ResourceNameList", + "documentation":"

An array of strings representing the instance name(s) you want to attach to your load balancer.

An instance must be running before you can attach it to your load balancer.

There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).

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

An object representing the API operations.

" + } + } + }, + "AttachLoadBalancerTlsCertificateRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "certificateName" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer to which you want to associate the SSL/TLS certificate.

" + }, + "certificateName":{ + "shape":"ResourceName", + "documentation":"

The name of your SSL/TLS certificate.

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

An object representing the API operations.

These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.

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

The name of the static IP.

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

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

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

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

" + } + } + }, + "AttachedDisk":{ + "type":"structure", + "members":{ + "path":{ + "shape":"string", + "documentation":"

The path of the disk (e.g., /dev/xvdf).

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

The size of the disk in GB.

" + } + }, + "documentation":"

Describes a block storage disk that is attached to an instance, and is included in an automatic snapshot.

" + }, + "AttachedDiskList":{ + "type":"list", + "member":{"shape":"AttachedDisk"} + }, + "AttachedDiskMap":{ + "type":"map", + "key":{"shape":"ResourceName"}, + "value":{"shape":"DiskMapList"} + }, + "AutoSnapshotAddOnRequest":{ + "type":"structure", + "members":{ + "snapshotTimeOfDay":{ + "shape":"TimeOfDay", + "documentation":"

The daily time when an automatic snapshot will be created.

Constraints:

  • Must be in HH:00 format, and in an hourly increment.

  • Specified in Coordinated Universal Time (UTC).

  • The snapshot will be automatically created between the time specified and up to 45 minutes after.

" + } + }, + "documentation":"

Describes a request to enable or modify the automatic snapshot add-on for an Amazon Lightsail instance or disk.

When you modify the automatic snapshot time for a resource, it is typically effective immediately except under the following conditions:

  • If an automatic snapshot has been created for the current day, and you change the snapshot time to a later time of day, then the new snapshot time will be effective the following day. This ensures that two snapshots are not created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to an earlier time of day, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day.

  • If an automatic snapshot has not yet been created for the current day, and you change the snapshot time to a time that is within 30 minutes from your current time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

  • If an automatic snapshot is scheduled to be created within 30 minutes from your current time and you change the snapshot time, then the new snapshot time will be effective the following day and a snapshot is automatically created at the previously set time for the current day. This ensures that a snapshot is created for the current day, because 30 minutes is required between your current time and the new snapshot time that you specify.

" + }, + "AutoSnapshotDate":{ + "type":"string", + "pattern":"^[0-9]{4}-[0-9]{2}-[0-9]{2}$" + }, + "AutoSnapshotDetails":{ + "type":"structure", + "members":{ + "date":{ + "shape":"string", + "documentation":"

The date of the automatic snapshot in YYYY-MM-DD format.

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

The timestamp when the automatic snapshot was created.

" + }, + "status":{ + "shape":"AutoSnapshotStatus", + "documentation":"

The status of the automatic snapshot.

" + }, + "fromAttachedDisks":{ + "shape":"AttachedDiskList", + "documentation":"

An array of objects that describe the block storage disks attached to the instance when the automatic snapshot was created.

" + } + }, + "documentation":"

Describes an automatic snapshot.

" + }, + "AutoSnapshotDetailsList":{ + "type":"list", + "member":{"shape":"AutoSnapshotDetails"} + }, + "AutoSnapshotStatus":{ + "type":"string", + "enum":[ + "Success", + "Failed", + "InProgress", + "NotFound" + ] + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "zoneName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the Availability Zone. The format is us-east-2a (case-sensitive).

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

The state of the Availability Zone.

" + } + }, + "documentation":"

Describes an Availability Zone.

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

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

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

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

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

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

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

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

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

The description of the blueprint.

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

A Boolean value indicating whether the blueprint is active. Inactive blueprints are listed to support customers with existing instances but are not necessarily available for launch of new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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

The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates that the blueprint runs on all instance sizes.

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

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

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

The version code.

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

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

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

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

" + }, + "platform":{ + "shape":"InstancePlatform", + "documentation":"

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

" + } + }, + "documentation":"

Describes a blueprint (a virtual private server image).

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

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

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

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

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

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

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

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

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

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

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

A Boolean value indicating whether the bundle is active.

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

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

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

A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a blueprint with a minimum power value of 500.

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

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

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

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

" + }, + "supportedPlatforms":{ + "shape":"InstancePlatformList", + "documentation":"

The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform. LINUX_UNIX blueprints require a LINUX_UNIX bundle.

" + } + }, + "documentation":"

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

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

Information about the public port you are trying to close.

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

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

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

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

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

The name of the CloudFormation stack record. It starts with CloudFormationStackRecord followed by a GUID.

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

The Amazon Resource Name (ARN) of the CloudFormation stack record.

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

The date when the CloudFormation stack record was created.

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

A list of objects describing the Availability Zone and AWS Region of the CloudFormation stack record.

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

The Lightsail resource type (e.g., CloudFormationStackRecord).

" + }, + "state":{ + "shape":"RecordState", + "documentation":"

The current state of the CloudFormation stack record.

" + }, + "sourceInfo":{ + "shape":"CloudFormationStackRecordSourceInfoList", + "documentation":"

A list of objects describing the source of the CloudFormation stack record.

" + }, + "destinationInfo":{ + "shape":"DestinationInfo", + "documentation":"

A list of objects describing the destination service, which is AWS CloudFormation, and the Amazon Resource Name (ARN) of the AWS CloudFormation stack.

" + } + }, + "documentation":"

Describes a CloudFormation stack record created as a result of the create cloud formation stack operation.

A CloudFormation stack record provides information about the AWS CloudFormation stack used to create a new Amazon Elastic Compute Cloud instance from an exported Lightsail instance snapshot.

" + }, + "CloudFormationStackRecordList":{ + "type":"list", + "member":{"shape":"CloudFormationStackRecord"} + }, + "CloudFormationStackRecordSourceInfo":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"CloudFormationStackRecordSourceType", + "documentation":"

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the record.

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

The Amazon Resource Name (ARN) of the export snapshot record.

" + } + }, + "documentation":"

Describes the source of a CloudFormation stack record (i.e., the export snapshot record).

" + }, + "CloudFormationStackRecordSourceInfoList":{ + "type":"list", + "member":{"shape":"CloudFormationStackRecordSourceInfo"} + }, + "CloudFormationStackRecordSourceType":{ + "type":"string", + "enum":["ExportSnapshotRecord"] + }, + "CopySnapshotRequest":{ + "type":"structure", + "required":[ + "targetSnapshotName", + "sourceRegion" + ], + "members":{ + "sourceSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the source instance or disk snapshot to be copied.

Define this parameter only when copying a manual snapshot as another manual snapshot.

" + }, + "sourceResourceName":{ + "shape":"string", + "documentation":"

The name of the source resource from which the automatic snapshot was created.

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "restoreDate":{ + "shape":"string", + "documentation":"

The date of the automatic snapshot to copy for the new manual snapshot.

Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "useLatestRestorableAutoSnapshot":{ + "shape":"boolean", + "documentation":"

A Boolean value to indicate whether to use the latest available automatic snapshot.

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "targetSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the new instance or disk snapshot to be created as a copy.

" + }, + "sourceRegion":{ + "shape":"RegionName", + "documentation":"

The AWS Region where the source manual or automatic snapshot is located.

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

A list of objects describing the API operation.

" + } + } + }, + "CreateCloudFormationStackRequest":{ + "type":"structure", + "required":["instances"], + "members":{ + "instances":{ + "shape":"InstanceEntryList", + "documentation":"

An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.

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

A list of objects describing the API operation.

" + } + } + }, + "CreateDiskFromSnapshotRequest":{ + "type":"structure", + "required":[ + "diskName", + "availabilityZone", + "sizeInGb" + ], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique Lightsail disk name (e.g., my-disk).

" + }, + "diskSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.

This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

" + }, + "availabilityZone":{ + "shape":"NonEmptyString", + "documentation":"

The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

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

The size of the disk in GB (e.g., 32).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

" + }, + "addOns":{ + "shape":"AddOnRequestList", + "documentation":"

An array of objects that represent the add-ons to enable for the new disk.

" + }, + "sourceDiskName":{ + "shape":"string", + "documentation":"

The name of the source disk from which the source automatic snapshot was created.

This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "restoreDate":{ + "shape":"string", + "documentation":"

The date of the automatic snapshot to use for the new disk.

Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "useLatestRestorableAutoSnapshot":{ + "shape":"boolean", + "documentation":"

A Boolean value to indicate whether to use the latest available automatic snapshot.

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Lightsail Dev Guide.

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

An object describing the API operations.

" + } + } + }, + "CreateDiskRequest":{ + "type":"structure", + "required":[ + "diskName", + "availabilityZone", + "sizeInGb" + ], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique Lightsail disk name (e.g., my-disk).

" + }, + "availabilityZone":{ + "shape":"NonEmptyString", + "documentation":"

The Availability Zone where you want to create the disk (e.g., us-east-2a). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.

Use the get regions operation to list the Availability Zones where Lightsail is currently available.

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

The size of the disk in GB (e.g., 32).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

" + }, + "addOns":{ + "shape":"AddOnRequestList", + "documentation":"

An array of objects that represent the add-ons to enable for the new disk.

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

An object describing the API operations.

" + } + } + }, + "CreateDiskSnapshotRequest":{ + "type":"structure", + "required":["diskSnapshotName"], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique name of the source disk (e.g., Disk-Virginia-1).

This parameter cannot be defined together with the instance name parameter. The disk name and instance name parameters are mutually exclusive.

" + }, + "diskSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the destination disk snapshot (e.g., my-disk-snapshot) based on the source disk.

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

The unique name of the source instance (e.g., Amazon_Linux-512MB-Virginia-1). When this is defined, a snapshot of the instance's system volume is created.

This parameter cannot be defined together with the disk name parameter. The instance name and disk name parameters are mutually exclusive.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object describing the API operations.

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

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

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

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

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

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

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

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

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

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

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

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

The name for your new snapshot.

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

The Lightsail instance on which to base your snapshot.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

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

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

The names for your new instances.

" + }, + "attachedDiskMapping":{ + "shape":"AttachedDiskMap", + "documentation":"

An object containing information about one or more disk mappings.

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

The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

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

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

This parameter cannot be defined together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive.

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

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

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

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

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

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

The name for your key pair.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

" + }, + "addOns":{ + "shape":"AddOnRequestList", + "documentation":"

An array of objects representing the add-ons to enable for the new instance.

" + }, + "sourceInstanceName":{ + "shape":"string", + "documentation":"

The name of the source instance from which the source automatic snapshot was created.

This parameter cannot be defined together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive.

Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "restoreDate":{ + "shape":"string", + "documentation":"

The date of the automatic snapshot to use for the new instance.

Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

  • Must be specified in YYYY-MM-DD format.

  • This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

" + }, + "useLatestRestorableAutoSnapshot":{ + "shape":"boolean", + "documentation":"

A Boolean value to indicate whether to use the latest available automatic snapshot.

This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the Lightsail Dev Guide.

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

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

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

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

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

The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request.

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

(Deprecated) The name for your custom image.

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

", + "deprecated":true + }, + "blueprintId":{ + "shape":"NonEmptyString", + "documentation":"

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

Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases.

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

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

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

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

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

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

The name of your key pair.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

" + }, + "addOns":{ + "shape":"AddOnRequestList", + "documentation":"

An array of objects representing the add-ons to enable for the new instance.

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

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

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

The name for your new key pair.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

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

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

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

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

A base64-encoded RSA private key.

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

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

" + } + } + }, + "CreateLoadBalancerRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "instancePort" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of your load balancer.

" + }, + "instancePort":{ + "shape":"Port", + "documentation":"

The instance port where you're creating your load balancer.

" + }, + "healthCheckPath":{ + "shape":"string", + "documentation":"

The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., \"/\").

You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

" + }, + "certificateName":{ + "shape":"ResourceName", + "documentation":"

The name of the SSL/TLS certificate.

If you specify certificateName, then certificateDomainName is required (and vice-versa).

" + }, + "certificateDomainName":{ + "shape":"DomainName", + "documentation":"

The domain name with which your certificate is associated (e.g., example.com).

If you specify certificateDomainName, then certificateName is required (and vice-versa).

" + }, + "certificateAlternativeNames":{ + "shape":"DomainNameList", + "documentation":"

The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object containing information about the API operations.

" + } + } + }, + "CreateLoadBalancerTlsCertificateRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "certificateName", + "certificateDomainName" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The load balancer name where you want to create the SSL/TLS certificate.

" + }, + "certificateName":{ + "shape":"ResourceName", + "documentation":"

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits.

" + }, + "certificateDomainName":{ + "shape":"DomainName", + "documentation":"

The domain name (e.g., example.com) for your SSL/TLS certificate.

" + }, + "certificateAlternativeNames":{ + "shape":"DomainNameList", + "documentation":"

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object containing information about the API operations.

" + } + } + }, + "CreateRelationalDatabaseFromSnapshotRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name to use for your new database.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

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

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

" + }, + "publiclyAccessible":{ + "shape":"boolean", + "documentation":"

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

" + }, + "relationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the database snapshot from which to create your new database.

" + }, + "relationalDatabaseBundleId":{ + "shape":"string", + "documentation":"

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database.

" + }, + "sourceRelationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of the source database.

" + }, + "restoreTime":{ + "shape":"IsoDate", + "documentation":"

The date and time to restore your database from.

Constraints:

  • Must be before the latest restorable time for the database.

  • Cannot be specified if the use latest restorable time parameter is true.

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time.

" + }, + "useLatestRestorableTime":{ + "shape":"boolean", + "documentation":"

Specifies whether your database is restored from the latest backup time. A value of true restores from the latest backup time.

Default: false

Constraints: Cannot be specified if the restore time parameter is provided.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object describing the result of your create relational database from snapshot request.

" + } + } + }, + "CreateRelationalDatabaseRequest":{ + "type":"structure", + "required":[ + "relationalDatabaseName", + "relationalDatabaseBlueprintId", + "relationalDatabaseBundleId", + "masterDatabaseName", + "masterUsername" + ], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name to use for your new database.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

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

The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format.

You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request.

" + }, + "relationalDatabaseBlueprintId":{ + "shape":"string", + "documentation":"

The blueprint ID for your new database. A blueprint describes the major engine version of a database.

You can get a list of database blueprints IDs by using the get relational database blueprints operation.

" + }, + "relationalDatabaseBundleId":{ + "shape":"string", + "documentation":"

The bundle ID for your new database. A bundle describes the performance specifications for your database.

You can get a list of database bundle IDs by using the get relational database bundles operation.

" + }, + "masterDatabaseName":{ + "shape":"string", + "documentation":"

The name of the master database created when the Lightsail database resource is created.

Constraints:

  • Must contain from 1 to 64 alphanumeric characters.

  • Cannot be a word reserved by the specified database engine

" + }, + "masterUsername":{ + "shape":"string", + "documentation":"

The master user name for your new database.

Constraints:

  • Master user name is required.

  • Must contain from 1 to 16 alphanumeric characters.

  • The first character must be a letter.

  • Cannot be a reserved word for the database engine you choose.

    For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 or MySQL 5.7 respectively.

" + }, + "masterUserPassword":{ + "shape":"SensitiveString", + "documentation":"

The password for the master user of your new database. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain 8 to 41 characters.

" + }, + "preferredBackupWindow":{ + "shape":"string", + "documentation":"

The daily time range during which automated backups are created for your new database if automated backups are enabled.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service (Amazon RDS) documentation.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "preferredMaintenanceWindow":{ + "shape":"string", + "documentation":"

The weekly time range during which system maintenance can occur on your new database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

" + }, + "publiclyAccessible":{ + "shape":"boolean", + "documentation":"

Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object describing the result of your create relational database request.

" + } + } + }, + "CreateRelationalDatabaseSnapshotRequest":{ + "type":"structure", + "required":[ + "relationalDatabaseName", + "relationalDatabaseSnapshotName" + ], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of the database on which to base your new snapshot.

" + }, + "relationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name for your new database snapshot.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

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

An object describing the result of your create relational database snapshot request.

" + } + } + }, + "DeleteAutoSnapshotRequest":{ + "type":"structure", + "required":[ + "resourceName", + "date" + ], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the source resource from which to delete the automatic snapshot.

" + }, + "date":{ + "shape":"AutoSnapshotDate", + "documentation":"

The date of the automatic snapshot to delete in YYYY-MM-DD format.

Use the get auto snapshots operation to get the available automatic snapshots for a resource.

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

An array of objects that describe the result of your request.

" + } + } + }, + "DeleteDiskRequest":{ + "type":"structure", + "required":["diskName"], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique name of the disk you want to delete (e.g., my-disk).

" + }, + "forceDeleteAddOns":{ + "shape":"boolean", + "documentation":"

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

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

An array of objects that describe the result of your request.

" + } + } + }, + "DeleteDiskSnapshotRequest":{ + "type":"structure", + "required":["diskSnapshotName"], + "members":{ + "diskSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).

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

An object describing the API operations.

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

The name of the domain entry to delete.

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

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

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

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

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

The specific domain name to delete.

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

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

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

The name of the instance to delete.

" + }, + "forceDeleteAddOns":{ + "shape":"boolean", + "documentation":"

A Boolean value to indicate whether to delete the enabled add-ons for the disk.

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

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

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

The name of the snapshot to delete.

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

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

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

The name of the key pair to delete.

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

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

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

The name of the instance for which you want to reset the host key or certificate.

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

A list of objects describing the API operation.

" + } + } + }, + "DeleteLoadBalancerRequest":{ + "type":"structure", + "required":["loadBalancerName"], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer you want to delete.

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

An object describing the API operations.

" + } + } + }, + "DeleteLoadBalancerTlsCertificateRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "certificateName" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The load balancer name.

" + }, + "certificateName":{ + "shape":"ResourceName", + "documentation":"

The SSL/TLS certificate name.

" + }, + "force":{ + "shape":"boolean", + "documentation":"

When true, forces the deletion of an SSL/TLS certificate.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

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

An object describing the API operations.

" + } + } + }, + "DeleteRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of the database that you are deleting.

" + }, + "skipFinalSnapshot":{ + "shape":"boolean", + "documentation":"

Determines whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted.

You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

Default: false

" + }, + "finalRelationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error.

Constraints:

  • Must contain from 2 to 255 alphanumeric characters, or hyphens.

  • The first and last character must be a letter or number.

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

An object describing the result of your delete relational database request.

" + } + } + }, + "DeleteRelationalDatabaseSnapshotRequest":{ + "type":"structure", + "required":["relationalDatabaseSnapshotName"], + "members":{ + "relationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the database snapshot that you are deleting.

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

An object describing the result of your delete relational database snapshot request.

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

The ID of the resource created at the destination.

" + }, + "service":{ + "shape":"NonEmptyString", + "documentation":"

The destination service of the record.

" + } + }, + "documentation":"

Describes the destination of a record.

" + }, + "DetachDiskRequest":{ + "type":"structure", + "required":["diskName"], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The unique name of the disk you want to detach from your instance (e.g., my-disk).

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

An object describing the API operations.

" + } + } + }, + "DetachInstancesFromLoadBalancerRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "instanceNames" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the Lightsail load balancer.

" + }, + "instanceNames":{ + "shape":"ResourceNameList", + "documentation":"

An array of strings containing the names of the instances you want to detach from the load balancer.

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

An object describing the API operations.

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

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

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

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

" + } + } + }, + "DisableAddOnRequest":{ + "type":"structure", + "required":[ + "addOnType", + "resourceName" + ], + "members":{ + "addOnType":{ + "shape":"AddOnType", + "documentation":"

The add-on type to disable.

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

The name of the source resource from which to disable the add-on.

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

An array of objects that describe the result of your request.

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

The unique name of the disk.

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

The Amazon Resource Name (ARN) of the disk.

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

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

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

The date when the disk was created.

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

The AWS Region and Availability Zone where the disk is located.

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

The Lightsail resource type (e.g., Disk).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "addOns":{ + "shape":"AddOnList", + "documentation":"

An array of objects representing the add-ons enabled on the disk.

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

The size of the disk in GB.

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

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

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

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

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

The disk path.

" + }, + "state":{ + "shape":"DiskState", + "documentation":"

Describes the status of the disk.

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

The resources to which the disk is attached.

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

A Boolean value indicating whether the disk is attached.

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

(Deprecated) The attachment state of the disk.

In releases prior to November 14, 2017, this parameter returned attached for system disks in the API response. It is now deprecated, but still included in the response. Use isAttached instead.

", + "deprecated":true + }, + "gbInUse":{ + "shape":"integer", + "documentation":"

(Deprecated) The number of GB in use by the disk.

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

", + "deprecated":true + } + }, + "documentation":"

Describes a system disk or a block storage disk.

" + }, + "DiskInfo":{ + "type":"structure", + "members":{ + "name":{ + "shape":"string", + "documentation":"

The disk name.

" + }, + "path":{ + "shape":"NonEmptyString", + "documentation":"

The disk path.

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

The size of the disk in GB (e.g., 32).

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

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

" + } + }, + "documentation":"

Describes a disk.

" + }, + "DiskInfoList":{ + "type":"list", + "member":{"shape":"DiskInfo"} + }, + "DiskList":{ + "type":"list", + "member":{"shape":"Disk"} + }, + "DiskMap":{ + "type":"structure", + "members":{ + "originalDiskPath":{ + "shape":"NonEmptyString", + "documentation":"

The original disk path exposed to the instance (for example, /dev/sdh).

" + }, + "newDiskName":{ + "shape":"ResourceName", + "documentation":"

The new disk name (e.g., my-new-disk).

" + } + }, + "documentation":"

Describes a block storage disk mapping.

" + }, + "DiskMapList":{ + "type":"list", + "member":{"shape":"DiskMap"} + }, + "DiskSnapshot":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the disk snapshot (e.g., my-disk-snapshot).

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

The Amazon Resource Name (ARN) of the disk snapshot.

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

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

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

The date when the disk snapshot was created.

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

The AWS Region and Availability Zone where the disk snapshot was created.

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

The Lightsail resource type (e.g., DiskSnapshot).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

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

The size of the disk in GB.

" + }, + "state":{ + "shape":"DiskSnapshotState", + "documentation":"

The status of the disk snapshot operation.

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

The progress of the disk snapshot operation.

" + }, + "fromDiskName":{ + "shape":"ResourceName", + "documentation":"

The unique name of the source disk from which the disk snapshot was created.

" + }, + "fromDiskArn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the source disk from which the disk snapshot was created.

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

The unique name of the source instance from which the disk (system volume) snapshot was created.

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

The Amazon Resource Name (ARN) of the source instance from which the disk (system volume) snapshot was created.

" + }, + "isFromAutoSnapshot":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

" + } + }, + "documentation":"

Describes a block storage disk snapshot.

" + }, + "DiskSnapshotInfo":{ + "type":"structure", + "members":{ + "sizeInGb":{ + "shape":"integer", + "documentation":"

The size of the disk in GB (e.g., 32).

" + } + }, + "documentation":"

Describes a disk snapshot.

" + }, + "DiskSnapshotList":{ + "type":"list", + "member":{"shape":"DiskSnapshot"} + }, + "DiskSnapshotState":{ + "type":"string", + "enum":[ + "pending", + "completed", + "error", + "unknown" + ] + }, + "DiskState":{ + "type":"string", + "enum":[ + "pending", + "error", + "available", + "in-use", + "unknown" + ] + }, + "Domain":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the domain.

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

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

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

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

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

The date when the domain recordset was created.

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

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

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

The resource type.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

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

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

" + } + }, + "documentation":"

Describes a domain where you are storing recordsets in Lightsail.

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

The ID of the domain recordset entry.

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

The name of the domain.

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

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

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com. Be sure to also set isAlias to true when setting up an A record for a load balancer.

" + }, + "isAlias":{ + "shape":"boolean", + "documentation":"

When true, specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

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

The type of domain entry, such as address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).

The following domain entry types can be used:

  • A

  • CNAME

  • MX

  • NS

  • SOA

  • SRV

  • TXT

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

(Deprecated) The options for the domain entry.

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

", + "deprecated":true + } + }, + "documentation":"

Describes a domain recordset entry.

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

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

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

A base64-encoded RSA private key.

" + } + } + }, + "EnableAddOnRequest":{ + "type":"structure", + "required":[ + "resourceName", + "addOnRequest" + ], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the source resource for which to enable or modify the add-on.

" + }, + "addOnRequest":{ + "shape":"AddOnRequest", + "documentation":"

An array of strings representing the add-on to enable or modify.

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

An array of objects that describe the result of your request.

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

The export snapshot record name.

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

The Amazon Resource Name (ARN) of the export snapshot record.

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

The date when the export snapshot record was created.

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

The AWS Region and Availability Zone where the export snapshot record is located.

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

The Lightsail resource type (e.g., ExportSnapshotRecord).

" + }, + "state":{ + "shape":"RecordState", + "documentation":"

The state of the export snapshot record.

" + }, + "sourceInfo":{ + "shape":"ExportSnapshotRecordSourceInfo", + "documentation":"

A list of objects describing the source of the export snapshot record.

" + }, + "destinationInfo":{ + "shape":"DestinationInfo", + "documentation":"

A list of objects describing the destination of the export snapshot record.

" + } + }, + "documentation":"

Describes an export snapshot record.

" + }, + "ExportSnapshotRecordList":{ + "type":"list", + "member":{"shape":"ExportSnapshotRecord"} + }, + "ExportSnapshotRecordSourceInfo":{ + "type":"structure", + "members":{ + "resourceType":{ + "shape":"ExportSnapshotRecordSourceType", + "documentation":"

The Lightsail resource type (e.g., InstanceSnapshot or DiskSnapshot).

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

The date when the source instance or disk snapshot was created.

" + }, + "name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the source instance or disk snapshot.

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

The Amazon Resource Name (ARN) of the source instance or disk snapshot.

" + }, + "fromResourceName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the snapshot's source instance or disk.

" + }, + "fromResourceArn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the snapshot's source instance or disk.

" + }, + "instanceSnapshotInfo":{ + "shape":"InstanceSnapshotInfo", + "documentation":"

A list of objects describing an instance snapshot.

" + }, + "diskSnapshotInfo":{ + "shape":"DiskSnapshotInfo", + "documentation":"

A list of objects describing a disk snapshot.

" + } + }, + "documentation":"

Describes the source of an export snapshot record.

" + }, + "ExportSnapshotRecordSourceType":{ + "type":"string", + "enum":[ + "InstanceSnapshot", + "DiskSnapshot" + ] + }, + "ExportSnapshotRequest":{ + "type":"structure", + "required":["sourceSnapshotName"], + "members":{ + "sourceSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the instance or disk snapshot to be exported to Amazon EC2.

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

A list of objects describing the API operation.

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

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

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

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

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

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

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

The name of the source resource from which to get automatic snapshot information.

" + } + } + }, + "GetAutoSnapshotsResult":{ + "type":"structure", + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the source resource for the automatic snapshots.

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

The resource type (e.g., Instance or Disk).

" + }, + "autoSnapshots":{ + "shape":"AutoSnapshotDetailsList", + "documentation":"

An array of objects that describe the automatic snapshots that are available for the specified source resource.asdf

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

A token used for advancing to a specific page of results for your get cloud formation stack records request.

" + } + } + }, + "GetCloudFormationStackRecordsResult":{ + "type":"structure", + "members":{ + "cloudFormationStackRecords":{ + "shape":"CloudFormationStackRecordList", + "documentation":"

A list of objects describing the CloudFormation stack records.

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

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

" + } + } + }, + "GetDiskRequest":{ + "type":"structure", + "required":["diskName"], + "members":{ + "diskName":{ + "shape":"ResourceName", + "documentation":"

The name of the disk (e.g., my-disk).

" + } + } + }, + "GetDiskResult":{ + "type":"structure", + "members":{ + "disk":{ + "shape":"Disk", + "documentation":"

An object containing information about the disk.

" + } + } + }, + "GetDiskSnapshotRequest":{ + "type":"structure", + "required":["diskSnapshotName"], + "members":{ + "diskSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the disk snapshot (e.g., my-disk-snapshot).

" + } + } + }, + "GetDiskSnapshotResult":{ + "type":"structure", + "members":{ + "diskSnapshot":{ + "shape":"DiskSnapshot", + "documentation":"

An object containing information about the disk snapshot.

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

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

" + } + } + }, + "GetDiskSnapshotsResult":{ + "type":"structure", + "members":{ + "diskSnapshots":{ + "shape":"DiskSnapshotList", + "documentation":"

An array of objects containing information about all block storage disk snapshots.

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

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

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

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

" + } + } + }, + "GetDisksResult":{ + "type":"structure", + "members":{ + "disks":{ + "shape":"DiskList", + "documentation":"

An array of objects containing information about all block storage disks.

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

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

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

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

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

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

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

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

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

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

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

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

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

A token used for advancing to a specific page of results for your get export snapshot records request.

" + } + } + }, + "GetExportSnapshotRecordsResult":{ + "type":"structure", + "members":{ + "exportSnapshotRecords":{ + "shape":"ExportSnapshotRecordList", + "documentation":"

A list of objects describing the export snapshot records.

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

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

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

The name of the instance to access.

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

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

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

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

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

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

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

The metric name to get data about.

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

The granularity, in seconds, of the returned data points.

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

The start time of the time period.

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

The end time of the time period.

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

The unit. The list of valid values is below.

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

The instance statistics.

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

The metric name to return data for.

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

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

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

The name of the instance.

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

Information about the port states resulting from your request.

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

The name of the instance.

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

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

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

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

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

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

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

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

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

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

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

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

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

The name of the instance to get state information about.

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

The state of the instance.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The name of the load balancer.

" + }, + "metricName":{ + "shape":"LoadBalancerMetricName", + "documentation":"

The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

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

The granularity, in seconds, of the returned data points.

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

The start time of the period.

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

The end time of the period.

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

The unit for the time period request. Valid values are listed below.

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

An array of statistics that you want to request metrics for. Valid values are listed below.

  • SampleCount - The count (number) of data points used for the statistical calculation.

  • Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.

  • Sum - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.

  • Minimum - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.

  • Maximum - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.

" + } + } + }, + "GetLoadBalancerMetricDataResult":{ + "type":"structure", + "members":{ + "metricName":{ + "shape":"LoadBalancerMetricName", + "documentation":"

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

  • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols.

    Statistics: The most useful statistic is Sum.

  • HealthyHostCount - The number of target instances that are considered healthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • UnhealthyHostCount - The number of target instances that are considered unhealthy.

    Statistics: The most useful statistic are Average, Minimum, and Maximum.

  • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_2XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_3XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_4XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • HTTPCode_Instance_5XX_Count - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

  • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.

    Statistics: The most useful statistic is Average.

  • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections.

    Statistics: The most useful statistic is Sum.

  • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer.

    Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1.

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

An array of metric datapoint objects.

" + } + } + }, + "GetLoadBalancerRequest":{ + "type":"structure", + "required":["loadBalancerName"], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer.

" + } + } + }, + "GetLoadBalancerResult":{ + "type":"structure", + "members":{ + "loadBalancer":{ + "shape":"LoadBalancer", + "documentation":"

An object containing information about your load balancer.

" + } + } + }, + "GetLoadBalancerTlsCertificatesRequest":{ + "type":"structure", + "required":["loadBalancerName"], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer you associated with your SSL/TLS certificate.

" + } + } + }, + "GetLoadBalancerTlsCertificatesResult":{ + "type":"structure", + "members":{ + "tlsCertificates":{ + "shape":"LoadBalancerTlsCertificateList", + "documentation":"

An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.

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

A token used for paginating the results from your GetLoadBalancers request.

" + } + } + }, + "GetLoadBalancersResult":{ + "type":"structure", + "members":{ + "loadBalancers":{ + "shape":"LoadBalancerList", + "documentation":"

An array of LoadBalancer objects describing your load balancers.

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

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

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

A GUID used to identify the operation.

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

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

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

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

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

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

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

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

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

(Deprecated) Returns the number of pages of results that remain.

In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated, and the API returns the next page token parameter instead.

", + "deprecated":true + }, + "nextPageToken":{ + "shape":"string", + "documentation":"

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

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

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

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

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

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

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

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

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

" + }, + "includeRelationalDatabaseAvailabilityZones":{ + "shape":"boolean", + "documentation":"

>A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (e.g., us-east-2a).

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

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

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

A token used for advancing to a specific page of results for your get relational database blueprints request.

" + } + } + }, + "GetRelationalDatabaseBlueprintsResult":{ + "type":"structure", + "members":{ + "blueprints":{ + "shape":"RelationalDatabaseBlueprintList", + "documentation":"

An object describing the result of your get relational database blueprints request.

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

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

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

A token used for advancing to a specific page of results for your get relational database bundles request.

" + } + } + }, + "GetRelationalDatabaseBundlesResult":{ + "type":"structure", + "members":{ + "bundles":{ + "shape":"RelationalDatabaseBundleList", + "documentation":"

An object describing the result of your get relational database bundles request.

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

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

" + } + } + }, + "GetRelationalDatabaseEventsRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of the database from which to get events.

" + }, + "durationInMinutes":{ + "shape":"integer", + "documentation":"

The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

Default: 60

The minimum is 1 and the maximum is 14 days (20160 minutes).

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

A token used for advancing to a specific page of results from for get relational database events request.

" + } + } + }, + "GetRelationalDatabaseEventsResult":{ + "type":"structure", + "members":{ + "relationalDatabaseEvents":{ + "shape":"RelationalDatabaseEventList", + "documentation":"

An object describing the result of your get relational database events request.

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

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

" + } + } + }, + "GetRelationalDatabaseLogEventsRequest":{ + "type":"structure", + "required":[ + "relationalDatabaseName", + "logStreamName" + ], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database for which to get log events.

" + }, + "logStreamName":{ + "shape":"string", + "documentation":"

The name of the log stream.

Use the get relational database log streams operation to get a list of available log streams.

" + }, + "startTime":{ + "shape":"IsoDate", + "documentation":"

The start of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

" + }, + "endTime":{ + "shape":"IsoDate", + "documentation":"

The end of the time interval from which to get log events.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

" + }, + "startFromHead":{ + "shape":"boolean", + "documentation":"

Parameter to specify if the log should start from head or tail. If true is specified, the log event starts from the head of the log. If false is specified, the log event starts from the tail of the log.

For PostgreSQL, the default value of false is the only option available.

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

A token used for advancing to a specific page of results for your get relational database log events request.

" + } + } + }, + "GetRelationalDatabaseLogEventsResult":{ + "type":"structure", + "members":{ + "resourceLogEvents":{ + "shape":"LogEventList", + "documentation":"

An object describing the result of your get relational database log events request.

" + }, + "nextBackwardToken":{ + "shape":"string", + "documentation":"

A token used for advancing to the previous page of results from your get relational database log events request.

" + }, + "nextForwardToken":{ + "shape":"string", + "documentation":"

A token used for advancing to the next page of results from your get relational database log events request.

" + } + } + }, + "GetRelationalDatabaseLogStreamsRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database for which to get log streams.

" + } + } + }, + "GetRelationalDatabaseLogStreamsResult":{ + "type":"structure", + "members":{ + "logStreams":{ + "shape":"StringList", + "documentation":"

An object describing the result of your get relational database log streams request.

" + } + } + }, + "GetRelationalDatabaseMasterUserPasswordRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database for which to get the master user password.

" + }, + "passwordVersion":{ + "shape":"RelationalDatabasePasswordVersion", + "documentation":"

The password version to return.

Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available.

Default: CURRENT

" + } + } + }, + "GetRelationalDatabaseMasterUserPasswordResult":{ + "type":"structure", + "members":{ + "masterUserPassword":{ + "shape":"SensitiveString", + "documentation":"

The master user password for the password version specified.

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

The timestamp when the specified version of the master user password was created.

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

The name of your database from which to get metric data.

" + }, + "metricName":{ + "shape":"RelationalDatabaseMetricName", + "documentation":"

The name of the metric data to return.

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

The granularity, in seconds, of the returned data points.

" + }, + "startTime":{ + "shape":"IsoDate", + "documentation":"

The start of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

" + }, + "endTime":{ + "shape":"IsoDate", + "documentation":"

The end of the time interval from which to get metric data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

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

The unit for the metric data request.

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

The array of statistics for your metric data request.

" + } + } + }, + "GetRelationalDatabaseMetricDataResult":{ + "type":"structure", + "members":{ + "metricName":{ + "shape":"RelationalDatabaseMetricName", + "documentation":"

The name of the metric.

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

An object describing the result of your get relational database metric data request.

" + } + } + }, + "GetRelationalDatabaseParametersRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database for which to get parameters.

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

A token used for advancing to a specific page of results for your get relational database parameters request.

" + } + } + }, + "GetRelationalDatabaseParametersResult":{ + "type":"structure", + "members":{ + "parameters":{ + "shape":"RelationalDatabaseParameterList", + "documentation":"

An object describing the result of your get relational database parameters request.

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

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

" + } + } + }, + "GetRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of the database that you are looking up.

" + } + } + }, + "GetRelationalDatabaseResult":{ + "type":"structure", + "members":{ + "relationalDatabase":{ + "shape":"RelationalDatabase", + "documentation":"

An object describing the specified database.

" + } + } + }, + "GetRelationalDatabaseSnapshotRequest":{ + "type":"structure", + "required":["relationalDatabaseSnapshotName"], + "members":{ + "relationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of the database snapshot for which to get information.

" + } + } + }, + "GetRelationalDatabaseSnapshotResult":{ + "type":"structure", + "members":{ + "relationalDatabaseSnapshot":{ + "shape":"RelationalDatabaseSnapshot", + "documentation":"

An object describing the specified database snapshot.

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

A token used for advancing to a specific page of results for your get relational database snapshots request.

" + } + } + }, + "GetRelationalDatabaseSnapshotsResult":{ + "type":"structure", + "members":{ + "relationalDatabaseSnapshots":{ + "shape":"RelationalDatabaseSnapshotList", + "documentation":"

An object describing the result of your get relational database snapshots request.

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

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

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

A token used for advancing to a specific page of results for your get relational database request.

" + } + } + }, + "GetRelationalDatabasesResult":{ + "type":"structure", + "members":{ + "relationalDatabases":{ + "shape":"RelationalDatabaseList", + "documentation":"

An object describing the result of your get relational databases request.

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

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

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

The name of the static IP in Lightsail.

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

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

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

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

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

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

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

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

" + } + } + }, + "HostKeyAttributes":{ + "type":"structure", + "members":{ + "algorithm":{ + "shape":"string", + "documentation":"

The SSH host key algorithm or the RDP certificate format.

For SSH host keys, the algorithm may be ssh-rsa, ecdsa-sha2-nistp256, ssh-ed25519, etc. For RDP certificates, the algorithm is always x509-cert.

" + }, + "publicKey":{ + "shape":"string", + "documentation":"

The public SSH host key or the RDP certificate.

" + }, + "witnessedAt":{ + "shape":"IsoDate", + "documentation":"

The time that the SSH host key or RDP certificate was recorded by Lightsail.

" + }, + "fingerprintSHA1":{ + "shape":"string", + "documentation":"

The SHA-1 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-1 SSH fingerprint:

    SHA1:1CHH6FaAaXjtFOsR/t83vf91SR0

  • Example of an SHA-1 RDP fingerprint:

    af:34:51:fe:09:f0:e0:da:b8:4e:56:ca:60:c2:10:ff:38:06:db:45

" + }, + "fingerprintSHA256":{ + "shape":"string", + "documentation":"

The SHA-256 fingerprint of the returned SSH host key or RDP certificate.

  • Example of an SHA-256 SSH fingerprint:

    SHA256:KTsMnRBh1IhD17HpdfsbzeGA4jOijm5tyXsMjKVbB8o

  • Example of an SHA-256 RDP fingerprint:

    03:9b:36:9f:4b:de:4e:61:70:fc:7c:c9:78:e7:d2:1a:1c:25:a8:0c:91:f6:7c:e4:d6:a0:85:c8:b4:53:99:68

" + }, + "notValidBefore":{ + "shape":"IsoDate", + "documentation":"

The returned RDP certificate is valid after this point in time.

This value is listed only for RDP certificates.

" + }, + "notValidAfter":{ + "shape":"IsoDate", + "documentation":"

The returned RDP certificate is not valid after this point in time.

This value is listed only for RDP certificates.

" + } + }, + "documentation":"

Describes the public SSH host keys or the RDP certificate.

" + }, + "HostKeysList":{ + "type":"list", + "member":{"shape":"HostKeyAttributes"} + }, + "ImportKeyPairRequest":{ + "type":"structure", + "required":[ + "keyPairName", + "publicKeyBase64" + ], + "members":{ + "keyPairName":{ + "shape":"ResourceName", + "documentation":"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The region name and Availability Zone where the instance is located.

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

The type of resource (usually Instance).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

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

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

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

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

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

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

" + }, + "addOns":{ + "shape":"AddOnList", + "documentation":"

An array of objects representing the add-ons enabled on the instance.

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

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

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

The private IP address of the instance.

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

The public IP address of the instance.

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

The IPv6 address of the instance.

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

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

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

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

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

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

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

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

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

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

" + } + }, + "documentation":"

Describes an instance (a virtual private server).

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

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

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

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

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

The public IP address of the Amazon Lightsail instance.

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

For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you create an instance using any key pair other than the default (LightsailDefaultKeyPair), password will always be an empty string.

If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

" + }, + "passwordData":{ + "shape":"PasswordData", + "documentation":"

For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if password is empty and the instance is not new (and therefore the password is not ready yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.

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

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

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

The protocol for these Amazon Lightsail instance access details.

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

The name of this Amazon Lightsail instance.

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

The user name to use when logging in to the Amazon Lightsail instance.

" + }, + "hostKeys":{ + "shape":"HostKeysList", + "documentation":"

Describes the public SSH host keys or the RDP certificate.

" + } + }, + "documentation":"

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

" + }, + "InstanceAccessProtocol":{ + "type":"string", + "enum":[ + "ssh", + "rdp" + ] + }, + "InstanceEntry":{ + "type":"structure", + "required":[ + "sourceName", + "instanceType", + "portInfoSource", + "availabilityZone" + ], + "members":{ + "sourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the export snapshot record, which contains the exported Lightsail instance snapshot that will be used as the source of the new Amazon EC2 instance.

Use the get export snapshot records operation to get a list of export snapshot records that you can use to create a CloudFormation stack.

" + }, + "instanceType":{ + "shape":"NonEmptyString", + "documentation":"

The instance type (e.g., t2.micro) to use for the new Amazon EC2 instance.

" + }, + "portInfoSource":{ + "shape":"PortInfoSourceType", + "documentation":"

The port configuration to use for the new Amazon EC2 instance.

The following configuration options are available:

  • DEFAULT — Use the default firewall settings from the image.

  • INSTANCE — Use the firewall settings from the source Lightsail instance.

  • NONE — Default to Amazon EC2.

  • CLOSED — All ports closed.

" + }, + "userData":{ + "shape":"string", + "documentation":"

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update.

Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg.

" + }, + "availabilityZone":{ + "shape":"string", + "documentation":"

The Availability Zone for the new Amazon EC2 instance.

" + } + }, + "documentation":"

Describes the Amazon Elastic Compute Cloud instance and related resources to be created using the create cloud formation stack operation.

" + }, + "InstanceEntryList":{ + "type":"list", + "member":{"shape":"InstanceEntry"} + }, + "InstanceHardware":{ + "type":"structure", + "members":{ + "cpuCount":{ + "shape":"integer", + "documentation":"

The number of vCPUs the instance has.

" + }, + "disks":{ + "shape":"DiskList", + "documentation":"

The disks attached to the instance.

" + }, + "ramSizeInGb":{ + "shape":"float", + "documentation":"

The amount of RAM in GB on the instance (e.g., 1.0).

" + } + }, + "documentation":"

Describes the hardware for the instance.

" + }, + "InstanceHealthReason":{ + "type":"string", + "enum":[ + "Lb.RegistrationInProgress", + "Lb.InitialHealthChecking", + "Lb.InternalError", + "Instance.ResponseCodeMismatch", + "Instance.Timeout", + "Instance.FailedHealthChecks", + "Instance.NotRegistered", + "Instance.NotInUse", + "Instance.DeregistrationInProgress", + "Instance.InvalidState", + "Instance.IpUnusable" + ] + }, + "InstanceHealthState":{ + "type":"string", + "enum":[ + "initial", + "healthy", + "unhealthy", + "unused", + "draining", + "unavailable" + ] + }, + "InstanceHealthSummary":{ + "type":"structure", + "members":{ + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The name of the Lightsail instance for which you are requesting health check data.

" + }, + "instanceHealth":{ + "shape":"InstanceHealthState", + "documentation":"

Describes the overall instance health. Valid values are below.

" + }, + "instanceHealthReason":{ + "shape":"InstanceHealthReason", + "documentation":"

More information about the instance health. If the instanceHealth is healthy, then an instanceHealthReason value is not provided.

If instanceHealth is initial, the instanceHealthReason value can be one of the following:

  • Lb.RegistrationInProgress - The target instance is in the process of being registered with the load balancer.

  • Lb.InitialHealthChecking - The Lightsail load balancer is still sending the target instance the minimum number of health checks required to determine its health status.

If instanceHealth is unhealthy, the instanceHealthReason value can be one of the following:

  • Instance.ResponseCodeMismatch - The health checks did not return an expected HTTP code.

  • Instance.Timeout - The health check requests timed out.

  • Instance.FailedHealthChecks - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

  • Lb.InternalError - The health checks failed due to an internal error.

If instanceHealth is unused, the instanceHealthReason value can be one of the following:

  • Instance.NotRegistered - The target instance is not registered with the target group.

  • Instance.NotInUse - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

  • Instance.IpUnusable - The target IP address is reserved for use by a Lightsail load balancer.

  • Instance.InvalidState - The target is in the stopped or terminated state.

If instanceHealth is draining, the instanceHealthReason value can be one of the following:

  • Instance.DeregistrationInProgress - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

" + } + }, + "documentation":"

Describes information about the health of the instance.

" + }, + "InstanceHealthSummaryList":{ + "type":"list", + "member":{"shape":"InstanceHealthSummary"} + }, + "InstanceList":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstanceMetricName":{ + "type":"string", + "enum":[ + "CPUUtilization", + "NetworkIn", + "NetworkOut", + "StatusCheckFailed", + "StatusCheckFailed_Instance", + "StatusCheckFailed_System" + ] + }, + "InstanceNetworking":{ + "type":"structure", + "members":{ + "monthlyTransfer":{ + "shape":"MonthlyTransfer", + "documentation":"

The amount of data in GB allocated for monthly data transfers.

" + }, + "ports":{ + "shape":"InstancePortInfoList", + "documentation":"

An array of key-value pairs containing information about the ports on the instance.

" + } + }, + "documentation":"

Describes monthly data transfer rates and port information for an instance.

" + }, + "InstancePlatform":{ + "type":"string", + "enum":[ + "LINUX_UNIX", + "WINDOWS" + ] + }, + "InstancePlatformList":{ + "type":"list", + "member":{"shape":"InstancePlatform"} + }, + "InstancePortInfo":{ + "type":"structure", + "members":{ + "fromPort":{ + "shape":"Port", + "documentation":"

The first port in the range.

" + }, + "toPort":{ + "shape":"Port", + "documentation":"

The last port in the range.

" + }, + "protocol":{ + "shape":"NetworkProtocol", + "documentation":"

The protocol being used. Can be one of the following.

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

" + }, + "accessFrom":{ + "shape":"string", + "documentation":"

The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).

" + }, + "accessType":{ + "shape":"PortAccessType", + "documentation":"

The type of access (Public or Private).

" + }, + "commonName":{ + "shape":"string", + "documentation":"

The common name.

" + }, + "accessDirection":{ + "shape":"AccessDirection", + "documentation":"

The access direction (inbound or outbound).

" + } + }, + "documentation":"

Describes information about the instance ports.

" + }, + "InstancePortInfoList":{ + "type":"list", + "member":{"shape":"InstancePortInfo"} + }, + "InstancePortState":{ + "type":"structure", + "members":{ + "fromPort":{ + "shape":"Port", + "documentation":"

The first port in the range.

" + }, + "toPort":{ + "shape":"Port", + "documentation":"

The last port in the range.

" + }, + "protocol":{ + "shape":"NetworkProtocol", + "documentation":"

The protocol being used. Can be one of the following.

  • tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of streamed data between applications running on hosts communicating by an IP network. If you have an application that doesn't require reliable data stream service, use UDP instead.

  • all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.

  • udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable data stream service, use TCP instead.

" + }, + "state":{ + "shape":"PortState", + "documentation":"

Specifies whether the instance port is open or closed.

" + } + }, + "documentation":"

Describes the port state.

" + }, + "InstancePortStateList":{ + "type":"list", + "member":{"shape":"InstancePortState"} + }, + "InstanceSnapshot":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the snapshot.

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the snapshot was created (e.g., 1479907467.024).

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The region name and Availability Zone where you created the snapshot.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The type of resource (usually InstanceSnapshot).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "state":{ + "shape":"InstanceSnapshotState", + "documentation":"

The state the snapshot is in.

" + }, + "progress":{ + "shape":"string", + "documentation":"

The progress of the snapshot.

" + }, + "fromAttachedDisks":{ + "shape":"DiskList", + "documentation":"

An array of disk objects containing information about all block storage disks.

" + }, + "fromInstanceName":{ + "shape":"ResourceName", + "documentation":"

The instance from which the snapshot was created.

" + }, + "fromInstanceArn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).

" + }, + "fromBlueprintId":{ + "shape":"string", + "documentation":"

The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual private server (or instance) image used to create instances quickly.

" + }, + "fromBundleId":{ + "shape":"string", + "documentation":"

The bundle ID from which you created the snapshot (e.g., micro_1_0).

" + }, + "isFromAutoSnapshot":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the snapshot was created from an automatic snapshot.

" + }, + "sizeInGb":{ + "shape":"integer", + "documentation":"

The size in GB of the SSD.

" + } + }, + "documentation":"

Describes an instance snapshot.

" + }, + "InstanceSnapshotInfo":{ + "type":"structure", + "members":{ + "fromBundleId":{ + "shape":"NonEmptyString", + "documentation":"

The bundle ID from which the source instance was created (e.g., micro_1_0).

" + }, + "fromBlueprintId":{ + "shape":"NonEmptyString", + "documentation":"

The blueprint ID from which the source instance (e.g., os_debian_8_3).

" + }, + "fromDiskInfo":{ + "shape":"DiskInfoList", + "documentation":"

A list of objects describing the disks that were attached to the source instance.

" + } + }, + "documentation":"

Describes an instance snapshot.

" + }, + "InstanceSnapshotList":{ + "type":"list", + "member":{"shape":"InstanceSnapshot"} + }, + "InstanceSnapshotState":{ + "type":"string", + "enum":[ + "pending", + "error", + "available" + ] + }, + "InstanceState":{ + "type":"structure", + "members":{ + "code":{ + "shape":"integer", + "documentation":"

The status code for the instance.

" + }, + "name":{ + "shape":"string", + "documentation":"

The state of the instance (e.g., running or pending).

" + } + }, + "documentation":"

Describes the virtual private server (or instance) status.

" + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "code":{"shape":"string"}, + "docs":{"shape":"string"}, + "message":{"shape":"string"}, + "tip":{"shape":"string"} + }, + "documentation":"

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your AWS Region configuration to us-east-1 to create, view, or edit these resources.

", + "exception":true + }, + "IpAddress":{ + "type":"string", + "pattern":"([0-9]{1,3}\\.){3}[0-9]{1,3}" + }, + "IpV6Address":{ + "type":"string", + "pattern":"([A-F0-9]{1,4}:){7}[A-F0-9]{1,4}" + }, + "IsVpcPeeredRequest":{ + "type":"structure", + "members":{ + } + }, + "IsVpcPeeredResult":{ + "type":"structure", + "members":{ + "isPeered":{ + "shape":"boolean", + "documentation":"

Returns true if the Lightsail VPC is peered; otherwise, false.

" + } + } + }, + "IsoDate":{"type":"timestamp"}, + "KeyPair":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The friendly name of the SSH key pair.

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the key pair was created (e.g., 1479816991.349).

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The region name and Availability Zone where the key pair was created.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type (usually KeyPair).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "fingerprint":{ + "shape":"Base64", + "documentation":"

The RSA fingerprint of the key pair.

" + } + }, + "documentation":"

Describes the SSH key pair.

" + }, + "KeyPairList":{ + "type":"list", + "member":{"shape":"KeyPair"} + }, + "LoadBalancer":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer (e.g., my-load-balancer).

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the load balancer.

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The date when your load balancer was created.

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The AWS Region where your load balancer was created (e.g., us-east-2a). Lightsail automatically creates your load balancer across Availability Zones.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type (e.g., LoadBalancer.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "dnsName":{ + "shape":"NonEmptyString", + "documentation":"

The DNS name of your Lightsail load balancer.

" + }, + "state":{ + "shape":"LoadBalancerState", + "documentation":"

The status of your load balancer. Valid values are below.

" + }, + "protocol":{ + "shape":"LoadBalancerProtocol", + "documentation":"

The protocol you have enabled for your load balancer. Valid values are below.

You can't just have HTTP_HTTPS, but you can have just HTTP.

" + }, + "publicPorts":{ + "shape":"PortList", + "documentation":"

An array of public port settings for your load balancer. For HTTP, use port 80. For HTTPS, use port 443.

" + }, + "healthCheckPath":{ + "shape":"NonEmptyString", + "documentation":"

The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.

" + }, + "instancePort":{ + "shape":"integer", + "documentation":"

The port where the load balancer will direct traffic to your Lightsail instances. For HTTP traffic, it's port 80. For HTTPS traffic, it's port 443.

" + }, + "instanceHealthSummary":{ + "shape":"InstanceHealthSummaryList", + "documentation":"

An array of InstanceHealthSummary objects describing the health of the load balancer.

" + }, + "tlsCertificateSummaries":{ + "shape":"LoadBalancerTlsCertificateSummaryList", + "documentation":"

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true, the certificate is attached to the load balancer.

" + }, + "configurationOptions":{ + "shape":"LoadBalancerConfigurationOptions", + "documentation":"

A string to string map of the configuration options for your load balancer. Valid values are listed below.

" + } + }, + "documentation":"

Describes the Lightsail load balancer.

" + }, + "LoadBalancerAttributeName":{ + "type":"string", + "enum":[ + "HealthCheckPath", + "SessionStickinessEnabled", + "SessionStickiness_LB_CookieDurationSeconds" + ] + }, + "LoadBalancerConfigurationOptions":{ + "type":"map", + "key":{"shape":"LoadBalancerAttributeName"}, + "value":{"shape":"string"} + }, + "LoadBalancerList":{ + "type":"list", + "member":{"shape":"LoadBalancer"} + }, + "LoadBalancerMetricName":{ + "type":"string", + "enum":[ + "ClientTLSNegotiationErrorCount", + "HealthyHostCount", + "UnhealthyHostCount", + "HTTPCode_LB_4XX_Count", + "HTTPCode_LB_5XX_Count", + "HTTPCode_Instance_2XX_Count", + "HTTPCode_Instance_3XX_Count", + "HTTPCode_Instance_4XX_Count", + "HTTPCode_Instance_5XX_Count", + "InstanceResponseTime", + "RejectedConnectionCount", + "RequestCount" + ] + }, + "LoadBalancerProtocol":{ + "type":"string", + "enum":[ + "HTTP_HTTPS", + "HTTP" + ] + }, + "LoadBalancerState":{ + "type":"string", + "enum":[ + "active", + "provisioning", + "active_impaired", + "failed", + "unknown" + ] + }, + "LoadBalancerTlsCertificate":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the SSL/TLS certificate (e.g., my-certificate).

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The time when you created your SSL/TLS certificate.

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The AWS Region and Availability Zone where you created your certificate.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type (e.g., LoadBalancerTlsCertificate).

  • Instance - A Lightsail instance (a virtual private server)

  • StaticIp - A static IP address

  • KeyPair - The key pair used to connect to a Lightsail instance

  • InstanceSnapshot - A Lightsail instance snapshot

  • Domain - A DNS zone

  • PeeredVpc - A peered VPC

  • LoadBalancer - A Lightsail load balancer

  • LoadBalancerTlsCertificate - An SSL/TLS certificate associated with a Lightsail load balancer

  • Disk - A Lightsail block storage disk

  • DiskSnapshot - A block storage disk snapshot

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The load balancer name where your SSL/TLS certificate is attached.

" + }, + "isAttached":{ + "shape":"boolean", + "documentation":"

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

" + }, + "status":{ + "shape":"LoadBalancerTlsCertificateStatus", + "documentation":"

The status of the SSL/TLS certificate. Valid values are below.

" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

The domain name for your SSL/TLS certificate.

" + }, + "domainValidationRecords":{ + "shape":"LoadBalancerTlsCertificateDomainValidationRecordList", + "documentation":"

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

" + }, + "failureReason":{ + "shape":"LoadBalancerTlsCertificateFailureReason", + "documentation":"

The reason for the SSL/TLS certificate validation failure.

" + }, + "issuedAt":{ + "shape":"IsoDate", + "documentation":"

The time when the SSL/TLS certificate was issued.

" + }, + "issuer":{ + "shape":"NonEmptyString", + "documentation":"

The issuer of the certificate.

" + }, + "keyAlgorithm":{ + "shape":"NonEmptyString", + "documentation":"

The algorithm that was used to generate the key pair (the public and private key).

" + }, + "notAfter":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the SSL/TLS certificate expires.

" + }, + "notBefore":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the SSL/TLS certificate is first valid.

" + }, + "renewalSummary":{ + "shape":"LoadBalancerTlsCertificateRenewalSummary", + "documentation":"

An object containing information about the status of Lightsail's managed renewal for the certificate.

" + }, + "revocationReason":{ + "shape":"LoadBalancerTlsCertificateRevocationReason", + "documentation":"

The reason the certificate was revoked. Valid values are below.

" + }, + "revokedAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the SSL/TLS certificate was revoked.

" + }, + "serial":{ + "shape":"NonEmptyString", + "documentation":"

The serial number of the certificate.

" + }, + "signatureAlgorithm":{ + "shape":"NonEmptyString", + "documentation":"

The algorithm that was used to sign the certificate.

" + }, + "subject":{ + "shape":"NonEmptyString", + "documentation":"

The name of the entity that is associated with the public key contained in the certificate.

" + }, + "subjectAlternativeNames":{ + "shape":"StringList", + "documentation":"

One or more domains or subdomains 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 (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com, www.example.com, or m.example.com.

" + } + }, + "documentation":"

Describes a load balancer SSL/TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

" + }, + "LoadBalancerTlsCertificateDomainStatus":{ + "type":"string", + "enum":[ + "PENDING_VALIDATION", + "FAILED", + "SUCCESS" + ] + }, + "LoadBalancerTlsCertificateDomainValidationOption":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

The fully qualified domain name in the certificate request.

" + }, + "validationStatus":{ + "shape":"LoadBalancerTlsCertificateDomainStatus", + "documentation":"

The status of the domain validation. Valid values are listed below.

" + } + }, + "documentation":"

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

" + }, + "LoadBalancerTlsCertificateDomainValidationOptionList":{ + "type":"list", + "member":{"shape":"LoadBalancerTlsCertificateDomainValidationOption"} + }, + "LoadBalancerTlsCertificateDomainValidationRecord":{ + "type":"structure", + "members":{ + "name":{ + "shape":"NonEmptyString", + "documentation":"

A fully qualified domain name in the certificate. For example, example.com.

" + }, + "type":{ + "shape":"NonEmptyString", + "documentation":"

The type of validation record. For example, CNAME for domain validation.

" + }, + "value":{ + "shape":"NonEmptyString", + "documentation":"

The value for that type.

" + }, + "validationStatus":{ + "shape":"LoadBalancerTlsCertificateDomainStatus", + "documentation":"

The validation status. Valid values are listed below.

" + }, + "domainName":{ + "shape":"DomainName", + "documentation":"

The domain name against which your SSL/TLS certificate was validated.

" + } + }, + "documentation":"

Describes the validation record of each domain name in the SSL/TLS certificate.

" + }, + "LoadBalancerTlsCertificateDomainValidationRecordList":{ + "type":"list", + "member":{"shape":"LoadBalancerTlsCertificateDomainValidationRecord"} + }, + "LoadBalancerTlsCertificateFailureReason":{ + "type":"string", + "enum":[ + "NO_AVAILABLE_CONTACTS", + "ADDITIONAL_VERIFICATION_REQUIRED", + "DOMAIN_NOT_ALLOWED", + "INVALID_PUBLIC_DOMAIN", + "OTHER" + ] + }, + "LoadBalancerTlsCertificateList":{ + "type":"list", + "member":{"shape":"LoadBalancerTlsCertificate"} + }, + "LoadBalancerTlsCertificateRenewalStatus":{ + "type":"string", + "enum":[ + "PENDING_AUTO_RENEWAL", + "PENDING_VALIDATION", + "SUCCESS", + "FAILED" + ] + }, + "LoadBalancerTlsCertificateRenewalSummary":{ + "type":"structure", + "members":{ + "renewalStatus":{ + "shape":"LoadBalancerTlsCertificateRenewalStatus", + "documentation":"

The status of Lightsail's managed renewal of the certificate. Valid values are listed below.

" + }, + "domainValidationOptions":{ + "shape":"LoadBalancerTlsCertificateDomainValidationOptionList", + "documentation":"

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

" + } + }, + "documentation":"

Contains information about the status of Lightsail's managed renewal for the certificate.

" + }, + "LoadBalancerTlsCertificateRevocationReason":{ + "type":"string", + "enum":[ + "UNSPECIFIED", + "KEY_COMPROMISE", + "CA_COMPROMISE", + "AFFILIATION_CHANGED", + "SUPERCEDED", + "CESSATION_OF_OPERATION", + "CERTIFICATE_HOLD", + "REMOVE_FROM_CRL", + "PRIVILEGE_WITHDRAWN", + "A_A_COMPROMISE" + ] + }, + "LoadBalancerTlsCertificateStatus":{ + "type":"string", + "enum":[ + "PENDING_VALIDATION", + "ISSUED", + "INACTIVE", + "EXPIRED", + "VALIDATION_TIMED_OUT", + "REVOKED", + "FAILED", + "UNKNOWN" + ] + }, + "LoadBalancerTlsCertificateSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the SSL/TLS certificate.

" + }, + "isAttached":{ + "shape":"boolean", + "documentation":"

When true, the SSL/TLS certificate is attached to the Lightsail load balancer.

" + } + }, + "documentation":"

Provides a summary of SSL/TLS certificate metadata.

" + }, + "LoadBalancerTlsCertificateSummaryList":{ + "type":"list", + "member":{"shape":"LoadBalancerTlsCertificateSummary"} + }, + "LogEvent":{ + "type":"structure", + "members":{ + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the database log event was created.

" + }, + "message":{ + "shape":"string", + "documentation":"

The message of the database log event.

" + } + }, + "documentation":"

Describes a database log event.

" + }, + "LogEventList":{ + "type":"list", + "member":{"shape":"LogEvent"} + }, + "MetricDatapoint":{ + "type":"structure", + "members":{ + "average":{ + "shape":"double", + "documentation":"

The average.

" + }, + "maximum":{ + "shape":"double", + "documentation":"

The maximum.

" + }, + "minimum":{ + "shape":"double", + "documentation":"

The minimum.

" + }, + "sampleCount":{ + "shape":"double", + "documentation":"

The sample count.

" + }, + "sum":{ + "shape":"double", + "documentation":"

The sum.

" + }, + "timestamp":{ + "shape":"timestamp", + "documentation":"

The timestamp (e.g., 1479816991.349).

" + }, + "unit":{ + "shape":"MetricUnit", + "documentation":"

The unit.

" + } + }, + "documentation":"

Describes the metric data point.

" + }, + "MetricDatapointList":{ + "type":"list", + "member":{"shape":"MetricDatapoint"} + }, + "MetricPeriod":{ + "type":"integer", + "max":86400, + "min":60 + }, + "MetricStatistic":{ + "type":"string", + "enum":[ + "Minimum", + "Maximum", + "Sum", + "Average", + "SampleCount" + ] + }, + "MetricStatisticList":{ + "type":"list", + "member":{"shape":"MetricStatistic"} + }, + "MetricUnit":{ + "type":"string", + "enum":[ + "Seconds", + "Microseconds", + "Milliseconds", + "Bytes", + "Kilobytes", + "Megabytes", + "Gigabytes", + "Terabytes", + "Bits", + "Kilobits", + "Megabits", + "Gigabits", + "Terabits", + "Percent", + "Count", + "Bytes/Second", + "Kilobytes/Second", + "Megabytes/Second", + "Gigabytes/Second", + "Terabytes/Second", + "Bits/Second", + "Kilobits/Second", + "Megabits/Second", + "Gigabits/Second", + "Terabits/Second", + "Count/Second", + "None" + ] + }, + "MonthlyTransfer":{ + "type":"structure", + "members":{ + "gbPerMonthAllocated":{ + "shape":"integer", + "documentation":"

The amount allocated per month (in GB).

" + } + }, + "documentation":"

Describes the monthly data transfer in and out of your virtual private server (or instance).

" + }, + "NetworkProtocol":{ + "type":"string", + "enum":[ + "tcp", + "all", + "udp" + ] + }, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "code":{"shape":"string"}, + "docs":{"shape":"string"}, + "message":{"shape":"string"}, + "tip":{"shape":"string"} + }, + "documentation":"

Lightsail throws this exception when it cannot find a resource.

", + "exception":true + }, + "OpenInstancePublicPortsRequest":{ + "type":"structure", + "required":[ + "portInfo", + "instanceName" + ], + "members":{ + "portInfo":{ + "shape":"PortInfo", + "documentation":"

An array of key-value pairs containing information about the port mappings.

" + }, + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The name of the instance for which you want to open the public ports.

" + } + } + }, + "OpenInstancePublicPortsResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "Operation":{ + "type":"structure", + "members":{ + "id":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the operation.

" + }, + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The resource name.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the operation was initialized (e.g., 1479816991.349).

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The AWS Region and Availability Zone.

" + }, + "isTerminal":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the operation is terminal.

" + }, + "operationDetails":{ + "shape":"string", + "documentation":"

Details about the operation (e.g., Debian-1GB-Ohio-1).

" + }, + "operationType":{ + "shape":"OperationType", + "documentation":"

The type of operation.

" + }, + "status":{ + "shape":"OperationStatus", + "documentation":"

The status of the operation.

" + }, + "statusChangedAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the status was changed (e.g., 1479816991.349).

" + }, + "errorCode":{ + "shape":"string", + "documentation":"

The error code.

" + }, + "errorDetails":{ + "shape":"string", + "documentation":"

The error details.

" + } + }, + "documentation":"

Describes the API operation.

" + }, + "OperationFailureException":{ + "type":"structure", + "members":{ + "code":{"shape":"string"}, + "docs":{"shape":"string"}, + "message":{"shape":"string"}, + "tip":{"shape":"string"} + }, + "documentation":"

Lightsail throws this exception when an operation fails to execute.

", + "exception":true + }, + "OperationList":{ + "type":"list", + "member":{"shape":"Operation"} + }, + "OperationStatus":{ + "type":"string", + "enum":[ + "NotStarted", + "Started", + "Failed", + "Completed", + "Succeeded" + ] + }, + "OperationType":{ + "type":"string", + "enum":[ + "DeleteKnownHostKeys", + "DeleteInstance", + "CreateInstance", + "StopInstance", + "StartInstance", + "RebootInstance", + "OpenInstancePublicPorts", + "PutInstancePublicPorts", + "CloseInstancePublicPorts", + "AllocateStaticIp", + "ReleaseStaticIp", + "AttachStaticIp", + "DetachStaticIp", + "UpdateDomainEntry", + "DeleteDomainEntry", + "CreateDomain", + "DeleteDomain", + "CreateInstanceSnapshot", + "DeleteInstanceSnapshot", + "CreateInstancesFromSnapshot", + "CreateLoadBalancer", + "DeleteLoadBalancer", + "AttachInstancesToLoadBalancer", + "DetachInstancesFromLoadBalancer", + "UpdateLoadBalancerAttribute", + "CreateLoadBalancerTlsCertificate", + "DeleteLoadBalancerTlsCertificate", + "AttachLoadBalancerTlsCertificate", + "CreateDisk", + "DeleteDisk", + "AttachDisk", + "DetachDisk", + "CreateDiskSnapshot", + "DeleteDiskSnapshot", + "CreateDiskFromSnapshot", + "CreateRelationalDatabase", + "UpdateRelationalDatabase", + "DeleteRelationalDatabase", + "CreateRelationalDatabaseFromSnapshot", + "CreateRelationalDatabaseSnapshot", + "DeleteRelationalDatabaseSnapshot", + "UpdateRelationalDatabaseParameters", + "StartRelationalDatabase", + "RebootRelationalDatabase", + "StopRelationalDatabase", + "EnableAddOn", + "DisableAddOn" + ] + }, + "PasswordData":{ + "type":"structure", + "members":{ + "ciphertext":{ + "shape":"string", + "documentation":"

The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.

If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available in the password field.

If you are using a custom key pair, you need to use your own means of decryption.

If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.

" + }, + "keyPairName":{ + "shape":"ResourceName", + "documentation":"

The name of the key pair that you used when creating your instance. If no key pair name was specified when creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).

If you are using a custom key pair, you need to use your own means of decrypting your password using the ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.

" + } + }, + "documentation":"

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

" + }, + "PeerVpcRequest":{ + "type":"structure", + "members":{ + } + }, + "PeerVpcResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "action":{ + "shape":"NonEmptyString", + "documentation":"

The type of pending database maintenance action.

" + }, + "description":{ + "shape":"NonEmptyString", + "documentation":"

Additional detail about the pending database maintenance action.

" + }, + "currentApplyDate":{ + "shape":"IsoDate", + "documentation":"

The effective date of the pending database maintenance action.

" + } + }, + "documentation":"

Describes a pending database maintenance action.

" + }, + "PendingMaintenanceActionList":{ + "type":"list", + "member":{"shape":"PendingMaintenanceAction"} + }, + "PendingModifiedRelationalDatabaseValues":{ + "type":"structure", + "members":{ + "masterUserPassword":{ + "shape":"string", + "documentation":"

The password for the master user of the database.

" + }, + "engineVersion":{ + "shape":"string", + "documentation":"

The database engine version.

" + }, + "backupRetentionEnabled":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether automated backup retention is enabled.

" + } + }, + "documentation":"

Describes a pending database value modification.

" + }, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "PortAccessType":{ + "type":"string", + "enum":[ + "Public", + "Private" + ] + }, + "PortInfo":{ + "type":"structure", + "members":{ + "fromPort":{ + "shape":"Port", + "documentation":"

The first port in the range.

" + }, + "toPort":{ + "shape":"Port", + "documentation":"

The last port in the range.

" + }, + "protocol":{ + "shape":"NetworkProtocol", + "documentation":"

The protocol.

" + } + }, + "documentation":"

Describes information about the ports on your virtual private server (or instance).

" + }, + "PortInfoList":{ + "type":"list", + "member":{"shape":"PortInfo"} + }, + "PortInfoSourceType":{ + "type":"string", + "enum":[ + "DEFAULT", + "INSTANCE", + "NONE", + "CLOSED" + ] + }, + "PortList":{ + "type":"list", + "member":{"shape":"Port"} + }, + "PortState":{ + "type":"string", + "enum":[ + "open", + "closed" + ] + }, + "PutInstancePublicPortsRequest":{ + "type":"structure", + "required":[ + "portInfos", + "instanceName" + ], + "members":{ + "portInfos":{ + "shape":"PortInfoList", + "documentation":"

Specifies information about the public port(s).

" + }, + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The Lightsail instance name of the public port(s) you are setting.

" + } + } + }, + "PutInstancePublicPortsResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"

Describes metadata about the operation you just executed.

" + } + } + }, + "RebootInstanceRequest":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The name of the instance to reboot.

" + } + } + }, + "RebootInstanceResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An array of key-value pairs containing information about the request operations.

" + } + } + }, + "RebootRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database to reboot.

" + } + } + }, + "RebootRelationalDatabaseResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the result of your reboot relational database request.

" + } + } + }, + "RecordState":{ + "type":"string", + "enum":[ + "Started", + "Succeeded", + "Failed" + ] + }, + "Region":{ + "type":"structure", + "members":{ + "continentCode":{ + "shape":"string", + "documentation":"

The continent code (e.g., NA, meaning North America).

" + }, + "description":{ + "shape":"string", + "documentation":"

The description of the AWS Region (e.g., This region is recommended to serve users in the eastern United States and eastern Canada).

" + }, + "displayName":{ + "shape":"string", + "documentation":"

The display name (e.g., Ohio).

" + }, + "name":{ + "shape":"RegionName", + "documentation":"

The region name (e.g., us-east-2).

" + }, + "availabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

The Availability Zones. Follows the format us-east-2a (case-sensitive).

" + }, + "relationalDatabaseAvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

The Availability Zones for databases. Follows the format us-east-2a (case-sensitive).

" + } + }, + "documentation":"

Describes the AWS Region.

" + }, + "RegionList":{ + "type":"list", + "member":{"shape":"Region"} + }, + "RegionName":{ + "type":"string", + "enum":[ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "eu-central-1", + "ca-central-1", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ap-northeast-2" + ] + }, + "RelationalDatabase":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The unique name of the database resource in Lightsail.

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the database.

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the database was created. Formatted in Unix time.

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The Region name and Availability Zone where the database is located.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The Lightsail resource type for the database (for example, RelationalDatabase).

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "relationalDatabaseBlueprintId":{ + "shape":"NonEmptyString", + "documentation":"

The blueprint ID for the database. A blueprint describes the major engine version of a database.

" + }, + "relationalDatabaseBundleId":{ + "shape":"NonEmptyString", + "documentation":"

The bundle ID for the database. A bundle describes the performance specifications for your database.

" + }, + "masterDatabaseName":{ + "shape":"string", + "documentation":"

The name of the master database created when the Lightsail database resource is created.

" + }, + "hardware":{ + "shape":"RelationalDatabaseHardware", + "documentation":"

Describes the hardware of the database.

" + }, + "state":{ + "shape":"NonEmptyString", + "documentation":"

Describes the current state of the database.

" + }, + "secondaryAvailabilityZone":{ + "shape":"string", + "documentation":"

Describes the secondary Availability Zone of a high availability database.

The secondary database is used for failover support of a high availability database.

" + }, + "backupRetentionEnabled":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether automated backup retention is enabled for the database.

" + }, + "pendingModifiedValues":{ + "shape":"PendingModifiedRelationalDatabaseValues", + "documentation":"

Describes pending database value modifications.

" + }, + "engine":{ + "shape":"NonEmptyString", + "documentation":"

The database software (for example, MySQL).

" + }, + "engineVersion":{ + "shape":"NonEmptyString", + "documentation":"

The database engine version (for example, 5.7.23).

" + }, + "latestRestorableTime":{ + "shape":"IsoDate", + "documentation":"

The latest point in time to which the database can be restored. Formatted in Unix time.

" + }, + "masterUsername":{ + "shape":"NonEmptyString", + "documentation":"

The master user name of the database.

" + }, + "parameterApplyStatus":{ + "shape":"NonEmptyString", + "documentation":"

The status of parameter updates for the database.

" + }, + "preferredBackupWindow":{ + "shape":"NonEmptyString", + "documentation":"

The daily time range during which automated backups are created for the database (for example, 16:00-16:30).

" + }, + "preferredMaintenanceWindow":{ + "shape":"NonEmptyString", + "documentation":"

The weekly time range during which system maintenance can occur on the database.

In the format ddd:hh24:mi-ddd:hh24:mi. For example, Tue:17:00-Tue:17:30.

" + }, + "publiclyAccessible":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the database is publicly accessible.

" + }, + "masterEndpoint":{ + "shape":"RelationalDatabaseEndpoint", + "documentation":"

The master endpoint for the database.

" + }, + "pendingMaintenanceActions":{ + "shape":"PendingMaintenanceActionList", + "documentation":"

Describes the pending maintenance actions for the database.

" + } + }, + "documentation":"

Describes a database.

" + }, + "RelationalDatabaseBlueprint":{ + "type":"structure", + "members":{ + "blueprintId":{ + "shape":"string", + "documentation":"

The ID for the database blueprint.

" + }, + "engine":{ + "shape":"RelationalDatabaseEngine", + "documentation":"

The database software of the database blueprint (for example, MySQL).

" + }, + "engineVersion":{ + "shape":"string", + "documentation":"

The database engine version for the database blueprint (for example, 5.7.23).

" + }, + "engineDescription":{ + "shape":"string", + "documentation":"

The description of the database engine for the database blueprint.

" + }, + "engineVersionDescription":{ + "shape":"string", + "documentation":"

The description of the database engine version for the database blueprint.

" + }, + "isEngineDefault":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the engine version is the default for the database blueprint.

" + } + }, + "documentation":"

Describes a database image, or blueprint. A blueprint describes the major engine version of a database.

" + }, + "RelationalDatabaseBlueprintList":{ + "type":"list", + "member":{"shape":"RelationalDatabaseBlueprint"} + }, + "RelationalDatabaseBundle":{ + "type":"structure", + "members":{ + "bundleId":{ + "shape":"string", + "documentation":"

The ID for the database bundle.

" + }, + "name":{ + "shape":"string", + "documentation":"

The name for the database bundle.

" + }, + "price":{ + "shape":"float", + "documentation":"

The cost of the database bundle in US currency.

" + }, + "ramSizeInGb":{ + "shape":"float", + "documentation":"

The amount of RAM in GB (for example, 2.0) for the database bundle.

" + }, + "diskSizeInGb":{ + "shape":"integer", + "documentation":"

The size of the disk for the database bundle.

" + }, + "transferPerMonthInGb":{ + "shape":"integer", + "documentation":"

The data transfer rate per month in GB for the database bundle.

" + }, + "cpuCount":{ + "shape":"integer", + "documentation":"

The number of virtual CPUs (vCPUs) for the database bundle.

" + }, + "isEncrypted":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the database bundle is encrypted.

" + }, + "isActive":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the database bundle is active.

" + } + }, + "documentation":"

Describes a database bundle. A bundle describes the performance specifications of the database.

" + }, + "RelationalDatabaseBundleList":{ + "type":"list", + "member":{"shape":"RelationalDatabaseBundle"} + }, + "RelationalDatabaseEndpoint":{ + "type":"structure", + "members":{ + "port":{ + "shape":"integer", + "documentation":"

Specifies the port that the database is listening on.

" + }, + "address":{ + "shape":"NonEmptyString", + "documentation":"

Specifies the DNS address of the database.

" + } + }, + "documentation":"

Describes an endpoint for a database.

" + }, + "RelationalDatabaseEngine":{ + "type":"string", + "enum":["mysql"] + }, + "RelationalDatabaseEvent":{ + "type":"structure", + "members":{ + "resource":{ + "shape":"ResourceName", + "documentation":"

The database that the database event relates to.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the database event was created.

" + }, + "message":{ + "shape":"string", + "documentation":"

The message of the database event.

" + }, + "eventCategories":{ + "shape":"StringList", + "documentation":"

The category that the database event belongs to.

" + } + }, + "documentation":"

Describes an event for a database.

" + }, + "RelationalDatabaseEventList":{ + "type":"list", + "member":{"shape":"RelationalDatabaseEvent"} + }, + "RelationalDatabaseHardware":{ + "type":"structure", + "members":{ + "cpuCount":{ + "shape":"integer", + "documentation":"

The number of vCPUs for the database.

" + }, + "diskSizeInGb":{ + "shape":"integer", + "documentation":"

The size of the disk for the database.

" + }, + "ramSizeInGb":{ + "shape":"float", + "documentation":"

The amount of RAM in GB for the database.

" + } + }, + "documentation":"

Describes the hardware of a database.

" + }, + "RelationalDatabaseList":{ + "type":"list", + "member":{"shape":"RelationalDatabase"} + }, + "RelationalDatabaseMetricName":{ + "type":"string", + "enum":[ + "CPUUtilization", + "DatabaseConnections", + "DiskQueueDepth", + "FreeStorageSpace", + "NetworkReceiveThroughput", + "NetworkTransmitThroughput" + ] + }, + "RelationalDatabaseParameter":{ + "type":"structure", + "members":{ + "allowedValues":{ + "shape":"string", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "applyMethod":{ + "shape":"string", + "documentation":"

Indicates when parameter updates are applied.

Can be immediate or pending-reboot.

" + }, + "applyType":{ + "shape":"string", + "documentation":"

Specifies the engine-specific parameter type.

" + }, + "dataType":{ + "shape":"string", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "description":{ + "shape":"string", + "documentation":"

Provides a description of the parameter.

" + }, + "isModifiable":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the parameter can be modified.

" + }, + "parameterName":{ + "shape":"string", + "documentation":"

Specifies the name of the parameter.

" + }, + "parameterValue":{ + "shape":"string", + "documentation":"

Specifies the value of the parameter.

" + } + }, + "documentation":"

Describes the parameters of a database.

" + }, + "RelationalDatabaseParameterList":{ + "type":"list", + "member":{"shape":"RelationalDatabaseParameter"} + }, + "RelationalDatabasePasswordVersion":{ + "type":"string", + "enum":[ + "CURRENT", + "PREVIOUS", + "PENDING" + ] + }, + "RelationalDatabaseSnapshot":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the database snapshot.

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the database snapshot.

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code for the database snapshot. Include this code in your email to support when you have questions about a database snapshot in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the database snapshot was created.

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The Region name and Availability Zone where the database snapshot is located.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The Lightsail resource type.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys and optional values for the resource. For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "engine":{ + "shape":"NonEmptyString", + "documentation":"

The software of the database snapshot (for example, MySQL)

" + }, + "engineVersion":{ + "shape":"NonEmptyString", + "documentation":"

The database engine version for the database snapshot (for example, 5.7.23).

" + }, + "sizeInGb":{ + "shape":"integer", + "documentation":"

The size of the disk in GB (for example, 32) for the database snapshot.

" + }, + "state":{ + "shape":"NonEmptyString", + "documentation":"

The state of the database snapshot.

" + }, + "fromRelationalDatabaseName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the source database from which the database snapshot was created.

" + }, + "fromRelationalDatabaseArn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the database from which the database snapshot was created.

" + }, + "fromRelationalDatabaseBundleId":{ + "shape":"string", + "documentation":"

The bundle ID of the database from which the database snapshot was created.

" + }, + "fromRelationalDatabaseBlueprintId":{ + "shape":"string", + "documentation":"

The blueprint ID of the database from which the database snapshot was created. A blueprint describes the major engine version of a database.

" + } + }, + "documentation":"

Describes a database snapshot.

" + }, + "RelationalDatabaseSnapshotList":{ + "type":"list", + "member":{"shape":"RelationalDatabaseSnapshot"} + }, + "ReleaseStaticIpRequest":{ + "type":"structure", + "required":["staticIpName"], + "members":{ + "staticIpName":{ + "shape":"ResourceName", + "documentation":"

The name of the static IP to delete.

" + } + } + }, + "ReleaseStaticIpResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "ResourceArn":{ + "type":"string", + "pattern":"^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$" + }, + "ResourceLocation":{ + "type":"structure", + "members":{ + "availabilityZone":{ + "shape":"string", + "documentation":"

The Availability Zone. Follows the format us-east-2a (case-sensitive).

" + }, + "regionName":{ + "shape":"RegionName", + "documentation":"

The AWS Region name.

" + } + }, + "documentation":"

Describes the resource location.

" + }, + "ResourceName":{ + "type":"string", + "pattern":"\\w[\\w\\-]*\\w" + }, + "ResourceNameList":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ResourceType":{ + "type":"string", + "enum":[ + "Instance", + "StaticIp", + "KeyPair", + "InstanceSnapshot", + "Domain", + "PeeredVpc", + "LoadBalancer", + "LoadBalancerTlsCertificate", + "Disk", + "DiskSnapshot", + "RelationalDatabase", + "RelationalDatabaseSnapshot", + "ExportSnapshotRecord", + "CloudFormationStackRecord" + ] + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "ServiceException":{ + "type":"structure", + "members":{ + "code":{"shape":"string"}, + "docs":{"shape":"string"}, + "message":{"shape":"string"}, + "tip":{"shape":"string"} + }, + "documentation":"

A general service exception.

", + "exception":true, + "fault":true + }, + "StartInstanceRequest":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The name of the instance (a virtual private server) to start.

" + } + } + }, + "StartInstanceResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "StartRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database to start.

" + } + } + }, + "StartRelationalDatabaseResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the result of your start relational database request.

" + } + } + }, + "StaticIp":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ResourceName", + "documentation":"

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).

" + }, + "arn":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).

" + }, + "supportCode":{ + "shape":"string", + "documentation":"

The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.

" + }, + "createdAt":{ + "shape":"IsoDate", + "documentation":"

The timestamp when the static IP was created (e.g., 1479735304.222).

" + }, + "location":{ + "shape":"ResourceLocation", + "documentation":"

The region and Availability Zone where the static IP was created.

" + }, + "resourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type (usually StaticIp).

" + }, + "ipAddress":{ + "shape":"IpAddress", + "documentation":"

The static IP address.

" + }, + "attachedTo":{ + "shape":"ResourceName", + "documentation":"

The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).

" + }, + "isAttached":{ + "shape":"boolean", + "documentation":"

A Boolean value indicating whether the static IP is attached.

" + } + }, + "documentation":"

Describes the static IP.

" + }, + "StaticIpList":{ + "type":"list", + "member":{"shape":"StaticIp"} + }, + "StopInstanceRequest":{ + "type":"structure", + "required":["instanceName"], + "members":{ + "instanceName":{ + "shape":"ResourceName", + "documentation":"

The name of the instance (a virtual private server) to stop.

" + }, + "force":{ + "shape":"boolean", + "documentation":"

When set to True, forces a Lightsail instance that is stuck in a stopping state to stop.

Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request.

" + } + } + }, + "StopInstanceResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "StopRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database to stop.

" + }, + "relationalDatabaseSnapshotName":{ + "shape":"ResourceName", + "documentation":"

The name of your new database snapshot to be created before stopping your database.

" + } + } + }, + "StopRelationalDatabaseResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the result of your stop relational database request.

" + } + } + }, + "StringList":{ + "type":"list", + "member":{"shape":"string"} + }, + "StringMax256":{ + "type":"string", + "max":256, + "min":1 + }, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

" + }, + "value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

" + } + }, + "documentation":"

Describes a tag key and optional value assigned to an Amazon Lightsail resource.

For more information about tags in Lightsail, see the Lightsail Dev Guide.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceName", + "tags" + ], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the resource to which you are adding tags.

" + }, + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource to which you want to add a tag.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag key and optional value.

" + } + } + }, + "TagResourceResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

A list of objects describing the API operation.

" + } + } + }, + "TagValue":{"type":"string"}, + "TimeOfDay":{ + "type":"string", + "pattern":"^(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$" + }, + "UnauthenticatedException":{ + "type":"structure", + "members":{ + "code":{"shape":"string"}, + "docs":{"shape":"string"}, + "message":{"shape":"string"}, + "tip":{"shape":"string"} + }, + "documentation":"

Lightsail throws this exception when the user has not been authenticated.

", + "exception":true + }, + "UnpeerVpcRequest":{ + "type":"structure", + "members":{ + } + }, + "UnpeerVpcResult":{ + "type":"structure", + "members":{ + "operation":{ + "shape":"Operation", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceName", + "tagKeys" + ], + "members":{ + "resourceName":{ + "shape":"ResourceName", + "documentation":"

The name of the resource from which you are removing a tag.

" + }, + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.

" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tag keys to delete from the specified resource.

" + } + } + }, + "UntagResourceResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

A list of objects describing the API operation.

" + } + } + }, + "UpdateDomainEntryRequest":{ + "type":"structure", + "required":[ + "domainName", + "domainEntry" + ], + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

The name of the domain recordset to update.

" + }, + "domainEntry":{ + "shape":"DomainEntry", + "documentation":"

An array of key-value pairs containing information about the domain entry.

" + } + } + }, + "UpdateDomainEntryResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An array of key-value pairs containing information about the request operation.

" + } + } + }, + "UpdateLoadBalancerAttributeRequest":{ + "type":"structure", + "required":[ + "loadBalancerName", + "attributeName", + "attributeValue" + ], + "members":{ + "loadBalancerName":{ + "shape":"ResourceName", + "documentation":"

The name of the load balancer that you want to modify (e.g., my-load-balancer.

" + }, + "attributeName":{ + "shape":"LoadBalancerAttributeName", + "documentation":"

The name of the attribute you want to update. Valid values are below.

" + }, + "attributeValue":{ + "shape":"StringMax256", + "documentation":"

The value that you want to specify for the attribute name.

" + } + } + }, + "UpdateLoadBalancerAttributeResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the API operations.

" + } + } + }, + "UpdateRelationalDatabaseParametersRequest":{ + "type":"structure", + "required":[ + "relationalDatabaseName", + "parameters" + ], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database for which to update parameters.

" + }, + "parameters":{ + "shape":"RelationalDatabaseParameterList", + "documentation":"

The database parameters to update.

" + } + } + }, + "UpdateRelationalDatabaseParametersResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the result of your update relational database parameters request.

" + } + } + }, + "UpdateRelationalDatabaseRequest":{ + "type":"structure", + "required":["relationalDatabaseName"], + "members":{ + "relationalDatabaseName":{ + "shape":"ResourceName", + "documentation":"

The name of your database to update.

" + }, + "masterUserPassword":{ + "shape":"SensitiveString", + "documentation":"

The password for the master user of your database. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain 8 to 41 characters.

" + }, + "rotateMasterUserPassword":{ + "shape":"boolean", + "documentation":"

When true, the master user password is changed to a new strong password generated by Lightsail.

Use the get relational database master user password operation to get the new password.

" + }, + "preferredBackupWindow":{ + "shape":"string", + "documentation":"

The daily time range during which automated backups are created for your database if automated backups are enabled.

Constraints:

  • Must be in the hh24:mi-hh24:mi format.

    Example: 16:00-16:30

  • Specified in Coordinated Universal Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "preferredMaintenanceWindow":{ + "shape":"string", + "documentation":"

The weekly time range during which system maintenance can occur on your database.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Constraints:

  • Must be in the ddd:hh24:mi-ddd:hh24:mi format.

  • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

  • Must be at least 30 minutes.

  • Specified in Coordinated Universal Time (UTC).

  • Example: Tue:17:00-Tue:17:30

" + }, + "enableBackupRetention":{ + "shape":"boolean", + "documentation":"

When true, enables automated backup retention for your database.

Updates are applied during the next maintenance window because this can result in an outage.

" + }, + "disableBackupRetention":{ + "shape":"boolean", + "documentation":"

When true, disables automated backup retention for your database.

Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the create relational database snapshot operation.

Updates are applied during the next maintenance window because this can result in an outage.

" + }, + "publiclyAccessible":{ + "shape":"boolean", + "documentation":"

Specifies the accessibility options for your database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.

" + }, + "applyImmediately":{ + "shape":"boolean", + "documentation":"

When true, applies changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

Default: false

" + } + } + }, + "UpdateRelationalDatabaseResult":{ + "type":"structure", + "members":{ + "operations":{ + "shape":"OperationList", + "documentation":"

An object describing the result of your update relational database request.

" + } + } + }, + "boolean":{"type":"boolean"}, + "double":{"type":"double"}, + "float":{"type":"float"}, + "integer":{"type":"integer"}, + "string":{"type":"string"}, + "timestamp":{"type":"timestamp"} + }, + "documentation":"

Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, a managed database, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).

For more information about Lightsail concepts and tasks, see the Lightsail Dev Guide.

To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the Lightsail Dev Guide.

" +} diff --git a/aws/dist/botocore/data/logs/2014-03-28/examples-1.json b/aws/dist/botocore/data/logs/2014-03-28/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/logs/2014-03-28/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/logs/2014-03-28/paginators-1.json b/aws/dist/botocore/data/logs/2014-03-28/paginators-1.json new file mode 100644 index 00000000..c5c1645f --- /dev/null +++ b/aws/dist/botocore/data/logs/2014-03-28/paginators-1.json @@ -0,0 +1,61 @@ +{ + "pagination": { + "DescribeDestinations": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "destinations" + }, + "DescribeLogGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logGroups" + }, + "DescribeLogStreams": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "logStreams" + }, + "DescribeMetricFilters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "metricFilters" + }, + "DescribeSubscriptionFilters": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": "subscriptionFilters" + }, + "FilterLogEvents": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "limit", + "result_key": [ + "events", + "searchedLogStreams" + ] + }, + "DescribeExportTasks": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "exportTasks" + }, + "DescribeQueries": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "queries" + }, + "DescribeResourcePolicies": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "resourcePolicies" + } + } +} diff --git a/aws/dist/botocore/data/logs/2014-03-28/service-2.json b/aws/dist/botocore/data/logs/2014-03-28/service-2.json new file mode 100644 index 00000000..6475f815 --- /dev/null +++ b/aws/dist/botocore/data/logs/2014-03-28/service-2.json @@ -0,0 +1,2444 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-03-28", + "endpointPrefix":"logs", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon CloudWatch Logs", + "serviceId":"CloudWatch Logs", + "signatureVersion":"v4", + "targetPrefix":"Logs_20140328", + "uid":"logs-2014-03-28" + }, + "operations":{ + "AssociateKmsKey":{ + "name":"AssociateKmsKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateKmsKeyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Associates the specified AWS Key Management Service (AWS KMS) customer master key (CMK) with the specified log group.

Associating an AWS KMS CMK with a log group overrides any existing associations between the log group and a CMK. After a CMK is associated with a log group, all newly ingested data for the log group is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

Note that it can take up to 5 minutes for this operation to take effect.

If you attempt to associate a CMK with a log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

" + }, + "CancelExportTask":{ + "name":"CancelExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelExportTaskRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidOperationException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Cancels the specified export task.

The task must be in the PENDING or RUNNING state.

" + }, + "CreateExportTask":{ + "name":"CreateExportTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExportTaskRequest"}, + "output":{"shape":"CreateExportTaskResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

Creates an export task, which allows you to efficiently export data from a log group to an Amazon S3 bucket.

This is an asynchronous call. If all the required information is provided, this operation initiates an export task and responds with the ID of the task. After the task has started, you can use DescribeExportTasks to get the status of the export task. Each account can only have one active (RUNNING or PENDING) export task at a time. To cancel an export task, use CancelExportTask.

You can export logs from multiple log groups or multiple time ranges to the same S3 bucket. To separate out log data for each export task, you can specify a prefix to be used as the Amazon S3 key prefix for all exported objects.

Exporting to S3 buckets that are encrypted with AES-256 is supported. Exporting to S3 buckets encrypted with SSE-KMS is not supported.

" + }, + "CreateLogGroup":{ + "name":"CreateLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a log group with the specified name.

You can create up to 5000 log groups per account.

You must use the following guidelines when naming a log group:

  • Log group names must be unique within a region for an AWS account.

  • Log group names can be between 1 and 512 characters long.

  • Log group names consist of the following characters: a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

If you associate a AWS Key Management Service (AWS KMS) customer master key (CMK) with the log group, ingested data is encrypted using the CMK. This association is stored as long as the data encrypted with the CMK is still within Amazon CloudWatch Logs. This enables Amazon CloudWatch Logs to decrypt this data whenever it is requested.

If you attempt to associate a CMK with the log group but the CMK does not exist or the CMK is disabled, you will receive an InvalidParameterException error.

" + }, + "CreateLogStream":{ + "name":"CreateLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLogStreamRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates a log stream for the specified log group.

There is no limit on the number of log streams that you can create for a log group.

You must use the following guidelines when naming a log stream:

  • Log stream names must be unique within the log group.

  • Log stream names can be between 1 and 512 characters long.

  • The ':' (colon) and '*' (asterisk) characters are not allowed.

" + }, + "DeleteDestination":{ + "name":"DeleteDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDestinationRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified destination, and eventually disables all the subscription filters that publish to it. This operation does not delete the physical resource encapsulated by the destination.

" + }, + "DeleteLogGroup":{ + "name":"DeleteLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogGroupRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified log group and permanently deletes all the archived log events associated with the log group.

" + }, + "DeleteLogStream":{ + "name":"DeleteLogStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLogStreamRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified log stream and permanently deletes all the archived log events associated with the log stream.

" + }, + "DeleteMetricFilter":{ + "name":"DeleteMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMetricFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified metric filter.

" + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes a resource policy from this account. This revokes the access of the identities in that policy to put log events to this account.

" + }, + "DeleteRetentionPolicy":{ + "name":"DeleteRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRetentionPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified retention policy.

Log events do not expire if they belong to log groups without a retention policy.

" + }, + "DeleteSubscriptionFilter":{ + "name":"DeleteSubscriptionFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubscriptionFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Deletes the specified subscription filter.

" + }, + "DescribeDestinations":{ + "name":"DescribeDestinations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDestinationsRequest"}, + "output":{"shape":"DescribeDestinationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists all your destinations. The results are ASCII-sorted by destination name.

" + }, + "DescribeExportTasks":{ + "name":"DescribeExportTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExportTasksRequest"}, + "output":{"shape":"DescribeExportTasksResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

" + }, + "DescribeLogGroups":{ + "name":"DescribeLogGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogGroupsRequest"}, + "output":{"shape":"DescribeLogGroupsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the specified log groups. You can list all your log groups or filter the results by prefix. The results are ASCII-sorted by log group name.

" + }, + "DescribeLogStreams":{ + "name":"DescribeLogStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLogStreamsRequest"}, + "output":{"shape":"DescribeLogStreamsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the log streams for the specified log group. You can list all the log streams or filter the results by prefix. You can also control how the results are ordered.

This operation has a limit of five transactions per second, after which transactions are throttled.

" + }, + "DescribeMetricFilters":{ + "name":"DescribeMetricFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMetricFiltersRequest"}, + "output":{"shape":"DescribeMetricFiltersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the specified metric filters. You can list all the metric filters or filter the results by log name, prefix, metric name, or metric namespace. The results are ASCII-sorted by filter name.

" + }, + "DescribeQueries":{ + "name":"DescribeQueries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeQueriesRequest"}, + "output":{"shape":"DescribeQueriesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns a list of CloudWatch Logs Insights queries that are scheduled, executing, or have been executed recently in this account. You can request all queries, or limit it to queries of a specific log group or queries with a certain status.

" + }, + "DescribeResourcePolicies":{ + "name":"DescribeResourcePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourcePoliciesRequest"}, + "output":{"shape":"DescribeResourcePoliciesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the resource policies in this account.

" + }, + "DescribeSubscriptionFilters":{ + "name":"DescribeSubscriptionFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubscriptionFiltersRequest"}, + "output":{"shape":"DescribeSubscriptionFiltersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

" + }, + "DisassociateKmsKey":{ + "name":"DisassociateKmsKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateKmsKeyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Disassociates the associated AWS Key Management Service (AWS KMS) customer master key (CMK) from the specified log group.

After the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested.

Note that it can take up to 5 minutes for this operation to take effect.

" + }, + "FilterLogEvents":{ + "name":"FilterLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FilterLogEventsRequest"}, + "output":{"shape":"FilterLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

" + }, + "GetLogEvents":{ + "name":"GetLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogEventsRequest"}, + "output":{"shape":"GetLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

" + }, + "GetLogGroupFields":{ + "name":"GetLogGroupFields", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogGroupFieldsRequest"}, + "output":{"shape":"GetLogGroupFieldsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns a list of the fields that are included in log events in the specified log group, along with the percentage of log events that contain each field. The search is limited to a time period that you specify.

In the results, fields that start with @ are fields generated by CloudWatch Logs. For example, @timestamp is the timestamp of each log event.

The response results are sorted by the frequency percentage, starting with the highest percentage.

" + }, + "GetLogRecord":{ + "name":"GetLogRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLogRecordRequest"}, + "output":{"shape":"GetLogRecordResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Retrieves all the fields and values of a single log event. All fields are retrieved, even if the original query that produced the logRecordPointer retrieved only a subset of fields. Fields are returned as field name/field value pairs.

Additionally, the entire unparsed log event is returned within @message.

" + }, + "GetQueryResults":{ + "name":"GetQueryResults", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueryResultsRequest"}, + "output":{"shape":"GetQueryResultsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Returns the results from the specified query.

Only the fields requested in the query are returned, along with a @ptr field which is the identifier for the log record. You can use the value of @ptr in a operation to get the full log record.

GetQueryResults does not start a query execution. To run a query, use .

If the value of the Status field in the output is Running, this operation returns only partial results. If you see a value of Scheduled or Running for the status, you can retry the operation later to see the final results.

" + }, + "ListTagsLogGroup":{ + "name":"ListTagsLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsLogGroupRequest"}, + "output":{"shape":"ListTagsLogGroupResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Lists the tags for the specified log group.

" + }, + "PutDestination":{ + "name":"PutDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDestinationRequest"}, + "output":{"shape":"PutDestinationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates or updates a destination. A destination encapsulates a physical resource (such as an Amazon Kinesis stream) and enables you to subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents. A destination can be an Amazon Kinesis stream, Amazon Kinesis Data Firehose strea, or an AWS Lambda function.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

" + }, + "PutDestinationPolicy":{ + "name":"PutDestinationPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutDestinationPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates or updates an access policy associated with an existing destination. An access policy is an IAM policy document that is used to authorize claims to register a subscription filter against a given destination.

" + }, + "PutLogEvents":{ + "name":"PutLogEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLogEventsRequest"}, + "output":{"shape":"PutLogEventsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidSequenceTokenException"}, + {"shape":"DataAlreadyAcceptedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnrecognizedClientException"} + ], + "documentation":"

Uploads a batch of log events to the specified log stream.

You must include the sequence token obtained from the response of the previous call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

The batch of events must satisfy the following constraints:

  • The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

  • None of the log events in the batch can be more than 2 hours in the future.

  • None of the log events in the batch can be older than 14 days or older than the retention period of the log group.

  • The log events in the batch must be in chronological ordered by their timestamp. The timestamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)

  • The maximum number of log events in a batch is 10,000.

  • A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.

If a call to PutLogEvents returns \"UnrecognizedClientException\" the most likely cause is an invalid AWS access key ID or secret key.

" + }, + "PutMetricFilter":{ + "name":"PutMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMetricFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates or updates a metric filter and associates it with the specified log group. Metric filters allow you to configure rules to extract metric data from log events ingested through PutLogEvents.

The maximum number of metric filters that can be associated with a log group is 100.

" + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates or updates a resource policy allowing other AWS services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per region.

" + }, + "PutRetentionPolicy":{ + "name":"PutRetentionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutRetentionPolicyRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Sets the retention of the specified log group. A retention policy allows you to configure the number of days for which to retain log events in the specified log group.

" + }, + "PutSubscriptionFilter":{ + "name":"PutSubscriptionFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSubscriptionFilterRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationAbortedException"}, + {"shape":"LimitExceededException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Creates or updates a subscription filter and associates it with the specified log group. Subscription filters allow you to subscribe to a real-time stream of log events ingested through PutLogEvents and have them delivered to a specific destination. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination that belongs to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream that belongs to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function that belongs to the same account as the subscription filter, for same-account delivery.

There can only be one subscription filter associated with a log group. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group.

" + }, + "StartQuery":{ + "name":"StartQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartQueryRequest"}, + "output":{"shape":"StartQueryResponse"}, + "errors":[ + {"shape":"MalformedQueryException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Schedules a query of a log group using CloudWatch Logs Insights. You specify the log group and time range to query, and the query string to use.

For more information, see CloudWatch Logs Insights Query Syntax.

Queries time out after 15 minutes of execution. If your queries are timing out, reduce the time range being searched, or partition your query into a number of queries.

" + }, + "StopQuery":{ + "name":"StopQuery", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopQueryRequest"}, + "output":{"shape":"StopQueryResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Stops a CloudWatch Logs Insights query that is in progress. If the query has already ended, the operation returns an error indicating that the specified query is not running.

" + }, + "TagLogGroup":{ + "name":"TagLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagLogGroupRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

Adds or updates the specified tags for the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To remove tags, use UntagLogGroup.

For more information about tags, see Tag Log Groups in Amazon CloudWatch Logs in the Amazon CloudWatch Logs User Guide.

" + }, + "TestMetricFilter":{ + "name":"TestMetricFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestMetricFilterRequest"}, + "output":{"shape":"TestMetricFilterResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

" + }, + "UntagLogGroup":{ + "name":"UntagLogGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagLogGroupRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes the specified tags from the specified log group.

To list the tags for a log group, use ListTagsLogGroup. To add tags, use UntagLogGroup.

" + } + }, + "shapes":{ + "AccessPolicy":{ + "type":"string", + "min":1 + }, + "Arn":{"type":"string"}, + "AssociateKmsKeyRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "kmsKeyId" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

" + } + } + }, + "CancelExportTaskRequest":{ + "type":"structure", + "required":["taskId"], + "members":{ + "taskId":{ + "shape":"ExportTaskId", + "documentation":"

The ID of the export task.

" + } + } + }, + "CreateExportTaskRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "from", + "to", + "destination" + ], + "members":{ + "taskName":{ + "shape":"ExportTaskName", + "documentation":"

The name of the export task.

" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamNamePrefix":{ + "shape":"LogStreamName", + "documentation":"

Export only log streams that match the provided prefix. If you don't specify a value, no prefix filter is applied.

" + }, + "from":{ + "shape":"Timestamp", + "documentation":"

The start time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp earlier than this time are not exported.

" + }, + "to":{ + "shape":"Timestamp", + "documentation":"

The end time of the range for the request, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

" + }, + "destination":{ + "shape":"ExportDestinationBucket", + "documentation":"

The name of S3 bucket for the exported log data. The bucket must be in the same AWS region.

" + }, + "destinationPrefix":{ + "shape":"ExportDestinationPrefix", + "documentation":"

The prefix used as the start of the key for every object exported. If you don't specify a value, the default is exportedlogs.

" + } + } + }, + "CreateExportTaskResponse":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"ExportTaskId", + "documentation":"

The ID of the export task.

" + } + } + }, + "CreateLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data. For more information, see Amazon Resource Names - AWS Key Management Service (AWS KMS).

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The key-value pairs to use for the tags.

" + } + } + }, + "CreateLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + } + } + }, + "DataAlreadyAcceptedException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "documentation":"

The event was already logged.

", + "exception":true + }, + "Days":{ + "type":"integer", + "documentation":"

The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, and 3653.

" + }, + "DefaultValue":{"type":"double"}, + "DeleteDestinationRequest":{ + "type":"structure", + "required":["destinationName"], + "members":{ + "destinationName":{ + "shape":"DestinationName", + "documentation":"

The name of the destination.

" + } + } + }, + "DeleteLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + } + } + }, + "DeleteLogStreamRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + } + } + }, + "DeleteMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterName":{ + "shape":"FilterName", + "documentation":"

The name of the metric filter.

" + } + } + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the policy to be revoked. This parameter is required.

" + } + } + }, + "DeleteRetentionPolicyRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + } + } + }, + "DeleteSubscriptionFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterName":{ + "shape":"FilterName", + "documentation":"

The name of the subscription filter.

" + } + } + }, + "Descending":{"type":"boolean"}, + "DescribeDestinationsRequest":{ + "type":"structure", + "members":{ + "DestinationNamePrefix":{ + "shape":"DestinationName", + "documentation":"

The prefix to match. If you don't specify a value, no prefix filter is applied.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + } + }, + "DescribeDestinationsResponse":{ + "type":"structure", + "members":{ + "destinations":{ + "shape":"Destinations", + "documentation":"

The destinations.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeExportTasksRequest":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"ExportTaskId", + "documentation":"

The ID of the export task. Specifying a task ID filters the results to zero or one export tasks.

" + }, + "statusCode":{ + "shape":"ExportTaskStatusCode", + "documentation":"

The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + } + }, + "DescribeExportTasksResponse":{ + "type":"structure", + "members":{ + "exportTasks":{ + "shape":"ExportTasks", + "documentation":"

The export tasks.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeLimit":{ + "type":"integer", + "max":50, + "min":1 + }, + "DescribeLogGroupsRequest":{ + "type":"structure", + "members":{ + "logGroupNamePrefix":{ + "shape":"LogGroupName", + "documentation":"

The prefix to match.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + } + }, + "DescribeLogGroupsResponse":{ + "type":"structure", + "members":{ + "logGroups":{ + "shape":"LogGroups", + "documentation":"

The log groups.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeLogStreamsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamNamePrefix":{ + "shape":"LogStreamName", + "documentation":"

The prefix to match.

If orderBy is LastEventTime,you cannot specify this parameter.

" + }, + "orderBy":{ + "shape":"OrderBy", + "documentation":"

If the value is LogStreamName, the results are ordered by log stream name. If the value is LastEventTime, the results are ordered by the event time. The default value is LogStreamName.

If you order the results by event time, you cannot specify the logStreamNamePrefix parameter.

lastEventTimestamp represents the time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. lastEventTimeStamp updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

" + }, + "descending":{ + "shape":"Descending", + "documentation":"

If the value is true, results are returned in descending order. If the value is to false, results are returned in ascending order. The default value is false.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + } + }, + "DescribeLogStreamsResponse":{ + "type":"structure", + "members":{ + "logStreams":{ + "shape":"LogStreams", + "documentation":"

The log streams.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeMetricFiltersRequest":{ + "type":"structure", + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterNamePrefix":{ + "shape":"FilterName", + "documentation":"

The prefix to match.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + }, + "metricName":{ + "shape":"MetricName", + "documentation":"

Filters results to include only those with the specified metric name. If you include this parameter in your request, you must also include the metricNamespace parameter.

" + }, + "metricNamespace":{ + "shape":"MetricNamespace", + "documentation":"

Filters results to include only those in the specified namespace. If you include this parameter in your request, you must also include the metricName parameter.

" + } + } + }, + "DescribeMetricFiltersResponse":{ + "type":"structure", + "members":{ + "metricFilters":{ + "shape":"MetricFilters", + "documentation":"

The metric filters.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeQueriesMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "DescribeQueriesRequest":{ + "type":"structure", + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

Limits the returned queries to only those for the specified log group.

" + }, + "status":{ + "shape":"QueryStatus", + "documentation":"

Limits the returned queries to only those that have the specified status. Valid values are Cancelled, Complete, Failed, Running, and Scheduled.

" + }, + "maxResults":{ + "shape":"DescribeQueriesMaxResults", + "documentation":"

Limits the number of returned queries to the specified number.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeQueriesResponse":{ + "type":"structure", + "members":{ + "queries":{ + "shape":"QueryInfoList", + "documentation":"

The list of queries that match the request.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeResourcePoliciesRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"NextToken"}, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of resource policies to be displayed with one call of this API.

" + } + } + }, + "DescribeResourcePoliciesResponse":{ + "type":"structure", + "members":{ + "resourcePolicies":{ + "shape":"ResourcePolicies", + "documentation":"

The resource policies that exist in this account.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "DescribeSubscriptionFiltersRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterNamePrefix":{ + "shape":"FilterName", + "documentation":"

The prefix to match. If you don't specify a value, no prefix filter is applied.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"DescribeLimit", + "documentation":"

The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

" + } + } + }, + "DescribeSubscriptionFiltersResponse":{ + "type":"structure", + "members":{ + "subscriptionFilters":{ + "shape":"SubscriptionFilters", + "documentation":"

The subscription filters.

" + }, + "nextToken":{"shape":"NextToken"} + } + }, + "Destination":{ + "type":"structure", + "members":{ + "destinationName":{ + "shape":"DestinationName", + "documentation":"

The name of the destination.

" + }, + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The Amazon Resource Name (ARN) of the physical target to where the log events are delivered (for example, a Kinesis stream).

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

A role for impersonation, used when delivering log events to the target.

" + }, + "accessPolicy":{ + "shape":"AccessPolicy", + "documentation":"

An IAM policy document that governs which AWS accounts can create subscription filters against this destination.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The ARN of this destination.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "documentation":"

Represents a cross-account destination that receives subscription log events.

" + }, + "DestinationArn":{ + "type":"string", + "min":1 + }, + "DestinationName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "Destinations":{ + "type":"list", + "member":{"shape":"Destination"} + }, + "DisassociateKmsKeyRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + } + } + }, + "Distribution":{ + "type":"string", + "documentation":"

The method used to distribute log data to the destination, which can be either random or grouped by log stream.

", + "enum":[ + "Random", + "ByLogStream" + ] + }, + "EventId":{"type":"string"}, + "EventMessage":{ + "type":"string", + "min":1 + }, + "EventNumber":{"type":"long"}, + "EventsLimit":{ + "type":"integer", + "max":10000, + "min":1 + }, + "ExportDestinationBucket":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportDestinationPrefix":{"type":"string"}, + "ExportTask":{ + "type":"structure", + "members":{ + "taskId":{ + "shape":"ExportTaskId", + "documentation":"

The ID of the export task.

" + }, + "taskName":{ + "shape":"ExportTaskName", + "documentation":"

The name of the export task.

" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group from which logs data was exported.

" + }, + "from":{ + "shape":"Timestamp", + "documentation":"

The start time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not exported.

" + }, + "to":{ + "shape":"Timestamp", + "documentation":"

The end time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not exported.

" + }, + "destination":{ + "shape":"ExportDestinationBucket", + "documentation":"

The name of Amazon S3 bucket to which the log data was exported.

" + }, + "destinationPrefix":{ + "shape":"ExportDestinationPrefix", + "documentation":"

The prefix that was used as the start of Amazon S3 key for every object exported.

" + }, + "status":{ + "shape":"ExportTaskStatus", + "documentation":"

The status of the export task.

" + }, + "executionInfo":{ + "shape":"ExportTaskExecutionInfo", + "documentation":"

Execution info about the export task.

" + } + }, + "documentation":"

Represents an export task.

" + }, + "ExportTaskExecutionInfo":{ + "type":"structure", + "members":{ + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "completionTime":{ + "shape":"Timestamp", + "documentation":"

The completion time of the export task, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "documentation":"

Represents the status of an export task.

" + }, + "ExportTaskId":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportTaskName":{ + "type":"string", + "max":512, + "min":1 + }, + "ExportTaskStatus":{ + "type":"structure", + "members":{ + "code":{ + "shape":"ExportTaskStatusCode", + "documentation":"

The status code of the export task.

" + }, + "message":{ + "shape":"ExportTaskStatusMessage", + "documentation":"

The status message related to the status code.

" + } + }, + "documentation":"

Represents the status of an export task.

" + }, + "ExportTaskStatusCode":{ + "type":"string", + "enum":[ + "CANCELLED", + "COMPLETED", + "FAILED", + "PENDING", + "PENDING_CANCEL", + "RUNNING" + ] + }, + "ExportTaskStatusMessage":{"type":"string"}, + "ExportTasks":{ + "type":"list", + "member":{"shape":"ExportTask"} + }, + "ExtractedValues":{ + "type":"map", + "key":{"shape":"Token"}, + "value":{"shape":"Value"} + }, + "Field":{"type":"string"}, + "FilterCount":{"type":"integer"}, + "FilterLogEventsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group to search.

" + }, + "logStreamNames":{ + "shape":"InputLogStreamNames", + "documentation":"

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

" + }, + "logStreamNamePrefix":{ + "shape":"LogStreamName", + "documentation":"

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp before this time are not returned.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

" + }, + "filterPattern":{ + "shape":"FilterPattern", + "documentation":"

The filter pattern to use. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of events to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"EventsLimit", + "documentation":"

The maximum number of events to return. The default is 10,000 events.

" + }, + "interleaved":{ + "shape":"Interleaved", + "documentation":"

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

IMPORTANT: Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group.

", + "deprecated":true, + "deprecatedMessage":"Starting on June 17, 2019, this parameter will be ignored and the value will be assumed to be true. The response from this operation will always interleave events from multiple log streams within a log group." + } + } + }, + "FilterLogEventsResponse":{ + "type":"structure", + "members":{ + "events":{ + "shape":"FilteredLogEvents", + "documentation":"

The matched events.

" + }, + "searchedLogStreams":{ + "shape":"SearchedLogStreams", + "documentation":"

Indicates which log streams have been searched and whether each has been searched completely.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token to use when requesting the next set of items. The token expires after 24 hours.

" + } + } + }, + "FilterName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "FilterPattern":{ + "type":"string", + "documentation":"

A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event may contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

", + "max":1024, + "min":0 + }, + "FilteredLogEvent":{ + "type":"structure", + "members":{ + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream to which this event belongs.

" + }, + "timestamp":{ + "shape":"Timestamp", + "documentation":"

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "message":{ + "shape":"EventMessage", + "documentation":"

The data contained in the log event.

" + }, + "ingestionTime":{ + "shape":"Timestamp", + "documentation":"

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "eventId":{ + "shape":"EventId", + "documentation":"

The ID of the event.

" + } + }, + "documentation":"

Represents a matched event.

" + }, + "FilteredLogEvents":{ + "type":"list", + "member":{"shape":"FilteredLogEvent"} + }, + "GetLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or later than this time are not included.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items to return. (You received this token from a previous call.)

" + }, + "limit":{ + "shape":"EventsLimit", + "documentation":"

The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.

" + }, + "startFromHead":{ + "shape":"StartFromHead", + "documentation":"

If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.

If you are using nextToken in this operation, you must specify true for startFromHead.

" + } + } + }, + "GetLogEventsResponse":{ + "type":"structure", + "members":{ + "events":{ + "shape":"OutputLogEvents", + "documentation":"

The events.

" + }, + "nextForwardToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items in the forward direction. The token expires after 24 hours. If you have reached the end of the stream, it will return the same token you passed in.

" + }, + "nextBackwardToken":{ + "shape":"NextToken", + "documentation":"

The token for the next set of items in the backward direction. The token expires after 24 hours. This token will never be null. If you have reached the end of the stream, it will return the same token you passed in.

" + } + } + }, + "GetLogGroupFieldsRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group to search.

" + }, + "time":{ + "shape":"Timestamp", + "documentation":"

The time to set as the center of the query. If you specify time, the 8 minutes before and 8 minutes after this time are searched. If you omit time, the past 15 minutes are queried.

The time value is specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

" + } + } + }, + "GetLogGroupFieldsResponse":{ + "type":"structure", + "members":{ + "logGroupFields":{ + "shape":"LogGroupFieldList", + "documentation":"

The array of fields found in the query. Each object in the array contains the name of the field, along with the percentage of time it appeared in the log events that were queried.

" + } + } + }, + "GetLogRecordRequest":{ + "type":"structure", + "required":["logRecordPointer"], + "members":{ + "logRecordPointer":{ + "shape":"LogRecordPointer", + "documentation":"

The pointer corresponding to the log event record you want to retrieve. You get this from the response of a GetQueryResults operation. In that response, the value of the @ptr field for a log event is the value to use as logRecordPointer to retrieve that complete log event record.

" + } + } + }, + "GetLogRecordResponse":{ + "type":"structure", + "members":{ + "logRecord":{ + "shape":"LogRecord", + "documentation":"

The requested log event, as a JSON string.

" + } + } + }, + "GetQueryResultsRequest":{ + "type":"structure", + "required":["queryId"], + "members":{ + "queryId":{ + "shape":"QueryId", + "documentation":"

The ID number of the query.

" + } + } + }, + "GetQueryResultsResponse":{ + "type":"structure", + "members":{ + "results":{ + "shape":"QueryResults", + "documentation":"

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

" + }, + "statistics":{ + "shape":"QueryStatistics", + "documentation":"

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

" + }, + "status":{ + "shape":"QueryStatus", + "documentation":"

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 15 minutes of execution. To avoid having your queries time out, reduce the time range being searched, or partition your query into a number of queries.

" + } + } + }, + "InputLogEvent":{ + "type":"structure", + "required":[ + "timestamp", + "message" + ], + "members":{ + "timestamp":{ + "shape":"Timestamp", + "documentation":"

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "message":{ + "shape":"EventMessage", + "documentation":"

The raw event message.

" + } + }, + "documentation":"

Represents a log event, which is a record of activity that was recorded by the application or resource being monitored.

" + }, + "InputLogEvents":{ + "type":"list", + "member":{"shape":"InputLogEvent"}, + "max":10000, + "min":1 + }, + "InputLogStreamNames":{ + "type":"list", + "member":{"shape":"LogStreamName"}, + "max":100, + "min":1 + }, + "Interleaved":{"type":"boolean"}, + "InvalidOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The operation is not valid on the specified resource.

", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A parameter is specified incorrectly.

", + "exception":true + }, + "InvalidSequenceTokenException":{ + "type":"structure", + "members":{ + "expectedSequenceToken":{"shape":"SequenceToken"} + }, + "documentation":"

The sequence token is not valid.

", + "exception":true + }, + "KmsKeyId":{ + "type":"string", + "max":256 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have reached the maximum number of resources that can be created.

", + "exception":true + }, + "ListTagsLogGroupRequest":{ + "type":"structure", + "required":["logGroupName"], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + } + } + }, + "ListTagsLogGroupResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"Tags", + "documentation":"

The tags for the log group.

" + } + } + }, + "LogEventIndex":{"type":"integer"}, + "LogGroup":{ + "type":"structure", + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the log group, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "retentionInDays":{"shape":"Days"}, + "metricFilterCount":{ + "shape":"FilterCount", + "documentation":"

The number of metric filters.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the log group.

" + }, + "storedBytes":{ + "shape":"StoredBytes", + "documentation":"

The number of bytes stored.

" + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

The Amazon Resource Name (ARN) of the CMK to use when encrypting log data.

" + } + }, + "documentation":"

Represents a log group.

" + }, + "LogGroupField":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Field", + "documentation":"

The name of a log field.

" + }, + "percent":{ + "shape":"Percentage", + "documentation":"

The percentage of log events queried that contained the field.

" + } + }, + "documentation":"

The fields contained in log events found by a GetLogGroupFields operation, along with the percentage of queried log events in which each field appears.

" + }, + "LogGroupFieldList":{ + "type":"list", + "member":{"shape":"LogGroupField"} + }, + "LogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "LogGroupNames":{ + "type":"list", + "member":{"shape":"LogGroupName"} + }, + "LogGroups":{ + "type":"list", + "member":{"shape":"LogGroup"} + }, + "LogRecord":{ + "type":"map", + "key":{"shape":"Field"}, + "value":{"shape":"Value"} + }, + "LogRecordPointer":{"type":"string"}, + "LogStream":{ + "type":"structure", + "members":{ + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the stream, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "firstEventTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time of the first event, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "lastEventTimestamp":{ + "shape":"Timestamp", + "documentation":"

The time of the most recent log event in the log stream in CloudWatch Logs. This number is expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. The lastEventTime value updates on an eventual consistency basis. It typically updates in less than an hour from ingestion, but may take longer in some rare situations.

" + }, + "lastIngestionTime":{ + "shape":"Timestamp", + "documentation":"

The ingestion time, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "uploadSequenceToken":{ + "shape":"SequenceToken", + "documentation":"

The sequence token.

" + }, + "arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the log stream.

" + }, + "storedBytes":{ + "shape":"StoredBytes", + "documentation":"

The number of bytes stored.

IMPORTANT: Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected.

", + "deprecated":true, + "deprecatedMessage":"Starting on June 17, 2019, this parameter will be deprecated for log streams, and will be reported as zero. This change applies only to log streams. The storedBytes parameter for log groups is not affected." + } + }, + "documentation":"

Represents a log stream, which is a sequence of log events from a single emitter of logs.

" + }, + "LogStreamName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[^:*]*" + }, + "LogStreamSearchedCompletely":{"type":"boolean"}, + "LogStreams":{ + "type":"list", + "member":{"shape":"LogStream"} + }, + "MalformedQueryException":{ + "type":"structure", + "members":{ + "queryCompileError":{"shape":"QueryCompileError"} + }, + "documentation":"

The query string is not valid. Details about this error are displayed in a QueryCompileError object. For more information, see .

For more information about valid query syntax, see CloudWatch Logs Insights Query Syntax.

", + "exception":true + }, + "Message":{"type":"string"}, + "MetricFilter":{ + "type":"structure", + "members":{ + "filterName":{ + "shape":"FilterName", + "documentation":"

The name of the metric filter.

" + }, + "filterPattern":{"shape":"FilterPattern"}, + "metricTransformations":{ + "shape":"MetricTransformations", + "documentation":"

The metric transformations.

" + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the metric filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + } + }, + "documentation":"

Metric filters express how CloudWatch Logs would extract metric observations from ingested log events and transform them into metric data in a CloudWatch metric.

" + }, + "MetricFilterMatchRecord":{ + "type":"structure", + "members":{ + "eventNumber":{ + "shape":"EventNumber", + "documentation":"

The event number.

" + }, + "eventMessage":{ + "shape":"EventMessage", + "documentation":"

The raw event data.

" + }, + "extractedValues":{ + "shape":"ExtractedValues", + "documentation":"

The values extracted from the event data by the filter.

" + } + }, + "documentation":"

Represents a matched event.

" + }, + "MetricFilterMatches":{ + "type":"list", + "member":{"shape":"MetricFilterMatchRecord"} + }, + "MetricFilters":{ + "type":"list", + "member":{"shape":"MetricFilter"} + }, + "MetricName":{ + "type":"string", + "documentation":"

The name of the CloudWatch metric to which the monitored log information should be published. For example, you may publish to a metric called ErrorCount.

", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricNamespace":{ + "type":"string", + "max":255, + "pattern":"[^:*$]*" + }, + "MetricTransformation":{ + "type":"structure", + "required":[ + "metricName", + "metricNamespace", + "metricValue" + ], + "members":{ + "metricName":{ + "shape":"MetricName", + "documentation":"

The name of the CloudWatch metric.

" + }, + "metricNamespace":{ + "shape":"MetricNamespace", + "documentation":"

The namespace of the CloudWatch metric.

" + }, + "metricValue":{ + "shape":"MetricValue", + "documentation":"

The value to publish to the CloudWatch metric when a filter pattern matches a log event.

" + }, + "defaultValue":{ + "shape":"DefaultValue", + "documentation":"

(Optional) The value to emit when a filter pattern does not match a log event. This value can be null.

" + } + }, + "documentation":"

Indicates how to transform ingested log events to metric data in a CloudWatch metric.

" + }, + "MetricTransformations":{ + "type":"list", + "member":{"shape":"MetricTransformation"}, + "max":1, + "min":1 + }, + "MetricValue":{ + "type":"string", + "documentation":"

The value to publish to the CloudWatch metric. For example, if you're counting the occurrences of a term like \"Error\", the value is \"1\" for each occurrence. If you're counting the bytes transferred, the value is the value in the log event.

", + "max":100 + }, + "NextToken":{ + "type":"string", + "documentation":"

The token for the next set of items to return. The token expires after 24 hours.

", + "min":1 + }, + "OperationAbortedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Multiple requests to update the same resource were in conflict.

", + "exception":true + }, + "OrderBy":{ + "type":"string", + "enum":[ + "LogStreamName", + "LastEventTime" + ] + }, + "OutputLogEvent":{ + "type":"structure", + "members":{ + "timestamp":{ + "shape":"Timestamp", + "documentation":"

The time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + }, + "message":{ + "shape":"EventMessage", + "documentation":"

The data contained in the log event.

" + }, + "ingestionTime":{ + "shape":"Timestamp", + "documentation":"

The time the event was ingested, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "documentation":"

Represents a log event.

" + }, + "OutputLogEvents":{ + "type":"list", + "member":{"shape":"OutputLogEvent"} + }, + "Percentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "PolicyDocument":{ + "type":"string", + "max":5120, + "min":1 + }, + "PolicyName":{"type":"string"}, + "PutDestinationPolicyRequest":{ + "type":"structure", + "required":[ + "destinationName", + "accessPolicy" + ], + "members":{ + "destinationName":{ + "shape":"DestinationName", + "documentation":"

A name for an existing destination.

" + }, + "accessPolicy":{ + "shape":"AccessPolicy", + "documentation":"

An IAM policy document that authorizes cross-account users to deliver their log events to the associated destination.

" + } + } + }, + "PutDestinationRequest":{ + "type":"structure", + "required":[ + "destinationName", + "targetArn", + "roleArn" + ], + "members":{ + "destinationName":{ + "shape":"DestinationName", + "documentation":"

A name for the destination.

" + }, + "targetArn":{ + "shape":"TargetArn", + "documentation":"

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

" + } + } + }, + "PutDestinationResponse":{ + "type":"structure", + "members":{ + "destination":{ + "shape":"Destination", + "documentation":"

The destination.

" + } + } + }, + "PutLogEventsRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "logStreamName", + "logEvents" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + }, + "logEvents":{ + "shape":"InputLogEvents", + "documentation":"

The log events.

" + }, + "sequenceToken":{ + "shape":"SequenceToken", + "documentation":"

The sequence token obtained from the response of the previous PutLogEvents call. An upload in a newly created log stream does not require a sequence token. You can also get the sequence token using DescribeLogStreams. If you call PutLogEvents twice within a narrow time period using the same value for sequenceToken, both calls may be successful, or one may be rejected.

" + } + } + }, + "PutLogEventsResponse":{ + "type":"structure", + "members":{ + "nextSequenceToken":{ + "shape":"SequenceToken", + "documentation":"

The next sequence token.

" + }, + "rejectedLogEventsInfo":{ + "shape":"RejectedLogEventsInfo", + "documentation":"

The rejected events.

" + } + } + }, + "PutMetricFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName", + "filterPattern", + "metricTransformations" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterName":{ + "shape":"FilterName", + "documentation":"

A name for the metric filter.

" + }, + "filterPattern":{ + "shape":"FilterPattern", + "documentation":"

A filter pattern for extracting metric data out of ingested log events.

" + }, + "metricTransformations":{ + "shape":"MetricTransformations", + "documentation":"

A collection of information that defines how metric data gets emitted.

" + } + } + }, + "PutResourcePolicyRequest":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

Name of the new policy. This parameter is required.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace \"logArn\" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

{ \"Version\": \"2012-10-17\", \"Statement\": [ { \"Sid\": \"Route53LogsToCloudWatchLogs\", \"Effect\": \"Allow\", \"Principal\": { \"Service\": [ \"route53.amazonaws.com\" ] }, \"Action\":\"logs:PutLogEvents\", \"Resource\": \"logArn\" } ] }

" + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "resourcePolicy":{ + "shape":"ResourcePolicy", + "documentation":"

The new policy.

" + } + } + }, + "PutRetentionPolicyRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "retentionInDays" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "retentionInDays":{"shape":"Days"} + } + }, + "PutSubscriptionFilterRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "filterName", + "filterPattern", + "destinationArn" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterName":{ + "shape":"FilterName", + "documentation":"

A name for the subscription filter. If you are updating an existing filter, you must specify the correct name in filterName. Otherwise, the call fails because you cannot associate a second filter with a log group. To find the name of the filter currently associated with a log group, use DescribeSubscriptionFilters.

" + }, + "filterPattern":{ + "shape":"FilterPattern", + "documentation":"

A filter pattern for subscribing to a filtered stream of log events.

" + }, + "destinationArn":{ + "shape":"DestinationArn", + "documentation":"

The ARN of the destination to deliver matching log events to. Currently, the supported destinations are:

  • An Amazon Kinesis stream belonging to the same account as the subscription filter, for same-account delivery.

  • A logical destination (specified using an ARN) belonging to a different account, for cross-account delivery.

  • An Amazon Kinesis Firehose delivery stream belonging to the same account as the subscription filter, for same-account delivery.

  • An AWS Lambda function belonging to the same account as the subscription filter, for same-account delivery.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of an IAM role that grants CloudWatch Logs permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery.

" + }, + "distribution":{ + "shape":"Distribution", + "documentation":"

The method used to distribute log data to the destination. By default log data is grouped by log stream, but the grouping can be set to random for a more even distribution. This property is only applicable when the destination is an Amazon Kinesis stream.

" + } + } + }, + "QueryCharOffset":{"type":"integer"}, + "QueryCompileError":{ + "type":"structure", + "members":{ + "location":{ + "shape":"QueryCompileErrorLocation", + "documentation":"

Reserved.

" + }, + "message":{ + "shape":"Message", + "documentation":"

Reserved.

" + } + }, + "documentation":"

Reserved.

" + }, + "QueryCompileErrorLocation":{ + "type":"structure", + "members":{ + "startCharOffset":{ + "shape":"QueryCharOffset", + "documentation":"

Reserved.

" + }, + "endCharOffset":{ + "shape":"QueryCharOffset", + "documentation":"

Reserved.

" + } + }, + "documentation":"

Reserved.

" + }, + "QueryId":{ + "type":"string", + "max":256, + "min":0 + }, + "QueryInfo":{ + "type":"structure", + "members":{ + "queryId":{ + "shape":"QueryId", + "documentation":"

The unique ID number of this query.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The query string used in this query.

" + }, + "status":{ + "shape":"QueryStatus", + "documentation":"

The status of this query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, and Unknown.

" + }, + "createTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that this query was created.

" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group scanned by this query.

" + } + }, + "documentation":"

Information about one CloudWatch Logs Insights query that matches the request in a DescribeQueries operation.

" + }, + "QueryInfoList":{ + "type":"list", + "member":{"shape":"QueryInfo"} + }, + "QueryResults":{ + "type":"list", + "member":{"shape":"ResultRows"} + }, + "QueryStatistics":{ + "type":"structure", + "members":{ + "recordsMatched":{ + "shape":"StatsValue", + "documentation":"

The number of log events that matched the query string.

" + }, + "recordsScanned":{ + "shape":"StatsValue", + "documentation":"

The total number of log events scanned during the query.

" + }, + "bytesScanned":{ + "shape":"StatsValue", + "documentation":"

The total number of bytes in the log events scanned during the query.

" + } + }, + "documentation":"

Contains the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the log events that were scanned.

" + }, + "QueryStatus":{ + "type":"string", + "enum":[ + "Scheduled", + "Running", + "Complete", + "Failed", + "Cancelled" + ] + }, + "QueryString":{ + "type":"string", + "max":2048, + "min":0 + }, + "RejectedLogEventsInfo":{ + "type":"structure", + "members":{ + "tooNewLogEventStartIndex":{ + "shape":"LogEventIndex", + "documentation":"

The log events that are too new.

" + }, + "tooOldLogEventEndIndex":{ + "shape":"LogEventIndex", + "documentation":"

The log events that are too old.

" + }, + "expiredLogEventEndIndex":{ + "shape":"LogEventIndex", + "documentation":"

The expired log events.

" + } + }, + "documentation":"

Represents the rejected events.

" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource already exists.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource does not exist.

", + "exception":true + }, + "ResourcePolicies":{ + "type":"list", + "member":{"shape":"ResourcePolicy"} + }, + "ResourcePolicy":{ + "type":"structure", + "members":{ + "policyName":{ + "shape":"PolicyName", + "documentation":"

The name of the resource policy.

" + }, + "policyDocument":{ + "shape":"PolicyDocument", + "documentation":"

The details of the policy.

" + }, + "lastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"

Timestamp showing when this policy was last updated, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "documentation":"

A policy enabling one or more entities to put logs to a log group in this account.

" + }, + "ResultField":{ + "type":"structure", + "members":{ + "field":{ + "shape":"Field", + "documentation":"

The log event field.

" + }, + "value":{ + "shape":"Value", + "documentation":"

The value of this field.

" + } + }, + "documentation":"

Contains one field from one log event returned by a CloudWatch Logs Insights query, along with the value of that field.

" + }, + "ResultRows":{ + "type":"list", + "member":{"shape":"ResultField"} + }, + "RoleArn":{ + "type":"string", + "min":1 + }, + "SearchedLogStream":{ + "type":"structure", + "members":{ + "logStreamName":{ + "shape":"LogStreamName", + "documentation":"

The name of the log stream.

" + }, + "searchedCompletely":{ + "shape":"LogStreamSearchedCompletely", + "documentation":"

Indicates whether all the events in this log stream were searched.

" + } + }, + "documentation":"

Represents the search status of a log stream.

" + }, + "SearchedLogStreams":{ + "type":"list", + "member":{"shape":"SearchedLogStream"} + }, + "SequenceToken":{ + "type":"string", + "min":1 + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The service cannot complete the request.

", + "exception":true, + "fault":true + }, + "StartFromHead":{"type":"boolean"}, + "StartQueryRequest":{ + "type":"structure", + "required":[ + "startTime", + "endTime", + "queryString" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The log group on which to perform the query.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

" + }, + "logGroupNames":{ + "shape":"LogGroupNames", + "documentation":"

The list of log groups to be queried. You can include up to 20 log groups.

A StartQuery operation must include a logGroupNames or a logGroupName parameter, but not both.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

" + }, + "queryString":{ + "shape":"QueryString", + "documentation":"

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

" + }, + "limit":{ + "shape":"EventsLimit", + "documentation":"

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned.

" + } + } + }, + "StartQueryResponse":{ + "type":"structure", + "members":{ + "queryId":{ + "shape":"QueryId", + "documentation":"

The unique ID of the query.

" + } + } + }, + "StatsValue":{"type":"double"}, + "StopQueryRequest":{ + "type":"structure", + "required":["queryId"], + "members":{ + "queryId":{ + "shape":"QueryId", + "documentation":"

The ID number of the query to stop. If necessary, you can use DescribeQueries to find this ID number.

" + } + } + }, + "StopQueryResponse":{ + "type":"structure", + "members":{ + "success":{ + "shape":"Success", + "documentation":"

This is true if the query was stopped by the StopQuery operation.

" + } + } + }, + "StoredBytes":{ + "type":"long", + "min":0 + }, + "SubscriptionFilter":{ + "type":"structure", + "members":{ + "filterName":{ + "shape":"FilterName", + "documentation":"

The name of the subscription filter.

" + }, + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "filterPattern":{"shape":"FilterPattern"}, + "destinationArn":{ + "shape":"DestinationArn", + "documentation":"

The Amazon Resource Name (ARN) of the destination.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

" + }, + "distribution":{"shape":"Distribution"}, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

The creation time of the subscription filter, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

" + } + }, + "documentation":"

Represents a subscription filter.

" + }, + "SubscriptionFilters":{ + "type":"list", + "member":{"shape":"SubscriptionFilter"} + }, + "Success":{"type":"boolean"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" + }, + "TagList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "min":1 + }, + "TagLogGroupRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "tags" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

The key-value pairs to use for the tags.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TargetArn":{ + "type":"string", + "min":1 + }, + "TestEventMessages":{ + "type":"list", + "member":{"shape":"EventMessage"}, + "max":50, + "min":1 + }, + "TestMetricFilterRequest":{ + "type":"structure", + "required":[ + "filterPattern", + "logEventMessages" + ], + "members":{ + "filterPattern":{"shape":"FilterPattern"}, + "logEventMessages":{ + "shape":"TestEventMessages", + "documentation":"

The log event messages to test.

" + } + } + }, + "TestMetricFilterResponse":{ + "type":"structure", + "members":{ + "matches":{ + "shape":"MetricFilterMatches", + "documentation":"

The matched events.

" + } + } + }, + "Timestamp":{ + "type":"long", + "min":0 + }, + "Token":{"type":"string"}, + "UnrecognizedClientException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The most likely cause is an invalid AWS access key ID or secret key.

", + "exception":true + }, + "UntagLogGroupRequest":{ + "type":"structure", + "required":[ + "logGroupName", + "tags" + ], + "members":{ + "logGroupName":{ + "shape":"LogGroupName", + "documentation":"

The name of the log group.

" + }, + "tags":{ + "shape":"TagList", + "documentation":"

The tag keys. The corresponding tags are removed from the log group.

" + } + } + }, + "Value":{"type":"string"} + }, + "documentation":"

You can use Amazon CloudWatch Logs to monitor, store, and access your log files from Amazon EC2 instances, AWS CloudTrail, or other sources. You can then retrieve the associated log data from CloudWatch Logs using the CloudWatch console, CloudWatch Logs commands in the AWS CLI, CloudWatch Logs API, or CloudWatch Logs SDK.

You can use CloudWatch Logs to:

  • Monitor logs from EC2 instances in real-time: You can use CloudWatch Logs to monitor applications and systems using log data. For example, CloudWatch Logs can track the number of errors that occur in your application logs and send you a notification whenever the rate of errors exceeds a threshold that you specify. CloudWatch Logs uses your log data for monitoring; so, no code changes are required. For example, you can monitor application logs for specific literal terms (such as \"NullReferenceException\") or count the number of occurrences of a literal term at a particular position in log data (such as \"404\" status codes in an Apache access log). When the term you are searching for is found, CloudWatch Logs reports the data to a CloudWatch metric that you specify.

  • Monitor AWS CloudTrail logged events: You can create alarms in CloudWatch and receive notifications of particular API activity as captured by CloudTrail and use the notification to perform troubleshooting.

  • Archive log data: You can use CloudWatch Logs to store your log data in highly durable storage. You can change the log retention setting so that any log events older than this setting are automatically deleted. The CloudWatch Logs agent makes it easy to quickly send both rotated and non-rotated log data off of a host and into the log service. You can then access the raw log data when you need it.

" +} diff --git a/aws/dist/botocore/data/machinelearning/2014-12-12/examples-1.json b/aws/dist/botocore/data/machinelearning/2014-12-12/examples-1.json new file mode 100644 index 00000000..faff7689 --- /dev/null +++ b/aws/dist/botocore/data/machinelearning/2014-12-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version":"1.0", + "examples":{ + } +} diff --git a/aws/dist/botocore/data/machinelearning/2014-12-12/paginators-1.json b/aws/dist/botocore/data/machinelearning/2014-12-12/paginators-1.json new file mode 100644 index 00000000..c13ce65a --- /dev/null +++ b/aws/dist/botocore/data/machinelearning/2014-12-12/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "DescribeBatchPredictions": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeDataSources": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeEvaluations": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + }, + "DescribeMLModels": { + "limit_key": "Limit", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Results" + } + } +} diff --git a/aws/dist/botocore/data/machinelearning/2014-12-12/service-2.json b/aws/dist/botocore/data/machinelearning/2014-12-12/service-2.json new file mode 100644 index 00000000..5e849383 --- /dev/null +++ b/aws/dist/botocore/data/machinelearning/2014-12-12/service-2.json @@ -0,0 +1,3144 @@ +{ + "version":"2.0", + "metadata":{ + "uid":"machinelearning-2014-12-12", + "apiVersion":"2014-12-12", + "endpointPrefix":"machinelearning", + "jsonVersion":"1.1", + "serviceFullName":"Amazon Machine Learning", + "serviceId":"Machine Learning", + "signatureVersion":"v4", + "targetPrefix":"AmazonML_20141212", + "protocol":"json" + }, + "documentation":"Definition of the public APIs exposed by Amazon Machine Learning", + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{ + "shape":"AddTagsOutput", + "documentation":"

Amazon ML returns the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InvalidTagException", + "exception":true + }, + { + "shape":"TagLimitExceededException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Adds one or more tags to an object, up to a limit of 10. Each tag consists of a key and an optional value. If you add a tag using a key that is already associated with the ML object, AddTags updates the tag's value.

" + }, + "CreateBatchPrediction":{ + "name":"CreateBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBatchPredictionInput"}, + "output":{ + "shape":"CreateBatchPredictionOutput", + "documentation":"

Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.

The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Generates predictions for a group of observations. The observations to process exist in one or more data files referenced by a DataSource. This operation creates a new BatchPrediction, and uses an MLModel and the data files referenced by the DataSource as information sources.

CreateBatchPrediction is an asynchronous operation. In response to CreateBatchPrediction, Amazon Machine Learning (Amazon ML) immediately returns and sets the BatchPrediction status to PENDING. After the BatchPrediction completes, Amazon ML sets the status to COMPLETED.

You can poll for status updates by using the GetBatchPrediction operation and checking the Status parameter of the result. After the COMPLETED status appears, the results are available in the location specified by the OutputUri parameter.

" + }, + "CreateDataSourceFromRDS":{ + "name":"CreateDataSourceFromRDS", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromRDSInput"}, + "output":{ + "shape":"CreateDataSourceFromRDSOutput", + "documentation":"

Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Creates a DataSource object from an Amazon Relational Database Service (Amazon RDS). A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromRDS is an asynchronous operation. In response to CreateDataSourceFromRDS, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used only to perform >CreateMLModel>, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML cannot accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

" + }, + "CreateDataSourceFromRedshift":{ + "name":"CreateDataSourceFromRedshift", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromRedshiftInput"}, + "output":{ + "shape":"CreateDataSourceFromRedshiftOutput", + "documentation":"

Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Creates a DataSource from a database hosted on an Amazon Redshift cluster. A DataSource references data that can be used to perform either CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromRedshift is an asynchronous operation. In response to CreateDataSourceFromRedshift, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource is created and ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in COMPLETED or PENDING states can be used to perform only CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observations should be contained in the database hosted on an Amazon Redshift cluster and should be specified by a SelectSqlQuery query. Amazon ML executes an Unload command in Amazon Redshift to transfer the result set of the SelectSqlQuery query to S3StagingLocation.

After the DataSource has been created, it's ready for use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also requires a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

You can't change an existing datasource, but you can copy and modify the settings from an existing Amazon Redshift datasource to create a new datasource. To do so, call GetDataSource for an existing datasource and copy the values to a CreateDataSource call. Change the settings that you want to change and make sure that all required fields have the appropriate values.

" + }, + "CreateDataSourceFromS3":{ + "name":"CreateDataSourceFromS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDataSourceFromS3Input"}, + "output":{ + "shape":"CreateDataSourceFromS3Output", + "documentation":"

Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Creates a DataSource object. A DataSource references data that can be used to perform CreateMLModel, CreateEvaluation, or CreateBatchPrediction operations.

CreateDataSourceFromS3 is an asynchronous operation. In response to CreateDataSourceFromS3, Amazon Machine Learning (Amazon ML) immediately returns and sets the DataSource status to PENDING. After the DataSource has been created and is ready for use, Amazon ML sets the Status parameter to COMPLETED. DataSource in the COMPLETED or PENDING state can be used to perform only CreateMLModel, CreateEvaluation or CreateBatchPrediction operations.

If Amazon ML can't accept the input source, it sets the Status parameter to FAILED and includes an error message in the Message attribute of the GetDataSource operation response.

The observation data used in a DataSource should be ready to use; that is, it should have a consistent structure, and missing data values should be kept to a minimum. The observation data must reside in one or more .csv files in an Amazon Simple Storage Service (Amazon S3) location, along with a schema that describes the data items by name and type. The same schema must be used for all of the data files referenced by the DataSource.

After the DataSource has been created, it's ready to use in evaluations and batch predictions. If you plan to use the DataSource to train an MLModel, the DataSource also needs a recipe. A recipe describes how each input variable will be used in training an MLModel. Will the variable be included or excluded from training? Will the variable be manipulated; for example, will it be combined with another variable or will it be split apart into word combinations? The recipe provides answers to these questions.

" + }, + "CreateEvaluation":{ + "name":"CreateEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEvaluationInput"}, + "output":{ + "shape":"CreateEvaluationOutput", + "documentation":"

Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.

CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Creates a new Evaluation of an MLModel. An MLModel is evaluated on a set of observations associated to a DataSource. Like a DataSource for an MLModel, the DataSource for an Evaluation contains values for the Target Variable. The Evaluation compares the predicted result for each observation to the actual outcome and provides a summary so that you know how effective the MLModel functions on the test data. Evaluation generates a relevant performance metric, such as BinaryAUC, RegressionRMSE or MulticlassAvgFScore based on the corresponding MLModelType: BINARY, REGRESSION or MULTICLASS.

CreateEvaluation is an asynchronous operation. In response to CreateEvaluation, Amazon Machine Learning (Amazon ML) immediately returns and sets the evaluation status to PENDING. After the Evaluation is created and ready for use, Amazon ML sets the status to COMPLETED.

You can use the GetEvaluation operation to check progress of the evaluation during the creation operation.

" + }, + "CreateMLModel":{ + "name":"CreateMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMLModelInput"}, + "output":{ + "shape":"CreateMLModelOutput", + "documentation":"

Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.

The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"IdempotentParameterMismatchException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + } + ], + "documentation":"

Creates a new MLModel using the DataSource and the recipe as information sources.

An MLModel is nearly immutable. Users can update only the MLModelName and the ScoreThreshold in an MLModel without creating a new MLModel.

CreateMLModel is an asynchronous operation. In response to CreateMLModel, Amazon Machine Learning (Amazon ML) immediately returns and sets the MLModel status to PENDING. After the MLModel has been created and ready is for use, Amazon ML sets the status to COMPLETED.

You can use the GetMLModel operation to check the progress of the MLModel during the creation operation.

CreateMLModel requires a DataSource with computed statistics, which can be created by setting ComputeStatistics to true in CreateDataSourceFromRDS, CreateDataSourceFromS3, or CreateDataSourceFromRedshift operations.

" + }, + "CreateRealtimeEndpoint":{ + "name":"CreateRealtimeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRealtimeEndpointInput"}, + "output":{ + "shape":"CreateRealtimeEndpointOutput", + "documentation":"

Represents the output of an CreateRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Creates a real-time endpoint for the MLModel. The endpoint contains the URI of the MLModel; that is, the location to send real-time prediction requests for the specified MLModel.

" + }, + "DeleteBatchPrediction":{ + "name":"DeleteBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBatchPredictionInput"}, + "output":{ + "shape":"DeleteBatchPredictionOutput", + "documentation":"

Represents the output of a DeleteBatchPrediction operation.

You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Assigns the DELETED status to a BatchPrediction, rendering it unusable.

After using the DeleteBatchPrediction operation, you can use the GetBatchPrediction operation to verify that the status of the BatchPrediction changed to DELETED.

Caution: The result of the DeleteBatchPrediction operation is irreversible.

" + }, + "DeleteDataSource":{ + "name":"DeleteDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDataSourceInput"}, + "output":{ + "shape":"DeleteDataSourceOutput", + "documentation":"

Represents the output of a DeleteDataSource operation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Assigns the DELETED status to a DataSource, rendering it unusable.

After using the DeleteDataSource operation, you can use the GetDataSource operation to verify that the status of the DataSource changed to DELETED.

Caution: The results of the DeleteDataSource operation are irreversible.

" + }, + "DeleteEvaluation":{ + "name":"DeleteEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEvaluationInput"}, + "output":{ + "shape":"DeleteEvaluationOutput", + "documentation":"

Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Assigns the DELETED status to an Evaluation, rendering it unusable.

After invoking the DeleteEvaluation operation, you can use the GetEvaluation operation to verify that the status of the Evaluation changed to DELETED.

Caution

The results of the DeleteEvaluation operation are irreversible.

" + }, + "DeleteMLModel":{ + "name":"DeleteMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMLModelInput"}, + "output":{ + "shape":"DeleteMLModelOutput", + "documentation":"

Represents the output of a DeleteMLModel operation.

You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Assigns the DELETED status to an MLModel, rendering it unusable.

After using the DeleteMLModel operation, you can use the GetMLModel operation to verify that the status of the MLModel changed to DELETED.

Caution: The result of the DeleteMLModel operation is irreversible.

" + }, + "DeleteRealtimeEndpoint":{ + "name":"DeleteRealtimeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRealtimeEndpointInput"}, + "output":{ + "shape":"DeleteRealtimeEndpointOutput", + "documentation":"

Represents the output of an DeleteRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Deletes a real time endpoint of an MLModel.

" + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsInput"}, + "output":{ + "shape":"DeleteTagsOutput", + "documentation":"

Amazon ML returns the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InvalidTagException", + "exception":true + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Deletes the specified tags associated with an ML object. After this operation is complete, you can't recover deleted tags.

If you specify a tag that doesn't exist, Amazon ML ignores it.

" + }, + "DescribeBatchPredictions":{ + "name":"DescribeBatchPredictions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBatchPredictionsInput"}, + "output":{ + "shape":"DescribeBatchPredictionsOutput", + "documentation":"

Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a list of BatchPrediction operations that match the search criteria in the request.

" + }, + "DescribeDataSources":{ + "name":"DescribeDataSources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDataSourcesInput"}, + "output":{ + "shape":"DescribeDataSourcesOutput", + "documentation":"

Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a list of DataSource that match the search criteria in the request.

" + }, + "DescribeEvaluations":{ + "name":"DescribeEvaluations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEvaluationsInput"}, + "output":{ + "shape":"DescribeEvaluationsOutput", + "documentation":"

Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a list of DescribeEvaluations that match the search criteria in the request.

" + }, + "DescribeMLModels":{ + "name":"DescribeMLModels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMLModelsInput"}, + "output":{ + "shape":"DescribeMLModelsOutput", + "documentation":"

Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a list of MLModel that match the search criteria in the request.

" + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsInput"}, + "output":{ + "shape":"DescribeTagsOutput", + "documentation":"

Amazon ML returns the following elements.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Describes one or more of the tags for your Amazon ML object.

" + }, + "GetBatchPrediction":{ + "name":"GetBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetBatchPredictionInput"}, + "output":{ + "shape":"GetBatchPredictionOutput", + "documentation":"

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a BatchPrediction that includes detailed metadata, status, and data file information for a Batch Prediction request.

" + }, + "GetDataSource":{ + "name":"GetDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDataSourceInput"}, + "output":{ + "shape":"GetDataSourceOutput", + "documentation":"

Represents the output of a GetDataSource operation and describes a DataSource.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns a DataSource that includes metadata and data file information, as well as the current status of the DataSource.

GetDataSource provides results in normal or verbose format. The verbose format adds the schema description and the list of files pointed to by the DataSource to the normal format.

" + }, + "GetEvaluation":{ + "name":"GetEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEvaluationInput"}, + "output":{ + "shape":"GetEvaluationOutput", + "documentation":"

Represents the output of a GetEvaluation operation and describes an Evaluation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns an Evaluation that includes metadata as well as the current status of the Evaluation.

" + }, + "GetMLModel":{ + "name":"GetMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMLModelInput"}, + "output":{ + "shape":"GetMLModelOutput", + "documentation":"

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Returns an MLModel that includes detailed metadata, data source information, and the current status of the MLModel.

GetMLModel provides results in normal or verbose format.

" + }, + "Predict":{ + "name":"Predict", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PredictInput"}, + "output":{"shape":"PredictOutput"}, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"LimitExceededException", + "error":{"httpStatusCode":417}, + "exception":true, + "documentation":"

The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + { + "shape":"PredictorNotMountedException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The exception is thrown when a predict request is made to an unmounted MLModel.

" + } + ], + "documentation":"

Generates a prediction for the observation using the specified ML Model.

Note

Not all response parameters will be populated. Whether a response parameter is populated depends on the type of model requested.

" + }, + "UpdateBatchPrediction":{ + "name":"UpdateBatchPrediction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBatchPredictionInput"}, + "output":{ + "shape":"UpdateBatchPredictionOutput", + "documentation":"

Represents the output of an UpdateBatchPrediction operation.

You can see the updated content by using the GetBatchPrediction operation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Updates the BatchPredictionName of a BatchPrediction.

You can use the GetBatchPrediction operation to view the contents of the updated data element.

" + }, + "UpdateDataSource":{ + "name":"UpdateDataSource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDataSourceInput"}, + "output":{ + "shape":"UpdateDataSourceOutput", + "documentation":"

Represents the output of an UpdateDataSource operation.

You can see the updated content by using the GetBatchPrediction operation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Updates the DataSourceName of a DataSource.

You can use the GetDataSource operation to view the contents of the updated data element.

" + }, + "UpdateEvaluation":{ + "name":"UpdateEvaluation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEvaluationInput"}, + "output":{ + "shape":"UpdateEvaluationOutput", + "documentation":"

Represents the output of an UpdateEvaluation operation.

You can see the updated content by using the GetEvaluation operation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Updates the EvaluationName of an Evaluation.

You can use the GetEvaluation operation to view the contents of the updated data element.

" + }, + "UpdateMLModel":{ + "name":"UpdateMLModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMLModelInput"}, + "output":{ + "shape":"UpdateMLModelOutput", + "documentation":"

Represents the output of an UpdateMLModel operation.

You can see the updated content by using the GetMLModel operation.

" + }, + "errors":[ + { + "shape":"InvalidInputException", + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + { + "shape":"ResourceNotFoundException", + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + { + "shape":"InternalServerException", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + } + ], + "documentation":"

Updates the MLModelName and the ScoreThreshold of an MLModel.

You can use the GetMLModel operation to view the contents of the updated data element.

" + } + }, + "shapes":{ + "AddTagsInput":{ + "type":"structure", + "required":[ + "Tags", + "ResourceId", + "ResourceType" + ], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.

" + }, + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the ML object to tag. For example, exampleModelId.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the ML object to tag.

" + } + } + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the ML object that was tagged.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the ML object that was tagged.

" + } + }, + "documentation":"

Amazon ML returns the following elements.

" + }, + "Algorithm":{ + "type":"string", + "enum":["sgd"], + "documentation":"

The function used to train an MLModel. Training choices supported by Amazon ML include the following:

  • SGD - Stochastic Gradient Descent.
  • RandomForest - Random forest of decision trees.
" + }, + "AwsUserArn":{ + "type":"string", + "pattern":"arn:aws:iam::[0-9]+:((user/.+)|(root))", + "documentation":"

An Amazon Web Service (AWS) user account identifier. The account identifier can be an AWS root account or an AWS Identity and Access Management (IAM) user.

" + }, + "BatchPrediction":{ + "type":"structure", + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel that generated predictions for the BatchPrediction request.

" + }, + "BatchPredictionDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the DataSource that points to the group of observations to predict.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the BatchPrediction was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the BatchPrediction.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The status of the BatchPrediction. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.
  • INPROGRESS - The process is underway.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.
" + }, + "OutputUri":{ + "shape":"S3Url", + "documentation":"

The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about processing the batch prediction request.

" + }, + "ComputeTime":{"shape":"LongType"}, + "FinishedAt":{"shape":"EpochTime"}, + "StartedAt":{"shape":"EpochTime"}, + "TotalRecordCount":{"shape":"LongType"}, + "InvalidRecordCount":{"shape":"LongType"} + }, + "documentation":"

Represents the output of a GetBatchPrediction operation.

The content consists of the detailed metadata, the status, and the data file information of a Batch Prediction.

" + }, + "BatchPredictionFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "MLModelId", + "DataSourceId", + "DataURI" + ], + "documentation":"

A list of the variables to use in searching or filtering BatchPrediction.

  • CreatedAt - Sets the search criteria to BatchPrediction creation date.
  • Status - Sets the search criteria to BatchPrediction status.
  • Name - Sets the search criteria to the contents of BatchPrediction Name.
  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" + }, + "BatchPredictions":{ + "type":"list", + "member":{"shape":"BatchPrediction"} + }, + "ComparatorValue":{ + "type":"string", + "max":1024, + "pattern":".*\\S.*|^$", + "documentation":"

The value specified in a filtering condition. The ComparatorValue becomes the reference value when matching or evaluating data values in filtering and searching functions.

" + }, + "ComputeStatistics":{"type":"boolean"}, + "CreateBatchPredictionInput":{ + "type":"structure", + "required":[ + "BatchPredictionId", + "MLModelId", + "BatchPredictionDataSourceId", + "OutputUri" + ], + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction.

" + }, + "BatchPredictionName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the BatchPrediction. BatchPredictionName can only use the UTF-8 character set.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel that will generate predictions for the group of observations.

" + }, + "BatchPredictionDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the DataSource that points to the group of observations to predict.

" + }, + "OutputUri":{ + "shape":"S3Url", + "documentation":"

The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the s3 key portion of the outputURI field: ':', '//', '/./', '/../'.

Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the Amazon Machine Learning Developer Guide.

" + } + } + }, + "CreateBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction. This value is identical to the value of the BatchPredictionId in the request.

" + } + }, + "documentation":"

Represents the output of a CreateBatchPrediction operation, and is an acknowledgement that Amazon ML received the request.

The CreateBatchPrediction operation is asynchronous. You can poll for status updates by using the >GetBatchPrediction operation and checking the Status parameter of the result.

" + }, + "CreateDataSourceFromRDSInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "RDSData", + "RoleARN" + ], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.

" + }, + "DataSourceName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the DataSource.

" + }, + "RDSData":{ + "shape":"RDSDataSpec", + "documentation":"

The data specification of an Amazon RDS DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon RDS database.
    • InstanceIdentifier - A unique identifier for the Amazon RDS database instance.

  • DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.

  • ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.

  • ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

  • SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [SubnetId, SecurityGroupIds] pair for a VPC-based RDS DB instance.

  • SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.

  • S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

  • DataSchemaUri - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.


    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

The role that Amazon ML assumes on behalf of the user to create and activate a data pipeline in the user's account and copy data using the SelectSqlQuery query from Amazon RDS to Amazon S3.

" + }, + "ComputeStatistics":{ + "shape":"ComputeStatistics", + "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" + } + } + }, + "CreateDataSourceFromRDSOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

" + } + }, + "documentation":"

Represents the output of a CreateDataSourceFromRDS operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRDS> operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter. You can inspect the Message when Status shows up as FAILED. You can also check the progress of the copy operation by going to the DataPipeline console and looking up the pipeline using the pipelineId from the describe call.

" + }, + "CreateDataSourceFromRedshiftInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSpec", + "RoleARN" + ], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the DataSource.

" + }, + "DataSourceName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the DataSource.

" + }, + "DataSpec":{ + "shape":"RedshiftDataSpec", + "documentation":"

The data specification of an Amazon Redshift DataSource:

  • DatabaseInformation -

    • DatabaseName - The name of the Amazon Redshift database.
    • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

  • DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

  • SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.

  • S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query is stored in this location.

  • DataSchemaUri - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the DataSource.

    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

  • A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

  • An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

" + }, + "ComputeStatistics":{ + "shape":"ComputeStatistics", + "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" + } + } + }, + "CreateDataSourceFromRedshiftOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the DataSourceID in the request.

" + } + }, + "documentation":"

Represents the output of a CreateDataSourceFromRedshift operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromRedshift operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" + }, + "CreateDataSourceFromS3Input":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSpec" + ], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied identifier that uniquely identifies the DataSource.

" + }, + "DataSourceName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the DataSource.

" + }, + "DataSpec":{ + "shape":"S3DataSpec", + "documentation":"

The data specification of a DataSource:

  • DataLocationS3 - The Amazon S3 location of the observation data.

  • DataSchemaLocationS3 - The Amazon S3 location of the DataSchema.

  • DataSchema - A JSON string representing the schema. This is not required if DataSchemaUri is specified.

  • DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the Datasource.

    Sample - \"{\\\"splitting\\\":{\\\"percentBegin\\\":10,\\\"percentEnd\\\":60}}\"

" + }, + "ComputeStatistics":{ + "shape":"ComputeStatistics", + "documentation":"

The compute statistics for a DataSource. The statistics are generated from the observation data referenced by a DataSource. Amazon ML uses the statistics internally during MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.

" + } + } + }, + "CreateDataSourceFromS3Output":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

" + } + }, + "documentation":"

Represents the output of a CreateDataSourceFromS3 operation, and is an acknowledgement that Amazon ML received the request.

The CreateDataSourceFromS3 operation is asynchronous. You can poll for updates by using the GetBatchPrediction operation and checking the Status parameter.

" + }, + "CreateEvaluationInput":{ + "type":"structure", + "required":[ + "EvaluationId", + "MLModelId", + "EvaluationDataSourceId" + ], + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the Evaluation.

" + }, + "EvaluationName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the Evaluation.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel to evaluate.

The schema used in creating the MLModel must match the schema of the DataSource used in the Evaluation.

" + }, + "EvaluationDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the DataSource for the evaluation. The schema of the DataSource must match the schema used to create the MLModel.

" + } + } + }, + "CreateEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

" + } + }, + "documentation":"

Represents the output of a CreateEvaluation operation, and is an acknowledgement that Amazon ML received the request.

CreateEvaluation operation is asynchronous. You can poll for status updates by using the GetEvcaluation operation and checking the Status parameter.

" + }, + "CreateMLModelInput":{ + "type":"structure", + "required":[ + "MLModelId", + "MLModelType", + "TrainingDataSourceId" + ], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel.

" + }, + "MLModelName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the MLModel.

" + }, + "MLModelType":{ + "shape":"MLModelType", + "documentation":"

The category of supervised learning that this MLModel will address. Choose from the following types:

  • Choose REGRESSION if the MLModel will be used to predict a numeric value.
  • Choose BINARY if the MLModel result has two possible values.
  • Choose MULTICLASS if the MLModel result has a limited number of values.

For more information, see the Amazon Machine Learning Developer Guide.

" + }, + "Parameters":{ + "shape":"TrainingParameters", + "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" + }, + "TrainingDataSourceId":{ + "shape":"EntityId", + "documentation":"

The DataSource that points to the training data.

" + }, + "Recipe":{ + "shape":"Recipe", + "documentation":"

The data recipe for creating the MLModel. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" + }, + "RecipeUri":{ + "shape":"S3Url", + "documentation":"

The Amazon Simple Storage Service (Amazon S3) location and file name that contains the MLModel recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.

" + } + } + }, + "CreateMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" + } + }, + "documentation":"

Represents the output of a CreateMLModel operation, and is an acknowledgement that Amazon ML received the request.

The CreateMLModel operation is asynchronous. You can poll for status updates by using the GetMLModel operation and checking the Status parameter.

" + }, + "CreateRealtimeEndpointInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel during creation.

" + } + } + }, + "CreateRealtimeEndpointOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" + }, + "RealtimeEndpointInfo":{ + "shape":"RealtimeEndpointInfo", + "documentation":"

The endpoint information of the MLModel

" + } + }, + "documentation":"

Represents the output of an CreateRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

The endpoint information includes the URI of the MLModel; that is, the location to send online prediction requests for the specified MLModel.

" + }, + "DataRearrangement":{"type":"string"}, + "DataSchema":{ + "type":"string", + "max":131071, + "documentation":"

The schema of a DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource. The DataSource schema is expressed in JSON format.

DataSchema is not required if you specify a DataSchemaUri

{ \"version\": \"1.0\", \"recordAnnotationFieldName\": \"F1\", \"recordWeightFieldName\": \"F2\", \"targetFieldName\": \"F3\", \"dataFormat\": \"CSV\", \"dataFileContainsHeader\": true, \"variables\": [ { \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ], \"excludedVariableNames\": [ \"F6\" ] }

" + }, + "DataSource":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID that is assigned to the DataSource during creation.

" + }, + "DataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a DataSource.

" + }, + "DataRearrangement":{ + "shape":"DataRearrangement", + "documentation":"

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the DataSource was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

" + }, + "DataSizeInBytes":{ + "shape":"LongType", + "documentation":"

The total number of observations contained in the data files that the DataSource references.

" + }, + "NumberOfFiles":{ + "shape":"LongType", + "documentation":"

The number of data files referenced by the DataSource.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the DataSource.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a DataSource.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create a DataSource did not run to completion. It is not usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The DataSource is marked as deleted. It is not usable.
" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about creating the DataSource.

" + }, + "RedshiftMetadata":{"shape":"RedshiftMetadata"}, + "RDSMetadata":{"shape":"RDSMetadata"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{ + "shape":"ComputeStatistics", + "documentation":"

The parameter is true if statistics need to be generated from the observation data.

" + }, + "ComputeTime":{"shape":"LongType"}, + "FinishedAt":{"shape":"EpochTime"}, + "StartedAt":{"shape":"EpochTime"} + }, + "documentation":"

Represents the output of the GetDataSource operation.

The content consists of the detailed metadata and data file information and the current status of the DataSource.

" + }, + "DataSourceFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "DataLocationS3", + "IAMUser" + ], + "documentation":"

A list of the variables to use in searching or filtering DataSource.

  • CreatedAt - Sets the search criteria to DataSource creation date.
  • Status - Sets the search criteria to DataSource status.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
Note

The variable names should match the variable names in the DataSource.

" + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DeleteBatchPredictionInput":{ + "type":"structure", + "required":["BatchPredictionId"], + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction.

" + } + } + }, + "DeleteBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the BatchPrediction. This value should be identical to the value of the BatchPredictionID in the request.

" + } + }, + "documentation":"

Represents the output of a DeleteBatchPrediction operation.

You can use the GetBatchPrediction operation and check the value of the Status parameter to see whether a BatchPrediction is marked as DELETED.

" + }, + "DeleteDataSourceInput":{ + "type":"structure", + "required":["DataSourceId"], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the DataSource.

" + } + } + }, + "DeleteDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the DataSource. This value should be identical to the value of the DataSourceID in the request.

" + } + }, + "documentation":"

Represents the output of a DeleteDataSource operation.

" + }, + "DeleteEvaluationInput":{ + "type":"structure", + "required":["EvaluationId"], + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the Evaluation to delete.

" + } + } + }, + "DeleteEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the Evaluation. This value should be identical to the value of the EvaluationId in the request.

" + } + }, + "documentation":"

Represents the output of a DeleteEvaluation operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.

You can use the GetEvaluation operation and check the value of the Status parameter to see whether an Evaluation is marked as DELETED.

" + }, + "DeleteMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel.

" + } + } + }, + "DeleteMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelID in the request.

" + } + }, + "documentation":"

Represents the output of a DeleteMLModel operation.

You can use the GetMLModel operation and check the value of the Status parameter to see whether an MLModel is marked as DELETED.

" + }, + "DeleteRealtimeEndpointInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel during creation.

" + } + } + }, + "DeleteRealtimeEndpointOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A user-supplied ID that uniquely identifies the MLModel. This value should be identical to the value of the MLModelId in the request.

" + }, + "RealtimeEndpointInfo":{ + "shape":"RealtimeEndpointInfo", + "documentation":"

The endpoint information of the MLModel

" + } + }, + "documentation":"

Represents the output of an DeleteRealtimeEndpoint operation.

The result contains the MLModelId and the endpoint information for the MLModel.

" + }, + "DeleteTagsInput":{ + "type":"structure", + "required":[ + "TagKeys", + "ResourceId", + "ResourceType" + ], + "members":{ + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

One or more tags to delete.

" + }, + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the tagged ML object. For example, exampleModelId.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the tagged ML object.

" + } + } + }, + "DeleteTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the ML object from which tags were deleted.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the ML object from which tags were deleted.

" + } + }, + "documentation":"

Amazon ML returns the following elements.

" + }, + "DescribeBatchPredictionsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{ + "shape":"BatchPredictionFilterVariable", + "documentation":"

Use one of the following variables to filter a list of BatchPrediction:

  • CreatedAt - Sets the search criteria to the BatchPrediction creation date.
  • Status - Sets the search criteria to the BatchPrediction status.
  • Name - Sets the search criteria to the contents of the BatchPrediction Name.
  • IAMUser - Sets the search criteria to the user account that invoked the BatchPrediction creation.
  • MLModelId - Sets the search criteria to the MLModel used in the BatchPrediction.
  • DataSourceId - Sets the search criteria to the DataSource used in the BatchPrediction.
  • DataURI - Sets the search criteria to the data file(s) used in the BatchPrediction. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
" + }, + "EQ":{ + "shape":"ComparatorValue", + "documentation":"

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

" + }, + "GT":{ + "shape":"ComparatorValue", + "documentation":"

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

" + }, + "LT":{ + "shape":"ComparatorValue", + "documentation":"

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

" + }, + "GE":{ + "shape":"ComparatorValue", + "documentation":"

The greater than or equal to operator. The BatchPrediction results will have FilterVariable values that are greater than or equal to the value specified with GE.

" + }, + "LE":{ + "shape":"ComparatorValue", + "documentation":"

The less than or equal to operator. The BatchPrediction results will have FilterVariable values that are less than or equal to the value specified with LE.

" + }, + "NE":{ + "shape":"ComparatorValue", + "documentation":"

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

" + }, + "Prefix":{ + "shape":"ComparatorValue", + "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, a Batch Prediction operation could have the Name 2014-09-09-HolidayGiftMailer. To search for this BatchPrediction, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

A two-value parameter that determines the sequence of the resulting list of MLModels.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

An ID of the page in the paginated results.

" + }, + "Limit":{ + "shape":"PageLimit", + "documentation":"

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" + } + } + }, + "DescribeBatchPredictionsOutput":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"BatchPredictions", + "documentation":"

A list of BatchPrediction objects that meet the search criteria.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" + } + }, + "documentation":"

Represents the output of a DescribeBatchPredictions operation. The content is essentially a list of BatchPredictions.

" + }, + "DescribeDataSourcesInput":{ + "type":"structure", + "members":{ + "FilterVariable":{ + "shape":"DataSourceFilterVariable", + "documentation":"

Use one of the following variables to filter a list of DataSource:

  • CreatedAt - Sets the search criteria to DataSource creation dates.
  • Status - Sets the search criteria to DataSource statuses.
  • Name - Sets the search criteria to the contents of DataSource Name.
  • DataUri - Sets the search criteria to the URI of data files used to create the DataSource. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
  • IAMUser - Sets the search criteria to the user account that invoked the DataSource creation.
" + }, + "EQ":{ + "shape":"ComparatorValue", + "documentation":"

The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

" + }, + "GT":{ + "shape":"ComparatorValue", + "documentation":"

The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

" + }, + "LT":{ + "shape":"ComparatorValue", + "documentation":"

The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

" + }, + "GE":{ + "shape":"ComparatorValue", + "documentation":"

The greater than or equal to operator. The DataSource results will have FilterVariable values that are greater than or equal to the value specified with GE.

" + }, + "LE":{ + "shape":"ComparatorValue", + "documentation":"

The less than or equal to operator. The DataSource results will have FilterVariable values that are less than or equal to the value specified with LE.

" + }, + "NE":{ + "shape":"ComparatorValue", + "documentation":"

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

" + }, + "Prefix":{ + "shape":"ComparatorValue", + "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, a DataSource could have the Name 2014-09-09-HolidayGiftMailer. To search for this DataSource, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

A two-value parameter that determines the sequence of the resulting list of DataSource.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the page in the paginated results.

" + }, + "Limit":{ + "shape":"PageLimit", + "documentation":"

The maximum number of DataSource to include in the result.

" + } + } + }, + "DescribeDataSourcesOutput":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"DataSources", + "documentation":"

A list of DataSource that meet the search criteria.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

An ID of the next page in the paginated results that indicates at least one more page follows.

" + } + }, + "documentation":"

Represents the query results from a DescribeDataSources operation. The content is essentially a list of DataSource.

" + }, + "DescribeEvaluationsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{ + "shape":"EvaluationFilterVariable", + "documentation":"

Use one of the following variable to filter a list of Evaluation objects:

  • CreatedAt - Sets the search criteria to the Evaluation creation date.
  • Status - Sets the search criteria to the Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation Name.
  • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.
  • MLModelId - Sets the search criteria to the MLModel that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.
" + }, + "EQ":{ + "shape":"ComparatorValue", + "documentation":"

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

" + }, + "GT":{ + "shape":"ComparatorValue", + "documentation":"

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

" + }, + "LT":{ + "shape":"ComparatorValue", + "documentation":"

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

" + }, + "GE":{ + "shape":"ComparatorValue", + "documentation":"

The greater than or equal to operator. The Evaluation results will have FilterVariable values that are greater than or equal to the value specified with GE.

" + }, + "LE":{ + "shape":"ComparatorValue", + "documentation":"

The less than or equal to operator. The Evaluation results will have FilterVariable values that are less than or equal to the value specified with LE.

" + }, + "NE":{ + "shape":"ComparatorValue", + "documentation":"

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

" + }, + "Prefix":{ + "shape":"ComparatorValue", + "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, an Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

A two-value parameter that determines the sequence of the resulting list of Evaluation.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the page in the paginated results.

" + }, + "Limit":{ + "shape":"PageLimit", + "documentation":"

The maximum number of Evaluation to include in the result.

" + } + } + }, + "DescribeEvaluationsOutput":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"Evaluations", + "documentation":"

A list of Evaluation that meet the search criteria.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" + } + }, + "documentation":"

Represents the query results from a DescribeEvaluations operation. The content is essentially a list of Evaluation.

" + }, + "DescribeMLModelsInput":{ + "type":"structure", + "members":{ + "FilterVariable":{ + "shape":"MLModelFilterVariable", + "documentation":"

Use one of the following variables to filter a list of MLModel:

  • CreatedAt - Sets the search criteria to MLModel creation date.
  • Status - Sets the search criteria to MLModel status.
  • Name - Sets the search criteria to the contents of MLModel Name.
  • IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
  • TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
  • RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
  • MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
  • Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
  • TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" + }, + "EQ":{ + "shape":"ComparatorValue", + "documentation":"

The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

" + }, + "GT":{ + "shape":"ComparatorValue", + "documentation":"

The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

" + }, + "LT":{ + "shape":"ComparatorValue", + "documentation":"

The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

" + }, + "GE":{ + "shape":"ComparatorValue", + "documentation":"

The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.

" + }, + "LE":{ + "shape":"ComparatorValue", + "documentation":"

The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.

" + }, + "NE":{ + "shape":"ComparatorValue", + "documentation":"

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

" + }, + "Prefix":{ + "shape":"ComparatorValue", + "documentation":"

A string that is found at the beginning of a variable, such as Name or Id.

For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:

  • 2014-09

  • 2014-09-09

  • 2014-09-09-Holiday

" + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

A two-value parameter that determines the sequence of the resulting list of MLModel.

  • asc - Arranges the list in ascending order (A-Z, 0-9).
  • dsc - Arranges the list in descending order (Z-A, 9-0).

Results are sorted by FilterVariable.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the page in the paginated results.

" + }, + "Limit":{ + "shape":"PageLimit", + "documentation":"

The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.

" + } + } + }, + "DescribeMLModelsOutput":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"MLModels", + "documentation":"

A list of MLModel that meet the search criteria.

" + }, + "NextToken":{ + "shape":"StringType", + "documentation":"

The ID of the next page in the paginated results that indicates at least one more page follows.

" + } + }, + "documentation":"

Represents the output of a DescribeMLModels operation. The content is essentially a list of MLModel.

" + }, + "DescribeTagsInput":{ + "type":"structure", + "required":[ + "ResourceId", + "ResourceType" + ], + "members":{ + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the ML object. For example, exampleModelId.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the ML object.

" + } + } + }, + "DescribeTagsOutput":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the tagged ML object.

" + }, + "ResourceType":{ + "shape":"TaggableResourceType", + "documentation":"

The type of the tagged ML object.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of tags associated with the ML object.

" + } + }, + "documentation":"

Amazon ML returns the following elements.

" + }, + "DetailsAttributes":{ + "type":"string", + "enum":[ + "PredictiveModelType", + "Algorithm" + ], + "documentation":"Contains the key values of DetailsMap: PredictiveModelType - Indicates the type of the MLModel. Algorithm - Indicates the algorithm that was used for the MLModel." + }, + "DetailsMap":{ + "type":"map", + "key":{"shape":"DetailsAttributes"}, + "value":{"shape":"DetailsValue"}, + "documentation":"Provides any additional details regarding the prediction." + }, + "DetailsValue":{ + "type":"string", + "min":1 + }, + "EDPPipelineId":{ + "type":"string", + "min":1, + "max":1024 + }, + "EDPResourceRole":{ + "type":"string", + "min":1, + "max":64 + }, + "EDPSecurityGroupId":{ + "type":"string", + "min":1, + "max":255 + }, + "EDPSecurityGroupIds":{ + "type":"list", + "member":{"shape":"EDPSecurityGroupId"} + }, + "EDPServiceRole":{ + "type":"string", + "min":1, + "max":64 + }, + "EDPSubnetId":{ + "type":"string", + "min":1, + "max":255 + }, + "EntityId":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-zA-Z0-9_.-]+" + }, + "EntityName":{ + "type":"string", + "max":1024, + "pattern":".*\\S.*|^$", + "documentation":"

A user-supplied name or description of the Amazon ML resource.

" + }, + "EntityStatus":{ + "type":"string", + "enum":[ + "PENDING", + "INPROGRESS", + "FAILED", + "COMPLETED", + "DELETED" + ], + "documentation":"

Object status with the following possible values:

  • PENDING
  • INPROGRESS
  • FAILED
  • COMPLETED
  • DELETED
" + }, + "EpochTime":{ + "type":"timestamp", + "documentation":"

A timestamp represented in epoch time.

" + }, + "ErrorCode":{"type":"integer"}, + "ErrorMessage":{ + "type":"string", + "max":2048 + }, + "Evaluation":{ + "type":"structure", + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The ID that is assigned to the Evaluation at creation.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel that is the focus of the evaluation.

" + }, + "EvaluationDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the DataSource that is used to evaluate the MLModel.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the Evaluation was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the Evaluation.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.
" + }, + "PerformanceMetrics":{ + "shape":"PerformanceMetrics", + "documentation":"

Measurements of how well the MLModel performed, using observations referenced by the DataSource. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about evaluating the MLModel.

" + }, + "ComputeTime":{"shape":"LongType"}, + "FinishedAt":{"shape":"EpochTime"}, + "StartedAt":{"shape":"EpochTime"} + }, + "documentation":"

Represents the output of GetEvaluation operation.

The content consists of the detailed metadata and data file information and the current status of the Evaluation.

" + }, + "EvaluationFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "MLModelId", + "DataSourceId", + "DataURI" + ], + "documentation":"

A list of the variables to use in searching or filtering Evaluation.

  • CreatedAt - Sets the search criteria to Evaluation creation date.
  • Status - Sets the search criteria to Evaluation status.
  • Name - Sets the search criteria to the contents of Evaluation Name.
  • IAMUser - Sets the search criteria to the user account that invoked an evaluation.
  • MLModelId - Sets the search criteria to the Predictor that was evaluated.
  • DataSourceId - Sets the search criteria to the DataSource used in evaluation.
  • DataUri - Sets the search criteria to the data file(s) used in evaluation. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
" + }, + "Evaluations":{ + "type":"list", + "member":{"shape":"Evaluation"} + }, + "GetBatchPredictionInput":{ + "type":"structure", + "required":["BatchPredictionId"], + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

An ID assigned to the BatchPrediction at creation.

" + } + } + }, + "GetBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

An ID assigned to the BatchPrediction at creation. This value should be identical to the value of the BatchPredictionID in the request.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel that generated predictions for the BatchPrediction request.

" + }, + "BatchPredictionDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the DataSource that was used to create the BatchPrediction.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account that invoked the BatchPrediction. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time when the BatchPrediction was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the BatchPrediction.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The status of the BatchPrediction, which can be one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.
  • INPROGRESS - The batch predictions are in progress.
  • FAILED - The request to perform a batch prediction did not run to completion. It is not usable.
  • COMPLETED - The batch prediction process completed successfully.
  • DELETED - The BatchPrediction is marked as deleted. It is not usable.
" + }, + "OutputUri":{ + "shape":"S3Url", + "documentation":"

The location of an Amazon S3 bucket or directory to receive the operation results.

" + }, + "LogUri":{ + "shape":"PresignedS3Url", + "documentation":"

A link to the file that contains logs of the CreateBatchPrediction operation.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about processing the batch prediction request.

" + }, + "ComputeTime":{ + "shape":"LongType", + "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the BatchPrediction, normalized and scaled on computation resources. ComputeTime is only available if the BatchPrediction is in the COMPLETED state.

" + }, + "FinishedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the BatchPrediction as COMPLETED or FAILED. FinishedAt is only available when the BatchPrediction is in the COMPLETED or FAILED state.

" + }, + "StartedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the BatchPrediction as INPROGRESS. StartedAt isn't available if the BatchPrediction is in the PENDING state.

" + }, + "TotalRecordCount":{ + "shape":"LongType", + "documentation":"

The number of total records that Amazon Machine Learning saw while processing the BatchPrediction.

" + }, + "InvalidRecordCount":{ + "shape":"LongType", + "documentation":"

The number of invalid records that Amazon Machine Learning saw while processing the BatchPrediction.

" + } + }, + "documentation":"

Represents the output of a GetBatchPrediction operation and describes a BatchPrediction.

" + }, + "GetDataSourceInput":{ + "type":"structure", + "required":["DataSourceId"], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the DataSource at creation.

" + }, + "Verbose":{ + "shape":"Verbose", + "documentation":"

Specifies whether the GetDataSource operation should return DataSourceSchema.

If true, DataSourceSchema is returned.

If false, DataSourceSchema is not returned.

" + } + } + }, + "GetDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the DataSource at creation. This value should be identical to the value of the DataSourceId in the request.

" + }, + "DataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "DataRearrangement":{ + "shape":"DataRearrangement", + "documentation":"

A JSON string that represents the splitting and rearrangement requirement used when this DataSource was created.

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account from which the DataSource was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the DataSource was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

" + }, + "DataSizeInBytes":{ + "shape":"LongType", + "documentation":"

The total size of observations in the data files.

" + }, + "NumberOfFiles":{ + "shape":"LongType", + "documentation":"

The number of data files referenced by the DataSource.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the DataSource.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The current status of the DataSource. This element can have one of the following values:

  • PENDING - Amazon ML submitted a request to create a DataSource.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create a DataSource did not run to completion. It is not usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The DataSource is marked as deleted. It is not usable.
" + }, + "LogUri":{ + "shape":"PresignedS3Url", + "documentation":"

A link to the file containing logs of CreateDataSourceFrom* operations.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

The user-supplied description of the most recent details about creating the DataSource.

" + }, + "RedshiftMetadata":{"shape":"RedshiftMetadata"}, + "RDSMetadata":{"shape":"RDSMetadata"}, + "RoleARN":{"shape":"RoleARN"}, + "ComputeStatistics":{ + "shape":"ComputeStatistics", + "documentation":"

The parameter is true if statistics need to be generated from the observation data.

" + }, + "ComputeTime":{ + "shape":"LongType", + "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the DataSource, normalized and scaled on computation resources. ComputeTime is only available if the DataSource is in the COMPLETED state and the ComputeStatistics is set to true.

" + }, + "FinishedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the DataSource as COMPLETED or FAILED. FinishedAt is only available when the DataSource is in the COMPLETED or FAILED state.

" + }, + "StartedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the DataSource as INPROGRESS. StartedAt isn't available if the DataSource is in the PENDING state.

" + }, + "DataSourceSchema":{ + "shape":"DataSchema", + "documentation":"

The schema used by all of the data files of this DataSource.

Note

This parameter is provided as part of the verbose format.

" + } + }, + "documentation":"

Represents the output of a GetDataSource operation and describes a DataSource.

" + }, + "GetEvaluationInput":{ + "type":"structure", + "required":["EvaluationId"], + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The ID of the Evaluation to retrieve. The evaluation of each MLModel is recorded and cataloged. The ID provides the means to access the information.

" + } + } + }, + "GetEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The evaluation ID which is same as the EvaluationId in the request.

" + }, + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID of the MLModel that was the focus of the evaluation.

" + }, + "EvaluationDataSourceId":{ + "shape":"EntityId", + "documentation":"

The DataSource used for this evaluation.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the Evaluation was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the Evaluation.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The status of the evaluation. This element can have one of the following values:

  • PENDING - Amazon Machine Language (Amazon ML) submitted a request to evaluate an MLModel.
  • INPROGRESS - The evaluation is underway.
  • FAILED - The request to evaluate an MLModel did not run to completion. It is not usable.
  • COMPLETED - The evaluation process completed successfully.
  • DELETED - The Evaluation is marked as deleted. It is not usable.
" + }, + "PerformanceMetrics":{ + "shape":"PerformanceMetrics", + "documentation":"

Measurements of how well the MLModel performed using observations referenced by the DataSource. One of the following metric is returned based on the type of the MLModel:

  • BinaryAUC: A binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: A regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: A multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" + }, + "LogUri":{ + "shape":"PresignedS3Url", + "documentation":"

A link to the file that contains logs of the CreateEvaluation operation.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about evaluating the MLModel.

" + }, + "ComputeTime":{ + "shape":"LongType", + "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the Evaluation, normalized and scaled on computation resources. ComputeTime is only available if the Evaluation is in the COMPLETED state.

" + }, + "FinishedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the Evaluation as COMPLETED or FAILED. FinishedAt is only available when the Evaluation is in the COMPLETED or FAILED state.

" + }, + "StartedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the Evaluation as INPROGRESS. StartedAt isn't available if the Evaluation is in the PENDING state.

" + } + }, + "documentation":"

Represents the output of a GetEvaluation operation and describes an Evaluation.

" + }, + "GetMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel at creation.

" + }, + "Verbose":{ + "shape":"Verbose", + "documentation":"

Specifies whether the GetMLModel operation should return Recipe.

If true, Recipe is returned.

If false, Recipe is not returned.

" + } + } + }, + "GetMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The MLModel ID, which is same as the MLModelId in the request.

" + }, + "TrainingDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the training DataSource.

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the MLModel was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"MLModelName", + "documentation":"

A user-supplied name or description of the MLModel.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The current status of the MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to describe a MLModel.
  • INPROGRESS - The request is processing.
  • FAILED - The request did not run to completion. The ML model isn't usable.
  • COMPLETED - The request completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.
" + }, + "SizeInBytes":{"shape":"LongType"}, + "EndpointInfo":{ + "shape":"RealtimeEndpointInfo", + "documentation":"

The current endpoint of the MLModel

" + }, + "TrainingParameters":{ + "shape":"TrainingParameters", + "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none. We strongly recommend that you shuffle your data.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to zero, resulting in a sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm. It controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "MLModelType":{ + "shape":"MLModelType", + "documentation":"

Identifies the MLModel category. The following are the available types:

  • REGRESSION -- Produces a numeric result. For example, \"What price should a house be listed at?\"
  • BINARY -- Produces one of two possible results. For example, \"Is this an e-commerce website?\"
  • MULTICLASS -- Produces one of several possible results. For example, \"Is this a HIGH, LOW or MEDIUM risk trade?\"
" + }, + "ScoreThreshold":{ + "shape":"ScoreThreshold", + "documentation":"

The scoring threshold is used in binary classification MLModel models. It marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the threshold receive a positive result from the MLModel, such as true. Output values less than the threshold receive a negative response from the MLModel, such as false.

" + }, + "ScoreThresholdLastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" + }, + "LogUri":{ + "shape":"PresignedS3Url", + "documentation":"

A link to the file that contains logs of the CreateMLModel operation.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about accessing the MLModel.

" + }, + "ComputeTime":{ + "shape":"LongType", + "documentation":"

The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the MLModel, normalized and scaled on computation resources. ComputeTime is only available if the MLModel is in the COMPLETED state.

" + }, + "FinishedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the MLModel as COMPLETED or FAILED. FinishedAt is only available when the MLModel is in the COMPLETED or FAILED state.

" + }, + "StartedAt":{ + "shape":"EpochTime", + "documentation":"

The epoch time when Amazon Machine Learning marked the MLModel as INPROGRESS. StartedAt isn't available if the MLModel is in the PENDING state.

" + }, + "Recipe":{ + "shape":"Recipe", + "documentation":"

The recipe to use when training the MLModel. The Recipe provides detailed information about the observation data to use during training, and manipulations to perform on the observation data during training.

Note

This parameter is provided as part of the verbose format.

" + }, + "Schema":{ + "shape":"DataSchema", + "documentation":"

The schema used by all of the data files referenced by the DataSource.

Note

This parameter is provided as part of the verbose format.

" + } + }, + "documentation":"

Represents the output of a GetMLModel operation, and provides detailed information about a MLModel.

" + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.

" + }, + "IntegerType":{ + "type":"integer", + "documentation":"

Integer type that is a 32-bit signed number.

" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "documentation":"

An error on the server occurred when trying to process a request.

" + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

An error on the client occurred. Typically, the cause is an invalid input value.

" + }, + "InvalidTagException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "Label":{ + "type":"string", + "min":1 + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":417}, + "exception":true, + "documentation":"

The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as DataSource.

" + }, + "LongType":{ + "type":"long", + "documentation":"

Long integer type that is a 64-bit signed number.

" + }, + "MLModel":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel at creation.

" + }, + "TrainingDataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

" + }, + "CreatedByIamUser":{ + "shape":"AwsUserArn", + "documentation":"

The AWS user account from which the MLModel was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the MLModel was created. The time is expressed in epoch time.

" + }, + "LastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

" + }, + "Name":{ + "shape":"MLModelName", + "documentation":"

A user-supplied name or description of the MLModel.

" + }, + "Status":{ + "shape":"EntityStatus", + "documentation":"

The current status of an MLModel. This element can have one of the following values:

  • PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create an MLModel.
  • INPROGRESS - The creation process is underway.
  • FAILED - The request to create an MLModel didn't run to completion. The model isn't usable.
  • COMPLETED - The creation process completed successfully.
  • DELETED - The MLModel is marked as deleted. It isn't usable.
" + }, + "SizeInBytes":{"shape":"LongType"}, + "EndpointInfo":{ + "shape":"RealtimeEndpointInfo", + "documentation":"

The current endpoint of the MLModel.

" + }, + "TrainingParameters":{ + "shape":"TrainingParameters", + "documentation":"

A list of the training parameters in the MLModel. The list is implemented as a map of key-value pairs.

The following is the current set of training parameters:

  • sgd.maxMLModelSizeInBytes - The maximum allowed size of the model. Depending on the input data, the size of the model might affect its performance.

    The value is an integer that ranges from 100000 to 2147483648. The default value is 33554432.

  • sgd.maxPasses - The number of times that the training process traverses the observations to build the MLModel. The value is an integer that ranges from 1 to 10000. The default value is 10.

  • sgd.shuffleType - Whether Amazon ML shuffles the training data. Shuffling the data improves a model's ability to find the optimal solution for a variety of data types. The valid values are auto and none. The default value is none.

  • sgd.l1RegularizationAmount - The coefficient regularization L1 norm, which controls overfitting the data by penalizing large coefficients. This parameter tends to drive coefficients to zero, resulting in sparse feature set. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L1 normalization. This parameter can't be used when L2 is specified. Use this parameter sparingly.

  • sgd.l2RegularizationAmount - The coefficient regularization L2 norm, which controls overfitting the data by penalizing large coefficients. This tends to drive coefficients to small, nonzero values. If you use this parameter, start by specifying a small value, such as 1.0E-08.

    The value is a double that ranges from 0 to MAX_DOUBLE. The default is to not use L2 normalization. This parameter can't be used when L1 is specified. Use this parameter sparingly.

" + }, + "InputDataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

" + }, + "Algorithm":{ + "shape":"Algorithm", + "documentation":"

The algorithm used to train the MLModel. The following algorithm is supported:

  • SGD -- Stochastic gradient descent. The goal of SGD is to minimize the gradient of the loss function.
" + }, + "MLModelType":{ + "shape":"MLModelType", + "documentation":"

Identifies the MLModel category. The following are the available types:

  • REGRESSION - Produces a numeric result. For example, \"What price should a house be listed at?\"
  • BINARY - Produces one of two possible results. For example, \"Is this a child-friendly web site?\".
  • MULTICLASS - Produces one of several possible results. For example, \"Is this a HIGH-, LOW-, or MEDIUM-risk trade?\".
" + }, + "ScoreThreshold":{"shape":"ScoreThreshold"}, + "ScoreThresholdLastUpdatedAt":{ + "shape":"EpochTime", + "documentation":"

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

" + }, + "Message":{ + "shape":"Message", + "documentation":"

A description of the most recent details about accessing the MLModel.

" + }, + "ComputeTime":{"shape":"LongType"}, + "FinishedAt":{"shape":"EpochTime"}, + "StartedAt":{"shape":"EpochTime"} + }, + "documentation":"

Represents the output of a GetMLModel operation.

The content consists of the detailed metadata and the current status of the MLModel.

" + }, + "MLModelFilterVariable":{ + "type":"string", + "enum":[ + "CreatedAt", + "LastUpdatedAt", + "Status", + "Name", + "IAMUser", + "TrainingDataSourceId", + "RealtimeEndpointStatus", + "MLModelType", + "Algorithm", + "TrainingDataURI" + ] + }, + "MLModelName":{ + "type":"string", + "max":1024 + }, + "MLModelType":{ + "type":"string", + "enum":[ + "REGRESSION", + "BINARY", + "MULTICLASS" + ] + }, + "MLModels":{ + "type":"list", + "member":{"shape":"MLModel"} + }, + "Message":{ + "type":"string", + "max":10240, + "documentation":"

Description of the most recent details about an object.

" + }, + "PageLimit":{ + "type":"integer", + "min":1, + "max":100 + }, + "PerformanceMetrics":{ + "type":"structure", + "members":{ + "Properties":{"shape":"PerformanceMetricsProperties"} + }, + "documentation":"

Measurements of how well the MLModel performed on known observations. One of the following metrics is returned, based on the type of the MLModel:

  • BinaryAUC: The binary MLModel uses the Area Under the Curve (AUC) technique to measure performance.

  • RegressionRMSE: The regression MLModel uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.

  • MulticlassAvgFScore: The multiclass MLModel uses the F1 score technique to measure performance.

For more information about performance metrics, please see the Amazon Machine Learning Developer Guide.

" + }, + "PerformanceMetricsProperties":{ + "type":"map", + "key":{"shape":"PerformanceMetricsPropertyKey"}, + "value":{"shape":"PerformanceMetricsPropertyValue"} + }, + "PerformanceMetricsPropertyKey":{"type":"string"}, + "PerformanceMetricsPropertyValue":{"type":"string"}, + "PredictInput":{ + "type":"structure", + "required":[ + "MLModelId", + "Record", + "PredictEndpoint" + ], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

A unique identifier of the MLModel.

" + }, + "Record":{"shape":"Record"}, + "PredictEndpoint":{"shape":"VipURL"} + } + }, + "PredictOutput":{ + "type":"structure", + "members":{ + "Prediction":{"shape":"Prediction"} + } + }, + "Prediction":{ + "type":"structure", + "members":{ + "predictedLabel":{ + "shape":"Label", + "documentation":"

The prediction label for either a BINARY or MULTICLASS MLModel.

" + }, + "predictedValue":{ + "shape":"floatLabel", + "documentation":"The prediction value for REGRESSION MLModel." + }, + "predictedScores":{"shape":"ScoreValuePerLabelMap"}, + "details":{"shape":"DetailsMap"} + }, + "documentation":"

The output from a Predict operation:

  • Details - Contains the following attributes: DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS DetailsAttributes.ALGORITHM - SGD

  • PredictedLabel - Present for either a BINARY or MULTICLASS MLModel request.

  • PredictedScores - Contains the raw classification score corresponding to each label.

  • PredictedValue - Present for a REGRESSION MLModel request.

" + }, + "PredictorNotMountedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "error":{"httpStatusCode":400}, + "exception":true, + "documentation":"

The exception is thrown when a predict request is made to an unmounted MLModel.

" + }, + "PresignedS3Url":{"type":"string"}, + "RDSDataSpec":{ + "type":"structure", + "required":[ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation", + "ResourceRole", + "ServiceRole", + "SubnetId", + "SecurityGroupIds" + ], + "members":{ + "DatabaseInformation":{ + "shape":"RDSDatabase", + "documentation":"

Describes the DatabaseName and InstanceIdentifier of an Amazon RDS database.

" + }, + "SelectSqlQuery":{ + "shape":"RDSSelectSqlQuery", + "documentation":"

The query that is used to retrieve the observation data for the DataSource.

" + }, + "DatabaseCredentials":{ + "shape":"RDSDatabaseCredentials", + "documentation":"

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

" + }, + "S3StagingLocation":{ + "shape":"S3Url", + "documentation":"

The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

" + }, + "DataRearrangement":{ + "shape":"DataRearrangement", + "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" + }, + "DataSchema":{ + "shape":"DataSchema", + "documentation":"

A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" + }, + "DataSchemaUri":{ + "shape":"S3Url", + "documentation":"

The Amazon S3 location of the DataSchema.

" + }, + "ResourceRole":{ + "shape":"EDPResourceRole", + "documentation":"

The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

" + }, + "ServiceRole":{ + "shape":"EDPServiceRole", + "documentation":"

The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" + }, + "SubnetId":{ + "shape":"EDPSubnetId", + "documentation":"

The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

" + }, + "SecurityGroupIds":{ + "shape":"EDPSecurityGroupIds", + "documentation":"

The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

" + } + }, + "documentation":"

The data specification of an Amazon Relational Database Service (Amazon RDS) DataSource.

" + }, + "RDSDatabase":{ + "type":"structure", + "required":[ + "InstanceIdentifier", + "DatabaseName" + ], + "members":{ + "InstanceIdentifier":{ + "shape":"RDSInstanceIdentifier", + "documentation":"

The ID of an RDS DB instance.

" + }, + "DatabaseName":{"shape":"RDSDatabaseName"} + }, + "documentation":"

The database details of an Amazon RDS database.

" + }, + "RDSDatabaseCredentials":{ + "type":"structure", + "required":[ + "Username", + "Password" + ], + "members":{ + "Username":{"shape":"RDSDatabaseUsername"}, + "Password":{"shape":"RDSDatabasePassword"} + }, + "documentation":"

The database credentials to connect to a database on an RDS DB instance.

" + }, + "RDSDatabaseName":{ + "type":"string", + "min":1, + "max":64, + "documentation":"

The name of a database hosted on an RDS DB instance.

" + }, + "RDSDatabasePassword":{ + "type":"string", + "min":8, + "max":128, + "documentation":"

The password to be used by Amazon ML to connect to a database on an RDS DB instance. The password should have sufficient permissions to execute the RDSSelectQuery query.

" + }, + "RDSDatabaseUsername":{ + "type":"string", + "min":1, + "max":128, + "documentation":"

The username to be used by Amazon ML to connect to database on an Amazon RDS instance. The username should have sufficient permissions to execute an RDSSelectSqlQuery query.

" + }, + "RDSInstanceIdentifier":{ + "type":"string", + "min":1, + "max":63, + "pattern":"[a-z0-9-]+", + "documentation":"Identifier of RDS DB Instances." + }, + "RDSMetadata":{ + "type":"structure", + "members":{ + "Database":{ + "shape":"RDSDatabase", + "documentation":"

The database details required to connect to an Amazon RDS.

" + }, + "DatabaseUserName":{"shape":"RDSDatabaseUsername"}, + "SelectSqlQuery":{ + "shape":"RDSSelectSqlQuery", + "documentation":"

The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

" + }, + "ResourceRole":{ + "shape":"EDPResourceRole", + "documentation":"

The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" + }, + "ServiceRole":{ + "shape":"EDPServiceRole", + "documentation":"

The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

" + }, + "DataPipelineId":{ + "shape":"EDPPipelineId", + "documentation":"

The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.

" + } + }, + "documentation":"

The datasource details that are specific to Amazon RDS.

" + }, + "RDSSelectSqlQuery":{ + "type":"string", + "min":1, + "max":16777216, + "documentation":"

The SQL query to be executed against the Amazon RDS database. The SQL query should be valid for the Amazon RDS type being used.

" + }, + "RealtimeEndpointInfo":{ + "type":"structure", + "members":{ + "PeakRequestsPerSecond":{ + "shape":"IntegerType", + "documentation":"

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

" + }, + "CreatedAt":{ + "shape":"EpochTime", + "documentation":"

The time that the request to create the real-time endpoint for the MLModel was received. The time is expressed in epoch time.

" + }, + "EndpointUrl":{ + "shape":"VipURL", + "documentation":"

The URI that specifies where to send real-time prediction requests for the MLModel.

Note

The application must wait until the real-time endpoint is ready before using this URI.

" + }, + "EndpointStatus":{ + "shape":"RealtimeEndpointStatus", + "documentation":"

The current status of the real-time endpoint for the MLModel. This element can have one of the following values:

  • NONE - Endpoint does not exist or was previously deleted.
  • READY - Endpoint is ready to be used for real-time predictions.
  • UPDATING - Updating/creating the endpoint.
" + } + }, + "documentation":"

Describes the real-time endpoint information for an MLModel.

" + }, + "RealtimeEndpointStatus":{ + "type":"string", + "enum":[ + "NONE", + "READY", + "UPDATING", + "FAILED" + ] + }, + "Recipe":{ + "type":"string", + "max":131071 + }, + "Record":{ + "type":"map", + "key":{"shape":"VariableName"}, + "value":{"shape":"VariableValue"}, + "documentation":"

A map of variable name-value pairs that represent an observation.

" + }, + "RedshiftClusterIdentifier":{ + "type":"string", + "min":1, + "max":63, + "pattern":"[a-z0-9-]+", + "documentation":"

The ID of an Amazon Redshift cluster.

" + }, + "RedshiftDataSpec":{ + "type":"structure", + "required":[ + "DatabaseInformation", + "SelectSqlQuery", + "DatabaseCredentials", + "S3StagingLocation" + ], + "members":{ + "DatabaseInformation":{ + "shape":"RedshiftDatabase", + "documentation":"

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

" + }, + "SelectSqlQuery":{ + "shape":"RedshiftSelectSqlQuery", + "documentation":"

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

" + }, + "DatabaseCredentials":{ + "shape":"RedshiftDatabaseCredentials", + "documentation":"

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

" + }, + "S3StagingLocation":{ + "shape":"S3Url", + "documentation":"

Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

" + }, + "DataRearrangement":{ + "shape":"DataRearrangement", + "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" + }, + "DataSchema":{ + "shape":"DataSchema", + "documentation":"

A JSON string that represents the schema for an Amazon Redshift DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

A DataSchema is not required if you specify a DataSchemaUri.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" + }, + "DataSchemaUri":{ + "shape":"S3Url", + "documentation":"

Describes the schema location for an Amazon Redshift DataSource.

" + } + }, + "documentation":"

Describes the data specification of an Amazon Redshift DataSource.

" + }, + "RedshiftDatabase":{ + "type":"structure", + "required":[ + "DatabaseName", + "ClusterIdentifier" + ], + "members":{ + "DatabaseName":{"shape":"RedshiftDatabaseName"}, + "ClusterIdentifier":{"shape":"RedshiftClusterIdentifier"} + }, + "documentation":"

Describes the database details required to connect to an Amazon Redshift database.

" + }, + "RedshiftDatabaseCredentials":{ + "type":"structure", + "required":[ + "Username", + "Password" + ], + "members":{ + "Username":{"shape":"RedshiftDatabaseUsername"}, + "Password":{"shape":"RedshiftDatabasePassword"} + }, + "documentation":"

Describes the database credentials for connecting to a database on an Amazon Redshift cluster.

" + }, + "RedshiftDatabaseName":{ + "type":"string", + "min":1, + "max":64, + "pattern":"[a-z0-9]+", + "documentation":"

The name of a database hosted on an Amazon Redshift cluster.

" + }, + "RedshiftDatabasePassword":{ + "type":"string", + "min":8, + "max":64, + "documentation":"

A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster. The password should have sufficient permissions to execute a RedshiftSelectSqlQuery query. The password should be valid for an Amazon Redshift USER.

" + }, + "RedshiftDatabaseUsername":{ + "type":"string", + "min":1, + "max":128, + "documentation":"

A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster. The username should have sufficient permissions to execute the RedshiftSelectSqlQuery query. The username should be valid for an Amazon Redshift USER.

" + }, + "RedshiftMetadata":{ + "type":"structure", + "members":{ + "RedshiftDatabase":{"shape":"RedshiftDatabase"}, + "DatabaseUserName":{"shape":"RedshiftDatabaseUsername"}, + "SelectSqlQuery":{ + "shape":"RedshiftSelectSqlQuery", + "documentation":"

The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

" + } + }, + "documentation":"

Describes the DataSource details specific to Amazon Redshift.

" + }, + "RedshiftSelectSqlQuery":{ + "type":"string", + "min":1, + "max":16777216, + "documentation":"

Describes the SQL query to execute on the Amazon Redshift database. The SQL query should be valid for an Amazon Redshift SELECT.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "code":{"shape":"ErrorCode"} + }, + "error":{"httpStatusCode":404}, + "exception":true, + "documentation":"

A specified resource cannot be located.

" + }, + "RoleARN":{ + "type":"string", + "min":1, + "max":110, + "documentation":"

The Amazon Resource Name (ARN) of an AWS IAM Role, such as the following: arn:aws:iam::account:role/rolename.

" + }, + "S3DataSpec":{ + "type":"structure", + "required":["DataLocationS3"], + "members":{ + "DataLocationS3":{ + "shape":"S3Url", + "documentation":"

The location of the data file(s) used by a DataSource. The URI specifies a data file or an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.

" + }, + "DataRearrangement":{ + "shape":"DataRearrangement", + "documentation":"

A JSON string that represents the splitting and rearrangement processing to be applied to a DataSource. If the DataRearrangement parameter is not provided, all of the input data is used to create the Datasource.

There are multiple parameters that control what data is used to create a datasource:

  • percentBegin

    Use percentBegin to indicate the beginning of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • percentEnd

    Use percentEnd to indicate the end of the range of the data used to create the Datasource. If you do not include percentBegin and percentEnd, Amazon ML includes all of the data when creating the datasource.

  • complement

    The complement parameter instructs Amazon ML to use the data that is not included in the range of percentBegin to percentEnd to create a datasource. The complement parameter is useful if you need to create complementary datasources for training and evaluation. To create a complementary datasource, use the same values for percentBegin and percentEnd, along with the complement parameter.

    For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25}}

    Datasource for training: {\"splitting\":{\"percentBegin\":0, \"percentEnd\":25, \"complement\":\"true\"}}

  • strategy

    To change how Amazon ML splits the data for a datasource, use the strategy parameter.

    The default value for the strategy parameter is sequential, meaning that Amazon ML takes all of the data records between the percentBegin and percentEnd parameters for the datasource, in the order that the records appear in the input data.

    The following two DataRearrangement lines are examples of sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"sequential\", \"complement\":\"true\"}}

    To randomly split the input data into the proportions indicated by the percentBegin and percentEnd parameters, set the strategy parameter to random and provide a string that is used as the seed value for the random data splitting (for example, you can use the S3 path to your data as the random seed string). If you choose the random split strategy, Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned number between percentBegin and percentEnd. Pseudo-random numbers are assigned using both the input seed string value and the byte offset as a seed, so changing the data results in a different split. Any existing ordering is preserved. The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly. It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in training and evaluation datasources containing non-similar data records.

    The following two DataRearrangement lines are examples of non-sequentially ordered training and evaluation datasources:

    Datasource for evaluation: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\"}}

    Datasource for training: {\"splitting\":{\"percentBegin\":70, \"percentEnd\":100, \"strategy\":\"random\", \"randomSeed\"=\"s3://my_s3_path/bucket/file.csv\", \"complement\":\"true\"}}

" + }, + "DataSchema":{ + "shape":"DataSchema", + "documentation":"

A JSON string that represents the schema for an Amazon S3 DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

You must provide either the DataSchema or the DataSchemaLocationS3.

Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

{ \"version\": \"1.0\",

\"recordAnnotationFieldName\": \"F1\",

\"recordWeightFieldName\": \"F2\",

\"targetFieldName\": \"F3\",

\"dataFormat\": \"CSV\",

\"dataFileContainsHeader\": true,

\"attributes\": [

{ \"fieldName\": \"F1\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F2\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F3\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F4\", \"fieldType\": \"NUMERIC\" }, { \"fieldName\": \"F5\", \"fieldType\": \"CATEGORICAL\" }, { \"fieldName\": \"F6\", \"fieldType\": \"TEXT\" }, { \"fieldName\": \"F7\", \"fieldType\": \"WEIGHTED_INT_SEQUENCE\" }, { \"fieldName\": \"F8\", \"fieldType\": \"WEIGHTED_STRING_SEQUENCE\" } ],

\"excludedVariableNames\": [ \"F6\" ] }

" + }, + "DataSchemaLocationS3":{ + "shape":"S3Url", + "documentation":"

Describes the schema location in Amazon S3. You must provide either the DataSchema or the DataSchemaLocationS3.

" + } + }, + "documentation":"

Describes the data specification of a DataSource.

" + }, + "S3Url":{ + "type":"string", + "max":2048, + "pattern":"s3://([^/]+)(/.*)?", + "documentation":"

A reference to a file or bucket on Amazon Simple Storage Service (Amazon S3).

" + }, + "ScoreThreshold":{"type":"float"}, + "ScoreValue":{"type":"float"}, + "ScoreValuePerLabelMap":{ + "type":"map", + "key":{"shape":"Label"}, + "value":{"shape":"ScoreValue"}, + "documentation":"Provides the raw classification score corresponding to each label." + }, + "SortOrder":{ + "type":"string", + "enum":[ + "asc", + "dsc" + ], + "documentation":"

The sort order specified in a listing condition. Possible values include the following:

  • asc - Present the information in ascending order (from A-Z).
  • dsc - Present the information in descending order (from Z-A).
" + }, + "StringType":{ + "type":"string", + "documentation":"

String type.

" + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.

" + } + }, + "documentation":"

A custom key-value pair associated with an ML object, such as an ML model.

" + }, + "TagKey":{ + "type":"string", + "min":1, + "max":128, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":100 + }, + "TagLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":100 + }, + "TagValue":{ + "type":"string", + "min":0, + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TaggableResourceType":{ + "type":"string", + "enum":[ + "BatchPrediction", + "DataSource", + "Evaluation", + "MLModel" + ] + }, + "TrainingParameters":{ + "type":"map", + "key":{"shape":"StringType"}, + "value":{"shape":"StringType"} + }, + "UpdateBatchPredictionInput":{ + "type":"structure", + "required":[ + "BatchPredictionId", + "BatchPredictionName" + ], + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the BatchPrediction during creation.

" + }, + "BatchPredictionName":{ + "shape":"EntityName", + "documentation":"

A new user-supplied name or description of the BatchPrediction.

" + } + } + }, + "UpdateBatchPredictionOutput":{ + "type":"structure", + "members":{ + "BatchPredictionId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the BatchPrediction during creation. This value should be identical to the value of the BatchPredictionId in the request.

" + } + }, + "documentation":"

Represents the output of an UpdateBatchPrediction operation.

You can see the updated content by using the GetBatchPrediction operation.

" + }, + "UpdateDataSourceInput":{ + "type":"structure", + "required":[ + "DataSourceId", + "DataSourceName" + ], + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the DataSource during creation.

" + }, + "DataSourceName":{ + "shape":"EntityName", + "documentation":"

A new user-supplied name or description of the DataSource that will replace the current description.

" + } + } + }, + "UpdateDataSourceOutput":{ + "type":"structure", + "members":{ + "DataSourceId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the DataSource during creation. This value should be identical to the value of the DataSourceID in the request.

" + } + }, + "documentation":"

Represents the output of an UpdateDataSource operation.

You can see the updated content by using the GetBatchPrediction operation.

" + }, + "UpdateEvaluationInput":{ + "type":"structure", + "required":[ + "EvaluationId", + "EvaluationName" + ], + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the Evaluation during creation.

" + }, + "EvaluationName":{ + "shape":"EntityName", + "documentation":"

A new user-supplied name or description of the Evaluation that will replace the current content.

" + } + } + }, + "UpdateEvaluationOutput":{ + "type":"structure", + "members":{ + "EvaluationId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the Evaluation during creation. This value should be identical to the value of the Evaluation in the request.

" + } + }, + "documentation":"

Represents the output of an UpdateEvaluation operation.

You can see the updated content by using the GetEvaluation operation.

" + }, + "UpdateMLModelInput":{ + "type":"structure", + "required":["MLModelId"], + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel during creation.

" + }, + "MLModelName":{ + "shape":"EntityName", + "documentation":"

A user-supplied name or description of the MLModel.

" + }, + "ScoreThreshold":{ + "shape":"ScoreThreshold", + "documentation":"

The ScoreThreshold used in binary classification MLModel that marks the boundary between a positive prediction and a negative prediction.

Output values greater than or equal to the ScoreThreshold receive a positive result from the MLModel, such as true. Output values less than the ScoreThreshold receive a negative response from the MLModel, such as false.

" + } + } + }, + "UpdateMLModelOutput":{ + "type":"structure", + "members":{ + "MLModelId":{ + "shape":"EntityId", + "documentation":"

The ID assigned to the MLModel during creation. This value should be identical to the value of the MLModelID in the request.

" + } + }, + "documentation":"

Represents the output of an UpdateMLModel operation.

You can see the updated content by using the GetMLModel operation.

" + }, + "VariableName":{ + "type":"string", + "documentation":"

The name of a variable. Currently it's used to specify the name of the target value, label, weight, and tags.

" + }, + "VariableValue":{ + "type":"string", + "documentation":"

The value of a variable. Currently it's used to specify values of the target value, weights, and tag variables and for filtering variable values.

" + }, + "Verbose":{ + "type":"boolean", + "documentation":"

Specifies whether a describe operation should return exhaustive or abbreviated information.

" + }, + "VipURL":{ + "type":"string", + "max":2048, + "pattern":"https://[a-zA-Z0-9-.]*\\.amazon(aws)?\\.com[/]?" + }, + "floatLabel":{"type":"float"} + }, + "examples":{ + } +} diff --git a/aws/dist/botocore/data/machinelearning/2014-12-12/waiters-2.json b/aws/dist/botocore/data/machinelearning/2014-12-12/waiters-2.json new file mode 100644 index 00000000..da6b1c95 --- /dev/null +++ b/aws/dist/botocore/data/machinelearning/2014-12-12/waiters-2.json @@ -0,0 +1,81 @@ +{ + "version": 2, + "waiters": { + "DataSourceAvailable": { + "delay": 30, + "operation": "DescribeDataSources", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "MLModelAvailable": { + "delay": 30, + "operation": "DescribeMLModels", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "EvaluationAvailable": { + "delay": 30, + "operation": "DescribeEvaluations", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + }, + "BatchPredictionAvailable": { + "delay": 30, + "operation": "DescribeBatchPredictions", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "COMPLETED", + "matcher": "pathAll", + "state": "success", + "argument": "Results[].Status" + }, + { + "expected": "FAILED", + "matcher": "pathAny", + "state": "failure", + "argument": "Results[].Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/macie/2017-12-19/paginators-1.json b/aws/dist/botocore/data/macie/2017-12-19/paginators-1.json new file mode 100644 index 00000000..f7b6a2c2 --- /dev/null +++ b/aws/dist/botocore/data/macie/2017-12-19/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListMemberAccounts": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "memberAccounts" + }, + "ListS3Resources": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "s3Resources" + } + } +} diff --git a/aws/dist/botocore/data/macie/2017-12-19/service-2.json b/aws/dist/botocore/data/macie/2017-12-19/service-2.json new file mode 100644 index 00000000..c3114b69 --- /dev/null +++ b/aws/dist/botocore/data/macie/2017-12-19/service-2.json @@ -0,0 +1,495 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-12-19", + "endpointPrefix":"macie", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Macie", + "serviceId":"Macie", + "signatureVersion":"v4", + "targetPrefix":"MacieService", + "uid":"macie-2017-12-19" + }, + "operations":{ + "AssociateMemberAccount":{ + "name":"AssociateMemberAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateMemberAccountRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalException"} + ], + "documentation":"

Associates a specified AWS account with Amazon Macie as a member account.

" + }, + "AssociateS3Resources":{ + "name":"AssociateS3Resources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateS3ResourcesRequest"}, + "output":{"shape":"AssociateS3ResourcesResult"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalException"} + ], + "documentation":"

Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account.

" + }, + "DisassociateMemberAccount":{ + "name":"DisassociateMemberAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateMemberAccountRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InternalException"} + ], + "documentation":"

Removes the specified member account from Amazon Macie.

" + }, + "DisassociateS3Resources":{ + "name":"DisassociateS3Resources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateS3ResourcesRequest"}, + "output":{"shape":"DisassociateS3ResourcesResult"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"} + ], + "documentation":"

Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.

" + }, + "ListMemberAccounts":{ + "name":"ListMemberAccounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMemberAccountsRequest"}, + "output":{"shape":"ListMemberAccountsResult"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Lists all Amazon Macie member accounts for the current Amazon Macie master account.

" + }, + "ListS3Resources":{ + "name":"ListS3Resources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListS3ResourcesRequest"}, + "output":{"shape":"ListS3ResourcesResult"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"} + ], + "documentation":"

Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.

" + }, + "UpdateS3Resources":{ + "name":"UpdateS3Resources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateS3ResourcesRequest"}, + "output":{"shape":"UpdateS3ResourcesResult"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalException"} + ], + "documentation":"

Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account.

" + } + }, + "shapes":{ + "AWSAccountId":{ + "type":"string", + "pattern":"[0-9]{12}" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"}, + "resourceType":{"shape":"ResourceType"} + }, + "documentation":"

You do not have required permissions to access the requested resource.

", + "exception":true + }, + "AssociateMemberAccountRequest":{ + "type":"structure", + "required":["memberAccountId"], + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The ID of the AWS account that you want to associate with Amazon Macie as a member account.

" + } + } + }, + "AssociateS3ResourcesRequest":{ + "type":"structure", + "required":["s3Resources"], + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The ID of the Amazon Macie member account whose resources you want to associate with Macie.

" + }, + "s3Resources":{ + "shape":"S3ResourcesClassification", + "documentation":"

The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.

" + } + } + }, + "AssociateS3ResourcesResult":{ + "type":"structure", + "members":{ + "failedS3Resources":{ + "shape":"FailedS3Resources", + "documentation":"

S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item.

" + } + } + }, + "BucketName":{ + "type":"string", + "max":500 + }, + "ClassificationType":{ + "type":"structure", + "required":[ + "oneTime", + "continuous" + ], + "members":{ + "oneTime":{ + "shape":"S3OneTimeClassificationType", + "documentation":"

A one-time classification of all of the existing objects in a specified S3 bucket.

" + }, + "continuous":{ + "shape":"S3ContinuousClassificationType", + "documentation":"

A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

" + } + }, + "documentation":"

The classification type that Amazon Macie applies to the associated S3 resources.

" + }, + "ClassificationTypeUpdate":{ + "type":"structure", + "members":{ + "oneTime":{ + "shape":"S3OneTimeClassificationType", + "documentation":"

A one-time classification of all of the existing objects in a specified S3 bucket.

" + }, + "continuous":{ + "shape":"S3ContinuousClassificationType", + "documentation":"

A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

" + } + }, + "documentation":"

The classification type that Amazon Macie applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified.

" + }, + "DisassociateMemberAccountRequest":{ + "type":"structure", + "required":["memberAccountId"], + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The ID of the member account that you want to remove from Amazon Macie.

" + } + } + }, + "DisassociateS3ResourcesRequest":{ + "type":"structure", + "required":["associatedS3Resources"], + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie.

" + }, + "associatedS3Resources":{ + "shape":"S3Resources", + "documentation":"

The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie.

" + } + } + }, + "DisassociateS3ResourcesResult":{ + "type":"structure", + "members":{ + "failedS3Resources":{ + "shape":"FailedS3Resources", + "documentation":"

S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item.

" + } + } + }, + "ErrorCode":{ + "type":"string", + "documentation":"Error code for the exception", + "max":10 + }, + "ExceptionMessage":{ + "type":"string", + "max":10000 + }, + "FailedS3Resource":{ + "type":"structure", + "members":{ + "failedItem":{ + "shape":"S3Resource", + "documentation":"

The failed S3 resources.

" + }, + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

The status code of a failed item.

" + }, + "errorMessage":{ + "shape":"ExceptionMessage", + "documentation":"

The error message of a failed item.

" + } + }, + "documentation":"

Includes details about the failed S3 resources.

" + }, + "FailedS3Resources":{ + "type":"list", + "member":{"shape":"FailedS3Resource"} + }, + "FieldName":{ + "type":"string", + "documentation":"Field that has invalid input", + "max":1000 + }, + "InternalException":{ + "type":"structure", + "members":{ + "errorCode":{"shape":"ErrorCode"}, + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Internal server error.

", + "exception":true, + "fault":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "errorCode":{"shape":"ErrorCode"}, + "message":{"shape":"ExceptionMessage"}, + "fieldName":{"shape":"FieldName"} + }, + "documentation":"

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

", + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "errorCode":{"shape":"ErrorCode"}, + "message":{"shape":"ExceptionMessage"}, + "resourceType":{"shape":"ResourceType"} + }, + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

", + "exception":true + }, + "ListMemberAccountsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

" + } + } + }, + "ListMemberAccountsResult":{ + "type":"structure", + "members":{ + "memberAccounts":{ + "shape":"MemberAccounts", + "documentation":"

A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "ListS3ResourcesRequest":{ + "type":"structure", + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The Amazon Macie member account ID whose associated S3 resources you want to list.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

" + } + } + }, + "ListS3ResourcesResult":{ + "type":"structure", + "members":{ + "s3Resources":{ + "shape":"S3ResourcesClassification", + "documentation":"

A list of the associated S3 resources returned by the action.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":250 + }, + "MemberAccount":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"AWSAccountId", + "documentation":"

The AWS account ID of the Amazon Macie member account.

" + } + }, + "documentation":"

Contains information about the Amazon Macie member account.

" + }, + "MemberAccounts":{ + "type":"list", + "member":{"shape":"MemberAccount"} + }, + "NextToken":{ + "type":"string", + "max":500 + }, + "Prefix":{ + "type":"string", + "max":10000 + }, + "ResourceType":{ + "type":"string", + "documentation":"Resource type that caused the exception", + "max":1000 + }, + "S3ContinuousClassificationType":{ + "type":"string", + "enum":["FULL"] + }, + "S3OneTimeClassificationType":{ + "type":"string", + "enum":[ + "FULL", + "NONE" + ] + }, + "S3Resource":{ + "type":"structure", + "required":["bucketName"], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

The name of the S3 bucket.

" + }, + "prefix":{ + "shape":"Prefix", + "documentation":"

The prefix of the S3 bucket.

" + } + }, + "documentation":"

Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions.

" + }, + "S3ResourceClassification":{ + "type":"structure", + "required":[ + "bucketName", + "classificationType" + ], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

The name of the S3 bucket that you want to associate with Amazon Macie.

" + }, + "prefix":{ + "shape":"Prefix", + "documentation":"

The prefix of the S3 bucket that you want to associate with Amazon Macie.

" + }, + "classificationType":{ + "shape":"ClassificationType", + "documentation":"

The classification type that you want to specify for the resource associated with Amazon Macie.

" + } + }, + "documentation":"

The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action.

" + }, + "S3ResourceClassificationUpdate":{ + "type":"structure", + "required":[ + "bucketName", + "classificationTypeUpdate" + ], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

The name of the S3 bucket whose classification types you want to update.

" + }, + "prefix":{ + "shape":"Prefix", + "documentation":"

The prefix of the S3 bucket whose classification types you want to update.

" + }, + "classificationTypeUpdate":{ + "shape":"ClassificationTypeUpdate", + "documentation":"

The classification type that you want to update for the resource associated with Amazon Macie.

" + } + }, + "documentation":"

The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action.

" + }, + "S3Resources":{ + "type":"list", + "member":{"shape":"S3Resource"} + }, + "S3ResourcesClassification":{ + "type":"list", + "member":{"shape":"S3ResourceClassification"} + }, + "S3ResourcesClassificationUpdate":{ + "type":"list", + "member":{"shape":"S3ResourceClassificationUpdate"} + }, + "UpdateS3ResourcesRequest":{ + "type":"structure", + "required":["s3ResourcesUpdate"], + "members":{ + "memberAccountId":{ + "shape":"AWSAccountId", + "documentation":"

The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.

" + }, + "s3ResourcesUpdate":{ + "shape":"S3ResourcesClassificationUpdate", + "documentation":"

The S3 resources whose classification types you want to update.

" + } + } + }, + "UpdateS3ResourcesResult":{ + "type":"structure", + "members":{ + "failedS3Resources":{ + "shape":"FailedS3Resources", + "documentation":"

The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.

" + } + } + } + }, + "documentation":"Amazon Macie

Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the Macie User Guide.

" +} diff --git a/aws/dist/botocore/data/managedblockchain/2018-09-24/paginators-1.json b/aws/dist/botocore/data/managedblockchain/2018-09-24/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/managedblockchain/2018-09-24/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/managedblockchain/2018-09-24/service-2.json b/aws/dist/botocore/data/managedblockchain/2018-09-24/service-2.json new file mode 100644 index 00000000..36523922 --- /dev/null +++ b/aws/dist/botocore/data/managedblockchain/2018-09-24/service-2.json @@ -0,0 +1,1863 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-09-24", + "endpointPrefix":"managedblockchain", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"ManagedBlockchain", + "serviceFullName":"Amazon Managed Blockchain", + "serviceId":"ManagedBlockchain", + "signatureVersion":"v4", + "signingName":"managedblockchain", + "uid":"managedblockchain-2018-09-24" + }, + "operations":{ + "CreateMember":{ + "name":"CreateMember", + "http":{ + "method":"POST", + "requestUri":"/networks/{networkId}/members" + }, + "input":{"shape":"CreateMemberInput"}, + "output":{"shape":"CreateMemberOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotReadyException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Creates a member within a Managed Blockchain network.

" + }, + "CreateNetwork":{ + "name":"CreateNetwork", + "http":{ + "method":"POST", + "requestUri":"/networks" + }, + "input":{"shape":"CreateNetworkInput"}, + "output":{"shape":"CreateNetworkOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Creates a new blockchain network using Amazon Managed Blockchain.

" + }, + "CreateNode":{ + "name":"CreateNode", + "http":{ + "method":"POST", + "requestUri":"/networks/{networkId}/members/{memberId}/nodes" + }, + "input":{"shape":"CreateNodeInput"}, + "output":{"shape":"CreateNodeOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotReadyException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Creates a peer node in a member.

" + }, + "CreateProposal":{ + "name":"CreateProposal", + "http":{ + "method":"POST", + "requestUri":"/networks/{networkId}/proposals" + }, + "input":{"shape":"CreateProposalInput"}, + "output":{"shape":"CreateProposalOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotReadyException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Creates a proposal for a change to the network that other members of the network can vote on, for example, a proposal to add a new member to the network. Any member can create a proposal.

" + }, + "DeleteMember":{ + "name":"DeleteMember", + "http":{ + "method":"DELETE", + "requestUri":"/networks/{networkId}/members/{memberId}" + }, + "input":{"shape":"DeleteMemberInput"}, + "output":{"shape":"DeleteMemberOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotReadyException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Deletes a member. Deleting a member removes the member and all associated resources from the network. DeleteMember can only be called for a specified MemberId if the principal performing the action is associated with the AWS account that owns the member. In all other cases, the DeleteMember action is carried out as the result of an approved proposal to remove a member. If MemberId is the last member in a network specified by the last AWS account, the network is deleted also.

" + }, + "DeleteNode":{ + "name":"DeleteNode", + "http":{ + "method":"DELETE", + "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + }, + "input":{"shape":"DeleteNodeInput"}, + "output":{"shape":"DeleteNodeOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceNotReadyException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Deletes a peer node from a member that your AWS account owns. All data on the node is lost and cannot be recovered.

" + }, + "GetMember":{ + "name":"GetMember", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/members/{memberId}" + }, + "input":{"shape":"GetMemberInput"}, + "output":{"shape":"GetMemberOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns detailed information about a member.

" + }, + "GetNetwork":{ + "name":"GetNetwork", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}" + }, + "input":{"shape":"GetNetworkInput"}, + "output":{"shape":"GetNetworkOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns detailed information about a network.

" + }, + "GetNode":{ + "name":"GetNode", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/members/{memberId}/nodes/{nodeId}" + }, + "input":{"shape":"GetNodeInput"}, + "output":{"shape":"GetNodeOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns detailed information about a peer node.

" + }, + "GetProposal":{ + "name":"GetProposal", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/proposals/{proposalId}" + }, + "input":{"shape":"GetProposalInput"}, + "output":{"shape":"GetProposalOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns detailed information about a proposal.

" + }, + "ListInvitations":{ + "name":"ListInvitations", + "http":{ + "method":"GET", + "requestUri":"/invitations" + }, + "input":{"shape":"ListInvitationsInput"}, + "output":{"shape":"ListInvitationsOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns a listing of all invitations made on the specified network.

" + }, + "ListMembers":{ + "name":"ListMembers", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/members" + }, + "input":{"shape":"ListMembersInput"}, + "output":{"shape":"ListMembersOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns a listing of the members in a network and properties of their configurations.

" + }, + "ListNetworks":{ + "name":"ListNetworks", + "http":{ + "method":"GET", + "requestUri":"/networks" + }, + "input":{"shape":"ListNetworksInput"}, + "output":{"shape":"ListNetworksOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns information about the networks in which the current AWS account has members.

" + }, + "ListNodes":{ + "name":"ListNodes", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/members/{memberId}/nodes" + }, + "input":{"shape":"ListNodesInput"}, + "output":{"shape":"ListNodesOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns information about the nodes within a network.

" + }, + "ListProposalVotes":{ + "name":"ListProposalVotes", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/proposals/{proposalId}/votes" + }, + "input":{"shape":"ListProposalVotesInput"}, + "output":{"shape":"ListProposalVotesOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns the listing of votes for a specified proposal, including the value of each vote and the unique identifier of the member that cast the vote.

" + }, + "ListProposals":{ + "name":"ListProposals", + "http":{ + "method":"GET", + "requestUri":"/networks/{networkId}/proposals" + }, + "input":{"shape":"ListProposalsInput"}, + "output":{"shape":"ListProposalsOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Returns a listing of proposals for the network.

" + }, + "RejectInvitation":{ + "name":"RejectInvitation", + "http":{ + "method":"DELETE", + "requestUri":"/invitations/{invitationId}" + }, + "input":{"shape":"RejectInvitationInput"}, + "output":{"shape":"RejectInvitationOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"IllegalActionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Rejects an invitation to join a network. This action can be called by a principal in an AWS account that has received an invitation to create a member and join a network.

" + }, + "VoteOnProposal":{ + "name":"VoteOnProposal", + "http":{ + "method":"POST", + "requestUri":"/networks/{networkId}/proposals/{proposalId}/votes" + }, + "input":{"shape":"VoteOnProposalInput"}, + "output":{"shape":"VoteOnProposalOutput"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"IllegalActionException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

Casts a vote for a specified ProposalId on behalf of a member. The member to vote as, specified by VoterMemberId, must be in the same AWS account as the principal that calls the action.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "ApprovalThresholdPolicy":{ + "type":"structure", + "members":{ + "ThresholdPercentage":{ + "shape":"ThresholdPercentageInt", + "documentation":"

The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN, this indicates that 6 YES votes are required for the proposal to be approved.

" + }, + "ProposalDurationInHours":{ + "shape":"ProposalDurationInt", + "documentation":"

The duration from the time that a proposal is created until it expires. If members cast neither the required number of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions are not carried out.

" + }, + "ThresholdComparator":{ + "shape":"ThresholdComparator", + "documentation":"

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.

" + } + }, + "documentation":"

A policy type that defines the voting rules for the network. The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of YES votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

" + }, + "AvailabilityZoneString":{"type":"string"}, + "ClientRequestTokenString":{ + "type":"string", + "max":64, + "min":1 + }, + "CreateMemberInput":{ + "type":"structure", + "required":[ + "ClientRequestToken", + "InvitationId", + "NetworkId", + "MemberConfiguration" + ], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "idempotencyToken":true + }, + "InvitationId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the invitation that is sent to the member to join the network.

" + }, + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network in which the member is created.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberConfiguration":{ + "shape":"MemberConfiguration", + "documentation":"

Member configuration parameters.

" + } + } + }, + "CreateMemberOutput":{ + "type":"structure", + "members":{ + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member.

" + } + } + }, + "CreateNetworkInput":{ + "type":"structure", + "required":[ + "ClientRequestToken", + "Name", + "Framework", + "FrameworkVersion", + "VotingPolicy", + "MemberConfiguration" + ], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "idempotencyToken":true + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the network.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

An optional description for the network.

" + }, + "Framework":{ + "shape":"Framework", + "documentation":"

The blockchain framework that the network uses.

" + }, + "FrameworkVersion":{ + "shape":"FrameworkVersionString", + "documentation":"

The version of the blockchain framework that the network uses.

" + }, + "FrameworkConfiguration":{ + "shape":"NetworkFrameworkConfiguration", + "documentation":"

Configuration properties of the blockchain framework relevant to the network configuration.

" + }, + "VotingPolicy":{ + "shape":"VotingPolicy", + "documentation":"

The voting rules used by the network to determine if a proposal is approved.

" + }, + "MemberConfiguration":{ + "shape":"MemberConfiguration", + "documentation":"

Configuration properties for the first member within the network.

" + } + } + }, + "CreateNetworkOutput":{ + "type":"structure", + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier for the network.

" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier for the first member within the network.

" + } + } + }, + "CreateNodeInput":{ + "type":"structure", + "required":[ + "ClientRequestToken", + "NetworkId", + "MemberId", + "NodeConfiguration" + ], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "idempotencyToken":true + }, + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network in which this node runs.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that owns this node.

", + "location":"uri", + "locationName":"memberId" + }, + "NodeConfiguration":{ + "shape":"NodeConfiguration", + "documentation":"

The properties of a node configuration.

" + } + } + }, + "CreateNodeOutput":{ + "type":"structure", + "members":{ + "NodeId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the node.

" + } + } + }, + "CreateProposalInput":{ + "type":"structure", + "required":[ + "ClientRequestToken", + "NetworkId", + "MemberId", + "Actions" + ], + "members":{ + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an AWS SDK or the AWS CLI.

", + "idempotencyToken":true + }, + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network for which the proposal is made.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account.

" + }, + "Actions":{ + "shape":"ProposalActions", + "documentation":"

The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

A description for the proposal that is visible to voting members, for example, \"Proposal to add Example Corp. as member.\"

" + } + } + }, + "CreateProposalOutput":{ + "type":"structure", + "members":{ + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

" + } + } + }, + "DeleteMemberInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network from which the member is removed.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member to remove.

", + "location":"uri", + "locationName":"memberId" + } + } + }, + "DeleteMemberOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteNodeInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId", + "NodeId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network that the node belongs to.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that owns this node.

", + "location":"uri", + "locationName":"memberId" + }, + "NodeId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the node.

", + "location":"uri", + "locationName":"nodeId" + } + } + }, + "DeleteNodeOutput":{ + "type":"structure", + "members":{ + } + }, + "DescriptionString":{ + "type":"string", + "max":128 + }, + "Edition":{ + "type":"string", + "enum":[ + "STARTER", + "STANDARD" + ] + }, + "Framework":{ + "type":"string", + "enum":["HYPERLEDGER_FABRIC"] + }, + "FrameworkVersionString":{ + "type":"string", + "max":8, + "min":1 + }, + "GetMemberInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network to which the member belongs.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member.

", + "location":"uri", + "locationName":"memberId" + } + } + }, + "GetMemberOutput":{ + "type":"structure", + "members":{ + "Member":{ + "shape":"Member", + "documentation":"

The properties of a member.

" + } + } + }, + "GetNetworkInput":{ + "type":"structure", + "required":["NetworkId"], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network to get information about.

", + "location":"uri", + "locationName":"networkId" + } + } + }, + "GetNetworkOutput":{ + "type":"structure", + "members":{ + "Network":{ + "shape":"Network", + "documentation":"

An object containing network configuration parameters.

" + } + } + }, + "GetNodeInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId", + "NodeId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network to which the node belongs.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that owns the node.

", + "location":"uri", + "locationName":"memberId" + }, + "NodeId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the node.

", + "location":"uri", + "locationName":"nodeId" + } + } + }, + "GetNodeOutput":{ + "type":"structure", + "members":{ + "Node":{ + "shape":"Node", + "documentation":"

Properties of the node configuration.

" + } + } + }, + "GetProposalInput":{ + "type":"structure", + "required":[ + "NetworkId", + "ProposalId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network for which the proposal is made.

", + "location":"uri", + "locationName":"networkId" + }, + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

", + "location":"uri", + "locationName":"proposalId" + } + } + }, + "GetProposalOutput":{ + "type":"structure", + "members":{ + "Proposal":{ + "shape":"Proposal", + "documentation":"

Information about a proposal.

" + } + } + }, + "IllegalActionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InstanceTypeString":{"type":"string"}, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request processing has failed because of an unknown error, exception or failure.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The action or operation requested is invalid. Verify that the action is typed correctly.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invitation":{ + "type":"structure", + "members":{ + "InvitationId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier for the invitation.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the invitation was created.

" + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the invitation expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, the invitee can no longer create a member and join the network using this InvitationId.

" + }, + "Status":{ + "shape":"InvitationStatus", + "documentation":"

The status of the invitation:

  • PENDING - The invitee has not created a member to join the network, and the invitation has not yet expired.

  • ACCEPTING - The invitee has begun creating a member, and creation has not yet completed.

  • ACCEPTED - The invitee created a member and joined the network using the InvitationID.

  • REJECTED - The invitee rejected the invitation.

  • EXPIRED - The invitee neither created a member nor rejected the invitation before the ExpirationDate.

" + }, + "NetworkSummary":{"shape":"NetworkSummary"} + }, + "documentation":"

An invitation to an AWS account to create a member and join the network.

" + }, + "InvitationList":{ + "type":"list", + "member":{"shape":"Invitation"} + }, + "InvitationStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACCEPTED", + "ACCEPTING", + "REJECTED", + "EXPIRED" + ] + }, + "InviteAction":{ + "type":"structure", + "required":["Principal"], + "members":{ + "Principal":{ + "shape":"PrincipalString", + "documentation":"

The AWS account ID to invite.

" + } + }, + "documentation":"

An action to invite a specific AWS account to create a member and join the network. The InviteAction is carried out when a Proposal is APPROVED.

" + }, + "InviteActionList":{ + "type":"list", + "member":{"shape":"InviteAction"} + }, + "IsOwned":{ + "type":"boolean", + "box":true + }, + "ListInvitationsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ProposalListMaxResults", + "documentation":"

The maximum number of invitations to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListInvitationsOutput":{ + "type":"structure", + "members":{ + "Invitations":{ + "shape":"InvitationList", + "documentation":"

The invitations for the network.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListMembersInput":{ + "type":"structure", + "required":["NetworkId"], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network for which to list members.

", + "location":"uri", + "locationName":"networkId" + }, + "Name":{ + "shape":"String", + "documentation":"

The optional name of the member to list.

", + "location":"querystring", + "locationName":"name" + }, + "Status":{ + "shape":"MemberStatus", + "documentation":"

An optional status specifier. If provided, only members currently in this status are listed.

", + "location":"querystring", + "locationName":"status" + }, + "IsOwned":{ + "shape":"IsOwned", + "documentation":"

An optional Boolean value. If provided, the request is limited either to members that the current AWS account owns (true) or that other AWS accounts own (false). If omitted, all members are listed.

", + "location":"querystring", + "locationName":"isOwned" + }, + "MaxResults":{ + "shape":"MemberListMaxResults", + "documentation":"

The maximum number of members to return in the request.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListMembersOutput":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"MemberSummaryList", + "documentation":"

An array of MemberSummary objects. Each object contains details about a network member.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListNetworksInput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the network.

", + "location":"querystring", + "locationName":"name" + }, + "Framework":{ + "shape":"Framework", + "documentation":"

An optional framework specifier. If provided, only networks of this framework type are listed.

", + "location":"querystring", + "locationName":"framework" + }, + "Status":{ + "shape":"NetworkStatus", + "documentation":"

An optional status specifier. If provided, only networks currently in this status are listed.

", + "location":"querystring", + "locationName":"status" + }, + "MaxResults":{ + "shape":"NetworkListMaxResults", + "documentation":"

The maximum number of networks to list.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListNetworksOutput":{ + "type":"structure", + "members":{ + "Networks":{ + "shape":"NetworkSummaryList", + "documentation":"

An array of NetworkSummary objects that contain configuration properties for each network.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListNodesInput":{ + "type":"structure", + "required":[ + "NetworkId", + "MemberId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network for which to list nodes.

", + "location":"uri", + "locationName":"networkId" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member who owns the nodes to list.

", + "location":"uri", + "locationName":"memberId" + }, + "Status":{ + "shape":"NodeStatus", + "documentation":"

An optional status specifier. If provided, only nodes currently in this status are listed.

", + "location":"querystring", + "locationName":"status" + }, + "MaxResults":{ + "shape":"NodeListMaxResults", + "documentation":"

The maximum number of nodes to list.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListNodesOutput":{ + "type":"structure", + "members":{ + "Nodes":{ + "shape":"NodeSummaryList", + "documentation":"

An array of NodeSummary objects that contain configuration properties for each node.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListProposalVotesInput":{ + "type":"structure", + "required":[ + "NetworkId", + "ProposalId" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network.

", + "location":"uri", + "locationName":"networkId" + }, + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

", + "location":"uri", + "locationName":"proposalId" + }, + "MaxResults":{ + "shape":"ProposalListMaxResults", + "documentation":"

The maximum number of votes to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListProposalVotesOutput":{ + "type":"structure", + "members":{ + "ProposalVotes":{ + "shape":"ProposalVoteList", + "documentation":"

The listing of votes.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "ListProposalsInput":{ + "type":"structure", + "required":["NetworkId"], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network.

", + "location":"uri", + "locationName":"networkId" + }, + "MaxResults":{ + "shape":"ProposalListMaxResults", + "documentation":"

The maximum number of proposals to return.

", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListProposalsOutput":{ + "type":"structure", + "members":{ + "Proposals":{ + "shape":"ProposalSummaryList", + "documentation":"

The summary of each proposal made on the network.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The pagination token that indicates the next set of results to retrieve.

" + } + } + }, + "Member":{ + "type":"structure", + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network to which the member belongs.

" + }, + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member.

" + }, + "Name":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

An optional description for the member.

" + }, + "FrameworkAttributes":{ + "shape":"MemberFrameworkAttributes", + "documentation":"

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

" + }, + "Status":{ + "shape":"MemberStatus", + "documentation":"

The status of a member.

  • CREATING - The AWS account is in the process of creating a member.

  • AVAILABLE - The member has been created and can participate in the network.

  • CREATE_FAILED - The AWS account attempted to create a member and creation failed.

  • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

  • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the member was created.

" + } + }, + "documentation":"

Member configuration properties.

" + }, + "MemberConfiguration":{ + "type":"structure", + "required":[ + "Name", + "FrameworkConfiguration" + ], + "members":{ + "Name":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

An optional description of the member.

" + }, + "FrameworkConfiguration":{ + "shape":"MemberFrameworkConfiguration", + "documentation":"

Configuration properties of the blockchain framework relevant to the member.

" + } + }, + "documentation":"

Configuration properties of the member.

" + }, + "MemberFabricAttributes":{ + "type":"structure", + "members":{ + "AdminUsername":{ + "shape":"UsernameString", + "documentation":"

The user name for the initial administrator user for the member.

" + }, + "CaEndpoint":{ + "shape":"String", + "documentation":"

The endpoint used to access the member's certificate authority.

" + } + }, + "documentation":"

Attributes of Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

" + }, + "MemberFabricConfiguration":{ + "type":"structure", + "required":[ + "AdminUsername", + "AdminPassword" + ], + "members":{ + "AdminUsername":{ + "shape":"UsernameString", + "documentation":"

The user name for the member's initial administrative user.

" + }, + "AdminPassword":{ + "shape":"PasswordString", + "documentation":"

The password for the member's initial administrative user. The AdminPassword must be at least eight characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quote(‘), double quote(“), forward slash(/), backward slash(\\), @, or a space.

" + } + }, + "documentation":"

Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

" + }, + "MemberFrameworkAttributes":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"MemberFabricAttributes", + "documentation":"

Attributes of Hyperledger Fabric relevant to a member on a Managed Blockchain network that uses Hyperledger Fabric.

" + } + }, + "documentation":"

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

" + }, + "MemberFrameworkConfiguration":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"MemberFabricConfiguration", + "documentation":"

Attributes of Hyperledger Fabric for a member on a Managed Blockchain network that uses Hyperledger Fabric.

" + } + }, + "documentation":"

Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.

" + }, + "MemberListMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "MemberStatus":{ + "type":"string", + "enum":[ + "CREATING", + "AVAILABLE", + "CREATE_FAILED", + "DELETING", + "DELETED" + ] + }, + "MemberSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member.

" + }, + "Name":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

An optional description of the member.

" + }, + "Status":{ + "shape":"MemberStatus", + "documentation":"

The status of the member.

  • CREATING - The AWS account is in the process of creating a member.

  • AVAILABLE - The member has been created and can participate in the network.

  • CREATE_FAILED - The AWS account attempted to create a member and creation failed.

  • DELETING - The member and all associated resources are in the process of being deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

  • DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the AWS account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the member was created.

" + }, + "IsOwned":{ + "shape":"IsOwned", + "documentation":"

An indicator of whether the member is owned by your AWS account or a different AWS account.

" + } + }, + "documentation":"

A summary of configuration properties for a member.

" + }, + "MemberSummaryList":{ + "type":"list", + "member":{"shape":"MemberSummary"} + }, + "NameString":{ + "type":"string", + "max":64, + "min":1, + "pattern":".*\\S.*" + }, + "Network":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the network.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

Attributes of the blockchain framework for the network.

" + }, + "Framework":{ + "shape":"Framework", + "documentation":"

The blockchain framework that the network uses.

" + }, + "FrameworkVersion":{ + "shape":"FrameworkVersionString", + "documentation":"

The version of the blockchain framework that the network uses.

" + }, + "FrameworkAttributes":{ + "shape":"NetworkFrameworkAttributes", + "documentation":"

Attributes of the blockchain framework that the network uses.

" + }, + "VpcEndpointServiceName":{ + "shape":"String", + "documentation":"

The VPC endpoint service name of the VPC endpoint service of the network. Members use the VPC endpoint service name to create a VPC endpoint to access network resources.

" + }, + "VotingPolicy":{ + "shape":"VotingPolicy", + "documentation":"

The voting rules for the network to decide if a proposal is accepted.

" + }, + "Status":{ + "shape":"NetworkStatus", + "documentation":"

The current status of the network.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the network was created.

" + } + }, + "documentation":"

Network configuration properties.

" + }, + "NetworkFabricAttributes":{ + "type":"structure", + "members":{ + "OrderingServiceEndpoint":{ + "shape":"String", + "documentation":"

The endpoint of the ordering service for the network.

" + }, + "Edition":{ + "shape":"Edition", + "documentation":"

The edition of Amazon Managed Blockchain that Hyperledger Fabric uses. For more information, see Amazon Managed Blockchain Pricing.

" + } + }, + "documentation":"

Attributes of Hyperledger Fabric for a network.

" + }, + "NetworkFabricConfiguration":{ + "type":"structure", + "required":["Edition"], + "members":{ + "Edition":{ + "shape":"Edition", + "documentation":"

The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.

" + } + }, + "documentation":"

Hyperledger Fabric configuration properties for the network.

" + }, + "NetworkFrameworkAttributes":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"NetworkFabricAttributes", + "documentation":"

Attributes of Hyperledger Fabric for a Managed Blockchain network that uses Hyperledger Fabric.

" + } + }, + "documentation":"

Attributes relevant to the network for the blockchain framework that the network uses.

" + }, + "NetworkFrameworkConfiguration":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"NetworkFabricConfiguration", + "documentation":"

Hyperledger Fabric configuration properties for a Managed Blockchain network that uses Hyperledger Fabric.

" + } + }, + "documentation":"

Configuration properties relevant to the network for the blockchain framework that the network uses.

" + }, + "NetworkListMaxResults":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "NetworkMemberNameString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^(?!-)^[^0-9](?!.*--)[A-Za-z0-9-]+[^- ]$" + }, + "NetworkStatus":{ + "type":"string", + "enum":[ + "CREATING", + "AVAILABLE", + "CREATE_FAILED", + "DELETING", + "DELETED" + ] + }, + "NetworkSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the network.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

An optional description of the network.

" + }, + "Framework":{ + "shape":"Framework", + "documentation":"

The blockchain framework that the network uses.

" + }, + "FrameworkVersion":{ + "shape":"FrameworkVersionString", + "documentation":"

The version of the blockchain framework that the network uses.

" + }, + "Status":{ + "shape":"NetworkStatus", + "documentation":"

The current status of the network.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the network was created.

" + } + }, + "documentation":"

A summary of network configuration properties.

" + }, + "NetworkSummaryList":{ + "type":"list", + "member":{"shape":"NetworkSummary"} + }, + "Node":{ + "type":"structure", + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network that the node is in.

" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member to which the node belongs.

" + }, + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the node.

" + }, + "InstanceType":{ + "shape":"InstanceTypeString", + "documentation":"

The instance type of the node.

" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZoneString", + "documentation":"

The Availability Zone in which the node exists.

" + }, + "FrameworkAttributes":{ + "shape":"NodeFrameworkAttributes", + "documentation":"

Attributes of the blockchain framework being used.

" + }, + "Status":{ + "shape":"NodeStatus", + "documentation":"

The status of the node.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the node was created.

" + } + }, + "documentation":"

Configuration properties of a peer node.

" + }, + "NodeConfiguration":{ + "type":"structure", + "required":[ + "InstanceType", + "AvailabilityZone" + ], + "members":{ + "InstanceType":{ + "shape":"InstanceTypeString", + "documentation":"

The Amazon Managed Blockchain instance type for the node.

" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZoneString", + "documentation":"

The Availability Zone in which the node exists.

" + } + }, + "documentation":"

Configuration properties of a peer node.

" + }, + "NodeFabricAttributes":{ + "type":"structure", + "members":{ + "PeerEndpoint":{ + "shape":"String", + "documentation":"

The endpoint that identifies the peer node for all services except peer channel-based event services.

" + }, + "PeerEventEndpoint":{ + "shape":"String", + "documentation":"

The endpoint that identifies the peer node for peer channel-based event services.

" + } + }, + "documentation":"

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

" + }, + "NodeFrameworkAttributes":{ + "type":"structure", + "members":{ + "Fabric":{ + "shape":"NodeFabricAttributes", + "documentation":"

Attributes of Hyperledger Fabric for a peer node on a Managed Blockchain network that uses Hyperledger Fabric.

" + } + }, + "documentation":"

Attributes relevant to a peer node on a Managed Blockchain network for the blockchain framework that the network uses.

" + }, + "NodeListMaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "NodeStatus":{ + "type":"string", + "enum":[ + "CREATING", + "AVAILABLE", + "CREATE_FAILED", + "DELETING", + "DELETED", + "FAILED" + ] + }, + "NodeSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the node.

" + }, + "Status":{ + "shape":"NodeStatus", + "documentation":"

The status of the node.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the node was created.

" + }, + "AvailabilityZone":{ + "shape":"AvailabilityZoneString", + "documentation":"

The Availability Zone in which the node exists.

" + }, + "InstanceType":{ + "shape":"InstanceTypeString", + "documentation":"

The EC2 instance type for the node.

" + } + }, + "documentation":"

A summary of configuration properties for a peer node.

" + }, + "NodeSummaryList":{ + "type":"list", + "member":{"shape":"NodeSummary"} + }, + "PaginationToken":{ + "type":"string", + "max":128 + }, + "PasswordString":{ + "type":"string", + "max":32, + "min":8, + "pattern":"^(?=.*[a-z])(?=.*[A-Z])(?=.*\\d)(?!.*[@'\\\\\"/])[a-zA-Z0-9\\S]*$", + "sensitive":true + }, + "PrincipalString":{"type":"string"}, + "Proposal":{ + "type":"structure", + "members":{ + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

" + }, + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network for which the proposal is made.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The description of the proposal.

" + }, + "Actions":{ + "shape":"ProposalActions", + "documentation":"

The actions to perform on the network if the proposal is APPROVED.

" + }, + "ProposedByMemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that created the proposal.

" + }, + "ProposedByMemberName":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member that created the proposal.

" + }, + "Status":{ + "shape":"ProposalStatus", + "documentation":"

The status of the proposal. Values are as follows:

  • IN_PROGRESS - The proposal is active and open for member voting.

  • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

  • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out.

  • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.

  • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the proposal was created.

" + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

" + }, + "YesVoteCount":{ + "shape":"VoteCount", + "documentation":"

The current total of YES votes cast on the proposal by members.

" + }, + "NoVoteCount":{ + "shape":"VoteCount", + "documentation":"

The current total of NO votes cast on the proposal by members.

" + }, + "OutstandingVoteCount":{ + "shape":"VoteCount", + "documentation":"

The number of votes remaining to be cast on the proposal by members. In other words, the number of members minus the sum of YES votes and NO votes.

" + } + }, + "documentation":"

Properties of a proposal on a Managed Blockchain network.

" + }, + "ProposalActions":{ + "type":"structure", + "members":{ + "Invitations":{ + "shape":"InviteActionList", + "documentation":"

The actions to perform for an APPROVED proposal to invite an AWS account to create a member and join the network.

" + }, + "Removals":{ + "shape":"RemoveActionList", + "documentation":"

The actions to perform for an APPROVED proposal to remove a member from the network, which deletes the member and all associated member resources from the network.

" + } + }, + "documentation":"

The actions to carry out if a proposal is APPROVED.

" + }, + "ProposalDurationInt":{ + "type":"integer", + "box":true, + "max":168, + "min":1 + }, + "ProposalListMaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "ProposalStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "APPROVED", + "REJECTED", + "EXPIRED", + "ACTION_FAILED" + ] + }, + "ProposalSummary":{ + "type":"structure", + "members":{ + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

" + }, + "Description":{ + "shape":"DescriptionString", + "documentation":"

The description of the proposal.

" + }, + "ProposedByMemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that created the proposal.

" + }, + "ProposedByMemberName":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member that created the proposal.

" + }, + "Status":{ + "shape":"ProposalStatus", + "documentation":"

The status of the proposal. Values are as follows:

  • IN_PROGRESS - The proposal is active and open for member voting.

  • APPROVED - The proposal was approved with sufficient YES votes among members according to the VotingPolicy specified for the Network. The specified proposal actions are carried out.

  • REJECTED - The proposal was rejected with insufficient YES votes among members according to the VotingPolicy specified for the Network. The specified ProposalActions are not carried out.

  • EXPIRED - Members did not cast the number of votes required to determine the proposal outcome before the proposal expired. The specified ProposalActions are not carried out.

  • ACTION_FAILED - One or more of the specified ProposalActions in a proposal that was approved could not be completed because of an error.

" + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the proposal was created.

" + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

The date and time that the proposal expires. This is the CreationDate plus the ProposalDurationInHours that is specified in the ProposalThresholdPolicy. After this date and time, if members have not cast enough votes to determine the outcome according to the voting policy, the proposal is EXPIRED and Actions are not carried out.

" + } + }, + "documentation":"

Properties of a proposal.

" + }, + "ProposalSummaryList":{ + "type":"list", + "member":{"shape":"ProposalSummary"} + }, + "ProposalVoteList":{ + "type":"list", + "member":{"shape":"VoteSummary"} + }, + "RejectInvitationInput":{ + "type":"structure", + "required":["InvitationId"], + "members":{ + "InvitationId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the invitation to reject.

", + "location":"uri", + "locationName":"invitationId" + } + } + }, + "RejectInvitationOutput":{ + "type":"structure", + "members":{ + } + }, + "RemoveAction":{ + "type":"structure", + "required":["MemberId"], + "members":{ + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member to remove.

" + } + }, + "documentation":"

An action to remove a member from a Managed Blockchain network as the result of a removal proposal that is APPROVED. The member and all associated resources are deleted from the network.

" + }, + "RemoveActionList":{ + "type":"list", + "member":{"shape":"RemoveAction"} + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

A resource request is issued for a resource that already exists.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceIdString":{ + "type":"string", + "max":32, + "min":1 + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The maximum number of resources of that type already exist. Ensure the resources requested are within the boundaries of the service edition and your account limits.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

A requested resource does not exist on the network. It may have been deleted or referenced inaccurately.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceNotReadyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The requested resource exists but is not in a status that can complete the operation.

", + "error":{"httpStatusCode":409}, + "exception":true + }, + "String":{"type":"string"}, + "ThresholdComparator":{ + "type":"string", + "enum":[ + "GREATER_THAN", + "GREATER_THAN_OR_EQUAL_TO" + ] + }, + "ThresholdPercentageInt":{ + "type":"integer", + "box":true, + "max":100, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The request or operation could not be performed because a service is throttling requests. The most common source of throttling errors is launching EC2 instances such that your service limit for EC2 instances is exceeded. Request a limit increase or delete unused resources if possible.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "UsernameString":{ + "type":"string", + "max":16, + "min":1, + "pattern":"^[a-zA-Z][a-zA-Z0-9]*$" + }, + "VoteCount":{ + "type":"integer", + "box":true + }, + "VoteOnProposalInput":{ + "type":"structure", + "required":[ + "NetworkId", + "ProposalId", + "VoterMemberId", + "Vote" + ], + "members":{ + "NetworkId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the network.

", + "location":"uri", + "locationName":"networkId" + }, + "ProposalId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the proposal.

", + "location":"uri", + "locationName":"proposalId" + }, + "VoterMemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member casting the vote.

" + }, + "Vote":{ + "shape":"VoteValue", + "documentation":"

The value of the vote.

" + } + } + }, + "VoteOnProposalOutput":{ + "type":"structure", + "members":{ + } + }, + "VoteSummary":{ + "type":"structure", + "members":{ + "Vote":{ + "shape":"VoteValue", + "documentation":"

The vote value, either YES or NO.

" + }, + "MemberName":{ + "shape":"NetworkMemberNameString", + "documentation":"

The name of the member that cast the vote.

" + }, + "MemberId":{ + "shape":"ResourceIdString", + "documentation":"

The unique identifier of the member that cast the vote.

" + } + }, + "documentation":"

Properties of an individual vote that a member cast for a proposal.

" + }, + "VoteValue":{ + "type":"string", + "enum":[ + "YES", + "NO" + ] + }, + "VotingPolicy":{ + "type":"structure", + "members":{ + "ApprovalThresholdPolicy":{ + "shape":"ApprovalThresholdPolicy", + "documentation":"

Defines the rules for the network for voting on proposals, such as the percentage of YES votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.

" + } + }, + "documentation":"

The voting rules for the network to decide if a proposal is accepted

" + } + }, + "documentation":"

Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority. Currently, Managed Blockchain supports the Hyperledger Fabric open source framework.

" +} diff --git a/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json b/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json new file mode 100644 index 00000000..8dbf525e --- /dev/null +++ b/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "GetEntitlements": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Entitlements" + } + } +} diff --git a/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/service-2.json b/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/service-2.json new file mode 100644 index 00000000..acdee343 --- /dev/null +++ b/aws/dist/botocore/data/marketplace-entitlement/2017-01-11/service-2.json @@ -0,0 +1,183 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-01-11", + "endpointPrefix":"entitlement.marketplace", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Marketplace Entitlement Service", + "serviceId":"Marketplace Entitlement Service", + "signatureVersion":"v4", + "signingName":"aws-marketplace", + "targetPrefix":"AWSMPEntitlementService", + "uid":"entitlement.marketplace-2017-01-11" + }, + "operations":{ + "GetEntitlements":{ + "name":"GetEntitlements", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEntitlementsRequest"}, + "output":{"shape":"GetEntitlementsResult"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

GetEntitlements retrieves entitlement values for a given product. The results can be filtered based on customer identifier or product dimensions.

" + } + }, + "shapes":{ + "Boolean":{"type":"boolean"}, + "Double":{"type":"double"}, + "Entitlement":{ + "type":"structure", + "members":{ + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

The product code for which the given entitlement applies. Product codes are provided by AWS Marketplace when the product listing is created.

" + }, + "Dimension":{ + "shape":"NonEmptyString", + "documentation":"

The dimension for which the given entitlement applies. Dimensions represent categories of capacity in a product and are specified when the product is listed in AWS Marketplace.

" + }, + "CustomerIdentifier":{ + "shape":"NonEmptyString", + "documentation":"

The customer identifier is a handle to each unique customer in an application. Customer identifiers are obtained through the ResolveCustomer operation in AWS Marketplace Metering Service.

" + }, + "Value":{ + "shape":"EntitlementValue", + "documentation":"

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

" + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

The expiration date represents the minimum date through which this entitlement is expected to remain valid. For contractual products listed on AWS Marketplace, the expiration date is the date at which the customer will renew or cancel their contract. Customers who are opting to renew their contract will still have entitlements with an expiration date.

" + } + }, + "documentation":"

An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

" + }, + "EntitlementList":{ + "type":"list", + "member":{"shape":"Entitlement"}, + "min":0 + }, + "EntitlementValue":{ + "type":"structure", + "members":{ + "IntegerValue":{ + "shape":"Integer", + "documentation":"

The IntegerValue field will be populated with an integer value when the entitlement is an integer type. Otherwise, the field will not be set.

" + }, + "DoubleValue":{ + "shape":"Double", + "documentation":"

The DoubleValue field will be populated with a double value when the entitlement is a double type. Otherwise, the field will not be set.

" + }, + "BooleanValue":{ + "shape":"Boolean", + "documentation":"

The BooleanValue field will be populated with a boolean value when the entitlement is a boolean type. Otherwise, the field will not be set.

" + }, + "StringValue":{ + "shape":"String", + "documentation":"

The StringValue field will be populated with a string value when the entitlement is a string type. Otherwise, the field will not be set.

" + } + }, + "documentation":"

The EntitlementValue represents the amount of capacity that the customer is entitled to for the product.

" + }, + "ErrorMessage":{"type":"string"}, + "FilterValue":{"type":"string"}, + "FilterValueList":{ + "type":"list", + "member":{"shape":"FilterValue"}, + "min":1 + }, + "GetEntitlementFilterName":{ + "type":"string", + "enum":[ + "CUSTOMER_IDENTIFIER", + "DIMENSION" + ] + }, + "GetEntitlementFilters":{ + "type":"map", + "key":{"shape":"GetEntitlementFilterName"}, + "value":{"shape":"FilterValueList"} + }, + "GetEntitlementsRequest":{ + "type":"structure", + "required":["ProductCode"], + "members":{ + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code will be provided by AWS Marketplace when the product listing is created.

" + }, + "Filter":{ + "shape":"GetEntitlementFilters", + "documentation":"

Filter is used to return entitlements for a specific customer or for a specific dimension. Filters are described as keys mapped to a lists of values. Filtered requests are unioned for each value in the value list, and then intersected for each filter key.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

For paginated calls to GetEntitlements, pass the NextToken from the previous GetEntitlementsResult.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

The maximum number of items to retrieve from the GetEntitlements operation. For pagination, use the NextToken field in subsequent calls to GetEntitlements.

" + } + }, + "documentation":"

The GetEntitlementsRequest contains parameters for the GetEntitlements operation.

" + }, + "GetEntitlementsResult":{ + "type":"structure", + "members":{ + "Entitlements":{ + "shape":"EntitlementList", + "documentation":"

The set of entitlements found through the GetEntitlements operation. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

" + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

For paginated results, use NextToken in subsequent calls to GetEntitlements. If the result contains an empty set of entitlements, NextToken might still be present and should be used.

" + } + }, + "documentation":"

The GetEntitlementsRequest contains results from the GetEntitlements operation.

" + }, + "Integer":{"type":"integer"}, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

", + "exception":true, + "fault":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

One or more parameters in your request was invalid.

", + "exception":true + }, + "NonEmptyString":{ + "type":"string", + "pattern":"\\S+" + }, + "ProductCode":{ + "type":"string", + "max":255, + "min":1 + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The calls to the GetEntitlements API are throttled.

", + "exception":true + }, + "Timestamp":{"type":"timestamp"} + }, + "documentation":"AWS Marketplace Entitlement Service

This reference provides descriptions of the AWS Marketplace Entitlement Service API.

AWS Marketplace Entitlement Service is used to determine the entitlement of a customer to a given product. An entitlement represents capacity in a product owned by the customer. For example, a customer might own some number of users or seats in an SaaS application or some amount of data capacity in a multi-tenant database.

Getting Entitlement Records

  • GetEntitlements- Gets the entitlements for a Marketplace product.

" +} diff --git a/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/paginators-1.json b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json new file mode 100644 index 00000000..17f866f0 --- /dev/null +++ b/aws/dist/botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json @@ -0,0 +1,235 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-07-01", + "endpointPrefix":"marketplacecommerceanalytics", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Marketplace Commerce Analytics", + "serviceId":"Marketplace Commerce Analytics", + "signatureVersion":"v4", + "signingName":"marketplacecommerceanalytics", + "targetPrefix":"MarketplaceCommerceAnalytics20150701", + "uid":"marketplacecommerceanalytics-2015-07-01" + }, + "operations":{ + "GenerateDataSet":{ + "name":"GenerateDataSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateDataSetRequest"}, + "output":{"shape":"GenerateDataSetResult"}, + "errors":[ + {"shape":"MarketplaceCommerceAnalyticsException"} + ], + "documentation":"Given a data set type and data set publication date, asynchronously publishes the requested data set to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." + }, + "StartSupportDataExport":{ + "name":"StartSupportDataExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSupportDataExportRequest"}, + "output":{"shape":"StartSupportDataExportResult"}, + "errors":[ + {"shape":"MarketplaceCommerceAnalyticsException"} + ], + "documentation":"Given a data set type and a from date, asynchronously publishes the requested customer support data to the specified S3 bucket and notifies the specified SNS topic once the data is available. Returns a unique request identifier that can be used to correlate requests with notifications from the SNS topic. Data sets will be published in comma-separated values (CSV) format with the file name {data_set_type}_YYYY-MM-DD'T'HH-mm-ss'Z'.csv. If a file with the same name already exists (e.g. if the same data set is requested twice), the original file will be overwritten by the new file. Requires a Role with an attached permissions policy providing Allow permissions for the following actions: s3:PutObject, s3:GetBucketLocation, sns:GetTopicAttributes, sns:Publish, iam:GetRolePolicy." + } + }, + "shapes":{ + "CustomerDefinedValues":{ + "type":"map", + "key":{"shape":"OptionalKey"}, + "value":{"shape":"OptionalValue"}, + "max":5, + "min":1 + }, + "DataSetPublicationDate":{"type":"timestamp"}, + "DataSetRequestId":{"type":"string"}, + "DataSetType":{ + "type":"string", + "enum":[ + "customer_subscriber_hourly_monthly_subscriptions", + "customer_subscriber_annual_subscriptions", + "daily_business_usage_by_instance_type", + "daily_business_fees", + "daily_business_free_trial_conversions", + "daily_business_new_instances", + "daily_business_new_product_subscribers", + "daily_business_canceled_product_subscribers", + "monthly_revenue_billing_and_revenue_data", + "monthly_revenue_annual_subscriptions", + "monthly_revenue_field_demonstration_usage", + "monthly_revenue_flexible_payment_schedule", + "disbursed_amount_by_product", + "disbursed_amount_by_product_with_uncollected_funds", + "disbursed_amount_by_instance_hours", + "disbursed_amount_by_customer_geo", + "disbursed_amount_by_age_of_uncollected_funds", + "disbursed_amount_by_age_of_disbursed_funds", + "disbursed_amount_by_age_of_past_due_funds", + "disbursed_amount_by_uncollected_funds_breakdown", + "customer_profile_by_industry", + "customer_profile_by_revenue", + "customer_profile_by_geography", + "sales_compensation_billed_revenue", + "us_sales_and_use_tax_records" + ], + "max":255, + "min":1 + }, + "DestinationS3BucketName":{ + "type":"string", + "min":1 + }, + "DestinationS3Prefix":{"type":"string"}, + "ExceptionMessage":{"type":"string"}, + "FromDate":{"type":"timestamp"}, + "GenerateDataSetRequest":{ + "type":"structure", + "required":[ + "dataSetType", + "dataSetPublicationDate", + "roleNameArn", + "destinationS3BucketName", + "snsTopicArn" + ], + "members":{ + "dataSetType":{ + "shape":"DataSetType", + "documentation":"

The desired data set type.

  • customer_subscriber_hourly_monthly_subscriptions

    From 2014-07-21 to present: Available daily by 24:00 UTC.

  • customer_subscriber_annual_subscriptions

    From 2014-07-21 to present: Available daily by 24:00 UTC.

  • daily_business_usage_by_instance_type

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • daily_business_fees

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • daily_business_free_trial_conversions

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • daily_business_new_instances

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • daily_business_new_product_subscribers

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • daily_business_canceled_product_subscribers

    From 2015-01-26 to present: Available daily by 24:00 UTC.

  • monthly_revenue_billing_and_revenue_data

    From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior.

    From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior.

  • monthly_revenue_annual_subscriptions

    From 2015-02 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.

    From 2017-07 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes up-front software charges (e.g. annual) from one month prior.

  • monthly_revenue_field_demonstration_usage

    From 2018-03-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

  • monthly_revenue_flexible_payment_schedule

    From 2018-11-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

  • disbursed_amount_by_product

    From 2015-01-26 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_product_with_uncollected_funds

    From 2012-04-19 to 2015-01-25: Available every 30 days by 24:00 UTC.

    From 2015-01-26 to present: This data set was split into three data sets: disbursed_amount_by_product, disbursed_amount_by_age_of_uncollected_funds, and disbursed_amount_by_age_of_disbursed_funds.

  • disbursed_amount_by_instance_hours

    From 2012-09-04 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_customer_geo

    From 2012-04-19 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_uncollected_funds

    From 2015-01-26 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_disbursed_funds

    From 2015-01-26 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_age_of_past_due_funds

    From 2018-04-07 to present: Available every 30 days by 24:00 UTC.

  • disbursed_amount_by_uncollected_funds_breakdown

    From 2019-10-04 to present: Available every 30 days by 24:00 UTC.

  • customer_profile_by_industry

    From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.

    From 2017-06-30 to present: This data set is no longer available.

  • customer_profile_by_revenue

    From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.

    From 2017-06-30 to present: This data set is no longer available.

  • customer_profile_by_geography

    From 2015-10-01 to 2017-06-29: Available daily by 24:00 UTC.

    From 2017-06-30 to present: This data set is no longer available.

  • sales_compensation_billed_revenue

    From 2016-12 to 2017-06: Available monthly on the 4th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from two months prior, and up-front software charges (e.g. annual) from one month prior.

    From 2017-06 to present: Available monthly on the 15th day of the month by 24:00 UTC. Data includes metered transactions (e.g. hourly) from one month prior, and up-front software charges (e.g. annual) from one month prior.

  • us_sales_and_use_tax_records

    From 2017-02-15 to present: Available monthly on the 15th day of the month by 24:00 UTC.

" + }, + "dataSetPublicationDate":{ + "shape":"DataSetPublicationDate", + "documentation":"The date a data set was published. For daily data sets, provide a date with day-level granularity for the desired day. For weekly data sets, provide a date with day-level granularity within the desired week (the day value will be ignored). For monthly data sets, provide a date with month-level granularity for the desired month (the day value will be ignored)." + }, + "roleNameArn":{ + "shape":"RoleNameArn", + "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services." + }, + "destinationS3BucketName":{ + "shape":"DestinationS3BucketName", + "documentation":"The name (friendly name, not ARN) of the destination S3 bucket." + }, + "destinationS3Prefix":{ + "shape":"DestinationS3Prefix", + "documentation":"(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root." + }, + "snsTopicArn":{ + "shape":"SnsTopicArn", + "documentation":"Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred." + }, + "customerDefinedValues":{ + "shape":"CustomerDefinedValues", + "documentation":"(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file. These key-value pairs can be used to correlated responses with tracking information from other systems." + } + }, + "documentation":"Container for the parameters to the GenerateDataSet operation." + }, + "GenerateDataSetResult":{ + "type":"structure", + "members":{ + "dataSetRequestId":{ + "shape":"DataSetRequestId", + "documentation":"A unique identifier representing a specific request to the GenerateDataSet operation. This identifier can be used to correlate a request with notifications from the SNS topic." + } + }, + "documentation":"Container for the result of the GenerateDataSet operation." + }, + "MarketplaceCommerceAnalyticsException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"This message describes details of the error." + } + }, + "documentation":"This exception is thrown when an internal service error occurs.", + "exception":true, + "fault":true + }, + "OptionalKey":{ + "type":"string", + "max":255, + "min":1 + }, + "OptionalValue":{ + "type":"string", + "max":255, + "min":1 + }, + "RoleNameArn":{ + "type":"string", + "min":1 + }, + "SnsTopicArn":{ + "type":"string", + "min":1 + }, + "StartSupportDataExportRequest":{ + "type":"structure", + "required":[ + "dataSetType", + "fromDate", + "roleNameArn", + "destinationS3BucketName", + "snsTopicArn" + ], + "members":{ + "dataSetType":{ + "shape":"SupportDataSetType", + "documentation":"

Specifies the data set type to be written to the output csv file. The data set types customer_support_contacts_data and test_customer_support_contacts_data both result in a csv file containing the following fields: Product Id, Product Code, Customer Guid, Subscription Guid, Subscription Start Date, Organization, AWS Account Id, Given Name, Surname, Telephone Number, Email, Title, Country Code, ZIP Code, Operation Type, and Operation Time.

  • customer_support_contacts_data Customer support contact data. The data set will contain all changes (Creates, Updates, and Deletes) to customer support contact data from the date specified in the from_date parameter.
  • test_customer_support_contacts_data An example data set containing static test data in the same format as customer_support_contacts_data

" + }, + "fromDate":{ + "shape":"FromDate", + "documentation":"The start date from which to retrieve the data set in UTC. This parameter only affects the customer_support_contacts_data data set type." + }, + "roleNameArn":{ + "shape":"RoleNameArn", + "documentation":"The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services." + }, + "destinationS3BucketName":{ + "shape":"DestinationS3BucketName", + "documentation":"The name (friendly name, not ARN) of the destination S3 bucket." + }, + "destinationS3Prefix":{ + "shape":"DestinationS3Prefix", + "documentation":"(Optional) The desired S3 prefix for the published data set, similar to a directory path in standard file systems. For example, if given the bucket name \"mybucket\" and the prefix \"myprefix/mydatasets\", the output file \"outputfile\" would be published to \"s3://mybucket/myprefix/mydatasets/outputfile\". If the prefix directory structure does not exist, it will be created. If no prefix is provided, the data set will be published to the S3 bucket root." + }, + "snsTopicArn":{ + "shape":"SnsTopicArn", + "documentation":"Amazon Resource Name (ARN) for the SNS Topic that will be notified when the data set has been published or if an error has occurred." + }, + "customerDefinedValues":{ + "shape":"CustomerDefinedValues", + "documentation":"(Optional) Key-value pairs which will be returned, unmodified, in the Amazon SNS notification message and the data set metadata file." + } + }, + "documentation":"Container for the parameters to the StartSupportDataExport operation." + }, + "StartSupportDataExportResult":{ + "type":"structure", + "members":{ + "dataSetRequestId":{ + "shape":"DataSetRequestId", + "documentation":"A unique identifier representing a specific request to the StartSupportDataExport operation. This identifier can be used to correlate a request with notifications from the SNS topic." + } + }, + "documentation":"Container for the result of the StartSupportDataExport operation." + }, + "SupportDataSetType":{ + "type":"string", + "enum":[ + "customer_support_contacts_data", + "test_customer_support_contacts_data" + ], + "max":255, + "min":1 + } + }, + "documentation":"Provides AWS Marketplace business intelligence data on-demand." +} diff --git a/aws/dist/botocore/data/mediaconnect/2018-11-14/paginators-1.json b/aws/dist/botocore/data/mediaconnect/2018-11-14/paginators-1.json new file mode 100644 index 00000000..bfc962af --- /dev/null +++ b/aws/dist/botocore/data/mediaconnect/2018-11-14/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListFlows": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Flows" + }, + "ListEntitlements": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Entitlements" + } + } +} diff --git a/aws/dist/botocore/data/mediaconnect/2018-11-14/service-2.json b/aws/dist/botocore/data/mediaconnect/2018-11-14/service-2.json new file mode 100644 index 00000000..63c04400 --- /dev/null +++ b/aws/dist/botocore/data/mediaconnect/2018-11-14/service-2.json @@ -0,0 +1,2236 @@ +{ + "metadata": { + "apiVersion": "2018-11-14", + "endpointPrefix": "mediaconnect", + "signingName": "mediaconnect", + "serviceFullName": "AWS MediaConnect", + "serviceId": "MediaConnect", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "mediaconnect-2018-11-14", + "signatureVersion": "v4" + }, + "operations": { + "AddFlowOutputs": { + "name": "AddFlowOutputs", + "http": { + "method": "POST", + "requestUri": "/v1/flows/{flowArn}/outputs", + "responseCode": 201 + }, + "input": { + "shape": "AddFlowOutputsRequest" + }, + "output": { + "shape": "AddFlowOutputsResponse", + "documentation": "AWS Elemental MediaConnect added the outputs successfully." + }, + "errors": [ + { + "shape": "AddFlowOutputs420Exception", + "documentation": "AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed outputs (20). For more information, contact AWS Customer Support." + }, + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Adds outputs to an existing flow. You can create up to 20 outputs per flow." + }, + "CreateFlow": { + "name": "CreateFlow", + "http": { + "method": "POST", + "requestUri": "/v1/flows", + "responseCode": 201 + }, + "input": { + "shape": "CreateFlowRequest" + }, + "output": { + "shape": "CreateFlowResponse", + "documentation": "AWS Elemental MediaConnect created the new flow successfully." + }, + "errors": [ + { + "shape": "CreateFlow420Exception", + "documentation": "Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Customer Support." + }, + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50)." + }, + "DeleteFlow": { + "name": "DeleteFlow", + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteFlowRequest" + }, + "output": { + "shape": "DeleteFlowResponse", + "documentation": "AWS Elemental MediaConnect is deleting the flow." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Deletes a flow. Before you can delete a flow, you must stop the flow." + }, + "DescribeFlow": { + "name": "DescribeFlow", + "http": { + "method": "GET", + "requestUri": "/v1/flows/{flowArn}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeFlowRequest" + }, + "output": { + "shape": "DescribeFlowResponse", + "documentation": "AWS Elemental MediaConnect returned the flow details successfully." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements." + }, + "GrantFlowEntitlements": { + "name": "GrantFlowEntitlements", + "http": { + "method": "POST", + "requestUri": "/v1/flows/{flowArn}/entitlements", + "responseCode": 200 + }, + "input": { + "shape": "GrantFlowEntitlementsRequest" + }, + "output": { + "shape": "GrantFlowEntitlementsResponse", + "documentation": "AWS Elemental MediaConnect granted the entitlements successfully." + }, + "errors": [ + { + "shape": "GrantFlowEntitlements420Exception", + "documentation": "AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed entitlements (50). For more information, contact AWS Customer Support." + }, + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Grants entitlements to an existing flow." + }, + "ListEntitlements": { + "name": "ListEntitlements", + "http": { + "method": "GET", + "requestUri": "/v1/entitlements", + "responseCode": 200 + }, + "input": { + "shape": "ListEntitlementsRequest" + }, + "output": { + "shape": "ListEntitlementsResponse", + "documentation": "AWS Elemental MediaConnect returned the list of entitlements successfully." + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + }, + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + } + ], + "documentation": "Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page." + }, + "ListFlows": { + "name": "ListFlows", + "http": { + "method": "GET", + "requestUri": "/v1/flows", + "responseCode": 200 + }, + "input": { + "shape": "ListFlowsRequest" + }, + "output": { + "shape": "ListFlowsResponse", + "documentation": "AWS Elemental MediaConnect returned the list of flows successfully." + }, + "errors": [ + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + }, + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + } + ], + "documentation": "Displays a list of flows that are associated with this account. This request returns a paginated result." + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse", + "documentation": "The tags for the resource" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The requested resource was not found" + }, + { + "shape": "BadRequestException", + "documentation": "The client performed an invalid request" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + } + ], + "documentation": "List all tags on an AWS Elemental MediaConnect resource" + }, + "RemoveFlowOutput": { + "name": "RemoveFlowOutput", + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}/outputs/{outputArn}", + "responseCode": 202 + }, + "input": { + "shape": "RemoveFlowOutputRequest" + }, + "output": { + "shape": "RemoveFlowOutputResponse", + "documentation": "output successfully removed from flow configuration." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output." + }, + "RevokeFlowEntitlement": { + "name": "RevokeFlowEntitlement", + "http": { + "method": "DELETE", + "requestUri": "/v1/flows/{flowArn}/entitlements/{entitlementArn}", + "responseCode": 202 + }, + "input": { + "shape": "RevokeFlowEntitlementRequest" + }, + "output": { + "shape": "RevokeFlowEntitlementResponse", + "documentation": "AWS Elemental MediaConnect revoked the entitlement successfully." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed." + }, + "StartFlow": { + "name": "StartFlow", + "http": { + "method": "POST", + "requestUri": "/v1/flows/start/{flowArn}", + "responseCode": 202 + }, + "input": { + "shape": "StartFlowRequest" + }, + "output": { + "shape": "StartFlowResponse", + "documentation": "AWS Elemental MediaConnect is starting the flow." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Starts a flow." + }, + "StopFlow": { + "name": "StopFlow", + "http": { + "method": "POST", + "requestUri": "/v1/flows/stop/{flowArn}", + "responseCode": 202 + }, + "input": { + "shape": "StopFlowRequest" + }, + "output": { + "shape": "StopFlowResponse", + "documentation": "AWS Elemental MediaConnect is stopping the flow." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Stops a flow." + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The requested resource was not found" + }, + { + "shape": "BadRequestException", + "documentation": "The client performed an invalid request" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + } + ], + "documentation": "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well." + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The requested resource was not found" + }, + { + "shape": "BadRequestException", + "documentation": "The client performed an invalid request" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + } + ], + "documentation": "Deletes specified tags from a resource." + }, + "UpdateFlowEntitlement": { + "name": "UpdateFlowEntitlement", + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/entitlements/{entitlementArn}", + "responseCode": 202 + }, + "input": { + "shape": "UpdateFlowEntitlementRequest" + }, + "output": { + "shape": "UpdateFlowEntitlementResponse", + "documentation": "AWS Elemental MediaConnect updated the entitlement successfully." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed." + }, + "UpdateFlowOutput": { + "name": "UpdateFlowOutput", + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/outputs/{outputArn}", + "responseCode": 202 + }, + "input": { + "shape": "UpdateFlowOutputRequest" + }, + "output": { + "shape": "UpdateFlowOutputResponse", + "documentation": "AWS Elemental MediaConnect updated the output successfully." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Updates an existing flow output." + }, + "UpdateFlowSource": { + "name": "UpdateFlowSource", + "http": { + "method": "PUT", + "requestUri": "/v1/flows/{flowArn}/source/{sourceArn}", + "responseCode": 202 + }, + "input": { + "shape": "UpdateFlowSourceRequest" + }, + "output": { + "shape": "UpdateFlowSourceResponse", + "documentation": "AWS Elemental MediaConnect updated the flow successfully." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request that you submitted is not valid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have the required permissions to perform this operation." + }, + { + "shape": "NotFoundException", + "documentation": "AWS Elemental MediaConnect did not find the resource that you specified in the request." + }, + { + "shape": "ServiceUnavailableException", + "documentation": "AWS Elemental MediaConnect is currently unavailable. Try again later." + }, + { + "shape": "TooManyRequestsException", + "documentation": "You have exceeded the service request rate limit for your AWS Elemental MediaConnect account." + } + ], + "documentation": "Updates the source of a flow." + } + }, + "shapes": { + "AddFlowOutputs420Exception": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 420 + } + }, + "AddFlowOutputsRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to add outputs to." + }, + "Outputs": { + "shape": "__listOfAddOutputRequest", + "locationName": "outputs", + "documentation": "A list of outputs that you want to add." + } + }, + "documentation": "A request to add outputs to the specified flow.", + "required": [ + "FlowArn", + "Outputs" + ] + }, + "AddFlowOutputsResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that these outputs were added to." + }, + "Outputs": { + "shape": "__listOfOutput", + "locationName": "outputs", + "documentation": "The details of the newly added outputs." + } + } + }, + "AddOutputRequest": { + "type": "structure", + "members": { + "CidrAllowList": { + "shape": "__listOf__string", + "locationName": "cidrAllowList", + "documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user." + }, + "Destination": { + "shape": "__string", + "locationName": "destination", + "documentation": "The IP address from which video will be sent to output destinations." + }, + "Encryption": { + "shape": "Encryption", + "locationName": "encryption", + "documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "MaxLatency": { + "shape": "__integer", + "locationName": "maxLatency", + "documentation": "The maximum latency in milliseconds for Zixi-based streams." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the output. This value must be unique within the current flow." + }, + "Port": { + "shape": "__integer", + "locationName": "port", + "documentation": "The port to use when content is distributed to this output." + }, + "Protocol": { + "shape": "Protocol", + "locationName": "protocol", + "documentation": "The protocol to use for the output." + }, + "RemoteId": { + "shape": "__string", + "locationName": "remoteId", + "documentation": "The remote ID for the Zixi-pull output stream." + }, + "SmoothingLatency": { + "shape": "__integer", + "locationName": "smoothingLatency", + "documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams." + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId", + "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + } + }, + "documentation": "The output that you want to add to this flow.", + "required": [ + "Protocol" + ] + }, + "Algorithm": { + "type": "string", + "enum": [ + "aes128", + "aes192", + "aes256" + ] + }, + "BadRequestException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 400 + } + }, + "CreateFlow420Exception": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 420 + } + }, + "CreateFlowRequest": { + "type": "structure", + "members": { + "AvailabilityZone": { + "shape": "__string", + "locationName": "availabilityZone", + "documentation": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS Region." + }, + "Entitlements": { + "shape": "__listOfGrantEntitlementRequest", + "locationName": "entitlements", + "documentation": "The entitlements that you want to grant on a flow." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the flow." + }, + "Outputs": { + "shape": "__listOfAddOutputRequest", + "locationName": "outputs", + "documentation": "The outputs that you want to add to this flow." + }, + "Source": { + "shape": "SetSourceRequest", + "locationName": "source" + } + }, + "documentation": "Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).", + "required": [ + "Source", + "Name" + ] + }, + "CreateFlowResponse": { + "type": "structure", + "members": { + "Flow": { + "shape": "Flow", + "locationName": "flow" + } + } + }, + "DeleteFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you want to delete." + } + }, + "required": [ + "FlowArn" + ] + }, + "DeleteFlowResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that was deleted." + }, + "Status": { + "shape": "Status", + "locationName": "status", + "documentation": "The status of the flow when the DeleteFlow process begins." + } + } + }, + "DescribeFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you want to describe." + } + }, + "required": [ + "FlowArn" + ] + }, + "DescribeFlowResponse": { + "type": "structure", + "members": { + "Flow": { + "shape": "Flow", + "locationName": "flow" + }, + "Messages": { + "shape": "Messages", + "locationName": "messages" + } + } + }, + "Encryption": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "Algorithm", + "locationName": "algorithm", + "documentation": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "ConstantInitializationVector": { + "shape": "__string", + "locationName": "constantInitializationVector", + "documentation": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption." + }, + "DeviceId": { + "shape": "__string", + "locationName": "deviceId", + "documentation": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "KeyType": { + "shape": "KeyType", + "locationName": "keyType", + "documentation": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "ResourceId": { + "shape": "__string", + "locationName": "resourceId", + "documentation": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "shape": "__string", + "locationName": "secretArn", + "documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption." + } + }, + "documentation": "Information about the encryption of the flow.", + "required": [ + "Algorithm", + "RoleArn" + ] + }, + "Entitlement": { + "type": "structure", + "members": { + "DataTransferSubscriberFeePercent": { + "shape": "__integer", + "locationName": "dataTransferSubscriberFeePercent", + "documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the entitlement." + }, + "Encryption": { + "shape": "Encryption", + "locationName": "encryption", + "documentation": "The type of encryption that will be used on the output that is associated with this entitlement." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the entitlement." + }, + "Subscribers": { + "shape": "__listOf__string", + "locationName": "subscribers", + "documentation": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source." + } + }, + "documentation": "The settings for a flow entitlement.", + "required": [ + "EntitlementArn", + "Subscribers", + "Name" + ] + }, + "Flow": { + "type": "structure", + "members": { + "AvailabilityZone": { + "shape": "__string", + "locationName": "availabilityZone", + "documentation": "The Availability Zone that you want to create the flow in. These options are limited to the Availability Zones within the current AWS." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the flow. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EgressIp": { + "shape": "__string", + "locationName": "egressIp", + "documentation": "The IP address from which video will be sent to output destinations." + }, + "Entitlements": { + "shape": "__listOfEntitlement", + "locationName": "entitlements", + "documentation": "The entitlements in this flow." + }, + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The Amazon Resource Name (ARN), a unique identifier for any AWS resource, of the flow." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the flow." + }, + "Outputs": { + "shape": "__listOfOutput", + "locationName": "outputs", + "documentation": "The outputs in this flow." + }, + "Source": { + "shape": "Source", + "locationName": "source" + }, + "Status": { + "shape": "Status", + "locationName": "status", + "documentation": "The current status of the flow." + } + }, + "documentation": "The settings for a flow, including its source, outputs, and entitlements.", + "required": [ + "Status", + "Entitlements", + "Outputs", + "AvailabilityZone", + "FlowArn", + "Source", + "Name" + ] + }, + "ForbiddenException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 403 + } + }, + "GrantEntitlementRequest": { + "type": "structure", + "members": { + "DataTransferSubscriberFeePercent": { + "shape": "__integer", + "locationName": "dataTransferSubscriberFeePercent", + "documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user." + }, + "Encryption": { + "shape": "Encryption", + "locationName": "encryption", + "documentation": "The type of encryption that will be used on the output that is associated with this entitlement." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the entitlement. This value must be unique within the current flow." + }, + "Subscribers": { + "shape": "__listOf__string", + "locationName": "subscribers", + "documentation": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flows using your content as the source." + } + }, + "documentation": "The entitlements that you want to grant on a flow.", + "required": [ + "Subscribers" + ] + }, + "GrantFlowEntitlements420Exception": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 420 + } + }, + "GrantFlowEntitlementsRequest": { + "type": "structure", + "members": { + "Entitlements": { + "shape": "__listOfGrantEntitlementRequest", + "locationName": "entitlements", + "documentation": "The list of entitlements that you want to grant." + }, + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to grant entitlements on." + } + }, + "documentation": "A request to grant entitlements on a flow.", + "required": [ + "FlowArn", + "Entitlements" + ] + }, + "GrantFlowEntitlementsResponse": { + "type": "structure", + "members": { + "Entitlements": { + "shape": "__listOfEntitlement", + "locationName": "entitlements", + "documentation": "The entitlements that were just granted." + }, + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that these entitlements were granted to." + } + } + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 500 + } + }, + "KeyType": { + "type": "string", + "enum": [ + "speke", + "static-key" + ] + }, + "ListEntitlementsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page." + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value." + } + } + }, + "ListEntitlementsResponse": { + "type": "structure", + "members": { + "Entitlements": { + "shape": "__listOfListedEntitlement", + "locationName": "entitlements", + "documentation": "A list of entitlements that have been granted to you from other AWS accounts." + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value." + } + } + }, + "ListFlowsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults", + "documentation": "The maximum number of results to return per API request. For example, you submit a ListFlows request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 10 results per page." + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken", + "documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value." + } + } + }, + "ListFlowsResponse": { + "type": "structure", + "members": { + "Flows": { + "shape": "__listOfListedFlow", + "locationName": "flows", + "documentation": "A list of flow summaries." + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The token that identifies which batch of results that you want to see. For example, you submit a ListFlows request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListFlows request a second time and specify the NextToken value." + } + } + }, + "ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource for which to list the tags." + } + }, + "required": [ + "ResourceArn" + ] + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters." + } + } + }, + "ListedEntitlement": { + "type": "structure", + "members": { + "DataTransferSubscriberFeePercent": { + "shape": "__integer", + "locationName": "dataTransferSubscriberFeePercent", + "documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement." + }, + "EntitlementName": { + "shape": "__string", + "locationName": "entitlementName", + "documentation": "The name of the entitlement." + } + }, + "documentation": "An entitlement that has been granted to you from other AWS accounts.", + "required": [ + "EntitlementArn", + "EntitlementName" + ] + }, + "ListedFlow": { + "type": "structure", + "members": { + "AvailabilityZone": { + "shape": "__string", + "locationName": "availabilityZone", + "documentation": "The Availability Zone that the flow was created in." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the flow." + }, + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the flow." + }, + "SourceType": { + "shape": "SourceType", + "locationName": "sourceType", + "documentation": "The type of source. This value is either owned (originated somewhere other than an AWS Elemental MediaConnect flow owned by another AWS account) or entitled (originated at an AWS Elemental MediaConnect flow owned by another AWS account)." + }, + "Status": { + "shape": "Status", + "locationName": "status", + "documentation": "The current status of the flow." + } + }, + "documentation": "Provides a summary of a flow, including its ARN, Availability Zone, and source type.", + "required": [ + "Status", + "Description", + "SourceType", + "AvailabilityZone", + "FlowArn", + "Name" + ] + }, + "MaxResults": { + "type": "integer", + "min": 1, + "max": 1000 + }, + "Messages": { + "type": "structure", + "members": { + "Errors": { + "shape": "__listOf__string", + "locationName": "errors", + "documentation": "A list of errors that might have been generated from processes on this flow." + } + }, + "documentation": "Messages that provide the state of the flow.", + "required": [ + "Errors" + ] + }, + "NotFoundException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 404 + } + }, + "Output": { + "type": "structure", + "members": { + "DataTransferSubscriberFeePercent": { + "shape": "__integer", + "locationName": "dataTransferSubscriberFeePercent", + "documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the output." + }, + "Destination": { + "shape": "__string", + "locationName": "destination", + "documentation": "The address where you want to send the output." + }, + "Encryption": { + "shape": "Encryption", + "locationName": "encryption", + "documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement on the originator''s flow. This value is relevant only on entitled flows." + }, + "MediaLiveInputArn": { + "shape": "__string", + "locationName": "mediaLiveInputArn", + "documentation": "The input ARN of the AWS Elemental MediaLive channel. This parameter is relevant only for outputs that were added by creating a MediaLive input." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the output. This value must be unique within the current flow." + }, + "OutputArn": { + "shape": "__string", + "locationName": "outputArn", + "documentation": "The ARN of the output." + }, + "Port": { + "shape": "__integer", + "locationName": "port", + "documentation": "The port to use when content is distributed to this output." + }, + "Transport": { + "shape": "Transport", + "locationName": "transport", + "documentation": "Attributes related to the transport stream that are used in the output." + } + }, + "documentation": "The settings for an output.", + "required": [ + "OutputArn", + "Name" + ] + }, + "Protocol": { + "type": "string", + "enum": [ + "zixi-push", + "rtp-fec", + "rtp", + "zixi-pull", + "rist" + ] + }, + "RemoveFlowOutputRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to remove an output from." + }, + "OutputArn": { + "shape": "__string", + "location": "uri", + "locationName": "outputArn", + "documentation": "The ARN of the output that you want to remove." + } + }, + "required": [ + "FlowArn", + "OutputArn" + ] + }, + "RemoveFlowOutputResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that is associated with the output you removed." + }, + "OutputArn": { + "shape": "__string", + "locationName": "outputArn", + "documentation": "The ARN of the output that was removed." + } + } + }, + "ResponseError": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ] + }, + "RevokeFlowEntitlementRequest": { + "type": "structure", + "members": { + "EntitlementArn": { + "shape": "__string", + "location": "uri", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that you want to revoke." + }, + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that you want to revoke an entitlement from." + } + }, + "required": [ + "FlowArn", + "EntitlementArn" + ] + }, + "RevokeFlowEntitlementResponse": { + "type": "structure", + "members": { + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that was revoked." + }, + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that the entitlement was revoked from." + } + } + }, + "ServiceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 503 + } + }, + "SetSourceRequest": { + "type": "structure", + "members": { + "Decryption": { + "shape": "Encryption", + "locationName": "decryption", + "documentation": "The type of encryption that is used on the content ingested from this source." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow." + }, + "IngestPort": { + "shape": "__integer", + "locationName": "ingestPort", + "documentation": "The port that the flow will be listening on for incoming content." + }, + "MaxBitrate": { + "shape": "__integer", + "locationName": "maxBitrate", + "documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams." + }, + "MaxLatency": { + "shape": "__integer", + "locationName": "maxLatency", + "documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the source." + }, + "Protocol": { + "shape": "Protocol", + "locationName": "protocol", + "documentation": "The protocol that is used by the source." + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId", + "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "WhitelistCidr": { + "shape": "__string", + "locationName": "whitelistCidr", + "documentation": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + } + }, + "documentation": "The settings for the source of the flow." + }, + "Source": { + "type": "structure", + "members": { + "DataTransferSubscriberFeePercent": { + "shape": "__integer", + "locationName": "dataTransferSubscriberFeePercent", + "documentation": "Percentage from 0-100 of the data transfer cost to be billed to the subscriber." + }, + "Decryption": { + "shape": "Encryption", + "locationName": "decryption", + "documentation": "The type of encryption that is used on the content ingested from this source." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that allows you to subscribe to content that comes from another AWS account. The entitlement is set by the content originator and the ARN is generated as part of the originator's flow." + }, + "IngestIp": { + "shape": "__string", + "locationName": "ingestIp", + "documentation": "The IP address that the flow will be listening on for incoming content." + }, + "IngestPort": { + "shape": "__integer", + "locationName": "ingestPort", + "documentation": "The port that the flow will be listening on for incoming content." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the source." + }, + "SourceArn": { + "shape": "__string", + "locationName": "sourceArn", + "documentation": "The ARN of the source." + }, + "Transport": { + "shape": "Transport", + "locationName": "transport", + "documentation": "Attributes related to the transport stream that are used in the source." + }, + "WhitelistCidr": { + "shape": "__string", + "locationName": "whitelistCidr", + "documentation": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + } + }, + "documentation": "The settings for the source of the flow.", + "required": [ + "SourceArn", + "Name" + ] + }, + "SourceType": { + "type": "string", + "enum": [ + "OWNED", + "ENTITLED" + ] + }, + "StartFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you want to start." + } + }, + "required": [ + "FlowArn" + ] + }, + "StartFlowResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you started." + }, + "Status": { + "shape": "Status", + "locationName": "status", + "documentation": "The status of the flow when the StartFlow process begins." + } + } + }, + "Status": { + "type": "string", + "enum": [ + "STANDBY", + "ACTIVE", + "UPDATING", + "DELETING", + "STARTING", + "STOPPING", + "ERROR" + ] + }, + "StopFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you want to stop." + } + }, + "required": [ + "FlowArn" + ] + }, + "StopFlowResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you stopped." + }, + "Status": { + "shape": "Status", + "locationName": "status", + "documentation": "The status of the flow when the StopFlow process begins." + } + } + }, + "TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource to which to add tags." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "A map from tag keys to values. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters." + } + }, + "documentation": "The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.", + "required": [ + "ResourceArn", + "Tags" + ] + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message", + "documentation": "The error message returned by AWS Elemental MediaConnect." + } + }, + "documentation": "Exception raised by AWS Elemental MediaConnect. See the error message and documentation for the operation for more information on the cause of this exception.", + "required": [ + "Message" + ], + "exception": true, + "error": { + "httpStatusCode": 429 + } + }, + "Transport": { + "type": "structure", + "members": { + "CidrAllowList": { + "shape": "__listOf__string", + "locationName": "cidrAllowList", + "documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + }, + "MaxBitrate": { + "shape": "__integer", + "locationName": "maxBitrate", + "documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams." + }, + "MaxLatency": { + "shape": "__integer", + "locationName": "maxLatency", + "documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "Protocol": { + "shape": "Protocol", + "locationName": "protocol", + "documentation": "The protocol that is used by the source or output." + }, + "RemoteId": { + "shape": "__string", + "locationName": "remoteId", + "documentation": "The remote ID for the Zixi-pull stream." + }, + "SmoothingLatency": { + "shape": "__integer", + "locationName": "smoothingLatency", + "documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams." + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId", + "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + } + }, + "documentation": "Attributes related to the transport stream that are used in a source or output.", + "required": [ + "Protocol" + ] + }, + "UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resourceArn", + "documentation": "The Amazon Resource Name (ARN) that identifies the AWS Elemental MediaConnect resource from which to delete tags." + }, + "TagKeys": { + "shape": "__listOf__string", + "location": "querystring", + "locationName": "tagKeys", + "documentation": "The keys of the tags to be removed." + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + }, + "UpdateEncryption": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "Algorithm", + "locationName": "algorithm", + "documentation": "The type of algorithm that is used for the encryption (such as aes128, aes192, or aes256)." + }, + "ConstantInitializationVector": { + "shape": "__string", + "locationName": "constantInitializationVector", + "documentation": "A 128-bit, 16-byte hex value represented by a 32-character string, to be used with the key for encrypting content. This parameter is not valid for static key encryption." + }, + "DeviceId": { + "shape": "__string", + "locationName": "deviceId", + "documentation": "The value of one of the devices that you configured with your digital rights management (DRM) platform key provider. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "KeyType": { + "shape": "KeyType", + "locationName": "keyType", + "documentation": "The type of key that is used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "The AWS Region that the API Gateway proxy endpoint was created in. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "ResourceId": { + "shape": "__string", + "locationName": "resourceId", + "documentation": "An identifier for the content. The service sends this value to the key server to identify the current endpoint. The resource ID is also known as the content ID. This parameter is required for SPEKE encryption and is not valid for static key encryption." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The ARN of the role that you created during setup (when you set up AWS Elemental MediaConnect as a trusted entity)." + }, + "SecretArn": { + "shape": "__string", + "locationName": "secretArn", + "documentation": "The ARN of the secret that you created in AWS Secrets Manager to store the encryption key. This parameter is required for static key encryption and is not valid for SPEKE encryption." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "The URL from the API Gateway proxy that you set up to talk to your key server. This parameter is required for SPEKE encryption and is not valid for static key encryption." + } + }, + "documentation": "Information about the encryption of the flow." + }, + "UpdateFlowEntitlementRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the entitlement. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the subscriber or end user." + }, + "Encryption": { + "shape": "UpdateEncryption", + "locationName": "encryption", + "documentation": "The type of encryption that will be used on the output associated with this entitlement." + }, + "EntitlementArn": { + "shape": "__string", + "location": "uri", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that you want to update." + }, + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that is associated with the entitlement that you want to update." + }, + "Subscribers": { + "shape": "__listOf__string", + "locationName": "subscribers", + "documentation": "The AWS account IDs that you want to share your content with. The receiving accounts (subscribers) will be allowed to create their own flow using your content as the source." + } + }, + "documentation": "The entitlement fields that you want to update.", + "required": [ + "FlowArn", + "EntitlementArn" + ] + }, + "UpdateFlowEntitlementResponse": { + "type": "structure", + "members": { + "Entitlement": { + "shape": "Entitlement", + "locationName": "entitlement" + }, + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that this entitlement was granted on." + } + } + }, + "UpdateFlowOutputRequest": { + "type": "structure", + "members": { + "CidrAllowList": { + "shape": "__listOf__string", + "locationName": "cidrAllowList", + "documentation": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description of the output. This description appears only on the AWS Elemental MediaConnect console and will not be seen by the end user." + }, + "Destination": { + "shape": "__string", + "locationName": "destination", + "documentation": "The IP address where you want to send the output." + }, + "Encryption": { + "shape": "UpdateEncryption", + "locationName": "encryption", + "documentation": "The type of key used for the encryption. If no keyType is provided, the service will use the default setting (static-key)." + }, + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that is associated with the output that you want to update." + }, + "MaxLatency": { + "shape": "__integer", + "locationName": "maxLatency", + "documentation": "The maximum latency in milliseconds for Zixi-based streams." + }, + "OutputArn": { + "shape": "__string", + "location": "uri", + "locationName": "outputArn", + "documentation": "The ARN of the output that you want to update." + }, + "Port": { + "shape": "__integer", + "locationName": "port", + "documentation": "The port to use when content is distributed to this output." + }, + "Protocol": { + "shape": "Protocol", + "locationName": "protocol", + "documentation": "The protocol to use for the output." + }, + "RemoteId": { + "shape": "__string", + "locationName": "remoteId", + "documentation": "The remote ID for the Zixi-pull stream." + }, + "SmoothingLatency": { + "shape": "__integer", + "locationName": "smoothingLatency", + "documentation": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams." + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId", + "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + } + }, + "documentation": "The fields that you want to update in the output.", + "required": [ + "FlowArn", + "OutputArn" + ] + }, + "UpdateFlowOutputResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that is associated with the updated output." + }, + "Output": { + "shape": "Output", + "locationName": "output" + } + } + }, + "UpdateFlowSourceRequest": { + "type": "structure", + "members": { + "Decryption": { + "shape": "UpdateEncryption", + "locationName": "decryption", + "documentation": "The type of encryption used on the content ingested from this source." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "A description for the source. This value is not used or seen outside of the current AWS Elemental MediaConnect account." + }, + "EntitlementArn": { + "shape": "__string", + "locationName": "entitlementArn", + "documentation": "The ARN of the entitlement that allows you to subscribe to this flow. The entitlement is set by the flow originator, and the ARN is generated as part of the originator's flow." + }, + "FlowArn": { + "shape": "__string", + "location": "uri", + "locationName": "flowArn", + "documentation": "The flow that is associated with the source that you want to update." + }, + "IngestPort": { + "shape": "__integer", + "locationName": "ingestPort", + "documentation": "The port that the flow will be listening on for incoming content." + }, + "MaxBitrate": { + "shape": "__integer", + "locationName": "maxBitrate", + "documentation": "The smoothing max bitrate for RIST, RTP, and RTP-FEC streams." + }, + "MaxLatency": { + "shape": "__integer", + "locationName": "maxLatency", + "documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams." + }, + "Protocol": { + "shape": "Protocol", + "locationName": "protocol", + "documentation": "The protocol that is used by the source." + }, + "SourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "sourceArn", + "documentation": "The ARN of the source that you want to update." + }, + "StreamId": { + "shape": "__string", + "locationName": "streamId", + "documentation": "The stream ID that you want to use for this transport. This parameter applies only to Zixi-based streams." + }, + "WhitelistCidr": { + "shape": "__string", + "locationName": "whitelistCidr", + "documentation": "The range of IP addresses that should be allowed to contribute content to your source. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16." + } + }, + "documentation": "A request to update the source of a flow.", + "required": [ + "FlowArn", + "SourceArn" + ] + }, + "UpdateFlowSourceResponse": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the flow that you want to update." + }, + "Source": { + "shape": "Source", + "locationName": "source", + "documentation": "The settings for the source of the flow." + } + } + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__listOfAddOutputRequest": { + "type": "list", + "member": { + "shape": "AddOutputRequest" + } + }, + "__listOfEntitlement": { + "type": "list", + "member": { + "shape": "Entitlement" + } + }, + "__listOfGrantEntitlementRequest": { + "type": "list", + "member": { + "shape": "GrantEntitlementRequest" + } + }, + "__listOfListedEntitlement": { + "type": "list", + "member": { + "shape": "ListedEntitlement" + } + }, + "__listOfListedFlow": { + "type": "list", + "member": { + "shape": "ListedFlow" + } + }, + "__listOfOutput": { + "type": "list", + "member": { + "shape": "Output" + } + }, + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" + } + }, + "__long": { + "type": "long" + }, + "__mapOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" + } + }, + "documentation": "API for AWS Elemental MediaConnect" +} diff --git a/aws/dist/botocore/data/mediaconvert/2017-08-29/paginators-1.json b/aws/dist/botocore/data/mediaconvert/2017-08-29/paginators-1.json new file mode 100644 index 00000000..5588b9e6 --- /dev/null +++ b/aws/dist/botocore/data/mediaconvert/2017-08-29/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "DescribeEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Endpoints" + }, + "ListJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Jobs" + }, + "ListPresets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Presets" + }, + "ListJobTemplates": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "JobTemplates" + }, + "ListQueues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Queues" + } + } +} diff --git a/aws/dist/botocore/data/mediaconvert/2017-08-29/service-2.json b/aws/dist/botocore/data/mediaconvert/2017-08-29/service-2.json new file mode 100644 index 00000000..f322ebd6 --- /dev/null +++ b/aws/dist/botocore/data/mediaconvert/2017-08-29/service-2.json @@ -0,0 +1,9767 @@ +{ + "metadata": { + "apiVersion": "2017-08-29", + "endpointPrefix": "mediaconvert", + "signingName": "mediaconvert", + "serviceFullName": "AWS Elemental MediaConvert", + "serviceId": "MediaConvert", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "mediaconvert-2017-08-29", + "signatureVersion": "v4", + "serviceAbbreviation": "MediaConvert" + }, + "operations": { + "AssociateCertificate": { + "name": "AssociateCertificate", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/certificates", + "responseCode": 201 + }, + "input": { + "shape": "AssociateCertificateRequest" + }, + "output": { + "shape": "AssociateCertificateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and cannot fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested does not exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service could not complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert." + }, + "CancelJob": { + "name": "CancelJob", + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/jobs/{id}", + "responseCode": 202 + }, + "input": { + "shape": "CancelJobRequest" + }, + "output": { + "shape": "CancelJobResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Permanently cancel a job. Once you have canceled a job, you can't start it again." + }, + "CreateJob": { + "name": "CreateJob", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/jobs", + "responseCode": 201 + }, + "input": { + "shape": "CreateJobRequest" + }, + "output": { + "shape": "CreateJobResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Create a new transcoding job. For information about jobs and job settings, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + }, + "CreateJobTemplate": { + "name": "CreateJobTemplate", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/jobTemplates", + "responseCode": 201 + }, + "input": { + "shape": "CreateJobTemplateRequest" + }, + "output": { + "shape": "CreateJobTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Create a new job template. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + }, + "CreatePreset": { + "name": "CreatePreset", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/presets", + "responseCode": 201 + }, + "input": { + "shape": "CreatePresetRequest" + }, + "output": { + "shape": "CreatePresetResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Create a new preset. For information about job templates see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + }, + "CreateQueue": { + "name": "CreateQueue", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/queues", + "responseCode": 201 + }, + "input": { + "shape": "CreateQueueRequest" + }, + "output": { + "shape": "CreateQueueResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Create a new transcoding queue. For information about queues, see Working With Queues in the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html" + }, + "DeleteJobTemplate": { + "name": "DeleteJobTemplate", + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteJobTemplateRequest" + }, + "output": { + "shape": "DeleteJobTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Permanently delete a job template you have created." + }, + "DeletePreset": { + "name": "DeletePreset", + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 202 + }, + "input": { + "shape": "DeletePresetRequest" + }, + "output": { + "shape": "DeletePresetResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Permanently delete a preset you have created." + }, + "DeleteQueue": { + "name": "DeleteQueue", + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteQueueRequest" + }, + "output": { + "shape": "DeleteQueueResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Permanently delete a queue you have created." + }, + "DescribeEndpoints": { + "name": "DescribeEndpoints", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/endpoints", + "responseCode": 200 + }, + "input": { + "shape": "DescribeEndpointsRequest" + }, + "output": { + "shape": "DescribeEndpointsResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "BadRequestException" + }, + { + "shape": "InternalServerErrorException", + "documentation": "InternalServiceException" + }, + { + "shape": "ForbiddenException", + "documentation": "AccessDeniedException" + }, + { + "shape": "NotFoundException", + "documentation": "ResourceNotFoundException" + }, + { + "shape": "TooManyRequestsException", + "documentation": "LimitExceededException" + }, + { + "shape": "ConflictException", + "documentation": "ResourceInUseException" + } + ], + "documentation": "Send an request with an empty body to the regional API endpoint to get your account API endpoint." + }, + "DisassociateCertificate": { + "name": "DisassociateCertificate", + "http": { + "method": "DELETE", + "requestUri": "/2017-08-29/certificates/{arn}", + "responseCode": 202 + }, + "input": { + "shape": "DisassociateCertificateRequest" + }, + "output": { + "shape": "DisassociateCertificateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and cannot fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested does not exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service could not complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource." + }, + "GetJob": { + "name": "GetJob", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobs/{id}", + "responseCode": 200 + }, + "input": { + "shape": "GetJobRequest" + }, + "output": { + "shape": "GetJobResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve the JSON for a specific completed transcoding job." + }, + "GetJobTemplate": { + "name": "GetJobTemplate", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 200 + }, + "input": { + "shape": "GetJobTemplateRequest" + }, + "output": { + "shape": "GetJobTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve the JSON for a specific job template." + }, + "GetPreset": { + "name": "GetPreset", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 200 + }, + "input": { + "shape": "GetPresetRequest" + }, + "output": { + "shape": "GetPresetResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve the JSON for a specific preset." + }, + "GetQueue": { + "name": "GetQueue", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 200 + }, + "input": { + "shape": "GetQueueRequest" + }, + "output": { + "shape": "GetQueueResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve the JSON for a specific queue." + }, + "ListJobTemplates": { + "name": "ListJobTemplates", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobTemplates", + "responseCode": 200 + }, + "input": { + "shape": "ListJobTemplatesRequest" + }, + "output": { + "shape": "ListJobTemplatesResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve a JSON array of up to twenty of your job templates. This will return the templates themselves, not just a list of them. To retrieve the next twenty templates, use the nextToken string returned with the array" + }, + "ListJobs": { + "name": "ListJobs", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/jobs", + "responseCode": 200 + }, + "input": { + "shape": "ListJobsRequest" + }, + "output": { + "shape": "ListJobsResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve a JSON array of up to twenty of your most recently created jobs. This array includes in-process, completed, and errored jobs. This will return the jobs themselves, not just a list of the jobs. To retrieve the twenty next most recent jobs, use the nextToken string returned with the array." + }, + "ListPresets": { + "name": "ListPresets", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/presets", + "responseCode": 200 + }, + "input": { + "shape": "ListPresetsRequest" + }, + "output": { + "shape": "ListPresetsResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve a JSON array of up to twenty of your presets. This will return the presets themselves, not just a list of them. To retrieve the next twenty presets, use the nextToken string returned with the array." + }, + "ListQueues": { + "name": "ListQueues", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/queues", + "responseCode": 200 + }, + "input": { + "shape": "ListQueuesRequest" + }, + "output": { + "shape": "ListQueuesResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve a JSON array of up to twenty of your queues. This will return the queues themselves, not just a list of them. To retrieve the next twenty queues, use the nextToken string returned with the array." + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/2017-08-29/tags/{arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Retrieve the tags for a MediaConvert resource." + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/2017-08-29/tags", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Add tags to a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/tags/{arn}", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Remove tags from a MediaConvert queue, preset, or job template. For information about tagging, see the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/tagging-resources.html" + }, + "UpdateJobTemplate": { + "name": "UpdateJobTemplate", + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/jobTemplates/{name}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateJobTemplateRequest" + }, + "output": { + "shape": "UpdateJobTemplateResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Modify one of your existing job templates." + }, + "UpdatePreset": { + "name": "UpdatePreset", + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/presets/{name}", + "responseCode": 200 + }, + "input": { + "shape": "UpdatePresetRequest" + }, + "output": { + "shape": "UpdatePresetResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Modify one of your existing presets." + }, + "UpdateQueue": { + "name": "UpdateQueue", + "http": { + "method": "PUT", + "requestUri": "/2017-08-29/queues/{name}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateQueueRequest" + }, + "output": { + "shape": "UpdateQueueResponse" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + { + "shape": "InternalServerErrorException", + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + { + "shape": "ForbiddenException", + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + { + "shape": "NotFoundException", + "documentation": "The resource you requested doesn't exist." + }, + { + "shape": "TooManyRequestsException", + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + { + "shape": "ConflictException", + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + } + ], + "documentation": "Modify one of your existing queues." + } + }, + "shapes": { + "AacAudioDescriptionBroadcasterMix": { + "type": "string", + "documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.", + "enum": [ + "BROADCASTER_MIXED_AD", + "NORMAL" + ] + }, + "AacCodecProfile": { + "type": "string", + "documentation": "AAC Profile.", + "enum": [ + "LC", + "HEV1", + "HEV2" + ] + }, + "AacCodingMode": { + "type": "string", + "documentation": "Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. \"1.0 - Audio Description (Receiver Mix)\" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.", + "enum": [ + "AD_RECEIVER_MIX", + "CODING_MODE_1_0", + "CODING_MODE_1_1", + "CODING_MODE_2_0", + "CODING_MODE_5_1" + ] + }, + "AacRateControlMode": { + "type": "string", + "documentation": "Rate Control Mode.", + "enum": [ + "CBR", + "VBR" + ] + }, + "AacRawFormat": { + "type": "string", + "documentation": "Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose \"No container\" for the output container.", + "enum": [ + "LATM_LOAS", + "NONE" + ] + }, + "AacSettings": { + "type": "structure", + "members": { + "AudioDescriptionBroadcasterMix": { + "shape": "AacAudioDescriptionBroadcasterMix", + "locationName": "audioDescriptionBroadcasterMix", + "documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType." + }, + "Bitrate": { + "shape": "__integerMin6000Max1024000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile." + }, + "CodecProfile": { + "shape": "AacCodecProfile", + "locationName": "codecProfile", + "documentation": "AAC Profile." + }, + "CodingMode": { + "shape": "AacCodingMode", + "locationName": "codingMode", + "documentation": "Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. \"1.0 - Audio Description (Receiver Mix)\" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E." + }, + "RateControlMode": { + "shape": "AacRateControlMode", + "locationName": "rateControlMode", + "documentation": "Rate Control Mode." + }, + "RawFormat": { + "shape": "AacRawFormat", + "locationName": "rawFormat", + "documentation": "Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose \"No container\" for the output container." + }, + "SampleRate": { + "shape": "__integerMin8000Max96000", + "locationName": "sampleRate", + "documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile." + }, + "Specification": { + "shape": "AacSpecification", + "locationName": "specification", + "documentation": "Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers." + }, + "VbrQuality": { + "shape": "AacVbrQuality", + "locationName": "vbrQuality", + "documentation": "VBR Quality Level - Only used if rate_control_mode is VBR." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to \"VBR\" or \"CBR\". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode." + }, + "AacSpecification": { + "type": "string", + "documentation": "Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", + "enum": [ + "MPEG2", + "MPEG4" + ] + }, + "AacVbrQuality": { + "type": "string", + "documentation": "VBR Quality Level - Only used if rate_control_mode is VBR.", + "enum": [ + "LOW", + "MEDIUM_LOW", + "MEDIUM_HIGH", + "HIGH" + ] + }, + "Ac3BitstreamMode": { + "type": "string", + "documentation": "Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "enum": [ + "COMPLETE_MAIN", + "COMMENTARY", + "DIALOGUE", + "EMERGENCY", + "HEARING_IMPAIRED", + "MUSIC_AND_EFFECTS", + "VISUALLY_IMPAIRED", + "VOICE_OVER" + ] + }, + "Ac3CodingMode": { + "type": "string", + "documentation": "Dolby Digital coding mode. Determines number of channels.", + "enum": [ + "CODING_MODE_1_0", + "CODING_MODE_1_1", + "CODING_MODE_2_0", + "CODING_MODE_3_2_LFE" + ] + }, + "Ac3DynamicRangeCompressionProfile": { + "type": "string", + "documentation": "If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.", + "enum": [ + "FILM_STANDARD", + "NONE" + ] + }, + "Ac3LfeFilter": { + "type": "string", + "documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Ac3MetadataControl": { + "type": "string", + "documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "Ac3Settings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__integerMin64000Max640000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode." + }, + "BitstreamMode": { + "shape": "Ac3BitstreamMode", + "locationName": "bitstreamMode", + "documentation": "Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E)." + }, + "CodingMode": { + "shape": "Ac3CodingMode", + "locationName": "codingMode", + "documentation": "Dolby Digital coding mode. Determines number of channels." + }, + "Dialnorm": { + "shape": "__integerMin1Max31", + "locationName": "dialnorm", + "documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through." + }, + "DynamicRangeCompressionProfile": { + "shape": "Ac3DynamicRangeCompressionProfile", + "locationName": "dynamicRangeCompressionProfile", + "documentation": "If set to FILM_STANDARD, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification." + }, + "LfeFilter": { + "shape": "Ac3LfeFilter", + "locationName": "lfeFilter", + "documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode." + }, + "MetadataControl": { + "shape": "Ac3MetadataControl", + "locationName": "metadataControl", + "documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used." + }, + "SampleRate": { + "shape": "__integerMin48000Max48000", + "locationName": "sampleRate", + "documentation": "This value is always 48000. It represents the sample rate in Hz." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3." + }, + "AccelerationMode": { + "type": "string", + "documentation": "Specify whether the service runs your job with accelerated transcoding. Choose DISABLED if you don't want accelerated transcoding. Choose ENABLED if you want your job to run with accelerated transcoding and to fail if your input files or your job settings aren't compatible with accelerated transcoding. Choose PREFERRED if you want your job to run with accelerated transcoding if the job is compatible with the feature and to run at standard speed if it's not.", + "enum": [ + "DISABLED", + "ENABLED", + "PREFERRED" + ] + }, + "AccelerationSettings": { + "type": "structure", + "members": { + "Mode": { + "shape": "AccelerationMode", + "locationName": "mode", + "documentation": "Specify the conditions when the service will run your job with accelerated transcoding." + } + }, + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", + "required": [ + "Mode" + ] + }, + "AccelerationStatus": { + "type": "string", + "documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.", + "enum": [ + "NOT_APPLICABLE", + "IN_PROGRESS", + "ACCELERATED", + "NOT_ACCELERATED" + ] + }, + "AfdSignaling": { + "type": "string", + "documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.", + "enum": [ + "NONE", + "AUTO", + "FIXED" + ] + }, + "AiffSettings": { + "type": "structure", + "members": { + "BitDepth": { + "shape": "__integerMin16Max24", + "locationName": "bitDepth", + "documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track." + }, + "Channels": { + "shape": "__integerMin1Max64", + "locationName": "channels", + "documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64." + }, + "SampleRate": { + "shape": "__integerMin8000Max192000", + "locationName": "sampleRate", + "documentation": "Sample rate in hz." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF." + }, + "AncillaryConvert608To708": { + "type": "string", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", + "enum": [ + "UPCONVERT", + "DISABLED" + ] + }, + "AncillarySourceSettings": { + "type": "structure", + "members": { + "Convert608To708": { + "shape": "AncillaryConvert608To708", + "locationName": "convert608To708", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708." + }, + "SourceAncillaryChannelNumber": { + "shape": "__integerMin1Max4", + "locationName": "sourceAncillaryChannelNumber", + "documentation": "Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough." + }, + "TerminateCaptions": { + "shape": "AncillaryTerminateCaptions", + "locationName": "terminateCaptions", + "documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting." + } + }, + "documentation": "Settings for ancillary captions source." + }, + "AncillaryTerminateCaptions": { + "type": "string", + "documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", + "enum": [ + "END_OF_INPUT", + "DISABLED" + ] + }, + "AntiAlias": { + "type": "string", + "documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "AssociateCertificateRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The ARN of the ACM certificate that you want to associate with your MediaConvert resource." + } + }, + "required": [ + "Arn" + ] + }, + "AssociateCertificateResponse": { + "type": "structure", + "members": { + } + }, + "AudioCodec": { + "type": "string", + "documentation": "Type of Audio codec.", + "enum": [ + "AAC", + "MP2", + "WAV", + "AIFF", + "AC3", + "EAC3", + "EAC3_ATMOS", + "PASSTHROUGH" + ] + }, + "AudioCodecSettings": { + "type": "structure", + "members": { + "AacSettings": { + "shape": "AacSettings", + "locationName": "aacSettings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode (rateControlMode) to \"VBR\" or \"CBR\". In VBR mode, you control the audio quality with the setting VBR quality (vbrQuality). In CBR mode, you use the setting Bitrate (bitrate). Defaults and valid values depend on the rate control mode." + }, + "Ac3Settings": { + "shape": "Ac3Settings", + "locationName": "ac3Settings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AC3." + }, + "AiffSettings": { + "shape": "AiffSettings", + "locationName": "aiffSettings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF." + }, + "Codec": { + "shape": "AudioCodec", + "locationName": "codec", + "documentation": "Type of Audio codec." + }, + "Eac3AtmosSettings": { + "shape": "Eac3AtmosSettings", + "locationName": "eac3AtmosSettings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS." + }, + "Eac3Settings": { + "shape": "Eac3Settings", + "locationName": "eac3Settings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3." + }, + "Mp2Settings": { + "shape": "Mp2Settings", + "locationName": "mp2Settings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2." + }, + "WavSettings": { + "shape": "WavSettings", + "locationName": "wavSettings", + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV." + } + }, + "documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings" + }, + "AudioDefaultSelection": { + "type": "string", + "documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.", + "enum": [ + "DEFAULT", + "NOT_DEFAULT" + ] + }, + "AudioDescription": { + "type": "structure", + "members": { + "AudioNormalizationSettings": { + "shape": "AudioNormalizationSettings", + "locationName": "audioNormalizationSettings", + "documentation": "Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard." + }, + "AudioSourceName": { + "shape": "__string", + "locationName": "audioSourceName", + "documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically." + }, + "AudioType": { + "shape": "__integerMin0Max255", + "locationName": "audioType", + "documentation": "Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved." + }, + "AudioTypeControl": { + "shape": "AudioTypeControl", + "locationName": "audioTypeControl", + "documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD." + }, + "CodecSettings": { + "shape": "AudioCodecSettings", + "locationName": "codecSettings", + "documentation": "Audio codec settings (CodecSettings) under (AudioDescriptions) contains the group of settings related to audio encoding. The settings in this group vary depending on the value that you choose for Audio codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * AAC, AacSettings * MP2, Mp2Settings * WAV, WavSettings * AIFF, AiffSettings * AC3, Ac3Settings * EAC3, Eac3Settings * EAC3_ATMOS, Eac3AtmosSettings" + }, + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "Specify the language for this audio output track, using the ISO 639-2 or ISO 639-3 three-letter language code. The language specified will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input." + }, + "LanguageCodeControl": { + "shape": "AudioLanguageCodeControl", + "locationName": "languageCodeControl", + "documentation": "Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input." + }, + "RemixSettings": { + "shape": "RemixSettings", + "locationName": "remixSettings", + "documentation": "Advanced audio remixing settings." + }, + "StreamName": { + "shape": "__stringPatternWS", + "locationName": "streamName", + "documentation": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting." + } + }, + "documentation": "Description of audio output" + }, + "AudioLanguageCodeControl": { + "type": "string", + "documentation": "Choosing FOLLOW_INPUT will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The language specified for languageCode' will be used when USE_CONFIGURED is selected or when FOLLOW_INPUT is selected but there is no ISO 639 language code specified by the input.", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "AudioNormalizationAlgorithm": { + "type": "string", + "documentation": "Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.", + "enum": [ + "ITU_BS_1770_1", + "ITU_BS_1770_2", + "ITU_BS_1770_3", + "ITU_BS_1770_4" + ] + }, + "AudioNormalizationAlgorithmControl": { + "type": "string", + "documentation": "When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.", + "enum": [ + "CORRECT_AUDIO", + "MEASURE_ONLY" + ] + }, + "AudioNormalizationLoudnessLogging": { + "type": "string", + "documentation": "If set to LOG, log each output's audio track loudness to a CSV file.", + "enum": [ + "LOG", + "DONT_LOG" + ] + }, + "AudioNormalizationPeakCalculation": { + "type": "string", + "documentation": "If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.", + "enum": [ + "TRUE_PEAK", + "NONE" + ] + }, + "AudioNormalizationSettings": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "AudioNormalizationAlgorithm", + "locationName": "algorithm", + "documentation": "Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1." + }, + "AlgorithmControl": { + "shape": "AudioNormalizationAlgorithmControl", + "locationName": "algorithmControl", + "documentation": "When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted." + }, + "CorrectionGateLevel": { + "shape": "__integerMinNegative70Max0", + "locationName": "correctionGateLevel", + "documentation": "Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected. Gating only applies when not using real_time_correction." + }, + "LoudnessLogging": { + "shape": "AudioNormalizationLoudnessLogging", + "locationName": "loudnessLogging", + "documentation": "If set to LOG, log each output's audio track loudness to a CSV file." + }, + "PeakCalculation": { + "shape": "AudioNormalizationPeakCalculation", + "locationName": "peakCalculation", + "documentation": "If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness." + }, + "TargetLkfs": { + "shape": "__doubleMinNegative59Max0", + "locationName": "targetLkfs", + "documentation": "When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS." + } + }, + "documentation": "Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard." + }, + "AudioSelector": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code" + }, + "DefaultSelection": { + "shape": "AudioDefaultSelection", + "locationName": "defaultSelection", + "documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio." + }, + "ExternalAudioFileInput": { + "shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", + "locationName": "externalAudioFileInput", + "documentation": "Specifies audio data from an external file source." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Selects a specific language code from within an audio source." + }, + "Offset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "offset", + "documentation": "Specifies a time delta in milliseconds to offset the audio from the input video." + }, + "Pids": { + "shape": "__listOf__integerMin1Max2147483647", + "locationName": "pids", + "documentation": "Selects a specific PID from within an audio source (e.g. 257 selects PID 0x101)." + }, + "ProgramSelection": { + "shape": "__integerMin0Max8", + "locationName": "programSelection", + "documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track." + }, + "RemixSettings": { + "shape": "RemixSettings", + "locationName": "remixSettings", + "documentation": "Use these settings to reorder the audio channels of one input to match those of another input. This allows you to combine the two files into a single output, one after the other." + }, + "SelectorType": { + "shape": "AudioSelectorType", + "locationName": "selectorType", + "documentation": "Specifies the type of the audio selector." + }, + "Tracks": { + "shape": "__listOf__integerMin1Max2147483647", + "locationName": "tracks", + "documentation": "Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type \"1,2,3\" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, \"tracks\": [1,2,3]." + } + }, + "documentation": "Selector for Audio" + }, + "AudioSelectorGroup": { + "type": "structure", + "members": { + "AudioSelectorNames": { + "shape": "__listOf__stringMin1", + "locationName": "audioSelectorNames", + "documentation": "Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., \"Audio Selector 1\"). The audio selector name parameter can be repeated to add any number of audio selectors to the group." + } + }, + "documentation": "Group of Audio Selectors" + }, + "AudioSelectorType": { + "type": "string", + "documentation": "Specifies the type of the audio selector.", + "enum": [ + "PID", + "TRACK", + "LANGUAGE_CODE" + ] + }, + "AudioTypeControl": { + "type": "string", + "documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "AvailBlanking": { + "type": "structure", + "members": { + "AvailBlankingImage": { + "shape": "__stringMin14PatternHttpHttpsS3BmpBMPPngPNG", + "locationName": "availBlankingImage", + "documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported." + } + }, + "documentation": "Settings for Avail Blanking" + }, + "BadRequestException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 400 + }, + "documentation": "The service can't process your request because of a problem in the request. Please check your request form and syntax." + }, + "BillingTagsSource": { + "type": "string", + "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "enum": [ + "QUEUE", + "PRESET", + "JOB_TEMPLATE", + "JOB" + ] + }, + "BurninDestinationSettings": { + "type": "structure", + "members": { + "Alignment": { + "shape": "BurninSubtitleAlignment", + "locationName": "alignment", + "documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundColor": { + "shape": "BurninSubtitleBackgroundColor", + "locationName": "backgroundColor", + "documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match." + }, + "BackgroundOpacity": { + "shape": "__integerMin0Max255", + "locationName": "backgroundOpacity", + "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "FontColor": { + "shape": "BurninSubtitleFontColor", + "locationName": "fontColor", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "FontOpacity": { + "shape": "__integerMin0Max255", + "locationName": "fontOpacity", + "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match." + }, + "FontResolution": { + "shape": "__integerMin96Max600", + "locationName": "fontResolution", + "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match." + }, + "FontScript": { + "shape": "FontScript", + "locationName": "fontScript", + "documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions." + }, + "FontSize": { + "shape": "__integerMin0Max96", + "locationName": "fontSize", + "documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match." + }, + "OutlineColor": { + "shape": "BurninSubtitleOutlineColor", + "locationName": "outlineColor", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "OutlineSize": { + "shape": "__integerMin0Max10", + "locationName": "outlineSize", + "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "ShadowColor": { + "shape": "BurninSubtitleShadowColor", + "locationName": "shadowColor", + "documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match." + }, + "ShadowOpacity": { + "shape": "__integerMin0Max255", + "locationName": "shadowOpacity", + "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "ShadowXOffset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "shadowXOffset", + "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match." + }, + "ShadowYOffset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "shadowYOffset", + "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match." + }, + "TeletextSpacing": { + "shape": "BurninSubtitleTeletextSpacing", + "locationName": "teletextSpacing", + "documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption." + }, + "XPosition": { + "shape": "__integerMin0Max2147483647", + "locationName": "xPosition", + "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "YPosition": { + "shape": "__integerMin0Max2147483647", + "locationName": "yPosition", + "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + } + }, + "documentation": "Burn-In Destination Settings." + }, + "BurninSubtitleAlignment": { + "type": "string", + "documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "CENTERED", + "LEFT" + ] + }, + "BurninSubtitleBackgroundColor": { + "type": "string", + "documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "enum": [ + "NONE", + "BLACK", + "WHITE" + ] + }, + "BurninSubtitleFontColor": { + "type": "string", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "WHITE", + "BLACK", + "YELLOW", + "RED", + "GREEN", + "BLUE" + ] + }, + "BurninSubtitleOutlineColor": { + "type": "string", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "BLACK", + "WHITE", + "YELLOW", + "RED", + "GREEN", + "BLUE" + ] + }, + "BurninSubtitleShadowColor": { + "type": "string", + "documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "enum": [ + "NONE", + "BLACK", + "WHITE" + ] + }, + "BurninSubtitleTeletextSpacing": { + "type": "string", + "documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "enum": [ + "FIXED_GRID", + "PROPORTIONAL" + ] + }, + "CancelJobRequest": { + "type": "structure", + "members": { + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The Job ID of the job to be cancelled.", + "location": "uri" + } + }, + "required": [ + "Id" + ] + }, + "CancelJobResponse": { + "type": "structure", + "members": { + } + }, + "CaptionDescription": { + "type": "structure", + "members": { + "CaptionSelectorName": { + "shape": "__stringMin1", + "locationName": "captionSelectorName", + "documentation": "Specifies which \"Caption Selector\":#inputs-caption_selector to use from each input when generating captions. The name should be of the format \"Caption Selector \", which denotes that the Nth Caption Selector will be used from each input." + }, + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text." + }, + "DestinationSettings": { + "shape": "CaptionDestinationSettings", + "locationName": "destinationSettings", + "documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text." + }, + "LanguageDescription": { + "shape": "__string", + "locationName": "languageDescription", + "documentation": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting." + } + }, + "documentation": "Description of Caption output" + }, + "CaptionDescriptionPreset": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "Indicates the language of the caption output track, using the ISO 639-2 or ISO 639-3 three-letter language code. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text." + }, + "DestinationSettings": { + "shape": "CaptionDestinationSettings", + "locationName": "destinationSettings", + "documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text." + }, + "LanguageDescription": { + "shape": "__string", + "locationName": "languageDescription", + "documentation": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting." + } + }, + "documentation": "Caption Description for preset" + }, + "CaptionDestinationSettings": { + "type": "structure", + "members": { + "BurninDestinationSettings": { + "shape": "BurninDestinationSettings", + "locationName": "burninDestinationSettings", + "documentation": "Burn-In Destination Settings." + }, + "DestinationType": { + "shape": "CaptionDestinationType", + "locationName": "destinationType", + "documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20)." + }, + "DvbSubDestinationSettings": { + "shape": "DvbSubDestinationSettings", + "locationName": "dvbSubDestinationSettings", + "documentation": "DVB-Sub Destination Settings" + }, + "EmbeddedDestinationSettings": { + "shape": "EmbeddedDestinationSettings", + "locationName": "embeddedDestinationSettings", + "documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number." + }, + "ImscDestinationSettings": { + "shape": "ImscDestinationSettings", + "locationName": "imscDestinationSettings", + "documentation": "Settings specific to IMSC caption outputs." + }, + "SccDestinationSettings": { + "shape": "SccDestinationSettings", + "locationName": "sccDestinationSettings", + "documentation": "Settings for SCC caption output." + }, + "TeletextDestinationSettings": { + "shape": "TeletextDestinationSettings", + "locationName": "teletextDestinationSettings", + "documentation": "Settings for Teletext caption output" + }, + "TtmlDestinationSettings": { + "shape": "TtmlDestinationSettings", + "locationName": "ttmlDestinationSettings", + "documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough)." + } + }, + "documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext." + }, + "CaptionDestinationType": { + "type": "string", + "documentation": "Specify the format for this set of captions on this output. The default format is embedded without SCTE-20. Other options are embedded with SCTE-20, burn-in, DVB-sub, IMSC, SCC, SRT, teletext, TTML, and web-VTT. If you are using SCTE-20, choose SCTE-20 plus embedded (SCTE20_PLUS_EMBEDDED) to create an output that complies with the SCTE-43 spec. To create a non-compliant output where the embedded captions come first, choose Embedded plus SCTE-20 (EMBEDDED_PLUS_SCTE20).", + "enum": [ + "BURN_IN", + "DVB_SUB", + "EMBEDDED", + "EMBEDDED_PLUS_SCTE20", + "IMSC", + "SCTE20_PLUS_EMBEDDED", + "SCC", + "SRT", + "SMI", + "TELETEXT", + "TTML", + "WEBVTT" + ] + }, + "CaptionSelector": { + "type": "structure", + "members": { + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "The specific language to extract from source, using the ISO 639-2 or ISO 639-3 three-letter language code. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions." + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions." + }, + "SourceSettings": { + "shape": "CaptionSourceSettings", + "locationName": "sourceSettings", + "documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." + } + }, + "documentation": "Set up captions in your outputs by first selecting them from your input here." + }, + "CaptionSourceSettings": { + "type": "structure", + "members": { + "AncillarySourceSettings": { + "shape": "AncillarySourceSettings", + "locationName": "ancillarySourceSettings", + "documentation": "Settings for ancillary captions source." + }, + "DvbSubSourceSettings": { + "shape": "DvbSubSourceSettings", + "locationName": "dvbSubSourceSettings", + "documentation": "DVB Sub Source Settings" + }, + "EmbeddedSourceSettings": { + "shape": "EmbeddedSourceSettings", + "locationName": "embeddedSourceSettings", + "documentation": "Settings for embedded captions Source" + }, + "FileSourceSettings": { + "shape": "FileSourceSettings", + "locationName": "fileSourceSettings", + "documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." + }, + "SourceType": { + "shape": "CaptionSourceType", + "locationName": "sourceType", + "documentation": "Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format." + }, + "TeletextSourceSettings": { + "shape": "TeletextSourceSettings", + "locationName": "teletextSourceSettings", + "documentation": "Settings specific to Teletext caption sources, including Page number." + }, + "TrackSourceSettings": { + "shape": "TrackSourceSettings", + "locationName": "trackSourceSettings", + "documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings." + } + }, + "documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." + }, + "CaptionSourceType": { + "type": "string", + "documentation": "Use Source (SourceType) to identify the format of your input captions. The service cannot auto-detect caption format.", + "enum": [ + "ANCILLARY", + "DVB_SUB", + "EMBEDDED", + "SCTE20", + "SCC", + "TTML", + "STL", + "SRT", + "SMI", + "TELETEXT", + "NULL_SOURCE", + "IMSC" + ] + }, + "ChannelMapping": { + "type": "structure", + "members": { + "OutputChannels": { + "shape": "__listOfOutputChannelMapping", + "locationName": "outputChannels", + "documentation": "List of output channels" + } + }, + "documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification)." + }, + "CmafClientCache": { + "type": "string", + "documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "CmafCodecSpecification": { + "type": "string", + "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "enum": [ + "RFC_6381", + "RFC_4281" + ] + }, + "CmafEncryptionSettings": { + "type": "structure", + "members": { + "ConstantInitializationVector": { + "shape": "__stringMin32Max32Pattern09aFAF32", + "locationName": "constantInitializationVector", + "documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default." + }, + "EncryptionMethod": { + "shape": "CmafEncryptionType", + "locationName": "encryptionMethod", + "documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR)." + }, + "InitializationVectorInManifest": { + "shape": "CmafInitializationVectorInManifest", + "locationName": "initializationVectorInManifest", + "documentation": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests." + }, + "SpekeKeyProvider": { + "shape": "SpekeKeyProviderCmaf", + "locationName": "spekeKeyProvider", + "documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead." + }, + "StaticKeyProvider": { + "shape": "StaticKeyProvider", + "locationName": "staticKeyProvider", + "documentation": "Use these settings to set up encryption with a static key provider." + }, + "Type": { + "shape": "CmafKeyProviderType", + "locationName": "type", + "documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html." + } + }, + "documentation": "Settings for CMAF encryption" + }, + "CmafEncryptionType": { + "type": "string", + "documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).", + "enum": [ + "SAMPLE_AES", + "AES_CTR" + ] + }, + "CmafGroupSettings": { + "type": "structure", + "members": { + "BaseUrl": { + "shape": "__string", + "locationName": "baseUrl", + "documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file." + }, + "ClientCache": { + "shape": "CmafClientCache", + "locationName": "clientCache", + "documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay." + }, + "CodecSpecification": { + "shape": "CmafCodecSpecification", + "locationName": "codecSpecification", + "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation." + }, + "Destination": { + "shape": "__stringPatternS3", + "locationName": "destination", + "documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file." + }, + "DestinationSettings": { + "shape": "DestinationSettings", + "locationName": "destinationSettings", + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + }, + "Encryption": { + "shape": "CmafEncryptionSettings", + "locationName": "encryption", + "documentation": "DRM settings." + }, + "FragmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "fragmentLength", + "documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types." + }, + "ManifestCompression": { + "shape": "CmafManifestCompression", + "locationName": "manifestCompression", + "documentation": "When set to GZIP, compresses HLS playlist." + }, + "ManifestDurationFormat": { + "shape": "CmafManifestDurationFormat", + "locationName": "manifestDurationFormat", + "documentation": "Indicates whether the output manifest should use floating point values for segment duration." + }, + "MinBufferTime": { + "shape": "__integerMin0Max2147483647", + "locationName": "minBufferTime", + "documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout." + }, + "MinFinalSegmentLength": { + "shape": "__doubleMin0Max2147483647", + "locationName": "minFinalSegmentLength", + "documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds." + }, + "MpdProfile": { + "shape": "CmafMpdProfile", + "locationName": "mpdProfile", + "documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE)." + }, + "SegmentControl": { + "shape": "CmafSegmentControl", + "locationName": "segmentControl", + "documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created." + }, + "SegmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "segmentLength", + "documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment." + }, + "StreamInfResolution": { + "shape": "CmafStreamInfResolution", + "locationName": "streamInfResolution", + "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest." + }, + "WriteDashManifest": { + "shape": "CmafWriteDASHManifest", + "locationName": "writeDashManifest", + "documentation": "When set to ENABLED, a DASH MPD manifest will be generated for this output." + }, + "WriteHlsManifest": { + "shape": "CmafWriteHLSManifest", + "locationName": "writeHlsManifest", + "documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output." + } + }, + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output." + }, + "CmafInitializationVectorInManifest": { + "type": "string", + "documentation": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "CmafKeyProviderType": { + "type": "string", + "documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", + "enum": [ + "SPEKE", + "STATIC_KEY" + ] + }, + "CmafManifestCompression": { + "type": "string", + "documentation": "When set to GZIP, compresses HLS playlist.", + "enum": [ + "GZIP", + "NONE" + ] + }, + "CmafManifestDurationFormat": { + "type": "string", + "documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "enum": [ + "FLOATING_POINT", + "INTEGER" + ] + }, + "CmafMpdProfile": { + "type": "string", + "documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", + "enum": [ + "MAIN_PROFILE", + "ON_DEMAND_PROFILE" + ] + }, + "CmafSegmentControl": { + "type": "string", + "documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", + "enum": [ + "SINGLE_FILE", + "SEGMENTED_FILES" + ] + }, + "CmafStreamInfResolution": { + "type": "string", + "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "CmafWriteDASHManifest": { + "type": "string", + "documentation": "When set to ENABLED, a DASH MPD manifest will be generated for this output.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "CmafWriteHLSManifest": { + "type": "string", + "documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "ColorCorrector": { + "type": "structure", + "members": { + "Brightness": { + "shape": "__integerMin1Max100", + "locationName": "brightness", + "documentation": "Brightness level." + }, + "ColorSpaceConversion": { + "shape": "ColorSpaceConversion", + "locationName": "colorSpaceConversion", + "documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output." + }, + "Contrast": { + "shape": "__integerMin1Max100", + "locationName": "contrast", + "documentation": "Contrast level." + }, + "Hdr10Metadata": { + "shape": "Hdr10Metadata", + "locationName": "hdr10Metadata", + "documentation": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr." + }, + "Hue": { + "shape": "__integerMinNegative180Max180", + "locationName": "hue", + "documentation": "Hue in degrees." + }, + "Saturation": { + "shape": "__integerMin1Max100", + "locationName": "saturation", + "documentation": "Saturation level." + } + }, + "documentation": "Settings for color correction." + }, + "ColorMetadata": { + "type": "string", + "documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.", + "enum": [ + "IGNORE", + "INSERT" + ] + }, + "ColorSpace": { + "type": "string", + "documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "enum": [ + "FOLLOW", + "REC_601", + "REC_709", + "HDR10", + "HLG_2020" + ] + }, + "ColorSpaceConversion": { + "type": "string", + "documentation": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.", + "enum": [ + "NONE", + "FORCE_601", + "FORCE_709", + "FORCE_HDR10", + "FORCE_HLG_2020" + ] + }, + "ColorSpaceUsage": { + "type": "string", + "documentation": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings.", + "enum": [ + "FORCE", + "FALLBACK" + ] + }, + "Commitment": { + "type": "string", + "documentation": "The length of the term of your reserved queue pricing plan commitment.", + "enum": [ + "ONE_YEAR" + ] + }, + "ConflictException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 409 + }, + "documentation": "The service couldn't complete your request because there is a conflict with the current state of the resource." + }, + "ContainerSettings": { + "type": "structure", + "members": { + "Container": { + "shape": "ContainerType", + "locationName": "container", + "documentation": "Container for this output. Some containers require a container settings object. If not specified, the default object will be created." + }, + "F4vSettings": { + "shape": "F4vSettings", + "locationName": "f4vSettings", + "documentation": "Settings for F4v container" + }, + "M2tsSettings": { + "shape": "M2tsSettings", + "locationName": "m2tsSettings", + "documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset." + }, + "M3u8Settings": { + "shape": "M3u8Settings", + "locationName": "m3u8Settings", + "documentation": "Settings for TS segments in HLS" + }, + "MovSettings": { + "shape": "MovSettings", + "locationName": "movSettings", + "documentation": "Settings for MOV Container." + }, + "Mp4Settings": { + "shape": "Mp4Settings", + "locationName": "mp4Settings", + "documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container." + } + }, + "documentation": "Container specific settings." + }, + "ContainerType": { + "type": "string", + "documentation": "Container for this output. Some containers require a container settings object. If not specified, the default object will be created.", + "enum": [ + "F4V", + "ISMV", + "M2TS", + "M3U8", + "CMFC", + "MOV", + "MP4", + "MPD", + "MXF", + "RAW" + ] + }, + "CreateJobRequest": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "AccelerationSettings", + "locationName": "accelerationSettings", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide." + }, + "BillingTagsSource": { + "shape": "BillingTagsSource", + "locationName": "billingTagsSource", + "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted." + }, + "ClientRequestToken": { + "shape": "__string", + "locationName": "clientRequestToken", + "documentation": "Idempotency token for CreateJob operation.", + "idempotencyToken": true + }, + "JobTemplate": { + "shape": "__string", + "locationName": "jobTemplate", + "documentation": "When you create a job, you can either specify a job template or specify the transcoding settings individually" + }, + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html." + }, + "Role": { + "shape": "__string", + "locationName": "role", + "documentation": "Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html." + }, + "Settings": { + "shape": "JobSettings", + "locationName": "settings", + "documentation": "JobSettings contains all the transcode settings for a job." + }, + "SimulateReservedQueue": { + "shape": "SimulateReservedQueue", + "locationName": "simulateReservedQueue", + "documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default." + }, + "StatusUpdateInterval": { + "shape": "StatusUpdateInterval", + "locationName": "statusUpdateInterval", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + }, + "UserMetadata": { + "shape": "__mapOf__string", + "locationName": "userMetadata", + "documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs." + } + }, + "required": [ + "Role", + "Settings" + ] + }, + "CreateJobResponse": { + "type": "structure", + "members": { + "Job": { + "shape": "Job", + "locationName": "job", + "documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + } + } + }, + "CreateJobTemplateRequest": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "AccelerationSettings", + "locationName": "accelerationSettings", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide." + }, + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "Optional. A category for the job template you are creating" + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "Optional. A description of the job template you are creating." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the job template you are creating." + }, + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue." + }, + "Settings": { + "shape": "JobTemplateSettings", + "locationName": "settings", + "documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it." + }, + "StatusUpdateInterval": { + "shape": "StatusUpdateInterval", + "locationName": "statusUpdateInterval", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "CreateJobTemplateResponse": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "JobTemplate", + "locationName": "jobTemplate", + "documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job." + } + } + }, + "CreatePresetRequest": { + "type": "structure", + "members": { + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "Optional. A category for the preset you are creating." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "Optional. A description of the preset you are creating." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the preset you are creating." + }, + "Settings": { + "shape": "PresetSettings", + "locationName": "settings", + "documentation": "Settings for preset" + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + } + }, + "required": [ + "Settings", + "Name" + ] + }, + "CreatePresetResponse": { + "type": "structure", + "members": { + "Preset": { + "shape": "Preset", + "locationName": "preset", + "documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process." + } + } + }, + "CreateQueueRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "Optional. A description of the queue that you are creating." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the queue that you are creating." + }, + "PricingPlan": { + "shape": "PricingPlan", + "locationName": "pricingPlan", + "documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment. When you use the API to create a queue, the default is on-demand." + }, + "ReservationPlanSettings": { + "shape": "ReservationPlanSettings", + "locationName": "reservationPlanSettings", + "documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues." + }, + "Status": { + "shape": "QueueStatus", + "locationName": "status", + "documentation": "Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + } + }, + "required": [ + "Name" + ] + }, + "CreateQueueResponse": { + "type": "structure", + "members": { + "Queue": { + "shape": "Queue", + "locationName": "queue", + "documentation": "You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html." + } + } + }, + "DashIsoEncryptionSettings": { + "type": "structure", + "members": { + "PlaybackDeviceCompatibility": { + "shape": "DashIsoPlaybackDeviceCompatibility", + "locationName": "playbackDeviceCompatibility", + "documentation": "This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted." + }, + "SpekeKeyProvider": { + "shape": "SpekeKeyProvider", + "locationName": "spekeKeyProvider", + "documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead." + } + }, + "documentation": "Specifies DRM settings for DASH outputs." + }, + "DashIsoGroupSettings": { + "type": "structure", + "members": { + "BaseUrl": { + "shape": "__string", + "locationName": "baseUrl", + "documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file." + }, + "Destination": { + "shape": "__stringPatternS3", + "locationName": "destination", + "documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file." + }, + "DestinationSettings": { + "shape": "DestinationSettings", + "locationName": "destinationSettings", + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + }, + "Encryption": { + "shape": "DashIsoEncryptionSettings", + "locationName": "encryption", + "documentation": "DRM settings." + }, + "FragmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "fragmentLength", + "documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types." + }, + "HbbtvCompliance": { + "shape": "DashIsoHbbtvCompliance", + "locationName": "hbbtvCompliance", + "documentation": "Supports HbbTV specification as indicated" + }, + "MinBufferTime": { + "shape": "__integerMin0Max2147483647", + "locationName": "minBufferTime", + "documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout." + }, + "MpdProfile": { + "shape": "DashIsoMpdProfile", + "locationName": "mpdProfile", + "documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE)." + }, + "SegmentControl": { + "shape": "DashIsoSegmentControl", + "locationName": "segmentControl", + "documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created." + }, + "SegmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "segmentLength", + "documentation": "Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types." + }, + "WriteSegmentTimelineInRepresentation": { + "shape": "DashIsoWriteSegmentTimelineInRepresentation", + "locationName": "writeSegmentTimelineInRepresentation", + "documentation": "If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest." + } + }, + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS." + }, + "DashIsoHbbtvCompliance": { + "type": "string", + "documentation": "Supports HbbTV specification as indicated", + "enum": [ + "HBBTV_1_5", + "NONE" + ] + }, + "DashIsoMpdProfile": { + "type": "string", + "documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", + "enum": [ + "MAIN_PROFILE", + "ON_DEMAND_PROFILE" + ] + }, + "DashIsoPlaybackDeviceCompatibility": { + "type": "string", + "documentation": "This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted.", + "enum": [ + "CENC_V1", + "UNENCRYPTED_SEI" + ] + }, + "DashIsoSegmentControl": { + "type": "string", + "documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", + "enum": [ + "SINGLE_FILE", + "SEGMENTED_FILES" + ] + }, + "DashIsoWriteSegmentTimelineInRepresentation": { + "type": "string", + "documentation": "When you enable Precise segment duration in manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "DecryptionMode": { + "type": "string", + "documentation": "Specify the encryption mode that you used to encrypt your input files.", + "enum": [ + "AES_CTR", + "AES_CBC", + "AES_GCM" + ] + }, + "DeinterlaceAlgorithm": { + "type": "string", + "documentation": "Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame.", + "enum": [ + "INTERPOLATE", + "INTERPOLATE_TICKER", + "BLEND", + "BLEND_TICKER" + ] + }, + "Deinterlacer": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "DeinterlaceAlgorithm", + "locationName": "algorithm", + "documentation": "Only applies when you set Deinterlacer (DeinterlaceMode) to Deinterlace (DEINTERLACE) or Adaptive (ADAPTIVE). Motion adaptive interpolate (INTERPOLATE) produces sharper pictures, while blend (BLEND) produces smoother motion. Use (INTERPOLATE_TICKER) OR (BLEND_TICKER) if your source file includes a ticker, such as a scrolling headline at the bottom of the frame." + }, + "Control": { + "shape": "DeinterlacerControl", + "locationName": "control", + "documentation": "- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video." + }, + "Mode": { + "shape": "DeinterlacerMode", + "locationName": "mode", + "documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive." + } + }, + "documentation": "Settings for deinterlacer" + }, + "DeinterlacerControl": { + "type": "string", + "documentation": "- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.", + "enum": [ + "FORCE_ALL_FRAMES", + "NORMAL" + ] + }, + "DeinterlacerMode": { + "type": "string", + "documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.", + "enum": [ + "DEINTERLACE", + "INVERSE_TELECINE", + "ADAPTIVE" + ] + }, + "DeleteJobTemplateRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the job template to be deleted.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "DeleteJobTemplateResponse": { + "type": "structure", + "members": { + } + }, + "DeletePresetRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the preset to be deleted.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "DeletePresetResponse": { + "type": "structure", + "members": { + } + }, + "DeleteQueueRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the queue that you want to delete.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "DeleteQueueResponse": { + "type": "structure", + "members": { + } + }, + "DescribeEndpointsMode": { + "type": "string", + "documentation": "Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.", + "enum": [ + "DEFAULT", + "GET_ONLY" + ] + }, + "DescribeEndpointsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "__integer", + "locationName": "maxResults", + "documentation": "Optional. Max number of endpoints, up to twenty, that will be returned at one time." + }, + "Mode": { + "shape": "DescribeEndpointsMode", + "locationName": "mode", + "documentation": "Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist." + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string, provided with the response to a previous request, to request the next batch of endpoints." + } + }, + "documentation": "DescribeEndpointsRequest" + }, + "DescribeEndpointsResponse": { + "type": "structure", + "members": { + "Endpoints": { + "shape": "__listOfEndpoint", + "locationName": "endpoints", + "documentation": "List of endpoints" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string to request the next batch of endpoints." + } + } + }, + "DestinationSettings": { + "type": "structure", + "members": { + "S3Settings": { + "shape": "S3DestinationSettings", + "locationName": "s3Settings", + "documentation": "Settings associated with S3 destination" + } + }, + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + }, + "DisassociateCertificateRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The ARN of the ACM certificate that you want to disassociate from your MediaConvert resource.", + "location": "uri" + } + }, + "required": [ + "Arn" + ] + }, + "DisassociateCertificateResponse": { + "type": "structure", + "members": { + } + }, + "DropFrameTimecode": { + "type": "string", + "documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "DvbNitSettings": { + "type": "structure", + "members": { + "NetworkId": { + "shape": "__integerMin0Max65535", + "locationName": "networkId", + "documentation": "The numeric value placed in the Network Information Table (NIT)." + }, + "NetworkName": { + "shape": "__stringMin1Max256", + "locationName": "networkName", + "documentation": "The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters." + }, + "NitInterval": { + "shape": "__integerMin25Max10000", + "locationName": "nitInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + } + }, + "documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval." + }, + "DvbSdtSettings": { + "type": "structure", + "members": { + "OutputSdt": { + "shape": "OutputSdt", + "locationName": "outputSdt", + "documentation": "Selects method of inserting SDT information into output stream. \"Follow input SDT\" copies SDT information from input stream to output stream. \"Follow input SDT if present\" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter \"SDT Manually\" means user will enter the SDT information. \"No SDT\" means output stream will not contain SDT information." + }, + "SdtInterval": { + "shape": "__integerMin25Max2000", + "locationName": "sdtInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + }, + "ServiceName": { + "shape": "__stringMin1Max256", + "locationName": "serviceName", + "documentation": "The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters." + }, + "ServiceProviderName": { + "shape": "__stringMin1Max256", + "locationName": "serviceProviderName", + "documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters." + } + }, + "documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval." + }, + "DvbSubDestinationSettings": { + "type": "structure", + "members": { + "Alignment": { + "shape": "DvbSubtitleAlignment", + "locationName": "alignment", + "documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundColor": { + "shape": "DvbSubtitleBackgroundColor", + "locationName": "backgroundColor", + "documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match." + }, + "BackgroundOpacity": { + "shape": "__integerMin0Max255", + "locationName": "backgroundOpacity", + "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "FontColor": { + "shape": "DvbSubtitleFontColor", + "locationName": "fontColor", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "FontOpacity": { + "shape": "__integerMin0Max255", + "locationName": "fontOpacity", + "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match." + }, + "FontResolution": { + "shape": "__integerMin96Max600", + "locationName": "fontResolution", + "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match." + }, + "FontScript": { + "shape": "FontScript", + "locationName": "fontScript", + "documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions." + }, + "FontSize": { + "shape": "__integerMin0Max96", + "locationName": "fontSize", + "documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match." + }, + "OutlineColor": { + "shape": "DvbSubtitleOutlineColor", + "locationName": "outlineColor", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "OutlineSize": { + "shape": "__integerMin0Max10", + "locationName": "outlineSize", + "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "ShadowColor": { + "shape": "DvbSubtitleShadowColor", + "locationName": "shadowColor", + "documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match." + }, + "ShadowOpacity": { + "shape": "__integerMin0Max255", + "locationName": "shadowOpacity", + "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "ShadowXOffset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "shadowXOffset", + "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match." + }, + "ShadowYOffset": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "shadowYOffset", + "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match." + }, + "TeletextSpacing": { + "shape": "DvbSubtitleTeletextSpacing", + "locationName": "teletextSpacing", + "documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption." + }, + "XPosition": { + "shape": "__integerMin0Max2147483647", + "locationName": "xPosition", + "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "YPosition": { + "shape": "__integerMin0Max2147483647", + "locationName": "yPosition", + "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + } + }, + "documentation": "DVB-Sub Destination Settings" + }, + "DvbSubSourceSettings": { + "type": "structure", + "members": { + "Pid": { + "shape": "__integerMin1Max2147483647", + "locationName": "pid", + "documentation": "When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors." + } + }, + "documentation": "DVB Sub Source Settings" + }, + "DvbSubtitleAlignment": { + "type": "string", + "documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "CENTERED", + "LEFT" + ] + }, + "DvbSubtitleBackgroundColor": { + "type": "string", + "documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "enum": [ + "NONE", + "BLACK", + "WHITE" + ] + }, + "DvbSubtitleFontColor": { + "type": "string", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "WHITE", + "BLACK", + "YELLOW", + "RED", + "GREEN", + "BLUE" + ] + }, + "DvbSubtitleOutlineColor": { + "type": "string", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "enum": [ + "BLACK", + "WHITE", + "YELLOW", + "RED", + "GREEN", + "BLUE" + ] + }, + "DvbSubtitleShadowColor": { + "type": "string", + "documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "enum": [ + "NONE", + "BLACK", + "WHITE" + ] + }, + "DvbSubtitleTeletextSpacing": { + "type": "string", + "documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "enum": [ + "FIXED_GRID", + "PROPORTIONAL" + ] + }, + "DvbTdtSettings": { + "type": "structure", + "members": { + "TdtInterval": { + "shape": "__integerMin1000Max30000", + "locationName": "tdtInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + } + }, + "documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval." + }, + "Eac3AtmosBitstreamMode": { + "type": "string", + "documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "enum": [ + "COMPLETE_MAIN" + ] + }, + "Eac3AtmosCodingMode": { + "type": "string", + "documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", + "enum": [ + "CODING_MODE_9_1_6" + ] + }, + "Eac3AtmosDialogueIntelligence": { + "type": "string", + "documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Eac3AtmosDynamicRangeCompressionLine": { + "type": "string", + "documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "enum": [ + "NONE", + "FILM_STANDARD", + "FILM_LIGHT", + "MUSIC_STANDARD", + "MUSIC_LIGHT", + "SPEECH" + ] + }, + "Eac3AtmosDynamicRangeCompressionRf": { + "type": "string", + "documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "enum": [ + "NONE", + "FILM_STANDARD", + "FILM_LIGHT", + "MUSIC_STANDARD", + "MUSIC_LIGHT", + "SPEECH" + ] + }, + "Eac3AtmosMeteringMode": { + "type": "string", + "documentation": "Choose how the service meters the loudness of your audio.", + "enum": [ + "LEQ_A", + "ITU_BS_1770_1", + "ITU_BS_1770_2", + "ITU_BS_1770_3", + "ITU_BS_1770_4" + ] + }, + "Eac3AtmosSettings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__integerMin384000Max768000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k" + }, + "BitstreamMode": { + "shape": "Eac3AtmosBitstreamMode", + "locationName": "bitstreamMode", + "documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E)." + }, + "CodingMode": { + "shape": "Eac3AtmosCodingMode", + "locationName": "codingMode", + "documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6)." + }, + "DialogueIntelligence": { + "shape": "Eac3AtmosDialogueIntelligence", + "locationName": "dialogueIntelligence", + "documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis." + }, + "DynamicRangeCompressionLine": { + "shape": "Eac3AtmosDynamicRangeCompressionLine", + "locationName": "dynamicRangeCompressionLine", + "documentation": "Specify the absolute peak level for a signal with dynamic range compression." + }, + "DynamicRangeCompressionRf": { + "shape": "Eac3AtmosDynamicRangeCompressionRf", + "locationName": "dynamicRangeCompressionRf", + "documentation": "Specify how the service limits the audio dynamic range when compressing the audio." + }, + "LoRoCenterMixLevel": { + "shape": "__doubleMinNegative6Max3", + "locationName": "loRoCenterMixLevel", + "documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0." + }, + "LoRoSurroundMixLevel": { + "shape": "__doubleMinNegative60MaxNegative1", + "locationName": "loRoSurroundMixLevel", + "documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel." + }, + "LtRtCenterMixLevel": { + "shape": "__doubleMinNegative6Max3", + "locationName": "ltRtCenterMixLevel", + "documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0." + }, + "LtRtSurroundMixLevel": { + "shape": "__doubleMinNegative60MaxNegative1", + "locationName": "ltRtSurroundMixLevel", + "documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel." + }, + "MeteringMode": { + "shape": "Eac3AtmosMeteringMode", + "locationName": "meteringMode", + "documentation": "Choose how the service meters the loudness of your audio." + }, + "SampleRate": { + "shape": "__integerMin48000Max48000", + "locationName": "sampleRate", + "documentation": "This value is always 48000. It represents the sample rate in Hz." + }, + "SpeechThreshold": { + "shape": "__integerMin1Max100", + "locationName": "speechThreshold", + "documentation": "Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness as the overall program loudness." + }, + "StereoDownmix": { + "shape": "Eac3AtmosStereoDownmix", + "locationName": "stereoDownmix", + "documentation": "Choose how the service does stereo downmixing." + }, + "SurroundExMode": { + "shape": "Eac3AtmosSurroundExMode", + "locationName": "surroundExMode", + "documentation": "Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS." + }, + "Eac3AtmosStereoDownmix": { + "type": "string", + "documentation": "Choose how the service does stereo downmixing.", + "enum": [ + "NOT_INDICATED", + "STEREO", + "SURROUND", + "DPL2" + ] + }, + "Eac3AtmosSurroundExMode": { + "type": "string", + "documentation": "Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.", + "enum": [ + "NOT_INDICATED", + "ENABLED", + "DISABLED" + ] + }, + "Eac3AttenuationControl": { + "type": "string", + "documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", + "enum": [ + "ATTENUATE_3_DB", + "NONE" + ] + }, + "Eac3BitstreamMode": { + "type": "string", + "documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "enum": [ + "COMPLETE_MAIN", + "COMMENTARY", + "EMERGENCY", + "HEARING_IMPAIRED", + "VISUALLY_IMPAIRED" + ] + }, + "Eac3CodingMode": { + "type": "string", + "documentation": "Dolby Digital Plus coding mode. Determines number of channels.", + "enum": [ + "CODING_MODE_1_0", + "CODING_MODE_2_0", + "CODING_MODE_3_2" + ] + }, + "Eac3DcFilter": { + "type": "string", + "documentation": "Activates a DC highpass filter for all input channels.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Eac3DynamicRangeCompressionLine": { + "type": "string", + "documentation": "Specify the absolute peak level for a signal with dynamic range compression.", + "enum": [ + "NONE", + "FILM_STANDARD", + "FILM_LIGHT", + "MUSIC_STANDARD", + "MUSIC_LIGHT", + "SPEECH" + ] + }, + "Eac3DynamicRangeCompressionRf": { + "type": "string", + "documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "enum": [ + "NONE", + "FILM_STANDARD", + "FILM_LIGHT", + "MUSIC_STANDARD", + "MUSIC_LIGHT", + "SPEECH" + ] + }, + "Eac3LfeControl": { + "type": "string", + "documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled", + "enum": [ + "LFE", + "NO_LFE" + ] + }, + "Eac3LfeFilter": { + "type": "string", + "documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Eac3MetadataControl": { + "type": "string", + "documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "Eac3PassthroughControl": { + "type": "string", + "documentation": "When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.", + "enum": [ + "WHEN_POSSIBLE", + "NO_PASSTHROUGH" + ] + }, + "Eac3PhaseControl": { + "type": "string", + "documentation": "Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode.", + "enum": [ + "SHIFT_90_DEGREES", + "NO_SHIFT" + ] + }, + "Eac3Settings": { + "type": "structure", + "members": { + "AttenuationControl": { + "shape": "Eac3AttenuationControl", + "locationName": "attenuationControl", + "documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode." + }, + "Bitrate": { + "shape": "__integerMin64000Max640000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode." + }, + "BitstreamMode": { + "shape": "Eac3BitstreamMode", + "locationName": "bitstreamMode", + "documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E)." + }, + "CodingMode": { + "shape": "Eac3CodingMode", + "locationName": "codingMode", + "documentation": "Dolby Digital Plus coding mode. Determines number of channels." + }, + "DcFilter": { + "shape": "Eac3DcFilter", + "locationName": "dcFilter", + "documentation": "Activates a DC highpass filter for all input channels." + }, + "Dialnorm": { + "shape": "__integerMin1Max31", + "locationName": "dialnorm", + "documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through." + }, + "DynamicRangeCompressionLine": { + "shape": "Eac3DynamicRangeCompressionLine", + "locationName": "dynamicRangeCompressionLine", + "documentation": "Specify the absolute peak level for a signal with dynamic range compression." + }, + "DynamicRangeCompressionRf": { + "shape": "Eac3DynamicRangeCompressionRf", + "locationName": "dynamicRangeCompressionRf", + "documentation": "Specify how the service limits the audio dynamic range when compressing the audio." + }, + "LfeControl": { + "shape": "Eac3LfeControl", + "locationName": "lfeControl", + "documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled" + }, + "LfeFilter": { + "shape": "Eac3LfeFilter", + "locationName": "lfeFilter", + "documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode." + }, + "LoRoCenterMixLevel": { + "shape": "__doubleMinNegative60Max3", + "locationName": "loRoCenterMixLevel", + "documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only center (loRoCenterMixLevel)." + }, + "LoRoSurroundMixLevel": { + "shape": "__doubleMinNegative60MaxNegative1", + "locationName": "loRoSurroundMixLevel", + "documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel)." + }, + "LtRtCenterMixLevel": { + "shape": "__doubleMinNegative60Max3", + "locationName": "ltRtCenterMixLevel", + "documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel)." + }, + "LtRtSurroundMixLevel": { + "shape": "__doubleMinNegative60MaxNegative1", + "locationName": "ltRtSurroundMixLevel", + "documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel)." + }, + "MetadataControl": { + "shape": "Eac3MetadataControl", + "locationName": "metadataControl", + "documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used." + }, + "PassthroughControl": { + "shape": "Eac3PassthroughControl", + "locationName": "passthroughControl", + "documentation": "When set to WHEN_POSSIBLE, input DD+ audio will be passed through if it is present on the input. this detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding." + }, + "PhaseControl": { + "shape": "Eac3PhaseControl", + "locationName": "phaseControl", + "documentation": "Controls the amount of phase-shift applied to the surround channels. Only used for 3/2 coding mode." + }, + "SampleRate": { + "shape": "__integerMin48000Max48000", + "locationName": "sampleRate", + "documentation": "This value is always 48000. It represents the sample rate in Hz." + }, + "StereoDownmix": { + "shape": "Eac3StereoDownmix", + "locationName": "stereoDownmix", + "documentation": "Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix)." + }, + "SurroundExMode": { + "shape": "Eac3SurroundExMode", + "locationName": "surroundExMode", + "documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels." + }, + "SurroundMode": { + "shape": "Eac3SurroundMode", + "locationName": "surroundMode", + "documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3." + }, + "Eac3StereoDownmix": { + "type": "string", + "documentation": "Choose how the service does stereo downmixing. This setting only applies if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Stereo downmix (Eac3StereoDownmix).", + "enum": [ + "NOT_INDICATED", + "LO_RO", + "LT_RT", + "DPL2" + ] + }, + "Eac3SurroundExMode": { + "type": "string", + "documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", + "enum": [ + "NOT_INDICATED", + "ENABLED", + "DISABLED" + ] + }, + "Eac3SurroundMode": { + "type": "string", + "documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", + "enum": [ + "NOT_INDICATED", + "ENABLED", + "DISABLED" + ] + }, + "EmbeddedConvert608To708": { + "type": "string", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", + "enum": [ + "UPCONVERT", + "DISABLED" + ] + }, + "EmbeddedDestinationSettings": { + "type": "structure", + "members": { + "Destination608ChannelNumber": { + "shape": "__integerMin1Max4", + "locationName": "destination608ChannelNumber", + "documentation": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded." + }, + "Destination708ServiceNumber": { + "shape": "__integerMin1Max6", + "locationName": "destination708ServiceNumber", + "documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded." + } + }, + "documentation": "Settings specific to embedded/ancillary caption outputs, including 608/708 Channel destination number." + }, + "EmbeddedSourceSettings": { + "type": "structure", + "members": { + "Convert608To708": { + "shape": "EmbeddedConvert608To708", + "locationName": "convert608To708", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708." + }, + "Source608ChannelNumber": { + "shape": "__integerMin1Max4", + "locationName": "source608ChannelNumber", + "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough." + }, + "Source608TrackNumber": { + "shape": "__integerMin1Max1", + "locationName": "source608TrackNumber", + "documentation": "Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'." + }, + "TerminateCaptions": { + "shape": "EmbeddedTerminateCaptions", + "locationName": "terminateCaptions", + "documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting." + } + }, + "documentation": "Settings for embedded captions Source" + }, + "EmbeddedTerminateCaptions": { + "type": "string", + "documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", + "enum": [ + "END_OF_INPUT", + "DISABLED" + ] + }, + "Endpoint": { + "type": "structure", + "members": { + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "URL of endpoint" + } + }, + "documentation": "Describes an account-specific API endpoint." + }, + "EsamManifestConfirmConditionNotification": { + "type": "structure", + "members": { + "MccXml": { + "shape": "__stringPatternSNManifestConfirmConditionNotificationNS", + "locationName": "mccXml", + "documentation": "Provide your ESAM ManifestConfirmConditionNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the Manifest Conditioning instructions in the message that you supply." + } + }, + "documentation": "ESAM ManifestConfirmConditionNotification defined by OC-SP-ESAM-API-I03-131025." + }, + "EsamSettings": { + "type": "structure", + "members": { + "ManifestConfirmConditionNotification": { + "shape": "EsamManifestConfirmConditionNotification", + "locationName": "manifestConfirmConditionNotification", + "documentation": "Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML (mccXml)." + }, + "ResponseSignalPreroll": { + "shape": "__integerMin0Max30000", + "locationName": "responseSignalPreroll", + "documentation": "Specifies the stream distance, in milliseconds, between the SCTE 35 messages that the transcoder places and the splice points that they refer to. If the time between the start of the asset and the SCTE-35 message is less than this value, then the transcoder places the SCTE-35 marker at the beginning of the stream." + }, + "SignalProcessingNotification": { + "shape": "EsamSignalProcessingNotification", + "locationName": "signalProcessingNotification", + "documentation": "Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML (sccXml)." + } + }, + "documentation": "Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings." + }, + "EsamSignalProcessingNotification": { + "type": "structure", + "members": { + "SccXml": { + "shape": "__stringPatternSNSignalProcessingNotificationNS", + "locationName": "sccXml", + "documentation": "Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that you supply. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. For your MPEG2-TS file outputs, if you want the service to place SCTE-35 markers at the insertion points you specify in the XML document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML document or enable SCTE-35 passthrough. You can't do both." + } + }, + "documentation": "ESAM SignalProcessingNotification data defined by OC-SP-ESAM-API-I03-131025." + }, + "ExceptionBody": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + } + }, + "F4vMoovPlacement": { + "type": "string", + "documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.", + "enum": [ + "PROGRESSIVE_DOWNLOAD", + "NORMAL" + ] + }, + "F4vSettings": { + "type": "structure", + "members": { + "MoovPlacement": { + "shape": "F4vMoovPlacement", + "locationName": "moovPlacement", + "documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end." + } + }, + "documentation": "Settings for F4v container" + }, + "FileGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "shape": "__stringPatternS3", + "locationName": "destination", + "documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file." + }, + "DestinationSettings": { + "shape": "DestinationSettings", + "locationName": "destinationSettings", + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + } + }, + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS." + }, + "FileSourceConvert608To708": { + "type": "string", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", + "enum": [ + "UPCONVERT", + "DISABLED" + ] + }, + "FileSourceSettings": { + "type": "structure", + "members": { + "Convert608To708": { + "shape": "FileSourceConvert608To708", + "locationName": "convert608To708", + "documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708." + }, + "SourceFile": { + "shape": "__stringMin14PatternHttpHttpsS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI", + "locationName": "sourceFile", + "documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'." + }, + "TimeDelta": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "timeDelta", + "documentation": "Specifies a time delta in seconds to offset the captions from the source file." + } + }, + "documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings." + }, + "FontScript": { + "type": "string", + "documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset.", + "enum": [ + "AUTOMATIC", + "HANS", + "HANT" + ] + }, + "ForbiddenException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 403 + }, + "documentation": "You don't have permissions for this action with the credentials you sent." + }, + "FrameCaptureSettings": { + "type": "structure", + "members": { + "FramerateDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateDenominator", + "documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateNumerator", + "documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places." + }, + "MaxCaptures": { + "shape": "__integerMin1Max10000000", + "locationName": "maxCaptures", + "documentation": "Maximum number of captures (encoded jpg output files)." + }, + "Quality": { + "shape": "__integerMin1Max100", + "locationName": "quality", + "documentation": "JPEG Quality - a higher value equals higher quality." + } + }, + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE." + }, + "GetJobRequest": { + "type": "structure", + "members": { + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "the job ID of the job.", + "location": "uri" + } + }, + "required": [ + "Id" + ] + }, + "GetJobResponse": { + "type": "structure", + "members": { + "Job": { + "shape": "Job", + "locationName": "job", + "documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + } + } + }, + "GetJobTemplateRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the job template.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "GetJobTemplateResponse": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "JobTemplate", + "locationName": "jobTemplate", + "documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job." + } + } + }, + "GetPresetRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the preset.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "GetPresetResponse": { + "type": "structure", + "members": { + "Preset": { + "shape": "Preset", + "locationName": "preset", + "documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process." + } + } + }, + "GetQueueRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the queue that you want information about.", + "location": "uri" + } + }, + "required": [ + "Name" + ] + }, + "GetQueueResponse": { + "type": "structure", + "members": { + "Queue": { + "shape": "Queue", + "locationName": "queue", + "documentation": "You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html." + } + } + }, + "H264AdaptiveQuantization": { + "type": "string", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "enum": [ + "OFF", + "LOW", + "MEDIUM", + "HIGH", + "HIGHER", + "MAX" + ] + }, + "H264CodecLevel": { + "type": "string", + "documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).", + "enum": [ + "AUTO", + "LEVEL_1", + "LEVEL_1_1", + "LEVEL_1_2", + "LEVEL_1_3", + "LEVEL_2", + "LEVEL_2_1", + "LEVEL_2_2", + "LEVEL_3", + "LEVEL_3_1", + "LEVEL_3_2", + "LEVEL_4", + "LEVEL_4_1", + "LEVEL_4_2", + "LEVEL_5", + "LEVEL_5_1", + "LEVEL_5_2" + ] + }, + "H264CodecProfile": { + "type": "string", + "documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.", + "enum": [ + "BASELINE", + "HIGH", + "HIGH_10BIT", + "HIGH_422", + "HIGH_422_10BIT", + "MAIN" + ] + }, + "H264DynamicSubGop": { + "type": "string", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "enum": [ + "ADAPTIVE", + "STATIC" + ] + }, + "H264EntropyEncoding": { + "type": "string", + "documentation": "Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC.", + "enum": [ + "CABAC", + "CAVLC" + ] + }, + "H264FieldEncoding": { + "type": "string", + "documentation": "Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs.", + "enum": [ + "PAFF", + "FORCE_FIELD" + ] + }, + "H264FlickerAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264FramerateControl": { + "type": "string", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H264FramerateConversionAlgorithm": { + "type": "string", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion.", + "enum": [ + "DUPLICATE_DROP", + "INTERPOLATE" + ] + }, + "H264GopBReference": { + "type": "string", + "documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264GopSizeUnits": { + "type": "string", + "documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "enum": [ + "FRAMES", + "SECONDS" + ] + }, + "H264InterlaceMode": { + "type": "string", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "enum": [ + "PROGRESSIVE", + "TOP_FIELD", + "BOTTOM_FIELD", + "FOLLOW_TOP_FIELD", + "FOLLOW_BOTTOM_FIELD" + ] + }, + "H264ParControl": { + "type": "string", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H264QualityTuningLevel": { + "type": "string", + "documentation": "Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.", + "enum": [ + "SINGLE_PASS", + "SINGLE_PASS_HQ", + "MULTI_PASS_HQ" + ] + }, + "H264QvbrSettings": { + "type": "structure", + "members": { + "MaxAverageBitrate": { + "shape": "__integerMin1000Max1152000000", + "locationName": "maxAverageBitrate", + "documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output." + }, + "QvbrQualityLevel": { + "shape": "__integerMin1Max10", + "locationName": "qvbrQualityLevel", + "documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9." + } + }, + "documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode." + }, + "H264RateControlMode": { + "type": "string", + "documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "enum": [ + "VBR", + "CBR", + "QVBR" + ] + }, + "H264RepeatPps": { + "type": "string", + "documentation": "Places a PPS header on each encoded picture, even if repeated.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264SceneChangeDetect": { + "type": "string", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "enum": [ + "DISABLED", + "ENABLED", + "TRANSITION_DETECTION" + ] + }, + "H264Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "shape": "H264AdaptiveQuantization", + "locationName": "adaptiveQuantization", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality." + }, + "Bitrate": { + "shape": "__integerMin1000Max1152000000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000." + }, + "CodecLevel": { + "shape": "H264CodecLevel", + "locationName": "codecLevel", + "documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO)." + }, + "CodecProfile": { + "shape": "H264CodecProfile", + "locationName": "codecProfile", + "documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License." + }, + "DynamicSubGop": { + "shape": "H264DynamicSubGop", + "locationName": "dynamicSubGop", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)." + }, + "EntropyEncoding": { + "shape": "H264EntropyEncoding", + "locationName": "entropyEncoding", + "documentation": "Entropy encoding mode. Use CABAC (must be in Main or High profile) or CAVLC." + }, + "FieldEncoding": { + "shape": "H264FieldEncoding", + "locationName": "fieldEncoding", + "documentation": "Choosing FORCE_FIELD disables PAFF encoding for interlaced outputs." + }, + "FlickerAdaptiveQuantization": { + "shape": "H264FlickerAdaptiveQuantization", + "locationName": "flickerAdaptiveQuantization", + "documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames." + }, + "FramerateControl": { + "shape": "H264FramerateControl", + "locationName": "framerateControl", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator." + }, + "FramerateConversionAlgorithm": { + "shape": "H264FramerateConversionAlgorithm", + "locationName": "framerateConversionAlgorithm", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateDenominator", + "documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateNumerator", + "documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps." + }, + "GopBReference": { + "shape": "H264GopBReference", + "locationName": "gopBReference", + "documentation": "If enable, use reference B frames for GOP structures that have B frames > 1." + }, + "GopClosedCadence": { + "shape": "__integerMin0Max2147483647", + "locationName": "gopClosedCadence", + "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." + }, + "GopSize": { + "shape": "__doubleMin0", + "locationName": "gopSize", + "documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero." + }, + "GopSizeUnits": { + "shape": "H264GopSizeUnits", + "locationName": "gopSizeUnits", + "documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time." + }, + "HrdBufferInitialFillPercentage": { + "shape": "__integerMin0Max100", + "locationName": "hrdBufferInitialFillPercentage", + "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)." + }, + "HrdBufferSize": { + "shape": "__integerMin0Max1152000000", + "locationName": "hrdBufferSize", + "documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000." + }, + "InterlaceMode": { + "shape": "H264InterlaceMode", + "locationName": "interlaceMode", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type, as follows.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose." + }, + "MaxBitrate": { + "shape": "__integerMin1000Max1152000000", + "locationName": "maxBitrate", + "documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR." + }, + "MinIInterval": { + "shape": "__integerMin0Max30", + "locationName": "minIInterval", + "documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1" + }, + "NumberBFramesBetweenReferenceFrames": { + "shape": "__integerMin0Max7", + "locationName": "numberBFramesBetweenReferenceFrames", + "documentation": "Number of B-frames between reference frames." + }, + "NumberReferenceFrames": { + "shape": "__integerMin1Max6", + "locationName": "numberReferenceFrames", + "documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding." + }, + "ParControl": { + "shape": "H264ParControl", + "locationName": "parControl", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio." + }, + "ParDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "QualityTuningLevel": { + "shape": "H264QualityTuningLevel", + "locationName": "qualityTuningLevel", + "documentation": "Use Quality tuning level (H264QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding." + }, + "QvbrSettings": { + "shape": "H264QvbrSettings", + "locationName": "qvbrSettings", + "documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode." + }, + "RateControlMode": { + "shape": "H264RateControlMode", + "locationName": "rateControlMode", + "documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR)." + }, + "RepeatPps": { + "shape": "H264RepeatPps", + "locationName": "repeatPps", + "documentation": "Places a PPS header on each encoded picture, even if repeated." + }, + "SceneChangeDetect": { + "shape": "H264SceneChangeDetect", + "locationName": "sceneChangeDetect", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr." + }, + "Slices": { + "shape": "__integerMin1Max32", + "locationName": "slices", + "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures." + }, + "SlowPal": { + "shape": "H264SlowPal", + "locationName": "slowPal", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly." + }, + "Softness": { + "shape": "__integerMin0Max128", + "locationName": "softness", + "documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image." + }, + "SpatialAdaptiveQuantization": { + "shape": "H264SpatialAdaptiveQuantization", + "locationName": "spatialAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity." + }, + "Syntax": { + "shape": "H264Syntax", + "locationName": "syntax", + "documentation": "Produces a bitstream compliant with SMPTE RP-2027." + }, + "Telecine": { + "shape": "H264Telecine", + "locationName": "telecine", + "documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i." + }, + "TemporalAdaptiveQuantization": { + "shape": "H264TemporalAdaptiveQuantization", + "locationName": "temporalAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity." + }, + "UnregisteredSeiTimecode": { + "shape": "H264UnregisteredSeiTimecode", + "locationName": "unregisteredSeiTimecode", + "documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message." + } + }, + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264." + }, + "H264SlowPal": { + "type": "string", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264SpatialAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264Syntax": { + "type": "string", + "documentation": "Produces a bitstream compliant with SMPTE RP-2027.", + "enum": [ + "DEFAULT", + "RP2027" + ] + }, + "H264Telecine": { + "type": "string", + "documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", + "enum": [ + "NONE", + "SOFT", + "HARD" + ] + }, + "H264TemporalAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264UnregisteredSeiTimecode": { + "type": "string", + "documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265AdaptiveQuantization": { + "type": "string", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "enum": [ + "OFF", + "LOW", + "MEDIUM", + "HIGH", + "HIGHER", + "MAX" + ] + }, + "H265AlternateTransferFunctionSei": { + "type": "string", + "documentation": "Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF).", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265CodecLevel": { + "type": "string", + "documentation": "H.265 Level.", + "enum": [ + "AUTO", + "LEVEL_1", + "LEVEL_2", + "LEVEL_2_1", + "LEVEL_3", + "LEVEL_3_1", + "LEVEL_4", + "LEVEL_4_1", + "LEVEL_5", + "LEVEL_5_1", + "LEVEL_5_2", + "LEVEL_6", + "LEVEL_6_1", + "LEVEL_6_2" + ] + }, + "H265CodecProfile": { + "type": "string", + "documentation": "Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so \"Main/High\" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License.", + "enum": [ + "MAIN_MAIN", + "MAIN_HIGH", + "MAIN10_MAIN", + "MAIN10_HIGH", + "MAIN_422_8BIT_MAIN", + "MAIN_422_8BIT_HIGH", + "MAIN_422_10BIT_MAIN", + "MAIN_422_10BIT_HIGH" + ] + }, + "H265DynamicSubGop": { + "type": "string", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "enum": [ + "ADAPTIVE", + "STATIC" + ] + }, + "H265FlickerAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265FramerateControl": { + "type": "string", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H265FramerateConversionAlgorithm": { + "type": "string", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion.", + "enum": [ + "DUPLICATE_DROP", + "INTERPOLATE" + ] + }, + "H265GopBReference": { + "type": "string", + "documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265GopSizeUnits": { + "type": "string", + "documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "enum": [ + "FRAMES", + "SECONDS" + ] + }, + "H265InterlaceMode": { + "type": "string", + "documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).", + "enum": [ + "PROGRESSIVE", + "TOP_FIELD", + "BOTTOM_FIELD", + "FOLLOW_TOP_FIELD", + "FOLLOW_BOTTOM_FIELD" + ] + }, + "H265ParControl": { + "type": "string", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H265QualityTuningLevel": { + "type": "string", + "documentation": "Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding.", + "enum": [ + "SINGLE_PASS", + "SINGLE_PASS_HQ", + "MULTI_PASS_HQ" + ] + }, + "H265QvbrSettings": { + "type": "structure", + "members": { + "MaxAverageBitrate": { + "shape": "__integerMin1000Max1466400000", + "locationName": "maxAverageBitrate", + "documentation": "Use this setting only when Rate control mode is QVBR and Quality tuning level is Multi-pass HQ. For Max average bitrate values suited to the complexity of your input video, the service limits the average bitrate of the video part of this output to the value that you choose. That is, the total size of the video element is less than or equal to the value you set multiplied by the number of seconds of encoded output." + }, + "QvbrQualityLevel": { + "shape": "__integerMin1Max10", + "locationName": "qvbrQualityLevel", + "documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9." + } + }, + "documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode." + }, + "H265RateControlMode": { + "type": "string", + "documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "enum": [ + "VBR", + "CBR", + "QVBR" + ] + }, + "H265SampleAdaptiveOffsetFilterMode": { + "type": "string", + "documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content", + "enum": [ + "DEFAULT", + "ADAPTIVE", + "OFF" + ] + }, + "H265SceneChangeDetect": { + "type": "string", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "enum": [ + "DISABLED", + "ENABLED", + "TRANSITION_DETECTION" + ] + }, + "H265Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "shape": "H265AdaptiveQuantization", + "locationName": "adaptiveQuantization", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality." + }, + "AlternateTransferFunctionSei": { + "shape": "H265AlternateTransferFunctionSei", + "locationName": "alternateTransferFunctionSei", + "documentation": "Enables Alternate Transfer Function SEI message for outputs using Hybrid Log Gamma (HLG) Electro-Optical Transfer Function (EOTF)." + }, + "Bitrate": { + "shape": "__integerMin1000Max1466400000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000." + }, + "CodecLevel": { + "shape": "H265CodecLevel", + "locationName": "codecLevel", + "documentation": "H.265 Level." + }, + "CodecProfile": { + "shape": "H265CodecProfile", + "locationName": "codecProfile", + "documentation": "Represents the Profile and Tier, per the HEVC (H.265) specification. Selections are grouped as [Profile] / [Tier], so \"Main/High\" represents Main Profile with High Tier. 4:2:2 profiles are only available with the HEVC 4:2:2 License." + }, + "DynamicSubGop": { + "shape": "H265DynamicSubGop", + "locationName": "dynamicSubGop", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)." + }, + "FlickerAdaptiveQuantization": { + "shape": "H265FlickerAdaptiveQuantization", + "locationName": "flickerAdaptiveQuantization", + "documentation": "Adjust quantization within each frame to reduce flicker or 'pop' on I-frames." + }, + "FramerateControl": { + "shape": "H265FramerateControl", + "locationName": "framerateControl", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator." + }, + "FramerateConversionAlgorithm": { + "shape": "H265FramerateConversionAlgorithm", + "locationName": "framerateConversionAlgorithm", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateDenominator", + "documentation": "Frame rate denominator." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateNumerator", + "documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps." + }, + "GopBReference": { + "shape": "H265GopBReference", + "locationName": "gopBReference", + "documentation": "If enable, use reference B frames for GOP structures that have B frames > 1." + }, + "GopClosedCadence": { + "shape": "__integerMin0Max2147483647", + "locationName": "gopClosedCadence", + "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." + }, + "GopSize": { + "shape": "__doubleMin0", + "locationName": "gopSize", + "documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero." + }, + "GopSizeUnits": { + "shape": "H265GopSizeUnits", + "locationName": "gopSizeUnits", + "documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time." + }, + "HrdBufferInitialFillPercentage": { + "shape": "__integerMin0Max100", + "locationName": "hrdBufferInitialFillPercentage", + "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)." + }, + "HrdBufferSize": { + "shape": "__integerMin0Max1466400000", + "locationName": "hrdBufferSize", + "documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000." + }, + "InterlaceMode": { + "shape": "H265InterlaceMode", + "locationName": "interlaceMode", + "documentation": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE)." + }, + "MaxBitrate": { + "shape": "__integerMin1000Max1466400000", + "locationName": "maxBitrate", + "documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR." + }, + "MinIInterval": { + "shape": "__integerMin0Max30", + "locationName": "minIInterval", + "documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1" + }, + "NumberBFramesBetweenReferenceFrames": { + "shape": "__integerMin0Max7", + "locationName": "numberBFramesBetweenReferenceFrames", + "documentation": "Number of B-frames between reference frames." + }, + "NumberReferenceFrames": { + "shape": "__integerMin1Max6", + "locationName": "numberReferenceFrames", + "documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding." + }, + "ParControl": { + "shape": "H265ParControl", + "locationName": "parControl", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio." + }, + "ParDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "QualityTuningLevel": { + "shape": "H265QualityTuningLevel", + "locationName": "qualityTuningLevel", + "documentation": "Use Quality tuning level (H265QualityTuningLevel) to specifiy whether to use fast single-pass, high-quality singlepass, or high-quality multipass video encoding." + }, + "QvbrSettings": { + "shape": "H265QvbrSettings", + "locationName": "qvbrSettings", + "documentation": "Settings for quality-defined variable bitrate encoding with the H.265 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode." + }, + "RateControlMode": { + "shape": "H265RateControlMode", + "locationName": "rateControlMode", + "documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR)." + }, + "SampleAdaptiveOffsetFilterMode": { + "shape": "H265SampleAdaptiveOffsetFilterMode", + "locationName": "sampleAdaptiveOffsetFilterMode", + "documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content" + }, + "SceneChangeDetect": { + "shape": "H265SceneChangeDetect", + "locationName": "sceneChangeDetect", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr." + }, + "Slices": { + "shape": "__integerMin1Max32", + "locationName": "slices", + "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures." + }, + "SlowPal": { + "shape": "H265SlowPal", + "locationName": "slowPal", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly." + }, + "SpatialAdaptiveQuantization": { + "shape": "H265SpatialAdaptiveQuantization", + "locationName": "spatialAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity." + }, + "Telecine": { + "shape": "H265Telecine", + "locationName": "telecine", + "documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i." + }, + "TemporalAdaptiveQuantization": { + "shape": "H265TemporalAdaptiveQuantization", + "locationName": "temporalAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity." + }, + "TemporalIds": { + "shape": "H265TemporalIds", + "locationName": "temporalIds", + "documentation": "Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output." + }, + "Tiles": { + "shape": "H265Tiles", + "locationName": "tiles", + "documentation": "Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures." + }, + "UnregisteredSeiTimecode": { + "shape": "H265UnregisteredSeiTimecode", + "locationName": "unregisteredSeiTimecode", + "documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message." + }, + "WriteMp4PackagingType": { + "shape": "H265WriteMp4PackagingType", + "locationName": "writeMp4PackagingType", + "documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting in your CMAF, DASH, or file MP4 output. For file MP4 outputs, choosing HVC1 can create video that doesn't work properly with some downstream systems and video players. Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples." + } + }, + "documentation": "Settings for H265 codec" + }, + "H265SlowPal": { + "type": "string", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265SpatialAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265Telecine": { + "type": "string", + "documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", + "enum": [ + "NONE", + "SOFT", + "HARD" + ] + }, + "H265TemporalAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265TemporalIds": { + "type": "string", + "documentation": "Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265Tiles": { + "type": "string", + "documentation": "Enable use of tiles, allowing horizontal as well as vertical subdivision of the encoded pictures.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265UnregisteredSeiTimecode": { + "type": "string", + "documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265WriteMp4PackagingType": { + "type": "string", + "documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting in your CMAF, DASH, or file MP4 output. For file MP4 outputs, choosing HVC1 can create video that doesn't work properly with some downstream systems and video players. Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.", + "enum": [ + "HVC1", + "HEV1" + ] + }, + "Hdr10Metadata": { + "type": "structure", + "members": { + "BluePrimaryX": { + "shape": "__integerMin0Max50000", + "locationName": "bluePrimaryX", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "BluePrimaryY": { + "shape": "__integerMin0Max50000", + "locationName": "bluePrimaryY", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "GreenPrimaryX": { + "shape": "__integerMin0Max50000", + "locationName": "greenPrimaryX", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "GreenPrimaryY": { + "shape": "__integerMin0Max50000", + "locationName": "greenPrimaryY", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "MaxContentLightLevel": { + "shape": "__integerMin0Max65535", + "locationName": "maxContentLightLevel", + "documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content." + }, + "MaxFrameAverageLightLevel": { + "shape": "__integerMin0Max65535", + "locationName": "maxFrameAverageLightLevel", + "documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content." + }, + "MaxLuminance": { + "shape": "__integerMin0Max2147483647", + "locationName": "maxLuminance", + "documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter." + }, + "MinLuminance": { + "shape": "__integerMin0Max2147483647", + "locationName": "minLuminance", + "documentation": "Nominal minimum mastering display luminance in units of of 0.0001 candelas per square meter" + }, + "RedPrimaryX": { + "shape": "__integerMin0Max50000", + "locationName": "redPrimaryX", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "RedPrimaryY": { + "shape": "__integerMin0Max50000", + "locationName": "redPrimaryY", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "WhitePointX": { + "shape": "__integerMin0Max50000", + "locationName": "whitePointX", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + }, + "WhitePointY": { + "shape": "__integerMin0Max50000", + "locationName": "whitePointY", + "documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction." + } + }, + "documentation": "Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator." + }, + "HlsAdMarkers": { + "type": "string", + "enum": [ + "ELEMENTAL", + "ELEMENTAL_SCTE35" + ] + }, + "HlsAudioOnlyContainer": { + "type": "string", + "documentation": "Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create a raw audio-only file with no container. Regardless of the value that you specify here, if this output has video, the service will place outputs into an MPEG2-TS container.", + "enum": [ + "AUTOMATIC", + "M2TS" + ] + }, + "HlsAudioTrackType": { + "type": "string", + "documentation": "Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO", + "enum": [ + "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT", + "ALTERNATE_AUDIO_AUTO_SELECT", + "ALTERNATE_AUDIO_NOT_AUTO_SELECT", + "AUDIO_ONLY_VARIANT_STREAM" + ] + }, + "HlsCaptionLanguageMapping": { + "type": "structure", + "members": { + "CaptionChannel": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "captionChannel", + "documentation": "Caption channel." + }, + "CustomLanguageCode": { + "shape": "__stringMin3Max3PatternAZaZ3", + "locationName": "customLanguageCode", + "documentation": "Specify the language for this caption channel, using the ISO 639-2 or ISO 639-3 three-letter language code" + }, + "LanguageCode": { + "shape": "LanguageCode", + "locationName": "languageCode", + "documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php." + }, + "LanguageDescription": { + "shape": "__string", + "locationName": "languageDescription", + "documentation": "Caption language description." + } + }, + "documentation": "Caption Language Mapping" + }, + "HlsCaptionLanguageSetting": { + "type": "string", + "documentation": "Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest.", + "enum": [ + "INSERT", + "OMIT", + "NONE" + ] + }, + "HlsClientCache": { + "type": "string", + "documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "HlsCodecSpecification": { + "type": "string", + "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "enum": [ + "RFC_6381", + "RFC_4281" + ] + }, + "HlsDirectoryStructure": { + "type": "string", + "documentation": "Indicates whether segments should be placed in subdirectories.", + "enum": [ + "SINGLE_DIRECTORY", + "SUBDIRECTORY_PER_STREAM" + ] + }, + "HlsEncryptionSettings": { + "type": "structure", + "members": { + "ConstantInitializationVector": { + "shape": "__stringMin32Max32Pattern09aFAF32", + "locationName": "constantInitializationVector", + "documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default." + }, + "EncryptionMethod": { + "shape": "HlsEncryptionType", + "locationName": "encryptionMethod", + "documentation": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption." + }, + "InitializationVectorInManifest": { + "shape": "HlsInitializationVectorInManifest", + "locationName": "initializationVectorInManifest", + "documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest." + }, + "OfflineEncrypted": { + "shape": "HlsOfflineEncrypted", + "locationName": "offlineEncrypted", + "documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection." + }, + "SpekeKeyProvider": { + "shape": "SpekeKeyProvider", + "locationName": "spekeKeyProvider", + "documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead." + }, + "StaticKeyProvider": { + "shape": "StaticKeyProvider", + "locationName": "staticKeyProvider", + "documentation": "Use these settings to set up encryption with a static key provider." + }, + "Type": { + "shape": "HlsKeyProviderType", + "locationName": "type", + "documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html." + } + }, + "documentation": "Settings for HLS encryption" + }, + "HlsEncryptionType": { + "type": "string", + "documentation": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.", + "enum": [ + "AES128", + "SAMPLE_AES" + ] + }, + "HlsGroupSettings": { + "type": "structure", + "members": { + "AdMarkers": { + "shape": "__listOfHlsAdMarkers", + "locationName": "adMarkers", + "documentation": "Choose one or more ad marker types to decorate your Apple HLS manifest. This setting does not determine whether SCTE-35 markers appear in the outputs themselves." + }, + "BaseUrl": { + "shape": "__string", + "locationName": "baseUrl", + "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file." + }, + "CaptionLanguageMappings": { + "shape": "__listOfHlsCaptionLanguageMapping", + "locationName": "captionLanguageMappings", + "documentation": "Language to be used on Caption outputs" + }, + "CaptionLanguageSetting": { + "shape": "HlsCaptionLanguageSetting", + "locationName": "captionLanguageSetting", + "documentation": "Applies only to 608 Embedded output captions. Insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. None: Include CLOSED-CAPTIONS=NONE line in the manifest. Omit: Omit any CLOSED-CAPTIONS line from the manifest." + }, + "ClientCache": { + "shape": "HlsClientCache", + "locationName": "clientCache", + "documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay." + }, + "CodecSpecification": { + "shape": "HlsCodecSpecification", + "locationName": "codecSpecification", + "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation." + }, + "Destination": { + "shape": "__stringPatternS3", + "locationName": "destination", + "documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file." + }, + "DestinationSettings": { + "shape": "DestinationSettings", + "locationName": "destinationSettings", + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + }, + "DirectoryStructure": { + "shape": "HlsDirectoryStructure", + "locationName": "directoryStructure", + "documentation": "Indicates whether segments should be placed in subdirectories." + }, + "Encryption": { + "shape": "HlsEncryptionSettings", + "locationName": "encryption", + "documentation": "DRM settings." + }, + "ManifestCompression": { + "shape": "HlsManifestCompression", + "locationName": "manifestCompression", + "documentation": "When set to GZIP, compresses HLS playlist." + }, + "ManifestDurationFormat": { + "shape": "HlsManifestDurationFormat", + "locationName": "manifestDurationFormat", + "documentation": "Indicates whether the output manifest should use floating point values for segment duration." + }, + "MinFinalSegmentLength": { + "shape": "__doubleMin0Max2147483647", + "locationName": "minFinalSegmentLength", + "documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds." + }, + "MinSegmentLength": { + "shape": "__integerMin0Max2147483647", + "locationName": "minSegmentLength", + "documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed." + }, + "OutputSelection": { + "shape": "HlsOutputSelection", + "locationName": "outputSelection", + "documentation": "Indicates whether the .m3u8 manifest file should be generated for this HLS output group." + }, + "ProgramDateTime": { + "shape": "HlsProgramDateTime", + "locationName": "programDateTime", + "documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset." + }, + "ProgramDateTimePeriod": { + "shape": "__integerMin0Max3600", + "locationName": "programDateTimePeriod", + "documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds." + }, + "SegmentControl": { + "shape": "HlsSegmentControl", + "locationName": "segmentControl", + "documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback." + }, + "SegmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "segmentLength", + "documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer." + }, + "SegmentsPerSubdirectory": { + "shape": "__integerMin1Max2147483647", + "locationName": "segmentsPerSubdirectory", + "documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be SINGLE_DIRECTORY for this setting to have an effect." + }, + "StreamInfResolution": { + "shape": "HlsStreamInfResolution", + "locationName": "streamInfResolution", + "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest." + }, + "TimedMetadataId3Frame": { + "shape": "HlsTimedMetadataId3Frame", + "locationName": "timedMetadataId3Frame", + "documentation": "Indicates ID3 frame that has the timecode." + }, + "TimedMetadataId3Period": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "timedMetadataId3Period", + "documentation": "Timed Metadata interval in seconds." + }, + "TimestampDeltaMilliseconds": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "timestampDeltaMilliseconds", + "documentation": "Provides an extra millisecond delta offset to fine tune the timestamps." + } + }, + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS." + }, + "HlsIFrameOnlyManifest": { + "type": "string", + "documentation": "When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "HlsInitializationVectorInManifest": { + "type": "string", + "documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "HlsKeyProviderType": { + "type": "string", + "documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", + "enum": [ + "SPEKE", + "STATIC_KEY" + ] + }, + "HlsManifestCompression": { + "type": "string", + "documentation": "When set to GZIP, compresses HLS playlist.", + "enum": [ + "GZIP", + "NONE" + ] + }, + "HlsManifestDurationFormat": { + "type": "string", + "documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "enum": [ + "FLOATING_POINT", + "INTEGER" + ] + }, + "HlsOfflineEncrypted": { + "type": "string", + "documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "HlsOutputSelection": { + "type": "string", + "documentation": "Indicates whether the .m3u8 manifest file should be generated for this HLS output group.", + "enum": [ + "MANIFESTS_AND_SEGMENTS", + "SEGMENTS_ONLY" + ] + }, + "HlsProgramDateTime": { + "type": "string", + "documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestamp_offset.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "HlsSegmentControl": { + "type": "string", + "documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.", + "enum": [ + "SINGLE_FILE", + "SEGMENTED_FILES" + ] + }, + "HlsSettings": { + "type": "structure", + "members": { + "AudioGroupId": { + "shape": "__string", + "locationName": "audioGroupId", + "documentation": "Specifies the group to which the audio Rendition belongs." + }, + "AudioOnlyContainer": { + "shape": "HlsAudioOnlyContainer", + "locationName": "audioOnlyContainer", + "documentation": "Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container." + }, + "AudioRenditionSets": { + "shape": "__string", + "locationName": "audioRenditionSets", + "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','." + }, + "AudioTrackType": { + "shape": "HlsAudioTrackType", + "locationName": "audioTrackType", + "documentation": "Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO" + }, + "IFrameOnlyManifest": { + "shape": "HlsIFrameOnlyManifest", + "locationName": "iFrameOnlyManifest", + "documentation": "When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest" + }, + "SegmentModifier": { + "shape": "__string", + "locationName": "segmentModifier", + "documentation": "String concatenated to end of segment filenames. Accepts \"Format Identifiers\":#format_identifier_parameters." + } + }, + "documentation": "Settings for HLS output groups" + }, + "HlsStreamInfResolution": { + "type": "string", + "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "HlsTimedMetadataId3Frame": { + "type": "string", + "documentation": "Indicates ID3 frame that has the timecode.", + "enum": [ + "NONE", + "PRIV", + "TDRL" + ] + }, + "Id3Insertion": { + "type": "structure", + "members": { + "Id3": { + "shape": "__stringPatternAZaZ0902", + "locationName": "id3", + "documentation": "Use ID3 tag (Id3) to provide a tag value in base64-encode format." + }, + "Timecode": { + "shape": "__stringPattern010920405090509092", + "locationName": "timecode", + "documentation": "Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format." + } + }, + "documentation": "To insert ID3 tags in your output, specify two values. Use ID3 tag (Id3) to specify the base 64 encoded string and use Timecode (TimeCode) to specify the time when the tag should be inserted. To insert multiple ID3 tags in your output, create multiple instances of ID3 insertion (Id3Insertion)." + }, + "ImageInserter": { + "type": "structure", + "members": { + "InsertableImages": { + "shape": "__listOfInsertableImage", + "locationName": "insertableImages", + "documentation": "Specify the images that you want to overlay on your video. The images must be PNG or TGA files." + } + }, + "documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input or output individually. This setting is disabled by default." + }, + "ImscDestinationSettings": { + "type": "structure", + "members": { + "StylePassthrough": { + "shape": "ImscStylePassthrough", + "locationName": "stylePassthrough", + "documentation": "Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions." + } + }, + "documentation": "Settings specific to IMSC caption outputs." + }, + "ImscStylePassthrough": { + "type": "string", + "documentation": "Keep this setting enabled to have MediaConvert use the font style and position information from the captions source in the output. This option is available only when your input captions are CFF-TT, IMSC, SMPTE-TT, or TTML. Disable this setting for simplified output captions.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Input": { + "type": "structure", + "members": { + "AudioSelectorGroups": { + "shape": "__mapOfAudioSelectorGroup", + "locationName": "audioSelectorGroups", + "documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information." + }, + "AudioSelectors": { + "shape": "__mapOfAudioSelector", + "locationName": "audioSelectors", + "documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input." + }, + "CaptionSelectors": { + "shape": "__mapOfCaptionSelector", + "locationName": "captionSelectors", + "documentation": "Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input." + }, + "Crop": { + "shape": "Rectangle", + "locationName": "crop", + "documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop)." + }, + "DeblockFilter": { + "shape": "InputDeblockFilter", + "locationName": "deblockFilter", + "documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs." + }, + "DecryptionSettings": { + "shape": "InputDecryptionSettings", + "locationName": "decryptionSettings", + "documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content." + }, + "DenoiseFilter": { + "shape": "InputDenoiseFilter", + "locationName": "denoiseFilter", + "documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs." + }, + "FileInput": { + "shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", + "locationName": "fileInput", + "documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL." + }, + "FilterEnable": { + "shape": "InputFilterEnable", + "locationName": "filterEnable", + "documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type." + }, + "FilterStrength": { + "shape": "__integerMinNegative5Max5", + "locationName": "filterStrength", + "documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0." + }, + "ImageInserter": { + "shape": "ImageInserter", + "locationName": "imageInserter", + "documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default." + }, + "InputClippings": { + "shape": "__listOfInputClipping", + "locationName": "inputClippings", + "documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them." + }, + "Position": { + "shape": "Rectangle", + "locationName": "position", + "documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior)." + }, + "ProgramNumber": { + "shape": "__integerMin1Max2147483647", + "locationName": "programNumber", + "documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default." + }, + "PsiControl": { + "shape": "InputPsiControl", + "locationName": "psiControl", + "documentation": "Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data." + }, + "SupplementalImps": { + "shape": "__listOf__stringPatternS3ASSETMAPXml", + "locationName": "supplementalImps", + "documentation": "Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it." + }, + "TimecodeSource": { + "shape": "InputTimecodeSource", + "locationName": "timecodeSource", + "documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode." + }, + "TimecodeStart": { + "shape": "__stringMin11Max11Pattern01D20305D205D", + "locationName": "timecodeStart", + "documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode." + }, + "VideoSelector": { + "shape": "VideoSelector", + "locationName": "videoSelector", + "documentation": "Selector for video." + } + }, + "documentation": "Specifies media input" + }, + "InputClipping": { + "type": "structure", + "members": { + "EndTimecode": { + "shape": "__stringPattern010920405090509092", + "locationName": "endTimecode", + "documentation": "Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00." + }, + "StartTimecode": { + "shape": "__stringPattern010920405090509092", + "locationName": "startTimecode", + "documentation": "Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00." + } + }, + "documentation": "To transcode only portions of your input (clips), include one Input clipping (one instance of InputClipping in the JSON job file) for each input clip. All input clips you specify will be included in every output of the job." + }, + "InputDeblockFilter": { + "type": "string", + "documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "InputDecryptionSettings": { + "type": "structure", + "members": { + "DecryptionMode": { + "shape": "DecryptionMode", + "locationName": "decryptionMode", + "documentation": "Specify the encryption mode that you used to encrypt your input files." + }, + "EncryptedDecryptionKey": { + "shape": "__stringMin24Max512PatternAZaZ0902", + "locationName": "encryptedDecryptionKey", + "documentation": "Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits." + }, + "InitializationVector": { + "shape": "__stringMin16Max24PatternAZaZ0922AZaZ0916", + "locationName": "initializationVector", + "documentation": "Specify the initialization vector that you used when you encrypted your content before uploading it to Amazon S3. You can use a 16-byte initialization vector with any encryption mode. Or, you can use a 12-byte initialization vector with GCM or CTR. MediaConvert accepts only initialization vectors that are base64-encoded." + }, + "KmsKeyRegion": { + "shape": "__stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912", + "locationName": "kmsKeyRegion", + "documentation": "Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert." + } + }, + "documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content." + }, + "InputDenoiseFilter": { + "type": "string", + "documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "InputFilterEnable": { + "type": "string", + "documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type.", + "enum": [ + "AUTO", + "DISABLE", + "FORCE" + ] + }, + "InputPsiControl": { + "type": "string", + "documentation": "Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.", + "enum": [ + "IGNORE_PSI", + "USE_PSI" + ] + }, + "InputRotate": { + "type": "string", + "documentation": "Use Rotate (InputRotate) to specify how the service rotates your video. You can choose automatic rotation or specify a rotation. You can specify a clockwise rotation of 0, 90, 180, or 270 degrees. If your input video container is .mov or .mp4 and your input has rotation metadata, you can choose Automatic to have the service rotate your video according to the rotation specified in the metadata. The rotation must be within one degree of 90, 180, or 270 degrees. If the rotation metadata specifies any other rotation, the service will default to no rotation. By default, the service does no rotation, even if your input video has rotation metadata. The service doesn't pass through rotation metadata.", + "enum": [ + "DEGREE_0", + "DEGREES_90", + "DEGREES_180", + "DEGREES_270", + "AUTO" + ] + }, + "InputTemplate": { + "type": "structure", + "members": { + "AudioSelectorGroups": { + "shape": "__mapOfAudioSelectorGroup", + "locationName": "audioSelectorGroups", + "documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information." + }, + "AudioSelectors": { + "shape": "__mapOfAudioSelector", + "locationName": "audioSelectors", + "documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use mutiple Audio selectors per input." + }, + "CaptionSelectors": { + "shape": "__mapOfCaptionSelector", + "locationName": "captionSelectors", + "documentation": "Use Captions selectors (CaptionSelectors) to specify the captions data from the input that you will use in your outputs. You can use mutiple captions selectors per input." + }, + "Crop": { + "shape": "Rectangle", + "locationName": "crop", + "documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop)." + }, + "DeblockFilter": { + "shape": "InputDeblockFilter", + "locationName": "deblockFilter", + "documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manaully controllable for MPEG2 and uncompressed video inputs." + }, + "DenoiseFilter": { + "shape": "InputDenoiseFilter", + "locationName": "denoiseFilter", + "documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs." + }, + "FilterEnable": { + "shape": "InputFilterEnable", + "locationName": "filterEnable", + "documentation": "Use Filter enable (InputFilterEnable) to specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The in put is filtered regardless of input type." + }, + "FilterStrength": { + "shape": "__integerMinNegative5Max5", + "locationName": "filterStrength", + "documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0." + }, + "ImageInserter": { + "shape": "ImageInserter", + "locationName": "imageInserter", + "documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default." + }, + "InputClippings": { + "shape": "__listOfInputClipping", + "locationName": "inputClippings", + "documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them." + }, + "Position": { + "shape": "Rectangle", + "locationName": "position", + "documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior)." + }, + "ProgramNumber": { + "shape": "__integerMin1Max2147483647", + "locationName": "programNumber", + "documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default." + }, + "PsiControl": { + "shape": "InputPsiControl", + "locationName": "psiControl", + "documentation": "Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data." + }, + "TimecodeSource": { + "shape": "InputTimecodeSource", + "locationName": "timecodeSource", + "documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode." + }, + "TimecodeStart": { + "shape": "__stringMin11Max11Pattern01D20305D205D", + "locationName": "timecodeStart", + "documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode." + }, + "VideoSelector": { + "shape": "VideoSelector", + "locationName": "videoSelector", + "documentation": "Selector for video." + } + }, + "documentation": "Specified video input in a template." + }, + "InputTimecodeSource": { + "type": "string", + "documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "enum": [ + "EMBEDDED", + "ZEROBASED", + "SPECIFIEDSTART" + ] + }, + "InsertableImage": { + "type": "structure", + "members": { + "Duration": { + "shape": "__integerMin0Max2147483647", + "locationName": "duration", + "documentation": "Specify the time, in milliseconds, for the image to remain on the output video. This duration includes fade-in time but not fade-out time." + }, + "FadeIn": { + "shape": "__integerMin0Max2147483647", + "locationName": "fadeIn", + "documentation": "Specify the length of time, in milliseconds, between the Start time that you specify for the image insertion and the time that the image appears at full opacity. Full opacity is the level that you specify for the opacity setting. If you don't specify a value for Fade-in, the image will appear abruptly at the overlay start time." + }, + "FadeOut": { + "shape": "__integerMin0Max2147483647", + "locationName": "fadeOut", + "documentation": "Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration." + }, + "Height": { + "shape": "__integerMin0Max2147483647", + "locationName": "height", + "documentation": "Specify the height of the inserted image in pixels. If you specify a value that's larger than the video resolution height, the service will crop your overlaid image to fit. To use the native height of the image, keep this setting blank." + }, + "ImageInserterInput": { + "shape": "__stringMin14PatternHttpHttpsS3BmpBMPPngPNGTgaTGA", + "locationName": "imageInserterInput", + "documentation": "Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file." + }, + "ImageX": { + "shape": "__integerMin0Max2147483647", + "locationName": "imageX", + "documentation": "Specify the distance, in pixels, between the inserted image and the left edge of the video frame. Required for any image overlay that you specify." + }, + "ImageY": { + "shape": "__integerMin0Max2147483647", + "locationName": "imageY", + "documentation": "Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify." + }, + "Layer": { + "shape": "__integerMin0Max99", + "locationName": "layer", + "documentation": "Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer." + }, + "Opacity": { + "shape": "__integerMin0Max100", + "locationName": "opacity", + "documentation": "Use Opacity (Opacity) to specify how much of the underlying video shows through the inserted image. 0 is transparent and 100 is fully opaque. Default is 50." + }, + "StartTime": { + "shape": "__stringPattern01D20305D205D", + "locationName": "startTime", + "documentation": "Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings." + }, + "Width": { + "shape": "__integerMin0Max2147483647", + "locationName": "width", + "documentation": "Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank." + } + }, + "documentation": "Settings that specify how your still graphic overlay appears." + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 500 + }, + "documentation": "The service encountered an unexpected condition and can't fulfill your request." + }, + "Job": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "AccelerationSettings", + "locationName": "accelerationSettings", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content." + }, + "AccelerationStatus": { + "shape": "AccelerationStatus", + "locationName": "accelerationStatus", + "documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED." + }, + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "An identifier for this resource that is unique within all of AWS." + }, + "BillingTagsSource": { + "shape": "BillingTagsSource", + "locationName": "billingTagsSource", + "documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted." + }, + "CreatedAt": { + "shape": "__timestampUnix", + "locationName": "createdAt", + "documentation": "The time, in Unix epoch format in seconds, when the job got created." + }, + "CurrentPhase": { + "shape": "JobPhase", + "locationName": "currentPhase", + "documentation": "A job's phase can be PROBING, TRANSCODING OR UPLOADING" + }, + "ErrorCode": { + "shape": "__integer", + "locationName": "errorCode", + "documentation": "Error code for the job" + }, + "ErrorMessage": { + "shape": "__string", + "locationName": "errorMessage", + "documentation": "Error message of Job" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "A portion of the job's ARN, unique within your AWS Elemental MediaConvert resources" + }, + "JobPercentComplete": { + "shape": "__integer", + "locationName": "jobPercentComplete", + "documentation": "An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value." + }, + "JobTemplate": { + "shape": "__string", + "locationName": "jobTemplate", + "documentation": "The job template that the job is created from, if it is created from a job template." + }, + "Messages": { + "shape": "JobMessages", + "locationName": "messages", + "documentation": "Provides messages from the service about jobs that you have already successfully submitted." + }, + "OutputGroupDetails": { + "shape": "__listOfOutputGroupDetail", + "locationName": "outputGroupDetails", + "documentation": "List of output group details" + }, + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Relative priority on the job." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html" + }, + "RetryCount": { + "shape": "__integer", + "locationName": "retryCount", + "documentation": "The number of times that the service automatically attempted to process your job after encountering an error." + }, + "Role": { + "shape": "__string", + "locationName": "role", + "documentation": "The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html" + }, + "Settings": { + "shape": "JobSettings", + "locationName": "settings", + "documentation": "JobSettings contains all the transcode settings for a job." + }, + "SimulateReservedQueue": { + "shape": "SimulateReservedQueue", + "locationName": "simulateReservedQueue", + "documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default." + }, + "Status": { + "shape": "JobStatus", + "locationName": "status", + "documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR." + }, + "StatusUpdateInterval": { + "shape": "StatusUpdateInterval", + "locationName": "statusUpdateInterval", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + }, + "Timing": { + "shape": "Timing", + "locationName": "timing", + "documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds." + }, + "UserMetadata": { + "shape": "__mapOf__string", + "locationName": "userMetadata", + "documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs." + } + }, + "documentation": "Each job converts an input file into an output file or files. For more information, see the User Guide at http://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", + "required": [ + "Role", + "Settings" + ] + }, + "JobMessages": { + "type": "structure", + "members": { + "Info": { + "shape": "__listOf__string", + "locationName": "info", + "documentation": "List of messages that are informational only and don't indicate a problem with your job." + }, + "Warning": { + "shape": "__listOf__string", + "locationName": "warning", + "documentation": "List of messages that warn about conditions that might cause your job not to run or to fail." + } + }, + "documentation": "Provides messages from the service about jobs that you have already successfully submitted." + }, + "JobPhase": { + "type": "string", + "documentation": "A job's phase can be PROBING, TRANSCODING OR UPLOADING", + "enum": [ + "PROBING", + "TRANSCODING", + "UPLOADING" + ] + }, + "JobSettings": { + "type": "structure", + "members": { + "AdAvailOffset": { + "shape": "__integerMinNegative1000Max1000", + "locationName": "adAvailOffset", + "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time." + }, + "AvailBlanking": { + "shape": "AvailBlanking", + "locationName": "availBlanking", + "documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails." + }, + "Esam": { + "shape": "EsamSettings", + "locationName": "esam", + "documentation": "Settings for Event Signaling And Messaging (ESAM)." + }, + "Inputs": { + "shape": "__listOfInput", + "locationName": "inputs", + "documentation": "Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output." + }, + "MotionImageInserter": { + "shape": "MotionImageInserter", + "locationName": "motionImageInserter", + "documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups." + }, + "NielsenConfiguration": { + "shape": "NielsenConfiguration", + "locationName": "nielsenConfiguration", + "documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting." + }, + "OutputGroups": { + "shape": "__listOfOutputGroup", + "locationName": "outputGroups", + "documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings" + }, + "TimecodeConfig": { + "shape": "TimecodeConfig", + "locationName": "timecodeConfig", + "documentation": "Contains settings used to acquire and adjust timecode information from inputs." + }, + "TimedMetadataInsertion": { + "shape": "TimedMetadataInsertion", + "locationName": "timedMetadataInsertion", + "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." + } + }, + "documentation": "JobSettings contains all the transcode settings for a job." + }, + "JobStatus": { + "type": "string", + "documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", + "enum": [ + "SUBMITTED", + "PROGRESSING", + "COMPLETE", + "CANCELED", + "ERROR" + ] + }, + "JobTemplate": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "AccelerationSettings", + "locationName": "accelerationSettings", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content." + }, + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "An identifier for this resource that is unique within all of AWS." + }, + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "An optional category you create to organize your job templates." + }, + "CreatedAt": { + "shape": "__timestampUnix", + "locationName": "createdAt", + "documentation": "The timestamp in epoch seconds for Job template creation." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "An optional description you create for each job template." + }, + "LastUpdated": { + "shape": "__timestampUnix", + "locationName": "lastUpdated", + "documentation": "The timestamp in epoch seconds when the Job template was last updated." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "A name you create for each job template. Each name must be unique within your account." + }, + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Relative priority on the job." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue." + }, + "Settings": { + "shape": "JobTemplateSettings", + "locationName": "settings", + "documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it." + }, + "StatusUpdateInterval": { + "shape": "StatusUpdateInterval", + "locationName": "statusUpdateInterval", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + }, + "Type": { + "shape": "Type", + "locationName": "type", + "documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user." + } + }, + "documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job.", + "required": [ + "Settings", + "Name" + ] + }, + "JobTemplateListBy": { + "type": "string", + "documentation": "Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "enum": [ + "NAME", + "CREATION_DATE", + "SYSTEM" + ] + }, + "JobTemplateSettings": { + "type": "structure", + "members": { + "AdAvailOffset": { + "shape": "__integerMinNegative1000Max1000", + "locationName": "adAvailOffset", + "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time." + }, + "AvailBlanking": { + "shape": "AvailBlanking", + "locationName": "availBlanking", + "documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails." + }, + "Esam": { + "shape": "EsamSettings", + "locationName": "esam", + "documentation": "Settings for Event Signaling And Messaging (ESAM)." + }, + "Inputs": { + "shape": "__listOfInputTemplate", + "locationName": "inputs", + "documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template." + }, + "MotionImageInserter": { + "shape": "MotionImageInserter", + "locationName": "motionImageInserter", + "documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups." + }, + "NielsenConfiguration": { + "shape": "NielsenConfiguration", + "locationName": "nielsenConfiguration", + "documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting." + }, + "OutputGroups": { + "shape": "__listOfOutputGroup", + "locationName": "outputGroups", + "documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings" + }, + "TimecodeConfig": { + "shape": "TimecodeConfig", + "locationName": "timecodeConfig", + "documentation": "Contains settings used to acquire and adjust timecode information from inputs." + }, + "TimedMetadataInsertion": { + "shape": "TimedMetadataInsertion", + "locationName": "timedMetadataInsertion", + "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." + } + }, + "documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it." + }, + "LanguageCode": { + "type": "string", + "documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.", + "enum": [ + "ENG", + "SPA", + "FRA", + "DEU", + "GER", + "ZHO", + "ARA", + "HIN", + "JPN", + "RUS", + "POR", + "ITA", + "URD", + "VIE", + "KOR", + "PAN", + "ABK", + "AAR", + "AFR", + "AKA", + "SQI", + "AMH", + "ARG", + "HYE", + "ASM", + "AVA", + "AVE", + "AYM", + "AZE", + "BAM", + "BAK", + "EUS", + "BEL", + "BEN", + "BIH", + "BIS", + "BOS", + "BRE", + "BUL", + "MYA", + "CAT", + "KHM", + "CHA", + "CHE", + "NYA", + "CHU", + "CHV", + "COR", + "COS", + "CRE", + "HRV", + "CES", + "DAN", + "DIV", + "NLD", + "DZO", + "ENM", + "EPO", + "EST", + "EWE", + "FAO", + "FIJ", + "FIN", + "FRM", + "FUL", + "GLA", + "GLG", + "LUG", + "KAT", + "ELL", + "GRN", + "GUJ", + "HAT", + "HAU", + "HEB", + "HER", + "HMO", + "HUN", + "ISL", + "IDO", + "IBO", + "IND", + "INA", + "ILE", + "IKU", + "IPK", + "GLE", + "JAV", + "KAL", + "KAN", + "KAU", + "KAS", + "KAZ", + "KIK", + "KIN", + "KIR", + "KOM", + "KON", + "KUA", + "KUR", + "LAO", + "LAT", + "LAV", + "LIM", + "LIN", + "LIT", + "LUB", + "LTZ", + "MKD", + "MLG", + "MSA", + "MAL", + "MLT", + "GLV", + "MRI", + "MAR", + "MAH", + "MON", + "NAU", + "NAV", + "NDE", + "NBL", + "NDO", + "NEP", + "SME", + "NOR", + "NOB", + "NNO", + "OCI", + "OJI", + "ORI", + "ORM", + "OSS", + "PLI", + "FAS", + "POL", + "PUS", + "QUE", + "QAA", + "RON", + "ROH", + "RUN", + "SMO", + "SAG", + "SAN", + "SRD", + "SRB", + "SNA", + "III", + "SND", + "SIN", + "SLK", + "SLV", + "SOM", + "SOT", + "SUN", + "SWA", + "SSW", + "SWE", + "TGL", + "TAH", + "TGK", + "TAM", + "TAT", + "TEL", + "THA", + "BOD", + "TIR", + "TON", + "TSO", + "TSN", + "TUR", + "TUK", + "TWI", + "UIG", + "UKR", + "UZB", + "VEN", + "VOL", + "WLN", + "CYM", + "FRY", + "WOL", + "XHO", + "YID", + "YOR", + "ZHA", + "ZUL", + "ORJ", + "QPC", + "TNG" + ] + }, + "ListJobTemplatesRequest": { + "type": "structure", + "members": { + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "Optionally, specify a job template category to limit responses to only job templates from that category.", + "location": "querystring" + }, + "ListBy": { + "shape": "JobTemplateListBy", + "locationName": "listBy", + "documentation": "Optional. When you request a list of job templates, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "location": "querystring" + }, + "MaxResults": { + "shape": "__integerMin1Max20", + "locationName": "maxResults", + "documentation": "Optional. Number of job templates, up to twenty, that will be returned at one time.", + "location": "querystring" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string, provided with the response to a previous request, to request the next batch of job templates.", + "location": "querystring" + }, + "Order": { + "shape": "Order", + "locationName": "order", + "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "location": "querystring" + } + } + }, + "ListJobTemplatesResponse": { + "type": "structure", + "members": { + "JobTemplates": { + "shape": "__listOfJobTemplate", + "locationName": "jobTemplates", + "documentation": "List of Job templates." + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string to request the next batch of job templates." + } + } + }, + "ListJobsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "__integerMin1Max20", + "locationName": "maxResults", + "documentation": "Optional. Number of jobs, up to twenty, that will be returned at one time.", + "location": "querystring" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string, provided with the response to a previous request, to request the next batch of jobs.", + "location": "querystring" + }, + "Order": { + "shape": "Order", + "locationName": "order", + "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "location": "querystring" + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "Provide a queue name to get back only jobs from that queue.", + "location": "querystring" + }, + "Status": { + "shape": "JobStatus", + "locationName": "status", + "documentation": "A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", + "location": "querystring" + } + } + }, + "ListJobsResponse": { + "type": "structure", + "members": { + "Jobs": { + "shape": "__listOfJob", + "locationName": "jobs", + "documentation": "List of jobs" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string to request the next batch of jobs." + } + } + }, + "ListPresetsRequest": { + "type": "structure", + "members": { + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "Optionally, specify a preset category to limit responses to only presets from that category.", + "location": "querystring" + }, + "ListBy": { + "shape": "PresetListBy", + "locationName": "listBy", + "documentation": "Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "location": "querystring" + }, + "MaxResults": { + "shape": "__integerMin1Max20", + "locationName": "maxResults", + "documentation": "Optional. Number of presets, up to twenty, that will be returned at one time", + "location": "querystring" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string, provided with the response to a previous request, to request the next batch of presets.", + "location": "querystring" + }, + "Order": { + "shape": "Order", + "locationName": "order", + "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "location": "querystring" + } + } + }, + "ListPresetsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string to request the next batch of presets." + }, + "Presets": { + "shape": "__listOfPreset", + "locationName": "presets", + "documentation": "List of presets" + } + } + }, + "ListQueuesRequest": { + "type": "structure", + "members": { + "ListBy": { + "shape": "QueueListBy", + "locationName": "listBy", + "documentation": "Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.", + "location": "querystring" + }, + "MaxResults": { + "shape": "__integerMin1Max20", + "locationName": "maxResults", + "documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.", + "location": "querystring" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string, provided with the response to a previous request, to request the next batch of queues.", + "location": "querystring" + }, + "Order": { + "shape": "Order", + "locationName": "order", + "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "location": "querystring" + } + } + }, + "ListQueuesResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Use this string to request the next batch of queues." + }, + "Queues": { + "shape": "__listOfQueue", + "locationName": "queues", + "documentation": "List of queues." + } + } + }, + "ListTagsForResourceRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Amazon Resource Name (ARN) of the resource that you want to list tags for. To get the ARN, send a GET request with the resource name.", + "location": "uri" + } + }, + "required": [ + "Arn" + ] + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTags": { + "shape": "ResourceTags", + "locationName": "resourceTags", + "documentation": "The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource." + } + } + }, + "M2tsAudioBufferModel": { + "type": "string", + "documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.", + "enum": [ + "DVB", + "ATSC" + ] + }, + "M2tsBufferModel": { + "type": "string", + "documentation": "Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions.", + "enum": [ + "MULTIPLEX", + "NONE" + ] + }, + "M2tsEbpAudioInterval": { + "type": "string", + "documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", + "enum": [ + "VIDEO_AND_FIXED_INTERVALS", + "VIDEO_INTERVAL" + ] + }, + "M2tsEbpPlacement": { + "type": "string", + "documentation": "Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", + "enum": [ + "VIDEO_AND_AUDIO_PIDS", + "VIDEO_PID" + ] + }, + "M2tsEsRateInPes": { + "type": "string", + "documentation": "Controls whether to include the ES Rate field in the PES header.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "M2tsForceTsVideoEbpOrder": { + "type": "string", + "documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).", + "enum": [ + "FORCE", + "DEFAULT" + ] + }, + "M2tsNielsenId3": { + "type": "string", + "documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "enum": [ + "INSERT", + "NONE" + ] + }, + "M2tsPcrControl": { + "type": "string", + "documentation": "When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream.", + "enum": [ + "PCR_EVERY_PES_PACKET", + "CONFIGURED_PCR_PERIOD" + ] + }, + "M2tsRateMode": { + "type": "string", + "documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.", + "enum": [ + "VBR", + "CBR" + ] + }, + "M2tsScte35Esam": { + "type": "structure", + "members": { + "Scte35EsamPid": { + "shape": "__integerMin32Max8182", + "locationName": "scte35EsamPid", + "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream generated by ESAM." + } + }, + "documentation": "Settings for SCTE-35 signals from ESAM. Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml)." + }, + "M2tsScte35Source": { + "type": "string", + "documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).", + "enum": [ + "PASSTHROUGH", + "NONE" + ] + }, + "M2tsSegmentationMarkers": { + "type": "string", + "documentation": "Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format.", + "enum": [ + "NONE", + "RAI_SEGSTART", + "RAI_ADAPT", + "PSI_SEGSTART", + "EBP", + "EBP_LEGACY" + ] + }, + "M2tsSegmentationStyle": { + "type": "string", + "documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.", + "enum": [ + "MAINTAIN_CADENCE", + "RESET_CADENCE" + ] + }, + "M2tsSettings": { + "type": "structure", + "members": { + "AudioBufferModel": { + "shape": "M2tsAudioBufferModel", + "locationName": "audioBufferModel", + "documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio." + }, + "AudioFramesPerPes": { + "shape": "__integerMin0Max2147483647", + "locationName": "audioFramesPerPes", + "documentation": "The number of audio frames to insert for each PES packet." + }, + "AudioPids": { + "shape": "__listOf__integerMin32Max8182", + "locationName": "audioPids", + "documentation": "Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492." + }, + "Bitrate": { + "shape": "__integerMin0Max2147483647", + "locationName": "bitrate", + "documentation": "Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000." + }, + "BufferModel": { + "shape": "M2tsBufferModel", + "locationName": "bufferModel", + "documentation": "Controls what buffer model to use for accurate interleaving. If set to MULTIPLEX, use multiplex buffer model. If set to NONE, this can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions." + }, + "DvbNitSettings": { + "shape": "DvbNitSettings", + "locationName": "dvbNitSettings", + "documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval." + }, + "DvbSdtSettings": { + "shape": "DvbSdtSettings", + "locationName": "dvbSdtSettings", + "documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval." + }, + "DvbSubPids": { + "shape": "__listOf__integerMin32Max8182", + "locationName": "dvbSubPids", + "documentation": "Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479." + }, + "DvbTdtSettings": { + "shape": "DvbTdtSettings", + "locationName": "dvbTdtSettings", + "documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval." + }, + "DvbTeletextPid": { + "shape": "__integerMin32Max8182", + "locationName": "dvbTeletextPid", + "documentation": "Specify the packet identifier (PID) for DVB teletext data you include in this output. Default is 499." + }, + "EbpAudioInterval": { + "shape": "M2tsEbpAudioInterval", + "locationName": "ebpAudioInterval", + "documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY)." + }, + "EbpPlacement": { + "shape": "M2tsEbpPlacement", + "locationName": "ebpPlacement", + "documentation": "Selects which PIDs to place EBP markers on. They can either be placed only on the video PID, or on both the video PID and all audio PIDs. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY)." + }, + "EsRateInPes": { + "shape": "M2tsEsRateInPes", + "locationName": "esRateInPes", + "documentation": "Controls whether to include the ES Rate field in the PES header." + }, + "ForceTsVideoEbpOrder": { + "shape": "M2tsForceTsVideoEbpOrder", + "locationName": "forceTsVideoEbpOrder", + "documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE)." + }, + "FragmentTime": { + "shape": "__doubleMin0", + "locationName": "fragmentTime", + "documentation": "The length, in seconds, of each fragment. Only used with EBP markers." + }, + "MaxPcrInterval": { + "shape": "__integerMin0Max500", + "locationName": "maxPcrInterval", + "documentation": "Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream." + }, + "MinEbpInterval": { + "shape": "__integerMin0Max10000", + "locationName": "minEbpInterval", + "documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate." + }, + "NielsenId3": { + "shape": "M2tsNielsenId3", + "locationName": "nielsenId3", + "documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output." + }, + "NullPacketBitrate": { + "shape": "__doubleMin0", + "locationName": "nullPacketBitrate", + "documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets." + }, + "PatInterval": { + "shape": "__integerMin0Max1000", + "locationName": "patInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + }, + "PcrControl": { + "shape": "M2tsPcrControl", + "locationName": "pcrControl", + "documentation": "When set to PCR_EVERY_PES_PACKET, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This is effective only when the PCR PID is the same as the video or audio elementary stream." + }, + "PcrPid": { + "shape": "__integerMin32Max8182", + "locationName": "pcrPid", + "documentation": "Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid)." + }, + "PmtInterval": { + "shape": "__integerMin0Max1000", + "locationName": "pmtInterval", + "documentation": "Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream." + }, + "PmtPid": { + "shape": "__integerMin32Max8182", + "locationName": "pmtPid", + "documentation": "Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480." + }, + "PrivateMetadataPid": { + "shape": "__integerMin32Max8182", + "locationName": "privateMetadataPid", + "documentation": "Specify the packet identifier (PID) of the private metadata stream. Default is 503." + }, + "ProgramNumber": { + "shape": "__integerMin0Max65535", + "locationName": "programNumber", + "documentation": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data." + }, + "RateMode": { + "shape": "M2tsRateMode", + "locationName": "rateMode", + "documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate." + }, + "Scte35Esam": { + "shape": "M2tsScte35Esam", + "locationName": "scte35Esam", + "documentation": "Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml)." + }, + "Scte35Pid": { + "shape": "__integerMin32Max8182", + "locationName": "scte35Pid", + "documentation": "Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream." + }, + "Scte35Source": { + "shape": "M2tsScte35Source", + "locationName": "scte35Source", + "documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam)." + }, + "SegmentationMarkers": { + "shape": "M2tsSegmentationMarkers", + "locationName": "segmentationMarkers", + "documentation": "Inserts segmentation markers at each segmentation_time period. rai_segstart sets the Random Access Indicator bit in the adaptation field. rai_adapt sets the RAI bit and adds the current timecode in the private data bytes. psi_segstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebp_legacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format." + }, + "SegmentationStyle": { + "shape": "M2tsSegmentationStyle", + "locationName": "segmentationStyle", + "documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule." + }, + "SegmentationTime": { + "shape": "__doubleMin0", + "locationName": "segmentationTime", + "documentation": "Specify the length, in seconds, of each segment. Required unless markers is set to _none_." + }, + "TimedMetadataPid": { + "shape": "__integerMin32Max8182", + "locationName": "timedMetadataPid", + "documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502." + }, + "TransportStreamId": { + "shape": "__integerMin0Max65535", + "locationName": "transportStreamId", + "documentation": "Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data." + }, + "VideoPid": { + "shape": "__integerMin32Max8182", + "locationName": "videoPid", + "documentation": "Specify the packet identifier (PID) of the elementary video stream in the transport stream." + } + }, + "documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset." + }, + "M3u8NielsenId3": { + "type": "string", + "documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "enum": [ + "INSERT", + "NONE" + ] + }, + "M3u8PcrControl": { + "type": "string", + "documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", + "enum": [ + "PCR_EVERY_PES_PACKET", + "CONFIGURED_PCR_PERIOD" + ] + }, + "M3u8Scte35Source": { + "type": "string", + "documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).", + "enum": [ + "PASSTHROUGH", + "NONE" + ] + }, + "M3u8Settings": { + "type": "structure", + "members": { + "AudioFramesPerPes": { + "shape": "__integerMin0Max2147483647", + "locationName": "audioFramesPerPes", + "documentation": "The number of audio frames to insert for each PES packet." + }, + "AudioPids": { + "shape": "__listOf__integerMin32Max8182", + "locationName": "audioPids", + "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation." + }, + "NielsenId3": { + "shape": "M3u8NielsenId3", + "locationName": "nielsenId3", + "documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output." + }, + "PatInterval": { + "shape": "__integerMin0Max1000", + "locationName": "patInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + }, + "PcrControl": { + "shape": "M3u8PcrControl", + "locationName": "pcrControl", + "documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream." + }, + "PcrPid": { + "shape": "__integerMin32Max8182", + "locationName": "pcrPid", + "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID." + }, + "PmtInterval": { + "shape": "__integerMin0Max1000", + "locationName": "pmtInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + }, + "PmtPid": { + "shape": "__integerMin32Max8182", + "locationName": "pmtPid", + "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream." + }, + "PrivateMetadataPid": { + "shape": "__integerMin32Max8182", + "locationName": "privateMetadataPid", + "documentation": "Packet Identifier (PID) of the private metadata stream in the transport stream." + }, + "ProgramNumber": { + "shape": "__integerMin0Max65535", + "locationName": "programNumber", + "documentation": "The value of the program number field in the Program Map Table." + }, + "Scte35Pid": { + "shape": "__integerMin32Max8182", + "locationName": "scte35Pid", + "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream." + }, + "Scte35Source": { + "shape": "M3u8Scte35Source", + "locationName": "scte35Source", + "documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml)." + }, + "TimedMetadata": { + "shape": "TimedMetadata", + "locationName": "timedMetadata", + "documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output." + }, + "TimedMetadataPid": { + "shape": "__integerMin32Max8182", + "locationName": "timedMetadataPid", + "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream." + }, + "TransportStreamId": { + "shape": "__integerMin0Max65535", + "locationName": "transportStreamId", + "documentation": "The value of the transport stream ID field in the Program Map Table." + }, + "VideoPid": { + "shape": "__integerMin32Max8182", + "locationName": "videoPid", + "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream." + } + }, + "documentation": "Settings for TS segments in HLS" + }, + "MotionImageInserter": { + "type": "structure", + "members": { + "Framerate": { + "shape": "MotionImageInsertionFramerate", + "locationName": "framerate", + "documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video." + }, + "Input": { + "shape": "__stringMin14Max1285PatternHttpHttpsS3Mov09Png", + "locationName": "input", + "documentation": "Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence." + }, + "InsertionMode": { + "shape": "MotionImageInsertionMode", + "locationName": "insertionMode", + "documentation": "Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files." + }, + "Offset": { + "shape": "MotionImageInsertionOffset", + "locationName": "offset", + "documentation": "Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling." + }, + "Playback": { + "shape": "MotionImagePlayback", + "locationName": "playback", + "documentation": "Specify whether your motion graphic overlay repeats on a loop or plays only once." + }, + "StartTime": { + "shape": "__stringMin11Max11Pattern01D20305D205D", + "locationName": "startTime", + "documentation": "Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource." + } + }, + "documentation": "Overlay motion graphics on top of your video at the time that you specify." + }, + "MotionImageInsertionFramerate": { + "type": "structure", + "members": { + "FramerateDenominator": { + "shape": "__integerMin1Max17895697", + "locationName": "framerateDenominator", + "documentation": "The bottom of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 1." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483640", + "locationName": "framerateNumerator", + "documentation": "The top of the fraction that expresses your overlay frame rate. For example, if your frame rate is 24 fps, set this value to 24." + } + }, + "documentation": "For motion overlays that don't have a built-in frame rate, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. The overlay frame rate doesn't need to match the frame rate of the underlying video." + }, + "MotionImageInsertionMode": { + "type": "string", + "documentation": "Choose the type of motion graphic asset that you are providing for your overlay. You can choose either a .mov file or a series of .png files.", + "enum": [ + "MOV", + "PNG" + ] + }, + "MotionImageInsertionOffset": { + "type": "structure", + "members": { + "ImageX": { + "shape": "__integerMin0Max2147483647", + "locationName": "imageX", + "documentation": "Set the distance, in pixels, between the overlay and the left edge of the video frame." + }, + "ImageY": { + "shape": "__integerMin0Max2147483647", + "locationName": "imageY", + "documentation": "Set the distance, in pixels, between the overlay and the top edge of the video frame." + } + }, + "documentation": "Specify the offset between the upper-left corner of the video frame and the top left corner of the overlay." + }, + "MotionImagePlayback": { + "type": "string", + "documentation": "Specify whether your motion graphic overlay repeats on a loop or plays only once.", + "enum": [ + "ONCE", + "REPEAT" + ] + }, + "MovClapAtom": { + "type": "string", + "documentation": "When enabled, include 'clap' atom if appropriate for the video output settings.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "MovCslgAtom": { + "type": "string", + "documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "MovMpeg2FourCCControl": { + "type": "string", + "documentation": "When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2.", + "enum": [ + "XDCAM", + "MPEG" + ] + }, + "MovPaddingControl": { + "type": "string", + "documentation": "If set to OMNEON, inserts Omneon-compatible padding", + "enum": [ + "OMNEON", + "NONE" + ] + }, + "MovReference": { + "type": "string", + "documentation": "Always keep the default value (SELF_CONTAINED) for this setting.", + "enum": [ + "SELF_CONTAINED", + "EXTERNAL" + ] + }, + "MovSettings": { + "type": "structure", + "members": { + "ClapAtom": { + "shape": "MovClapAtom", + "locationName": "clapAtom", + "documentation": "When enabled, include 'clap' atom if appropriate for the video output settings." + }, + "CslgAtom": { + "shape": "MovCslgAtom", + "locationName": "cslgAtom", + "documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools." + }, + "Mpeg2FourCCControl": { + "shape": "MovMpeg2FourCCControl", + "locationName": "mpeg2FourCCControl", + "documentation": "When set to XDCAM, writes MPEG2 video streams into the QuickTime file using XDCAM fourcc codes. This increases compatibility with Apple editors and players, but may decrease compatibility with other players. Only applicable when the video codec is MPEG2." + }, + "PaddingControl": { + "shape": "MovPaddingControl", + "locationName": "paddingControl", + "documentation": "If set to OMNEON, inserts Omneon-compatible padding" + }, + "Reference": { + "shape": "MovReference", + "locationName": "reference", + "documentation": "Always keep the default value (SELF_CONTAINED) for this setting." + } + }, + "documentation": "Settings for MOV Container." + }, + "Mp2Settings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__integerMin32000Max384000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second." + }, + "Channels": { + "shape": "__integerMin1Max2", + "locationName": "channels", + "documentation": "Set Channels to specify the number of channels in this output audio track. Choosing Mono in the console will give you 1 output channel; choosing Stereo will give you 2. In the API, valid values are 1 and 2." + }, + "SampleRate": { + "shape": "__integerMin32000Max48000", + "locationName": "sampleRate", + "documentation": "Sample rate in hz." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value MP2." + }, + "Mp4CslgAtom": { + "type": "string", + "documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "Mp4FreeSpaceBox": { + "type": "string", + "documentation": "Inserts a free-space box immediately after the moov box.", + "enum": [ + "INCLUDE", + "EXCLUDE" + ] + }, + "Mp4MoovPlacement": { + "type": "string", + "documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end.", + "enum": [ + "PROGRESSIVE_DOWNLOAD", + "NORMAL" + ] + }, + "Mp4Settings": { + "type": "structure", + "members": { + "CslgAtom": { + "shape": "Mp4CslgAtom", + "locationName": "cslgAtom", + "documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools." + }, + "FreeSpaceBox": { + "shape": "Mp4FreeSpaceBox", + "locationName": "freeSpaceBox", + "documentation": "Inserts a free-space box immediately after the moov box." + }, + "MoovPlacement": { + "shape": "Mp4MoovPlacement", + "locationName": "moovPlacement", + "documentation": "If set to PROGRESSIVE_DOWNLOAD, the MOOV atom is relocated to the beginning of the archive as required for progressive downloading. Otherwise it is placed normally at the end." + }, + "Mp4MajorBrand": { + "shape": "__string", + "locationName": "mp4MajorBrand", + "documentation": "Overrides the \"Major Brand\" field in the output file. Usually not necessary to specify." + } + }, + "documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container." + }, + "Mpeg2AdaptiveQuantization": { + "type": "string", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.", + "enum": [ + "OFF", + "LOW", + "MEDIUM", + "HIGH" + ] + }, + "Mpeg2CodecLevel": { + "type": "string", + "documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.", + "enum": [ + "AUTO", + "LOW", + "MAIN", + "HIGH1440", + "HIGH" + ] + }, + "Mpeg2CodecProfile": { + "type": "string", + "documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.", + "enum": [ + "MAIN", + "PROFILE_422" + ] + }, + "Mpeg2DynamicSubGop": { + "type": "string", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "enum": [ + "ADAPTIVE", + "STATIC" + ] + }, + "Mpeg2FramerateControl": { + "type": "string", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "Mpeg2FramerateConversionAlgorithm": { + "type": "string", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion.", + "enum": [ + "DUPLICATE_DROP", + "INTERPOLATE" + ] + }, + "Mpeg2GopSizeUnits": { + "type": "string", + "documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "enum": [ + "FRAMES", + "SECONDS" + ] + }, + "Mpeg2InterlaceMode": { + "type": "string", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "enum": [ + "PROGRESSIVE", + "TOP_FIELD", + "BOTTOM_FIELD", + "FOLLOW_TOP_FIELD", + "FOLLOW_BOTTOM_FIELD" + ] + }, + "Mpeg2IntraDcPrecision": { + "type": "string", + "documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.", + "enum": [ + "AUTO", + "INTRA_DC_PRECISION_8", + "INTRA_DC_PRECISION_9", + "INTRA_DC_PRECISION_10", + "INTRA_DC_PRECISION_11" + ] + }, + "Mpeg2ParControl": { + "type": "string", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "Mpeg2QualityTuningLevel": { + "type": "string", + "documentation": "Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video encoding.", + "enum": [ + "SINGLE_PASS", + "MULTI_PASS" + ] + }, + "Mpeg2RateControlMode": { + "type": "string", + "documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).", + "enum": [ + "VBR", + "CBR" + ] + }, + "Mpeg2SceneChangeDetect": { + "type": "string", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Mpeg2Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "shape": "Mpeg2AdaptiveQuantization", + "locationName": "adaptiveQuantization", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality." + }, + "Bitrate": { + "shape": "__integerMin1000Max288000000", + "locationName": "bitrate", + "documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000." + }, + "CodecLevel": { + "shape": "Mpeg2CodecLevel", + "locationName": "codecLevel", + "documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output." + }, + "CodecProfile": { + "shape": "Mpeg2CodecProfile", + "locationName": "codecProfile", + "documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output." + }, + "DynamicSubGop": { + "shape": "Mpeg2DynamicSubGop", + "locationName": "dynamicSubGop", + "documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames)." + }, + "FramerateControl": { + "shape": "Mpeg2FramerateControl", + "locationName": "framerateControl", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator." + }, + "FramerateConversionAlgorithm": { + "shape": "Mpeg2FramerateConversionAlgorithm", + "locationName": "framerateConversionAlgorithm", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max1001", + "locationName": "framerateDenominator", + "documentation": "Frame rate denominator." + }, + "FramerateNumerator": { + "shape": "__integerMin24Max60000", + "locationName": "framerateNumerator", + "documentation": "Frame rate numerator - frame rate is a fraction, e.g. 24000 / 1001 = 23.976 fps." + }, + "GopClosedCadence": { + "shape": "__integerMin0Max2147483647", + "locationName": "gopClosedCadence", + "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." + }, + "GopSize": { + "shape": "__doubleMin0", + "locationName": "gopSize", + "documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero." + }, + "GopSizeUnits": { + "shape": "Mpeg2GopSizeUnits", + "locationName": "gopSizeUnits", + "documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time." + }, + "HrdBufferInitialFillPercentage": { + "shape": "__integerMin0Max100", + "locationName": "hrdBufferInitialFillPercentage", + "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)." + }, + "HrdBufferSize": { + "shape": "__integerMin0Max47185920", + "locationName": "hrdBufferSize", + "documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000." + }, + "InterlaceMode": { + "shape": "Mpeg2InterlaceMode", + "locationName": "interlaceMode", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose." + }, + "IntraDcPrecision": { + "shape": "Mpeg2IntraDcPrecision", + "locationName": "intraDcPrecision", + "documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio." + }, + "MaxBitrate": { + "shape": "__integerMin1000Max300000000", + "locationName": "maxBitrate", + "documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000." + }, + "MinIInterval": { + "shape": "__integerMin0Max30", + "locationName": "minIInterval", + "documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1" + }, + "NumberBFramesBetweenReferenceFrames": { + "shape": "__integerMin0Max7", + "locationName": "numberBFramesBetweenReferenceFrames", + "documentation": "Number of B-frames between reference frames." + }, + "ParControl": { + "shape": "Mpeg2ParControl", + "locationName": "parControl", + "documentation": "Using the API, enable ParFollowSource if you want the service to use the pixel aspect ratio from the input. Using the console, do this by choosing Follow source for Pixel aspect ratio." + }, + "ParDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "QualityTuningLevel": { + "shape": "Mpeg2QualityTuningLevel", + "locationName": "qualityTuningLevel", + "documentation": "Use Quality tuning level (Mpeg2QualityTuningLevel) to specifiy whether to use single-pass or multipass video encoding." + }, + "RateControlMode": { + "shape": "Mpeg2RateControlMode", + "locationName": "rateControlMode", + "documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr)." + }, + "SceneChangeDetect": { + "shape": "Mpeg2SceneChangeDetect", + "locationName": "sceneChangeDetect", + "documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default." + }, + "SlowPal": { + "shape": "Mpeg2SlowPal", + "locationName": "slowPal", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly." + }, + "Softness": { + "shape": "__integerMin0Max128", + "locationName": "softness", + "documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image." + }, + "SpatialAdaptiveQuantization": { + "shape": "Mpeg2SpatialAdaptiveQuantization", + "locationName": "spatialAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity." + }, + "Syntax": { + "shape": "Mpeg2Syntax", + "locationName": "syntax", + "documentation": "Produces a Type D-10 compatible bitstream (SMPTE 356M-2001)." + }, + "Telecine": { + "shape": "Mpeg2Telecine", + "locationName": "telecine", + "documentation": "Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player." + }, + "TemporalAdaptiveQuantization": { + "shape": "Mpeg2TemporalAdaptiveQuantization", + "locationName": "temporalAdaptiveQuantization", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity." + } + }, + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2." + }, + "Mpeg2SlowPal": { + "type": "string", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Mpeg2SpatialAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on spatial variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Mpeg2Syntax": { + "type": "string", + "documentation": "Produces a Type D-10 compatible bitstream (SMPTE 356M-2001).", + "enum": [ + "DEFAULT", + "D_10" + ] + }, + "Mpeg2Telecine": { + "type": "string", + "documentation": "Only use Telecine (Mpeg2Telecine) when you set Framerate (Framerate) to 29.970. Set Telecine (Mpeg2Telecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", + "enum": [ + "NONE", + "SOFT", + "HARD" + ] + }, + "Mpeg2TemporalAdaptiveQuantization": { + "type": "string", + "documentation": "Adjust quantization within each frame based on temporal variation of content complexity.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "MsSmoothAudioDeduplication": { + "type": "string", + "documentation": "COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream.", + "enum": [ + "COMBINE_DUPLICATE_STREAMS", + "NONE" + ] + }, + "MsSmoothEncryptionSettings": { + "type": "structure", + "members": { + "SpekeKeyProvider": { + "shape": "SpekeKeyProvider", + "locationName": "spekeKeyProvider", + "documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead." + } + }, + "documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider." + }, + "MsSmoothGroupSettings": { + "type": "structure", + "members": { + "AudioDeduplication": { + "shape": "MsSmoothAudioDeduplication", + "locationName": "audioDeduplication", + "documentation": "COMBINE_DUPLICATE_STREAMS combines identical audio encoding settings across a Microsoft Smooth output group into a single audio stream." + }, + "Destination": { + "shape": "__stringPatternS3", + "locationName": "destination", + "documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file." + }, + "DestinationSettings": { + "shape": "DestinationSettings", + "locationName": "destinationSettings", + "documentation": "Settings associated with the destination. Will vary based on the type of destination" + }, + "Encryption": { + "shape": "MsSmoothEncryptionSettings", + "locationName": "encryption", + "documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider." + }, + "FragmentLength": { + "shape": "__integerMin1Max2147483647", + "locationName": "fragmentLength", + "documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate." + }, + "ManifestEncoding": { + "shape": "MsSmoothManifestEncoding", + "locationName": "manifestEncoding", + "documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16." + } + }, + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS." + }, + "MsSmoothManifestEncoding": { + "type": "string", + "documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.", + "enum": [ + "UTF8", + "UTF16" + ] + }, + "NielsenConfiguration": { + "type": "structure", + "members": { + "BreakoutCode": { + "shape": "__integerMin0Max0", + "locationName": "breakoutCode", + "documentation": "Nielsen has discontinued the use of breakout code functionality. If you must include this property, set the value to zero." + }, + "DistributorId": { + "shape": "__string", + "locationName": "distributorId", + "documentation": "Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen." + } + }, + "documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting." + }, + "NoiseReducer": { + "type": "structure", + "members": { + "Filter": { + "shape": "NoiseReducerFilter", + "locationName": "filter", + "documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion." + }, + "FilterSettings": { + "shape": "NoiseReducerFilterSettings", + "locationName": "filterSettings", + "documentation": "Settings for a noise reducer filter" + }, + "SpatialFilterSettings": { + "shape": "NoiseReducerSpatialFilterSettings", + "locationName": "spatialFilterSettings", + "documentation": "Noise reducer filter settings for spatial filter." + }, + "TemporalFilterSettings": { + "shape": "NoiseReducerTemporalFilterSettings", + "locationName": "temporalFilterSettings", + "documentation": "Noise reducer filter settings for temporal filter." + } + }, + "documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default. When you enable Noise reducer (NoiseReducer), you must also select a value for Noise reducer filter (NoiseReducerFilter)." + }, + "NoiseReducerFilter": { + "type": "string", + "documentation": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion.", + "enum": [ + "BILATERAL", + "MEAN", + "GAUSSIAN", + "LANCZOS", + "SHARPEN", + "CONSERVE", + "SPATIAL", + "TEMPORAL" + ] + }, + "NoiseReducerFilterSettings": { + "type": "structure", + "members": { + "Strength": { + "shape": "__integerMin0Max3", + "locationName": "strength", + "documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering." + } + }, + "documentation": "Settings for a noise reducer filter" + }, + "NoiseReducerSpatialFilterSettings": { + "type": "structure", + "members": { + "PostFilterSharpenStrength": { + "shape": "__integerMin0Max3", + "locationName": "postFilterSharpenStrength", + "documentation": "Specify strength of post noise reduction sharpening filter, with 0 disabling the filter and 3 enabling it at maximum strength." + }, + "Speed": { + "shape": "__integerMinNegative2Max3", + "locationName": "speed", + "documentation": "The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value." + }, + "Strength": { + "shape": "__integerMin0Max16", + "locationName": "strength", + "documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering." + } + }, + "documentation": "Noise reducer filter settings for spatial filter." + }, + "NoiseReducerTemporalFilterSettings": { + "type": "structure", + "members": { + "AggressiveMode": { + "shape": "__integerMin0Max4", + "locationName": "aggressiveMode", + "documentation": "Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs." + }, + "Speed": { + "shape": "__integerMinNegative1Max3", + "locationName": "speed", + "documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate." + }, + "Strength": { + "shape": "__integerMin0Max16", + "locationName": "strength", + "documentation": "Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity reduction" + } + }, + "documentation": "Noise reducer filter settings for temporal filter." + }, + "NotFoundException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 404 + }, + "documentation": "The resource you requested doesn't exist." + }, + "Order": { + "type": "string", + "documentation": "When you request lists of resources, you can optionally specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "enum": [ + "ASCENDING", + "DESCENDING" + ] + }, + "Output": { + "type": "structure", + "members": { + "AudioDescriptions": { + "shape": "__listOfAudioDescription", + "locationName": "audioDescriptions", + "documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings." + }, + "CaptionDescriptions": { + "shape": "__listOfCaptionDescription", + "locationName": "captionDescriptions", + "documentation": "(CaptionDescriptions) contains groups of captions settings. For each output that has captions, include one instance of (CaptionDescriptions). (CaptionDescriptions) can contain multiple groups of captions settings." + }, + "ContainerSettings": { + "shape": "ContainerSettings", + "locationName": "containerSettings", + "documentation": "Container specific settings." + }, + "Extension": { + "shape": "__string", + "locationName": "extension", + "documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)" + }, + "NameModifier": { + "shape": "__stringMin1", + "locationName": "nameModifier", + "documentation": "Use Name modifier (NameModifier) to have the service add a string to the end of each output filename. You specify the base filename as part of your destination URI. When you create multiple outputs in the same output group, Name modifier (NameModifier) is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output group." + }, + "OutputSettings": { + "shape": "OutputSettings", + "locationName": "outputSettings", + "documentation": "Specific settings for this type of output." + }, + "Preset": { + "shape": "__stringMin0", + "locationName": "preset", + "documentation": "Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both." + }, + "VideoDescription": { + "shape": "VideoDescription", + "locationName": "videoDescription", + "documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output." + } + }, + "documentation": "An output object describes the settings for a single output file or stream in an output group." + }, + "OutputChannelMapping": { + "type": "structure", + "members": { + "InputChannels": { + "shape": "__listOf__integerMinNegative60Max6", + "locationName": "inputChannels", + "documentation": "List of input channels" + } + }, + "documentation": "OutputChannel mapping settings." + }, + "OutputDetail": { + "type": "structure", + "members": { + "DurationInMs": { + "shape": "__integer", + "locationName": "durationInMs", + "documentation": "Duration in milliseconds" + }, + "VideoDetails": { + "shape": "VideoDetail", + "locationName": "videoDetails", + "documentation": "Contains details about the output's video stream" + } + }, + "documentation": "Details regarding output" + }, + "OutputGroup": { + "type": "structure", + "members": { + "CustomName": { + "shape": "__string", + "locationName": "customName", + "documentation": "Use Custom Group Name (CustomName) to specify a name for the output group. This value is displayed on the console and can make your job settings JSON more human-readable. It does not affect your outputs. Use up to twelve characters that are either letters, numbers, spaces, or underscores." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the output group" + }, + "OutputGroupSettings": { + "shape": "OutputGroupSettings", + "locationName": "outputGroupSettings", + "documentation": "Output Group settings, including type" + }, + "Outputs": { + "shape": "__listOfOutput", + "locationName": "outputs", + "documentation": "This object holds groups of encoding settings, one group of settings per output." + } + }, + "documentation": "Group of outputs" + }, + "OutputGroupDetail": { + "type": "structure", + "members": { + "OutputDetails": { + "shape": "__listOfOutputDetail", + "locationName": "outputDetails", + "documentation": "Details about the output" + } + }, + "documentation": "Contains details about the output groups specified in the job settings." + }, + "OutputGroupSettings": { + "type": "structure", + "members": { + "CmafGroupSettings": { + "shape": "CmafGroupSettings", + "locationName": "cmafGroupSettings", + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to CMAF_GROUP_SETTINGS. Each output in a CMAF Output Group may only contain a single video, audio, or caption output." + }, + "DashIsoGroupSettings": { + "shape": "DashIsoGroupSettings", + "locationName": "dashIsoGroupSettings", + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS." + }, + "FileGroupSettings": { + "shape": "FileGroupSettings", + "locationName": "fileGroupSettings", + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to FILE_GROUP_SETTINGS." + }, + "HlsGroupSettings": { + "shape": "HlsGroupSettings", + "locationName": "hlsGroupSettings", + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to HLS_GROUP_SETTINGS." + }, + "MsSmoothGroupSettings": { + "shape": "MsSmoothGroupSettings", + "locationName": "msSmoothGroupSettings", + "documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS." + }, + "Type": { + "shape": "OutputGroupType", + "locationName": "type", + "documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)" + } + }, + "documentation": "Output Group settings, including type" + }, + "OutputGroupType": { + "type": "string", + "documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)", + "enum": [ + "HLS_GROUP_SETTINGS", + "DASH_ISO_GROUP_SETTINGS", + "FILE_GROUP_SETTINGS", + "MS_SMOOTH_GROUP_SETTINGS", + "CMAF_GROUP_SETTINGS" + ] + }, + "OutputSdt": { + "type": "string", + "documentation": "Selects method of inserting SDT information into output stream. \"Follow input SDT\" copies SDT information from input stream to output stream. \"Follow input SDT if present\" copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. Enter \"SDT Manually\" means user will enter the SDT information. \"No SDT\" means output stream will not contain SDT information.", + "enum": [ + "SDT_FOLLOW", + "SDT_FOLLOW_IF_PRESENT", + "SDT_MANUAL", + "SDT_NONE" + ] + }, + "OutputSettings": { + "type": "structure", + "members": { + "HlsSettings": { + "shape": "HlsSettings", + "locationName": "hlsSettings", + "documentation": "Settings for HLS output groups" + } + }, + "documentation": "Specific settings for this type of output." + }, + "Preset": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "An identifier for this resource that is unique within all of AWS." + }, + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "An optional category you create to organize your presets." + }, + "CreatedAt": { + "shape": "__timestampUnix", + "locationName": "createdAt", + "documentation": "The timestamp in epoch seconds for preset creation." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "An optional description you create for each preset." + }, + "LastUpdated": { + "shape": "__timestampUnix", + "locationName": "lastUpdated", + "documentation": "The timestamp in epoch seconds when the preset was last updated." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "A name you create for each preset. Each name must be unique within your account." + }, + "Settings": { + "shape": "PresetSettings", + "locationName": "settings", + "documentation": "Settings for preset" + }, + "Type": { + "shape": "Type", + "locationName": "type", + "documentation": "A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user." + } + }, + "documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process.", + "required": [ + "Settings", + "Name" + ] + }, + "PresetListBy": { + "type": "string", + "documentation": "Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "enum": [ + "NAME", + "CREATION_DATE", + "SYSTEM" + ] + }, + "PresetSettings": { + "type": "structure", + "members": { + "AudioDescriptions": { + "shape": "__listOfAudioDescription", + "locationName": "audioDescriptions", + "documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings." + }, + "CaptionDescriptions": { + "shape": "__listOfCaptionDescriptionPreset", + "locationName": "captionDescriptions", + "documentation": "Caption settings for this preset. There can be multiple caption settings in a single output." + }, + "ContainerSettings": { + "shape": "ContainerSettings", + "locationName": "containerSettings", + "documentation": "Container specific settings." + }, + "VideoDescription": { + "shape": "VideoDescription", + "locationName": "videoDescription", + "documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output." + } + }, + "documentation": "Settings for preset" + }, + "PricingPlan": { + "type": "string", + "documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment.", + "enum": [ + "ON_DEMAND", + "RESERVED" + ] + }, + "ProresCodecProfile": { + "type": "string", + "documentation": "Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.", + "enum": [ + "APPLE_PRORES_422", + "APPLE_PRORES_422_HQ", + "APPLE_PRORES_422_LT", + "APPLE_PRORES_422_PROXY" + ] + }, + "ProresFramerateControl": { + "type": "string", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "ProresFramerateConversionAlgorithm": { + "type": "string", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion.", + "enum": [ + "DUPLICATE_DROP", + "INTERPOLATE" + ] + }, + "ProresInterlaceMode": { + "type": "string", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "enum": [ + "PROGRESSIVE", + "TOP_FIELD", + "BOTTOM_FIELD", + "FOLLOW_TOP_FIELD", + "FOLLOW_BOTTOM_FIELD" + ] + }, + "ProresParControl": { + "type": "string", + "documentation": "Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio: Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and provide for (ParNumerator) and (ParDenominator).", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "ProresSettings": { + "type": "structure", + "members": { + "CodecProfile": { + "shape": "ProresCodecProfile", + "locationName": "codecProfile", + "documentation": "Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output." + }, + "FramerateControl": { + "shape": "ProresFramerateControl", + "locationName": "framerateControl", + "documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job sepecification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator." + }, + "FramerateConversionAlgorithm": { + "shape": "ProresFramerateConversionAlgorithm", + "locationName": "framerateConversionAlgorithm", + "documentation": "When set to INTERPOLATE, produces smoother motion during frame rate conversion." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateDenominator", + "documentation": "Frame rate denominator." + }, + "FramerateNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "framerateNumerator", + "documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator." + }, + "InterlaceMode": { + "shape": "ProresInterlaceMode", + "locationName": "interlaceMode", + "documentation": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose." + }, + "ParControl": { + "shape": "ProresParControl", + "locationName": "parControl", + "documentation": "Use (ProresParControl) to specify how the service determines the pixel aspect ratio. Set to Follow source (INITIALIZE_FROM_SOURCE) to use the pixel aspect ratio from the input. To specify a different pixel aspect ratio: Using the console, choose it from the dropdown menu. Using the API, set ProresParControl to (SPECIFIED) and provide for (ParNumerator) and (ParDenominator)." + }, + "ParDenominator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integerMin1Max2147483647", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "SlowPal": { + "shape": "ProresSlowPal", + "locationName": "slowPal", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly." + }, + "Telecine": { + "shape": "ProresTelecine", + "locationName": "telecine", + "documentation": "Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player." + } + }, + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES." + }, + "ProresSlowPal": { + "type": "string", + "documentation": "Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled as 25fps, and audio is sped up correspondingly.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "ProresTelecine": { + "type": "string", + "documentation": "Only use Telecine (ProresTelecine) when you set Framerate (Framerate) to 29.970. Set Telecine (ProresTelecine) to Hard (hard) to produce a 29.97i output from a 23.976 input. Set it to Soft (soft) to produce 23.976 output and leave converstion to the player.", + "enum": [ + "NONE", + "HARD" + ] + }, + "Queue": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "An identifier for this resource that is unique within all of AWS." + }, + "CreatedAt": { + "shape": "__timestampUnix", + "locationName": "createdAt", + "documentation": "The timestamp in epoch seconds for when you created the queue." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "An optional description that you create for each queue." + }, + "LastUpdated": { + "shape": "__timestampUnix", + "locationName": "lastUpdated", + "documentation": "The timestamp in epoch seconds for when you most recently updated the queue." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "A name that you create for each queue. Each name must be unique within your account." + }, + "PricingPlan": { + "shape": "PricingPlan", + "locationName": "pricingPlan", + "documentation": "Specifies whether the pricing plan for the queue is on-demand or reserved. For on-demand, you pay per minute, billed in increments of .01 minute. For reserved, you pay for the transcoding capacity of the entire queue, regardless of how much or how little you use it. Reserved pricing requires a 12-month commitment." + }, + "ProgressingJobsCount": { + "shape": "__integer", + "locationName": "progressingJobsCount", + "documentation": "The estimated number of jobs with a PROGRESSING status." + }, + "ReservationPlan": { + "shape": "ReservationPlan", + "locationName": "reservationPlan", + "documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues." + }, + "Status": { + "shape": "QueueStatus", + "locationName": "status", + "documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error." + }, + "SubmittedJobsCount": { + "shape": "__integer", + "locationName": "submittedJobsCount", + "documentation": "The estimated number of jobs with a SUBMITTED status." + }, + "Type": { + "shape": "Type", + "locationName": "type", + "documentation": "Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues." + } + }, + "documentation": "You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html.", + "required": [ + "Name" + ] + }, + "QueueListBy": { + "type": "string", + "documentation": "Optional. When you request a list of queues, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by creation date.", + "enum": [ + "NAME", + "CREATION_DATE" + ] + }, + "QueueStatus": { + "type": "string", + "documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.", + "enum": [ + "ACTIVE", + "PAUSED" + ] + }, + "Rectangle": { + "type": "structure", + "members": { + "Height": { + "shape": "__integerMin2Max2147483647", + "locationName": "height", + "documentation": "Height of rectangle in pixels. Specify only even numbers." + }, + "Width": { + "shape": "__integerMin2Max2147483647", + "locationName": "width", + "documentation": "Width of rectangle in pixels. Specify only even numbers." + }, + "X": { + "shape": "__integerMin0Max2147483647", + "locationName": "x", + "documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers." + }, + "Y": { + "shape": "__integerMin0Max2147483647", + "locationName": "y", + "documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers." + } + }, + "documentation": "Use Rectangle to identify a specific area of the video frame." + }, + "RemixSettings": { + "type": "structure", + "members": { + "ChannelMapping": { + "shape": "ChannelMapping", + "locationName": "channelMapping", + "documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification)." + }, + "ChannelsIn": { + "shape": "__integerMin1Max64", + "locationName": "channelsIn", + "documentation": "Specify the number of audio channels from your input that you want to use in your output. With remixing, you might combine or split the data in these channels, so the number of channels in your final output might be different." + }, + "ChannelsOut": { + "shape": "__integerMin1Max64", + "locationName": "channelsOut", + "documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)" + } + }, + "documentation": "Use Manual audio remixing (RemixSettings) to adjust audio levels for each audio channel in each output of your job. With audio remixing, you can output more or fewer audio channels than your input audio source provides." + }, + "RenewalType": { + "type": "string", + "documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term.", + "enum": [ + "AUTO_RENEW", + "EXPIRE" + ] + }, + "ReservationPlan": { + "type": "structure", + "members": { + "Commitment": { + "shape": "Commitment", + "locationName": "commitment", + "documentation": "The length of the term of your reserved queue pricing plan commitment." + }, + "ExpiresAt": { + "shape": "__timestampUnix", + "locationName": "expiresAt", + "documentation": "The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires." + }, + "PurchasedAt": { + "shape": "__timestampUnix", + "locationName": "purchasedAt", + "documentation": "The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue." + }, + "RenewalType": { + "shape": "RenewalType", + "locationName": "renewalType", + "documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term." + }, + "ReservedSlots": { + "shape": "__integer", + "locationName": "reservedSlots", + "documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue." + }, + "Status": { + "shape": "ReservationPlanStatus", + "locationName": "status", + "documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED." + } + }, + "documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues." + }, + "ReservationPlanSettings": { + "type": "structure", + "members": { + "Commitment": { + "shape": "Commitment", + "locationName": "commitment", + "documentation": "The length of the term of your reserved queue pricing plan commitment." + }, + "RenewalType": { + "shape": "RenewalType", + "locationName": "renewalType", + "documentation": "Specifies whether the term of your reserved queue pricing plan is automatically extended (AUTO_RENEW) or expires (EXPIRE) at the end of the term. When your term is auto renewed, you extend your commitment by 12 months from the auto renew date. You can cancel this commitment." + }, + "ReservedSlots": { + "shape": "__integer", + "locationName": "reservedSlots", + "documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity." + } + }, + "documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.", + "required": [ + "Commitment", + "ReservedSlots", + "RenewalType" + ] + }, + "ReservationPlanStatus": { + "type": "string", + "documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.", + "enum": [ + "ACTIVE", + "EXPIRED" + ] + }, + "ResourceTags": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Amazon Resource Name (ARN) of the resource." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags for the resource." + } + }, + "documentation": "The Amazon Resource Name (ARN) and tags for an AWS Elemental MediaConvert resource." + }, + "RespondToAfd": { + "type": "string", + "documentation": "Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output.", + "enum": [ + "NONE", + "RESPOND", + "PASSTHROUGH" + ] + }, + "S3DestinationSettings": { + "type": "structure", + "members": { + "Encryption": { + "shape": "S3EncryptionSettings", + "locationName": "encryption", + "documentation": "Settings for how your job outputs are encrypted as they are uploaded to Amazon S3." + } + }, + "documentation": "Settings associated with S3 destination" + }, + "S3EncryptionSettings": { + "type": "structure", + "members": { + "EncryptionType": { + "shape": "S3ServerSideEncryptionType", + "locationName": "encryptionType", + "documentation": "Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3 (SERVER_SIDE_ENCRYPTION_S3). If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN (kmsKeyArn)." + }, + "KmsKeyArn": { + "shape": "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912", + "locationName": "kmsKeyArn", + "documentation": "Optionally, specify the customer master key (CMK) that you want to use to encrypt the data key that AWS uses to encrypt your output content. Enter the Amazon Resource Name (ARN) of the CMK. To use this setting, you must also set Server-side encryption (S3ServerSideEncryptionType) to AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). If you set Server-side encryption to AWS KMS but don't specify a CMK here, AWS uses the AWS managed CMK associated with Amazon S3." + } + }, + "documentation": "Settings for how your job outputs are encrypted as they are uploaded to Amazon S3." + }, + "S3ServerSideEncryptionType": { + "type": "string", + "documentation": "Specify how you want your data keys managed. AWS uses data keys to encrypt your content. AWS also encrypts the data keys themselves, using a customer master key (CMK), and then stores the encrypted data keys alongside your encrypted content. Use this setting to specify which AWS service manages the CMK. For simplest set up, choose Amazon S3 (SERVER_SIDE_ENCRYPTION_S3). If you want your master key to be managed by AWS Key Management Service (KMS), choose AWS KMS (SERVER_SIDE_ENCRYPTION_KMS). By default, when you choose AWS KMS, KMS uses the AWS managed customer master key (CMK) associated with Amazon S3 to encrypt your data keys. You can optionally choose to specify a different, customer managed CMK. Do so by specifying the Amazon Resource Name (ARN) of the key for the setting KMS ARN (kmsKeyArn).", + "enum": [ + "SERVER_SIDE_ENCRYPTION_S3", + "SERVER_SIDE_ENCRYPTION_KMS" + ] + }, + "ScalingBehavior": { + "type": "string", + "documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.", + "enum": [ + "DEFAULT", + "STRETCH_TO_OUTPUT" + ] + }, + "SccDestinationFramerate": { + "type": "string", + "documentation": "Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME).", + "enum": [ + "FRAMERATE_23_97", + "FRAMERATE_24", + "FRAMERATE_29_97_DROPFRAME", + "FRAMERATE_29_97_NON_DROPFRAME" + ] + }, + "SccDestinationSettings": { + "type": "structure", + "members": { + "Framerate": { + "shape": "SccDestinationFramerate", + "locationName": "framerate", + "documentation": "Set Framerate (SccDestinationFramerate) to make sure that the captions and the video are synchronized in the output. Specify a frame rate that matches the frame rate of the associated video. If the video frame rate is 29.97, choose 29.97 dropframe (FRAMERATE_29_97_DROPFRAME) only if the video has video_insertion=true and drop_frame_timecode=true; otherwise, choose 29.97 non-dropframe (FRAMERATE_29_97_NON_DROPFRAME)." + } + }, + "documentation": "Settings for SCC caption output." + }, + "SimulateReservedQueue": { + "type": "string", + "documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "SpekeKeyProvider": { + "type": "structure", + "members": { + "CertificateArn": { + "shape": "__stringPatternArnAwsUsGovAcm", + "locationName": "certificateArn", + "documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here." + }, + "ResourceId": { + "shape": "__string", + "locationName": "resourceId", + "documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content." + }, + "SystemIds": { + "shape": "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "locationName": "systemIds", + "documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See\n https://dashif.org/identifiers/content_protection/ for more details." + }, + "Url": { + "shape": "__stringPatternHttps", + "locationName": "url", + "documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content." + } + }, + "documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead." + }, + "SpekeKeyProviderCmaf": { + "type": "structure", + "members": { + "CertificateArn": { + "shape": "__stringPatternArnAwsUsGovAcm", + "locationName": "certificateArn", + "documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here." + }, + "DashSignaledSystemIds": { + "shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "locationName": "dashSignaledSystemIds", + "documentation": "Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/." + }, + "HlsSignaledSystemIds": { + "shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "locationName": "hlsSignaledSystemIds", + "documentation": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/." + }, + "ResourceId": { + "shape": "__stringPatternW", + "locationName": "resourceId", + "documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content." + }, + "Url": { + "shape": "__stringPatternHttps", + "locationName": "url", + "documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content." + } + }, + "documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead." + }, + "StaticKeyProvider": { + "type": "structure", + "members": { + "KeyFormat": { + "shape": "__stringPatternIdentityAZaZ26AZaZ09163", + "locationName": "keyFormat", + "documentation": "Relates to DRM implementation. Sets the value of the KEYFORMAT attribute. Must be 'identity' or a reverse DNS string. May be omitted to indicate an implicit value of 'identity'." + }, + "KeyFormatVersions": { + "shape": "__stringPatternDD", + "locationName": "keyFormatVersions", + "documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3)." + }, + "StaticKeyValue": { + "shape": "__stringPatternAZaZ0932", + "locationName": "staticKeyValue", + "documentation": "Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue)." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "Relates to DRM implementation. The location of the license server used for protecting content." + } + }, + "documentation": "Use these settings to set up encryption with a static key provider." + }, + "StatusUpdateInterval": { + "type": "string", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "enum": [ + "SECONDS_10", + "SECONDS_12", + "SECONDS_15", + "SECONDS_20", + "SECONDS_30", + "SECONDS_60", + "SECONDS_120", + "SECONDS_180", + "SECONDS_240", + "SECONDS_300", + "SECONDS_360", + "SECONDS_420", + "SECONDS_480", + "SECONDS_540", + "SECONDS_600" + ] + }, + "TagResourceRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name." + }, + "Tags": { + "shape": "__mapOf__string", + "locationName": "tags", + "documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key." + } + }, + "required": [ + "Arn", + "Tags" + ] + }, + "TagResourceResponse": { + "type": "structure", + "members": { + } + }, + "TeletextDestinationSettings": { + "type": "structure", + "members": { + "PageNumber": { + "shape": "__stringMin3Max3Pattern1809aFAF09aEAE", + "locationName": "pageNumber", + "documentation": "Set pageNumber to the Teletext page number for the destination captions for this output. This value must be a three-digit hexadecimal string; strings ending in -FF are invalid. If you are passing through the entire set of Teletext data, do not use this field." + }, + "PageTypes": { + "shape": "__listOfTeletextPageType", + "locationName": "pageTypes", + "documentation": "Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input." + } + }, + "documentation": "Settings for Teletext caption output" + }, + "TeletextPageType": { + "type": "string", + "documentation": "A page type as defined in the standard ETSI EN 300 468, Table 94", + "enum": [ + "PAGE_TYPE_INITIAL", + "PAGE_TYPE_SUBTITLE", + "PAGE_TYPE_ADDL_INFO", + "PAGE_TYPE_PROGRAM_SCHEDULE", + "PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE" + ] + }, + "TeletextSourceSettings": { + "type": "structure", + "members": { + "PageNumber": { + "shape": "__stringMin3Max3Pattern1809aFAF09aEAE", + "locationName": "pageNumber", + "documentation": "Use Page Number (PageNumber) to specify the three-digit hexadecimal page number that will be used for Teletext captions. Do not use this setting if you are passing through teletext from the input source to output." + } + }, + "documentation": "Settings specific to Teletext caption sources, including Page number." + }, + "TimecodeBurnin": { + "type": "structure", + "members": { + "FontSize": { + "shape": "__integerMin10Max48", + "locationName": "fontSize", + "documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48." + }, + "Position": { + "shape": "TimecodeBurninPosition", + "locationName": "position", + "documentation": "Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video." + }, + "Prefix": { + "shape": "__stringPattern", + "locationName": "prefix", + "documentation": "Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of \"EZ-\" will result in the timecode \"EZ-00:00:00:00\". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard." + } + }, + "documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output." + }, + "TimecodeBurninPosition": { + "type": "string", + "documentation": "Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to specify the location the burned-in timecode on output video.", + "enum": [ + "TOP_CENTER", + "TOP_LEFT", + "TOP_RIGHT", + "MIDDLE_LEFT", + "MIDDLE_CENTER", + "MIDDLE_RIGHT", + "BOTTOM_LEFT", + "BOTTOM_CENTER", + "BOTTOM_RIGHT" + ] + }, + "TimecodeConfig": { + "type": "structure", + "members": { + "Anchor": { + "shape": "__stringPattern010920405090509092", + "locationName": "anchor", + "documentation": "If you use an editing platform that relies on an anchor timecode, use Anchor Timecode (Anchor) to specify a timecode that will match the input video frame to the output video frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF). This setting ignores frame rate conversion. System behavior for Anchor Timecode varies depending on your setting for Source (TimecodeSource). * If Source (TimecodeSource) is set to Specified Start (SPECIFIEDSTART), the first input frame is the specified value in Start Timecode (Start). Anchor Timecode (Anchor) and Start Timecode (Start) are used calculate output timecode. * If Source (TimecodeSource) is set to Start at 0 (ZEROBASED) the first frame is 00:00:00:00. * If Source (TimecodeSource) is set to Embedded (EMBEDDED), the first frame is the timecode value on the first input frame of the input." + }, + "Source": { + "shape": "TimecodeSource", + "locationName": "source", + "documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value." + }, + "Start": { + "shape": "__stringPattern010920405090509092", + "locationName": "start", + "documentation": "Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF)." + }, + "TimestampOffset": { + "shape": "__stringPattern0940191020191209301", + "locationName": "timestampOffset", + "documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25." + } + }, + "documentation": "These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping." + }, + "TimecodeSource": { + "type": "string", + "documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.", + "enum": [ + "EMBEDDED", + "ZEROBASED", + "SPECIFIEDSTART" + ] + }, + "TimedMetadata": { + "type": "string", + "documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "enum": [ + "PASSTHROUGH", + "NONE" + ] + }, + "TimedMetadataInsertion": { + "type": "structure", + "members": { + "Id3Insertions": { + "shape": "__listOfId3Insertion", + "locationName": "id3Insertions", + "documentation": "Id3Insertions contains the array of Id3Insertion instances." + } + }, + "documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects." + }, + "Timing": { + "type": "structure", + "members": { + "FinishTime": { + "shape": "__timestampUnix", + "locationName": "finishTime", + "documentation": "The time, in Unix epoch format, that the transcoding job finished" + }, + "StartTime": { + "shape": "__timestampUnix", + "locationName": "startTime", + "documentation": "The time, in Unix epoch format, that transcoding for the job began." + }, + "SubmitTime": { + "shape": "__timestampUnix", + "locationName": "submitTime", + "documentation": "The time, in Unix epoch format, that you submitted the job." + } + }, + "documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds." + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 429 + }, + "documentation": "Too many requests have been sent in too short of a time. The service limits the rate at which it will accept requests." + }, + "TrackSourceSettings": { + "type": "structure", + "members": { + "TrackNumber": { + "shape": "__integerMin1Max2147483647", + "locationName": "trackNumber", + "documentation": "Use this setting to select a single captions track from a source. Track numbers correspond to the order in the captions source file. For IMF sources, track numbering is based on the order that the captions appear in the CPL. For example, use 1 to select the captions asset that is listed first in the CPL. To include more than one captions track in your job outputs, create multiple input captions selectors. Specify one track per selector." + } + }, + "documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings." + }, + "TtmlDestinationSettings": { + "type": "structure", + "members": { + "StylePassthrough": { + "shape": "TtmlStylePassthrough", + "locationName": "stylePassthrough", + "documentation": "Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output." + } + }, + "documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough)." + }, + "TtmlStylePassthrough": { + "type": "string", + "documentation": "Pass through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output.", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "Type": { + "type": "string", + "enum": [ + "SYSTEM", + "CUSTOM" + ] + }, + "UntagResourceRequest": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.", + "location": "uri" + }, + "TagKeys": { + "shape": "__listOf__string", + "locationName": "tagKeys", + "documentation": "The keys of the tags that you want to remove from the resource." + } + }, + "required": [ + "Arn" + ] + }, + "UntagResourceResponse": { + "type": "structure", + "members": { + } + }, + "UpdateJobTemplateRequest": { + "type": "structure", + "members": { + "AccelerationSettings": { + "shape": "AccelerationSettings", + "locationName": "accelerationSettings", + "documentation": "Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide." + }, + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "The new category for the job template, if you are changing it." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "The new description for the job template, if you are changing it." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the job template you are modifying", + "location": "uri" + }, + "Priority": { + "shape": "__integerMinNegative50Max50", + "locationName": "priority", + "documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0." + }, + "Queue": { + "shape": "__string", + "locationName": "queue", + "documentation": "The new queue for the job template, if you are changing it." + }, + "Settings": { + "shape": "JobTemplateSettings", + "locationName": "settings", + "documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it." + }, + "StatusUpdateInterval": { + "shape": "StatusUpdateInterval", + "locationName": "statusUpdateInterval", + "documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error." + } + }, + "required": [ + "Name" + ] + }, + "UpdateJobTemplateResponse": { + "type": "structure", + "members": { + "JobTemplate": { + "shape": "JobTemplate", + "locationName": "jobTemplate", + "documentation": "A job template is a pre-made set of encoding instructions that you can use to quickly create a job." + } + } + }, + "UpdatePresetRequest": { + "type": "structure", + "members": { + "Category": { + "shape": "__string", + "locationName": "category", + "documentation": "The new category for the preset, if you are changing it." + }, + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "The new description for the preset, if you are changing it." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the preset you are modifying.", + "location": "uri" + }, + "Settings": { + "shape": "PresetSettings", + "locationName": "settings", + "documentation": "Settings for preset" + } + }, + "required": [ + "Name" + ] + }, + "UpdatePresetResponse": { + "type": "structure", + "members": { + "Preset": { + "shape": "Preset", + "locationName": "preset", + "documentation": "A preset is a collection of preconfigured media conversion settings that you want MediaConvert to apply to the output during the conversion process." + } + } + }, + "UpdateQueueRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "__string", + "locationName": "description", + "documentation": "The new description for the queue, if you are changing it." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the queue that you are modifying.", + "location": "uri" + }, + "ReservationPlanSettings": { + "shape": "ReservationPlanSettings", + "locationName": "reservationPlanSettings", + "documentation": "The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them." + }, + "Status": { + "shape": "QueueStatus", + "locationName": "status", + "documentation": "Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error." + } + }, + "required": [ + "Name" + ] + }, + "UpdateQueueResponse": { + "type": "structure", + "members": { + "Queue": { + "shape": "Queue", + "locationName": "queue", + "documentation": "You can use queues to manage the resources that are available to your AWS account for running multiple transcoding jobs at the same time. If you don't specify a queue, the service sends all jobs through the default queue. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/working-with-queues.html." + } + } + }, + "VideoCodec": { + "type": "string", + "documentation": "Type of video codec", + "enum": [ + "FRAME_CAPTURE", + "H_264", + "H_265", + "MPEG2", + "PRORES" + ] + }, + "VideoCodecSettings": { + "type": "structure", + "members": { + "Codec": { + "shape": "VideoCodec", + "locationName": "codec", + "documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec." + }, + "FrameCaptureSettings": { + "shape": "FrameCaptureSettings", + "locationName": "frameCaptureSettings", + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE." + }, + "H264Settings": { + "shape": "H264Settings", + "locationName": "h264Settings", + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264." + }, + "H265Settings": { + "shape": "H265Settings", + "locationName": "h265Settings", + "documentation": "Settings for H265 codec" + }, + "Mpeg2Settings": { + "shape": "Mpeg2Settings", + "locationName": "mpeg2Settings", + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2." + }, + "ProresSettings": { + "shape": "ProresSettings", + "locationName": "proresSettings", + "documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES." + } + }, + "documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings" + }, + "VideoDescription": { + "type": "structure", + "members": { + "AfdSignaling": { + "shape": "AfdSignaling", + "locationName": "afdSignaling", + "documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data." + }, + "AntiAlias": { + "shape": "AntiAlias", + "locationName": "antiAlias", + "documentation": "The anti-alias filter is automatically applied to all outputs. The service no longer accepts the value DISABLED for AntiAlias. If you specify that in your job, the service will ignore the setting." + }, + "CodecSettings": { + "shape": "VideoCodecSettings", + "locationName": "codecSettings", + "documentation": "Video codec settings, (CodecSettings) under (VideoDescription), contains the group of settings related to video encoding. The settings in this group vary depending on the value that you choose for Video codec (Codec). For each codec enum that you choose, define the corresponding settings object. The following lists the codec enum, settings object pairs. * H_264, H264Settings * H_265, H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * FRAME_CAPTURE, FrameCaptureSettings" + }, + "ColorMetadata": { + "shape": "ColorMetadata", + "locationName": "colorMetadata", + "documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default." + }, + "Crop": { + "shape": "Rectangle", + "locationName": "crop", + "documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame." + }, + "DropFrameTimecode": { + "shape": "DropFrameTimecode", + "locationName": "dropFrameTimecode", + "documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled." + }, + "FixedAfd": { + "shape": "__integerMin0Max15", + "locationName": "fixedAfd", + "documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output." + }, + "Height": { + "shape": "__integerMin32Max4096", + "locationName": "height", + "documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height." + }, + "Position": { + "shape": "Rectangle", + "locationName": "position", + "documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black." + }, + "RespondToAfd": { + "shape": "RespondToAfd", + "locationName": "respondToAfd", + "documentation": "Use Respond to AFD (RespondToAfd) to specify how the service changes the video itself in response to AFD values in the input. * Choose Respond to clip the input video frame according to the AFD value, input display aspect ratio, and output display aspect ratio. * Choose Passthrough to include the input AFD values. Do not choose this when AfdSignaling is set to (NONE). A preferred implementation of this workflow is to set RespondToAfd to (NONE) and set AfdSignaling to (AUTO). * Choose None to remove all input AFD values from this output." + }, + "ScalingBehavior": { + "shape": "ScalingBehavior", + "locationName": "scalingBehavior", + "documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output." + }, + "Sharpness": { + "shape": "__integerMin0Max100", + "locationName": "sharpness", + "documentation": "Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content." + }, + "TimecodeInsertion": { + "shape": "VideoTimecodeInsertion", + "locationName": "timecodeInsertion", + "documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does." + }, + "VideoPreprocessors": { + "shape": "VideoPreprocessor", + "locationName": "videoPreprocessors", + "documentation": "Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default." + }, + "Width": { + "shape": "__integerMin32Max4096", + "locationName": "width", + "documentation": "Use Width (Width) to define the video resolution width, in pixels, for this output. If you don't provide a value here, the service will use the input width." + } + }, + "documentation": "Settings for video outputs" + }, + "VideoDetail": { + "type": "structure", + "members": { + "HeightInPx": { + "shape": "__integer", + "locationName": "heightInPx", + "documentation": "Height in pixels for the output" + }, + "WidthInPx": { + "shape": "__integer", + "locationName": "widthInPx", + "documentation": "Width in pixels for the output" + } + }, + "documentation": "Contains details about the output's video stream" + }, + "VideoPreprocessor": { + "type": "structure", + "members": { + "ColorCorrector": { + "shape": "ColorCorrector", + "locationName": "colorCorrector", + "documentation": "Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default." + }, + "Deinterlacer": { + "shape": "Deinterlacer", + "locationName": "deinterlacer", + "documentation": "Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture." + }, + "ImageInserter": { + "shape": "ImageInserter", + "locationName": "imageInserter", + "documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default." + }, + "NoiseReducer": { + "shape": "NoiseReducer", + "locationName": "noiseReducer", + "documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default." + }, + "TimecodeBurnin": { + "shape": "TimecodeBurnin", + "locationName": "timecodeBurnin", + "documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output." + } + }, + "documentation": "Find additional transcoding features under Preprocessors (VideoPreprocessors). Enable the features at each output individually. These features are disabled by default." + }, + "VideoSelector": { + "type": "structure", + "members": { + "ColorSpace": { + "shape": "ColorSpace", + "locationName": "colorSpace", + "documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr." + }, + "ColorSpaceUsage": { + "shape": "ColorSpaceUsage", + "locationName": "colorSpaceUsage", + "documentation": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings." + }, + "Hdr10Metadata": { + "shape": "Hdr10Metadata", + "locationName": "hdr10Metadata", + "documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr." + }, + "Pid": { + "shape": "__integerMin1Max2147483647", + "locationName": "pid", + "documentation": "Use PID (Pid) to select specific video data from an input file. Specify this value as an integer; the system automatically converts it to the hexidecimal value. For example, 257 selects PID 0x101. A PID, or packet identifier, is an identifier for a set of data in an MPEG-2 transport stream container." + }, + "ProgramNumber": { + "shape": "__integerMinNegative2147483648Max2147483647", + "locationName": "programNumber", + "documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported." + }, + "Rotate": { + "shape": "InputRotate", + "locationName": "rotate", + "documentation": "Use Rotate (InputRotate) to specify how the service rotates your video. You can choose automatic rotation or specify a rotation. You can specify a clockwise rotation of 0, 90, 180, or 270 degrees. If your input video container is .mov or .mp4 and your input has rotation metadata, you can choose Automatic to have the service rotate your video according to the rotation specified in the metadata. The rotation must be within one degree of 90, 180, or 270 degrees. If the rotation metadata specifies any other rotation, the service will default to no rotation. By default, the service does no rotation, even if your input video has rotation metadata. The service doesn't pass through rotation metadata." + } + }, + "documentation": "Selector for video." + }, + "VideoTimecodeInsertion": { + "type": "string", + "documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.", + "enum": [ + "DISABLED", + "PIC_TIMING_SEI" + ] + }, + "WavFormat": { + "type": "string", + "documentation": "The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64.", + "enum": [ + "RIFF", + "RF64" + ] + }, + "WavSettings": { + "type": "structure", + "members": { + "BitDepth": { + "shape": "__integerMin16Max24", + "locationName": "bitDepth", + "documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track." + }, + "Channels": { + "shape": "__integerMin1Max64", + "locationName": "channels", + "documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64." + }, + "Format": { + "shape": "WavFormat", + "locationName": "format", + "documentation": "The service defaults to using RIFF for WAV outputs. If your output audio is likely to exceed 4 GB in file size, or if you otherwise need the extended support of the RF64 format, set your output WAV file format to RF64." + }, + "SampleRate": { + "shape": "__integerMin8000Max192000", + "locationName": "sampleRate", + "documentation": "Sample rate in Hz." + } + }, + "documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV." + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__doubleMin0": { + "type": "double" + }, + "__doubleMin0Max2147483647": { + "type": "double" + }, + "__doubleMinNegative59Max0": { + "type": "double" + }, + "__doubleMinNegative60Max3": { + "type": "double" + }, + "__doubleMinNegative60MaxNegative1": { + "type": "double" + }, + "__doubleMinNegative6Max3": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__integerMin0Max0": { + "type": "integer", + "min": 0, + "max": 0 + }, + "__integerMin0Max10": { + "type": "integer", + "min": 0, + "max": 10 + }, + "__integerMin0Max100": { + "type": "integer", + "min": 0, + "max": 100 + }, + "__integerMin0Max1000": { + "type": "integer", + "min": 0, + "max": 1000 + }, + "__integerMin0Max10000": { + "type": "integer", + "min": 0, + "max": 10000 + }, + "__integerMin0Max1152000000": { + "type": "integer", + "min": 0, + "max": 1152000000 + }, + "__integerMin0Max128": { + "type": "integer", + "min": 0, + "max": 128 + }, + "__integerMin0Max1466400000": { + "type": "integer", + "min": 0, + "max": 1466400000 + }, + "__integerMin0Max15": { + "type": "integer", + "min": 0, + "max": 15 + }, + "__integerMin0Max16": { + "type": "integer", + "min": 0, + "max": 16 + }, + "__integerMin0Max2147483647": { + "type": "integer", + "min": 0, + "max": 2147483647 + }, + "__integerMin0Max255": { + "type": "integer", + "min": 0, + "max": 255 + }, + "__integerMin0Max3": { + "type": "integer", + "min": 0, + "max": 3 + }, + "__integerMin0Max30": { + "type": "integer", + "min": 0, + "max": 30 + }, + "__integerMin0Max30000": { + "type": "integer", + "min": 0, + "max": 30000 + }, + "__integerMin0Max3600": { + "type": "integer", + "min": 0, + "max": 3600 + }, + "__integerMin0Max4": { + "type": "integer", + "min": 0, + "max": 4 + }, + "__integerMin0Max47185920": { + "type": "integer", + "min": 0, + "max": 47185920 + }, + "__integerMin0Max500": { + "type": "integer", + "min": 0, + "max": 500 + }, + "__integerMin0Max50000": { + "type": "integer", + "min": 0, + "max": 50000 + }, + "__integerMin0Max65535": { + "type": "integer", + "min": 0, + "max": 65535 + }, + "__integerMin0Max7": { + "type": "integer", + "min": 0, + "max": 7 + }, + "__integerMin0Max8": { + "type": "integer", + "min": 0, + "max": 8 + }, + "__integerMin0Max96": { + "type": "integer", + "min": 0, + "max": 96 + }, + "__integerMin0Max99": { + "type": "integer", + "min": 0, + "max": 99 + }, + "__integerMin1000Max1152000000": { + "type": "integer", + "min": 1000, + "max": 1152000000 + }, + "__integerMin1000Max1466400000": { + "type": "integer", + "min": 1000, + "max": 1466400000 + }, + "__integerMin1000Max288000000": { + "type": "integer", + "min": 1000, + "max": 288000000 + }, + "__integerMin1000Max30000": { + "type": "integer", + "min": 1000, + "max": 30000 + }, + "__integerMin1000Max300000000": { + "type": "integer", + "min": 1000, + "max": 300000000 + }, + "__integerMin10Max48": { + "type": "integer", + "min": 10, + "max": 48 + }, + "__integerMin16Max24": { + "type": "integer", + "min": 16, + "max": 24 + }, + "__integerMin1Max1": { + "type": "integer", + "min": 1, + "max": 1 + }, + "__integerMin1Max10": { + "type": "integer", + "min": 1, + "max": 10 + }, + "__integerMin1Max100": { + "type": "integer", + "min": 1, + "max": 100 + }, + "__integerMin1Max10000000": { + "type": "integer", + "min": 1, + "max": 10000000 + }, + "__integerMin1Max1001": { + "type": "integer", + "min": 1, + "max": 1001 + }, + "__integerMin1Max17895697": { + "type": "integer", + "min": 1, + "max": 17895697 + }, + "__integerMin1Max2": { + "type": "integer", + "min": 1, + "max": 2 + }, + "__integerMin1Max20": { + "type": "integer", + "min": 1, + "max": 20 + }, + "__integerMin1Max2147483640": { + "type": "integer", + "min": 1, + "max": 2147483640 + }, + "__integerMin1Max2147483647": { + "type": "integer", + "min": 1, + "max": 2147483647 + }, + "__integerMin1Max31": { + "type": "integer", + "min": 1, + "max": 31 + }, + "__integerMin1Max32": { + "type": "integer", + "min": 1, + "max": 32 + }, + "__integerMin1Max4": { + "type": "integer", + "min": 1, + "max": 4 + }, + "__integerMin1Max6": { + "type": "integer", + "min": 1, + "max": 6 + }, + "__integerMin1Max64": { + "type": "integer", + "min": 1, + "max": 64 + }, + "__integerMin24Max60000": { + "type": "integer", + "min": 24, + "max": 60000 + }, + "__integerMin25Max10000": { + "type": "integer", + "min": 25, + "max": 10000 + }, + "__integerMin25Max2000": { + "type": "integer", + "min": 25, + "max": 2000 + }, + "__integerMin2Max2147483647": { + "type": "integer", + "min": 2, + "max": 2147483647 + }, + "__integerMin32000Max384000": { + "type": "integer", + "min": 32000, + "max": 384000 + }, + "__integerMin32000Max48000": { + "type": "integer", + "min": 32000, + "max": 48000 + }, + "__integerMin32Max4096": { + "type": "integer", + "min": 32, + "max": 4096 + }, + "__integerMin32Max8182": { + "type": "integer", + "min": 32, + "max": 8182 + }, + "__integerMin384000Max768000": { + "type": "integer", + "min": 384000, + "max": 768000 + }, + "__integerMin48000Max48000": { + "type": "integer", + "min": 48000, + "max": 48000 + }, + "__integerMin6000Max1024000": { + "type": "integer", + "min": 6000, + "max": 1024000 + }, + "__integerMin64000Max640000": { + "type": "integer", + "min": 64000, + "max": 640000 + }, + "__integerMin8000Max192000": { + "type": "integer", + "min": 8000, + "max": 192000 + }, + "__integerMin8000Max96000": { + "type": "integer", + "min": 8000, + "max": 96000 + }, + "__integerMin96Max600": { + "type": "integer", + "min": 96, + "max": 600 + }, + "__integerMinNegative1000Max1000": { + "type": "integer", + "min": -1000, + "max": 1000 + }, + "__integerMinNegative180Max180": { + "type": "integer", + "min": -180, + "max": 180 + }, + "__integerMinNegative1Max3": { + "type": "integer", + "min": -1, + "max": 3 + }, + "__integerMinNegative2147483648Max2147483647": { + "type": "integer", + "min": -2147483648, + "max": 2147483647 + }, + "__integerMinNegative2Max3": { + "type": "integer", + "min": -2, + "max": 3 + }, + "__integerMinNegative50Max50": { + "type": "integer", + "min": -50, + "max": 50 + }, + "__integerMinNegative5Max5": { + "type": "integer", + "min": -5, + "max": 5 + }, + "__integerMinNegative60Max6": { + "type": "integer", + "min": -60, + "max": 6 + }, + "__integerMinNegative70Max0": { + "type": "integer", + "min": -70, + "max": 0 + }, + "__listOfAudioDescription": { + "type": "list", + "member": { + "shape": "AudioDescription" + } + }, + "__listOfCaptionDescription": { + "type": "list", + "member": { + "shape": "CaptionDescription" + } + }, + "__listOfCaptionDescriptionPreset": { + "type": "list", + "member": { + "shape": "CaptionDescriptionPreset" + } + }, + "__listOfEndpoint": { + "type": "list", + "member": { + "shape": "Endpoint" + } + }, + "__listOfHlsAdMarkers": { + "type": "list", + "member": { + "shape": "HlsAdMarkers" + } + }, + "__listOfHlsCaptionLanguageMapping": { + "type": "list", + "member": { + "shape": "HlsCaptionLanguageMapping" + } + }, + "__listOfId3Insertion": { + "type": "list", + "member": { + "shape": "Id3Insertion" + } + }, + "__listOfInput": { + "type": "list", + "member": { + "shape": "Input" + } + }, + "__listOfInputClipping": { + "type": "list", + "member": { + "shape": "InputClipping" + } + }, + "__listOfInputTemplate": { + "type": "list", + "member": { + "shape": "InputTemplate" + } + }, + "__listOfInsertableImage": { + "type": "list", + "member": { + "shape": "InsertableImage" + } + }, + "__listOfJob": { + "type": "list", + "member": { + "shape": "Job" + } + }, + "__listOfJobTemplate": { + "type": "list", + "member": { + "shape": "JobTemplate" + } + }, + "__listOfOutput": { + "type": "list", + "member": { + "shape": "Output" + } + }, + "__listOfOutputChannelMapping": { + "type": "list", + "member": { + "shape": "OutputChannelMapping" + } + }, + "__listOfOutputDetail": { + "type": "list", + "member": { + "shape": "OutputDetail" + } + }, + "__listOfOutputGroup": { + "type": "list", + "member": { + "shape": "OutputGroup" + } + }, + "__listOfOutputGroupDetail": { + "type": "list", + "member": { + "shape": "OutputGroupDetail" + } + }, + "__listOfPreset": { + "type": "list", + "member": { + "shape": "Preset" + } + }, + "__listOfQueue": { + "type": "list", + "member": { + "shape": "Queue" + } + }, + "__listOfTeletextPageType": { + "type": "list", + "member": { + "shape": "TeletextPageType" + } + }, + "__listOf__integerMin1Max2147483647": { + "type": "list", + "member": { + "shape": "__integerMin1Max2147483647" + } + }, + "__listOf__integerMin32Max8182": { + "type": "list", + "member": { + "shape": "__integerMin32Max8182" + } + }, + "__listOf__integerMinNegative60Max6": { + "type": "list", + "member": { + "shape": "__integerMinNegative60Max6" + } + }, + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" + } + }, + "__listOf__stringMin1": { + "type": "list", + "member": { + "shape": "__stringMin1" + } + }, + "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "list", + "member": { + "shape": "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12" + } + }, + "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "list", + "member": { + "shape": "__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12" + } + }, + "__listOf__stringPatternS3ASSETMAPXml": { + "type": "list", + "member": { + "shape": "__stringPatternS3ASSETMAPXml" + } + }, + "__mapOfAudioSelector": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "AudioSelector" + } + }, + "__mapOfAudioSelectorGroup": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "AudioSelectorGroup" + } + }, + "__mapOfCaptionSelector": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "CaptionSelector" + } + }, + "__mapOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + }, + "__stringMin0": { + "type": "string", + "min": 0 + }, + "__stringMin1": { + "type": "string", + "min": 1 + }, + "__stringMin11Max11Pattern01D20305D205D": { + "type": "string", + "min": 11, + "max": 11, + "pattern": "^((([0-1]\\d)|(2[0-3]))(:[0-5]\\d){2}([:;][0-5]\\d))$" + }, + "__stringMin14Max1285PatternHttpHttpsS3Mov09Png": { + "type": "string", + "min": 14, + "max": 1285, + "pattern": "^(http|https|s3)://(.*)(\\.mov|[0-9]+\\.png)$" + }, + "__stringMin14PatternHttpHttpsS3BmpBMPPngPNG": { + "type": "string", + "min": 14, + "pattern": "^(http|https|s3)://(.*?)\\.(bmp|BMP|png|PNG)$" + }, + "__stringMin14PatternHttpHttpsS3BmpBMPPngPNGTgaTGA": { + "type": "string", + "min": 14, + "pattern": "^(http|https|s3)://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)$" + }, + "__stringMin14PatternHttpHttpsS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI": { + "type": "string", + "min": 14, + "pattern": "^(http|https|s3)://(.*?)\\.(scc|SCC|ttml|TTML|dfxp|DFXP|stl|STL|srt|SRT|xml|XML|smi|SMI)$" + }, + "__stringMin16Max24PatternAZaZ0922AZaZ0916": { + "type": "string", + "min": 16, + "max": 24, + "pattern": "^[A-Za-z0-9+\\/]{22}==$|^[A-Za-z0-9+\\/]{16}$" + }, + "__stringMin1Max256": { + "type": "string", + "min": 1, + "max": 256 + }, + "__stringMin24Max512PatternAZaZ0902": { + "type": "string", + "min": 24, + "max": 512, + "pattern": "^[A-Za-z0-9+\\/]+={0,2}$" + }, + "__stringMin32Max32Pattern09aFAF32": { + "type": "string", + "min": 32, + "max": 32, + "pattern": "^[0-9a-fA-F]{32}$" + }, + "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "string", + "min": 36, + "max": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "__stringMin3Max3Pattern1809aFAF09aEAE": { + "type": "string", + "min": 3, + "max": 3, + "pattern": "^[1-8][0-9a-fA-F][0-9a-eA-E]$" + }, + "__stringMin3Max3PatternAZaZ3": { + "type": "string", + "min": 3, + "max": 3, + "pattern": "^[A-Za-z]{3}$" + }, + "__stringMin9Max19PatternAZ26EastWestCentralNorthSouthEastWest1912": { + "type": "string", + "min": 9, + "max": 19, + "pattern": "^[a-z-]{2,6}-(east|west|central|((north|south)(east|west)?))-[1-9]{1,2}$" + }, + "__stringPattern": { + "type": "string", + "pattern": "^[ -~]+$" + }, + "__stringPattern010920405090509092": { + "type": "string", + "pattern": "^([01][0-9]|2[0-4]):[0-5][0-9]:[0-5][0-9][:;][0-9]{2}$" + }, + "__stringPattern01D20305D205D": { + "type": "string", + "pattern": "^((([0-1]\\d)|(2[0-3]))(:[0-5]\\d){2}([:;][0-5]\\d))$" + }, + "__stringPattern0940191020191209301": { + "type": "string", + "pattern": "^([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$" + }, + "__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "string", + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "__stringPatternAZaZ0902": { + "type": "string", + "pattern": "^[A-Za-z0-9+\\/]+={0,2}$" + }, + "__stringPatternAZaZ0932": { + "type": "string", + "pattern": "^[A-Za-z0-9]{32}$" + }, + "__stringPatternArnAwsUsGovAcm": { + "type": "string", + "pattern": "^arn:aws(-us-gov)?:acm:" + }, + "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912": { + "type": "string", + "pattern": "^arn:aws(-us-gov|-cn)?:kms:[a-z-]{2,6}-(east|west|central|((north|south)(east|west)?))-[1-9]{1,2}:\\d{12}:key/[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" + }, + "__stringPatternDD": { + "type": "string", + "pattern": "^(\\d+(\\/\\d+)*)$" + }, + "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { + "type": "string", + "pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$" + }, + "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { + "type": "string", + "pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$" + }, + "__stringPatternHttps": { + "type": "string", + "pattern": "^https:\\/\\/" + }, + "__stringPatternIdentityAZaZ26AZaZ09163": { + "type": "string", + "pattern": "^(identity|[A-Za-z]{2,6}(\\.[A-Za-z0-9-]{1,63})+)$" + }, + "__stringPatternS3": { + "type": "string", + "pattern": "^s3:\\/\\/" + }, + "__stringPatternS3ASSETMAPXml": { + "type": "string", + "pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$" + }, + "__stringPatternSNManifestConfirmConditionNotificationNS": { + "type": "string", + "pattern": "^\\s*<(.|\\n)*ManifestConfirmConditionNotification(.|\\n)*>\\s*$" + }, + "__stringPatternSNSignalProcessingNotificationNS": { + "type": "string", + "pattern": "^\\s*<(.|\\n)*SignalProcessingNotification(.|\\n)*>\\s*$" + }, + "__stringPatternW": { + "type": "string", + "pattern": "^[\\w-]+$" + }, + "__stringPatternWS": { + "type": "string", + "pattern": "^[\\w\\s]*$" + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" + } + }, + "documentation": "AWS Elemental MediaConvert" +} \ No newline at end of file diff --git a/aws/dist/botocore/data/medialive/2017-10-14/paginators-1.json b/aws/dist/botocore/data/medialive/2017-10-14/paginators-1.json new file mode 100644 index 00000000..e0a675bc --- /dev/null +++ b/aws/dist/botocore/data/medialive/2017-10-14/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListInputs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Inputs" + }, + "ListChannels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Channels" + }, + "ListInputSecurityGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InputSecurityGroups" + }, + "ListOfferings": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Offerings" + }, + "ListReservations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Reservations" + }, + "DescribeSchedule": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ScheduleActions" + } + } +} diff --git a/aws/dist/botocore/data/medialive/2017-10-14/service-2.json b/aws/dist/botocore/data/medialive/2017-10-14/service-2.json new file mode 100644 index 00000000..ce5c77b6 --- /dev/null +++ b/aws/dist/botocore/data/medialive/2017-10-14/service-2.json @@ -0,0 +1,10739 @@ +{ + "metadata": { + "apiVersion": "2017-10-14", + "endpointPrefix": "medialive", + "signingName": "medialive", + "serviceFullName": "AWS Elemental MediaLive", + "serviceId": "MediaLive", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "medialive-2017-10-14", + "signatureVersion": "v4", + "serviceAbbreviation": "MediaLive" + }, + "operations": { + "BatchUpdateSchedule": { + "name": "BatchUpdateSchedule", + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "shape": "BatchUpdateScheduleRequest" + }, + "output": { + "shape": "BatchUpdateScheduleResponse", + "documentation": "Successful update of the schedule." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "UnprocessableEntityException", + "documentation": "The update schedule request failed validation." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to update the channel schedule." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The specified channel id does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on update schedule calls." + } + ], + "documentation": "Update a channel schedule" + }, + "CreateChannel": { + "name": "CreateChannel", + "http": { + "method": "POST", + "requestUri": "/prod/channels", + "responseCode": 201 + }, + "input": { + "shape": "CreateChannelRequest" + }, + "output": { + "shape": "CreateChannelResponse", + "documentation": "Creation of channel is started." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "UnprocessableEntityException", + "documentation": "The Channel failed validation and could not be created." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to create the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on create channel calls to channel service." + }, + { + "shape": "ConflictException", + "documentation": "The channel is unable to create due to an issue with channel resources." + } + ], + "documentation": "Creates a new channel" + }, + "CreateInput": { + "name": "CreateInput", + "http": { + "method": "POST", + "requestUri": "/prod/inputs", + "responseCode": 201 + }, + "input": { + "shape": "CreateInputRequest" + }, + "output": { + "shape": "CreateInputResponse", + "documentation": "Successfully created the input." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit exceeded" + } + ], + "documentation": "Create an input" + }, + "CreateInputSecurityGroup": { + "name": "CreateInputSecurityGroup", + "http": { + "method": "POST", + "requestUri": "/prod/inputSecurityGroups", + "responseCode": 200 + }, + "input": { + "shape": "CreateInputSecurityGroupRequest" + }, + "output": { + "shape": "CreateInputSecurityGroupResponse", + "documentation": "Successfully created the Input Security Group." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request to create an Input Security Group was Invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Server Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to create an Input Security Group" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit Exceeded Error" + } + ], + "documentation": "Creates a Input Security Group" + }, + "CreateTags": { + "name": "CreateTags", + "http": { + "method": "POST", + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "CreateTagsRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The arn was not found." + }, + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + } + ], + "documentation": "Create tags for a resource" + }, + "DeleteChannel": { + "name": "DeleteChannel", + "http": { + "method": "DELETE", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteChannelRequest" + }, + "output": { + "shape": "DeleteChannelResponse", + "documentation": "Deletion was successfully initiated." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to delete the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting to delete does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on delete channel calls to channel service." + }, + { + "shape": "ConflictException", + "documentation": "The channel is unable to delete due to an issue with channel resources." + } + ], + "documentation": "Starts deletion of channel. The associated outputs are also deleted." + }, + "DeleteInput": { + "name": "DeleteInput", + "http": { + "method": "DELETE", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteInputRequest" + }, + "output": { + "shape": "DeleteInputResponse", + "documentation": "Successful deletion" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "Input not found" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit exceeded" + }, + { + "shape": "ConflictException", + "documentation": "Resource conflict" + } + ], + "documentation": "Deletes the input end point" + }, + "DeleteInputSecurityGroup": { + "name": "DeleteInputSecurityGroup", + "http": { + "method": "DELETE", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteInputSecurityGroupRequest" + }, + "output": { + "shape": "DeleteInputSecurityGroupResponse", + "documentation": "An Input Security Group" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request to delete the Input Security Group was Invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Server Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to delete this Input Security Group" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "Input Security Group not found" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit Exceeded Error" + } + ], + "documentation": "Deletes an Input Security Group" + }, + "DeleteReservation": { + "name": "DeleteReservation", + "http": { + "method": "DELETE", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteReservationRequest" + }, + "output": { + "shape": "DeleteReservationResponse", + "documentation": "Deleted reservation" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to delete reservation" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "NotFoundException", + "documentation": "Reservation you're attempting to delete does not exist" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on delete reservation request" + }, + { + "shape": "ConflictException", + "documentation": "The reservation could not be deleted because it is currently active." + } + ], + "documentation": "Delete an expired reservation." + }, + "DeleteSchedule": { + "name": "DeleteSchedule", + "http": { + "method": "DELETE", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "shape": "DeleteScheduleRequest" + }, + "output": { + "shape": "DeleteScheduleResponse", + "documentation": "Successful delete of the schedule." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request to delete the schedule on this channel was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to delete the channel schedule." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The specified channel does not exist to have its schedule deleted." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on delete schedule calls." + } + ], + "documentation": "Delete all schedule actions on a channel." + }, + "DeleteTags": { + "name": "DeleteTags", + "http": { + "method": "DELETE", + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteTagsRequest" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The arn was not found." + }, + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + } + ], + "documentation": "Removes tags for a resource" + }, + "DescribeChannel": { + "name": "DescribeChannel", + "http": { + "method": "GET", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeChannelRequest" + }, + "output": { + "shape": "DescribeChannelResponse", + "documentation": "Channel details" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to describe the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting to describe does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on describe channel calls to channel service." + } + ], + "documentation": "Gets details about a channel" + }, + "DescribeInput": { + "name": "DescribeInput", + "http": { + "method": "GET", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeInputRequest" + }, + "output": { + "shape": "DescribeInputResponse", + "documentation": "Input details" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "Input not found" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit exceeded" + } + ], + "documentation": "Produces details about an input" + }, + "DescribeInputSecurityGroup": { + "name": "DescribeInputSecurityGroup", + "http": { + "method": "GET", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeInputSecurityGroupRequest" + }, + "output": { + "shape": "DescribeInputSecurityGroupResponse", + "documentation": "An Input Security Group" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request to describe an Input Security Group was Invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Server Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to describe this Input Security Group" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "Input Security Group not found" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit Exceeded Error" + } + ], + "documentation": "Produces a summary of an Input Security Group" + }, + "DescribeOffering": { + "name": "DescribeOffering", + "http": { + "method": "GET", + "requestUri": "/prod/offerings/{offeringId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeOfferingRequest" + }, + "output": { + "shape": "DescribeOfferingResponse", + "documentation": "Offering details" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to describe offering" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "NotFoundException", + "documentation": "Offering you're attempting to describe does not exist" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on describe offering request" + } + ], + "documentation": "Get details for an offering." + }, + "DescribeReservation": { + "name": "DescribeReservation", + "http": { + "method": "GET", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeReservationRequest" + }, + "output": { + "shape": "DescribeReservationResponse", + "documentation": "Reservation details" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to describe reservation" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "NotFoundException", + "documentation": "Reservation you're attempting to describe does not exist" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on describe reservation request" + } + ], + "documentation": "Get details for a reservation." + }, + "DescribeSchedule": { + "name": "DescribeSchedule", + "http": { + "method": "GET", + "requestUri": "/prod/channels/{channelId}/schedule", + "responseCode": 200 + }, + "input": { + "shape": "DescribeScheduleRequest" + }, + "output": { + "shape": "DescribeScheduleResponse", + "documentation": "An array of channel schedule actions." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to describe the channel schedule." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting a schedule describe for does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on describe schedule calls." + } + ], + "documentation": "Get a channel schedule" + }, + "ListChannels": { + "name": "ListChannels", + "http": { + "method": "GET", + "requestUri": "/prod/channels", + "responseCode": 200 + }, + "input": { + "shape": "ListChannelsRequest" + }, + "output": { + "shape": "ListChannelsResponse", + "documentation": "An array of channels" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to list channels." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on list channel calls to channel service." + } + ], + "documentation": "Produces list of channels that have been created" + }, + "ListInputSecurityGroups": { + "name": "ListInputSecurityGroups", + "http": { + "method": "GET", + "requestUri": "/prod/inputSecurityGroups", + "responseCode": 200 + }, + "input": { + "shape": "ListInputSecurityGroupsRequest" + }, + "output": { + "shape": "ListInputSecurityGroupsResponse", + "documentation": "An array of Input Security Groups" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request to list Input Security Groups was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Server Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to call ListInputSecurityGroups" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit Exceeded Error" + } + ], + "documentation": "Produces a list of Input Security Groups for an account" + }, + "ListInputs": { + "name": "ListInputs", + "http": { + "method": "GET", + "requestUri": "/prod/inputs", + "responseCode": 200 + }, + "input": { + "shape": "ListInputsRequest" + }, + "output": { + "shape": "ListInputsResponse", + "documentation": "An array of inputs" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Limit exceeded" + } + ], + "documentation": "Produces list of inputs that have been created" + }, + "ListOfferings": { + "name": "ListOfferings", + "http": { + "method": "GET", + "requestUri": "/prod/offerings", + "responseCode": 200 + }, + "input": { + "shape": "ListOfferingsRequest" + }, + "output": { + "shape": "ListOfferingsResponse", + "documentation": "List of offerings" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to list offerings" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on list offerings request" + } + ], + "documentation": "List offerings available for purchase." + }, + "ListReservations": { + "name": "ListReservations", + "http": { + "method": "GET", + "requestUri": "/prod/reservations", + "responseCode": 200 + }, + "input": { + "shape": "ListReservationsRequest" + }, + "output": { + "shape": "ListReservationsResponse", + "documentation": "List of reservations" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to list reservations" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on list reservations request" + } + ], + "documentation": "List purchased reservations." + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/prod/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse", + "documentation": "An array of tags" + }, + "errors": [ + { + "shape": "NotFoundException", + "documentation": "The arn was not found" + }, + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "Access was denied" + } + ], + "documentation": "Produces list of tags that have been created for a resource" + }, + "PurchaseOffering": { + "name": "PurchaseOffering", + "http": { + "method": "POST", + "requestUri": "/prod/offerings/{offeringId}/purchase", + "responseCode": 201 + }, + "input": { + "shape": "PurchaseOfferingRequest" + }, + "output": { + "shape": "PurchaseOfferingResponse", + "documentation": "Purchased reservation" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to purchase the offering" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "NotFoundException", + "documentation": "Offering you're attempting to purchase does not exist" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on purchase offering request" + }, + { + "shape": "ConflictException", + "documentation": "Offering purchase prevented by service resource issue" + } + ], + "documentation": "Purchase an offering and create a reservation." + }, + "StartChannel": { + "name": "StartChannel", + "http": { + "method": "POST", + "requestUri": "/prod/channels/{channelId}/start", + "responseCode": 200 + }, + "input": { + "shape": "StartChannelRequest" + }, + "output": { + "shape": "StartChannelResponse", + "documentation": "Successfully initiated start of the channel." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to start the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting to start does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on start channel calls to channel service." + }, + { + "shape": "ConflictException", + "documentation": "The channel is unable to start due to an issue with channel resources." + } + ], + "documentation": "Starts an existing channel" + }, + "StopChannel": { + "name": "StopChannel", + "http": { + "method": "POST", + "requestUri": "/prod/channels/{channelId}/stop", + "responseCode": 200 + }, + "input": { + "shape": "StopChannelRequest" + }, + "output": { + "shape": "StopChannelResponse", + "documentation": "Successfully initiated stop of the channel." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to stop the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're requesting to stop does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on stop channel calls to channel service." + }, + { + "shape": "ConflictException", + "documentation": "The channel is unable to stop due to an issue with channel resources." + } + ], + "documentation": "Stops a running channel" + }, + "UpdateChannel": { + "name": "UpdateChannel", + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateChannelRequest" + }, + "output": { + "shape": "UpdateChannelResponse", + "documentation": "Channel is successfully updated." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid." + }, + { + "shape": "UnprocessableEntityException", + "documentation": "The channel configuration failed validation and could not be updated." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to update the channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "ConflictException", + "documentation": "The channel is unable to update due to an issue with channel resources." + } + ], + "documentation": "Updates a channel." + }, + "UpdateChannelClass": { + "name": "UpdateChannelClass", + "http": { + "method": "PUT", + "requestUri": "/prod/channels/{channelId}/channelClass", + "responseCode": 200 + }, + "input": { + "shape": "UpdateChannelClassRequest" + }, + "output": { + "shape": "UpdateChannelClassResponse", + "documentation": "The class of the channel has been successfully updated." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request to update the channel class was invalid." + }, + { + "shape": "UnprocessableEntityException", + "documentation": "The channel configuration failed validation when attempting to update the channel class." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Unexpected internal service error." + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to update the class of this channel." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The channel you're trying to update the class on does not exist." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded on update channel class calls." + }, + { + "shape": "ConflictException", + "documentation": "The channel class cannot be updated due to an issue with channel resources." + } + ], + "documentation": "Changes the class of the channel." + }, + "UpdateInput": { + "name": "UpdateInput", + "http": { + "method": "PUT", + "requestUri": "/prod/inputs/{inputId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateInputRequest" + }, + "output": { + "shape": "UpdateInputResponse", + "documentation": "The input update is successfully initiated." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request to update the input was invalid." + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Service Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to update an input." + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The input was not found." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "ConflictException", + "documentation": "The input was unable to be updated at this time due to an issue with input resources." + } + ], + "documentation": "Updates an input." + }, + "UpdateInputSecurityGroup": { + "name": "UpdateInputSecurityGroup", + "http": { + "method": "PUT", + "requestUri": "/prod/inputSecurityGroups/{inputSecurityGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateInputSecurityGroupRequest" + }, + "output": { + "shape": "UpdateInputSecurityGroupResponse", + "documentation": "Successfully initiated the update of the Input Security Group." + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "The request to update the Input Security Group was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal Server Error" + }, + { + "shape": "ForbiddenException", + "documentation": "The requester does not have permission to update an Input Security Group" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad Gateway Error" + }, + { + "shape": "NotFoundException", + "documentation": "The Input Security Group was not found." + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway Timeout Error" + }, + { + "shape": "ConflictException", + "documentation": "The Input Security Group was unable to be updated due to an issue with input security group resources." + } + ], + "documentation": "Update an Input Security Group's Whilelists." + }, + "UpdateReservation": { + "name": "UpdateReservation", + "http": { + "method": "PUT", + "requestUri": "/prod/reservations/{reservationId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateReservationRequest" + }, + "output": { + "shape": "UpdateReservationResponse", + "documentation": "Updated reservation" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "This request was invalid" + }, + { + "shape": "InternalServerErrorException", + "documentation": "Internal service error" + }, + { + "shape": "ForbiddenException", + "documentation": "You do not have permission to update reservation" + }, + { + "shape": "BadGatewayException", + "documentation": "Bad gateway error" + }, + { + "shape": "NotFoundException", + "documentation": "Reservation not found" + }, + { + "shape": "GatewayTimeoutException", + "documentation": "Gateway timeout error" + }, + { + "shape": "TooManyRequestsException", + "documentation": "Request limit exceeded" + }, + { + "shape": "ConflictException", + "documentation": "The reservation could not be updated" + } + ], + "documentation": "Update reservation." + } + }, + "shapes": { + "AacCodingMode": { + "type": "string", + "documentation": "Aac Coding Mode", + "enum": [ + "AD_RECEIVER_MIX", + "CODING_MODE_1_0", + "CODING_MODE_1_1", + "CODING_MODE_2_0", + "CODING_MODE_5_1" + ] + }, + "AacInputType": { + "type": "string", + "documentation": "Aac Input Type", + "enum": [ + "BROADCASTER_MIXED_AD", + "NORMAL" + ] + }, + "AacProfile": { + "type": "string", + "documentation": "Aac Profile", + "enum": [ + "HEV1", + "HEV2", + "LC" + ] + }, + "AacRateControlMode": { + "type": "string", + "documentation": "Aac Rate Control Mode", + "enum": [ + "CBR", + "VBR" + ] + }, + "AacRawFormat": { + "type": "string", + "documentation": "Aac Raw Format", + "enum": [ + "LATM_LOAS", + "NONE" + ] + }, + "AacSettings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__double", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Valid values depend on rate control mode and profile." + }, + "CodingMode": { + "shape": "AacCodingMode", + "locationName": "codingMode", + "documentation": "Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E." + }, + "InputType": { + "shape": "AacInputType", + "locationName": "inputType", + "documentation": "Set to \"broadcasterMixedAd\" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd.\n\nLeave set to \"normal\" when input does not contain pre-mixed audio + AD." + }, + "Profile": { + "shape": "AacProfile", + "locationName": "profile", + "documentation": "AAC Profile." + }, + "RateControlMode": { + "shape": "AacRateControlMode", + "locationName": "rateControlMode", + "documentation": "Rate Control Mode." + }, + "RawFormat": { + "shape": "AacRawFormat", + "locationName": "rawFormat", + "documentation": "Sets LATM / LOAS AAC output for raw containers." + }, + "SampleRate": { + "shape": "__double", + "locationName": "sampleRate", + "documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile." + }, + "Spec": { + "shape": "AacSpec", + "locationName": "spec", + "documentation": "Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers." + }, + "VbrQuality": { + "shape": "AacVbrQuality", + "locationName": "vbrQuality", + "documentation": "VBR Quality Level - Only used if rateControlMode is VBR." + } + }, + "documentation": "Aac Settings" + }, + "AacSpec": { + "type": "string", + "documentation": "Aac Spec", + "enum": [ + "MPEG2", + "MPEG4" + ] + }, + "AacVbrQuality": { + "type": "string", + "documentation": "Aac Vbr Quality", + "enum": [ + "HIGH", + "LOW", + "MEDIUM_HIGH", + "MEDIUM_LOW" + ] + }, + "Ac3BitstreamMode": { + "type": "string", + "documentation": "Ac3 Bitstream Mode", + "enum": [ + "COMMENTARY", + "COMPLETE_MAIN", + "DIALOGUE", + "EMERGENCY", + "HEARING_IMPAIRED", + "MUSIC_AND_EFFECTS", + "VISUALLY_IMPAIRED", + "VOICE_OVER" + ] + }, + "Ac3CodingMode": { + "type": "string", + "documentation": "Ac3 Coding Mode", + "enum": [ + "CODING_MODE_1_0", + "CODING_MODE_1_1", + "CODING_MODE_2_0", + "CODING_MODE_3_2_LFE" + ] + }, + "Ac3DrcProfile": { + "type": "string", + "documentation": "Ac3 Drc Profile", + "enum": [ + "FILM_STANDARD", + "NONE" + ] + }, + "Ac3LfeFilter": { + "type": "string", + "documentation": "Ac3 Lfe Filter", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Ac3MetadataControl": { + "type": "string", + "documentation": "Ac3 Metadata Control", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "Ac3Settings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__double", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode." + }, + "BitstreamMode": { + "shape": "Ac3BitstreamMode", + "locationName": "bitstreamMode", + "documentation": "Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values." + }, + "CodingMode": { + "shape": "Ac3CodingMode", + "locationName": "codingMode", + "documentation": "Dolby Digital coding mode. Determines number of channels." + }, + "Dialnorm": { + "shape": "__integerMin1Max31", + "locationName": "dialnorm", + "documentation": "Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through." + }, + "DrcProfile": { + "shape": "Ac3DrcProfile", + "locationName": "drcProfile", + "documentation": "If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification." + }, + "LfeFilter": { + "shape": "Ac3LfeFilter", + "locationName": "lfeFilter", + "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode." + }, + "MetadataControl": { + "shape": "Ac3MetadataControl", + "locationName": "metadataControl", + "documentation": "When set to \"followInput\", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used." + } + }, + "documentation": "Ac3 Settings" + }, + "AccessDenied": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for AccessDenied" + }, + "AfdSignaling": { + "type": "string", + "documentation": "Afd Signaling", + "enum": [ + "AUTO", + "FIXED", + "NONE" + ] + }, + "ArchiveContainerSettings": { + "type": "structure", + "members": { + "M2tsSettings": { + "shape": "M2tsSettings", + "locationName": "m2tsSettings" + } + }, + "documentation": "Archive Container Settings" + }, + "ArchiveGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "A directory and base filename where archive files should be written." + }, + "RolloverInterval": { + "shape": "__integerMin1", + "locationName": "rolloverInterval", + "documentation": "Number of seconds to write to archive file before closing and starting a new one." + } + }, + "documentation": "Archive Group Settings", + "required": [ + "Destination" + ] + }, + "ArchiveOutputSettings": { + "type": "structure", + "members": { + "ContainerSettings": { + "shape": "ArchiveContainerSettings", + "locationName": "containerSettings", + "documentation": "Settings specific to the container type of the file." + }, + "Extension": { + "shape": "__string", + "locationName": "extension", + "documentation": "Output file extension. If excluded, this will be auto-selected from the container type." + }, + "NameModifier": { + "shape": "__string", + "locationName": "nameModifier", + "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type." + } + }, + "documentation": "Archive Output Settings", + "required": [ + "ContainerSettings" + ] + }, + "AribDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Arib Destination Settings" + }, + "AribSourceSettings": { + "type": "structure", + "members": { + }, + "documentation": "Arib Source Settings" + }, + "AudioChannelMapping": { + "type": "structure", + "members": { + "InputChannelLevels": { + "shape": "__listOfInputChannelLevel", + "locationName": "inputChannelLevels", + "documentation": "Indices and gain values for each input channel that should be remixed into this output channel." + }, + "OutputChannel": { + "shape": "__integerMin0Max7", + "locationName": "outputChannel", + "documentation": "The index of the output channel being produced." + } + }, + "documentation": "Audio Channel Mapping", + "required": [ + "OutputChannel", + "InputChannelLevels" + ] + }, + "AudioCodecSettings": { + "type": "structure", + "members": { + "AacSettings": { + "shape": "AacSettings", + "locationName": "aacSettings" + }, + "Ac3Settings": { + "shape": "Ac3Settings", + "locationName": "ac3Settings" + }, + "Eac3Settings": { + "shape": "Eac3Settings", + "locationName": "eac3Settings" + }, + "Mp2Settings": { + "shape": "Mp2Settings", + "locationName": "mp2Settings" + }, + "PassThroughSettings": { + "shape": "PassThroughSettings", + "locationName": "passThroughSettings" + } + }, + "documentation": "Audio Codec Settings" + }, + "AudioDescription": { + "type": "structure", + "members": { + "AudioNormalizationSettings": { + "shape": "AudioNormalizationSettings", + "locationName": "audioNormalizationSettings", + "documentation": "Advanced audio normalization settings." + }, + "AudioSelectorName": { + "shape": "__string", + "locationName": "audioSelectorName", + "documentation": "The name of the AudioSelector used as the source for this AudioDescription." + }, + "AudioType": { + "shape": "AudioType", + "locationName": "audioType", + "documentation": "Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1." + }, + "AudioTypeControl": { + "shape": "AudioDescriptionAudioTypeControl", + "locationName": "audioTypeControl", + "documentation": "Determines how audio type is determined.\n followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output.\n useConfigured: The value in Audio Type is included in the output.\nNote that this field and audioType are both ignored if inputType is broadcasterMixedAd." + }, + "CodecSettings": { + "shape": "AudioCodecSettings", + "locationName": "codecSettings", + "documentation": "Audio codec settings." + }, + "LanguageCode": { + "shape": "__stringMin3Max3", + "locationName": "languageCode", + "documentation": "Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input." + }, + "LanguageCodeControl": { + "shape": "AudioDescriptionLanguageCodeControl", + "locationName": "languageCodeControl", + "documentation": "Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event." + }, + "RemixSettings": { + "shape": "RemixSettings", + "locationName": "remixSettings", + "documentation": "Settings that control how input audio channels are remixed into the output audio channels." + }, + "StreamName": { + "shape": "__string", + "locationName": "streamName", + "documentation": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary)." + } + }, + "documentation": "Audio Description", + "required": [ + "AudioSelectorName", + "Name" + ] + }, + "AudioDescriptionAudioTypeControl": { + "type": "string", + "documentation": "Audio Description Audio Type Control", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "AudioDescriptionLanguageCodeControl": { + "type": "string", + "documentation": "Audio Description Language Code Control", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "AudioLanguageSelection": { + "type": "structure", + "members": { + "LanguageCode": { + "shape": "__string", + "locationName": "languageCode", + "documentation": "Selects a specific three-letter language code from within an audio source." + }, + "LanguageSelectionPolicy": { + "shape": "AudioLanguageSelectionPolicy", + "locationName": "languageSelectionPolicy", + "documentation": "When set to \"strict\", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If \"loose\", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language." + } + }, + "documentation": "Audio Language Selection", + "required": [ + "LanguageCode" + ] + }, + "AudioLanguageSelectionPolicy": { + "type": "string", + "documentation": "Audio Language Selection Policy", + "enum": [ + "LOOSE", + "STRICT" + ] + }, + "AudioNormalizationAlgorithm": { + "type": "string", + "documentation": "Audio Normalization Algorithm", + "enum": [ + "ITU_1770_1", + "ITU_1770_2" + ] + }, + "AudioNormalizationAlgorithmControl": { + "type": "string", + "documentation": "Audio Normalization Algorithm Control", + "enum": [ + "CORRECT_AUDIO" + ] + }, + "AudioNormalizationSettings": { + "type": "structure", + "members": { + "Algorithm": { + "shape": "AudioNormalizationAlgorithm", + "locationName": "algorithm", + "documentation": "Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification." + }, + "AlgorithmControl": { + "shape": "AudioNormalizationAlgorithmControl", + "locationName": "algorithmControl", + "documentation": "When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted." + }, + "TargetLkfs": { + "shape": "__doubleMinNegative59Max0", + "locationName": "targetLkfs", + "documentation": "Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS." + } + }, + "documentation": "Audio Normalization Settings" + }, + "AudioOnlyHlsSettings": { + "type": "structure", + "members": { + "AudioGroupId": { + "shape": "__string", + "locationName": "audioGroupId", + "documentation": "Specifies the group to which the audio Rendition belongs." + }, + "AudioOnlyImage": { + "shape": "InputLocation", + "locationName": "audioOnlyImage", + "documentation": "Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth.\n\nThe image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the \"ID3 tag version 2.4.0 - Native Frames\" standard." + }, + "AudioTrackType": { + "shape": "AudioOnlyHlsTrackType", + "locationName": "audioTrackType", + "documentation": "Four types of audio-only tracks are supported:\n\nAudio-Only Variant Stream\nThe client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest.\n\nAlternate Audio, Auto Select, Default\nAlternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES\n\nAlternate Audio, Auto Select, Not Default\nAlternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES\n\nAlternate Audio, not Auto Select\nAlternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO" + } + }, + "documentation": "Audio Only Hls Settings" + }, + "AudioOnlyHlsTrackType": { + "type": "string", + "documentation": "Audio Only Hls Track Type", + "enum": [ + "ALTERNATE_AUDIO_AUTO_SELECT", + "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT", + "ALTERNATE_AUDIO_NOT_AUTO_SELECT", + "AUDIO_ONLY_VARIANT_STREAM" + ] + }, + "AudioPidSelection": { + "type": "structure", + "members": { + "Pid": { + "shape": "__integerMin0Max8191", + "locationName": "pid", + "documentation": "Selects a specific PID from within a source." + } + }, + "documentation": "Audio Pid Selection", + "required": [ + "Pid" + ] + }, + "AudioSelector": { + "type": "structure", + "members": { + "Name": { + "shape": "__stringMin1", + "locationName": "name", + "documentation": "The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input." + }, + "SelectorSettings": { + "shape": "AudioSelectorSettings", + "locationName": "selectorSettings", + "documentation": "The audio selector settings." + } + }, + "documentation": "Audio Selector", + "required": [ + "Name" + ] + }, + "AudioSelectorSettings": { + "type": "structure", + "members": { + "AudioLanguageSelection": { + "shape": "AudioLanguageSelection", + "locationName": "audioLanguageSelection" + }, + "AudioPidSelection": { + "shape": "AudioPidSelection", + "locationName": "audioPidSelection" + } + }, + "documentation": "Audio Selector Settings" + }, + "AudioType": { + "type": "string", + "documentation": "Audio Type", + "enum": [ + "CLEAN_EFFECTS", + "HEARING_IMPAIRED", + "UNDEFINED", + "VISUAL_IMPAIRED_COMMENTARY" + ] + }, + "AuthenticationScheme": { + "type": "string", + "documentation": "Authentication Scheme", + "enum": [ + "AKAMAI", + "COMMON" + ] + }, + "AvailBlanking": { + "type": "structure", + "members": { + "AvailBlankingImage": { + "shape": "InputLocation", + "locationName": "availBlankingImage", + "documentation": "Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported." + }, + "State": { + "shape": "AvailBlankingState", + "locationName": "state", + "documentation": "When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added." + } + }, + "documentation": "Avail Blanking" + }, + "AvailBlankingState": { + "type": "string", + "documentation": "Avail Blanking State", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "AvailConfiguration": { + "type": "structure", + "members": { + "AvailSettings": { + "shape": "AvailSettings", + "locationName": "availSettings", + "documentation": "Ad avail settings." + } + }, + "documentation": "Avail Configuration" + }, + "AvailSettings": { + "type": "structure", + "members": { + "Scte35SpliceInsert": { + "shape": "Scte35SpliceInsert", + "locationName": "scte35SpliceInsert" + }, + "Scte35TimeSignalApos": { + "shape": "Scte35TimeSignalApos", + "locationName": "scte35TimeSignalApos" + } + }, + "documentation": "Avail Settings" + }, + "BadGatewayException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 502 + }, + "documentation": "Placeholder documentation for BadGatewayException" + }, + "BadRequestException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 400 + }, + "documentation": "Placeholder documentation for BadRequestException" + }, + "BatchScheduleActionCreateRequest": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "A list of schedule actions to create." + } + }, + "documentation": "A list of schedule actions to create (in a request) or that have been created (in a response).", + "required": [ + "ScheduleActions" + ] + }, + "BatchScheduleActionCreateResult": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "List of actions that have been created in the schedule." + } + }, + "documentation": "List of actions that have been created in the schedule.", + "required": [ + "ScheduleActions" + ] + }, + "BatchScheduleActionDeleteRequest": { + "type": "structure", + "members": { + "ActionNames": { + "shape": "__listOf__string", + "locationName": "actionNames", + "documentation": "A list of schedule actions to delete." + } + }, + "documentation": "A list of schedule actions to delete.", + "required": [ + "ActionNames" + ] + }, + "BatchScheduleActionDeleteResult": { + "type": "structure", + "members": { + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "List of actions that have been deleted from the schedule." + } + }, + "documentation": "List of actions that have been deleted from the schedule.", + "required": [ + "ScheduleActions" + ] + }, + "BatchUpdateScheduleRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Id of the channel whose schedule is being updated." + }, + "Creates": { + "shape": "BatchScheduleActionCreateRequest", + "locationName": "creates", + "documentation": "Schedule actions to create in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteRequest", + "locationName": "deletes", + "documentation": "Schedule actions to delete from the schedule." + } + }, + "documentation": "List of actions to create and list of actions to delete.", + "required": [ + "ChannelId" + ] + }, + "BatchUpdateScheduleResponse": { + "type": "structure", + "members": { + "Creates": { + "shape": "BatchScheduleActionCreateResult", + "locationName": "creates", + "documentation": "Schedule actions created in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteResult", + "locationName": "deletes", + "documentation": "Schedule actions deleted from the schedule." + } + }, + "documentation": "Placeholder documentation for BatchUpdateScheduleResponse" + }, + "BatchUpdateScheduleResult": { + "type": "structure", + "members": { + "Creates": { + "shape": "BatchScheduleActionCreateResult", + "locationName": "creates", + "documentation": "Schedule actions created in the schedule." + }, + "Deletes": { + "shape": "BatchScheduleActionDeleteResult", + "locationName": "deletes", + "documentation": "Schedule actions deleted from the schedule." + } + }, + "documentation": "Results of a batch schedule update." + }, + "BlackoutSlate": { + "type": "structure", + "members": { + "BlackoutSlateImage": { + "shape": "InputLocation", + "locationName": "blackoutSlateImage", + "documentation": "Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported." + }, + "NetworkEndBlackout": { + "shape": "BlackoutSlateNetworkEndBlackout", + "locationName": "networkEndBlackout", + "documentation": "Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the \"Network Blackout Image\" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in \"Network ID\"." + }, + "NetworkEndBlackoutImage": { + "shape": "InputLocation", + "locationName": "networkEndBlackoutImage", + "documentation": "Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster." + }, + "NetworkId": { + "shape": "__stringMin34Max34", + "locationName": "networkId", + "documentation": "Provides Network ID that matches EIDR ID format (e.g., \"10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C\")." + }, + "State": { + "shape": "BlackoutSlateState", + "locationName": "state", + "documentation": "When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata." + } + }, + "documentation": "Blackout Slate" + }, + "BlackoutSlateNetworkEndBlackout": { + "type": "string", + "documentation": "Blackout Slate Network End Blackout", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "BlackoutSlateState": { + "type": "string", + "documentation": "Blackout Slate State", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "BurnInAlignment": { + "type": "string", + "documentation": "Burn In Alignment", + "enum": [ + "CENTERED", + "LEFT", + "SMART" + ] + }, + "BurnInBackgroundColor": { + "type": "string", + "documentation": "Burn In Background Color", + "enum": [ + "BLACK", + "NONE", + "WHITE" + ] + }, + "BurnInDestinationSettings": { + "type": "structure", + "members": { + "Alignment": { + "shape": "BurnInAlignment", + "locationName": "alignment", + "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundColor": { + "shape": "BurnInBackgroundColor", + "locationName": "backgroundColor", + "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundOpacity": { + "shape": "__integerMin0Max255", + "locationName": "backgroundOpacity", + "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "Font": { + "shape": "InputLocation", + "locationName": "font", + "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match." + }, + "FontColor": { + "shape": "BurnInFontColor", + "locationName": "fontColor", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "FontOpacity": { + "shape": "__integerMin0Max255", + "locationName": "fontOpacity", + "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match." + }, + "FontResolution": { + "shape": "__integerMin96Max600", + "locationName": "fontResolution", + "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match." + }, + "FontSize": { + "shape": "__string", + "locationName": "fontSize", + "documentation": "When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match." + }, + "OutlineColor": { + "shape": "BurnInOutlineColor", + "locationName": "outlineColor", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "OutlineSize": { + "shape": "__integerMin0Max10", + "locationName": "outlineSize", + "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "ShadowColor": { + "shape": "BurnInShadowColor", + "locationName": "shadowColor", + "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match." + }, + "ShadowOpacity": { + "shape": "__integerMin0Max255", + "locationName": "shadowOpacity", + "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "ShadowXOffset": { + "shape": "__integer", + "locationName": "shadowXOffset", + "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match." + }, + "ShadowYOffset": { + "shape": "__integer", + "locationName": "shadowYOffset", + "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match." + }, + "TeletextGridControl": { + "shape": "BurnInTeletextGridControl", + "locationName": "teletextGridControl", + "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs." + }, + "XPosition": { + "shape": "__integerMin0", + "locationName": "xPosition", + "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match." + }, + "YPosition": { + "shape": "__integerMin0", + "locationName": "yPosition", + "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match." + } + }, + "documentation": "Burn In Destination Settings" + }, + "BurnInFontColor": { + "type": "string", + "documentation": "Burn In Font Color", + "enum": [ + "BLACK", + "BLUE", + "GREEN", + "RED", + "WHITE", + "YELLOW" + ] + }, + "BurnInOutlineColor": { + "type": "string", + "documentation": "Burn In Outline Color", + "enum": [ + "BLACK", + "BLUE", + "GREEN", + "RED", + "WHITE", + "YELLOW" + ] + }, + "BurnInShadowColor": { + "type": "string", + "documentation": "Burn In Shadow Color", + "enum": [ + "BLACK", + "NONE", + "WHITE" + ] + }, + "BurnInTeletextGridControl": { + "type": "string", + "documentation": "Burn In Teletext Grid Control", + "enum": [ + "FIXED", + "SCALED" + ] + }, + "CaptionDescription": { + "type": "structure", + "members": { + "CaptionSelectorName": { + "shape": "__string", + "locationName": "captionSelectorName", + "documentation": "Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name." + }, + "DestinationSettings": { + "shape": "CaptionDestinationSettings", + "locationName": "destinationSettings", + "documentation": "Additional settings for captions destination that depend on the destination type." + }, + "LanguageCode": { + "shape": "__string", + "locationName": "languageCode", + "documentation": "ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/" + }, + "LanguageDescription": { + "shape": "__string", + "locationName": "languageDescription", + "documentation": "Human readable information to indicate captions available for players (eg. English, or Spanish)." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event." + } + }, + "documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed.", + "required": [ + "CaptionSelectorName", + "Name" + ] + }, + "CaptionDestinationSettings": { + "type": "structure", + "members": { + "AribDestinationSettings": { + "shape": "AribDestinationSettings", + "locationName": "aribDestinationSettings" + }, + "BurnInDestinationSettings": { + "shape": "BurnInDestinationSettings", + "locationName": "burnInDestinationSettings" + }, + "DvbSubDestinationSettings": { + "shape": "DvbSubDestinationSettings", + "locationName": "dvbSubDestinationSettings" + }, + "EmbeddedDestinationSettings": { + "shape": "EmbeddedDestinationSettings", + "locationName": "embeddedDestinationSettings" + }, + "EmbeddedPlusScte20DestinationSettings": { + "shape": "EmbeddedPlusScte20DestinationSettings", + "locationName": "embeddedPlusScte20DestinationSettings" + }, + "RtmpCaptionInfoDestinationSettings": { + "shape": "RtmpCaptionInfoDestinationSettings", + "locationName": "rtmpCaptionInfoDestinationSettings" + }, + "Scte20PlusEmbeddedDestinationSettings": { + "shape": "Scte20PlusEmbeddedDestinationSettings", + "locationName": "scte20PlusEmbeddedDestinationSettings" + }, + "Scte27DestinationSettings": { + "shape": "Scte27DestinationSettings", + "locationName": "scte27DestinationSettings" + }, + "SmpteTtDestinationSettings": { + "shape": "SmpteTtDestinationSettings", + "locationName": "smpteTtDestinationSettings" + }, + "TeletextDestinationSettings": { + "shape": "TeletextDestinationSettings", + "locationName": "teletextDestinationSettings" + }, + "TtmlDestinationSettings": { + "shape": "TtmlDestinationSettings", + "locationName": "ttmlDestinationSettings" + }, + "WebvttDestinationSettings": { + "shape": "WebvttDestinationSettings", + "locationName": "webvttDestinationSettings" + } + }, + "documentation": "Caption Destination Settings" + }, + "CaptionLanguageMapping": { + "type": "structure", + "members": { + "CaptionChannel": { + "shape": "__integerMin1Max4", + "locationName": "captionChannel", + "documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)" + }, + "LanguageCode": { + "shape": "__stringMin3Max3", + "locationName": "languageCode", + "documentation": "Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)" + }, + "LanguageDescription": { + "shape": "__stringMin1", + "locationName": "languageDescription", + "documentation": "Textual description of language" + } + }, + "documentation": "Maps a caption channel to an ISO 693-2 language code (http://www.loc.gov/standards/iso639-2), with an optional description.", + "required": [ + "LanguageCode", + "LanguageDescription", + "CaptionChannel" + ] + }, + "CaptionSelector": { + "type": "structure", + "members": { + "LanguageCode": { + "shape": "__string", + "locationName": "languageCode", + "documentation": "When specified this field indicates the three letter language code of the caption track to extract from the source." + }, + "Name": { + "shape": "__stringMin1", + "locationName": "name", + "documentation": "Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event." + }, + "SelectorSettings": { + "shape": "CaptionSelectorSettings", + "locationName": "selectorSettings", + "documentation": "Caption selector settings." + } + }, + "documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed.", + "required": [ + "Name" + ] + }, + "CaptionSelectorSettings": { + "type": "structure", + "members": { + "AribSourceSettings": { + "shape": "AribSourceSettings", + "locationName": "aribSourceSettings" + }, + "DvbSubSourceSettings": { + "shape": "DvbSubSourceSettings", + "locationName": "dvbSubSourceSettings" + }, + "EmbeddedSourceSettings": { + "shape": "EmbeddedSourceSettings", + "locationName": "embeddedSourceSettings" + }, + "Scte20SourceSettings": { + "shape": "Scte20SourceSettings", + "locationName": "scte20SourceSettings" + }, + "Scte27SourceSettings": { + "shape": "Scte27SourceSettings", + "locationName": "scte27SourceSettings" + }, + "TeletextSourceSettings": { + "shape": "TeletextSourceSettings", + "locationName": "teletextSourceSettings" + } + }, + "documentation": "Caption Selector Settings" + }, + "Channel": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelineDetails": { + "shape": "__listOfPipelineDetail", + "locationName": "pipelineDetails", + "documentation": "Runtime details for the pipelines of a running channel." + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for Channel" + }, + "ChannelClass": { + "type": "string", + "documentation": "A standard channel has two encoding pipelines and a single pipeline channel only has one.", + "enum": [ + "STANDARD", + "SINGLE_PIPELINE" + ] + }, + "ChannelConfigurationValidationError": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + }, + "ValidationErrors": { + "shape": "__listOfValidationError", + "locationName": "validationErrors", + "documentation": "A collection of validation error responses." + } + }, + "documentation": "Placeholder documentation for ChannelConfigurationValidationError" + }, + "ChannelEgressEndpoint": { + "type": "structure", + "members": { + "SourceIp": { + "shape": "__string", + "locationName": "sourceIp", + "documentation": "Public IP of where a channel's output comes from" + } + }, + "documentation": "Placeholder documentation for ChannelEgressEndpoint" + }, + "ChannelState": { + "type": "string", + "enum": [ + "CREATING", + "CREATE_FAILED", + "IDLE", + "STARTING", + "RUNNING", + "RECOVERING", + "STOPPING", + "DELETING", + "DELETED", + "UPDATING", + "UPDATE_FAILED" + ], + "documentation": "Placeholder documentation for ChannelState" + }, + "ChannelSummary": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for ChannelSummary" + }, + "ColorSpacePassthroughSettings": { + "type": "structure", + "members": { + }, + "documentation": "Passthrough applies no color space conversion to the output" + }, + "ConflictException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 409 + }, + "documentation": "Placeholder documentation for ConflictException" + }, + "CreateChannel": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification", + "documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level to write to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of channel." + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.\n", + "idempotencyToken": true + }, + "Reserved": { + "shape": "__string", + "locationName": "reserved", + "documentation": "Deprecated field that's only usable by whitelisted customers.", + "deprecated": true + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for CreateChannel" + }, + "CreateChannelRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification", + "documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level to write to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of channel." + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique request ID to be specified. This is needed to prevent retries from\ncreating multiple resources.\n", + "idempotencyToken": true + }, + "Reserved": { + "shape": "__string", + "locationName": "reserved", + "documentation": "Deprecated field that's only usable by whitelisted customers.", + "deprecated": true + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "A request to create a channel" + }, + "CreateChannelResponse": { + "type": "structure", + "members": { + "Channel": { + "shape": "Channel", + "locationName": "channel" + } + }, + "documentation": "Placeholder documentation for CreateChannelResponse" + }, + "CreateChannelResultModel": { + "type": "structure", + "members": { + "Channel": { + "shape": "Channel", + "locationName": "channel" + } + }, + "documentation": "Placeholder documentation for CreateChannelResultModel" + }, + "CreateInput": { + "type": "structure", + "members": { + "Destinations": { + "shape": "__listOfInputDestinationRequest", + "locationName": "destinations", + "documentation": "Destination settings for PUSH type inputs." + }, + "InputSecurityGroups": { + "shape": "__listOf__string", + "locationName": "inputSecurityGroups", + "documentation": "A list of security groups referenced by IDs to attach to the input." + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlowRequest", + "locationName": "mediaConnectFlows", + "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.\n" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the input." + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.\n", + "idempotencyToken": true + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "Sources": { + "shape": "__listOfInputSourceRequest", + "locationName": "sources", + "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty.\n" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "Type": { + "shape": "InputType", + "locationName": "type" + }, + "Vpc": { + "shape": "InputVpcRequest", + "locationName": "vpc" + } + }, + "documentation": "Placeholder documentation for CreateInput" + }, + "CreateInputRequest": { + "type": "structure", + "members": { + "Destinations": { + "shape": "__listOfInputDestinationRequest", + "locationName": "destinations", + "documentation": "Destination settings for PUSH type inputs." + }, + "InputSecurityGroups": { + "shape": "__listOf__string", + "locationName": "inputSecurityGroups", + "documentation": "A list of security groups referenced by IDs to attach to the input." + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlowRequest", + "locationName": "mediaConnectFlows", + "documentation": "A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.\n" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the input." + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.\n", + "idempotencyToken": true + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "Sources": { + "shape": "__listOfInputSourceRequest", + "locationName": "sources", + "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty.\n" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "Type": { + "shape": "InputType", + "locationName": "type" + }, + "Vpc": { + "shape": "InputVpcRequest", + "locationName": "vpc" + } + }, + "documentation": "The name of the input" + }, + "CreateInputResponse": { + "type": "structure", + "members": { + "Input": { + "shape": "Input", + "locationName": "input" + } + }, + "documentation": "Placeholder documentation for CreateInputResponse" + }, + "CreateInputResultModel": { + "type": "structure", + "members": { + "Input": { + "shape": "Input", + "locationName": "input" + } + }, + "documentation": "Placeholder documentation for CreateInputResultModel" + }, + "CreateInputSecurityGroupRequest": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "WhitelistRules": { + "shape": "__listOfInputWhitelistRuleCidr", + "locationName": "whitelistRules", + "documentation": "List of IPv4 CIDR addresses to whitelist" + } + }, + "documentation": "The IPv4 CIDRs to whitelist for this Input Security Group" + }, + "CreateInputSecurityGroupResponse": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "InputSecurityGroup", + "locationName": "securityGroup" + } + }, + "documentation": "Placeholder documentation for CreateInputSecurityGroupResponse" + }, + "CreateInputSecurityGroupResultModel": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "InputSecurityGroup", + "locationName": "securityGroup" + } + }, + "documentation": "Placeholder documentation for CreateInputSecurityGroupResultModel" + }, + "CreateTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags" + } + }, + "required": [ + "ResourceArn" + ], + "documentation": "Placeholder documentation for CreateTagsRequest" + }, + "DeleteChannelRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Unique ID of the channel." + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for DeleteChannelRequest" + }, + "DeleteChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelineDetails": { + "shape": "__listOfPipelineDetail", + "locationName": "pipelineDetails", + "documentation": "Runtime details for the pipelines of a running channel." + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for DeleteChannelResponse" + }, + "DeleteInputRequest": { + "type": "structure", + "members": { + "InputId": { + "shape": "__string", + "location": "uri", + "locationName": "inputId", + "documentation": "Unique ID of the input" + } + }, + "required": [ + "InputId" + ], + "documentation": "Placeholder documentation for DeleteInputRequest" + }, + "DeleteInputResponse": { + "type": "structure", + "members": { + }, + "documentation": "Placeholder documentation for DeleteInputResponse" + }, + "DeleteInputSecurityGroupRequest": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "shape": "__string", + "location": "uri", + "locationName": "inputSecurityGroupId", + "documentation": "The Input Security Group to delete" + } + }, + "required": [ + "InputSecurityGroupId" + ], + "documentation": "Placeholder documentation for DeleteInputSecurityGroupRequest" + }, + "DeleteInputSecurityGroupResponse": { + "type": "structure", + "members": { + }, + "documentation": "Placeholder documentation for DeleteInputSecurityGroupResponse" + }, + "DeleteReservationRequest": { + "type": "structure", + "members": { + "ReservationId": { + "shape": "__string", + "location": "uri", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + } + }, + "required": [ + "ReservationId" + ], + "documentation": "Placeholder documentation for DeleteReservationRequest" + }, + "DeleteReservationResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'" + }, + "Count": { + "shape": "__integer", + "locationName": "count", + "documentation": "Number of reserved resources" + }, + "CurrencyCode": { + "shape": "__string", + "locationName": "currencyCode", + "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'" + }, + "Duration": { + "shape": "__integer", + "locationName": "duration", + "documentation": "Lease duration, e.g. '12'" + }, + "DurationUnits": { + "shape": "OfferingDurationUnits", + "locationName": "durationUnits", + "documentation": "Units for duration, e.g. 'MONTHS'" + }, + "End": { + "shape": "__string", + "locationName": "end", + "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'" + }, + "FixedPrice": { + "shape": "__double", + "locationName": "fixedPrice", + "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "User specified reservation name" + }, + "OfferingDescription": { + "shape": "__string", + "locationName": "offeringDescription", + "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'" + }, + "OfferingId": { + "shape": "__string", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + }, + "OfferingType": { + "shape": "OfferingType", + "locationName": "offeringType", + "documentation": "Offering type, e.g. 'NO_UPFRONT'" + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "AWS region, e.g. 'us-west-2'" + }, + "ReservationId": { + "shape": "__string", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + }, + "ResourceSpecification": { + "shape": "ReservationResourceSpecification", + "locationName": "resourceSpecification", + "documentation": "Resource configuration details" + }, + "Start": { + "shape": "__string", + "locationName": "start", + "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'" + }, + "State": { + "shape": "ReservationState", + "locationName": "state", + "documentation": "Current state of reservation, e.g. 'ACTIVE'" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs" + }, + "UsagePrice": { + "shape": "__double", + "locationName": "usagePrice", + "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'" + } + }, + "documentation": "Placeholder documentation for DeleteReservationResponse" + }, + "DeleteScheduleRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Id of the channel whose schedule is being deleted." + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for DeleteScheduleRequest" + }, + "DeleteScheduleResponse": { + "type": "structure", + "members": { + }, + "documentation": "Placeholder documentation for DeleteScheduleResponse" + }, + "DeleteTagsRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + }, + "TagKeys": { + "shape": "__listOf__string", + "location": "querystring", + "locationName": "tagKeys", + "documentation": "An array of tag keys to delete" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ], + "documentation": "Placeholder documentation for DeleteTagsRequest" + }, + "DescribeChannelRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "channel ID" + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for DescribeChannelRequest" + }, + "DescribeChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelineDetails": { + "shape": "__listOfPipelineDetail", + "locationName": "pipelineDetails", + "documentation": "Runtime details for the pipelines of a running channel." + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for DescribeChannelResponse" + }, + "DescribeInputRequest": { + "type": "structure", + "members": { + "InputId": { + "shape": "__string", + "location": "uri", + "locationName": "inputId", + "documentation": "Unique ID of the input" + } + }, + "required": [ + "InputId" + ], + "documentation": "Placeholder documentation for DescribeInputRequest" + }, + "DescribeInputResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Unique ARN of the input (generated, immutable)." + }, + "AttachedChannels": { + "shape": "__listOf__string", + "locationName": "attachedChannels", + "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)." + }, + "Destinations": { + "shape": "__listOfInputDestination", + "locationName": "destinations", + "documentation": "A list of the destinations of the input (PUSH-type)." + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The generated ID of the input (unique for user account, immutable)." + }, + "InputClass": { + "shape": "InputClass", + "locationName": "inputClass", + "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.\n" + }, + "InputSourceType": { + "shape": "InputSourceType", + "locationName": "inputSourceType", + "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE inputs.\n" + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlow", + "locationName": "mediaConnectFlows", + "documentation": "A list of MediaConnect Flows for this input." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The user-assigned name (This is a mutable value)." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "SecurityGroups": { + "shape": "__listOf__string", + "locationName": "securityGroups", + "documentation": "A list of IDs for all the Input Security Groups attached to the input." + }, + "Sources": { + "shape": "__listOfInputSource", + "locationName": "sources", + "documentation": "A list of the sources of the input (PULL-type)." + }, + "State": { + "shape": "InputState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "Type": { + "shape": "InputType", + "locationName": "type" + } + }, + "documentation": "Placeholder documentation for DescribeInputResponse" + }, + "DescribeInputSecurityGroupRequest": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "shape": "__string", + "location": "uri", + "locationName": "inputSecurityGroupId", + "documentation": "The id of the Input Security Group to describe" + } + }, + "required": [ + "InputSecurityGroupId" + ], + "documentation": "Placeholder documentation for DescribeInputSecurityGroupRequest" + }, + "DescribeInputSecurityGroupResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique ARN of Input Security Group" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The Id of the Input Security Group" + }, + "Inputs": { + "shape": "__listOf__string", + "locationName": "inputs", + "documentation": "The list of inputs currently using this Input Security Group." + }, + "State": { + "shape": "InputSecurityGroupState", + "locationName": "state", + "documentation": "The current state of the Input Security Group." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "WhitelistRules": { + "shape": "__listOfInputWhitelistRule", + "locationName": "whitelistRules", + "documentation": "Whitelist rules and their sync status" + } + }, + "documentation": "Placeholder documentation for DescribeInputSecurityGroupResponse" + }, + "DescribeOfferingRequest": { + "type": "structure", + "members": { + "OfferingId": { + "shape": "__string", + "location": "uri", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + } + }, + "required": [ + "OfferingId" + ], + "documentation": "Placeholder documentation for DescribeOfferingRequest" + }, + "DescribeOfferingResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'" + }, + "CurrencyCode": { + "shape": "__string", + "locationName": "currencyCode", + "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'" + }, + "Duration": { + "shape": "__integer", + "locationName": "duration", + "documentation": "Lease duration, e.g. '12'" + }, + "DurationUnits": { + "shape": "OfferingDurationUnits", + "locationName": "durationUnits", + "documentation": "Units for duration, e.g. 'MONTHS'" + }, + "FixedPrice": { + "shape": "__double", + "locationName": "fixedPrice", + "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering" + }, + "OfferingDescription": { + "shape": "__string", + "locationName": "offeringDescription", + "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'" + }, + "OfferingId": { + "shape": "__string", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + }, + "OfferingType": { + "shape": "OfferingType", + "locationName": "offeringType", + "documentation": "Offering type, e.g. 'NO_UPFRONT'" + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "AWS region, e.g. 'us-west-2'" + }, + "ResourceSpecification": { + "shape": "ReservationResourceSpecification", + "locationName": "resourceSpecification", + "documentation": "Resource configuration details" + }, + "UsagePrice": { + "shape": "__double", + "locationName": "usagePrice", + "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'" + } + }, + "documentation": "Placeholder documentation for DescribeOfferingResponse" + }, + "DescribeReservationRequest": { + "type": "structure", + "members": { + "ReservationId": { + "shape": "__string", + "location": "uri", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + } + }, + "required": [ + "ReservationId" + ], + "documentation": "Placeholder documentation for DescribeReservationRequest" + }, + "DescribeReservationResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'" + }, + "Count": { + "shape": "__integer", + "locationName": "count", + "documentation": "Number of reserved resources" + }, + "CurrencyCode": { + "shape": "__string", + "locationName": "currencyCode", + "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'" + }, + "Duration": { + "shape": "__integer", + "locationName": "duration", + "documentation": "Lease duration, e.g. '12'" + }, + "DurationUnits": { + "shape": "OfferingDurationUnits", + "locationName": "durationUnits", + "documentation": "Units for duration, e.g. 'MONTHS'" + }, + "End": { + "shape": "__string", + "locationName": "end", + "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'" + }, + "FixedPrice": { + "shape": "__double", + "locationName": "fixedPrice", + "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "User specified reservation name" + }, + "OfferingDescription": { + "shape": "__string", + "locationName": "offeringDescription", + "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'" + }, + "OfferingId": { + "shape": "__string", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + }, + "OfferingType": { + "shape": "OfferingType", + "locationName": "offeringType", + "documentation": "Offering type, e.g. 'NO_UPFRONT'" + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "AWS region, e.g. 'us-west-2'" + }, + "ReservationId": { + "shape": "__string", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + }, + "ResourceSpecification": { + "shape": "ReservationResourceSpecification", + "locationName": "resourceSpecification", + "documentation": "Resource configuration details" + }, + "Start": { + "shape": "__string", + "locationName": "start", + "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'" + }, + "State": { + "shape": "ReservationState", + "locationName": "state", + "documentation": "Current state of reservation, e.g. 'ACTIVE'" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs" + }, + "UsagePrice": { + "shape": "__double", + "locationName": "usagePrice", + "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'" + } + }, + "documentation": "Placeholder documentation for DescribeReservationResponse" + }, + "DescribeScheduleRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Id of the channel whose schedule is being updated." + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for DescribeScheduleRequest" + }, + "DescribeScheduleResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The next token; for use in pagination." + }, + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "The list of actions in the schedule." + } + }, + "documentation": "Placeholder documentation for DescribeScheduleResponse" + }, + "DvbNitSettings": { + "type": "structure", + "members": { + "NetworkId": { + "shape": "__integerMin0Max65536", + "locationName": "networkId", + "documentation": "The numeric value placed in the Network Information Table (NIT)." + }, + "NetworkName": { + "shape": "__stringMin1Max256", + "locationName": "networkName", + "documentation": "The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters." + }, + "RepInterval": { + "shape": "__integerMin25Max10000", + "locationName": "repInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + } + }, + "documentation": "DVB Network Information Table (NIT)", + "required": [ + "NetworkName", + "NetworkId" + ] + }, + "DvbSdtOutputSdt": { + "type": "string", + "documentation": "Dvb Sdt Output Sdt", + "enum": [ + "SDT_FOLLOW", + "SDT_FOLLOW_IF_PRESENT", + "SDT_MANUAL", + "SDT_NONE" + ] + }, + "DvbSdtSettings": { + "type": "structure", + "members": { + "OutputSdt": { + "shape": "DvbSdtOutputSdt", + "locationName": "outputSdt", + "documentation": "Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information." + }, + "RepInterval": { + "shape": "__integerMin25Max2000", + "locationName": "repInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + }, + "ServiceName": { + "shape": "__stringMin1Max256", + "locationName": "serviceName", + "documentation": "The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters." + }, + "ServiceProviderName": { + "shape": "__stringMin1Max256", + "locationName": "serviceProviderName", + "documentation": "The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters." + } + }, + "documentation": "DVB Service Description Table (SDT)" + }, + "DvbSubDestinationAlignment": { + "type": "string", + "documentation": "Dvb Sub Destination Alignment", + "enum": [ + "CENTERED", + "LEFT", + "SMART" + ] + }, + "DvbSubDestinationBackgroundColor": { + "type": "string", + "documentation": "Dvb Sub Destination Background Color", + "enum": [ + "BLACK", + "NONE", + "WHITE" + ] + }, + "DvbSubDestinationFontColor": { + "type": "string", + "documentation": "Dvb Sub Destination Font Color", + "enum": [ + "BLACK", + "BLUE", + "GREEN", + "RED", + "WHITE", + "YELLOW" + ] + }, + "DvbSubDestinationOutlineColor": { + "type": "string", + "documentation": "Dvb Sub Destination Outline Color", + "enum": [ + "BLACK", + "BLUE", + "GREEN", + "RED", + "WHITE", + "YELLOW" + ] + }, + "DvbSubDestinationSettings": { + "type": "structure", + "members": { + "Alignment": { + "shape": "DvbSubDestinationAlignment", + "locationName": "alignment", + "documentation": "If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting \"smart\" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundColor": { + "shape": "DvbSubDestinationBackgroundColor", + "locationName": "backgroundColor", + "documentation": "Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match." + }, + "BackgroundOpacity": { + "shape": "__integerMin0Max255", + "locationName": "backgroundOpacity", + "documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "Font": { + "shape": "InputLocation", + "locationName": "font", + "documentation": "External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match." + }, + "FontColor": { + "shape": "DvbSubDestinationFontColor", + "locationName": "fontColor", + "documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "FontOpacity": { + "shape": "__integerMin0Max255", + "locationName": "fontOpacity", + "documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match." + }, + "FontResolution": { + "shape": "__integerMin96Max600", + "locationName": "fontResolution", + "documentation": "Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match." + }, + "FontSize": { + "shape": "__string", + "locationName": "fontSize", + "documentation": "When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match." + }, + "OutlineColor": { + "shape": "DvbSubDestinationOutlineColor", + "locationName": "outlineColor", + "documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "OutlineSize": { + "shape": "__integerMin0Max10", + "locationName": "outlineSize", + "documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "ShadowColor": { + "shape": "DvbSubDestinationShadowColor", + "locationName": "shadowColor", + "documentation": "Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match." + }, + "ShadowOpacity": { + "shape": "__integerMin0Max255", + "locationName": "shadowOpacity", + "documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match." + }, + "ShadowXOffset": { + "shape": "__integer", + "locationName": "shadowXOffset", + "documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match." + }, + "ShadowYOffset": { + "shape": "__integer", + "locationName": "shadowYOffset", + "documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match." + }, + "TeletextGridControl": { + "shape": "DvbSubDestinationTeletextGridControl", + "locationName": "teletextGridControl", + "documentation": "Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs." + }, + "XPosition": { + "shape": "__integerMin0", + "locationName": "xPosition", + "documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + }, + "YPosition": { + "shape": "__integerMin0", + "locationName": "yPosition", + "documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match." + } + }, + "documentation": "Dvb Sub Destination Settings" + }, + "DvbSubDestinationShadowColor": { + "type": "string", + "documentation": "Dvb Sub Destination Shadow Color", + "enum": [ + "BLACK", + "NONE", + "WHITE" + ] + }, + "DvbSubDestinationTeletextGridControl": { + "type": "string", + "documentation": "Dvb Sub Destination Teletext Grid Control", + "enum": [ + "FIXED", + "SCALED" + ] + }, + "DvbSubSourceSettings": { + "type": "structure", + "members": { + "Pid": { + "shape": "__integerMin1", + "locationName": "pid", + "documentation": "When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors." + } + }, + "documentation": "Dvb Sub Source Settings" + }, + "DvbTdtSettings": { + "type": "structure", + "members": { + "RepInterval": { + "shape": "__integerMin1000Max30000", + "locationName": "repInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream." + } + }, + "documentation": "DVB Time and Date Table (SDT)" + }, + "Eac3AttenuationControl": { + "type": "string", + "documentation": "Eac3 Attenuation Control", + "enum": [ + "ATTENUATE_3_DB", + "NONE" + ] + }, + "Eac3BitstreamMode": { + "type": "string", + "documentation": "Eac3 Bitstream Mode", + "enum": [ + "COMMENTARY", + "COMPLETE_MAIN", + "EMERGENCY", + "HEARING_IMPAIRED", + "VISUALLY_IMPAIRED" + ] + }, + "Eac3CodingMode": { + "type": "string", + "documentation": "Eac3 Coding Mode", + "enum": [ + "CODING_MODE_1_0", + "CODING_MODE_2_0", + "CODING_MODE_3_2" + ] + }, + "Eac3DcFilter": { + "type": "string", + "documentation": "Eac3 Dc Filter", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Eac3DrcLine": { + "type": "string", + "documentation": "Eac3 Drc Line", + "enum": [ + "FILM_LIGHT", + "FILM_STANDARD", + "MUSIC_LIGHT", + "MUSIC_STANDARD", + "NONE", + "SPEECH" + ] + }, + "Eac3DrcRf": { + "type": "string", + "documentation": "Eac3 Drc Rf", + "enum": [ + "FILM_LIGHT", + "FILM_STANDARD", + "MUSIC_LIGHT", + "MUSIC_STANDARD", + "NONE", + "SPEECH" + ] + }, + "Eac3LfeControl": { + "type": "string", + "documentation": "Eac3 Lfe Control", + "enum": [ + "LFE", + "NO_LFE" + ] + }, + "Eac3LfeFilter": { + "type": "string", + "documentation": "Eac3 Lfe Filter", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "Eac3MetadataControl": { + "type": "string", + "documentation": "Eac3 Metadata Control", + "enum": [ + "FOLLOW_INPUT", + "USE_CONFIGURED" + ] + }, + "Eac3PassthroughControl": { + "type": "string", + "documentation": "Eac3 Passthrough Control", + "enum": [ + "NO_PASSTHROUGH", + "WHEN_POSSIBLE" + ] + }, + "Eac3PhaseControl": { + "type": "string", + "documentation": "Eac3 Phase Control", + "enum": [ + "NO_SHIFT", + "SHIFT_90_DEGREES" + ] + }, + "Eac3Settings": { + "type": "structure", + "members": { + "AttenuationControl": { + "shape": "Eac3AttenuationControl", + "locationName": "attenuationControl", + "documentation": "When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode." + }, + "Bitrate": { + "shape": "__double", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Valid bitrates depend on the coding mode." + }, + "BitstreamMode": { + "shape": "Eac3BitstreamMode", + "locationName": "bitstreamMode", + "documentation": "Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values." + }, + "CodingMode": { + "shape": "Eac3CodingMode", + "locationName": "codingMode", + "documentation": "Dolby Digital Plus coding mode. Determines number of channels." + }, + "DcFilter": { + "shape": "Eac3DcFilter", + "locationName": "dcFilter", + "documentation": "When set to enabled, activates a DC highpass filter for all input channels." + }, + "Dialnorm": { + "shape": "__integerMin1Max31", + "locationName": "dialnorm", + "documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through." + }, + "DrcLine": { + "shape": "Eac3DrcLine", + "locationName": "drcLine", + "documentation": "Sets the Dolby dynamic range compression profile." + }, + "DrcRf": { + "shape": "Eac3DrcRf", + "locationName": "drcRf", + "documentation": "Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels." + }, + "LfeControl": { + "shape": "Eac3LfeControl", + "locationName": "lfeControl", + "documentation": "When encoding 3/2 audio, setting to lfe enables the LFE channel" + }, + "LfeFilter": { + "shape": "Eac3LfeFilter", + "locationName": "lfeFilter", + "documentation": "When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode." + }, + "LoRoCenterMixLevel": { + "shape": "__double", + "locationName": "loRoCenterMixLevel", + "documentation": "Left only/Right only center mix level. Only used for 3/2 coding mode." + }, + "LoRoSurroundMixLevel": { + "shape": "__double", + "locationName": "loRoSurroundMixLevel", + "documentation": "Left only/Right only surround mix level. Only used for 3/2 coding mode." + }, + "LtRtCenterMixLevel": { + "shape": "__double", + "locationName": "ltRtCenterMixLevel", + "documentation": "Left total/Right total center mix level. Only used for 3/2 coding mode." + }, + "LtRtSurroundMixLevel": { + "shape": "__double", + "locationName": "ltRtSurroundMixLevel", + "documentation": "Left total/Right total surround mix level. Only used for 3/2 coding mode." + }, + "MetadataControl": { + "shape": "Eac3MetadataControl", + "locationName": "metadataControl", + "documentation": "When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used." + }, + "PassthroughControl": { + "shape": "Eac3PassthroughControl", + "locationName": "passthroughControl", + "documentation": "When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding." + }, + "PhaseControl": { + "shape": "Eac3PhaseControl", + "locationName": "phaseControl", + "documentation": "When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode." + }, + "StereoDownmix": { + "shape": "Eac3StereoDownmix", + "locationName": "stereoDownmix", + "documentation": "Stereo downmix preference. Only used for 3/2 coding mode." + }, + "SurroundExMode": { + "shape": "Eac3SurroundExMode", + "locationName": "surroundExMode", + "documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels." + }, + "SurroundMode": { + "shape": "Eac3SurroundMode", + "locationName": "surroundMode", + "documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels." + } + }, + "documentation": "Eac3 Settings" + }, + "Eac3StereoDownmix": { + "type": "string", + "documentation": "Eac3 Stereo Downmix", + "enum": [ + "DPL2", + "LO_RO", + "LT_RT", + "NOT_INDICATED" + ] + }, + "Eac3SurroundExMode": { + "type": "string", + "documentation": "Eac3 Surround Ex Mode", + "enum": [ + "DISABLED", + "ENABLED", + "NOT_INDICATED" + ] + }, + "Eac3SurroundMode": { + "type": "string", + "documentation": "Eac3 Surround Mode", + "enum": [ + "DISABLED", + "ENABLED", + "NOT_INDICATED" + ] + }, + "EmbeddedConvert608To708": { + "type": "string", + "documentation": "Embedded Convert608 To708", + "enum": [ + "DISABLED", + "UPCONVERT" + ] + }, + "EmbeddedDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Embedded Destination Settings" + }, + "EmbeddedPlusScte20DestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Embedded Plus Scte20 Destination Settings" + }, + "EmbeddedScte20Detection": { + "type": "string", + "documentation": "Embedded Scte20 Detection", + "enum": [ + "AUTO", + "OFF" + ] + }, + "EmbeddedSourceSettings": { + "type": "structure", + "members": { + "Convert608To708": { + "shape": "EmbeddedConvert608To708", + "locationName": "convert608To708", + "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded." + }, + "Scte20Detection": { + "shape": "EmbeddedScte20Detection", + "locationName": "scte20Detection", + "documentation": "Set to \"auto\" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions." + }, + "Source608ChannelNumber": { + "shape": "__integerMin1Max4", + "locationName": "source608ChannelNumber", + "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough." + }, + "Source608TrackNumber": { + "shape": "__integerMin1Max5", + "locationName": "source608TrackNumber", + "documentation": "This field is unused and deprecated." + } + }, + "documentation": "Embedded Source Settings" + }, + "Empty": { + "type": "structure", + "members": { + }, + "documentation": "Placeholder documentation for Empty" + }, + "EncoderSettings": { + "type": "structure", + "members": { + "AudioDescriptions": { + "shape": "__listOfAudioDescription", + "locationName": "audioDescriptions" + }, + "AvailBlanking": { + "shape": "AvailBlanking", + "locationName": "availBlanking", + "documentation": "Settings for ad avail blanking." + }, + "AvailConfiguration": { + "shape": "AvailConfiguration", + "locationName": "availConfiguration", + "documentation": "Event-wide configuration settings for ad avail insertion." + }, + "BlackoutSlate": { + "shape": "BlackoutSlate", + "locationName": "blackoutSlate", + "documentation": "Settings for blackout slate." + }, + "CaptionDescriptions": { + "shape": "__listOfCaptionDescription", + "locationName": "captionDescriptions", + "documentation": "Settings for caption decriptions" + }, + "GlobalConfiguration": { + "shape": "GlobalConfiguration", + "locationName": "globalConfiguration", + "documentation": "Configuration settings that apply to the event as a whole." + }, + "OutputGroups": { + "shape": "__listOfOutputGroup", + "locationName": "outputGroups" + }, + "TimecodeConfig": { + "shape": "TimecodeConfig", + "locationName": "timecodeConfig", + "documentation": "Contains settings used to acquire and adjust timecode information from inputs." + }, + "VideoDescriptions": { + "shape": "__listOfVideoDescription", + "locationName": "videoDescriptions" + } + }, + "documentation": "Encoder Settings", + "required": [ + "VideoDescriptions", + "AudioDescriptions", + "OutputGroups", + "TimecodeConfig" + ] + }, + "FecOutputIncludeFec": { + "type": "string", + "documentation": "Fec Output Include Fec", + "enum": [ + "COLUMN", + "COLUMN_AND_ROW" + ] + }, + "FecOutputSettings": { + "type": "structure", + "members": { + "ColumnDepth": { + "shape": "__integerMin4Max20", + "locationName": "columnDepth", + "documentation": "Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive." + }, + "IncludeFec": { + "shape": "FecOutputIncludeFec", + "locationName": "includeFec", + "documentation": "Enables column only or column and row based FEC" + }, + "RowLength": { + "shape": "__integerMin1Max20", + "locationName": "rowLength", + "documentation": "Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive." + } + }, + "documentation": "Fec Output Settings" + }, + "FixedAfd": { + "type": "string", + "documentation": "Fixed Afd", + "enum": [ + "AFD_0000", + "AFD_0010", + "AFD_0011", + "AFD_0100", + "AFD_1000", + "AFD_1001", + "AFD_1010", + "AFD_1011", + "AFD_1101", + "AFD_1110", + "AFD_1111" + ] + }, + "FixedModeScheduleActionStartSettings": { + "type": "structure", + "members": { + "Time": { + "shape": "__string", + "locationName": "time", + "documentation": "Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants \"T\" for time and \"Z\" for \"UTC format\"." + } + }, + "documentation": "Start time for the action.", + "required": [ + "Time" + ] + }, + "FollowModeScheduleActionStartSettings": { + "type": "structure", + "members": { + "FollowPoint": { + "shape": "FollowPoint", + "locationName": "followPoint", + "documentation": "Identifies whether this action starts relative to the start or relative to the end of the reference action." + }, + "ReferenceActionName": { + "shape": "__string", + "locationName": "referenceActionName", + "documentation": "The action name of another action that this one refers to." + } + }, + "documentation": "Settings to specify if an action follows another.", + "required": [ + "ReferenceActionName", + "FollowPoint" + ] + }, + "FollowPoint": { + "type": "string", + "documentation": "Follow reference point.", + "enum": [ + "END", + "START" + ] + }, + "ForbiddenException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 403 + }, + "documentation": "Placeholder documentation for ForbiddenException" + }, + "FrameCaptureGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling_) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling_). The final file names consist of the prefix from the destination field (for example, \"curling_\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg" + } + }, + "documentation": "Frame Capture Group Settings", + "required": [ + "Destination" + ] + }, + "FrameCaptureOutputSettings": { + "type": "structure", + "members": { + "NameModifier": { + "shape": "__string", + "locationName": "nameModifier", + "documentation": "Required if the output group contains more than one output. This modifier forms part of the output file name." + } + }, + "documentation": "Frame Capture Output Settings" + }, + "FrameCaptureSettings": { + "type": "structure", + "members": { + "CaptureInterval": { + "shape": "__integerMin1Max3600", + "locationName": "captureInterval", + "documentation": "The frequency, in seconds, for capturing frames for inclusion in the output. For example, \"10\" means capture a frame every 10 seconds." + } + }, + "documentation": "Frame Capture Settings", + "required": [ + "CaptureInterval" + ] + }, + "GatewayTimeoutException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 504 + }, + "documentation": "Placeholder documentation for GatewayTimeoutException" + }, + "GlobalConfiguration": { + "type": "structure", + "members": { + "InitialAudioGain": { + "shape": "__integerMinNegative60Max60", + "locationName": "initialAudioGain", + "documentation": "Value to set the initial audio gain for the Live Event." + }, + "InputEndAction": { + "shape": "GlobalConfigurationInputEndAction", + "locationName": "inputEndAction", + "documentation": "Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When \"none\" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the \"Input Loss Behavior\" configuration until the next input switch occurs (which is controlled through the Channel Schedule API)." + }, + "InputLossBehavior": { + "shape": "InputLossBehavior", + "locationName": "inputLossBehavior", + "documentation": "Settings for system actions when input is lost." + }, + "OutputLockingMode": { + "shape": "GlobalConfigurationOutputLockingMode", + "locationName": "outputLockingMode", + "documentation": "Indicates how MediaLive pipelines are synchronized.\n\nPIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other.\nEPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch." + }, + "OutputTimingSource": { + "shape": "GlobalConfigurationOutputTimingSource", + "locationName": "outputTimingSource", + "documentation": "Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream." + }, + "SupportLowFramerateInputs": { + "shape": "GlobalConfigurationLowFramerateInputs", + "locationName": "supportLowFramerateInputs", + "documentation": "Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second." + } + }, + "documentation": "Global Configuration" + }, + "GlobalConfigurationInputEndAction": { + "type": "string", + "documentation": "Global Configuration Input End Action", + "enum": [ + "NONE", + "SWITCH_AND_LOOP_INPUTS" + ] + }, + "GlobalConfigurationLowFramerateInputs": { + "type": "string", + "documentation": "Global Configuration Low Framerate Inputs", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "GlobalConfigurationOutputLockingMode": { + "type": "string", + "documentation": "Global Configuration Output Locking Mode", + "enum": [ + "EPOCH_LOCKING", + "PIPELINE_LOCKING" + ] + }, + "GlobalConfigurationOutputTimingSource": { + "type": "string", + "documentation": "Global Configuration Output Timing Source", + "enum": [ + "INPUT_CLOCK", + "SYSTEM_CLOCK" + ] + }, + "H264AdaptiveQuantization": { + "type": "string", + "documentation": "H264 Adaptive Quantization", + "enum": [ + "HIGH", + "HIGHER", + "LOW", + "MAX", + "MEDIUM", + "OFF" + ] + }, + "H264ColorMetadata": { + "type": "string", + "documentation": "H264 Color Metadata", + "enum": [ + "IGNORE", + "INSERT" + ] + }, + "H264ColorSpaceSettings": { + "type": "structure", + "members": { + "ColorSpacePassthroughSettings": { + "shape": "ColorSpacePassthroughSettings", + "locationName": "colorSpacePassthroughSettings" + }, + "Rec601Settings": { + "shape": "Rec601Settings", + "locationName": "rec601Settings" + }, + "Rec709Settings": { + "shape": "Rec709Settings", + "locationName": "rec709Settings" + } + }, + "documentation": "H264 Color Space Settings" + }, + "H264EntropyEncoding": { + "type": "string", + "documentation": "H264 Entropy Encoding", + "enum": [ + "CABAC", + "CAVLC" + ] + }, + "H264FlickerAq": { + "type": "string", + "documentation": "H264 Flicker Aq", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264FramerateControl": { + "type": "string", + "documentation": "H264 Framerate Control", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H264GopBReference": { + "type": "string", + "documentation": "H264 Gop BReference", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264GopSizeUnits": { + "type": "string", + "documentation": "H264 Gop Size Units", + "enum": [ + "FRAMES", + "SECONDS" + ] + }, + "H264Level": { + "type": "string", + "documentation": "H264 Level", + "enum": [ + "H264_LEVEL_1", + "H264_LEVEL_1_1", + "H264_LEVEL_1_2", + "H264_LEVEL_1_3", + "H264_LEVEL_2", + "H264_LEVEL_2_1", + "H264_LEVEL_2_2", + "H264_LEVEL_3", + "H264_LEVEL_3_1", + "H264_LEVEL_3_2", + "H264_LEVEL_4", + "H264_LEVEL_4_1", + "H264_LEVEL_4_2", + "H264_LEVEL_5", + "H264_LEVEL_5_1", + "H264_LEVEL_5_2", + "H264_LEVEL_AUTO" + ] + }, + "H264LookAheadRateControl": { + "type": "string", + "documentation": "H264 Look Ahead Rate Control", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ] + }, + "H264ParControl": { + "type": "string", + "documentation": "H264 Par Control", + "enum": [ + "INITIALIZE_FROM_SOURCE", + "SPECIFIED" + ] + }, + "H264Profile": { + "type": "string", + "documentation": "H264 Profile", + "enum": [ + "BASELINE", + "HIGH", + "HIGH_10BIT", + "HIGH_422", + "HIGH_422_10BIT", + "MAIN" + ] + }, + "H264RateControlMode": { + "type": "string", + "documentation": "H264 Rate Control Mode", + "enum": [ + "CBR", + "MULTIPLEX", + "QVBR", + "VBR" + ] + }, + "H264ScanType": { + "type": "string", + "documentation": "H264 Scan Type", + "enum": [ + "INTERLACED", + "PROGRESSIVE" + ] + }, + "H264SceneChangeDetect": { + "type": "string", + "documentation": "H264 Scene Change Detect", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "shape": "H264AdaptiveQuantization", + "locationName": "adaptiveQuantization", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality." + }, + "AfdSignaling": { + "shape": "AfdSignaling", + "locationName": "afdSignaling", + "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter." + }, + "Bitrate": { + "shape": "__integerMin1000", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000." + }, + "BufFillPct": { + "shape": "__integerMin0Max100", + "locationName": "bufFillPct", + "documentation": "Percentage of the buffer that should initially be filled (HRD buffer model)." + }, + "BufSize": { + "shape": "__integerMin0", + "locationName": "bufSize", + "documentation": "Size of buffer (HRD buffer model) in bits." + }, + "ColorMetadata": { + "shape": "H264ColorMetadata", + "locationName": "colorMetadata", + "documentation": "Includes colorspace metadata in the output." + }, + "ColorSpaceSettings": { + "shape": "H264ColorSpaceSettings", + "locationName": "colorSpaceSettings", + "documentation": "Color Space settings" + }, + "EntropyEncoding": { + "shape": "H264EntropyEncoding", + "locationName": "entropyEncoding", + "documentation": "Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc." + }, + "FixedAfd": { + "shape": "FixedAfd", + "locationName": "fixedAfd", + "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'." + }, + "FlickerAq": { + "shape": "H264FlickerAq", + "locationName": "flickerAq", + "documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames." + }, + "FramerateControl": { + "shape": "H264FramerateControl", + "locationName": "framerateControl", + "documentation": "This field indicates how the output video frame rate is specified. If \"specified\" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if \"initializeFromSource\" is selected then the output video frame rate will be set equal to the input video frame rate of the first input." + }, + "FramerateDenominator": { + "shape": "__integerMin1", + "locationName": "framerateDenominator", + "documentation": "Framerate denominator." + }, + "FramerateNumerator": { + "shape": "__integerMin1", + "locationName": "framerateNumerator", + "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps." + }, + "GopBReference": { + "shape": "H264GopBReference", + "locationName": "gopBReference", + "documentation": "Documentation update needed" + }, + "GopClosedCadence": { + "shape": "__integerMin0", + "locationName": "gopClosedCadence", + "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." + }, + "GopNumBFrames": { + "shape": "__integerMin0Max7", + "locationName": "gopNumBFrames", + "documentation": "Number of B-frames between reference frames." + }, + "GopSize": { + "shape": "__doubleMin1", + "locationName": "gopSize", + "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero." + }, + "GopSizeUnits": { + "shape": "H264GopSizeUnits", + "locationName": "gopSizeUnits", + "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time." + }, + "Level": { + "shape": "H264Level", + "locationName": "level", + "documentation": "H.264 Level." + }, + "LookAheadRateControl": { + "shape": "H264LookAheadRateControl", + "locationName": "lookAheadRateControl", + "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content." + }, + "MaxBitrate": { + "shape": "__integerMin1000", + "locationName": "maxBitrate", + "documentation": "For QVBR: See the tooltip for Quality level\n\nFor VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video." + }, + "MinIInterval": { + "shape": "__integerMin0Max30", + "locationName": "minIInterval", + "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1" + }, + "NumRefFrames": { + "shape": "__integerMin1Max6", + "locationName": "numRefFrames", + "documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding." + }, + "ParControl": { + "shape": "H264ParControl", + "locationName": "parControl", + "documentation": "This field indicates how the output pixel aspect ratio is specified. If \"specified\" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if \"initializeFromSource\" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input." + }, + "ParDenominator": { + "shape": "__integerMin1", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integer", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "Profile": { + "shape": "H264Profile", + "locationName": "profile", + "documentation": "H.264 Profile." + }, + "QvbrQualityLevel": { + "shape": "__integerMin1Max10", + "locationName": "qvbrQualityLevel", + "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M" + }, + "RateControlMode": { + "shape": "H264RateControlMode", + "locationName": "rateControlMode", + "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nVBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR\nif you want to maintain a specific average bitrate over the duration of the channel.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates." + }, + "ScanType": { + "shape": "H264ScanType", + "locationName": "scanType", + "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced." + }, + "SceneChangeDetect": { + "shape": "H264SceneChangeDetect", + "locationName": "sceneChangeDetect", + "documentation": "Scene change detection.\n\n- On: inserts I-frames when scene change is detected.\n- Off: does not force an I-frame when scene change is detected." + }, + "Slices": { + "shape": "__integerMin1Max32", + "locationName": "slices", + "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution." + }, + "Softness": { + "shape": "__integerMin0Max128", + "locationName": "softness", + "documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image." + }, + "SpatialAq": { + "shape": "H264SpatialAq", + "locationName": "spatialAq", + "documentation": "If set to enabled, adjust quantization within each frame based on spatial variation of content complexity." + }, + "SubgopLength": { + "shape": "H264SubGopLength", + "locationName": "subgopLength", + "documentation": "If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality." + }, + "Syntax": { + "shape": "H264Syntax", + "locationName": "syntax", + "documentation": "Produces a bitstream compliant with SMPTE RP-2027." + }, + "TemporalAq": { + "shape": "H264TemporalAq", + "locationName": "temporalAq", + "documentation": "If set to enabled, adjust quantization within each frame based on temporal variation of content complexity." + }, + "TimecodeInsertion": { + "shape": "H264TimecodeInsertionBehavior", + "locationName": "timecodeInsertion", + "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config" + } + }, + "documentation": "H264 Settings" + }, + "H264SpatialAq": { + "type": "string", + "documentation": "H264 Spatial Aq", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264SubGopLength": { + "type": "string", + "documentation": "H264 Sub Gop Length", + "enum": [ + "DYNAMIC", + "FIXED" + ] + }, + "H264Syntax": { + "type": "string", + "documentation": "H264 Syntax", + "enum": [ + "DEFAULT", + "RP2027" + ] + }, + "H264TemporalAq": { + "type": "string", + "documentation": "H264 Temporal Aq", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H264TimecodeInsertionBehavior": { + "type": "string", + "documentation": "H264 Timecode Insertion Behavior", + "enum": [ + "DISABLED", + "PIC_TIMING_SEI" + ] + }, + "H265AdaptiveQuantization": { + "type": "string", + "documentation": "H265 Adaptive Quantization", + "enum": [ + "HIGH", + "HIGHER", + "LOW", + "MAX", + "MEDIUM", + "OFF" + ] + }, + "H265AlternativeTransferFunction": { + "type": "string", + "documentation": "H265 Alternative Transfer Function", + "enum": [ + "INSERT", + "OMIT" + ] + }, + "H265ColorMetadata": { + "type": "string", + "documentation": "H265 Color Metadata", + "enum": [ + "IGNORE", + "INSERT" + ] + }, + "H265ColorSpaceSettings": { + "type": "structure", + "members": { + "ColorSpacePassthroughSettings": { + "shape": "ColorSpacePassthroughSettings", + "locationName": "colorSpacePassthroughSettings" + }, + "Hdr10Settings": { + "shape": "Hdr10Settings", + "locationName": "hdr10Settings" + }, + "Rec601Settings": { + "shape": "Rec601Settings", + "locationName": "rec601Settings" + }, + "Rec709Settings": { + "shape": "Rec709Settings", + "locationName": "rec709Settings" + } + }, + "documentation": "H265 Color Space Settings" + }, + "H265FlickerAq": { + "type": "string", + "documentation": "H265 Flicker Aq", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265GopSizeUnits": { + "type": "string", + "documentation": "H265 Gop Size Units", + "enum": [ + "FRAMES", + "SECONDS" + ] + }, + "H265Level": { + "type": "string", + "documentation": "H265 Level", + "enum": [ + "H265_LEVEL_1", + "H265_LEVEL_2", + "H265_LEVEL_2_1", + "H265_LEVEL_3", + "H265_LEVEL_3_1", + "H265_LEVEL_4", + "H265_LEVEL_4_1", + "H265_LEVEL_5", + "H265_LEVEL_5_1", + "H265_LEVEL_5_2", + "H265_LEVEL_6", + "H265_LEVEL_6_1", + "H265_LEVEL_6_2", + "H265_LEVEL_AUTO" + ] + }, + "H265LookAheadRateControl": { + "type": "string", + "documentation": "H265 Look Ahead Rate Control", + "enum": [ + "HIGH", + "LOW", + "MEDIUM" + ] + }, + "H265Profile": { + "type": "string", + "documentation": "H265 Profile", + "enum": [ + "MAIN", + "MAIN_10BIT" + ] + }, + "H265RateControlMode": { + "type": "string", + "documentation": "H265 Rate Control Mode", + "enum": [ + "CBR", + "QVBR" + ] + }, + "H265ScanType": { + "type": "string", + "documentation": "H265 Scan Type", + "enum": [ + "PROGRESSIVE" + ] + }, + "H265SceneChangeDetect": { + "type": "string", + "documentation": "H265 Scene Change Detect", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "H265Settings": { + "type": "structure", + "members": { + "AdaptiveQuantization": { + "shape": "H265AdaptiveQuantization", + "locationName": "adaptiveQuantization", + "documentation": "Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality." + }, + "AfdSignaling": { + "shape": "AfdSignaling", + "locationName": "afdSignaling", + "documentation": "Indicates that AFD values will be written into the output stream. If afdSignaling is \"auto\", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to \"fixed\", the AFD value will be the value configured in the fixedAfd parameter." + }, + "AlternativeTransferFunction": { + "shape": "H265AlternativeTransferFunction", + "locationName": "alternativeTransferFunction", + "documentation": "Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays." + }, + "Bitrate": { + "shape": "__integerMin100000Max40000000", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000." + }, + "BufSize": { + "shape": "__integerMin100000Max80000000", + "locationName": "bufSize", + "documentation": "Size of buffer (HRD buffer model) in bits." + }, + "ColorMetadata": { + "shape": "H265ColorMetadata", + "locationName": "colorMetadata", + "documentation": "Includes colorspace metadata in the output." + }, + "ColorSpaceSettings": { + "shape": "H265ColorSpaceSettings", + "locationName": "colorSpaceSettings", + "documentation": "Color Space settings" + }, + "FixedAfd": { + "shape": "FixedAfd", + "locationName": "fixedAfd", + "documentation": "Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'." + }, + "FlickerAq": { + "shape": "H265FlickerAq", + "locationName": "flickerAq", + "documentation": "If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames." + }, + "FramerateDenominator": { + "shape": "__integerMin1Max3003", + "locationName": "framerateDenominator", + "documentation": "Framerate denominator." + }, + "FramerateNumerator": { + "shape": "__integerMin1", + "locationName": "framerateNumerator", + "documentation": "Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps." + }, + "GopClosedCadence": { + "shape": "__integerMin0", + "locationName": "gopClosedCadence", + "documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting." + }, + "GopSize": { + "shape": "__doubleMin1", + "locationName": "gopSize", + "documentation": "GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero." + }, + "GopSizeUnits": { + "shape": "H265GopSizeUnits", + "locationName": "gopSizeUnits", + "documentation": "Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time." + }, + "Level": { + "shape": "H265Level", + "locationName": "level", + "documentation": "H.265 Level." + }, + "LookAheadRateControl": { + "shape": "H265LookAheadRateControl", + "locationName": "lookAheadRateControl", + "documentation": "Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content." + }, + "MaxBitrate": { + "shape": "__integerMin100000Max40000000", + "locationName": "maxBitrate", + "documentation": "For QVBR: See the tooltip for Quality level" + }, + "MinIInterval": { + "shape": "__integerMin0Max30", + "locationName": "minIInterval", + "documentation": "Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1" + }, + "ParDenominator": { + "shape": "__integerMin1", + "locationName": "parDenominator", + "documentation": "Pixel Aspect Ratio denominator." + }, + "ParNumerator": { + "shape": "__integerMin1", + "locationName": "parNumerator", + "documentation": "Pixel Aspect Ratio numerator." + }, + "Profile": { + "shape": "H265Profile", + "locationName": "profile", + "documentation": "H.265 Profile." + }, + "QvbrQualityLevel": { + "shape": "__integerMin1Max10", + "locationName": "qvbrQualityLevel", + "documentation": "Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are:\n- Primary screen: Quality level: 8 to 10. Max bitrate: 4M\n- PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M\n- Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M" + }, + "RateControlMode": { + "shape": "H265RateControlMode", + "locationName": "rateControlMode", + "documentation": "Rate control mode.\n\nQVBR: Quality will match the specified quality level except when it is constrained by the\nmaximum bitrate. Recommended if you or your viewers pay for bandwidth.\n\nCBR: Quality varies, depending on the video complexity. Recommended only if you distribute\nyour assets to devices that cannot handle variable bitrates." + }, + "ScanType": { + "shape": "H265ScanType", + "locationName": "scanType", + "documentation": "Sets the scan type of the output to progressive or top-field-first interlaced." + }, + "SceneChangeDetect": { + "shape": "H265SceneChangeDetect", + "locationName": "sceneChangeDetect", + "documentation": "Scene change detection." + }, + "Slices": { + "shape": "__integerMin1Max16", + "locationName": "slices", + "documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.\nThis field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution." + }, + "Tier": { + "shape": "H265Tier", + "locationName": "tier", + "documentation": "H.265 Tier." + }, + "TimecodeInsertion": { + "shape": "H265TimecodeInsertionBehavior", + "locationName": "timecodeInsertion", + "documentation": "Determines how timecodes should be inserted into the video elementary stream.\n- 'disabled': Do not include timecodes\n- 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config" + } + }, + "documentation": "H265 Settings", + "required": [ + "FramerateNumerator", + "FramerateDenominator" + ] + }, + "H265Tier": { + "type": "string", + "documentation": "H265 Tier", + "enum": [ + "HIGH", + "MAIN" + ] + }, + "H265TimecodeInsertionBehavior": { + "type": "string", + "documentation": "H265 Timecode Insertion Behavior", + "enum": [ + "DISABLED", + "PIC_TIMING_SEI" + ] + }, + "Hdr10Settings": { + "type": "structure", + "members": { + "MaxCll": { + "shape": "__integerMin0Max32768", + "locationName": "maxCll", + "documentation": "Maximum Content Light Level\nAn integer metadata value defining the maximum light level, in nits,\nof any single pixel within an encoded HDR video stream or file." + }, + "MaxFall": { + "shape": "__integerMin0Max32768", + "locationName": "maxFall", + "documentation": "Maximum Frame Average Light Level\nAn integer metadata value defining the maximum average light level, in nits,\nfor any single frame within an encoded HDR video stream or file." + } + }, + "documentation": "Hdr10 Settings" + }, + "HlsAdMarkers": { + "type": "string", + "documentation": "Hls Ad Markers", + "enum": [ + "ADOBE", + "ELEMENTAL", + "ELEMENTAL_SCTE35" + ] + }, + "HlsAkamaiHttpTransferMode": { + "type": "string", + "documentation": "Hls Akamai Http Transfer Mode", + "enum": [ + "CHUNKED", + "NON_CHUNKED" + ] + }, + "HlsAkamaiSettings": { + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "shape": "__integerMin0", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost." + }, + "FilecacheDuration": { + "shape": "__integerMin0Max600", + "locationName": "filecacheDuration", + "documentation": "Size in seconds of file cache for streaming outputs." + }, + "HttpTransferMode": { + "shape": "HlsAkamaiHttpTransferMode", + "locationName": "httpTransferMode", + "documentation": "Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state." + }, + "RestartDelay": { + "shape": "__integerMin0Max15", + "locationName": "restartDelay", + "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart." + }, + "Salt": { + "shape": "__string", + "locationName": "salt", + "documentation": "Salt for authenticated Akamai." + }, + "Token": { + "shape": "__string", + "locationName": "token", + "documentation": "Token parameter for authenticated akamai. If not specified, _gda_ is used." + } + }, + "documentation": "Hls Akamai Settings" + }, + "HlsBasicPutSettings": { + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "shape": "__integerMin0", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost." + }, + "FilecacheDuration": { + "shape": "__integerMin0Max600", + "locationName": "filecacheDuration", + "documentation": "Size in seconds of file cache for streaming outputs." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state." + }, + "RestartDelay": { + "shape": "__integerMin0Max15", + "locationName": "restartDelay", + "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart." + } + }, + "documentation": "Hls Basic Put Settings" + }, + "HlsCaptionLanguageSetting": { + "type": "string", + "documentation": "Hls Caption Language Setting", + "enum": [ + "INSERT", + "NONE", + "OMIT" + ] + }, + "HlsCdnSettings": { + "type": "structure", + "members": { + "HlsAkamaiSettings": { + "shape": "HlsAkamaiSettings", + "locationName": "hlsAkamaiSettings" + }, + "HlsBasicPutSettings": { + "shape": "HlsBasicPutSettings", + "locationName": "hlsBasicPutSettings" + }, + "HlsMediaStoreSettings": { + "shape": "HlsMediaStoreSettings", + "locationName": "hlsMediaStoreSettings" + }, + "HlsWebdavSettings": { + "shape": "HlsWebdavSettings", + "locationName": "hlsWebdavSettings" + } + }, + "documentation": "Hls Cdn Settings" + }, + "HlsClientCache": { + "type": "string", + "documentation": "Hls Client Cache", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "HlsCodecSpecification": { + "type": "string", + "documentation": "Hls Codec Specification", + "enum": [ + "RFC_4281", + "RFC_6381" + ] + }, + "HlsDirectoryStructure": { + "type": "string", + "documentation": "Hls Directory Structure", + "enum": [ + "SINGLE_DIRECTORY", + "SUBDIRECTORY_PER_STREAM" + ] + }, + "HlsEncryptionType": { + "type": "string", + "documentation": "Hls Encryption Type", + "enum": [ + "AES128", + "SAMPLE_AES" + ] + }, + "HlsGroupSettings": { + "type": "structure", + "members": { + "AdMarkers": { + "shape": "__listOfHlsAdMarkers", + "locationName": "adMarkers", + "documentation": "Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs." + }, + "BaseUrlContent": { + "shape": "__string", + "locationName": "baseUrlContent", + "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file." + }, + "BaseUrlManifest": { + "shape": "__string", + "locationName": "baseUrlManifest", + "documentation": "A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file." + }, + "CaptionLanguageMappings": { + "shape": "__listOfCaptionLanguageMapping", + "locationName": "captionLanguageMappings", + "documentation": "Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to \"insert\"." + }, + "CaptionLanguageSetting": { + "shape": "HlsCaptionLanguageSetting", + "locationName": "captionLanguageSetting", + "documentation": "Applies only to 608 Embedded output captions.\ninsert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.\nnone: Include CLOSED-CAPTIONS=NONE line in the manifest.\nomit: Omit any CLOSED-CAPTIONS line from the manifest." + }, + "ClientCache": { + "shape": "HlsClientCache", + "locationName": "clientCache", + "documentation": "When set to \"disabled\", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay." + }, + "CodecSpecification": { + "shape": "HlsCodecSpecification", + "locationName": "codecSpecification", + "documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation." + }, + "ConstantIv": { + "shape": "__stringMin32Max32", + "locationName": "constantIv", + "documentation": "For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to \"explicit\" then this parameter is required and is used as the IV for encryption." + }, + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled)." + }, + "DirectoryStructure": { + "shape": "HlsDirectoryStructure", + "locationName": "directoryStructure", + "documentation": "Place segments in subdirectories." + }, + "EncryptionType": { + "shape": "HlsEncryptionType", + "locationName": "encryptionType", + "documentation": "Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired." + }, + "HlsCdnSettings": { + "shape": "HlsCdnSettings", + "locationName": "hlsCdnSettings", + "documentation": "Parameters that control interactions with the CDN." + }, + "IFrameOnlyPlaylists": { + "shape": "IFrameOnlyPlaylistType", + "locationName": "iFrameOnlyPlaylists", + "documentation": "DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field).\n\nSTANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888\"" + }, + "IndexNSegments": { + "shape": "__integerMin3", + "locationName": "indexNSegments", + "documentation": "Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field." + }, + "InputLossAction": { + "shape": "InputLossActionForHlsOut", + "locationName": "inputLossAction", + "documentation": "Parameter that control output group behavior on input loss." + }, + "IvInManifest": { + "shape": "HlsIvInManifest", + "locationName": "ivInManifest", + "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to \"include\", IV is listed in the manifest, otherwise the IV is not in the manifest." + }, + "IvSource": { + "shape": "HlsIvSource", + "locationName": "ivSource", + "documentation": "For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is \"followsSegmentNumber\", it will cause the IV to change every segment (to match the segment number). If this is set to \"explicit\", you must enter a constantIv value." + }, + "KeepSegments": { + "shape": "__integerMin1", + "locationName": "keepSegments", + "documentation": "Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory." + }, + "KeyFormat": { + "shape": "__string", + "locationName": "keyFormat", + "documentation": "The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of \"identity\" is used. A reverse DNS string can also be given." + }, + "KeyFormatVersions": { + "shape": "__string", + "locationName": "keyFormatVersions", + "documentation": "Either a single positive integer version value or a slash delimited list of version values (1/2/3)." + }, + "KeyProviderSettings": { + "shape": "KeyProviderSettings", + "locationName": "keyProviderSettings", + "documentation": "The key provider settings." + }, + "ManifestCompression": { + "shape": "HlsManifestCompression", + "locationName": "manifestCompression", + "documentation": "When set to gzip, compresses HLS playlist." + }, + "ManifestDurationFormat": { + "shape": "HlsManifestDurationFormat", + "locationName": "manifestDurationFormat", + "documentation": "Indicates whether the output manifest should use floating point or integer values for segment duration." + }, + "MinSegmentLength": { + "shape": "__integerMin0", + "locationName": "minSegmentLength", + "documentation": "When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed." + }, + "Mode": { + "shape": "HlsMode", + "locationName": "mode", + "documentation": "If \"vod\", all segments are indexed and kept permanently in the destination and manifest. If \"live\", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.\n\nVOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a \"VOD\" type manifest on completion of the stream." + }, + "OutputSelection": { + "shape": "HlsOutputSelection", + "locationName": "outputSelection", + "documentation": "MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group.\n\nSEGMENTSONLY: Does not generate any manifests for this output group." + }, + "ProgramDateTime": { + "shape": "HlsProgramDateTime", + "locationName": "programDateTime", + "documentation": "Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset." + }, + "ProgramDateTimePeriod": { + "shape": "__integerMin0Max3600", + "locationName": "programDateTimePeriod", + "documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds." + }, + "RedundantManifest": { + "shape": "HlsRedundantManifest", + "locationName": "redundantManifest", + "documentation": "ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines.\n\nDISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only.\n\nFor an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant." + }, + "SegmentLength": { + "shape": "__integerMin1", + "locationName": "segmentLength", + "documentation": "Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer." + }, + "SegmentationMode": { + "shape": "HlsSegmentationMode", + "locationName": "segmentationMode", + "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used." + }, + "SegmentsPerSubdirectory": { + "shape": "__integerMin1", + "locationName": "segmentsPerSubdirectory", + "documentation": "Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect." + }, + "StreamInfResolution": { + "shape": "HlsStreamInfResolution", + "locationName": "streamInfResolution", + "documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest." + }, + "TimedMetadataId3Frame": { + "shape": "HlsTimedMetadataId3Frame", + "locationName": "timedMetadataId3Frame", + "documentation": "Indicates ID3 frame that has the timecode." + }, + "TimedMetadataId3Period": { + "shape": "__integerMin0", + "locationName": "timedMetadataId3Period", + "documentation": "Timed Metadata interval in seconds." + }, + "TimestampDeltaMilliseconds": { + "shape": "__integerMin0", + "locationName": "timestampDeltaMilliseconds", + "documentation": "Provides an extra millisecond delta offset to fine tune the timestamps." + }, + "TsFileMode": { + "shape": "HlsTsFileMode", + "locationName": "tsFileMode", + "documentation": "SEGMENTEDFILES: Emit the program as segments - multiple .ts media files.\n\nSINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching." + } + }, + "documentation": "Hls Group Settings", + "required": [ + "Destination" + ] + }, + "HlsInputSettings": { + "type": "structure", + "members": { + "Bandwidth": { + "shape": "__integerMin0", + "locationName": "bandwidth", + "documentation": "When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest." + }, + "BufferSegments": { + "shape": "__integerMin0", + "locationName": "bufferSegments", + "documentation": "When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8." + }, + "Retries": { + "shape": "__integerMin0", + "locationName": "retries", + "documentation": "The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable." + }, + "RetryInterval": { + "shape": "__integerMin0", + "locationName": "retryInterval", + "documentation": "The number of seconds between retries when an attempt to read a manifest or segment fails." + } + }, + "documentation": "Hls Input Settings" + }, + "HlsIvInManifest": { + "type": "string", + "documentation": "Hls Iv In Manifest", + "enum": [ + "EXCLUDE", + "INCLUDE" + ] + }, + "HlsIvSource": { + "type": "string", + "documentation": "Hls Iv Source", + "enum": [ + "EXPLICIT", + "FOLLOWS_SEGMENT_NUMBER" + ] + }, + "HlsManifestCompression": { + "type": "string", + "documentation": "Hls Manifest Compression", + "enum": [ + "GZIP", + "NONE" + ] + }, + "HlsManifestDurationFormat": { + "type": "string", + "documentation": "Hls Manifest Duration Format", + "enum": [ + "FLOATING_POINT", + "INTEGER" + ] + }, + "HlsMediaStoreSettings": { + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "shape": "__integerMin0", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost." + }, + "FilecacheDuration": { + "shape": "__integerMin0Max600", + "locationName": "filecacheDuration", + "documentation": "Size in seconds of file cache for streaming outputs." + }, + "MediaStoreStorageClass": { + "shape": "HlsMediaStoreStorageClass", + "locationName": "mediaStoreStorageClass", + "documentation": "When set to temporal, output files are stored in non-persistent memory for faster reading and writing." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state." + }, + "RestartDelay": { + "shape": "__integerMin0Max15", + "locationName": "restartDelay", + "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart." + } + }, + "documentation": "Hls Media Store Settings" + }, + "HlsMediaStoreStorageClass": { + "type": "string", + "documentation": "Hls Media Store Storage Class", + "enum": [ + "TEMPORAL" + ] + }, + "HlsMode": { + "type": "string", + "documentation": "Hls Mode", + "enum": [ + "LIVE", + "VOD" + ] + }, + "HlsOutputSelection": { + "type": "string", + "documentation": "Hls Output Selection", + "enum": [ + "MANIFESTS_AND_SEGMENTS", + "SEGMENTS_ONLY" + ] + }, + "HlsOutputSettings": { + "type": "structure", + "members": { + "HlsSettings": { + "shape": "HlsSettings", + "locationName": "hlsSettings", + "documentation": "Settings regarding the underlying stream. These settings are different for audio-only outputs." + }, + "NameModifier": { + "shape": "__stringMin1", + "locationName": "nameModifier", + "documentation": "String concatenated to the end of the destination filename. Accepts \\\"Format Identifiers\\\":#formatIdentifierParameters." + }, + "SegmentModifier": { + "shape": "__string", + "locationName": "segmentModifier", + "documentation": "String concatenated to end of segment filenames." + } + }, + "documentation": "Hls Output Settings", + "required": [ + "HlsSettings" + ] + }, + "HlsProgramDateTime": { + "type": "string", + "documentation": "Hls Program Date Time", + "enum": [ + "EXCLUDE", + "INCLUDE" + ] + }, + "HlsRedundantManifest": { + "type": "string", + "documentation": "Hls Redundant Manifest", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "HlsSegmentationMode": { + "type": "string", + "documentation": "Hls Segmentation Mode", + "enum": [ + "USE_INPUT_SEGMENTATION", + "USE_SEGMENT_DURATION" + ] + }, + "HlsSettings": { + "type": "structure", + "members": { + "AudioOnlyHlsSettings": { + "shape": "AudioOnlyHlsSettings", + "locationName": "audioOnlyHlsSettings" + }, + "StandardHlsSettings": { + "shape": "StandardHlsSettings", + "locationName": "standardHlsSettings" + } + }, + "documentation": "Hls Settings" + }, + "HlsStreamInfResolution": { + "type": "string", + "documentation": "Hls Stream Inf Resolution", + "enum": [ + "EXCLUDE", + "INCLUDE" + ] + }, + "HlsTimedMetadataId3Frame": { + "type": "string", + "documentation": "Hls Timed Metadata Id3 Frame", + "enum": [ + "NONE", + "PRIV", + "TDRL" + ] + }, + "HlsTimedMetadataScheduleActionSettings": { + "type": "structure", + "members": { + "Id3": { + "shape": "__string", + "locationName": "id3", + "documentation": "Base64 string formatted according to the ID3 specification: http://id3.org/id3v2.4.0-structure" + } + }, + "documentation": "Settings for the action to emit HLS metadata", + "required": [ + "Id3" + ] + }, + "HlsTsFileMode": { + "type": "string", + "documentation": "Hls Ts File Mode", + "enum": [ + "SEGMENTED_FILES", + "SINGLE_FILE" + ] + }, + "HlsWebdavHttpTransferMode": { + "type": "string", + "documentation": "Hls Webdav Http Transfer Mode", + "enum": [ + "CHUNKED", + "NON_CHUNKED" + ] + }, + "HlsWebdavSettings": { + "type": "structure", + "members": { + "ConnectionRetryInterval": { + "shape": "__integerMin0", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying connection to the CDN if the connection is lost." + }, + "FilecacheDuration": { + "shape": "__integerMin0Max600", + "locationName": "filecacheDuration", + "documentation": "Size in seconds of file cache for streaming outputs." + }, + "HttpTransferMode": { + "shape": "HlsWebdavHttpTransferMode", + "locationName": "httpTransferMode", + "documentation": "Specify whether or not to use chunked transfer encoding to WebDAV." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts that will be made before the Live Event is put into an error state." + }, + "RestartDelay": { + "shape": "__integerMin0Max15", + "locationName": "restartDelay", + "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart." + } + }, + "documentation": "Hls Webdav Settings" + }, + "IFrameOnlyPlaylistType": { + "type": "string", + "documentation": "When set to \"standard\", an I-Frame only playlist will be written out for each video output in the output group. This I-Frame only playlist will contain byte range offsets pointing to the I-frame(s) in each segment.", + "enum": [ + "DISABLED", + "STANDARD" + ] + }, + "ImmediateModeScheduleActionStartSettings": { + "type": "structure", + "members": { + }, + "documentation": "Settings to configure an action so that it occurs immediately. This is only supported for input switch actions currently." + }, + "Input": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The Unique ARN of the input (generated, immutable)." + }, + "AttachedChannels": { + "shape": "__listOf__string", + "locationName": "attachedChannels", + "documentation": "A list of channel IDs that that input is attached to (currently an input can only be attached to one channel)." + }, + "Destinations": { + "shape": "__listOfInputDestination", + "locationName": "destinations", + "documentation": "A list of the destinations of the input (PUSH-type)." + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The generated ID of the input (unique for user account, immutable)." + }, + "InputClass": { + "shape": "InputClass", + "locationName": "inputClass", + "documentation": "STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails.\nSINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input.\n" + }, + "InputSourceType": { + "shape": "InputSourceType", + "locationName": "inputSourceType", + "documentation": "Certain pull input sources can be dynamic, meaning that they can have their URL's dynamically changes\nduring input switch actions. Presently, this functionality only works with MP4_FILE inputs.\n" + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlow", + "locationName": "mediaConnectFlows", + "documentation": "A list of MediaConnect Flows for this input." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The user-assigned name (This is a mutable value)." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "SecurityGroups": { + "shape": "__listOf__string", + "locationName": "securityGroups", + "documentation": "A list of IDs for all the Input Security Groups attached to the input." + }, + "Sources": { + "shape": "__listOfInputSource", + "locationName": "sources", + "documentation": "A list of the sources of the input (PULL-type)." + }, + "State": { + "shape": "InputState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "Type": { + "shape": "InputType", + "locationName": "type" + } + }, + "documentation": "Placeholder documentation for Input" + }, + "InputAttachment": { + "type": "structure", + "members": { + "InputAttachmentName": { + "shape": "__string", + "locationName": "inputAttachmentName", + "documentation": "User-specified name for the attachment. This is required if the user wants to use this input in an input switch action." + }, + "InputId": { + "shape": "__string", + "locationName": "inputId", + "documentation": "The ID of the input" + }, + "InputSettings": { + "shape": "InputSettings", + "locationName": "inputSettings", + "documentation": "Settings of an input (caption selector, etc.)" + } + }, + "documentation": "Placeholder documentation for InputAttachment" + }, + "InputChannelLevel": { + "type": "structure", + "members": { + "Gain": { + "shape": "__integerMinNegative60Max6", + "locationName": "gain", + "documentation": "Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB." + }, + "InputChannel": { + "shape": "__integerMin0Max15", + "locationName": "inputChannel", + "documentation": "The index of the input channel used as a source." + } + }, + "documentation": "Input Channel Level", + "required": [ + "InputChannel", + "Gain" + ] + }, + "InputClass": { + "type": "string", + "documentation": "A standard input has two sources and a single pipeline input only has one.", + "enum": [ + "STANDARD", + "SINGLE_PIPELINE" + ] + }, + "InputClippingSettings": { + "type": "structure", + "members": { + "InputTimecodeSource": { + "shape": "InputTimecodeSource", + "locationName": "inputTimecodeSource", + "documentation": "The source of the timecodes in the source being clipped." + }, + "StartTimecode": { + "shape": "StartTimecode", + "locationName": "startTimecode", + "documentation": "Settings to identify the start of the clip." + }, + "StopTimecode": { + "shape": "StopTimecode", + "locationName": "stopTimecode", + "documentation": "Settings to identify the end of the clip." + } + }, + "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file.", + "required": [ + "InputTimecodeSource" + ] + }, + "InputCodec": { + "type": "string", + "documentation": "codec in increasing order of complexity", + "enum": [ + "MPEG2", + "AVC", + "HEVC" + ] + }, + "InputDeblockFilter": { + "type": "string", + "documentation": "Input Deblock Filter", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "InputDenoiseFilter": { + "type": "string", + "documentation": "Input Denoise Filter", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "InputDestination": { + "type": "structure", + "members": { + "Ip": { + "shape": "__string", + "locationName": "ip", + "documentation": "The system-generated static IP address of endpoint.\nIt remains fixed for the lifetime of the input.\n" + }, + "Port": { + "shape": "__string", + "locationName": "port", + "documentation": "The port number for the input." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "This represents the endpoint that the customer stream will be\npushed to.\n" + }, + "Vpc": { + "shape": "InputDestinationVpc", + "locationName": "vpc" + } + }, + "documentation": "The settings for a PUSH type input." + }, + "InputDestinationRequest": { + "type": "structure", + "members": { + "StreamName": { + "shape": "__string", + "locationName": "streamName", + "documentation": "A unique name for the location the RTMP stream is being pushed\nto.\n" + } + }, + "documentation": "Endpoint settings for a PUSH type input." + }, + "InputDestinationVpc": { + "type": "structure", + "members": { + "AvailabilityZone": { + "shape": "__string", + "locationName": "availabilityZone", + "documentation": "The availability zone of the Input destination.\n" + }, + "NetworkInterfaceId": { + "shape": "__string", + "locationName": "networkInterfaceId", + "documentation": "The network interface ID of the Input destination in the VPC.\n" + } + }, + "documentation": "The properties for a VPC type input destination." + }, + "InputFilter": { + "type": "string", + "documentation": "Input Filter", + "enum": [ + "AUTO", + "DISABLED", + "FORCED" + ] + }, + "InputLocation": { + "type": "structure", + "members": { + "PasswordParam": { + "shape": "__string", + "locationName": "passwordParam", + "documentation": "key used to extract the password from EC2 Parameter store" + }, + "Uri": { + "shape": "__string", + "locationName": "uri", + "documentation": "Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: \"rtmp://fmsserver/live\"." + }, + "Username": { + "shape": "__string", + "locationName": "username", + "documentation": "Documentation update needed" + } + }, + "documentation": "Input Location", + "required": [ + "Uri" + ] + }, + "InputLossActionForHlsOut": { + "type": "string", + "documentation": "Input Loss Action For Hls Out", + "enum": [ + "EMIT_OUTPUT", + "PAUSE_OUTPUT" + ] + }, + "InputLossActionForMsSmoothOut": { + "type": "string", + "documentation": "Input Loss Action For Ms Smooth Out", + "enum": [ + "EMIT_OUTPUT", + "PAUSE_OUTPUT" + ] + }, + "InputLossActionForRtmpOut": { + "type": "string", + "documentation": "Input Loss Action For Rtmp Out", + "enum": [ + "EMIT_OUTPUT", + "PAUSE_OUTPUT" + ] + }, + "InputLossActionForUdpOut": { + "type": "string", + "documentation": "Input Loss Action For Udp Out", + "enum": [ + "DROP_PROGRAM", + "DROP_TS", + "EMIT_PROGRAM" + ] + }, + "InputLossBehavior": { + "type": "structure", + "members": { + "BlackFrameMsec": { + "shape": "__integerMin0Max1000000", + "locationName": "blackFrameMsec", + "documentation": "Documentation update needed" + }, + "InputLossImageColor": { + "shape": "__stringMin6Max6", + "locationName": "inputLossImageColor", + "documentation": "When input loss image type is \"color\" this field specifies the color to use. Value: 6 hex characters representing the values of RGB." + }, + "InputLossImageSlate": { + "shape": "InputLocation", + "locationName": "inputLossImageSlate", + "documentation": "When input loss image type is \"slate\" these fields specify the parameters for accessing the slate." + }, + "InputLossImageType": { + "shape": "InputLossImageType", + "locationName": "inputLossImageType", + "documentation": "Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec." + }, + "RepeatFrameMsec": { + "shape": "__integerMin0Max1000000", + "locationName": "repeatFrameMsec", + "documentation": "Documentation update needed" + } + }, + "documentation": "Input Loss Behavior" + }, + "InputLossImageType": { + "type": "string", + "documentation": "Input Loss Image Type", + "enum": [ + "COLOR", + "SLATE" + ] + }, + "InputMaximumBitrate": { + "type": "string", + "documentation": "Maximum input bitrate in megabits per second. Bitrates up to 50 Mbps are supported currently.", + "enum": [ + "MAX_10_MBPS", + "MAX_20_MBPS", + "MAX_50_MBPS" + ] + }, + "InputResolution": { + "type": "string", + "documentation": "Input resolution based on lines of vertical resolution in the input; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines\n", + "enum": [ + "SD", + "HD", + "UHD" + ] + }, + "InputSecurityGroup": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique ARN of Input Security Group" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The Id of the Input Security Group" + }, + "Inputs": { + "shape": "__listOf__string", + "locationName": "inputs", + "documentation": "The list of inputs currently using this Input Security Group." + }, + "State": { + "shape": "InputSecurityGroupState", + "locationName": "state", + "documentation": "The current state of the Input Security Group." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "WhitelistRules": { + "shape": "__listOfInputWhitelistRule", + "locationName": "whitelistRules", + "documentation": "Whitelist rules and their sync status" + } + }, + "documentation": "An Input Security Group" + }, + "InputSecurityGroupState": { + "type": "string", + "enum": [ + "IDLE", + "IN_USE", + "UPDATING", + "DELETED" + ], + "documentation": "Placeholder documentation for InputSecurityGroupState" + }, + "InputSecurityGroupWhitelistRequest": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "WhitelistRules": { + "shape": "__listOfInputWhitelistRuleCidr", + "locationName": "whitelistRules", + "documentation": "List of IPv4 CIDR addresses to whitelist" + } + }, + "documentation": "Request of IPv4 CIDR addresses to whitelist in a security group." + }, + "InputSettings": { + "type": "structure", + "members": { + "AudioSelectors": { + "shape": "__listOfAudioSelector", + "locationName": "audioSelectors", + "documentation": "Used to select the audio stream to decode for inputs that have multiple available." + }, + "CaptionSelectors": { + "shape": "__listOfCaptionSelector", + "locationName": "captionSelectors", + "documentation": "Used to select the caption input to use for inputs that have multiple available." + }, + "DeblockFilter": { + "shape": "InputDeblockFilter", + "locationName": "deblockFilter", + "documentation": "Enable or disable the deblock filter when filtering." + }, + "DenoiseFilter": { + "shape": "InputDenoiseFilter", + "locationName": "denoiseFilter", + "documentation": "Enable or disable the denoise filter when filtering." + }, + "FilterStrength": { + "shape": "__integerMin1Max5", + "locationName": "filterStrength", + "documentation": "Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest)." + }, + "InputFilter": { + "shape": "InputFilter", + "locationName": "inputFilter", + "documentation": "Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default.\n1) auto - filtering will be applied depending on input type/quality\n2) disabled - no filtering will be applied to the input\n3) forced - filtering will be applied regardless of input type" + }, + "NetworkInputSettings": { + "shape": "NetworkInputSettings", + "locationName": "networkInputSettings", + "documentation": "Input settings." + }, + "SourceEndBehavior": { + "shape": "InputSourceEndBehavior", + "locationName": "sourceEndBehavior", + "documentation": "Loop input if it is a file. This allows a file input to be streamed indefinitely." + }, + "VideoSelector": { + "shape": "VideoSelector", + "locationName": "videoSelector", + "documentation": "Informs which video elementary stream to decode for input types that have multiple available." + } + }, + "documentation": "Live Event input parameters. There can be multiple inputs in a single Live Event." + }, + "InputSource": { + "type": "structure", + "members": { + "PasswordParam": { + "shape": "__string", + "locationName": "passwordParam", + "documentation": "The key used to extract the password from EC2 Parameter store." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "This represents the customer's source URL where stream is\npulled from.\n" + }, + "Username": { + "shape": "__string", + "locationName": "username", + "documentation": "The username for the input source." + } + }, + "documentation": "The settings for a PULL type input." + }, + "InputSourceEndBehavior": { + "type": "string", + "documentation": "Input Source End Behavior", + "enum": [ + "CONTINUE", + "LOOP" + ] + }, + "InputSourceRequest": { + "type": "structure", + "members": { + "PasswordParam": { + "shape": "__string", + "locationName": "passwordParam", + "documentation": "The key used to extract the password from EC2 Parameter store." + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "This represents the customer's source URL where stream is\npulled from.\n" + }, + "Username": { + "shape": "__string", + "locationName": "username", + "documentation": "The username for the input source." + } + }, + "documentation": "Settings for for a PULL type input." + }, + "InputSourceType": { + "type": "string", + "documentation": "There are two types of input sources, static and dynamic. If an input source is dynamic you can\nchange the source url of the input dynamically using an input switch action. However, the only input type\nto support a dynamic url at this time is MP4_FILE. By default all input sources are static.\n", + "enum": [ + "STATIC", + "DYNAMIC" + ] + }, + "InputSpecification": { + "type": "structure", + "members": { + "Codec": { + "shape": "InputCodec", + "locationName": "codec", + "documentation": "Input codec" + }, + "MaximumBitrate": { + "shape": "InputMaximumBitrate", + "locationName": "maximumBitrate", + "documentation": "Maximum input bitrate, categorized coarsely" + }, + "Resolution": { + "shape": "InputResolution", + "locationName": "resolution", + "documentation": "Input resolution, categorized coarsely" + } + }, + "documentation": "Placeholder documentation for InputSpecification" + }, + "InputState": { + "type": "string", + "enum": [ + "CREATING", + "DETACHED", + "ATTACHED", + "DELETING", + "DELETED" + ], + "documentation": "Placeholder documentation for InputState" + }, + "InputSwitchScheduleActionSettings": { + "type": "structure", + "members": { + "InputAttachmentNameReference": { + "shape": "__string", + "locationName": "inputAttachmentNameReference", + "documentation": "The name of the input attachment (not the name of the input!) to switch to. The name is specified in the channel configuration." + }, + "InputClippingSettings": { + "shape": "InputClippingSettings", + "locationName": "inputClippingSettings", + "documentation": "Settings to let you create a clip of the file input, in order to set up the input to ingest only a portion of the file." + }, + "UrlPath": { + "shape": "__listOf__string", + "locationName": "urlPath", + "documentation": "The value for the variable portion of the URL for the dynamic input, for this instance of the input. Each time you use the same dynamic input in an input switch action, you can provide a different value, in order to connect the input to a different content source." + } + }, + "documentation": "Settings for the \"switch input\" action: to switch from ingesting one input to ingesting another input.", + "required": [ + "InputAttachmentNameReference" + ] + }, + "InputTimecodeSource": { + "type": "string", + "documentation": "Documentation update needed", + "enum": [ + "ZEROBASED", + "EMBEDDED" + ] + }, + "InputType": { + "type": "string", + "enum": [ + "UDP_PUSH", + "RTP_PUSH", + "RTMP_PUSH", + "RTMP_PULL", + "URL_PULL", + "MP4_FILE", + "MEDIACONNECT" + ], + "documentation": "Placeholder documentation for InputType" + }, + "InputVpcRequest": { + "type": "structure", + "members": { + "SecurityGroupIds": { + "shape": "__listOf__string", + "locationName": "securityGroupIds", + "documentation": "A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces.\nRequires subnetIds. If none are specified then the VPC default security group will be used.\n" + }, + "SubnetIds": { + "shape": "__listOf__string", + "locationName": "subnetIds", + "documentation": "A list of 2 VPC subnet IDs from the same VPC.\nSubnet IDs must be mapped to two unique availability zones (AZ).\n" + } + }, + "documentation": "Settings for a private VPC Input.\nWhen this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses.\nThis property requires setting the roleArn property on Input creation.\nNot compatible with the inputSecurityGroups property.\n", + "required": [ + "SubnetIds" + ] + }, + "InputWhitelistRule": { + "type": "structure", + "members": { + "Cidr": { + "shape": "__string", + "locationName": "cidr", + "documentation": "The IPv4 CIDR that's whitelisted." + } + }, + "documentation": "Whitelist rule" + }, + "InputWhitelistRuleCidr": { + "type": "structure", + "members": { + "Cidr": { + "shape": "__string", + "locationName": "cidr", + "documentation": "The IPv4 CIDR to whitelist." + } + }, + "documentation": "An IPv4 CIDR to whitelist." + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 500 + }, + "documentation": "Placeholder documentation for InternalServerErrorException" + }, + "InternalServiceError": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for InternalServiceError" + }, + "InvalidRequest": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for InvalidRequest" + }, + "KeyProviderSettings": { + "type": "structure", + "members": { + "StaticKeySettings": { + "shape": "StaticKeySettings", + "locationName": "staticKeySettings" + } + }, + "documentation": "Key Provider Settings" + }, + "LastFrameClippingBehavior": { + "type": "string", + "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode.", + "enum": [ + "EXCLUDE_LAST_FRAME", + "INCLUDE_LAST_FRAME" + ] + }, + "LimitExceeded": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for LimitExceeded" + }, + "ListChannelsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListChannelsRequest" + }, + "ListChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "shape": "__listOfChannelSummary", + "locationName": "channels" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListChannelsResponse" + }, + "ListChannelsResultModel": { + "type": "structure", + "members": { + "Channels": { + "shape": "__listOfChannelSummary", + "locationName": "channels" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListChannelsResultModel" + }, + "ListInputSecurityGroupsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListInputSecurityGroupsRequest" + }, + "ListInputSecurityGroupsResponse": { + "type": "structure", + "members": { + "InputSecurityGroups": { + "shape": "__listOfInputSecurityGroup", + "locationName": "inputSecurityGroups", + "documentation": "List of input security groups" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListInputSecurityGroupsResponse" + }, + "ListInputSecurityGroupsResultModel": { + "type": "structure", + "members": { + "InputSecurityGroups": { + "shape": "__listOfInputSecurityGroup", + "locationName": "inputSecurityGroups", + "documentation": "List of input security groups" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Result of input security group list request" + }, + "ListInputsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListInputsRequest" + }, + "ListInputsResponse": { + "type": "structure", + "members": { + "Inputs": { + "shape": "__listOfInput", + "locationName": "inputs" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListInputsResponse" + }, + "ListInputsResultModel": { + "type": "structure", + "members": { + "Inputs": { + "shape": "__listOfInput", + "locationName": "inputs" + }, + "NextToken": { + "shape": "__string", + "locationName": "nextToken" + } + }, + "documentation": "Placeholder documentation for ListInputsResultModel" + }, + "ListOfferingsRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "__string", + "location": "querystring", + "locationName": "channelClass", + "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'\n" + }, + "ChannelConfiguration": { + "shape": "__string", + "location": "querystring", + "locationName": "channelConfiguration", + "documentation": "Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)\n" + }, + "Codec": { + "shape": "__string", + "location": "querystring", + "locationName": "codec", + "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'" + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "MaximumBitrate": { + "shape": "__string", + "location": "querystring", + "locationName": "maximumBitrate", + "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'\n" + }, + "MaximumFramerate": { + "shape": "__string", + "location": "querystring", + "locationName": "maximumFramerate", + "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + }, + "Resolution": { + "shape": "__string", + "location": "querystring", + "locationName": "resolution", + "documentation": "Filter by resolution, 'SD', 'HD', or 'UHD'" + }, + "ResourceType": { + "shape": "__string", + "location": "querystring", + "locationName": "resourceType", + "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'" + }, + "SpecialFeature": { + "shape": "__string", + "location": "querystring", + "locationName": "specialFeature", + "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'\n" + }, + "VideoQuality": { + "shape": "__string", + "location": "querystring", + "locationName": "videoQuality", + "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'\n" + } + }, + "documentation": "Placeholder documentation for ListOfferingsRequest" + }, + "ListOfferingsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Token to retrieve the next page of results" + }, + "Offerings": { + "shape": "__listOfOffering", + "locationName": "offerings", + "documentation": "List of offerings" + } + }, + "documentation": "Placeholder documentation for ListOfferingsResponse" + }, + "ListOfferingsResultModel": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Token to retrieve the next page of results" + }, + "Offerings": { + "shape": "__listOfOffering", + "locationName": "offerings", + "documentation": "List of offerings" + } + }, + "documentation": "ListOfferings response" + }, + "ListReservationsRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "__string", + "location": "querystring", + "locationName": "channelClass", + "documentation": "Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'\n" + }, + "Codec": { + "shape": "__string", + "location": "querystring", + "locationName": "codec", + "documentation": "Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'" + }, + "MaxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "MaximumBitrate": { + "shape": "__string", + "location": "querystring", + "locationName": "maximumBitrate", + "documentation": "Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'\n" + }, + "MaximumFramerate": { + "shape": "__string", + "location": "querystring", + "locationName": "maximumFramerate", + "documentation": "Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'" + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "nextToken" + }, + "Resolution": { + "shape": "__string", + "location": "querystring", + "locationName": "resolution", + "documentation": "Filter by resolution, 'SD', 'HD', or 'UHD'" + }, + "ResourceType": { + "shape": "__string", + "location": "querystring", + "locationName": "resourceType", + "documentation": "Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'" + }, + "SpecialFeature": { + "shape": "__string", + "location": "querystring", + "locationName": "specialFeature", + "documentation": "Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'\n" + }, + "VideoQuality": { + "shape": "__string", + "location": "querystring", + "locationName": "videoQuality", + "documentation": "Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'\n" + } + }, + "documentation": "Placeholder documentation for ListReservationsRequest" + }, + "ListReservationsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Token to retrieve the next page of results" + }, + "Reservations": { + "shape": "__listOfReservation", + "locationName": "reservations", + "documentation": "List of reservations" + } + }, + "documentation": "Placeholder documentation for ListReservationsResponse" + }, + "ListReservationsResultModel": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "Token to retrieve the next page of results" + }, + "Reservations": { + "shape": "__listOfReservation", + "locationName": "reservations", + "documentation": "List of reservations" + } + }, + "documentation": "ListReservations response" + }, + "ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn" + } + }, + "required": [ + "ResourceArn" + ], + "documentation": "Placeholder documentation for ListTagsForResourceRequest" + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", + "locationName": "tags" + } + }, + "documentation": "Placeholder documentation for ListTagsForResourceResponse" + }, + "LogLevel": { + "type": "string", + "documentation": "The log level the user wants for their channel.", + "enum": [ + "ERROR", + "WARNING", + "INFO", + "DEBUG", + "DISABLED" + ] + }, + "M2tsAbsentInputAudioBehavior": { + "type": "string", + "documentation": "M2ts Absent Input Audio Behavior", + "enum": [ + "DROP", + "ENCODE_SILENCE" + ] + }, + "M2tsArib": { + "type": "string", + "documentation": "M2ts Arib", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "M2tsAribCaptionsPidControl": { + "type": "string", + "documentation": "M2ts Arib Captions Pid Control", + "enum": [ + "AUTO", + "USE_CONFIGURED" + ] + }, + "M2tsAudioBufferModel": { + "type": "string", + "documentation": "M2ts Audio Buffer Model", + "enum": [ + "ATSC", + "DVB" + ] + }, + "M2tsAudioInterval": { + "type": "string", + "documentation": "M2ts Audio Interval", + "enum": [ + "VIDEO_AND_FIXED_INTERVALS", + "VIDEO_INTERVAL" + ] + }, + "M2tsAudioStreamType": { + "type": "string", + "documentation": "M2ts Audio Stream Type", + "enum": [ + "ATSC", + "DVB" + ] + }, + "M2tsBufferModel": { + "type": "string", + "documentation": "M2ts Buffer Model", + "enum": [ + "MULTIPLEX", + "NONE" + ] + }, + "M2tsCcDescriptor": { + "type": "string", + "documentation": "M2ts Cc Descriptor", + "enum": [ + "DISABLED", + "ENABLED" + ] + }, + "M2tsEbifControl": { + "type": "string", + "documentation": "M2ts Ebif Control", + "enum": [ + "NONE", + "PASSTHROUGH" + ] + }, + "M2tsEbpPlacement": { + "type": "string", + "documentation": "M2ts Ebp Placement", + "enum": [ + "VIDEO_AND_AUDIO_PIDS", + "VIDEO_PID" + ] + }, + "M2tsEsRateInPes": { + "type": "string", + "documentation": "M2ts Es Rate In Pes", + "enum": [ + "EXCLUDE", + "INCLUDE" + ] + }, + "M2tsKlv": { + "type": "string", + "documentation": "M2ts Klv", + "enum": [ + "NONE", + "PASSTHROUGH" + ] + }, + "M2tsPcrControl": { + "type": "string", + "documentation": "M2ts Pcr Control", + "enum": [ + "CONFIGURED_PCR_PERIOD", + "PCR_EVERY_PES_PACKET" + ] + }, + "M2tsRateMode": { + "type": "string", + "documentation": "M2ts Rate Mode", + "enum": [ + "CBR", + "VBR" + ] + }, + "M2tsScte35Control": { + "type": "string", + "documentation": "M2ts Scte35 Control", + "enum": [ + "NONE", + "PASSTHROUGH" + ] + }, + "M2tsSegmentationMarkers": { + "type": "string", + "documentation": "M2ts Segmentation Markers", + "enum": [ + "EBP", + "EBP_LEGACY", + "NONE", + "PSI_SEGSTART", + "RAI_ADAPT", + "RAI_SEGSTART" + ] + }, + "M2tsSegmentationStyle": { + "type": "string", + "documentation": "M2ts Segmentation Style", + "enum": [ + "MAINTAIN_CADENCE", + "RESET_CADENCE" + ] + }, + "M2tsSettings": { + "type": "structure", + "members": { + "AbsentInputAudioBehavior": { + "shape": "M2tsAbsentInputAudioBehavior", + "locationName": "absentInputAudioBehavior", + "documentation": "When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream." + }, + "Arib": { + "shape": "M2tsArib", + "locationName": "arib", + "documentation": "When set to enabled, uses ARIB-compliant field muxing and removes video descriptor." + }, + "AribCaptionsPid": { + "shape": "__string", + "locationName": "aribCaptionsPid", + "documentation": "Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "AribCaptionsPidControl": { + "shape": "M2tsAribCaptionsPidControl", + "locationName": "aribCaptionsPidControl", + "documentation": "If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number." + }, + "AudioBufferModel": { + "shape": "M2tsAudioBufferModel", + "locationName": "audioBufferModel", + "documentation": "When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used." + }, + "AudioFramesPerPes": { + "shape": "__integerMin0", + "locationName": "audioFramesPerPes", + "documentation": "The number of audio frames to insert for each PES packet." + }, + "AudioPids": { + "shape": "__string", + "locationName": "audioPids", + "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "AudioStreamType": { + "shape": "M2tsAudioStreamType", + "locationName": "audioStreamType", + "documentation": "When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06." + }, + "Bitrate": { + "shape": "__integerMin0", + "locationName": "bitrate", + "documentation": "The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate." + }, + "BufferModel": { + "shape": "M2tsBufferModel", + "locationName": "bufferModel", + "documentation": "If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions." + }, + "CcDescriptor": { + "shape": "M2tsCcDescriptor", + "locationName": "ccDescriptor", + "documentation": "When set to enabled, generates captionServiceDescriptor in PMT." + }, + "DvbNitSettings": { + "shape": "DvbNitSettings", + "locationName": "dvbNitSettings", + "documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval." + }, + "DvbSdtSettings": { + "shape": "DvbSdtSettings", + "locationName": "dvbSdtSettings", + "documentation": "Inserts DVB Service Description Table (SDT) at the specified table repetition interval." + }, + "DvbSubPids": { + "shape": "__string", + "locationName": "dvbSubPids", + "documentation": "Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "DvbTdtSettings": { + "shape": "DvbTdtSettings", + "locationName": "dvbTdtSettings", + "documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval." + }, + "DvbTeletextPid": { + "shape": "__string", + "locationName": "dvbTeletextPid", + "documentation": "Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "Ebif": { + "shape": "M2tsEbifControl", + "locationName": "ebif", + "documentation": "If set to passthrough, passes any EBIF data from the input source to this output." + }, + "EbpAudioInterval": { + "shape": "M2tsAudioInterval", + "locationName": "ebpAudioInterval", + "documentation": "When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval." + }, + "EbpLookaheadMs": { + "shape": "__integerMin0Max10000", + "locationName": "ebpLookaheadMs", + "documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate." + }, + "EbpPlacement": { + "shape": "M2tsEbpPlacement", + "locationName": "ebpPlacement", + "documentation": "Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID." + }, + "EcmPid": { + "shape": "__string", + "locationName": "ecmPid", + "documentation": "This field is unused and deprecated." + }, + "EsRateInPes": { + "shape": "M2tsEsRateInPes", + "locationName": "esRateInPes", + "documentation": "Include or exclude the ES Rate field in the PES header." + }, + "EtvPlatformPid": { + "shape": "__string", + "locationName": "etvPlatformPid", + "documentation": "Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "EtvSignalPid": { + "shape": "__string", + "locationName": "etvSignalPid", + "documentation": "Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "FragmentTime": { + "shape": "__doubleMin0", + "locationName": "fragmentTime", + "documentation": "The length in seconds of each fragment. Only used with EBP markers." + }, + "Klv": { + "shape": "M2tsKlv", + "locationName": "klv", + "documentation": "If set to passthrough, passes any KLV data from the input source to this output." + }, + "KlvDataPids": { + "shape": "__string", + "locationName": "klvDataPids", + "documentation": "Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "NullPacketBitrate": { + "shape": "__doubleMin0", + "locationName": "nullPacketBitrate", + "documentation": "Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets." + }, + "PatInterval": { + "shape": "__integerMin0Max1000", + "locationName": "patInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000." + }, + "PcrControl": { + "shape": "M2tsPcrControl", + "locationName": "pcrControl", + "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream." + }, + "PcrPeriod": { + "shape": "__integerMin0Max500", + "locationName": "pcrPeriod", + "documentation": "Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream." + }, + "PcrPid": { + "shape": "__string", + "locationName": "pcrPid", + "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "PmtInterval": { + "shape": "__integerMin0Max1000", + "locationName": "pmtInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000." + }, + "PmtPid": { + "shape": "__string", + "locationName": "pmtPid", + "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "ProgramNum": { + "shape": "__integerMin0Max65535", + "locationName": "programNum", + "documentation": "The value of the program number field in the Program Map Table." + }, + "RateMode": { + "shape": "M2tsRateMode", + "locationName": "rateMode", + "documentation": "When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set." + }, + "Scte27Pids": { + "shape": "__string", + "locationName": "scte27Pids", + "documentation": "Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "Scte35Control": { + "shape": "M2tsScte35Control", + "locationName": "scte35Control", + "documentation": "Optionally pass SCTE-35 signals from the input source to this output." + }, + "Scte35Pid": { + "shape": "__string", + "locationName": "scte35Pid", + "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "SegmentationMarkers": { + "shape": "M2tsSegmentationMarkers", + "locationName": "segmentationMarkers", + "documentation": "Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format." + }, + "SegmentationStyle": { + "shape": "M2tsSegmentationStyle", + "locationName": "segmentationStyle", + "documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted.\n\nWhen a segmentation style of \"resetCadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds.\n\nWhen a segmentation style of \"maintainCadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule." + }, + "SegmentationTime": { + "shape": "__doubleMin1", + "locationName": "segmentationTime", + "documentation": "The length in seconds of each segment. Required unless markers is set to None_." + }, + "TimedMetadataBehavior": { + "shape": "M2tsTimedMetadataBehavior", + "locationName": "timedMetadataBehavior", + "documentation": "When set to passthrough, timed metadata will be passed through from input to output." + }, + "TimedMetadataPid": { + "shape": "__string", + "locationName": "timedMetadataPid", + "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "TransportStreamId": { + "shape": "__integerMin0Max65535", + "locationName": "transportStreamId", + "documentation": "The value of the transport stream ID field in the Program Map Table." + }, + "VideoPid": { + "shape": "__string", + "locationName": "videoPid", + "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + } + }, + "documentation": "M2ts Settings" + }, + "M2tsTimedMetadataBehavior": { + "type": "string", + "documentation": "M2ts Timed Metadata Behavior", + "enum": [ + "NO_PASSTHROUGH", + "PASSTHROUGH" + ] + }, + "M3u8PcrControl": { + "type": "string", + "documentation": "M3u8 Pcr Control", + "enum": [ + "CONFIGURED_PCR_PERIOD", + "PCR_EVERY_PES_PACKET" + ] + }, + "M3u8Scte35Behavior": { + "type": "string", + "documentation": "M3u8 Scte35 Behavior", + "enum": [ + "NO_PASSTHROUGH", + "PASSTHROUGH" + ] + }, + "M3u8Settings": { + "type": "structure", + "members": { + "AudioFramesPerPes": { + "shape": "__integerMin0", + "locationName": "audioFramesPerPes", + "documentation": "The number of audio frames to insert for each PES packet." + }, + "AudioPids": { + "shape": "__string", + "locationName": "audioPids", + "documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values." + }, + "EcmPid": { + "shape": "__string", + "locationName": "ecmPid", + "documentation": "This parameter is unused and deprecated." + }, + "PatInterval": { + "shape": "__integerMin0Max1000", + "locationName": "patInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file." + }, + "PcrControl": { + "shape": "M3u8PcrControl", + "locationName": "pcrControl", + "documentation": "When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream." + }, + "PcrPeriod": { + "shape": "__integerMin0Max500", + "locationName": "pcrPeriod", + "documentation": "Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream." + }, + "PcrPid": { + "shape": "__string", + "locationName": "pcrPid", + "documentation": "Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value." + }, + "PmtInterval": { + "shape": "__integerMin0Max1000", + "locationName": "pmtInterval", + "documentation": "The number of milliseconds between instances of this table in the output transport stream. A value of \\\"0\\\" writes out the PMT once per segment file." + }, + "PmtPid": { + "shape": "__string", + "locationName": "pmtPid", + "documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value." + }, + "ProgramNum": { + "shape": "__integerMin0Max65535", + "locationName": "programNum", + "documentation": "The value of the program number field in the Program Map Table." + }, + "Scte35Behavior": { + "shape": "M3u8Scte35Behavior", + "locationName": "scte35Behavior", + "documentation": "If set to passthrough, passes any SCTE-35 signals from the input source to this output." + }, + "Scte35Pid": { + "shape": "__string", + "locationName": "scte35Pid", + "documentation": "Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value." + }, + "TimedMetadataBehavior": { + "shape": "M3u8TimedMetadataBehavior", + "locationName": "timedMetadataBehavior", + "documentation": "When set to passthrough, timed metadata is passed through from input to output." + }, + "TimedMetadataPid": { + "shape": "__string", + "locationName": "timedMetadataPid", + "documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6)." + }, + "TransportStreamId": { + "shape": "__integerMin0Max65535", + "locationName": "transportStreamId", + "documentation": "The value of the transport stream ID field in the Program Map Table." + }, + "VideoPid": { + "shape": "__string", + "locationName": "videoPid", + "documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value." + } + }, + "documentation": "Settings information for the .m3u8 container" + }, + "M3u8TimedMetadataBehavior": { + "type": "string", + "documentation": "M3u8 Timed Metadata Behavior", + "enum": [ + "NO_PASSTHROUGH", + "PASSTHROUGH" + ] + }, + "MaxResults": { + "type": "integer", + "min": 1, + "max": 1000, + "documentation": "Placeholder documentation for MaxResults" + }, + "MediaConnectFlow": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The unique ARN of the MediaConnect Flow being used as a source." + } + }, + "documentation": "The settings for a MediaConnect Flow." + }, + "MediaConnectFlowRequest": { + "type": "structure", + "members": { + "FlowArn": { + "shape": "__string", + "locationName": "flowArn", + "documentation": "The ARN of the MediaConnect Flow that you want to use as a source." + } + }, + "documentation": "The settings for a MediaConnect Flow." + }, + "MediaPackageGroupSettings": { + "type": "structure", + "members": { + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "MediaPackage channel destination." + } + }, + "documentation": "Media Package Group Settings", + "required": [ + "Destination" + ] + }, + "MediaPackageOutputDestinationSettings": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__stringMin1", + "locationName": "channelId", + "documentation": "ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region." + } + }, + "documentation": "MediaPackage Output Destination Settings" + }, + "MediaPackageOutputSettings": { + "type": "structure", + "members": { + }, + "documentation": "Media Package Output Settings" + }, + "Mp2CodingMode": { + "type": "string", + "documentation": "Mp2 Coding Mode", + "enum": [ + "CODING_MODE_1_0", + "CODING_MODE_2_0" + ] + }, + "Mp2Settings": { + "type": "structure", + "members": { + "Bitrate": { + "shape": "__double", + "locationName": "bitrate", + "documentation": "Average bitrate in bits/second." + }, + "CodingMode": { + "shape": "Mp2CodingMode", + "locationName": "codingMode", + "documentation": "The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo)." + }, + "SampleRate": { + "shape": "__double", + "locationName": "sampleRate", + "documentation": "Sample rate in Hz." + } + }, + "documentation": "Mp2 Settings" + }, + "MsSmoothGroupSettings": { + "type": "structure", + "members": { + "AcquisitionPointId": { + "shape": "__string", + "locationName": "acquisitionPointId", + "documentation": "The value of the \"Acquisition Point Identity\" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not \"none\"." + }, + "AudioOnlyTimecodeControl": { + "shape": "SmoothGroupAudioOnlyTimecodeControl", + "locationName": "audioOnlyTimecodeControl", + "documentation": "If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream." + }, + "CertificateMode": { + "shape": "SmoothGroupCertificateMode", + "locationName": "certificateMode", + "documentation": "If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail." + }, + "ConnectionRetryInterval": { + "shape": "__integerMin0", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established." + }, + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "Smooth Streaming publish point on an IIS server. Elemental Live acts as a \"Push\" encoder to IIS." + }, + "EventId": { + "shape": "__string", + "locationName": "eventId", + "documentation": "MS Smooth event ID to be sent to the IIS server.\n\nShould only be specified if eventIdMode is set to useConfigured." + }, + "EventIdMode": { + "shape": "SmoothGroupEventIdMode", + "locationName": "eventIdMode", + "documentation": "Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run.\n\nOptions:\n- \"useConfigured\" - use the value provided in eventId\n- \"useTimestamp\" - generate and send an event ID based on the current timestamp\n- \"noEventId\" - do not send an event ID to the IIS server." + }, + "EventStopBehavior": { + "shape": "SmoothGroupEventStopBehavior", + "locationName": "eventStopBehavior", + "documentation": "When set to sendEos, send EOS signal to IIS server when stopping the event" + }, + "FilecacheDuration": { + "shape": "__integerMin0", + "locationName": "filecacheDuration", + "documentation": "Size in seconds of file cache for streaming outputs." + }, + "FragmentLength": { + "shape": "__integerMin1", + "locationName": "fragmentLength", + "documentation": "Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate." + }, + "InputLossAction": { + "shape": "InputLossActionForMsSmoothOut", + "locationName": "inputLossAction", + "documentation": "Parameter that control output group behavior on input loss." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts." + }, + "RestartDelay": { + "shape": "__integerMin0", + "locationName": "restartDelay", + "documentation": "Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration." + }, + "SegmentationMode": { + "shape": "SmoothGroupSegmentationMode", + "locationName": "segmentationMode", + "documentation": "useInputSegmentation has been deprecated. The configured segment size is always used." + }, + "SendDelayMs": { + "shape": "__integerMin0Max10000", + "locationName": "sendDelayMs", + "documentation": "Number of milliseconds to delay the output from the second pipeline." + }, + "SparseTrackType": { + "shape": "SmoothGroupSparseTrackType", + "locationName": "sparseTrackType", + "documentation": "If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs." + }, + "StreamManifestBehavior": { + "shape": "SmoothGroupStreamManifestBehavior", + "locationName": "streamManifestBehavior", + "documentation": "When set to send, send stream manifest so publishing point doesn't start until all streams start." + }, + "TimestampOffset": { + "shape": "__string", + "locationName": "timestampOffset", + "documentation": "Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset." + }, + "TimestampOffsetMode": { + "shape": "SmoothGroupTimestampOffsetMode", + "locationName": "timestampOffsetMode", + "documentation": "Type of timestamp date offset to use.\n- useEventStartDate: Use the date the event was started as the offset\n- useConfiguredOffset: Use an explicitly configured date as the offset" + } + }, + "documentation": "Ms Smooth Group Settings", + "required": [ + "Destination" + ] + }, + "MsSmoothH265PackagingType": { + "type": "string", + "documentation": "Ms Smooth H265 Packaging Type", + "enum": [ + "HEV1", + "HVC1" + ] + }, + "MsSmoothOutputSettings": { + "type": "structure", + "members": { + "H265PackagingType": { + "shape": "MsSmoothH265PackagingType", + "locationName": "h265PackagingType", + "documentation": "Only applicable when this output is referencing an H.265 video description.\nSpecifies whether MP4 segments should be packaged as HEV1 or HVC1." + }, + "NameModifier": { + "shape": "__string", + "locationName": "nameModifier", + "documentation": "String concatenated to the end of the destination filename. Required for multiple outputs of the same type." + } + }, + "documentation": "Ms Smooth Output Settings" + }, + "NetworkInputServerValidation": { + "type": "string", + "documentation": "Network Input Server Validation", + "enum": [ + "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME", + "CHECK_CRYPTOGRAPHY_ONLY" + ] + }, + "NetworkInputSettings": { + "type": "structure", + "members": { + "HlsInputSettings": { + "shape": "HlsInputSettings", + "locationName": "hlsInputSettings", + "documentation": "Specifies HLS input settings when the uri is for a HLS manifest." + }, + "ServerValidation": { + "shape": "NetworkInputServerValidation", + "locationName": "serverValidation", + "documentation": "Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https." + } + }, + "documentation": "Network source to transcode. Must be accessible to the Elemental Live node that is running the live event through a network connection." + }, + "NotFoundException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 404 + }, + "documentation": "Placeholder documentation for NotFoundException" + }, + "Offering": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'" + }, + "CurrencyCode": { + "shape": "__string", + "locationName": "currencyCode", + "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'" + }, + "Duration": { + "shape": "__integer", + "locationName": "duration", + "documentation": "Lease duration, e.g. '12'" + }, + "DurationUnits": { + "shape": "OfferingDurationUnits", + "locationName": "durationUnits", + "documentation": "Units for duration, e.g. 'MONTHS'" + }, + "FixedPrice": { + "shape": "__double", + "locationName": "fixedPrice", + "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering" + }, + "OfferingDescription": { + "shape": "__string", + "locationName": "offeringDescription", + "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'" + }, + "OfferingId": { + "shape": "__string", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + }, + "OfferingType": { + "shape": "OfferingType", + "locationName": "offeringType", + "documentation": "Offering type, e.g. 'NO_UPFRONT'" + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "AWS region, e.g. 'us-west-2'" + }, + "ResourceSpecification": { + "shape": "ReservationResourceSpecification", + "locationName": "resourceSpecification", + "documentation": "Resource configuration details" + }, + "UsagePrice": { + "shape": "__double", + "locationName": "usagePrice", + "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'" + } + }, + "documentation": "Reserved resources available for purchase" + }, + "OfferingDurationUnits": { + "type": "string", + "documentation": "Units for duration, e.g. 'MONTHS'", + "enum": [ + "MONTHS" + ] + }, + "OfferingType": { + "type": "string", + "documentation": "Offering type, e.g. 'NO_UPFRONT'", + "enum": [ + "NO_UPFRONT" + ] + }, + "Output": { + "type": "structure", + "members": { + "AudioDescriptionNames": { + "shape": "__listOf__string", + "locationName": "audioDescriptionNames", + "documentation": "The names of the AudioDescriptions used as audio sources for this output." + }, + "CaptionDescriptionNames": { + "shape": "__listOf__string", + "locationName": "captionDescriptionNames", + "documentation": "The names of the CaptionDescriptions used as caption sources for this output." + }, + "OutputName": { + "shape": "__stringMin1Max255", + "locationName": "outputName", + "documentation": "The name used to identify an output." + }, + "OutputSettings": { + "shape": "OutputSettings", + "locationName": "outputSettings", + "documentation": "Output type-specific settings." + }, + "VideoDescriptionName": { + "shape": "__string", + "locationName": "videoDescriptionName", + "documentation": "The name of the VideoDescription used as the source for this output." + } + }, + "documentation": "Output settings. There can be multiple outputs within a group.", + "required": [ + "OutputSettings" + ] + }, + "OutputDestination": { + "type": "structure", + "members": { + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "User-specified id. This is used in an output group or an output." + }, + "MediaPackageSettings": { + "shape": "__listOfMediaPackageOutputDestinationSettings", + "locationName": "mediaPackageSettings", + "documentation": "Destination settings for a MediaPackage output; one destination for both encoders." + }, + "Settings": { + "shape": "__listOfOutputDestinationSettings", + "locationName": "settings", + "documentation": "Destination settings for a standard output; one destination for each redundant encoder." + } + }, + "documentation": "Placeholder documentation for OutputDestination" + }, + "OutputDestinationSettings": { + "type": "structure", + "members": { + "PasswordParam": { + "shape": "__string", + "locationName": "passwordParam", + "documentation": "key used to extract the password from EC2 Parameter store" + }, + "StreamName": { + "shape": "__string", + "locationName": "streamName", + "documentation": "Stream name for RTMP destinations (URLs of type rtmp://)" + }, + "Url": { + "shape": "__string", + "locationName": "url", + "documentation": "A URL specifying a destination" + }, + "Username": { + "shape": "__string", + "locationName": "username", + "documentation": "username for destination" + } + }, + "documentation": "Placeholder documentation for OutputDestinationSettings" + }, + "OutputGroup": { + "type": "structure", + "members": { + "Name": { + "shape": "__stringMax32", + "locationName": "name", + "documentation": "Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed." + }, + "OutputGroupSettings": { + "shape": "OutputGroupSettings", + "locationName": "outputGroupSettings", + "documentation": "Settings associated with the output group." + }, + "Outputs": { + "shape": "__listOfOutput", + "locationName": "outputs" + } + }, + "documentation": "Output groups for this Live Event. Output groups contain information about where streams should be distributed.", + "required": [ + "Outputs", + "OutputGroupSettings" + ] + }, + "OutputGroupSettings": { + "type": "structure", + "members": { + "ArchiveGroupSettings": { + "shape": "ArchiveGroupSettings", + "locationName": "archiveGroupSettings" + }, + "FrameCaptureGroupSettings": { + "shape": "FrameCaptureGroupSettings", + "locationName": "frameCaptureGroupSettings" + }, + "HlsGroupSettings": { + "shape": "HlsGroupSettings", + "locationName": "hlsGroupSettings" + }, + "MediaPackageGroupSettings": { + "shape": "MediaPackageGroupSettings", + "locationName": "mediaPackageGroupSettings" + }, + "MsSmoothGroupSettings": { + "shape": "MsSmoothGroupSettings", + "locationName": "msSmoothGroupSettings" + }, + "RtmpGroupSettings": { + "shape": "RtmpGroupSettings", + "locationName": "rtmpGroupSettings" + }, + "UdpGroupSettings": { + "shape": "UdpGroupSettings", + "locationName": "udpGroupSettings" + } + }, + "documentation": "Output Group Settings" + }, + "OutputLocationRef": { + "type": "structure", + "members": { + "DestinationRefId": { + "shape": "__string", + "locationName": "destinationRefId" + } + }, + "documentation": "Reference to an OutputDestination ID defined in the channel" + }, + "OutputSettings": { + "type": "structure", + "members": { + "ArchiveOutputSettings": { + "shape": "ArchiveOutputSettings", + "locationName": "archiveOutputSettings" + }, + "FrameCaptureOutputSettings": { + "shape": "FrameCaptureOutputSettings", + "locationName": "frameCaptureOutputSettings" + }, + "HlsOutputSettings": { + "shape": "HlsOutputSettings", + "locationName": "hlsOutputSettings" + }, + "MediaPackageOutputSettings": { + "shape": "MediaPackageOutputSettings", + "locationName": "mediaPackageOutputSettings" + }, + "MsSmoothOutputSettings": { + "shape": "MsSmoothOutputSettings", + "locationName": "msSmoothOutputSettings" + }, + "RtmpOutputSettings": { + "shape": "RtmpOutputSettings", + "locationName": "rtmpOutputSettings" + }, + "UdpOutputSettings": { + "shape": "UdpOutputSettings", + "locationName": "udpOutputSettings" + } + }, + "documentation": "Output Settings" + }, + "PassThroughSettings": { + "type": "structure", + "members": { + }, + "documentation": "Pass Through Settings" + }, + "PauseStateScheduleActionSettings": { + "type": "structure", + "members": { + "Pipelines": { + "shape": "__listOfPipelinePauseStateSettings", + "locationName": "pipelines" + } + }, + "documentation": "Settings for the action to set pause state of a channel." + }, + "PipelineDetail": { + "type": "structure", + "members": { + "ActiveInputAttachmentName": { + "shape": "__string", + "locationName": "activeInputAttachmentName", + "documentation": "The name of the active input attachment currently being ingested by this pipeline." + }, + "ActiveInputSwitchActionName": { + "shape": "__string", + "locationName": "activeInputSwitchActionName", + "documentation": "The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline." + }, + "PipelineId": { + "shape": "__string", + "locationName": "pipelineId", + "documentation": "Pipeline ID" + } + }, + "documentation": "Runtime details of a pipeline when a channel is running." + }, + "PipelineId": { + "type": "string", + "documentation": "Pipeline ID", + "enum": [ + "PIPELINE_0", + "PIPELINE_1" + ] + }, + "PipelinePauseStateSettings": { + "type": "structure", + "members": { + "PipelineId": { + "shape": "PipelineId", + "locationName": "pipelineId", + "documentation": "Pipeline ID to pause (\"PIPELINE_0\" or \"PIPELINE_1\")." + } + }, + "documentation": "Settings for pausing a pipeline.", + "required": [ + "PipelineId" + ] + }, + "PurchaseOffering": { + "type": "structure", + "members": { + "Count": { + "shape": "__integerMin1", + "locationName": "count", + "documentation": "Number of resources" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name for the new reservation" + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.", + "idempotencyToken": true + }, + "Start": { + "shape": "__string", + "locationName": "start", + "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs" + } + }, + "documentation": "PurchaseOffering request", + "required": [ + "Count" + ] + }, + "PurchaseOfferingRequest": { + "type": "structure", + "members": { + "Count": { + "shape": "__integerMin1", + "locationName": "count", + "documentation": "Number of resources" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name for the new reservation" + }, + "OfferingId": { + "shape": "__string", + "location": "uri", + "locationName": "offeringId", + "documentation": "Offering to purchase, e.g. '87654321'" + }, + "RequestId": { + "shape": "__string", + "locationName": "requestId", + "documentation": "Unique request ID to be specified. This is needed to prevent retries from creating multiple resources.", + "idempotencyToken": true + }, + "Start": { + "shape": "__string", + "locationName": "start", + "documentation": "Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs" + } + }, + "required": [ + "OfferingId", + "Count" + ], + "documentation": "Placeholder documentation for PurchaseOfferingRequest" + }, + "PurchaseOfferingResponse": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Reservation", + "locationName": "reservation" + } + }, + "documentation": "Placeholder documentation for PurchaseOfferingResponse" + }, + "PurchaseOfferingResultModel": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Reservation", + "locationName": "reservation" + } + }, + "documentation": "PurchaseOffering response" + }, + "Rec601Settings": { + "type": "structure", + "members": { + }, + "documentation": "Rec601 Settings" + }, + "Rec709Settings": { + "type": "structure", + "members": { + }, + "documentation": "Rec709 Settings" + }, + "RemixSettings": { + "type": "structure", + "members": { + "ChannelMappings": { + "shape": "__listOfAudioChannelMapping", + "locationName": "channelMappings", + "documentation": "Mapping of input channels to output channels, with appropriate gain adjustments." + }, + "ChannelsIn": { + "shape": "__integerMin1Max16", + "locationName": "channelsIn", + "documentation": "Number of input channels to be used." + }, + "ChannelsOut": { + "shape": "__integerMin1Max8", + "locationName": "channelsOut", + "documentation": "Number of output channels to be produced.\nValid values: 1, 2, 4, 6, 8" + } + }, + "documentation": "Remix Settings", + "required": [ + "ChannelMappings" + ] + }, + "Reservation": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'" + }, + "Count": { + "shape": "__integer", + "locationName": "count", + "documentation": "Number of reserved resources" + }, + "CurrencyCode": { + "shape": "__string", + "locationName": "currencyCode", + "documentation": "Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'" + }, + "Duration": { + "shape": "__integer", + "locationName": "duration", + "documentation": "Lease duration, e.g. '12'" + }, + "DurationUnits": { + "shape": "OfferingDurationUnits", + "locationName": "durationUnits", + "documentation": "Units for duration, e.g. 'MONTHS'" + }, + "End": { + "shape": "__string", + "locationName": "end", + "documentation": "Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'" + }, + "FixedPrice": { + "shape": "__double", + "locationName": "fixedPrice", + "documentation": "One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "User specified reservation name" + }, + "OfferingDescription": { + "shape": "__string", + "locationName": "offeringDescription", + "documentation": "Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'" + }, + "OfferingId": { + "shape": "__string", + "locationName": "offeringId", + "documentation": "Unique offering ID, e.g. '87654321'" + }, + "OfferingType": { + "shape": "OfferingType", + "locationName": "offeringType", + "documentation": "Offering type, e.g. 'NO_UPFRONT'" + }, + "Region": { + "shape": "__string", + "locationName": "region", + "documentation": "AWS region, e.g. 'us-west-2'" + }, + "ReservationId": { + "shape": "__string", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + }, + "ResourceSpecification": { + "shape": "ReservationResourceSpecification", + "locationName": "resourceSpecification", + "documentation": "Resource configuration details" + }, + "Start": { + "shape": "__string", + "locationName": "start", + "documentation": "Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'" + }, + "State": { + "shape": "ReservationState", + "locationName": "state", + "documentation": "Current state of reservation, e.g. 'ACTIVE'" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs" + }, + "UsagePrice": { + "shape": "__double", + "locationName": "usagePrice", + "documentation": "Recurring usage charge for each reserved resource, e.g. '157.0'" + } + }, + "documentation": "Reserved resources available to use" + }, + "ReservationCodec": { + "type": "string", + "documentation": "Codec, 'MPEG2', 'AVC', 'HEVC', or 'AUDIO'", + "enum": [ + "MPEG2", + "AVC", + "HEVC", + "AUDIO" + ] + }, + "ReservationMaximumBitrate": { + "type": "string", + "documentation": "Maximum bitrate in megabits per second", + "enum": [ + "MAX_10_MBPS", + "MAX_20_MBPS", + "MAX_50_MBPS" + ] + }, + "ReservationMaximumFramerate": { + "type": "string", + "documentation": "Maximum framerate in frames per second (Outputs only)", + "enum": [ + "MAX_30_FPS", + "MAX_60_FPS" + ] + }, + "ReservationResolution": { + "type": "string", + "documentation": "Resolution based on lines of vertical resolution; SD is less than 720 lines, HD is 720 to 1080 lines, UHD is greater than 1080 lines\n", + "enum": [ + "SD", + "HD", + "UHD" + ] + }, + "ReservationResourceSpecification": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "Channel class, e.g. 'STANDARD'" + }, + "Codec": { + "shape": "ReservationCodec", + "locationName": "codec", + "documentation": "Codec, e.g. 'AVC'" + }, + "MaximumBitrate": { + "shape": "ReservationMaximumBitrate", + "locationName": "maximumBitrate", + "documentation": "Maximum bitrate, e.g. 'MAX_20_MBPS'" + }, + "MaximumFramerate": { + "shape": "ReservationMaximumFramerate", + "locationName": "maximumFramerate", + "documentation": "Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only)" + }, + "Resolution": { + "shape": "ReservationResolution", + "locationName": "resolution", + "documentation": "Resolution, e.g. 'HD'" + }, + "ResourceType": { + "shape": "ReservationResourceType", + "locationName": "resourceType", + "documentation": "Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'" + }, + "SpecialFeature": { + "shape": "ReservationSpecialFeature", + "locationName": "specialFeature", + "documentation": "Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only)" + }, + "VideoQuality": { + "shape": "ReservationVideoQuality", + "locationName": "videoQuality", + "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)" + } + }, + "documentation": "Resource configuration (codec, resolution, bitrate, ...)" + }, + "ReservationResourceType": { + "type": "string", + "documentation": "Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'", + "enum": [ + "INPUT", + "OUTPUT", + "CHANNEL" + ] + }, + "ReservationSpecialFeature": { + "type": "string", + "documentation": "Special features, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'", + "enum": [ + "ADVANCED_AUDIO", + "AUDIO_NORMALIZATION" + ] + }, + "ReservationState": { + "type": "string", + "documentation": "Current reservation state", + "enum": [ + "ACTIVE", + "EXPIRED", + "CANCELED", + "DELETED" + ] + }, + "ReservationVideoQuality": { + "type": "string", + "documentation": "Video quality, e.g. 'STANDARD' (Outputs only)", + "enum": [ + "STANDARD", + "ENHANCED", + "PREMIUM" + ] + }, + "ResourceConflict": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for ResourceConflict" + }, + "ResourceNotFound": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "documentation": "Placeholder documentation for ResourceNotFound" + }, + "RtmpCacheFullBehavior": { + "type": "string", + "documentation": "Rtmp Cache Full Behavior", + "enum": [ + "DISCONNECT_IMMEDIATELY", + "WAIT_FOR_SERVER" + ] + }, + "RtmpCaptionData": { + "type": "string", + "documentation": "Rtmp Caption Data", + "enum": [ + "ALL", + "FIELD1_608", + "FIELD1_AND_FIELD2_608" + ] + }, + "RtmpCaptionInfoDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Rtmp Caption Info Destination Settings" + }, + "RtmpGroupSettings": { + "type": "structure", + "members": { + "AuthenticationScheme": { + "shape": "AuthenticationScheme", + "locationName": "authenticationScheme", + "documentation": "Authentication scheme to use when connecting with CDN" + }, + "CacheFullBehavior": { + "shape": "RtmpCacheFullBehavior", + "locationName": "cacheFullBehavior", + "documentation": "Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again." + }, + "CacheLength": { + "shape": "__integerMin30", + "locationName": "cacheLength", + "documentation": "Cache length, in seconds, is used to calculate buffer size." + }, + "CaptionData": { + "shape": "RtmpCaptionData", + "locationName": "captionData", + "documentation": "Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed." + }, + "InputLossAction": { + "shape": "InputLossActionForRtmpOut", + "locationName": "inputLossAction", + "documentation": "Controls the behavior of this RTMP group if input becomes unavailable.\n\n- emitOutput: Emit a slate until input returns.\n- pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection." + }, + "RestartDelay": { + "shape": "__integerMin0", + "locationName": "restartDelay", + "documentation": "If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart." + } + }, + "documentation": "Rtmp Group Settings" + }, + "RtmpOutputCertificateMode": { + "type": "string", + "documentation": "Rtmp Output Certificate Mode", + "enum": [ + "SELF_SIGNED", + "VERIFY_AUTHENTICITY" + ] + }, + "RtmpOutputSettings": { + "type": "structure", + "members": { + "CertificateMode": { + "shape": "RtmpOutputCertificateMode", + "locationName": "certificateMode", + "documentation": "If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail." + }, + "ConnectionRetryInterval": { + "shape": "__integerMin1", + "locationName": "connectionRetryInterval", + "documentation": "Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost." + }, + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers." + }, + "NumRetries": { + "shape": "__integerMin0", + "locationName": "numRetries", + "documentation": "Number of retry attempts." + } + }, + "documentation": "Rtmp Output Settings", + "required": [ + "Destination" + ] + }, + "ScheduleAction": { + "type": "structure", + "members": { + "ActionName": { + "shape": "__string", + "locationName": "actionName", + "documentation": "The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused." + }, + "ScheduleActionSettings": { + "shape": "ScheduleActionSettings", + "locationName": "scheduleActionSettings", + "documentation": "Settings for this schedule action." + }, + "ScheduleActionStartSettings": { + "shape": "ScheduleActionStartSettings", + "locationName": "scheduleActionStartSettings", + "documentation": "The time for the action to start in the channel." + } + }, + "documentation": "Contains information on a single schedule action.", + "required": [ + "ActionName", + "ScheduleActionStartSettings", + "ScheduleActionSettings" + ] + }, + "ScheduleActionSettings": { + "type": "structure", + "members": { + "HlsTimedMetadataSettings": { + "shape": "HlsTimedMetadataScheduleActionSettings", + "locationName": "hlsTimedMetadataSettings", + "documentation": "Action to insert HLS metadata" + }, + "InputSwitchSettings": { + "shape": "InputSwitchScheduleActionSettings", + "locationName": "inputSwitchSettings", + "documentation": "Action to switch the input" + }, + "PauseStateSettings": { + "shape": "PauseStateScheduleActionSettings", + "locationName": "pauseStateSettings", + "documentation": "Action to pause or unpause one or both channel pipelines" + }, + "Scte35ReturnToNetworkSettings": { + "shape": "Scte35ReturnToNetworkScheduleActionSettings", + "locationName": "scte35ReturnToNetworkSettings", + "documentation": "Action to insert SCTE-35 return_to_network message" + }, + "Scte35SpliceInsertSettings": { + "shape": "Scte35SpliceInsertScheduleActionSettings", + "locationName": "scte35SpliceInsertSettings", + "documentation": "Action to insert SCTE-35 splice_insert message" + }, + "Scte35TimeSignalSettings": { + "shape": "Scte35TimeSignalScheduleActionSettings", + "locationName": "scte35TimeSignalSettings", + "documentation": "Action to insert SCTE-35 time_signal message" + }, + "StaticImageActivateSettings": { + "shape": "StaticImageActivateScheduleActionSettings", + "locationName": "staticImageActivateSettings", + "documentation": "Action to activate a static image overlay" + }, + "StaticImageDeactivateSettings": { + "shape": "StaticImageDeactivateScheduleActionSettings", + "locationName": "staticImageDeactivateSettings", + "documentation": "Action to deactivate a static image overlay" + } + }, + "documentation": "Holds the settings for a single schedule action." + }, + "ScheduleActionStartSettings": { + "type": "structure", + "members": { + "FixedModeScheduleActionStartSettings": { + "shape": "FixedModeScheduleActionStartSettings", + "locationName": "fixedModeScheduleActionStartSettings", + "documentation": "Option for specifying the start time for an action." + }, + "FollowModeScheduleActionStartSettings": { + "shape": "FollowModeScheduleActionStartSettings", + "locationName": "followModeScheduleActionStartSettings", + "documentation": "Option for specifying an action as relative to another action." + }, + "ImmediateModeScheduleActionStartSettings": { + "shape": "ImmediateModeScheduleActionStartSettings", + "locationName": "immediateModeScheduleActionStartSettings", + "documentation": "Option for specifying an action that should be applied immediately." + } + }, + "documentation": "Settings to specify when an action should occur. Only one of the options must be selected." + }, + "ScheduleDeleteResultModel": { + "type": "structure", + "members": { + }, + "documentation": "Result of a schedule deletion." + }, + "ScheduleDescribeResultModel": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "locationName": "nextToken", + "documentation": "The next token; for use in pagination." + }, + "ScheduleActions": { + "shape": "__listOfScheduleAction", + "locationName": "scheduleActions", + "documentation": "The list of actions in the schedule." + } + }, + "documentation": "Results of a schedule describe.", + "required": [ + "ScheduleActions" + ] + }, + "Scte20Convert608To708": { + "type": "string", + "documentation": "Scte20 Convert608 To708", + "enum": [ + "DISABLED", + "UPCONVERT" + ] + }, + "Scte20PlusEmbeddedDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Scte20 Plus Embedded Destination Settings" + }, + "Scte20SourceSettings": { + "type": "structure", + "members": { + "Convert608To708": { + "shape": "Scte20Convert608To708", + "locationName": "convert608To708", + "documentation": "If upconvert, 608 data is both passed through via the \"608 compatibility bytes\" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded." + }, + "Source608ChannelNumber": { + "shape": "__integerMin1Max4", + "locationName": "source608ChannelNumber", + "documentation": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough." + } + }, + "documentation": "Scte20 Source Settings" + }, + "Scte27DestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Scte27 Destination Settings" + }, + "Scte27SourceSettings": { + "type": "structure", + "members": { + "Pid": { + "shape": "__integerMin1", + "locationName": "pid", + "documentation": "The pid field is used in conjunction with the caption selector languageCode field as follows:\n - Specify PID and Language: Extracts captions from that PID; the language is \"informational\".\n - Specify PID and omit Language: Extracts the specified PID.\n - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be.\n - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through." + } + }, + "documentation": "Scte27 Source Settings" + }, + "Scte35AposNoRegionalBlackoutBehavior": { + "type": "string", + "documentation": "Scte35 Apos No Regional Blackout Behavior", + "enum": [ + "FOLLOW", + "IGNORE" + ] + }, + "Scte35AposWebDeliveryAllowedBehavior": { + "type": "string", + "documentation": "Scte35 Apos Web Delivery Allowed Behavior", + "enum": [ + "FOLLOW", + "IGNORE" + ] + }, + "Scte35ArchiveAllowedFlag": { + "type": "string", + "documentation": "Corresponds to the archive_allowed parameter. A value of ARCHIVE_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.", + "enum": [ + "ARCHIVE_NOT_ALLOWED", + "ARCHIVE_ALLOWED" + ] + }, + "Scte35DeliveryRestrictions": { + "type": "structure", + "members": { + "ArchiveAllowedFlag": { + "shape": "Scte35ArchiveAllowedFlag", + "locationName": "archiveAllowedFlag", + "documentation": "Corresponds to SCTE-35 archive_allowed_flag." + }, + "DeviceRestrictions": { + "shape": "Scte35DeviceRestrictions", + "locationName": "deviceRestrictions", + "documentation": "Corresponds to SCTE-35 device_restrictions parameter." + }, + "NoRegionalBlackoutFlag": { + "shape": "Scte35NoRegionalBlackoutFlag", + "locationName": "noRegionalBlackoutFlag", + "documentation": "Corresponds to SCTE-35 no_regional_blackout_flag parameter." + }, + "WebDeliveryAllowedFlag": { + "shape": "Scte35WebDeliveryAllowedFlag", + "locationName": "webDeliveryAllowedFlag", + "documentation": "Corresponds to SCTE-35 web_delivery_allowed_flag parameter." + } + }, + "documentation": "Corresponds to SCTE-35 delivery_not_restricted_flag parameter. To declare delivery restrictions, include this element and its four \"restriction\" flags. To declare that there are no restrictions, omit this element.", + "required": [ + "DeviceRestrictions", + "ArchiveAllowedFlag", + "WebDeliveryAllowedFlag", + "NoRegionalBlackoutFlag" + ] + }, + "Scte35Descriptor": { + "type": "structure", + "members": { + "Scte35DescriptorSettings": { + "shape": "Scte35DescriptorSettings", + "locationName": "scte35DescriptorSettings", + "documentation": "SCTE-35 Descriptor Settings." + } + }, + "documentation": "Holds one set of SCTE-35 Descriptor Settings.", + "required": [ + "Scte35DescriptorSettings" + ] + }, + "Scte35DescriptorSettings": { + "type": "structure", + "members": { + "SegmentationDescriptorScte35DescriptorSettings": { + "shape": "Scte35SegmentationDescriptor", + "locationName": "segmentationDescriptorScte35DescriptorSettings", + "documentation": "SCTE-35 Segmentation Descriptor." + } + }, + "documentation": "SCTE-35 Descriptor settings.", + "required": [ + "SegmentationDescriptorScte35DescriptorSettings" + ] + }, + "Scte35DeviceRestrictions": { + "type": "string", + "documentation": "Corresponds to the device_restrictions parameter in a segmentation_descriptor. If you include one of the \"restriction\" flags then you must include all four of them.", + "enum": [ + "NONE", + "RESTRICT_GROUP0", + "RESTRICT_GROUP1", + "RESTRICT_GROUP2" + ] + }, + "Scte35NoRegionalBlackoutFlag": { + "type": "string", + "documentation": "Corresponds to the no_regional_blackout_flag parameter. A value of REGIONAL_BLACKOUT corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.", + "enum": [ + "REGIONAL_BLACKOUT", + "NO_REGIONAL_BLACKOUT" + ] + }, + "Scte35ReturnToNetworkScheduleActionSettings": { + "type": "structure", + "members": { + "SpliceEventId": { + "shape": "__longMin0Max4294967295", + "locationName": "spliceEventId", + "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35." + } + }, + "documentation": "Settings for a SCTE-35 return_to_network message.", + "required": [ + "SpliceEventId" + ] + }, + "Scte35SegmentationCancelIndicator": { + "type": "string", + "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator. SEGMENTATION_EVENT_NOT_CANCELED corresponds to 0 in the SCTE-35 specification and indicates that this is an insertion request. SEGMENTATION_EVENT_CANCELED corresponds to 1 in the SCTE-35 specification and indicates that this is a cancelation request, in which case complete this field and the existing event ID to cancel.", + "enum": [ + "SEGMENTATION_EVENT_NOT_CANCELED", + "SEGMENTATION_EVENT_CANCELED" + ] + }, + "Scte35SegmentationDescriptor": { + "type": "structure", + "members": { + "DeliveryRestrictions": { + "shape": "Scte35DeliveryRestrictions", + "locationName": "deliveryRestrictions", + "documentation": "Holds the four SCTE-35 delivery restriction parameters." + }, + "SegmentNum": { + "shape": "__integerMin0Max255", + "locationName": "segmentNum", + "documentation": "Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id." + }, + "SegmentationCancelIndicator": { + "shape": "Scte35SegmentationCancelIndicator", + "locationName": "segmentationCancelIndicator", + "documentation": "Corresponds to SCTE-35 segmentation_event_cancel_indicator." + }, + "SegmentationDuration": { + "shape": "__longMin0Max1099511627775", + "locationName": "segmentationDuration", + "documentation": "Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message." + }, + "SegmentationEventId": { + "shape": "__longMin0Max4294967295", + "locationName": "segmentationEventId", + "documentation": "Corresponds to SCTE-35 segmentation_event_id. " + }, + "SegmentationTypeId": { + "shape": "__integerMin0Max255", + "locationName": "segmentationTypeId", + "documentation": "Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, \"52\"). In the CLI, API, or an SDK, enter the ID in hex (for example, \"0x34\") or decimal (for example, \"52\")." + }, + "SegmentationUpid": { + "shape": "__string", + "locationName": "segmentationUpid", + "documentation": "Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII \"ADS Information\" becomes hex \"41445320496e666f726d6174696f6e." + }, + "SegmentationUpidType": { + "shape": "__integerMin0Max255", + "locationName": "segmentationUpidType", + "documentation": "Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, \"0x0C\" hex from the specification is \"12\" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, \"0x0C\" ) or in decimal (for example, \"12\")." + }, + "SegmentsExpected": { + "shape": "__integerMin0Max255", + "locationName": "segmentsExpected", + "documentation": "Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id." + }, + "SubSegmentNum": { + "shape": "__integerMin0Max255", + "locationName": "subSegmentNum", + "documentation": "Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id." + }, + "SubSegmentsExpected": { + "shape": "__integerMin0Max255", + "locationName": "subSegmentsExpected", + "documentation": "Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id." + } + }, + "documentation": "Corresponds to SCTE-35 segmentation_descriptor.", + "required": [ + "SegmentationEventId", + "SegmentationCancelIndicator" + ] + }, + "Scte35SpliceInsert": { + "type": "structure", + "members": { + "AdAvailOffset": { + "shape": "__integerMinNegative1000Max1000", + "locationName": "adAvailOffset", + "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages." + }, + "NoRegionalBlackoutFlag": { + "shape": "Scte35SpliceInsertNoRegionalBlackoutBehavior", + "locationName": "noRegionalBlackoutFlag", + "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates" + }, + "WebDeliveryAllowedFlag": { + "shape": "Scte35SpliceInsertWebDeliveryAllowedBehavior", + "locationName": "webDeliveryAllowedFlag", + "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates" + } + }, + "documentation": "Scte35 Splice Insert" + }, + "Scte35SpliceInsertNoRegionalBlackoutBehavior": { + "type": "string", + "documentation": "Scte35 Splice Insert No Regional Blackout Behavior", + "enum": [ + "FOLLOW", + "IGNORE" + ] + }, + "Scte35SpliceInsertScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "shape": "__longMin0Max8589934591", + "locationName": "duration", + "documentation": "Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time." + }, + "SpliceEventId": { + "shape": "__longMin0Max4294967295", + "locationName": "spliceEventId", + "documentation": "The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35." + } + }, + "documentation": "Settings for a SCTE-35 splice_insert message.", + "required": [ + "SpliceEventId" + ] + }, + "Scte35SpliceInsertWebDeliveryAllowedBehavior": { + "type": "string", + "documentation": "Scte35 Splice Insert Web Delivery Allowed Behavior", + "enum": [ + "FOLLOW", + "IGNORE" + ] + }, + "Scte35TimeSignalApos": { + "type": "structure", + "members": { + "AdAvailOffset": { + "shape": "__integerMinNegative1000Max1000", + "locationName": "adAvailOffset", + "documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages." + }, + "NoRegionalBlackoutFlag": { + "shape": "Scte35AposNoRegionalBlackoutBehavior", + "locationName": "noRegionalBlackoutFlag", + "documentation": "When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates" + }, + "WebDeliveryAllowedFlag": { + "shape": "Scte35AposWebDeliveryAllowedBehavior", + "locationName": "webDeliveryAllowedFlag", + "documentation": "When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates" + } + }, + "documentation": "Scte35 Time Signal Apos" + }, + "Scte35TimeSignalScheduleActionSettings": { + "type": "structure", + "members": { + "Scte35Descriptors": { + "shape": "__listOfScte35Descriptor", + "locationName": "scte35Descriptors", + "documentation": "The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal." + } + }, + "documentation": "Settings for a SCTE-35 time_signal.", + "required": [ + "Scte35Descriptors" + ] + }, + "Scte35WebDeliveryAllowedFlag": { + "type": "string", + "documentation": "Corresponds to the web_delivery_allowed_flag parameter. A value of WEB_DELIVERY_NOT_ALLOWED corresponds to 0 (false) in the SCTE-35 specification. If you include one of the \"restriction\" flags then you must include all four of them.", + "enum": [ + "WEB_DELIVERY_NOT_ALLOWED", + "WEB_DELIVERY_ALLOWED" + ] + }, + "SmoothGroupAudioOnlyTimecodeControl": { + "type": "string", + "documentation": "Smooth Group Audio Only Timecode Control", + "enum": [ + "PASSTHROUGH", + "USE_CONFIGURED_CLOCK" + ] + }, + "SmoothGroupCertificateMode": { + "type": "string", + "documentation": "Smooth Group Certificate Mode", + "enum": [ + "SELF_SIGNED", + "VERIFY_AUTHENTICITY" + ] + }, + "SmoothGroupEventIdMode": { + "type": "string", + "documentation": "Smooth Group Event Id Mode", + "enum": [ + "NO_EVENT_ID", + "USE_CONFIGURED", + "USE_TIMESTAMP" + ] + }, + "SmoothGroupEventStopBehavior": { + "type": "string", + "documentation": "Smooth Group Event Stop Behavior", + "enum": [ + "NONE", + "SEND_EOS" + ] + }, + "SmoothGroupSegmentationMode": { + "type": "string", + "documentation": "Smooth Group Segmentation Mode", + "enum": [ + "USE_INPUT_SEGMENTATION", + "USE_SEGMENT_DURATION" + ] + }, + "SmoothGroupSparseTrackType": { + "type": "string", + "documentation": "Smooth Group Sparse Track Type", + "enum": [ + "NONE", + "SCTE_35" + ] + }, + "SmoothGroupStreamManifestBehavior": { + "type": "string", + "documentation": "Smooth Group Stream Manifest Behavior", + "enum": [ + "DO_NOT_SEND", + "SEND" + ] + }, + "SmoothGroupTimestampOffsetMode": { + "type": "string", + "documentation": "Smooth Group Timestamp Offset Mode", + "enum": [ + "USE_CONFIGURED_OFFSET", + "USE_EVENT_START_DATE" + ] + }, + "SmpteTtDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Smpte Tt Destination Settings" + }, + "StandardHlsSettings": { + "type": "structure", + "members": { + "AudioRenditionSets": { + "shape": "__string", + "locationName": "audioRenditionSets", + "documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','." + }, + "M3u8Settings": { + "shape": "M3u8Settings", + "locationName": "m3u8Settings" + } + }, + "documentation": "Standard Hls Settings", + "required": [ + "M3u8Settings" + ] + }, + "StartChannelRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "A request to start a channel" + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for StartChannelRequest" + }, + "StartChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelineDetails": { + "shape": "__listOfPipelineDetail", + "locationName": "pipelineDetails", + "documentation": "Runtime details for the pipelines of a running channel." + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for StartChannelResponse" + }, + "StartTimecode": { + "type": "structure", + "members": { + "Timecode": { + "shape": "__string", + "locationName": "timecode", + "documentation": "The timecode for the frame where you want to start the clip. Optional; if not specified, the clip starts at first frame in the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF." + } + }, + "documentation": "Settings to identify the start of the clip." + }, + "StaticImageActivateScheduleActionSettings": { + "type": "structure", + "members": { + "Duration": { + "shape": "__integerMin0", + "locationName": "duration", + "documentation": "The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated." + }, + "FadeIn": { + "shape": "__integerMin0", + "locationName": "fadeIn", + "documentation": "The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in)." + }, + "FadeOut": { + "shape": "__integerMin0", + "locationName": "fadeOut", + "documentation": "Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out)." + }, + "Height": { + "shape": "__integerMin1", + "locationName": "height", + "documentation": "The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay." + }, + "Image": { + "shape": "InputLocation", + "locationName": "image", + "documentation": "The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video." + }, + "ImageX": { + "shape": "__integerMin0", + "locationName": "imageX", + "documentation": "Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right." + }, + "ImageY": { + "shape": "__integerMin0", + "locationName": "imageY", + "documentation": "Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom." + }, + "Layer": { + "shape": "__integerMin0Max7", + "locationName": "layer", + "documentation": "The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0." + }, + "Opacity": { + "shape": "__integerMin0Max100", + "locationName": "opacity", + "documentation": "Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100." + }, + "Width": { + "shape": "__integerMin1", + "locationName": "width", + "documentation": "The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay." + } + }, + "documentation": "Settings for the action to activate a static image.", + "required": [ + "Image" + ] + }, + "StaticImageDeactivateScheduleActionSettings": { + "type": "structure", + "members": { + "FadeOut": { + "shape": "__integerMin0", + "locationName": "fadeOut", + "documentation": "The time in milliseconds for the image to fade out. Default is 0 (no fade-out)." + }, + "Layer": { + "shape": "__integerMin0Max7", + "locationName": "layer", + "documentation": "The image overlay layer to deactivate, 0 to 7. Default is 0." + } + }, + "documentation": "Settings for the action to deactivate the image in a specific layer." + }, + "StaticKeySettings": { + "type": "structure", + "members": { + "KeyProviderServer": { + "shape": "InputLocation", + "locationName": "keyProviderServer", + "documentation": "The URL of the license server used for protecting content." + }, + "StaticKeyValue": { + "shape": "__stringMin32Max32", + "locationName": "staticKeyValue", + "documentation": "Static key value as a 32 character hexadecimal string." + } + }, + "documentation": "Static Key Settings", + "required": [ + "StaticKeyValue" + ] + }, + "StopChannelRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "A request to stop a running channel" + } + }, + "required": [ + "ChannelId" + ], + "documentation": "Placeholder documentation for StopChannelRequest" + }, + "StopChannelResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "locationName": "arn", + "documentation": "The unique arn of the channel." + }, + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of destinations of the channel. For UDP outputs, there is one\ndestination per output. For other types (HLS, for example), there is\none destination per packager.\n" + }, + "EgressEndpoints": { + "shape": "__listOfChannelEgressEndpoint", + "locationName": "egressEndpoints", + "documentation": "The endpoints where outgoing connections initiate from" + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings" + }, + "Id": { + "shape": "__string", + "locationName": "id", + "documentation": "The unique id of the channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments", + "documentation": "List of input attachments for channel." + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level being written to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel. (user-mutable)" + }, + "PipelineDetails": { + "shape": "__listOfPipelineDetail", + "locationName": "pipelineDetails", + "documentation": "Runtime details for the pipelines of a running channel." + }, + "PipelinesRunningCount": { + "shape": "__integer", + "locationName": "pipelinesRunningCount", + "documentation": "The number of currently healthy pipelines." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role assumed when running the Channel." + }, + "State": { + "shape": "ChannelState", + "locationName": "state" + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + } + }, + "documentation": "Placeholder documentation for StopChannelResponse" + }, + "StopTimecode": { + "type": "structure", + "members": { + "LastFrameClippingBehavior": { + "shape": "LastFrameClippingBehavior", + "locationName": "lastFrameClippingBehavior", + "documentation": "If you specify a StopTimecode in an input (in order to clip the file), you can specify if you want the clip to exclude (the default) or include the frame specified by the timecode." + }, + "Timecode": { + "shape": "__string", + "locationName": "timecode", + "documentation": "The timecode for the frame where you want to stop the clip. Optional; if not specified, the clip continues to the end of the file. Enter the timecode as HH:MM:SS:FF or HH:MM:SS;FF." + } + }, + "documentation": "Settings to identify the end of the clip." + }, + "Tags": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + }, + "documentation": "Placeholder documentation for Tags" + }, + "TagsModel": { + "type": "structure", + "members": { + "Tags": { + "shape": "Tags", + "locationName": "tags" + } + }, + "documentation": "Placeholder documentation for TagsModel" + }, + "TeletextDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Teletext Destination Settings" + }, + "TeletextSourceSettings": { + "type": "structure", + "members": { + "PageNumber": { + "shape": "__string", + "locationName": "pageNumber", + "documentation": "Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no \"0x\" prefix." + } + }, + "documentation": "Teletext Source Settings" + }, + "TimecodeConfig": { + "type": "structure", + "members": { + "Source": { + "shape": "TimecodeConfigSource", + "locationName": "source", + "documentation": "Identifies the source for the timecode that will be associated with the events outputs.\n-Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using \"Start at 0\" (zerobased).\n-System Clock (systemclock): Use the UTC time.\n-Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00." + }, + "SyncThreshold": { + "shape": "__integerMin1Max1000000", + "locationName": "syncThreshold", + "documentation": "Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified." + } + }, + "documentation": "Timecode Config", + "required": [ + "Source" + ] + }, + "TimecodeConfigSource": { + "type": "string", + "documentation": "Timecode Config Source", + "enum": [ + "EMBEDDED", + "SYSTEMCLOCK", + "ZEROBASED" + ] + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + } + }, + "exception": true, + "error": { + "httpStatusCode": 429 + }, + "documentation": "Placeholder documentation for TooManyRequestsException" + }, + "TtmlDestinationSettings": { + "type": "structure", + "members": { + "StyleControl": { + "shape": "TtmlDestinationStyleControl", + "locationName": "styleControl", + "documentation": "When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output." + } + }, + "documentation": "Ttml Destination Settings" + }, + "TtmlDestinationStyleControl": { + "type": "string", + "documentation": "Ttml Destination Style Control", + "enum": [ + "PASSTHROUGH", + "USE_CONFIGURED" + ] + }, + "UdpContainerSettings": { + "type": "structure", + "members": { + "M2tsSettings": { + "shape": "M2tsSettings", + "locationName": "m2tsSettings" + } + }, + "documentation": "Udp Container Settings" + }, + "UdpGroupSettings": { + "type": "structure", + "members": { + "InputLossAction": { + "shape": "InputLossActionForUdpOut", + "locationName": "inputLossAction", + "documentation": "Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video." + }, + "TimedMetadataId3Frame": { + "shape": "UdpTimedMetadataId3Frame", + "locationName": "timedMetadataId3Frame", + "documentation": "Indicates ID3 frame that has the timecode." + }, + "TimedMetadataId3Period": { + "shape": "__integerMin0", + "locationName": "timedMetadataId3Period", + "documentation": "Timed Metadata interval in seconds." + } + }, + "documentation": "Udp Group Settings" + }, + "UdpOutputSettings": { + "type": "structure", + "members": { + "BufferMsec": { + "shape": "__integerMin0Max10000", + "locationName": "bufferMsec", + "documentation": "UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc." + }, + "ContainerSettings": { + "shape": "UdpContainerSettings", + "locationName": "containerSettings" + }, + "Destination": { + "shape": "OutputLocationRef", + "locationName": "destination", + "documentation": "Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002)." + }, + "FecOutputSettings": { + "shape": "FecOutputSettings", + "locationName": "fecOutputSettings", + "documentation": "Settings for enabling and adjusting Forward Error Correction on UDP outputs." + } + }, + "documentation": "Udp Output Settings", + "required": [ + "Destination", + "ContainerSettings" + ] + }, + "UdpTimedMetadataId3Frame": { + "type": "string", + "documentation": "Udp Timed Metadata Id3 Frame", + "enum": [ + "NONE", + "PRIV", + "TDRL" + ] + }, + "UnprocessableEntityException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "locationName": "message" + }, + "ValidationErrors": { + "shape": "__listOfValidationError", + "locationName": "validationErrors", + "documentation": "A collection of validation error responses." + } + }, + "exception": true, + "error": { + "httpStatusCode": 422 + }, + "documentation": "Placeholder documentation for UnprocessableEntityException" + }, + "UpdateChannel": { + "type": "structure", + "members": { + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of output destinations for this channel." + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings", + "documentation": "The encoder settings for this channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification", + "documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level to write to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed." + } + }, + "documentation": "Placeholder documentation for UpdateChannel" + }, + "UpdateChannelClass": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The channel class that you wish to update this channel to use." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of output destinations for this channel." + } + }, + "required": [ + "ChannelClass" + ], + "documentation": "Placeholder documentation for UpdateChannelClass" + }, + "UpdateChannelClassRequest": { + "type": "structure", + "members": { + "ChannelClass": { + "shape": "ChannelClass", + "locationName": "channelClass", + "documentation": "The channel class that you wish to update this channel to use." + }, + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "Channel Id of the channel whose class should be updated." + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of output destinations for this channel." + } + }, + "documentation": "Channel class that the channel should be updated to.", + "required": [ + "ChannelId", + "ChannelClass" + ] + }, + "UpdateChannelClassResponse": { + "type": "structure", + "members": { + "Channel": { + "shape": "Channel", + "locationName": "channel" + } + }, + "documentation": "Placeholder documentation for UpdateChannelClassResponse" + }, + "UpdateChannelRequest": { + "type": "structure", + "members": { + "ChannelId": { + "shape": "__string", + "location": "uri", + "locationName": "channelId", + "documentation": "channel ID" + }, + "Destinations": { + "shape": "__listOfOutputDestination", + "locationName": "destinations", + "documentation": "A list of output destinations for this channel." + }, + "EncoderSettings": { + "shape": "EncoderSettings", + "locationName": "encoderSettings", + "documentation": "The encoder settings for this channel." + }, + "InputAttachments": { + "shape": "__listOfInputAttachment", + "locationName": "inputAttachments" + }, + "InputSpecification": { + "shape": "InputSpecification", + "locationName": "inputSpecification", + "documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)" + }, + "LogLevel": { + "shape": "LogLevel", + "locationName": "logLevel", + "documentation": "The log level to write to CloudWatch Logs." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of the channel." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed." + } + }, + "documentation": "A request to update a channel.", + "required": [ + "ChannelId" + ] + }, + "UpdateChannelResponse": { + "type": "structure", + "members": { + "Channel": { + "shape": "Channel", + "locationName": "channel" + } + }, + "documentation": "Placeholder documentation for UpdateChannelResponse" + }, + "UpdateChannelResultModel": { + "type": "structure", + "members": { + "Channel": { + "shape": "Channel", + "locationName": "channel" + } + }, + "documentation": "The updated channel's description." + }, + "UpdateInput": { + "type": "structure", + "members": { + "Destinations": { + "shape": "__listOfInputDestinationRequest", + "locationName": "destinations", + "documentation": "Destination settings for PUSH type inputs." + }, + "InputSecurityGroups": { + "shape": "__listOf__string", + "locationName": "inputSecurityGroups", + "documentation": "A list of security groups referenced by IDs to attach to the input." + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlowRequest", + "locationName": "mediaConnectFlows", + "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.\n" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the input." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "Sources": { + "shape": "__listOfInputSourceRequest", + "locationName": "sources", + "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty.\n" + } + }, + "documentation": "Placeholder documentation for UpdateInput" + }, + "UpdateInputRequest": { + "type": "structure", + "members": { + "Destinations": { + "shape": "__listOfInputDestinationRequest", + "locationName": "destinations", + "documentation": "Destination settings for PUSH type inputs." + }, + "InputId": { + "shape": "__string", + "location": "uri", + "locationName": "inputId", + "documentation": "Unique ID of the input." + }, + "InputSecurityGroups": { + "shape": "__listOf__string", + "locationName": "inputSecurityGroups", + "documentation": "A list of security groups referenced by IDs to attach to the input." + }, + "MediaConnectFlows": { + "shape": "__listOfMediaConnectFlowRequest", + "locationName": "mediaConnectFlows", + "documentation": "A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one\nFlow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a\nseparate Availability Zone as this ensures your EML input is redundant to AZ issues.\n" + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the input." + }, + "RoleArn": { + "shape": "__string", + "locationName": "roleArn", + "documentation": "The Amazon Resource Name (ARN) of the role this input assumes during and after creation." + }, + "Sources": { + "shape": "__listOfInputSourceRequest", + "locationName": "sources", + "documentation": "The source URLs for a PULL-type input. Every PULL type input needs\nexactly two source URLs for redundancy.\nOnly specify sources for PULL type Inputs. Leave Destinations empty.\n" + } + }, + "documentation": "A request to update an input.", + "required": [ + "InputId" + ] + }, + "UpdateInputResponse": { + "type": "structure", + "members": { + "Input": { + "shape": "Input", + "locationName": "input" + } + }, + "documentation": "Placeholder documentation for UpdateInputResponse" + }, + "UpdateInputResultModel": { + "type": "structure", + "members": { + "Input": { + "shape": "Input", + "locationName": "input" + } + }, + "documentation": "Placeholder documentation for UpdateInputResultModel" + }, + "UpdateInputSecurityGroupRequest": { + "type": "structure", + "members": { + "InputSecurityGroupId": { + "shape": "__string", + "location": "uri", + "locationName": "inputSecurityGroupId", + "documentation": "The id of the Input Security Group to update." + }, + "Tags": { + "shape": "Tags", + "locationName": "tags", + "documentation": "A collection of key-value pairs." + }, + "WhitelistRules": { + "shape": "__listOfInputWhitelistRuleCidr", + "locationName": "whitelistRules", + "documentation": "List of IPv4 CIDR addresses to whitelist" + } + }, + "documentation": "The request to update some combination of the Input Security Group name and the IPv4 CIDRs the Input Security Group should allow.", + "required": [ + "InputSecurityGroupId" + ] + }, + "UpdateInputSecurityGroupResponse": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "InputSecurityGroup", + "locationName": "securityGroup" + } + }, + "documentation": "Placeholder documentation for UpdateInputSecurityGroupResponse" + }, + "UpdateInputSecurityGroupResultModel": { + "type": "structure", + "members": { + "SecurityGroup": { + "shape": "InputSecurityGroup", + "locationName": "securityGroup" + } + }, + "documentation": "Placeholder documentation for UpdateInputSecurityGroupResultModel" + }, + "UpdateReservation": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the reservation" + } + }, + "documentation": "UpdateReservation request" + }, + "UpdateReservationRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "Name of the reservation" + }, + "ReservationId": { + "shape": "__string", + "location": "uri", + "locationName": "reservationId", + "documentation": "Unique reservation ID, e.g. '1234567'" + } + }, + "documentation": "Request to update a reservation", + "required": [ + "ReservationId" + ] + }, + "UpdateReservationResponse": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Reservation", + "locationName": "reservation" + } + }, + "documentation": "Placeholder documentation for UpdateReservationResponse" + }, + "UpdateReservationResultModel": { + "type": "structure", + "members": { + "Reservation": { + "shape": "Reservation", + "locationName": "reservation" + } + }, + "documentation": "UpdateReservation response" + }, + "ValidationError": { + "type": "structure", + "members": { + "ElementPath": { + "shape": "__string", + "locationName": "elementPath" + }, + "ErrorMessage": { + "shape": "__string", + "locationName": "errorMessage" + } + }, + "documentation": "Placeholder documentation for ValidationError" + }, + "VideoCodecSettings": { + "type": "structure", + "members": { + "FrameCaptureSettings": { + "shape": "FrameCaptureSettings", + "locationName": "frameCaptureSettings" + }, + "H264Settings": { + "shape": "H264Settings", + "locationName": "h264Settings" + }, + "H265Settings": { + "shape": "H265Settings", + "locationName": "h265Settings" + } + }, + "documentation": "Video Codec Settings" + }, + "VideoDescription": { + "type": "structure", + "members": { + "CodecSettings": { + "shape": "VideoCodecSettings", + "locationName": "codecSettings", + "documentation": "Video codec settings." + }, + "Height": { + "shape": "__integer", + "locationName": "height", + "documentation": "Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required." + }, + "Name": { + "shape": "__string", + "locationName": "name", + "documentation": "The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event." + }, + "RespondToAfd": { + "shape": "VideoDescriptionRespondToAfd", + "locationName": "respondToAfd", + "documentation": "Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped." + }, + "ScalingBehavior": { + "shape": "VideoDescriptionScalingBehavior", + "locationName": "scalingBehavior", + "documentation": "STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution." + }, + "Sharpness": { + "shape": "__integerMin0Max100", + "locationName": "sharpness", + "documentation": "Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content." + }, + "Width": { + "shape": "__integer", + "locationName": "width", + "documentation": "Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required." + } + }, + "documentation": "Video settings for this stream.", + "required": [ + "Name" + ] + }, + "VideoDescriptionRespondToAfd": { + "type": "string", + "documentation": "Video Description Respond To Afd", + "enum": [ + "NONE", + "PASSTHROUGH", + "RESPOND" + ] + }, + "VideoDescriptionScalingBehavior": { + "type": "string", + "documentation": "Video Description Scaling Behavior", + "enum": [ + "DEFAULT", + "STRETCH_TO_OUTPUT" + ] + }, + "VideoSelector": { + "type": "structure", + "members": { + "ColorSpace": { + "shape": "VideoSelectorColorSpace", + "locationName": "colorSpace", + "documentation": "Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed." + }, + "ColorSpaceUsage": { + "shape": "VideoSelectorColorSpaceUsage", + "locationName": "colorSpaceUsage", + "documentation": "Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data." + }, + "SelectorSettings": { + "shape": "VideoSelectorSettings", + "locationName": "selectorSettings", + "documentation": "The video selector settings." + } + }, + "documentation": "Specifies a particular video stream within an input source. An input may have only a single video selector." + }, + "VideoSelectorColorSpace": { + "type": "string", + "documentation": "Video Selector Color Space", + "enum": [ + "FOLLOW", + "REC_601", + "REC_709" + ] + }, + "VideoSelectorColorSpaceUsage": { + "type": "string", + "documentation": "Video Selector Color Space Usage", + "enum": [ + "FALLBACK", + "FORCE" + ] + }, + "VideoSelectorPid": { + "type": "structure", + "members": { + "Pid": { + "shape": "__integerMin0Max8191", + "locationName": "pid", + "documentation": "Selects a specific PID from within a video source." + } + }, + "documentation": "Video Selector Pid" + }, + "VideoSelectorProgramId": { + "type": "structure", + "members": { + "ProgramId": { + "shape": "__integerMin0Max65536", + "locationName": "programId", + "documentation": "Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default." + } + }, + "documentation": "Video Selector Program Id" + }, + "VideoSelectorSettings": { + "type": "structure", + "members": { + "VideoSelectorPid": { + "shape": "VideoSelectorPid", + "locationName": "videoSelectorPid" + }, + "VideoSelectorProgramId": { + "shape": "VideoSelectorProgramId", + "locationName": "videoSelectorProgramId" + } + }, + "documentation": "Video Selector Settings" + }, + "WebvttDestinationSettings": { + "type": "structure", + "members": { + }, + "documentation": "Webvtt Destination Settings" + }, + "__boolean": { + "type": "boolean", + "documentation": "Placeholder documentation for __boolean" + }, + "__double": { + "type": "double", + "documentation": "Placeholder documentation for __double" + }, + "__doubleMin0": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMin0" + }, + "__doubleMin0Max1000000000": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMin0Max1000000000" + }, + "__doubleMin0Max65535": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMin0Max65535" + }, + "__doubleMin1": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMin1" + }, + "__doubleMin10000Max1000000000": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMin10000Max1000000000" + }, + "__doubleMinNegative59Max0": { + "type": "double", + "documentation": "Placeholder documentation for __doubleMinNegative59Max0" + }, + "__integer": { + "type": "integer", + "documentation": "Placeholder documentation for __integer" + }, + "__integerMin0": { + "type": "integer", + "min": 0, + "documentation": "Placeholder documentation for __integerMin0" + }, + "__integerMin0Max10": { + "type": "integer", + "min": 0, + "max": 10, + "documentation": "Placeholder documentation for __integerMin0Max10" + }, + "__integerMin0Max100": { + "type": "integer", + "min": 0, + "max": 100, + "documentation": "Placeholder documentation for __integerMin0Max100" + }, + "__integerMin0Max1000": { + "type": "integer", + "min": 0, + "max": 1000, + "documentation": "Placeholder documentation for __integerMin0Max1000" + }, + "__integerMin0Max10000": { + "type": "integer", + "min": 0, + "max": 10000, + "documentation": "Placeholder documentation for __integerMin0Max10000" + }, + "__integerMin0Max1000000": { + "type": "integer", + "min": 0, + "max": 1000000, + "documentation": "Placeholder documentation for __integerMin0Max1000000" + }, + "__integerMin0Max128": { + "type": "integer", + "min": 0, + "max": 128, + "documentation": "Placeholder documentation for __integerMin0Max128" + }, + "__integerMin0Max15": { + "type": "integer", + "min": 0, + "max": 15, + "documentation": "Placeholder documentation for __integerMin0Max15" + }, + "__integerMin0Max255": { + "type": "integer", + "min": 0, + "max": 255, + "documentation": "Placeholder documentation for __integerMin0Max255" + }, + "__integerMin0Max30": { + "type": "integer", + "min": 0, + "max": 30, + "documentation": "Placeholder documentation for __integerMin0Max30" + }, + "__integerMin0Max32768": { + "type": "integer", + "min": 0, + "max": 32768, + "documentation": "Placeholder documentation for __integerMin0Max32768" + }, + "__integerMin0Max3600": { + "type": "integer", + "min": 0, + "max": 3600, + "documentation": "Placeholder documentation for __integerMin0Max3600" + }, + "__integerMin0Max500": { + "type": "integer", + "min": 0, + "max": 500, + "documentation": "Placeholder documentation for __integerMin0Max500" + }, + "__integerMin0Max600": { + "type": "integer", + "min": 0, + "max": 600, + "documentation": "Placeholder documentation for __integerMin0Max600" + }, + "__integerMin0Max65535": { + "type": "integer", + "min": 0, + "max": 65535, + "documentation": "Placeholder documentation for __integerMin0Max65535" + }, + "__integerMin0Max65536": { + "type": "integer", + "min": 0, + "max": 65536, + "documentation": "Placeholder documentation for __integerMin0Max65536" + }, + "__integerMin0Max7": { + "type": "integer", + "min": 0, + "max": 7, + "documentation": "Placeholder documentation for __integerMin0Max7" + }, + "__integerMin0Max8191": { + "type": "integer", + "min": 0, + "max": 8191, + "documentation": "Placeholder documentation for __integerMin0Max8191" + }, + "__integerMin1": { + "type": "integer", + "min": 1, + "documentation": "Placeholder documentation for __integerMin1" + }, + "__integerMin1000": { + "type": "integer", + "min": 1000, + "documentation": "Placeholder documentation for __integerMin1000" + }, + "__integerMin100000Max100000000": { + "type": "integer", + "min": 100000, + "max": 100000000, + "documentation": "Placeholder documentation for __integerMin100000Max100000000" + }, + "__integerMin100000Max40000000": { + "type": "integer", + "min": 100000, + "max": 40000000, + "documentation": "Placeholder documentation for __integerMin100000Max40000000" + }, + "__integerMin100000Max80000000": { + "type": "integer", + "min": 100000, + "max": 80000000, + "documentation": "Placeholder documentation for __integerMin100000Max80000000" + }, + "__integerMin1000Max30000": { + "type": "integer", + "min": 1000, + "max": 30000, + "documentation": "Placeholder documentation for __integerMin1000Max30000" + }, + "__integerMin1Max10": { + "type": "integer", + "min": 1, + "max": 10, + "documentation": "Placeholder documentation for __integerMin1Max10" + }, + "__integerMin1Max1000000": { + "type": "integer", + "min": 1, + "max": 1000000, + "documentation": "Placeholder documentation for __integerMin1Max1000000" + }, + "__integerMin1Max16": { + "type": "integer", + "min": 1, + "max": 16, + "documentation": "Placeholder documentation for __integerMin1Max16" + }, + "__integerMin1Max20": { + "type": "integer", + "min": 1, + "max": 20, + "documentation": "Placeholder documentation for __integerMin1Max20" + }, + "__integerMin1Max3003": { + "type": "integer", + "min": 1, + "max": 3003, + "documentation": "Placeholder documentation for __integerMin1Max3003" + }, + "__integerMin1Max31": { + "type": "integer", + "min": 1, + "max": 31, + "documentation": "Placeholder documentation for __integerMin1Max31" + }, + "__integerMin1Max32": { + "type": "integer", + "min": 1, + "max": 32, + "documentation": "Placeholder documentation for __integerMin1Max32" + }, + "__integerMin1Max3600": { + "type": "integer", + "min": 1, + "max": 3600, + "documentation": "Placeholder documentation for __integerMin1Max3600" + }, + "__integerMin1Max4": { + "type": "integer", + "min": 1, + "max": 4, + "documentation": "Placeholder documentation for __integerMin1Max4" + }, + "__integerMin1Max5": { + "type": "integer", + "min": 1, + "max": 5, + "documentation": "Placeholder documentation for __integerMin1Max5" + }, + "__integerMin1Max6": { + "type": "integer", + "min": 1, + "max": 6, + "documentation": "Placeholder documentation for __integerMin1Max6" + }, + "__integerMin1Max8": { + "type": "integer", + "min": 1, + "max": 8, + "documentation": "Placeholder documentation for __integerMin1Max8" + }, + "__integerMin25Max10000": { + "type": "integer", + "min": 25, + "max": 10000, + "documentation": "Placeholder documentation for __integerMin25Max10000" + }, + "__integerMin25Max2000": { + "type": "integer", + "min": 25, + "max": 2000, + "documentation": "Placeholder documentation for __integerMin25Max2000" + }, + "__integerMin3": { + "type": "integer", + "min": 3, + "documentation": "Placeholder documentation for __integerMin3" + }, + "__integerMin30": { + "type": "integer", + "min": 30, + "documentation": "Placeholder documentation for __integerMin30" + }, + "__integerMin4Max20": { + "type": "integer", + "min": 4, + "max": 20, + "documentation": "Placeholder documentation for __integerMin4Max20" + }, + "__integerMin96Max600": { + "type": "integer", + "min": 96, + "max": 600, + "documentation": "Placeholder documentation for __integerMin96Max600" + }, + "__integerMinNegative1000Max1000": { + "type": "integer", + "min": -1000, + "max": 1000, + "documentation": "Placeholder documentation for __integerMinNegative1000Max1000" + }, + "__integerMinNegative60Max6": { + "type": "integer", + "min": -60, + "max": 6, + "documentation": "Placeholder documentation for __integerMinNegative60Max6" + }, + "__integerMinNegative60Max60": { + "type": "integer", + "min": -60, + "max": 60, + "documentation": "Placeholder documentation for __integerMinNegative60Max60" + }, + "__listOfAudioChannelMapping": { + "type": "list", + "member": { + "shape": "AudioChannelMapping" + }, + "documentation": "Placeholder documentation for __listOfAudioChannelMapping" + }, + "__listOfAudioDescription": { + "type": "list", + "member": { + "shape": "AudioDescription" + }, + "documentation": "Placeholder documentation for __listOfAudioDescription" + }, + "__listOfAudioSelector": { + "type": "list", + "member": { + "shape": "AudioSelector" + }, + "documentation": "Placeholder documentation for __listOfAudioSelector" + }, + "__listOfCaptionDescription": { + "type": "list", + "member": { + "shape": "CaptionDescription" + }, + "documentation": "Placeholder documentation for __listOfCaptionDescription" + }, + "__listOfCaptionLanguageMapping": { + "type": "list", + "member": { + "shape": "CaptionLanguageMapping" + }, + "documentation": "Placeholder documentation for __listOfCaptionLanguageMapping" + }, + "__listOfCaptionSelector": { + "type": "list", + "member": { + "shape": "CaptionSelector" + }, + "documentation": "Placeholder documentation for __listOfCaptionSelector" + }, + "__listOfChannelEgressEndpoint": { + "type": "list", + "member": { + "shape": "ChannelEgressEndpoint" + }, + "documentation": "Placeholder documentation for __listOfChannelEgressEndpoint" + }, + "__listOfChannelSummary": { + "type": "list", + "member": { + "shape": "ChannelSummary" + }, + "documentation": "Placeholder documentation for __listOfChannelSummary" + }, + "__listOfHlsAdMarkers": { + "type": "list", + "member": { + "shape": "HlsAdMarkers" + }, + "documentation": "Placeholder documentation for __listOfHlsAdMarkers" + }, + "__listOfInput": { + "type": "list", + "member": { + "shape": "Input" + }, + "documentation": "Placeholder documentation for __listOfInput" + }, + "__listOfInputAttachment": { + "type": "list", + "member": { + "shape": "InputAttachment" + }, + "documentation": "Placeholder documentation for __listOfInputAttachment" + }, + "__listOfInputChannelLevel": { + "type": "list", + "member": { + "shape": "InputChannelLevel" + }, + "documentation": "Placeholder documentation for __listOfInputChannelLevel" + }, + "__listOfInputDestination": { + "type": "list", + "member": { + "shape": "InputDestination" + }, + "documentation": "Placeholder documentation for __listOfInputDestination" + }, + "__listOfInputDestinationRequest": { + "type": "list", + "member": { + "shape": "InputDestinationRequest" + }, + "documentation": "Placeholder documentation for __listOfInputDestinationRequest" + }, + "__listOfInputSecurityGroup": { + "type": "list", + "member": { + "shape": "InputSecurityGroup" + }, + "documentation": "Placeholder documentation for __listOfInputSecurityGroup" + }, + "__listOfInputSource": { + "type": "list", + "member": { + "shape": "InputSource" + }, + "documentation": "Placeholder documentation for __listOfInputSource" + }, + "__listOfInputSourceRequest": { + "type": "list", + "member": { + "shape": "InputSourceRequest" + }, + "documentation": "Placeholder documentation for __listOfInputSourceRequest" + }, + "__listOfInputWhitelistRule": { + "type": "list", + "member": { + "shape": "InputWhitelistRule" + }, + "documentation": "Placeholder documentation for __listOfInputWhitelistRule" + }, + "__listOfInputWhitelistRuleCidr": { + "type": "list", + "member": { + "shape": "InputWhitelistRuleCidr" + }, + "documentation": "Placeholder documentation for __listOfInputWhitelistRuleCidr" + }, + "__listOfMediaConnectFlow": { + "type": "list", + "member": { + "shape": "MediaConnectFlow" + }, + "documentation": "Placeholder documentation for __listOfMediaConnectFlow" + }, + "__listOfMediaConnectFlowRequest": { + "type": "list", + "member": { + "shape": "MediaConnectFlowRequest" + }, + "documentation": "Placeholder documentation for __listOfMediaConnectFlowRequest" + }, + "__listOfMediaPackageOutputDestinationSettings": { + "type": "list", + "member": { + "shape": "MediaPackageOutputDestinationSettings" + }, + "documentation": "Placeholder documentation for __listOfMediaPackageOutputDestinationSettings" + }, + "__listOfOffering": { + "type": "list", + "member": { + "shape": "Offering" + }, + "documentation": "Placeholder documentation for __listOfOffering" + }, + "__listOfOutput": { + "type": "list", + "member": { + "shape": "Output" + }, + "documentation": "Placeholder documentation for __listOfOutput" + }, + "__listOfOutputDestination": { + "type": "list", + "member": { + "shape": "OutputDestination" + }, + "documentation": "Placeholder documentation for __listOfOutputDestination" + }, + "__listOfOutputDestinationSettings": { + "type": "list", + "member": { + "shape": "OutputDestinationSettings" + }, + "documentation": "Placeholder documentation for __listOfOutputDestinationSettings" + }, + "__listOfOutputGroup": { + "type": "list", + "member": { + "shape": "OutputGroup" + }, + "documentation": "Placeholder documentation for __listOfOutputGroup" + }, + "__listOfPipelineDetail": { + "type": "list", + "member": { + "shape": "PipelineDetail" + }, + "documentation": "Placeholder documentation for __listOfPipelineDetail" + }, + "__listOfPipelinePauseStateSettings": { + "type": "list", + "member": { + "shape": "PipelinePauseStateSettings" + }, + "documentation": "Placeholder documentation for __listOfPipelinePauseStateSettings" + }, + "__listOfReservation": { + "type": "list", + "member": { + "shape": "Reservation" + }, + "documentation": "Placeholder documentation for __listOfReservation" + }, + "__listOfScheduleAction": { + "type": "list", + "member": { + "shape": "ScheduleAction" + }, + "documentation": "Placeholder documentation for __listOfScheduleAction" + }, + "__listOfScte35Descriptor": { + "type": "list", + "member": { + "shape": "Scte35Descriptor" + }, + "documentation": "Placeholder documentation for __listOfScte35Descriptor" + }, + "__listOfValidationError": { + "type": "list", + "member": { + "shape": "ValidationError" + }, + "documentation": "Placeholder documentation for __listOfValidationError" + }, + "__listOfVideoDescription": { + "type": "list", + "member": { + "shape": "VideoDescription" + }, + "documentation": "Placeholder documentation for __listOfVideoDescription" + }, + "__listOf__string": { + "type": "list", + "member": { + "shape": "__string" + }, + "documentation": "Placeholder documentation for __listOf__string" + }, + "__long": { + "type": "long", + "documentation": "Placeholder documentation for __long" + }, + "__longMin0Max1099511627775": { + "type": "long", + "min": 0, + "max": 1099511627775, + "documentation": "Placeholder documentation for __longMin0Max1099511627775" + }, + "__longMin0Max4294967295": { + "type": "long", + "min": 0, + "max": 4294967295, + "documentation": "Placeholder documentation for __longMin0Max4294967295" + }, + "__longMin0Max8589934591": { + "type": "long", + "min": 0, + "max": 8589934591, + "documentation": "Placeholder documentation for __longMin0Max8589934591" + }, + "__string": { + "type": "string", + "documentation": "Placeholder documentation for __string" + }, + "__stringMax256": { + "type": "string", + "max": 256, + "documentation": "Placeholder documentation for __stringMax256" + }, + "__stringMax32": { + "type": "string", + "max": 32, + "documentation": "Placeholder documentation for __stringMax32" + }, + "__stringMin1": { + "type": "string", + "min": 1, + "documentation": "Placeholder documentation for __stringMin1" + }, + "__stringMin1Max255": { + "type": "string", + "min": 1, + "max": 255, + "documentation": "Placeholder documentation for __stringMin1Max255" + }, + "__stringMin1Max256": { + "type": "string", + "min": 1, + "max": 256, + "documentation": "Placeholder documentation for __stringMin1Max256" + }, + "__stringMin32Max32": { + "type": "string", + "min": 32, + "max": 32, + "documentation": "Placeholder documentation for __stringMin32Max32" + }, + "__stringMin34Max34": { + "type": "string", + "min": 34, + "max": 34, + "documentation": "Placeholder documentation for __stringMin34Max34" + }, + "__stringMin3Max3": { + "type": "string", + "min": 3, + "max": 3, + "documentation": "Placeholder documentation for __stringMin3Max3" + }, + "__stringMin6Max6": { + "type": "string", + "min": 6, + "max": 6, + "documentation": "Placeholder documentation for __stringMin6Max6" + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601", + "documentation": "Placeholder documentation for __timestampIso8601" + }, + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp", + "documentation": "Placeholder documentation for __timestampUnix" + } + }, + "documentation": "API for AWS Elemental MediaLive" +} diff --git a/aws/dist/botocore/data/medialive/2017-10-14/waiters-2.json b/aws/dist/botocore/data/medialive/2017-10-14/waiters-2.json new file mode 100644 index 00000000..93721381 --- /dev/null +++ b/aws/dist/botocore/data/medialive/2017-10-14/waiters-2.json @@ -0,0 +1,111 @@ +{ + "version": 2, + "waiters": { + "ChannelCreated": { + "description": "Wait until a channel has been created", + "operation": "DescribeChannel", + "delay": 3, + "maxAttempts": 5, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "IDLE" + }, + { + "state": "retry", + "matcher": "path", + "argument": "State", + "expected": "CREATING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + }, + { + "state": "failure", + "matcher": "path", + "argument": "State", + "expected": "CREATE_FAILED" + } + ] + }, + "ChannelRunning": { + "description": "Wait until a channel is running", + "operation": "DescribeChannel", + "delay": 5, + "maxAttempts": 120, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "RUNNING" + }, + { + "state": "retry", + "matcher": "path", + "argument": "State", + "expected": "STARTING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "ChannelStopped": { + "description": "Wait until a channel has is stopped", + "operation": "DescribeChannel", + "delay": 5, + "maxAttempts": 28, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "IDLE" + }, + { + "state": "retry", + "matcher": "path", + "argument": "State", + "expected": "STOPPING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + }, + "ChannelDeleted": { + "description": "Wait until a channel has been deleted", + "operation": "DescribeChannel", + "delay": 5, + "maxAttempts": 20, + "acceptors": [ + { + "state": "success", + "matcher": "path", + "argument": "State", + "expected": "DELETED" + }, + { + "state": "retry", + "matcher": "path", + "argument": "State", + "expected": "DELETING" + }, + { + "state": "retry", + "matcher": "status", + "expected": 500 + } + ] + } + } +} diff --git a/aws/dist/botocore/data/mediapackage-vod/2018-11-07/paginators-1.json b/aws/dist/botocore/data/mediapackage-vod/2018-11-07/paginators-1.json new file mode 100644 index 00000000..df498b9f --- /dev/null +++ b/aws/dist/botocore/data/mediapackage-vod/2018-11-07/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListAssets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Assets" + }, + "ListPackagingConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PackagingConfigurations" + }, + "ListPackagingGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PackagingGroups" + } + } +} diff --git a/aws/dist/botocore/data/mediapackage-vod/2018-11-07/service-2.json b/aws/dist/botocore/data/mediapackage-vod/2018-11-07/service-2.json new file mode 100644 index 00000000..b38e47db --- /dev/null +++ b/aws/dist/botocore/data/mediapackage-vod/2018-11-07/service-2.json @@ -0,0 +1,1668 @@ +{ + "documentation": "AWS Elemental MediaPackage VOD", + "metadata": { + "apiVersion": "2018-11-07", + "endpointPrefix": "mediapackage-vod", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "MediaPackage Vod", + "serviceFullName": "AWS Elemental MediaPackage VOD", + "serviceId": "MediaPackage Vod", + "signatureVersion": "v4", + "signingName": "mediapackage-vod", + "uid": "mediapackage-vod-2018-11-07" + }, + "operations": { + "CreateAsset": { + "documentation": "Creates a new MediaPackage VOD Asset resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/assets", + "responseCode": 200 + }, + "input": { + "shape": "CreateAssetRequest" + }, + "name": "CreateAsset", + "output": { + "documentation": "The new MediaPackage VOD Asset resource.", + "shape": "CreateAssetResponse" + } + }, + "CreatePackagingConfiguration": { + "documentation": "Creates a new MediaPackage VOD PackagingConfiguration resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/packaging_configurations", + "responseCode": 200 + }, + "input": { + "shape": "CreatePackagingConfigurationRequest" + }, + "name": "CreatePackagingConfiguration", + "output": { + "documentation": "The new MediaPackage VOD PackagingConfiguration resource.", + "shape": "CreatePackagingConfigurationResponse" + } + }, + "CreatePackagingGroup": { + "documentation": "Creates a new MediaPackage VOD PackagingGroup resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/packaging_groups", + "responseCode": 200 + }, + "input": { + "shape": "CreatePackagingGroupRequest" + }, + "name": "CreatePackagingGroup", + "output": { + "documentation": "The new MediaPackage VOD PackagingGroup resource.", + "shape": "CreatePackagingGroupResponse" + } + }, + "DeleteAsset": { + "documentation": "Deletes an existing MediaPackage VOD Asset resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/assets/{id}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteAssetRequest" + }, + "name": "DeleteAsset", + "output": { + "documentation": "The MediaPackage VOD Asset resource has been deleted.", + "shape": "DeleteAssetResponse" + } + }, + "DeletePackagingConfiguration": { + "documentation": "Deletes a MediaPackage VOD PackagingConfiguration resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/packaging_configurations/{id}", + "responseCode": 202 + }, + "input": { + "shape": "DeletePackagingConfigurationRequest" + }, + "name": "DeletePackagingConfiguration", + "output": { + "documentation": "The MediaPackage VOD PackagingConfiguration resource has been deleted.", + "shape": "DeletePackagingConfigurationResponse" + } + }, + "DeletePackagingGroup": { + "documentation": "Deletes a MediaPackage VOD PackagingGroup resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/packaging_groups/{id}", + "responseCode": 202 + }, + "input": { + "shape": "DeletePackagingGroupRequest" + }, + "name": "DeletePackagingGroup", + "output": { + "documentation": "The MediaPackage VOD PackagingGroup resource has been deleted.", + "shape": "DeletePackagingGroupResponse" + } + }, + "DescribeAsset": { + "documentation": "Returns a description of a MediaPackage VOD Asset resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/assets/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeAssetRequest" + }, + "name": "DescribeAsset", + "output": { + "documentation": "A MediaPackage VOD Asset resource.", + "shape": "DescribeAssetResponse" + } + }, + "DescribePackagingConfiguration": { + "documentation": "Returns a description of a MediaPackage VOD PackagingConfiguration resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/packaging_configurations/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribePackagingConfigurationRequest" + }, + "name": "DescribePackagingConfiguration", + "output": { + "documentation": "A MediaPackage VOD PackagingConfiguration resource.", + "shape": "DescribePackagingConfigurationResponse" + } + }, + "DescribePackagingGroup": { + "documentation": "Returns a description of a MediaPackage VOD PackagingGroup resource.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/packaging_groups/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribePackagingGroupRequest" + }, + "name": "DescribePackagingGroup", + "output": { + "documentation": "A MediaPackage VOD PackagingGroup resource.", + "shape": "DescribePackagingGroupResponse" + } + }, + "ListAssets": { + "documentation": "Returns a collection of MediaPackage VOD Asset resources.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/assets", + "responseCode": 200 + }, + "input": { + "shape": "ListAssetsRequest" + }, + "name": "ListAssets", + "output": { + "documentation": "A collection of MediaPackage VOD Asset resources.", + "shape": "ListAssetsResponse" + } + }, + "ListPackagingConfigurations": { + "documentation": "Returns a collection of MediaPackage VOD PackagingConfiguration resources.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/packaging_configurations", + "responseCode": 200 + }, + "input": { + "shape": "ListPackagingConfigurationsRequest" + }, + "name": "ListPackagingConfigurations", + "output": { + "documentation": "A collection of MediaPackage VOD PackagingConfiguration resources.", + "shape": "ListPackagingConfigurationsResponse" + } + }, + "ListPackagingGroups": { + "documentation": "Returns a collection of MediaPackage VOD PackagingGroup resources.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/packaging_groups", + "responseCode": 200 + }, + "input": { + "shape": "ListPackagingGroupsRequest" + }, + "name": "ListPackagingGroups", + "output": { + "documentation": "A collection of MediaPackage VOD PackagingGroup resources.", + "shape": "ListPackagingGroupsResponse" + } + } + }, + "shapes": { + "AdMarkers": { + "enum": [ + "NONE", + "SCTE35_ENHANCED", + "PASSTHROUGH" + ], + "type": "string" + }, + "Asset": { + "documentation": "A MediaPackage VOD Asset resource.", + "members": { + "Arn": { + "documentation": "The ARN of the Asset.", + "locationName": "arn", + "shape": "__string" + }, + "EgressEndpoints": { + "documentation": "The list of egress endpoints available for the Asset.", + "locationName": "egressEndpoints", + "shape": "__listOfEgressEndpoint" + }, + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role_arn used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "type": "structure" + }, + "AssetCreateParameters": { + "documentation": "Parameters used to create a MediaPackage VOD Asset.", + "members": { + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role ARN used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "required": [ + "SourceArn", + "Id", + "PackagingGroupId", + "SourceRoleArn" + ], + "type": "structure" + }, + "AssetList": { + "documentation": "A collection of MediaPackage VOD Asset resources.", + "members": { + "Assets": { + "documentation": "A list of MediaPackage VOD Asset resources.", + "locationName": "assets", + "shape": "__listOfAssetShallow" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "AssetShallow": { + "documentation": "A MediaPackage VOD Asset resource.", + "members": { + "Arn": { + "documentation": "The ARN of the Asset.", + "locationName": "arn", + "shape": "__string" + }, + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role ARN used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "type": "structure" + }, + "CmafEncryption": { + "documentation": "A CMAF encryption configuration.", + "members": { + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "CmafPackage": { + "documentation": "A CMAF packaging configuration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "CmafEncryption" + }, + "HlsManifests": { + "documentation": "A list of HLS manifest configurations.", + "locationName": "hlsManifests", + "shape": "__listOfHlsManifest" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each fragment. Actual fragments will be\nrounded to the nearest multiple of the source fragment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + } + }, + "required": [ + "HlsManifests" + ], + "type": "structure" + }, + "CreateAssetRequest": { + "documentation": "A new MediaPackage VOD Asset configuration.", + "members": { + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role ARN used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "required": [ + "SourceArn", + "Id", + "PackagingGroupId", + "SourceRoleArn" + ], + "type": "structure" + }, + "CreateAssetResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the Asset.", + "locationName": "arn", + "shape": "__string" + }, + "EgressEndpoints": { + "documentation": "The list of egress endpoints available for the Asset.", + "locationName": "egressEndpoints", + "shape": "__listOfEgressEndpoint" + }, + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role_arn used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "type": "structure" + }, + "CreatePackagingConfigurationRequest": { + "documentation": "A new MediaPackage VOD PackagingConfiguration resource configuration.", + "members": { + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the PackagingConfiguration.", + "locationName": "id", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "PackagingGroupId": { + "documentation": "The ID of a PackagingGroup.", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "required": [ + "Id", + "PackagingGroupId" + ], + "type": "structure" + }, + "CreatePackagingConfigurationResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the PackagingConfiguration.", + "locationName": "arn", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the PackagingConfiguration.", + "locationName": "id", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "PackagingGroupId": { + "documentation": "The ID of a PackagingGroup.", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "type": "structure" + }, + "CreatePackagingGroupRequest": { + "documentation": "A new MediaPackage VOD PackagingGroup resource configuration.", + "members": { + "Id": { + "documentation": "The ID of the PackagingGroup.", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "CreatePackagingGroupResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the PackagingGroup.", + "locationName": "arn", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the PackagingGroup.", + "locationName": "id", + "shape": "__string" + } + }, + "type": "structure" + }, + "DashEncryption": { + "documentation": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", + "members": { + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "DashManifest": { + "documentation": "A DASH manifest configuration.", + "members": { + "ManifestName": { + "documentation": "An optional string to include in the name of the manifest.", + "locationName": "manifestName", + "shape": "__string" + }, + "MinBufferTimeSeconds": { + "documentation": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", + "locationName": "minBufferTimeSeconds", + "shape": "__integer" + }, + "Profile": { + "documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "locationName": "profile", + "shape": "Profile" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "DashPackage": { + "documentation": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", + "members": { + "DashManifests": { + "documentation": "A list of DASH manifest configurations.", + "locationName": "dashManifests", + "shape": "__listOfDashManifest" + }, + "Encryption": { + "locationName": "encryption", + "shape": "DashEncryption" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + } + }, + "required": [ + "DashManifests" + ], + "type": "structure" + }, + "DeleteAssetRequest": { + "members": { + "Id": { + "documentation": "The ID of the MediaPackage VOD Asset resource to delete.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DeleteAssetResponse": { + "members": {}, + "type": "structure" + }, + "DeletePackagingConfigurationRequest": { + "members": { + "Id": { + "documentation": "The ID of the MediaPackage VOD PackagingConfiguration resource to delete.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DeletePackagingConfigurationResponse": { + "members": {}, + "type": "structure" + }, + "DeletePackagingGroupRequest": { + "members": { + "Id": { + "documentation": "The ID of the MediaPackage VOD PackagingGroup resource to delete.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DeletePackagingGroupResponse": { + "members": {}, + "type": "structure" + }, + "DescribeAssetRequest": { + "members": { + "Id": { + "documentation": "The ID of an MediaPackage VOD Asset resource.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribeAssetResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the Asset.", + "locationName": "arn", + "shape": "__string" + }, + "EgressEndpoints": { + "documentation": "The list of egress endpoints available for the Asset.", + "locationName": "egressEndpoints", + "shape": "__listOfEgressEndpoint" + }, + "Id": { + "documentation": "The unique identifier for the Asset.", + "locationName": "id", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "The ID of the PackagingGroup for the Asset.", + "locationName": "packagingGroupId", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in SPEKE key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "SourceArn": { + "documentation": "ARN of the source object in S3.", + "locationName": "sourceArn", + "shape": "__string" + }, + "SourceRoleArn": { + "documentation": "The IAM role_arn used to access the source S3 bucket.", + "locationName": "sourceRoleArn", + "shape": "__string" + } + }, + "type": "structure" + }, + "DescribePackagingConfigurationRequest": { + "members": { + "Id": { + "documentation": "The ID of a MediaPackage VOD PackagingConfiguration resource.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribePackagingConfigurationResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the PackagingConfiguration.", + "locationName": "arn", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the PackagingConfiguration.", + "locationName": "id", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "PackagingGroupId": { + "documentation": "The ID of a PackagingGroup.", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "type": "structure" + }, + "DescribePackagingGroupRequest": { + "members": { + "Id": { + "documentation": "The ID of a MediaPackage VOD PackagingGroup resource.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribePackagingGroupResponse": { + "members": { + "Arn": { + "documentation": "The ARN of the PackagingGroup.", + "locationName": "arn", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the PackagingGroup.", + "locationName": "id", + "shape": "__string" + } + }, + "type": "structure" + }, + "EgressEndpoint": { + "documentation": "The endpoint URL used to access an Asset using one PackagingConfiguration.", + "members": { + "PackagingConfigurationId": { + "documentation": "The ID of the PackagingConfiguration being applied to the Asset.", + "locationName": "packagingConfigurationId", + "shape": "__string" + }, + "Url": { + "documentation": "The URL of the parent manifest for the repackaged Asset.", + "locationName": "url", + "shape": "__string" + } + }, + "type": "structure" + }, + "EncryptionMethod": { + "enum": [ + "AES_128", + "SAMPLE_AES" + ], + "type": "string" + }, + "ForbiddenException": { + "documentation": "The client is not authorized to access the requested resource.", + "error": { + "httpStatusCode": 403 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "HlsEncryption": { + "documentation": "An HTTP Live Streaming (HLS) encryption configuration.", + "members": { + "ConstantInitializationVector": { + "documentation": "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.\n", + "locationName": "constantInitializationVector", + "shape": "__string" + }, + "EncryptionMethod": { + "documentation": "The encryption method to use.", + "locationName": "encryptionMethod", + "shape": "EncryptionMethod" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "HlsManifest": { + "documentation": "An HTTP Live Streaming (HLS) manifest configuration.", + "members": { + "AdMarkers": { + "documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n", + "locationName": "adMarkers", + "shape": "AdMarkers" + }, + "IncludeIframeOnlyStream": { + "documentation": "When enabled, an I-Frame only stream will be included in the output.", + "locationName": "includeIframeOnlyStream", + "shape": "__boolean" + }, + "ManifestName": { + "documentation": "An optional string to include in the name of the manifest.", + "locationName": "manifestName", + "shape": "__string" + }, + "ProgramDateTimeIntervalSeconds": { + "documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.\n", + "locationName": "programDateTimeIntervalSeconds", + "shape": "__integer" + }, + "RepeatExtXKey": { + "documentation": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", + "locationName": "repeatExtXKey", + "shape": "__boolean" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "HlsPackage": { + "documentation": "An HTTP Live Streaming (HLS) packaging configuration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "HlsEncryption" + }, + "HlsManifests": { + "documentation": "A list of HLS manifest configurations.", + "locationName": "hlsManifests", + "shape": "__listOfHlsManifest" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each fragment. Actual fragments will be\nrounded to the nearest multiple of the source fragment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "UseAudioRenditionGroup": { + "documentation": "When enabled, audio streams will be placed in rendition groups in the output.", + "locationName": "useAudioRenditionGroup", + "shape": "__boolean" + } + }, + "required": [ + "HlsManifests" + ], + "type": "structure" + }, + "InternalServerErrorException": { + "documentation": "An unexpected error occurred.", + "error": { + "httpStatusCode": 500 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListAssetsRequest": { + "members": { + "MaxResults": { + "documentation": "Upper bound on number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "Returns Assets associated with the specified PackagingGroup.", + "location": "querystring", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListAssetsResponse": { + "members": { + "Assets": { + "documentation": "A list of MediaPackage VOD Asset resources.", + "locationName": "assets", + "shape": "__listOfAssetShallow" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListPackagingConfigurationsRequest": { + "members": { + "MaxResults": { + "documentation": "Upper bound on number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingGroupId": { + "documentation": "Returns MediaPackage VOD PackagingConfigurations associated with the specified PackagingGroup.", + "location": "querystring", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListPackagingConfigurationsResponse": { + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingConfigurations": { + "documentation": "A list of MediaPackage VOD PackagingConfiguration resources.", + "locationName": "packagingConfigurations", + "shape": "__listOfPackagingConfiguration" + } + }, + "type": "structure" + }, + "ListPackagingGroupsRequest": { + "members": { + "MaxResults": { + "documentation": "Upper bound on number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListPackagingGroupsResponse": { + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingGroups": { + "documentation": "A list of MediaPackage VOD PackagingGroup resources.", + "locationName": "packagingGroups", + "shape": "__listOfPackagingGroup" + } + }, + "type": "structure" + }, + "MaxResults": { + "max": 1000, + "min": 1, + "type": "integer" + }, + "MssEncryption": { + "documentation": "A Microsoft Smooth Streaming (MSS) encryption configuration.", + "members": { + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "MssManifest": { + "documentation": "A Microsoft Smooth Streaming (MSS) manifest configuration.", + "members": { + "ManifestName": { + "documentation": "An optional string to include in the name of the manifest.", + "locationName": "manifestName", + "shape": "__string" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "MssPackage": { + "documentation": "A Microsoft Smooth Streaming (MSS) PackagingConfiguration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "MssEncryption" + }, + "MssManifests": { + "documentation": "A list of MSS manifest configurations.", + "locationName": "mssManifests", + "shape": "__listOfMssManifest" + }, + "SegmentDurationSeconds": { + "documentation": "The duration (in seconds) of each segment.", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + } + }, + "required": [ + "MssManifests" + ], + "type": "structure" + }, + "NotFoundException": { + "documentation": "The requested resource does not exist.", + "error": { + "httpStatusCode": 404 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "PackagingConfiguration": { + "documentation": "A MediaPackage VOD PackagingConfiguration resource.", + "members": { + "Arn": { + "documentation": "The ARN of the PackagingConfiguration.", + "locationName": "arn", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the PackagingConfiguration.", + "locationName": "id", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "PackagingGroupId": { + "documentation": "The ID of a PackagingGroup.", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "type": "structure" + }, + "PackagingConfigurationCreateParameters": { + "documentation": "Parameters used to create a new MediaPackage VOD PackagingConfiguration resource.", + "members": { + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the PackagingConfiguration.", + "locationName": "id", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "PackagingGroupId": { + "documentation": "The ID of a PackagingGroup.", + "locationName": "packagingGroupId", + "shape": "__string" + } + }, + "required": [ + "Id", + "PackagingGroupId" + ], + "type": "structure" + }, + "PackagingConfigurationList": { + "documentation": "A collection of MediaPackage VOD PackagingConfiguration resources.", + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingConfigurations": { + "documentation": "A list of MediaPackage VOD PackagingConfiguration resources.", + "locationName": "packagingConfigurations", + "shape": "__listOfPackagingConfiguration" + } + }, + "type": "structure" + }, + "PackagingGroup": { + "documentation": "A MediaPackage VOD PackagingGroup resource.", + "members": { + "Arn": { + "documentation": "The ARN of the PackagingGroup.", + "locationName": "arn", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the PackagingGroup.", + "locationName": "id", + "shape": "__string" + } + }, + "type": "structure" + }, + "PackagingGroupCreateParameters": { + "documentation": "Parameters used to create a new MediaPackage VOD PackagingGroup resource.", + "members": { + "Id": { + "documentation": "The ID of the PackagingGroup.", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "PackagingGroupList": { + "documentation": "A collection of MediaPackage VOD PackagingGroup resources.", + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "PackagingGroups": { + "documentation": "A list of MediaPackage VOD PackagingGroup resources.", + "locationName": "packagingGroups", + "shape": "__listOfPackagingGroup" + } + }, + "type": "structure" + }, + "Profile": { + "enum": [ + "NONE", + "HBBTV_1_5" + ], + "type": "string" + }, + "ServiceUnavailableException": { + "documentation": "An unexpected error occurred.", + "error": { + "httpStatusCode": 503 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "SpekeKeyProvider": { + "documentation": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", + "members": { + "RoleArn": { + "documentation": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.\n", + "locationName": "roleArn", + "shape": "__string" + }, + "SystemIds": { + "documentation": "The system IDs to include in key requests.", + "locationName": "systemIds", + "shape": "__listOf__string" + }, + "Url": { + "documentation": "The URL of the external key provider service.", + "locationName": "url", + "shape": "__string" + } + }, + "required": [ + "SystemIds", + "Url", + "RoleArn" + ], + "type": "structure" + }, + "StreamOrder": { + "enum": [ + "ORIGINAL", + "VIDEO_BITRATE_ASCENDING", + "VIDEO_BITRATE_DESCENDING" + ], + "type": "string" + }, + "StreamSelection": { + "documentation": "A StreamSelection configuration.", + "members": { + "MaxVideoBitsPerSecond": { + "documentation": "The maximum video bitrate (bps) to include in output.", + "locationName": "maxVideoBitsPerSecond", + "shape": "__integer" + }, + "MinVideoBitsPerSecond": { + "documentation": "The minimum video bitrate (bps) to include in output.", + "locationName": "minVideoBitsPerSecond", + "shape": "__integer" + }, + "StreamOrder": { + "documentation": "A directive that determines the order of streams in the output.", + "locationName": "streamOrder", + "shape": "StreamOrder" + } + }, + "type": "structure" + }, + "TooManyRequestsException": { + "documentation": "The client has exceeded their resource or throttling limits.", + "error": { + "httpStatusCode": 429 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "UnprocessableEntityException": { + "documentation": "The parameters sent in the request are not valid.", + "error": { + "httpStatusCode": 422 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__listOfAssetShallow": { + "member": { + "shape": "AssetShallow" + }, + "type": "list" + }, + "__listOfDashManifest": { + "member": { + "shape": "DashManifest" + }, + "type": "list" + }, + "__listOfEgressEndpoint": { + "member": { + "shape": "EgressEndpoint" + }, + "type": "list" + }, + "__listOfHlsManifest": { + "member": { + "shape": "HlsManifest" + }, + "type": "list" + }, + "__listOfMssManifest": { + "member": { + "shape": "MssManifest" + }, + "type": "list" + }, + "__listOfPackagingConfiguration": { + "member": { + "shape": "PackagingConfiguration" + }, + "type": "list" + }, + "__listOfPackagingGroup": { + "member": { + "shape": "PackagingGroup" + }, + "type": "list" + }, + "__listOf__string": { + "member": { + "shape": "__string" + }, + "type": "list" + }, + "__long": { + "type": "long" + }, + "__string": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/aws/dist/botocore/data/mediapackage/2017-10-12/paginators-1.json b/aws/dist/botocore/data/mediapackage/2017-10-12/paginators-1.json new file mode 100644 index 00000000..24e44104 --- /dev/null +++ b/aws/dist/botocore/data/mediapackage/2017-10-12/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListChannels": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Channels" + }, + "ListOriginEndpoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OriginEndpoints" + }, + "ListHarvestJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "HarvestJobs" + } + } +} diff --git a/aws/dist/botocore/data/mediapackage/2017-10-12/service-2.json b/aws/dist/botocore/data/mediapackage/2017-10-12/service-2.json new file mode 100644 index 00000000..e8f590b1 --- /dev/null +++ b/aws/dist/botocore/data/mediapackage/2017-10-12/service-2.json @@ -0,0 +1,2757 @@ +{ + "documentation": "AWS Elemental MediaPackage", + "metadata": { + "apiVersion": "2017-10-12", + "endpointPrefix": "mediapackage", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "MediaPackage", + "serviceFullName": "AWS Elemental MediaPackage", + "serviceId": "MediaPackage", + "signatureVersion": "v4", + "signingName": "mediapackage", + "uid": "mediapackage-2017-10-12" + }, + "operations": { + "CreateChannel": { + "documentation": "Creates a new Channel.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/channels", + "responseCode": 200 + }, + "input": { + "shape": "CreateChannelRequest" + }, + "name": "CreateChannel", + "output": { + "documentation": "The new Channel record.", + "shape": "CreateChannelResponse" + } + }, + "CreateHarvestJob": { + "documentation": "Creates a new HarvestJob record.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/harvest_jobs", + "responseCode": 200 + }, + "input": { + "shape": "CreateHarvestJobRequest" + }, + "name": "CreateHarvestJob", + "output": { + "documentation": "A new HarvestJob record.", + "shape": "CreateHarvestJobResponse" + } + }, + "CreateOriginEndpoint": { + "documentation": "Creates a new OriginEndpoint record.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "POST", + "requestUri": "/origin_endpoints", + "responseCode": 200 + }, + "input": { + "shape": "CreateOriginEndpointRequest" + }, + "name": "CreateOriginEndpoint", + "output": { + "documentation": "A new OriginEndpoint record.", + "shape": "CreateOriginEndpointResponse" + } + }, + "DeleteChannel": { + "documentation": "Deletes an existing Channel.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/channels/{id}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteChannelRequest" + }, + "name": "DeleteChannel", + "output": { + "documentation": "The Channel has been deleted.", + "shape": "DeleteChannelResponse" + } + }, + "DeleteOriginEndpoint": { + "documentation": "Deletes an existing OriginEndpoint.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteOriginEndpointRequest" + }, + "name": "DeleteOriginEndpoint", + "output": { + "documentation": "The OriginEndpoint has been deleted.", + "shape": "DeleteOriginEndpointResponse" + } + }, + "DescribeChannel": { + "documentation": "Gets details about a Channel.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/channels/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeChannelRequest" + }, + "name": "DescribeChannel", + "output": { + "documentation": "A Channel record.", + "shape": "DescribeChannelResponse" + } + }, + "DescribeHarvestJob": { + "documentation": "Gets details about an existing HarvestJob.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/harvest_jobs/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeHarvestJobRequest" + }, + "name": "DescribeHarvestJob", + "output": { + "documentation": "An HarvestJob record.", + "shape": "DescribeHarvestJobResponse" + } + }, + "DescribeOriginEndpoint": { + "documentation": "Gets details about an existing OriginEndpoint.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeOriginEndpointRequest" + }, + "name": "DescribeOriginEndpoint", + "output": { + "documentation": "An OriginEndpoint record.", + "shape": "DescribeOriginEndpointResponse" + } + }, + "ListChannels": { + "documentation": "Returns a collection of Channels.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/channels", + "responseCode": 200 + }, + "input": { + "shape": "ListChannelsRequest" + }, + "name": "ListChannels", + "output": { + "documentation": "A collection of Channel records.", + "shape": "ListChannelsResponse" + } + }, + "ListHarvestJobs": { + "documentation": "Returns a collection of HarvestJob records.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/harvest_jobs", + "responseCode": 200 + }, + "input": { + "shape": "ListHarvestJobsRequest" + }, + "name": "ListHarvestJobs", + "output": { + "documentation": "A collection of HarvestJob records.", + "shape": "ListHarvestJobsResponse" + } + }, + "ListOriginEndpoints": { + "documentation": "Returns a collection of OriginEndpoint records.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "GET", + "requestUri": "/origin_endpoints", + "responseCode": 200 + }, + "input": { + "shape": "ListOriginEndpointsRequest" + }, + "name": "ListOriginEndpoints", + "output": { + "documentation": "A collection of OriginEndpoint records.", + "shape": "ListOriginEndpointsResponse" + } + }, + "ListTagsForResource": { + "errors": [], + "http": { + "method": "GET", + "requestUri": "/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "name": "ListTagsForResource", + "output": { + "documentation": "200 response", + "shape": "ListTagsForResourceResponse" + } + }, + "RotateChannelCredentials": { + "deprecated": true, + "deprecatedMessage": "This API is deprecated. Please use RotateIngestEndpointCredentials instead", + "documentation": "Changes the Channel's first IngestEndpoint's username and password. WARNING - This API is deprecated. Please use RotateIngestEndpointCredentials instead", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "PUT", + "requestUri": "/channels/{id}/credentials", + "responseCode": 200 + }, + "input": { + "shape": "RotateChannelCredentialsRequest" + }, + "name": "RotateChannelCredentials", + "output": { + "documentation": "The updated Channel record.", + "shape": "RotateChannelCredentialsResponse" + } + }, + "RotateIngestEndpointCredentials": { + "documentation": "Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "PUT", + "requestUri": "/channels/{id}/ingest_endpoints/{ingest_endpoint_id}/credentials", + "responseCode": 200 + }, + "input": { + "shape": "RotateIngestEndpointCredentialsRequest" + }, + "name": "RotateIngestEndpointCredentials", + "output": { + "documentation": "The updated Channel record.", + "shape": "RotateIngestEndpointCredentialsResponse" + } + }, + "TagResource": { + "errors": [], + "http": { + "method": "POST", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "name": "TagResource" + }, + "UntagResource": { + "errors": [], + "http": { + "method": "DELETE", + "requestUri": "/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "name": "UntagResource" + }, + "UpdateChannel": { + "documentation": "Updates an existing Channel.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "PUT", + "requestUri": "/channels/{id}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateChannelRequest" + }, + "name": "UpdateChannel", + "output": { + "documentation": "The updated Channel record.", + "shape": "UpdateChannelResponse" + } + }, + "UpdateOriginEndpoint": { + "documentation": "Updates an existing OriginEndpoint.", + "errors": [ + { + "shape": "UnprocessableEntityException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "http": { + "method": "PUT", + "requestUri": "/origin_endpoints/{id}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateOriginEndpointRequest" + }, + "name": "UpdateOriginEndpoint", + "output": { + "documentation": "An updated OriginEndpoint record.", + "shape": "UpdateOriginEndpointResponse" + } + } + }, + "shapes": { + "AdMarkers": { + "enum": [ + "NONE", + "SCTE35_ENHANCED", + "PASSTHROUGH" + ], + "type": "string" + }, + "AdTriggers": { + "documentation": "A list of SCTE-35 message types that are treated as ad markers in the output. If empty, no\nad markers are output. Specify multiple items to create ad markers for all of the included\nmessage types.\n", + "member": { + "shape": "__AdTriggersElement" + }, + "type": "list" + }, + "AdsOnDeliveryRestrictions": { + "documentation": "This setting allows the delivery restriction flags on SCTE-35 segmentation descriptors to\ndetermine whether a message signals an ad. Choosing \"NONE\" means no SCTE-35 messages become\nads. Choosing \"RESTRICTED\" means SCTE-35 messages of the types specified in AdTriggers that\ncontain delivery restrictions will be treated as ads. Choosing \"UNRESTRICTED\" means SCTE-35\nmessages of the types specified in AdTriggers that do not contain delivery restrictions will\nbe treated as ads. Choosing \"BOTH\" means all SCTE-35 messages of the types specified in\nAdTriggers will be treated as ads. Note that Splice Insert messages do not have these flags\nand are always treated as ads if specified in AdTriggers.\n", + "enum": [ + "NONE", + "RESTRICTED", + "UNRESTRICTED", + "BOTH" + ], + "type": "string" + }, + "Channel": { + "documentation": "A Channel resource configuration.", + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "ChannelCreateParameters": { + "documentation": "Configuration parameters for a new Channel.", + "members": { + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the Channel. The ID must be unique within the region and it\ncannot be changed after a Channel is created.\n", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "ChannelList": { + "documentation": "A collection of Channel records.", + "members": { + "Channels": { + "documentation": "A list of Channel records.", + "locationName": "channels", + "shape": "__listOfChannel" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ChannelUpdateParameters": { + "documentation": "Configuration parameters for updating an existing Channel.", + "members": { + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + } + }, + "type": "structure" + }, + "CmafEncryption": { + "documentation": "A Common Media Application Format (CMAF) encryption configuration.", + "members": { + "KeyRotationIntervalSeconds": { + "documentation": "Time (in seconds) between each encryption key rotation.", + "locationName": "keyRotationIntervalSeconds", + "shape": "__integer" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "CmafPackage": { + "documentation": "A Common Media Application Format (CMAF) packaging configuration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "CmafEncryption" + }, + "HlsManifests": { + "documentation": "A list of HLS manifest configurations", + "locationName": "hlsManifests", + "shape": "__listOfHlsManifest" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "SegmentPrefix": { + "documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", + "locationName": "segmentPrefix", + "shape": "__string" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "CmafPackageCreateOrUpdateParameters": { + "documentation": "A Common Media Application Format (CMAF) packaging configuration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "CmafEncryption" + }, + "HlsManifests": { + "documentation": "A list of HLS manifest configurations", + "locationName": "hlsManifests", + "shape": "__listOfHlsManifestCreateOrUpdateParameters" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "SegmentPrefix": { + "documentation": "An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the ChannelId.", + "locationName": "segmentPrefix", + "shape": "__string" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "CreateChannelRequest": { + "documentation": "A new Channel configuration.", + "members": { + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the Channel. The ID must be unique within the region and it\ncannot be changed after a Channel is created.\n", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "CreateChannelResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "CreateHarvestJobRequest": { + "documentation": "Configuration parameters used to create a new HarvestJob.", + "members": { + "EndTime": { + "documentation": "The end of the time-window which will be harvested\n", + "locationName": "endTime", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted\n", + "locationName": "id", + "shape": "__string" + }, + "OriginEndpointId": { + "documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.\n", + "locationName": "originEndpointId", + "shape": "__string" + }, + "S3Destination": { + "locationName": "s3Destination", + "shape": "S3Destination" + }, + "StartTime": { + "documentation": "The start of the time-window which will be harvested\n", + "locationName": "startTime", + "shape": "__string" + } + }, + "required": [ + "S3Destination", + "EndTime", + "OriginEndpointId", + "StartTime", + "Id" + ], + "type": "structure" + }, + "CreateHarvestJobResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.\n", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel that the HarvestJob will harvest from.\n", + "locationName": "channelId", + "shape": "__string" + }, + "CreatedAt": { + "documentation": "The time the HarvestJob was submitted\n", + "locationName": "createdAt", + "shape": "__string" + }, + "EndTime": { + "documentation": "The end of the time-window which will be harvested.\n", + "locationName": "endTime", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.\n", + "locationName": "id", + "shape": "__string" + }, + "OriginEndpointId": { + "documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.\n", + "locationName": "originEndpointId", + "shape": "__string" + }, + "S3Destination": { + "locationName": "s3Destination", + "shape": "S3Destination" + }, + "StartTime": { + "documentation": "The start of the time-window which will be harvested.\n", + "locationName": "startTime", + "shape": "__string" + }, + "Status": { + "documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.\n", + "locationName": "status", + "shape": "Status" + } + }, + "type": "structure" + }, + "CreateOriginEndpointRequest": { + "documentation": "Configuration parameters used to create a new OriginEndpoint.", + "members": { + "ChannelId": { + "documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.\n", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackageCreateOrUpdateParameters" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint. The ID must be unique within the region\nand it cannot be changed after the OriginEndpoint is created.\n", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string that will be used as the filename of the OriginEndpoint URL (defaults to \"index\").", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "required": [ + "Id", + "ChannelId" + ], + "type": "structure" + }, + "CreateOriginEndpointResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint.", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string appended to the end of the OriginEndpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Url": { + "documentation": "The URL of the packaged OriginEndpoint for consumption.", + "locationName": "url", + "shape": "__string" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "type": "structure" + }, + "DashEncryption": { + "documentation": "A Dynamic Adaptive Streaming over HTTP (DASH) encryption configuration.", + "members": { + "KeyRotationIntervalSeconds": { + "documentation": "Time (in seconds) between each encryption key rotation.", + "locationName": "keyRotationIntervalSeconds", + "shape": "__integer" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "DashPackage": { + "documentation": "A Dynamic Adaptive Streaming over HTTP (DASH) packaging configuration.", + "members": { + "AdTriggers": { + "locationName": "adTriggers", + "shape": "AdTriggers" + }, + "AdsOnDeliveryRestrictions": { + "locationName": "adsOnDeliveryRestrictions", + "shape": "AdsOnDeliveryRestrictions" + }, + "Encryption": { + "locationName": "encryption", + "shape": "DashEncryption" + }, + "ManifestLayout": { + "documentation": "Determines the position of some tags in the Media Presentation Description (MPD). When set to FULL, elements like SegmentTemplate and ContentProtection are included in each Representation. When set to COMPACT, duplicate elements are combined and presented at the AdaptationSet level.", + "locationName": "manifestLayout", + "shape": "ManifestLayout" + }, + "ManifestWindowSeconds": { + "documentation": "Time window (in seconds) contained in each manifest.", + "locationName": "manifestWindowSeconds", + "shape": "__integer" + }, + "MinBufferTimeSeconds": { + "documentation": "Minimum duration (in seconds) that a player will buffer media before starting the presentation.", + "locationName": "minBufferTimeSeconds", + "shape": "__integer" + }, + "MinUpdatePeriodSeconds": { + "documentation": "Minimum duration (in seconds) between potential changes to the Dynamic Adaptive Streaming over HTTP (DASH) Media Presentation Description (MPD).", + "locationName": "minUpdatePeriodSeconds", + "shape": "__integer" + }, + "PeriodTriggers": { + "documentation": "A list of triggers that controls when the outgoing Dynamic Adaptive Streaming over HTTP (DASH)\nMedia Presentation Description (MPD) will be partitioned into multiple periods. If empty, the content will not\nbe partitioned into more than one period. If the list contains \"ADS\", new periods will be created where\nthe Channel source contains SCTE-35 ad markers.\n", + "locationName": "periodTriggers", + "shape": "__listOf__PeriodTriggersElement" + }, + "Profile": { + "documentation": "The Dynamic Adaptive Streaming over HTTP (DASH) profile type. When set to \"HBBTV_1_5\", HbbTV 1.5 compliant output is enabled.", + "locationName": "profile", + "shape": "Profile" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each segment. Actual segments will be\nrounded to the nearest multiple of the source segment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "SegmentTemplateFormat": { + "documentation": "Determines the type of SegmentTemplate included in the Media Presentation Description (MPD). When set to NUMBER_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Number$ media URLs. When set to TIME_WITH_TIMELINE, a full timeline is presented in each SegmentTemplate, with $Time$ media URLs. When set to NUMBER_WITH_DURATION, only a duration is included in each SegmentTemplate, with $Number$ media URLs.", + "locationName": "segmentTemplateFormat", + "shape": "SegmentTemplateFormat" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + }, + "SuggestedPresentationDelaySeconds": { + "documentation": "Duration (in seconds) to delay live content before presentation.", + "locationName": "suggestedPresentationDelaySeconds", + "shape": "__integer" + } + }, + "type": "structure" + }, + "DeleteChannelRequest": { + "members": { + "Id": { + "documentation": "The ID of the Channel to delete.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DeleteChannelResponse": { + "members": {}, + "type": "structure" + }, + "DeleteOriginEndpointRequest": { + "members": { + "Id": { + "documentation": "The ID of the OriginEndpoint to delete.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DeleteOriginEndpointResponse": { + "members": {}, + "type": "structure" + }, + "DescribeChannelRequest": { + "members": { + "Id": { + "documentation": "The ID of a Channel.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribeChannelResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "DescribeHarvestJobRequest": { + "members": { + "Id": { + "documentation": "The ID of the HarvestJob.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribeHarvestJobResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.\n", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel that the HarvestJob will harvest from.\n", + "locationName": "channelId", + "shape": "__string" + }, + "CreatedAt": { + "documentation": "The time the HarvestJob was submitted\n", + "locationName": "createdAt", + "shape": "__string" + }, + "EndTime": { + "documentation": "The end of the time-window which will be harvested.\n", + "locationName": "endTime", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.\n", + "locationName": "id", + "shape": "__string" + }, + "OriginEndpointId": { + "documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.\n", + "locationName": "originEndpointId", + "shape": "__string" + }, + "S3Destination": { + "locationName": "s3Destination", + "shape": "S3Destination" + }, + "StartTime": { + "documentation": "The start of the time-window which will be harvested.\n", + "locationName": "startTime", + "shape": "__string" + }, + "Status": { + "documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.\n", + "locationName": "status", + "shape": "Status" + } + }, + "type": "structure" + }, + "DescribeOriginEndpointRequest": { + "members": { + "Id": { + "documentation": "The ID of the OriginEndpoint.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "DescribeOriginEndpointResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint.", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string appended to the end of the OriginEndpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Url": { + "documentation": "The URL of the packaged OriginEndpoint for consumption.", + "locationName": "url", + "shape": "__string" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "type": "structure" + }, + "EncryptionMethod": { + "enum": [ + "AES_128", + "SAMPLE_AES" + ], + "type": "string" + }, + "ForbiddenException": { + "documentation": "The client is not authorized to access the requested resource.", + "error": { + "httpStatusCode": 403 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "HarvestJob": { + "documentation": "A HarvestJob resource configuration", + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the HarvestJob.\n", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel that the HarvestJob will harvest from.\n", + "locationName": "channelId", + "shape": "__string" + }, + "CreatedAt": { + "documentation": "The time the HarvestJob was submitted\n", + "locationName": "createdAt", + "shape": "__string" + }, + "EndTime": { + "documentation": "The end of the time-window which will be harvested.\n", + "locationName": "endTime", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted.\n", + "locationName": "id", + "shape": "__string" + }, + "OriginEndpointId": { + "documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.\n", + "locationName": "originEndpointId", + "shape": "__string" + }, + "S3Destination": { + "locationName": "s3Destination", + "shape": "S3Destination" + }, + "StartTime": { + "documentation": "The start of the time-window which will be harvested.\n", + "locationName": "startTime", + "shape": "__string" + }, + "Status": { + "documentation": "The current status of the HarvestJob. Consider setting up a CloudWatch Event to listen for\nHarvestJobs as they succeed or fail. In the event of failure, the CloudWatch Event will\ninclude an explanation of why the HarvestJob failed.\n", + "locationName": "status", + "shape": "Status" + } + }, + "type": "structure" + }, + "HarvestJobCreateParameters": { + "documentation": "Configuration parameters for a new HarvestJob", + "members": { + "EndTime": { + "documentation": "The end of the time-window which will be harvested\n", + "locationName": "endTime", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the HarvestJob. The ID must be unique within the region\nand it cannot be changed after the HarvestJob is submitted\n", + "locationName": "id", + "shape": "__string" + }, + "OriginEndpointId": { + "documentation": "The ID of the OriginEndpoint that the HarvestJob will harvest from.\nThis cannot be changed after the HarvestJob is submitted.\n", + "locationName": "originEndpointId", + "shape": "__string" + }, + "S3Destination": { + "locationName": "s3Destination", + "shape": "S3Destination" + }, + "StartTime": { + "documentation": "The start of the time-window which will be harvested\n", + "locationName": "startTime", + "shape": "__string" + } + }, + "required": [ + "S3Destination", + "EndTime", + "OriginEndpointId", + "StartTime", + "Id" + ], + "type": "structure" + }, + "HarvestJobList": { + "documentation": "A collection of HarvestJob records.", + "members": { + "HarvestJobs": { + "documentation": "A list of HarvestJob records.", + "locationName": "harvestJobs", + "shape": "__listOfHarvestJob" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "HlsEncryption": { + "documentation": "An HTTP Live Streaming (HLS) encryption configuration.", + "members": { + "ConstantInitializationVector": { + "documentation": "A constant initialization vector for encryption (optional).\nWhen not specified the initialization vector will be periodically rotated.\n", + "locationName": "constantInitializationVector", + "shape": "__string" + }, + "EncryptionMethod": { + "documentation": "The encryption method to use.", + "locationName": "encryptionMethod", + "shape": "EncryptionMethod" + }, + "KeyRotationIntervalSeconds": { + "documentation": "Interval (in seconds) between each encryption key rotation.", + "locationName": "keyRotationIntervalSeconds", + "shape": "__integer" + }, + "RepeatExtXKey": { + "documentation": "When enabled, the EXT-X-KEY tag will be repeated in output manifests.", + "locationName": "repeatExtXKey", + "shape": "__boolean" + }, + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "HlsIngest": { + "documentation": "An HTTP Live Streaming (HLS) ingest resource configuration.", + "members": { + "IngestEndpoints": { + "documentation": "A list of endpoints to which the source stream should be sent.", + "locationName": "ingestEndpoints", + "shape": "__listOfIngestEndpoint" + } + }, + "type": "structure" + }, + "HlsManifest": { + "documentation": "A HTTP Live Streaming (HLS) manifest configuration.", + "members": { + "AdMarkers": { + "documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n", + "locationName": "adMarkers", + "shape": "AdMarkers" + }, + "Id": { + "documentation": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", + "locationName": "id", + "shape": "__string" + }, + "IncludeIframeOnlyStream": { + "documentation": "When enabled, an I-Frame only stream will be included in the output.", + "locationName": "includeIframeOnlyStream", + "shape": "__boolean" + }, + "ManifestName": { + "documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", + "locationName": "manifestName", + "shape": "__string" + }, + "PlaylistType": { + "documentation": "The HTTP Live Streaming (HLS) playlist type.\nWhen either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE\nentry will be included in the media playlist.\n", + "locationName": "playlistType", + "shape": "PlaylistType" + }, + "PlaylistWindowSeconds": { + "documentation": "Time window (in seconds) contained in each parent manifest.", + "locationName": "playlistWindowSeconds", + "shape": "__integer" + }, + "ProgramDateTimeIntervalSeconds": { + "documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.\n", + "locationName": "programDateTimeIntervalSeconds", + "shape": "__integer" + }, + "Url": { + "documentation": "The URL of the packaged OriginEndpoint for consumption.", + "locationName": "url", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "HlsManifestCreateOrUpdateParameters": { + "documentation": "A HTTP Live Streaming (HLS) manifest configuration.", + "members": { + "AdMarkers": { + "documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n", + "locationName": "adMarkers", + "shape": "AdMarkers" + }, + "AdTriggers": { + "locationName": "adTriggers", + "shape": "AdTriggers" + }, + "AdsOnDeliveryRestrictions": { + "locationName": "adsOnDeliveryRestrictions", + "shape": "AdsOnDeliveryRestrictions" + }, + "Id": { + "documentation": "The ID of the manifest. The ID must be unique within the OriginEndpoint and it cannot be changed after it is created.", + "locationName": "id", + "shape": "__string" + }, + "IncludeIframeOnlyStream": { + "documentation": "When enabled, an I-Frame only stream will be included in the output.", + "locationName": "includeIframeOnlyStream", + "shape": "__boolean" + }, + "ManifestName": { + "documentation": "An optional short string appended to the end of the OriginEndpoint URL. If not specified, defaults to the manifestName for the OriginEndpoint.", + "locationName": "manifestName", + "shape": "__string" + }, + "PlaylistType": { + "documentation": "The HTTP Live Streaming (HLS) playlist type.\nWhen either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE\nentry will be included in the media playlist.\n", + "locationName": "playlistType", + "shape": "PlaylistType" + }, + "PlaylistWindowSeconds": { + "documentation": "Time window (in seconds) contained in each parent manifest.", + "locationName": "playlistWindowSeconds", + "shape": "__integer" + }, + "ProgramDateTimeIntervalSeconds": { + "documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.\n", + "locationName": "programDateTimeIntervalSeconds", + "shape": "__integer" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "HlsPackage": { + "documentation": "An HTTP Live Streaming (HLS) packaging configuration.", + "members": { + "AdMarkers": { + "documentation": "This setting controls how ad markers are included in the packaged OriginEndpoint.\n\"NONE\" will omit all SCTE-35 ad markers from the output.\n\"PASSTHROUGH\" causes the manifest to contain a copy of the SCTE-35 ad\nmarkers (comments) taken directly from the input HTTP Live Streaming (HLS) manifest.\n\"SCTE35_ENHANCED\" generates ad markers and blackout tags based on SCTE-35\nmessages in the input source.\n", + "locationName": "adMarkers", + "shape": "AdMarkers" + }, + "AdTriggers": { + "locationName": "adTriggers", + "shape": "AdTriggers" + }, + "AdsOnDeliveryRestrictions": { + "locationName": "adsOnDeliveryRestrictions", + "shape": "AdsOnDeliveryRestrictions" + }, + "Encryption": { + "locationName": "encryption", + "shape": "HlsEncryption" + }, + "IncludeIframeOnlyStream": { + "documentation": "When enabled, an I-Frame only stream will be included in the output.", + "locationName": "includeIframeOnlyStream", + "shape": "__boolean" + }, + "PlaylistType": { + "documentation": "The HTTP Live Streaming (HLS) playlist type.\nWhen either \"EVENT\" or \"VOD\" is specified, a corresponding EXT-X-PLAYLIST-TYPE\nentry will be included in the media playlist.\n", + "locationName": "playlistType", + "shape": "PlaylistType" + }, + "PlaylistWindowSeconds": { + "documentation": "Time window (in seconds) contained in each parent manifest.", + "locationName": "playlistWindowSeconds", + "shape": "__integer" + }, + "ProgramDateTimeIntervalSeconds": { + "documentation": "The interval (in seconds) between each EXT-X-PROGRAM-DATE-TIME tag\ninserted into manifests. Additionally, when an interval is specified\nID3Timed Metadata messages will be generated every 5 seconds using the\ningest time of the content.\nIf the interval is not specified, or set to 0, then\nno EXT-X-PROGRAM-DATE-TIME tags will be inserted into manifests and no\nID3Timed Metadata messages will be generated. Note that irrespective\nof this parameter, if any ID3 Timed Metadata is found in HTTP Live Streaming (HLS) input,\nit will be passed through to HLS output.\n", + "locationName": "programDateTimeIntervalSeconds", + "shape": "__integer" + }, + "SegmentDurationSeconds": { + "documentation": "Duration (in seconds) of each fragment. Actual fragments will be\nrounded to the nearest multiple of the source fragment duration.\n", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + }, + "UseAudioRenditionGroup": { + "documentation": "When enabled, audio streams will be placed in rendition groups in the output.", + "locationName": "useAudioRenditionGroup", + "shape": "__boolean" + } + }, + "type": "structure" + }, + "IngestEndpoint": { + "documentation": "An endpoint for ingesting source content for a Channel.", + "members": { + "Id": { + "documentation": "The system generated unique identifier for the IngestEndpoint", + "locationName": "id", + "shape": "__string" + }, + "Password": { + "documentation": "The system generated password for ingest authentication.", + "locationName": "password", + "shape": "__string" + }, + "Url": { + "documentation": "The ingest URL to which the source stream should be sent.", + "locationName": "url", + "shape": "__string" + }, + "Username": { + "documentation": "The system generated username for ingest authentication.", + "locationName": "username", + "shape": "__string" + } + }, + "type": "structure" + }, + "InternalServerErrorException": { + "documentation": "An unexpected error occurred.", + "error": { + "httpStatusCode": 500 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListChannelsRequest": { + "members": { + "MaxResults": { + "documentation": "Upper bound on number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListChannelsResponse": { + "members": { + "Channels": { + "documentation": "A list of Channel records.", + "locationName": "channels", + "shape": "__listOfChannel" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListHarvestJobsRequest": { + "members": { + "IncludeChannelId": { + "documentation": "When specified, the request will return only HarvestJobs associated with the given Channel ID.", + "location": "querystring", + "locationName": "includeChannelId", + "shape": "__string" + }, + "IncludeStatus": { + "documentation": "When specified, the request will return only HarvestJobs in the given status.", + "location": "querystring", + "locationName": "includeStatus", + "shape": "__string" + }, + "MaxResults": { + "documentation": "The upper bound on the number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListHarvestJobsResponse": { + "members": { + "HarvestJobs": { + "documentation": "A list of HarvestJob records.", + "locationName": "harvestJobs", + "shape": "__listOfHarvestJob" + }, + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListOriginEndpointsRequest": { + "members": { + "ChannelId": { + "documentation": "When specified, the request will return only OriginEndpoints associated with the given Channel ID.", + "location": "querystring", + "locationName": "channelId", + "shape": "__string" + }, + "MaxResults": { + "documentation": "The upper bound on the number of records to return.", + "location": "querystring", + "locationName": "maxResults", + "shape": "MaxResults" + }, + "NextToken": { + "documentation": "A token used to resume pagination from the end of a previous request.", + "location": "querystring", + "locationName": "nextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListOriginEndpointsResponse": { + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "OriginEndpoints": { + "documentation": "A list of OriginEndpoint records.", + "locationName": "originEndpoints", + "shape": "__listOfOriginEndpoint" + } + }, + "type": "structure" + }, + "ListTagsForResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "ListTagsForResourceResponse": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "type": "structure" + }, + "ManifestLayout": { + "enum": [ + "FULL", + "COMPACT" + ], + "type": "string" + }, + "MaxResults": { + "max": 1000, + "min": 1, + "type": "integer" + }, + "MssEncryption": { + "documentation": "A Microsoft Smooth Streaming (MSS) encryption configuration.", + "members": { + "SpekeKeyProvider": { + "locationName": "spekeKeyProvider", + "shape": "SpekeKeyProvider" + } + }, + "required": [ + "SpekeKeyProvider" + ], + "type": "structure" + }, + "MssPackage": { + "documentation": "A Microsoft Smooth Streaming (MSS) packaging configuration.", + "members": { + "Encryption": { + "locationName": "encryption", + "shape": "MssEncryption" + }, + "ManifestWindowSeconds": { + "documentation": "The time window (in seconds) contained in each manifest.", + "locationName": "manifestWindowSeconds", + "shape": "__integer" + }, + "SegmentDurationSeconds": { + "documentation": "The duration (in seconds) of each segment.", + "locationName": "segmentDurationSeconds", + "shape": "__integer" + }, + "StreamSelection": { + "locationName": "streamSelection", + "shape": "StreamSelection" + } + }, + "type": "structure" + }, + "NotFoundException": { + "documentation": "The requested resource does not exist.", + "error": { + "httpStatusCode": 404 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "OriginEndpoint": { + "documentation": "An OriginEndpoint resource configuration.", + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint.", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string appended to the end of the OriginEndpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Url": { + "documentation": "The URL of the packaged OriginEndpoint for consumption.", + "locationName": "url", + "shape": "__string" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "type": "structure" + }, + "OriginEndpointCreateParameters": { + "documentation": "Configuration parameters for a new OriginEndpoint.", + "members": { + "ChannelId": { + "documentation": "The ID of the Channel that the OriginEndpoint will be associated with.\nThis cannot be changed after the OriginEndpoint is created.\n", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackageCreateOrUpdateParameters" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint. The ID must be unique within the region\nand it cannot be changed after the OriginEndpoint is created.\n", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string that will be used as the filename of the OriginEndpoint URL (defaults to \"index\").", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "required": [ + "Id", + "ChannelId" + ], + "type": "structure" + }, + "OriginEndpointList": { + "documentation": "A collection of OriginEndpoint records.", + "members": { + "NextToken": { + "documentation": "A token that can be used to resume pagination from the end of the collection.", + "locationName": "nextToken", + "shape": "__string" + }, + "OriginEndpoints": { + "documentation": "A list of OriginEndpoint records.", + "locationName": "originEndpoints", + "shape": "__listOfOriginEndpoint" + } + }, + "type": "structure" + }, + "OriginEndpointUpdateParameters": { + "documentation": "Configuration parameters for updating an existing OriginEndpoint.", + "members": { + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackageCreateOrUpdateParameters" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "ManifestName": { + "documentation": "A short string that will be appended to the end of the Endpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (in seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (in seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "type": "structure" + }, + "Origination": { + "enum": [ + "ALLOW", + "DENY" + ], + "type": "string" + }, + "PlaylistType": { + "enum": [ + "NONE", + "EVENT", + "VOD" + ], + "type": "string" + }, + "Profile": { + "enum": [ + "NONE", + "HBBTV_1_5" + ], + "type": "string" + }, + "RotateChannelCredentialsRequest": { + "deprecated": true, + "members": { + "Id": { + "documentation": "The ID of the channel to update.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "RotateChannelCredentialsResponse": { + "deprecated": true, + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "RotateIngestEndpointCredentialsRequest": { + "members": { + "Id": { + "documentation": "The ID of the channel the IngestEndpoint is on.", + "location": "uri", + "locationName": "id", + "shape": "__string" + }, + "IngestEndpointId": { + "documentation": "The id of the IngestEndpoint whose credentials should be rotated", + "location": "uri", + "locationName": "ingest_endpoint_id", + "shape": "__string" + } + }, + "required": [ + "IngestEndpointId", + "Id" + ], + "type": "structure" + }, + "RotateIngestEndpointCredentialsResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "S3Destination": { + "documentation": "Configuration parameters for where in an S3 bucket to place the harvested content\n", + "members": { + "BucketName": { + "documentation": "The name of an S3 bucket within which harvested content will be exported\n", + "locationName": "bucketName", + "shape": "__string" + }, + "ManifestKey": { + "documentation": "The key in the specified S3 bucket where the harvested top-level manifest will be placed.\n", + "locationName": "manifestKey", + "shape": "__string" + }, + "RoleArn": { + "documentation": "The IAM role used to write to the specified S3 bucket\n", + "locationName": "roleArn", + "shape": "__string" + } + }, + "required": [ + "ManifestKey", + "BucketName", + "RoleArn" + ], + "type": "structure" + }, + "SegmentTemplateFormat": { + "enum": [ + "NUMBER_WITH_TIMELINE", + "TIME_WITH_TIMELINE", + "NUMBER_WITH_DURATION" + ], + "type": "string" + }, + "ServiceUnavailableException": { + "documentation": "An unexpected error occurred.", + "error": { + "httpStatusCode": 503 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "SpekeKeyProvider": { + "documentation": "A configuration for accessing an external Secure Packager and Encoder Key Exchange (SPEKE) service that will provide encryption keys.", + "members": { + "CertificateArn": { + "documentation": "An Amazon Resource Name (ARN) of a Certificate Manager certificate\nthat MediaPackage will use for enforcing secure end-to-end data\ntransfer with the key provider service.\n", + "locationName": "certificateArn", + "shape": "__string" + }, + "ResourceId": { + "documentation": "The resource ID to include in key requests.", + "locationName": "resourceId", + "shape": "__string" + }, + "RoleArn": { + "documentation": "An Amazon Resource Name (ARN) of an IAM role that AWS Elemental\nMediaPackage will assume when accessing the key provider service.\n", + "locationName": "roleArn", + "shape": "__string" + }, + "SystemIds": { + "documentation": "The system IDs to include in key requests.", + "locationName": "systemIds", + "shape": "__listOf__string" + }, + "Url": { + "documentation": "The URL of the external key provider service.", + "locationName": "url", + "shape": "__string" + } + }, + "required": [ + "ResourceId", + "SystemIds", + "Url", + "RoleArn" + ], + "type": "structure" + }, + "Status": { + "enum": [ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ], + "type": "string" + }, + "StreamOrder": { + "enum": [ + "ORIGINAL", + "VIDEO_BITRATE_ASCENDING", + "VIDEO_BITRATE_DESCENDING" + ], + "type": "string" + }, + "StreamSelection": { + "documentation": "A StreamSelection configuration.", + "members": { + "MaxVideoBitsPerSecond": { + "documentation": "The maximum video bitrate (bps) to include in output.", + "locationName": "maxVideoBitsPerSecond", + "shape": "__integer" + }, + "MinVideoBitsPerSecond": { + "documentation": "The minimum video bitrate (bps) to include in output.", + "locationName": "minVideoBitsPerSecond", + "shape": "__integer" + }, + "StreamOrder": { + "documentation": "A directive that determines the order of streams in the output.", + "locationName": "streamOrder", + "shape": "StreamOrder" + } + }, + "type": "structure" + }, + "TagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + }, + "Tags": { + "documentation": "A collection of tags associated with a resource", + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, + "TagsModel": { + "members": { + "Tags": { + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "Tags" + ], + "type": "structure" + }, + "TooManyRequestsException": { + "documentation": "The client has exceeded their resource or throttling limits.", + "error": { + "httpStatusCode": 429 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "UnprocessableEntityException": { + "documentation": "The parameters sent in the request are not valid.", + "error": { + "httpStatusCode": 422 + }, + "exception": true, + "members": { + "Message": { + "locationName": "message", + "shape": "__string" + } + }, + "type": "structure" + }, + "UntagResourceRequest": { + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resource-arn", + "shape": "__string" + }, + "TagKeys": { + "documentation": "The key(s) of tag to be deleted", + "location": "querystring", + "locationName": "tagKeys", + "shape": "__listOf__string" + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ], + "type": "structure" + }, + "UpdateChannelRequest": { + "documentation": "Configuration parameters used to update the Channel.", + "members": { + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "Id": { + "documentation": "The ID of the Channel to update.", + "location": "uri", + "locationName": "id", + "shape": "__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "UpdateChannelResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the Channel.", + "locationName": "arn", + "shape": "__string" + }, + "Description": { + "documentation": "A short text description of the Channel.", + "locationName": "description", + "shape": "__string" + }, + "HlsIngest": { + "locationName": "hlsIngest", + "shape": "HlsIngest" + }, + "Id": { + "documentation": "The ID of the Channel.", + "locationName": "id", + "shape": "__string" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + } + }, + "type": "structure" + }, + "UpdateOriginEndpointRequest": { + "documentation": "Configuration parameters used to update an existing OriginEndpoint.", + "members": { + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackageCreateOrUpdateParameters" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint to update.", + "location": "uri", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string that will be appended to the end of the Endpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (in seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (in seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "required": [ + "Id" + ], + "type": "structure" + }, + "UpdateOriginEndpointResponse": { + "members": { + "Arn": { + "documentation": "The Amazon Resource Name (ARN) assigned to the OriginEndpoint.", + "locationName": "arn", + "shape": "__string" + }, + "ChannelId": { + "documentation": "The ID of the Channel the OriginEndpoint is associated with.", + "locationName": "channelId", + "shape": "__string" + }, + "CmafPackage": { + "locationName": "cmafPackage", + "shape": "CmafPackage" + }, + "DashPackage": { + "locationName": "dashPackage", + "shape": "DashPackage" + }, + "Description": { + "documentation": "A short text description of the OriginEndpoint.", + "locationName": "description", + "shape": "__string" + }, + "HlsPackage": { + "locationName": "hlsPackage", + "shape": "HlsPackage" + }, + "Id": { + "documentation": "The ID of the OriginEndpoint.", + "locationName": "id", + "shape": "__string" + }, + "ManifestName": { + "documentation": "A short string appended to the end of the OriginEndpoint URL.", + "locationName": "manifestName", + "shape": "__string" + }, + "MssPackage": { + "locationName": "mssPackage", + "shape": "MssPackage" + }, + "Origination": { + "documentation": "Control whether origination of video is allowed for this OriginEndpoint. If set to ALLOW, the OriginEndpoint\nmay by requested, pursuant to any other form of access control. If set to DENY, the OriginEndpoint may not be\nrequested. This can be helpful for Live to VOD harvesting, or for temporarily disabling origination\n", + "locationName": "origination", + "shape": "Origination" + }, + "StartoverWindowSeconds": { + "documentation": "Maximum duration (seconds) of content to retain for startover playback.\nIf not specified, startover playback will be disabled for the OriginEndpoint.\n", + "locationName": "startoverWindowSeconds", + "shape": "__integer" + }, + "Tags": { + "locationName": "tags", + "shape": "Tags" + }, + "TimeDelaySeconds": { + "documentation": "Amount of delay (seconds) to enforce on the playback of live content.\nIf not specified, there will be no time delay in effect for the OriginEndpoint.\n", + "locationName": "timeDelaySeconds", + "shape": "__integer" + }, + "Url": { + "documentation": "The URL of the packaged OriginEndpoint for consumption.", + "locationName": "url", + "shape": "__string" + }, + "Whitelist": { + "documentation": "A list of source IP CIDR blocks that will be allowed to access the OriginEndpoint.", + "locationName": "whitelist", + "shape": "__listOf__string" + } + }, + "type": "structure" + }, + "__AdTriggersElement": { + "enum": [ + "SPLICE_INSERT", + "BREAK", + "PROVIDER_ADVERTISEMENT", + "DISTRIBUTOR_ADVERTISEMENT", + "PROVIDER_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_PLACEMENT_OPPORTUNITY", + "PROVIDER_OVERLAY_PLACEMENT_OPPORTUNITY", + "DISTRIBUTOR_OVERLAY_PLACEMENT_OPPORTUNITY" + ], + "type": "string" + }, + "__PeriodTriggersElement": { + "enum": [ + "ADS" + ], + "type": "string" + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__listOfChannel": { + "member": { + "shape": "Channel" + }, + "type": "list" + }, + "__listOfHarvestJob": { + "member": { + "shape": "HarvestJob" + }, + "type": "list" + }, + "__listOfHlsManifest": { + "member": { + "shape": "HlsManifest" + }, + "type": "list" + }, + "__listOfHlsManifestCreateOrUpdateParameters": { + "member": { + "shape": "HlsManifestCreateOrUpdateParameters" + }, + "type": "list" + }, + "__listOfIngestEndpoint": { + "member": { + "shape": "IngestEndpoint" + }, + "type": "list" + }, + "__listOfOriginEndpoint": { + "member": { + "shape": "OriginEndpoint" + }, + "type": "list" + }, + "__listOf__PeriodTriggersElement": { + "member": { + "shape": "__PeriodTriggersElement" + }, + "type": "list" + }, + "__listOf__string": { + "member": { + "shape": "__string" + }, + "type": "list" + }, + "__long": { + "type": "long" + }, + "__mapOf__string": { + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/aws/dist/botocore/data/mediastore-data/2017-09-01/paginators-1.json b/aws/dist/botocore/data/mediastore-data/2017-09-01/paginators-1.json new file mode 100644 index 00000000..7b1c0f7e --- /dev/null +++ b/aws/dist/botocore/data/mediastore-data/2017-09-01/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListItems": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/aws/dist/botocore/data/mediastore-data/2017-09-01/service-2.json b/aws/dist/botocore/data/mediastore-data/2017-09-01/service-2.json new file mode 100644 index 00000000..960e523f --- /dev/null +++ b/aws/dist/botocore/data/mediastore-data/2017-09-01/service-2.json @@ -0,0 +1,480 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-01", + "endpointPrefix":"data.mediastore", + "protocol":"rest-json", + "serviceAbbreviation":"MediaStore Data", + "serviceFullName":"AWS Elemental MediaStore Data Plane", + "serviceId":"MediaStore Data", + "signatureVersion":"v4", + "signingName":"mediastore", + "uid":"mediastore-data-2017-09-01" + }, + "operations":{ + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"DELETE", + "requestUri":"/{Path+}" + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectResponse"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes an object at the specified path.

" + }, + "DescribeObject":{ + "name":"DescribeObject", + "http":{ + "method":"HEAD", + "requestUri":"/{Path+}" + }, + "input":{"shape":"DescribeObjectRequest"}, + "output":{"shape":"DescribeObjectResponse"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Gets the headers for an object at the specified path.

" + }, + "GetObject":{ + "name":"GetObject", + "http":{ + "method":"GET", + "requestUri":"/{Path+}" + }, + "input":{"shape":"GetObjectRequest"}, + "output":{"shape":"GetObjectResponse"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"ObjectNotFoundException"}, + {"shape":"RequestedRangeNotSatisfiableException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

" + }, + "ListItems":{ + "name":"ListItems", + "http":{ + "method":"GET", + "requestUri":"/" + }, + "input":{"shape":"ListItemsRequest"}, + "output":{"shape":"ListItemsResponse"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Provides a list of metadata entries about folders and objects in the specified folder.

" + }, + "PutObject":{ + "name":"PutObject", + "http":{ + "method":"PUT", + "requestUri":"/{Path+}" + }, + "input":{"shape":"PutObjectRequest"}, + "output":{"shape":"PutObjectResponse"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

", + "authtype":"v4-unsigned-body" + } + }, + "shapes":{ + "ContainerNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified container was not found for the specified account.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ContentRangePattern":{ + "type":"string", + "pattern":"^bytes=\\d+\\-\\d+/\\d+$" + }, + "ContentType":{ + "type":"string", + "pattern":"^[\\w\\-\\/\\.\\+]{1,255}$" + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"PathNaming", + "documentation":"

The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

", + "location":"uri", + "locationName":"Path" + } + } + }, + "DeleteObjectResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeObjectRequest":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"PathNaming", + "documentation":"

The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

", + "location":"uri", + "locationName":"Path" + } + } + }, + "DescribeObjectResponse":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"

The ETag that represents a unique instance of the object.

", + "location":"header", + "locationName":"ETag" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the object.

", + "location":"header", + "locationName":"Content-Type" + }, + "ContentLength":{ + "shape":"NonNegativeLong", + "documentation":"

The length of the object in bytes.

", + "location":"header", + "locationName":"Content-Length" + }, + "CacheControl":{ + "shape":"StringPrimitive", + "documentation":"

An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Headers with a custom user-defined value are also accepted.

", + "location":"header", + "locationName":"Cache-Control" + }, + "LastModified":{ + "shape":"TimeStamp", + "documentation":"

The date and time that the object was last modified.

", + "location":"header", + "locationName":"Last-Modified" + } + } + }, + "ETag":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[0-9A-Fa-f]+" + }, + "ErrorMessage":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[ \\w:\\.\\?-]+" + }, + "GetObjectRequest":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"PathNaming", + "documentation":"

The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

For example, to upload the file mlaw.avi to the folder path premium\\canada in the container movies, enter the path premium/canada/mlaw.avi.

Do not include the container name in this path.

If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

", + "location":"uri", + "locationName":"Path" + }, + "Range":{ + "shape":"RangePattern", + "documentation":"

The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.

", + "location":"header", + "locationName":"Range" + } + } + }, + "GetObjectResponse":{ + "type":"structure", + "required":["StatusCode"], + "members":{ + "Body":{ + "shape":"PayloadBlob", + "documentation":"

The bytes of the object.

" + }, + "CacheControl":{ + "shape":"StringPrimitive", + "documentation":"

An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Headers with a custom user-defined value are also accepted.

", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentRange":{ + "shape":"ContentRangePattern", + "documentation":"

The range of bytes to retrieve.

", + "location":"header", + "locationName":"Content-Range" + }, + "ContentLength":{ + "shape":"NonNegativeLong", + "documentation":"

The length of the object in bytes.

", + "location":"header", + "locationName":"Content-Length" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the object.

", + "location":"header", + "locationName":"Content-Type" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

The ETag that represents a unique instance of the object.

", + "location":"header", + "locationName":"ETag" + }, + "LastModified":{ + "shape":"TimeStamp", + "documentation":"

The date and time that the object was last modified.

", + "location":"header", + "locationName":"Last-Modified" + }, + "StatusCode":{ + "shape":"statusCode", + "documentation":"

The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.

", + "location":"statusCode" + } + }, + "payload":"Body" + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service is temporarily unavailable.

", + "exception":true, + "fault":true + }, + "Item":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ItemName", + "documentation":"

The name of the item.

" + }, + "Type":{ + "shape":"ItemType", + "documentation":"

The item type (folder or object).

" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

The ETag that represents a unique instance of the item.

" + }, + "LastModified":{ + "shape":"TimeStamp", + "documentation":"

The date and time that the item was last modified.

" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the item.

" + }, + "ContentLength":{ + "shape":"NonNegativeLong", + "documentation":"

The length of the item in bytes.

" + } + }, + "documentation":"

A metadata entry for a folder or object.

" + }, + "ItemList":{ + "type":"list", + "member":{"shape":"Item"} + }, + "ItemName":{ + "type":"string", + "pattern":"[A-Za-z0-9_\\.\\-\\~]+" + }, + "ItemType":{ + "type":"string", + "enum":[ + "OBJECT", + "FOLDER" + ] + }, + "ListItemsRequest":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"ListPathNaming", + "documentation":"

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

", + "location":"querystring", + "locationName":"Path" + }, + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListItemsResponse":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"

The metadata entries for the folders and objects at the requested path.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

" + } + } + }, + "ListLimit":{ + "type":"integer", + "max":1000, + "min":1 + }, + "ListPathNaming":{ + "type":"string", + "max":900, + "min":0, + "pattern":"/?(?:[A-Za-z0-9_\\.\\-\\~]+/){0,10}(?:[A-Za-z0-9_\\.\\-\\~]+)?/?" + }, + "NonNegativeLong":{ + "type":"long", + "min":0 + }, + "ObjectNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Could not perform an operation on an object that does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "PaginationToken":{"type":"string"}, + "PathNaming":{ + "type":"string", + "max":900, + "min":1, + "pattern":"(?:[A-Za-z0-9_\\.\\-\\~]+/){0,10}[A-Za-z0-9_\\.\\-\\~]+" + }, + "PayloadBlob":{ + "type":"blob", + "streaming":true + }, + "PutObjectRequest":{ + "type":"structure", + "required":[ + "Body", + "Path" + ], + "members":{ + "Body":{ + "shape":"PayloadBlob", + "documentation":"

The bytes to be stored.

" + }, + "Path":{ + "shape":"PathNaming", + "documentation":"

The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

For example, to upload the file mlaw.avi to the folder path premium\\canada in the container movies, enter the path premium/canada/mlaw.avi.

Do not include the container name in this path.

If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

", + "location":"uri", + "locationName":"Path" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

The content type of the object.

", + "location":"header", + "locationName":"Content-Type" + }, + "CacheControl":{ + "shape":"StringPrimitive", + "documentation":"

An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Headers with a custom user-defined value are also accepted.

", + "location":"header", + "locationName":"Cache-Control" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "UploadAvailability":{ + "shape":"UploadAvailability", + "documentation":"

Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

", + "location":"header", + "locationName":"x-amz-upload-availability" + } + }, + "payload":"Body" + }, + "PutObjectResponse":{ + "type":"structure", + "members":{ + "ContentSHA256":{ + "shape":"SHA256Hash", + "documentation":"

The SHA256 digest of the object that is persisted.

" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

Unique identifier of the object in the container.

" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

The storage class where the object was persisted. The class should be “Temporal”.

" + } + } + }, + "RangePattern":{ + "type":"string", + "pattern":"^bytes=(?:\\d+\\-\\d*|\\d*\\-\\d+)$" + }, + "RequestedRangeNotSatisfiableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The requested content range is not valid.

", + "error":{"httpStatusCode":416}, + "exception":true + }, + "SHA256Hash":{ + "type":"string", + "max":64, + "min":64, + "pattern":"[0-9A-Fa-f]{64}" + }, + "StorageClass":{ + "type":"string", + "enum":["TEMPORAL"], + "max":16, + "min":1 + }, + "StringPrimitive":{"type":"string"}, + "TimeStamp":{"type":"timestamp"}, + "UploadAvailability":{ + "type":"string", + "enum":[ + "STANDARD", + "STREAMING" + ], + "max":16, + "min":1 + }, + "statusCode":{"type":"integer"} + }, + "documentation":"

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.

" +} diff --git a/aws/dist/botocore/data/mediastore/2017-09-01/paginators-1.json b/aws/dist/botocore/data/mediastore/2017-09-01/paginators-1.json new file mode 100644 index 00000000..ed3ece02 --- /dev/null +++ b/aws/dist/botocore/data/mediastore/2017-09-01/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListContainers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Containers" + } + } +} diff --git a/aws/dist/botocore/data/mediastore/2017-09-01/service-2.json b/aws/dist/botocore/data/mediastore/2017-09-01/service-2.json new file mode 100644 index 00000000..af202889 --- /dev/null +++ b/aws/dist/botocore/data/mediastore/2017-09-01/service-2.json @@ -0,0 +1,902 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-09-01", + "endpointPrefix":"mediastore", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"MediaStore", + "serviceFullName":"AWS Elemental MediaStore", + "serviceId":"MediaStore", + "signatureVersion":"v4", + "signingName":"mediastore", + "targetPrefix":"MediaStore_20170901", + "uid":"mediastore-2017-09-01" + }, + "operations":{ + "CreateContainer":{ + "name":"CreateContainer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateContainerInput"}, + "output":{"shape":"CreateContainerOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.

" + }, + "DeleteContainer":{ + "name":"DeleteContainer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteContainerInput"}, + "output":{"shape":"DeleteContainerOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers.

" + }, + "DeleteContainerPolicy":{ + "name":"DeleteContainerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteContainerPolicyInput"}, + "output":{"shape":"DeleteContainerPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes the access policy that is associated with the specified container.

" + }, + "DeleteCorsPolicy":{ + "name":"DeleteCorsPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCorsPolicyInput"}, + "output":{"shape":"DeleteCorsPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"CorsPolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others.

" + }, + "DeleteLifecyclePolicy":{ + "name":"DeleteLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLifecyclePolicyInput"}, + "output":{"shape":"DeleteLifecyclePolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

" + }, + "DescribeContainer":{ + "name":"DescribeContainer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeContainerInput"}, + "output":{"shape":"DescribeContainerOutput"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

" + }, + "GetContainerPolicy":{ + "name":"GetContainerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContainerPolicyInput"}, + "output":{"shape":"GetContainerPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.

" + }, + "GetCorsPolicy":{ + "name":"GetCorsPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCorsPolicyInput"}, + "output":{"shape":"GetCorsPolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"CorsPolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others.

" + }, + "GetLifecyclePolicy":{ + "name":"GetLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLifecyclePolicyInput"}, + "output":{"shape":"GetLifecyclePolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Retrieves the object lifecycle policy that is assigned to a container.

" + }, + "ListContainers":{ + "name":"ListContainers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListContainersInput"}, + "output":{"shape":"ListContainersOutput"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

Lists the properties of all containers in AWS Elemental MediaStore.

You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive.

See also DescribeContainer, which gets the properties of one container.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Returns a list of the tags assigned to the specified container.

" + }, + "PutContainerPolicy":{ + "name":"PutContainerPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutContainerPolicyInput"}, + "output":{"shape":"PutContainerPolicyOutput"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"ContainerInUseException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide.

For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy.

" + }, + "PutCorsPolicy":{ + "name":"PutCorsPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutCorsPolicyInput"}, + "output":{"shape":"PutCorsPolicyOutput"}, + "errors":[ + {"shape":"ContainerNotFoundException"}, + {"shape":"ContainerInUseException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

" + }, + "PutLifecyclePolicy":{ + "name":"PutLifecyclePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLifecyclePolicyInput"}, + "output":{"shape":"PutLifecyclePolicyOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect.

For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

" + }, + "StartAccessLogging":{ + "name":"StartAccessLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAccessLoggingInput"}, + "output":{"shape":"StartAccessLoggingOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.

" + }, + "StopAccessLogging":{ + "name":"StopAccessLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAccessLoggingInput"}, + "output":{"shape":"StopAccessLoggingOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"ContainerInUseException"}, + {"shape":"ContainerNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

Removes tags from the specified container. You can specify one or more tags to remove.

" + } + }, + "shapes":{ + "AllowedHeaders":{ + "type":"list", + "member":{"shape":"Header"}, + "max":100, + "min":0 + }, + "AllowedMethods":{ + "type":"list", + "member":{"shape":"MethodName"}, + "max":4, + "min":1 + }, + "AllowedOrigins":{ + "type":"list", + "member":{"shape":"Origin"}, + "max":100, + "min":1 + }, + "Container":{ + "type":"structure", + "members":{ + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.

" + }, + "CreationTime":{ + "shape":"TimeStamp", + "documentation":"

Unix timestamp.

" + }, + "ARN":{ + "shape":"ContainerARN", + "documentation":"

The Amazon Resource Name (ARN) of the container. The ARN has the following format:

arn:aws:<region>:<account that owns this container>:container/<name of container>

For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

" + }, + "Name":{ + "shape":"ContainerName", + "documentation":"

The name of the container.

" + }, + "Status":{ + "shape":"ContainerStatus", + "documentation":"

The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When the endpoint is available, the status changes to ACTIVE.

" + }, + "AccessLoggingEnabled":{ + "shape":"ContainerAccessLoggingEnabled", + "documentation":"

The state of access logging on the container. This value is false by default, indicating that AWS Elemental MediaStore does not send access logs to Amazon CloudWatch Logs. When you enable access logging on the container, MediaStore changes this value to true, indicating that the service delivers access logs for objects stored in that container to CloudWatch Logs.

" + } + }, + "documentation":"

This section describes operations that you can perform on an AWS Elemental MediaStore container.

" + }, + "ContainerARN":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"arn:aws:mediastore:[a-z]+-[a-z]+-\\d:\\d{12}:container/[\\w-]{1,255}" + }, + "ContainerAccessLoggingEnabled":{"type":"boolean"}, + "ContainerInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The container that you specified in the request already exists or is being updated.

", + "exception":true + }, + "ContainerList":{ + "type":"list", + "member":{"shape":"Container"} + }, + "ContainerListLimit":{ + "type":"integer", + "max":100, + "min":1 + }, + "ContainerName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\w-]+" + }, + "ContainerNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The container that you specified in the request does not exist.

", + "exception":true + }, + "ContainerPolicy":{ + "type":"string", + "max":8192, + "min":1, + "pattern":"[\\x00-\\x7F]+" + }, + "ContainerStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "CREATING", + "DELETING" + ], + "max":16, + "min":1 + }, + "CorsPolicy":{ + "type":"list", + "member":{"shape":"CorsRule"}, + "documentation":"

The CORS policy of the container.

", + "max":100, + "min":1 + }, + "CorsPolicyNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The CORS policy that you specified in the request does not exist.

", + "exception":true + }, + "CorsRule":{ + "type":"structure", + "required":[ + "AllowedOrigins", + "AllowedHeaders" + ], + "members":{ + "AllowedOrigins":{ + "shape":"AllowedOrigins", + "documentation":"

One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

Each CORS rule must have at least one AllowedOrigins element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.

" + }, + "AllowedMethods":{ + "shape":"AllowedMethods", + "documentation":"

Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.

Each CORS rule must contain at least one AllowedMethods and one AllowedOrigins element.

" + }, + "AllowedHeaders":{ + "shape":"AllowedHeaders", + "documentation":"

Specifies which headers are allowed in a preflight OPTIONS request through the Access-Control-Request-Headers header. Each header name that is specified in Access-Control-Request-Headers must have a corresponding entry in the rule. Only the headers that were requested are sent back.

This element can contain only one wildcard character (*).

" + }, + "MaxAgeSeconds":{ + "shape":"MaxAgeSeconds", + "documentation":"

The time in seconds that your browser caches the preflight response for the specified resource.

A CORS rule can have only one MaxAgeSeconds element.

" + }, + "ExposeHeaders":{ + "shape":"ExposeHeaders", + "documentation":"

One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

This element is optional for each rule.

" + } + }, + "documentation":"

A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.

" + }, + "CreateContainerInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name for the container. The name must be from 1 to 255 characters. Container names must be unique to your AWS account within a specific region. As an example, you could create a container named movies in every region, as long as you don’t have an existing container with that name.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of key:value pairs that you define. These values can be anything that you want. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

" + } + } + }, + "CreateContainerOutput":{ + "type":"structure", + "required":["Container"], + "members":{ + "Container":{ + "shape":"Container", + "documentation":"

ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:<region>:<account that owns this container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies

ContainerName: The container name as specified in the request.

CreationTime: Unix time stamp.

Status: The status of container creation or deletion. The status is one of the following: CREATING, ACTIVE, or DELETING. While the service is creating the container, the status is CREATING. When an endpoint is available, the status changes to ACTIVE.

The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using DescribeContainer or ListContainers.

" + } + } + }, + "DeleteContainerInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container to delete.

" + } + } + }, + "DeleteContainerOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteContainerPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that holds the policy.

" + } + } + }, + "DeleteContainerPolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteCorsPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container to remove the policy from.

" + } + } + }, + "DeleteCorsPolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteLifecyclePolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that holds the object lifecycle policy.

" + } + } + }, + "DeleteLifecyclePolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeContainerInput":{ + "type":"structure", + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container to query.

" + } + } + }, + "DescribeContainerOutput":{ + "type":"structure", + "members":{ + "Container":{ + "shape":"Container", + "documentation":"

The name of the queried container.

" + } + } + }, + "Endpoint":{ + "type":"string", + "max":255, + "min":1 + }, + "ErrorMessage":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[ \\w:\\.\\?-]+" + }, + "ExposeHeaders":{ + "type":"list", + "member":{"shape":"Header"}, + "max":100, + "min":0 + }, + "GetContainerPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container.

" + } + } + }, + "GetContainerPolicyOutput":{ + "type":"structure", + "required":["Policy"], + "members":{ + "Policy":{ + "shape":"ContainerPolicy", + "documentation":"

The contents of the access policy.

" + } + } + }, + "GetCorsPolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that the policy is assigned to.

" + } + } + }, + "GetCorsPolicyOutput":{ + "type":"structure", + "required":["CorsPolicy"], + "members":{ + "CorsPolicy":{ + "shape":"CorsPolicy", + "documentation":"

The CORS policy assigned to the container.

" + } + } + }, + "GetLifecyclePolicyInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that the object lifecycle policy is assigned to.

" + } + } + }, + "GetLifecyclePolicyOutput":{ + "type":"structure", + "required":["LifecyclePolicy"], + "members":{ + "LifecyclePolicy":{ + "shape":"LifecyclePolicy", + "documentation":"

The object lifecycle policy that is assigned to the container.

" + } + } + }, + "Header":{ + "type":"string", + "max":8192, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service is temporarily unavailable.

", + "exception":true, + "fault":true + }, + "LifecyclePolicy":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

A service limit has been exceeded.

", + "exception":true + }, + "ListContainersInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Only if you used MaxResults in the first command, enter the token (which was included in the previous response) to obtain the next set of containers. This token is included in a response only if there actually are more containers to list.

" + }, + "MaxResults":{ + "shape":"ContainerListLimit", + "documentation":"

Enter the maximum number of containers in the response. Use from 1 to 255 characters.

" + } + } + }, + "ListContainersOutput":{ + "type":"structure", + "required":["Containers"], + "members":{ + "Containers":{ + "shape":"ContainerList", + "documentation":"

The names of the containers.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

NextToken is the token to use in the next call to ListContainers. This token is returned only if you included the MaxResults tag in the original command, and only if there are still containers to return.

" + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ContainerARN", + "documentation":"

The Amazon Resource Name (ARN) for the container.

" + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

An array of key:value pairs that are assigned to the container.

" + } + } + }, + "MaxAgeSeconds":{ + "type":"integer", + "max":2147483647, + "min":0 + }, + "MethodName":{ + "type":"string", + "enum":[ + "PUT", + "GET", + "DELETE", + "HEAD" + ] + }, + "Origin":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[0-9A-Za-z=/+]+" + }, + "PolicyNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The policy that you specified in the request does not exist.

", + "exception":true + }, + "PutContainerPolicyInput":{ + "type":"structure", + "required":[ + "ContainerName", + "Policy" + ], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container.

" + }, + "Policy":{ + "shape":"ContainerPolicy", + "documentation":"

The contents of the policy, which includes the following:

  • One Version tag

  • One Statement tag that contains the standard tags for the policy.

" + } + } + }, + "PutContainerPolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "PutCorsPolicyInput":{ + "type":"structure", + "required":[ + "ContainerName", + "CorsPolicy" + ], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that you want to assign the CORS policy to.

" + }, + "CorsPolicy":{ + "shape":"CorsPolicy", + "documentation":"

The CORS policy to apply to the container.

" + } + } + }, + "PutCorsPolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "PutLifecyclePolicyInput":{ + "type":"structure", + "required":[ + "ContainerName", + "LifecyclePolicy" + ], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that you want to assign the object lifecycle policy to.

" + }, + "LifecyclePolicy":{ + "shape":"LifecyclePolicy", + "documentation":"

The object lifecycle policy to apply to the container.

" + } + } + }, + "PutLifecyclePolicyOutput":{ + "type":"structure", + "members":{ + } + }, + "StartAccessLoggingInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that you want to start access logging on.

" + } + } + }, + "StartAccessLoggingOutput":{ + "type":"structure", + "members":{ + } + }, + "StopAccessLoggingInput":{ + "type":"structure", + "required":["ContainerName"], + "members":{ + "ContainerName":{ + "shape":"ContainerName", + "documentation":"

The name of the container that you want to stop access logging on.

" + } + } + }, + "StopAccessLoggingOutput":{ + "type":"structure", + "members":{ + } + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

" + } + }, + "documentation":"

A collection of tags associated with a container. Each tag consists of a key:value pair, which can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "Resource", + "Tags" + ], + "members":{ + "Resource":{ + "shape":"ContainerARN", + "documentation":"

The Amazon Resource Name (ARN) for the container.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of key:value pairs that you want to add to the container. You need to specify only the tags that you want to add or update. For example, suppose a container already has two tags (customer:CompanyA and priority:High). You want to change the priority tag and also add a third tag (type:Contract). For TagResource, you specify the following tags: priority:Medium, type:Contract. The result is that your container has three tags: customer:CompanyA, priority:Medium, and type:Contract.

" + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TimeStamp":{"type":"timestamp"}, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "Resource", + "TagKeys" + ], + "members":{ + "Resource":{ + "shape":"ContainerARN", + "documentation":"

The Amazon Resource Name (ARN) for the container.

" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

A comma-separated list of keys for tags that you want to remove from the container. For example, if your container has two tags (customer:CompanyA and priority:High) and you want to remove one of the tags (priority:High), you specify the key for the tag that you want to remove (priority).

" + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"

An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.

" +} diff --git a/aws/dist/botocore/data/mediatailor/2018-04-23/paginators-1.json b/aws/dist/botocore/data/mediatailor/2018-04-23/paginators-1.json new file mode 100644 index 00000000..993b5eaf --- /dev/null +++ b/aws/dist/botocore/data/mediatailor/2018-04-23/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListPlaybackConfigurations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/aws/dist/botocore/data/mediatailor/2018-04-23/service-2.json b/aws/dist/botocore/data/mediatailor/2018-04-23/service-2.json new file mode 100644 index 00000000..a1820ba2 --- /dev/null +++ b/aws/dist/botocore/data/mediatailor/2018-04-23/service-2.json @@ -0,0 +1,616 @@ +{ + "documentation": "

Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.

Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).

", + "metadata": { + "apiVersion": "2018-04-23", + "endpointPrefix": "api.mediatailor", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "MediaTailor", + "serviceFullName": "AWS MediaTailor", + "serviceId": "MediaTailor", + "signatureVersion": "v4", + "signingName": "mediatailor", + "uid": "mediatailor-2018-04-23" + }, + "operations": { + "DeletePlaybackConfiguration": { + "documentation": "

Deletes the playback configuration for the specified name.

", + "errors": [], + "http": { + "method": "DELETE", + "requestUri": "/playbackConfiguration/{Name}", + "responseCode": 204 + }, + "input": { + "shape": "DeletePlaybackConfigurationRequest" + }, + "name": "DeletePlaybackConfiguration", + "output": { + "documentation": "

The request was successful and there is no content in the response.

", + "shape": "DeletePlaybackConfigurationResponse" + } + }, + "GetPlaybackConfiguration": { + "documentation": "

Returns the playback configuration for the specified name.

", + "errors": [], + "http": { + "method": "GET", + "requestUri": "/playbackConfiguration/{Name}", + "responseCode": 200 + }, + "input": { + "shape": "GetPlaybackConfigurationRequest" + }, + "name": "GetPlaybackConfiguration", + "output": { + "documentation": "

Success.

", + "shape": "GetPlaybackConfigurationResponse" + } + }, + "ListPlaybackConfigurations": { + "documentation": "

Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.

", + "errors": [], + "http": { + "method": "GET", + "requestUri": "/playbackConfigurations", + "responseCode": 200 + }, + "input": { + "shape": "ListPlaybackConfigurationsRequest" + }, + "name": "ListPlaybackConfigurations", + "output": { + "documentation": "

Success.

", + "shape": "ListPlaybackConfigurationsResponse" + } + }, + "ListTagsForResource": { + "documentation": "

Returns a list of the tags assigned to the specified playback configuration resource.

", + "errors": [ + { + "documentation": "

Invalid request parameters.

", + "shape": "BadRequestException" + } + ], + "http": { + "method": "GET", + "requestUri": "/tags/{ResourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "name": "ListTagsForResource", + "output": { + "documentation": "

Success.

", + "shape": "ListTagsForResourceResponse" + } + }, + "PutPlaybackConfiguration": { + "documentation": "

Adds a new playback configuration to AWS Elemental MediaTailor.

", + "errors": [], + "http": { + "method": "PUT", + "requestUri": "/playbackConfiguration", + "responseCode": 200 + }, + "input": { + "shape": "PutPlaybackConfigurationRequest" + }, + "name": "PutPlaybackConfiguration", + "output": { + "documentation": "

Success.

", + "shape": "PutPlaybackConfigurationResponse" + } + }, + "TagResource": { + "documentation": "

Adds tags to the specified playback configuration resource. You can specify one or more tags to add.

", + "errors": [ + { + "documentation": "

Invalid request parameters.

", + "shape": "BadRequestException" + } + ], + "http": { + "method": "POST", + "requestUri": "/tags/{ResourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "name": "TagResource" + }, + "UntagResource": { + "documentation": "

Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.

", + "errors": [ + { + "documentation": "

Invalid request parameters.

", + "shape": "BadRequestException" + } + ], + "http": { + "method": "DELETE", + "requestUri": "/tags/{ResourceArn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "name": "UntagResource" + } + }, + "shapes": { + "BadRequestException": { + "documentation": "

Invalid request parameters.

", + "error": { + "httpStatusCode": 400 + }, + "exception": true, + "members": { + "Message": { + "shape": "__string" + } + }, + "type": "structure" + }, + "CdnConfiguration": { + "documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

", + "members": { + "AdSegmentUrlPrefix": { + "documentation": "

A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.<region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.

", + "shape": "__string" + }, + "ContentSegmentUrlPrefix": { + "documentation": "

A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "DashConfiguration": { + "documentation": "

The configuration for DASH content.

", + "members": { + "ManifestEndpointPrefix": { + "documentation": "

The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.

", + "shape": "__string" + }, + "MpdLocation": { + "documentation": "

The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

", + "shape": "__string" + }, + "OriginManifestType": { + "documentation": "

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

", + "shape": "OriginManifestType" + } + }, + "type": "structure" + }, + "DashConfigurationForPut": { + "documentation": "

The configuration for DASH PUT operations.

", + "members": { + "MpdLocation": { + "documentation": "

The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.

", + "shape": "__string" + }, + "OriginManifestType": { + "documentation": "

The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.

", + "shape": "OriginManifestType" + } + }, + "type": "structure" + }, + "DeletePlaybackConfigurationRequest": { + "members": { + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "location": "uri", + "locationName": "Name", + "shape": "__string" + } + }, + "required": [ + "Name" + ], + "type": "structure" + }, + "DeletePlaybackConfigurationResponse": { + "members": {}, + "type": "structure" + }, + "Empty": { + "members": {}, + "type": "structure" + }, + "GetPlaybackConfigurationRequest": { + "members": { + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "location": "uri", + "locationName": "Name", + "shape": "__string" + } + }, + "required": [ + "Name" + ], + "type": "structure" + }, + "GetPlaybackConfigurationResponse": { + "members": { + "AdDecisionServerUrl": { + "documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

", + "shape": "__string" + }, + "CdnConfiguration": { + "documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

", + "shape": "CdnConfiguration" + }, + "DashConfiguration": { + "documentation": "

The configuration for DASH content.

", + "shape": "DashConfiguration" + }, + "HlsConfiguration": { + "documentation": "

The configuration for HLS content.

", + "shape": "HlsConfiguration" + }, + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "shape": "__string" + }, + "PlaybackConfigurationArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

", + "shape": "__string" + }, + "PlaybackEndpointPrefix": { + "documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

", + "shape": "__string" + }, + "SessionInitializationEndpointPrefix": { + "documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

", + "shape": "__string" + }, + "SlateAdUrl": { + "documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

", + "shape": "__string" + }, + "Tags": { + "documentation": "

The tags assigned to the playback configuration.

", + "locationName": "tags", + "shape": "__mapOf__string" + }, + "TranscodeProfileName": { + "documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

", + "shape": "__string" + }, + "VideoContentSourceUrl": { + "documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "HlsConfiguration": { + "documentation": "

The configuration for HLS content.

", + "members": { + "ManifestEndpointPrefix": { + "documentation": "

The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListPlaybackConfigurationsRequest": { + "members": { + "MaxResults": { + "documentation": "

Maximum number of records to return.

", + "location": "querystring", + "locationName": "MaxResults", + "shape": "__integerMin1Max100" + }, + "NextToken": { + "documentation": "

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "location": "querystring", + "locationName": "NextToken", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListPlaybackConfigurationsResponse": { + "members": { + "Items": { + "documentation": "

Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.

", + "shape": "__listOfPlaybackConfigurations" + }, + "NextToken": { + "documentation": "

Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "ListTagsForResourceRequest": { + "members": { + "ResourceArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

", + "location": "uri", + "locationName": "ResourceArn", + "shape": "__string" + } + }, + "required": [ + "ResourceArn" + ], + "type": "structure" + }, + "ListTagsForResourceResponse": { + "members": { + "Tags": { + "documentation": "

A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n

", + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "type": "structure" + }, + "OriginManifestType": { + "enum": [ + "SINGLE_PERIOD", + "MULTI_PERIOD" + ], + "type": "string" + }, + "PlaybackConfiguration": { + "documentation": "

The AWSMediaTailor configuration.

", + "members": { + "AdDecisionServerUrl": { + "documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

", + "shape": "__string" + }, + "CdnConfiguration": { + "documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

", + "shape": "CdnConfiguration" + }, + "DashConfiguration": { + "documentation": "

The configuration for DASH content.

", + "shape": "DashConfiguration" + }, + "HlsConfiguration": { + "documentation": "

The configuration for HLS content.

", + "shape": "HlsConfiguration" + }, + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "shape": "__string" + }, + "PlaybackConfigurationArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

", + "shape": "__string" + }, + "PlaybackEndpointPrefix": { + "documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

", + "shape": "__string" + }, + "SessionInitializationEndpointPrefix": { + "documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

", + "shape": "__string" + }, + "SlateAdUrl": { + "documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

", + "shape": "__string" + }, + "Tags": { + "documentation": "

The tags assigned to the playback configuration.

", + "locationName": "tags", + "shape": "__mapOf__string" + }, + "TranscodeProfileName": { + "documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

", + "shape": "__string" + }, + "VideoContentSourceUrl": { + "documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "PutPlaybackConfigurationRequest": { + "members": { + "AdDecisionServerUrl": { + "documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.

", + "shape": "__string" + }, + "CdnConfiguration": { + "documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

", + "shape": "CdnConfiguration" + }, + "DashConfiguration": { + "documentation": "

The configuration for DASH content.

", + "shape": "DashConfigurationForPut" + }, + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "shape": "__string" + }, + "SlateAdUrl": { + "documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

", + "shape": "__string" + }, + "Tags": { + "documentation": "

The tags to assign to the playback configuration.

", + "locationName": "tags", + "shape": "__mapOf__string" + }, + "TranscodeProfileName": { + "documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

", + "shape": "__string" + }, + "VideoContentSourceUrl": { + "documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "PutPlaybackConfigurationResponse": { + "members": { + "AdDecisionServerUrl": { + "documentation": "

The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.

", + "shape": "__string" + }, + "CdnConfiguration": { + "documentation": "

The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.

", + "shape": "CdnConfiguration" + }, + "DashConfiguration": { + "documentation": "

The configuration for DASH content.

", + "shape": "DashConfiguration" + }, + "HlsConfiguration": { + "documentation": "

The configuration for HLS content.

", + "shape": "HlsConfiguration" + }, + "Name": { + "documentation": "

The identifier for the playback configuration.

", + "shape": "__string" + }, + "PlaybackConfigurationArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration.

", + "shape": "__string" + }, + "PlaybackEndpointPrefix": { + "documentation": "

The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.

", + "shape": "__string" + }, + "SessionInitializationEndpointPrefix": { + "documentation": "

The URL that the player uses to initialize a session that uses client-side reporting.

", + "shape": "__string" + }, + "SlateAdUrl": { + "documentation": "

The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.

", + "shape": "__string" + }, + "Tags": { + "documentation": "

The tags assigned to the playback configuration.

", + "locationName": "tags", + "shape": "__mapOf__string" + }, + "TranscodeProfileName": { + "documentation": "

The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.

", + "shape": "__string" + }, + "VideoContentSourceUrl": { + "documentation": "

The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.

", + "shape": "__string" + } + }, + "type": "structure" + }, + "TagResourceRequest": { + "members": { + "ResourceArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

", + "location": "uri", + "locationName": "ResourceArn", + "shape": "__string" + }, + "Tags": { + "documentation": "

A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n

", + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "ResourceArn", + "Tags" + ], + "type": "structure" + }, + "TagsModel": { + "documentation": "

A set of tags assigned to a resource.

", + "members": { + "Tags": { + "documentation": "

A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n

", + "locationName": "tags", + "shape": "__mapOf__string" + } + }, + "required": [ + "Tags" + ], + "type": "structure" + }, + "UntagResourceRequest": { + "members": { + "ResourceArn": { + "documentation": "

The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.

", + "location": "uri", + "locationName": "ResourceArn", + "shape": "__string" + }, + "TagKeys": { + "documentation": "

A comma-separated list of the tag keys to remove from the playback configuration.

", + "location": "querystring", + "locationName": "tagKeys", + "shape": "__listOf__string" + } + }, + "required": [ + "ResourceArn", + "TagKeys" + ], + "type": "structure" + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "__integerMin1Max100": { + "max": 100, + "min": 1, + "type": "integer" + }, + "__listOfPlaybackConfigurations": { + "member": { + "shape": "PlaybackConfiguration" + }, + "type": "list" + }, + "__listOf__string": { + "member": { + "shape": "__string" + }, + "type": "list" + }, + "__long": { + "type": "long" + }, + "__mapOf__string": { + "key": { + "shape": "__string" + }, + "type": "map", + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + }, + "__timestampIso8601": { + "timestampFormat": "iso8601", + "type": "timestamp" + }, + "__timestampUnix": { + "timestampFormat": "unixTimestamp", + "type": "timestamp" + } + } +} diff --git a/aws/dist/botocore/data/meteringmarketplace/2016-01-14/examples-1.json b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/meteringmarketplace/2016-01-14/paginators-1.json b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/meteringmarketplace/2016-01-14/service-2.json b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/service-2.json new file mode 100644 index 00000000..b74f8b39 --- /dev/null +++ b/aws/dist/botocore/data/meteringmarketplace/2016-01-14/service-2.json @@ -0,0 +1,445 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-01-14", + "endpointPrefix":"metering.marketplace", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWSMarketplace Metering", + "serviceId":"Marketplace Metering", + "signatureVersion":"v4", + "signingName":"aws-marketplace", + "targetPrefix":"AWSMPMeteringService", + "uid":"meteringmarketplace-2016-01-14" + }, + "operations":{ + "BatchMeterUsage":{ + "name":"BatchMeterUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchMeterUsageRequest"}, + "output":{"shape":"BatchMeterUsageResult"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidProductCodeException"}, + {"shape":"InvalidUsageDimensionException"}, + {"shape":"InvalidCustomerIdentifierException"}, + {"shape":"TimestampOutOfBoundsException"}, + {"shape":"ThrottlingException"}, + {"shape":"DisabledApiException"} + ], + "documentation":"

BatchMeterUsage is called from a SaaS application listed on the AWS Marketplace to post metering records for a set of customers.

For identical requests, the API is idempotent; requests can be retried with the same records or a subset of the input records.

Every request to BatchMeterUsage is for one product. If you need to meter usage for multiple products, you must make multiple calls to BatchMeterUsage.

BatchMeterUsage can process up to 25 UsageRecords at a time.

" + }, + "MeterUsage":{ + "name":"MeterUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MeterUsageRequest"}, + "output":{"shape":"MeterUsageResult"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidProductCodeException"}, + {"shape":"InvalidUsageDimensionException"}, + {"shape":"InvalidEndpointRegionException"}, + {"shape":"TimestampOutOfBoundsException"}, + {"shape":"DuplicateRequestException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

API to emit metering records. For identical requests, the API is idempotent. It simply returns the metering record ID.

MeterUsage is authenticated on the buyer's AWS account, generally when running from an EC2 instance on the AWS Marketplace.

" + }, + "RegisterUsage":{ + "name":"RegisterUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterUsageRequest"}, + "output":{"shape":"RegisterUsageResult"}, + "errors":[ + {"shape":"InvalidProductCodeException"}, + {"shape":"InvalidRegionException"}, + {"shape":"InvalidPublicKeyVersionException"}, + {"shape":"PlatformNotSupportedException"}, + {"shape":"CustomerNotEntitledException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"DisabledApiException"} + ], + "documentation":"

Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Calling RegisterUsage from containers running outside of ECS is not currently supported. Free and BYOL products for ECS aren't required to call RegisterUsage, but you may choose to do so if you would like to receive usage data in your seller reports. The sections below explain the behavior of RegisterUsage. RegisterUsage performs two primary functions: metering and entitlement.

  • Entitlement: RegisterUsage allows you to verify that the customer running your paid software is subscribed to your product on AWS Marketplace, enabling you to guard against unauthorized use. Your container image that integrates with RegisterUsage is only required to guard against unauthorized use at container startup, as such a CustomerNotSubscribedException/PlatformNotSupportedException will only be thrown on the initial call to RegisterUsage. Subsequent calls from the same Amazon ECS task instance (e.g. task-id) will not throw a CustomerNotSubscribedException, even if the customer unsubscribes while the Amazon ECS task is still running.

  • Metering: RegisterUsage meters software use per ECS task, per hour, with usage prorated to the second. A minimum of 1 minute of usage applies to tasks that are short lived. For example, if a customer has a 10 node ECS cluster and creates an ECS service configured as a Daemon Set, then ECS will launch a task on all 10 cluster nodes and the customer will be charged: (10 * hourly_rate). Metering for software use is automatically handled by the AWS Marketplace Metering Control Plane -- your software is not required to perform any metering specific actions, other than call RegisterUsage once for metering of software use to commence. The AWS Marketplace Metering Control Plane will also continue to bill customers for running ECS tasks, regardless of the customers subscription state, removing the need for your software to perform entitlement checks at runtime.

" + }, + "ResolveCustomer":{ + "name":"ResolveCustomer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveCustomerRequest"}, + "output":{"shape":"ResolveCustomerResult"}, + "errors":[ + {"shape":"InvalidTokenException"}, + {"shape":"ExpiredTokenException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"DisabledApiException"} + ], + "documentation":"

ResolveCustomer is called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a registration token through their browser. The registration token is resolved through this API to obtain a CustomerIdentifier and product code.

" + } + }, + "shapes":{ + "BatchMeterUsageRequest":{ + "type":"structure", + "required":[ + "UsageRecords", + "ProductCode" + ], + "members":{ + "UsageRecords":{ + "shape":"UsageRecordList", + "documentation":"

The set of UsageRecords to submit. BatchMeterUsage accepts up to 25 UsageRecords at a time.

" + }, + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

" + } + }, + "documentation":"

A BatchMeterUsageRequest contains UsageRecords, which indicate quantities of usage within your application.

" + }, + "BatchMeterUsageResult":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"UsageRecordResultList", + "documentation":"

Contains all UsageRecords processed by BatchMeterUsage. These records were either honored by AWS Marketplace Metering Service or were invalid.

" + }, + "UnprocessedRecords":{ + "shape":"UsageRecordList", + "documentation":"

Contains all UsageRecords that were not processed by BatchMeterUsage. This is a list of UsageRecords. You can retry the failed request by making another BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.

" + } + }, + "documentation":"

Contains the UsageRecords processed by BatchMeterUsage and any records that have failed due to transient error.

" + }, + "Boolean":{"type":"boolean"}, + "CustomerIdentifier":{ + "type":"string", + "max":255, + "min":1 + }, + "CustomerNotEntitledException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

Exception thrown when the customer does not have a valid subscription for the product.

", + "exception":true + }, + "DisabledApiException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The API is disabled in the Region.

", + "exception":true + }, + "DuplicateRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

A metering record has already been emitted by the same EC2 instance for the given {usageDimension, timestamp} with a different usageQuantity.

", + "exception":true + }, + "ExpiredTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The submitted registration token has expired. This can happen if the buyer's browser takes too long to redirect to your page, the buyer has resubmitted the registration token, or your application has held on to the registration token for too long. Your SaaS registration website should redeem this token as soon as it is submitted by the buyer's browser.

", + "exception":true + }, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

An internal error has occurred. Retry your request. If the problem persists, post a message with details on the AWS forums.

", + "exception":true, + "fault":true + }, + "InvalidCustomerIdentifierException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

You have metered usage for a CustomerIdentifier that does not exist.

", + "exception":true + }, + "InvalidEndpointRegionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The endpoint being called is in a Region different from your EC2 instance. The Region of the Metering Service endpoint and the Region of the EC2 instance must match.

", + "exception":true + }, + "InvalidProductCodeException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The product code passed does not match the product code used for publishing the product.

", + "exception":true + }, + "InvalidPublicKeyVersionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

Public Key version is invalid.

", + "exception":true + }, + "InvalidRegionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

RegisterUsage must be called in the same AWS Region the ECS task was launched in. This prevents a container from hardcoding a Region (e.g. withRegion(“us-east-1”) when calling RegisterUsage.

", + "exception":true + }, + "InvalidTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

Registration token is invalid.

", + "exception":true + }, + "InvalidUsageDimensionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The usage dimension does not match one of the UsageDimensions associated with products.

", + "exception":true + }, + "MeterUsageRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "Timestamp", + "UsageDimension" + ], + "members":{ + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

" + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Timestamp, in UTC, for which the usage is being reported. Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

" + }, + "UsageDimension":{ + "shape":"UsageDimension", + "documentation":"

It will be one of the fcp dimension name provided during the publishing of the product.

" + }, + "UsageQuantity":{ + "shape":"UsageQuantity", + "documentation":"

Consumption value for the hour. Defaults to 0 if not specified.

" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the permissions required for the action, but does not make the request. If you have the permissions, the request returns DryRunOperation; otherwise, it returns UnauthorizedException. Defaults to false if not specified.

" + } + } + }, + "MeterUsageResult":{ + "type":"structure", + "members":{ + "MeteringRecordId":{ + "shape":"String", + "documentation":"

Metering record id.

" + } + } + }, + "NonEmptyString":{ + "type":"string", + "pattern":"\\S+" + }, + "Nonce":{ + "type":"string", + "max":255 + }, + "PlatformNotSupportedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

AWS Marketplace does not support metering usage from the underlying platform. Currently, only Amazon ECS is supported.

", + "exception":true + }, + "ProductCode":{ + "type":"string", + "max":255, + "min":1 + }, + "RegisterUsageRequest":{ + "type":"structure", + "required":[ + "ProductCode", + "PublicKeyVersion" + ], + "members":{ + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

Product code is used to uniquely identify a product in AWS Marketplace. The product code should be the same as the one used during the publishing of a new product.

" + }, + "PublicKeyVersion":{ + "shape":"VersionInteger", + "documentation":"

Public Key Version provided by AWS Marketplace

" + }, + "Nonce":{ + "shape":"Nonce", + "documentation":"

(Optional) To scope down the registration to a specific running software instance and guard against replay attacks.

" + } + } + }, + "RegisterUsageResult":{ + "type":"structure", + "members":{ + "PublicKeyRotationTimestamp":{ + "shape":"Timestamp", + "documentation":"

(Optional) Only included when public key version has expired

" + }, + "Signature":{ + "shape":"NonEmptyString", + "documentation":"

JWT Token

" + } + } + }, + "ResolveCustomerRequest":{ + "type":"structure", + "required":["RegistrationToken"], + "members":{ + "RegistrationToken":{ + "shape":"NonEmptyString", + "documentation":"

When a buyer visits your website during the registration process, the buyer submits a registration token through the browser. The registration token is resolved to obtain a CustomerIdentifier and product code.

" + } + }, + "documentation":"

Contains input to the ResolveCustomer operation.

" + }, + "ResolveCustomerResult":{ + "type":"structure", + "members":{ + "CustomerIdentifier":{ + "shape":"CustomerIdentifier", + "documentation":"

The CustomerIdentifier is used to identify an individual customer in your application. Calls to BatchMeterUsage require CustomerIdentifiers for each UsageRecord.

" + }, + "ProductCode":{ + "shape":"ProductCode", + "documentation":"

The product code is returned to confirm that the buyer is registering for your product. Subsequent BatchMeterUsage calls should be made using this product code.

" + } + }, + "documentation":"

The result of the ResolveCustomer operation. Contains the CustomerIdentifier and product code.

" + }, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The calls to the API are throttled.

", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TimestampOutOfBoundsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

The timestamp value passed in the meterUsage() is out of allowed range.

", + "exception":true + }, + "UsageDimension":{ + "type":"string", + "max":255, + "min":1 + }, + "UsageQuantity":{ + "type":"integer", + "max":2147483647, + "min":0 + }, + "UsageRecord":{ + "type":"structure", + "required":[ + "Timestamp", + "CustomerIdentifier", + "Dimension" + ], + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

Timestamp, in UTC, for which the usage is being reported.

Your application can meter usage for up to one hour in the past. Make sure the timestamp value is not before the start of the software usage.

" + }, + "CustomerIdentifier":{ + "shape":"CustomerIdentifier", + "documentation":"

The CustomerIdentifier is obtained through the ResolveCustomer operation and represents an individual buyer in your application.

" + }, + "Dimension":{ + "shape":"UsageDimension", + "documentation":"

During the process of registering a product on AWS Marketplace, up to eight dimensions are specified. These represent different units of value in your application.

" + }, + "Quantity":{ + "shape":"UsageQuantity", + "documentation":"

The quantity of usage consumed by the customer for the given dimension and time. Defaults to 0 if not specified.

" + } + }, + "documentation":"

A UsageRecord indicates a quantity of usage for a given product, customer, dimension and time.

Multiple requests with the same UsageRecords as input will be deduplicated to prevent double charges.

" + }, + "UsageRecordList":{ + "type":"list", + "member":{"shape":"UsageRecord"}, + "max":25, + "min":0 + }, + "UsageRecordResult":{ + "type":"structure", + "members":{ + "UsageRecord":{ + "shape":"UsageRecord", + "documentation":"

The UsageRecord that was part of the BatchMeterUsage request.

" + }, + "MeteringRecordId":{ + "shape":"String", + "documentation":"

The MeteringRecordId is a unique identifier for this metering event.

" + }, + "Status":{ + "shape":"UsageRecordResultStatus", + "documentation":"

The UsageRecordResult Status indicates the status of an individual UsageRecord processed by BatchMeterUsage.

  • Success- The UsageRecord was accepted and honored by BatchMeterUsage.

  • CustomerNotSubscribed- The CustomerIdentifier specified is not subscribed to your product. The UsageRecord was not honored. Future UsageRecords for this customer will fail until the customer subscribes to your product.

  • DuplicateRecord- Indicates that the UsageRecord was invalid and not honored. A previously metered UsageRecord had the same customer, dimension, and time, but a different quantity.

" + } + }, + "documentation":"

A UsageRecordResult indicates the status of a given UsageRecord processed by BatchMeterUsage.

" + }, + "UsageRecordResultList":{ + "type":"list", + "member":{"shape":"UsageRecordResult"} + }, + "UsageRecordResultStatus":{ + "type":"string", + "enum":[ + "Success", + "CustomerNotSubscribed", + "DuplicateRecord" + ] + }, + "VersionInteger":{ + "type":"integer", + "min":1 + }, + "errorMessage":{"type":"string"} + }, + "documentation":"AWS Marketplace Metering Service

This reference provides descriptions of the low-level AWS Marketplace Metering Service API.

AWS Marketplace sellers can use this API to submit usage data for custom usage dimensions.

Submitting Metering Records

  • MeterUsage- Submits the metering record for a Marketplace product. MeterUsage is called from an EC2 instance.

  • BatchMeterUsage- Submits the metering record for a set of customers. BatchMeterUsage is called from a software-as-a-service (SaaS) application.

Accepting New Customers

  • ResolveCustomer- Called by a SaaS application during the registration process. When a buyer visits your website during the registration process, the buyer submits a Registration Token through the browser. The Registration Token is resolved through this API to obtain a CustomerIdentifier and Product Code.

Entitlement and Metering for Paid Container Products

  • Paid container software products sold through AWS Marketplace must integrate with the AWS Marketplace Metering Service and call the RegisterUsage operation for software entitlement and metering. Calling RegisterUsage from containers running outside of Amazon Elastic Container Service (Amazon ECR) isn't supported. Free and BYOL products for ECS aren't required to call RegisterUsage, but you can do so if you want to receive usage data in your seller reports. For more information on using the RegisterUsage operation, see Container-Based Products.

BatchMeterUsage API calls are captured by AWS CloudTrail. You can use Cloudtrail to verify that the SaaS metering records that you sent are accurate by searching for records with the eventName of BatchMeterUsage. You can also use CloudTrail to audit records over time. For more information, see the AWS CloudTrail User Guide .

" +} diff --git a/aws/dist/botocore/data/mgh/2017-05-31/paginators-1.json b/aws/dist/botocore/data/mgh/2017-05-31/paginators-1.json new file mode 100644 index 00000000..4a1efc37 --- /dev/null +++ b/aws/dist/botocore/data/mgh/2017-05-31/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListCreatedArtifacts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CreatedArtifactList" + }, + "ListDiscoveredResources": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DiscoveredResourceList" + }, + "ListMigrationTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "MigrationTaskSummaryList" + }, + "ListProgressUpdateStreams": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ProgressUpdateStreamSummaryList" + } + } +} diff --git a/aws/dist/botocore/data/mgh/2017-05-31/service-2.json b/aws/dist/botocore/data/mgh/2017-05-31/service-2.json new file mode 100644 index 00000000..68e2b5a2 --- /dev/null +++ b/aws/dist/botocore/data/mgh/2017-05-31/service-2.json @@ -0,0 +1,1123 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-05-31", + "endpointPrefix":"mgh", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Migration Hub", + "serviceId":"Migration Hub", + "signatureVersion":"v4", + "targetPrefix":"AWSMigrationHub", + "uid":"AWSMigrationHub-2017-05-31" + }, + "operations":{ + "AssociateCreatedArtifact":{ + "name":"AssociateCreatedArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateCreatedArtifactRequest"}, + "output":{"shape":"AssociateCreatedArtifactResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Associates a created artifact of an AWS cloud resource, the target receiving the migration, with the migration task performed by a migration tool. This API has the following traits:

  • Migration tools can call the AssociateCreatedArtifact operation to indicate which AWS artifact is associated with a migration task.

  • The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

  • Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or DMS endpoint, etc.

" + }, + "AssociateDiscoveredResource":{ + "name":"AssociateDiscoveredResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDiscoveredResourceRequest"}, + "output":{"shape":"AssociateDiscoveredResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Associates a discovered resource ID from Application Discovery Service (ADS) with a migration task.

" + }, + "CreateProgressUpdateStream":{ + "name":"CreateProgressUpdateStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProgressUpdateStreamRequest"}, + "output":{"shape":"CreateProgressUpdateStreamResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Creates a progress update stream which is an AWS resource used for access control as well as a namespace for migration task names that is implicitly linked to your AWS account. It must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

" + }, + "DeleteProgressUpdateStream":{ + "name":"DeleteProgressUpdateStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProgressUpdateStreamRequest"}, + "output":{"shape":"DeleteProgressUpdateStreamResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a progress update stream, including all of its tasks, which was previously created as an AWS resource used for access control. This API has the following traits:

  • The only parameter needed for DeleteProgressUpdateStream is the stream name (same as a CreateProgressUpdateStream call).

  • The call will return, and a background process will asynchronously delete the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).

  • If the stream takes time to be deleted, it might still show up on a ListProgressUpdateStreams call.

  • CreateProgressUpdateStream, ImportMigrationTask, NotifyMigrationTaskState, and all Associate[*] APIs realted to the tasks belonging to the stream will throw \"InvalidInputException\" if the stream of the same name is in the process of being deleted.

  • Once the stream and all of its resources are deleted, CreateProgressUpdateStream for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).

" + }, + "DescribeApplicationState":{ + "name":"DescribeApplicationState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeApplicationStateRequest"}, + "output":{"shape":"DescribeApplicationStateResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets the migration status of an application.

" + }, + "DescribeMigrationTask":{ + "name":"DescribeMigrationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMigrationTaskRequest"}, + "output":{"shape":"DescribeMigrationTaskResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Retrieves a list of all attributes associated with a specific migration task.

" + }, + "DisassociateCreatedArtifact":{ + "name":"DisassociateCreatedArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateCreatedArtifactRequest"}, + "output":{"shape":"DisassociateCreatedArtifactResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disassociates a created artifact of an AWS resource with a migration task performed by a migration tool that was previously associated. This API has the following traits:

  • A migration user can call the DisassociateCreatedArtifacts operation to disassociate a created AWS Artifact from a migration task.

  • The created artifact name must be provided in ARN (Amazon Resource Name) format which will contain information about type and region; for example: arn:aws:ec2:us-east-1:488216288981:image/ami-6d0ba87b.

  • Examples of the AWS resource behind the created artifact are, AMI's, EC2 instance, or RDS instance, etc.

" + }, + "DisassociateDiscoveredResource":{ + "name":"DisassociateDiscoveredResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDiscoveredResourceRequest"}, + "output":{"shape":"DisassociateDiscoveredResourceResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disassociate an Application Discovery Service (ADS) discovered resource from a migration task.

" + }, + "ImportMigrationTask":{ + "name":"ImportMigrationTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportMigrationTaskRequest"}, + "output":{"shape":"ImportMigrationTaskResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers a new migration task which represents a server, database, etc., being migrated to AWS by a migration tool.

This API is a prerequisite to calling the NotifyMigrationTaskState API as the migration tool must first register the migration task with Migration Hub.

" + }, + "ListCreatedArtifacts":{ + "name":"ListCreatedArtifacts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCreatedArtifactsRequest"}, + "output":{"shape":"ListCreatedArtifactsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists the created artifacts attached to a given migration task in an update stream. This API has the following traits:

  • Gets the list of the created artifacts while migration is taking place.

  • Shows the artifacts created by the migration tool that was associated by the AssociateCreatedArtifact API.

  • Lists created artifacts in a paginated interface.

" + }, + "ListDiscoveredResources":{ + "name":"ListDiscoveredResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDiscoveredResourcesRequest"}, + "output":{"shape":"ListDiscoveredResourcesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists discovered resources associated with the given MigrationTask.

" + }, + "ListMigrationTasks":{ + "name":"ListMigrationTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMigrationTasksRequest"}, + "output":{"shape":"ListMigrationTasksResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

  • Can show a summary list of the most recent migration tasks.

  • Can show a summary list of migration tasks associated with a given discovered resource.

  • Lists migration tasks in a paginated interface.

" + }, + "ListProgressUpdateStreams":{ + "name":"ListProgressUpdateStreams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProgressUpdateStreamsRequest"}, + "output":{"shape":"ListProgressUpdateStreamsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Lists progress update streams associated with the user account making this call.

" + }, + "NotifyApplicationState":{ + "name":"NotifyApplicationState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"NotifyApplicationStateRequest"}, + "output":{"shape":"NotifyApplicationStateResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Sets the migration state of an application. For a given application identified by the value passed to ApplicationId, its status is set or updated by passing one of three values to Status: NOT_STARTED | IN_PROGRESS | COMPLETED.

" + }, + "NotifyMigrationTaskState":{ + "name":"NotifyMigrationTaskState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"NotifyMigrationTaskStateRequest"}, + "output":{"shape":"NotifyMigrationTaskStateResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:

  • Migration tools will call the NotifyMigrationTaskState API to share the latest progress and status.

  • MigrationTaskName is used for addressing updates to the correct target.

  • ProgressUpdateStream is used for access control and to provide a namespace for each migration tool.

" + }, + "PutResourceAttributes":{ + "name":"PutResourceAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourceAttributesRequest"}, + "output":{"shape":"PutResourceAttributesResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DryRunOperation"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after PutResourceAttributes returns.

  • Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to add an IP address, it will then be required to call it with both the IP and MAC addresses to prevent overiding the MAC address.

  • Note the instructions regarding the special use case of the ResourceAttributeList parameter when specifying any \"VM\" related value.

Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call ListDiscoveredResources.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "exception":true + }, + "ApplicationId":{ + "type":"string", + "max":1600, + "min":1 + }, + "ApplicationStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETED" + ] + }, + "AssociateCreatedArtifactRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "CreatedArtifact" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "CreatedArtifact":{ + "shape":"CreatedArtifact", + "documentation":"

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "AssociateCreatedArtifactResult":{ + "type":"structure", + "members":{ + } + }, + "AssociateDiscoveredResourceRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "DiscoveredResource" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

The identifier given to the MigrationTask.

" + }, + "DiscoveredResource":{ + "shape":"DiscoveredResource", + "documentation":"

Object representing a Resource.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "AssociateDiscoveredResourceResult":{ + "type":"structure", + "members":{ + } + }, + "ConfigurationId":{ + "type":"string", + "min":1 + }, + "CreateProgressUpdateStreamRequest":{ + "type":"structure", + "required":["ProgressUpdateStreamName"], + "members":{ + "ProgressUpdateStreamName":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "CreateProgressUpdateStreamResult":{ + "type":"structure", + "members":{ + } + }, + "CreatedArtifact":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"CreatedArtifactName", + "documentation":"

An ARN that uniquely identifies the result of a migration task.

" + }, + "Description":{ + "shape":"CreatedArtifactDescription", + "documentation":"

A description that can be free-form text to record additional detail about the artifact for clarity or for later reference.

" + } + }, + "documentation":"

An ARN of the AWS cloud resource target receiving the migration (e.g., AMI, EC2 instance, RDS instance, etc.).

" + }, + "CreatedArtifactDescription":{ + "type":"string", + "max":500, + "min":0 + }, + "CreatedArtifactList":{ + "type":"list", + "member":{"shape":"CreatedArtifact"} + }, + "CreatedArtifactName":{ + "type":"string", + "max":1600, + "min":1, + "pattern":"arn:[a-z-]+:[a-z0-9-]+:(?:[a-z0-9-]+|):(?:[0-9]{12}|):.*" + }, + "DeleteProgressUpdateStreamRequest":{ + "type":"structure", + "required":["ProgressUpdateStreamName"], + "members":{ + "ProgressUpdateStreamName":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "DeleteProgressUpdateStreamResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeApplicationStateRequest":{ + "type":"structure", + "required":["ApplicationId"], + "members":{ + "ApplicationId":{ + "shape":"ApplicationId", + "documentation":"

The configurationId in ADS that uniquely identifies the grouped application.

" + } + } + }, + "DescribeApplicationStateResult":{ + "type":"structure", + "members":{ + "ApplicationStatus":{ + "shape":"ApplicationStatus", + "documentation":"

Status of the application - Not Started, In-Progress, Complete.

" + }, + "LastUpdatedTime":{ + "shape":"UpdateDateTime", + "documentation":"

The timestamp when the application status was last updated.

" + } + } + }, + "DescribeMigrationTaskRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

The identifier given to the MigrationTask.

" + } + } + }, + "DescribeMigrationTaskResult":{ + "type":"structure", + "members":{ + "MigrationTask":{ + "shape":"MigrationTask", + "documentation":"

Object encapsulating information about the migration task.

" + } + } + }, + "DisassociateCreatedArtifactRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "CreatedArtifactName" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task to be disassociated with the artifact.

" + }, + "CreatedArtifactName":{ + "shape":"CreatedArtifactName", + "documentation":"

An ARN of the AWS resource related to the migration (e.g., AMI, EC2 instance, RDS instance, etc.)

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "DisassociateCreatedArtifactResult":{ + "type":"structure", + "members":{ + } + }, + "DisassociateDiscoveredResourceRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "ConfigurationId" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

The identifier given to the MigrationTask.

" + }, + "ConfigurationId":{ + "shape":"ConfigurationId", + "documentation":"

ConfigurationId of the ADS resource to be disassociated.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "DisassociateDiscoveredResourceResult":{ + "type":"structure", + "members":{ + } + }, + "DiscoveredResource":{ + "type":"structure", + "required":["ConfigurationId"], + "members":{ + "ConfigurationId":{ + "shape":"ConfigurationId", + "documentation":"

The configurationId in ADS that uniquely identifies the on-premise resource.

" + }, + "Description":{ + "shape":"DiscoveredResourceDescription", + "documentation":"

A description that can be free-form text to record additional detail about the discovered resource for clarity or later reference.

" + } + }, + "documentation":"

Object representing the on-premises resource being migrated.

" + }, + "DiscoveredResourceDescription":{ + "type":"string", + "max":500, + "min":0 + }, + "DiscoveredResourceList":{ + "type":"list", + "member":{"shape":"DiscoveredResource"} + }, + "DryRun":{"type":"boolean"}, + "DryRunOperation":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised to indicate a successfully authorized action when the DryRun flag is set to \"true\".

", + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "ImportMigrationTaskRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "ImportMigrationTaskResult":{ + "type":"structure", + "members":{ + } + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised when there is an internal, configuration, or dependency error encountered.

", + "exception":true, + "fault":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised when the provided input violates a policy constraint or is entered in the wrong format or data type.

", + "exception":true + }, + "LatestResourceAttributeList":{ + "type":"list", + "member":{"shape":"ResourceAttribute"}, + "max":100, + "min":0 + }, + "ListCreatedArtifactsRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

" + }, + "MaxResults":{ + "shape":"MaxResultsCreatedArtifacts", + "documentation":"

Maximum number of results to be returned per page.

" + } + } + }, + "ListCreatedArtifactsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

If there are more created artifacts than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

" + }, + "CreatedArtifactList":{ + "shape":"CreatedArtifactList", + "documentation":"

List of created artifacts up to the maximum number of results specified in the request.

" + } + } + }, + "ListDiscoveredResourcesRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

The name of the MigrationTask.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

" + }, + "MaxResults":{ + "shape":"MaxResultsResources", + "documentation":"

The maximum number of results returned per page.

" + } + } + }, + "ListDiscoveredResourcesResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

If there are more discovered resources than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

" + }, + "DiscoveredResourceList":{ + "shape":"DiscoveredResourceList", + "documentation":"

Returned list of discovered resources associated with the given MigrationTask.

" + } + } + }, + "ListMigrationTasksRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Value to specify how many results are returned per page.

" + }, + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

Filter migration tasks by discovered resource name.

" + } + } + }, + "ListMigrationTasksResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

" + }, + "MigrationTaskSummaryList":{ + "shape":"MigrationTaskSummaryList", + "documentation":"

Lists the migration task's summary which includes: MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and the UpdateDateTime for each task.

" + } + } + }, + "ListProgressUpdateStreamsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Filter to limit the maximum number of results to list per page.

" + } + } + }, + "ListProgressUpdateStreamsResult":{ + "type":"structure", + "members":{ + "ProgressUpdateStreamSummaryList":{ + "shape":"ProgressUpdateStreamSummaryList", + "documentation":"

List of progress update streams up to the max number of results passed in the input.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

If there are more streams created than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsCreatedArtifacts":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "MaxResultsResources":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "MigrationTask":{ + "type":"structure", + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

A name that identifies the vendor of the migration tool being used.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "Task":{ + "shape":"Task", + "documentation":"

Task object encapsulating task information.

" + }, + "UpdateDateTime":{ + "shape":"UpdateDateTime", + "documentation":"

The timestamp when the task was gathered.

" + }, + "ResourceAttributeList":{ + "shape":"LatestResourceAttributeList", + "documentation":"

" + } + }, + "documentation":"

Represents a migration task in a migration tool.

" + }, + "MigrationTaskName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[^:|]+" + }, + "MigrationTaskSummary":{ + "type":"structure", + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

Status of the task.

" + }, + "ProgressPercent":{ + "shape":"ProgressPercent", + "documentation":"

" + }, + "StatusDetail":{ + "shape":"StatusDetail", + "documentation":"

Detail information of what is being done within the overall status state.

" + }, + "UpdateDateTime":{ + "shape":"UpdateDateTime", + "documentation":"

The timestamp when the task was gathered.

" + } + }, + "documentation":"

MigrationTaskSummary includes MigrationTaskName, ProgressPercent, ProgressUpdateStream, Status, and UpdateDateTime for each task.

" + }, + "MigrationTaskSummaryList":{ + "type":"list", + "member":{"shape":"MigrationTaskSummary"} + }, + "NextUpdateSeconds":{ + "type":"integer", + "min":0 + }, + "NotifyApplicationStateRequest":{ + "type":"structure", + "required":[ + "ApplicationId", + "Status" + ], + "members":{ + "ApplicationId":{ + "shape":"ApplicationId", + "documentation":"

The configurationId in ADS that uniquely identifies the grouped application.

" + }, + "Status":{ + "shape":"ApplicationStatus", + "documentation":"

Status of the application - Not Started, In-Progress, Complete.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "NotifyApplicationStateResult":{ + "type":"structure", + "members":{ + } + }, + "NotifyMigrationTaskStateRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "Task", + "UpdateDateTime", + "NextUpdateSeconds" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "Task":{ + "shape":"Task", + "documentation":"

Information about the task's progress and status.

" + }, + "UpdateDateTime":{ + "shape":"UpdateDateTime", + "documentation":"

The timestamp when the task was gathered.

" + }, + "NextUpdateSeconds":{ + "shape":"NextUpdateSeconds", + "documentation":"

Number of seconds after the UpdateDateTime within which the Migration Hub can expect an update. If Migration Hub does not receive an update within the specified interval, then the migration task will be considered stale.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "NotifyMigrationTaskStateResult":{ + "type":"structure", + "members":{ + } + }, + "PolicyErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the migrationhub-discovery role is missing or not configured correctly.

", + "exception":true + }, + "ProgressPercent":{ + "type":"integer", + "box":true, + "max":100, + "min":0 + }, + "ProgressUpdateStream":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[^/:|\\000-\\037]+" + }, + "ProgressUpdateStreamSummary":{ + "type":"structure", + "members":{ + "ProgressUpdateStreamName":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + } + }, + "documentation":"

Summary of the AWS resource used for access control that is implicitly linked to your AWS account.

" + }, + "ProgressUpdateStreamSummaryList":{ + "type":"list", + "member":{"shape":"ProgressUpdateStreamSummary"} + }, + "PutResourceAttributesRequest":{ + "type":"structure", + "required":[ + "ProgressUpdateStream", + "MigrationTaskName", + "ResourceAttributeList" + ], + "members":{ + "ProgressUpdateStream":{ + "shape":"ProgressUpdateStream", + "documentation":"

The name of the ProgressUpdateStream.

" + }, + "MigrationTaskName":{ + "shape":"MigrationTaskName", + "documentation":"

Unique identifier that references the migration task.

" + }, + "ResourceAttributeList":{ + "shape":"ResourceAttributeList", + "documentation":"

Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.

Takes the object array of ResourceAttribute where the Type field is reserved for the following values: IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER where the identifying value can be a string up to 256 characters.

  • If any \"VM\" related value is set for a ResourceAttribute object, it is required that VM_MANAGER_ID, as a minimum, is always set. If VM_MANAGER_ID is not set, then all \"VM\" fields will be discarded and \"VM\" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the Example section below for a use case of specifying \"VM\" related values.

  • If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the ResourceAttributeList parameter to maximize the chances of matching.

" + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

Optional boolean flag to indicate whether any effect should take place. Used to test if the caller has permission to make the call.

" + } + } + }, + "PutResourceAttributesResult":{ + "type":"structure", + "members":{ + } + }, + "ResourceAttribute":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"ResourceAttributeType", + "documentation":"

Type of resource.

" + }, + "Value":{ + "shape":"ResourceAttributeValue", + "documentation":"

Value of the resource type.

" + } + }, + "documentation":"

Attribute associated with a resource.

Note the corresponding format required per type listed below:

IPV4

x.x.x.x

where x is an integer in the range [0,255]

IPV6

y : y : y : y : y : y : y : y

where y is a hexadecimal between 0 and FFFF. [0, FFFF]

MAC_ADDRESS

^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$

FQDN

^[^<>{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$

" + }, + "ResourceAttributeList":{ + "type":"list", + "member":{"shape":"ResourceAttribute"}, + "max":100, + "min":1 + }, + "ResourceAttributeType":{ + "type":"string", + "enum":[ + "IPV4_ADDRESS", + "IPV6_ADDRESS", + "MAC_ADDRESS", + "FQDN", + "VM_MANAGER_ID", + "VM_MANAGED_OBJECT_REFERENCE", + "VM_NAME", + "VM_PATH", + "BIOS_ID", + "MOTHERBOARD_SERIAL_NUMBER" + ] + }, + "ResourceAttributeValue":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceName":{ + "type":"string", + "max":1600, + "min":1 + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised when the request references a resource (ADS configuration, update stream, migration task, etc.) that does not exist in ADS (Application Discovery Service) or in Migration Hub's repository.

", + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised when there is an internal, configuration, or dependency error encountered.

", + "exception":true, + "fault":true + }, + "Status":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "FAILED", + "COMPLETED" + ] + }, + "StatusDetail":{ + "type":"string", + "max":500, + "min":0 + }, + "Task":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

Status of the task - Not Started, In-Progress, Complete.

" + }, + "StatusDetail":{ + "shape":"StatusDetail", + "documentation":"

Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

" + }, + "ProgressPercent":{ + "shape":"ProgressPercent", + "documentation":"

Indication of the percentage completion of the task.

" + } + }, + "documentation":"

Task object encapsulating task information.

" + }, + "Token":{"type":"string"}, + "UnauthorizedOperation":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Exception raised to indicate a request was not authorized when the DryRun flag is set to \"true\".

", + "exception":true + }, + "UpdateDateTime":{"type":"timestamp"} + }, + "documentation":"

The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub.

" +} diff --git a/aws/dist/botocore/data/mobile/2017-07-01/paginators-1.json b/aws/dist/botocore/data/mobile/2017-07-01/paginators-1.json new file mode 100644 index 00000000..e86bb7d0 --- /dev/null +++ b/aws/dist/botocore/data/mobile/2017-07-01/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListBundles": { + "result_key": "bundleList", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + }, + "ListProjects": { + "result_key": "projects", + "output_token": "nextToken", + "input_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/aws/dist/botocore/data/mobile/2017-07-01/service-2.json b/aws/dist/botocore/data/mobile/2017-07-01/service-2.json new file mode 100644 index 00000000..b588798e --- /dev/null +++ b/aws/dist/botocore/data/mobile/2017-07-01/service-2.json @@ -0,0 +1,732 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-01", + "endpointPrefix":"mobile", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS Mobile", + "serviceId":"Mobile", + "signatureVersion":"v4", + "signingName":"AWSMobileHubService", + "uid":"mobile-2017-07-01" + }, + "operations":{ + "CreateProject":{ + "name":"CreateProject", + "http":{ + "method":"POST", + "requestUri":"/projects" + }, + "input":{"shape":"CreateProjectRequest"}, + "output":{"shape":"CreateProjectResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an AWS Mobile Hub project.

" + }, + "DeleteProject":{ + "name":"DeleteProject", + "http":{ + "method":"DELETE", + "requestUri":"/projects/{projectId}" + }, + "input":{"shape":"DeleteProjectRequest"}, + "output":{"shape":"DeleteProjectResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Delets a project in AWS Mobile Hub.

" + }, + "DescribeBundle":{ + "name":"DescribeBundle", + "http":{ + "method":"GET", + "requestUri":"/bundles/{bundleId}" + }, + "input":{"shape":"DescribeBundleRequest"}, + "output":{"shape":"DescribeBundleResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Get the bundle details for the requested bundle id.

" + }, + "DescribeProject":{ + "name":"DescribeProject", + "http":{ + "method":"GET", + "requestUri":"/project" + }, + "input":{"shape":"DescribeProjectRequest"}, + "output":{"shape":"DescribeProjectResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Gets details about a project in AWS Mobile Hub.

" + }, + "ExportBundle":{ + "name":"ExportBundle", + "http":{ + "method":"POST", + "requestUri":"/bundles/{bundleId}" + }, + "input":{"shape":"ExportBundleRequest"}, + "output":{"shape":"ExportBundleResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.

" + }, + "ExportProject":{ + "name":"ExportProject", + "http":{ + "method":"POST", + "requestUri":"/exports/{projectId}" + }, + "input":{"shape":"ExportProjectRequest"}, + "output":{"shape":"ExportProjectResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.

" + }, + "ListBundles":{ + "name":"ListBundles", + "http":{ + "method":"GET", + "requestUri":"/bundles" + }, + "input":{"shape":"ListBundlesRequest"}, + "output":{"shape":"ListBundlesResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

List all available bundles.

" + }, + "ListProjects":{ + "name":"ListProjects", + "http":{ + "method":"GET", + "requestUri":"/projects" + }, + "input":{"shape":"ListProjectsRequest"}, + "output":{"shape":"ListProjectsResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Lists projects in AWS Mobile Hub.

" + }, + "UpdateProject":{ + "name":"UpdateProject", + "http":{ + "method":"POST", + "requestUri":"/update" + }, + "input":{"shape":"UpdateProjectRequest"}, + "output":{"shape":"UpdateProjectResult"}, + "errors":[ + {"shape":"InternalFailureException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"AccountActionRequiredException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Update an existing project.

" + } + }, + "shapes":{ + "AccountActionRequiredException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Account Action is required in order to continue the request.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AttributeKey":{ + "type":"string", + "documentation":"

Key part of key-value attribute pairs.

" + }, + "AttributeValue":{ + "type":"string", + "documentation":"

Value part of key-value attribute pairs.

" + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttributeKey"}, + "value":{"shape":"AttributeValue"}, + "documentation":"

Key-value attribute pairs.

" + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request cannot be processed because some parameter is not valid or the project state prevents the operation from being performed.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BundleDescription":{ + "type":"string", + "documentation":"

Description of the download bundle.

" + }, + "BundleDetails":{ + "type":"structure", + "members":{ + "bundleId":{"shape":"BundleId"}, + "title":{"shape":"BundleTitle"}, + "version":{"shape":"BundleVersion"}, + "description":{"shape":"BundleDescription"}, + "iconUrl":{"shape":"IconUrl"}, + "availablePlatforms":{"shape":"Platforms"} + }, + "documentation":"

The details of the bundle.

" + }, + "BundleId":{ + "type":"string", + "documentation":"

Unique bundle identifier.

" + }, + "BundleList":{ + "type":"list", + "member":{"shape":"BundleDetails"}, + "documentation":"

A list of bundles.

" + }, + "BundleTitle":{ + "type":"string", + "documentation":"

Title of the download bundle.

" + }, + "BundleVersion":{ + "type":"string", + "documentation":"

Version of the download bundle.

" + }, + "ConsoleUrl":{"type":"string"}, + "Contents":{ + "type":"blob", + "documentation":"

Binary file data.

" + }, + "CreateProjectRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

Name of the project.

", + "location":"querystring", + "locationName":"name" + }, + "region":{ + "shape":"ProjectRegion", + "documentation":"

Default region where project resources should be created.

", + "location":"querystring", + "locationName":"region" + }, + "contents":{ + "shape":"Contents", + "documentation":"

ZIP or YAML file which contains configuration settings to be used when creating the project. This may be the contents of the file downloaded from the URL provided in an export project operation.

" + }, + "snapshotId":{ + "shape":"SnapshotId", + "documentation":"

Unique identifier for an exported snapshot of project configuration. This snapshot identifier is included in the share URL when a project is exported.

", + "location":"querystring", + "locationName":"snapshotId" + } + }, + "documentation":"

Request structure used to request a project be created.

", + "payload":"contents" + }, + "CreateProjectResult":{ + "type":"structure", + "members":{ + "details":{ + "shape":"ProjectDetails", + "documentation":"

Detailed information about the created AWS Mobile Hub project.

" + } + }, + "documentation":"

Result structure used in response to a request to create a project.

" + }, + "Date":{"type":"timestamp"}, + "DeleteProjectRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

", + "location":"uri", + "locationName":"projectId" + } + }, + "documentation":"

Request structure used to request a project be deleted.

" + }, + "DeleteProjectResult":{ + "type":"structure", + "members":{ + "deletedResources":{ + "shape":"Resources", + "documentation":"

Resources which were deleted.

" + }, + "orphanedResources":{ + "shape":"Resources", + "documentation":"

Resources which were not deleted, due to a risk of losing potentially important data or files.

" + } + }, + "documentation":"

Result structure used in response to request to delete a project.

" + }, + "DescribeBundleRequest":{ + "type":"structure", + "required":["bundleId"], + "members":{ + "bundleId":{ + "shape":"BundleId", + "documentation":"

Unique bundle identifier.

", + "location":"uri", + "locationName":"bundleId" + } + }, + "documentation":"

Request structure to request the details of a specific bundle.

" + }, + "DescribeBundleResult":{ + "type":"structure", + "members":{ + "details":{ + "shape":"BundleDetails", + "documentation":"

The details of the bundle.

" + } + }, + "documentation":"

Result structure contains the details of the bundle.

" + }, + "DescribeProjectRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

", + "location":"querystring", + "locationName":"projectId" + }, + "syncFromResources":{ + "shape":"Boolean", + "documentation":"

If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.

", + "location":"querystring", + "locationName":"syncFromResources" + } + }, + "documentation":"

Request structure used to request details about a project.

" + }, + "DescribeProjectResult":{ + "type":"structure", + "members":{ + "details":{"shape":"ProjectDetails"} + }, + "documentation":"

Result structure used for requests of project details.

" + }, + "DownloadUrl":{ + "type":"string", + "documentation":"

The download Url.

" + }, + "ErrorMessage":{ + "type":"string", + "documentation":"

The Exception Error Message.

" + }, + "ExportBundleRequest":{ + "type":"structure", + "required":["bundleId"], + "members":{ + "bundleId":{ + "shape":"BundleId", + "documentation":"

Unique bundle identifier.

", + "location":"uri", + "locationName":"bundleId" + }, + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

", + "location":"querystring", + "locationName":"projectId" + }, + "platform":{ + "shape":"Platform", + "documentation":"

Developer desktop or target application platform.

", + "location":"querystring", + "locationName":"platform" + } + }, + "documentation":"

Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources.

" + }, + "ExportBundleResult":{ + "type":"structure", + "members":{ + "downloadUrl":{ + "shape":"DownloadUrl", + "documentation":"

URL which contains the custom-generated SDK and tool packages used to integrate the client mobile app or web app with the AWS resources created by the AWS Mobile Hub project.

" + } + }, + "documentation":"

Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources.

" + }, + "ExportProjectRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

", + "location":"uri", + "locationName":"projectId" + } + }, + "documentation":"

Request structure used in requests to export project configuration details.

" + }, + "ExportProjectResult":{ + "type":"structure", + "members":{ + "downloadUrl":{ + "shape":"DownloadUrl", + "documentation":"

URL which can be used to download the exported project configuation file(s).

" + }, + "shareUrl":{ + "shape":"ShareUrl", + "documentation":"

URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

" + }, + "snapshotId":{ + "shape":"SnapshotId", + "documentation":"

Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

" + } + }, + "documentation":"

Result structure used for requests to export project configuration details.

" + }, + "Feature":{ + "type":"string", + "documentation":"

Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

" + }, + "IconUrl":{ + "type":"string", + "documentation":"

Icon for the download bundle.

" + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service has encountered an unexpected error condition which prevents it from servicing the request.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"ErrorMessage", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

There are too many AWS Mobile Hub projects in the account or the account has exceeded the maximum number of resources in some AWS service. You should create another sub-account using AWS Organizations or remove some resources and retry your request.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListBundlesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing bundles from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more bundles.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Request structure to request all available bundles.

" + }, + "ListBundlesResult":{ + "type":"structure", + "members":{ + "bundleList":{ + "shape":"BundleList", + "documentation":"

A list of bundles.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + } + }, + "documentation":"

Result structure contains a list of all available bundles with details.

" + }, + "ListProjectsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "documentation":"

Maximum number of records to list in a single response.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

Pagination token. Set to null to start listing projects from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more projects.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

Request structure used to request projects list in AWS Mobile Hub.

" + }, + "ListProjectsResult":{ + "type":"structure", + "members":{ + "projects":{"shape":"ProjectSummaries"}, + "nextToken":{"shape":"NextToken"} + }, + "documentation":"

Result structure used for requests to list projects in AWS Mobile Hub.

" + }, + "MaxResults":{ + "type":"integer", + "documentation":"

Maximum number of records to list in a single response.

" + }, + "NextToken":{ + "type":"string", + "documentation":"

Pagination token. Set to null to start listing records from start. If non-null pagination token is returned in a result, then pass its value in here in another request to list more entries.

" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

No entity can be found with the specified identifier.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Platform":{ + "type":"string", + "documentation":"

Developer desktop or target mobile app or website platform.

", + "enum":[ + "OSX", + "WINDOWS", + "LINUX", + "OBJC", + "SWIFT", + "ANDROID", + "JAVASCRIPT" + ] + }, + "Platforms":{ + "type":"list", + "member":{"shape":"Platform"}, + "documentation":"

Developer desktop or mobile app or website platforms.

" + }, + "ProjectDetails":{ + "type":"structure", + "members":{ + "name":{"shape":"ProjectName"}, + "projectId":{"shape":"ProjectId"}, + "region":{"shape":"ProjectRegion"}, + "state":{"shape":"ProjectState"}, + "createdDate":{ + "shape":"Date", + "documentation":"

Date the project was created.

" + }, + "lastUpdatedDate":{ + "shape":"Date", + "documentation":"

Date of the last modification of the project.

" + }, + "consoleUrl":{ + "shape":"ConsoleUrl", + "documentation":"

Website URL for this project in the AWS Mobile Hub console.

" + }, + "resources":{"shape":"Resources"} + }, + "documentation":"

Detailed information about an AWS Mobile Hub project.

" + }, + "ProjectId":{ + "type":"string", + "documentation":"

Unique project identifier.

" + }, + "ProjectName":{ + "type":"string", + "documentation":"

Name of the project.

" + }, + "ProjectRegion":{ + "type":"string", + "documentation":"

Default region to use for AWS resource creation in the AWS Mobile Hub project.

" + }, + "ProjectState":{ + "type":"string", + "documentation":"

Synchronization state for a project.

", + "enum":[ + "NORMAL", + "SYNCING", + "IMPORTING" + ] + }, + "ProjectSummaries":{ + "type":"list", + "member":{"shape":"ProjectSummary"}, + "documentation":"

List of projects.

" + }, + "ProjectSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ProjectName", + "documentation":"

Name of the project.

" + }, + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

" + } + }, + "documentation":"

Summary information about an AWS Mobile Hub project.

" + }, + "Resource":{ + "type":"structure", + "members":{ + "type":{"shape":"ResourceType"}, + "name":{"shape":"ResourceName"}, + "arn":{"shape":"ResourceArn"}, + "feature":{"shape":"Feature"}, + "attributes":{"shape":"Attributes"} + }, + "documentation":"

Information about an instance of an AWS resource associated with a project.

" + }, + "ResourceArn":{ + "type":"string", + "documentation":"

AWS resource name which uniquely identifies the resource in AWS systems.

" + }, + "ResourceName":{ + "type":"string", + "documentation":"

Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

" + }, + "ResourceType":{ + "type":"string", + "documentation":"

Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

" + }, + "Resources":{ + "type":"list", + "member":{"shape":"Resource"}, + "documentation":"

List of AWS resources associated with a project.

" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"ErrorMessage", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The service is temporarily unavailable. The request should be retried after some time delay.

", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "ShareUrl":{ + "type":"string", + "documentation":"

URL which can be shared to allow other AWS users to create their own project in AWS Mobile Hub with the same configuration as the specified project. This URL pertains to a snapshot in time of the project configuration that is created when this API is called. If you want to share additional changes to your project configuration, then you will need to create and share a new snapshot by calling this method again.

" + }, + "SnapshotId":{ + "type":"string", + "documentation":"

Unique identifier for the exported snapshot of the project configuration. This snapshot identifier is included in the share URL.

" + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "retryAfterSeconds":{ + "shape":"ErrorMessage", + "location":"header", + "locationName":"Retry-After" + }, + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Too many requests have been received for this AWS account in too short a time. The request should be retried after some time delay.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Credentials of the caller are insufficient to authorize the request.

", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UpdateProjectRequest":{ + "type":"structure", + "required":["projectId"], + "members":{ + "contents":{ + "shape":"Contents", + "documentation":"

ZIP or YAML file which contains project configuration to be updated. This should be the contents of the file downloaded from the URL provided in an export project operation.

" + }, + "projectId":{ + "shape":"ProjectId", + "documentation":"

Unique project identifier.

", + "location":"querystring", + "locationName":"projectId" + } + }, + "documentation":"

Request structure used for requests to update project configuration.

", + "payload":"contents" + }, + "UpdateProjectResult":{ + "type":"structure", + "members":{ + "details":{ + "shape":"ProjectDetails", + "documentation":"

Detailed information about the updated AWS Mobile Hub project.

" + } + }, + "documentation":"

Result structure used for requests to updated project configuration.

" + } + }, + "documentation":"

AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

" +} diff --git a/aws/dist/botocore/data/mq/2017-11-27/paginators-1.json b/aws/dist/botocore/data/mq/2017-11-27/paginators-1.json new file mode 100644 index 00000000..55160732 --- /dev/null +++ b/aws/dist/botocore/data/mq/2017-11-27/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListBrokers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BrokerSummaries" + } + } +} diff --git a/aws/dist/botocore/data/mq/2017-11-27/service-2.json b/aws/dist/botocore/data/mq/2017-11-27/service-2.json new file mode 100644 index 00000000..98259235 --- /dev/null +++ b/aws/dist/botocore/data/mq/2017-11-27/service-2.json @@ -0,0 +1,3065 @@ +{ + "metadata" : { + "apiVersion" : "2017-11-27", + "endpointPrefix" : "mq", + "signingName" : "mq", + "serviceFullName" : "AmazonMQ", + "serviceId" : "mq", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "mq-2017-11-27", + "signatureVersion" : "v4" + }, + "operations" : { + "CreateBroker" : { + "name" : "CreateBroker", + "http" : { + "method" : "POST", + "requestUri" : "/v1/brokers", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateBrokerRequest" + }, + "output" : { + "shape" : "CreateBrokerResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "UnauthorizedException", + "documentation" : "HTTP Status Code 401: Unauthorized request. The provided credentials couldn't be validated." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. This broker name already exists. Retry your request with another name." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Creates a broker. Note: This API is asynchronous." + }, + "CreateConfiguration" : { + "name" : "CreateConfiguration", + "http" : { + "method" : "POST", + "requestUri" : "/v1/configurations", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConfigurationRequest" + }, + "output" : { + "shape" : "CreateConfigurationResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. This configuration name already exists. Retry your request with another configuration name." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your input and then retry your request." + } ], + "documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)." + }, + "CreateTags" : { + "name" : "CreateTags", + "http" : { + "method" : "POST", + "requestUri" : "/v1/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "CreateTagsRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Add a tag to a resource." + }, + "CreateUser" : { + "name" : "CreateUser", + "http" : { + "method" : "POST", + "requestUri" : "/v1/brokers/{broker-id}/users/{username}", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateUserRequest" + }, + "output" : { + "shape" : "CreateUserResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Creates an ActiveMQ user." + }, + "DeleteBroker" : { + "name" : "DeleteBroker", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/brokers/{broker-id}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteBrokerRequest" + }, + "output" : { + "shape" : "DeleteBrokerResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Deletes a broker. Note: This API is asynchronous." + }, + "DeleteTags" : { + "name" : "DeleteTags", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/tags/{resource-arn}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteTagsRequest" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Removes a tag from a resource." + }, + "DeleteUser" : { + "name" : "DeleteUser", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/brokers/{broker-id}/users/{username}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteUserRequest" + }, + "output" : { + "shape" : "DeleteUserResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Deletes an ActiveMQ user." + }, + "DescribeBroker" : { + "name" : "DescribeBroker", + "http" : { + "method" : "GET", + "requestUri" : "/v1/brokers/{broker-id}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeBrokerRequest" + }, + "output" : { + "shape" : "DescribeBrokerResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns information about the specified broker." + }, + "DescribeBrokerEngineTypes" : { + "name" : "DescribeBrokerEngineTypes", + "http" : { + "method" : "GET", + "requestUri" : "/v1/broker-engine-types", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeBrokerEngineTypesRequest" + }, + "output" : { + "shape" : "DescribeBrokerEngineTypesResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Describe available engine types and versions." + }, + "DescribeBrokerInstanceOptions" : { + "name" : "DescribeBrokerInstanceOptions", + "http" : { + "method" : "GET", + "requestUri" : "/v1/broker-instance-options", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeBrokerInstanceOptionsRequest" + }, + "output" : { + "shape" : "DescribeBrokerInstanceOptionsResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Describe available broker instance options." + }, + "DescribeConfiguration" : { + "name" : "DescribeConfiguration", + "http" : { + "method" : "GET", + "requestUri" : "/v1/configurations/{configuration-id}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeConfigurationRequest" + }, + "output" : { + "shape" : "DescribeConfigurationResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns information about the specified configuration." + }, + "DescribeConfigurationRevision" : { + "name" : "DescribeConfigurationRevision", + "http" : { + "method" : "GET", + "requestUri" : "/v1/configurations/{configuration-id}/revisions/{configuration-revision}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeConfigurationRevisionRequest" + }, + "output" : { + "shape" : "DescribeConfigurationRevisionResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns the specified configuration revision for the specified configuration." + }, + "DescribeUser" : { + "name" : "DescribeUser", + "http" : { + "method" : "GET", + "requestUri" : "/v1/brokers/{broker-id}/users/{username}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DescribeUserRequest" + }, + "output" : { + "shape" : "DescribeUserResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns information about an ActiveMQ user." + }, + "ListBrokers" : { + "name" : "ListBrokers", + "http" : { + "method" : "GET", + "requestUri" : "/v1/brokers", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListBrokersRequest" + }, + "output" : { + "shape" : "ListBrokersResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns a list of all brokers." + }, + "ListConfigurationRevisions" : { + "name" : "ListConfigurationRevisions", + "http" : { + "method" : "GET", + "requestUri" : "/v1/configurations/{configuration-id}/revisions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListConfigurationRevisionsRequest" + }, + "output" : { + "shape" : "ListConfigurationRevisionsResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns a list of all revisions for the specified configuration." + }, + "ListConfigurations" : { + "name" : "ListConfigurations", + "http" : { + "method" : "GET", + "requestUri" : "/v1/configurations", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListConfigurationsRequest" + }, + "output" : { + "shape" : "ListConfigurationsResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns a list of all configurations." + }, + "ListTags" : { + "name" : "ListTags", + "http" : { + "method" : "GET", + "requestUri" : "/v1/tags/{resource-arn}", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListTagsRequest" + }, + "output" : { + "shape" : "ListTagsResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Lists tags for a resource." + }, + "ListUsers" : { + "name" : "ListUsers", + "http" : { + "method" : "GET", + "requestUri" : "/v1/brokers/{broker-id}/users", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListUsersRequest" + }, + "output" : { + "shape" : "ListUsersResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Returns a list of all ActiveMQ users." + }, + "RebootBroker" : { + "name" : "RebootBroker", + "http" : { + "method" : "POST", + "requestUri" : "/v1/brokers/{broker-id}/reboot", + "responseCode" : 200 + }, + "input" : { + "shape" : "RebootBrokerRequest" + }, + "output" : { + "shape" : "RebootBrokerResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Reboots a broker. Note: This API is asynchronous." + }, + "UpdateBroker" : { + "name" : "UpdateBroker", + "http" : { + "method" : "PUT", + "requestUri" : "/v1/brokers/{broker-id}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateBrokerRequest" + }, + "output" : { + "shape" : "UpdateBrokerResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. Concurrent broker update detected. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Adds a pending configuration change to a broker." + }, + "UpdateConfiguration" : { + "name" : "UpdateConfiguration", + "http" : { + "method" : "PUT", + "requestUri" : "/v1/configurations/{configuration-id}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateConfigurationRequest" + }, + "output" : { + "shape" : "UpdateConfigurationResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. Concurrent update to configuration. Retry to create a new revision." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your input and then retry your request." + } ], + "documentation" : "Updates the specified configuration." + }, + "UpdateUser" : { + "name" : "UpdateUser", + "http" : { + "method" : "PUT", + "requestUri" : "/v1/brokers/{broker-id}/users/{username}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateUserRequest" + }, + "output" : { + "shape" : "UpdateUserResponse", + "documentation" : "HTTP Status Code 200: OK." + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "HTTP Status Code 404: Resource not found due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "BadRequestException", + "documentation" : "HTTP Status Code 400: Bad request due to incorrect input. Correct your request and then retry it." + }, { + "shape" : "InternalServerErrorException", + "documentation" : "HTTP Status Code 500: Unexpected internal server error. Retrying your request might resolve the issue." + }, { + "shape" : "ConflictException", + "documentation" : "HTTP Status Code 409: Conflict. Retrying your request might resolve the issue." + }, { + "shape" : "ForbiddenException", + "documentation" : "HTTP Status Code 403: Access forbidden. Correct your credentials and then retry your request." + } ], + "documentation" : "Updates the information for an ActiveMQ user." + } + }, + "shapes" : { + "AvailabilityZone" : { + "type" : "structure", + "members" : { + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Id for the availability zone." + } + }, + "documentation" : "Name of the availability zone." + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "BrokerEngineType" : { + "type" : "structure", + "members" : { + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "The type of broker engine." + }, + "EngineVersions" : { + "shape" : "__listOfEngineVersion", + "locationName" : "engineVersions", + "documentation" : "The list of engine versions." + } + }, + "documentation" : "Types of broker engines." + }, + "BrokerEngineTypeOutput" : { + "type" : "structure", + "members" : { + "BrokerEngineTypes" : { + "shape" : "__listOfBrokerEngineType", + "locationName" : "brokerEngineTypes", + "documentation" : "List of available engine types and versions." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "documentation" : "Returns a list of broker engine type." + }, + "BrokerInstance" : { + "type" : "structure", + "members" : { + "ConsoleURL" : { + "shape" : "__string", + "locationName" : "consoleURL", + "documentation" : "The URL of the broker's ActiveMQ Web Console." + }, + "Endpoints" : { + "shape" : "__listOf__string", + "locationName" : "endpoints", + "documentation" : "The broker's wire-level protocol endpoints." + }, + "IpAddress" : { + "shape" : "__string", + "locationName" : "ipAddress", + "documentation" : "The IP address of the Elastic Network Interface (ENI) attached to the broker." + } + }, + "documentation" : "Returns information about all brokers." + }, + "BrokerInstanceOption" : { + "type" : "structure", + "members" : { + "AvailabilityZones" : { + "shape" : "__listOfAvailabilityZone", + "locationName" : "availabilityZones", + "documentation" : "The list of available az." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "The type of broker engine." + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The type of broker instance." + }, + "SupportedEngineVersions" : { + "shape" : "__listOf__string", + "locationName" : "supportedEngineVersions", + "documentation" : "The list of supported engine versions." + } + }, + "documentation" : "Option for host instance type." + }, + "BrokerInstanceOptionsOutput" : { + "type" : "structure", + "members" : { + "BrokerInstanceOptions" : { + "shape" : "__listOfBrokerInstanceOption", + "locationName" : "brokerInstanceOptions", + "documentation" : "List of available broker instance options." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "documentation" : "Returns a list of broker instance options." + }, + "BrokerState" : { + "type" : "string", + "documentation" : "The status of the broker.", + "enum" : [ "CREATION_IN_PROGRESS", "CREATION_FAILED", "DELETION_IN_PROGRESS", "RUNNING", "REBOOT_IN_PROGRESS" ] + }, + "BrokerSummary" : { + "type" : "structure", + "members" : { + "BrokerArn" : { + "shape" : "__string", + "locationName" : "brokerArn", + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "BrokerName" : { + "shape" : "__string", + "locationName" : "brokerName", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "BrokerState" : { + "shape" : "BrokerState", + "locationName" : "brokerState", + "documentation" : "The status of the broker." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "The time when the broker was created." + }, + "DeploymentMode" : { + "shape" : "DeploymentMode", + "locationName" : "deploymentMode", + "documentation" : "Required. The deployment mode of the broker." + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The broker's instance type." + } + }, + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "ChangeType" : { + "type" : "string", + "documentation" : "The type of change pending for the ActiveMQ user.", + "enum" : [ "CREATE", "UPDATE", "DELETE" ] + }, + "Configuration" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The ARN of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration revision." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "Required. The description of the configuration." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "Required. The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The list of all tags associated with this configuration." + } + }, + "documentation" : "Returns information about all configurations." + }, + "ConfigurationId" : { + "type" : "structure", + "members" : { + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "Revision" : { + "shape" : "__integer", + "locationName" : "revision", + "documentation" : "The revision number of the configuration." + } + }, + "documentation" : "A list of information about the configuration." + }, + "ConfigurationRevision" : { + "type" : "structure", + "members" : { + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration revision." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "The description of the configuration revision." + }, + "Revision" : { + "shape" : "__integer", + "locationName" : "revision", + "documentation" : "Required. The revision number of the configuration." + } + }, + "documentation" : "Returns information about the specified configuration revision." + }, + "Configurations" : { + "type" : "structure", + "members" : { + "Current" : { + "shape" : "ConfigurationId", + "locationName" : "current", + "documentation" : "The current configuration of the broker." + }, + "History" : { + "shape" : "__listOfConfigurationId", + "locationName" : "history", + "documentation" : "The history of configurations applied to the broker." + }, + "Pending" : { + "shape" : "ConfigurationId", + "locationName" : "pending", + "documentation" : "The pending configuration of the broker." + } + }, + "documentation" : "Broker configuration information" + }, + "ConflictException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "CreateBrokerInput" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "BrokerName" : { + "shape" : "__string", + "locationName" : "brokerName", + "documentation" : "Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "A list of information about the configuration." + }, + "CreatorRequestId" : { + "shape" : "__string", + "locationName" : "creatorRequestId", + "documentation" : "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.", + "idempotencyToken" : true + }, + "DeploymentMode" : { + "shape" : "DeploymentMode", + "locationName" : "deploymentMode", + "documentation" : "Required. The deployment mode of the broker." + }, + "EncryptionOptions" : { + "shape" : "EncryptionOptions", + "locationName" : "encryptionOptions", + "documentation" : "Encryption options for the broker." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "Required. The broker's instance type." + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "Enables Amazon CloudWatch logging for brokers." + }, + "MaintenanceWindowStartTime" : { + "shape" : "WeeklyStartTime", + "locationName" : "maintenanceWindowStartTime", + "documentation" : "The parameters that determine the WeeklyStartTime." + }, + "PubliclyAccessible" : { + "shape" : "__boolean", + "locationName" : "publiclyAccessible", + "documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + }, + "SubnetIds" : { + "shape" : "__listOf__string", + "locationName" : "subnetIds", + "documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "Create tags when creating the broker." + }, + "Users" : { + "shape" : "__listOfUser", + "locationName" : "users", + "documentation" : "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Required. The time period during which Amazon MQ applies pending updates or patches to the broker." + }, + "CreateBrokerOutput" : { + "type" : "structure", + "members" : { + "BrokerArn" : { + "shape" : "__string", + "locationName" : "brokerArn", + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + } + }, + "documentation" : "Returns information about the created broker." + }, + "CreateBrokerRequest" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "BrokerName" : { + "shape" : "__string", + "locationName" : "brokerName", + "documentation" : "Required. The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "A list of information about the configuration." + }, + "CreatorRequestId" : { + "shape" : "__string", + "locationName" : "creatorRequestId", + "documentation" : "The unique ID that the requester receives for the created broker. Amazon MQ passes your ID with the API action. Note: We recommend using a Universally Unique Identifier (UUID) for the creatorRequestId. You may omit the creatorRequestId if your application doesn't require idempotency.", + "idempotencyToken" : true + }, + "DeploymentMode" : { + "shape" : "DeploymentMode", + "locationName" : "deploymentMode", + "documentation" : "Required. The deployment mode of the broker." + }, + "EncryptionOptions" : { + "shape" : "EncryptionOptions", + "locationName" : "encryptionOptions", + "documentation" : "Encryption options for the broker." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "Required. The broker's instance type." + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "Enables Amazon CloudWatch logging for brokers." + }, + "MaintenanceWindowStartTime" : { + "shape" : "WeeklyStartTime", + "locationName" : "maintenanceWindowStartTime", + "documentation" : "The parameters that determine the WeeklyStartTime." + }, + "PubliclyAccessible" : { + "shape" : "__boolean", + "locationName" : "publiclyAccessible", + "documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + }, + "SubnetIds" : { + "shape" : "__listOf__string", + "locationName" : "subnetIds", + "documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "Create tags when creating the broker." + }, + "Users" : { + "shape" : "__listOfUser", + "locationName" : "users", + "documentation" : "Required. The list of ActiveMQ users (persons or applications) who can access queues and topics. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Creates a broker using the specified properties." + }, + "CreateBrokerResponse" : { + "type" : "structure", + "members" : { + "BrokerArn" : { + "shape" : "__string", + "locationName" : "brokerArn", + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + } + } + }, + "CreateConfigurationInput" : { + "type" : "structure", + "members" : { + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "Create tags when creating the configuration." + } + }, + "documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)." + }, + "CreateConfigurationOutput" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The Amazon Resource Name (ARN) of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + } + }, + "documentation" : "Returns information about the created configuration." + }, + "CreateConfigurationRequest" : { + "type" : "structure", + "members" : { + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "Create tags when creating the configuration." + } + }, + "documentation" : "Creates a new configuration for the specified configuration name. Amazon MQ uses the default configuration (the engine type and version)." + }, + "CreateConfigurationResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The Amazon Resource Name (ARN) of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + } + } + }, + "CreateTagsRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource tag." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The key-value pair for the resource tag." + } + }, + "documentation" : "A map of the key-value pairs for the resource tag.", + "required" : [ "ResourceArn" ] + }, + "CreateUserInput" : { + "type" : "structure", + "members" : { + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Password" : { + "shape" : "__string", + "locationName" : "password", + "documentation" : "Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas." + } + }, + "documentation" : "Creates a new ActiveMQ user." + }, + "CreateUserRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Password" : { + "shape" : "__string", + "locationName" : "password", + "documentation" : "Required. The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas." + }, + "Username" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "username", + "documentation" : "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Creates a new ActiveMQ user.", + "required" : [ "Username", "BrokerId" ] + }, + "CreateUserResponse" : { + "type" : "structure", + "members" : { } + }, + "DayOfWeek" : { + "type" : "string", + "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] + }, + "DeleteBrokerOutput" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + } + }, + "documentation" : "Returns information about the deleted broker." + }, + "DeleteBrokerRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + } + }, + "required" : [ "BrokerId" ] + }, + "DeleteBrokerResponse" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + } + } + }, + "DeleteTagsRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource tag." + }, + "TagKeys" : { + "shape" : "__listOf__string", + "location" : "querystring", + "locationName" : "tagKeys", + "documentation" : "An array of tag keys to delete" + } + }, + "required" : [ "TagKeys", "ResourceArn" ] + }, + "DeleteUserRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "Username" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "username", + "documentation" : "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "required" : [ "Username", "BrokerId" ] + }, + "DeleteUserResponse" : { + "type" : "structure", + "members" : { } + }, + "DeploymentMode" : { + "type" : "string", + "documentation" : "The deployment mode of the broker.", + "enum" : [ "SINGLE_INSTANCE", "ACTIVE_STANDBY_MULTI_AZ" ] + }, + "DescribeBrokerEngineTypesRequest" : { + "type" : "structure", + "members" : { + "EngineType" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "engineType", + "documentation" : "Filter response by engine type." + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of engine types that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "DescribeBrokerEngineTypesResponse" : { + "type" : "structure", + "members" : { + "BrokerEngineTypes" : { + "shape" : "__listOfBrokerEngineType", + "locationName" : "brokerEngineTypes", + "documentation" : "List of available engine types and versions." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of engine types that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "DescribeBrokerInstanceOptionsRequest" : { + "type" : "structure", + "members" : { + "EngineType" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "engineType", + "documentation" : "Filter response by engine type." + }, + "HostInstanceType" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "hostInstanceType", + "documentation" : "Filter response by host instance type." + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of instance options that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "DescribeBrokerInstanceOptionsResponse" : { + "type" : "structure", + "members" : { + "BrokerInstanceOptions" : { + "shape" : "__listOfBrokerInstanceOption", + "locationName" : "brokerInstanceOptions", + "documentation" : "List of available broker instance options." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of instance options that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "DescribeBrokerOutput" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "BrokerArn" : { + "shape" : "__string", + "locationName" : "brokerArn", + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "BrokerInstances" : { + "shape" : "__listOfBrokerInstance", + "locationName" : "brokerInstances", + "documentation" : "A list of information about allocated brokers." + }, + "BrokerName" : { + "shape" : "__string", + "locationName" : "brokerName", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "BrokerState" : { + "shape" : "BrokerState", + "locationName" : "brokerState", + "documentation" : "The status of the broker." + }, + "Configurations" : { + "shape" : "Configurations", + "locationName" : "configurations", + "documentation" : "The list of all revisions for the specified configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "The time when the broker was created." + }, + "DeploymentMode" : { + "shape" : "DeploymentMode", + "locationName" : "deploymentMode", + "documentation" : "Required. The deployment mode of the broker." + }, + "EncryptionOptions" : { + "shape" : "EncryptionOptions", + "locationName" : "encryptionOptions", + "documentation" : "Encryption options for the broker." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The broker's instance type." + }, + "Logs" : { + "shape" : "LogsSummary", + "locationName" : "logs", + "documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker." + }, + "MaintenanceWindowStartTime" : { + "shape" : "WeeklyStartTime", + "locationName" : "maintenanceWindowStartTime", + "documentation" : "The parameters that determine the WeeklyStartTime." + }, + "PendingEngineVersion" : { + "shape" : "__string", + "locationName" : "pendingEngineVersion", + "documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "PendingSecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "pendingSecurityGroups", + "documentation" : "The list of pending security groups to authorize connections to brokers." + }, + "PendingHostInstanceType" : { + "shape" : "__string", + "locationName" : "pendingHostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "PubliclyAccessible" : { + "shape" : "__boolean", + "locationName" : "publiclyAccessible", + "documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + }, + "SubnetIds" : { + "shape" : "__listOf__string", + "locationName" : "subnetIds", + "documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The list of all tags associated with this broker." + }, + "Users" : { + "shape" : "__listOfUserSummary", + "locationName" : "users", + "documentation" : "The list of all ActiveMQ usernames for the specified broker." + } + }, + "documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "DescribeBrokerRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + } + }, + "required" : [ "BrokerId" ] + }, + "DescribeBrokerResponse" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Required. Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "BrokerArn" : { + "shape" : "__string", + "locationName" : "brokerArn", + "documentation" : "The Amazon Resource Name (ARN) of the broker." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "BrokerInstances" : { + "shape" : "__listOfBrokerInstance", + "locationName" : "brokerInstances", + "documentation" : "A list of information about allocated brokers." + }, + "BrokerName" : { + "shape" : "__string", + "locationName" : "brokerName", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "BrokerState" : { + "shape" : "BrokerState", + "locationName" : "brokerState", + "documentation" : "The status of the broker." + }, + "Configurations" : { + "shape" : "Configurations", + "locationName" : "configurations", + "documentation" : "The list of all revisions for the specified configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "The time when the broker was created." + }, + "DeploymentMode" : { + "shape" : "DeploymentMode", + "locationName" : "deploymentMode", + "documentation" : "Required. The deployment mode of the broker." + }, + "EncryptionOptions" : { + "shape" : "EncryptionOptions", + "locationName" : "encryptionOptions", + "documentation" : "Encryption options for the broker." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The broker's instance type." + }, + "Logs" : { + "shape" : "LogsSummary", + "locationName" : "logs", + "documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker." + }, + "MaintenanceWindowStartTime" : { + "shape" : "WeeklyStartTime", + "locationName" : "maintenanceWindowStartTime", + "documentation" : "The parameters that determine the WeeklyStartTime." + }, + "PendingEngineVersion" : { + "shape" : "__string", + "locationName" : "pendingEngineVersion", + "documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "PendingSecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "pendingSecurityGroups", + "documentation" : "The list of pending security groups to authorize connections to brokers." + }, + "PendingHostInstanceType" : { + "shape" : "__string", + "locationName" : "pendingHostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "PubliclyAccessible" : { + "shape" : "__boolean", + "locationName" : "publiclyAccessible", + "documentation" : "Required. Enables connections from applications outside of the VPC that hosts the broker's subnets." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + }, + "SubnetIds" : { + "shape" : "__listOf__string", + "locationName" : "subnetIds", + "documentation" : "The list of groups (2 maximum) that define which subnets and IP ranges the broker can use from different Availability Zones. A SINGLE_INSTANCE deployment requires one subnet (for example, the default subnet). An ACTIVE_STANDBY_MULTI_AZ deployment requires two subnets." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The list of all tags associated with this broker." + }, + "Users" : { + "shape" : "__listOfUserSummary", + "locationName" : "users", + "documentation" : "The list of all ActiveMQ usernames for the specified broker." + } + } + }, + "DescribeConfigurationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "configuration-id", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + } + }, + "required" : [ "ConfigurationId" ] + }, + "DescribeConfigurationResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The ARN of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration revision." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "Required. The description of the configuration." + }, + "EngineType" : { + "shape" : "EngineType", + "locationName" : "engineType", + "documentation" : "Required. The type of broker engine. Note: Currently, Amazon MQ supports only ACTIVEMQ." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "Required. The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "Required. The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The list of all tags associated with this configuration." + } + } + }, + "DescribeConfigurationRevisionOutput" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "locationName" : "configurationId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Data" : { + "shape" : "__string", + "locationName" : "data", + "documentation" : "Required. The base64-encoded XML configuration." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "The description of the configuration." + } + }, + "documentation" : "Returns the specified configuration revision for the specified configuration." + }, + "DescribeConfigurationRevisionRequest" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "configuration-id", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + }, + "ConfigurationRevision" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "configuration-revision", + "documentation" : "The revision of the configuration." + } + }, + "required" : [ "ConfigurationRevision", "ConfigurationId" ] + }, + "DescribeConfigurationRevisionResponse" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "locationName" : "configurationId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Data" : { + "shape" : "__string", + "locationName" : "data", + "documentation" : "Required. The base64-encoded XML configuration." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "The description of the configuration." + } + } + }, + "DescribeUserOutput" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Pending" : { + "shape" : "UserPendingChanges", + "locationName" : "pending", + "documentation" : "The status of the changes pending for the ActiveMQ user." + }, + "Username" : { + "shape" : "__string", + "locationName" : "username", + "documentation" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Returns information about an ActiveMQ user." + }, + "DescribeUserRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "Username" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "username", + "documentation" : "The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "required" : [ "Username", "BrokerId" ] + }, + "DescribeUserResponse" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Pending" : { + "shape" : "UserPendingChanges", + "locationName" : "pending", + "documentation" : "The status of the changes pending for the ActiveMQ user." + }, + "Username" : { + "shape" : "__string", + "locationName" : "username", + "documentation" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + } + }, + "EncryptionOptions" : { + "type" : "structure", + "members" : { + "KmsKeyId" : { + "shape" : "__string", + "locationName" : "kmsKeyId", + "documentation" : "The customer master key (CMK) to use for the AWS Key Management Service (KMS). This key is used to encrypt your data at rest. If not provided, Amazon MQ will use a default CMK to encrypt your data." + }, + "UseAwsOwnedKey" : { + "shape" : "__boolean", + "locationName" : "useAwsOwnedKey", + "documentation" : "Enables the use of an AWS owned CMK using AWS Key Management Service (KMS)." + } + }, + "documentation" : "Encryption options for the broker.", + "required" : [ "UseAwsOwnedKey" ] + }, + "EngineType" : { + "type" : "string", + "documentation" : "The type of broker engine. Note: Currently, Amazon MQ supports only ActiveMQ.", + "enum" : [ "ACTIVEMQ" ] + }, + "EngineVersion" : { + "type" : "structure", + "members" : { + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Id for the version." + } + }, + "documentation" : "Id of the engine version." + }, + "Error" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error." + }, + "ForbiddenException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 403 + } + }, + "InternalServerErrorException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "ListBrokersOutput" : { + "type" : "structure", + "members" : { + "BrokerSummaries" : { + "shape" : "__listOfBrokerSummary", + "locationName" : "brokerSummaries", + "documentation" : "A list of information about all brokers." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "documentation" : "A list of information about all brokers." + }, + "ListBrokersRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of brokers that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "ListBrokersResponse" : { + "type" : "structure", + "members" : { + "BrokerSummaries" : { + "shape" : "__listOfBrokerSummary", + "locationName" : "brokerSummaries", + "documentation" : "A list of information about all brokers." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "ListConfigurationRevisionsOutput" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "locationName" : "configurationId", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + }, + "MaxResults" : { + "shape" : "__integer", + "locationName" : "maxResults", + "documentation" : "The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + }, + "Revisions" : { + "shape" : "__listOfConfigurationRevision", + "locationName" : "revisions", + "documentation" : "The list of all revisions for the specified configuration." + } + }, + "documentation" : "Returns a list of all revisions for the specified configuration." + }, + "ListConfigurationRevisionsRequest" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "configuration-id", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "required" : [ "ConfigurationId" ] + }, + "ListConfigurationRevisionsResponse" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "locationName" : "configurationId", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + }, + "MaxResults" : { + "shape" : "__integer", + "locationName" : "maxResults", + "documentation" : "The maximum number of configuration revisions that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + }, + "Revisions" : { + "shape" : "__listOfConfigurationRevision", + "locationName" : "revisions", + "documentation" : "The list of all revisions for the specified configuration." + } + } + }, + "ListConfigurationsOutput" : { + "type" : "structure", + "members" : { + "Configurations" : { + "shape" : "__listOfConfiguration", + "locationName" : "configurations", + "documentation" : "The list of all revisions for the specified configuration." + }, + "MaxResults" : { + "shape" : "__integer", + "locationName" : "maxResults", + "documentation" : "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "documentation" : "Returns a list of all configurations." + }, + "ListConfigurationsRequest" : { + "type" : "structure", + "members" : { + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "ListConfigurationsResponse" : { + "type" : "structure", + "members" : { + "Configurations" : { + "shape" : "__listOfConfiguration", + "locationName" : "configurations", + "documentation" : "The list of all revisions for the specified configuration." + }, + "MaxResults" : { + "shape" : "__integer", + "locationName" : "maxResults", + "documentation" : "The maximum number of configurations that Amazon MQ can return per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + } + }, + "ListTagsRequest" : { + "type" : "structure", + "members" : { + "ResourceArn" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "resource-arn", + "documentation" : "The Amazon Resource Name (ARN) of the resource tag." + } + }, + "required" : [ "ResourceArn" ] + }, + "ListTagsResponse" : { + "type" : "structure", + "members" : { + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The key-value pair for the resource tag." + } + } + }, + "ListUsersOutput" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + }, + "Users" : { + "shape" : "__listOfUserSummary", + "locationName" : "users", + "documentation" : "Required. The list of all ActiveMQ usernames for the specified broker." + } + }, + "documentation" : "Returns a list of all ActiveMQ users." + }, + "ListUsersRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "MaxResults" : { + "shape" : "MaxResults", + "location" : "querystring", + "locationName" : "maxResults", + "documentation" : "The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + } + }, + "required" : [ "BrokerId" ] + }, + "ListUsersResponse" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "MaxResults" : { + "shape" : "__integerMin5Max100", + "locationName" : "maxResults", + "documentation" : "Required. The maximum number of ActiveMQ users that can be returned per page (20 by default). This value must be an integer from 5 to 100." + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "The token that specifies the next page of results Amazon MQ should return. To request the first page, leave nextToken empty." + }, + "Users" : { + "shape" : "__listOfUserSummary", + "locationName" : "users", + "documentation" : "Required. The list of all ActiveMQ usernames for the specified broker." + } + } + }, + "Logs" : { + "type" : "structure", + "members" : { + "Audit" : { + "shape" : "__boolean", + "locationName" : "audit", + "documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged." + }, + "General" : { + "shape" : "__boolean", + "locationName" : "general", + "documentation" : "Enables general logging." + } + }, + "documentation" : "The list of information about logs to be enabled for the specified broker." + }, + "LogsSummary" : { + "type" : "structure", + "members" : { + "Audit" : { + "shape" : "__boolean", + "locationName" : "audit", + "documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged." + }, + "AuditLogGroup" : { + "shape" : "__string", + "locationName" : "auditLogGroup", + "documentation" : "The location of the CloudWatch Logs log group where audit logs are sent." + }, + "General" : { + "shape" : "__boolean", + "locationName" : "general", + "documentation" : "Enables general logging." + }, + "GeneralLogGroup" : { + "shape" : "__string", + "locationName" : "generalLogGroup", + "documentation" : "The location of the CloudWatch Logs log group where general logs are sent." + }, + "Pending" : { + "shape" : "PendingLogs", + "locationName" : "pending", + "documentation" : "The list of information about logs pending to be deployed for the specified broker." + } + }, + "documentation" : "The list of information about logs currently enabled and pending to be deployed for the specified broker." + }, + "MaxResults" : { + "type" : "integer", + "min" : 1, + "max" : 100 + }, + "NotFoundException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "PendingLogs" : { + "type" : "structure", + "members" : { + "Audit" : { + "shape" : "__boolean", + "locationName" : "audit", + "documentation" : "Enables audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged." + }, + "General" : { + "shape" : "__boolean", + "locationName" : "general", + "documentation" : "Enables general logging." + } + }, + "documentation" : "The list of information about logs to be enabled for the specified broker." + }, + "RebootBrokerRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + } + }, + "required" : [ "BrokerId" ] + }, + "RebootBrokerResponse" : { + "type" : "structure", + "members" : { } + }, + "SanitizationWarning" : { + "type" : "structure", + "members" : { + "AttributeName" : { + "shape" : "__string", + "locationName" : "attributeName", + "documentation" : "The name of the XML attribute that has been sanitized." + }, + "ElementName" : { + "shape" : "__string", + "locationName" : "elementName", + "documentation" : "The name of the XML element that has been sanitized." + }, + "Reason" : { + "shape" : "SanitizationWarningReason", + "locationName" : "reason", + "documentation" : "Required. The reason for which the XML elements or attributes were sanitized." + } + }, + "documentation" : "Returns information about the XML element or attribute that was sanitized in the configuration." + }, + "SanitizationWarningReason" : { + "type" : "string", + "documentation" : "The reason for which the XML elements or attributes were sanitized.", + "enum" : [ "DISALLOWED_ELEMENT_REMOVED", "DISALLOWED_ATTRIBUTE_REMOVED", "INVALID_ATTRIBUTE_VALUE_REMOVED" ] + }, + "Tags" : { + "type" : "structure", + "members" : { + "Tags" : { + "shape" : "__mapOf__string", + "locationName" : "tags", + "documentation" : "The key-value pair for the resource tag." + } + }, + "documentation" : "A map of the key-value pairs for the resource tag." + }, + "UnauthorizedException" : { + "type" : "structure", + "members" : { + "ErrorAttribute" : { + "shape" : "__string", + "locationName" : "errorAttribute", + "documentation" : "The attribute which caused the error." + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "The explanation of the error." + } + }, + "documentation" : "Returns information about an error.", + "exception" : true, + "error" : { + "httpStatusCode" : 401 + } + }, + "UpdateBrokerInput" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "A list of information about the configuration." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "Enables Amazon CloudWatch logging for brokers." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + } + }, + "documentation" : "Updates the broker using the specified properties." + }, + "UpdateBrokerOutput" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "The new value of automatic upgrades to new minor version for brokers." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "The ID of the updated configuration." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "The list of information about logs to be enabled for the specified broker." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + } + }, + "documentation" : "Returns information about the updated broker." + }, + "UpdateBrokerRequest" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions. The automatic upgrades occur during the maintenance window of the broker or after a manual broker reboot." + }, + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The name of the broker. This value must be unique in your AWS account, 1-50 characters long, must contain only letters, numbers, dashes, and underscores, and must not contain whitespaces, brackets, wildcard characters, or special characters." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "A list of information about the configuration." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "Enables Amazon CloudWatch logging for brokers." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + } + }, + "documentation" : "Updates the broker using the specified properties.", + "required" : [ "BrokerId" ] + }, + "UpdateBrokerResponse" : { + "type" : "structure", + "members" : { + "AutoMinorVersionUpgrade" : { + "shape" : "__boolean", + "locationName" : "autoMinorVersionUpgrade", + "documentation" : "The new value of automatic upgrades to new minor version for brokers." + }, + "BrokerId" : { + "shape" : "__string", + "locationName" : "brokerId", + "documentation" : "Required. The unique ID that Amazon MQ generates for the broker." + }, + "Configuration" : { + "shape" : "ConfigurationId", + "locationName" : "configuration", + "documentation" : "The ID of the updated configuration." + }, + "EngineVersion" : { + "shape" : "__string", + "locationName" : "engineVersion", + "documentation" : "The version of the broker engine to upgrade to. For a list of supported engine versions, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html" + }, + "HostInstanceType" : { + "shape" : "__string", + "locationName" : "hostInstanceType", + "documentation" : "The host instance type of the broker to upgrade to. For a list of supported instance types, see https://docs.aws.amazon.com/amazon-mq/latest/developer-guide//broker.html#broker-instance-types" + }, + "Logs" : { + "shape" : "Logs", + "locationName" : "logs", + "documentation" : "The list of information about logs to be enabled for the specified broker." + }, + "SecurityGroups" : { + "shape" : "__listOf__string", + "locationName" : "securityGroups", + "documentation" : "The list of security groups (1 minimum, 5 maximum) that authorize connections to brokers." + } + } + }, + "UpdateConfigurationInput" : { + "type" : "structure", + "members" : { + "Data" : { + "shape" : "__string", + "locationName" : "data", + "documentation" : "Required. The base64-encoded XML configuration." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "The description of the configuration." + } + }, + "documentation" : "Updates the specified configuration." + }, + "UpdateConfigurationOutput" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The Amazon Resource Name (ARN) of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Warnings" : { + "shape" : "__listOfSanitizationWarning", + "locationName" : "warnings", + "documentation" : "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized." + } + }, + "documentation" : "Returns information about the updated configuration." + }, + "UpdateConfigurationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "configuration-id", + "documentation" : "The unique ID that Amazon MQ generates for the configuration." + }, + "Data" : { + "shape" : "__string", + "locationName" : "data", + "documentation" : "Required. The base64-encoded XML configuration." + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "The description of the configuration." + } + }, + "documentation" : "Updates the specified configuration.", + "required" : [ "ConfigurationId" ] + }, + "UpdateConfigurationResponse" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "Required. The Amazon Resource Name (ARN) of the configuration." + }, + "Created" : { + "shape" : "__timestampIso8601", + "locationName" : "created", + "documentation" : "Required. The date and time of the configuration." + }, + "Id" : { + "shape" : "__string", + "locationName" : "id", + "documentation" : "Required. The unique ID that Amazon MQ generates for the configuration." + }, + "LatestRevision" : { + "shape" : "ConfigurationRevision", + "locationName" : "latestRevision", + "documentation" : "The latest revision of the configuration." + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "Required. The name of the configuration. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 1-150 characters long." + }, + "Warnings" : { + "shape" : "__listOfSanitizationWarning", + "locationName" : "warnings", + "documentation" : "The list of the first 20 warnings about the configuration XML elements or attributes that were sanitized." + } + } + }, + "UpdateUserInput" : { + "type" : "structure", + "members" : { + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Password" : { + "shape" : "__string", + "locationName" : "password", + "documentation" : "The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas." + } + }, + "documentation" : "Updates the information for an ActiveMQ user." + }, + "UpdateUserRequest" : { + "type" : "structure", + "members" : { + "BrokerId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "broker-id", + "documentation" : "The unique ID that Amazon MQ generates for the broker." + }, + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Password" : { + "shape" : "__string", + "locationName" : "password", + "documentation" : "The password of the user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas." + }, + "Username" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "username", + "documentation" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Updates the information for an ActiveMQ user.", + "required" : [ "Username", "BrokerId" ] + }, + "UpdateUserResponse" : { + "type" : "structure", + "members" : { } + }, + "User" : { + "type" : "structure", + "members" : { + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "Password" : { + "shape" : "__string", + "locationName" : "password", + "documentation" : "Required. The password of the ActiveMQ user. This value must be at least 12 characters long, must contain at least 4 unique characters, and must not contain commas." + }, + "Username" : { + "shape" : "__string", + "locationName" : "username", + "documentation" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "An ActiveMQ user associated with the broker." + }, + "UserPendingChanges" : { + "type" : "structure", + "members" : { + "ConsoleAccess" : { + "shape" : "__boolean", + "locationName" : "consoleAccess", + "documentation" : "Enables access to the the ActiveMQ Web Console for the ActiveMQ user." + }, + "Groups" : { + "shape" : "__listOf__string", + "locationName" : "groups", + "documentation" : "The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + }, + "PendingChange" : { + "shape" : "ChangeType", + "locationName" : "pendingChange", + "documentation" : "Required. The type of change pending for the ActiveMQ user." + } + }, + "documentation" : "Returns information about the status of the changes pending for the ActiveMQ user." + }, + "UserSummary" : { + "type" : "structure", + "members" : { + "PendingChange" : { + "shape" : "ChangeType", + "locationName" : "pendingChange", + "documentation" : "The type of change pending for the ActiveMQ user." + }, + "Username" : { + "shape" : "__string", + "locationName" : "username", + "documentation" : "Required. The username of the ActiveMQ user. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long." + } + }, + "documentation" : "Returns a list of all ActiveMQ users." + }, + "WeeklyStartTime" : { + "type" : "structure", + "members" : { + "DayOfWeek" : { + "shape" : "DayOfWeek", + "locationName" : "dayOfWeek", + "documentation" : "Required. The day of the week." + }, + "TimeOfDay" : { + "shape" : "__string", + "locationName" : "timeOfDay", + "documentation" : "Required. The time, in 24-hour format." + }, + "TimeZone" : { + "shape" : "__string", + "locationName" : "timeZone", + "documentation" : "The time zone, UTC by default, in either the Country/City format, or the UTC offset format." + } + }, + "documentation" : "The scheduled time period relative to UTC during which Amazon MQ begins to apply pending updates or patches to the broker." + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__integerMin5Max100" : { + "type" : "integer", + "min" : 5, + "max" : 100 + }, + "__listOfAvailabilityZone" : { + "type" : "list", + "member" : { + "shape" : "AvailabilityZone" + } + }, + "__listOfBrokerEngineType" : { + "type" : "list", + "member" : { + "shape" : "BrokerEngineType" + } + }, + "__listOfBrokerInstance" : { + "type" : "list", + "member" : { + "shape" : "BrokerInstance" + } + }, + "__listOfBrokerInstanceOption" : { + "type" : "list", + "member" : { + "shape" : "BrokerInstanceOption" + } + }, + "__listOfBrokerSummary" : { + "type" : "list", + "member" : { + "shape" : "BrokerSummary" + } + }, + "__listOfConfiguration" : { + "type" : "list", + "member" : { + "shape" : "Configuration" + } + }, + "__listOfConfigurationId" : { + "type" : "list", + "member" : { + "shape" : "ConfigurationId" + } + }, + "__listOfConfigurationRevision" : { + "type" : "list", + "member" : { + "shape" : "ConfigurationRevision" + } + }, + "__listOfEngineVersion" : { + "type" : "list", + "member" : { + "shape" : "EngineVersion" + } + }, + "__listOfSanitizationWarning" : { + "type" : "list", + "member" : { + "shape" : "SanitizationWarning" + } + }, + "__listOfUser" : { + "type" : "list", + "member" : { + "shape" : "User" + } + }, + "__listOfUserSummary" : { + "type" : "list", + "member" : { + "shape" : "UserSummary" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__mapOf__string" : { + "type" : "map", + "key" : { + "shape" : "__string" + }, + "value" : { + "shape" : "__string" + } + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "authorizers" : { + "authorization_strategy" : { + "name" : "authorization_strategy", + "type" : "provided", + "placement" : { + "location" : "header", + "name" : "Authorization" + } + } + }, + "documentation" : "Amazon MQ is a managed message broker service for Apache ActiveMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols." +} diff --git a/aws/dist/botocore/data/mturk/2017-01-17/paginators-1.json b/aws/dist/botocore/data/mturk/2017-01-17/paginators-1.json new file mode 100644 index 00000000..ea50cacc --- /dev/null +++ b/aws/dist/botocore/data/mturk/2017-01-17/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "ListAssignmentsForHIT": { + "result_key": "Assignments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListQualificationTypes": { + "result_key": "QualificationTypes", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHITs": { + "result_key": "HITs", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkerBlocks": { + "result_key": "WorkerBlocks", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListReviewableHITs": { + "result_key": "HITs", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListHITsForQualificationType": { + "result_key": "HITs", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListQualificationRequests": { + "result_key": "QualificationRequests", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListWorkersWithQualificationType": { + "result_key": "Qualifications", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListBonusPayments": { + "result_key": "BonusPayments", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/mturk/2017-01-17/service-2.json b/aws/dist/botocore/data/mturk/2017-01-17/service-2.json new file mode 100644 index 00000000..77db25a9 --- /dev/null +++ b/aws/dist/botocore/data/mturk/2017-01-17/service-2.json @@ -0,0 +1,2569 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-01-17", + "endpointPrefix":"mturk-requester", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon MTurk", + "serviceFullName":"Amazon Mechanical Turk", + "serviceId":"MTurk", + "signatureVersion":"v4", + "targetPrefix":"MTurkRequesterServiceV20170117", + "uid":"mturk-requester-2017-01-17" + }, + "operations":{ + "AcceptQualificationRequest":{ + "name":"AcceptQualificationRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptQualificationRequestRequest"}, + "output":{"shape":"AcceptQualificationRequestResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The AcceptQualificationRequest operation approves a Worker's request for a Qualification.

Only the owner of the Qualification type can grant a Qualification request for that type.

A successful request for the AcceptQualificationRequest operation returns with no errors and an empty body.

" + }, + "ApproveAssignment":{ + "name":"ApproveAssignment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApproveAssignmentRequest"}, + "output":{"shape":"ApproveAssignmentResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ApproveAssignment operation approves the results of a completed assignment.

Approving an assignment initiates two payments from the Requester's Amazon.com account

  • The Worker who submitted the results is paid the reward specified in the HIT.

  • Amazon Mechanical Turk fees are debited.

If the Requester's account does not have adequate funds for these payments, the call to ApproveAssignment returns an exception, and the approval is not processed. You can include an optional feedback message with the approval, which the Worker can see in the Status section of the web site.

You can also call this operation for assignments that were previous rejected and approve them by explicitly overriding the previous rejection. This only works on rejected assignments that were submitted within the previous 30 days and only if the assignment's related HIT has not been deleted.

", + "idempotent":true + }, + "AssociateQualificationWithWorker":{ + "name":"AssociateQualificationWithWorker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateQualificationWithWorkerRequest"}, + "output":{"shape":"AssociateQualificationWithWorkerResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The AssociateQualificationWithWorker operation gives a Worker a Qualification. AssociateQualificationWithWorker does not require that the Worker submit a Qualification request. It gives the Qualification directly to the Worker.

You can only assign a Qualification of a Qualification type that you created (using the CreateQualificationType operation).

Note: AssociateQualificationWithWorker does not affect any pending Qualification requests for the Qualification by the Worker. If you assign a Qualification to a Worker, then later grant a Qualification request made by the Worker, the granting of the request may modify the Qualification score. To resolve a pending Qualification request without affecting the Qualification the Worker already has, reject the request with the RejectQualificationRequest operation.

" + }, + "CreateAdditionalAssignmentsForHIT":{ + "name":"CreateAdditionalAssignmentsForHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAdditionalAssignmentsForHITRequest"}, + "output":{"shape":"CreateAdditionalAssignmentsForHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT.

To extend the maximum number of assignments, specify the number of additional assignments.

  • HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception.

  • HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.

" + }, + "CreateHIT":{ + "name":"CreateHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHITRequest"}, + "output":{"shape":"CreateHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateHIT operation creates a new Human Intelligence Task (HIT). The new HIT is made available for Workers to find and accept on the Amazon Mechanical Turk website.

This operation allows you to specify a new HIT by passing in values for the properties of the HIT, such as its title, reward amount and number of assignments. When you pass these values to CreateHIT, a new HIT is created for you, with a new HITTypeID. The HITTypeID can be used to create additional HITs in the future without needing to specify common parameters such as the title, description and reward amount each time.

An alternative way to create HITs is to first generate a HITTypeID using the CreateHITType operation and then call the CreateHITWithHITType operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.

CreateHIT also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.

" + }, + "CreateHITType":{ + "name":"CreateHITType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHITTypeRequest"}, + "output":{"shape":"CreateHITTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateHITType operation creates a new HIT type. This operation allows you to define a standard set of HIT properties to use when creating HITs. If you register a HIT type with values that match an existing HIT type, the HIT type ID of the existing type will be returned.

", + "idempotent":true + }, + "CreateHITWithHITType":{ + "name":"CreateHITWithHITType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHITWithHITTypeRequest"}, + "output":{"shape":"CreateHITWithHITTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateHITWithHITType operation creates a new Human Intelligence Task (HIT) using an existing HITTypeID generated by the CreateHITType operation.

This is an alternative way to create HITs from the CreateHIT operation. This is the recommended best practice for Requesters who are creating large numbers of HITs.

CreateHITWithHITType also supports several ways to provide question data: by providing a value for the Question parameter that fully specifies the contents of the HIT, or by providing a HitLayoutId and associated HitLayoutParameters.

If a HIT is created with 10 or more maximum assignments, there is an additional fee. For more information, see Amazon Mechanical Turk Pricing.

" + }, + "CreateQualificationType":{ + "name":"CreateQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateQualificationTypeRequest"}, + "output":{"shape":"CreateQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateQualificationType operation creates a new Qualification type, which is represented by a QualificationType data structure.

" + }, + "CreateWorkerBlock":{ + "name":"CreateWorkerBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkerBlockRequest"}, + "output":{"shape":"CreateWorkerBlockResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The CreateWorkerBlock operation allows you to prevent a Worker from working on your HITs. For example, you can block a Worker who is producing poor quality work. You can block up to 100,000 Workers.

" + }, + "DeleteHIT":{ + "name":"DeleteHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHITRequest"}, + "output":{"shape":"DeleteHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The DeleteHIT operation is used to delete HIT that is no longer needed. Only the Requester who created the HIT can delete it.

You can only dispose of HITs that are in the Reviewable state, with all of their submitted assignments already either approved or rejected. If you call the DeleteHIT operation on a HIT that is not in the Reviewable state (for example, that has not expired, or still has active assignments), or on a HIT that is Reviewable but without all of its submitted assignments already approved or rejected, the service will return an error.

  • HITs are automatically disposed of after 120 days.

  • After you dispose of a HIT, you can no longer approve the HIT's rejected assignments.

  • Disposed HITs are not returned in results for the ListHITs operation.

  • Disposing HITs can improve the performance of operations such as ListReviewableHITs and ListHITs.

", + "idempotent":true + }, + "DeleteQualificationType":{ + "name":"DeleteQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteQualificationTypeRequest"}, + "output":{"shape":"DeleteQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The DeleteQualificationType deletes a Qualification type and deletes any HIT types that are associated with the Qualification type.

This operation does not revoke Qualifications already assigned to Workers because the Qualifications might be needed for active HITs. If there are any pending requests for the Qualification type, Amazon Mechanical Turk rejects those requests. After you delete a Qualification type, you can no longer use it to create HITs or HIT types.

DeleteQualificationType must wait for all the HITs that use the deleted Qualification type to be deleted before completing. It may take up to 48 hours before DeleteQualificationType completes and the unique name of the Qualification type is available for reuse with CreateQualificationType.

", + "idempotent":true + }, + "DeleteWorkerBlock":{ + "name":"DeleteWorkerBlock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkerBlockRequest"}, + "output":{"shape":"DeleteWorkerBlockResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The DeleteWorkerBlock operation allows you to reinstate a blocked Worker to work on your HITs. This operation reverses the effects of the CreateWorkerBlock operation. You need the Worker ID to use this operation. If the Worker ID is missing or invalid, this operation fails and returns the message “WorkerId is invalid.” If the specified Worker is not blocked, this operation returns successfully.

", + "idempotent":true + }, + "DisassociateQualificationFromWorker":{ + "name":"DisassociateQualificationFromWorker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateQualificationFromWorkerRequest"}, + "output":{"shape":"DisassociateQualificationFromWorkerResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The DisassociateQualificationFromWorker revokes a previously granted Qualification from a user.

You can provide a text message explaining why the Qualification was revoked. The user who had the Qualification can see this message.

" + }, + "GetAccountBalance":{ + "name":"GetAccountBalance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccountBalanceRequest"}, + "output":{"shape":"GetAccountBalanceResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.

", + "idempotent":true + }, + "GetAssignment":{ + "name":"GetAssignment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAssignmentRequest"}, + "output":{"shape":"GetAssignmentResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetAssignment operation retrieves the details of the specified Assignment.

", + "idempotent":true + }, + "GetFileUploadURL":{ + "name":"GetFileUploadURL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFileUploadURLRequest"}, + "output":{"shape":"GetFileUploadURLResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetFileUploadURL operation generates and returns a temporary URL. You use the temporary URL to retrieve a file uploaded by a Worker as an answer to a FileUploadAnswer question for a HIT. The temporary URL is generated the instant the GetFileUploadURL operation is called, and is valid for 60 seconds. You can get a temporary file upload URL any time until the HIT is disposed. After the HIT is disposed, any uploaded files are deleted, and cannot be retrieved. Pending Deprecation on December 12, 2017. The Answer Specification structure will no longer support the FileUploadAnswer element to be used for the QuestionForm data structure. Instead, we recommend that Requesters who want to create HITs asking Workers to upload files to use Amazon S3.

", + "idempotent":true + }, + "GetHIT":{ + "name":"GetHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHITRequest"}, + "output":{"shape":"GetHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetHIT operation retrieves the details of the specified HIT.

", + "idempotent":true + }, + "GetQualificationScore":{ + "name":"GetQualificationScore", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQualificationScoreRequest"}, + "output":{"shape":"GetQualificationScoreResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetQualificationScore operation returns the value of a Worker's Qualification for a given Qualification type.

To get a Worker's Qualification, you must know the Worker's ID. The Worker's ID is included in the assignment data returned by the ListAssignmentsForHIT operation.

Only the owner of a Qualification type can query the value of a Worker's Qualification of that type.

", + "idempotent":true + }, + "GetQualificationType":{ + "name":"GetQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQualificationTypeRequest"}, + "output":{"shape":"GetQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The GetQualificationTypeoperation retrieves information about a Qualification type using its ID.

", + "idempotent":true + }, + "ListAssignmentsForHIT":{ + "name":"ListAssignmentsForHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssignmentsForHITRequest"}, + "output":{"shape":"ListAssignmentsForHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT.

You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation.

Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set.

Only the Requester who created the HIT can retrieve the assignments for that HIT.

Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.

", + "idempotent":true + }, + "ListBonusPayments":{ + "name":"ListBonusPayments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBonusPaymentsRequest"}, + "output":{"shape":"ListBonusPaymentsResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListBonusPayments operation retrieves the amounts of bonuses you have paid to Workers for a given HIT or assignment.

", + "idempotent":true + }, + "ListHITs":{ + "name":"ListHITs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHITsRequest"}, + "output":{"shape":"ListHITsResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListHITs operation returns all of a Requester's HITs. The operation returns HITs of any status, except for HITs that have been deleted of with the DeleteHIT operation or that have been auto-deleted.

", + "idempotent":true + }, + "ListHITsForQualificationType":{ + "name":"ListHITsForQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHITsForQualificationTypeRequest"}, + "output":{"shape":"ListHITsForQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListHITsForQualificationType operation returns the HITs that use the given Qualification type for a Qualification requirement. The operation returns HITs of any status, except for HITs that have been deleted with the DeleteHIT operation or that have been auto-deleted.

", + "idempotent":true + }, + "ListQualificationRequests":{ + "name":"ListQualificationRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQualificationRequestsRequest"}, + "output":{"shape":"ListQualificationRequestsResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListQualificationRequests operation retrieves requests for Qualifications of a particular Qualification type. The owner of the Qualification type calls this operation to poll for pending requests, and accepts them using the AcceptQualification operation.

", + "idempotent":true + }, + "ListQualificationTypes":{ + "name":"ListQualificationTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQualificationTypesRequest"}, + "output":{"shape":"ListQualificationTypesResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListQualificationTypes operation returns a list of Qualification types, filtered by an optional search term.

", + "idempotent":true + }, + "ListReviewPolicyResultsForHIT":{ + "name":"ListReviewPolicyResultsForHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListReviewPolicyResultsForHITRequest"}, + "output":{"shape":"ListReviewPolicyResultsForHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListReviewPolicyResultsForHIT operation retrieves the computed results and the actions taken in the course of executing your Review Policies for a given HIT. For information about how to specify Review Policies when you call CreateHIT, see Review Policies. The ListReviewPolicyResultsForHIT operation can return results for both Assignment-level and HIT-level review results.

", + "idempotent":true + }, + "ListReviewableHITs":{ + "name":"ListReviewableHITs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListReviewableHITsRequest"}, + "output":{"shape":"ListReviewableHITsResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListReviewableHITs operation retrieves the HITs with Status equal to Reviewable or Status equal to Reviewing that belong to the Requester calling the operation.

", + "idempotent":true + }, + "ListWorkerBlocks":{ + "name":"ListWorkerBlocks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkerBlocksRequest"}, + "output":{"shape":"ListWorkerBlocksResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListWorkersBlocks operation retrieves a list of Workers who are blocked from working on your HITs.

", + "idempotent":true + }, + "ListWorkersWithQualificationType":{ + "name":"ListWorkersWithQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkersWithQualificationTypeRequest"}, + "output":{"shape":"ListWorkersWithQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The ListWorkersWithQualificationType operation returns all of the Workers that have been associated with a given Qualification type.

", + "idempotent":true + }, + "NotifyWorkers":{ + "name":"NotifyWorkers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"NotifyWorkersRequest"}, + "output":{"shape":"NotifyWorkersResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The NotifyWorkers operation sends an email to one or more Workers that you specify with the Worker ID. You can specify up to 100 Worker IDs to send the same message with a single call to the NotifyWorkers operation. The NotifyWorkers operation will send a notification email to a Worker only if you have previously approved or rejected work from the Worker.

" + }, + "RejectAssignment":{ + "name":"RejectAssignment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectAssignmentRequest"}, + "output":{"shape":"RejectAssignmentResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The RejectAssignment operation rejects the results of a completed assignment.

You can include an optional feedback message with the rejection, which the Worker can see in the Status section of the web site. When you include a feedback message with the rejection, it helps the Worker understand why the assignment was rejected, and can improve the quality of the results the Worker submits in the future.

Only the Requester who created the HIT can reject an assignment for the HIT.

", + "idempotent":true + }, + "RejectQualificationRequest":{ + "name":"RejectQualificationRequest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectQualificationRequestRequest"}, + "output":{"shape":"RejectQualificationRequestResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The RejectQualificationRequest operation rejects a user's request for a Qualification.

You can provide a text message explaining why the request was rejected. The Worker who made the request can see this message.

" + }, + "SendBonus":{ + "name":"SendBonus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendBonusRequest"}, + "output":{"shape":"SendBonusResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees.

" + }, + "SendTestEventNotification":{ + "name":"SendTestEventNotification", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTestEventNotificationRequest"}, + "output":{"shape":"SendTestEventNotificationResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The SendTestEventNotification operation causes Amazon Mechanical Turk to send a notification message as if a HIT event occurred, according to the provided notification specification. This allows you to test notifications without setting up notifications for a real HIT type and trying to trigger them using the website. When you call this operation, the service attempts to send the test notification immediately.

" + }, + "UpdateExpirationForHIT":{ + "name":"UpdateExpirationForHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateExpirationForHITRequest"}, + "output":{"shape":"UpdateExpirationForHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The UpdateExpirationForHIT operation allows you update the expiration time of a HIT. If you update it to a time in the past, the HIT will be immediately expired.

", + "idempotent":true + }, + "UpdateHITReviewStatus":{ + "name":"UpdateHITReviewStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateHITReviewStatusRequest"}, + "output":{"shape":"UpdateHITReviewStatusResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The UpdateHITReviewStatus operation updates the status of a HIT. If the status is Reviewable, this operation can update the status to Reviewing, or it can revert a Reviewing HIT back to the Reviewable status.

", + "idempotent":true + }, + "UpdateHITTypeOfHIT":{ + "name":"UpdateHITTypeOfHIT", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateHITTypeOfHITRequest"}, + "output":{"shape":"UpdateHITTypeOfHITResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The UpdateHITTypeOfHIT operation allows you to change the HITType properties of a HIT. This operation disassociates the HIT from its old HITType properties and associates it with the new HITType properties. The HIT takes on the properties of the new HITType in place of the old ones.

", + "idempotent":true + }, + "UpdateNotificationSettings":{ + "name":"UpdateNotificationSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNotificationSettingsRequest"}, + "output":{"shape":"UpdateNotificationSettingsResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The UpdateNotificationSettings operation creates, updates, disables or re-enables notifications for a HIT type. If you call the UpdateNotificationSettings operation for a HIT type that already has a notification specification, the operation replaces the old specification with a new one. You can call the UpdateNotificationSettings operation to enable or disable notifications for the HIT type, without having to modify the notification specification itself by providing updates to the Active status without specifying a new notification specification. To change the Active status of a HIT type's notifications, the HIT type must already have a notification specification, or one must be provided in the same call to UpdateNotificationSettings.

", + "idempotent":true + }, + "UpdateQualificationType":{ + "name":"UpdateQualificationType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateQualificationTypeRequest"}, + "output":{"shape":"UpdateQualificationTypeResponse"}, + "errors":[ + {"shape":"ServiceFault"}, + {"shape":"RequestError"} + ], + "documentation":"

The UpdateQualificationType operation modifies the attributes of an existing Qualification type, which is represented by a QualificationType data structure. Only the owner of a Qualification type can modify its attributes.

Most attributes of a Qualification type can be changed after the type has been created. However, the Name and Keywords fields cannot be modified. The RetryDelayInSeconds parameter can be modified or added to change the delay or to enable retries, but RetryDelayInSeconds cannot be used to disable retries.

You can use this operation to update the test for a Qualification type. The test is updated based on the values specified for the Test, TestDurationInSeconds and AnswerKey parameters. All three parameters specify the updated test. If you are updating the test for a type, you must specify the Test and TestDurationInSeconds parameters. The AnswerKey parameter is optional; omitting it specifies that the updated test does not have an answer key.

If you omit the Test parameter, the test for the Qualification type is unchanged. There is no way to remove a test from a Qualification type that has one. If the type already has a test, you cannot update it to be AutoGranted. If the Qualification type does not have a test and one is provided by an update, the type will henceforth have a test.

If you want to update the test duration or answer key for an existing test without changing the questions, you must specify a Test parameter with the original questions, along with the updated values.

If you provide an updated Test but no AnswerKey, the new test will not have an answer key. Requests for such Qualifications must be granted manually.

You can also update the AutoGranted and AutoGrantedValue attributes of the Qualification type.

" + } + }, + "shapes":{ + "AcceptQualificationRequestRequest":{ + "type":"structure", + "required":["QualificationRequestId"], + "members":{ + "QualificationRequestId":{ + "shape":"String", + "documentation":"

The ID of the Qualification request, as returned by the GetQualificationRequests operation.

" + }, + "IntegerValue":{ + "shape":"Integer", + "documentation":"

The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement.

" + } + } + }, + "AcceptQualificationRequestResponse":{ + "type":"structure", + "members":{ + } + }, + "ApproveAssignmentRequest":{ + "type":"structure", + "required":["AssignmentId"], + "members":{ + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

" + }, + "RequesterFeedback":{ + "shape":"String", + "documentation":"

A message for the Worker, which the Worker can see in the Status section of the web site.

" + }, + "OverrideRejection":{ + "shape":"Boolean", + "documentation":"

A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.

" + } + } + }, + "ApproveAssignmentResponse":{ + "type":"structure", + "members":{ + } + }, + "Assignment":{ + "type":"structure", + "members":{ + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

A unique identifier for the assignment.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker who accepted the HIT.

" + }, + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT.

" + }, + "AssignmentStatus":{ + "shape":"AssignmentStatus", + "documentation":"

The status of the assignment.

" + }, + "AutoApprovalTime":{ + "shape":"Timestamp", + "documentation":"

If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.

" + }, + "AcceptTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the Worker accepted the assignment.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.

" + }, + "ApprovalTime":{ + "shape":"Timestamp", + "documentation":"

If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.

" + }, + "RejectionTime":{ + "shape":"Timestamp", + "documentation":"

If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

" + }, + "Deadline":{ + "shape":"Timestamp", + "documentation":"

The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.

" + }, + "Answer":{ + "shape":"String", + "documentation":"

The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.

" + }, + "RequesterFeedback":{ + "shape":"String", + "documentation":"

The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.

" + } + }, + "documentation":"

The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker's efforts to complete the HIT, and contains the results for later retrieval.

" + }, + "AssignmentList":{ + "type":"list", + "member":{"shape":"Assignment"} + }, + "AssignmentStatus":{ + "type":"string", + "enum":[ + "Submitted", + "Approved", + "Rejected" + ] + }, + "AssignmentStatusList":{ + "type":"list", + "member":{"shape":"AssignmentStatus"} + }, + "AssociateQualificationWithWorkerRequest":{ + "type":"structure", + "required":[ + "QualificationTypeId", + "WorkerId" + ], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type to use for the assigned Qualification.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.

" + }, + "IntegerValue":{ + "shape":"Integer", + "documentation":"

The value of the Qualification to assign.

" + }, + "SendNotification":{ + "shape":"Boolean", + "documentation":"

Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default.

" + } + } + }, + "AssociateQualificationWithWorkerResponse":{ + "type":"structure", + "members":{ + } + }, + "BonusPayment":{ + "type":"structure", + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker to whom the bonus was paid.

" + }, + "BonusAmount":{"shape":"CurrencyAmount"}, + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment associated with this bonus payment.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

The Reason text given when the bonus was granted, if any.

" + }, + "GrantTime":{ + "shape":"Timestamp", + "documentation":"

The date and time of when the bonus was granted.

" + } + }, + "documentation":"

An object representing a Bonus payment paid to a Worker.

" + }, + "BonusPaymentList":{ + "type":"list", + "member":{"shape":"BonusPayment"} + }, + "Boolean":{"type":"boolean"}, + "Comparator":{ + "type":"string", + "enum":[ + "LessThan", + "LessThanOrEqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "EqualTo", + "NotEqualTo", + "Exists", + "DoesNotExist", + "In", + "NotIn" + ] + }, + "CountryParameters":{ + "type":"string", + "max":2, + "min":2 + }, + "CreateAdditionalAssignmentsForHITRequest":{ + "type":"structure", + "required":[ + "HITId", + "NumberOfAdditionalAssignments" + ], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT to extend.

" + }, + "NumberOfAdditionalAssignments":{ + "shape":"Integer", + "documentation":"

The number of additional assignments to request for this HIT.

" + }, + "UniqueRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

" + } + } + }, + "CreateAdditionalAssignmentsForHITResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateHITRequest":{ + "type":"structure", + "required":[ + "LifetimeInSeconds", + "AssignmentDurationInSeconds", + "Reward", + "Title", + "Description" + ], + "members":{ + "MaxAssignments":{ + "shape":"Integer", + "documentation":"

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

" + }, + "AutoApprovalDelayInSeconds":{ + "shape":"Long", + "documentation":"

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

" + }, + "LifetimeInSeconds":{ + "shape":"Long", + "documentation":"

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

" + }, + "AssignmentDurationInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

" + }, + "Reward":{ + "shape":"CurrencyAmount", + "documentation":"

The amount of money the Requester will pay a Worker for successfully completing the HIT.

" + }, + "Title":{ + "shape":"String", + "documentation":"

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

" + }, + "Keywords":{ + "shape":"String", + "documentation":"

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

" + }, + "Question":{ + "shape":"String", + "documentation":"

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

" + }, + "RequesterAnnotation":{ + "shape":"String", + "documentation":"

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

" + }, + "QualificationRequirements":{ + "shape":"QualificationRequirementList", + "documentation":"

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

" + }, + "UniqueRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

" + }, + "AssignmentReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

" + }, + "HITReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

" + }, + "HITLayoutId":{ + "shape":"EntityId", + "documentation":"

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

" + }, + "HITLayoutParameters":{ + "shape":"HITLayoutParameterList", + "documentation":"

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

" + } + } + }, + "CreateHITResponse":{ + "type":"structure", + "members":{ + "HIT":{ + "shape":"HIT", + "documentation":"

Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.

" + } + } + }, + "CreateHITTypeRequest":{ + "type":"structure", + "required":[ + "AssignmentDurationInSeconds", + "Reward", + "Title", + "Description" + ], + "members":{ + "AutoApprovalDelayInSeconds":{ + "shape":"Long", + "documentation":"

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

" + }, + "AssignmentDurationInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

" + }, + "Reward":{ + "shape":"CurrencyAmount", + "documentation":"

The amount of money the Requester will pay a Worker for successfully completing the HIT.

" + }, + "Title":{ + "shape":"String", + "documentation":"

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

" + }, + "Keywords":{ + "shape":"String", + "documentation":"

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

" + }, + "QualificationRequirements":{ + "shape":"QualificationRequirementList", + "documentation":"

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

" + } + } + }, + "CreateHITTypeResponse":{ + "type":"structure", + "members":{ + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the newly registered HIT type.

" + } + } + }, + "CreateHITWithHITTypeRequest":{ + "type":"structure", + "required":[ + "HITTypeId", + "LifetimeInSeconds" + ], + "members":{ + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The HIT type ID you want to create this HIT with.

" + }, + "MaxAssignments":{ + "shape":"Integer", + "documentation":"

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

" + }, + "LifetimeInSeconds":{ + "shape":"Long", + "documentation":"

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

" + }, + "Question":{ + "shape":"String", + "documentation":"

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

" + }, + "RequesterAnnotation":{ + "shape":"String", + "documentation":"

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

" + }, + "UniqueRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

" + }, + "AssignmentReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

" + }, + "HITReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

" + }, + "HITLayoutId":{ + "shape":"EntityId", + "documentation":"

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

" + }, + "HITLayoutParameters":{ + "shape":"HITLayoutParameterList", + "documentation":"

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

" + } + } + }, + "CreateHITWithHITTypeResponse":{ + "type":"structure", + "members":{ + "HIT":{ + "shape":"HIT", + "documentation":"

Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.

" + } + } + }, + "CreateQualificationTypeRequest":{ + "type":"structure", + "required":[ + "Name", + "Description", + "QualificationTypeStatus" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.

" + }, + "Keywords":{ + "shape":"String", + "documentation":"

One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.

" + }, + "QualificationTypeStatus":{ + "shape":"QualificationTypeStatus", + "documentation":"

The initial status of the Qualification type.

Constraints: Valid values are: Active | Inactive

" + }, + "RetryDelayInSeconds":{ + "shape":"Long", + "documentation":"

The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.

Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.

" + }, + "Test":{ + "shape":"String", + "documentation":"

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

" + }, + "AnswerKey":{ + "shape":"String", + "documentation":"

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

Constraints: Must not be longer than 65535 bytes.

Constraints: None. If not specified, you must process Qualification requests manually.

" + }, + "TestDurationInSeconds":{ + "shape":"Long", + "documentation":"

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

" + }, + "AutoGranted":{ + "shape":"Boolean", + "documentation":"

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

" + }, + "AutoGrantedValue":{ + "shape":"Integer", + "documentation":"

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

" + } + } + }, + "CreateQualificationTypeResponse":{ + "type":"structure", + "members":{ + "QualificationType":{ + "shape":"QualificationType", + "documentation":"

The created Qualification type, returned as a QualificationType data structure.

" + } + } + }, + "CreateWorkerBlockRequest":{ + "type":"structure", + "required":[ + "WorkerId", + "Reason" + ], + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker to block.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.

" + } + } + }, + "CreateWorkerBlockResponse":{ + "type":"structure", + "members":{ + } + }, + "CurrencyAmount":{ + "type":"string", + "documentation":"

A string representing a currency amount.

", + "pattern":"^[0-9]+(\\.)?[0-9]{0,2}$" + }, + "CustomerId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^A[A-Z0-9]+$" + }, + "CustomerIdList":{ + "type":"list", + "member":{"shape":"CustomerId"} + }, + "DeleteHITRequest":{ + "type":"structure", + "required":["HITId"], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT to be deleted.

" + } + } + }, + "DeleteHITResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteQualificationTypeRequest":{ + "type":"structure", + "required":["QualificationTypeId"], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the QualificationType to dispose.

" + } + } + }, + "DeleteQualificationTypeResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkerBlockRequest":{ + "type":"structure", + "required":["WorkerId"], + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker to unblock.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A message that explains the reason for unblocking the Worker. The Worker does not see this message.

" + } + } + }, + "DeleteWorkerBlockResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateQualificationFromWorkerRequest":{ + "type":"structure", + "required":[ + "WorkerId", + "QualificationTypeId" + ], + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker who possesses the Qualification to be revoked.

" + }, + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type of the Qualification to be revoked.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.

" + } + } + }, + "DisassociateQualificationFromWorkerResponse":{ + "type":"structure", + "members":{ + } + }, + "EntityId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[A-Z0-9]+$" + }, + "EventType":{ + "type":"string", + "enum":[ + "AssignmentAccepted", + "AssignmentAbandoned", + "AssignmentReturned", + "AssignmentSubmitted", + "AssignmentRejected", + "AssignmentApproved", + "HITCreated", + "HITExpired", + "HITReviewable", + "HITExtended", + "HITDisposed", + "Ping" + ] + }, + "EventTypeList":{ + "type":"list", + "member":{"shape":"EventType"} + }, + "ExceptionMessage":{"type":"string"}, + "GetAccountBalanceRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAccountBalanceResponse":{ + "type":"structure", + "members":{ + "AvailableBalance":{"shape":"CurrencyAmount"}, + "OnHoldBalance":{"shape":"CurrencyAmount"} + } + }, + "GetAssignmentRequest":{ + "type":"structure", + "required":["AssignmentId"], + "members":{ + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the Assignment to be retrieved.

" + } + } + }, + "GetAssignmentResponse":{ + "type":"structure", + "members":{ + "Assignment":{ + "shape":"Assignment", + "documentation":"

The assignment. The response includes one Assignment element.

" + }, + "HIT":{ + "shape":"HIT", + "documentation":"

The HIT associated with this assignment. The response includes one HIT element.

" + } + } + }, + "GetFileUploadURLRequest":{ + "type":"structure", + "required":[ + "AssignmentId", + "QuestionIdentifier" + ], + "members":{ + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment that contains the question with a FileUploadAnswer.

" + }, + "QuestionIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the question with a FileUploadAnswer, as specified in the QuestionForm of the HIT.

" + } + } + }, + "GetFileUploadURLResponse":{ + "type":"structure", + "members":{ + "FileUploadURL":{ + "shape":"String", + "documentation":"

A temporary URL for the file that the Worker uploaded for the answer.

" + } + } + }, + "GetHITRequest":{ + "type":"structure", + "required":["HITId"], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT to be retrieved.

" + } + } + }, + "GetHITResponse":{ + "type":"structure", + "members":{ + "HIT":{ + "shape":"HIT", + "documentation":"

Contains the requested HIT data.

" + } + } + }, + "GetQualificationScoreRequest":{ + "type":"structure", + "required":[ + "QualificationTypeId", + "WorkerId" + ], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the QualificationType.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker whose Qualification is being updated.

" + } + } + }, + "GetQualificationScoreResponse":{ + "type":"structure", + "members":{ + "Qualification":{ + "shape":"Qualification", + "documentation":"

The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score).

" + } + } + }, + "GetQualificationTypeRequest":{ + "type":"structure", + "required":["QualificationTypeId"], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the QualificationType.

" + } + } + }, + "GetQualificationTypeResponse":{ + "type":"structure", + "members":{ + "QualificationType":{ + "shape":"QualificationType", + "documentation":"

The returned Qualification Type

" + } + } + }, + "HIT":{ + "type":"structure", + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

A unique identifier for the HIT.

" + }, + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT type of this HIT

" + }, + "HITGroupId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT Group of this HIT.

" + }, + "HITLayoutId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT Layout of this HIT.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the HIT was created.

" + }, + "Title":{ + "shape":"String", + "documentation":"

The title of the HIT.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A general description of the HIT.

" + }, + "Question":{ + "shape":"String", + "documentation":"

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

" + }, + "Keywords":{ + "shape":"String", + "documentation":"

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

" + }, + "HITStatus":{ + "shape":"HITStatus", + "documentation":"

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

" + }, + "MaxAssignments":{ + "shape":"Integer", + "documentation":"

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

" + }, + "Reward":{"shape":"CurrencyAmount"}, + "AutoApprovalDelayInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

" + }, + "Expiration":{ + "shape":"Timestamp", + "documentation":"

The date and time the HIT expires.

" + }, + "AssignmentDurationInSeconds":{ + "shape":"Long", + "documentation":"

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

" + }, + "RequesterAnnotation":{ + "shape":"String", + "documentation":"

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

" + }, + "QualificationRequirements":{ + "shape":"QualificationRequirementList", + "documentation":"

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

" + }, + "HITReviewStatus":{ + "shape":"HITReviewStatus", + "documentation":"

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

" + }, + "NumberOfAssignmentsPending":{ + "shape":"Integer", + "documentation":"

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

" + }, + "NumberOfAssignmentsAvailable":{ + "shape":"Integer", + "documentation":"

The number of assignments for this HIT that are available for Workers to accept.

" + }, + "NumberOfAssignmentsCompleted":{ + "shape":"Integer", + "documentation":"

The number of assignments for this HIT that have been approved or rejected.

" + } + }, + "documentation":"

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.

" + }, + "HITAccessActions":{ + "type":"string", + "enum":[ + "Accept", + "PreviewAndAccept", + "DiscoverPreviewAndAccept" + ] + }, + "HITLayoutParameter":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the parameter in the HITLayout.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The value substituted for the parameter referenced in the HITLayout.

" + } + }, + "documentation":"

The HITLayoutParameter data structure defines parameter values used with a HITLayout. A HITLayout is a reusable Amazon Mechanical Turk project template used to provide Human Intelligence Task (HIT) question data for CreateHIT.

" + }, + "HITLayoutParameterList":{ + "type":"list", + "member":{"shape":"HITLayoutParameter"} + }, + "HITList":{ + "type":"list", + "member":{"shape":"HIT"} + }, + "HITReviewStatus":{ + "type":"string", + "enum":[ + "NotReviewed", + "MarkedForReview", + "ReviewedAppropriate", + "ReviewedInappropriate" + ] + }, + "HITStatus":{ + "type":"string", + "enum":[ + "Assignable", + "Unassignable", + "Reviewable", + "Reviewing", + "Disposed" + ] + }, + "IdempotencyToken":{ + "type":"string", + "max":64, + "min":1 + }, + "Integer":{"type":"integer"}, + "IntegerList":{ + "type":"list", + "member":{"shape":"Integer"} + }, + "ListAssignmentsForHITRequest":{ + "type":"structure", + "required":["HITId"], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination token

" + }, + "MaxResults":{"shape":"ResultSize"}, + "AssignmentStatuses":{ + "shape":"AssignmentStatusList", + "documentation":"

The status of the assignments to return: Submitted | Approved | Rejected

" + } + } + }, + "ListAssignmentsForHITResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

" + }, + "Assignments":{ + "shape":"AssignmentList", + "documentation":"

The collection of Assignment data structures returned by this call.

" + } + } + }, + "ListBonusPaymentsRequest":{ + "type":"structure", + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified

" + }, + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination token

" + }, + "MaxResults":{"shape":"ResultSize"} + } + }, + "ListBonusPaymentsResponse":{ + "type":"structure", + "members":{ + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call.

" + }, + "NextToken":{"shape":"PaginationToken"}, + "BonusPayments":{ + "shape":"BonusPaymentList", + "documentation":"

A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.

" + } + } + }, + "ListHITsForQualificationTypeRequest":{ + "type":"structure", + "required":["QualificationTypeId"], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type to use when querying HITs.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination Token

" + }, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

Limit the number of results returned.

" + } + } + }, + "ListHITsForQualificationTypeResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

" + }, + "HITs":{ + "shape":"HITList", + "documentation":"

The list of HIT elements returned by the query.

" + } + } + }, + "ListHITsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination token

" + }, + "MaxResults":{"shape":"ResultSize"} + } + }, + "ListHITsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

" + }, + "HITs":{ + "shape":"HITList", + "documentation":"

The list of HIT elements returned by the query.

" + } + } + }, + "ListQualificationRequestsRequest":{ + "type":"structure", + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the QualificationType.

" + }, + "NextToken":{"shape":"PaginationToken"}, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

The maximum number of results to return in a single call.

" + } + } + }, + "ListQualificationRequestsResponse":{ + "type":"structure", + "members":{ + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.

" + }, + "NextToken":{"shape":"PaginationToken"}, + "QualificationRequests":{ + "shape":"QualificationRequestList", + "documentation":"

The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.

" + } + } + }, + "ListQualificationTypesRequest":{ + "type":"structure", + "required":["MustBeRequestable"], + "members":{ + "Query":{ + "shape":"String", + "documentation":"

A text query against all of the searchable attributes of Qualification types.

" + }, + "MustBeRequestable":{ + "shape":"Boolean", + "documentation":"

Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.

" + }, + "MustBeOwnedByCaller":{ + "shape":"Boolean", + "documentation":"

Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.

" + }, + "NextToken":{"shape":"PaginationToken"}, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

The maximum number of results to return in a single call.

" + } + } + }, + "ListQualificationTypesResponse":{ + "type":"structure", + "members":{ + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.

" + }, + "NextToken":{"shape":"PaginationToken"}, + "QualificationTypes":{ + "shape":"QualificationTypeList", + "documentation":"

The list of QualificationType elements returned by the query.

" + } + } + }, + "ListReviewPolicyResultsForHITRequest":{ + "type":"structure", + "required":["HITId"], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The unique identifier of the HIT to retrieve review results for.

" + }, + "PolicyLevels":{ + "shape":"ReviewPolicyLevelList", + "documentation":"

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

" + }, + "RetrieveActions":{ + "shape":"Boolean", + "documentation":"

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

" + }, + "RetrieveResults":{ + "shape":"Boolean", + "documentation":"

Specify if the operation should retrieve a list of the results computed by the Review Policies.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination token

" + }, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

Limit the number of results returned.

" + } + } + }, + "ListReviewPolicyResultsForHITResponse":{ + "type":"structure", + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The HITId of the HIT for which results have been returned.

" + }, + "AssignmentReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The name of the Assignment-level Review Policy. This contains only the PolicyName element.

" + }, + "HITReviewPolicy":{ + "shape":"ReviewPolicy", + "documentation":"

The name of the HIT-level Review Policy. This contains only the PolicyName element.

" + }, + "AssignmentReviewReport":{ + "shape":"ReviewReport", + "documentation":"

Contains both ReviewResult and ReviewAction elements for an Assignment.

" + }, + "HITReviewReport":{ + "shape":"ReviewReport", + "documentation":"

Contains both ReviewResult and ReviewAction elements for a particular HIT.

" + }, + "NextToken":{"shape":"PaginationToken"} + } + }, + "ListReviewableHITsRequest":{ + "type":"structure", + "members":{ + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered

" + }, + "Status":{ + "shape":"ReviewableHITStatus", + "documentation":"

Can be either Reviewable or Reviewing. Reviewable is the default value.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination Token

" + }, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

Limit the number of results returned.

" + } + } + }, + "ListReviewableHITsResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.

" + }, + "HITs":{ + "shape":"HITList", + "documentation":"

The list of HIT elements returned by the query.

" + } + } + }, + "ListWorkerBlocksRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination token

" + }, + "MaxResults":{"shape":"ResultSize"} + } + }, + "ListWorkerBlocksResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

" + }, + "WorkerBlocks":{ + "shape":"WorkerBlockList", + "documentation":"

The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.

" + } + } + }, + "ListWorkersWithQualificationTypeRequest":{ + "type":"structure", + "required":["QualificationTypeId"], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type of the Qualifications to return.

" + }, + "Status":{ + "shape":"QualificationStatus", + "documentation":"

The status of the Qualifications to return. Can be Granted | Revoked.

" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

Pagination Token

" + }, + "MaxResults":{ + "shape":"ResultSize", + "documentation":"

Limit the number of results returned.

" + } + } + }, + "ListWorkersWithQualificationTypeResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"PaginationToken"}, + "NumResults":{ + "shape":"Integer", + "documentation":"

The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.

" + }, + "Qualifications":{ + "shape":"QualificationList", + "documentation":"

The list of Qualification elements returned by this call.

" + } + } + }, + "Locale":{ + "type":"structure", + "required":["Country"], + "members":{ + "Country":{ + "shape":"CountryParameters", + "documentation":"

The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America.

" + }, + "Subdivision":{ + "shape":"CountryParameters", + "documentation":"

The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington.

" + } + }, + "documentation":"

The Locale data structure represents a geographical region or location.

" + }, + "LocaleList":{ + "type":"list", + "member":{"shape":"Locale"} + }, + "Long":{"type":"long"}, + "NotificationSpecification":{ + "type":"structure", + "required":[ + "Destination", + "Transport", + "Version", + "EventTypes" + ], + "members":{ + "Destination":{ + "shape":"String", + "documentation":"

The target for notification messages. The Destination’s format is determined by the specified Transport:

  • When Transport is Email, the Destination is your email address.

  • When Transport is SQS, the Destination is your queue URL.

  • When Transport is SNS, the Destination is the ARN of your topic.

" + }, + "Transport":{ + "shape":"NotificationTransport", + "documentation":"

The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The version of the Notification API to use. Valid value is 2006-05-05.

" + }, + "EventTypes":{ + "shape":"EventTypeList", + "documentation":"

The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.

" + } + }, + "documentation":"

The NotificationSpecification data structure describes a HIT event notification for a HIT type.

" + }, + "NotificationTransport":{ + "type":"string", + "enum":[ + "Email", + "SQS", + "SNS" + ] + }, + "NotifyWorkersFailureCode":{ + "type":"string", + "enum":[ + "SoftFailure", + "HardFailure" + ] + }, + "NotifyWorkersFailureStatus":{ + "type":"structure", + "members":{ + "NotifyWorkersFailureCode":{ + "shape":"NotifyWorkersFailureCode", + "documentation":"

Encoded value for the failure type.

" + }, + "NotifyWorkersFailureMessage":{ + "shape":"String", + "documentation":"

A message detailing the reason the Worker could not be notified.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker.

" + } + }, + "documentation":"

When MTurk encounters an issue with notifying the Workers you specified, it returns back this object with failure details.

" + }, + "NotifyWorkersFailureStatusList":{ + "type":"list", + "member":{"shape":"NotifyWorkersFailureStatus"} + }, + "NotifyWorkersRequest":{ + "type":"structure", + "required":[ + "Subject", + "MessageText", + "WorkerIds" + ], + "members":{ + "Subject":{ + "shape":"String", + "documentation":"

The subject line of the email message to send. Can include up to 200 characters.

" + }, + "MessageText":{ + "shape":"String", + "documentation":"

The text of the email message to send. Can include up to 4,096 characters

" + }, + "WorkerIds":{ + "shape":"CustomerIdList", + "documentation":"

A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.

" + } + } + }, + "NotifyWorkersResponse":{ + "type":"structure", + "members":{ + "NotifyWorkersFailureStatuses":{ + "shape":"NotifyWorkersFailureStatusList", + "documentation":"

When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.

" + } + } + }, + "PaginationToken":{ + "type":"string", + "documentation":"

If the previous response was incomplete (because there is more data to retrieve), Amazon Mechanical Turk returns a pagination token in the response. You can use this pagination token to retrieve the next set of results.

", + "max":255, + "min":1 + }, + "ParameterMapEntry":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy.

" + }, + "Values":{ + "shape":"StringList", + "documentation":"

The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly.

" + } + }, + "documentation":"

This data structure is the data type for the AnswerKey parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy.

" + }, + "ParameterMapEntryList":{ + "type":"list", + "member":{"shape":"ParameterMapEntry"} + }, + "PolicyParameter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

Name of the parameter from the list of Review Polices.

" + }, + "Values":{ + "shape":"StringList", + "documentation":"

The list of values of the Parameter

" + }, + "MapEntries":{ + "shape":"ParameterMapEntryList", + "documentation":"

List of ParameterMapEntry objects.

" + } + }, + "documentation":"

Name of the parameter from the Review policy.

" + }, + "PolicyParameterList":{ + "type":"list", + "member":{"shape":"PolicyParameter"} + }, + "Qualification":{ + "type":"structure", + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type for the Qualification.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker who possesses the Qualification.

" + }, + "GrantTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation.

" + }, + "IntegerValue":{ + "shape":"Integer", + "documentation":"

The value (score) of the Qualification, if the Qualification has an integer value.

" + }, + "LocaleValue":{"shape":"Locale"}, + "Status":{ + "shape":"QualificationStatus", + "documentation":"

The status of the Qualification. Valid values are Granted | Revoked.

" + } + }, + "documentation":"

The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).

" + }, + "QualificationList":{ + "type":"list", + "member":{"shape":"Qualification"} + }, + "QualificationRequest":{ + "type":"structure", + "members":{ + "QualificationRequestId":{ + "shape":"String", + "documentation":"

The ID of the Qualification request, a unique identifier generated when the request was submitted.

" + }, + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.

" + }, + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker requesting the Qualification.

" + }, + "Test":{ + "shape":"String", + "documentation":"

The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.

" + }, + "Answer":{ + "shape":"String", + "documentation":"

The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.

" + }, + "SubmitTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.

" + } + }, + "documentation":"

The QualificationRequest data structure represents a request a Worker has made for a Qualification.

" + }, + "QualificationRequestList":{ + "type":"list", + "member":{"shape":"QualificationRequest"} + }, + "QualificationRequirement":{ + "type":"structure", + "required":[ + "QualificationTypeId", + "Comparator" + ], + "members":{ + "QualificationTypeId":{ + "shape":"String", + "documentation":"

The ID of the Qualification type for the requirement.

" + }, + "Comparator":{ + "shape":"Comparator", + "documentation":"

The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value.

" + }, + "IntegerValues":{ + "shape":"IntegerList", + "documentation":"

The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.

" + }, + "LocaleValues":{ + "shape":"LocaleList", + "documentation":"

The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure.

" + }, + "RequiredToPreview":{ + "shape":"Boolean", + "documentation":"

DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default is false. This should not be used in combination with the ActionsGuarded field.

", + "deprecated":true + }, + "ActionsGuarded":{ + "shape":"HITAccessActions", + "documentation":"

Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from taking the specified action. Valid arguments include \"Accept\" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results), \"PreviewAndAccept\" (Worker cannot accept or preview the HIT, but can see the HIT in their search results), and \"DiscoverPreviewAndAccept\" (Worker cannot accept, preview, or see the HIT in their search results). It's possible for you to create a HIT with multiple QualificationRequirements (which can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform an action when they have met all QualificationRequirements guarding the action. The actions in the order of least restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the HIT in their search result, but will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the RequiredToPreview field.

" + } + }, + "documentation":"

The QualificationRequirement data structure describes a Qualification that a Worker must have before the Worker is allowed to accept a HIT. A requirement may optionally state that a Worker must have the Qualification in order to preview the HIT, or see the HIT in search results.

" + }, + "QualificationRequirementList":{ + "type":"list", + "member":{"shape":"QualificationRequirement"} + }, + "QualificationStatus":{ + "type":"string", + "enum":[ + "Granted", + "Revoked" + ] + }, + "QualificationType":{ + "type":"structure", + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.

" + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

The date and time the Qualification type was created.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A long description for the Qualification type.

" + }, + "Keywords":{ + "shape":"String", + "documentation":"

One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.

" + }, + "QualificationTypeStatus":{ + "shape":"QualificationTypeStatus", + "documentation":"

The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.

" + }, + "Test":{ + "shape":"String", + "documentation":"

The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.

" + }, + "TestDurationInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.

" + }, + "AnswerKey":{ + "shape":"String", + "documentation":"

The answers to the Qualification test specified in the Test parameter.

" + }, + "RetryDelayInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.

" + }, + "IsRequestable":{ + "shape":"Boolean", + "documentation":"

Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.

" + }, + "AutoGranted":{ + "shape":"Boolean", + "documentation":"

Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.

" + }, + "AutoGrantedValue":{ + "shape":"Integer", + "documentation":"

The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.

" + } + }, + "documentation":"

The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test.

" + }, + "QualificationTypeList":{ + "type":"list", + "member":{"shape":"QualificationType"} + }, + "QualificationTypeStatus":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "RejectAssignmentRequest":{ + "type":"structure", + "required":[ + "AssignmentId", + "RequesterFeedback" + ], + "members":{ + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment. The assignment must correspond to a HIT created by the Requester.

" + }, + "RequesterFeedback":{ + "shape":"String", + "documentation":"

A message for the Worker, which the Worker can see in the Status section of the web site.

" + } + } + }, + "RejectAssignmentResponse":{ + "type":"structure", + "members":{ + } + }, + "RejectQualificationRequestRequest":{ + "type":"structure", + "required":["QualificationRequestId"], + "members":{ + "QualificationRequestId":{ + "shape":"String", + "documentation":"

The ID of the Qualification request, as returned by the ListQualificationRequests operation.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A text message explaining why the request was rejected, to be shown to the Worker who made the request.

" + } + } + }, + "RejectQualificationRequestResponse":{ + "type":"structure", + "members":{ + } + }, + "RequestError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "TurkErrorCode":{"shape":"TurkErrorCode"} + }, + "documentation":"

Your request is invalid.

", + "exception":true + }, + "ResultSize":{ + "type":"integer", + "max":100, + "min":1 + }, + "ReviewActionDetail":{ + "type":"structure", + "members":{ + "ActionId":{ + "shape":"EntityId", + "documentation":"

The unique identifier for the action.

" + }, + "ActionName":{ + "shape":"String", + "documentation":"

The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.

" + }, + "TargetId":{ + "shape":"EntityId", + "documentation":"

The specific HITId or AssignmentID targeted by the action.

" + }, + "TargetType":{ + "shape":"String", + "documentation":"

The type of object in TargetId.

" + }, + "Status":{ + "shape":"ReviewActionStatus", + "documentation":"

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

" + }, + "CompleteTime":{ + "shape":"Timestamp", + "documentation":"

The date when the action was completed.

" + }, + "Result":{ + "shape":"String", + "documentation":"

A description of the outcome of the review.

" + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

Present only when the Results have a FAILED Status.

" + } + }, + "documentation":"

Both the AssignmentReviewReport and the HITReviewReport elements contains the ReviewActionDetail data structure. This structure is returned multiple times for each action specified in the Review Policy.

" + }, + "ReviewActionDetailList":{ + "type":"list", + "member":{"shape":"ReviewActionDetail"} + }, + "ReviewActionStatus":{ + "type":"string", + "enum":[ + "Intended", + "Succeeded", + "Failed", + "Cancelled" + ] + }, + "ReviewPolicy":{ + "type":"structure", + "required":["PolicyName"], + "members":{ + "PolicyName":{ + "shape":"String", + "documentation":"

Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01

" + }, + "Parameters":{ + "shape":"PolicyParameterList", + "documentation":"

Name of the parameter from the Review policy.

" + } + }, + "documentation":"

HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.

" + }, + "ReviewPolicyLevel":{ + "type":"string", + "enum":[ + "Assignment", + "HIT" + ] + }, + "ReviewPolicyLevelList":{ + "type":"list", + "member":{"shape":"ReviewPolicyLevel"} + }, + "ReviewReport":{ + "type":"structure", + "members":{ + "ReviewResults":{ + "shape":"ReviewResultDetailList", + "documentation":"

A list of ReviewResults objects for each action specified in the Review Policy.

" + }, + "ReviewActions":{ + "shape":"ReviewActionDetailList", + "documentation":"

A list of ReviewAction objects for each action specified in the Review Policy.

" + } + }, + "documentation":"

Contains both ReviewResult and ReviewAction elements for a particular HIT.

" + }, + "ReviewResultDetail":{ + "type":"structure", + "members":{ + "ActionId":{ + "shape":"EntityId", + "documentation":"

A unique identifier of the Review action result.

" + }, + "SubjectId":{ + "shape":"EntityId", + "documentation":"

The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself.

" + }, + "SubjectType":{ + "shape":"String", + "documentation":"

The type of the object from the SubjectId field.

" + }, + "QuestionId":{ + "shape":"EntityId", + "documentation":"

Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker's performance on the HIT.

" + }, + "Key":{ + "shape":"String", + "documentation":"

Key identifies the particular piece of reviewed information.

" + }, + "Value":{ + "shape":"String", + "documentation":"

The values of Key provided by the review policies you have selected.

" + } + }, + "documentation":"

This data structure is returned multiple times for each result specified in the Review Policy.

" + }, + "ReviewResultDetailList":{ + "type":"list", + "member":{"shape":"ReviewResultDetail"} + }, + "ReviewableHITStatus":{ + "type":"string", + "enum":[ + "Reviewable", + "Reviewing" + ] + }, + "SendBonusRequest":{ + "type":"structure", + "required":[ + "WorkerId", + "BonusAmount", + "AssignmentId", + "Reason" + ], + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker being paid the bonus.

" + }, + "BonusAmount":{ + "shape":"CurrencyAmount", + "documentation":"

The Bonus amount is a US Dollar amount specified using a string (for example, \"5\" represents $5.00 USD and \"101.42\" represents $101.42 USD). Do not include currency symbols or currency codes.

" + }, + "AssignmentId":{ + "shape":"EntityId", + "documentation":"

The ID of the assignment for which this bonus is paid.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

" + }, + "UniqueRequestToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

" + } + } + }, + "SendBonusResponse":{ + "type":"structure", + "members":{ + } + }, + "SendTestEventNotificationRequest":{ + "type":"structure", + "required":[ + "Notification", + "TestEventType" + ], + "members":{ + "Notification":{ + "shape":"NotificationSpecification", + "documentation":"

The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.

" + }, + "TestEventType":{ + "shape":"EventType", + "documentation":"

The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.

" + } + } + }, + "SendTestEventNotificationResponse":{ + "type":"structure", + "members":{ + } + }, + "ServiceFault":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "TurkErrorCode":{"shape":"TurkErrorCode"} + }, + "documentation":"

Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.

", + "exception":true, + "fault":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Timestamp":{"type":"timestamp"}, + "TurkErrorCode":{"type":"string"}, + "UpdateExpirationForHITRequest":{ + "type":"structure", + "required":[ + "HITId", + "ExpireAt" + ], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The HIT to update.

" + }, + "ExpireAt":{ + "shape":"Timestamp", + "documentation":"

The date and time at which you want the HIT to expire

" + } + } + }, + "UpdateExpirationForHITResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateHITReviewStatusRequest":{ + "type":"structure", + "required":["HITId"], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT to update.

" + }, + "Revert":{ + "shape":"Boolean", + "documentation":"

Specifies how to update the HIT status. Default is False.

  • Setting this to false will only transition a HIT from Reviewable to Reviewing

  • Setting this to true will only transition a HIT from Reviewing to Reviewable

" + } + } + }, + "UpdateHITReviewStatusResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateHITTypeOfHITRequest":{ + "type":"structure", + "required":[ + "HITId", + "HITTypeId" + ], + "members":{ + "HITId":{ + "shape":"EntityId", + "documentation":"

The HIT to update.

" + }, + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the new HIT type.

" + } + } + }, + "UpdateHITTypeOfHITResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateNotificationSettingsRequest":{ + "type":"structure", + "required":["HITTypeId"], + "members":{ + "HITTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the HIT type whose notification specification is being updated.

" + }, + "Notification":{ + "shape":"NotificationSpecification", + "documentation":"

The notification specification for the HIT type.

" + }, + "Active":{ + "shape":"Boolean", + "documentation":"

Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.

" + } + } + }, + "UpdateNotificationSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateQualificationTypeRequest":{ + "type":"structure", + "required":["QualificationTypeId"], + "members":{ + "QualificationTypeId":{ + "shape":"EntityId", + "documentation":"

The ID of the Qualification type to update.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The new description of the Qualification type.

" + }, + "QualificationTypeStatus":{ + "shape":"QualificationTypeStatus", + "documentation":"

The new status of the Qualification type - Active | Inactive

" + }, + "Test":{ + "shape":"String", + "documentation":"

The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.

Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.

Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.

" + }, + "AnswerKey":{ + "shape":"String", + "documentation":"

The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.

" + }, + "TestDurationInSeconds":{ + "shape":"Long", + "documentation":"

The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.

" + }, + "RetryDelayInSeconds":{ + "shape":"Long", + "documentation":"

The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.

" + }, + "AutoGranted":{ + "shape":"Boolean", + "documentation":"

Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.

Constraints: If the Test parameter is specified, this parameter cannot be true.

" + }, + "AutoGrantedValue":{ + "shape":"Integer", + "documentation":"

The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.

" + } + } + }, + "UpdateQualificationTypeResponse":{ + "type":"structure", + "members":{ + "QualificationType":{ + "shape":"QualificationType", + "documentation":"

Contains a QualificationType data structure.

" + } + } + }, + "WorkerBlock":{ + "type":"structure", + "members":{ + "WorkerId":{ + "shape":"CustomerId", + "documentation":"

The ID of the Worker who accepted the HIT.

" + }, + "Reason":{ + "shape":"String", + "documentation":"

A message explaining the reason the Worker was blocked.

" + } + }, + "documentation":"

The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.

" + }, + "WorkerBlockList":{ + "type":"list", + "member":{"shape":"WorkerBlock"} + } + }, + "documentation":"Amazon Mechanical Turk API Reference" +} diff --git a/aws/dist/botocore/data/neptune/2014-10-31/paginators-1.json b/aws/dist/botocore/data/neptune/2014-10-31/paginators-1.json new file mode 100644 index 00000000..a93bd84d --- /dev/null +++ b/aws/dist/botocore/data/neptune/2014-10-31/paginators-1.json @@ -0,0 +1,88 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstances" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "EngineDefaults.Marker", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Events" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeDBClusterParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterParameterGroups" + }, + "DescribeDBClusterParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBClusterSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterSnapshots" + }, + "DescribeDBClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusters" + }, + "DescribePendingMaintenanceActions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "PendingMaintenanceActions" + } + } +} diff --git a/aws/dist/botocore/data/neptune/2014-10-31/service-2.json b/aws/dist/botocore/data/neptune/2014-10-31/service-2.json new file mode 100644 index 00000000..cf3ebb8e --- /dev/null +++ b/aws/dist/botocore/data/neptune/2014-10-31/service-2.json @@ -0,0 +1,5518 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-31", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon Neptune", + "serviceFullName":"Amazon Neptune", + "serviceId":"Neptune", + "signatureVersion":"v4", + "signingName":"rds", + "uid":"neptune-2014-10-31", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations":{ + "AddRoleToDBCluster":{ + "name":"AddRoleToDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToDBClusterMessage"}, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterRoleAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterRoleQuotaExceededFault"} + ], + "documentation":"

Associates an Identity and Access Management (IAM) role from an Neptune DB cluster.

" + }, + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

Adds a source identifier to an existing event notification subscription.

" + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Adds metadata tags to an Amazon Neptune resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon Neptune resources, or used in a Condition statement in an IAM policy for Amazon Neptune.

" + }, + "ApplyPendingMaintenanceAction":{ + "name":"ApplyPendingMaintenanceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, + "output":{ + "shape":"ApplyPendingMaintenanceActionResult", + "resultWrapper":"ApplyPendingMaintenanceActionResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Applies a pending maintenance action to a resource (for example, to a DB instance).

" + }, + "CopyDBClusterParameterGroup":{ + "name":"CopyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CopyDBClusterParameterGroupResult", + "resultWrapper":"CopyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

Copies the specified DB cluster parameter group.

" + }, + "CopyDBClusterSnapshot":{ + "name":"CopyDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterSnapshotMessage"}, + "output":{ + "shape":"CopyDBClusterSnapshotResult", + "resultWrapper":"CopyDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can't copy from one AWS Region to another.

" + }, + "CopyDBParameterGroup":{ + "name":"CopyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBParameterGroupMessage"}, + "output":{ + "shape":"CopyDBParameterGroupResult", + "resultWrapper":"CopyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"} + ], + "documentation":"

Copies the specified DB parameter group.

" + }, + "CreateDBCluster":{ + "name":"CreateDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterMessage"}, + "output":{ + "shape":"CreateDBClusterResult", + "resultWrapper":"CreateDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"} + ], + "documentation":"

Creates a new Amazon Neptune DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

" + }, + "CreateDBClusterParameterGroup":{ + "name":"CreateDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateDBClusterParameterGroupResult", + "resultWrapper":"CreateDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

Creates a new DB cluster parameter group.

Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

" + }, + "CreateDBClusterSnapshot":{ + "name":"CreateDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterSnapshotMessage"}, + "output":{ + "shape":"CreateDBClusterSnapshotResult", + "resultWrapper":"CreateDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

Creates a snapshot of a DB cluster.

" + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DomainNotFoundFault"} + ], + "documentation":"

Creates a new DB instance.

" + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

" + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

" + }, + "DeleteDBCluster":{ + "name":"DeleteDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterMessage"}, + "output":{ + "shape":"DeleteDBClusterResult", + "resultWrapper":"DeleteDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

" + }, + "DeleteDBClusterParameterGroup":{ + "name":"DeleteDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

" + }, + "DeleteDBClusterSnapshot":{ + "name":"DeleteDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteDBClusterSnapshotResult", + "resultWrapper":"DeleteDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

" + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon Neptune DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

You can't delete a DB instance if it is the only instance in the DB cluster.

" + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted can't be associated with any DB instances.

" + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

Deletes a DB subnet group.

The specified database subnet group must not be associated with any DB instances.

" + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ], + "documentation":"

Deletes an event notification subscription.

" + }, + "DescribeDBClusterParameterGroups":{ + "name":"DescribeDBClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, + "output":{ + "shape":"DBClusterParameterGroupsMessage", + "resultWrapper":"DescribeDBClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

" + }, + "DescribeDBClusterParameters":{ + "name":"DescribeDBClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParametersMessage"}, + "output":{ + "shape":"DBClusterParameterGroupDetails", + "resultWrapper":"DescribeDBClusterParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns the detailed parameter list for a particular DB cluster parameter group.

" + }, + "DescribeDBClusterSnapshotAttributes":{ + "name":"DescribeDBClusterSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBClusterSnapshotAttributesResult", + "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

" + }, + "DescribeDBClusterSnapshots":{ + "name":"DescribeDBClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, + "output":{ + "shape":"DBClusterSnapshotMessage", + "resultWrapper":"DescribeDBClusterSnapshotsResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

Returns information about DB cluster snapshots. This API action supports pagination.

" + }, + "DescribeDBClusters":{ + "name":"DescribeDBClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClustersMessage"}, + "output":{ + "shape":"DBClusterMessage", + "resultWrapper":"DescribeDBClustersResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Returns information about provisioned DB clusters. This API supports pagination.

" + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

Returns a list of the available DB engines.

" + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

Returns information about provisioned instances. This API supports pagination.

" + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

" + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Returns the detailed parameter list for a particular DB parameter group.

" + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

" + }, + "DescribeEngineDefaultClusterParameters":{ + "name":"DescribeEngineDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultClusterParametersResult", + "resultWrapper":"DescribeEngineDefaultClusterParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the cluster database engine.

" + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

Returns the default engine and system parameter information for the specified database engine.

" + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

Displays a list of categories for all event source types, or, if specified, for a specified source type.

" + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ], + "documentation":"

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a SubscriptionName, lists the description for that subscription.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

" + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

Returns a list of orderable DB instance options for the specified engine.

" + }, + "DescribePendingMaintenanceActions":{ + "name":"DescribePendingMaintenanceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, + "output":{ + "shape":"PendingMaintenanceActionsMessage", + "resultWrapper":"DescribePendingMaintenanceActionsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

" + }, + "DescribeValidDBInstanceModifications":{ + "name":"DescribeValidDBInstanceModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeValidDBInstanceModificationsMessage"}, + "output":{ + "shape":"DescribeValidDBInstanceModificationsResult", + "resultWrapper":"DescribeValidDBInstanceModificationsResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

" + }, + "FailoverDBCluster":{ + "name":"FailoverDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FailoverDBClusterMessage"}, + "output":{ + "shape":"FailoverDBClusterResult", + "resultWrapper":"FailoverDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Lists all tags on an Amazon Neptune resource.

" + }, + "ModifyDBCluster":{ + "name":"ModifyDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterMessage"}, + "output":{ + "shape":"ModifyDBClusterResult", + "resultWrapper":"ModifyDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterAlreadyExistsFault"} + ], + "documentation":"

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

" + }, + "ModifyDBClusterParameterGroup":{ + "name":"ModifyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ModifyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ], + "documentation":"

Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

" + }, + "ModifyDBClusterSnapshotAttribute":{ + "name":"ModifyDBClusterSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBClusterSnapshotAttributeResult", + "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ], + "documentation":"

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

" + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"CertificateNotFoundFault"}, + {"shape":"DomainNotFoundFault"} + ], + "documentation":"

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

" + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ], + "documentation":"

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

" + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

" + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ], + "documentation":"

Modifies an existing event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

You can see a list of the event categories for a given SourceType by using the DescribeEventCategories action.

" + }, + "PromoteReadReplicaDBCluster":{ + "name":"PromoteReadReplicaDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaDBClusterMessage"}, + "output":{ + "shape":"PromoteReadReplicaDBClusterResult", + "resultWrapper":"PromoteReadReplicaDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

Not supported.

" + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

" + }, + "RemoveRoleFromDBCluster":{ + "name":"RemoveRoleFromDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromDBClusterMessage"}, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterRoleNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

" + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

Removes a source identifier from an existing event notification subscription.

" + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

Removes metadata tags from an Amazon Neptune resource.

" + }, + "ResetDBClusterParameterGroup":{ + "name":"ResetDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ResetDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

" + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

" + }, + "RestoreDBClusterFromSnapshot":{ + "name":"RestoreDBClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, + "output":{ + "shape":"RestoreDBClusterFromSnapshotResult", + "resultWrapper":"RestoreDBClusterFromSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"} + ], + "documentation":"

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

" + }, + "RestoreDBClusterToPointInTime":{ + "name":"RestoreDBClusterToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBClusterToPointInTimeResult", + "resultWrapper":"RestoreDBClusterToPointInTimeResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"} + ], + "documentation":"

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

" + } + }, + "shapes":{ + "AddRoleToDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "RoleArn" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the DB cluster to associate the IAM role with.

" + }, + "RoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

" + } + } + }, + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the event notification subscription you want to add a source identifier to.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source to be added.

Constraints:

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

" + } + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Neptune resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the Amazon Neptune resource.

" + } + } + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "ApplyPendingMaintenanceActionMessage":{ + "type":"structure", + "required":[ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

" + }, + "ApplyAction":{ + "shape":"String", + "documentation":"

The pending maintenance action to apply to this resource.

Valid values: system-update, db-upgrade

" + }, + "OptInType":{ + "shape":"String", + "documentation":"

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" + } + } + }, + "ApplyPendingMaintenanceActionResult":{ + "type":"structure", + "members":{ + "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} + } + }, + "AttributeValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeValue" + } + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

Neptune may not also be authorized via IAM to perform necessary actions on your behalf.

", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the availability zone.

" + } + }, + "documentation":"

Specifies an Availability Zone.

", + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "AvailabilityZones":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

CertificateIdentifier does not refer to an existing certificate.

", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

The name of the character set.

" + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

The description of the character set.

" + } + }, + "documentation":"

Specifies a character set.

" + }, + "CloudwatchLogsExportConfiguration":{ + "type":"structure", + "members":{ + "EnableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The list of log types to enable.

" + }, + "DisableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The list of log types to disable.

" + } + }, + "documentation":"

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs.

" + }, + "CopyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members":{ + "SourceDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

Constraints:

  • Must specify a valid DB cluster parameter group.

  • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

  • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

" + }, + "TargetDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied DB cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster-param-group1

" + }, + "TargetDBClusterParameterGroupDescription":{ + "shape":"String", + "documentation":"

A description for the copied DB cluster parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the copied DB cluster parameter group.

" + } + } + }, + "CopyDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CopyDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members":{ + "SourceDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

You can't copy from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

" + }, + "TargetDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, Amazon Neptune encrypts the target DB cluster snapshot using the specified KMS encryption key.

If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

" + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

Not currently supported.

" + }, + "CopyTags":{ + "shape":"BooleanOptional", + "documentation":"

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to assign to the new DB cluster snapshot copy.

" + } + } + }, + "CopyDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CopyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members":{ + "SourceDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

Constraints:

  • Must specify a valid DB parameter group.

  • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

" + }, + "TargetDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the copied DB parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-db-parameter-group

" + }, + "TargetDBParameterGroupDescription":{ + "shape":"String", + "documentation":"

A description for the copied DB parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the copied DB parameter group.

" + } + } + }, + "CopyDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

A value that indicates that the DB cluster should be associated with the specified CharacterSet.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to associate with this DB cluster.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB subnet group to associate with this DB cluster.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this DB cluster.

Valid Values: neptune

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

Example: 1.0.1

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the instances in the DB cluster accept connections.

Default: 8182

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name of the master user for the DB cluster.

Constraints:

  • Must be 1 to 16 letters or numbers.

  • First character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

A value that indicates that the DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Neptune User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

" + }, + "ReplicationSourceIdentifier":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to assign to the new DB cluster.

" + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the DB cluster is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

" + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

This parameter is not currently supported.

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" + } + } + }, + "CreateDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must match the name of an existing DBClusterParameterGroup.

This value is stored as a lowercase string.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB cluster parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the new DB cluster parameter group.

" + } + } + }, + "CreateDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CreateDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "CreateDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster1-snapshot1

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

Example: my-cluster1

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the DB cluster snapshot.

" + } + } + }, + "CreateDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Not applicable. Neptune cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in a Neptune cluster volume.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine to be used for this instance.

Valid Values: neptune

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

The name for the master user. Not used.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Not used.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to associate with this DB instance.

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: The default EC2 VPC security group for the DB subnet group's VPC.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The EC2 Availability Zone that the DB instance is created in

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

A DB subnet group to associate with this DB instance.

If there is no DB subnet group, then it is a non-VPC DB instance.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine is used.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained.

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 1

Constraints:

  • Must be a value from 0 to 35

  • Cannot be set to 0 if the DB instance is a source to Read Replicas

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see CreateDBCluster.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

Not applicable. The port is managed by the DB cluster. For more information, see CreateDBCluster.

Default: 8182

Type: Integer

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to use.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB instance should be associated with the specified option group.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

Indicates that the DB instance should be associated with the specified CharacterSet.

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

This flag should no longer be used.

", + "deprecated":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to assign to the new instance.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster that the instance will belong to.

For information on creating a DB cluster, see CreateDBCluster.

Type: String

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Specifies the storage type to be associated with the DB instance.

Not applicable. Storage is managed by the DB Cluster.

" + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

The ARN from the key store with which to associate the instance for TDE encryption.

" + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

The password for the given ARN from the key store in order to access the device.

" + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

Specifies whether the DB instance is encrypted.

Not applicable. The encryption for DB instances is managed by the DB cluster. For more information, see CreateDBCluster.

Default: false

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier for an encrypted DB instance.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon Neptune will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

Specify the Active Directory Domain to create the instance in.

" + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

" + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

" + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

" + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

Specify the name of the IAM role to be used when making API calls to the Directory Service.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which an Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid Values: 0 - 15

" + }, + "Timezone":{ + "shape":"String", + "documentation":"

The time zone of the DB instance.

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable AWS Identity and Access Management (IAM) authentication for Neptune.

Default: false

" + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

True to enable Performance Insights for the DB instance, and otherwise false.

" + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

The list of log types that need to be enabled for exporting to CloudWatch Logs.

" + } + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The description for the DB parameter group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the new DB parameter group.

" + } + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string.

Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 Subnet IDs for the DB subnet group.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the new DB subnet group.

" + } + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the subscription.

Constraints: The name must be less than 255 characters.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

" + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be applied to the new event subscription.

" + } + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DBCluster":{ + "type":"structure", + "members":{ + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

If present, specifies the name of the character set that this cluster is associated with.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

" + }, + "DBClusterParameterGroup":{ + "shape":"String", + "documentation":"

Specifies the name of the DB cluster parameter group for the DB cluster.

" + }, + "DBSubnetGroup":{ + "shape":"String", + "documentation":"

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the current state of this DB cluster.

" + }, + "PercentProgress":{ + "shape":"String", + "documentation":"

Specifies the progress of the operation as a percentage.

" + }, + "EarliestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the earliest time to which a database can be restored with point-in-time restore.

" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

Specifies the connection endpoint for the primary instance of the DB cluster.

" + }, + "ReaderEndpoint":{ + "shape":"String", + "documentation":"

The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.

If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster has instances in multiple Availability Zones.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the port that the database engine is listening on.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master username for the DB cluster.

" + }, + "DBClusterOptionGroupMemberships":{ + "shape":"DBClusterOptionGroupMemberships", + "documentation":"

Provides the list of option group memberships for this DB cluster.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + }, + "ReplicationSourceIdentifier":{ + "shape":"String", + "documentation":"

Not supported by Neptune.

" + }, + "ReadReplicaIdentifiers":{ + "shape":"ReadReplicaIdentifierList", + "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

" + }, + "DBClusterMembers":{ + "shape":"DBClusterMemberList", + "documentation":"

Provides the list of instances that make up the DB cluster.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides a list of VPC security groups that the DB cluster belongs to.

" + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

" + }, + "DbClusterResourceId":{ + "shape":"String", + "documentation":"

The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

" + }, + "DBClusterArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster.

" + }, + "AssociatedRoles":{ + "shape":"DBClusterRoles", + "documentation":"

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

" + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + }, + "CloneGroupId":{ + "shape":"String", + "documentation":"

Identifies the clone group to which the DB cluster is associated.

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

" + } + }, + "documentation":"

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters action.

", + "wrapper":true + }, + "DBClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

User already has a DB cluster with the given identifier.

", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterList":{ + "type":"list", + "member":{ + "shape":"DBCluster", + "locationName":"DBCluster" + } + }, + "DBClusterMember":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Specifies the instance identifier for this member of the DB cluster.

" + }, + "IsClusterWriter":{ + "shape":"Boolean", + "documentation":"

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

" + }, + "DBClusterParameterGroupStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

" + } + }, + "documentation":"

Contains information about an instance that is part of a DB cluster.

", + "wrapper":true + }, + "DBClusterMemberList":{ + "type":"list", + "member":{ + "shape":"DBClusterMember", + "locationName":"DBClusterMember" + } + }, + "DBClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

A pagination token that can be used in a subsequent DescribeDBClusters request.

" + }, + "DBClusters":{ + "shape":"DBClusterList", + "documentation":"

Contains a list of DB clusters for the user.

" + } + } + }, + "DBClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterIdentifier does not refer to an existing DB cluster.

", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterOptionGroupMemberships":{ + "type":"list", + "member":{ + "shape":"DBClusterOptionGroupStatus", + "locationName":"DBClusterOptionGroup" + } + }, + "DBClusterOptionGroupStatus":{ + "type":"structure", + "members":{ + "DBClusterOptionGroupName":{ + "shape":"String", + "documentation":"

Specifies the name of the DB cluster option group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of the DB cluster option group.

" + } + }, + "documentation":"

Contains status information for a DB cluster option group.

" + }, + "DBClusterParameterGroup":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB cluster parameter group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB cluster parameter group.

" + }, + "DBClusterParameterGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster parameter group.

" + } + }, + "documentation":"

Contains the details of an Amazon Neptune DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

", + "wrapper":true + }, + "DBClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Provides a list of parameters for the DB cluster parameter group.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + } + }, + "DBClusterParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBClusterParameterGroup", + "locationName":"DBClusterParameterGroup" + } + }, + "DBClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

This value is stored as a lowercase string.

" + } + } + }, + "DBClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterParameterGroupName does not refer to an existing DB Cluster parameter group.

", + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBClusterParameterGroups":{ + "shape":"DBClusterParameterGroupList", + "documentation":"

A list of DB cluster parameter groups.

" + } + } + }, + "DBClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

User attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterRole":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

  • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

  • PENDING - the IAM role ARN is being associated with the DB cluster.

  • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

" + } + }, + "documentation":"

Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

" + }, + "DBClusterRoleAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

", + "error":{ + "code":"DBClusterRoleAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified IAM role Amazon Resource Name (ARN) is not associated with the specified DB cluster.

", + "error":{ + "code":"DBClusterRoleNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoleQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

", + "error":{ + "code":"DBClusterRoleQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoles":{ + "type":"list", + "member":{ + "shape":"DBClusterRole", + "locationName":"DBClusterRole" + } + }, + "DBClusterSnapshot":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

" + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier for the DB cluster snapshot.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

" + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Specifies the name of the database engine.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size in gibibytes (GiB).

" + }, + "Status":{ + "shape":"String", + "documentation":"

Specifies the status of this DB cluster snapshot.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the DB cluster was listening on at the time of the snapshot.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VPC ID associated with the DB cluster snapshot.

" + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Provides the master username for the DB cluster snapshot.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Provides the version of the database engine for this DB cluster snapshot.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

Provides the license model information for this DB cluster snapshot.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

Provides the type of the DB cluster snapshot.

" + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

Specifies the percentage of the estimated data that has been transferred.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether the DB cluster snapshot is encrypted.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

" + }, + "DBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB cluster snapshot.

" + }, + "SourceDBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

" + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

" + } + }, + "documentation":"

Contains the details for an Amazon Neptune DB cluster snapshot

This data type is used as a response element in the DescribeDBClusterSnapshots action.

", + "wrapper":true + }, + "DBClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

User already has a DB cluster snapshot with the given identifier.

", + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the manual DB cluster snapshot attribute.

The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" + }, + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

The value(s) for the manual DB cluster snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

" + } + }, + "documentation":"

Contains the name and values of a manual DB cluster snapshot attribute.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

" + }, + "DBClusterSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshotAttribute", + "locationName":"DBClusterSnapshotAttribute" + } + }, + "DBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the manual DB cluster snapshot that the attributes apply to.

" + }, + "DBClusterSnapshotAttributes":{ + "shape":"DBClusterSnapshotAttributeList", + "documentation":"

The list of attributes and values for the manual DB cluster snapshot.

" + } + }, + "documentation":"

Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

", + "wrapper":true + }, + "DBClusterSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshot", + "locationName":"DBClusterSnapshot" + } + }, + "DBClusterSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBClusterSnapshots":{ + "shape":"DBClusterSnapshotList", + "documentation":"

Provides a list of DB cluster snapshots for the user.

" + } + } + }, + "DBClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBClusterSnapshotIdentifier does not refer to an existing DB cluster snapshot.

", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB parameter group family for the database engine.

" + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

The description of the database engine.

" + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

The description of the database engine version.

" + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

" + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

" + }, + "ValidUpgradeTarget":{ + "shape":"ValidUpgradeTargetList", + "documentation":"

A list of engine versions that this database engine version can be upgraded to.

" + }, + "SupportedTimezones":{ + "shape":"SupportedTimezonesList", + "documentation":"

A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

" + }, + "ExportableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

The types of logs that the database engine has available for export to CloudWatch Logs.

" + }, + "SupportsLogExportsToCloudwatchLogs":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

" + }, + "SupportsReadReplica":{ + "shape":"Boolean", + "documentation":"

Indicates whether the database engine version supports read replicas.

" + } + }, + "documentation":"

This data type is used as a response element in the action DescribeDBEngineVersions.

" + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

A list of DBEngineVersion elements.

" + } + } + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the name of the compute and memory capacity class of the DB instance.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

Provides the name of the database engine to be used for this DB instance.

" + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

Specifies the current state of this database.

" + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

Contains the master username for the DB instance.

" + }, + "DBName":{ + "shape":"String", + "documentation":"

The database name.

" + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

Specifies the connection endpoint.

" + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

Specifies the allocated storage size specified in gibibytes.

" + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

Provides the date and time the DB instance was created.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

" + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

Specifies the number of days for which automatic DB snapshots are retained.

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

" + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

Provides a list of VPC security group elements that the DB instance belongs to.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

Provides the list of DB parameter groups applied to this DB instance.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

Specifies the name of the Availability Zone the DB instance is located in.

" + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

" + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

" + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

Specifies the latest time to which a database can be restored with point-in-time restore.

" + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that minor version patches are applied automatically.

" + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

" + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

Contains one or more identifiers of the Read Replicas associated with this DB instance.

" + }, + "ReadReplicaDBClusterIdentifiers":{ + "shape":"ReadReplicaDBClusterIdentifierList", + "documentation":"

Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

License model information for this DB instance.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the Provisioned IOPS (I/O operations per second) value.

" + }, + "OptionGroupMemberships":{ + "shape":"OptionGroupMembershipList", + "documentation":"

Provides the list of option group memberships for this DB instance.

" + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

If present, specifies the name of the character set that this instance is associated with.

" + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

" + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

This flag should no longer be used.

", + "deprecated":true + }, + "StatusInfos":{ + "shape":"DBInstanceStatusInfoList", + "documentation":"

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Specifies the storage type associated with DB instance.

" + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

The ARN from the key store with which the instance is associated for TDE encryption.

" + }, + "DbInstancePort":{ + "shape":"Integer", + "documentation":"

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

" + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

Not supported: The encryption for DB instances is managed by the DB cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

Not supported: The encryption for DB instances is managed by the DB cluster.

" + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the CA certificate for this DB instance.

" + }, + "DomainMemberships":{ + "shape":"DomainMembershipList", + "documentation":"

Not supported

" + }, + "CopyTagsToSnapshot":{ + "shape":"Boolean", + "documentation":"

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

" + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

" + }, + "EnhancedMonitoringResourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

" + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

" + }, + "DBInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB instance.

" + }, + "Timezone":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.

" + }, + "PerformanceInsightsEnabled":{ + "shape":"BooleanOptional", + "documentation":"

True if Performance Insights is enabled for the DB instance, and otherwise false.

" + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

" + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

A list of log types that this DB instance is configured to export to CloudWatch Logs.

" + } + }, + "documentation":"

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the DescribeDBInstances action.

", + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

User already has a DB instance with the given identifier.

", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

A list of DBInstance instances.

" + } + } + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBInstanceIdentifier does not refer to an existing DB instance.

", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{ + "shape":"String", + "documentation":"

This value is currently \"read replication.\"

" + }, + "Normal":{ + "shape":"Boolean", + "documentation":"

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

" + }, + "Status":{ + "shape":"String", + "documentation":"

Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

" + } + }, + "documentation":"

Provides a list of status information for a DB instance.

" + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group.

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides the customer-specified description for this DB parameter group.

" + }, + "DBParameterGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB parameter group.

" + } + }, + "documentation":"

Contains the details of an Amazon Neptune DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups action.

", + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

A DB parameter group with the same name exists.

", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of Parameter values.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

Provides the name of the DB parameter group.

" + } + } + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBParameterGroupName does not refer to an existing DB parameter group.

", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed number of DB parameter groups.

", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DP parameter group.

" + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

The status of parameter updates.

" + } + }, + "documentation":"

The status of the DB parameter group.

This data type is used as a response element in the following actions:

" + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

A list of DBParameterGroup instances.

" + } + } + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

The name of the DB security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB security group.

" + } + }, + "documentation":"

Specifies membership in a designated DB security group.

" + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSecurityGroupName does not refer to an existing DB security group.

", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSnapshotIdentifier is already used by an existing snapshot.

", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSnapshotIdentifier does not refer to an existing DB snapshot.

", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group.

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

Provides the description of the DB subnet group.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

Provides the VpcId of the DB subnet group.

" + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

Provides the status of the DB subnet group.

" + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

Contains a list of Subnet elements.

" + }, + "DBSubnetGroupArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the DB subnet group.

" + } + }, + "documentation":"

Contains the details of an Amazon Neptune DB subnet group.

This data type is used as a response element in the DescribeDBSubnetGroups action.

", + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSubnetGroupName is already used by an existing DB subnet group.

", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "documentation":"

Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

A list of DBSubnetGroup instances.

" + } + } + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DBSubnetGroupName does not refer to an existing DB subnet group.

", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed number of DB subnet groups.

", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB upgrade failed because a resource the DB depends on could not be modified.

", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters, numbers, or hyphens.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" + } + } + }, + "DeleteDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group.

Constraints:

  • Must be the name of an existing DB cluster parameter group.

  • You can't delete a default DB cluster parameter group.

  • Cannot be associated with any DB clusters.

" + } + } + }, + "DeleteDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "DeleteDBClusterSnapshotMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

" + } + } + }, + "DeleteDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

  • Must match the name of an existing DB instance.

" + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to \"true\".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

" + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

" + } + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

  • Must be the name of an existing DB parameter group

  • You can't delete a default DB parameter group

  • Cannot be associated with any DB instances

" + } + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the database subnet group to delete.

You can't delete the default subnet group.

Constraints:

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + } + } + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the event notification subscription you want to delete.

" + } + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DescribeDBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB cluster parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBClusterParametersMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB cluster parameter group to return parameter details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + }, + "Source":{ + "shape":"String", + "documentation":"

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBClusterSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB cluster snapshot to describe the attributes for.

" + } + } + }, + "DescribeDBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "DescribeDBClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBCluster.

" + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

  • If supplied, must match the identifier of an existing DBClusterSnapshot.

  • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

" + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

The type of DB cluster snapshots to be returned. You can specify one of the following values:

  • automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my AWS account.

  • manual - Return all DB cluster snapshots that have been taken by my AWS account.

  • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

  • public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "IncludeShared":{ + "shape":"Boolean", + "documentation":"

True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

" + }, + "IncludePublic":{ + "shape":"Boolean", + "documentation":"

True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

" + } + } + }, + "DescribeDBClustersMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The database engine to return.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The database engine version to return.

Example: 5.1.49

" + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group family to return details for.

Constraints:

  • If supplied, must match an existing DBParameterGroupFamily.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

Indicates that only the default version of the specified engine or engine and major version combination is returned.

" + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

" + }, + "ListSupportedTimezones":{ + "shape":"BooleanOptional", + "documentation":"

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

" + } + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match the identifier of an existing DBInstance.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more DB instances to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of a specific DB parameter group to return details for.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

" + }, + "Source":{ + "shape":"String", + "documentation":"

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group to return details for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeEngineDefaultClusterParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group family to return engine parameter information for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeEngineDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

The name of the DB parameter group family.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

Not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that is generating the events.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + } + } + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the event notification subscription you want to describe.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + } + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

Constraints:

  • If SourceIdentifier is supplied, SourceType must also be provided.

  • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

The event source to retrieve events for. If no value is specified, all events are returned.

" + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

" + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

The number of minutes to retrieve events for.

Default: 60

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories that trigger notifications for a event notification subscription.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the engine to retrieve DB instance options for.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

" + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + } + }, + "DescribePendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The ARN of a resource to return pending maintenance actions for.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

A filter that specifies one or more resources to return pending maintenance actions for.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

  • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

" + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

" + } + } + }, + "DescribeValidDBInstanceModificationsMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The customer identifier or the ARN of your DB instance.

" + } + } + }, + "DescribeValidDBInstanceModificationsResult":{ + "type":"structure", + "members":{ + "ValidDBInstanceModificationsMessage":{"shape":"ValidDBInstanceModificationsMessage"} + } + }, + "DomainMembership":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"String", + "documentation":"

The identifier of the Active Directory Domain.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

" + }, + "FQDN":{ + "shape":"String", + "documentation":"

The fully qualified domain name of the Active Directory Domain.

" + }, + "IAMRoleName":{ + "shape":"String", + "documentation":"

The name of the IAM role to be used when making API calls to the Directory Service.

" + } + }, + "documentation":"

An Active Directory Domain membership record associated with a DB instance.

" + }, + "DomainMembershipList":{ + "type":"list", + "member":{ + "shape":"DomainMembership", + "locationName":"DomainMembership" + } + }, + "DomainNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Domain does not refer to an existing Active Directory Domain.

", + "error":{ + "code":"DomainNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Double":{"type":"double"}, + "DoubleOptional":{"type":"double"}, + "DoubleRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Double", + "documentation":"

The minimum value in the range.

" + }, + "To":{ + "shape":"Double", + "documentation":"

The maximum value in the range.

" + } + }, + "documentation":"

A range of double values.

" + }, + "DoubleRangeList":{ + "type":"list", + "member":{ + "shape":"DoubleRange", + "locationName":"DoubleRange" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

Specifies the DNS address of the DB instance.

" + }, + "Port":{ + "shape":"Integer", + "documentation":"

Specifies the port that the database engine is listening on.

" + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

" + } + }, + "documentation":"

Specifies a connection endpoint.

" + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

Specifies the name of the DB parameter group family that the engine default parameters apply to.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

Contains a list of engine default parameters.

" + } + }, + "documentation":"

Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

", + "wrapper":true + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

Provides the identifier for the source of the event.

" + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

Specifies the source type for this event.

" + }, + "Message":{ + "shape":"String", + "documentation":"

Provides the text of this event.

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

Specifies the category for the event.

" + }, + "Date":{ + "shape":"TStamp", + "documentation":"

Specifies the date and time of the event.

" + }, + "SourceArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the event.

" + } + }, + "documentation":"

This data type is used as a response element in the DescribeEvents action.

" + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

The source type that the returned categories belong to

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

The event categories for the specified source type

" + } + }, + "documentation":"

Contains the results of a successful invocation of the DescribeEventCategories action.

", + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

A list of EventCategoriesMap data types.

" + } + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

The AWS customer account associated with the event notification subscription.

" + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

The event notification subscription Id.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The topic ARN of the event notification subscription.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the event notification subscription.

Constraints:

Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

The status \"no-permission\" indicates that Neptune no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

" + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

The time the event notification subscription was created.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The source type for the event notification subscription.

" + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

A list of source IDs for the event notification subscription.

" + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for the event notification subscription.

" + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

" + }, + "EventSubscriptionArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for the event subscription.

" + } + }, + "documentation":"

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

", + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the number of events you can subscribe to.

", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

" + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

A list of EventSubscriptions data types.

" + } + } + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + }, + "Events":{ + "shape":"EventList", + "documentation":"

A list of Event instances.

" + } + } + }, + "FailoverDBClusterMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

" + } + } + }, + "FailoverDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

This parameter is not currently supported.

" + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

This parameter is not currently supported.

" + } + }, + "documentation":"

This type is not currently supported.

" + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed number of DB instances.

", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB cluster does not have enough capacity for the current operation.

", + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Specified DB instance class is not available in the specified Availability Zone.

", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientStorageClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is insufficient storage available for the current action. You may be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

", + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The supplied value is not a valid DB cluster snapshot state.

", + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB cluster is not in a valid state.

", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified DB instance is not in the available state.

", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you cannot delete it when the parameter group is in this state.

", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The state of the DB security group does not allow deletion.

", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The state of the DB snapshot does not allow deletion.

", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet group cannot be deleted because it is in use.

", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet is not in the available state.

", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The event subscription is in an invalid state.

", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Cannot restore from vpc backup to non-vpc DB instance.

", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

DB subnet group does not cover all Availability Zones after it is created because users' change.

", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSKeyNotAccessibleFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Error accessing KMS key.

", + "error":{ + "code":"KMSKeyNotAccessibleFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Neptune resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

This parameter is not currently supported.

" + } + } + }, + "LogTypeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ModifyDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "NewDBClusterIdentifier":{ + "shape":"String", + "documentation":"

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • The first character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-cluster2

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the NewDBClusterIdentifier and MasterUserPassword values. If you set the ApplyImmediately parameter value to false, then changes to the NewDBClusterIdentifier and MasterUserPassword values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

  • Must be a value from 1 to 35

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to use for the DB cluster.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VPC security groups that the DB cluster will belong to.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

" + }, + "CloudwatchLogsExportConfiguration":{ + "shape":"CloudwatchLogsExportConfiguration", + "documentation":"

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

" + } + } + }, + "ModifyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "Parameters" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to modify.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of parameters in the DB cluster parameter group to modify.

" + } + } + }, + "ModifyDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ModifyDBClusterSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB cluster snapshot to modify the attributes for.

" + }, + "AttributeName":{ + "shape":"String", + "documentation":"

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

" + }, + "ValuesToAdd":{ + "shape":"AttributeValueList", + "documentation":"

A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

" + }, + "ValuesToRemove":{ + "shape":"AttributeValueList", + "documentation":"

A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

" + } + } + }, + "ModifyDBClusterSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

The new amount of storage (in gibibytes) to allocate for the DB instance.

Not applicable. Storage is managed by the DB Cluster.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

" + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints:

  • If supplied, must match existing DBSecurityGroups.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • If supplied, must match existing VpcSecurityGroupIds.

" + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot.

Default: false

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Not applicable.

" + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

Default: Uses existing setting

Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

" + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled.

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

  • Must be in the format hh24:mi-hh24:mi

  • Must be in Universal Time Coordinated (UTC)

  • Must not conflict with the preferred maintenance window

  • Must be at least 30 minutes

" + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

Default: Uses existing setting

Format: ddd:hh24:mi-ddd:hh24:mi

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Must be at least 30 minutes

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

" + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

" + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and Neptune has enabled auto patching for that engine version.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

The new Provisioned IOPS (I/O operations per second) value for the instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

Default: Uses existing setting

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

" + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: mydbinstance

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

The ARN from the key store with which to associate the instance for TDE encryption.

" + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

The password for the given ARN from the key store in order to access the device.

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

Indicates the certificate that needs to be associated with the instance.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

" + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

Valid Values: 0, 1, 5, 10, 15, 30, 60

" + }, + "DBPortNumber":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the database accepts connections.

The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

Default: 8182

" + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

This flag should no longer be used.

", + "deprecated":true + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

The ARN for the IAM role that permits Neptune to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

" + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

Not supported

" + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

Default: 1

Valid Values: 0 - 15

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: false

" + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

Not supported.

" + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "CloudwatchLogsExportConfiguration":{ + "shape":"CloudwatchLogsExportConfiguration", + "documentation":"

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

" + } + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

  • If supplied, must match the name of an existing DBParameterGroup.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

" + } + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

Example: mySubnetgroup

" + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

The description for the DB subnet group.

" + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

The EC2 subnet IDs for the DB subnet group.

" + } + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the event notification subscription.

" + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

" + }, + "SourceType":{ + "shape":"String", + "documentation":"

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

" + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType by using the DescribeEventCategories action.

" + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

A Boolean value; set to true to activate the subscription.

" + } + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group that the instance belongs to.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

" + } + }, + "documentation":"

Provides information on the option groups the DB instance is a member of.

" + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The designated option group could not be found.

", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The engine type of a DB instance.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of a DB instance.

" + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

The DB instance class for a DB instance.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for a DB instance.

" + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

A list of Availability Zones for a DB instance.

" + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance is Multi-AZ capable.

" + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance can have a Read Replica.

" + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance is in a VPC.

" + }, + "SupportsStorageEncryption":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance supports encrypted storage.

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Indicates the storage type for a DB instance.

" + }, + "SupportsIops":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance supports provisioned IOPS.

" + }, + "SupportsEnhancedMonitoring":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

" + }, + "SupportsIAMDatabaseAuthentication":{ + "shape":"Boolean", + "documentation":"

Indicates whether a DB instance supports IAM database authentication.

" + }, + "SupportsPerformanceInsights":{ + "shape":"Boolean", + "documentation":"

True if a DB instance supports Performance Insights, otherwise false.

" + }, + "MinStorageSize":{ + "shape":"IntegerOptional", + "documentation":"

Minimum storage size for a DB instance.

" + }, + "MaxStorageSize":{ + "shape":"IntegerOptional", + "documentation":"

Maximum storage size for a DB instance.

" + }, + "MinIopsPerDbInstance":{ + "shape":"IntegerOptional", + "documentation":"

Minimum total provisioned IOPS for a DB instance.

" + }, + "MaxIopsPerDbInstance":{ + "shape":"IntegerOptional", + "documentation":"

Maximum total provisioned IOPS for a DB instance.

" + }, + "MinIopsPerGib":{ + "shape":"DoubleOptional", + "documentation":"

Minimum provisioned IOPS per GiB for a DB instance.

" + }, + "MaxIopsPerGib":{ + "shape":"DoubleOptional", + "documentation":"

Maximum provisioned IOPS per GiB for a DB instance.

" + } + }, + "documentation":"

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

", + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

" + } + } + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

Specifies the name of the parameter.

" + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

Specifies the value of the parameter.

" + }, + "Description":{ + "shape":"String", + "documentation":"

Provides a description of the parameter.

" + }, + "Source":{ + "shape":"String", + "documentation":"

Indicates the source of the parameter value.

" + }, + "ApplyType":{ + "shape":"String", + "documentation":"

Specifies the engine specific parameters type.

" + }, + "DataType":{ + "shape":"String", + "documentation":"

Specifies the valid data type for the parameter.

" + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

Specifies the valid range of values for the parameter.

" + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

" + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

The earliest engine version to which the parameter can apply.

" + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

Indicates when to apply parameter updates.

" + } + }, + "documentation":"

Specifies a parameter.

" + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingCloudwatchLogsExports":{ + "type":"structure", + "members":{ + "LogTypesToEnable":{ + "shape":"LogTypeList", + "documentation":"

Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

" + }, + "LogTypesToDisable":{ + "shape":"LogTypeList", + "documentation":"

Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

" + } + }, + "documentation":"

A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

" + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"String", + "documentation":"

The type of pending maintenance action that is available for the resource.

" + }, + "AutoAppliedAfterDate":{ + "shape":"TStamp", + "documentation":"

The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any next-maintenance opt-in requests are ignored.

" + }, + "ForcedApplyDate":{ + "shape":"TStamp", + "documentation":"

The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any immediate opt-in requests are ignored.

" + }, + "OptInStatus":{ + "shape":"String", + "documentation":"

Indicates the type of opt-in request that has been received for the resource.

" + }, + "CurrentApplyDate":{ + "shape":"TStamp", + "documentation":"

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description providing more detail about the maintenance action.

" + } + }, + "documentation":"

Provides information about a pending maintenance action for a resource.

" + }, + "PendingMaintenanceActionDetails":{ + "type":"list", + "member":{ + "shape":"PendingMaintenanceAction", + "locationName":"PendingMaintenanceAction" + } + }, + "PendingMaintenanceActions":{ + "type":"list", + "member":{ + "shape":"ResourcePendingMaintenanceActions", + "locationName":"ResourcePendingMaintenanceActions" + } + }, + "PendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "PendingMaintenanceActions":{ + "shape":"PendingMaintenanceActions", + "documentation":"

A list of the pending maintenance actions for the resource.

" + }, + "Marker":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

" + } + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

" + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

" + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

Contains the pending or currently-in-progress change of the master credentials for the DB instance.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending port for the DB instance.

" + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the pending number of days for which automated backups are retained.

" + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

Indicates the database engine version.

" + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

" + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

" + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

" + }, + "StorageType":{ + "shape":"String", + "documentation":"

Specifies the storage type to be associated with the DB instance.

" + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the CA certificate for the DB instance.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The new DB subnet group for the DB instance.

" + }, + "PendingCloudwatchLogsExports":{ + "shape":"PendingCloudwatchLogsExports", + "documentation":"

Specifies the CloudWatch logs to be exported.

" + } + }, + "documentation":"

This data type is used as a response element in the ModifyDBInstance action.

" + }, + "PromoteReadReplicaDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

Not supported.

" + } + } + }, + "PromoteReadReplicaDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Provisioned IOPS not available in the specified Availability Zone.

", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Range":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

The minimum value in the range.

" + }, + "To":{ + "shape":"Integer", + "documentation":"

The maximum value in the range.

" + }, + "Step":{ + "shape":"IntegerOptional", + "documentation":"

The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

" + } + }, + "documentation":"

A range of integer values.

" + }, + "RangeList":{ + "type":"list", + "member":{ + "shape":"Range", + "locationName":"Range" + } + }, + "ReadReplicaDBClusterIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBClusterIdentifier" + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "ReadReplicaIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

" + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

When true, the reboot is conducted through a MultiAZ failover.

Constraint: You can't specify true if the instance is not configured for MultiAZ.

" + } + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveRoleFromDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "RoleArn" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the DB cluster to disassociate the IAM role from.

" + }, + "RoleArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

" + } + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

The name of the event notification subscription you want to remove a source identifier from.

" + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

" + } + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

The Amazon Neptune resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an Amazon Resource Name (ARN).

" + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

The tag key (name) of the tag to be removed.

" + } + } + }, + "ResetDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to reset.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

A value that is set to true to reset all parameters in the DB cluster parameter group to their default values, and false otherwise. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

" + } + } + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB parameter group.

Constraints:

  • Must match the name of an existing DBParameterGroup.

" + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

" + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Valid Values (for Apply method): pending-reboot

" + } + } + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The specified resource ID was not found.

", + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourcePendingMaintenanceActions":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

The ARN of the resource that has pending maintenance actions.

" + }, + "PendingMaintenanceActionDetails":{ + "shape":"PendingMaintenanceActionDetails", + "documentation":"

A list that provides details about the pending maintenance actions for the resource.

" + } + }, + "documentation":"

Describes the pending maintenance actions for a resource.

", + "wrapper":true + }, + "RestoreDBClusterFromSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

" + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

" + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

  • Must match the identifier of an existing Snapshot.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version of the database engine to use for the new DB cluster.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

Not supported.

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group to use for the restored DB cluster.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VPC security groups that the new DB cluster will belong to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be assigned to the restored DB cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

  • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + } + } + }, + "RestoreDBClusterFromSnapshotResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterToPointInTimeMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

The name of the new DB cluster to be created.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

" + }, + "RestoreType":{ + "shape":"String", + "documentation":"

The type of restore to be performed. You can specify one of the following values:

  • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

  • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

" + }, + "SourceDBClusterIdentifier":{ + "shape":"String", + "documentation":"

The identifier of the source DB cluster from which to restore.

Constraints:

  • Must match the identifier of an existing DBCluster.

" + }, + "RestoreToTime":{ + "shape":"TStamp", + "documentation":"

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

  • Must be before the latest restorable time for the DB instance

  • Must be specified if UseLatestRestorableTime parameter is not provided

  • Cannot be specified if UseLatestRestorableTime parameter is true

  • Cannot be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

" + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

" + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

" + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

" + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

The name of the option group for the new DB cluster.

" + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

A list of VPC security groups that the new DB cluster belongs to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags to be applied to the restored DB cluster.

" + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

  • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

  • If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

" + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

" + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

" + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

  • If supplied, must match the name of an existing DBClusterParameterGroup.

" + } + } + }, + "RestoreDBClusterToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The SNS topic is invalid.

", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

There is no SNS authorization.

", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The ARN of the SNS topic could not be found.

", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SharedSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

", + "error":{ + "code":"SharedSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed number of DB snapshots.

", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The source could not be found.

", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot", + "db-cluster", + "db-cluster-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

Request would result in user exceeding the allowed amount of storage available across all DB instances.

", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

StorageType specified cannot be associated with the DB Instance.

", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

Specifies the identifier of the subnet.

" + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

Specifies the EC2 Availability Zone that the subnet is in.

" + }, + "SubnetStatus":{ + "shape":"String", + "documentation":"

Specifies the status of the subnet.

" + } + }, + "documentation":"

Specifies a subnet.

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The DB subnet is already in use in the Availability Zone.

", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

This subscription already exists.

", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The designated subscription category could not be found.

", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

The designated subscription could not be found.

", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "SupportedTimezonesList":{ + "type":"list", + "member":{ + "shape":"Timezone", + "locationName":"Timezone" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + }, + "Value":{ + "shape":"String", + "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + } + }, + "documentation":"

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

" + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

List of tags returned by the ListTagsForResource operation.

" + } + } + }, + "Timezone":{ + "type":"structure", + "members":{ + "TimezoneName":{ + "shape":"String", + "documentation":"

The name of the time zone.

" + } + }, + "documentation":"

A time zone associated with a DBInstance.

" + }, + "UpgradeTarget":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

The name of the upgrade target database engine.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The version number of the upgrade target database engine.

" + }, + "Description":{ + "shape":"String", + "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" + }, + "AutoUpgrade":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

" + }, + "IsMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

A value that indicates whether a database engine is upgraded to a major version.

" + } + }, + "documentation":"

The version of the database engine that a DB instance can be upgraded to.

" + }, + "ValidDBInstanceModificationsMessage":{ + "type":"structure", + "members":{ + "Storage":{ + "shape":"ValidStorageOptionsList", + "documentation":"

Valid storage options for your DB instance.

" + } + }, + "documentation":"

Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

", + "wrapper":true + }, + "ValidStorageOptions":{ + "type":"structure", + "members":{ + "StorageType":{ + "shape":"String", + "documentation":"

The valid storage types for your DB instance. For example, gp2, io1.

" + }, + "StorageSize":{ + "shape":"RangeList", + "documentation":"

The valid range of storage in gibibytes. For example, 100 to 16384.

" + }, + "ProvisionedIops":{ + "shape":"RangeList", + "documentation":"

The valid range of provisioned IOPS. For example, 1000-20000.

" + }, + "IopsToStorageRatio":{ + "shape":"DoubleRangeList", + "documentation":"

The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

" + } + }, + "documentation":"

Information about valid modifications that you can make to your DB instance.

Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

" + }, + "ValidStorageOptionsList":{ + "type":"list", + "member":{ + "shape":"ValidStorageOptions", + "locationName":"ValidStorageOptions" + } + }, + "ValidUpgradeTargetList":{ + "type":"list", + "member":{ + "shape":"UpgradeTarget", + "locationName":"UpgradeTarget" + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

The name of the VPC security group.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The status of the VPC security group.

" + } + }, + "documentation":"

This data type is used as a response element for queries on VPC security group membership.

" + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + } + }, + "documentation":"Amazon Neptune

Amazon Neptune is a fast, reliable, fully-managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Amazon Neptune is a purpose-built, high-performance graph database engine optimized for storing billions of relationships and querying the graph with milliseconds latency. Amazon Neptune supports popular graph models Property Graph and W3C's RDF, and their respective query languages Apache TinkerPop Gremlin and SPARQL, allowing you to easily build queries that efficiently navigate highly connected datasets. Neptune powers graph use cases such as recommendation engines, fraud detection, knowledge graphs, drug discovery, and network security.

This interface reference for Amazon Neptune contains documentation for a programming or command line interface you can use to manage Amazon Neptune. Note that Amazon Neptune is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

" +} diff --git a/aws/dist/botocore/data/neptune/2014-10-31/service-2.sdk-extras.json b/aws/dist/botocore/data/neptune/2014-10-31/service-2.sdk-extras.json new file mode 100644 index 00000000..85e8a104 --- /dev/null +++ b/aws/dist/botocore/data/neptune/2014-10-31/service-2.sdk-extras.json @@ -0,0 +1,23 @@ + { + "version": 1.0, + "merge": { + "shapes": { + "CopyDBClusterSnapshotMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

The ID of the region that contains the snapshot to be copied.

" + } + } + }, + "CreateDBClusterMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

The ID of the region that contains the source for the db cluster.

" + } + } + } + } + } +} diff --git a/aws/dist/botocore/data/neptune/2014-10-31/waiters-2.json b/aws/dist/botocore/data/neptune/2014-10-31/waiters-2.json new file mode 100644 index 00000000..e75f03b2 --- /dev/null +++ b/aws/dist/botocore/data/neptune/2014-10-31/waiters-2.json @@ -0,0 +1,90 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/opsworks/2013-02-18/examples-1.json b/aws/dist/botocore/data/opsworks/2013-02-18/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/opsworks/2013-02-18/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/opsworks/2013-02-18/paginators-1.json b/aws/dist/botocore/data/opsworks/2013-02-18/paginators-1.json new file mode 100644 index 00000000..77936158 --- /dev/null +++ b/aws/dist/botocore/data/opsworks/2013-02-18/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "DescribeEcsClusters": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "EcsClusters" + } + } +} diff --git a/aws/dist/botocore/data/opsworks/2013-02-18/service-2.json b/aws/dist/botocore/data/opsworks/2013-02-18/service-2.json new file mode 100644 index 00000000..68e9434a --- /dev/null +++ b/aws/dist/botocore/data/opsworks/2013-02-18/service-2.json @@ -0,0 +1,4983 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-02-18", + "endpointPrefix":"opsworks", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS OpsWorks", + "serviceId":"OpsWorks", + "signatureVersion":"v4", + "targetPrefix":"OpsWorks_20130218", + "uid":"opsworks-2013-02-18" + }, + "operations":{ + "AssignInstance":{ + "name":"AssignInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Assign a registered instance to a layer.

  • You can assign registered on-premises instances to any layer type.

  • You can assign registered Amazon EC2 instances only to custom layers.

  • You cannot use this action with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an AWS Identity and Access Management (IAM) user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "AssignVolume":{ + "name":"AssignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "AssociateElasticIp":{ + "name":"AssociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "AttachElasticLoadBalancer":{ + "name":"AttachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachElasticLoadBalancerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. For more information, see Elastic Load Balancing.

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CloneStack":{ + "name":"CloneStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CloneStackRequest"}, + "output":{"shape":"CloneStackResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "CreateApp":{ + "name":"CreateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppRequest"}, + "output":{"shape":"CreateAppResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates an app for a specified stack. For more information, see Creating Apps.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateDeployment":{ + "name":"CreateDeployment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDeploymentRequest"}, + "output":{"shape":"CreateDeploymentResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateInstance":{ + "name":"CreateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateInstanceRequest"}, + "output":{"shape":"CreateInstanceResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateLayer":{ + "name":"CreateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLayerRequest"}, + "output":{"shape":"CreateLayerResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Creates a layer. For more information, see How to Create a Layer.

You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "CreateStack":{ + "name":"CreateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStackRequest"}, + "output":{"shape":"CreateStackResult"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "CreateUserProfile":{ + "name":"CreateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserProfileRequest"}, + "output":{"shape":"CreateUserProfileResult"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Creates a new user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DeleteApp":{ + "name":"DeleteApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a specified app.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteInstance":{ + "name":"DeleteInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

For more information, see Deleting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteLayer":{ + "name":"DeleteLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLayerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteStack":{ + "name":"DeleteStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down a Stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeleteUserProfile":{ + "name":"DeleteUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes a user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DeregisterEcsCluster":{ + "name":"DeregisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterEcsClusterRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

" + }, + "DeregisterElasticIp":{ + "name":"DeregisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterInstance":{ + "name":"DeregisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action cannot be used with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterRdsDbInstance":{ + "name":"DeregisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregisters an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DeregisterVolume":{ + "name":"DeregisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeAgentVersions":{ + "name":"DescribeAgentVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAgentVersionsRequest"}, + "output":{"shape":"DescribeAgentVersionsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

" + }, + "DescribeApps":{ + "name":"DescribeApps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAppsRequest"}, + "output":{"shape":"DescribeAppsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of a specified set of apps.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeCommands":{ + "name":"DescribeCommands", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCommandsRequest"}, + "output":{"shape":"DescribeCommandsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the results of specified commands.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeDeployments":{ + "name":"DescribeDeployments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDeploymentsRequest"}, + "output":{"shape":"DescribeDeploymentsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of a specified set of deployments.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeEcsClusters":{ + "name":"DescribeEcsClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEcsClustersRequest"}, + "output":{"shape":"DescribeEcsClustersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

" + }, + "DescribeElasticIps":{ + "name":"DescribeElasticIps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticIpsRequest"}, + "output":{"shape":"DescribeElasticIpsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes Elastic IP addresses.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeElasticLoadBalancers":{ + "name":"DescribeElasticLoadBalancers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeElasticLoadBalancersRequest"}, + "output":{"shape":"DescribeElasticLoadBalancersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a stack's Elastic Load Balancing instances.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeInstances":{ + "name":"DescribeInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancesRequest"}, + "output":{"shape":"DescribeInstancesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of a set of instances.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeLayers":{ + "name":"DescribeLayers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLayersRequest"}, + "output":{"shape":"DescribeLayersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of one or more layers in a specified stack.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeLoadBasedAutoScaling":{ + "name":"DescribeLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoadBasedAutoScalingRequest"}, + "output":{"shape":"DescribeLoadBasedAutoScalingResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeMyUserProfile":{ + "name":"DescribeMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeMyUserProfileResult"}, + "documentation":"

Describes a user's SSH information.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeOperatingSystems":{ + "name":"DescribeOperatingSystems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeOperatingSystemsResponse"}, + "documentation":"

Describes the operating systems that are supported by AWS OpsWorks Stacks.

" + }, + "DescribePermissions":{ + "name":"DescribePermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePermissionsRequest"}, + "output":{"shape":"DescribePermissionsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the permissions for a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DescribeRaidArrays":{ + "name":"DescribeRaidArrays", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRaidArraysRequest"}, + "output":{"shape":"DescribeRaidArraysResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describe an instance's RAID arrays.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeRdsDbInstances":{ + "name":"DescribeRdsDbInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRdsDbInstancesRequest"}, + "output":{"shape":"DescribeRdsDbInstancesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes Amazon RDS instances.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

" + }, + "DescribeServiceErrors":{ + "name":"DescribeServiceErrors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceErrorsRequest"}, + "output":{"shape":"DescribeServiceErrorsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes AWS OpsWorks Stacks service errors.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

This call accepts only one resource-identifying parameter.

" + }, + "DescribeStackProvisioningParameters":{ + "name":"DescribeStackProvisioningParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackProvisioningParametersRequest"}, + "output":{"shape":"DescribeStackProvisioningParametersResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of a stack's provisioning parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeStackSummary":{ + "name":"DescribeStackSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStackSummaryRequest"}, + "output":{"shape":"DescribeStackSummaryResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeStacks":{ + "name":"DescribeStacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStacksRequest"}, + "output":{"shape":"DescribeStacksResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Requests a description of one or more stacks.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeTimeBasedAutoScaling":{ + "name":"DescribeTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTimeBasedAutoScalingRequest"}, + "output":{"shape":"DescribeTimeBasedAutoScalingResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the parameters.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeUserProfiles":{ + "name":"DescribeUserProfiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserProfilesRequest"}, + "output":{"shape":"DescribeUserProfilesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describe specified users.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DescribeVolumes":{ + "name":"DescribeVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVolumesRequest"}, + "output":{"shape":"DescribeVolumesResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an instance's Amazon EBS volumes.

This call accepts only one resource-identifying parameter.

Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "DetachElasticLoadBalancer":{ + "name":"DetachElasticLoadBalancer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachElasticLoadBalancerRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Detaches a specified Elastic Load Balancing instance from its layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "DisassociateElasticIp":{ + "name":"DisassociateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "GetHostnameSuggestion":{ + "name":"GetHostnameSuggestion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostnameSuggestionRequest"}, + "output":{"shape":"GetHostnameSuggestionResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets a generated host name for the specified layer, based on the current host name theme.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "GrantAccess":{ + "name":"GrantAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GrantAccessRequest"}, + "output":{"shape":"GrantAccessResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

" + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsRequest"}, + "output":{"shape":"ListTagsResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of tags that are applied to the specified stack or layer.

" + }, + "RebootInstance":{ + "name":"RebootInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterEcsCluster":{ + "name":"RegisterEcsCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterEcsClusterRequest"}, + "output":{"shape":"RegisterEcsClusterResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterElasticIp":{ + "name":"RegisterElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterElasticIpRequest"}, + "output":{"shape":"RegisterElasticIpResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterInstance":{ + "name":"RegisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterInstanceRequest"}, + "output":{"shape":"RegisterInstanceResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack.

Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterRdsDbInstance":{ + "name":"RegisterRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers an Amazon RDS instance with a stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "RegisterVolume":{ + "name":"RegisterVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterVolumeRequest"}, + "output":{"shape":"RegisterVolumeResult"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetLoadBasedAutoScaling":{ + "name":"SetLoadBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLoadBasedAutoScalingRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetPermission":{ + "name":"SetPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetPermissionRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Specifies a user's permissions. For more information, see Security and Permissions.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "SetTimeBasedAutoScaling":{ + "name":"SetTimeBasedAutoScaling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTimeBasedAutoScalingRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StartInstance":{ + "name":"StartInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StartStack":{ + "name":"StartStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Starts a stack's instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StopInstance":{ + "name":"StopInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "StopStack":{ + "name":"StopStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Stops a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.

" + }, + "UnassignInstance":{ + "name":"UnassignInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "UnassignVolume":{ + "name":"UnassignVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnassignVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes tags from a specified stack or layer.

" + }, + "UpdateApp":{ + "name":"UpdateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAppRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a specified app.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateElasticIp":{ + "name":"UpdateElasticIp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateElasticIpRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a registered Elastic IP address's name. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateInstance":{ + "name":"UpdateInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a specified instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateLayer":{ + "name":"UpdateLayer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateLayerRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a specified layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateMyUserProfile":{ + "name":"UpdateMyUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMyUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"} + ], + "documentation":"

Updates a user's SSH public key.

Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "UpdateRdsDbInstance":{ + "name":"UpdateRdsDbInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRdsDbInstanceRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates an Amazon RDS instance.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateStack":{ + "name":"UpdateStack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStackRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a specified stack.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + }, + "UpdateUserProfile":{ + "name":"UpdateUserProfile", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserProfileRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates a specified user profile.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

" + }, + "UpdateVolume":{ + "name":"UpdateVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVolumeRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

" + } + }, + "shapes":{ + "AgentVersion":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"String", + "documentation":"

The agent version.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager.

" + } + }, + "documentation":"

Describes an agent version.

" + }, + "AgentVersions":{ + "type":"list", + "member":{"shape":"AgentVersion"} + }, + "App":{ + "type":"structure", + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The app stack ID.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The app's short name.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data sources.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that describes the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether to enable SSL for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

The stack attributes.

" + }, + "CreatedAt":{ + "shape":"String", + "documentation":"

When the app was created.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an \"Environment: is too large (maximum is 20 KB)\" message.

" + } + }, + "documentation":"

A description of the app.

" + }, + "AppAttributes":{ + "type":"map", + "key":{"shape":"AppAttributesKeys"}, + "value":{"shape":"String"} + }, + "AppAttributesKeys":{ + "type":"string", + "enum":[ + "DocumentRoot", + "RailsEnv", + "AutoBundleOnDeploy", + "AwsFlowRubySettings" + ] + }, + "AppType":{ + "type":"string", + "enum":[ + "aws-flow-ruby", + "java", + "rails", + "php", + "nodejs", + "static", + "other" + ] + }, + "Apps":{ + "type":"list", + "member":{"shape":"App"} + }, + "Architecture":{ + "type":"string", + "enum":[ + "x86_64", + "i386" + ] + }, + "AssignInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "LayerIds" + ], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

" + } + } + }, + "AssignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "AssociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "AttachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer to which the Elastic Load Balancing instance is to be attached.

" + } + } + }, + "AutoScalingThresholds":{ + "type":"structure", + "members":{ + "InstanceCount":{ + "shape":"Integer", + "documentation":"

The number of instances to add or remove when the load exceeds a threshold.

" + }, + "ThresholdsWaitTime":{ + "shape":"Minute", + "documentation":"

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

" + }, + "IgnoreMetricsTime":{ + "shape":"Minute", + "documentation":"

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

" + }, + "CpuThreshold":{ + "shape":"Double", + "documentation":"

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

" + }, + "MemoryThreshold":{ + "shape":"Double", + "documentation":"

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

" + }, + "LoadThreshold":{ + "shape":"Double", + "documentation":"

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

" + }, + "Alarms":{ + "shape":"Strings", + "documentation":"

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

" + } + }, + "documentation":"

Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.

" + }, + "AutoScalingType":{ + "type":"string", + "enum":[ + "load", + "timer" + ] + }, + "BlockDeviceMapping":{ + "type":"structure", + "members":{ + "DeviceName":{ + "shape":"String", + "documentation":"

The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

" + }, + "NoDevice":{ + "shape":"String", + "documentation":"

Suppresses the specified device included in the AMI's block device mapping.

" + }, + "VirtualName":{ + "shape":"String", + "documentation":"

The virtual device name. For more information, see BlockDeviceMapping.

" + }, + "Ebs":{ + "shape":"EbsBlockDevice", + "documentation":"

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

" + } + }, + "documentation":"

Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.

" + }, + "BlockDeviceMappings":{ + "type":"list", + "member":{"shape":"BlockDeviceMapping"} + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ChefConfiguration":{ + "type":"structure", + "members":{ + "ManageBerkshelf":{ + "shape":"Boolean", + "documentation":"

Whether to enable Berkshelf.

" + }, + "BerkshelfVersion":{ + "shape":"String", + "documentation":"

The Berkshelf version.

" + } + }, + "documentation":"

Describes the Chef configuration.

" + }, + "CloneStackRequest":{ + "type":"structure", + "required":[ + "SourceStackId", + "ServiceRoleArn" + ], + "members":{ + "SourceStackId":{ + "shape":"String", + "documentation":"

The source stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The cloned stack name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The cloned stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

  • If your account supports EC2 Classic, the default value is no VPC.

  • If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.

  • You must specify a value for DefaultSubnetId.

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities_and_Titans

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether to use custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.

  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" + }, + "CustomCookbooksSource":{ + "shape":"Source", + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

" + }, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" + }, + "ClonePermissions":{ + "shape":"Boolean", + "documentation":"

Whether to clone the source stack's permissions.

" + }, + "CloneAppIds":{ + "shape":"Strings", + "documentation":"

A list of source stack app IDs to be included in the cloned stack.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" + } + } + }, + "CloneStackResult":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The cloned stack ID.

" + } + }, + "documentation":"

Contains the response to a CloneStack request.

" + }, + "CloudWatchLogsConfiguration":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Boolean", + "documentation":"

Whether CloudWatch Logs is enabled for a layer.

" + }, + "LogStreams":{ + "shape":"CloudWatchLogsLogStreams", + "documentation":"

A list of configuration options for CloudWatch Logs.

" + } + }, + "documentation":"

Describes the Amazon CloudWatch logs configuration for a layer.

" + }, + "CloudWatchLogsEncoding":{ + "type":"string", + "documentation":"

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

", + "enum":[ + "ascii", + "big5", + "big5hkscs", + "cp037", + "cp424", + "cp437", + "cp500", + "cp720", + "cp737", + "cp775", + "cp850", + "cp852", + "cp855", + "cp856", + "cp857", + "cp858", + "cp860", + "cp861", + "cp862", + "cp863", + "cp864", + "cp865", + "cp866", + "cp869", + "cp874", + "cp875", + "cp932", + "cp949", + "cp950", + "cp1006", + "cp1026", + "cp1140", + "cp1250", + "cp1251", + "cp1252", + "cp1253", + "cp1254", + "cp1255", + "cp1256", + "cp1257", + "cp1258", + "euc_jp", + "euc_jis_2004", + "euc_jisx0213", + "euc_kr", + "gb2312", + "gbk", + "gb18030", + "hz", + "iso2022_jp", + "iso2022_jp_1", + "iso2022_jp_2", + "iso2022_jp_2004", + "iso2022_jp_3", + "iso2022_jp_ext", + "iso2022_kr", + "latin_1", + "iso8859_2", + "iso8859_3", + "iso8859_4", + "iso8859_5", + "iso8859_6", + "iso8859_7", + "iso8859_8", + "iso8859_9", + "iso8859_10", + "iso8859_13", + "iso8859_14", + "iso8859_15", + "iso8859_16", + "johab", + "koi8_r", + "koi8_u", + "mac_cyrillic", + "mac_greek", + "mac_iceland", + "mac_latin2", + "mac_roman", + "mac_turkish", + "ptcp154", + "shift_jis", + "shift_jis_2004", + "shift_jisx0213", + "utf_32", + "utf_32_be", + "utf_32_le", + "utf_16", + "utf_16_be", + "utf_16_le", + "utf_7", + "utf_8", + "utf_8_sig" + ] + }, + "CloudWatchLogsInitialPosition":{ + "type":"string", + "documentation":"

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.

", + "enum":[ + "start_of_file", + "end_of_file" + ] + }, + "CloudWatchLogsLogStream":{ + "type":"structure", + "members":{ + "LogGroupName":{ + "shape":"String", + "documentation":"

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

" + }, + "DatetimeFormat":{ + "shape":"String", + "documentation":"

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

" + }, + "TimeZone":{ + "shape":"CloudWatchLogsTimeZone", + "documentation":"

Specifies the time zone of log event time stamps.

" + }, + "File":{ + "shape":"String", + "documentation":"

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

" + }, + "FileFingerprintLines":{ + "shape":"String", + "documentation":"

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

" + }, + "MultiLineStartPattern":{ + "shape":"String", + "documentation":"

Specifies the pattern for identifying the start of a log message.

" + }, + "InitialPosition":{ + "shape":"CloudWatchLogsInitialPosition", + "documentation":"

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

" + }, + "Encoding":{ + "shape":"CloudWatchLogsEncoding", + "documentation":"

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

" + }, + "BufferDuration":{ + "shape":"Integer", + "documentation":"

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

" + }, + "BatchCount":{ + "shape":"Integer", + "documentation":"

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

" + }, + "BatchSize":{ + "shape":"Integer", + "documentation":"

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

" + } + }, + "documentation":"

Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference.

" + }, + "CloudWatchLogsLogStreams":{ + "type":"list", + "member":{"shape":"CloudWatchLogsLogStream"}, + "documentation":"

Describes the Amazon CloudWatch logs configuration for a layer.

" + }, + "CloudWatchLogsTimeZone":{ + "type":"string", + "documentation":"

The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC, for Coordinated Universal Time.

", + "enum":[ + "LOCAL", + "UTC" + ] + }, + "Command":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"String", + "documentation":"

The command ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance where the command was executed.

" + }, + "DeploymentId":{ + "shape":"String", + "documentation":"

The command deployment ID.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date and time when the command was run.

" + }, + "AcknowledgedAt":{ + "shape":"DateTime", + "documentation":"

Date and time when the command was acknowledged.

" + }, + "CompletedAt":{ + "shape":"DateTime", + "documentation":"

Date when the command completed.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The command status:

  • failed

  • successful

  • skipped

  • pending

" + }, + "ExitCode":{ + "shape":"Integer", + "documentation":"

The command exit code.

" + }, + "LogUrl":{ + "shape":"String", + "documentation":"

The URL of the command log.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The command type:

  • configure

  • deploy

  • execute_recipes

  • install_dependencies

  • restart

  • rollback

  • setup

  • start

  • stop

  • undeploy

  • update_custom_cookbooks

  • update_dependencies

" + } + }, + "documentation":"

Describes a command.

" + }, + "Commands":{ + "type":"list", + "member":{"shape":"Command"} + }, + "CreateAppRequest":{ + "type":"structure", + "required":[ + "StackId", + "Name", + "Type" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The app's short name.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data source.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that specifies the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether to enable SSL for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20KB).\"

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

" + } + } + }, + "CreateAppResult":{ + "type":"structure", + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + } + }, + "documentation":"

Contains the response to a CreateApp request.

" + }, + "CreateDeploymentRequest":{ + "type":"structure", + "required":[ + "StackId", + "Command" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID. This parameter is required for app deployments, but not for other deployment commands.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

The instance IDs for the deployment targets.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

The layer IDs for the deployment targets.

" + }, + "Command":{ + "shape":"DeploymentCommand", + "documentation":"

A DeploymentCommand object that specifies the deployment command and any associated arguments.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

" + } + } + }, + "CreateDeploymentResult":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID, which can be used with other requests to identify the deployment.

" + } + }, + "documentation":"

Contains the response to a CreateDeployment request.

" + }, + "CreateInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "LayerIds", + "InstanceType" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array that contains the instance's layer IDs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance's Amazon EC2 key-pair name.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" + }, + "VirtualizationType":{ + "shape":"String", + "documentation":"

The instance's virtualization type, paravirtual or hvm.

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" + }, + "RootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The instance root device type. For more information, see Storage for the Root Device.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Whether to create an Amazon EBS-optimized instance.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

" + }, + "Tenancy":{ + "shape":"String", + "documentation":"

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

" + } + } + }, + "CreateInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + }, + "documentation":"

Contains the response to a CreateInstance request.

" + }, + "CreateLayerRequest":{ + "type":"structure", + "required":[ + "StackId", + "Type", + "Name", + "Shortname" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The layer stack ID.

" + }, + "Type":{ + "shape":"LayerType", + "documentation":"

The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name, which is used by the console.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

To create a cluster layer, set the EcsClusterArn attribute to the cluster's ARN.

" + }, + "CloudWatchLogsConfiguration":{ + "shape":"CloudWatchLogsConfiguration", + "documentation":"

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON. This feature is supported as of version 1.7.42 of the AWS CLI.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer custom security group IDs.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describes the layer packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether to disable auto healing for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer custom recipes.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

To ensure that your instances have the latest security updates, we strongly recommend using the default value of true.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether to use Amazon EBS-optimized instances.

" + }, + "LifecycleEventConfiguration":{ + "shape":"LifecycleEventConfiguration", + "documentation":"

A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.

" + } + } + }, + "CreateLayerResult":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + }, + "documentation":"

Contains the response to a CreateLayer request.

" + }, + "CreateStackRequest":{ + "type":"structure", + "required":[ + "Name", + "Region", + "ServiceRoleArn", + "DefaultInstanceProfileArn" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.

In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

  • If your account supports EC2-Classic, the default value is no VPC.

  • If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.

  • You must specify a value for DefaultSubnetId.

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.

The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities_and_Titans

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" + }, + "CustomCookbooksSource":{ + "shape":"Source", + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

" + }, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" + } + } + }, + "CreateStackResult":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

" + } + }, + "documentation":"

Contains the response to a CreateStack request.

" + }, + "CreateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN; this can also be a federated user's ARN.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's public SSH key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

" + } + } + }, + "CreateUserProfileResult":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + } + }, + "documentation":"

Contains the response to a CreateUserProfile request.

" + }, + "DailyAutoScalingSchedule":{ + "type":"map", + "key":{"shape":"Hour"}, + "value":{"shape":"Switch"} + }, + "DataSource":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The data source's ARN.

" + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

The database name.

" + } + }, + "documentation":"

Describes an app's data source.

" + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DateTime":{"type":"string"}, + "DeleteAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + } + } + }, + "DeleteInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "DeleteElasticIp":{ + "shape":"Boolean", + "documentation":"

Whether to delete the instance Elastic IP address.

" + }, + "DeleteVolumes":{ + "shape":"Boolean", + "documentation":"

Whether to delete the instance's Amazon EBS volumes.

" + } + } + }, + "DeleteLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + } + }, + "DeleteStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DeleteUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN. This can also be a federated user's ARN.

" + } + } + }, + "Deployment":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date when the deployment was created.

" + }, + "CompletedAt":{ + "shape":"DateTime", + "documentation":"

Date when the deployment completed.

" + }, + "Duration":{ + "shape":"Integer", + "documentation":"

The deployment duration.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Comment":{ + "shape":"String", + "documentation":"

A user-defined comment.

" + }, + "Command":{ + "shape":"DeploymentCommand", + "documentation":"

Used to specify a stack or deployment command.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The deployment status:

  • running

  • successful

  • failed

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

The IDs of the target instances.

" + } + }, + "documentation":"

Describes a deployment of a stack or app.

" + }, + "DeploymentCommand":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DeploymentCommandName", + "documentation":"

Specifies the operation. You can specify only one command.

For stacks, the following commands are available:

  • execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {\"recipes\":[\"phpapp::appsetup\"]}.

  • install_dependencies: Install the stack's dependencies.

  • update_custom_cookbooks: Update the stack's custom cookbooks.

  • update_dependencies: Update the stack's dependencies.

The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

For apps, the following commands are available:

  • deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {\"migrate\":[\"true\"]} to migrate the database. The default setting is {\"migrate\":[\"false\"]}.

  • rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.

  • start: Start the app's web or application server.

  • stop: Stop the app's web or application server.

  • restart: Restart the app's web or application server.

  • undeploy: Undeploy the app.

" + }, + "Args":{ + "shape":"DeploymentCommandArgs", + "documentation":"

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

{\"arg_name1\" : [\"value1\", \"value2\", ...], \"arg_name2\" : [\"value1\", \"value2\", ...], ...}

The update_dependencies command takes two arguments:

  • upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set the allow_reboot argument to true.

  • allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.

For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the following.

{ \"upgrade_os_to\":[\"Amazon Linux 2016.09\"], \"allow_reboot\":[\"true\"] }

" + } + }, + "documentation":"

Used to specify a stack or deployment command.

" + }, + "DeploymentCommandArgs":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"Strings"} + }, + "DeploymentCommandName":{ + "type":"string", + "enum":[ + "install_dependencies", + "update_dependencies", + "update_custom_cookbooks", + "execute_recipes", + "configure", + "setup", + "deploy", + "rollback", + "start", + "stop", + "restart", + "undeploy" + ] + }, + "Deployments":{ + "type":"list", + "member":{"shape":"Deployment"} + }, + "DeregisterEcsClusterRequest":{ + "type":"structure", + "required":["EcsClusterArn"], + "members":{ + "EcsClusterArn":{ + "shape":"String", + "documentation":"

The cluster's Amazon Resource Number (ARN).

" + } + } + }, + "DeregisterElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + } + }, + "DeregisterInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "DeregisterRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + } + } + }, + "DeregisterVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

" + } + } + }, + "DescribeAgentVersionsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager.

" + } + } + }, + "DescribeAgentVersionsResult":{ + "type":"structure", + "members":{ + "AgentVersions":{ + "shape":"AgentVersions", + "documentation":"

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

" + } + }, + "documentation":"

Contains the response to a DescribeAgentVersions request.

" + }, + "DescribeAppsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

" + }, + "AppIds":{ + "shape":"Strings", + "documentation":"

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

" + } + } + }, + "DescribeAppsResult":{ + "type":"structure", + "members":{ + "Apps":{ + "shape":"Apps", + "documentation":"

An array of App objects that describe the specified apps.

" + } + }, + "documentation":"

Contains the response to a DescribeApps request.

" + }, + "DescribeCommandsRequest":{ + "type":"structure", + "members":{ + "DeploymentId":{ + "shape":"String", + "documentation":"

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

" + }, + "CommandIds":{ + "shape":"Strings", + "documentation":"

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

" + } + } + }, + "DescribeCommandsResult":{ + "type":"structure", + "members":{ + "Commands":{ + "shape":"Commands", + "documentation":"

An array of Command objects that describe each of the specified commands.

" + } + }, + "documentation":"

Contains the response to a DescribeCommands request.

" + }, + "DescribeDeploymentsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

" + }, + "AppId":{ + "shape":"String", + "documentation":"

The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

" + }, + "DeploymentIds":{ + "shape":"Strings", + "documentation":"

An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

" + } + } + }, + "DescribeDeploymentsResult":{ + "type":"structure", + "members":{ + "Deployments":{ + "shape":"Deployments", + "documentation":"

An array of Deployment objects that describe the deployments.

" + } + }, + "documentation":"

Contains the response to a DescribeDeployments request.

" + }, + "DescribeEcsClustersRequest":{ + "type":"structure", + "members":{ + "EcsClusterArns":{ + "shape":"Strings", + "documentation":"

A list of ARNs, one for each cluster to be described.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

" + }, + "MaxResults":{ + "shape":"Integer", + "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + } + } + }, + "DescribeEcsClustersResult":{ + "type":"structure", + "members":{ + "EcsClusters":{ + "shape":"EcsClusters", + "documentation":"

A list of EcsCluster objects containing the cluster descriptions.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

" + } + }, + "documentation":"

Contains the response to a DescribeEcsClusters request.

" + }, + "DescribeElasticIpsRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

" + }, + "Ips":{ + "shape":"Strings", + "documentation":"

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

" + } + } + }, + "DescribeElasticIpsResult":{ + "type":"structure", + "members":{ + "ElasticIps":{ + "shape":"ElasticIps", + "documentation":"

An ElasticIps object that describes the specified Elastic IP addresses.

" + } + }, + "documentation":"

Contains the response to a DescribeElasticIps request.

" + }, + "DescribeElasticLoadBalancersRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. The action describes the stack's Elastic Load Balancing instances.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

" + } + } + }, + "DescribeElasticLoadBalancersResult":{ + "type":"structure", + "members":{ + "ElasticLoadBalancers":{ + "shape":"ElasticLoadBalancers", + "documentation":"

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

" + } + }, + "documentation":"

Contains the response to a DescribeElasticLoadBalancers request.

" + }, + "DescribeInstancesRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

" + }, + "InstanceIds":{ + "shape":"Strings", + "documentation":"

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

" + } + } + }, + "DescribeInstancesResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Instances", + "documentation":"

An array of Instance objects that describe the instances.

" + } + }, + "documentation":"

Contains the response to a DescribeInstances request.

" + }, + "DescribeLayersRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

" + } + } + }, + "DescribeLayersResult":{ + "type":"structure", + "members":{ + "Layers":{ + "shape":"Layers", + "documentation":"

An array of Layer objects that describe the layers.

" + } + }, + "documentation":"

Contains the response to a DescribeLayers request.

" + }, + "DescribeLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerIds"], + "members":{ + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array of layer IDs.

" + } + } + }, + "DescribeLoadBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "LoadBasedAutoScalingConfigurations":{ + "shape":"LoadBasedAutoScalingConfigurations", + "documentation":"

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

" + } + }, + "documentation":"

Contains the response to a DescribeLoadBasedAutoScaling request.

" + }, + "DescribeMyUserProfileResult":{ + "type":"structure", + "members":{ + "UserProfile":{ + "shape":"SelfUserProfile", + "documentation":"

A UserProfile object that describes the user's SSH information.

" + } + }, + "documentation":"

Contains the response to a DescribeMyUserProfile request.

" + }, + "DescribeOperatingSystemsResponse":{ + "type":"structure", + "members":{ + "OperatingSystems":{ + "shape":"OperatingSystems", + "documentation":"

Contains information in response to a DescribeOperatingSystems request.

" + } + }, + "documentation":"

The response to a DescribeOperatingSystems request.

" + }, + "DescribePermissionsRequest":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DescribePermissionsResult":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"Permissions", + "documentation":"

An array of Permission objects that describe the stack permissions.

  • If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.

  • If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.

  • If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.

" + } + }, + "documentation":"

Contains the response to a DescribePermissions request.

" + }, + "DescribeRaidArraysRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "RaidArrayIds":{ + "shape":"Strings", + "documentation":"

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

" + } + } + }, + "DescribeRaidArraysResult":{ + "type":"structure", + "members":{ + "RaidArrays":{ + "shape":"RaidArrays", + "documentation":"

A RaidArrays object that describes the specified RAID arrays.

" + } + }, + "documentation":"

Contains the response to a DescribeRaidArrays request.

" + }, + "DescribeRdsDbInstancesRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

" + }, + "RdsDbInstanceArns":{ + "shape":"Strings", + "documentation":"

An array containing the ARNs of the instances to be described.

" + } + } + }, + "DescribeRdsDbInstancesResult":{ + "type":"structure", + "members":{ + "RdsDbInstances":{ + "shape":"RdsDbInstances", + "documentation":"

An a array of RdsDbInstance objects that describe the instances.

" + } + }, + "documentation":"

Contains the response to a DescribeRdsDbInstances request.

" + }, + "DescribeServiceErrorsRequest":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

" + }, + "ServiceErrorIds":{ + "shape":"Strings", + "documentation":"

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

" + } + } + }, + "DescribeServiceErrorsResult":{ + "type":"structure", + "members":{ + "ServiceErrors":{ + "shape":"ServiceErrors", + "documentation":"

An array of ServiceError objects that describe the specified service errors.

" + } + }, + "documentation":"

Contains the response to a DescribeServiceErrors request.

" + }, + "DescribeStackProvisioningParametersRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DescribeStackProvisioningParametersResult":{ + "type":"structure", + "members":{ + "AgentInstallerUrl":{ + "shape":"String", + "documentation":"

The AWS OpsWorks Stacks agent installer's URL.

" + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

An embedded object that contains the provisioning parameters.

" + } + }, + "documentation":"

Contains the response to a DescribeStackProvisioningParameters request.

" + }, + "DescribeStackSummaryRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "DescribeStackSummaryResult":{ + "type":"structure", + "members":{ + "StackSummary":{ + "shape":"StackSummary", + "documentation":"

A StackSummary object that contains the results.

" + } + }, + "documentation":"

Contains the response to a DescribeStackSummary request.

" + }, + "DescribeStacksRequest":{ + "type":"structure", + "members":{ + "StackIds":{ + "shape":"Strings", + "documentation":"

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

" + } + } + }, + "DescribeStacksResult":{ + "type":"structure", + "members":{ + "Stacks":{ + "shape":"Stacks", + "documentation":"

An array of Stack objects that describe the stacks.

" + } + }, + "documentation":"

Contains the response to a DescribeStacks request.

" + }, + "DescribeTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"Strings", + "documentation":"

An array of instance IDs.

" + } + } + }, + "DescribeTimeBasedAutoScalingResult":{ + "type":"structure", + "members":{ + "TimeBasedAutoScalingConfigurations":{ + "shape":"TimeBasedAutoScalingConfigurations", + "documentation":"

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

" + } + }, + "documentation":"

Contains the response to a DescribeTimeBasedAutoScaling request.

" + }, + "DescribeUserProfilesRequest":{ + "type":"structure", + "members":{ + "IamUserArns":{ + "shape":"Strings", + "documentation":"

An array of IAM or federated user ARNs that identify the users to be described.

" + } + } + }, + "DescribeUserProfilesResult":{ + "type":"structure", + "members":{ + "UserProfiles":{ + "shape":"UserProfiles", + "documentation":"

A Users object that describes the specified users.

" + } + }, + "documentation":"

Contains the response to a DescribeUserProfiles request.

" + }, + "DescribeVolumesRequest":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

A stack ID. The action describes the stack's registered Amazon EBS volumes.

" + }, + "RaidArrayId":{ + "shape":"String", + "documentation":"

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

" + }, + "VolumeIds":{ + "shape":"Strings", + "documentation":"

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

" + } + } + }, + "DescribeVolumesResult":{ + "type":"structure", + "members":{ + "Volumes":{ + "shape":"Volumes", + "documentation":"

An array of volume IDs.

" + } + }, + "documentation":"

Contains the response to a DescribeVolumes request.

" + }, + "DetachElasticLoadBalancerRequest":{ + "type":"structure", + "required":[ + "ElasticLoadBalancerName", + "LayerId" + ], + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer that the Elastic Load Balancing instance is attached to.

" + } + } + }, + "DisassociateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + } + }, + "Double":{ + "type":"double", + "box":true + }, + "EbsBlockDevice":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"String", + "documentation":"

The snapshot ID.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

" + }, + "VolumeSize":{ + "shape":"Integer", + "documentation":"

The volume size, in GiB. For more information, see EbsBlockDevice.

" + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Whether the volume is deleted on instance termination.

" + } + }, + "documentation":"

Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.

" + }, + "EcsCluster":{ + "type":"structure", + "members":{ + "EcsClusterArn":{ + "shape":"String", + "documentation":"

The cluster's ARN.

" + }, + "EcsClusterName":{ + "shape":"String", + "documentation":"

The cluster name.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "RegisteredAt":{ + "shape":"DateTime", + "documentation":"

The time and date that the cluster was registered with the stack.

" + } + }, + "documentation":"

Describes a registered Amazon ECS cluster.

" + }, + "EcsClusters":{ + "type":"list", + "member":{"shape":"EcsCluster"} + }, + "ElasticIp":{ + "type":"structure", + "members":{ + "Ip":{ + "shape":"String", + "documentation":"

The IP address.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The name.

" + }, + "Domain":{ + "shape":"String", + "documentation":"

The domain.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The AWS region. For more information, see Regions and Endpoints.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The ID of the instance that the address is attached to.

" + } + }, + "documentation":"

Describes an Elastic IP address.

" + }, + "ElasticIps":{ + "type":"list", + "member":{"shape":"ElasticIp"} + }, + "ElasticLoadBalancer":{ + "type":"structure", + "members":{ + "ElasticLoadBalancerName":{ + "shape":"String", + "documentation":"

The Elastic Load Balancing instance's name.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The instance's AWS region.

" + }, + "DnsName":{ + "shape":"String", + "documentation":"

The instance's public DNS name.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack that the instance is associated with.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The ID of the layer that the instance is attached to.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC ID.

" + }, + "AvailabilityZones":{ + "shape":"Strings", + "documentation":"

A list of Availability Zones.

" + }, + "SubnetIds":{ + "shape":"Strings", + "documentation":"

A list of subnet IDs, if the stack is running in a VPC.

" + }, + "Ec2InstanceIds":{ + "shape":"Strings", + "documentation":"

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

" + } + }, + "documentation":"

Describes an Elastic Load Balancing instance.

" + }, + "ElasticLoadBalancers":{ + "type":"list", + "member":{"shape":"ElasticLoadBalancer"} + }, + "EnvironmentVariable":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"String", + "documentation":"

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

" + }, + "Value":{ + "shape":"String", + "documentation":"

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

" + }, + "Secure":{ + "shape":"Boolean", + "documentation":"

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false.

" + } + }, + "documentation":"

Represents an app's environment variable.

" + }, + "EnvironmentVariables":{ + "type":"list", + "member":{"shape":"EnvironmentVariable"} + }, + "GetHostnameSuggestionRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + } + } + }, + "GetHostnameSuggestionResult":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The generated host name.

" + } + }, + "documentation":"

Contains the response to a GetHostnameSuggestion request.

" + }, + "GrantAccessRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance's AWS OpsWorks Stacks ID.

" + }, + "ValidForInMinutes":{ + "shape":"ValidForInMinutes", + "documentation":"

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

" + } + } + }, + "GrantAccessResult":{ + "type":"structure", + "members":{ + "TemporaryCredential":{ + "shape":"TemporaryCredential", + "documentation":"

A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

" + } + }, + "documentation":"

Contains the response to a GrantAccess request.

" + }, + "Hour":{"type":"string"}, + "Instance":{ + "type":"structure", + "members":{ + "AgentVersion":{ + "shape":"String", + "documentation":"

The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

A custom AMI ID to be used to create the instance. For more information, see Instances

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture: \"i386\" or \"x86_64\".

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The instance's Amazon Resource Number (ARN).

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

For load-based or time-based instances, the type.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The instance Availability Zone. For more information, see Regions and Endpoints.

" + }, + "BlockDeviceMappings":{ + "shape":"BlockDeviceMappings", + "documentation":"

An array of BlockDeviceMapping objects that specify the instance's block device mappings.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The time that the instance was created.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

Whether this is an Amazon EBS-optimized instance.

" + }, + "Ec2InstanceId":{ + "shape":"String", + "documentation":"

The ID of the associated Amazon EC2 instance.

" + }, + "EcsClusterArn":{ + "shape":"String", + "documentation":"

For container instances, the Amazon ECS cluster's ARN.

" + }, + "EcsContainerInstanceArn":{ + "shape":"String", + "documentation":"

For container instances, the instance's ARN.

" + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

The instance Elastic IP address .

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "InfrastructureClass":{ + "shape":"String", + "documentation":"

For registered instances, the infrastructure class: ec2 or on-premises.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "InstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type, such as t2.micro.

" + }, + "LastServiceErrorId":{ + "shape":"String", + "documentation":"

The ID of the last service error. For more information, call DescribeServiceErrors.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

An array containing the instance layer IDs.

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance's operating system.

" + }, + "Platform":{ + "shape":"String", + "documentation":"

The instance's platform.

" + }, + "PrivateDns":{ + "shape":"String", + "documentation":"

The instance's private DNS name.

" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The instance's private IP address.

" + }, + "PublicDns":{ + "shape":"String", + "documentation":"

The instance public DNS name.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The instance public IP address.

" + }, + "RegisteredBy":{ + "shape":"String", + "documentation":"

For registered instances, who performed the registration.

" + }, + "ReportedAgentVersion":{ + "shape":"String", + "documentation":"

The instance's reported AWS OpsWorks Stacks agent version.

" + }, + "ReportedOs":{ + "shape":"ReportedOs", + "documentation":"

For registered instances, the reported operating system.

" + }, + "RootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The instance's root device type. For more information, see Storage for the Root Device.

" + }, + "RootDeviceVolumeId":{ + "shape":"String", + "documentation":"

The root device volume ID.

" + }, + "SecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the instance security group IDs.

" + }, + "SshHostDsaKeyFingerprint":{ + "shape":"String", + "documentation":"

The SSH key's Deep Security Agent (DSA) fingerprint.

" + }, + "SshHostRsaKeyFingerprint":{ + "shape":"String", + "documentation":"

The SSH key's RSA fingerprint.

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance's Amazon EC2 key-pair name.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The instance status:

  • booting

  • connection_lost

  • online

  • pending

  • rebooting

  • requested

  • running_setup

  • setup_failed

  • shutting_down

  • start_failed

  • stop_failed

  • stopped

  • stopping

  • terminated

  • terminating

" + }, + "SubnetId":{ + "shape":"String", + "documentation":"

The instance's subnet ID; applicable only if the stack is running in a VPC.

" + }, + "Tenancy":{ + "shape":"String", + "documentation":"

The instance's tenancy option, such as dedicated or host.

" + }, + "VirtualizationType":{ + "shape":"VirtualizationType", + "documentation":"

The instance's virtualization type: paravirtual or hvm.

" + } + }, + "documentation":"

Describes an instance.

" + }, + "InstanceIdentity":{ + "type":"structure", + "members":{ + "Document":{ + "shape":"String", + "documentation":"

A JSON document that contains the metadata.

" + }, + "Signature":{ + "shape":"String", + "documentation":"

A signature that can be used to verify the document's accuracy and authenticity.

" + } + }, + "documentation":"

Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data.

" + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InstancesCount":{ + "type":"structure", + "members":{ + "Assigning":{ + "shape":"Integer", + "documentation":"

The number of instances in the Assigning state.

" + }, + "Booting":{ + "shape":"Integer", + "documentation":"

The number of instances with booting status.

" + }, + "ConnectionLost":{ + "shape":"Integer", + "documentation":"

The number of instances with connection_lost status.

" + }, + "Deregistering":{ + "shape":"Integer", + "documentation":"

The number of instances in the Deregistering state.

" + }, + "Online":{ + "shape":"Integer", + "documentation":"

The number of instances with online status.

" + }, + "Pending":{ + "shape":"Integer", + "documentation":"

The number of instances with pending status.

" + }, + "Rebooting":{ + "shape":"Integer", + "documentation":"

The number of instances with rebooting status.

" + }, + "Registered":{ + "shape":"Integer", + "documentation":"

The number of instances in the Registered state.

" + }, + "Registering":{ + "shape":"Integer", + "documentation":"

The number of instances in the Registering state.

" + }, + "Requested":{ + "shape":"Integer", + "documentation":"

The number of instances with requested status.

" + }, + "RunningSetup":{ + "shape":"Integer", + "documentation":"

The number of instances with running_setup status.

" + }, + "SetupFailed":{ + "shape":"Integer", + "documentation":"

The number of instances with setup_failed status.

" + }, + "ShuttingDown":{ + "shape":"Integer", + "documentation":"

The number of instances with shutting_down status.

" + }, + "StartFailed":{ + "shape":"Integer", + "documentation":"

The number of instances with start_failed status.

" + }, + "StopFailed":{ + "shape":"Integer", + "documentation":"

The number of instances with stop_failed status.

" + }, + "Stopped":{ + "shape":"Integer", + "documentation":"

The number of instances with stopped status.

" + }, + "Stopping":{ + "shape":"Integer", + "documentation":"

The number of instances with stopping status.

" + }, + "Terminated":{ + "shape":"Integer", + "documentation":"

The number of instances with terminated status.

" + }, + "Terminating":{ + "shape":"Integer", + "documentation":"

The number of instances with terminating status.

" + }, + "Unassigning":{ + "shape":"Integer", + "documentation":"

The number of instances in the Unassigning state.

" + } + }, + "documentation":"

Describes how many instances a stack has for each status.

" + }, + "Integer":{ + "type":"integer", + "box":true + }, + "Layer":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Number (ARN) of a layer.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The layer stack ID.

" + }, + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Type":{ + "shape":"LayerType", + "documentation":"

The layer type.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

The layer short name.

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

" + }, + "CloudWatchLogsConfiguration":{ + "shape":"CloudWatchLogsConfiguration", + "documentation":"

The Amazon CloudWatch Logs configuration settings for the layer.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer's custom security group IDs.

" + }, + "DefaultSecurityGroupNames":{ + "shape":"Strings", + "documentation":"

An array containing the layer's security group names.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describe the layer's packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether auto healing is disabled for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "DefaultRecipes":{ + "shape":"Recipes", + "documentation":"

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

" + }, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

Date when the layer was created.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set to false, you must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether the layer uses Amazon EBS-optimized instances.

" + }, + "LifecycleEventConfiguration":{ + "shape":"LifecycleEventConfiguration", + "documentation":"

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

" + } + }, + "documentation":"

Describes a layer.

" + }, + "LayerAttributes":{ + "type":"map", + "key":{"shape":"LayerAttributesKeys"}, + "value":{"shape":"String"} + }, + "LayerAttributesKeys":{ + "type":"string", + "enum":[ + "EcsClusterArn", + "EnableHaproxyStats", + "HaproxyStatsUrl", + "HaproxyStatsUser", + "HaproxyStatsPassword", + "HaproxyHealthCheckUrl", + "HaproxyHealthCheckMethod", + "MysqlRootPassword", + "MysqlRootPasswordUbiquitous", + "GangliaUrl", + "GangliaUser", + "GangliaPassword", + "MemcachedMemory", + "NodejsVersion", + "RubyVersion", + "RubygemsVersion", + "ManageBundler", + "BundlerVersion", + "RailsStack", + "PassengerVersion", + "Jvm", + "JvmVersion", + "JvmOptions", + "JavaAppServer", + "JavaAppServerVersion" + ] + }, + "LayerType":{ + "type":"string", + "enum":[ + "aws-flow-ruby", + "ecs-cluster", + "java-app", + "lb", + "web", + "php-app", + "rails-app", + "nodejs-app", + "memcached", + "db-master", + "monitoring-master", + "custom" + ] + }, + "Layers":{ + "type":"list", + "member":{"shape":"Layer"} + }, + "LifecycleEventConfiguration":{ + "type":"structure", + "members":{ + "Shutdown":{ + "shape":"ShutdownEventConfiguration", + "documentation":"

A ShutdownEventConfiguration object that specifies the Shutdown event configuration.

" + } + }, + "documentation":"

Specifies the lifecycle event configuration

" + }, + "ListTagsRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The stack or layer's Amazon Resource Number (ARN).

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.

" + } + } + }, + "ListTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

" + } + }, + "documentation":"

Contains the response to a ListTags request.

" + }, + "LoadBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Enable":{ + "shape":"Boolean", + "documentation":"

Whether load-based auto scaling is enabled for the layer.

" + }, + "UpScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances.

" + }, + "DownScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances.

" + } + }, + "documentation":"

Describes a layer's load-based auto scaling configuration.

" + }, + "LoadBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"LoadBasedAutoScalingConfiguration"} + }, + "MaxResults":{"type":"integer"}, + "Minute":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextToken":{"type":"string"}, + "OperatingSystem":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the operating system, such as Amazon Linux 2018.03.

" + }, + "Id":{ + "shape":"String", + "documentation":"

The ID of a supported operating system, such as Amazon Linux 2018.03.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The type of a supported operating system, either Linux or Windows.

" + }, + "ConfigurationManagers":{ + "shape":"OperatingSystemConfigurationManagers", + "documentation":"

Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.

" + }, + "ReportedName":{ + "shape":"String", + "documentation":"

A short name for the operating system manufacturer.

" + }, + "ReportedVersion":{ + "shape":"String", + "documentation":"

The version of the operating system, including the release and edition, if applicable.

" + }, + "Supported":{ + "shape":"Boolean", + "documentation":"

Indicates that an operating system is not supported for new instances.

" + } + }, + "documentation":"

Describes supported operating systems in AWS OpsWorks Stacks.

" + }, + "OperatingSystemConfigurationManager":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name of the configuration manager, which is Chef.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The versions of the configuration manager that are supported by an operating system.

" + } + }, + "documentation":"

A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.

" + }, + "OperatingSystemConfigurationManagers":{ + "type":"list", + "member":{"shape":"OperatingSystemConfigurationManager"} + }, + "OperatingSystems":{ + "type":"list", + "member":{"shape":"OperatingSystem"} + }, + "Parameters":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Permission":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

A stack ID.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

" + }, + "AllowSsh":{ + "shape":"Boolean", + "documentation":"

Whether the user can use SSH.

" + }, + "AllowSudo":{ + "shape":"Boolean", + "documentation":"

Whether the user can use sudo.

" + }, + "Level":{ + "shape":"String", + "documentation":"

The user's permission level, which must be the following:

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions

" + } + }, + "documentation":"

Describes stack or user permissions.

" + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "RaidArray":{ + "type":"structure", + "members":{ + "RaidArrayId":{ + "shape":"String", + "documentation":"

The array ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The array name.

" + }, + "RaidLevel":{ + "shape":"Integer", + "documentation":"

The RAID level.

" + }, + "NumberOfDisks":{ + "shape":"Integer", + "documentation":"

The number of disks in the array.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The array's size.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The array's Linux device. For example /dev/mdadm0.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The array's mount point.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The array's Availability Zone. For more information, see Regions and Endpoints.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

When the RAID array was created.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type, standard or PIOPS.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + } + }, + "documentation":"

Describes an instance's RAID array.

" + }, + "RaidArrays":{ + "type":"list", + "member":{"shape":"RaidArray"} + }, + "RdsDbInstance":{ + "type":"structure", + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The instance's ARN.

" + }, + "DbInstanceIdentifier":{ + "shape":"String", + "documentation":"

The DB instance identifier.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The instance's AWS region.

" + }, + "Address":{ + "shape":"String", + "documentation":"

The instance's address.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The instance's database engine.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack with which the instance is registered.

" + }, + "MissingOnRds":{ + "shape":"Boolean", + "documentation":"

Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts to discover the instance only once. If this value is set to true, you must deregister the instance, and then register it again.

" + } + }, + "documentation":"

Describes an Amazon RDS instance.

" + }, + "RdsDbInstances":{ + "type":"list", + "member":{"shape":"RdsDbInstance"} + }, + "RebootInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "Recipes":{ + "type":"structure", + "members":{ + "Setup":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a setup event.

" + }, + "Configure":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a configure event.

" + }, + "Deploy":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a deploy event.

" + }, + "Undeploy":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a undeploy event.

" + }, + "Shutdown":{ + "shape":"Strings", + "documentation":"

An array of custom recipe names to be run following a shutdown event.

" + } + }, + "documentation":"

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

" + }, + "RegisterEcsClusterRequest":{ + "type":"structure", + "required":[ + "EcsClusterArn", + "StackId" + ], + "members":{ + "EcsClusterArn":{ + "shape":"String", + "documentation":"

The cluster's ARN.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "RegisterEcsClusterResult":{ + "type":"structure", + "members":{ + "EcsClusterArn":{ + "shape":"String", + "documentation":"

The cluster's ARN.

" + } + }, + "documentation":"

Contains the response to a RegisterEcsCluster request.

" + }, + "RegisterElasticIpRequest":{ + "type":"structure", + "required":[ + "ElasticIp", + "StackId" + ], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "RegisterElasticIpResult":{ + "type":"structure", + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The Elastic IP address.

" + } + }, + "documentation":"

Contains the response to a RegisterElasticIp request.

" + }, + "RegisterInstanceRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The ID of the stack that the instance is to be registered with.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance's hostname.

" + }, + "PublicIp":{ + "shape":"String", + "documentation":"

The instance's public IP address.

" + }, + "PrivateIp":{ + "shape":"String", + "documentation":"

The instance's private IP address.

" + }, + "RsaPublicKey":{ + "shape":"String", + "documentation":"

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

" + }, + "RsaPublicKeyFingerprint":{ + "shape":"String", + "documentation":"

The instances public RSA key fingerprint.

" + }, + "InstanceIdentity":{ + "shape":"InstanceIdentity", + "documentation":"

An InstanceIdentity object that contains the instance's identity.

" + } + } + }, + "RegisterInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The registered instance's AWS OpsWorks Stacks ID.

" + } + }, + "documentation":"

Contains the response to a RegisterInstanceResult request.

" + }, + "RegisterRdsDbInstanceRequest":{ + "type":"structure", + "required":[ + "StackId", + "RdsDbInstanceArn", + "DbUser", + "DbPassword" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The database's master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

The database password.

" + } + } + }, + "RegisterVolumeRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "Ec2VolumeId":{ + "shape":"String", + "documentation":"

The Amazon EBS volume ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "RegisterVolumeResult":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + } + }, + "documentation":"

Contains the response to a RegisterVolume request.

" + }, + "ReportedOs":{ + "type":"structure", + "members":{ + "Family":{ + "shape":"String", + "documentation":"

The operating system family.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The operating system name.

" + }, + "Version":{ + "shape":"String", + "documentation":"

The operating system version.

" + } + }, + "documentation":"

A registered instance's reported operating system.

" + }, + "ResourceArn":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

Indicates that a resource was not found.

", + "exception":true + }, + "RootDeviceType":{ + "type":"string", + "enum":[ + "ebs", + "instance-store" + ] + }, + "SelfUserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The user's name.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + } + }, + "documentation":"

Describes a user's SSH information.

" + }, + "ServiceError":{ + "type":"structure", + "members":{ + "ServiceErrorId":{ + "shape":"String", + "documentation":"

The error ID.

" + }, + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Type":{ + "shape":"String", + "documentation":"

The error type.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A message that describes the error.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

When the error occurred.

" + } + }, + "documentation":"

Describes an AWS OpsWorks Stacks service error.

" + }, + "ServiceErrors":{ + "type":"list", + "member":{"shape":"ServiceError"} + }, + "SetLoadBasedAutoScalingRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Enable":{ + "shape":"Boolean", + "documentation":"

Enables load-based auto scaling for the layer.

" + }, + "UpScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.

" + }, + "DownScaling":{ + "shape":"AutoScalingThresholds", + "documentation":"

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.

" + } + } + }, + "SetPermissionRequest":{ + "type":"structure", + "required":[ + "StackId", + "IamUserArn" + ], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN. This can also be a federated user's ARN.

" + }, + "AllowSsh":{ + "shape":"Boolean", + "documentation":"

The user is allowed to use SSH to communicate with the instance.

" + }, + "AllowSudo":{ + "shape":"Boolean", + "documentation":"

The user is allowed to use sudo to elevate privileges.

" + }, + "Level":{ + "shape":"String", + "documentation":"

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

  • deny

  • show

  • deploy

  • manage

  • iam_only

For more information about the permissions associated with these levels, see Managing User Permissions.

" + } + } + }, + "SetTimeBasedAutoScalingRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "AutoScalingSchedule":{ + "shape":"WeeklyAutoScalingSchedule", + "documentation":"

An AutoScalingSchedule with the instance schedule.

" + } + } + }, + "ShutdownEventConfiguration":{ + "type":"structure", + "members":{ + "ExecutionTimeout":{ + "shape":"Integer", + "documentation":"

The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.

" + }, + "DelayUntilElbConnectionsDrained":{ + "shape":"Boolean", + "documentation":"

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

" + } + }, + "documentation":"

The Shutdown event configuration.

" + }, + "Source":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"SourceType", + "documentation":"

The repository type.

" + }, + "Url":{ + "shape":"String", + "documentation":"

The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

" + }, + "Username":{ + "shape":"String", + "documentation":"

This parameter depends on the repository type.

  • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.

  • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

" + }, + "Password":{ + "shape":"String", + "documentation":"

When included in a request, the parameter depends on the repository type.

  • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.

  • For HTTP bundles and Subversion repositories, set Password to the password.

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" + }, + "SshKey":{ + "shape":"String", + "documentation":"

In requests, the repository's SSH key.

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

" + }, + "Revision":{ + "shape":"String", + "documentation":"

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

" + } + }, + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

" + }, + "SourceType":{ + "type":"string", + "enum":[ + "git", + "svn", + "archive", + "s3" + ] + }, + "SslConfiguration":{ + "type":"structure", + "required":[ + "Certificate", + "PrivateKey" + ], + "members":{ + "Certificate":{ + "shape":"String", + "documentation":"

The contents of the certificate's domain.crt file.

" + }, + "PrivateKey":{ + "shape":"String", + "documentation":"

The private key; the contents of the certificate's domain.kex file.

" + }, + "Chain":{ + "shape":"String", + "documentation":"

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

" + } + }, + "documentation":"

Describes an app's SSL configuration.

" + }, + "Stack":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The stack's ARN.

" + }, + "Region":{ + "shape":"String", + "documentation":"

The stack AWS region, such as \"ap-northeast-2\". For more information about AWS regions, see Regions and Endpoints.

" + }, + "VpcId":{ + "shape":"String", + "documentation":"

The VPC ID; applicable only if the stack is running in a VPC.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

The stack's attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The stack AWS Identity and Access Management (IAM) role.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's default operating system.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack host name theme, with spaces replaced by underscores.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone. For more information, see Regions and Endpoints.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The default subnet ID; applicable only if the stack is running in a VPC.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

" + }, + "CustomCookbooksSource":{ + "shape":"Source", + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

" + }, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

" + }, + "CreatedAt":{ + "shape":"DateTime", + "documentation":"

The date when the stack was created.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

" + } + }, + "documentation":"

Describes a stack.

" + }, + "StackAttributes":{ + "type":"map", + "key":{"shape":"StackAttributesKeys"}, + "value":{"shape":"String"} + }, + "StackAttributesKeys":{ + "type":"string", + "enum":["Color"] + }, + "StackConfigurationManager":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The name. This parameter must be set to \"Chef\".

" + }, + "Version":{ + "shape":"String", + "documentation":"

The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.

" + } + }, + "documentation":"

Describes the configuration manager.

" + }, + "StackSummary":{ + "type":"structure", + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack name.

" + }, + "Arn":{ + "shape":"String", + "documentation":"

The stack's ARN.

" + }, + "LayersCount":{ + "shape":"Integer", + "documentation":"

The number of layers.

" + }, + "AppsCount":{ + "shape":"Integer", + "documentation":"

The number of apps.

" + }, + "InstancesCount":{ + "shape":"InstancesCount", + "documentation":"

An InstancesCount object with the number of instances in each status.

" + } + }, + "documentation":"

Summarizes the number of layers, instances, and apps in a stack.

" + }, + "Stacks":{ + "type":"list", + "member":{"shape":"Stack"} + }, + "StartInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "StartStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "StopInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Force":{ + "shape":"Boolean", + "documentation":"

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

" + } + } + }, + "StopStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + } + } + }, + "String":{"type":"string"}, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "Switch":{"type":"string"}, + "TagKey":{"type":"string"}, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The stack or layer's Amazon Resource Number (ARN).

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

A map that contains tag keys and tag values that are attached to a stack or layer.

  • The key cannot be empty.

  • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /

  • Leading and trailing white spaces are trimmed from both the key and value.

  • A maximum of 40 tags is allowed for any resource.

" + } + } + }, + "TagValue":{"type":"string"}, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TemporaryCredential":{ + "type":"structure", + "members":{ + "Username":{ + "shape":"String", + "documentation":"

The user name.

" + }, + "Password":{ + "shape":"String", + "documentation":"

The password.

" + }, + "ValidForInMinutes":{ + "shape":"Integer", + "documentation":"

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance's AWS OpsWorks Stacks ID.

" + } + }, + "documentation":"

Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.

" + }, + "TimeBasedAutoScalingConfiguration":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "AutoScalingSchedule":{ + "shape":"WeeklyAutoScalingSchedule", + "documentation":"

A WeeklyAutoScalingSchedule object with the instance schedule.

" + } + }, + "documentation":"

Describes an instance's time-based auto scaling configuration.

" + }, + "TimeBasedAutoScalingConfigurations":{ + "type":"list", + "member":{"shape":"TimeBasedAutoScalingConfiguration"} + }, + "UnassignInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + } + } + }, + "UnassignVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + } + } + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The stack or layer's Amazon Resource Number (ARN).

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

A list of the keys of tags to be removed from a stack or layer.

" + } + } + }, + "UpdateAppRequest":{ + "type":"structure", + "required":["AppId"], + "members":{ + "AppId":{ + "shape":"String", + "documentation":"

The app ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The app name.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description of the app.

" + }, + "DataSources":{ + "shape":"DataSources", + "documentation":"

The app's data sources.

" + }, + "Type":{ + "shape":"AppType", + "documentation":"

The app type.

" + }, + "AppSource":{ + "shape":"Source", + "documentation":"

A Source object that specifies the app repository.

" + }, + "Domains":{ + "shape":"Strings", + "documentation":"

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

" + }, + "EnableSsl":{ + "shape":"Boolean", + "documentation":"

Whether SSL is enabled for the app.

" + }, + "SslConfiguration":{ + "shape":"SslConfiguration", + "documentation":"

An SslConfiguration object with the SSL configuration.

" + }, + "Attributes":{ + "shape":"AppAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "Environment":{ + "shape":"EnvironmentVariables", + "documentation":"

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, \"Environment: is too large (maximum is 20 KB).\"

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

" + } + } + }, + "UpdateElasticIpRequest":{ + "type":"structure", + "required":["ElasticIp"], + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

The IP address for which you want to update the name.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The new name.

" + } + } + }, + "UpdateInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "LayerIds":{ + "shape":"Strings", + "documentation":"

The instance's layer IDs.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

" + }, + "AutoScalingType":{ + "shape":"AutoScalingType", + "documentation":"

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

" + }, + "Hostname":{ + "shape":"String", + "documentation":"

The instance host name.

" + }, + "Os":{ + "shape":"String", + "documentation":"

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

" + }, + "AmiId":{ + "shape":"String", + "documentation":"

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

" + }, + "SshKeyName":{ + "shape":"String", + "documentation":"

The instance's Amazon EC2 key name.

" + }, + "Architecture":{ + "shape":"Architecture", + "documentation":"

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" + }, + "EbsOptimized":{ + "shape":"Boolean", + "documentation":"

This property cannot be updated.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

AgentVersion cannot be set to Chef 12.2.

" + } + } + }, + "UpdateLayerRequest":{ + "type":"structure", + "required":["LayerId"], + "members":{ + "LayerId":{ + "shape":"String", + "documentation":"

The layer ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The layer name, which is used by the console.

" + }, + "Shortname":{ + "shape":"String", + "documentation":"

For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/.

The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference

" + }, + "Attributes":{ + "shape":"LayerAttributes", + "documentation":"

One or more user-defined key/value pairs to be added to the stack attributes.

" + }, + "CloudWatchLogsConfiguration":{ + "shape":"CloudWatchLogsConfiguration", + "documentation":"

Specifies CloudWatch Logs configuration options for the layer. For more information, see CloudWatchLogsLogStream.

" + }, + "CustomInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see Using Custom JSON.

" + }, + "CustomSecurityGroupIds":{ + "shape":"Strings", + "documentation":"

An array containing the layer's custom security group IDs.

" + }, + "Packages":{ + "shape":"Strings", + "documentation":"

An array of Package objects that describe the layer's packages.

" + }, + "VolumeConfigurations":{ + "shape":"VolumeConfigurations", + "documentation":"

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

" + }, + "EnableAutoHealing":{ + "shape":"Boolean", + "documentation":"

Whether to disable auto healing for the layer.

" + }, + "AutoAssignElasticIps":{ + "shape":"Boolean", + "documentation":"

Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "AutoAssignPublicIps":{ + "shape":"Boolean", + "documentation":"

For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.

" + }, + "CustomRecipes":{ + "shape":"Recipes", + "documentation":"

A LayerCustomRecipes object that specifies the layer's custom recipes.

" + }, + "InstallUpdatesOnBoot":{ + "shape":"Boolean", + "documentation":"

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

We strongly recommend using the default value of true, to ensure that your instances have the latest security updates.

" + }, + "UseEbsOptimizedInstances":{ + "shape":"Boolean", + "documentation":"

Whether to use Amazon EBS-optimized instances.

" + }, + "LifecycleEventConfiguration":{ + "shape":"LifecycleEventConfiguration", + "documentation":"

" + } + } + }, + "UpdateMyUserProfileRequest":{ + "type":"structure", + "members":{ + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + } + } + }, + "UpdateRdsDbInstanceRequest":{ + "type":"structure", + "required":["RdsDbInstanceArn"], + "members":{ + "RdsDbInstanceArn":{ + "shape":"String", + "documentation":"

The Amazon RDS instance's ARN.

" + }, + "DbUser":{ + "shape":"String", + "documentation":"

The master user name.

" + }, + "DbPassword":{ + "shape":"String", + "documentation":"

The database password.

" + } + } + }, + "UpdateStackRequest":{ + "type":"structure", + "required":["StackId"], + "members":{ + "StackId":{ + "shape":"String", + "documentation":"

The stack ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The stack's new name.

" + }, + "Attributes":{ + "shape":"StackAttributes", + "documentation":"

One or more user-defined key-value pairs to be added to the stack attributes.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

Do not use this parameter. You cannot update a stack's service role.

" + }, + "DefaultInstanceProfileArn":{ + "shape":"String", + "documentation":"

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

" + }, + "DefaultOs":{ + "shape":"String", + "documentation":"

The stack's operating system, which must be set to one of the following:

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

" + }, + "HostnameTheme":{ + "shape":"String", + "documentation":"

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods

  • Clouds

  • Europe_Cities

  • Fruits

  • Greek_Deities_and_Titans

  • Legendary_creatures_from_Japan

  • Planets_and_Moons

  • Roman_Deities

  • Scottish_Islands

  • US_Cities

  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

" + }, + "DefaultAvailabilityZone":{ + "shape":"String", + "documentation":"

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

" + }, + "DefaultSubnetId":{ + "shape":"String", + "documentation":"

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

" + }, + "CustomJson":{ + "shape":"String", + "documentation":"

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

\"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

" + }, + "ConfigurationManager":{ + "shape":"StackConfigurationManager", + "documentation":"

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

" + }, + "ChefConfiguration":{ + "shape":"ChefConfiguration", + "documentation":"

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

" + }, + "UseCustomCookbooks":{ + "shape":"Boolean", + "documentation":"

Whether the stack uses custom cookbooks.

" + }, + "CustomCookbooksSource":{ + "shape":"Source", + "documentation":"

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

" + }, + "DefaultSshKeyName":{ + "shape":"String", + "documentation":"

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

" + }, + "DefaultRootDeviceType":{ + "shape":"RootDeviceType", + "documentation":"

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

" + }, + "UseOpsworksSecurityGroups":{ + "shape":"Boolean", + "documentation":"

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.

  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

" + }, + "AgentVersion":{ + "shape":"String", + "documentation":"

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.

  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

" + } + } + }, + "UpdateUserProfileRequest":{ + "type":"structure", + "required":["IamUserArn"], + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user IAM ARN. This can also be a federated user's ARN.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's new SSH public key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" + } + } + }, + "UpdateVolumeRequest":{ + "type":"structure", + "required":["VolumeId"], + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The new name.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The new mount point.

" + } + } + }, + "UserProfile":{ + "type":"structure", + "members":{ + "IamUserArn":{ + "shape":"String", + "documentation":"

The user's IAM ARN.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The user's name.

" + }, + "SshUsername":{ + "shape":"String", + "documentation":"

The user's SSH user name.

" + }, + "SshPublicKey":{ + "shape":"String", + "documentation":"

The user's SSH public key.

" + }, + "AllowSelfManagement":{ + "shape":"Boolean", + "documentation":"

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

" + } + }, + "documentation":"

Describes a user's SSH information.

" + }, + "UserProfiles":{ + "type":"list", + "member":{"shape":"UserProfile"} + }, + "ValidForInMinutes":{ + "type":"integer", + "box":true, + "max":1440, + "min":60 + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

The exception message.

" + } + }, + "documentation":"

Indicates that a request was not valid.

", + "exception":true + }, + "VirtualizationType":{ + "type":"string", + "enum":[ + "paravirtual", + "hvm" + ] + }, + "Volume":{ + "type":"structure", + "members":{ + "VolumeId":{ + "shape":"String", + "documentation":"

The volume ID.

" + }, + "Ec2VolumeId":{ + "shape":"String", + "documentation":"

The Amazon EC2 volume ID.

" + }, + "Name":{ + "shape":"String", + "documentation":"

The volume name.

" + }, + "RaidArrayId":{ + "shape":"String", + "documentation":"

The RAID array ID.

" + }, + "InstanceId":{ + "shape":"String", + "documentation":"

The instance ID.

" + }, + "Status":{ + "shape":"String", + "documentation":"

The value returned by DescribeVolumes.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The volume size.

" + }, + "Device":{ + "shape":"String", + "documentation":"

The device name.

" + }, + "MountPoint":{ + "shape":"String", + "documentation":"

The volume mount point. For example, \"/mnt/disk1\".

" + }, + "Region":{ + "shape":"String", + "documentation":"

The AWS region. For more information about AWS regions, see Regions and Endpoints.

" + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

The volume Availability Zone. For more information, see Regions and Endpoints.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. For more information, see Amazon EBS Volume Types.

  • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

  • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

  • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

  • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

  • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

" + } + }, + "documentation":"

Describes an instance's Amazon EBS volume.

" + }, + "VolumeConfiguration":{ + "type":"structure", + "required":[ + "MountPoint", + "NumberOfDisks", + "Size" + ], + "members":{ + "MountPoint":{ + "shape":"String", + "documentation":"

The volume mount point. For example \"/dev/sdh\".

" + }, + "RaidLevel":{ + "shape":"Integer", + "documentation":"

The volume RAID level.

" + }, + "NumberOfDisks":{ + "shape":"Integer", + "documentation":"

The number of disks in the volume.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The volume size.

" + }, + "VolumeType":{ + "shape":"String", + "documentation":"

The volume type. For more information, see Amazon EBS Volume Types.

  • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.

  • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.

  • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.

  • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

  • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

" + }, + "Iops":{ + "shape":"Integer", + "documentation":"

For PIOPS volumes, the IOPS per disk.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

" + } + }, + "documentation":"

Describes an Amazon EBS volume configuration.

" + }, + "VolumeConfigurations":{ + "type":"list", + "member":{"shape":"VolumeConfiguration"} + }, + "VolumeType":{ + "type":"string", + "enum":[ + "gp2", + "io1", + "standard" + ] + }, + "Volumes":{ + "type":"list", + "member":{"shape":"Volume"} + }, + "WeeklyAutoScalingSchedule":{ + "type":"structure", + "members":{ + "Monday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Monday.

" + }, + "Tuesday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Tuesday.

" + }, + "Wednesday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Wednesday.

" + }, + "Thursday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Thursday.

" + }, + "Friday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Friday.

" + }, + "Saturday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Saturday.

" + }, + "Sunday":{ + "shape":"DailyAutoScalingSchedule", + "documentation":"

The schedule for Sunday.

" + } + }, + "documentation":"

Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.

  • The key is the time period (a UTC hour) and must be an integer from 0 - 23.

  • The value indicates whether the instance should be online or offline for the specified period, and must be set to \"on\" or \"off\"

The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.

The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.

{ \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" }

" + } + }, + "documentation":"AWS OpsWorks

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.

AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.

SDKs and CLI

The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:

Endpoints

AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.

  • opsworks.us-east-1.amazonaws.com

  • opsworks.us-east-2.amazonaws.com

  • opsworks.us-west-1.amazonaws.com

  • opsworks.us-west-2.amazonaws.com

  • opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)

  • opsworks.eu-west-1.amazonaws.com

  • opsworks.eu-west-2.amazonaws.com

  • opsworks.eu-west-3.amazonaws.com

  • opsworks.eu-central-1.amazonaws.com

  • opsworks.ap-northeast-1.amazonaws.com

  • opsworks.ap-northeast-2.amazonaws.com

  • opsworks.ap-south-1.amazonaws.com

  • opsworks.ap-southeast-1.amazonaws.com

  • opsworks.ap-southeast-2.amazonaws.com

  • opsworks.sa-east-1.amazonaws.com

Chef Versions

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

" +} diff --git a/aws/dist/botocore/data/opsworks/2013-02-18/waiters-2.json b/aws/dist/botocore/data/opsworks/2013-02-18/waiters-2.json new file mode 100644 index 00000000..1b9dfaad --- /dev/null +++ b/aws/dist/botocore/data/opsworks/2013-02-18/waiters-2.json @@ -0,0 +1,289 @@ +{ + "version": 2, + "waiters": { + "AppExists": { + "delay": 1, + "operation": "DescribeApps", + "maxAttempts": 40, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "matcher": "status", + "expected": 400, + "state": "failure" + } + ] + }, + "DeploymentSuccessful": { + "delay": 15, + "operation": "DescribeDeployments", + "maxAttempts": 40, + "description": "Wait until a deployment has completed successfully.", + "acceptors": [ + { + "expected": "successful", + "matcher": "pathAll", + "state": "success", + "argument": "Deployments[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Deployments[].Status" + } + ] + }, + "InstanceOnline": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is online.", + "acceptors": [ + { + "expected": "online", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "shutting_down", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopped", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminating", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceRegistered": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is registered.", + "acceptors": [ + { + "expected": "registered", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "shutting_down", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopped", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stopping", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminating", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "terminated", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceStopped": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is stopped.", + "acceptors": [ + { + "expected": "stopped", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "booting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "requested", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "running_setup", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "stop_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + }, + "InstanceTerminated": { + "delay": 15, + "operation": "DescribeInstances", + "maxAttempts": 40, + "description": "Wait until OpsWorks instance is terminated.", + "acceptors": [ + { + "expected": "terminated", + "matcher": "pathAll", + "state": "success", + "argument": "Instances[].Status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "success" + }, + { + "expected": "booting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "online", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "pending", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "requested", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "running_setup", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "setup_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + }, + { + "expected": "start_failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Instances[].Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/opsworkscm/2016-11-01/examples-1.json b/aws/dist/botocore/data/opsworkscm/2016-11-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/opsworkscm/2016-11-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/opsworkscm/2016-11-01/paginators-1.json b/aws/dist/botocore/data/opsworkscm/2016-11-01/paginators-1.json new file mode 100644 index 00000000..3324f85e --- /dev/null +++ b/aws/dist/botocore/data/opsworkscm/2016-11-01/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "DescribeBackups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Backups" + }, + "DescribeEvents": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ServerEvents" + }, + "DescribeServers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Servers" + } + } +} diff --git a/aws/dist/botocore/data/opsworkscm/2016-11-01/service-2.json b/aws/dist/botocore/data/opsworkscm/2016-11-01/service-2.json new file mode 100644 index 00000000..82e715d4 --- /dev/null +++ b/aws/dist/botocore/data/opsworkscm/2016-11-01/service-2.json @@ -0,0 +1,1259 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-01", + "endpointPrefix":"opsworks-cm", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"OpsWorksCM", + "serviceFullName":"AWS OpsWorks CM", + "serviceId":"OpsWorksCM", + "signatureVersion":"v4", + "signingName":"opsworks-cm", + "targetPrefix":"OpsWorksCM_V2016_11_01", + "uid":"opsworkscm-2016-11-01" + }, + "operations":{ + "AssociateNode":{ + "name":"AssociateNode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateNodeRequest"}, + "output":{"shape":"AssociateNodeResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Associates a new node with the server. For more information about how to disassociate a node, see DisassociateNode.

On a Chef server: This command is an alternative to knife bootstrap.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=CHEF_ORGANIZATION,Value=default\" \"Name=CHEF_NODE_PUBLIC_KEY,Value=public-key-pem\"

On a Puppet server, this command is an alternative to the puppet cert sign command that signs a Puppet node CSR.

Example (Chef): aws opsworks-cm associate-node --server-name MyServer --node-name MyManagedNode --engine-attributes \"Name=PUPPET_NODE_CSR,Value=csr-pem\"

A node can can only be associated with servers that are in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid. The AssociateNode API call can be integrated into Auto Scaling configurations, AWS Cloudformation templates, or the user data of a server's instance.

" + }, + "CreateBackup":{ + "name":"CreateBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateBackupRequest"}, + "output":{"shape":"CreateBackupResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Creates an application-level backup of a server. While the server is in the BACKING_UP state, the server cannot be changed, and no additional backup can be created.

Backups can be created for servers in RUNNING, HEALTHY, and UNHEALTHY states. By default, you can create a maximum of 50 manual backups.

This operation is asynchronous.

A LimitExceededException is thrown when the maximum number of manual backups is reached. An InvalidStateException is thrown when the server is not in any of the following states: RUNNING, HEALTHY, or UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.

" + }, + "CreateServer":{ + "name":"CreateServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServerRequest"}, + "output":{"shape":"CreateServerResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Creates and immedately starts a new server. The server is ready to use when it is in the HEALTHY state. By default, you can create a maximum of 10 servers.

This operation is asynchronous.

A LimitExceededException is thrown when you have created the maximum number of servers (10). A ResourceAlreadyExistsException is thrown when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when you specify a backup ID that is not valid or is for a backup that does not exist. A ValidationException is thrown when parameters of the request are not valid.

If you do not specify a security group by adding the SecurityGroupIds parameter, AWS OpsWorks creates a new security group.

Chef Automate: The default security group opens the Chef server to the world on TCP port 443. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

Puppet Enterprise: The default security group opens TCP ports 22, 443, 4433, 8140, 8142, 8143, and 8170. If a KeyName is present, AWS OpsWorks enables SSH access. SSH is also open to the world on TCP port 22.

By default, your server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.

To specify your own domain for a server, and provide your own self-signed or CA-signed certificate and private key, specify values for CustomDomain, CustomCertificate, and CustomPrivateKey.

" + }, + "DeleteBackup":{ + "name":"DeleteBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBackupRequest"}, + "output":{"shape":"DeleteBackupResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Deletes a backup. You can delete both manual and automated backups. This operation is asynchronous.

An InvalidStateException is thrown when a backup deletion is already in progress. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.

" + }, + "DeleteServer":{ + "name":"DeleteServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerRequest"}, + "output":{"shape":"DeleteServerResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Deletes the server and the underlying AWS CloudFormation stacks (including the server's EC2 instance). When you run this command, the server state is updated to DELETING. After the server is deleted, it is no longer returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.

This operation is asynchronous.

An InvalidStateException is thrown when a server deletion is already in progress. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesRequest"}, + "output":{"shape":"DescribeAccountAttributesResponse"}, + "documentation":"

Describes your OpsWorks-CM account attributes.

This operation is synchronous.

" + }, + "DescribeBackups":{ + "name":"DescribeBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBackupsRequest"}, + "output":{"shape":"DescribeBackupsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.

This operation is synchronous.

A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsRequest"}, + "output":{"shape":"DescribeEventsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes events for a specified server. Results are ordered by time, with newest events first.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "DescribeNodeAssociationStatus":{ + "name":"DescribeNodeAssociationStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNodeAssociationStatusRequest"}, + "output":{"shape":"DescribeNodeAssociationStatusResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns the current status of an existing association or disassociation request.

A ResourceNotFoundException is thrown when no recent association or disassociation request with the specified token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "DescribeServers":{ + "name":"DescribeServers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServersRequest"}, + "output":{"shape":"DescribeServersResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM does not query other services.

This operation is synchronous.

A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "DisassociateNode":{ + "name":"DisassociateNode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateNodeRequest"}, + "output":{"shape":"DisassociateNodeResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the configuration manager's API. For more information about how to associate a node, see AssociateNode.

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "ExportServerEngineAttribute":{ + "name":"ExportServerEngineAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExportServerEngineAttributeRequest"}, + "output":{"shape":"ExportServerEngineAttributeResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

Exports a specified server engine attribute as a base64-encoded string. For example, you can export user data that you can use in EC2 to associate nodes with a server.

This operation is synchronous.

A ValidationException is raised when parameters of the request are not valid. A ResourceNotFoundException is thrown when the server does not exist. An InvalidStateException is thrown when the server is in any of the following states: CREATING, TERMINATED, FAILED or DELETING.

" + }, + "RestoreServer":{ + "name":"RestoreServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreServerRequest"}, + "output":{"shape":"RestoreServerResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Restores a backup to a server that is in a CONNECTION_LOST, HEALTHY, RUNNING, UNHEALTHY, or TERMINATED state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work.

This operation is asynchronous.

An InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "StartMaintenance":{ + "name":"StartMaintenance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartMaintenanceRequest"}, + "output":{"shape":"StartMaintenanceResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE state while maintenance is in progress.

Maintenance can only be started on servers in HEALTHY and UNHEALTHY states. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + }, + "UpdateServer":{ + "name":"UpdateServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerRequest"}, + "output":{"shape":"UpdateServerResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates settings for a server.

This operation is synchronous.

" + }, + "UpdateServerEngineAttributes":{ + "name":"UpdateServerEngineAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerEngineAttributesRequest"}, + "output":{"shape":"UpdateServerEngineAttributesResponse"}, + "errors":[ + {"shape":"InvalidStateException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates engine-specific attributes on a specified server. The server enters the MODIFYING state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's public key (CHEF_PIVOTAL_KEY) or a Puppet server's admin password (PUPPET_ADMIN_PASSWORD).

This operation is asynchronous.

This operation can only be called for servers in HEALTHY or UNHEALTHY states. Otherwise, an InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

" + } + }, + "shapes":{ + "AccountAttribute":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

The attribute name. The following are supported attribute names.

  • ServerLimit: The number of current servers/maximum number of servers allowed. By default, you can have a maximum of 10 servers.

  • ManualBackupLimit: The number of current manual backups/maximum number of backups allowed. By default, you can have a maximum of 50 manual backups saved.

" + }, + "Maximum":{ + "shape":"Integer", + "documentation":"

The maximum allowed value.

" + }, + "Used":{ + "shape":"Integer", + "documentation":"

The current usage, such as the current number of servers that are associated with the account.

" + } + }, + "documentation":"

Stores account attributes.

" + }, + "AccountAttributes":{ + "type":"list", + "member":{"shape":"AccountAttribute"}, + "documentation":"

A list of individual account attributes.

" + }, + "AssociateNodeRequest":{ + "type":"structure", + "required":[ + "ServerName", + "NodeName", + "EngineAttributes" + ], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server with which to associate the node.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

The name of the node.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

Engine attributes used for associating the node.

Attributes accepted in a AssociateNode request for Chef

  • CHEF_ORGANIZATION: The Chef organization with which the node is associated. By default only one organization named default can exist.

  • CHEF_NODE_PUBLIC_KEY: A PEM-formatted public key. This key is required for the chef-client agent to access the Chef API.

Attributes accepted in a AssociateNode request for Puppet

  • PUPPET_NODE_CSR: A PEM-formatted certificate-signing request (CSR) that is created by the node.

" + } + } + }, + "AssociateNodeResponse":{ + "type":"structure", + "members":{ + "NodeAssociationStatusToken":{ + "shape":"NodeAssociationStatusToken", + "documentation":"

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the association request.

" + } + } + }, + "AttributeName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Z][A-Z0-9_]*" + }, + "AttributeValue":{ + "type":"string", + "max":10000, + "pattern":"(?s).*" + }, + "Backup":{ + "type":"structure", + "members":{ + "BackupArn":{ + "shape":"String", + "documentation":"

The ARN of the backup.

" + }, + "BackupId":{ + "shape":"BackupId", + "documentation":"

The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS

" + }, + "BackupType":{ + "shape":"BackupType", + "documentation":"

The backup type. Valid values are automated or manual.

" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"

The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z

" + }, + "Description":{ + "shape":"String", + "documentation":"

A user-provided description for a manual backup. This field is empty for automated backups.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The engine type that is obtained from the server when the backup is created.

" + }, + "EngineModel":{ + "shape":"String", + "documentation":"

The engine model that is obtained from the server when the backup is created.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version that is obtained from the server when the backup is created.

" + }, + "InstanceProfileArn":{ + "shape":"String", + "documentation":"

The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type that is obtained from the server when the backup is created.

" + }, + "KeyPair":{ + "shape":"String", + "documentation":"

The key pair that is obtained from the server when the backup is created.

" + }, + "PreferredBackupWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The preferred backup period that is obtained from the server when the backup is created.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The preferred maintenance period that is obtained from the server when the backup is created.

" + }, + "S3DataSize":{ + "shape":"Integer", + "documentation":"

This field is deprecated and is no longer used.

", + "deprecated":true + }, + "S3DataUrl":{ + "shape":"String", + "documentation":"

This field is deprecated and is no longer used.

", + "deprecated":true + }, + "S3LogUrl":{ + "shape":"String", + "documentation":"

The Amazon S3 URL of the backup's log file.

" + }, + "SecurityGroupIds":{ + "shape":"Strings", + "documentation":"

The security group IDs that are obtained from the server when the backup is created.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server from which the backup was made.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The service role ARN that is obtained from the server when the backup is created.

" + }, + "Status":{ + "shape":"BackupStatus", + "documentation":"

The status of a backup while in progress.

" + }, + "StatusDescription":{ + "shape":"String", + "documentation":"

An informational message about backup status.

" + }, + "SubnetIds":{ + "shape":"Strings", + "documentation":"

The subnet IDs that are obtained from the server when the backup is created.

" + }, + "ToolsVersion":{ + "shape":"String", + "documentation":"

The version of AWS OpsWorks CM-specific tools that is obtained from the server when the backup is created.

" + }, + "UserArn":{ + "shape":"String", + "documentation":"

The IAM user ARN of the requester for manual backups. This field is empty for automated backups.

" + } + }, + "documentation":"

Describes a single backup.

" + }, + "BackupId":{ + "type":"string", + "max":79, + "pattern":"[a-zA-Z][a-zA-Z0-9\\-\\.\\:]*" + }, + "BackupRetentionCountDefinition":{ + "type":"integer", + "min":1 + }, + "BackupStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "OK", + "FAILED", + "DELETING" + ] + }, + "BackupType":{ + "type":"string", + "enum":[ + "AUTOMATED", + "MANUAL" + ] + }, + "Backups":{ + "type":"list", + "member":{"shape":"Backup"} + }, + "Boolean":{"type":"boolean"}, + "CreateBackupRequest":{ + "type":"structure", + "required":["ServerName"], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server that you want to back up.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A user-defined description of the backup.

" + } + } + }, + "CreateBackupResponse":{ + "type":"structure", + "members":{ + "Backup":{ + "shape":"Backup", + "documentation":"

Backup created by request.

" + } + } + }, + "CreateServerRequest":{ + "type":"structure", + "required":[ + "ServerName", + "InstanceProfileArn", + "InstanceType", + "ServiceRoleArn" + ], + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Associate a public IP address with a server that you are launching. Valid values are true or false. The default value is true.

" + }, + "CustomDomain":{ + "shape":"CustomDomain", + "documentation":"

An optional public endpoint of a server, such as https://aws.my-company.com. To access the server, create a CNAME DNS record in your preferred DNS service that points the custom domain to the endpoint that is generated when the server is created (the value of the CreateServer Endpoint attribute). You cannot access the server by using the generated Endpoint value if the server is using a custom domain. If you specify a custom domain, you must also specify values for CustomCertificate and CustomPrivateKey.

" + }, + "CustomCertificate":{ + "shape":"CustomCertificate", + "documentation":"

A PEM-formatted HTTPS certificate. The value can be be a single, self-signed certificate, or a certificate chain. If you specify a custom certificate, you must also specify values for CustomDomain and CustomPrivateKey. The following are requirements for the CustomCertificate value:

  • You can provide either a self-signed, custom certificate, or the full certificate chain.

  • The certificate must be a valid X509 certificate, or a certificate chain in PEM format.

  • The certificate must be valid at the time of upload. A certificate can't be used before its validity period begins (the certificate's NotBefore date), or after it expires (the certificate's NotAfter date).

  • The certificate’s common name or subject alternative names (SANs), if present, must match the value of CustomDomain.

  • The certificate must match the value of CustomPrivateKey.

" + }, + "CustomPrivateKey":{ + "shape":"CustomPrivateKey", + "documentation":"

A private key in PEM format for connecting to the server by using HTTPS. The private key must not be encrypted; it cannot be protected by a password or passphrase. If you specify a custom private key, you must also specify values for CustomDomain and CustomCertificate.

" + }, + "DisableAutomatedBackup":{ + "shape":"Boolean", + "documentation":"

Enable or disable scheduled backups. Valid values are true or false. The default value is true.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The configuration management engine to use. Valid values include ChefAutomate and Puppet.

" + }, + "EngineModel":{ + "shape":"String", + "documentation":"

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The major release version of the engine that you want to use. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

Optional engine attributes on a specified server.

Attributes accepted in a Chef createServer request:

  • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA public key. The corresponding private key is required to access the Chef API. When no CHEF_AUTOMATE_PIVOTAL_KEY is set, a private key is generated and returned in the response.

  • CHEF_AUTOMATE_ADMIN_PASSWORD: The password for the administrative user in the Chef Automate web-based dashboard. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_AUTOMATE_ADMIN_PASSWORD is set, one is generated and returned in the response.

Attributes accepted in a Puppet createServer request:

  • PUPPET_ADMIN_PASSWORD: To work with the Puppet Enterprise console, a password must use ASCII characters.

  • PUPPET_R10K_REMOTE: The r10k remote is the URL of your control repository (for example, ssh://git@your.git-repo.com:user/control-repo.git). Specifying an r10k remote opens TCP port 8170.

  • PUPPET_R10K_PRIVATE_KEY: If you are using a private Git repository, add PUPPET_R10K_PRIVATE_KEY to specify a PEM-encoded private SSH key.

" + }, + "BackupRetentionCount":{ + "shape":"BackupRetentionCountDefinition", + "documentation":"

The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks CM deletes the oldest backups if this number is exceeded. The default value is 1.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 40 characters.

" + }, + "InstanceProfileArn":{ + "shape":"InstanceProfileArn", + "documentation":"

The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, if you are using API commands instead, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the instance profile you need.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The Amazon EC2 instance type to use. For example, m5.large.

" + }, + "KeyPair":{ + "shape":"KeyPair", + "documentation":"

The Amazon EC2 key pair to set for the instance. This parameter is optional; if desired, you may specify this parameter to connect to your instances by using SSH.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The start time for a one-hour period each week during which AWS OpsWorks CM performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" + }, + "PreferredBackupWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The start time for a one-hour period during which AWS OpsWorks CM backs up application-level data on your server if automated backups are enabled. Valid values must be specified in one of the following formats:

  • HH:MM for daily backups

  • DDD:HH:MM for weekly backups

The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.

Example: 08:00, which represents a daily start time of 08:00 UTC.

Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)

" + }, + "SecurityGroupIds":{ + "shape":"Strings", + "documentation":"

A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.

If you do not specify this parameter, AWS OpsWorks CM creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).

" + }, + "ServiceRoleArn":{ + "shape":"ServiceRoleArn", + "documentation":"

The service role that the AWS OpsWorks CM service backend uses to work with your account. Although the AWS OpsWorks management console typically creates the service role for you, if you are using the AWS CLI or API commands, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-cm-us-east-1-prod-default-assets/misc/opsworks-cm-roles.yaml. This template creates a CloudFormation stack that includes the service role and instance profile that you need.

" + }, + "SubnetIds":{ + "shape":"Strings", + "documentation":"

The IDs of subnets in which to launch the server EC2 instance.

Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have \"Auto Assign Public IP\" enabled.

EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have \"Auto Assign Public IP\" enabled.

For more information about supported Amazon EC2 platforms, see Supported Platforms.

" + }, + "BackupId":{ + "shape":"BackupId", + "documentation":"

If you specify this field, AWS OpsWorks CM creates the server by using the backup represented by BackupId.

" + } + } + }, + "CreateServerResponse":{ + "type":"structure", + "members":{ + "Server":{ + "shape":"Server", + "documentation":"

The server that is created by the request.

" + } + } + }, + "CustomCertificate":{ + "type":"string", + "max":2097152, + "pattern":"(?s)\\s*-----BEGIN CERTIFICATE-----.+-----END CERTIFICATE-----\\s*" + }, + "CustomDomain":{ + "type":"string", + "max":253, + "pattern":"^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$" + }, + "CustomPrivateKey":{ + "type":"string", + "max":4096, + "pattern":"(?ms)\\s*^-----BEGIN (?-s:.*)PRIVATE KEY-----$.*?^-----END (?-s:.*)PRIVATE KEY-----$\\s*", + "sensitive":true + }, + "DeleteBackupRequest":{ + "type":"structure", + "required":["BackupId"], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.

" + } + } + }, + "DeleteBackupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteServerRequest":{ + "type":"structure", + "required":["ServerName"], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The ID of the server to delete.

" + } + } + }, + "DeleteServerResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountAttributesRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AccountAttributes", + "documentation":"

The attributes that are currently set for the account.

" + } + } + }, + "DescribeBackupsRequest":{ + "type":"structure", + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

Describes a single backup.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

Returns backups for the server with the specified ServerName.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

This is not currently implemented for DescribeBackups requests.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

This is not currently implemented for DescribeBackups requests.

" + } + } + }, + "DescribeBackupsResponse":{ + "type":"structure", + "members":{ + "Backups":{ + "shape":"Backups", + "documentation":"

Contains the response to a DescribeBackups request.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

This is not currently implemented for DescribeBackups requests.

" + } + } + }, + "DescribeEventsRequest":{ + "type":"structure", + "required":["ServerName"], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server for which you want to view events.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" + } + } + }, + "DescribeEventsResponse":{ + "type":"structure", + "members":{ + "ServerEvents":{ + "shape":"ServerEvents", + "documentation":"

Contains the response to a DescribeEvents request.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.

" + } + } + }, + "DescribeNodeAssociationStatusRequest":{ + "type":"structure", + "required":[ + "NodeAssociationStatusToken", + "ServerName" + ], + "members":{ + "NodeAssociationStatusToken":{ + "shape":"NodeAssociationStatusToken", + "documentation":"

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server from which to disassociate the node.

" + } + } + }, + "DescribeNodeAssociationStatusResponse":{ + "type":"structure", + "members":{ + "NodeAssociationStatus":{ + "shape":"NodeAssociationStatus", + "documentation":"

The status of the association or disassociation request.

Possible values:

  • SUCCESS: The association or disassociation succeeded.

  • FAILED: The association or disassociation failed.

  • IN_PROGRESS: The association or disassociation is still in progress.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR).

" + } + } + }, + "DescribeServersRequest":{ + "type":"structure", + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

Describes the server with the specified ServerName.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

This is not currently implemented for DescribeServers requests.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

This is not currently implemented for DescribeServers requests.

" + } + } + }, + "DescribeServersResponse":{ + "type":"structure", + "members":{ + "Servers":{ + "shape":"Servers", + "documentation":"

Contains the response to a DescribeServers request.

For Puppet Server: DescribeServersResponse$Servers$EngineAttributes contains PUPPET_API_CA_CERT. This is the PEM-encoded CA certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

This is not currently implemented for DescribeServers requests.

" + } + } + }, + "DisassociateNodeRequest":{ + "type":"structure", + "required":[ + "ServerName", + "NodeName" + ], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server from which to disassociate the node.

" + }, + "NodeName":{ + "shape":"NodeName", + "documentation":"

The name of the client node.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

Attributes required in a DisassociateNode request for Chef

  • CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

" + } + } + }, + "DisassociateNodeResponse":{ + "type":"structure", + "members":{ + "NodeAssociationStatusToken":{ + "shape":"NodeAssociationStatusToken", + "documentation":"

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

" + } + } + }, + "EngineAttribute":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"EngineAttributeName", + "documentation":"

The name of the engine attribute.

" + }, + "Value":{ + "shape":"EngineAttributeValue", + "documentation":"

The value of the engine attribute.

" + } + }, + "documentation":"

A name and value pair that is specific to the engine of the server.

" + }, + "EngineAttributeName":{ + "type":"string", + "max":10000, + "pattern":"(?s).*" + }, + "EngineAttributeValue":{ + "type":"string", + "max":10000, + "pattern":"(?s).*", + "sensitive":true + }, + "EngineAttributes":{ + "type":"list", + "member":{"shape":"EngineAttribute"} + }, + "ExportServerEngineAttributeRequest":{ + "type":"structure", + "required":[ + "ExportAttributeName", + "ServerName" + ], + "members":{ + "ExportAttributeName":{ + "shape":"String", + "documentation":"

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server from which you are exporting the attribute.

" + }, + "InputAttributes":{ + "shape":"EngineAttributes", + "documentation":"

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

  • RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

  • OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

  • NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

  • NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

" + } + } + }, + "ExportServerEngineAttributeResponse":{ + "type":"structure", + "members":{ + "EngineAttribute":{ + "shape":"EngineAttribute", + "documentation":"

The requested engine attribute pair with attribute name and value.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The server name used in the request.

" + } + } + }, + "InstanceProfileArn":{ + "type":"string", + "max":10000, + "pattern":"arn:aws:iam::[0-9]{12}:instance-profile/.*" + }, + "Integer":{"type":"integer"}, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message that can contain more detail about a nextToken failure.

" + } + }, + "documentation":"

This occurs when the provided nextToken is not valid.

", + "exception":true + }, + "InvalidStateException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message that provides more detail if a resource is in a state that is not valid for performing a specified action.

" + } + }, + "documentation":"

The resource is in a state that does not allow you to perform a specified action.

", + "exception":true + }, + "KeyPair":{ + "type":"string", + "max":10000, + "pattern":".*" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message that the maximum allowed number of servers or backups has been exceeded.

" + } + }, + "documentation":"

The limit of servers or backups has been reached.

", + "exception":true + }, + "MaintenanceStatus":{ + "type":"string", + "enum":[ + "SUCCESS", + "FAILED" + ] + }, + "MaxResults":{ + "type":"integer", + "min":1 + }, + "NextToken":{ + "type":"string", + "max":10000, + "pattern":"(?s).*" + }, + "NodeAssociationStatus":{ + "type":"string", + "documentation":"

The status of the association or disassociation request.

Possible values:

  • SUCCESS: The association or disassociation succeeded.

  • FAILED: The association or disassociation failed.

  • IN_PROGRESS: The association or disassociation is still in progress.

", + "enum":[ + "SUCCESS", + "FAILED", + "IN_PROGRESS" + ] + }, + "NodeAssociationStatusToken":{ + "type":"string", + "max":10000, + "pattern":"(?s).*" + }, + "NodeName":{ + "type":"string", + "documentation":"

The node name that is used by chef-client or puppet-agentfor a new node. We recommend to use a unique FQDN as hostname. For more information, see the Chef or Puppet documentation.

", + "max":10000, + "pattern":"^[\\-\\p{Alnum}_:.]+$" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message in response to a CreateServer request that a resource cannot be created because it already exists.

" + } + }, + "documentation":"

The requested resource cannot be created because it already exists.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message that can contain more detail about problems locating or accessing a resource.

" + } + }, + "documentation":"

The requested resource does not exist, or access was denied.

", + "exception":true + }, + "RestoreServerRequest":{ + "type":"structure", + "required":[ + "BackupId", + "ServerName" + ], + "members":{ + "BackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the backup that you want to use to restore a server.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server that you want to restore.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The type of the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, m5.large. Valid values are m5.large, r5.xlarge, and r5.2xlarge. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.

" + }, + "KeyPair":{ + "shape":"KeyPair", + "documentation":"

The name of the key pair to set on the new EC2 instance. This can be helpful if the administrator no longer has the SSH key.

" + } + } + }, + "RestoreServerResponse":{ + "type":"structure", + "members":{ + } + }, + "Server":{ + "type":"structure", + "members":{ + "AssociatePublicIpAddress":{ + "shape":"Boolean", + "documentation":"

Associate a public IP address with a server that you are launching.

" + }, + "BackupRetentionCount":{ + "shape":"Integer", + "documentation":"

The number of automated backups to keep.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server.

" + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"

Time stamp of server creation. Example 2016-07-29T13:38:47.520Z

" + }, + "CloudFormationStackArn":{ + "shape":"String", + "documentation":"

The ARN of the CloudFormation stack that was used to create the server.

" + }, + "CustomDomain":{ + "shape":"CustomDomain", + "documentation":"

An optional public endpoint of a server, such as https://aws.my-company.com. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" + }, + "DisableAutomatedBackup":{ + "shape":"Boolean", + "documentation":"

Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.

" + }, + "Endpoint":{ + "shape":"String", + "documentation":"

A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io. You cannot access the server by using the Endpoint value if the server has a CustomDomain specified.

" + }, + "Engine":{ + "shape":"String", + "documentation":"

The engine type of the server. Valid values in this release include ChefAutomate and Puppet.

" + }, + "EngineModel":{ + "shape":"String", + "documentation":"

The engine model of the server. Valid values in this release include Monolithic for Puppet and Single for Chef.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer().

Attributes returned in a createServer response for Chef

  • CHEF_AUTOMATE_PIVOTAL_KEY: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.

  • CHEF_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.

Attributes returned in a createServer response for Puppet

  • PUPPET_STARTER_KIT: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.

  • PUPPET_ADMIN_PASSWORD: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.

" + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

The engine version of the server. For a Chef server, the valid value for EngineVersion is currently 12. For a Puppet server, the valid value is 2017.

" + }, + "InstanceProfileArn":{ + "shape":"String", + "documentation":"

The instance profile ARN of the server.

" + }, + "InstanceType":{ + "shape":"String", + "documentation":"

The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.

" + }, + "KeyPair":{ + "shape":"String", + "documentation":"

The key pair associated with the server.

" + }, + "MaintenanceStatus":{ + "shape":"MaintenanceStatus", + "documentation":"

The status of the most recent server maintenance run. Shows SUCCESS or FAILED.

" + }, + "PreferredMaintenanceWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The preferred maintenance period specified for the server.

" + }, + "PreferredBackupWindow":{ + "shape":"TimeWindowDefinition", + "documentation":"

The preferred backup period specified for the server.

" + }, + "SecurityGroupIds":{ + "shape":"Strings", + "documentation":"

The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.

" + }, + "ServiceRoleArn":{ + "shape":"String", + "documentation":"

The service role ARN used to create the server.

" + }, + "Status":{ + "shape":"ServerStatus", + "documentation":"

The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as the server's health state.

" + }, + "StatusReason":{ + "shape":"String", + "documentation":"

Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).

" + }, + "SubnetIds":{ + "shape":"Strings", + "documentation":"

The subnet IDs specified in a CreateServer request.

" + }, + "ServerArn":{ + "shape":"String", + "documentation":"

The ARN of the server.

" + } + }, + "documentation":"

Describes a configuration management server.

" + }, + "ServerEvent":{ + "type":"structure", + "members":{ + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"

The time when the event occurred.

" + }, + "ServerName":{ + "shape":"String", + "documentation":"

The name of the server on or for which the event occurred.

" + }, + "Message":{ + "shape":"String", + "documentation":"

A human-readable informational or status message.

" + }, + "LogUrl":{ + "shape":"String", + "documentation":"

The Amazon S3 URL of the event's log file.

" + } + }, + "documentation":"

An event that is related to the server, such as the start of maintenance or backup.

" + }, + "ServerEvents":{ + "type":"list", + "member":{"shape":"ServerEvent"} + }, + "ServerName":{ + "type":"string", + "max":40, + "min":1, + "pattern":"[a-zA-Z][a-zA-Z0-9\\-]*" + }, + "ServerStatus":{ + "type":"string", + "enum":[ + "BACKING_UP", + "CONNECTION_LOST", + "CREATING", + "DELETING", + "MODIFYING", + "FAILED", + "HEALTHY", + "RUNNING", + "RESTORING", + "SETUP", + "UNDER_MAINTENANCE", + "UNHEALTHY", + "TERMINATED" + ] + }, + "Servers":{ + "type":"list", + "member":{"shape":"Server"} + }, + "ServiceRoleArn":{ + "type":"string", + "max":10000, + "pattern":"arn:aws:iam::[0-9]{12}:role/.*" + }, + "StartMaintenanceRequest":{ + "type":"structure", + "required":["ServerName"], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server on which to run maintenance.

" + }, + "EngineAttributes":{ + "shape":"EngineAttributes", + "documentation":"

Engine attributes that are specific to the server on which you want to run maintenance.

" + } + } + }, + "StartMaintenanceResponse":{ + "type":"structure", + "members":{ + "Server":{ + "shape":"Server", + "documentation":"

Contains the response to a StartMaintenance request.

" + } + } + }, + "String":{ + "type":"string", + "max":10000, + "pattern":"(?s).*" + }, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "TimeWindowDefinition":{ + "type":"string", + "documentation":"

DDD:HH:MM (weekly start time) or HH:MM (daily start time).

Time windows always use coordinated universal time (UTC). Valid strings for day of week (DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, or Sun.

", + "max":10000, + "pattern":"^((Mon|Tue|Wed|Thu|Fri|Sat|Sun):)?([0-1][0-9]|2[0-3]):[0-5][0-9]$" + }, + "Timestamp":{"type":"timestamp"}, + "UpdateServerEngineAttributesRequest":{ + "type":"structure", + "required":[ + "ServerName", + "AttributeName" + ], + "members":{ + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server to update.

" + }, + "AttributeName":{ + "shape":"AttributeName", + "documentation":"

The name of the engine attribute to update.

" + }, + "AttributeValue":{ + "shape":"AttributeValue", + "documentation":"

The value to set for the attribute.

" + } + } + }, + "UpdateServerEngineAttributesResponse":{ + "type":"structure", + "members":{ + "Server":{ + "shape":"Server", + "documentation":"

Contains the response to an UpdateServerEngineAttributes request.

" + } + } + }, + "UpdateServerRequest":{ + "type":"structure", + "required":["ServerName"], + "members":{ + "DisableAutomatedBackup":{ + "shape":"Boolean", + "documentation":"

Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.

" + }, + "BackupRetentionCount":{ + "shape":"Integer", + "documentation":"

Sets the number of automated backups that you want to keep.

" + }, + "ServerName":{ + "shape":"ServerName", + "documentation":"

The name of the server to update.

" + }, + "PreferredMaintenanceWindow":{"shape":"TimeWindowDefinition"}, + "PreferredBackupWindow":{"shape":"TimeWindowDefinition"} + } + }, + "UpdateServerResponse":{ + "type":"structure", + "members":{ + "Server":{ + "shape":"Server", + "documentation":"

Contains the response to a UpdateServer request.

" + } + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

Error or informational message that can contain more detail about a validation failure.

" + } + }, + "documentation":"

One or more of the provided request parameters are not valid.

", + "exception":true + } + }, + "documentation":"AWS OpsWorks CM

AWS OpsWorks for configuration management (CM) is a service that runs and manages configuration management servers. You can use AWS OpsWorks CM to create and manage AWS OpsWorks for Chef Automate and AWS OpsWorks for Puppet Enterprise servers, and add or remove nodes for the servers to manage.

Glossary of terms

  • Server: A configuration management server that can be highly-available. The configuration management server runs on an Amazon Elastic Compute Cloud (EC2) instance, and may use various other AWS services, such as Amazon Relational Database Service (RDS) and Elastic Load Balancing. A server is a generic abstraction over the configuration manager that you want to use, much like Amazon RDS. In AWS OpsWorks CM, you do not start or stop servers. After you create servers, they continue to run until they are deleted.

  • Engine: The engine is the specific configuration manager that you want to use. Valid values in this release include ChefAutomate and Puppet.

  • Backup: This is an application-level backup of the data that the configuration manager stores. AWS OpsWorks CM creates an S3 bucket for backups when you launch the first server. A backup maintains a snapshot of a server's configuration-related attributes at the time the backup starts.

  • Events: Events are always related to a server. Events are written during server creation, when health checks run, when backups are created, when system maintenance is performed, etc. When you delete a server, the server's events are also deleted.

  • Account attributes: Every account has attributes that are assigned in the AWS OpsWorks CM database. These attributes store information about configuration limits (servers, backups, etc.) and your customer account.

Endpoints

AWS OpsWorks CM supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Your servers can only be accessed or managed within the endpoint in which they are created.

  • opsworks-cm.us-east-1.amazonaws.com

  • opsworks-cm.us-east-2.amazonaws.com

  • opsworks-cm.us-west-1.amazonaws.com

  • opsworks-cm.us-west-2.amazonaws.com

  • opsworks-cm.ap-northeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-1.amazonaws.com

  • opsworks-cm.ap-southeast-2.amazonaws.com

  • opsworks-cm.eu-central-1.amazonaws.com

  • opsworks-cm.eu-west-1.amazonaws.com

Throttling limits

All API operations allow for five requests per second with a burst of 10 requests per second.

" +} diff --git a/aws/dist/botocore/data/opsworkscm/2016-11-01/waiters-2.json b/aws/dist/botocore/data/opsworkscm/2016-11-01/waiters-2.json new file mode 100644 index 00000000..f37dd040 --- /dev/null +++ b/aws/dist/botocore/data/opsworkscm/2016-11-01/waiters-2.json @@ -0,0 +1,25 @@ +{ + "version": 2, + "waiters": { + "NodeAssociated": { + "delay": 15, + "maxAttempts": 15, + "operation": "DescribeNodeAssociationStatus", + "description": "Wait until node is associated or disassociated.", + "acceptors": [ + { + "expected": "SUCCESS", + "state": "success", + "matcher": "path", + "argument": "NodeAssociationStatus" + }, + { + "expected": "FAILED", + "state": "failure", + "matcher": "path", + "argument": "NodeAssociationStatus" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/organizations/2016-11-28/paginators-1.json b/aws/dist/botocore/data/organizations/2016-11-28/paginators-1.json new file mode 100644 index 00000000..cb7df330 --- /dev/null +++ b/aws/dist/botocore/data/organizations/2016-11-28/paginators-1.json @@ -0,0 +1,87 @@ +{ + "pagination": { + "ListAccounts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Accounts" + }, + "ListAccountsForParent": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Accounts" + }, + "ListChildren": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Children" + }, + "ListCreateAccountStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "CreateAccountStatuses" + }, + "ListHandshakesForAccount": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Handshakes" + }, + "ListHandshakesForOrganization": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Handshakes" + }, + "ListOrganizationalUnitsForParent": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "OrganizationalUnits" + }, + "ListParents": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Parents" + }, + "ListPolicies": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Policies" + }, + "ListPoliciesForTarget": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Policies" + }, + "ListRoots": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Roots" + }, + "ListTargetsForPolicy": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Targets" + }, + "ListAWSServiceAccessForOrganization": { + "result_key": "EnabledServicePrincipals", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTagsForResource": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/organizations/2016-11-28/service-2.json b/aws/dist/botocore/data/organizations/2016-11-28/service-2.json new file mode 100644 index 00000000..454d34f2 --- /dev/null +++ b/aws/dist/botocore/data/organizations/2016-11-28/service-2.json @@ -0,0 +1,3033 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-28", + "endpointPrefix":"organizations", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Organizations", + "serviceFullName":"AWS Organizations", + "serviceId":"Organizations", + "signatureVersion":"v4", + "targetPrefix":"AWSOrganizationsV20161128", + "uid":"organizations-2016-11-28" + }, + "operations":{ + "AcceptHandshake":{ + "name":"AcceptHandshake", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptHandshakeRequest"}, + "output":{"shape":"AcceptHandshakeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"HandshakeConstraintViolationException"}, + {"shape":"HandshakeNotFoundException"}, + {"shape":"InvalidHandshakeTransitionException"}, + {"shape":"HandshakeAlreadyInStateException"}, + {"shape":"InvalidInputException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AccessDeniedForDependencyException"} + ], + "documentation":"

Sends a response to the originator of a handshake agreeing to the action proposed by the handshake request.

This operation can be called only by the following principals when they also have the relevant IAM permissions:

  • Invitation to join or Approve all features request handshakes: only a principal from the member account.

    The user who calls the API for an invitation to join must have the organizations:AcceptHandshake permission. If you enabled all features in the organization, the user must also have the iam:CreateServiceLinkedRole permission so that AWS Organizations can create the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

  • Enable all features final confirmation handshake: only a principal from the master account.

    For more information about invitations, see Inviting an AWS Account to Join Your Organization in the AWS Organizations User Guide. For more information about requests to enable all features in the organization, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

After you accept a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

" + }, + "AttachPolicy":{ + "name":"AttachPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachPolicyRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"DuplicatePolicyAttachmentException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"PolicyTypeNotEnabledException"}, + {"shape":"ServiceException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy:

  • Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:

    • If you attach an SCP to a root, it affects all accounts in the organization.

    • If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.

    • If you attach the policy directly to an account, it affects only that account.

    SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). You can attach one SCP to a higher level root or OU, and a different SCP to a child OU or to an account. The child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child can't grant a permission that the parent hasn't already granted. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They can't use A or B because the child OU filtered them out. They also can't use F and G because the parent OU filtered them out. They can't be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.

    AWS Organizations attaches a default SCP named \"FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.

    For more information about how AWS Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

" + }, + "CancelHandshake":{ + "name":"CancelHandshake", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelHandshakeRequest"}, + "output":{"shape":"CancelHandshakeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"HandshakeNotFoundException"}, + {"shape":"InvalidHandshakeTransitionException"}, + {"shape":"HandshakeAlreadyInStateException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Cancels a handshake. Canceling a handshake sets the handshake state to CANCELED.

This operation can be called only from the account that originated the handshake. The recipient of the handshake can't cancel it, but can use DeclineHandshake instead. After a handshake is canceled, the recipient can no longer respond to that handshake.

After you cancel a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

" + }, + "CreateAccount":{ + "name":"CreateAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAccountRequest"}, + "output":{"shape":"CreateAccountResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"FinalizingOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"

Creates an AWS account that is automatically a member of the organization whose credentials made the request. This is an asynchronous request that AWS performs in the background. Because CreateAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

The user who calls the API to create an account must have the organizations:CreateAccount permission. If you enabled all features in the organization, AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS Organizations preconfigures the new member account with a role (named OrganizationAccountAccessRole by default) that grants users in the master account administrator permissions in the new member account. Principals in the master account can assume the role. AWS Organizations clones the company name and address information for the new account from the organization's master account.

This operation can be called only from the organization's master account.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

  • Using CreateAccount to create multiple temporary accounts isn't recommended. You can only close an account from the Billing and Cost Management Console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

" + }, + "CreateGovCloudAccount":{ + "name":"CreateGovCloudAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGovCloudAccountRequest"}, + "output":{"shape":"CreateGovCloudAccountResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"FinalizingOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"

This action is available if all of the following are true:

  • You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

  • You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

  • You call this action from the master account of your organization in the commercial Region.

  • You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

  • Verify that AWS CloudTrail is enabled to store logs.

  • Create an S3 bucket for AWS CloudTrail log storage.

    For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

  • Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

" + }, + "CreateOrganization":{ + "name":"CreateOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOrganizationRequest"}, + "output":{"shape":"CreateOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AlreadyInOrganizationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AccessDeniedForDependencyException"} + ], + "documentation":"

Creates an AWS organization. The account whose user is calling the CreateOrganization operation automatically becomes the master account of the new organization.

This operation must be called using credentials from the account that is to become the new organization's master account. The principal must also have the relevant IAM permissions.

By default (or if you set the FeatureSet parameter to ALL), the new organization is created with all features enabled and service control policies automatically enabled in the root. If you instead choose to create the organization supporting only the consolidated billing features by setting the FeatureSet parameter to CONSOLIDATED_BILLING\", no policy types are enabled by default, and you can't use organization policies.

" + }, + "CreateOrganizationalUnit":{ + "name":"CreateOrganizationalUnit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOrganizationalUnitRequest"}, + "output":{"shape":"CreateOrganizationalUnitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"DuplicateOrganizationalUnitException"}, + {"shape":"InvalidInputException"}, + {"shape":"ParentNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Creates an organizational unit (OU) within a root or parent OU. An OU is a container for accounts that enables you to organize your accounts to apply policies according to your business requirements. The number of levels deep that you can nest OUs is dependent upon the policy types enabled for that root. For service control policies, the limit is five.

For more information about OUs, see Managing Organizational Units in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

" + }, + "CreatePolicy":{ + "name":"CreatePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePolicyRequest"}, + "output":{"shape":"CreatePolicyResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"DuplicatePolicyException"}, + {"shape":"InvalidInputException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PolicyTypeNotAvailableForOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Creates a policy of a specified type that you can attach to a root, an organizational unit (OU), or an individual AWS account.

For more information about policies and their use, see Managing Organization Policies.

This operation can be called only from the organization's master account.

" + }, + "DeclineHandshake":{ + "name":"DeclineHandshake", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeclineHandshakeRequest"}, + "output":{"shape":"DeclineHandshakeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"HandshakeNotFoundException"}, + {"shape":"InvalidHandshakeTransitionException"}, + {"shape":"HandshakeAlreadyInStateException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Declines a handshake request. This sets the handshake state to DECLINED and effectively deactivates the request.

This operation can be called only from the account that received the handshake. The originator of the handshake can use CancelHandshake instead. The originator can't reactivate a declined request, but can reinitiate the process with a new handshake request.

After you decline a handshake, it continues to appear in the results of relevant APIs for only 30 days. After that, it's deleted.

" + }, + "DeleteOrganization":{ + "name":"DeleteOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidInputException"}, + {"shape":"OrganizationNotEmptyException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes the organization. You can delete an organization only by using credentials from the master account. The organization must be empty of member accounts.

" + }, + "DeleteOrganizationalUnit":{ + "name":"DeleteOrganizationalUnit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOrganizationalUnitRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidInputException"}, + {"shape":"OrganizationalUnitNotEmptyException"}, + {"shape":"OrganizationalUnitNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes an organizational unit (OU) from a root or another OU. You must first remove all accounts and child OUs from the OU that you want to delete.

This operation can be called only from the organization's master account.

" + }, + "DeletePolicy":{ + "name":"DeletePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePolicyRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyInUseException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Deletes the specified policy from your organization. Before you perform this operation, you must first detach the policy from all organizational units (OUs), roots, and accounts.

This operation can be called only from the organization's master account.

" + }, + "DescribeAccount":{ + "name":"DescribeAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountRequest"}, + "output":{"shape":"DescribeAccountResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves AWS Organizations-related information about the specified account.

This operation can be called only from the organization's master account.

" + }, + "DescribeCreateAccountStatus":{ + "name":"DescribeCreateAccountStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCreateAccountStatusRequest"}, + "output":{"shape":"DescribeCreateAccountStatusResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"CreateAccountStatusNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"

Retrieves the current status of an asynchronous request to create an account.

This operation can be called only from the organization's master account.

" + }, + "DescribeHandshake":{ + "name":"DescribeHandshake", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHandshakeRequest"}, + "output":{"shape":"DescribeHandshakeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"HandshakeNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves information about a previously requested handshake. The handshake ID comes from the response to the original InviteAccountToOrganization operation that generated the handshake.

You can access handshakes that are ACCEPTED, DECLINED, or CANCELED for only 30 days after they change to that state. They're then deleted and no longer accessible.

This operation can be called from any account in the organization.

" + }, + "DescribeOrganization":{ + "name":"DescribeOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{"shape":"DescribeOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves information about the organization that the user's account belongs to.

This operation can be called from any account in the organization.

Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.

" + }, + "DescribeOrganizationalUnit":{ + "name":"DescribeOrganizationalUnit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrganizationalUnitRequest"}, + "output":{"shape":"DescribeOrganizationalUnitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"OrganizationalUnitNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves information about an organizational unit (OU).

This operation can be called only from the organization's master account.

" + }, + "DescribePolicy":{ + "name":"DescribePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePolicyRequest"}, + "output":{"shape":"DescribePolicyResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves information about a policy.

This operation can be called only from the organization's master account.

" + }, + "DetachPolicy":{ + "name":"DetachPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachPolicyRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotAttachedException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.

Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of whitelisting. If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of blacklisting .

This operation can be called only from the organization's master account.

" + }, + "DisableAWSServiceAccess":{ + "name":"DisableAWSServiceAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableAWSServiceAccessRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Disables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you disable integration, the specified service no longer can create a service-linked role in new accounts in your organization. This means the service can't perform operations on your behalf on any new accounts in your organization. The service can still perform operations in older accounts until the service completes its clean-up from AWS Organizations.

We recommend that you disable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the other service is aware that it can clean up any resources that are required only for the integration. How the service cleans up its resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

After you perform the DisableAWSServiceAccess operation, the specified service can no longer perform operations in your organization's accounts unless the operations are explicitly permitted by the IAM policies that are attached to your roles.

For more information about integrating other services with AWS Organizations, including the list of services that work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

" + }, + "DisablePolicyType":{ + "name":"DisablePolicyType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisablePolicyTypeRequest"}, + "output":{"shape":"DisablePolicyTypeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyTypeNotEnabledException"}, + {"shape":"RootNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

To view the status of available policy types in the organization, use DescribeOrganization.

" + }, + "EnableAWSServiceAccess":{ + "name":"EnableAWSServiceAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAWSServiceAccessRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Enables the integration of an AWS service (the service that is specified by ServicePrincipal) with AWS Organizations. When you enable integration, you allow the specified service to create a service-linked role in all the accounts in your organization. This allows the service to perform operations on your behalf in your organization and its accounts.

We recommend that you enable integration between AWS Organizations and the specified AWS service by using the console or commands that are provided by the specified service. Doing so ensures that the service is aware that it can create the resources that are required for the integration. How the service creates those resources in the organization's accounts depends on that service. For more information, see the documentation for the other AWS service.

For more information about enabling services to integrate with AWS Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account and only if the organization has enabled all features.

" + }, + "EnableAllFeatures":{ + "name":"EnableAllFeatures", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAllFeaturesRequest"}, + "output":{"shape":"EnableAllFeaturesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"HandshakeConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Enables all features in an organization. This enables the use of organization policies that can restrict the services and actions that can be called in each account. Until you enable all features, you have access only to consolidated billing, and you can't use any of the advanced account administration features that AWS Organizations supports. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

This operation is required only for organizations that were created explicitly with only the consolidated billing features enabled. Calling this operation sends a handshake to every invited account in the organization. The feature set change can be finalized and the additional features enabled only after all administrators in the invited accounts approve the change by accepting the handshake.

After you enable all features, you can separately enable or disable individual policy types in a root using EnablePolicyType and DisablePolicyType. To see the status of policy types in a root, use ListRoots.

After all invited member accounts accept the handshake, you finalize the feature set change by accepting the handshake that contains \"Action\": \"ENABLE_ALL_FEATURES\". This completes the change.

After you enable all features in your organization, the master account in the organization can apply policies on all member accounts. These policies can restrict what users and even administrators in those accounts can do. The master account can apply policies that prevent accounts from leaving the organization. Ensure that your account administrators are aware of this.

This operation can be called only from the organization's master account.

" + }, + "EnablePolicyType":{ + "name":"EnablePolicyType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnablePolicyTypeRequest"}, + "output":{"shape":"EnablePolicyTypeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyTypeAlreadyEnabledException"}, + {"shape":"RootNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"PolicyTypeNotAvailableForOrganizationException"} + ], + "documentation":"

Enables a policy type in a root. After you enable a policy type in a root, you can attach policies of that type to the root, any organizational unit (OU), or account in that root. You can undo this by using the DisablePolicyType operation.

This is an asynchronous request that AWS performs in the background. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

You can enable a policy type in a root only if that policy type is available in the organization. To view the status of available policy types in the organization, use DescribeOrganization.

" + }, + "InviteAccountToOrganization":{ + "name":"InviteAccountToOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"InviteAccountToOrganizationRequest"}, + "output":{"shape":"InviteAccountToOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"AccountOwnerNotVerifiedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"HandshakeConstraintViolationException"}, + {"shape":"DuplicateHandshakeException"}, + {"shape":"InvalidInputException"}, + {"shape":"FinalizingOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Sends an invitation to another account to join your organization as a member account. AWS Organizations sends email on your behalf to the email address that is associated with the other account's owner. The invitation is implemented as a Handshake whose details are in the response.

  • You can invite AWS accounts only from the same seller as the master account. For example, if your organization's master account was created by Amazon Internet Services Pvt. Ltd (AISPL), an AWS seller in India, you can invite only other AISPL accounts to your organization. You can't combine accounts from AISPL and AWS or from any other AWS seller. For more information, see Consolidated Billing in India.

  • If you receive an exception that indicates that you exceeded your account limits for the organization or that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists after an hour, contact AWS Support.

This operation can be called only from the organization's master account.

" + }, + "LeaveOrganization":{ + "name":"LeaveOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"MasterCannotLeaveOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Removes a member account from its parent organization. This version of the operation is performed by the account that wants to leave. To remove a member account as a user in the master account, use RemoveAccountFromOrganization instead.

This operation can be called only from a member account in the organization.

  • The master account in an organization with all features enabled can set service control policies (SCPs) that can restrict what administrators of member accounts can do, including preventing them from successfully calling LeaveOrganization and leaving the organization.

  • You can leave an organization as a member account only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For each account that you want to make standalone, you must accept the end user license agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • You can leave an organization only after you enable IAM user access to billing in your account. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

" + }, + "ListAWSServiceAccessForOrganization":{ + "name":"ListAWSServiceAccessForOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAWSServiceAccessForOrganizationRequest"}, + "output":{"shape":"ListAWSServiceAccessForOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Returns a list of the AWS services that you enabled to integrate with your organization. After a service on this list creates the resources that it requires for the integration, it can perform operations on your organization and its accounts.

For more information about integrating other services with AWS Organizations, including the list of services that currently work with Organizations, see Integrating AWS Organizations with Other AWS Services in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

" + }, + "ListAccounts":{ + "name":"ListAccounts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountsRequest"}, + "output":{"shape":"ListAccountsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists all the accounts in the organization. To request only the accounts in a specified root or organizational unit (OU), use the ListAccountsForParent operation instead.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListAccountsForParent":{ + "name":"ListAccountsForParent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAccountsForParentRequest"}, + "output":{"shape":"ListAccountsForParentResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ParentNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the accounts in an organization that are contained by the specified target root or organizational unit (OU). If you specify the root, you get a list of all the accounts that aren't in any OU. If you specify an OU, you get a list of all the accounts in only that OU and not in any child OUs. To get a list of all accounts in the organization, use the ListAccounts operation.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListChildren":{ + "name":"ListChildren", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListChildrenRequest"}, + "output":{"shape":"ListChildrenResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ParentNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists all of the organizational units (OUs) or accounts that are contained in the specified parent OU or root. This operation, along with ListParents enables you to traverse the tree structure that makes up this root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListCreateAccountStatus":{ + "name":"ListCreateAccountStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCreateAccountStatusRequest"}, + "output":{"shape":"ListCreateAccountStatusResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedAPIEndpointException"} + ], + "documentation":"

Lists the account creation requests that match the specified status that is currently being tracked for the organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListHandshakesForAccount":{ + "name":"ListHandshakesForAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHandshakesForAccountRequest"}, + "output":{"shape":"ListHandshakesForAccountResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the current handshakes that are associated with the account of the requesting user.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called from any account in the organization.

" + }, + "ListHandshakesForOrganization":{ + "name":"ListHandshakesForOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHandshakesForOrganizationRequest"}, + "output":{"shape":"ListHandshakesForOrganizationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the handshakes that are associated with the organization that the requesting user is part of. The ListHandshakesForOrganization operation returns a list of handshake structures. Each structure contains details and status about a handshake.

Handshakes that are ACCEPTED, DECLINED, or CANCELED appear in the results of this API for only 30 days after changing to that state. After that, they're deleted and no longer accessible.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListOrganizationalUnitsForParent":{ + "name":"ListOrganizationalUnitsForParent", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOrganizationalUnitsForParentRequest"}, + "output":{"shape":"ListOrganizationalUnitsForParentResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ParentNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the organizational units (OUs) in a parent organizational unit or root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListParents":{ + "name":"ListParents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListParentsRequest"}, + "output":{"shape":"ListParentsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ChildNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the root or organizational units (OUs) that serve as the immediate parent of the specified child OU or account. This operation, along with ListChildren enables you to traverse the tree structure that makes up this root.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

In the current release, a child can have only a single parent.

" + }, + "ListPolicies":{ + "name":"ListPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesRequest"}, + "output":{"shape":"ListPoliciesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieves the list of all policies in an organization of a specified type.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListPoliciesForTarget":{ + "name":"ListPoliciesForTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPoliciesForTargetRequest"}, + "output":{"shape":"ListPoliciesForTargetResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the policies that are directly attached to the specified target root, organizational unit (OU), or account. You must specify the policy type that you want included in the returned list.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "ListRoots":{ + "name":"ListRoots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRootsRequest"}, + "output":{"shape":"ListRootsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists the roots that are defined in the current organization.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

Policy types can be enabled and disabled in roots. This is distinct from whether they're available in the organization. When you enable all features, you make policy types available for use in that organization. Individual policy types can then be enabled and disabled in a root. To see the availability of a policy type in an organization, use DescribeOrganization.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists tags for the specified resource.

Currently, you can list tags on an account in AWS Organizations.

This operation can be called only from the organization's master account.

" + }, + "ListTargetsForPolicy":{ + "name":"ListTargetsForPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTargetsForPolicyRequest"}, + "output":{"shape":"ListTargetsForPolicyResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Lists all the roots, organizational units (OUs), and accounts that the specified policy is attached to.

Always check the NextToken response parameter for a null value when calling a List* operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

This operation can be called only from the organization's master account.

" + }, + "MoveAccount":{ + "name":"MoveAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"MoveAccountRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidInputException"}, + {"shape":"SourceParentNotFoundException"}, + {"shape":"DestinationParentNotFoundException"}, + {"shape":"DuplicateAccountException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ServiceException"} + ], + "documentation":"

Moves an account from its current source parent root or organizational unit (OU) to the specified destination parent root or OU.

This operation can be called only from the organization's master account.

" + }, + "RemoveAccountFromOrganization":{ + "name":"RemoveAccountFromOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveAccountFromOrganizationRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AccountNotFoundException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"MasterCannotLeaveOrganizationException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Removes the specified account from the organization.

The removed account becomes a standalone account that isn't a member of any organization. It's no longer subject to any policies and is responsible for its own bill payments. The organization's master account is no longer charged for any expenses accrued by the member account after it's removed from the organization.

This operation can be called only from the organization's master account. Member accounts can remove themselves with LeaveOrganization instead.

You can remove an account from your organization only if the account is configured with the information required to operate as a standalone account. When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required of standalone accounts is not automatically collected. For an account that you want to make standalone, you must accept the end user license agreement (EULA), choose a support plan, provide and verify the required contact information, and provide a current payment method. AWS uses the payment method to charge for any billable (not free tier) AWS activity that occurs while the account isn't attached to an organization. To remove an account that doesn't yet have this information, you must sign in as the member account and follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Adds one or more tags to the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

This operation can be called only from the organization's master account.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"TargetNotFoundException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"InvalidInputException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Removes a tag from the specified resource.

Currently, you can tag and untag accounts in AWS Organizations.

This operation can be called only from the organization's master account.

" + }, + "UpdateOrganizationalUnit":{ + "name":"UpdateOrganizationalUnit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateOrganizationalUnitRequest"}, + "output":{"shape":"UpdateOrganizationalUnitResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"DuplicateOrganizationalUnitException"}, + {"shape":"InvalidInputException"}, + {"shape":"OrganizationalUnitNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Renames the specified organizational unit (OU). The ID and ARN don't change. The child OUs and accounts remain in place, and any attached policies of the OU remain attached.

This operation can be called only from the organization's master account.

" + }, + "UpdatePolicy":{ + "name":"UpdatePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePolicyRequest"}, + "output":{"shape":"UpdatePolicyResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"AWSOrganizationsNotInUseException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"ConstraintViolationException"}, + {"shape":"DuplicatePolicyException"}, + {"shape":"InvalidInputException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PolicyNotFoundException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Updates an existing policy with a new name, description, or content. If you don't supply any parameter, that value remains unchanged. You can't change a policy's type.

This operation can be called only from the organization's master account.

" + } + }, + "shapes":{ + "AWSOrganizationsNotInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

Your account isn't a member of an organization. To make this request, you must use the credentials of an account that belongs to an organization.

", + "exception":true + }, + "AcceptHandshakeRequest":{ + "type":"structure", + "required":["HandshakeId"], + "members":{ + "HandshakeId":{ + "shape":"HandshakeId", + "documentation":"

The unique identifier (ID) of the handshake that you want to accept.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + } + } + }, + "AcceptHandshakeResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains details about the accepted handshake.

" + } + } + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.

", + "exception":true + }, + "AccessDeniedForDependencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "Reason":{"shape":"AccessDeniedForDependencyExceptionReason"} + }, + "documentation":"

The operation that you attempted requires you to have the iam:CreateServiceLinkedRole for organizations.amazonaws.com permission so that AWS Organizations can create the required service-linked role. You don't have that permission.

", + "exception":true + }, + "AccessDeniedForDependencyExceptionReason":{ + "type":"string", + "enum":["ACCESS_DENIED_DURING_CREATE_SERVICE_LINKED_ROLE"] + }, + "Account":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"AccountId", + "documentation":"

The unique identifier (ID) of the account.

The regex pattern for an account ID string requires exactly 12 digits.

" + }, + "Arn":{ + "shape":"AccountArn", + "documentation":"

The Amazon Resource Name (ARN) of the account.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Email":{ + "shape":"Email", + "documentation":"

The email address associated with the AWS account.

The regex pattern for this parameter is a string of characters that represents a standard Internet email address.

" + }, + "Name":{ + "shape":"AccountName", + "documentation":"

The friendly name of the account.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "Status":{ + "shape":"AccountStatus", + "documentation":"

The status of the account in the organization.

" + }, + "JoinedMethod":{ + "shape":"AccountJoinedMethod", + "documentation":"

The method by which the account joined the organization.

" + }, + "JoinedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date the account became a part of the organization.

" + } + }, + "documentation":"

Contains information about an AWS account that is a member of an organization.

" + }, + "AccountArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::\\d{12}:account\\/o-[a-z0-9]{10,32}\\/\\d{12}" + }, + "AccountId":{ + "type":"string", + "pattern":"^\\d{12}$" + }, + "AccountJoinedMethod":{ + "type":"string", + "enum":[ + "INVITED", + "CREATED" + ] + }, + "AccountName":{ + "type":"string", + "max":50, + "min":1, + "pattern":"[\\u0020-\\u007E]+", + "sensitive":true + }, + "AccountNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find an AWS account with the AccountId that you specified, or the account whose credentials you used to make this request isn't a member of an organization.

", + "exception":true + }, + "AccountOwnerNotVerifiedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You can't invite an existing account to your organization until you verify that you own the email address associated with the master account. For more information, see Email Address Verification in the AWS Organizations User Guide.

", + "exception":true + }, + "AccountStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "SUSPENDED" + ] + }, + "Accounts":{ + "type":"list", + "member":{"shape":"Account"} + }, + "ActionType":{ + "type":"string", + "enum":[ + "INVITE", + "ENABLE_ALL_FEATURES", + "APPROVE_ALL_FEATURES", + "ADD_ORGANIZATIONS_SERVICE_LINKED_ROLE" + ] + }, + "AlreadyInOrganizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

This account is already a member of an organization. An account can belong to only one organization at a time.

", + "exception":true + }, + "AttachPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyId", + "TargetId" + ], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy that you want to attach to the target. You can get the ID for the policy by calling the ListPolicies operation.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + }, + "TargetId":{ + "shape":"PolicyTargetId", + "documentation":"

The unique identifier (ID) of the root, OU, or account that you want to attach the policy to. You can get the ID by calling the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + } + } + }, + "AwsManagedPolicy":{"type":"boolean"}, + "CancelHandshakeRequest":{ + "type":"structure", + "required":["HandshakeId"], + "members":{ + "HandshakeId":{ + "shape":"HandshakeId", + "documentation":"

The unique identifier (ID) of the handshake that you want to cancel. You can get the ID from the ListHandshakesForOrganization operation.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + } + } + }, + "CancelHandshakeResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains details about the handshake that you canceled.

" + } + } + }, + "Child":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ChildId", + "documentation":"

The unique identifier (ID) of this child entity.

The regex pattern for a child ID string requires one of the following:

  • Account: a string that consists of exactly 12 digits.

  • Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Type":{ + "shape":"ChildType", + "documentation":"

The type of this child entity.

" + } + }, + "documentation":"

Contains a list of child entities, either OUs or accounts.

" + }, + "ChildId":{ + "type":"string", + "pattern":"^(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" + }, + "ChildNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find an organizational unit (OU) or AWS account with the ChildId that you specified.

", + "exception":true + }, + "ChildType":{ + "type":"string", + "enum":[ + "ACCOUNT", + "ORGANIZATIONAL_UNIT" + ] + }, + "Children":{ + "type":"list", + "member":{"shape":"Child"} + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The target of the operation is currently being modified by a different request. Try again later.

", + "exception":true + }, + "ConstraintViolationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "Reason":{"shape":"ConstraintViolationExceptionReason"} + }, + "documentation":"

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit.

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

  • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.

    Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.

    Deleted and closed accounts still count toward your limit.

    If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

  • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

  • MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.

  • MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.

  • MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

  • MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.

  • MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

  • MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.

  • OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

  • ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

  • OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

  • POLICY_NUMBER_LIMIT_EXCEEDED. You attempted to exceed the number of policies that you can have in an organization.

", + "exception":true + }, + "ConstraintViolationExceptionReason":{ + "type":"string", + "enum":[ + "ACCOUNT_NUMBER_LIMIT_EXCEEDED", + "HANDSHAKE_RATE_LIMIT_EXCEEDED", + "OU_NUMBER_LIMIT_EXCEEDED", + "OU_DEPTH_LIMIT_EXCEEDED", + "POLICY_NUMBER_LIMIT_EXCEEDED", + "MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED", + "MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED", + "ACCOUNT_CANNOT_LEAVE_ORGANIZATION", + "ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA", + "ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION", + "MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED", + "MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED", + "ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED", + "MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE", + "MASTER_ACCOUNT_MISSING_CONTACT_INFO", + "MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED", + "ORGANIZATION_NOT_IN_ALL_FEATURES_MODE", + "CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION", + "EMAIL_VERIFICATION_CODE_EXPIRED", + "WAIT_PERIOD_ACTIVE", + "MAX_TAG_LIMIT_EXCEEDED", + "TAG_POLICY_VIOLATION" + ] + }, + "CreateAccountFailureReason":{ + "type":"string", + "enum":[ + "ACCOUNT_LIMIT_EXCEEDED", + "EMAIL_ALREADY_EXISTS", + "INVALID_ADDRESS", + "INVALID_EMAIL", + "CONCURRENT_ACCOUNT_MODIFICATION", + "INTERNAL_FAILURE" + ] + }, + "CreateAccountRequest":{ + "type":"structure", + "required":[ + "Email", + "AccountName" + ], + "members":{ + "Email":{ + "shape":"Email", + "documentation":"

The email address of the owner to assign to the new member account. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address.

" + }, + "AccountName":{ + "shape":"AccountName", + "documentation":"

The friendly name of the member account.

" + }, + "RoleName":{ + "shape":"RoleName", + "documentation":"

(Optional)

The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.

If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.

For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" + }, + "IamUserAccessToBilling":{ + "shape":"IAMUserAccessToBilling", + "documentation":"

If set to ALLOW, the new account enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.

" + } + } + }, + "CreateAccountRequestId":{ + "type":"string", + "pattern":"^car-[a-z0-9]{8,32}$" + }, + "CreateAccountResponse":{ + "type":"structure", + "members":{ + "CreateAccountStatus":{ + "shape":"CreateAccountStatus", + "documentation":"

A structure that contains details about the request to create an account. This response structure might not be fully populated when you first receive it because account creation is an asynchronous process. You can pass the returned CreateAccountStatus ID as a parameter to DescribeCreateAccountStatus to get status about the progress of the request at later times. You can also check the AWS CloudTrail log for the CreateAccountResult event. For more information, see Monitoring the Activity in Your Organization in the AWS Organizations User Guide.

" + } + } + }, + "CreateAccountState":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "CreateAccountStates":{ + "type":"list", + "member":{"shape":"CreateAccountState"} + }, + "CreateAccountStatus":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"CreateAccountRequestId", + "documentation":"

The unique identifier (ID) that references this request. You get this value from the response of the initial CreateAccount request to create the account.

The regex pattern for an create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.

" + }, + "AccountName":{ + "shape":"AccountName", + "documentation":"

The account name given to the account when it was created.

" + }, + "State":{ + "shape":"CreateAccountState", + "documentation":"

The status of the request.

" + }, + "RequestedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the request was made for the account creation.

" + }, + "CompletedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the account was created and the request completed.

" + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

If the account was created successfully, the unique identifier (ID) of the new account.

The regex pattern for an account ID string requires exactly 12 digits.

" + }, + "GovCloudAccountId":{ + "shape":"AccountId", + "documentation":"

If the account was created successfully, the unique identifier (ID) of the new account in the AWS GovCloud (US) Region.

" + }, + "FailureReason":{ + "shape":"CreateAccountFailureReason", + "documentation":"

If the request failed, a description of the reason for the failure.

  • ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.

  • EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.

  • GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.

  • INVALID_ADDRESS: The account could not be created because the address you provided is not valid.

  • INVALID_EMAIL: The account could not be created because the email address you provided is not valid.

  • INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.

" + } + }, + "documentation":"

Contains the status about a CreateAccount or CreateGovCloudAccount request to create an AWS account or an AWS GovCloud (US) account in an organization.

" + }, + "CreateAccountStatusNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find an create account request with the CreateAccountRequestId that you specified.

", + "exception":true + }, + "CreateAccountStatuses":{ + "type":"list", + "member":{"shape":"CreateAccountStatus"} + }, + "CreateGovCloudAccountRequest":{ + "type":"structure", + "required":[ + "Email", + "AccountName" + ], + "members":{ + "Email":{ + "shape":"Email", + "documentation":"

The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for CreateGovCloudAccount, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region.

" + }, + "AccountName":{ + "shape":"AccountName", + "documentation":"

The friendly name of the member account.

" + }, + "RoleName":{ + "shape":"RoleName", + "documentation":"

(Optional)

The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.

If you don't specify this parameter, the role name defaults to OrganizationAccountAccessRole.

For more information about how to use this role to access the member account, see Accessing and Administering the Member Accounts in Your Organization in the AWS Organizations User Guide and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

" + }, + "IamUserAccessToBilling":{ + "shape":"IAMUserAccessToBilling", + "documentation":"

If set to ALLOW, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set to DENY, only the root user of the new account can access account billing information. For more information, see Activating Access to the Billing and Cost Management Console in the AWS Billing and Cost Management User Guide.

If you don't specify this parameter, the value defaults to ALLOW, and IAM users and roles with the required permissions can access billing information for the new account.

" + } + } + }, + "CreateGovCloudAccountResponse":{ + "type":"structure", + "members":{ + "CreateAccountStatus":{"shape":"CreateAccountStatus"} + } + }, + "CreateOrganizationRequest":{ + "type":"structure", + "members":{ + "FeatureSet":{ + "shape":"OrganizationFeatureSet", + "documentation":"

Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.

  • CONSOLIDATED_BILLING: All member accounts have their bills consolidated to and paid by the master account. For more information, see Consolidated billing in the AWS Organizations User Guide.

    The consolidated billing feature subset isn't available for organizations in the AWS GovCloud (US) Region.

  • ALL: In addition to all the features supported by the consolidated billing feature set, the master account can also apply any policy type to any member account in the organization. For more information, see All features in the AWS Organizations User Guide.

" + } + } + }, + "CreateOrganizationResponse":{ + "type":"structure", + "members":{ + "Organization":{ + "shape":"Organization", + "documentation":"

A structure that contains details about the newly created organization.

" + } + } + }, + "CreateOrganizationalUnitRequest":{ + "type":"structure", + "required":[ + "ParentId", + "Name" + ], + "members":{ + "ParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) of the parent root or OU that you want to create the new OU in.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Name":{ + "shape":"OrganizationalUnitName", + "documentation":"

The friendly name to assign to the new OU.

" + } + } + }, + "CreateOrganizationalUnitResponse":{ + "type":"structure", + "members":{ + "OrganizationalUnit":{ + "shape":"OrganizationalUnit", + "documentation":"

A structure that contains details about the newly created OU.

" + } + } + }, + "CreatePolicyRequest":{ + "type":"structure", + "required":[ + "Content", + "Description", + "Name", + "Type" + ], + "members":{ + "Content":{ + "shape":"PolicyContent", + "documentation":"

The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

An optional description to assign to the policy.

" + }, + "Name":{ + "shape":"PolicyName", + "documentation":"

The friendly name to assign to the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "Type":{ + "shape":"PolicyType", + "documentation":"

The type of policy to create.

In the current release, the only type of policy that you can create is a service control policy (SCP).

" + } + } + }, + "CreatePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

A structure that contains details about the newly created policy.

" + } + } + }, + "DeclineHandshakeRequest":{ + "type":"structure", + "required":["HandshakeId"], + "members":{ + "HandshakeId":{ + "shape":"HandshakeId", + "documentation":"

The unique identifier (ID) of the handshake that you want to decline. You can get the ID from the ListHandshakesForAccount operation.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + } + } + }, + "DeclineHandshakeResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains details about the declined handshake. The state is updated to show the value DECLINED.

" + } + } + }, + "DeleteOrganizationalUnitRequest":{ + "type":"structure", + "required":["OrganizationalUnitId"], + "members":{ + "OrganizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"

The unique identifier (ID) of the organizational unit that you want to delete. You can get the ID from the ListOrganizationalUnitsForParent operation.

The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + } + } + }, + "DeletePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy that you want to delete. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + } + } + }, + "DescribeAccountRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The unique identifier (ID) of the AWS account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

The regex pattern for an account ID string requires exactly 12 digits.

" + } + } + }, + "DescribeAccountResponse":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"Account", + "documentation":"

A structure that contains information about the requested account.

" + } + } + }, + "DescribeCreateAccountStatusRequest":{ + "type":"structure", + "required":["CreateAccountRequestId"], + "members":{ + "CreateAccountRequestId":{ + "shape":"CreateAccountRequestId", + "documentation":"

Specifies the operationId that uniquely identifies the request. You can get the ID from the response to an earlier CreateAccount request, or from the ListCreateAccountStatus operation.

The regex pattern for a create account request ID string requires \"car-\" followed by from 8 to 32 lower-case letters or digits.

" + } + } + }, + "DescribeCreateAccountStatusResponse":{ + "type":"structure", + "members":{ + "CreateAccountStatus":{ + "shape":"CreateAccountStatus", + "documentation":"

A structure that contains the current status of an account creation request.

" + } + } + }, + "DescribeHandshakeRequest":{ + "type":"structure", + "required":["HandshakeId"], + "members":{ + "HandshakeId":{ + "shape":"HandshakeId", + "documentation":"

The unique identifier (ID) of the handshake that you want information about. You can get the ID from the original call to InviteAccountToOrganization, or from a call to ListHandshakesForAccount or ListHandshakesForOrganization.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + } + } + }, + "DescribeHandshakeResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains information about the specified handshake.

" + } + } + }, + "DescribeOrganizationResponse":{ + "type":"structure", + "members":{ + "Organization":{ + "shape":"Organization", + "documentation":"

A structure that contains information about the organization.

" + } + } + }, + "DescribeOrganizationalUnitRequest":{ + "type":"structure", + "required":["OrganizationalUnitId"], + "members":{ + "OrganizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"

The unique identifier (ID) of the organizational unit that you want details about. You can get the ID from the ListOrganizationalUnitsForParent operation.

The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + } + } + }, + "DescribeOrganizationalUnitResponse":{ + "type":"structure", + "members":{ + "OrganizationalUnit":{ + "shape":"OrganizationalUnit", + "documentation":"

A structure that contains details about the specified OU.

" + } + } + }, + "DescribePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy that you want details about. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + } + } + }, + "DescribePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

A structure that contains details about the specified policy.

" + } + } + }, + "DestinationParentNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find the destination container (a root or OU) with the ParentId that you specified.

", + "exception":true + }, + "DetachPolicyRequest":{ + "type":"structure", + "required":[ + "PolicyId", + "TargetId" + ], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy you want to detach. You can get the ID from the ListPolicies or ListPoliciesForTarget operations.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + }, + "TargetId":{ + "shape":"PolicyTargetId", + "documentation":"

The unique identifier (ID) of the root, OU, or account that you want to detach the policy from. You can get the ID from the ListRoots, ListOrganizationalUnitsForParent, or ListAccounts operations.

The regex pattern for a target ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + } + } + }, + "DisableAWSServiceAccessRequest":{ + "type":"structure", + "required":["ServicePrincipal"], + "members":{ + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"

The service principal name of the AWS service for which you want to disable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

" + } + } + }, + "DisablePolicyTypeRequest":{ + "type":"structure", + "required":[ + "RootId", + "PolicyType" + ], + "members":{ + "RootId":{ + "shape":"RootId", + "documentation":"

The unique identifier (ID) of the root in which you want to disable a policy type. You can get the ID from the ListRoots operation.

The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The policy type that you want to disable in this root.

" + } + } + }, + "DisablePolicyTypeResponse":{ + "type":"structure", + "members":{ + "Root":{ + "shape":"Root", + "documentation":"

A structure that shows the root with the updated list of enabled policy types.

" + } + } + }, + "DuplicateAccountException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

That account is already present in the specified destination.

", + "exception":true + }, + "DuplicateHandshakeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A handshake with the same action and target already exists. For example, if you invited an account to join your organization, the invited account might already have a pending invitation from this organization. If you intend to resend an invitation to an account, ensure that existing handshakes that might be considered duplicates are canceled or declined.

", + "exception":true + }, + "DuplicateOrganizationalUnitException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

An OU with the same name already exists.

", + "exception":true + }, + "DuplicatePolicyAttachmentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The selected policy is already attached to the specified target.

", + "exception":true + }, + "DuplicatePolicyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

A policy with the same name already exists.

", + "exception":true + }, + "Email":{ + "type":"string", + "max":64, + "min":6, + "pattern":"[^\\s@]+@[^\\s@]+\\.[^\\s@]+", + "sensitive":true + }, + "EnableAWSServiceAccessRequest":{ + "type":"structure", + "required":["ServicePrincipal"], + "members":{ + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"

The service principal name of the AWS service for which you want to enable integration with your organization. This is typically in the form of a URL, such as service-abbreviation.amazonaws.com.

" + } + } + }, + "EnableAllFeaturesRequest":{ + "type":"structure", + "members":{ + } + }, + "EnableAllFeaturesResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains details about the handshake created to support this request to enable all features in the organization.

" + } + } + }, + "EnablePolicyTypeRequest":{ + "type":"structure", + "required":[ + "RootId", + "PolicyType" + ], + "members":{ + "RootId":{ + "shape":"RootId", + "documentation":"

The unique identifier (ID) of the root in which you want to enable a policy type. You can get the ID from the ListRoots operation.

The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.

" + }, + "PolicyType":{ + "shape":"PolicyType", + "documentation":"

The policy type that you want to enable.

" + } + } + }, + "EnablePolicyTypeResponse":{ + "type":"structure", + "members":{ + "Root":{ + "shape":"Root", + "documentation":"

A structure that shows the root with the updated list of enabled policy types.

" + } + } + }, + "EnabledServicePrincipal":{ + "type":"structure", + "members":{ + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"

The name of the service principal. This is typically in the form of a URL, such as: servicename.amazonaws.com.

" + }, + "DateEnabled":{ + "shape":"Timestamp", + "documentation":"

The date that the service principal was enabled for integration with AWS Organizations.

" + } + }, + "documentation":"

A structure that contains details of a service principal that is enabled to integrate with AWS Organizations.

" + }, + "EnabledServicePrincipals":{ + "type":"list", + "member":{"shape":"EnabledServicePrincipal"} + }, + "ExceptionMessage":{"type":"string"}, + "ExceptionType":{"type":"string"}, + "FinalizingOrganizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

AWS Organizations couldn't perform the operation because your organization hasn't finished initializing. This can take up to an hour. Try again later. If after one hour you continue to receive this error, contact AWS Support.

", + "exception":true + }, + "GenericArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::.+:.+" + }, + "Handshake":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"HandshakeId", + "documentation":"

The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + }, + "Arn":{ + "shape":"HandshakeArn", + "documentation":"

The Amazon Resource Name (ARN) of a handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Parties":{ + "shape":"HandshakeParties", + "documentation":"

Information about the two accounts that are participating in the handshake.

" + }, + "State":{ + "shape":"HandshakeState", + "documentation":"

The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:

  • REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.

  • OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.

  • CANCELED: This handshake is no longer active because it was canceled by the originating account.

  • ACCEPTED: This handshake is complete because it has been accepted by the recipient.

  • DECLINED: This handshake is no longer active because it was declined by the recipient account.

  • EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).

" + }, + "RequestedTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the handshake request was made.

" + }, + "ExpirationTimestamp":{ + "shape":"Timestamp", + "documentation":"

The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.

" + }, + "Action":{ + "shape":"ActionType", + "documentation":"

The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:

  • INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.

  • ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.

  • APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member accounts have approved the ENABLE_ALL_FEATURES invitation. It is sent only to the master account and signals the master that it can finalize the process to enable all features.

" + }, + "Resources":{ + "shape":"HandshakeResources", + "documentation":"

Additional information that is needed to process the handshake.

" + } + }, + "documentation":"

Contains information that must be exchanged to securely establish a relationship between two accounts (an originator and a recipient). For example, when a master account (the originator) invites another account (the recipient) to join its organization, the two accounts exchange information as a series of handshake requests and responses.

Note: Handshakes that are CANCELED, ACCEPTED, or DECLINED show up in lists for only 30 days after entering that state After that they are deleted.

" + }, + "HandshakeAlreadyInStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified handshake is already in the requested state. For example, you can't accept a handshake that was already accepted.

", + "exception":true + }, + "HandshakeArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::\\d{12}:handshake\\/o-[a-z0-9]{10,32}\\/[a-z_]{1,32}\\/h-[0-9a-z]{8,32}" + }, + "HandshakeConstraintViolationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "Reason":{"shape":"HandshakeConstraintViolationExceptionReason"} + }, + "documentation":"

The requested operation would violate the constraint identified in the reason code.

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.

    If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

  • ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.

  • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

  • INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.

  • ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.

  • ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.

  • ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.

  • PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.

", + "exception":true + }, + "HandshakeConstraintViolationExceptionReason":{ + "type":"string", + "enum":[ + "ACCOUNT_NUMBER_LIMIT_EXCEEDED", + "HANDSHAKE_RATE_LIMIT_EXCEEDED", + "ALREADY_IN_AN_ORGANIZATION", + "ORGANIZATION_ALREADY_HAS_ALL_FEATURES", + "INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES", + "PAYMENT_INSTRUMENT_REQUIRED", + "ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD", + "ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED" + ] + }, + "HandshakeFilter":{ + "type":"structure", + "members":{ + "ActionType":{ + "shape":"ActionType", + "documentation":"

Specifies the type of handshake action.

If you specify ActionType, you cannot also specify ParentHandshakeId.

" + }, + "ParentHandshakeId":{ + "shape":"HandshakeId", + "documentation":"

Specifies the parent handshake. Only used for handshake types that are a child of another type.

If you specify ParentHandshakeId, you cannot also specify ActionType.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + } + }, + "documentation":"

Specifies the criteria that are used to select the handshakes for the operation.

" + }, + "HandshakeId":{ + "type":"string", + "pattern":"^h-[0-9a-z]{8,32}$" + }, + "HandshakeNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a handshake with the HandshakeId that you specified.

", + "exception":true + }, + "HandshakeNotes":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "HandshakeParties":{ + "type":"list", + "member":{"shape":"HandshakeParty"} + }, + "HandshakeParty":{ + "type":"structure", + "required":[ + "Id", + "Type" + ], + "members":{ + "Id":{ + "shape":"HandshakePartyId", + "documentation":"

The unique identifier (ID) for the party.

The regex pattern for handshake ID string requires \"h-\" followed by from 8 to 32 lower-case letters or digits.

" + }, + "Type":{ + "shape":"HandshakePartyType", + "documentation":"

The type of party.

" + } + }, + "documentation":"

Identifies a participant in a handshake.

" + }, + "HandshakePartyId":{ + "type":"string", + "max":64, + "min":1, + "sensitive":true + }, + "HandshakePartyType":{ + "type":"string", + "enum":[ + "ACCOUNT", + "ORGANIZATION", + "EMAIL" + ] + }, + "HandshakeResource":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"HandshakeResourceValue", + "documentation":"

The information that is passed to the other party in the handshake. The format of the value string must match the requirements of the specified type.

" + }, + "Type":{ + "shape":"HandshakeResourceType", + "documentation":"

The type of information being passed, specifying how the value is to be interpreted by the other party:

  • ACCOUNT - Specifies an AWS account ID number.

  • ORGANIZATION - Specifies an organization ID number.

  • EMAIL - Specifies the email address that is associated with the account that receives the handshake.

  • OWNER_EMAIL - Specifies the email address associated with the master account. Included as information about an organization.

  • OWNER_NAME - Specifies the name associated with the master account. Included as information about an organization.

  • NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.

" + }, + "Resources":{ + "shape":"HandshakeResources", + "documentation":"

When needed, contains an additional array of HandshakeResource objects.

" + } + }, + "documentation":"

Contains additional data that is needed to process a handshake.

" + }, + "HandshakeResourceType":{ + "type":"string", + "enum":[ + "ACCOUNT", + "ORGANIZATION", + "ORGANIZATION_FEATURE_SET", + "EMAIL", + "MASTER_EMAIL", + "MASTER_NAME", + "NOTES", + "PARENT_HANDSHAKE" + ] + }, + "HandshakeResourceValue":{ + "type":"string", + "sensitive":true + }, + "HandshakeResources":{ + "type":"list", + "member":{"shape":"HandshakeResource"} + }, + "HandshakeState":{ + "type":"string", + "enum":[ + "REQUESTED", + "OPEN", + "CANCELED", + "ACCEPTED", + "DECLINED", + "EXPIRED" + ] + }, + "Handshakes":{ + "type":"list", + "member":{"shape":"Handshake"} + }, + "IAMUserAccessToBilling":{ + "type":"string", + "enum":[ + "ALLOW", + "DENY" + ] + }, + "InvalidHandshakeTransitionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You can't perform the operation on the handshake in its current state. For example, you can't cancel a handshake that was already accepted or accept a handshake that was already declined.

", + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "Reason":{"shape":"InvalidInputExceptionReason"} + }, + "documentation":"

The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

  • INPUT_REQUIRED: You must include a value for all required parameters.

  • INVALID_ENUM: You specified an invalid value.

  • INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.

  • INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.

  • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

  • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

  • INVALID_PATTERN: You provided a value that doesn't match the required pattern.

  • INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.

  • INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

  • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

  • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

  • INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

  • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

  • MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

  • MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

  • MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

  • MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

  • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

", + "exception":true + }, + "InvalidInputExceptionReason":{ + "type":"string", + "enum":[ + "INVALID_PARTY_TYPE_TARGET", + "INVALID_SYNTAX_ORGANIZATION_ARN", + "INVALID_SYNTAX_POLICY_ID", + "INVALID_ENUM", + "INVALID_LIST_MEMBER", + "MAX_LENGTH_EXCEEDED", + "MAX_VALUE_EXCEEDED", + "MIN_LENGTH_EXCEEDED", + "MIN_VALUE_EXCEEDED", + "IMMUTABLE_POLICY", + "INVALID_PATTERN", + "INVALID_PATTERN_TARGET_ID", + "INPUT_REQUIRED", + "INVALID_NEXT_TOKEN", + "MAX_LIMIT_EXCEEDED_FILTER", + "MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS", + "INVALID_FULL_NAME_TARGET", + "UNRECOGNIZED_SERVICE_PRINCIPAL", + "INVALID_ROLE_NAME", + "INVALID_SYSTEM_TAGS_PARAMETER" + ] + }, + "InviteAccountToOrganizationRequest":{ + "type":"structure", + "required":["Target"], + "members":{ + "Target":{ + "shape":"HandshakeParty", + "documentation":"

The identifier (ID) of the AWS account that you want to invite to join your organization. This is a JSON object that contains the following elements:

{ \"Type\": \"ACCOUNT\", \"Id\": \"< account id number >\" }

If you use the AWS CLI, you can submit this as a single string, similar to the following example:

--target Id=123456789012,Type=ACCOUNT

If you specify \"Type\": \"ACCOUNT\", you must provide the AWS account ID number as the Id. If you specify \"Type\": \"EMAIL\", you must specify the email address that is associated with the account.

--target Id=diego@example.com,Type=EMAIL

" + }, + "Notes":{ + "shape":"HandshakeNotes", + "documentation":"

Additional information that you want to include in the generated email to the recipient account owner.

" + } + } + }, + "InviteAccountToOrganizationResponse":{ + "type":"structure", + "members":{ + "Handshake":{ + "shape":"Handshake", + "documentation":"

A structure that contains details about the handshake that is created to support this invitation request.

" + } + } + }, + "ListAWSServiceAccessForOrganizationRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListAWSServiceAccessForOrganizationResponse":{ + "type":"structure", + "members":{ + "EnabledServicePrincipals":{ + "shape":"EnabledServicePrincipals", + "documentation":"

A list of the service principals for the services that are enabled to integrate with your organization. Each principal is a structure that includes the name and the date that it was enabled for integration with AWS Organizations.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListAccountsForParentRequest":{ + "type":"structure", + "required":["ParentId"], + "members":{ + "ParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) for the parent root or organization unit (OU) whose accounts you want to list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListAccountsForParentResponse":{ + "type":"structure", + "members":{ + "Accounts":{ + "shape":"Accounts", + "documentation":"

A list of the accounts in the specified root or OU.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListAccountsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListAccountsResponse":{ + "type":"structure", + "members":{ + "Accounts":{ + "shape":"Accounts", + "documentation":"

A list of objects in the organization.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListChildrenRequest":{ + "type":"structure", + "required":[ + "ParentId", + "ChildType" + ], + "members":{ + "ParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) for the parent root or OU whose children you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "ChildType":{ + "shape":"ChildType", + "documentation":"

Filters the output to include only the specified child type.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListChildrenResponse":{ + "type":"structure", + "members":{ + "Children":{ + "shape":"Children", + "documentation":"

The list of children of the specified parent container.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListCreateAccountStatusRequest":{ + "type":"structure", + "members":{ + "States":{ + "shape":"CreateAccountStates", + "documentation":"

A list of one or more states that you want included in the response. If this parameter isn't present, all requests are included in the response.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListCreateAccountStatusResponse":{ + "type":"structure", + "members":{ + "CreateAccountStatuses":{ + "shape":"CreateAccountStatuses", + "documentation":"

A list of objects with details about the requests. Certain elements, such as the accountId number, are present in the output only after the account has been successfully created.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListHandshakesForAccountRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"HandshakeFilter", + "documentation":"

Filters the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE_ALL_FEATURES, or APPROVE_ALL_FEATURES. Alternatively, for the ENABLE_ALL_FEATURES handshake that generates a separate child handshake for each member account, you can specify ParentHandshakeId to see only the handshakes that were generated by that parent request.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListHandshakesForAccountResponse":{ + "type":"structure", + "members":{ + "Handshakes":{ + "shape":"Handshakes", + "documentation":"

A list of Handshake objects with details about each of the handshakes that is associated with the specified account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListHandshakesForOrganizationRequest":{ + "type":"structure", + "members":{ + "Filter":{ + "shape":"HandshakeFilter", + "documentation":"

A filter of the handshakes that you want included in the response. The default is all types. Use the ActionType element to limit the output to only a specified type, such as INVITE, ENABLE-ALL-FEATURES, or APPROVE-ALL-FEATURES. Alternatively, for the ENABLE-ALL-FEATURES handshake that generates a separate child handshake for each member account, you can specify the ParentHandshakeId to see only the handshakes that were generated by that parent request.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListHandshakesForOrganizationResponse":{ + "type":"structure", + "members":{ + "Handshakes":{ + "shape":"Handshakes", + "documentation":"

A list of Handshake objects with details about each of the handshakes that are associated with an organization.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListOrganizationalUnitsForParentRequest":{ + "type":"structure", + "required":["ParentId"], + "members":{ + "ParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) of the root or OU whose child OUs you want to list.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListOrganizationalUnitsForParentResponse":{ + "type":"structure", + "members":{ + "OrganizationalUnits":{ + "shape":"OrganizationalUnits", + "documentation":"

A list of the OUs in the specified root or parent OU.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListParentsRequest":{ + "type":"structure", + "required":["ChildId"], + "members":{ + "ChildId":{ + "shape":"ChildId", + "documentation":"

The unique identifier (ID) of the OU or account whose parent containers you want to list. Don't specify a root.

The regex pattern for a child ID string requires one of the following:

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListParentsResponse":{ + "type":"structure", + "members":{ + "Parents":{ + "shape":"Parents", + "documentation":"

A list of parents for the specified child account or OU.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListPoliciesForTargetRequest":{ + "type":"structure", + "required":[ + "TargetId", + "Filter" + ], + "members":{ + "TargetId":{ + "shape":"PolicyTargetId", + "documentation":"

The unique identifier (ID) of the root, organizational unit, or account whose policies you want to list.

The regex pattern for a target ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Account - A string that consists of exactly 12 digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Filter":{ + "shape":"PolicyType", + "documentation":"

The type of policy that you want to include in the returned list.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListPoliciesForTargetResponse":{ + "type":"structure", + "members":{ + "Policies":{ + "shape":"Policies", + "documentation":"

The list of policies that match the criteria in the request.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListPoliciesRequest":{ + "type":"structure", + "required":["Filter"], + "members":{ + "Filter":{ + "shape":"PolicyType", + "documentation":"

Specifies the type of policy that you want to include in the response.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListPoliciesResponse":{ + "type":"structure", + "members":{ + "Policies":{ + "shape":"Policies", + "documentation":"

A list of policies that match the filter criteria in the request. The output list doesn't include the policy contents. To see the content for a policy, see DescribePolicy.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListRootsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListRootsResponse":{ + "type":"structure", + "members":{ + "Roots":{ + "shape":"Roots", + "documentation":"

A list of roots that are defined in an organization.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"TaggableResourceId", + "documentation":"

The ID of the resource that you want to retrieve tags for.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The tags that are assigned to the resource.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "ListTargetsForPolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy whose attachments you want to know.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

(Optional) Use this to limit the number of results you want included per page in the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Organizations might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

" + } + } + }, + "ListTargetsForPolicyResponse":{ + "type":"structure", + "members":{ + "Targets":{ + "shape":"PolicyTargets", + "documentation":"

A list of structures, each of which contains details about one of the entities to which the specified policy is attached.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

If present, this value indicates that there is more output available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null.

" + } + } + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The provided policy document doesn't meet the requirements of the specified policy type. For example, the syntax might be incorrect. For details about service control policy syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

", + "exception":true + }, + "MasterCannotLeaveOrganizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You can't remove a master account from an organization. If you want the master account to become a member account in another organization, you must first delete the current organization of the master account.

", + "exception":true + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":20, + "min":1 + }, + "MoveAccountRequest":{ + "type":"structure", + "required":[ + "AccountId", + "SourceParentId", + "DestinationParentId" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The unique identifier (ID) of the account that you want to move.

The regex pattern for an account ID string requires exactly 12 digits.

" + }, + "SourceParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) of the root or organizational unit that you want to move the account from.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "DestinationParentId":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) of the root or organizational unit that you want to move the account to.

The regex pattern for a parent ID string requires one of the following:

  • Root - A string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU) - A string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + } + } + }, + "NextToken":{"type":"string"}, + "Organization":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"OrganizationId", + "documentation":"

The unique identifier (ID) of an organization.

The regex pattern for an organization ID string requires \"o-\" followed by from 10 to 32 lower-case letters or digits.

" + }, + "Arn":{ + "shape":"OrganizationArn", + "documentation":"

The Amazon Resource Name (ARN) of an organization.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "FeatureSet":{ + "shape":"OrganizationFeatureSet", + "documentation":"

Specifies the functionality that currently is available to the organization. If set to \"ALL\", then all features are enabled and policies can be applied to accounts in the organization. If set to \"CONSOLIDATED_BILLING\", then only consolidated billing functionality is available. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

" + }, + "MasterAccountArn":{ + "shape":"AccountArn", + "documentation":"

The Amazon Resource Name (ARN) of the account that is designated as the master account for the organization.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "MasterAccountId":{ + "shape":"AccountId", + "documentation":"

The unique identifier (ID) of the master account of an organization.

The regex pattern for an account ID string requires exactly 12 digits.

" + }, + "MasterAccountEmail":{ + "shape":"Email", + "documentation":"

The email address that is associated with the AWS account that is designated as the master account for the organization.

" + }, + "AvailablePolicyTypes":{ + "shape":"PolicyTypes", + "documentation":"

A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.

" + } + }, + "documentation":"

Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

" + }, + "OrganizationArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32}" + }, + "OrganizationFeatureSet":{ + "type":"string", + "enum":[ + "ALL", + "CONSOLIDATED_BILLING" + ] + }, + "OrganizationId":{ + "type":"string", + "pattern":"^o-[a-z0-9]{10,32}$" + }, + "OrganizationNotEmptyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The organization isn't empty. To delete an organization, you must first remove all accounts except the master account, delete all OUs, and delete all policies.

", + "exception":true + }, + "OrganizationalUnit":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"OrganizationalUnitId", + "documentation":"

The unique identifier (ID) associated with this OU.

The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Arn":{ + "shape":"OrganizationalUnitArn", + "documentation":"

The Amazon Resource Name (ARN) of this OU.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Name":{ + "shape":"OrganizationalUnitName", + "documentation":"

The friendly name of this OU.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + } + }, + "documentation":"

Contains details about an organizational unit (OU). An OU is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.

" + }, + "OrganizationalUnitArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}" + }, + "OrganizationalUnitId":{ + "type":"string", + "pattern":"^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" + }, + "OrganizationalUnitName":{ + "type":"string", + "max":128, + "min":1 + }, + "OrganizationalUnitNotEmptyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified OU is not empty. Move all accounts to another root or to other OUs, remove all child OUs, and try the operation again.

", + "exception":true + }, + "OrganizationalUnitNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find an OU with the OrganizationalUnitId that you specified.

", + "exception":true + }, + "OrganizationalUnits":{ + "type":"list", + "member":{"shape":"OrganizationalUnit"} + }, + "Parent":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ParentId", + "documentation":"

The unique identifier (ID) of the parent entity.

The regex pattern for a parent ID string requires one of the following:

  • Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Type":{ + "shape":"ParentType", + "documentation":"

The type of the parent entity.

" + } + }, + "documentation":"

Contains information about either a root or an organizational unit (OU) that can contain OUs or accounts in an organization.

" + }, + "ParentId":{ + "type":"string", + "pattern":"^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" + }, + "ParentNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a root or OU with the ParentId that you specified.

", + "exception":true + }, + "ParentType":{ + "type":"string", + "enum":[ + "ROOT", + "ORGANIZATIONAL_UNIT" + ] + }, + "Parents":{ + "type":"list", + "member":{"shape":"Parent"} + }, + "Policies":{ + "type":"list", + "member":{"shape":"PolicySummary"} + }, + "Policy":{ + "type":"structure", + "members":{ + "PolicySummary":{ + "shape":"PolicySummary", + "documentation":"

A structure that contains additional details about the policy.

" + }, + "Content":{ + "shape":"PolicyContent", + "documentation":"

The text content of the policy.

" + } + }, + "documentation":"

Contains rules to be applied to the affected accounts. Policies can be attached directly to accounts, or to roots and OUs to affect all accounts in those hierarchies.

" + }, + "PolicyArn":{ + "type":"string", + "pattern":"^(arn:aws:organizations::\\d{12}:policy\\/o-[a-z0-9]{10,32}\\/[0-9a-z_]+\\/p-[0-9a-z]{10,32})|(arn:aws:organizations::aws:policy\\/[0-9a-z_]+\\/p-[0-9a-zA-Z_]{10,128})" + }, + "PolicyContent":{ + "type":"string", + "max":1000000, + "min":1 + }, + "PolicyDescription":{ + "type":"string", + "max":512 + }, + "PolicyId":{ + "type":"string", + "pattern":"^p-[0-9a-zA-Z_]{8,128}$" + }, + "PolicyInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The policy is attached to one or more entities. You must detach it from all roots, OUs, and accounts before performing this operation.

", + "exception":true + }, + "PolicyName":{ + "type":"string", + "max":128, + "min":1 + }, + "PolicyNotAttachedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The policy isn't attached to the specified target in the specified root.

", + "exception":true + }, + "PolicyNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a policy with the PolicyId that you specified.

", + "exception":true + }, + "PolicySummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + }, + "Arn":{ + "shape":"PolicyArn", + "documentation":"

The Amazon Resource Name (ARN) of the policy.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Name":{ + "shape":"PolicyName", + "documentation":"

The friendly name of the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

The description of the policy.

" + }, + "Type":{ + "shape":"PolicyType", + "documentation":"

The type of policy.

" + }, + "AwsManaged":{ + "shape":"AwsManagedPolicy", + "documentation":"

A boolean value that indicates whether the specified policy is an AWS managed policy. If true, then you can attach the policy to roots, OUs, or accounts, but you cannot edit it.

" + } + }, + "documentation":"

Contains information about a policy, but does not include the content. To see the content of a policy, see DescribePolicy.

" + }, + "PolicyTargetId":{ + "type":"string", + "pattern":"^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" + }, + "PolicyTargetSummary":{ + "type":"structure", + "members":{ + "TargetId":{ + "shape":"PolicyTargetId", + "documentation":"

The unique identifier (ID) of the policy target.

The regex pattern for a target ID string requires one of the following:

  • Root: a string that begins with \"r-\" followed by from 4 to 32 lower-case letters or digits.

  • Account: a string that consists of exactly 12 digits.

  • Organizational unit (OU): a string that begins with \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that the OU is in) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Arn":{ + "shape":"GenericArn", + "documentation":"

The Amazon Resource Name (ARN) of the policy target.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Name":{ + "shape":"TargetName", + "documentation":"

The friendly name of the policy target.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "Type":{ + "shape":"TargetType", + "documentation":"

The type of the policy target.

" + } + }, + "documentation":"

Contains information about a root, OU, or account that a policy is attached to.

" + }, + "PolicyTargets":{ + "type":"list", + "member":{"shape":"PolicyTargetSummary"} + }, + "PolicyType":{ + "type":"string", + "enum":["SERVICE_CONTROL_POLICY"] + }, + "PolicyTypeAlreadyEnabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified policy type is already enabled in the specified root.

", + "exception":true + }, + "PolicyTypeNotAvailableForOrganizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see Enabling and Disabling a Policy Type on a Root in the AWS Organizations User Guide.

", + "exception":true + }, + "PolicyTypeNotEnabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified policy type isn't currently enabled in this root. You can't attach policies of the specified type to entities in a root until you enable that type in the root. For more information, see Enabling All Features in Your Organization in the AWS Organizations User Guide.

", + "exception":true + }, + "PolicyTypeStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "PENDING_ENABLE", + "PENDING_DISABLE" + ] + }, + "PolicyTypeSummary":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"PolicyType", + "documentation":"

The name of the policy type.

" + }, + "Status":{ + "shape":"PolicyTypeStatus", + "documentation":"

The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

" + } + }, + "documentation":"

Contains information about a policy type and its status in the associated root.

" + }, + "PolicyTypes":{ + "type":"list", + "member":{"shape":"PolicyTypeSummary"} + }, + "RemoveAccountFromOrganizationRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The unique identifier (ID) of the member account that you want to remove from the organization.

The regex pattern for an account ID string requires exactly 12 digits.

" + } + } + }, + "RoleName":{ + "type":"string", + "pattern":"[\\w+=,.@-]{1,64}" + }, + "Root":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"RootId", + "documentation":"

The unique identifier (ID) for the root.

The regex pattern for a root ID string requires \"r-\" followed by from 4 to 32 lower-case letters or digits.

" + }, + "Arn":{ + "shape":"RootArn", + "documentation":"

The Amazon Resource Name (ARN) of the root.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.

" + }, + "Name":{ + "shape":"RootName", + "documentation":"

The friendly name of the root.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "PolicyTypes":{ + "shape":"PolicyTypes", + "documentation":"

The types of policies that are currently enabled for the root and therefore can be attached to the root or to its OUs or accounts.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to see the availability of the policy types in that organization.

" + } + }, + "documentation":"

Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain organizational units (OUs) and accounts. Every root contains every AWS account in the organization. Each root enables the accounts to be organized in a different way and to have different policy types enabled for use in that root.

" + }, + "RootArn":{ + "type":"string", + "pattern":"^arn:aws:organizations::\\d{12}:root\\/o-[a-z0-9]{10,32}\\/r-[0-9a-z]{4,32}" + }, + "RootId":{ + "type":"string", + "pattern":"^r-[0-9a-z]{4,32}$" + }, + "RootName":{ + "type":"string", + "max":128, + "min":1 + }, + "RootNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a root with the RootId that you specified.

", + "exception":true + }, + "Roots":{ + "type":"list", + "member":{"shape":"Root"} + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

AWS Organizations can't complete your request because of an internal service error. Try again later.

", + "exception":true + }, + "ServicePrincipal":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+=,.@-]*" + }, + "SourceParentNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a source root or OU with the ParentId that you specified.

", + "exception":true + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key identifier, or name, of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The string value that's associated with the key of the tag. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

" + } + }, + "documentation":"

A custom key-value pair associated with a resource such as an account within your organization.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"TaggableResourceId", + "documentation":"

The ID of the resource to add a tag to.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tag to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

" + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TaggableResourceId":{ + "type":"string", + "pattern":"^\\d{12}$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TargetName":{ + "type":"string", + "max":128, + "min":1 + }, + "TargetNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

We can't find a root, OU, or account with the TargetId that you specified.

", + "exception":true + }, + "TargetType":{ + "type":"string", + "enum":[ + "ACCOUNT", + "ORGANIZATIONAL_UNIT", + "ROOT" + ] + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Type":{"shape":"ExceptionType"}, + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

", + "exception":true + }, + "UnsupportedAPIEndpointException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

This action isn't available in the current Region.

", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"TaggableResourceId", + "documentation":"

The ID of the resource to remove the tag from.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

The tag to remove from the specified resource.

" + } + } + }, + "UpdateOrganizationalUnitRequest":{ + "type":"structure", + "required":["OrganizationalUnitId"], + "members":{ + "OrganizationalUnitId":{ + "shape":"OrganizationalUnitId", + "documentation":"

The unique identifier (ID) of the OU that you want to rename. You can get the ID from the ListOrganizationalUnitsForParent operation.

The regex pattern for an organizational unit ID string requires \"ou-\" followed by from 4 to 32 lower-case letters or digits (the ID of the root that contains the OU) followed by a second \"-\" dash and from 8 to 32 additional lower-case letters or digits.

" + }, + "Name":{ + "shape":"OrganizationalUnitName", + "documentation":"

The new name that you want to assign to the OU.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + } + } + }, + "UpdateOrganizationalUnitResponse":{ + "type":"structure", + "members":{ + "OrganizationalUnit":{ + "shape":"OrganizationalUnit", + "documentation":"

A structure that contains the details about the specified OU, including its new name.

" + } + } + }, + "UpdatePolicyRequest":{ + "type":"structure", + "required":["PolicyId"], + "members":{ + "PolicyId":{ + "shape":"PolicyId", + "documentation":"

The unique identifier (ID) of the policy that you want to update.

The regex pattern for a policy ID string requires \"p-\" followed by from 8 to 128 lower-case letters or digits.

" + }, + "Name":{ + "shape":"PolicyName", + "documentation":"

If provided, the new name for the policy.

The regex pattern that is used to validate this parameter is a string of any of the characters in the ASCII character range.

" + }, + "Description":{ + "shape":"PolicyDescription", + "documentation":"

If provided, the new description for the policy.

" + }, + "Content":{ + "shape":"PolicyContent", + "documentation":"

If provided, the new content for the policy. The text must be correctly formatted JSON that complies with the syntax for the policy's type. For more information, see Service Control Policy Syntax in the AWS Organizations User Guide.

" + } + } + }, + "UpdatePolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

A structure that contains details about the updated policy, showing the requested changes.

" + } + } + } + }, + "documentation":"AWS Organizations" +} diff --git a/aws/dist/botocore/data/personalize-events/2018-03-22/paginators-1.json b/aws/dist/botocore/data/personalize-events/2018-03-22/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/personalize-events/2018-03-22/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/personalize-events/2018-03-22/service-2.json b/aws/dist/botocore/data/personalize-events/2018-03-22/service-2.json new file mode 100644 index 00000000..5b3518b5 --- /dev/null +++ b/aws/dist/botocore/data/personalize-events/2018-03-22/service-2.json @@ -0,0 +1,117 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-03-22", + "endpointPrefix":"personalize-events", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Personalize Events", + "serviceId":"Personalize Events", + "signatureVersion":"v4", + "signingName":"personalize", + "uid":"personalize-events-2018-03-22" + }, + "operations":{ + "PutEvents":{ + "name":"PutEvents", + "http":{ + "method":"POST", + "requestUri":"/events" + }, + "input":{"shape":"PutEventsRequest"}, + "errors":[ + {"shape":"InvalidInputException"} + ], + "documentation":"

Records user interaction event data.

" + } + }, + "shapes":{ + "Date":{"type":"timestamp"}, + "ErrorMessage":{"type":"string"}, + "Event":{ + "type":"structure", + "required":[ + "eventType", + "properties", + "sentAt" + ], + "members":{ + "eventId":{ + "shape":"StringType", + "documentation":"

An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

" + }, + "eventType":{ + "shape":"StringType", + "documentation":"

The type of event. This property corresponds to the EVENT_TYPE field of the Interactions schema.

" + }, + "properties":{ + "shape":"EventPropertiesJSON", + "documentation":"

A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, you might send the movie ID and rating, and the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{\"itemId\": \"movie1\"}

{\"itemId\": \"movie2\", \"eventValue\": \"4.5\"}

{\"itemId\": \"movie3\", \"eventValue\": \"3\", \"numberOfRatings\": \"12\"}

The keys use camel case names that match the fields in the Interactions schema. The itemId and eventValue keys correspond to the ITEM_ID and EVENT_VALUE fields. In the above example, the eventType might be 'MovieRating' with eventValue being the rating. The numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

", + "jsonvalue":true + }, + "sentAt":{ + "shape":"Date", + "documentation":"

The timestamp on the client side when the event occurred.

" + } + }, + "documentation":"

Represents user interaction event information sent using the PutEvents API.

" + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"}, + "max":10, + "min":1 + }, + "EventPropertiesJSON":{ + "type":"string", + "max":1024, + "min":1 + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Provide a valid value for the field or parameter.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "PutEventsRequest":{ + "type":"structure", + "required":[ + "trackingId", + "sessionId", + "eventList" + ], + "members":{ + "trackingId":{ + "shape":"StringType", + "documentation":"

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

" + }, + "userId":{ + "shape":"UserId", + "documentation":"

The user associated with the event.

" + }, + "sessionId":{ + "shape":"StringType", + "documentation":"

The session ID associated with the user's visit.

" + }, + "eventList":{ + "shape":"EventList", + "documentation":"

A list of event data from the session.

" + } + } + }, + "StringType":{ + "type":"string", + "max":256, + "min":1 + }, + "UserId":{ + "type":"string", + "max":256, + "min":1 + } + }, + "documentation":"

" +} diff --git a/aws/dist/botocore/data/personalize-runtime/2018-05-22/paginators-1.json b/aws/dist/botocore/data/personalize-runtime/2018-05-22/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/personalize-runtime/2018-05-22/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/personalize-runtime/2018-05-22/service-2.json b/aws/dist/botocore/data/personalize-runtime/2018-05-22/service-2.json new file mode 100644 index 00000000..3c29c4a2 --- /dev/null +++ b/aws/dist/botocore/data/personalize-runtime/2018-05-22/service-2.json @@ -0,0 +1,165 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-22", + "endpointPrefix":"personalize-runtime", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Personalize Runtime", + "serviceId":"Personalize Runtime", + "signatureVersion":"v4", + "signingName":"personalize", + "uid":"personalize-runtime-2018-05-22" + }, + "operations":{ + "GetPersonalizedRanking":{ + "name":"GetPersonalizedRanking", + "http":{ + "method":"POST", + "requestUri":"/personalize-ranking" + }, + "input":{"shape":"GetPersonalizedRankingRequest"}, + "output":{"shape":"GetPersonalizedRankingResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Re-ranks a list of recommended items for the given user. The first item in the list is deemed the most likely item to be of interest to the user.

The solution backing the campaign must have been created using a recipe of type PERSONALIZED_RANKING.

", + "idempotent":true + }, + "GetRecommendations":{ + "name":"GetRecommendations", + "http":{ + "method":"POST", + "requestUri":"/recommendations" + }, + "input":{"shape":"GetRecommendationsRequest"}, + "output":{"shape":"GetRecommendationsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of recommended items. The required input depends on the recipe type used to create the solution backing the campaign, as follows:

  • RELATED_ITEMS - itemId required, userId not used

  • USER_PERSONALIZATION - itemId optional, userId required

Campaigns that are backed by a solution created using a recipe of type PERSONALIZED_RANKING use the API.

", + "idempotent":true + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":256, + "pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+" + }, + "ErrorMessage":{"type":"string"}, + "GetPersonalizedRankingRequest":{ + "type":"structure", + "required":[ + "campaignArn", + "inputList", + "userId" + ], + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign to use for generating the personalized ranking.

" + }, + "inputList":{ + "shape":"InputList", + "documentation":"

A list of items (itemId's) to rank. If an item was not included in the training dataset, the item is appended to the end of the reranked list.

" + }, + "userId":{ + "shape":"UserID", + "documentation":"

The user for which you want the campaign to provide a personalized ranking.

" + } + } + }, + "GetPersonalizedRankingResponse":{ + "type":"structure", + "members":{ + "personalizedRanking":{ + "shape":"ItemList", + "documentation":"

A list of items in order of most likely interest to the user.

" + } + } + }, + "GetRecommendationsRequest":{ + "type":"structure", + "required":["campaignArn"], + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

" + }, + "itemId":{ + "shape":"ItemID", + "documentation":"

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

" + }, + "userId":{ + "shape":"UserID", + "documentation":"

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.

" + }, + "numResults":{ + "shape":"NumResults", + "documentation":"

The number of results to return. The default is 25. The maximum is 100.

" + } + } + }, + "GetRecommendationsResponse":{ + "type":"structure", + "members":{ + "itemList":{ + "shape":"ItemList", + "documentation":"

A list of recommendations.

" + } + } + }, + "InputList":{ + "type":"list", + "member":{"shape":"ItemID"} + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Provide a valid value for the field or parameter.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ItemID":{ + "type":"string", + "max":256 + }, + "ItemList":{ + "type":"list", + "member":{"shape":"PredictedItem"} + }, + "NumResults":{ + "type":"integer", + "min":0 + }, + "PredictedItem":{ + "type":"structure", + "members":{ + "itemId":{ + "shape":"ItemID", + "documentation":"

The recommended item ID.

" + } + }, + "documentation":"

An object that identifies an item.

The and APIs return a list of PredictedItems.

" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource does not exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "UserID":{ + "type":"string", + "max":256 + } + }, + "documentation":"

" +} diff --git a/aws/dist/botocore/data/personalize/2018-05-22/paginators-1.json b/aws/dist/botocore/data/personalize/2018-05-22/paginators-1.json new file mode 100644 index 00000000..ecbdbd5f --- /dev/null +++ b/aws/dist/botocore/data/personalize/2018-05-22/paginators-1.json @@ -0,0 +1,58 @@ +{ + "pagination": { + "ListCampaigns": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "campaigns" + }, + "ListDatasetGroups": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datasetGroups" + }, + "ListDatasetImportJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datasetImportJobs" + }, + "ListDatasets": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "datasets" + }, + "ListEventTrackers": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "eventTrackers" + }, + "ListRecipes": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "recipes" + }, + "ListSchemas": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "schemas" + }, + "ListSolutionVersions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "solutionVersions" + }, + "ListSolutions": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "solutions" + } + } +} diff --git a/aws/dist/botocore/data/personalize/2018-05-22/service-2.json b/aws/dist/botocore/data/personalize/2018-05-22/service-2.json new file mode 100644 index 00000000..6a3211b2 --- /dev/null +++ b/aws/dist/botocore/data/personalize/2018-05-22/service-2.json @@ -0,0 +1,2722 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-05-22", + "endpointPrefix":"personalize", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Personalize", + "serviceId":"Personalize", + "signatureVersion":"v4", + "signingName":"personalize", + "targetPrefix":"AmazonPersonalize", + "uid":"personalize-2018-05-22" + }, + "operations":{ + "CreateCampaign":{ + "name":"CreateCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCampaignRequest"}, + "output":{"shape":"CreateCampaignResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates a campaign by deploying a solution version. When a client calls the GetRecommendations and GetPersonalizedRanking APIs, a campaign is specified in the request.

Minimum Provisioned TPS and Auto-Scaling

A transaction is a single GetRecommendations or GetPersonalizedRanking call. Transactions per second (TPS) is the throughput and unit of billing for Amazon Personalize. The minimum provisioned TPS (minProvisionedTPS) specifies the baseline throughput provisioned by Amazon Personalize, and thus, the minimum billing charge. If your TPS increases beyond minProvisionedTPS, Amazon Personalize auto-scales the provisioned capacity up and down, but never below minProvisionedTPS, to maintain a 70% utilization. There's a short time delay while the capacity is increased that might cause loss of transactions. It's recommended to start with a low minProvisionedTPS, track your usage using Amazon CloudWatch metrics, and then increase the minProvisionedTPS as necessary.

Status

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the campaign status, call DescribeCampaign.

Wait until the status of the campaign is ACTIVE before asking the campaign for recommendations.

Related APIs

", + "idempotent":true + }, + "CreateDataset":{ + "name":"CreateDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetRequest"}, + "output":{"shape":"CreateDatasetResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates an empty dataset and adds it to the specified dataset group. Use CreateDatasetImportJob to import your training data to a dataset.

There are three types of datasets:

  • Interactions

  • Items

  • Users

Each dataset type has an associated schema with required field types. Only the Interactions dataset is required in order to train a model (also referred to as creating a solution).

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the dataset, call DescribeDataset.

Related APIs

", + "idempotent":true + }, + "CreateDatasetGroup":{ + "name":"CreateDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetGroupRequest"}, + "output":{"shape":"CreateDatasetGroupResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an empty dataset group. A dataset group contains related datasets that supply data for training a model. A dataset group can contain at most three datasets, one for each type of dataset:

  • Interactions

  • Items

  • Users

To train a model (create a solution), a dataset group that contains an Interactions dataset is required. Call CreateDataset to add a dataset to the group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

To get the status of the dataset group, call DescribeDatasetGroup. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the creation failed.

You must wait until the status of the dataset group is ACTIVE before adding a dataset to the group.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group. If you specify a KMS key, you must also include an AWS Identity and Access Management (IAM) role that has permission to access the key.

APIs that require a dataset group ARN in the request

Related APIs

" + }, + "CreateDatasetImportJob":{ + "name":"CreateDatasetImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDatasetImportJobRequest"}, + "output":{"shape":"CreateDatasetImportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates a job that imports training data from your data source (an Amazon S3 bucket) to an Amazon Personalize dataset. To allow Amazon Personalize to import the training data, you must specify an AWS Identity and Access Management (IAM) role that has permission to read from the data source.

The dataset import job replaces any previous data in the dataset.

Status

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the import job, call DescribeDatasetImportJob, providing the Amazon Resource Name (ARN) of the dataset import job. The dataset import is complete when the status shows as ACTIVE. If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Importing takes time. You must wait until the status shows as ACTIVE before training a model using the dataset.

Related APIs

" + }, + "CreateEventTracker":{ + "name":"CreateEventTracker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventTrackerRequest"}, + "output":{"shape":"CreateEventTrackerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates an event tracker that you use when sending event data to the specified dataset group using the PutEvents API.

When Amazon Personalize creates an event tracker, it also creates an event-interactions dataset in the dataset group associated with the event tracker. The event-interactions dataset stores the event data from the PutEvents call. The contents of this dataset are not available to the user.

Only one event tracker can be associated with a dataset group. You will get an error if you call CreateEventTracker using the same dataset group as an existing event tracker.

When you send event data you include your tracking ID. The tracking ID identifies the customer and authorizes the customer to send the data.

The event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the event tracker, call DescribeEventTracker.

The event tracker must be in the ACTIVE state before using the tracking ID.

Related APIs

", + "idempotent":true + }, + "CreateSchema":{ + "name":"CreateSchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSchemaRequest"}, + "output":{"shape":"CreateSchemaResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. You specify a schema when you call CreateDataset.

Related APIs

", + "idempotent":true + }, + "CreateSolution":{ + "name":"CreateSolution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSolutionRequest"}, + "output":{"shape":"CreateSolutionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Creates the configuration for training a model. A trained model is known as a solution. After the configuration is created, you train the model (create a solution) by calling the CreateSolutionVersion operation. Every time you call CreateSolutionVersion, a new version of the solution is created.

After creating a solution version, you check its accuracy by calling GetSolutionMetrics. When you are satisfied with the version, you deploy it using CreateCampaign. The campaign provides recommendations to a client through the GetRecommendations API.

To train a model, Amazon Personalize requires training data and a recipe. The training data comes from the dataset group that you provide in the request. A recipe specifies the training algorithm and a feature transformation. You can specify one of the predefined recipes provided by Amazon Personalize. Alternatively, you can specify performAutoML and Amazon Personalize will analyze your data and select the optimum USER_PERSONALIZATION recipe for you.

Status

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

To get the status of the solution, call DescribeSolution. Wait until the status shows as ACTIVE before calling CreateSolutionVersion.

Related APIs

" + }, + "CreateSolutionVersion":{ + "name":"CreateSolutionVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSolutionVersionRequest"}, + "output":{"shape":"CreateSolutionVersionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Trains or retrains an active solution. A solution is created using the CreateSolution operation and must be in the ACTIVE state before calling CreateSolutionVersion. A new version of the solution is created every time you call this operation.

Status

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

To get the status of the version, call DescribeSolutionVersion. Wait until the status shows as ACTIVE before calling CreateCampaign.

If the status shows as CREATE FAILED, the response includes a failureReason key, which describes why the job failed.

Related APIs

" + }, + "DeleteCampaign":{ + "name":"DeleteCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCampaignRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Removes a campaign by deleting the solution deployment. The solution that the campaign is based on is not deleted and can be redeployed when needed. A deleted campaign can no longer be specified in a GetRecommendations request. For more information on campaigns, see CreateCampaign.

", + "idempotent":true + }, + "DeleteDataset":{ + "name":"DeleteDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatasetRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a dataset. You can't delete a dataset if an associated DatasetImportJob or SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on datasets, see CreateDataset.

", + "idempotent":true + }, + "DeleteDatasetGroup":{ + "name":"DeleteDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDatasetGroupRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a dataset group. Before you delete a dataset group, you must delete the following:

  • All associated event trackers.

  • All associated solutions.

  • All datasets in the dataset group.

", + "idempotent":true + }, + "DeleteEventTracker":{ + "name":"DeleteEventTracker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventTrackerRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes the event tracker. Does not delete the event-interactions dataset from the associated dataset group. For more information on event trackers, see CreateEventTracker.

", + "idempotent":true + }, + "DeleteSchema":{ + "name":"DeleteSchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSchemaRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes a schema. Before deleting a schema, you must delete all datasets referencing the schema. For more information on schemas, see CreateSchema.

", + "idempotent":true + }, + "DeleteSolution":{ + "name":"DeleteSolution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSolutionRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Deletes all versions of a solution and the Solution object itself. Before deleting a solution, you must delete all campaigns based on the solution. To determine what campaigns are using the solution, call ListCampaigns and supply the Amazon Resource Name (ARN) of the solution. You can't delete a solution if an associated SolutionVersion is in the CREATE PENDING or IN PROGRESS state. For more information on solutions, see CreateSolution.

", + "idempotent":true + }, + "DescribeAlgorithm":{ + "name":"DescribeAlgorithm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlgorithmRequest"}, + "output":{"shape":"DescribeAlgorithmResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the given algorithm.

", + "idempotent":true + }, + "DescribeCampaign":{ + "name":"DescribeCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCampaignRequest"}, + "output":{"shape":"DescribeCampaignResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the given campaign, including its status.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

For more information on campaigns, see CreateCampaign.

", + "idempotent":true + }, + "DescribeDataset":{ + "name":"DescribeDataset", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetRequest"}, + "output":{"shape":"DescribeDatasetResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the given dataset. For more information on datasets, see CreateDataset.

", + "idempotent":true + }, + "DescribeDatasetGroup":{ + "name":"DescribeDatasetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetGroupRequest"}, + "output":{"shape":"DescribeDatasetGroupResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the given dataset group. For more information on dataset groups, see CreateDatasetGroup.

", + "idempotent":true + }, + "DescribeDatasetImportJob":{ + "name":"DescribeDatasetImportJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDatasetImportJobRequest"}, + "output":{"shape":"DescribeDatasetImportJobResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the dataset import job created by CreateDatasetImportJob, including the import job status.

", + "idempotent":true + }, + "DescribeEventTracker":{ + "name":"DescribeEventTracker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventTrackerRequest"}, + "output":{"shape":"DescribeEventTrackerResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes an event tracker. The response includes the trackingId and status of the event tracker. For more information on event trackers, see CreateEventTracker.

", + "idempotent":true + }, + "DescribeFeatureTransformation":{ + "name":"DescribeFeatureTransformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFeatureTransformationRequest"}, + "output":{"shape":"DescribeFeatureTransformationResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes the given feature transformation.

", + "idempotent":true + }, + "DescribeRecipe":{ + "name":"DescribeRecipe", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRecipeRequest"}, + "output":{"shape":"DescribeRecipeResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a recipe.

A recipe contains three items:

  • An algorithm that trains a model.

  • Hyperparameters that govern the training.

  • Feature transformation information for modifying the input data before training.

Amazon Personalize provides a set of predefined recipes. You specify a recipe when you create a solution with the CreateSolution API. CreateSolution trains a model by using the algorithm in the specified recipe and a training dataset. The solution, when deployed as a campaign, can provide recommendations using the GetRecommendations API.

", + "idempotent":true + }, + "DescribeSchema":{ + "name":"DescribeSchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSchemaRequest"}, + "output":{"shape":"DescribeSchemaResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a schema. For more information on schemas, see CreateSchema.

", + "idempotent":true + }, + "DescribeSolution":{ + "name":"DescribeSolution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSolutionRequest"}, + "output":{"shape":"DescribeSolutionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a solution. For more information on solutions, see CreateSolution.

", + "idempotent":true + }, + "DescribeSolutionVersion":{ + "name":"DescribeSolutionVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSolutionVersionRequest"}, + "output":{"shape":"DescribeSolutionVersionResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Describes a specific version of a solution. For more information on solutions, see CreateSolution.

", + "idempotent":true + }, + "GetSolutionMetrics":{ + "name":"GetSolutionMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSolutionMetricsRequest"}, + "output":{"shape":"GetSolutionMetricsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Gets the metrics for the specified solution version.

" + }, + "ListCampaigns":{ + "name":"ListCampaigns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCampaignsRequest"}, + "output":{"shape":"ListCampaignsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of campaigns that use the given solution. When a solution is not specified, all the campaigns associated with the account are listed. The response provides the properties for each campaign, including the Amazon Resource Name (ARN). For more information on campaigns, see CreateCampaign.

", + "idempotent":true + }, + "ListDatasetGroups":{ + "name":"ListDatasetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetGroupsRequest"}, + "output":{"shape":"ListDatasetGroupsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of dataset groups. The response provides the properties for each dataset group, including the Amazon Resource Name (ARN). For more information on dataset groups, see CreateDatasetGroup.

", + "idempotent":true + }, + "ListDatasetImportJobs":{ + "name":"ListDatasetImportJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetImportJobsRequest"}, + "output":{"shape":"ListDatasetImportJobsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of dataset import jobs that use the given dataset. When a dataset is not specified, all the dataset import jobs associated with the account are listed. The response provides the properties for each dataset import job, including the Amazon Resource Name (ARN). For more information on dataset import jobs, see CreateDatasetImportJob. For more information on datasets, see CreateDataset.

", + "idempotent":true + }, + "ListDatasets":{ + "name":"ListDatasets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDatasetsRequest"}, + "output":{"shape":"ListDatasetsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns the list of datasets contained in the given dataset group. The response provides the properties for each dataset, including the Amazon Resource Name (ARN). For more information on datasets, see CreateDataset.

", + "idempotent":true + }, + "ListEventTrackers":{ + "name":"ListEventTrackers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEventTrackersRequest"}, + "output":{"shape":"ListEventTrackersResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns the list of event trackers associated with the account. The response provides the properties for each event tracker, including the Amazon Resource Name (ARN) and tracking ID. For more information on event trackers, see CreateEventTracker.

", + "idempotent":true + }, + "ListRecipes":{ + "name":"ListRecipes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecipesRequest"}, + "output":{"shape":"ListRecipesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of available recipes. The response provides the properties for each recipe, including the recipe's Amazon Resource Name (ARN).

", + "idempotent":true + }, + "ListSchemas":{ + "name":"ListSchemas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSchemasRequest"}, + "output":{"shape":"ListSchemasResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns the list of schemas associated with the account. The response provides the properties for each schema, including the Amazon Resource Name (ARN). For more information on schemas, see CreateSchema.

", + "idempotent":true + }, + "ListSolutionVersions":{ + "name":"ListSolutionVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSolutionVersionsRequest"}, + "output":{"shape":"ListSolutionVersionsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of solution versions for the given solution. When a solution is not specified, all the solution versions associated with the account are listed. The response provides the properties for each solution version, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

", + "idempotent":true + }, + "ListSolutions":{ + "name":"ListSolutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSolutionsRequest"}, + "output":{"shape":"ListSolutionsResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

Returns a list of solutions that use the given dataset group. When a dataset group is not specified, all the solutions associated with the account are listed. The response provides the properties for each solution, including the Amazon Resource Name (ARN). For more information on solutions, see CreateSolution.

", + "idempotent":true + }, + "UpdateCampaign":{ + "name":"UpdateCampaign", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCampaignRequest"}, + "output":{"shape":"UpdateCampaignResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

Updates a campaign by either deploying a new solution or changing the value of the campaign's minProvisionedTPS parameter.

To update a campaign, the campaign status must be ACTIVE or CREATE FAILED. Check the campaign status using the DescribeCampaign API.

You must wait until the status of the updated campaign is ACTIVE before asking the campaign for recommendations.

For more information on campaigns, see CreateCampaign.

", + "idempotent":true + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "max":256 + }, + "Algorithm":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the algorithm.

" + }, + "algorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm.

" + }, + "algorithmImage":{ + "shape":"AlgorithmImage", + "documentation":"

The URI of the Docker container for the algorithm image.

" + }, + "defaultHyperParameters":{ + "shape":"HyperParameters", + "documentation":"

Specifies the default hyperparameters.

" + }, + "defaultHyperParameterRanges":{ + "shape":"DefaultHyperParameterRanges", + "documentation":"

Specifies the default hyperparameters, their ranges, and whether they are tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

" + }, + "defaultResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

Specifies the default maximum number of training jobs and parallel training jobs.

" + }, + "trainingInputMode":{ + "shape":"TrainingInputMode", + "documentation":"

The training input mode.

" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the role.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the algorithm was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the algorithm was last updated.

" + } + }, + "documentation":"

Describes a custom algorithm.

" + }, + "AlgorithmImage":{ + "type":"structure", + "required":["dockerURI"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the algorithm image.

" + }, + "dockerURI":{ + "shape":"DockerURI", + "documentation":"

The URI of the Docker container for the algorithm image.

" + } + }, + "documentation":"

Describes an algorithm image.

" + }, + "Arn":{ + "type":"string", + "max":256, + "pattern":"arn:([a-z\\d-]+):personalize:.*:.*:.+" + }, + "ArnList":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":100 + }, + "AutoMLConfig":{ + "type":"structure", + "members":{ + "metricName":{ + "shape":"MetricName", + "documentation":"

The metric to optimize.

" + }, + "recipeList":{ + "shape":"ArnList", + "documentation":"

The list of candidate recipes.

" + } + }, + "documentation":"

When the solution performs AutoML (performAutoML is true in CreateSolution), Amazon Personalize determines which recipe, from the specified list, optimizes the given metric. Amazon Personalize then uses that recipe for the solution.

" + }, + "AutoMLResult":{ + "type":"structure", + "members":{ + "bestRecipeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the best recipe.

" + } + }, + "documentation":"

When the solution performs AutoML (performAutoML is true in CreateSolution), specifies the recipe that best optimized the specified metric.

" + }, + "AvroSchema":{ + "type":"string", + "max":10000 + }, + "Boolean":{"type":"boolean"}, + "Campaign":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the campaign.

" + }, + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign.

" + }, + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of a specific version of the solution.

" + }, + "minProvisionedTPS":{ + "shape":"TransactionsPerSecond", + "documentation":"

Specifies the requested minimum provisioned transactions (recommendations) per second.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a campaign fails, the reason behind the failure.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix format) that the campaign was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix format) that the campaign was last updated.

" + }, + "latestCampaignUpdate":{"shape":"CampaignUpdateSummary"} + }, + "documentation":"

Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

" + }, + "CampaignSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the campaign.

" + }, + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the campaign.

A campaign can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the campaign was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the campaign was last updated.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a campaign fails, the reason behind the failure.

" + } + }, + "documentation":"

Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

" + }, + "CampaignUpdateSummary":{ + "type":"structure", + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the deployed solution version.

" + }, + "minProvisionedTPS":{ + "shape":"TransactionsPerSecond", + "documentation":"

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the campaign update.

A campaign update can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a campaign update fails, the reason behind the failure.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the campaign update was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the campaign update was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of a campaign update. For a complete listing, call the DescribeCampaign API.

" + }, + "Campaigns":{ + "type":"list", + "member":{"shape":"CampaignSummary"}, + "max":100 + }, + "CategoricalHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "values":{ + "shape":"CategoricalValues", + "documentation":"

A list of the categories for the hyperparameter.

" + } + }, + "documentation":"

Provides the name and range of a categorical hyperparameter.

" + }, + "CategoricalHyperParameterRanges":{ + "type":"list", + "member":{"shape":"CategoricalHyperParameterRange"}, + "max":100 + }, + "CategoricalValue":{ + "type":"string", + "max":1000 + }, + "CategoricalValues":{ + "type":"list", + "member":{"shape":"CategoricalValue"}, + "max":100 + }, + "ContinuousHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "minValue":{ + "shape":"ContinuousMinValue", + "documentation":"

The minimum allowable value for the hyperparameter.

" + }, + "maxValue":{ + "shape":"ContinuousMaxValue", + "documentation":"

The maximum allowable value for the hyperparameter.

" + } + }, + "documentation":"

Provides the name and range of a continuous hyperparameter.

" + }, + "ContinuousHyperParameterRanges":{ + "type":"list", + "member":{"shape":"ContinuousHyperParameterRange"}, + "max":100 + }, + "ContinuousMaxValue":{ + "type":"double", + "min":-1000000 + }, + "ContinuousMinValue":{ + "type":"double", + "min":-1000000 + }, + "CreateCampaignRequest":{ + "type":"structure", + "required":[ + "name", + "solutionVersionArn", + "minProvisionedTPS" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

A name for the new campaign. The campaign name must be unique within your account.

" + }, + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution version to deploy.

" + }, + "minProvisionedTPS":{ + "shape":"TransactionsPerSecond", + "documentation":"

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

" + } + } + }, + "CreateCampaignResponse":{ + "type":"structure", + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign.

" + } + } + }, + "CreateDatasetGroupRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name for the new dataset group.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that has permissions to access the KMS key. Supplying an IAM role is only valid when also specifying a KMS key.

" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of a KMS key used to encrypt the datasets.

" + } + } + }, + "CreateDatasetGroupResponse":{ + "type":"structure", + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the new dataset group.

" + } + } + }, + "CreateDatasetImportJobRequest":{ + "type":"structure", + "required":[ + "jobName", + "datasetArn", + "dataSource", + "roleArn" + ], + "members":{ + "jobName":{ + "shape":"Name", + "documentation":"

The name for the dataset import job.

" + }, + "datasetArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset that receives the imported data.

" + }, + "dataSource":{ + "shape":"DataSource", + "documentation":"

The Amazon S3 bucket that contains the training data to import.

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that has permissions to read from the Amazon S3 data source.

" + } + } + }, + "CreateDatasetImportJobResponse":{ + "type":"structure", + "members":{ + "datasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset import job.

" + } + } + }, + "CreateDatasetRequest":{ + "type":"structure", + "required":[ + "name", + "schemaArn", + "datasetGroupArn", + "datasetType" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name for the dataset.

" + }, + "schemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the schema to associate with the dataset. The schema defines the dataset fields.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group to add the dataset to.

" + }, + "datasetType":{ + "shape":"DatasetType", + "documentation":"

The type of dataset.

One of the following (case insensitive) values:

  • Interactions

  • Items

  • Users

" + } + } + }, + "CreateDatasetResponse":{ + "type":"structure", + "members":{ + "datasetArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset.

" + } + } + }, + "CreateEventTrackerRequest":{ + "type":"structure", + "required":[ + "name", + "datasetGroupArn" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name for the event tracker.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

" + } + } + }, + "CreateEventTrackerResponse":{ + "type":"structure", + "members":{ + "eventTrackerArn":{ + "shape":"Arn", + "documentation":"

The ARN of the event tracker.

" + }, + "trackingId":{ + "shape":"TrackingId", + "documentation":"

The ID of the event tracker. Include this ID in requests to the PutEvents API.

" + } + } + }, + "CreateSchemaRequest":{ + "type":"structure", + "required":[ + "name", + "schema" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name for the schema.

" + }, + "schema":{ + "shape":"AvroSchema", + "documentation":"

A schema in Avro JSON format.

" + } + } + }, + "CreateSchemaResponse":{ + "type":"structure", + "members":{ + "schemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the created schema.

" + } + } + }, + "CreateSolutionRequest":{ + "type":"structure", + "required":[ + "name", + "datasetGroupArn" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name for the solution.

" + }, + "performHPO":{ + "shape":"Boolean", + "documentation":"

Whether to perform hyperparameter optimization (HPO) on the specified or selected recipe. The default is false.

When performing AutoML, this parameter is always true and you should not set it to false.

" + }, + "performAutoML":{ + "shape":"PerformAutoML", + "documentation":"

Whether to perform automated machine learning (AutoML). The default is false. For this case, you must specify recipeArn.

When set to true, Amazon Personalize analyzes your training data and selects the optimal USER_PERSONALIZATION recipe and hyperparameters. In this case, you must omit recipeArn. Amazon Personalize determines the optimal recipe by running tests with different values for the hyperparameters. AutoML lengthens the training process as compared to selecting a specific recipe.

" + }, + "recipeArn":{ + "shape":"Arn", + "documentation":"

The ARN of the recipe to use for model training. Only specified when performAutoML is false.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

" + }, + "eventType":{ + "shape":"EventType", + "documentation":"

When your have multiple event types (using an EVENT_TYPE schema field), this parameter specifies which event type (for example, 'click' or 'like') is used for training the model.

" + }, + "solutionConfig":{ + "shape":"SolutionConfig", + "documentation":"

The configuration to use with the solution. When performAutoML is set to true, Amazon Personalize only evaluates the autoMLConfig section of the solution configuration.

" + } + } + }, + "CreateSolutionResponse":{ + "type":"structure", + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the solution.

" + } + } + }, + "CreateSolutionVersionRequest":{ + "type":"structure", + "required":["solutionArn"], + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution containing the training configuration information.

" + }, + "trainingMode":{ + "shape":"TrainingMode", + "documentation":"

The scope of training to be performed when creating the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the data that has changed in comparison to the input solution. Choose UPDATE when you want to incrementally update your solution version instead of creating an entirely new one.

The UPDATE option can only be used when you already have an active solution version created from the input solution using the FULL option and the input solution was trained with the native-recipe-hrnn-coldstart recipe.

" + } + } + }, + "CreateSolutionVersionResponse":{ + "type":"structure", + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the new solution version.

" + } + } + }, + "DataSource":{ + "type":"structure", + "members":{ + "dataLocation":{ + "shape":"S3Location", + "documentation":"

The path to the Amazon S3 bucket where the data that you want to upload to your dataset is stored. For example:

s3://bucket-name/training-data.csv

" + } + }, + "documentation":"

Describes the data source that contains the data to upload to a dataset.

" + }, + "Dataset":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the dataset.

" + }, + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset that you want metadata for.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "datasetType":{ + "shape":"DatasetType", + "documentation":"

One of the following values:

  • Interactions

  • Items

  • Users

" + }, + "schemaArn":{ + "shape":"Arn", + "documentation":"

The ARN of the associated schema.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time (in Unix time) of the dataset.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

A time stamp that shows when the dataset was updated.

" + } + }, + "documentation":"

Provides metadata for a dataset.

" + }, + "DatasetGroup":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the dataset group.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The current status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

" + }, + "roleArn":{ + "shape":"RoleArn", + "documentation":"

The ARN of the IAM role that has permissions to create the dataset group.

" + }, + "kmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the KMS key used to encrypt the datasets.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time (in Unix time) of the dataset group.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The last update date and time (in Unix time) of the dataset group.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If creating a dataset group fails, provides the reason why.

" + } + }, + "documentation":"

A dataset group is a collection of related datasets (Interactions, User, and Item). You create a dataset group by calling CreateDatasetGroup. You then create a dataset and add it to a dataset group by calling CreateDataset. The dataset group is used to create and train a solution by calling CreateSolution. A dataset group can contain only one of each type of dataset.

You can specify an AWS Key Management Service (KMS) key to encrypt the datasets in the group.

" + }, + "DatasetGroupSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the dataset group.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the dataset group.

A dataset group can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset group was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset group was last updated.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If creating a dataset group fails, the reason behind the failure.

" + } + }, + "documentation":"

Provides a summary of the properties of a dataset group. For a complete listing, call the DescribeDatasetGroup API.

" + }, + "DatasetGroups":{ + "type":"list", + "member":{"shape":"DatasetGroupSummary"}, + "max":100 + }, + "DatasetImportJob":{ + "type":"structure", + "members":{ + "jobName":{ + "shape":"Name", + "documentation":"

The name of the import job.

" + }, + "datasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset import job.

" + }, + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset that receives the imported data.

" + }, + "dataSource":{ + "shape":"DataSource", + "documentation":"

The Amazon S3 bucket that contains the training data to import.

" + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

The ARN of the AWS Identity and Access Management (IAM) role that has permissions to read from the Amazon S3 data source.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time (in Unix time) of the dataset import job.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) the dataset was last updated.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a dataset import job fails, provides the reason why.

" + } + }, + "documentation":"

Describes a job that imports training data from a data source (Amazon S3 bucket) to an Amazon Personalize dataset. For more information, see CreateDatasetImportJob.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

" + }, + "DatasetImportJobSummary":{ + "type":"structure", + "members":{ + "datasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job.

" + }, + "jobName":{ + "shape":"Name", + "documentation":"

The name of the dataset import job.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the dataset import job.

A dataset import job can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset import job was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset was last updated.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a dataset import job fails, the reason behind the failure.

" + } + }, + "documentation":"

Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

" + }, + "DatasetImportJobs":{ + "type":"list", + "member":{"shape":"DatasetImportJobSummary"}, + "max":100 + }, + "DatasetSchema":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the schema.

" + }, + "schemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema.

" + }, + "schema":{ + "shape":"AvroSchema", + "documentation":"

The schema.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the schema was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the schema was last updated.

" + } + }, + "documentation":"

Describes the schema for a dataset. For more information on schemas, see CreateSchema.

" + }, + "DatasetSchemaSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the schema.

" + }, + "schemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the schema was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the schema was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of a dataset schema. For a complete listing, call the DescribeSchema API.

" + }, + "DatasetSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the dataset.

" + }, + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset.

" + }, + "datasetType":{ + "shape":"DatasetType", + "documentation":"

The dataset type. One of the following values:

  • Interactions

  • Items

  • Users

  • Event-Interactions

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the dataset.

A dataset can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the dataset was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

" + }, + "DatasetType":{ + "type":"string", + "max":256 + }, + "Datasets":{ + "type":"list", + "member":{"shape":"DatasetSummary"}, + "max":100 + }, + "Date":{"type":"timestamp"}, + "DefaultCategoricalHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "values":{ + "shape":"CategoricalValues", + "documentation":"

A list of the categories for the hyperparameter.

" + }, + "isTunable":{ + "shape":"Tunable", + "documentation":"

Whether the hyperparameter is tunable.

" + } + }, + "documentation":"

Provides the name and default range of a categorical hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

" + }, + "DefaultCategoricalHyperParameterRanges":{ + "type":"list", + "member":{"shape":"DefaultCategoricalHyperParameterRange"}, + "max":100 + }, + "DefaultContinuousHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "minValue":{ + "shape":"ContinuousMinValue", + "documentation":"

The minimum allowable value for the hyperparameter.

" + }, + "maxValue":{ + "shape":"ContinuousMaxValue", + "documentation":"

The maximum allowable value for the hyperparameter.

" + }, + "isTunable":{ + "shape":"Tunable", + "documentation":"

Whether the hyperparameter is tunable.

" + } + }, + "documentation":"

Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

" + }, + "DefaultContinuousHyperParameterRanges":{ + "type":"list", + "member":{"shape":"DefaultContinuousHyperParameterRange"}, + "max":100 + }, + "DefaultHyperParameterRanges":{ + "type":"structure", + "members":{ + "integerHyperParameterRanges":{ + "shape":"DefaultIntegerHyperParameterRanges", + "documentation":"

The integer-valued hyperparameters and their default ranges.

" + }, + "continuousHyperParameterRanges":{ + "shape":"DefaultContinuousHyperParameterRanges", + "documentation":"

The continuous hyperparameters and their default ranges.

" + }, + "categoricalHyperParameterRanges":{ + "shape":"DefaultCategoricalHyperParameterRanges", + "documentation":"

The categorical hyperparameters and their default ranges.

" + } + }, + "documentation":"

Specifies the hyperparameters and their default ranges. Hyperparameters can be categorical, continuous, or integer-valued.

" + }, + "DefaultIntegerHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "minValue":{ + "shape":"IntegerMinValue", + "documentation":"

The minimum allowable value for the hyperparameter.

" + }, + "maxValue":{ + "shape":"IntegerMaxValue", + "documentation":"

The maximum allowable value for the hyperparameter.

" + }, + "isTunable":{ + "shape":"Tunable", + "documentation":"

Indicates whether the hyperparameter is tunable.

" + } + }, + "documentation":"

Provides the name and default range of a integer-valued hyperparameter and whether the hyperparameter is tunable. A tunable hyperparameter can have its value determined during hyperparameter optimization (HPO).

" + }, + "DefaultIntegerHyperParameterRanges":{ + "type":"list", + "member":{"shape":"DefaultIntegerHyperParameterRange"}, + "max":100 + }, + "DeleteCampaignRequest":{ + "type":"structure", + "required":["campaignArn"], + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign to delete.

" + } + } + }, + "DeleteDatasetGroupRequest":{ + "type":"structure", + "required":["datasetGroupArn"], + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of the dataset group to delete.

" + } + } + }, + "DeleteDatasetRequest":{ + "type":"structure", + "required":["datasetArn"], + "members":{ + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset to delete.

" + } + } + }, + "DeleteEventTrackerRequest":{ + "type":"structure", + "required":["eventTrackerArn"], + "members":{ + "eventTrackerArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event tracker to delete.

" + } + } + }, + "DeleteSchemaRequest":{ + "type":"structure", + "required":["schemaArn"], + "members":{ + "schemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema to delete.

" + } + } + }, + "DeleteSolutionRequest":{ + "type":"structure", + "required":["solutionArn"], + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the solution to delete.

" + } + } + }, + "DescribeAlgorithmRequest":{ + "type":"structure", + "required":["algorithmArn"], + "members":{ + "algorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm to describe.

" + } + } + }, + "DescribeAlgorithmResponse":{ + "type":"structure", + "members":{ + "algorithm":{ + "shape":"Algorithm", + "documentation":"

A listing of the properties of the algorithm.

" + } + } + }, + "DescribeCampaignRequest":{ + "type":"structure", + "required":["campaignArn"], + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign.

" + } + } + }, + "DescribeCampaignResponse":{ + "type":"structure", + "members":{ + "campaign":{ + "shape":"Campaign", + "documentation":"

The properties of the campaign.

" + } + } + }, + "DescribeDatasetGroupRequest":{ + "type":"structure", + "required":["datasetGroupArn"], + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group to describe.

" + } + } + }, + "DescribeDatasetGroupResponse":{ + "type":"structure", + "members":{ + "datasetGroup":{ + "shape":"DatasetGroup", + "documentation":"

A listing of the dataset group's properties.

" + } + } + }, + "DescribeDatasetImportJobRequest":{ + "type":"structure", + "required":["datasetImportJobArn"], + "members":{ + "datasetImportJobArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset import job to describe.

" + } + } + }, + "DescribeDatasetImportJobResponse":{ + "type":"structure", + "members":{ + "datasetImportJob":{ + "shape":"DatasetImportJob", + "documentation":"

Information about the dataset import job, including the status.

The status is one of the following values:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

" + } + } + }, + "DescribeDatasetRequest":{ + "type":"structure", + "required":["datasetArn"], + "members":{ + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset to describe.

" + } + } + }, + "DescribeDatasetResponse":{ + "type":"structure", + "members":{ + "dataset":{ + "shape":"Dataset", + "documentation":"

A listing of the dataset's properties.

" + } + } + }, + "DescribeEventTrackerRequest":{ + "type":"structure", + "required":["eventTrackerArn"], + "members":{ + "eventTrackerArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event tracker to describe.

" + } + } + }, + "DescribeEventTrackerResponse":{ + "type":"structure", + "members":{ + "eventTracker":{ + "shape":"EventTracker", + "documentation":"

An object that describes the event tracker.

" + } + } + }, + "DescribeFeatureTransformationRequest":{ + "type":"structure", + "required":["featureTransformationArn"], + "members":{ + "featureTransformationArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the feature transformation to describe.

" + } + } + }, + "DescribeFeatureTransformationResponse":{ + "type":"structure", + "members":{ + "featureTransformation":{ + "shape":"FeatureTransformation", + "documentation":"

A listing of the FeatureTransformation properties.

" + } + } + }, + "DescribeRecipeRequest":{ + "type":"structure", + "required":["recipeArn"], + "members":{ + "recipeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the recipe to describe.

" + } + } + }, + "DescribeRecipeResponse":{ + "type":"structure", + "members":{ + "recipe":{ + "shape":"Recipe", + "documentation":"

An object that describes the recipe.

" + } + } + }, + "DescribeSchemaRequest":{ + "type":"structure", + "required":["schemaArn"], + "members":{ + "schemaArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the schema to retrieve.

" + } + } + }, + "DescribeSchemaResponse":{ + "type":"structure", + "members":{ + "schema":{ + "shape":"DatasetSchema", + "documentation":"

The requested schema.

" + } + } + }, + "DescribeSolutionRequest":{ + "type":"structure", + "required":["solutionArn"], + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution to describe.

" + } + } + }, + "DescribeSolutionResponse":{ + "type":"structure", + "members":{ + "solution":{ + "shape":"Solution", + "documentation":"

An object that describes the solution.

" + } + } + }, + "DescribeSolutionVersionRequest":{ + "type":"structure", + "required":["solutionVersionArn"], + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution version.

" + } + } + }, + "DescribeSolutionVersionResponse":{ + "type":"structure", + "members":{ + "solutionVersion":{ + "shape":"SolutionVersion", + "documentation":"

The solution version.

" + } + } + }, + "Description":{"type":"string"}, + "DockerURI":{ + "type":"string", + "max":256 + }, + "ErrorMessage":{"type":"string"}, + "EventTracker":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the event tracker.

" + }, + "eventTrackerArn":{ + "shape":"Arn", + "documentation":"

The ARN of the event tracker.

" + }, + "accountId":{ + "shape":"AccountId", + "documentation":"

The Amazon AWS account that owns the event tracker.

" + }, + "trackingId":{ + "shape":"TrackingId", + "documentation":"

The ID of the event tracker. Include this ID in requests to the PutEvents API.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that receives the event data.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix format) that the event tracker was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the event tracker was last updated.

" + } + }, + "documentation":"

Provides information about an event tracker.

" + }, + "EventTrackerSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the event tracker.

" + }, + "eventTrackerArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the event tracker.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the event tracker.

An event tracker can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the event tracker was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the event tracker was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of an event tracker. For a complete listing, call the DescribeEventTracker API.

" + }, + "EventTrackers":{ + "type":"list", + "member":{"shape":"EventTrackerSummary"}, + "max":100 + }, + "EventType":{ + "type":"string", + "max":256 + }, + "EventValueThreshold":{ + "type":"string", + "max":256 + }, + "FailureReason":{"type":"string"}, + "FeatureTransformation":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the feature transformation.

" + }, + "featureTransformationArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the FeatureTransformation object.

" + }, + "defaultParameters":{ + "shape":"FeaturizationParameters", + "documentation":"

Provides the default parameters for feature transformation.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time (in Unix time) of the feature transformation.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The last update date and time (in Unix time) of the feature transformation.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the feature transformation.

A feature transformation can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

" + } + }, + "documentation":"

Provides feature transformation information. Feature transformation is the process of modifying raw input data into a form more suitable for model training.

" + }, + "FeatureTransformationParameters":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"}, + "max":100 + }, + "FeaturizationParameters":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"}, + "max":100 + }, + "GetSolutionMetricsRequest":{ + "type":"structure", + "required":["solutionVersionArn"], + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution version for which to get metrics.

" + } + } + }, + "GetSolutionMetricsResponse":{ + "type":"structure", + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The same solution version ARN as specified in the request.

" + }, + "metrics":{ + "shape":"Metrics", + "documentation":"

The metrics for the solution version.

" + } + } + }, + "HPOConfig":{ + "type":"structure", + "members":{ + "hpoObjective":{ + "shape":"HPOObjective", + "documentation":"

The metric to optimize during HPO.

" + }, + "hpoResourceConfig":{ + "shape":"HPOResourceConfig", + "documentation":"

Describes the resource configuration for HPO.

" + }, + "algorithmHyperParameterRanges":{ + "shape":"HyperParameterRanges", + "documentation":"

The hyperparameters and their allowable ranges.

" + } + }, + "documentation":"

Describes the properties for hyperparameter optimization (HPO). For use with the bring-your-own-recipe feature. Do not use for Amazon Personalize native recipes.

" + }, + "HPOObjective":{ + "type":"structure", + "members":{ + "type":{ + "shape":"HPOObjectiveType", + "documentation":"

The data type of the metric.

" + }, + "metricName":{ + "shape":"MetricName", + "documentation":"

The name of the metric.

" + }, + "metricRegex":{ + "shape":"MetricRegex", + "documentation":"

A regular expression for finding the metric in the training job logs.

" + } + }, + "documentation":"

The metric to optimize during hyperparameter optimization (HPO).

" + }, + "HPOObjectiveType":{ + "type":"string", + "max":256 + }, + "HPOResource":{ + "type":"string", + "max":256 + }, + "HPOResourceConfig":{ + "type":"structure", + "members":{ + "maxNumberOfTrainingJobs":{ + "shape":"HPOResource", + "documentation":"

The maximum number of training jobs when you create a solution version. The maximum value for maxNumberOfTrainingJobs is 40.

" + }, + "maxParallelTrainingJobs":{ + "shape":"HPOResource", + "documentation":"

The maximum number of parallel training jobs when you create a solution version. The maximum value for maxParallelTrainingJobs is 10.

" + } + }, + "documentation":"

Describes the resource configuration for hyperparameter optimization (HPO).

" + }, + "HyperParameterRanges":{ + "type":"structure", + "members":{ + "integerHyperParameterRanges":{ + "shape":"IntegerHyperParameterRanges", + "documentation":"

The integer-valued hyperparameters and their ranges.

" + }, + "continuousHyperParameterRanges":{ + "shape":"ContinuousHyperParameterRanges", + "documentation":"

The continuous hyperparameters and their ranges.

" + }, + "categoricalHyperParameterRanges":{ + "shape":"CategoricalHyperParameterRanges", + "documentation":"

The categorical hyperparameters and their ranges.

" + } + }, + "documentation":"

Specifies the hyperparameters and their ranges. Hyperparameters can be categorical, continuous, or integer-valued.

" + }, + "HyperParameters":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"}, + "max":100 + }, + "IntegerHyperParameterRange":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

The name of the hyperparameter.

" + }, + "minValue":{ + "shape":"IntegerMinValue", + "documentation":"

The minimum allowable value for the hyperparameter.

" + }, + "maxValue":{ + "shape":"IntegerMaxValue", + "documentation":"

The maximum allowable value for the hyperparameter.

" + } + }, + "documentation":"

Provides the name and range of an integer-valued hyperparameter.

" + }, + "IntegerHyperParameterRanges":{ + "type":"list", + "member":{"shape":"IntegerHyperParameterRange"}, + "max":100 + }, + "IntegerMaxValue":{ + "type":"integer", + "max":1000000 + }, + "IntegerMinValue":{ + "type":"integer", + "min":-1000000 + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Provide a valid value for the field or parameter.

", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The token is not valid.

", + "exception":true + }, + "KmsKeyArn":{"type":"string"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The limit on the number of requests per second has been exceeded.

", + "exception":true + }, + "ListCampaignsRequest":{ + "type":"structure", + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution to list the campaigns for. When a solution is not specified, all the campaigns associated with the account are listed.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListCampaigns for getting the next set of campaigns (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of campaigns to return.

" + } + } + }, + "ListCampaignsResponse":{ + "type":"structure", + "members":{ + "campaigns":{ + "shape":"Campaigns", + "documentation":"

A list of the campaigns.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of campaigns (if they exist).

" + } + } + }, + "ListDatasetGroupsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListDatasetGroups for getting the next set of dataset groups (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of dataset groups to return.

" + } + } + }, + "ListDatasetGroupsResponse":{ + "type":"structure", + "members":{ + "datasetGroups":{ + "shape":"DatasetGroups", + "documentation":"

The list of your dataset groups.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of dataset groups (if they exist).

" + } + } + }, + "ListDatasetImportJobsRequest":{ + "type":"structure", + "members":{ + "datasetArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of dataset import jobs to return.

" + } + } + }, + "ListDatasetImportJobsResponse":{ + "type":"structure", + "members":{ + "datasetImportJobs":{ + "shape":"DatasetImportJobs", + "documentation":"

The list of dataset import jobs.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of dataset import jobs (if they exist).

" + } + } + }, + "ListDatasetsRequest":{ + "type":"structure", + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListDatasetImportJobs for getting the next set of dataset import jobs (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of datasets to return.

" + } + } + }, + "ListDatasetsResponse":{ + "type":"structure", + "members":{ + "datasets":{ + "shape":"Datasets", + "documentation":"

An array of Dataset objects. Each object provides metadata information.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of datasets (if they exist).

" + } + } + }, + "ListEventTrackersRequest":{ + "type":"structure", + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The ARN of a dataset group used to filter the response.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListEventTrackers for getting the next set of event trackers (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of event trackers to return.

" + } + } + }, + "ListEventTrackersResponse":{ + "type":"structure", + "members":{ + "eventTrackers":{ + "shape":"EventTrackers", + "documentation":"

A list of event trackers.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of event trackers (if they exist).

" + } + } + }, + "ListRecipesRequest":{ + "type":"structure", + "members":{ + "recipeProvider":{ + "shape":"RecipeProvider", + "documentation":"

The default is SERVICE.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListRecipes for getting the next set of recipes (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of recipes to return.

" + } + } + }, + "ListRecipesResponse":{ + "type":"structure", + "members":{ + "recipes":{ + "shape":"Recipes", + "documentation":"

The list of available recipes.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of recipes.

" + } + } + }, + "ListSchemasRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListSchemas for getting the next set of schemas (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of schemas to return.

" + } + } + }, + "ListSchemasResponse":{ + "type":"structure", + "members":{ + "schemas":{ + "shape":"Schemas", + "documentation":"

A list of schemas.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token used to get the next set of schemas (if they exist).

" + } + } + }, + "ListSolutionVersionsRequest":{ + "type":"structure", + "members":{ + "solutionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListSolutionVersions for getting the next set of solution versions (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of solution versions to return.

" + } + } + }, + "ListSolutionVersionsResponse":{ + "type":"structure", + "members":{ + "solutionVersions":{ + "shape":"SolutionVersions", + "documentation":"

A list of solution versions describing the version properties.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of solution versions (if they exist).

" + } + } + }, + "ListSolutionsRequest":{ + "type":"structure", + "members":{ + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from the previous call to ListSolutions for getting the next set of solutions (if they exist).

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of solutions to return.

" + } + } + }, + "ListSolutionsResponse":{ + "type":"structure", + "members":{ + "solutions":{ + "shape":"Solutions", + "documentation":"

A list of the current solutions.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

A token for getting the next set of solutions (if they exist).

" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "MetricName":{ + "type":"string", + "max":256 + }, + "MetricRegex":{ + "type":"string", + "max":256 + }, + "MetricValue":{"type":"double"}, + "Metrics":{ + "type":"map", + "key":{"shape":"MetricName"}, + "value":{"shape":"MetricValue"}, + "max":100 + }, + "Name":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9\\-_]*" + }, + "NextToken":{ + "type":"string", + "max":1300 + }, + "ParameterName":{ + "type":"string", + "max":256 + }, + "ParameterValue":{ + "type":"string", + "max":1000 + }, + "PerformAutoML":{"type":"boolean"}, + "PerformHPO":{"type":"boolean"}, + "Recipe":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the recipe.

" + }, + "recipeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the recipe.

" + }, + "algorithmArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the algorithm that Amazon Personalize uses to train the model.

" + }, + "featureTransformationArn":{ + "shape":"Arn", + "documentation":"

The ARN of the FeatureTransformation object.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the recipe.

" + }, + "description":{ + "shape":"Description", + "documentation":"

The description of the recipe.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix format) that the recipe was created.

" + }, + "recipeType":{ + "shape":"RecipeType", + "documentation":"

One of the following values:

  • PERSONALIZED_RANKING

  • RELATED_ITEMS

  • USER_PERSONALIZATION

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix format) that the recipe was last updated.

" + } + }, + "documentation":"

Provides information about a recipe. Each recipe provides an algorithm that Amazon Personalize uses in model training when you use the CreateSolution operation.

" + }, + "RecipeProvider":{ + "type":"string", + "enum":["SERVICE"] + }, + "RecipeSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the recipe.

" + }, + "recipeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the recipe.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the recipe.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the recipe was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the recipe was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of a recipe. For a complete listing, call the DescribeRecipe API.

" + }, + "RecipeType":{ + "type":"string", + "max":256 + }, + "Recipes":{ + "type":"list", + "member":{"shape":"RecipeSummary"}, + "max":100 + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource already exists.

", + "exception":true + }, + "ResourceConfig":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValue"}, + "max":100 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The specified resource is in use.

", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Could not find the specified resource.

", + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":256, + "pattern":"arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "S3Location":{ + "type":"string", + "max":256 + }, + "Schemas":{ + "type":"list", + "member":{"shape":"DatasetSchemaSummary"}, + "max":100 + }, + "Solution":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the solution.

" + }, + "solutionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the solution.

" + }, + "performHPO":{ + "shape":"PerformHPO", + "documentation":"

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

" + }, + "performAutoML":{ + "shape":"PerformAutoML", + "documentation":"

When true, Amazon Personalize performs a search for the best USER_PERSONALIZATION recipe from the list specified in the solution configuration (recipeArn must not be specified). When false (the default), Amazon Personalize uses recipeArn for training.

" + }, + "recipeArn":{ + "shape":"Arn", + "documentation":"

The ARN of the recipe used to create the solution.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group that provides the training data.

" + }, + "eventType":{ + "shape":"EventType", + "documentation":"

The event type (for example, 'click' or 'like') that is used for training the model.

" + }, + "solutionConfig":{ + "shape":"SolutionConfig", + "documentation":"

Describes the configuration properties for the solution.

" + }, + "autoMLResult":{ + "shape":"AutoMLResult", + "documentation":"

When performAutoML is true, specifies the best recipe found.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The creation date and time (in Unix time) of the solution.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the solution was last updated.

" + }, + "latestSolutionVersion":{ + "shape":"SolutionVersionSummary", + "documentation":"

Describes the latest version of the solution, including the status and the ARN.

" + } + }, + "documentation":"

An object that provides information about a solution. A solution is a trained model that can be deployed as a campaign.

" + }, + "SolutionConfig":{ + "type":"structure", + "members":{ + "eventValueThreshold":{ + "shape":"EventValueThreshold", + "documentation":"

Only events with a value greater than or equal to this threshold are used for training a model.

" + }, + "hpoConfig":{ + "shape":"HPOConfig", + "documentation":"

Describes the properties for hyperparameter optimization (HPO). For use with the bring-your-own-recipe feature. Not used with Amazon Personalize predefined recipes.

" + }, + "algorithmHyperParameters":{ + "shape":"HyperParameters", + "documentation":"

Lists the hyperparameter names and ranges.

" + }, + "featureTransformationParameters":{ + "shape":"FeatureTransformationParameters", + "documentation":"

Lists the feature transformation parameters.

" + }, + "autoMLConfig":{ + "shape":"AutoMLConfig", + "documentation":"

The AutoMLConfig object containing a list of recipes to search when AutoML is performed.

" + } + }, + "documentation":"

Describes the configuration properties for the solution.

" + }, + "SolutionSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the solution.

" + }, + "solutionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the solution.

A solution can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

  • DELETE PENDING > DELETE IN_PROGRESS

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the solution was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the solution was last updated.

" + } + }, + "documentation":"

Provides a summary of the properties of a solution. For a complete listing, call the DescribeSolution API.

" + }, + "SolutionVersion":{ + "type":"structure", + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the solution version.

" + }, + "solutionArn":{ + "shape":"Arn", + "documentation":"

The ARN of the solution.

" + }, + "performHPO":{ + "shape":"PerformHPO", + "documentation":"

Whether to perform hyperparameter optimization (HPO) on the chosen recipe. The default is false.

" + }, + "performAutoML":{ + "shape":"PerformAutoML", + "documentation":"

When true, Amazon Personalize searches for the most optimal recipe according to the solution configuration. When false (the default), Amazon Personalize uses recipeArn.

" + }, + "recipeArn":{ + "shape":"Arn", + "documentation":"

The ARN of the recipe used in the solution.

" + }, + "eventType":{ + "shape":"EventType", + "documentation":"

The event type (for example, 'click' or 'like') that is used for training the model.

" + }, + "datasetGroupArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the dataset group providing the training data.

" + }, + "solutionConfig":{ + "shape":"SolutionConfig", + "documentation":"

Describes the configuration properties for the solution.

" + }, + "trainingHours":{ + "shape":"TrainingHours", + "documentation":"

The time used to train the model. You are billed for the time it takes to train a model. This field is visible only after Amazon Personalize successfully trains a model.

" + }, + "trainingMode":{ + "shape":"TrainingMode", + "documentation":"

The scope of training used to create the solution version. The FULL option trains the solution version based on the entirety of the input solution's training data, while the UPDATE option processes only the training data that has changed since the creation of the last solution version. Choose UPDATE when you want to start recommending items added to the dataset without retraining the model.

The UPDATE option can only be used after you've created a solution version with the FULL option and the training solution uses the native-recipe-hrnn-coldstart.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING

  • CREATE IN_PROGRESS

  • ACTIVE

  • CREATE FAILED

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If training a solution version fails, the reason for the failure.

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that this version of the solution was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the solution was last updated.

" + } + }, + "documentation":"

An object that provides information about a specific version of a Solution.

" + }, + "SolutionVersionSummary":{ + "type":"structure", + "members":{ + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the solution version.

" + }, + "status":{ + "shape":"Status", + "documentation":"

The status of the solution version.

A solution version can be in one of the following states:

  • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

" + }, + "creationDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that this version of a solution was created.

" + }, + "lastUpdatedDateTime":{ + "shape":"Date", + "documentation":"

The date and time (in Unix time) that the solution version was last updated.

" + }, + "failureReason":{ + "shape":"FailureReason", + "documentation":"

If a solution version fails, the reason behind the failure.

" + } + }, + "documentation":"

Provides a summary of the properties of a solution version. For a complete listing, call the DescribeSolutionVersion API.

" + }, + "SolutionVersions":{ + "type":"list", + "member":{"shape":"SolutionVersionSummary"}, + "max":100 + }, + "Solutions":{ + "type":"list", + "member":{"shape":"SolutionSummary"}, + "max":100 + }, + "Status":{ + "type":"string", + "max":256 + }, + "TrackingId":{ + "type":"string", + "max":256 + }, + "TrainingHours":{ + "type":"double", + "min":0 + }, + "TrainingInputMode":{ + "type":"string", + "max":256 + }, + "TrainingMode":{ + "type":"string", + "enum":[ + "FULL", + "UPDATE" + ] + }, + "TransactionsPerSecond":{ + "type":"integer", + "min":1 + }, + "Tunable":{"type":"boolean"}, + "UpdateCampaignRequest":{ + "type":"structure", + "required":["campaignArn"], + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the campaign.

" + }, + "solutionVersionArn":{ + "shape":"Arn", + "documentation":"

The ARN of a new solution version to deploy.

" + }, + "minProvisionedTPS":{ + "shape":"TransactionsPerSecond", + "documentation":"

Specifies the requested minimum provisioned transactions (recommendations) per second that Amazon Personalize will support.

" + } + } + }, + "UpdateCampaignResponse":{ + "type":"structure", + "members":{ + "campaignArn":{ + "shape":"Arn", + "documentation":"

The same campaign ARN as given in the request.

" + } + } + } + }, + "documentation":"

Amazon Personalize is a machine learning service that makes it easy to add individualized recommendations to customers.

" +} diff --git a/aws/dist/botocore/data/pi/2018-02-27/paginators-1.json b/aws/dist/botocore/data/pi/2018-02-27/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/pi/2018-02-27/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/pi/2018-02-27/service-2.json b/aws/dist/botocore/data/pi/2018-02-27/service-2.json new file mode 100644 index 00000000..3253917f --- /dev/null +++ b/aws/dist/botocore/data/pi/2018-02-27/service-2.json @@ -0,0 +1,401 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-02-27", + "endpointPrefix":"pi", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWS PI", + "serviceFullName":"AWS Performance Insights", + "serviceId":"PI", + "signatureVersion":"v4", + "signingName":"pi", + "targetPrefix":"PerformanceInsightsv20180227", + "uid":"pi-2018-02-27" + }, + "operations":{ + "DescribeDimensionKeys":{ + "name":"DescribeDimensionKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDimensionKeysRequest"}, + "output":{"shape":"DescribeDimensionKeysResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

For a specific time period, retrieve the top N dimension keys for a metric.

" + }, + "GetResourceMetrics":{ + "name":"GetResourceMetrics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourceMetricsRequest"}, + "output":{"shape":"GetResourceMetricsResponse"}, + "errors":[ + {"shape":"InvalidArgumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"NotAuthorizedException"} + ], + "documentation":"

Retrieve Performance Insights metrics for a set of data sources, over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

" + } + }, + "shapes":{ + "DataPoint":{ + "type":"structure", + "required":[ + "Timestamp", + "Value" + ], + "members":{ + "Timestamp":{ + "shape":"ISOTimestamp", + "documentation":"

The time, in epoch format, associated with a particular Value.

" + }, + "Value":{ + "shape":"Double", + "documentation":"

The actual value associated with a particular Timestamp.

" + } + }, + "documentation":"

A timestamp, and a single numerical value, which together represent a measurement at a particular point in time.

" + }, + "DataPointsList":{ + "type":"list", + "member":{"shape":"DataPoint"} + }, + "DescribeDimensionKeysRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "StartTime", + "EndTime", + "Metric", + "GroupBy" + ], + "members":{ + "ServiceType":{ + "shape":"ServiceType", + "documentation":"

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

" + }, + "Identifier":{ + "shape":"String", + "documentation":"

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

" + }, + "StartTime":{ + "shape":"ISOTimestamp", + "documentation":"

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

The value for StartTime must be earlier than the value for EndTime.

" + }, + "EndTime":{ + "shape":"ISOTimestamp", + "documentation":"

The date and time specifying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

The value for EndTime must be later than the value for StartTime.

" + }, + "Metric":{ + "shape":"String", + "documentation":"

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

" + }, + "PeriodInSeconds":{ + "shape":"Integer", + "documentation":"

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

  • 1 (one second)

  • 60 (one minute)

  • 300 (five minutes)

  • 3600 (one hour)

  • 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

" + }, + "GroupBy":{ + "shape":"DimensionGroup", + "documentation":"

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

" + }, + "PartitionBy":{ + "shape":"DimensionGroup", + "documentation":"

For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

" + }, + "Filter":{ + "shape":"MetricQueryFilterMap", + "documentation":"

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

  • A single filter for any other dimension in this dimension group.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

" + } + } + }, + "DescribeDimensionKeysResponse":{ + "type":"structure", + "members":{ + "AlignedStartTime":{ + "shape":"ISOTimestamp", + "documentation":"

The start time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

" + }, + "AlignedEndTime":{ + "shape":"ISOTimestamp", + "documentation":"

The end time for the returned dimension keys, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

" + }, + "PartitionKeys":{ + "shape":"ResponsePartitionKeyList", + "documentation":"

If PartitionBy was present in the request, PartitionKeys contains the breakdown of dimension keys by the specified partitions.

" + }, + "Keys":{ + "shape":"DimensionKeyDescriptionList", + "documentation":"

The dimension keys that were requested.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

" + } + } + }, + "DimensionGroup":{ + "type":"structure", + "required":["Group"], + "members":{ + "Group":{ + "shape":"String", + "documentation":"

The name of the dimension group. Valid values are:

  • db.user

  • db.host

  • db.sql

  • db.sql_tokenized

  • db.wait_event

  • db.wait_event_type

" + }, + "Dimensions":{ + "shape":"StringList", + "documentation":"

A list of specific dimensions from a dimension group. If this parameter is not present, then it signifies that all of the dimensions in the group were requested, or are present in the response.

Valid values for elements in the Dimensions array are:

  • db.user.id

  • db.user.name

  • db.host.id

  • db.host.name

  • db.sql.id

  • db.sql.db_id

  • db.sql.statement

  • db.sql.tokenized_id

  • db.sql_tokenized.id

  • db.sql_tokenized.db_id

  • db.sql_tokenized.statement

  • db.wait_event.name

  • db.wait_event.type

  • db.wait_event_type.name

" + }, + "Limit":{ + "shape":"Limit", + "documentation":"

The maximum number of items to fetch for this dimension group.

" + } + }, + "documentation":"

A logical grouping of Performance Insights metrics for a related subject area. For example, the db.sql dimension group consists of the following dimensions: db.sql.id, db.sql.db_id, db.sql.statement, and db.sql.tokenized_id.

" + }, + "DimensionKeyDescription":{ + "type":"structure", + "members":{ + "Dimensions":{ + "shape":"DimensionMap", + "documentation":"

A map of name-value pairs for the dimensions in the group.

" + }, + "Total":{ + "shape":"Double", + "documentation":"

The aggregated metric value for the dimension(s), over the requested time range.

" + }, + "Partitions":{ + "shape":"MetricValuesList", + "documentation":"

If PartitionBy was specified, PartitionKeys contains the dimensions that were.

" + } + }, + "documentation":"

An array of descriptions and aggregated values for each dimension within a dimension group.

" + }, + "DimensionKeyDescriptionList":{ + "type":"list", + "member":{"shape":"DimensionKeyDescription"} + }, + "DimensionMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "Double":{"type":"double"}, + "GetResourceMetricsRequest":{ + "type":"structure", + "required":[ + "ServiceType", + "Identifier", + "MetricQueries", + "StartTime", + "EndTime" + ], + "members":{ + "ServiceType":{ + "shape":"ServiceType", + "documentation":"

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

" + }, + "Identifier":{ + "shape":"String", + "documentation":"

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

" + }, + "MetricQueries":{ + "shape":"MetricQueryList", + "documentation":"

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

" + }, + "StartTime":{ + "shape":"ISOTimestamp", + "documentation":"

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

The value for StartTime must be earlier than the value for EndTime.

" + }, + "EndTime":{ + "shape":"ISOTimestamp", + "documentation":"

The date and time specifiying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

The value for EndTime must be later than the value for StartTime.

" + }, + "PeriodInSeconds":{ + "shape":"Integer", + "documentation":"

The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

  • 1 (one second)

  • 60 (one minute)

  • 300 (five minutes)

  • 3600 (one hour)

  • 86400 (twenty-four hours)

If you don't specify PeriodInSeconds, then Performance Insights will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

" + } + } + }, + "GetResourceMetricsResponse":{ + "type":"structure", + "members":{ + "AlignedStartTime":{ + "shape":"ISOTimestamp", + "documentation":"

The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

" + }, + "AlignedEndTime":{ + "shape":"ISOTimestamp", + "documentation":"

The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

" + }, + "Identifier":{ + "shape":"String", + "documentation":"

An immutable, AWS Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

To use an Amazon RDS instance as a data source, you specify its DbiResourceId value - for example: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

" + }, + "MetricList":{ + "shape":"MetricKeyDataPointsList", + "documentation":"

An array of metric results,, where each array element contains all of the data points for a particular dimension.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

" + } + } + }, + "ISOTimestamp":{"type":"timestamp"}, + "Integer":{"type":"integer"}, + "InternalServiceError":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The request failed due to an unknown error.

", + "exception":true, + "fault":true + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

One of the arguments provided is invalid for this request.

", + "exception":true + }, + "Limit":{ + "type":"integer", + "max":10, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":20, + "min":0 + }, + "MetricKeyDataPoints":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ResponseResourceMetricKey", + "documentation":"

The dimension(s) to which the data points apply.

" + }, + "DataPoints":{ + "shape":"DataPointsList", + "documentation":"

An array of timestamp-value pairs, representing measurements over a period of time.

" + } + }, + "documentation":"

A time-ordered series of data points, correpsonding to a dimension of a Performance Insights metric.

" + }, + "MetricKeyDataPointsList":{ + "type":"list", + "member":{"shape":"MetricKeyDataPoints"} + }, + "MetricQuery":{ + "type":"structure", + "required":["Metric"], + "members":{ + "Metric":{ + "shape":"String", + "documentation":"

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

" + }, + "GroupBy":{ + "shape":"DimensionGroup", + "documentation":"

A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights will return all of the dimensions within that group, unless you provide the names of specific dimensions within that group. You can also request that Performance Insights return a limited number of values for a dimension.

" + }, + "Filter":{ + "shape":"MetricQueryFilterMap", + "documentation":"

One or more filters to apply in the request. Restrictions:

  • Any number of filters by the same dimension, as specified in the GroupBy parameter.

  • A single filter for any other dimension in this dimension group.

" + } + }, + "documentation":"

A single query to be processed. You must provide the metric to query. If no other parameters are specified, Performance Insights returns all of the data points for that metric. You can optionally request that the data points be aggregated by dimension group ( GroupBy), and return only those data points that match your criteria (Filter).

" + }, + "MetricQueryFilterMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MetricQueryList":{ + "type":"list", + "member":{"shape":"MetricQuery"}, + "max":15, + "min":1 + }, + "MetricValuesList":{ + "type":"list", + "member":{"shape":"Double"} + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

The user is not authorized to perform this request.

", + "exception":true + }, + "ResponsePartitionKey":{ + "type":"structure", + "required":["Dimensions"], + "members":{ + "Dimensions":{ + "shape":"DimensionMap", + "documentation":"

A dimension map that contains the dimension(s) for this partition.

" + } + }, + "documentation":"

If PartitionBy was specified in a DescribeDimensionKeys request, the dimensions are returned in an array. Each element in the array specifies one dimension.

" + }, + "ResponsePartitionKeyList":{ + "type":"list", + "member":{"shape":"ResponsePartitionKey"} + }, + "ResponseResourceMetricKey":{ + "type":"structure", + "required":["Metric"], + "members":{ + "Metric":{ + "shape":"String", + "documentation":"

The name of a Performance Insights metric to be measured.

Valid values for Metric are:

  • db.load.avg - a scaled representation of the number of active sessions for the database engine.

  • db.sampledload.avg - the raw number of active sessions for the database engine.

" + }, + "Dimensions":{ + "shape":"DimensionMap", + "documentation":"

The valid dimensions for the metric.

" + } + }, + "documentation":"

An object describing a Performance Insights metric and one or more dimensions for that metric.

" + }, + "ServiceType":{ + "type":"string", + "enum":["RDS"] + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"}, + "max":10, + "min":1 + } + }, + "documentation":"

AWS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running RDS instance. The guide provides detailed information about Performance Insights data types, parameters and errors. For more information about Performance Insights capabilities see Using Amazon RDS Performance Insights in the Amazon RDS User Guide.

The AWS Performance Insights API provides visibility into the performance of your RDS instance, when Performance Insights is enabled for supported engine types. While Amazon CloudWatch provides the authoritative source for AWS service vended monitoring metrics, AWS Performance Insights offers a domain-specific view of database load measured as Average Active Sessions and provided to API consumers as a 2-dimensional time-series dataset. The time dimension of the data provides DB load data for each time point in the queried time range, and each time point decomposes overall load in relation to the requested dimensions, such as SQL, Wait-event, User or Host, measured at that time point.

" +} diff --git a/aws/dist/botocore/data/pinpoint-email/2018-07-26/paginators-1.json b/aws/dist/botocore/data/pinpoint-email/2018-07-26/paginators-1.json new file mode 100644 index 00000000..f2693b19 --- /dev/null +++ b/aws/dist/botocore/data/pinpoint-email/2018-07-26/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "GetDedicatedIps": { + "input_token": "NextToken", + "limit_key": "PageSize", + "output_token": "NextToken", + "result_key": "DedicatedIps" + }, + "ListConfigurationSets": { + "input_token": "NextToken", + "limit_key": "PageSize", + "output_token": "NextToken", + "result_key": "ConfigurationSets" + }, + "ListDedicatedIpPools": { + "input_token": "NextToken", + "limit_key": "PageSize", + "output_token": "NextToken", + "result_key": "DedicatedIpPools" + }, + "ListDeliverabilityTestReports": { + "input_token": "NextToken", + "limit_key": "PageSize", + "output_token": "NextToken", + "result_key": "DeliverabilityTestReports" + }, + "ListEmailIdentities": { + "input_token": "NextToken", + "limit_key": "PageSize", + "output_token": "NextToken", + "result_key": "EmailIdentities" + } + } +} diff --git a/aws/dist/botocore/data/pinpoint-email/2018-07-26/service-2.json b/aws/dist/botocore/data/pinpoint-email/2018-07-26/service-2.json new file mode 100644 index 00000000..53bb6cd6 --- /dev/null +++ b/aws/dist/botocore/data/pinpoint-email/2018-07-26/service-2.json @@ -0,0 +1,3004 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-07-26", + "endpointPrefix":"email", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Pinpoint Email", + "serviceFullName":"Amazon Pinpoint Email Service", + "serviceId":"Pinpoint Email", + "signatureVersion":"v4", + "signingName":"ses", + "uid":"pinpoint-email-2018-07-26" + }, + "operations":{ + "CreateConfigurationSet":{ + "name":"CreateConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/v1/email/configuration-sets" + }, + "input":{"shape":"CreateConfigurationSetRequest"}, + "output":{"shape":"CreateConfigurationSetResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

" + }, + "CreateConfigurationSetEventDestination":{ + "name":"CreateConfigurationSetEventDestination", + "http":{ + "method":"POST", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations" + }, + "input":{"shape":"CreateConfigurationSetEventDestinationRequest"}, + "output":{"shape":"CreateConfigurationSetEventDestinationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

" + }, + "CreateDedicatedIpPool":{ + "name":"CreateDedicatedIpPool", + "http":{ + "method":"POST", + "requestUri":"/v1/email/dedicated-ip-pools" + }, + "input":{"shape":"CreateDedicatedIpPoolRequest"}, + "output":{"shape":"CreateDedicatedIpPoolResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Create a new pool of dedicated IP addresses. A pool can include one or more dedicated IP addresses that are associated with your Amazon Pinpoint account. You can associate a pool with a configuration set. When you send an email that uses that configuration set, Amazon Pinpoint sends it using only the IP addresses in the associated pool.

" + }, + "CreateDeliverabilityTestReport":{ + "name":"CreateDeliverabilityTestReport", + "http":{ + "method":"POST", + "requestUri":"/v1/email/deliverability-dashboard/test" + }, + "input":{"shape":"CreateDeliverabilityTestReportRequest"}, + "output":{"shape":"CreateDeliverabilityTestReportResponse"}, + "errors":[ + {"shape":"AccountSuspendedException"}, + {"shape":"SendingPausedException"}, + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Create a new predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

" + }, + "CreateEmailIdentity":{ + "name":"CreateEmailIdentity", + "http":{ + "method":"POST", + "requestUri":"/v1/email/identities" + }, + "input":{"shape":"CreateEmailIdentityRequest"}, + "output":{"shape":"CreateEmailIdentityResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Verifies an email identity for use with Amazon Pinpoint. In Amazon Pinpoint, an identity is an email address or domain that you use when you send email. Before you can use an identity to send email with Amazon Pinpoint, you first have to verify it. By verifying an address, you demonstrate that you're the owner of the address, and that you've given Amazon Pinpoint permission to send email from the address.

When you verify an email address, Amazon Pinpoint sends an email to the address. Your email address is verified as soon as you follow the link in the verification email.

When you verify a domain, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

" + }, + "DeleteConfigurationSet":{ + "name":"DeleteConfigurationSet", + "http":{ + "method":"DELETE", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}" + }, + "input":{"shape":"DeleteConfigurationSetRequest"}, + "output":{"shape":"DeleteConfigurationSetResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Delete an existing configuration set.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

" + }, + "DeleteConfigurationSetEventDestination":{ + "name":"DeleteConfigurationSetEventDestination", + "http":{ + "method":"DELETE", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}" + }, + "input":{"shape":"DeleteConfigurationSetEventDestinationRequest"}, + "output":{"shape":"DeleteConfigurationSetEventDestinationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Delete an event destination.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" + }, + "DeleteDedicatedIpPool":{ + "name":"DeleteDedicatedIpPool", + "http":{ + "method":"DELETE", + "requestUri":"/v1/email/dedicated-ip-pools/{PoolName}" + }, + "input":{"shape":"DeleteDedicatedIpPoolRequest"}, + "output":{"shape":"DeleteDedicatedIpPoolResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Delete a dedicated IP pool.

" + }, + "DeleteEmailIdentity":{ + "name":"DeleteEmailIdentity", + "http":{ + "method":"DELETE", + "requestUri":"/v1/email/identities/{EmailIdentity}" + }, + "input":{"shape":"DeleteEmailIdentityRequest"}, + "output":{"shape":"DeleteEmailIdentityResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"} + ], + "documentation":"

Deletes an email identity that you previously verified for use with Amazon Pinpoint. An identity can be either an email address or a domain name.

" + }, + "GetAccount":{ + "name":"GetAccount", + "http":{ + "method":"GET", + "requestUri":"/v1/email/account" + }, + "input":{"shape":"GetAccountRequest"}, + "output":{"shape":"GetAccountResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Obtain information about the email-sending status and capabilities of your Amazon Pinpoint account in the current AWS Region.

" + }, + "GetBlacklistReports":{ + "name":"GetBlacklistReports", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/blacklist-report" + }, + "input":{"shape":"GetBlacklistReportsRequest"}, + "output":{"shape":"GetBlacklistReportsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieve a list of the blacklists that your dedicated IP addresses appear on.

" + }, + "GetConfigurationSet":{ + "name":"GetConfigurationSet", + "http":{ + "method":"GET", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}" + }, + "input":{"shape":"GetConfigurationSetRequest"}, + "output":{"shape":"GetConfigurationSetResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

" + }, + "GetConfigurationSetEventDestinations":{ + "name":"GetConfigurationSetEventDestinations", + "http":{ + "method":"GET", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations" + }, + "input":{"shape":"GetConfigurationSetEventDestinationsRequest"}, + "output":{"shape":"GetConfigurationSetEventDestinationsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieve a list of event destinations that are associated with a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" + }, + "GetDedicatedIp":{ + "name":"GetDedicatedIp", + "http":{ + "method":"GET", + "requestUri":"/v1/email/dedicated-ips/{IP}" + }, + "input":{"shape":"GetDedicatedIpRequest"}, + "output":{"shape":"GetDedicatedIpResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

" + }, + "GetDedicatedIps":{ + "name":"GetDedicatedIps", + "http":{ + "method":"GET", + "requestUri":"/v1/email/dedicated-ips" + }, + "input":{"shape":"GetDedicatedIpsRequest"}, + "output":{"shape":"GetDedicatedIpsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

" + }, + "GetDeliverabilityDashboardOptions":{ + "name":"GetDeliverabilityDashboardOptions", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard" + }, + "input":{"shape":"GetDeliverabilityDashboardOptionsRequest"}, + "output":{"shape":"GetDeliverabilityDashboardOptionsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

" + }, + "GetDeliverabilityTestReport":{ + "name":"GetDeliverabilityTestReport", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/test-reports/{ReportId}" + }, + "input":{"shape":"GetDeliverabilityTestReportRequest"}, + "output":{"shape":"GetDeliverabilityTestReportResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieve the results of a predictive inbox placement test.

" + }, + "GetDomainDeliverabilityCampaign":{ + "name":"GetDomainDeliverabilityCampaign", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/campaigns/{CampaignId}" + }, + "input":{"shape":"GetDomainDeliverabilityCampaignRequest"}, + "output":{"shape":"GetDomainDeliverabilityCampaignResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

" + }, + "GetDomainStatisticsReport":{ + "name":"GetDomainStatisticsReport", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/statistics-report/{Domain}" + }, + "input":{"shape":"GetDomainStatisticsReportRequest"}, + "output":{"shape":"GetDomainStatisticsReportResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Retrieve inbox placement and engagement rates for the domains that you use to send email.

" + }, + "GetEmailIdentity":{ + "name":"GetEmailIdentity", + "http":{ + "method":"GET", + "requestUri":"/v1/email/identities/{EmailIdentity}" + }, + "input":{"shape":"GetEmailIdentityRequest"}, + "output":{"shape":"GetEmailIdentityResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

" + }, + "ListConfigurationSets":{ + "name":"ListConfigurationSets", + "http":{ + "method":"GET", + "requestUri":"/v1/email/configuration-sets" + }, + "input":{"shape":"ListConfigurationSetsRequest"}, + "output":{"shape":"ListConfigurationSetsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

" + }, + "ListDedicatedIpPools":{ + "name":"ListDedicatedIpPools", + "http":{ + "method":"GET", + "requestUri":"/v1/email/dedicated-ip-pools" + }, + "input":{"shape":"ListDedicatedIpPoolsRequest"}, + "output":{"shape":"ListDedicatedIpPoolsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

" + }, + "ListDeliverabilityTestReports":{ + "name":"ListDeliverabilityTestReports", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/test-reports" + }, + "input":{"shape":"ListDeliverabilityTestReportsRequest"}, + "output":{"shape":"ListDeliverabilityTestReportsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

" + }, + "ListDomainDeliverabilityCampaigns":{ + "name":"ListDomainDeliverabilityCampaigns", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns" + }, + "input":{"shape":"ListDomainDeliverabilityCampaignsRequest"}, + "output":{"shape":"ListDomainDeliverabilityCampaignsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

" + }, + "ListEmailIdentities":{ + "name":"ListEmailIdentities", + "http":{ + "method":"GET", + "requestUri":"/v1/email/identities" + }, + "input":{"shape":"ListEmailIdentitiesRequest"}, + "output":{"shape":"ListEmailIdentitiesResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/v1/email/tags" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

" + }, + "PutAccountDedicatedIpWarmupAttributes":{ + "name":"PutAccountDedicatedIpWarmupAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/account/dedicated-ips/warmup" + }, + "input":{"shape":"PutAccountDedicatedIpWarmupAttributesRequest"}, + "output":{"shape":"PutAccountDedicatedIpWarmupAttributesResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Enable or disable the automatic warm-up feature for dedicated IP addresses.

" + }, + "PutAccountSendingAttributes":{ + "name":"PutAccountSendingAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/account/sending" + }, + "input":{"shape":"PutAccountSendingAttributesRequest"}, + "output":{"shape":"PutAccountSendingAttributesResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Enable or disable the ability of your account to send email.

" + }, + "PutConfigurationSetDeliveryOptions":{ + "name":"PutConfigurationSetDeliveryOptions", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/delivery-options" + }, + "input":{"shape":"PutConfigurationSetDeliveryOptionsRequest"}, + "output":{"shape":"PutConfigurationSetDeliveryOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

" + }, + "PutConfigurationSetReputationOptions":{ + "name":"PutConfigurationSetReputationOptions", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/reputation-options" + }, + "input":{"shape":"PutConfigurationSetReputationOptionsRequest"}, + "output":{"shape":"PutConfigurationSetReputationOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

" + }, + "PutConfigurationSetSendingOptions":{ + "name":"PutConfigurationSetSendingOptions", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/sending" + }, + "input":{"shape":"PutConfigurationSetSendingOptionsRequest"}, + "output":{"shape":"PutConfigurationSetSendingOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

" + }, + "PutConfigurationSetTrackingOptions":{ + "name":"PutConfigurationSetTrackingOptions", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/tracking-options" + }, + "input":{"shape":"PutConfigurationSetTrackingOptionsRequest"}, + "output":{"shape":"PutConfigurationSetTrackingOptionsResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

" + }, + "PutDedicatedIpInPool":{ + "name":"PutDedicatedIpInPool", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/dedicated-ips/{IP}/pool" + }, + "input":{"shape":"PutDedicatedIpInPoolRequest"}, + "output":{"shape":"PutDedicatedIpInPoolResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Move a dedicated IP address to an existing dedicated IP pool.

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

" + }, + "PutDedicatedIpWarmupAttributes":{ + "name":"PutDedicatedIpWarmupAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/dedicated-ips/{IP}/warmup" + }, + "input":{"shape":"PutDedicatedIpWarmupAttributesRequest"}, + "output":{"shape":"PutDedicatedIpWarmupAttributesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

" + }, + "PutDeliverabilityDashboardOption":{ + "name":"PutDeliverabilityDashboardOption", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/deliverability-dashboard" + }, + "input":{"shape":"PutDeliverabilityDashboardOptionRequest"}, + "output":{"shape":"PutDeliverabilityDashboardOptionResponse"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

" + }, + "PutEmailIdentityDkimAttributes":{ + "name":"PutEmailIdentityDkimAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/identities/{EmailIdentity}/dkim" + }, + "input":{"shape":"PutEmailIdentityDkimAttributesRequest"}, + "output":{"shape":"PutEmailIdentityDkimAttributesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Used to enable or disable DKIM authentication for an email identity.

" + }, + "PutEmailIdentityFeedbackAttributes":{ + "name":"PutEmailIdentityFeedbackAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/identities/{EmailIdentity}/feedback" + }, + "input":{"shape":"PutEmailIdentityFeedbackAttributesRequest"}, + "output":{"shape":"PutEmailIdentityFeedbackAttributesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

" + }, + "PutEmailIdentityMailFromAttributes":{ + "name":"PutEmailIdentityMailFromAttributes", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/identities/{EmailIdentity}/mail-from" + }, + "input":{"shape":"PutEmailIdentityMailFromAttributesRequest"}, + "output":{"shape":"PutEmailIdentityMailFromAttributesResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Used to enable or disable the custom Mail-From domain configuration for an email identity.

" + }, + "SendEmail":{ + "name":"SendEmail", + "http":{ + "method":"POST", + "requestUri":"/v1/email/outbound-emails" + }, + "input":{"shape":"SendEmailRequest"}, + "output":{"shape":"SendEmailResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"LimitExceededException"}, + {"shape":"AccountSuspendedException"}, + {"shape":"SendingPausedException"}, + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

  • Simple – A standard email message. When you create this type of message, you specify the sender, the recipient, and the message body, and Amazon Pinpoint assembles the message for you.

  • Raw – A raw, MIME-formatted email message. When you send this type of email, you have to specify all of the message headers, as well as the message body. You can use this message type to send messages that contain attachments. The message that you specify has to be a valid MIME message.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/v1/email/tags" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/v1/email/tags" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

Remove one or more tags (keys and values) from a specified resource.

" + }, + "UpdateConfigurationSetEventDestination":{ + "name":"UpdateConfigurationSetEventDestination", + "http":{ + "method":"PUT", + "requestUri":"/v1/email/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}" + }, + "input":{"shape":"UpdateConfigurationSetEventDestinationRequest"}, + "output":{"shape":"UpdateConfigurationSetEventDestinationResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" + } + }, + "shapes":{ + "AccountSuspendedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The message can't be sent because the account's ability to send email has been permanently restricted.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource specified in your request already exists.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AmazonResourceName":{"type":"string"}, + "BadRequestException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The input you provided is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BehaviorOnMxFailure":{ + "type":"string", + "documentation":"

The action that you want Amazon Pinpoint to take if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

", + "enum":[ + "USE_DEFAULT_VALUE", + "REJECT_MESSAGE" + ] + }, + "BlacklistEntries":{ + "type":"list", + "member":{"shape":"BlacklistEntry"} + }, + "BlacklistEntry":{ + "type":"structure", + "members":{ + "RblName":{ + "shape":"RblName", + "documentation":"

The name of the blacklist that the IP address appears on.

" + }, + "ListingTime":{ + "shape":"Timestamp", + "documentation":"

The time when the blacklisting event occurred, shown in Unix time format.

" + }, + "Description":{ + "shape":"BlacklistingDescription", + "documentation":"

Additional information about the blacklisting event, as provided by the blacklist maintainer.

" + } + }, + "documentation":"

An object that contains information about a blacklisting event that impacts one of the dedicated IP addresses that is associated with your account.

" + }, + "BlacklistItemName":{ + "type":"string", + "documentation":"

An IP address that you want to obtain blacklist information for.

" + }, + "BlacklistItemNames":{ + "type":"list", + "member":{"shape":"BlacklistItemName"} + }, + "BlacklistReport":{ + "type":"map", + "key":{"shape":"BlacklistItemName"}, + "value":{"shape":"BlacklistEntries"} + }, + "BlacklistingDescription":{ + "type":"string", + "documentation":"

A description of the blacklisting event.

" + }, + "Body":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"Content", + "documentation":"

An object that represents the version of the message that is displayed in email clients that don't support HTML, or clients where the recipient has disabled HTML rendering.

" + }, + "Html":{ + "shape":"Content", + "documentation":"

An object that represents the version of the message that is displayed in email clients that support HTML. HTML messages can include formatted text, hyperlinks, images, and more.

" + } + }, + "documentation":"

Represents the body of the email message.

" + }, + "CampaignId":{"type":"string"}, + "Charset":{"type":"string"}, + "CloudWatchDestination":{ + "type":"structure", + "required":["DimensionConfigurations"], + "members":{ + "DimensionConfigurations":{ + "shape":"CloudWatchDimensionConfigurations", + "documentation":"

An array of objects that define the dimensions to use when you send email events to Amazon CloudWatch.

" + } + }, + "documentation":"

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

" + }, + "CloudWatchDimensionConfiguration":{ + "type":"structure", + "required":[ + "DimensionName", + "DimensionValueSource", + "DefaultDimensionValue" + ], + "members":{ + "DimensionName":{ + "shape":"DimensionName", + "documentation":"

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "DimensionValueSource":{ + "shape":"DimensionValueSource", + "documentation":"

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

" + }, + "DefaultDimensionValue":{ + "shape":"DefaultDimensionValue", + "documentation":"

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + } + }, + "documentation":"

An object that defines the dimension configuration to use when you send Amazon Pinpoint email events to Amazon CloudWatch.

" + }, + "CloudWatchDimensionConfigurations":{ + "type":"list", + "member":{"shape":"CloudWatchDimensionConfiguration"} + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource is being modified by another operation or thread.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "ConfigurationSetName":{ + "type":"string", + "documentation":"

The name of a configuration set.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

" + }, + "ConfigurationSetNameList":{ + "type":"list", + "member":{"shape":"ConfigurationSetName"} + }, + "Content":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"MessageData", + "documentation":"

The content of the message itself.

" + }, + "Charset":{ + "shape":"Charset", + "documentation":"

The character set for the content. Because of the constraints of the SMTP protocol, Amazon Pinpoint uses 7-bit ASCII by default. If the text includes characters outside of the ASCII range, you have to specify a character set. For example, you could specify UTF-8, ISO-8859-1, or Shift_JIS.

" + } + }, + "documentation":"

An object that represents the content of the email, and optionally a character set specification.

" + }, + "CreateConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName", + "EventDestination" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to add an event destination to.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

A name that identifies the event destination within the configuration set.

" + }, + "EventDestination":{ + "shape":"EventDestinationDefinition", + "documentation":"

An object that defines the event destination.

" + } + }, + "documentation":"

A request to add an event destination to a configuration set.

" + }, + "CreateConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "CreateConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set.

" + }, + "TrackingOptions":{ + "shape":"TrackingOptions", + "documentation":"

An object that defines the open and click tracking options for emails that you send using the configuration set.

" + }, + "DeliveryOptions":{ + "shape":"DeliveryOptions", + "documentation":"

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

" + }, + "ReputationOptions":{ + "shape":"ReputationOptions", + "documentation":"

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

" + }, + "SendingOptions":{ + "shape":"SendingOptions", + "documentation":"

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

" + } + }, + "documentation":"

A request to create a configuration set.

" + }, + "CreateConfigurationSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "CreateDedicatedIpPoolRequest":{ + "type":"structure", + "required":["PoolName"], + "members":{ + "PoolName":{ + "shape":"PoolName", + "documentation":"

The name of the dedicated IP pool.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An object that defines the tags (keys and values) that you want to associate with the pool.

" + } + }, + "documentation":"

A request to create a new dedicated IP pool.

" + }, + "CreateDedicatedIpPoolResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "CreateDeliverabilityTestReportRequest":{ + "type":"structure", + "required":[ + "FromEmailAddress", + "Content" + ], + "members":{ + "ReportName":{ + "shape":"ReportName", + "documentation":"

A unique name that helps you to identify the predictive inbox placement test when you retrieve the results.

" + }, + "FromEmailAddress":{ + "shape":"EmailAddress", + "documentation":"

The email address that the predictive inbox placement test email was sent from.

" + }, + "Content":{ + "shape":"EmailContent", + "documentation":"

The HTML body of the message that you sent when you performed the predictive inbox placement test.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

" + } + }, + "documentation":"

A request to perform a predictive inbox placement test. Predictive inbox placement tests can help you predict how your messages will be handled by various email providers around the world. When you perform a predictive inbox placement test, you provide a sample message that contains the content that you plan to send to your customers. Amazon Pinpoint then sends that message to special email addresses spread across several major email providers. After about 24 hours, the test is complete, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

" + }, + "CreateDeliverabilityTestReportResponse":{ + "type":"structure", + "required":[ + "ReportId", + "DeliverabilityTestStatus" + ], + "members":{ + "ReportId":{ + "shape":"ReportId", + "documentation":"

A unique string that identifies the predictive inbox placement test.

" + }, + "DeliverabilityTestStatus":{ + "shape":"DeliverabilityTestStatus", + "documentation":"

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

" + } + }, + "documentation":"

Information about the predictive inbox placement test that you created.

" + }, + "CreateEmailIdentityRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The email address or domain that you want to verify.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that you want to associate with the email identity.

" + } + }, + "documentation":"

A request to begin the verification process for an email identity (an email address or domain).

" + }, + "CreateEmailIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

The email identity type.

" + }, + "VerifiedForSendingStatus":{ + "shape":"Enabled", + "documentation":"

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

" + }, + "DkimAttributes":{ + "shape":"DkimAttributes", + "documentation":"

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

" + } + }, + "documentation":"

If the email identity is a domain, this object contains tokens that you can use to create a set of CNAME records. To sucessfully verify your domain, you have to add these records to the DNS configuration for your domain.

If the email identity is an email address, this object is empty.

" + }, + "CustomRedirectDomain":{ + "type":"string", + "documentation":"

The domain that you want to use for tracking open and click events.

" + }, + "DailyVolume":{ + "type":"structure", + "members":{ + "StartDate":{ + "shape":"Timestamp", + "documentation":"

The date that the DailyVolume metrics apply to, in Unix time.

" + }, + "VolumeStatistics":{ + "shape":"VolumeStatistics", + "documentation":"

An object that contains inbox placement metrics for a specific day in the analysis period.

" + }, + "DomainIspPlacements":{ + "shape":"DomainIspPlacements", + "documentation":"

An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

" + } + }, + "documentation":"

An object that contains information about the volume of email sent on each day of the analysis period.

" + }, + "DailyVolumes":{ + "type":"list", + "member":{"shape":"DailyVolume"} + }, + "DedicatedIp":{ + "type":"structure", + "required":[ + "Ip", + "WarmupStatus", + "WarmupPercentage" + ], + "members":{ + "Ip":{ + "shape":"Ip", + "documentation":"

An IP address that is reserved for use by your Amazon Pinpoint account.

" + }, + "WarmupStatus":{ + "shape":"WarmupStatus", + "documentation":"

The warm-up status of a dedicated IP address. The status can have one of the following values:

  • IN_PROGRESS – The IP address isn't ready to use because the dedicated IP warm-up process is ongoing.

  • DONE – The dedicated IP warm-up process is complete, and the IP address is ready to use.

" + }, + "WarmupPercentage":{ + "shape":"Percentage100Wrapper", + "documentation":"

Indicates how complete the dedicated IP warm-up process is. When this value equals 1, the address has completed the warm-up process and is ready for use.

" + }, + "PoolName":{ + "shape":"PoolName", + "documentation":"

The name of the dedicated IP pool that the IP address is associated with.

" + } + }, + "documentation":"

Contains information about a dedicated IP address that is associated with your Amazon Pinpoint account.

" + }, + "DedicatedIpList":{ + "type":"list", + "member":{"shape":"DedicatedIp"}, + "documentation":"

A list of dedicated IP addresses that are associated with your Amazon Pinpoint account.

" + }, + "DefaultDimensionValue":{ + "type":"string", + "documentation":"

The default value of the dimension that is published to Amazon CloudWatch if you don't provide the value of the dimension when you send an email. This value has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "DeleteConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that contains the event destination that you want to delete.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

The name of the event destination that you want to delete.

", + "location":"uri", + "locationName":"EventDestinationName" + } + }, + "documentation":"

A request to delete an event destination from a configuration set.

" + }, + "DeleteConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "DeleteConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to delete.

", + "location":"uri", + "locationName":"ConfigurationSetName" + } + }, + "documentation":"

A request to delete a configuration set.

" + }, + "DeleteConfigurationSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "DeleteDedicatedIpPoolRequest":{ + "type":"structure", + "required":["PoolName"], + "members":{ + "PoolName":{ + "shape":"PoolName", + "documentation":"

The name of the dedicated IP pool that you want to delete.

", + "location":"uri", + "locationName":"PoolName" + } + }, + "documentation":"

A request to delete a dedicated IP pool.

" + }, + "DeleteDedicatedIpPoolResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "DeleteEmailIdentityRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.

", + "location":"uri", + "locationName":"EmailIdentity" + } + }, + "documentation":"

A request to delete an existing email identity. When you delete an identity, you lose the ability to use Amazon Pinpoint to send email from that identity. You can restore your ability to send email by completing the verification process for the identity again.

" + }, + "DeleteEmailIdentityResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "DeliverabilityDashboardAccountStatus":{ + "type":"string", + "documentation":"

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

", + "enum":[ + "ACTIVE", + "PENDING_EXPIRATION", + "DISABLED" + ] + }, + "DeliverabilityTestReport":{ + "type":"structure", + "members":{ + "ReportId":{ + "shape":"ReportId", + "documentation":"

A unique string that identifies the predictive inbox placement test.

" + }, + "ReportName":{ + "shape":"ReportName", + "documentation":"

A name that helps you identify a predictive inbox placement test report.

" + }, + "Subject":{ + "shape":"DeliverabilityTestSubject", + "documentation":"

The subject line for an email that you submitted in a predictive inbox placement test.

" + }, + "FromEmailAddress":{ + "shape":"EmailAddress", + "documentation":"

The sender address that you specified for the predictive inbox placement test.

" + }, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

The date and time when the predictive inbox placement test was created, in Unix time format.

" + }, + "DeliverabilityTestStatus":{ + "shape":"DeliverabilityTestStatus", + "documentation":"

The status of the predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport to view the results of the test.

" + } + }, + "documentation":"

An object that contains metadata related to a predictive inbox placement test.

" + }, + "DeliverabilityTestReports":{ + "type":"list", + "member":{"shape":"DeliverabilityTestReport"} + }, + "DeliverabilityTestStatus":{ + "type":"string", + "documentation":"

The status of a predictive inbox placement test. If the status is IN_PROGRESS, then the predictive inbox placement test is currently running. Predictive inbox placement tests are usually complete within 24 hours of creating the test. If the status is COMPLETE, then the test is finished, and you can use the GetDeliverabilityTestReport operation to view the results of the test.

", + "enum":[ + "IN_PROGRESS", + "COMPLETED" + ] + }, + "DeliverabilityTestSubject":{ + "type":"string", + "documentation":"

The subject line for an email that you submitted in a predictive inbox placement test.

" + }, + "DeliveryOptions":{ + "type":"structure", + "members":{ + "TlsPolicy":{ + "shape":"TlsPolicy", + "documentation":"

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

" + }, + "SendingPoolName":{ + "shape":"PoolName", + "documentation":"

The name of the dedicated IP pool that you want to associate with the configuration set.

" + } + }, + "documentation":"

Used to associate a configuration set with a dedicated IP pool.

" + }, + "Destination":{ + "type":"structure", + "members":{ + "ToAddresses":{ + "shape":"EmailAddressList", + "documentation":"

An array that contains the email addresses of the \"To\" recipients for the email.

" + }, + "CcAddresses":{ + "shape":"EmailAddressList", + "documentation":"

An array that contains the email addresses of the \"CC\" (carbon copy) recipients for the email.

" + }, + "BccAddresses":{ + "shape":"EmailAddressList", + "documentation":"

An array that contains the email addresses of the \"BCC\" (blind carbon copy) recipients for the email.

" + } + }, + "documentation":"

An object that describes the recipients for an email.

" + }, + "DimensionName":{ + "type":"string", + "documentation":"

The name of an Amazon CloudWatch dimension associated with an email sending metric. The name has to meet the following criteria:

  • It can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "DimensionValueSource":{ + "type":"string", + "documentation":"

The location where Amazon Pinpoint finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon Pinpoint to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon Pinpoint to use your own email headers, choose emailHeader. If you want Amazon Pinpoint to use link tags, choose linkTags.

", + "enum":[ + "MESSAGE_TAG", + "EMAIL_HEADER", + "LINK_TAG" + ] + }, + "DkimAttributes":{ + "type":"structure", + "members":{ + "SigningEnabled":{ + "shape":"Enabled", + "documentation":"

If the value is true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. If the value is false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

" + }, + "Status":{ + "shape":"DkimStatus", + "documentation":"

Describes whether or not Amazon Pinpoint has successfully located the DKIM records in the DNS records for the domain. The status can be one of the following:

  • PENDING – Amazon Pinpoint hasn't yet located the DKIM records in the DNS configuration for the domain, but will continue to attempt to locate them.

  • SUCCESS – Amazon Pinpoint located the DKIM records in the DNS configuration for the domain and determined that they're correct. Amazon Pinpoint can now send DKIM-signed email from the identity.

  • FAILED – Amazon Pinpoint was unable to locate the DKIM records in the DNS settings for the domain, and won't continue to search for them.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the DKIM status for the domain.

  • NOT_STARTED – Amazon Pinpoint hasn't yet started searching for the DKIM records in the DKIM records for the domain.

" + }, + "Tokens":{ + "shape":"DnsTokenList", + "documentation":"

A set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

" + } + }, + "documentation":"

An object that contains information about the DKIM configuration for an email identity.

" + }, + "DkimStatus":{ + "type":"string", + "documentation":"

The DKIM authentication status of the identity. The status can be one of the following:

  • PENDING – The DKIM verification process was initiated, and Amazon Pinpoint is still waiting for the required CNAME records to appear in the DNS configuration for the domain.

  • SUCCESS – The DKIM authentication process completed successfully.

  • FAILED – The DKIM authentication process failed. This can happen when Amazon Pinpoint fails to find the required CNAME records in the DNS configuration of the domain.

  • TEMPORARY_FAILURE – A temporary issue is preventing Amazon Pinpoint from determining the DKIM authentication status of the domain.

  • NOT_STARTED – The DKIM verification process hasn't been initiated for the domain.

", + "enum":[ + "PENDING", + "SUCCESS", + "FAILED", + "TEMPORARY_FAILURE", + "NOT_STARTED" + ] + }, + "DnsToken":{"type":"string"}, + "DnsTokenList":{ + "type":"list", + "member":{"shape":"DnsToken"} + }, + "Domain":{"type":"string"}, + "DomainDeliverabilityCampaign":{ + "type":"structure", + "members":{ + "CampaignId":{ + "shape":"CampaignId", + "documentation":"

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

" + }, + "ImageUrl":{ + "shape":"ImageUrl", + "documentation":"

The URL of an image that contains a snapshot of the email message that was sent.

" + }, + "Subject":{ + "shape":"Subject", + "documentation":"

The subject line, or title, of the email message.

" + }, + "FromAddress":{ + "shape":"Identity", + "documentation":"

The verified email address that the email message was sent from.

" + }, + "SendingIps":{ + "shape":"IpList", + "documentation":"

The IP addresses that were used to send the email message.

" + }, + "FirstSeenDateTime":{ + "shape":"Timestamp", + "documentation":"

The first time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

" + }, + "LastSeenDateTime":{ + "shape":"Timestamp", + "documentation":"

The last time, in Unix time format, when the email message was delivered to any recipient's inbox. This value can help you determine how long it took for a campaign to deliver an email message.

" + }, + "InboxCount":{ + "shape":"Volume", + "documentation":"

The number of email messages that were delivered to recipients’ inboxes.

" + }, + "SpamCount":{ + "shape":"Volume", + "documentation":"

The number of email messages that were delivered to recipients' spam or junk mail folders.

" + }, + "ReadRate":{ + "shape":"Percentage", + "documentation":"

The percentage of email messages that were opened by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

" + }, + "DeleteRate":{ + "shape":"Percentage", + "documentation":"

The percentage of email messages that were deleted by recipients, without being opened first. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

" + }, + "ReadDeleteRate":{ + "shape":"Percentage", + "documentation":"

The percentage of email messages that were opened and then deleted by recipients. Due to technical limitations, this value only includes recipients who opened the message by using an email client that supports images.

" + }, + "ProjectedVolume":{ + "shape":"Volume", + "documentation":"

The projected number of recipients that the email message was sent to.

" + }, + "Esps":{ + "shape":"Esps", + "documentation":"

The major email providers who handled the email message.

" + } + }, + "documentation":"

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

" + }, + "DomainDeliverabilityCampaignList":{ + "type":"list", + "member":{"shape":"DomainDeliverabilityCampaign"}, + "documentation":"

" + }, + "DomainDeliverabilityTrackingOption":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"Domain", + "documentation":"

A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

" + }, + "SubscriptionStartDate":{ + "shape":"Timestamp", + "documentation":"

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

" + }, + "InboxPlacementTrackingOption":{ + "shape":"InboxPlacementTrackingOption", + "documentation":"

An object that contains information about the inbox placement data settings for the domain.

" + } + }, + "documentation":"

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

" + }, + "DomainDeliverabilityTrackingOptions":{ + "type":"list", + "member":{"shape":"DomainDeliverabilityTrackingOption"}, + "documentation":"

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

" + }, + "DomainIspPlacement":{ + "type":"structure", + "members":{ + "IspName":{ + "shape":"IspName", + "documentation":"

The name of the email provider that the inbox placement data applies to.

" + }, + "InboxRawCount":{ + "shape":"Volume", + "documentation":"

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

" + }, + "SpamRawCount":{ + "shape":"Volume", + "documentation":"

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

" + }, + "InboxPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

" + }, + "SpamPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' spam or junk mail folders.

" + } + }, + "documentation":"

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

" + }, + "DomainIspPlacements":{ + "type":"list", + "member":{"shape":"DomainIspPlacement"} + }, + "EmailAddress":{"type":"string"}, + "EmailAddressList":{ + "type":"list", + "member":{"shape":"EmailAddress"} + }, + "EmailContent":{ + "type":"structure", + "members":{ + "Simple":{ + "shape":"Message", + "documentation":"

The simple email message. The message consists of a subject and a message body.

" + }, + "Raw":{ + "shape":"RawMessage", + "documentation":"

The raw email message. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by one blank line.

  • All of the required header fields must be present in the message.

  • Each part of a multipart MIME message must be formatted properly.

  • If you include attachments, they must be in a file format that Amazon Pinpoint supports.

  • The entire message must be Base64 encoded.

  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

" + }, + "Template":{ + "shape":"Template", + "documentation":"

The template to use for the email message.

" + } + }, + "documentation":"

An object that defines the entire content of the email, including the message headers and the body content. You can create a simple email message, in which you specify the subject and the text and HTML versions of the message body. You can also create raw messages, in which you specify a complete MIME-formatted message. Raw messages can include attachments and custom headers.

" + }, + "Enabled":{"type":"boolean"}, + "Esp":{"type":"string"}, + "Esps":{ + "type":"list", + "member":{"shape":"Esp"} + }, + "EventDestination":{ + "type":"structure", + "required":[ + "Name", + "MatchingEventTypes" + ], + "members":{ + "Name":{ + "shape":"EventDestinationName", + "documentation":"

A name that identifies the event destination.

" + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

" + }, + "MatchingEventTypes":{ + "shape":"EventTypes", + "documentation":"

The types of events that Amazon Pinpoint sends to the specified event destinations.

" + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

" + }, + "CloudWatchDestination":{ + "shape":"CloudWatchDestination", + "documentation":"

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

" + }, + "SnsDestination":{ + "shape":"SnsDestination", + "documentation":"

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

" + }, + "PinpointDestination":{ + "shape":"PinpointDestination", + "documentation":"

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

" + } + }, + "documentation":"

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" + }, + "EventDestinationDefinition":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Enabled", + "documentation":"

If true, the event destination is enabled. When the event destination is enabled, the specified event types are sent to the destinations in this EventDestinationDefinition.

If false, the event destination is disabled. When the event destination is disabled, events aren't sent to the specified destinations.

" + }, + "MatchingEventTypes":{ + "shape":"EventTypes", + "documentation":"

An array that specifies which events Amazon Pinpoint should send to the destinations in this EventDestinationDefinition.

" + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

" + }, + "CloudWatchDestination":{ + "shape":"CloudWatchDestination", + "documentation":"

An object that defines an Amazon CloudWatch destination for email events. You can use Amazon CloudWatch to monitor and gain insights on your email sending metrics.

" + }, + "SnsDestination":{ + "shape":"SnsDestination", + "documentation":"

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

" + }, + "PinpointDestination":{ + "shape":"PinpointDestination", + "documentation":"

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

" + } + }, + "documentation":"

An object that defines the event destination. Specifically, it defines which services receive events from emails sent using the configuration set that the event destination is associated with. Also defines the types of events that are sent to the event destination.

" + }, + "EventDestinationName":{ + "type":"string", + "documentation":"

The name of an event destination.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" + }, + "EventDestinations":{ + "type":"list", + "member":{"shape":"EventDestination"} + }, + "EventType":{ + "type":"string", + "documentation":"

An email sending event type. For example, email sends, opens, and bounces are all email events.

", + "enum":[ + "SEND", + "REJECT", + "BOUNCE", + "COMPLAINT", + "DELIVERY", + "OPEN", + "CLICK", + "RENDERING_FAILURE" + ] + }, + "EventTypes":{ + "type":"list", + "member":{"shape":"EventType"} + }, + "GeneralEnforcementStatus":{"type":"string"}, + "GetAccountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

A request to obtain information about the email-sending capabilities of your Amazon Pinpoint account.

" + }, + "GetAccountResponse":{ + "type":"structure", + "members":{ + "SendQuota":{ + "shape":"SendQuota", + "documentation":"

An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

" + }, + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.

" + }, + "DedicatedIpAutoWarmupEnabled":{ + "shape":"Enabled", + "documentation":"

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

" + }, + "EnforcementStatus":{ + "shape":"GeneralEnforcementStatus", + "documentation":"

The reputation status of your Amazon Pinpoint account. The status can be one of the following:

  • HEALTHY – There are no reputation-related issues that currently impact your account.

  • PROBATION – We've identified some issues with your Amazon Pinpoint account. We're placing your account under review while you work on correcting these issues.

  • SHUTDOWN – Your account's ability to send email is currently paused because of an issue with the email sent from your account. When you correct the issue, you can contact us and request that your account's ability to send email is resumed.

" + }, + "ProductionAccessEnabled":{ + "shape":"Enabled", + "documentation":"

Indicates whether or not your account has production access in the current AWS Region.

If the value is false, then your account is in the sandbox. When your account is in the sandbox, you can only send email to verified identities. Additionally, the maximum number of emails you can send in a 24-hour period (your sending quota) is 200, and the maximum number of emails you can send per second (your maximum sending rate) is 1.

If the value is true, then your account has production access. When your account has production access, you can send email to any address. The sending quota and maximum sending rate for your account vary based on your specific use case.

" + } + }, + "documentation":"

A list of details about the email-sending capabilities of your Amazon Pinpoint account in the current AWS Region.

" + }, + "GetBlacklistReportsRequest":{ + "type":"structure", + "required":["BlacklistItemNames"], + "members":{ + "BlacklistItemNames":{ + "shape":"BlacklistItemNames", + "documentation":"

A list of IP addresses that you want to retrieve blacklist information about. You can only specify the dedicated IP addresses that you use to send email using Amazon Pinpoint or Amazon SES.

", + "location":"querystring", + "locationName":"BlacklistItemNames" + } + }, + "documentation":"

A request to retrieve a list of the blacklists that your dedicated IP addresses appear on.

" + }, + "GetBlacklistReportsResponse":{ + "type":"structure", + "required":["BlacklistReport"], + "members":{ + "BlacklistReport":{ + "shape":"BlacklistReport", + "documentation":"

An object that contains information about a blacklist that one of your dedicated IP addresses appears on.

" + } + }, + "documentation":"

An object that contains information about blacklist events.

" + }, + "GetConfigurationSetEventDestinationsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that contains the event destination.

", + "location":"uri", + "locationName":"ConfigurationSetName" + } + }, + "documentation":"

A request to obtain information about the event destinations for a configuration set.

" + }, + "GetConfigurationSetEventDestinationsResponse":{ + "type":"structure", + "members":{ + "EventDestinations":{ + "shape":"EventDestinations", + "documentation":"

An array that includes all of the events destinations that have been configured for the configuration set.

" + } + }, + "documentation":"

Information about an event destination for a configuration set.

" + }, + "GetConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to obtain more information about.

", + "location":"uri", + "locationName":"ConfigurationSetName" + } + }, + "documentation":"

A request to obtain information about a configuration set.

" + }, + "GetConfigurationSetResponse":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set.

" + }, + "TrackingOptions":{ + "shape":"TrackingOptions", + "documentation":"

An object that defines the open and click tracking options for emails that you send using the configuration set.

" + }, + "DeliveryOptions":{ + "shape":"DeliveryOptions", + "documentation":"

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

" + }, + "ReputationOptions":{ + "shape":"ReputationOptions", + "documentation":"

An object that defines whether or not Amazon Pinpoint collects reputation metrics for the emails that you send that use the configuration set.

" + }, + "SendingOptions":{ + "shape":"SendingOptions", + "documentation":"

An object that defines whether or not Amazon Pinpoint can send email that you send using the configuration set.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that are associated with the configuration set.

" + } + }, + "documentation":"

Information about a configuration set.

" + }, + "GetDedicatedIpRequest":{ + "type":"structure", + "required":["Ip"], + "members":{ + "Ip":{ + "shape":"Ip", + "documentation":"

The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

", + "location":"uri", + "locationName":"IP" + } + }, + "documentation":"

A request to obtain more information about a dedicated IP address.

" + }, + "GetDedicatedIpResponse":{ + "type":"structure", + "members":{ + "DedicatedIp":{ + "shape":"DedicatedIp", + "documentation":"

An object that contains information about a dedicated IP address.

" + } + }, + "documentation":"

Information about a dedicated IP address.

" + }, + "GetDedicatedIpsRequest":{ + "type":"structure", + "members":{ + "PoolName":{ + "shape":"PoolName", + "documentation":"

The name of the IP pool that the dedicated IP address is associated with.

", + "location":"querystring", + "locationName":"PoolName" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from a previous call to GetDedicatedIps to indicate the position of the dedicated IP pool in the list of IP pools.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The number of results to show in a single call to GetDedicatedIpsRequest. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

A request to obtain more information about dedicated IP pools.

" + }, + "GetDedicatedIpsResponse":{ + "type":"structure", + "members":{ + "DedicatedIps":{ + "shape":"DedicatedIpList", + "documentation":"

A list of dedicated IP addresses that are reserved for use by your Amazon Pinpoint account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates that there are additional dedicated IP addresses to list. To view additional addresses, issue another request to GetDedicatedIps, passing this token in the NextToken parameter.

" + } + }, + "documentation":"

Information about the dedicated IP addresses that are associated with your Amazon Pinpoint account.

" + }, + "GetDeliverabilityDashboardOptionsRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

" + }, + "GetDeliverabilityDashboardOptionsResponse":{ + "type":"structure", + "required":["DashboardEnabled"], + "members":{ + "DashboardEnabled":{ + "shape":"Enabled", + "documentation":"

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

" + }, + "SubscriptionExpiryDate":{ + "shape":"Timestamp", + "documentation":"

The date, in Unix time format, when your current subscription to the Deliverability dashboard is scheduled to expire, if your subscription is scheduled to expire at the end of the current calendar month. This value is null if you have an active subscription that isn’t due to expire at the end of the month.

" + }, + "AccountStatus":{ + "shape":"DeliverabilityDashboardAccountStatus", + "documentation":"

The current status of your Deliverability dashboard subscription. If this value is PENDING_EXPIRATION, your subscription is scheduled to expire at the end of the current calendar month.

" + }, + "ActiveSubscribedDomains":{ + "shape":"DomainDeliverabilityTrackingOptions", + "documentation":"

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that isn’t scheduled to expire at the end of the current calendar month.

" + }, + "PendingExpirationSubscribedDomains":{ + "shape":"DomainDeliverabilityTrackingOptions", + "documentation":"

An array of objects, one for each verified domain that you use to send email and currently has an active Deliverability dashboard subscription that's scheduled to expire at the end of the current calendar month.

" + } + }, + "documentation":"

An object that shows the status of the Deliverability dashboard for your Amazon Pinpoint account.

" + }, + "GetDeliverabilityTestReportRequest":{ + "type":"structure", + "required":["ReportId"], + "members":{ + "ReportId":{ + "shape":"ReportId", + "documentation":"

A unique string that identifies the predictive inbox placement test.

", + "location":"uri", + "locationName":"ReportId" + } + }, + "documentation":"

A request to retrieve the results of a predictive inbox placement test.

" + }, + "GetDeliverabilityTestReportResponse":{ + "type":"structure", + "required":[ + "DeliverabilityTestReport", + "OverallPlacement", + "IspPlacements" + ], + "members":{ + "DeliverabilityTestReport":{ + "shape":"DeliverabilityTestReport", + "documentation":"

An object that contains the results of the predictive inbox placement test.

" + }, + "OverallPlacement":{ + "shape":"PlacementStatistics", + "documentation":"

An object that specifies how many test messages that were sent during the predictive inbox placement test were delivered to recipients' inboxes, how many were sent to recipients' spam folders, and how many weren't delivered.

" + }, + "IspPlacements":{ + "shape":"IspPlacements", + "documentation":"

An object that describes how the test email was handled by several email providers, including Gmail, Hotmail, Yahoo, AOL, and others.

" + }, + "Message":{ + "shape":"MessageContent", + "documentation":"

An object that contains the message that you sent when you performed this predictive inbox placement test.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

" + } + }, + "documentation":"

The results of the predictive inbox placement test.

" + }, + "GetDomainDeliverabilityCampaignRequest":{ + "type":"structure", + "required":["CampaignId"], + "members":{ + "CampaignId":{ + "shape":"CampaignId", + "documentation":"

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

", + "location":"uri", + "locationName":"CampaignId" + } + }, + "documentation":"

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

" + }, + "GetDomainDeliverabilityCampaignResponse":{ + "type":"structure", + "required":["DomainDeliverabilityCampaign"], + "members":{ + "DomainDeliverabilityCampaign":{ + "shape":"DomainDeliverabilityCampaign", + "documentation":"

An object that contains the deliverability data for the campaign.

" + } + }, + "documentation":"

An object that contains all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

" + }, + "GetDomainStatisticsReportRequest":{ + "type":"structure", + "required":[ + "Domain", + "StartDate", + "EndDate" + ], + "members":{ + "Domain":{ + "shape":"Identity", + "documentation":"

The domain that you want to obtain deliverability metrics for.

", + "location":"uri", + "locationName":"Domain" + }, + "StartDate":{ + "shape":"Timestamp", + "documentation":"

The first day (in Unix time) that you want to obtain domain deliverability metrics for.

", + "location":"querystring", + "locationName":"StartDate" + }, + "EndDate":{ + "shape":"Timestamp", + "documentation":"

The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

", + "location":"querystring", + "locationName":"EndDate" + } + }, + "documentation":"

A request to obtain deliverability metrics for a domain.

" + }, + "GetDomainStatisticsReportResponse":{ + "type":"structure", + "required":[ + "OverallVolume", + "DailyVolumes" + ], + "members":{ + "OverallVolume":{ + "shape":"OverallVolume", + "documentation":"

An object that contains deliverability metrics for the domain that you specified. The data in this object is a summary of all of the data that was collected from the StartDate to the EndDate.

" + }, + "DailyVolumes":{ + "shape":"DailyVolumes", + "documentation":"

An object that contains deliverability metrics for the domain that you specified. This object contains data for each day, starting on the StartDate and ending on the EndDate.

" + } + }, + "documentation":"

An object that includes statistics that are related to the domain that you specified.

" + }, + "GetEmailIdentityRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The email identity that you want to retrieve details for.

", + "location":"uri", + "locationName":"EmailIdentity" + } + }, + "documentation":"

A request to return details about an email identity.

" + }, + "GetEmailIdentityResponse":{ + "type":"structure", + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

The email identity type.

" + }, + "FeedbackForwardingStatus":{ + "shape":"Enabled", + "documentation":"

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

" + }, + "VerifiedForSendingStatus":{ + "shape":"Enabled", + "documentation":"

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

" + }, + "DkimAttributes":{ + "shape":"DkimAttributes", + "documentation":"

An object that contains information about the DKIM attributes for the identity. This object includes the tokens that you use to create the CNAME records that are required to complete the DKIM verification process.

" + }, + "MailFromAttributes":{ + "shape":"MailFromAttributes", + "documentation":"

An object that contains information about the Mail-From attributes for the email identity.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

An array of objects that define the tags (keys and values) that are associated with the email identity.

" + } + }, + "documentation":"

Details about an email identity.

" + }, + "Identity":{"type":"string"}, + "IdentityInfo":{ + "type":"structure", + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

The email identity type. The identity type can be one of the following:

  • EMAIL_ADDRESS – The identity is an email address.

  • DOMAIN – The identity is a domain.

  • MANAGED_DOMAIN – The identity is a domain that is managed by AWS.

" + }, + "IdentityName":{ + "shape":"Identity", + "documentation":"

The address or domain of the identity.

" + }, + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

Indicates whether or not you can send email from the identity.

In Amazon Pinpoint, an identity is an email address or domain that you send email from. Before you can send email from an identity, you have to demostrate that you own the identity, and that you authorize Amazon Pinpoint to send email from that identity.

" + } + }, + "documentation":"

Information about an email identity.

" + }, + "IdentityInfoList":{ + "type":"list", + "member":{"shape":"IdentityInfo"} + }, + "IdentityType":{ + "type":"string", + "documentation":"

The email identity type. The identity type can be one of the following:

  • EMAIL_ADDRESS – The identity is an email address.

  • DOMAIN – The identity is a domain.

", + "enum":[ + "EMAIL_ADDRESS", + "DOMAIN", + "MANAGED_DOMAIN" + ] + }, + "ImageUrl":{"type":"string"}, + "InboxPlacementTrackingOption":{ + "type":"structure", + "members":{ + "Global":{ + "shape":"Enabled", + "documentation":"

Specifies whether inbox placement data is being tracked for the domain.

" + }, + "TrackedIsps":{ + "shape":"IspNameList", + "documentation":"

An array of strings, one for each major email provider that the inbox placement data applies to.

" + } + }, + "documentation":"

An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain (PutDeliverabilityDashboardOption operation).

" + }, + "Ip":{ + "type":"string", + "documentation":"

A dedicated IP address that is associated with your Amazon Pinpoint account.

" + }, + "IpList":{ + "type":"list", + "member":{"shape":"Ip"} + }, + "IspName":{ + "type":"string", + "documentation":"

The name of an email provider.

" + }, + "IspNameList":{ + "type":"list", + "member":{"shape":"IspName"} + }, + "IspPlacement":{ + "type":"structure", + "members":{ + "IspName":{ + "shape":"IspName", + "documentation":"

The name of the email provider that the inbox placement data applies to.

" + }, + "PlacementStatistics":{ + "shape":"PlacementStatistics", + "documentation":"

An object that contains inbox placement metrics for a specific email provider.

" + } + }, + "documentation":"

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

" + }, + "IspPlacements":{ + "type":"list", + "member":{"shape":"IspPlacement"} + }, + "KinesisFirehoseDestination":{ + "type":"structure", + "required":[ + "IamRoleArn", + "DeliveryStreamArn" + ], + "members":{ + "IamRoleArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the IAM role that Amazon Pinpoint uses when sending email events to the Amazon Kinesis Data Firehose stream.

" + }, + "DeliveryStreamArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose stream that Amazon Pinpoint sends email events to.

" + } + }, + "documentation":"

An object that defines an Amazon Kinesis Data Firehose destination for email events. You can use Amazon Kinesis Data Firehose to stream data to other services, such as Amazon S3 and Amazon Redshift.

" + }, + "LastFreshStart":{ + "type":"timestamp", + "documentation":"

The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

There are too many instances of the specified resource type.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListConfigurationSetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

A request to obtain a list of configuration sets for your Amazon Pinpoint account in the current AWS Region.

" + }, + "ListConfigurationSetsResponse":{ + "type":"structure", + "members":{ + "ConfigurationSets":{ + "shape":"ConfigurationSetNameList", + "documentation":"

An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListConfigurationSets, and pass this token in the NextToken parameter.

" + } + }, + "documentation":"

A list of configuration sets in your Amazon Pinpoint account in the current AWS Region.

" + }, + "ListDedicatedIpPoolsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from a previous call to ListDedicatedIpPools to indicate the position in the list of dedicated IP pools.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The number of results to show in a single call to ListDedicatedIpPools. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

A request to obtain a list of dedicated IP pools.

" + }, + "ListDedicatedIpPoolsResponse":{ + "type":"structure", + "members":{ + "DedicatedIpPools":{ + "shape":"ListOfDedicatedIpPools", + "documentation":"

A list of all of the dedicated IP pools that are associated with your Amazon Pinpoint account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates that there are additional IP pools to list. To view additional IP pools, issue another request to ListDedicatedIpPools, passing this token in the NextToken parameter.

" + } + }, + "documentation":"

A list of dedicated IP pools.

" + }, + "ListDeliverabilityTestReportsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The number of results to show in a single call to ListDeliverabilityTestReports. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 0, and can be no more than 1000.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

A request to list all of the predictive inbox placement tests that you've performed.

" + }, + "ListDeliverabilityTestReportsResponse":{ + "type":"structure", + "required":["DeliverabilityTestReports"], + "members":{ + "DeliverabilityTestReports":{ + "shape":"DeliverabilityTestReports", + "documentation":"

An object that contains a lists of predictive inbox placement tests that you've performed.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

" + } + }, + "documentation":"

A list of the predictive inbox placement test reports that are available for your account, regardless of whether or not those tests are complete.

" + }, + "ListDomainDeliverabilityCampaignsRequest":{ + "type":"structure", + "required":[ + "StartDate", + "EndDate", + "SubscribedDomain" + ], + "members":{ + "StartDate":{ + "shape":"Timestamp", + "documentation":"

The first day, in Unix time format, that you want to obtain deliverability data for.

", + "location":"querystring", + "locationName":"StartDate" + }, + "EndDate":{ + "shape":"Timestamp", + "documentation":"

The last day, in Unix time format, that you want to obtain deliverability data for. This value has to be less than or equal to 30 days after the value of the StartDate parameter.

", + "location":"querystring", + "locationName":"EndDate" + }, + "SubscribedDomain":{ + "shape":"Domain", + "documentation":"

The domain to obtain deliverability data for.

", + "location":"uri", + "locationName":"SubscribedDomain" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of a campaign in the list of campaigns.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The maximum number of results to include in response to a single call to the ListDomainDeliverabilityCampaigns operation. If the number of results is larger than the number that you specify in this parameter, the response includes a NextToken element, which you can use to obtain additional results.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

" + }, + "ListDomainDeliverabilityCampaignsResponse":{ + "type":"structure", + "required":["DomainDeliverabilityCampaigns"], + "members":{ + "DomainDeliverabilityCampaigns":{ + "shape":"DomainDeliverabilityCampaignList", + "documentation":"

An array of responses, one for each campaign that used the domain to send email during the specified time range.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

" + } + }, + "documentation":"

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

" + }, + "ListEmailIdentitiesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "documentation":"

The number of results to show in a single call to ListEmailIdentities. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

The value you specify has to be at least 0, and can be no more than 1000.

", + "location":"querystring", + "locationName":"PageSize" + } + }, + "documentation":"

A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

" + }, + "ListEmailIdentitiesResponse":{ + "type":"structure", + "members":{ + "EmailIdentities":{ + "shape":"IdentityInfoList", + "documentation":"

An array that includes all of the identities associated with your Amazon Pinpoint account.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

" + } + }, + "documentation":"

A list of all of the identities that you've attempted to verify for use with Amazon Pinpoint, regardless of whether or not those identities were successfully verified.

" + }, + "ListOfDedicatedIpPools":{ + "type":"list", + "member":{"shape":"PoolName"}, + "documentation":"

A list of dedicated IP pools that are associated with your Amazon Pinpoint account.

" + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to retrieve tag information for.

", + "location":"querystring", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["Tags"], + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)

" + } + } + }, + "MailFromAttributes":{ + "type":"structure", + "required":[ + "MailFromDomain", + "MailFromDomainStatus", + "BehaviorOnMxFailure" + ], + "members":{ + "MailFromDomain":{ + "shape":"MailFromDomainName", + "documentation":"

The name of a domain that an email identity uses as a custom MAIL FROM domain.

" + }, + "MailFromDomainStatus":{ + "shape":"MailFromDomainStatus", + "documentation":"

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

  • SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

" + }, + "BehaviorOnMxFailure":{ + "shape":"BehaviorOnMxFailure", + "documentation":"

The action that Amazon Pinpoint to takes if it can't read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

" + } + }, + "documentation":"

A list of attributes that are associated with a MAIL FROM domain.

" + }, + "MailFromDomainName":{ + "type":"string", + "documentation":"

The domain that you want to use as a MAIL FROM domain.

" + }, + "MailFromDomainNotVerifiedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The message can't be sent because the sending domain isn't verified.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MailFromDomainStatus":{ + "type":"string", + "documentation":"

The status of the MAIL FROM domain. This status can have the following values:

  • PENDING – Amazon Pinpoint hasn't started searching for the MX record yet.

  • SUCCESS – Amazon Pinpoint detected the required MX record for the MAIL FROM domain.

  • FAILED – Amazon Pinpoint can't find the required MX record, or the record no longer exists.

  • TEMPORARY_FAILURE – A temporary issue occurred, which prevented Amazon Pinpoint from determining the status of the MAIL FROM domain.

", + "enum":[ + "PENDING", + "SUCCESS", + "FAILED", + "TEMPORARY_FAILURE" + ] + }, + "Max24HourSend":{"type":"double"}, + "MaxItems":{"type":"integer"}, + "MaxSendRate":{"type":"double"}, + "Message":{ + "type":"structure", + "required":[ + "Subject", + "Body" + ], + "members":{ + "Subject":{ + "shape":"Content", + "documentation":"

The subject line of the email. The subject line can only contain 7-bit ASCII characters. However, you can specify non-ASCII characters in the subject line by using encoded-word syntax, as described in RFC 2047.

" + }, + "Body":{ + "shape":"Body", + "documentation":"

The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

" + } + }, + "documentation":"

Represents the email message that you're sending. The Message object consists of a subject line and a message body.

" + }, + "MessageContent":{ + "type":"string", + "documentation":"

The body of an email message.

" + }, + "MessageData":{"type":"string"}, + "MessageRejected":{ + "type":"structure", + "members":{ + }, + "documentation":"

The message can't be sent because it contains invalid content.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MessageTag":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MessageTagName", + "documentation":"

The name of the message tag. The message tag name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "Value":{ + "shape":"MessageTagValue", + "documentation":"

The value of the message tag. The message tag value has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + } + }, + "documentation":"

Contains the name and value of a tag that you apply to an email. You can use message tags when you publish email sending events.

" + }, + "MessageTagList":{ + "type":"list", + "member":{"shape":"MessageTag"}, + "documentation":"

A list of message tags.

" + }, + "MessageTagName":{ + "type":"string", + "documentation":"

The name of the message tag. The message tag name has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "MessageTagValue":{ + "type":"string", + "documentation":"

The value of the message tag. The message tag value has to meet the following criteria:

  • It can only contain ASCII letters (a–z, A–Z), numbers (0–9), underscores (_), or dashes (-).

  • It can contain no more than 256 characters.

" + }, + "NextToken":{"type":"string"}, + "NotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The resource you attempted to access doesn't exist.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "OutboundMessageId":{"type":"string"}, + "OverallVolume":{ + "type":"structure", + "members":{ + "VolumeStatistics":{ + "shape":"VolumeStatistics", + "documentation":"

An object that contains information about the numbers of messages that arrived in recipients' inboxes and junk mail folders.

" + }, + "ReadRatePercent":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that were sent from the domain that were read by their recipients.

" + }, + "DomainIspPlacements":{ + "shape":"DomainIspPlacements", + "documentation":"

An object that contains inbox and junk mail placement metrics for individual email providers.

" + } + }, + "documentation":"

An object that contains information about email that was sent from the selected domain.

" + }, + "Percentage":{ + "type":"double", + "documentation":"

An object that contains information about inbox placement percentages.

" + }, + "Percentage100Wrapper":{"type":"integer"}, + "PinpointDestination":{ + "type":"structure", + "members":{ + "ApplicationArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon Pinpoint project that you want to send email events to.

" + } + }, + "documentation":"

An object that defines a Amazon Pinpoint destination for email events. You can use Amazon Pinpoint events to create attributes in Amazon Pinpoint projects. You can use these attributes to create segments for your campaigns.

" + }, + "PlacementStatistics":{ + "type":"structure", + "members":{ + "InboxPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that arrived in recipients' inboxes during the predictive inbox placement test.

" + }, + "SpamPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that arrived in recipients' spam or junk mail folders during the predictive inbox placement test.

" + }, + "MissingPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that didn't arrive in recipients' inboxes at all during the predictive inbox placement test.

" + }, + "SpfPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that were authenticated by using Sender Policy Framework (SPF) during the predictive inbox placement test.

" + }, + "DkimPercentage":{ + "shape":"Percentage", + "documentation":"

The percentage of emails that were authenticated by using DomainKeys Identified Mail (DKIM) during the predictive inbox placement test.

" + } + }, + "documentation":"

An object that contains inbox placement data for an email provider.

" + }, + "PoolName":{ + "type":"string", + "documentation":"

The name of a dedicated IP pool.

" + }, + "PutAccountDedicatedIpWarmupAttributesRequest":{ + "type":"structure", + "members":{ + "AutoWarmupEnabled":{ + "shape":"Enabled", + "documentation":"

Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

" + } + }, + "documentation":"

A request to enable or disable the automatic IP address warm-up feature.

" + }, + "PutAccountDedicatedIpWarmupAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutAccountSendingAttributesRequest":{ + "type":"structure", + "members":{ + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.

If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

" + } + }, + "documentation":"

A request to change the ability of your account to send email.

" + }, + "PutAccountSendingAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutConfigurationSetDeliveryOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to associate with a dedicated IP pool.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "TlsPolicy":{ + "shape":"TlsPolicy", + "documentation":"

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

" + }, + "SendingPoolName":{ + "shape":"SendingPoolName", + "documentation":"

The name of the dedicated IP pool that you want to associate with the configuration set.

" + } + }, + "documentation":"

A request to associate a configuration set with a dedicated IP pool.

" + }, + "PutConfigurationSetDeliveryOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutConfigurationSetReputationOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to enable or disable reputation metric tracking for.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "ReputationMetricsEnabled":{ + "shape":"Enabled", + "documentation":"

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

" + } + }, + "documentation":"

A request to enable or disable tracking of reputation metrics for a configuration set.

" + }, + "PutConfigurationSetReputationOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutConfigurationSetSendingOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to enable or disable email sending for.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

" + } + }, + "documentation":"

A request to enable or disable the ability of Amazon Pinpoint to send emails that use a specific configuration set.

" + }, + "PutConfigurationSetSendingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutConfigurationSetTrackingOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to add a custom tracking domain to.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "CustomRedirectDomain":{ + "shape":"CustomRedirectDomain", + "documentation":"

The domain that you want to use to track open and click events.

" + } + }, + "documentation":"

A request to add a custom domain for tracking open and click events to a configuration set.

" + }, + "PutConfigurationSetTrackingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutDedicatedIpInPoolRequest":{ + "type":"structure", + "required":[ + "Ip", + "DestinationPoolName" + ], + "members":{ + "Ip":{ + "shape":"Ip", + "documentation":"

The IP address that you want to move to the dedicated IP pool. The value you specify has to be a dedicated IP address that's associated with your Amazon Pinpoint account.

", + "location":"uri", + "locationName":"IP" + }, + "DestinationPoolName":{ + "shape":"PoolName", + "documentation":"

The name of the IP pool that you want to add the dedicated IP address to. You have to specify an IP pool that already exists.

" + } + }, + "documentation":"

A request to move a dedicated IP address to a dedicated IP pool.

" + }, + "PutDedicatedIpInPoolResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutDedicatedIpWarmupAttributesRequest":{ + "type":"structure", + "required":[ + "Ip", + "WarmupPercentage" + ], + "members":{ + "Ip":{ + "shape":"Ip", + "documentation":"

The dedicated IP address that you want to update the warm-up attributes for.

", + "location":"uri", + "locationName":"IP" + }, + "WarmupPercentage":{ + "shape":"Percentage100Wrapper", + "documentation":"

The warm-up percentage that you want to associate with the dedicated IP address.

" + } + }, + "documentation":"

A request to change the warm-up attributes for a dedicated IP address. This operation is useful when you want to resume the warm-up process for an existing IP address.

" + }, + "PutDedicatedIpWarmupAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutDeliverabilityDashboardOptionRequest":{ + "type":"structure", + "required":["DashboardEnabled"], + "members":{ + "DashboardEnabled":{ + "shape":"Enabled", + "documentation":"

Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

" + }, + "SubscribedDomains":{ + "shape":"DomainDeliverabilityTrackingOptions", + "documentation":"

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

" + } + }, + "documentation":"

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

" + }, + "PutDeliverabilityDashboardOptionResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

A response that indicates whether the Deliverability dashboard is enabled for your Amazon Pinpoint account.

" + }, + "PutEmailIdentityDkimAttributesRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The email identity that you want to change the DKIM settings for.

", + "location":"uri", + "locationName":"EmailIdentity" + }, + "SigningEnabled":{ + "shape":"Enabled", + "documentation":"

Sets the DKIM signing configuration for the identity.

When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

" + } + }, + "documentation":"

A request to enable or disable DKIM signing of email that you send from an email identity.

" + }, + "PutEmailIdentityDkimAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutEmailIdentityFeedbackAttributesRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The email identity that you want to configure bounce and complaint feedback forwarding for.

", + "location":"uri", + "locationName":"EmailIdentity" + }, + "EmailForwardingEnabled":{ + "shape":"Enabled", + "documentation":"

Sets the feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

" + } + }, + "documentation":"

A request to set the attributes that control how bounce and complaint events are processed.

" + }, + "PutEmailIdentityFeedbackAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "PutEmailIdentityMailFromAttributesRequest":{ + "type":"structure", + "required":["EmailIdentity"], + "members":{ + "EmailIdentity":{ + "shape":"Identity", + "documentation":"

The verified email identity that you want to set up the custom MAIL FROM domain for.

", + "location":"uri", + "locationName":"EmailIdentity" + }, + "MailFromDomain":{ + "shape":"MailFromDomainName", + "documentation":"

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

  • It has to be a subdomain of the verified identity.

  • It can't be used to receive email.

  • It can't be used in a \"From\" address if the MAIL FROM domain is a destination for feedback forwarding emails.

" + }, + "BehaviorOnMxFailure":{ + "shape":"BehaviorOnMxFailure", + "documentation":"

The action that you want Amazon Pinpoint to take if it can't read the required MX record when you send an email. When you set this value to UseDefaultValue, Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage, Amazon Pinpoint returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending, Failed, and TemporaryFailure states.

" + } + }, + "documentation":"

A request to configure the custom MAIL FROM domain for a verified identity.

" + }, + "PutEmailIdentityMailFromAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "RawMessage":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"RawMessageData", + "documentation":"

The raw email message. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by one blank line.

  • All of the required header fields must be present in the message.

  • Each part of a multipart MIME message must be formatted properly.

  • Attachments must be in a file format that Amazon Pinpoint supports.

  • The entire message must be Base64 encoded.

  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

" + } + }, + "documentation":"

The raw email message.

" + }, + "RawMessageData":{ + "type":"blob", + "documentation":"

The raw email message. The message has to meet the following criteria:

  • The message has to contain a header and a body, separated by one blank line.

  • All of the required header fields must be present in the message.

  • Each part of a multipart MIME message must be formatted properly.

  • Attachments must be in a file format that Amazon Pinpoint supports.

  • The entire message must be Base64 encoded.

  • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, you should encode that content to ensure that recipients' email clients render the message properly.

  • The length of any single line of text in the message can't exceed 1,000 characters. This restriction is defined in RFC 5321.

" + }, + "RblName":{ + "type":"string", + "documentation":"

The name of a blacklist that an IP address was found on.

" + }, + "ReportId":{ + "type":"string", + "documentation":"

A unique string that identifies a Deliverability dashboard report.

" + }, + "ReportName":{ + "type":"string", + "documentation":"

A name that helps you identify a report generated by the Deliverability dashboard.

" + }, + "ReputationOptions":{ + "type":"structure", + "members":{ + "ReputationMetricsEnabled":{ + "shape":"Enabled", + "documentation":"

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

" + }, + "LastFreshStart":{ + "shape":"LastFreshStart", + "documentation":"

The date and time (in Unix time) when the reputation metrics were last given a fresh start. When your account is given a fresh start, your reputation metrics are calculated starting from the date of the fresh start.

" + } + }, + "documentation":"

Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.

" + }, + "SendEmailRequest":{ + "type":"structure", + "required":[ + "Destination", + "Content" + ], + "members":{ + "FromEmailAddress":{ + "shape":"EmailAddress", + "documentation":"

The email address that you want to use as the \"From\" address for the email. The address that you specify has to be verified.

" + }, + "Destination":{ + "shape":"Destination", + "documentation":"

An object that contains the recipients of the email message.

" + }, + "ReplyToAddresses":{ + "shape":"EmailAddressList", + "documentation":"

The \"Reply-to\" email addresses for the message. When the recipient replies to the message, each Reply-to address receives the reply.

" + }, + "FeedbackForwardingEmailAddress":{ + "shape":"EmailAddress", + "documentation":"

The address that Amazon Pinpoint should send bounce and complaint notifications to.

" + }, + "Content":{ + "shape":"EmailContent", + "documentation":"

An object that contains the body of the message. You can send either a Simple message or a Raw message.

" + }, + "EmailTags":{ + "shape":"MessageTagList", + "documentation":"

A list of tags, in the form of name/value pairs, to apply to an email that you send using the SendEmail operation. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

" + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that you want to use when sending the email.

" + } + }, + "documentation":"

A request to send an email message.

" + }, + "SendEmailResponse":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"OutboundMessageId", + "documentation":"

A unique identifier for the message that is generated when Amazon Pinpoint accepts the message.

It is possible for Amazon Pinpoint to accept a message without sending it. This can happen when the message you're trying to send has an attachment doesn't pass a virus check, or when you send a templated email that contains invalid personalization content, for example.

" + } + }, + "documentation":"

A unique message ID that you receive when Amazon Pinpoint accepts an email for sending.

" + }, + "SendQuota":{ + "type":"structure", + "members":{ + "Max24HourSend":{ + "shape":"Max24HourSend", + "documentation":"

The maximum number of emails that you can send in the current AWS Region over a 24-hour period. This value is also called your sending quota.

" + }, + "MaxSendRate":{ + "shape":"MaxSendRate", + "documentation":"

The maximum number of emails that you can send per second in the current AWS Region. This value is also called your maximum sending rate or your maximum TPS (transactions per second) rate.

" + }, + "SentLast24Hours":{ + "shape":"SentLast24Hours", + "documentation":"

The number of emails sent from your Amazon Pinpoint account in the current AWS Region over the past 24 hours.

" + } + }, + "documentation":"

An object that contains information about the per-day and per-second sending limits for your Amazon Pinpoint account in the current AWS Region.

" + }, + "SendingOptions":{ + "type":"structure", + "members":{ + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

" + } + }, + "documentation":"

Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.

" + }, + "SendingPausedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The message can't be sent because the account's ability to send email is currently paused.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SendingPoolName":{ + "type":"string", + "documentation":"

The name of the dedicated IP pool that you want to associate with the configuration set.

" + }, + "SentLast24Hours":{"type":"double"}, + "SnsDestination":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish email events to. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

" + } + }, + "documentation":"

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

" + }, + "Subject":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that defines a tag. The maximum length of a tag key is 128 characters. The minimum length is 1 character.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that defines a tag. The maximum length of a tag value is 256 characters. The minimum length is 0 characters. If you don’t want a resource to have a specific tag value, don’t specify a value for this parameter. Amazon Pinpoint will set the value to an empty string.

" + } + }, + "documentation":"

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

  • Tag keys and values are case sensitive.

  • For each associated resource, each tag key must be unique and it can have only one value.

  • The aws: prefix is reserved for use by AWS; you can’t use it in any tag keys or values that you define. In addition, you can't edit or remove tag keys or values that use this prefix. Tags that use this prefix don’t count against the limit of 50 tags per resource.

  • You can associate tags with public or shared resources, but the tags are available only for your AWS account, not any other accounts that share the resource. In addition, the tags are available only for resources that are located in the specified AWS Region for your AWS account.

" + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to add one or more tags to.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A list of the tags that you want to add to the resource. A tag consists of a required tag key (Key) and an associated tag value (Value). The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "Template":{ + "type":"structure", + "members":{ + "TemplateArn":{ + "shape":"TemplateArn", + "documentation":"

The Amazon Resource Name (ARN) of the template.

" + }, + "TemplateData":{ + "shape":"TemplateData", + "documentation":"

An object that defines the values to use for message variables in the template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the value to use for that variable.

" + } + } + }, + "TemplateArn":{"type":"string"}, + "TemplateData":{ + "type":"string", + "max":262144 + }, + "Timestamp":{"type":"timestamp"}, + "TlsPolicy":{ + "type":"string", + "documentation":"

Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

", + "enum":[ + "REQUIRE", + "OPTIONAL" + ] + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

Too many requests have been made to the operation.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TrackingOptions":{ + "type":"structure", + "required":["CustomRedirectDomain"], + "members":{ + "CustomRedirectDomain":{ + "shape":"CustomRedirectDomain", + "documentation":"

The domain that you want to use for tracking open and click events.

" + } + }, + "documentation":"

An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them.

These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

The Amazon Resource Name (ARN) of the resource that you want to remove one or more tags from.

", + "location":"querystring", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

The tags (tag keys) that you want to remove from the resource. When you specify a tag key, the action removes both that key and its associated tag value.

To remove more than one tag from the resource, append the TagKeys parameter and argument for each additional tag to remove, separated by an ampersand. For example: /v1/email/tags?ResourceArn=ResourceArn&TagKeys=Key1&TagKeys=Key2

", + "location":"querystring", + "locationName":"TagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName", + "EventDestination" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

The name of the configuration set that contains the event destination that you want to modify.

", + "location":"uri", + "locationName":"ConfigurationSetName" + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

The name of the event destination that you want to modify.

", + "location":"uri", + "locationName":"EventDestinationName" + }, + "EventDestination":{ + "shape":"EventDestinationDefinition", + "documentation":"

An object that defines the event destination.

" + } + }, + "documentation":"

A request to change the settings for an event destination for a configuration set.

" + }, + "UpdateConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

An HTTP 200 response if the request succeeds, or an error message if the request fails.

" + }, + "Volume":{ + "type":"long", + "documentation":"

An object that contains information about inbox placement volume.

" + }, + "VolumeStatistics":{ + "type":"structure", + "members":{ + "InboxRawCount":{ + "shape":"Volume", + "documentation":"

The total number of emails that arrived in recipients' inboxes.

" + }, + "SpamRawCount":{ + "shape":"Volume", + "documentation":"

The total number of emails that arrived in recipients' spam or junk mail folders.

" + }, + "ProjectedInbox":{ + "shape":"Volume", + "documentation":"

An estimate of the percentage of emails sent from the current domain that will arrive in recipients' inboxes.

" + }, + "ProjectedSpam":{ + "shape":"Volume", + "documentation":"

An estimate of the percentage of emails sent from the current domain that will arrive in recipients' spam or junk mail folders.

" + } + }, + "documentation":"

An object that contains information about the amount of email that was delivered to recipients.

" + }, + "WarmupStatus":{ + "type":"string", + "documentation":"

The warmup status of a dedicated IP.

", + "enum":[ + "IN_PROGRESS", + "DONE" + ] + } + }, + "documentation":"Amazon Pinpoint Email Service

Welcome to the Amazon Pinpoint Email API Reference. This guide provides information about the Amazon Pinpoint Email API (version 1.0), including supported operations, data types, parameters, and schemas.

Amazon Pinpoint is an AWS service that you can use to engage with your customers across multiple messaging channels. You can use Amazon Pinpoint to send email, SMS text messages, voice messages, and push notifications. The Amazon Pinpoint Email API provides programmatic access to options that are unique to the email channel and supplement the options provided by the Amazon Pinpoint API.

If you're new to Amazon Pinpoint, you might find it helpful to also review the Amazon Pinpoint Developer Guide. The Amazon Pinpoint Developer Guide provides tutorials, code samples, and procedures that demonstrate how to use Amazon Pinpoint features programmatically and how to integrate Amazon Pinpoint functionality into mobile apps and other types of applications. The guide also provides information about key topics such as Amazon Pinpoint integration with other AWS services and the limits that apply to using the service.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Service Endpoints in the Amazon Web Services General Reference. To learn more about AWS Regions, see Managing AWS Regions in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

" +} diff --git a/aws/dist/botocore/data/pinpoint-sms-voice/2018-09-05/service-2.json b/aws/dist/botocore/data/pinpoint-sms-voice/2018-09-05/service-2.json new file mode 100644 index 00000000..7938a2ce --- /dev/null +++ b/aws/dist/botocore/data/pinpoint-sms-voice/2018-09-05/service-2.json @@ -0,0 +1,677 @@ +{ + "metadata" : { + "apiVersion" : "2018-09-05", + "endpointPrefix" : "sms-voice.pinpoint", + "signingName" : "sms-voice", + "serviceAbbreviation":"Pinpoint SMS Voice", + "serviceFullName" : "Amazon Pinpoint SMS and Voice Service", + "serviceId" : "Pinpoint SMS Voice", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "pinpoint-sms-voice-2018-09-05", + "signatureVersion" : "v4" + }, + "operations" : { + "CreateConfigurationSet" : { + "name" : "CreateConfigurationSet", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/configuration-sets", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConfigurationSetRequest" + }, + "output" : { + "shape" : "CreateConfigurationSetResponse", + "documentation" : "CreateConfigurationSetResponse" + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "LimitExceededException", + "documentation" : "LimitExceededException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + }, { + "shape" : "AlreadyExistsException", + "documentation" : "AlreadyExistsException" + } ], + "documentation" : "Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it." + }, + "CreateConfigurationSetEventDestination" : { + "name" : "CreateConfigurationSetEventDestination", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "CreateConfigurationSetEventDestinationResponse", + "documentation" : "CreateConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "LimitExceededException", + "documentation" : "LimitExceededException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + }, { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "AlreadyExistsException", + "documentation" : "AlreadyExistsException" + } ], + "documentation" : "Create a new event destination in a configuration set." + }, + "DeleteConfigurationSet" : { + "name" : "DeleteConfigurationSet", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteConfigurationSetRequest" + }, + "output" : { + "shape" : "DeleteConfigurationSetResponse", + "documentation" : "DeleteConfigurationSetResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Deletes an existing configuration set." + }, + "DeleteConfigurationSetEventDestination" : { + "name" : "DeleteConfigurationSetEventDestination", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "DeleteConfigurationSetEventDestinationResponse", + "documentation" : "DeleteConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Deletes an event destination in a configuration set." + }, + "GetConfigurationSetEventDestinations" : { + "name" : "GetConfigurationSetEventDestinations", + "http" : { + "method" : "GET", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConfigurationSetEventDestinationsRequest" + }, + "output" : { + "shape" : "GetConfigurationSetEventDestinationsResponse", + "documentation" : "GetConfigurationSetEventDestinationsResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination." + }, + "SendVoiceMessage" : { + "name" : "SendVoiceMessage", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/voice/message", + "responseCode" : 200 + }, + "input" : { + "shape" : "SendVoiceMessageRequest" + }, + "output" : { + "shape" : "SendVoiceMessageResponse", + "documentation" : "SendVoiceMessageResponse" + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Create a new voice message and send it to a recipient's phone number." + }, + "UpdateConfigurationSetEventDestination" : { + "name" : "UpdateConfigurationSetEventDestination", + "http" : { + "method" : "PUT", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "UpdateConfigurationSetEventDestinationResponse", + "documentation" : "UpdateConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails." + } + }, + "shapes" : { + "AlreadyExistsException" : { + "type" : "structure", + "documentation" : "The resource specified in your request already exists.", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "BadRequestException" : { + "type" : "structure", + "documentation" : "The input you provided is invalid.", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "Boolean" : { + "type" : "boolean" + }, + "CallInstructionsMessageType" : { + "type" : "structure", + "members" : { + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.", + "required" : [ ] + }, + "CloudWatchLogsDestination" : { + "type" : "structure", + "members" : { + "IamRoleArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination." + }, + "LogGroupArn" : { + "shape" : "String", + "documentation" : "The name of the Amazon CloudWatch Log Group that you want to record events in." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.", + "required" : [ ] + }, + "CreateConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestination" : { + "shape" : "EventDestinationDefinition" + }, + "EventDestinationName" : { + "shape" : "NonEmptyString", + "documentation" : "A name that identifies the event destination." + } + }, + "documentation" : "Create a new event destination in a configuration set.", + "required" : [ "ConfigurationSetName" ] + }, + "CreateConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was created successfully." + }, + "CreateConfigurationSetRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "WordCharactersWithDelimiters", + "documentation" : "The name that you want to give the configuration set." + } + }, + "documentation" : "A request to create a new configuration set." + }, + "CreateConfigurationSetResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the configuration set was successfully created." + }, + "DeleteConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestinationName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "EventDestinationName", + "documentation" : "EventDestinationName" + } + }, + "required" : [ "EventDestinationName", "ConfigurationSetName" ] + }, + "DeleteConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was deleted successfully." + }, + "DeleteConfigurationSetRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + } + }, + "required" : [ "ConfigurationSetName" ] + }, + "DeleteConfigurationSetResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the configuration set was deleted successfully." + }, + "EventDestination" : { + "type" : "structure", + "members" : { + "CloudWatchLogsDestination" : { + "shape" : "CloudWatchLogsDestination" + }, + "Enabled" : { + "shape" : "Boolean", + "documentation" : "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." + }, + "KinesisFirehoseDestination" : { + "shape" : "KinesisFirehoseDestination" + }, + "MatchingEventTypes" : { + "shape" : "EventTypes" + }, + "Name" : { + "shape" : "String", + "documentation" : "A name that identifies the event destination configuration." + }, + "SnsDestination" : { + "shape" : "SnsDestination" + } + }, + "documentation" : "An object that defines an event destination." + }, + "EventDestinationDefinition" : { + "type" : "structure", + "members" : { + "CloudWatchLogsDestination" : { + "shape" : "CloudWatchLogsDestination" + }, + "Enabled" : { + "shape" : "Boolean", + "documentation" : "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." + }, + "KinesisFirehoseDestination" : { + "shape" : "KinesisFirehoseDestination" + }, + "MatchingEventTypes" : { + "shape" : "EventTypes" + }, + "SnsDestination" : { + "shape" : "SnsDestination" + } + }, + "documentation" : "An object that defines a single event destination.", + "required" : [ ] + }, + "EventDestinations" : { + "type" : "list", + "documentation" : "An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.", + "member" : { + "shape" : "EventDestination" + } + }, + "EventType" : { + "type" : "string", + "documentation" : "The types of events that are sent to the event destination.", + "enum" : [ "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER" ] + }, + "EventTypes" : { + "type" : "list", + "documentation" : "An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.", + "member" : { + "shape" : "EventType" + } + }, + "GetConfigurationSetEventDestinationsRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + } + }, + "required" : [ "ConfigurationSetName" ] + }, + "GetConfigurationSetEventDestinationsResponse" : { + "type" : "structure", + "members" : { + "EventDestinations" : { + "shape" : "EventDestinations" + } + }, + "documentation" : "An object that contains information about an event destination." + }, + "InternalServiceErrorException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.", + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "KinesisFirehoseDestination" : { + "type" : "structure", + "members" : { + "DeliveryStreamArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream." + }, + "IamRoleArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.", + "required" : [ ] + }, + "LimitExceededException" : { + "type" : "structure", + "documentation" : "There are too many instances of the specified resource type.", + "exception" : true, + "members" : { + "Message" : { + "shape" : "String" + } + }, + "error" : { + "httpStatusCode" : 412 + } + }, + "NonEmptyString" : { + "type" : "string" + }, + "NotFoundException" : { + "type" : "structure", + "documentation" : "The resource you attempted to access doesn't exist.", + "exception" : true, + "members" : { + "Message" : { + "shape" : "String" + } + }, + "error" : { + "httpStatusCode" : 404 + } + }, + "PlainTextMessageType" : { + "type" : "structure", + "members" : { + "LanguageCode" : { + "shape" : "String", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + }, + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The plain (not SSML-formatted) text to deliver to the recipient." + }, + "VoiceId" : { + "shape" : "String", + "documentation" : "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains unformatted text.", + "required" : [ ] + }, + "SSMLMessageType" : { + "type" : "structure", + "members" : { + "LanguageCode" : { + "shape" : "String", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + }, + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The SSML-formatted text to deliver to the recipient." + }, + "VoiceId" : { + "shape" : "String", + "documentation" : "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains SSML-formatted text.", + "required" : [ ] + }, + "SendVoiceMessageRequest" : { + "type" : "structure", + "members" : { + "CallerId" : { + "shape" : "String", + "documentation" : "The phone number that appears on recipients' devices when they receive the message." + }, + "ConfigurationSetName" : { + "shape" : "WordCharactersWithDelimiters", + "documentation" : "The name of the configuration set that you want to use to send the message." + }, + "Content" : { + "shape" : "VoiceMessageContent" + }, + "DestinationPhoneNumber" : { + "shape" : "NonEmptyString", + "documentation" : "The phone number that you want to send the voice message to." + }, + "OriginationPhoneNumber" : { + "shape" : "NonEmptyString", + "documentation" : "The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request." + } + }, + "documentation" : "SendVoiceMessageRequest" + }, + "SendVoiceMessageResponse" : { + "type" : "structure", + "members" : { + "MessageId" : { + "shape" : "String", + "documentation" : "A unique identifier for the voice message." + } + }, + "documentation" : "An object that that contains the Message ID of a Voice message that was sent successfully." + }, + "SnsDestination" : { + "type" : "structure", + "members" : { + "TopicArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon SNS.", + "required" : [ ] + }, + "String" : { + "type" : "string" + }, + "TooManyRequestsException" : { + "type" : "structure", + "documentation" : "You've issued too many requests to the resource. Wait a few minutes, and then try again.", + "exception" : true, + "members" : { + "Message" : { + "shape" : "String" + } + }, + "error" : { + "httpStatusCode" : 429 + } + }, + "UpdateConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestination" : { + "shape" : "EventDestinationDefinition" + }, + "EventDestinationName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "EventDestinationName", + "documentation" : "EventDestinationName" + } + }, + "documentation" : "UpdateConfigurationSetEventDestinationRequest", + "required" : [ "EventDestinationName", "ConfigurationSetName" ] + }, + "UpdateConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was updated successfully." + }, + "VoiceMessageContent" : { + "type" : "structure", + "members" : { + "CallInstructionsMessage" : { + "shape" : "CallInstructionsMessageType" + }, + "PlainTextMessage" : { + "shape" : "PlainTextMessageType" + }, + "SSMLMessage" : { + "shape" : "SSMLMessageType" + } + }, + "documentation" : "An object that contains a voice message and information about the recipient that you want to send it to." + }, + "WordCharactersWithDelimiters" : { + "type" : "string" + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__long" : { + "type" : "long" + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "documentation" : "Pinpoint SMS and Voice Messaging public facing APIs" +} \ No newline at end of file diff --git a/aws/dist/botocore/data/pinpoint/2016-12-01/examples-1.json b/aws/dist/botocore/data/pinpoint/2016-12-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/pinpoint/2016-12-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/pinpoint/2016-12-01/service-2.json b/aws/dist/botocore/data/pinpoint/2016-12-01/service-2.json new file mode 100644 index 00000000..cbaff204 --- /dev/null +++ b/aws/dist/botocore/data/pinpoint/2016-12-01/service-2.json @@ -0,0 +1,12846 @@ +{ + "metadata": { + "apiVersion": "2016-12-01", + "endpointPrefix": "pinpoint", + "signingName": "mobiletargeting", + "serviceFullName": "Amazon Pinpoint", + "serviceId": "Pinpoint", + "protocol": "rest-json", + "jsonVersion": "1.1", + "uid": "pinpoint-2016-12-01", + "signatureVersion": "v4" + }, + "documentation": "

Doc Engage API - Amazon Pinpoint API

", + "operations": { + "CreateApp": { + "name": "CreateApp", + "http": { + "method": "POST", + "requestUri": "/v1/apps", + "responseCode": 201 + }, + "input": { + "shape": "CreateAppRequest" + }, + "output": { + "shape": "CreateAppResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates an application.

" + }, + "CreateCampaign": { + "name": "CreateCampaign", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/campaigns", + "responseCode": 201 + }, + "input": { + "shape": "CreateCampaignRequest" + }, + "output": { + "shape": "CreateCampaignResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new campaign for an application or updates the settings of an existing campaign for an application.

" + }, + "CreateEmailTemplate": { + "name": "CreateEmailTemplate", + "http": { + "method": "POST", + "requestUri": "/v1/templates/{template-name}/email", + "responseCode": 201 + }, + "input": { + "shape": "CreateEmailTemplateRequest" + }, + "output": { + "shape": "CreateEmailTemplateResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + }, + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + } + ], + "documentation": "

Creates a message template that you can use in messages that are sent through the email channel.

" + }, + "CreateExportJob": { + "name": "CreateExportJob", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/jobs/export", + "responseCode": 202 + }, + "input": { + "shape": "CreateExportJobRequest" + }, + "output": { + "shape": "CreateExportJobResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates an export job for an application.

" + }, + "CreateImportJob": { + "name": "CreateImportJob", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/jobs/import", + "responseCode": 201 + }, + "input": { + "shape": "CreateImportJobRequest" + }, + "output": { + "shape": "CreateImportJobResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates an import job for an application.

" + }, + "CreateJourney": { + "name": "CreateJourney", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/journeys", + "responseCode": 201 + }, + "input": { + "shape": "CreateJourneyRequest" + }, + "output": { + "shape": "CreateJourneyResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a journey for an application.

" + }, + "CreatePushTemplate": { + "name": "CreatePushTemplate", + "http": { + "method": "POST", + "requestUri": "/v1/templates/{template-name}/push", + "responseCode": 201 + }, + "input": { + "shape": "CreatePushTemplateRequest" + }, + "output": { + "shape": "CreatePushTemplateResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + }, + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + } + ], + "documentation": "

Creates a message template that you can use in messages that are sent through a push notification channel.

" + }, + "CreateSegment": { + "name": "CreateSegment", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/segments", + "responseCode": 201 + }, + "input": { + "shape": "CreateSegmentRequest" + }, + "output": { + "shape": "CreateSegmentResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

" + }, + "CreateSmsTemplate": { + "name": "CreateSmsTemplate", + "http": { + "method": "POST", + "requestUri": "/v1/templates/{template-name}/sms", + "responseCode": 201 + }, + "input": { + "shape": "CreateSmsTemplateRequest" + }, + "output": { + "shape": "CreateSmsTemplateResponse", + "documentation": "

The request succeeded and the specified resource was created.

" + }, + "errors": [ + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + }, + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + } + ], + "documentation": "

Creates a message template that you can use in messages that are sent through the SMS channel.

" + }, + "DeleteAdmChannel": { + "name": "DeleteAdmChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "shape": "DeleteAdmChannelRequest" + }, + "output": { + "shape": "DeleteAdmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the ADM channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteApnsChannel": { + "name": "DeleteApnsChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "shape": "DeleteApnsChannelRequest" + }, + "output": { + "shape": "DeleteApnsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the APNs channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteApnsSandboxChannel": { + "name": "DeleteApnsSandboxChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "DeleteApnsSandboxChannelRequest" + }, + "output": { + "shape": "DeleteApnsSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteApnsVoipChannel": { + "name": "DeleteApnsVoipChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "shape": "DeleteApnsVoipChannelRequest" + }, + "output": { + "shape": "DeleteApnsVoipChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteApnsVoipSandboxChannel": { + "name": "DeleteApnsVoipSandboxChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "DeleteApnsVoipSandboxChannelRequest" + }, + "output": { + "shape": "DeleteApnsVoipSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteApp": { + "name": "DeleteApp", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteAppRequest" + }, + "output": { + "shape": "DeleteAppResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes an application.

" + }, + "DeleteBaiduChannel": { + "name": "DeleteBaiduChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "shape": "DeleteBaiduChannelRequest" + }, + "output": { + "shape": "DeleteBaiduChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the Baidu channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteCampaign": { + "name": "DeleteCampaign", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteCampaignRequest" + }, + "output": { + "shape": "DeleteCampaignResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a campaign from an application.

" + }, + "DeleteEmailChannel": { + "name": "DeleteEmailChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "shape": "DeleteEmailChannelRequest" + }, + "output": { + "shape": "DeleteEmailChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the email channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteEmailTemplate": { + "name": "DeleteEmailTemplate", + "http": { + "method": "DELETE", + "requestUri": "/v1/templates/{template-name}/email", + "responseCode": 202 + }, + "input": { + "shape": "DeleteEmailTemplateRequest" + }, + "output": { + "shape": "DeleteEmailTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a message template that was designed for use in messages that were sent through the email channel.

" + }, + "DeleteEndpoint": { + "name": "DeleteEndpoint", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteEndpointRequest" + }, + "output": { + "shape": "DeleteEndpointResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes an endpoint from an application.

" + }, + "DeleteEventStream": { + "name": "DeleteEventStream", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "shape": "DeleteEventStreamRequest" + }, + "output": { + "shape": "DeleteEventStreamResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes the event stream for an application.

" + }, + "DeleteGcmChannel": { + "name": "DeleteGcmChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "shape": "DeleteGcmChannelRequest" + }, + "output": { + "shape": "DeleteGcmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the GCM channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteJourney": { + "name": "DeleteJourney", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteJourneyRequest" + }, + "output": { + "shape": "DeleteJourneyResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a journey from an application.

" + }, + "DeletePushTemplate": { + "name": "DeletePushTemplate", + "http": { + "method": "DELETE", + "requestUri": "/v1/templates/{template-name}/push", + "responseCode": 202 + }, + "input": { + "shape": "DeletePushTemplateRequest" + }, + "output": { + "shape": "DeletePushTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a message template that was designed for use in messages that were sent through a push notification channel.

" + }, + "DeleteSegment": { + "name": "DeleteSegment", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteSegmentRequest" + }, + "output": { + "shape": "DeleteSegmentResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a segment from an application.

" + }, + "DeleteSmsChannel": { + "name": "DeleteSmsChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "shape": "DeleteSmsChannelRequest" + }, + "output": { + "shape": "DeleteSmsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the SMS channel for an application and deletes any existing settings for the channel.

" + }, + "DeleteSmsTemplate": { + "name": "DeleteSmsTemplate", + "http": { + "method": "DELETE", + "requestUri": "/v1/templates/{template-name}/sms", + "responseCode": 202 + }, + "input": { + "shape": "DeleteSmsTemplateRequest" + }, + "output": { + "shape": "DeleteSmsTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes a message template that was designed for use in messages that were sent through the SMS channel.

" + }, + "DeleteUserEndpoints": { + "name": "DeleteUserEndpoints", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/users/{user-id}", + "responseCode": 202 + }, + "input": { + "shape": "DeleteUserEndpointsRequest" + }, + "output": { + "shape": "DeleteUserEndpointsResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Deletes all the endpoints that are associated with a specific user ID.

" + }, + "DeleteVoiceChannel": { + "name": "DeleteVoiceChannel", + "http": { + "method": "DELETE", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVoiceChannelRequest" + }, + "output": { + "shape": "DeleteVoiceChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Disables the voice channel for an application and deletes any existing settings for the channel.

" + }, + "GetAdmChannel": { + "name": "GetAdmChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "shape": "GetAdmChannelRequest" + }, + "output": { + "shape": "GetAdmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the ADM channel for an application.

" + }, + "GetApnsChannel": { + "name": "GetApnsChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "shape": "GetApnsChannelRequest" + }, + "output": { + "shape": "GetApnsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the APNs channel for an application.

" + }, + "GetApnsSandboxChannel": { + "name": "GetApnsSandboxChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "GetApnsSandboxChannelRequest" + }, + "output": { + "shape": "GetApnsSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the APNs sandbox channel for an application.

" + }, + "GetApnsVoipChannel": { + "name": "GetApnsVoipChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "shape": "GetApnsVoipChannelRequest" + }, + "output": { + "shape": "GetApnsVoipChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the APNs VoIP channel for an application.

" + }, + "GetApnsVoipSandboxChannel": { + "name": "GetApnsVoipSandboxChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "GetApnsVoipSandboxChannelRequest" + }, + "output": { + "shape": "GetApnsVoipSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.

" + }, + "GetApp": { + "name": "GetApp", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetAppRequest" + }, + "output": { + "shape": "GetAppResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about an application.

" + }, + "GetApplicationDateRangeKpi": { + "name": "GetApplicationDateRangeKpi", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/kpis/daterange/{kpi-name}", + "responseCode": 200 + }, + "input": { + "shape": "GetApplicationDateRangeKpiRequest" + }, + "output": { + "shape": "GetApplicationDateRangeKpiResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.

" + }, + "GetApplicationSettings": { + "name": "GetApplicationSettings", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/settings", + "responseCode": 200 + }, + "input": { + "shape": "GetApplicationSettingsRequest" + }, + "output": { + "shape": "GetApplicationSettingsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the settings for an application.

" + }, + "GetApps": { + "name": "GetApps", + "http": { + "method": "GET", + "requestUri": "/v1/apps", + "responseCode": 200 + }, + "input": { + "shape": "GetAppsRequest" + }, + "output": { + "shape": "GetAppsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about all of your applications.

" + }, + "GetBaiduChannel": { + "name": "GetBaiduChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "shape": "GetBaiduChannelRequest" + }, + "output": { + "shape": "GetBaiduChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the Baidu channel for an application.

" + }, + "GetCampaign": { + "name": "GetCampaign", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignRequest" + }, + "output": { + "shape": "GetCampaignResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for a campaign.

" + }, + "GetCampaignActivities": { + "name": "GetCampaignActivities", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/activities", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignActivitiesRequest" + }, + "output": { + "shape": "GetCampaignActivitiesResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about all the activities for a campaign.

" + }, + "GetCampaignDateRangeKpi": { + "name": "GetCampaignDateRangeKpi", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/kpis/daterange/{kpi-name}", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignDateRangeKpiRequest" + }, + "output": { + "shape": "GetCampaignDateRangeKpiResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.

" + }, + "GetCampaignVersion": { + "name": "GetCampaignVersion", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions/{version}", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignVersionRequest" + }, + "output": { + "shape": "GetCampaignVersionResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for a specific version of a campaign.

" + }, + "GetCampaignVersions": { + "name": "GetCampaignVersions", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}/versions", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignVersionsRequest" + }, + "output": { + "shape": "GetCampaignVersionsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for all versions of a campaign.

" + }, + "GetCampaigns": { + "name": "GetCampaigns", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/campaigns", + "responseCode": 200 + }, + "input": { + "shape": "GetCampaignsRequest" + }, + "output": { + "shape": "GetCampaignsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.

" + }, + "GetChannels": { + "name": "GetChannels", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels", + "responseCode": 200 + }, + "input": { + "shape": "GetChannelsRequest" + }, + "output": { + "shape": "GetChannelsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the history and status of each channel for an application.

" + }, + "GetEmailChannel": { + "name": "GetEmailChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "shape": "GetEmailChannelRequest" + }, + "output": { + "shape": "GetEmailChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the email channel for an application.

" + }, + "GetEmailTemplate": { + "name": "GetEmailTemplate", + "http": { + "method": "GET", + "requestUri": "/v1/templates/{template-name}/email", + "responseCode": 200 + }, + "input": { + "shape": "GetEmailTemplateRequest" + }, + "output": { + "shape": "GetEmailTemplateResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves the content and settings for a message template that you can use in messages that are sent through the email channel.

" + }, + "GetEndpoint": { + "name": "GetEndpoint", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetEndpointRequest" + }, + "output": { + "shape": "GetEndpointResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the settings and attributes of a specific endpoint for an application.

" + }, + "GetEventStream": { + "name": "GetEventStream", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "shape": "GetEventStreamRequest" + }, + "output": { + "shape": "GetEventStreamResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the event stream settings for an application.

" + }, + "GetExportJob": { + "name": "GetExportJob", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/export/{job-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetExportJobRequest" + }, + "output": { + "shape": "GetExportJobResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of a specific export job for an application.

" + }, + "GetExportJobs": { + "name": "GetExportJobs", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/export", + "responseCode": 200 + }, + "input": { + "shape": "GetExportJobsRequest" + }, + "output": { + "shape": "GetExportJobsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of all the export jobs for an application.

" + }, + "GetGcmChannel": { + "name": "GetGcmChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "shape": "GetGcmChannelRequest" + }, + "output": { + "shape": "GetGcmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the GCM channel for an application.

" + }, + "GetImportJob": { + "name": "GetImportJob", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/import/{job-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetImportJobRequest" + }, + "output": { + "shape": "GetImportJobResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of a specific import job for an application.

" + }, + "GetImportJobs": { + "name": "GetImportJobs", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/jobs/import", + "responseCode": 200 + }, + "input": { + "shape": "GetImportJobsRequest" + }, + "output": { + "shape": "GetImportJobsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of all the import jobs for an application.

" + }, + "GetJourney": { + "name": "GetJourney", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetJourneyRequest" + }, + "output": { + "shape": "GetJourneyResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for a journey.

" + }, + "GetJourneyDateRangeKpi": { + "name": "GetJourneyDateRangeKpi", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}/kpis/daterange/{kpi-name}", + "responseCode": 200 + }, + "input": { + "shape": "GetJourneyDateRangeKpiRequest" + }, + "output": { + "shape": "GetJourneyDateRangeKpiResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.

" + }, + "GetJourneyExecutionActivityMetrics": { + "name": "GetJourneyExecutionActivityMetrics", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}/activities/{journey-activity-id}/execution-metrics", + "responseCode": 200 + }, + "input": { + "shape": "GetJourneyExecutionActivityMetricsRequest" + }, + "output": { + "shape": "GetJourneyExecutionActivityMetricsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.

" + }, + "GetJourneyExecutionMetrics": { + "name": "GetJourneyExecutionMetrics", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}/execution-metrics", + "responseCode": 200 + }, + "input": { + "shape": "GetJourneyExecutionMetricsRequest" + }, + "output": { + "shape": "GetJourneyExecutionMetricsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.

" + }, + "GetPushTemplate": { + "name": "GetPushTemplate", + "http": { + "method": "GET", + "requestUri": "/v1/templates/{template-name}/push", + "responseCode": 200 + }, + "input": { + "shape": "GetPushTemplateRequest" + }, + "output": { + "shape": "GetPushTemplateResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves the content and settings for a message template that you can use in messages that are sent through a push notification channel.

" + }, + "GetSegment": { + "name": "GetSegment", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentRequest" + }, + "output": { + "shape": "GetSegmentResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.

" + }, + "GetSegmentExportJobs": { + "name": "GetSegmentExportJobs", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/export", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentExportJobsRequest" + }, + "output": { + "shape": "GetSegmentExportJobsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the export jobs for a segment.

" + }, + "GetSegmentImportJobs": { + "name": "GetSegmentImportJobs", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/jobs/import", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentImportJobsRequest" + }, + "output": { + "shape": "GetSegmentImportJobsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the import jobs for a segment.

" + }, + "GetSegmentVersion": { + "name": "GetSegmentVersion", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions/{version}", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentVersionRequest" + }, + "output": { + "shape": "GetSegmentVersionResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.

" + }, + "GetSegmentVersions": { + "name": "GetSegmentVersions", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}/versions", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentVersionsRequest" + }, + "output": { + "shape": "GetSegmentVersionsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the configuration, dimension, and other settings for all versions of a specific segment that's associated with an application.

" + }, + "GetSegments": { + "name": "GetSegments", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/segments", + "responseCode": 200 + }, + "input": { + "shape": "GetSegmentsRequest" + }, + "output": { + "shape": "GetSegmentsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.

" + }, + "GetSmsChannel": { + "name": "GetSmsChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "shape": "GetSmsChannelRequest" + }, + "output": { + "shape": "GetSmsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the SMS channel for an application.

" + }, + "GetSmsTemplate": { + "name": "GetSmsTemplate", + "http": { + "method": "GET", + "requestUri": "/v1/templates/{template-name}/sms", + "responseCode": 200 + }, + "input": { + "shape": "GetSmsTemplateRequest" + }, + "output": { + "shape": "GetSmsTemplateResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves the content and settings for a message template that you can use in messages that are sent through the SMS channel.

" + }, + "GetUserEndpoints": { + "name": "GetUserEndpoints", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/users/{user-id}", + "responseCode": 200 + }, + "input": { + "shape": "GetUserEndpointsRequest" + }, + "output": { + "shape": "GetUserEndpointsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about all the endpoints that are associated with a specific user ID.

" + }, + "GetVoiceChannel": { + "name": "GetVoiceChannel", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "shape": "GetVoiceChannelRequest" + }, + "output": { + "shape": "GetVoiceChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status and settings of the voice channel for an application.

" + }, + "ListJourneys": { + "name": "ListJourneys", + "http": { + "method": "GET", + "requestUri": "/v1/apps/{application-id}/journeys", + "responseCode": 200 + }, + "input": { + "shape": "ListJourneysRequest" + }, + "output": { + "shape": "ListJourneysResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.

" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + + ], + "documentation": "

Retrieves all the tags (keys and values) that are associated with an application, campaign, journey, message template, or segment.

" + }, + "ListTemplates": { + "name": "ListTemplates", + "http": { + "method": "GET", + "requestUri": "/v1/templates", + "responseCode": 200 + }, + "input": { + "shape": "ListTemplatesRequest" + }, + "output": { + "shape": "ListTemplatesResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + }, + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + } + ], + "documentation": "

Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.

" + }, + "PhoneNumberValidate": { + "name": "PhoneNumberValidate", + "http": { + "method": "POST", + "requestUri": "/v1/phone/number/validate", + "responseCode": 200 + }, + "input": { + "shape": "PhoneNumberValidateRequest" + }, + "output": { + "shape": "PhoneNumberValidateResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Retrieves information about a phone number.

" + }, + "PutEventStream": { + "name": "PutEventStream", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/eventstream", + "responseCode": 200 + }, + "input": { + "shape": "PutEventStreamRequest" + }, + "output": { + "shape": "PutEventStreamResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

" + }, + "PutEvents": { + "name": "PutEvents", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/events", + "responseCode": 202 + }, + "input": { + "shape": "PutEventsRequest" + }, + "output": { + "shape": "PutEventsResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.

" + }, + "RemoveAttributes": { + "name": "RemoveAttributes", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/attributes/{attribute-type}", + "responseCode": 200 + }, + "input": { + "shape": "RemoveAttributesRequest" + }, + "output": { + "shape": "RemoveAttributesResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.

" + }, + "SendMessages": { + "name": "SendMessages", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/messages", + "responseCode": 200 + }, + "input": { + "shape": "SendMessagesRequest" + }, + "output": { + "shape": "SendMessagesResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates and sends a direct message.

" + }, + "SendUsersMessages": { + "name": "SendUsersMessages", + "http": { + "method": "POST", + "requestUri": "/v1/apps/{application-id}/users-messages", + "responseCode": 200 + }, + "input": { + "shape": "SendUsersMessagesRequest" + }, + "output": { + "shape": "SendUsersMessagesResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates and sends a message to a list of users.

" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "TagResourceRequest" + }, + "errors": [ + + ], + "documentation": "

Adds one or more tags (keys and values) to an application, campaign, journey, message template, or segment.

" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/v1/tags/{resource-arn}", + "responseCode": 204 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "errors": [ + + ], + "documentation": "

Removes one or more tags (keys and values) from an application, campaign, journey, message template, or segment.

" + }, + "UpdateAdmChannel": { + "name": "UpdateAdmChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/adm", + "responseCode": 200 + }, + "input": { + "shape": "UpdateAdmChannelRequest" + }, + "output": { + "shape": "UpdateAdmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.

" + }, + "UpdateApnsChannel": { + "name": "UpdateApnsChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApnsChannelRequest" + }, + "output": { + "shape": "UpdateApnsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.

" + }, + "UpdateApnsSandboxChannel": { + "name": "UpdateApnsSandboxChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApnsSandboxChannelRequest" + }, + "output": { + "shape": "UpdateApnsSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.

" + }, + "UpdateApnsVoipChannel": { + "name": "UpdateApnsVoipChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApnsVoipChannelRequest" + }, + "output": { + "shape": "UpdateApnsVoipChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

" + }, + "UpdateApnsVoipSandboxChannel": { + "name": "UpdateApnsVoipSandboxChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/apns_voip_sandbox", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApnsVoipSandboxChannelRequest" + }, + "output": { + "shape": "UpdateApnsVoipSandboxChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.

" + }, + "UpdateApplicationSettings": { + "name": "UpdateApplicationSettings", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/settings", + "responseCode": 200 + }, + "input": { + "shape": "UpdateApplicationSettingsRequest" + }, + "output": { + "shape": "UpdateApplicationSettingsResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates the settings for an application.

" + }, + "UpdateBaiduChannel": { + "name": "UpdateBaiduChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/baidu", + "responseCode": 200 + }, + "input": { + "shape": "UpdateBaiduChannelRequest" + }, + "output": { + "shape": "UpdateBaiduChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.

" + }, + "UpdateCampaign": { + "name": "UpdateCampaign", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/campaigns/{campaign-id}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateCampaignRequest" + }, + "output": { + "shape": "UpdateCampaignResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates the configuration and other settings for a campaign.

" + }, + "UpdateEmailChannel": { + "name": "UpdateEmailChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/email", + "responseCode": 200 + }, + "input": { + "shape": "UpdateEmailChannelRequest" + }, + "output": { + "shape": "UpdateEmailChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the email channel for an application or updates the status and settings of the email channel for an application.

" + }, + "UpdateEmailTemplate": { + "name": "UpdateEmailTemplate", + "http": { + "method": "PUT", + "requestUri": "/v1/templates/{template-name}/email", + "responseCode": 202 + }, + "input": { + "shape": "UpdateEmailTemplateRequest" + }, + "output": { + "shape": "UpdateEmailTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates an existing message template that you can use in messages that are sent through the email channel.

" + }, + "UpdateEndpoint": { + "name": "UpdateEndpoint", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/endpoints/{endpoint-id}", + "responseCode": 202 + }, + "input": { + "shape": "UpdateEndpointRequest" + }, + "output": { + "shape": "UpdateEndpointResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for an endpoint.

" + }, + "UpdateEndpointsBatch": { + "name": "UpdateEndpointsBatch", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/endpoints", + "responseCode": 202 + }, + "input": { + "shape": "UpdateEndpointsBatchRequest" + }, + "output": { + "shape": "UpdateEndpointsBatchResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes (Attributes, Metrics, and UserAttributes properties) for a batch of endpoints.

" + }, + "UpdateGcmChannel": { + "name": "UpdateGcmChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/gcm", + "responseCode": 200 + }, + "input": { + "shape": "UpdateGcmChannelRequest" + }, + "output": { + "shape": "UpdateGcmChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.

" + }, + "UpdateJourney": { + "name": "UpdateJourney", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateJourneyRequest" + }, + "output": { + "shape": "UpdateJourneyResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates the configuration and other settings for a journey.

" + }, + "UpdateJourneyState": { + "name": "UpdateJourneyState", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/journeys/{journey-id}/state", + "responseCode": 200 + }, + "input": { + "shape": "UpdateJourneyStateRequest" + }, + "output": { + "shape": "UpdateJourneyStateResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Cancels an active journey.

" + }, + "UpdatePushTemplate": { + "name": "UpdatePushTemplate", + "http": { + "method": "PUT", + "requestUri": "/v1/templates/{template-name}/push", + "responseCode": 202 + }, + "input": { + "shape": "UpdatePushTemplateRequest" + }, + "output": { + "shape": "UpdatePushTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates an existing message template that you can use in messages that are sent through a push notification channel.

" + }, + "UpdateSegment": { + "name": "UpdateSegment", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/segments/{segment-id}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateSegmentRequest" + }, + "output": { + "shape": "UpdateSegmentResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.

" + }, + "UpdateSmsChannel": { + "name": "UpdateSmsChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/sms", + "responseCode": 200 + }, + "input": { + "shape": "UpdateSmsChannelRequest" + }, + "output": { + "shape": "UpdateSmsChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.

" + }, + "UpdateSmsTemplate": { + "name": "UpdateSmsTemplate", + "http": { + "method": "PUT", + "requestUri": "/v1/templates/{template-name}/sms", + "responseCode": 202 + }, + "input": { + "shape": "UpdateSmsTemplateRequest" + }, + "output": { + "shape": "UpdateSmsTemplateResponse", + "documentation": "

The request was accepted for processing. Processing may not be complete.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Updates an existing message template that you can use in messages that are sent through the SMS channel.

" + }, + "UpdateVoiceChannel": { + "name": "UpdateVoiceChannel", + "http": { + "method": "PUT", + "requestUri": "/v1/apps/{application-id}/channels/voice", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVoiceChannelRequest" + }, + "output": { + "shape": "UpdateVoiceChannelResponse", + "documentation": "

The request succeeded.

" + }, + "errors": [ + { + "shape": "BadRequestException", + "documentation": "

The request contains a syntax error (BadRequestException).

" + }, + { + "shape": "InternalServerErrorException", + "documentation": "

The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

" + }, + { + "shape": "ForbiddenException", + "documentation": "

The request was denied because access to the specified resource is forbidden (ForbiddenException).

" + }, + { + "shape": "NotFoundException", + "documentation": "

The request failed because the specified resource was not found (NotFoundException).

" + }, + { + "shape": "MethodNotAllowedException", + "documentation": "

The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).

" + }, + { + "shape": "TooManyRequestsException", + "documentation": "

The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).

" + } + ], + "documentation": "

Enables the voice channel for an application or updates the status and settings of the voice channel for an application.

" + } + }, + "shapes": { + "ADMChannelRequest": { + "type": "structure", + "members": { + "ClientId": { + "shape": "__string", + "documentation": "

The Client ID that you received from Amazon to send messages by using ADM.

" + }, + "ClientSecret": { + "shape": "__string", + "documentation": "

The Client Secret that you received from Amazon to send messages by using ADM.

" + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

Specifies whether to enable the ADM channel for the application.

" + } + }, + "documentation": "

Specifies the status and settings of the ADM (Amazon Device Messaging) channel for an application.

", + "required": [ + "ClientSecret", + "ClientId" + ] + }, + "ADMChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

The unique identifier for the application that the ADM channel applies to.

" + }, + "CreationDate": { + "shape": "__string", + "documentation": "

The date and time when the ADM channel was enabled.

" + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

Specifies whether the ADM channel is enabled for the application.

" + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

(Not used) This property is retained only for backward compatibility.

" + }, + "Id": { + "shape": "__string", + "documentation": "

(Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.

" + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

Specifies whether the ADM channel is archived.

" + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

The user who last modified the ADM channel.

" + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

The date and time when the ADM channel was last modified.

" + }, + "Platform": { + "shape": "__string", + "documentation": "

The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.

" + }, + "Version": { + "shape": "__integer", + "documentation": "

The current version of the ADM channel.

" + } + }, + "documentation": "

Provides information about the status and settings of the ADM (Amazon Device Messaging) channel for an application.

", + "required": [ + "Platform" + ] + }, + "ADMMessage": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

" + }, + "Body": { + "shape": "__string", + "documentation": "

The body of the notification message.

" + }, + "ConsolidationKey": { + "shape": "__string", + "documentation": "

An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.

" + }, + "Data": { + "shape": "MapOf__string", + "documentation": "

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

" + }, + "ExpiresAfter": { + "shape": "__string", + "documentation": "

The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.

" + }, + "IconReference": { + "shape": "__string", + "documentation": "

The icon image name of the asset saved in your app.

" + }, + "ImageIconUrl": { + "shape": "__string", + "documentation": "

The URL of the large icon image to display in the content view of the push notification.

" + }, + "ImageUrl": { + "shape": "__string", + "documentation": "

The URL of an image to display in the push notification.

" + }, + "MD5": { + "shape": "__string", + "documentation": "

The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.

" + }, + "RawContent": { + "shape": "__string", + "documentation": "

The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

" + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

" + }, + "SmallImageIconUrl": { + "shape": "__string", + "documentation": "

The URL of the small icon image to display in the status bar and the content view of the push notification.

" + }, + "Sound": { + "shape": "__string", + "documentation": "

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

" + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

The default message variables to use in the notification message. You can override the default variables with individual address variables.

" + }, + "Title": { + "shape": "__string", + "documentation": "

The title to display above the notification message on the recipient's device.

" + }, + "Url": { + "shape": "__string", + "documentation": "

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

" + } + }, + "documentation": "

Specifies the settings for a one-time message that's sent directly to an endpoint through the ADM (Amazon Device Messaging) channel.

" + }, + "APNSChannelRequest": { + "type": "structure", + "members": { + "BundleId": { + "shape": "__string", + "documentation": "

The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

" + }, + "Certificate": { + "shape": "__string", + "documentation": "

The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

" + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

" + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

Specifies whether to enable the APNs channel for the application.

" + }, + "PrivateKey": { + "shape": "__string", + "documentation": "

The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

" + }, + "TeamId": { + "shape": "__string", + "documentation": "

The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

" + }, + "TokenKey": { + "shape": "__string", + "documentation": "

The authentication key to use for APNs tokens.

" + }, + "TokenKeyId": { + "shape": "__string", + "documentation": "

The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

" + } + }, + "documentation": "

Specifies the status and settings of the APNs (Apple Push Notification service) channel for an application.

" + }, + "APNSChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

The unique identifier for the application that the APNs channel applies to.

" + }, + "CreationDate": { + "shape": "__string", + "documentation": "

The date and time when the APNs channel was enabled.

" + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

" + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

Specifies whether the APNs channel is enabled for the application.

" + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

(Not used) This property is retained only for backward compatibility.

" + }, + "HasTokenKey": { + "shape": "__boolean", + "documentation": "

Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

" + }, + "Id": { + "shape": "__string", + "documentation": "

(Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.

" + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

Specifies whether the APNs channel is archived.

" + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

The user who last modified the APNs channel.

" + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

The date and time when the APNs channel was last modified.

" + }, + "Platform": { + "shape": "__string", + "documentation": "

The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.

" + }, + "Version": { + "shape": "__integer", + "documentation": "

The current version of the APNs channel.

" + } + }, + "documentation": "

Provides information about the status and settings of the APNs (Apple Push Notification service) channel for an application.

", + "required": [ + "Platform" + ] + }, + "APNSMessage": { + "type": "structure", + "members": { + "APNSPushType": { + "shape": "__string", + "documentation": "

The type of push notification to send. Valid values are:

  • alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification.

  • background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices.

  • complication - For a notification that contains update information for an app’s complication timeline.

  • fileprovider - For a notification that signals changes to a File Provider extension.

  • mdm - For a notification that tells managed devices to contact the MDM server.

  • voip - For a notification that provides information about an incoming VoIP call.

Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message.

For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.

" + }, + "Action": { + "shape": "Action", + "documentation": "

The action to occur if the recipient taps the push notification. Valid values are:

  • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

  • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

  • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

" + }, + "Badge": { + "shape": "__integer", + "documentation": "

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

" + }, + "Body": { + "shape": "__string", + "documentation": "

The body of the notification message.

" + }, + "Category": { + "shape": "__string", + "documentation": "

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

" + }, + "CollapseId": { + "shape": "__string", + "documentation": "

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

" + }, + "Data": { + "shape": "MapOf__string", + "documentation": "

The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

" + }, + "MediaUrl": { + "shape": "__string", + "documentation": "

The URL of an image or video to display in the push notification.

" + }, + "PreferredAuthenticationMethod": { + "shape": "__string", + "documentation": "

The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.

" + }, + "Priority": { + "shape": "__string", + "documentation": "

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem>

  • 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

    • /para>

    Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

    The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides all other content for the message.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    " + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

    Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center.

    Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background.

    If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.

    Apple has indicated that they will throttle \"excessive\" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the notification message. You can override these default variables with individual address variables.

    " + }, + "ThreadId": { + "shape": "__string", + "documentation": "

    The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

    " + }, + "TimeToLive": { + "shape": "__integer", + "documentation": "

    The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to display above the notification message on the recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

    " + }, + "APNSPushNotificationTemplate": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The message body to use in push notifications that are based on the message template.

    " + }, + "MediaUrl": { + "shape": "__string", + "documentation": "

    The URL of an image or video to display in push notifications that are based on the message template.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

    " + }, + "APNSSandboxChannelRequest": { + "type": "structure", + "members": { + "BundleId": { + "shape": "__string", + "documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " + }, + "Certificate": { + "shape": "__string", + "documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the APNs sandbox channel for the application.

    " + }, + "PrivateKey": { + "shape": "__string", + "documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " + }, + "TeamId": { + "shape": "__string", + "documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + }, + "TokenKey": { + "shape": "__string", + "documentation": "

    The authentication key to use for APNs tokens.

    " + }, + "TokenKeyId": { + "shape": "__string", + "documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " + } + }, + "documentation": "

    Specifies the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

    " + }, + "APNSSandboxChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the APNs sandbox channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs sandbox channel was enabled.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs sandbox channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "HasTokenKey": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs sandbox channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the APNs sandbox channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs sandbox channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the APNs sandbox channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the APNs (Apple Push Notification service) sandbox channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "APNSVoipChannelRequest": { + "type": "structure", + "members": { + "BundleId": { + "shape": "__string", + "documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " + }, + "Certificate": { + "shape": "__string", + "documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the APNs VoIP channel for the application.

    " + }, + "PrivateKey": { + "shape": "__string", + "documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.

    " + }, + "TeamId": { + "shape": "__string", + "documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + }, + "TokenKey": { + "shape": "__string", + "documentation": "

    The authentication key to use for APNs tokens.

    " + }, + "TokenKeyId": { + "shape": "__string", + "documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

    " + } + }, + "documentation": "

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

    " + }, + "APNSVoipChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the APNs VoIP channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs VoIP channel was enabled.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "HasTokenKey": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the APNs VoIP channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs VoIP channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the APNs VoIP channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "APNSVoipSandboxChannelRequest": { + "type": "structure", + "members": { + "BundleId": { + "shape": "__string", + "documentation": "

    The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.

    " + }, + "Certificate": { + "shape": "__string", + "documentation": "

    The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    " + }, + "PrivateKey": { + "shape": "__string", + "documentation": "

    The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.

    " + }, + "TeamId": { + "shape": "__string", + "documentation": "

    The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.

    " + }, + "TokenKey": { + "shape": "__string", + "documentation": "

    The authentication key to use for APNs tokens.

    " + }, + "TokenKeyId": { + "shape": "__string", + "documentation": "

    The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.

    " + } + }, + "documentation": "

    Specifies the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

    " + }, + "APNSVoipSandboxChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the APNs VoIP sandbox channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs VoIP sandbox channel was enabled.

    " + }, + "DefaultAuthenticationMethod": { + "shape": "__string", + "documentation": "

    The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP sandbox channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "HasTokenKey": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the APNs VoIP sandbox channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the APNs VoIP sandbox channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the APNs VoIP sandbox channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the APNs VoIP sandbox channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP sandbox channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "Action": { + "type": "string", + "enum": [ + "OPEN_APP", + "DEEP_LINK", + "URL" + ] + }, + "ActivitiesResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfActivityResponse", + "documentation": "

    An array of responses, one for each activity that was performed by the campaign.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about the activities that were performed by a campaign.

    ", + "required": [ + "Item" + ] + }, + "Activity": { + "type": "structure", + "members": { + "ConditionalSplit": { + "shape": "ConditionalSplitActivity", + "documentation": "

    The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    " + }, + "Description": { + "shape": "__string", + "documentation": "

    The custom description of the activity.

    " + }, + "EMAIL": { + "shape": "EmailMessageActivity", + "documentation": "

    The settings for an email activity. This type of activity sends an email message to participants.

    " + }, + "Holdout": { + "shape": "HoldoutActivity", + "documentation": "

    The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.

    " + }, + "MultiCondition": { + "shape": "MultiConditionalSplitActivity", + "documentation": "

    The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.

    " + }, + "RandomSplit": { + "shape": "RandomSplitActivity", + "documentation": "

    The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

    " + }, + "Wait": { + "shape": "WaitActivity", + "documentation": "

    The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    " + } + }, + "documentation": "

    Specifies the configuration and other settings for an activity in a journey.

    " + }, + "ActivityResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the campaign applies to.

    " + }, + "CampaignId": { + "shape": "__string", + "documentation": "

    The unique identifier for the campaign that the activity applies to.

    " + }, + "End": { + "shape": "__string", + "documentation": "

    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the activity.

    " + }, + "Result": { + "shape": "__string", + "documentation": "

    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

    " + }, + "ScheduledStart": { + "shape": "__string", + "documentation": "

    The scheduled start time, in ISO 8601 format, for the activity.

    " + }, + "Start": { + "shape": "__string", + "documentation": "

    The actual start time, in ISO 8601 format, of the activity.

    " + }, + "State": { + "shape": "__string", + "documentation": "

    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

    " + }, + "SuccessfulEndpointCount": { + "shape": "__integer", + "documentation": "

    The total number of endpoints that the campaign successfully delivered messages to.

    " + }, + "TimezonesCompletedCount": { + "shape": "__integer", + "documentation": "

    The total number of time zones that were completed.

    " + }, + "TimezonesTotalCount": { + "shape": "__integer", + "documentation": "

    The total number of unique time zones that are in the segment for the campaign.

    " + }, + "TotalEndpointCount": { + "shape": "__integer", + "documentation": "

    The total number of endpoints that the campaign attempted to deliver messages to.

    " + }, + "TreatmentId": { + "shape": "__string", + "documentation": "

    The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    " + } + }, + "documentation": "

    Provides information about an activity that was performed by a campaign.

    ", + "required": [ + "CampaignId", + "Id", + "ApplicationId" + ] + }, + "AddressConfiguration": { + "type": "structure", + "members": { + "BodyOverride": { + "shape": "__string", + "documentation": "

    The message body to use instead of the default message body. This value overrides the default message body.

    " + }, + "ChannelType": { + "shape": "ChannelType", + "documentation": "

    The channel to use when sending the message.

    " + }, + "Context": { + "shape": "MapOf__string", + "documentation": "

    An object that maps custom attributes to attributes for the address and is attached to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    An object that maps variable values for the message. Amazon Pinpoint merges these values with the variable values specified by properties of the DefaultMessage object. The substitutions in this map take precedence over all other substitutions.

    " + }, + "TitleOverride": { + "shape": "__string", + "documentation": "

    The message title to use instead of the default message title. This value overrides the default message title.

    " + } + }, + "documentation": "

    Specifies address-based configuration settings for a message that's sent directly to an endpoint.

    " + }, + "AndroidPushNotificationTemplate": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The message body to use in a push notification that's based on the message template.

    " + }, + "ImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the large icon image to display in the content view of a push notification that's based on the message template.

    " + }, + "ImageUrl": { + "shape": "__string", + "documentation": "

    The URL of an image to display in a push notification that's based on the message template.

    " + }, + "SmallImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps a a push notification that's based on the message template and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

    " + }, + "ApplicationDateRangeKpiResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the metric applies to.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + }, + "KpiName": { + "shape": "__string", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    " + }, + "KpiResult": { + "shape": "BaseKpiResult", + "documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard metric that applies to an application, and provides information about that query.

    ", + "required": [ + "KpiResult", + "KpiName", + "EndTime", + "StartTime", + "ApplicationId" + ] + }, + "ApplicationResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Provides information about an application.

    ", + "required": [ + "Id", + "Arn", + "Name" + ] + }, + "ApplicationSettingsResource": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignHook": { + "shape": "CampaignHook", + "documentation": "

    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the application's settings were last modified.

    " + }, + "Limits": { + "shape": "CampaignLimits", + "documentation": "

    The default sending limits for campaigns in the application.

    " + }, + "QuietTime": { + "shape": "QuietTime", + "documentation": "

    The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    " + } + }, + "documentation": "

    Provides information about an application, including the default settings for an application.

    ", + "required": [ + "ApplicationId" + ] + }, + "ApplicationsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfApplicationResponse", + "documentation": "

    An array of responses, one for each application that was returned.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about all of your applications.

    " + }, + "AttributeDimension": { + "type": "structure", + "members": { + "AttributeType": { + "shape": "AttributeType", + "documentation": "

    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

    " + }, + "Values": { + "shape": "ListOf__string", + "documentation": "

    The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.

    " + } + }, + "documentation": "

    Specifies attribute-based criteria for including or excluding endpoints from a segment.

    ", + "required": [ + "Values" + ] + }, + "AttributeType": { + "type": "string", + "enum": [ + "INCLUSIVE", + "EXCLUSIVE" + ] + }, + "AttributesResource": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application.

    " + }, + "AttributeType": { + "shape": "__string", + "documentation": "

    The type of attribute or attributes that were removed from the endpoints. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints.

    • endpoint-user-attributes - Custom attributes that describe users.

    " + }, + "Attributes": { + "shape": "ListOf__string", + "documentation": "

    An array that specifies the names of the attributes that were removed from the endpoints.

    " + } + }, + "documentation": "

    Provides information about the type and the names of attributes that were removed from all the endpoints that are associated with an application.

    ", + "required": [ + "AttributeType", + "ApplicationId" + ] + }, + "BadRequestException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 400 + } + }, + "BaiduChannelRequest": { + "type": "structure", + "members": { + "ApiKey": { + "shape": "__string", + "documentation": "

    The API key that you received from the Baidu Cloud Push service to communicate with the service.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the Baidu channel for the application.

    " + }, + "SecretKey": { + "shape": "__string", + "documentation": "

    The secret key that you received from the Baidu Cloud Push service to communicate with the service.

    " + } + }, + "documentation": "

    Specifies the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

    ", + "required": [ + "SecretKey", + "ApiKey" + ] + }, + "BaiduChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the Baidu channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the Baidu channel was enabled.

    " + }, + "Credential": { + "shape": "__string", + "documentation": "

    The API key that you received from the Baidu Cloud Push service to communicate with the service.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the Baidu channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the Baidu channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the Baidu channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the Baidu channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the Baidu channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the Baidu (Baidu Cloud Push) channel for an application.

    ", + "required": [ + "Credential", + "Platform" + ] + }, + "BaiduMessage": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The body of the notification message.

    " + }, + "Data": { + "shape": "MapOf__string", + "documentation": "

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " + }, + "IconReference": { + "shape": "__string", + "documentation": "

    The icon image name of the asset saved in your app.

    " + }, + "ImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " + }, + "ImageUrl": { + "shape": "__string", + "documentation": "

    The URL of an image to display in the push notification.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

    " + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " + }, + "SmallImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " + }, + "TimeToLive": { + "shape": "__integer", + "documentation": "

    The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to display above the notification message on the recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

    " + }, + "BaseKpiResult": { + "type": "structure", + "members": { + "Rows": { + "shape": "ListOfResultRow", + "documentation": "

    An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

    ", + "required": [ + "Rows" + ] + }, + "CampaignDateRangeKpiResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the metric applies to.

    " + }, + "CampaignId": { + "shape": "__string", + "documentation": "

    The unique identifier for the campaign that the metric applies to.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + }, + "KpiName": { + "shape": "__string", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    " + }, + "KpiResult": { + "shape": "BaseKpiResult", + "documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard metric that applies to a campaign, and provides information about that query.

    ", + "required": [ + "KpiResult", + "KpiName", + "EndTime", + "CampaignId", + "StartTime", + "ApplicationId" + ] + }, + "CampaignEmailMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The body of the email for recipients whose email clients don't support HTML content.

    " + }, + "FromAddress": { + "shape": "__string", + "documentation": "

    The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.

    " + }, + "HtmlBody": { + "shape": "__string", + "documentation": "

    The body of the email, in HTML format, for recipients whose email clients support HTML content.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The subject line, or title, of the email.

    " + } + }, + "documentation": "

    Specifies the content and \"From\" address for an email message that's sent to recipients of a campaign.

    ", + "required": [ + "Title" + ] + }, + "CampaignEventFilter": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "EventDimensions", + "documentation": "

    The dimension settings of the event filter for the campaign.

    " + }, + "FilterType": { + "shape": "FilterType", + "documentation": "

    The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.

    " + } + }, + "documentation": "

    Specifies the settings for events that cause a campaign to be sent.

    ", + "required": [ + "FilterType", + "Dimensions" + ] + }, + "CampaignHook": { + "type": "structure", + "members": { + "LambdaFunctionName": { + "shape": "__string", + "documentation": "

    The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to send messages for a campaign.

    " + }, + "Mode": { + "shape": "Mode", + "documentation": "

    Specifies which Lambda mode to use when invoking the AWS Lambda function.

    " + }, + "WebUrl": { + "shape": "__string", + "documentation": "

    The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.

    " + } + }, + "documentation": "

    Specifies the AWS Lambda function to use as a code hook for a campaign.

    " + }, + "CampaignLimits": { + "type": "structure", + "members": { + "Daily": { + "shape": "__integer", + "documentation": "

    The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. The maximum value is 100.

    " + }, + "MaximumDuration": { + "shape": "__integer", + "documentation": "

    The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.

    " + }, + "MessagesPerSecond": { + "shape": "__integer", + "documentation": "

    The maximum number of messages that a campaign can send each second. The minimum value is 50. The maximum value is 20,000.

    " + }, + "Total": { + "shape": "__integer", + "documentation": "

    The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. The maximum value is 100.

    " + } + }, + "documentation": "

    Specifies limits on the messages that a campaign can send.

    " + }, + "CampaignResponse": { + "type": "structure", + "members": { + "AdditionalTreatments": { + "shape": "ListOfTreatmentResource", + "documentation": "

    An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.

    " + }, + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the campaign applies to.

    " + }, + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the campaign.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date, ISO 8601 format, when the campaign was created.

    " + }, + "DefaultState": { + "shape": "CampaignState", + "documentation": "

    The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment, to support A/B testing.

    " + }, + "Description": { + "shape": "__string", + "documentation": "

    The custom description of the campaign.

    " + }, + "HoldoutPercent": { + "shape": "__integer", + "documentation": "

    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    " + }, + "Hook": { + "shape": "CampaignHook", + "documentation": "

    The settings for the AWS Lambda function to use as a code hook for the campaign.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "IsPaused": { + "shape": "__boolean", + "documentation": "

    Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the campaign was last modified.

    " + }, + "Limits": { + "shape": "CampaignLimits", + "documentation": "

    The messaging limits for the campaign.

    " + }, + "MessageConfiguration": { + "shape": "MessageConfiguration", + "documentation": "

    The message configuration settings for the campaign.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The name of the campaign.

    " + }, + "Schedule": { + "shape": "Schedule", + "documentation": "

    The schedule settings for the campaign.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The unique identifier for the segment that's associated with the campaign.

    " + }, + "SegmentVersion": { + "shape": "__integer", + "documentation": "

    The version number of the segment that's associated with the campaign.

    " + }, + "State": { + "shape": "CampaignState", + "documentation": "

    The current status of the campaign.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template that’s used for the campaign.

    " + }, + "TreatmentDescription": { + "shape": "__string", + "documentation": "

    The custom description of a variation of the campaign that's used for A/B testing.

    " + }, + "TreatmentName": { + "shape": "__string", + "documentation": "

    The custom name of a variation of the campaign that's used for A/B testing.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The version number of the campaign.

    " + } + }, + "documentation": "

    Provides information about the status, configuration, and other settings for a campaign.

    ", + "required": [ + "LastModifiedDate", + "CreationDate", + "SegmentId", + "SegmentVersion", + "Id", + "Arn", + "ApplicationId" + ] + }, + "CampaignSmsMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The body of the SMS message.

    " + }, + "MessageType": { + "shape": "MessageType", + "documentation": "

    The type of SMS message. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message isn't critical or time-sensitive, such as a marketing message.

    " + }, + "SenderId": { + "shape": "__string", + "documentation": "

    The sender ID to display on recipients' devices when they receive the SMS message.

    " + } + }, + "documentation": "

    Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

    " + }, + "CampaignState": { + "type": "structure", + "members": { + "CampaignStatus": { + "shape": "CampaignStatus", + "documentation": "

    The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED.

    " + } + }, + "documentation": "

    Provides information about the status of a campaign.

    " + }, + "CampaignStatus": { + "type": "string", + "enum": [ + "SCHEDULED", + "EXECUTING", + "PENDING_NEXT_RUN", + "COMPLETED", + "PAUSED", + "DELETED" + ] + }, + "CampaignsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfCampaignResponse", + "documentation": "

    An array of responses, one for each campaign that's associated with the application.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about the configuration and other settings for all the campaigns that are associated with an application.

    ", + "required": [ + "Item" + ] + }, + "ChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the channel was enabled.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the channel was last modified.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the channel.

    " + } + }, + "documentation": "

    Provides information about the general settings and status of a channel for an application.

    " + }, + "ChannelType": { + "type": "string", + "enum": [ + "GCM", + "APNS", + "APNS_SANDBOX", + "APNS_VOIP", + "APNS_VOIP_SANDBOX", + "ADM", + "SMS", + "VOICE", + "EMAIL", + "BAIDU", + "CUSTOM" + ] + }, + "ChannelsResponse": { + "type": "structure", + "members": { + "Channels": { + "shape": "MapOfChannelResponse", + "documentation": "

    A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.

    " + } + }, + "documentation": "

    Provides information about the general settings and status of all channels for an application, including channels that aren't enabled for the application.

    ", + "required": [ + "Channels" + ] + }, + "Condition": { + "type": "structure", + "members": { + "Conditions": { + "shape": "ListOfSimpleCondition", + "documentation": "

    The conditions to evaluate for the activity.

    " + }, + "Operator": { + "shape": "Operator", + "documentation": "

    Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.

    " + } + }, + "documentation": "

    Specifies the conditions to evaluate for an activity in a journey, and how to evaluate those conditions.

    " + }, + "ConditionalSplitActivity": { + "type": "structure", + "members": { + "Condition": { + "shape": "Condition", + "documentation": "

    The conditions that define the paths for the activity, and the relationship between the conditions.

    " + }, + "EvaluationWaitTime": { + "shape": "WaitTime", + "documentation": "

    The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.

    " + }, + "FalseActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the activity to perform if the condition isn't met.

    " + }, + "TrueActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the activity to perform if the condition is met.

    " + } + }, + "documentation": "

    Specifies the settings for a yes/no split activity in a journey. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.

    " + }, + "CreateAppRequest": { + "type": "structure", + "members": { + "CreateApplicationRequest": { + "shape": "CreateApplicationRequest" + } + }, + "required": [ + "CreateApplicationRequest" + ], + "payload": "CreateApplicationRequest" + }, + "CreateAppResponse": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "ApplicationResponse" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + }, + "CreateApplicationRequest": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "documentation": "

    The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Specifies the display name of an application and the tags to associate with the application.

    ", + "required": [ + "Name" + ] + }, + "CreateCampaignRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "WriteCampaignRequest": { + "shape": "WriteCampaignRequest" + } + }, + "required": [ + "ApplicationId", + "WriteCampaignRequest" + ], + "payload": "WriteCampaignRequest" + }, + "CreateCampaignResponse": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "CampaignResponse" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + }, + "CreateEmailTemplateRequest": { + "type": "structure", + "members": { + "EmailTemplateRequest": { + "shape": "EmailTemplateRequest", + "documentation": "

    Creates a new message template that you can use in messages that are sent through the email channel.

    " + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "EmailTemplateRequest" + ], + "payload": "EmailTemplateRequest" + }, + "CreateEmailTemplateResponse": { + "type": "structure", + "members": { + "CreateTemplateMessageBody": { + "shape": "CreateTemplateMessageBody" + } + }, + "required": [ + "CreateTemplateMessageBody" + ], + "payload": "CreateTemplateMessageBody" + }, + "CreateExportJobRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "ExportJobRequest": { + "shape": "ExportJobRequest" + } + }, + "required": [ + "ApplicationId", + "ExportJobRequest" + ], + "payload": "ExportJobRequest" + }, + "CreateExportJobResponse": { + "type": "structure", + "members": { + "ExportJobResponse": { + "shape": "ExportJobResponse" + } + }, + "required": [ + "ExportJobResponse" + ], + "payload": "ExportJobResponse" + }, + "CreateImportJobRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "ImportJobRequest": { + "shape": "ImportJobRequest" + } + }, + "required": [ + "ApplicationId", + "ImportJobRequest" + ], + "payload": "ImportJobRequest" + }, + "CreateImportJobResponse": { + "type": "structure", + "members": { + "ImportJobResponse": { + "shape": "ImportJobResponse" + } + }, + "required": [ + "ImportJobResponse" + ], + "payload": "ImportJobResponse" + }, + "CreateJourneyRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "WriteJourneyRequest": { + "shape": "WriteJourneyRequest" + } + }, + "required": [ + "ApplicationId", + "WriteJourneyRequest" + ], + "payload": "WriteJourneyRequest" + }, + "CreateJourneyResponse": { + "type": "structure", + "members": { + "JourneyResponse": { + "shape": "JourneyResponse" + } + }, + "required": [ + "JourneyResponse" + ], + "payload": "JourneyResponse" + }, + "CreatePushTemplateRequest": { + "type": "structure", + "members": { + "PushNotificationTemplateRequest": { + "shape": "PushNotificationTemplateRequest", + "documentation": "

    Creates a message template that you can use in messages that are sent through a push notification channel.

    " + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "PushNotificationTemplateRequest" + ], + "payload": "PushNotificationTemplateRequest" + }, + "CreatePushTemplateResponse": { + "type": "structure", + "members": { + "CreateTemplateMessageBody": { + "shape": "CreateTemplateMessageBody" + } + }, + "required": [ + "CreateTemplateMessageBody" + ], + "payload": "CreateTemplateMessageBody" + }, + "CreateSegmentRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "WriteSegmentRequest": { + "shape": "WriteSegmentRequest" + } + }, + "required": [ + "ApplicationId", + "WriteSegmentRequest" + ], + "payload": "WriteSegmentRequest" + }, + "CreateSegmentResponse": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "SegmentResponse" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + }, + "CreateSmsTemplateRequest": { + "type": "structure", + "members": { + "SMSTemplateRequest": { + "shape": "SMSTemplateRequest", + "documentation": "

    Creates a message template that you can use in messages that are sent through the SMS channel.

    " + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "SMSTemplateRequest" + ], + "payload": "SMSTemplateRequest" + }, + "CreateSmsTemplateResponse": { + "type": "structure", + "members": { + "CreateTemplateMessageBody": { + "shape": "CreateTemplateMessageBody" + } + }, + "required": [ + "CreateTemplateMessageBody" + ], + "payload": "CreateTemplateMessageBody" + }, + "CreateTemplateMessageBody": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the message template that was created.

    " + }, + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API for the request to create the message template.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request to create the message template.

    " + } + }, + "documentation": "

    Provides information about a request to create a message template.

    " + }, + "DefaultMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The default message body of the push notification, email, or SMS message.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the push notification, email, or SMS message. You can override these default variables with individual address variables.

    " + } + }, + "documentation": "

    Specifies the default message to use for all channels.

    " + }, + "DefaultPushNotificationMessage": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The default action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The default body of the notification message.

    " + }, + "Data": { + "shape": "MapOf__string", + "documentation": "

    The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

    Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The default title to display above the notification message on a recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the default settings and content for a push notification that's sent directly to an endpoint.

    " + }, + "DefaultPushNotificationTemplate": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if a recipient taps a push notification that's based on the message template. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The message body to use in push notifications that are based on the message template.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

    " + }, + "DeleteAdmChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteAdmChannelResponse": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "ADMChannelResponse" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + }, + "DeleteApnsChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteApnsChannelResponse": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "APNSChannelResponse" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + }, + "DeleteApnsSandboxChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteApnsSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "APNSSandboxChannelResponse" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + }, + "DeleteApnsVoipChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteApnsVoipChannelResponse": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "APNSVoipChannelResponse" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + }, + "DeleteApnsVoipSandboxChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteApnsVoipSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "APNSVoipSandboxChannelResponse" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + }, + "DeleteAppRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteAppResponse": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "ApplicationResponse" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + }, + "DeleteBaiduChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteBaiduChannelResponse": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "BaiduChannelResponse" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + }, + "DeleteCampaignRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + } + }, + "required": [ + "CampaignId", + "ApplicationId" + ] + }, + "DeleteCampaignResponse": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "CampaignResponse" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + }, + "DeleteEmailChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteEmailChannelResponse": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "EmailChannelResponse" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + }, + "DeleteEmailTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "DeleteEmailTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "DeleteEndpointRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndpointId": { + "shape": "__string", + "location": "uri", + "locationName": "endpoint-id", + "documentation": "

    The unique identifier for the endpoint.

    " + } + }, + "required": [ + "ApplicationId", + "EndpointId" + ] + }, + "DeleteEndpointResponse": { + "type": "structure", + "members": { + "EndpointResponse": { + "shape": "EndpointResponse" + } + }, + "required": [ + "EndpointResponse" + ], + "payload": "EndpointResponse" + }, + "DeleteEventStreamRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteEventStreamResponse": { + "type": "structure", + "members": { + "EventStream": { + "shape": "EventStream" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + }, + "DeleteGcmChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteGcmChannelResponse": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "GCMChannelResponse" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + }, + "DeleteJourneyRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + } + }, + "required": [ + "JourneyId", + "ApplicationId" + ] + }, + "DeleteJourneyResponse": { + "type": "structure", + "members": { + "JourneyResponse": { + "shape": "JourneyResponse" + } + }, + "required": [ + "JourneyResponse" + ], + "payload": "JourneyResponse" + }, + "DeletePushTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "DeletePushTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "DeleteSegmentRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "DeleteSegmentResponse": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "SegmentResponse" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + }, + "DeleteSmsChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteSmsChannelResponse": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "SMSChannelResponse" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + }, + "DeleteSmsTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "DeleteSmsTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "DeleteUserEndpointsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "UserId": { + "shape": "__string", + "location": "uri", + "locationName": "user-id", + "documentation": "

    The unique identifier for the user.

    " + } + }, + "required": [ + "ApplicationId", + "UserId" + ] + }, + "DeleteUserEndpointsResponse": { + "type": "structure", + "members": { + "EndpointsResponse": { + "shape": "EndpointsResponse" + } + }, + "required": [ + "EndpointsResponse" + ], + "payload": "EndpointsResponse" + }, + "DeleteVoiceChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "DeleteVoiceChannelResponse": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "VoiceChannelResponse" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + }, + "DeliveryStatus": { + "type": "string", + "enum": [ + "SUCCESSFUL", + "THROTTLED", + "TEMPORARY_FAILURE", + "PERMANENT_FAILURE", + "UNKNOWN_FAILURE", + "OPT_OUT", + "DUPLICATE" + ] + }, + "DimensionType": { + "type": "string", + "enum": [ + "INCLUSIVE", + "EXCLUSIVE" + ] + }, + "DirectMessageConfiguration": { + "type": "structure", + "members": { + "ADMMessage": { + "shape": "ADMMessage", + "documentation": "

    The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " + }, + "APNSMessage": { + "shape": "APNSMessage", + "documentation": "

    The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " + }, + "BaiduMessage": { + "shape": "BaiduMessage", + "documentation": "

    The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " + }, + "DefaultMessage": { + "shape": "DefaultMessage", + "documentation": "

    The default message body for all channels.

    " + }, + "DefaultPushNotificationMessage": { + "shape": "DefaultPushNotificationMessage", + "documentation": "

    The default push notification message for all push notification channels.

    " + }, + "EmailMessage": { + "shape": "EmailMessage", + "documentation": "

    The default message for the email channel. This message overrides the default message (DefaultMessage).

    " + }, + "GCMMessage": { + "shape": "GCMMessage", + "documentation": "

    The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).

    " + }, + "SMSMessage": { + "shape": "SMSMessage", + "documentation": "

    The default message for the SMS channel. This message overrides the default message (DefaultMessage).

    " + }, + "VoiceMessage": { + "shape": "VoiceMessage", + "documentation": "

    The default message for the voice channel. This message overrides the default message (DefaultMessage).

    " + } + }, + "documentation": "

    Specifies the settings and content for the default message and any default messages that you tailored for specific channels.

    " + }, + "Duration": { + "type": "string", + "enum": [ + "HR_24", + "DAY_7", + "DAY_14", + "DAY_30" + ] + }, + "EmailChannelRequest": { + "type": "structure", + "members": { + "ConfigurationSet": { + "shape": "__string", + "documentation": "

    The configuration set that you want to apply to email that you send through the channel by using the Amazon Pinpoint Email API.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the email channel for the application.

    " + }, + "FromAddress": { + "shape": "__string", + "documentation": "

    The verified email address that you want to send email from when you send email through the channel.

    " + }, + "Identity": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

    " + } + }, + "documentation": "

    Specifies the status and settings of the email channel for an application.

    ", + "required": [ + "FromAddress", + "Identity" + ] + }, + "EmailChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the email channel applies to.

    " + }, + "ConfigurationSet": { + "shape": "__string", + "documentation": "

    The configuration set that's applied to email that's sent through the channel by using the Amazon Pinpoint Email API.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the email channel was enabled.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the email channel is enabled for the application.

    " + }, + "FromAddress": { + "shape": "__string", + "documentation": "

    The verified email address that you send email from when you send email through the channel.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.

    " + }, + "Identity": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you use when you send email through the channel.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the email channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the email channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the email channel was last modified.

    " + }, + "MessagesPerSecond": { + "shape": "__integer", + "documentation": "

    The maximum number of emails that you can send through the channel each second.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the email channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the email channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "EmailMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The body of the email message.

    " + }, + "FeedbackForwardingAddress": { + "shape": "__string", + "documentation": "

    The email address to forward bounces and complaints to, if feedback forwarding is enabled.

    " + }, + "FromAddress": { + "shape": "__string", + "documentation": "

    The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.

    " + }, + "RawEmail": { + "shape": "RawEmail", + "documentation": "

    The email message, represented as a raw MIME message.

    " + }, + "ReplyToAddresses": { + "shape": "ListOf__string", + "documentation": "

    The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.

    " + }, + "SimpleEmail": { + "shape": "SimpleEmail", + "documentation": "

    The email message, composed of a subject, a text part, and an HTML part.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the email message. You can override the default variables with individual address variables.

    " + } + }, + "documentation": "

    Specifies the default settings and content for a one-time email message that's sent directly to an endpoint.

    " + }, + "EmailMessageActivity": { + "type": "structure", + "members": { + "MessageConfig": { + "shape": "JourneyEmailMessage", + "documentation": "

    The \"From\" address to use for the message.

    " + }, + "NextActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the next activity to perform, after the message is sent.

    " + }, + "TemplateName": { + "shape": "__string", + "documentation": "

    The name of the email template to use for the message.

    " + } + }, + "documentation": "

    Specifies the settings for an email activity in a journey. This type of activity sends an email message to participants.

    " + }, + "EmailTemplateRequest": { + "type": "structure", + "members": { + "HtmlPart": { + "shape": "__string", + "documentation": "

    The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that support HTML. You can include links, formatted text, and more in an HTML message.

    " + }, + "Subject": { + "shape": "__string", + "documentation": "

    The subject line, or title, to use in email messages that are based on the message template.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TextPart": { + "shape": "__string", + "documentation": "

    The message body, in text format, to use in email messages that are based on the message template. We recommend using text format for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.

    " + } + }, + "documentation": "

    Specifies the content and settings for a message template that can be used in messages that are sent through the email channel.

    " + }, + "EmailTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date when the message template was created.

    " + }, + "HtmlPart": { + "shape": "__string", + "documentation": "

    The message body, in HTML format, that's used in email messages that are based on the message template.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date when the message template was last modified.

    " + }, + "Subject": { + "shape": "__string", + "documentation": "

    The subject line, or title, that's used in email messages that are based on the message template.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateName": { + "shape": "__string", + "documentation": "

    The name of the message template.

    " + }, + "TemplateType": { + "shape": "TemplateType", + "documentation": "

    The type of channel that the message template is designed for. For an email template, this value is EMAIL.

    " + }, + "TextPart": { + "shape": "__string", + "documentation": "

    The message body, in text format, that's used in email messages that are based on the message template.

    " + } + }, + "documentation": "

    Provides information about the content and settings for a message template that can be used in messages that are sent through the email channel.

    ", + "required": [ + "LastModifiedDate", + "CreationDate", + "TemplateName", + "TemplateType" + ] + }, + "EndpointBatchItem": { + "type": "structure", + "members": { + "Address": { + "shape": "__string", + "documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

    " + }, + "Attributes": { + "shape": "MapOfListOf__string", + "documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.

    When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

    " + }, + "ChannelType": { + "shape": "ChannelType", + "documentation": "

    The channel to use when sending messages or push notifications to the endpoint.

    " + }, + "Demographic": { + "shape": "EndpointDemographic", + "documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + }, + "EffectiveDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created or updated.

    " + }, + "EndpointStatus": { + "shape": "__string", + "documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the endpoint in the context of the batch.

    " + }, + "Location": { + "shape": "EndpointLocation", + "documentation": "

    The geographic information for the endpoint.

    " + }, + "Metrics": { + "shape": "MapOf__double", + "documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + }, + "OptOut": { + "shape": "__string", + "documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    The unique identifier for the request to create or update the endpoint.

    " + }, + "User": { + "shape": "EndpointUser", + "documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " + } + }, + "documentation": "

    Specifies an endpoint to create or update and the settings and attributes to set or change for the endpoint.

    " + }, + "EndpointBatchRequest": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfEndpointBatchItem", + "documentation": "

    An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.

    " + } + }, + "documentation": "

    Specifies a batch of endpoints to create or update and the settings and attributes to set or change for each endpoint.

    ", + "required": [ + "Item" + ] + }, + "EndpointDemographic": { + "type": "structure", + "members": { + "AppVersion": { + "shape": "__string", + "documentation": "

    The version of the app that's associated with the endpoint.

    " + }, + "Locale": { + "shape": "__string", + "documentation": "

    The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.

    " + }, + "Make": { + "shape": "__string", + "documentation": "

    The manufacturer of the endpoint device, such as Apple or Samsung.

    " + }, + "Model": { + "shape": "__string", + "documentation": "

    The model name or number of the endpoint device, such as iPhone.

    " + }, + "ModelVersion": { + "shape": "__string", + "documentation": "

    The model version of the endpoint device.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The platform of the endpoint device, such as iOS or Android.

    " + }, + "PlatformVersion": { + "shape": "__string", + "documentation": "

    The platform version of the endpoint device.

    " + }, + "Timezone": { + "shape": "__string", + "documentation": "

    The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.

    " + } + }, + "documentation": "

    Specifies demographic information about an endpoint, such as the applicable time zone and platform.

    " + }, + "EndpointItemResponse": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The custom message that's returned in the response as a result of processing the endpoint data.

    " + }, + "StatusCode": { + "shape": "__integer", + "documentation": "

    The status code that's returned in the response as a result of processing the endpoint data.

    " + } + }, + "documentation": "

    Provides the status code and message that result from processing data for an endpoint.

    " + }, + "EndpointLocation": { + "type": "structure", + "members": { + "City": { + "shape": "__string", + "documentation": "

    The name of the city where the endpoint is located.

    " + }, + "Country": { + "shape": "__string", + "documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.

    " + }, + "Latitude": { + "shape": "__double", + "documentation": "

    The latitude coordinate of the endpoint location, rounded to one decimal place.

    " + }, + "Longitude": { + "shape": "__double", + "documentation": "

    The longitude coordinate of the endpoint location, rounded to one decimal place.

    " + }, + "PostalCode": { + "shape": "__string", + "documentation": "

    The postal or ZIP code for the area where the endpoint is located.

    " + }, + "Region": { + "shape": "__string", + "documentation": "

    The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.

    " + } + }, + "documentation": "

    Specifies geographic information about an endpoint.

    " + }, + "EndpointMessageResult": { + "type": "structure", + "members": { + "Address": { + "shape": "__string", + "documentation": "

    The endpoint address that the message was delivered to.

    " + }, + "DeliveryStatus": { + "shape": "DeliveryStatus", + "documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    " + }, + "MessageId": { + "shape": "__string", + "documentation": "

    The unique identifier for the message that was sent.

    " + }, + "StatusCode": { + "shape": "__integer", + "documentation": "

    The downstream service status code for delivering the message.

    " + }, + "StatusMessage": { + "shape": "__string", + "documentation": "

    The status message for delivering the message.

    " + }, + "UpdatedToken": { + "shape": "__string", + "documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " + } + }, + "documentation": "

    Provides information about the delivery status and results of sending a message directly to an endpoint.

    ", + "required": [ + "DeliveryStatus", + "StatusCode" + ] + }, + "EndpointRequest": { + "type": "structure", + "members": { + "Address": { + "shape": "__string", + "documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.

    " + }, + "Attributes": { + "shape": "MapOfListOf__string", + "documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.

    When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

    " + }, + "ChannelType": { + "shape": "ChannelType", + "documentation": "

    The channel to use when sending messages or push notifications to the endpoint.

    " + }, + "Demographic": { + "shape": "EndpointDemographic", + "documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + }, + "EffectiveDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the endpoint is updated.

    " + }, + "EndpointStatus": { + "shape": "__string", + "documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + }, + "Location": { + "shape": "EndpointLocation", + "documentation": "

    The geographic information for the endpoint.

    " + }, + "Metrics": { + "shape": "MapOf__double", + "documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + }, + "OptOut": { + "shape": "__string", + "documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    The unique identifier for the most recent request to update the endpoint.

    " + }, + "User": { + "shape": "EndpointUser", + "documentation": "

    One or more custom user attributes that describe the user who's associated with the endpoint.

    " + } + }, + "documentation": "

    Specifies the channel type and other settings for an endpoint.

    " + }, + "EndpointResponse": { + "type": "structure", + "members": { + "Address": { + "shape": "__string", + "documentation": "

    The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.

    " + }, + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that's associated with the endpoint.

    " + }, + "Attributes": { + "shape": "MapOfListOf__string", + "documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.

    " + }, + "ChannelType": { + "shape": "ChannelType", + "documentation": "

    The channel that's used when sending messages or push notifications to the endpoint.

    " + }, + "CohortId": { + "shape": "__string", + "documentation": "

    A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the endpoint was created.

    " + }, + "Demographic": { + "shape": "EndpointDemographic", + "documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + }, + "EffectiveDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the endpoint was last updated.

    " + }, + "EndpointStatus": { + "shape": "__string", + "documentation": "

    Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.

    " + }, + "Location": { + "shape": "EndpointLocation", + "documentation": "

    The geographic information for the endpoint.

    " + }, + "Metrics": { + "shape": "MapOf__double", + "documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + }, + "OptOut": { + "shape": "__string", + "documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    The unique identifier for the most recent request to update the endpoint.

    " + }, + "User": { + "shape": "EndpointUser", + "documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " + } + }, + "documentation": "

    Provides information about the channel type and other settings for an endpoint.

    " + }, + "EndpointSendConfiguration": { + "type": "structure", + "members": { + "BodyOverride": { + "shape": "__string", + "documentation": "

    The body of the message. If specified, this value overrides the default message body.

    " + }, + "Context": { + "shape": "MapOf__string", + "documentation": "

    A map of custom attributes to attach to the message for the address. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides the message.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.

    " + }, + "TitleOverride": { + "shape": "__string", + "documentation": "

    The title or subject line of the message. If specified, this value overrides the default message title or subject line.

    " + } + }, + "documentation": "

    Specifies the content, including message variables and attributes, to use in a message that's sent directly to an endpoint.

    " + }, + "EndpointUser": { + "type": "structure", + "members": { + "UserAttributes": { + "shape": "MapOfListOf__string", + "documentation": "

    One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: [\"science\", \"music\", \"travel\"]. You can use these attributes as filter criteria when you create segments.

    When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This limitation doesn't apply to attribute values.

    " + }, + "UserId": { + "shape": "__string", + "documentation": "

    The unique identifier for the user.

    " + } + }, + "documentation": "

    Specifies data for one or more attributes that describe the user who's associated with an endpoint.

    " + }, + "EndpointsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfEndpointResponse", + "documentation": "

    An array of responses, one for each endpoint that's associated with the user ID.

    " + } + }, + "documentation": "

    Provides information about all the endpoints that are associated with a user ID.

    ", + "required": [ + "Item" + ] + }, + "Event": { + "type": "structure", + "members": { + "AppPackageName": { + "shape": "__string", + "documentation": "

    The package name of the app that's recording the event.

    " + }, + "AppTitle": { + "shape": "__string", + "documentation": "

    The title of the app that's recording the event.

    " + }, + "AppVersionCode": { + "shape": "__string", + "documentation": "

    The version number of the app that's recording the event.

    " + }, + "Attributes": { + "shape": "MapOf__string", + "documentation": "

    One or more custom attributes that are associated with the event.

    " + }, + "ClientSdkVersion": { + "shape": "__string", + "documentation": "

    The version of the SDK that's running on the client device.

    " + }, + "EventType": { + "shape": "__string", + "documentation": "

    The name of the event.

    " + }, + "Metrics": { + "shape": "MapOf__double", + "documentation": "

    One or more custom metrics that are associated with the event.

    " + }, + "SdkName": { + "shape": "__string", + "documentation": "

    The name of the SDK that's being used to record the event.

    " + }, + "Session": { + "shape": "Session", + "documentation": "

    Information about the session in which the event occurred.

    " + }, + "Timestamp": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the event occurred.

    " + } + }, + "documentation": "

    Specifies information about an event that reports data to Amazon Pinpoint.

    ", + "required": [ + "EventType", + "Timestamp" + ] + }, + "EventCondition": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "EventDimensions", + "documentation": "

    The dimensions for the event filter to use for the activity.

    " + }, + "MessageActivity": { + "shape": "__string", + "documentation": "

    The message identifier (message_id) for the message to use when determining whether message events meet the condition.

    " + } + }, + "documentation": "

    Specifies the conditions to evaluate for an event that applies to an activity in a journey.

    ", + "required": [ + "Dimensions" + ] + }, + "EventDimensions": { + "type": "structure", + "members": { + "Attributes": { + "shape": "MapOfAttributeDimension", + "documentation": "

    One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.

    " + }, + "EventType": { + "shape": "SetDimension", + "documentation": "

    The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard type of event that Amazon Pinpoint generates, such as _email.delivered, or a custom event that's specific to your application.

    " + }, + "Metrics": { + "shape": "MapOfMetricDimension", + "documentation": "

    One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.

    " + } + }, + "documentation": "

    Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

    " + }, + "EventItemResponse": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    A custom message that's returned in the response as a result of processing the event.

    " + }, + "StatusCode": { + "shape": "__integer", + "documentation": "

    The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.

    " + } + }, + "documentation": "

    Provides the status code and message that result from processing an event.

    " + }, + "EventStream": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application to publish event data for.

    " + }, + "DestinationStreamArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

    " + }, + "ExternalId": { + "shape": "__string", + "documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the event stream was last modified.

    " + }, + "LastUpdatedBy": { + "shape": "__string", + "documentation": "

    The IAM user who last modified the event stream.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

    " + } + }, + "documentation": "

    Specifies settings for publishing event data to an Amazon Kinesis data stream or an Amazon Kinesis Data Firehose delivery stream.

    ", + "required": [ + "ApplicationId", + "RoleArn", + "DestinationStreamArn" + ] + }, + "EventsBatch": { + "type": "structure", + "members": { + "Endpoint": { + "shape": "PublicEndpoint", + "documentation": "

    A set of properties and attributes that are associated with the endpoint.

    " + }, + "Events": { + "shape": "MapOfEvent", + "documentation": "

    A set of properties that are associated with the event.

    " + } + }, + "documentation": "

    Specifies a batch of endpoints and events to process.

    ", + "required": [ + "Endpoint", + "Events" + ] + }, + "EventsRequest": { + "type": "structure", + "members": { + "BatchItem": { + "shape": "MapOfEventsBatch", + "documentation": "

    The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.

    " + } + }, + "documentation": "

    Specifies a batch of events to process.

    ", + "required": [ + "BatchItem" + ] + }, + "EventsResponse": { + "type": "structure", + "members": { + "Results": { + "shape": "MapOfItemResponse", + "documentation": "

    A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.

    " + } + }, + "documentation": "

    Provides information about endpoints and the events that they're associated with.

    " + }, + "ExportJobRequest": { + "type": "structure", + "members": { + "RoleArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.

    " + }, + "S3UrlPrefix": { + "shape": "__string", + "documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.

    " + }, + "SegmentVersion": { + "shape": "__integer", + "documentation": "

    The version of the segment to export endpoint definitions from, if specified.

    " + } + }, + "documentation": "

    Specifies the settings for a job that exports endpoint definitions to an Amazon Simple Storage Service (Amazon S3) bucket.

    ", + "required": [ + "S3UrlPrefix", + "RoleArn" + ] + }, + "ExportJobResource": { + "type": "structure", + "members": { + "RoleArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.

    " + }, + "S3UrlPrefix": { + "shape": "__string", + "documentation": "

    The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.

    " + }, + "SegmentVersion": { + "shape": "__integer", + "documentation": "

    The version of the segment that the endpoint definitions were exported from.

    " + } + }, + "documentation": "

    Provides information about the resource settings for a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

    ", + "required": [ + "S3UrlPrefix", + "RoleArn" + ] + }, + "ExportJobResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that's associated with the export job.

    " + }, + "CompletedPieces": { + "shape": "__integer", + "documentation": "

    The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

    " + }, + "CompletionDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the export job was completed.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the export job was created.

    " + }, + "Definition": { + "shape": "ExportJobResource", + "documentation": "

    The resource settings that apply to the export job.

    " + }, + "FailedPieces": { + "shape": "__integer", + "documentation": "

    The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

    " + }, + "Failures": { + "shape": "ListOf__string", + "documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the export job.

    " + }, + "JobStatus": { + "shape": "JobStatus", + "documentation": "

    The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

    " + }, + "TotalFailures": { + "shape": "__integer", + "documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

    " + }, + "TotalPieces": { + "shape": "__integer", + "documentation": "

    The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

    " + }, + "TotalProcessed": { + "shape": "__integer", + "documentation": "

    The total number of endpoint definitions that were processed by the export job.

    " + }, + "Type": { + "shape": "__string", + "documentation": "

    The job type. This value is EXPORT for export jobs.

    " + } + }, + "documentation": "

    Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

    ", + "required": [ + "JobStatus", + "CreationDate", + "Type", + "Definition", + "Id", + "ApplicationId" + ] + }, + "ExportJobsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfExportJobResponse", + "documentation": "

    An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about all the export jobs that are associated with an application or segment. An export job is a job that exports endpoint definitions to a file.

    ", + "required": [ + "Item" + ] + }, + "FilterType": { + "type": "string", + "enum": [ + "SYSTEM", + "ENDPOINT" + ] + }, + "ForbiddenException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 403 + } + }, + "Format": { + "type": "string", + "enum": [ + "CSV", + "JSON" + ] + }, + "Frequency": { + "type": "string", + "enum": [ + "ONCE", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "EVENT" + ] + }, + "GCMChannelRequest": { + "type": "structure", + "members": { + "ApiKey": { + "shape": "__string", + "documentation": "

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the GCM channel for the application.

    " + } + }, + "documentation": "

    Specifies the status and settings of the GCM channel for an application. This channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    ", + "required": [ + "ApiKey" + ] + }, + "GCMChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the GCM channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the GCM channel was enabled.

    " + }, + "Credential": { + "shape": "__string", + "documentation": "

    The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the GCM channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the GCM channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the GCM channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the GCM channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the GCM channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the GCM channel for an application. The GCM channel enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    ", + "required": [ + "Credential", + "Platform" + ] + }, + "GCMMessage": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if the recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The body of the notification message.

    " + }, + "CollapseKey": { + "shape": "__string", + "documentation": "

    An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active.

    Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.

    " + }, + "Data": { + "shape": "MapOf__string", + "documentation": "

    The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

    " + }, + "IconReference": { + "shape": "__string", + "documentation": "

    The icon image name of the asset saved in your app.

    " + }, + "ImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the large icon image to display in the content view of the push notification.

    " + }, + "ImageUrl": { + "shape": "__string", + "documentation": "

    The URL of an image to display in the push notification.

    " + }, + "Priority": { + "shape": "__string", + "documentation": "

    para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required.

    /listitem>

  • high - The notification is sent immediately and might wake a sleeping device.

    • /para>

    Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM.

    The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

    " + }, + "RestrictedPackageName": { + "shape": "__string", + "documentation": "

    The package name of the application where registration tokens must match in order for the recipient to receive the message.

    " + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

    " + }, + "SmallImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the small icon image to display in the status bar and the content view of the push notification.

    " + }, + "Sound": { + "shape": "__string", + "documentation": "

    The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the notification message. You can override the default variables with individual address variables.

    " + }, + "TimeToLive": { + "shape": "__integer", + "documentation": "

    The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days).

    Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to display above the notification message on the recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the settings for a one-time message that's sent directly to an endpoint through the GCM channel. The GCM channel enables Amazon Pinpoint to send messages to the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

    " + }, + "GPSCoordinates": { + "type": "structure", + "members": { + "Latitude": { + "shape": "__double", + "documentation": "

    The latitude coordinate of the location.

    " + }, + "Longitude": { + "shape": "__double", + "documentation": "

    The longitude coordinate of the location.

    " + } + }, + "documentation": "

    Specifies the GPS coordinates of a location.

    ", + "required": [ + "Latitude", + "Longitude" + ] + }, + "GPSPointDimension": { + "type": "structure", + "members": { + "Coordinates": { + "shape": "GPSCoordinates", + "documentation": "

    The GPS coordinates to measure distance from.

    " + }, + "RangeInKilometers": { + "shape": "__double", + "documentation": "

    The range, in kilometers, from the GPS coordinates.

    " + } + }, + "documentation": "

    Specifies GPS-based criteria for including or excluding endpoints from a segment.

    ", + "required": [ + "Coordinates" + ] + }, + "GetAdmChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetAdmChannelResponse": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "ADMChannelResponse" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + }, + "GetApnsChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetApnsChannelResponse": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "APNSChannelResponse" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + }, + "GetApnsSandboxChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetApnsSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "APNSSandboxChannelResponse" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + }, + "GetApnsVoipChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetApnsVoipChannelResponse": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "APNSVoipChannelResponse" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + }, + "GetApnsVoipSandboxChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetApnsVoipSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "APNSVoipSandboxChannelResponse" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + }, + "GetAppRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetAppResponse": { + "type": "structure", + "members": { + "ApplicationResponse": { + "shape": "ApplicationResponse" + } + }, + "required": [ + "ApplicationResponse" + ], + "payload": "ApplicationResponse" + }, + "GetApplicationDateRangeKpiRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "end-time", + "documentation": "

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

    " + }, + "KpiName": { + "shape": "__string", + "location": "uri", + "locationName": "kpi-name", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "start-time", + "documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

    " + } + }, + "required": [ + "ApplicationId", + "KpiName" + ] + }, + "GetApplicationDateRangeKpiResponse": { + "type": "structure", + "members": { + "ApplicationDateRangeKpiResponse": { + "shape": "ApplicationDateRangeKpiResponse" + } + }, + "required": [ + "ApplicationDateRangeKpiResponse" + ], + "payload": "ApplicationDateRangeKpiResponse" + }, + "GetApplicationSettingsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetApplicationSettingsResponse": { + "type": "structure", + "members": { + "ApplicationSettingsResource": { + "shape": "ApplicationSettingsResource" + } + }, + "required": [ + "ApplicationSettingsResource" + ], + "payload": "ApplicationSettingsResource" + }, + "GetAppsRequest": { + "type": "structure", + "members": { + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + } + }, + "GetAppsResponse": { + "type": "structure", + "members": { + "ApplicationsResponse": { + "shape": "ApplicationsResponse" + } + }, + "required": [ + "ApplicationsResponse" + ], + "payload": "ApplicationsResponse" + }, + "GetBaiduChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetBaiduChannelResponse": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "BaiduChannelResponse" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + }, + "GetCampaignActivitiesRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId", + "CampaignId" + ] + }, + "GetCampaignActivitiesResponse": { + "type": "structure", + "members": { + "ActivitiesResponse": { + "shape": "ActivitiesResponse" + } + }, + "required": [ + "ActivitiesResponse" + ], + "payload": "ActivitiesResponse" + }, + "GetCampaignDateRangeKpiRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "end-time", + "documentation": "

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

    " + }, + "KpiName": { + "shape": "__string", + "location": "uri", + "locationName": "kpi-name", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "start-time", + "documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

    " + } + }, + "required": [ + "ApplicationId", + "KpiName", + "CampaignId" + ] + }, + "GetCampaignDateRangeKpiResponse": { + "type": "structure", + "members": { + "CampaignDateRangeKpiResponse": { + "shape": "CampaignDateRangeKpiResponse" + } + }, + "required": [ + "CampaignDateRangeKpiResponse" + ], + "payload": "CampaignDateRangeKpiResponse" + }, + "GetCampaignRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + } + }, + "required": [ + "CampaignId", + "ApplicationId" + ] + }, + "GetCampaignResponse": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "CampaignResponse" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + }, + "GetCampaignVersionRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "Version": { + "shape": "__string", + "location": "uri", + "locationName": "version", + "documentation": "

    The unique version number (Version property) for the campaign version.

    " + } + }, + "required": [ + "Version", + "ApplicationId", + "CampaignId" + ] + }, + "GetCampaignVersionResponse": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "CampaignResponse" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + }, + "GetCampaignVersionsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId", + "CampaignId" + ] + }, + "GetCampaignVersionsResponse": { + "type": "structure", + "members": { + "CampaignsResponse": { + "shape": "CampaignsResponse" + } + }, + "required": [ + "CampaignsResponse" + ], + "payload": "CampaignsResponse" + }, + "GetCampaignsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetCampaignsResponse": { + "type": "structure", + "members": { + "CampaignsResponse": { + "shape": "CampaignsResponse" + } + }, + "required": [ + "CampaignsResponse" + ], + "payload": "CampaignsResponse" + }, + "GetChannelsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetChannelsResponse": { + "type": "structure", + "members": { + "ChannelsResponse": { + "shape": "ChannelsResponse" + } + }, + "required": [ + "ChannelsResponse" + ], + "payload": "ChannelsResponse" + }, + "GetEmailChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetEmailChannelResponse": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "EmailChannelResponse" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + }, + "GetEmailTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "GetEmailTemplateResponse": { + "type": "structure", + "members": { + "EmailTemplateResponse": { + "shape": "EmailTemplateResponse" + } + }, + "required": [ + "EmailTemplateResponse" + ], + "payload": "EmailTemplateResponse" + }, + "GetEndpointRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndpointId": { + "shape": "__string", + "location": "uri", + "locationName": "endpoint-id", + "documentation": "

    The unique identifier for the endpoint.

    " + } + }, + "required": [ + "ApplicationId", + "EndpointId" + ] + }, + "GetEndpointResponse": { + "type": "structure", + "members": { + "EndpointResponse": { + "shape": "EndpointResponse" + } + }, + "required": [ + "EndpointResponse" + ], + "payload": "EndpointResponse" + }, + "GetEventStreamRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetEventStreamResponse": { + "type": "structure", + "members": { + "EventStream": { + "shape": "EventStream" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + }, + "GetExportJobRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JobId": { + "shape": "__string", + "location": "uri", + "locationName": "job-id", + "documentation": "

    The unique identifier for the job.

    " + } + }, + "required": [ + "ApplicationId", + "JobId" + ] + }, + "GetExportJobResponse": { + "type": "structure", + "members": { + "ExportJobResponse": { + "shape": "ExportJobResponse" + } + }, + "required": [ + "ExportJobResponse" + ], + "payload": "ExportJobResponse" + }, + "GetExportJobsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetExportJobsResponse": { + "type": "structure", + "members": { + "ExportJobsResponse": { + "shape": "ExportJobsResponse" + } + }, + "required": [ + "ExportJobsResponse" + ], + "payload": "ExportJobsResponse" + }, + "GetGcmChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetGcmChannelResponse": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "GCMChannelResponse" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + }, + "GetImportJobRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JobId": { + "shape": "__string", + "location": "uri", + "locationName": "job-id", + "documentation": "

    The unique identifier for the job.

    " + } + }, + "required": [ + "ApplicationId", + "JobId" + ] + }, + "GetImportJobResponse": { + "type": "structure", + "members": { + "ImportJobResponse": { + "shape": "ImportJobResponse" + } + }, + "required": [ + "ImportJobResponse" + ], + "payload": "ImportJobResponse" + }, + "GetImportJobsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetImportJobsResponse": { + "type": "structure", + "members": { + "ImportJobsResponse": { + "shape": "ImportJobsResponse" + } + }, + "required": [ + "ImportJobsResponse" + ], + "payload": "ImportJobsResponse" + }, + "GetJourneyDateRangeKpiRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "end-time", + "documentation": "

    The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-19T00:00:00Z for July 19, 2019 and 2019-07-19T20:00:00Z for 8:00 PM July 19, 2019.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + }, + "KpiName": { + "shape": "__string", + "location": "uri", + "locationName": "kpi-name", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

    " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "location": "querystring", + "locationName": "start-time", + "documentation": "

    The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format, for example: 2019-07-15T00:00:00Z for July 15, 2019 and 2019-07-15T16:00:00Z for 4:00 PM July 15, 2019.

    " + } + }, + "required": [ + "JourneyId", + "ApplicationId", + "KpiName" + ] + }, + "GetJourneyDateRangeKpiResponse": { + "type": "structure", + "members": { + "JourneyDateRangeKpiResponse": { + "shape": "JourneyDateRangeKpiResponse" + } + }, + "required": [ + "JourneyDateRangeKpiResponse" + ], + "payload": "JourneyDateRangeKpiResponse" + }, + "GetJourneyExecutionActivityMetricsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyActivityId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-activity-id", + "documentation": "

    The unique identifier for the journey activity.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + } + }, + "required": [ + "JourneyActivityId", + "ApplicationId", + "JourneyId" + ] + }, + "GetJourneyExecutionActivityMetricsResponse": { + "type": "structure", + "members": { + "JourneyExecutionActivityMetricsResponse": { + "shape": "JourneyExecutionActivityMetricsResponse" + } + }, + "required": [ + "JourneyExecutionActivityMetricsResponse" + ], + "payload": "JourneyExecutionActivityMetricsResponse" + }, + "GetJourneyExecutionMetricsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + }, + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + } + }, + "required": [ + "ApplicationId", + "JourneyId" + ] + }, + "GetJourneyExecutionMetricsResponse": { + "type": "structure", + "members": { + "JourneyExecutionMetricsResponse": { + "shape": "JourneyExecutionMetricsResponse" + } + }, + "required": [ + "JourneyExecutionMetricsResponse" + ], + "payload": "JourneyExecutionMetricsResponse" + }, + "GetJourneyRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + } + }, + "required": [ + "JourneyId", + "ApplicationId" + ] + }, + "GetJourneyResponse": { + "type": "structure", + "members": { + "JourneyResponse": { + "shape": "JourneyResponse" + } + }, + "required": [ + "JourneyResponse" + ], + "payload": "JourneyResponse" + }, + "GetPushTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "GetPushTemplateResponse": { + "type": "structure", + "members": { + "PushNotificationTemplateResponse": { + "shape": "PushNotificationTemplateResponse" + } + }, + "required": [ + "PushNotificationTemplateResponse" + ], + "payload": "PushNotificationTemplateResponse" + }, + "GetSegmentExportJobsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "GetSegmentExportJobsResponse": { + "type": "structure", + "members": { + "ExportJobsResponse": { + "shape": "ExportJobsResponse" + } + }, + "required": [ + "ExportJobsResponse" + ], + "payload": "ExportJobsResponse" + }, + "GetSegmentImportJobsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "GetSegmentImportJobsResponse": { + "type": "structure", + "members": { + "ImportJobsResponse": { + "shape": "ImportJobsResponse" + } + }, + "required": [ + "ImportJobsResponse" + ], + "payload": "ImportJobsResponse" + }, + "GetSegmentRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "GetSegmentResponse": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "SegmentResponse" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + }, + "GetSegmentVersionRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + }, + "Version": { + "shape": "__string", + "location": "uri", + "locationName": "version", + "documentation": "

    The unique version number (Version property) for the campaign version.

    " + } + }, + "required": [ + "SegmentId", + "Version", + "ApplicationId" + ] + }, + "GetSegmentVersionResponse": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "SegmentResponse" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + }, + "GetSegmentVersionsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "SegmentId", + "ApplicationId" + ] + }, + "GetSegmentVersionsResponse": { + "type": "structure", + "members": { + "SegmentsResponse": { + "shape": "SegmentsResponse" + } + }, + "required": [ + "SegmentsResponse" + ], + "payload": "SegmentsResponse" + }, + "GetSegmentsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetSegmentsResponse": { + "type": "structure", + "members": { + "SegmentsResponse": { + "shape": "SegmentsResponse" + } + }, + "required": [ + "SegmentsResponse" + ], + "payload": "SegmentsResponse" + }, + "GetSmsChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetSmsChannelResponse": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "SMSChannelResponse" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + }, + "GetSmsTemplateRequest": { + "type": "structure", + "members": { + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName" + ] + }, + "GetSmsTemplateResponse": { + "type": "structure", + "members": { + "SMSTemplateResponse": { + "shape": "SMSTemplateResponse" + } + }, + "required": [ + "SMSTemplateResponse" + ], + "payload": "SMSTemplateResponse" + }, + "GetUserEndpointsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "UserId": { + "shape": "__string", + "location": "uri", + "locationName": "user-id", + "documentation": "

    The unique identifier for the user.

    " + } + }, + "required": [ + "ApplicationId", + "UserId" + ] + }, + "GetUserEndpointsResponse": { + "type": "structure", + "members": { + "EndpointsResponse": { + "shape": "EndpointsResponse" + } + }, + "required": [ + "EndpointsResponse" + ], + "payload": "EndpointsResponse" + }, + "GetVoiceChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "GetVoiceChannelResponse": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "VoiceChannelResponse" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + }, + "HoldoutActivity": { + "type": "structure", + "members": { + "NextActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the next activity to perform, after performing the holdout activity.

    " + }, + "Percentage": { + "shape": "__integer", + "documentation": "

    The percentage of participants who shouldn't continue the journey.

    " + } + }, + "documentation": "

    Specifies the settings for a holdout activity in a journey. This type of activity stops a journey for a specified percentage of participants.

    ", + "required": [ + "Percentage" + ] + }, + "ImportJobRequest": { + "type": "structure", + "members": { + "DefineSegment": { + "shape": "__boolean", + "documentation": "

    Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.

    " + }, + "ExternalId": { + "shape": "__string", + "documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + }, + "Format": { + "shape": "Format", + "documentation": "

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    " + }, + "RegisterEndpoints": { + "shape": "__boolean", + "documentation": "

    Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    " + }, + "S3Url": { + "shape": "__string", + "documentation": "

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.

    " + }, + "SegmentName": { + "shape": "__string", + "documentation": "

    The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

    " + } + }, + "documentation": "

    Specifies the settings for a job that imports endpoint definitions from an Amazon Simple Storage Service (Amazon S3) bucket.

    ", + "required": [ + "Format", + "S3Url", + "RoleArn" + ] + }, + "ImportJobResource": { + "type": "structure", + "members": { + "DefineSegment": { + "shape": "__boolean", + "documentation": "

    Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.

    " + }, + "ExternalId": { + "shape": "__string", + "documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + }, + "Format": { + "shape": "Format", + "documentation": "

    The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.

    " + }, + "RegisterEndpoints": { + "shape": "__boolean", + "documentation": "

    Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    " + }, + "S3Url": { + "shape": "__string", + "documentation": "

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains.

    The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.

    " + }, + "SegmentName": { + "shape": "__string", + "documentation": "

    The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.

    " + } + }, + "documentation": "

    Provides information about the resource settings for a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

    ", + "required": [ + "Format", + "S3Url", + "RoleArn" + ] + }, + "ImportJobResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that's associated with the import job.

    " + }, + "CompletedPieces": { + "shape": "__integer", + "documentation": "

    The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.

    " + }, + "CompletionDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the import job was completed.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the import job was created.

    " + }, + "Definition": { + "shape": "ImportJobResource", + "documentation": "

    The resource settings that apply to the import job.

    " + }, + "FailedPieces": { + "shape": "__integer", + "documentation": "

    The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.

    " + }, + "Failures": { + "shape": "ListOf__string", + "documentation": "

    An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the import job.

    " + }, + "JobStatus": { + "shape": "JobStatus", + "documentation": "

    The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

    " + }, + "TotalFailures": { + "shape": "__integer", + "documentation": "

    The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.

    " + }, + "TotalPieces": { + "shape": "__integer", + "documentation": "

    The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.

    " + }, + "TotalProcessed": { + "shape": "__integer", + "documentation": "

    The total number of endpoint definitions that were processed by the import job.

    " + }, + "Type": { + "shape": "__string", + "documentation": "

    The job type. This value is IMPORT for import jobs.

    " + } + }, + "documentation": "

    Provides information about the status and settings of a job that imports endpoint definitions from one or more files. The files can be stored in an Amazon Simple Storage Service (Amazon S3) bucket or uploaded directly from a computer by using the Amazon Pinpoint console.

    ", + "required": [ + "JobStatus", + "CreationDate", + "Type", + "Definition", + "Id", + "ApplicationId" + ] + }, + "ImportJobsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfImportJobResponse", + "documentation": "

    An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about the status and settings of all the import jobs that are associated with an application or segment. An import job is a job that imports endpoint definitions from one or more files.

    ", + "required": [ + "Item" + ] + }, + "Include": { + "type": "string", + "enum": [ + "ALL", + "ANY", + "NONE" + ] + }, + "InternalServerErrorException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 500 + } + }, + "ItemResponse": { + "type": "structure", + "members": { + "EndpointItemResponse": { + "shape": "EndpointItemResponse", + "documentation": "

    The response that was received after the endpoint data was accepted.

    " + }, + "EventsItemResponse": { + "shape": "MapOfEventItemResponse", + "documentation": "

    A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.

    " + } + }, + "documentation": "

    Provides information about the results of a request to create or update an endpoint that's associated with an event.

    " + }, + "JobStatus": { + "type": "string", + "enum": [ + "CREATED", + "PREPARING_FOR_INITIALIZATION", + "INITIALIZING", + "PROCESSING", + "PENDING_JOB", + "COMPLETING", + "COMPLETED", + "FAILING", + "FAILED" + ] + }, + "JourneyDateRangeKpiResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the metric applies to.

    " + }, + "EndTime": { + "shape": "__timestampIso8601", + "documentation": "

    The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + }, + "JourneyId": { + "shape": "__string", + "documentation": "

    The unique identifier for the journey that the metric applies to.

    " + }, + "KpiName": { + "shape": "__string", + "documentation": "

    The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.

    " + }, + "KpiResult": { + "shape": "BaseKpiResult", + "documentation": "

    An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "documentation": "

    The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard engagement metric that applies to a journey, and provides information about that query.

    ", + "required": [ + "KpiResult", + "KpiName", + "JourneyId", + "EndTime", + "StartTime", + "ApplicationId" + ] + }, + "JourneyEmailMessage": { + "type": "structure", + "members": { + "FromAddress": { + "shape": "__string", + "documentation": "

    The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.

    " + } + }, + "documentation": "

    Specifies the \"From\" address for an email message that's sent to participants in a journey.

    " + }, + "JourneyExecutionActivityMetricsResponse": { + "type": "structure", + "members": { + "ActivityType": { + "shape": "__string", + "documentation": "

    The type of activity that the metric applies to. Possible values are:

    • CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

    • HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

    • MESSAGE - For an email activity, which is an activity that sends an email message to participants.

    • MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

    • RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

    • WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    " + }, + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the metric applies to.

    " + }, + "JourneyActivityId": { + "shape": "__string", + "documentation": "

    The unique identifier for the activity that the metric applies to.

    " + }, + "JourneyId": { + "shape": "__string", + "documentation": "

    The unique identifier for the journey that the metric applies to.

    " + }, + "LastEvaluatedTime": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.

    " + }, + "Metrics": { + "shape": "MapOf__string", + "documentation": "

    A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey activity, and provides information about that query.

    ", + "required": [ + "Metrics", + "JourneyId", + "LastEvaluatedTime", + "JourneyActivityId", + "ActivityType", + "ApplicationId" + ] + }, + "JourneyExecutionMetricsResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the metric applies to.

    " + }, + "JourneyId": { + "shape": "__string", + "documentation": "

    The unique identifier for the journey that the metric applies to.

    " + }, + "LastEvaluatedTime": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.

    " + }, + "Metrics": { + "shape": "MapOf__string", + "documentation": "

    A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey.

    ", + "required": [ + "Metrics", + "JourneyId", + "LastEvaluatedTime", + "ApplicationId" + ] + }, + "JourneyLimits": { + "type": "structure", + "members": { + "DailyCap": { + "shape": "__integer", + "documentation": "

    The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.

    " + }, + "EndpointReentryCap": { + "shape": "__integer", + "documentation": "

    The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.

    " + }, + "MessagesPerSecond": { + "shape": "__integer", + "documentation": "

    The maximum number of messages that the journey can send each second.

    " + } + }, + "documentation": "

    Specifies limits on the messages that a journey can send and the number of times participants can enter a journey.

    " + }, + "JourneyResponse": { + "type": "structure", + "members": { + "Activities": { + "shape": "MapOfActivity", + "documentation": "

    The configuration and other settings for the activities that comprise the journey.

    " + }, + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the journey applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the journey was created.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the journey.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " + }, + "Limits": { + "shape": "JourneyLimits", + "documentation": "

    The messaging and entry limits for the journey.

    " + }, + "LocalTime": { + "shape": "__boolean", + "documentation": "

    Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The name of the journey.

    " + }, + "QuietTime": { + "shape": "QuietTime", + "documentation": "

    The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

    • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

    • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

    If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

    " + }, + "RefreshFrequency": { + "shape": "__string", + "documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " + }, + "Schedule": { + "shape": "JourneySchedule", + "documentation": "

    The schedule settings for the journey.

    " + }, + "StartActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the first activity in the journey.

    " + }, + "StartCondition": { + "shape": "StartCondition", + "documentation": "

    The segment that defines which users are participants in the journey.

    " + }, + "State": { + "shape": "State", + "documentation": "

    The current status of the journey. Possible values are:

    • DRAFT - The journey is being developed and hasn't been published yet.

    • ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    • COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey.

    • CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey.

    • CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may resume the journey.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the journey. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Provides information about the status, configuration, and other settings for a journey.

    ", + "required": [ + "Name", + "Id", + "ApplicationId" + ] + }, + "JourneySchedule": { + "type": "structure", + "members": { + "EndTime": { + "shape": "__timestampIso8601", + "documentation": "

    The scheduled time, in ISO 8601 format, when the journey ended or will end.

    " + }, + "StartTime": { + "shape": "__timestampIso8601", + "documentation": "

    The scheduled time, in ISO 8601 format, when the journey began or will begin.

    " + }, + "Timezone": { + "shape": "__string", + "documentation": "

    The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC,\n UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,\n UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02,\n UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09,\n UTC-09:30, UTC-10, and UTC-11.

    " + } + }, + "documentation": "

    Specifies the schedule settings for a journey.

    " + }, + "JourneyStateRequest": { + "type": "structure", + "members": { + "State": { + "shape": "State", + "documentation": "

    The status of the journey. Currently, the only supported value is CANCELLED.

    If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey.

    After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.

    " + } + }, + "documentation": "

    Changes the status of a journey.

    " + }, + "JourneysResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfJourneyResponse", + "documentation": "

    An array of responses, one for each journey that's associated with the application.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about the status, configuration, and other settings for all the journeys that are associated with an application.

    ", + "required": [ + "Item" + ] + }, + "ListJourneysRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Token": { + "shape": "__string", + "location": "querystring", + "locationName": "token", + "documentation": "

    The NextToken string that specifies which page of results to return in a paginated response.

    " + } + }, + "required": [ + "ApplicationId" + ] + }, + "ListJourneysResponse": { + "type": "structure", + "members": { + "JourneysResponse": { + "shape": "JourneysResponse" + } + }, + "required": [ + "JourneysResponse" + ], + "payload": "JourneysResponse" + }, + "ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + } + }, + "required": [ + "ResourceArn" + ] + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "TagsModel": { + "shape": "TagsModel" + } + }, + "required": [ + "TagsModel" + ], + "payload": "TagsModel" + }, + "ListTemplatesRequest": { + "type": "structure", + "members": { + "NextToken": { + "shape": "__string", + "location": "querystring", + "locationName": "next-token", + "documentation": "

    The string that specifies which page of results to return in a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "PageSize": { + "shape": "__string", + "location": "querystring", + "locationName": "page-size", + "documentation": "

    The maximum number of items to include in each page of a paginated response. This parameter is currently not supported for application, campaign, and journey metrics.

    " + }, + "Prefix": { + "shape": "__string", + "location": "querystring", + "locationName": "prefix", + "documentation": "

    The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.

    " + }, + "TemplateType": { + "shape": "__string", + "location": "querystring", + "locationName": "template-type", + "documentation": "

    The type of message template to include in the results. Valid values are: EMAIL, SMS, and PUSH. To include all types of templates in the results, don't include this parameter in your request.

    " + } + } + }, + "ListTemplatesResponse": { + "type": "structure", + "members": { + "TemplatesResponse": { + "shape": "TemplatesResponse" + } + }, + "required": [ + "TemplatesResponse" + ], + "payload": "TemplatesResponse" + }, + "Message": { + "type": "structure", + "members": { + "Action": { + "shape": "Action", + "documentation": "

    The action to occur if a recipient taps the push notification. Valid values are:

    • OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.

    • DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.

    • URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The body of the notification message. The maximum number of characters is 200.

    " + }, + "ImageIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the image to display as the push-notification icon, such as the icon for the app.

    " + }, + "ImageSmallIconUrl": { + "shape": "__string", + "documentation": "

    The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.

    " + }, + "ImageUrl": { + "shape": "__string", + "documentation": "

    The URL of an image to display in the push notification.

    " + }, + "JsonBody": { + "shape": "__string", + "documentation": "

    The JSON payload to use for a silent push notification.

    " + }, + "MediaUrl": { + "shape": "__string", + "documentation": "

    The URL of the image or video to display in the push notification.

    " + }, + "RawContent": { + "shape": "__string", + "documentation": "

    The raw, JSON-formatted string to use as the payload for the notification message. This value overrides other values for the message.

    " + }, + "SilentPush": { + "shape": "__boolean", + "documentation": "

    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

    " + }, + "TimeToLive": { + "shape": "__integer", + "documentation": "

    The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

    This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

    " + }, + "Title": { + "shape": "__string", + "documentation": "

    The title to display above the notification message on a recipient's device.

    " + }, + "Url": { + "shape": "__string", + "documentation": "

    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

    " + } + }, + "documentation": "

    Specifies the content and settings for a push notification that's sent to recipients of a campaign.

    " + }, + "MessageBody": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    " + }, + "MessageConfiguration": { + "type": "structure", + "members": { + "ADMMessage": { + "shape": "Message", + "documentation": "

    The message that the campaign sends through the ADM (Amazon Device Messaging) channel. This message overrides the default message.

    " + }, + "APNSMessage": { + "shape": "Message", + "documentation": "

    The message that the campaign sends through the APNs (Apple Push Notification service) channel. This message overrides the default message.

    " + }, + "BaiduMessage": { + "shape": "Message", + "documentation": "

    The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. This message overrides the default message.

    " + }, + "DefaultMessage": { + "shape": "Message", + "documentation": "

    The default message that the campaign sends through all the channels that are configured for the campaign.

    " + }, + "EmailMessage": { + "shape": "CampaignEmailMessage", + "documentation": "

    The message that the campaign sends through the email channel.

    " + }, + "GCMMessage": { + "shape": "Message", + "documentation": "

    The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default message.

    " + }, + "SMSMessage": { + "shape": "CampaignSmsMessage", + "documentation": "

    The message that the campaign sends through the SMS channel.

    " + } + }, + "documentation": "

    Specifies the message configuration settings for a campaign.

    " + }, + "MessageRequest": { + "type": "structure", + "members": { + "Addresses": { + "shape": "MapOfAddressConfiguration", + "documentation": "

    A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.

    " + }, + "Context": { + "shape": "MapOf__string", + "documentation": "

    A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.

    " + }, + "Endpoints": { + "shape": "MapOfEndpointSendConfiguration", + "documentation": "

    A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.

    " + }, + "MessageConfiguration": { + "shape": "DirectMessageConfiguration", + "documentation": "

    The set of properties that defines the configuration settings for the message.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template to use for the message.

    " + }, + "TraceId": { + "shape": "__string", + "documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " + } + }, + "documentation": "

    Specifies the objects that define configuration and other settings for a message.

    ", + "required": [ + "MessageConfiguration" + ] + }, + "MessageResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that was used to send the message.

    " + }, + "EndpointResult": { + "shape": "MapOfEndpointMessageResult", + "documentation": "

    A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    The identifier for the original request that the message was delivered for.

    " + }, + "Result": { + "shape": "MapOfMessageResult", + "documentation": "

    A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.

    " + } + }, + "documentation": "

    Provides information about the results of a request to send a message to an endpoint address.

    ", + "required": [ + "ApplicationId" + ] + }, + "MessageResult": { + "type": "structure", + "members": { + "DeliveryStatus": { + "shape": "DeliveryStatus", + "documentation": "

    The delivery status of the message. Possible values are:

    • DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again.

    • PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again.

    • SUCCESSFUL - The message was successfully delivered to the endpoint address.

    • TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint will attempt to deliver the message again later.

    • THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address.

    • TIMEOUT - The message couldn't be sent within the timeout period.

    • UNKNOWN_FAILURE - An unknown error occurred.

    " + }, + "MessageId": { + "shape": "__string", + "documentation": "

    The unique identifier for the message that was sent.

    " + }, + "StatusCode": { + "shape": "__integer", + "documentation": "

    The downstream service status code for delivering the message.

    " + }, + "StatusMessage": { + "shape": "__string", + "documentation": "

    The status message for delivering the message.

    " + }, + "UpdatedToken": { + "shape": "__string", + "documentation": "

    For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.

    " + } + }, + "documentation": "

    Provides information about the results of sending a message directly to an endpoint address.

    ", + "required": [ + "DeliveryStatus", + "StatusCode" + ] + }, + "MessageType": { + "type": "string", + "enum": [ + "TRANSACTIONAL", + "PROMOTIONAL" + ] + }, + "MethodNotAllowedException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 405 + } + }, + "MetricDimension": { + "type": "structure", + "members": { + "ComparisonOperator": { + "shape": "__string", + "documentation": "

    The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.

    " + }, + "Value": { + "shape": "__double", + "documentation": "

    The value to compare.

    " + } + }, + "documentation": "

    Specifies metric-based criteria for including or excluding endpoints from a segment. These criteria derive from custom metrics that you define for endpoints.

    ", + "required": [ + "ComparisonOperator", + "Value" + ] + }, + "Mode": { + "type": "string", + "enum": [ + "DELIVERY", + "FILTER" + ] + }, + "MultiConditionalBranch": { + "type": "structure", + "members": { + "Condition": { + "shape": "SimpleCondition", + "documentation": "

    The condition to evaluate for the activity path.

    " + }, + "NextActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the next activity to perform, after completing the activity for the path.

    " + } + }, + "documentation": "

    Specifies a condition to evaluate for an activity path in a journey.

    " + }, + "MultiConditionalSplitActivity": { + "type": "structure", + "members": { + "Branches": { + "shape": "ListOfMultiConditionalBranch", + "documentation": "

    The paths for the activity, including the conditions for entering each path and the activity to perform for each path.

    " + }, + "DefaultActivity": { + "shape": "__string", + "documentation": "

    The activity to perform by default for any path in the activity.

    " + }, + "EvaluationWaitTime": { + "shape": "WaitTime", + "documentation": "

    The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.

    " + } + }, + "documentation": "

    Specifies the settings for a multivariate split activity in a journey. This type of activity sends participants down one of as many as five paths in a journey, based on conditions that you specify.

    " + }, + "NotFoundException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 404 + } + }, + "NumberValidateRequest": { + "type": "structure", + "members": { + "IsoCountryCode": { + "shape": "__string", + "documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " + }, + "PhoneNumber": { + "shape": "__string", + "documentation": "

    The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.

    " + } + }, + "documentation": "

    Specifies a phone number to validate and retrieve information about.

    " + }, + "NumberValidateResponse": { + "type": "structure", + "members": { + "Carrier": { + "shape": "__string", + "documentation": "

    The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.

    " + }, + "City": { + "shape": "__string", + "documentation": "

    The name of the city where the phone number was originally registered.

    " + }, + "CleansedPhoneNumberE164": { + "shape": "__string", + "documentation": "

    The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.

    " + }, + "CleansedPhoneNumberNational": { + "shape": "__string", + "documentation": "

    The cleansed phone number, in the format for the location where the phone number was originally registered.

    " + }, + "Country": { + "shape": "__string", + "documentation": "

    The name of the country or region where the phone number was originally registered.

    " + }, + "CountryCodeIso2": { + "shape": "__string", + "documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.

    " + }, + "CountryCodeNumeric": { + "shape": "__string", + "documentation": "

    The numeric code for the country or region where the phone number was originally registered.

    " + }, + "County": { + "shape": "__string", + "documentation": "

    The name of the county where the phone number was originally registered.

    " + }, + "OriginalCountryCodeIso2": { + "shape": "__string", + "documentation": "

    The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.

    " + }, + "OriginalPhoneNumber": { + "shape": "__string", + "documentation": "

    The phone number that was sent in the request body.

    " + }, + "PhoneType": { + "shape": "__string", + "documentation": "

    The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,\n INVALID, PREPAID, and OTHER.

    " + }, + "PhoneTypeCode": { + "shape": "__integer", + "documentation": "

    The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).

    " + }, + "Timezone": { + "shape": "__string", + "documentation": "

    The time zone for the location where the phone number was originally registered.

    " + }, + "ZipCode": { + "shape": "__string", + "documentation": "

    The postal or ZIP code for the location where the phone number was originally registered.

    " + } + }, + "documentation": "

    Provides information about a phone number.

    " + }, + "Operator": { + "type": "string", + "enum": [ + "ALL", + "ANY" + ] + }, + "PhoneNumberValidateRequest": { + "type": "structure", + "members": { + "NumberValidateRequest": { + "shape": "NumberValidateRequest" + } + }, + "required": [ + "NumberValidateRequest" + ], + "payload": "NumberValidateRequest" + }, + "PhoneNumberValidateResponse": { + "type": "structure", + "members": { + "NumberValidateResponse": { + "shape": "NumberValidateResponse" + } + }, + "required": [ + "NumberValidateResponse" + ], + "payload": "NumberValidateResponse" + }, + "PublicEndpoint": { + "type": "structure", + "members": { + "Address": { + "shape": "__string", + "documentation": "

    The unique identifier for the recipient, such as a device token, email address, or mobile phone number.

    " + }, + "Attributes": { + "shape": "MapOfListOf__string", + "documentation": "

    One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.

    " + }, + "ChannelType": { + "shape": "ChannelType", + "documentation": "

    The channel that's used when sending messages or push notifications to the endpoint.

    " + }, + "Demographic": { + "shape": "EndpointDemographic", + "documentation": "

    The demographic information for the endpoint, such as the time zone and platform.

    " + }, + "EffectiveDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the endpoint was last updated.

    " + }, + "EndpointStatus": { + "shape": "__string", + "documentation": "

    Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint.

    Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.

    " + }, + "Location": { + "shape": "EndpointLocation", + "documentation": "

    The geographic information for the endpoint.

    " + }, + "Metrics": { + "shape": "MapOf__double", + "documentation": "

    One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.

    " + }, + "OptOut": { + "shape": "__string", + "documentation": "

    Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    A unique identifier that's generated each time the endpoint is updated.

    " + }, + "User": { + "shape": "EndpointUser", + "documentation": "

    One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.

    " + } + }, + "documentation": "

    Specifies the properties and attributes of an endpoint that's associated with an event.

    " + }, + "PushNotificationTemplateRequest": { + "type": "structure", + "members": { + "ADM": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "APNS": { + "shape": "APNSPushNotificationTemplate", + "documentation": "

    The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "Baidu": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "Default": { + "shape": "DefaultPushNotificationTemplate", + "documentation": "

    The default message template to use for push notification channels.

    " + }, + "GCM": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    " + }, + "PushNotificationTemplateResponse": { + "type": "structure", + "members": { + "ADM": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "APNS": { + "shape": "APNSPushNotificationTemplate", + "documentation": "

    The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " + }, + "Baidu": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date when the message template was created.

    " + }, + "Default": { + "shape": "DefaultPushNotificationTemplate", + "documentation": "

    The default message template that's used for push notification channels.

    " + }, + "GCM": { + "shape": "AndroidPushNotificationTemplate", + "documentation": "

    The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date when the message template was last modified.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateName": { + "shape": "__string", + "documentation": "

    The name of the message template.

    " + }, + "TemplateType": { + "shape": "TemplateType", + "documentation": "

    The type of channel that the message template is designed for. For a push notification template, this value is PUSH.

    " + } + }, + "documentation": "

    Provides information about the content and settings for a message template that can be used in messages that are sent through a push notification channel.

    ", + "required": [ + "LastModifiedDate", + "CreationDate", + "TemplateName", + "TemplateType" + ] + }, + "PutEventStreamRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "WriteEventStream": { + "shape": "WriteEventStream" + } + }, + "required": [ + "ApplicationId", + "WriteEventStream" + ], + "payload": "WriteEventStream" + }, + "PutEventStreamResponse": { + "type": "structure", + "members": { + "EventStream": { + "shape": "EventStream" + } + }, + "required": [ + "EventStream" + ], + "payload": "EventStream" + }, + "PutEventsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EventsRequest": { + "shape": "EventsRequest" + } + }, + "required": [ + "ApplicationId", + "EventsRequest" + ], + "payload": "EventsRequest" + }, + "PutEventsResponse": { + "type": "structure", + "members": { + "EventsResponse": { + "shape": "EventsResponse" + } + }, + "required": [ + "EventsResponse" + ], + "payload": "EventsResponse" + }, + "QuietTime": { + "type": "structure", + "members": { + "End": { + "shape": "__string", + "documentation": "

    The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

    " + }, + "Start": { + "shape": "__string", + "documentation": "

    The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.

    " + } + }, + "documentation": "

    Specifies the start and end times that define a time range when messages aren't sent to endpoints.

    " + }, + "RandomSplitActivity": { + "type": "structure", + "members": { + "Branches": { + "shape": "ListOfRandomSplitEntry", + "documentation": "

    The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.

    " + } + }, + "documentation": "

    Specifies the settings for a random split activity in a journey. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.

    " + }, + "RandomSplitEntry": { + "type": "structure", + "members": { + "NextActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the next activity to perform, after completing the activity for the path.

    " + }, + "Percentage": { + "shape": "__integer", + "documentation": "

    The percentage of participants to send down the activity path.

    " + } + }, + "documentation": "

    Specifies the settings for a path in a random split activity in a journey.

    " + }, + "RawEmail": { + "type": "structure", + "members": { + "Data": { + "shape": "__blob", + "documentation": "

    The email message, represented as a raw MIME message. The entire message must be base64 encoded.

    " + } + }, + "documentation": "

    Specifies the contents of an email message, represented as a raw MIME message.

    " + }, + "__blob": { + "type": "blob" + }, + "RecencyDimension": { + "type": "structure", + "members": { + "Duration": { + "shape": "Duration", + "documentation": "

    The duration to use when determining whether an endpoint is active or inactive.

    " + }, + "RecencyType": { + "shape": "RecencyType", + "documentation": "

    The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.

    " + } + }, + "documentation": "

    Specifies criteria for including or excluding endpoints from a segment based on how recently an endpoint was active.

    ", + "required": [ + "Duration", + "RecencyType" + ] + }, + "RecencyType": { + "type": "string", + "enum": [ + "ACTIVE", + "INACTIVE" + ] + }, + "RemoveAttributesRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "AttributeType": { + "shape": "__string", + "location": "uri", + "locationName": "attribute-type", + "documentation": "

    The type of attribute or attributes to remove. Valid values are:

    • endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel.

    • endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart.

    • endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.

    " + }, + "UpdateAttributesRequest": { + "shape": "UpdateAttributesRequest" + } + }, + "required": [ + "AttributeType", + "ApplicationId", + "UpdateAttributesRequest" + ], + "payload": "UpdateAttributesRequest" + }, + "RemoveAttributesResponse": { + "type": "structure", + "members": { + "AttributesResource": { + "shape": "AttributesResource" + } + }, + "required": [ + "AttributesResource" + ], + "payload": "AttributesResource" + }, + "ResultRow": { + "type": "structure", + "members": { + "GroupedBys": { + "shape": "ListOfResultRowValue", + "documentation": "

    An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.

    " + }, + "Values": { + "shape": "ListOfResultRowValue", + "documentation": "

    An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.

    " + } + }, + "documentation": "

    Provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.

    ", + "required": [ + "GroupedBys", + "Values" + ] + }, + "ResultRowValue": { + "type": "structure", + "members": { + "Key": { + "shape": "__string", + "documentation": "

    The friendly name of the metric whose value is specified by the Value property.

    " + }, + "Type": { + "shape": "__string", + "documentation": "

    The data type of the value specified by the Value property.

    " + }, + "Value": { + "shape": "__string", + "documentation": "

    In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).

    " + } + }, + "documentation": "

    Provides a single value and metadata about that value as part of an array of query results for a standard metric that applies to an application, campaign, or journey.

    ", + "required": [ + "Type", + "Value", + "Key" + ] + }, + "SMSChannelRequest": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the SMS channel for the application.

    " + }, + "SenderId": { + "shape": "__string", + "documentation": "

    The identity that you want to display on recipients' devices when they receive messages from the SMS channel.

    " + }, + "ShortCode": { + "shape": "__string", + "documentation": "

    The registered short code that you want to use when you send messages through the SMS channel.

    " + } + }, + "documentation": "

    Specifies the status and settings of the SMS channel for an application.

    " + }, + "SMSChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the SMS channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the SMS channel was enabled.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the SMS channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the SMS channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the SMS channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the SMS channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.

    " + }, + "PromotionalMessagesPerSecond": { + "shape": "__integer", + "documentation": "

    The maximum number of promotional messages that you can send through the SMS channel each second.

    " + }, + "SenderId": { + "shape": "__string", + "documentation": "

    The identity that displays on recipients' devices when they receive messages from the SMS channel.

    " + }, + "ShortCode": { + "shape": "__string", + "documentation": "

    The registered short code to use when you send messages through the SMS channel.

    " + }, + "TransactionalMessagesPerSecond": { + "shape": "__integer", + "documentation": "

    The maximum number of transactional messages that you can send through the SMS channel each second.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the SMS channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the SMS channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "SMSMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The body of the SMS message.

    " + }, + "Keyword": { + "shape": "__string", + "documentation": "

    The SMS program name that you provided to AWS Support when you requested your dedicated number.

    " + }, + "MessageType": { + "shape": "MessageType", + "documentation": "

    The SMS message type. Valid values are: TRANSACTIONAL, the message is critical or time-sensitive, such as a one-time password that supports a customer transaction; and, PROMOTIONAL, the message is not critical or time-sensitive, such as a marketing message.

    " + }, + "OriginationNumber": { + "shape": "__string", + "documentation": "

    The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.

    " + }, + "SenderId": { + "shape": "__string", + "documentation": "

    The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The message variables to use in the SMS message. You can override the default variables with individual address variables.

    " + } + }, + "documentation": "

    Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.

    " + }, + "SMSTemplateRequest": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The message body to use in text messages that are based on the message template.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Specifies the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    " + }, + "SMSTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " + }, + "Body": { + "shape": "__string", + "documentation": "

    The message body that's used in text messages that are based on the message template.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date when the message template was created.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date when the message template was last modified.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateName": { + "shape": "__string", + "documentation": "

    The name of the message template.

    " + }, + "TemplateType": { + "shape": "TemplateType", + "documentation": "

    The type of channel that the message template is designed for. For an SMS template, this value is SMS.

    " + } + }, + "documentation": "

    Provides information about the content and settings for a message template that can be used in text messages that are sent through the SMS channel.

    ", + "required": [ + "LastModifiedDate", + "CreationDate", + "TemplateName", + "TemplateType" + ] + }, + "Schedule": { + "type": "structure", + "members": { + "EndTime": { + "shape": "__string", + "documentation": "

    The scheduled time, in ISO 8601 format, when the campaign ended or will end.

    " + }, + "EventFilter": { + "shape": "CampaignEventFilter", + "documentation": "

    The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

    " + }, + "Frequency": { + "shape": "Frequency", + "documentation": "

    Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

    " + }, + "IsLocalTime": { + "shape": "__boolean", + "documentation": "

    Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

    " + }, + "QuietTime": { + "shape": "QuietTime", + "documentation": "

    The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

    If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

    " + }, + "StartTime": { + "shape": "__string", + "documentation": "

    The scheduled time, in ISO 8601 format, when the campaign began or will begin.

    " + }, + "Timezone": { + "shape": "__string", + "documentation": "

    The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,\n UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,\n UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,\n UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

    " + } + }, + "documentation": "

    Specifies the schedule settings for a campaign.

    ", + "required": [ + "StartTime" + ] + }, + "SegmentBehaviors": { + "type": "structure", + "members": { + "Recency": { + "shape": "RecencyDimension", + "documentation": "

    The dimension settings that are based on how recently an endpoint was active.

    " + } + }, + "documentation": "

    Specifies dimension settings for including or excluding endpoints from a segment based on how recently an endpoint was active.

    " + }, + "SegmentCondition": { + "type": "structure", + "members": { + "SegmentId": { + "shape": "__string", + "documentation": "

    The unique identifier for the segment to associate with the activity.

    " + } + }, + "documentation": "

    Specifies a segment to associate with an activity in a journey.

    ", + "required": [ + "SegmentId" + ] + }, + "SegmentDemographics": { + "type": "structure", + "members": { + "AppVersion": { + "shape": "SetDimension", + "documentation": "

    The app version criteria for the segment.

    " + }, + "Channel": { + "shape": "SetDimension", + "documentation": "

    The channel criteria for the segment.

    " + }, + "DeviceType": { + "shape": "SetDimension", + "documentation": "

    The device type criteria for the segment.

    " + }, + "Make": { + "shape": "SetDimension", + "documentation": "

    The device make criteria for the segment.

    " + }, + "Model": { + "shape": "SetDimension", + "documentation": "

    The device model criteria for the segment.

    " + }, + "Platform": { + "shape": "SetDimension", + "documentation": "

    The device platform criteria for the segment.

    " + } + }, + "documentation": "

    Specifies demographic-based dimension settings for including or excluding endpoints from a segment. These settings derive from characteristics of endpoint devices, such as platform, make, and model.

    " + }, + "SegmentDimensions": { + "type": "structure", + "members": { + "Attributes": { + "shape": "MapOfAttributeDimension", + "documentation": "

    One or more custom attributes to use as criteria for the segment.

    " + }, + "Behavior": { + "shape": "SegmentBehaviors", + "documentation": "

    The behavior-based criteria, such as how recently users have used your app, for the segment.

    " + }, + "Demographic": { + "shape": "SegmentDemographics", + "documentation": "

    The demographic-based criteria, such as device platform, for the segment.

    " + }, + "Location": { + "shape": "SegmentLocation", + "documentation": "

    The location-based criteria, such as region or GPS coordinates, for the segment.

    " + }, + "Metrics": { + "shape": "MapOfMetricDimension", + "documentation": "

    One or more custom metrics to use as criteria for the segment.

    " + }, + "UserAttributes": { + "shape": "MapOfAttributeDimension", + "documentation": "

    One or more custom user attributes to use as criteria for the segment.

    " + } + }, + "documentation": "

    Specifies the dimension settings for a segment.

    " + }, + "SegmentGroup": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "ListOfSegmentDimensions", + "documentation": "

    An array that defines the dimensions for the segment.

    " + }, + "SourceSegments": { + "shape": "ListOfSegmentReference", + "documentation": "

    The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

    You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.

    " + }, + "SourceType": { + "shape": "SourceType", + "documentation": "

    Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

    " + }, + "Type": { + "shape": "Type", + "documentation": "

    Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

    " + } + }, + "documentation": "

    Specifies the base segments and dimensions for a segment, and the relationships between these base segments and dimensions.

    " + }, + "SegmentGroupList": { + "type": "structure", + "members": { + "Groups": { + "shape": "ListOfSegmentGroup", + "documentation": "

    An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

    " + }, + "Include": { + "shape": "Include", + "documentation": "

    Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.

    " + } + }, + "documentation": "

    Specifies the settings that define the relationships between segment groups for a segment.

    " + }, + "SegmentImportResource": { + "type": "structure", + "members": { + "ChannelCounts": { + "shape": "MapOf__integer", + "documentation": "

    The number of channel types in the endpoint definitions that were imported to create the segment.

    " + }, + "ExternalId": { + "shape": "__string", + "documentation": "

    (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.

    " + }, + "Format": { + "shape": "Format", + "documentation": "

    The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.

    " + }, + "S3Url": { + "shape": "__string", + "documentation": "

    The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.

    " + }, + "Size": { + "shape": "__integer", + "documentation": "

    The number of endpoint definitions that were imported successfully to create the segment.

    " + } + }, + "documentation": "

    Provides information about the import job that created a segment. An import job is a job that creates a user segment by importing endpoint definitions.

    ", + "required": [ + "Format", + "S3Url", + "Size", + "ExternalId", + "RoleArn" + ] + }, + "SegmentLocation": { + "type": "structure", + "members": { + "Country": { + "shape": "SetDimension", + "documentation": "

    The country or region code, in ISO 3166-1 alpha-2 format, for the segment.

    " + }, + "GPSPoint": { + "shape": "GPSPointDimension", + "documentation": "

    The GPS location and range for the segment.

    " + } + }, + "documentation": "

    Specifies geographical dimension settings for a segment.

    " + }, + "SegmentReference": { + "type": "structure", + "members": { + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the segment.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The version number of the segment.

    " + } + }, + "documentation": "

    Specifies the segment identifier and version of a segment.

    ", + "required": [ + "Id" + ] + }, + "SegmentResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the segment is associated with.

    " + }, + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the segment.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time when the segment was created.

    " + }, + "Dimensions": { + "shape": "SegmentDimensions", + "documentation": "

    The dimension settings for the segment.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the segment.

    " + }, + "ImportDefinition": { + "shape": "SegmentImportResource", + "documentation": "

    The settings for the import job that's associated with the segment.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time when the segment was last modified.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The name of the segment.

    " + }, + "SegmentGroups": { + "shape": "SegmentGroupList", + "documentation": "

    A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.

    " + }, + "SegmentType": { + "shape": "SegmentType", + "documentation": "

    The segment type. Valid values are:

    • DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time.

    • IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The version number of the segment.

    " + } + }, + "documentation": "

    Provides information about the configuration, dimension, and other settings for a segment.

    ", + "required": [ + "SegmentType", + "CreationDate", + "Id", + "Arn", + "ApplicationId" + ] + }, + "SegmentType": { + "type": "string", + "enum": [ + "DIMENSIONAL", + "IMPORT" + ] + }, + "SegmentsResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfSegmentResponse", + "documentation": "

    An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about all the segments that are associated with an application.

    ", + "required": [ + "Item" + ] + }, + "SendMessagesRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "MessageRequest": { + "shape": "MessageRequest" + } + }, + "required": [ + "ApplicationId", + "MessageRequest" + ], + "payload": "MessageRequest" + }, + "SendMessagesResponse": { + "type": "structure", + "members": { + "MessageResponse": { + "shape": "MessageResponse" + } + }, + "required": [ + "MessageResponse" + ], + "payload": "MessageResponse" + }, + "SendUsersMessageRequest": { + "type": "structure", + "members": { + "Context": { + "shape": "MapOf__string", + "documentation": "

    A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.

    " + }, + "MessageConfiguration": { + "shape": "DirectMessageConfiguration", + "documentation": "

    The message definitions for the default message and any default messages that you defined for specific channels.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template to use for the message.

    " + }, + "TraceId": { + "shape": "__string", + "documentation": "

    The unique identifier for tracing the message. This identifier is visible to message recipients.

    " + }, + "Users": { + "shape": "MapOfEndpointSendConfiguration", + "documentation": "

    A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.

    " + } + }, + "documentation": "

    Specifies the configuration and other settings for a message to send to all the endpoints that are associated with a list of users.

    ", + "required": [ + "MessageConfiguration", + "Users" + ] + }, + "SendUsersMessageResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that was used to send the message.

    " + }, + "RequestId": { + "shape": "__string", + "documentation": "

    The unique identifier that was assigned to the message request.

    " + }, + "Result": { + "shape": "MapOfMapOfEndpointMessageResult", + "documentation": "

    An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.

    " + } + }, + "documentation": "

    Provides information about which users and endpoints a message was sent to.

    ", + "required": [ + "ApplicationId" + ] + }, + "SendUsersMessagesRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SendUsersMessageRequest": { + "shape": "SendUsersMessageRequest" + } + }, + "required": [ + "ApplicationId", + "SendUsersMessageRequest" + ], + "payload": "SendUsersMessageRequest" + }, + "SendUsersMessagesResponse": { + "type": "structure", + "members": { + "SendUsersMessageResponse": { + "shape": "SendUsersMessageResponse" + } + }, + "required": [ + "SendUsersMessageResponse" + ], + "payload": "SendUsersMessageResponse" + }, + "Session": { + "type": "structure", + "members": { + "Duration": { + "shape": "__integer", + "documentation": "

    The duration of the session, in milliseconds.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the session.

    " + }, + "StartTimestamp": { + "shape": "__string", + "documentation": "

    The date and time when the session began.

    " + }, + "StopTimestamp": { + "shape": "__string", + "documentation": "

    The date and time when the session ended.

    " + } + }, + "documentation": "

    Provides information about a session.

    ", + "required": [ + "StartTimestamp", + "Id" + ] + }, + "SetDimension": { + "type": "structure", + "members": { + "DimensionType": { + "shape": "DimensionType", + "documentation": "

    The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.

    " + }, + "Values": { + "shape": "ListOf__string", + "documentation": "

    The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

    " + } + }, + "documentation": "

    Specifies the dimension type and values for a segment dimension.

    ", + "required": [ + "Values" + ] + }, + "SimpleCondition": { + "type": "structure", + "members": { + "EventCondition": { + "shape": "EventCondition", + "documentation": "

    The dimension settings for the event that's associated with the activity.

    " + }, + "SegmentCondition": { + "shape": "SegmentCondition", + "documentation": "

    The segment that's associated with the activity.

    " + }, + "SegmentDimensions": { + "shape": "SegmentDimensions", + "locationName": "segmentDimensions", + "documentation": "

    The dimension settings for the segment that's associated with the activity.

    " + } + }, + "documentation": "

    Specifies a condition to evaluate for an activity in a journey.

    " + }, + "SimpleEmail": { + "type": "structure", + "members": { + "HtmlPart": { + "shape": "SimpleEmailPart", + "documentation": "

    The body of the email message, in HTML format. We recommend using an HTML part for email clients that support HTML. You can include links, formatted text, and more in an HTML message.

    " + }, + "Subject": { + "shape": "SimpleEmailPart", + "documentation": "

    The subject line, or title, of the email.

    " + }, + "TextPart": { + "shape": "SimpleEmailPart", + "documentation": "

    The body of the email message, in text format. We recommend using a text part for email clients that don't support HTML and clients that are connected to high-latency networks, such as mobile devices.

    " + } + }, + "documentation": "

    Specifies the contents of an email message, composed of a subject, a text part, and an HTML part.

    " + }, + "SimpleEmailPart": { + "type": "structure", + "members": { + "Charset": { + "shape": "__string", + "documentation": "

    The applicable character set for the message content.

    " + }, + "Data": { + "shape": "__string", + "documentation": "

    The textual data of the message content.

    " + } + }, + "documentation": "

    Specifies the subject or body of an email message, represented as textual email data and the applicable character set.

    " + }, + "SourceType": { + "type": "string", + "enum": [ + "ALL", + "ANY", + "NONE" + ] + }, + "StartCondition": { + "type": "structure", + "members": { + "Description": { + "shape": "__string", + "documentation": "

    The custom description of the condition.

    " + }, + "SegmentStartCondition": { + "shape": "SegmentCondition", + "documentation": "

    The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.

    " + } + }, + "documentation": "

    Specifies the conditions for the first activity in a journey. This activity and its conditions determine which users are participants in a journey.

    " + }, + "State": { + "type": "string", + "enum": [ + "DRAFT", + "ACTIVE", + "COMPLETED", + "CANCELLED", + "CLOSED" + ] + }, + "TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "TagsModel": { + "shape": "TagsModel" + } + }, + "required": [ + "ResourceArn", + "TagsModel" + ], + "payload": "TagsModel" + }, + "TagsModel": { + "type": "structure", + "members": { + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags for an application, campaign, journey, message template, or segment. Each of these resources can have a maximum of 50 tags.

    Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

    " + } + }, + "documentation": "

    Specifies the tags (keys and values) for an application, campaign, journey, message template, or segment.

    ", + "required": [ + "tags" + ] + }, + "Template": { + "type": "structure", + "members": { + "Name": { + "shape": "__string", + "documentation": "

    The name of the message template to use for the message. If specified, this value must match the name of an existing message template.

    " + } + }, + "documentation": "

    Specifies the name of the message template to use for the message.

    " + }, + "TemplateConfiguration": { + "type": "structure", + "members": { + "EmailTemplate": { + "shape": "Template", + "documentation": "

    The email template to use for the message.

    " + }, + "PushTemplate": { + "shape": "Template", + "documentation": "

    The push notification template to use for the message.

    " + }, + "SMSTemplate": { + "shape": "Template", + "documentation": "

    The SMS template to use for the message.

    " + } + }, + "documentation": "

    Specifies the message template for each type of channel.

    " + }, + "TemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the message template.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date when the message template was created.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date when the message template was last modified.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateName": { + "shape": "__string", + "documentation": "

    The name of the message template.

    " + }, + "TemplateType": { + "shape": "TemplateType", + "documentation": "

    The type of channel that the message template is designed for.

    " + } + }, + "documentation": "

    Provides information about a message template that's associated with your Amazon Pinpoint account.

    ", + "required": [ + "LastModifiedDate", + "CreationDate", + "TemplateName", + "TemplateType" + ] + }, + "TemplateType": { + "type": "string", + "enum": [ + "EMAIL", + "SMS", + "VOICE", + "PUSH" + ] + }, + "TemplatesResponse": { + "type": "structure", + "members": { + "Item": { + "shape": "ListOfTemplateResponse", + "documentation": "

    An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.

    " + }, + "NextToken": { + "shape": "__string", + "documentation": "

    The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

    " + } + }, + "documentation": "

    Provides information about all the message templates that are associated with your Amazon Pinpoint account.

    ", + "required": [ + "Item" + ] + }, + "TooManyRequestsException": { + "type": "structure", + "members": { + "Message": { + "shape": "__string", + "documentation": "

    The message that's returned from the API.

    " + }, + "RequestID": { + "shape": "__string", + "documentation": "

    The unique identifier for the request or response.

    " + } + }, + "documentation": "

    Provides information about an API request or response.

    ", + "exception": true, + "error": { + "httpStatusCode": 429 + } + }, + "TreatmentResource": { + "type": "structure", + "members": { + "Id": { + "shape": "__string", + "documentation": "

    The unique identifier for the treatment.

    " + }, + "MessageConfiguration": { + "shape": "MessageConfiguration", + "documentation": "

    The message configuration settings for the treatment.

    " + }, + "Schedule": { + "shape": "Schedule", + "documentation": "

    The schedule settings for the treatment.

    " + }, + "SizePercent": { + "shape": "__integer", + "documentation": "

    The allocated percentage of users (segment members) that the treatment is sent to.

    " + }, + "State": { + "shape": "CampaignState", + "documentation": "

    The current status of the treatment.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template to use for the treatment.

    " + }, + "TreatmentDescription": { + "shape": "__string", + "documentation": "

    The custom description of the treatment.

    " + }, + "TreatmentName": { + "shape": "__string", + "documentation": "

    The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    " + } + }, + "documentation": "

    Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    ", + "required": [ + "Id", + "SizePercent" + ] + }, + "Type": { + "type": "string", + "enum": [ + "ALL", + "ANY", + "NONE" + ] + }, + "UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "shape": "__string", + "location": "uri", + "locationName": "resource-arn", + "documentation": "

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "TagKeys": { + "shape": "ListOf__string", + "location": "querystring", + "locationName": "tagKeys", + "documentation": "

    The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

    " + } + }, + "required": [ + "TagKeys", + "ResourceArn" + ] + }, + "UpdateAdmChannelRequest": { + "type": "structure", + "members": { + "ADMChannelRequest": { + "shape": "ADMChannelRequest" + }, + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId", + "ADMChannelRequest" + ], + "payload": "ADMChannelRequest" + }, + "UpdateAdmChannelResponse": { + "type": "structure", + "members": { + "ADMChannelResponse": { + "shape": "ADMChannelResponse" + } + }, + "required": [ + "ADMChannelResponse" + ], + "payload": "ADMChannelResponse" + }, + "UpdateApnsChannelRequest": { + "type": "structure", + "members": { + "APNSChannelRequest": { + "shape": "APNSChannelRequest" + }, + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId", + "APNSChannelRequest" + ], + "payload": "APNSChannelRequest" + }, + "UpdateApnsChannelResponse": { + "type": "structure", + "members": { + "APNSChannelResponse": { + "shape": "APNSChannelResponse" + } + }, + "required": [ + "APNSChannelResponse" + ], + "payload": "APNSChannelResponse" + }, + "UpdateApnsSandboxChannelRequest": { + "type": "structure", + "members": { + "APNSSandboxChannelRequest": { + "shape": "APNSSandboxChannelRequest" + }, + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId", + "APNSSandboxChannelRequest" + ], + "payload": "APNSSandboxChannelRequest" + }, + "UpdateApnsSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSSandboxChannelResponse": { + "shape": "APNSSandboxChannelResponse" + } + }, + "required": [ + "APNSSandboxChannelResponse" + ], + "payload": "APNSSandboxChannelResponse" + }, + "UpdateApnsVoipChannelRequest": { + "type": "structure", + "members": { + "APNSVoipChannelRequest": { + "shape": "APNSVoipChannelRequest" + }, + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId", + "APNSVoipChannelRequest" + ], + "payload": "APNSVoipChannelRequest" + }, + "UpdateApnsVoipChannelResponse": { + "type": "structure", + "members": { + "APNSVoipChannelResponse": { + "shape": "APNSVoipChannelResponse" + } + }, + "required": [ + "APNSVoipChannelResponse" + ], + "payload": "APNSVoipChannelResponse" + }, + "UpdateApnsVoipSandboxChannelRequest": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelRequest": { + "shape": "APNSVoipSandboxChannelRequest" + }, + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + } + }, + "required": [ + "ApplicationId", + "APNSVoipSandboxChannelRequest" + ], + "payload": "APNSVoipSandboxChannelRequest" + }, + "UpdateApnsVoipSandboxChannelResponse": { + "type": "structure", + "members": { + "APNSVoipSandboxChannelResponse": { + "shape": "APNSVoipSandboxChannelResponse" + } + }, + "required": [ + "APNSVoipSandboxChannelResponse" + ], + "payload": "APNSVoipSandboxChannelResponse" + }, + "UpdateApplicationSettingsRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "WriteApplicationSettingsRequest": { + "shape": "WriteApplicationSettingsRequest" + } + }, + "required": [ + "ApplicationId", + "WriteApplicationSettingsRequest" + ], + "payload": "WriteApplicationSettingsRequest" + }, + "UpdateApplicationSettingsResponse": { + "type": "structure", + "members": { + "ApplicationSettingsResource": { + "shape": "ApplicationSettingsResource" + } + }, + "required": [ + "ApplicationSettingsResource" + ], + "payload": "ApplicationSettingsResource" + }, + "UpdateAttributesRequest": { + "type": "structure", + "members": { + "Blacklist": { + "shape": "ListOf__string", + "documentation": "

    An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.

    " + } + }, + "documentation": "

    Specifies one or more attributes to remove from all the endpoints that are associated with an application.

    " + }, + "UpdateBaiduChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "BaiduChannelRequest": { + "shape": "BaiduChannelRequest" + } + }, + "required": [ + "ApplicationId", + "BaiduChannelRequest" + ], + "payload": "BaiduChannelRequest" + }, + "UpdateBaiduChannelResponse": { + "type": "structure", + "members": { + "BaiduChannelResponse": { + "shape": "BaiduChannelResponse" + } + }, + "required": [ + "BaiduChannelResponse" + ], + "payload": "BaiduChannelResponse" + }, + "UpdateCampaignRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "CampaignId": { + "shape": "__string", + "location": "uri", + "locationName": "campaign-id", + "documentation": "

    The unique identifier for the campaign.

    " + }, + "WriteCampaignRequest": { + "shape": "WriteCampaignRequest" + } + }, + "required": [ + "CampaignId", + "ApplicationId", + "WriteCampaignRequest" + ], + "payload": "WriteCampaignRequest" + }, + "UpdateCampaignResponse": { + "type": "structure", + "members": { + "CampaignResponse": { + "shape": "CampaignResponse" + } + }, + "required": [ + "CampaignResponse" + ], + "payload": "CampaignResponse" + }, + "UpdateEmailChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EmailChannelRequest": { + "shape": "EmailChannelRequest" + } + }, + "required": [ + "ApplicationId", + "EmailChannelRequest" + ], + "payload": "EmailChannelRequest" + }, + "UpdateEmailChannelResponse": { + "type": "structure", + "members": { + "EmailChannelResponse": { + "shape": "EmailChannelResponse" + } + }, + "required": [ + "EmailChannelResponse" + ], + "payload": "EmailChannelResponse" + }, + "UpdateEmailTemplateRequest": { + "type": "structure", + "members": { + "EmailTemplateRequest": { + "shape": "EmailTemplateRequest" + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "EmailTemplateRequest" + ], + "payload": "EmailTemplateRequest" + }, + "UpdateEmailTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "UpdateEndpointRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndpointId": { + "shape": "__string", + "location": "uri", + "locationName": "endpoint-id", + "documentation": "

    The unique identifier for the endpoint.

    " + }, + "EndpointRequest": { + "shape": "EndpointRequest" + } + }, + "required": [ + "ApplicationId", + "EndpointId", + "EndpointRequest" + ], + "payload": "EndpointRequest" + }, + "UpdateEndpointResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "UpdateEndpointsBatchRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "EndpointBatchRequest": { + "shape": "EndpointBatchRequest" + } + }, + "required": [ + "ApplicationId", + "EndpointBatchRequest" + ], + "payload": "EndpointBatchRequest" + }, + "UpdateEndpointsBatchResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "UpdateGcmChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "GCMChannelRequest": { + "shape": "GCMChannelRequest" + } + }, + "required": [ + "ApplicationId", + "GCMChannelRequest" + ], + "payload": "GCMChannelRequest" + }, + "UpdateGcmChannelResponse": { + "type": "structure", + "members": { + "GCMChannelResponse": { + "shape": "GCMChannelResponse" + } + }, + "required": [ + "GCMChannelResponse" + ], + "payload": "GCMChannelResponse" + }, + "UpdateJourneyRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + }, + "WriteJourneyRequest": { + "shape": "WriteJourneyRequest" + } + }, + "required": [ + "JourneyId", + "ApplicationId", + "WriteJourneyRequest" + ], + "payload": "WriteJourneyRequest" + }, + "UpdateJourneyResponse": { + "type": "structure", + "members": { + "JourneyResponse": { + "shape": "JourneyResponse" + } + }, + "required": [ + "JourneyResponse" + ], + "payload": "JourneyResponse" + }, + "UpdateJourneyStateRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "JourneyId": { + "shape": "__string", + "location": "uri", + "locationName": "journey-id", + "documentation": "

    The unique identifier for the journey.

    " + }, + "JourneyStateRequest": { + "shape": "JourneyStateRequest" + } + }, + "required": [ + "JourneyId", + "ApplicationId", + "JourneyStateRequest" + ], + "payload": "JourneyStateRequest" + }, + "UpdateJourneyStateResponse": { + "type": "structure", + "members": { + "JourneyResponse": { + "shape": "JourneyResponse" + } + }, + "required": [ + "JourneyResponse" + ], + "payload": "JourneyResponse" + }, + "UpdatePushTemplateRequest": { + "type": "structure", + "members": { + "PushNotificationTemplateRequest": { + "shape": "PushNotificationTemplateRequest", + "documentation": "

    Updates an existing message template that you can use in messages that are sent through a push notification channel.

    " + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "PushNotificationTemplateRequest" + ], + "payload": "PushNotificationTemplateRequest" + }, + "UpdatePushTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "UpdateSegmentRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SegmentId": { + "shape": "__string", + "location": "uri", + "locationName": "segment-id", + "documentation": "

    The unique identifier for the segment.

    " + }, + "WriteSegmentRequest": { + "shape": "WriteSegmentRequest" + } + }, + "required": [ + "SegmentId", + "ApplicationId", + "WriteSegmentRequest" + ], + "payload": "WriteSegmentRequest" + }, + "UpdateSegmentResponse": { + "type": "structure", + "members": { + "SegmentResponse": { + "shape": "SegmentResponse" + } + }, + "required": [ + "SegmentResponse" + ], + "payload": "SegmentResponse" + }, + "UpdateSmsChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "SMSChannelRequest": { + "shape": "SMSChannelRequest" + } + }, + "required": [ + "ApplicationId", + "SMSChannelRequest" + ], + "payload": "SMSChannelRequest" + }, + "UpdateSmsChannelResponse": { + "type": "structure", + "members": { + "SMSChannelResponse": { + "shape": "SMSChannelResponse" + } + }, + "required": [ + "SMSChannelResponse" + ], + "payload": "SMSChannelResponse" + }, + "UpdateSmsTemplateRequest": { + "type": "structure", + "members": { + "SMSTemplateRequest": { + "shape": "SMSTemplateRequest" + }, + "TemplateName": { + "shape": "__string", + "location": "uri", + "locationName": "template-name", + "documentation": "

    The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.

    " + } + }, + "required": [ + "TemplateName", + "SMSTemplateRequest" + ], + "payload": "SMSTemplateRequest" + }, + "UpdateSmsTemplateResponse": { + "type": "structure", + "members": { + "MessageBody": { + "shape": "MessageBody" + } + }, + "required": [ + "MessageBody" + ], + "payload": "MessageBody" + }, + "UpdateVoiceChannelRequest": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "location": "uri", + "locationName": "application-id", + "documentation": "

    The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    " + }, + "VoiceChannelRequest": { + "shape": "VoiceChannelRequest" + } + }, + "required": [ + "ApplicationId", + "VoiceChannelRequest" + ], + "payload": "VoiceChannelRequest" + }, + "UpdateVoiceChannelResponse": { + "type": "structure", + "members": { + "VoiceChannelResponse": { + "shape": "VoiceChannelResponse" + } + }, + "required": [ + "VoiceChannelResponse" + ], + "payload": "VoiceChannelResponse" + }, + "VoiceChannelRequest": { + "type": "structure", + "members": { + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable the voice channel for the application.

    " + } + }, + "documentation": "

    Specifies the status and settings of the voice channel for an application.

    " + }, + "VoiceChannelResponse": { + "type": "structure", + "members": { + "ApplicationId": { + "shape": "__string", + "documentation": "

    The unique identifier for the application that the voice channel applies to.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the voice channel was enabled.

    " + }, + "Enabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether the voice channel is enabled for the application.

    " + }, + "HasCredential": { + "shape": "__boolean", + "documentation": "

    (Not used) This property is retained only for backward compatibility.

    " + }, + "Id": { + "shape": "__string", + "documentation": "

    (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.

    " + }, + "IsArchived": { + "shape": "__boolean", + "documentation": "

    Specifies whether the voice channel is archived.

    " + }, + "LastModifiedBy": { + "shape": "__string", + "documentation": "

    The user who last modified the voice channel.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when the voice channel was last modified.

    " + }, + "Platform": { + "shape": "__string", + "documentation": "

    The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.

    " + }, + "Version": { + "shape": "__integer", + "documentation": "

    The current version of the voice channel.

    " + } + }, + "documentation": "

    Provides information about the status and settings of the voice channel for an application.

    ", + "required": [ + "Platform" + ] + }, + "VoiceMessage": { + "type": "structure", + "members": { + "Body": { + "shape": "__string", + "documentation": "

    The text script for the voice message.

    " + }, + "LanguageCode": { + "shape": "__string", + "documentation": "

    The language to use when delivering the message. For a list of supported languages, see the Amazon Polly Developer Guide.

    " + }, + "OriginationNumber": { + "shape": "__string", + "documentation": "

    The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.

    " + }, + "Substitutions": { + "shape": "MapOfListOf__string", + "documentation": "

    The default message variables to use in the voice message. You can override the default variables with individual address variables.

    " + }, + "VoiceId": { + "shape": "__string", + "documentation": "

    The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.

    " + } + }, + "documentation": "

    Specifies the settings for a one-time voice message that's sent directly to an endpoint through the voice channel.

    " + }, + "WaitActivity": { + "type": "structure", + "members": { + "NextActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the next activity to perform, after performing the wait activity.

    " + }, + "WaitTime": { + "shape": "WaitTime", + "documentation": "

    The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.

    " + } + }, + "documentation": "

    Specifies the settings for a wait activity in a journey. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

    " + }, + "WaitTime": { + "type": "structure", + "members": { + "WaitFor": { + "shape": "__string", + "documentation": "

    The amount of time, as a duration in ISO 8601 format, to wait before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.

    " + }, + "WaitUntil": { + "shape": "__string", + "documentation": "

    The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.

    " + } + }, + "documentation": "

    Specifies a duration or a date and time that indicates when Amazon Pinpoint determines whether an activity's conditions have been met or an activity moves participants to the next activity in a journey.

    " + }, + "WriteApplicationSettingsRequest": { + "type": "structure", + "members": { + "CampaignHook": { + "shape": "CampaignHook", + "documentation": "

    The settings for the AWS Lambda function to use by default as a code hook for campaigns in the application. To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.

    " + }, + "CloudWatchMetricsEnabled": { + "shape": "__boolean", + "documentation": "

    Specifies whether to enable application-related alarms in Amazon CloudWatch.

    " + }, + "Limits": { + "shape": "CampaignLimits", + "documentation": "

    The default sending limits for campaigns in the application. To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.

    " + }, + "QuietTime": { + "shape": "QuietTime", + "documentation": "

    The default quiet time for campaigns and journeys in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

    • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings).

    • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings).

    If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.

    To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.

    " + } + }, + "documentation": "

    Specifies the default settings for an application.

    " + }, + "WriteCampaignRequest": { + "type": "structure", + "members": { + "AdditionalTreatments": { + "shape": "ListOfWriteTreatmentResource", + "documentation": "

    An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.

    " + }, + "Description": { + "shape": "__string", + "documentation": "

    The custom description of the campaign.

    " + }, + "HoldoutPercent": { + "shape": "__integer", + "documentation": "

    The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.

    " + }, + "Hook": { + "shape": "CampaignHook", + "documentation": "

    The settings for the AWS Lambda function to use as a code hook for the campaign.

    " + }, + "IsPaused": { + "shape": "__boolean", + "documentation": "

    Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by setting this value to false.

    " + }, + "Limits": { + "shape": "CampaignLimits", + "documentation": "

    The messaging limits for the campaign.

    " + }, + "MessageConfiguration": { + "shape": "MessageConfiguration", + "documentation": "

    The message configuration settings for the campaign.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The custom name of the campaign.

    " + }, + "Schedule": { + "shape": "Schedule", + "documentation": "

    The schedule settings for the campaign.

    " + }, + "SegmentId": { + "shape": "__string", + "documentation": "

    The unique identifier for the segment to associate with the campaign.

    " + }, + "SegmentVersion": { + "shape": "__integer", + "documentation": "

    The version of the segment to associate with the campaign.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template to use for the campaign.

    " + }, + "TreatmentDescription": { + "shape": "__string", + "documentation": "

    The custom description of a variation of the campaign to use for A/B testing.

    " + }, + "TreatmentName": { + "shape": "__string", + "documentation": "

    The custom name of a variation of the campaign to use for A/B testing.

    " + } + }, + "documentation": "

    Specifies the configuration and other settings for a campaign.

    " + }, + "WriteEventStream": { + "type": "structure", + "members": { + "DestinationStreamArn": { + "shape": "__string", + "documentation": "

    The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.

    For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name\n

    For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name\n

    " + }, + "RoleArn": { + "shape": "__string", + "documentation": "

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

    " + } + }, + "documentation": "

    Specifies the Amazon Resource Name (ARN) of an event stream to publish events to and the AWS Identity and Access Management (IAM) role to use when publishing those events.

    ", + "required": [ + "RoleArn", + "DestinationStreamArn" + ] + }, + "WriteJourneyRequest": { + "type": "structure", + "members": { + "Activities": { + "shape": "MapOfActivity", + "documentation": "

    The configuration and other settings for the activities that comprise the journey.

    " + }, + "CreationDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the journey was created.

    " + }, + "LastModifiedDate": { + "shape": "__string", + "documentation": "

    The date, in ISO 8601 format, when the journey was last modified.

    " + }, + "Limits": { + "shape": "JourneyLimits", + "documentation": "

    The messaging and entry limits for the journey.

    " + }, + "LocalTime": { + "shape": "__boolean", + "documentation": "

    Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.

    " + }, + "QuietTime": { + "shape": "QuietTime", + "documentation": "

    The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met:

    • The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value.

    • The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey.

    • The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey.

    If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.

    " + }, + "RefreshFrequency": { + "shape": "__string", + "documentation": "

    The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.

    " + }, + "Schedule": { + "shape": "JourneySchedule", + "documentation": "

    The schedule settings for the journey.

    " + }, + "StartActivity": { + "shape": "__string", + "documentation": "

    The unique identifier for the first activity in the journey.

    " + }, + "StartCondition": { + "shape": "StartCondition", + "documentation": "

    The segment that defines which users are participants in the journey.

    " + }, + "State": { + "shape": "State", + "documentation": "

    The status of the journey. Valid values are:

    • DRAFT - Saves the journey and doesn't publish it.

    • ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it.

    The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.

    " + } + }, + "documentation": "

    Specifies the configuration and other settings for a journey.

    ", + "required": [ + "Name" + ] + }, + "WriteSegmentRequest": { + "type": "structure", + "members": { + "Dimensions": { + "shape": "SegmentDimensions", + "documentation": "

    The criteria that define the dimensions for the segment.

    " + }, + "Name": { + "shape": "__string", + "documentation": "

    The name of the segment.

    " + }, + "SegmentGroups": { + "shape": "SegmentGroupList", + "documentation": "

    The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.

    " + }, + "tags": { + "shape": "MapOf__string", + "locationName": "tags", + "documentation": "

    A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.

    " + } + }, + "documentation": "

    Specifies the configuration, dimension, and other settings for a segment. A WriteSegmentRequest object can include a Dimensions object or a SegmentGroups object, but not both.

    " + }, + "WriteTreatmentResource": { + "type": "structure", + "members": { + "MessageConfiguration": { + "shape": "MessageConfiguration", + "documentation": "

    The message configuration settings for the treatment.

    " + }, + "Schedule": { + "shape": "Schedule", + "documentation": "

    The schedule settings for the treatment.

    " + }, + "SizePercent": { + "shape": "__integer", + "documentation": "

    The allocated percentage of users (segment members) to send the treatment to.

    " + }, + "TemplateConfiguration": { + "shape": "TemplateConfiguration", + "documentation": "

    The message template to use for the treatment.

    " + }, + "TreatmentDescription": { + "shape": "__string", + "documentation": "

    The custom description of the treatment.

    " + }, + "TreatmentName": { + "shape": "__string", + "documentation": "

    The custom name of the treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    " + } + }, + "documentation": "

    Specifies the settings for a campaign treatment. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

    ", + "required": [ + "SizePercent" + ] + }, + "__boolean": { + "type": "boolean" + }, + "__double": { + "type": "double" + }, + "__integer": { + "type": "integer" + }, + "ListOfActivityResponse": { + "type": "list", + "member": { + "shape": "ActivityResponse" + } + }, + "ListOfApplicationResponse": { + "type": "list", + "member": { + "shape": "ApplicationResponse" + } + }, + "ListOfCampaignResponse": { + "type": "list", + "member": { + "shape": "CampaignResponse" + } + }, + "ListOfEndpointBatchItem": { + "type": "list", + "member": { + "shape": "EndpointBatchItem" + } + }, + "ListOfEndpointResponse": { + "type": "list", + "member": { + "shape": "EndpointResponse" + } + }, + "ListOfExportJobResponse": { + "type": "list", + "member": { + "shape": "ExportJobResponse" + } + }, + "ListOfImportJobResponse": { + "type": "list", + "member": { + "shape": "ImportJobResponse" + } + }, + "ListOfJourneyResponse": { + "type": "list", + "member": { + "shape": "JourneyResponse" + } + }, + "ListOfMultiConditionalBranch": { + "type": "list", + "member": { + "shape": "MultiConditionalBranch" + } + }, + "ListOfRandomSplitEntry": { + "type": "list", + "member": { + "shape": "RandomSplitEntry" + } + }, + "ListOfResultRow": { + "type": "list", + "member": { + "shape": "ResultRow" + } + }, + "ListOfResultRowValue": { + "type": "list", + "member": { + "shape": "ResultRowValue" + } + }, + "ListOfSegmentDimensions": { + "type": "list", + "member": { + "shape": "SegmentDimensions" + } + }, + "ListOfSegmentGroup": { + "type": "list", + "member": { + "shape": "SegmentGroup" + } + }, + "ListOfSegmentReference": { + "type": "list", + "member": { + "shape": "SegmentReference" + } + }, + "ListOfSegmentResponse": { + "type": "list", + "member": { + "shape": "SegmentResponse" + } + }, + "ListOfSimpleCondition": { + "type": "list", + "member": { + "shape": "SimpleCondition" + } + }, + "ListOfTemplateResponse": { + "type": "list", + "member": { + "shape": "TemplateResponse" + } + }, + "ListOfTreatmentResource": { + "type": "list", + "member": { + "shape": "TreatmentResource" + } + }, + "ListOfWriteTreatmentResource": { + "type": "list", + "member": { + "shape": "WriteTreatmentResource" + } + }, + "ListOf__string": { + "type": "list", + "member": { + "shape": "__string" + } + }, + "__long": { + "type": "long" + }, + "MapOfActivity": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "Activity" + } + }, + "MapOfAddressConfiguration": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "AddressConfiguration" + } + }, + "MapOfAttributeDimension": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "AttributeDimension" + } + }, + "MapOfChannelResponse": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "ChannelResponse" + } + }, + "MapOfEndpointMessageResult": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "EndpointMessageResult" + } + }, + "MapOfEndpointSendConfiguration": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "EndpointSendConfiguration" + } + }, + "MapOfEvent": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "Event" + } + }, + "MapOfEventItemResponse": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "EventItemResponse" + } + }, + "MapOfEventsBatch": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "EventsBatch" + } + }, + "MapOfItemResponse": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "ItemResponse" + } + }, + "MapOfMessageResult": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "MessageResult" + } + }, + "MapOfMetricDimension": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "MetricDimension" + } + }, + "MapOf__double": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__double" + } + }, + "MapOf__integer": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__integer" + } + }, + "MapOfListOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "ListOf__string" + } + }, + "MapOfMapOfEndpointMessageResult": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "MapOfEndpointMessageResult" + } + }, + "MapOf__string": { + "type": "map", + "key": { + "shape": "__string" + }, + "value": { + "shape": "__string" + } + }, + "__string": { + "type": "string" + }, + "__timestampIso8601": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "__timestampUnix": { + "type": "timestamp", + "timestampFormat": "unixTimestamp" + } + } +} \ No newline at end of file diff --git a/aws/dist/botocore/data/polly/2016-06-10/examples-1.json b/aws/dist/botocore/data/polly/2016-06-10/examples-1.json new file mode 100644 index 00000000..38205dbe --- /dev/null +++ b/aws/dist/botocore/data/polly/2016-06-10/examples-1.json @@ -0,0 +1,171 @@ +{ + "version": "1.0", + "examples": { + "DeleteLexicon": [ + { + "input": { + "Name": "example" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes a specified pronunciation lexicon stored in an AWS Region.", + "id": "to-delete-a-lexicon-1481922498332", + "title": "To delete a lexicon" + } + ], + "DescribeVoices": [ + { + "input": { + "LanguageCode": "en-GB" + }, + "output": { + "Voices": [ + { + "Gender": "Female", + "Id": "Emma", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Emma" + }, + { + "Gender": "Male", + "Id": "Brian", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Brian" + }, + { + "Gender": "Female", + "Id": "Amy", + "LanguageCode": "en-GB", + "LanguageName": "British English", + "Name": "Amy" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the list of voices that are available for use when requesting speech synthesis. Displayed languages are those within the specified language code. If no language code is specified, voices for all available languages are displayed.", + "id": "to-describe-available-voices-1482180557753", + "title": "To describe available voices" + } + ], + "GetLexicon": [ + { + "input": { + "Name": "" + }, + "output": { + "Lexicon": { + "Content": "\r\n\r\n \r\n W3C\r\n World Wide Web Consortium\r\n \r\n", + "Name": "example" + }, + "LexiconAttributes": { + "Alphabet": "ipa", + "LanguageCode": "en-US", + "LastModified": 1478542980.117, + "LexemesCount": 1, + "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example", + "Size": 503 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the content of the specified pronunciation lexicon stored in an AWS Region.", + "id": "to-retrieve-a-lexicon-1481912870836", + "title": "To retrieve a lexicon" + } + ], + "ListLexicons": [ + { + "input": { + }, + "output": { + "Lexicons": [ + { + "Attributes": { + "Alphabet": "ipa", + "LanguageCode": "en-US", + "LastModified": 1478542980.117, + "LexemesCount": 1, + "LexiconArn": "arn:aws:polly:us-east-1:123456789012:lexicon/example", + "Size": 503 + }, + "Name": "example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of pronunciation lexicons stored in an AWS Region.", + "id": "to-list-all-lexicons-in-a-region-1481842106487", + "title": "To list all lexicons in a region" + } + ], + "PutLexicon": [ + { + "input": { + "Content": "file://example.pls", + "Name": "W3C" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Stores a pronunciation lexicon in an AWS Region.", + "id": "to-save-a-lexicon-1482272584088", + "title": "To save a lexicon" + } + ], + "SynthesizeSpeech": [ + { + "input": { + "LexiconNames": [ + "example" + ], + "OutputFormat": "mp3", + "SampleRate": "8000", + "Text": "All Gaul is divided into three parts", + "TextType": "text", + "VoiceId": "Joanna" + }, + "output": { + "AudioStream": "TEXT", + "ContentType": "audio/mpeg", + "RequestCharacters": 37 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Synthesizes plain text or SSML into a file of human-like speech.", + "id": "to-synthesize-speech-1482186064046", + "title": "To synthesize speech" + } + ] + } +} diff --git a/aws/dist/botocore/data/polly/2016-06-10/paginators-1.json b/aws/dist/botocore/data/polly/2016-06-10/paginators-1.json new file mode 100644 index 00000000..dc76e7c1 --- /dev/null +++ b/aws/dist/botocore/data/polly/2016-06-10/paginators-1.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "DescribeVoices": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Voices" + }, + "ListLexicons": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Lexicons" + }, + "ListSpeechSynthesisTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SynthesisTasks" + } + } +} diff --git a/aws/dist/botocore/data/polly/2016-06-10/service-2.json b/aws/dist/botocore/data/polly/2016-06-10/service-2.json new file mode 100644 index 00000000..a3c4055f --- /dev/null +++ b/aws/dist/botocore/data/polly/2016-06-10/service-2.json @@ -0,0 +1,1077 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-06-10", + "endpointPrefix":"polly", + "protocol":"rest-json", + "serviceFullName":"Amazon Polly", + "serviceId":"Polly", + "signatureVersion":"v4", + "uid":"polly-2016-06-10" + }, + "operations":{ + "DeleteLexicon":{ + "name":"DeleteLexicon", + "http":{ + "method":"DELETE", + "requestUri":"/v1/lexicons/{LexiconName}", + "responseCode":200 + }, + "input":{"shape":"DeleteLexiconInput"}, + "output":{"shape":"DeleteLexiconOutput"}, + "errors":[ + {"shape":"LexiconNotFoundException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Deletes the specified pronunciation lexicon stored in an AWS Region. A lexicon which has been deleted is not available for speech synthesis, nor is it possible to retrieve it using either the GetLexicon or ListLexicon APIs.

    For more information, see Managing Lexicons.

    " + }, + "DescribeVoices":{ + "name":"DescribeVoices", + "http":{ + "method":"GET", + "requestUri":"/v1/voices", + "responseCode":200 + }, + "input":{"shape":"DescribeVoicesInput"}, + "output":{"shape":"DescribeVoicesOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Returns the list of voices that are available for use when requesting speech synthesis. Each voice speaks a specified language, is either male or female, and is identified by an ID, which is the ASCII version of the voice name.

    When synthesizing speech ( SynthesizeSpeech ), you provide the voice ID for the voice you want from the list of voices returned by DescribeVoices.

    For example, you want your news reader application to read news in a specific language, but giving a user the option to choose the voice. Using the DescribeVoices operation you can provide the user with a list of available voices to select from.

    You can optionally specify a language code to filter the available voices. For example, if you specify en-US, the operation returns a list of all available US English voices.

    This operation requires permissions to perform the polly:DescribeVoices action.

    " + }, + "GetLexicon":{ + "name":"GetLexicon", + "http":{ + "method":"GET", + "requestUri":"/v1/lexicons/{LexiconName}", + "responseCode":200 + }, + "input":{"shape":"GetLexiconInput"}, + "output":{"shape":"GetLexiconOutput"}, + "errors":[ + {"shape":"LexiconNotFoundException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Returns the content of the specified pronunciation lexicon stored in an AWS Region. For more information, see Managing Lexicons.

    " + }, + "GetSpeechSynthesisTask":{ + "name":"GetSpeechSynthesisTask", + "http":{ + "method":"GET", + "requestUri":"/v1/synthesisTasks/{TaskId}", + "responseCode":200 + }, + "input":{"shape":"GetSpeechSynthesisTaskInput"}, + "output":{"shape":"GetSpeechSynthesisTaskOutput"}, + "errors":[ + {"shape":"InvalidTaskIdException"}, + {"shape":"ServiceFailureException"}, + {"shape":"SynthesisTaskNotFoundException"} + ], + "documentation":"

    Retrieves a specific SpeechSynthesisTask object based on its TaskID. This object contains information about the given speech synthesis task, including the status of the task, and a link to the S3 bucket containing the output of the task.

    " + }, + "ListLexicons":{ + "name":"ListLexicons", + "http":{ + "method":"GET", + "requestUri":"/v1/lexicons", + "responseCode":200 + }, + "input":{"shape":"ListLexiconsInput"}, + "output":{"shape":"ListLexiconsOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Returns a list of pronunciation lexicons stored in an AWS Region. For more information, see Managing Lexicons.

    " + }, + "ListSpeechSynthesisTasks":{ + "name":"ListSpeechSynthesisTasks", + "http":{ + "method":"GET", + "requestUri":"/v1/synthesisTasks", + "responseCode":200 + }, + "input":{"shape":"ListSpeechSynthesisTasksInput"}, + "output":{"shape":"ListSpeechSynthesisTasksOutput"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Returns a list of SpeechSynthesisTask objects ordered by their creation date. This operation can filter the tasks by their status, for example, allowing users to list only tasks that are completed.

    " + }, + "PutLexicon":{ + "name":"PutLexicon", + "http":{ + "method":"PUT", + "requestUri":"/v1/lexicons/{LexiconName}", + "responseCode":200 + }, + "input":{"shape":"PutLexiconInput"}, + "output":{"shape":"PutLexiconOutput"}, + "errors":[ + {"shape":"InvalidLexiconException"}, + {"shape":"UnsupportedPlsAlphabetException"}, + {"shape":"UnsupportedPlsLanguageException"}, + {"shape":"LexiconSizeExceededException"}, + {"shape":"MaxLexemeLengthExceededException"}, + {"shape":"MaxLexiconsNumberExceededException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

    Stores a pronunciation lexicon in an AWS Region. If a lexicon with the same name already exists in the region, it is overwritten by the new lexicon. Lexicon operations have eventual consistency, therefore, it might take some time before the lexicon is available to the SynthesizeSpeech operation.

    For more information, see Managing Lexicons.

    " + }, + "StartSpeechSynthesisTask":{ + "name":"StartSpeechSynthesisTask", + "http":{ + "method":"POST", + "requestUri":"/v1/synthesisTasks", + "responseCode":200 + }, + "input":{"shape":"StartSpeechSynthesisTaskInput"}, + "output":{"shape":"StartSpeechSynthesisTaskOutput"}, + "errors":[ + {"shape":"TextLengthExceededException"}, + {"shape":"InvalidS3BucketException"}, + {"shape":"InvalidS3KeyException"}, + {"shape":"InvalidSampleRateException"}, + {"shape":"InvalidSnsTopicArnException"}, + {"shape":"InvalidSsmlException"}, + {"shape":"EngineNotSupportedException"}, + {"shape":"LexiconNotFoundException"}, + {"shape":"ServiceFailureException"}, + {"shape":"MarksNotSupportedForFormatException"}, + {"shape":"SsmlMarksNotSupportedForTextTypeException"}, + {"shape":"LanguageNotSupportedException"} + ], + "documentation":"

    Allows the creation of an asynchronous synthesis task, by starting a new SpeechSynthesisTask. This operation requires all the standard information needed for speech synthesis, plus the name of an Amazon S3 bucket for the service to store the output of the synthesis task and two optional parameters (OutputS3KeyPrefix and SnsTopicArn). Once the synthesis task is created, this operation will return a SpeechSynthesisTask object, which will include an identifier of this task as well as the current status.

    " + }, + "SynthesizeSpeech":{ + "name":"SynthesizeSpeech", + "http":{ + "method":"POST", + "requestUri":"/v1/speech", + "responseCode":200 + }, + "input":{"shape":"SynthesizeSpeechInput"}, + "output":{"shape":"SynthesizeSpeechOutput"}, + "errors":[ + {"shape":"TextLengthExceededException"}, + {"shape":"InvalidSampleRateException"}, + {"shape":"InvalidSsmlException"}, + {"shape":"LexiconNotFoundException"}, + {"shape":"ServiceFailureException"}, + {"shape":"MarksNotSupportedForFormatException"}, + {"shape":"SsmlMarksNotSupportedForTextTypeException"}, + {"shape":"LanguageNotSupportedException"}, + {"shape":"EngineNotSupportedException"} + ], + "documentation":"

    Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

    " + } + }, + "shapes":{ + "Alphabet":{"type":"string"}, + "AudioStream":{ + "type":"blob", + "streaming":true + }, + "ContentType":{"type":"string"}, + "DateTime":{"type":"timestamp"}, + "DeleteLexiconInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LexiconName", + "documentation":"

    The name of the lexicon to delete. Must be an existing lexicon in the region.

    ", + "location":"uri", + "locationName":"LexiconName" + } + } + }, + "DeleteLexiconOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeVoicesInput":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"Engine", + "documentation":"

    Specifies the engine (standard or neural) used by Amazon Polly when processing input text for speech synthesis.

    ", + "location":"querystring", + "locationName":"Engine" + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language identification tag (ISO 639 code for the language name-ISO 3166 country code) for filtering the list of voices returned. If you don't specify this optional parameter, all available voices are returned.

    ", + "location":"querystring", + "locationName":"LanguageCode" + }, + "IncludeAdditionalLanguageCodes":{ + "shape":"IncludeAdditionalLanguageCodes", + "documentation":"

    Boolean value indicating whether to return any bilingual voices that use the specified language as an additional language. For instance, if you request all languages that use US English (es-US), and there is an Italian voice that speaks both Italian (it-IT) and US English, that voice will be included if you specify yes but not if you specify no.

    ", + "location":"querystring", + "locationName":"IncludeAdditionalLanguageCodes" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    An opaque pagination token returned from the previous DescribeVoices operation. If present, this indicates where to continue the listing.

    ", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "DescribeVoicesOutput":{ + "type":"structure", + "members":{ + "Voices":{ + "shape":"VoiceList", + "documentation":"

    A list of voices with their properties.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token to use in the next request to continue the listing of voices. NextToken is returned only if the response is truncated.

    " + } + } + }, + "Engine":{ + "type":"string", + "enum":[ + "standard", + "neural" + ] + }, + "EngineList":{ + "type":"list", + "member":{"shape":"Engine"} + }, + "EngineNotSupportedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    This engine is not compatible with the voice that you have designated. Choose a new voice that is compatible with the engine or change the engine and restart the operation.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "Gender":{ + "type":"string", + "enum":[ + "Female", + "Male" + ] + }, + "GetLexiconInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LexiconName", + "documentation":"

    Name of the lexicon.

    ", + "location":"uri", + "locationName":"LexiconName" + } + } + }, + "GetLexiconOutput":{ + "type":"structure", + "members":{ + "Lexicon":{ + "shape":"Lexicon", + "documentation":"

    Lexicon object that provides name and the string content of the lexicon.

    " + }, + "LexiconAttributes":{ + "shape":"LexiconAttributes", + "documentation":"

    Metadata of the lexicon, including phonetic alphabetic used, language code, lexicon ARN, number of lexemes defined in the lexicon, and size of lexicon in bytes.

    " + } + } + }, + "GetSpeechSynthesisTaskInput":{ + "type":"structure", + "required":["TaskId"], + "members":{ + "TaskId":{ + "shape":"TaskId", + "documentation":"

    The Amazon Polly generated identifier for a speech synthesis task.

    ", + "location":"uri", + "locationName":"TaskId" + } + } + }, + "GetSpeechSynthesisTaskOutput":{ + "type":"structure", + "members":{ + "SynthesisTask":{ + "shape":"SynthesisTask", + "documentation":"

    SynthesisTask object that provides information from the requested task, including output format, creation time, task status, and so on.

    " + } + } + }, + "IncludeAdditionalLanguageCodes":{"type":"boolean"}, + "InvalidLexiconException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Amazon Polly can't find the specified lexicon. Verify that the lexicon's name is spelled correctly, and then try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The NextToken is invalid. Verify that it's spelled correctly, and then try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidS3BucketException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided Amazon S3 bucket name is invalid. Please check your input with S3 bucket naming requirements and try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidS3KeyException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided Amazon S3 key prefix is invalid. Please provide a valid S3 object key name.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSampleRateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified sample rate is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSnsTopicArnException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided SNS topic ARN is invalid. Please provide a valid SNS topic ARN and try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidSsmlException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The SSML you provided is invalid. Verify the SSML syntax, spelling of tags and values, and then try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTaskIdException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided Task ID is not valid. Please provide a valid Task ID and try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LanguageCode":{ + "type":"string", + "enum":[ + "arb", + "cmn-CN", + "cy-GB", + "da-DK", + "de-DE", + "en-AU", + "en-GB", + "en-GB-WLS", + "en-IN", + "en-US", + "es-ES", + "es-MX", + "es-US", + "fr-CA", + "fr-FR", + "is-IS", + "it-IT", + "ja-JP", + "hi-IN", + "ko-KR", + "nb-NO", + "nl-NL", + "pl-PL", + "pt-BR", + "pt-PT", + "ro-RO", + "ru-RU", + "sv-SE", + "tr-TR" + ] + }, + "LanguageCodeList":{ + "type":"list", + "member":{"shape":"LanguageCode"} + }, + "LanguageName":{"type":"string"}, + "LanguageNotSupportedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The language specified is not currently supported by Amazon Polly in this capacity.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LastModified":{"type":"timestamp"}, + "LexemesCount":{"type":"integer"}, + "Lexicon":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"LexiconContent", + "documentation":"

    Lexicon content in string format. The content of a lexicon must be in PLS format.

    " + }, + "Name":{ + "shape":"LexiconName", + "documentation":"

    Name of the lexicon.

    " + } + }, + "documentation":"

    Provides lexicon name and lexicon content in string format. For more information, see Pronunciation Lexicon Specification (PLS) Version 1.0.

    " + }, + "LexiconArn":{"type":"string"}, + "LexiconAttributes":{ + "type":"structure", + "members":{ + "Alphabet":{ + "shape":"Alphabet", + "documentation":"

    Phonetic alphabet used in the lexicon. Valid values are ipa and x-sampa.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    Language code that the lexicon applies to. A lexicon with a language code such as \"en\" would be applied to all English languages (en-GB, en-US, en-AUS, en-WLS, and so on.

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Date lexicon was last modified (a timestamp value).

    " + }, + "LexiconArn":{ + "shape":"LexiconArn", + "documentation":"

    Amazon Resource Name (ARN) of the lexicon.

    " + }, + "LexemesCount":{ + "shape":"LexemesCount", + "documentation":"

    Number of lexemes in the lexicon.

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    Total size of the lexicon, in characters.

    " + } + }, + "documentation":"

    Contains metadata describing the lexicon such as the number of lexemes, language code, and so on. For more information, see Managing Lexicons.

    " + }, + "LexiconContent":{"type":"string"}, + "LexiconDescription":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LexiconName", + "documentation":"

    Name of the lexicon.

    " + }, + "Attributes":{ + "shape":"LexiconAttributes", + "documentation":"

    Provides lexicon metadata.

    " + } + }, + "documentation":"

    Describes the content of the lexicon.

    " + }, + "LexiconDescriptionList":{ + "type":"list", + "member":{"shape":"LexiconDescription"} + }, + "LexiconName":{ + "type":"string", + "pattern":"[0-9A-Za-z]{1,20}", + "sensitive":true + }, + "LexiconNameList":{ + "type":"list", + "member":{"shape":"LexiconName"}, + "max":5 + }, + "LexiconNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Amazon Polly can't find the specified lexicon. This could be caused by a lexicon that is missing, its name is misspelled or specifying a lexicon that is in a different region.

    Verify that the lexicon exists, is in the region (see ListLexicons) and that you spelled its name is spelled correctly. Then try again.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "LexiconSizeExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum size of the specified lexicon would be exceeded by this operation.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListLexiconsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    An opaque pagination token returned from previous ListLexicons operation. If present, indicates where to continue the list of lexicons.

    ", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListLexiconsOutput":{ + "type":"structure", + "members":{ + "Lexicons":{ + "shape":"LexiconDescriptionList", + "documentation":"

    A list of lexicon names and attributes.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token to use in the next request to continue the listing of lexicons. NextToken is returned only if the response is truncated.

    " + } + } + }, + "ListSpeechSynthesisTasksInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of speech synthesis tasks returned in a List operation.

    ", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token to use in the next request to continue the listing of speech synthesis tasks.

    ", + "location":"querystring", + "locationName":"NextToken" + }, + "Status":{ + "shape":"TaskStatus", + "documentation":"

    Status of the speech synthesis tasks returned in a List operation

    ", + "location":"querystring", + "locationName":"Status" + } + } + }, + "ListSpeechSynthesisTasksOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    An opaque pagination token returned from the previous List operation in this request. If present, this indicates where to continue the listing.

    " + }, + "SynthesisTasks":{ + "shape":"SynthesisTasks", + "documentation":"

    List of SynthesisTask objects that provides information from the specified task in the list request, including output format, creation time, task status, and so on.

    " + } + } + }, + "MarksNotSupportedForFormatException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Speech marks are not supported for the OutputFormat selected. Speech marks are only available for content in json format.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MaxLexemeLengthExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum size of the lexeme would be exceeded by this operation.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MaxLexiconsNumberExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum number of lexicons would be exceeded by this operation.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":4096, + "min":0 + }, + "OutputFormat":{ + "type":"string", + "enum":[ + "json", + "mp3", + "ogg_vorbis", + "pcm" + ] + }, + "OutputS3BucketName":{ + "type":"string", + "pattern":"^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + }, + "OutputS3KeyPrefix":{ + "type":"string", + "pattern":"^[0-9a-zA-Z\\/\\!\\-_\\.\\*\\'\\(\\)]{0,800}$" + }, + "OutputUri":{"type":"string"}, + "PutLexiconInput":{ + "type":"structure", + "required":[ + "Name", + "Content" + ], + "members":{ + "Name":{ + "shape":"LexiconName", + "documentation":"

    Name of the lexicon. The name must follow the regular express format [0-9A-Za-z]{1,20}. That is, the name is a case-sensitive alphanumeric string up to 20 characters long.

    ", + "location":"uri", + "locationName":"LexiconName" + }, + "Content":{ + "shape":"LexiconContent", + "documentation":"

    Content of the PLS lexicon as string data.

    " + } + } + }, + "PutLexiconOutput":{ + "type":"structure", + "members":{ + } + }, + "RequestCharacters":{"type":"integer"}, + "SampleRate":{"type":"string"}, + "ServiceFailureException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    An unknown condition has caused a service failure.

    ", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "Size":{"type":"integer"}, + "SnsTopicArn":{ + "type":"string", + "pattern":"^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\\d{12}:[a-zA-Z0-9_-]{1,256}$" + }, + "SpeechMarkType":{ + "type":"string", + "enum":[ + "sentence", + "ssml", + "viseme", + "word" + ] + }, + "SpeechMarkTypeList":{ + "type":"list", + "member":{"shape":"SpeechMarkType"}, + "max":4 + }, + "SsmlMarksNotSupportedForTextTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    SSML speech marks are not supported for plain text-type input.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "StartSpeechSynthesisTaskInput":{ + "type":"structure", + "required":[ + "OutputFormat", + "OutputS3BucketName", + "Text", + "VoiceId" + ], + "members":{ + "Engine":{ + "shape":"Engine", + "documentation":"

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    Optional language code for the Speech Synthesis request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    " + }, + "LexiconNames":{ + "shape":"LexiconNameList", + "documentation":"

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

    " + }, + "OutputFormat":{ + "shape":"OutputFormat", + "documentation":"

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

    " + }, + "OutputS3BucketName":{ + "shape":"OutputS3BucketName", + "documentation":"

    Amazon S3 bucket name to which the output file will be saved.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"OutputS3KeyPrefix", + "documentation":"

    The Amazon S3 key prefix for the output speech file.

    " + }, + "SampleRate":{ + "shape":"SampleRate", + "documentation":"

    The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " + }, + "SnsTopicArn":{ + "shape":"SnsTopicArn", + "documentation":"

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    " + }, + "SpeechMarkTypes":{ + "shape":"SpeechMarkTypeList", + "documentation":"

    The type of speech marks returned for the input text.

    " + }, + "Text":{ + "shape":"Text", + "documentation":"

    The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

    " + }, + "TextType":{ + "shape":"TextType", + "documentation":"

    Specifies whether the input text is plain text or SSML. The default value is plain text.

    " + }, + "VoiceId":{ + "shape":"VoiceId", + "documentation":"

    Voice ID to use for the synthesis.

    " + } + } + }, + "StartSpeechSynthesisTaskOutput":{ + "type":"structure", + "members":{ + "SynthesisTask":{ + "shape":"SynthesisTask", + "documentation":"

    SynthesisTask object that provides information and attributes about a newly submitted speech synthesis task.

    " + } + } + }, + "SynthesisTask":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"Engine", + "documentation":"

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

    " + }, + "TaskId":{ + "shape":"TaskId", + "documentation":"

    The Amazon Polly generated identifier for a speech synthesis task.

    " + }, + "TaskStatus":{ + "shape":"TaskStatus", + "documentation":"

    Current status of the individual speech synthesis task.

    " + }, + "TaskStatusReason":{ + "shape":"TaskStatusReason", + "documentation":"

    Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

    " + }, + "OutputUri":{ + "shape":"OutputUri", + "documentation":"

    Pathway for the output speech file.

    " + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

    Timestamp for the time the synthesis task was started.

    " + }, + "RequestCharacters":{ + "shape":"RequestCharacters", + "documentation":"

    Number of billable characters synthesized.

    " + }, + "SnsTopicArn":{ + "shape":"SnsTopicArn", + "documentation":"

    ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

    " + }, + "LexiconNames":{ + "shape":"LexiconNameList", + "documentation":"

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice.

    " + }, + "OutputFormat":{ + "shape":"OutputFormat", + "documentation":"

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

    " + }, + "SampleRate":{ + "shape":"SampleRate", + "documentation":"

    The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " + }, + "SpeechMarkTypes":{ + "shape":"SpeechMarkTypeList", + "documentation":"

    The type of speech marks returned for the input text.

    " + }, + "TextType":{ + "shape":"TextType", + "documentation":"

    Specifies whether the input text is plain text or SSML. The default value is plain text.

    " + }, + "VoiceId":{ + "shape":"VoiceId", + "documentation":"

    Voice ID to use for the synthesis.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    Optional language code for a synthesis task. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    " + } + }, + "documentation":"

    SynthesisTask object that provides information about a speech synthesis task.

    " + }, + "SynthesisTaskNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The Speech Synthesis task with requested Task ID cannot be found.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "SynthesisTasks":{ + "type":"list", + "member":{"shape":"SynthesisTask"} + }, + "SynthesizeSpeechInput":{ + "type":"structure", + "required":[ + "OutputFormat", + "Text", + "VoiceId" + ], + "members":{ + "Engine":{ + "shape":"Engine", + "documentation":"

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

    If a bilingual voice is used and no language code is specified, Amazon Polly will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

    " + }, + "LexiconNames":{ + "shape":"LexiconNameList", + "documentation":"

    List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

    " + }, + "OutputFormat":{ + "shape":"OutputFormat", + "documentation":"

    The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

    When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

    " + }, + "SampleRate":{ + "shape":"SampleRate", + "documentation":"

    The audio frequency specified in Hz.

    The valid values for mp3 and ogg_vorbis are \"8000\", \"16000\", \"22050\", and \"24000\". The default value for standard voices is \"22050\". The default value for neural voices is \"24000\".

    Valid values for pcm are \"8000\" and \"16000\" The default value is \"16000\".

    " + }, + "SpeechMarkTypes":{ + "shape":"SpeechMarkTypeList", + "documentation":"

    The type of speech marks returned for the input text.

    " + }, + "Text":{ + "shape":"Text", + "documentation":"

    Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

    " + }, + "TextType":{ + "shape":"TextType", + "documentation":"

    Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

    " + }, + "VoiceId":{ + "shape":"VoiceId", + "documentation":"

    Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

    " + } + } + }, + "SynthesizeSpeechOutput":{ + "type":"structure", + "members":{ + "AudioStream":{ + "shape":"AudioStream", + "documentation":"

    Stream containing the synthesized speech.

    " + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.

    • If you request mp3 as the OutputFormat, the ContentType returned is audio/mpeg.

    • If you request ogg_vorbis as the OutputFormat, the ContentType returned is audio/ogg.

    • If you request pcm as the OutputFormat, the ContentType returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

    • If you request json as the OutputFormat, the ContentType returned is audio/json.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "RequestCharacters":{ + "shape":"RequestCharacters", + "documentation":"

    Number of characters synthesized.

    ", + "location":"header", + "locationName":"x-amzn-RequestCharacters" + } + }, + "payload":"AudioStream" + }, + "TaskId":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_-]{1,100}$" + }, + "TaskStatus":{ + "type":"string", + "enum":[ + "scheduled", + "inProgress", + "completed", + "failed" + ] + }, + "TaskStatusReason":{"type":"string"}, + "Text":{"type":"string"}, + "TextLengthExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The value of the \"Text\" parameter is longer than the accepted limits. For the SynthesizeSpeech API, the limit for input text is a maximum of 6000 characters total, of which no more than 3000 can be billed characters. For the StartSpeechSynthesisTask API, the maximum is 200,000 characters, of which no more than 100,000 can be billed characters. SSML tags are not counted as billed characters.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TextType":{ + "type":"string", + "enum":[ + "ssml", + "text" + ] + }, + "UnsupportedPlsAlphabetException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The alphabet specified by the lexicon is not a supported alphabet. Valid values are x-sampa and ipa.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UnsupportedPlsLanguageException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The language specified in the lexicon is unsupported. For a list of supported languages, see Lexicon Attributes.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Voice":{ + "type":"structure", + "members":{ + "Gender":{ + "shape":"Gender", + "documentation":"

    Gender of the voice.

    " + }, + "Id":{ + "shape":"VoiceId", + "documentation":"

    Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    Language code of the voice.

    " + }, + "LanguageName":{ + "shape":"LanguageName", + "documentation":"

    Human readable name of the language in English.

    " + }, + "Name":{ + "shape":"VoiceName", + "documentation":"

    Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

    " + }, + "AdditionalLanguageCodes":{ + "shape":"LanguageCodeList", + "documentation":"

    Additional codes for languages available for the specified voice in addition to its default language.

    For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

    " + }, + "SupportedEngines":{ + "shape":"EngineList", + "documentation":"

    Specifies which engines (standard or neural) that are supported by a given voice.

    " + } + }, + "documentation":"

    Description of the voice.

    " + }, + "VoiceId":{ + "type":"string", + "enum":[ + "Aditi", + "Amy", + "Astrid", + "Bianca", + "Brian", + "Camila", + "Carla", + "Carmen", + "Celine", + "Chantal", + "Conchita", + "Cristiano", + "Dora", + "Emma", + "Enrique", + "Ewa", + "Filiz", + "Geraint", + "Giorgio", + "Gwyneth", + "Hans", + "Ines", + "Ivy", + "Jacek", + "Jan", + "Joanna", + "Joey", + "Justin", + "Karl", + "Kendra", + "Kimberly", + "Lea", + "Liv", + "Lotte", + "Lucia", + "Lupe", + "Mads", + "Maja", + "Marlene", + "Mathieu", + "Matthew", + "Maxim", + "Mia", + "Miguel", + "Mizuki", + "Naja", + "Nicole", + "Penelope", + "Raveena", + "Ricardo", + "Ruben", + "Russell", + "Salli", + "Seoyeon", + "Takumi", + "Tatyana", + "Vicki", + "Vitoria", + "Zeina", + "Zhiyu" + ] + }, + "VoiceList":{ + "type":"list", + "member":{"shape":"Voice"} + }, + "VoiceName":{"type":"string"} + }, + "documentation":"

    Amazon Polly is a web service that makes it easy to synthesize speech from text.

    The Amazon Polly service provides API operations for synthesizing high-quality speech from plain text and Speech Synthesis Markup Language (SSML), along with managing pronunciations lexicons that enable you to get the best results for your application domain.

    " +} diff --git a/aws/dist/botocore/data/pricing/2017-10-15/paginators-1.json b/aws/dist/botocore/data/pricing/2017-10-15/paginators-1.json new file mode 100644 index 00000000..c113c43f --- /dev/null +++ b/aws/dist/botocore/data/pricing/2017-10-15/paginators-1.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "DescribeServices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Services", + "non_aggregate_keys": ["FormatVersion"] + }, + "GetAttributeValues": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AttributeValues" + }, + "GetProducts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "PriceList", + "non_aggregate_keys": ["FormatVersion"] + } + } +} diff --git a/aws/dist/botocore/data/pricing/2017-10-15/service-2.json b/aws/dist/botocore/data/pricing/2017-10-15/service-2.json new file mode 100644 index 00000000..bc77bc67 --- /dev/null +++ b/aws/dist/botocore/data/pricing/2017-10-15/service-2.json @@ -0,0 +1,315 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-15", + "endpointPrefix":"api.pricing", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWS Pricing", + "serviceFullName":"AWS Price List Service", + "serviceId":"Pricing", + "signatureVersion":"v4", + "signingName":"pricing", + "targetPrefix":"AWSPriceListService", + "uid":"pricing-2017-10-15" + }, + "operations":{ + "DescribeServices":{ + "name":"DescribeServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServicesRequest"}, + "output":{"shape":"DescribeServicesResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"} + ], + "documentation":"

    Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

    " + }, + "GetAttributeValues":{ + "name":"GetAttributeValues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAttributeValuesRequest"}, + "output":{"shape":"GetAttributeValuesResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"} + ], + "documentation":"

    Returns a list of attribute values. Attibutes are similar to the details in a Price List API offer file. For a list of available attributes, see Offer File Definitions in the AWS Billing and Cost Management User Guide.

    " + }, + "GetProducts":{ + "name":"GetProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetProductsRequest"}, + "output":{"shape":"GetProductsResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ExpiredNextTokenException"} + ], + "documentation":"

    Returns a list of all products that match the filter criteria.

    " + } + }, + "shapes":{ + "AttributeNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "AttributeValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"String", + "documentation":"

    The specific value of an attributeName.

    " + } + }, + "documentation":"

    The values of a given attribute, such as Throughput Optimized HDD or Provisioned IOPS for the Amazon EC2 volumeType attribute.

    " + }, + "AttributeValueList":{ + "type":"list", + "member":{"shape":"AttributeValue"} + }, + "BoxedInteger":{ + "type":"integer", + "max":100, + "min":1 + }, + "DescribeServicesRequest":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"String", + "documentation":"

    The code for the service whose information you want to retrieve, such as AmazonEC2. You can use the ServiceCode to filter the results in a GetProducts call. To retrieve a list of all services, leave this blank.

    " + }, + "FormatVersion":{ + "shape":"String", + "documentation":"

    The format version that you want the response to be in.

    Valid values are: aws_v1

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token that indicates the next set of results that you want to retrieve.

    " + }, + "MaxResults":{ + "shape":"BoxedInteger", + "documentation":"

    The maximum number of results that you want returned in the response.

    ", + "box":true + } + } + }, + "DescribeServicesResponse":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ServiceList", + "documentation":"

    The service metadata for the service or services in the response.

    " + }, + "FormatVersion":{ + "shape":"String", + "documentation":"

    The format version of the response. For example, aws_v1.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token for the next set of retreivable results.

    " + } + } + }, + "ExpiredNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

    The pagination token expired. Try again without a pagination token.

    ", + "exception":true + }, + "Filter":{ + "type":"structure", + "required":[ + "Type", + "Field", + "Value" + ], + "members":{ + "Type":{ + "shape":"FilterType", + "documentation":"

    The type of filter that you want to use.

    Valid values are: TERM_MATCH. TERM_MATCH returns only products that match both the given filter field and the given value.

    " + }, + "Field":{ + "shape":"String", + "documentation":"

    The product metadata field that you want to filter on. You can filter by just the service code to see all products for a specific service, filter by just the attribute name to see a specific attribute for multiple services, or use both a service code and an attribute name to retrieve only products that match both fields.

    Valid values include: ServiceCode, and all attribute names

    For example, you can filter by the AmazonEC2 service code and the volumeType attribute name to get the prices for only Amazon EC2 volumes.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The service code or attribute value that you want to filter by. If you are filtering by service code this is the actual service code, such as AmazonEC2. If you are filtering by attribute name, this is the attribute value that you want the returned products to match, such as a Provisioned IOPS volume.

    " + } + }, + "documentation":"

    The constraints that you want all returned products to match.

    " + }, + "FilterType":{ + "type":"string", + "enum":["TERM_MATCH"] + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetAttributeValuesRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "AttributeName" + ], + "members":{ + "ServiceCode":{ + "shape":"String", + "documentation":"

    The service code for the service whose attributes you want to retrieve. For example, if you want the retrieve an EC2 attribute, use AmazonEC2.

    " + }, + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the attribute that you want to retrieve the values for, such as volumeType.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token that indicates the next set of results that you want to retrieve.

    " + }, + "MaxResults":{ + "shape":"BoxedInteger", + "documentation":"

    The maximum number of results to return in response.

    ", + "box":true + } + } + }, + "GetAttributeValuesResponse":{ + "type":"structure", + "members":{ + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

    The list of values for an attribute. For example, Throughput Optimized HDD and Provisioned IOPS are two available values for the AmazonEC2 volumeType.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token that indicates the next set of results to retrieve.

    " + } + } + }, + "GetProductsRequest":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"String", + "documentation":"

    The code for the service whose products you want to retrieve.

    " + }, + "Filters":{ + "shape":"Filters", + "documentation":"

    The list of filters that limit the returned products. only products that match all filters are returned.

    " + }, + "FormatVersion":{ + "shape":"String", + "documentation":"

    The format version that you want the response to be in.

    Valid values are: aws_v1

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token that indicates the next set of results that you want to retrieve.

    " + }, + "MaxResults":{ + "shape":"BoxedInteger", + "documentation":"

    The maximum number of results to return in the response.

    ", + "box":true + } + } + }, + "GetProductsResponse":{ + "type":"structure", + "members":{ + "FormatVersion":{ + "shape":"String", + "documentation":"

    The format version of the response. For example, aws_v1.

    " + }, + "PriceList":{ + "shape":"PriceList", + "documentation":"

    The list of products that match your filters. The list contains both the product metadata and the price information.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    The pagination token that indicates the next set of results to retrieve.

    " + } + } + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

    An error on the server occurred during the processing of your request. Try again later.

    ", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

    The pagination token is invalid. Try again without a pagination token.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

    One or more parameters had an invalid value.

    ", + "exception":true + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"errorMessage"} + }, + "documentation":"

    The requested resource can't be found.

    ", + "exception":true + }, + "PriceList":{ + "type":"list", + "member":{ + "shape":"PriceListItemJSON", + "jsonvalue":true + } + }, + "PriceListItemJSON":{"type":"string"}, + "Service":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"String", + "documentation":"

    The code for the AWS service.

    " + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

    The attributes that are available for this service.

    " + } + }, + "documentation":"

    The metadata for a service, such as the service code and available attribute names.

    " + }, + "ServiceList":{ + "type":"list", + "member":{"shape":"Service"} + }, + "String":{"type":"string"}, + "errorMessage":{"type":"string"} + }, + "documentation":"

    AWS Price List Service API (AWS Price List Service) is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The AWS Price List Service uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the AWS Price List Service to build cost control and scenario planning tools, reconcile billing data, forecast future spend for budgeting purposes, and provide cost benefit analysis that compare your internal workloads with AWS.

    Use GetServices without a service code to retrieve the service codes for all AWS services, then GetServices with a service code to retreive the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.

    Service Endpoint

    AWS Price List Service API provides the following two endpoints:

    • https://api.pricing.us-east-1.amazonaws.com

    • https://api.pricing.ap-south-1.amazonaws.com

    " +} diff --git a/aws/dist/botocore/data/qldb-session/2019-07-11/paginators-1.json b/aws/dist/botocore/data/qldb-session/2019-07-11/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/qldb-session/2019-07-11/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/qldb-session/2019-07-11/service-2.json b/aws/dist/botocore/data/qldb-session/2019-07-11/service-2.json new file mode 100644 index 00000000..4cbf48b6 --- /dev/null +++ b/aws/dist/botocore/data/qldb-session/2019-07-11/service-2.json @@ -0,0 +1,381 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-07-11", + "endpointPrefix":"session.qldb", + "jsonVersion":"1.0", + "protocol":"json", + "serviceAbbreviation":"QLDB Session", + "serviceFullName":"Amazon QLDB Session", + "serviceId":"QLDB Session", + "signatureVersion":"v4", + "signingName":"qldb", + "targetPrefix":"QLDBSession", + "uid":"qldb-session-2019-07-11" + }, + "operations":{ + "SendCommand":{ + "name":"SendCommand", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendCommandRequest"}, + "output":{"shape":"SendCommandResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InvalidSessionException"}, + {"shape":"OccConflictException"}, + {"shape":"RateExceededException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Sends a command to an Amazon QLDB ledger.

    " + } + }, + "shapes":{ + "AbortTransactionRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Contains the details of the transaction to abort.

    " + }, + "AbortTransactionResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Contains the details of the aborted transaction.

    " + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"} + }, + "documentation":"

    Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.

    ", + "exception":true + }, + "CommitDigest":{"type":"blob"}, + "CommitTransactionRequest":{ + "type":"structure", + "required":[ + "TransactionId", + "CommitDigest" + ], + "members":{ + "TransactionId":{ + "shape":"TransactionId", + "documentation":"

    Specifies the transaction id of the transaction to commit.

    " + }, + "CommitDigest":{ + "shape":"CommitDigest", + "documentation":"

    Specifies the commit digest for the transaction to commit. For every active transaction, the commit digest must be passed. QLDB validates CommitDigest and rejects the commit with an error if the digest computed on the client does not match the digest computed by QLDB.

    " + } + }, + "documentation":"

    Contains the details of the transaction to commit.

    " + }, + "CommitTransactionResult":{ + "type":"structure", + "members":{ + "TransactionId":{ + "shape":"TransactionId", + "documentation":"

    The transaction id of the committed transaction.

    " + }, + "CommitDigest":{ + "shape":"CommitDigest", + "documentation":"

    The commit digest of the committed transaction.

    " + } + }, + "documentation":"

    Contains the details of the committed transaction.

    " + }, + "EndSessionRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Specifies a request to end the session.

    " + }, + "EndSessionResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Contains the details of the ended session.

    " + }, + "ErrorCode":{"type":"string"}, + "ErrorMessage":{"type":"string"}, + "ExecuteStatementRequest":{ + "type":"structure", + "required":[ + "TransactionId", + "Statement" + ], + "members":{ + "TransactionId":{ + "shape":"TransactionId", + "documentation":"

    Specifies the transaction id of the request.

    " + }, + "Statement":{ + "shape":"Statement", + "documentation":"

    Specifies the statement of the request.

    " + }, + "Parameters":{ + "shape":"StatementParameters", + "documentation":"

    Specifies the parameters for the parameterized statement in the request.

    " + } + }, + "documentation":"

    Specifies a request to execute a statement.

    " + }, + "ExecuteStatementResult":{ + "type":"structure", + "members":{ + "FirstPage":{ + "shape":"Page", + "documentation":"

    Contains the details of the first fetched page.

    " + } + }, + "documentation":"

    Contains the details of the executed statement.

    " + }, + "FetchPageRequest":{ + "type":"structure", + "required":[ + "TransactionId", + "NextPageToken" + ], + "members":{ + "TransactionId":{ + "shape":"TransactionId", + "documentation":"

    Specifies the transaction id of the page to be fetched.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    Specifies the next page token of the page to be fetched.

    " + } + }, + "documentation":"

    Specifies the details of the page to be fetched.

    " + }, + "FetchPageResult":{ + "type":"structure", + "members":{ + "Page":{ + "shape":"Page", + "documentation":"

    Contains details of the fetched page.

    " + } + }, + "documentation":"

    Contains the page that was fetched.

    " + }, + "InvalidSessionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Code":{"shape":"ErrorCode"} + }, + "documentation":"

    Returned if the session doesn't exist anymore because it timed-out or expired.

    ", + "exception":true + }, + "IonBinary":{ + "type":"blob", + "max":131072, + "min":1 + }, + "IonText":{ + "type":"string", + "max":1048576, + "min":1 + }, + "LedgerName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Returned if a resource limit such as number of active sessions is exceeded.

    ", + "exception":true + }, + "OccConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Returned when a transaction cannot be written to the journal due to a failure in the verification phase of Optimistic Concurrency Control.

    ", + "exception":true + }, + "Page":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"ValueHolders", + "documentation":"

    A structure that contains values in multiple encoding formats.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The token of the next page.

    " + } + }, + "documentation":"

    Contains details of the fetched page.

    " + }, + "PageToken":{ + "type":"string", + "max":1024, + "min":4, + "pattern":"^[A-Za-z-0-9+/=]+$" + }, + "RateExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Returned when the rate of requests exceeds the allowed throughput.

    ", + "exception":true + }, + "SendCommandRequest":{ + "type":"structure", + "members":{ + "SessionToken":{ + "shape":"SessionToken", + "documentation":"

    Specifies the session token for the current command. A session token is constant throughout the life of the session.

    To obtain a session token, run the StartSession command. This SessionToken is required for every subsequent command that is issued during the current session.

    " + }, + "StartSession":{ + "shape":"StartSessionRequest", + "documentation":"

    Command to start a new session. A session token is obtained as part of the response.

    " + }, + "StartTransaction":{ + "shape":"StartTransactionRequest", + "documentation":"

    Command to start a new transaction.

    " + }, + "EndSession":{ + "shape":"EndSessionRequest", + "documentation":"

    Command to end the current session.

    " + }, + "CommitTransaction":{ + "shape":"CommitTransactionRequest", + "documentation":"

    Command to commit the specified transaction.

    " + }, + "AbortTransaction":{ + "shape":"AbortTransactionRequest", + "documentation":"

    Command to abort the current transaction.

    " + }, + "ExecuteStatement":{ + "shape":"ExecuteStatementRequest", + "documentation":"

    Command to execute a statement in the specified transaction.

    " + }, + "FetchPage":{ + "shape":"FetchPageRequest", + "documentation":"

    Command to fetch a page.

    " + } + } + }, + "SendCommandResult":{ + "type":"structure", + "members":{ + "StartSession":{ + "shape":"StartSessionResult", + "documentation":"

    Contains the details of the started session that includes a session token. This SessionToken is required for every subsequent command that is issued during the current session.

    " + }, + "StartTransaction":{ + "shape":"StartTransactionResult", + "documentation":"

    Contains the details of the started transaction.

    " + }, + "EndSession":{ + "shape":"EndSessionResult", + "documentation":"

    Contains the details of the ended session.

    " + }, + "CommitTransaction":{ + "shape":"CommitTransactionResult", + "documentation":"

    Contains the details of the committed transaction.

    " + }, + "AbortTransaction":{ + "shape":"AbortTransactionResult", + "documentation":"

    Contains the details of the aborted transaction.

    " + }, + "ExecuteStatement":{ + "shape":"ExecuteStatementResult", + "documentation":"

    Contains the details of the executed statement.

    " + }, + "FetchPage":{ + "shape":"FetchPageResult", + "documentation":"

    Contains the details of the fetched page.

    " + } + } + }, + "SessionToken":{ + "type":"string", + "max":1024, + "min":4, + "pattern":"^[A-Za-z-0-9+/=]+$" + }, + "StartSessionRequest":{ + "type":"structure", + "required":["LedgerName"], + "members":{ + "LedgerName":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger to start a new session against.

    " + } + }, + "documentation":"

    Specifies a request to start a a new session.

    " + }, + "StartSessionResult":{ + "type":"structure", + "members":{ + "SessionToken":{ + "shape":"SessionToken", + "documentation":"

    Session token of the started session. This SessionToken is required for every subsequent command that is issued during the current session.

    " + } + }, + "documentation":"

    Contains the details of the started session.

    " + }, + "StartTransactionRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Specifies a request to start a transaction.

    " + }, + "StartTransactionResult":{ + "type":"structure", + "members":{ + "TransactionId":{ + "shape":"TransactionId", + "documentation":"

    The transaction id of the started transaction.

    " + } + }, + "documentation":"

    Contains the details of the started transaction.

    " + }, + "Statement":{ + "type":"string", + "max":100000, + "min":1 + }, + "StatementParameters":{ + "type":"list", + "member":{"shape":"ValueHolder"} + }, + "TransactionId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[A-Za-z-0-9]+$" + }, + "ValueHolder":{ + "type":"structure", + "members":{ + "IonBinary":{ + "shape":"IonBinary", + "documentation":"

    An Amazon Ion binary value contained in a ValueHolder structure.

    " + }, + "IonText":{ + "shape":"IonText", + "documentation":"

    An Amazon Ion plaintext value contained in a ValueHolder structure.

    " + } + }, + "documentation":"

    A structure that can contains values in multiple encoding formats.

    " + }, + "ValueHolders":{ + "type":"list", + "member":{"shape":"ValueHolder"} + } + }, + "documentation":"

    The transactional data APIs for Amazon QLDB

    " +} diff --git a/aws/dist/botocore/data/qldb/2019-01-02/paginators-1.json b/aws/dist/botocore/data/qldb/2019-01-02/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/qldb/2019-01-02/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/qldb/2019-01-02/service-2.json b/aws/dist/botocore/data/qldb/2019-01-02/service-2.json new file mode 100644 index 00000000..ab53e53a --- /dev/null +++ b/aws/dist/botocore/data/qldb/2019-01-02/service-2.json @@ -0,0 +1,1036 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-01-02", + "endpointPrefix":"qldb", + "jsonVersion":"1.0", + "protocol":"rest-json", + "serviceAbbreviation":"QLDB", + "serviceFullName":"Amazon QLDB", + "serviceId":"QLDB", + "signatureVersion":"v4", + "signingName":"qldb", + "uid":"qldb-2019-01-02" + }, + "operations":{ + "CreateLedger":{ + "name":"CreateLedger", + "http":{ + "method":"POST", + "requestUri":"/ledgers" + }, + "input":{"shape":"CreateLedgerRequest"}, + "output":{"shape":"CreateLedgerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

    Creates a new ledger in your AWS account.

    " + }, + "DeleteLedger":{ + "name":"DeleteLedger", + "http":{ + "method":"DELETE", + "requestUri":"/ledgers/{name}" + }, + "input":{"shape":"DeleteLedgerRequest"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourcePreconditionNotMetException"} + ], + "documentation":"

    Deletes a ledger and all of its contents. This action is irreversible.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + }, + "DescribeJournalS3Export":{ + "name":"DescribeJournalS3Export", + "http":{ + "method":"GET", + "requestUri":"/ledgers/{name}/journal-s3-exports/{exportId}" + }, + "input":{"shape":"DescribeJournalS3ExportRequest"}, + "output":{"shape":"DescribeJournalS3ExportResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

    If the export job with the given ExportId doesn't exist, then throws ResourceNotFoundException.

    If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

    " + }, + "DescribeLedger":{ + "name":"DescribeLedger", + "http":{ + "method":"GET", + "requestUri":"/ledgers/{name}" + }, + "input":{"shape":"DescribeLedgerRequest"}, + "output":{"shape":"DescribeLedgerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns information about a ledger, including its state and when it was created.

    " + }, + "ExportJournalToS3":{ + "name":"ExportJournalToS3", + "http":{ + "method":"POST", + "requestUri":"/ledgers/{name}/journal-s3-exports" + }, + "input":{"shape":"ExportJournalToS3Request"}, + "output":{"shape":"ExportJournalToS3Response"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourcePreconditionNotMetException"} + ], + "documentation":"

    Exports journal contents within a date and time range from a ledger into a specified Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.

    If the ledger with the given Name doesn't exist, then throws ResourceNotFoundException.

    If the ledger with the given Name is in CREATING status, then throws ResourcePreconditionNotMetException.

    You can initiate up to two concurrent journal export requests for each ledger. Beyond this limit, journal export requests throw LimitExceededException.

    " + }, + "GetBlock":{ + "name":"GetBlock", + "http":{ + "method":"POST", + "requestUri":"/ledgers/{name}/block" + }, + "input":{"shape":"GetBlockRequest"}, + "output":{"shape":"GetBlockResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourcePreconditionNotMetException"} + ], + "documentation":"

    Returns a journal block object at a specified address in a ledger. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

    If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

    If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

    If no block exists with the specified address, then throws InvalidParameterException.

    " + }, + "GetDigest":{ + "name":"GetDigest", + "http":{ + "method":"POST", + "requestUri":"/ledgers/{name}/digest" + }, + "input":{"shape":"GetDigestRequest"}, + "output":{"shape":"GetDigestResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourcePreconditionNotMetException"} + ], + "documentation":"

    Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

    " + }, + "GetRevision":{ + "name":"GetRevision", + "http":{ + "method":"POST", + "requestUri":"/ledgers/{name}/revision" + }, + "input":{"shape":"GetRevisionRequest"}, + "output":{"shape":"GetRevisionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourcePreconditionNotMetException"} + ], + "documentation":"

    Returns a revision data object for a specified document ID and block address. Also returns a proof of the specified revision for verification if DigestTipAddress is provided.

    " + }, + "ListJournalS3Exports":{ + "name":"ListJournalS3Exports", + "http":{ + "method":"GET", + "requestUri":"/journal-s3-exports" + }, + "input":{"shape":"ListJournalS3ExportsRequest"}, + "output":{"shape":"ListJournalS3ExportsResponse"}, + "documentation":"

    Returns an array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

    This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3Exports multiple times.

    " + }, + "ListJournalS3ExportsForLedger":{ + "name":"ListJournalS3ExportsForLedger", + "http":{ + "method":"GET", + "requestUri":"/ledgers/{name}/journal-s3-exports" + }, + "input":{"shape":"ListJournalS3ExportsForLedgerRequest"}, + "output":{"shape":"ListJournalS3ExportsForLedgerResponse"}, + "documentation":"

    Returns an array of journal export job descriptions for a specified ledger.

    This action returns a maximum of MaxResults items, and is paginated so that you can retrieve all the items by calling ListJournalS3ExportsForLedger multiple times.

    " + }, + "ListLedgers":{ + "name":"ListLedgers", + "http":{ + "method":"GET", + "requestUri":"/ledgers" + }, + "input":{"shape":"ListLedgersRequest"}, + "output":{"shape":"ListLedgersResponse"}, + "documentation":"

    Returns an array of ledger summaries that are associated with the current AWS account and Region.

    This action returns a maximum of 100 items and is paginated so that you can retrieve all the items by calling ListLedgers multiple times.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns all tags for a specified Amazon QLDB resource.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Adds one or more tags to a specified Amazon QLDB resource.

    A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, your request fails and returns an error.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Removes one or more tags from a specified Amazon QLDB resource. You can specify up to 50 tag keys to remove.

    " + }, + "UpdateLedger":{ + "name":"UpdateLedger", + "http":{ + "method":"PATCH", + "requestUri":"/ledgers/{name}" + }, + "input":{"shape":"UpdateLedgerRequest"}, + "output":{"shape":"UpdateLedgerResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Updates properties on a ledger.

    " + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":1600, + "min":20 + }, + "CreateLedgerRequest":{ + "type":"structure", + "required":[ + "Name", + "PermissionsMode" + ], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger that you want to create. The name must be unique among all of your ledgers in the current AWS Region.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The key-value pairs to add as tags to the ledger that you want to create. Tag keys are case sensitive. Tag values are case sensitive and can be null.

    " + }, + "PermissionsMode":{ + "shape":"PermissionsMode", + "documentation":"

    The permissions mode to assign to the ledger that you want to create.

    " + }, + "DeletionProtection":{ + "shape":"DeletionProtection", + "documentation":"

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + } + } + }, + "CreateLedgerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the ledger.

    " + }, + "State":{ + "shape":"LedgerState", + "documentation":"

    The current status of the ledger.

    " + }, + "CreationDateTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + }, + "DeletionProtection":{ + "shape":"DeletionProtection", + "documentation":"

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + } + } + }, + "DeleteLedgerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger that you want to delete.

    ", + "location":"uri", + "locationName":"name" + } + } + }, + "DeletionProtection":{"type":"boolean"}, + "DescribeJournalS3ExportRequest":{ + "type":"structure", + "required":[ + "Name", + "ExportId" + ], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "ExportId":{ + "shape":"UniqueId", + "documentation":"

    The unique ID of the journal export job that you want to describe.

    ", + "location":"uri", + "locationName":"exportId" + } + } + }, + "DescribeJournalS3ExportResponse":{ + "type":"structure", + "required":["ExportDescription"], + "members":{ + "ExportDescription":{ + "shape":"JournalS3ExportDescription", + "documentation":"

    Information about the journal export job returned by a DescribeJournalS3Export request.

    " + } + } + }, + "DescribeLedgerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger that you want to describe.

    ", + "location":"uri", + "locationName":"name" + } + } + }, + "DescribeLedgerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the ledger.

    " + }, + "State":{ + "shape":"LedgerState", + "documentation":"

    The current status of the ledger.

    " + }, + "CreationDateTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + }, + "DeletionProtection":{ + "shape":"DeletionProtection", + "documentation":"

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + } + } + }, + "Digest":{ + "type":"blob", + "max":32, + "min":32 + }, + "ErrorMessage":{"type":"string"}, + "ExportJournalToS3Request":{ + "type":"structure", + "required":[ + "Name", + "InclusiveStartTime", + "ExclusiveEndTime", + "S3ExportConfiguration", + "RoleArn" + ], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "InclusiveStartTime":{ + "shape":"Timestamp", + "documentation":"

    The inclusive start date and time for the range of journal contents that you want to export.

    The InclusiveStartTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

    The InclusiveStartTime must be before ExclusiveEndTime.

    If you provide an InclusiveStartTime that is before the ledger's CreationDateTime, Amazon QLDB defaults it to the ledger's CreationDateTime.

    " + }, + "ExclusiveEndTime":{ + "shape":"Timestamp", + "documentation":"

    The exclusive end date and time for the range of journal contents that you want to export.

    The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z

    The ExclusiveEndTime must be less than or equal to the current UTC date and time.

    " + }, + "S3ExportConfiguration":{ + "shape":"S3ExportConfiguration", + "documentation":"

    The configuration settings of the Amazon S3 bucket destination for your export request.

    " + }, + "RoleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

    • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    • (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.

    " + } + } + }, + "ExportJournalToS3Response":{ + "type":"structure", + "required":["ExportId"], + "members":{ + "ExportId":{ + "shape":"UniqueId", + "documentation":"

    The unique ID that QLDB assigns to each journal export job.

    To describe your export request and check the status of the job, you can use ExportId to call DescribeJournalS3Export.

    " + } + } + }, + "ExportStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "COMPLETED", + "CANCELLED" + ] + }, + "GetBlockRequest":{ + "type":"structure", + "required":[ + "Name", + "BlockAddress" + ], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "BlockAddress":{ + "shape":"ValueHolder", + "documentation":"

    The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}

    " + }, + "DigestTipAddress":{ + "shape":"ValueHolder", + "documentation":"

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}

    " + } + } + }, + "GetBlockResponse":{ + "type":"structure", + "required":["Block"], + "members":{ + "Block":{ + "shape":"ValueHolder", + "documentation":"

    The block data object in Amazon Ion format.

    " + }, + "Proof":{ + "shape":"ValueHolder", + "documentation":"

    The proof object in Amazon Ion format returned by a GetBlock request. A proof contains the list of hash values required to recalculate the specified digest using a Merkle tree, starting with the specified block.

    " + } + } + }, + "GetDigestRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + } + } + }, + "GetDigestResponse":{ + "type":"structure", + "required":[ + "Digest", + "DigestTipAddress" + ], + "members":{ + "Digest":{ + "shape":"Digest", + "documentation":"

    The 256-bit hash value representing the digest returned by a GetDigest request.

    " + }, + "DigestTipAddress":{ + "shape":"ValueHolder", + "documentation":"

    The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    " + } + } + }, + "GetRevisionRequest":{ + "type":"structure", + "required":[ + "Name", + "BlockAddress", + "DocumentId" + ], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "BlockAddress":{ + "shape":"ValueHolder", + "documentation":"

    The block location of the document revision to be verified. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:14}

    " + }, + "DocumentId":{ + "shape":"UniqueId", + "documentation":"

    The unique ID of the document to be verified.

    " + }, + "DigestTipAddress":{ + "shape":"ValueHolder", + "documentation":"

    The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

    For example: {strandId:\"BlFTjlSXze9BIh1KOszcE3\",sequenceNo:49}

    " + } + } + }, + "GetRevisionResponse":{ + "type":"structure", + "required":["Revision"], + "members":{ + "Proof":{ + "shape":"ValueHolder", + "documentation":"

    The proof object in Amazon Ion format returned by a GetRevision request. A proof contains the list of hash values that are required to recalculate the specified digest using a Merkle tree, starting with the specified document revision.

    " + }, + "Revision":{ + "shape":"ValueHolder", + "documentation":"

    The document revision data object in Amazon Ion format.

    " + } + } + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ParameterName":{ + "shape":"ParameterName", + "documentation":"

    The name of the invalid parameter.

    " + } + }, + "documentation":"

    One or more parameters in the request aren't valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "IonText":{ + "type":"string", + "max":1048576, + "min":1, + "sensitive":true + }, + "JournalS3ExportDescription":{ + "type":"structure", + "required":[ + "LedgerName", + "ExportId", + "ExportCreationTime", + "Status", + "InclusiveStartTime", + "ExclusiveEndTime", + "S3ExportConfiguration", + "RoleArn" + ], + "members":{ + "LedgerName":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    " + }, + "ExportId":{ + "shape":"UniqueId", + "documentation":"

    The unique ID of the journal export job.

    " + }, + "ExportCreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time, in epoch time format, when the export job was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + }, + "Status":{ + "shape":"ExportStatus", + "documentation":"

    The current state of the journal export job.

    " + }, + "InclusiveStartTime":{ + "shape":"Timestamp", + "documentation":"

    The inclusive start date and time for the range of journal contents that are specified in the original export request.

    " + }, + "ExclusiveEndTime":{ + "shape":"Timestamp", + "documentation":"

    The exclusive end date and time for the range of journal contents that are specified in the original export request.

    " + }, + "S3ExportConfiguration":{"shape":"S3ExportConfiguration"}, + "RoleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal export job to do the following:

    • Write objects into your Amazon Simple Storage Service (Amazon S3) bucket.

    • (Optional) Use your customer master key (CMK) in AWS Key Management Service (AWS KMS) for server-side encryption of your exported data.

    " + } + }, + "documentation":"

    The information about a journal export job, including the ledger name, export ID, when it was created, current status, and its start and end time export parameters.

    " + }, + "JournalS3ExportList":{ + "type":"list", + "member":{"shape":"JournalS3ExportDescription"} + }, + "LedgerList":{ + "type":"list", + "member":{"shape":"LedgerSummary"} + }, + "LedgerName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$" + }, + "LedgerState":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "DELETED" + ] + }, + "LedgerSummary":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    " + }, + "State":{ + "shape":"LedgerState", + "documentation":"

    The current status of the ledger.

    " + }, + "CreationDateTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + } + }, + "documentation":"

    Information about a ledger, including its name, state, and when it was created.

    " + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + } + }, + "documentation":"

    You have reached the limit on the maximum number of resources allowed.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListJournalS3ExportsForLedgerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single ListJournalS3ExportsForLedger request. (The actual number of results returned might be fewer.)

    ", + "location":"querystring", + "locationName":"max_results" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3ExportsForLedger call, then you should use that value as input here.

    ", + "location":"querystring", + "locationName":"next_token" + } + } + }, + "ListJournalS3ExportsForLedgerResponse":{ + "type":"structure", + "members":{ + "JournalS3Exports":{ + "shape":"JournalS3ExportList", + "documentation":"

    The array of journal export job descriptions that are associated with the specified ledger.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

    • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3ExportsForLedger call.

    " + } + } + }, + "ListJournalS3ExportsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single ListJournalS3Exports request. (The actual number of results returned might be fewer.)

    ", + "location":"querystring", + "locationName":"max_results" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListJournalS3Exports call, then you should use that value as input here.

    ", + "location":"querystring", + "locationName":"next_token" + } + } + }, + "ListJournalS3ExportsResponse":{ + "type":"structure", + "members":{ + "JournalS3Exports":{ + "shape":"JournalS3ExportList", + "documentation":"

    The array of journal export job descriptions for all ledgers that are associated with the current AWS account and Region.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

    • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListJournalS3Exports call.

    " + } + } + }, + "ListLedgersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single ListLedgers request. (The actual number of results returned might be fewer.)

    ", + "location":"querystring", + "locationName":"max_results" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A pagination token, indicating that you want to retrieve the next page of results. If you received a value for NextToken in the response from a previous ListLedgers call, then you should use that value as input here.

    ", + "location":"querystring", + "locationName":"next_token" + } + } + }, + "ListLedgersResponse":{ + "type":"structure", + "members":{ + "Ledgers":{ + "shape":"LedgerList", + "documentation":"

    The array of ledger summaries that are associated with the current AWS account and Region.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A pagination token, indicating whether there are more results available:

    • If NextToken is empty, then the last page of results has been processed and there are no more results to be retrieved.

    • If NextToken is not empty, then there are more results available. To retrieve the next page of results, use the value of NextToken in a subsequent ListLedgers call.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for which you want to list the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

    ", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags that are currently associated with the specified Amazon QLDB resource.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":4, + "pattern":"^[A-Za-z-0-9+/=]+$" + }, + "ParameterName":{"type":"string"}, + "PermissionsMode":{ + "type":"string", + "enum":["ALLOW_ALL"] + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + }, + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource.

    " + } + }, + "documentation":"

    The specified resource already exists.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + }, + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource.

    " + } + }, + "documentation":"

    The specified resource can't be modified at this time.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceName":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + }, + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource.

    " + } + }, + "documentation":"

    The specified resource doesn't exist.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourcePreconditionNotMetException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + }, + "ResourceName":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource.

    " + } + }, + "documentation":"

    The operation failed because a condition wasn't satisfied in advance.

    ", + "error":{"httpStatusCode":412}, + "exception":true + }, + "ResourceType":{"type":"string"}, + "S3Bucket":{ + "type":"string", + "max":255, + "min":3, + "pattern":"^[A-Za-z-0-9-_.]+$" + }, + "S3EncryptionConfiguration":{ + "type":"structure", + "required":["ObjectEncryptionType"], + "members":{ + "ObjectEncryptionType":{ + "shape":"S3ObjectEncryptionType", + "documentation":"

    The Amazon S3 object encryption type.

    To learn more about server-side encryption options in Amazon S3, see Protecting Data Using Server-Side Encryption in the Amazon S3 Developer Guide.

    " + }, + "KmsKeyArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for a customer master key (CMK) in AWS Key Management Service (AWS KMS).

    You must provide a KmsKeyArn if you specify SSE_KMS as the ObjectEncryptionType.

    KmsKeyArn is not required if you specify SSE_S3 as the ObjectEncryptionType.

    " + } + }, + "documentation":"

    The encryption settings that are used by a journal export job to write data in an Amazon Simple Storage Service (Amazon S3) bucket.

    " + }, + "S3ExportConfiguration":{ + "type":"structure", + "required":[ + "Bucket", + "Prefix", + "EncryptionConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The Amazon S3 bucket name in which a journal export job writes the journal contents.

    The bucket name must comply with the Amazon S3 bucket naming conventions. For more information, see Bucket Restrictions and Limitations in the Amazon S3 Developer Guide.

    " + }, + "Prefix":{ + "shape":"S3Prefix", + "documentation":"

    The prefix for the Amazon S3 bucket in which a journal export job writes the journal contents.

    The prefix must comply with Amazon S3 key naming rules and restrictions. For more information, see Object Key and Metadata in the Amazon S3 Developer Guide.

    The following are examples of valid Prefix values:

    • JournalExports-ForMyLedger/Testing/

    • JournalExports

    • My:Tests/

    " + }, + "EncryptionConfiguration":{ + "shape":"S3EncryptionConfiguration", + "documentation":"

    The encryption settings that are used by a journal export job to write data in an Amazon S3 bucket.

    " + } + }, + "documentation":"

    The Amazon Simple Storage Service (Amazon S3) bucket location in which a journal export job writes the journal contents.

    " + }, + "S3ObjectEncryptionType":{ + "type":"string", + "enum":[ + "SSE_KMS", + "SSE_S3", + "NO_ENCRYPTION" + ] + }, + "S3Prefix":{ + "type":"string", + "max":128, + "min":0 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) to which you want to add the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The key-value pairs to add as tags to the specified QLDB resource. Tag keys are case sensitive. If you specify a key that already exists for the resource, your request fails and returns an error. Tag values are case sensitive and can be null.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "UniqueId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[A-Za-z-0-9]+$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) from which you want to remove the tags. For example:

    arn:aws:qldb:us-east-1:123456789012:ledger/exampleLedger

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The list of tag keys that you want to remove.

    ", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateLedgerRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    ", + "location":"uri", + "locationName":"name" + }, + "DeletionProtection":{ + "shape":"DeletionProtection", + "documentation":"

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + } + } + }, + "UpdateLedgerResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"LedgerName", + "documentation":"

    The name of the ledger.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the ledger.

    " + }, + "State":{ + "shape":"LedgerState", + "documentation":"

    The current status of the ledger.

    " + }, + "CreationDateTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

    " + }, + "DeletionProtection":{ + "shape":"DeletionProtection", + "documentation":"

    The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (true) by default.

    If deletion protection is enabled, you must first disable it before you can delete the ledger using the QLDB API or the AWS Command Line Interface (AWS CLI). You can disable it by calling the UpdateLedger operation to set the flag to false. The QLDB console disables deletion protection for you when you use it to delete a ledger.

    " + } + } + }, + "ValueHolder":{ + "type":"structure", + "members":{ + "IonText":{ + "shape":"IonText", + "documentation":"

    An Amazon Ion plaintext value contained in a ValueHolder structure.

    " + } + }, + "documentation":"

    A structure that can contain an Amazon Ion value in multiple encoding formats.

    ", + "sensitive":true + } + }, + "documentation":"

    The control plane for Amazon QLDB

    " +} diff --git a/aws/dist/botocore/data/quicksight/2018-04-01/paginators-1.json b/aws/dist/botocore/data/quicksight/2018-04-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/quicksight/2018-04-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/quicksight/2018-04-01/service-2.json b/aws/dist/botocore/data/quicksight/2018-04-01/service-2.json new file mode 100644 index 00000000..686bf040 --- /dev/null +++ b/aws/dist/botocore/data/quicksight/2018-04-01/service-2.json @@ -0,0 +1,1563 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-04-01", + "endpointPrefix":"quicksight", + "jsonVersion":"1.0", + "protocol":"rest-json", + "serviceFullName":"Amazon QuickSight", + "serviceId":"QuickSight", + "signatureVersion":"v4", + "uid":"quicksight-2018-04-01" + }, + "operations":{ + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{"shape":"CreateGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Creates an Amazon QuickSight group.

    The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

    The response is a group object.

    CLI Sample:

    aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name=\"Sales-Management\" --description=\"Sales Management - Forecasting\"

    " + }, + "CreateGroupMembership":{ + "name":"CreateGroupMembership", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}" + }, + "input":{"shape":"CreateGroupMembershipRequest"}, + "output":{"shape":"CreateGroupMembershipResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Adds an Amazon QuickSight user to an Amazon QuickSight group.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

    The condition resource is the user name.

    The condition key is quicksight:UserName.

    The response is the group member object.

    CLI Sample:

    aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat

    " + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Removes a user group from Amazon QuickSight.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

    CLI Sample:

    aws quicksight delete-group -\\-aws-account-id=111122223333 -\\-namespace=default -\\-group-name=Sales-Management

    " + }, + "DeleteGroupMembership":{ + "name":"DeleteGroupMembership", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}" + }, + "input":{"shape":"DeleteGroupMembershipRequest"}, + "output":{"shape":"DeleteGroupMembershipResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Removes a user from a group so that the user is no longer a member of the group.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

    The condition resource is the user name.

    The condition key is quicksight:UserName.

    CLI Sample:

    aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie

    " + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    CLI Sample:

    aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

    " + }, + "DeleteUserByPrincipalId":{ + "name":"DeleteUserByPrincipalId", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}" + }, + "input":{"shape":"DeleteUserByPrincipalIdRequest"}, + "output":{"shape":"DeleteUserByPrincipalIdResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Deletes a user identified by its principal ID.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    CLI Sample:

    aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS

    " + }, + "DescribeGroup":{ + "name":"DescribeGroup", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input":{"shape":"DescribeGroupRequest"}, + "output":{"shape":"DescribeGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

    The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .

    The response is the group object.

    CLI Sample:

    aws quicksight describe-group -\\-aws-account-id=11112222333 -\\-namespace=default -\\-group-name=Sales

    " + }, + "DescribeUser":{ + "name":"DescribeUser", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input":{"shape":"DescribeUserRequest"}, + "output":{"shape":"DescribeUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Returns information about a user, given the user name.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

    CLI Sample:

    aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat

    " + }, + "GetDashboardEmbedUrl":{ + "name":"GetDashboardEmbedUrl", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url" + }, + "input":{"shape":"GetDashboardEmbedUrlRequest"}, + "output":{"shape":"GetDashboardEmbedUrlResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"DomainNotWhitelistedException"}, + {"shape":"QuickSightUserNotFoundException"}, + {"shape":"IdentityTypeNotSupportedException"}, + {"shape":"SessionLifetimeInMinutesInvalidException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.

    Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

    CLI Sample:

    Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.

    aws sts assume-role --role-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --role-session-name embeddingsession

    If the user does not exist in QuickSight, register the user:

    aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --user-role READER --session-name \"embeddingsession\" --email user123@example.com --region us-east-1

    Get the URL for the embedded dashboard

    aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM

    " + }, + "ListGroupMemberships":{ + "name":"ListGroupMemberships", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members" + }, + "input":{"shape":"ListGroupMembershipsRequest"}, + "output":{"shape":"ListGroupMembershipsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Lists member users in a group.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

    The response is a list of group member objects.

    CLI Sample:

    aws quicksight list-group-memberships -\\-aws-account-id=111122223333 -\\-namespace=default

    " + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{"shape":"ListGroupsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Lists all user groups in Amazon QuickSight.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.

    The response is a list of group objects.

    CLI Sample:

    aws quicksight list-groups -\\-aws-account-id=111122223333 -\\-namespace=default

    " + }, + "ListUserGroups":{ + "name":"ListUserGroups", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups" + }, + "input":{"shape":"ListUserGroupsRequest"}, + "output":{"shape":"ListUserGroupsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    The response is a one or more group objects.

    CLI Sample:

    aws quicksight list-user-groups -\\-user-name=Pat -\\-aws-account-id=111122223333 -\\-namespace=default -\\-region=us-east-1

    " + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Returns a list of all of the Amazon QuickSight users belonging to this account.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* .

    The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.

    CLI Sample:

    aws quicksight list-users --aws-account-id=111122223333 --namespace=default

    " + }, + "RegisterUser":{ + "name":"RegisterUser", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users" + }, + "input":{"shape":"RegisterUserRequest"}, + "output":{"shape":"RegisterUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceExistsException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

    The condition keys are quicksight:IamArn and quicksight:SessionName.

    CLI Sample:

    aws quicksight register-user -\\-aws-account-id=111122223333 -\\-namespace=default -\\-email=pat@example.com -\\-identity-type=IAM -\\-user-role=AUTHOR -\\-iam-arn=arn:aws:iam::111122223333:user/Pat

    " + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}" + }, + "input":{"shape":"UpdateGroupRequest"}, + "output":{"shape":"UpdateGroupResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"PreconditionNotMetException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Changes a group description.

    The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .

    The response is a group object.

    CLI Sample:

    aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description=\"Sales BI Dashboards\"

    " + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}" + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalFailureException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Updates an Amazon QuickSight user.

    The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

    The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).

    CLI Sample:

    aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1

    " + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request id for this request.

    " + } + }, + "documentation":"

    You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "Arn":{"type":"string"}, + "AwsAccountId":{ + "type":"string", + "max":12, + "min":12, + "pattern":"^[0-9]{12}$" + }, + "Boolean":{"type":"boolean"}, + "CreateGroupMembershipRequest":{ + "type":"structure", + "required":[ + "MemberName", + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "MemberName":{ + "shape":"GroupMemberName", + "documentation":"

    The name of the user that you want to add to the group membership.

    ", + "location":"uri", + "locationName":"MemberName" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to add the user to.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "CreateGroupMembershipResponse":{ + "type":"structure", + "members":{ + "GroupMember":{ + "shape":"GroupMember", + "documentation":"

    The group member.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "CreateGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    A name for the group that you want to create.

    " + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    A description for the group that you want to create.

    " + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + }, + "documentation":"

    The request object for this operation.

    " + }, + "CreateGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The name of the group.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + }, + "documentation":"

    The response object for this operation.

    " + }, + "DeleteGroupMembershipRequest":{ + "type":"structure", + "required":[ + "MemberName", + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "MemberName":{ + "shape":"GroupMemberName", + "documentation":"

    The name of the user that you want to delete from the group membership.

    ", + "location":"uri", + "locationName":"MemberName" + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to delete the user from.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "DeleteGroupMembershipResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to delete.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "DeleteGroupResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DeleteUserByPrincipalIdRequest":{ + "type":"structure", + "required":[ + "PrincipalId", + "AwsAccountId", + "Namespace" + ], + "members":{ + "PrincipalId":{ + "shape":"String", + "documentation":"

    The principal ID of the user.

    ", + "location":"uri", + "locationName":"PrincipalId" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + }, + "documentation":"

    " + }, + "DeleteUserByPrincipalIdResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the user that you want to delete.

    ", + "location":"uri", + "locationName":"UserName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "DeleteUserResponse":{ + "type":"structure", + "members":{ + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DescribeGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to describe.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "DescribeGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The name of the group.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DescribeUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the user that you want to describe.

    ", + "location":"uri", + "locationName":"UserName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "DescribeUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The user name.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "DomainNotWhitelistedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "EmbeddingUrl":{ + "type":"string", + "sensitive":true + }, + "ExceptionResourceType":{ + "type":"string", + "enum":[ + "USER", + "GROUP", + "NAMESPACE", + "DATA_SOURCE", + "DATA_SET", + "VPC_CONNECTION", + "INGESTION" + ] + }, + "GetDashboardEmbedUrlRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "DashboardId", + "IdentityType" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    AWS account ID that contains the dashboard you are embedding.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "DashboardId":{ + "shape":"String", + "documentation":"

    The ID for the dashboard, also added to IAM policy

    ", + "location":"uri", + "locationName":"DashboardId" + }, + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

    The authentication method the user uses to sign in (IAM only).

    ", + "location":"querystring", + "locationName":"creds-type" + }, + "SessionLifetimeInMinutes":{ + "shape":"SessionLifetimeInMinutes", + "documentation":"

    How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.

    ", + "location":"querystring", + "locationName":"session-lifetime" + }, + "UndoRedoDisabled":{ + "shape":"boolean", + "documentation":"

    Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.

    ", + "location":"querystring", + "locationName":"undo-redo-disabled" + }, + "ResetDisabled":{ + "shape":"boolean", + "documentation":"

    Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.

    ", + "location":"querystring", + "locationName":"reset-disabled" + }, + "UserArn":{ + "shape":"Arn", + "documentation":"

    The Amazon QuickSight user's ARN, for use with QUICKSIGHT identity type. You can use this for any of the following:

    • Amazon QuickSight users in your account (readers, authors, or admins)

    • AD users

    • Invited non-federated users

    • Federated IAM users

    • Federated IAM role-based sessions

    ", + "location":"querystring", + "locationName":"user-arn" + } + } + }, + "GetDashboardEmbedUrlResponse":{ + "type":"structure", + "members":{ + "EmbedUrl":{ + "shape":"EmbeddingUrl", + "documentation":"

    URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + } + } + }, + "Group":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the group.

    " + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group.

    " + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    The group description.

    " + }, + "PrincipalId":{ + "shape":"String", + "documentation":"

    The principal ID of the group.

    " + } + }, + "documentation":"

    A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.

    " + }, + "GroupDescription":{ + "type":"string", + "max":512, + "min":1 + }, + "GroupList":{ + "type":"list", + "member":{"shape":"Group"} + }, + "GroupMember":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the group member (user).

    " + }, + "MemberName":{ + "shape":"GroupMemberName", + "documentation":"

    The name of the group member (user).

    " + } + }, + "documentation":"

    A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group.

    " + }, + "GroupMemberList":{ + "type":"list", + "member":{"shape":"GroupMember"} + }, + "GroupMemberName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "GroupName":{ + "type":"string", + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "IdentityType":{ + "type":"string", + "enum":[ + "IAM", + "QUICKSIGHT" + ] + }, + "IdentityTypeNotSupportedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    An internal failure occurred.

    ", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The NextToken value isn't valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    One or more parameters don't have a valid value.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"ExceptionResourceType", + "documentation":"

    Limit exceeded.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    A limit is exceeded.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ListGroupMembershipsRequest":{ + "type":"structure", + "required":[ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to see a membership list of.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    ", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return from this request.

    ", + "box":true, + "location":"querystring", + "locationName":"max-results" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "ListGroupMembershipsResponse":{ + "type":"structure", + "members":{ + "GroupMemberList":{ + "shape":"GroupMemberList", + "documentation":"

    The list of the members of the group.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "ListGroupsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "Namespace" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    ", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return.

    ", + "box":true, + "location":"querystring", + "locationName":"max-results" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "members":{ + "GroupList":{ + "shape":"GroupList", + "documentation":"

    The list of the groups.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "ListUserGroupsRequest":{ + "type":"structure", + "required":[ + "UserName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "UserName":{ + "shape":"UserName", + "documentation":"

    The Amazon QuickSight user name that you want to list group memberships for.

    ", + "location":"uri", + "locationName":"UserName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    ", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return from this request.

    ", + "box":true, + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListUserGroupsResponse":{ + "type":"structure", + "members":{ + "GroupList":{ + "shape":"GroupList", + "documentation":"

    The list of groups the user is a member of.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The HTTP status of the request.

    ", + "location":"statusCode" + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "Namespace" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    ", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return from this request.

    ", + "box":true, + "location":"querystring", + "locationName":"max-results" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "UserList":{ + "shape":"UserList", + "documentation":"

    The list of users.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Namespace":{ + "type":"string", + "pattern":"default" + }, + "PreconditionNotMetException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    One or more preconditions aren't met.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QuickSightUserNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RegisterUserRequest":{ + "type":"structure", + "required":[ + "IdentityType", + "Email", + "UserRole", + "AwsAccountId", + "Namespace" + ], + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

    Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

    • IAM: A user whose identity maps to an existing IAM user or role.

    • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

    " + }, + "Email":{ + "shape":"String", + "documentation":"

    The email address of the user that you want to register.

    " + }, + "UserRole":{ + "shape":"UserRole", + "documentation":"

    The Amazon QuickSight role of the user. The user role can be one of the following:

    • READER: A user who has read-only access to dashboards.

    • AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.

    • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

    " + }, + "IamArn":{ + "shape":"String", + "documentation":"

    The ARN of the IAM user or role that you are registering with Amazon QuickSight.

    " + }, + "SessionName":{ + "shape":"RoleSessionName", + "documentation":"

    You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

    " + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The Amazon QuickSight user name that you want to create for the user you are registering.

    " + } + } + }, + "RegisterUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The user name.

    " + }, + "UserInvitationUrl":{ + "shape":"String", + "documentation":"

    The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "ResourceExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"ExceptionResourceType", + "documentation":"

    The AWS request ID for this request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The resource specified doesn't exist.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"ExceptionResourceType", + "documentation":"

    The AWS request ID for this request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    One or more resources can't be found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"ExceptionResourceType", + "documentation":"

    The resource type for this request.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    This resource is currently unavailable.

    ", + "error":{"httpStatusCode":503}, + "exception":true + }, + "RoleSessionName":{ + "type":"string", + "max":64, + "min":2, + "pattern":"[\\w+=.@-]*" + }, + "SessionLifetimeInMinutes":{ + "type":"long", + "max":600, + "min":15 + }, + "SessionLifetimeInMinutesInvalidException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "StatusCode":{"type":"integer"}, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    Access is throttled.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnsupportedUserEditionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this request.

    " + } + }, + "documentation":"

    This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "UpdateGroupRequest":{ + "type":"structure", + "required":[ + "GroupName", + "AwsAccountId", + "Namespace" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the group that you want to update.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    The description for the group that you want to update.

    " + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + } + } + }, + "UpdateGroupResponse":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The name of the group.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "UserName", + "AwsAccountId", + "Namespace", + "Email", + "Role" + ], + "members":{ + "UserName":{ + "shape":"UserName", + "documentation":"

    The Amazon QuickSight user name that you want to update.

    ", + "location":"uri", + "locationName":"UserName" + }, + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

    The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

    ", + "location":"uri", + "locationName":"AwsAccountId" + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace. Currently, you should set this to default.

    ", + "location":"uri", + "locationName":"Namespace" + }, + "Email":{ + "shape":"String", + "documentation":"

    The email address of the user that you want to update.

    " + }, + "Role":{ + "shape":"UserRole", + "documentation":"

    The Amazon QuickSight role of the user. The user role can be one of the following:

    • READER: A user who has read-only access to dashboards.

    • AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.

    • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

    " + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The Amazon QuickSight user.

    " + }, + "RequestId":{ + "shape":"String", + "documentation":"

    The AWS request ID for this operation.

    " + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

    The http status of the request.

    ", + "location":"statusCode" + } + } + }, + "User":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the user.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The user's user name.

    " + }, + "Email":{ + "shape":"String", + "documentation":"

    The user's email address.

    " + }, + "Role":{ + "shape":"UserRole", + "documentation":"

    The Amazon QuickSight role for the user.

    " + }, + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

    The type of identity authentication used by the user.

    " + }, + "Active":{ + "shape":"Boolean", + "documentation":"

    Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password

    " + }, + "PrincipalId":{ + "shape":"String", + "documentation":"

    The principal ID of the user.

    " + } + }, + "documentation":"

    A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.

    " + }, + "UserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "UserName":{ + "type":"string", + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "UserRole":{ + "type":"string", + "enum":[ + "ADMIN", + "AUTHOR", + "READER", + "RESTRICTED_AUTHOR", + "RESTRICTED_READER" + ] + }, + "boolean":{"type":"boolean"} + }, + "documentation":"Amazon QuickSight API Reference

    Amazon QuickSight is a fully managed, serverless, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

    " +} diff --git a/aws/dist/botocore/data/ram/2018-01-04/paginators-1.json b/aws/dist/botocore/data/ram/2018-01-04/paginators-1.json new file mode 100644 index 00000000..ec438a09 --- /dev/null +++ b/aws/dist/botocore/data/ram/2018-01-04/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "GetResourcePolicies": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "policies" + }, + "GetResourceShareAssociations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resourceShareAssociations" + }, + "GetResourceShareInvitations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resourceShareInvitations" + }, + "GetResourceShares": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resourceShares" + }, + "ListPrincipals": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "principals" + }, + "ListResources": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "resources" + } + } +} diff --git a/aws/dist/botocore/data/ram/2018-01-04/service-2.json b/aws/dist/botocore/data/ram/2018-01-04/service-2.json new file mode 100644 index 00000000..e227e50d --- /dev/null +++ b/aws/dist/botocore/data/ram/2018-01-04/service-2.json @@ -0,0 +1,1475 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-01-04", + "endpointPrefix":"ram", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"RAM", + "serviceFullName":"AWS Resource Access Manager", + "serviceId":"RAM", + "signatureVersion":"v4", + "uid":"ram-2018-01-04" + }, + "operations":{ + "AcceptResourceShareInvitation":{ + "name":"AcceptResourceShareInvitation", + "http":{ + "method":"POST", + "requestUri":"/acceptresourceshareinvitation" + }, + "input":{"shape":"AcceptResourceShareInvitationRequest"}, + "output":{"shape":"AcceptResourceShareInvitationResponse"}, + "errors":[ + {"shape":"MalformedArnException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceShareInvitationArnNotFoundException"}, + {"shape":"ResourceShareInvitationAlreadyAcceptedException"}, + {"shape":"ResourceShareInvitationAlreadyRejectedException"}, + {"shape":"ResourceShareInvitationExpiredException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Accepts an invitation to a resource share from another AWS account.

    " + }, + "AssociateResourceShare":{ + "name":"AssociateResourceShare", + "http":{ + "method":"POST", + "requestUri":"/associateresourceshare" + }, + "input":{"shape":"AssociateResourceShareRequest"}, + "output":{"shape":"AssociateResourceShareResponse"}, + "errors":[ + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"ResourceShareLimitExceededException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnknownResourceException"} + ], + "documentation":"

    Associates the specified resource share with the specified principals and resources.

    " + }, + "CreateResourceShare":{ + "name":"CreateResourceShare", + "http":{ + "method":"POST", + "requestUri":"/createresourceshare" + }, + "input":{"shape":"CreateResourceShareRequest"}, + "output":{"shape":"CreateResourceShareResponse"}, + "errors":[ + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceShareLimitExceededException"}, + {"shape":"TagPolicyViolationException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Creates a resource share.

    " + }, + "DeleteResourceShare":{ + "name":"DeleteResourceShare", + "http":{ + "method":"DELETE", + "requestUri":"/deleteresourceshare" + }, + "input":{"shape":"DeleteResourceShareRequest"}, + "output":{"shape":"DeleteResourceShareResponse"}, + "errors":[ + {"shape":"OperationNotPermittedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deletes the specified resource share.

    " + }, + "DisassociateResourceShare":{ + "name":"DisassociateResourceShare", + "http":{ + "method":"POST", + "requestUri":"/disassociateresourceshare" + }, + "input":{"shape":"DisassociateResourceShareRequest"}, + "output":{"shape":"DisassociateResourceShareResponse"}, + "errors":[ + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ResourceShareLimitExceededException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidStateTransitionException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"UnknownResourceException"} + ], + "documentation":"

    Disassociates the specified principals or resources from the specified resource share.

    " + }, + "EnableSharingWithAwsOrganization":{ + "name":"EnableSharingWithAwsOrganization", + "http":{ + "method":"POST", + "requestUri":"/enablesharingwithawsorganization" + }, + "input":{"shape":"EnableSharingWithAwsOrganizationRequest"}, + "output":{"shape":"EnableSharingWithAwsOrganizationResponse"}, + "errors":[ + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Enables resource sharing within your AWS Organization.

    The caller must be the master account for the AWS Organization.

    " + }, + "GetResourcePolicies":{ + "name":"GetResourcePolicies", + "http":{ + "method":"POST", + "requestUri":"/getresourcepolicies" + }, + "input":{"shape":"GetResourcePoliciesRequest"}, + "output":{"shape":"GetResourcePoliciesResponse"}, + "errors":[ + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Gets the policies for the specified resources that you own and have shared.

    " + }, + "GetResourceShareAssociations":{ + "name":"GetResourceShareAssociations", + "http":{ + "method":"POST", + "requestUri":"/getresourceshareassociations" + }, + "input":{"shape":"GetResourceShareAssociationsRequest"}, + "output":{"shape":"GetResourceShareAssociationsResponse"}, + "errors":[ + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Gets the resources or principals for the resource shares that you own.

    " + }, + "GetResourceShareInvitations":{ + "name":"GetResourceShareInvitations", + "http":{ + "method":"POST", + "requestUri":"/getresourceshareinvitations" + }, + "input":{"shape":"GetResourceShareInvitationsRequest"}, + "output":{"shape":"GetResourceShareInvitationsResponse"}, + "errors":[ + {"shape":"ResourceShareInvitationArnNotFoundException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Gets the invitations for resource sharing that you've received.

    " + }, + "GetResourceShares":{ + "name":"GetResourceShares", + "http":{ + "method":"POST", + "requestUri":"/getresourceshares" + }, + "input":{"shape":"GetResourceSharesRequest"}, + "output":{"shape":"GetResourceSharesResponse"}, + "errors":[ + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Gets the resource shares that you own or the resource shares that are shared with you.

    " + }, + "ListPendingInvitationResources":{ + "name":"ListPendingInvitationResources", + "http":{ + "method":"POST", + "requestUri":"/listpendinginvitationresources" + }, + "input":{"shape":"ListPendingInvitationResourcesRequest"}, + "output":{"shape":"ListPendingInvitationResourcesResponse"}, + "errors":[ + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ResourceShareInvitationArnNotFoundException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"ResourceShareInvitationAlreadyRejectedException"}, + {"shape":"ResourceShareInvitationExpiredException"} + ], + "documentation":"

    Lists the resources in a resource share that is shared with you but that the invitation is still pending for.

    " + }, + "ListPrincipals":{ + "name":"ListPrincipals", + "http":{ + "method":"POST", + "requestUri":"/listprincipals" + }, + "input":{"shape":"ListPrincipalsRequest"}, + "output":{"shape":"ListPrincipalsResponse"}, + "errors":[ + {"shape":"MalformedArnException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Lists the principals that you have shared resources with or the principals that have shared resources with you.

    " + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/listresources" + }, + "input":{"shape":"ListResourcesRequest"}, + "output":{"shape":"ListResourcesResponse"}, + "errors":[ + {"shape":"InvalidResourceTypeException"}, + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Lists the resources that you added to a resource shares or the resources that are shared with you.

    " + }, + "RejectResourceShareInvitation":{ + "name":"RejectResourceShareInvitation", + "http":{ + "method":"POST", + "requestUri":"/rejectresourceshareinvitation" + }, + "input":{"shape":"RejectResourceShareInvitationRequest"}, + "output":{"shape":"RejectResourceShareInvitationResponse"}, + "errors":[ + {"shape":"MalformedArnException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ResourceShareInvitationArnNotFoundException"}, + {"shape":"ResourceShareInvitationAlreadyAcceptedException"}, + {"shape":"ResourceShareInvitationAlreadyRejectedException"}, + {"shape":"ResourceShareInvitationExpiredException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Rejects an invitation to a resource share from another AWS account.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tagresource" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MalformedArnException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"ResourceArnNotFoundException"}, + {"shape":"TagPolicyViolationException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Adds the specified tags to the specified resource share that you own.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/untagresource" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Removes the specified tags from the specified resource share that you own.

    " + }, + "UpdateResourceShare":{ + "name":"UpdateResourceShare", + "http":{ + "method":"POST", + "requestUri":"/updateresourceshare" + }, + "input":{"shape":"UpdateResourceShareRequest"}, + "output":{"shape":"UpdateResourceShareResponse"}, + "errors":[ + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnknownResourceException"}, + {"shape":"MalformedArnException"}, + {"shape":"InvalidClientTokenException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerInternalException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Updates the specified resource share that you own.

    " + } + }, + "shapes":{ + "AcceptResourceShareInvitationRequest":{ + "type":"structure", + "required":["resourceShareInvitationArn"], + "members":{ + "resourceShareInvitationArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the invitation.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "AcceptResourceShareInvitationResponse":{ + "type":"structure", + "members":{ + "resourceShareInvitation":{ + "shape":"ResourceShareInvitation", + "documentation":"

    Information about the invitation.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "AssociateResourceShareRequest":{ + "type":"structure", + "required":["resourceShareArn"], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resources.

    " + }, + "principals":{ + "shape":"PrincipalArnOrIdList", + "documentation":"

    The principals.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "AssociateResourceShareResponse":{ + "type":"structure", + "members":{ + "resourceShareAssociations":{ + "shape":"ResourceShareAssociationList", + "documentation":"

    Information about the associations.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "Boolean":{"type":"boolean"}, + "CreateResourceShareRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resources to associate with the resource share.

    " + }, + "principals":{ + "shape":"PrincipalArnOrIdList", + "documentation":"

    The principals to associate with the resource share. The possible values are IDs of AWS accounts, the ARN of an OU or organization from AWS Organizations.

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    One or more tags.

    " + }, + "allowExternalPrincipals":{ + "shape":"Boolean", + "documentation":"

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "CreateResourceShareResponse":{ + "type":"structure", + "members":{ + "resourceShare":{ + "shape":"ResourceShare", + "documentation":"

    Information about the resource share.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "DateTime":{"type":"timestamp"}, + "DeleteResourceShareRequest":{ + "type":"structure", + "required":["resourceShareArn"], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    ", + "location":"querystring", + "locationName":"resourceShareArn" + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "location":"querystring", + "locationName":"clientToken" + } + } + }, + "DeleteResourceShareResponse":{ + "type":"structure", + "members":{ + "returnValue":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the request succeeded.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "DisassociateResourceShareRequest":{ + "type":"structure", + "required":["resourceShareArn"], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resources.

    " + }, + "principals":{ + "shape":"PrincipalArnOrIdList", + "documentation":"

    The principals.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "DisassociateResourceShareResponse":{ + "type":"structure", + "members":{ + "resourceShareAssociations":{ + "shape":"ResourceShareAssociationList", + "documentation":"

    Information about the associations.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "EnableSharingWithAwsOrganizationRequest":{ + "type":"structure", + "members":{ + } + }, + "EnableSharingWithAwsOrganizationResponse":{ + "type":"structure", + "members":{ + "returnValue":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the request succeeded.

    " + } + } + }, + "GetResourcePoliciesRequest":{ + "type":"structure", + "required":["resourceArns"], + "members":{ + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resources.

    " + }, + "principal":{ + "shape":"String", + "documentation":"

    The principal.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "GetResourcePoliciesResponse":{ + "type":"structure", + "members":{ + "policies":{ + "shape":"PolicyList", + "documentation":"

    A key policy document, in JSON format.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetResourceShareAssociationsRequest":{ + "type":"structure", + "required":["associationType"], + "members":{ + "associationType":{ + "shape":"ResourceShareAssociationType", + "documentation":"

    The association type.

    " + }, + "resourceShareArns":{ + "shape":"ResourceShareArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resource shares.

    " + }, + "resourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource. You cannot specify this parameter if the association type is PRINCIPAL.

    " + }, + "principal":{ + "shape":"String", + "documentation":"

    The principal. You cannot specify this parameter if the association type is RESOURCE.

    " + }, + "associationStatus":{ + "shape":"ResourceShareAssociationStatus", + "documentation":"

    The association status.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "GetResourceShareAssociationsResponse":{ + "type":"structure", + "members":{ + "resourceShareAssociations":{ + "shape":"ResourceShareAssociationList", + "documentation":"

    Information about the associations.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetResourceShareInvitationsRequest":{ + "type":"structure", + "members":{ + "resourceShareInvitationArns":{ + "shape":"ResourceShareInvitationArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the invitations.

    " + }, + "resourceShareArns":{ + "shape":"ResourceShareArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resource shares.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "GetResourceShareInvitationsResponse":{ + "type":"structure", + "members":{ + "resourceShareInvitations":{ + "shape":"ResourceShareInvitationList", + "documentation":"

    Information about the invitations.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetResourceSharesRequest":{ + "type":"structure", + "required":["resourceOwner"], + "members":{ + "resourceShareArns":{ + "shape":"ResourceShareArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resource shares.

    " + }, + "resourceShareStatus":{ + "shape":"ResourceShareStatus", + "documentation":"

    The status of the resource share.

    " + }, + "resourceOwner":{ + "shape":"ResourceOwner", + "documentation":"

    The type of owner.

    " + }, + "name":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "tagFilters":{ + "shape":"TagFilters", + "documentation":"

    One or more tag filters.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "GetResourceSharesResponse":{ + "type":"structure", + "members":{ + "resourceShares":{ + "shape":"ResourceShareList", + "documentation":"

    Information about the resource shares.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A client token input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidClientTokenException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A client token is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidMaxResultsException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified value for MaxResults is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified value for NextToken is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A parameter is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidResourceTypeException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified resource type is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidStateTransitionException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The requested state transition is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListPendingInvitationResourcesRequest":{ + "type":"structure", + "required":["resourceShareInvitationArn"], + "members":{ + "resourceShareInvitationArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the invitation.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "ListPendingInvitationResourcesResponse":{ + "type":"structure", + "members":{ + "resources":{ + "shape":"ResourceList", + "documentation":"

    Information about the resources included the resource share.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListPrincipalsRequest":{ + "type":"structure", + "required":["resourceOwner"], + "members":{ + "resourceOwner":{ + "shape":"ResourceOwner", + "documentation":"

    The type of owner.

    " + }, + "resourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "principals":{ + "shape":"PrincipalArnOrIdList", + "documentation":"

    The principals.

    " + }, + "resourceType":{ + "shape":"String", + "documentation":"

    The resource type.

    Valid values: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration

    " + }, + "resourceShareArns":{ + "shape":"ResourceShareArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resource shares.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "ListPrincipalsResponse":{ + "type":"structure", + "members":{ + "principals":{ + "shape":"PrincipalList", + "documentation":"

    The principals.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListResourcesRequest":{ + "type":"structure", + "required":["resourceOwner"], + "members":{ + "resourceOwner":{ + "shape":"ResourceOwner", + "documentation":"

    The type of owner.

    " + }, + "principal":{ + "shape":"String", + "documentation":"

    The principal.

    " + }, + "resourceType":{ + "shape":"String", + "documentation":"

    The resource type.

    Valid values: route53resolver:ResolverRule | ec2:TransitGateway | ec2:Subnet | license-manager:LicenseConfiguration

    " + }, + "resourceArns":{ + "shape":"ResourceArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resources.

    " + }, + "resourceShareArns":{ + "shape":"ResourceShareArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the resource shares.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

    " + } + } + }, + "ListResourcesResponse":{ + "type":"structure", + "members":{ + "resources":{ + "shape":"ResourceList", + "documentation":"

    Information about the resources.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "MalformedArnException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The format of an Amazon Resource Name (ARN) is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "MaxResults":{ + "type":"integer", + "max":500, + "min":1 + }, + "MissingRequiredParameterException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A required input parameter is missing.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "OperationNotPermittedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The requested operation is not permitted.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Policy":{"type":"string"}, + "PolicyList":{ + "type":"list", + "member":{"shape":"Policy"} + }, + "Principal":{ + "type":"structure", + "members":{ + "id":{ + "shape":"String", + "documentation":"

    The ID of the principal.

    " + }, + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "creationTime":{ + "shape":"DateTime", + "documentation":"

    The time when the principal was associated with the resource share.

    " + }, + "lastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the association was last updated.

    " + }, + "external":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    " + } + }, + "documentation":"

    Describes a principal for use with AWS Resource Access Manager.

    " + }, + "PrincipalArnOrIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PrincipalList":{ + "type":"list", + "member":{"shape":"Principal"} + }, + "RejectResourceShareInvitationRequest":{ + "type":"structure", + "required":["resourceShareInvitationArn"], + "members":{ + "resourceShareInvitationArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the invitation.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "RejectResourceShareInvitationResponse":{ + "type":"structure", + "members":{ + "resourceShareInvitation":{ + "shape":"ResourceShareInvitation", + "documentation":"

    Information about the invitation.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "Resource":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "type":{ + "shape":"String", + "documentation":"

    The resource type.

    " + }, + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "status":{ + "shape":"ResourceStatus", + "documentation":"

    The status of the resource.

    " + }, + "statusMessage":{ + "shape":"String", + "documentation":"

    A message about the status of the resource.

    " + }, + "creationTime":{ + "shape":"DateTime", + "documentation":"

    The time when the resource was associated with the resource share.

    " + }, + "lastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the association was last updated.

    " + } + }, + "documentation":"

    Describes a resource associated with a resource share.

    " + }, + "ResourceArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceArnNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    An Amazon Resource Name (ARN) was not found.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "ResourceOwner":{ + "type":"string", + "enum":[ + "SELF", + "OTHER-ACCOUNTS" + ] + }, + "ResourceShare":{ + "type":"structure", + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "name":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "owningAccountId":{ + "shape":"String", + "documentation":"

    The ID of the AWS account that owns the resource share.

    " + }, + "allowExternalPrincipals":{ + "shape":"Boolean", + "documentation":"

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " + }, + "status":{ + "shape":"ResourceShareStatus", + "documentation":"

    The status of the resource share.

    " + }, + "statusMessage":{ + "shape":"String", + "documentation":"

    A message about the status of the resource share.

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    The tags for the resource share.

    " + }, + "creationTime":{ + "shape":"DateTime", + "documentation":"

    The time when the resource share was created.

    " + }, + "lastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the resource share was last updated.

    " + } + }, + "documentation":"

    Describes a resource share.

    " + }, + "ResourceShareArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceShareAssociation":{ + "type":"structure", + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "resourceShareName":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "associatedEntity":{ + "shape":"String", + "documentation":"

    The associated entity. For resource associations, this is the ARN of the resource. For principal associations, this is the ID of an AWS account or the ARN of an OU or organization from AWS Organizations.

    " + }, + "associationType":{ + "shape":"ResourceShareAssociationType", + "documentation":"

    The association type.

    " + }, + "status":{ + "shape":"ResourceShareAssociationStatus", + "documentation":"

    The status of the association.

    " + }, + "statusMessage":{ + "shape":"String", + "documentation":"

    A message about the status of the association.

    " + }, + "creationTime":{ + "shape":"DateTime", + "documentation":"

    The time when the association was created.

    " + }, + "lastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the association was last updated.

    " + }, + "external":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the principal belongs to the same AWS organization as the AWS account that owns the resource share.

    " + } + }, + "documentation":"

    Describes an association with a resource share.

    " + }, + "ResourceShareAssociationList":{ + "type":"list", + "member":{"shape":"ResourceShareAssociation"} + }, + "ResourceShareAssociationStatus":{ + "type":"string", + "enum":[ + "ASSOCIATING", + "ASSOCIATED", + "FAILED", + "DISASSOCIATING", + "DISASSOCIATED" + ] + }, + "ResourceShareAssociationType":{ + "type":"string", + "enum":[ + "PRINCIPAL", + "RESOURCE" + ] + }, + "ResourceShareInvitation":{ + "type":"structure", + "members":{ + "resourceShareInvitationArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the invitation.

    " + }, + "resourceShareName":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "senderAccountId":{ + "shape":"String", + "documentation":"

    The ID of the AWS account that sent the invitation.

    " + }, + "receiverAccountId":{ + "shape":"String", + "documentation":"

    The ID of the AWS account that received the invitation.

    " + }, + "invitationTimestamp":{ + "shape":"DateTime", + "documentation":"

    The date and time when the invitation was sent.

    " + }, + "status":{ + "shape":"ResourceShareInvitationStatus", + "documentation":"

    The status of the invitation.

    " + }, + "resourceShareAssociations":{ + "shape":"ResourceShareAssociationList", + "documentation":"

    To view the resources associated with a pending resource share invitation, use ListPendingInvitationResources.

    ", + "deprecated":true, + "deprecatedMessage":"This member has been deprecated. Use ListPendingInvitationResources." + } + }, + "documentation":"

    Describes an invitation to join a resource share.

    " + }, + "ResourceShareInvitationAlreadyAcceptedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The invitation was already accepted.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceShareInvitationAlreadyRejectedException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The invitation was already rejected.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceShareInvitationArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ResourceShareInvitationArnNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The Amazon Resource Name (ARN) for an invitation was not found.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceShareInvitationExpiredException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The invitation is expired.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceShareInvitationList":{ + "type":"list", + "member":{"shape":"ResourceShareInvitation"} + }, + "ResourceShareInvitationStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACCEPTED", + "REJECTED", + "EXPIRED" + ] + }, + "ResourceShareLimitExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The requested resource share exceeds the limit for your account.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceShareList":{ + "type":"list", + "member":{"shape":"ResourceShare"} + }, + "ResourceShareStatus":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "FAILED", + "DELETING", + "DELETED" + ] + }, + "ResourceStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "ZONAL_RESOURCE_INACCESSIBLE", + "LIMIT_EXCEEDED", + "UNAVAILABLE", + "PENDING" + ] + }, + "ServerInternalException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The service could not respond to the request due to an internal problem.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The service is not available.

    ", + "error":{"httpStatusCode":503}, + "exception":true + }, + "String":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

    The key of the tag.

    " + }, + "value":{ + "shape":"TagValue", + "documentation":"

    The value of the tag.

    " + } + }, + "documentation":"

    Information about a tag.

    " + }, + "TagFilter":{ + "type":"structure", + "members":{ + "tagKey":{ + "shape":"TagKey", + "documentation":"

    The tag key.

    " + }, + "tagValues":{ + "shape":"TagValueList", + "documentation":"

    The tag values.

    " + } + }, + "documentation":"

    Used to filter information based on tags.

    " + }, + "TagFilters":{ + "type":"list", + "member":{"shape":"TagFilter"} + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagLimitExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The requested tags exceed the limit for your account.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagPolicyViolationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified tag is a reserved word and cannot be used.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceShareArn", + "tags" + ], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    One or more tags.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "TagValueList":{ + "type":"list", + "member":{"shape":"TagValue"} + }, + "UnknownResourceException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A specified resource was not found.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceShareArn", + "tagKeys" + ], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tag keys of the tags to remove.

    " + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateResourceShareRequest":{ + "type":"structure", + "required":["resourceShareArn"], + "members":{ + "resourceShareArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the resource share.

    " + }, + "name":{ + "shape":"String", + "documentation":"

    The name of the resource share.

    " + }, + "allowExternalPrincipals":{ + "shape":"Boolean", + "documentation":"

    Indicates whether principals outside your AWS organization can be associated with a resource share.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + }, + "UpdateResourceShareResponse":{ + "type":"structure", + "members":{ + "resourceShare":{ + "shape":"ResourceShare", + "documentation":"

    Information about the resource share.

    " + }, + "clientToken":{ + "shape":"String", + "documentation":"

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + } + } + } + }, + "documentation":"

    Use AWS Resource Access Manager to share AWS resources between AWS accounts. To share a resource, you create a resource share, associate the resource with the resource share, and specify the principals that can access the resources associated with the resource share. The following principals are supported: AWS accounts, organizational units (OU) from AWS Organizations, and organizations from AWS Organizations.

    For more information, see the AWS Resource Access Manager User Guide.

    " +} diff --git a/aws/dist/botocore/data/rds-data/2018-08-01/paginators-1.json b/aws/dist/botocore/data/rds-data/2018-08-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/rds-data/2018-08-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/rds-data/2018-08-01/service-2.json b/aws/dist/botocore/data/rds-data/2018-08-01/service-2.json new file mode 100644 index 00000000..53cee2dc --- /dev/null +++ b/aws/dist/botocore/data/rds-data/2018-08-01/service-2.json @@ -0,0 +1,864 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-08-01", + "endpointPrefix":"rds-data", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS RDS DataService", + "serviceId":"RDS Data", + "signatureVersion":"v4", + "signingName":"rds-data", + "uid":"rds-data-2018-08-01" + }, + "operations":{ + "BatchExecuteStatement":{ + "name":"BatchExecuteStatement", + "http":{ + "method":"POST", + "requestUri":"/BatchExecute", + "responseCode":200 + }, + "input":{"shape":"BatchExecuteStatementRequest"}, + "output":{"shape":"BatchExecuteStatementResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"StatementTimeoutException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Runs a batch SQL statement over an array of data.

    You can run bulk update and insert operations for multiple records using a DML statement with different parameter sets. Bulk operations can provide a significant performance improvement over individual insert and update operations.

    If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

    " + }, + "BeginTransaction":{ + "name":"BeginTransaction", + "http":{ + "method":"POST", + "requestUri":"/BeginTransaction", + "responseCode":200 + }, + "input":{"shape":"BeginTransactionRequest"}, + "output":{"shape":"BeginTransactionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"StatementTimeoutException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Starts a SQL transaction.

     <important> <p>A transaction can run for a maximum of 24 hours. A transaction is terminated and rolled back automatically after 24 hours.</p> <p>A transaction times out if no calls use its transaction ID in three minutes. If a transaction times out before it's committed, it's rolled back automatically.</p> <p>DDL statements inside a transaction cause an implicit commit. We recommend that you run each DDL statement in a separate <code>ExecuteStatement</code> call with <code>continueAfterTimeout</code> enabled.</p> </important>
    " + }, + "CommitTransaction":{ + "name":"CommitTransaction", + "http":{ + "method":"POST", + "requestUri":"/CommitTransaction", + "responseCode":200 + }, + "input":{"shape":"CommitTransactionRequest"}, + "output":{"shape":"CommitTransactionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Ends a SQL transaction started with the BeginTransaction operation and commits the changes.

    " + }, + "ExecuteSql":{ + "name":"ExecuteSql", + "http":{ + "method":"POST", + "requestUri":"/ExecuteSql", + "responseCode":200 + }, + "input":{"shape":"ExecuteSqlRequest"}, + "output":{"shape":"ExecuteSqlResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Runs one or more SQL statements.

    This operation is deprecated. Use the BatchExecuteStatement or ExecuteStatement operation.

    ", + "deprecated":true, + "deprecatedMessage":"The ExecuteSql API is deprecated, please use the ExecuteStatement API." + }, + "ExecuteStatement":{ + "name":"ExecuteStatement", + "http":{ + "method":"POST", + "requestUri":"/Execute", + "responseCode":200 + }, + "input":{"shape":"ExecuteStatementRequest"}, + "output":{"shape":"ExecuteStatementResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"StatementTimeoutException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Runs a SQL statement against a database.

    If a call isn't part of a transaction because it doesn't include the transactionID parameter, changes that result from the call are committed automatically.

    The response size limit is 1 MB or 1,000 records. If the call returns more than 1 MB of response data or over 1,000 records, the call is terminated.

    " + }, + "RollbackTransaction":{ + "name":"RollbackTransaction", + "http":{ + "method":"POST", + "requestUri":"/RollbackTransaction", + "responseCode":200 + }, + "input":{"shape":"RollbackTransactionRequest"}, + "output":{"shape":"RollbackTransactionResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"ForbiddenException"}, + {"shape":"ServiceUnavailableError"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Performs a rollback of a transaction. Rolling back a transaction cancels its changes.

    " + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":100, + "min":11 + }, + "ArrayOfArray":{ + "type":"list", + "member":{"shape":"ArrayValue"}, + "documentation":"

    An array of arrays.

    Some array entries can be null.

    " + }, + "ArrayValue":{ + "type":"structure", + "members":{ + "arrayValues":{ + "shape":"ArrayOfArray", + "documentation":"

    An array of arrays.

    " + }, + "booleanValues":{ + "shape":"BooleanArray", + "documentation":"

    An array of Boolean values.

    " + }, + "doubleValues":{ + "shape":"DoubleArray", + "documentation":"

    An array of integers.

    " + }, + "longValues":{ + "shape":"LongArray", + "documentation":"

    An array of floating point numbers.

    " + }, + "stringValues":{ + "shape":"StringArray", + "documentation":"

    An array of strings.

    " + } + }, + "documentation":"

    Contains an array.

    " + }, + "ArrayValueList":{ + "type":"list", + "member":{"shape":"Value"} + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The error message returned by this BadRequestException error.

    " + } + }, + "documentation":"

    There is an error in the call or in a SQL statement.

    ", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchExecuteStatementRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "secretArn", + "sql" + ], + "members":{ + "database":{ + "shape":"DbName", + "documentation":"

    The name of the database.

    " + }, + "parameterSets":{ + "shape":"SqlParameterSets", + "documentation":"

    The parameter set for the batch operation.

    " + }, + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    " + }, + "schema":{ + "shape":"DbName", + "documentation":"

    The name of the database schema.

    " + }, + "secretArn":{ + "shape":"Arn", + "documentation":"

    The name or ARN of the secret that enables access to the DB cluster.

    " + }, + "sql":{ + "shape":"SqlStatement", + "documentation":"

    The SQL statement to run.

    " + }, + "transactionId":{ + "shape":"Id", + "documentation":"

    The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

    If the SQL statement is not part of a transaction, don't set this parameter.

    " + } + }, + "documentation":"

    The request parameters represent the input of a SQL statement over an array of data.

    " + }, + "BatchExecuteStatementResponse":{ + "type":"structure", + "members":{ + "updateResults":{ + "shape":"UpdateResults", + "documentation":"

    The execution results of each batch entry.

    " + } + }, + "documentation":"

    The response elements represent the output of a SQL statement over an array of data.

    " + }, + "BeginTransactionRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "secretArn" + ], + "members":{ + "database":{ + "shape":"DbName", + "documentation":"

    The name of the database.

    " + }, + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    " + }, + "schema":{ + "shape":"DbName", + "documentation":"

    The name of the database schema.

    " + }, + "secretArn":{ + "shape":"Arn", + "documentation":"

    The name or ARN of the secret that enables access to the DB cluster.

    " + } + }, + "documentation":"

    The request parameters represent the input of a request to start a SQL transaction.

    " + }, + "BeginTransactionResponse":{ + "type":"structure", + "members":{ + "transactionId":{ + "shape":"Id", + "documentation":"

    The transaction ID of the transaction started by the call.

    " + } + }, + "documentation":"

    The response elements represent the output of a request to start a SQL transaction.

    " + }, + "Blob":{"type":"blob"}, + "Boolean":{"type":"boolean"}, + "BooleanArray":{ + "type":"list", + "member":{"shape":"BoxedBoolean"}, + "documentation":"

    An array of Boolean values.

    Some array entries can be null.

    " + }, + "BoxedBoolean":{ + "type":"boolean", + "box":true + }, + "BoxedDouble":{ + "type":"double", + "box":true + }, + "BoxedFloat":{ + "type":"float", + "box":true + }, + "BoxedInteger":{ + "type":"integer", + "box":true + }, + "BoxedLong":{ + "type":"long", + "box":true + }, + "ColumnMetadata":{ + "type":"structure", + "members":{ + "arrayBaseColumnType":{ + "shape":"Integer", + "documentation":"

    The type of the column.

    " + }, + "isAutoIncrement":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the column increments automatically.

    " + }, + "isCaseSensitive":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the column is case-sensitive.

    " + }, + "isCurrency":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the column contains currency values.

    " + }, + "isSigned":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether an integer column is signed.

    " + }, + "label":{ + "shape":"String", + "documentation":"

    The label for the column.

    " + }, + "name":{ + "shape":"String", + "documentation":"

    The name of the column.

    " + }, + "nullable":{ + "shape":"Integer", + "documentation":"

    A value that indicates whether the column is nullable.

    " + }, + "precision":{ + "shape":"Integer", + "documentation":"

    The precision value of a decimal number column.

    " + }, + "scale":{ + "shape":"Integer", + "documentation":"

    The scale value of a decimal number column.

    " + }, + "schemaName":{ + "shape":"String", + "documentation":"

    The name of the schema that owns the table that includes the column.

    " + }, + "tableName":{ + "shape":"String", + "documentation":"

    The name of the table that includes the column.

    " + }, + "type":{ + "shape":"Integer", + "documentation":"

    The type of the column.

    " + }, + "typeName":{ + "shape":"String", + "documentation":"

    The database-specific data type of the column.

    " + } + }, + "documentation":"

    Contains the metadata for a column.

    " + }, + "CommitTransactionRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "secretArn", + "transactionId" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    " + }, + "secretArn":{ + "shape":"Arn", + "documentation":"

    The name or ARN of the secret that enables access to the DB cluster.

    " + }, + "transactionId":{ + "shape":"Id", + "documentation":"

    The identifier of the transaction to end and commit.

    " + } + }, + "documentation":"

    The request parameters represent the input of a commit transaction request.

    " + }, + "CommitTransactionResponse":{ + "type":"structure", + "members":{ + "transactionStatus":{ + "shape":"TransactionStatus", + "documentation":"

    The status of the commit operation.

    " + } + }, + "documentation":"

    The response elements represent the output of a commit transaction request.

    " + }, + "DbName":{ + "type":"string", + "max":64, + "min":0 + }, + "DecimalReturnType":{ + "type":"string", + "enum":[ + "DOUBLE_OR_LONG", + "STRING" + ] + }, + "DoubleArray":{ + "type":"list", + "member":{"shape":"BoxedDouble"}, + "documentation":"

    An array of floating point numbers.

    Some array entries can be null.

    " + }, + "ErrorMessage":{"type":"string"}, + "ExecuteSqlRequest":{ + "type":"structure", + "required":[ + "awsSecretStoreArn", + "dbClusterOrInstanceArn", + "sqlStatements" + ], + "members":{ + "awsSecretStoreArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the secret that enables access to the DB cluster.

    " + }, + "database":{ + "shape":"DbName", + "documentation":"

    The name of the database.

    " + }, + "dbClusterOrInstanceArn":{ + "shape":"Arn", + "documentation":"

    The ARN of the Aurora Serverless DB cluster.

    " + }, + "schema":{ + "shape":"DbName", + "documentation":"

    The name of the database schema.

    " + }, + "sqlStatements":{ + "shape":"SqlStatement", + "documentation":"

    One or more SQL statements to run on the DB cluster.

    You can separate SQL statements from each other with a semicolon (;). Any valid SQL statement is permitted, including data definition, data manipulation, and commit statements.

    " + } + }, + "documentation":"

    The request parameters represent the input of a request to run one or more SQL statements.

    " + }, + "ExecuteSqlResponse":{ + "type":"structure", + "members":{ + "sqlStatementResults":{ + "shape":"SqlStatementResults", + "documentation":"

    The results of the SQL statement or statements.

    " + } + }, + "documentation":"

    The response elements represent the output of a request to run one or more SQL statements.

    " + }, + "ExecuteStatementRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "secretArn", + "sql" + ], + "members":{ + "continueAfterTimeout":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to continue running the statement after the call times out. By default, the statement stops running when the call times out.

    For DDL statements, we recommend continuing to run the statement after the call times out. When a DDL statement terminates before it is finished running, it can result in errors and possibly corrupted data structures.

    " + }, + "database":{ + "shape":"DbName", + "documentation":"

    The name of the database.

    " + }, + "includeResultMetadata":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to include metadata in the results.

    " + }, + "parameters":{ + "shape":"SqlParametersList", + "documentation":"

    The parameters for the SQL statement.

    " + }, + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    " + }, + "resultSetOptions":{ + "shape":"ResultSetOptions", + "documentation":"

    Options that control how the result set is returned.

    " + }, + "schema":{ + "shape":"DbName", + "documentation":"

    The name of the database schema.

    " + }, + "secretArn":{ + "shape":"Arn", + "documentation":"

    The name or ARN of the secret that enables access to the DB cluster.

    " + }, + "sql":{ + "shape":"SqlStatement", + "documentation":"

    The SQL statement to run.

    " + }, + "transactionId":{ + "shape":"Id", + "documentation":"

    The identifier of a transaction that was started by using the BeginTransaction operation. Specify the transaction ID of the transaction that you want to include the SQL statement in.

    If the SQL statement is not part of a transaction, don't set this parameter.

    " + } + }, + "documentation":"

    The request parameters represent the input of a request to run a SQL statement against a database.

    " + }, + "ExecuteStatementResponse":{ + "type":"structure", + "members":{ + "columnMetadata":{ + "shape":"Metadata", + "documentation":"

    Metadata for the columns included in the results.

    " + }, + "generatedFields":{ + "shape":"FieldList", + "documentation":"

    Values for fields generated during the request.

     <note> <p>The <code>generatedFields</code> data isn't supported by Aurora PostgreSQL. To get the values of generated fields, use the <code>RETURNING</code> clause. For more information, see <a href="https://www.postgresql.org/docs/10/dml-returning.html">Returning Data From Modified Rows</a> in the PostgreSQL documentation.</p> </note>
    " + }, + "numberOfRecordsUpdated":{ + "shape":"RecordsUpdated", + "documentation":"

    The number of records updated by the request.

    " + }, + "records":{ + "shape":"SqlRecords", + "documentation":"

    The records returned by the SQL statement.

    " + } + }, + "documentation":"

    The response elements represent the output of a request to run a SQL statement against a database.

    " + }, + "Field":{ + "type":"structure", + "members":{ + "arrayValue":{ + "shape":"ArrayValue", + "documentation":"

    An array of values.

    " + }, + "blobValue":{ + "shape":"Blob", + "documentation":"

    A value of BLOB data type.

    " + }, + "booleanValue":{ + "shape":"BoxedBoolean", + "documentation":"

    A value of Boolean data type.

    " + }, + "doubleValue":{ + "shape":"BoxedDouble", + "documentation":"

    A value of double data type.

    " + }, + "isNull":{ + "shape":"BoxedBoolean", + "documentation":"

    A NULL value.

    " + }, + "longValue":{ + "shape":"BoxedLong", + "documentation":"

    A value of long data type.

    " + }, + "stringValue":{ + "shape":"String", + "documentation":"

    A value of string data type.

    " + } + }, + "documentation":"

    Contains a value.

    " + }, + "FieldList":{ + "type":"list", + "member":{"shape":"Field"} + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The error message returned by this ForbiddenException error.

    " + } + }, + "documentation":"

    There are insufficient privileges to make the call.

    ", + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Id":{ + "type":"string", + "max":192, + "min":0 + }, + "Integer":{"type":"integer"}, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An internal error occurred.

    ", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "Long":{"type":"long"}, + "LongArray":{ + "type":"list", + "member":{"shape":"BoxedLong"}, + "documentation":"

    An array of integers.

    Some array entries can be null.

    " + }, + "Metadata":{ + "type":"list", + "member":{"shape":"ColumnMetadata"} + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The error message returned by this NotFoundException error.

    " + } + }, + "documentation":"

    The resourceArn, secretArn, or transactionId value can't be found.

    ", + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ParameterName":{"type":"string"}, + "Record":{ + "type":"structure", + "members":{ + "values":{ + "shape":"Row", + "documentation":"

    The values returned in the record.

    " + } + }, + "documentation":"

    A record returned by a call.

    " + }, + "Records":{ + "type":"list", + "member":{"shape":"Record"} + }, + "RecordsUpdated":{"type":"long"}, + "ResultFrame":{ + "type":"structure", + "members":{ + "records":{ + "shape":"Records", + "documentation":"

    The records in the result set.

    " + }, + "resultSetMetadata":{ + "shape":"ResultSetMetadata", + "documentation":"

    The result-set metadata in the result set.

    " + } + }, + "documentation":"

    The result set returned by a SQL statement.

    " + }, + "ResultSetMetadata":{ + "type":"structure", + "members":{ + "columnCount":{ + "shape":"Long", + "documentation":"

    The number of columns in the result set.

    " + }, + "columnMetadata":{ + "shape":"Metadata", + "documentation":"

    The metadata of the columns in the result set.

    " + } + }, + "documentation":"

    The metadata of the result set returned by a SQL statement.

    " + }, + "ResultSetOptions":{ + "type":"structure", + "members":{ + "decimalReturnType":{ + "shape":"DecimalReturnType", + "documentation":"

    A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

    Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.

    " + } + }, + "documentation":"

    Options that control how the result set is returned.

    " + }, + "RollbackTransactionRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "secretArn", + "transactionId" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the Aurora Serverless DB cluster.

    " + }, + "secretArn":{ + "shape":"Arn", + "documentation":"

    The name or ARN of the secret that enables access to the DB cluster.

    " + }, + "transactionId":{ + "shape":"Id", + "documentation":"

    The identifier of the transaction to roll back.

    " + } + }, + "documentation":"

    The request parameters represent the input of a request to perform a rollback of a transaction.

    " + }, + "RollbackTransactionResponse":{ + "type":"structure", + "members":{ + "transactionStatus":{ + "shape":"TransactionStatus", + "documentation":"

    The status of the rollback operation.

    " + } + }, + "documentation":"

    The response elements represent the output of a request to perform a rollback of a transaction.

    " + }, + "Row":{ + "type":"list", + "member":{"shape":"Value"} + }, + "ServiceUnavailableError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The service specified by the resourceArn parameter is not available.

    ", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SqlParameter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ParameterName", + "documentation":"

    The name of the parameter.

    " + }, + "value":{ + "shape":"Field", + "documentation":"

    The value of the parameter.

    " + } + }, + "documentation":"

    A parameter used in a SQL statement.

    " + }, + "SqlParameterSets":{ + "type":"list", + "member":{"shape":"SqlParametersList"} + }, + "SqlParametersList":{ + "type":"list", + "member":{"shape":"SqlParameter"} + }, + "SqlRecords":{ + "type":"list", + "member":{"shape":"FieldList"} + }, + "SqlStatement":{ + "type":"string", + "max":65536, + "min":0 + }, + "SqlStatementResult":{ + "type":"structure", + "members":{ + "numberOfRecordsUpdated":{ + "shape":"RecordsUpdated", + "documentation":"

    The number of records updated by a SQL statement.

    " + }, + "resultFrame":{ + "shape":"ResultFrame", + "documentation":"

    The result set of the SQL statement.

    " + } + }, + "documentation":"

    The result of a SQL statement.

     <important> <p>This data type is deprecated.</p> </important>
    " + }, + "SqlStatementResults":{ + "type":"list", + "member":{"shape":"SqlStatementResult"} + }, + "StatementTimeoutException":{ + "type":"structure", + "members":{ + "dbConnectionId":{ + "shape":"Long", + "documentation":"

    The database connection ID that executed the SQL statement.

    " + }, + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The error message returned by this StatementTimeoutException error.

    " + } + }, + "documentation":"

    The execution of the SQL statement timed out.

    ", + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "StringArray":{ + "type":"list", + "member":{"shape":"String"}, + "documentation":"

    An array of strings.

    Some array entries can be null.

    " + }, + "StructValue":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"ArrayValueList", + "documentation":"

    The attributes returned in the record.

    " + } + }, + "documentation":"

    A structure value returned by a call.

    " + }, + "TransactionStatus":{ + "type":"string", + "max":128, + "min":0 + }, + "UpdateResult":{ + "type":"structure", + "members":{ + "generatedFields":{ + "shape":"FieldList", + "documentation":"

    Values for fields generated during the request.

    " + } + }, + "documentation":"

    The response elements represent the results of an update.

    " + }, + "UpdateResults":{ + "type":"list", + "member":{"shape":"UpdateResult"} + }, + "Value":{ + "type":"structure", + "members":{ + "arrayValues":{ + "shape":"ArrayValueList", + "documentation":"

    An array of column values.

    " + }, + "bigIntValue":{ + "shape":"BoxedLong", + "documentation":"

    A value for a column of big integer data type.

    " + }, + "bitValue":{ + "shape":"BoxedBoolean", + "documentation":"

    A value for a column of BIT data type.

    " + }, + "blobValue":{ + "shape":"Blob", + "documentation":"

    A value for a column of BLOB data type.

    " + }, + "doubleValue":{ + "shape":"BoxedDouble", + "documentation":"

    A value for a column of double data type.

    " + }, + "intValue":{ + "shape":"BoxedInteger", + "documentation":"

    A value for a column of integer data type.

    " + }, + "isNull":{ + "shape":"BoxedBoolean", + "documentation":"

    A NULL value.

    " + }, + "realValue":{ + "shape":"BoxedFloat", + "documentation":"

    A value for a column of real data type.

    " + }, + "stringValue":{ + "shape":"String", + "documentation":"

    A value for a column of string data type.

    " + }, + "structValue":{ + "shape":"StructValue", + "documentation":"

    A value for a column of STRUCT data type.

    " + } + }, + "documentation":"

    Contains the value of a column.

     <important> <p>This data type is deprecated.</p> </important>
    " + } + }, + "documentation":"

    Amazon RDS Data Service

    Amazon RDS provides an HTTP endpoint to run SQL statements on an Amazon Aurora Serverless DB cluster. To run these statements, you work with the Data Service API.

    For more information about the Data Service API, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    If you have questions or comments related to the Data API, send email to Rds-data-api-feedback@amazon.com.

    " +} diff --git a/aws/dist/botocore/data/rds/2014-09-01/paginators-1.json b/aws/dist/botocore/data/rds/2014-09-01/paginators-1.json new file mode 100644 index 00000000..76c4f3a1 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-09-01/paginators-1.json @@ -0,0 +1,107 @@ +{ + "pagination": { + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + } + } +} diff --git a/aws/dist/botocore/data/rds/2014-09-01/service-2.json b/aws/dist/botocore/data/rds/2014-09-01/service-2.json new file mode 100644 index 00000000..727e854f --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-09-01/service-2.json @@ -0,0 +1,6944 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-09-01", + "endpointPrefix":"rds", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "serviceId":"RDS", + "signatureVersion":"v4", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-09-01/", + "protocol":"query" + }, + "documentation":"Amazon Relational Database Service

    Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

    Amazon RDS gives you access to the capabilities of a MySQL, PostgreSQL, Microsoft SQL Server, or Oracle database server. This means the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

    This is an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces.

    ", + "operations":{ + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddSourceIdentifierToSubscriptionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested source could not be found.

    " + } + ], + "documentation":"

    Adds a source identifier to an existing RDS event notification subscription.

    " + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AddTagsToResourceMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + } + ], + "documentation":"

    Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in Condition statement in IAM policy for Amazon RDS.

    For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

    " + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"AuthorizeDBSecurityGroupIngressMessage", + "documentation":"

    " + }, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    ", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB security group does not allow deletion.

    " + }, + { + "shape":"AuthorizationAlreadyExistsFault", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

    " + }, + { + "shape":"AuthorizationQuotaExceededFault", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB security group authorization quota has been reached.

    " + } + ], + "documentation":"

    Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    For an overview of CIDR ranges, go to the Wikipedia Tutorial.

    " + }, + "CopyDBParameterGroup":{ + "name":"CopyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyDBParameterGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CopyDBParameterGroupResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the CreateDBParameterGroup action.

    This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

    ", + "resultWrapper":"CopyDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB parameter group with the same name exists.

    " + }, + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB parameter groups.

    " + } + ], + "documentation":"

    Copies the specified DB parameter group.

    " + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyDBSnapshotMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CopyDBSnapshotResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSnapshots action.

    ", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier is already used by an existing snapshot.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB snapshot does not allow deletion.

    " + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB snapshots.

    " + } + ], + "documentation":"

    Copies the specified DBSnapshot. The source DBSnapshot must be in the \"available\" state.

    " + }, + "CopyOptionGroup":{ + "name":"CopyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CopyOptionGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CopyOptionGroupResult", + "wrapper":true, + "documentation":"

    ", + "resultWrapper":"CopyOptionGroupResult" + }, + "errors":[ + { + "shape":"OptionGroupAlreadyExistsFault", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group you are trying to create already exists.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"OptionGroupQuotaExceededFault", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The quota of 20 option groups was exceeded for this AWS account.

    " + } + ], + "documentation":"

    Copies the specified option group.

    " + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBInstanceMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateDBInstanceResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB instances.

    " + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"StorageTypeNotSupportedFault", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + } + ], + "documentation":"

    Creates a new DB instance.

    " + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB instances.

    " + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"DBSubnetGroupNotAllowedFault", + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

    " + }, + { + "shape":"InvalidDBSubnetGroupFault", + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

    " + }, + { + "shape":"StorageTypeNotSupportedFault", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + } + ], + "documentation":"

    Creates a DB instance that acts as a Read Replica of a source DB instance.

    All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.

    The source DB instance must have backup retention enabled.

    " + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBParameterGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateDBParameterGroupResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the CreateDBParameterGroup action.

    This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

    ", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupQuotaExceededFault", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB parameter groups.

    " + }, + { + "shape":"DBParameterGroupAlreadyExistsFault", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB parameter group with the same name exists.

    " + } + ], + "documentation":"

    Creates a new DB parameter group.

    A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    " + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSecurityGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    ", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupAlreadyExistsFault", + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB security group with the name specified in DBSecurityGroupName already exists.

    " + }, + { + "shape":"DBSecurityGroupQuotaExceededFault", + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB security groups.

    " + }, + { + "shape":"DBSecurityGroupNotSupportedFault", + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB security group is not allowed for this action.

    " + } + ], + "documentation":"

    Creates a new DB security group. DB security groups control access to a DB instance.

    " + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSnapshotMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateDBSnapshotResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSnapshots action.

    ", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier is already used by an existing snapshot.

    " + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB snapshots.

    " + } + ], + "documentation":"

    Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

    " + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateDBSubnetGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    ", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupAlreadyExistsFault", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName is already used by an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetGroupQuotaExceededFault", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB subnet groups.

    " + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + } + ], + "documentation":"

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

    " + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateEventSubscriptionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateEventSubscriptionResult", + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You have reached the maximum number of event subscriptions.

    " + }, + { + "shape":"SubscriptionAlreadyExistFault", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The supplied subscription name already exists.

    " + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    SNS has responded that there is a problem with the SND topic specified.

    " + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You do not have permission to publish to the SNS topic ARN.

    " + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The SNS topic ARN does not exist.

    " + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The supplied category does not exist.

    " + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested source could not be found.

    " + } + ], + "documentation":"

    Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.

    " + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"CreateOptionGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"CreateOptionGroupResult", + "wrapper":true, + "documentation":"

    ", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + { + "shape":"OptionGroupAlreadyExistsFault", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group you are trying to create already exists.

    " + }, + { + "shape":"OptionGroupQuotaExceededFault", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The quota of 20 option groups was exceeded for this AWS account.

    " + } + ], + "documentation":"

    Creates a new option group. You can create up to 20 option groups.

    " + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBInstanceMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DeleteDBInstanceResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"DBSnapshotAlreadyExistsFault", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier is already used by an existing snapshot.

    " + }, + { + "shape":"SnapshotQuotaExceededFault", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB snapshots.

    " + } + ], + "documentation":"

    The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.

    If a final DB snapshot is requested the status of the RDS instance will be \"deleting\" until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action cannot be canceled or reverted once submitted.

    " + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBParameterGroupMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB parameter group cannot be deleted because it is in use.

    " + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + } + ], + "documentation":"

    Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.

    The specified DB parameter group cannot be associated with any DB instances. " + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSecurityGroupMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB security group does not allow deletion.

    " + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + } + ], + "documentation":"

    Deletes a DB security group.

    The specified DB security group must not be associated with any DB instances." + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSnapshotMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DeleteDBSnapshotResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSnapshots action.

    ", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB snapshot does not allow deletion.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + } + ], + "documentation":"

    Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.

    The DBSnapshot must be in the available state to be deleted." + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteDBSubnetGroupMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"InvalidDBSubnetGroupStateFault", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet group cannot be deleted because it is in use.

    " + }, + { + "shape":"InvalidDBSubnetStateFault", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet is not in the available state.

    " + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + } + ], + "documentation":"

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances." + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteEventSubscriptionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + }, + { + "shape":"InvalidEventSubscriptionStateFault", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    This error can occur if someone else is modifying a subscription. You should retry the action.

    " + } + ], + "documentation":"

    Deletes an RDS event notification subscription.

    " + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DeleteOptionGroupMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group is not in the available state.

    " + } + ], + "documentation":"

    Deletes an existing option group.

    " + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBEngineVersions action.

    ", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

    Returns a list of the available DB engines.

    " + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBInstancesMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBInstanceMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBInstances action.

    ", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + } + ], + "documentation":"

    Returns information about provisioned RDS instances. This API supports pagination.

    " + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBLogFilesMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "documentation":"

    The response from a call to DescribeDBLogFiles.

    ", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + } + ], + "documentation":"

    Returns a list of DB log files for the DB instance.

    " + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBParameterGroupsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBParameterGroupsMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameterGroups action.

    ", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + } + ], + "documentation":"

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

    " + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameters action.

    ", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + } + ], + "documentation":"

    Returns the detailed parameter list for a particular DB parameter group.

    " + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSecurityGroupsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBSecurityGroupMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    ", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + } + ], + "documentation":"

    Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

    " + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSnapshotsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBSnapshotMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSnapshots action.

    ", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + } + ], + "documentation":"

    Returns information about DB snapshots. This API supports pagination.

    " + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeDBSubnetGroupsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBSubnetGroupMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

    ", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + } + ], + "documentation":"

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the Wikipedia Tutorial.

    " + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEngineDefaultParametersMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

    ", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

    Returns the default engine and system parameter information for the specified database engine.

    " + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventCategoriesMessage", + "documentation":"

    " + }, + "output":{ + "shape":"EventCategoriesMessage", + "documentation":"

    Data returned from the DescribeEventCategories action.

    ", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

    Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

    " + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventSubscriptionsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"EventSubscriptionsMessage", + "documentation":"

    Data returned by the DescribeEventSubscriptions action.

    ", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + } + ], + "documentation":"

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

    " + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeEventsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"EventsMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeEvents action.

    ", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

    Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

    " + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupOptionsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"OptionGroupOptionsMessage", + "documentation":"

    ", + "resultWrapper":"DescribeOptionGroupOptionsResult" + }, + "documentation":"

    Describes all available options.

    " + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOptionGroupsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"OptionGroups", + "documentation":"

    List of option groups.

    ", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + } + ], + "documentation":"

    Describes the available option groups.

    " + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeOrderableDBInstanceOptionsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

    ", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

    Returns a list of orderable DB instance options for the specified engine.

    " + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ReservedDBInstanceMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstances action.

    ", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + { + "shape":"ReservedDBInstanceNotFoundFault", + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified reserved DB Instance not found.

    " + } + ], + "documentation":"

    Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

    " + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DescribeReservedDBInstancesOfferingsMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

    ", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified offering does not exist.

    " + } + ], + "documentation":"

    Lists available reserved DB instance offerings.

    " + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"DownloadDBLogFilePortionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "documentation":"

    This data type is used as a response element to DownloadDBLogFilePortion.

    ", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + } + ], + "documentation":"

    Downloads all or a portion of the specified log file.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ListTagsForResourceMessage", + "documentation":"

    " + }, + "output":{ + "shape":"TagListMessage", + "documentation":"

    ", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + } + ], + "documentation":"

    Lists all tags on an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

    " + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBInstanceMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ModifyDBInstanceResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB security group does not allow deletion.

    " + }, + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"DBUpgradeDependencyFailureFault", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB upgrade failed because a resource the DB depends on could not be modified.

    " + }, + { + "shape":"StorageTypeNotSupportedFault", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + } + ], + "documentation":"

    Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

    " + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBParameterGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

    Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

    ", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB parameter group cannot be deleted because it is in use.

    " + } + ], + "documentation":"

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    " + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyDBSubnetGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    ", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetQuotaExceededFault", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

    " + }, + { + "shape":"SubnetAlreadyInUse", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet is already in use in the Availability Zone.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + } + ], + "documentation":"

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.

    " + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyEventSubscriptionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + { + "shape":"EventSubscriptionQuotaExceededFault", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You have reached the maximum number of event subscriptions.

    " + }, + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + }, + { + "shape":"SNSInvalidTopicFault", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    SNS has responded that there is a problem with the SND topic specified.

    " + }, + { + "shape":"SNSNoAuthorizationFault", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You do not have permission to publish to the SNS topic ARN.

    " + }, + { + "shape":"SNSTopicArnNotFoundFault", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The SNS topic ARN does not exist.

    " + }, + { + "shape":"SubscriptionCategoryNotFoundFault", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The supplied category does not exist.

    " + } + ], + "documentation":"

    Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ModifyOptionGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"ModifyOptionGroupResult", + "wrapper":true, + "documentation":"

    ", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + { + "shape":"InvalidOptionGroupStateFault", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group is not in the available state.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + } + ], + "documentation":"

    Modifies an existing option group.

    " + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PromoteReadReplicaMessage", + "documentation":"

    " + }, + "output":{ + "shape":"PromoteReadReplicaResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + } + ], + "documentation":"

    Promotes a Read Replica DB instance to a standalone DB instance.

    We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.

    " + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"PurchaseReservedDBInstancesOfferingMessage", + "documentation":"

    " + }, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "wrapper":true, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

    ", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + { + "shape":"ReservedDBInstancesOfferingNotFoundFault", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified offering does not exist.

    " + }, + { + "shape":"ReservedDBInstanceAlreadyExistsFault", + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a reservation with the given identifier.

    " + }, + { + "shape":"ReservedDBInstanceQuotaExceededFault", + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would exceed the user's DB Instance quota.

    " + } + ], + "documentation":"

    Purchases a reserved DB instance offering.

    " + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RebootDBInstanceMessage", + "documentation":"

    " + }, + "output":{ + "shape":"RebootDBInstanceResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + } + ], + "documentation":"

    Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. An Amazon RDS event is created when the reboot is completed.

    If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.

    The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.

    " + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveSourceIdentifierFromSubscriptionMessage", + "documentation":"

    " + }, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + { + "shape":"SubscriptionNotFoundFault", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + }, + { + "shape":"SourceNotFoundFault", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested source could not be found.

    " + } + ], + "documentation":"

    Removes a source identifier from an existing RDS event notification subscription.

    " + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RemoveTagsFromResourceMessage", + "documentation":"

    " + }, + "errors":[ + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + } + ], + "documentation":"

    Removes metadata tags from an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources.

    " + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"ResetDBParameterGroupMessage", + "documentation":"

    " + }, + "output":{ + "shape":"DBParameterGroupNameMessage", + "documentation":"

    Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

    ", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + { + "shape":"InvalidDBParameterGroupStateFault", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB parameter group cannot be deleted because it is in use.

    " + }, + { + "shape":"DBParameterGroupNotFoundFault", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + } + ], + "documentation":"

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

    " + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceFromDBSnapshotMessage", + "documentation":"

    " + }, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + { + "shape":"DBSnapshotNotFoundFault", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB instances.

    " + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + { + "shape":"InvalidDBSnapshotStateFault", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB snapshot does not allow deletion.

    " + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Cannot restore from vpc backup to non-vpc DB instance.

    " + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"StorageTypeNotSupportedFault", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + } + ], + "documentation":"

    Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.

    If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

    " + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RestoreDBInstanceToPointInTimeMessage", + "documentation":"

    " + }, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + { + "shape":"DBInstanceAlreadyExistsFault", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + { + "shape":"DBInstanceNotFoundFault", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + { + "shape":"InstanceQuotaExceededFault", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB instances.

    " + }, + { + "shape":"InsufficientDBInstanceCapacityFault", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + { + "shape":"InvalidDBInstanceStateFault", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + { + "shape":"PointInTimeRestoreNotEnabledFault", + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

    " + }, + { + "shape":"StorageQuotaExceededFault", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + { + "shape":"InvalidVPCNetworkStateFault", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + { + "shape":"InvalidRestoreFault", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Cannot restore from vpc backup to non-vpc DB instance.

    " + }, + { + "shape":"DBSubnetGroupNotFoundFault", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + { + "shape":"DBSubnetGroupDoesNotCoverEnoughAZs", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + { + "shape":"InvalidSubnet", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + }, + { + "shape":"ProvisionedIopsNotAvailableInAZFault", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + { + "shape":"OptionGroupNotFoundFault", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + { + "shape":"StorageTypeNotSupportedFault", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + } + ], + "documentation":"

    Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.

    " + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{ + "shape":"RevokeDBSecurityGroupIngressMessage", + "documentation":"

    " + }, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    ", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + { + "shape":"DBSecurityGroupNotFoundFault", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + { + "shape":"AuthorizationNotFoundFault", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + }, + { + "shape":"InvalidDBSecurityGroupStateFault", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB security group does not allow deletion.

    " + } + ], + "documentation":"

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

    " + } + }, + "shapes":{ + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to add a source identifier to.

    " + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the event source to be added. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
    " + } + }, + "documentation":"

    " + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource the tags will be added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags to be assigned to the Amazon RDS resource.

    " + } + }, + "documentation":"

    " + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified CIDRIP or EC2 security group is already authorized for the specified DB security group.

    " + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified CIDRIP or EC2 security group is not authorized for the specified DB security group.

    RDS may not also be authorized via IAM to perform necessary actions on your behalf.

    " + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB security group authorization quota has been reached.

    " + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to add authorization to.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range to authorize.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + } + }, + "documentation":"

    " + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the availability zone.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains Availability Zone information.

    This data type is used as an element in the following data type:

    " + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

    The name of the character set.

    " + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

    The description of the character set.

    " + } + }, + "documentation":"

    This data type is used as a response element in the action DescribeDBEngineVersions.

    " + }, + "CopyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members":{ + "SourceDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier or ARN for the source DB parameter group.

    Constraints:

    • Must specify a valid DB parameter group.
    • If the source DB parameter group is in the same region as the copy, specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.
    • If the source DB parameter group is in a different region than the copy, specify a valid DB parameter group ARN, for example arn:aws:rds:us-west-2:123456789012:pg:special-parameters.
    " + }, + "TargetDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied DB parameter group.

    Constraints:

    • Cannot be null, empty, or blank
    • Must contain from 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-db-parameter-group

    " + }, + "TargetDBParameterGroupDescription":{ + "shape":"String", + "documentation":"

    A description for the copied DB parameter group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the source DB snapshot.

    Constraints:

    • Must specify a valid system snapshot in the \"available\" state.
    • If the source snapshot is in the same region as the copy, specify a valid DB snapshot identifier.
    • If the source snapshot is in a different region than the copy, specify a valid DB snapshot ARN. For more information, go to Copying a DB Snapshot.

    Example: rds:mydb-2012-04-02-00-01

    Example: arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805

    " + }, + "TargetDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied snapshot.

    Constraints:

    • Cannot be null, empty, or blank
    • Must contain from 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-db-snapshot

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CopyOptionGroupMessage":{ + "type":"structure", + "required":[ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members":{ + "SourceOptionGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier or ARN for the source option group.

    Constraints:

    • Must specify a valid option group.
    • If the source option group is in the same region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.
    • If the source option group is in a different region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.
    " + }, + "TargetOptionGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied option group.

    Constraints:

    • Cannot be null, empty, or blank
    • Must contain from 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

    " + }, + "TargetOptionGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the copied option group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "AllocatedStorage", + "DBInstanceClass", + "Engine", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

    The meaning of this parameter differs according to the database engine you use.

    Type: String

    MySQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    • Must contain 1 to 64 alphanumeric characters
    • Cannot be a word reserved by the specified database engine

    PostgreSQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    • Must contain 1 to 63 alphanumeric characters
    • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).
    • Cannot be a word reserved by the specified database engine

    Oracle

    The Oracle System ID (SID) of the created DB instance.

    Default: ORCL

    Constraints:

    • Cannot be longer than 8 characters

    SQL Server

    Not applicable. Must be null.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
    • First character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of storage (in gigabytes) to be initially allocated for the database instance.

    Type: Integer

    MySQL

    Constraints: Must be an integer from 5 to 3072.

    PostgreSQL

    Constraints: Must be an integer from 5 to 3072.

    Oracle

    Constraints: Must be an integer from 10 to 3072.

    SQL Server

    Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 20 to 1024 (Express Edition and Web Edition)

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for this instance.

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

    Not every database engine is available for every AWS region.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The name of master user for the client DB instance.

    MySQL

    Constraints:

    • Must be 1 to 16 alphanumeric characters.
    • First character must be a letter.
    • Cannot be a reserved word for the chosen database engine.

    Type: String

    Oracle

    Constraints:

    • Must be 1 to 30 alphanumeric characters.
    • First character must be a letter.
    • Cannot be a reserved word for the chosen database engine.

    SQL Server

    Constraints:

    • Must be 1 to 128 alphanumeric characters.
    • First character must be a letter.
    • Cannot be a reserved word for the chosen database engine.
    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password for the master database user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

    Type: String

    MySQL

    Constraints: Must contain from 8 to 41 characters.

    Oracle

    Constraints: Must contain from 8 to 30 characters.

    SQL Server

    Constraints: Must contain from 8 to 128 characters.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with this DB instance.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones.

    Default: A random, system-chosen Availability Zone in the endpoint's region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    A DB subnet group to associate with this DB instance.

    If there is no DB subnet group, then it is a non-VPC DB instance.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which system maintenance can occur. For more information, see DB Instance Maintenance.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    • Must be a value from 0 to 35
    • Cannot be set to 0 if the DB instance is a source to Read Replicas
    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see DB Instance Backups.

    Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

    Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    MySQL

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

    PostgreSQL

    Default: 5432

    Valid Values: 1150-65535

    Type: Integer

    Oracle

    Default: 1521

    Valid Values: 1150-65535

    SQL Server

    Default: 1433

    Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use.

    The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region.

    MySQL

    • Version 5.1: 5.1.45 | 5.1.49 | 5.1.50 | 5.1.57 | 5.1.61 | 5.1.62 | 5.1.63 | 5.1.69 | 5.1.71 | 5.1.73
    • Version 5.5: 5.5.12 | 5.5.20 | 5.5.23 | 5.5.25a | 5.5.27 | 5.5.31 | 5.5.33 | 5.5.37 | 5.5.38 | 5.5.8
    • Version 5.6: 5.6.12 | 5.6.13 | 5.6.17 | 5.6.19 | 5.6.21

    Oracle Database Enterprise Edition (oracle-ee)

    • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

    Oracle Database Standard Edition (oracle-se)

    • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

    Oracle Database Standard Edition One (oracle-se1)

    • Version 11.2: 11.2.0.2.v3 | 11.2.0.2.v4 | 11.2.0.2.v5 | 11.2.0.2.v6 | 11.2.0.2.v7 | 11.2.0.3.v1 | 11.2.0.4.v1

    PostgreSQL

    • Version 9.3: 9.3.1 | 9.3.2 | 9.3.3

    Microsoft SQL Server Enterprise Edition (sqlserver-ee)

    • Version 10.5: 10.50.2789.0.v1
    • Version 11.0: 11.00.2100.60.v1

    Microsoft SQL Server Express Edition (sqlserver-ex)

    • Version 10.5: 10.50.2789.0.v1
    • Version 11.0: 11.00.2100.60.v1

    Microsoft SQL Server Standard Edition (sqlserver-se)

    • Version 10.5: 10.50.2789.0.v1
    • Version 11.0: 11.00.2100.60.v1

    Microsoft SQL Server Web Edition (sqlserver-web)

    • Version 10.5: 10.50.2789.0.v1
    • Version 11.0: 11.00.2100.60.v1
    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

    Default: true

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for this DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    Constraints: To use PIOPS, this value must be an integer greater than 1000.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Indicates that the DB instance should be associated with the specified option group.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    • Default VPC:true
    • VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    " + }, + "Tags":{"shape":"TagList"}, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB Instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the Key Store in order to access the device.

    " + } + }, + "documentation":"

    " + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier of the Read Replica. This is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

    " + }, + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

    Constraints:

    • Must be the identifier of an existing DB instance.
    • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6.
    • Can specify a DB instance that is a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5.
    • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.
    • If the source DB instance is in the same region as the Read Replica, specify a valid DB instance identifier.
    • If the source DB instance is in a different region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing a Amazon RDS Amazon Resource Name (ARN).
    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Read Replica.

    Valid Values: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    Default: Inherits from the source DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Amazon EC2 Availability Zone that the Read Replica will be created in.

    Default: A random, system-chosen Availability Zone in the endpoint's region.

    Example: us-east-1d

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number that the DB instance uses for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that minor engine upgrades will be applied automatically to the Read Replica during the maintenance window.

    Default: Inherits from the source DB instance

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The option group the DB instance will be associated with. If omitted, the default option group for the engine specified will be used.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    • Default VPC:true
    • VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    " + }, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    Specifies a DB subnet group for the DB instance. The new DB instance will be created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

    Constraints:

    • Can only be specified if the source DB instance identifier specifies a DB instance in another region.
    • The specified DB subnet group must be in the same region in which the operation is running.
    • All Read Replicas in one region that are created from the same source DB instance must either:
      • Specify DB subnet groups from the same VPC. All these Read Replicas will be created in the same VPC.
      • Not specify a DB subnet group. All these Read Replicas will be created outside of any VPC.
    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB Instance Read Replica.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

    " + } + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    This value is stored as a lower-case string." + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description for the DB parameter group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB security group. This value is stored as a lowercase string.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    • Must not be \"Default\"
    • May not contain spaces

    Example: mysecuritygroup

    " + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB security group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot.

    Constraints:

    • Cannot be null, empty, or blank
    • Must contain from 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This is the unique key that identifies a DB instance.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

    Example: mySubnetgroup

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB subnet group.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    The EC2 Subnet IDs for the DB subnet group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

    The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are supplied, SourceType must also be provided.
    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.
    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.
    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.
    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.
    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the option group to be created.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: myoptiongroup

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Specifies the name of the engine that this option group should be associated with.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Specifies the major version of the engine that this option group should be associated with.

    " + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

    The description of the option group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group family for the database engine.

    " + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

    The description of the database engine.

    " + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

    The description of the database engine version.

    " + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

    The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API is not specified.

    " + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

    " + } + }, + "documentation":"

    This data type is used as a response element in the action DescribeDBEngineVersions.

    " + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

    A list of DBEngineVersion elements.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBEngineVersions action.

    " + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains a user-supplied database identifier. This is the unique key that identifies a DB instance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    Contains the name of the compute and memory capacity class of the DB instance.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Provides the name of the database engine to be used for this DB instance.

    " + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

    Specifies the current state of this database.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Contains the master username for the DB instance.

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The meaning of this parameter differs according to the database engine you use. For example, this value returns either MySQL or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for MySQL and PostgreSQL.

    MySQL, SQL Server, PostgreSQL

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

    " + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

    Specifies the connection endpoint.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size specified in gigabytes.

    " + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the date and time the DB instance was created.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    " + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

    Specifies the number of days for which automatic DB snapshots are retained.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    " + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    Provides List of VPC security group elements that the DB instance belongs to.

    " + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

    Provides the list of DB parameter groups applied to this DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    Specifies the name of the Availability Zone the DB instance is located in.

    " + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    Specifies the weekly time range (in UTC) during which system maintenance can occur.

    " + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

    " + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    Indicates that minor version patches are applied automatically.

    " + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

    " + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for this DB instance.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the Provisioned IOPS (I/O operations per second) value.

    " + }, + "OptionGroupMemberships":{ + "shape":"OptionGroupMembershipList", + "documentation":"

    Provides the list of option group memberships for this DB instance.

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    If present, specifies the name of the character set that this instance is associated with.

    " + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    " + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    • Default VPC:true
    • VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    " + }, + "StatusInfos":{ + "shape":"DBInstanceStatusInfoList", + "documentation":"

    The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type associated with DB Instance.

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which the instance is associated for TDE encryption.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBInstances action.

    " + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a DB instance with the given identifier.

    " + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

    A list of DBInstance instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBInstances action.

    " + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBInstanceIdentifier does not refer to an existing DB instance.

    " + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{ + "shape":"String", + "documentation":"

    This value is currently \"read replication.\"

    " + }, + "Normal":{ + "shape":"Boolean", + "documentation":"

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank.

    " + } + }, + "documentation":"

    Provides a list of status information for a DB instance.

    " + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group family that this DB parameter group is compatible with.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Provides the customer-specified description for this DB parameter group.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the CreateDBParameterGroup action.

    This data type is used as a request parameter in the DeleteDBParameterGroup action, and as a response element in the DescribeDBParameterGroups action.

    " + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB parameter group with the same name exists.

    " + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    A list of Parameter values.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameters action.

    " + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

    " + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBParameterGroupName does not refer to an existing DB parameter group.

    " + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB parameter groups.

    " + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DP parameter group.

    " + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

    The status of parameter updates.

    " + } + }, + "documentation":"

    The status of the DB parameter group.

    This data type is used as a response element in the following actions:

    " + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

    A list of DBParameterGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameterGroups action.

    " + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

    Provides the AWS ID of the owner of a specific DB security group.

    " + }, + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB security group.

    " + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

    Provides the description of the DB security group.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VpcId of the DB security group.

    " + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

    Contains a list of EC2SecurityGroup elements.

    " + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

    Contains a list of IPRange elements.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    " + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB security group with the name specified in DBSecurityGroupName already exists.

    " + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB security group.

    " + } + }, + "documentation":"

    This data type is used as a response element in the following actions:

    " + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroups", + "documentation":"

    A list of DBSecurityGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    " + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSecurityGroupName does not refer to an existing DB security group.

    " + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    A DB security group is not allowed for this action.

    " + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB security groups.

    " + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier for the DB snapshot.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    " + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the time (UTC) when the snapshot was taken.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Specifies the name of the database engine.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size in gigabytes (GB).

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of this DB snapshot.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the database engine was listening on at the time of the snapshot.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the Vpc Id associated with the DB snapshot.

    " + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the time (UTC) when the snapshot was taken.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Provides the master username for the DB snapshot.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Specifies the version of the database engine.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    Provides the type of the DB snapshot.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Provides the option group name for the DB snapshot.

    " + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

    The percentage of the estimated data that has been transferred.

    " + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

    The region that the DB snapshot was created in or copied from.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type associated with DB Snapshot.

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which to associate the instance for TDE encryption.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSnapshots action.

    " + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier is already used by an existing snapshot.

    " + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSnapshots":{ + "shape":"DBSnapshotList", + "documentation":"

    A list of DBSnapshot instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSnapshots action.

    " + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSnapshotIdentifier does not refer to an existing DB snapshot.

    " + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB subnet group.

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    Provides the description of the DB subnet group.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VpcId of the DB subnet group.

    " + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

    Provides the status of the DB subnet group.

    " + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

    Contains a list of Subnet elements.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the following actions:

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    " + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName is already used by an existing DB subnet group.

    " + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    " + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

    A list of DBSubnetGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

    " + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Indicates that the DBSubnetGroup should not be specified while creating read replicas that lie in the same region as the source instance.

    " + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    DBSubnetGroupName does not refer to an existing DB subnet group.

    " + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB subnet groups.

    " + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of subnets in a DB subnet groups.

    " + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB upgrade failed because a resource the DB depends on could not be modified.

    " + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier for the DB instance to be deleted. This parameter isn't case sensitive.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

    Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

    Specify true when deleting a Read Replica.

    The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

    Default: false

    " + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    • Cannot be specified when deleting a Read Replica.
    " + } + }, + "documentation":"

    " + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be the name of an existing DB parameter group
    • You cannot delete a default DB parameter group
    • Cannot be associated with any DB instances
    " + } + }, + "documentation":"

    " + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to delete.

    You cannot delete the default DB security group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    • Must not be \"Default\"
    • May not contain spaces
    " + } + }, + "documentation":"

    " + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DBSnapshot identifier.

    Constraints: Must be the name of an existing DB snapshot in the available state.

    " + } + }, + "documentation":"

    " + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the database subnet group to delete.

    You cannot delete the default subnet group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + } + }, + "documentation":"

    " + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to delete.

    " + } + }, + "documentation":"

    " + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be deleted.

    You cannot delete default option groups." + } + }, + "documentation":"

    " + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to return.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The database engine version to return.

    Example: 5.1.49

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group family to return details for.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    Not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

    Indicates that only the default version of the specified engine or engine and major version combination is returned.

    " + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

    If this parameter is specified, and if the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    " + } + } + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case sensitive.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    " + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{ + "shape":"String", + "documentation":"

    The name of the log file for the specified DB instance.

    " + }, + "LastWritten":{ + "shape":"Long", + "documentation":"

    A POSIX timestamp when the last log entry was written.

    " + }, + "Size":{ + "shape":"Long", + "documentation":"

    The size, in bytes, of the log file for the specified DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element to DescribeDBLogFiles.

    " + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "FilenameContains":{ + "shape":"String", + "documentation":"

    Filters the available log files for log file names that contain the specified string.

    " + }, + "FileLastWritten":{ + "shape":"Long", + "documentation":"

    Filters the available log files for files written since the specified date, in POSIX timestamp format.

    " + }, + "FileSize":{ + "shape":"Long", + "documentation":"

    Filters the available log files for files larger than the specified size.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{ + "shape":"DescribeDBLogFilesList", + "documentation":"

    The DB log files returned.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DescribeDBLogFiles request.

    " + } + }, + "documentation":"

    The response from a call to DescribeDBLogFiles.

    " + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group to return details for.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group to return details for.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Source":{ + "shape":"String", + "documentation":"

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to return details for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    A DB instance identifier to retrieve the list of DB snapshots for. Cannot be used in conjunction with DBSnapshotIdentifier. This parameter is not case sensitive.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    A specific DB snapshot identifier to describe. Cannot be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    • If this is the identifier of an automated snapshot, the SnapshotType parameter must also be specified.
    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    The type of snapshots that will be returned. Values can be \"automated\" or \"manual.\" If not specified, the returned results will include all snapshots types.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB subnet group to return details for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group family.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    Not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that will be generating the events.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + } + }, + "documentation":"

    " + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to describe.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    " + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

    Constraints:

    • If SourceIdentifier is supplied, SourceType must also be provided.
    • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.
    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.
    • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.
    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.
    • Cannot end with a hyphen or contain two consecutive hyphens.
    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    The event source to retrieve events for. If no value is specified, all events are returned.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

    The number of minutes to retrieve events for.

    Default: 60

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories that trigger notifications for a event notification subscription.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

    A required parameter. Options available for the given Engine name will be described.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    If specified, filters the results to include only options for the specified major engine version.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Filters the list of option groups to only include groups associated with a specific database engine.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

    " + } + }, + "documentation":"

    " + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The name of the engine to retrieve DB instance options for.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    " + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

    The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

    " + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    " + }, + "Duration":{ + "shape":"String", + "documentation":"

    The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " + }, + "Duration":{ + "shape":"String", + "documentation":"

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: \"Light Utilization\" | \"Medium Utilization\" | \"Heavy Utilization\"

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

    Default: 100

    Constraints: minimum 20, maximum 100

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "Double":{"type":"double"}, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{ + "shape":"String", + "documentation":"

    Entries from the specified log file.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

    " + }, + "AdditionalDataPending":{ + "shape":"Boolean", + "documentation":"

    Boolean value that if true, indicates there is more data to be downloaded.

    " + } + }, + "documentation":"

    This data type is used as a response element to DownloadDBLogFilePortion.

    " + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "LogFileName":{ + "shape":"String", + "documentation":"

    The name of the log file to be downloaded.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

    " + }, + "NumberOfLines":{ + "shape":"Integer", + "documentation":"

    The number of lines to download.

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

    • If neither Marker or NumberOfLines are specified, the entire log file is returned.

    • If NumberOfLines is specified and Marker is not specified, then the most recent lines from the end of the log file are returned.

    • If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.

    • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

    " + } + }, + "documentation":"

    " + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the EC2 security group.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    Specifies the id of the EC2 security group.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

    " + } + }, + "documentation":"

    This data type is used as a response element in the following actions:

    " + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

    Specifies the DNS address of the DB instance.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the database engine is listening on.

    " + } + }, + "documentation":"

    This data type is used as a response element in the following actions:

    " + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB parameter group family which the engine default parameters apply to.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    Contains a list of engine default parameters.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

    " + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    Provides the identifier for the source of the event.

    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    Specifies the source type for this event.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    Provides the text of this event.

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    Specifies the category for the event.

    " + }, + "Date":{ + "shape":"TStamp", + "documentation":"

    Specifies the date and time of the event.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeEvents action.

    " + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The source type that the returned categories belong to

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    The event categories for the specified source type

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventCategories action.

    " + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

    A list of EventCategoriesMap data types.

    " + } + }, + "documentation":"

    Data returned from the DescribeEventCategories action.

    " + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

    The AWS customer account associated with the RDS event notification subscription.

    " + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

    The RDS event notification subscription Id.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The topic ARN of the RDS event notification subscription.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the RDS event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

    " + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

    The time the RDS event notification subscription was created.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The source type for the RDS event notification subscription.

    " + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

    A list of source IDs for the RDS event notification subscription.

    " + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for the RDS event notification subscription.

    " + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    " + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You have reached the maximum number of event subscriptions.

    " + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

    A list of EventSubscriptions data types.

    " + } + }, + "documentation":"

    Data returned by the DescribeEventSubscriptions action.

    " + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "Events":{ + "shape":"EventList", + "documentation":"

    A list of Event instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeEvents action.

    " + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    This parameter is not currently supported.

    " + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

    This parameter is not currently supported.

    " + } + } + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    Specifies the IP range.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    " + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB instances.

    " + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified DB instance class is not available in the specified Availability Zone.

    " + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified DB instance is not in the available state.

    " + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB parameter group cannot be deleted because it is in use.

    " + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB security group does not allow deletion.

    " + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The state of the DB snapshot does not allow deletion.

    " + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Indicates the DBSubnetGroup does not belong to the same VPC as that of an existing cross region read replica of the same source instance.

    " + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet group cannot be deleted because it is in use.

    " + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet is not in the available state.

    " + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    This error can occur if someone else is modifying a subscription. You should retry the action.

    " + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group is not in the available state.

    " + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Cannot restore from vpc backup to non-vpc DB instance.

    " + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    " + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    DB subnet group does not cover all Availability Zones after it is created because users' change.

    " + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter is not currently supported.

    " + } + }, + "documentation":"

    " + }, + "Long":{"type":"long"}, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must be the identifier for an existing DB instance
    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The new storage capacity of the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless ApplyImmediately is set to true for this request.

    MySQL

    Default: Uses existing setting

    Valid Values: 5-3072

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    Type: Integer

    PostgreSQL

    Default: Uses existing setting

    Valid Values: 5-3072

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    Type: Integer

    Oracle

    Default: Uses existing setting

    Valid Values: 10-3072

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    SQL Server

    Cannot be modified.

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The new compute and memory capacity of the DB instance. To determine the instance classes that are available for a particular DB engine, use the DescribeOrderableDBInstanceOptions action.

    Passing a value for this setting causes an outage during the change and is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

    Default: Uses existing setting

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DB security groups to authorize on this DB instance. Changing this setting does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance.

    If this parameter is set to false, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and will be applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes will be applied.

    Default: false

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The new password for the DB instance master user. Can be any printable ASCII character except \"/\", \"\"\", or \"@\".

    Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    Default: Uses existing setting

    Constraints: Must be 8 to 41 alphanumeric characters (MySQL), 8 to 30 alphanumeric characters (Oracle), or 8 to 128 alphanumeric characters (SQL Server).

    Amazon RDS API actions never return the password, so this action provides a way to regain access to a master instance user if the password is lost. This includes restoring privileges that may have been accidentally revoked. " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to apply to the DB instance. Changing this setting does not result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. The db instance will NOT be rebooted automatically and the parameter changes will NOT be applied during the next maintenance window.

    Default: Uses existing setting

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

    Default: Uses existing setting

    Constraints:

    • Must be a value from 0 to 35
    • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6
    • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5
    • Cannot be set to 0 if the DB instance is a source to Read Replicas
    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi
    • Times should be Universal Time Coordinated (UTC)
    • Must not conflict with the preferred maintenance window
    • Must be at least 30 minutes
    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which system maintenance can occur, which may result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment. Changing this parameter does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Constraints: Cannot be specified if the DB instance is a Read Replica.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    For major version upgrades, if a non-default DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

    For a list of valid engine versions, see CreateDBInstance.

    " + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.

    Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The new Provisioned IOPS (I/O operations per second) value for the RDS instance. Changing this setting does not result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

    Default: Uses existing setting

    Constraints: Value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

    Type: Integer

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance will be available for use, but may experience performance degradation. While the migration takes place, nightly backups for the instance will be suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a read replica for the instance, and creating a DB snapshot of the instance.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Indicates that the DB instance should be associated with the specified option group. Changing this parameter does not result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    " + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot will occur immediately if you set Apply Immediately to true, or will occur during the next maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB Instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the Key Store in order to access the device.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be the name of an existing DB parameter group
    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

    Valid Values (for the application method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover. " + } + }, + "documentation":"

    " + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 alphanumeric characters or hyphens. Must not be \"Default\".

    Example: mySubnetgroup

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB subnet group.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    The EC2 subnet IDs for the DB subnet group.

    " + } + }, + "documentation":"

    " + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A Boolean value; set to true to activate the subscription.

    " + } + }, + "documentation":"

    " + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be modified.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    " + }, + "OptionsToInclude":{ + "shape":"OptionConfigurationList", + "documentation":"

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

    " + }, + "OptionsToRemove":{ + "shape":"OptionNamesList", + "documentation":"

    Options in this list are removed from the option group.

    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

    " + } + }, + "documentation":"

    " + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

    The name of the option.

    " + }, + "OptionDescription":{ + "shape":"String", + "documentation":"

    The description of the option.

    " + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

    Indicate if this option is persistent.

    " + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

    Indicate if this option is permanent.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    If required, the port configured for this option to use.

    " + }, + "OptionSettings":{ + "shape":"OptionSettingConfigurationList", + "documentation":"

    The option settings for this option.

    " + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

    If the option requires access to a port, then this DB security group allows access to the port.

    " + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    If the option requires access to a port, then this VPC security group allows access to the port.

    " + } + }, + "documentation":"

    Option details.

    " + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

    The configuration of options to include in a group.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The optional port for the option.

    " + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DBSecurityGroupMemebrship name strings used for this option.

    " + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VpcSecurityGroupMemebrship name strings used for this option.

    " + }, + "OptionSettings":{ + "shape":"OptionSettingsList", + "documentation":"

    The option settings to include in an option group.

    " + } + }, + "documentation":"

    A list of all available options

    " + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the option group.

    " + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

    Provides a description of the option group.

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Engine name that this option group can be applied to.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the major engine version associated with this option group.

    " + }, + "Options":{ + "shape":"OptionsList", + "documentation":"

    Indicates what options are available in the option group.

    " + }, + "AllowsVpcAndNonVpcInstanceMemberships":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

    " + } + }, + "wrapper":true, + "documentation":"

    " + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The option group you are trying to create already exists.

    " + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group that the instance belongs to.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB instance's option group membership (e.g. in-sync, pending, pending-maintenance, applying).

    " + } + }, + "documentation":"

    Provides information on the option groups the DB instance is a member of.

    " + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified option group could not be found.

    " + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the option.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the option.

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    The name of the engine that this option can be applied to.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the major engine version that the option is available for.

    " + }, + "MinimumRequiredMinorEngineVersion":{ + "shape":"String", + "documentation":"

    The minimum required engine version for the option to be applied.

    " + }, + "PortRequired":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the option requires a port.

    " + }, + "DefaultPort":{ + "shape":"IntegerOptional", + "documentation":"

    If the option requires a port, specifies the default port for the option.

    " + }, + "OptionsDependedOn":{ + "shape":"OptionsDependedOn", + "documentation":"

    List of all options that are prerequisites for this option.

    " + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

    A persistent option cannot be removed from the option group once the option group is used, but this option can be removed from the db instance while modifying the related data and assigning another option group without this option.

    " + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

    A permanent option cannot be removed from the option group once the option group is used, and it cannot be removed from the db instance after assigning an option group with this permanent option.

    " + }, + "OptionGroupOptionSettings":{ + "shape":"OptionGroupOptionSettingsList", + "documentation":"

    Specifies the option settings that are available (and the default value) for each option in an option group.

    " + } + }, + "documentation":"

    Available option.

    " + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{ + "shape":"String", + "documentation":"

    The name of the option group option.

    " + }, + "SettingDescription":{ + "shape":"String", + "documentation":"

    The description of the option group option.

    " + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

    The default value for the option group option.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    The DB engine specific parameter type for the option group option.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    Indicates the acceptable values for the option group option.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    Boolean value where true indicates that this option group option can be changed from the default value.

    " + } + }, + "documentation":"

    Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

    " + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + }, + "documentation":"

    List of available option group options.

    " + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The quota of 20 option groups was exceeded for this AWS account.

    " + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{ + "shape":"OptionGroupsList", + "documentation":"

    List of option groups.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    List of option groups.

    " + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the option that has settings that you can set.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The current value of the option setting.

    " + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

    The default value of the option setting.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the option setting.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    The DB engine specific parameter type.

    " + }, + "DataType":{ + "shape":"String", + "documentation":"

    The data type of the option setting.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    The allowed values of the option setting.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    A Boolean value that, when true, indicates the option setting can be modified from the default.

    " + }, + "IsCollection":{ + "shape":"Boolean", + "documentation":"

    Indicates if the option setting is part of a collection.

    " + } + }, + "documentation":"

    Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

    " + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The engine type of the orderable DB instance.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version of the orderable DB instance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance Class for the orderable DB instance

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model for the orderable DB instance.

    " + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

    A list of availability zones for the orderable DB instance.

    " + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this orderable DB instance is multi-AZ capable.

    " + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this orderable DB instance can have a Read Replica.

    " + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this is a VPC orderable DB instance.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    The storage type for this orderable DB instance.

    " + }, + "SupportsIops":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this orderable DB instance supports provisioned IOPS.

    " + } + }, + "wrapper":true, + "documentation":"

    Contains a list of available options for a DB instance

    This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

    " + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

    " + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

    Specifies the name of the parameter.

    " + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

    Specifies the value of the parameter.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Provides a description of the parameter.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    Indicates the source of the parameter value.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    Specifies the engine specific parameters type.

    " + }, + "DataType":{ + "shape":"String", + "documentation":"

    Specifies the valid data type for the parameter.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    Specifies the valid range of values for the parameter.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    " + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

    The earliest engine version to which the parameter can apply.

    " + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

    Indicates when to apply parameter updates.

    " + } + }, + "documentation":"

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    " + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    Contains the pending or in-progress change of the master credentials for the DB instance.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the pending port for the DB instance.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the pending number of days for which automated backups are retained.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the new Provisioned IOPS value for the DB instance that will be applied or is being applied.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element in the ModifyDBInstance action.

    " + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

    " + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must be the identifier for an existing Read Replica DB instance
    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: mydbinstance

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    • Must be a value from 0 to 8
    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned.

    Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

    " + } + }, + "documentation":"

    " + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    " + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The ID of the Reserved DB instance offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    " + }, + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    Customer-specified identifier to track this reservation.

    Example: myreservationID

    " + }, + "DBInstanceCount":{ + "shape":"IntegerOptional", + "documentation":"

    The number of instances to reserve.

    Default: 1

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

    When true, the reboot will be conducted through a MultiAZ failover.

    Constraint: You cannot specify true if the instance is not configured for MultiAZ.

    " + } + }, + "documentation":"

    " + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

    The amount of the recurring charge.

    " + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

    The frequency of the recurring charge.

    " + } + }, + "wrapper":true, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

    " + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to remove a source identifier from.

    " + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

    " + } + }, + "documentation":"

    " + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource the tags will be removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    " + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

    The tag key (name) of the tag to be removed.

    " + } + }, + "documentation":"

    " + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    The unique identifier for the reservation.

    " + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class for the reserved DB instance.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The time the reservation started.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration of the reservation in seconds.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The fixed price charged for this reserved DB instance.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The hourly price charged for this reserved DB instance.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the reserved DB instance.

    " + }, + "DBInstanceCount":{ + "shape":"Integer", + "documentation":"

    The number of reserved DB instances.

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The description of the reserved DB instance.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type of this reserved DB instance.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Indicates if the reservation applies to Multi-AZ deployments.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The state of the reserved DB instance.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The recurring price charged to run this reserved DB instance.

    " + } + }, + "wrapper":true, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

    " + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    User already has a reservation with the given identifier.

    " + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "ReservedDBInstances":{ + "shape":"ReservedDBInstanceList", + "documentation":"

    A list of reserved DB instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstances action.

    " + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified reserved DB Instance not found.

    " + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would exceed the user's DB Instance quota.

    " + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class for the reserved DB instance.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration of the offering in seconds.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The fixed price charged for this offering.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The hourly price charged for this offering.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the reserved DB instance offering.

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The database engine used by the offering.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Indicates if the offering applies to Multi-AZ deployments.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The recurring price charged to run this reserved DB instance.

    " + } + }, + "wrapper":true, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

    " + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "ReservedDBInstancesOfferings":{ + "shape":"ReservedDBInstancesOfferingList", + "documentation":"

    A list of reserved DB instance offerings.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

    " + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    Specified offering does not exist.

    " + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

    Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

    Default: true

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request.

    MySQL

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    Oracle

    Valid Values (for Apply method): pending-reboot

    " + } + }, + "documentation":"

    " + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Name of the DB instance to create from the DB snapshot. This parameter isn't case sensitive.

    Constraints:

    • Must contain from 1 to 255 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot to restore from.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Amazon RDS DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance

    Constraints: Value must be 1150-65535

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The EC2 Availability Zone that the database instance will be created in.

    Default: A random, system-chosen Availability Zone.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    Example: us-east-1a

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The DB subnet group name to use for the new instance.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    • Default VPC:true
    • VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    Default: Same as source.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB instance.

    This parameter doesn't apply to the MySQL engine.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value will be taken from the backup. If this parameter is set to 0, the new instance will be converted to a non-PIOPS instance, which will take additional time, though your DB instance will be available for connections before the conversion starts.

    Constraints: Must be an integer greater than 1000.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    " + }, + "Tags":{"shape":"TagList"}, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB Instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the Key Store in order to access the device.

    " + } + }, + "documentation":"

    " + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":[ + "SourceDBInstanceIdentifier", + "TargetDBInstanceIdentifier" + ], + "members":{ + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the source DB instance from which to restore.

    Constraints:

    • Must be the identifier of an existing database instance
    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The name of the new database instance to be created.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens
    • First character must be a letter
    • Cannot end with a hyphen or contain two consecutive hyphens
    " + }, + "RestoreTime":{ + "shape":"TStamp", + "documentation":"

    The date and time to restore from.

    Valid Values: Value must be a UTC time

    Constraints:

    • Must be before the latest restorable time for the DB instance
    • Cannot be specified if UseLatestRestorableTime parameter is true

    Example: 2009-09-07T23:45:00Z

    " + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

    Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

    Default: false

    Constraints: Cannot be specified if RestoreTime parameter is provided.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Amazon RDS DB instance.

    Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium

    Default: The same DBInstanceClass as the original DB instance.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The EC2 Availability Zone that the database instance will be created in.

    Default: A random, system-chosen Availability Zone.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    Example: us-east-1a

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The DB subnet group name to use for the new instance.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment.

    Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

    • Default VPC:true
    • VPC:false

    If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    Default: Same as source.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB instance.

    This parameter is not used for the MySQL engine.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web | postgres

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    Constraints: Must be an integer greater than 1000.

    SQL Server

    Setting the IOPS value for the SQL Server database engine is not supported.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

    " + }, + "Tags":{"shape":"TagList"}, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies storage type to be associated with the DB Instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise standard

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the Key Store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the Key Store in order to access the device.

    " + } + }, + "documentation":"

    " + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to revoke ingress from.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId cannot be provided.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + } + }, + "documentation":"

    " + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    SNS has responded that there is a problem with the SND topic specified.

    " + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    You do not have permission to publish to the SNS topic ARN.

    " + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The SNS topic ARN does not exist.

    " + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed number of DB snapshots.

    " + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The requested source could not be found.

    " + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot" + ] + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Request would result in user exceeding the allowed amount of storage available across all DB instances.

    " + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    StorageType specified cannot be associated with the DB Instance.

    " + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier of the subnet.

    " + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

    Specifies the status of the subnet.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    " + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The DB subnet is already in use in the Availability Zone.

    " + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The supplied subscription name already exists.

    " + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The supplied category does not exist.

    " + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The subscription name does not exist.

    " + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with \"aws:\" or \"rds:\". The string may only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + } + }, + "documentation":"

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    " + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "documentation":"

    A list of tags.

    " + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

    List of tags returned by the ListTagsForResource operation.

    " + } + }, + "documentation":"

    " + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

    The name of the VPC security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the VPC security group.

    " + } + }, + "documentation":"

    This data type is used as a response element for queries on VPC security group membership.

    " + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CopyDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CopyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + } + } +} diff --git a/aws/dist/botocore/data/rds/2014-09-01/waiters-2.json b/aws/dist/botocore/data/rds/2014-09-01/waiters-2.json new file mode 100644 index 00000000..b0150079 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-09-01/waiters-2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "deleted", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/rds/2014-10-31/examples-1.json b/aws/dist/botocore/data/rds/2014-10-31/examples-1.json new file mode 100644 index 00000000..4bb4a5a9 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-10-31/examples-1.json @@ -0,0 +1,1658 @@ +{ + "version": "1.0", + "examples": { + "AddSourceIdentifierToSubscription": [ + { + "input": { + "SourceIdentifier": "mymysqlinstance", + "SubscriptionName": "mymysqleventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example add a source identifier to an event notification subscription.", + "id": "add-source-identifier-to-subscription-93fb6a15-0a59-4577-a7b5-e12db9752c14", + "title": "To add a source identifier to an event notification subscription" + } + ], + "AddTagsToResource": [ + { + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup", + "Tags": [ + { + "Key": "Staging", + "Value": "LocationDB" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds a tag to an option group.", + "id": "add-tags-to-resource-fa99ef50-228b-449d-b893-ca4d4e9768ab", + "title": "To add tags to a resource" + } + ], + "ApplyPendingMaintenanceAction": [ + { + "input": { + "ApplyAction": "system-update", + "OptInType": "immediate", + "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example immediately applies a pending system update to a DB instance.", + "id": "apply-pending-maintenance-action-2a026047-8bbb-47fc-b695-abad9f308c24", + "title": "To apply a pending maintenance action" + } + ], + "AuthorizeDBSecurityGroupIngress": [ + { + "input": { + "CIDRIP": "203.0.113.5/32", + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example authorizes access to the specified security group by the specified CIDR block.", + "id": "authorize-db-security-group-ingress-ebf9ab91-8912-4b07-a32e-ca150668164f", + "title": "To authorize DB security group integress" + } + ], + "CopyDBClusterParameterGroup": [ + { + "input": { + "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup", + "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy", + "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a DB cluster parameter group.", + "id": "copy-db-cluster-parameter-group-6fefaffe-cde9-4dba-9f0b-d3f593572fe4", + "title": "To copy a DB cluster parameter group" + } + ], + "CopyDBClusterSnapshot": [ + { + "input": { + "SourceDBClusterSnapshotIdentifier": "rds:sample-cluster-2016-09-14-10-38", + "TargetDBClusterSnapshotIdentifier": "cluster-snapshot-copy-1" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.", + "id": "to-copy-a-db-cluster-snapshot-1473879770564", + "title": "To copy a DB cluster snapshot" + } + ], + "CopyDBParameterGroup": [ + { + "input": { + "SourceDBParameterGroupIdentifier": "mymysqlparametergroup", + "TargetDBParameterGroupDescription": "My MySQL parameter group copy", + "TargetDBParameterGroupIdentifier": "mymysqlparametergroup-copy" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a DB parameter group.", + "id": "copy-db-parameter-group-610d4dba-2c87-467f-ae5d-edd7f8e47349", + "title": "To copy a DB parameter group" + } + ], + "CopyDBSnapshot": [ + { + "input": { + "SourceDBSnapshotIdentifier": "mydbsnapshot", + "TargetDBSnapshotIdentifier": "mydbsnapshot-copy" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies a DB snapshot.", + "id": "copy-db-snapshot-1b2f0210-bc67-415d-9822-6eecf447dc86", + "title": "To copy a DB snapshot" + } + ], + "CopyOptionGroup": [ + { + "input": { + "SourceOptionGroupIdentifier": "mymysqloptiongroup", + "TargetOptionGroupDescription": "My MySQL option group copy", + "TargetOptionGroupIdentifier": "mymysqloptiongroup-copy" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example copies an option group.", + "id": "copy-option-group-8d5c01c3-8846-4e9c-a4b0-1b7237f7d0ec", + "title": "To copy an option group" + } + ], + "CreateDBCluster": [ + { + "input": { + "AvailabilityZones": [ + "us-east-1a" + ], + "BackupRetentionPeriod": 1, + "DBClusterIdentifier": "mydbcluster", + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DatabaseName": "myauroradb", + "Engine": "aurora", + "EngineVersion": "5.6.10a", + "MasterUserPassword": "mypassword", + "MasterUsername": "myuser", + "Port": 3306, + "StorageEncrypted": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB cluster.", + "id": "create-db-cluster-423b998d-eba9-40dd-8e19-96c5b6e5f31d", + "title": "To create a DB cluster" + } + ], + "CreateDBClusterParameterGroup": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "DBParameterGroupFamily": "aurora5.6", + "Description": "My DB cluster parameter group" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB cluster parameter group.", + "id": "create-db-cluster-parameter-group-8eb1c3ae-1965-4262-afe3-ee134c4430b1", + "title": "To create a DB cluster parameter group" + } + ], + "CreateDBClusterSnapshot": [ + { + "input": { + "DBClusterIdentifier": "mydbcluster", + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB cluster snapshot.", + "id": "create-db-cluster-snapshot-", + "title": "To create a DB cluster snapshot" + } + ], + "CreateDBInstance": [ + { + "input": { + "AllocatedStorage": 5, + "DBInstanceClass": "db.t2.micro", + "DBInstanceIdentifier": "mymysqlinstance", + "Engine": "MySQL", + "MasterUserPassword": "MyPassword", + "MasterUsername": "MyUser" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB instance.", + "id": "create-db-instance-57eb5d16-8bf8-4c84-9709-1700322b37b9", + "title": "To create a DB instance." + } + ], + "CreateDBInstanceReadReplica": [ + { + "input": { + "AvailabilityZone": "us-east-1a", + "CopyTagsToSnapshot": true, + "DBInstanceClass": "db.t2.micro", + "DBInstanceIdentifier": "mydbreadreplica", + "PubliclyAccessible": true, + "SourceDBInstanceIdentifier": "mymysqlinstance", + "StorageType": "gp2", + "Tags": [ + { + "Key": "mydbreadreplicakey", + "Value": "mydbreadreplicavalue" + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB instance read replica.", + "id": "create-db-instance-read-replica-81b41cd5-2871-4dae-bc59-3e264449d5fe", + "title": "To create a DB instance read replica." + } + ], + "CreateDBParameterGroup": [ + { + "input": { + "DBParameterGroupFamily": "mysql5.6", + "DBParameterGroupName": "mymysqlparametergroup", + "Description": "My MySQL parameter group" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB parameter group.", + "id": "create-db-parameter-group-42afcc37-12e9-4b6a-a55c-b8a141246e87", + "title": "To create a DB parameter group." + } + ], + "CreateDBSecurityGroup": [ + { + "input": { + "DBSecurityGroupDescription": "My DB security group", + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB security group.", + "id": "create-db-security-group-41b6786a-539e-42a5-a645-a8bc3cf99353", + "title": "To create a DB security group." + } + ], + "CreateDBSnapshot": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB snapshot.", + "id": "create-db-snapshot-e10e0e2c-9ac4-426d-9b17-6b6a3e382ce2", + "title": "To create a DB snapshot." + } + ], + "CreateDBSubnetGroup": [ + { + "input": { + "DBSubnetGroupDescription": "My DB subnet group", + "DBSubnetGroupName": "mydbsubnetgroup", + "SubnetIds": [ + "subnet-1fab8a69", + "subnet-d43a468c" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates a DB subnet group.", + "id": "create-db-subnet-group-c3d162c2-0ec4-4955-ba89-18967615fdb8", + "title": "To create a DB subnet group." + } + ], + "CreateEventSubscription": [ + { + "input": { + "Enabled": true, + "EventCategories": [ + "availability" + ], + "SnsTopicArn": "arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic", + "SourceIds": [ + "mymysqlinstance" + ], + "SourceType": "db-instance", + "SubscriptionName": "mymysqleventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an event notification subscription.", + "id": "create-event-subscription-00dd0ee6-0e0f-4a38-ae83-e5f2ded5f69a", + "title": "To create an event notification subscription" + } + ], + "CreateOptionGroup": [ + { + "input": { + "EngineName": "MySQL", + "MajorEngineVersion": "5.6", + "OptionGroupDescription": "My MySQL 5.6 option group", + "OptionGroupName": "mymysqloptiongroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example creates an option group.", + "id": "create-option-group-a7708c87-1b79-4a5e-a762-21cf8fc62b78", + "title": "To create an option group" + } + ], + "DeleteDBCluster": [ + { + "input": { + "DBClusterIdentifier": "mydbcluster", + "SkipFinalSnapshot": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB cluster.", + "id": "delete-db-cluster-927fc2c8-6c67-4075-b1ba-75490be0f7d6", + "title": "To delete a DB cluster." + } + ], + "DeleteDBClusterParameterGroup": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB cluster parameter group.", + "id": "delete-db-cluster-parameter-group-364f5555-ba0a-4cc8-979c-e769098924fc", + "title": "To delete a DB cluster parameter group." + } + ], + "DeleteDBClusterSnapshot": [ + { + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB cluster snapshot.", + "id": "delete-db-cluster-snapshot-c67e0d95-670e-4fb5-af90-6d9a70a91b07", + "title": "To delete a DB cluster snapshot." + } + ], + "DeleteDBInstance": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "SkipFinalSnapshot": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB instance.", + "id": "delete-db-instance-4412e650-949c-488a-b32a-7d3038ebccc4", + "title": "To delete a DB instance." + } + ], + "DeleteDBParameterGroup": [ + { + "input": { + "DBParameterGroupName": "mydbparamgroup3" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a DB parameter group.", + "id": "to-delete-a-db-parameter-group-1473888796509", + "title": "To delete a DB parameter group" + } + ], + "DeleteDBSecurityGroup": [ + { + "input": { + "DBSecurityGroupName": "mysecgroup" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a DB security group.", + "id": "to-delete-a-db-security-group-1473960141889", + "title": "To delete a DB security group" + } + ], + "DeleteDBSnapshot": [ + { + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB snapshot.", + "id": "delete-db-snapshot-505d6b4e-8ced-479c-856a-c460a33fe07b", + "title": "To delete a DB cluster snapshot." + } + ], + "DeleteDBSubnetGroup": [ + { + "input": { + "DBSubnetGroupName": "mydbsubnetgroup" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB subnetgroup.", + "id": "delete-db-subnet-group-4ae00375-511e-443d-a01d-4b9f552244aa", + "title": "To delete a DB subnet group." + } + ], + "DeleteEventSubscription": [ + { + "input": { + "SubscriptionName": "myeventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified DB event subscription.", + "id": "delete-db-event-subscription-d33567e3-1d5d-48ff-873f-0270453f4a75", + "title": "To delete a DB event subscription." + } + ], + "DeleteOptionGroup": [ + { + "input": { + "OptionGroupName": "mydboptiongroup" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified option group.", + "id": "delete-db-option-group-578be2be-3095-431a-9ea4-9a3c3b0daef4", + "title": "To delete an option group." + } + ], + "DescribeAccountAttributes": [ + { + "input": { + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists account attributes.", + "id": "describe-account-attributes-683d3ff7-5524-421a-8da5-e88f1ea2222b", + "title": "To list account attributes" + } + ], + "DescribeCertificates": [ + { + "input": { + "CertificateIdentifier": "rds-ca-2015", + "MaxRecords": 20 + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists up to 20 certificates for the specified certificate identifier.", + "id": "describe-certificates-9d71a70d-7908-4444-b43f-321d842c62dc", + "title": "To list certificates" + } + ], + "DescribeDBClusterParameterGroups": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified DB cluster parameter group.", + "id": "describe-db-cluster-parameter-groups-cf9c6e66-664e-4f57-8e29-a9080abfc013", + "title": "To list DB cluster parameter group settings" + } + ], + "DescribeDBClusterParameters": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "Source": "system" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists system parameters for the specified DB cluster parameter group.", + "id": "describe-db-cluster-parameters-98043c28-e489-41a7-b118-bfd96dc779a1", + "title": "To list DB cluster parameters" + } + ], + "DescribeDBClusterSnapshotAttributes": [ + { + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists attributes for the specified DB cluster snapshot.", + "id": "describe-db-cluster-snapshot-attributes-6752ade3-0c7b-4b06-a8e4-b76bf4e2d3571", + "title": "To list DB cluster snapshot attributes" + } + ], + "DescribeDBClusterSnapshots": [ + { + "input": { + "DBClusterSnapshotIdentifier": "mydbclustersnapshot", + "SnapshotType": "manual" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified, manually-created cluster snapshot.", + "id": "describe-db-cluster-snapshots-52f38af1-3431-4a51-9a6a-e6bb8c961b32", + "title": "To list DB cluster snapshots" + } + ], + "DescribeDBClusters": [ + { + "input": { + "DBClusterIdentifier": "mynewdbcluster" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified DB cluster.", + "id": "describe-db-clusters-7aae8861-cb95-4b3b-9042-f62df7698635", + "title": "To list DB clusters" + } + ], + "DescribeDBEngineVersions": [ + { + "input": { + "DBParameterGroupFamily": "mysql5.6", + "DefaultOnly": true, + "Engine": "mysql", + "EngineVersion": "5.6", + "ListSupportedCharacterSets": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified DB engine version.", + "id": "describe-db-engine-versions-8e698cf2-2162-425a-a854-111cdaceb52b", + "title": "To list DB engine version settings" + } + ], + "DescribeDBInstances": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified DB instance.", + "id": "describe-db-instances-0e11a8c5-4ec3-4463-8cbf-f7254d04c4fc", + "title": "To list DB instance settings" + } + ], + "DescribeDBLogFiles": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "FileLastWritten": 1470873600000, + "FileSize": 0, + "FilenameContains": "error" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.", + "id": "describe-db-log-files-5f002d8d-5c1d-44c2-b5f4-bd284c0f1285", + "title": "To list DB log file names" + } + ], + "DescribeDBParameterGroups": [ + { + "input": { + "DBParameterGroupName": "mymysqlparametergroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information about the specified DB parameter group.", + "id": "describe-db-parameter-groups-", + "title": "To list information about DB parameter groups" + } + ], + "DescribeDBParameters": [ + { + "input": { + "DBParameterGroupName": "mymysqlparametergroup", + "MaxRecords": 20, + "Source": "system" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for up to the first 20 system parameters for the specified DB parameter group.", + "id": "describe-db-parameters-09db4201-ef4f-4d97-a4b5-d71c0715b901", + "title": "To list information about DB parameters" + } + ], + "DescribeDBSecurityGroups": [ + { + "input": { + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists settings for the specified security group.", + "id": "describe-db-security-groups-66fe9ea1-17dd-4275-b82e-f771cee0c849", + "title": "To list DB security group settings" + } + ], + "DescribeDBSnapshotAttributes": [ + { + "input": { + "DBSnapshotIdentifier": "mydbsnapshot" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists attributes for the specified DB snapshot.", + "id": "describe-db-snapshot-attributes-1d4fb750-34f6-4e43-8b3d-b2751d796a95", + "title": "To list DB snapshot attributes" + } + ], + "DescribeDBSnapshots": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "IncludePublic": false, + "IncludeShared": true, + "SnapshotType": "manual" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all manually-created, shared snapshots for the specified DB instance.", + "id": "describe-db-snapshots-2c935989-a1ef-4c85-aea4-1d0f45f17f26", + "title": "To list DB snapshot attributes" + } + ], + "DescribeDBSubnetGroups": [ + { + "input": { + "DBSubnetGroupName": "mydbsubnetgroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information about the specified DB subnet group.", + "id": "describe-db-subnet-groups-1d97b340-682f-4dd6-9653-8ed72a8d1221", + "title": "To list information about DB subnet groups" + } + ], + "DescribeEngineDefaultClusterParameters": [ + { + "input": { + "DBParameterGroupFamily": "aurora5.6" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists default parameters for the specified DB cluster engine.", + "id": "describe-engine-default-cluster-parameters-f130374a-7bee-434b-b51d-da20b6e000e0", + "title": "To list default parameters for a DB cluster engine" + } + ], + "DescribeEngineDefaultParameters": [ + { + "input": { + "DBParameterGroupFamily": "mysql5.6" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists default parameters for the specified DB engine.", + "id": "describe-engine-default-parameters-35d5108e-1d44-4fac-8aeb-04b8fdfface1", + "title": "To list default parameters for a DB engine" + } + ], + "DescribeEventCategories": [ + { + "input": { + "SourceType": "db-instance" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists all DB instance event categories.", + "id": "describe-event-categories-97bd4c77-12da-4be6-b42f-edf77771428b", + "title": "To list event categories." + } + ], + "DescribeEventSubscriptions": [ + { + "input": { + "SubscriptionName": "mymysqleventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for the specified DB event notification subscription.", + "id": "describe-event-subscriptions-11184a82-e58a-4d0c-b558-f3a7489e0850", + "title": "To list information about DB event notification subscriptions" + } + ], + "DescribeEvents": [ + { + "input": { + "Duration": 10080, + "EventCategories": [ + "backup" + ], + "SourceIdentifier": "mymysqlinstance", + "SourceType": "db-instance" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).", + "id": "describe-events-3836e5ed-3913-4f76-8452-c77fcad5016b", + "title": "To list information about events" + } + ], + "DescribeOptionGroupOptions": [ + { + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "5.6" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all option group options for the specified DB engine.", + "id": "describe-option-group-options-30d735a4-81f1-49e4-b3f2-5dc45d50c8ed", + "title": "To list information about DB option group options" + } + ], + "DescribeOptionGroups": [ + { + "input": { + "EngineName": "mysql", + "MajorEngineVersion": "5.6" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all option groups for the specified DB engine.", + "id": "describe-option-groups-4ef478a1-66d5-45f2-bec3-e608720418a4", + "title": "To list information about DB option groups" + } + ], + "DescribeOrderableDBInstanceOptions": [ + { + "input": { + "DBInstanceClass": "db.t2.micro", + "Engine": "mysql", + "EngineVersion": "5.6.27", + "LicenseModel": "general-public-license", + "Vpc": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.", + "id": "describe-orderable-db-instance-options-7444d3ed-82eb-42b9-9ed9-896b8c27a782", + "title": "To list information about orderable DB instance options" + } + ], + "DescribePendingMaintenanceActions": [ + { + "input": { + "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all pending maintenance actions for the specified DB instance.", + "id": "describe-pending-maintenance-actions-e6021f7e-58ae-49cc-b874-11996176835c", + "title": "To list information about pending maintenance actions" + } + ], + "DescribeReservedDBInstances": [ + { + "input": { + "DBInstanceClass": "db.t2.micro", + "Duration": "1y", + "MultiAZ": false, + "OfferingType": "No Upfront", + "ProductDescription": "mysql" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.", + "id": "describe-reserved-db-instances-d45adaca-2e30-407c-a0f3-aa7b98bea17f", + "title": "To list information about reserved DB instances" + } + ], + "DescribeReservedDBInstancesOfferings": [ + { + "input": { + "DBInstanceClass": "db.t2.micro", + "Duration": "1y", + "MultiAZ": false, + "OfferingType": "No Upfront", + "ProductDescription": "mysql" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.", + "id": "describe-reserved-db-instances-offerings-9de7d1fd-d6a6-4a72-84ae-b2ef58d47d8d", + "title": "To list information about reserved DB instance offerings" + } + ], + "DescribeSourceRegions": [ + { + "input": { + }, + "output": { + "SourceRegions": [ + { + "Endpoint": "https://rds.ap-northeast-1.amazonaws.com", + "RegionName": "ap-northeast-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.ap-northeast-2.amazonaws.com", + "RegionName": "ap-northeast-2", + "Status": "available" + }, + { + "Endpoint": "https://rds.ap-south-1.amazonaws.com", + "RegionName": "ap-south-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.ap-southeast-1.amazonaws.com", + "RegionName": "ap-southeast-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.ap-southeast-2.amazonaws.com", + "RegionName": "ap-southeast-2", + "Status": "available" + }, + { + "Endpoint": "https://rds.eu-central-1.amazonaws.com", + "RegionName": "eu-central-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.eu-west-1.amazonaws.com", + "RegionName": "eu-west-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.sa-east-1.amazonaws.com", + "RegionName": "sa-east-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.us-west-1.amazonaws.com", + "RegionName": "us-west-1", + "Status": "available" + }, + { + "Endpoint": "https://rds.us-west-2.amazonaws.com", + "RegionName": "us-west-2", + "Status": "available" + } + ] + }, + "comments": { + }, + "description": "To list the AWS regions where a Read Replica can be created.", + "id": "to-describe-source-regions-1473457722410", + "title": "To describe source regions" + } + ], + "DownloadDBLogFilePortion": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "LogFileName": "mysqlUpgrade" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information for the specified log file for the specified DB instance.", + "id": "download-db-log-file-portion-54a82731-a441-4fc7-a010-8eccae6fa202", + "title": "To list information about DB log files" + } + ], + "FailoverDBCluster": [ + { + "input": { + "DBClusterIdentifier": "myaurorainstance-cluster", + "TargetDBInstanceIdentifier": "myaurorareplica" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example performs a failover for the specified DB cluster to the specified DB instance.", + "id": "failover-db-cluster-9e7f2f93-d98c-42c7-bb0e-d6c485c096d6", + "title": "To perform a failover for a DB cluster" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example lists information about all tags associated with the specified DB option group.", + "id": "list-tags-for-resource-8401f3c2-77cd-4f90-bfd5-b523f0adcc2f", + "title": "To list information about tags associated with a resource" + } + ], + "ModifyDBCluster": [ + { + "input": { + "ApplyImmediately": true, + "DBClusterIdentifier": "mydbcluster", + "MasterUserPassword": "mynewpassword", + "NewDBClusterIdentifier": "mynewdbcluster", + "PreferredBackupWindow": "04:00-04:30", + "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the specified settings for the specified DB cluster.", + "id": "modify-db-cluster-a370ee1b-768d-450a-853b-707cb1ab663d", + "title": "To change DB cluster settings" + } + ], + "ModifyDBClusterParameterGroup": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "Parameters": [ + { + "ApplyMethod": "immediate", + "ParameterName": "time_zone", + "ParameterValue": "America/Phoenix" + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example immediately changes the specified setting for the specified DB cluster parameter group.", + "id": "modify-db-cluster-parameter-group-f9156bc9-082a-442e-8d12-239542c1a113", + "title": "To change DB cluster parameter group settings" + } + ], + "ModifyDBClusterSnapshotAttribute": [ + { + "input": { + "AttributeName": "restore", + "DBClusterSnapshotIdentifier": "manual-cluster-snapshot1", + "ValuesToAdd": [ + "123451234512", + "123456789012" + ], + "ValuesToRemove": [ + "all" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value \"all\".", + "id": "to-add-or-remove-access-to-a-manual-db-cluster-snapshot-1473889426431", + "title": "To add or remove access to a manual DB cluster snapshot" + } + ], + "ModifyDBInstance": [ + { + "input": { + "AllocatedStorage": 10, + "ApplyImmediately": true, + "BackupRetentionPeriod": 1, + "DBInstanceClass": "db.t2.small", + "DBInstanceIdentifier": "mymysqlinstance", + "MasterUserPassword": "mynewpassword", + "PreferredBackupWindow": "04:00-04:30", + "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example immediately changes the specified settings for the specified DB instance.", + "id": "modify-db-instance-6979a368-6254-467b-8a8d-61103f4fcde9", + "title": "To change DB instance settings" + } + ], + "ModifyDBParameterGroup": [ + { + "input": { + "DBParameterGroupName": "mymysqlparametergroup", + "Parameters": [ + { + "ApplyMethod": "immediate", + "ParameterName": "time_zone", + "ParameterValue": "America/Phoenix" + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example immediately changes the specified setting for the specified DB parameter group.", + "id": "modify-db-parameter-group-f3a4e52a-68e4-4b88-b559-f912d34c457a", + "title": "To change DB parameter group settings" + } + ], + "ModifyDBSnapshotAttribute": [ + { + "input": { + "AttributeName": "restore", + "DBSnapshotIdentifier": "mydbsnapshot", + "ValuesToAdd": [ + "all" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example adds the specified attribute for the specified DB snapshot.", + "id": "modify-db-snapshot-attribute-2e66f120-2b21-4a7c-890b-4474da88bde6", + "title": "To change DB snapshot attributes" + } + ], + "ModifyDBSubnetGroup": [ + { + "input": { + "DBSubnetGroupName": "mydbsubnetgroup", + "SubnetIds": [ + "subnet-70e1975a", + "subnet-747a5c49" + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the specified setting for the specified DB subnet group.", + "id": "modify-db-subnet-group-e34a97d9-8fe6-4239-a4ed-ad6e73a956b0", + "title": "To change DB subnet group settings" + } + ], + "ModifyEventSubscription": [ + { + "input": { + "Enabled": true, + "EventCategories": [ + "deletion", + "low storage" + ], + "SourceType": "db-instance", + "SubscriptionName": "mymysqleventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example changes the specified setting for the specified event notification subscription.", + "id": "modify-event-subscription-405ac869-1f02-42cd-b8f4-6950a435f30e", + "title": "To change event notification subscription settings" + } + ], + "ModifyOptionGroup": [ + { + "input": { + "ApplyImmediately": true, + "OptionGroupName": "myawsuser-og02", + "OptionsToInclude": [ + { + "DBSecurityGroupMemberships": [ + "default" + ], + "OptionName": "MEMCACHED" + } + ] + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds an option to an option group.", + "id": "to-modify-an-option-group-1473890247875", + "title": "To modify an option group" + } + ], + "PromoteReadReplica": [ + { + "input": { + "BackupRetentionPeriod": 1, + "DBInstanceIdentifier": "mydbreadreplica", + "PreferredBackupWindow": "03:30-04:00" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example promotes the specified read replica and sets its backup retention period and preferred backup window.", + "id": "promote-read-replica-cc580039-c55d-4035-838a-def4a1ae4181", + "title": "To promote a read replica" + } + ], + "PurchaseReservedDBInstancesOffering": [ + { + "input": { + "ReservedDBInstanceId": "myreservationid", + "ReservedDBInstancesOfferingId": "fb29428a-646d-4390-850e-5fe89926e727" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example purchases a reserved DB instance offering that matches the specified settings.", + "id": "purchase-reserved-db-instances-offfering-f423c736-8413-429b-ba13-850fd4fa4dcd", + "title": "To purchase a reserved DB instance offering" + } + ], + "RebootDBInstance": [ + { + "input": { + "DBInstanceIdentifier": "mymysqlinstance", + "ForceFailover": false + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example reboots the specified DB instance without forcing a failover.", + "id": "reboot-db-instance-b9ce8a0a-2920-451d-a1f3-01d288aa7366", + "title": "To reboot a DB instance" + } + ], + "RemoveSourceIdentifierFromSubscription": [ + { + "input": { + "SourceIdentifier": "mymysqlinstance", + "SubscriptionName": "myeventsubscription" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified source identifier from the specified DB event subscription.", + "id": "remove-source-identifier-from-subscription-30d25493-c19d-4cf7-b4e5-68371d0d8770", + "title": "To remove a source identifier from a DB event subscription" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mydboptiongroup", + "TagKeys": [ + "MyKey" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example removes the specified tag associated with the specified DB option group.", + "id": "remove-tags-from-resource-49f00574-38f6-4d01-ac89-d3c668449ce3", + "title": "To remove tags from a resource" + } + ], + "ResetDBClusterParameterGroup": [ + { + "input": { + "DBClusterParameterGroupName": "mydbclusterparametergroup", + "ResetAllParameters": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets all parameters for the specified DB cluster parameter group to their default values.", + "id": "reset-db-cluster-parameter-group-b04aeaf7-7f73-49e1-9bb4-857573ea3ee4", + "title": "To reset the values of a DB cluster parameter group" + } + ], + "ResetDBParameterGroup": [ + { + "input": { + "DBParameterGroupName": "mydbparametergroup", + "ResetAllParameters": true + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example resets all parameters for the specified DB parameter group to their default values.", + "id": "reset-db-parameter-group-ed2ed723-de0d-4824-8af5-3c65fa130abf", + "title": "To reset the values of a DB parameter group" + } + ], + "RestoreDBClusterFromSnapshot": [ + { + "input": { + "DBClusterIdentifier": "restored-cluster1", + "Engine": "aurora", + "SnapshotIdentifier": "sample-cluster-snapshot1" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.", + "id": "to-restore-an-amazon-aurora-db-cluster-from-a-db-cluster-snapshot-1473958144325", + "title": "To restore an Amazon Aurora DB cluster from a DB cluster snapshot" + } + ], + "RestoreDBClusterToPointInTime": [ + { + "input": { + "DBClusterIdentifier": "sample-restored-cluster1", + "RestoreToTime": "2016-09-13T18:45:00Z", + "SourceDBClusterIdentifier": "sample-cluster1" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.", + "id": "to-restore-a-db-cluster-to-a-point-in-time-1473962082214", + "title": "To restore a DB cluster to a point in time." + } + ], + "RevokeDBSecurityGroupIngress": [ + { + "input": { + "CIDRIP": "203.0.113.5/32", + "DBSecurityGroupName": "mydbsecuritygroup" + }, + "output": { + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example revokes ingress for the specified CIDR block associated with the specified DB security group.", + "id": "revoke-db-security-group-ingress-ce5b2c1c-bd4e-4809-b04a-6d78ec448813", + "title": "To revoke ingress for a DB security group" + } + ] + } +} diff --git a/aws/dist/botocore/data/rds/2014-10-31/paginators-1.json b/aws/dist/botocore/data/rds/2014-10-31/paginators-1.json new file mode 100644 index 00000000..fac3dbc3 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-10-31/paginators-1.json @@ -0,0 +1,191 @@ +{ + "pagination": { + "DescribeCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Certificates" + }, + "DescribeDBClusterBacktracks": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBClusterBacktracks" + }, + "DescribeDBClusterParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBClusterParameterGroups" + }, + "DescribeDBClusterParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBClusterSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBClusterSnapshots" + }, + "DescribeDBClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusters" + }, + "DescribeDBEngineVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBEngineVersions" + }, + "DescribeDBInstanceAutomatedBackups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBInstanceAutomatedBackups" + }, + "DescribeDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBInstances" + }, + "DescribeDBLogFiles": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DescribeDBLogFiles" + }, + "DescribeDBParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBParameterGroups" + }, + "DescribeDBParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeDBSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSecurityGroups" + }, + "DescribeDBSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSnapshots" + }, + "DescribeDBSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "DBSubnetGroups" + }, + "DescribeEngineDefaultClusterParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEngineDefaultParameters": { + "input_token": "Marker", + "output_token": "EngineDefaults.Marker", + "limit_key": "MaxRecords", + "result_key": "EngineDefaults.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeGlobalClusters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "GlobalClusters" + }, + "DescribeOptionGroupOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupOptions" + }, + "DescribeOptionGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OptionGroupsList" + }, + "DescribeOrderableDBInstanceOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableDBInstanceOptions" + }, + "DescribePendingMaintenanceActions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "PendingMaintenanceActions" + }, + "DescribeReservedDBInstances": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstances" + }, + "DescribeReservedDBInstancesOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedDBInstancesOfferings" + }, + "DescribeSourceRegions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "SourceRegions" + }, + "DownloadDBLogFilePortion": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "NumberOfLines", + "more_results": "AdditionalDataPending", + "result_key": "LogFileData" + }, + "DescribeDBClusterEndpoints": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterEndpoints" + }, + "DescribeCustomAvailabilityZones": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "CustomAvailabilityZones" + }, + "DescribeInstallationMedia": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "InstallationMedia" + } + } +} diff --git a/aws/dist/botocore/data/rds/2014-10-31/service-2.json b/aws/dist/botocore/data/rds/2014-10-31/service-2.json new file mode 100644 index 00000000..a602d6f5 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-10-31/service-2.json @@ -0,0 +1,11250 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-10-31", + "endpointPrefix":"rds", + "protocol":"query", + "serviceAbbreviation":"Amazon RDS", + "serviceFullName":"Amazon Relational Database Service", + "serviceId":"RDS", + "signatureVersion":"v4", + "uid":"rds-2014-10-31", + "xmlNamespace":"http://rds.amazonaws.com/doc/2014-10-31/" + }, + "operations":{ + "AddRoleToDBCluster":{ + "name":"AddRoleToDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToDBClusterMessage"}, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterRoleAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterRoleQuotaExceededFault"} + ], + "documentation":"

    Associates an Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "AddRoleToDBInstance":{ + "name":"AddRoleToDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddRoleToDBInstanceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBInstanceRoleAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceRoleQuotaExceededFault"} + ], + "documentation":"

    Associates an AWS Identity and Access Management (IAM) role with a DB instance.

    To add a role to a DB instance, the status of the DB instance must be available.

    " + }, + "AddSourceIdentifierToSubscription":{ + "name":"AddSourceIdentifierToSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddSourceIdentifierToSubscriptionMessage"}, + "output":{ + "shape":"AddSourceIdentifierToSubscriptionResult", + "resultWrapper":"AddSourceIdentifierToSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

    Adds a source identifier to an existing RDS event notification subscription.

    " + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.

    For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources.

    " + }, + "ApplyPendingMaintenanceAction":{ + "name":"ApplyPendingMaintenanceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ApplyPendingMaintenanceActionMessage"}, + "output":{ + "shape":"ApplyPendingMaintenanceActionResult", + "resultWrapper":"ApplyPendingMaintenanceActionResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Applies a pending maintenance action to a resource (for example, to a DB instance).

    " + }, + "AuthorizeDBSecurityGroupIngress":{ + "name":"AuthorizeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeDBSecurityGroupIngressResult", + "resultWrapper":"AuthorizeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ], + "documentation":"

    Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).

    You can't authorize ingress from an EC2 security group in one AWS Region to an Amazon RDS DB instance in another. You can't authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.

    For an overview of CIDR ranges, go to the Wikipedia Tutorial.

    " + }, + "BacktrackDBCluster":{ + "name":"BacktrackDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BacktrackDBClusterMessage"}, + "output":{ + "shape":"DBClusterBacktrack", + "resultWrapper":"BacktrackDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

    Backtracks a DB cluster to a specific time, without creating a new DB cluster.

    For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "CopyDBClusterParameterGroup":{ + "name":"CopyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CopyDBClusterParameterGroupResult", + "resultWrapper":"CopyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

    Copies the specified DB cluster parameter group.

    This action only applies to Aurora DB clusters.

    " + }, + "CopyDBClusterSnapshot":{ + "name":"CopyDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBClusterSnapshotMessage"}, + "output":{ + "shape":"CopyDBClusterSnapshotResult", + "resultWrapper":"CopyDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Copies a snapshot of a DB cluster.

    To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

    You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values:

    • KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region.

    • PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied.

      The pre-signed URL request must contain the following parameter values:

      • KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

      • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

      • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

      To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

      If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

    • TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.

    To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in \"copying\" status.

    For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "CopyDBParameterGroup":{ + "name":"CopyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBParameterGroupMessage"}, + "output":{ + "shape":"CopyDBParameterGroupResult", + "resultWrapper":"CopyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"}, + {"shape":"DBParameterGroupQuotaExceededFault"} + ], + "documentation":"

    Copies the specified DB parameter group.

    " + }, + "CopyDBSnapshot":{ + "name":"CopyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyDBSnapshotMessage"}, + "output":{ + "shape":"CopyDBSnapshotResult", + "resultWrapper":"CopyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Copies the specified DB snapshot. The source DB snapshot must be in the \"available\" state.

    You can copy a snapshot from one AWS Region to another. In that case, the AWS Region where you call the CopyDBSnapshot action is the destination AWS Region for the DB snapshot copy.

    For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

    " + }, + "CopyOptionGroup":{ + "name":"CopyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyOptionGroupMessage"}, + "output":{ + "shape":"CopyOptionGroupResult", + "resultWrapper":"CopyOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ], + "documentation":"

    Copies the specified option group.

    " + }, + "CreateCustomAvailabilityZone":{ + "name":"CreateCustomAvailabilityZone", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomAvailabilityZoneMessage"}, + "output":{ + "shape":"CreateCustomAvailabilityZoneResult", + "resultWrapper":"CreateCustomAvailabilityZoneResult" + }, + "errors":[ + {"shape":"CustomAvailabilityZoneAlreadyExistsFault"}, + {"shape":"CustomAvailabilityZoneQuotaExceededFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Creates a custom Availability Zone (AZ).

    A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    " + }, + "CreateDBCluster":{ + "name":"CreateDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterMessage"}, + "output":{ + "shape":"CreateDBClusterResult", + "resultWrapper":"CreateDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"GlobalClusterNotFoundFault"}, + {"shape":"InvalidGlobalClusterStateFault"}, + {"shape":"DomainNotFoundFault"} + ], + "documentation":"

    Creates a new Amazon Aurora DB cluster.

    You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "CreateDBClusterEndpoint":{ + "name":"CreateDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterEndpointMessage"}, + "output":{ + "shape":"DBClusterEndpoint", + "resultWrapper":"CreateDBClusterEndpointResult" + }, + "errors":[ + {"shape":"DBClusterEndpointQuotaExceededFault"}, + {"shape":"DBClusterEndpointAlreadyExistsFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

    " + }, + "CreateDBClusterParameterGroup":{ + "name":"CreateDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateDBClusterParameterGroupResult", + "resultWrapper":"CreateDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

    Creates a new DB cluster parameter group.

    Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.

    A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "CreateDBClusterSnapshot":{ + "name":"CreateDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBClusterSnapshotMessage"}, + "output":{ + "shape":"CreateDBClusterSnapshotResult", + "resultWrapper":"CreateDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

    Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "CreateDBInstance":{ + "name":"CreateDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceMessage"}, + "output":{ + "shape":"CreateDBInstanceResult", + "resultWrapper":"CreateDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"BackupPolicyNotFoundFault"} + ], + "documentation":"

    Creates a new DB instance.

    " + }, + "CreateDBInstanceReadReplica":{ + "name":"CreateDBInstanceReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBInstanceReadReplicaMessage"}, + "output":{ + "shape":"CreateDBInstanceReadReplicaResult", + "resultWrapper":"CreateDBInstanceReadReplicaResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBSubnetGroupNotAllowedFault"}, + {"shape":"InvalidDBSubnetGroupFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DomainNotFoundFault"} + ], + "documentation":"

    Creates a new DB instance that acts as a Read Replica for an existing source DB instance. You can create a Read Replica for a DB instance running MySQL, MariaDB, Oracle, or PostgreSQL. For more information, see Working with Read Replicas in the Amazon RDS User Guide.

    Amazon Aurora doesn't support this action. You must call the CreateDBInstance action to create a DB instance for an Aurora DB cluster.

    All Read Replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified following.

    Your source DB instance must have backup retention enabled.

    " + }, + "CreateDBParameterGroup":{ + "name":"CreateDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBParameterGroupMessage"}, + "output":{ + "shape":"CreateDBParameterGroupResult", + "resultWrapper":"CreateDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupQuotaExceededFault"}, + {"shape":"DBParameterGroupAlreadyExistsFault"} + ], + "documentation":"

    Creates a new DB parameter group.

    A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

    After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    " + }, + "CreateDBSecurityGroup":{ + "name":"CreateDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSecurityGroupMessage"}, + "output":{ + "shape":"CreateDBSecurityGroupResult", + "resultWrapper":"CreateDBSecurityGroupResult" + }, + "errors":[ + {"shape":"DBSecurityGroupAlreadyExistsFault"}, + {"shape":"DBSecurityGroupQuotaExceededFault"}, + {"shape":"DBSecurityGroupNotSupportedFault"} + ], + "documentation":"

    Creates a new DB security group. DB security groups control access to a DB instance.

    A DB security group controls access to EC2-Classic DB instances that are not in a VPC.

    " + }, + "CreateDBSnapshot":{ + "name":"CreateDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSnapshotMessage"}, + "output":{ + "shape":"CreateDBSnapshotResult", + "resultWrapper":"CreateDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"SnapshotQuotaExceededFault"} + ], + "documentation":"

    Creates a DBSnapshot. The source DBInstance must be in \"available\" state.

    " + }, + "CreateDBSubnetGroup":{ + "name":"CreateDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDBSubnetGroupMessage"}, + "output":{ + "shape":"CreateDBSubnetGroupResult", + "resultWrapper":"CreateDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupAlreadyExistsFault"}, + {"shape":"DBSubnetGroupQuotaExceededFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

    Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

    " + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

    Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

    If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all RDS sources belonging to your customer account.

    " + }, + "CreateGlobalCluster":{ + "name":"CreateGlobalCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGlobalClusterMessage"}, + "output":{ + "shape":"CreateGlobalClusterResult", + "resultWrapper":"CreateGlobalClusterResult" + }, + "errors":[ + {"shape":"GlobalClusterAlreadyExistsFault"}, + {"shape":"GlobalClusterQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Creates an Aurora global database spread across multiple regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.

    You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.

    This action only applies to Aurora DB clusters.

    " + }, + "CreateOptionGroup":{ + "name":"CreateOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOptionGroupMessage"}, + "output":{ + "shape":"CreateOptionGroupResult", + "resultWrapper":"CreateOptionGroupResult" + }, + "errors":[ + {"shape":"OptionGroupAlreadyExistsFault"}, + {"shape":"OptionGroupQuotaExceededFault"} + ], + "documentation":"

    Creates a new option group. You can create up to 20 option groups.

    " + }, + "DeleteCustomAvailabilityZone":{ + "name":"DeleteCustomAvailabilityZone", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomAvailabilityZoneMessage"}, + "output":{ + "shape":"DeleteCustomAvailabilityZoneResult", + "resultWrapper":"DeleteCustomAvailabilityZoneResult" + }, + "errors":[ + {"shape":"CustomAvailabilityZoneNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Deletes a custom Availability Zone (AZ).

    A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    " + }, + "DeleteDBCluster":{ + "name":"DeleteDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterMessage"}, + "output":{ + "shape":"DeleteDBClusterResult", + "resultWrapper":"DeleteDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBClusterSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"} + ], + "documentation":"

    The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DeleteDBClusterEndpoint":{ + "name":"DeleteDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterEndpointMessage"}, + "output":{ + "shape":"DBClusterEndpoint", + "resultWrapper":"DeleteDBClusterEndpointResult" + }, + "errors":[ + {"shape":"InvalidDBClusterEndpointStateFault"}, + {"shape":"DBClusterEndpointNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

    Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

    " + }, + "DeleteDBClusterParameterGroup":{ + "name":"DeleteDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DeleteDBClusterSnapshot":{ + "name":"DeleteDBClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteDBClusterSnapshotResult", + "resultWrapper":"DeleteDBClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

    Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

    The DB cluster snapshot must be in the available state to be deleted.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DeleteDBInstance":{ + "name":"DeleteDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceMessage"}, + "output":{ + "shape":"DeleteDBInstanceResult", + "resultWrapper":"DeleteDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"DBInstanceAutomatedBackupQuotaExceededFault"} + ], + "documentation":"

    The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

    If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

    Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

    If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

    • The DB cluster is a Read Replica of another Amazon Aurora DB cluster.

    • The DB instance is the only instance in the DB cluster.

    To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

    " + }, + "DeleteDBInstanceAutomatedBackup":{ + "name":"DeleteDBInstanceAutomatedBackup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBInstanceAutomatedBackupMessage"}, + "output":{ + "shape":"DeleteDBInstanceAutomatedBackupResult", + "resultWrapper":"DeleteDBInstanceAutomatedBackupResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceAutomatedBackupStateFault"}, + {"shape":"DBInstanceAutomatedBackupNotFoundFault"} + ], + "documentation":"

    Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.

    " + }, + "DeleteDBParameterGroup":{ + "name":"DeleteDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

    " + }, + "DeleteDBSecurityGroup":{ + "name":"DeleteDBSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBSecurityGroupNotFoundFault"} + ], + "documentation":"

    Deletes a DB security group.

    The specified DB security group must not be associated with any DB instances.

    " + }, + "DeleteDBSnapshot":{ + "name":"DeleteDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSnapshotMessage"}, + "output":{ + "shape":"DeleteDBSnapshotResult", + "resultWrapper":"DeleteDBSnapshotResult" + }, + "errors":[ + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"DBSnapshotNotFoundFault"} + ], + "documentation":"

    Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.

    The DB snapshot must be in the available state to be deleted.

    " + }, + "DeleteDBSubnetGroup":{ + "name":"DeleteDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDBSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidDBSubnetStateFault"}, + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

    Deletes a DB subnet group.

    The specified database subnet group must not be associated with any DB instances.

    " + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "output":{ + "shape":"DeleteEventSubscriptionResult", + "resultWrapper":"DeleteEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidEventSubscriptionStateFault"} + ], + "documentation":"

    Deletes an RDS event notification subscription.

    " + }, + "DeleteGlobalCluster":{ + "name":"DeleteGlobalCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGlobalClusterMessage"}, + "output":{ + "shape":"DeleteGlobalClusterResult", + "resultWrapper":"DeleteGlobalClusterResult" + }, + "errors":[ + {"shape":"GlobalClusterNotFoundFault"}, + {"shape":"InvalidGlobalClusterStateFault"} + ], + "documentation":"

    Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.

    This action only applies to Aurora DB clusters.

    " + }, + "DeleteInstallationMedia":{ + "name":"DeleteInstallationMedia", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInstallationMediaMessage"}, + "output":{ + "shape":"InstallationMedia", + "resultWrapper":"DeleteInstallationMediaResult" + }, + "errors":[ + {"shape":"InstallationMediaNotFoundFault"} + ], + "documentation":"

    Deletes the installation medium for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    " + }, + "DeleteOptionGroup":{ + "name":"DeleteOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteOptionGroupMessage"}, + "errors":[ + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"InvalidOptionGroupStateFault"} + ], + "documentation":"

    Deletes an existing option group.

    " + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesMessage"}, + "output":{ + "shape":"AccountAttributesMessage", + "resultWrapper":"DescribeAccountAttributesResult" + }, + "documentation":"

    Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.

    This command doesn't take any parameters.

    " + }, + "DescribeCertificates":{ + "name":"DescribeCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCertificatesMessage"}, + "output":{ + "shape":"CertificateMessage", + "resultWrapper":"DescribeCertificatesResult" + }, + "errors":[ + {"shape":"CertificateNotFoundFault"} + ], + "documentation":"

    Lists the set of CA certificates provided by Amazon RDS for this AWS account.

    " + }, + "DescribeCustomAvailabilityZones":{ + "name":"DescribeCustomAvailabilityZones", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCustomAvailabilityZonesMessage"}, + "output":{ + "shape":"CustomAvailabilityZoneMessage", + "resultWrapper":"DescribeCustomAvailabilityZonesResult" + }, + "errors":[ + {"shape":"CustomAvailabilityZoneNotFoundFault"} + ], + "documentation":"

    Returns information about custom Availability Zones (AZs).

    A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    " + }, + "DescribeDBClusterBacktracks":{ + "name":"DescribeDBClusterBacktracks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterBacktracksMessage"}, + "output":{ + "shape":"DBClusterBacktrackMessage", + "resultWrapper":"DescribeDBClusterBacktracksResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterBacktrackNotFoundFault"} + ], + "documentation":"

    Returns information about backtracks for a DB cluster.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusterEndpoints":{ + "name":"DescribeDBClusterEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterEndpointsMessage"}, + "output":{ + "shape":"DBClusterEndpointMessage", + "resultWrapper":"DescribeDBClusterEndpointsResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Returns information about endpoints for an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusterParameterGroups":{ + "name":"DescribeDBClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParameterGroupsMessage"}, + "output":{ + "shape":"DBClusterParameterGroupsMessage", + "resultWrapper":"DescribeDBClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusterParameters":{ + "name":"DescribeDBClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterParametersMessage"}, + "output":{ + "shape":"DBClusterParameterGroupDetails", + "resultWrapper":"DescribeDBClusterParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Returns the detailed parameter list for a particular DB cluster parameter group.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusterSnapshotAttributes":{ + "name":"DescribeDBClusterSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBClusterSnapshotAttributesResult", + "resultWrapper":"DescribeDBClusterSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

    Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.

    When sharing snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or restored by all AWS accounts.

    To add or remove access for an AWS account to copy or restore a manual DB cluster snapshot, or to make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API action.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusterSnapshots":{ + "name":"DescribeDBClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClusterSnapshotsMessage"}, + "output":{ + "shape":"DBClusterSnapshotMessage", + "resultWrapper":"DescribeDBClusterSnapshotsResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"} + ], + "documentation":"

    Returns information about DB cluster snapshots. This API action supports pagination.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBClusters":{ + "name":"DescribeDBClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBClustersMessage"}, + "output":{ + "shape":"DBClusterMessage", + "resultWrapper":"DescribeDBClustersResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Returns information about provisioned Aurora DB clusters. This API supports pagination.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeDBEngineVersions":{ + "name":"DescribeDBEngineVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBEngineVersionsMessage"}, + "output":{ + "shape":"DBEngineVersionMessage", + "resultWrapper":"DescribeDBEngineVersionsResult" + }, + "documentation":"

    Returns a list of the available DB engines.

    " + }, + "DescribeDBInstanceAutomatedBackups":{ + "name":"DescribeDBInstanceAutomatedBackups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstanceAutomatedBackupsMessage"}, + "output":{ + "shape":"DBInstanceAutomatedBackupMessage", + "resultWrapper":"DescribeDBInstanceAutomatedBackupsResult" + }, + "errors":[ + {"shape":"DBInstanceAutomatedBackupNotFoundFault"} + ], + "documentation":"

    Displays backups for both current and deleted instances. For example, use this operation to find details about automated backups for previously deleted instances. Current instances with retention periods greater than zero (0) are returned for both the DescribeDBInstanceAutomatedBackups and DescribeDBInstances operations.

    All parameters are optional.

    " + }, + "DescribeDBInstances":{ + "name":"DescribeDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBInstancesMessage"}, + "output":{ + "shape":"DBInstanceMessage", + "resultWrapper":"DescribeDBInstancesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

    Returns information about provisioned RDS instances. This API supports pagination.

    " + }, + "DescribeDBLogFiles":{ + "name":"DescribeDBLogFiles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBLogFilesMessage"}, + "output":{ + "shape":"DescribeDBLogFilesResponse", + "resultWrapper":"DescribeDBLogFilesResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

    Returns a list of DB log files for the DB instance.

    " + }, + "DescribeDBParameterGroups":{ + "name":"DescribeDBParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParameterGroupsMessage"}, + "output":{ + "shape":"DBParameterGroupsMessage", + "resultWrapper":"DescribeDBParameterGroupsResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

    " + }, + "DescribeDBParameters":{ + "name":"DescribeDBParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBParametersMessage"}, + "output":{ + "shape":"DBParameterGroupDetails", + "resultWrapper":"DescribeDBParametersResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Returns the detailed parameter list for a particular DB parameter group.

    " + }, + "DescribeDBSecurityGroups":{ + "name":"DescribeDBSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSecurityGroupsMessage"}, + "output":{ + "shape":"DBSecurityGroupMessage", + "resultWrapper":"DescribeDBSecurityGroupsResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"} + ], + "documentation":"

    Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DB security group.

    " + }, + "DescribeDBSnapshotAttributes":{ + "name":"DescribeDBSnapshotAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotAttributesMessage"}, + "output":{ + "shape":"DescribeDBSnapshotAttributesResult", + "resultWrapper":"DescribeDBSnapshotAttributesResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ], + "documentation":"

    Returns a list of DB snapshot attribute names and values for a manual DB snapshot.

    When sharing snapshots with other AWS accounts, DescribeDBSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual DB snapshot. If all is included in the list of values for the restore attribute, then the manual DB snapshot is public and can be copied or restored by all AWS accounts.

    To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.

    " + }, + "DescribeDBSnapshots":{ + "name":"DescribeDBSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSnapshotsMessage"}, + "output":{ + "shape":"DBSnapshotMessage", + "resultWrapper":"DescribeDBSnapshotsResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ], + "documentation":"

    Returns information about DB snapshots. This API action supports pagination.

    " + }, + "DescribeDBSubnetGroups":{ + "name":"DescribeDBSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDBSubnetGroupsMessage"}, + "output":{ + "shape":"DBSubnetGroupMessage", + "resultWrapper":"DescribeDBSubnetGroupsResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"} + ], + "documentation":"

    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

    For an overview of CIDR ranges, go to the Wikipedia Tutorial.

    " + }, + "DescribeEngineDefaultClusterParameters":{ + "name":"DescribeEngineDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultClusterParametersResult", + "resultWrapper":"DescribeEngineDefaultClusterParametersResult" + }, + "documentation":"

    Returns the default engine and system parameter information for the cluster database engine.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    " + }, + "DescribeEngineDefaultParameters":{ + "name":"DescribeEngineDefaultParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEngineDefaultParametersMessage"}, + "output":{ + "shape":"DescribeEngineDefaultParametersResult", + "resultWrapper":"DescribeEngineDefaultParametersResult" + }, + "documentation":"

    Returns the default engine and system parameter information for the specified database engine.

    " + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

    Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.

    " + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"} + ], + "documentation":"

    Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

    If you specify a SubscriptionName, lists the description for that subscription.

    " + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

    Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

    " + }, + "DescribeGlobalClusters":{ + "name":"DescribeGlobalClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGlobalClustersMessage"}, + "output":{ + "shape":"GlobalClustersMessage", + "resultWrapper":"DescribeGlobalClustersResult" + }, + "errors":[ + {"shape":"GlobalClusterNotFoundFault"} + ], + "documentation":"

    Returns information about Aurora global database clusters. This API supports pagination.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "DescribeInstallationMedia":{ + "name":"DescribeInstallationMedia", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstallationMediaMessage"}, + "output":{ + "shape":"InstallationMediaMessage", + "resultWrapper":"DescribeInstallationMediaResult" + }, + "errors":[ + {"shape":"InstallationMediaNotFoundFault"} + ], + "documentation":"

    Describes the available installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    " + }, + "DescribeOptionGroupOptions":{ + "name":"DescribeOptionGroupOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupOptionsMessage"}, + "output":{ + "shape":"OptionGroupOptionsMessage", + "resultWrapper":"DescribeOptionGroupOptionsResult" + }, + "documentation":"

    Describes all available options.

    " + }, + "DescribeOptionGroups":{ + "name":"DescribeOptionGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOptionGroupsMessage"}, + "output":{ + "shape":"OptionGroups", + "resultWrapper":"DescribeOptionGroupsResult" + }, + "errors":[ + {"shape":"OptionGroupNotFoundFault"} + ], + "documentation":"

    Describes the available option groups.

    " + }, + "DescribeOrderableDBInstanceOptions":{ + "name":"DescribeOrderableDBInstanceOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableDBInstanceOptionsMessage"}, + "output":{ + "shape":"OrderableDBInstanceOptionsMessage", + "resultWrapper":"DescribeOrderableDBInstanceOptionsResult" + }, + "documentation":"

    Returns a list of orderable DB instance options for the specified engine.

    " + }, + "DescribePendingMaintenanceActions":{ + "name":"DescribePendingMaintenanceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePendingMaintenanceActionsMessage"}, + "output":{ + "shape":"PendingMaintenanceActionsMessage", + "resultWrapper":"DescribePendingMaintenanceActionsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"} + ], + "documentation":"

    Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.

    " + }, + "DescribeReservedDBInstances":{ + "name":"DescribeReservedDBInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesMessage"}, + "output":{ + "shape":"ReservedDBInstanceMessage", + "resultWrapper":"DescribeReservedDBInstancesResult" + }, + "errors":[ + {"shape":"ReservedDBInstanceNotFoundFault"} + ], + "documentation":"

    Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

    " + }, + "DescribeReservedDBInstancesOfferings":{ + "name":"DescribeReservedDBInstancesOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedDBInstancesOfferingsMessage"}, + "output":{ + "shape":"ReservedDBInstancesOfferingMessage", + "resultWrapper":"DescribeReservedDBInstancesOfferingsResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"} + ], + "documentation":"

    Lists available reserved DB instance offerings.

    " + }, + "DescribeSourceRegions":{ + "name":"DescribeSourceRegions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSourceRegionsMessage"}, + "output":{ + "shape":"SourceRegionMessage", + "resultWrapper":"DescribeSourceRegionsResult" + }, + "documentation":"

    Returns a list of the source AWS Regions where the current AWS Region can create a Read Replica or copy a DB snapshot from. This API action supports pagination.

    " + }, + "DescribeValidDBInstanceModifications":{ + "name":"DescribeValidDBInstanceModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeValidDBInstanceModificationsMessage"}, + "output":{ + "shape":"DescribeValidDBInstanceModificationsResult", + "resultWrapper":"DescribeValidDBInstanceModificationsResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.

    " + }, + "DownloadDBLogFilePortion":{ + "name":"DownloadDBLogFilePortion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DownloadDBLogFilePortionMessage"}, + "output":{ + "shape":"DownloadDBLogFilePortionDetails", + "resultWrapper":"DownloadDBLogFilePortionResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBLogFileNotFoundFault"} + ], + "documentation":"

    Downloads all or a portion of the specified log file, up to 1 MB in size.

    " + }, + "FailoverDBCluster":{ + "name":"FailoverDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"FailoverDBClusterMessage"}, + "output":{ + "shape":"FailoverDBClusterResult", + "resultWrapper":"FailoverDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Forces a failover for a DB cluster.

    A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

    Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "ImportInstallationMedia":{ + "name":"ImportInstallationMedia", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportInstallationMediaMessage"}, + "output":{ + "shape":"InstallationMedia", + "resultWrapper":"ImportInstallationMediaResult" + }, + "errors":[ + {"shape":"CustomAvailabilityZoneNotFoundFault"}, + {"shape":"InstallationMediaAlreadyExistsFault"} + ], + "documentation":"

    Imports the installation media for a DB engine that requires an on-premises customer provided license, such as SQL Server.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceMessage"}, + "output":{ + "shape":"TagListMessage", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Lists all tags on an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    " + }, + "ModifyCurrentDBClusterCapacity":{ + "name":"ModifyCurrentDBClusterCapacity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyCurrentDBClusterCapacityMessage"}, + "output":{ + "shape":"DBClusterCapacityInfo", + "resultWrapper":"ModifyCurrentDBClusterCapacityResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterCapacityFault"} + ], + "documentation":"

    Set the capacity of an Aurora Serverless DB cluster to a specific value.

    Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly.

    After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down.

    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

    If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyDBCluster":{ + "name":"ModifyDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterMessage"}, + "output":{ + "shape":"ModifyDBClusterResult", + "resultWrapper":"ModifyDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DomainNotFoundFault"} + ], + "documentation":"

    Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyDBClusterEndpoint":{ + "name":"ModifyDBClusterEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterEndpointMessage"}, + "output":{ + "shape":"DBClusterEndpoint", + "resultWrapper":"ModifyDBClusterEndpointResult" + }, + "errors":[ + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBClusterEndpointStateFault"}, + {"shape":"DBClusterEndpointNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Modifies the properties of an endpoint in an Amazon Aurora DB cluster.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyDBClusterParameterGroup":{ + "name":"ModifyDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ModifyDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ], + "documentation":"

    Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.

    After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters action to verify that your DB cluster parameter group has been created or modified.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyDBClusterSnapshotAttribute":{ + "name":"ModifyDBClusterSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBClusterSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBClusterSnapshotAttributeResult", + "resultWrapper":"ModifyDBClusterSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ], + "documentation":"

    Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

    To share a manual DB cluster snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which AWS accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot public or private, use the DescribeDBClusterSnapshotAttributes API action.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyDBInstance":{ + "name":"ModifyDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBInstanceMessage"}, + "output":{ + "shape":"ModifyDBInstanceResult", + "resultWrapper":"ModifyDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"}, + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"DBUpgradeDependencyFailureFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"CertificateNotFoundFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"BackupPolicyNotFoundFault"} + ], + "documentation":"

    Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

    " + }, + "ModifyDBParameterGroup":{ + "name":"ModifyDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ModifyDBParameterGroupResult" + }, + "errors":[ + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"InvalidDBParameterGroupStateFault"} + ], + "documentation":"

    Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

    After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

    " + }, + "ModifyDBSnapshot":{ + "name":"ModifyDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSnapshotMessage"}, + "output":{ + "shape":"ModifyDBSnapshotResult", + "resultWrapper":"ModifyDBSnapshotResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"} + ], + "documentation":"

    Updates a manual DB snapshot, which can be encrypted or not encrypted, with a new engine version.

    Amazon RDS supports upgrading DB snapshots for MySQL and Oracle.

    " + }, + "ModifyDBSnapshotAttribute":{ + "name":"ModifyDBSnapshotAttribute", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSnapshotAttributeMessage"}, + "output":{ + "shape":"ModifyDBSnapshotAttributeResult", + "resultWrapper":"ModifyDBSnapshotAttributeResult" + }, + "errors":[ + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"SharedSnapshotQuotaExceededFault"} + ], + "documentation":"

    Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot.

    To share a manual DB snapshot with other AWS accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

    To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API action.

    " + }, + "ModifyDBSubnetGroup":{ + "name":"ModifyDBSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDBSubnetGroupMessage"}, + "output":{ + "shape":"ModifyDBSubnetGroupResult", + "resultWrapper":"ModifyDBSubnetGroupResult" + }, + "errors":[ + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"} + ], + "documentation":"

    Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the AWS Region.

    " + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"} + ], + "documentation":"

    Modifies an existing RDS event notification subscription. Note that you can't modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.

    You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "ModifyGlobalCluster":{ + "name":"ModifyGlobalCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyGlobalClusterMessage"}, + "output":{ + "shape":"ModifyGlobalClusterResult", + "resultWrapper":"ModifyGlobalClusterResult" + }, + "errors":[ + {"shape":"GlobalClusterNotFoundFault"}, + {"shape":"InvalidGlobalClusterStateFault"} + ], + "documentation":"

    Modify a setting for an Amazon Aurora global cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "ModifyOptionGroup":{ + "name":"ModifyOptionGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyOptionGroupMessage"}, + "output":{ + "shape":"ModifyOptionGroupResult", + "resultWrapper":"ModifyOptionGroupResult" + }, + "errors":[ + {"shape":"InvalidOptionGroupStateFault"}, + {"shape":"OptionGroupNotFoundFault"} + ], + "documentation":"

    Modifies an existing option group.

    " + }, + "PromoteReadReplica":{ + "name":"PromoteReadReplica", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaMessage"}, + "output":{ + "shape":"PromoteReadReplicaResult", + "resultWrapper":"PromoteReadReplicaResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

    Promotes a Read Replica DB instance to a standalone DB instance.

    • Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a Read Replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a Read Replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your Read Replica, configure the automated backup window so that daily backups do not interfere with Read Replica promotion.

    • This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.

    " + }, + "PromoteReadReplicaDBCluster":{ + "name":"PromoteReadReplicaDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PromoteReadReplicaDBClusterMessage"}, + "output":{ + "shape":"PromoteReadReplicaDBClusterResult", + "resultWrapper":"PromoteReadReplicaDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

    Promotes a Read Replica DB cluster to a standalone DB cluster.

    This action only applies to Aurora DB clusters.

    " + }, + "PurchaseReservedDBInstancesOffering":{ + "name":"PurchaseReservedDBInstancesOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedDBInstancesOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedDBInstancesOfferingResult", + "resultWrapper":"PurchaseReservedDBInstancesOfferingResult" + }, + "errors":[ + {"shape":"ReservedDBInstancesOfferingNotFoundFault"}, + {"shape":"ReservedDBInstanceAlreadyExistsFault"}, + {"shape":"ReservedDBInstanceQuotaExceededFault"} + ], + "documentation":"

    Purchases a reserved DB instance offering.

    " + }, + "RebootDBInstance":{ + "name":"RebootDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootDBInstanceMessage"}, + "output":{ + "shape":"RebootDBInstanceResult", + "resultWrapper":"RebootDBInstanceResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

    You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.

    Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.

    For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.

    " + }, + "RemoveFromGlobalCluster":{ + "name":"RemoveFromGlobalCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveFromGlobalClusterMessage"}, + "output":{ + "shape":"RemoveFromGlobalClusterResult", + "resultWrapper":"RemoveFromGlobalClusterResult" + }, + "errors":[ + {"shape":"GlobalClusterNotFoundFault"}, + {"shape":"InvalidGlobalClusterStateFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary cluster in a different region.

    This action only applies to Aurora DB clusters.

    " + }, + "RemoveRoleFromDBCluster":{ + "name":"RemoveRoleFromDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromDBClusterMessage"}, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterRoleNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

    Disassociates an AWS Identity and Access Management (IAM) role from an Amazon Aurora DB cluster. For more information, see Authorizing Amazon Aurora MySQL to Access Other AWS Services on Your Behalf in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "RemoveRoleFromDBInstance":{ + "name":"RemoveRoleFromDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveRoleFromDBInstanceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBInstanceRoleNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Disassociates an AWS Identity and Access Management (IAM) role from a DB instance.

    " + }, + "RemoveSourceIdentifierFromSubscription":{ + "name":"RemoveSourceIdentifierFromSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveSourceIdentifierFromSubscriptionMessage"}, + "output":{ + "shape":"RemoveSourceIdentifierFromSubscriptionResult", + "resultWrapper":"RemoveSourceIdentifierFromSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SourceNotFoundFault"} + ], + "documentation":"

    Removes a source identifier from an existing RDS event notification subscription.

    " + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceMessage"}, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"} + ], + "documentation":"

    Removes metadata tags from an Amazon RDS resource.

    For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    " + }, + "ResetDBClusterParameterGroup":{ + "name":"ResetDBClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBClusterParameterGroupMessage"}, + "output":{ + "shape":"DBClusterParameterGroupNameMessage", + "resultWrapper":"ResetDBClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

    When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request. You must call RebootDBInstance for every DB instance in your DB cluster that you want the updated static parameter to apply to.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "ResetDBParameterGroup":{ + "name":"ResetDBParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetDBParameterGroupMessage"}, + "output":{ + "shape":"DBParameterGroupNameMessage", + "resultWrapper":"ResetDBParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidDBParameterGroupStateFault"}, + {"shape":"DBParameterGroupNotFoundFault"} + ], + "documentation":"

    Modifies the parameters of a DB parameter group to the engine/system default value. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.

    " + }, + "RestoreDBClusterFromS3":{ + "name":"RestoreDBClusterFromS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromS3Message"}, + "output":{ + "shape":"RestoreDBClusterFromS3Result", + "resultWrapper":"RestoreDBClusterFromS3Result" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidS3BucketFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"} + ], + "documentation":"

    Creates an Amazon Aurora DB cluster from data stored in an Amazon S3 bucket. Amazon RDS must be authorized to access the Amazon S3 bucket and the data must be created using the Percona XtraBackup utility as described in Migrating Data to an Amazon Aurora MySQL DB Cluster in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "RestoreDBClusterFromSnapshot":{ + "name":"RestoreDBClusterFromSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterFromSnapshotMessage"}, + "output":{ + "shape":"RestoreDBClusterFromSnapshotResult", + "resultWrapper":"RestoreDBClusterFromSnapshotResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"} + ], + "documentation":"

    Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

    If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

    If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster. If you don't specify a security group, the new DB cluster is associated with the default security group.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "RestoreDBClusterToPointInTime":{ + "name":"RestoreDBClusterToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBClusterToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBClusterToPointInTimeResult", + "resultWrapper":"RestoreDBClusterToPointInTimeResult" + }, + "errors":[ + {"shape":"DBClusterAlreadyExistsFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBClusterQuotaExceededFault"}, + {"shape":"DBClusterSnapshotNotFoundFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"InsufficientDBClusterCapacityFault"}, + {"shape":"InsufficientStorageClusterCapacityFault"}, + {"shape":"InvalidDBClusterSnapshotStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"DBClusterParameterGroupNotFoundFault"} + ], + "documentation":"

    Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

    This action only restores the DB cluster, not the DB instances for that DB cluster. You must invoke the CreateDBInstance action to create DB instances for the restored DB cluster, specifying the identifier of the restored DB cluster in DBClusterIdentifier. You can create DB instances only after the RestoreDBClusterToPointInTime action has completed and the DB cluster is available.

    For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "RestoreDBInstanceFromDBSnapshot":{ + "name":"RestoreDBInstanceFromDBSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromDBSnapshotMessage"}, + "output":{ + "shape":"RestoreDBInstanceFromDBSnapshotResult", + "resultWrapper":"RestoreDBInstanceFromDBSnapshotResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBSnapshotNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBSnapshotStateFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"BackupPolicyNotFoundFault"} + ], + "documentation":"

    Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with the most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.

    If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.

    If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.

    " + }, + "RestoreDBInstanceFromS3":{ + "name":"RestoreDBInstanceFromS3", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceFromS3Message"}, + "output":{ + "shape":"RestoreDBInstanceFromS3Result", + "resultWrapper":"RestoreDBInstanceFromS3Result" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidS3BucketFault"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"BackupPolicyNotFoundFault"} + ], + "documentation":"

    Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.

    " + }, + "RestoreDBInstanceToPointInTime":{ + "name":"RestoreDBInstanceToPointInTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreDBInstanceToPointInTimeMessage"}, + "output":{ + "shape":"RestoreDBInstanceToPointInTimeResult", + "resultWrapper":"RestoreDBInstanceToPointInTimeResult" + }, + "errors":[ + {"shape":"DBInstanceAlreadyExistsFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InstanceQuotaExceededFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"PointInTimeRestoreNotEnabledFault"}, + {"shape":"StorageQuotaExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidSubnet"}, + {"shape":"ProvisionedIopsNotAvailableInAZFault"}, + {"shape":"OptionGroupNotFoundFault"}, + {"shape":"StorageTypeNotSupportedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"DomainNotFoundFault"}, + {"shape":"BackupPolicyNotFoundFault"}, + {"shape":"DBParameterGroupNotFoundFault"}, + {"shape":"DBInstanceAutomatedBackupNotFoundFault"} + ], + "documentation":"

    Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.

    The target database is created with most of the original configuration, but in a system-selected Availability Zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterToPointInTime.

    " + }, + "RevokeDBSecurityGroupIngress":{ + "name":"RevokeDBSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeDBSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeDBSecurityGroupIngressResult", + "resultWrapper":"RevokeDBSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"DBSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidDBSecurityGroupStateFault"} + ], + "documentation":"

    Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).

    " + }, + "StartActivityStream":{ + "name":"StartActivityStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartActivityStreamRequest"}, + "output":{ + "shape":"StartActivityStreamResponse", + "resultWrapper":"StartActivityStreamResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Starts a database activity stream to monitor activity on the database. For more information, see Database Activity Streams in the Amazon Aurora User Guide.

    " + }, + "StartDBCluster":{ + "name":"StartDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDBClusterMessage"}, + "output":{ + "shape":"StartDBClusterResult", + "resultWrapper":"StartDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Starts an Amazon Aurora DB cluster that was stopped using the AWS console, the stop-db-cluster AWS CLI command, or the StopDBCluster action.

    For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "StartDBInstance":{ + "name":"StartDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDBInstanceMessage"}, + "output":{ + "shape":"StartDBInstanceResult", + "resultWrapper":"StartDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InsufficientDBInstanceCapacityFault"}, + {"shape":"DBSubnetGroupNotFoundFault"}, + {"shape":"DBSubnetGroupDoesNotCoverEnoughAZs"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"} + ], + "documentation":"

    Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action.

    For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.

    " + }, + "StopActivityStream":{ + "name":"StopActivityStream", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopActivityStreamRequest"}, + "output":{ + "shape":"StopActivityStreamResponse", + "resultWrapper":"StopActivityStreamResult" + }, + "errors":[ + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"DBClusterNotFoundFault"}, + {"shape":"DBInstanceNotFoundFault"} + ], + "documentation":"

    Stops a database activity stream that was started using the AWS console, the start-activity-stream AWS CLI command, or the StartActivityStream action.

    For more information, see Database Activity Streams in the Amazon Aurora User Guide.

    " + }, + "StopDBCluster":{ + "name":"StopDBCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDBClusterMessage"}, + "output":{ + "shape":"StopDBClusterResult", + "resultWrapper":"StopDBClusterResult" + }, + "errors":[ + {"shape":"DBClusterNotFoundFault"}, + {"shape":"InvalidDBClusterStateFault"}, + {"shape":"InvalidDBInstanceStateFault"} + ], + "documentation":"

    Stops an Amazon Aurora DB cluster. When you stop a DB cluster, Aurora retains the DB cluster's metadata, including its endpoints and DB parameter groups. Aurora also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see Stopping and Starting an Aurora Cluster in the Amazon Aurora User Guide.

    This action only applies to Aurora DB clusters.

    " + }, + "StopDBInstance":{ + "name":"StopDBInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopDBInstanceMessage"}, + "output":{ + "shape":"StopDBInstanceResult", + "resultWrapper":"StopDBInstanceResult" + }, + "errors":[ + {"shape":"DBInstanceNotFoundFault"}, + {"shape":"InvalidDBInstanceStateFault"}, + {"shape":"DBSnapshotAlreadyExistsFault"}, + {"shape":"SnapshotQuotaExceededFault"}, + {"shape":"InvalidDBClusterStateFault"} + ], + "documentation":"

    Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

    For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

    This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

    " + } + }, + "shapes":{ + "AccountAttributesMessage":{ + "type":"structure", + "members":{ + "AccountQuotas":{ + "shape":"AccountQuotaList", + "documentation":"

    A list of AccountQuota objects. Within this list, each quota has a name, a count of usage toward the quota maximum, and a maximum value for the quota.

    " + } + }, + "documentation":"

    Data returned by the DescribeAccountAttributes action.

    " + }, + "AccountQuota":{ + "type":"structure", + "members":{ + "AccountQuotaName":{ + "shape":"String", + "documentation":"

    The name of the Amazon RDS quota for this AWS account.

    " + }, + "Used":{ + "shape":"Long", + "documentation":"

    The amount currently used toward the quota maximum.

    " + }, + "Max":{ + "shape":"Long", + "documentation":"

    The maximum allowed value for the quota.

    " + } + }, + "documentation":"

    Describes a quota for an AWS account.

    The following are account quotas:

    • AllocatedStorage - The total allocated storage per account, in GiB. The used value is the total allocated storage in the account, in GiB.

    • AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB security group. The used value is the highest number of ingress rules in a DB security group in the account. Other DB security groups in the account might have a lower number of ingress rules.

    • CustomEndpointsPerDBCluster - The number of custom endpoints per DB cluster. The used value is the highest number of custom endpoints in a DB clusters in the account. Other DB clusters in the account might have a lower number of custom endpoints.

    • DBClusterParameterGroups - The number of DB cluster parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB cluster parameter groups in the account.

    • DBClusterRoles - The number of associated AWS Identity and Access Management (IAM) roles per DB cluster. The used value is the highest number of associated IAM roles for a DB cluster in the account. Other DB clusters in the account might have a lower number of associated IAM roles.

    • DBClusters - The number of DB clusters per account. The used value is the count of DB clusters in the account.

    • DBInstanceRoles - The number of associated IAM roles per DB instance. The used value is the highest number of associated IAM roles for a DB instance in the account. Other DB instances in the account might have a lower number of associated IAM roles.

    • DBInstances - The number of DB instances per account. The used value is the count of the DB instances in the account.

    • DBParameterGroups - The number of DB parameter groups per account, excluding default parameter groups. The used value is the count of nondefault DB parameter groups in the account.

    • DBSecurityGroups - The number of DB security groups (not VPC security groups) per account, excluding the default security group. The used value is the count of nondefault DB security groups in the account.

    • DBSubnetGroups - The number of DB subnet groups per account. The used value is the count of the DB subnet groups in the account.

    • EventSubscriptions - The number of event subscriptions per account. The used value is the count of the event subscriptions in the account.

    • ManualSnapshots - The number of manual DB snapshots per account. The used value is the count of the manual DB snapshots in the account.

    • OptionGroups - The number of DB option groups per account, excluding default option groups. The used value is the count of nondefault DB option groups in the account.

    • ReadReplicasPerMaster - The number of Read Replicas per DB instance. The used value is the highest number of Read Replicas for a DB instance in the account. Other DB instances in the account might have a lower number of Read Replicas.

    • ReservedDBInstances - The number of reserved DB instances per account. The used value is the count of the active reserved DB instances in the account.

    • SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. The used value is highest number of subnets for a DB subnet group in the account. Other DB subnet groups in the account might have a lower number of subnets.

    For more information, see Limits in the Amazon RDS User Guide and Limits in the Amazon Aurora User Guide.

    ", + "wrapper":true + }, + "AccountQuotaList":{ + "type":"list", + "member":{ + "shape":"AccountQuota", + "locationName":"AccountQuota" + } + }, + "ActivityStreamMode":{ + "type":"string", + "enum":[ + "sync", + "async" + ] + }, + "ActivityStreamStatus":{ + "type":"string", + "enum":[ + "stopped", + "starting", + "started", + "stopping" + ] + }, + "AddRoleToDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "RoleArn" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB cluster to associate the IAM role with.

    " + }, + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature for the DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

    " + } + } + }, + "AddRoleToDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "RoleArn", + "FeatureName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB instance to associate the IAM role with.

    " + }, + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role to associate with the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature for the DB instance that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

    " + } + } + }, + "AddSourceIdentifierToSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to add a source identifier to.

    " + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the event source to be added.

    Constraints:

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

    " + } + }, + "documentation":"

    " + }, + "AddSourceIdentifierToSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "AddTagsToResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource that the tags are added to. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags to be assigned to the Amazon RDS resource.

    " + } + }, + "documentation":"

    " + }, + "ApplyMethod":{ + "type":"string", + "enum":[ + "immediate", + "pending-reboot" + ] + }, + "ApplyPendingMaintenanceActionMessage":{ + "type":"structure", + "required":[ + "ResourceIdentifier", + "ApplyAction", + "OptInType" + ], + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

    The RDS Amazon Resource Name (ARN) of the resource that the pending maintenance action applies to. For information about creating an ARN, see Constructing an RDS Amazon Resource Name (ARN).

    " + }, + "ApplyAction":{ + "shape":"String", + "documentation":"

    The pending maintenance action to apply to this resource.

    Valid values: system-update, db-upgrade, hardware-maintenance

    " + }, + "OptInType":{ + "shape":"String", + "documentation":"

    A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type immediate can't be undone.

    Valid values:

    • immediate - Apply the maintenance action immediately.

    • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

    • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

    " + } + }, + "documentation":"

    " + }, + "ApplyPendingMaintenanceActionResult":{ + "type":"structure", + "members":{ + "ResourcePendingMaintenanceActions":{"shape":"ResourcePendingMaintenanceActions"} + } + }, + "AttributeValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeValue" + } + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified CIDR IP range or Amazon EC2 security group is already authorized for the specified DB security group.

    ", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified CIDR IP range or Amazon EC2 security group might not be authorized for the specified DB security group.

    Or, RDS might not be authorized to perform necessary actions using IAM on your behalf.

    ", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB security group authorization quota has been reached.

    ", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to add authorization to.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range to authorize.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    Name of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    Id of the EC2 security group to authorize. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + } + }, + "documentation":"

    " + }, + "AuthorizeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the Availability Zone.

    " + } + }, + "documentation":"

    Contains Availability Zone information.

    This data type is used as an element in the OrderableDBInstanceOption data type.

    ", + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "AvailabilityZones":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AvailabilityZone" + } + }, + "AvailableProcessorFeature":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

    " + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

    The default value for the processor feature of the DB instance class.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    The allowed values for the processor feature of the DB instance class.

    " + } + }, + "documentation":"

    Contains the available processor feature information for the DB instance class of a DB instance.

    For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

    " + }, + "AvailableProcessorFeatureList":{ + "type":"list", + "member":{ + "shape":"AvailableProcessorFeature", + "locationName":"AvailableProcessorFeature" + } + }, + "BacktrackDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "BacktrackTo" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the DB cluster to be backtracked. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

    " + }, + "BacktrackTo":{ + "shape":"TStamp", + "documentation":"

    The timestamp of the time to backtrack the DB cluster to, specified in ISO 8601 format. For more information about ISO 8601, see the ISO8601 Wikipedia page.

    If the specified time isn't a consistent time for the DB cluster, Aurora automatically chooses the nearest possible consistent time for the DB cluster.

    Constraints:

    • Must contain a valid ISO 8601 timestamp.

    • Can't contain a timestamp set in the future.

    Example: 2017-07-08T18:00Z

    " + }, + "Force":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

    " + }, + "UseEarliestTimeOnPointInTimeUnavailable":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

    " + } + }, + "documentation":"

    " + }, + "BackupPolicyNotFoundFault":{ + "type":"structure", + "members":{ + }, + "deprecated":true, + "deprecatedMessage":"Please avoid using this fault", + "error":{ + "code":"BackupPolicyNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "Certificate":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

    The unique key that identifies a certificate.

    " + }, + "CertificateType":{ + "shape":"String", + "documentation":"

    The type of the certificate.

    " + }, + "Thumbprint":{ + "shape":"String", + "documentation":"

    The thumbprint of the certificate.

    " + }, + "ValidFrom":{ + "shape":"TStamp", + "documentation":"

    The starting date from which the certificate is valid.

    " + }, + "ValidTill":{ + "shape":"TStamp", + "documentation":"

    The final date that the certificate continues to be valid.

    " + }, + "CertificateArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the certificate.

    " + } + }, + "documentation":"

    A CA certificate for an AWS account.

    ", + "wrapper":true + }, + "CertificateList":{ + "type":"list", + "member":{ + "shape":"Certificate", + "locationName":"Certificate" + } + }, + "CertificateMessage":{ + "type":"structure", + "members":{ + "Certificates":{ + "shape":"CertificateList", + "documentation":"

    The list of Certificate objects for the AWS account.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    Data returned by the DescribeCertificates action.

    " + }, + "CertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    CertificateIdentifier doesn't refer to an existing certificate.

    ", + "error":{ + "code":"CertificateNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CharacterSet":{ + "type":"structure", + "members":{ + "CharacterSetName":{ + "shape":"String", + "documentation":"

    The name of the character set.

    " + }, + "CharacterSetDescription":{ + "shape":"String", + "documentation":"

    The description of the character set.

    " + } + }, + "documentation":"

    This data type is used as a response element in the action DescribeDBEngineVersions.

    " + }, + "CloudwatchLogsExportConfiguration":{ + "type":"structure", + "members":{ + "EnableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

    The list of log types to enable.

    " + }, + "DisableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

    The list of log types to disable.

    " + } + }, + "documentation":"

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster.

    The EnableLogTypes and DisableLogTypes arrays determine which logs will be exported (or not exported) to CloudWatch Logs. The values within these arrays depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + }, + "CopyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupIdentifier", + "TargetDBClusterParameterGroupDescription" + ], + "members":{ + "SourceDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide.

    Constraints:

    • Must specify a valid DB cluster parameter group.

    • If the source DB cluster parameter group is in the same AWS Region as the copy, specify a valid DB parameter group identifier, for example my-db-cluster-param-group, or a valid ARN.

    • If the source DB parameter group is in a different AWS Region than the copy, specify a valid DB cluster parameter group ARN, for example arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

    " + }, + "TargetDBClusterParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied DB cluster parameter group.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster-param-group1

    " + }, + "TargetDBClusterParameterGroupDescription":{ + "shape":"String", + "documentation":"

    A description for the copied DB cluster parameter group.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CopyDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CopyDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBClusterSnapshotIdentifier", + "TargetDBClusterSnapshotIdentifier" + ], + "members":{ + "SourceDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster snapshot to copy. This parameter isn't case-sensitive.

    You can't copy an encrypted, shared DB cluster snapshot from one AWS Region to another.

    Constraints:

    • Must specify a valid system snapshot in the \"available\" state.

    • If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier.

    • If the source snapshot is in a different AWS Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across AWS Regions in the Amazon Aurora User Guide.

    Example: my-cluster-snapshot1

    " + }, + "TargetDBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster-snapshot2

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot.

    If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

    To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the KMS key ID you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

    If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

    " + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

    The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region.

    The pre-signed URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

    • SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

    " + }, + "CopyTags":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CopyDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CopyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "SourceDBParameterGroupIdentifier", + "TargetDBParameterGroupIdentifier", + "TargetDBParameterGroupDescription" + ], + "members":{ + "SourceDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier or ARN for the source DB parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    Constraints:

    • Must specify a valid DB parameter group.

    • Must specify a valid DB parameter group identifier, for example my-db-param-group, or a valid ARN.

    " + }, + "TargetDBParameterGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied DB parameter group.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-db-parameter-group

    " + }, + "TargetDBParameterGroupDescription":{ + "shape":"String", + "documentation":"

    A description for the copied DB parameter group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CopyDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CopyDBSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceDBSnapshotIdentifier", + "TargetDBSnapshotIdentifier" + ], + "members":{ + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the source DB snapshot.

    If the source snapshot is in the same AWS Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

    If the source snapshot is in a different AWS Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

    If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

    If you are copying an encrypted snapshot this parameter must be in the ARN format for the source AWS Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

    Constraints:

    • Must specify a valid system snapshot in the \"available\" state.

    Example: rds:mydb-2012-04-02-00-01

    Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

    " + }, + "TargetDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copy of the snapshot.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-db-snapshot

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key ID for an encrypted DB snapshot. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new KMS encryption key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same KMS key as the source DB snapshot.

    If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter.

    If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

    If you copy an encrypted snapshot to a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

    " + }, + "Tags":{"shape":"TagList"}, + "CopyTags":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

    " + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

    The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy.

    You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region.

    The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

      For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

    • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of an option group to associate with the copy of the snapshot.

    Specify this option if you are copying a snapshot from one AWS Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across AWS Regions. For more information, see Option Group Considerations in the Amazon RDS User Guide.

    " + } + }, + "documentation":"

    " + }, + "CopyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CopyOptionGroupMessage":{ + "type":"structure", + "required":[ + "SourceOptionGroupIdentifier", + "TargetOptionGroupIdentifier", + "TargetOptionGroupDescription" + ], + "members":{ + "SourceOptionGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier or ARN for the source option group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    Constraints:

    • Must specify a valid option group.

    • If the source option group is in the same AWS Region as the copy, specify a valid option group identifier, for example my-option-group, or a valid ARN.

    • If the source option group is in a different AWS Region than the copy, specify a valid option group ARN, for example arn:aws:rds:us-west-2:123456789012:og:special-options.

    " + }, + "TargetOptionGroupIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the copied option group.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-option-group

    " + }, + "TargetOptionGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the copied option group.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CopyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "CreateCustomAvailabilityZoneMessage":{ + "type":"structure", + "required":["CustomAvailabilityZoneName"], + "members":{ + "CustomAvailabilityZoneName":{ + "shape":"String", + "documentation":"

    The name of the custom Availability Zone (AZ).

    " + }, + "ExistingVpnId":{ + "shape":"String", + "documentation":"

    The ID of an existing virtual private network (VPN) between the Amazon RDS website and the VMware vSphere cluster.

    " + }, + "NewVpnTunnelName":{ + "shape":"String", + "documentation":"

    The name of a new VPN tunnel between the Amazon RDS website and the VMware vSphere cluster.

    Specify this parameter only if ExistingVpnId isn't specified.

    " + }, + "VpnTunnelOriginatorIP":{ + "shape":"String", + "documentation":"

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    Specify this parameter only if ExistingVpnId isn't specified.

    " + } + }, + "documentation":"

    " + }, + "CreateCustomAvailabilityZoneResult":{ + "type":"structure", + "members":{ + "CustomAvailabilityZone":{"shape":"CustomAvailabilityZone"} + } + }, + "CreateDBClusterEndpointMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "DBClusterEndpointIdentifier", + "EndpointType" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    " + }, + "DBClusterEndpointIdentifier":{ + "shape":"String", + "documentation":"

    The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

    " + }, + "EndpointType":{ + "shape":"String", + "documentation":"

    The type of the endpoint. One of: READER, WRITER, ANY.

    " + }, + "StaticMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that are part of the custom endpoint group.

    " + }, + "ExcludedMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    " + } + } + }, + "CreateDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

    A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    A value that indicates that the DB cluster should be associated with the specified CharacterSet.

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

    " + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to associate with this DB cluster. If you do not specify a value, then the default DB cluster parameter group for the specified DB engine and version is used.

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with this DB cluster.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    A DB subnet group to associate with this DB cluster.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for this DB cluster.

    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"

    Aurora MySQL

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

    Aurora PostgreSQL

    Example: 9.6.3, 10.7

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the instances in the DB cluster accept connections.

    Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The name of the master user for the DB cluster.

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    Constraints: Must contain from 8 to 41 characters.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    A value that indicates that the DB cluster should be associated with the specified option group.

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    " + }, + "ReplicationSourceIdentifier":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB cluster.

    " + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If an encryption key isn't specified in KmsKeyId:

    • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the encryption key used to encrypt the source. Otherwise, Amazon RDS will use your default encryption key.

    • If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default encryption key.

    AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

    " + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

    A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

    The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

    The pre-signed URL request must contain the following parameter values:

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL.

    • DestinationRegion - The name of the AWS Region that Aurora Read Replica will be created in.

    • ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + }, + "EngineMode":{ + "shape":"String", + "documentation":"

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

    " + }, + "ScalingConfiguration":{ + "shape":"ScalingConfiguration", + "documentation":"

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    " + }, + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

    " + }, + "EnableHttpEndpoint":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

    " + } + }, + "documentation":"

    " + }, + "CreateDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group.

    Constraints:

    • Must match the name of an existing DB cluster parameter group.

    This value is stored as a lowercase string.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.

    Aurora MySQL

    Example: aurora5.6, aurora-mysql5.7

    Aurora PostgreSQL

    Example: aurora-postgresql9.6

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description for the DB cluster parameter group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB cluster parameter group.

    " + } + }, + "documentation":"

    " + }, + "CreateDBClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "DBClusterParameterGroup":{"shape":"DBClusterParameterGroup"} + } + }, + "CreateDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "CreateDBClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "DBClusterIdentifier" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1-snapshot1

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster to create a snapshot for. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    Example: my-cluster1

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags to be assigned to the DB cluster snapshot.

    " + } + }, + "documentation":"

    " + }, + "CreateDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "CreateDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

    The meaning of this parameter differs according to the database engine you use.

    MySQL

    The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

    Constraints:

    • Must contain 1 to 64 letters or numbers.

    • Can't be a word reserved by the specified database engine

    MariaDB

    The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.

    Constraints:

    • Must contain 1 to 64 letters or numbers.

    • Can't be a word reserved by the specified database engine

    PostgreSQL

    The name of the database to create when the DB instance is created. If this parameter isn't specified, the default \"postgres\" database is created in the DB instance.

    Constraints:

    • Must contain 1 to 63 letters, numbers, or underscores.

    • Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9).

    • Can't be a word reserved by the specified database engine

    Oracle

    The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName.

    Default: ORCL

    Constraints:

    • Can't be longer than 8 characters

    SQL Server

    Not applicable. Must be null.

    Amazon Aurora

    The name of the database to create when the primary instance of the DB cluster is created. If this parameter isn't specified, no database is created in the DB instance.

    Constraints:

    • Must contain 1 to 64 letters or numbers.

    • Can't be a word reserved by the specified database engine

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of storage (in gibibytes) to allocate for the DB instance.

    Type: Integer

    Amazon Aurora

    Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

    MySQL

    Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    • Magnetic storage (standard): Must be an integer from 5 to 3072.

    MariaDB

    Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    • Magnetic storage (standard): Must be an integer from 5 to 3072.

    PostgreSQL

    Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    • Magnetic storage (standard): Must be an integer from 5 to 3072.

    Oracle

    Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.

    • Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.

    • Magnetic storage (standard): Must be an integer from 10 to 3072.

    SQL Server

    Constraints to the amount of storage for each storage type are the following:

    • General Purpose (SSD) storage (gp2):

      • Enterprise and Standard editions: Must be an integer from 200 to 16384.

      • Web and Express editions: Must be an integer from 20 to 16384.

    • Provisioned IOPS storage (io1):

      • Enterprise and Standard editions: Must be an integer from 200 to 16384.

      • Web and Express editions: Must be an integer from 100 to 16384.

    • Magnetic storage (standard):

      • Enterprise and Standard editions: Must be an integer from 200 to 1024.

      • Web and Express editions: Must be an integer from 20 to 1024.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for this instance.

    Not every database engine is available for every AWS Region.

    Valid Values:

    • aurora (for MySQL 5.6-compatible Aurora)

    • aurora-mysql (for MySQL 5.7-compatible Aurora)

    • aurora-postgresql

    • mariadb

    • mysql

    • oracle-ee

    • oracle-se2

    • oracle-se1

    • oracle-se

    • postgres

    • sqlserver-ee

    • sqlserver-se

    • sqlserver-ex

    • sqlserver-web

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The name for the master user.

    Amazon Aurora

    Not applicable. The name for the master user is managed by the DB cluster.

    MariaDB

    Constraints:

    • Required for MariaDB.

    • Must be 1 to 16 letters or numbers.

    • Can't be a reserved word for the chosen database engine.

    Microsoft SQL Server

    Constraints:

    • Required for SQL Server.

    • Must be 1 to 128 letters or numbers.

    • The first character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    MySQL

    Constraints:

    • Required for MySQL.

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    Oracle

    Constraints:

    • Required for Oracle.

    • Must be 1 to 30 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    PostgreSQL

    Constraints:

    • Required for PostgreSQL.

    • Must be 1 to 63 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    Amazon Aurora

    Not applicable. The password for the master user is managed by the DB cluster.

    MariaDB

    Constraints: Must contain from 8 to 41 characters.

    Microsoft SQL Server

    Constraints: Must contain from 8 to 128 characters.

    MySQL

    Constraints: Must contain from 8 to 41 characters.

    Oracle

    Constraints: Must contain from 8 to 30 characters.

    PostgreSQL

    Constraints: Must contain from 8 to 128 characters.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of Amazon EC2 VPC security groups to associate with this DB instance.

    Amazon Aurora

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

    If you're creating a DB instance in an RDS on VMware environment, specify the identifier of the custom Availability Zone to create the DB instance in.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    A DB subnet group to associate with this DB instance.

    If there is no DB subnet group, then it is a non-VPC DB instance.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Amazon Aurora

    Not applicable. The retention period for automated backups is managed by the DB cluster.

    Default: 1

    Constraints:

    • Must be a value from 0 to 35

    • Can't be set to 0 if the DB instance is a source to Read Replicas

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. For more information, see The Backup Window in the Amazon RDS User Guide.

    Amazon Aurora

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Instance Maintenance Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    MySQL

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

    MariaDB

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

    PostgreSQL

    Default: 5432

    Valid Values: 1150-65535

    Type: Integer

    Oracle

    Default: 1521

    Valid Values: 1150-65535

    SQL Server

    Default: 1433

    Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

    Amazon Aurora

    Default: 3306

    Valid Values: 1150-65535

    Type: Integer

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use.

    For a list of valid engine versions, use the DescribeDBEngineVersions action.

    The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.

    Amazon Aurora

    Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.

    MariaDB

    See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide.

    Microsoft SQL Server

    See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

    MySQL

    See MySQL on Amazon RDS Versions in the Amazon RDS User Guide.

    Oracle

    See Oracle Database Engine Release Notes in the Amazon RDS User Guide.

    PostgreSQL

    See Supported PostgreSQL Database Versions in the Amazon RDS User Guide.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for this DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

    Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Indicates that the DB instance should be associated with the specified option group.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

    Amazon Aurora

    Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

    Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

    If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

    • If the default VPC in the target region doesn’t have an Internet gateway attached to it, the DB instance is private.

    • If the default VPC in the target region has an Internet gateway attached to it, the DB instance is public.

    If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

    • If the subnets are part of a VPC that doesn’t have an Internet gateway attached to it, the DB instance is private.

    • If the subnets are part of a VPC that has an Internet gateway attached to it, the DB instance is public.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB instance.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster that the instance will belong to.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the key store in order to access the device.

    " + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.

    Amazon Aurora

    Not applicable. The encryption for DB instances is managed by the DB cluster.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for an encrypted DB instance.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    Amazon Aurora

    Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

    If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "Domain":{ + "shape":"String", + "documentation":"

    The Active Directory directory ID to create the DB instance in. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

    For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

    For Oracle DB instance, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    Amazon Aurora

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.

    " + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    " + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

    Default: 1

    Valid Values: 0 - 15

    " + }, + "Timezone":{ + "shape":"String", + "documentation":"

    The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    You can enable IAM database authentication for the following database engines:

    Amazon Aurora

    Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

    MySQL

    • For MySQL 5.6, minor version 5.6.34 or higher

    • For MySQL 5.7, minor version 5.7.16 or higher

    • For MySQL 8.0, minor version 8.0.16 or higher

    PostgreSQL

    • For PostgreSQL 9.5, minor version 9.5.15 or higher

    • For PostgreSQL 9.6, minor version 9.6.11 or higher

    • PostgreSQL 10.6, 10.7, and 10.9

    For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable Performance Insights for the DB instance.

    For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

    " + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "PerformanceInsightsRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + }, + "MaxAllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " + } + }, + "documentation":"

    " + }, + "CreateDBInstanceReadReplicaMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "SourceDBInstanceIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

    " + }, + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

    Constraints:

    • Must be the identifier of an existing MySQL, MariaDB, Oracle, or PostgreSQL DB instance.

    • Can specify a DB instance that is a MySQL Read Replica only if the source is running MySQL 5.6 or later.

    • For the limitations of Oracle Read Replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide.

    • Can specify a DB instance that is a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication).

    • The specified DB instance must have automatic backups enabled, its backup retention period must be greater than 0.

    • If the source DB instance is in the same AWS Region as the Read Replica, specify a valid DB instance identifier.

    • If the source DB instance is in a different AWS Region than the Read Replica, specify a valid DB instance ARN. For more information, go to Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Read Replica, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    Default: Inherits from the source DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone (AZ) where the Read Replica will be created.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    Example: us-east-1d

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number that the DB instance uses for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the Read Replica is in a Multi-AZ deployment.

    You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

    Default: Inherits from the source DB instance

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region Read Replica, or the default DBParameterGroup for the specified DB engine for a cross region Read Replica.

    Currently, specifying a parameter group for this operation is only supported for Oracle DB instances.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

    " + }, + "Tags":{"shape":"TagList"}, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance isn't created in a VPC.

    Constraints:

    • Can only be specified if the source DB instance identifier specifies a DB instance in another AWS Region.

    • If supplied, must match the name of an existing DBSubnetGroup.

    • The specified DB subnet group must be in the same AWS Region in which the operation is running.

    • All Read Replicas in one AWS Region that are created from the same source DB instance must either:>

      • Specify DB subnet groups from the same VPC. All these Read Replicas are created in the same VPC.

      • Not specify a DB subnet group. All these Read Replicas are created outside of any VPC.

    Example: mySubnetgroup

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with the Read Replica.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the Read Replica.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.

    " + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the Read Replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    " + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

    If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

    You can't create an encrypted Read Replica from an unencrypted DB instance.

    " + }, + "PreSignedUrl":{ + "shape":"String", + "documentation":"

    The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

    You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted Read Replica in the same AWS Region.

    The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

    • DestinationRegion - The AWS Region that the encrypted Read Replica is created in. This AWS Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL.

      For example, if you create an encrypted DB instance in the us-west-1 AWS Region, from a source DB instance in the us-east-2 AWS Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region.

    • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the Read Replica in the destination AWS Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination AWS Region, and the action contained in the presigned URL.

    • SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are creating an encrypted Read Replica from a DB instance in the us-west-2 AWS Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115.

    To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

    If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable Performance Insights for the Read Replica.

    For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

    " + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "PerformanceInsightsRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "UseDefaultProcessorFeatures":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + }, + "Domain":{ + "shape":"String", + "documentation":"

    The Active Directory directory ID to create the DB instance in.

    For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + } + } + }, + "CreateDBInstanceReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "CreateDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "DBParameterGroupFamily", + "Description" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

    To list all of the available parameter group families, use the following command:

    aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"

    The output contains duplicates.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description for the DB parameter group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB parameter group.

    " + } + }, + "documentation":"

    " + }, + "CreateDBParameterGroupResult":{ + "type":"structure", + "members":{ + "DBParameterGroup":{"shape":"DBParameterGroup"} + } + }, + "CreateDBSecurityGroupMessage":{ + "type":"structure", + "required":[ + "DBSecurityGroupName", + "DBSecurityGroupDescription" + ], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB security group. This value is stored as a lowercase string.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    • Must not be \"Default\"

    Example: mysecuritygroup

    " + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB security group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB security group.

    " + } + }, + "documentation":"

    " + }, + "CreateDBSecurityGroupResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "CreateDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "DBInstanceIdentifier" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot.

    Constraints:

    • Can't be null, empty, or blank

    • Must contain from 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB instance that you want to create the snapshot of.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "CreateDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "DBSubnetGroupDescription", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB subnet group. This value is stored as a lowercase string.

    Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.

    Example: mySubnetgroup

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB subnet group.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    The EC2 Subnet IDs for the DB subnet group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the DB subnet group.

    " + } + }, + "documentation":"

    " + }, + "CreateDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the subscription.

    Constraints: The name must be less than 255 characters.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value isn't specified, all events are returned.

    Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

    The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.

    Constraints:

    • If SourceIds are supplied, SourceType must also be provided.

    • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

    • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

    • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

    • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateGlobalClusterMessage":{ + "type":"structure", + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The cluster identifier of the new global database cluster.

    " + }, + "SourceDBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) to use as the primary cluster of the global database. This parameter is optional.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Provides the name of the database engine to be used for this DB cluster.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version of the Aurora global database.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.

    " + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    The storage encryption setting for the new global database cluster.

    " + } + } + }, + "CreateGlobalClusterResult":{ + "type":"structure", + "members":{ + "GlobalCluster":{"shape":"GlobalCluster"} + } + }, + "CreateOptionGroupMessage":{ + "type":"structure", + "required":[ + "OptionGroupName", + "EngineName", + "MajorEngineVersion", + "OptionGroupDescription" + ], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the option group to be created.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: myoptiongroup

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Specifies the name of the engine that this option group should be associated with.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Specifies the major version of the engine that this option group should be associated with.

    " + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

    The description of the option group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags to assign to the option group.

    " + } + }, + "documentation":"

    " + }, + "CreateOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "CustomAvailabilityZone":{ + "type":"structure", + "members":{ + "CustomAvailabilityZoneId":{ + "shape":"String", + "documentation":"

    The identifier of the custom AZ.

    Amazon RDS generates a unique identifier when a custom AZ is created.

    " + }, + "CustomAvailabilityZoneName":{ + "shape":"String", + "documentation":"

    The name of the custom AZ.

    " + }, + "CustomAvailabilityZoneStatus":{ + "shape":"String", + "documentation":"

    The status of the custom AZ.

    " + }, + "VpnDetails":{ + "shape":"VpnDetails", + "documentation":"

    Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

    " + } + }, + "documentation":"

    A custom Availability Zone (AZ) is an on-premises AZ that is integrated with a VMware vSphere cluster.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    ", + "wrapper":true + }, + "CustomAvailabilityZoneAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    CustomAvailabilityZoneName is already used by an existing custom Availability Zone.

    ", + "error":{ + "code":"CustomAvailabilityZoneAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CustomAvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"CustomAvailabilityZone", + "locationName":"CustomAvailabilityZone" + } + }, + "CustomAvailabilityZoneMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "CustomAvailabilityZones":{ + "shape":"CustomAvailabilityZoneList", + "documentation":"

    The list of CustomAvailabilityZone objects for the AWS account.

    " + } + } + }, + "CustomAvailabilityZoneNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

    ", + "error":{ + "code":"CustomAvailabilityZoneNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "CustomAvailabilityZoneQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the maximum number of custom Availability Zones.

    ", + "error":{ + "code":"CustomAvailabilityZoneQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBCluster":{ + "type":"structure", + "members":{ + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

    " + }, + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

    Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the number of days for which automatic DB snapshots are retained.

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    If present, specifies the name of the character set that this cluster is associated with.

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " + }, + "DBClusterParameterGroup":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB cluster parameter group for the DB cluster.

    " + }, + "DBSubnetGroup":{ + "shape":"String", + "documentation":"

    Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the current state of this DB cluster.

    " + }, + "PercentProgress":{ + "shape":"String", + "documentation":"

    Specifies the progress of the operation as a percentage.

    " + }, + "EarliestRestorableTime":{ + "shape":"TStamp", + "documentation":"

    The earliest time to which a database can be restored with point-in-time restore.

    " + }, + "Endpoint":{ + "shape":"String", + "documentation":"

    Specifies the connection endpoint for the primary instance of the DB cluster.

    " + }, + "ReaderEndpoint":{ + "shape":"String", + "documentation":"

    The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.

    If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

    " + }, + "CustomEndpoints":{ + "shape":"StringList", + "documentation":"

    Identifies all custom endpoints associated with the cluster.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies whether the DB cluster has instances in multiple Availability Zones.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Provides the name of the database engine to be used for this DB cluster.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the port that the database engine is listening on.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Contains the master username for the DB cluster.

    " + }, + "DBClusterOptionGroupMemberships":{ + "shape":"DBClusterOptionGroupMemberships", + "documentation":"

    Provides the list of option group memberships for this DB cluster.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    " + }, + "ReplicationSourceIdentifier":{ + "shape":"String", + "documentation":"

    Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

    " + }, + "ReadReplicaIdentifiers":{ + "shape":"ReadReplicaIdentifierList", + "documentation":"

    Contains one or more identifiers of the Read Replicas associated with this DB cluster.

    " + }, + "DBClusterMembers":{ + "shape":"DBClusterMemberList", + "documentation":"

    Provides the list of instances that make up the DB cluster.

    " + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    Provides a list of VPC security groups that the DB cluster belongs to.

    " + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the DB cluster is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

    " + }, + "DbClusterResourceId":{ + "shape":"String", + "documentation":"

    The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

    " + }, + "DBClusterArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB cluster.

    " + }, + "AssociatedRoles":{ + "shape":"DBClusterRoles", + "documentation":"

    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

    " + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

    " + }, + "CloneGroupId":{ + "shape":"String", + "documentation":"

    Identifies the clone group to which the DB cluster is associated.

    " + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " + }, + "EarliestBacktrackTime":{ + "shape":"TStamp", + "documentation":"

    The earliest time to which a DB cluster can be backtracked.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

    " + }, + "BacktrackConsumedChangeRecords":{ + "shape":"LongOptional", + "documentation":"

    The number of change records stored for Backtrack.

    " + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    A list of log types that this DB cluster is configured to export to CloudWatch Logs.

    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

    " + }, + "Capacity":{ + "shape":"IntegerOptional", + "documentation":"

    The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused.

    For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "EngineMode":{ + "shape":"String", + "documentation":"

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

    " + }, + "ScalingConfigurationInfo":{"shape":"ScalingConfigurationInfo"}, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    " + }, + "HttpEndpointEnabled":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "ActivityStreamMode":{ + "shape":"ActivityStreamMode", + "documentation":"

    The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

    " + }, + "ActivityStreamStatus":{ + "shape":"ActivityStreamStatus", + "documentation":"

    The status of the database activity stream.

    " + }, + "ActivityStreamKmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier used for encrypting messages in the database activity stream.

    " + }, + "ActivityStreamKinesisStreamName":{ + "shape":"String", + "documentation":"

    The name of the Amazon Kinesis data stream used for the database activity stream.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

    " + }, + "CrossAccountClone":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

    " + } + }, + "documentation":"

    Contains the details of an Amazon Aurora DB cluster.

    This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

    ", + "wrapper":true + }, + "DBClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The user already has a DB cluster with the given identifier.

    ", + "error":{ + "code":"DBClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterBacktrack":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " + }, + "BacktrackIdentifier":{ + "shape":"String", + "documentation":"

    Contains the backtrack identifier.

    " + }, + "BacktrackTo":{ + "shape":"TStamp", + "documentation":"

    The timestamp of the time to which the DB cluster was backtracked.

    " + }, + "BacktrackedFrom":{ + "shape":"TStamp", + "documentation":"

    The timestamp of the time from which the DB cluster was backtracked.

    " + }, + "BacktrackRequestCreationTime":{ + "shape":"TStamp", + "documentation":"

    The timestamp of the time at which the backtrack was requested.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the backtrack. This property returns one of the following values:

    • applying - The backtrack is currently being applied to or rolled back from the DB cluster.

    • completed - The backtrack has successfully been applied to or rolled back from the DB cluster.

    • failed - An error occurred while the backtrack was applied to or rolled back from the DB cluster.

    • pending - The backtrack is currently pending application to or rollback from the DB cluster.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeDBClusterBacktracks action.

    " + }, + "DBClusterBacktrackList":{ + "type":"list", + "member":{ + "shape":"DBClusterBacktrack", + "locationName":"DBClusterBacktrack" + } + }, + "DBClusterBacktrackMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DescribeDBClusterBacktracks request.

    " + }, + "DBClusterBacktracks":{ + "shape":"DBClusterBacktrackList", + "documentation":"

    Contains a list of backtracks for the user.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBClusterBacktracks action.

    " + }, + "DBClusterBacktrackNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    BacktrackIdentifier doesn't refer to an existing backtrack.

    ", + "error":{ + "code":"DBClusterBacktrackNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterCapacityInfo":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    A user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    " + }, + "PendingCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    A value that specifies the capacity that the DB cluster scales to next.

    " + }, + "CurrentCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    The current capacity of the DB cluster.

    " + }, + "SecondsBeforeTimeout":{ + "shape":"IntegerOptional", + "documentation":"

    The number of seconds before a call to ModifyCurrentDBClusterCapacity times out.

    " + }, + "TimeoutAction":{ + "shape":"String", + "documentation":"

    The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

    " + } + } + }, + "DBClusterEndpoint":{ + "type":"structure", + "members":{ + "DBClusterEndpointIdentifier":{ + "shape":"String", + "documentation":"

    The identifier associated with the endpoint. This parameter is stored as a lowercase string.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    " + }, + "DBClusterEndpointResourceIdentifier":{ + "shape":"String", + "documentation":"

    A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint.

    " + }, + "Endpoint":{ + "shape":"String", + "documentation":"

    The DNS address of the endpoint.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The current status of the endpoint. One of: creating, available, deleting, modifying.

    " + }, + "EndpointType":{ + "shape":"String", + "documentation":"

    The type of the endpoint. One of: READER, WRITER, CUSTOM.

    " + }, + "CustomEndpointType":{ + "shape":"String", + "documentation":"

    The type associated with a custom endpoint. One of: READER, WRITER, ANY.

    " + }, + "StaticMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that are part of the custom endpoint group.

    " + }, + "ExcludedMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    " + }, + "DBClusterEndpointArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the endpoint.

    " + } + }, + "documentation":"

    This data type represents the information you need to connect to an Amazon Aurora DB cluster. This data type is used as a response element in the following actions:

    • CreateDBClusterEndpoint

    • DescribeDBClusterEndpoints

    • ModifyDBClusterEndpoint

    • DeleteDBClusterEndpoint

    For the data structure that represents Amazon RDS DB instance endpoints, see Endpoint.

    " + }, + "DBClusterEndpointAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified custom endpoint can't be created because it already exists.

    ", + "error":{ + "code":"DBClusterEndpointAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterEndpointList":{ + "type":"list", + "member":{ + "shape":"DBClusterEndpoint", + "locationName":"DBClusterEndpointList" + } + }, + "DBClusterEndpointMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBClusterEndpoints":{ + "shape":"DBClusterEndpointList", + "documentation":"

    Contains the details of the endpoints associated with the cluster and matching any filter conditions.

    " + } + } + }, + "DBClusterEndpointNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified custom endpoint doesn't exist.

    ", + "error":{ + "code":"DBClusterEndpointNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterEndpointQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster already has the maximum number of custom endpoints.

    ", + "error":{ + "code":"DBClusterEndpointQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterList":{ + "type":"list", + "member":{ + "shape":"DBCluster", + "locationName":"DBCluster" + } + }, + "DBClusterMember":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the instance identifier for this member of the DB cluster.

    " + }, + "IsClusterWriter":{ + "shape":"Boolean", + "documentation":"

    Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

    " + }, + "DBClusterParameterGroupStatus":{ + "shape":"String", + "documentation":"

    Specifies the status of the DB cluster parameter group for this member of the DB cluster.

    " + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

    " + } + }, + "documentation":"

    Contains information about an instance that is part of a DB cluster.

    ", + "wrapper":true + }, + "DBClusterMemberList":{ + "type":"list", + "member":{ + "shape":"DBClusterMember", + "locationName":"DBClusterMember" + } + }, + "DBClusterMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DescribeDBClusters request.

    " + }, + "DBClusters":{ + "shape":"DBClusterList", + "documentation":"

    Contains a list of DB clusters for the user.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBClusters action.

    " + }, + "DBClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBClusterIdentifier doesn't refer to an existing DB cluster.

    ", + "error":{ + "code":"DBClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterOptionGroupMemberships":{ + "type":"list", + "member":{ + "shape":"DBClusterOptionGroupStatus", + "locationName":"DBClusterOptionGroup" + } + }, + "DBClusterOptionGroupStatus":{ + "type":"structure", + "members":{ + "DBClusterOptionGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB cluster option group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of the DB cluster option group.

    " + } + }, + "documentation":"

    Contains status information for a DB cluster option group.

    " + }, + "DBClusterParameterGroup":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    Provides the name of the DB cluster parameter group.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Provides the customer-specified description for this DB cluster parameter group.

    " + }, + "DBClusterParameterGroupArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB cluster parameter group.

    " + } + }, + "documentation":"

    Contains the details of an Amazon RDS DB cluster parameter group.

    This data type is used as a response element in the DescribeDBClusterParameterGroups action.

    ", + "wrapper":true + }, + "DBClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    Provides a list of parameters for the DB cluster parameter group.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    Provides details about a DB cluster parameter group including the parameters in the DB cluster parameter group.

    " + }, + "DBClusterParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBClusterParameterGroup", + "locationName":"DBClusterParameterGroup" + } + }, + "DBClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    This value is stored as a lowercase string.

    " + } + }, + "documentation":"

    " + }, + "DBClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBClusterParameterGroupName doesn't refer to an existing DB cluster parameter group.

    ", + "error":{ + "code":"DBClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBClusterParameterGroups":{ + "shape":"DBClusterParameterGroupList", + "documentation":"

    A list of DB cluster parameter groups.

    " + } + }, + "documentation":"

    " + }, + "DBClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The user attempted to create a new DB cluster and the user has already reached the maximum allowed DB cluster quota.

    ", + "error":{ + "code":"DBClusterQuotaExceededFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "DBClusterRole":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:

    • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other AWS services on your behalf.

    • PENDING - the IAM role ARN is being associated with the DB cluster.

    • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other AWS services on your behalf.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

    " + } + }, + "documentation":"

    Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.

    " + }, + "DBClusterRoleAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.

    ", + "error":{ + "code":"DBClusterRoleAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified IAM role Amazon Resource Name (ARN) isn't associated with the specified DB cluster.

    ", + "error":{ + "code":"DBClusterRoleNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoleQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.

    ", + "error":{ + "code":"DBClusterRoleQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterRoles":{ + "type":"list", + "member":{ + "shape":"DBClusterRole", + "locationName":"DBClusterRole" + } + }, + "DBClusterSnapshot":{ + "type":"structure", + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

    " + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier for the DB cluster snapshot.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    " + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Specifies the name of the database engine.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size in gibibytes (GiB).

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of this DB cluster snapshot.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the DB cluster was listening on at the time of the snapshot.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VPC ID associated with the DB cluster snapshot.

    " + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Provides the master username for the DB cluster snapshot.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Provides the version of the database engine for this DB cluster snapshot.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    Provides the license model information for this DB cluster snapshot.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    Provides the type of the DB cluster snapshot.

    " + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

    Specifies the percentage of the estimated data that has been transferred.

    " + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the DB cluster snapshot is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.

    " + }, + "DBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB cluster snapshot.

    " + }, + "SourceDBClusterSnapshotArn":{ + "shape":"String", + "documentation":"

    If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    " + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " + } + }, + "documentation":"

    Contains the details for an Amazon RDS DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

    ", + "wrapper":true + }, + "DBClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The user already has a DB cluster snapshot with the given identifier.

    ", + "error":{ + "code":"DBClusterSnapshotAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBClusterSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the manual DB cluster snapshot attribute.

    The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

    " + }, + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

    The value(s) for the manual DB cluster snapshot attribute.

    If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any AWS account to copy or restore.

    " + } + }, + "documentation":"

    Contains the name and values of a manual DB cluster snapshot attribute.

    Manual DB cluster snapshot attributes are used to authorize other AWS accounts to restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

    " + }, + "DBClusterSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshotAttribute", + "locationName":"DBClusterSnapshotAttribute" + } + }, + "DBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the manual DB cluster snapshot that the attributes apply to.

    " + }, + "DBClusterSnapshotAttributes":{ + "shape":"DBClusterSnapshotAttributeList", + "documentation":"

    The list of attributes and values for the manual DB cluster snapshot.

    " + } + }, + "documentation":"

    Contains the results of a successful call to the DescribeDBClusterSnapshotAttributes API action.

    Manual DB cluster snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB cluster snapshot. For more information, see the ModifyDBClusterSnapshotAttribute API action.

    ", + "wrapper":true + }, + "DBClusterSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBClusterSnapshot", + "locationName":"DBClusterSnapshot" + } + }, + "DBClusterSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBClusterSnapshots":{ + "shape":"DBClusterSnapshotList", + "documentation":"

    Provides a list of DB cluster snapshots for the user.

    " + } + }, + "documentation":"

    Provides a list of DB cluster snapshots for the user as the result of a call to the DescribeDBClusterSnapshots action.

    " + }, + "DBClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBClusterSnapshotIdentifier doesn't refer to an existing DB cluster snapshot.

    ", + "error":{ + "code":"DBClusterSnapshotNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBEngineVersion":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group family for the database engine.

    " + }, + "DBEngineDescription":{ + "shape":"String", + "documentation":"

    The description of the database engine.

    " + }, + "DBEngineVersionDescription":{ + "shape":"String", + "documentation":"

    The description of the database engine version.

    " + }, + "DefaultCharacterSet":{ + "shape":"CharacterSet", + "documentation":"

    The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.

    " + }, + "SupportedCharacterSets":{ + "shape":"SupportedCharacterSetsList", + "documentation":"

    A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance action.

    " + }, + "ValidUpgradeTarget":{ + "shape":"ValidUpgradeTargetList", + "documentation":"

    A list of engine versions that this database engine version can be upgraded to.

    " + }, + "SupportedTimezones":{ + "shape":"SupportedTimezonesList", + "documentation":"

    A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.

    " + }, + "ExportableLogTypes":{ + "shape":"LogTypeList", + "documentation":"

    The types of logs that the database engine has available for export to CloudWatch Logs.

    " + }, + "SupportsLogExportsToCloudwatchLogs":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

    " + }, + "SupportsReadReplica":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the database engine version supports Read Replicas.

    " + }, + "SupportedEngineModes":{ + "shape":"EngineModeList", + "documentation":"

    A list of the supported DB engine modes.

    " + }, + "SupportedFeatureNames":{ + "shape":"FeatureNameList", + "documentation":"

    A list of features supported by the DB engine. Supported feature names include the following.

    • s3Import

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB engine version, either available or deprecated.

    " + } + }, + "documentation":"

    This data type is used as a response element in the action DescribeDBEngineVersions.

    " + }, + "DBEngineVersionList":{ + "type":"list", + "member":{ + "shape":"DBEngineVersion", + "locationName":"DBEngineVersion" + } + }, + "DBEngineVersionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBEngineVersions":{ + "shape":"DBEngineVersionList", + "documentation":"

    A list of DBEngineVersion elements.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBEngineVersions action.

    " + }, + "DBInstance":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    Contains the name of the compute and memory capacity class of the DB instance.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Provides the name of the database engine to be used for this DB instance.

    " + }, + "DBInstanceStatus":{ + "shape":"String", + "documentation":"

    Specifies the current state of this database.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Contains the master username for the DB instance.

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The meaning of this parameter differs according to the database engine you use.

    MySQL, MariaDB, SQL Server, PostgreSQL

    Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

    Type: String

    Oracle

    Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

    " + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

    Specifies the connection endpoint.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size specified in gibibytes.

    " + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the date and time the DB instance was created.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    " + }, + "BackupRetentionPeriod":{ + "shape":"Integer", + "documentation":"

    Specifies the number of days for which automatic DB snapshots are retained.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

    A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    " + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    Provides a list of VPC security group elements that the DB instance belongs to.

    " + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupStatusList", + "documentation":"

    Provides the list of DB parameter groups applied to this DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    Specifies the name of the Availability Zone the DB instance is located in.

    " + }, + "DBSubnetGroup":{ + "shape":"DBSubnetGroup", + "documentation":"

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    " + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

    " + }, + "LatestRestorableTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the latest time to which a database can be restored with point-in-time restore.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Specifies if the DB instance is a Multi-AZ deployment.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    Indicates that minor version patches are applied automatically.

    " + }, + "ReadReplicaSourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

    " + }, + "ReadReplicaDBInstanceIdentifiers":{ + "shape":"ReadReplicaDBInstanceIdentifierList", + "documentation":"

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

    " + }, + "ReadReplicaDBClusterIdentifiers":{ + "shape":"ReadReplicaDBClusterIdentifierList", + "documentation":"

    Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a Read Replica. For example, when you create an Aurora Read Replica of an RDS MySQL DB instance, the Aurora MySQL DB cluster for the Aurora Read Replica is shown. This output does not contain information about cross region Aurora Read Replicas.

    Currently, each RDS DB instance can have only one Aurora Read Replica.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for this DB instance.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the Provisioned IOPS (I/O operations per second) value.

    " + }, + "OptionGroupMemberships":{ + "shape":"OptionGroupMembershipList", + "documentation":"

    Provides the list of option group memberships for this DB instance.

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    If present, specifies the name of the character set that this instance is associated with.

    " + }, + "SecondaryAvailabilityZone":{ + "shape":"String", + "documentation":"

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    " + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

    Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

    " + }, + "StatusInfos":{ + "shape":"DBInstanceStatusInfoList", + "documentation":"

    The status of a Read Replica. If the instance isn't a Read Replica, this is blank.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type associated with DB instance.

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which the instance is associated for TDE encryption.

    " + }, + "DbInstancePort":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

    " + }, + "StorageEncrypted":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the DB instance is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

    " + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

    The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

    " + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the CA certificate for this DB instance.

    " + }, + "DomainMemberships":{ + "shape":"DomainMembershipList", + "documentation":"

    The Active Directory Domain membership records associated with the DB instance.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"Boolean", + "documentation":"

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    Amazon Aurora

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.

    " + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    " + }, + "EnhancedMonitoringResourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    " + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

    The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    " + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

    " + }, + "DBInstanceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB instance.

    " + }, + "Timezone":{ + "shape":"String", + "documentation":"

    The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

    " + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    IAM database authentication can be enabled for the following database engines

    • For MySQL 5.6, minor version 5.6.34 or higher

    • For MySQL 5.7, minor version 5.7.16 or higher

    • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

    " + }, + "PerformanceInsightsEnabled":{ + "shape":"BooleanOptional", + "documentation":"

    True if Performance Insights is enabled for the DB instance, and otherwise false.

    " + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    " + }, + "PerformanceInsightsRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + }, + "EnabledCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

    Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon RDS User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "DeletionProtection":{ + "shape":"Boolean", + "documentation":"

    Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.

    " + }, + "AssociatedRoles":{ + "shape":"DBInstanceRoles", + "documentation":"

    The AWS Identity and Access Management (IAM) roles associated with the DB instance.

    " + }, + "ListenerEndpoint":{ + "shape":"Endpoint", + "documentation":"

    Specifies the listener connection endpoint for SQL Server Always On.

    " + }, + "MaxAllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " + } + }, + "documentation":"

    Contains the details of an Amazon RDS DB instance.

    This data type is used as a response element in the DescribeDBInstances action.

    ", + "wrapper":true + }, + "DBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The user already has a DB instance with the given identifier.

    ", + "error":{ + "code":"DBInstanceAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceAutomatedBackup":{ + "type":"structure", + "members":{ + "DBInstanceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the automated backup.

    " + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + }, + "Region":{ + "shape":"String", + "documentation":"

    The AWS Region associated with the automated backup.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer id of the instance that is/was associated with the automated backup.

    " + }, + "RestoreWindow":{ + "shape":"RestoreWindow", + "documentation":"

    Earliest and latest time an instance can be restored to.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size in gibibytes (GiB).

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Provides a list of status information for an automated backup:

    • active - automated backups for current instances

    • retained - automated backups for deleted instances

    • creating - automated backups that are waiting for the first automated snapshot to be available.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    The port number that the automated backup used for connections.

    Default: Inherits from the source DB instance

    Valid Values: 1150-65535

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone that the automated backup was created in. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VPC ID associated with the DB instance

    " + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the date and time that the DB instance was created.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The license model of an automated backup.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine for this automated backup.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version of the database engine for the automated backup.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the automated backup.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The IOPS (I/O operations per second) value for the automated backup.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The option group the automated backup is associated with. If omitted, the default option group for the engine specified is used.

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which the automated backup is associated for TDE encryption.

    " + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the automated backup is encrypted.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type associated with the automated backup.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key ID for an automated backup. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    " + }, + "Timezone":{ + "shape":"String", + "documentation":"

    The time zone of the automated backup. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

    " + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " + } + }, + "documentation":"

    An automated backup of a DB instance. It it consists of system backups, transaction logs, and the database instance properties that existed at the time you deleted the source instance.

    ", + "wrapper":true + }, + "DBInstanceAutomatedBackupList":{ + "type":"list", + "member":{ + "shape":"DBInstanceAutomatedBackup", + "locationName":"DBInstanceAutomatedBackup" + } + }, + "DBInstanceAutomatedBackupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "DBInstanceAutomatedBackups":{ + "shape":"DBInstanceAutomatedBackupList", + "documentation":"

    A list of DBInstanceAutomatedBackup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBInstanceAutomatedBackups action.

    " + }, + "DBInstanceAutomatedBackupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    No automated backup for this DB instance was found.

    ", + "error":{ + "code":"DBInstanceAutomatedBackupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceAutomatedBackupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB Instance quota.

    ", + "error":{ + "code":"DBInstanceAutomatedBackupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceList":{ + "type":"list", + "member":{ + "shape":"DBInstance", + "locationName":"DBInstance" + } + }, + "DBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "DBInstances":{ + "shape":"DBInstanceList", + "documentation":"

    A list of DBInstance instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBInstances action.

    " + }, + "DBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBInstanceIdentifier doesn't refer to an existing DB instance.

    ", + "error":{ + "code":"DBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceRole":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Describes the state of association between the IAM role and the DB instance. The Status property returns one of the following values:

    • ACTIVE - the IAM role ARN is associated with the DB instance and can be used to access other AWS services on your behalf.

    • PENDING - the IAM role ARN is being associated with the DB instance.

    • INVALID - the IAM role ARN is associated with the DB instance, but the DB instance is unable to assume the IAM role in order to access other AWS services on your behalf.

    " + } + }, + "documentation":"

    Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.

    " + }, + "DBInstanceRoleAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified RoleArn or FeatureName value is already associated with the DB instance.

    ", + "error":{ + "code":"DBInstanceRoleAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceRoleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified RoleArn value doesn't match the specified feature for the DB instance.

    ", + "error":{ + "code":"DBInstanceRoleNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBInstanceRoleQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You can't associate any more AWS Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.

    ", + "error":{ + "code":"DBInstanceRoleQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBInstanceRoles":{ + "type":"list", + "member":{ + "shape":"DBInstanceRole", + "locationName":"DBInstanceRole" + } + }, + "DBInstanceStatusInfo":{ + "type":"structure", + "members":{ + "StatusType":{ + "shape":"String", + "documentation":"

    This value is currently \"read replication.\"

    " + }, + "Normal":{ + "shape":"Boolean", + "documentation":"

    Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Status of the DB instance. For a StatusType of Read Replica, the values can be replicating, replication stop point set, replication stop point reached, error, stopped, or terminated.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    Details of the error if there is an error for the instance. If the instance isn't in an error state, this value is blank.

    " + } + }, + "documentation":"

    Provides a list of status information for a DB instance.

    " + }, + "DBInstanceStatusInfoList":{ + "type":"list", + "member":{ + "shape":"DBInstanceStatusInfo", + "locationName":"DBInstanceStatusInfo" + } + }, + "DBLogFileNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    LogFileName doesn't refer to an existing DB log file.

    ", + "error":{ + "code":"DBLogFileNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroup":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group.

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group family that this DB parameter group is compatible with.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Provides the customer-specified description for this DB parameter group.

    " + }, + "DBParameterGroupArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB parameter group.

    " + } + }, + "documentation":"

    Contains the details of an Amazon RDS DB parameter group.

    This data type is used as a response element in the DescribeDBParameterGroups action.

    ", + "wrapper":true + }, + "DBParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A DB parameter group with the same name exists.

    ", + "error":{ + "code":"DBParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    A list of Parameter values.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameters action.

    " + }, + "DBParameterGroupList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroup", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    Provides the name of the DB parameter group.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the ModifyDBParameterGroup or ResetDBParameterGroup action.

    " + }, + "DBParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBParameterGroupName doesn't refer to an existing DB parameter group.

    ", + "error":{ + "code":"DBParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of DB parameter groups.

    ", + "error":{ + "code":"DBParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBParameterGroupStatus":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    " + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

    The status of parameter updates.

    " + } + }, + "documentation":"

    The status of the DB parameter group.

    This data type is used as a response element in the following actions:

    • CreateDBInstance

    • CreateDBInstanceReadReplica

    • DeleteDBInstance

    • ModifyDBInstance

    • RebootDBInstance

    • RestoreDBInstanceFromDBSnapshot

    " + }, + "DBParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"DBParameterGroupStatus", + "locationName":"DBParameterGroup" + } + }, + "DBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBParameterGroups":{ + "shape":"DBParameterGroupList", + "documentation":"

    A list of DBParameterGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBParameterGroups action.

    " + }, + "DBSecurityGroup":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"String", + "documentation":"

    Provides the AWS ID of the owner of a specific DB security group.

    " + }, + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB security group.

    " + }, + "DBSecurityGroupDescription":{ + "shape":"String", + "documentation":"

    Provides the description of the DB security group.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VpcId of the DB security group.

    " + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

    Contains a list of EC2SecurityGroup elements.

    " + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

    Contains a list of IPRange elements.

    " + }, + "DBSecurityGroupArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB security group.

    " + } + }, + "documentation":"

    Contains the details for an Amazon RDS DB security group.

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    ", + "wrapper":true + }, + "DBSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A DB security group with the name specified in DBSecurityGroupName already exists.

    ", + "error":{ + "code":"DBSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupMembership":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB security group.

    " + } + }, + "documentation":"

    This data type is used as a response element in the following actions:

    • ModifyDBInstance

    • RebootDBInstance

    • RestoreDBInstanceFromDBSnapshot

    • RestoreDBInstanceToPointInTime

    " + }, + "DBSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroupMembership", + "locationName":"DBSecurityGroup" + } + }, + "DBSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroups", + "documentation":"

    A list of DBSecurityGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSecurityGroups action.

    " + }, + "DBSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DBSecurityGroupName" + } + }, + "DBSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBSecurityGroupName doesn't refer to an existing DB security group.

    ", + "error":{ + "code":"DBSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A DB security group isn't allowed for this action.

    ", + "error":{ + "code":"DBSecurityGroupNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of DB security groups.

    ", + "error":{ + "code":"QuotaExceeded.DBSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSecurityGroups":{ + "type":"list", + "member":{ + "shape":"DBSecurityGroup", + "locationName":"DBSecurityGroup" + } + }, + "DBSnapshot":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier for the DB snapshot.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

    " + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    Specifies the name of the database engine.

    " + }, + "AllocatedStorage":{ + "shape":"Integer", + "documentation":"

    Specifies the allocated storage size in gibibytes (GiB).

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of this DB snapshot.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the database engine was listening on at the time of the snapshot.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VPC ID associated with the DB snapshot.

    " + }, + "InstanceCreateTime":{ + "shape":"TStamp", + "documentation":"

    Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    Provides the master username for the DB snapshot.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Specifies the version of the database engine.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    Provides the type of the DB snapshot.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Provides the option group name for the DB snapshot.

    " + }, + "PercentProgress":{ + "shape":"Integer", + "documentation":"

    The percentage of the estimated data that has been transferred.

    " + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

    The AWS Region that the DB snapshot was created in or copied from.

    " + }, + "SourceDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has value in case of cross-customer or cross-region copy.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type associated with DB snapshot.

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the DB snapshot is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.

    " + }, + "DBSnapshotArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB snapshot.

    " + }, + "Timezone":{ + "shape":"String", + "documentation":"

    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

    " + }, + "IAMDatabaseAuthenticationEnabled":{ + "shape":"Boolean", + "documentation":"

    True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

    " + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + } + }, + "documentation":"

    Contains the details of an Amazon RDS DB snapshot.

    This data type is used as a response element in the DescribeDBSnapshots action.

    ", + "wrapper":true + }, + "DBSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBSnapshotIdentifier is already used by an existing snapshot.

    ", + "error":{ + "code":"DBSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSnapshotAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the manual DB snapshot attribute.

    The attribute named restore refers to the list of AWS accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

    " + }, + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

    The value or values for the manual DB snapshot attribute.

    If the AttributeName field is set to restore, then this element returns a list of IDs of the AWS accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any AWS account to copy or restore.

    " + } + }, + "documentation":"

    Contains the name and values of a manual DB snapshot attribute

    Manual DB snapshot attributes are used to authorize other AWS accounts to restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API.

    ", + "wrapper":true + }, + "DBSnapshotAttributeList":{ + "type":"list", + "member":{ + "shape":"DBSnapshotAttribute", + "locationName":"DBSnapshotAttribute" + } + }, + "DBSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the manual DB snapshot that the attributes apply to.

    " + }, + "DBSnapshotAttributes":{ + "shape":"DBSnapshotAttributeList", + "documentation":"

    The list of attributes and values for the manual DB snapshot.

    " + } + }, + "documentation":"

    Contains the results of a successful call to the DescribeDBSnapshotAttributes API action.

    Manual DB snapshot attributes are used to authorize other AWS accounts to copy or restore a manual DB snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

    ", + "wrapper":true + }, + "DBSnapshotList":{ + "type":"list", + "member":{ + "shape":"DBSnapshot", + "locationName":"DBSnapshot" + } + }, + "DBSnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSnapshots":{ + "shape":"DBSnapshotList", + "documentation":"

    A list of DBSnapshot instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSnapshots action.

    " + }, + "DBSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

    ", + "error":{ + "code":"DBSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroup":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB subnet group.

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    Provides the description of the DB subnet group.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    Provides the VpcId of the DB subnet group.

    " + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

    Provides the status of the DB subnet group.

    " + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

    Contains a list of Subnet elements.

    " + }, + "DBSubnetGroupArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the DB subnet group.

    " + } + }, + "documentation":"

    Contains the details of an Amazon RDS DB subnet group.

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    ", + "wrapper":true + }, + "DBSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBSubnetGroupName is already used by an existing DB subnet group.

    ", + "error":{ + "code":"DBSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupDoesNotCoverEnoughAZs":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

    ", + "error":{ + "code":"DBSubnetGroupDoesNotCoverEnoughAZs", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DBSubnetGroups":{ + "shape":"DBSubnetGroups", + "documentation":"

    A list of DBSubnetGroup instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

    " + }, + "DBSubnetGroupNotAllowedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DBSubnetGroup shouldn't be specified while creating read replicas that lie in the same region as the source instance.

    ", + "error":{ + "code":"DBSubnetGroupNotAllowedFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    DBSubnetGroupName doesn't refer to an existing DB subnet group.

    ", + "error":{ + "code":"DBSubnetGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of DB subnet groups.

    ", + "error":{ + "code":"DBSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBSubnetGroups":{ + "type":"list", + "member":{ + "shape":"DBSubnetGroup", + "locationName":"DBSubnetGroup" + } + }, + "DBSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of subnets in a DB subnet groups.

    ", + "error":{ + "code":"DBSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DBUpgradeDependencyFailureFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB upgrade failed because a resource the DB depends on can't be modified.

    ", + "error":{ + "code":"DBUpgradeDependencyFailure", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DeleteCustomAvailabilityZoneMessage":{ + "type":"structure", + "required":["CustomAvailabilityZoneId"], + "members":{ + "CustomAvailabilityZoneId":{ + "shape":"String", + "documentation":"

    The custom AZ identifier.

    " + } + } + }, + "DeleteCustomAvailabilityZoneResult":{ + "type":"structure", + "members":{ + "CustomAvailabilityZone":{"shape":"CustomAvailabilityZone"} + } + }, + "DeleteDBClusterEndpointMessage":{ + "type":"structure", + "required":["DBClusterEndpointIdentifier"], + "members":{ + "DBClusterEndpointIdentifier":{ + "shape":"String", + "documentation":"

    The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

    " + } + } + }, + "DeleteDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

    Constraints:

    • Must match an existing DBClusterIdentifier.

    " + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

    " + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

    Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    " + } + }, + "documentation":"

    " + }, + "DeleteDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group.

    Constraints:

    • Must be the name of an existing DB cluster parameter group.

    • You can't delete a default DB cluster parameter group.

    • Can't be associated with any DB clusters.

    " + } + }, + "documentation":"

    " + }, + "DeleteDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "DeleteDBClusterSnapshotMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster snapshot to delete.

    Constraints: Must be the name of an existing DB cluster snapshot in the available state.

    " + } + }, + "documentation":"

    " + }, + "DeleteDBClusterSnapshotResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshot":{"shape":"DBClusterSnapshot"} + } + }, + "DeleteDBInstanceAutomatedBackupMessage":{ + "type":"structure", + "required":["DbiResourceId"], + "members":{ + "DbiResourceId":{ + "shape":"String", + "documentation":"

    The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

    " + } + }, + "documentation":"

    Parameter input for the DeleteDBInstanceAutomatedBackup operation.

    " + }, + "DeleteDBInstanceAutomatedBackupResult":{ + "type":"structure", + "members":{ + "DBInstanceAutomatedBackup":{"shape":"DBInstanceAutomatedBackup"} + } + }, + "DeleteDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

    Constraints:

    • Must match the name of an existing DB instance.

    " + }, + "SkipFinalSnapshot":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip isn't specified, a DB snapshot is created before the DB instance is deleted. By default, skip isn't specified, and the DB snapshot is created.

    Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

    Specify skip when deleting a Read Replica.

    The FinalDBSnapshotIdentifier parameter must be specified if skip isn't specified.

    " + }, + "FinalDBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

    Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

    Constraints:

    • Must be 1 to 255 letters or numbers.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    • Can't be specified when deleting a Read Replica.

    " + }, + "DeleteAutomatedBackups":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "DeleteDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must be the name of an existing DB parameter group

    • You can't delete a default DB parameter group

    • Can't be associated with any DB instances

    " + } + }, + "documentation":"

    " + }, + "DeleteDBSecurityGroupMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to delete.

    You can't delete the default DB security group.

    Constraints:

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    • Must not be \"Default\"

    " + } + }, + "documentation":"

    " + }, + "DeleteDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The DB snapshot identifier.

    Constraints: Must be the name of an existing DB snapshot in the available state.

    " + } + }, + "documentation":"

    " + }, + "DeleteDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "DeleteDBSubnetGroupMessage":{ + "type":"structure", + "required":["DBSubnetGroupName"], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the database subnet group to delete.

    You can't delete the default subnet group.

    Constraints:

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    " + } + }, + "documentation":"

    " + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to delete.

    " + } + }, + "documentation":"

    " + }, + "DeleteEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "DeleteGlobalClusterMessage":{ + "type":"structure", + "required":["GlobalClusterIdentifier"], + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The cluster identifier of the global database cluster being deleted.

    " + } + } + }, + "DeleteGlobalClusterResult":{ + "type":"structure", + "members":{ + "GlobalCluster":{"shape":"GlobalCluster"} + } + }, + "DeleteInstallationMediaMessage":{ + "type":"structure", + "required":["InstallationMediaId"], + "members":{ + "InstallationMediaId":{ + "shape":"String", + "documentation":"

    The installation medium ID.

    " + } + } + }, + "DeleteOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be deleted.

    You can't delete default option groups.

    " + } + }, + "documentation":"

    " + }, + "DescribeAccountAttributesMessage":{ + "type":"structure", + "members":{ + }, + "documentation":"

    " + }, + "DescribeCertificatesMessage":{ + "type":"structure", + "members":{ + "CertificateIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

    Constraints:

    • Must match an existing CertificateIdentifier.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeCertificates request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeCustomAvailabilityZonesMessage":{ + "type":"structure", + "members":{ + "CustomAvailabilityZoneId":{ + "shape":"String", + "documentation":"

    The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more custom AZs to describe.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeDBClusterBacktracksMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the DB cluster to be described. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

    " + }, + "BacktrackIdentifier":{ + "shape":"String", + "documentation":"

    If specified, this value is the backtrack identifier of the backtrack to be described.

    Constraints:

    Example: 123e4567-e89b-12d3-a456-426655440000

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more DB clusters to describe. Supported filters include the following:

    • db-cluster-backtrack-id - Accepts backtrack identifiers. The results list includes information about only the backtracks identified by these identifiers.

    • db-cluster-backtrack-status - Accepts any of the following backtrack status values:

      • applying

      • completed

      • failed

      • pending

      The results list includes information about only the backtracks identified by these values.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterBacktracks request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBClusterEndpointsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

    " + }, + "DBClusterEndpointIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the endpoint to describe. This parameter is stored as a lowercase string.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A set of name-value pairs that define which endpoints to include in the output. The filters are specified as name-value pairs, in the format Name=endpoint_type,Values=endpoint_type1,endpoint_type2,.... Name can be one of: db-cluster-endpoint-type, db-cluster-endpoint-custom-type, db-cluster-endpoint-id, db-cluster-endpoint-status. Values for the db-cluster-endpoint-type filter can be one or more of: reader, writer, custom. Values for the db-cluster-endpoint-custom-type filter can be one or more of: reader, any. Values for the db-cluster-endpoint-status filter can be one or more of: available, creating, deleting, modifying.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterEndpoints request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeDBClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB cluster parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBClusterParametersMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB cluster parameter group to return parameter details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBClusterSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBClusterSnapshotIdentifier"], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB cluster snapshot to describe the attributes for.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBClusterSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "DescribeDBClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBCluster.

    " + }, + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

    Constraints:

    • If supplied, must match the identifier of an existing DBClusterSnapshot.

    • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    The type of DB cluster snapshots to be returned. You can specify one of the following values:

    • automated - Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my AWS account.

    • manual - Return all DB cluster snapshots that have been taken by my AWS account.

    • shared - Return all manual DB cluster snapshots that have been shared to my AWS account.

    • public - Return all DB cluster snapshots that have been marked as public.

    If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more DB cluster snapshots to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs).

    • db-cluster-snapshot-id - Accepts DB cluster snapshot identifiers.

    • snapshot-type - Accepts types of DB cluster snapshots.

    • engine - Accepts names of database engines.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusterSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "IncludeShared":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

    You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

    " + }, + "IncludePublic":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

    You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBClustersMessage":{ + "type":"structure", + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match an existing DBClusterIdentifier.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more DB clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "IncludeShared":{ + "shape":"Boolean", + "documentation":"

    Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBEngineVersionsMessage":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to return.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The database engine version to return.

    Example: 5.1.49

    " + }, + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group family to return details for.

    Constraints:

    • If supplied, must match an existing DBParameterGroupFamily.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "DefaultOnly":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

    " + }, + "ListSupportedCharacterSets":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to list the supported character sets for each engine version.

    If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

    " + }, + "ListSupportedTimezones":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to list the supported time zones for each engine version.

    If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

    " + }, + "IncludeAll":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

    " + } + } + }, + "DescribeDBInstanceAutomatedBackupsMessage":{ + "type":"structure", + "members":{ + "DbiResourceId":{ + "shape":"String", + "documentation":"

    The resource ID of the DB instance that is the source of the automated backup. This parameter isn't case-sensitive.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    (Optional) The user-supplied instance identifier. If this parameter is specified, it must match the identifier of an existing DB instance. It returns information from the specific DB instance' automated backup. This parameter isn't case-sensitive.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies which resources to return based on status.

    Supported filters are the following:

    • status

      • active - automated backups for current instances

      • retained - automated backups for deleted instances

      • creating - automated backups that are waiting for the first automated snapshot to be available

    • db-instance-id - Accepts DB instance identifiers and Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance automated backupss identified by these ARNs.

    • dbi-resource-id - Accepts DB instance resource identifiers and DB Amazon Resource Names (ARNs) for DB instances. The results list includes only information about the DB instance resources identified by these ARNs.

    Returns all resources by default. The status for each resource is specified in the response.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    " + } + }, + "documentation":"

    Parameter input for DescribeDBInstanceAutomatedBackups.

    " + }, + "DescribeDBInstancesMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied instance identifier. If this parameter is specified, information from only the specific DB instance is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBInstance.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more DB instances to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB instances associated with the DB clusters identified by these ARNs.

    • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs). The results list will only include information about the DB instances identified by these ARNs.

    • dbi-resource-id - Accepts DB instance resource identifiers. The results list will only include information about the DB instances identified by these DB instance resource identifiers.

    • domain - Accepts Active Directory directory IDs. The results list will only include information about the DB instances associated with these domains.

    • engine - Accepts engine names. The results list will only include information about the DB instances for these engines.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBInstances request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBLogFilesDetails":{ + "type":"structure", + "members":{ + "LogFileName":{ + "shape":"String", + "documentation":"

    The name of the log file for the specified DB instance.

    " + }, + "LastWritten":{ + "shape":"Long", + "documentation":"

    A POSIX timestamp when the last log entry was written.

    " + }, + "Size":{ + "shape":"Long", + "documentation":"

    The size, in bytes, of the log file for the specified DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element to DescribeDBLogFiles.

    " + }, + "DescribeDBLogFilesList":{ + "type":"list", + "member":{ + "shape":"DescribeDBLogFilesDetails", + "locationName":"DescribeDBLogFilesDetails" + } + }, + "DescribeDBLogFilesMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    " + }, + "FilenameContains":{ + "shape":"String", + "documentation":"

    Filters the available log files for log file names that contain the specified string.

    " + }, + "FileLastWritten":{ + "shape":"Long", + "documentation":"

    Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

    " + }, + "FileSize":{ + "shape":"Long", + "documentation":"

    Filters the available log files for files larger than the specified size.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBLogFilesResponse":{ + "type":"structure", + "members":{ + "DescribeDBLogFiles":{ + "shape":"DescribeDBLogFilesList", + "documentation":"

    The DB log files returned.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DescribeDBLogFiles request.

    " + } + }, + "documentation":"

    The response from a call to DescribeDBLogFiles.

    " + }, + "DescribeDBParameterGroupsMessage":{ + "type":"structure", + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific DB parameter group to return details for.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    The parameter types to return.

    Default: All parameter types returned

    Valid Values: user | system | engine-default

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeDBSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to return details for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSecurityGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBSnapshotAttributesMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot to describe the attributes for.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBSnapshotAttributesResult":{ + "type":"structure", + "members":{ + "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} + } + }, + "DescribeDBSnapshotsMessage":{ + "type":"structure", + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match the identifier of an existing DBInstance.

    " + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

    Constraints:

    • If supplied, must match the identifier of an existing DBSnapshot.

    • If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    The type of snapshots to be returned. You can specify one of the following values:

    • automated - Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS account.

    • manual - Return all DB snapshots that have been taken by my AWS account.

    • shared - Return all manual DB snapshots that have been shared to my AWS account.

    • public - Return all DB snapshots that have been marked as public.

    • awsbackup - Return the DB snapshots managed by the AWS Backup service.

      For information about AWS Backup, see the AWS Backup Developer Guide.

      The awsbackup type does not apply to Aurora.

    If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

    The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more DB snapshots to describe.

    Supported filters:

    • db-instance-id - Accepts DB instance identifiers and DB instance Amazon Resource Names (ARNs).

    • db-snapshot-id - Accepts DB snapshot identifiers.

    • dbi-resource-id - Accepts identifiers of source DB instances.

    • snapshot-type - Accepts types of DB snapshots.

    • engine - Accepts names of database engines.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "IncludeShared":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

    You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

    " + }, + "IncludePublic":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

    You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

    " + }, + "DbiResourceId":{ + "shape":"String", + "documentation":"

    A specific DB resource ID to describe.

    " + } + }, + "documentation":"

    " + }, + "DescribeDBSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB subnet group to return details for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeDBSubnetGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeEngineDefaultClusterParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group family to return engine parameter information for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeEngineDefaultClusterParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeEngineDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEngineDefaultParametersMessage":{ + "type":"structure", + "required":["DBParameterGroupFamily"], + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group family.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeEngineDefaultParametersResult":{ + "type":"structure", + "members":{ + "EngineDefaults":{"shape":"EngineDefaults"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that is generating the events.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + } + }, + "documentation":"

    " + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to describe.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    " + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

    Constraints:

    • If SourceIdentifier is supplied, SourceType must also be provided.

    • If the source type is DBInstance, then a DBInstanceIdentifier must be supplied.

    • If the source type is DBSecurityGroup, a DBSecurityGroupName must be supplied.

    • If the source type is DBParameterGroup, a DBParameterGroupName must be supplied.

    • If the source type is DBSnapshot, a DBSnapshotIdentifier must be supplied.

    • Can't end with a hyphen or contain two consecutive hyphens.

    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    The event source to retrieve events for. If no value is specified, all events are returned.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

    The number of minutes to retrieve events for.

    Default: 60

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories that trigger notifications for a event notification subscription.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeGlobalClustersMessage":{ + "type":"structure", + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

    Constraints:

    • If supplied, must match an existing DBClusterIdentifier.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more global DB clusters to describe.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeInstallationMediaMessage":{ + "type":"structure", + "members":{ + "InstallationMediaId":{ + "shape":"String", + "documentation":"

    The installation medium ID.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more installation media to describe. Supported filters include the following:

    • custom-availability-zone-id - Accepts custom Availability Zone (AZ) identifiers. The results list includes information about only the custom AZs identified by these identifiers.

    • engine - Accepts database engines. The results list includes information about only the database engines identified by these identifiers.

      For more information about the valid engines for installation media, see ImportInstallationMedia.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + } + }, + "DescribeOptionGroupOptionsMessage":{ + "type":"structure", + "required":["EngineName"], + "members":{ + "EngineName":{ + "shape":"String", + "documentation":"

    A required parameter. Options available for the given engine name are described.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    If specified, filters the results to include only options for the specified major engine version.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeOptionGroupsMessage":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Filters the list of option groups to only include groups associated with a specific database engine.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

    " + } + }, + "documentation":"

    " + }, + "DescribeOrderableDBInstanceOptionsMessage":{ + "type":"structure", + "required":["Engine"], + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The name of the engine to retrieve DB instance options for.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

    " + }, + "Vpc":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to show only VPC or non-VPC offerings.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    " + }, + "DescribePendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

    The ARN of a resource to return pending maintenance actions for.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A filter that specifies one or more resources to return pending maintenance actions for.

    Supported filters:

    • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include pending maintenance actions for the DB clusters identified by these ARNs.

    • db-instance-id - Accepts DB instance identifiers and DB instance ARNs. The results list will only include pending maintenance actions for the DB instances identified by these ARNs.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedDBInstancesMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

    " + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

    " + }, + "Duration":{ + "shape":"String", + "documentation":"

    The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " + }, + "LeaseId":{ + "shape":"String", + "documentation":"

    The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedDBInstancesOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

    " + }, + "Duration":{ + "shape":"String", + "documentation":"

    Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration.

    Valid Values: 1 | 3 | 31536000 | 94608000

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description.

    The results show offerings that partially match the filter value.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

    Valid Values: \"Partial Upfront\" | \"All Upfront\" | \"No Upfront\"

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to show only those reservations that support Multi-AZ.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "DescribeSourceRegionsMessage":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

    The source AWS Region name. For example, us-east-1.

    Constraints:

    • Must specify a valid AWS Region name.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeSourceRegions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + } + }, + "documentation":"

    " + }, + "DescribeValidDBInstanceModificationsMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer identifier or the ARN of your DB instance.

    " + } + }, + "documentation":"

    " + }, + "DescribeValidDBInstanceModificationsResult":{ + "type":"structure", + "members":{ + "ValidDBInstanceModificationsMessage":{"shape":"ValidDBInstanceModificationsMessage"} + } + }, + "DomainMembership":{ + "type":"structure", + "members":{ + "Domain":{ + "shape":"String", + "documentation":"

    The identifier of the Active Directory Domain.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

    " + }, + "FQDN":{ + "shape":"String", + "documentation":"

    The fully qualified domain name of the Active Directory Domain.

    " + }, + "IAMRoleName":{ + "shape":"String", + "documentation":"

    The name of the IAM role to be used when making API calls to the Directory Service.

    " + } + }, + "documentation":"

    An Active Directory Domain membership record associated with the DB instance.

    " + }, + "DomainMembershipList":{ + "type":"list", + "member":{ + "shape":"DomainMembership", + "locationName":"DomainMembership" + }, + "documentation":"

    List of Active Directory Domain membership records associated with a DB instance.

    " + }, + "DomainNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Domain doesn't refer to an existing Active Directory domain.

    ", + "error":{ + "code":"DomainNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "Double":{"type":"double"}, + "DoubleOptional":{"type":"double"}, + "DoubleRange":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Double", + "documentation":"

    The minimum value in the range.

    " + }, + "To":{ + "shape":"Double", + "documentation":"

    The maximum value in the range.

    " + } + }, + "documentation":"

    A range of double values.

    " + }, + "DoubleRangeList":{ + "type":"list", + "member":{ + "shape":"DoubleRange", + "locationName":"DoubleRange" + } + }, + "DownloadDBLogFilePortionDetails":{ + "type":"structure", + "members":{ + "LogFileData":{ + "shape":"String", + "documentation":"

    Entries from the specified log file.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

    " + }, + "AdditionalDataPending":{ + "shape":"Boolean", + "documentation":"

    Boolean value that if true, indicates there is more data to be downloaded.

    " + } + }, + "documentation":"

    This data type is used as a response element to DownloadDBLogFilePortion.

    " + }, + "DownloadDBLogFilePortionMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "LogFileName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The customer-assigned name of the DB instance that contains the log files you want to list.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    " + }, + "LogFileName":{ + "shape":"String", + "documentation":"

    The name of the log file to be downloaded.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The pagination token provided in the previous request or \"0\". If the Marker parameter is specified the response includes only records beyond the marker until the end of the file or up to NumberOfLines.

    " + }, + "NumberOfLines":{ + "shape":"Integer", + "documentation":"

    The number of lines to download. If the number of lines specified results in a file over 1 MB in size, the file is truncated at 1 MB in size.

    If the NumberOfLines parameter is specified, then the block of lines returned can be from the beginning or the end of the log file, depending on the value of the Marker parameter.

    • If neither Marker or NumberOfLines are specified, the entire log file is returned up to a maximum of 10000 lines, starting with the most recent log entries first.

    • If NumberOfLines is specified and Marker isn't specified, then the most recent lines from the end of the log file are returned.

    • If Marker is specified as \"0\", then the specified number of lines from the beginning of the log file are returned.

    • You can download the log file in blocks of lines by specifying the size of the block using the NumberOfLines parameter, and by specifying a value of \"0\" for the Marker parameter in your first request. Include the Marker value returned in the response as the Marker value for the next request, continuing until the AdditionalDataPending response element returns false.

    " + } + }, + "documentation":"

    " + }, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Provides the status of the EC2 security group. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the EC2 security group.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    Specifies the id of the EC2 security group.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    Specifies the AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

    " + } + }, + "documentation":"

    This data type is used as a response element in the following actions:

    • AuthorizeDBSecurityGroupIngress

    • DescribeDBSecurityGroups

    • RevokeDBSecurityGroupIngress

    " + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

    Specifies the DNS address of the DB instance.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    Specifies the port that the database engine is listening on.

    " + }, + "HostedZoneId":{ + "shape":"String", + "documentation":"

    Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    " + } + }, + "documentation":"

    This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions:

    • CreateDBInstance

    • DescribeDBInstances

    • DeleteDBInstance

    For the data structure that represents Amazon Aurora DB cluster endpoints, see DBClusterEndpoint.

    " + }, + "EngineDefaults":{ + "type":"structure", + "members":{ + "DBParameterGroupFamily":{ + "shape":"String", + "documentation":"

    Specifies the name of the DB parameter group family that the engine default parameters apply to.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    Contains a list of engine default parameters.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeEngineDefaultParameters action.

    ", + "wrapper":true + }, + "EngineModeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    Provides the identifier for the source of the event.

    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    Specifies the source type for this event.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    Provides the text of this event.

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    Specifies the category for the event.

    " + }, + "Date":{ + "shape":"TStamp", + "documentation":"

    Specifies the date and time of the event.

    " + }, + "SourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the event.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeEvents action.

    " + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The source type that the returned categories belong to

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    The event categories for the specified source type

    " + } + }, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventCategories action.

    ", + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

    A list of EventCategoriesMap data types.

    " + } + }, + "documentation":"

    Data returned from the DescribeEventCategories action.

    " + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

    The AWS customer account associated with the RDS event notification subscription.

    " + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

    The RDS event notification subscription Id.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The topic ARN of the RDS event notification subscription.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the RDS event notification subscription.

    Constraints:

    Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status \"no-permission\" indicates that RDS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

    " + }, + "SubscriptionCreationTime":{ + "shape":"String", + "documentation":"

    The time the RDS event notification subscription was created.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The source type for the RDS event notification subscription.

    " + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

    A list of source IDs for the RDS event notification subscription.

    " + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for the RDS event notification subscription.

    " + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

    A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

    " + }, + "EventSubscriptionArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the event subscription.

    " + } + }, + "documentation":"

    Contains the results of a successful invocation of the DescribeEventSubscriptions action.

    ", + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have reached the maximum number of event subscriptions.

    ", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

    A list of EventSubscriptions data types.

    " + } + }, + "documentation":"

    Data returned by the DescribeEventSubscriptions action.

    " + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + }, + "Events":{ + "shape":"EventList", + "documentation":"

    A list of Event instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeEvents action.

    " + }, + "FailoverDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    A DB cluster identifier to force a failover for. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    " + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The name of the instance to promote to the primary instance.

    You must specify the instance identifier for an Aurora Replica in the DB cluster. For example, mydbcluster-replica1.

    " + } + }, + "documentation":"

    " + }, + "FailoverDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "FeatureNameList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Filter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the filter. Filter names are case-sensitive.

    " + }, + "Values":{ + "shape":"FilterValueList", + "documentation":"

    One or more filter values. Filter values are case-sensitive.

    " + } + }, + "documentation":"

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribePendingMaintenanceActions

    " + }, + "FilterList":{ + "type":"list", + "member":{ + "shape":"Filter", + "locationName":"Filter" + } + }, + "FilterValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"Value" + } + }, + "GlobalCluster":{ + "type":"structure", + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.

    " + }, + "GlobalClusterResourceId":{ + "shape":"String", + "documentation":"

    The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.

    " + }, + "GlobalClusterArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the global database cluster.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Specifies the current state of this global database cluster.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The Aurora database engine used by the global database cluster.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    The default database name within the new global database cluster.

    " + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    The storage encryption setting for the global database cluster.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    The deletion protection setting for the new global database cluster.

    " + }, + "GlobalClusterMembers":{ + "shape":"GlobalClusterMemberList", + "documentation":"

    The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item.

    " + } + }, + "documentation":"

    A data type representing an Aurora global database.

    ", + "wrapper":true + }, + "GlobalClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "error":{ + "code":"GlobalClusterAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "GlobalClusterList":{ + "type":"list", + "member":{ + "shape":"GlobalCluster", + "locationName":"GlobalClusterMember" + } + }, + "GlobalClusterMember":{ + "type":"structure", + "members":{ + "DBClusterArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for each Aurora cluster.

    " + }, + "Readers":{ + "shape":"ReadersArnList", + "documentation":"

    The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Aurora global database.

    " + }, + "IsWriter":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

    " + } + }, + "documentation":"

    A data structure with information about any primary and secondary clusters associated with an Aurora global database.

    ", + "wrapper":true + }, + "GlobalClusterMemberList":{ + "type":"list", + "member":{ + "shape":"GlobalClusterMember", + "locationName":"GlobalClusterMember" + } + }, + "GlobalClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "error":{ + "code":"GlobalClusterNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "GlobalClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "error":{ + "code":"GlobalClusterQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "GlobalClustersMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeGlobalClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "GlobalClusters":{ + "shape":"GlobalClusterList", + "documentation":"

    The list of global clusters returned by this request.

    " + } + } + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Specifies the status of the IP range. Status can be \"authorizing\", \"authorized\", \"revoking\", and \"revoked\".

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    Specifies the IP range.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeDBSecurityGroups action.

    " + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "ImportInstallationMediaMessage":{ + "type":"structure", + "required":[ + "CustomAvailabilityZoneId", + "Engine", + "EngineVersion", + "EngineInstallationMediaPath", + "OSInstallationMediaPath" + ], + "members":{ + "CustomAvailabilityZoneId":{ + "shape":"String", + "documentation":"

    The identifier of the custom Availability Zone (AZ) to import the installation media to.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for this instance.

    The list only includes supported DB engines that require an on-premises customer provided license.

    Valid Values:

    • sqlserver-ee

    • sqlserver-se

    • sqlserver-ex

    • sqlserver-web

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use.

    For a list of valid engine versions, call DescribeDBEngineVersions.

    The following are the database engines and links to information about the major and minor versions. The list only includes DB engines that require an on-premises customer provided license.

    Microsoft SQL Server

    See Version and Feature Support on Amazon RDS in the Amazon RDS User Guide.

    " + }, + "EngineInstallationMediaPath":{ + "shape":"String", + "documentation":"

    The path to the installation medium for the specified DB engine.

    Example: SQLServerISO/en_sql_server_2016_enterprise_x64_dvd_8701793.iso

    " + }, + "OSInstallationMediaPath":{ + "shape":"String", + "documentation":"

    The path to the installation medium for the operating system associated with the specified DB engine.

    Example: WindowsISO/en_windows_server_2016_x64_dvd_9327751.iso

    " + } + } + }, + "InstallationMedia":{ + "type":"structure", + "members":{ + "InstallationMediaId":{ + "shape":"String", + "documentation":"

    The installation medium ID.

    " + }, + "CustomAvailabilityZoneId":{ + "shape":"String", + "documentation":"

    The custom Availability Zone (AZ) that contains the installation media.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The DB engine.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version of the DB engine.

    " + }, + "EngineInstallationMediaPath":{ + "shape":"String", + "documentation":"

    The path to the installation medium for the DB engine.

    " + }, + "OSInstallationMediaPath":{ + "shape":"String", + "documentation":"

    The path to the installation medium for the operating system associated with the DB engine.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the installation medium.

    " + }, + "FailureCause":{ + "shape":"InstallationMediaFailureCause", + "documentation":"

    If an installation media failure occurred, the cause of the failure.

    " + } + }, + "documentation":"

    Contains the installation media for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    " + }, + "InstallationMediaAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified installation medium has already been imported.

    ", + "error":{ + "code":"InstallationMediaAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InstallationMediaFailureCause":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

    The reason that an installation media import failed.

    " + } + }, + "documentation":"

    Contains the cause of an installation media failure. Installation media is used for a DB engine that requires an on-premises customer provided license, such as Microsoft SQL Server.

    " + }, + "InstallationMediaList":{ + "type":"list", + "member":{ + "shape":"InstallationMedia", + "locationName":"InstallationMedia" + } + }, + "InstallationMediaMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeInstallationMedia request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "InstallationMedia":{ + "shape":"InstallationMediaList", + "documentation":"

    The list of InstallationMedia objects for the AWS account.

    " + } + } + }, + "InstallationMediaNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    InstallationMediaID doesn't refer to an existing installation medium.

    ", + "error":{ + "code":"InstallationMediaNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "InstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of DB instances.

    ", + "error":{ + "code":"InstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB cluster doesn't have enough capacity for the current operation.

    ", + "error":{ + "code":"InsufficientDBClusterCapacityFault", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InsufficientDBInstanceCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified DB instance class isn't available in the specified Availability Zone.

    ", + "error":{ + "code":"InsufficientDBInstanceCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientStorageClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is insufficient storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

    ", + "error":{ + "code":"InsufficientStorageClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidDBClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Capacity isn't a valid Aurora Serverless DB cluster capacity. Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

    ", + "error":{ + "code":"InvalidDBClusterCapacityFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterEndpointStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested operation can't be performed on the endpoint while the endpoint is in this state.

    ", + "error":{ + "code":"InvalidDBClusterEndpointStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The supplied value isn't a valid DB cluster snapshot state.

    ", + "error":{ + "code":"InvalidDBClusterSnapshotStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested operation can't be performed while the cluster is in this state.

    ", + "error":{ + "code":"InvalidDBClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBInstanceAutomatedBackupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.

    ", + "error":{ + "code":"InvalidDBInstanceAutomatedBackupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBInstanceStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB instance isn't in a valid state.

    ", + "error":{ + "code":"InvalidDBInstanceState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.

    ", + "error":{ + "code":"InvalidDBParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The state of the DB security group doesn't allow deletion.

    ", + "error":{ + "code":"InvalidDBSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The state of the DB snapshot doesn't allow deletion.

    ", + "error":{ + "code":"InvalidDBSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DBSubnetGroup doesn't belong to the same VPC as that of an existing cross-region read replica of the same source instance.

    ", + "error":{ + "code":"InvalidDBSubnetGroupFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB subnet group cannot be deleted because it's in use.

    ", + "error":{ + "code":"InvalidDBSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDBSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB subnet isn't in the available state.

    ", + "error":{ + "code":"InvalidDBSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidEventSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    This error can occur if someone else is modifying a subscription. You should retry the action.

    ", + "error":{ + "code":"InvalidEventSubscriptionState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidGlobalClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "error":{ + "code":"InvalidGlobalClusterStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidOptionGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The option group isn't in the available state.

    ", + "error":{ + "code":"InvalidOptionGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Cannot restore from VPC backup to non-VPC DB instance.

    ", + "error":{ + "code":"InvalidRestoreFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidS3BucketFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified Amazon S3 bucket name can't be found or Amazon RDS isn't authorized to access the specified Amazon S3 bucket. Verify the SourceS3BucketName and S3IngestionRoleArn values and try again.

    ", + "error":{ + "code":"InvalidS3BucketFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.

    ", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB subnet group doesn't cover all Availability Zones after it's created because of users' change.

    ", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSKeyNotAccessibleFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An error occurred accessing an AWS KMS key.

    ", + "error":{ + "code":"KMSKeyNotAccessibleFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceMessage":{ + "type":"structure", + "required":["ResourceName"], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    This parameter isn't currently supported.

    " + } + }, + "documentation":"

    " + }, + "LogTypeList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Long":{"type":"long"}, + "LongOptional":{"type":"long"}, + "MinimumEngineVersionPerAllowedValue":{ + "type":"structure", + "members":{ + "AllowedValue":{ + "shape":"String", + "documentation":"

    The allowed value for an option setting.

    " + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

    The minimum DB engine version required for the allowed value.

    " + } + }, + "documentation":"

    The minimum DB engine version required for each corresponding allowed value for an option setting.

    " + }, + "MinimumEngineVersionPerAllowedValueList":{ + "type":"list", + "member":{ + "shape":"MinimumEngineVersionPerAllowedValue", + "locationName":"MinimumEngineVersionPerAllowedValue" + } + }, + "ModifyCurrentDBClusterCapacityMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DB cluster.

    " + }, + "Capacity":{ + "shape":"IntegerOptional", + "documentation":"

    The DB cluster capacity.

    When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

    Constraints:

    • Value must be 1, 2, 4, 8, 16, 32, 64, 128, or 256.

    " + }, + "SecondsBeforeTimeout":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

    • Value must be from 10 through 600.

    " + }, + "TimeoutAction":{ + "shape":"String", + "documentation":"

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

    RollbackCapacityChange ignores the capacity change if a scaling point isn't found in the timeout period.

    " + } + } + }, + "ModifyDBClusterEndpointMessage":{ + "type":"structure", + "required":["DBClusterEndpointIdentifier"], + "members":{ + "DBClusterEndpointIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the endpoint to modify. This parameter is stored as a lowercase string.

    " + }, + "EndpointType":{ + "shape":"String", + "documentation":"

    The type of the endpoint. One of: READER, WRITER, ANY.

    " + }, + "StaticMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that are part of the custom endpoint group.

    " + }, + "ExcludedMembers":{ + "shape":"StringList", + "documentation":"

    List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

    " + } + } + }, + "ModifyDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier for the cluster being modified. This parameter isn't case-sensitive.

    Constraints: This identifier must match the identifier of an existing DB cluster.

    " + }, + "NewDBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • The first character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is disabled, changes to the DB cluster are applied during the next maintenance window.

    The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

    By default, this parameter is disabled.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    " + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to use for the DB cluster.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VPC security groups that the DB cluster will belong to.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the DB cluster accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB cluster.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    Constraints: Must contain from 8 to 41 characters.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    " + }, + "CloudwatchLogsExportConfiguration":{ + "shape":"CloudwatchLogsExportConfiguration", + "documentation":"

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"

    " + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether major version upgrades are allowed.

    Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.

    " + }, + "DBInstanceParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to apply to all instances of the DB cluster.

    When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

    Default: The existing name setting

    Constraints:

    • The DB parameter group must be in the same DB parameter group family as this DB cluster.

    • The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

    " + }, + "ScalingConfiguration":{ + "shape":"ScalingConfiguration", + "documentation":"

    The scaling properties of the DB cluster. You can only modify scaling properties for DB clusters in serverless DB engine mode.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    " + }, + "EnableHttpEndpoint":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBClusterParameterGroupName", + "Parameters" + ], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to modify.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    A list of parameters in the DB cluster parameter group to modify.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "ModifyDBClusterSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBClusterSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB cluster snapshot to modify the attributes for.

    " + }, + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster snapshot attribute to modify.

    To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

    " + }, + "ValuesToAdd":{ + "shape":"AttributeValueList", + "documentation":"

    A list of DB cluster snapshot attributes to add to the attribute specified by AttributeName.

    To authorize other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB cluster snapshot restorable by any AWS account. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts.

    " + }, + "ValuesToRemove":{ + "shape":"AttributeValueList", + "documentation":"

    A list of DB cluster snapshot attributes to remove from the attribute specified by AttributeName.

    To remove authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB cluster snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore a manual DB cluster snapshot.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBClusterSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBClusterSnapshotAttributesResult":{"shape":"DBClusterSnapshotAttributesResult"} + } + }, + "ModifyDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The new amount of storage (in gibibytes) to allocate for the DB instance.

    For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    For the valid values for allocated storage for each engine, see CreateDBInstance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

    Default: Uses existing setting

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

    Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetGroup

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible.

    Constraints:

    • If supplied, must match existing DBSecurityGroups.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible.

    Amazon Aurora

    Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Constraints:

    • If supplied, must match existing VpcSecurityGroupIds.

    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.

    If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    Amazon Aurora

    Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

    Default: Uses existing setting

    MariaDB

    Constraints: Must contain from 8 to 41 characters.

    Microsoft SQL Server

    Constraints: Must contain from 8 to 128 characters.

    MySQL

    Constraints: Must contain from 8 to 41 characters.

    Oracle

    Constraints: Must contain from 8 to 30 characters.

    PostgreSQL

    Constraints: Must contain from 8 to 128 characters.

    Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes isn't applied during the next maintenance window.

    Default: Uses existing setting

    Constraints: The DB parameter group must be in the same DB parameter group family as this DB instance.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

    Amazon Aurora

    Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Default: Uses existing setting

    Constraints:

    • Must be a value from 0 to 35

    • Can be specified for a MySQL Read Replica only if the source is running MySQL 5.6 or later

    • Can be specified for a PostgreSQL Read Replica only if the source is running PostgreSQL 9.3.5

    • Can't be set to 0 if the DB instance is a source to Read Replicas

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

    Amazon Aurora

    Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi

    • Must be in Universal Time Coordinated (UTC)

    • Must not conflict with the preferred maintenance window

    • Must be at least 30 minutes

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter doesn't result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If there are pending actions that cause a reboot, and the maintenance window is changed to include the current time, then changing this parameter will cause a reboot of the DB instance. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.

    Default: Uses existing setting

    Format: ddd:hh24:mi-ddd:hh24:mi

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is eanbled for this request.

    For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

    For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    " + }, + "AllowMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

    Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. Changing this parameter doesn't result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model for the DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

    Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

    Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

    Default: Uses existing setting

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + }, + "NewDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • The first character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

    If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

    Valid values: standard | gp2 | io1

    Default: io1 if the Iops parameter is specified, otherwise gp2

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the key store in order to access the device.

    " + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

    Indicates the certificate that needs to be associated with the instance.

    " + }, + "Domain":{ + "shape":"String", + "documentation":"

    The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

    For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

    For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    Amazon Aurora

    Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see ModifyDBCluster.

    " + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    " + }, + "DBPortNumber":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.

    Your database will restart when you change the DBPortNumber value regardless of the value of the ApplyImmediately parameter.

    MySQL

    Default: 3306

    Valid Values: 1150-65535

    MariaDB

    Default: 3306

    Valid Values: 1150-65535

    PostgreSQL

    Default: 5432

    Valid Values: 1150-65535

    Type: Integer

    Oracle

    Default: 1521

    Valid Values: 1150-65535

    SQL Server

    Default: 1433

    Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

    Amazon Aurora

    Default: 3306

    Valid Values: 1150-65535

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

    PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

    Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

    " + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

    The name of the IAM role to use when making API calls to the Directory Service.

    " + }, + "PromotionTier":{ + "shape":"IntegerOptional", + "documentation":"

    A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.

    Default: 1

    Valid Values: 0 - 15

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable Performance Insights for the DB instance.

    For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

    " + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "PerformanceInsightsRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + }, + "CloudwatchLogsExportConfiguration":{ + "shape":"CloudwatchLogsExportConfiguration", + "documentation":"

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance.

    A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "UseDefaultProcessorFeatures":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + }, + "MaxAllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ModifyDBParameterGroupMessage":{ + "type":"structure", + "required":[ + "DBParameterGroupName", + "Parameters" + ], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be modified in a single request.

    Valid Values (for the application method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBSnapshotAttributeMessage":{ + "type":"structure", + "required":[ + "DBSnapshotIdentifier", + "AttributeName" + ], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot to modify the attributes for.

    " + }, + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the DB snapshot attribute to modify.

    To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

    " + }, + "ValuesToAdd":{ + "shape":"AttributeValueList", + "documentation":"

    A list of DB snapshot attributes to add to the attribute specified by AttributeName.

    To authorize other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account IDs, or all to make the manual DB snapshot restorable by any AWS account. Do not add the all value for any manual DB snapshots that contain private information that you don't want available to all AWS accounts.

    " + }, + "ValuesToRemove":{ + "shape":"AttributeValueList", + "documentation":"

    A list of DB snapshot attributes to remove from the attribute specified by AttributeName.

    To remove authorization for other AWS accounts to copy or restore a manual snapshot, set this list to include one or more AWS account identifiers, or all to remove authorization for any AWS account to copy or restore the DB snapshot. If you specify all, an AWS account whose account ID is explicitly added to the restore attribute can still copy or restore the manual DB snapshot.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBSnapshotAttributeResult":{ + "type":"structure", + "members":{ + "DBSnapshotAttributesResult":{"shape":"DBSnapshotAttributesResult"} + } + }, + "ModifyDBSnapshotMessage":{ + "type":"structure", + "required":["DBSnapshotIdentifier"], + "members":{ + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB snapshot to modify.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version to upgrade the DB snapshot to.

    The following are the database engines and engine versions that are available when you upgrade a DB snapshot.

    MySQL

    • 5.5.46 (supported for 5.1 DB snapshots)

    Oracle

    • 12.1.0.2.v8 (supported for 12.1.0.1 DB snapshots)

    • 11.2.0.4.v12 (supported for 11.2.0.2 DB snapshots)

    • 11.2.0.4.v11 (supported for 11.2.0.3 DB snapshots)

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The option group to identify with the upgraded DB snapshot.

    You can specify this parameter when you upgrade an Oracle DB snapshot. The same option group considerations apply when upgrading a DB snapshot as when upgrading a DB instance. For more information, see Option Group Considerations in the Amazon RDS User Guide.

    " + } + } + }, + "ModifyDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBSnapshot":{"shape":"DBSnapshot"} + } + }, + "ModifyDBSubnetGroupMessage":{ + "type":"structure", + "required":[ + "DBSubnetGroupName", + "SubnetIds" + ], + "members":{ + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name for the DB subnet group. This value is stored as a lowercase string. You can't modify the default subnet group.

    Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

    Example: mySubnetgroup

    " + }, + "DBSubnetGroupDescription":{ + "shape":"String", + "documentation":"

    The description for the DB subnet group.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    The EC2 subnet IDs for the DB subnet group.

    " + } + }, + "documentation":"

    " + }, + "ModifyDBSubnetGroupResult":{ + "type":"structure", + "members":{ + "DBSubnetGroup":{"shape":"DBSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. If this value isn't specified, all events are returned.

    Valid values: db-instance | db-parameter-group | db-security-group | db-snapshot

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.

    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to activate the subscription.

    " + } + }, + "documentation":"

    " + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifyGlobalClusterMessage":{ + "type":"structure", + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier for the global cluster being modified. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing global database cluster.

    " + }, + "NewGlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The new cluster identifier for the global database cluster when modifying a global database cluster. This value is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • The first character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-cluster2

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

    " + } + } + }, + "ModifyGlobalClusterResult":{ + "type":"structure", + "members":{ + "GlobalCluster":{"shape":"GlobalCluster"} + } + }, + "ModifyOptionGroupMessage":{ + "type":"structure", + "required":["OptionGroupName"], + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be modified.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + }, + "OptionsToInclude":{ + "shape":"OptionConfigurationList", + "documentation":"

    Options in this list are added to the option group or, if already present, the specified configuration is used to update the existing configuration.

    " + }, + "OptionsToRemove":{ + "shape":"OptionNamesList", + "documentation":"

    Options in this list are removed from the option group.

    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

    " + } + }, + "documentation":"

    " + }, + "ModifyOptionGroupResult":{ + "type":"structure", + "members":{ + "OptionGroup":{"shape":"OptionGroup"} + } + }, + "Option":{ + "type":"structure", + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

    The name of the option.

    " + }, + "OptionDescription":{ + "shape":"String", + "documentation":"

    The description of the option.

    " + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

    Indicate if this option is persistent.

    " + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

    Indicate if this option is permanent.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    If required, the port configured for this option to use.

    " + }, + "OptionVersion":{ + "shape":"String", + "documentation":"

    The version of the option.

    " + }, + "OptionSettings":{ + "shape":"OptionSettingConfigurationList", + "documentation":"

    The option settings for this option.

    " + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupMembershipList", + "documentation":"

    If the option requires access to a port, then this DB security group allows access to the port.

    " + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    If the option requires access to a port, then this VPC security group allows access to the port.

    " + } + }, + "documentation":"

    Option details.

    " + }, + "OptionConfiguration":{ + "type":"structure", + "required":["OptionName"], + "members":{ + "OptionName":{ + "shape":"String", + "documentation":"

    The configuration of options to include in a group.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The optional port for the option.

    " + }, + "OptionVersion":{ + "shape":"String", + "documentation":"

    The version for the option.

    " + }, + "DBSecurityGroupMemberships":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DBSecurityGroupMembership name strings used for this option.

    " + }, + "VpcSecurityGroupMemberships":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VpcSecurityGroupMembership name strings used for this option.

    " + }, + "OptionSettings":{ + "shape":"OptionSettingsList", + "documentation":"

    The option settings to include in an option group.

    " + } + }, + "documentation":"

    A list of all available options

    " + }, + "OptionConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionConfiguration", + "locationName":"OptionConfiguration" + } + }, + "OptionGroup":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    Specifies the name of the option group.

    " + }, + "OptionGroupDescription":{ + "shape":"String", + "documentation":"

    Provides a description of the option group.

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    Indicates the name of the engine that this option group can be applied to.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the major engine version associated with this option group.

    " + }, + "Options":{ + "shape":"OptionsList", + "documentation":"

    Indicates what options are available in the option group.

    " + }, + "AllowsVpcAndNonVpcInstanceMemberships":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this option group can be applied to both VPC and non-VPC instances. The value true indicates the option group can be applied to both VPC and non-VPC instances.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    If AllowsVpcAndNonVpcInstanceMemberships is false, this field is blank. If AllowsVpcAndNonVpcInstanceMemberships is true and this field is blank, then this option group can be applied to both VPC and non-VPC instances. If this field contains a value, then this option group can only be applied to instances that are in the VPC indicated by this field.

    " + }, + "OptionGroupArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the option group.

    " + } + }, + "documentation":"

    ", + "wrapper":true + }, + "OptionGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The option group you are trying to create already exists.

    ", + "error":{ + "code":"OptionGroupAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroupMembership":{ + "type":"structure", + "members":{ + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group that the instance belongs to.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the DB instance's option group membership. Valid values are: in-sync, pending-apply, pending-removal, pending-maintenance-apply, pending-maintenance-removal, applying, removing, and failed.

    " + } + }, + "documentation":"

    Provides information on the option groups the DB instance is a member of.

    " + }, + "OptionGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"OptionGroupMembership", + "locationName":"OptionGroupMembership" + } + }, + "OptionGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified option group could not be found.

    ", + "error":{ + "code":"OptionGroupNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptionGroupOption":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the option.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the option.

    " + }, + "EngineName":{ + "shape":"String", + "documentation":"

    The name of the engine that this option can be applied to.

    " + }, + "MajorEngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the major engine version that the option is available for.

    " + }, + "MinimumRequiredMinorEngineVersion":{ + "shape":"String", + "documentation":"

    The minimum required engine version for the option to be applied.

    " + }, + "PortRequired":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the option requires a port.

    " + }, + "DefaultPort":{ + "shape":"IntegerOptional", + "documentation":"

    If the option requires a port, specifies the default port for the option.

    " + }, + "OptionsDependedOn":{ + "shape":"OptionsDependedOn", + "documentation":"

    The options that are prerequisites for this option.

    " + }, + "OptionsConflictsWith":{ + "shape":"OptionsConflictsWith", + "documentation":"

    The options that conflict with this option.

    " + }, + "Persistent":{ + "shape":"Boolean", + "documentation":"

    Persistent options can't be removed from an option group while DB instances are associated with the option group. If you disassociate all DB instances from the option group, your can remove the persistent option from the option group.

    " + }, + "Permanent":{ + "shape":"Boolean", + "documentation":"

    Permanent options can never be removed from an option group. An option group containing a permanent option can't be removed from a DB instance.

    " + }, + "RequiresAutoMinorEngineVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    If true, you must enable the Auto Minor Version Upgrade setting for your DB instance before you can use this option. You can enable Auto Minor Version Upgrade when you first create your DB instance, or by modifying your DB instance later.

    " + }, + "VpcOnly":{ + "shape":"Boolean", + "documentation":"

    If true, you can only use this option with a DB instance that is in a VPC.

    " + }, + "SupportsOptionVersionDowngrade":{ + "shape":"BooleanOptional", + "documentation":"

    If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

    " + }, + "OptionGroupOptionSettings":{ + "shape":"OptionGroupOptionSettingsList", + "documentation":"

    The option settings that are available (and the default value) for each option in an option group.

    " + }, + "OptionGroupOptionVersions":{ + "shape":"OptionGroupOptionVersionsList", + "documentation":"

    The versions that are available for the option.

    " + } + }, + "documentation":"

    Available option.

    " + }, + "OptionGroupOptionSetting":{ + "type":"structure", + "members":{ + "SettingName":{ + "shape":"String", + "documentation":"

    The name of the option group option.

    " + }, + "SettingDescription":{ + "shape":"String", + "documentation":"

    The description of the option group option.

    " + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

    The default value for the option group option.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    The DB engine specific parameter type for the option group option.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    Indicates the acceptable values for the option group option.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    Boolean value where true indicates that this option group option can be changed from the default value.

    " + }, + "IsRequired":{ + "shape":"Boolean", + "documentation":"

    Boolean value where true indicates that a value must be specified for this option setting of the option group option.

    " + }, + "MinimumEngineVersionPerAllowedValue":{ + "shape":"MinimumEngineVersionPerAllowedValueList", + "documentation":"

    The minimum DB engine version required for the corresponding allowed value for this option setting.

    " + } + }, + "documentation":"

    Option group option settings are used to display settings available for each option with their default values and other information. These values are used with the DescribeOptionGroupOptions action.

    " + }, + "OptionGroupOptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOptionSetting", + "locationName":"OptionGroupOptionSetting" + } + }, + "OptionGroupOptionVersionsList":{ + "type":"list", + "member":{ + "shape":"OptionVersion", + "locationName":"OptionVersion" + } + }, + "OptionGroupOptionsList":{ + "type":"list", + "member":{ + "shape":"OptionGroupOption", + "locationName":"OptionGroupOption" + }, + "documentation":"

    List of available option group options.

    " + }, + "OptionGroupOptionsMessage":{ + "type":"structure", + "members":{ + "OptionGroupOptions":{"shape":"OptionGroupOptionsList"}, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    " + }, + "OptionGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The quota of 20 option groups was exceeded for this AWS account.

    ", + "error":{ + "code":"OptionGroupQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OptionGroups":{ + "type":"structure", + "members":{ + "OptionGroupsList":{ + "shape":"OptionGroupsList", + "documentation":"

    List of option groups.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + } + }, + "documentation":"

    List of option groups.

    " + }, + "OptionGroupsList":{ + "type":"list", + "member":{ + "shape":"OptionGroup", + "locationName":"OptionGroup" + } + }, + "OptionNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OptionSetting":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the option that has settings that you can set.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The current value of the option setting.

    " + }, + "DefaultValue":{ + "shape":"String", + "documentation":"

    The default value of the option setting.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the option setting.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    The DB engine specific parameter type.

    " + }, + "DataType":{ + "shape":"String", + "documentation":"

    The data type of the option setting.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    The allowed values of the option setting.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    A Boolean value that, when true, indicates the option setting can be modified from the default.

    " + }, + "IsCollection":{ + "shape":"Boolean", + "documentation":"

    Indicates if the option setting is part of a collection.

    " + } + }, + "documentation":"

    Option settings are the actual settings being applied or configured for that option. It is used when you modify an option group or describe option groups. For example, the NATIVE_NETWORK_ENCRYPTION option has a setting called SQLNET.ENCRYPTION_SERVER that can have several different values.

    " + }, + "OptionSettingConfigurationList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionSettingsList":{ + "type":"list", + "member":{ + "shape":"OptionSetting", + "locationName":"OptionSetting" + } + }, + "OptionVersion":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"String", + "documentation":"

    The version of the option.

    " + }, + "IsDefault":{ + "shape":"Boolean", + "documentation":"

    True if the version is the default version of the option, and otherwise false.

    " + } + }, + "documentation":"

    The version for an option. Option group option versions are returned by the DescribeOptionGroupOptions action.

    " + }, + "OptionsConflictsWith":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionConflictName" + } + }, + "OptionsDependedOn":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"OptionName" + } + }, + "OptionsList":{ + "type":"list", + "member":{ + "shape":"Option", + "locationName":"Option" + } + }, + "OrderableDBInstanceOption":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The engine type of a DB instance.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The engine version of a DB instance.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class for a DB instance.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model for a DB instance.

    " + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

    A list of Availability Zones for a DB instance.

    " + }, + "MultiAZCapable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance is Multi-AZ capable.

    " + }, + "ReadReplicaCapable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance can have a Read Replica.

    " + }, + "Vpc":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance is in a VPC.

    " + }, + "SupportsStorageEncryption":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance supports encrypted storage.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Indicates the storage type for a DB instance.

    " + }, + "SupportsIops":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance supports provisioned IOPS.

    " + }, + "SupportsEnhancedMonitoring":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

    " + }, + "SupportsIAMDatabaseAuthentication":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a DB instance supports IAM database authentication.

    " + }, + "SupportsPerformanceInsights":{ + "shape":"Boolean", + "documentation":"

    True if a DB instance supports Performance Insights, otherwise false.

    " + }, + "MinStorageSize":{ + "shape":"IntegerOptional", + "documentation":"

    Minimum storage size for a DB instance.

    " + }, + "MaxStorageSize":{ + "shape":"IntegerOptional", + "documentation":"

    Maximum storage size for a DB instance.

    " + }, + "MinIopsPerDbInstance":{ + "shape":"IntegerOptional", + "documentation":"

    Minimum total provisioned IOPS for a DB instance.

    " + }, + "MaxIopsPerDbInstance":{ + "shape":"IntegerOptional", + "documentation":"

    Maximum total provisioned IOPS for a DB instance.

    " + }, + "MinIopsPerGib":{ + "shape":"DoubleOptional", + "documentation":"

    Minimum provisioned IOPS per GiB for a DB instance.

    " + }, + "MaxIopsPerGib":{ + "shape":"DoubleOptional", + "documentation":"

    Maximum provisioned IOPS per GiB for a DB instance.

    " + }, + "AvailableProcessorFeatures":{ + "shape":"AvailableProcessorFeatureList", + "documentation":"

    A list of the available processor features for the DB instance class of a DB instance.

    " + }, + "SupportedEngineModes":{ + "shape":"EngineModeList", + "documentation":"

    A list of the supported DB engine modes.

    " + }, + "SupportsStorageAutoscaling":{ + "shape":"BooleanOptional", + "documentation":"

    Whether or not Amazon RDS can automatically scale storage for DB instances that use the specified instance class.

    " + }, + "SupportsKerberosAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    Whether a DB instance supports Kerberos Authentication.

    " + } + }, + "documentation":"

    Contains a list of available options for a DB instance.

    This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

    ", + "wrapper":true + }, + "OrderableDBInstanceOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableDBInstanceOption", + "locationName":"OrderableDBInstanceOption" + } + }, + "OrderableDBInstanceOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableDBInstanceOptions":{ + "shape":"OrderableDBInstanceOptionsList", + "documentation":"

    An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

    " + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

    Specifies the name of the parameter.

    " + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

    Specifies the value of the parameter.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Provides a description of the parameter.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    Indicates the source of the parameter value.

    " + }, + "ApplyType":{ + "shape":"String", + "documentation":"

    Specifies the engine specific parameters type.

    " + }, + "DataType":{ + "shape":"String", + "documentation":"

    Specifies the valid data type for the parameter.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    Specifies the valid range of values for the parameter.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    " + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

    The earliest engine version to which the parameter can apply.

    " + }, + "ApplyMethod":{ + "shape":"ApplyMethod", + "documentation":"

    Indicates when to apply parameter updates.

    " + }, + "SupportedEngineModes":{ + "shape":"EngineModeList", + "documentation":"

    The valid DB engine modes.

    " + } + }, + "documentation":"

    This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

    This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

    " + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingCloudwatchLogsExports":{ + "type":"structure", + "members":{ + "LogTypesToEnable":{ + "shape":"LogTypeList", + "documentation":"

    Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

    " + }, + "LogTypesToDisable":{ + "shape":"LogTypeList", + "documentation":"

    Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

    " + } + }, + "documentation":"

    A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated.

    " + }, + "PendingMaintenanceAction":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"String", + "documentation":"

    The type of pending maintenance action that is available for the resource. Valid actions are system-update, db-upgrade, and hardware-maintenance.

    " + }, + "AutoAppliedAfterDate":{ + "shape":"TStamp", + "documentation":"

    The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date.

    " + }, + "ForcedApplyDate":{ + "shape":"TStamp", + "documentation":"

    The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource.

    " + }, + "OptInStatus":{ + "shape":"String", + "documentation":"

    Indicates the type of opt-in request that has been received for the resource.

    " + }, + "CurrentApplyDate":{ + "shape":"TStamp", + "documentation":"

    The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description providing more detail about the maintenance action.

    " + } + }, + "documentation":"

    Provides information about a pending maintenance action for a resource.

    " + }, + "PendingMaintenanceActionDetails":{ + "type":"list", + "member":{ + "shape":"PendingMaintenanceAction", + "locationName":"PendingMaintenanceAction" + } + }, + "PendingMaintenanceActions":{ + "type":"list", + "member":{ + "shape":"ResourcePendingMaintenanceActions", + "locationName":"ResourcePendingMaintenanceActions" + } + }, + "PendingMaintenanceActionsMessage":{ + "type":"structure", + "members":{ + "PendingMaintenanceActions":{ + "shape":"PendingMaintenanceActions", + "documentation":"

    A list of the pending maintenance actions for the resource.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribePendingMaintenanceActions request. If this parameter is specified, the response includes only records beyond the marker, up to a number of records specified by MaxRecords.

    " + } + }, + "documentation":"

    Data returned from the DescribePendingMaintenanceActions action.

    " + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    Contains the new DBInstanceClass for the DB instance that will be applied or is currently being applied.

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    Contains the new AllocatedStorage size for the DB instance that will be applied or is currently being applied.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    Contains the pending or currently-in-progress change of the master credentials for the DB instance.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the pending port for the DB instance.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the pending number of days for which automated backups are retained.

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    Indicates the database engine version.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model for the DB instance.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Contains the new DBInstanceIdentifier for the DB instance that will be applied or is currently being applied.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    " + }, + "CACertificateIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier of the CA certificate for the DB instance.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The new DB subnet group for the DB instance.

    " + }, + "PendingCloudwatchLogsExports":{"shape":"PendingCloudwatchLogsExports"}, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element in the ModifyDBInstance action.

    " + }, + "PointInTimeRestoreNotEnabledFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    SourceDBInstanceIdentifier refers to a DB instance with BackupRetentionPeriod equal to 0.

    ", + "error":{ + "code":"PointInTimeRestoreNotEnabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ProcessorFeature":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the processor feature. Valid names are coreCount and threadsPerCore.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The value of a processor feature name.

    " + } + }, + "documentation":"

    Contains the processor features of a DB instance class.

    To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.

    You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:

    • CreateDBInstance

    • ModifyDBInstance

    • RestoreDBInstanceFromDBSnapshot

    • RestoreDBInstanceFromS3

    • RestoreDBInstanceToPointInTime

    You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.

    In addition, you can use the following actions for DB instance class processor information:

    • DescribeDBInstances

    • DescribeDBSnapshots

    • DescribeValidDBInstanceModifications

    For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.

    " + }, + "ProcessorFeatureList":{ + "type":"list", + "member":{ + "shape":"ProcessorFeature", + "locationName":"ProcessorFeature" + } + }, + "PromoteReadReplicaDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the DB cluster Read Replica to promote. This parameter isn't case-sensitive.

    Constraints:

    • Must match the identifier of an existing DBCluster Read Replica.

    Example: my-cluster-replica1

    " + } + }, + "documentation":"

    " + }, + "PromoteReadReplicaDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "PromoteReadReplicaMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This value is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing Read Replica DB instance.

    Example: mydbinstance

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

    Default: 1

    Constraints:

    • Must be a value from 0 to 35.

    • Can't be set to 0 if the DB instance is a source to Read Replicas.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + } + }, + "documentation":"

    " + }, + "PromoteReadReplicaResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "ProvisionedIopsNotAvailableInAZFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Provisioned IOPS not available in the specified Availability Zone.

    ", + "error":{ + "code":"ProvisionedIopsNotAvailableInAZFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PurchaseReservedDBInstancesOfferingMessage":{ + "type":"structure", + "required":["ReservedDBInstancesOfferingId"], + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The ID of the Reserved DB instance offering to purchase.

    Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

    " + }, + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    Customer-specified identifier to track this reservation.

    Example: myreservationID

    " + }, + "DBInstanceCount":{ + "shape":"IntegerOptional", + "documentation":"

    The number of instances to reserve.

    Default: 1

    " + }, + "Tags":{"shape":"TagList"} + }, + "documentation":"

    " + }, + "PurchaseReservedDBInstancesOfferingResult":{ + "type":"structure", + "members":{ + "ReservedDBInstance":{"shape":"ReservedDBInstance"} + } + }, + "Range":{ + "type":"structure", + "members":{ + "From":{ + "shape":"Integer", + "documentation":"

    The minimum value in the range.

    " + }, + "To":{ + "shape":"Integer", + "documentation":"

    The maximum value in the range.

    " + }, + "Step":{ + "shape":"IntegerOptional", + "documentation":"

    The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000...

    " + } + }, + "documentation":"

    A range of integer values.

    " + }, + "RangeList":{ + "type":"list", + "member":{ + "shape":"Range", + "locationName":"Range" + } + }, + "ReadReplicaDBClusterIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBClusterIdentifier" + } + }, + "ReadReplicaDBInstanceIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaDBInstanceIdentifier" + } + }, + "ReadReplicaIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ReadReplicaIdentifier" + } + }, + "ReadersArnList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RebootDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must match the identifier of an existing DBInstance.

    " + }, + "ForceFailover":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the reboot is conducted through a Multi-AZ failover.

    Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.

    " + } + }, + "documentation":"

    " + }, + "RebootDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

    The amount of the recurring charge.

    " + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

    The frequency of the recurring charge.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstances and DescribeReservedDBInstancesOfferings actions.

    ", + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "RemoveFromGlobalClusterMessage":{ + "type":"structure", + "members":{ + "GlobalClusterIdentifier":{ + "shape":"String", + "documentation":"

    The cluster identifier to detach from the Aurora global database cluster.

    " + }, + "DbClusterIdentifier":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) identifying the cluster that was detached from the Aurora global database cluster.

    " + } + } + }, + "RemoveFromGlobalClusterResult":{ + "type":"structure", + "members":{ + "GlobalCluster":{"shape":"GlobalCluster"} + } + }, + "RemoveRoleFromDBClusterMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "RoleArn" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB cluster to disassociate the IAM role from.

    " + }, + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.

    " + } + } + }, + "RemoveRoleFromDBInstanceMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "RoleArn", + "FeatureName" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB instance to disassociate the IAM role from.

    " + }, + "RoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.

    " + }, + "FeatureName":{ + "shape":"String", + "documentation":"

    The name of the feature for the DB instance that the IAM role is to be disassociated from. For the list of supported feature names, see DBEngineVersion.

    " + } + } + }, + "RemoveSourceIdentifierFromSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SourceIdentifier" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the RDS event notification subscription you want to remove a source identifier from.

    " + }, + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The source identifier to be removed from the subscription, such as the DB instance identifier for a DB instance or the name of a security group.

    " + } + }, + "documentation":"

    " + }, + "RemoveSourceIdentifierFromSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "RemoveTagsFromResourceMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon RDS resource that the tags are removed from. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.

    " + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

    The tag key (name) of the tag to be removed.

    " + } + }, + "documentation":"

    " + }, + "ReservedDBInstance":{ + "type":"structure", + "members":{ + "ReservedDBInstanceId":{ + "shape":"String", + "documentation":"

    The unique identifier for the reservation.

    " + }, + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class for the reserved DB instance.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The time the reservation started.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration of the reservation in seconds.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The fixed price charged for this reserved DB instance.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The hourly price charged for this reserved DB instance.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the reserved DB instance.

    " + }, + "DBInstanceCount":{ + "shape":"Integer", + "documentation":"

    The number of reserved DB instances.

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The description of the reserved DB instance.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type of this reserved DB instance.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Indicates if the reservation applies to Multi-AZ deployments.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The state of the reserved DB instance.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The recurring price charged to run this reserved DB instance.

    " + }, + "ReservedDBInstanceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the reserved DB instance.

    " + }, + "LeaseId":{ + "shape":"String", + "documentation":"

    The unique identifier for the lease associated with the reserved DB instance.

    AWS Support might request the lease ID for an issue related to a reserved DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstances and PurchaseReservedDBInstancesOffering actions.

    ", + "wrapper":true + }, + "ReservedDBInstanceAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    User already has a reservation with the given identifier.

    ", + "error":{ + "code":"ReservedDBInstanceAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstance", + "locationName":"ReservedDBInstance" + } + }, + "ReservedDBInstanceMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "ReservedDBInstances":{ + "shape":"ReservedDBInstanceList", + "documentation":"

    A list of reserved DB instances.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstances action.

    " + }, + "ReservedDBInstanceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified reserved DB Instance not found.

    ", + "error":{ + "code":"ReservedDBInstanceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstanceQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Request would exceed the user's DB Instance quota.

    ", + "error":{ + "code":"ReservedDBInstanceQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedDBInstancesOffering":{ + "type":"structure", + "members":{ + "ReservedDBInstancesOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The DB instance class for the reserved DB instance.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration of the offering in seconds.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The fixed price charged for this offering.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The hourly price charged for this offering.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the reserved DB instance offering.

    " + }, + "ProductDescription":{ + "shape":"String", + "documentation":"

    The database engine used by the offering.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The offering type.

    " + }, + "MultiAZ":{ + "shape":"Boolean", + "documentation":"

    Indicates if the offering applies to Multi-AZ deployments.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The recurring price charged to run this reserved DB instance.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeReservedDBInstancesOfferings action.

    ", + "wrapper":true + }, + "ReservedDBInstancesOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedDBInstancesOffering", + "locationName":"ReservedDBInstancesOffering" + } + }, + "ReservedDBInstancesOfferingMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "ReservedDBInstancesOfferings":{ + "shape":"ReservedDBInstancesOfferingList", + "documentation":"

    A list of reserved DB instance offerings.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeReservedDBInstancesOfferings action.

    " + }, + "ReservedDBInstancesOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Specified offering does not exist.

    ", + "error":{ + "code":"ReservedDBInstancesOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResetDBClusterParameterGroupMessage":{ + "type":"structure", + "required":["DBClusterParameterGroupName"], + "members":{ + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to reset.

    " + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

    " + } + }, + "documentation":"

    " + }, + "ResetDBParameterGroupMessage":{ + "type":"structure", + "required":["DBParameterGroupName"], + "members":{ + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group.

    Constraints:

    • Must match the name of an existing DBParameterGroup.

    " + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

    MySQL

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    MariaDB

    Valid Values (for Apply method): immediate | pending-reboot

    You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

    Oracle

    Valid Values (for Apply method): pending-reboot

    " + } + }, + "documentation":"

    " + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified resource ID was not found.

    ", + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResourcePendingMaintenanceActions":{ + "type":"structure", + "members":{ + "ResourceIdentifier":{ + "shape":"String", + "documentation":"

    The ARN of the resource that has pending maintenance actions.

    " + }, + "PendingMaintenanceActionDetails":{ + "shape":"PendingMaintenanceActionDetails", + "documentation":"

    A list that provides details about the pending maintenance actions for the resource.

    " + } + }, + "documentation":"

    Describes the pending maintenance actions for a resource.

    ", + "wrapper":true + }, + "RestoreDBClusterFromS3Message":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "Engine", + "MasterUsername", + "MasterUserPassword", + "SourceEngine", + "SourceEngineVersion", + "S3BucketName", + "S3IngestionRoleArn" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

    A list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups of the restored DB cluster are retained. You must specify a minimum value of 1.

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

    " + }, + "CharacterSetName":{ + "shape":"String", + "documentation":"

    A value that indicates that the restored DB cluster should be associated with the specified CharacterSet.

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB cluster.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB cluster to create from the source data in the Amazon S3 bucket. This parameter is isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: my-cluster1

    " + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to associate with the restored DB cluster. If this argument is omitted, default.aurora5.6 is used.

    Constraints:

    • If supplied, must match the name of an existing DBClusterParameterGroup.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with the restored DB cluster.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    A DB subnet group to associate with the restored DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for the restored DB cluster.

    Valid Values: aurora, aurora-postgresql

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"

    Aurora MySQL

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

    Aurora PostgreSQL

    Example: 9.6.3, 10.7

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the instances in the restored DB cluster accept connections.

    Default: 3306

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The name of the master user for the restored DB cluster.

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

    Constraints: Must contain from 8 to 41 characters.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    A value that indicates that the restored DB cluster should be associated with the specified option group.

    Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    Constraints: Minimum 30-minute window.

    " + }, + "Tags":{"shape":"TagList"}, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the restored DB cluster is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    " + }, + "SourceEngine":{ + "shape":"String", + "documentation":"

    The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

    Valid values: mysql

    " + }, + "SourceEngineVersion":{ + "shape":"String", + "documentation":"

    The version of the database that the backup files were created from.

    MySQL version 5.5 and 5.6 are supported.

    Example: 5.6.22

    " + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

    The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

    " + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

    The prefix for all of the file names that contain the data used to create the Amazon Aurora DB cluster. If you do not specify a SourceS3Prefix value, then the Amazon Aurora DB cluster is created by using all of the files in the Amazon S3 bucket.

    " + }, + "S3IngestionRoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon RDS to access the Amazon S3 bucket on your behalf.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + } + } + }, + "RestoreDBClusterFromS3Result":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterFromSnapshotMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SnapshotIdentifier", + "Engine" + ], + "members":{ + "AvailabilityZones":{ + "shape":"AvailabilityZones", + "documentation":"

    Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.

    " + }, + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot or DB cluster snapshot to restore from.

    You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

    Constraints:

    • Must match the identifier of an existing Snapshot.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to use for the new DB cluster.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version of the database engine to use for the new DB cluster.

    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:

    aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"

    To list all of the available engine versions for aurora-postgresql, use the following command:

    aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"

    If you aren't using the default engine version, then you must specify the engine version.

    Aurora MySQL

    Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5

    Aurora PostgreSQL

    Example: 9.6.3, 10.7

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the new DB cluster accepts connections.

    Constraints: This value must be 1150-65535

    Default: The same port as the original DB cluster.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB subnet group to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DB subnet group.

    Example: mySubnetgroup

    " + }, + "DatabaseName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB cluster.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to use for the restored DB cluster.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VPC security groups that the new DB cluster will belong to.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags to be assigned to the restored DB cluster.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

    • If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + }, + "EngineMode":{ + "shape":"String", + "documentation":"

    The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

    " + }, + "ScalingConfiguration":{ + "shape":"ScalingConfiguration", + "documentation":"

    For DB clusters in serverless DB engine mode, the scaling properties of the DB cluster.

    " + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    Constraints:

    • If supplied, must match the name of an existing default DB cluster parameter group.

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + } + }, + "documentation":"

    " + }, + "RestoreDBClusterFromSnapshotResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBClusterToPointInTimeMessage":{ + "type":"structure", + "required":[ + "DBClusterIdentifier", + "SourceDBClusterIdentifier" + ], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the new DB cluster to be created.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    " + }, + "RestoreType":{ + "shape":"String", + "documentation":"

    The type of restore to be performed. You can specify one of the following values:

    • full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

    • copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

    Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

    If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

    " + }, + "SourceDBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the source DB cluster from which to restore.

    Constraints:

    • Must match the identifier of an existing DBCluster.

    " + }, + "RestoreToTime":{ + "shape":"TStamp", + "documentation":"

    The date and time to restore the DB cluster to.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance

    • Must be specified if UseLatestRestorableTime parameter isn't provided

    • Can't be specified if the UseLatestRestorableTime parameter is enabled

    • Can't be specified if the RestoreType parameter is copy-on-write

    Example: 2015-03-07T23:45:00Z

    " + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster isn't restored to the latest restorable backup time.

    Constraints: Can't be specified if RestoreToTime parameter is provided.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the new DB cluster accepts connections.

    Constraints: A value from 1150-65535.

    Default: The default port for the engine.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The DB subnet group name to use for the new DB cluster.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group for the new DB cluster.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VPC security groups that the new DB cluster belongs to.

    " + }, + "Tags":{"shape":"TagList"}, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

    You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

    If you don't specify a value for the KmsKeyId parameter, then the following occurs:

    • If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

    • If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted.

    If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

    " + }, + "BacktrackWindow":{ + "shape":"LongOptional", + "documentation":"

    The target backtrack window, in seconds. To disable backtracking, set this value to 0.

    Default: 0

    Constraints:

    • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + }, + "DBClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.

    Constraints:

    • If supplied, must match the name of an existing DB cluster parameter group.

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

    " + } + }, + "documentation":"

    " + }, + "RestoreDBClusterToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "RestoreDBInstanceFromDBSnapshotMessage":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBSnapshotIdentifier" + ], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

    Constraints:

    • Must contain from 1 to 63 numbers, letters, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the DB snapshot to restore from.

    Constraints:

    • Must match the identifier of an existing DBSnapshot.

    • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    Default: The same DBInstanceClass as the original DB instance.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    Default: The same port as the original DB instance

    Constraints: Value must be 1150-65535

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone (AZ) where the DB instance will be created.

    Default: A random, system-chosen Availability Zone.

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    Example: us-east-1a

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The DB subnet group name to use for the new instance.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    Default: Same as source.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB instance.

    This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

    Valid Values:

    • mariadb

    • mysql

    • oracle-ee

    • oracle-se2

    • oracle-se1

    • oracle-se

    • postgres

    • sqlserver-ee

    • sqlserver-se

    • sqlserver-ex

    • sqlserver-web

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter isn't specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

    The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

    Constraints: Must be an integer greater than 1000.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + }, + "Tags":{"shape":"TagList"}, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the key store in order to access the device.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with this DB instance.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " + }, + "Domain":{ + "shape":"String", + "documentation":"

    Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

    For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

    For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "UseDefaultProcessorFeatures":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + } + }, + "documentation":"

    " + }, + "RestoreDBInstanceFromDBSnapshotResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceFromS3Message":{ + "type":"structure", + "required":[ + "DBInstanceIdentifier", + "DBInstanceClass", + "Engine", + "SourceEngine", + "SourceEngineVersion", + "S3BucketName", + "S3IngestionRoleArn" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

    The name of the database to create when the DB instance is created. Follow the naming rules specified in CreateDBInstance.

    " + }, + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The DB instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    " + }, + "AllocatedStorage":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of storage (in gigabytes) to allocate initially for the DB instance. Follow the allocation rules specified in CreateDBInstance.

    Be sure to allocate enough memory for your new DB instance so that the restore operation can succeed. You can also allocate additional memory for future growth.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    Importing from Amazon S3 isn't supported on the db.t2.micro DB instance class.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The name of the database engine to be used for this instance.

    Valid Values: mysql

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The name for the master user.

    Constraints:

    • Must be 1 to 16 letters or numbers.

    • First character must be a letter.

    • Can't be a reserved word for the chosen database engine.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

    Constraints: Must contain from 8 to 41 characters.

    " + }, + "DBSecurityGroups":{ + "shape":"DBSecurityGroupNameList", + "documentation":"

    A list of DB security groups to associate with this DB instance.

    Default: The default DB security group for the database engine.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of VPC security groups to associate with this DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

    Example: us-east-1d

    Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    A DB subnet group to associate with this DB instance.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format ddd:hh24:mi-ddd:hh24:mi.

    • Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred backup window.

    • Must be at least 30 minutes.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    " + }, + "BackupRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. For more information, see CreateDBInstance.

    " + }, + "PreferredBackupWindow":{ + "shape":"String", + "documentation":"

    The time range each day during which automated backups are created if automated backups are enabled. For more information, see The Backup Window in the Amazon RDS User Guide.

    Constraints:

    • Must be in the format hh24:mi-hh24:mi.

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    Type: Integer

    Valid Values: 1150-65535

    Default: 3306

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is a Multi-AZ deployment. If the DB instance is a Multi-AZ deployment, you can't set the AvailabilityZone parameter.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are not applied automatically.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    The license model for this DB instance. Use general-public-license.

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to allocate initially for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tags to associate with this DB instance. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    " + }, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified; otherwise gp2

    " + }, + "StorageEncrypted":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the new DB instance is encrypted or not.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for an encrypted DB instance.

    The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

    If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + }, + "MonitoringInterval":{ + "shape":"IntegerOptional", + "documentation":"

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0.

    If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0.

    Valid Values: 0, 1, 5, 10, 15, 30, 60

    Default: 0

    " + }, + "MonitoringRoleArn":{ + "shape":"String", + "documentation":"

    The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

    If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "SourceEngine":{ + "shape":"String", + "documentation":"

    The name of the engine of your source database.

    Valid Values: mysql

    " + }, + "SourceEngineVersion":{ + "shape":"String", + "documentation":"

    The engine version of your source database.

    Valid Values: 5.6

    " + }, + "S3BucketName":{ + "shape":"String", + "documentation":"

    The name of your Amazon S3 bucket that contains your database backup file.

    " + }, + "S3Prefix":{ + "shape":"String", + "documentation":"

    The prefix of your Amazon S3 bucket.

    " + }, + "S3IngestionRoleArn":{ + "shape":"String", + "documentation":"

    An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

    " + }, + "EnablePerformanceInsights":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable Performance Insights for the DB instance.

    For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

    " + }, + "PerformanceInsightsKMSKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key identifier, or the KMS key alias for the KMS encryption key.

    If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

    " + }, + "PerformanceInsightsRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "UseDefaultProcessorFeatures":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + } + } + }, + "RestoreDBInstanceFromS3Result":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreDBInstanceToPointInTimeMessage":{ + "type":"structure", + "required":["TargetDBInstanceIdentifier"], + "members":{ + "SourceDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the source DB instance from which to restore.

    Constraints:

    • Must match the identifier of an existing DB instance.

    " + }, + "TargetDBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The name of the new DB instance to be created.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens

    • First character must be a letter

    • Can't end with a hyphen or contain two consecutive hyphens

    " + }, + "RestoreTime":{ + "shape":"TStamp", + "documentation":"

    The date and time to restore from.

    Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

    Constraints:

    • Must be before the latest restorable time for the DB instance

    • Can't be specified if the UseLatestRestorableTime parameter is enabled

    Example: 2009-09-07T23:45:00Z

    " + }, + "UseLatestRestorableTime":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

    Constraints: Can't be specified if the RestoreTime parameter is provided.

    " + }, + "DBInstanceClass":{ + "shape":"String", + "documentation":"

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

    Default: The same DBInstanceClass as the original DB instance.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the database accepts connections.

    Constraints: Value must be 1150-65535

    Default: The same port as the original DB instance.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone (AZ) where the DB instance will be created.

    Default: A random, system-chosen Availability Zone.

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    Example: us-east-1a

    " + }, + "DBSubnetGroupName":{ + "shape":"String", + "documentation":"

    The DB subnet group name to use for the new instance.

    Constraints: If supplied, must match the name of an existing DBSubnetGroup.

    Example: mySubnetgroup

    " + }, + "MultiAZ":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is a Multi-AZ deployment.

    Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn't publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

    " + }, + "AutoMinorVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

    " + }, + "LicenseModel":{ + "shape":"String", + "documentation":"

    License model information for the restored DB instance.

    Default: Same as source.

    Valid values: license-included | bring-your-own-license | general-public-license

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The database name for the restored DB instance.

    This parameter isn't used for the MySQL or MariaDB engines.

    " + }, + "Engine":{ + "shape":"String", + "documentation":"

    The database engine to use for the new instance.

    Default: The same as source

    Constraint: Must be compatible with the engine of the source

    Valid Values:

    • mariadb

    • mysql

    • oracle-ee

    • oracle-se2

    • oracle-se1

    • oracle-se

    • postgres

    • sqlserver-ee

    • sqlserver-se

    • sqlserver-ex

    • sqlserver-web

    " + }, + "Iops":{ + "shape":"IntegerOptional", + "documentation":"

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

    Constraints: Must be an integer greater than 1000.

    SQL Server

    Setting the IOPS value for the SQL Server database engine isn't supported.

    " + }, + "OptionGroupName":{ + "shape":"String", + "documentation":"

    The name of the option group to be used for the restored DB instance.

    Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance

    " + }, + "CopyTagsToSnapshot":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

    " + }, + "Tags":{"shape":"TagList"}, + "StorageType":{ + "shape":"String", + "documentation":"

    Specifies the storage type to be associated with the DB instance.

    Valid values: standard | gp2 | io1

    If you specify io1, you must also include a value for the Iops parameter.

    Default: io1 if the Iops parameter is specified, otherwise gp2

    " + }, + "TdeCredentialArn":{ + "shape":"String", + "documentation":"

    The ARN from the key store with which to associate the instance for TDE encryption.

    " + }, + "TdeCredentialPassword":{ + "shape":"String", + "documentation":"

    The password for the given ARN from the key store in order to access the device.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of EC2 VPC security groups to associate with this DB instance.

    Default: The default EC2 VPC security group for the DB subnet group's VPC.

    " + }, + "Domain":{ + "shape":"String", + "documentation":"

    Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

    For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

    For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

    " + }, + "DomainIAMRoleName":{ + "shape":"String", + "documentation":"

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

    " + }, + "EnableIAMDatabaseAuthentication":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For information about the supported DB engines, see CreateDBInstance.

    For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

    " + }, + "EnableCloudwatchLogsExports":{ + "shape":"LogTypeList", + "documentation":"

    The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.

    " + }, + "ProcessorFeatures":{ + "shape":"ProcessorFeatureList", + "documentation":"

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

    " + }, + "UseDefaultProcessorFeatures":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

    " + }, + "DBParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB parameter group to associate with this DB instance.

    If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used.

    Constraints:

    • If supplied, must match the name of an existing DBParameterGroup.

    • Must be 1 to 255 letters, numbers, or hyphens.

    • First character must be a letter.

    • Can't end with a hyphen or contain two consecutive hyphens.

    " + }, + "DeletionProtection":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.

    " + }, + "SourceDbiResourceId":{ + "shape":"String", + "documentation":"

    The resource ID of the source DB instance from which to restore.

    " + } + }, + "documentation":"

    " + }, + "RestoreDBInstanceToPointInTimeResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "RestoreWindow":{ + "type":"structure", + "members":{ + "EarliestTime":{ + "shape":"TStamp", + "documentation":"

    The earliest time you can restore an instance to.

    " + }, + "LatestTime":{ + "shape":"TStamp", + "documentation":"

    The latest time you can restore an instance to.

    " + } + }, + "documentation":"

    Earliest and latest time an instance can be restored to:

    " + }, + "RevokeDBSecurityGroupIngressMessage":{ + "type":"structure", + "required":["DBSecurityGroupName"], + "members":{ + "DBSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the DB security group to revoke ingress from.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range to revoke access from. Must be a valid CIDR range. If CIDRIP is specified, EC2SecurityGroupName, EC2SecurityGroupId and EC2SecurityGroupOwnerId can't be provided.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupId":{ + "shape":"String", + "documentation":"

    The id of the EC2 security group to revoke access from. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    The AWS account number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS access key ID isn't an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

    " + } + }, + "documentation":"

    " + }, + "RevokeDBSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "DBSecurityGroup":{"shape":"DBSecurityGroup"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    SNS has responded that there is a problem with the SND topic specified.

    ", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You do not have permission to publish to the SNS topic ARN.

    ", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The SNS topic ARN does not exist.

    ", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ScalingConfiguration":{ + "type":"structure", + "members":{ + "MinCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

    Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    The minimum capacity must be less than or equal to the maximum capacity.

    " + }, + "MaxCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

    The maximum capacity must be greater than or equal to the minimum capacity.

    " + }, + "AutoPause":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).

    If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.

    " + }, + "SecondsUntilAutoPause":{ + "shape":"IntegerOptional", + "documentation":"

    The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

    " + }, + "TimeoutAction":{ + "shape":"String", + "documentation":"

    The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

    ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

    RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.

    If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

    For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

    " + } + }, + "documentation":"

    Contains the scaling configuration of an Aurora Serverless DB cluster.

    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "ScalingConfigurationInfo":{ + "type":"structure", + "members":{ + "MinCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum capacity for the Aurora DB cluster in serverless DB engine mode.

    " + }, + "MaxCapacity":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

    " + }, + "AutoPause":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether automatic pause is allowed for the Aurora DB cluster in serverless DB engine mode.

    When the value is set to false for an Aurora Serverless DB cluster, the DB cluster automatically resumes.

    " + }, + "SecondsUntilAutoPause":{ + "shape":"IntegerOptional", + "documentation":"

    The remaining amount of time, in seconds, before the Aurora DB cluster in serverless mode is paused. A DB cluster can be paused only when it's idle (it has no connections).

    " + }, + "TimeoutAction":{ + "shape":"String", + "documentation":"

    The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

    " + } + }, + "documentation":"

    Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.

    For more information, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

    " + }, + "SharedSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

    ", + "error":{ + "code":"SharedSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of DB snapshots.

    ", + "error":{ + "code":"SnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested source could not be found.

    ", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceRegion":{ + "type":"structure", + "members":{ + "RegionName":{ + "shape":"String", + "documentation":"

    The name of the source AWS Region.

    " + }, + "Endpoint":{ + "shape":"String", + "documentation":"

    The endpoint for the source AWS Region endpoint.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the source AWS Region.

    " + } + }, + "documentation":"

    Contains an AWS Region name as the result of a successful call to the DescribeSourceRegions action.

    " + }, + "SourceRegionList":{ + "type":"list", + "member":{ + "shape":"SourceRegion", + "locationName":"SourceRegion" + } + }, + "SourceRegionMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

    " + }, + "SourceRegions":{ + "shape":"SourceRegionList", + "documentation":"

    A list of SourceRegion instances that contains each source AWS Region that the current AWS Region can get a Read Replica or a DB snapshot from.

    " + } + }, + "documentation":"

    Contains the result of a successful invocation of the DescribeSourceRegions action.

    " + }, + "SourceType":{ + "type":"string", + "enum":[ + "db-instance", + "db-parameter-group", + "db-security-group", + "db-snapshot", + "db-cluster", + "db-cluster-snapshot" + ] + }, + "StartActivityStreamRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Mode", + "KmsKeyId" + ], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the DB cluster, for example arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    " + }, + "Mode":{ + "shape":"ActivityStreamMode", + "documentation":"

    Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier can be either a key ID, a key ARN, or a key alias.

    " + }, + "ApplyImmediately":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies whether or not the database activity stream is to start as soon as possible, regardless of the maintenance window for the database.

    " + } + } + }, + "StartActivityStreamResponse":{ + "type":"structure", + "members":{ + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier for encryption of messages in the database activity stream.

    " + }, + "KinesisStreamName":{ + "shape":"String", + "documentation":"

    The name of the Amazon Kinesis data stream to be used for the database activity stream.

    " + }, + "Status":{ + "shape":"ActivityStreamStatus", + "documentation":"

    The status of the database activity stream.

    " + }, + "Mode":{ + "shape":"ActivityStreamMode", + "documentation":"

    The mode of the database activity stream.

    " + }, + "ApplyImmediately":{ + "shape":"Boolean", + "documentation":"

    Indicates whether or not the database activity stream will start as soon as possible, regardless of the maintenance window for the database.

    " + } + } + }, + "StartDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the Amazon Aurora DB cluster to be started. This parameter is stored as a lowercase string.

    " + } + } + }, + "StartDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "StartDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied instance identifier.

    " + } + } + }, + "StartDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "StopActivityStreamRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the DB cluster for the database activity stream. For example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.

    " + }, + "ApplyImmediately":{ + "shape":"BooleanOptional", + "documentation":"

    Specifies whether or not the database activity stream is to stop as soon as possible, regardless of the maintenance window for the database.

    " + } + } + }, + "StopActivityStreamResponse":{ + "type":"structure", + "members":{ + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS KMS key identifier used for encrypting messages in the database activity stream.

    " + }, + "KinesisStreamName":{ + "shape":"String", + "documentation":"

    The name of the Amazon Kinesis data stream used for the database activity stream.

    " + }, + "Status":{ + "shape":"ActivityStreamStatus", + "documentation":"

    The status of the database activity stream.

    " + } + } + }, + "StopDBClusterMessage":{ + "type":"structure", + "required":["DBClusterIdentifier"], + "members":{ + "DBClusterIdentifier":{ + "shape":"String", + "documentation":"

    The DB cluster identifier of the Amazon Aurora DB cluster to be stopped. This parameter is stored as a lowercase string.

    " + } + } + }, + "StopDBClusterResult":{ + "type":"structure", + "members":{ + "DBCluster":{"shape":"DBCluster"} + } + }, + "StopDBInstanceMessage":{ + "type":"structure", + "required":["DBInstanceIdentifier"], + "members":{ + "DBInstanceIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied instance identifier.

    " + }, + "DBSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

    " + } + } + }, + "StopDBInstanceResult":{ + "type":"structure", + "members":{ + "DBInstance":{"shape":"DBInstance"} + } + }, + "StorageQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed amount of storage available across all DB instances.

    ", + "error":{ + "code":"StorageQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "StorageTypeNotSupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Storage of the StorageType specified can't be associated with the DB instance.

    ", + "error":{ + "code":"StorageTypeNotSupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "StringSensitive":{ + "type":"string", + "sensitive":true + }, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the identifier of the subnet.

    " + }, + "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetStatus":{ + "shape":"String", + "documentation":"

    Specifies the status of the subnet.

    " + } + }, + "documentation":"

    This data type is used as a response element in the DescribeDBSubnetGroups action.

    " + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The DB subnet is already in use in the Availability Zone.

    ", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The supplied subscription name already exists.

    ", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The supplied category does not exist.

    ", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The subscription name does not exist.

    ", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedCharacterSetsList":{ + "type":"list", + "member":{ + "shape":"CharacterSet", + "locationName":"CharacterSet" + } + }, + "SupportedTimezonesList":{ + "type":"list", + "member":{ + "shape":"Timezone", + "locationName":"Timezone" + } + }, + "TStamp":{"type":"timestamp"}, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

    A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"rds:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

    " + } + }, + "documentation":"

    Metadata assigned to an Amazon RDS resource consisting of a key-value pair.

    " + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "documentation":"

    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

    " + }, + "TagListMessage":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

    List of tags returned by the ListTagsForResource operation.

    " + } + }, + "documentation":"

    " + }, + "Timezone":{ + "type":"structure", + "members":{ + "TimezoneName":{ + "shape":"String", + "documentation":"

    The name of the time zone.

    " + } + }, + "documentation":"

    A time zone associated with a DBInstance or a DBSnapshot. This data type is an element in the response to the DescribeDBInstances, the DescribeDBSnapshots, and the DescribeDBEngineVersions actions.

    " + }, + "UpgradeTarget":{ + "type":"structure", + "members":{ + "Engine":{ + "shape":"String", + "documentation":"

    The name of the upgrade target database engine.

    " + }, + "EngineVersion":{ + "shape":"String", + "documentation":"

    The version number of the upgrade target database engine.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The version of the database engine that a DB instance can be upgraded to.

    " + }, + "AutoUpgrade":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

    " + }, + "IsMajorVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    A value that indicates whether a database engine is upgraded to a major version.

    " + } + }, + "documentation":"

    The version of the database engine that a DB instance can be upgraded to.

    " + }, + "ValidDBInstanceModificationsMessage":{ + "type":"structure", + "members":{ + "Storage":{ + "shape":"ValidStorageOptionsList", + "documentation":"

    Valid storage options for your DB instance.

    " + }, + "ValidProcessorFeatures":{ + "shape":"AvailableProcessorFeatureList", + "documentation":"

    Valid processor features for your DB instance.

    " + } + }, + "documentation":"

    Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action. You can use this information when you call ModifyDBInstance.

    ", + "wrapper":true + }, + "ValidStorageOptions":{ + "type":"structure", + "members":{ + "StorageType":{ + "shape":"String", + "documentation":"

    The valid storage types for your DB instance. For example, gp2, io1.

    " + }, + "StorageSize":{ + "shape":"RangeList", + "documentation":"

    The valid range of storage in gibibytes. For example, 100 to 16384.

    " + }, + "ProvisionedIops":{ + "shape":"RangeList", + "documentation":"

    The valid range of provisioned IOPS. For example, 1000-20000.

    " + }, + "IopsToStorageRatio":{ + "shape":"DoubleRangeList", + "documentation":"

    The valid range of Provisioned IOPS to gibibytes of storage multiplier. For example, 3-10, which means that provisioned IOPS can be between 3 and 10 times storage.

    " + }, + "SupportsStorageAutoscaling":{ + "shape":"Boolean", + "documentation":"

    Whether or not Amazon RDS can automatically scale storage for DB instances that use the new instance class.

    " + } + }, + "documentation":"

    Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the DescribeValidDBInstanceModifications action.

    " + }, + "ValidStorageOptionsList":{ + "type":"list", + "member":{ + "shape":"ValidStorageOptions", + "locationName":"ValidStorageOptions" + } + }, + "ValidUpgradeTargetList":{ + "type":"list", + "member":{ + "shape":"UpgradeTarget", + "locationName":"UpgradeTarget" + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

    The name of the VPC security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the VPC security group.

    " + } + }, + "documentation":"

    This data type is used as a response element for queries on VPC security group membership.

    " + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroupMembership" + } + }, + "VpnDetails":{ + "type":"structure", + "members":{ + "VpnId":{ + "shape":"String", + "documentation":"

    The ID of the VPN.

    " + }, + "VpnTunnelOriginatorIP":{ + "shape":"String", + "documentation":"

    The IP address of network traffic from your on-premises data center. A custom AZ receives the network traffic.

    " + }, + "VpnGatewayIp":{ + "shape":"String", + "documentation":"

    The IP address of network traffic from AWS to your on-premises data center.

    " + }, + "VpnPSK":{ + "shape":"StringSensitive", + "documentation":"

    The preshared key (PSK) for the VPN.

    " + }, + "VpnName":{ + "shape":"String", + "documentation":"

    The name of the VPN.

    " + }, + "VpnState":{ + "shape":"String", + "documentation":"

    The state of the VPN.

    " + } + }, + "documentation":"

    Information about the virtual private network (VPN) between the VMware vSphere cluster and the AWS website.

    For more information about RDS on VMware, see the RDS on VMware User Guide.

    " + } + }, + "documentation":"Amazon Relational Database Service

    Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizeable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.

    Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS is flexible: you can scale your DB instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.

    This interface reference for Amazon RDS contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces might require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. The reference structure is as follows, and we list following some related topics from the user guide.

    Amazon RDS API Reference

    Amazon RDS User Guide

    " +} diff --git a/aws/dist/botocore/data/rds/2014-10-31/service-2.sdk-extras.json b/aws/dist/botocore/data/rds/2014-10-31/service-2.sdk-extras.json new file mode 100644 index 00000000..ab6bfcd3 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-10-31/service-2.sdk-extras.json @@ -0,0 +1,39 @@ + { + "version": 1.0, + "merge": { + "shapes": { + "CopyDBClusterSnapshotMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

    The ID of the region that contains the snapshot to be copied.

    " + } + } + }, + "CreateDBClusterMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

    The ID of the region that contains the source for the db cluster.

    " + } + } + }, + "CopyDBSnapshotMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

    The ID of the region that contains the snapshot to be copied.

    " + } + } + }, + "CreateDBInstanceReadReplicaMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

    The ID of the region that contains the source for the read replica.

    " + } + } + } + } + } +} diff --git a/aws/dist/botocore/data/rds/2014-10-31/waiters-2.json b/aws/dist/botocore/data/rds/2014-10-31/waiters-2.json new file mode 100644 index 00000000..57accf12 --- /dev/null +++ b/aws/dist/botocore/data/rds/2014-10-31/waiters-2.json @@ -0,0 +1,278 @@ +{ + "version": 2, + "waiters": { + "DBInstanceAvailable": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBInstanceDeleted": { + "delay": 30, + "operation": "DescribeDBInstances", + "maxAttempts": 60, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(DBInstances) == `0`" + }, + { + "expected": "DBInstanceNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBInstances[].DBInstanceStatus" + } + ] + }, + "DBSnapshotAvailable": { + "delay": 30, + "operation": "DescribeDBSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + } + ] + }, + "DBSnapshotDeleted": { + "delay": 30, + "operation": "DescribeDBSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(DBSnapshots) == `0`" + }, + { + "expected": "DBSnapshotNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBSnapshots[].Status" + } + ] + }, + "DBClusterSnapshotAvailable": { + "delay": 30, + "operation": "DescribeDBClusterSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "incompatible-restore", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "incompatible-parameters", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + } + ] + }, + "DBClusterSnapshotDeleted": { + "delay": 30, + "operation": "DescribeDBClusterSnapshots", + "maxAttempts": 60, + "acceptors": [ + { + "expected": true, + "matcher": "path", + "state": "success", + "argument": "length(DBClusterSnapshots) == `0`" + }, + { + "expected": "DBClusterSnapshotNotFoundFault", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "rebooting", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + }, + { + "expected": "resetting-master-credentials", + "matcher": "pathAny", + "state": "failure", + "argument": "DBClusterSnapshots[].Status" + } + ] + }, + "DBSnapshotCompleted": { + "delay": 15, + "operation": "DescribeDBSnapshots", + "maxAttempts": 40, + "acceptors": [ + { + "expected": "DBSnapshotNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "DBSnapshots[].Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/redshift/2012-12-01/examples-1.json b/aws/dist/botocore/data/redshift/2012-12-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/redshift/2012-12-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/redshift/2012-12-01/paginators-1.json b/aws/dist/botocore/data/redshift/2012-12-01/paginators-1.json new file mode 100644 index 00000000..614516d3 --- /dev/null +++ b/aws/dist/botocore/data/redshift/2012-12-01/paginators-1.json @@ -0,0 +1,142 @@ +{ + "pagination": { + "DescribeClusterParameterGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ParameterGroups" + }, + "DescribeClusterParameters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Parameters" + }, + "DescribeClusterSecurityGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSecurityGroups" + }, + "DescribeClusterSnapshots": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Snapshots" + }, + "DescribeClusterSubnetGroups": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterSubnetGroups" + }, + "DescribeClusterVersions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ClusterVersions" + }, + "DescribeClusters": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Clusters" + }, + "DescribeDefaultClusterParameters": { + "input_token": "Marker", + "output_token": "DefaultClusterParameters.Marker", + "limit_key": "MaxRecords", + "result_key": "DefaultClusterParameters.Parameters" + }, + "DescribeEventSubscriptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "EventSubscriptionsList" + }, + "DescribeEvents": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "Events" + }, + "DescribeHsmClientCertificates": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmClientCertificates" + }, + "DescribeHsmConfigurations": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "HsmConfigurations" + }, + "DescribeOrderableClusterOptions": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "OrderableClusterOptions" + }, + "DescribeReservedNodeOfferings": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodeOfferings" + }, + "DescribeReservedNodes": { + "input_token": "Marker", + "output_token": "Marker", + "limit_key": "MaxRecords", + "result_key": "ReservedNodes" + }, + "DescribeClusterDbRevisions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ClusterDbRevisions" + }, + "DescribeClusterTracks": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "MaintenanceTracks" + }, + "DescribeSnapshotCopyGrants": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "SnapshotCopyGrants" + }, + "DescribeSnapshotSchedules": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "SnapshotSchedules" + }, + "DescribeTableRestoreStatus": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "TableRestoreStatusDetails" + }, + "DescribeTags": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "TaggedResources" + }, + "GetReservedNodeExchangeOfferings": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "ReservedNodeOfferings" + }, + "DescribeNodeConfigurationOptions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "NodeConfigurationOptionList" + } + } +} diff --git a/aws/dist/botocore/data/redshift/2012-12-01/service-2.json b/aws/dist/botocore/data/redshift/2012-12-01/service-2.json new file mode 100644 index 00000000..2a1a913d --- /dev/null +++ b/aws/dist/botocore/data/redshift/2012-12-01/service-2.json @@ -0,0 +1,7490 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-12-01", + "endpointPrefix":"redshift", + "protocol":"query", + "serviceFullName":"Amazon Redshift", + "serviceId":"Redshift", + "signatureVersion":"v4", + "uid":"redshift-2012-12-01", + "xmlNamespace":"http://redshift.amazonaws.com/doc/2012-12-01/" + }, + "operations":{ + "AcceptReservedNodeExchange":{ + "name":"AcceptReservedNodeExchange", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptReservedNodeExchangeInputMessage"}, + "output":{ + "shape":"AcceptReservedNodeExchangeOutputMessage", + "resultWrapper":"AcceptReservedNodeExchangeResult" + }, + "errors":[ + {"shape":"ReservedNodeNotFoundFault"}, + {"shape":"InvalidReservedNodeStateFault"}, + {"shape":"ReservedNodeAlreadyMigratedFault"}, + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"DependentServiceUnavailableFault"}, + {"shape":"ReservedNodeAlreadyExistsFault"} + ], + "documentation":"

    Exchanges a DC1 Reserved Node for a DC2 Reserved Node with no changes to the configuration (term, payment type, or number of nodes) and no additional costs.

    " + }, + "AuthorizeClusterSecurityGroupIngress":{ + "name":"AuthorizeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeClusterSecurityGroupIngressMessage"}, + "output":{ + "shape":"AuthorizeClusterSecurityGroupIngressResult", + "resultWrapper":"AuthorizeClusterSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"} + ], + "documentation":"

    Adds an inbound (ingress) rule to an Amazon Redshift security group. Depending on whether the application accessing your cluster is running on the Internet or an Amazon EC2 instance, you can authorize inbound access to either a Classless Interdomain Routing (CIDR)/Internet Protocol (IP) range or to an Amazon EC2 security group. You can add as many as 20 ingress rules to an Amazon Redshift security group.

    If you authorize access to an Amazon EC2 security group, specify EC2SecurityGroupName and EC2SecurityGroupOwnerId. The Amazon EC2 security group and Amazon Redshift cluster must be in the same AWS Region.

    If you authorize access to a CIDR/IP address range, specify CIDRIP. For an overview of CIDR blocks, see the Wikipedia article on Classless Inter-Domain Routing.

    You must also associate the security group with a cluster so that clients running on these IP addresses or the EC2 instance are authorized to connect to the cluster. For information about managing security groups, go to Working with Security Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "AuthorizeSnapshotAccess":{ + "name":"AuthorizeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeSnapshotAccessMessage"}, + "output":{ + "shape":"AuthorizeSnapshotAccessResult", + "resultWrapper":"AuthorizeSnapshotAccessResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"AuthorizationAlreadyExistsFault"}, + {"shape":"AuthorizationQuotaExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"LimitExceededFault"} + ], + "documentation":"

    Authorizes the specified AWS customer account to restore the specified snapshot.

    For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

    " + }, + "BatchDeleteClusterSnapshots":{ + "name":"BatchDeleteClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteClusterSnapshotsRequest"}, + "output":{ + "shape":"BatchDeleteClusterSnapshotsResult", + "resultWrapper":"BatchDeleteClusterSnapshotsResult" + }, + "errors":[ + {"shape":"BatchDeleteRequestSizeExceededFault"} + ], + "documentation":"

    Deletes a set of cluster snapshots.

    " + }, + "BatchModifyClusterSnapshots":{ + "name":"BatchModifyClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchModifyClusterSnapshotsMessage"}, + "output":{ + "shape":"BatchModifyClusterSnapshotsOutputMessage", + "resultWrapper":"BatchModifyClusterSnapshotsResult" + }, + "errors":[ + {"shape":"InvalidRetentionPeriodFault"}, + {"shape":"BatchModifyClusterSnapshotsLimitExceededFault"} + ], + "documentation":"

    Modifies the settings for a list of snapshots.

    " + }, + "CancelResize":{ + "name":"CancelResize", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelResizeMessage"}, + "output":{ + "shape":"ResizeProgressMessage", + "resultWrapper":"CancelResizeResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ResizeNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"

    Cancels a resize operation.

    " + }, + "CopyClusterSnapshot":{ + "name":"CopyClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyClusterSnapshotMessage"}, + "output":{ + "shape":"CopyClusterSnapshotResult", + "resultWrapper":"CopyClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Copies the specified automated cluster snapshot to a new manual cluster snapshot. The source must be an automated snapshot and it must be in the available state.

    When you delete a cluster, Amazon Redshift deletes any automated snapshots of the cluster. Also, when the retention period of the snapshot expires, Amazon Redshift automatically deletes it. If you want to keep an automated snapshot for a longer period, you can make a manual copy of the snapshot. Manual snapshots are retained until you delete them.

    For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterMessage"}, + "output":{ + "shape":"CreateClusterResult", + "resultWrapper":"CreateClusterResult" + }, + "errors":[ + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"ClusterQuotaExceededFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidElasticIpFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidClusterTrackFault"}, + {"shape":"SnapshotScheduleNotFoundFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Creates a new cluster.

    To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateClusterParameterGroup":{ + "name":"CreateClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterParameterGroupMessage"}, + "output":{ + "shape":"CreateClusterParameterGroupResult", + "resultWrapper":"CreateClusterParameterGroupResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupQuotaExceededFault"}, + {"shape":"ClusterParameterGroupAlreadyExistsFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates an Amazon Redshift parameter group.

    Creating parameter groups is independent of creating clusters. You can associate a cluster with a parameter group when you create the cluster. You can also associate an existing cluster with a parameter group after the cluster is created by using ModifyCluster.

    Parameters in the parameter group define specific behavior that applies to the databases you create on the cluster. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateClusterSecurityGroup":{ + "name":"CreateClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSecurityGroupMessage"}, + "output":{ + "shape":"CreateClusterSecurityGroupResult", + "resultWrapper":"CreateClusterSecurityGroupResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupAlreadyExistsFault"}, + {"shape":"ClusterSecurityGroupQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates a new Amazon Redshift security group. You use security groups to control access to non-VPC clusters.

    For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateClusterSnapshot":{ + "name":"CreateClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSnapshotMessage"}, + "output":{ + "shape":"CreateClusterSnapshotResult", + "resultWrapper":"CreateClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Creates a manual snapshot of the specified cluster. The cluster must be in the available state.

    For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateClusterSubnetGroup":{ + "name":"CreateClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterSubnetGroupMessage"}, + "output":{ + "shape":"CreateClusterSubnetGroupResult", + "resultWrapper":"CreateClusterSubnetGroupResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupAlreadyExistsFault"}, + {"shape":"ClusterSubnetGroupQuotaExceededFault"}, + {"shape":"ClusterSubnetQuotaExceededFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ], + "documentation":"

    Creates a new Amazon Redshift subnet group. You must provide a list of one or more subnets in your existing Amazon Virtual Private Cloud (Amazon VPC) when creating Amazon Redshift subnet group.

    For information about subnet groups, go to Amazon Redshift Cluster Subnet Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateEventSubscription":{ + "name":"CreateEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEventSubscriptionMessage"}, + "output":{ + "shape":"CreateEventSubscriptionResult", + "resultWrapper":"CreateEventSubscriptionResult" + }, + "errors":[ + {"shape":"EventSubscriptionQuotaExceededFault"}, + {"shape":"SubscriptionAlreadyExistFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionEventIdNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SubscriptionSeverityNotFoundFault"}, + {"shape":"SourceNotFoundFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates an Amazon Redshift event notification subscription. This action requires an ARN (Amazon Resource Name) of an Amazon SNS topic created by either the Amazon Redshift console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

    You can specify the source type, and lists of Amazon Redshift source IDs, event categories, and event severities. Notifications will be sent for all events you want that match those criteria. For example, you can specify source type = cluster, source ID = my-cluster-1 and mycluster2, event categories = Availability, Backup, and severity = ERROR. The subscription will only send notifications for those ERROR events in the Availability and Backup categories for the specified clusters.

    If you specify both the source type and source IDs, such as source type = cluster and source identifier = my-cluster-1, notifications will be sent for all the cluster events for my-cluster-1. If you specify a source type but do not specify a source identifier, you will receive notice of the events for the objects of that type in your AWS account. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all Amazon Redshift sources belonging to your AWS account. You must specify a source type if you specify a source ID.

    " + }, + "CreateHsmClientCertificate":{ + "name":"CreateHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmClientCertificateMessage"}, + "output":{ + "shape":"CreateHsmClientCertificateResult", + "resultWrapper":"CreateHsmClientCertificateResult" + }, + "errors":[ + {"shape":"HsmClientCertificateAlreadyExistsFault"}, + {"shape":"HsmClientCertificateQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates an HSM client certificate that an Amazon Redshift cluster will use to connect to the client's HSM in order to store and retrieve the keys used to encrypt the cluster databases.

    The command returns a public key, which you must store in the HSM. In addition to creating the HSM certificate, you must create an Amazon Redshift HSM configuration that provides a cluster the information needed to store and use encryption keys in the HSM. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateHsmConfiguration":{ + "name":"CreateHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHsmConfigurationMessage"}, + "output":{ + "shape":"CreateHsmConfigurationResult", + "resultWrapper":"CreateHsmConfigurationResult" + }, + "errors":[ + {"shape":"HsmConfigurationAlreadyExistsFault"}, + {"shape":"HsmConfigurationQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates an HSM configuration that contains the information required by an Amazon Redshift cluster to store and use database encryption keys in a Hardware Security Module (HSM). After creating the HSM configuration, you can specify it as a parameter when creating a cluster. The cluster will then store its encryption keys in the HSM.

    In addition to creating an HSM configuration, you must also create an HSM client certificate. For more information, go to Hardware Security Modules in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateSnapshotCopyGrant":{ + "name":"CreateSnapshotCopyGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotCopyGrantMessage"}, + "output":{ + "shape":"CreateSnapshotCopyGrantResult", + "resultWrapper":"CreateSnapshotCopyGrantResult" + }, + "errors":[ + {"shape":"SnapshotCopyGrantAlreadyExistsFault"}, + {"shape":"SnapshotCopyGrantQuotaExceededFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ], + "documentation":"

    Creates a snapshot copy grant that permits Amazon Redshift to use a customer master key (CMK) from AWS Key Management Service (AWS KMS) to encrypt copied snapshots in a destination region.

    For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

    " + }, + "CreateSnapshotSchedule":{ + "name":"CreateSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotScheduleMessage"}, + "output":{ + "shape":"SnapshotSchedule", + "resultWrapper":"CreateSnapshotScheduleResult" + }, + "errors":[ + {"shape":"SnapshotScheduleAlreadyExistsFault"}, + {"shape":"InvalidScheduleFault"}, + {"shape":"SnapshotScheduleQuotaExceededFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"ScheduleDefinitionTypeUnsupportedFault"} + ], + "documentation":"

    Creates a new snapshot schedule.

    " + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsMessage"}, + "errors":[ + {"shape":"TagLimitExceededFault"}, + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Adds one or more tags to a specified resource.

    A resource can have up to 50 tags. If you try to create more than 50 tags for a resource, you will receive an error and the attempt will fail.

    If you specify a key that already exists for the resource, the value for that key will be updated with the new value.

    " + }, + "DeleteCluster":{ + "name":"DeleteCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterMessage"}, + "output":{ + "shape":"DeleteClusterResult", + "resultWrapper":"DeleteClusterResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterSnapshotAlreadyExistsFault"}, + {"shape":"ClusterSnapshotQuotaExceededFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier. You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be \"final-snapshot\" while the snapshot is being taken, then it's \"deleting\" once Amazon Redshift begins deleting the cluster.

    For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    " + }, + "DeleteClusterParameterGroup":{ + "name":"DeleteClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterParameterGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterParameterGroupStateFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"} + ], + "documentation":"

    Deletes a specified Amazon Redshift parameter group.

    You cannot delete a parameter group if it is associated with a cluster.

    " + }, + "DeleteClusterSecurityGroup":{ + "name":"DeleteClusterSecurityGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSecurityGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"} + ], + "documentation":"

    Deletes an Amazon Redshift security group.

    You cannot delete a security group that is associated with any clusters. You cannot delete the default security group.

    For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "DeleteClusterSnapshot":{ + "name":"DeleteClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSnapshotMessage"}, + "output":{ + "shape":"DeleteClusterSnapshotResult", + "resultWrapper":"DeleteClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"ClusterSnapshotNotFoundFault"} + ], + "documentation":"

    Deletes the specified manual snapshot. The snapshot must be in the available state, with no other users authorized to access the snapshot.

    Unlike automated snapshots, manual snapshots are retained even after you delete your cluster. Amazon Redshift does not delete your manual snapshots. You must delete manual snapshot explicitly to avoid getting charged. If other accounts are authorized to access the snapshot, you must revoke all of the authorizations before you can delete the snapshot.

    " + }, + "DeleteClusterSubnetGroup":{ + "name":"DeleteClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteClusterSubnetGroupMessage"}, + "errors":[ + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidClusterSubnetStateFault"}, + {"shape":"ClusterSubnetGroupNotFoundFault"} + ], + "documentation":"

    Deletes the specified cluster subnet group.

    " + }, + "DeleteEventSubscription":{ + "name":"DeleteEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEventSubscriptionMessage"}, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidSubscriptionStateFault"} + ], + "documentation":"

    Deletes an Amazon Redshift event notification subscription.

    " + }, + "DeleteHsmClientCertificate":{ + "name":"DeleteHsmClientCertificate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmClientCertificateMessage"}, + "errors":[ + {"shape":"InvalidHsmClientCertificateStateFault"}, + {"shape":"HsmClientCertificateNotFoundFault"} + ], + "documentation":"

    Deletes the specified HSM client certificate.

    " + }, + "DeleteHsmConfiguration":{ + "name":"DeleteHsmConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHsmConfigurationMessage"}, + "errors":[ + {"shape":"InvalidHsmConfigurationStateFault"}, + {"shape":"HsmConfigurationNotFoundFault"} + ], + "documentation":"

    Deletes the specified Amazon Redshift HSM configuration.

    " + }, + "DeleteSnapshotCopyGrant":{ + "name":"DeleteSnapshotCopyGrant", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotCopyGrantMessage"}, + "errors":[ + {"shape":"InvalidSnapshotCopyGrantStateFault"}, + {"shape":"SnapshotCopyGrantNotFoundFault"} + ], + "documentation":"

    Deletes the specified snapshot copy grant.

    " + }, + "DeleteSnapshotSchedule":{ + "name":"DeleteSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotScheduleMessage"}, + "errors":[ + {"shape":"InvalidClusterSnapshotScheduleStateFault"}, + {"shape":"SnapshotScheduleNotFoundFault"} + ], + "documentation":"

    Deletes a snapshot schedule.

    " + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsMessage"}, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Deletes a tag or tags from a resource. You must provide the ARN of the resource from which you want to delete the tag or tags.

    " + }, + "DescribeAccountAttributes":{ + "name":"DescribeAccountAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountAttributesMessage"}, + "output":{ + "shape":"AccountAttributeList", + "resultWrapper":"DescribeAccountAttributesResult" + }, + "documentation":"

    Returns a list of attributes attached to an account

    " + }, + "DescribeClusterDbRevisions":{ + "name":"DescribeClusterDbRevisions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterDbRevisionsMessage"}, + "output":{ + "shape":"ClusterDbRevisionsMessage", + "resultWrapper":"DescribeClusterDbRevisionsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"} + ], + "documentation":"

    Returns an array of ClusterDbRevision objects.

    " + }, + "DescribeClusterParameterGroups":{ + "name":"DescribeClusterParameterGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterParameterGroupsMessage"}, + "output":{ + "shape":"ClusterParameterGroupsMessage", + "resultWrapper":"DescribeClusterParameterGroupsResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns a list of Amazon Redshift parameter groups, including parameter groups you created and the default parameter group. For each parameter group, the response includes the parameter group name, description, and parameter group family name. You can optionally specify a name to retrieve the description of a specific parameter group.

    For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all parameter groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all parameter groups that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, parameter groups are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeClusterParameters":{ + "name":"DescribeClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterParametersMessage"}, + "output":{ + "shape":"ClusterParameterGroupDetails", + "resultWrapper":"DescribeClusterParametersResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"} + ], + "documentation":"

    Returns a detailed list of parameters contained within the specified Amazon Redshift parameter group. For each parameter the response includes information such as parameter name, description, data type, value, whether the parameter value is modifiable, and so on.

    You can specify source filter to retrieve parameters of only specific type. For example, to retrieve parameters that were modified by a user action such as from ModifyClusterParameterGroup, you can specify source equal to user.

    For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeClusterSecurityGroups":{ + "name":"DescribeClusterSecurityGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSecurityGroupsMessage"}, + "output":{ + "shape":"ClusterSecurityGroupMessage", + "resultWrapper":"DescribeClusterSecurityGroupsResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

    For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeClusterSnapshots":{ + "name":"DescribeClusterSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSnapshotsMessage"}, + "output":{ + "shape":"SnapshotMessage", + "resultWrapper":"DescribeClusterSnapshotsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns one or more snapshot objects, which contain metadata about your cluster snapshots. By default, this operation returns information about all snapshots of all clusters that are owned by you AWS customer account. No information is returned for snapshots owned by inactive AWS customer accounts.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all snapshots that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all snapshots that have any combination of those values are returned. Only snapshots that you own are returned in the response; shared snapshots are not returned with the tag key and tag value request parameters.

    If both tag keys and values are omitted from the request, snapshots are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeClusterSubnetGroups":{ + "name":"DescribeClusterSubnetGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterSubnetGroupsMessage"}, + "output":{ + "shape":"ClusterSubnetGroupMessage", + "resultWrapper":"DescribeClusterSubnetGroupsResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns one or more cluster subnet group objects, which contain metadata about your cluster subnet groups. By default, this operation returns information about all cluster subnet groups that are defined in you AWS account.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all subnet groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subnet groups that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, subnet groups are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeClusterTracks":{ + "name":"DescribeClusterTracks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterTracksMessage"}, + "output":{ + "shape":"TrackListMessage", + "resultWrapper":"DescribeClusterTracksResult" + }, + "errors":[ + {"shape":"InvalidClusterTrackFault"}, + {"shape":"UnauthorizedOperation"} + ], + "documentation":"

    Returns a list of all the available maintenance tracks.

    " + }, + "DescribeClusterVersions":{ + "name":"DescribeClusterVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterVersionsMessage"}, + "output":{ + "shape":"ClusterVersionsMessage", + "resultWrapper":"DescribeClusterVersionsResult" + }, + "documentation":"

    Returns descriptions of the available Amazon Redshift cluster versions. You can call this operation even before creating any clusters to learn more about the Amazon Redshift versions. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeClusters":{ + "name":"DescribeClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClustersMessage"}, + "output":{ + "shape":"ClustersMessage", + "resultWrapper":"DescribeClustersResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns properties of provisioned clusters including general cluster properties, cluster database properties, maintenance and backup properties, and security and access properties. This operation supports pagination. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all clusters that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all clusters that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, clusters are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeDefaultClusterParameters":{ + "name":"DescribeDefaultClusterParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDefaultClusterParametersMessage"}, + "output":{ + "shape":"DescribeDefaultClusterParametersResult", + "resultWrapper":"DescribeDefaultClusterParametersResult" + }, + "documentation":"

    Returns a list of parameter settings for the specified parameter group family.

    For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeEventCategories":{ + "name":"DescribeEventCategories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventCategoriesMessage"}, + "output":{ + "shape":"EventCategoriesMessage", + "resultWrapper":"DescribeEventCategoriesResult" + }, + "documentation":"

    Displays a list of event categories for all event source types, or for a specified source type. For a list of the event categories and source types, go to Amazon Redshift Event Notifications.

    " + }, + "DescribeEventSubscriptions":{ + "name":"DescribeEventSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventSubscriptionsMessage"}, + "output":{ + "shape":"EventSubscriptionsMessage", + "resultWrapper":"DescribeEventSubscriptionsResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Lists descriptions of all the Amazon Redshift event notification subscriptions for a customer account. If you specify a subscription name, lists the description for that subscription.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all event notification subscriptions that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all subscriptions that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, subscriptions are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeEvents":{ + "name":"DescribeEvents", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEventsMessage"}, + "output":{ + "shape":"EventsMessage", + "resultWrapper":"DescribeEventsResult" + }, + "documentation":"

    Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

    " + }, + "DescribeHsmClientCertificates":{ + "name":"DescribeHsmClientCertificates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHsmClientCertificatesMessage"}, + "output":{ + "shape":"HsmClientCertificateMessage", + "resultWrapper":"DescribeHsmClientCertificatesResult" + }, + "errors":[ + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns information about the specified HSM client certificate. If no certificate ID is specified, returns information about all the HSM certificates owned by your AWS customer account.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM client certificates that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM client certificates that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, HSM client certificates are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeHsmConfigurations":{ + "name":"DescribeHsmConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHsmConfigurationsMessage"}, + "output":{ + "shape":"HsmConfigurationMessage", + "resultWrapper":"DescribeHsmConfigurationsResult" + }, + "errors":[ + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns information about the specified Amazon Redshift HSM configuration. If no configuration ID is specified, returns information about all the HSM configurations owned by your AWS customer account.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all HSM connections that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all HSM connections that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, HSM connections are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DescribeLoggingStatus":{ + "name":"DescribeLoggingStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLoggingStatusMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"DescribeLoggingStatusResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Describes whether information, such as queries and connection attempts, is being logged for the specified Amazon Redshift cluster.

    " + }, + "DescribeNodeConfigurationOptions":{ + "name":"DescribeNodeConfigurationOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNodeConfigurationOptionsMessage"}, + "output":{ + "shape":"NodeConfigurationOptionsMessage", + "resultWrapper":"DescribeNodeConfigurationOptionsResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidClusterSnapshotStateFault"} + ], + "documentation":"

    Returns properties of possible node configurations such as node type, number of nodes, and disk usage for the specified action type.

    " + }, + "DescribeOrderableClusterOptions":{ + "name":"DescribeOrderableClusterOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrderableClusterOptionsMessage"}, + "output":{ + "shape":"OrderableClusterOptionsMessage", + "resultWrapper":"DescribeOrderableClusterOptionsResult" + }, + "documentation":"

    Returns a list of orderable cluster options. Before you create a new cluster you can use this operation to find what options are available, such as the EC2 Availability Zones (AZ) in the specific AWS Region that you can specify, and the node types you can request. The node types differ by available storage, memory, CPU and price. With the cost involved you might want to obtain a list of cluster options in the specific region and specify values when creating a cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeReservedNodeOfferings":{ + "name":"DescribeReservedNodeOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedNodeOfferingsMessage"}, + "output":{ + "shape":"ReservedNodeOfferingsMessage", + "resultWrapper":"DescribeReservedNodeOfferingsResult" + }, + "errors":[ + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"DependentServiceUnavailableFault"} + ], + "documentation":"

    Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

    For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeReservedNodes":{ + "name":"DescribeReservedNodes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReservedNodesMessage"}, + "output":{ + "shape":"ReservedNodesMessage", + "resultWrapper":"DescribeReservedNodesResult" + }, + "errors":[ + {"shape":"ReservedNodeNotFoundFault"}, + {"shape":"DependentServiceUnavailableFault"} + ], + "documentation":"

    Returns the descriptions of the reserved nodes.

    " + }, + "DescribeResize":{ + "name":"DescribeResize", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResizeMessage"}, + "output":{ + "shape":"ResizeProgressMessage", + "resultWrapper":"DescribeResizeResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ResizeNotFoundFault"} + ], + "documentation":"

    Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.

    A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.

    " + }, + "DescribeSnapshotCopyGrants":{ + "name":"DescribeSnapshotCopyGrants", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotCopyGrantsMessage"}, + "output":{ + "shape":"SnapshotCopyGrantMessage", + "resultWrapper":"DescribeSnapshotCopyGrantsResult" + }, + "errors":[ + {"shape":"SnapshotCopyGrantNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns a list of snapshot copy grants owned by the AWS account in the destination region.

    For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

    " + }, + "DescribeSnapshotSchedules":{ + "name":"DescribeSnapshotSchedules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotSchedulesMessage"}, + "output":{ + "shape":"DescribeSnapshotSchedulesOutputMessage", + "resultWrapper":"DescribeSnapshotSchedulesResult" + }, + "documentation":"

    Returns a list of snapshot schedules.

    " + }, + "DescribeStorage":{ + "name":"DescribeStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"CustomerStorageMessage", + "resultWrapper":"DescribeStorageResult" + }, + "documentation":"

    Returns the total amount of snapshot usage and provisioned storage in megabytes.

    " + }, + "DescribeTableRestoreStatus":{ + "name":"DescribeTableRestoreStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTableRestoreStatusMessage"}, + "output":{ + "shape":"TableRestoreStatusMessage", + "resultWrapper":"DescribeTableRestoreStatusResult" + }, + "errors":[ + {"shape":"TableRestoreNotFoundFault"}, + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.

    " + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsMessage"}, + "output":{ + "shape":"TaggedResourceListMessage", + "resultWrapper":"DescribeTagsResult" + }, + "errors":[ + {"shape":"ResourceNotFoundFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.

    The following are limitations for DescribeTags:

    • You cannot specify an ARN and a resource-type value together in the same request.

    • You cannot use the MaxRecords and Marker parameters together with the ARN parameter.

    • The MaxRecords parameter can be a range from 10 to 50 results to return in a request.

    If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.

    If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.

    " + }, + "DisableLogging":{ + "name":"DisableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableLoggingMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"DisableLoggingResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

    " + }, + "DisableSnapshotCopy":{ + "name":"DisableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableSnapshotCopyMessage"}, + "output":{ + "shape":"DisableSnapshotCopyResult", + "resultWrapper":"DisableSnapshotCopyResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"SnapshotCopyAlreadyDisabledFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnauthorizedOperation"} + ], + "documentation":"

    Disables the automatic copying of snapshots from one region to another region for a specified cluster.

    If your cluster and its snapshots are encrypted using a customer master key (CMK) from AWS KMS, use DeleteSnapshotCopyGrant to delete the grant that grants Amazon Redshift permission to the CMK in the destination region.

    " + }, + "EnableLogging":{ + "name":"EnableLogging", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableLoggingMessage"}, + "output":{ + "shape":"LoggingStatus", + "resultWrapper":"EnableLoggingResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"BucketNotFoundFault"}, + {"shape":"InsufficientS3BucketPolicyFault"}, + {"shape":"InvalidS3KeyPrefixFault"}, + {"shape":"InvalidS3BucketNameFault"} + ], + "documentation":"

    Starts logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.

    " + }, + "EnableSnapshotCopy":{ + "name":"EnableSnapshotCopy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableSnapshotCopyMessage"}, + "output":{ + "shape":"EnableSnapshotCopyResult", + "resultWrapper":"EnableSnapshotCopyResult" + }, + "errors":[ + {"shape":"IncompatibleOrderableOptions"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"CopyToRegionDisabledFault"}, + {"shape":"SnapshotCopyAlreadyEnabledFault"}, + {"shape":"UnknownSnapshotCopyRegionFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"SnapshotCopyGrantNotFoundFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Enables the automatic copy of snapshots from one region to another region for a specified cluster.

    " + }, + "GetClusterCredentials":{ + "name":"GetClusterCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetClusterCredentialsMessage"}, + "output":{ + "shape":"ClusterCredentials", + "resultWrapper":"GetClusterCredentialsResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"

    Returns a database user name and temporary password with temporary authorization to log on to an Amazon Redshift database. The action returns the database user name prefixed with IAM: if AutoCreate is False or IAMA: if AutoCreate is True. You can optionally specify one or more database user groups that the user will join at log on. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). For more information, see Using IAM Authentication to Generate Database User Credentials in the Amazon Redshift Cluster Management Guide.

    The AWS Identity and Access Management (IAM)user or role that executes GetClusterCredentials must have an IAM policy attached that allows access to all necessary actions and resources. For more information about permissions, see Resource Policies for GetClusterCredentials in the Amazon Redshift Cluster Management Guide.

    If the DbGroups parameter is specified, the IAM policy must allow the redshift:JoinGroup action with access to the listed dbgroups.

    In addition, if the AutoCreate parameter is set to True, then the policy must include the redshift:CreateClusterUser privilege.

    If the DbName parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.

    " + }, + "GetReservedNodeExchangeOfferings":{ + "name":"GetReservedNodeExchangeOfferings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReservedNodeExchangeOfferingsInputMessage"}, + "output":{ + "shape":"GetReservedNodeExchangeOfferingsOutputMessage", + "resultWrapper":"GetReservedNodeExchangeOfferingsResult" + }, + "errors":[ + {"shape":"ReservedNodeNotFoundFault"}, + {"shape":"InvalidReservedNodeStateFault"}, + {"shape":"ReservedNodeAlreadyMigratedFault"}, + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"DependentServiceUnavailableFault"} + ], + "documentation":"

    Returns an array of DC2 ReservedNodeOfferings that matches the payment type, term, and usage price of the given DC1 reserved node.

    " + }, + "ModifyCluster":{ + "name":"ModifyCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterMessage"}, + "output":{ + "shape":"ModifyClusterResult", + "resultWrapper":"ModifyClusterResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"UnsupportedOptionFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidElasticIpFault"}, + {"shape":"TableLimitExceededFault"}, + {"shape":"InvalidClusterTrackFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

    " + }, + "ModifyClusterDbRevision":{ + "name":"ModifyClusterDbRevision", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterDbRevisionMessage"}, + "output":{ + "shape":"ModifyClusterDbRevisionResult", + "resultWrapper":"ModifyClusterDbRevisionResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"ClusterOnLatestRevisionFault"}, + {"shape":"InvalidClusterStateFault"} + ], + "documentation":"

    Modifies the database revision of a cluster. The database revision is a unique revision of the database running in a cluster.

    " + }, + "ModifyClusterIamRoles":{ + "name":"ModifyClusterIamRoles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterIamRolesMessage"}, + "output":{ + "shape":"ModifyClusterIamRolesResult", + "resultWrapper":"ModifyClusterIamRolesResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Modifies the list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

    A cluster can have up to 10 IAM roles associated at any time.

    " + }, + "ModifyClusterMaintenance":{ + "name":"ModifyClusterMaintenance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterMaintenanceMessage"}, + "output":{ + "shape":"ModifyClusterMaintenanceResult", + "resultWrapper":"ModifyClusterMaintenanceResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Modifies the maintenance settings of a cluster. For example, you can defer a maintenance window. You can also update or cancel a deferment.

    " + }, + "ModifyClusterParameterGroup":{ + "name":"ModifyClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterParameterGroupMessage"}, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "resultWrapper":"ModifyClusterParameterGroupResult" + }, + "errors":[ + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"InvalidClusterParameterGroupStateFault"} + ], + "documentation":"

    Modifies the parameters of a parameter group.

    For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "ModifyClusterSnapshot":{ + "name":"ModifyClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterSnapshotMessage"}, + "output":{ + "shape":"ModifyClusterSnapshotResult", + "resultWrapper":"ModifyClusterSnapshotResult" + }, + "errors":[ + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Modifies the settings for a snapshot.

    " + }, + "ModifyClusterSnapshotSchedule":{ + "name":"ModifyClusterSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterSnapshotScheduleMessage"}, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"SnapshotScheduleNotFoundFault"}, + {"shape":"InvalidClusterSnapshotScheduleStateFault"} + ], + "documentation":"

    Modifies a snapshot schedule for a cluster.

    " + }, + "ModifyClusterSubnetGroup":{ + "name":"ModifyClusterSubnetGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClusterSubnetGroupMessage"}, + "output":{ + "shape":"ModifyClusterSubnetGroupResult", + "resultWrapper":"ModifyClusterSubnetGroupResult" + }, + "errors":[ + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"ClusterSubnetQuotaExceededFault"}, + {"shape":"SubnetAlreadyInUse"}, + {"shape":"InvalidSubnet"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ], + "documentation":"

    Modifies a cluster subnet group to include the specified list of VPC subnets. The operation replaces the existing list of subnets with the new list of subnets.

    " + }, + "ModifyEventSubscription":{ + "name":"ModifyEventSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyEventSubscriptionMessage"}, + "output":{ + "shape":"ModifyEventSubscriptionResult", + "resultWrapper":"ModifyEventSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionNotFoundFault"}, + {"shape":"SNSInvalidTopicFault"}, + {"shape":"SNSNoAuthorizationFault"}, + {"shape":"SNSTopicArnNotFoundFault"}, + {"shape":"SubscriptionEventIdNotFoundFault"}, + {"shape":"SubscriptionCategoryNotFoundFault"}, + {"shape":"SubscriptionSeverityNotFoundFault"}, + {"shape":"SourceNotFoundFault"}, + {"shape":"InvalidSubscriptionStateFault"} + ], + "documentation":"

    Modifies an existing Amazon Redshift event notification subscription.

    " + }, + "ModifySnapshotCopyRetentionPeriod":{ + "name":"ModifySnapshotCopyRetentionPeriod", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotCopyRetentionPeriodMessage"}, + "output":{ + "shape":"ModifySnapshotCopyRetentionPeriodResult", + "resultWrapper":"ModifySnapshotCopyRetentionPeriodResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"SnapshotCopyDisabledFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"InvalidRetentionPeriodFault"} + ], + "documentation":"

    Modifies the number of days to retain snapshots in the destination AWS Region after they are copied from the source AWS Region. By default, this operation only changes the retention period of copied automated snapshots. The retention periods for both new and existing copied automated snapshots are updated with the new retention period. You can set the manual option to change only the retention periods of copied manual snapshots. If you set this option, only newly copied manual snapshots have the new retention period.

    " + }, + "ModifySnapshotSchedule":{ + "name":"ModifySnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifySnapshotScheduleMessage"}, + "output":{ + "shape":"SnapshotSchedule", + "resultWrapper":"ModifySnapshotScheduleResult" + }, + "errors":[ + {"shape":"InvalidScheduleFault"}, + {"shape":"SnapshotScheduleNotFoundFault"}, + {"shape":"SnapshotScheduleUpdateInProgressFault"} + ], + "documentation":"

    Modifies a snapshot schedule. Any schedule associated with a cluster is modified asynchronously.

    " + }, + "PurchaseReservedNodeOffering":{ + "name":"PurchaseReservedNodeOffering", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurchaseReservedNodeOfferingMessage"}, + "output":{ + "shape":"PurchaseReservedNodeOfferingResult", + "resultWrapper":"PurchaseReservedNodeOfferingResult" + }, + "errors":[ + {"shape":"ReservedNodeOfferingNotFoundFault"}, + {"shape":"ReservedNodeAlreadyExistsFault"}, + {"shape":"ReservedNodeQuotaExceededFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"

    Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve.

    For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

    " + }, + "RebootCluster":{ + "name":"RebootCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootClusterMessage"}, + "output":{ + "shape":"RebootClusterResult", + "resultWrapper":"RebootClusterResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"} + ], + "documentation":"

    Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

    " + }, + "ResetClusterParameterGroup":{ + "name":"ResetClusterParameterGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetClusterParameterGroupMessage"}, + "output":{ + "shape":"ClusterParameterGroupNameMessage", + "resultWrapper":"ResetClusterParameterGroupResult" + }, + "errors":[ + {"shape":"InvalidClusterParameterGroupStateFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"} + ], + "documentation":"

    Sets one or more parameters of the specified parameter group to their default values and sets the source values of the parameters to \"engine-default\". To reset the entire parameter group specify the ResetAllParameters parameter. For parameter changes to take effect you must reboot any associated clusters.

    " + }, + "ResizeCluster":{ + "name":"ResizeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResizeClusterMessage"}, + "output":{ + "shape":"ResizeClusterResult", + "resultWrapper":"ResizeClusterResult" + }, + "errors":[ + {"shape":"InvalidClusterStateFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"UnsupportedOptionFault"}, + {"shape":"UnsupportedOperationFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"LimitExceededFault"} + ], + "documentation":"

    Changes the size of the cluster. You can change the cluster's type, or change the number or type of nodes. The default behavior is to use the elastic resize method. With an elastic resize, your cluster is available for read and write operations more quickly than with the classic resize method.

    Elastic resize operations have the following restrictions:

    • You can only resize clusters of the following types:

      • dc2.large

      • dc2.8xlarge

      • ds2.xlarge

      • ds2.8xlarge

    • The type of nodes that you add must match the node type for the cluster.

    " + }, + "RestoreFromClusterSnapshot":{ + "name":"RestoreFromClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreFromClusterSnapshotMessage"}, + "output":{ + "shape":"RestoreFromClusterSnapshotResult", + "resultWrapper":"RestoreFromClusterSnapshotResult" + }, + "errors":[ + {"shape":"AccessToSnapshotDeniedFault"}, + {"shape":"ClusterAlreadyExistsFault"}, + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"ClusterQuotaExceededFault"}, + {"shape":"InsufficientClusterCapacityFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"InvalidRestoreFault"}, + {"shape":"NumberOfNodesQuotaExceededFault"}, + {"shape":"NumberOfNodesPerClusterLimitExceededFault"}, + {"shape":"InvalidVPCNetworkStateFault"}, + {"shape":"InvalidClusterSubnetGroupStateFault"}, + {"shape":"InvalidSubnet"}, + {"shape":"ClusterSubnetGroupNotFoundFault"}, + {"shape":"UnauthorizedOperation"}, + {"shape":"HsmClientCertificateNotFoundFault"}, + {"shape":"HsmConfigurationNotFoundFault"}, + {"shape":"InvalidElasticIpFault"}, + {"shape":"ClusterParameterGroupNotFoundFault"}, + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"DependentServiceRequestThrottlingFault"}, + {"shape":"InvalidClusterTrackFault"}, + {"shape":"SnapshotScheduleNotFoundFault"}, + {"shape":"TagLimitExceededFault"}, + {"shape":"InvalidTagFault"} + ], + "documentation":"

    Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

    If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

    For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

    " + }, + "RestoreTableFromClusterSnapshot":{ + "name":"RestoreTableFromClusterSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreTableFromClusterSnapshotMessage"}, + "output":{ + "shape":"RestoreTableFromClusterSnapshotResult", + "resultWrapper":"RestoreTableFromClusterSnapshotResult" + }, + "errors":[ + {"shape":"ClusterSnapshotNotFoundFault"}, + {"shape":"InProgressTableRestoreQuotaExceededFault"}, + {"shape":"InvalidClusterSnapshotStateFault"}, + {"shape":"InvalidTableRestoreArgumentFault"}, + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"UnsupportedOperationFault"} + ], + "documentation":"

    Creates a new table from a table in an Amazon Redshift cluster snapshot. You must create the new table within the Amazon Redshift cluster that the snapshot was taken from.

    You cannot use RestoreTableFromClusterSnapshot to restore a table with the same name as an existing table in an Amazon Redshift cluster. That is, you cannot overwrite an existing table in a cluster with a restored table. If you want to replace your original table with a new, restored table, then rename or drop your original table before you call RestoreTableFromClusterSnapshot. When you have renamed your original table, then you can pass the original name of the table as the NewTableName parameter value in the call to RestoreTableFromClusterSnapshot. This way, you can replace the original table with the table created from the snapshot.

    " + }, + "RevokeClusterSecurityGroupIngress":{ + "name":"RevokeClusterSecurityGroupIngress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeClusterSecurityGroupIngressMessage"}, + "output":{ + "shape":"RevokeClusterSecurityGroupIngressResult", + "resultWrapper":"RevokeClusterSecurityGroupIngressResult" + }, + "errors":[ + {"shape":"ClusterSecurityGroupNotFoundFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"InvalidClusterSecurityGroupStateFault"} + ], + "documentation":"

    Revokes an ingress rule in an Amazon Redshift security group for a previously authorized IP range or Amazon EC2 security group. To add an ingress rule, see AuthorizeClusterSecurityGroupIngress. For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "RevokeSnapshotAccess":{ + "name":"RevokeSnapshotAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeSnapshotAccessMessage"}, + "output":{ + "shape":"RevokeSnapshotAccessResult", + "resultWrapper":"RevokeSnapshotAccessResult" + }, + "errors":[ + {"shape":"AccessToSnapshotDeniedFault"}, + {"shape":"AuthorizationNotFoundFault"}, + {"shape":"ClusterSnapshotNotFoundFault"} + ], + "documentation":"

    Removes the ability of the specified AWS customer account to restore the specified snapshot. If the account is currently restoring the snapshot, the restore will run to completion.

    For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

    " + }, + "RotateEncryptionKey":{ + "name":"RotateEncryptionKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RotateEncryptionKeyMessage"}, + "output":{ + "shape":"RotateEncryptionKeyResult", + "resultWrapper":"RotateEncryptionKeyResult" + }, + "errors":[ + {"shape":"ClusterNotFoundFault"}, + {"shape":"InvalidClusterStateFault"}, + {"shape":"DependentServiceRequestThrottlingFault"} + ], + "documentation":"

    Rotates the encryption keys for a cluster.

    " + } + }, + "shapes":{ + "AcceptReservedNodeExchangeInputMessage":{ + "type":"structure", + "required":[ + "ReservedNodeId", + "TargetReservedNodeOfferingId" + ], + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

    A string representing the node identifier of the DC1 Reserved Node to be exchanged.

    " + }, + "TargetReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

    The unique identifier of the DC2 Reserved Node offering to be used for the exchange. You can obtain the value for the parameter by calling GetReservedNodeExchangeOfferings

    " + } + } + }, + "AcceptReservedNodeExchangeOutputMessage":{ + "type":"structure", + "members":{ + "ExchangedReservedNode":{ + "shape":"ReservedNode", + "documentation":"

    " + } + } + }, + "AccessToSnapshotDeniedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The owner of the specified snapshot has not authorized your account to access the snapshot.

    ", + "error":{ + "code":"AccessToSnapshotDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AccountAttribute":{ + "type":"structure", + "members":{ + "AttributeName":{ + "shape":"String", + "documentation":"

    The name of the attribute.

    " + }, + "AttributeValues":{ + "shape":"AttributeValueList", + "documentation":"

    A list of attribute values.

    " + } + }, + "documentation":"

    A name value pair that describes an aspect of an account.

    " + }, + "AccountAttributeList":{ + "type":"structure", + "members":{ + "AccountAttributes":{ + "shape":"AttributeList", + "documentation":"

    A list of attributes assigned to an account.

    " + } + } + }, + "AccountWithRestoreAccess":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"String", + "documentation":"

    The identifier of an AWS customer account authorized to restore a snapshot.

    " + }, + "AccountAlias":{ + "shape":"String", + "documentation":"

    The identifier of an AWS support account authorized to restore a snapshot. For AWS support, the identifier is amazon-redshift-support.

    " + } + }, + "documentation":"

    Describes an AWS customer account authorized to restore a snapshot.

    " + }, + "AccountsWithRestoreAccessList":{ + "type":"list", + "member":{ + "shape":"AccountWithRestoreAccess", + "locationName":"AccountWithRestoreAccess" + } + }, + "ActionType":{ + "type":"string", + "enum":["restore-cluster"] + }, + "AssociatedClusterList":{ + "type":"list", + "member":{ + "shape":"ClusterAssociatedToSchedule", + "locationName":"ClusterAssociatedToSchedule" + } + }, + "AttributeList":{ + "type":"list", + "member":{ + "shape":"AccountAttribute", + "locationName":"AccountAttribute" + } + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeName" + } + }, + "AttributeValueList":{ + "type":"list", + "member":{ + "shape":"AttributeValueTarget", + "locationName":"AttributeValueTarget" + } + }, + "AttributeValueTarget":{ + "type":"structure", + "members":{ + "AttributeValue":{ + "shape":"String", + "documentation":"

    The value of the attribute.

    " + } + }, + "documentation":"

    Describes an attribute value.

    " + }, + "AuthorizationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified CIDR block or EC2 security group is already authorized for the specified cluster security group.

    ", + "error":{ + "code":"AuthorizationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified CIDR IP range or EC2 security group is not authorized for the specified cluster security group.

    ", + "error":{ + "code":"AuthorizationNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "AuthorizationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The authorization quota for the cluster security group has been reached.

    ", + "error":{ + "code":"AuthorizationQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AuthorizeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the security group to which the ingress rule is added.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range to be added the Amazon Redshift security group.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    The EC2 security group to be added the Amazon Redshift security group.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    The AWS account number of the owner of the security group specified by the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value.

    Example: 111122223333

    " + } + }, + "documentation":"

    " + }, + "AuthorizeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "AuthorizeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot the account is authorized to restore.

    " + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    " + }, + "AccountWithRestoreAccess":{ + "shape":"String", + "documentation":"

    The identifier of the AWS customer account authorized to restore the specified snapshot.

    To share a snapshot with AWS support, specify amazon-redshift-support.

    " + } + }, + "documentation":"

    " + }, + "AuthorizeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "AvailabilityZone":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the availability zone.

    " + }, + "SupportedPlatforms":{ + "shape":"SupportedPlatformsList", + "documentation":"

    " + } + }, + "documentation":"

    Describes an availability zone.

    ", + "wrapper":true + }, + "AvailabilityZoneList":{ + "type":"list", + "member":{ + "shape":"AvailabilityZone", + "locationName":"AvailabilityZone" + } + }, + "BatchDeleteClusterSnapshotsRequest":{ + "type":"structure", + "required":["Identifiers"], + "members":{ + "Identifiers":{ + "shape":"DeleteClusterSnapshotMessageList", + "documentation":"

    A list of identifiers for the snapshots that you want to delete.

    " + } + } + }, + "BatchDeleteClusterSnapshotsResult":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"SnapshotIdentifierList", + "documentation":"

    A list of the snapshot identifiers that were deleted.

    " + }, + "Errors":{ + "shape":"BatchSnapshotOperationErrorList", + "documentation":"

    A list of any errors returned.

    " + } + } + }, + "BatchDeleteRequestSizeExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The maximum number for a batch delete of snapshots has been reached. The limit is 100.

    ", + "error":{ + "code":"BatchDeleteRequestSizeExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchModifyClusterSnapshotsLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The maximum number for snapshot identifiers has been reached. The limit is 100.

    ", + "error":{ + "code":"BatchModifyClusterSnapshotsLimitExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchModifyClusterSnapshotsMessage":{ + "type":"structure", + "required":["SnapshotIdentifierList"], + "members":{ + "SnapshotIdentifierList":{ + "shape":"SnapshotIdentifierList", + "documentation":"

    A list of snapshot identifiers you want to modify.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If you specify the value -1, the manual snapshot is retained indefinitely.

    The number must be either -1 or an integer between 1 and 3,653.

    If you decrease the manual snapshot retention period from its current value, existing manual snapshots that fall outside of the new retention period will return an error. If you want to suppress the errors and delete the snapshots, use the force option.

    " + }, + "Force":{ + "shape":"Boolean", + "documentation":"

    A boolean value indicating whether to override an exception if the retention period has passed.

    " + } + } + }, + "BatchModifyClusterSnapshotsOutputMessage":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"SnapshotIdentifierList", + "documentation":"

    A list of the snapshots that were modified.

    " + }, + "Errors":{ + "shape":"BatchSnapshotOperationErrors", + "documentation":"

    A list of any errors returned.

    " + } + } + }, + "BatchSnapshotOperationErrorList":{ + "type":"list", + "member":{ + "shape":"SnapshotErrorMessage", + "locationName":"SnapshotErrorMessage" + } + }, + "BatchSnapshotOperationErrors":{ + "type":"list", + "member":{ + "shape":"SnapshotErrorMessage", + "locationName":"SnapshotErrorMessage" + } + }, + "Boolean":{"type":"boolean"}, + "BooleanOptional":{"type":"boolean"}, + "BucketNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Could not find the specified S3 bucket.

    ", + "error":{ + "code":"BucketNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CancelResizeMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier for the cluster that you want to cancel a resize operation for.

    " + } + } + }, + "Cluster":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type for the nodes in the cluster.

    " + }, + "ClusterStatus":{ + "shape":"String", + "documentation":"

    The current state of the cluster. Possible values are the following:

    • available

    • available, prep-for-resize

    • available, resize-cleanup

    • cancelling-resize

    • creating

    • deleting

    • final-snapshot

    • hardware-failure

    • incompatible-hsm

    • incompatible-network

    • incompatible-parameters

    • incompatible-restore

    • modifying

    • rebooting

    • renaming

    • resizing

    • rotating-keys

    • storage-full

    • updating-hsm

    " + }, + "ClusterAvailabilityStatus":{ + "shape":"String", + "documentation":"

    The availability status of the cluster for queries. Possible values are the following:

    • Available - The cluster is available for queries.

    • Unavailable - The cluster is not available for queries.

    • Maintenance - The cluster is intermittently available for queries due to maintenance activities.

    • Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.

    • Failed - The cluster failed and is not available for queries.

    " + }, + "ModifyStatus":{ + "shape":"String", + "documentation":"

    The status of a modify operation, if any, initiated for the cluster.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

    " + }, + "Endpoint":{ + "shape":"Endpoint", + "documentation":"

    The connection endpoint.

    " + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

    The date and time that the cluster was created.

    " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"

    The number of days that automatic cluster snapshots are retained.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"

    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupMembershipList", + "documentation":"

    A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

    Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

    " + }, + "VpcSecurityGroups":{ + "shape":"VpcSecurityGroupMembershipList", + "documentation":"

    A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

    " + }, + "ClusterParameterGroups":{ + "shape":"ClusterParameterGroupStatusList", + "documentation":"

    The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

    " + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    The identifier of the VPC the cluster is in, if the cluster is in a VPC.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The name of the Availability Zone in which the cluster is located.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.

    " + }, + "PendingModifiedValues":{ + "shape":"PendingModifiedValues", + "documentation":"

    A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

    " + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " + }, + "AllowVersionUpgrade":{ + "shape":"Boolean", + "documentation":"

    A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

    " + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

    The number of compute nodes in the cluster.

    " + }, + "PubliclyAccessible":{ + "shape":"Boolean", + "documentation":"

    A boolean value that, if true, indicates that the cluster can be accessed from a public network.

    " + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

    A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

    " + }, + "RestoreStatus":{ + "shape":"RestoreStatus", + "documentation":"

    A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

    " + }, + "DataTransferProgress":{ + "shape":"DataTransferProgress", + "documentation":"

    " + }, + "HsmStatus":{ + "shape":"HsmStatus", + "documentation":"

    A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

    Values: active, applying

    " + }, + "ClusterSnapshotCopyStatus":{ + "shape":"ClusterSnapshotCopyStatus", + "documentation":"

    A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

    " + }, + "ClusterPublicKey":{ + "shape":"String", + "documentation":"

    The public key for the cluster.

    " + }, + "ClusterNodes":{ + "shape":"ClusterNodesList", + "documentation":"

    The nodes in the cluster.

    " + }, + "ElasticIpStatus":{ + "shape":"ElasticIpStatus", + "documentation":"

    The status of the elastic IP (EIP) address.

    " + }, + "ClusterRevisionNumber":{ + "shape":"String", + "documentation":"

    The specific revision number of the database in the cluster.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the cluster.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

    " + }, + "EnhancedVpcRouting":{ + "shape":"Boolean", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "IamRoles":{ + "shape":"ClusterIamRoleList", + "documentation":"

    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

    " + }, + "PendingActions":{ + "shape":"PendingActionsList", + "documentation":"

    Cluster operations that are waiting to be started.

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track for the cluster.

    " + }, + "ElasticResizeNumberOfNodeOptions":{ + "shape":"String", + "documentation":"

    The number of nodes that you can resize the cluster to with the elastic resize method.

    " + }, + "DeferredMaintenanceWindows":{ + "shape":"DeferredMaintenanceWindowsList", + "documentation":"

    Describes a group of DeferredMaintenanceWindow objects.

    " + }, + "SnapshotScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the cluster snapshot schedule.

    " + }, + "SnapshotScheduleState":{ + "shape":"ScheduleState", + "documentation":"

    The current state of the cluster snapshot schedule.

    " + }, + "ExpectedNextSnapshotScheduleTime":{ + "shape":"TStamp", + "documentation":"

    The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

    " + }, + "ExpectedNextSnapshotScheduleTimeStatus":{ + "shape":"String", + "documentation":"

    The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

    • OnTrack - The next snapshot is expected to be taken on time.

    • Pending - The next snapshot is pending to be taken.

    " + }, + "NextMaintenanceWindowStartTime":{ + "shape":"TStamp", + "documentation":"

    The date and time in UTC when system maintenance can begin.

    " + }, + "ResizeInfo":{ + "shape":"ResizeInfo", + "documentation":"

    Returns the following:

    • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

    • ResizeType: Returns ClassicResize

    " + } + }, + "documentation":"

    Describes a cluster.

    ", + "wrapper":true + }, + "ClusterAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The account already has a cluster with the given identifier.

    ", + "error":{ + "code":"ClusterAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterAssociatedToSchedule":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    " + }, + "ScheduleAssociationState":{ + "shape":"ScheduleState", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "ClusterCredentials":{ + "type":"structure", + "members":{ + "DbUser":{ + "shape":"String", + "documentation":"

    A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.

    " + }, + "DbPassword":{ + "shape":"SensitiveString", + "documentation":"

    A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.

    " + }, + "Expiration":{ + "shape":"TStamp", + "documentation":"

    The date and time the password in DbPassword expires.

    " + } + }, + "documentation":"

    Temporary credentials with authorization to log on to an Amazon Redshift database.

    " + }, + "ClusterDbRevision":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster.

    " + }, + "CurrentDatabaseRevision":{ + "shape":"String", + "documentation":"

    A string representing the current cluster version.

    " + }, + "DatabaseRevisionReleaseDate":{ + "shape":"TStamp", + "documentation":"

    The date on which the database revision was released.

    " + }, + "RevisionTargets":{ + "shape":"RevisionTargetsList", + "documentation":"

    A list of RevisionTarget objects, where each object describes the database revision that a cluster can be updated to.

    " + } + }, + "documentation":"

    Describes a ClusterDbRevision.

    " + }, + "ClusterDbRevisionsList":{ + "type":"list", + "member":{ + "shape":"ClusterDbRevision", + "locationName":"ClusterDbRevision" + } + }, + "ClusterDbRevisionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A string representing the starting point for the next set of revisions. If a value is returned in a response, you can retrieve the next set of revisions by providing the value in the marker parameter and retrying the command. If the marker field is empty, all revisions have already been returned.

    " + }, + "ClusterDbRevisions":{ + "shape":"ClusterDbRevisionsList", + "documentation":"

    A list of revisions.

    " + } + } + }, + "ClusterIamRole":{ + "type":"structure", + "members":{ + "IamRoleArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role, for example, arn:aws:iam::123456789012:role/RedshiftCopyUnload.

    " + }, + "ApplyStatus":{ + "shape":"String", + "documentation":"

    A value that describes the status of the IAM role's association with an Amazon Redshift cluster.

    The following are possible statuses and descriptions.

    • in-sync: The role is available for use by the cluster.

    • adding: The role is in the process of being associated with the cluster.

    • removing: The role is in the process of being disassociated with the cluster.

    " + } + }, + "documentation":"

    An AWS Identity and Access Management (IAM) role that can be used by the associated Amazon Redshift cluster to access other AWS services.

    " + }, + "ClusterIamRoleList":{ + "type":"list", + "member":{ + "shape":"ClusterIamRole", + "locationName":"ClusterIamRole" + } + }, + "ClusterList":{ + "type":"list", + "member":{ + "shape":"Cluster", + "locationName":"Cluster" + } + }, + "ClusterNode":{ + "type":"structure", + "members":{ + "NodeRole":{ + "shape":"String", + "documentation":"

    Whether the node is a leader node or a compute node.

    " + }, + "PrivateIPAddress":{ + "shape":"String", + "documentation":"

    The private IP address of a node within a cluster.

    " + }, + "PublicIPAddress":{ + "shape":"String", + "documentation":"

    The public IP address of a node within a cluster.

    " + } + }, + "documentation":"

    The identifier of a node in a cluster.

    " + }, + "ClusterNodesList":{ + "type":"list", + "member":{"shape":"ClusterNode"} + }, + "ClusterNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The ClusterIdentifier parameter does not refer to an existing cluster.

    ", + "error":{ + "code":"ClusterNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterOnLatestRevisionFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Cluster is already on the latest database revision.

    ", + "error":{ + "code":"ClusterOnLatestRevision", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroup":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group.

    " + }, + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group family that this cluster parameter group is compatible with.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the parameter group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the cluster parameter group.

    " + } + }, + "documentation":"

    Describes a parameter group.

    ", + "wrapper":true + }, + "ClusterParameterGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A cluster parameter group with the same name already exists.

    ", + "error":{ + "code":"ClusterParameterGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupDetails":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    A list of Parameter instances. Each instance lists the parameters of one cluster parameter group.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusterParameters action.

    " + }, + "ClusterParameterGroupNameMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group.

    " + }, + "ParameterGroupStatus":{ + "shape":"String", + "documentation":"

    The status of the parameter group. For example, if you made a change to a parameter group name-value pair, then the change could be pending a reboot of an associated cluster.

    " + } + }, + "documentation":"

    " + }, + "ClusterParameterGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The parameter group name does not refer to an existing parameter group.

    ", + "error":{ + "code":"ClusterParameterGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of cluster parameter groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"ClusterParameterGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterParameterGroupStatus":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group.

    " + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

    The status of parameter updates.

    " + }, + "ClusterParameterStatusList":{ + "shape":"ClusterParameterStatusList", + "documentation":"

    The list of parameter statuses.

    For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + } + }, + "documentation":"

    Describes the status of a parameter group.

    " + }, + "ClusterParameterGroupStatusList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroupStatus", + "locationName":"ClusterParameterGroup" + } + }, + "ClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ParameterGroups":{ + "shape":"ParameterGroupList", + "documentation":"

    A list of ClusterParameterGroup instances. Each instance describes one cluster parameter group.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusterParameterGroups action.

    " + }, + "ClusterParameterStatus":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

    The name of the parameter.

    " + }, + "ParameterApplyStatus":{ + "shape":"String", + "documentation":"

    The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

    The following are possible statuses and descriptions.

    • in-sync: The parameter value is in sync with the database.

    • pending-reboot: The parameter value will be applied after the cluster reboots.

    • applying: The parameter value is being applied to the database.

    • invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.

    • apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.

    • apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.

    • unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

    " + }, + "ParameterApplyErrorDescription":{ + "shape":"String", + "documentation":"

    The error that prevented the parameter from being applied to the database.

    " + } + }, + "documentation":"

    Describes the status of a parameter group.

    " + }, + "ClusterParameterStatusList":{ + "type":"list", + "member":{"shape":"ClusterParameterStatus"} + }, + "ClusterQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"ClusterQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroup":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster security group to which the operation was applied.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description of the security group.

    " + }, + "EC2SecurityGroups":{ + "shape":"EC2SecurityGroupList", + "documentation":"

    A list of EC2 security groups that are permitted to access clusters associated with this cluster security group.

    " + }, + "IPRanges":{ + "shape":"IPRangeList", + "documentation":"

    A list of IP ranges (CIDR blocks) that are permitted to access clusters associated with this cluster security group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the cluster security group.

    " + } + }, + "documentation":"

    Describes a security group.

    ", + "wrapper":true + }, + "ClusterSecurityGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A cluster security group with the same name already exists.

    ", + "error":{ + "code":"ClusterSecurityGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroupMembership":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the cluster security group.

    " + } + }, + "documentation":"

    Describes a cluster security group.

    " + }, + "ClusterSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroupMembership", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSecurityGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroups", + "documentation":"

    A list of ClusterSecurityGroup instances.

    " + } + }, + "documentation":"

    " + }, + "ClusterSecurityGroupNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ClusterSecurityGroupName" + } + }, + "ClusterSecurityGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster security group name does not refer to an existing cluster security group.

    ", + "error":{ + "code":"ClusterSecurityGroupNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of cluster security groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"QuotaExceeded.ClusterSecurityGroup", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSecurityGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSecurityGroup", + "locationName":"ClusterSecurityGroup" + } + }, + "ClusterSnapshotAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The value specified as a snapshot identifier is already used by an existing snapshot.

    ", + "error":{ + "code":"ClusterSnapshotAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSnapshotCopyStatus":{ + "type":"structure", + "members":{ + "DestinationRegion":{ + "shape":"String", + "documentation":"

    The destination region that snapshots are automatically copied to when cross-region snapshot copy is enabled.

    " + }, + "RetentionPeriod":{ + "shape":"Long", + "documentation":"

    The number of days that automated snapshots are retained in the destination region after they are copied from a source region.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"Integer", + "documentation":"

    The number of days that automated snapshots are retained in the destination region after they are copied from a source region. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant.

    " + } + }, + "documentation":"

    Returns the destination region and retention period that are configured for cross-region snapshot copy.

    " + }, + "ClusterSnapshotNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The snapshot identifier does not refer to an existing cluster snapshot.

    ", + "error":{ + "code":"ClusterSnapshotNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ClusterSnapshotQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in the user exceeding the allowed number of cluster snapshots.

    ", + "error":{ + "code":"ClusterSnapshotQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroup":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster subnet group.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the cluster subnet group.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    The VPC ID of the cluster subnet group.

    " + }, + "SubnetGroupStatus":{ + "shape":"String", + "documentation":"

    The status of the cluster subnet group. Possible values are Complete, Incomplete and Invalid.

    " + }, + "Subnets":{ + "shape":"SubnetList", + "documentation":"

    A list of the VPC Subnet elements.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the cluster subnet group.

    " + } + }, + "documentation":"

    Describes a subnet group.

    ", + "wrapper":true + }, + "ClusterSubnetGroupAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A ClusterSubnetGroupName is already used by an existing cluster subnet group.

    ", + "error":{ + "code":"ClusterSubnetGroupAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroupMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ClusterSubnetGroups":{ + "shape":"ClusterSubnetGroups", + "documentation":"

    A list of ClusterSubnetGroup instances.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusterSubnetGroups action.

    " + }, + "ClusterSubnetGroupNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster subnet group name does not refer to an existing cluster subnet group.

    ", + "error":{ + "code":"ClusterSubnetGroupNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroupQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in user exceeding the allowed number of cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"ClusterSubnetGroupQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterSubnetGroups":{ + "type":"list", + "member":{ + "shape":"ClusterSubnetGroup", + "locationName":"ClusterSubnetGroup" + } + }, + "ClusterSubnetQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would result in user exceeding the allowed number of subnets in a cluster subnet groups. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"ClusterSubnetQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ClusterVersion":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version number used by the cluster.

    " + }, + "ClusterParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group family for the cluster.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the cluster version.

    " + } + }, + "documentation":"

    Describes a cluster version, including the parameter group family and description of the version.

    " + }, + "ClusterVersionList":{ + "type":"list", + "member":{ + "shape":"ClusterVersion", + "locationName":"ClusterVersion" + } + }, + "ClusterVersionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ClusterVersions":{ + "shape":"ClusterVersionList", + "documentation":"

    A list of Version elements.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusterVersions action.

    " + }, + "ClustersMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "Clusters":{ + "shape":"ClusterList", + "documentation":"

    A list of Cluster objects, where each object describes one cluster.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusters action.

    " + }, + "CopyClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SourceSnapshotIdentifier", + "TargetSnapshotIdentifier" + ], + "members":{ + "SourceSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the source snapshot.

    Constraints:

    • Must be the identifier for a valid automated snapshot whose state is available.

    " + }, + "SourceSnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    Constraints:

    • Must be the identifier for a valid cluster.

    " + }, + "TargetSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier given to the new manual snapshot.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for the AWS account that is making the request.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    " + } + }, + "documentation":"

    " + }, + "CopyClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CopyToRegionDisabledFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Cross-region snapshot copy was temporarily disabled. Try your request again.

    ", + "error":{ + "code":"CopyToRegionDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CreateClusterMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "NodeType", + "MasterUsername", + "MasterUserPassword" + ], + "members":{ + "DBName":{ + "shape":"String", + "documentation":"

    The name of the first database to be created when the cluster is created.

    To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

    Default: dev

    Constraints:

    • Must contain 1 to 64 alphanumeric characters.

    • Must contain only lowercase letters.

    • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    Example: myexamplecluster

    " + }, + "ClusterType":{ + "shape":"String", + "documentation":"

    The type of the cluster. When cluster type is specified as

    • single-node, the NumberOfNodes parameter is not required.

    • multi-node, the NumberOfNodes parameter is required.

    Valid Values: multi-node | single-node

    Default: multi-node

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    Valid Values: ds2.xlarge | ds2.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The user name associated with the master user account for the cluster that is being created.

    Constraints:

    • Must be 1 - 128 alphanumeric characters. The user name can't be PUBLIC.

    • First character must be a letter.

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The password associated with the master user account for the cluster that is being created.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.

    " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

    A list of security groups to be associated with this cluster.

    Default: The default cluster security group for Amazon Redshift.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

    " + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of a cluster subnet group to be associated with this cluster.

    If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.

    Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

    Example: us-east-1d

    Constraint: The specified Availability Zone must be in the same region as the current endpoint.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

    " + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    Default: 1

    Constraints: Must be a value from 0 to 35.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the cluster accepts incoming connections.

    The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.

    Default: 5439

    Valid Values: 1150-65535

    " + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version of the Amazon Redshift engine software that you want to deploy on the cluster.

    The version selected runs on all the nodes in the cluster.

    Constraints: Only version 1.0 is currently available.

    Example: 1.0

    " + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

    Default: true

    " + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

    The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node.

    For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.

    If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

    Default: 1

    Constraints: Value must be at least 1 and no more than 100.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    If true, the cluster can be accessed from a public network.

    " + }, + "Encrypted":{ + "shape":"BooleanOptional", + "documentation":"

    If true, the data in the cluster is encrypted at rest.

    Default: false

    " + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

    " + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

    " + }, + "EnhancedVpcRouting":{ + "shape":"BooleanOptional", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

    Reserved.

    " + }, + "IamRoles":{ + "shape":"IamRoleArnList", + "documentation":"

    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

    A cluster can have up to 10 IAM roles associated with it at any time.

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

    " + }, + "SnapshotScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the snapshot schedule.

    " + } + }, + "documentation":"

    " + }, + "CreateClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "ParameterGroupFamily", + "Description" + ], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique withing your AWS account.

    This value is stored as a lower-case string.

    " + }, + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters.

    To get a list of valid parameter group family names, you can call DescribeClusterParameterGroups. By default, Amazon Redshift returns a list of all the parameter groups that are owned by your AWS account, including the default parameter groups for each Amazon Redshift engine version. The parameter group family names associated with the default parameter groups provide you the valid values. For example, a valid family name is \"redshift-1.0\".

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description of the parameter group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateClusterParameterGroupResult":{ + "type":"structure", + "members":{ + "ClusterParameterGroup":{"shape":"ClusterParameterGroup"} + } + }, + "CreateClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "CreateClusterSecurityGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSecurityGroupName", + "Description" + ], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name for the security group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be \"Default\".

    • Must be unique for all security groups that are created by your AWS account.

    Example: examplesecuritygroup

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description for the security group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateClusterSecurityGroupResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "CreateClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "ClusterIdentifier" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the AWS account.

    Constraints:

    • Cannot be null, empty, or blank

    • Must contain from 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    Example: my-snapshot-id

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The cluster identifier for which you want a snapshot.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "CreateClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "Description", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name for the subnet group. Amazon Redshift stores the value as a lowercase string.

    Constraints:

    • Must contain no more than 255 alphanumeric characters or hyphens.

    • Must not be \"Default\".

    • Must be unique for all subnet groups that are created by your AWS account.

    Example: examplesubnetgroup

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description for the subnet group.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "CreateEventSubscriptionMessage":{ + "type":"structure", + "required":[ + "SubscriptionName", + "SnsTopicArn" + ], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the event subscription to be created.

    Constraints:

    • Cannot be null, empty, or blank.

    • Must contain from 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

    " + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    Specifies the Amazon Redshift event categories to be published by the event notification subscription.

    Values: configuration, management, monitoring, security

    " + }, + "Severity":{ + "shape":"String", + "documentation":"

    Specifies the Amazon Redshift event severity to be published by the event notification subscription.

    Values: ERROR, INFO

    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "CreateHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    The identifier to be assigned to the new HSM client certificate that the cluster will use to connect to the HSM to use the database encryption keys.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateHsmClientCertificateResult":{ + "type":"structure", + "members":{ + "HsmClientCertificate":{"shape":"HsmClientCertificate"} + } + }, + "CreateHsmConfigurationMessage":{ + "type":"structure", + "required":[ + "HsmConfigurationIdentifier", + "Description", + "HsmIpAddress", + "HsmPartitionName", + "HsmPartitionPassword", + "HsmServerPublicCertificate" + ], + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    The identifier to be assigned to the new Amazon Redshift HSM configuration.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A text description of the HSM configuration to be created.

    " + }, + "HsmIpAddress":{ + "shape":"String", + "documentation":"

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    " + }, + "HsmPartitionName":{ + "shape":"String", + "documentation":"

    The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

    " + }, + "HsmPartitionPassword":{ + "shape":"String", + "documentation":"

    The password required to access the HSM partition.

    " + }, + "HsmServerPublicCertificate":{ + "shape":"String", + "documentation":"

    The HSMs public certificate file. When using Cloud HSM, the file name is server.pem.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    " + }, + "CreateHsmConfigurationResult":{ + "type":"structure", + "members":{ + "HsmConfiguration":{"shape":"HsmConfiguration"} + } + }, + "CreateSnapshotCopyGrantMessage":{ + "type":"structure", + "required":["SnapshotCopyGrantName"], + "members":{ + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant. This name must be unique in the region for the AWS account.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The unique identifier of the customer master key (CMK) to which to grant Amazon Redshift permission. If no key is specified, the default key is used.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    The result of the CreateSnapshotCopyGrant action.

    " + }, + "CreateSnapshotCopyGrantResult":{ + "type":"structure", + "members":{ + "SnapshotCopyGrant":{"shape":"SnapshotCopyGrant"} + } + }, + "CreateSnapshotScheduleMessage":{ + "type":"structure", + "members":{ + "ScheduleDefinitions":{ + "shape":"ScheduleDefinitionList", + "documentation":"

    The definition of the snapshot schedule. The definition is made up of schedule expressions, for example \"cron(30 12 *)\" or \"rate(12 hours)\".

    " + }, + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for a snapshot schedule. Only alphanumeric characters are allowed for the identifier.

    " + }, + "ScheduleDescription":{ + "shape":"String", + "documentation":"

    The description of the snapshot schedule.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An optional set of tags you can use to search for the schedule.

    " + }, + "DryRun":{ + "shape":"BooleanOptional", + "documentation":"

    " + }, + "NextInvocations":{ + "shape":"IntegerOptional", + "documentation":"

    " + } + } + }, + "CreateTagsMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "Tags" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) to which you want to add the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    One or more name/value pairs to add as tags to the specified resource. Each tag name is passed in with the parameter Key and the corresponding value is passed in with the parameter Value. The Key and Value parameters are separated by a comma (,). Separate multiple tags with a space. For example, --tags \"Key\"=\"owner\",\"Value\"=\"admin\" \"Key\"=\"environment\",\"Value\"=\"test\" \"Key\"=\"version\",\"Value\"=\"1.0\".

    " + } + }, + "documentation":"

    Contains the output from the CreateTags action.

    " + }, + "CustomerStorageMessage":{ + "type":"structure", + "members":{ + "TotalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"

    The total amount of storage currently used for snapshots.

    " + }, + "TotalProvisionedStorageInMegaBytes":{ + "shape":"Double", + "documentation":"

    The total amount of storage currently provisioned.

    " + } + } + }, + "DataTransferProgress":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Describes the status of the cluster. While the transfer is in progress the status is transferringdata.

    " + }, + "CurrentRateInMegaBytesPerSecond":{ + "shape":"DoubleOptional", + "documentation":"

    Describes the data transfer rate in MB's per second.

    " + }, + "TotalDataInMegaBytes":{ + "shape":"Long", + "documentation":"

    Describes the total amount of data to be transfered in megabytes.

    " + }, + "DataTransferredInMegaBytes":{ + "shape":"Long", + "documentation":"

    Describes the total amount of data that has been transfered in MB's.

    " + }, + "EstimatedTimeToCompletionInSeconds":{ + "shape":"LongOptional", + "documentation":"

    Describes the estimated number of seconds remaining to complete the transfer.

    " + }, + "ElapsedTimeInSeconds":{ + "shape":"LongOptional", + "documentation":"

    Describes the number of seconds that have elapsed during the data transfer.

    " + } + }, + "documentation":"

    Describes the status of a cluster while it is in the process of resizing with an incremental resize.

    " + }, + "DbGroupList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DbGroup" + } + }, + "DefaultClusterParameters":{ + "type":"structure", + "members":{ + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group family to which the engine default parameters apply.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    The list of cluster default parameters.

    " + } + }, + "documentation":"

    Describes the default cluster parameters for a parameter group family.

    ", + "wrapper":true + }, + "DeferredMaintenanceWindow":{ + "type":"structure", + "members":{ + "DeferMaintenanceIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the maintenance window.

    " + }, + "DeferMaintenanceStartTime":{ + "shape":"TStamp", + "documentation":"

    A timestamp for the beginning of the time period when we defer maintenance.

    " + }, + "DeferMaintenanceEndTime":{ + "shape":"TStamp", + "documentation":"

    A timestamp for the end of the time period when we defer maintenance.

    " + } + }, + "documentation":"

    Describes a deferred maintenance window

    " + }, + "DeferredMaintenanceWindowsList":{ + "type":"list", + "member":{ + "shape":"DeferredMaintenanceWindow", + "locationName":"DeferredMaintenanceWindow" + } + }, + "DeleteClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster to be deleted.

    Constraints:

    • Must contain lowercase characters.

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    " + }, + "SkipFinalClusterSnapshot":{ + "shape":"Boolean", + "documentation":"

    Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true, a final cluster snapshot is not created. If false, a final cluster snapshot is created before the cluster is deleted.

    The FinalClusterSnapshotIdentifier parameter must be specified if SkipFinalClusterSnapshot is false.

    Default: false

    " + }, + "FinalClusterSnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false.

    Constraints:

    • Must be 1 to 255 alphanumeric characters.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    " + }, + "FinalClusterSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    " + } + }, + "documentation":"

    " + }, + "DeleteClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the parameter group to be deleted.

    Constraints:

    • Must be the name of an existing cluster parameter group.

    • Cannot delete a default cluster parameter group.

    " + } + }, + "documentation":"

    " + }, + "DeleteClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "DeleteClusterSecurityGroupMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster security group to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteClusterSnapshotMessage":{ + "type":"structure", + "required":["SnapshotIdentifier"], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the manual snapshot to be deleted.

    Constraints: Must be the name of an existing snapshot that is in the available, failed, or cancelled state.

    " + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    Constraints: Must be the name of valid cluster.

    " + } + }, + "documentation":"

    " + }, + "DeleteClusterSnapshotMessageList":{ + "type":"list", + "member":{ + "shape":"DeleteClusterSnapshotMessage", + "locationName":"DeleteClusterSnapshotMessage" + } + }, + "DeleteClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "DeleteClusterSubnetGroupMessage":{ + "type":"structure", + "required":["ClusterSubnetGroupName"], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster subnet group name to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the Amazon Redshift event notification subscription to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteHsmClientCertificateMessage":{ + "type":"structure", + "required":["HsmClientCertificateIdentifier"], + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the HSM client certificate to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteHsmConfigurationMessage":{ + "type":"structure", + "required":["HsmConfigurationIdentifier"], + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the Amazon Redshift HSM configuration to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteSnapshotCopyGrantMessage":{ + "type":"structure", + "required":["SnapshotCopyGrantName"], + "members":{ + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant to delete.

    " + } + }, + "documentation":"

    The result of the DeleteSnapshotCopyGrant action.

    " + }, + "DeleteSnapshotScheduleMessage":{ + "type":"structure", + "required":["ScheduleIdentifier"], + "members":{ + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier of the snapshot schedule to delete.

    " + } + } + }, + "DeleteTagsMessage":{ + "type":"structure", + "required":[ + "ResourceName", + "TagKeys" + ], + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) from which you want to remove the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tag key that you want to delete.

    " + } + }, + "documentation":"

    Contains the output from the DeleteTags action.

    " + }, + "DependentServiceRequestThrottlingFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

    ", + "error":{ + "code":"DependentServiceRequestThrottlingFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DependentServiceUnavailableFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

    ", + "error":{ + "code":"DependentServiceUnavailableFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "DescribeAccountAttributesMessage":{ + "type":"structure", + "members":{ + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

    A list of attribute names.

    " + } + } + }, + "DescribeClusterDbRevisionsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for a cluster whose ClusterDbRevisions you are requesting. This parameter is case sensitive. All clusters defined for an account are returned by default.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a DescribeClusterDbRevisions request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter, or the marker parameter, but not both.

    " + } + } + }, + "DescribeClusterParameterGroupsMessage":{ + "type":"structure", + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a specific parameter group for which to return details. By default, details about all parameter groups and the default parameter group are returned.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameterGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching cluster parameter groups that are associated with the specified key or keys. For example, suppose that you have parameter groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching cluster parameter groups that are associated with the specified tag value or values. For example, suppose that you have parameter groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the parameter groups that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of a cluster parameter group for which to return details.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    The parameter types to return. Specify user to show parameters that are different form the default. Similarly, specify engine-default to show parameters that are the same as the default parameter group.

    Default: All parameter types returned.

    Valid Values: user | engine-default

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeClusterSecurityGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

    Example: securitygroup1

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeClusterSnapshotsMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster which generated the requested snapshots.

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The snapshot identifier of the snapshot about which to return information.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    The type of snapshots for which you are requesting information. By default, snapshots of all types are returned.

    Valid Values: automated | manual

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    A value that requests only snapshots created at or after the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

    " + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

    A time value that requests only snapshots created at or before the specified time. The time value is specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2012-07-16T18:00:00Z

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSnapshots request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

    The AWS customer account used to create or copy the snapshot. Use this field to filter the results to snapshots owned by a particular account. To describe snapshots you own, either specify your AWS customer account, or do not specify the parameter.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching cluster snapshots that are associated with the specified key or keys. For example, suppose that you have snapshots that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching cluster snapshots that are associated with the specified tag value or values. For example, suppose that you have snapshots that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the snapshots that have either or both of these tag values associated with them.

    " + }, + "ClusterExists":{ + "shape":"BooleanOptional", + "documentation":"

    A value that indicates whether to return snapshots only for an existing cluster. You can perform table-level restore only by using a snapshot of an existing cluster, that is, a cluster that has not been deleted. Values for this parameter work as follows:

    • If ClusterExists is set to true, ClusterIdentifier is required.

    • If ClusterExists is set to false and ClusterIdentifier isn't specified, all snapshots associated with deleted clusters (orphaned snapshots) are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for a deleted cluster, snapshots associated with that cluster are returned.

    • If ClusterExists is set to false and ClusterIdentifier is specified for an existing cluster, no snapshots are returned.

    " + }, + "SortingEntities":{ + "shape":"SnapshotSortingEntityList", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "DescribeClusterSubnetGroupsMessage":{ + "type":"structure", + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster subnet group for which information is requested.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSubnetGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching cluster subnet groups that are associated with the specified key or keys. For example, suppose that you have subnet groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching cluster subnet groups that are associated with the specified tag value or values. For example, suppose that you have subnet groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subnet groups that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeClusterTracksMessage":{ + "type":"structure", + "members":{ + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    An integer value for the maximum number of maintenance tracks to return.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterTracks request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + } + }, + "DescribeClusterVersionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The specific cluster version to return.

    Example: 1.0

    " + }, + "ClusterParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of a specific cluster parameter group family to return details for.

    Constraints:

    • Must be 1 to 255 alphanumeric characters

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterVersions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeClustersMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of a cluster whose properties you are requesting. This parameter is case sensitive.

    The default is that all clusters defined for an account are returned.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the ClusterIdentifier parameter or the Marker parameter, but not both.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching clusters that are associated with the specified key or keys. For example, suppose that you have clusters that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching clusters that are associated with the specified tag value or values. For example, suppose that you have clusters that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the clusters that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeDefaultClusterParametersMessage":{ + "type":"structure", + "required":["ParameterGroupFamily"], + "members":{ + "ParameterGroupFamily":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group family.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeDefaultClusterParametersResult":{ + "type":"structure", + "members":{ + "DefaultClusterParameters":{"shape":"DefaultClusterParameters"} + } + }, + "DescribeEventCategoriesMessage":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The source type, such as cluster or parameter group, to which the described event categories apply.

    Valid values: cluster, cluster-snapshot, cluster-parameter-group, and cluster-security-group.

    " + } + }, + "documentation":"

    " + }, + "DescribeEventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the Amazon Redshift event notification subscription to be described.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEventSubscriptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching event notification subscriptions that are associated with the specified key or keys. For example, suppose that you have subscriptions that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching event notification subscriptions that are associated with the specified tag value or values. For example, suppose that you have subscriptions that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the subscriptions that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeEventsMessage":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.

    Constraints:

    If SourceIdentifier is supplied, SourceType must also be provided.

    • Specify a cluster identifier when SourceType is cluster.

    • Specify a cluster security group name when SourceType is cluster-security-group.

    • Specify a cluster parameter group name when SourceType is cluster-parameter-group.

    • Specify a cluster snapshot identifier when SourceType is cluster-snapshot.

    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    The event source to retrieve events for. If no value is specified, all events are returned.

    Constraints:

    If SourceType is supplied, SourceIdentifier must also be provided.

    • Specify cluster when SourceIdentifier is a cluster identifier.

    • Specify cluster-security-group when SourceIdentifier is a cluster security group name.

    • Specify cluster-parameter-group when SourceIdentifier is a cluster parameter group name.

    • Specify cluster-snapshot when SourceIdentifier is a cluster snapshot identifier.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "EndTime":{ + "shape":"TStamp", + "documentation":"

    The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

    Example: 2009-07-08T18:00Z

    " + }, + "Duration":{ + "shape":"IntegerOptional", + "documentation":"

    The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.

    Default: 60

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeEvents request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeHsmClientCertificatesMessage":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of a specific HSM client certificate for which you want information. If no identifier is specified, information is returned for all HSM client certificates owned by your AWS customer account.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmClientCertificates request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching HSM client certificates that are associated with the specified key or keys. For example, suppose that you have HSM client certificates that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching HSM client certificates that are associated with the specified tag value or values. For example, suppose that you have HSM client certificates that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM client certificates that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeHsmConfigurationsMessage":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of a specific Amazon Redshift HSM configuration to be described. If no identifier is specified, information is returned for all HSM configurations owned by your AWS customer account.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeHsmConfigurations request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching HSM configurations that are associated with the specified key or keys. For example, suppose that you have HSM configurations that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching HSM configurations that are associated with the specified tag value or values. For example, suppose that you have HSM configurations that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the HSM configurations that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DescribeLoggingStatusMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster from which to get the logging status.

    Example: examplecluster

    " + } + }, + "documentation":"

    " + }, + "DescribeNodeConfigurationOptionsMessage":{ + "type":"structure", + "required":["ActionType"], + "members":{ + "ActionType":{ + "shape":"ActionType", + "documentation":"

    The action type to evaluate for possible node configurations. Currently, it must be \"restore-cluster\".

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot to evaluate for possible node configurations.

    " + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

    The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    " + }, + "Filters":{ + "shape":"NodeConfigurationOptionsFilterList", + "documentation":"

    A set of name, operator, and value items to filter the results.

    ", + "locationName":"Filter" + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeNodeConfigurationOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 500

    Constraints: minimum 100, maximum 500.

    " + } + } + }, + "DescribeOrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version filter value. Specify this parameter to show only the available offerings matching the specified version.

    Default: All versions.

    Constraints: Must be one of the version returned from DescribeClusterVersions.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type filter value. Specify this parameter to show only the available offerings matching the specified node type.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeOrderableClusterOptions request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

    The unique identifier for the offering.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeReservedNodesMessage":{ + "type":"structure", + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

    Identifier for the node reservation.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + }, + "documentation":"

    " + }, + "DescribeResizeMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of a cluster whose resize progress you are requesting. This parameter is case-sensitive.

    By default, resize operations for all clusters defined for an AWS account are returned.

    " + } + }, + "documentation":"

    " + }, + "DescribeSnapshotCopyGrantsMessage":{ + "type":"structure", + "members":{ + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    Default: 100

    Constraints: minimum 20, maximum 100.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    The result of the DescribeSnapshotCopyGrants action.

    " + }, + "DescribeSnapshotSchedulesMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier for the cluster whose snapshot schedules you want to view.

    " + }, + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for a snapshot schedule.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The key value for a snapshot schedule tag.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    The value corresponding to the key of the snapshot schedule tag.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    " + } + } + }, + "DescribeSnapshotSchedulesOutputMessage":{ + "type":"structure", + "members":{ + "SnapshotSchedules":{ + "shape":"SnapshotScheduleList", + "documentation":"

    A list of SnapshotSchedules.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    " + } + } + }, + "DescribeTableRestoreStatusMessage":{ + "type":"structure", + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The Amazon Redshift cluster that the table is being restored to.

    " + }, + "TableRestoreRequestId":{ + "shape":"String", + "documentation":"

    The identifier of the table restore request to return status for. If you don't specify a TableRestoreRequestId value, then DescribeTableRestoreStatus returns the status of all in-progress table restore requests.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    An optional pagination token provided by a previous DescribeTableRestoreStatus request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter.

    " + } + }, + "documentation":"

    " + }, + "DescribeTagsMessage":{ + "type":"structure", + "members":{ + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for which you want to describe the tag or tags. For example, arn:aws:redshift:us-east-1:123456789:cluster:t1.

    " + }, + "ResourceType":{ + "shape":"String", + "documentation":"

    The type of resource with which you want to view tags. Valid resource types are:

    • Cluster

    • CIDR/IP

    • EC2 security group

    • Snapshot

    • Cluster security group

    • Subnet group

    • HSM connection

    • HSM certificate

    • Parameter group

    • Snapshot copy grant

    For more information about Amazon Redshift resource types and constructing ARNs, go to Specifying Policy Elements: Actions, Effects, Resources, and Principals in the Amazon Redshift Cluster Management Guide.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    The maximum number or response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the marker parameter and retrying the command. If the marker field is empty, all response records have been retrieved for the request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A tag key or keys for which you want to return all matching resources that are associated with the specified key or keys. For example, suppose that you have resources tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with all resources that have either or both of these tag keys associated with them.

    " + }, + "TagValues":{ + "shape":"TagValueList", + "documentation":"

    A tag value or values for which you want to return all matching resources that are associated with the specified value or values. For example, suppose that you have resources tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with all resources that have either or both of these tag values associated with them.

    " + } + }, + "documentation":"

    " + }, + "DisableLoggingMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster on which logging is to be stopped.

    Example: examplecluster

    " + } + }, + "documentation":"

    " + }, + "DisableSnapshotCopyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the source cluster that you want to disable copying of snapshots to a destination region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    " + } + }, + "documentation":"

    " + }, + "DisableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "Double":{"type":"double"}, + "DoubleOptional":{"type":"double"}, + "EC2SecurityGroup":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    The status of the EC2 security group.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the EC2 Security Group.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    The AWS ID of the owner of the EC2 security group specified in the EC2SecurityGroupName field.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the EC2 security group.

    " + } + }, + "documentation":"

    Describes an Amazon EC2 security group.

    " + }, + "EC2SecurityGroupList":{ + "type":"list", + "member":{ + "shape":"EC2SecurityGroup", + "locationName":"EC2SecurityGroup" + } + }, + "ElasticIpStatus":{ + "type":"structure", + "members":{ + "ElasticIp":{ + "shape":"String", + "documentation":"

    The elastic IP (EIP) address for the cluster.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the elastic IP (EIP) address.

    " + } + }, + "documentation":"

    Describes the status of the elastic IP (EIP) address.

    " + }, + "EligibleTracksToUpdateList":{ + "type":"list", + "member":{ + "shape":"UpdateTarget", + "locationName":"UpdateTarget" + } + }, + "EnableLoggingMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "BucketName" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster on which logging is to be started.

    Example: examplecluster

    " + }, + "BucketName":{ + "shape":"String", + "documentation":"

    The name of an existing S3 bucket where the log files are to be stored.

    Constraints:

    • Must be in the same region as the cluster

    • The cluster must have read bucket and put object permissions

    " + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

    The prefix applied to the log file names.

    Constraints:

    • Cannot exceed 512 characters

    • Cannot contain spaces( ), double quotes (\"), single quotes ('), a backslash (\\), or control characters. The hexadecimal codes for invalid characters are:

      • x00 to x20

      • x22

      • x27

      • x5c

      • x7f or larger

    " + } + }, + "documentation":"

    " + }, + "EnableSnapshotCopyMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "DestinationRegion" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the source cluster to copy snapshots from.

    Constraints: Must be the valid name of an existing cluster that does not already have cross-region snapshot copy enabled.

    " + }, + "DestinationRegion":{ + "shape":"String", + "documentation":"

    The destination AWS Region that you want to copy snapshots to.

    Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services General Reference.

    " + }, + "RetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days to retain automated snapshots in the destination region after they are copied from the source region.

    Default: 7.

    Constraints: Must be at least 1 and no more than 35.

    " + }, + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    " + } + }, + "documentation":"

    " + }, + "EnableSnapshotCopyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"String", + "documentation":"

    The DNS address of the Cluster.

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    The port that the database engine is listening on.

    " + } + }, + "documentation":"

    Describes a connection endpoint.

    " + }, + "Event":{ + "type":"structure", + "members":{ + "SourceIdentifier":{ + "shape":"String", + "documentation":"

    The identifier for the source of the event.

    " + }, + "SourceType":{ + "shape":"SourceType", + "documentation":"

    The source type for this event.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    The text of this event.

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    A list of the event categories.

    Values: Configuration, Management, Monitoring, Security

    " + }, + "Severity":{ + "shape":"String", + "documentation":"

    The severity of the event.

    Values: ERROR, INFO

    " + }, + "Date":{ + "shape":"TStamp", + "documentation":"

    The date and time of the event.

    " + }, + "EventId":{ + "shape":"String", + "documentation":"

    The identifier of the event.

    " + } + }, + "documentation":"

    Describes an event.

    " + }, + "EventCategoriesList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"EventCategory" + } + }, + "EventCategoriesMap":{ + "type":"structure", + "members":{ + "SourceType":{ + "shape":"String", + "documentation":"

    The source type, such as cluster or cluster-snapshot, that the returned categories belong to.

    " + }, + "Events":{ + "shape":"EventInfoMapList", + "documentation":"

    The events in the event category.

    " + } + }, + "documentation":"

    Describes event categories.

    ", + "wrapper":true + }, + "EventCategoriesMapList":{ + "type":"list", + "member":{ + "shape":"EventCategoriesMap", + "locationName":"EventCategoriesMap" + } + }, + "EventCategoriesMessage":{ + "type":"structure", + "members":{ + "EventCategoriesMapList":{ + "shape":"EventCategoriesMapList", + "documentation":"

    A list of event categories descriptions.

    " + } + }, + "documentation":"

    " + }, + "EventInfoMap":{ + "type":"structure", + "members":{ + "EventId":{ + "shape":"String", + "documentation":"

    The identifier of an Amazon Redshift event.

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    The category of an Amazon Redshift event.

    " + }, + "EventDescription":{ + "shape":"String", + "documentation":"

    The description of an Amazon Redshift event.

    " + }, + "Severity":{ + "shape":"String", + "documentation":"

    The severity of the event.

    Values: ERROR, INFO

    " + } + }, + "documentation":"

    Describes event information.

    ", + "wrapper":true + }, + "EventInfoMapList":{ + "type":"list", + "member":{ + "shape":"EventInfoMap", + "locationName":"EventInfoMap" + } + }, + "EventList":{ + "type":"list", + "member":{ + "shape":"Event", + "locationName":"Event" + } + }, + "EventSubscription":{ + "type":"structure", + "members":{ + "CustomerAwsId":{ + "shape":"String", + "documentation":"

    The AWS customer account associated with the Amazon Redshift event notification subscription.

    " + }, + "CustSubscriptionId":{ + "shape":"String", + "documentation":"

    The name of the Amazon Redshift event notification subscription.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic used by the event notification subscription.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the Amazon Redshift event notification subscription.

    Constraints:

    • Can be one of the following: active | no-permission | topic-not-exist

    • The status \"no-permission\" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.

    " + }, + "SubscriptionCreationTime":{ + "shape":"TStamp", + "documentation":"

    The date and time the Amazon Redshift event notification subscription was created.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The source type of the events returned the Amazon Redshift event notification, such as cluster, or cluster-snapshot.

    " + }, + "SourceIdsList":{ + "shape":"SourceIdsList", + "documentation":"

    A list of the sources that publish events to the Amazon Redshift event notification subscription.

    " + }, + "EventCategoriesList":{ + "shape":"EventCategoriesList", + "documentation":"

    The list of Amazon Redshift event categories specified in the event notification subscription.

    Values: Configuration, Management, Monitoring, Security

    " + }, + "Severity":{ + "shape":"String", + "documentation":"

    The event severity specified in the Amazon Redshift event notification subscription.

    Values: ERROR, INFO

    " + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

    A boolean value indicating whether the subscription is enabled; true indicates that the subscription is enabled.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the event subscription.

    " + } + }, + "documentation":"

    Describes event subscriptions.

    ", + "wrapper":true + }, + "EventSubscriptionQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The request would exceed the allowed number of event subscriptions for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"EventSubscriptionQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventSubscriptionsList":{ + "type":"list", + "member":{ + "shape":"EventSubscription", + "locationName":"EventSubscription" + } + }, + "EventSubscriptionsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "EventSubscriptionsList":{ + "shape":"EventSubscriptionsList", + "documentation":"

    A list of event subscriptions.

    " + } + }, + "documentation":"

    " + }, + "EventsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "Events":{ + "shape":"EventList", + "documentation":"

    A list of Event instances.

    " + } + }, + "documentation":"

    " + }, + "GetClusterCredentialsMessage":{ + "type":"structure", + "required":[ + "DbUser", + "ClusterIdentifier" + ], + "members":{ + "DbUser":{ + "shape":"String", + "documentation":"

    The name of a database user. If a user name matching DbUser exists in the database, the temporary user credentials have the same permissions as the existing user. If DbUser doesn't exist in the database and Autocreate is True, a new user is created using the value for DbUser with PUBLIC permissions. If a database user matching the value for DbUser doesn't exist and Autocreate is False, then the command succeeds but the connection attempt will fail because the user doesn't exist in the database.

    For more information, see CREATE USER in the Amazon Redshift Database Developer Guide.

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens. The user name can't be PUBLIC.

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    " + }, + "DbName":{ + "shape":"String", + "documentation":"

    The name of a database that DbUser is authorized to log on to. If DbName is not specified, DbUser can log on to any existing database.

    Constraints:

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster that contains the database for which your are requesting credentials. This parameter is case sensitive.

    " + }, + "DurationSeconds":{ + "shape":"IntegerOptional", + "documentation":"

    The number of seconds until the returned temporary password expires.

    Constraint: minimum 900, maximum 3600.

    Default: 900

    " + }, + "AutoCreate":{ + "shape":"BooleanOptional", + "documentation":"

    Create a database user with the name specified for the user named in DbUser if one does not exist.

    " + }, + "DbGroups":{ + "shape":"DbGroupList", + "documentation":"

    A list of the names of existing database groups that the user named in DbUser will join for the current session, in addition to any group memberships for an existing user. If not specified, a new user is added only to PUBLIC.

    Database group name constraints

    • Must be 1 to 64 alphanumeric characters or hyphens

    • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

    • First character must be a letter.

    • Must not contain a colon ( : ) or slash ( / ).

    • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

    " + } + }, + "documentation":"

    The request parameters to get cluster credentials.

    " + }, + "GetReservedNodeExchangeOfferingsInputMessage":{ + "type":"structure", + "required":["ReservedNodeId"], + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

    A string representing the node identifier for the DC1 Reserved Node to be exchanged.

    " + }, + "MaxRecords":{ + "shape":"IntegerOptional", + "documentation":"

    An integer setting the maximum number of ReservedNodeOfferings to retrieve.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of ReservedNodeOfferings.

    " + } + }, + "documentation":"

    " + }, + "GetReservedNodeExchangeOfferingsOutputMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point for returning a set of response records. When the results of a GetReservedNodeExchangeOfferings request exceed the value specified in MaxRecords, Amazon Redshift returns a value in the marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the marker parameter and retrying the request.

    " + }, + "ReservedNodeOfferings":{ + "shape":"ReservedNodeOfferingList", + "documentation":"

    Returns an array of ReservedNodeOffering objects.

    " + } + } + }, + "HsmClientCertificate":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the HSM client certificate.

    " + }, + "HsmClientCertificatePublicKey":{ + "shape":"String", + "documentation":"

    The public key that the Amazon Redshift cluster will use to connect to the HSM. You must register the public key in the HSM.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the HSM client certificate.

    " + } + }, + "documentation":"

    Returns information about an HSM client certificate. The certificate is stored in a secure Hardware Storage Module (HSM), and used by the Amazon Redshift cluster to encrypt data files.

    ", + "wrapper":true + }, + "HsmClientCertificateAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is already an existing Amazon Redshift HSM client certificate with the specified identifier.

    ", + "error":{ + "code":"HsmClientCertificateAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmClientCertificateList":{ + "type":"list", + "member":{ + "shape":"HsmClientCertificate", + "locationName":"HsmClientCertificate" + } + }, + "HsmClientCertificateMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "HsmClientCertificates":{ + "shape":"HsmClientCertificateList", + "documentation":"

    A list of the identifiers for one or more HSM client certificates used by Amazon Redshift clusters to store and retrieve database encryption keys in an HSM.

    " + } + }, + "documentation":"

    " + }, + "HsmClientCertificateNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is no Amazon Redshift HSM client certificate with the specified identifier.

    ", + "error":{ + "code":"HsmClientCertificateNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmClientCertificateQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The quota for HSM client certificates has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"HsmClientCertificateQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfiguration":{ + "type":"structure", + "members":{ + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    The name of the Amazon Redshift HSM configuration.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A text description of the HSM configuration.

    " + }, + "HsmIpAddress":{ + "shape":"String", + "documentation":"

    The IP address that the Amazon Redshift cluster must use to access the HSM.

    " + }, + "HsmPartitionName":{ + "shape":"String", + "documentation":"

    The name of the partition in the HSM where the Amazon Redshift clusters will store their database encryption keys.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the HSM configuration.

    " + } + }, + "documentation":"

    Returns information about an HSM configuration, which is an object that describes to Amazon Redshift clusters the information they require to connect to an HSM where they can store database encryption keys.

    ", + "wrapper":true + }, + "HsmConfigurationAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is already an existing Amazon Redshift HSM configuration with the specified identifier.

    ", + "error":{ + "code":"HsmConfigurationAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfigurationList":{ + "type":"list", + "member":{ + "shape":"HsmConfiguration", + "locationName":"HsmConfiguration" + } + }, + "HsmConfigurationMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "HsmConfigurations":{ + "shape":"HsmConfigurationList", + "documentation":"

    A list of HsmConfiguration objects.

    " + } + }, + "documentation":"

    " + }, + "HsmConfigurationNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is no Amazon Redshift HSM configuration with the specified identifier.

    ", + "error":{ + "code":"HsmConfigurationNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmConfigurationQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The quota for HSM configurations has been reached. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"HsmConfigurationQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "HsmStatus":{ + "type":"structure", + "members":{ + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

    " + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    Reports whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command.

    Values: active, applying

    " + } + }, + "documentation":"

    Describes the status of changes to HSM settings.

    " + }, + "IPRange":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    The status of the IP range, for example, \"authorized\".

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range in Classless Inter-Domain Routing (CIDR) notation.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the IP range.

    " + } + }, + "documentation":"

    Describes an IP range used in a security group.

    " + }, + "IPRangeList":{ + "type":"list", + "member":{ + "shape":"IPRange", + "locationName":"IPRange" + } + }, + "IamRoleArnList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"IamRoleArn" + } + }, + "ImportTablesCompleted":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesInProgress":{ + "type":"list", + "member":{"shape":"String"} + }, + "ImportTablesNotStarted":{ + "type":"list", + "member":{"shape":"String"} + }, + "InProgressTableRestoreQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the allowed number of table restore requests. Wait for your current table restore requests to complete before making a new request.

    ", + "error":{ + "code":"InProgressTableRestoreQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IncompatibleOrderableOptions":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified options are incompatible.

    ", + "error":{ + "code":"IncompatibleOrderableOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientClusterCapacityFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The number of nodes specified exceeds the allotted capacity of the cluster.

    ", + "error":{ + "code":"InsufficientClusterCapacity", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InsufficientS3BucketPolicyFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster does not have read bucket or put object permissions on the S3 bucket specified when enabling logging.

    ", + "error":{ + "code":"InsufficientS3BucketPolicyFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Integer":{"type":"integer"}, + "IntegerOptional":{"type":"integer"}, + "InvalidClusterParameterGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster parameter group action can not be completed because another task is in progress that involves the parameter group. Wait a few moments and try the operation again.

    ", + "error":{ + "code":"InvalidClusterParameterGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSecurityGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The state of the cluster security group is not available.

    ", + "error":{ + "code":"InvalidClusterSecurityGroupState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSnapshotScheduleStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster snapshot schedule state is not valid.

    ", + "error":{ + "code":"InvalidClusterSnapshotScheduleState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSnapshotStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

    ", + "error":{ + "code":"InvalidClusterSnapshotState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified cluster is not in the available state.

    ", + "error":{ + "code":"InvalidClusterState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSubnetGroupStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster subnet group cannot be deleted because it is in use.

    ", + "error":{ + "code":"InvalidClusterSubnetGroupStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterSubnetStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The state of the subnet is invalid.

    ", + "error":{ + "code":"InvalidClusterSubnetStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidClusterTrackFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The provided cluster track name is not valid.

    ", + "error":{ + "code":"InvalidClusterTrack", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidElasticIpFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The Elastic IP (EIP) is invalid or cannot be found.

    ", + "error":{ + "code":"InvalidElasticIpFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidHsmClientCertificateStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified HSM client certificate is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

    ", + "error":{ + "code":"InvalidHsmClientCertificateStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidHsmConfigurationStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified HSM configuration is not in the available state, or it is still in use by one or more Amazon Redshift clusters.

    ", + "error":{ + "code":"InvalidHsmConfigurationStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidReservedNodeStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the Reserved Node being exchanged is not in an active state.

    ", + "error":{ + "code":"InvalidReservedNodeState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRestoreFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The restore is invalid.

    ", + "error":{ + "code":"InvalidRestore", + "httpStatusCode":406, + "senderFault":true + }, + "exception":true + }, + "InvalidRetentionPeriodFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The retention period specified is either in the past or is not a valid value.

    The value must be either -1 or an integer between 1 and 3,653.

    ", + "error":{ + "code":"InvalidRetentionPeriodFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidS3BucketNameFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The S3 bucket name is invalid. For more information about naming rules, go to Bucket Restrictions and Limitations in the Amazon Simple Storage Service (S3) Developer Guide.

    ", + "error":{ + "code":"InvalidS3BucketNameFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidS3KeyPrefixFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The string specified for the logging S3 key prefix does not comply with the documented constraints.

    ", + "error":{ + "code":"InvalidS3KeyPrefixFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidScheduleFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The schedule you submitted isn't valid.

    ", + "error":{ + "code":"InvalidSchedule", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSnapshotCopyGrantStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The snapshot copy grant can't be deleted because it is used by one or more clusters.

    ", + "error":{ + "code":"InvalidSnapshotCopyGrantStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubnet":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested subnet is not valid, or not all of the subnets are in the same VPC.

    ", + "error":{ + "code":"InvalidSubnet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSubscriptionStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The subscription request is invalid because it is a duplicate request. This subscription request is already in progress.

    ", + "error":{ + "code":"InvalidSubscriptionStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTableRestoreArgumentFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The value specified for the sourceDatabaseName, sourceSchemaName, or sourceTableName parameter, or a combination of these, doesn't exist in the snapshot.

    ", + "error":{ + "code":"InvalidTableRestoreArgument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTagFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The tag is invalid.

    ", + "error":{ + "code":"InvalidTagFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidVPCNetworkStateFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster subnet group does not cover all Availability Zones.

    ", + "error":{ + "code":"InvalidVPCNetworkStateFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The encryption key has exceeded its grant limit in AWS KMS.

    ", + "error":{ + "code":"LimitExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "LoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{ + "shape":"Boolean", + "documentation":"

    true if logging is on, false if logging is off.

    " + }, + "BucketName":{ + "shape":"String", + "documentation":"

    The name of the S3 bucket where the log files are stored.

    " + }, + "S3KeyPrefix":{ + "shape":"String", + "documentation":"

    The prefix applied to the log file names.

    " + }, + "LastSuccessfulDeliveryTime":{ + "shape":"TStamp", + "documentation":"

    The last time that logs were delivered.

    " + }, + "LastFailureTime":{ + "shape":"TStamp", + "documentation":"

    The last time when logs failed to be delivered.

    " + }, + "LastFailureMessage":{ + "shape":"String", + "documentation":"

    The message indicating that logs failed to be delivered.

    " + } + }, + "documentation":"

    Describes the status of logging for a cluster.

    " + }, + "Long":{"type":"long"}, + "LongOptional":{"type":"long"}, + "MaintenanceTrack":{ + "type":"structure", + "members":{ + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track. Possible values are current and trailing.

    " + }, + "DatabaseVersion":{ + "shape":"String", + "documentation":"

    The version number for the cluster release.

    " + }, + "UpdateTargets":{ + "shape":"EligibleTracksToUpdateList", + "documentation":"

    An array of UpdateTarget objects to update with the maintenance track.

    " + } + }, + "documentation":"

    Defines a maintenance track that determines which Amazon Redshift version to apply during a maintenance window. If the value for MaintenanceTrack is current, the cluster is updated to the most recently certified maintenance release. If the value is trailing, the cluster is updated to the previously certified maintenance release.

    " + }, + "ModifyClusterDbRevisionMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "RevisionTarget" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of a cluster whose database revision you want to modify.

    Example: examplecluster

    " + }, + "RevisionTarget":{ + "shape":"String", + "documentation":"

    The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request.

    " + } + } + }, + "ModifyClusterDbRevisionResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterIamRolesMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster for which you want to associate or disassociate IAM roles.

    " + }, + "AddIamRoles":{ + "shape":"IamRoleArnList", + "documentation":"

    Zero or more IAM roles to associate with the cluster. The roles must be in their Amazon Resource Name (ARN) format. You can associate up to 10 IAM roles with a single cluster in a single request.

    " + }, + "RemoveIamRoles":{ + "shape":"IamRoleArnList", + "documentation":"

    Zero or more IAM roles in ARN format to disassociate from the cluster. You can disassociate up to 10 IAM roles from a single cluster in a single request.

    " + } + }, + "documentation":"

    " + }, + "ModifyClusterIamRolesResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterMaintenanceMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the cluster.

    " + }, + "DeferMaintenance":{ + "shape":"BooleanOptional", + "documentation":"

    A boolean indicating whether to enable the deferred maintenance window.

    " + }, + "DeferMaintenanceIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the deferred maintenance window.

    " + }, + "DeferMaintenanceStartTime":{ + "shape":"TStamp", + "documentation":"

    A timestamp indicating the start time for the deferred maintenance window.

    " + }, + "DeferMaintenanceEndTime":{ + "shape":"TStamp", + "documentation":"

    A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration.

    " + }, + "DeferMaintenanceDuration":{ + "shape":"IntegerOptional", + "documentation":"

    An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less.

    " + } + } + }, + "ModifyClusterMaintenanceResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster to be modified.

    Example: examplecluster

    " + }, + "ClusterType":{ + "shape":"String", + "documentation":"

    The new cluster type.

    When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

    Valid Values: multi-node | single-node

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

    When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

    Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge

    " + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

    The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

    When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

    Valid Values: Integer greater than 0.

    " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

    A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

    Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens

    • First character must be a letter

    • Cannot end with a hyphen or contain two consecutive hyphens

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of virtual private cloud (VPC) security groups to be associated with the cluster. This change is asynchronously applied as soon as possible.

    " + }, + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

    Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

    Default: Uses existing setting.

    Constraints:

    • Must be between 8 and 64 characters in length.

    • Must contain at least one uppercase letter.

    • Must contain at least one lowercase letter.

    • Must contain one number.

    • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), \" (double quote), \\, /, @, or space.

    " + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

    Default: Uses existing setting.

    Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

    " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

    Default: Uses existing setting.

    Constraints: Must be a value from 0 to 35.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The default for number of days that a newly created manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely. This value doesn't retroactively change the retention periods of existing manual snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    The default value is -1.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

    This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

    Default: Uses existing setting.

    Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Must be at least 30 minutes.

    " + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The new version number of the Amazon Redshift engine to upgrade to.

    For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    Example: 1.0

    " + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

    Default: false

    " + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

    " + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " + }, + "NewClusterIdentifier":{ + "shape":"String", + "documentation":"

    The new identifier for the cluster.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    Example: examplecluster

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

    " + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

    The Elastic IP (EIP) address for the cluster.

    Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

    " + }, + "EnhancedVpcRouting":{ + "shape":"BooleanOptional", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied.

    " + }, + "Encrypted":{ + "shape":"BooleanOptional", + "documentation":"

    Indicates whether the cluster is encrypted. If the cluster is encrypted and you provide a value for the KmsKeyId parameter, we will encrypt the cluster with the provided KmsKeyId. If you don't provide a KmsKeyId, we will encrypt with the default key. In the China region we will use legacy encryption if you specify that the cluster is encrypted.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

    " + } + }, + "documentation":"

    " + }, + "ModifyClusterParameterGroupMessage":{ + "type":"structure", + "required":[ + "ParameterGroupName", + "Parameters" + ], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the parameter group to be modified.

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.

    For each parameter to be modified, you must supply at least the parameter name and parameter value; other name-value pairs of the parameter are optional.

    For the workload management (WLM) configuration, you must supply all the name-value pairs in the wlm_json_configuration parameter.

    " + } + }, + "documentation":"

    " + }, + "ModifyClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifyClusterSnapshotMessage":{ + "type":"structure", + "required":["SnapshotIdentifier"], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot whose setting you want to modify.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    If the manual snapshot falls outside of the new retention period, you can specify the force option to immediately delete the snapshot.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "Force":{ + "shape":"Boolean", + "documentation":"

    A Boolean option to override an exception if the retention period has already passed.

    " + } + } + }, + "ModifyClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "ModifyClusterSnapshotScheduleMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the cluster whose snapshot schedule you want to modify.

    " + }, + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique alphanumeric identifier for the schedule that you want to associate with the cluster.

    " + }, + "DisassociateSchedule":{ + "shape":"BooleanOptional", + "documentation":"

    A boolean to indicate whether to remove the assoiciation between the cluster and the schedule.

    " + } + } + }, + "ModifyClusterSubnetGroupMessage":{ + "type":"structure", + "required":[ + "ClusterSubnetGroupName", + "SubnetIds" + ], + "members":{ + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the subnet group to be modified.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A text description of the subnet group to be modified.

    " + }, + "SubnetIds":{ + "shape":"SubnetIdentifierList", + "documentation":"

    An array of VPC subnet IDs. A maximum of 20 subnets can be modified in a single request.

    " + } + }, + "documentation":"

    " + }, + "ModifyClusterSubnetGroupResult":{ + "type":"structure", + "members":{ + "ClusterSubnetGroup":{"shape":"ClusterSubnetGroup"} + } + }, + "ModifyEventSubscriptionMessage":{ + "type":"structure", + "required":["SubscriptionName"], + "members":{ + "SubscriptionName":{ + "shape":"String", + "documentation":"

    The name of the modified Amazon Redshift event notification subscription.

    " + }, + "SnsTopicArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the SNS topic to be used by the event notification subscription.

    " + }, + "SourceType":{ + "shape":"String", + "documentation":"

    The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

    Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

    " + }, + "SourceIds":{ + "shape":"SourceIdsList", + "documentation":"

    A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

    Example: my-cluster-1, my-cluster-2

    Example: my-snapshot-20131010

    " + }, + "EventCategories":{ + "shape":"EventCategoriesList", + "documentation":"

    Specifies the Amazon Redshift event categories to be published by the event notification subscription.

    Values: configuration, management, monitoring, security

    " + }, + "Severity":{ + "shape":"String", + "documentation":"

    Specifies the Amazon Redshift event severity to be published by the event notification subscription.

    Values: ERROR, INFO

    " + }, + "Enabled":{ + "shape":"BooleanOptional", + "documentation":"

    A Boolean value indicating if the subscription is enabled. true indicates the subscription is enabled

    " + } + }, + "documentation":"

    " + }, + "ModifyEventSubscriptionResult":{ + "type":"structure", + "members":{ + "EventSubscription":{"shape":"EventSubscription"} + } + }, + "ModifySnapshotCopyRetentionPeriodMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "RetentionPeriod" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster for which you want to change the retention period for either automated or manual snapshots that are copied to a destination AWS Region.

    Constraints: Must be the valid name of an existing cluster that has cross-region snapshot copy enabled.

    " + }, + "RetentionPeriod":{ + "shape":"Integer", + "documentation":"

    The number of days to retain automated snapshots in the destination AWS Region after they are copied from the source AWS Region.

    By default, this only changes the retention period of copied automated snapshots.

    If you decrease the retention period for automated snapshots that are copied to a destination AWS Region, Amazon Redshift deletes any existing automated snapshots that were copied to the destination AWS Region and that fall outside of the new retention period.

    Constraints: Must be at least 1 and no more than 35 for automated snapshots.

    If you specify the manual option, only newly copied manual snapshots will have the new retention period.

    If you specify the value of -1 newly copied manual snapshots are retained indefinitely.

    Constraints: The number of days must be either -1 or an integer between 1 and 3,653 for manual snapshots.

    " + }, + "Manual":{ + "shape":"Boolean", + "documentation":"

    Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots.

    " + } + }, + "documentation":"

    " + }, + "ModifySnapshotCopyRetentionPeriodResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ModifySnapshotScheduleMessage":{ + "type":"structure", + "required":[ + "ScheduleIdentifier", + "ScheduleDefinitions" + ], + "members":{ + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique alphanumeric identifier of the schedule to modify.

    " + }, + "ScheduleDefinitions":{ + "shape":"ScheduleDefinitionList", + "documentation":"

    An updated list of schedule definitions. A schedule definition is made up of schedule expressions, for example, \"cron(30 12 *)\" or \"rate(12 hours)\".

    " + } + } + }, + "NodeConfigurationOption":{ + "type":"structure", + "members":{ + "NodeType":{ + "shape":"String", + "documentation":"

    The node type, such as, \"ds2.8xlarge\".

    " + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

    The number of nodes.

    " + }, + "EstimatedDiskUtilizationPercent":{ + "shape":"DoubleOptional", + "documentation":"

    The estimated disk utilizaton percentage.

    " + } + }, + "documentation":"

    A list of node configurations.

    " + }, + "NodeConfigurationOptionList":{ + "type":"list", + "member":{ + "shape":"NodeConfigurationOption", + "locationName":"NodeConfigurationOption" + } + }, + "NodeConfigurationOptionsFilter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NodeConfigurationOptionsFilterName", + "documentation":"

    The name of the element to filter.

    " + }, + "Operator":{ + "shape":"OperatorType", + "documentation":"

    The filter operator. If filter Name is NodeType only the 'in' operator is supported. Provide one value to evaluate for 'eq', 'lt', 'le', 'gt', and 'ge'. Provide two values to evaluate for 'between'. Provide a list of values for 'in'.

    " + }, + "Values":{ + "shape":"ValueStringList", + "documentation":"

    List of values. Compare Name using Operator to Values. If filter Name is NumberOfNodes, then values can range from 0 to 200. If filter Name is EstimatedDiskUtilizationPercent, then values can range from 0 to 100. For example, filter NumberOfNodes (name) GT (operator) 3 (values).

    ", + "locationName":"Value" + } + }, + "documentation":"

    A set of elements to filter the returned node configurations.

    " + }, + "NodeConfigurationOptionsFilterList":{ + "type":"list", + "member":{ + "shape":"NodeConfigurationOptionsFilter", + "locationName":"NodeConfigurationOptionsFilter" + } + }, + "NodeConfigurationOptionsFilterName":{ + "type":"string", + "enum":[ + "NodeType", + "NumberOfNodes", + "EstimatedDiskUtilizationPercent" + ] + }, + "NodeConfigurationOptionsMessage":{ + "type":"structure", + "members":{ + "NodeConfigurationOptionList":{ + "shape":"NodeConfigurationOptionList", + "documentation":"

    A list of valid node configurations.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + } + } + }, + "NumberOfNodesPerClusterLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation would exceed the number of nodes allowed for a cluster.

    ", + "error":{ + "code":"NumberOfNodesPerClusterLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NumberOfNodesQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"NumberOfNodesQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "OperatorType":{ + "type":"string", + "enum":[ + "eq", + "lt", + "gt", + "le", + "ge", + "in", + "between" + ] + }, + "OrderableClusterOption":{ + "type":"structure", + "members":{ + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version of the orderable cluster.

    " + }, + "ClusterType":{ + "shape":"String", + "documentation":"

    The cluster type, for example multi-node.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type for the orderable cluster.

    " + }, + "AvailabilityZones":{ + "shape":"AvailabilityZoneList", + "documentation":"

    A list of availability zones for the orderable cluster.

    " + } + }, + "documentation":"

    Describes an orderable cluster option.

    ", + "wrapper":true + }, + "OrderableClusterOptionsList":{ + "type":"list", + "member":{ + "shape":"OrderableClusterOption", + "locationName":"OrderableClusterOption" + } + }, + "OrderableClusterOptionsMessage":{ + "type":"structure", + "members":{ + "OrderableClusterOptions":{ + "shape":"OrderableClusterOptionsList", + "documentation":"

    An OrderableClusterOption structure containing information about orderable options for the cluster.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + } + }, + "documentation":"

    Contains the output from the DescribeOrderableClusterOptions action.

    " + }, + "Parameter":{ + "type":"structure", + "members":{ + "ParameterName":{ + "shape":"String", + "documentation":"

    The name of the parameter.

    " + }, + "ParameterValue":{ + "shape":"String", + "documentation":"

    The value of the parameter.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A description of the parameter.

    " + }, + "Source":{ + "shape":"String", + "documentation":"

    The source of the parameter value, such as \"engine-default\" or \"user\".

    " + }, + "DataType":{ + "shape":"String", + "documentation":"

    The data type of the parameter.

    " + }, + "AllowedValues":{ + "shape":"String", + "documentation":"

    The valid range of values for the parameter.

    " + }, + "ApplyType":{ + "shape":"ParameterApplyType", + "documentation":"

    Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

    " + }, + "IsModifiable":{ + "shape":"Boolean", + "documentation":"

    If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    " + }, + "MinimumEngineVersion":{ + "shape":"String", + "documentation":"

    The earliest engine version to which the parameter can apply.

    " + } + }, + "documentation":"

    Describes a parameter in a cluster parameter group.

    " + }, + "ParameterApplyType":{ + "type":"string", + "enum":[ + "static", + "dynamic" + ] + }, + "ParameterGroupList":{ + "type":"list", + "member":{ + "shape":"ClusterParameterGroup", + "locationName":"ClusterParameterGroup" + } + }, + "ParametersList":{ + "type":"list", + "member":{ + "shape":"Parameter", + "locationName":"Parameter" + } + }, + "PendingActionsList":{ + "type":"list", + "member":{"shape":"String"} + }, + "PendingModifiedValues":{ + "type":"structure", + "members":{ + "MasterUserPassword":{ + "shape":"String", + "documentation":"

    The pending or in-progress change of the master user password for the cluster.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The pending or in-progress change of the cluster's node type.

    " + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

    The pending or in-progress change of the number of nodes in the cluster.

    " + }, + "ClusterType":{ + "shape":"String", + "documentation":"

    The pending or in-progress change of the cluster type.

    " + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The pending or in-progress change of the service version.

    " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The pending or in-progress change of the automated snapshot retention period.

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The pending or in-progress change of the new identifier for the cluster.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    The pending or in-progress change of the ability to connect to the cluster from the public network.

    " + }, + "EnhancedVpcRouting":{ + "shape":"BooleanOptional", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track that the cluster will change to during the next maintenance window.

    " + }, + "EncryptionType":{ + "shape":"String", + "documentation":"

    The encryption type for a cluster. Possible values are: KMS and None. For the China region the possible values are None, and Legacy.

    " + } + }, + "documentation":"

    Describes cluster attributes that are in a pending state. A change to one or more the attributes was requested and is in progress or will be applied.

    " + }, + "PurchaseReservedNodeOfferingMessage":{ + "type":"structure", + "required":["ReservedNodeOfferingId"], + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

    The unique identifier of the reserved node offering you want to purchase.

    " + }, + "NodeCount":{ + "shape":"IntegerOptional", + "documentation":"

    The number of reserved nodes that you want to purchase.

    Default: 1

    " + } + }, + "documentation":"

    " + }, + "PurchaseReservedNodeOfferingResult":{ + "type":"structure", + "members":{ + "ReservedNode":{"shape":"ReservedNode"} + } + }, + "RebootClusterMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The cluster identifier.

    " + } + }, + "documentation":"

    " + }, + "RebootClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RecurringCharge":{ + "type":"structure", + "members":{ + "RecurringChargeAmount":{ + "shape":"Double", + "documentation":"

    The amount charged per the period of time specified by the recurring charge frequency.

    " + }, + "RecurringChargeFrequency":{ + "shape":"String", + "documentation":"

    The frequency at which the recurring charge amount is applied.

    " + } + }, + "documentation":"

    Describes a recurring charge.

    ", + "wrapper":true + }, + "RecurringChargeList":{ + "type":"list", + "member":{ + "shape":"RecurringCharge", + "locationName":"RecurringCharge" + } + }, + "ReservedNode":{ + "type":"structure", + "members":{ + "ReservedNodeId":{ + "shape":"String", + "documentation":"

    The unique identifier for the reservation.

    " + }, + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

    The identifier for the reserved node offering.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type of the reserved node.

    " + }, + "StartTime":{ + "shape":"TStamp", + "documentation":"

    The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration of the node reservation in seconds.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The fixed cost Amazon Redshift charges you for this reserved node.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The hourly rate Amazon Redshift charges you for this reserved node.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the reserved cluster.

    " + }, + "NodeCount":{ + "shape":"Integer", + "documentation":"

    The number of reserved compute nodes.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The state of the reserved compute node.

    Possible Values:

    • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

    • active-This reserved node is owned by the caller and is available for use.

    • payment-failed-Payment failed for the purchase attempt.

    • retired-The reserved node is no longer available.

    • exchanging-The owner is exchanging the reserved node for another reserved node.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The anticipated utilization of the reserved node, as defined in the reserved node offering.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The recurring charges for the reserved node.

    " + }, + "ReservedNodeOfferingType":{ + "shape":"ReservedNodeOfferingType", + "documentation":"

    " + } + }, + "documentation":"

    Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

    ", + "wrapper":true + }, + "ReservedNodeAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    User already has a reservation with the given identifier.

    ", + "error":{ + "code":"ReservedNodeAlreadyExists", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeAlreadyMigratedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the reserved node has already been exchanged.

    ", + "error":{ + "code":"ReservedNodeAlreadyMigrated", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeList":{ + "type":"list", + "member":{ + "shape":"ReservedNode", + "locationName":"ReservedNode" + } + }, + "ReservedNodeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified reserved compute node not found.

    ", + "error":{ + "code":"ReservedNodeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeOffering":{ + "type":"structure", + "members":{ + "ReservedNodeOfferingId":{ + "shape":"String", + "documentation":"

    The offering identifier.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type offered by the reserved node offering.

    " + }, + "Duration":{ + "shape":"Integer", + "documentation":"

    The duration, in seconds, for which the offering will reserve the node.

    " + }, + "FixedPrice":{ + "shape":"Double", + "documentation":"

    The upfront fixed charge you will pay to purchase the specific reserved node offering.

    " + }, + "UsagePrice":{ + "shape":"Double", + "documentation":"

    The rate you are charged for each hour the cluster that is using the offering is running.

    " + }, + "CurrencyCode":{ + "shape":"String", + "documentation":"

    The currency code for the compute nodes offering.

    " + }, + "OfferingType":{ + "shape":"String", + "documentation":"

    The anticipated utilization of the reserved node, as defined in the reserved node offering.

    " + }, + "RecurringCharges":{ + "shape":"RecurringChargeList", + "documentation":"

    The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

    " + }, + "ReservedNodeOfferingType":{ + "shape":"ReservedNodeOfferingType", + "documentation":"

    " + } + }, + "documentation":"

    Describes a reserved node offering.

    ", + "wrapper":true + }, + "ReservedNodeOfferingList":{ + "type":"list", + "member":{ + "shape":"ReservedNodeOffering", + "locationName":"ReservedNodeOffering" + } + }, + "ReservedNodeOfferingNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Specified offering does not exist.

    ", + "error":{ + "code":"ReservedNodeOfferingNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ReservedNodeOfferingType":{ + "type":"string", + "enum":[ + "Regular", + "Upgradable" + ] + }, + "ReservedNodeOfferingsMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ReservedNodeOfferings":{ + "shape":"ReservedNodeOfferingList", + "documentation":"

    A list of ReservedNodeOffering objects.

    " + } + }, + "documentation":"

    " + }, + "ReservedNodeQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Request would exceed the user's compute node quota. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

    ", + "error":{ + "code":"ReservedNodeQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ReservedNodesMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "ReservedNodes":{ + "shape":"ReservedNodeList", + "documentation":"

    The list of ReservedNode objects.

    " + } + }, + "documentation":"

    " + }, + "ResetClusterParameterGroupMessage":{ + "type":"structure", + "required":["ParameterGroupName"], + "members":{ + "ParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the cluster parameter group to be reset.

    " + }, + "ResetAllParameters":{ + "shape":"Boolean", + "documentation":"

    If true, all parameters in the specified parameter group will be reset to their default values.

    Default: true

    " + }, + "Parameters":{ + "shape":"ParametersList", + "documentation":"

    An array of names of parameters to be reset. If ResetAllParameters option is not used, then at least one parameter name must be supplied.

    Constraints: A maximum of 20 parameters can be reset in a single request.

    " + } + }, + "documentation":"

    " + }, + "ResizeClusterMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "NumberOfNodes" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier for the cluster to resize.

    " + }, + "ClusterType":{ + "shape":"String", + "documentation":"

    The new cluster type for the specified cluster.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.

    " + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

    The new number of nodes for the cluster.

    " + }, + "Classic":{ + "shape":"BooleanOptional", + "documentation":"

    A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false, the resize type is elastic.

    " + } + } + }, + "ResizeClusterResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "ResizeInfo":{ + "type":"structure", + "members":{ + "ResizeType":{ + "shape":"String", + "documentation":"

    Returns the value ClassicResize.

    " + }, + "AllowCancelResize":{ + "shape":"Boolean", + "documentation":"

    A boolean value indicating if the resize operation can be cancelled.

    " + } + }, + "documentation":"

    Describes a resize operation.

    " + }, + "ResizeNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A resize operation for the specified cluster is not found.

    ", + "error":{ + "code":"ResizeNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResizeProgressMessage":{ + "type":"structure", + "members":{ + "TargetNodeType":{ + "shape":"String", + "documentation":"

    The node type that the cluster will have after the resize operation is complete.

    " + }, + "TargetNumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

    The number of nodes that the cluster will have after the resize operation is complete.

    " + }, + "TargetClusterType":{ + "shape":"String", + "documentation":"

    The cluster type after the resize operation is complete.

    Valid Values: multi-node | single-node

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the resize operation.

    Valid Values: NONE | IN_PROGRESS | FAILED | SUCCEEDED | CANCELLING

    " + }, + "ImportTablesCompleted":{ + "shape":"ImportTablesCompleted", + "documentation":"

    The names of tables that have been completely imported .

    Valid Values: List of table names.

    " + }, + "ImportTablesInProgress":{ + "shape":"ImportTablesInProgress", + "documentation":"

    The names of tables that are being currently imported.

    Valid Values: List of table names.

    " + }, + "ImportTablesNotStarted":{ + "shape":"ImportTablesNotStarted", + "documentation":"

    The names of tables that have not been yet imported.

    Valid Values: List of table names

    " + }, + "AvgResizeRateInMegaBytesPerSecond":{ + "shape":"DoubleOptional", + "documentation":"

    The average rate of the resize operation over the last few minutes, measured in megabytes per second. After the resize operation completes, this value shows the average rate of the entire resize operation.

    " + }, + "TotalResizeDataInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

    The estimated total amount of data, in megabytes, on the cluster before the resize operation began.

    " + }, + "ProgressInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

    While the resize operation is in progress, this value shows the current amount of data, in megabytes, that has been processed so far. When the resize operation is complete, this value shows the total amount of data, in megabytes, on the cluster, which may be more or less than TotalResizeDataInMegaBytes (the estimated total amount of data before resize).

    " + }, + "ElapsedTimeInSeconds":{ + "shape":"LongOptional", + "documentation":"

    The amount of seconds that have elapsed since the resize operation began. After the resize operation completes, this value shows the total actual time, in seconds, for the resize operation.

    " + }, + "EstimatedTimeToCompletionInSeconds":{ + "shape":"LongOptional", + "documentation":"

    The estimated time remaining, in seconds, until the resize operation is complete. This value is calculated based on the average resize rate and the estimated amount of data remaining to be processed. Once the resize operation is complete, this value will be 0.

    " + }, + "ResizeType":{ + "shape":"String", + "documentation":"

    An enum with possible values of ClassicResize and ElasticResize. These values describe the type of resize operation being performed.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    An optional string to provide additional details about the resize action.

    " + }, + "TargetEncryptionType":{ + "shape":"String", + "documentation":"

    The type of encryption for the cluster after the resize is complete.

    Possible values are KMS and None. In the China region possible values are: Legacy and None.

    " + }, + "DataTransferProgressPercent":{ + "shape":"DoubleOptional", + "documentation":"

    The percent of data transferred from source cluster to target cluster.

    " + } + }, + "documentation":"

    Describes the result of a cluster resize operation.

    " + }, + "ResourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The resource could not be found.

    ", + "error":{ + "code":"ResourceNotFoundFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "RestorableNodeTypeList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"NodeType" + } + }, + "RestoreFromClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "SnapshotIdentifier" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster that will be created from restoring the snapshot.

    Constraints:

    • Must contain from 1 to 63 alphanumeric characters or hyphens.

    • Alphabetic characters must be lowercase.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters within an AWS account.

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

    Example: my-snapshot-id

    " + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    " + }, + "Port":{ + "shape":"IntegerOptional", + "documentation":"

    The port number on which the cluster accepts connections.

    Default: The same port as the original cluster.

    Constraints: Must be between 1115 and 65535.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Amazon EC2 Availability Zone in which to restore the cluster.

    Default: A random, system-chosen Availability Zone.

    Example: us-east-1a

    " + }, + "AllowVersionUpgrade":{ + "shape":"BooleanOptional", + "documentation":"

    If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

    Default: true

    " + }, + "ClusterSubnetGroupName":{ + "shape":"String", + "documentation":"

    The name of the subnet group where you want to cluster restored.

    A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

    " + }, + "PubliclyAccessible":{ + "shape":"BooleanOptional", + "documentation":"

    If true, the cluster can be accessed from a public network.

    " + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

    The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.

    " + }, + "HsmClientCertificateIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

    " + }, + "HsmConfigurationIdentifier":{ + "shape":"String", + "documentation":"

    Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.

    " + }, + "ElasticIp":{ + "shape":"String", + "documentation":"

    The elastic IP (EIP) address for the cluster.

    " + }, + "ClusterParameterGroupName":{ + "shape":"String", + "documentation":"

    The name of the parameter group to be associated with this cluster.

    Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

    Constraints:

    • Must be 1 to 255 alphanumeric characters or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    " + }, + "ClusterSecurityGroups":{ + "shape":"ClusterSecurityGroupNameList", + "documentation":"

    A list of security groups to be associated with this cluster.

    Default: The default cluster security group for Amazon Redshift.

    Cluster security groups only apply to clusters outside of VPCs.

    " + }, + "VpcSecurityGroupIds":{ + "shape":"VpcSecurityGroupIdList", + "documentation":"

    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Default: The default VPC security group is associated with the cluster.

    VPC security groups only apply to clusters in VPCs.

    " + }, + "PreferredMaintenanceWindow":{ + "shape":"String", + "documentation":"

    The weekly time range (in UTC) during which automated cluster maintenance can occur.

    Format: ddd:hh24:mi-ddd:hh24:mi

    Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

    Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

    Constraints: Minimum 30-minute window.

    " + }, + "AutomatedSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.

    Default: The value selected for the cluster from which the snapshot was taken.

    Constraints: Must be a value from 0 to 35.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot.

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type that the restored cluster will be provisioned with.

    Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds1.xlarge into ds2.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore dc1.8xlarge to dc2.8xlarge. First restore to a dc1.8xlareg cluster, then resize to a dc2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

    " + }, + "EnhancedVpcRouting":{ + "shape":"BooleanOptional", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "AdditionalInfo":{ + "shape":"String", + "documentation":"

    Reserved.

    " + }, + "IamRoles":{ + "shape":"IamRoleArnList", + "documentation":"

    A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request.

    A cluster can have up to 10 IAM roles associated at any time.

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.

    " + }, + "SnapshotScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the snapshot schedule.

    " + }, + "NumberOfNodes":{ + "shape":"IntegerOptional", + "documentation":"

    The number of nodes specified when provisioning the restored cluster.

    " + } + }, + "documentation":"

    " + }, + "RestoreFromClusterSnapshotResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "RestoreStatus":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    The status of the restore action. Returns starting, restoring, completed, or failed.

    " + }, + "CurrentRestoreRateInMegaBytesPerSecond":{ + "shape":"Double", + "documentation":"

    The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup.

    " + }, + "SnapshotSizeInMegaBytes":{ + "shape":"Long", + "documentation":"

    The size of the set of snapshot data used to restore the cluster.

    " + }, + "ProgressInMegaBytes":{ + "shape":"Long", + "documentation":"

    The number of megabytes that have been transferred from snapshot storage.

    " + }, + "ElapsedTimeInSeconds":{ + "shape":"Long", + "documentation":"

    The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

    " + }, + "EstimatedTimeToCompletionInSeconds":{ + "shape":"Long", + "documentation":"

    The estimate of the time remaining before the restore will complete. Returns 0 for a completed restore.

    " + } + }, + "documentation":"

    Describes the status of a cluster restore action. Returns null if the cluster was not created by restoring a snapshot.

    " + }, + "RestoreTableFromClusterSnapshotMessage":{ + "type":"structure", + "required":[ + "ClusterIdentifier", + "SnapshotIdentifier", + "SourceDatabaseName", + "SourceTableName", + "NewTableName" + ], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the Amazon Redshift cluster to restore the table to.

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot to restore the table from. This snapshot must have been created from the Amazon Redshift cluster specified by the ClusterIdentifier parameter.

    " + }, + "SourceDatabaseName":{ + "shape":"String", + "documentation":"

    The name of the source database that contains the table to restore from.

    " + }, + "SourceSchemaName":{ + "shape":"String", + "documentation":"

    The name of the source schema that contains the table to restore from. If you do not specify a SourceSchemaName value, the default is public.

    " + }, + "SourceTableName":{ + "shape":"String", + "documentation":"

    The name of the source table to restore from.

    " + }, + "TargetDatabaseName":{ + "shape":"String", + "documentation":"

    The name of the database to restore the table to.

    " + }, + "TargetSchemaName":{ + "shape":"String", + "documentation":"

    The name of the schema to restore the table to.

    " + }, + "NewTableName":{ + "shape":"String", + "documentation":"

    The name of the table to create as a result of the current request.

    " + } + }, + "documentation":"

    " + }, + "RestoreTableFromClusterSnapshotResult":{ + "type":"structure", + "members":{ + "TableRestoreStatus":{"shape":"TableRestoreStatus"} + } + }, + "RevisionTarget":{ + "type":"structure", + "members":{ + "DatabaseRevision":{ + "shape":"String", + "documentation":"

    A unique string that identifies the version to update the cluster to. You can use this value in ModifyClusterDbRevision.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    A string that describes the changes and features that will be applied to the cluster when it is updated to the corresponding ClusterDbRevision.

    " + }, + "DatabaseRevisionReleaseDate":{ + "shape":"TStamp", + "documentation":"

    The date on which the database revision was released.

    " + } + }, + "documentation":"

    Describes a RevisionTarget.

    " + }, + "RevisionTargetsList":{ + "type":"list", + "member":{ + "shape":"RevisionTarget", + "locationName":"RevisionTarget" + } + }, + "RevokeClusterSecurityGroupIngressMessage":{ + "type":"structure", + "required":["ClusterSecurityGroupName"], + "members":{ + "ClusterSecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the security Group from which to revoke the ingress rule.

    " + }, + "CIDRIP":{ + "shape":"String", + "documentation":"

    The IP range for which to revoke access. This range must be a valid Classless Inter-Domain Routing (CIDR) block of IP addresses. If CIDRIP is specified, EC2SecurityGroupName and EC2SecurityGroupOwnerId cannot be provided.

    " + }, + "EC2SecurityGroupName":{ + "shape":"String", + "documentation":"

    The name of the EC2 Security Group whose access is to be revoked. If EC2SecurityGroupName is specified, EC2SecurityGroupOwnerId must also be provided and CIDRIP cannot be provided.

    " + }, + "EC2SecurityGroupOwnerId":{ + "shape":"String", + "documentation":"

    The AWS account number of the owner of the security group specified in the EC2SecurityGroupName parameter. The AWS access key ID is not an acceptable value. If EC2SecurityGroupOwnerId is specified, EC2SecurityGroupName must also be provided. and CIDRIP cannot be provided.

    Example: 111122223333

    " + } + }, + "documentation":"

    " + }, + "RevokeClusterSecurityGroupIngressResult":{ + "type":"structure", + "members":{ + "ClusterSecurityGroup":{"shape":"ClusterSecurityGroup"} + } + }, + "RevokeSnapshotAccessMessage":{ + "type":"structure", + "required":[ + "SnapshotIdentifier", + "AccountWithRestoreAccess" + ], + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot that the account can no longer access.

    " + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster the snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.

    " + }, + "AccountWithRestoreAccess":{ + "shape":"String", + "documentation":"

    The identifier of the AWS customer account that can no longer restore the specified snapshot.

    " + } + }, + "documentation":"

    " + }, + "RevokeSnapshotAccessResult":{ + "type":"structure", + "members":{ + "Snapshot":{"shape":"Snapshot"} + } + }, + "RotateEncryptionKeyMessage":{ + "type":"structure", + "required":["ClusterIdentifier"], + "members":{ + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The unique identifier of the cluster that you want to rotate the encryption keys for.

    Constraints: Must be the name of valid cluster that has encryption enabled.

    " + } + }, + "documentation":"

    " + }, + "RotateEncryptionKeyResult":{ + "type":"structure", + "members":{ + "Cluster":{"shape":"Cluster"} + } + }, + "SNSInvalidTopicFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon SNS has responded that there is a problem with the specified Amazon SNS topic.

    ", + "error":{ + "code":"SNSInvalidTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSNoAuthorizationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You do not have permission to publish to the specified Amazon SNS topic.

    ", + "error":{ + "code":"SNSNoAuthorization", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SNSTopicArnNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An Amazon SNS topic with the specified Amazon Resource Name (ARN) does not exist.

    ", + "error":{ + "code":"SNSTopicArnNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ScheduleDefinitionList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ScheduleDefinition" + } + }, + "ScheduleDefinitionTypeUnsupportedFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The definition you submitted is not supported.

    ", + "error":{ + "code":"ScheduleDefinitionTypeUnsupported", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ScheduleState":{ + "type":"string", + "enum":[ + "MODIFYING", + "ACTIVE", + "FAILED" + ] + }, + "ScheduledSnapshotTimeList":{ + "type":"list", + "member":{ + "shape":"TStamp", + "locationName":"SnapshotTime" + } + }, + "SensitiveString":{ + "type":"string", + "sensitive":true + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The snapshot identifier that is provided in the request.

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the cluster for which the snapshot was taken.

    " + }, + "SnapshotCreateTime":{ + "shape":"TStamp", + "documentation":"

    The time (in UTC format) when Amazon Redshift began the snapshot. A snapshot contains a copy of the cluster data as of this exact time.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The snapshot status. The value of the status depends on the API operation used:

    " + }, + "Port":{ + "shape":"Integer", + "documentation":"

    The port that the cluster is listening on.

    " + }, + "AvailabilityZone":{ + "shape":"String", + "documentation":"

    The Availability Zone in which the cluster was created.

    " + }, + "ClusterCreateTime":{ + "shape":"TStamp", + "documentation":"

    The time (UTC) when the cluster was originally created.

    " + }, + "MasterUsername":{ + "shape":"String", + "documentation":"

    The master user name for the cluster.

    " + }, + "ClusterVersion":{ + "shape":"String", + "documentation":"

    The version ID of the Amazon Redshift engine that is running on the cluster.

    " + }, + "SnapshotType":{ + "shape":"String", + "documentation":"

    The snapshot type. Snapshots created using CreateClusterSnapshot and CopyClusterSnapshot are of type \"manual\".

    " + }, + "NodeType":{ + "shape":"String", + "documentation":"

    The node type of the nodes in the cluster.

    " + }, + "NumberOfNodes":{ + "shape":"Integer", + "documentation":"

    The number of nodes in the cluster.

    " + }, + "DBName":{ + "shape":"String", + "documentation":"

    The name of the database that was created when the cluster was created.

    " + }, + "VpcId":{ + "shape":"String", + "documentation":"

    The VPC identifier of the cluster if the snapshot is from a cluster in a VPC. Otherwise, this field is not in the output.

    " + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

    If true, the data in the snapshot is encrypted at rest.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The AWS Key Management Service (KMS) key ID of the encryption key that was used to encrypt data in the cluster from which the snapshot was taken.

    " + }, + "EncryptedWithHSM":{ + "shape":"Boolean", + "documentation":"

    A boolean that indicates whether the snapshot data is encrypted using the HSM keys of the source cluster. true indicates that the data is encrypted using HSM keys.

    " + }, + "AccountsWithRestoreAccess":{ + "shape":"AccountsWithRestoreAccessList", + "documentation":"

    A list of the AWS customer accounts authorized to restore the snapshot. Returns null if no accounts are authorized. Visible only to the snapshot owner.

    " + }, + "OwnerAccount":{ + "shape":"String", + "documentation":"

    For manual snapshots, the AWS customer account used to create or copy the snapshot. For automatic snapshots, the owner of the cluster. The owner can perform all snapshot actions, such as sharing a manual snapshot.

    " + }, + "TotalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"

    The size of the complete set of backup data that would be used to restore the cluster.

    " + }, + "ActualIncrementalBackupSizeInMegaBytes":{ + "shape":"Double", + "documentation":"

    The size of the incremental backup.

    " + }, + "BackupProgressInMegaBytes":{ + "shape":"Double", + "documentation":"

    The number of megabytes that have been transferred to the snapshot backup.

    " + }, + "CurrentBackupRateInMegaBytesPerSecond":{ + "shape":"Double", + "documentation":"

    The number of megabytes per second being transferred to the snapshot backup. Returns 0 for a completed backup.

    " + }, + "EstimatedSecondsToCompletion":{ + "shape":"Long", + "documentation":"

    The estimate of the time remaining before the snapshot backup will complete. Returns 0 for a completed backup.

    " + }, + "ElapsedTimeInSeconds":{ + "shape":"Long", + "documentation":"

    The amount of time an in-progress snapshot backup has been running, or the amount of time it took a completed backup to finish.

    " + }, + "SourceRegion":{ + "shape":"String", + "documentation":"

    The source region from which the snapshot was copied.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags for the cluster snapshot.

    " + }, + "RestorableNodeTypes":{ + "shape":"RestorableNodeTypeList", + "documentation":"

    The list of node types that this cluster snapshot is able to restore into.

    " + }, + "EnhancedVpcRouting":{ + "shape":"Boolean", + "documentation":"

    An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

    If this option is true, enhanced VPC routing is enabled.

    Default: false

    " + }, + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the maintenance track for the snapshot.

    " + }, + "ManualSnapshotRetentionPeriod":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.

    The value must be either -1 or an integer between 1 and 3,653.

    " + }, + "ManualSnapshotRemainingDays":{ + "shape":"IntegerOptional", + "documentation":"

    The number of days until a manual snapshot will pass its retention period.

    " + }, + "SnapshotRetentionStartTime":{ + "shape":"TStamp", + "documentation":"

    A timestamp representing the start of the retention period for the snapshot.

    " + } + }, + "documentation":"

    Describes a snapshot.

    ", + "wrapper":true + }, + "SnapshotAttributeToSortBy":{ + "type":"string", + "enum":[ + "SOURCE_TYPE", + "TOTAL_SIZE", + "CREATE_TIME" + ] + }, + "SnapshotCopyAlreadyDisabledFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster already has cross-region snapshot copy disabled.

    ", + "error":{ + "code":"SnapshotCopyAlreadyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyAlreadyEnabledFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The cluster already has cross-region snapshot copy enabled.

    ", + "error":{ + "code":"SnapshotCopyAlreadyEnabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyDisabledFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Cross-region snapshot copy was temporarily disabled. Try your request again.

    ", + "error":{ + "code":"SnapshotCopyDisabledFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrant":{ + "type":"structure", + "members":{ + "SnapshotCopyGrantName":{ + "shape":"String", + "documentation":"

    The name of the snapshot copy grant.

    " + }, + "KmsKeyId":{ + "shape":"String", + "documentation":"

    The unique identifier of the customer master key (CMK) in AWS KMS to which Amazon Redshift is granted permission.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tag instances.

    " + } + }, + "documentation":"

    The snapshot copy grant that grants Amazon Redshift permission to encrypt copied snapshots with the specified customer master key (CMK) from AWS KMS in the destination region.

    For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.

    ", + "wrapper":true + }, + "SnapshotCopyGrantAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The snapshot copy grant can't be created because a grant with the same name already exists.

    ", + "error":{ + "code":"SnapshotCopyGrantAlreadyExistsFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrantList":{ + "type":"list", + "member":{ + "shape":"SnapshotCopyGrant", + "locationName":"SnapshotCopyGrant" + } + }, + "SnapshotCopyGrantMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeSnapshotCopyGrant request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    Constraints: You can specify either the SnapshotCopyGrantName parameter or the Marker parameter, but not both.

    " + }, + "SnapshotCopyGrants":{ + "shape":"SnapshotCopyGrantList", + "documentation":"

    The list of SnapshotCopyGrant objects.

    " + } + }, + "documentation":"

    " + }, + "SnapshotCopyGrantNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified snapshot copy grant can't be found. Make sure that the name is typed correctly and that the grant exists in the destination region.

    ", + "error":{ + "code":"SnapshotCopyGrantNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotCopyGrantQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The AWS account has exceeded the maximum number of snapshot copy grants in this region.

    ", + "error":{ + "code":"SnapshotCopyGrantQuotaExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotErrorMessage":{ + "type":"structure", + "members":{ + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the snapshot returning the error.

    " + }, + "SnapshotClusterIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the cluster.

    " + }, + "FailureCode":{ + "shape":"String", + "documentation":"

    The failure code for the error.

    " + }, + "FailureReason":{ + "shape":"String", + "documentation":"

    The text message describing the error.

    " + } + }, + "documentation":"

    Describes the errors returned by a snapshot.

    " + }, + "SnapshotIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"String" + } + }, + "SnapshotList":{ + "type":"list", + "member":{ + "shape":"Snapshot", + "locationName":"Snapshot" + } + }, + "SnapshotMessage":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + }, + "Snapshots":{ + "shape":"SnapshotList", + "documentation":"

    A list of Snapshot instances.

    " + } + }, + "documentation":"

    Contains the output from the DescribeClusterSnapshots action.

    " + }, + "SnapshotSchedule":{ + "type":"structure", + "members":{ + "ScheduleDefinitions":{ + "shape":"ScheduleDefinitionList", + "documentation":"

    A list of ScheduleDefinitions.

    " + }, + "ScheduleIdentifier":{ + "shape":"String", + "documentation":"

    A unique identifier for the schedule.

    " + }, + "ScheduleDescription":{ + "shape":"String", + "documentation":"

    The description of the schedule.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An optional set of tags describing the schedule.

    " + }, + "NextInvocations":{ + "shape":"ScheduledSnapshotTimeList", + "documentation":"

    " + }, + "AssociatedClusterCount":{ + "shape":"IntegerOptional", + "documentation":"

    The number of clusters associated with the schedule.

    " + }, + "AssociatedClusters":{ + "shape":"AssociatedClusterList", + "documentation":"

    A list of clusters associated with the schedule. A maximum of 100 clusters is returned.

    " + } + }, + "documentation":"

    Describes a snapshot schedule. You can set a regular interval for creating snapshots of a cluster. You can also schedule snapshots for specific dates.

    " + }, + "SnapshotScheduleAlreadyExistsFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified snapshot schedule already exists.

    ", + "error":{ + "code":"SnapshotScheduleAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotScheduleList":{ + "type":"list", + "member":{ + "shape":"SnapshotSchedule", + "locationName":"SnapshotSchedule" + } + }, + "SnapshotScheduleNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    We could not find the specified snapshot schedule.

    ", + "error":{ + "code":"SnapshotScheduleNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotScheduleQuotaExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the quota of snapshot schedules.

    ", + "error":{ + "code":"SnapshotScheduleQuotaExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotScheduleUpdateInProgressFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified snapshot schedule is already being updated.

    ", + "error":{ + "code":"SnapshotScheduleUpdateInProgress", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SnapshotSortingEntity":{ + "type":"structure", + "required":["Attribute"], + "members":{ + "Attribute":{ + "shape":"SnapshotAttributeToSortBy", + "documentation":"

    The category for sorting the snapshots.

    " + }, + "SortOrder":{ + "shape":"SortByOrder", + "documentation":"

    The order for listing the attributes.

    " + } + }, + "documentation":"

    Describes a sorting entity

    " + }, + "SnapshotSortingEntityList":{ + "type":"list", + "member":{ + "shape":"SnapshotSortingEntity", + "locationName":"SnapshotSortingEntity" + } + }, + "SortByOrder":{ + "type":"string", + "enum":[ + "ASC", + "DESC" + ] + }, + "SourceIdsList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SourceId" + } + }, + "SourceNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified Amazon Redshift event source could not be found.

    ", + "error":{ + "code":"SourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SourceType":{ + "type":"string", + "enum":[ + "cluster", + "cluster-parameter-group", + "cluster-security-group", + "cluster-snapshot" + ] + }, + "String":{"type":"string"}, + "Subnet":{ + "type":"structure", + "members":{ + "SubnetIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the subnet.

    " + }, + "SubnetAvailabilityZone":{ + "shape":"AvailabilityZone", + "documentation":"

    " + }, + "SubnetStatus":{ + "shape":"String", + "documentation":"

    The status of the subnet.

    " + } + }, + "documentation":"

    Describes a subnet.

    " + }, + "SubnetAlreadyInUse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A specified subnet is already in use by another cluster.

    ", + "error":{ + "code":"SubnetAlreadyInUse", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubnetIdentifierList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"SubnetIdentifier" + } + }, + "SubnetList":{ + "type":"list", + "member":{ + "shape":"Subnet", + "locationName":"Subnet" + } + }, + "SubscriptionAlreadyExistFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    There is already an existing event notification subscription with the specified name.

    ", + "error":{ + "code":"SubscriptionAlreadyExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "SubscriptionCategoryNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The value specified for the event category was not one of the allowed values, or it specified a category that does not apply to the specified source type. The allowed values are Configuration, Management, Monitoring, and Security.

    ", + "error":{ + "code":"SubscriptionCategoryNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionEventIdNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An Amazon Redshift event with the specified event ID does not exist.

    ", + "error":{ + "code":"SubscriptionEventIdNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An Amazon Redshift event notification subscription with the specified name does not exist.

    ", + "error":{ + "code":"SubscriptionNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SubscriptionSeverityNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The value specified for the event severity was not one of the allowed values, or it specified a severity that does not apply to the specified source type. The allowed values are ERROR and INFO.

    ", + "error":{ + "code":"SubscriptionSeverityNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SupportedOperation":{ + "type":"structure", + "members":{ + "OperationName":{ + "shape":"String", + "documentation":"

    A list of the supported operations.

    " + } + }, + "documentation":"

    Describes the operations that are allowed on a maintenance track.

    " + }, + "SupportedOperationList":{ + "type":"list", + "member":{ + "shape":"SupportedOperation", + "locationName":"SupportedOperation" + } + }, + "SupportedPlatform":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    " + } + }, + "documentation":"

    A list of supported platforms for orderable clusters.

    ", + "wrapper":true + }, + "SupportedPlatformsList":{ + "type":"list", + "member":{ + "shape":"SupportedPlatform", + "locationName":"SupportedPlatform" + } + }, + "TStamp":{"type":"timestamp"}, + "TableLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The number of tables in the cluster exceeds the limit for the requested new cluster node type.

    ", + "error":{ + "code":"TableLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TableRestoreNotFoundFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified TableRestoreRequestId value was not found.

    ", + "error":{ + "code":"TableRestoreNotFoundFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TableRestoreStatus":{ + "type":"structure", + "members":{ + "TableRestoreRequestId":{ + "shape":"String", + "documentation":"

    The unique identifier for the table restore request.

    " + }, + "Status":{ + "shape":"TableRestoreStatusType", + "documentation":"

    A value that describes the current state of the table restore request.

    Valid Values: SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    A description of the status of the table restore request. Status values include SUCCEEDED, FAILED, CANCELED, PENDING, IN_PROGRESS.

    " + }, + "RequestTime":{ + "shape":"TStamp", + "documentation":"

    The time that the table restore request was made, in Universal Coordinated Time (UTC).

    " + }, + "ProgressInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

    The amount of data restored to the new table so far, in megabytes (MB).

    " + }, + "TotalDataInMegaBytes":{ + "shape":"LongOptional", + "documentation":"

    The total amount of data to restore to the new table, in megabytes (MB).

    " + }, + "ClusterIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the Amazon Redshift cluster that the table is being restored to.

    " + }, + "SnapshotIdentifier":{ + "shape":"String", + "documentation":"

    The identifier of the snapshot that the table is being restored from.

    " + }, + "SourceDatabaseName":{ + "shape":"String", + "documentation":"

    The name of the source database that contains the table being restored.

    " + }, + "SourceSchemaName":{ + "shape":"String", + "documentation":"

    The name of the source schema that contains the table being restored.

    " + }, + "SourceTableName":{ + "shape":"String", + "documentation":"

    The name of the source table being restored.

    " + }, + "TargetDatabaseName":{ + "shape":"String", + "documentation":"

    The name of the database to restore the table to.

    " + }, + "TargetSchemaName":{ + "shape":"String", + "documentation":"

    The name of the schema to restore the table to.

    " + }, + "NewTableName":{ + "shape":"String", + "documentation":"

    The name of the table to create as a result of the table restore request.

    " + } + }, + "documentation":"

    Describes the status of a RestoreTableFromClusterSnapshot operation.

    ", + "wrapper":true + }, + "TableRestoreStatusList":{ + "type":"list", + "member":{ + "shape":"TableRestoreStatus", + "locationName":"TableRestoreStatus" + } + }, + "TableRestoreStatusMessage":{ + "type":"structure", + "members":{ + "TableRestoreStatusDetails":{ + "shape":"TableRestoreStatusList", + "documentation":"

    A list of status details for one or more table restore requests.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A pagination token that can be used in a subsequent DescribeTableRestoreStatus request.

    " + } + }, + "documentation":"

    " + }, + "TableRestoreStatusType":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "CANCELED" + ] + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"String", + "documentation":"

    The key, or name, for the resource tag.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The value for the resource tag.

    " + } + }, + "documentation":"

    A tag consisting of a name/value pair for a resource.

    " + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"TagKey" + } + }, + "TagLimitExceededFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You have exceeded the number of tags allowed.

    ", + "error":{ + "code":"TagLimitExceededFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "TagValueList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"TagValue" + } + }, + "TaggedResource":{ + "type":"structure", + "members":{ + "Tag":{ + "shape":"Tag", + "documentation":"

    The tag for the resource.

    " + }, + "ResourceName":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) with which the tag is associated, for example: arn:aws:redshift:us-east-1:123456789:cluster:t1.

    " + }, + "ResourceType":{ + "shape":"String", + "documentation":"

    The type of resource with which the tag is associated. Valid resource types are:

    • Cluster

    • CIDR/IP

    • EC2 security group

    • Snapshot

    • Cluster security group

    • Subnet group

    • HSM connection

    • HSM certificate

    • Parameter group

    For more information about Amazon Redshift resource types and constructing ARNs, go to Constructing an Amazon Redshift Amazon Resource Name (ARN) in the Amazon Redshift Cluster Management Guide.

    " + } + }, + "documentation":"

    A tag and its associated resource.

    " + }, + "TaggedResourceList":{ + "type":"list", + "member":{ + "shape":"TaggedResource", + "locationName":"TaggedResource" + } + }, + "TaggedResourceListMessage":{ + "type":"structure", + "members":{ + "TaggedResources":{ + "shape":"TaggedResourceList", + "documentation":"

    A list of tags with their associated resources.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

    " + } + }, + "documentation":"

    " + }, + "TrackList":{ + "type":"list", + "member":{ + "shape":"MaintenanceTrack", + "locationName":"MaintenanceTrack" + } + }, + "TrackListMessage":{ + "type":"structure", + "members":{ + "MaintenanceTracks":{ + "shape":"TrackList", + "documentation":"

    A list of maintenance tracks output by the DescribeClusterTracks operation.

    " + }, + "Marker":{ + "shape":"String", + "documentation":"

    The starting point to return a set of response tracklist records. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

    " + } + } + }, + "UnauthorizedOperation":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Your account is not authorized to perform the requested operation.

    ", + "error":{ + "code":"UnauthorizedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnknownSnapshotCopyRegionFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified region is incorrect or does not exist.

    ", + "error":{ + "code":"UnknownSnapshotCopyRegionFault", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOperationFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested operation isn't supported.

    ", + "error":{ + "code":"UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOptionFault":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A request option was specified that is not supported.

    ", + "error":{ + "code":"UnsupportedOptionFault", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UpdateTarget":{ + "type":"structure", + "members":{ + "MaintenanceTrackName":{ + "shape":"String", + "documentation":"

    The name of the new maintenance track.

    " + }, + "DatabaseVersion":{ + "shape":"String", + "documentation":"

    The cluster version for the new maintenance track.

    " + }, + "SupportedOperations":{ + "shape":"SupportedOperationList", + "documentation":"

    A list of operations supported by the maintenance track.

    " + } + }, + "documentation":"

    A maintenance track that you can switch the current track to.

    " + }, + "ValueStringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"item" + } + }, + "VpcSecurityGroupIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"VpcSecurityGroupId" + } + }, + "VpcSecurityGroupMembership":{ + "type":"structure", + "members":{ + "VpcSecurityGroupId":{ + "shape":"String", + "documentation":"

    The identifier of the VPC security group.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the VPC security group.

    " + } + }, + "documentation":"

    Describes the members of a VPC security group.

    " + }, + "VpcSecurityGroupMembershipList":{ + "type":"list", + "member":{ + "shape":"VpcSecurityGroupMembership", + "locationName":"VpcSecurityGroup" + } + } + }, + "documentation":"Amazon Redshift

    Overview

    This is an interface reference for Amazon Redshift. It contains documentation for one of the programming or command line interfaces you can use to manage Amazon Redshift clusters. Note that Amazon Redshift is asynchronous, which means that some interfaces may require techniques, such as polling or asynchronous callback handlers, to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a change is applied immediately, on the next instance reboot, or during the next maintenance window. For a summary of the Amazon Redshift cluster management interfaces, go to Using the Amazon Redshift Management Interfaces.

    Amazon Redshift manages all the work of setting up, operating, and scaling a data warehouse: provisioning capacity, monitoring and backing up the cluster, and applying patches and upgrades to the Amazon Redshift engine. You can focus on using your data to acquire new insights for your business and customers.

    If you are a first-time user of Amazon Redshift, we recommend that you begin by reading the Amazon Redshift Getting Started Guide.

    If you are a database developer, the Amazon Redshift Database Developer Guide explains how to design, build, query, and maintain the databases that make up your data warehouse.

    " +} diff --git a/aws/dist/botocore/data/redshift/2012-12-01/waiters-2.json b/aws/dist/botocore/data/redshift/2012-12-01/waiters-2.json new file mode 100644 index 00000000..164e9b0d --- /dev/null +++ b/aws/dist/botocore/data/redshift/2012-12-01/waiters-2.json @@ -0,0 +1,97 @@ +{ + "version": 2, + "waiters": { + "ClusterAvailable": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "deleting", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "retry" + } + ] + }, + "ClusterDeleted": { + "delay": 60, + "operation": "DescribeClusters", + "maxAttempts": 30, + "acceptors": [ + { + "expected": "ClusterNotFound", + "matcher": "error", + "state": "success" + }, + { + "expected": "creating", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + }, + { + "expected": "modifying", + "matcher": "pathAny", + "state": "failure", + "argument": "Clusters[].ClusterStatus" + } + ] + }, + "ClusterRestored": { + "operation": "DescribeClusters", + "maxAttempts": 30, + "delay": 60, + "acceptors": [ + { + "state": "success", + "matcher": "pathAll", + "argument": "Clusters[].RestoreStatus.Status", + "expected": "completed" + }, + { + "state": "failure", + "matcher": "pathAny", + "argument": "Clusters[].ClusterStatus", + "expected": "deleting" + } + ] + }, + "SnapshotAvailable": { + "delay": 15, + "operation": "DescribeClusterSnapshots", + "maxAttempts": 20, + "acceptors": [ + { + "expected": "available", + "matcher": "pathAll", + "state": "success", + "argument": "Snapshots[].Status" + }, + { + "expected": "failed", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + }, + { + "expected": "deleted", + "matcher": "pathAny", + "state": "failure", + "argument": "Snapshots[].Status" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/rekognition/2016-06-27/examples-1.json b/aws/dist/botocore/data/rekognition/2016-06-27/examples-1.json new file mode 100644 index 00000000..20b03280 --- /dev/null +++ b/aws/dist/botocore/data/rekognition/2016-06-27/examples-1.json @@ -0,0 +1,651 @@ +{ + "version": "1.0", + "examples": { + "CompareFaces": [ + { + "input": { + "SimilarityThreshold": 90, + "SourceImage": { + "S3Object": { + "Bucket": "mybucket", + "Name": "mysourceimage" + } + }, + "TargetImage": { + "S3Object": { + "Bucket": "mybucket", + "Name": "mytargetimage" + } + } + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289 + }, + "Similarity": 100 + } + ], + "SourceImageFace": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289 + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation compares the largest face detected in the source image with each face detected in the target image.", + "id": "to-compare-two-images-1482181985581", + "title": "To compare two images" + } + ], + "CreateCollection": [ + { + "input": { + "CollectionId": "myphotos" + }, + "output": { + "CollectionArn": "aws:rekognition:us-west-2:123456789012:collection/myphotos", + "StatusCode": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation creates a Rekognition collection for storing image data.", + "id": "to-create-a-collection-1481833313674", + "title": "To create a collection" + } + ], + "DeleteCollection": [ + { + "input": { + "CollectionId": "myphotos" + }, + "output": { + "StatusCode": 200 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes a Rekognition collection.", + "id": "to-delete-a-collection-1481838179973", + "title": "To delete a collection" + } + ], + "DeleteFaces": [ + { + "input": { + "CollectionId": "myphotos", + "FaceIds": [ + "ff43d742-0c13-5d16-a3e8-03d3f58e980b" + ] + }, + "output": { + "DeletedFaces": [ + "ff43d742-0c13-5d16-a3e8-03d3f58e980b" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes one or more faces from a Rekognition collection.", + "id": "to-delete-a-face-1482182799377", + "title": "To delete a face" + } + ], + "DetectFaces": [ + { + "input": { + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + } + }, + "output": { + "FaceDetails": [ + { + "BoundingBox": { + "Height": 0.18000000715255737, + "Left": 0.5555555820465088, + "Top": 0.33666667342185974, + "Width": 0.23999999463558197 + }, + "Confidence": 100, + "Landmarks": [ + { + "Type": "EYE_LEFT", + "X": 0.6394737362861633, + "Y": 0.40819624066352844 + }, + { + "Type": "EYE_RIGHT", + "X": 0.7266660928726196, + "Y": 0.41039225459098816 + }, + { + "Type": "NOSE_LEFT", + "X": 0.6912462115287781, + "Y": 0.44240960478782654 + }, + { + "Type": "MOUTH_DOWN", + "X": 0.6306198239326477, + "Y": 0.46700039505958557 + }, + { + "Type": "MOUTH_UP", + "X": 0.7215608954429626, + "Y": 0.47114261984825134 + } + ], + "Pose": { + "Pitch": 4.050806522369385, + "Roll": 0.9950747489929199, + "Yaw": 13.693790435791016 + }, + "Quality": { + "Brightness": 37.60169982910156, + "Sharpness": 80 + } + } + ], + "OrientationCorrection": "ROTATE_0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects faces in an image stored in an AWS S3 bucket.", + "id": "to-detect-faces-in-an-image-1481841782793", + "title": "To detect faces in an image" + } + ], + "DetectLabels": [ + { + "input": { + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + }, + "MaxLabels": 123, + "MinConfidence": 70 + }, + "output": { + "Labels": [ + { + "Confidence": 99.25072479248047, + "Name": "People" + }, + { + "Confidence": 99.25074005126953, + "Name": "Person" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects labels in the supplied image", + "id": "to-detect-labels-1481834255770", + "title": "To detect labels" + } + ], + "IndexFaces": [ + { + "input": { + "CollectionId": "myphotos", + "DetectionAttributes": [ + + ], + "ExternalImageId": "myphotoid", + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + } + }, + "output": { + "FaceRecords": [ + { + "Face": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289, + "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "FaceDetail": { + "BoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "Confidence": 99.9991226196289, + "Landmarks": [ + { + "Type": "EYE_LEFT", + "X": 0.3976764678955078, + "Y": 0.6248345971107483 + }, + { + "Type": "EYE_RIGHT", + "X": 0.4810936450958252, + "Y": 0.6317117214202881 + }, + { + "Type": "NOSE_LEFT", + "X": 0.41986238956451416, + "Y": 0.7111940383911133 + }, + { + "Type": "MOUTH_DOWN", + "X": 0.40525302290916443, + "Y": 0.7497701048851013 + }, + { + "Type": "MOUTH_UP", + "X": 0.4753248989582062, + "Y": 0.7558549642562866 + } + ], + "Pose": { + "Pitch": -9.713645935058594, + "Roll": 4.707281112670898, + "Yaw": -24.438663482666016 + }, + "Quality": { + "Brightness": 29.23358917236328, + "Sharpness": 80 + } + } + }, + { + "Face": { + "BoundingBox": { + "Height": 0.32592591643333435, + "Left": 0.5144444704055786, + "Top": 0.15111111104488373, + "Width": 0.24444444477558136 + }, + "Confidence": 99.99950408935547, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "FaceDetail": { + "BoundingBox": { + "Height": 0.32592591643333435, + "Left": 0.5144444704055786, + "Top": 0.15111111104488373, + "Width": 0.24444444477558136 + }, + "Confidence": 99.99950408935547, + "Landmarks": [ + { + "Type": "EYE_LEFT", + "X": 0.6006892323493958, + "Y": 0.290842205286026 + }, + { + "Type": "EYE_RIGHT", + "X": 0.6808141469955444, + "Y": 0.29609042406082153 + }, + { + "Type": "NOSE_LEFT", + "X": 0.6395332217216492, + "Y": 0.3522595763206482 + }, + { + "Type": "MOUTH_DOWN", + "X": 0.5892083048820496, + "Y": 0.38689887523651123 + }, + { + "Type": "MOUTH_UP", + "X": 0.674560010433197, + "Y": 0.394125759601593 + } + ], + "Pose": { + "Pitch": -4.683138370513916, + "Roll": 2.1029529571533203, + "Yaw": 6.716655254364014 + }, + "Quality": { + "Brightness": 34.951698303222656, + "Sharpness": 160 + } + } + } + ], + "OrientationCorrection": "ROTATE_0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation detects faces in an image and adds them to the specified Rekognition collection.", + "id": "to-add-a-face-to-a-collection-1482179542923", + "title": "To add a face to a collection" + } + ], + "ListCollections": [ + { + "input": { + }, + "output": { + "CollectionIds": [ + "myphotos" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation returns a list of Rekognition collections.", + "id": "to-list-the-collections-1482179199088", + "title": "To list the collections" + } + ], + "ListFaces": [ + { + "input": { + "CollectionId": "myphotos", + "MaxResults": 20 + }, + "output": { + "Faces": [ + { + "BoundingBox": { + "Height": 0.18000000715255737, + "Left": 0.5555559992790222, + "Top": 0.336667001247406, + "Width": 0.23999999463558197 + }, + "Confidence": 100, + "FaceId": "1c62e8b5-69a7-5b7d-b3cd-db4338a8a7e7", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + { + "BoundingBox": { + "Height": 0.16555599868297577, + "Left": 0.30963000655174255, + "Top": 0.7066670060157776, + "Width": 0.22074100375175476 + }, + "Confidence": 100, + "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + { + "BoundingBox": { + "Height": 0.3234420120716095, + "Left": 0.3233329951763153, + "Top": 0.5, + "Width": 0.24222199618816376 + }, + "Confidence": 99.99829864501953, + "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + { + "BoundingBox": { + "Height": 0.03555560111999512, + "Left": 0.37388700246810913, + "Top": 0.2477779984474182, + "Width": 0.04747769981622696 + }, + "Confidence": 99.99210357666016, + "FaceId": "3b01bef0-c883-5654-ba42-d5ad28b720b3", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.05333330109715462, + "Left": 0.2937690019607544, + "Top": 0.35666701197624207, + "Width": 0.07121659815311432 + }, + "Confidence": 99.99919891357422, + "FaceId": "4839a608-49d0-566c-8301-509d71b534d1", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.3249259889125824, + "Left": 0.5155559778213501, + "Top": 0.1513350009918213, + "Width": 0.24333299696445465 + }, + "Confidence": 99.99949645996094, + "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + { + "BoundingBox": { + "Height": 0.03777780011296272, + "Left": 0.7002969980239868, + "Top": 0.18777799606323242, + "Width": 0.05044509842991829 + }, + "Confidence": 99.92639923095703, + "FaceId": "7f5f88ed-d684-5a88-b0df-01e4a521552b", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.05555560067296028, + "Left": 0.13946600258350372, + "Top": 0.46333301067352295, + "Width": 0.07270029932260513 + }, + "Confidence": 99.99469757080078, + "FaceId": "895b4e2c-81de-5902-a4bd-d1792bda00b2", + "ImageId": "812d9f04-86f9-54fc-9275-8d0dcbcb6784" + }, + { + "BoundingBox": { + "Height": 0.3259260058403015, + "Left": 0.5144439935684204, + "Top": 0.15111100673675537, + "Width": 0.24444399774074554 + }, + "Confidence": 99.99949645996094, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + { + "BoundingBox": { + "Height": 0.18888899683952332, + "Left": 0.3783380091190338, + "Top": 0.2355560064315796, + "Width": 0.25222599506378174 + }, + "Confidence": 99.9999008178711, + "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5", + "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07" + }, + { + "BoundingBox": { + "Height": 0.33481499552726746, + "Left": 0.31888899207115173, + "Top": 0.49333301186561584, + "Width": 0.25 + }, + "Confidence": 99.99909973144531, + "FaceId": "ff43d742-0c13-5d16-a3e8-03d3f58e980b", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation lists the faces in a Rekognition collection.", + "id": "to-list-the-faces-in-a-collection-1482181416530", + "title": "To list the faces in a collection" + } + ], + "SearchFaces": [ + { + "input": { + "CollectionId": "myphotos", + "FaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14", + "FaceMatchThreshold": 90, + "MaxFaces": 10 + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.3259260058403015, + "Left": 0.5144439935684204, + "Top": 0.15111100673675537, + "Width": 0.24444399774074554 + }, + "Confidence": 99.99949645996094, + "FaceId": "8be04dba-4e58-520d-850e-9eae4af70eb2", + "ImageId": "465f4e93-763e-51d0-b030-b9667a2d94b1" + }, + "Similarity": 99.97222137451172 + }, + { + "Face": { + "BoundingBox": { + "Height": 0.16555599868297577, + "Left": 0.30963000655174255, + "Top": 0.7066670060157776, + "Width": 0.22074100375175476 + }, + "Confidence": 100, + "FaceId": "29a75abe-397b-5101-ba4f-706783b2246c", + "ImageId": "147fdf82-7a71-52cf-819b-e786c7b9746e" + }, + "Similarity": 97.04154968261719 + }, + { + "Face": { + "BoundingBox": { + "Height": 0.18888899683952332, + "Left": 0.3783380091190338, + "Top": 0.2355560064315796, + "Width": 0.25222599506378174 + }, + "Confidence": 99.9999008178711, + "FaceId": "908544ad-edc3-59df-8faf-6a87cc256cf5", + "ImageId": "3c731605-d772-541a-a5e7-0375dbc68a07" + }, + "Similarity": 95.94520568847656 + } + ], + "SearchedFaceId": "70008e50-75e4-55d0-8e80-363fb73b3a14" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation searches for matching faces in the collection the supplied face belongs to.", + "id": "to-delete-a-face-1482182799377", + "title": "To delete a face" + } + ], + "SearchFacesByImage": [ + { + "input": { + "CollectionId": "myphotos", + "FaceMatchThreshold": 95, + "Image": { + "S3Object": { + "Bucket": "mybucket", + "Name": "myphoto" + } + }, + "MaxFaces": 5 + }, + "output": { + "FaceMatches": [ + { + "Face": { + "BoundingBox": { + "Height": 0.3234420120716095, + "Left": 0.3233329951763153, + "Top": 0.5, + "Width": 0.24222199618816376 + }, + "Confidence": 99.99829864501953, + "FaceId": "38271d79-7bc2-5efb-b752-398a8d575b85", + "ImageId": "d5631190-d039-54e4-b267-abd22c8647c5" + }, + "Similarity": 99.97036743164062 + } + ], + "SearchedFaceBoundingBox": { + "Height": 0.33481481671333313, + "Left": 0.31888890266418457, + "Top": 0.4933333396911621, + "Width": 0.25 + }, + "SearchedFaceConfidence": 99.9991226196289 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation searches for faces in a Rekognition collection that match the largest face in an S3 bucket stored image.", + "id": "to-search-for-faces-matching-a-supplied-image-1482175994491", + "title": "To search for faces matching a supplied image" + } + ] + } +} diff --git a/aws/dist/botocore/data/rekognition/2016-06-27/paginators-1.json b/aws/dist/botocore/data/rekognition/2016-06-27/paginators-1.json new file mode 100644 index 00000000..ea009a1b --- /dev/null +++ b/aws/dist/botocore/data/rekognition/2016-06-27/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListCollections": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": [ + "CollectionIds", + "FaceModelVersions" + ] + }, + "ListFaces": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Faces", + "non_aggregate_keys": [ + "FaceModelVersion" + ] + }, + "ListStreamProcessors": { + "result_key": "StreamProcessors", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/rekognition/2016-06-27/service-2.json b/aws/dist/botocore/data/rekognition/2016-06-27/service-2.json new file mode 100644 index 00000000..f81e973d --- /dev/null +++ b/aws/dist/botocore/data/rekognition/2016-06-27/service-2.json @@ -0,0 +1,3238 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-06-27", + "endpointPrefix":"rekognition", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Rekognition", + "serviceId":"Rekognition", + "signatureVersion":"v4", + "targetPrefix":"RekognitionService", + "uid":"rekognition-2016-06-27" + }, + "operations":{ + "CompareFaces":{ + "name":"CompareFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CompareFacesRequest"}, + "output":{"shape":"CompareFacesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

    If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image.

    You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

    In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match.

    By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the SimilarityThreshold parameter.

    CompareFaces also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value.

    If the image doesn't contain Exif metadata, CompareFaces returns orientation information for the source and target images. Use these values to display the images with the correct image orientation.

    If no faces are detected in the source or target images, CompareFaces returns an InvalidParameterException error.

    This is a stateless API operation. That is, data returned by this operation doesn't persist.

    For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:CompareFaces action.

    " + }, + "CreateCollection":{ + "name":"CreateCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCollectionRequest"}, + "output":{"shape":"CreateCollectionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

    Creates a collection in an AWS Region. You can add faces to the collection using the IndexFaces operation.

    For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

    When you create a collection, it is associated with the latest version of the face model version.

    Collection names are case-sensitive.

    This operation requires permissions to perform the rekognition:CreateCollection action.

    " + }, + "CreateStreamProcessor":{ + "name":"CreateStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStreamProcessorRequest"}, + "output":{"shape":"CreateStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video.

    Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams.

    You provide as input a Kinesis video stream (Input) and a Kinesis data stream (Output) stream. You also specify the face recognition criteria in Settings. For example, the collection containing faces that you want to recognize. Use Name to assign an identifier for the stream processor. You use Name to manage the stream processor. For example, you can start processing the source video by calling StartStreamProcessor with the Name field.

    After you have finished analyzing a streaming video, use StopStreamProcessor to stop processing. You can delete the stream processor by calling DeleteStreamProcessor.

    " + }, + "DeleteCollection":{ + "name":"DeleteCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCollectionRequest"}, + "output":{"shape":"DeleteCollectionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see delete-collection-procedure.

    This operation requires permissions to perform the rekognition:DeleteCollection action.

    " + }, + "DeleteFaces":{ + "name":"DeleteFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFacesRequest"}, + "output":{"shape":"DeleteFacesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

    This operation requires permissions to perform the rekognition:DeleteFaces action.

    " + }, + "DeleteStreamProcessor":{ + "name":"DeleteStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStreamProcessorRequest"}, + "output":{"shape":"DeleteStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Deletes the stream processor identified by Name. You assign the value for Name when you create the stream processor with CreateStreamProcessor. You might not be able to use the same name for a stream processor for a few seconds after calling DeleteStreamProcessor.

    " + }, + "DescribeCollection":{ + "name":"DescribeCollection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCollectionRequest"}, + "output":{"shape":"DescribeCollectionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Describes the specified collection. You can use DescribeCollection to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection.

    For more information, see Describing a Collection in the Amazon Rekognition Developer Guide.

    " + }, + "DescribeStreamProcessor":{ + "name":"DescribeStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStreamProcessorRequest"}, + "output":{"shape":"DescribeStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.

    " + }, + "DetectFaces":{ + "name":"DetectFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectFacesRequest"}, + "output":{"shape":"DetectFacesResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Detects faces within an image that is provided as input.

    DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on.

    The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.

    You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

    This is a stateless API operation. That is, the operation does not persist any data.

    This operation requires permissions to perform the rekognition:DetectFaces action.

    " + }, + "DetectLabels":{ + "name":"DetectLabels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectLabelsRequest"}, + "output":{"shape":"DetectLabelsResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.

    For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.

    DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.

    You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

    For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.

    {Name: lighthouse, Confidence: 98.4629}

    {Name: rock,Confidence: 79.2097}

    {Name: sea,Confidence: 75.061}

    In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.

    {Name: flower,Confidence: 99.0562}

    {Name: plant,Confidence: 99.0562}

    {Name: tulip,Confidence: 99.0562}

    In this example, the detection algorithm more precisely identifies the flower as a tulip.

    In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.

    If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.

    DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.

    DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.

    This is a stateless API operation. That is, the operation does not persist any data.

    This operation requires permissions to perform the rekognition:DetectLabels action.

    " + }, + "DetectModerationLabels":{ + "name":"DetectModerationLabels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectModerationLabelsRequest"}, + "output":{"shape":"DetectModerationLabelsResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.

    To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.

    For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

    You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

    " + }, + "DetectText":{ + "name":"DetectText", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectTextRequest"}, + "output":{"shape":"DetectTextResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Detects text in the input image and converts it into machine-readable text.

    Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.

    The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.

    A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 50 words in an image.

    A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.

    To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.

    To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.

    For more information, see DetectText in the Amazon Rekognition Developer Guide.

    " + }, + "GetCelebrityInfo":{ + "name":"GetCelebrityInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCelebrityInfoRequest"}, + "output":{"shape":"GetCelebrityInfoResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

    For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

    " + }, + "GetCelebrityRecognition":{ + "name":"GetCelebrityRecognition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCelebrityRecognitionRequest"}, + "output":{"shape":"GetCelebrityRecognitionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

    Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection.

    For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.

    GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected.

    GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

    By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.

    The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.

    No information is returned for faces not recognized as celebrities.

    Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.

    " + }, + "GetContentModeration":{ + "name":"GetContentModeration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContentModerationRequest"}, + "output":{"shape":"GetContentModerationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

    Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

    For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.

    GetContentModeration returns detected unsafe content labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.

    By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.

    Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.

    For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

    " + }, + "GetFaceDetection":{ + "name":"GetFaceDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFaceDetectionRequest"}, + "output":{"shape":"GetFaceDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

    Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

    GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.

    Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.

    " + }, + "GetFaceSearch":{ + "name":"GetFaceSearch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFaceSearchRequest"}, + "output":{"shape":"GetFaceSearchResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

    Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.

    For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

    The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

    GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

    By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

    " + }, + "GetLabelDetection":{ + "name":"GetLabelDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLabelDetectionRequest"}, + "output":{"shape":"GetLabelDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

    The label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

    GetLabelDetection returns an array of detected labels (Labels) sorted by the time the labels were detected. You can also sort by the label name by specifying NAME for the SortBy input parameter.

    The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video.

    The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection.

    Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetlabelDetection and populate the NextToken request parameter with the token value returned from the previous call to GetLabelDetection.

    " + }, + "GetPersonTracking":{ + "name":"GetPersonTracking", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPersonTrackingRequest"}, + "output":{"shape":"GetPersonTrackingResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

    The person path tracking operation is started by a call to StartPersonTracking which returns a job identifier (JobId). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartPersonTracking.

    To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

    GetPersonTracking returns an array, Persons, of tracked persons and the time(s) their paths were tracked in the video.

    GetPersonTracking only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned.

    For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

    By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying INDEX for the SortBy input parameter.

    Use the MaxResults parameter to limit the number of items returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetPersonTracking and populate the NextToken request parameter with the token value returned from the previous call to GetPersonTracking.

    " + }, + "IndexFaces":{ + "name":"IndexFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"IndexFacesRequest"}, + "output":{"shape":"IndexFacesResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Detects faces in the input image and adds them to the specified collection.

    Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the SearchFaces and SearchFacesByImage operations.

    For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide.

    To get the number of faces in a collection, call DescribeCollection.

    If you're using version 1.0 of the face detection model, IndexFaces indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image.

    If you're using version 4 or later of the face model, image orientation information is not returned in the OrientationCorrection field.

    To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response from IndexFaces

    For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

    If you provide the optional ExternalImageID for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image.

    You can specify the maximum number of faces to index with the MaxFaces input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background.

    The QualityFilter input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, IndexFaces filters detected faces. You can also explicitly filter detected faces by specifying AUTO for the value of QualityFilter. If you do not want to filter detected faces, specify NONE.

    To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call DescribeCollection.

    Information about faces detected in an image, but not indexed, is returned in an array of UnindexedFace objects, UnindexedFaces. Faces aren't indexed for reasons such as:

    • The number of faces detected exceeds the value of the MaxFaces request parameter.

    • The face is too small compared to the image dimensions.

    • The face is too blurry.

    • The image is too dark.

    • The face has an extreme pose.

    In response, the IndexFaces operation returns an array of metadata for all detected faces, FaceRecords. This includes:

    • The bounding box, BoundingBox, of the detected face.

    • A confidence value, Confidence, which indicates the confidence that the bounding box contains a face.

    • A face ID, FaceId, assigned by the service for each face that's detected and stored.

    • An image ID, ImageId, assigned by the service for the input image.

    If you request all facial attributes (by using the detectionAttributes parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.

    The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.

    This operation requires permissions to perform the rekognition:IndexFaces action.

    " + }, + "ListCollections":{ + "name":"ListCollections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCollectionsRequest"}, + "output":{"shape":"ListCollectionsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns list of collection IDs in your account. If the result is truncated, the response also provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

    For an example, see Listing Collections in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:ListCollections action.

    " + }, + "ListFaces":{ + "name":"ListFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFacesRequest"}, + "output":{"shape":"ListFacesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:ListFaces action.

    " + }, + "ListStreamProcessors":{ + "name":"ListStreamProcessors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStreamProcessorsRequest"}, + "output":{"shape":"ListStreamProcessorsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Gets a list of stream processors that you have created with CreateStreamProcessor.

    " + }, + "RecognizeCelebrities":{ + "name":"RecognizeCelebrities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecognizeCelebritiesRequest"}, + "output":{"shape":"RecognizeCelebritiesResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidImageFormatException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

    RecognizeCelebrities returns the 100 largest faces in the image. It lists recognized celebrities in the CelebrityFaces array and unrecognized faces in the UnrecognizedFaces array. RecognizeCelebrities doesn't return celebrities whose faces aren't among the largest 100 faces in the image.

    For each celebrity recognized, RecognizeCelebrities returns a Celebrity object. The Celebrity object contains the celebrity name, ID, URL links to additional information, match confidence, and a ComparedFace object that you can use to locate the celebrity's face on the image.

    Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the Celebrity ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by RecognizeCelebrities, you will need the ID to identify the celebrity in a call to the GetCelebrityInfo operation.

    You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

    For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:RecognizeCelebrities operation.

    " + }, + "SearchFaces":{ + "name":"SearchFaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchFacesRequest"}, + "output":{"shape":"SearchFacesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

    You can also search faces without indexing faces by using the SearchFacesByImage operation.

    The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

    For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:SearchFaces action.

    " + }, + "SearchFacesByImage":{ + "name":"SearchFacesByImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchFacesByImageRequest"}, + "output":{"shape":"SearchFacesByImageResponse"}, + "errors":[ + {"shape":"InvalidS3ObjectException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ImageTooLargeException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidImageFormatException"} + ], + "documentation":"

    For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

    To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.

    You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

    You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

    The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

    For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

    This operation requires permissions to perform the rekognition:SearchFacesByImage action.

    " + }, + "StartCelebrityRecognition":{ + "name":"StartCelebrityRecognition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartCelebrityRecognitionRequest"}, + "output":{"shape":"StartCelebrityRecognitionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts asynchronous recognition of celebrities in a stored video.

    Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartCelebrityRecognition returns a job identifier (JobId) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityRecognition and pass the job identifier (JobId) from the initial call to StartCelebrityRecognition.

    For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide.

    ", + "idempotent":true + }, + "StartContentModeration":{ + "name":"StartContentModeration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartContentModerationRequest"}, + "output":{"shape":"StartContentModerationResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts asynchronous detection of unsafe content in a stored video.

    Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartContentModeration returns a job identifier (JobId) which you use to get the results of the analysis. When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

    To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.

    For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

    ", + "idempotent":true + }, + "StartFaceDetection":{ + "name":"StartFaceDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFaceDetectionRequest"}, + "output":{"shape":"StartFaceDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts asynchronous detection of faces in a stored video.

    Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceDetection returns a job identifier (JobId) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.

    For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide.

    ", + "idempotent":true + }, + "StartFaceSearch":{ + "name":"StartFaceSearch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFaceSearchRequest"}, + "output":{"shape":"StartFaceSearchResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

    The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartFaceSearch returns a job identifier (JobId) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch. For more information, see procedure-person-search-videos.

    ", + "idempotent":true + }, + "StartLabelDetection":{ + "name":"StartLabelDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartLabelDetectionRequest"}, + "output":{"shape":"StartLabelDetectionResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts asynchronous detection of labels in a stored video.

    Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing.

    The video must be stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartLabelDetection returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

    To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetLabelDetection and pass the job identifier (JobId) from the initial call to StartLabelDetection.

    ", + "idempotent":true + }, + "StartPersonTracking":{ + "name":"StartPersonTracking", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartPersonTrackingRequest"}, + "output":{"shape":"StartPersonTrackingResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"InternalServerError"}, + {"shape":"VideoTooLargeException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Starts the asynchronous tracking of a person's path in a stored video.

    Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use Video to specify the bucket name and the filename of the video. StartPersonTracking returns a job identifier (JobId) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in NotificationChannel.

    To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetPersonTracking and pass the job identifier (JobId) from the initial call to StartPersonTracking.

    ", + "idempotent":true + }, + "StartStreamProcessor":{ + "name":"StartStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartStreamProcessorRequest"}, + "output":{"shape":"StartStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Starts processing a stream processor. You create a stream processor by calling CreateStreamProcessor. To tell StartStreamProcessor which stream processor to start, use the value of the Name field specified in the call to CreateStreamProcessor.

    " + }, + "StopStreamProcessor":{ + "name":"StopStreamProcessor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopStreamProcessorRequest"}, + "output":{"shape":"StopStreamProcessorResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ProvisionedThroughputExceededException"} + ], + "documentation":"

    Stops a running stream processor that was created by CreateStreamProcessor.

    " + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You are not authorized to perform the action.

    ", + "exception":true + }, + "AgeRange":{ + "type":"structure", + "members":{ + "Low":{ + "shape":"UInteger", + "documentation":"

    The lowest estimated age.

    " + }, + "High":{ + "shape":"UInteger", + "documentation":"

    The highest estimated age.

    " + } + }, + "documentation":"

    Structure containing the estimated age range, in years, for a face.

    Amazon Rekognition estimates an age range for faces detected in the input image. Estimated age ranges can overlap. A face of a 5-year-old might have an estimated range of 4-6, while the face of a 6-year-old might have an estimated range of 4-8.

    " + }, + "Attribute":{ + "type":"string", + "enum":[ + "DEFAULT", + "ALL" + ] + }, + "Attributes":{ + "type":"list", + "member":{"shape":"Attribute"} + }, + "Beard":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the face has beard or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the face has a beard, and the confidence level in the determination.

    " + }, + "Boolean":{"type":"boolean"}, + "BoundingBox":{ + "type":"structure", + "members":{ + "Width":{ + "shape":"Float", + "documentation":"

    Width of the bounding box as a ratio of the overall image width.

    " + }, + "Height":{ + "shape":"Float", + "documentation":"

    Height of the bounding box as a ratio of the overall image height.

    " + }, + "Left":{ + "shape":"Float", + "documentation":"

    Left coordinate of the bounding box as a ratio of overall image width.

    " + }, + "Top":{ + "shape":"Float", + "documentation":"

    Top coordinate of the bounding box as a ratio of overall image height.

    " + } + }, + "documentation":"

    Identifies the bounding box around the label, face, or text. The left (x-coordinate) and top (y-coordinate) are coordinates representing the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

    The top and left values returned are ratios of the overall image size. For example, if the input image is 700x200 pixels, and the top-left coordinate of the bounding box is 350x50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

    The width and height values represent the dimensions of the bounding box as a ratio of the overall image dimension. For example, if the input image is 700x200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

    The bounding box coordinates can have negative values. For example, if Amazon Rekognition is able to detect a face that is at the image edge and is only partially visible, the service can return coordinates that are outside the image bounds and, depending on the image edge, you might get negative values or values greater than 1 for the left or top values.

    " + }, + "Celebrity":{ + "type":"structure", + "members":{ + "Urls":{ + "shape":"Urls", + "documentation":"

    An array of URLs pointing to additional information about the celebrity. If there is no additional information about the celebrity, this list is empty.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of the celebrity.

    " + }, + "Id":{ + "shape":"RekognitionUniqueId", + "documentation":"

    A unique identifier for the celebrity.

    " + }, + "Face":{ + "shape":"ComparedFace", + "documentation":"

    Provides information about the celebrity's face, such as its location on the image.

    " + }, + "MatchConfidence":{ + "shape":"Percent", + "documentation":"

    The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

    " + } + }, + "documentation":"

    Provides information about a celebrity recognized by the RecognizeCelebrities operation.

    " + }, + "CelebrityDetail":{ + "type":"structure", + "members":{ + "Urls":{ + "shape":"Urls", + "documentation":"

    An array of URLs pointing to additional celebrity information.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of the celebrity.

    " + }, + "Id":{ + "shape":"RekognitionUniqueId", + "documentation":"

    The unique identifier for the celebrity.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    The confidence, in percentage, that Amazon Rekognition has that the recognized face is the celebrity.

    " + }, + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box around the body of a celebrity.

    " + }, + "Face":{ + "shape":"FaceDetail", + "documentation":"

    Face details for the recognized celebrity.

    " + } + }, + "documentation":"

    Information about a recognized celebrity.

    " + }, + "CelebrityList":{ + "type":"list", + "member":{"shape":"Celebrity"} + }, + "CelebrityRecognition":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The time, in milliseconds from the start of the video, that the celebrity was recognized.

    " + }, + "Celebrity":{ + "shape":"CelebrityDetail", + "documentation":"

    Information about a recognized celebrity.

    " + } + }, + "documentation":"

    Information about a detected celebrity and the time the celebrity was detected in a stored video. For more information, see GetCelebrityRecognition in the Amazon Rekognition Developer Guide.

    " + }, + "CelebrityRecognitionSortBy":{ + "type":"string", + "enum":[ + "ID", + "TIMESTAMP" + ] + }, + "CelebrityRecognitions":{ + "type":"list", + "member":{"shape":"CelebrityRecognition"} + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "CollectionId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-]+" + }, + "CollectionIdList":{ + "type":"list", + "member":{"shape":"CollectionId"} + }, + "CompareFacesMatch":{ + "type":"structure", + "members":{ + "Similarity":{ + "shape":"Percent", + "documentation":"

    Level of confidence that the faces match.

    " + }, + "Face":{ + "shape":"ComparedFace", + "documentation":"

    Provides face metadata (bounding box and confidence that the bounding box actually contains a face).

    " + } + }, + "documentation":"

    Provides information about a face in a target image that matches the source image face analyzed by CompareFaces. The Face property contains the bounding box of the face in the target image. The Similarity property is the confidence that the source image face matches the face in the bounding box.

    " + }, + "CompareFacesMatchList":{ + "type":"list", + "member":{"shape":"CompareFacesMatch"} + }, + "CompareFacesRequest":{ + "type":"structure", + "required":[ + "SourceImage", + "TargetImage" + ], + "members":{ + "SourceImage":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "TargetImage":{ + "shape":"Image", + "documentation":"

    The target image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "SimilarityThreshold":{ + "shape":"Percent", + "documentation":"

    The minimum level of confidence in the face matches that a match must meet to be included in the FaceMatches array.

    " + } + } + }, + "CompareFacesResponse":{ + "type":"structure", + "members":{ + "SourceImageFace":{ + "shape":"ComparedSourceImageFace", + "documentation":"

    The face in the source image that was used for comparison.

    " + }, + "FaceMatches":{ + "shape":"CompareFacesMatchList", + "documentation":"

    An array of faces in the target image that match the source image face. Each CompareFacesMatch object provides the bounding box, the confidence level that the bounding box contains a face, and the similarity score for the face in the bounding box and the face in the source image.

    " + }, + "UnmatchedFaces":{ + "shape":"CompareFacesUnmatchList", + "documentation":"

    An array of faces in the target image that did not match the source image face.

    " + }, + "SourceImageOrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    The value of SourceImageOrientationCorrection is always null.

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

    Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

    " + }, + "TargetImageOrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    The value of TargetImageOrientationCorrection is always null.

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

    Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

    " + } + } + }, + "CompareFacesUnmatchList":{ + "type":"list", + "member":{"shape":"ComparedFace"} + }, + "ComparedFace":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box of the face.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence that what the bounding box contains is a face.

    " + }, + "Landmarks":{ + "shape":"Landmarks", + "documentation":"

    An array of facial landmarks.

    " + }, + "Pose":{ + "shape":"Pose", + "documentation":"

    Indicates the pose of the face as determined by its pitch, roll, and yaw.

    " + }, + "Quality":{ + "shape":"ImageQuality", + "documentation":"

    Identifies face image brightness and sharpness.

    " + } + }, + "documentation":"

    Provides face metadata for target image faces that are analyzed by CompareFaces and RecognizeCelebrities.

    " + }, + "ComparedFaceList":{ + "type":"list", + "member":{"shape":"ComparedFace"} + }, + "ComparedSourceImageFace":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box of the face.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Confidence level that the selected bounding box contains a face.

    " + } + }, + "documentation":"

    Type that describes the face Amazon Rekognition chose to compare with the faces in the target. This contains a bounding box for the selected face and confidence level that the bounding box contains a face. Note that Amazon Rekognition selects the largest face in the source image for this comparison.

    " + }, + "ContentModerationDetection":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    Time, in milliseconds from the beginning of the video, that the unsafe content label was detected.

    " + }, + "ModerationLabel":{ + "shape":"ModerationLabel", + "documentation":"

    The unsafe content label detected by in the stored video.

    " + } + }, + "documentation":"

    Information about an unsafe content label detection in a stored video.

    " + }, + "ContentModerationDetections":{ + "type":"list", + "member":{"shape":"ContentModerationDetection"} + }, + "ContentModerationSortBy":{ + "type":"string", + "enum":[ + "NAME", + "TIMESTAMP" + ] + }, + "CreateCollectionRequest":{ + "type":"structure", + "required":["CollectionId"], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID for the collection that you are creating.

    " + } + } + }, + "CreateCollectionResponse":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"UInteger", + "documentation":"

    HTTP status code indicating the result of the operation.

    " + }, + "CollectionArn":{ + "shape":"String", + "documentation":"

    Amazon Resource Name (ARN) of the collection. You can use this to manage permissions on your resources.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the face detection model associated with the collection you are creating.

    " + } + } + }, + "CreateStreamProcessorRequest":{ + "type":"structure", + "required":[ + "Input", + "Output", + "Name", + "Settings", + "RoleArn" + ], + "members":{ + "Input":{ + "shape":"StreamProcessorInput", + "documentation":"

    Kinesis video stream stream that provides the source streaming video. If you are using the AWS CLI, the parameter name is StreamProcessorInput.

    " + }, + "Output":{ + "shape":"StreamProcessorOutput", + "documentation":"

    Kinesis data stream stream to which Amazon Rekognition Video puts the analysis results. If you are using the AWS CLI, the parameter name is StreamProcessorOutput.

    " + }, + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    An identifier you assign to the stream processor. You can use Name to manage the stream processor. For example, you can get the current status of the stream processor by calling DescribeStreamProcessor. Name is idempotent.

    " + }, + "Settings":{ + "shape":"StreamProcessorSettings", + "documentation":"

    Face recognition input parameters to be used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    ARN of the IAM role that allows access to the stream processor.

    " + } + } + }, + "CreateStreamProcessorResponse":{ + "type":"structure", + "members":{ + "StreamProcessorArn":{ + "shape":"StreamProcessorArn", + "documentation":"

    ARN for the newly create stream processor.

    " + } + } + }, + "DateTime":{"type":"timestamp"}, + "Degree":{ + "type":"float", + "max":180, + "min":-180 + }, + "DeleteCollectionRequest":{ + "type":"structure", + "required":["CollectionId"], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID of the collection to delete.

    " + } + } + }, + "DeleteCollectionResponse":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"UInteger", + "documentation":"

    HTTP status code that indicates the result of the operation.

    " + } + } + }, + "DeleteFacesRequest":{ + "type":"structure", + "required":[ + "CollectionId", + "FaceIds" + ], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    Collection from which to remove the specific faces.

    " + }, + "FaceIds":{ + "shape":"FaceIdList", + "documentation":"

    An array of face IDs to delete.

    " + } + } + }, + "DeleteFacesResponse":{ + "type":"structure", + "members":{ + "DeletedFaces":{ + "shape":"FaceIdList", + "documentation":"

    An array of strings (face IDs) of the faces that were deleted.

    " + } + } + }, + "DeleteStreamProcessorRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    The name of the stream processor you want to delete.

    " + } + } + }, + "DeleteStreamProcessorResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeCollectionRequest":{ + "type":"structure", + "required":["CollectionId"], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    The ID of the collection to describe.

    " + } + } + }, + "DescribeCollectionResponse":{ + "type":"structure", + "members":{ + "FaceCount":{ + "shape":"ULong", + "documentation":"

    The number of faces that are indexed into the collection. To index faces into a collection, use IndexFaces.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    The version of the face model that's used by the collection for face detection.

    For more information, see Model Versioning in the Amazon Rekognition Developer Guide.

    " + }, + "CollectionARN":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the collection.

    " + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

    The number of milliseconds since the Unix epoch time until the creation of the collection. The Unix epoch time is 00:00:00 Coordinated Universal Time (UTC), Thursday, 1 January 1970.

    " + } + } + }, + "DescribeStreamProcessorRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    Name of the stream processor for which you want information.

    " + } + } + }, + "DescribeStreamProcessorResponse":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    Name of the stream processor.

    " + }, + "StreamProcessorArn":{ + "shape":"StreamProcessorArn", + "documentation":"

    ARN of the stream processor.

    " + }, + "Status":{ + "shape":"StreamProcessorStatus", + "documentation":"

    Current status of the stream processor.

    " + }, + "StatusMessage":{ + "shape":"String", + "documentation":"

    Detailed status message about the stream processor.

    " + }, + "CreationTimestamp":{ + "shape":"DateTime", + "documentation":"

    Date and time the stream processor was created

    " + }, + "LastUpdateTimestamp":{ + "shape":"DateTime", + "documentation":"

    The time, in Unix format, the stream processor was last updated. For example, when the stream processor moves from a running state to a failed state, or when the user starts or stops the stream processor.

    " + }, + "Input":{ + "shape":"StreamProcessorInput", + "documentation":"

    Kinesis video stream that provides the source streaming video.

    " + }, + "Output":{ + "shape":"StreamProcessorOutput", + "documentation":"

    Kinesis data stream to which Amazon Rekognition Video puts the analysis results.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    ARN of the IAM role that allows access to the stream processor.

    " + }, + "Settings":{ + "shape":"StreamProcessorSettings", + "documentation":"

    Face recognition input parameters that are being used by the stream processor. Includes the collection to use for face recognition and the face attributes to detect.

    " + } + } + }, + "DetectFacesRequest":{ + "type":"structure", + "required":["Image"], + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

    An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify [\"DEFAULT\"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide [\"ALL\"], all facial attributes are returned, but the operation takes longer to complete.

    If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

    " + } + } + }, + "DetectFacesResponse":{ + "type":"structure", + "members":{ + "FaceDetails":{ + "shape":"FaceDetailList", + "documentation":"

    Details of each face found in the image.

    " + }, + "OrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    The value of OrientationCorrection is always null.

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

    Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

    " + } + } + }, + "DetectLabelsRequest":{ + "type":"structure", + "required":["Image"], + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. Images stored in an S3 Bucket do not need to be base64-encoded.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "MaxLabels":{ + "shape":"UInteger", + "documentation":"

    Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels.

    " + }, + "MinConfidence":{ + "shape":"Percent", + "documentation":"

    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.

    If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.

    " + } + } + }, + "DetectLabelsResponse":{ + "type":"structure", + "members":{ + "Labels":{ + "shape":"Labels", + "documentation":"

    An array of labels for the real-world objects detected.

    " + }, + "OrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    The value of OrientationCorrection is always null.

    If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

    Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

    " + }, + "LabelModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the label detection model that was used to detect labels.

    " + } + } + }, + "DetectModerationLabelsRequest":{ + "type":"structure", + "required":["Image"], + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "MinConfidence":{ + "shape":"Percent", + "documentation":"

    Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.

    If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

    " + } + } + }, + "DetectModerationLabelsResponse":{ + "type":"structure", + "members":{ + "ModerationLabels":{ + "shape":"ModerationLabels", + "documentation":"

    Array of detected Moderation labels and the time, in milliseconds from the start of the video, they were detected.

    " + }, + "ModerationModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the moderation detection model that was used to detect unsafe content.

    " + } + } + }, + "DetectTextRequest":{ + "type":"structure", + "required":["Image"], + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + } + } + }, + "DetectTextResponse":{ + "type":"structure", + "members":{ + "TextDetections":{ + "shape":"TextDetectionList", + "documentation":"

    An array of text that was detected in the input image.

    " + } + } + }, + "Emotion":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"EmotionName", + "documentation":"

    Type of emotion detected.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

    " + }, + "EmotionName":{ + "type":"string", + "enum":[ + "HAPPY", + "SAD", + "ANGRY", + "CONFUSED", + "DISGUSTED", + "SURPRISED", + "CALM", + "UNKNOWN", + "FEAR" + ] + }, + "Emotions":{ + "type":"list", + "member":{"shape":"Emotion"} + }, + "ExternalImageId":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-:]+" + }, + "EyeOpen":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the eyes on the face are open.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

    " + }, + "Eyeglasses":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the face is wearing eye glasses or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

    " + }, + "Face":{ + "type":"structure", + "members":{ + "FaceId":{ + "shape":"FaceId", + "documentation":"

    Unique identifier that Amazon Rekognition assigns to the face.

    " + }, + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box of the face.

    " + }, + "ImageId":{ + "shape":"ImageId", + "documentation":"

    Unique identifier that Amazon Rekognition assigns to the input image.

    " + }, + "ExternalImageId":{ + "shape":"ExternalImageId", + "documentation":"

    Identifier that you assign to all the faces in the input image.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Confidence level that the bounding box contains a face (and not a different object such as a tree).

    " + } + }, + "documentation":"

    Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

    " + }, + "FaceAttributes":{ + "type":"string", + "enum":[ + "DEFAULT", + "ALL" + ] + }, + "FaceDetail":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box of the face. Default attribute.

    " + }, + "AgeRange":{ + "shape":"AgeRange", + "documentation":"

    The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

    " + }, + "Smile":{ + "shape":"Smile", + "documentation":"

    Indicates whether or not the face is smiling, and the confidence level in the determination.

    " + }, + "Eyeglasses":{ + "shape":"Eyeglasses", + "documentation":"

    Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

    " + }, + "Sunglasses":{ + "shape":"Sunglasses", + "documentation":"

    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

    " + }, + "Gender":{ + "shape":"Gender", + "documentation":"

    Gender of the face and the confidence level in the determination.

    " + }, + "Beard":{ + "shape":"Beard", + "documentation":"

    Indicates whether or not the face has a beard, and the confidence level in the determination.

    " + }, + "Mustache":{ + "shape":"Mustache", + "documentation":"

    Indicates whether or not the face has a mustache, and the confidence level in the determination.

    " + }, + "EyesOpen":{ + "shape":"EyeOpen", + "documentation":"

    Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

    " + }, + "MouthOpen":{ + "shape":"MouthOpen", + "documentation":"

    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

    " + }, + "Emotions":{ + "shape":"Emotions", + "documentation":"

    The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.

    " + }, + "Landmarks":{ + "shape":"Landmarks", + "documentation":"

    Indicates the location of landmarks on the face. Default attribute.

    " + }, + "Pose":{ + "shape":"Pose", + "documentation":"

    Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

    " + }, + "Quality":{ + "shape":"ImageQuality", + "documentation":"

    Identifies image brightness and sharpness. Default attribute.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

    " + } + }, + "documentation":"

    Structure containing attributes of the face that the algorithm detected.

    A FaceDetail object contains either the default facial attributes or all facial attributes. The default attributes are BoundingBox, Confidence, Landmarks, Pose, and Quality.

    GetFaceDetection is the only Amazon Rekognition Video stored video operation that can return a FaceDetail object with all attributes. To specify which attributes to return, use the FaceAttributes input parameter for StartFaceDetection. The following Amazon Rekognition Video operations return only the default attributes. The corresponding Start operations don't have a FaceAttributes input parameter.

    • GetCelebrityRecognition

    • GetPersonTracking

    • GetFaceSearch

    The Amazon Rekognition Image DetectFaces and IndexFaces operations can return all facial attributes. To specify which attributes to return, use the Attributes input parameter for DetectFaces. For IndexFaces, use the DetectAttributes input parameter.

    " + }, + "FaceDetailList":{ + "type":"list", + "member":{"shape":"FaceDetail"} + }, + "FaceDetection":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    Time, in milliseconds from the start of the video, that the face was detected.

    " + }, + "Face":{ + "shape":"FaceDetail", + "documentation":"

    The face properties for the detected face.

    " + } + }, + "documentation":"

    Information about a face detected in a video analysis request and the time the face was detected in the video.

    " + }, + "FaceDetections":{ + "type":"list", + "member":{"shape":"FaceDetection"} + }, + "FaceId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "FaceIdList":{ + "type":"list", + "member":{"shape":"FaceId"}, + "max":4096, + "min":1 + }, + "FaceList":{ + "type":"list", + "member":{"shape":"Face"} + }, + "FaceMatch":{ + "type":"structure", + "members":{ + "Similarity":{ + "shape":"Percent", + "documentation":"

    Confidence in the match of this face with the input face.

    " + }, + "Face":{ + "shape":"Face", + "documentation":"

    Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

    " + } + }, + "documentation":"

    Provides face metadata. In addition, it also provides the confidence in the match of this face with the input face.

    " + }, + "FaceMatchList":{ + "type":"list", + "member":{"shape":"FaceMatch"} + }, + "FaceModelVersionList":{ + "type":"list", + "member":{"shape":"String"} + }, + "FaceRecord":{ + "type":"structure", + "members":{ + "Face":{ + "shape":"Face", + "documentation":"

    Describes the face properties such as the bounding box, face ID, image ID of the input image, and external image ID that you assigned.

    " + }, + "FaceDetail":{ + "shape":"FaceDetail", + "documentation":"

    Structure containing attributes of the face that the algorithm detected.

    " + } + }, + "documentation":"

    Object containing both the face metadata (stored in the backend database), and facial attributes that are detected but aren't stored in the database.

    " + }, + "FaceRecordList":{ + "type":"list", + "member":{"shape":"FaceRecord"} + }, + "FaceSearchSettings":{ + "type":"structure", + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    The ID of a collection that contains faces that you want to search for.

    " + }, + "FaceMatchThreshold":{ + "shape":"Percent", + "documentation":"

    Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.

    " + } + }, + "documentation":"

    Input face recognition parameters for an Amazon Rekognition stream processor. FaceRecognitionSettings is a request parameter for CreateStreamProcessor.

    " + }, + "FaceSearchSortBy":{ + "type":"string", + "enum":[ + "INDEX", + "TIMESTAMP" + ] + }, + "Float":{"type":"float"}, + "Gender":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"GenderType", + "documentation":"

    Gender of the face.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Gender of the face and the confidence level in the determination.

    " + }, + "GenderType":{ + "type":"string", + "enum":[ + "Male", + "Female" + ] + }, + "Geometry":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    An axis-aligned coarse representation of the detected text's location on the image.

    " + }, + "Polygon":{ + "shape":"Polygon", + "documentation":"

    Within the bounding box, a fine-grained polygon around the detected text.

    " + } + }, + "documentation":"

    Information about where the text detected by DetectText is located on an image.

    " + }, + "GetCelebrityInfoRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"RekognitionUniqueId", + "documentation":"

    The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

    " + } + } + }, + "GetCelebrityInfoResponse":{ + "type":"structure", + "members":{ + "Urls":{ + "shape":"Urls", + "documentation":"

    An array of URLs pointing to additional celebrity information.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of the celebrity.

    " + } + } + }, + "GetCelebrityRecognitionRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

    " + }, + "SortBy":{ + "shape":"CelebrityRecognitionSortBy", + "documentation":"

    Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

    " + } + } + }, + "GetCelebrityRecognitionResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the celebrity recognition job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of celebrities.

    " + }, + "Celebrities":{ + "shape":"CelebrityRecognitions", + "documentation":"

    Array of celebrities recognized in the video.

    " + } + } + }, + "GetContentModerationRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the unsafe content job. Use JobId to identify the job in a subsequent call to GetContentModeration.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of unsafe content labels.

    " + }, + "SortBy":{ + "shape":"ContentModerationSortBy", + "documentation":"

    Sort to use for elements in the ModerationLabelDetections array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

    " + } + } + }, + "GetContentModerationResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the unsafe content analysis job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.

    " + }, + "ModerationLabels":{ + "shape":"ContentModerationDetections", + "documentation":"

    The detected unsafe content labels and the time(s) they were detected.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of unsafe content labels.

    " + }, + "ModerationModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the moderation detection model that was used to detect unsafe content.

    " + } + } + }, + "GetFaceDetectionRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

    " + } + } + }, + "GetFaceDetectionResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the face detection job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

    " + }, + "Faces":{ + "shape":"FaceDetections", + "documentation":"

    An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.

    " + } + } + }, + "GetFaceSearchRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The job identifer for the search request. You get the job identifier from an initial call to StartFaceSearch.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results.

    " + }, + "SortBy":{ + "shape":"FaceSearchSortBy", + "documentation":"

    Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces.

    " + } + } + }, + "GetFaceSearchResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the face search job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

    " + }, + "Persons":{ + "shape":"PersonMatches", + "documentation":"

    An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person.

    " + } + } + }, + "GetLabelDetectionRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels.

    " + }, + "SortBy":{ + "shape":"LabelDetectionSortBy", + "documentation":"

    Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

    " + } + } + }, + "GetLabelDetectionResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the label detection job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.

    " + }, + "Labels":{ + "shape":"LabelDetections", + "documentation":"

    An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.

    " + }, + "LabelModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the label detection model that was used to detect labels.

    " + } + } + }, + "GetPersonTrackingRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for a job that tracks persons in a video. You get the JobId from a call to StartPersonTracking.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons.

    " + }, + "SortBy":{ + "shape":"PersonTrackingSortBy", + "documentation":"

    Sort to use for elements in the Persons array. Use TIMESTAMP to sort array elements by the time persons are detected. Use INDEX to sort by the tracked persons. If you sort by INDEX, the array elements for each person are sorted by detection confidence. The default sort is by TIMESTAMP.

    " + } + } + }, + "GetPersonTrackingResponse":{ + "type":"structure", + "members":{ + "JobStatus":{ + "shape":"VideoJobStatus", + "documentation":"

    The current status of the person tracking job.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    If the job fails, StatusMessage provides a descriptive error message.

    " + }, + "VideoMetadata":{ + "shape":"VideoMetadata", + "documentation":"

    Information about a video that Amazon Rekognition Video analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of persons.

    " + }, + "Persons":{ + "shape":"PersonDetections", + "documentation":"

    An array of the persons detected in the video and the time(s) their path was tracked throughout the video. An array element will exist for each time a person's path is tracked.

    " + } + } + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

    ", + "exception":true + }, + "Image":{ + "type":"structure", + "members":{ + "Bytes":{ + "shape":"ImageBlob", + "documentation":"

    Blob of image bytes up to 5 MBs.

    " + }, + "S3Object":{ + "shape":"S3Object", + "documentation":"

    Identifies an S3 object as the image source.

    " + } + }, + "documentation":"

    Provides the input image either as bytes or an S3 object.

    You pass image bytes to an Amazon Rekognition API operation by using the Bytes property. For example, you would use the Bytes property to pass an image loaded from a local file system. Image bytes passed by using the Bytes property must be base64-encoded. Your code may not need to encode image bytes if you are using an AWS SDK to call Amazon Rekognition API operations.

    For more information, see Analyzing an Image Loaded from a Local File System in the Amazon Rekognition Developer Guide.

    You pass images stored in an S3 bucket to an Amazon Rekognition API operation by using the S3Object property. Images stored in an S3 bucket do not need to be base64-encoded.

    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

    If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes using the Bytes property is not supported. You must first upload the image to an Amazon S3 bucket and then call the operation using the S3Object property.

    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource Based Policies in the Amazon Rekognition Developer Guide.

    " + }, + "ImageBlob":{ + "type":"blob", + "max":5242880, + "min":1 + }, + "ImageId":{ + "type":"string", + "pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ImageQuality":{ + "type":"structure", + "members":{ + "Brightness":{ + "shape":"Float", + "documentation":"

    Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

    " + }, + "Sharpness":{ + "shape":"Float", + "documentation":"

    Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

    " + } + }, + "documentation":"

    Identifies face image brightness and sharpness.

    " + }, + "ImageTooLargeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The input image size exceeds the allowed limit. For more information, see Limits in Amazon Rekognition in the Amazon Rekognition Developer Guide.

    ", + "exception":true + }, + "IndexFacesRequest":{ + "type":"structure", + "required":[ + "CollectionId", + "Image" + ], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    The ID of an existing collection to which you want to add the faces that are detected in the input images.

    " + }, + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes isn't supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "ExternalImageId":{ + "shape":"ExternalImageId", + "documentation":"

    The ID you want to assign to all the faces detected in the image.

    " + }, + "DetectionAttributes":{ + "shape":"Attributes", + "documentation":"

    An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for Attributes or if you specify [\"DEFAULT\"], the API returns the following subset of facial attributes: BoundingBox, Confidence, Pose, Quality, and Landmarks. If you provide [\"ALL\"], all facial attributes are returned, but the operation takes longer to complete.

    If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND operator to determine which attributes to return (in this case, all attributes).

    " + }, + "MaxFaces":{ + "shape":"MaxFacesToIndex", + "documentation":"

    The maximum number of faces to index. The value of MaxFaces must be greater than or equal to 1. IndexFaces returns no more than 100 detected faces in an image, even if you specify a larger value for MaxFaces.

    If IndexFaces detects more faces than the value of MaxFaces, the faces with the lowest quality are filtered out first. If there are still more faces than the value of MaxFaces, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of MaxFaces). Information about the unindexed faces is available in the UnindexedFaces array.

    The faces that are returned by IndexFaces are sorted by the largest face bounding box size to the smallest size, in descending order.

    MaxFaces can be used with a collection associated with any version of the face model.

    " + }, + "QualityFilter":{ + "shape":"QualityFilter", + "documentation":"

    A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren't indexed. If you specify AUTO, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is AUTO.

    To use quality filtering, the collection you are using must be associated with version 3 of the face model.

    " + } + } + }, + "IndexFacesResponse":{ + "type":"structure", + "members":{ + "FaceRecords":{ + "shape":"FaceRecordList", + "documentation":"

    An array of faces detected and added to the collection. For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

    " + }, + "OrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.

    If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:

    • If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null.

    • If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.

    Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    The version number of the face detection model that's associated with the input collection (CollectionId).

    " + }, + "UnindexedFaces":{ + "shape":"UnindexedFaces", + "documentation":"

    An array of faces that were detected in the image but weren't indexed. They weren't indexed because the quality filter identified them as low quality, or the MaxFaces request parameter filtered them out. To use the quality filter, you specify the QualityFilter request parameter.

    " + } + } + }, + "Instance":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    The position of the label instance on the image.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    The confidence that Amazon Rekognition has in the accuracy of the bounding box.

    " + } + }, + "documentation":"

    An instance of a label returned by Amazon Rekognition Image (DetectLabels) or by Amazon Rekognition Video (GetLabelDetection).

    " + }, + "Instances":{ + "type":"list", + "member":{"shape":"Instance"} + }, + "InternalServerError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Rekognition experienced a service issue. Try your call again.

    ", + "exception":true, + "fault":true + }, + "InvalidImageFormatException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The provided image format is not supported.

    ", + "exception":true + }, + "InvalidPaginationTokenException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Pagination token in the request is not valid.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Input parameter violated a constraint. Validate your parameter before calling the API operation again.

    ", + "exception":true + }, + "InvalidS3ObjectException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Rekognition is unable to access the S3 object specified in the request.

    ", + "exception":true + }, + "JobId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "JobTag":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-:]+" + }, + "KinesisDataArn":{ + "type":"string", + "pattern":"(^arn:([a-z\\d-]+):kinesis:([a-z\\d-]+):\\d{12}:.+$)" + }, + "KinesisDataStream":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"KinesisDataArn", + "documentation":"

    ARN of the output Amazon Kinesis Data Streams stream.

    " + } + }, + "documentation":"

    The Kinesis data stream Amazon Rekognition to which the analysis results of a Amazon Rekognition stream processor are streamed. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

    " + }, + "KinesisVideoArn":{ + "type":"string", + "pattern":"(^arn:([a-z\\d-]+):kinesisvideo:([a-z\\d-]+):\\d{12}:.+$)" + }, + "KinesisVideoStream":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"KinesisVideoArn", + "documentation":"

    ARN of the Kinesis video stream stream that streams the source video.

    " + } + }, + "documentation":"

    Kinesis video stream stream that provides the source streaming video for a Amazon Rekognition Video stream processor. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

    " + }, + "Label":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name (label) of the object or scene.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence.

    " + }, + "Instances":{ + "shape":"Instances", + "documentation":"

    If Label represents an object, Instances contains the bounding boxes for each instance of the detected object. Bounding boxes are returned for common object labels such as people, cars, furniture, apparel or pets.

    " + }, + "Parents":{ + "shape":"Parents", + "documentation":"

    The parent labels for a label. The response includes all ancestor labels.

    " + } + }, + "documentation":"

    Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.

    " + }, + "LabelDetection":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    Time, in milliseconds from the start of the video, that the label was detected.

    " + }, + "Label":{ + "shape":"Label", + "documentation":"

    Details about the detected label.

    " + } + }, + "documentation":"

    Information about a label detected in a video analysis request and the time the label was detected in the video.

    " + }, + "LabelDetectionSortBy":{ + "type":"string", + "enum":[ + "NAME", + "TIMESTAMP" + ] + }, + "LabelDetections":{ + "type":"list", + "member":{"shape":"LabelDetection"} + }, + "Labels":{ + "type":"list", + "member":{"shape":"Label"} + }, + "Landmark":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"LandmarkType", + "documentation":"

    Type of landmark.

    " + }, + "X":{ + "shape":"Float", + "documentation":"

    The x-coordinate from the top left of the landmark expressed as the ratio of the width of the image. For example, if the image is 700 x 200 and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

    " + }, + "Y":{ + "shape":"Float", + "documentation":"

    The y-coordinate from the top left of the landmark expressed as the ratio of the height of the image. For example, if the image is 700 x 200 and the y-coordinate of the landmark is at 100 pixels, this value is 0.5.

    " + } + }, + "documentation":"

    Indicates the location of the landmark on the face.

    " + }, + "LandmarkType":{ + "type":"string", + "enum":[ + "eyeLeft", + "eyeRight", + "nose", + "mouthLeft", + "mouthRight", + "leftEyeBrowLeft", + "leftEyeBrowRight", + "leftEyeBrowUp", + "rightEyeBrowLeft", + "rightEyeBrowRight", + "rightEyeBrowUp", + "leftEyeLeft", + "leftEyeRight", + "leftEyeUp", + "leftEyeDown", + "rightEyeLeft", + "rightEyeRight", + "rightEyeUp", + "rightEyeDown", + "noseLeft", + "noseRight", + "mouthUp", + "mouthDown", + "leftPupil", + "rightPupil", + "upperJawlineLeft", + "midJawlineLeft", + "chinBottom", + "midJawlineRight", + "upperJawlineRight" + ] + }, + "Landmarks":{ + "type":"list", + "member":{"shape":"Landmark"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An Amazon Rekognition service limit was exceeded. For example, if you start too many Amazon Rekognition Video jobs concurrently, calls to start operations (StartLabelDetection, for example) will raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Rekognition service limit.

    ", + "exception":true + }, + "ListCollectionsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    Pagination token from the previous response.

    " + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

    Maximum number of collection IDs to return.

    " + } + } + }, + "ListCollectionsResponse":{ + "type":"structure", + "members":{ + "CollectionIds":{ + "shape":"CollectionIdList", + "documentation":"

    An array of collection IDs.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the result is truncated, the response provides a NextToken that you can use in the subsequent request to fetch the next set of collection IDs.

    " + }, + "FaceModelVersions":{ + "shape":"FaceModelVersionList", + "documentation":"

    Version numbers of the face detection models associated with the collections in the array CollectionIds. For example, the value of FaceModelVersions[2] is the version number for the face detection model used by the collection in CollectionId[2].

    " + } + } + }, + "ListFacesRequest":{ + "type":"structure", + "required":["CollectionId"], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID of the collection from which to list the faces.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

    " + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

    Maximum number of faces to return.

    " + } + } + }, + "ListFacesResponse":{ + "type":"structure", + "members":{ + "Faces":{ + "shape":"FaceList", + "documentation":"

    An array of Face objects.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the face detection model associated with the input collection (CollectionId).

    " + } + } + }, + "ListStreamProcessorsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000.

    " + } + } + }, + "ListStreamProcessorsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of stream processors.

    " + }, + "StreamProcessors":{ + "shape":"StreamProcessorList", + "documentation":"

    List of stream processors that you have created.

    " + } + } + }, + "MaxFaces":{ + "type":"integer", + "max":4096, + "min":1 + }, + "MaxFacesToIndex":{ + "type":"integer", + "min":1 + }, + "MaxResults":{ + "type":"integer", + "min":1 + }, + "ModerationLabel":{ + "type":"structure", + "members":{ + "Confidence":{ + "shape":"Percent", + "documentation":"

    Specifies the confidence that Amazon Rekognition has that the label has been correctly identified.

    If you don't specify the MinConfidence parameter in the call to DetectModerationLabels, the operation returns labels with a confidence value greater than or equal to 50 percent.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The label name for the type of unsafe content detected in the image.

    " + }, + "ParentName":{ + "shape":"String", + "documentation":"

    The name for the parent label. Labels at the top level of the hierarchy have the parent label \"\".

    " + } + }, + "documentation":"

    Provides information about a single type of unsafe content found in an image or video. Each type of moderated content has a label within a hierarchical taxonomy. For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.

    " + }, + "ModerationLabels":{ + "type":"list", + "member":{"shape":"ModerationLabel"} + }, + "MouthOpen":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the mouth on the face is open or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

    " + }, + "Mustache":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the face has mustache or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the face has a mustache, and the confidence level in the determination.

    " + }, + "NotificationChannel":{ + "type":"structure", + "required":[ + "SNSTopicArn", + "RoleArn" + ], + "members":{ + "SNSTopicArn":{ + "shape":"SNSTopicArn", + "documentation":"

    The Amazon SNS topic to which Amazon Rekognition to posts the completion status.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic.

    " + } + }, + "documentation":"

    The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status of a video analysis operation. For more information, see api-video.

    " + }, + "OrientationCorrection":{ + "type":"string", + "enum":[ + "ROTATE_0", + "ROTATE_90", + "ROTATE_180", + "ROTATE_270" + ] + }, + "PageSize":{ + "type":"integer", + "max":4096, + "min":0 + }, + "PaginationToken":{ + "type":"string", + "max":255 + }, + "Parent":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the parent label.

    " + } + }, + "documentation":"

    A parent label for a label. A label can have 0, 1, or more parents.

    " + }, + "Parents":{ + "type":"list", + "member":{"shape":"Parent"} + }, + "Percent":{ + "type":"float", + "max":100, + "min":0 + }, + "PersonDetail":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"PersonIndex", + "documentation":"

    Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.

    " + }, + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    Bounding box around the detected person.

    " + }, + "Face":{ + "shape":"FaceDetail", + "documentation":"

    Face details for the detected person.

    " + } + }, + "documentation":"

    Details about a person detected in a video analysis request.

    " + }, + "PersonDetection":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The time, in milliseconds from the start of the video, that the person's path was tracked.

    " + }, + "Person":{ + "shape":"PersonDetail", + "documentation":"

    Details about a person whose path was tracked in a video.

    " + } + }, + "documentation":"

    Details and path tracking information for a single time a person's path is tracked in a video. Amazon Rekognition operations that track people's paths return an array of PersonDetection objects with elements for each time a person's path is tracked in a video.

    For more information, see GetPersonTracking in the Amazon Rekognition Developer Guide.

    " + }, + "PersonDetections":{ + "type":"list", + "member":{"shape":"PersonDetection"} + }, + "PersonIndex":{"type":"long"}, + "PersonMatch":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The time, in milliseconds from the beginning of the video, that the person was matched in the video.

    " + }, + "Person":{ + "shape":"PersonDetail", + "documentation":"

    Information about the matched person.

    " + }, + "FaceMatches":{ + "shape":"FaceMatchList", + "documentation":"

    Information about the faces in the input collection that match the face of a person in the video.

    " + } + }, + "documentation":"

    Information about a person whose face matches a face(s) in an Amazon Rekognition collection. Includes information about the faces in the Amazon Rekognition collection (FaceMatch), information about the person (PersonDetail), and the time stamp for when the person was detected in a video. An array of PersonMatch objects is returned by GetFaceSearch.

    " + }, + "PersonMatches":{ + "type":"list", + "member":{"shape":"PersonMatch"} + }, + "PersonTrackingSortBy":{ + "type":"string", + "enum":[ + "INDEX", + "TIMESTAMP" + ] + }, + "Point":{ + "type":"structure", + "members":{ + "X":{ + "shape":"Float", + "documentation":"

    The value of the X coordinate for a point on a Polygon.

    " + }, + "Y":{ + "shape":"Float", + "documentation":"

    The value of the Y coordinate for a point on a Polygon.

    " + } + }, + "documentation":"

    The X and Y coordinates of a point on an image. The X and Y values returned are ratios of the overall image size. For example, if the input image is 700x200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the image.

    An array of Point objects, Polygon, is returned by DetectText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Rekognition Developer Guide.

    " + }, + "Polygon":{ + "type":"list", + "member":{"shape":"Point"} + }, + "Pose":{ + "type":"structure", + "members":{ + "Roll":{ + "shape":"Degree", + "documentation":"

    Value representing the face rotation on the roll axis.

    " + }, + "Yaw":{ + "shape":"Degree", + "documentation":"

    Value representing the face rotation on the yaw axis.

    " + }, + "Pitch":{ + "shape":"Degree", + "documentation":"

    Value representing the face rotation on the pitch axis.

    " + } + }, + "documentation":"

    Indicates the pose of the face as determined by its pitch, roll, and yaw.

    " + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.

    ", + "exception":true + }, + "QualityFilter":{ + "type":"string", + "enum":[ + "NONE", + "AUTO" + ] + }, + "Reason":{ + "type":"string", + "enum":[ + "EXCEEDS_MAX_FACES", + "EXTREME_POSE", + "LOW_BRIGHTNESS", + "LOW_SHARPNESS", + "LOW_CONFIDENCE", + "SMALL_BOUNDING_BOX" + ] + }, + "Reasons":{ + "type":"list", + "member":{"shape":"Reason"} + }, + "RecognizeCelebritiesRequest":{ + "type":"structure", + "required":["Image"], + "members":{ + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + } + } + }, + "RecognizeCelebritiesResponse":{ + "type":"structure", + "members":{ + "CelebrityFaces":{ + "shape":"CelebrityList", + "documentation":"

    Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 15 celebrities in an image.

    " + }, + "UnrecognizedFaces":{ + "shape":"ComparedFaceList", + "documentation":"

    Details about each unrecognized face in the image.

    " + }, + "OrientationCorrection":{ + "shape":"OrientationCorrection", + "documentation":"

    The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected.

    If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.

    " + } + } + }, + "RekognitionUniqueId":{ + "type":"string", + "pattern":"[0-9A-Za-z]*" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A collection with the specified ID already exists.

    ", + "exception":true + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The collection specified in the request cannot be found.

    ", + "exception":true + }, + "RoleArn":{ + "type":"string", + "pattern":"arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "S3Bucket":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[0-9A-Za-z\\.\\-_]*" + }, + "S3Object":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"S3Bucket", + "documentation":"

    Name of the S3 bucket.

    " + }, + "Name":{ + "shape":"S3ObjectName", + "documentation":"

    S3 object key name.

    " + }, + "Version":{ + "shape":"S3ObjectVersion", + "documentation":"

    If the bucket is versioning enabled, you can specify the object version.

    " + } + }, + "documentation":"

    Provides the S3 bucket name and object name.

    The region for the S3 bucket containing the S3 object must match the region you use for Amazon Rekognition operations.

    For Amazon Rekognition to process an S3 object, the user must have permission to access the S3 object. For more information, see Resource-Based Policies in the Amazon Rekognition Developer Guide.

    " + }, + "S3ObjectName":{ + "type":"string", + "max":1024, + "min":1 + }, + "S3ObjectVersion":{ + "type":"string", + "max":1024, + "min":1 + }, + "SNSTopicArn":{ + "type":"string", + "pattern":"(^arn:aws:sns:.*:\\w{12}:.+$)" + }, + "SearchFacesByImageRequest":{ + "type":"structure", + "required":[ + "CollectionId", + "Image" + ], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID of the collection to search.

    " + }, + "Image":{ + "shape":"Image", + "documentation":"

    The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

    If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

    " + }, + "MaxFaces":{ + "shape":"MaxFaces", + "documentation":"

    Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

    " + }, + "FaceMatchThreshold":{ + "shape":"Percent", + "documentation":"

    (Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

    " + } + } + }, + "SearchFacesByImageResponse":{ + "type":"structure", + "members":{ + "SearchedFaceBoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    The bounding box around the face in the input image that Amazon Rekognition used for the search.

    " + }, + "SearchedFaceConfidence":{ + "shape":"Percent", + "documentation":"

    The level of confidence that the searchedFaceBoundingBox, contains a face.

    " + }, + "FaceMatches":{ + "shape":"FaceMatchList", + "documentation":"

    An array of faces that match the input face, along with the confidence in the match.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the face detection model associated with the input collection (CollectionId).

    " + } + } + }, + "SearchFacesRequest":{ + "type":"structure", + "required":[ + "CollectionId", + "FaceId" + ], + "members":{ + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID of the collection the face belongs to.

    " + }, + "FaceId":{ + "shape":"FaceId", + "documentation":"

    ID of a face to find matches for in the collection.

    " + }, + "MaxFaces":{ + "shape":"MaxFaces", + "documentation":"

    Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

    " + }, + "FaceMatchThreshold":{ + "shape":"Percent", + "documentation":"

    Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

    " + } + } + }, + "SearchFacesResponse":{ + "type":"structure", + "members":{ + "SearchedFaceId":{ + "shape":"FaceId", + "documentation":"

    ID of the face that was searched for matches in a collection.

    " + }, + "FaceMatches":{ + "shape":"FaceMatchList", + "documentation":"

    An array of faces that matched the input face, along with the confidence in the match.

    " + }, + "FaceModelVersion":{ + "shape":"String", + "documentation":"

    Version number of the face detection model associated with the input collection (CollectionId).

    " + } + } + }, + "Smile":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the face is smiling or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the face is smiling, and the confidence level in the determination.

    " + }, + "StartCelebrityRecognitionRequest":{ + "type":"structure", + "required":["Video"], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartCelebrityRecognition requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the celebrity recognition analysis to.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartCelebrityRecognitionResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the celebrity recognition analysis job. Use JobId to identify the job in a subsequent call to GetCelebrityRecognition.

    " + } + } + }, + "StartContentModerationRequest":{ + "type":"structure", + "required":["Video"], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.

    " + }, + "MinConfidence":{ + "shape":"Percent", + "documentation":"

    Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify MinConfidence, GetContentModeration returns labels with confidence values greater than or equal to 50 percent.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartContentModeration requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN that you want Amazon Rekognition Video to publish the completion status of the unsafe content analysis to.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartContentModerationResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the unsafe content analysis job. Use JobId to identify the job in a subsequent call to GetContentModeration.

    " + } + } + }, + "StartFaceDetectionRequest":{ + "type":"structure", + "required":["Video"], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the face detection operation.

    " + }, + "FaceAttributes":{ + "shape":"FaceAttributes", + "documentation":"

    The face attributes you want returned.

    DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

    ALL - All facial attributes are returned.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartFaceDetectionResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the face detection job. Use JobId to identify the job in a subsequent call to GetFaceDetection.

    " + } + } + }, + "StartFaceSearchRequest":{ + "type":"structure", + "required":[ + "Video", + "CollectionId" + ], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video you want to search. The video must be stored in an Amazon S3 bucket.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartFaceSearch requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "FaceMatchThreshold":{ + "shape":"Percent", + "documentation":"

    The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

    " + }, + "CollectionId":{ + "shape":"CollectionId", + "documentation":"

    ID of the collection that contains the faces you want to search for.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartFaceSearchResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the search job. Use JobId to identify the job in a subsequent call to GetFaceSearch.

    " + } + } + }, + "StartLabelDetectionRequest":{ + "type":"structure", + "required":["Video"], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "MinConfidence":{ + "shape":"Percent", + "documentation":"

    Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

    If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartLabelDetectionResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the label detection job. Use JobId to identify the job in a subsequent call to GetLabelDetection.

    " + } + } + }, + "StartPersonTrackingRequest":{ + "type":"structure", + "required":["Video"], + "members":{ + "Video":{ + "shape":"Video", + "documentation":"

    The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Idempotent token used to identify the start request. If you use the same token with multiple StartPersonTracking requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the people detection operation to.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

    " + } + } + }, + "StartPersonTrackingResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the person detection job. Use JobId to identify the job in a subsequent call to GetPersonTracking.

    " + } + } + }, + "StartStreamProcessorRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    The name of the stream processor to start processing.

    " + } + } + }, + "StartStreamProcessorResponse":{ + "type":"structure", + "members":{ + } + }, + "StatusMessage":{"type":"string"}, + "StopStreamProcessorRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    The name of a stream processor created by CreateStreamProcessor.

    " + } + } + }, + "StopStreamProcessorResponse":{ + "type":"structure", + "members":{ + } + }, + "StreamProcessor":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StreamProcessorName", + "documentation":"

    Name of the Amazon Rekognition stream processor.

    " + }, + "Status":{ + "shape":"StreamProcessorStatus", + "documentation":"

    Current status of the Amazon Rekognition stream processor.

    " + } + }, + "documentation":"

    An object that recognizes faces in a streaming video. An Amazon Rekognition stream processor is created by a call to CreateStreamProcessor. The request parameters for CreateStreamProcessor describe the Kinesis video stream source for the streaming video, face recognition parameters, and where to stream the analysis resullts.

    " + }, + "StreamProcessorArn":{ + "type":"string", + "pattern":"(^arn:[a-z\\d-]+:rekognition:[a-z\\d-]+:\\d{12}:streamprocessor\\/.+$)" + }, + "StreamProcessorInput":{ + "type":"structure", + "members":{ + "KinesisVideoStream":{ + "shape":"KinesisVideoStream", + "documentation":"

    The Kinesis video stream input stream for the source streaming video.

    " + } + }, + "documentation":"

    Information about the source streaming video.

    " + }, + "StreamProcessorList":{ + "type":"list", + "member":{"shape":"StreamProcessor"} + }, + "StreamProcessorName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-]+" + }, + "StreamProcessorOutput":{ + "type":"structure", + "members":{ + "KinesisDataStream":{ + "shape":"KinesisDataStream", + "documentation":"

    The Amazon Kinesis Data Streams stream to which the Amazon Rekognition stream processor streams the analysis results.

    " + } + }, + "documentation":"

    Information about the Amazon Kinesis Data Streams stream to which a Amazon Rekognition Video stream processor streams the results of a video analysis. For more information, see CreateStreamProcessor in the Amazon Rekognition Developer Guide.

    " + }, + "StreamProcessorSettings":{ + "type":"structure", + "members":{ + "FaceSearch":{ + "shape":"FaceSearchSettings", + "documentation":"

    Face search settings to use on a streaming video.

    " + } + }, + "documentation":"

    Input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

    " + }, + "StreamProcessorStatus":{ + "type":"string", + "enum":[ + "STOPPED", + "STARTING", + "RUNNING", + "FAILED", + "STOPPING" + ] + }, + "String":{"type":"string"}, + "Sunglasses":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Boolean", + "documentation":"

    Boolean value that indicates whether the face is wearing sunglasses or not.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    Level of confidence in the determination.

    " + } + }, + "documentation":"

    Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

    " + }, + "TextDetection":{ + "type":"structure", + "members":{ + "DetectedText":{ + "shape":"String", + "documentation":"

    The word or line of text recognized by Amazon Rekognition.

    " + }, + "Type":{ + "shape":"TextTypes", + "documentation":"

    The type of text that was detected.

    " + }, + "Id":{ + "shape":"UInteger", + "documentation":"

    The identifier for the detected text. The identifier is only unique for a single call to DetectText.

    " + }, + "ParentId":{ + "shape":"UInteger", + "documentation":"

    The Parent identifier for the detected text identified by the value of ID. If the type of detected text is LINE, the value of ParentId is Null.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    The confidence that Amazon Rekognition has in the accuracy of the detected text and the accuracy of the geometry points around the detected text.

    " + }, + "Geometry":{ + "shape":"Geometry", + "documentation":"

    The location of the detected text on the image. Includes an axis aligned coarse bounding box surrounding the text and a finer grain polygon for more accurate spatial information.

    " + } + }, + "documentation":"

    Information about a word or line of text detected by DetectText.

    The DetectedText field contains the text that Amazon Rekognition detected in the image.

    Every word and line has an identifier (Id). Each word belongs to a line and has a parent identifier (ParentId) that identifies the line of text in which the word appears. The word Id is also an index for the word within a line of words.

    For more information, see Detecting Text in the Amazon Rekognition Developer Guide.

    " + }, + "TextDetectionList":{ + "type":"list", + "member":{"shape":"TextDetection"} + }, + "TextTypes":{ + "type":"string", + "enum":[ + "LINE", + "WORD" + ] + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Rekognition is temporarily unable to process the request. Try your call again.

    ", + "exception":true, + "fault":true + }, + "Timestamp":{"type":"long"}, + "UInteger":{ + "type":"integer", + "min":0 + }, + "ULong":{ + "type":"long", + "min":0 + }, + "UnindexedFace":{ + "type":"structure", + "members":{ + "Reasons":{ + "shape":"Reasons", + "documentation":"

    An array of reasons that specify why a face wasn't indexed.

    • EXTREME_POSE - The face is at a pose that can't be detected. For example, the head is turned too far away from the camera.

    • EXCEEDS_MAX_FACES - The number of faces detected is already higher than that specified by the MaxFaces input parameter for IndexFaces.

    • LOW_BRIGHTNESS - The image is too dark.

    • LOW_SHARPNESS - The image is too blurry.

    • LOW_CONFIDENCE - The face was detected with a low confidence.

    • SMALL_BOUNDING_BOX - The bounding box around the face is too small.

    " + }, + "FaceDetail":{ + "shape":"FaceDetail", + "documentation":"

    The structure that contains attributes of a face that IndexFacesdetected, but didn't index.

    " + } + }, + "documentation":"

    A face that IndexFaces detected, but didn't index. Use the Reasons response attribute to determine why a face wasn't indexed.

    " + }, + "UnindexedFaces":{ + "type":"list", + "member":{"shape":"UnindexedFace"} + }, + "Url":{"type":"string"}, + "Urls":{ + "type":"list", + "member":{"shape":"Url"} + }, + "Video":{ + "type":"structure", + "members":{ + "S3Object":{ + "shape":"S3Object", + "documentation":"

    The Amazon S3 bucket name and file name for the video.

    " + } + }, + "documentation":"

    Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

    " + }, + "VideoJobStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED" + ] + }, + "VideoMetadata":{ + "type":"structure", + "members":{ + "Codec":{ + "shape":"String", + "documentation":"

    Type of compression used in the analyzed video.

    " + }, + "DurationMillis":{ + "shape":"ULong", + "documentation":"

    Length of the video in milliseconds.

    " + }, + "Format":{ + "shape":"String", + "documentation":"

    Format of the analyzed video. Possible values are MP4, MOV and AVI.

    " + }, + "FrameRate":{ + "shape":"Float", + "documentation":"

    Number of frames per second in the video.

    " + }, + "FrameHeight":{ + "shape":"ULong", + "documentation":"

    Vertical pixel dimension of the video.

    " + }, + "FrameWidth":{ + "shape":"ULong", + "documentation":"

    Horizontal pixel dimension of the video.

    " + } + }, + "documentation":"

    Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition video operation.

    " + }, + "VideoTooLargeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The file size or duration of the supplied media is too large. The maximum file size is 8GB. The maximum duration is 2 hours.

    ", + "exception":true + } + }, + "documentation":"

    This is the Amazon Rekognition API reference.

    " +} diff --git a/aws/dist/botocore/data/resource-groups/2017-11-27/paginators-1.json b/aws/dist/botocore/data/resource-groups/2017-11-27/paginators-1.json new file mode 100644 index 00000000..a0ddf9b4 --- /dev/null +++ b/aws/dist/botocore/data/resource-groups/2017-11-27/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListGroups": { + "result_key": "Groups", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "SearchResources": { + "result_key": "ResourceIdentifiers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroupResources": { + "result_key": "ResourceIdentifiers", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/resource-groups/2017-11-27/service-2.json b/aws/dist/botocore/data/resource-groups/2017-11-27/service-2.json new file mode 100644 index 00000000..cded5101 --- /dev/null +++ b/aws/dist/botocore/data/resource-groups/2017-11-27/service-2.json @@ -0,0 +1,941 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-11-27", + "endpointPrefix":"resource-groups", + "protocol":"rest-json", + "serviceAbbreviation":"Resource Groups", + "serviceFullName":"AWS Resource Groups", + "serviceId":"Resource Groups", + "signatureVersion":"v4", + "signingName":"resource-groups", + "uid":"resource-groups-2017-11-27" + }, + "operations":{ + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/groups" + }, + "input":{"shape":"CreateGroupInput"}, + "output":{"shape":"CreateGroupOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Creates a group with a specified name, description, and resource query.

    " + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"DELETE", + "requestUri":"/groups/{GroupName}" + }, + "input":{"shape":"DeleteGroupInput"}, + "output":{"shape":"DeleteGroupOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Deletes a specified resource group. Deleting a resource group does not delete resources that are members of the group; it only deletes the group structure.

    " + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"GET", + "requestUri":"/groups/{GroupName}" + }, + "input":{"shape":"GetGroupInput"}, + "output":{"shape":"GetGroupOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns information about a specified resource group.

    " + }, + "GetGroupQuery":{ + "name":"GetGroupQuery", + "http":{ + "method":"GET", + "requestUri":"/groups/{GroupName}/query" + }, + "input":{"shape":"GetGroupQueryInput"}, + "output":{"shape":"GetGroupQueryOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns the resource query associated with the specified resource group.

    " + }, + "GetTags":{ + "name":"GetTags", + "http":{ + "method":"GET", + "requestUri":"/resources/{Arn}/tags" + }, + "input":{"shape":"GetTagsInput"}, + "output":{"shape":"GetTagsOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns a list of tags that are associated with a resource group, specified by an ARN.

    " + }, + "ListGroupResources":{ + "name":"ListGroupResources", + "http":{ + "method":"POST", + "requestUri":"/groups/{GroupName}/resource-identifiers-list" + }, + "input":{"shape":"ListGroupResourcesInput"}, + "output":{"shape":"ListGroupResourcesOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns a list of ARNs of resources that are members of a specified resource group.

    " + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/groups-list" + }, + "input":{"shape":"ListGroupsInput"}, + "output":{"shape":"ListGroupsOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns a list of existing resource groups in your account.

    " + }, + "SearchResources":{ + "name":"SearchResources", + "http":{ + "method":"POST", + "requestUri":"/resources/search" + }, + "input":{"shape":"SearchResourcesInput"}, + "output":{"shape":"SearchResourcesOutput"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Returns a list of AWS resource identifiers that matches a specified query. The query uses the same format as a resource query in a CreateGroup or UpdateGroupQuery operation.

    " + }, + "Tag":{ + "name":"Tag", + "http":{ + "method":"PUT", + "requestUri":"/resources/{Arn}/tags" + }, + "input":{"shape":"TagInput"}, + "output":{"shape":"TagOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Adds tags to a resource group with the specified ARN. Existing tags on a resource group are not changed if they are not specified in the request parameters.

    " + }, + "Untag":{ + "name":"Untag", + "http":{ + "method":"PATCH", + "requestUri":"/resources/{Arn}/tags" + }, + "input":{"shape":"UntagInput"}, + "output":{"shape":"UntagOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Deletes specified tags from a specified resource.

    " + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"PUT", + "requestUri":"/groups/{GroupName}" + }, + "input":{"shape":"UpdateGroupInput"}, + "output":{"shape":"UpdateGroupOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Updates an existing group with a new or changed description. You cannot update the name of a resource group.

    " + }, + "UpdateGroupQuery":{ + "name":"UpdateGroupQuery", + "http":{ + "method":"PUT", + "requestUri":"/groups/{GroupName}/query" + }, + "input":{"shape":"UpdateGroupQueryInput"}, + "output":{"shape":"UpdateGroupQueryOutput"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"ForbiddenException"}, + {"shape":"NotFoundException"}, + {"shape":"MethodNotAllowedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerErrorException"} + ], + "documentation":"

    Updates the resource query of a group.

    " + } + }, + "shapes":{ + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request does not comply with validation rules that are defined for the request parameters.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateGroupInput":{ + "type":"structure", + "required":[ + "Name", + "ResourceQuery" + ], + "members":{ + "Name":{ + "shape":"GroupName", + "documentation":"

    The name of the group, which is the identifier of the group in other operations. A resource group name cannot be updated after it is created. A resource group name can have a maximum of 128 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with AWS or aws; these are reserved. A resource group name must be unique within your account.

    " + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.

    " + }, + "ResourceQuery":{ + "shape":"ResourceQuery", + "documentation":"

    The resource query that determines which AWS resources are members of this group.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags to add to the group. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    " + } + } + }, + "CreateGroupOutput":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    A full description of the resource group after it is created.

    " + }, + "ResourceQuery":{ + "shape":"ResourceQuery", + "documentation":"

    The resource query associated with the group.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags associated with the group.

    " + } + } + }, + "DeleteGroupInput":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group to delete.

    ", + "location":"uri", + "locationName":"GroupName" + } + } + }, + "DeleteGroupOutput":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    A full description of the deleted resource group.

    " + } + } + }, + "ErrorMessage":{ + "type":"string", + "max":1024, + "min":1 + }, + "ForbiddenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The caller is not authorized to make the request.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "GetGroupInput":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group.

    ", + "location":"uri", + "locationName":"GroupName" + } + } + }, + "GetGroupOutput":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    A full description of the resource group.

    " + } + } + }, + "GetGroupQueryInput":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group.

    ", + "location":"uri", + "locationName":"GroupName" + } + } + }, + "GetGroupQueryOutput":{ + "type":"structure", + "members":{ + "GroupQuery":{ + "shape":"GroupQuery", + "documentation":"

    The resource query associated with the specified group.

    " + } + } + }, + "GetTagsInput":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the resource group for which you want a list of tags. The resource must exist within the account you are using.

    ", + "location":"uri", + "locationName":"Arn" + } + } + }, + "GetTagsOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the tagged resource group.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags associated with the specified resource group.

    " + } + } + }, + "Group":{ + "type":"structure", + "required":[ + "GroupArn", + "Name" + ], + "members":{ + "GroupArn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of a resource group.

    " + }, + "Name":{ + "shape":"GroupName", + "documentation":"

    The name of a resource group.

    " + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    The description of the resource group.

    " + } + }, + "documentation":"

    A resource group.

    " + }, + "GroupArn":{ + "type":"string", + "max":1600, + "min":12, + "pattern":"arn:aws(-[a-z]+)*:resource-groups:[a-z]{2}-[a-z]+-\\d{1}:[0-9]{12}:group/[a-zA-Z0-9_\\.-]{1,128}" + }, + "GroupDescription":{ + "type":"string", + "max":512, + "pattern":"[\\sa-zA-Z0-9_\\.-]*" + }, + "GroupFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"GroupFilterName", + "documentation":"

    The name of the filter. Filter names are case-sensitive.

    " + }, + "Values":{ + "shape":"GroupFilterValues", + "documentation":"

    One or more filter values. Allowed filter values vary by group filter name, and are case-sensitive.

    " + } + }, + "documentation":"

    A filter name and value pair that is used to obtain more specific results from a list of groups.

    " + }, + "GroupFilterList":{ + "type":"list", + "member":{"shape":"GroupFilter"} + }, + "GroupFilterName":{ + "type":"string", + "enum":["resource-type"] + }, + "GroupFilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"AWS::(AllSupported|[a-zA-Z0-9]+::[a-zA-Z0-9]+)" + }, + "GroupFilterValues":{ + "type":"list", + "member":{"shape":"GroupFilterValue"}, + "max":5, + "min":1 + }, + "GroupIdentifier":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of a resource group.

    " + }, + "GroupArn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of a resource group.

    " + } + }, + "documentation":"

    The ARN and group name of a group.

    " + }, + "GroupIdentifierList":{ + "type":"list", + "member":{"shape":"GroupIdentifier"} + }, + "GroupList":{ + "type":"list", + "member":{"shape":"Group"} + }, + "GroupName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9_\\.-]+" + }, + "GroupQuery":{ + "type":"structure", + "required":[ + "GroupName", + "ResourceQuery" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of a resource group that is associated with a specific resource query.

    " + }, + "ResourceQuery":{ + "shape":"ResourceQuery", + "documentation":"

    The resource query which determines which AWS resources are members of the associated resource group.

    " + } + }, + "documentation":"

    The underlying resource query of a resource group. Resources that match query results are part of the group.

    " + }, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    An internal error occurred while processing the request.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "ListGroupResourcesInput":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "Filters":{ + "shape":"ResourceFilterList", + "documentation":"

    Filters, formatted as ResourceFilter objects, that you want to apply to a ListGroupResources operation.

    • resource-type - Filter resources by their type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of group member ARNs that are returned in a single call by ListGroupResources, in paginated output. By default, this number is 50.

    ", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value that is returned in a paginated ListGroupResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

    ", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListGroupResourcesOutput":{ + "type":"structure", + "members":{ + "ResourceIdentifiers":{ + "shape":"ResourceIdentifierList", + "documentation":"

    The ARNs and resource types of resources that are members of the group that you specified.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value to include in a subsequent ListGroupResources request, to get more results.

    " + }, + "QueryErrors":{ + "shape":"QueryErrorList", + "documentation":"

    A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

    " + } + } + }, + "ListGroupsInput":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"GroupFilterList", + "documentation":"

    Filters, formatted as GroupFilter objects, that you want to apply to a ListGroups operation.

    • resource-type - Filter groups by resource type. Specify up to five resource types in the format AWS::ServiceCode::ResourceType. For example, AWS::EC2::Instance, or AWS::S3::Bucket.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of resource group results that are returned by ListGroups in paginated output. By default, this number is 50.

    ", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value that is returned in a paginated ListGroups request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

    ", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListGroupsOutput":{ + "type":"structure", + "members":{ + "GroupIdentifiers":{ + "shape":"GroupIdentifierList", + "documentation":"

    A list of GroupIdentifier objects. Each identifier is an object that contains both the GroupName and the GroupArn.

    " + }, + "Groups":{ + "shape":"GroupList", + "documentation":"

    A list of resource groups.

    ", + "deprecated":true, + "deprecatedMessage":"This field is deprecated, use GroupIdentifiers instead." + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value to include in a subsequent ListGroups request, to get more results.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MethodNotAllowedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request uses an HTTP method which is not allowed for the specified resource.

    ", + "error":{"httpStatusCode":405}, + "exception":true + }, + "NextToken":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"^[a-zA-Z0-9+/]*={0,2}$" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    One or more resources specified in the request do not exist.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Query":{ + "type":"string", + "max":4096, + "pattern":"[\\s\\S]*" + }, + "QueryError":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"QueryErrorCode", + "documentation":"

    Possible values are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

    " + }, + "Message":{ + "shape":"QueryErrorMessage", + "documentation":"

    A message that explains the ErrorCode value. Messages might state that the specified CloudFormation stack does not exist (or no longer exists). For CLOUDFORMATION_STACK_INACTIVE, the message typically states that the CloudFormation stack has a status that is not (or no longer) active, such as CREATE_FAILED.

    " + } + }, + "documentation":"

    A two-part error structure that can occur in ListGroupResources or SearchResources operations on CloudFormation stack-based queries. The error occurs if the CloudFormation stack on which the query is based either does not exist, or has a status that renders the stack inactive. A QueryError occurrence does not necessarily mean that AWS Resource Groups could not complete the operation, but the resulting group might have no member resources.

    " + }, + "QueryErrorCode":{ + "type":"string", + "enum":[ + "CLOUDFORMATION_STACK_INACTIVE", + "CLOUDFORMATION_STACK_NOT_EXISTING" + ] + }, + "QueryErrorList":{ + "type":"list", + "member":{"shape":"QueryError"} + }, + "QueryErrorMessage":{"type":"string"}, + "QueryType":{ + "type":"string", + "enum":[ + "TAG_FILTERS_1_0", + "CLOUDFORMATION_STACK_1_0" + ], + "max":128, + "min":1, + "pattern":"^\\w+$" + }, + "ResourceArn":{ + "type":"string", + "pattern":"arn:aws(-[a-z]+)*:[a-z0-9\\-]*:([a-z]{2}-[a-z]+-\\d{1})?:([0-9]{12})?:.+" + }, + "ResourceFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ResourceFilterName", + "documentation":"

    The name of the filter. Filter names are case-sensitive.

    " + }, + "Values":{ + "shape":"ResourceFilterValues", + "documentation":"

    One or more filter values. Allowed filter values vary by resource filter name, and are case-sensitive.

    " + } + }, + "documentation":"

    A filter name and value pair that is used to obtain more specific results from a list of resources.

    " + }, + "ResourceFilterList":{ + "type":"list", + "member":{"shape":"ResourceFilter"} + }, + "ResourceFilterName":{ + "type":"string", + "enum":["resource-type"] + }, + "ResourceFilterValue":{ + "type":"string", + "max":128, + "min":1, + "pattern":"AWS::[a-zA-Z0-9]+::[a-zA-Z0-9]+" + }, + "ResourceFilterValues":{ + "type":"list", + "member":{"shape":"ResourceFilterValue"}, + "max":5, + "min":1 + }, + "ResourceIdentifier":{ + "type":"structure", + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN of a resource.

    " + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The resource type of a resource, such as AWS::EC2::Instance.

    " + } + }, + "documentation":"

    The ARN of a resource, and its resource type.

    " + }, + "ResourceIdentifierList":{ + "type":"list", + "member":{"shape":"ResourceIdentifier"} + }, + "ResourceQuery":{ + "type":"structure", + "required":[ + "Type", + "Query" + ], + "members":{ + "Type":{ + "shape":"QueryType", + "documentation":"

    The type of the query. The valid values in this release are TAG_FILTERS_1_0 and CLOUDFORMATION_STACK_1_0.

    TAG_FILTERS_1_0: A JSON syntax that lets you specify a collection of simple tag filters for resource types and tags, as supported by the AWS Tagging API GetResources operation. If you specify more than one tag key, only resources that match all tag keys, and at least one value of each specified tag key, are returned in your query. If you specify more than one value for a tag key, a resource matches the filter if it has a tag key value that matches any of the specified values.

    For example, consider the following sample query for resources that have two tags, Stage and Version, with two values each. ([{\"Key\":\"Stage\",\"Values\":[\"Test\",\"Deploy\"]},{\"Key\":\"Version\",\"Values\":[\"1\",\"2\"]}]) The results of this query might include the following.

    • An EC2 instance that has the following two tags: {\"Key\":\"Stage\",\"Value\":\"Deploy\"}, and {\"Key\":\"Version\",\"Value\":\"2\"}

    • An S3 bucket that has the following two tags: {\"Key\":\"Stage\",\"Value\":\"Test\"}, and {\"Key\":\"Version\",\"Value\":\"1\"}

    The query would not return the following results, however. The following EC2 instance does not have all tag keys specified in the filter, so it is rejected. The RDS database has all of the tag keys, but no values that match at least one of the specified tag key values in the filter.

    • An EC2 instance that has only the following tag: {\"Key\":\"Stage\",\"Value\":\"Deploy\"}.

    • An RDS database that has the following two tags: {\"Key\":\"Stage\",\"Value\":\"Archived\"}, and {\"Key\":\"Version\",\"Value\":\"4\"}

    CLOUDFORMATION_STACK_1_0: A JSON syntax that lets you specify a CloudFormation stack ARN.

    " + }, + "Query":{ + "shape":"Query", + "documentation":"

    The query that defines a group or a search.

    " + } + }, + "documentation":"

    The query that is used to define a resource group or a search for resources.

    " + }, + "ResourceType":{ + "type":"string", + "pattern":"AWS::[a-zA-Z0-9]+::\\w+" + }, + "SearchResourcesInput":{ + "type":"structure", + "required":["ResourceQuery"], + "members":{ + "ResourceQuery":{ + "shape":"ResourceQuery", + "documentation":"

    The search query, using the same formats that are supported for resource group definition.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of group member ARNs returned by SearchResources in paginated output. By default, this number is 50.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value that is returned in a paginated SearchResources request. To get the next page of results, run the call again, add the NextToken parameter, and specify the NextToken value.

    " + } + } + }, + "SearchResourcesOutput":{ + "type":"structure", + "members":{ + "ResourceIdentifiers":{ + "shape":"ResourceIdentifierList", + "documentation":"

    The ARNs and resource types of resources that are members of the group that you specified.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The NextToken value to include in a subsequent SearchResources request, to get more results.

    " + }, + "QueryErrors":{ + "shape":"QueryErrorList", + "documentation":"

    A list of QueryError objects. Each error is an object that contains ErrorCode and Message structures. Possible values for ErrorCode are CLOUDFORMATION_STACK_INACTIVE and CLOUDFORMATION_STACK_NOT_EXISTING.

    " + } + } + }, + "TagInput":{ + "type":"structure", + "required":[ + "Arn", + "Tags" + ], + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the resource to which to add tags.

    ", + "location":"uri", + "locationName":"Arn" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags to add to the specified resource. A tag is a string-to-string map of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

    " + } + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the tagged resource.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags that have been added to the specified resource.

    " + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The caller has exceeded throttling limits.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request has not been applied because it lacks valid authentication credentials for the target resource.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "UntagInput":{ + "type":"structure", + "required":[ + "Arn", + "Keys" + ], + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the resource from which to remove tags.

    ", + "location":"uri", + "locationName":"Arn" + }, + "Keys":{ + "shape":"TagKeyList", + "documentation":"

    The keys of the tags to be removed.

    " + } + } + }, + "UntagOutput":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"GroupArn", + "documentation":"

    The ARN of the resource from which tags have been removed.

    " + }, + "Keys":{ + "shape":"TagKeyList", + "documentation":"

    The keys of tags that have been removed.

    " + } + } + }, + "UpdateGroupInput":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group for which you want to update its description.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "Description":{ + "shape":"GroupDescription", + "documentation":"

    The description of the resource group. Descriptions can have a maximum of 511 characters, including letters, numbers, hyphens, underscores, punctuation, and spaces.

    " + } + } + }, + "UpdateGroupOutput":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The full description of the resource group after it has been updated.

    " + } + } + }, + "UpdateGroupQueryInput":{ + "type":"structure", + "required":[ + "GroupName", + "ResourceQuery" + ], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of the resource group for which you want to edit the query.

    ", + "location":"uri", + "locationName":"GroupName" + }, + "ResourceQuery":{ + "shape":"ResourceQuery", + "documentation":"

    The resource query that determines which AWS resources are members of the resource group.

    " + } + } + }, + "UpdateGroupQueryOutput":{ + "type":"structure", + "members":{ + "GroupQuery":{ + "shape":"GroupQuery", + "documentation":"

    The resource query associated with the resource group after the update.

    " + } + } + } + }, + "documentation":"AWS Resource Groups

    AWS Resource Groups lets you organize AWS resources such as Amazon EC2 instances, Amazon Relational Database Service databases, and Amazon S3 buckets into groups using criteria that you define as tags. A resource group is a collection of resources that match the resource types specified in a query, and share one or more tags or portions of tags. You can create a group of resources based on their roles in your cloud infrastructure, lifecycle stages, regions, application layers, or virtually any criteria. Resource groups enable you to automate management tasks, such as those in AWS Systems Manager Automation documents, on tag-related resources in AWS Systems Manager. Groups of tagged resources also let you quickly view a custom console in AWS Systems Manager that shows AWS Config compliance and other monitoring data about member resources.

    To create a resource group, build a resource query, and specify tags that identify the criteria that members of the group have in common. Tags are key-value pairs.

    For more information about Resource Groups, see the AWS Resource Groups User Guide.

    AWS Resource Groups uses a REST-compliant API that you can use to perform the following types of operations.

    • Create, Read, Update, and Delete (CRUD) operations on resource groups and resource query entities

    • Applying, editing, and removing tags from resource groups

    • Resolving resource group member ARNs so they can be returned as search results

    • Getting data about resources that are members of a group

    • Searching AWS resources based on a resource query

    " +} diff --git a/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/paginators-1.json b/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/paginators-1.json new file mode 100644 index 00000000..7c8ba892 --- /dev/null +++ b/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/paginators-1.json @@ -0,0 +1,20 @@ +{ + "pagination": { + "GetResources": { + "input_token": "PaginationToken", + "limit_key": "ResourcesPerPage", + "output_token": "PaginationToken", + "result_key": "ResourceTagMappingList" + }, + "GetTagKeys": { + "input_token": "PaginationToken", + "output_token": "PaginationToken", + "result_key": "TagKeys" + }, + "GetTagValues": { + "input_token": "PaginationToken", + "output_token": "PaginationToken", + "result_key": "TagValues" + } + } +} diff --git a/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json b/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json new file mode 100644 index 00000000..c8fe14c8 --- /dev/null +++ b/aws/dist/botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json @@ -0,0 +1,430 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-01-26", + "endpointPrefix":"tagging", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Resource Groups Tagging API", + "serviceId":"Resource Groups Tagging API", + "signatureVersion":"v4", + "targetPrefix":"ResourceGroupsTaggingAPI_20170126", + "uid":"resourcegroupstaggingapi-2017-01-26" + }, + "operations":{ + "GetResources":{ + "name":"GetResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcesInput"}, + "output":{"shape":"GetResourcesOutput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalServiceException"}, + {"shape":"PaginationTokenExpiredException"} + ], + "documentation":"

    Returns all the tagged or previously tagged resources that are located in the specified region for the AWS account. You can optionally specify filters (tags and resource types) in your request, depending on what information you want returned. The response includes all tags that are associated with the requested resources.

    You can check the PaginationToken response parameter to determine if a query completed. Queries can occasionally return fewer results on a page than allowed. The PaginationToken response parameter value is null only when there are no more results to display.

    " + }, + "GetTagKeys":{ + "name":"GetTagKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTagKeysInput"}, + "output":{"shape":"GetTagKeysOutput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalServiceException"}, + {"shape":"PaginationTokenExpiredException"} + ], + "documentation":"

    Returns all tag keys in the specified region for the AWS account.

    " + }, + "GetTagValues":{ + "name":"GetTagValues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTagValuesInput"}, + "output":{"shape":"GetTagValuesOutput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalServiceException"}, + {"shape":"PaginationTokenExpiredException"} + ], + "documentation":"

    Returns all tag values for the specified key in the specified region for the AWS account.

    " + }, + "TagResources":{ + "name":"TagResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourcesInput"}, + "output":{"shape":"TagResourcesOutput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Applies one or more tags to the specified resources. Note the following:

    • Not all resources can have tags. For a list of resources that support tagging, see Supported Resources in the AWS Resource Groups User Guide.

    • Each resource can have up to 50 tags. For other limits, see Tag Restrictions in the Amazon EC2 User Guide for Linux Instances.

    • You can only tag resources that are located in the specified region for the AWS account.

    • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups User Guide.

    " + }, + "UntagResources":{ + "name":"UntagResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourcesInput"}, + "output":{"shape":"UntagResourcesOutput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Removes the specified tags from the specified resources. When you specify a tag key, the action removes both that key and its associated value. The operation succeeds even if you attempt to remove tags from a resource that were already removed. Note the following:

    • To remove tags from a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for removing tags. For more information, see Obtaining Permissions for Tagging in the AWS Resource Groups User Guide.

    • You can only tag resources that are located in the specified region for the AWS account.

    " + } + }, + "shapes":{ + "AmazonResourceType":{ + "type":"string", + "max":256, + "min":0 + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "InternalServiceException", + "InvalidParameterException" + ] + }, + "ErrorMessage":{"type":"string"}, + "ExceptionMessage":{ + "type":"string", + "max":2048, + "min":0 + }, + "FailedResourcesMap":{ + "type":"map", + "key":{"shape":"ResourceARN"}, + "value":{"shape":"FailureInfo"} + }, + "FailureInfo":{ + "type":"structure", + "members":{ + "StatusCode":{ + "shape":"StatusCode", + "documentation":"

    The HTTP status code of the common error.

    " + }, + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

    The code of the common error. Valid values include InternalServiceException, InvalidParameterException, and any valid error code returned by the AWS service that hosts the resource that you want to tag.

    " + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

    The message of the common error.

    " + } + }, + "documentation":"

    Details of the common errors that all actions return.

    " + }, + "GetResourcesInput":{ + "type":"structure", + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

    " + }, + "TagFilters":{ + "shape":"TagFilterList", + "documentation":"

    A list of TagFilters (keys and values). Each TagFilter specified must contain a key with values as optional. A request can include up to 50 keys, and each key can include up to 20 values.

    Note the following when deciding how to use TagFilters:

    • If you do specify a TagFilter, the response returns only those resources that are currently associated with the specified tag.

    • If you don't specify a TagFilter, the response includes all resources that were ever associated with tags. Resources that currently don't have associated tags are shown with an empty tag set, like this: \"Tags\": [].

    • If you specify more than one filter in a single request, the response returns only those resources that satisfy all specified filters.

    • If you specify a filter that contains more than one value for a key, the response returns resources that match any of the specified values for that key.

    • If you don't specify any values for a key, the response returns resources that are tagged with that key irrespective of the value.

      For example, for filters: filter1 = {key1, {value1}}, filter2 = {key2, {value2,value3,value4}} , filter3 = {key3}:

      • GetResources( {filter1} ) returns resources tagged with key1=value1

      • GetResources( {filter2} ) returns resources tagged with key2=value2 or key2=value3 or key2=value4

      • GetResources( {filter3} ) returns resources tagged with any tag containing key3 as its tag key, irrespective of its value

      • GetResources( {filter1,filter2,filter3} ) returns resources tagged with ( key1=value1) and ( key2=value2 or key2=value3 or key2=value4) and (key3, irrespective of the value)

    " + }, + "ResourcesPerPage":{ + "shape":"ResourcesPerPage", + "documentation":"

    A limit that restricts the number of resources returned by GetResources in paginated output. You can set ResourcesPerPage to a minimum of 1 item and the maximum of 100 items.

    " + }, + "TagsPerPage":{ + "shape":"TagsPerPage", + "documentation":"

    A limit that restricts the number of tags (key and value pairs) returned by GetResources in paginated output. A resource with no tags is counted as having one tag (one key and value pair).

    GetResources does not split a resource and its associated tags across pages. If the specified TagsPerPage would cause such a break, a PaginationToken is returned in place of the affected resource and its tags. Use that token in another request to get the remaining data. For example, if you specify a TagsPerPage of 100 and the account has 22 resources with 10 tags each (meaning that each resource has 10 key and value pairs), the output will consist of 3 pages, with the first page displaying the first 10 resources, each with its 10 tags, the second page displaying the next 10 resources each with its 10 tags, and the third page displaying the remaining 2 resources, each with its 10 tags.

    You can set TagsPerPage to a minimum of 100 items and the maximum of 500 items.

    " + }, + "ResourceTypeFilters":{ + "shape":"ResourceTypeFilterList", + "documentation":"

    The constraints on the resources that you want returned. The format of each resource type is service[:resourceType]. For example, specifying a resource type of ec2 returns all Amazon EC2 resources (which includes EC2 instances). Specifying a resource type of ec2:instance returns only EC2 instances.

    The string for each service name and resource type is the same as that embedded in a resource's Amazon Resource Name (ARN). Consult the AWS General Reference for the following:

    You can specify multiple resource types by using an array. The array can include up to 100 items. Note that the length constraint requirement applies to each resource type filter.

    " + } + } + }, + "GetResourcesOutput":{ + "type":"structure", + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.

    " + }, + "ResourceTagMappingList":{ + "shape":"ResourceTagMappingList", + "documentation":"

    A list of resource ARNs and the tags (keys and values) associated with each.

    " + } + } + }, + "GetTagKeysInput":{ + "type":"structure", + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

    " + } + } + }, + "GetTagKeysOutput":{ + "type":"structure", + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A list of all tag keys in the AWS account.

    " + } + } + }, + "GetTagValuesInput":{ + "type":"structure", + "required":["Key"], + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that additional data is available. Leave this value empty for your initial request. If the response includes a PaginationToken, use that string for this value to request an additional page of data.

    " + }, + "Key":{ + "shape":"TagKey", + "documentation":"

    The key for which you want to list all existing values in the specified region for the AWS account.

    " + } + } + }, + "GetTagValuesOutput":{ + "type":"structure", + "members":{ + "PaginationToken":{ + "shape":"PaginationToken", + "documentation":"

    A string that indicates that the response contains more data than can be returned in a single response. To receive additional data, specify this string for the PaginationToken value in a subsequent request.

    " + }, + "TagValues":{ + "shape":"TagValuesOutputList", + "documentation":"

    A list of all tag values for the specified key in the AWS account.

    " + } + } + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The request processing failed because of an unknown error, exception, or failure. You can retry the request.

    ", + "exception":true, + "fault":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    A parameter is missing or a malformed string or invalid or out-of-range value was supplied for the request parameter.

    ", + "exception":true + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":0 + }, + "PaginationTokenExpiredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    A PaginationToken is valid for a maximum of 15 minutes. Your request was denied because the specified PaginationToken has expired.

    ", + "exception":true + }, + "ResourceARN":{ + "type":"string", + "max":1600, + "min":1 + }, + "ResourceARNList":{ + "type":"list", + "member":{"shape":"ResourceARN"}, + "max":20, + "min":1 + }, + "ResourceTagMapping":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The ARN of the resource.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags that have been applied to one or more AWS resources.

    " + } + }, + "documentation":"

    A list of resource ARNs and the tags (keys and values) that are associated with each.

    " + }, + "ResourceTagMappingList":{ + "type":"list", + "member":{"shape":"ResourceTagMapping"} + }, + "ResourceTypeFilterList":{ + "type":"list", + "member":{"shape":"AmazonResourceType"} + }, + "ResourcesPerPage":{"type":"integer"}, + "StatusCode":{"type":"integer"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    " + } + }, + "documentation":"

    The metadata that you apply to AWS resources to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see Tag Basics in the Amazon EC2 User Guide for Linux Instances.

    " + }, + "TagFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

    " + }, + "Values":{ + "shape":"TagValueList", + "documentation":"

    The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

    " + } + }, + "documentation":"

    A list of tags (keys and values) that are used to specify the associated resources.

    " + }, + "TagFilterList":{ + "type":"list", + "member":{"shape":"TagFilter"}, + "max":50, + "min":0 + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagKeyListForUntag":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourcesInput":{ + "type":"structure", + "required":[ + "ResourceARNList", + "Tags" + ], + "members":{ + "ResourceARNList":{ + "shape":"ResourceARNList", + "documentation":"

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to tag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

    The tags that you want to add to the specified resources. A tag consists of a key and a value that you define.

    " + } + } + }, + "TagResourcesOutput":{ + "type":"structure", + "members":{ + "FailedResourcesMap":{ + "shape":"FailedResourcesMap", + "documentation":"

    Details of resources that could not be tagged. An error code, status code, and error message are returned for each failed item.

    " + } + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TagValueList":{ + "type":"list", + "member":{"shape":"TagValue"}, + "max":20, + "min":0 + }, + "TagValuesOutputList":{ + "type":"list", + "member":{"shape":"TagValue"} + }, + "TagsPerPage":{"type":"integer"}, + "ThrottledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The request was denied to limit the frequency of submitted requests.

    ", + "exception":true + }, + "UntagResourcesInput":{ + "type":"structure", + "required":[ + "ResourceARNList", + "TagKeys" + ], + "members":{ + "ResourceARNList":{ + "shape":"ResourceARNList", + "documentation":"

    A list of ARNs. An ARN (Amazon Resource Name) uniquely identifies a resource. You can specify a minimum of 1 and a maximum of 20 ARNs (resources) to untag. An ARN can be set to a maximum of 1600 characters. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + }, + "TagKeys":{ + "shape":"TagKeyListForUntag", + "documentation":"

    A list of the tag keys that you want to remove from the specified resources.

    " + } + } + }, + "UntagResourcesOutput":{ + "type":"structure", + "members":{ + "FailedResourcesMap":{ + "shape":"FailedResourcesMap", + "documentation":"

    Details of resources that could not be untagged. An error code, status code, and error message are returned for each failed item.

    " + } + } + } + }, + "documentation":"Resource Groups Tagging API

    This guide describes the API operations for the resource groups tagging.

    A tag is a label that you assign to an AWS resource. A tag consists of a key and a value, both of which you define. For example, if you have two Amazon EC2 instances, you might assign both a tag key of \"Stack.\" But the value of \"Stack\" might be \"Testing\" for one and \"Production\" for the other.

    Tagging can help you organize your resources and enables you to simplify resource management, access management and cost allocation.

    You can use the resource groups tagging API operations to complete the following tasks:

    • Tag and untag supported resources located in the specified region for the AWS account

    • Use tag-based filters to search for resources located in the specified region for the AWS account

    • List all existing tag keys in the specified region for the AWS account

    • List all existing values for the specified key in the specified region for the AWS account

    To use resource groups tagging API operations, you must add the following permissions to your IAM policy:

    • tag:GetResources

    • tag:TagResources

    • tag:UntagResources

    • tag:GetTagKeys

    • tag:GetTagValues

    You'll also need permissions to access the resources of individual services so that you can tag and untag those resources.

    For more information on IAM policies, see Managing IAM Policies in the IAM User Guide.

    You can use the Resource Groups Tagging API to tag resources for the following AWS services.

    • Alexa for Business (a4b)

    • API Gateway

    • AWS AppStream

    • AWS AppSync

    • AWS App Mesh

    • Amazon Athena

    • Amazon Aurora

    • AWS Backup

    • AWS Certificate Manager

    • AWS Certificate Manager Private CA

    • Amazon Cloud Directory

    • AWS CloudFormation

    • Amazon CloudFront

    • AWS CloudHSM

    • AWS CloudTrail

    • Amazon CloudWatch (alarms only)

    • Amazon CloudWatch Events

    • Amazon CloudWatch Logs

    • AWS CodeBuild

    • AWS CodeCommit

    • AWS CodePipeline

    • AWS CodeStar

    • Amazon Cognito Identity

    • Amazon Cognito User Pools

    • Amazon Comprehend

    • AWS Config

    • AWS Data Pipeline

    • AWS Database Migration Service

    • AWS Datasync

    • AWS Direct Connect

    • AWS Directory Service

    • Amazon DynamoDB

    • Amazon EBS

    • Amazon EC2

    • Amazon ECR

    • Amazon ECS

    • AWS Elastic Beanstalk

    • Amazon Elastic File System

    • Elastic Load Balancing

    • Amazon ElastiCache

    • Amazon Elasticsearch Service

    • AWS Elemental MediaLive

    • AWS Elemental MediaPackage

    • AWS Elemental MediaTailor

    • Amazon EMR

    • Amazon FSx

    • Amazon Glacier

    • AWS Glue

    • Amazon Inspector

    • AWS IoT Analytics

    • AWS IoT Core

    • AWS IoT Device Defender

    • AWS IoT Device Management

    • AWS IoT Greengrass

    • AWS Key Management Service

    • Amazon Kinesis

    • Amazon Kinesis Data Analytics

    • Amazon Kinesis Data Firehose

    • AWS Lambda

    • AWS License Manager

    • Amazon Machine Learning

    • Amazon MQ

    • Amazon MSK

    • Amazon Neptune

    • AWS OpsWorks

    • Amazon RDS

    • Amazon Redshift

    • AWS Resource Access Manager

    • AWS Resource Groups

    • AWS RoboMaker

    • Amazon Route 53

    • Amazon Route 53 Resolver

    • Amazon S3 (buckets only)

    • Amazon SageMaker

    • AWS Secrets Manager

    • AWS Service Catalog

    • Amazon Simple Notification Service (SNS)

    • Amazon Simple Queue Service (SQS)

    • AWS Simple System Manager (SSM)

    • AWS Step Functions

    • AWS Storage Gateway

    • AWS Transfer for SFTP

    • Amazon VPC

    • Amazon WorkSpaces

    " +} diff --git a/aws/dist/botocore/data/robomaker/2018-06-29/paginators-1.json b/aws/dist/botocore/data/robomaker/2018-06-29/paginators-1.json new file mode 100644 index 00000000..314046d4 --- /dev/null +++ b/aws/dist/botocore/data/robomaker/2018-06-29/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListDeploymentJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "deploymentJobs" + }, + "ListFleets": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "fleetDetails" + }, + "ListRobotApplications": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "robotApplicationSummaries" + }, + "ListRobots": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "robots" + }, + "ListSimulationApplications": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "simulationApplicationSummaries" + }, + "ListSimulationJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "simulationJobSummaries" + } + } +} diff --git a/aws/dist/botocore/data/robomaker/2018-06-29/service-2.json b/aws/dist/botocore/data/robomaker/2018-06-29/service-2.json new file mode 100644 index 00000000..1a0222b2 --- /dev/null +++ b/aws/dist/botocore/data/robomaker/2018-06-29/service-2.json @@ -0,0 +1,3457 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-06-29", + "endpointPrefix":"robomaker", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"RoboMaker", + "serviceFullName":"AWS RoboMaker", + "serviceId":"RoboMaker", + "signatureVersion":"v4", + "signingName":"robomaker", + "uid":"robomaker-2018-06-29" + }, + "operations":{ + "BatchDescribeSimulationJob":{ + "name":"BatchDescribeSimulationJob", + "http":{ + "method":"POST", + "requestUri":"/batchDescribeSimulationJob" + }, + "input":{"shape":"BatchDescribeSimulationJobRequest"}, + "output":{"shape":"BatchDescribeSimulationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Describes one or more simulation jobs.

    " + }, + "CancelDeploymentJob":{ + "name":"CancelDeploymentJob", + "http":{ + "method":"POST", + "requestUri":"/cancelDeploymentJob" + }, + "input":{"shape":"CancelDeploymentJobRequest"}, + "output":{"shape":"CancelDeploymentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Cancels the specified deployment job.

    " + }, + "CancelSimulationJob":{ + "name":"CancelSimulationJob", + "http":{ + "method":"POST", + "requestUri":"/cancelSimulationJob" + }, + "input":{"shape":"CancelSimulationJobRequest"}, + "output":{"shape":"CancelSimulationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Cancels the specified simulation job.

    " + }, + "CreateDeploymentJob":{ + "name":"CreateDeploymentJob", + "http":{ + "method":"POST", + "requestUri":"/createDeploymentJob" + }, + "input":{"shape":"CreateDeploymentJobRequest"}, + "output":{"shape":"CreateDeploymentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentDeploymentException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Deploys a specific version of a robot application to robots in a fleet.

    The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

    After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

    " + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/createFleet" + }, + "input":{"shape":"CreateFleetRequest"}, + "output":{"shape":"CreateFleetResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a fleet, a logical group of robots running the same robot application.

    " + }, + "CreateRobot":{ + "name":"CreateRobot", + "http":{ + "method":"POST", + "requestUri":"/createRobot" + }, + "input":{"shape":"CreateRobotRequest"}, + "output":{"shape":"CreateRobotResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

    Creates a robot.

    " + }, + "CreateRobotApplication":{ + "name":"CreateRobotApplication", + "http":{ + "method":"POST", + "requestUri":"/createRobotApplication" + }, + "input":{"shape":"CreateRobotApplicationRequest"}, + "output":{"shape":"CreateRobotApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Creates a robot application.

    " + }, + "CreateRobotApplicationVersion":{ + "name":"CreateRobotApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/createRobotApplicationVersion" + }, + "input":{"shape":"CreateRobotApplicationVersionRequest"}, + "output":{"shape":"CreateRobotApplicationVersionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Creates a version of a robot application.

    " + }, + "CreateSimulationApplication":{ + "name":"CreateSimulationApplication", + "http":{ + "method":"POST", + "requestUri":"/createSimulationApplication" + }, + "input":{"shape":"CreateSimulationApplicationRequest"}, + "output":{"shape":"CreateSimulationApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Creates a simulation application.

    " + }, + "CreateSimulationApplicationVersion":{ + "name":"CreateSimulationApplicationVersion", + "http":{ + "method":"POST", + "requestUri":"/createSimulationApplicationVersion" + }, + "input":{"shape":"CreateSimulationApplicationVersionRequest"}, + "output":{"shape":"CreateSimulationApplicationVersionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Creates a simulation application with a specific revision id.

    " + }, + "CreateSimulationJob":{ + "name":"CreateSimulationJob", + "http":{ + "method":"POST", + "requestUri":"/createSimulationJob" + }, + "input":{"shape":"CreateSimulationJobRequest"}, + "output":{"shape":"CreateSimulationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Creates a simulation job.

    After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.

    " + }, + "DeleteFleet":{ + "name":"DeleteFleet", + "http":{ + "method":"POST", + "requestUri":"/deleteFleet" + }, + "input":{"shape":"DeleteFleetRequest"}, + "output":{"shape":"DeleteFleetResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Deletes a fleet.

    " + }, + "DeleteRobot":{ + "name":"DeleteRobot", + "http":{ + "method":"POST", + "requestUri":"/deleteRobot" + }, + "input":{"shape":"DeleteRobotRequest"}, + "output":{"shape":"DeleteRobotResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Deletes a robot.

    " + }, + "DeleteRobotApplication":{ + "name":"DeleteRobotApplication", + "http":{ + "method":"POST", + "requestUri":"/deleteRobotApplication" + }, + "input":{"shape":"DeleteRobotApplicationRequest"}, + "output":{"shape":"DeleteRobotApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Deletes a robot application.

    " + }, + "DeleteSimulationApplication":{ + "name":"DeleteSimulationApplication", + "http":{ + "method":"POST", + "requestUri":"/deleteSimulationApplication" + }, + "input":{"shape":"DeleteSimulationApplicationRequest"}, + "output":{"shape":"DeleteSimulationApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Deletes a simulation application.

    " + }, + "DeregisterRobot":{ + "name":"DeregisterRobot", + "http":{ + "method":"POST", + "requestUri":"/deregisterRobot" + }, + "input":{"shape":"DeregisterRobotRequest"}, + "output":{"shape":"DeregisterRobotResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deregisters a robot.

    " + }, + "DescribeDeploymentJob":{ + "name":"DescribeDeploymentJob", + "http":{ + "method":"POST", + "requestUri":"/describeDeploymentJob" + }, + "input":{"shape":"DescribeDeploymentJobRequest"}, + "output":{"shape":"DescribeDeploymentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Describes a deployment job.

    " + }, + "DescribeFleet":{ + "name":"DescribeFleet", + "http":{ + "method":"POST", + "requestUri":"/describeFleet" + }, + "input":{"shape":"DescribeFleetRequest"}, + "output":{"shape":"DescribeFleetResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Describes a fleet.

    " + }, + "DescribeRobot":{ + "name":"DescribeRobot", + "http":{ + "method":"POST", + "requestUri":"/describeRobot" + }, + "input":{"shape":"DescribeRobotRequest"}, + "output":{"shape":"DescribeRobotResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Describes a robot.

    " + }, + "DescribeRobotApplication":{ + "name":"DescribeRobotApplication", + "http":{ + "method":"POST", + "requestUri":"/describeRobotApplication" + }, + "input":{"shape":"DescribeRobotApplicationRequest"}, + "output":{"shape":"DescribeRobotApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Describes a robot application.

    " + }, + "DescribeSimulationApplication":{ + "name":"DescribeSimulationApplication", + "http":{ + "method":"POST", + "requestUri":"/describeSimulationApplication" + }, + "input":{"shape":"DescribeSimulationApplicationRequest"}, + "output":{"shape":"DescribeSimulationApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Describes a simulation application.

    " + }, + "DescribeSimulationJob":{ + "name":"DescribeSimulationJob", + "http":{ + "method":"POST", + "requestUri":"/describeSimulationJob" + }, + "input":{"shape":"DescribeSimulationJobRequest"}, + "output":{"shape":"DescribeSimulationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Describes a simulation job.

    " + }, + "ListDeploymentJobs":{ + "name":"ListDeploymentJobs", + "http":{ + "method":"POST", + "requestUri":"/listDeploymentJobs" + }, + "input":{"shape":"ListDeploymentJobsRequest"}, + "output":{"shape":"ListDeploymentJobsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.

    " + }, + "ListFleets":{ + "name":"ListFleets", + "http":{ + "method":"POST", + "requestUri":"/listFleets" + }, + "input":{"shape":"ListFleetsRequest"}, + "output":{"shape":"ListFleetsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.

    " + }, + "ListRobotApplications":{ + "name":"ListRobotApplications", + "http":{ + "method":"POST", + "requestUri":"/listRobotApplications" + }, + "input":{"shape":"ListRobotApplicationsRequest"}, + "output":{"shape":"ListRobotApplicationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.

    " + }, + "ListRobots":{ + "name":"ListRobots", + "http":{ + "method":"POST", + "requestUri":"/listRobots" + }, + "input":{"shape":"ListRobotsRequest"}, + "output":{"shape":"ListRobotsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Returns a list of robots. You can optionally provide filters to retrieve specific robots.

    " + }, + "ListSimulationApplications":{ + "name":"ListSimulationApplications", + "http":{ + "method":"POST", + "requestUri":"/listSimulationApplications" + }, + "input":{"shape":"ListSimulationApplicationsRequest"}, + "output":{"shape":"ListSimulationApplicationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.

    " + }, + "ListSimulationJobs":{ + "name":"ListSimulationJobs", + "http":{ + "method":"POST", + "requestUri":"/listSimulationJobs" + }, + "input":{"shape":"ListSimulationJobsRequest"}, + "output":{"shape":"ListSimulationJobsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists all tags on a AWS RoboMaker resource.

    " + }, + "RegisterRobot":{ + "name":"RegisterRobot", + "http":{ + "method":"POST", + "requestUri":"/registerRobot" + }, + "input":{"shape":"RegisterRobotRequest"}, + "output":{"shape":"RegisterRobotResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Registers a robot with a fleet.

    " + }, + "RestartSimulationJob":{ + "name":"RestartSimulationJob", + "http":{ + "method":"POST", + "requestUri":"/restartSimulationJob" + }, + "input":{"shape":"RestartSimulationJobRequest"}, + "output":{"shape":"RestartSimulationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Restarts a running simulation job.

    " + }, + "SyncDeploymentJob":{ + "name":"SyncDeploymentJob", + "http":{ + "method":"POST", + "requestUri":"/syncDeploymentJob" + }, + "input":{"shape":"SyncDeploymentJobRequest"}, + "output":{"shape":"SyncDeploymentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"}, + {"shape":"ConcurrentDeploymentException"}, + {"shape":"IdempotentParameterMismatchException"} + ], + "documentation":"

    Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Adds or edits tags for a AWS RoboMaker resource.

    Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.

    For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Removes the specified tags from the specified AWS RoboMaker resource.

    To remove a tag, specify the tag key. To change the tag value of an existing tag key, use TagResource .

    " + }, + "UpdateRobotApplication":{ + "name":"UpdateRobotApplication", + "http":{ + "method":"POST", + "requestUri":"/updateRobotApplication" + }, + "input":{"shape":"UpdateRobotApplicationRequest"}, + "output":{"shape":"UpdateRobotApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Updates a robot application.

    " + }, + "UpdateSimulationApplication":{ + "name":"UpdateSimulationApplication", + "http":{ + "method":"POST", + "requestUri":"/updateSimulationApplication" + }, + "input":{"shape":"UpdateSimulationApplicationRequest"}, + "output":{"shape":"UpdateSimulationApplicationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Updates a simulation application.

    " + } + }, + "shapes":{ + "Architecture":{ + "type":"string", + "enum":[ + "X86_64", + "ARM64", + "ARMHF" + ] + }, + "Arn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"arn:.*" + }, + "Arns":{ + "type":"list", + "member":{"shape":"Arn"}, + "max":100, + "min":1 + }, + "BatchDescribeSimulationJobRequest":{ + "type":"structure", + "required":["jobs"], + "members":{ + "jobs":{ + "shape":"Arns", + "documentation":"

    A list of Amazon Resource Names (ARNs) of simulation jobs to describe.

    " + } + } + }, + "BatchDescribeSimulationJobResponse":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"SimulationJobs", + "documentation":"

    A list of simulation jobs.

    " + }, + "unprocessedJobs":{ + "shape":"Arns", + "documentation":"

    A list of unprocessed simulation job Amazon Resource Names (ARNs).

    " + } + } + }, + "Boolean":{"type":"boolean"}, + "BoxedBoolean":{"type":"boolean"}, + "CancelDeploymentJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"Arn", + "documentation":"

    The deployment job ARN to cancel.

    " + } + } + }, + "CancelDeploymentJobResponse":{ + "type":"structure", + "members":{ + } + }, + "CancelSimulationJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"Arn", + "documentation":"

    The simulation job ARN to cancel.

    " + } + } + }, + "CancelSimulationJobResponse":{ + "type":"structure", + "members":{ + } + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_\\-=]*" + }, + "Command":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-]*" + }, + "ConcurrentDeploymentException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The failure percentage threshold percentage was met.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateDeploymentJobRequest":{ + "type":"structure", + "required":[ + "clientRequestToken", + "fleet", + "deploymentApplicationConfigs" + ], + "members":{ + "deploymentConfig":{ + "shape":"DeploymentConfig", + "documentation":"

    The requested deployment configuration.

    " + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "idempotencyToken":true + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet to deploy.

    " + }, + "deploymentApplicationConfigs":{ + "shape":"DeploymentApplicationConfigs", + "documentation":"

    The deployment application configuration.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the deployment job.

    " + } + } + }, + "CreateDeploymentJobResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the deployment job.

    " + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The target fleet for the deployment job.

    " + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the deployment job.

    " + }, + "deploymentApplicationConfigs":{ + "shape":"DeploymentApplicationConfigs", + "documentation":"

    The deployment application configuration.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    The failure reason of the deployment job if it failed.

    " + }, + "failureCode":{ + "shape":"DeploymentJobErrorCode", + "documentation":"

    The failure code of the simulation job if it failed:

    BadPermissionError

    AWS Greengrass requires a service-level role permission to access other services. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy.

    ExtractingBundleFailure

    The robot application could not be extracted from the bundle.

    FailureThresholdBreached

    The percentage of robots that could not be updated exceeded the percentage set for the deployment.

    GreengrassDeploymentFailed

    The robot application could not be deployed to the robot.

    GreengrassGroupVersionDoesNotExist

    The AWS Greengrass group or version associated with a robot is missing.

    InternalServerError

    An internal error has occurred. Retry your request, but if the problem persists, contact us with details.

    MissingRobotApplicationArchitecture

    The robot application does not have a source that matches the architecture of the robot.

    MissingRobotDeploymentResource

    One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?

    PostLaunchFileFailure

    The post-launch script failed.

    PreLaunchFileFailure

    The pre-launch script failed.

    ResourceNotFound

    One or more deployment resources are missing. For example, do robot application source bundles still exist?

    RobotDeploymentNoResponse

    There is no response from the robot. It might not be powered on or connected to the internet.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the fleet was created.

    " + }, + "deploymentConfig":{ + "shape":"DeploymentConfig", + "documentation":"

    The deployment configuration.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the deployment job.

    " + } + } + }, + "CreateFleetRequest":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the fleet.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the fleet.

    " + } + } + }, + "CreateFleetResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the fleet.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the fleet was created.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the fleet.

    " + } + } + }, + "CreateRobotApplicationRequest":{ + "type":"structure", + "required":[ + "name", + "sources", + "robotSoftwareSuite" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "sources":{ + "shape":"SourceConfigs", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the robot application.

    " + } + } + }, + "CreateRobotApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the robot application.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the robot application.

    " + } + } + }, + "CreateRobotApplicationVersionRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the robot application.

    " + }, + "currentRevisionId":{ + "shape":"RevisionId", + "documentation":"

    The current revision id for the robot application. If you provide a value and it matches the latest revision ID, a new version will be created.

    " + } + } + }, + "CreateRobotApplicationVersionResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the robot application.

    " + } + } + }, + "CreateRobotRequest":{ + "type":"structure", + "required":[ + "name", + "architecture", + "greengrassGroupId" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name for the robot.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The target architecture of the robot.

    " + }, + "greengrassGroupId":{ + "shape":"Id", + "documentation":"

    The Greengrass group id.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the robot.

    " + } + } + }, + "CreateRobotResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot was created.

    " + }, + "greengrassGroupId":{ + "shape":"Id", + "documentation":"

    The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The target architecture of the robot.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the robot.

    " + } + } + }, + "CreateSimulationApplicationRequest":{ + "type":"structure", + "required":[ + "name", + "sources", + "simulationSoftwareSuite", + "robotSoftwareSuite" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "sources":{ + "shape":"SourceConfigs", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite of the simulation application.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the simulation application.

    " + } + } + }, + "CreateSimulationApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the simulation application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about the robot software suite.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the simulation application.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the simulation application.

    " + } + } + }, + "CreateSimulationApplicationVersionRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the simulation application.

    " + }, + "currentRevisionId":{ + "shape":"RevisionId", + "documentation":"

    The current revision id for the simulation application. If you provide a value and it matches the latest revision ID, a new version will be created.

    " + } + } + }, + "CreateSimulationApplicationVersionResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the simulation application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about the robot software suite.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision ID of the simulation application.

    " + } + } + }, + "CreateSimulationJobRequest":{ + "type":"structure", + "required":[ + "maxJobDurationInSeconds", + "iamRole" + ], + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "idempotencyToken":true + }, + "outputLocation":{ + "shape":"OutputLocation", + "documentation":"

    Location for output files generated by the simulation job.

    " + }, + "loggingConfig":{ + "shape":"LoggingConfig", + "documentation":"

    The logging configuration.

    " + }, + "maxJobDurationInSeconds":{ + "shape":"JobDuration", + "documentation":"

    The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When maxJobDurationInSeconds is reached, the simulation job will status will transition to Completed.

    " + }, + "iamRole":{ + "shape":"IamRole", + "documentation":"

    The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

    " + }, + "failureBehavior":{ + "shape":"FailureBehavior", + "documentation":"

    The failure behavior the simulation job.

    Continue

    Restart the simulation job in the same host instance.

    Fail

    Stop the simulation job and terminate the instance.

    " + }, + "robotApplications":{ + "shape":"RobotApplicationConfigs", + "documentation":"

    The robot application to use in the simulation job.

    " + }, + "simulationApplications":{ + "shape":"SimulationApplicationConfigs", + "documentation":"

    The simulation application to use in the simulation job.

    " + }, + "dataSources":{ + "shape":"DataSourceConfigs", + "documentation":"

    The data sources for the simulation job.

    There is a limit of 100 files and a combined size of 25GB for all DataSourceConfig objects.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the simulation job.

    " + }, + "vpcConfig":{ + "shape":"VPCConfig", + "documentation":"

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and one subnet ID.

    " + } + } + }, + "CreateSimulationJobResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job.

    " + }, + "status":{ + "shape":"SimulationJobStatus", + "documentation":"

    The status of the simulation job.

    " + }, + "lastStartedAt":{ + "shape":"LastStartedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + }, + "failureBehavior":{ + "shape":"FailureBehavior", + "documentation":"

    the failure behavior for the simulation job.

    " + }, + "failureCode":{ + "shape":"SimulationJobErrorCode", + "documentation":"

    The failure code of the simulation job if it failed:

    InternalServiceError

    Internal service error.

    RobotApplicationCrash

    Robot application exited abnormally.

    SimulationApplicationCrash

    Simulation application exited abnormally.

    BadPermissionsRobotApplication

    Robot application bundle could not be downloaded.

    BadPermissionsSimulationApplication

    Simulation application bundle could not be downloaded.

    BadPermissionsS3Output

    Unable to publish outputs to customer-provided S3 bucket.

    BadPermissionsCloudwatchLogs

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    SubnetIpLimitExceeded

    Subnet IP limit exceeded.

    ENILimitExceeded

    ENI limit exceeded.

    BadPermissionsUserCredentials

    Unable to use the Role provided.

    InvalidBundleRobotApplication

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    InvalidBundleSimulationApplication

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    RobotApplicationVersionMismatchedEtag

    Etag for RobotApplication does not match value during version creation.

    SimulationApplicationVersionMismatchedEtag

    Etag for SimulationApplication does not match value during version creation.

    " + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + }, + "outputLocation":{ + "shape":"OutputLocation", + "documentation":"

    Simulation job output files location.

    " + }, + "loggingConfig":{ + "shape":"LoggingConfig", + "documentation":"

    The logging configuration.

    " + }, + "maxJobDurationInSeconds":{ + "shape":"JobDuration", + "documentation":"

    The maximum simulation job duration in seconds.

    " + }, + "simulationTimeMillis":{ + "shape":"SimulationTimeMillis", + "documentation":"

    The simulation job execution duration in milliseconds.

    " + }, + "iamRole":{ + "shape":"IamRole", + "documentation":"

    The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.

    " + }, + "robotApplications":{ + "shape":"RobotApplicationConfigs", + "documentation":"

    The robot application used by the simulation job.

    " + }, + "simulationApplications":{ + "shape":"SimulationApplicationConfigs", + "documentation":"

    The simulation application used by the simulation job.

    " + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

    The data sources for the simulation job.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the simulation job.

    " + }, + "vpcConfig":{ + "shape":"VPCConfigResponse", + "documentation":"

    Information about the vpc configuration.

    " + } + } + }, + "CreatedAt":{"type":"timestamp"}, + "DataSource":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the data source.

    " + }, + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The S3 bucket where the data files are located.

    " + }, + "s3Keys":{ + "shape":"S3KeyOutputs", + "documentation":"

    The list of S3 keys identifying the data source files.

    " + } + }, + "documentation":"

    Information about a data source.

    " + }, + "DataSourceConfig":{ + "type":"structure", + "required":[ + "name", + "s3Bucket", + "s3Keys" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the data source.

    " + }, + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The S3 bucket where the data files are located.

    " + }, + "s3Keys":{ + "shape":"S3Keys", + "documentation":"

    The list of S3 keys identifying the data source files.

    " + } + }, + "documentation":"

    Information about a data source.

    " + }, + "DataSourceConfigs":{ + "type":"list", + "member":{"shape":"DataSourceConfig"}, + "max":5, + "min":1 + }, + "DataSourceNames":{ + "type":"list", + "member":{"shape":"Name"} + }, + "DataSources":{ + "type":"list", + "member":{"shape":"DataSource"} + }, + "DeleteFleetRequest":{ + "type":"structure", + "required":["fleet"], + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + } + } + }, + "DeleteFleetResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRobotApplicationRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the the robot application.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the robot application to delete.

    " + } + } + }, + "DeleteRobotApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRobotRequest":{ + "type":"structure", + "required":["robot"], + "members":{ + "robot":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + } + } + }, + "DeleteRobotResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSimulationApplicationRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the simulation application to delete.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the simulation application to delete.

    " + } + } + }, + "DeleteSimulationApplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeploymentApplicationConfig":{ + "type":"structure", + "required":[ + "application", + "applicationVersion", + "launchConfig" + ], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot application.

    " + }, + "applicationVersion":{ + "shape":"DeploymentVersion", + "documentation":"

    The version of the application.

    " + }, + "launchConfig":{ + "shape":"DeploymentLaunchConfig", + "documentation":"

    The launch configuration.

    " + } + }, + "documentation":"

    Information about a deployment application configuration.

    " + }, + "DeploymentApplicationConfigs":{ + "type":"list", + "member":{"shape":"DeploymentApplicationConfig"}, + "max":1, + "min":1 + }, + "DeploymentConfig":{ + "type":"structure", + "members":{ + "concurrentDeploymentPercentage":{ + "shape":"Percentage", + "documentation":"

    The percentage of robots receiving the deployment at the same time.

    " + }, + "failureThresholdPercentage":{ + "shape":"Percentage", + "documentation":"

    The percentage of deployments that need to fail before stopping deployment.

    " + }, + "robotDeploymentTimeoutInSeconds":{ + "shape":"DeploymentTimeout", + "documentation":"

    The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.

    " + }, + "downloadConditionFile":{ + "shape":"S3Object", + "documentation":"

    The download condition file.

    " + } + }, + "documentation":"

    Information about a deployment configuration.

    " + }, + "DeploymentJob":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the deployment job.

    " + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the deployment job.

    " + }, + "deploymentApplicationConfigs":{ + "shape":"DeploymentApplicationConfigs", + "documentation":"

    The deployment application configuration.

    " + }, + "deploymentConfig":{ + "shape":"DeploymentConfig", + "documentation":"

    The deployment configuration.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    A short description of the reason why the deployment job failed.

    " + }, + "failureCode":{ + "shape":"DeploymentJobErrorCode", + "documentation":"

    The deployment job failure code.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the deployment job was created.

    " + } + }, + "documentation":"

    Information about a deployment job.

    " + }, + "DeploymentJobErrorCode":{ + "type":"string", + "enum":[ + "ResourceNotFound", + "EnvironmentSetupError", + "EtagMismatch", + "FailureThresholdBreached", + "RobotDeploymentAborted", + "RobotDeploymentNoResponse", + "RobotAgentConnectionTimeout", + "GreengrassDeploymentFailed", + "MissingRobotArchitecture", + "MissingRobotApplicationArchitecture", + "MissingRobotDeploymentResource", + "GreengrassGroupVersionDoesNotExist", + "ExtractingBundleFailure", + "PreLaunchFileFailure", + "PostLaunchFileFailure", + "BadPermissionError", + "DownloadConditionFailed", + "InternalServerError" + ] + }, + "DeploymentJobs":{ + "type":"list", + "member":{"shape":"DeploymentJob"}, + "max":200, + "min":0 + }, + "DeploymentLaunchConfig":{ + "type":"structure", + "required":[ + "packageName", + "launchFile" + ], + "members":{ + "packageName":{ + "shape":"Command", + "documentation":"

    The package name.

    " + }, + "preLaunchFile":{ + "shape":"Path", + "documentation":"

    The deployment pre-launch file. This file will be executed prior to the launch file.

    " + }, + "launchFile":{ + "shape":"Command", + "documentation":"

    The launch file name.

    " + }, + "postLaunchFile":{ + "shape":"Path", + "documentation":"

    The deployment post-launch file. This file will be executed after the launch file.

    " + }, + "environmentVariables":{ + "shape":"EnvironmentVariableMap", + "documentation":"

    An array of key/value pairs specifying environment variables for the robot application

    " + } + }, + "documentation":"

    Configuration information for a deployment launch.

    " + }, + "DeploymentStatus":{ + "type":"string", + "enum":[ + "Pending", + "Preparing", + "InProgress", + "Failed", + "Succeeded", + "Canceled" + ] + }, + "DeploymentTimeout":{"type":"long"}, + "DeploymentVersion":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[0-9]*" + }, + "DeregisterRobotRequest":{ + "type":"structure", + "required":[ + "fleet", + "robot" + ], + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "robot":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + } + } + }, + "DeregisterRobotResponse":{ + "type":"structure", + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "robot":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + } + } + }, + "DescribeDeploymentJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the deployment job.

    " + } + } + }, + "DescribeDeploymentJobResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the deployment job.

    " + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the deployment job.

    " + }, + "deploymentConfig":{ + "shape":"DeploymentConfig", + "documentation":"

    The deployment configuration.

    " + }, + "deploymentApplicationConfigs":{ + "shape":"DeploymentApplicationConfigs", + "documentation":"

    The deployment application configuration.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    A short description of the reason why the deployment job failed.

    " + }, + "failureCode":{ + "shape":"DeploymentJobErrorCode", + "documentation":"

    The deployment job failure code.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the deployment job was created.

    " + }, + "robotDeploymentSummary":{ + "shape":"RobotDeploymentSummary", + "documentation":"

    A list of robot deployment summaries.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified deployment job.

    " + } + } + }, + "DescribeFleetRequest":{ + "type":"structure", + "required":["fleet"], + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + } + } + }, + "DescribeFleetResponse":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the fleet.

    " + }, + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "robots":{ + "shape":"Robots", + "documentation":"

    A list of robots.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the fleet was created.

    " + }, + "lastDeploymentStatus":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the last deployment.

    " + }, + "lastDeploymentJob":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the last deployment job.

    " + }, + "lastDeploymentTime":{ + "shape":"CreatedAt", + "documentation":"

    The time of the last deployment.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified fleet.

    " + } + } + }, + "DescribeRobotApplicationRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot application.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the robot application to describe.

    " + } + } + }, + "DescribeRobotApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the robot application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified robot application.

    " + } + } + }, + "DescribeRobotRequest":{ + "type":"structure", + "required":["robot"], + "members":{ + "robot":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot to be described.

    " + } + } + }, + "DescribeRobotResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot.

    " + }, + "fleetArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "status":{ + "shape":"RobotStatus", + "documentation":"

    The status of the fleet.

    " + }, + "greengrassGroupId":{ + "shape":"Id", + "documentation":"

    The Greengrass group id.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot was created.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The target architecture of the robot application.

    " + }, + "lastDeploymentJob":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the last deployment job.

    " + }, + "lastDeploymentTime":{ + "shape":"CreatedAt", + "documentation":"

    The time of the last deployment job.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified robot.

    " + } + } + }, + "DescribeSimulationApplicationRequest":{ + "type":"structure", + "required":["application"], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the simulation application.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the simulation application to describe.

    " + } + } + }, + "DescribeSimulationApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot simulation application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the simulation application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about the robot software suite.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the simulation application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified simulation application.

    " + } + } + }, + "DescribeSimulationJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job to be described.

    " + } + } + }, + "DescribeSimulationJobResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation job.

    " + }, + "status":{ + "shape":"SimulationJobStatus", + "documentation":"

    The status of the simulation job.

    " + }, + "lastStartedAt":{ + "shape":"LastStartedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + }, + "failureBehavior":{ + "shape":"FailureBehavior", + "documentation":"

    The failure behavior for the simulation job.

    " + }, + "failureCode":{ + "shape":"SimulationJobErrorCode", + "documentation":"

    The failure code of the simulation job if it failed:

    InternalServiceError

    Internal service error.

    RobotApplicationCrash

    Robot application exited abnormally.

    SimulationApplicationCrash

    Simulation application exited abnormally.

    BadPermissionsRobotApplication

    Robot application bundle could not be downloaded.

    BadPermissionsSimulationApplication

    Simulation application bundle could not be downloaded.

    BadPermissionsS3Output

    Unable to publish outputs to customer-provided S3 bucket.

    BadPermissionsCloudwatchLogs

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    SubnetIpLimitExceeded

    Subnet IP limit exceeded.

    ENILimitExceeded

    ENI limit exceeded.

    BadPermissionsUserCredentials

    Unable to use the Role provided.

    InvalidBundleRobotApplication

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    InvalidBundleSimulationApplication

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    RobotApplicationVersionMismatchedEtag

    Etag for RobotApplication does not match value during version creation.

    SimulationApplicationVersionMismatchedEtag

    Etag for SimulationApplication does not match value during version creation.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting.

    " + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    " + }, + "outputLocation":{ + "shape":"OutputLocation", + "documentation":"

    Location for output files generated by the simulation job.

    " + }, + "loggingConfig":{ + "shape":"LoggingConfig", + "documentation":"

    The logging configuration.

    " + }, + "maxJobDurationInSeconds":{ + "shape":"JobDuration", + "documentation":"

    The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    " + }, + "simulationTimeMillis":{ + "shape":"SimulationTimeMillis", + "documentation":"

    The simulation job execution duration in milliseconds.

    " + }, + "iamRole":{ + "shape":"IamRole", + "documentation":"

    The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

    " + }, + "robotApplications":{ + "shape":"RobotApplicationConfigs", + "documentation":"

    A list of robot applications.

    " + }, + "simulationApplications":{ + "shape":"SimulationApplicationConfigs", + "documentation":"

    A list of simulation applications.

    " + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

    The data sources for the simulation job.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified simulation job.

    " + }, + "vpcConfig":{ + "shape":"VPCConfigResponse", + "documentation":"

    The VPC configuration.

    " + }, + "networkInterface":{ + "shape":"NetworkInterface", + "documentation":"

    The network interface information for the simulation job.

    " + } + } + }, + "EnvironmentVariableKey":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[A-Z_][A-Z0-9_]*" + }, + "EnvironmentVariableMap":{ + "type":"map", + "key":{"shape":"EnvironmentVariableKey"}, + "value":{"shape":"EnvironmentVariableValue"}, + "max":16, + "min":0 + }, + "EnvironmentVariableValue":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*" + }, + "FailureBehavior":{ + "type":"string", + "enum":[ + "Fail", + "Continue" + ] + }, + "Filter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the filter.

    " + }, + "values":{ + "shape":"FilterValues", + "documentation":"

    A list of values.

    " + } + }, + "documentation":"

    Information about a filter.

    " + }, + "FilterValues":{ + "type":"list", + "member":{"shape":"Name"}, + "max":1, + "min":1 + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":1, + "min":1 + }, + "Fleet":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the fleet.

    " + }, + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the fleet was created.

    " + }, + "lastDeploymentStatus":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the last fleet deployment.

    " + }, + "lastDeploymentJob":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the last deployment job.

    " + }, + "lastDeploymentTime":{ + "shape":"CreatedAt", + "documentation":"

    The time of the last deployment.

    " + } + }, + "documentation":"

    Information about a fleet.

    " + }, + "Fleets":{ + "type":"list", + "member":{"shape":"Fleet"}, + "max":200, + "min":0 + }, + "GenericInteger":{"type":"integer"}, + "GenericString":{"type":"string"}, + "IamRole":{ + "type":"string", + "max":255, + "min":1, + "pattern":"arn:aws:iam::\\w+:role/.*" + }, + "Id":{ + "type":"string", + "max":1224, + "min":1, + "pattern":".*" + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    AWS RoboMaker experienced a service issue. Try your call again.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "JobDuration":{"type":"long"}, + "LastStartedAt":{"type":"timestamp"}, + "LastUpdatedAt":{"type":"timestamp"}, + "LaunchConfig":{ + "type":"structure", + "required":[ + "packageName", + "launchFile" + ], + "members":{ + "packageName":{ + "shape":"Command", + "documentation":"

    The package name.

    " + }, + "launchFile":{ + "shape":"Command", + "documentation":"

    The launch file name.

    " + }, + "environmentVariables":{ + "shape":"EnvironmentVariableMap", + "documentation":"

    The environment variables for the application launch.

    " + }, + "portForwardingConfig":{ + "shape":"PortForwardingConfig", + "documentation":"

    The port forwarding configuration.

    " + } + }, + "documentation":"

    Information about a launch configuration.

    " + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListDeploymentJobsRequest":{ + "type":"structure", + "members":{ + "filters":{ + "shape":"Filters", + "documentation":"

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListDeploymentJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListDeploymentJobs in paginated output. When this parameter is used, ListDeploymentJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListDeploymentJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListDeploymentJobs returns up to 100 results and a nextToken value if applicable.

    " + } + } + }, + "ListDeploymentJobsResponse":{ + "type":"structure", + "members":{ + "deploymentJobs":{ + "shape":"DeploymentJobs", + "documentation":"

    A list of deployment jobs that meet the criteria of the request.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListDeploymentJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListFleetsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListFleets request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListFleets in paginated output. When this parameter is used, ListFleets only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFleets request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListFleets returns up to 100 results and a nextToken value if applicable.

    " + }, + "filters":{ + "shape":"Filters", + "documentation":"

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + } + } + }, + "ListFleetsResponse":{ + "type":"structure", + "members":{ + "fleetDetails":{ + "shape":"Fleets", + "documentation":"

    A list of fleet details meeting the request criteria.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListDeploymentJobs request. When the results of a ListFleets request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListRobotApplicationsRequest":{ + "type":"structure", + "members":{ + "versionQualifier":{ + "shape":"VersionQualifier", + "documentation":"

    The version qualifier of the robot application.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListRobotApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListRobotApplications in paginated output. When this parameter is used, ListRobotApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobotApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobotApplications returns up to 100 results and a nextToken value if applicable.

    " + }, + "filters":{ + "shape":"Filters", + "documentation":"

    Optional filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + } + } + }, + "ListRobotApplicationsResponse":{ + "type":"structure", + "members":{ + "robotApplicationSummaries":{ + "shape":"RobotApplicationSummaries", + "documentation":"

    A list of robot application summaries that meet the criteria of the request.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListRobotApplications request. When the results of a ListRobotApplications request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListRobotsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListRobots request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListRobots in paginated output. When this parameter is used, ListRobots only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRobots request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListRobots returns up to 100 results and a nextToken value if applicable.

    " + }, + "filters":{ + "shape":"Filters", + "documentation":"

    Optional filters to limit results.

    The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available.

    " + } + } + }, + "ListRobotsResponse":{ + "type":"structure", + "members":{ + "robots":{ + "shape":"Robots", + "documentation":"

    A list of robots that meet the criteria of the request.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListRobots request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListSimulationApplicationsRequest":{ + "type":"structure", + "members":{ + "versionQualifier":{ + "shape":"VersionQualifier", + "documentation":"

    The version qualifier of the simulation application.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListSimulationApplications request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListSimulationApplications in paginated output. When this parameter is used, ListSimulationApplications only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationApplications request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationApplications returns up to 100 results and a nextToken value if applicable.

    " + }, + "filters":{ + "shape":"Filters", + "documentation":"

    Optional list of filters to limit results.

    The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.

    " + } + } + }, + "ListSimulationApplicationsResponse":{ + "type":"structure", + "members":{ + "simulationApplicationSummaries":{ + "shape":"SimulationApplicationSummaries", + "documentation":"

    A list of simulation application summaries that meet the criteria of the request.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListSimulationApplications request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListSimulationJobsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value returned from a previous paginated ListSimulationJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of deployment job results returned by ListSimulationJobs in paginated output. When this parameter is used, ListSimulationJobs only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListSimulationJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, then ListSimulationJobs returns up to 100 results and a nextToken value if applicable.

    " + }, + "filters":{ + "shape":"Filters", + "documentation":"

    Optional filters to limit results.

    The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running.

    " + } + } + }, + "ListSimulationJobsResponse":{ + "type":"structure", + "required":["simulationJobSummaries"], + "members":{ + "simulationJobSummaries":{ + "shape":"SimulationJobSummaries", + "documentation":"

    A list of simulation job summaries that meet the criteria of the request.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The nextToken value to include in a future ListSimulationJobs request. When the results of a ListRobot request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.

    ", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified resource.

    " + } + } + }, + "LoggingConfig":{ + "type":"structure", + "required":["recordAllRosTopics"], + "members":{ + "recordAllRosTopics":{ + "shape":"BoxedBoolean", + "documentation":"

    A boolean indicating whether to record all ROS topics.

    " + } + }, + "documentation":"

    The logging configuration.

    " + }, + "MaxResults":{"type":"integer"}, + "Name":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[a-zA-Z0-9_\\-]*" + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "networkInterfaceId":{ + "shape":"GenericString", + "documentation":"

    The ID of the network interface.

    " + }, + "privateIpAddress":{ + "shape":"GenericString", + "documentation":"

    The IPv4 address of the network interface within the subnet.

    " + }, + "publicIpAddress":{ + "shape":"GenericString", + "documentation":"

    The IPv4 public address of the network interface.

    " + } + }, + "documentation":"

    Describes a network interface.

    " + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "NonSystemPort":{ + "type":"integer", + "max":65535, + "min":1024 + }, + "OutputLocation":{ + "type":"structure", + "members":{ + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The S3 bucket for output.

    " + }, + "s3Prefix":{ + "shape":"S3Key", + "documentation":"

    The S3 folder in the s3Bucket where output files will be placed.

    " + } + }, + "documentation":"

    The output location.

    " + }, + "PaginationToken":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-\\/+=]*" + }, + "Path":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*" + }, + "PercentDone":{ + "type":"float", + "max":100.0, + "min":0.0 + }, + "Percentage":{ + "type":"integer", + "max":100, + "min":1 + }, + "Port":{ + "type":"integer", + "max":65535, + "min":1 + }, + "PortForwardingConfig":{ + "type":"structure", + "members":{ + "portMappings":{ + "shape":"PortMappingList", + "documentation":"

    The port mappings for the configuration.

    " + } + }, + "documentation":"

    Configuration information for port forwarding.

    " + }, + "PortMapping":{ + "type":"structure", + "required":[ + "jobPort", + "applicationPort" + ], + "members":{ + "jobPort":{ + "shape":"Port", + "documentation":"

    The port number on the simulation job instance to use as a remote connection point.

    " + }, + "applicationPort":{ + "shape":"NonSystemPort", + "documentation":"

    The port number on the application.

    " + }, + "enableOnPublicIp":{ + "shape":"Boolean", + "documentation":"

    A Boolean indicating whether to enable this port mapping on public IP.

    " + } + }, + "documentation":"

    An object representing a port mapping.

    " + }, + "PortMappingList":{ + "type":"list", + "member":{"shape":"PortMapping"}, + "max":10, + "min":0 + }, + "ProgressDetail":{ + "type":"structure", + "members":{ + "currentProgress":{ + "shape":"RobotDeploymentStep", + "documentation":"

    The current progress status.

    Validating

    Validating the deployment.

    DownloadingExtracting

    Downloading and extracting the bundle on the robot.

    ExecutingPreLaunch

    Executing pre-launch script(s) if provided.

    Launching

    Launching the robot application.

    ExecutingPostLaunch

    Executing post-launch script(s) if provided.

    Finished

    Deployment is complete.

    " + }, + "percentDone":{ + "shape":"PercentDone", + "documentation":"

    Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

    " + }, + "estimatedTimeRemainingSeconds":{ + "shape":"GenericInteger", + "documentation":"

    Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.

    " + }, + "targetResource":{ + "shape":"GenericString", + "documentation":"

    The Amazon Resource Name (ARN) of the deployment job.

    " + } + }, + "documentation":"

    Information about the progress of a deployment job.

    " + }, + "RegisterRobotRequest":{ + "type":"structure", + "required":[ + "fleet", + "robot" + ], + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "robot":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + } + } + }, + "RegisterRobotResponse":{ + "type":"structure", + "members":{ + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet that the robot will join.

    " + }, + "robot":{ + "shape":"Arn", + "documentation":"

    Information about the robot registration.

    " + } + } + }, + "RenderingEngine":{ + "type":"structure", + "members":{ + "name":{ + "shape":"RenderingEngineType", + "documentation":"

    The name of the rendering engine.

    " + }, + "version":{ + "shape":"RenderingEngineVersionType", + "documentation":"

    The version of the rendering engine.

    " + } + }, + "documentation":"

    Information about a rendering engine.

    " + }, + "RenderingEngineType":{ + "type":"string", + "enum":["OGRE"] + }, + "RenderingEngineVersionType":{ + "type":"string", + "pattern":"1.x" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The specified resource already exists.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The specified resource does not exist.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "RestartSimulationJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job.

    " + } + } + }, + "RestartSimulationJobResponse":{ + "type":"structure", + "members":{ + } + }, + "RevisionId":{ + "type":"string", + "max":40, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-]*" + }, + "Robot":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot.

    " + }, + "fleetArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "status":{ + "shape":"RobotStatus", + "documentation":"

    The status of the robot.

    " + }, + "greenGrassGroupId":{ + "shape":"Id", + "documentation":"

    The Greengrass group associated with the robot.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot was created.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The architecture of the robot.

    " + }, + "lastDeploymentJob":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the last deployment job.

    " + }, + "lastDeploymentTime":{ + "shape":"CreatedAt", + "documentation":"

    The time of the last deployment.

    " + } + }, + "documentation":"

    Information about a robot.

    " + }, + "RobotApplicationConfig":{ + "type":"structure", + "required":[ + "application", + "launchConfig" + ], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the robot application.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "launchConfig":{ + "shape":"LaunchConfig", + "documentation":"

    The launch configuration for the robot application.

    " + } + }, + "documentation":"

    Application configuration information for a robot.

    " + }, + "RobotApplicationConfigs":{ + "type":"list", + "member":{"shape":"RobotApplicationConfig"}, + "max":1, + "min":1 + }, + "RobotApplicationNames":{ + "type":"list", + "member":{"shape":"Name"} + }, + "RobotApplicationSummaries":{ + "type":"list", + "member":{"shape":"RobotApplicationSummary"}, + "max":100, + "min":0 + }, + "RobotApplicationSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the robot.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about a robot software suite.

    " + } + }, + "documentation":"

    Summary information for a robot application.

    " + }, + "RobotDeployment":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The robot deployment Amazon Resource Name (ARN).

    " + }, + "deploymentStartTime":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the deployment was started.

    " + }, + "deploymentFinishTime":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the deployment finished.

    " + }, + "status":{ + "shape":"RobotStatus", + "documentation":"

    The status of the robot deployment.

    " + }, + "progressDetail":{ + "shape":"ProgressDetail", + "documentation":"

    Information about how the deployment is progressing.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    A short description of the reason why the robot deployment failed.

    " + }, + "failureCode":{ + "shape":"DeploymentJobErrorCode", + "documentation":"

    The robot deployment failure code.

    " + } + }, + "documentation":"

    Information about a robot deployment.

    " + }, + "RobotDeploymentStep":{ + "type":"string", + "enum":[ + "Validating", + "DownloadingExtracting", + "ExecutingDownloadCondition", + "ExecutingPreLaunch", + "Launching", + "ExecutingPostLaunch", + "Finished" + ] + }, + "RobotDeploymentSummary":{ + "type":"list", + "member":{"shape":"RobotDeployment"} + }, + "RobotSoftwareSuite":{ + "type":"structure", + "members":{ + "name":{ + "shape":"RobotSoftwareSuiteType", + "documentation":"

    The name of the robot software suite.

    " + }, + "version":{ + "shape":"RobotSoftwareSuiteVersionType", + "documentation":"

    The version of the robot software suite.

    " + } + }, + "documentation":"

    Information about a robot software suite.

    " + }, + "RobotSoftwareSuiteType":{ + "type":"string", + "enum":[ + "ROS", + "ROS2" + ] + }, + "RobotSoftwareSuiteVersionType":{ + "type":"string", + "enum":[ + "Kinetic", + "Melodic", + "Dashing" + ] + }, + "RobotStatus":{ + "type":"string", + "enum":[ + "Available", + "Registered", + "PendingNewDeployment", + "Deploying", + "Failed", + "InSync", + "NoResponse" + ] + }, + "Robots":{ + "type":"list", + "member":{"shape":"Robot"}, + "max":1000, + "min":0 + }, + "S3Bucket":{ + "type":"string", + "max":63, + "min":3, + "pattern":"[a-z0-9][a-z0-9.\\-]*[a-z0-9]" + }, + "S3Etag":{"type":"string"}, + "S3Key":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*" + }, + "S3KeyOutput":{ + "type":"structure", + "members":{ + "s3Key":{ + "shape":"S3Key", + "documentation":"

    The S3 key.

    " + }, + "etag":{ + "shape":"S3Etag", + "documentation":"

    The etag for the object.

    " + } + }, + "documentation":"

    Information about S3 keys.

    " + }, + "S3KeyOutputs":{ + "type":"list", + "member":{"shape":"S3KeyOutput"} + }, + "S3Keys":{ + "type":"list", + "member":{"shape":"S3Key"}, + "max":100, + "min":1 + }, + "S3Object":{ + "type":"structure", + "required":[ + "bucket", + "key" + ], + "members":{ + "bucket":{ + "shape":"S3Bucket", + "documentation":"

    The bucket containing the object.

    " + }, + "key":{ + "shape":"S3Key", + "documentation":"

    The key of the object.

    " + }, + "etag":{ + "shape":"S3Etag", + "documentation":"

    The etag of the object.

    " + } + }, + "documentation":"

    Information about an S3 object.

    " + }, + "SecurityGroups":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":5, + "min":1 + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The request has failed due to a temporary failure of the server.

    ", + "error":{"httpStatusCode":503}, + "exception":true + }, + "SimulationApplicationConfig":{ + "type":"structure", + "required":[ + "application", + "launchConfig" + ], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the simulation application.

    " + }, + "applicationVersion":{ + "shape":"Version", + "documentation":"

    The version of the simulation application.

    " + }, + "launchConfig":{ + "shape":"LaunchConfig", + "documentation":"

    The launch configuration for the simulation application.

    " + } + }, + "documentation":"

    Information about a simulation application configuration.

    " + }, + "SimulationApplicationConfigs":{ + "type":"list", + "member":{"shape":"SimulationApplicationConfig"}, + "max":1, + "min":1 + }, + "SimulationApplicationNames":{ + "type":"list", + "member":{"shape":"Name"} + }, + "SimulationApplicationSummaries":{ + "type":"list", + "member":{"shape":"SimulationApplicationSummary"}, + "max":100, + "min":0 + }, + "SimulationApplicationSummary":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the simulation application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about a robot software suite.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    Information about a simulation software suite.

    " + } + }, + "documentation":"

    Summary information for a simulation application.

    " + }, + "SimulationJob":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation job.

    " + }, + "status":{ + "shape":"SimulationJobStatus", + "documentation":"

    Status of the simulation job.

    " + }, + "lastStartedAt":{ + "shape":"LastStartedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last started.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + }, + "failureBehavior":{ + "shape":"FailureBehavior", + "documentation":"

    The failure behavior the simulation job.

    Continue

    Restart the simulation job in the same host instance.

    Fail

    Stop the simulation job and terminate the instance.

    " + }, + "failureCode":{ + "shape":"SimulationJobErrorCode", + "documentation":"

    The failure code of the simulation job if it failed.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    The reason why the simulation job failed.

    " + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    A unique identifier for this SimulationJob request.

    " + }, + "outputLocation":{ + "shape":"OutputLocation", + "documentation":"

    Location for output files generated by the simulation job.

    " + }, + "loggingConfig":{ + "shape":"LoggingConfig", + "documentation":"

    The logging configuration.

    " + }, + "maxJobDurationInSeconds":{ + "shape":"JobDuration", + "documentation":"

    The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

    " + }, + "simulationTimeMillis":{ + "shape":"SimulationTimeMillis", + "documentation":"

    The simulation job execution duration in milliseconds.

    " + }, + "iamRole":{ + "shape":"IamRole", + "documentation":"

    The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

    " + }, + "robotApplications":{ + "shape":"RobotApplicationConfigs", + "documentation":"

    A list of robot applications.

    " + }, + "simulationApplications":{ + "shape":"SimulationApplicationConfigs", + "documentation":"

    A list of simulation applications.

    " + }, + "dataSources":{ + "shape":"DataSources", + "documentation":"

    The data sources for the simulation job.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the simulation job.

    " + }, + "vpcConfig":{ + "shape":"VPCConfigResponse", + "documentation":"

    VPC configuration information.

    " + }, + "networkInterface":{ + "shape":"NetworkInterface", + "documentation":"

    Information about a network interface.

    " + } + }, + "documentation":"

    Information about a simulation job.

    " + }, + "SimulationJobErrorCode":{ + "type":"string", + "enum":[ + "InternalServiceError", + "RobotApplicationCrash", + "SimulationApplicationCrash", + "BadPermissionsRobotApplication", + "BadPermissionsSimulationApplication", + "BadPermissionsS3Object", + "BadPermissionsS3Output", + "BadPermissionsCloudwatchLogs", + "SubnetIpLimitExceeded", + "ENILimitExceeded", + "BadPermissionsUserCredentials", + "InvalidBundleRobotApplication", + "InvalidBundleSimulationApplication", + "InvalidS3Resource", + "MismatchedEtag", + "RobotApplicationVersionMismatchedEtag", + "SimulationApplicationVersionMismatchedEtag", + "ResourceNotFound", + "InvalidInput", + "WrongRegionS3Bucket", + "WrongRegionS3Output", + "WrongRegionRobotApplication", + "WrongRegionSimulationApplication" + ] + }, + "SimulationJobStatus":{ + "type":"string", + "enum":[ + "Pending", + "Preparing", + "Running", + "Restarting", + "Completed", + "Failed", + "RunningFailed", + "Terminating", + "Terminated", + "Canceled" + ] + }, + "SimulationJobSummaries":{ + "type":"list", + "member":{"shape":"SimulationJobSummary"}, + "max":100, + "min":0 + }, + "SimulationJobSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the simulation job.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation job was last updated.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation job.

    " + }, + "status":{ + "shape":"SimulationJobStatus", + "documentation":"

    The status of the simulation job.

    " + }, + "simulationApplicationNames":{ + "shape":"SimulationApplicationNames", + "documentation":"

    A list of simulation job simulation application names.

    " + }, + "robotApplicationNames":{ + "shape":"RobotApplicationNames", + "documentation":"

    A list of simulation job robot application names.

    " + }, + "dataSourceNames":{ + "shape":"DataSourceNames", + "documentation":"

    The names of the data sources.

    " + } + }, + "documentation":"

    Summary information for a simulation job.

    " + }, + "SimulationJobs":{ + "type":"list", + "member":{"shape":"SimulationJob"} + }, + "SimulationSoftwareSuite":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SimulationSoftwareSuiteType", + "documentation":"

    The name of the simulation software suite.

    " + }, + "version":{ + "shape":"SimulationSoftwareSuiteVersionType", + "documentation":"

    The version of the simulation software suite.

    " + } + }, + "documentation":"

    Information about a simulation software suite.

    " + }, + "SimulationSoftwareSuiteType":{ + "type":"string", + "enum":[ + "Gazebo", + "RosbagPlay" + ] + }, + "SimulationSoftwareSuiteVersionType":{ + "type":"string", + "pattern":"7|9|Kinetic|Melodic|Dashing" + }, + "SimulationTimeMillis":{"type":"long"}, + "Source":{ + "type":"structure", + "members":{ + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The s3 bucket name.

    " + }, + "s3Key":{ + "shape":"S3Key", + "documentation":"

    The s3 object key.

    " + }, + "etag":{ + "shape":"S3Etag", + "documentation":"

    A hash of the object specified by s3Bucket and s3Key.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The taget processor architecture for the application.

    " + } + }, + "documentation":"

    Information about a source.

    " + }, + "SourceConfig":{ + "type":"structure", + "members":{ + "s3Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The Amazon S3 bucket name.

    " + }, + "s3Key":{ + "shape":"S3Key", + "documentation":"

    The s3 object key.

    " + }, + "architecture":{ + "shape":"Architecture", + "documentation":"

    The target processor architecture for the application.

    " + } + }, + "documentation":"

    Information about a source configuration.

    " + }, + "SourceConfigs":{ + "type":"list", + "member":{"shape":"SourceConfig"} + }, + "Sources":{ + "type":"list", + "member":{"shape":"Source"} + }, + "Subnets":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":16, + "min":1 + }, + "SyncDeploymentJobRequest":{ + "type":"structure", + "required":[ + "clientRequestToken", + "fleet" + ], + "members":{ + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "idempotencyToken":true + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The target fleet for the synchronization.

    " + } + } + }, + "SyncDeploymentJobResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the synchronization request.

    " + }, + "fleet":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "status":{ + "shape":"DeploymentStatus", + "documentation":"

    The status of the synchronization job.

    " + }, + "deploymentConfig":{ + "shape":"DeploymentConfig", + "documentation":"

    Information about the deployment configuration.

    " + }, + "deploymentApplicationConfigs":{ + "shape":"DeploymentApplicationConfigs", + "documentation":"

    Information about the deployment application configurations.

    " + }, + "failureReason":{ + "shape":"GenericString", + "documentation":"

    The failure reason if the job fails.

    " + }, + "failureCode":{ + "shape":"DeploymentJobErrorCode", + "documentation":"

    The failure code if the job fails:

    InternalServiceError

    Internal service error.

    RobotApplicationCrash

    Robot application exited abnormally.

    SimulationApplicationCrash

    Simulation application exited abnormally.

    BadPermissionsRobotApplication

    Robot application bundle could not be downloaded.

    BadPermissionsSimulationApplication

    Simulation application bundle could not be downloaded.

    BadPermissionsS3Output

    Unable to publish outputs to customer-provided S3 bucket.

    BadPermissionsCloudwatchLogs

    Unable to publish logs to customer-provided CloudWatch Logs resource.

    SubnetIpLimitExceeded

    Subnet IP limit exceeded.

    ENILimitExceeded

    ENI limit exceeded.

    BadPermissionsUserCredentials

    Unable to use the Role provided.

    InvalidBundleRobotApplication

    Robot bundle cannot be extracted (invalid format, bundling error, or other issue).

    InvalidBundleSimulationApplication

    Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).

    RobotApplicationVersionMismatchedEtag

    Etag for RobotApplication does not match value during version creation.

    SimulationApplicationVersionMismatchedEtag

    Etag for SimulationApplication does not match value during version creation.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the fleet was created.

    " + } + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9 _.\\-\\/+=:]*" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A map that contains tag keys and tag values that are attached to the resource.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"[a-zA-Z0-9 _.\\-\\/+=:]*" + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    AWS RoboMaker is temporarily unable to process the request. Try your call again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A map that contains tag keys and tag values that will be unattached from the resource.

    ", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateRobotApplicationRequest":{ + "type":"structure", + "required":[ + "application", + "sources", + "robotSoftwareSuite" + ], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the robot application.

    " + }, + "sources":{ + "shape":"SourceConfigs", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "currentRevisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id for the robot application.

    " + } + } + }, + "UpdateRobotApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the updated robot application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the robot application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the robot application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    The robot software suite used by the robot application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the robot application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the robot application.

    " + } + } + }, + "UpdateSimulationApplicationRequest":{ + "type":"structure", + "required":[ + "application", + "sources", + "simulationSoftwareSuite", + "robotSoftwareSuite" + ], + "members":{ + "application":{ + "shape":"Arn", + "documentation":"

    The application information for the simulation application.

    " + }, + "sources":{ + "shape":"SourceConfigs", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about the robot software suite.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "currentRevisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id for the robot application.

    " + } + } + }, + "UpdateSimulationApplicationResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the updated simulation application.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the simulation application.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the robot application.

    " + }, + "sources":{ + "shape":"Sources", + "documentation":"

    The sources of the simulation application.

    " + }, + "simulationSoftwareSuite":{ + "shape":"SimulationSoftwareSuite", + "documentation":"

    The simulation software suite used by the simulation application.

    " + }, + "robotSoftwareSuite":{ + "shape":"RobotSoftwareSuite", + "documentation":"

    Information about the robot software suite.

    " + }, + "renderingEngine":{ + "shape":"RenderingEngine", + "documentation":"

    The rendering engine for the simulation application.

    " + }, + "lastUpdatedAt":{ + "shape":"LastUpdatedAt", + "documentation":"

    The time, in milliseconds since the epoch, when the simulation application was last updated.

    " + }, + "revisionId":{ + "shape":"RevisionId", + "documentation":"

    The revision id of the simulation application.

    " + } + } + }, + "VPCConfig":{ + "type":"structure", + "required":["subnets"], + "members":{ + "subnets":{ + "shape":"Subnets", + "documentation":"

    A list of one or more subnet IDs in your VPC.

    " + }, + "securityGroups":{ + "shape":"SecurityGroups", + "documentation":"

    A list of one or more security groups IDs in your VPC.

    " + }, + "assignPublicIp":{ + "shape":"Boolean", + "documentation":"

    A boolean indicating whether to assign a public IP address.

    " + } + }, + "documentation":"

    If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.

    " + }, + "VPCConfigResponse":{ + "type":"structure", + "members":{ + "subnets":{ + "shape":"Subnets", + "documentation":"

    A list of subnet IDs associated with the simulation job.

    " + }, + "securityGroups":{ + "shape":"SecurityGroups", + "documentation":"

    A list of security group IDs associated with the simulation job.

    " + }, + "vpcId":{ + "shape":"GenericString", + "documentation":"

    The VPC ID associated with your simulation job.

    " + }, + "assignPublicIp":{ + "shape":"Boolean", + "documentation":"

    A boolean indicating if a public IP was assigned.

    " + } + }, + "documentation":"

    VPC configuration associated with your simulation job.

    " + }, + "Version":{ + "type":"string", + "max":255, + "min":1, + "pattern":"(\\$LATEST)|[0-9]*" + }, + "VersionQualifier":{ + "type":"string", + "pattern":"ALL" + }, + "errorMessage":{"type":"string"} + }, + "documentation":"

    This section provides documentation for the AWS RoboMaker API operations.

    " +} diff --git a/aws/dist/botocore/data/route53/2013-04-01/examples-1.json b/aws/dist/botocore/data/route53/2013-04-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/route53/2013-04-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/route53/2013-04-01/paginators-1.json b/aws/dist/botocore/data/route53/2013-04-01/paginators-1.json new file mode 100644 index 00000000..8d8e433d --- /dev/null +++ b/aws/dist/botocore/data/route53/2013-04-01/paginators-1.json @@ -0,0 +1,49 @@ +{ + "pagination": { + "ListHealthChecks": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HealthChecks" + }, + "ListHostedZones": { + "input_token": "Marker", + "output_token": "NextMarker", + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "HostedZones" + }, + "ListResourceRecordSets": { + "more_results": "IsTruncated", + "limit_key": "MaxItems", + "result_key": "ResourceRecordSets", + "input_token": [ + "StartRecordName", + "StartRecordType", + "StartRecordIdentifier" + ], + "output_token": [ + "NextRecordName", + "NextRecordType", + "NextRecordIdentifier" + ] + }, + "ListVPCAssociationAuthorizations": { + "input_token": "NextToken", + "output_token": "NextToken", + "non_aggregate_keys": [ + "HostedZoneId" + ], + "result_key": [ + "VPCs" + ] + }, + "ListQueryLoggingConfigs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "QueryLoggingConfigs" + } + } +} diff --git a/aws/dist/botocore/data/route53/2013-04-01/service-2.json b/aws/dist/botocore/data/route53/2013-04-01/service-2.json new file mode 100644 index 00000000..5feb69ec --- /dev/null +++ b/aws/dist/botocore/data/route53/2013-04-01/service-2.json @@ -0,0 +1,5100 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-04-01", + "endpointPrefix":"route53", + "globalEndpoint":"route53.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"Route 53", + "serviceFullName":"Amazon Route 53", + "serviceId":"Route 53", + "signatureVersion":"v4", + "uid":"route53-2013-04-01" + }, + "operations":{ + "AssociateVPCWithHostedZone":{ + "name":"AssociateVPCWithHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/associatevpc" + }, + "input":{ + "shape":"AssociateVPCWithHostedZoneRequest", + "locationName":"AssociateVPCWithHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"AssociateVPCWithHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"NotAuthorizedException"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"}, + {"shape":"PublicZoneVPCAssociation"}, + {"shape":"ConflictingDomainExists"}, + {"shape":"LimitsExceeded"} + ], + "documentation":"

    Associates an Amazon VPC with a private hosted zone.

    To perform the association, the VPC and the private hosted zone must already exist. You can't convert a public hosted zone into a private hosted zone.

    If you want to associate a VPC that was created by using one AWS account with a private hosted zone that was created by using a different account, the AWS account that created the private hosted zone must first submit a CreateVPCAssociationAuthorization request. Then the account that created the VPC must submit an AssociateVPCWithHostedZone request.

    " + }, + "ChangeResourceRecordSets":{ + "name":"ChangeResourceRecordSets", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset/" + }, + "input":{ + "shape":"ChangeResourceRecordSetsRequest", + "locationName":"ChangeResourceRecordSetsRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ChangeResourceRecordSetsResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidChangeBatch"}, + {"shape":"InvalidInput"}, + {"shape":"PriorRequestNotComplete"} + ], + "documentation":"

    Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name. For example, you can use ChangeResourceRecordSets to create a resource record set that routes traffic for test.example.com to a web server that has an IP address of 192.0.2.44.

    Change Batches and Transactional Changes

    The request body must include a document with a ChangeResourceRecordSetsRequest element. The request body contains a list of change items, known as a change batch. Change batches are considered transactional changes. When using the Amazon Route 53 API to change resource record sets, Route 53 either makes all or none of the changes in a change batch request. This ensures that Route 53 never partially implements the intended changes to the resource record sets in a hosted zone.

    For example, a change batch request that deletes the CNAME record for www.example.com and creates an alias resource record set for www.example.com. Route 53 deletes the first resource record set and creates the second resource record set in a single operation. If either the DELETE or the CREATE action fails, then both changes (plus any other changes in the batch) fail, and the original CNAME record continues to exist.

    Due to the nature of transactional changes, you can't delete the same resource record set more than once in a single change batch. If you attempt to delete the same change batch more than once, Route 53 returns an InvalidChangeBatch error.

    Traffic Flow

    To create resource record sets for complex routing configurations, use either the traffic flow visual editor in the Route 53 console or the API actions for traffic policies and traffic policy instances. Save the configuration as a traffic policy, then associate the traffic policy with one or more domain names (such as example.com) or subdomain names (such as www.example.com), in the same hosted zone or in multiple hosted zones. You can roll back the updates if the new configuration isn't performing as expected. For more information, see Using Traffic Flow to Route DNS Traffic in the Amazon Route 53 Developer Guide.

    Create, Delete, and Upsert

    Use ChangeResourceRecordsSetsRequest to perform the following actions:

    • CREATE: Creates a resource record set that has the specified values.

    • DELETE: Deletes an existing resource record set that has the specified values.

    • UPSERT: If a resource record set does not already exist, AWS creates it. If a resource set does exist, Route 53 updates it with the values in the request.

    Syntaxes for Creating, Updating, and Deleting Resource Record Sets

    The syntax for a request depends on the type of resource record set that you want to create, delete, or update, such as weighted, alias, or failover. The XML elements in your request must appear in the order listed in the syntax.

    For an example for each type of resource record set, see \"Examples.\"

    Don't refer to the syntax in the \"Parameter Syntax\" section, which includes all of the elements for every kind of resource record set that you can create, delete, or update by using ChangeResourceRecordSets.

    Change Propagation to Route 53 DNS Servers

    When you submit a ChangeResourceRecordSets request, Route 53 propagates your changes to all of the Route 53 authoritative DNS servers. While your changes are propagating, GetChange returns a status of PENDING. When propagation is complete, GetChange returns a status of INSYNC. Changes generally propagate to all Route 53 name servers within 60 seconds. For more information, see GetChange.

    Limits on ChangeResourceRecordSets Requests

    For information about the limits on a ChangeResourceRecordSets request, see Limits in the Amazon Route 53 Developer Guide.

    " + }, + "ChangeTagsForResource":{ + "name":"ChangeTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{ + "shape":"ChangeTagsForResourceRequest", + "locationName":"ChangeTagsForResourceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ChangeTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Adds, edits, or deletes tags for a health check or a hosted zone.

    For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "CreateHealthCheck":{ + "name":"CreateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck", + "responseCode":201 + }, + "input":{ + "shape":"CreateHealthCheckRequest", + "locationName":"CreateHealthCheckRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateHealthCheckResponse"}, + "errors":[ + {"shape":"TooManyHealthChecks"}, + {"shape":"HealthCheckAlreadyExists"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Creates a new health check.

    For information about adding health checks to resource record sets, see HealthCheckId in ChangeResourceRecordSets.

    ELB Load Balancers

    If you're registering EC2 instances with an Elastic Load Balancing (ELB) load balancer, do not create Amazon Route 53 health checks for the EC2 instances. When you register an EC2 instance with a load balancer, you configure settings for an ELB health check, which performs a similar function to a Route 53 health check.

    Private Hosted Zones

    You can associate health checks with failover resource record sets in a private hosted zone. Note the following:

    • Route 53 health checkers are outside the VPC. To check the health of an endpoint within a VPC by IP address, you must assign a public IP address to the instance in the VPC.

    • You can configure a health checker to check the health of an external resource that the instance relies on, such as a database server.

    • You can create a CloudWatch metric, associate an alarm with the metric, and then create a health check that is based on the state of the alarm. For example, you might create a CloudWatch metric that checks the status of the Amazon EC2 StatusCheckFailed metric, add an alarm to the metric, and then create a health check that is based on the state of the alarm. For information about creating CloudWatch metrics and alarms by using the CloudWatch console, see the Amazon CloudWatch User Guide.

    " + }, + "CreateHostedZone":{ + "name":"CreateHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone", + "responseCode":201 + }, + "input":{ + "shape":"CreateHostedZoneRequest", + "locationName":"CreateHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateHostedZoneResponse"}, + "errors":[ + {"shape":"InvalidDomainName"}, + {"shape":"HostedZoneAlreadyExists"}, + {"shape":"TooManyHostedZones"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"}, + {"shape":"DelegationSetNotAvailable"}, + {"shape":"ConflictingDomainExists"}, + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"} + ], + "documentation":"

    Creates a new public or private hosted zone. You create records in a public hosted zone to define how you want to route traffic on the internet for a domain, such as example.com, and its subdomains (apex.example.com, acme.example.com). You create records in a private hosted zone to define how you want to route traffic for a domain and its subdomains within one or more Amazon Virtual Private Clouds (Amazon VPCs).

    You can't convert a public hosted zone to a private hosted zone or vice versa. Instead, you must create a new hosted zone with the same name and create new resource record sets.

    For more information about charges for hosted zones, see Amazon Route 53 Pricing.

    Note the following:

    • You can't create a hosted zone for a top-level domain (TLD) such as .com.

    • For public hosted zones, Amazon Route 53 automatically creates a default SOA record and four NS records for the zone. For more information about SOA and NS records, see NS and SOA Records that Route 53 Creates for a Hosted Zone in the Amazon Route 53 Developer Guide.

      If you want to use the same name servers for multiple public hosted zones, you can optionally associate a reusable delegation set with the hosted zone. See the DelegationSetId element.

    • If your domain is registered with a registrar other than Route 53, you must update the name servers with your registrar to make Route 53 the DNS service for the domain. For more information, see Migrating DNS Service for an Existing Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

    When you submit a CreateHostedZone request, the initial status of the hosted zone is PENDING. For public hosted zones, this means that the NS and SOA records are not yet available on all Route 53 DNS servers. When the NS and SOA records are available, the status of the zone changes to INSYNC.

    " + }, + "CreateQueryLoggingConfig":{ + "name":"CreateQueryLoggingConfig", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/queryloggingconfig", + "responseCode":201 + }, + "input":{ + "shape":"CreateQueryLoggingConfigRequest", + "locationName":"CreateQueryLoggingConfigRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateQueryLoggingConfigResponse"}, + "errors":[ + {"shape":"ConcurrentModification"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"NoSuchCloudWatchLogsLogGroup"}, + {"shape":"InvalidInput"}, + {"shape":"QueryLoggingConfigAlreadyExists"}, + {"shape":"InsufficientCloudWatchLogsResourcePolicy"} + ], + "documentation":"

    Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group.

    DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following:

    • Route 53 edge location that responded to the DNS query

    • Domain or subdomain that was requested

    • DNS record type, such as A or AAAA

    • DNS response code, such as NoError or ServFail

    Log Group and Resource Policy

    Before you create a query logging configuration, perform the following operations.

    If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically.

    1. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following:

      • You must create the log group in the us-east-1 region.

      • You must use the same AWS account to create the log group and the hosted zone that you want to configure query logging for.

      • When you create log groups for query logging, we recommend that you use a consistent prefix, for example:

        /aws/route53/hosted zone name

        In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated AWS resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging.

    2. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example:

      arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/*

      You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the AWS SDKs, or the AWS CLI.
    Log Streams and Edge Locations

    When Route 53 finishes creating the configuration for DNS query logging, it does the following:

    • Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location.

    • Begins to send query logs to the applicable log stream.

    The name of each log stream is in the following format:

    hosted zone ID/edge location code

    The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see \"The Route 53 Global Network\" on the Route 53 Product Details page.

    Queries That Are Logged

    Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide.

    Log File Format

    For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide.

    Pricing

    For information about charges for query logs, see Amazon CloudWatch Pricing.

    How to Stop Logging

    If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig.

    " + }, + "CreateReusableDelegationSet":{ + "name":"CreateReusableDelegationSet", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/delegationset", + "responseCode":201 + }, + "input":{ + "shape":"CreateReusableDelegationSetRequest", + "locationName":"CreateReusableDelegationSetRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateReusableDelegationSetResponse"}, + "errors":[ + {"shape":"DelegationSetAlreadyCreated"}, + {"shape":"LimitsExceeded"}, + {"shape":"HostedZoneNotFound"}, + {"shape":"InvalidArgument"}, + {"shape":"InvalidInput"}, + {"shape":"DelegationSetNotAvailable"}, + {"shape":"DelegationSetAlreadyReusable"} + ], + "documentation":"

    Creates a delegation set (a group of four name servers) that can be reused by multiple hosted zones. If a hosted zoned ID is specified, CreateReusableDelegationSet marks the delegation set associated with that zone as reusable.

    You can't associate a reusable delegation set with a private hosted zone.

    For information about using a reusable delegation set to configure white label name servers, see Configuring White Label Name Servers.

    The process for migrating existing hosted zones to use a reusable delegation set is comparable to the process for configuring white label name servers. You need to perform the following steps:

    1. Create a reusable delegation set.

    2. Recreate hosted zones, and reduce the TTL to 60 seconds or less.

    3. Recreate resource record sets in the new hosted zones.

    4. Change the registrar's name servers to use the name servers for the new hosted zones.

    5. Monitor traffic for the website or application.

    6. Change TTLs back to their original values.

    If you want to migrate existing hosted zones to use a reusable delegation set, the existing hosted zones can't use any of the name servers that are assigned to the reusable delegation set. If one or more hosted zones do use one or more name servers that are assigned to the reusable delegation set, you can do one of the following:

    • For small numbers of hosted zones—up to a few hundred—it's relatively easy to create reusable delegation sets until you get one that has four name servers that don't overlap with any of the name servers in your hosted zones.

    • For larger numbers of hosted zones, the easiest solution is to use more than one reusable delegation set.

    • For larger numbers of hosted zones, you can also migrate hosted zones that have overlapping name servers to hosted zones that don't have overlapping name servers, then migrate the hosted zones again to use the reusable delegation set.

    " + }, + "CreateTrafficPolicy":{ + "name":"CreateTrafficPolicy", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyRequest", + "locationName":"CreateTrafficPolicyRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"TooManyTrafficPolicies"}, + {"shape":"TrafficPolicyAlreadyExists"}, + {"shape":"InvalidTrafficPolicyDocument"} + ], + "documentation":"

    Creates a traffic policy, which you use to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com).

    " + }, + "CreateTrafficPolicyInstance":{ + "name":"CreateTrafficPolicyInstance", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicyinstance", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyInstanceRequest", + "locationName":"CreateTrafficPolicyInstanceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"}, + {"shape":"TooManyTrafficPolicyInstances"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"TrafficPolicyInstanceAlreadyExists"} + ], + "documentation":"

    Creates resource record sets in a specified hosted zone based on the settings in a specified traffic policy version. In addition, CreateTrafficPolicyInstance associates the resource record sets with a specified domain name (such as example.com) or subdomain name (such as www.example.com). Amazon Route 53 responds to DNS queries for the domain or subdomain name by using the resource record sets that CreateTrafficPolicyInstance created.

    " + }, + "CreateTrafficPolicyVersion":{ + "name":"CreateTrafficPolicyVersion", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy/{Id}", + "responseCode":201 + }, + "input":{ + "shape":"CreateTrafficPolicyVersionRequest", + "locationName":"CreateTrafficPolicyVersionRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateTrafficPolicyVersionResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"}, + {"shape":"TooManyTrafficPolicyVersionsForCurrentPolicy"}, + {"shape":"ConcurrentModification"}, + {"shape":"InvalidTrafficPolicyDocument"} + ], + "documentation":"

    Creates a new version of an existing traffic policy. When you create a new version of a traffic policy, you specify the ID of the traffic policy that you want to update and a JSON-formatted document that describes the new version. You use traffic policies to create multiple DNS resource record sets for one domain name (such as example.com) or one subdomain name (such as www.example.com). You can create a maximum of 1000 versions of a traffic policy. If you reach the limit and need to create another version, you'll need to start a new traffic policy.

    " + }, + "CreateVPCAssociationAuthorization":{ + "name":"CreateVPCAssociationAuthorization", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/authorizevpcassociation" + }, + "input":{ + "shape":"CreateVPCAssociationAuthorizationRequest", + "locationName":"CreateVPCAssociationAuthorizationRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"CreateVPCAssociationAuthorizationResponse"}, + "errors":[ + {"shape":"ConcurrentModification"}, + {"shape":"TooManyVPCAssociationAuthorizations"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Authorizes the AWS account that created a specified VPC to submit an AssociateVPCWithHostedZone request to associate the VPC with a specified hosted zone that was created by a different account. To submit a CreateVPCAssociationAuthorization request, you must use the account that created the hosted zone. After you authorize the association, use the account that created the VPC to submit an AssociateVPCWithHostedZone request.

    If you want to associate multiple VPCs that you created by using one account with a hosted zone that you created by using a different account, you must submit one authorization request for each VPC.

    " + }, + "DeleteHealthCheck":{ + "name":"DeleteHealthCheck", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{"shape":"DeleteHealthCheckRequest"}, + "output":{"shape":"DeleteHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"HealthCheckInUse"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Deletes a health check.

    Amazon Route 53 does not prevent you from deleting a health check even if the health check is associated with one or more resource record sets. If you delete a health check and you don't update the associated resource record sets, the future status of the health check can't be predicted and may change. This will affect the routing of DNS queries for your DNS failover configuration. For more information, see Replacing and Deleting Health Checks in the Amazon Route 53 Developer Guide.

    " + }, + "DeleteHostedZone":{ + "name":"DeleteHostedZone", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{"shape":"DeleteHostedZoneRequest"}, + "output":{"shape":"DeleteHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"HostedZoneNotEmpty"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"InvalidInput"}, + {"shape":"InvalidDomainName"} + ], + "documentation":"

    Deletes a hosted zone.

    If the hosted zone was created by another service, such as AWS Cloud Map, see Deleting Public Hosted Zones That Were Created by Another Service in the Amazon Route 53 Developer Guide for information about how to delete it. (The process is the same for public and private hosted zones that were created by another service.)

    If you want to keep your domain registration but you want to stop routing internet traffic to your website or web application, we recommend that you delete resource record sets in the hosted zone instead of deleting the hosted zone.

    If you delete a hosted zone, you can't undelete it. You must create a new hosted zone and update the name servers for your domain registration, which can require up to 48 hours to take effect. (If you delegated responsibility for a subdomain to a hosted zone and you delete the child hosted zone, you must update the name servers in the parent hosted zone.) In addition, if you delete a hosted zone, someone could hijack the domain and route traffic to their own resources using your domain name.

    If you want to avoid the monthly charge for the hosted zone, you can transfer DNS service for the domain to a free DNS service. When you transfer DNS service, you have to update the name servers for the domain registration. If the domain is registered with Route 53, see UpdateDomainNameservers for information about how to replace Route 53 name servers with name servers for the new DNS service. If the domain is registered with another registrar, use the method provided by the registrar to update name servers for the domain registration. For more information, perform an internet search on \"free DNS service.\"

    You can delete a hosted zone only if it contains only the default SOA record and NS resource record sets. If the hosted zone contains other resource record sets, you must delete them before you can delete the hosted zone. If you try to delete a hosted zone that contains other resource record sets, the request fails, and Route 53 returns a HostedZoneNotEmpty error. For information about deleting records from your hosted zone, see ChangeResourceRecordSets.

    To verify that the hosted zone has been deleted, do one of the following:

    • Use the GetHostedZone action to request information about the hosted zone.

    • Use the ListHostedZones action to get a list of the hosted zones associated with the current AWS account.

    " + }, + "DeleteQueryLoggingConfig":{ + "name":"DeleteQueryLoggingConfig", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/queryloggingconfig/{Id}" + }, + "input":{"shape":"DeleteQueryLoggingConfigRequest"}, + "output":{"shape":"DeleteQueryLoggingConfigResponse"}, + "errors":[ + {"shape":"ConcurrentModification"}, + {"shape":"NoSuchQueryLoggingConfig"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Deletes a configuration for DNS query logging. If you delete a configuration, Amazon Route 53 stops sending query logs to CloudWatch Logs. Route 53 doesn't delete any logs that are already in CloudWatch Logs.

    For more information about DNS query logs, see CreateQueryLoggingConfig.

    " + }, + "DeleteReusableDelegationSet":{ + "name":"DeleteReusableDelegationSet", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/delegationset/{Id}" + }, + "input":{"shape":"DeleteReusableDelegationSetRequest"}, + "output":{"shape":"DeleteReusableDelegationSetResponse"}, + "errors":[ + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetInUse"}, + {"shape":"DelegationSetNotReusable"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Deletes a reusable delegation set.

    You can delete a reusable delegation set only if it isn't associated with any hosted zones.

    To verify that the reusable delegation set is not associated with any hosted zones, submit a GetReusableDelegationSet request and specify the ID of the reusable delegation set that you want to delete.

    " + }, + "DeleteTrafficPolicy":{ + "name":"DeleteTrafficPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{"shape":"DeleteTrafficPolicyRequest"}, + "output":{"shape":"DeleteTrafficPolicyResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"}, + {"shape":"TrafficPolicyInUse"}, + {"shape":"ConcurrentModification"} + ], + "documentation":"

    Deletes a traffic policy.

    " + }, + "DeleteTrafficPolicyInstance":{ + "name":"DeleteTrafficPolicyInstance", + "http":{ + "method":"DELETE", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{"shape":"DeleteTrafficPolicyInstanceRequest"}, + "output":{"shape":"DeleteTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"InvalidInput"}, + {"shape":"PriorRequestNotComplete"} + ], + "documentation":"

    Deletes a traffic policy instance and all of the resource record sets that Amazon Route 53 created when you created the instance.

    In the Route 53 console, traffic policy instances are known as policy records.

    " + }, + "DeleteVPCAssociationAuthorization":{ + "name":"DeleteVPCAssociationAuthorization", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/deauthorizevpcassociation" + }, + "input":{ + "shape":"DeleteVPCAssociationAuthorizationRequest", + "locationName":"DeleteVPCAssociationAuthorizationRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"DeleteVPCAssociationAuthorizationResponse"}, + "errors":[ + {"shape":"ConcurrentModification"}, + {"shape":"VPCAssociationAuthorizationNotFound"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidVPCId"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Removes authorization to submit an AssociateVPCWithHostedZone request to associate a specified VPC with a hosted zone that was created by a different account. You must use the account that created the hosted zone to submit a DeleteVPCAssociationAuthorization request.

    Sending this request only prevents the AWS account that created the VPC from associating the VPC with the Amazon Route 53 hosted zone in the future. If the VPC is already associated with the hosted zone, DeleteVPCAssociationAuthorization won't disassociate the VPC from the hosted zone. If you want to delete an existing association, use DisassociateVPCFromHostedZone.

    " + }, + "DisassociateVPCFromHostedZone":{ + "name":"DisassociateVPCFromHostedZone", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}/disassociatevpc" + }, + "input":{ + "shape":"DisassociateVPCFromHostedZoneRequest", + "locationName":"DisassociateVPCFromHostedZoneRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"DisassociateVPCFromHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidVPCId"}, + {"shape":"VPCAssociationNotFound"}, + {"shape":"LastVPCAssociation"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Disassociates a VPC from a Amazon Route 53 private hosted zone. Note the following:

    • You can't disassociate the last VPC from a private hosted zone.

    • You can't convert a private hosted zone into a public hosted zone.

    • You can submit a DisassociateVPCFromHostedZone request using either the account that created the hosted zone or the account that created the VPC.

    " + }, + "GetAccountLimit":{ + "name":"GetAccountLimit", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/accountlimit/{Type}" + }, + "input":{"shape":"GetAccountLimitRequest"}, + "output":{"shape":"GetAccountLimitResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets the specified limit for the current account, for example, the maximum number of health checks that you can create using the account.

    For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

    You can also view account limits in AWS Trusted Advisor. Sign in to the AWS Management Console and open the Trusted Advisor console at https://console.aws.amazon.com/trustedadvisor/. Then choose Service limits in the navigation pane.

    " + }, + "GetChange":{ + "name":"GetChange", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/change/{Id}" + }, + "input":{"shape":"GetChangeRequest"}, + "output":{"shape":"GetChangeResponse"}, + "errors":[ + {"shape":"NoSuchChange"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Returns the current status of a change batch request. The status is one of the following values:

    • PENDING indicates that the changes in this request have not propagated to all Amazon Route 53 DNS servers. This is the initial status of all change batch requests.

    • INSYNC indicates that the changes have propagated to all Route 53 DNS servers.

    " + }, + "GetCheckerIpRanges":{ + "name":"GetCheckerIpRanges", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/checkeripranges" + }, + "input":{"shape":"GetCheckerIpRangesRequest"}, + "output":{"shape":"GetCheckerIpRangesResponse"}, + "documentation":"

    GetCheckerIpRanges still works, but we recommend that you download ip-ranges.json, which includes IP address ranges for all AWS services. For more information, see IP Address Ranges of Amazon Route 53 Servers in the Amazon Route 53 Developer Guide.

    " + }, + "GetGeoLocation":{ + "name":"GetGeoLocation", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocation" + }, + "input":{"shape":"GetGeoLocationRequest"}, + "output":{"shape":"GetGeoLocationResponse"}, + "errors":[ + {"shape":"NoSuchGeoLocation"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

    Use the following syntax to determine whether a continent is supported for geolocation:

    GET /2013-04-01/geolocation?continentcode=two-letter abbreviation for a continent

    Use the following syntax to determine whether a country is supported for geolocation:

    GET /2013-04-01/geolocation?countrycode=two-character country code

    Use the following syntax to determine whether a subdivision of a country is supported for geolocation:

    GET /2013-04-01/geolocation?countrycode=two-character country code&subdivisioncode=subdivision code

    " + }, + "GetHealthCheck":{ + "name":"GetHealthCheck", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{"shape":"GetHealthCheckRequest"}, + "output":{"shape":"GetHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"}, + {"shape":"IncompatibleVersion"} + ], + "documentation":"

    Gets information about a specified health check.

    " + }, + "GetHealthCheckCount":{ + "name":"GetHealthCheckCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheckcount" + }, + "input":{"shape":"GetHealthCheckCountRequest"}, + "output":{"shape":"GetHealthCheckCountResponse"}, + "documentation":"

    Retrieves the number of health checks that are associated with the current AWS account.

    " + }, + "GetHealthCheckLastFailureReason":{ + "name":"GetHealthCheckLastFailureReason", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/lastfailurereason" + }, + "input":{"shape":"GetHealthCheckLastFailureReasonRequest"}, + "output":{"shape":"GetHealthCheckLastFailureReasonResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets the reason that a specified health check failed most recently.

    " + }, + "GetHealthCheckStatus":{ + "name":"GetHealthCheckStatus", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}/status" + }, + "input":{"shape":"GetHealthCheckStatusRequest"}, + "output":{"shape":"GetHealthCheckStatusResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets status of a specified health check.

    " + }, + "GetHostedZone":{ + "name":"GetHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{"shape":"GetHostedZoneRequest"}, + "output":{"shape":"GetHostedZoneResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about a specified hosted zone including the four name servers assigned to the hosted zone.

    " + }, + "GetHostedZoneCount":{ + "name":"GetHostedZoneCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzonecount" + }, + "input":{"shape":"GetHostedZoneCountRequest"}, + "output":{"shape":"GetHostedZoneCountResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Retrieves the number of hosted zones that are associated with the current AWS account.

    " + }, + "GetHostedZoneLimit":{ + "name":"GetHostedZoneLimit", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzonelimit/{Id}/{Type}" + }, + "input":{"shape":"GetHostedZoneLimitRequest"}, + "output":{"shape":"GetHostedZoneLimitResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"}, + {"shape":"HostedZoneNotPrivate"} + ], + "documentation":"

    Gets the specified limit for a specified hosted zone, for example, the maximum number of records that you can create in the hosted zone.

    For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

    " + }, + "GetQueryLoggingConfig":{ + "name":"GetQueryLoggingConfig", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/queryloggingconfig/{Id}" + }, + "input":{"shape":"GetQueryLoggingConfigRequest"}, + "output":{"shape":"GetQueryLoggingConfigResponse"}, + "errors":[ + {"shape":"NoSuchQueryLoggingConfig"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about a specified configuration for DNS query logging.

    For more information about DNS query logs, see CreateQueryLoggingConfig and Logging DNS Queries.

    " + }, + "GetReusableDelegationSet":{ + "name":"GetReusableDelegationSet", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/delegationset/{Id}" + }, + "input":{"shape":"GetReusableDelegationSetRequest"}, + "output":{"shape":"GetReusableDelegationSetResponse"}, + "errors":[ + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Retrieves information about a specified reusable delegation set, including the four name servers that are assigned to the delegation set.

    " + }, + "GetReusableDelegationSetLimit":{ + "name":"GetReusableDelegationSetLimit", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/reusabledelegationsetlimit/{Id}/{Type}" + }, + "input":{"shape":"GetReusableDelegationSetLimitRequest"}, + "output":{"shape":"GetReusableDelegationSetLimitResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchDelegationSet"} + ], + "documentation":"

    Gets the maximum number of hosted zones that you can associate with the specified reusable delegation set.

    For the default limit, see Limits in the Amazon Route 53 Developer Guide. To request a higher limit, open a case.

    " + }, + "GetTrafficPolicy":{ + "name":"GetTrafficPolicy", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{"shape":"GetTrafficPolicyRequest"}, + "output":{"shape":"GetTrafficPolicyResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about a specific traffic policy version.

    " + }, + "GetTrafficPolicyInstance":{ + "name":"GetTrafficPolicyInstance", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{"shape":"GetTrafficPolicyInstanceRequest"}, + "output":{"shape":"GetTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about a specified traffic policy instance.

    After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

    In the Route 53 console, traffic policy instances are known as policy records.

    " + }, + "GetTrafficPolicyInstanceCount":{ + "name":"GetTrafficPolicyInstanceCount", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstancecount" + }, + "input":{"shape":"GetTrafficPolicyInstanceCountRequest"}, + "output":{"shape":"GetTrafficPolicyInstanceCountResponse"}, + "documentation":"

    Gets the number of traffic policy instances that are associated with the current AWS account.

    " + }, + "ListGeoLocations":{ + "name":"ListGeoLocations", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/geolocations" + }, + "input":{"shape":"ListGeoLocationsRequest"}, + "output":{"shape":"ListGeoLocationsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Retrieves a list of supported geographic locations.

    Countries are listed first, and continents are listed last. If Amazon Route 53 supports subdivisions for a country (for example, states or provinces), the subdivisions for that country are listed in alphabetical order immediately after the corresponding country.

    " + }, + "ListHealthChecks":{ + "name":"ListHealthChecks", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/healthcheck" + }, + "input":{"shape":"ListHealthChecksRequest"}, + "output":{"shape":"ListHealthChecksResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"IncompatibleVersion"} + ], + "documentation":"

    Retrieve a list of the health checks that are associated with the current AWS account.

    " + }, + "ListHostedZones":{ + "name":"ListHostedZones", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone" + }, + "input":{"shape":"ListHostedZonesRequest"}, + "output":{"shape":"ListHostedZonesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchDelegationSet"}, + {"shape":"DelegationSetNotReusable"} + ], + "documentation":"

    Retrieves a list of the public and private hosted zones that are associated with the current AWS account. The response includes a HostedZones child element for each hosted zone.

    Amazon Route 53 returns a maximum of 100 items in each response. If you have a lot of hosted zones, you can use the maxitems parameter to list them in groups of up to 100.

    " + }, + "ListHostedZonesByName":{ + "name":"ListHostedZonesByName", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzonesbyname" + }, + "input":{"shape":"ListHostedZonesByNameRequest"}, + "output":{"shape":"ListHostedZonesByNameResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"InvalidDomainName"} + ], + "documentation":"

    Retrieves a list of your hosted zones in lexicographic order. The response includes a HostedZones child element for each hosted zone created by the current AWS account.

    ListHostedZonesByName sorts hosted zones by name with the labels reversed. For example:

    com.example.www.

    Note the trailing dot, which can change the sort order in some circumstances.

    If the domain name includes escape characters or Punycode, ListHostedZonesByName alphabetizes the domain name using the escaped or Punycoded value, which is the format that Amazon Route 53 saves in its database. For example, to create a hosted zone for exämple.com, you specify ex\\344mple.com for the domain name. ListHostedZonesByName alphabetizes it as:

    com.ex\\344mple.

    The labels are reversed and alphabetized using the escaped value. For more information about valid domain name formats, including internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

    Route 53 returns up to 100 items in each response. If you have a lot of hosted zones, use the MaxItems parameter to list them in groups of up to 100. The response includes values that help navigate from one group of MaxItems hosted zones to the next:

    • The DNSName and HostedZoneId elements in the response contain the values, if any, specified for the dnsname and hostedzoneid parameters in the request that produced the current response.

    • The MaxItems element in the response contains the value, if any, that you specified for the maxitems parameter in the request that produced the current response.

    • If the value of IsTruncated in the response is true, there are more hosted zones associated with the current AWS account.

      If IsTruncated is false, this response includes the last hosted zone that is associated with the current account. The NextDNSName element and NextHostedZoneId elements are omitted from the response.

    • The NextDNSName and NextHostedZoneId elements in the response contain the domain name and the hosted zone ID of the next hosted zone that is associated with the current AWS account. If you want to list more hosted zones, make another call to ListHostedZonesByName, and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    " + }, + "ListQueryLoggingConfigs":{ + "name":"ListQueryLoggingConfigs", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/queryloggingconfig" + }, + "input":{"shape":"ListQueryLoggingConfigsRequest"}, + "output":{"shape":"ListQueryLoggingConfigsResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"InvalidPaginationToken"}, + {"shape":"NoSuchHostedZone"} + ], + "documentation":"

    Lists the configurations for DNS query logging that are associated with the current AWS account or the configuration that is associated with a specified hosted zone.

    For more information about DNS query logs, see CreateQueryLoggingConfig. Additional information, including the format of DNS query logs, appears in Logging DNS Queries in the Amazon Route 53 Developer Guide.

    " + }, + "ListResourceRecordSets":{ + "name":"ListResourceRecordSets", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/rrset" + }, + "input":{"shape":"ListResourceRecordSetsRequest"}, + "output":{"shape":"ListResourceRecordSetsResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Lists the resource record sets in a specified hosted zone.

    ListResourceRecordSets returns up to 100 resource record sets at a time in ASCII order, beginning at a position specified by the name and type elements.

    Sort order

    ListResourceRecordSets sorts results first by DNS name with the labels reversed, for example:

    com.example.www.

    Note the trailing dot, which can change the sort order when the record name contains characters that appear before . (decimal 46) in the ASCII table. These characters include the following: ! \" # $ % & ' ( ) * + , -

    When multiple records have the same DNS name, ListResourceRecordSets sorts results by the record type.

    Specifying where to start listing records

    You can use the name and type elements to specify the resource record set that the list begins with:

    If you do not specify Name or Type

    The results begin with the first resource record set that the hosted zone contains.

    If you specify Name but not Type

    The results begin with the first resource record set in the list whose name is greater than or equal to Name.

    If you specify Type but not Name

    Amazon Route 53 returns the InvalidInput error.

    If you specify both Name and Type

    The results begin with the first resource record set in the list whose name is greater than or equal to Name, and whose type is greater than or equal to Type.

    Resource record sets that are PENDING

    This action returns the most current version of the records. This includes records that are PENDING, and that are not yet available on all Route 53 DNS servers.

    Changing resource record sets

    To ensure that you get an accurate listing of the resource record sets for a hosted zone at a point in time, do not submit a ChangeResourceRecordSets request while you're paging through the results of a ListResourceRecordSets request. If you do, some pages may display results without the latest changes while other pages display results with the latest changes.

    Displaying the next page of results

    If a ListResourceRecordSets command returns more than one page of results, the value of IsTruncated is true. To display the next page of results, get the values of NextRecordName, NextRecordType, and NextRecordIdentifier (if any) from the response. Then submit another ListResourceRecordSets request, and specify those values for StartRecordName, StartRecordType, and StartRecordIdentifier.

    " + }, + "ListReusableDelegationSets":{ + "name":"ListReusableDelegationSets", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/delegationset" + }, + "input":{"shape":"ListReusableDelegationSetsRequest"}, + "output":{"shape":"ListReusableDelegationSetsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Retrieves a list of the reusable delegation sets that are associated with the current AWS account.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/tags/{ResourceType}/{ResourceId}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists tags for one health check or hosted zone.

    For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "ListTagsForResources":{ + "name":"ListTagsForResources", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/tags/{ResourceType}" + }, + "input":{ + "shape":"ListTagsForResourcesRequest", + "locationName":"ListTagsForResourcesRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"ListTagsForResourcesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchHealthCheck"}, + {"shape":"NoSuchHostedZone"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists tags for up to 10 health checks or hosted zones.

    For information about using tags for cost allocation, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "ListTrafficPolicies":{ + "name":"ListTrafficPolicies", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicies" + }, + "input":{"shape":"ListTrafficPoliciesRequest"}, + "output":{"shape":"ListTrafficPoliciesResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets information about the latest version for every traffic policy that is associated with the current AWS account. Policies are listed in the order that they were created in.

    " + }, + "ListTrafficPolicyInstances":{ + "name":"ListTrafficPolicyInstances", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances" + }, + "input":{"shape":"ListTrafficPolicyInstancesRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"} + ], + "documentation":"

    Gets information about the traffic policy instances that you created by using the current AWS account.

    After you submit an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

    Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

    " + }, + "ListTrafficPolicyInstancesByHostedZone":{ + "name":"ListTrafficPolicyInstancesByHostedZone", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances/hostedzone" + }, + "input":{"shape":"ListTrafficPolicyInstancesByHostedZoneRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesByHostedZoneResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"NoSuchHostedZone"} + ], + "documentation":"

    Gets information about the traffic policy instances that you created in a specified hosted zone.

    After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

    Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

    " + }, + "ListTrafficPolicyInstancesByPolicy":{ + "name":"ListTrafficPolicyInstancesByPolicy", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicyinstances/trafficpolicy" + }, + "input":{"shape":"ListTrafficPolicyInstancesByPolicyRequest"}, + "output":{"shape":"ListTrafficPolicyInstancesByPolicyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"NoSuchTrafficPolicy"} + ], + "documentation":"

    Gets information about the traffic policy instances that you created by using a specify traffic policy version.

    After you submit a CreateTrafficPolicyInstance or an UpdateTrafficPolicyInstance request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State response element.

    Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems parameter to list them in groups of up to 100.

    " + }, + "ListTrafficPolicyVersions":{ + "name":"ListTrafficPolicyVersions", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/trafficpolicies/{Id}/versions" + }, + "input":{"shape":"ListTrafficPolicyVersionsRequest"}, + "output":{"shape":"ListTrafficPolicyVersionsResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"} + ], + "documentation":"

    Gets information about all of the versions for a specified traffic policy.

    Traffic policy versions are listed in numerical order by VersionNumber.

    " + }, + "ListVPCAssociationAuthorizations":{ + "name":"ListVPCAssociationAuthorizations", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/hostedzone/{Id}/authorizevpcassociation" + }, + "input":{"shape":"ListVPCAssociationAuthorizationsRequest"}, + "output":{"shape":"ListVPCAssociationAuthorizationsResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"}, + {"shape":"InvalidPaginationToken"} + ], + "documentation":"

    Gets a list of the VPCs that were created by other accounts and that can be associated with a specified hosted zone because you've submitted one or more CreateVPCAssociationAuthorization requests.

    The response includes a VPCs element with a VPC child element for each VPC that can be associated with the hosted zone.

    " + }, + "TestDNSAnswer":{ + "name":"TestDNSAnswer", + "http":{ + "method":"GET", + "requestUri":"/2013-04-01/testdnsanswer" + }, + "input":{"shape":"TestDNSAnswerRequest"}, + "output":{"shape":"TestDNSAnswerResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

    " + }, + "UpdateHealthCheck":{ + "name":"UpdateHealthCheck", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/healthcheck/{HealthCheckId}" + }, + "input":{ + "shape":"UpdateHealthCheckRequest", + "locationName":"UpdateHealthCheckRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateHealthCheckResponse"}, + "errors":[ + {"shape":"NoSuchHealthCheck"}, + {"shape":"InvalidInput"}, + {"shape":"HealthCheckVersionMismatch"} + ], + "documentation":"

    Updates an existing health check. Note that some values can't be updated.

    For more information about updating health checks, see Creating, Updating, and Deleting Health Checks in the Amazon Route 53 Developer Guide.

    " + }, + "UpdateHostedZoneComment":{ + "name":"UpdateHostedZoneComment", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/hostedzone/{Id}" + }, + "input":{ + "shape":"UpdateHostedZoneCommentRequest", + "locationName":"UpdateHostedZoneCommentRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateHostedZoneCommentResponse"}, + "errors":[ + {"shape":"NoSuchHostedZone"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Updates the comment for a specified hosted zone.

    " + }, + "UpdateTrafficPolicyComment":{ + "name":"UpdateTrafficPolicyComment", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicy/{Id}/{Version}" + }, + "input":{ + "shape":"UpdateTrafficPolicyCommentRequest", + "locationName":"UpdateTrafficPolicyCommentRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateTrafficPolicyCommentResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"ConcurrentModification"} + ], + "documentation":"

    Updates the comment for a specified traffic policy version.

    " + }, + "UpdateTrafficPolicyInstance":{ + "name":"UpdateTrafficPolicyInstance", + "http":{ + "method":"POST", + "requestUri":"/2013-04-01/trafficpolicyinstance/{Id}" + }, + "input":{ + "shape":"UpdateTrafficPolicyInstanceRequest", + "locationName":"UpdateTrafficPolicyInstanceRequest", + "xmlNamespace":{"uri":"https://route53.amazonaws.com/doc/2013-04-01/"} + }, + "output":{"shape":"UpdateTrafficPolicyInstanceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NoSuchTrafficPolicy"}, + {"shape":"NoSuchTrafficPolicyInstance"}, + {"shape":"PriorRequestNotComplete"}, + {"shape":"ConflictingTypes"} + ], + "documentation":"

    Updates the resource record sets in a specified hosted zone that were created based on the settings in a specified traffic policy version.

    When you update a traffic policy instance, Amazon Route 53 continues to respond to DNS queries for the root resource record set name (such as example.com) while it replaces one group of resource record sets with another. Route 53 performs the following operations:

    1. Route 53 creates a new group of resource record sets based on the specified traffic policy. This is true regardless of how significant the differences are between the existing resource record sets and the new resource record sets.

    2. When all of the new resource record sets have been created, Route 53 starts to respond to DNS queries for the root resource record set name (such as example.com) by using the new resource record sets.

    3. Route 53 deletes the old group of resource record sets that are associated with the root resource record set name.

    " + } + }, + "shapes":{ + "AccountLimit":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"AccountLimitType", + "documentation":"

    The limit that you requested. Valid values include the following:

    • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.

    • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.

    • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.

    • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.

    • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

    " + }, + "Value":{ + "shape":"LimitValue", + "documentation":"

    The current value for the limit that is specified by Type.

    " + } + }, + "documentation":"

    A complex type that contains the type of limit that you specified in the request and the current value for that limit.

    " + }, + "AccountLimitType":{ + "type":"string", + "enum":[ + "MAX_HEALTH_CHECKS_BY_OWNER", + "MAX_HOSTED_ZONES_BY_OWNER", + "MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER", + "MAX_REUSABLE_DELEGATION_SETS_BY_OWNER", + "MAX_TRAFFIC_POLICIES_BY_OWNER" + ] + }, + "AlarmIdentifier":{ + "type":"structure", + "required":[ + "Region", + "Name" + ], + "members":{ + "Region":{ + "shape":"CloudWatchRegion", + "documentation":"

    For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

    For the current list of CloudWatch regions, see Amazon CloudWatch in the AWS Regions and Endpoints chapter of the Amazon Web Services General Reference.

    " + }, + "Name":{ + "shape":"AlarmName", + "documentation":"

    The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

    Route 53 supports CloudWatch alarms with the following features:

    • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.

    • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

    " + } + }, + "documentation":"

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

    " + }, + "AlarmName":{ + "type":"string", + "max":256, + "min":1 + }, + "AliasHealthEnabled":{"type":"boolean"}, + "AliasTarget":{ + "type":"structure", + "required":[ + "HostedZoneId", + "DNSName", + "EvaluateTargetHealth" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    Alias resource records sets only: The value used depends on where you want to route traffic:

    Amazon API Gateway custom regional APIs and edge-optimized APIs

    Specify the hosted zone ID for your API. You can get the applicable value using the AWS CLI command get-domain-names:

    • For regional APIs, specify the value of regionalHostedZoneId.

    • For edge-optimized APIs, specify the value of distributionHostedZoneId.

    Amazon Virtual Private Cloud interface VPC endpoint

    Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the AWS CLI command describe-vpc-endpoints.

    CloudFront distribution

    Specify Z2FDTNDATAQYW2.

    Alias resource record sets for CloudFront can't be created in a private zone.
    Elastic Beanstalk environment

    Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference.

    ELB load balancer

    Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

    • Elastic Load Balancing table in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

    • AWS Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

    • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

    • AWS CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

    An Amazon S3 bucket configured as a static website

    Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the Amazon Simple Storage Service Website Endpoints table in the \"AWS Regions and Endpoints\" chapter of the Amazon Web Services General Reference.

    Another Route 53 resource record set in your hosted zone

    Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

    " + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

    Alias resource record sets only: The value that you specify depends on where you want to route queries:

    Amazon API Gateway custom regional APIs and edge-optimized APIs

    Specify the applicable domain name for your API. You can get the applicable value using the AWS CLI command get-domain-names:

    • For regional APIs, specify the value of regionalDomainName.

    • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

    The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.
    Amazon Virtual Private Cloud interface VPC endpoint

    Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the AWS CLI command describe-vpc-endpoints.

    CloudFront distribution

    Specify the domain name that CloudFront assigned when you created your distribution.

    Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

    You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

    For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

    Elastic Beanstalk environment

    If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

    For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

    For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

    • AWS Management Console: For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide.

    • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference.

    • AWS CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference.

    ELB load balancer

    Specify the DNS name that is associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI.

    • AWS Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

      If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

    • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

    • AWS CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

    Amazon S3 bucket that is configured as a static website

    Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    Another Route 53 resource record set

    Specify the value of the Name element for a resource record set in the current hosted zone.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
    " + }, + "EvaluateTargetHealth":{ + "shape":"AliasHealthEnabled", + "documentation":"

    Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced AWS resource, such as an ELB load balancer or another resource record set in the hosted zone.

    Note the following:

    CloudFront distributions

    You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

    Elastic Beanstalk environments that have regionalized subdomains

    If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

    If the environment contains a single Amazon EC2 instance, there are no special requirements.

    ELB load balancers

    Health checking behavior depends on the type of load balancer:

    • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

    • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

      • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

      • A target group that has no registered targets is considered unhealthy.

    When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

    S3 buckets

    There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

    Other records in the same hosted zone

    If the AWS resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

    For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

    " + } + }, + "documentation":"

    Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

    When creating resource record sets for a private hosted zone, note the following:

    • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

    • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.

    " + }, + "AssociateVPCComment":{"type":"string"}, + "AssociateVPCWithHostedZoneRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the private hosted zone that you want to associate an Amazon VPC with.

    Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

    ", + "location":"uri", + "locationName":"Id" + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    A complex type that contains information about the VPC that you want to associate with a private hosted zone.

    " + }, + "Comment":{ + "shape":"AssociateVPCComment", + "documentation":"

    Optional: A comment about the association request.

    " + } + }, + "documentation":"

    A complex type that contains information about the request to associate a VPC with a private hosted zone.

    " + }, + "AssociateVPCWithHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that describes the changes made to your hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the AssociateVPCWithHostedZone request.

    " + }, + "Change":{ + "type":"structure", + "required":[ + "Action", + "ResourceRecordSet" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    The action to perform:

    • CREATE: Creates a resource record set that has the specified values.

    • DELETE: Deletes a existing resource record set.

      To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

    • UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

    " + }, + "ResourceRecordSet":{ + "shape":"ResourceRecordSet", + "documentation":"

    Information about the resource record set to create, delete, or update.

    " + } + }, + "documentation":"

    The information for each resource record set that you want to change.

    " + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "CREATE", + "DELETE", + "UPSERT" + ] + }, + "ChangeBatch":{ + "type":"structure", + "required":["Changes"], + "members":{ + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

    Optional: Any comments you want to include about a change batch request.

    " + }, + "Changes":{ + "shape":"Changes", + "documentation":"

    Information about the changes to make to the record sets.

    " + } + }, + "documentation":"

    The information for a change request.

    " + }, + "ChangeInfo":{ + "type":"structure", + "required":[ + "Id", + "Status", + "SubmittedAt" + ], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the request.

    " + }, + "Status":{ + "shape":"ChangeStatus", + "documentation":"

    The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

    " + }, + "SubmittedAt":{ + "shape":"TimeStamp", + "documentation":"

    The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

    " + }, + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

    A complex type that describes change information about changes made to your hosted zone.

    This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

    " + } + }, + "documentation":"

    A complex type that describes change information about changes made to your hosted zone.

    " + }, + "ChangeResourceRecordSetsRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "ChangeBatch" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that contains the resource record sets that you want to change.

    ", + "location":"uri", + "locationName":"Id" + }, + "ChangeBatch":{ + "shape":"ChangeBatch", + "documentation":"

    A complex type that contains an optional comment and the Changes element.

    " + } + }, + "documentation":"

    A complex type that contains change information for the resource record set.

    " + }, + "ChangeResourceRecordSetsResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that contains information about changes made to your hosted zone.

    This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

    " + } + }, + "documentation":"

    A complex type containing the response for the request.

    " + }, + "ChangeStatus":{ + "type":"string", + "enum":[ + "PENDING", + "INSYNC" + ] + }, + "ChangeTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "documentation":"

    The type of the resource.

    • The resource type for health checks is healthcheck.

    • The resource type for hosted zones is hostedzone.

    ", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceId":{ + "shape":"TagResourceId", + "documentation":"

    The ID of the resource for which you want to add, change, or delete tags.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "AddTags":{ + "shape":"TagList", + "documentation":"

    A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for.

    You can add a maximum of 10 tags to a health check or a hosted zone.

    " + }, + "RemoveTagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.

    " + } + }, + "documentation":"

    A complex type that contains information about the tags that you want to add, edit, or delete.

    " + }, + "ChangeTagsForResourceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Empty response for the request.

    " + }, + "Changes":{ + "type":"list", + "member":{ + "shape":"Change", + "locationName":"Change" + }, + "min":1 + }, + "CheckerIpRanges":{ + "type":"list", + "member":{"shape":"IPAddressCidr"} + }, + "ChildHealthCheckList":{ + "type":"list", + "member":{ + "shape":"HealthCheckId", + "locationName":"ChildHealthCheck" + }, + "max":256 + }, + "CloudWatchAlarmConfiguration":{ + "type":"structure", + "required":[ + "EvaluationPeriods", + "Threshold", + "ComparisonOperator", + "Period", + "MetricName", + "Namespace", + "Statistic" + ], + "members":{ + "EvaluationPeriods":{ + "shape":"EvaluationPeriods", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

    " + }, + "Threshold":{ + "shape":"Threshold", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

    " + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

    " + }, + "Period":{ + "shape":"Period", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    The name of the CloudWatch metric that the alarm is associated with.

    " + }, + "Namespace":{ + "shape":"Namespace", + "documentation":"

    The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

    " + }, + "Statistic":{ + "shape":"Statistic", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

    " + }, + "Dimensions":{ + "shape":"DimensionList", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

    " + } + }, + "documentation":"

    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

    " + }, + "CloudWatchLogsLogGroupArn":{"type":"string"}, + "CloudWatchRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "ca-central-1", + "eu-central-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "ap-east-1", + "me-south-1", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "eu-north-1", + "sa-east-1", + "cn-northwest-1", + "cn-north-1" + ], + "max":64, + "min":1 + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "GreaterThanOrEqualToThreshold", + "GreaterThanThreshold", + "LessThanThreshold", + "LessThanOrEqualToThreshold" + ] + }, + "ConcurrentModification":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConflictingDomainExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The cause of this error depends on whether you're trying to create a public or a private hosted zone:

    • Public hosted zone: Two hosted zones that have the same name or that have a parent/child relationship (example.com and test.example.com) can't have any common name servers. You tried to create a hosted zone that has the same name as an existing hosted zone or that's the parent or child of an existing hosted zone, and you specified a delegation set that shares one or more name servers with the existing hosted zone. For more information, see CreateReusableDelegationSet.

    • Private hosted zone: You specified an Amazon VPC that you're already using for another hosted zone, and the domain that you specified for one of the hosted zones is a subdomain of the domain that you specified for the other hosted zone. For example, you can't use the same Amazon VPC for the hosted zones for example.com and test.example.com.

    ", + "exception":true + }, + "ConflictingTypes":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "CreateHealthCheckRequest":{ + "type":"structure", + "required":[ + "CallerReference", + "HealthCheckConfig" + ], + "members":{ + "CallerReference":{ + "shape":"HealthCheckNonce", + "documentation":"

    A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

    • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.

    • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.

    • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.

    • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

    " + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

    A complex type that contains settings for a new health check.

    " + } + }, + "documentation":"

    A complex type that contains the health check request information.

    " + }, + "CreateHealthCheckResponse":{ + "type":"structure", + "required":[ + "HealthCheck", + "Location" + ], + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

    A complex type that contains identifying information about the health check.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    The unique URL representing the new health check.

    ", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

    A complex type containing the response information for the new health check.

    " + }, + "CreateHostedZoneRequest":{ + "type":"structure", + "required":[ + "Name", + "CallerReference" + ], + "members":{ + "Name":{ + "shape":"DNSName", + "documentation":"

    The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

    If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

    " + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    (Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

    You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

    " + }, + "CallerReference":{ + "shape":"Nonce", + "documentation":"

    A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

    " + }, + "HostedZoneConfig":{ + "shape":"HostedZoneConfig", + "documentation":"

    (Optional) A complex type that contains the following optional values:

    • For public and private hosted zones, an optional comment

    • For private hosted zones, an optional PrivateZone element

    If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

    " + }, + "DelegationSetId":{ + "shape":"ResourceId", + "documentation":"

    If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

    " + } + }, + "documentation":"

    A complex type that contains information about the request to create a public or private hosted zone.

    " + }, + "CreateHostedZoneResponse":{ + "type":"structure", + "required":[ + "HostedZone", + "ChangeInfo", + "DelegationSet", + "Location" + ], + "members":{ + "HostedZone":{ + "shape":"HostedZone", + "documentation":"

    A complex type that contains general information about the hosted zone.

    " + }, + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that contains information about the CreateHostedZone request.

    " + }, + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

    A complex type that describes the name servers for this hosted zone.

    " + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    The unique URL representing the new hosted zone.

    ", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

    A complex type containing the response information for the hosted zone.

    " + }, + "CreateQueryLoggingConfigRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "CloudWatchLogsLogGroupArn" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

    " + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"CloudWatchLogsLogGroupArn", + "documentation":"

    The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

    arn:aws:logs:region:account-id:log-group:log_group_name

    To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the AWS SDKs.

    " + } + } + }, + "CreateQueryLoggingConfigResponse":{ + "type":"structure", + "required":[ + "QueryLoggingConfig", + "Location" + ], + "members":{ + "QueryLoggingConfig":{ + "shape":"QueryLoggingConfig", + "documentation":"

    A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    The unique URL representing the new query logging configuration.

    ", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateReusableDelegationSetRequest":{ + "type":"structure", + "required":["CallerReference"], + "members":{ + "CallerReference":{ + "shape":"Nonce", + "documentation":"

    A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp.

    " + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.

    " + } + } + }, + "CreateReusableDelegationSetResponse":{ + "type":"structure", + "required":[ + "DelegationSet", + "Location" + ], + "members":{ + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

    A complex type that contains name server information.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    The unique URL representing the new reusable delegation set.

    ", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "Name", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.

    " + }, + "Name":{ + "shape":"DNSName", + "documentation":"

    The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance.

    " + }, + "TTL":{ + "shape":"TTL", + "documentation":"

    (Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

    " + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

    " + }, + "TrafficPolicyVersion":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains information about the resource record sets that you want to create based on a specified traffic policy.

    " + }, + "CreateTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstance", + "Location" + ], + "members":{ + "TrafficPolicyInstance":{ + "shape":"TrafficPolicyInstance", + "documentation":"

    A complex type that contains settings for the new traffic policy instance.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    A unique URL that represents a new traffic policy instance.

    ", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

    A complex type that contains the response information for the CreateTrafficPolicyInstance request.

    " + }, + "CreateTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Name", + "Document" + ], + "members":{ + "Name":{ + "shape":"TrafficPolicyName", + "documentation":"

    The name of the traffic policy.

    " + }, + "Document":{ + "shape":"TrafficPolicyDocument", + "documentation":"

    The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

    " + }, + "Comment":{ + "shape":"TrafficPolicyComment", + "documentation":"

    (Optional) Any comments that you want to include about the traffic policy.

    " + } + }, + "documentation":"

    A complex type that contains information about the traffic policy that you want to create.

    " + }, + "CreateTrafficPolicyResponse":{ + "type":"structure", + "required":[ + "TrafficPolicy", + "Location" + ], + "members":{ + "TrafficPolicy":{ + "shape":"TrafficPolicy", + "documentation":"

    A complex type that contains settings for the new traffic policy.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    A unique URL that represents a new traffic policy.

    ", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

    A complex type that contains the response information for the CreateTrafficPolicy request.

    " + }, + "CreateTrafficPolicyVersionRequest":{ + "type":"structure", + "required":[ + "Id", + "Document" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy for which you want to create a new version.

    ", + "location":"uri", + "locationName":"Id" + }, + "Document":{ + "shape":"TrafficPolicyDocument", + "documentation":"

    The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

    " + }, + "Comment":{ + "shape":"TrafficPolicyComment", + "documentation":"

    The comment that you specified in the CreateTrafficPolicyVersion request, if any.

    " + } + }, + "documentation":"

    A complex type that contains information about the traffic policy that you want to create a new version for.

    " + }, + "CreateTrafficPolicyVersionResponse":{ + "type":"structure", + "required":[ + "TrafficPolicy", + "Location" + ], + "members":{ + "TrafficPolicy":{ + "shape":"TrafficPolicy", + "documentation":"

    A complex type that contains settings for the new version of the traffic policy.

    " + }, + "Location":{ + "shape":"ResourceURI", + "documentation":"

    A unique URL that represents a new traffic policy version.

    ", + "location":"header", + "locationName":"Location" + } + }, + "documentation":"

    A complex type that contains the response information for the CreateTrafficPolicyVersion request.

    " + }, + "CreateVPCAssociationAuthorizationRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the private hosted zone that you want to authorize associating a VPC with.

    ", + "location":"uri", + "locationName":"Id" + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains information about the request to authorize associating a VPC with your private hosted zone. Authorization is only required when a private hosted zone and a VPC were created by using different accounts.

    " + }, + "CreateVPCAssociationAuthorizationResponse":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you authorized associating a VPC with.

    " + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    The VPC that you authorized associating with a hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the response information from a CreateVPCAssociationAuthorization request.

    " + }, + "DNSName":{ + "type":"string", + "max":1024 + }, + "DNSRCode":{"type":"string"}, + "DelegationSet":{ + "type":"structure", + "required":["NameServers"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID that Amazon Route 53 assigns to a reusable delegation set.

    " + }, + "CallerReference":{ + "shape":"Nonce", + "documentation":"

    The value that you specified for CallerReference when you created the reusable delegation set.

    " + }, + "NameServers":{ + "shape":"DelegationSetNameServers", + "documentation":"

    A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

    " + } + }, + "documentation":"

    A complex type that lists the name servers in a delegation set, as well as the CallerReference and the ID for the delegation set.

    " + }, + "DelegationSetAlreadyCreated":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    A delegation set with the same owner and caller reference combination has already been created.

    ", + "exception":true + }, + "DelegationSetAlreadyReusable":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified delegation set has already been marked as reusable.

    ", + "exception":true + }, + "DelegationSetInUse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.

    ", + "exception":true + }, + "DelegationSetNameServers":{ + "type":"list", + "member":{ + "shape":"DNSName", + "locationName":"NameServer" + }, + "min":1 + }, + "DelegationSetNotAvailable":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Route 53 generates this error, contact Customer Support.

    ", + "exception":true + }, + "DelegationSetNotReusable":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    A reusable delegation set with the specified ID does not exist.

    ", + "exception":true + }, + "DelegationSets":{ + "type":"list", + "member":{ + "shape":"DelegationSet", + "locationName":"DelegationSet" + } + }, + "DeleteHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    The ID of the health check that you want to delete.

    ", + "location":"uri", + "locationName":"HealthCheckId" + } + }, + "documentation":"

    This action deletes a health check.

    " + }, + "DeleteHealthCheckResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element.

    " + }, + "DeleteHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone you want to delete.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A request to delete a hosted zone.

    " + }, + "DeleteHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the response to a DeleteHostedZone request.

    " + }, + "DeleteQueryLoggingConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"QueryLoggingConfigId", + "documentation":"

    The ID of the configuration that you want to delete.

    ", + "location":"uri", + "locationName":"Id" + } + } + }, + "DeleteQueryLoggingConfigResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteReusableDelegationSetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the reusable delegation set that you want to delete.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A request to delete a reusable delegation set.

    " + }, + "DeleteReusableDelegationSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element.

    " + }, + "DeleteTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "documentation":"

    The ID of the traffic policy instance that you want to delete.

    When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A request to delete a specified traffic policy instance.

    " + }, + "DeleteTrafficPolicyInstanceResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element.

    " + }, + "DeleteTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Id", + "Version" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy that you want to delete.

    ", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version number of the traffic policy that you want to delete.

    ", + "location":"uri", + "locationName":"Version" + } + }, + "documentation":"

    A request to delete a specified traffic policy version.

    " + }, + "DeleteTrafficPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element.

    " + }, + "DeleteVPCAssociationAuthorizationRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, the ID of the hosted zone.

    ", + "location":"uri", + "locationName":"Id" + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    When removing authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account, a complex type that includes the ID and region of the VPC.

    " + } + }, + "documentation":"

    A complex type that contains information about the request to remove authorization to associate a VPC that was created by one AWS account with a hosted zone that was created with a different AWS account.

    " + }, + "DeleteVPCAssociationAuthorizationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Empty response for the request.

    " + }, + "Dimension":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"DimensionField", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the name of one dimension.

    " + }, + "Value":{ + "shape":"DimensionField", + "documentation":"

    For the metric that the CloudWatch alarm is associated with, the value of one dimension.

    " + } + }, + "documentation":"

    For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.

    " + }, + "DimensionField":{ + "type":"string", + "max":255, + "min":1 + }, + "DimensionList":{ + "type":"list", + "member":{ + "shape":"Dimension", + "locationName":"Dimension" + }, + "max":10 + }, + "Disabled":{"type":"boolean"}, + "DisassociateVPCComment":{"type":"string"}, + "DisassociateVPCFromHostedZoneRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPC" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the private hosted zone that you want to disassociate a VPC from.

    ", + "location":"uri", + "locationName":"Id" + }, + "VPC":{ + "shape":"VPC", + "documentation":"

    A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.

    " + }, + "Comment":{ + "shape":"DisassociateVPCComment", + "documentation":"

    Optional: A comment about the disassociation request.

    " + } + }, + "documentation":"

    A complex type that contains information about the VPC that you want to disassociate from a specified private hosted zone.

    " + }, + "DisassociateVPCFromHostedZoneResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that describes the changes made to the specified private hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the disassociate request.

    " + }, + "EnableSNI":{"type":"boolean"}, + "ErrorMessage":{"type":"string"}, + "ErrorMessages":{ + "type":"list", + "member":{ + "shape":"ErrorMessage", + "locationName":"Message" + } + }, + "EvaluationPeriods":{ + "type":"integer", + "min":1 + }, + "FailureThreshold":{ + "type":"integer", + "max":10, + "min":1 + }, + "FullyQualifiedDomainName":{ + "type":"string", + "max":255 + }, + "GeoLocation":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

    The two-letter code for the continent.

    Valid values: AF | AN | AS | EU | OC | NA | SA

    Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

    " + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

    The two-letter code for the country.

    " + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

    The code for the subdivision. Route 53 currently supports only states in the United States.

    " + } + }, + "documentation":"

    A complex type that contains information about a geographic location.

    " + }, + "GeoLocationContinentCode":{ + "type":"string", + "max":2, + "min":2 + }, + "GeoLocationContinentName":{ + "type":"string", + "max":32, + "min":1 + }, + "GeoLocationCountryCode":{ + "type":"string", + "max":2, + "min":1 + }, + "GeoLocationCountryName":{ + "type":"string", + "max":64, + "min":1 + }, + "GeoLocationDetails":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

    The two-letter code for the continent.

    " + }, + "ContinentName":{ + "shape":"GeoLocationContinentName", + "documentation":"

    The full name of the continent.

    " + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

    The two-letter code for the country.

    " + }, + "CountryName":{ + "shape":"GeoLocationCountryName", + "documentation":"

    The name of the country.

    " + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

    The code for the subdivision. Route 53 currently supports only states in the United States.

    " + }, + "SubdivisionName":{ + "shape":"GeoLocationSubdivisionName", + "documentation":"

    The full name of the subdivision. Route 53 currently supports only states in the United States.

    " + } + }, + "documentation":"

    A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

    " + }, + "GeoLocationDetailsList":{ + "type":"list", + "member":{ + "shape":"GeoLocationDetails", + "locationName":"GeoLocationDetails" + } + }, + "GeoLocationSubdivisionCode":{ + "type":"string", + "max":3, + "min":1 + }, + "GeoLocationSubdivisionName":{ + "type":"string", + "max":64, + "min":1 + }, + "GetAccountLimitRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"AccountLimitType", + "documentation":"

    The limit that you want to get. Valid values include the following:

    • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.

    • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.

    • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.

    • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.

    • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

    ", + "location":"uri", + "locationName":"Type" + } + }, + "documentation":"

    A complex type that contains information about the request to create a hosted zone.

    " + }, + "GetAccountLimitResponse":{ + "type":"structure", + "required":[ + "Limit", + "Count" + ], + "members":{ + "Limit":{ + "shape":"AccountLimit", + "documentation":"

    The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Limit is the maximum number of health checks that you can create using the current account.

    " + }, + "Count":{ + "shape":"UsageCount", + "documentation":"

    The current number of entities that you have created of the specified type. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count is the current number of health checks that you have created using the current account.

    " + } + }, + "documentation":"

    A complex type that contains the requested limit.

    " + }, + "GetChangeRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    The input for a GetChange request.

    " + }, + "GetChangeResponse":{ + "type":"structure", + "required":["ChangeInfo"], + "members":{ + "ChangeInfo":{ + "shape":"ChangeInfo", + "documentation":"

    A complex type that contains information about the specified change batch.

    " + } + }, + "documentation":"

    A complex type that contains the ChangeInfo element.

    " + }, + "GetCheckerIpRangesRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Empty request.

    " + }, + "GetCheckerIpRangesResponse":{ + "type":"structure", + "required":["CheckerIpRanges"], + "members":{ + "CheckerIpRanges":{ + "shape":"CheckerIpRanges", + "documentation":"

    A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.

    " + } + }, + "documentation":"

    A complex type that contains the CheckerIpRanges element.

    " + }, + "GetGeoLocationRequest":{ + "type":"structure", + "members":{ + "ContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

    Amazon Route 53 supports the following continent codes:

    • AF: Africa

    • AN: Antarctica

    • AS: Asia

    • EU: Europe

    • OC: Oceania

    • NA: North America

    • SA: South America

    ", + "location":"querystring", + "locationName":"continentcode" + }, + "CountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

    Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

    ", + "location":"querystring", + "locationName":"countrycode" + }, + "SubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

    Amazon Route 53 uses the one- to three-letter subdivision codes that are specified in ISO standard 3166-1 alpha-2. Route 53 doesn't support subdivision codes for all countries. If you specify subdivisioncode, you must also specify countrycode.

    ", + "location":"querystring", + "locationName":"subdivisioncode" + } + }, + "documentation":"

    A request for information about whether a specified geographic location is supported for Amazon Route 53 geolocation resource record sets.

    " + }, + "GetGeoLocationResponse":{ + "type":"structure", + "required":["GeoLocationDetails"], + "members":{ + "GeoLocationDetails":{ + "shape":"GeoLocationDetails", + "documentation":"

    A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the specified geolocation code.

    " + }, + "GetHealthCheckCountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A request for the number of health checks that are associated with the current AWS account.

    " + }, + "GetHealthCheckCountResponse":{ + "type":"structure", + "required":["HealthCheckCount"], + "members":{ + "HealthCheckCount":{ + "shape":"HealthCheckCount", + "documentation":"

    The number of health checks associated with the current AWS account.

    " + } + }, + "documentation":"

    A complex type that contains the response to a GetHealthCheckCount request.

    " + }, + "GetHealthCheckLastFailureReasonRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

    If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated health check.

    ", + "location":"uri", + "locationName":"HealthCheckId" + } + }, + "documentation":"

    A request for the reason that a health check failed most recently.

    " + }, + "GetHealthCheckLastFailureReasonResponse":{ + "type":"structure", + "required":["HealthCheckObservations"], + "members":{ + "HealthCheckObservations":{ + "shape":"HealthCheckObservations", + "documentation":"

    A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason.

    " + } + }, + "documentation":"

    A complex type that contains the response to a GetHealthCheckLastFailureReason request.

    " + }, + "GetHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

    ", + "location":"uri", + "locationName":"HealthCheckId" + } + }, + "documentation":"

    A request to get information about a specified health check.

    " + }, + "GetHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

    A complex type that contains information about one health check that is associated with the current AWS account.

    " + } + }, + "documentation":"

    A complex type that contains the response to a GetHealthCheck request.

    " + }, + "GetHealthCheckStatusRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

    If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

    ", + "location":"uri", + "locationName":"HealthCheckId" + } + }, + "documentation":"

    A request to get the status for a health check.

    " + }, + "GetHealthCheckStatusResponse":{ + "type":"structure", + "required":["HealthCheckObservations"], + "members":{ + "HealthCheckObservations":{ + "shape":"HealthCheckObservations", + "documentation":"

    A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

    " + } + }, + "documentation":"

    A complex type that contains the response to a GetHealthCheck request.

    " + }, + "GetHostedZoneCountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A request to retrieve a count of all the hosted zones that are associated with the current AWS account.

    " + }, + "GetHostedZoneCountResponse":{ + "type":"structure", + "required":["HostedZoneCount"], + "members":{ + "HostedZoneCount":{ + "shape":"HostedZoneCount", + "documentation":"

    The total number of public and private hosted zones that are associated with the current AWS account.

    " + } + }, + "documentation":"

    A complex type that contains the response to a GetHostedZoneCount request.

    " + }, + "GetHostedZoneLimitRequest":{ + "type":"structure", + "required":[ + "Type", + "HostedZoneId" + ], + "members":{ + "Type":{ + "shape":"HostedZoneLimitType", + "documentation":"

    The limit that you want to get. Valid values include the following:

    • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.

    • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

    ", + "location":"uri", + "locationName":"Type" + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want to get a limit for.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A complex type that contains information about the request to create a hosted zone.

    " + }, + "GetHostedZoneLimitResponse":{ + "type":"structure", + "required":[ + "Limit", + "Count" + ], + "members":{ + "Limit":{ + "shape":"HostedZoneLimit", + "documentation":"

    The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is the maximum number of records that you can create in the specified hosted zone.

    " + }, + "Count":{ + "shape":"UsageCount", + "documentation":"

    The current number of entities that you have created of the specified type. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count is the current number of records that you have created in the specified hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the requested limit.

    " + }, + "GetHostedZoneRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want to get information about.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A request to get information about a specified hosted zone.

    " + }, + "GetHostedZoneResponse":{ + "type":"structure", + "required":["HostedZone"], + "members":{ + "HostedZone":{ + "shape":"HostedZone", + "documentation":"

    A complex type that contains general information about the specified hosted zone.

    " + }, + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

    A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

    " + }, + "VPCs":{ + "shape":"VPCs", + "documentation":"

    A complex type that contains information about the VPCs that are associated with the specified hosted zone.

    " + } + }, + "documentation":"

    A complex type that contain the response to a GetHostedZone request.

    " + }, + "GetQueryLoggingConfigRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"QueryLoggingConfigId", + "documentation":"

    The ID of the configuration for DNS query logging that you want to get information about.

    ", + "location":"uri", + "locationName":"Id" + } + } + }, + "GetQueryLoggingConfigResponse":{ + "type":"structure", + "required":["QueryLoggingConfig"], + "members":{ + "QueryLoggingConfig":{ + "shape":"QueryLoggingConfig", + "documentation":"

    A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request.

    " + } + } + }, + "GetReusableDelegationSetLimitRequest":{ + "type":"structure", + "required":[ + "Type", + "DelegationSetId" + ], + "members":{ + "Type":{ + "shape":"ReusableDelegationSetLimitType", + "documentation":"

    Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted zones that you can associate with the specified reusable delegation set.

    ", + "location":"uri", + "locationName":"Type" + }, + "DelegationSetId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the delegation set that you want to get the limit for.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A complex type that contains information about the request to create a hosted zone.

    " + }, + "GetReusableDelegationSetLimitResponse":{ + "type":"structure", + "required":[ + "Limit", + "Count" + ], + "members":{ + "Limit":{ + "shape":"ReusableDelegationSetLimit", + "documentation":"

    The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set.

    " + }, + "Count":{ + "shape":"UsageCount", + "documentation":"

    The current number of hosted zones that you can associate with the specified reusable delegation set.

    " + } + }, + "documentation":"

    A complex type that contains the requested limit.

    " + }, + "GetReusableDelegationSetRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the reusable delegation set that you want to get a list of name servers for.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    A request to get information about a specified reusable delegation set.

    " + }, + "GetReusableDelegationSetResponse":{ + "type":"structure", + "required":["DelegationSet"], + "members":{ + "DelegationSet":{ + "shape":"DelegationSet", + "documentation":"

    A complex type that contains information about the reusable delegation set.

    " + } + }, + "documentation":"

    A complex type that contains the response to the GetReusableDelegationSet request.

    " + }, + "GetTrafficPolicyInstanceCountRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Request to get the number of traffic policy instances that are associated with the current AWS account.

    " + }, + "GetTrafficPolicyInstanceCountResponse":{ + "type":"structure", + "required":["TrafficPolicyInstanceCount"], + "members":{ + "TrafficPolicyInstanceCount":{ + "shape":"TrafficPolicyInstanceCount", + "documentation":"

    The number of traffic policy instances that are associated with the current AWS account.

    " + } + }, + "documentation":"

    A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

    " + }, + "GetTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "documentation":"

    The ID of the traffic policy instance that you want to get information about.

    ", + "location":"uri", + "locationName":"Id" + } + }, + "documentation":"

    Gets information about a specified traffic policy instance.

    " + }, + "GetTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":["TrafficPolicyInstance"], + "members":{ + "TrafficPolicyInstance":{ + "shape":"TrafficPolicyInstance", + "documentation":"

    A complex type that contains settings for the traffic policy instance.

    " + } + }, + "documentation":"

    A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

    " + }, + "GetTrafficPolicyRequest":{ + "type":"structure", + "required":[ + "Id", + "Version" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy that you want to get information about.

    ", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version number of the traffic policy that you want to get information about.

    ", + "location":"uri", + "locationName":"Version" + } + }, + "documentation":"

    Gets information about a specific traffic policy version.

    " + }, + "GetTrafficPolicyResponse":{ + "type":"structure", + "required":["TrafficPolicy"], + "members":{ + "TrafficPolicy":{ + "shape":"TrafficPolicy", + "documentation":"

    A complex type that contains settings for the specified traffic policy.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "HealthCheck":{ + "type":"structure", + "required":[ + "Id", + "CallerReference", + "HealthCheckConfig", + "HealthCheckVersion" + ], + "members":{ + "Id":{ + "shape":"HealthCheckId", + "documentation":"

    The identifier that Amazon Route 53assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

    " + }, + "CallerReference":{ + "shape":"HealthCheckNonce", + "documentation":"

    A unique string that you specified when you created the health check.

    " + }, + "LinkedService":{ + "shape":"LinkedService", + "documentation":"

    If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.

    " + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

    A complex type that contains detailed information about one health check.

    " + }, + "HealthCheckVersion":{ + "shape":"HealthCheckVersion", + "documentation":"

    The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

    " + }, + "CloudWatchAlarmConfiguration":{ + "shape":"CloudWatchAlarmConfiguration", + "documentation":"

    A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

    " + } + }, + "documentation":"

    A complex type that contains information about one health check that is associated with the current AWS account.

    " + }, + "HealthCheckAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The health check you're attempting to create already exists. Amazon Route 53 returns this error when you submit a request that has the following values:

    • The same value for CallerReference as an existing health check, and one or more values that differ from the existing health check that has the same caller reference.

    • The same value for CallerReference as a health check that you created and later deleted, regardless of the other settings in the request.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "HealthCheckConfig":{ + "type":"structure", + "required":["Type"], + "members":{ + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

    The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.

    Use one of the following formats for the value of IPAddress:

    • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

    • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

    For more information, see FullyQualifiedDomainName.

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

    When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

    " + }, + "Port":{ + "shape":"Port", + "documentation":"

    The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress.

    " + }, + "Type":{ + "shape":"HealthCheckType", + "documentation":"

    The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

    You can't change the value of Type after you create a health check.

    You can create the following types of health checks:

    • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

    • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

    • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

    • HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.

    • TCP: Route 53 tries to establish a TCP connection.

    • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.

    • CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.

    For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

    " + }, + "ResourcePath":{ + "shape":"ResourcePath", + "documentation":"

    The path, if any, that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

    " + }, + "FullyQualifiedDomainName":{ + "shape":"FullyQualifiedDomainName", + "documentation":"

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    If you specify a value for IPAddress:

    Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

    If you don't specify a value for IPAddress :

    Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

    In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

    " + }, + "SearchString":{ + "shape":"SearchString", + "documentation":"

    If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

    Route 53 considers case when searching for SearchString in the response body.

    " + }, + "RequestInterval":{ + "shape":"RequestInterval", + "documentation":"

    The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.

    You can't change the value of RequestInterval after you create a health check.

    If you don't specify a value for RequestInterval, the default value is 30 seconds.

    " + }, + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " + }, + "MeasureLatency":{ + "shape":"MeasureLatency", + "documentation":"

    Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint, and to display CloudWatch latency graphs on the Health Checks page in the Route 53 console.

    You can't change the value of MeasureLatency after you create a health check.

    " + }, + "Inverted":{ + "shape":"Inverted", + "documentation":"

    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

    " + }, + "Disabled":{ + "shape":"Disabled", + "documentation":"

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

    • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

    • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

    Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

    " + }, + "HealthThreshold":{ + "shape":"HealthThreshold", + "documentation":"

    The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

    • If you specify 0, Route 53 always considers this health check to be healthy.

    " + }, + "ChildHealthChecks":{ + "shape":"ChildHealthCheckList", + "documentation":"

    (CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

    " + }, + "EnableSNI":{ + "shape":"EnableSNI", + "documentation":"

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " + }, + "Regions":{ + "shape":"HealthCheckRegionList", + "documentation":"

    A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

    If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

    If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

    " + }, + "AlarmIdentifier":{ + "shape":"AlarmIdentifier", + "documentation":"

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

    " + }, + "InsufficientDataHealthStatus":{ + "shape":"InsufficientDataHealthStatus", + "documentation":"

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

    • Healthy: Route 53 considers the health check to be healthy.

    • Unhealthy: Route 53 considers the health check to be unhealthy.

    • LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

    " + } + }, + "documentation":"

    A complex type that contains information about the health check.

    " + }, + "HealthCheckCount":{"type":"long"}, + "HealthCheckId":{ + "type":"string", + "max":64 + }, + "HealthCheckInUse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This error code is not in use.

    ", + "deprecated":true, + "error":{"httpStatusCode":400}, + "exception":true + }, + "HealthCheckNonce":{ + "type":"string", + "max":64, + "min":1 + }, + "HealthCheckObservation":{ + "type":"structure", + "members":{ + "Region":{ + "shape":"HealthCheckRegion", + "documentation":"

    The region of the Amazon Route 53 health checker that provided the status in StatusReport.

    " + }, + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

    The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

    " + }, + "StatusReport":{ + "shape":"StatusReport", + "documentation":"

    A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

    " + } + }, + "documentation":"

    A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.

    " + }, + "HealthCheckObservations":{ + "type":"list", + "member":{ + "shape":"HealthCheckObservation", + "locationName":"HealthCheckObservation" + } + }, + "HealthCheckRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-west-1", + "us-west-2", + "eu-west-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1" + ], + "max":64, + "min":1 + }, + "HealthCheckRegionList":{ + "type":"list", + "member":{ + "shape":"HealthCheckRegion", + "locationName":"Region" + }, + "max":64, + "min":3 + }, + "HealthCheckType":{ + "type":"string", + "enum":[ + "HTTP", + "HTTPS", + "HTTP_STR_MATCH", + "HTTPS_STR_MATCH", + "TCP", + "CALCULATED", + "CLOUDWATCH_METRIC" + ] + }, + "HealthCheckVersion":{ + "type":"long", + "min":1 + }, + "HealthCheckVersionMismatch":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The value of HealthCheckVersion in the request doesn't match the value of HealthCheckVersion in the health check.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "HealthChecks":{ + "type":"list", + "member":{ + "shape":"HealthCheck", + "locationName":"HealthCheck" + } + }, + "HealthThreshold":{ + "type":"integer", + "max":256, + "min":0 + }, + "HostedZone":{ + "type":"structure", + "required":[ + "Id", + "Name", + "CallerReference" + ], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    " + }, + "Name":{ + "shape":"DNSName", + "documentation":"

    The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

    For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

    " + }, + "CallerReference":{ + "shape":"Nonce", + "documentation":"

    The value that you specified for CallerReference when you created the hosted zone.

    " + }, + "Config":{ + "shape":"HostedZoneConfig", + "documentation":"

    A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

    " + }, + "ResourceRecordSetCount":{ + "shape":"HostedZoneRRSetCount", + "documentation":"

    The number of resource record sets in the hosted zone.

    " + }, + "LinkedService":{ + "shape":"LinkedService", + "documentation":"

    If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.

    " + } + }, + "documentation":"

    A complex type that contains general information about the hosted zone.

    " + }, + "HostedZoneAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The hosted zone you're trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "HostedZoneConfig":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

    Any comments that you want to include about the hosted zone.

    " + }, + "PrivateZone":{ + "shape":"IsPrivateZone", + "documentation":"

    A value that indicates whether this is a private hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the HostedZoneConfig and Comment elements.

    " + }, + "HostedZoneCount":{"type":"long"}, + "HostedZoneLimit":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"HostedZoneLimitType", + "documentation":"

    The limit that you requested. Valid values include the following:

    • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.

    • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

    " + }, + "Value":{ + "shape":"LimitValue", + "documentation":"

    The current value for the limit that is specified by Type.

    " + } + }, + "documentation":"

    A complex type that contains the type of limit that you specified in the request and the current value for that limit.

    " + }, + "HostedZoneLimitType":{ + "type":"string", + "enum":[ + "MAX_RRSETS_BY_ZONE", + "MAX_VPCS_ASSOCIATED_BY_ZONE" + ] + }, + "HostedZoneNotEmpty":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The hosted zone contains resource records that are not SOA or NS records.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "HostedZoneNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified HostedZone can't be found.

    ", + "exception":true + }, + "HostedZoneNotPrivate":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified hosted zone is a public hosted zone, not a private hosted zone.

    ", + "exception":true + }, + "HostedZoneRRSetCount":{"type":"long"}, + "HostedZones":{ + "type":"list", + "member":{ + "shape":"HostedZone", + "locationName":"HostedZone" + } + }, + "IPAddress":{ + "type":"string", + "max":45, + "pattern":"(^((([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]))$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$)" + }, + "IPAddressCidr":{"type":"string"}, + "IncompatibleVersion":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InsufficientCloudWatchLogsResourcePolicy":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:

    • There is no resource policy that specifies the log group ARN in the value for Resource.

    • The resource policy that includes the log group ARN in the value for Resource doesn't have the necessary permissions.

    • The resource policy hasn't finished propagating yet.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InsufficientDataHealthStatus":{ + "type":"string", + "enum":[ + "Healthy", + "Unhealthy", + "LastKnownStatus" + ] + }, + "InvalidArgument":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    Parameter name is invalid.

    ", + "exception":true + }, + "InvalidChangeBatch":{ + "type":"structure", + "members":{ + "messages":{ + "shape":"ErrorMessages", + "documentation":"

    Descriptive message for the error response.

    " + }, + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    This exception contains a list of messages that might contain one or more error messages. Each error message indicates one error in the change batch.

    ", + "exception":true + }, + "InvalidDomainName":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified domain name is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The input is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidPaginationToken":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The value that you specified to get the second or subsequent page of results is invalid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidTrafficPolicyDocument":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The format of the traffic policy document that you specified in the Document element is invalid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidVPCId":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Inverted":{"type":"boolean"}, + "IsPrivateZone":{"type":"boolean"}, + "LastVPCAssociation":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with the hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LimitValue":{ + "type":"long", + "min":1 + }, + "LimitsExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This operation can't be completed either because the current account has reached the limit on reusable delegation sets that it can create or because you've reached the limit on the number of Amazon VPCs that you can associate with a private hosted zone. To get the current limit on the number of reusable delegation sets, see GetAccountLimit. To get the current limit on the number of Amazon VPCs that you can associate with a private hosted zone, see GetHostedZoneLimit. To request a higher limit, create a case with the AWS Support Center.

    ", + "exception":true + }, + "LinkedService":{ + "type":"structure", + "members":{ + "ServicePrincipal":{ + "shape":"ServicePrincipal", + "documentation":"

    If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    " + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    " + } + }, + "documentation":"

    If a health check or hosted zone was created by another service, LinkedService is a complex type that describes the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

    " + }, + "ListGeoLocationsRequest":{ + "type":"structure", + "members":{ + "StartContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

    The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in startcontinentcode to return the next page of results.

    Include startcontinentcode only if you want to list continents. Don't include startcontinentcode when you're listing countries or countries with their subdivisions.

    ", + "location":"querystring", + "locationName":"startcontinentcode" + }, + "StartCountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

    The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.

    Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

    ", + "location":"querystring", + "locationName":"startcountrycode" + }, + "StartSubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

    The code for the subdivision (for example, state or province) with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.

    To list subdivisions of a country, you must include both startcountrycode and startsubdivisioncode.

    ", + "location":"querystring", + "locationName":"startsubdivisioncode" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    (Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request to get a list of geographic locations that Amazon Route 53 supports for geolocation resource record sets.

    " + }, + "ListGeoLocationsResponse":{ + "type":"structure", + "required":[ + "GeoLocationDetailsList", + "IsTruncated", + "MaxItems" + ], + "members":{ + "GeoLocationDetailsList":{ + "shape":"GeoLocationDetailsList", + "documentation":"

    A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and startsubdivisioncode, as applicable.

    " + }, + "NextContinentCode":{ + "shape":"GeoLocationContinentCode", + "documentation":"

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the startcontinentcode parameter in another ListGeoLocations request.

    " + }, + "NextCountryCode":{ + "shape":"GeoLocationCountryCode", + "documentation":"

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

    " + }, + "NextSubdivisionCode":{ + "shape":"GeoLocationSubdivisionCode", + "documentation":"

    If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for MaxItems in the request.

    " + } + }, + "documentation":"

    A complex type containing the response information for the request.

    " + }, + "ListHealthChecksRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

    For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more health checks to get.

    ", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request to retrieve a list of the health checks that are associated with the current AWS account.

    " + }, + "ListHealthChecksResponse":{ + "type":"structure", + "required":[ + "HealthChecks", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HealthChecks":{ + "shape":"HealthChecks", + "documentation":"

    A complex type that contains one HealthCheck element for each health check that is associated with the current AWS account.

    " + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

    " + }, + "NextMarker":{ + "shape":"PageMarker", + "documentation":"

    If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response to a ListHealthChecks request.

    " + }, + "ListHostedZonesByNameRequest":{ + "type":"structure", + "members":{ + "DNSName":{ + "shape":"DNSName", + "documentation":"

    (Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current AWS account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

    ", + "location":"querystring", + "locationName":"dnsname" + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    (Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

    If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

    ", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    Retrieves a list of the public and private hosted zones that are associated with the current AWS account in ASCII order by domain name.

    " + }, + "ListHostedZonesByNameResponse":{ + "type":"structure", + "required":[ + "HostedZones", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HostedZones":{ + "shape":"HostedZones", + "documentation":"

    A complex type that contains general information about the hosted zone.

    " + }, + "DNSName":{ + "shape":"DNSName", + "documentation":"

    For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

    " + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID that Amazon Route 53 assigned to the hosted zone when you created it.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

    " + }, + "NextDNSName":{ + "shape":"DNSName", + "documentation":"

    If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    This element is present only if IsTruncated is true.

    " + }, + "NextHostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

    This element is present only if IsTruncated is true.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListHostedZonesRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

    For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

    ", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    (Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

    ", + "location":"querystring", + "locationName":"maxitems" + }, + "DelegationSetId":{ + "shape":"ResourceId", + "documentation":"

    If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

    ", + "location":"querystring", + "locationName":"delegationsetid" + } + }, + "documentation":"

    A request to retrieve a list of the public and private hosted zones that are associated with the current AWS account.

    " + }, + "ListHostedZonesResponse":{ + "type":"structure", + "required":[ + "HostedZones", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "HostedZones":{ + "shape":"HostedZones", + "documentation":"

    A complex type that contains general information about the hosted zone.

    " + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

    " + }, + "NextMarker":{ + "shape":"PageMarker", + "documentation":"

    If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

    This element is present only if IsTruncated is true.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

    " + } + } + }, + "ListQueryLoggingConfigsRequest":{ + "type":"structure", + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    (Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.

    If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current AWS account.

    ", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    (Optional) If the current AWS account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.

    For the first ListQueryLoggingConfigs request, omit this value.

    For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

    ", + "location":"querystring", + "locationName":"nexttoken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current AWS account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.

    If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

    ", + "location":"querystring", + "locationName":"maxresults" + } + } + }, + "ListQueryLoggingConfigsResponse":{ + "type":"structure", + "required":["QueryLoggingConfigs"], + "members":{ + "QueryLoggingConfigs":{ + "shape":"QueryLoggingConfigs", + "documentation":"

    An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current AWS account.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If a response includes the last of the query logging configurations that are associated with the current AWS account, NextToken doesn't appear in the response.

    If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

    " + } + } + }, + "ListResourceRecordSetsRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that contains the resource record sets that you want to list.

    ", + "location":"uri", + "locationName":"Id" + }, + "StartRecordName":{ + "shape":"DNSName", + "documentation":"

    The first name in the lexicographic ordering of resource record sets that you want to list.

    ", + "location":"querystring", + "locationName":"name" + }, + "StartRecordType":{ + "shape":"RRType", + "documentation":"

    The type of resource record set to begin the record listing from.

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

    Values for alias resource record sets:

    • API Gateway custom regional API or edge-optimized API: A

    • CloudFront distribution: A or AAAA

    • Elastic Beanstalk environment that has a regionalized subdomain: A

    • Elastic Load Balancing load balancer: A | AAAA

    • Amazon S3 bucket: A

    • Amazon VPC interface VPC endpoint: A

    • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

    Constraint: Specifying type without specifying name returns an InvalidInput error.

    ", + "location":"querystring", + "locationName":"type" + }, + "StartRecordIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "documentation":"

    Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

    ", + "location":"querystring", + "locationName":"identifier" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    (Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request for the resource record sets that are associated with a specified hosted zone.

    " + }, + "ListResourceRecordSetsResponse":{ + "type":"structure", + "required":[ + "ResourceRecordSets", + "IsTruncated", + "MaxItems" + ], + "members":{ + "ResourceRecordSets":{ + "shape":"ResourceRecordSets", + "documentation":"

    Information about multiple resource record sets.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

    " + }, + "NextRecordName":{ + "shape":"DNSName", + "documentation":"

    If the results were truncated, the name of the next record in the list.

    This element is present only if IsTruncated is true.

    " + }, + "NextRecordType":{ + "shape":"RRType", + "documentation":"

    If the results were truncated, the type of the next record in the list.

    This element is present only if IsTruncated is true.

    " + }, + "NextRecordIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "documentation":"

    Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

    For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of records you requested.

    " + } + }, + "documentation":"

    A complex type that contains list information for the resource record set.

    " + }, + "ListReusableDelegationSetsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request.

    For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

    ", + "location":"querystring", + "locationName":"marker" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request to get a list of the reusable delegation sets that are associated with the current AWS account.

    " + }, + "ListReusableDelegationSetsResponse":{ + "type":"structure", + "required":[ + "DelegationSets", + "Marker", + "IsTruncated", + "MaxItems" + ], + "members":{ + "DelegationSets":{ + "shape":"DelegationSets", + "documentation":"

    A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current AWS account.

    " + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more reusable delegation sets to be listed.

    " + }, + "NextMarker":{ + "shape":"PageMarker", + "documentation":"

    If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains information about the reusable delegation sets that are associated with the current AWS account.

    " + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "documentation":"

    The type of the resource.

    • The resource type for health checks is healthcheck.

    • The resource type for hosted zones is hostedzone.

    ", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceId":{ + "shape":"TagResourceId", + "documentation":"

    The ID of the resource for which you want to retrieve tags.

    ", + "location":"uri", + "locationName":"ResourceId" + } + }, + "documentation":"

    A complex type containing information about a request for a list of the tags that are associated with an individual resource.

    " + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["ResourceTagSet"], + "members":{ + "ResourceTagSet":{ + "shape":"ResourceTagSet", + "documentation":"

    A ResourceTagSet containing tags associated with the specified resource.

    " + } + }, + "documentation":"

    A complex type that contains information about the health checks or hosted zones for which you want to list tags.

    " + }, + "ListTagsForResourcesRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceIds" + ], + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "documentation":"

    The type of the resources.

    • The resource type for health checks is healthcheck.

    • The resource type for hosted zones is hostedzone.

    ", + "location":"uri", + "locationName":"ResourceType" + }, + "ResourceIds":{ + "shape":"TagResourceIdList", + "documentation":"

    A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

    " + } + }, + "documentation":"

    A complex type that contains information about the health checks or hosted zones for which you want to list tags.

    " + }, + "ListTagsForResourcesResponse":{ + "type":"structure", + "required":["ResourceTagSets"], + "members":{ + "ResourceTagSets":{ + "shape":"ResourceTagSetList", + "documentation":"

    A list of ResourceTagSets containing tags associated with the specified resources.

    " + } + }, + "documentation":"

    A complex type containing tags for the specified resources.

    " + }, + "ListTrafficPoliciesRequest":{ + "type":"structure", + "members":{ + "TrafficPolicyIdMarker":{ + "shape":"TrafficPolicyId", + "documentation":"

    (Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

    If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

    ", + "location":"querystring", + "locationName":"trafficpolicyid" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    (Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A complex type that contains the information about the request to list the traffic policies that are associated with the current AWS account.

    " + }, + "ListTrafficPoliciesResponse":{ + "type":"structure", + "required":[ + "TrafficPolicySummaries", + "IsTruncated", + "TrafficPolicyIdMarker", + "MaxItems" + ], + "members":{ + "TrafficPolicySummaries":{ + "shape":"TrafficPolicySummaries", + "documentation":"

    A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current AWS account.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

    " + }, + "TrafficPolicyIdMarker":{ + "shape":"TrafficPolicyId", + "documentation":"

    If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListTrafficPolicyInstancesByHostedZoneRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want to list traffic policy instances for.

    ", + "location":"querystring", + "locationName":"id" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request for the traffic policy instances that you created in a specified hosted zone.

    " + }, + "ListTrafficPolicyInstancesByHostedZoneResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{ + "shape":"TrafficPolicyInstances", + "documentation":"

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    " + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

    " + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListTrafficPolicyInstancesByPolicyRequest":{ + "type":"structure", + "required":[ + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy for which you want to list traffic policy instances.

    ", + "location":"querystring", + "locationName":"id" + }, + "TrafficPolicyVersion":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

    ", + "location":"querystring", + "locationName":"version" + }, + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

    For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

    For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

    For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A complex type that contains the information about the request to list your traffic policy instances.

    " + }, + "ListTrafficPolicyInstancesByPolicyResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{ + "shape":"TrafficPolicyInstances", + "documentation":"

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    " + }, + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "documentation":"

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.

    " + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

    " + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListTrafficPolicyInstancesRequest":{ + "type":"structure", + "members":{ + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancename" + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

    If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

    ", + "location":"querystring", + "locationName":"trafficpolicyinstancetype" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A request to get information about the traffic policy instances that you created by using the current AWS account.

    " + }, + "ListTrafficPolicyInstancesResponse":{ + "type":"structure", + "required":[ + "TrafficPolicyInstances", + "IsTruncated", + "MaxItems" + ], + "members":{ + "TrafficPolicyInstances":{ + "shape":"TrafficPolicyInstances", + "documentation":"

    A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

    " + }, + "HostedZoneIdMarker":{ + "shape":"ResourceId", + "documentation":"

    If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    " + }, + "TrafficPolicyInstanceNameMarker":{ + "shape":"DNSName", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

    " + }, + "TrafficPolicyInstanceTypeMarker":{ + "shape":"RRType", + "documentation":"

    If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListTrafficPolicyVersionsRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    Specify the value of Id of the traffic policy for which you want to list all versions.

    ", + "location":"uri", + "locationName":"Id" + }, + "TrafficPolicyVersionMarker":{ + "shape":"TrafficPolicyVersionMarker", + "documentation":"

    For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

    If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.

    ", + "location":"querystring", + "locationName":"trafficpolicyversion" + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request.

    ", + "location":"querystring", + "locationName":"maxitems" + } + }, + "documentation":"

    A complex type that contains the information about the request to list your traffic policies.

    " + }, + "ListTrafficPolicyVersionsResponse":{ + "type":"structure", + "required":[ + "TrafficPolicies", + "IsTruncated", + "TrafficPolicyVersionMarker", + "MaxItems" + ], + "members":{ + "TrafficPolicies":{ + "shape":"TrafficPolicies", + "documentation":"

    A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

    " + }, + "IsTruncated":{ + "shape":"PageTruncated", + "documentation":"

    A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.

    " + }, + "TrafficPolicyVersionMarker":{ + "shape":"TrafficPolicyVersionMarker", + "documentation":"

    If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

    This element is present only if IsTruncated is true.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "ListVPCAssociationAuthorizationsRequest":{ + "type":"structure", + "required":["HostedZoneId"], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

    ", + "location":"uri", + "locationName":"Id" + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request.

    ", + "location":"querystring", + "locationName":"nexttoken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.

    ", + "location":"querystring", + "locationName":"maxresults" + } + }, + "documentation":"

    A complex type that contains information about that can be associated with your hosted zone.

    " + }, + "ListVPCAssociationAuthorizationsResponse":{ + "type":"structure", + "required":[ + "HostedZoneId", + "VPCs" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you can associate the listed VPCs with.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter.

    " + }, + "VPCs":{ + "shape":"VPCs", + "documentation":"

    The list of VPCs that are authorized to be associated with the specified hosted zone.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the request.

    " + }, + "MaxResults":{"type":"string"}, + "MeasureLatency":{"type":"boolean"}, + "Message":{ + "type":"string", + "max":1024 + }, + "MetricName":{ + "type":"string", + "max":255, + "min":1 + }, + "Nameserver":{ + "type":"string", + "max":255, + "min":0 + }, + "Namespace":{ + "type":"string", + "max":255, + "min":1 + }, + "NoSuchChange":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A change with the specified change ID does not exist.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchCloudWatchLogsLogGroup":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    There is no CloudWatch Logs log group with the specified ARN.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchDelegationSet":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    A reusable delegation set with the specified ID does not exist.

    ", + "exception":true + }, + "NoSuchGeoLocation":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    Amazon Route 53 doesn't support the specified geographic location.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchHealthCheck":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    No health check exists with the specified ID.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchHostedZone":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    No hosted zone exists with the ID that you specified.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchQueryLoggingConfig":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    There is no DNS query logging configuration with the specified ID.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchTrafficPolicy":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    No traffic policy exists with the specified ID.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchTrafficPolicyInstance":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    No traffic policy instance exists with the specified ID.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Nonce":{ + "type":"string", + "max":128, + "min":1 + }, + "NotAuthorizedException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    Associating the specified VPC with the specified hosted zone has not been authorized.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "PageMarker":{ + "type":"string", + "max":64 + }, + "PageMaxItems":{"type":"string"}, + "PageTruncated":{"type":"boolean"}, + "PaginationToken":{ + "type":"string", + "max":256 + }, + "Period":{ + "type":"integer", + "min":60 + }, + "Port":{ + "type":"integer", + "max":65535, + "min":1 + }, + "PriorRequestNotComplete":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "PublicZoneVPCAssociation":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a VPC with a public hosted zone.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "QueryLoggingConfig":{ + "type":"structure", + "required":[ + "Id", + "HostedZoneId", + "CloudWatchLogsLogGroupArn" + ], + "members":{ + "Id":{ + "shape":"QueryLoggingConfigId", + "documentation":"

    The ID for a configuration for DNS query logging.

    " + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that CloudWatch Logs is logging queries for.

    " + }, + "CloudWatchLogsLogGroupArn":{ + "shape":"CloudWatchLogsLogGroupArn", + "documentation":"

    The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

    " + } + }, + "documentation":"

    A complex type that contains information about a configuration for DNS query logging.

    " + }, + "QueryLoggingConfigAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists for this hosted zone.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "QueryLoggingConfigId":{ + "type":"string", + "max":36, + "min":1 + }, + "QueryLoggingConfigs":{ + "type":"list", + "member":{ + "shape":"QueryLoggingConfig", + "locationName":"QueryLoggingConfig" + } + }, + "RData":{ + "type":"string", + "max":4000 + }, + "RRType":{ + "type":"string", + "enum":[ + "SOA", + "A", + "TXT", + "NS", + "CNAME", + "MX", + "NAPTR", + "PTR", + "SRV", + "SPF", + "AAAA", + "CAA" + ] + }, + "RecordData":{ + "type":"list", + "member":{ + "shape":"RecordDataEntry", + "locationName":"RecordDataEntry" + } + }, + "RecordDataEntry":{ + "type":"string", + "documentation":"

    A value that Amazon Route 53 returned for this resource record set. A RecordDataEntry element is one of the following:

    • For non-alias resource record sets, a RecordDataEntry element contains one value in the resource record set. If the resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

    • For multiple resource record sets that have the same name and type, which includes weighted, latency, geolocation, and failover, a RecordDataEntry element contains the value from the appropriate resource record set based on the request.

    • For alias resource record sets that refer to AWS resources other than another resource record set, the RecordDataEntry element contains an IP address or a domain name for the AWS resource, depending on the type of resource.

    • For alias resource record sets that refer to other resource record sets, a RecordDataEntry element contains one value from the referenced resource record set. If the referenced resource record set contains multiple values, the response includes one RecordDataEntry element for each value.

    ", + "max":512, + "min":0 + }, + "RequestInterval":{ + "type":"integer", + "max":30, + "min":10 + }, + "ResettableElementName":{ + "type":"string", + "enum":[ + "FullyQualifiedDomainName", + "Regions", + "ResourcePath", + "ChildHealthChecks" + ], + "max":64, + "min":1 + }, + "ResettableElementNameList":{ + "type":"list", + "member":{ + "shape":"ResettableElementName", + "locationName":"ResettableElementName" + }, + "max":64 + }, + "ResourceDescription":{ + "type":"string", + "max":256 + }, + "ResourceId":{ + "type":"string", + "max":32 + }, + "ResourcePath":{ + "type":"string", + "max":255 + }, + "ResourceRecord":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{ + "shape":"RData", + "documentation":"

    The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

    You can specify more than one value for all record types except CNAME and SOA.

    If you're creating an alias resource record set, omit Value.

    " + } + }, + "documentation":"

    Information specific to the resource record.

    If you're creating an alias resource record set, omit ResourceRecord.

    " + }, + "ResourceRecordSet":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "Name":{ + "shape":"DNSName", + "documentation":"

    For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

    ChangeResourceRecordSets Only

    Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

    For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

    You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

    • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

    • The * can't replace any of the middle labels, for example, marketing.*.example.com.

    • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

      You can't use the * wildcard for resource records sets that have a type of NS.

    You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

    " + }, + "Type":{ + "shape":"RRType", + "documentation":"

    The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

    Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

    Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

    Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

    SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, \"...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.\" In RFC 7208, see section 14.1, The SPF DNS Record Type.

    Values for alias resource record sets:

    • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

    • CloudFront distributions: A

      If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

    • AWS Elastic Beanstalk environment that has a regionalized subdomain: A

    • ELB load balancers: A | AAAA

    • Amazon S3 buckets: A

    • Amazon Virtual Private Cloud interface VPC endpoints A

    • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

      If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
    " + }, + "SetIdentifier":{ + "shape":"ResourceRecordSetIdentifier", + "documentation":"

    Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

    For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

    " + }, + "Weight":{ + "shape":"ResourceRecordSetWeight", + "documentation":"

    Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

    • You must specify a value for the Weight element for every weighted resource record set.

    • You can only specify one ResourceRecord per weighted resource record set.

    • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

    • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

    • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

      The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

    " + }, + "Region":{ + "shape":"ResourceRecordSetRegion", + "documentation":"

    Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an AWS resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

    Creating latency and latency alias resource record sets in private hosted zones is not supported.

    When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

    Note the following:

    • You can only specify one ResourceRecord per latency resource record set.

    • You can only create one latency resource record set for each Amazon EC2 Region.

    • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

    • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

    " + }, + "GeoLocation":{ + "shape":"GeoLocation", + "documentation":"

    Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

    Creating geolocation and geolocation alias resource record sets in private hosted zones is not supported.

    If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

    You can't create two geolocation resource record sets that specify the same geographic location.

    The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

    Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *, which handles both queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a \"no answer\" response for queries from those locations.

    You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

    " + }, + "Failover":{ + "shape":"ResourceRecordSetFailover", + "documentation":"

    Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

    Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

    • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

    • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

    • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

    • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

    You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

    For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

    For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

    " + }, + "MultiValueAnswer":{ + "shape":"ResourceRecordSetMultiValueAnswer", + "documentation":"

    Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

    • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

    • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

    • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

    • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

    • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

    • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

    You can't create multivalue answer alias records.

    " + }, + "TTL":{ + "shape":"TTL", + "documentation":"

    The resource record cache time to live (TTL), in seconds. Note the following:

    • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

    • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

    • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

    • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

    " + }, + "ResourceRecords":{ + "shape":"ResourceRecords", + "documentation":"

    Information about the resource records to act upon.

    If you're creating an alias resource record set, omit ResourceRecords.

    " + }, + "AliasTarget":{ + "shape":"AliasTarget", + "documentation":"

    Alias resource record sets only: Information about the AWS resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

    If you're creating resource records sets for a private hosted zone, note the following:

    • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

    • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.

    • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

    " + }, + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

    Route 53 determines whether a resource record set is healthy based on one of the following:

    • By periodically sending a request to the endpoint that is specified in the health check

    • By aggregating the status of a specified group of health checks (calculated health checks)

    • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

    Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.

    For more information, see the following topics in the Amazon Route 53 Developer Guide:

    When to Specify HealthCheckId

    Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

    • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

      If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

      If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

      If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

    • Alias resource record sets: You specify the following settings:

      • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

      • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

      • You specify a health check ID for the non-alias resource record set.

      If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

      If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

      The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

    Geolocation Routing

    For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

    • The United States

    • North America

    • The default resource record set

    Specifying the Health Check Endpoint by Domain Name

    If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    Health check results will be unpredictable if you do the following:

    • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

    • Associate that health check with the resource record set.

    " + }, + "TrafficPolicyInstanceId":{ + "shape":"TrafficPolicyInstanceId", + "documentation":"

    When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

    " + } + }, + "documentation":"

    Information about the resource record set to create or delete.

    " + }, + "ResourceRecordSetFailover":{ + "type":"string", + "enum":[ + "PRIMARY", + "SECONDARY" + ] + }, + "ResourceRecordSetIdentifier":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceRecordSetMultiValueAnswer":{"type":"boolean"}, + "ResourceRecordSetRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "ca-central-1", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "eu-central-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "eu-north-1", + "sa-east-1", + "cn-north-1", + "cn-northwest-1", + "ap-east-1", + "me-south-1", + "ap-south-1" + ], + "max":64, + "min":1 + }, + "ResourceRecordSetWeight":{ + "type":"long", + "max":255, + "min":0 + }, + "ResourceRecordSets":{ + "type":"list", + "member":{ + "shape":"ResourceRecordSet", + "locationName":"ResourceRecordSet" + } + }, + "ResourceRecords":{ + "type":"list", + "member":{ + "shape":"ResourceRecord", + "locationName":"ResourceRecord" + }, + "min":1 + }, + "ResourceTagSet":{ + "type":"structure", + "members":{ + "ResourceType":{ + "shape":"TagResourceType", + "documentation":"

    The type of the resource.

    • The resource type for health checks is healthcheck.

    • The resource type for hosted zones is hostedzone.

    " + }, + "ResourceId":{ + "shape":"TagResourceId", + "documentation":"

    The ID for the specified resource.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags associated with the specified resource.

    " + } + }, + "documentation":"

    A complex type containing a resource and its associated tags.

    " + }, + "ResourceTagSetList":{ + "type":"list", + "member":{ + "shape":"ResourceTagSet", + "locationName":"ResourceTagSet" + } + }, + "ResourceURI":{ + "type":"string", + "max":1024 + }, + "ReusableDelegationSetLimit":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"ReusableDelegationSetLimitType", + "documentation":"

    The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate with the specified reusable delegation set.

    " + }, + "Value":{ + "shape":"LimitValue", + "documentation":"

    The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET limit.

    " + } + }, + "documentation":"

    A complex type that contains the type of limit that you specified in the request and the current value for that limit.

    " + }, + "ReusableDelegationSetLimitType":{ + "type":"string", + "enum":["MAX_ZONES_BY_REUSABLE_DELEGATION_SET"] + }, + "SearchString":{ + "type":"string", + "max":255 + }, + "ServicePrincipal":{ + "type":"string", + "max":128 + }, + "Statistic":{ + "type":"string", + "enum":[ + "Average", + "Sum", + "SampleCount", + "Maximum", + "Minimum" + ] + }, + "Status":{"type":"string"}, + "StatusReport":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

    A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

    " + }, + "CheckedTime":{ + "shape":"TimeStamp", + "documentation":"

    The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

    " + } + }, + "documentation":"

    A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check.

    " + }, + "SubnetMask":{ + "type":"string", + "max":3, + "min":0 + }, + "TTL":{ + "type":"long", + "max":2147483647, + "min":0 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The value of Key depends on the operation that you want to perform:

    • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.

    • Edit a tag: Key is the name of the tag that you want to change the Value for.

    • Delete a key: Key is the name of the tag you want to remove.

    • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value of Value depends on the operation that you want to perform:

    • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.

    • Edit a tag: Value is the new value that you want to assign the tag.

    " + } + }, + "documentation":"

    A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.

    " + }, + "TagKey":{ + "type":"string", + "max":128 + }, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"Key" + }, + "max":10, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + }, + "max":10, + "min":1 + }, + "TagResourceId":{ + "type":"string", + "max":64 + }, + "TagResourceIdList":{ + "type":"list", + "member":{ + "shape":"TagResourceId", + "locationName":"ResourceId" + }, + "max":10, + "min":1 + }, + "TagResourceType":{ + "type":"string", + "enum":[ + "healthcheck", + "hostedzone" + ] + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "TestDNSAnswerRequest":{ + "type":"structure", + "required":[ + "HostedZoneId", + "RecordName", + "RecordType" + ], + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

    ", + "location":"querystring", + "locationName":"hostedzoneid" + }, + "RecordName":{ + "shape":"DNSName", + "documentation":"

    The name of the resource record set that you want Amazon Route 53 to simulate a query for.

    ", + "location":"querystring", + "locationName":"recordname" + }, + "RecordType":{ + "shape":"RRType", + "documentation":"

    The type of the resource record set.

    ", + "location":"querystring", + "locationName":"recordtype" + }, + "ResolverIP":{ + "shape":"IPAddress", + "documentation":"

    If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the AWS US East (N. Virginia) Region (us-east-1).

    ", + "location":"querystring", + "locationName":"resolverip" + }, + "EDNS0ClientSubnetIP":{ + "shape":"IPAddress", + "documentation":"

    If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

    ", + "location":"querystring", + "locationName":"edns0clientsubnetip" + }, + "EDNS0ClientSubnetMask":{ + "shape":"SubnetMask", + "documentation":"

    If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

    The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

    • IPv4: Specify a value between 0 and 32

    • IPv6: Specify a value between 0 and 128

    ", + "location":"querystring", + "locationName":"edns0clientsubnetmask" + } + }, + "documentation":"

    Gets the value that Amazon Route 53 returns in response to a DNS request for a specified record name and type. You can optionally specify the IP address of a DNS resolver, an EDNS0 client subnet IP address, and a subnet mask.

    " + }, + "TestDNSAnswerResponse":{ + "type":"structure", + "required":[ + "Nameserver", + "RecordName", + "RecordType", + "RecordData", + "ResponseCode", + "Protocol" + ], + "members":{ + "Nameserver":{ + "shape":"Nameserver", + "documentation":"

    The Amazon Route 53 name server used to respond to the request.

    " + }, + "RecordName":{ + "shape":"DNSName", + "documentation":"

    The name of the resource record set that you submitted a request for.

    " + }, + "RecordType":{ + "shape":"RRType", + "documentation":"

    The type of the resource record set that you submitted a request for.

    " + }, + "RecordData":{ + "shape":"RecordData", + "documentation":"

    A list that contains values that Amazon Route 53 returned for this resource record set.

    " + }, + "ResponseCode":{ + "shape":"DNSRCode", + "documentation":"

    A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.

    " + }, + "Protocol":{ + "shape":"TransportProtocol", + "documentation":"

    The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

    " + } + }, + "documentation":"

    A complex type that contains the response to a TestDNSAnswer request.

    " + }, + "Threshold":{"type":"double"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The limit on the number of requests per second was exceeded.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TimeStamp":{"type":"timestamp"}, + "TooManyHealthChecks":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    This health check can't be created because the current account has reached the limit on the number of active health checks.

    For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

    For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the AWS Support Center.

    You have reached the maximum number of active health checks for an AWS account. To request a higher limit, create a case with the AWS Support Center.

    ", + "exception":true + }, + "TooManyHostedZones":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This operation can't be completed either because the current account has reached the limit on the number of hosted zones or because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.

    For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

    To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.

    To get the current limit on hosted zones that can be associated with a reusable delegation set, see GetReusableDelegationSetLimit.

    To request a higher limit, create a case with the AWS Support Center.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrafficPolicies":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.

    For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

    To get the current limit for an account, see GetAccountLimit.

    To request a higher limit, create a case with the AWS Support Center.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrafficPolicyInstances":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This traffic policy instance can't be created because the current account has reached the limit on the number of traffic policy instances.

    For information about default limits, see Limits in the Amazon Route 53 Developer Guide.

    For information about how to get the current limit for an account, see GetAccountLimit.

    To request a higher limit, create a case with the AWS Support Center.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyTrafficPolicyVersionsForCurrentPolicy":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    This traffic policy version can't be created because you've reached the limit of 1000 on the number of versions that you can create for the current traffic policy.

    To create more traffic policy versions, you can use GetTrafficPolicy to get the traffic policy document for a specified traffic policy version, and then use CreateTrafficPolicy to create a new traffic policy using the traffic policy document.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TooManyVPCAssociationAuthorizations":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    You've created the maximum number of authorizations that can be created for the specified hosted zone. To authorize another VPC to be associated with the hosted zone, submit a DeleteVPCAssociationAuthorization request to remove an existing authorization. To get a list of existing authorizations, submit a ListVPCAssociationAuthorizations request.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrafficPolicies":{ + "type":"list", + "member":{ + "shape":"TrafficPolicy", + "locationName":"TrafficPolicy" + } + }, + "TrafficPolicy":{ + "type":"structure", + "required":[ + "Id", + "Version", + "Name", + "Type", + "Document" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID that Amazon Route 53 assigned to a traffic policy when you created it.

    " + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

    " + }, + "Name":{ + "shape":"TrafficPolicyName", + "documentation":"

    The name that you specified when you created the traffic policy.

    " + }, + "Type":{ + "shape":"RRType", + "documentation":"

    The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

    " + }, + "Document":{ + "shape":"TrafficPolicyDocument", + "documentation":"

    The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

    " + }, + "Comment":{ + "shape":"TrafficPolicyComment", + "documentation":"

    The comment that you specify in the CreateTrafficPolicy request, if any.

    " + } + }, + "documentation":"

    A complex type that contains settings for a traffic policy.

    " + }, + "TrafficPolicyAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    A traffic policy that has the same value for Name already exists.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "TrafficPolicyComment":{ + "type":"string", + "max":1024 + }, + "TrafficPolicyDocument":{ + "type":"string", + "max":102400 + }, + "TrafficPolicyId":{ + "type":"string", + "max":36, + "min":1 + }, + "TrafficPolicyInUse":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    One or more traffic policy instances were created by using the specified traffic policy.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "TrafficPolicyInstance":{ + "type":"structure", + "required":[ + "Id", + "HostedZoneId", + "Name", + "TTL", + "State", + "Message", + "TrafficPolicyId", + "TrafficPolicyVersion", + "TrafficPolicyType" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "documentation":"

    The ID that Amazon Route 53 assigned to the new traffic policy instance.

    " + }, + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the hosted zone that Amazon Route 53 created resource record sets in.

    " + }, + "Name":{ + "shape":"DNSName", + "documentation":"

    The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

    " + }, + "TTL":{ + "shape":"TTL", + "documentation":"

    The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

    " + }, + "State":{ + "shape":"TrafficPolicyInstanceState", + "documentation":"

    The value of State is one of the following values:

    Applied

    Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.

    Creating

    Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.

    Failed

    Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

    " + }, + "Message":{ + "shape":"Message", + "documentation":"

    If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

    " + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    " + }, + "TrafficPolicyVersion":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

    " + }, + "TrafficPolicyType":{ + "shape":"RRType", + "documentation":"

    The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

    " + } + }, + "documentation":"

    A complex type that contains settings for the new traffic policy instance.

    " + }, + "TrafficPolicyInstanceAlreadyExists":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    There is already a traffic policy instance with the specified ID.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "TrafficPolicyInstanceCount":{"type":"integer"}, + "TrafficPolicyInstanceId":{ + "type":"string", + "max":36, + "min":1 + }, + "TrafficPolicyInstanceState":{"type":"string"}, + "TrafficPolicyInstances":{ + "type":"list", + "member":{ + "shape":"TrafficPolicyInstance", + "locationName":"TrafficPolicyInstance" + } + }, + "TrafficPolicyName":{ + "type":"string", + "max":512 + }, + "TrafficPolicySummaries":{ + "type":"list", + "member":{ + "shape":"TrafficPolicySummary", + "locationName":"TrafficPolicySummary" + } + }, + "TrafficPolicySummary":{ + "type":"structure", + "required":[ + "Id", + "Name", + "Type", + "LatestVersion", + "TrafficPolicyCount" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID that Amazon Route 53 assigned to the traffic policy when you created it.

    " + }, + "Name":{ + "shape":"TrafficPolicyName", + "documentation":"

    The name that you specified for the traffic policy when you created it.

    " + }, + "Type":{ + "shape":"RRType", + "documentation":"

    The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

    " + }, + "LatestVersion":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version number of the latest version of the traffic policy.

    " + }, + "TrafficPolicyCount":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The number of traffic policies that are associated with the current AWS account.

    " + } + }, + "documentation":"

    A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.

    " + }, + "TrafficPolicyVersion":{ + "type":"integer", + "max":1000, + "min":1 + }, + "TrafficPolicyVersionMarker":{ + "type":"string", + "max":4 + }, + "TransportProtocol":{"type":"string"}, + "UpdateHealthCheckRequest":{ + "type":"structure", + "required":["HealthCheckId"], + "members":{ + "HealthCheckId":{ + "shape":"HealthCheckId", + "documentation":"

    The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

    ", + "location":"uri", + "locationName":"HealthCheckId" + }, + "HealthCheckVersion":{ + "shape":"HealthCheckVersion", + "documentation":"

    A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

    We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

    • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

    • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

    " + }, + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

    The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

    Use one of the following formats for the value of IPAddress:

    • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

    • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

    If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

    For more information, see FullyQualifiedDomainName.

    Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

    " + }, + "Port":{ + "shape":"Port", + "documentation":"

    The port on the endpoint on which you want Amazon Route 53 to perform health checks.

    " + }, + "ResourcePath":{ + "shape":"ResourcePath", + "documentation":"

    The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

    Specify this value only if you want to change it.

    " + }, + "FullyQualifiedDomainName":{ + "shape":"FullyQualifiedDomainName", + "documentation":"

    Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

    If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

    If you specify a value for IPAddress:

    Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

    When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

    • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

    • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

    If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

    If you don't specify a value for IPAddress:

    If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

    If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a \"DNS resolution failed\" error.

    If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

    In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

    In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

    " + }, + "SearchString":{ + "shape":"SearchString", + "documentation":"

    If the value of Type is HTTP_STR_MATCH or HTTP_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

    " + }, + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

    The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

    If you don't specify a value for FailureThreshold, the default value is three health checks.

    " + }, + "Inverted":{ + "shape":"Inverted", + "documentation":"

    Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

    " + }, + "Disabled":{ + "shape":"Disabled", + "documentation":"

    Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

    • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

    • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

    • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

    After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

    Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

    " + }, + "HealthThreshold":{ + "shape":"HealthThreshold", + "documentation":"

    The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

    Note the following:

    • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

    • If you specify 0, Route 53 always considers this health check to be healthy.

    " + }, + "ChildHealthChecks":{ + "shape":"ChildHealthCheckList", + "documentation":"

    A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

    " + }, + "EnableSNI":{ + "shape":"EnableSNI", + "documentation":"

    Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

    Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

    The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

    " + }, + "Regions":{ + "shape":"HealthCheckRegionList", + "documentation":"

    A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

    " + }, + "AlarmIdentifier":{ + "shape":"AlarmIdentifier", + "documentation":"

    A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

    " + }, + "InsufficientDataHealthStatus":{ + "shape":"InsufficientDataHealthStatus", + "documentation":"

    When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

    • Healthy: Route 53 considers the health check to be healthy.

    • Unhealthy: Route 53 considers the health check to be unhealthy.

    • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

    " + }, + "ResetElements":{ + "shape":"ResettableElementNameList", + "documentation":"

    A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

    " + } + }, + "documentation":"

    A complex type that contains information about a request to update a health check.

    " + }, + "UpdateHealthCheckResponse":{ + "type":"structure", + "required":["HealthCheck"], + "members":{ + "HealthCheck":{ + "shape":"HealthCheck", + "documentation":"

    A complex type that contains the response to an UpdateHealthCheck request.

    " + } + }, + "documentation":"

    A complex type that contains the response to the UpdateHealthCheck request.

    " + }, + "UpdateHostedZoneCommentRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID for the hosted zone that you want to update the comment for.

    ", + "location":"uri", + "locationName":"Id" + }, + "Comment":{ + "shape":"ResourceDescription", + "documentation":"

    The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

    " + } + }, + "documentation":"

    A request to update the comment for a hosted zone.

    " + }, + "UpdateHostedZoneCommentResponse":{ + "type":"structure", + "required":["HostedZone"], + "members":{ + "HostedZone":{ + "shape":"HostedZone", + "documentation":"

    A complex type that contains the response to the UpdateHostedZoneComment request.

    " + } + }, + "documentation":"

    A complex type that contains the response to the UpdateHostedZoneComment request.

    " + }, + "UpdateTrafficPolicyCommentRequest":{ + "type":"structure", + "required":[ + "Id", + "Version", + "Comment" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyId", + "documentation":"

    The value of Id for the traffic policy that you want to update the comment for.

    ", + "location":"uri", + "locationName":"Id" + }, + "Version":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The value of Version for the traffic policy that you want to update the comment for.

    ", + "location":"uri", + "locationName":"Version" + }, + "Comment":{ + "shape":"TrafficPolicyComment", + "documentation":"

    The new comment for the specified traffic policy and version.

    " + } + }, + "documentation":"

    A complex type that contains information about the traffic policy that you want to update the comment for.

    " + }, + "UpdateTrafficPolicyCommentResponse":{ + "type":"structure", + "required":["TrafficPolicy"], + "members":{ + "TrafficPolicy":{ + "shape":"TrafficPolicy", + "documentation":"

    A complex type that contains settings for the specified traffic policy.

    " + } + }, + "documentation":"

    A complex type that contains the response information for the traffic policy.

    " + }, + "UpdateTrafficPolicyInstanceRequest":{ + "type":"structure", + "required":[ + "Id", + "TTL", + "TrafficPolicyId", + "TrafficPolicyVersion" + ], + "members":{ + "Id":{ + "shape":"TrafficPolicyInstanceId", + "documentation":"

    The ID of the traffic policy instance that you want to update.

    ", + "location":"uri", + "locationName":"Id" + }, + "TTL":{ + "shape":"TTL", + "documentation":"

    The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

    " + }, + "TrafficPolicyId":{ + "shape":"TrafficPolicyId", + "documentation":"

    The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

    " + }, + "TrafficPolicyVersion":{ + "shape":"TrafficPolicyVersion", + "documentation":"

    The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

    " + } + }, + "documentation":"

    A complex type that contains information about the resource record sets that you want to update based on a specified traffic policy instance.

    " + }, + "UpdateTrafficPolicyInstanceResponse":{ + "type":"structure", + "required":["TrafficPolicyInstance"], + "members":{ + "TrafficPolicyInstance":{ + "shape":"TrafficPolicyInstance", + "documentation":"

    A complex type that contains settings for the updated traffic policy instance.

    " + } + }, + "documentation":"

    A complex type that contains information about the resource record sets that Amazon Route 53 created based on a specified traffic policy.

    " + }, + "UsageCount":{ + "type":"long", + "min":0 + }, + "VPC":{ + "type":"structure", + "members":{ + "VPCRegion":{ + "shape":"VPCRegion", + "documentation":"

    (Private hosted zones only) The region that an Amazon VPC was created in.

    " + }, + "VPCId":{"shape":"VPCId"} + }, + "documentation":"

    (Private hosted zones only) A complex type that contains information about an Amazon VPC.

    " + }, + "VPCAssociationAuthorizationNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The VPC that you specified is not authorized to be associated with the hosted zone.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "VPCAssociationNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Descriptive message for the error response.

    " + } + }, + "documentation":"

    The specified VPC and hosted zone are not currently associated.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "VPCId":{ + "type":"string", + "documentation":"

    (Private hosted zones only) The ID of an Amazon VPC.

    ", + "max":1024 + }, + "VPCRegion":{ + "type":"string", + "enum":[ + "us-east-1", + "us-east-2", + "us-west-1", + "us-west-2", + "eu-west-1", + "eu-west-2", + "eu-west-3", + "eu-central-1", + "ap-east-1", + "me-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-south-1", + "ap-northeast-1", + "ap-northeast-2", + "ap-northeast-3", + "eu-north-1", + "sa-east-1", + "ca-central-1", + "cn-north-1" + ], + "max":64, + "min":1 + }, + "VPCs":{ + "type":"list", + "member":{ + "shape":"VPC", + "locationName":"VPC" + }, + "documentation":"

    (Private hosted zones only) A list of VPC elements.

    ", + "min":1 + } + }, + "documentation":"

    Amazon Route 53 is a highly available and scalable Domain Name System (DNS) web service.

    " +} diff --git a/aws/dist/botocore/data/route53/2013-04-01/waiters-2.json b/aws/dist/botocore/data/route53/2013-04-01/waiters-2.json new file mode 100644 index 00000000..94aad399 --- /dev/null +++ b/aws/dist/botocore/data/route53/2013-04-01/waiters-2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "ResourceRecordSetsChanged": { + "delay": 30, + "maxAttempts": 60, + "operation": "GetChange", + "acceptors": [ + { + "matcher": "path", + "expected": "INSYNC", + "argument": "ChangeInfo.Status", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/route53domains/2014-05-15/paginators-1.json b/aws/dist/botocore/data/route53domains/2014-05-15/paginators-1.json new file mode 100644 index 00000000..7ccbf9da --- /dev/null +++ b/aws/dist/botocore/data/route53domains/2014-05-15/paginators-1.json @@ -0,0 +1,23 @@ +{ + "version": "1.0", + "pagination": { + "ListDomains": { + "limit_key": "MaxItems", + "input_token": "Marker", + "output_token": "NextPageMarker", + "result_key": "Domains" + }, + "ListOperations": { + "limit_key": "MaxItems", + "input_token": "Marker", + "output_token": "NextPageMarker", + "result_key": "Operations" + }, + "ViewBilling": { + "input_token": "Marker", + "limit_key": "MaxItems", + "output_token": "NextPageMarker", + "result_key": "BillingRecords" + } + } +} diff --git a/aws/dist/botocore/data/route53domains/2014-05-15/service-2.json b/aws/dist/botocore/data/route53domains/2014-05-15/service-2.json new file mode 100644 index 00000000..4a7dfc94 --- /dev/null +++ b/aws/dist/botocore/data/route53domains/2014-05-15/service-2.json @@ -0,0 +1,1931 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-05-15", + "endpointPrefix":"route53domains", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Route 53 Domains", + "serviceId":"Route 53 Domains", + "signatureVersion":"v4", + "targetPrefix":"Route53Domains_v20140515", + "uid":"route53domains-2014-05-15" + }, + "operations":{ + "CheckDomainAvailability":{ + "name":"CheckDomainAvailability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CheckDomainAvailabilityRequest"}, + "output":{"shape":"CheckDomainAvailabilityResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

    " + }, + "CheckDomainTransferability":{ + "name":"CheckDomainTransferability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CheckDomainTransferabilityRequest"}, + "output":{"shape":"CheckDomainTransferabilityResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    Checks whether a domain name can be transferred to Amazon Route 53.

    " + }, + "DeleteTagsForDomain":{ + "name":"DeleteTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsForDomainRequest"}, + "output":{"shape":"DeleteTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation deletes the specified tags for a domain.

    All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

    " + }, + "DisableDomainAutoRenew":{ + "name":"DisableDomainAutoRenew", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableDomainAutoRenewRequest"}, + "output":{"shape":"DisableDomainAutoRenewResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation disables automatic renewal of domain registration for the specified domain.

    " + }, + "DisableDomainTransferLock":{ + "name":"DisableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableDomainTransferLockRequest"}, + "output":{"shape":"DisableDomainTransferLockResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

    " + }, + "EnableDomainAutoRenew":{ + "name":"EnableDomainAutoRenew", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableDomainAutoRenewRequest"}, + "output":{"shape":"EnableDomainAutoRenewResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"TLDRulesViolation"} + ], + "documentation":"

    This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.

    The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \"Renewal, restoration, and deletion times\" on the website for our registrar associate, Gandi. Amazon Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

    " + }, + "EnableDomainTransferLock":{ + "name":"EnableDomainTransferLock", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableDomainTransferLockRequest"}, + "output":{"shape":"EnableDomainTransferLockResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

    " + }, + "GetContactReachabilityStatus":{ + "name":"GetContactReachabilityStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetContactReachabilityStatusRequest"}, + "output":{"shape":"GetContactReachabilityStatusResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.

    If you want us to resend the email, use the ResendContactReachabilityEmail operation.

    " + }, + "GetDomainDetail":{ + "name":"GetDomainDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDomainDetailRequest"}, + "output":{"shape":"GetDomainDetailResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.

    " + }, + "GetDomainSuggestions":{ + "name":"GetDomainSuggestions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDomainSuggestionsRequest"}, + "output":{"shape":"GetDomainSuggestionsResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).

    " + }, + "GetOperationDetail":{ + "name":"GetOperationDetail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOperationDetailRequest"}, + "output":{"shape":"GetOperationDetailResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    This operation returns the current status of an operation that is not completed.

    " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

    " + }, + "ListOperations":{ + "name":"ListOperations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOperationsRequest"}, + "output":{"shape":"ListOperationsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    This operation returns the operation IDs of operations that are not yet complete.

    " + }, + "ListTagsForDomain":{ + "name":"ListTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForDomainRequest"}, + "output":{"shape":"ListTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation returns all of the tags that are associated with the specified domain.

    All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

    " + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDomainRequest"}, + "output":{"shape":"RegisterDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"DomainLimitExceeded"}, + {"shape":"OperationLimitExceeded"} + ], + "documentation":"

    This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.

    When you register a domain, Amazon Route 53 does the following:

    • Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.

    • Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.

    • Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.

    • If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.

    • Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

    " + }, + "RenewDomain":{ + "name":"RenewDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RenewDomainRequest"}, + "output":{"shape":"RenewDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"} + ], + "documentation":"

    This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.

    We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.

    " + }, + "ResendContactReachabilityEmail":{ + "name":"ResendContactReachabilityEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResendContactReachabilityEmailRequest"}, + "output":{"shape":"ResendContactReachabilityEmailResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.

    " + }, + "RetrieveDomainAuthCode":{ + "name":"RetrieveDomainAuthCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveDomainAuthCodeRequest"}, + "output":{"shape":"RetrieveDomainAuthCodeResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

    " + }, + "TransferDomain":{ + "name":"TransferDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TransferDomainRequest"}, + "output":{"shape":"TransferDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"UnsupportedTLD"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"DomainLimitExceeded"}, + {"shape":"OperationLimitExceeded"} + ], + "documentation":"

    This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).

    For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

    If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

    If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

    If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

    " + }, + "UpdateDomainContact":{ + "name":"UpdateDomainContact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainContactRequest"}, + "output":{"shape":"UpdateDomainContactResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.

    If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

    " + }, + "UpdateDomainContactPrivacy":{ + "name":"UpdateDomainContactPrivacy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainContactPrivacyRequest"}, + "output":{"shape":"UpdateDomainContactPrivacyResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.

    This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.

    " + }, + "UpdateDomainNameservers":{ + "name":"UpdateDomainNameservers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainNameserversRequest"}, + "output":{"shape":"UpdateDomainNameserversResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"DuplicateRequest"}, + {"shape":"TLDRulesViolation"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

    If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

    " + }, + "UpdateTagsForDomain":{ + "name":"UpdateTagsForDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTagsForDomainRequest"}, + "output":{"shape":"UpdateTagsForDomainResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationLimitExceeded"}, + {"shape":"UnsupportedTLD"} + ], + "documentation":"

    This operation adds or updates tags for a specified domain.

    All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

    " + }, + "ViewBilling":{ + "name":"ViewBilling", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ViewBillingRequest"}, + "output":{"shape":"ViewBillingResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Returns all the domain-related billing records for the current AWS account for a specified period

    " + } + }, + "shapes":{ + "AddressLine":{ + "type":"string", + "max":255 + }, + "BillingRecord":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that the billing record applies to. If the domain name contains characters other than a-z, 0-9, and - (hyphen), such as an internationalized domain name, then this value is in Punycode. For more information, see DNS Domain Name Format in the Amazon Route 53 Developer Guidezzz.

    " + }, + "Operation":{ + "shape":"OperationType", + "documentation":"

    The operation that you were charged for.

    " + }, + "InvoiceId":{ + "shape":"InvoiceId", + "documentation":"

    The ID of the invoice that is associated with the billing record.

    " + }, + "BillDate":{ + "shape":"Timestamp", + "documentation":"

    The date that the operation was billed, in Unix format.

    " + }, + "Price":{ + "shape":"Price", + "documentation":"

    The price that you were charged for the operation, in US dollars.

    Example value: 12.0

    " + } + }, + "documentation":"

    Information for one billing record.

    " + }, + "BillingRecords":{ + "type":"list", + "member":{"shape":"BillingRecord"} + }, + "Boolean":{"type":"boolean"}, + "CheckDomainAvailabilityRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to get availability for.

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    " + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

    Reserved for future use.

    " + } + }, + "documentation":"

    The CheckDomainAvailability request contains the following elements.

    " + }, + "CheckDomainAvailabilityResponse":{ + "type":"structure", + "required":["Availability"], + "members":{ + "Availability":{ + "shape":"DomainAvailability", + "documentation":"

    Whether the domain name is available for registering.

    You can register only domains designated as AVAILABLE.

    Valid values:

    AVAILABLE

    The domain name is available.

    AVAILABLE_RESERVED

    The domain name is reserved under specific conditions.

    AVAILABLE_PREORDER

    The domain name is available and can be preordered.

    DONT_KNOW

    The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

    PENDING

    The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.

    RESERVED

    The domain name has been reserved for another person or organization.

    UNAVAILABLE

    The domain name is not available.

    UNAVAILABLE_PREMIUM

    The domain name is not available.

    UNAVAILABLE_RESTRICTED

    The domain name is forbidden.

    " + } + }, + "documentation":"

    The CheckDomainAvailability response includes the following elements.

    " + }, + "CheckDomainTransferabilityRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to transfer to Amazon Route 53.

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    " + }, + "AuthCode":{ + "shape":"DomainAuthCode", + "documentation":"

    If the registrar for the top-level domain (TLD) requires an authorization code to transfer the domain, the code that you got from the current registrar for the domain.

    " + } + }, + "documentation":"

    The CheckDomainTransferability request contains the following elements.

    " + }, + "CheckDomainTransferabilityResponse":{ + "type":"structure", + "required":["Transferability"], + "members":{ + "Transferability":{ + "shape":"DomainTransferability", + "documentation":"

    A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53.

    " + } + }, + "documentation":"

    The CheckDomainTransferability response includes the following elements.

    " + }, + "City":{ + "type":"string", + "max":255 + }, + "ContactDetail":{ + "type":"structure", + "members":{ + "FirstName":{ + "shape":"ContactName", + "documentation":"

    First name of contact.

    " + }, + "LastName":{ + "shape":"ContactName", + "documentation":"

    Last name of contact.

    " + }, + "ContactType":{ + "shape":"ContactType", + "documentation":"

    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

    " + }, + "OrganizationName":{ + "shape":"ContactName", + "documentation":"

    Name of the organization for contact types other than PERSON.

    " + }, + "AddressLine1":{ + "shape":"AddressLine", + "documentation":"

    First line of the contact's address.

    " + }, + "AddressLine2":{ + "shape":"AddressLine", + "documentation":"

    Second line of contact's address, if any.

    " + }, + "City":{ + "shape":"City", + "documentation":"

    The city of the contact's address.

    " + }, + "State":{ + "shape":"State", + "documentation":"

    The state or province of the contact's city.

    " + }, + "CountryCode":{ + "shape":"CountryCode", + "documentation":"

    Code for the country of the contact's address.

    " + }, + "ZipCode":{ + "shape":"ZipCode", + "documentation":"

    The zip or postal code of the contact's address.

    " + }, + "PhoneNumber":{ + "shape":"ContactNumber", + "documentation":"

    The phone number of the contact.

    Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code>]\". For example, a US phone number might appear as \"+1.1234567890\".

    " + }, + "Email":{ + "shape":"Email", + "documentation":"

    Email address of the contact.

    " + }, + "Fax":{ + "shape":"ContactNumber", + "documentation":"

    Fax number of the contact.

    Constraints: Phone number must be specified in the format \"+[country dialing code].[number including any area code]\". For example, a US phone number might appear as \"+1.1234567890\".

    " + }, + "ExtraParams":{ + "shape":"ExtraParamList", + "documentation":"

    A list of name-value pairs for parameters required by certain top-level domains.

    " + } + }, + "documentation":"

    ContactDetail includes the following elements.

    ", + "sensitive":true + }, + "ContactName":{ + "type":"string", + "max":255 + }, + "ContactNumber":{ + "type":"string", + "max":30 + }, + "ContactType":{ + "type":"string", + "enum":[ + "PERSON", + "COMPANY", + "ASSOCIATION", + "PUBLIC_BODY", + "RESELLER" + ] + }, + "CountryCode":{ + "type":"string", + "enum":[ + "AD", + "AE", + "AF", + "AG", + "AI", + "AL", + "AM", + "AN", + "AO", + "AQ", + "AR", + "AS", + "AT", + "AU", + "AW", + "AZ", + "BA", + "BB", + "BD", + "BE", + "BF", + "BG", + "BH", + "BI", + "BJ", + "BL", + "BM", + "BN", + "BO", + "BR", + "BS", + "BT", + "BW", + "BY", + "BZ", + "CA", + "CC", + "CD", + "CF", + "CG", + "CH", + "CI", + "CK", + "CL", + "CM", + "CN", + "CO", + "CR", + "CU", + "CV", + "CX", + "CY", + "CZ", + "DE", + "DJ", + "DK", + "DM", + "DO", + "DZ", + "EC", + "EE", + "EG", + "ER", + "ES", + "ET", + "FI", + "FJ", + "FK", + "FM", + "FO", + "FR", + "GA", + "GB", + "GD", + "GE", + "GH", + "GI", + "GL", + "GM", + "GN", + "GQ", + "GR", + "GT", + "GU", + "GW", + "GY", + "HK", + "HN", + "HR", + "HT", + "HU", + "ID", + "IE", + "IL", + "IM", + "IN", + "IQ", + "IR", + "IS", + "IT", + "JM", + "JO", + "JP", + "KE", + "KG", + "KH", + "KI", + "KM", + "KN", + "KP", + "KR", + "KW", + "KY", + "KZ", + "LA", + "LB", + "LC", + "LI", + "LK", + "LR", + "LS", + "LT", + "LU", + "LV", + "LY", + "MA", + "MC", + "MD", + "ME", + "MF", + "MG", + "MH", + "MK", + "ML", + "MM", + "MN", + "MO", + "MP", + "MR", + "MS", + "MT", + "MU", + "MV", + "MW", + "MX", + "MY", + "MZ", + "NA", + "NC", + "NE", + "NG", + "NI", + "NL", + "NO", + "NP", + "NR", + "NU", + "NZ", + "OM", + "PA", + "PE", + "PF", + "PG", + "PH", + "PK", + "PL", + "PM", + "PN", + "PR", + "PT", + "PW", + "PY", + "QA", + "RO", + "RS", + "RU", + "RW", + "SA", + "SB", + "SC", + "SD", + "SE", + "SG", + "SH", + "SI", + "SK", + "SL", + "SM", + "SN", + "SO", + "SR", + "ST", + "SV", + "SY", + "SZ", + "TC", + "TD", + "TG", + "TH", + "TJ", + "TK", + "TL", + "TM", + "TN", + "TO", + "TR", + "TT", + "TV", + "TW", + "TZ", + "UA", + "UG", + "US", + "UY", + "UZ", + "VA", + "VC", + "VE", + "VG", + "VI", + "VN", + "VU", + "WF", + "WS", + "YE", + "YT", + "ZA", + "ZM", + "ZW" + ] + }, + "CurrentExpiryYear":{"type":"integer"}, + "DNSSec":{"type":"string"}, + "DeleteTagsForDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "TagsToDelete" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain for which you want to delete one or more tags.

    " + }, + "TagsToDelete":{ + "shape":"TagKeyList", + "documentation":"

    A list of tag keys to delete.

    " + } + }, + "documentation":"

    The DeleteTagsForDomainRequest includes the following elements.

    " + }, + "DeleteTagsForDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableDomainAutoRenewRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to disable automatic renewal for.

    " + } + } + }, + "DisableDomainAutoRenewResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to remove the transfer lock for.

    " + } + }, + "documentation":"

    The DisableDomainTransferLock request includes the following element.

    " + }, + "DisableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The DisableDomainTransferLock response includes the following element.

    " + }, + "DomainAuthCode":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "DomainAvailability":{ + "type":"string", + "enum":[ + "AVAILABLE", + "AVAILABLE_RESERVED", + "AVAILABLE_PREORDER", + "UNAVAILABLE", + "UNAVAILABLE_PREMIUM", + "UNAVAILABLE_RESTRICTED", + "RESERVED", + "DONT_KNOW" + ] + }, + "DomainLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The number of domains has exceeded the allowed threshold for the account.

    " + } + }, + "documentation":"

    The number of domains has exceeded the allowed threshold for the account.

    ", + "exception":true + }, + "DomainName":{ + "type":"string", + "max":255 + }, + "DomainStatus":{"type":"string"}, + "DomainStatusList":{ + "type":"list", + "member":{"shape":"DomainStatus"} + }, + "DomainSuggestion":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    A suggested domain name.

    " + }, + "Availability":{ + "shape":"String", + "documentation":"

    Whether the domain name is available for registering.

    You can register only the domains that are designated as AVAILABLE.

    Valid values:

    AVAILABLE

    The domain name is available.

    AVAILABLE_RESERVED

    The domain name is reserved under specific conditions.

    AVAILABLE_PREORDER

    The domain name is available and can be preordered.

    DONT_KNOW

    The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

    PENDING

    The TLD registry didn't return a response in the expected amount of time. When the response is delayed, it usually takes just a few extra seconds. You can resubmit the request immediately.

    RESERVED

    The domain name has been reserved for another person or organization.

    UNAVAILABLE

    The domain name is not available.

    UNAVAILABLE_PREMIUM

    The domain name is not available.

    UNAVAILABLE_RESTRICTED

    The domain name is forbidden.

    " + } + }, + "documentation":"

    Information about one suggested domain name.

    " + }, + "DomainSuggestionsList":{ + "type":"list", + "member":{"shape":"DomainSuggestion"} + }, + "DomainSummary":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that the summary information applies to.

    " + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the domain is automatically renewed upon expiration.

    " + }, + "TransferLock":{ + "shape":"Boolean", + "documentation":"

    Indicates whether a domain is locked from unauthorized transfer to another party.

    " + }, + "Expiry":{ + "shape":"Timestamp", + "documentation":"

    Expiration date of the domain in Coordinated Universal Time (UTC).

    " + } + }, + "documentation":"

    Summary information about one domain.

    " + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "DomainTransferability":{ + "type":"structure", + "members":{ + "Transferable":{"shape":"Transferable"} + }, + "documentation":"

    A complex type that contains information about whether the specified domain can be transferred to Amazon Route 53.

    " + }, + "DuplicateRequest":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The request is already in progress for the domain.

    " + } + }, + "documentation":"

    The request is already in progress for the domain.

    ", + "exception":true + }, + "DurationInYears":{ + "type":"integer", + "max":10, + "min":1 + }, + "Email":{ + "type":"string", + "max":254 + }, + "EnableDomainAutoRenewRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to enable automatic renewal for.

    " + } + } + }, + "EnableDomainAutoRenewResponse":{ + "type":"structure", + "members":{ + } + }, + "EnableDomainTransferLockRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to set the transfer lock for.

    " + } + }, + "documentation":"

    A request to set the transfer lock for the specified domain.

    " + }, + "EnableDomainTransferLockResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The EnableDomainTransferLock response includes the following elements.

    " + }, + "ErrorMessage":{"type":"string"}, + "ExtraParam":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ExtraParamName", + "documentation":"

    Name of the additional parameter required by the top-level domain. Here are the top-level domains that require additional parameters and which parameters they require:

    • .com.au and .net.au: AU_ID_NUMBER and AU_ID_TYPE

    • .ca: BRAND_NUMBER, CA_LEGAL_TYPE, and CA_BUSINESS_ENTITY_TYPE

    • .es: ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, and ES_LEGAL_FORM

    • .fi: BIRTH_DATE_IN_YYYY_MM_DD, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, and FI_ORGANIZATION_TYPE

    • .fr: BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, and BIRTH_CITY

    • .it: BIRTH_COUNTRY, IT_PIN, and IT_REGISTRANT_ENTITY_TYPE

    • .ru: BIRTH_DATE_IN_YYYY_MM_DD and RU_PASSPORT_DATA

    • .se: BIRTH_COUNTRY and SE_ID_NUMBER

    • .sg: SG_ID_NUMBER

    • .co.uk, .me.uk, and .org.uk: UK_CONTACT_TYPE and UK_COMPANY_NUMBER

    In addition, many TLDs require VAT_NUMBER.

    " + }, + "Value":{ + "shape":"ExtraParamValue", + "documentation":"

    Values corresponding to the additional parameter names required by some top-level domains.

    " + } + }, + "documentation":"

    ExtraParam includes the following elements.

    " + }, + "ExtraParamList":{ + "type":"list", + "member":{"shape":"ExtraParam"} + }, + "ExtraParamName":{ + "type":"string", + "enum":[ + "DUNS_NUMBER", + "BRAND_NUMBER", + "BIRTH_DEPARTMENT", + "BIRTH_DATE_IN_YYYY_MM_DD", + "BIRTH_COUNTRY", + "BIRTH_CITY", + "DOCUMENT_NUMBER", + "AU_ID_NUMBER", + "AU_ID_TYPE", + "CA_LEGAL_TYPE", + "CA_BUSINESS_ENTITY_TYPE", + "ES_IDENTIFICATION", + "ES_IDENTIFICATION_TYPE", + "ES_LEGAL_FORM", + "FI_BUSINESS_NUMBER", + "FI_ID_NUMBER", + "FI_NATIONALITY", + "FI_ORGANIZATION_TYPE", + "IT_PIN", + "IT_REGISTRANT_ENTITY_TYPE", + "RU_PASSPORT_DATA", + "SE_ID_NUMBER", + "SG_ID_NUMBER", + "VAT_NUMBER", + "UK_CONTACT_TYPE", + "UK_COMPANY_NUMBER" + ] + }, + "ExtraParamValue":{ + "type":"string", + "max":2048 + }, + "FIAuthKey":{"type":"string"}, + "GetContactReachabilityStatusRequest":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain for which you want to know whether the registrant contact has confirmed that the email address is valid.

    " + } + } + }, + "GetContactReachabilityStatusResponse":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

    The domain name for which you requested the reachability status.

    " + }, + "status":{ + "shape":"ReachabilityStatus", + "documentation":"

    Whether the registrant contact has responded. Values include the following:

    PENDING

    We sent the confirmation email and haven't received a response yet.

    DONE

    We sent the email and got confirmation from the registrant contact.

    EXPIRED

    The time limit expired before the registrant contact responded.

    " + } + } + }, + "GetDomainDetailRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to get detailed information about.

    " + } + }, + "documentation":"

    The GetDomainDetail request includes the following element.

    " + }, + "GetDomainDetailResponse":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of a domain.

    " + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

    The name of the domain.

    " + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the domain registration is set to renew automatically.

    " + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides details about the domain administrative contact.

    " + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides details about the domain registrant.

    " + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides details about the domain technical contact.

    " + }, + "AdminPrivacy":{ + "shape":"Boolean", + "documentation":"

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the admin contact.

    " + }, + "RegistrantPrivacy":{ + "shape":"Boolean", + "documentation":"

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    " + }, + "TechPrivacy":{ + "shape":"Boolean", + "documentation":"

    Specifies whether contact information is concealed from WHOIS queries. If the value is true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If the value is false, WHOIS queries return the information that you entered for the technical contact.

    " + }, + "RegistrarName":{ + "shape":"RegistrarName", + "documentation":"

    Name of the registrar of the domain as identified in the registry. Domains with a .com, .net, or .org TLD are registered by Amazon Registrar. All other domains are registered by our registrar associate, Gandi. The value for domains that are registered by Gandi is \"GANDI SAS\".

    " + }, + "WhoIsServer":{ + "shape":"RegistrarWhoIsServer", + "documentation":"

    The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

    " + }, + "RegistrarUrl":{ + "shape":"RegistrarUrl", + "documentation":"

    Web address of the registrar.

    " + }, + "AbuseContactEmail":{ + "shape":"Email", + "documentation":"

    Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

    " + }, + "AbuseContactPhone":{ + "shape":"ContactNumber", + "documentation":"

    Phone number for reporting abuse.

    " + }, + "RegistryDomainId":{ + "shape":"RegistryDomainId", + "documentation":"

    Reserved for future use.

    " + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

    The date when the domain was created as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

    " + }, + "UpdatedDate":{ + "shape":"Timestamp", + "documentation":"

    The last updated date of the domain as found in the response to a WHOIS query. The date and time is in Coordinated Universal time (UTC).

    " + }, + "ExpirationDate":{ + "shape":"Timestamp", + "documentation":"

    The date when the registration for the domain is set to expire. The date and time is in Coordinated Universal time (UTC).

    " + }, + "Reseller":{ + "shape":"Reseller", + "documentation":"

    Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have \"Amazon\" as the reseller.

    " + }, + "DnsSec":{ + "shape":"DNSSec", + "documentation":"

    Reserved for future use.

    " + }, + "StatusList":{ + "shape":"DomainStatusList", + "documentation":"

    An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

    ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

    For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

    " + } + }, + "documentation":"

    The GetDomainDetail response includes the following elements.

    " + }, + "GetDomainSuggestionsRequest":{ + "type":"structure", + "required":[ + "DomainName", + "SuggestionCount", + "OnlyAvailable" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    A domain name that you want to use as the basis for a list of possible domain names. The domain name must contain a top-level domain (TLD), such as .com, that Amazon Route 53 supports. For a list of TLDs, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    " + }, + "SuggestionCount":{ + "shape":"Integer", + "documentation":"

    The number of suggested domain names that you want Amazon Route 53 to return.

    " + }, + "OnlyAvailable":{ + "shape":"Boolean", + "documentation":"

    If OnlyAvailable is true, Amazon Route 53 returns only domain names that are available. If OnlyAvailable is false, Amazon Route 53 returns domain names without checking whether they're available to be registered. To determine whether the domain is available, you can call checkDomainAvailability for each suggestion.

    " + } + } + }, + "GetDomainSuggestionsResponse":{ + "type":"structure", + "members":{ + "SuggestionsList":{ + "shape":"DomainSuggestionsList", + "documentation":"

    A list of possible domain names. If you specified true for OnlyAvailable in the request, the list contains only domains that are available for registration.

    " + } + } + }, + "GetOperationDetailRequest":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

    " + } + }, + "documentation":"

    The GetOperationDetail request includes the following element.

    " + }, + "GetOperationDetailResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    The identifier for the operation.

    " + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

    The current status of the requested operation in the system.

    " + }, + "Message":{ + "shape":"ErrorMessage", + "documentation":"

    Detailed information on the status including possible errors.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of a domain.

    " + }, + "Type":{ + "shape":"OperationType", + "documentation":"

    The type of operation that was requested.

    " + }, + "SubmittedDate":{ + "shape":"Timestamp", + "documentation":"

    The date when the request was submitted.

    " + } + }, + "documentation":"

    The GetOperationDetail response includes the following elements.

    " + }, + "GlueIp":{ + "type":"string", + "max":45 + }, + "GlueIpList":{ + "type":"list", + "member":{"shape":"GlueIp"} + }, + "HostName":{ + "type":"string", + "max":255, + "pattern":"[a-zA-Z0-9_\\-.]*" + }, + "Integer":{"type":"integer"}, + "InvalidInput":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

    " + } + }, + "documentation":"

    The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an operation that is already completed. For a domain name, it might not be a valid domain name or belong to the requester account.

    ", + "exception":true + }, + "InvoiceId":{"type":"string"}, + "LangCode":{ + "type":"string", + "max":3 + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Constraints: The marker must match the value specified in the previous request.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    Number of domains to be returned.

    Default: 20

    " + } + }, + "documentation":"

    The ListDomains request includes the following elements.

    " + }, + "ListDomainsResponse":{ + "type":"structure", + "required":["Domains"], + "members":{ + "Domains":{ + "shape":"DomainSummaryList", + "documentation":"

    A summary of domains.

    " + }, + "NextPageMarker":{ + "shape":"PageMarker", + "documentation":"

    If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

    " + } + }, + "documentation":"

    The ListDomains response includes the following elements.

    " + }, + "ListOperationsRequest":{ + "type":"structure", + "members":{ + "SubmittedSince":{ + "shape":"Timestamp", + "documentation":"

    An optional parameter that lets you get information about all the operations that you submitted after a specified date and time. Specify the date and time in Coordinated Universal time (UTC).

    " + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    Number of domains to be returned.

    Default: 20

    " + } + }, + "documentation":"

    The ListOperations request includes the following elements.

    " + }, + "ListOperationsResponse":{ + "type":"structure", + "required":["Operations"], + "members":{ + "Operations":{ + "shape":"OperationSummaryList", + "documentation":"

    Lists summaries of the operations.

    " + }, + "NextPageMarker":{ + "shape":"PageMarker", + "documentation":"

    If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

    " + } + }, + "documentation":"

    The ListOperations response includes the following elements.

    " + }, + "ListTagsForDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain for which you want to get a list of tags.

    " + } + }, + "documentation":"

    The ListTagsForDomainRequest includes the following elements.

    " + }, + "ListTagsForDomainResponse":{ + "type":"structure", + "required":["TagList"], + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

    A list of the tags that are associated with the specified domain.

    " + } + }, + "documentation":"

    The ListTagsForDomain response includes the following elements.

    " + }, + "Nameserver":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"HostName", + "documentation":"

    The fully qualified host name of the name server.

    Constraint: Maximum 255 characters

    " + }, + "GlueIps":{ + "shape":"GlueIpList", + "documentation":"

    Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

    Constraints: The list can contain only one IPv4 and one IPv6 address.

    " + } + }, + "documentation":"

    Nameserver includes the following elements.

    " + }, + "NameserverList":{ + "type":"list", + "member":{"shape":"Nameserver"} + }, + "OperationId":{ + "type":"string", + "max":255 + }, + "OperationLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The number of operations or jobs running exceeded the allowed threshold for the account.

    " + } + }, + "documentation":"

    The number of operations or jobs running exceeded the allowed threshold for the account.

    ", + "exception":true + }, + "OperationStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "ERROR", + "SUCCESSFUL", + "FAILED" + ] + }, + "OperationSummary":{ + "type":"structure", + "required":[ + "OperationId", + "Status", + "Type", + "SubmittedDate" + ], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier returned to track the requested action.

    " + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

    The current status of the requested operation in the system.

    " + }, + "Type":{ + "shape":"OperationType", + "documentation":"

    Type of the action requested.

    " + }, + "SubmittedDate":{ + "shape":"Timestamp", + "documentation":"

    The date when the request was submitted.

    " + } + }, + "documentation":"

    OperationSummary includes the following elements.

    " + }, + "OperationSummaryList":{ + "type":"list", + "member":{"shape":"OperationSummary"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "REGISTER_DOMAIN", + "DELETE_DOMAIN", + "TRANSFER_IN_DOMAIN", + "UPDATE_DOMAIN_CONTACT", + "UPDATE_NAMESERVER", + "CHANGE_PRIVACY_PROTECTION", + "DOMAIN_LOCK", + "ENABLE_AUTORENEW", + "DISABLE_AUTORENEW", + "ADD_DNSSEC", + "REMOVE_DNSSEC", + "EXPIRE_DOMAIN", + "TRANSFER_OUT_DOMAIN", + "CHANGE_DOMAIN_OWNER", + "RENEW_DOMAIN", + "PUSH_DOMAIN" + ] + }, + "PageMarker":{ + "type":"string", + "max":4096 + }, + "PageMaxItems":{ + "type":"integer", + "max":100 + }, + "Price":{"type":"double"}, + "ReachabilityStatus":{ + "type":"string", + "enum":[ + "PENDING", + "DONE", + "EXPIRED" + ] + }, + "RegisterDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain name that you want to register.

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    " + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

    Reserved for future use.

    " + }, + "DurationInYears":{ + "shape":"DurationInYears", + "documentation":"

    The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    Default: 1

    " + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

    Default: true

    " + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "PrivacyProtectAdminContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact.

    Default: true

    " + }, + "PrivacyProtectRegistrantContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (the domain owner).

    Default: true

    " + }, + "PrivacyProtectTechContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact.

    Default: true

    " + } + }, + "documentation":"

    The RegisterDomain request includes the following elements.

    " + }, + "RegisterDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The RegisterDomain response includes the following element.

    " + }, + "RegistrarName":{"type":"string"}, + "RegistrarUrl":{"type":"string"}, + "RegistrarWhoIsServer":{"type":"string"}, + "RegistryDomainId":{"type":"string"}, + "RenewDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "CurrentExpiryYear" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to renew.

    " + }, + "DurationInYears":{ + "shape":"DurationInYears", + "documentation":"

    The number of years that you want to renew the domain for. The maximum number of years depends on the top-level domain. For the range of valid values for your domain, see Domains that You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide.

    Default: 1

    " + }, + "CurrentExpiryYear":{ + "shape":"CurrentExpiryYear", + "documentation":"

    The year when the registration for the domain is set to expire. This value must match the current expiration date for the domain.

    " + } + }, + "documentation":"

    A RenewDomain request includes the number of years that you want to renew for and the current expiration year.

    " + }, + "RenewDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    The identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + } + }, + "Reseller":{"type":"string"}, + "ResendContactReachabilityEmailRequest":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain for which you want Amazon Route 53 to resend a confirmation email to the registrant contact.

    " + } + } + }, + "ResendContactReachabilityEmailResponse":{ + "type":"structure", + "members":{ + "domainName":{ + "shape":"DomainName", + "documentation":"

    The domain name for which you requested a confirmation email.

    " + }, + "emailAddress":{ + "shape":"Email", + "documentation":"

    The email address for the registrant contact at the time that we sent the verification email.

    " + }, + "isAlreadyVerified":{ + "shape":"Boolean", + "documentation":"

    True if the email address for the registrant contact has already been verified, and false otherwise. If the email address has already been verified, we don't send another confirmation email.

    " + } + } + }, + "RetrieveDomainAuthCodeRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to get an authorization code for.

    " + } + }, + "documentation":"

    A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide this value to the new registrar.

    " + }, + "RetrieveDomainAuthCodeResponse":{ + "type":"structure", + "required":["AuthCode"], + "members":{ + "AuthCode":{ + "shape":"DomainAuthCode", + "documentation":"

    The authorization code for the domain.

    " + } + }, + "documentation":"

    The RetrieveDomainAuthCode response includes the following element.

    " + }, + "State":{ + "type":"string", + "max":255 + }, + "String":{"type":"string"}, + "TLDRulesViolation":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The top-level domain does not support this operation.

    " + } + }, + "documentation":"

    The top-level domain does not support this operation.

    ", + "exception":true + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The key (name) of a tag.

    Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

    Constraints: Each key can be 1-128 characters long.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value of a tag.

    Valid values: A-Z, a-z, 0-9, space, \".:/=+\\-@\"

    Constraints: Each value can be 0-256 characters long.

    " + } + }, + "documentation":"

    Each tag includes the following elements.

    " + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{"type":"string"}, + "Timestamp":{"type":"timestamp"}, + "TransferDomainRequest":{ + "type":"structure", + "required":[ + "DomainName", + "DurationInYears", + "AdminContact", + "RegistrantContact", + "TechContact" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to transfer to Amazon Route 53.

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    " + }, + "IdnLangCode":{ + "shape":"LangCode", + "documentation":"

    Reserved for future use.

    " + }, + "DurationInYears":{ + "shape":"DurationInYears", + "documentation":"

    The number of years that you want to register the domain for. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

    Default: 1

    " + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

    Contains details for the host and glue IP addresses.

    " + }, + "AuthCode":{ + "shape":"DomainAuthCode", + "documentation":"

    The authorization code for the domain. You get this value from the current registrar.

    " + }, + "AutoRenew":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

    Default: true

    " + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "PrivacyProtectAdminContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact.

    Default: true

    " + }, + "PrivacyProtectRegistrantContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    Default: true

    " + }, + "PrivacyProtectTechContact":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact.

    Default: true

    " + } + }, + "documentation":"

    The TransferDomain request includes the following elements.

    " + }, + "TransferDomainResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The TranserDomain response includes the following element.

    " + }, + "Transferable":{ + "type":"string", + "documentation":"

    Whether the domain name can be transferred to Amazon Route 53.

    You can transfer only domains that have a value of TRANSFERABLE for Transferable.

    Valid values:

    TRANSFERABLE

    The domain name can be transferred to Amazon Route 53.

    UNTRANSFERRABLE

    The domain name can't be transferred to Amazon Route 53.

    DONT_KNOW

    Reserved for future use.

    ", + "enum":[ + "TRANSFERABLE", + "UNTRANSFERABLE", + "DONT_KNOW" + ] + }, + "UnsupportedTLD":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    Amazon Route 53 does not support this top-level domain (TLD).

    " + } + }, + "documentation":"

    Amazon Route 53 does not support this top-level domain (TLD).

    ", + "exception":true + }, + "UpdateDomainContactPrivacyRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to update the privacy setting for.

    " + }, + "AdminPrivacy":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the admin contact.

    " + }, + "RegistrantPrivacy":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the registrant contact (domain owner).

    " + }, + "TechPrivacy":{ + "shape":"Boolean", + "documentation":"

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you specify false, WHOIS queries return the information that you entered for the technical contact.

    " + } + }, + "documentation":"

    The UpdateDomainContactPrivacy request includes the following elements.

    " + }, + "UpdateDomainContactPrivacyResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The UpdateDomainContactPrivacy response includes the following element.

    " + }, + "UpdateDomainContactRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to update contact information for.

    " + }, + "AdminContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "RegistrantContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + }, + "TechContact":{ + "shape":"ContactDetail", + "documentation":"

    Provides detailed contact information.

    " + } + }, + "documentation":"

    The UpdateDomainContact request includes the following elements.

    " + }, + "UpdateDomainContactResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The UpdateDomainContact response includes the following element.

    " + }, + "UpdateDomainNameserversRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Nameservers" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want to change name servers for.

    " + }, + "FIAuthKey":{ + "shape":"FIAuthKey", + "documentation":"

    The authorization key for .fi domains

    ", + "deprecated":true + }, + "Nameservers":{ + "shape":"NameserverList", + "documentation":"

    A list of new name servers for the domain.

    " + } + }, + "documentation":"

    Replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

    If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

    " + }, + "UpdateDomainNameserversResponse":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

    " + } + }, + "documentation":"

    The UpdateDomainNameservers response includes the following element.

    " + }, + "UpdateTagsForDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain for which you want to add or update tags.

    " + }, + "TagsToUpdate":{ + "shape":"TagList", + "documentation":"

    A list of the tag keys and values that you want to add or update. If you specify a key that already exists, the corresponding value will be replaced.

    " + } + }, + "documentation":"

    The UpdateTagsForDomainRequest includes the following elements.

    " + }, + "UpdateTagsForDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "ViewBillingRequest":{ + "type":"structure", + "members":{ + "Start":{ + "shape":"Timestamp", + "documentation":"

    The beginning date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).

    " + }, + "End":{ + "shape":"Timestamp", + "documentation":"

    The end date and time for the time period for which you want a list of billing records. Specify the date and time in Coordinated Universal time (UTC).

    " + }, + "Marker":{ + "shape":"PageMarker", + "documentation":"

    For an initial request for a list of billing records, omit this element. If the number of billing records that are associated with the current AWS account during the specified period is greater than the value that you specified for MaxItems, you can use Marker to return additional billing records. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.

    " + }, + "MaxItems":{ + "shape":"PageMaxItems", + "documentation":"

    The number of billing records to be returned.

    Default: 20

    " + } + }, + "documentation":"

    The ViewBilling request includes the following elements.

    " + }, + "ViewBillingResponse":{ + "type":"structure", + "members":{ + "NextPageMarker":{ + "shape":"PageMarker", + "documentation":"

    If there are more billing records than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

    " + }, + "BillingRecords":{ + "shape":"BillingRecords", + "documentation":"

    A summary of billing records.

    " + } + }, + "documentation":"

    The ViewBilling response includes the following elements.

    " + }, + "ZipCode":{ + "type":"string", + "max":255 + } + }, + "documentation":"

    Amazon Route 53 API actions let you register domain names and perform related operations.

    " +} diff --git a/aws/dist/botocore/data/route53resolver/2018-04-01/paginators-1.json b/aws/dist/botocore/data/route53resolver/2018-04-01/paginators-1.json new file mode 100644 index 00000000..5a36213a --- /dev/null +++ b/aws/dist/botocore/data/route53resolver/2018-04-01/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListTagsForResource": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/route53resolver/2018-04-01/service-2.json b/aws/dist/botocore/data/route53resolver/2018-04-01/service-2.json new file mode 100644 index 00000000..970ca7cd --- /dev/null +++ b/aws/dist/botocore/data/route53resolver/2018-04-01/service-2.json @@ -0,0 +1,1615 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-04-01", + "endpointPrefix":"route53resolver", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Route53Resolver", + "serviceFullName":"Amazon Route 53 Resolver", + "serviceId":"Route53Resolver", + "signatureVersion":"v4", + "targetPrefix":"Route53Resolver", + "uid":"route53resolver-2018-04-01" + }, + "operations":{ + "AssociateResolverEndpointIpAddress":{ + "name":"AssociateResolverEndpointIpAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateResolverEndpointIpAddressRequest"}, + "output":{"shape":"AssociateResolverEndpointIpAddressResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"LimitExceededException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Adds IP addresses to an inbound or an outbound resolver endpoint. If you want to adding more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.

    To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.

    " + }, + "AssociateResolverRule":{ + "name":"AssociateResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateResolverRuleRequest"}, + "output":{"shape":"AssociateResolverRuleResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceExistsException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Associates a resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see CreateResolverRule.

    " + }, + "CreateResolverEndpoint":{ + "name":"CreateResolverEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResolverEndpointRequest"}, + "output":{"shape":"CreateResolverEndpointResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Creates a resolver endpoint. There are two types of resolver endpoints, inbound and outbound:

    • An inbound resolver endpoint forwards DNS queries to the DNS service for a VPC from your network or another VPC.

    • An outbound resolver endpoint forwards DNS queries from the DNS service for a VPC to your network or another VPC.

    " + }, + "CreateResolverRule":{ + "name":"CreateResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResolverRuleRequest"}, + "output":{"shape":"CreateResolverRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    For DNS queries that originate in your VPCs, specifies which resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.

    " + }, + "DeleteResolverEndpoint":{ + "name":"DeleteResolverEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResolverEndpointRequest"}, + "output":{"shape":"DeleteResolverEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Deletes a resolver endpoint. The effect of deleting a resolver endpoint depends on whether it's an inbound or an outbound resolver endpoint:

    • Inbound: DNS queries from your network or another VPC are no longer routed to the DNS service for the specified VPC.

    • Outbound: DNS queries from a VPC are no longer routed to your network or to another VPC.

    " + }, + "DeleteResolverRule":{ + "name":"DeleteResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResolverRuleRequest"}, + "output":{"shape":"DeleteResolverRuleResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Deletes a resolver rule. Before you can delete a resolver rule, you must disassociate it from all the VPCs that you associated the resolver rule with. For more infomation, see DisassociateResolverRule.

    " + }, + "DisassociateResolverEndpointIpAddress":{ + "name":"DisassociateResolverEndpointIpAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateResolverEndpointIpAddressRequest"}, + "output":{"shape":"DisassociateResolverEndpointIpAddressResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Removes IP addresses from an inbound or an outbound resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.

    To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.

    " + }, + "DisassociateResolverRule":{ + "name":"DisassociateResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateResolverRuleRequest"}, + "output":{"shape":"DisassociateResolverRuleResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Removes the association between a specified resolver rule and a specified VPC.

    If you disassociate a resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the resolver rule.

    " + }, + "GetResolverEndpoint":{ + "name":"GetResolverEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverEndpointRequest"}, + "output":{"shape":"GetResolverEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets information about a specified resolver endpoint, such as whether it's an inbound or an outbound resolver endpoint, and the current status of the endpoint.

    " + }, + "GetResolverRule":{ + "name":"GetResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverRuleRequest"}, + "output":{"shape":"GetResolverRuleResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets information about a specified resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound resolver endpoint that the rule is associated with.

    " + }, + "GetResolverRuleAssociation":{ + "name":"GetResolverRuleAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverRuleAssociationRequest"}, + "output":{"shape":"GetResolverRuleAssociationResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets information about an association between a specified resolver rule and a VPC. You associate a resolver rule and a VPC using AssociateResolverRule.

    " + }, + "GetResolverRulePolicy":{ + "name":"GetResolverRulePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResolverRulePolicyRequest"}, + "output":{"shape":"GetResolverRulePolicyResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Gets information about a resolver rule policy. A resolver rule policy specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

    " + }, + "ListResolverEndpointIpAddresses":{ + "name":"ListResolverEndpointIpAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverEndpointIpAddressesRequest"}, + "output":{"shape":"ListResolverEndpointIpAddressesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the IP addresses for a specified resolver endpoint.

    " + }, + "ListResolverEndpoints":{ + "name":"ListResolverEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverEndpointsRequest"}, + "output":{"shape":"ListResolverEndpointsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists all the resolver endpoints that were created using the current AWS account.

    " + }, + "ListResolverRuleAssociations":{ + "name":"ListResolverRuleAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverRuleAssociationsRequest"}, + "output":{"shape":"ListResolverRuleAssociationsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists the associations that were created between resolver rules and VPCs using the current AWS account.

    " + }, + "ListResolverRules":{ + "name":"ListResolverRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResolverRulesRequest"}, + "output":{"shape":"ListResolverRulesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists the resolver rules that were created using the current AWS account.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Lists the tags that you associated with the specified resource.

    " + }, + "PutResolverRulePolicy":{ + "name":"PutResolverRulePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResolverRulePolicyRequest"}, + "output":{"shape":"PutResolverRulePolicyResponse"}, + "errors":[ + {"shape":"InvalidPolicyDocument"}, + {"shape":"InvalidParameterException"}, + {"shape":"UnknownResourceException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Specifies the Resolver operations and resources that you want to allow another AWS account to be able to use.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidTagException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Adds one or more tags to a specified resource.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Removes one or more tags from a specified resource.

    " + }, + "UpdateResolverEndpoint":{ + "name":"UpdateResolverEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResolverEndpointRequest"}, + "output":{"shape":"UpdateResolverEndpointResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Updates the name of an inbound or an outbound resolver endpoint.

    " + }, + "UpdateResolverRule":{ + "name":"UpdateResolverRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResolverRuleRequest"}, + "output":{"shape":"UpdateResolverRuleResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceErrorException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Updates settings for a specified resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.

    " + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "max":32, + "min":12 + }, + "Arn":{ + "type":"string", + "max":255, + "min":1 + }, + "AssociateResolverEndpointIpAddressRequest":{ + "type":"structure", + "required":[ + "ResolverEndpointId", + "IpAddress" + ], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to associate IP addresses with.

    " + }, + "IpAddress":{ + "shape":"IpAddressUpdate", + "documentation":"

    Either the IPv4 address that you want to add to a resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.

    " + } + } + }, + "AssociateResolverEndpointIpAddressResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    The response to an AssociateResolverEndpointIpAddress request.

    " + } + } + }, + "AssociateResolverRuleRequest":{ + "type":"structure", + "required":[ + "ResolverRuleId", + "VPCId" + ], + "members":{ + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you want to associate with the VPC. To list the existing resolver rules, use ListResolverRules.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    A name for the association that you're creating between a resolver rule and a VPC.

    " + }, + "VPCId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the VPC that you want to associate the resolver rule with.

    " + } + } + }, + "AssociateResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRuleAssociation":{ + "shape":"ResolverRuleAssociation", + "documentation":"

    Information about the AssociateResolverRule request, including the status of the request.

    " + } + } + }, + "Boolean":{"type":"boolean"}, + "CreateResolverEndpointRequest":{ + "type":"structure", + "required":[ + "CreatorRequestId", + "SecurityGroupIds", + "Direction", + "IpAddresses" + ], + "members":{ + "CreatorRequestId":{ + "shape":"CreatorRequestId", + "documentation":"

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.

    " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

    The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound resolver endpoints) or outbound rules (for outbound resolver endpoints).

    ", + "box":true + }, + "Direction":{ + "shape":"ResolverEndpointDirection", + "documentation":"

    Specify the applicable value:

    • INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC

    • OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC

    " + }, + "IpAddresses":{ + "shape":"IpAddressesRequest", + "documentation":"

    The subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound resolver endpoints).

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of the tag keys and values that you want to associate with the endpoint.

    ", + "box":true + } + } + }, + "CreateResolverEndpointResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    Information about the CreateResolverEndpoint request, including the status of the request.

    " + } + } + }, + "CreateResolverRuleRequest":{ + "type":"structure", + "required":[ + "CreatorRequestId", + "RuleType", + "DomainName" + ], + "members":{ + "CreatorRequestId":{ + "shape":"CreatorRequestId", + "documentation":"

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.

    " + }, + "RuleType":{ + "shape":"RuleTypeOption", + "documentation":"

    Specify FORWARD. Other resolver rule types aren't supported.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    DNS queries for this domain name are forwarded to the IP addresses that you specify in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), outbound DNS queries are routed using the resolver rule that contains the most specific domain name (www.example.com).

    " + }, + "TargetIps":{ + "shape":"TargetList", + "documentation":"

    The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a comma.

    ", + "box":true + }, + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

    ", + "box":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of the tag keys and values that you want to associate with the endpoint.

    ", + "box":true + } + } + }, + "CreateResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRule":{ + "shape":"ResolverRule", + "documentation":"

    Information about the CreateResolverRule request, including the status of the request.

    " + } + } + }, + "CreatorRequestId":{ + "type":"string", + "max":255, + "min":1 + }, + "DeleteResolverEndpointRequest":{ + "type":"structure", + "required":["ResolverEndpointId"], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to delete.

    " + } + } + }, + "DeleteResolverEndpointResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    Information about the DeleteResolverEndpoint request, including the status of the request.

    " + } + } + }, + "DeleteResolverRuleRequest":{ + "type":"structure", + "required":["ResolverRuleId"], + "members":{ + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you want to delete.

    " + } + } + }, + "DeleteResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRule":{ + "shape":"ResolverRule", + "documentation":"

    Information about the DeleteResolverRule request, including the status of the request.

    " + } + } + }, + "DisassociateResolverEndpointIpAddressRequest":{ + "type":"structure", + "required":[ + "ResolverEndpointId", + "IpAddress" + ], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to disassociate an IP address from.

    " + }, + "IpAddress":{ + "shape":"IpAddressUpdate", + "documentation":"

    The IPv4 address that you want to remove from a resolver endpoint.

    " + } + } + }, + "DisassociateResolverEndpointIpAddressResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    The response to an DisassociateResolverEndpointIpAddress request.

    " + } + } + }, + "DisassociateResolverRuleRequest":{ + "type":"structure", + "required":[ + "VPCId", + "ResolverRuleId" + ], + "members":{ + "VPCId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the VPC that you want to disassociate the resolver rule from.

    " + }, + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you want to disassociate from the specified VPC.

    " + } + } + }, + "DisassociateResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRuleAssociation":{ + "shape":"ResolverRuleAssociation", + "documentation":"

    Information about the DisassociateResolverRule request, including the status of the request.

    " + } + } + }, + "DomainName":{ + "type":"string", + "max":256, + "min":1 + }, + "ExceptionMessage":{"type":"string"}, + "Filter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FilterName", + "documentation":"

    When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the name of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify Direction for the value of Name.

    " + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

    When you're using a List operation and you want the operation to return a subset of objects, such as resolver endpoints or resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound resolver endpoints, specify INBOUND for the value of Values.

    " + } + }, + "documentation":"

    For List operations, an optional specification to return a subset of objects, such as resolver endpoints or resolver rules.

    " + }, + "FilterName":{ + "type":"string", + "max":64, + "min":1 + }, + "FilterValue":{ + "type":"string", + "max":64, + "min":1 + }, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"} + }, + "Filters":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "GetResolverEndpointRequest":{ + "type":"structure", + "required":["ResolverEndpointId"], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to get information about.

    " + } + } + }, + "GetResolverEndpointResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    Information about the resolver endpoint that you specified in a GetResolverEndpoint request.

    " + } + } + }, + "GetResolverRuleAssociationRequest":{ + "type":"structure", + "required":["ResolverRuleAssociationId"], + "members":{ + "ResolverRuleAssociationId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule association that you want to get information about.

    " + } + } + }, + "GetResolverRuleAssociationResponse":{ + "type":"structure", + "members":{ + "ResolverRuleAssociation":{ + "shape":"ResolverRuleAssociation", + "documentation":"

    Information about the resolver rule association that you specified in a GetResolverRuleAssociation request.

    " + } + } + }, + "GetResolverRulePolicyRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The ID of the resolver rule policy that you want to get information about.

    " + } + } + }, + "GetResolverRulePolicyResponse":{ + "type":"structure", + "members":{ + "ResolverRulePolicy":{ + "shape":"ResolverRulePolicy", + "documentation":"

    Information about the resolver rule policy that you specified in a GetResolverRulePolicy request.

    " + } + } + }, + "GetResolverRuleRequest":{ + "type":"structure", + "required":["ResolverRuleId"], + "members":{ + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you want to get information about.

    " + } + } + }, + "GetResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRule":{ + "shape":"ResolverRule", + "documentation":"

    Information about the resolver rule that you specified in a GetResolverRule request.

    " + } + } + }, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    We encountered an unknown error. Try again in a few minutes.

    ", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The value that you specified for NextToken in a List request isn't valid.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"ExceptionMessage"}, + "FieldName":{ + "shape":"String", + "documentation":"

    For an InvalidParameterException error, the name of the parameter that's invalid.

    " + } + }, + "documentation":"

    One or more parameters in this request are not valid.

    ", + "exception":true + }, + "InvalidPolicyDocument":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified resolver rule policy is invalid.

    ", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The request is invalid.

    ", + "exception":true + }, + "InvalidTagException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified tag is invalid.

    ", + "exception":true + }, + "Ip":{ + "type":"string", + "max":36, + "min":7 + }, + "IpAddressCount":{"type":"integer"}, + "IpAddressRequest":{ + "type":"structure", + "required":["SubnetId"], + "members":{ + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The subnet that contains the IP address.

    " + }, + "Ip":{ + "shape":"Ip", + "documentation":"

    The IP address that you want to use for DNS queries.

    ", + "box":true + } + }, + "documentation":"

    In an CreateResolverEndpoint request, a subnet and IP address that you want to use for DNS queries.

    " + }, + "IpAddressResponse":{ + "type":"structure", + "members":{ + "IpId":{ + "shape":"ResourceId", + "documentation":"

    The ID of one IP address.

    " + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The ID of one subnet.

    " + }, + "Ip":{ + "shape":"Ip", + "documentation":"

    One IP address that the resolver endpoint uses for DNS queries.

    " + }, + "Status":{ + "shape":"IpAddressStatus", + "documentation":"

    A status code that gives the current status of the request.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    A message that provides additional information about the status of the request.

    " + }, + "CreationTime":{ + "shape":"Rfc3339TimeString", + "documentation":"

    The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

    " + }, + "ModificationTime":{ + "shape":"Rfc3339TimeString", + "documentation":"

    The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " + } + }, + "documentation":"

    In the response to a GetResolverEndpoint request, information about the IP addresses that the resolver endpoint uses for DNS queries.

    " + }, + "IpAddressStatus":{ + "type":"string", + "enum":[ + "CREATING", + "FAILED_CREATION", + "ATTACHING", + "ATTACHED", + "REMAP_DETACHING", + "REMAP_ATTACHING", + "DETACHING", + "FAILED_RESOURCE_GONE", + "DELETING", + "DELETE_FAILED_FAS_EXPIRED" + ] + }, + "IpAddressUpdate":{ + "type":"structure", + "members":{ + "IpId":{ + "shape":"ResourceId", + "documentation":"

    Only when removing an IP address from a resolver endpoint: The ID of the IP address that you want to remove. To get this ID, use GetResolverEndpoint.

    ", + "box":true + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The ID of the subnet that includes the IP address that you want to update. To get this ID, use GetResolverEndpoint.

    ", + "box":true + }, + "Ip":{ + "shape":"Ip", + "documentation":"

    The new IP address.

    ", + "box":true + } + }, + "documentation":"

    In an UpdateResolverEndpoint request, information about an IP address to update.

    " + }, + "IpAddressesRequest":{ + "type":"list", + "member":{"shape":"IpAddressRequest"}, + "max":10, + "min":1 + }, + "IpAddressesResponse":{ + "type":"list", + "member":{"shape":"IpAddressResponse"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    For a LimitExceededException error, the type of resource that exceeded the current limit.

    " + } + }, + "documentation":"

    The request caused one or more limits to be exceeded.

    ", + "exception":true + }, + "ListResolverEndpointIpAddressesRequest":{ + "type":"structure", + "required":["ResolverEndpointId"], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to get IP addresses for.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListResolverEndpointIpAddresses request, omit this value.

    If the specified resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

    ", + "box":true + } + } + }, + "ListResolverEndpointIpAddressesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The value that you specified for MaxResults in the request.

    " + }, + "IpAddresses":{ + "shape":"IpAddressesResponse", + "documentation":"

    The IP addresses that DNS queries pass through on their way to your network (outbound endpoint) or on the way to Resolver (inbound endpoint).

    " + } + } + }, + "ListResolverEndpointsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver endpoints.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListResolverEndpoints request, omit this value.

    If you have more than MaxResults resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of resolver endpoints. In the next request, specify the value of NextToken from the previous response.

    ", + "box":true + }, + "Filters":{ + "shape":"Filters", + "documentation":"

    An optional specification to return a subset of resolver endpoints, such as all inbound resolver endpoints.

    If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

    ", + "box":true + } + } + }, + "ListResolverEndpointsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The value that you specified for MaxResults in the request.

    " + }, + "ResolverEndpoints":{ + "shape":"ResolverEndpoints", + "documentation":"

    The resolver endpoints that were created by using the current AWS account, and that match the specified filters, if any.

    " + } + } + }, + "ListResolverRuleAssociationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListResolverRuleAssociation request, omit this value.

    If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

    ", + "box":true + }, + "Filters":{ + "shape":"Filters", + "documentation":"

    An optional specification to return a subset of resolver rules, such as resolver rules that are associated with the same VPC ID.

    If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

    ", + "box":true + } + } + }, + "ListResolverRuleAssociationsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The value that you specified for MaxResults in the request.

    " + }, + "ResolverRuleAssociations":{ + "shape":"ResolverRuleAssociations", + "documentation":"

    The associations that were created between resolver rules and VPCs using the current AWS account, and that match the specified filters, if any.

    " + } + } + }, + "ListResolverRulesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 resolver rules.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListResolverRules request, omit this value.

    If you have more than MaxResults resolver rules, you can submit another ListResolverRules request to get the next group of resolver rules. In the next request, specify the value of NextToken from the previous response.

    ", + "box":true + }, + "Filters":{ + "shape":"Filters", + "documentation":"

    An optional specification to return a subset of resolver rules, such as all resolver rules that are associated with the same resolver endpoint.

    If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

    ", + "box":true + } + } + }, + "ListResolverRulesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The value that you specified for MaxResults in the request.

    " + }, + "ResolverRules":{ + "shape":"ResolverRules", + "documentation":"

    The resolver rules that were created using the current AWS account and that match the specified filters, if any.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the resource that you want to list tags for.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListTagsForResource request, omit this value.

    If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

    ", + "box":true + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags that are associated with the resource that you specified in the ListTagsForResource request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "max":64, + "pattern":"(?!^[0-9]+$)([a-zA-Z0-9-_' ']+)" + }, + "NextToken":{"type":"string"}, + "Port":{ + "type":"integer", + "max":65535, + "min":0 + }, + "PutResolverRulePolicyRequest":{ + "type":"structure", + "required":[ + "Arn", + "ResolverRulePolicy" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the account that you want to grant permissions to.

    " + }, + "ResolverRulePolicy":{ + "shape":"ResolverRulePolicy", + "documentation":"

    An AWS Identity and Access Management policy statement that lists the permissions that you want to grant to another AWS account.

    " + } + } + }, + "PutResolverRulePolicyResponse":{ + "type":"structure", + "members":{ + "ReturnValue":{ + "shape":"Boolean", + "documentation":"

    Whether the PutResolverRulePolicy request was successful.

    " + } + }, + "documentation":"

    The response to a PutResolverRulePolicy request.

    " + }, + "ResolverEndpoint":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint.

    " + }, + "CreatorRequestId":{ + "shape":"CreatorRequestId", + "documentation":"

    A unique string that identifies the request that created the resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of executing the operation twice.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The ARN (Amazon Resource Name) for the resolver endpoint.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    The name that you assigned to the resolver endpoint when you submitted a CreateResolverEndpoint request.

    " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

    The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound resolver rules.

    " + }, + "Direction":{ + "shape":"ResolverEndpointDirection", + "documentation":"

    Indicates whether the resolver endpoint allows inbound or outbound DNS queries:

    • INBOUND: allows DNS queries to your VPC from your network or another VPC

    • OUTBOUND: allows DNS queries from your VPC to your network or another VPC

    " + }, + "IpAddressCount":{ + "shape":"IpAddressCount", + "documentation":"

    The number of IP addresses that the resolver endpoint can use for DNS queries.

    " + }, + "HostVPCId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the VPC that you want to create the resolver endpoint in.

    " + }, + "Status":{ + "shape":"ResolverEndpointStatus", + "documentation":"

    A code that specifies the current status of the resolver endpoint.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    A detailed description of the status of the resolver endpoint.

    " + }, + "CreationTime":{ + "shape":"Rfc3339TimeString", + "documentation":"

    The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

    " + }, + "ModificationTime":{ + "shape":"Rfc3339TimeString", + "documentation":"

    The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

    " + } + }, + "documentation":"

    In the response to a CreateResolverEndpoint, DeleteResolverEndpoint, GetResolverEndpoint, ListResolverEndpoints, or UpdateResolverEndpoint request, a complex type that contains settings for an existing inbound or outbound resolver endpoint.

    " + }, + "ResolverEndpointDirection":{ + "type":"string", + "enum":[ + "INBOUND", + "OUTBOUND" + ] + }, + "ResolverEndpointStatus":{ + "type":"string", + "enum":[ + "CREATING", + "OPERATIONAL", + "UPDATING", + "AUTO_RECOVERING", + "ACTION_NEEDED", + "DELETING" + ] + }, + "ResolverEndpoints":{ + "type":"list", + "member":{"shape":"ResolverEndpoint"} + }, + "ResolverRule":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID that Resolver assigned to the resolver rule when you created it.

    " + }, + "CreatorRequestId":{ + "shape":"CreatorRequestId", + "documentation":"

    A unique string that you specified when you created the resolver rule. CreatorRequestIdidentifies the request and allows failed requests to be retried without the risk of executing the operation twice.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The ARN (Amazon Resource Name) for the resolver rule specified by Id.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple resolver rules (example.com and www.example.com), the query is routed using the resolver rule that contains the most specific domain name (www.example.com).

    " + }, + "Status":{ + "shape":"ResolverRuleStatus", + "documentation":"

    A code that specifies the current status of the resolver rule.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    A detailed description of the status of a resolver rule.

    " + }, + "RuleType":{ + "shape":"RuleTypeOption", + "documentation":"

    This value is always FORWARD. Other resolver rule types aren't supported.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    The name for the resolver rule, which you specified when you created the resolver rule.

    " + }, + "TargetIps":{ + "shape":"TargetList", + "documentation":"

    An array that contains the IP addresses and ports that you want to forward

    " + }, + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the endpoint that the rule is associated with.

    " + }, + "OwnerId":{ + "shape":"AccountId", + "documentation":"

    When a rule is shared with another AWS account, the account ID of the account that the rule is shared with.

    " + }, + "ShareStatus":{ + "shape":"ShareStatus", + "documentation":"

    Whether the rules is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

    " + } + }, + "documentation":"

    For queries that originate in your VPC, detailed information about a resolver rule, which specifies how to route DNS queries out of the VPC. The ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.

    " + }, + "ResolverRuleAssociation":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the association between a resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

    " + }, + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you associated with the VPC that is specified by VPCId.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    The name of an association between a resolver rule and a VPC.

    " + }, + "VPCId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the VPC that you associated the resolver rule with.

    " + }, + "Status":{ + "shape":"ResolverRuleAssociationStatus", + "documentation":"

    A code that specifies the current status of the association between a resolver rule and a VPC.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    A detailed description of the status of the association between a resolver rule and a VPC.

    " + } + }, + "documentation":"

    In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations request, information about an association between a resolver rule and a VPC.

    " + }, + "ResolverRuleAssociationStatus":{ + "type":"string", + "enum":[ + "CREATING", + "COMPLETE", + "DELETING", + "FAILED", + "OVERRIDDEN" + ] + }, + "ResolverRuleAssociations":{ + "type":"list", + "member":{"shape":"ResolverRuleAssociation"} + }, + "ResolverRuleConfig":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Name", + "documentation":"

    The new name for the resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

    " + }, + "TargetIps":{ + "shape":"TargetList", + "documentation":"

    For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

    " + }, + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the new outbound resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

    " + } + }, + "documentation":"

    In an UpdateResolverRule request, information about the changes that you want to make.

    " + }, + "ResolverRulePolicy":{ + "type":"string", + "max":5000 + }, + "ResolverRuleStatus":{ + "type":"string", + "enum":[ + "COMPLETE", + "DELETING", + "UPDATING", + "FAILED" + ] + }, + "ResolverRules":{ + "type":"list", + "member":{"shape":"ResolverRule"} + }, + "ResourceExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    For a ResourceExistsException error, the type of resource that the error applies to.

    " + } + }, + "documentation":"

    The resource that you tried to create already exists.

    ", + "exception":true + }, + "ResourceId":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    For a ResourceInUseException error, the type of resource that is currently in use.

    " + } + }, + "documentation":"

    The resource that you tried to update or delete is currently in use.

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    For a ResourceNotFoundException error, the type of resource that doesn't exist.

    " + } + }, + "documentation":"

    The specified resource doesn't exist.

    ", + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    For a ResourceUnavailableException error, the type of resource that isn't available.

    " + } + }, + "documentation":"

    The specified resource isn't available.

    ", + "exception":true + }, + "Rfc3339TimeString":{ + "type":"string", + "max":40, + "min":20 + }, + "RuleTypeOption":{ + "type":"string", + "enum":[ + "FORWARD", + "SYSTEM", + "RECURSIVE" + ] + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"ResourceId"} + }, + "ShareStatus":{ + "type":"string", + "enum":[ + "NOT_SHARED", + "SHARED_WITH_ME", + "SHARED_BY_ME" + ] + }, + "StatusMessage":{ + "type":"string", + "max":255 + }, + "String":{"type":"string"}, + "SubnetId":{ + "type":"string", + "max":32, + "min":1 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

    " + } + }, + "documentation":"

    One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.

    " + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags that you want to add to the specified resource.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "TargetAddress":{ + "type":"structure", + "required":["Ip"], + "members":{ + "Ip":{ + "shape":"Ip", + "documentation":"

    One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.

    " + }, + "Port":{ + "shape":"Port", + "documentation":"

    The port at Ip that you want to forward DNS queries to.

    ", + "box":true + } + }, + "documentation":"

    In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.

    " + }, + "TargetList":{ + "type":"list", + "member":{"shape":"TargetAddress"}, + "min":1 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The request was throttled. Try again in a few minutes.

    ", + "exception":true + }, + "UnknownResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified resource doesn't exist.

    ", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tags that you want to remove to the specified resource.

    " + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateResolverEndpointRequest":{ + "type":"structure", + "required":["ResolverEndpointId"], + "members":{ + "ResolverEndpointId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver endpoint that you want to update.

    " + }, + "Name":{ + "shape":"Name", + "documentation":"

    The name of the resolver endpoint that you want to update.

    ", + "box":true + } + } + }, + "UpdateResolverEndpointResponse":{ + "type":"structure", + "members":{ + "ResolverEndpoint":{ + "shape":"ResolverEndpoint", + "documentation":"

    The response to an UpdateResolverEndpoint request.

    " + } + } + }, + "UpdateResolverRuleRequest":{ + "type":"structure", + "required":[ + "ResolverRuleId", + "Config" + ], + "members":{ + "ResolverRuleId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resolver rule that you want to update.

    " + }, + "Config":{ + "shape":"ResolverRuleConfig", + "documentation":"

    The new settings for the resolver rule.

    " + } + } + }, + "UpdateResolverRuleResponse":{ + "type":"structure", + "members":{ + "ResolverRule":{ + "shape":"ResolverRule", + "documentation":"

    The response to an UpdateResolverRule request.

    " + } + } + } + }, + "documentation":"

    Here's how you set up to query an Amazon Route 53 private hosted zone from your network:

    1. Connect your network to a VPC using AWS Direct Connect or a VPN.

    2. Run the following AWS CLI command to create a Resolver endpoint:

      create-resolver-endpoint --name [endpoint_name] --direction INBOUND --creator-request-id [unique_string] --security-group-ids [security_group_with_inbound_rules] --ip-addresses SubnetId=[subnet_id] SubnetId=[subnet_id_in_different_AZ]

      Note the resolver endpoint ID that appears in the response. You'll use it in step 3.

    3. Get the IP addresses for the Resolver endpoints:

      get-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]

    4. In your network configuration, define the IP addresses that you got in step 3 as DNS servers.

      You can now query instance names in your VPCs and the names of records in your private hosted zone.

    You can also perform the following operations using the AWS CLI:

    • list-resolver-endpoints: List all endpoints. The syntax includes options for pagination and filtering.

    • update-resolver-endpoints: Add IP addresses to an endpoint or remove IP addresses from an endpoint.

    To delete an endpoint, use the following AWS CLI command:

    delete-resolver-endpoint --resolver-endpoint-id [resolver_endpoint_id]

    " +} diff --git a/aws/dist/botocore/data/s3/2006-03-01/examples-1.json b/aws/dist/botocore/data/s3/2006-03-01/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/s3/2006-03-01/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/s3/2006-03-01/paginators-1.json b/aws/dist/botocore/data/s3/2006-03-01/paginators-1.json new file mode 100644 index 00000000..d6c97ba4 --- /dev/null +++ b/aws/dist/botocore/data/s3/2006-03-01/paginators-1.json @@ -0,0 +1,69 @@ +{ + "pagination": { + "ListMultipartUploads": { + "limit_key": "MaxUploads", + "more_results": "IsTruncated", + "output_token": [ + "NextKeyMarker", + "NextUploadIdMarker" + ], + "input_token": [ + "KeyMarker", + "UploadIdMarker" + ], + "result_key": [ + "Uploads", + "CommonPrefixes" + ] + }, + "ListObjectVersions": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": [ + "NextKeyMarker", + "NextVersionIdMarker" + ], + "input_token": [ + "KeyMarker", + "VersionIdMarker" + ], + "result_key": [ + "Versions", + "DeleteMarkers", + "CommonPrefixes" + ] + }, + "ListObjects": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": "NextMarker || Contents[-1].Key", + "input_token": "Marker", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListObjectsV2": { + "more_results": "IsTruncated", + "limit_key": "MaxKeys", + "output_token": "NextContinuationToken", + "input_token": "ContinuationToken", + "result_key": [ + "Contents", + "CommonPrefixes" + ] + }, + "ListParts": { + "more_results": "IsTruncated", + "limit_key": "MaxParts", + "output_token": "NextPartNumberMarker", + "input_token": "PartNumberMarker", + "result_key": "Parts", + "non_aggregate_keys": [ + "Initiator", + "Owner", + "StorageClass" + ] + } + } +} diff --git a/aws/dist/botocore/data/s3/2006-03-01/service-2.json b/aws/dist/botocore/data/s3/2006-03-01/service-2.json new file mode 100644 index 00000000..218cfc46 --- /dev/null +++ b/aws/dist/botocore/data/s3/2006-03-01/service-2.json @@ -0,0 +1,8451 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2006-03-01", + "checksumFormat":"md5", + "endpointPrefix":"s3", + "globalEndpoint":"s3.amazonaws.com", + "protocol":"rest-xml", + "serviceAbbreviation":"Amazon S3", + "serviceFullName":"Amazon Simple Storage Service", + "serviceId":"S3", + "signatureVersion":"s3", + "uid":"s3-2006-03-01" + }, + "operations":{ + "AbortMultipartUpload":{ + "name":"AbortMultipartUpload", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key+}", + "responseCode":204 + }, + "input":{"shape":"AbortMultipartUploadRequest"}, + "output":{"shape":"AbortMultipartUploadOutput"}, + "errors":[ + {"shape":"NoSuchUpload"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html", + "documentation":"

    Aborts a multipart upload.

    To verify that all parts have been removed, so you don't get charged for the part storage, you should call the List Parts operation and ensure the parts list is empty.

    " + }, + "CompleteMultipartUpload":{ + "name":"CompleteMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"CompleteMultipartUploadRequest"}, + "output":{"shape":"CompleteMultipartUploadOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html", + "documentation":"

    Completes a multipart upload by assembling previously uploaded parts.

    " + }, + "CopyObject":{ + "name":"CopyObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"CopyObjectRequest"}, + "output":{"shape":"CopyObjectOutput"}, + "errors":[ + {"shape":"ObjectNotInActiveTierError"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html", + "documentation":"

    Creates a copy of an object that is already stored in Amazon S3.

    ", + "alias":"PutObjectCopy" + }, + "CreateBucket":{ + "name":"CreateBucket", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"CreateBucketRequest"}, + "output":{"shape":"CreateBucketOutput"}, + "errors":[ + {"shape":"BucketAlreadyExists"}, + {"shape":"BucketAlreadyOwnedByYou"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", + "documentation":"

    Creates a new bucket.

    ", + "alias":"PutBucket" + }, + "CreateMultipartUpload":{ + "name":"CreateMultipartUpload", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}?uploads" + }, + "input":{"shape":"CreateMultipartUploadRequest"}, + "output":{"shape":"CreateMultipartUploadOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html", + "documentation":"

    Initiates a multipart upload and returns an upload ID.

    Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    ", + "alias":"InitiateMultipartUpload" + }, + "DeleteBucket":{ + "name":"DeleteBucket", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html", + "documentation":"

    Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.

    " + }, + "DeleteBucketAnalyticsConfiguration":{ + "name":"DeleteBucketAnalyticsConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?analytics", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketAnalyticsConfigurationRequest"}, + "documentation":"

    Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).

    To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.

    " + }, + "DeleteBucketCors":{ + "name":"DeleteBucketCors", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?cors", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketCorsRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html", + "documentation":"

    Deletes the CORS configuration information set for the bucket.

    " + }, + "DeleteBucketEncryption":{ + "name":"DeleteBucketEncryption", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?encryption", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketEncryptionRequest"}, + "documentation":"

    Deletes the server-side encryption configuration from the bucket.

    " + }, + "DeleteBucketInventoryConfiguration":{ + "name":"DeleteBucketInventoryConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?inventory", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketInventoryConfigurationRequest"}, + "documentation":"

    Deletes an inventory configuration (identified by the inventory ID) from the bucket.

    " + }, + "DeleteBucketLifecycle":{ + "name":"DeleteBucketLifecycle", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?lifecycle", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketLifecycleRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html", + "documentation":"

    Deletes the lifecycle configuration from the bucket.

    " + }, + "DeleteBucketMetricsConfiguration":{ + "name":"DeleteBucketMetricsConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?metrics", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketMetricsConfigurationRequest"}, + "documentation":"

    Deletes a metrics configuration (specified by the metrics configuration ID) from the bucket.

    " + }, + "DeleteBucketPolicy":{ + "name":"DeleteBucketPolicy", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?policy", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketPolicyRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html", + "documentation":"

    Deletes the policy from the bucket.

    " + }, + "DeleteBucketReplication":{ + "name":"DeleteBucketReplication", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?replication", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketReplicationRequest"}, + "documentation":"

    Deletes the replication configuration from the bucket. For information about replication configuration, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    " + }, + "DeleteBucketTagging":{ + "name":"DeleteBucketTagging", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?tagging", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketTaggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html", + "documentation":"

    Deletes the tags from the bucket.

    " + }, + "DeleteBucketWebsite":{ + "name":"DeleteBucketWebsite", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?website", + "responseCode":204 + }, + "input":{"shape":"DeleteBucketWebsiteRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html", + "documentation":"

    This operation removes the website configuration from the bucket.

    " + }, + "DeleteObject":{ + "name":"DeleteObject", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key+}", + "responseCode":204 + }, + "input":{"shape":"DeleteObjectRequest"}, + "output":{"shape":"DeleteObjectOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html", + "documentation":"

    Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.

    " + }, + "DeleteObjectTagging":{ + "name":"DeleteObjectTagging", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}/{Key+}?tagging", + "responseCode":204 + }, + "input":{"shape":"DeleteObjectTaggingRequest"}, + "output":{"shape":"DeleteObjectTaggingOutput"}, + "documentation":"

    Removes the tag-set from an existing object.

    " + }, + "DeleteObjects":{ + "name":"DeleteObjects", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}?delete" + }, + "input":{"shape":"DeleteObjectsRequest"}, + "output":{"shape":"DeleteObjectsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html", + "documentation":"

    This operation enables you to delete multiple objects from a bucket using a single HTTP request. You may specify up to 1000 keys.

    ", + "alias":"DeleteMultipleObjects" + }, + "DeletePublicAccessBlock":{ + "name":"DeletePublicAccessBlock", + "http":{ + "method":"DELETE", + "requestUri":"/{Bucket}?publicAccessBlock", + "responseCode":204 + }, + "input":{"shape":"DeletePublicAccessBlockRequest"}, + "documentation":"

    Removes the PublicAccessBlock configuration from an Amazon S3 bucket.

    " + }, + "GetBucketAccelerateConfiguration":{ + "name":"GetBucketAccelerateConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?accelerate" + }, + "input":{"shape":"GetBucketAccelerateConfigurationRequest"}, + "output":{"shape":"GetBucketAccelerateConfigurationOutput"}, + "documentation":"

    Returns the accelerate configuration of a bucket.

    " + }, + "GetBucketAcl":{ + "name":"GetBucketAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"GetBucketAclRequest"}, + "output":{"shape":"GetBucketAclOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html", + "documentation":"

    Gets the access control policy for the bucket.

    " + }, + "GetBucketAnalyticsConfiguration":{ + "name":"GetBucketAnalyticsConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?analytics" + }, + "input":{"shape":"GetBucketAnalyticsConfigurationRequest"}, + "output":{"shape":"GetBucketAnalyticsConfigurationOutput"}, + "documentation":"

    Gets an analytics configuration for the bucket (specified by the analytics configuration ID).

    " + }, + "GetBucketCors":{ + "name":"GetBucketCors", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"GetBucketCorsRequest"}, + "output":{"shape":"GetBucketCorsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html", + "documentation":"

    Returns the CORS configuration for the bucket.

    " + }, + "GetBucketEncryption":{ + "name":"GetBucketEncryption", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?encryption" + }, + "input":{"shape":"GetBucketEncryptionRequest"}, + "output":{"shape":"GetBucketEncryptionOutput"}, + "documentation":"

    Returns the server-side encryption configuration of a bucket.

    " + }, + "GetBucketInventoryConfiguration":{ + "name":"GetBucketInventoryConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?inventory" + }, + "input":{"shape":"GetBucketInventoryConfigurationRequest"}, + "output":{"shape":"GetBucketInventoryConfigurationOutput"}, + "documentation":"

    Returns an inventory configuration (identified by the inventory ID) from the bucket.

    " + }, + "GetBucketLifecycle":{ + "name":"GetBucketLifecycle", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"GetBucketLifecycleRequest"}, + "output":{"shape":"GetBucketLifecycleOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html", + "documentation":"

    No longer used, see the GetBucketLifecycleConfiguration operation.

    ", + "deprecated":true + }, + "GetBucketLifecycleConfiguration":{ + "name":"GetBucketLifecycleConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"GetBucketLifecycleConfigurationRequest"}, + "output":{"shape":"GetBucketLifecycleConfigurationOutput"}, + "documentation":"

    Returns the lifecycle configuration information set on the bucket.

    " + }, + "GetBucketLocation":{ + "name":"GetBucketLocation", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?location" + }, + "input":{"shape":"GetBucketLocationRequest"}, + "output":{"shape":"GetBucketLocationOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html", + "documentation":"

    Returns the region the bucket resides in.

    " + }, + "GetBucketLogging":{ + "name":"GetBucketLogging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"GetBucketLoggingRequest"}, + "output":{"shape":"GetBucketLoggingOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html", + "documentation":"

    Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.

    " + }, + "GetBucketMetricsConfiguration":{ + "name":"GetBucketMetricsConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?metrics" + }, + "input":{"shape":"GetBucketMetricsConfigurationRequest"}, + "output":{"shape":"GetBucketMetricsConfigurationOutput"}, + "documentation":"

    Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.

    " + }, + "GetBucketNotification":{ + "name":"GetBucketNotification", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"GetBucketNotificationConfigurationRequest"}, + "output":{"shape":"NotificationConfigurationDeprecated"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html", + "documentation":"

    No longer used, see the GetBucketNotificationConfiguration operation.

    ", + "deprecated":true + }, + "GetBucketNotificationConfiguration":{ + "name":"GetBucketNotificationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"GetBucketNotificationConfigurationRequest"}, + "output":{"shape":"NotificationConfiguration"}, + "documentation":"

    Returns the notification configuration of a bucket.

    " + }, + "GetBucketPolicy":{ + "name":"GetBucketPolicy", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"GetBucketPolicyRequest"}, + "output":{"shape":"GetBucketPolicyOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html", + "documentation":"

    Returns the policy of a specified bucket.

    " + }, + "GetBucketPolicyStatus":{ + "name":"GetBucketPolicyStatus", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?policyStatus" + }, + "input":{"shape":"GetBucketPolicyStatusRequest"}, + "output":{"shape":"GetBucketPolicyStatusOutput"}, + "documentation":"

    Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.

    " + }, + "GetBucketReplication":{ + "name":"GetBucketReplication", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?replication" + }, + "input":{"shape":"GetBucketReplicationRequest"}, + "output":{"shape":"GetBucketReplicationOutput"}, + "documentation":"

    Returns the replication configuration of a bucket.

    It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.

    " + }, + "GetBucketRequestPayment":{ + "name":"GetBucketRequestPayment", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"GetBucketRequestPaymentRequest"}, + "output":{"shape":"GetBucketRequestPaymentOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html", + "documentation":"

    Returns the request payment configuration of a bucket.

    " + }, + "GetBucketTagging":{ + "name":"GetBucketTagging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"GetBucketTaggingRequest"}, + "output":{"shape":"GetBucketTaggingOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html", + "documentation":"

    Returns the tag set associated with the bucket.

    " + }, + "GetBucketVersioning":{ + "name":"GetBucketVersioning", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"GetBucketVersioningRequest"}, + "output":{"shape":"GetBucketVersioningOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html", + "documentation":"

    Returns the versioning state of a bucket.

    " + }, + "GetBucketWebsite":{ + "name":"GetBucketWebsite", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"GetBucketWebsiteRequest"}, + "output":{"shape":"GetBucketWebsiteOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html", + "documentation":"

    Returns the website configuration for a bucket.

    " + }, + "GetObject":{ + "name":"GetObject", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"GetObjectRequest"}, + "output":{"shape":"GetObjectOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html", + "documentation":"

    Retrieves objects from Amazon S3.

    " + }, + "GetObjectAcl":{ + "name":"GetObjectAcl", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?acl" + }, + "input":{"shape":"GetObjectAclRequest"}, + "output":{"shape":"GetObjectAclOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html", + "documentation":"

    Returns the access control list (ACL) of an object.

    " + }, + "GetObjectLegalHold":{ + "name":"GetObjectLegalHold", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?legal-hold" + }, + "input":{"shape":"GetObjectLegalHoldRequest"}, + "output":{"shape":"GetObjectLegalHoldOutput"}, + "documentation":"

    Gets an object's current Legal Hold status.

    " + }, + "GetObjectLockConfiguration":{ + "name":"GetObjectLockConfiguration", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?object-lock" + }, + "input":{"shape":"GetObjectLockConfigurationRequest"}, + "output":{"shape":"GetObjectLockConfigurationOutput"}, + "documentation":"

    Gets the object lock configuration for a bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

    " + }, + "GetObjectRetention":{ + "name":"GetObjectRetention", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?retention" + }, + "input":{"shape":"GetObjectRetentionRequest"}, + "output":{"shape":"GetObjectRetentionOutput"}, + "documentation":"

    Retrieves an object's retention settings.

    " + }, + "GetObjectTagging":{ + "name":"GetObjectTagging", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?tagging" + }, + "input":{"shape":"GetObjectTaggingRequest"}, + "output":{"shape":"GetObjectTaggingOutput"}, + "documentation":"

    Returns the tag-set of an object.

    " + }, + "GetObjectTorrent":{ + "name":"GetObjectTorrent", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}?torrent" + }, + "input":{"shape":"GetObjectTorrentRequest"}, + "output":{"shape":"GetObjectTorrentOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html", + "documentation":"

    Return torrent files from a bucket.

    " + }, + "GetPublicAccessBlock":{ + "name":"GetPublicAccessBlock", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?publicAccessBlock" + }, + "input":{"shape":"GetPublicAccessBlockRequest"}, + "output":{"shape":"GetPublicAccessBlockOutput"}, + "documentation":"

    Retrieves the PublicAccessBlock configuration for an Amazon S3 bucket.

    " + }, + "HeadBucket":{ + "name":"HeadBucket", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"HeadBucketRequest"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html", + "documentation":"

    This operation is useful to determine if a bucket exists and you have permission to access it.

    " + }, + "HeadObject":{ + "name":"HeadObject", + "http":{ + "method":"HEAD", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"HeadObjectRequest"}, + "output":{"shape":"HeadObjectOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html", + "documentation":"

    The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.

    " + }, + "ListBucketAnalyticsConfigurations":{ + "name":"ListBucketAnalyticsConfigurations", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?analytics" + }, + "input":{"shape":"ListBucketAnalyticsConfigurationsRequest"}, + "output":{"shape":"ListBucketAnalyticsConfigurationsOutput"}, + "documentation":"

    Lists the analytics configurations for the bucket.

    " + }, + "ListBucketInventoryConfigurations":{ + "name":"ListBucketInventoryConfigurations", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?inventory" + }, + "input":{"shape":"ListBucketInventoryConfigurationsRequest"}, + "output":{"shape":"ListBucketInventoryConfigurationsOutput"}, + "documentation":"

    Returns a list of inventory configurations for the bucket.

    " + }, + "ListBucketMetricsConfigurations":{ + "name":"ListBucketMetricsConfigurations", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?metrics" + }, + "input":{"shape":"ListBucketMetricsConfigurationsRequest"}, + "output":{"shape":"ListBucketMetricsConfigurationsOutput"}, + "documentation":"

    Lists the metrics configurations for the bucket.

    " + }, + "ListBuckets":{ + "name":"ListBuckets", + "http":{ + "method":"GET", + "requestUri":"/" + }, + "output":{"shape":"ListBucketsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html", + "documentation":"

    Returns a list of all buckets owned by the authenticated sender of the request.

    ", + "alias":"GetService" + }, + "ListMultipartUploads":{ + "name":"ListMultipartUploads", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?uploads" + }, + "input":{"shape":"ListMultipartUploadsRequest"}, + "output":{"shape":"ListMultipartUploadsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html", + "documentation":"

    This operation lists in-progress multipart uploads.

    " + }, + "ListObjectVersions":{ + "name":"ListObjectVersions", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?versions" + }, + "input":{"shape":"ListObjectVersionsRequest"}, + "output":{"shape":"ListObjectVersionsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html", + "documentation":"

    Returns metadata about all of the versions of objects in a bucket.

    ", + "alias":"GetBucketObjectVersions" + }, + "ListObjects":{ + "name":"ListObjects", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}" + }, + "input":{"shape":"ListObjectsRequest"}, + "output":{"shape":"ListObjectsOutput"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html", + "documentation":"

    Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket.

    ", + "alias":"GetBucket" + }, + "ListObjectsV2":{ + "name":"ListObjectsV2", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}?list-type=2" + }, + "input":{"shape":"ListObjectsV2Request"}, + "output":{"shape":"ListObjectsV2Output"}, + "errors":[ + {"shape":"NoSuchBucket"} + ], + "documentation":"

    Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. Note: ListObjectsV2 is the revised List Objects API and we recommend you use this revised API for new application development.

    " + }, + "ListParts":{ + "name":"ListParts", + "http":{ + "method":"GET", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"ListPartsRequest"}, + "output":{"shape":"ListPartsOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html", + "documentation":"

    Lists the parts that have been uploaded for a specific multipart upload.

    " + }, + "PutBucketAccelerateConfiguration":{ + "name":"PutBucketAccelerateConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?accelerate" + }, + "input":{"shape":"PutBucketAccelerateConfigurationRequest"}, + "documentation":"

    Sets the accelerate configuration of an existing bucket.

    " + }, + "PutBucketAcl":{ + "name":"PutBucketAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?acl" + }, + "input":{"shape":"PutBucketAclRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html", + "documentation":"

    Sets the permissions on a bucket using access control lists (ACL).

    " + }, + "PutBucketAnalyticsConfiguration":{ + "name":"PutBucketAnalyticsConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?analytics" + }, + "input":{"shape":"PutBucketAnalyticsConfigurationRequest"}, + "documentation":"

    Sets an analytics configuration for the bucket (specified by the analytics configuration ID).

    " + }, + "PutBucketCors":{ + "name":"PutBucketCors", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?cors" + }, + "input":{"shape":"PutBucketCorsRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html", + "documentation":"

    Sets the CORS configuration for a bucket.

    " + }, + "PutBucketEncryption":{ + "name":"PutBucketEncryption", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?encryption" + }, + "input":{"shape":"PutBucketEncryptionRequest"}, + "documentation":"

    Creates a new server-side encryption configuration (or replaces an existing one, if present).

    " + }, + "PutBucketInventoryConfiguration":{ + "name":"PutBucketInventoryConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?inventory" + }, + "input":{"shape":"PutBucketInventoryConfigurationRequest"}, + "documentation":"

    Adds an inventory configuration (identified by the inventory ID) from the bucket.

    " + }, + "PutBucketLifecycle":{ + "name":"PutBucketLifecycle", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"PutBucketLifecycleRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html", + "documentation":"

    No longer used, see the PutBucketLifecycleConfiguration operation.

    ", + "deprecated":true + }, + "PutBucketLifecycleConfiguration":{ + "name":"PutBucketLifecycleConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?lifecycle" + }, + "input":{"shape":"PutBucketLifecycleConfigurationRequest"}, + "documentation":"

    Sets lifecycle configuration for your bucket. If a lifecycle configuration exists, it replaces it.

    " + }, + "PutBucketLogging":{ + "name":"PutBucketLogging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?logging" + }, + "input":{"shape":"PutBucketLoggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html", + "documentation":"

    Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. To set the logging status of a bucket, you must be the bucket owner.

    " + }, + "PutBucketMetricsConfiguration":{ + "name":"PutBucketMetricsConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?metrics" + }, + "input":{"shape":"PutBucketMetricsConfigurationRequest"}, + "documentation":"

    Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.

    " + }, + "PutBucketNotification":{ + "name":"PutBucketNotification", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"PutBucketNotificationRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html", + "documentation":"

    No longer used, see the PutBucketNotificationConfiguration operation.

    ", + "deprecated":true + }, + "PutBucketNotificationConfiguration":{ + "name":"PutBucketNotificationConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?notification" + }, + "input":{"shape":"PutBucketNotificationConfigurationRequest"}, + "documentation":"

    Enables notifications of specified events for a bucket.

    " + }, + "PutBucketPolicy":{ + "name":"PutBucketPolicy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?policy" + }, + "input":{"shape":"PutBucketPolicyRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html", + "documentation":"

    Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

    " + }, + "PutBucketReplication":{ + "name":"PutBucketReplication", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?replication" + }, + "input":{"shape":"PutBucketReplicationRequest"}, + "documentation":"

    Creates a replication configuration or replaces an existing one. For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    " + }, + "PutBucketRequestPayment":{ + "name":"PutBucketRequestPayment", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?requestPayment" + }, + "input":{"shape":"PutBucketRequestPaymentRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html", + "documentation":"

    Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. Documentation on requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html

    " + }, + "PutBucketTagging":{ + "name":"PutBucketTagging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?tagging" + }, + "input":{"shape":"PutBucketTaggingRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html", + "documentation":"

    Sets the tags for a bucket.

    " + }, + "PutBucketVersioning":{ + "name":"PutBucketVersioning", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?versioning" + }, + "input":{"shape":"PutBucketVersioningRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html", + "documentation":"

    Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.

    " + }, + "PutBucketWebsite":{ + "name":"PutBucketWebsite", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?website" + }, + "input":{"shape":"PutBucketWebsiteRequest"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html", + "documentation":"

    Set the website configuration for a bucket.

    " + }, + "PutObject":{ + "name":"PutObject", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"PutObjectRequest"}, + "output":{"shape":"PutObjectOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html", + "documentation":"

    Adds an object to a bucket.

    " + }, + "PutObjectAcl":{ + "name":"PutObjectAcl", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}?acl" + }, + "input":{"shape":"PutObjectAclRequest"}, + "output":{"shape":"PutObjectAclOutput"}, + "errors":[ + {"shape":"NoSuchKey"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html", + "documentation":"

    uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket

    " + }, + "PutObjectLegalHold":{ + "name":"PutObjectLegalHold", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}?legal-hold" + }, + "input":{"shape":"PutObjectLegalHoldRequest"}, + "output":{"shape":"PutObjectLegalHoldOutput"}, + "documentation":"

    Applies a Legal Hold configuration to the specified object.

    " + }, + "PutObjectLockConfiguration":{ + "name":"PutObjectLockConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?object-lock" + }, + "input":{"shape":"PutObjectLockConfigurationRequest"}, + "output":{"shape":"PutObjectLockConfigurationOutput"}, + "documentation":"

    Places an object lock configuration on the specified bucket. The rule specified in the object lock configuration will be applied by default to every new object placed in the specified bucket.

    " + }, + "PutObjectRetention":{ + "name":"PutObjectRetention", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}?retention" + }, + "input":{"shape":"PutObjectRetentionRequest"}, + "output":{"shape":"PutObjectRetentionOutput"}, + "documentation":"

    Places an Object Retention configuration on an object.

    " + }, + "PutObjectTagging":{ + "name":"PutObjectTagging", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}?tagging" + }, + "input":{"shape":"PutObjectTaggingRequest"}, + "output":{"shape":"PutObjectTaggingOutput"}, + "documentation":"

    Sets the supplied tag-set to an object that already exists in a bucket

    " + }, + "PutPublicAccessBlock":{ + "name":"PutPublicAccessBlock", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}?publicAccessBlock" + }, + "input":{"shape":"PutPublicAccessBlockRequest"}, + "documentation":"

    Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.

    " + }, + "RestoreObject":{ + "name":"RestoreObject", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}?restore" + }, + "input":{"shape":"RestoreObjectRequest"}, + "output":{"shape":"RestoreObjectOutput"}, + "errors":[ + {"shape":"ObjectAlreadyInActiveTierError"} + ], + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html", + "documentation":"

    Restores an archived copy of an object back into Amazon S3

    ", + "alias":"PostObjectRestore" + }, + "SelectObjectContent":{ + "name":"SelectObjectContent", + "http":{ + "method":"POST", + "requestUri":"/{Bucket}/{Key+}?select&select-type=2" + }, + "input":{ + "shape":"SelectObjectContentRequest", + "locationName":"SelectObjectContentRequest", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "output":{"shape":"SelectObjectContentOutput"}, + "documentation":"

    This operation filters the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

    " + }, + "UploadPart":{ + "name":"UploadPart", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"UploadPartRequest"}, + "output":{"shape":"UploadPartOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html", + "documentation":"

    Uploads a part in a multipart upload.

    Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.

    " + }, + "UploadPartCopy":{ + "name":"UploadPartCopy", + "http":{ + "method":"PUT", + "requestUri":"/{Bucket}/{Key+}" + }, + "input":{"shape":"UploadPartCopyRequest"}, + "output":{"shape":"UploadPartCopyOutput"}, + "documentationUrl":"http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", + "documentation":"

    Uploads a part by copying data from an existing object as data source.

    " + } + }, + "shapes":{ + "AbortDate":{"type":"timestamp"}, + "AbortIncompleteMultipartUpload":{ + "type":"structure", + "members":{ + "DaysAfterInitiation":{ + "shape":"DaysAfterInitiation", + "documentation":"

    Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

    " + } + }, + "documentation":"

    Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the Amazon Simple Storage Service Developer Guide.

    " + }, + "AbortMultipartUploadOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "AbortMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the multipart upload was initiated.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Key of the object for which the multipart upload was initiated.

    ", + "location":"uri", + "locationName":"Key" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID that identifies the multipart upload.

    ", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "AbortRuleId":{"type":"string"}, + "AccelerateConfiguration":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BucketAccelerateStatus", + "documentation":"

    Specifies the transfer acceleration status of the bucket.

    " + } + }, + "documentation":"

    Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.

    " + }, + "AcceptRanges":{"type":"string"}, + "AccessControlPolicy":{ + "type":"structure", + "members":{ + "Grants":{ + "shape":"Grants", + "documentation":"

    A list of grants.

    ", + "locationName":"AccessControlList" + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    Container for the bucket owner's display name and ID.

    " + } + }, + "documentation":"

    Contains the elements that set the ACL permissions for an object per grantee.

    " + }, + "AccessControlTranslation":{ + "type":"structure", + "required":["Owner"], + "members":{ + "Owner":{ + "shape":"OwnerOverride", + "documentation":"

    Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon Simple Storage Service API Reference.

    " + } + }, + "documentation":"

    A container for information about access control for replicas.

    " + }, + "AccountId":{"type":"string"}, + "AllowQuotedRecordDelimiter":{"type":"boolean"}, + "AllowedHeader":{"type":"string"}, + "AllowedHeaders":{ + "type":"list", + "member":{"shape":"AllowedHeader"}, + "flattened":true + }, + "AllowedMethod":{"type":"string"}, + "AllowedMethods":{ + "type":"list", + "member":{"shape":"AllowedMethod"}, + "flattened":true + }, + "AllowedOrigin":{"type":"string"}, + "AllowedOrigins":{ + "type":"list", + "member":{"shape":"AllowedOrigin"}, + "flattened":true + }, + "AnalyticsAndOperator":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

    " + }, + "Tags":{ + "shape":"TagSet", + "documentation":"

    The list of tags to use when evaluating an AND predicate.

    ", + "flattened":true, + "locationName":"Tag" + } + }, + "documentation":"

    A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

    " + }, + "AnalyticsConfiguration":{ + "type":"structure", + "required":[ + "Id", + "StorageClassAnalysis" + ], + "members":{ + "Id":{ + "shape":"AnalyticsId", + "documentation":"

    The ID that identifies the analytics configuration.

    " + }, + "Filter":{ + "shape":"AnalyticsFilter", + "documentation":"

    The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

    " + }, + "StorageClassAnalysis":{ + "shape":"StorageClassAnalysis", + "documentation":"

    Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

    " + } + }, + "documentation":"

    Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

    For more information, see GET Bucket analytics in the Amazon Simple Storage Service API Reference.

    " + }, + "AnalyticsConfigurationList":{ + "type":"list", + "member":{"shape":"AnalyticsConfiguration"}, + "flattened":true + }, + "AnalyticsExportDestination":{ + "type":"structure", + "required":["S3BucketDestination"], + "members":{ + "S3BucketDestination":{ + "shape":"AnalyticsS3BucketDestination", + "documentation":"

    A destination signifying output to an S3 bucket.

    " + } + }, + "documentation":"

    Where to publish the analytics results.

    " + }, + "AnalyticsFilter":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix to use when evaluating an analytics filter.

    " + }, + "Tag":{ + "shape":"Tag", + "documentation":"

    The tag to use when evaluating an analytics filter.

    " + }, + "And":{ + "shape":"AnalyticsAndOperator", + "documentation":"

    A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

    " + } + }, + "documentation":"

    " + }, + "AnalyticsId":{"type":"string"}, + "AnalyticsS3BucketDestination":{ + "type":"structure", + "required":[ + "Format", + "Bucket" + ], + "members":{ + "Format":{ + "shape":"AnalyticsS3ExportFileFormat", + "documentation":"

    Specifies the file format used when exporting data to Amazon S3.

    " + }, + "BucketAccountId":{ + "shape":"AccountId", + "documentation":"

    The account ID that owns the destination bucket. If no account ID is provided, the owner will not be validated prior to exporting data.

    " + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The Amazon Resource Name (ARN) of the bucket to which data is exported.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix to use when exporting data. The prefix is prepended to all results.

    " + } + }, + "documentation":"

    " + }, + "AnalyticsS3ExportFileFormat":{ + "type":"string", + "enum":["CSV"] + }, + "Body":{"type":"blob"}, + "Bucket":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket.

    " + }, + "CreationDate":{ + "shape":"CreationDate", + "documentation":"

    Date the bucket was created.

    " + } + }, + "documentation":"

    " + }, + "BucketAccelerateStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, + "BucketAlreadyExists":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.

    ", + "exception":true + }, + "BucketAlreadyOwnedByYou":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "exception":true + }, + "BucketCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read" + ] + }, + "BucketLifecycleConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"LifecycleRules", + "documentation":"

    A lifecycle rule for individual objects in an Amazon S3 bucket.

    ", + "locationName":"Rule" + } + }, + "documentation":"

    Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon Simple Storage Service Developer Guide.

    " + }, + "BucketLocationConstraint":{ + "type":"string", + "enum":[ + "EU", + "eu-west-1", + "us-west-1", + "us-west-2", + "ap-south-1", + "ap-southeast-1", + "ap-southeast-2", + "ap-northeast-1", + "sa-east-1", + "cn-north-1", + "eu-central-1" + ] + }, + "BucketLoggingStatus":{ + "type":"structure", + "members":{ + "LoggingEnabled":{ + "shape":"LoggingEnabled", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "BucketLogsPermission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "READ", + "WRITE" + ] + }, + "BucketName":{"type":"string"}, + "BucketVersioningStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, + "Buckets":{ + "type":"list", + "member":{ + "shape":"Bucket", + "locationName":"Bucket" + } + }, + "BypassGovernanceRetention":{"type":"boolean"}, + "BytesProcessed":{"type":"long"}, + "BytesReturned":{"type":"long"}, + "BytesScanned":{"type":"long"}, + "CORSConfiguration":{ + "type":"structure", + "required":["CORSRules"], + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "documentation":"

    A set of allowed origins and methods.

    ", + "locationName":"CORSRule" + } + }, + "documentation":"

    Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.

    " + }, + "CORSRule":{ + "type":"structure", + "required":[ + "AllowedMethods", + "AllowedOrigins" + ], + "members":{ + "AllowedHeaders":{ + "shape":"AllowedHeaders", + "documentation":"

    Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

    ", + "locationName":"AllowedHeader" + }, + "AllowedMethods":{ + "shape":"AllowedMethods", + "documentation":"

    An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

    ", + "locationName":"AllowedMethod" + }, + "AllowedOrigins":{ + "shape":"AllowedOrigins", + "documentation":"

    One or more origins you want customers to be able to access the bucket from.

    ", + "locationName":"AllowedOrigin" + }, + "ExposeHeaders":{ + "shape":"ExposeHeaders", + "documentation":"

    One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

    ", + "locationName":"ExposeHeader" + }, + "MaxAgeSeconds":{ + "shape":"MaxAgeSeconds", + "documentation":"

    The time in seconds that your browser is to cache the preflight response for the specified resource.

    " + } + }, + "documentation":"

    Specifies a cross-origin access rule for an Amazon S3 bucket.

    " + }, + "CORSRules":{ + "type":"list", + "member":{"shape":"CORSRule"}, + "flattened":true + }, + "CSVInput":{ + "type":"structure", + "members":{ + "FileHeaderInfo":{ + "shape":"FileHeaderInfo", + "documentation":"

    Describes the first line of input. Valid values: None, Ignore, Use.

    " + }, + "Comments":{ + "shape":"Comments", + "documentation":"

    The single character used to indicate a row should be ignored when present at the start of a row.

    " + }, + "QuoteEscapeCharacter":{ + "shape":"QuoteEscapeCharacter", + "documentation":"

    The single character used for escaping the quote character inside an already escaped value.

    " + }, + "RecordDelimiter":{ + "shape":"RecordDelimiter", + "documentation":"

    The value used to separate individual records.

    " + }, + "FieldDelimiter":{ + "shape":"FieldDelimiter", + "documentation":"

    The value used to separate individual fields in a record.

    " + }, + "QuoteCharacter":{ + "shape":"QuoteCharacter", + "documentation":"

    Value used for escaping where the field delimiter is part of the value.

    " + }, + "AllowQuotedRecordDelimiter":{ + "shape":"AllowQuotedRecordDelimiter", + "documentation":"

    Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.

    " + } + }, + "documentation":"

    Describes how a CSV-formatted input object is formatted.

    " + }, + "CSVOutput":{ + "type":"structure", + "members":{ + "QuoteFields":{ + "shape":"QuoteFields", + "documentation":"

    Indicates whether or not all output fields should be quoted.

    " + }, + "QuoteEscapeCharacter":{ + "shape":"QuoteEscapeCharacter", + "documentation":"

    Th single character used for escaping the quote character inside an already escaped value.

    " + }, + "RecordDelimiter":{ + "shape":"RecordDelimiter", + "documentation":"

    The value used to separate individual records.

    " + }, + "FieldDelimiter":{ + "shape":"FieldDelimiter", + "documentation":"

    The value used to separate individual fields in a record.

    " + }, + "QuoteCharacter":{ + "shape":"QuoteCharacter", + "documentation":"

    The value used for escaping where the field delimiter is part of the value.

    " + } + }, + "documentation":"

    Describes how CSV-formatted results are formatted.

    " + }, + "CacheControl":{"type":"string"}, + "CloudFunction":{"type":"string"}, + "CloudFunctionConfiguration":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Event":{ + "shape":"Event", + "deprecated":true + }, + "Events":{ + "shape":"EventList", + "documentation":"

    ", + "locationName":"Event" + }, + "CloudFunction":{ + "shape":"CloudFunction", + "documentation":"

    " + }, + "InvocationRole":{ + "shape":"CloudFunctionInvocationRole", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "CloudFunctionInvocationRole":{"type":"string"}, + "Code":{"type":"string"}, + "Comments":{"type":"string"}, + "CommonPrefix":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "CommonPrefixList":{ + "type":"list", + "member":{"shape":"CommonPrefix"}, + "flattened":true + }, + "CompleteMultipartUploadOutput":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"Location", + "documentation":"

    " + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    " + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    " + }, + "Expiration":{ + "shape":"Expiration", + "documentation":"

    If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

    ", + "location":"header", + "locationName":"x-amz-expiration" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag of the object.

    " + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version of the object.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "CompleteMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "MultipartUpload":{ + "shape":"CompletedMultipartUpload", + "documentation":"

    ", + "locationName":"CompleteMultipartUpload", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    ", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"MultipartUpload" + }, + "CompletedMultipartUpload":{ + "type":"structure", + "members":{ + "Parts":{ + "shape":"CompletedPartList", + "documentation":"

    ", + "locationName":"Part" + } + }, + "documentation":"

    " + }, + "CompletedPart":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag returned when the part was uploaded.

    " + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number that identifies the part. This is a positive integer between 1 and 10,000.

    " + } + }, + "documentation":"

    " + }, + "CompletedPartList":{ + "type":"list", + "member":{"shape":"CompletedPart"}, + "flattened":true + }, + "CompressionType":{ + "type":"string", + "enum":[ + "NONE", + "GZIP", + "BZIP2" + ] + }, + "Condition":{ + "type":"structure", + "members":{ + "HttpErrorCodeReturnedEquals":{ + "shape":"HttpErrorCodeReturnedEquals", + "documentation":"

    The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

    " + }, + "KeyPrefixEquals":{ + "shape":"KeyPrefixEquals", + "documentation":"

    The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html, the key prefix will be ExamplePage.html. To redirect request for all pages with the prefix docs/, the key prefix will be /docs, which identifies all objects in the docs/ folder. Required when the parent element Condition is specified and sibling HttpErrorCodeReturnedEquals is not specified. If both conditions are specified, both must be true for the redirect to be applied.

    " + } + }, + "documentation":"

    Specifies a condition that must be met for a redirect to apply.

    " + }, + "ConfirmRemoveSelfBucketAccess":{"type":"boolean"}, + "ContentDisposition":{"type":"string"}, + "ContentEncoding":{"type":"string"}, + "ContentLanguage":{"type":"string"}, + "ContentLength":{"type":"long"}, + "ContentMD5":{"type":"string"}, + "ContentRange":{"type":"string"}, + "ContentType":{"type":"string"}, + "ContinuationEvent":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "event":true + }, + "CopyObjectOutput":{ + "type":"structure", + "members":{ + "CopyObjectResult":{ + "shape":"CopyObjectResult", + "documentation":"

    " + }, + "Expiration":{ + "shape":"Expiration", + "documentation":"

    If the object expiration is configured, the response includes this header.

    ", + "location":"header", + "locationName":"x-amz-expiration" + }, + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-copy-source-version-id" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version ID of the newly created copy.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"CopyObjectResult" + }, + "CopyObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "documentation":"

    The canned ACL to apply to the object.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "documentation":"

    Specifies caching behavior along the request/reply chain.

    ", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "documentation":"

    Specifies presentational information for the object.

    ", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "documentation":"

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "documentation":"

    The language the content is in.

    ", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    A standard MIME type describing the format of the object data.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "CopySource":{ + "shape":"CopySource", + "documentation":"

    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    ", + "location":"header", + "locationName":"x-amz-copy-source" + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "documentation":"

    Copies the object if its entity tag (ETag) matches the specified tag.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "documentation":"

    Copies the object if it has been modified since the specified time.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since" + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "documentation":"

    Copies the object if its entity tag (ETag) is different than the specified ETag.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "documentation":"

    Copies the object if it hasn't been modified since the specified time.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

    The date and time at which the object is no longer cacheable.

    ", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to read the object data and its metadata.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the object ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable object.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

    A map of metadata to store with the object in S3.

    ", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "MetadataDirective":{ + "shape":"MetadataDirective", + "documentation":"

    Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

    ", + "location":"header", + "locationName":"x-amz-metadata-directive" + }, + "TaggingDirective":{ + "shape":"TaggingDirective", + "documentation":"

    Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

    ", + "location":"header", + "locationName":"x-amz-tagging-directive" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The type of storage to use for the object. Defaults to 'STANDARD'.

    ", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "documentation":"

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "Tagging":{ + "shape":"TaggingHeader", + "documentation":"

    The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters

    ", + "location":"header", + "locationName":"x-amz-tagging" + }, + "ObjectLockMode":{ + "shape":"ObjectLockMode", + "documentation":"

    The object lock mode that you want to apply to the copied object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate":{ + "shape":"ObjectLockRetainUntilDate", + "documentation":"

    The date and time when you want the copied object's object lock to expire.

    ", + "location":"header", + "locationName":"x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    Specifies whether you want to apply a Legal Hold to the copied object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-legal-hold" + } + } + }, + "CopyObjectResult":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "CopyPartResult":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag of the object.

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Date and time at which the object was uploaded.

    " + } + }, + "documentation":"

    " + }, + "CopySource":{ + "type":"string", + "pattern":"\\/.+\\/.+" + }, + "CopySourceIfMatch":{"type":"string"}, + "CopySourceIfModifiedSince":{"type":"timestamp"}, + "CopySourceIfNoneMatch":{"type":"string"}, + "CopySourceIfUnmodifiedSince":{"type":"timestamp"}, + "CopySourceRange":{"type":"string"}, + "CopySourceSSECustomerAlgorithm":{"type":"string"}, + "CopySourceSSECustomerKey":{ + "type":"string", + "sensitive":true + }, + "CopySourceSSECustomerKeyMD5":{"type":"string"}, + "CopySourceVersionId":{"type":"string"}, + "CreateBucketConfiguration":{ + "type":"structure", + "members":{ + "LocationConstraint":{ + "shape":"BucketLocationConstraint", + "documentation":"

    Specifies the region where the bucket will be created. If you don't specify a region, the bucket is created in US East (N. Virginia) Region (us-east-1).

    " + } + }, + "documentation":"

    " + }, + "CreateBucketOutput":{ + "type":"structure", + "members":{ + "Location":{ + "shape":"Location", + "documentation":"

    ", + "location":"header", + "locationName":"Location" + } + } + }, + "CreateBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "documentation":"

    The canned ACL to apply to the bucket.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CreateBucketConfiguration":{ + "shape":"CreateBucketConfiguration", + "documentation":"

    ", + "locationName":"CreateBucketConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to list the objects in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the bucket ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "documentation":"

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "ObjectLockEnabledForBucket":{ + "shape":"ObjectLockEnabledForBucket", + "documentation":"

    Specifies whether you want Amazon S3 object lock to be enabled for the new bucket.

    ", + "location":"header", + "locationName":"x-amz-bucket-object-lock-enabled" + } + }, + "payload":"CreateBucketConfiguration" + }, + "CreateMultipartUploadOutput":{ + "type":"structure", + "members":{ + "AbortDate":{ + "shape":"AbortDate", + "documentation":"

    Date when multipart upload will become eligible for abort operation by lifecycle.

    ", + "location":"header", + "locationName":"x-amz-abort-date" + }, + "AbortRuleId":{ + "shape":"AbortRuleId", + "documentation":"

    Id of the lifecycle rule that makes a multipart upload eligible for abort operation.

    ", + "location":"header", + "locationName":"x-amz-abort-rule-id" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the multipart upload was initiated.

    ", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Object key for which the multipart upload was initiated.

    " + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    ID for the initiated multipart upload.

    " + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "CreateMultipartUploadRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "documentation":"

    The canned ACL to apply to the object.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "documentation":"

    Specifies caching behavior along the request/reply chain.

    ", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "documentation":"

    Specifies presentational information for the object.

    ", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "documentation":"

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "documentation":"

    The language the content is in.

    ", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    A standard MIME type describing the format of the object data.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

    The date and time at which the object is no longer cacheable.

    ", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to read the object data and its metadata.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the object ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable object.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

    A map of metadata to store with the object in S3.

    ", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The type of storage to use for the object. Defaults to 'STANDARD'.

    ", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "documentation":"

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "Tagging":{ + "shape":"TaggingHeader", + "documentation":"

    The tag-set for the object. The tag-set must be encoded as URL Query parameters

    ", + "location":"header", + "locationName":"x-amz-tagging" + }, + "ObjectLockMode":{ + "shape":"ObjectLockMode", + "documentation":"

    Specifies the object lock mode that you want to apply to the uploaded object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate":{ + "shape":"ObjectLockRetainUntilDate", + "documentation":"

    Specifies the date and time when you want the object lock to expire.

    ", + "location":"header", + "locationName":"x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    Specifies whether you want to apply a Legal Hold to the uploaded object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-legal-hold" + } + } + }, + "CreationDate":{"type":"timestamp"}, + "Date":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "Days":{"type":"integer"}, + "DaysAfterInitiation":{"type":"integer"}, + "DefaultRetention":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"ObjectLockRetentionMode", + "documentation":"

    The default object lock retention mode you want to apply to new objects placed in the specified bucket.

    " + }, + "Days":{ + "shape":"Days", + "documentation":"

    The number of days that you want to specify for the default retention period.

    " + }, + "Years":{ + "shape":"Years", + "documentation":"

    The number of years that you want to specify for the default retention period.

    " + } + }, + "documentation":"

    The container element for specifying the default object lock retention settings for new objects placed in the specified bucket.

    " + }, + "Delete":{ + "type":"structure", + "required":["Objects"], + "members":{ + "Objects":{ + "shape":"ObjectIdentifierList", + "documentation":"

    ", + "locationName":"Object" + }, + "Quiet":{ + "shape":"Quiet", + "documentation":"

    Element to enable quiet mode for the request. When you add this element, you must set its value to true.

    " + } + }, + "documentation":"

    " + }, + "DeleteBucketAnalyticsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket from which an analytics configuration is deleted.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"AnalyticsId", + "documentation":"

    The ID that identifies the analytics configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "DeleteBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketEncryptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the server-side encryption configuration to delete.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketInventoryConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the inventory configuration to delete.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"InventoryId", + "documentation":"

    The ID used to identify the inventory configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "DeleteBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketMetricsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the metrics configuration to delete.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"MetricsId", + "documentation":"

    The ID used to identify the metrics configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "DeleteBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketReplicationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket name.

    It can take a while to propagate the deletion of a replication configuration to all Amazon S3 systems.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeleteMarker":{"type":"boolean"}, + "DeleteMarkerEntry":{ + "type":"structure", + "members":{ + "Owner":{ + "shape":"Owner", + "documentation":"

    " + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The object key.

    " + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version ID of an object.

    " + }, + "IsLatest":{ + "shape":"IsLatest", + "documentation":"

    Specifies whether the object is (true) or is not (false) the latest version of an object.

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Date and time the object was last modified.

    " + } + }, + "documentation":"

    " + }, + "DeleteMarkerReplication":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"DeleteMarkerReplicationStatus", + "documentation":"

    The status of the delete marker replication.

    In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be Disabled.

    " + } + }, + "documentation":"

    Specifies whether Amazon S3 should replicate delete makers.

    " + }, + "DeleteMarkerReplicationStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "DeleteMarkerVersionId":{"type":"string"}, + "DeleteMarkers":{ + "type":"list", + "member":{"shape":"DeleteMarkerEntry"}, + "flattened":true + }, + "DeleteObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "documentation":"

    Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.

    ", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Returns the version ID of the delete marker created as a result of the DELETE operation.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "DeleteObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "MFA":{ + "shape":"MFA", + "documentation":"

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    ", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId used to reference a specific version of the object.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "BypassGovernanceRetention":{ + "shape":"BypassGovernanceRetention", + "documentation":"

    Indicates whether Amazon S3 object lock should bypass governance-mode restrictions to process this operation.

    ", + "location":"header", + "locationName":"x-amz-bypass-governance-retention" + } + } + }, + "DeleteObjectTaggingOutput":{ + "type":"structure", + "members":{ + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The versionId of the object the tag-set was removed from.

    ", + "location":"header", + "locationName":"x-amz-version-id" + } + } + }, + "DeleteObjectTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The versionId of the object that the tag-set will be removed from.

    ", + "location":"querystring", + "locationName":"versionId" + } + } + }, + "DeleteObjectsOutput":{ + "type":"structure", + "members":{ + "Deleted":{ + "shape":"DeletedObjects", + "documentation":"

    " + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "Errors":{ + "shape":"Errors", + "documentation":"

    ", + "locationName":"Error" + } + } + }, + "DeleteObjectsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Delete" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Delete":{ + "shape":"Delete", + "documentation":"

    ", + "locationName":"Delete", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "MFA":{ + "shape":"MFA", + "documentation":"

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    ", + "location":"header", + "locationName":"x-amz-mfa" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "BypassGovernanceRetention":{ + "shape":"BypassGovernanceRetention", + "documentation":"

    Specifies whether you want to delete this object even if it has a Governance-type object lock in place. You must have sufficient permissions to perform this operation.

    ", + "location":"header", + "locationName":"x-amz-bypass-governance-retention" + } + }, + "payload":"Delete" + }, + "DeletePublicAccessBlockRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "DeletedObject":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    " + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    " + }, + "DeleteMarker":{ + "shape":"DeleteMarker", + "documentation":"

    " + }, + "DeleteMarkerVersionId":{ + "shape":"DeleteMarkerVersionId", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "DeletedObjects":{ + "type":"list", + "member":{"shape":"DeletedObject"}, + "flattened":true + }, + "Delimiter":{"type":"string"}, + "Description":{"type":"string"}, + "Destination":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store replicas of the object identified by the rule.

    A replication configuration can replicate objects to only one destination bucket. If there are multiple rules in your replication configuration, all rules must specify the same destination bucket.

    " + }, + "Account":{ + "shape":"AccountId", + "documentation":"

    Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation property, this is the account ID of the destination bucket owner. For more information, see Cross-Region Replication Additional Configuration: Change Replica Owner in the Amazon Simple Storage Service Developer Guide.

    " + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The storage class to use when replicating objects, such as standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

    For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon Simple Storage Service API Reference.

    " + }, + "AccessControlTranslation":{ + "shape":"AccessControlTranslation", + "documentation":"

    Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.

    " + }, + "EncryptionConfiguration":{ + "shape":"EncryptionConfiguration", + "documentation":"

    A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

    " + } + }, + "documentation":"

    Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

    " + }, + "DisplayName":{"type":"string"}, + "ETag":{"type":"string"}, + "EmailAddress":{"type":"string"}, + "EnableRequestProgress":{"type":"boolean"}, + "EncodingType":{ + "type":"string", + "documentation":"

    Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.

    ", + "enum":["url"] + }, + "Encryption":{ + "type":"structure", + "required":["EncryptionType"], + "members":{ + "EncryptionType":{ + "shape":"ServerSideEncryption", + "documentation":"

    The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).

    " + }, + "KMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results.

    " + }, + "KMSContext":{ + "shape":"KMSContext", + "documentation":"

    If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

    " + } + }, + "documentation":"

    Describes the server-side encryption that will be applied to the restore results.

    " + }, + "EncryptionConfiguration":{ + "type":"structure", + "members":{ + "ReplicaKmsKeyID":{ + "shape":"ReplicaKmsKeyID", + "documentation":"

    Specifies the AWS KMS Key ID (Key ARN or Alias ARN) for the destination bucket. Amazon S3 uses this key to encrypt replica objects.

    " + } + }, + "documentation":"

    Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

    " + }, + "End":{"type":"long"}, + "EndEvent":{ + "type":"structure", + "members":{ + }, + "documentation":"

    ", + "event":true + }, + "Error":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    " + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    " + }, + "Code":{ + "shape":"Code", + "documentation":"

    " + }, + "Message":{ + "shape":"Message", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "ErrorDocument":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The object key name to use when a 4XX class error occurs.

    " + } + }, + "documentation":"

    " + }, + "Errors":{ + "type":"list", + "member":{"shape":"Error"}, + "flattened":true + }, + "Event":{ + "type":"string", + "documentation":"

    The bucket event for which to send notifications.

    ", + "enum":[ + "s3:ReducedRedundancyLostObject", + "s3:ObjectCreated:*", + "s3:ObjectCreated:Put", + "s3:ObjectCreated:Post", + "s3:ObjectCreated:Copy", + "s3:ObjectCreated:CompleteMultipartUpload", + "s3:ObjectRemoved:*", + "s3:ObjectRemoved:Delete", + "s3:ObjectRemoved:DeleteMarkerCreated", + "s3:ObjectRestore:Post", + "s3:ObjectRestore:Completed" + ] + }, + "EventList":{ + "type":"list", + "member":{"shape":"Event"}, + "flattened":true + }, + "Expiration":{"type":"string"}, + "ExpirationStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ExpiredObjectDeleteMarker":{"type":"boolean"}, + "Expires":{"type":"timestamp"}, + "ExposeHeader":{"type":"string"}, + "ExposeHeaders":{ + "type":"list", + "member":{"shape":"ExposeHeader"}, + "flattened":true + }, + "Expression":{"type":"string"}, + "ExpressionType":{ + "type":"string", + "enum":["SQL"] + }, + "FetchOwner":{"type":"boolean"}, + "FieldDelimiter":{"type":"string"}, + "FileHeaderInfo":{ + "type":"string", + "enum":[ + "USE", + "IGNORE", + "NONE" + ] + }, + "FilterRule":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"FilterRuleName", + "documentation":"

    The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

    " + }, + "Value":{ + "shape":"FilterRuleValue", + "documentation":"

    The value that the filter searches for in object key names.

    " + } + }, + "documentation":"

    Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.

    " + }, + "FilterRuleList":{ + "type":"list", + "member":{"shape":"FilterRule"}, + "documentation":"

    A list of containers for the key value pair that defines the criteria for the filter rule.

    ", + "flattened":true + }, + "FilterRuleName":{ + "type":"string", + "enum":[ + "prefix", + "suffix" + ] + }, + "FilterRuleValue":{"type":"string"}, + "GetBucketAccelerateConfigurationOutput":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BucketAccelerateStatus", + "documentation":"

    The accelerate configuration of the bucket.

    " + } + } + }, + "GetBucketAccelerateConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket for which the accelerate configuration is retrieved.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketAclOutput":{ + "type":"structure", + "members":{ + "Owner":{ + "shape":"Owner", + "documentation":"

    " + }, + "Grants":{ + "shape":"Grants", + "documentation":"

    A list of grants.

    ", + "locationName":"AccessControlList" + } + } + }, + "GetBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketAnalyticsConfigurationOutput":{ + "type":"structure", + "members":{ + "AnalyticsConfiguration":{ + "shape":"AnalyticsConfiguration", + "documentation":"

    The configuration and any analyses for the analytics filter.

    " + } + }, + "payload":"AnalyticsConfiguration" + }, + "GetBucketAnalyticsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket from which an analytics configuration is retrieved.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"AnalyticsId", + "documentation":"

    The ID that identifies the analytics configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "GetBucketCorsOutput":{ + "type":"structure", + "members":{ + "CORSRules":{ + "shape":"CORSRules", + "documentation":"

    ", + "locationName":"CORSRule" + } + } + }, + "GetBucketCorsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketEncryptionOutput":{ + "type":"structure", + "members":{ + "ServerSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

    " + } + }, + "payload":"ServerSideEncryptionConfiguration" + }, + "GetBucketEncryptionRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket from which the server-side encryption configuration is retrieved.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketInventoryConfigurationOutput":{ + "type":"structure", + "members":{ + "InventoryConfiguration":{ + "shape":"InventoryConfiguration", + "documentation":"

    Specifies the inventory configuration.

    " + } + }, + "payload":"InventoryConfiguration" + }, + "GetBucketInventoryConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the inventory configuration to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"InventoryId", + "documentation":"

    The ID used to identify the inventory configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "GetBucketLifecycleConfigurationOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"LifecycleRules", + "documentation":"

    ", + "locationName":"Rule" + } + } + }, + "GetBucketLifecycleConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLifecycleOutput":{ + "type":"structure", + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

    ", + "locationName":"Rule" + } + } + }, + "GetBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLocationOutput":{ + "type":"structure", + "members":{ + "LocationConstraint":{ + "shape":"BucketLocationConstraint", + "documentation":"

    " + } + } + }, + "GetBucketLocationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketLoggingOutput":{ + "type":"structure", + "members":{ + "LoggingEnabled":{ + "shape":"LoggingEnabled", + "documentation":"

    " + } + } + }, + "GetBucketLoggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketMetricsConfigurationOutput":{ + "type":"structure", + "members":{ + "MetricsConfiguration":{ + "shape":"MetricsConfiguration", + "documentation":"

    Specifies the metrics configuration.

    " + } + }, + "payload":"MetricsConfiguration" + }, + "GetBucketMetricsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the metrics configuration to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"MetricsId", + "documentation":"

    The ID used to identify the metrics configuration.

    ", + "location":"querystring", + "locationName":"id" + } + } + }, + "GetBucketNotificationConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to get the notification configuration for.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketPolicyOutput":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"Policy", + "documentation":"

    The bucket policy as a JSON document.

    " + } + }, + "payload":"Policy" + }, + "GetBucketPolicyRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketPolicyStatusOutput":{ + "type":"structure", + "members":{ + "PolicyStatus":{ + "shape":"PolicyStatus", + "documentation":"

    The policy status for the specified bucket.

    " + } + }, + "payload":"PolicyStatus" + }, + "GetBucketPolicyStatusRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the Amazon S3 bucket whose policy status you want to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketReplicationOutput":{ + "type":"structure", + "members":{ + "ReplicationConfiguration":{ + "shape":"ReplicationConfiguration", + "documentation":"

    " + } + }, + "payload":"ReplicationConfiguration" + }, + "GetBucketReplicationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketRequestPaymentOutput":{ + "type":"structure", + "members":{ + "Payer":{ + "shape":"Payer", + "documentation":"

    Specifies who pays for the download and request fees.

    " + } + } + }, + "GetBucketRequestPaymentRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketTaggingOutput":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{ + "shape":"TagSet", + "documentation":"

    " + } + } + }, + "GetBucketTaggingRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketVersioningOutput":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"

    The versioning state of the bucket.

    " + }, + "MFADelete":{ + "shape":"MFADeleteStatus", + "documentation":"

    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

    ", + "locationName":"MfaDelete" + } + } + }, + "GetBucketVersioningRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetBucketWebsiteOutput":{ + "type":"structure", + "members":{ + "RedirectAllRequestsTo":{ + "shape":"RedirectAllRequestsTo", + "documentation":"

    " + }, + "IndexDocument":{ + "shape":"IndexDocument", + "documentation":"

    " + }, + "ErrorDocument":{ + "shape":"ErrorDocument", + "documentation":"

    " + }, + "RoutingRules":{ + "shape":"RoutingRules", + "documentation":"

    " + } + } + }, + "GetBucketWebsiteRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetObjectAclOutput":{ + "type":"structure", + "members":{ + "Owner":{ + "shape":"Owner", + "documentation":"

    " + }, + "Grants":{ + "shape":"Grants", + "documentation":"

    A list of grants.

    ", + "locationName":"AccessControlList" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "GetObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId used to reference a specific version of the object.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetObjectLegalHoldOutput":{ + "type":"structure", + "members":{ + "LegalHold":{ + "shape":"ObjectLockLegalHold", + "documentation":"

    The current Legal Hold status for the specified object.

    " + } + }, + "payload":"LegalHold" + }, + "GetObjectLegalHoldRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket containing the object whose Legal Hold status you want to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The key name for the object whose Legal Hold status you want to retrieve.

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The version ID of the object whose Legal Hold status you want to retrieve.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetObjectLockConfigurationOutput":{ + "type":"structure", + "members":{ + "ObjectLockConfiguration":{ + "shape":"ObjectLockConfiguration", + "documentation":"

    The specified bucket's object lock configuration.

    " + } + }, + "payload":"ObjectLockConfiguration" + }, + "GetObjectLockConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket whose object lock configuration you want to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GetObjectOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "documentation":"

    Object data.

    ", + "streaming":true + }, + "DeleteMarker":{ + "shape":"DeleteMarker", + "documentation":"

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

    ", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "documentation":"

    ", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "documentation":"

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.

    ", + "location":"header", + "locationName":"x-amz-expiration" + }, + "Restore":{ + "shape":"Restore", + "documentation":"

    Provides information about object restoration operation and expiration time of the restored object copy.

    ", + "location":"header", + "locationName":"x-amz-restore" + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Last modified date of the object

    ", + "location":"header", + "locationName":"Last-Modified" + }, + "ContentLength":{ + "shape":"ContentLength", + "documentation":"

    Size of the body in bytes.

    ", + "location":"header", + "locationName":"Content-Length" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL

    ", + "location":"header", + "locationName":"ETag" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "documentation":"

    This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

    ", + "location":"header", + "locationName":"x-amz-missing-meta" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version of the object.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "CacheControl":{ + "shape":"CacheControl", + "documentation":"

    Specifies caching behavior along the request/reply chain.

    ", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "documentation":"

    Specifies presentational information for the object.

    ", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "documentation":"

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "documentation":"

    The language the content is in.

    ", + "location":"header", + "locationName":"Content-Language" + }, + "ContentRange":{ + "shape":"ContentRange", + "documentation":"

    The portion of the object returned in the response.

    ", + "location":"header", + "locationName":"Content-Range" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    A standard MIME type describing the format of the object data.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

    The date and time at which the object is no longer cacheable.

    ", + "location":"header", + "locationName":"Expires" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "documentation":"

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

    A map of metadata to store with the object in S3.

    ", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "ReplicationStatus":{ + "shape":"ReplicationStatus", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-replication-status" + }, + "PartsCount":{ + "shape":"PartsCount", + "documentation":"

    The count of parts this object has.

    ", + "location":"header", + "locationName":"x-amz-mp-parts-count" + }, + "TagCount":{ + "shape":"TagCount", + "documentation":"

    The number of tags, if any, on the object.

    ", + "location":"header", + "locationName":"x-amz-tagging-count" + }, + "ObjectLockMode":{ + "shape":"ObjectLockMode", + "documentation":"

    The object lock mode currently in place for this object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate":{ + "shape":"ObjectLockRetainUntilDate", + "documentation":"

    The date and time when this object's object lock will expire.

    ", + "location":"header", + "locationName":"x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.

    ", + "location":"header", + "locationName":"x-amz-object-lock-legal-hold" + } + }, + "payload":"Body" + }, + "GetObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "documentation":"

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    ", + "location":"header", + "locationName":"If-Match" + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "documentation":"

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    ", + "location":"header", + "locationName":"If-Modified-Since" + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "documentation":"

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    ", + "location":"header", + "locationName":"If-None-Match" + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "documentation":"

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    ", + "location":"header", + "locationName":"If-Unmodified-Since" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "documentation":"

    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    ", + "location":"header", + "locationName":"Range" + }, + "ResponseCacheControl":{ + "shape":"ResponseCacheControl", + "documentation":"

    Sets the Cache-Control header of the response.

    ", + "location":"querystring", + "locationName":"response-cache-control" + }, + "ResponseContentDisposition":{ + "shape":"ResponseContentDisposition", + "documentation":"

    Sets the Content-Disposition header of the response

    ", + "location":"querystring", + "locationName":"response-content-disposition" + }, + "ResponseContentEncoding":{ + "shape":"ResponseContentEncoding", + "documentation":"

    Sets the Content-Encoding header of the response.

    ", + "location":"querystring", + "locationName":"response-content-encoding" + }, + "ResponseContentLanguage":{ + "shape":"ResponseContentLanguage", + "documentation":"

    Sets the Content-Language header of the response.

    ", + "location":"querystring", + "locationName":"response-content-language" + }, + "ResponseContentType":{ + "shape":"ResponseContentType", + "documentation":"

    Sets the Content-Type header of the response.

    ", + "location":"querystring", + "locationName":"response-content-type" + }, + "ResponseExpires":{ + "shape":"ResponseExpires", + "documentation":"

    Sets the Expires header of the response.

    ", + "location":"querystring", + "locationName":"response-expires" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId used to reference a specific version of the object.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

    ", + "location":"querystring", + "locationName":"partNumber" + } + } + }, + "GetObjectRetentionOutput":{ + "type":"structure", + "members":{ + "Retention":{ + "shape":"ObjectLockRetention", + "documentation":"

    The container element for an object's retention settings.

    " + } + }, + "payload":"Retention" + }, + "GetObjectRetentionRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket containing the object whose retention settings you want to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The key name for the object whose retention settings you want to retrieve.

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The version ID for the object whose retention settings you want to retrieve.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetObjectTaggingOutput":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "TagSet":{ + "shape":"TagSet", + "documentation":"

    " + } + } + }, + "GetObjectTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    ", + "location":"querystring", + "locationName":"versionId" + } + } + }, + "GetObjectTorrentOutput":{ + "type":"structure", + "members":{ + "Body":{ + "shape":"Body", + "documentation":"

    ", + "streaming":true + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"Body" + }, + "GetObjectTorrentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "GetPublicAccessBlockOutput":{ + "type":"structure", + "members":{ + "PublicAccessBlockConfiguration":{ + "shape":"PublicAccessBlockConfiguration", + "documentation":"

    The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

    " + } + }, + "payload":"PublicAccessBlockConfiguration" + }, + "GetPublicAccessBlockRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "GlacierJobParameters":{ + "type":"structure", + "required":["Tier"], + "members":{ + "Tier":{ + "shape":"Tier", + "documentation":"

    Glacier retrieval tier at which the restore will be processed.

    " + } + }, + "documentation":"

    " + }, + "Grant":{ + "type":"structure", + "members":{ + "Grantee":{ + "shape":"Grantee", + "documentation":"

    " + }, + "Permission":{ + "shape":"Permission", + "documentation":"

    Specifies the permission given to the grantee.

    " + } + }, + "documentation":"

    " + }, + "GrantFullControl":{"type":"string"}, + "GrantRead":{"type":"string"}, + "GrantReadACP":{"type":"string"}, + "GrantWrite":{"type":"string"}, + "GrantWriteACP":{"type":"string"}, + "Grantee":{ + "type":"structure", + "required":["Type"], + "members":{ + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    Screen name of the grantee.

    " + }, + "EmailAddress":{ + "shape":"EmailAddress", + "documentation":"

    Email address of the grantee.

    " + }, + "ID":{ + "shape":"ID", + "documentation":"

    The canonical user ID of the grantee.

    " + }, + "Type":{ + "shape":"Type", + "documentation":"

    Type of grantee

    ", + "locationName":"xsi:type", + "xmlAttribute":true + }, + "URI":{ + "shape":"URI", + "documentation":"

    URI of the grantee group.

    " + } + }, + "documentation":"

    ", + "xmlNamespace":{ + "prefix":"xsi", + "uri":"http://www.w3.org/2001/XMLSchema-instance" + } + }, + "Grants":{ + "type":"list", + "member":{ + "shape":"Grant", + "locationName":"Grant" + } + }, + "HeadBucketRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + } + } + }, + "HeadObjectOutput":{ + "type":"structure", + "members":{ + "DeleteMarker":{ + "shape":"DeleteMarker", + "documentation":"

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

    ", + "location":"header", + "locationName":"x-amz-delete-marker" + }, + "AcceptRanges":{ + "shape":"AcceptRanges", + "documentation":"

    ", + "location":"header", + "locationName":"accept-ranges" + }, + "Expiration":{ + "shape":"Expiration", + "documentation":"

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.

    ", + "location":"header", + "locationName":"x-amz-expiration" + }, + "Restore":{ + "shape":"Restore", + "documentation":"

    Provides information about object restoration operation and expiration time of the restored object copy.

    ", + "location":"header", + "locationName":"x-amz-restore" + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Last modified date of the object

    ", + "location":"header", + "locationName":"Last-Modified" + }, + "ContentLength":{ + "shape":"ContentLength", + "documentation":"

    Size of the body in bytes.

    ", + "location":"header", + "locationName":"Content-Length" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL

    ", + "location":"header", + "locationName":"ETag" + }, + "MissingMeta":{ + "shape":"MissingMeta", + "documentation":"

    This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

    ", + "location":"header", + "locationName":"x-amz-missing-meta" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version of the object.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "CacheControl":{ + "shape":"CacheControl", + "documentation":"

    Specifies caching behavior along the request/reply chain.

    ", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "documentation":"

    Specifies presentational information for the object.

    ", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "documentation":"

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "documentation":"

    The language the content is in.

    ", + "location":"header", + "locationName":"Content-Language" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    A standard MIME type describing the format of the object data.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

    The date and time at which the object is no longer cacheable.

    ", + "location":"header", + "locationName":"Expires" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "documentation":"

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

    A map of metadata to store with the object in S3.

    ", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "ReplicationStatus":{ + "shape":"ReplicationStatus", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-replication-status" + }, + "PartsCount":{ + "shape":"PartsCount", + "documentation":"

    The count of parts this object has.

    ", + "location":"header", + "locationName":"x-amz-mp-parts-count" + }, + "ObjectLockMode":{ + "shape":"ObjectLockMode", + "documentation":"

    The object lock mode currently in place for this object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate":{ + "shape":"ObjectLockRetainUntilDate", + "documentation":"

    The date and time when this object's object lock expires.

    ", + "location":"header", + "locationName":"x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    The Legal Hold status for the specified object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-legal-hold" + } + } + }, + "HeadObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "IfMatch":{ + "shape":"IfMatch", + "documentation":"

    Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

    ", + "location":"header", + "locationName":"If-Match" + }, + "IfModifiedSince":{ + "shape":"IfModifiedSince", + "documentation":"

    Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

    ", + "location":"header", + "locationName":"If-Modified-Since" + }, + "IfNoneMatch":{ + "shape":"IfNoneMatch", + "documentation":"

    Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

    ", + "location":"header", + "locationName":"If-None-Match" + }, + "IfUnmodifiedSince":{ + "shape":"IfUnmodifiedSince", + "documentation":"

    Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

    ", + "location":"header", + "locationName":"If-Unmodified-Since" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "Range":{ + "shape":"Range", + "documentation":"

    Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

    ", + "location":"header", + "locationName":"Range" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId used to reference a specific version of the object.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

    ", + "location":"querystring", + "locationName":"partNumber" + } + } + }, + "HostName":{"type":"string"}, + "HttpErrorCodeReturnedEquals":{"type":"string"}, + "HttpRedirectCode":{"type":"string"}, + "ID":{"type":"string"}, + "IfMatch":{"type":"string"}, + "IfModifiedSince":{"type":"timestamp"}, + "IfNoneMatch":{"type":"string"}, + "IfUnmodifiedSince":{"type":"timestamp"}, + "IndexDocument":{ + "type":"structure", + "required":["Suffix"], + "members":{ + "Suffix":{ + "shape":"Suffix", + "documentation":"

    A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.

    " + } + }, + "documentation":"

    " + }, + "Initiated":{"type":"timestamp"}, + "Initiator":{ + "type":"structure", + "members":{ + "ID":{ + "shape":"ID", + "documentation":"

    If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    Name of the Principal.

    " + } + }, + "documentation":"

    " + }, + "InputSerialization":{ + "type":"structure", + "members":{ + "CSV":{ + "shape":"CSVInput", + "documentation":"

    Describes the serialization of a CSV-encoded object.

    " + }, + "CompressionType":{ + "shape":"CompressionType", + "documentation":"

    Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

    " + }, + "JSON":{ + "shape":"JSONInput", + "documentation":"

    Specifies JSON as object's input serialization format.

    " + }, + "Parquet":{ + "shape":"ParquetInput", + "documentation":"

    Specifies Parquet as object's input serialization format.

    " + } + }, + "documentation":"

    Describes the serialization format of the object.

    " + }, + "InventoryConfiguration":{ + "type":"structure", + "required":[ + "Destination", + "IsEnabled", + "Id", + "IncludedObjectVersions", + "Schedule" + ], + "members":{ + "Destination":{ + "shape":"InventoryDestination", + "documentation":"

    Contains information about where to publish the inventory results.

    " + }, + "IsEnabled":{ + "shape":"IsEnabled", + "documentation":"

    Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

    " + }, + "Filter":{ + "shape":"InventoryFilter", + "documentation":"

    Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.

    " + }, + "Id":{ + "shape":"InventoryId", + "documentation":"

    The ID used to identify the inventory configuration.

    " + }, + "IncludedObjectVersions":{ + "shape":"InventoryIncludedObjectVersions", + "documentation":"

    Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

    " + }, + "OptionalFields":{ + "shape":"InventoryOptionalFields", + "documentation":"

    Contains the optional fields that are included in the inventory results.

    " + }, + "Schedule":{ + "shape":"InventorySchedule", + "documentation":"

    Specifies the schedule for generating inventory results.

    " + } + }, + "documentation":"

    Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon Simple Storage Service API Reference.

    " + }, + "InventoryConfigurationList":{ + "type":"list", + "member":{"shape":"InventoryConfiguration"}, + "flattened":true + }, + "InventoryDestination":{ + "type":"structure", + "required":["S3BucketDestination"], + "members":{ + "S3BucketDestination":{ + "shape":"InventoryS3BucketDestination", + "documentation":"

    Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

    " + } + }, + "documentation":"

    " + }, + "InventoryEncryption":{ + "type":"structure", + "members":{ + "SSES3":{ + "shape":"SSES3", + "documentation":"

    Specifies the use of SSE-S3 to encrypt delivered Inventory reports.

    ", + "locationName":"SSE-S3" + }, + "SSEKMS":{ + "shape":"SSEKMS", + "documentation":"

    Specifies the use of SSE-KMS to encrypt delivered Inventory reports.

    ", + "locationName":"SSE-KMS" + } + }, + "documentation":"

    Contains the type of server-side encryption used to encrypt the inventory results.

    " + }, + "InventoryFilter":{ + "type":"structure", + "required":["Prefix"], + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix that an object must have to be included in the inventory results.

    " + } + }, + "documentation":"

    " + }, + "InventoryFormat":{ + "type":"string", + "enum":[ + "CSV", + "ORC", + "Parquet" + ] + }, + "InventoryFrequency":{ + "type":"string", + "enum":[ + "Daily", + "Weekly" + ] + }, + "InventoryId":{"type":"string"}, + "InventoryIncludedObjectVersions":{ + "type":"string", + "enum":[ + "All", + "Current" + ] + }, + "InventoryOptionalField":{ + "type":"string", + "enum":[ + "Size", + "LastModifiedDate", + "StorageClass", + "ETag", + "IsMultipartUploaded", + "ReplicationStatus", + "EncryptionStatus", + "ObjectLockRetainUntilDate", + "ObjectLockMode", + "ObjectLockLegalHoldStatus", + "IntelligentTieringAccessTier" + ] + }, + "InventoryOptionalFields":{ + "type":"list", + "member":{ + "shape":"InventoryOptionalField", + "locationName":"Field" + } + }, + "InventoryS3BucketDestination":{ + "type":"structure", + "required":[ + "Bucket", + "Format" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The ID of the account that owns the destination bucket.

    " + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The Amazon resource name (ARN) of the bucket where inventory results will be published.

    " + }, + "Format":{ + "shape":"InventoryFormat", + "documentation":"

    Specifies the output format of the inventory results.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix that is prepended to all inventory results.

    " + }, + "Encryption":{ + "shape":"InventoryEncryption", + "documentation":"

    Contains the type of server-side encryption used to encrypt the inventory results.

    " + } + }, + "documentation":"

    " + }, + "InventorySchedule":{ + "type":"structure", + "required":["Frequency"], + "members":{ + "Frequency":{ + "shape":"InventoryFrequency", + "documentation":"

    Specifies how frequently inventory results are produced.

    " + } + }, + "documentation":"

    " + }, + "IsEnabled":{"type":"boolean"}, + "IsLatest":{"type":"boolean"}, + "IsPublic":{"type":"boolean"}, + "IsTruncated":{"type":"boolean"}, + "JSONInput":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"JSONType", + "documentation":"

    The type of JSON. Valid values: Document, Lines.

    " + } + }, + "documentation":"

    " + }, + "JSONOutput":{ + "type":"structure", + "members":{ + "RecordDelimiter":{ + "shape":"RecordDelimiter", + "documentation":"

    The value used to separate individual records in the output.

    " + } + }, + "documentation":"

    " + }, + "JSONType":{ + "type":"string", + "enum":[ + "DOCUMENT", + "LINES" + ] + }, + "KMSContext":{"type":"string"}, + "KeyCount":{"type":"integer"}, + "KeyMarker":{"type":"string"}, + "KeyPrefixEquals":{"type":"string"}, + "LambdaFunctionArn":{"type":"string"}, + "LambdaFunctionConfiguration":{ + "type":"structure", + "required":[ + "LambdaFunctionArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "LambdaFunctionArn":{ + "shape":"LambdaFunctionArn", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

    ", + "locationName":"CloudFunction" + }, + "Events":{ + "shape":"EventList", + "documentation":"

    The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.

    ", + "locationName":"Event" + }, + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

    " + } + }, + "documentation":"

    A container for specifying the configuration for AWS Lambda notifications.

    " + }, + "LambdaFunctionConfigurationList":{ + "type":"list", + "member":{"shape":"LambdaFunctionConfiguration"}, + "flattened":true + }, + "LastModified":{"type":"timestamp"}, + "LifecycleConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"Rules", + "documentation":"

    ", + "locationName":"Rule" + } + }, + "documentation":"

    " + }, + "LifecycleExpiration":{ + "type":"structure", + "members":{ + "Date":{ + "shape":"Date", + "documentation":"

    Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.

    " + }, + "Days":{ + "shape":"Days", + "documentation":"

    Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

    " + }, + "ExpiredObjectDeleteMarker":{ + "shape":"ExpiredObjectDeleteMarker", + "documentation":"

    Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

    " + } + }, + "documentation":"

    " + }, + "LifecycleRule":{ + "type":"structure", + "required":["Status"], + "members":{ + "Expiration":{ + "shape":"LifecycleExpiration", + "documentation":"

    " + }, + "ID":{ + "shape":"ID", + "documentation":"

    Unique identifier for the rule. The value cannot be longer than 255 characters.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead.

    ", + "deprecated":true + }, + "Filter":{ + "shape":"LifecycleRuleFilter", + "documentation":"

    " + }, + "Status":{ + "shape":"ExpirationStatus", + "documentation":"

    If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.

    " + }, + "Transitions":{ + "shape":"TransitionList", + "documentation":"

    ", + "locationName":"Transition" + }, + "NoncurrentVersionTransitions":{ + "shape":"NoncurrentVersionTransitionList", + "documentation":"

    ", + "locationName":"NoncurrentVersionTransition" + }, + "NoncurrentVersionExpiration":{ + "shape":"NoncurrentVersionExpiration", + "documentation":"

    " + }, + "AbortIncompleteMultipartUpload":{ + "shape":"AbortIncompleteMultipartUpload", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "LifecycleRuleAndOperator":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    " + }, + "Tags":{ + "shape":"TagSet", + "documentation":"

    All of these tags must exist in the object's tag set in order for the rule to apply.

    ", + "flattened":true, + "locationName":"Tag" + } + }, + "documentation":"

    This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

    " + }, + "LifecycleRuleFilter":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Prefix identifying one or more objects to which the rule applies.

    " + }, + "Tag":{ + "shape":"Tag", + "documentation":"

    This tag must exist in the object's tag set in order for the rule to apply.

    " + }, + "And":{ + "shape":"LifecycleRuleAndOperator", + "documentation":"

    " + } + }, + "documentation":"

    The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.

    " + }, + "LifecycleRules":{ + "type":"list", + "member":{"shape":"LifecycleRule"}, + "flattened":true + }, + "ListBucketAnalyticsConfigurationsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

    " + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    The ContinuationToken that represents where this request began.

    " + }, + "NextContinuationToken":{ + "shape":"NextToken", + "documentation":"

    NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.

    " + }, + "AnalyticsConfigurationList":{ + "shape":"AnalyticsConfigurationList", + "documentation":"

    The list of analytics configurations for a bucket.

    ", + "locationName":"AnalyticsConfiguration" + } + } + }, + "ListBucketAnalyticsConfigurationsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket from which analytics configurations are retrieved.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    The ContinuationToken that represents a placeholder from where this request should begin.

    ", + "location":"querystring", + "locationName":"continuation-token" + } + } + }, + "ListBucketInventoryConfigurationsOutput":{ + "type":"structure", + "members":{ + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

    " + }, + "InventoryConfigurationList":{ + "shape":"InventoryConfigurationList", + "documentation":"

    The list of inventory configurations for a bucket.

    ", + "locationName":"InventoryConfiguration" + }, + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    Indicates whether the returned list of inventory configurations is truncated in this response. A value of true indicates that the list is truncated.

    " + }, + "NextContinuationToken":{ + "shape":"NextToken", + "documentation":"

    The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.

    " + } + } + }, + "ListBucketInventoryConfigurationsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the inventory configurations to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    ", + "location":"querystring", + "locationName":"continuation-token" + } + } + }, + "ListBucketMetricsConfigurationsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

    " + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

    " + }, + "NextContinuationToken":{ + "shape":"NextToken", + "documentation":"

    The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    " + }, + "MetricsConfigurationList":{ + "shape":"MetricsConfigurationList", + "documentation":"

    The list of metrics configurations for a bucket.

    ", + "locationName":"MetricsConfiguration" + } + } + }, + "ListBucketMetricsConfigurationsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket containing the metrics configurations to retrieve.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

    ", + "location":"querystring", + "locationName":"continuation-token" + } + } + }, + "ListBucketsOutput":{ + "type":"structure", + "members":{ + "Buckets":{ + "shape":"Buckets", + "documentation":"

    " + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    " + } + } + }, + "ListMultipartUploadsOutput":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the multipart upload was initiated.

    " + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"

    The key at or after which the listing began.

    " + }, + "UploadIdMarker":{ + "shape":"UploadIdMarker", + "documentation":"

    Upload ID after which listing began.

    " + }, + "NextKeyMarker":{ + "shape":"NextKeyMarker", + "documentation":"

    When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

    " + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    " + }, + "NextUploadIdMarker":{ + "shape":"NextUploadIdMarker", + "documentation":"

    When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.

    " + }, + "MaxUploads":{ + "shape":"MaxUploads", + "documentation":"

    Maximum number of multipart uploads that could have been included in the response.

    " + }, + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

    " + }, + "Uploads":{ + "shape":"MultipartUploadList", + "documentation":"

    ", + "locationName":"Upload" + }, + "CommonPrefixes":{ + "shape":"CommonPrefixList", + "documentation":"

    " + }, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"

    Encoding type used by Amazon S3 to encode object keys in the response.

    " + } + } + }, + "ListMultipartUploadsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    Character you use to group keys.

    ", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"

    Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.

    ", + "location":"querystring", + "locationName":"key-marker" + }, + "MaxUploads":{ + "shape":"MaxUploads", + "documentation":"

    Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

    ", + "location":"querystring", + "locationName":"max-uploads" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Lists in-progress uploads only for those keys that begin with the specified prefix.

    ", + "location":"querystring", + "locationName":"prefix" + }, + "UploadIdMarker":{ + "shape":"UploadIdMarker", + "documentation":"

    Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored.

    ", + "location":"querystring", + "locationName":"upload-id-marker" + } + } + }, + "ListObjectVersionsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

    " + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"

    Marks the last Key returned in a truncated response.

    " + }, + "VersionIdMarker":{ + "shape":"VersionIdMarker", + "documentation":"

    " + }, + "NextKeyMarker":{ + "shape":"NextKeyMarker", + "documentation":"

    Use this value for the key marker request parameter in a subsequent request.

    " + }, + "NextVersionIdMarker":{ + "shape":"NextVersionIdMarker", + "documentation":"

    Use this value for the next version id marker parameter in a subsequent request.

    " + }, + "Versions":{ + "shape":"ObjectVersionList", + "documentation":"

    ", + "locationName":"Version" + }, + "DeleteMarkers":{ + "shape":"DeleteMarkers", + "documentation":"

    ", + "locationName":"DeleteMarker" + }, + "Name":{ + "shape":"BucketName", + "documentation":"

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    " + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    " + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    " + }, + "CommonPrefixes":{ + "shape":"CommonPrefixList", + "documentation":"

    " + }, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"

    Encoding type used by Amazon S3 to encode object keys in the response.

    " + } + } + }, + "ListObjectVersionsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    A delimiter is a character you use to group keys.

    ", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "KeyMarker":{ + "shape":"KeyMarker", + "documentation":"

    Specifies the key to start with when listing objects in a bucket.

    ", + "location":"querystring", + "locationName":"key-marker" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

    ", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Limits the response to keys that begin with the specified prefix.

    ", + "location":"querystring", + "locationName":"prefix" + }, + "VersionIdMarker":{ + "shape":"VersionIdMarker", + "documentation":"

    Specifies the object version you want to start listing from.

    ", + "location":"querystring", + "locationName":"version-id-marker" + } + } + }, + "ListObjectsOutput":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMaker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.

    " + }, + "Contents":{ + "shape":"ObjectList", + "documentation":"

    " + }, + "Name":{ + "shape":"BucketName", + "documentation":"

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    " + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    " + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    " + }, + "CommonPrefixes":{ + "shape":"CommonPrefixList", + "documentation":"

    " + }, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"

    Encoding type used by Amazon S3 to encode object keys in the response.

    " + } + } + }, + "ListObjectsRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    A delimiter is a character you use to group keys.

    ", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "location":"querystring", + "locationName":"encoding-type" + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    Specifies the key to start with when listing objects in a bucket.

    ", + "location":"querystring", + "locationName":"marker" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

    ", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Limits the response to keys that begin with the specified prefix.

    ", + "location":"querystring", + "locationName":"prefix" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "documentation":"

    Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

    ", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "ListObjectsV2Output":{ + "type":"structure", + "members":{ + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.

    " + }, + "Contents":{ + "shape":"ObjectList", + "documentation":"

    Metadata about each object returned.

    " + }, + "Name":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to list.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Limits the response to keys that begin with the specified prefix.

    " + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    A delimiter is a character you use to group keys.

    " + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

    " + }, + "CommonPrefixes":{ + "shape":"CommonPrefixList", + "documentation":"

    CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by delimiter

    " + }, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"

    Encoding type used by Amazon S3 to encode object keys in the response.

    " + }, + "KeyCount":{ + "shape":"KeyCount", + "documentation":"

    KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys

    " + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

    " + }, + "NextContinuationToken":{ + "shape":"NextToken", + "documentation":"

    NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key

    " + }, + "StartAfter":{ + "shape":"StartAfter", + "documentation":"

    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

    " + } + } + }, + "ListObjectsV2Request":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to list.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Delimiter":{ + "shape":"Delimiter", + "documentation":"

    A delimiter is a character you use to group keys.

    ", + "location":"querystring", + "locationName":"delimiter" + }, + "EncodingType":{ + "shape":"EncodingType", + "documentation":"

    Encoding type used by Amazon S3 to encode object keys in the response.

    ", + "location":"querystring", + "locationName":"encoding-type" + }, + "MaxKeys":{ + "shape":"MaxKeys", + "documentation":"

    Sets the maximum number of keys returned in the response. The response might contain fewer keys but will never contain more.

    ", + "location":"querystring", + "locationName":"max-keys" + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Limits the response to keys that begin with the specified prefix.

    ", + "location":"querystring", + "locationName":"prefix" + }, + "ContinuationToken":{ + "shape":"Token", + "documentation":"

    ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key

    ", + "location":"querystring", + "locationName":"continuation-token" + }, + "FetchOwner":{ + "shape":"FetchOwner", + "documentation":"

    The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true

    ", + "location":"querystring", + "locationName":"fetch-owner" + }, + "StartAfter":{ + "shape":"StartAfter", + "documentation":"

    StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket

    ", + "location":"querystring", + "locationName":"start-after" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "documentation":"

    Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

    ", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "ListPartsOutput":{ + "type":"structure", + "members":{ + "AbortDate":{ + "shape":"AbortDate", + "documentation":"

    Date when multipart upload will become eligible for abort operation by lifecycle.

    ", + "location":"header", + "locationName":"x-amz-abort-date" + }, + "AbortRuleId":{ + "shape":"AbortRuleId", + "documentation":"

    Id of the lifecycle rule that makes a multipart upload eligible for abort operation.

    ", + "location":"header", + "locationName":"x-amz-abort-rule-id" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the multipart upload was initiated.

    " + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Object key for which the multipart upload was initiated.

    " + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID identifying the multipart upload whose parts are being listed.

    " + }, + "PartNumberMarker":{ + "shape":"PartNumberMarker", + "documentation":"

    Part number after which listing begins.

    " + }, + "NextPartNumberMarker":{ + "shape":"NextPartNumberMarker", + "documentation":"

    When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

    " + }, + "MaxParts":{ + "shape":"MaxParts", + "documentation":"

    Maximum number of parts that were allowed in the response.

    " + }, + "IsTruncated":{ + "shape":"IsTruncated", + "documentation":"

    Indicates whether the returned list of parts is truncated.

    " + }, + "Parts":{ + "shape":"Parts", + "documentation":"

    ", + "locationName":"Part" + }, + "Initiator":{ + "shape":"Initiator", + "documentation":"

    Identifies who initiated the multipart upload.

    " + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    " + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The class of storage used to store the object.

    " + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "ListPartsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "MaxParts":{ + "shape":"MaxParts", + "documentation":"

    Sets the maximum number of parts to return.

    ", + "location":"querystring", + "locationName":"max-parts" + }, + "PartNumberMarker":{ + "shape":"PartNumberMarker", + "documentation":"

    Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

    ", + "location":"querystring", + "locationName":"part-number-marker" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID identifying the multipart upload whose parts are being listed.

    ", + "location":"querystring", + "locationName":"uploadId" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "Location":{"type":"string"}, + "LocationPrefix":{"type":"string"}, + "LoggingEnabled":{ + "type":"structure", + "required":[ + "TargetBucket", + "TargetPrefix" + ], + "members":{ + "TargetBucket":{ + "shape":"TargetBucket", + "documentation":"

    Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.

    " + }, + "TargetGrants":{ + "shape":"TargetGrants", + "documentation":"

    " + }, + "TargetPrefix":{ + "shape":"TargetPrefix", + "documentation":"

    A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

    " + } + }, + "documentation":"

    Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon Simple Storage Service API Reference.

    " + }, + "MFA":{"type":"string"}, + "MFADelete":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "MFADeleteStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Marker":{"type":"string"}, + "MaxAgeSeconds":{"type":"integer"}, + "MaxKeys":{"type":"integer"}, + "MaxParts":{"type":"integer"}, + "MaxUploads":{"type":"integer"}, + "Message":{"type":"string"}, + "Metadata":{ + "type":"map", + "key":{"shape":"MetadataKey"}, + "value":{"shape":"MetadataValue"} + }, + "MetadataDirective":{ + "type":"string", + "enum":[ + "COPY", + "REPLACE" + ] + }, + "MetadataEntry":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"MetadataKey", + "documentation":"

    " + }, + "Value":{ + "shape":"MetadataValue", + "documentation":"

    " + } + }, + "documentation":"

    A metadata key-value pair to store with an object.

    " + }, + "MetadataKey":{"type":"string"}, + "MetadataValue":{"type":"string"}, + "MetricsAndOperator":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix used when evaluating an AND predicate.

    " + }, + "Tags":{ + "shape":"TagSet", + "documentation":"

    The list of tags used when evaluating an AND predicate.

    ", + "flattened":true, + "locationName":"Tag" + } + }, + "documentation":"

    " + }, + "MetricsConfiguration":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"MetricsId", + "documentation":"

    The ID used to identify the metrics configuration.

    " + }, + "Filter":{ + "shape":"MetricsFilter", + "documentation":"

    Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).

    " + } + }, + "documentation":"

    Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see PUT Bucket metrics in the Amazon Simple Storage Service API Reference.

    " + }, + "MetricsConfigurationList":{ + "type":"list", + "member":{"shape":"MetricsConfiguration"}, + "flattened":true + }, + "MetricsFilter":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    The prefix used when evaluating a metrics filter.

    " + }, + "Tag":{ + "shape":"Tag", + "documentation":"

    The tag used when evaluating a metrics filter.

    " + }, + "And":{ + "shape":"MetricsAndOperator", + "documentation":"

    A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

    " + } + }, + "documentation":"

    " + }, + "MetricsId":{"type":"string"}, + "MissingMeta":{"type":"integer"}, + "MultipartUpload":{ + "type":"structure", + "members":{ + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID that identifies the multipart upload.

    " + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Key of the object for which the multipart upload was initiated.

    " + }, + "Initiated":{ + "shape":"Initiated", + "documentation":"

    Date and time at which the multipart upload was initiated.

    " + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The class of storage used to store the object.

    " + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    " + }, + "Initiator":{ + "shape":"Initiator", + "documentation":"

    Identifies who initiated the multipart upload.

    " + } + }, + "documentation":"

    " + }, + "MultipartUploadId":{"type":"string"}, + "MultipartUploadList":{ + "type":"list", + "member":{"shape":"MultipartUpload"}, + "flattened":true + }, + "NextKeyMarker":{"type":"string"}, + "NextMarker":{"type":"string"}, + "NextPartNumberMarker":{"type":"integer"}, + "NextToken":{"type":"string"}, + "NextUploadIdMarker":{"type":"string"}, + "NextVersionIdMarker":{"type":"string"}, + "NoSuchBucket":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified bucket does not exist.

    ", + "exception":true + }, + "NoSuchKey":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified key does not exist.

    ", + "exception":true + }, + "NoSuchUpload":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified multipart upload does not exist.

    ", + "exception":true + }, + "NoncurrentVersionExpiration":{ + "type":"structure", + "members":{ + "NoncurrentDays":{ + "shape":"Days", + "documentation":"

    Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

    " + } + }, + "documentation":"

    Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.

    " + }, + "NoncurrentVersionTransition":{ + "type":"structure", + "members":{ + "NoncurrentDays":{ + "shape":"Days", + "documentation":"

    Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.

    " + }, + "StorageClass":{ + "shape":"TransitionStorageClass", + "documentation":"

    The class of storage used to store the object.

    " + } + }, + "documentation":"

    Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object's lifetime.

    " + }, + "NoncurrentVersionTransitionList":{ + "type":"list", + "member":{"shape":"NoncurrentVersionTransition"}, + "flattened":true + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "TopicConfigurations":{ + "shape":"TopicConfigurationList", + "documentation":"

    The topic to which notifications are sent and the events for which notifications are generated.

    ", + "locationName":"TopicConfiguration" + }, + "QueueConfigurations":{ + "shape":"QueueConfigurationList", + "documentation":"

    The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

    ", + "locationName":"QueueConfiguration" + }, + "LambdaFunctionConfigurations":{ + "shape":"LambdaFunctionConfigurationList", + "documentation":"

    Describes the AWS Lambda functions to invoke and the events for which to invoke them.

    ", + "locationName":"CloudFunctionConfiguration" + } + }, + "documentation":"

    A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

    " + }, + "NotificationConfigurationDeprecated":{ + "type":"structure", + "members":{ + "TopicConfiguration":{ + "shape":"TopicConfigurationDeprecated", + "documentation":"

    " + }, + "QueueConfiguration":{ + "shape":"QueueConfigurationDeprecated", + "documentation":"

    " + }, + "CloudFunctionConfiguration":{ + "shape":"CloudFunctionConfiguration", + "documentation":"

    " + } + } + }, + "NotificationConfigurationFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"S3KeyFilter", + "documentation":"

    ", + "locationName":"S3Key" + } + }, + "documentation":"

    Specifies object key name filtering rules. For information about key name filtering, see Configuring Event Notifications in the Amazon Simple Storage Service Developer Guide.

    " + }, + "NotificationId":{ + "type":"string", + "documentation":"

    An optional unique identifier for configurations in a notification configuration. If you don't provide one, Amazon S3 will assign an ID.

    " + }, + "Object":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    " + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    " + }, + "StorageClass":{ + "shape":"ObjectStorageClass", + "documentation":"

    The class of storage used to store the object.

    " + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "ObjectAlreadyInActiveTierError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    This operation is not allowed against this storage tier

    ", + "exception":true + }, + "ObjectCannedACL":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read", + "aws-exec-read", + "bucket-owner-read", + "bucket-owner-full-control" + ] + }, + "ObjectIdentifier":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Key name of the object to delete.

    " + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId for the specific version of the object to delete.

    " + } + }, + "documentation":"

    " + }, + "ObjectIdentifierList":{ + "type":"list", + "member":{"shape":"ObjectIdentifier"}, + "flattened":true + }, + "ObjectKey":{ + "type":"string", + "min":1 + }, + "ObjectList":{ + "type":"list", + "member":{"shape":"Object"}, + "flattened":true + }, + "ObjectLockConfiguration":{ + "type":"structure", + "members":{ + "ObjectLockEnabled":{ + "shape":"ObjectLockEnabled", + "documentation":"

    Indicates whether this bucket has an object lock configuration enabled.

    " + }, + "Rule":{ + "shape":"ObjectLockRule", + "documentation":"

    The object lock rule in place for the specified object.

    " + } + }, + "documentation":"

    The container element for object lock configuration parameters.

    " + }, + "ObjectLockEnabled":{ + "type":"string", + "enum":["Enabled"] + }, + "ObjectLockEnabledForBucket":{"type":"boolean"}, + "ObjectLockLegalHold":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    Indicates whether the specified object has a Legal Hold in place.

    " + } + }, + "documentation":"

    A Legal Hold configuration for an object.

    " + }, + "ObjectLockLegalHoldStatus":{ + "type":"string", + "enum":[ + "ON", + "OFF" + ] + }, + "ObjectLockMode":{ + "type":"string", + "enum":[ + "GOVERNANCE", + "COMPLIANCE" + ] + }, + "ObjectLockRetainUntilDate":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "ObjectLockRetention":{ + "type":"structure", + "members":{ + "Mode":{ + "shape":"ObjectLockRetentionMode", + "documentation":"

    Indicates the Retention mode for the specified object.

    " + }, + "RetainUntilDate":{ + "shape":"Date", + "documentation":"

    The date on which this object lock retention expires.

    " + } + }, + "documentation":"

    A Retention configuration for an object.

    " + }, + "ObjectLockRetentionMode":{ + "type":"string", + "enum":[ + "GOVERNANCE", + "COMPLIANCE" + ] + }, + "ObjectLockRule":{ + "type":"structure", + "members":{ + "DefaultRetention":{ + "shape":"DefaultRetention", + "documentation":"

    The default retention period that you want to apply to new objects placed in the specified bucket.

    " + } + }, + "documentation":"

    The container element for an object lock rule.

    " + }, + "ObjectLockToken":{"type":"string"}, + "ObjectNotInActiveTierError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The source object of the COPY operation is not in the active tier and is only stored in Amazon Glacier.

    ", + "exception":true + }, + "ObjectStorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "GLACIER", + "STANDARD_IA", + "ONEZONE_IA", + "INTELLIGENT_TIERING", + "DEEP_ARCHIVE" + ] + }, + "ObjectVersion":{ + "type":"structure", + "members":{ + "ETag":{ + "shape":"ETag", + "documentation":"

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    Size in bytes of the object.

    " + }, + "StorageClass":{ + "shape":"ObjectVersionStorageClass", + "documentation":"

    The class of storage used to store the object.

    " + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The object key.

    " + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version ID of an object.

    " + }, + "IsLatest":{ + "shape":"IsLatest", + "documentation":"

    Specifies whether the object is (true) or is not (false) the latest version of an object.

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Date and time the object was last modified.

    " + }, + "Owner":{ + "shape":"Owner", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "ObjectVersionId":{"type":"string"}, + "ObjectVersionList":{ + "type":"list", + "member":{"shape":"ObjectVersion"}, + "flattened":true + }, + "ObjectVersionStorageClass":{ + "type":"string", + "enum":["STANDARD"] + }, + "OutputLocation":{ + "type":"structure", + "members":{ + "S3":{ + "shape":"S3Location", + "documentation":"

    Describes an S3 location that will receive the results of the restore request.

    " + } + }, + "documentation":"

    Describes the location where the restore job's output is stored.

    " + }, + "OutputSerialization":{ + "type":"structure", + "members":{ + "CSV":{ + "shape":"CSVOutput", + "documentation":"

    Describes the serialization of CSV-encoded Select results.

    " + }, + "JSON":{ + "shape":"JSONOutput", + "documentation":"

    Specifies JSON as request's output serialization format.

    " + } + }, + "documentation":"

    Describes how results of the Select job are serialized.

    " + }, + "Owner":{ + "type":"structure", + "members":{ + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    " + }, + "ID":{ + "shape":"ID", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "OwnerOverride":{ + "type":"string", + "enum":["Destination"] + }, + "ParquetInput":{ + "type":"structure", + "members":{ + }, + "documentation":"

    " + }, + "Part":{ + "type":"structure", + "members":{ + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number identifying the part. This is a positive integer between 1 and 10,000.

    " + }, + "LastModified":{ + "shape":"LastModified", + "documentation":"

    Date and time at which the part was uploaded.

    " + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag returned when the part was uploaded.

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    Size in bytes of the uploaded part data.

    " + } + }, + "documentation":"

    " + }, + "PartNumber":{"type":"integer"}, + "PartNumberMarker":{"type":"integer"}, + "Parts":{ + "type":"list", + "member":{"shape":"Part"}, + "flattened":true + }, + "PartsCount":{"type":"integer"}, + "Payer":{ + "type":"string", + "enum":[ + "Requester", + "BucketOwner" + ] + }, + "Permission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "WRITE", + "WRITE_ACP", + "READ", + "READ_ACP" + ] + }, + "Policy":{"type":"string"}, + "PolicyStatus":{ + "type":"structure", + "members":{ + "IsPublic":{ + "shape":"IsPublic", + "documentation":"

    The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

    ", + "locationName":"IsPublic" + } + }, + "documentation":"

    The container element for a bucket's policy status.

    " + }, + "Prefix":{"type":"string"}, + "Priority":{"type":"integer"}, + "Progress":{ + "type":"structure", + "members":{ + "BytesScanned":{ + "shape":"BytesScanned", + "documentation":"

    The current number of object bytes scanned.

    " + }, + "BytesProcessed":{ + "shape":"BytesProcessed", + "documentation":"

    The current number of uncompressed object bytes processed.

    " + }, + "BytesReturned":{ + "shape":"BytesReturned", + "documentation":"

    The current number of bytes of records payload data returned.

    " + } + }, + "documentation":"

    " + }, + "ProgressEvent":{ + "type":"structure", + "members":{ + "Details":{ + "shape":"Progress", + "documentation":"

    The Progress event details.

    ", + "eventpayload":true + } + }, + "documentation":"

    ", + "event":true + }, + "Protocol":{ + "type":"string", + "enum":[ + "http", + "https" + ] + }, + "PublicAccessBlockConfiguration":{ + "type":"structure", + "members":{ + "BlockPublicAcls":{ + "shape":"Setting", + "documentation":"

    Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

    • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.

    • PUT Object calls fail if the request includes a public ACL.

    Enabling this setting doesn't affect existing policies or ACLs.

    ", + "locationName":"BlockPublicAcls" + }, + "IgnorePublicAcls":{ + "shape":"Setting", + "documentation":"

    Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

    Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.

    ", + "locationName":"IgnorePublicAcls" + }, + "BlockPublicPolicy":{ + "shape":"Setting", + "documentation":"

    Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

    Enabling this setting doesn't affect existing bucket policies.

    ", + "locationName":"BlockPublicPolicy" + }, + "RestrictPublicBuckets":{ + "shape":"Setting", + "documentation":"

    Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy.

    Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

    ", + "locationName":"RestrictPublicBuckets" + } + }, + "documentation":"

    Specifies the Block Public Access configuration for an Amazon S3 bucket.

    " + }, + "PutBucketAccelerateConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "AccelerateConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket for which the accelerate configuration is set.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "AccelerateConfiguration":{ + "shape":"AccelerateConfiguration", + "documentation":"

    Specifies the Accelerate Configuration you want to set for the bucket.

    ", + "locationName":"AccelerateConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"AccelerateConfiguration" + }, + "PutBucketAclRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "ACL":{ + "shape":"BucketCannedACL", + "documentation":"

    The canned ACL to apply to the bucket.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "documentation":"

    Contains the elements that set the ACL permissions for an object per grantee.

    ", + "locationName":"AccessControlPolicy", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to list the objects in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the bucket ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "documentation":"

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + } + }, + "payload":"AccessControlPolicy" + }, + "PutBucketAnalyticsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id", + "AnalyticsConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket to which an analytics configuration is stored.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"AnalyticsId", + "documentation":"

    The ID that identifies the analytics configuration.

    ", + "location":"querystring", + "locationName":"id" + }, + "AnalyticsConfiguration":{ + "shape":"AnalyticsConfiguration", + "documentation":"

    The configuration and any analyses for the analytics filter.

    ", + "locationName":"AnalyticsConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"AnalyticsConfiguration" + }, + "PutBucketCorsRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CORSConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CORSConfiguration":{ + "shape":"CORSConfiguration", + "documentation":"

    ", + "locationName":"CORSConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"CORSConfiguration" + }, + "PutBucketEncryptionRequest":{ + "type":"structure", + "required":[ + "Bucket", + "ServerSideEncryptionConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS-managed keys (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The base64-encoded 128-bit MD5 digest of the server-side encryption configuration. This parameter is auto-populated when using the command from the CLI.

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "ServerSideEncryptionConfiguration":{ + "shape":"ServerSideEncryptionConfiguration", + "documentation":"

    ", + "locationName":"ServerSideEncryptionConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"ServerSideEncryptionConfiguration" + }, + "PutBucketInventoryConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id", + "InventoryConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket where the inventory configuration will be stored.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"InventoryId", + "documentation":"

    The ID used to identify the inventory configuration.

    ", + "location":"querystring", + "locationName":"id" + }, + "InventoryConfiguration":{ + "shape":"InventoryConfiguration", + "documentation":"

    Specifies the inventory configuration.

    ", + "locationName":"InventoryConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"InventoryConfiguration" + }, + "PutBucketLifecycleConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "LifecycleConfiguration":{ + "shape":"BucketLifecycleConfiguration", + "documentation":"

    ", + "locationName":"LifecycleConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"LifecycleConfiguration" + }, + "PutBucketLifecycleRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "LifecycleConfiguration":{ + "shape":"LifecycleConfiguration", + "documentation":"

    ", + "locationName":"LifecycleConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"LifecycleConfiguration" + }, + "PutBucketLoggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "BucketLoggingStatus" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "BucketLoggingStatus":{ + "shape":"BucketLoggingStatus", + "documentation":"

    ", + "locationName":"BucketLoggingStatus", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"BucketLoggingStatus" + }, + "PutBucketMetricsConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Id", + "MetricsConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket for which the metrics configuration is set.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Id":{ + "shape":"MetricsId", + "documentation":"

    The ID used to identify the metrics configuration.

    ", + "location":"querystring", + "locationName":"id" + }, + "MetricsConfiguration":{ + "shape":"MetricsConfiguration", + "documentation":"

    Specifies the metrics configuration.

    ", + "locationName":"MetricsConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"MetricsConfiguration" + }, + "PutBucketNotificationConfigurationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "NotificationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

    ", + "locationName":"NotificationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"NotificationConfiguration" + }, + "PutBucketNotificationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "NotificationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "NotificationConfiguration":{ + "shape":"NotificationConfigurationDeprecated", + "documentation":"

    ", + "locationName":"NotificationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"NotificationConfiguration" + }, + "PutBucketPolicyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Policy" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "ConfirmRemoveSelfBucketAccess":{ + "shape":"ConfirmRemoveSelfBucketAccess", + "documentation":"

    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

    ", + "location":"header", + "locationName":"x-amz-confirm-remove-self-bucket-access" + }, + "Policy":{ + "shape":"Policy", + "documentation":"

    The bucket policy as a JSON document.

    " + } + }, + "payload":"Policy" + }, + "PutBucketReplicationRequest":{ + "type":"structure", + "required":[ + "Bucket", + "ReplicationConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit.

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "ReplicationConfiguration":{ + "shape":"ReplicationConfiguration", + "documentation":"

    ", + "locationName":"ReplicationConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "Token":{ + "shape":"ObjectLockToken", + "documentation":"

    A token that allows Amazon S3 object lock to be enabled for an existing bucket.

    ", + "location":"header", + "locationName":"x-amz-bucket-object-lock-token" + } + }, + "payload":"ReplicationConfiguration" + }, + "PutBucketRequestPaymentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "RequestPaymentConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "RequestPaymentConfiguration":{ + "shape":"RequestPaymentConfiguration", + "documentation":"

    ", + "locationName":"RequestPaymentConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"RequestPaymentConfiguration" + }, + "PutBucketTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Tagging" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "Tagging":{ + "shape":"Tagging", + "documentation":"

    ", + "locationName":"Tagging", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"Tagging" + }, + "PutBucketVersioningRequest":{ + "type":"structure", + "required":[ + "Bucket", + "VersioningConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "MFA":{ + "shape":"MFA", + "documentation":"

    The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

    ", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersioningConfiguration":{ + "shape":"VersioningConfiguration", + "documentation":"

    ", + "locationName":"VersioningConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"VersioningConfiguration" + }, + "PutBucketWebsiteRequest":{ + "type":"structure", + "required":[ + "Bucket", + "WebsiteConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "WebsiteConfiguration":{ + "shape":"WebsiteConfiguration", + "documentation":"

    ", + "locationName":"WebsiteConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"WebsiteConfiguration" + }, + "PutObjectAclOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectAclRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "documentation":"

    The canned ACL to apply to the object.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "AccessControlPolicy":{ + "shape":"AccessControlPolicy", + "documentation":"

    Contains the elements that set the ACL permissions for an object per grantee.

    ", + "locationName":"AccessControlPolicy", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to list the objects in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the bucket ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWrite":{ + "shape":"GrantWrite", + "documentation":"

    Allows grantee to create, overwrite, and delete any object in the bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable bucket.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    VersionId used to reference a specific version of the object.

    ", + "location":"querystring", + "locationName":"versionId" + } + }, + "payload":"AccessControlPolicy" + }, + "PutObjectLegalHoldOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectLegalHoldRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket containing the object that you want to place a Legal Hold on.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The key name for the object that you want to place a Legal Hold on.

    ", + "location":"uri", + "locationName":"Key" + }, + "LegalHold":{ + "shape":"ObjectLockLegalHold", + "documentation":"

    Container element for the Legal Hold configuration you want to apply to the specified object.

    ", + "locationName":"LegalHold", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The version ID of the object that you want to place a Legal Hold on.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The MD5 hash for the request body.

    ", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"LegalHold" + }, + "PutObjectLockConfigurationOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectLockConfigurationRequest":{ + "type":"structure", + "required":["Bucket"], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket whose object lock configuration you want to create or replace.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ObjectLockConfiguration":{ + "shape":"ObjectLockConfiguration", + "documentation":"

    The object lock configuration that you want to apply to the specified bucket.

    ", + "locationName":"ObjectLockConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "Token":{ + "shape":"ObjectLockToken", + "documentation":"

    A token to allow Amazon S3 object lock to be enabled for an existing bucket.

    ", + "location":"header", + "locationName":"x-amz-bucket-object-lock-token" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The MD5 hash for the request body.

    ", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"ObjectLockConfiguration" + }, + "PutObjectOutput":{ + "type":"structure", + "members":{ + "Expiration":{ + "shape":"Expiration", + "documentation":"

    If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.

    ", + "location":"header", + "locationName":"x-amz-expiration" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag for the uploaded object.

    ", + "location":"header", + "locationName":"ETag" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    Version of the object.

    ", + "location":"header", + "locationName":"x-amz-version-id" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "ACL":{ + "shape":"ObjectCannedACL", + "documentation":"

    The canned ACL to apply to the object.

    ", + "location":"header", + "locationName":"x-amz-acl" + }, + "Body":{ + "shape":"Body", + "documentation":"

    Object data.

    ", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the PUT operation was initiated.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CacheControl":{ + "shape":"CacheControl", + "documentation":"

    Specifies caching behavior along the request/reply chain.

    ", + "location":"header", + "locationName":"Cache-Control" + }, + "ContentDisposition":{ + "shape":"ContentDisposition", + "documentation":"

    Specifies presentational information for the object.

    ", + "location":"header", + "locationName":"Content-Disposition" + }, + "ContentEncoding":{ + "shape":"ContentEncoding", + "documentation":"

    Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

    ", + "location":"header", + "locationName":"Content-Encoding" + }, + "ContentLanguage":{ + "shape":"ContentLanguage", + "documentation":"

    The language the content is in.

    ", + "location":"header", + "locationName":"Content-Language" + }, + "ContentLength":{ + "shape":"ContentLength", + "documentation":"

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    ", + "location":"header", + "locationName":"Content-Length" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    A standard MIME type describing the format of the object data.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "Expires":{ + "shape":"Expires", + "documentation":"

    The date and time at which the object is no longer cacheable.

    ", + "location":"header", + "locationName":"Expires" + }, + "GrantFullControl":{ + "shape":"GrantFullControl", + "documentation":"

    Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

    ", + "location":"header", + "locationName":"x-amz-grant-full-control" + }, + "GrantRead":{ + "shape":"GrantRead", + "documentation":"

    Allows grantee to read the object data and its metadata.

    ", + "location":"header", + "locationName":"x-amz-grant-read" + }, + "GrantReadACP":{ + "shape":"GrantReadACP", + "documentation":"

    Allows grantee to read the object ACL.

    ", + "location":"header", + "locationName":"x-amz-grant-read-acp" + }, + "GrantWriteACP":{ + "shape":"GrantWriteACP", + "documentation":"

    Allows grantee to write the ACL for the applicable object.

    ", + "location":"header", + "locationName":"x-amz-grant-write-acp" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Object key for which the PUT operation was initiated.

    ", + "location":"uri", + "locationName":"Key" + }, + "Metadata":{ + "shape":"Metadata", + "documentation":"

    A map of metadata to store with the object in S3.

    ", + "location":"headers", + "locationName":"x-amz-meta-" + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The type of storage to use for the object. Defaults to 'STANDARD'.

    ", + "location":"header", + "locationName":"x-amz-storage-class" + }, + "WebsiteRedirectLocation":{ + "shape":"WebsiteRedirectLocation", + "documentation":"

    If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

    ", + "location":"header", + "locationName":"x-amz-website-redirect-location" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "SSEKMSEncryptionContext":{ + "shape":"SSEKMSEncryptionContext", + "documentation":"

    Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-context" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "Tagging":{ + "shape":"TaggingHeader", + "documentation":"

    The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")

    ", + "location":"header", + "locationName":"x-amz-tagging" + }, + "ObjectLockMode":{ + "shape":"ObjectLockMode", + "documentation":"

    The object lock mode that you want to apply to this object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-mode" + }, + "ObjectLockRetainUntilDate":{ + "shape":"ObjectLockRetainUntilDate", + "documentation":"

    The date and time when you want this object's object lock to expire.

    ", + "location":"header", + "locationName":"x-amz-object-lock-retain-until-date" + }, + "ObjectLockLegalHoldStatus":{ + "shape":"ObjectLockLegalHoldStatus", + "documentation":"

    The Legal Hold status that you want to apply to the specified object.

    ", + "location":"header", + "locationName":"x-amz-object-lock-legal-hold" + } + }, + "payload":"Body" + }, + "PutObjectRetentionOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "PutObjectRetentionRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The bucket that contains the object you want to apply this Object Retention configuration to.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The key name for the object that you want to apply this Object Retention configuration to.

    ", + "location":"uri", + "locationName":"Key" + }, + "Retention":{ + "shape":"ObjectLockRetention", + "documentation":"

    The container element for the Object Retention configuration.

    ", + "locationName":"Retention", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    The version ID for the object that you want to apply this Object Retention configuration to.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "BypassGovernanceRetention":{ + "shape":"BypassGovernanceRetention", + "documentation":"

    Indicates whether this operation should bypass Governance-mode restrictions.j

    ", + "location":"header", + "locationName":"x-amz-bypass-governance-retention" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The MD5 hash for the request body.

    ", + "location":"header", + "locationName":"Content-MD5" + } + }, + "payload":"Retention" + }, + "PutObjectTaggingOutput":{ + "type":"structure", + "members":{ + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-version-id" + } + } + }, + "PutObjectTaggingRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "Tagging" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    ", + "location":"querystring", + "locationName":"versionId" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "Tagging":{ + "shape":"Tagging", + "documentation":"

    ", + "locationName":"Tagging", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"Tagging" + }, + "PutPublicAccessBlockRequest":{ + "type":"structure", + "required":[ + "Bucket", + "PublicAccessBlockConfiguration" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The MD5 hash of the PutPublicAccessBlock request body.

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "PublicAccessBlockConfiguration":{ + "shape":"PublicAccessBlockConfiguration", + "documentation":"

    The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.

    ", + "locationName":"PublicAccessBlockConfiguration", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + } + }, + "payload":"PublicAccessBlockConfiguration" + }, + "QueueArn":{"type":"string"}, + "QueueConfiguration":{ + "type":"structure", + "required":[ + "QueueArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "QueueArn":{ + "shape":"QueueArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

    ", + "locationName":"Queue" + }, + "Events":{ + "shape":"EventList", + "documentation":"

    ", + "locationName":"Event" + }, + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

    " + } + }, + "documentation":"

    Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

    " + }, + "QueueConfigurationDeprecated":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Event":{ + "shape":"Event", + "deprecated":true + }, + "Events":{ + "shape":"EventList", + "documentation":"

    ", + "locationName":"Event" + }, + "Queue":{ + "shape":"QueueArn", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "QueueConfigurationList":{ + "type":"list", + "member":{"shape":"QueueConfiguration"}, + "flattened":true + }, + "Quiet":{"type":"boolean"}, + "QuoteCharacter":{"type":"string"}, + "QuoteEscapeCharacter":{"type":"string"}, + "QuoteFields":{ + "type":"string", + "enum":[ + "ALWAYS", + "ASNEEDED" + ] + }, + "Range":{"type":"string"}, + "RecordDelimiter":{"type":"string"}, + "RecordsEvent":{ + "type":"structure", + "members":{ + "Payload":{ + "shape":"Body", + "documentation":"

    The byte array of partial, one or more result records.

    ", + "eventpayload":true + } + }, + "documentation":"

    ", + "event":true + }, + "Redirect":{ + "type":"structure", + "members":{ + "HostName":{ + "shape":"HostName", + "documentation":"

    The host name to use in the redirect request.

    " + }, + "HttpRedirectCode":{ + "shape":"HttpRedirectCode", + "documentation":"

    The HTTP redirect code to use on the response. Not required if one of the siblings is present.

    " + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"

    Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

    " + }, + "ReplaceKeyPrefixWith":{ + "shape":"ReplaceKeyPrefixWith", + "documentation":"

    The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

    " + }, + "ReplaceKeyWith":{ + "shape":"ReplaceKeyWith", + "documentation":"

    The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

    " + } + }, + "documentation":"

    Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

    " + }, + "RedirectAllRequestsTo":{ + "type":"structure", + "required":["HostName"], + "members":{ + "HostName":{ + "shape":"HostName", + "documentation":"

    Name of the host where requests are redirected.

    " + }, + "Protocol":{ + "shape":"Protocol", + "documentation":"

    Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

    " + } + }, + "documentation":"

    Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

    " + }, + "ReplaceKeyPrefixWith":{"type":"string"}, + "ReplaceKeyWith":{"type":"string"}, + "ReplicaKmsKeyID":{"type":"string"}, + "ReplicationConfiguration":{ + "type":"structure", + "required":[ + "Role", + "Rules" + ], + "members":{ + "Role":{ + "shape":"Role", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Cross-Region Replication in the Amazon Simple Storage Service Developer Guide.

    " + }, + "Rules":{ + "shape":"ReplicationRules", + "documentation":"

    A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

    ", + "locationName":"Rule" + } + }, + "documentation":"

    A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

    " + }, + "ReplicationRule":{ + "type":"structure", + "required":[ + "Status", + "Destination" + ], + "members":{ + "ID":{ + "shape":"ID", + "documentation":"

    A unique identifier for the rule. The maximum value is 255 characters.

    " + }, + "Priority":{ + "shape":"Priority", + "documentation":"

    The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:

    • Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap

    • Same object qualify tag based filter criteria specified in multiple rules

    For more information, see Cross-Region Replication (CRR) in the Amazon S3 Developer Guide.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.

    ", + "deprecated":true + }, + "Filter":{ + "shape":"ReplicationRuleFilter", + "documentation":"

    " + }, + "Status":{ + "shape":"ReplicationRuleStatus", + "documentation":"

    Specifies whether the rule is enabled.

    " + }, + "SourceSelectionCriteria":{ + "shape":"SourceSelectionCriteria", + "documentation":"

    A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS).

    " + }, + "Destination":{ + "shape":"Destination", + "documentation":"

    A container for information about the replication destination.

    " + }, + "DeleteMarkerReplication":{ + "shape":"DeleteMarkerReplication", + "documentation":"

    " + } + }, + "documentation":"

    Specifies which Amazon S3 objects to replicate and where to store the replicas.

    " + }, + "ReplicationRuleAndOperator":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    " + }, + "Tags":{ + "shape":"TagSet", + "documentation":"

    ", + "flattened":true, + "locationName":"Tag" + } + }, + "documentation":"

    " + }, + "ReplicationRuleFilter":{ + "type":"structure", + "members":{ + "Prefix":{ + "shape":"Prefix", + "documentation":"

    An object keyname prefix that identifies the subset of objects to which the rule applies.

    " + }, + "Tag":{ + "shape":"Tag", + "documentation":"

    A container for specifying a tag key and value.

    The rule applies only to objects that have the tag in their tag set.

    " + }, + "And":{ + "shape":"ReplicationRuleAndOperator", + "documentation":"

    A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example:

    • If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.

    • If you specify a filter based on multiple tags, wrap the Tag elements in an And tag.

    " + } + }, + "documentation":"

    A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

    " + }, + "ReplicationRuleStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "ReplicationRules":{ + "type":"list", + "member":{"shape":"ReplicationRule"}, + "flattened":true + }, + "ReplicationStatus":{ + "type":"string", + "enum":[ + "COMPLETE", + "PENDING", + "FAILED", + "REPLICA" + ] + }, + "RequestCharged":{ + "type":"string", + "documentation":"

    If present, indicates that the requester was successfully charged for the request.

    ", + "enum":["requester"] + }, + "RequestPayer":{ + "type":"string", + "documentation":"

    Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

    ", + "enum":["requester"] + }, + "RequestPaymentConfiguration":{ + "type":"structure", + "required":["Payer"], + "members":{ + "Payer":{ + "shape":"Payer", + "documentation":"

    Specifies who pays for the download and request fees.

    " + } + }, + "documentation":"

    " + }, + "RequestProgress":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"EnableRequestProgress", + "documentation":"

    Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.

    " + } + }, + "documentation":"

    " + }, + "ResponseCacheControl":{"type":"string"}, + "ResponseContentDisposition":{"type":"string"}, + "ResponseContentEncoding":{"type":"string"}, + "ResponseContentLanguage":{"type":"string"}, + "ResponseContentType":{"type":"string"}, + "ResponseExpires":{"type":"timestamp"}, + "Restore":{"type":"string"}, + "RestoreObjectOutput":{ + "type":"structure", + "members":{ + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + }, + "RestoreOutputPath":{ + "shape":"RestoreOutputPath", + "documentation":"

    Indicates the path in the provided S3 output location where Select results will be restored to.

    ", + "location":"header", + "locationName":"x-amz-restore-output-path" + } + } + }, + "RestoreObjectRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "VersionId":{ + "shape":"ObjectVersionId", + "documentation":"

    ", + "location":"querystring", + "locationName":"versionId" + }, + "RestoreRequest":{ + "shape":"RestoreRequest", + "documentation":"

    ", + "locationName":"RestoreRequest", + "xmlNamespace":{"uri":"http://s3.amazonaws.com/doc/2006-03-01/"} + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"RestoreRequest" + }, + "RestoreOutputPath":{"type":"string"}, + "RestoreRequest":{ + "type":"structure", + "members":{ + "Days":{ + "shape":"Days", + "documentation":"

    Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

    " + }, + "GlacierJobParameters":{ + "shape":"GlacierJobParameters", + "documentation":"

    Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

    " + }, + "Type":{ + "shape":"RestoreRequestType", + "documentation":"

    Type of restore request.

    " + }, + "Tier":{ + "shape":"Tier", + "documentation":"

    Glacier retrieval tier at which the restore will be processed.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The optional description for the job.

    " + }, + "SelectParameters":{ + "shape":"SelectParameters", + "documentation":"

    Describes the parameters for Select job types.

    " + }, + "OutputLocation":{ + "shape":"OutputLocation", + "documentation":"

    Describes the location where the restore job's output is stored.

    " + } + }, + "documentation":"

    Container for restore job parameters.

    " + }, + "RestoreRequestType":{ + "type":"string", + "enum":["SELECT"] + }, + "Role":{"type":"string"}, + "RoutingRule":{ + "type":"structure", + "required":["Redirect"], + "members":{ + "Condition":{ + "shape":"Condition", + "documentation":"

    A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs folder, redirect to the /documents folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.

    " + }, + "Redirect":{ + "shape":"Redirect", + "documentation":"

    Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

    " + } + }, + "documentation":"

    Specifies the redirect behavior and when a redirect is applied.

    " + }, + "RoutingRules":{ + "type":"list", + "member":{ + "shape":"RoutingRule", + "locationName":"RoutingRule" + } + }, + "Rule":{ + "type":"structure", + "required":[ + "Prefix", + "Status" + ], + "members":{ + "Expiration":{ + "shape":"LifecycleExpiration", + "documentation":"

    " + }, + "ID":{ + "shape":"ID", + "documentation":"

    Unique identifier for the rule. The value can't be longer than 255 characters.

    " + }, + "Prefix":{ + "shape":"Prefix", + "documentation":"

    Object key prefix that identifies one or more objects to which this rule applies.

    " + }, + "Status":{ + "shape":"ExpirationStatus", + "documentation":"

    If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

    " + }, + "Transition":{ + "shape":"Transition", + "documentation":"

    " + }, + "NoncurrentVersionTransition":{ + "shape":"NoncurrentVersionTransition", + "documentation":"

    " + }, + "NoncurrentVersionExpiration":{ + "shape":"NoncurrentVersionExpiration", + "documentation":"

    " + }, + "AbortIncompleteMultipartUpload":{ + "shape":"AbortIncompleteMultipartUpload", + "documentation":"

    " + } + }, + "documentation":"

    Specifies lifecycle rules for an Amazon S3 bucket. For more information, see PUT Bucket lifecycle in the Amazon Simple Storage Service API Reference.

    " + }, + "Rules":{ + "type":"list", + "member":{"shape":"Rule"}, + "flattened":true + }, + "S3KeyFilter":{ + "type":"structure", + "members":{ + "FilterRules":{ + "shape":"FilterRuleList", + "documentation":"

    ", + "locationName":"FilterRule" + } + }, + "documentation":"

    A container for object key name prefix and suffix filtering rules.

    " + }, + "S3Location":{ + "type":"structure", + "required":[ + "BucketName", + "Prefix" + ], + "members":{ + "BucketName":{ + "shape":"BucketName", + "documentation":"

    The name of the bucket where the restore results will be placed.

    " + }, + "Prefix":{ + "shape":"LocationPrefix", + "documentation":"

    The prefix that is prepended to the restore results for this request.

    " + }, + "Encryption":{ + "shape":"Encryption", + "documentation":"

    " + }, + "CannedACL":{ + "shape":"ObjectCannedACL", + "documentation":"

    The canned ACL to apply to the restore results.

    " + }, + "AccessControlList":{ + "shape":"Grants", + "documentation":"

    A list of grants that control access to the staged results.

    " + }, + "Tagging":{ + "shape":"Tagging", + "documentation":"

    The tag-set that is applied to the restore results.

    " + }, + "UserMetadata":{ + "shape":"UserMetadata", + "documentation":"

    A list of metadata to store with the restore results in S3.

    " + }, + "StorageClass":{ + "shape":"StorageClass", + "documentation":"

    The class of storage used to store the restore results.

    " + } + }, + "documentation":"

    Describes an S3 location that will receive the results of the restore request.

    " + }, + "SSECustomerAlgorithm":{"type":"string"}, + "SSECustomerKey":{ + "type":"string", + "sensitive":true + }, + "SSECustomerKeyMD5":{"type":"string"}, + "SSEKMS":{ + "type":"structure", + "required":["KeyId"], + "members":{ + "KeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    Specifies the ID of the AWS Key Management Service (KMS) master encryption key to use for encrypting Inventory reports.

    " + } + }, + "documentation":"

    Specifies the use of SSE-KMS to encrypt delivered Inventory reports.

    ", + "locationName":"SSE-KMS" + }, + "SSEKMSEncryptionContext":{ + "type":"string", + "sensitive":true + }, + "SSEKMSKeyId":{ + "type":"string", + "sensitive":true + }, + "SSES3":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Specifies the use of SSE-S3 to encrypt delivered Inventory reports.

    ", + "locationName":"SSE-S3" + }, + "ScanRange":{ + "type":"structure", + "members":{ + "Start":{ + "shape":"Start", + "documentation":"

    Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0.

    " + }, + "End":{ + "shape":"End", + "documentation":"

    Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried.

    " + } + } + }, + "SelectObjectContentEventStream":{ + "type":"structure", + "members":{ + "Records":{ + "shape":"RecordsEvent", + "documentation":"

    The Records Event.

    " + }, + "Stats":{ + "shape":"StatsEvent", + "documentation":"

    The Stats Event.

    " + }, + "Progress":{ + "shape":"ProgressEvent", + "documentation":"

    The Progress Event.

    " + }, + "Cont":{ + "shape":"ContinuationEvent", + "documentation":"

    The Continuation Event.

    " + }, + "End":{ + "shape":"EndEvent", + "documentation":"

    The End Event.

    " + } + }, + "documentation":"

    ", + "eventstream":true + }, + "SelectObjectContentOutput":{ + "type":"structure", + "members":{ + "Payload":{ + "shape":"SelectObjectContentEventStream", + "documentation":"

    " + } + }, + "payload":"Payload" + }, + "SelectObjectContentRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "Expression", + "ExpressionType", + "InputSerialization", + "OutputSerialization" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    The S3 bucket.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    The object key.

    ", + "location":"uri", + "locationName":"Key" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "Expression":{ + "shape":"Expression", + "documentation":"

    The expression that is used to query the object.

    " + }, + "ExpressionType":{ + "shape":"ExpressionType", + "documentation":"

    The type of the provided expression (for example., SQL).

    " + }, + "RequestProgress":{ + "shape":"RequestProgress", + "documentation":"

    Specifies if periodic request progress information should be enabled.

    " + }, + "InputSerialization":{ + "shape":"InputSerialization", + "documentation":"

    Describes the format of the data in the object that is being queried.

    " + }, + "OutputSerialization":{ + "shape":"OutputSerialization", + "documentation":"

    Describes the format of the data that you want Amazon S3 to return in response.

    " + }, + "ScanRange":{ + "shape":"ScanRange", + "documentation":"

    Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

    " + } + }, + "documentation":"

    Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

    " + }, + "SelectParameters":{ + "type":"structure", + "required":[ + "InputSerialization", + "ExpressionType", + "Expression", + "OutputSerialization" + ], + "members":{ + "InputSerialization":{ + "shape":"InputSerialization", + "documentation":"

    Describes the serialization format of the object.

    " + }, + "ExpressionType":{ + "shape":"ExpressionType", + "documentation":"

    The type of the provided expression (e.g., SQL).

    " + }, + "Expression":{ + "shape":"Expression", + "documentation":"

    The expression that is used to query the object.

    " + }, + "OutputSerialization":{ + "shape":"OutputSerialization", + "documentation":"

    Describes how the results of the Select job are serialized.

    " + } + }, + "documentation":"

    Describes the parameters for Select job types.

    " + }, + "ServerSideEncryption":{ + "type":"string", + "enum":[ + "AES256", + "aws:kms" + ] + }, + "ServerSideEncryptionByDefault":{ + "type":"structure", + "required":["SSEAlgorithm"], + "members":{ + "SSEAlgorithm":{ + "shape":"ServerSideEncryption", + "documentation":"

    Server-side encryption algorithm to use for the default encryption.

    " + }, + "KMSMasterKeyID":{ + "shape":"SSEKMSKeyId", + "documentation":"

    KMS master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

    " + } + }, + "documentation":"

    Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption in the Amazon Simple Storage Service API Reference.

    " + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "required":["Rules"], + "members":{ + "Rules":{ + "shape":"ServerSideEncryptionRules", + "documentation":"

    Container for information about a particular server-side encryption configuration rule.

    ", + "locationName":"Rule" + } + }, + "documentation":"

    Specifies the default server-side-encryption configuration.

    " + }, + "ServerSideEncryptionRule":{ + "type":"structure", + "members":{ + "ApplyServerSideEncryptionByDefault":{ + "shape":"ServerSideEncryptionByDefault", + "documentation":"

    Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.

    " + } + }, + "documentation":"

    Specifies the default server-side encryption configuration.

    " + }, + "ServerSideEncryptionRules":{ + "type":"list", + "member":{"shape":"ServerSideEncryptionRule"}, + "flattened":true + }, + "Setting":{"type":"boolean"}, + "Size":{"type":"integer"}, + "SourceSelectionCriteria":{ + "type":"structure", + "members":{ + "SseKmsEncryptedObjects":{ + "shape":"SseKmsEncryptedObjects", + "documentation":"

    A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

    " + } + }, + "documentation":"

    A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using an AWS KMS-Managed Key (SSE-KMS).

    " + }, + "SseKmsEncryptedObjects":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"SseKmsEncryptedObjectsStatus", + "documentation":"

    Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS-managed key.

    " + } + }, + "documentation":"

    A container for filter information for the selection of S3 objects encrypted with AWS KMS.

    " + }, + "SseKmsEncryptedObjectsStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "Start":{"type":"long"}, + "StartAfter":{"type":"string"}, + "Stats":{ + "type":"structure", + "members":{ + "BytesScanned":{ + "shape":"BytesScanned", + "documentation":"

    The total number of object bytes scanned.

    " + }, + "BytesProcessed":{ + "shape":"BytesProcessed", + "documentation":"

    The total number of uncompressed object bytes processed.

    " + }, + "BytesReturned":{ + "shape":"BytesReturned", + "documentation":"

    The total number of bytes of records payload data returned.

    " + } + }, + "documentation":"

    " + }, + "StatsEvent":{ + "type":"structure", + "members":{ + "Details":{ + "shape":"Stats", + "documentation":"

    The Stats event details.

    ", + "eventpayload":true + } + }, + "documentation":"

    ", + "event":true + }, + "StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "REDUCED_REDUNDANCY", + "STANDARD_IA", + "ONEZONE_IA", + "INTELLIGENT_TIERING", + "GLACIER", + "DEEP_ARCHIVE" + ] + }, + "StorageClassAnalysis":{ + "type":"structure", + "members":{ + "DataExport":{ + "shape":"StorageClassAnalysisDataExport", + "documentation":"

    Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

    " + } + }, + "documentation":"

    Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

    " + }, + "StorageClassAnalysisDataExport":{ + "type":"structure", + "required":[ + "OutputSchemaVersion", + "Destination" + ], + "members":{ + "OutputSchemaVersion":{ + "shape":"StorageClassAnalysisSchemaVersion", + "documentation":"

    The version of the output schema to use when exporting data. Must be V_1.

    " + }, + "Destination":{ + "shape":"AnalyticsExportDestination", + "documentation":"

    The place to store the data for an analysis.

    " + } + }, + "documentation":"

    " + }, + "StorageClassAnalysisSchemaVersion":{ + "type":"string", + "enum":["V_1"] + }, + "Suffix":{"type":"string"}, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Name of the tag.

    " + }, + "Value":{ + "shape":"Value", + "documentation":"

    Value of the tag.

    " + } + }, + "documentation":"

    " + }, + "TagCount":{"type":"integer"}, + "TagSet":{ + "type":"list", + "member":{ + "shape":"Tag", + "locationName":"Tag" + } + }, + "Tagging":{ + "type":"structure", + "required":["TagSet"], + "members":{ + "TagSet":{ + "shape":"TagSet", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "TaggingDirective":{ + "type":"string", + "enum":[ + "COPY", + "REPLACE" + ] + }, + "TaggingHeader":{"type":"string"}, + "TargetBucket":{"type":"string"}, + "TargetGrant":{ + "type":"structure", + "members":{ + "Grantee":{ + "shape":"Grantee", + "documentation":"

    " + }, + "Permission":{ + "shape":"BucketLogsPermission", + "documentation":"

    Logging permissions assigned to the Grantee for the bucket.

    " + } + }, + "documentation":"

    " + }, + "TargetGrants":{ + "type":"list", + "member":{ + "shape":"TargetGrant", + "locationName":"Grant" + } + }, + "TargetPrefix":{"type":"string"}, + "Tier":{ + "type":"string", + "enum":[ + "Standard", + "Bulk", + "Expedited" + ] + }, + "Token":{"type":"string"}, + "TopicArn":{"type":"string"}, + "TopicConfiguration":{ + "type":"structure", + "required":[ + "TopicArn", + "Events" + ], + "members":{ + "Id":{"shape":"NotificationId"}, + "TopicArn":{ + "shape":"TopicArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

    ", + "locationName":"Topic" + }, + "Events":{ + "shape":"EventList", + "documentation":"

    The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon Simple Storage Service Developer Guide.

    ", + "locationName":"Event" + }, + "Filter":{ + "shape":"NotificationConfigurationFilter", + "documentation":"

    " + } + }, + "documentation":"

    A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.

    " + }, + "TopicConfigurationDeprecated":{ + "type":"structure", + "members":{ + "Id":{"shape":"NotificationId"}, + "Events":{ + "shape":"EventList", + "documentation":"

    ", + "locationName":"Event" + }, + "Event":{ + "shape":"Event", + "documentation":"

    Bucket event for which to send notifications.

    ", + "deprecated":true + }, + "Topic":{ + "shape":"TopicArn", + "documentation":"

    Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

    " + } + }, + "documentation":"

    " + }, + "TopicConfigurationList":{ + "type":"list", + "member":{"shape":"TopicConfiguration"}, + "flattened":true + }, + "Transition":{ + "type":"structure", + "members":{ + "Date":{ + "shape":"Date", + "documentation":"

    Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

    " + }, + "Days":{ + "shape":"Days", + "documentation":"

    Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

    " + }, + "StorageClass":{ + "shape":"TransitionStorageClass", + "documentation":"

    The storage class to which you want the object to transition.

    " + } + }, + "documentation":"

    Specifies when an object transitions to a specified storage class.

    " + }, + "TransitionList":{ + "type":"list", + "member":{"shape":"Transition"}, + "flattened":true + }, + "TransitionStorageClass":{ + "type":"string", + "enum":[ + "GLACIER", + "STANDARD_IA", + "ONEZONE_IA", + "INTELLIGENT_TIERING", + "DEEP_ARCHIVE" + ] + }, + "Type":{ + "type":"string", + "enum":[ + "CanonicalUser", + "AmazonCustomerByEmail", + "Group" + ] + }, + "URI":{"type":"string"}, + "UploadIdMarker":{"type":"string"}, + "UploadPartCopyOutput":{ + "type":"structure", + "members":{ + "CopySourceVersionId":{ + "shape":"CopySourceVersionId", + "documentation":"

    The version of the source object that was copied, if you have enabled versioning on the source bucket.

    ", + "location":"header", + "locationName":"x-amz-copy-source-version-id" + }, + "CopyPartResult":{ + "shape":"CopyPartResult", + "documentation":"

    " + }, + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + }, + "payload":"CopyPartResult" + }, + "UploadPartCopyRequest":{ + "type":"structure", + "required":[ + "Bucket", + "CopySource", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Bucket":{ + "shape":"BucketName", + "documentation":"

    ", + "location":"uri", + "locationName":"Bucket" + }, + "CopySource":{ + "shape":"CopySource", + "documentation":"

    The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

    ", + "location":"header", + "locationName":"x-amz-copy-source" + }, + "CopySourceIfMatch":{ + "shape":"CopySourceIfMatch", + "documentation":"

    Copies the object if its entity tag (ETag) matches the specified tag.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-match" + }, + "CopySourceIfModifiedSince":{ + "shape":"CopySourceIfModifiedSince", + "documentation":"

    Copies the object if it has been modified since the specified time.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-modified-since" + }, + "CopySourceIfNoneMatch":{ + "shape":"CopySourceIfNoneMatch", + "documentation":"

    Copies the object if its entity tag (ETag) is different than the specified ETag.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-none-match" + }, + "CopySourceIfUnmodifiedSince":{ + "shape":"CopySourceIfUnmodifiedSince", + "documentation":"

    Copies the object if it hasn't been modified since the specified time.

    ", + "location":"header", + "locationName":"x-amz-copy-source-if-unmodified-since" + }, + "CopySourceRange":{ + "shape":"CopySourceRange", + "documentation":"

    The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 MB.

    ", + "location":"header", + "locationName":"x-amz-copy-source-range" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    ", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number of part being copied. This is a positive integer between 1 and 10,000.

    ", + "location":"querystring", + "locationName":"partNumber" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID identifying the multipart upload whose part is being copied.

    ", + "location":"querystring", + "locationName":"uploadId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "CopySourceSSECustomerAlgorithm":{ + "shape":"CopySourceSSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use when decrypting the source object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-algorithm" + }, + "CopySourceSSECustomerKey":{ + "shape":"CopySourceSSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key" + }, + "CopySourceSSECustomerKeyMD5":{ + "shape":"CopySourceSSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-copy-source-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + } + }, + "UploadPartOutput":{ + "type":"structure", + "members":{ + "ServerSideEncryption":{ + "shape":"ServerSideEncryption", + "documentation":"

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption" + }, + "ETag":{ + "shape":"ETag", + "documentation":"

    Entity tag for the uploaded object.

    ", + "location":"header", + "locationName":"ETag" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "SSEKMSKeyId":{ + "shape":"SSEKMSKeyId", + "documentation":"

    If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-aws-kms-key-id" + }, + "RequestCharged":{ + "shape":"RequestCharged", + "location":"header", + "locationName":"x-amz-request-charged" + } + } + }, + "UploadPartRequest":{ + "type":"structure", + "required":[ + "Bucket", + "Key", + "PartNumber", + "UploadId" + ], + "members":{ + "Body":{ + "shape":"Body", + "documentation":"

    Object data.

    ", + "streaming":true + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

    Name of the bucket to which the multipart upload was initiated.

    ", + "location":"uri", + "locationName":"Bucket" + }, + "ContentLength":{ + "shape":"ContentLength", + "documentation":"

    Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

    ", + "location":"header", + "locationName":"Content-Length" + }, + "ContentMD5":{ + "shape":"ContentMD5", + "documentation":"

    The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.

    ", + "location":"header", + "locationName":"Content-MD5" + }, + "Key":{ + "shape":"ObjectKey", + "documentation":"

    Object key for which the multipart upload was initiated.

    ", + "location":"uri", + "locationName":"Key" + }, + "PartNumber":{ + "shape":"PartNumber", + "documentation":"

    Part number of part being uploaded. This is a positive integer between 1 and 10,000.

    ", + "location":"querystring", + "locationName":"partNumber" + }, + "UploadId":{ + "shape":"MultipartUploadId", + "documentation":"

    Upload ID identifying the multipart upload whose part is being uploaded.

    ", + "location":"querystring", + "locationName":"uploadId" + }, + "SSECustomerAlgorithm":{ + "shape":"SSECustomerAlgorithm", + "documentation":"

    Specifies the algorithm to use to when encrypting the object (e.g., AES256).

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-algorithm" + }, + "SSECustomerKey":{ + "shape":"SSECustomerKey", + "documentation":"

    Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key" + }, + "SSECustomerKeyMD5":{ + "shape":"SSECustomerKeyMD5", + "documentation":"

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.

    ", + "location":"header", + "locationName":"x-amz-server-side-encryption-customer-key-MD5" + }, + "RequestPayer":{ + "shape":"RequestPayer", + "location":"header", + "locationName":"x-amz-request-payer" + } + }, + "payload":"Body" + }, + "UserMetadata":{ + "type":"list", + "member":{ + "shape":"MetadataEntry", + "locationName":"MetadataEntry" + } + }, + "Value":{"type":"string"}, + "VersionIdMarker":{"type":"string"}, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "MFADelete":{ + "shape":"MFADelete", + "documentation":"

    Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.

    ", + "locationName":"MfaDelete" + }, + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"

    The versioning state of the bucket.

    " + } + }, + "documentation":"

    Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon Simple Storage Service API Reference.

    " + }, + "WebsiteConfiguration":{ + "type":"structure", + "members":{ + "ErrorDocument":{ + "shape":"ErrorDocument", + "documentation":"

    The name of the error document for the website.

    " + }, + "IndexDocument":{ + "shape":"IndexDocument", + "documentation":"

    The name of the index document for the website.

    " + }, + "RedirectAllRequestsTo":{ + "shape":"RedirectAllRequestsTo", + "documentation":"

    The redirect behavior for every request to this bucket's website endpoint.

    If you specify this property, you can't specify any other property.

    " + }, + "RoutingRules":{ + "shape":"RoutingRules", + "documentation":"

    Rules that define when a redirect is applied and the redirect behavior.

    " + } + }, + "documentation":"

    Specifies website configuration parameters for an Amazon S3 bucket.

    " + }, + "WebsiteRedirectLocation":{"type":"string"}, + "Years":{"type":"integer"} + }, + "documentation":"

    " +} diff --git a/aws/dist/botocore/data/s3/2006-03-01/waiters-2.json b/aws/dist/botocore/data/s3/2006-03-01/waiters-2.json new file mode 100644 index 00000000..b508a8f5 --- /dev/null +++ b/aws/dist/botocore/data/s3/2006-03-01/waiters-2.json @@ -0,0 +1,73 @@ +{ + "version": 2, + "waiters": { + "BucketExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 301, + "matcher": "status", + "state": "success" + }, + { + "expected": 403, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "BucketNotExists": { + "delay": 5, + "operation": "HeadBucket", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + }, + "ObjectExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 200, + "matcher": "status", + "state": "success" + }, + { + "expected": 404, + "matcher": "status", + "state": "retry" + } + ] + }, + "ObjectNotExists": { + "delay": 5, + "operation": "HeadObject", + "maxAttempts": 20, + "acceptors": [ + { + "expected": 404, + "matcher": "status", + "state": "success" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/s3control/2018-08-20/paginators-1.json b/aws/dist/botocore/data/s3control/2018-08-20/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/s3control/2018-08-20/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/s3control/2018-08-20/service-2.json b/aws/dist/botocore/data/s3control/2018-08-20/service-2.json new file mode 100644 index 00000000..6314cf84 --- /dev/null +++ b/aws/dist/botocore/data/s3control/2018-08-20/service-2.json @@ -0,0 +1,1352 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-08-20", + "endpointPrefix":"s3-control", + "protocol":"rest-xml", + "serviceFullName":"AWS S3 Control", + "serviceId":"S3 Control", + "signatureVersion":"s3v4", + "signingName":"s3", + "uid":"s3control-2018-08-20" + }, + "operations":{ + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/v20180820/jobs" + }, + "input":{ + "shape":"CreateJobRequest", + "locationName":"CreateJobRequest", + "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} + }, + "output":{"shape":"CreateJobResult"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"IdempotencyException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Creates an Amazon S3 batch operations job.

    " + }, + "DeletePublicAccessBlock":{ + "name":"DeletePublicAccessBlock", + "http":{ + "method":"DELETE", + "requestUri":"/v20180820/configuration/publicAccessBlock" + }, + "input":{"shape":"DeletePublicAccessBlockRequest"}, + "documentation":"

    Deletes the block public access configuration for the specified account.

    " + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"GET", + "requestUri":"/v20180820/jobs/{id}" + }, + "input":{"shape":"DescribeJobRequest"}, + "output":{"shape":"DescribeJobResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Retrieves the configuration parameters and status for a batch operations job.

    " + }, + "GetPublicAccessBlock":{ + "name":"GetPublicAccessBlock", + "http":{ + "method":"GET", + "requestUri":"/v20180820/configuration/publicAccessBlock" + }, + "input":{"shape":"GetPublicAccessBlockRequest"}, + "output":{"shape":"GetPublicAccessBlockOutput"}, + "errors":[ + {"shape":"NoSuchPublicAccessBlockConfiguration"} + ], + "documentation":"

    " + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"GET", + "requestUri":"/v20180820/jobs" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

    Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.

    " + }, + "PutPublicAccessBlock":{ + "name":"PutPublicAccessBlock", + "http":{ + "method":"PUT", + "requestUri":"/v20180820/configuration/publicAccessBlock" + }, + "input":{"shape":"PutPublicAccessBlockRequest"}, + "documentation":"

    " + }, + "UpdateJobPriority":{ + "name":"UpdateJobPriority", + "http":{ + "method":"POST", + "requestUri":"/v20180820/jobs/{id}/priority" + }, + "input":{"shape":"UpdateJobPriorityRequest"}, + "output":{"shape":"UpdateJobPriorityResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Updates an existing job's priority.

    " + }, + "UpdateJobStatus":{ + "name":"UpdateJobStatus", + "http":{ + "method":"POST", + "requestUri":"/v20180820/jobs/{id}/status" + }, + "input":{"shape":"UpdateJobStatusRequest"}, + "output":{"shape":"UpdateJobStatusResult"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NotFoundException"}, + {"shape":"JobStatusException"}, + {"shape":"InternalServiceException"} + ], + "documentation":"

    Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job.

    " + } + }, + "shapes":{ + "AccountId":{ + "type":"string", + "max":64 + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "Boolean":{"type":"boolean"}, + "ConfirmationRequired":{"type":"boolean"}, + "CreateJobRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Operation", + "Report", + "ClientRequestToken", + "Manifest", + "Priority", + "RoleArn" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + }, + "ConfirmationRequired":{ + "shape":"ConfirmationRequired", + "documentation":"

    Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.

    ", + "box":true + }, + "Operation":{ + "shape":"JobOperation", + "documentation":"

    The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.

    " + }, + "Report":{ + "shape":"JobReport", + "documentation":"

    Configuration parameters for the optional job-completion report.

    " + }, + "ClientRequestToken":{ + "shape":"NonEmptyMaxLength64String", + "documentation":"

    An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.

    ", + "idempotencyToken":true + }, + "Manifest":{ + "shape":"JobManifest", + "documentation":"

    Configuration parameters for the manifest.

    " + }, + "Description":{ + "shape":"NonEmptyMaxLength256String", + "documentation":"

    A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.

    " + }, + "Priority":{ + "shape":"JobPriority", + "documentation":"

    The numerical priority for this job. Higher numbers indicate higher priority.

    ", + "box":true + }, + "RoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role that batch operations will use to execute this job's operation on each object in the manifest.

    " + } + } + }, + "CreateJobResult":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for this job. Amazon S3 generates this ID automatically and returns it after a successful Create Job request.

    " + } + } + }, + "DeletePublicAccessBlockRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The account ID for the AWS account whose block public access configuration you want to delete.

    ", + "location":"header", + "locationName":"x-amz-account-id" + } + } + }, + "DescribeJobRequest":{ + "type":"structure", + "required":[ + "AccountId", + "JobId" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + }, + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the job whose information you want to retrieve.

    ", + "location":"uri", + "locationName":"id" + } + } + }, + "DescribeJobResult":{ + "type":"structure", + "members":{ + "Job":{ + "shape":"JobDescriptor", + "documentation":"

    Contains the configuration parameters and status for the job specified in the Describe Job request.

    " + } + } + }, + "ExceptionMessage":{ + "type":"string", + "max":1024, + "min":1 + }, + "GetPublicAccessBlockOutput":{ + "type":"structure", + "members":{ + "PublicAccessBlockConfiguration":{ + "shape":"PublicAccessBlockConfiguration", + "documentation":"

    " + } + }, + "payload":"PublicAccessBlockConfiguration" + }, + "GetPublicAccessBlockRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + } + } + }, + "IAMRoleArn":{ + "type":"string", + "max":2048, + "min":1 + }, + "IdempotencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "InternalServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true, + "fault":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "JobArn":{ + "type":"string", + "max":1024, + "min":1 + }, + "JobCreationTime":{"type":"timestamp"}, + "JobDescriptor":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the specified job.

    " + }, + "ConfirmationRequired":{ + "shape":"ConfirmationRequired", + "documentation":"

    Indicates whether confirmation is required before Amazon S3 begins running the specified job. Confirmation is required only for jobs created through the Amazon S3 console.

    ", + "box":true + }, + "Description":{ + "shape":"NonEmptyMaxLength256String", + "documentation":"

    The description for this job, if one was provided in this job's Create Job request.

    ", + "box":true + }, + "JobArn":{ + "shape":"JobArn", + "documentation":"

    The Amazon Resource Name (ARN) for this job.

    ", + "box":true + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

    The current status of the specified job.

    " + }, + "Manifest":{ + "shape":"JobManifest", + "documentation":"

    The configuration information for the specified job's manifest object.

    ", + "box":true + }, + "Operation":{ + "shape":"JobOperation", + "documentation":"

    The operation that the specified job is configured to execute on the objects listed in the manifest.

    ", + "box":true + }, + "Priority":{ + "shape":"JobPriority", + "documentation":"

    The priority of the specified job.

    " + }, + "ProgressSummary":{ + "shape":"JobProgressSummary", + "documentation":"

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    ", + "box":true + }, + "StatusUpdateReason":{ + "shape":"JobStatusUpdateReason", + "documentation":"

    ", + "box":true + }, + "FailureReasons":{ + "shape":"JobFailureList", + "documentation":"

    If the specified job failed, this field contains information describing the failure.

    ", + "box":true + }, + "Report":{ + "shape":"JobReport", + "documentation":"

    Contains the configuration information for the job-completion report if you requested one in the Create Job request.

    ", + "box":true + }, + "CreationTime":{ + "shape":"JobCreationTime", + "documentation":"

    A timestamp indicating when this job was created.

    " + }, + "TerminationDate":{ + "shape":"JobTerminationDate", + "documentation":"

    A timestamp indicating when this job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    ", + "box":true + }, + "RoleArn":{ + "shape":"IAMRoleArn", + "documentation":"

    The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) Role assigned to execute the tasks for this job.

    ", + "box":true + }, + "SuspendedDate":{ + "shape":"SuspendedDate", + "documentation":"

    The timestamp when this job was suspended, if it has been suspended.

    ", + "box":true + }, + "SuspendedCause":{ + "shape":"SuspendedCause", + "documentation":"

    The reason why the specified job was suspended. A job is only suspended if you create it through the Amazon S3 console. When you create the job, it enters the Suspended state to await confirmation before running. After you confirm the job, it automatically exits the Suspended state.

    ", + "box":true + } + }, + "documentation":"

    A container element for the job configuration and status information returned by a Describe Job request.

    " + }, + "JobFailure":{ + "type":"structure", + "members":{ + "FailureCode":{ + "shape":"JobFailureCode", + "documentation":"

    The failure code, if any, for the specified job.

    " + }, + "FailureReason":{ + "shape":"JobFailureReason", + "documentation":"

    The failure reason, if any, for the specified job.

    " + } + }, + "documentation":"

    If this job failed, this element indicates why the job failed.

    " + }, + "JobFailureCode":{ + "type":"string", + "max":64, + "min":1 + }, + "JobFailureList":{ + "type":"list", + "member":{"shape":"JobFailure"} + }, + "JobFailureReason":{ + "type":"string", + "max":256, + "min":1 + }, + "JobId":{ + "type":"string", + "max":36, + "min":5 + }, + "JobListDescriptor":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the specified job.

    " + }, + "Description":{ + "shape":"NonEmptyMaxLength256String", + "documentation":"

    The user-specified description that was included in the specified job's Create Job request.

    " + }, + "Operation":{ + "shape":"OperationName", + "documentation":"

    The operation that the specified job is configured to run on each object listed in the manifest.

    " + }, + "Priority":{ + "shape":"JobPriority", + "documentation":"

    The current priority for the specified job.

    " + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

    The specified job's current status.

    " + }, + "CreationTime":{ + "shape":"JobCreationTime", + "documentation":"

    A timestamp indicating when the specified job was created.

    " + }, + "TerminationDate":{ + "shape":"JobTerminationDate", + "documentation":"

    A timestamp indicating when the specified job terminated. A job's termination date is the date and time when it succeeded, failed, or was canceled.

    " + }, + "ProgressSummary":{ + "shape":"JobProgressSummary", + "documentation":"

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    " + } + }, + "documentation":"

    Contains the configuration and status information for a single job retrieved as part of a job list.

    " + }, + "JobListDescriptorList":{ + "type":"list", + "member":{"shape":"JobListDescriptor"} + }, + "JobManifest":{ + "type":"structure", + "required":[ + "Spec", + "Location" + ], + "members":{ + "Spec":{ + "shape":"JobManifestSpec", + "documentation":"

    Describes the format of the specified job's manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

    " + }, + "Location":{ + "shape":"JobManifestLocation", + "documentation":"

    Contains the information required to locate the specified job's manifest.

    " + } + }, + "documentation":"

    Contains the configuration information for a job's manifest.

    " + }, + "JobManifestFieldList":{ + "type":"list", + "member":{"shape":"JobManifestFieldName"} + }, + "JobManifestFieldName":{ + "type":"string", + "enum":[ + "Ignore", + "Bucket", + "Key", + "VersionId" + ] + }, + "JobManifestFormat":{ + "type":"string", + "enum":[ + "S3BatchOperations_CSV_20180820", + "S3InventoryReport_CSV_20161130" + ] + }, + "JobManifestLocation":{ + "type":"structure", + "required":[ + "ObjectArn", + "ETag" + ], + "members":{ + "ObjectArn":{ + "shape":"S3KeyArnString", + "documentation":"

    The Amazon Resource Name (ARN) for a manifest object.

    " + }, + "ObjectVersionId":{ + "shape":"S3ObjectVersionId", + "documentation":"

    The optional version ID to identify a specific version of the manifest object.

    ", + "box":true + }, + "ETag":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    The ETag for the specified manifest object.

    " + } + }, + "documentation":"

    Contains the information required to locate a manifest object.

    " + }, + "JobManifestSpec":{ + "type":"structure", + "required":["Format"], + "members":{ + "Format":{ + "shape":"JobManifestFormat", + "documentation":"

    Indicates which of the available formats the specified manifest uses.

    " + }, + "Fields":{ + "shape":"JobManifestFieldList", + "documentation":"

    If the specified manifest object is in the S3BatchOperations_CSV_20180820 format, this element describes which columns contain the required data.

    ", + "box":true + } + }, + "documentation":"

    Describes the format of a manifest. If the manifest is in CSV format, also describes the columns contained within the manifest.

    " + }, + "JobNumberOfTasksFailed":{ + "type":"long", + "min":0 + }, + "JobNumberOfTasksSucceeded":{ + "type":"long", + "min":0 + }, + "JobOperation":{ + "type":"structure", + "members":{ + "LambdaInvoke":{ + "shape":"LambdaInvokeOperation", + "documentation":"

    Directs the specified job to invoke an AWS Lambda function on each object in the manifest.

    ", + "box":true + }, + "S3PutObjectCopy":{ + "shape":"S3CopyObjectOperation", + "documentation":"

    Directs the specified job to execute a PUT Copy object call on each object in the manifest.

    ", + "box":true + }, + "S3PutObjectAcl":{ + "shape":"S3SetObjectAclOperation", + "documentation":"

    Directs the specified job to execute a PUT Object acl call on each object in the manifest.

    ", + "box":true + }, + "S3PutObjectTagging":{ + "shape":"S3SetObjectTaggingOperation", + "documentation":"

    Directs the specified job to execute a PUT Object tagging call on each object in the manifest.

    ", + "box":true + }, + "S3InitiateRestoreObject":{ + "shape":"S3InitiateRestoreObjectOperation", + "documentation":"

    Directs the specified job to execute an Initiate Glacier Restore call on each object in the manifest.

    ", + "box":true + } + }, + "documentation":"

    The operation that you want this job to perform on each object listed in the manifest. For more information about the available operations, see Available Operations in the Amazon Simple Storage Service Developer Guide.

    " + }, + "JobPriority":{ + "type":"integer", + "max":2147483647, + "min":0 + }, + "JobProgressSummary":{ + "type":"structure", + "members":{ + "TotalNumberOfTasks":{ + "shape":"JobTotalNumberOfTasks", + "documentation":"

    ", + "box":true + }, + "NumberOfTasksSucceeded":{ + "shape":"JobNumberOfTasksSucceeded", + "documentation":"

    ", + "box":true + }, + "NumberOfTasksFailed":{ + "shape":"JobNumberOfTasksFailed", + "documentation":"

    ", + "box":true + } + }, + "documentation":"

    Describes the total number of tasks that the specified job has executed, the number of tasks that succeeded, and the number of tasks that failed.

    " + }, + "JobReport":{ + "type":"structure", + "required":["Enabled"], + "members":{ + "Bucket":{ + "shape":"S3BucketArnString", + "documentation":"

    The bucket where specified job-completion report will be stored.

    ", + "box":true + }, + "Format":{ + "shape":"JobReportFormat", + "documentation":"

    The format of the specified job-completion report.

    ", + "box":true + }, + "Enabled":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the specified job will generate a job-completion report.

    " + }, + "Prefix":{ + "shape":"ReportPrefixString", + "documentation":"

    An optional prefix to describe where in the specified bucket the job-completion report will be stored. Amazon S3 will store the job-completion report at <prefix>/job-<job-id>/report.json.

    ", + "box":true + }, + "ReportScope":{ + "shape":"JobReportScope", + "documentation":"

    Indicates whether the job-completion report will include details of all tasks or only failed tasks.

    ", + "box":true + } + }, + "documentation":"

    Contains the configuration parameters for a job-completion report.

    " + }, + "JobReportFormat":{ + "type":"string", + "enum":["Report_CSV_20180820"] + }, + "JobReportScope":{ + "type":"string", + "enum":[ + "AllTasks", + "FailedTasksOnly" + ] + }, + "JobStatus":{ + "type":"string", + "enum":[ + "Active", + "Cancelled", + "Cancelling", + "Complete", + "Completing", + "Failed", + "Failing", + "New", + "Paused", + "Pausing", + "Preparing", + "Ready", + "Suspended" + ] + }, + "JobStatusException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "JobStatusList":{ + "type":"list", + "member":{"shape":"JobStatus"} + }, + "JobStatusUpdateReason":{ + "type":"string", + "max":256, + "min":1 + }, + "JobTerminationDate":{"type":"timestamp"}, + "JobTotalNumberOfTasks":{ + "type":"long", + "min":0 + }, + "KmsKeyArnString":{ + "type":"string", + "max":2000, + "min":1 + }, + "LambdaInvokeOperation":{ + "type":"structure", + "members":{ + "FunctionArn":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    The Amazon Resource Name (ARN) for the AWS Lambda function that the specified job will invoke for each object in the manifest.

    " + } + }, + "documentation":"

    Contains the configuration parameters for a Lambda Invoke operation.

    " + }, + "ListJobsRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + }, + "JobStatuses":{ + "shape":"JobStatusList", + "documentation":"

    The List Jobs request returns jobs that match the statuses listed in this element.

    ", + "location":"querystring", + "locationName":"jobStatuses" + }, + "NextToken":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    A pagination token to request the next page of results. Use the token that Amazon S3 returned in the NextToken element of the ListJobsResult from the previous List Jobs request.

    ", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of jobs that Amazon S3 will include in the List Jobs response. If there are more jobs than this number, the response will include a pagination token in the NextToken field to enable you to retrieve the next page of results.

    ", + "box":true, + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListJobsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    If the List Jobs request produced more than the maximum number of results, you can pass this value into a subsequent List Jobs request in order to retrieve the next page of results.

    " + }, + "Jobs":{ + "shape":"JobListDescriptorList", + "documentation":"

    The list of current jobs and jobs that have ended within the last 30 days.

    " + } + } + }, + "MaxLength1024String":{ + "type":"string", + "max":1024 + }, + "MaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "NoSuchPublicAccessBlockConfiguration":{ + "type":"structure", + "members":{ + "Message":{"shape":"NoSuchPublicAccessBlockConfigurationMessage"} + }, + "documentation":"

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "NoSuchPublicAccessBlockConfigurationMessage":{"type":"string"}, + "NonEmptyMaxLength1024String":{ + "type":"string", + "max":1024, + "min":1 + }, + "NonEmptyMaxLength2048String":{ + "type":"string", + "max":2048, + "min":1 + }, + "NonEmptyMaxLength256String":{ + "type":"string", + "max":256, + "min":1 + }, + "NonEmptyMaxLength64String":{ + "type":"string", + "max":64, + "min":1 + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "OperationName":{ + "type":"string", + "enum":[ + "LambdaInvoke", + "S3PutObjectCopy", + "S3PutObjectAcl", + "S3PutObjectTagging", + "S3InitiateRestoreObject" + ] + }, + "PublicAccessBlockConfiguration":{ + "type":"structure", + "members":{ + "BlockPublicAcls":{ + "shape":"Setting", + "documentation":"

    ", + "locationName":"BlockPublicAcls" + }, + "IgnorePublicAcls":{ + "shape":"Setting", + "documentation":"

    ", + "locationName":"IgnorePublicAcls" + }, + "BlockPublicPolicy":{ + "shape":"Setting", + "documentation":"

    ", + "locationName":"BlockPublicPolicy" + }, + "RestrictPublicBuckets":{ + "shape":"Setting", + "documentation":"

    ", + "locationName":"RestrictPublicBuckets" + } + }, + "documentation":"

    " + }, + "PutPublicAccessBlockRequest":{ + "type":"structure", + "required":[ + "PublicAccessBlockConfiguration", + "AccountId" + ], + "members":{ + "PublicAccessBlockConfiguration":{ + "shape":"PublicAccessBlockConfiguration", + "documentation":"

    ", + "locationName":"PublicAccessBlockConfiguration", + "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + } + }, + "payload":"PublicAccessBlockConfiguration" + }, + "ReportPrefixString":{ + "type":"string", + "max":512, + "min":1 + }, + "RequestedJobStatus":{ + "type":"string", + "enum":[ + "Cancelled", + "Ready" + ] + }, + "S3AccessControlList":{ + "type":"structure", + "required":["Owner"], + "members":{ + "Owner":{ + "shape":"S3ObjectOwner", + "documentation":"

    " + }, + "Grants":{ + "shape":"S3GrantList", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3AccessControlPolicy":{ + "type":"structure", + "members":{ + "AccessControlList":{ + "shape":"S3AccessControlList", + "documentation":"

    ", + "box":true + }, + "CannedAccessControlList":{ + "shape":"S3CannedAccessControlList", + "documentation":"

    ", + "box":true + } + }, + "documentation":"

    " + }, + "S3BucketArnString":{ + "type":"string", + "max":128, + "min":1 + }, + "S3CannedAccessControlList":{ + "type":"string", + "enum":[ + "private", + "public-read", + "public-read-write", + "aws-exec-read", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control" + ] + }, + "S3ContentLength":{ + "type":"long", + "min":0 + }, + "S3CopyObjectOperation":{ + "type":"structure", + "members":{ + "TargetResource":{ + "shape":"S3BucketArnString", + "documentation":"

    " + }, + "CannedAccessControlList":{ + "shape":"S3CannedAccessControlList", + "documentation":"

    ", + "box":true + }, + "AccessControlGrants":{ + "shape":"S3GrantList", + "documentation":"

    ", + "box":true + }, + "MetadataDirective":{ + "shape":"S3MetadataDirective", + "documentation":"

    " + }, + "ModifiedSinceConstraint":{ + "shape":"TimeStamp", + "documentation":"

    " + }, + "NewObjectMetadata":{ + "shape":"S3ObjectMetadata", + "documentation":"

    " + }, + "NewObjectTagging":{ + "shape":"S3TagSet", + "documentation":"

    " + }, + "RedirectLocation":{ + "shape":"NonEmptyMaxLength2048String", + "documentation":"

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    " + }, + "StorageClass":{ + "shape":"S3StorageClass", + "documentation":"

    " + }, + "UnModifiedSinceConstraint":{ + "shape":"TimeStamp", + "documentation":"

    " + }, + "SSEAwsKmsKeyId":{ + "shape":"KmsKeyArnString", + "documentation":"

    " + }, + "TargetKeyPrefix":{"shape":"NonEmptyMaxLength1024String"}, + "ObjectLockLegalHoldStatus":{"shape":"S3ObjectLockLegalHoldStatus"}, + "ObjectLockMode":{"shape":"S3ObjectLockMode"}, + "ObjectLockRetainUntilDate":{"shape":"TimeStamp"} + }, + "documentation":"

    Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.

    " + }, + "S3ExpirationInDays":{ + "type":"integer", + "min":0 + }, + "S3GlacierJobTier":{ + "type":"string", + "enum":[ + "BULK", + "STANDARD" + ] + }, + "S3Grant":{ + "type":"structure", + "members":{ + "Grantee":{ + "shape":"S3Grantee", + "documentation":"

    " + }, + "Permission":{ + "shape":"S3Permission", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3GrantList":{ + "type":"list", + "member":{"shape":"S3Grant"} + }, + "S3Grantee":{ + "type":"structure", + "members":{ + "TypeIdentifier":{ + "shape":"S3GranteeTypeIdentifier", + "documentation":"

    " + }, + "Identifier":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    ", + "box":true + }, + "DisplayName":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3GranteeTypeIdentifier":{ + "type":"string", + "enum":[ + "id", + "emailAddress", + "uri" + ] + }, + "S3InitiateRestoreObjectOperation":{ + "type":"structure", + "members":{ + "ExpirationInDays":{ + "shape":"S3ExpirationInDays", + "documentation":"

    " + }, + "GlacierJobTier":{ + "shape":"S3GlacierJobTier", + "documentation":"

    " + } + }, + "documentation":"

    Contains the configuration parameters for an Initiate Glacier Restore job. Amazon S3 batch operations passes each value through to the underlying POST Object restore API. For more information about the parameters for this operation, see Restoring Archives.

    " + }, + "S3KeyArnString":{ + "type":"string", + "max":2000, + "min":1 + }, + "S3MetadataDirective":{ + "type":"string", + "enum":[ + "COPY", + "REPLACE" + ] + }, + "S3ObjectLockLegalHoldStatus":{ + "type":"string", + "enum":[ + "OFF", + "ON" + ] + }, + "S3ObjectLockMode":{ + "type":"string", + "enum":[ + "COMPLIANCE", + "GOVERNANCE" + ] + }, + "S3ObjectMetadata":{ + "type":"structure", + "members":{ + "CacheControl":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "ContentDisposition":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "ContentEncoding":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "ContentLanguage":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "UserMetadata":{ + "shape":"S3UserMetadata", + "documentation":"

    " + }, + "ContentLength":{ + "shape":"S3ContentLength", + "documentation":"

    ", + "box":true + }, + "ContentMD5":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "ContentType":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "HttpExpiresDate":{ + "shape":"TimeStamp", + "documentation":"

    " + }, + "RequesterCharged":{ + "shape":"Boolean", + "documentation":"

    " + }, + "SSEAlgorithm":{ + "shape":"S3SSEAlgorithm", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3ObjectOwner":{ + "type":"structure", + "members":{ + "ID":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "DisplayName":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3ObjectVersionId":{ + "type":"string", + "max":2000, + "min":1 + }, + "S3Permission":{ + "type":"string", + "enum":[ + "FULL_CONTROL", + "READ", + "WRITE", + "READ_ACP", + "WRITE_ACP" + ] + }, + "S3SSEAlgorithm":{ + "type":"string", + "enum":[ + "AES256", + "KMS" + ] + }, + "S3SetObjectAclOperation":{ + "type":"structure", + "members":{ + "AccessControlPolicy":{ + "shape":"S3AccessControlPolicy", + "documentation":"

    " + } + }, + "documentation":"

    Contains the configuration parameters for a Set Object ACL operation. Amazon S3 batch operations passes each value through to the underlying PUT Object acl API. For more information about the parameters for this operation, see PUT Object acl.

    " + }, + "S3SetObjectTaggingOperation":{ + "type":"structure", + "members":{ + "TagSet":{ + "shape":"S3TagSet", + "documentation":"

    " + } + }, + "documentation":"

    Contains the configuration parameters for a Set Object Tagging operation. Amazon S3 batch operations passes each value through to the underlying PUT Object tagging API. For more information about the parameters for this operation, see PUT Object tagging.

    " + }, + "S3StorageClass":{ + "type":"string", + "enum":[ + "STANDARD", + "STANDARD_IA", + "ONEZONE_IA", + "GLACIER", + "INTELLIGENT_TIERING", + "DEEP_ARCHIVE" + ] + }, + "S3Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"NonEmptyMaxLength1024String", + "documentation":"

    " + }, + "Value":{ + "shape":"MaxLength1024String", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "S3TagSet":{ + "type":"list", + "member":{"shape":"S3Tag"} + }, + "S3UserMetadata":{ + "type":"map", + "key":{"shape":"NonEmptyMaxLength1024String"}, + "value":{"shape":"MaxLength1024String"}, + "max":8192 + }, + "Setting":{"type":"boolean"}, + "SuspendedCause":{ + "type":"string", + "max":1024, + "min":1 + }, + "SuspendedDate":{"type":"timestamp"}, + "TimeStamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    ", + "exception":true + }, + "UpdateJobPriorityRequest":{ + "type":"structure", + "required":[ + "AccountId", + "JobId", + "Priority" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + }, + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the job whose priority you want to update.

    ", + "location":"uri", + "locationName":"id" + }, + "Priority":{ + "shape":"JobPriority", + "documentation":"

    The priority you want to assign to this job.

    ", + "location":"querystring", + "locationName":"priority" + } + } + }, + "UpdateJobPriorityResult":{ + "type":"structure", + "required":[ + "JobId", + "Priority" + ], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the job whose priority Amazon S3 updated.

    " + }, + "Priority":{ + "shape":"JobPriority", + "documentation":"

    The new priority assigned to the specified job.

    " + } + } + }, + "UpdateJobStatusRequest":{ + "type":"structure", + "required":[ + "AccountId", + "JobId", + "RequestedJobStatus" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    ", + "location":"header", + "locationName":"x-amz-account-id" + }, + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID of the job whose status you want to update.

    ", + "location":"uri", + "locationName":"id" + }, + "RequestedJobStatus":{ + "shape":"RequestedJobStatus", + "documentation":"

    The status that you want to move the specified job to.

    ", + "location":"querystring", + "locationName":"requestedJobStatus" + }, + "StatusUpdateReason":{ + "shape":"JobStatusUpdateReason", + "documentation":"

    A description of the reason why you want to change the specified job's status. This field can be any string up to the maximum length.

    ", + "location":"querystring", + "locationName":"statusUpdateReason" + } + } + }, + "UpdateJobStatusResult":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the job whose status was updated.

    " + }, + "Status":{ + "shape":"JobStatus", + "documentation":"

    The current status for the specified job.

    " + }, + "StatusUpdateReason":{ + "shape":"JobStatusUpdateReason", + "documentation":"

    The reason that the specified job's status was updated.

    " + } + } + } + }, + "documentation":"

    AWS S3 Control provides access to Amazon S3 control plane operations.

    " +} diff --git a/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/paginators-1.json b/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/service-2.json b/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/service-2.json new file mode 100644 index 00000000..6de0f98b --- /dev/null +++ b/aws/dist/botocore/data/sagemaker-runtime/2017-05-13/service-2.json @@ -0,0 +1,180 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-05-13", + "endpointPrefix":"runtime.sagemaker", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon SageMaker Runtime", + "serviceId":"SageMaker Runtime", + "signatureVersion":"v4", + "signingName":"sagemaker", + "uid":"runtime.sagemaker-2017-05-13" + }, + "operations":{ + "InvokeEndpoint":{ + "name":"InvokeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/endpoints/{EndpointName}/invocations" + }, + "input":{"shape":"InvokeEndpointInput"}, + "output":{"shape":"InvokeEndpointOutput"}, + "errors":[ + {"shape":"InternalFailure"}, + {"shape":"ServiceUnavailable"}, + {"shape":"ValidationError"}, + {"shape":"ModelError"} + ], + "documentation":"

    After you deploy a model into production using Amazon SageMaker hosting services, your client applications use this API to get inferences from the model hosted at the specified endpoint.

    For an overview of Amazon SageMaker, see How It Works.

    Amazon SageMaker strips all POST headers except those supported by the API. Amazon SageMaker might add additional headers. You should not rely on the behavior of headers outside those enumerated in the request syntax.

    Cals to InvokeEndpoint are authenticated by using AWS Signature Version 4. For information, see Authenticating Requests (AWS Signature Version 4) in the Amazon S3 API Reference.

    Endpoints are scoped to an individual account, and are not public. The URL does not contain the account ID, but Amazon SageMaker determines the account ID from the authentication token that is supplied by the caller.

    " + } + }, + "shapes":{ + "BodyBlob":{ + "type":"blob", + "max":5242880, + "sensitive":true + }, + "CustomAttributesHeader":{ + "type":"string", + "max":1024, + "sensitive":true + }, + "EndpointName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "Header":{ + "type":"string", + "max":1024 + }, + "InternalFailure":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    An internal failure occurred.

    ", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true, + "synthetic":true + }, + "InvokeEndpointInput":{ + "type":"structure", + "required":[ + "EndpointName", + "Body" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint that you specified when you created the endpoint using the CreateEndpoint API.

    ", + "location":"uri", + "locationName":"EndpointName" + }, + "Body":{ + "shape":"BodyBlob", + "documentation":"

    Provides input data, in the format specified in the ContentType request header. Amazon SageMaker passes all of the data in the body to the model.

    For information about the format of the request body, see Common Data Formats—Inference.

    " + }, + "ContentType":{ + "shape":"Header", + "documentation":"

    The MIME type of the input data in the request body.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "Accept":{ + "shape":"Header", + "documentation":"

    The desired MIME type of the inference in the response.

    ", + "location":"header", + "locationName":"Accept" + }, + "CustomAttributes":{ + "shape":"CustomAttributesHeader", + "documentation":"

    ", + "location":"header", + "locationName":"X-Amzn-SageMaker-Custom-Attributes" + } + }, + "payload":"Body" + }, + "InvokeEndpointOutput":{ + "type":"structure", + "required":["Body"], + "members":{ + "Body":{ + "shape":"BodyBlob", + "documentation":"

    Includes the inference provided by the model.

    For information about the format of the response body, see Common Data Formats—Inference.

    " + }, + "ContentType":{ + "shape":"Header", + "documentation":"

    The MIME type of the inference returned in the response body.

    ", + "location":"header", + "locationName":"Content-Type" + }, + "InvokedProductionVariant":{ + "shape":"Header", + "documentation":"

    Identifies the production variant that was invoked.

    ", + "location":"header", + "locationName":"x-Amzn-Invoked-Production-Variant" + }, + "CustomAttributes":{ + "shape":"CustomAttributesHeader", + "documentation":"

    ", + "location":"header", + "locationName":"X-Amzn-SageMaker-Custom-Attributes" + } + }, + "payload":"Body" + }, + "LogStreamArn":{"type":"string"}, + "Message":{ + "type":"string", + "max":2048 + }, + "ModelError":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"}, + "OriginalStatusCode":{ + "shape":"StatusCode", + "documentation":"

    Original status code.

    " + }, + "OriginalMessage":{ + "shape":"Message", + "documentation":"

    Original message.

    " + }, + "LogStreamArn":{ + "shape":"LogStreamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the log stream.

    " + } + }, + "documentation":"

    Model (owned by the customer in the container) returned an error 500.

    ", + "error":{"httpStatusCode":424}, + "exception":true + }, + "ServiceUnavailable":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    The service is unavailable. Try your call again.

    ", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true, + "synthetic":true + }, + "StatusCode":{"type":"integer"}, + "ValidationError":{ + "type":"structure", + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    Inspect your request and try again.

    ", + "error":{"httpStatusCode":400}, + "exception":true, + "synthetic":true + } + }, + "documentation":"

    The Amazon SageMaker runtime API.

    " +} diff --git a/aws/dist/botocore/data/sagemaker/2017-07-24/paginators-1.json b/aws/dist/botocore/data/sagemaker/2017-07-24/paginators-1.json new file mode 100644 index 00000000..dc7a411f --- /dev/null +++ b/aws/dist/botocore/data/sagemaker/2017-07-24/paginators-1.json @@ -0,0 +1,118 @@ +{ + "pagination": { + "ListTrainingJobs": { + "result_key": "TrainingJobSummaries", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEndpoints": { + "result_key": "Endpoints", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListEndpointConfigs": { + "result_key": "EndpointConfigs", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNotebookInstances": { + "result_key": "NotebookInstances", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListTags": { + "result_key": "Tags", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListModels": { + "result_key": "Models", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAlgorithms": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AlgorithmSummaryList" + }, + "ListCodeRepositories": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CodeRepositorySummaryList" + }, + "ListCompilationJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CompilationJobSummaries" + }, + "ListHyperParameterTuningJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "HyperParameterTuningJobSummaries" + }, + "ListLabelingJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LabelingJobSummaryList" + }, + "ListLabelingJobsForWorkteam": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "LabelingJobSummaryList" + }, + "ListModelPackages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ModelPackageSummaryList" + }, + "ListNotebookInstanceLifecycleConfigs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "NotebookInstanceLifecycleConfigs" + }, + "ListSubscribedWorkteams": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SubscribedWorkteams" + }, + "ListTrainingJobsForHyperParameterTuningJob": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TrainingJobSummaries" + }, + "ListTransformJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TransformJobSummaries" + }, + "ListWorkteams": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Workteams" + }, + "Search": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Results" + } + } +} diff --git a/aws/dist/botocore/data/sagemaker/2017-07-24/service-2.json b/aws/dist/botocore/data/sagemaker/2017-07-24/service-2.json new file mode 100644 index 00000000..47335c7d --- /dev/null +++ b/aws/dist/botocore/data/sagemaker/2017-07-24/service-2.json @@ -0,0 +1,8344 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-24", + "endpointPrefix":"api.sagemaker", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"SageMaker", + "serviceFullName":"Amazon SageMaker Service", + "serviceId":"SageMaker", + "signatureVersion":"v4", + "signingName":"sagemaker", + "targetPrefix":"SageMaker", + "uid":"sagemaker-2017-07-24" + }, + "operations":{ + "AddTags":{ + "name":"AddTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsInput"}, + "output":{"shape":"AddTagsOutput"}, + "documentation":"

    Adds or overwrites one or more tags for the specified Amazon SageMaker resource. You can add tags to notebook instances, training jobs, hyperparameter tuning jobs, batch transform jobs, models, labeling jobs, work teams, endpoint configurations, and endpoints.

    Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see For more information, see AWS Tagging Strategies.

    Tags that you add to a hyperparameter tuning job by calling this API are also added to any training jobs that the hyperparameter tuning job launches after you call this API, but not to training jobs that the hyperparameter tuning job launched before you called this API. To make sure that the tags associated with a hyperparameter tuning job are also added to all training jobs that the hyperparameter tuning job launches, add the tags when you first create the tuning job by specifying them in the Tags parameter of CreateHyperParameterTuningJob

    " + }, + "CreateAlgorithm":{ + "name":"CreateAlgorithm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAlgorithmInput"}, + "output":{"shape":"CreateAlgorithmOutput"}, + "documentation":"

    Create a machine learning algorithm that you can use in Amazon SageMaker and list in the AWS Marketplace.

    " + }, + "CreateCodeRepository":{ + "name":"CreateCodeRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCodeRepositoryInput"}, + "output":{"shape":"CreateCodeRepositoryOutput"}, + "documentation":"

    Creates a Git repository as a resource in your Amazon SageMaker account. You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your Amazon SageMaker account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

    The repository can be hosted either in AWS CodeCommit or in any other Git repository.

    " + }, + "CreateCompilationJob":{ + "name":"CreateCompilationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCompilationJobRequest"}, + "output":{"shape":"CreateCompilationJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Starts a model compilation job. After the model has been compiled, Amazon SageMaker saves the resulting model artifacts to an Amazon Simple Storage Service (Amazon S3) bucket that you specify.

    If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts with AWS IoT Greengrass. In that case, deploy them as an ML resource.

    In the request body, you provide the following:

    • A name for the compilation job

    • Information about the input model artifacts

    • The output location for the compiled model and the device (target) that the model runs on

    • The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker assumes to perform the model compilation job

    You can also provide a Tag to track the model compilation job's resource use and costs. The response body contains the CompilationJobArn for the compiled job.

    To stop a model compilation job, use StopCompilationJob. To get information about a particular model compilation job, use DescribeCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

    " + }, + "CreateEndpoint":{ + "name":"CreateEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointInput"}, + "output":{"shape":"CreateEndpointOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates an endpoint using the endpoint configuration specified in the request. Amazon SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.

    Use this API only for hosting models using Amazon SageMaker hosting services.

    You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

    The endpoint name must be unique within an AWS Region in your AWS account.

    When it receives the request, Amazon SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.

    When Amazon SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. Amazon SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.

    For an example, see Exercise 1: Using the K-Means Algorithm Provided by Amazon SageMaker.

    If any of the models hosted at this endpoint get model data from an Amazon S3 location, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provided. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS i an AWS Region in the AWS Identity and Access Management User Guide.

    " + }, + "CreateEndpointConfig":{ + "name":"CreateEndpointConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateEndpointConfigInput"}, + "output":{"shape":"CreateEndpointConfigOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates an endpoint configuration that Amazon SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel API, to deploy and the resources that you want Amazon SageMaker to provision. Then you call the CreateEndpoint API.

    Use this API only if you want to use Amazon SageMaker hosting services to deploy models into production.

    In the request, you define one or more ProductionVariants, each of which identifies a model. Each ProductionVariant parameter also describes the resources that you want Amazon SageMaker to provision. This includes the number and type of ML compute instances to deploy.

    If you are hosting multiple models, you also assign a VariantWeight to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. Amazon SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.

    " + }, + "CreateHyperParameterTuningJob":{ + "name":"CreateHyperParameterTuningJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHyperParameterTuningJobRequest"}, + "output":{"shape":"CreateHyperParameterTuningJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.

    " + }, + "CreateLabelingJob":{ + "name":"CreateLabelingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateLabelingJobRequest"}, + "output":{"shape":"CreateLabelingJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates a job that uses workers to label the data objects in your input dataset. You can use the labeled data to train machine learning models.

    You can select your workforce from one of three providers:

    • A private workforce that you create. It can include employees, contractors, and outside experts. Use a private workforce when want the data to stay within your organization or when a specific set of skills is required.

    • One or more vendors that you select from the AWS Marketplace. Vendors provide expertise in specific areas.

    • The Amazon Mechanical Turk workforce. This is the largest workforce, but it should only be used for public data or data that has been stripped of any personally identifiable information.

    You can also use automated data labeling to reduce the number of data objects that need to be labeled by a human. Automated data labeling uses active learning to determine if a data object can be labeled by machine or if it needs to be sent to a human worker. For more information, see Using Automated Data Labeling.

    The data objects to be labeled are contained in an Amazon S3 bucket. You create a manifest file that describes the location of each object. For more information, see Using Input and Output Data.

    The output can be used as the manifest file for another labeling job or as training data for your machine learning models.

    " + }, + "CreateModel":{ + "name":"CreateModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelInput"}, + "output":{"shape":"CreateModelOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates a model in Amazon SageMaker. In the request, you name the model and describe a primary container. For the primary container, you specify the docker image containing inference code, artifacts (from prior training), and custom environment map that the inference code uses when you deploy the model for predictions.

    Use this API to create a model if you want to use Amazon SageMaker hosting services or run a batch transform job.

    To host your model, you create an endpoint configuration with the CreateEndpointConfig API, and then create an endpoint with the CreateEndpoint API. Amazon SageMaker then deploys all of the containers that you defined for the model in the hosting environment.

    To run a batch transform using your model, you start a job with the CreateTransformJob API. Amazon SageMaker uses your model and your dataset to get inferences which are then saved to a specified S3 location.

    In the CreateModel request, you must define a container with the PrimaryContainer parameter.

    In the request, you also provide an IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute hosting instances or for batch transform jobs. In addition, you also use the IAM role to manage permissions the inference code needs. For example, if the inference code access any other AWS resources, you grant necessary permissions via this role.

    " + }, + "CreateModelPackage":{ + "name":"CreateModelPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateModelPackageInput"}, + "output":{"shape":"CreateModelPackageOutput"}, + "documentation":"

    Creates a model package that you can use to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

    To create a model package by specifying a Docker container that contains your inference code and the Amazon S3 location of your model artifacts, provide values for InferenceSpecification. To create a model from an algorithm resource that you created or subscribed to in AWS Marketplace, provide a value for SourceAlgorithmSpecification.

    " + }, + "CreateNotebookInstance":{ + "name":"CreateNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNotebookInstanceInput"}, + "output":{"shape":"CreateNotebookInstanceOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates an Amazon SageMaker notebook instance. A notebook instance is a machine learning (ML) compute instance running on a Jupyter notebook.

    In a CreateNotebookInstance request, specify the type of ML compute instance that you want to run. Amazon SageMaker launches the instance, installs common libraries that you can use to explore datasets for model training, and attaches an ML storage volume to the notebook instance.

    Amazon SageMaker also provides a set of example notebooks. Each notebook demonstrates how to use Amazon SageMaker with a specific algorithm or with a machine learning framework.

    After receiving the request, Amazon SageMaker does the following:

    1. Creates a network interface in the Amazon SageMaker VPC.

    2. (Option) If you specified SubnetId, Amazon SageMaker creates a network interface in your own VPC, which is inferred from the subnet ID that you provide in the input. When creating this network interface, Amazon SageMaker attaches the security group that you specified in the request to the network interface that it creates in your VPC.

    3. Launches an EC2 instance of the type specified in the request in the Amazon SageMaker VPC. If you specified SubnetId of your VPC, Amazon SageMaker specifies both network interfaces when launching this instance. This enables inbound traffic from your own VPC to the notebook instance, assuming that the security groups allow it.

    After creating the notebook instance, Amazon SageMaker returns its Amazon Resource Name (ARN). You can't change the name of a notebook instance after you create it.

    After Amazon SageMaker creates the notebook instance, you can connect to the Jupyter server and work in Jupyter notebooks. For example, you can write code to explore a dataset that you can use for model training, train a model, host models by creating Amazon SageMaker endpoints, and validate hosted models.

    For more information, see How It Works.

    " + }, + "CreateNotebookInstanceLifecycleConfig":{ + "name":"CreateNotebookInstanceLifecycleConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNotebookInstanceLifecycleConfigInput"}, + "output":{"shape":"CreateNotebookInstanceLifecycleConfigOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates a lifecycle configuration that you can associate with a notebook instance. A lifecycle configuration is a collection of shell scripts that run when you create or start a notebook instance.

    Each lifecycle configuration script has a limit of 16384 characters.

    The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

    View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

    Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "CreatePresignedNotebookInstanceUrl":{ + "name":"CreatePresignedNotebookInstanceUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePresignedNotebookInstanceUrlInput"}, + "output":{"shape":"CreatePresignedNotebookInstanceUrlOutput"}, + "documentation":"

    Returns a URL that you can use to connect to the Jupyter server from a notebook instance. In the Amazon SageMaker console, when you choose Open next to a notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server home page from the notebook instance. The console uses this API to get the URL and show the page.

    IAM authorization policies for this API are also enforced for every HTTP request and WebSocket frame that attempts to connect to the notebook instance.For example, you can restrict access to this API and to the URL that it returns to a list of IP addresses that you specify. Use the NotIpAddress condition operator and the aws:SourceIP condition context key to specify the list of IP addresses that you want to have access to the notebook instance. For more information, see Limit Access to a Notebook Instance by IP Address.

    The URL that you get from a call to is valid only for 5 minutes. If you try to use the URL after the 5-minute limit expires, you are directed to the AWS console sign-in page.

    " + }, + "CreateTrainingJob":{ + "name":"CreateTrainingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTrainingJobRequest"}, + "output":{"shape":"CreateTrainingJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Starts a model training job. After training completes, Amazon SageMaker saves the resulting model artifacts to an Amazon S3 location that you specify.

    If you choose to host your model using Amazon SageMaker hosting services, you can use the resulting model artifacts as part of the model. You can also use the artifacts in a machine learning service other than Amazon SageMaker, provided that you know how to use them for inferences.

    In the request body, you provide the following:

    • AlgorithmSpecification - Identifies the training algorithm to use.

    • HyperParameters - Specify these algorithm-specific parameters to enable the estimation of model parameters during training. Hyperparameters can be tuned to optimize this learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

    • InputDataConfig - Describes the training dataset and the Amazon S3, EFS, or FSx location where it is stored.

    • OutputDataConfig - Identifies the Amazon S3 bucket where you want Amazon SageMaker to save the results of model training.

    • ResourceConfig - Identifies the resources, ML compute instances, and ML storage volumes to deploy for model training. In distributed training, you specify more than one instance.

    • EnableManagedSpotTraining - Optimize the cost of training machine learning models by up to 80% by using Amazon EC2 Spot instances. For more information, see Managed Spot Training.

    • RoleARN - The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during model training. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete model training.

    • StoppingCondition - To help cap training costs, use MaxRuntimeInSeconds to set a time limit for training. Use MaxWaitTimeInSeconds to specify how long you are willing to to wait for a managed spot training job to complete.

    For more information about Amazon SageMaker, see How It Works.

    " + }, + "CreateTransformJob":{ + "name":"CreateTransformJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTransformJobRequest"}, + "output":{"shape":"CreateTransformJobResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Starts a transform job. A transform job uses a trained model to get inferences on a dataset and saves these results to an Amazon S3 location that you specify.

    To perform batch transformations, you create a transform job and use the data that you have readily available.

    In the request body, you provide the following:

    • TransformJobName - Identifies the transform job. The name must be unique within an AWS Region in an AWS account.

    • ModelName - Identifies the model to use. ModelName must be the name of an existing Amazon SageMaker model in the same AWS Region and AWS account. For information on creating a model, see CreateModel.

    • TransformInput - Describes the dataset to be transformed and the Amazon S3 location where it is stored.

    • TransformOutput - Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

    • TransformResources - Identifies the ML compute instances for the transform job.

    For more information about how batch transformation works Amazon SageMaker, see How It Works.

    " + }, + "CreateWorkteam":{ + "name":"CreateWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkteamRequest"}, + "output":{"shape":"CreateWorkteamResponse"}, + "errors":[ + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

    You cannot create more than 25 work teams in an account and region.

    " + }, + "DeleteAlgorithm":{ + "name":"DeleteAlgorithm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAlgorithmInput"}, + "documentation":"

    Removes the specified algorithm from your account.

    " + }, + "DeleteCodeRepository":{ + "name":"DeleteCodeRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCodeRepositoryInput"}, + "documentation":"

    Deletes the specified Git repository from your account.

    " + }, + "DeleteEndpoint":{ + "name":"DeleteEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointInput"}, + "documentation":"

    Deletes an endpoint. Amazon SageMaker frees up all of the resources that were deployed when the endpoint was created.

    Amazon SageMaker retires any custom KMS key grants associated with the endpoint, meaning you don't need to use the RevokeGrant API call.

    " + }, + "DeleteEndpointConfig":{ + "name":"DeleteEndpointConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointConfigInput"}, + "documentation":"

    Deletes an endpoint configuration. The DeleteEndpointConfig API deletes only the specified configuration. It does not delete endpoints created using the configuration.

    " + }, + "DeleteModel":{ + "name":"DeleteModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteModelInput"}, + "documentation":"

    Deletes a model. The DeleteModel API deletes only the model entry that was created in Amazon SageMaker when you called the CreateModel API. It does not delete model artifacts, inference code, or the IAM role that you specified when creating the model.

    " + }, + "DeleteModelPackage":{ + "name":"DeleteModelPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteModelPackageInput"}, + "documentation":"

    Deletes a model package.

    A model package is used to create Amazon SageMaker models or list on AWS Marketplace. Buyers can subscribe to model packages listed on AWS Marketplace to create models in Amazon SageMaker.

    " + }, + "DeleteNotebookInstance":{ + "name":"DeleteNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNotebookInstanceInput"}, + "documentation":"

    Deletes an Amazon SageMaker notebook instance. Before you can delete a notebook instance, you must call the StopNotebookInstance API.

    When you delete a notebook instance, you lose all of your data. Amazon SageMaker removes the ML compute instance, and deletes the ML storage volume and the network interface associated with the notebook instance.

    " + }, + "DeleteNotebookInstanceLifecycleConfig":{ + "name":"DeleteNotebookInstanceLifecycleConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNotebookInstanceLifecycleConfigInput"}, + "documentation":"

    Deletes a notebook instance lifecycle configuration.

    " + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsInput"}, + "output":{"shape":"DeleteTagsOutput"}, + "documentation":"

    Deletes the specified tags from an Amazon SageMaker resource.

    To list a resource's tags, use the ListTags API.

    When you call this API to delete tags from a hyperparameter tuning job, the deleted tags are not removed from training jobs that the hyperparameter tuning job launched before you called this API.

    " + }, + "DeleteWorkteam":{ + "name":"DeleteWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkteamRequest"}, + "output":{"shape":"DeleteWorkteamResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Deletes an existing work team. This operation can't be undone.

    " + }, + "DescribeAlgorithm":{ + "name":"DescribeAlgorithm", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAlgorithmInput"}, + "output":{"shape":"DescribeAlgorithmOutput"}, + "documentation":"

    Returns a description of the specified algorithm that is in your account.

    " + }, + "DescribeCodeRepository":{ + "name":"DescribeCodeRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCodeRepositoryInput"}, + "output":{"shape":"DescribeCodeRepositoryOutput"}, + "documentation":"

    Gets details about the specified Git repository.

    " + }, + "DescribeCompilationJob":{ + "name":"DescribeCompilationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCompilationJobRequest"}, + "output":{"shape":"DescribeCompilationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Returns information about a model compilation job.

    To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.

    " + }, + "DescribeEndpoint":{ + "name":"DescribeEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointInput"}, + "output":{"shape":"DescribeEndpointOutput"}, + "documentation":"

    Returns the description of an endpoint.

    " + }, + "DescribeEndpointConfig":{ + "name":"DescribeEndpointConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEndpointConfigInput"}, + "output":{"shape":"DescribeEndpointConfigOutput"}, + "documentation":"

    Returns the description of an endpoint configuration created using the CreateEndpointConfig API.

    " + }, + "DescribeHyperParameterTuningJob":{ + "name":"DescribeHyperParameterTuningJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeHyperParameterTuningJobRequest"}, + "output":{"shape":"DescribeHyperParameterTuningJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Gets a description of a hyperparameter tuning job.

    " + }, + "DescribeLabelingJob":{ + "name":"DescribeLabelingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeLabelingJobRequest"}, + "output":{"shape":"DescribeLabelingJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Gets information about a labeling job.

    " + }, + "DescribeModel":{ + "name":"DescribeModel", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeModelInput"}, + "output":{"shape":"DescribeModelOutput"}, + "documentation":"

    Describes a model that you created using the CreateModel API.

    " + }, + "DescribeModelPackage":{ + "name":"DescribeModelPackage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeModelPackageInput"}, + "output":{"shape":"DescribeModelPackageOutput"}, + "documentation":"

    Returns a description of the specified model package, which is used to create Amazon SageMaker models or list them on AWS Marketplace.

    To create models in Amazon SageMaker, buyers can subscribe to model packages listed on AWS Marketplace.

    " + }, + "DescribeNotebookInstance":{ + "name":"DescribeNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNotebookInstanceInput"}, + "output":{"shape":"DescribeNotebookInstanceOutput"}, + "documentation":"

    Returns information about a notebook instance.

    " + }, + "DescribeNotebookInstanceLifecycleConfig":{ + "name":"DescribeNotebookInstanceLifecycleConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNotebookInstanceLifecycleConfigInput"}, + "output":{"shape":"DescribeNotebookInstanceLifecycleConfigOutput"}, + "documentation":"

    Returns a description of a notebook instance lifecycle configuration.

    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "DescribeSubscribedWorkteam":{ + "name":"DescribeSubscribedWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubscribedWorkteamRequest"}, + "output":{"shape":"DescribeSubscribedWorkteamResponse"}, + "documentation":"

    Gets information about a work team provided by a vendor. It returns details about the subscription with a vendor in the AWS Marketplace.

    " + }, + "DescribeTrainingJob":{ + "name":"DescribeTrainingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrainingJobRequest"}, + "output":{"shape":"DescribeTrainingJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Returns information about a training job.

    " + }, + "DescribeTransformJob":{ + "name":"DescribeTransformJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTransformJobRequest"}, + "output":{"shape":"DescribeTransformJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Returns information about a transform job.

    " + }, + "DescribeWorkteam":{ + "name":"DescribeWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkteamRequest"}, + "output":{"shape":"DescribeWorkteamResponse"}, + "documentation":"

    Gets information about a specific work team. You can see information such as the create date, the last updated date, membership information, and the work team's Amazon Resource Name (ARN).

    " + }, + "GetSearchSuggestions":{ + "name":"GetSearchSuggestions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSearchSuggestionsRequest"}, + "output":{"shape":"GetSearchSuggestionsResponse"}, + "documentation":"

    An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search queries. Provides suggestions for HyperParameters, Tags, and Metrics.

    " + }, + "ListAlgorithms":{ + "name":"ListAlgorithms", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAlgorithmsInput"}, + "output":{"shape":"ListAlgorithmsOutput"}, + "documentation":"

    Lists the machine learning algorithms that have been created.

    " + }, + "ListCodeRepositories":{ + "name":"ListCodeRepositories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCodeRepositoriesInput"}, + "output":{"shape":"ListCodeRepositoriesOutput"}, + "documentation":"

    Gets a list of the Git repositories in your account.

    " + }, + "ListCompilationJobs":{ + "name":"ListCompilationJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCompilationJobsRequest"}, + "output":{"shape":"ListCompilationJobsResponse"}, + "documentation":"

    Lists model compilation jobs that satisfy various filters.

    To create a model compilation job, use CreateCompilationJob. To get information about a particular model compilation job you have created, use DescribeCompilationJob.

    " + }, + "ListEndpointConfigs":{ + "name":"ListEndpointConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEndpointConfigsInput"}, + "output":{"shape":"ListEndpointConfigsOutput"}, + "documentation":"

    Lists endpoint configurations.

    " + }, + "ListEndpoints":{ + "name":"ListEndpoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEndpointsInput"}, + "output":{"shape":"ListEndpointsOutput"}, + "documentation":"

    Lists endpoints.

    " + }, + "ListHyperParameterTuningJobs":{ + "name":"ListHyperParameterTuningJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHyperParameterTuningJobsRequest"}, + "output":{"shape":"ListHyperParameterTuningJobsResponse"}, + "documentation":"

    Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

    " + }, + "ListLabelingJobs":{ + "name":"ListLabelingJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLabelingJobsRequest"}, + "output":{"shape":"ListLabelingJobsResponse"}, + "documentation":"

    Gets a list of labeling jobs.

    " + }, + "ListLabelingJobsForWorkteam":{ + "name":"ListLabelingJobsForWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLabelingJobsForWorkteamRequest"}, + "output":{"shape":"ListLabelingJobsForWorkteamResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Gets a list of labeling jobs assigned to a specified work team.

    " + }, + "ListModelPackages":{ + "name":"ListModelPackages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelPackagesInput"}, + "output":{"shape":"ListModelPackagesOutput"}, + "documentation":"

    Lists the model packages that have been created.

    " + }, + "ListModels":{ + "name":"ListModels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListModelsInput"}, + "output":{"shape":"ListModelsOutput"}, + "documentation":"

    Lists models created with the CreateModel API.

    " + }, + "ListNotebookInstanceLifecycleConfigs":{ + "name":"ListNotebookInstanceLifecycleConfigs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListNotebookInstanceLifecycleConfigsInput"}, + "output":{"shape":"ListNotebookInstanceLifecycleConfigsOutput"}, + "documentation":"

    Lists notebook instance lifestyle configurations created with the CreateNotebookInstanceLifecycleConfig API.

    " + }, + "ListNotebookInstances":{ + "name":"ListNotebookInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListNotebookInstancesInput"}, + "output":{"shape":"ListNotebookInstancesOutput"}, + "documentation":"

    Returns a list of the Amazon SageMaker notebook instances in the requester's account in an AWS Region.

    " + }, + "ListSubscribedWorkteams":{ + "name":"ListSubscribedWorkteams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSubscribedWorkteamsRequest"}, + "output":{"shape":"ListSubscribedWorkteamsResponse"}, + "documentation":"

    Gets a list of the work teams that you are subscribed to in the AWS Marketplace. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

    " + }, + "ListTags":{ + "name":"ListTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsInput"}, + "output":{"shape":"ListTagsOutput"}, + "documentation":"

    Returns the tags for the specified Amazon SageMaker resource.

    " + }, + "ListTrainingJobs":{ + "name":"ListTrainingJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTrainingJobsRequest"}, + "output":{"shape":"ListTrainingJobsResponse"}, + "documentation":"

    Lists training jobs.

    " + }, + "ListTrainingJobsForHyperParameterTuningJob":{ + "name":"ListTrainingJobsForHyperParameterTuningJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTrainingJobsForHyperParameterTuningJobRequest"}, + "output":{"shape":"ListTrainingJobsForHyperParameterTuningJobResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Gets a list of TrainingJobSummary objects that describe the training jobs that a hyperparameter tuning job launched.

    " + }, + "ListTransformJobs":{ + "name":"ListTransformJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTransformJobsRequest"}, + "output":{"shape":"ListTransformJobsResponse"}, + "documentation":"

    Lists transform jobs.

    " + }, + "ListWorkteams":{ + "name":"ListWorkteams", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkteamsRequest"}, + "output":{"shape":"ListWorkteamsResponse"}, + "documentation":"

    Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

    " + }, + "RenderUiTemplate":{ + "name":"RenderUiTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RenderUiTemplateRequest"}, + "output":{"shape":"RenderUiTemplateResponse"}, + "documentation":"

    Renders the UI template so that you can preview the worker's experience.

    " + }, + "Search":{ + "name":"Search", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchRequest"}, + "output":{"shape":"SearchResponse"}, + "documentation":"

    Finds Amazon SageMaker resources that match a search query. Matching resource objects are returned as a list of SearchResult objects in the response. You can sort the search results by any resource property in a ascending or descending order.

    You can query against the following value types: numerical, text, Booleans, and timestamps.

    " + }, + "StartNotebookInstance":{ + "name":"StartNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartNotebookInstanceInput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, Amazon SageMaker sets the notebook instance status to InService. A notebook instance's status must be InService before you can connect to your Jupyter notebook.

    " + }, + "StopCompilationJob":{ + "name":"StopCompilationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopCompilationJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Stops a model compilation job.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.

    When it receives a StopCompilationJob request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped.

    " + }, + "StopHyperParameterTuningJob":{ + "name":"StopHyperParameterTuningJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopHyperParameterTuningJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

    All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

    " + }, + "StopLabelingJob":{ + "name":"StopLabelingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopLabelingJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Stops a running labeling job. A job that is stopped cannot be restarted. Any results obtained before the job is stopped are placed in the Amazon S3 output bucket.

    " + }, + "StopNotebookInstance":{ + "name":"StopNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopNotebookInstanceInput"}, + "documentation":"

    Terminates the ML compute instance. Before terminating the instance, Amazon SageMaker disconnects the ML storage volume from it. Amazon SageMaker preserves the ML storage volume. Amazon SageMaker stops charging you for the ML compute instance when you call StopNotebookInstance.

    To access data on the ML storage volume for a notebook instance that has been terminated, call the StartNotebookInstance API. StartNotebookInstance launches another ML compute instance, configures it, and attaches the preserved ML storage volume so you can continue your work.

    " + }, + "StopTrainingJob":{ + "name":"StopTrainingJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTrainingJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Stops a training job. To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms might use this 120-second window to save the model artifacts, so the results of the training is not lost.

    When it receives a StopTrainingJob request, Amazon SageMaker changes the status of the job to Stopping. After Amazon SageMaker stops the job, it sets the status to Stopped.

    " + }, + "StopTransformJob":{ + "name":"StopTransformJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopTransformJobRequest"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Stops a transform job.

    When Amazon SageMaker receives a StopTransformJob request, the status of the job changes to Stopping. After Amazon SageMaker stops the job, the status is set to Stopped. When you stop a transform job before it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.

    " + }, + "UpdateCodeRepository":{ + "name":"UpdateCodeRepository", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCodeRepositoryInput"}, + "output":{"shape":"UpdateCodeRepositoryOutput"}, + "documentation":"

    Updates the specified Git repository with the specified values.

    " + }, + "UpdateEndpoint":{ + "name":"UpdateEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEndpointInput"}, + "output":{"shape":"UpdateEndpointOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss).

    When Amazon SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

    You must not delete an EndpointConfig in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig.

    " + }, + "UpdateEndpointWeightsAndCapacities":{ + "name":"UpdateEndpointWeightsAndCapacities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEndpointWeightsAndCapacitiesInput"}, + "output":{"shape":"UpdateEndpointWeightsAndCapacitiesOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Updates variant weight of one or more variants associated with an existing endpoint, or capacity of one variant associated with an existing endpoint. When it receives the request, Amazon SageMaker sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API.

    " + }, + "UpdateNotebookInstance":{ + "name":"UpdateNotebookInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNotebookInstanceInput"}, + "output":{"shape":"UpdateNotebookInstanceOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Updates a notebook instance. NotebookInstance updates include upgrading or downgrading the ML compute instance used for your notebook instance to accommodate changes in your workload requirements.

    " + }, + "UpdateNotebookInstanceLifecycleConfig":{ + "name":"UpdateNotebookInstanceLifecycleConfig", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNotebookInstanceLifecycleConfigInput"}, + "output":{"shape":"UpdateNotebookInstanceLifecycleConfigOutput"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Updates a notebook instance lifecycle configuration created with the CreateNotebookInstanceLifecycleConfig API.

    " + }, + "UpdateWorkteam":{ + "name":"UpdateWorkteam", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWorkteamRequest"}, + "output":{"shape":"UpdateWorkteamResponse"}, + "errors":[ + {"shape":"ResourceLimitExceeded"} + ], + "documentation":"

    Updates an existing work team with new member definitions or description.

    " + } + }, + "shapes":{ + "Accept":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "AccountId":{ + "type":"string", + "pattern":"^\\d+$" + }, + "AddTagsInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource that you want to tag.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of Tag objects. Each tag is a key-value pair. Only the key parameter is required. If you don't specify a value, Amazon SageMaker sets the value to an empty string.

    " + } + } + }, + "AddTagsOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tags associated with the Amazon SageMaker resource.

    " + } + } + }, + "AdditionalCodeRepositoryNamesOrUrls":{ + "type":"list", + "member":{"shape":"CodeRepositoryNameOrUrl"}, + "max":3 + }, + "AlgorithmArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:algorithm/.*" + }, + "AlgorithmImage":{ + "type":"string", + "max":255, + "pattern":".*" + }, + "AlgorithmSortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, + "AlgorithmSpecification":{ + "type":"structure", + "required":["TrainingInputMode"], + "members":{ + "TrainingImage":{ + "shape":"AlgorithmImage", + "documentation":"

    The registry path of the Docker image that contains the training algorithm. For information about docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

    " + }, + "AlgorithmName":{ + "shape":"ArnOrName", + "documentation":"

    The name of the algorithm resource to use for the training job. This must be an algorithm resource that you created or subscribe to on AWS Marketplace. If you specify a value for this parameter, you can't specify a value for TrainingImage.

    " + }, + "TrainingInputMode":{ + "shape":"TrainingInputMode", + "documentation":"

    The input mode that the algorithm supports. For the input modes that Amazon SageMaker algorithms support, see Algorithms. If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

    In File mode, make sure you provision ML storage volume with sufficient capacity to accommodate the data download from S3. In addition to the training data, the ML storage volume also stores the output model. The algorithm container use ML storage volume to also store intermediate information, if any.

    For distributed algorithms using File mode, training data is distributed uniformly, and your training duration is predictable if the input data objects size is approximately same. Amazon SageMaker does not split the files any further for model training. If the object sizes are skewed, training won't be optimal as the data distribution is also skewed where one host in a training cluster is overloaded, thus becoming bottleneck in training.

    " + }, + "MetricDefinitions":{ + "shape":"MetricDefinitionList", + "documentation":"

    A list of metric definition objects. Each object specifies the metric name and regular expressions used to parse algorithm logs. Amazon SageMaker publishes each metric to Amazon CloudWatch.

    " + } + }, + "documentation":"

    Specifies the training algorithm to use in a CreateTrainingJob request.

    For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about using your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

    " + }, + "AlgorithmStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Completed", + "Failed", + "Deleting" + ] + }, + "AlgorithmStatusDetails":{ + "type":"structure", + "members":{ + "ValidationStatuses":{ + "shape":"AlgorithmStatusItemList", + "documentation":"

    The status of algorithm validation.

    " + }, + "ImageScanStatuses":{ + "shape":"AlgorithmStatusItemList", + "documentation":"

    The status of the scan of the algorithm's Docker image container.

    " + } + }, + "documentation":"

    Specifies the validation and image scan statuses of the algorithm.

    " + }, + "AlgorithmStatusItem":{ + "type":"structure", + "required":[ + "Name", + "Status" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"

    The name of the algorithm for which the overall status is being reported.

    " + }, + "Status":{ + "shape":"DetailedAlgorithmStatus", + "documentation":"

    The current status.

    " + }, + "FailureReason":{ + "shape":"String", + "documentation":"

    if the overall status is Failed, the reason for the failure.

    " + } + }, + "documentation":"

    Represents the overall status of an algorithm.

    " + }, + "AlgorithmStatusItemList":{ + "type":"list", + "member":{"shape":"AlgorithmStatusItem"} + }, + "AlgorithmSummary":{ + "type":"structure", + "required":[ + "AlgorithmName", + "AlgorithmArn", + "CreationTime", + "AlgorithmStatus" + ], + "members":{ + "AlgorithmName":{ + "shape":"EntityName", + "documentation":"

    The name of the algorithm that is described by the summary.

    " + }, + "AlgorithmArn":{ + "shape":"AlgorithmArn", + "documentation":"

    The Amazon Resource Name (ARN) of the algorithm.

    " + }, + "AlgorithmDescription":{ + "shape":"EntityDescription", + "documentation":"

    A brief description of the algorithm.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp that shows when the algorithm was created.

    " + }, + "AlgorithmStatus":{ + "shape":"AlgorithmStatus", + "documentation":"

    The overall status of the algorithm.

    " + } + }, + "documentation":"

    Provides summary information about an algorithm.

    " + }, + "AlgorithmSummaryList":{ + "type":"list", + "member":{"shape":"AlgorithmSummary"} + }, + "AlgorithmValidationProfile":{ + "type":"structure", + "required":[ + "ProfileName", + "TrainingJobDefinition" + ], + "members":{ + "ProfileName":{ + "shape":"EntityName", + "documentation":"

    The name of the profile for the algorithm. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    " + }, + "TrainingJobDefinition":{ + "shape":"TrainingJobDefinition", + "documentation":"

    The TrainingJobDefinition object that describes the training job that Amazon SageMaker runs to validate your algorithm.

    " + }, + "TransformJobDefinition":{ + "shape":"TransformJobDefinition", + "documentation":"

    The TransformJobDefinition object that describes the transform job that Amazon SageMaker runs to validate your algorithm.

    " + } + }, + "documentation":"

    Defines a training job and a batch transform job that Amazon SageMaker runs to validate your algorithm.

    The data provided in the validation profile is made available to your buyers on AWS Marketplace.

    " + }, + "AlgorithmValidationProfiles":{ + "type":"list", + "member":{"shape":"AlgorithmValidationProfile"}, + "max":1, + "min":1 + }, + "AlgorithmValidationSpecification":{ + "type":"structure", + "required":[ + "ValidationRole", + "ValidationProfiles" + ], + "members":{ + "ValidationRole":{ + "shape":"RoleArn", + "documentation":"

    The IAM roles that Amazon SageMaker uses to run the training jobs.

    " + }, + "ValidationProfiles":{ + "shape":"AlgorithmValidationProfiles", + "documentation":"

    An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that Amazon SageMaker runs to validate your algorithm.

    " + } + }, + "documentation":"

    Specifies configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

    " + }, + "AnnotationConsolidationConfig":{ + "type":"structure", + "required":["AnnotationConsolidationLambdaArn"], + "members":{ + "AnnotationConsolidationLambdaArn":{ + "shape":"LambdaFunctionArn", + "documentation":"

    The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.

    For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

    • Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

      arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

      arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

      arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

      arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

      arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

      arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

      arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

      arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

      arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

      arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

      arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

      arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

    • Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

      arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

      arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

      arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

      arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

      arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

      arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

      arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

      arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

      arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

      arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

      arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

      arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

    • Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

      arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

      arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

      arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

      arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

      arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

      arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

      arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

      arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

      arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

      arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

      arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

      arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

    • Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

      arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

      arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

      arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

      arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

      arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

      arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

      arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

      arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

      arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

      arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

      arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

      arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

    • Named entity eecognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

      arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

      arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

      arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

      arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

      arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

      arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

      arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

    For more information, see Annotation Consolidation.

    " + } + }, + "documentation":"

    Configures how labels are consolidated across human workers.

    " + }, + "ArnOrName":{ + "type":"string", + "max":170, + "min":1, + "pattern":"(arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:[a-z\\-]*\\/)?([a-zA-Z0-9]([a-zA-Z0-9-]){0,62})(?The name of the categorical hyperparameter to tune.

    " + }, + "Values":{ + "shape":"ParameterValues", + "documentation":"

    A list of the categories for the hyperparameter.

    " + } + }, + "documentation":"

    A list of categorical hyperparameters to tune.

    " + }, + "CategoricalParameterRangeSpecification":{ + "type":"structure", + "required":["Values"], + "members":{ + "Values":{ + "shape":"ParameterValues", + "documentation":"

    The allowed categories for the hyperparameter.

    " + } + }, + "documentation":"

    Defines the possible values for a categorical hyperparameter.

    " + }, + "CategoricalParameterRanges":{ + "type":"list", + "member":{"shape":"CategoricalParameterRange"}, + "max":20, + "min":0 + }, + "Cents":{ + "type":"integer", + "max":99, + "min":0 + }, + "CertifyForMarketplace":{"type":"boolean"}, + "Channel":{ + "type":"structure", + "required":[ + "ChannelName", + "DataSource" + ], + "members":{ + "ChannelName":{ + "shape":"ChannelName", + "documentation":"

    The name of the channel.

    " + }, + "DataSource":{ + "shape":"DataSource", + "documentation":"

    The location of the channel data.

    " + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    The MIME type of the data.

    " + }, + "CompressionType":{ + "shape":"CompressionType", + "documentation":"

    If training data is compressed, the compression type. The default value is None. CompressionType is used only in Pipe input mode. In File mode, leave this field unset or set it to None.

    " + }, + "RecordWrapperType":{ + "shape":"RecordWrapper", + "documentation":"

    Specify RecordIO as the value when input data is in raw format but the training algorithm requires the RecordIO format. In this case, Amazon SageMaker wraps each individual S3 object in a RecordIO record. If the input data is already in RecordIO format, you don't need to set this attribute. For more information, see Create a Dataset Using RecordIO.

    In File mode, leave this field unset or set it to None.

    " + }, + "InputMode":{ + "shape":"TrainingInputMode", + "documentation":"

    (Optional) The input mode to use for the data channel in a training job. If you don't set a value for InputMode, Amazon SageMaker uses the value set for TrainingInputMode. Use this parameter to override the TrainingInputMode setting in a AlgorithmSpecification request when you have a channel that needs a different input mode from the training job's general setting. To download the data from Amazon Simple Storage Service (Amazon S3) to the provisioned ML storage volume, and mount the directory to a Docker volume, use File input mode. To stream data directly from Amazon S3 to the container, choose Pipe input mode.

    To use a model for incremental training, choose File input model.

    " + }, + "ShuffleConfig":{ + "shape":"ShuffleConfig", + "documentation":"

    A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, this shuffles the results of the S3 key prefix matches. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

    For Pipe input mode, shuffling is done at the start of every epoch. With large datasets this ensures that the order of the training data is different for each epoch, it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

    " + } + }, + "documentation":"

    A channel is a named input source that training algorithms can consume.

    " + }, + "ChannelName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[A-Za-z0-9\\.\\-_]+" + }, + "ChannelSpecification":{ + "type":"structure", + "required":[ + "Name", + "SupportedContentTypes", + "SupportedInputModes" + ], + "members":{ + "Name":{ + "shape":"ChannelName", + "documentation":"

    The name of the channel.

    " + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"

    A brief description of the channel.

    " + }, + "IsRequired":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the channel is required by the algorithm.

    " + }, + "SupportedContentTypes":{ + "shape":"ContentTypes", + "documentation":"

    The supported MIME types for the data.

    " + }, + "SupportedCompressionTypes":{ + "shape":"CompressionTypes", + "documentation":"

    The allowed compression types, if data compression is used.

    " + }, + "SupportedInputModes":{ + "shape":"InputModes", + "documentation":"

    The allowed input mode, either FILE or PIPE.

    In FILE mode, Amazon SageMaker copies the data from the input source onto the local Amazon Elastic Block Store (Amazon EBS) volumes before starting your training algorithm. This is the most commonly used input mode.

    In PIPE mode, Amazon SageMaker streams input data from the source directly to your algorithm without using the EBS volume.

    " + } + }, + "documentation":"

    Defines a named input source, called a channel, to be used by an algorithm.

    " + }, + "ChannelSpecifications":{ + "type":"list", + "member":{"shape":"ChannelSpecification"}, + "max":8, + "min":1 + }, + "CheckpointConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

    Identifies the S3 path where you want Amazon SageMaker to store checkpoints. For example, s3://bucket-name/key-name-prefix.

    " + }, + "LocalPath":{ + "shape":"DirectoryPath", + "documentation":"

    (Optional) The local directory where checkpoints are written. The default directory is /opt/ml/checkpoints/.

    " + } + }, + "documentation":"

    Contains information about the output location for managed spot training checkpoint data.

    " + }, + "CodeRepositoryArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:code-repository/.*" + }, + "CodeRepositoryContains":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z0-9-]+" + }, + "CodeRepositoryNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "CodeRepositoryNameOrUrl":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^https://([^/]+)/?(.*)$|^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "CodeRepositorySortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "LastModifiedTime" + ] + }, + "CodeRepositorySortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "CodeRepositorySummary":{ + "type":"structure", + "required":[ + "CodeRepositoryName", + "CodeRepositoryArn", + "CreationTime", + "LastModifiedTime" + ], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository.

    " + }, + "CodeRepositoryArn":{ + "shape":"CodeRepositoryArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Git repository.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    The date and time that the Git repository was created.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    The date and time that the Git repository was last modified.

    " + }, + "GitConfig":{ + "shape":"GitConfig", + "documentation":"

    Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

    " + } + }, + "documentation":"

    Specifies summary information about a Git repository.

    " + }, + "CodeRepositorySummaryList":{ + "type":"list", + "member":{"shape":"CodeRepositorySummary"} + }, + "CognitoClientId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+]+" + }, + "CognitoMemberDefinition":{ + "type":"structure", + "required":[ + "UserPool", + "UserGroup", + "ClientId" + ], + "members":{ + "UserPool":{ + "shape":"CognitoUserPool", + "documentation":"

    An identifier for a user pool. The user pool must be in the same region as the service that you are calling.

    " + }, + "UserGroup":{ + "shape":"CognitoUserGroup", + "documentation":"

    An identifier for a user group.

    " + }, + "ClientId":{ + "shape":"CognitoClientId", + "documentation":"

    An identifier for an application client. You must create the app client ID using Amazon Cognito.

    " + } + }, + "documentation":"

    Identifies a Amazon Cognito user group. A user group can be used in on or more work teams.

    " + }, + "CognitoUserGroup":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+" + }, + "CognitoUserPool":{ + "type":"string", + "max":55, + "min":1, + "pattern":"[\\w-]+_[0-9a-zA-Z]+" + }, + "CompilationJobArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:compilation-job/.*" + }, + "CompilationJobStatus":{ + "type":"string", + "enum":[ + "INPROGRESS", + "COMPLETED", + "FAILED", + "STARTING", + "STOPPING", + "STOPPED" + ] + }, + "CompilationJobSummaries":{ + "type":"list", + "member":{"shape":"CompilationJobSummary"} + }, + "CompilationJobSummary":{ + "type":"structure", + "required":[ + "CompilationJobName", + "CompilationJobArn", + "CreationTime", + "CompilationTargetDevice", + "CompilationJobStatus" + ], + "members":{ + "CompilationJobName":{ + "shape":"EntityName", + "documentation":"

    The name of the model compilation job that you want a summary for.

    " + }, + "CompilationJobArn":{ + "shape":"CompilationJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model compilation job.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    The time when the model compilation job was created.

    " + }, + "CompilationStartTime":{ + "shape":"Timestamp", + "documentation":"

    The time when the model compilation job started.

    " + }, + "CompilationEndTime":{ + "shape":"Timestamp", + "documentation":"

    The time when the model compilation job completed.

    " + }, + "CompilationTargetDevice":{ + "shape":"TargetDevice", + "documentation":"

    The type of device that the model will run on after compilation has completed.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    The time when the model compilation job was last modified.

    " + }, + "CompilationJobStatus":{ + "shape":"CompilationJobStatus", + "documentation":"

    The status of the model compilation job.

    " + } + }, + "documentation":"

    A summary of a model compilation job.

    " + }, + "CompressionType":{ + "type":"string", + "enum":[ + "None", + "Gzip" + ] + }, + "CompressionTypes":{ + "type":"list", + "member":{"shape":"CompressionType"} + }, + "ContainerDefinition":{ + "type":"structure", + "members":{ + "ContainerHostname":{ + "shape":"ContainerHostname", + "documentation":"

    This parameter is ignored for models that contain only a PrimaryContainer.

    When a ContainerDefinition is part of an inference pipeline, the value of ths parameter uniquely identifies the container for the purposes of logging and metrics. For information, see Use Logs and Metrics to Monitor an Inference Pipeline. If you don't specify a value for this parameter for a ContainerDefinition that is part of an inference pipeline, a unique name is automatically assigned based on the position of the ContainerDefinition in the pipeline. If you specify a value for the ContainerHostName for any ContainerDefinition that is part of an inference pipeline, you must specify a value for the ContainerHostName parameter of every ContainerDefinition in that pipeline.

    " + }, + "Image":{ + "shape":"Image", + "documentation":"

    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored. If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker

    " + }, + "ModelDataUrl":{ + "shape":"Url", + "documentation":"

    The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for Amazon SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.

    If you provide a value for this parameter, Amazon SageMaker uses AWS Security Token Service to download model artifacts from the S3 path you provide. AWS STS is activated in your IAM user account by default. If you previously deactivated AWS STS for a region, you need to reactivate AWS STS for that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

    If you use a built-in algorithm to create a model, Amazon SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl.

    " + }, + "Environment":{ + "shape":"EnvironmentMap", + "documentation":"

    The environment variables to set in the Docker container. Each key and value in the Environment string to string map can have length of up to 1024. We support up to 16 entries in the map.

    " + }, + "ModelPackageName":{ + "shape":"ArnOrName", + "documentation":"

    The name or Amazon Resource Name (ARN) of the model package to use to create the model.

    " + } + }, + "documentation":"

    Describes the container, as part of model definition.

    " + }, + "ContainerDefinitionList":{ + "type":"list", + "member":{"shape":"ContainerDefinition"}, + "max":5 + }, + "ContainerHostname":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "ContentClassifier":{ + "type":"string", + "enum":[ + "FreeOfPersonallyIdentifiableInformation", + "FreeOfAdultContent" + ] + }, + "ContentClassifiers":{ + "type":"list", + "member":{"shape":"ContentClassifier"}, + "max":256 + }, + "ContentType":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "ContentTypes":{ + "type":"list", + "member":{"shape":"ContentType"} + }, + "ContinuousParameterRange":{ + "type":"structure", + "required":[ + "Name", + "MinValue", + "MaxValue" + ], + "members":{ + "Name":{ + "shape":"ParameterKey", + "documentation":"

    The name of the continuous hyperparameter to tune.

    " + }, + "MinValue":{ + "shape":"ParameterValue", + "documentation":"

    The minimum value for the hyperparameter. The tuning job uses floating-point values between this value and MaxValuefor tuning.

    " + }, + "MaxValue":{ + "shape":"ParameterValue", + "documentation":"

    The maximum value for the hyperparameter. The tuning job uses floating-point values between MinValue value and this value for tuning.

    " + }, + "ScalingType":{ + "shape":"HyperParameterScalingType", + "documentation":"

    The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    Auto

    Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

    Linear

    Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

    Logarithmic

    Hyperparameter tuning searches the values in the hyperparameter range by using a logarithmic scale.

    Logarithmic scaling works only for ranges that have only values greater than 0.

    ReverseLogarithmic

    Hyperparemeter tuning searches the values in the hyperparameter range by using a reverse logarithmic scale.

    Reverse logarithmic scaling works only for ranges that are entirely within the range 0<=x<1.0.

    " + } + }, + "documentation":"

    A list of continuous hyperparameters to tune.

    " + }, + "ContinuousParameterRangeSpecification":{ + "type":"structure", + "required":[ + "MinValue", + "MaxValue" + ], + "members":{ + "MinValue":{ + "shape":"ParameterValue", + "documentation":"

    The minimum floating-point value allowed.

    " + }, + "MaxValue":{ + "shape":"ParameterValue", + "documentation":"

    The maximum floating-point value allowed.

    " + } + }, + "documentation":"

    Defines the possible values for a continuous hyperparameter.

    " + }, + "ContinuousParameterRanges":{ + "type":"list", + "member":{"shape":"ContinuousParameterRange"}, + "max":20, + "min":0 + }, + "CreateAlgorithmInput":{ + "type":"structure", + "required":[ + "AlgorithmName", + "TrainingSpecification" + ], + "members":{ + "AlgorithmName":{ + "shape":"EntityName", + "documentation":"

    The name of the algorithm.

    " + }, + "AlgorithmDescription":{ + "shape":"EntityDescription", + "documentation":"

    A description of the algorithm.

    " + }, + "TrainingSpecification":{ + "shape":"TrainingSpecification", + "documentation":"

    Specifies details about training jobs run by this algorithm, including the following:

    • The Amazon ECR path of the container and the version digest of the algorithm.

    • The hyperparameters that the algorithm supports.

    • The instance types that the algorithm supports for training.

    • Whether the algorithm supports distributed training.

    • The metrics that the algorithm emits to Amazon CloudWatch.

    • Which metrics that the algorithm emits can be used as the objective metric for hyperparameter tuning jobs.

    • The input channels that the algorithm supports for training data. For example, an algorithm might support train, validation, and test channels.

    " + }, + "InferenceSpecification":{ + "shape":"InferenceSpecification", + "documentation":"

    Specifies details about inference jobs that the algorithm runs, including the following:

    • The Amazon ECR paths of containers that contain the inference code and model artifacts.

    • The instance types that the algorithm supports for transform jobs and real-time endpoints used for inference.

    • The input and output content formats that the algorithm supports for inference.

    " + }, + "ValidationSpecification":{ + "shape":"AlgorithmValidationSpecification", + "documentation":"

    Specifies configurations for one or more training jobs and that Amazon SageMaker runs to test the algorithm's training code and, optionally, one or more batch transform jobs that Amazon SageMaker runs to test the algorithm's inference code.

    " + }, + "CertifyForMarketplace":{ + "shape":"CertifyForMarketplace", + "documentation":"

    Whether to certify the algorithm so that it can be listed in AWS Marketplace.

    " + } + } + }, + "CreateAlgorithmOutput":{ + "type":"structure", + "required":["AlgorithmArn"], + "members":{ + "AlgorithmArn":{ + "shape":"AlgorithmArn", + "documentation":"

    The Amazon Resource Name (ARN) of the new algorithm.

    " + } + } + }, + "CreateCodeRepositoryInput":{ + "type":"structure", + "required":[ + "CodeRepositoryName", + "GitConfig" + ], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    " + }, + "GitConfig":{ + "shape":"GitConfig", + "documentation":"

    Specifies details about the repository, including the URL where the repository is located, the default branch, and credentials to use to access the repository.

    " + } + } + }, + "CreateCodeRepositoryOutput":{ + "type":"structure", + "required":["CodeRepositoryArn"], + "members":{ + "CodeRepositoryArn":{ + "shape":"CodeRepositoryArn", + "documentation":"

    The Amazon Resource Name (ARN) of the new repository.

    " + } + } + }, + "CreateCompilationJobRequest":{ + "type":"structure", + "required":[ + "CompilationJobName", + "RoleArn", + "InputConfig", + "OutputConfig", + "StoppingCondition" + ], + "members":{ + "CompilationJobName":{ + "shape":"EntityName", + "documentation":"

    A name for the model compilation job. The name must be unique within the AWS Region and within your AWS account.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

    During model compilation, Amazon SageMaker needs your permission to:

    • Read input data from an S3 bucket

    • Write model artifacts to an S3 bucket

    • Write logs to Amazon CloudWatch Logs

    • Publish metrics to Amazon CloudWatch

    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

    " + }, + "InputConfig":{ + "shape":"InputConfig", + "documentation":"

    Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

    " + }, + "OutputConfig":{ + "shape":"OutputConfig", + "documentation":"

    Provides information about the output location for the compiled model and the target device the model runs on.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

    " + } + } + }, + "CreateCompilationJobResponse":{ + "type":"structure", + "required":["CompilationJobArn"], + "members":{ + "CompilationJobArn":{ + "shape":"CompilationJobArn", + "documentation":"

    If the action is successful, the service sends back an HTTP 200 response. Amazon SageMaker returns the following data in JSON format:

    • CompilationJobArn: The Amazon Resource Name (ARN) of the compiled job.

    " + } + } + }, + "CreateEndpointConfigInput":{ + "type":"structure", + "required":[ + "EndpointConfigName", + "ProductionVariants" + ], + "members":{ + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the endpoint configuration. You specify this name in a CreateEndpoint request.

    " + }, + "ProductionVariants":{ + "shape":"ProductionVariantList", + "documentation":"

    An list of ProductionVariant objects, one for each model that you want to host at this endpoint.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint.

    Nitro-based instances do not support encryption with AWS KMS. If any of the models that you specify in the ProductionVariants parameter use nitro-based instances, do not specify a value for the KmsKeyId parameter. If you specify a value for KmsKeyId when using any nitro-based instances, the call to CreateEndpointConfig fails.

    For a list of nitro-based instances, see Nitro-based Instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.

    For more information about storage volumes on nitro-based instances, see Amazon EBS and NVMe on Linux Instances.

    " + } + } + }, + "CreateEndpointConfigOutput":{ + "type":"structure", + "required":["EndpointConfigArn"], + "members":{ + "EndpointConfigArn":{ + "shape":"EndpointConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint configuration.

    " + } + } + }, + "CreateEndpointInput":{ + "type":"structure", + "required":[ + "EndpointName", + "EndpointConfigName" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint. The name must be unique within an AWS Region in your AWS account.

    " + }, + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of an endpoint configuration. For more information, see CreateEndpointConfig.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs. For more information, see Using Cost Allocation Tagsin the AWS Billing and Cost Management User Guide.

    " + } + } + }, + "CreateEndpointOutput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint.

    " + } + } + }, + "CreateHyperParameterTuningJobRequest":{ + "type":"structure", + "required":[ + "HyperParameterTuningJobName", + "HyperParameterTuningJobConfig" + ], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job. This name is the prefix for the names of all training jobs that this tuning job launches. The name must be unique within the same AWS account and AWS Region. The name must have { } to { } characters. Valid characters are a-z, A-Z, 0-9, and : + = @ _ % - (hyphen). The name is not case sensitive.

    " + }, + "HyperParameterTuningJobConfig":{ + "shape":"HyperParameterTuningJobConfig", + "documentation":"

    The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see automatic-model-tuning

    " + }, + "TrainingJobDefinition":{ + "shape":"HyperParameterTrainingJobDefinition", + "documentation":"

    The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

    " + }, + "WarmStartConfig":{ + "shape":"HyperParameterTuningJobWarmStartConfig", + "documentation":"

    Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

    All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

    All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see AWS Tagging Strategies.

    Tags that you specify for the tuning job are also added to all training jobs that the tuning job launches.

    " + } + } + }, + "CreateHyperParameterTuningJobResponse":{ + "type":"structure", + "required":["HyperParameterTuningJobArn"], + "members":{ + "HyperParameterTuningJobArn":{ + "shape":"HyperParameterTuningJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the tuning job. Amazon SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

    " + } + } + }, + "CreateLabelingJobRequest":{ + "type":"structure", + "required":[ + "LabelingJobName", + "LabelAttributeName", + "InputConfig", + "OutputConfig", + "RoleArn", + "HumanTaskConfig" + ], + "members":{ + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name of the labeling job. This name is used to identify the job in a list of labeling jobs.

    " + }, + "LabelAttributeName":{ + "shape":"LabelAttributeName", + "documentation":"

    The attribute name to use for the label in the output manifest file. This is the key for the key/value pair formed with the label that a worker assigns to the object. The name can't end with \"-metadata\". If you are running a semantic segmentation labeling job, the attribute name must end with \"-ref\". If you are running any other kind of labeling job, the attribute name must not end with \"-ref\".

    " + }, + "InputConfig":{ + "shape":"LabelingJobInputConfig", + "documentation":"

    Input data for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

    " + }, + "OutputConfig":{ + "shape":"LabelingJobOutputConfig", + "documentation":"

    The location of the output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Number (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling. You must grant this role the necessary permissions so that Amazon SageMaker can successfully complete data labeling.

    " + }, + "LabelCategoryConfigS3Uri":{ + "shape":"S3Uri", + "documentation":"

    The S3 URL of the file that defines the categories used to label the data objects.

    The file is a JSON structure in the following format:

    {

    \"document-version\": \"2018-11-28\"

    \"labels\": [

    {

    \"label\": \"label 1\"

    },

    {

    \"label\": \"label 2\"

    },

    ...

    {

    \"label\": \"label n\"

    }

    ]

    }

    " + }, + "StoppingConditions":{ + "shape":"LabelingJobStoppingConditions", + "documentation":"

    A set of conditions for stopping the labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

    " + }, + "LabelingJobAlgorithmsConfig":{ + "shape":"LabelingJobAlgorithmsConfig", + "documentation":"

    Configures the information required to perform automated data labeling.

    " + }, + "HumanTaskConfig":{ + "shape":"HumanTaskConfig", + "documentation":"

    Configures the information required for human workers to complete a labeling task.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + } + } + }, + "CreateLabelingJobResponse":{ + "type":"structure", + "required":["LabelingJobArn"], + "members":{ + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the labeling job. You use this ARN to identify the labeling job.

    " + } + } + }, + "CreateModelInput":{ + "type":"structure", + "required":[ + "ModelName", + "ExecutionRoleArn" + ], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the new model.

    " + }, + "PrimaryContainer":{ + "shape":"ContainerDefinition", + "documentation":"

    The location of the primary docker image containing inference code, associated artifacts, and custom environment map that the inference code uses when the model is deployed for predictions.

    " + }, + "Containers":{ + "shape":"ContainerDefinitionList", + "documentation":"

    Specifies the containers in the inference pipeline.

    " + }, + "ExecutionRoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access model artifacts and docker image for deployment on ML compute instances or for batch transform jobs. Deploying on ML compute instances is part of model hosting. For more information, see Amazon SageMaker Roles.

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    A VpcConfig object that specifies the VPC that you want your model to connect to. Control access to and from your model container by configuring the VPC. VpcConfig is used in hosting services and in batch transform. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Data in Batch Transform Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    Isolates the model container. No inbound or outbound network calls can be made to or from the model container.

    The Semantic Segmentation built-in algorithm does not support network isolation.

    " + } + } + }, + "CreateModelOutput":{ + "type":"structure", + "required":["ModelArn"], + "members":{ + "ModelArn":{ + "shape":"ModelArn", + "documentation":"

    The ARN of the model created in Amazon SageMaker.

    " + } + } + }, + "CreateModelPackageInput":{ + "type":"structure", + "required":["ModelPackageName"], + "members":{ + "ModelPackageName":{ + "shape":"EntityName", + "documentation":"

    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    " + }, + "ModelPackageDescription":{ + "shape":"EntityDescription", + "documentation":"

    A description of the model package.

    " + }, + "InferenceSpecification":{ + "shape":"InferenceSpecification", + "documentation":"

    Specifies details about inference jobs that can be run with models based on this model package, including the following:

    • The Amazon ECR paths of containers that contain the inference code and model artifacts.

    • The instance types that the model package supports for transform jobs and real-time endpoints used for inference.

    • The input and output content formats that the model package supports for inference.

    " + }, + "ValidationSpecification":{ + "shape":"ModelPackageValidationSpecification", + "documentation":"

    Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

    " + }, + "SourceAlgorithmSpecification":{ + "shape":"SourceAlgorithmSpecification", + "documentation":"

    Details about the algorithm that was used to create the model package.

    " + }, + "CertifyForMarketplace":{ + "shape":"CertifyForMarketplace", + "documentation":"

    Whether to certify the model package for listing on AWS Marketplace.

    " + } + } + }, + "CreateModelPackageOutput":{ + "type":"structure", + "required":["ModelPackageArn"], + "members":{ + "ModelPackageArn":{ + "shape":"ModelPackageArn", + "documentation":"

    The Amazon Resource Name (ARN) of the new model package.

    " + } + } + }, + "CreateNotebookInstanceInput":{ + "type":"structure", + "required":[ + "NotebookInstanceName", + "InstanceType", + "RoleArn" + ], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the new notebook instance.

    " + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

    The type of ML compute instance to launch for the notebook instance.

    " + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The ID of the subnet in a VPC to which you would like to have a connectivity from your ML compute instance.

    " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

    The VPC security group IDs, in the form sg-xxxxxxxx. The security groups must be for the same VPC as specified in the subnet.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    When you send any requests to AWS resources from the notebook instance, Amazon SageMaker assumes this role to perform tasks on your behalf. You must grant this role necessary permissions so Amazon SageMaker can perform these tasks. The policy must allow the Amazon SageMaker service principal (sagemaker.amazonaws.com) permissionsto to assume this role. For more information, see Amazon SageMaker Roles.

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and Disabling Keys in the AWS Key Management Service Developer Guide.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    A list of tags to associate with the notebook instance. You can add tags later by using the CreateTags API.

    " + }, + "LifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "DirectInternetAccess":{ + "shape":"DirectInternetAccess", + "documentation":"

    Sets whether Amazon SageMaker provides internet access to the notebook instance. If you set this to Disabled this notebook instance will be able to access resources only in your VPC, and will not be able to connect to Amazon SageMaker training and endpoint services unless your configure a NAT Gateway in your VPC.

    For more information, see Notebook Instances Are Internet-Enabled by Default. You can set the value of this parameter to Disabled only if you set a value for the SubnetId parameter.

    " + }, + "VolumeSizeInGB":{ + "shape":"NotebookInstanceVolumeSizeInGB", + "documentation":"

    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB.

    " + }, + "AcceleratorTypes":{ + "shape":"NotebookInstanceAcceleratorTypes", + "documentation":"

    A list of Elastic Inference (EI) instance types to associate with this notebook instance. Currently, only one instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

    " + }, + "DefaultCodeRepository":{ + "shape":"CodeRepositoryNameOrUrl", + "documentation":"

    A Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "AdditionalCodeRepositories":{ + "shape":"AdditionalCodeRepositoryNamesOrUrls", + "documentation":"

    An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "RootAccess":{ + "shape":"RootAccess", + "documentation":"

    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

    Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

    " + } + } + }, + "CreateNotebookInstanceLifecycleConfigInput":{ + "type":"structure", + "required":["NotebookInstanceLifecycleConfigName"], + "members":{ + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration.

    " + }, + "OnCreate":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

    " + }, + "OnStart":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

    " + } + } + }, + "CreateNotebookInstanceLifecycleConfigOutput":{ + "type":"structure", + "members":{ + "NotebookInstanceLifecycleConfigArn":{ + "shape":"NotebookInstanceLifecycleConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    " + } + } + }, + "CreateNotebookInstanceOutput":{ + "type":"structure", + "members":{ + "NotebookInstanceArn":{ + "shape":"NotebookInstanceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the notebook instance.

    " + } + } + }, + "CreatePresignedNotebookInstanceUrlInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance.

    " + }, + "SessionExpirationDurationInSeconds":{ + "shape":"SessionExpirationDurationInSeconds", + "documentation":"

    The duration of the session, in seconds. The default is 12 hours.

    " + } + } + }, + "CreatePresignedNotebookInstanceUrlOutput":{ + "type":"structure", + "members":{ + "AuthorizedUrl":{ + "shape":"NotebookInstanceUrl", + "documentation":"

    A JSON object that contains the URL string.

    " + } + } + }, + "CreateTrainingJobRequest":{ + "type":"structure", + "required":[ + "TrainingJobName", + "AlgorithmSpecification", + "RoleArn", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job. The name must be unique within an AWS Region in an AWS account.

    " + }, + "HyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. For a list of hyperparameters for each training algorithm provided by Amazon SageMaker, see Algorithms.

    You can specify a maximum of 100 hyperparameters. Each hyperparameter is a key-value pair. Each key and value is limited to 256 characters, as specified by the Length Constraint.

    " + }, + "AlgorithmSpecification":{ + "shape":"AlgorithmSpecification", + "documentation":"

    The registry path of the Docker image that contains the training algorithm and algorithm-specific metadata, including the input mode. For more information about algorithms provided by Amazon SageMaker, see Algorithms. For information about providing your own algorithms, see Using Your Own Algorithms with Amazon SageMaker.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.

    During model training, Amazon SageMaker needs your permission to read input data from an S3 bucket, download a Docker image that contains training code, write model artifacts to an S3 bucket, write logs to Amazon CloudWatch Logs, and publish metrics to Amazon CloudWatch. You grant permissions for all of these tasks to an IAM role. For more information, see Amazon SageMaker Roles.

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

    " + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

    An array of Channel objects. Each channel is a named input source. InputDataConfig describes the input data and its location.

    Algorithms can accept input data from one or more channels. For example, an algorithm might have two channels of input data, training_data and validation_data. The configuration for each channel provides the S3, EFS, or FSx location where the input data is stored. It also provides information about the stored data: the MIME type, compression method, and whether the data is wrapped in RecordIO format.

    Depending on the input mode that the algorithm supports, Amazon SageMaker either copies input data files from an S3 bucket to a local directory in the Docker container, or makes it available as input streams. For example, if you specify an EFS location, input data files will be made available as input streams. They do not need to be downloaded.

    " + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

    Specifies the path to the S3 location where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

    " + }, + "ResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

    The resources, including the ML compute instances and ML storage volumes, to use for model training.

    ML storage volumes store model artifacts and incremental states. Training algorithms might also use ML storage volumes for scratch space. If you want Amazon SageMaker to use the ML storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    A VpcConfig object that specifies the VPC that you want your training job to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

    The Semantic Segmentation built-in algorithm does not support network isolation.

    " + }, + "EnableInterContainerTrafficEncryption":{ + "shape":"Boolean", + "documentation":"

    To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training. For more information, see Protect Communications Between ML Compute Instances in a Distributed Training Job.

    " + }, + "EnableManagedSpotTraining":{ + "shape":"Boolean", + "documentation":"

    To train models using managed spot training, choose True. Managed spot training provides a fully managed and scalable infrastructure for training machine learning models. this option is useful when training jobs can be interrupted and when there is flexibility when the training job is run.

    The complete and intermediate results of jobs are stored in an Amazon S3 bucket, and can be used as a starting point to train models incrementally. Amazon SageMaker provides metrics and logs in CloudWatch. They can be used to see when managed spot training jobs are running, interrupted, resumed, or completed.

    " + }, + "CheckpointConfig":{ + "shape":"CheckpointConfig", + "documentation":"

    Contains information about the output location for managed spot training checkpoint data.

    " + } + } + }, + "CreateTrainingJobResponse":{ + "type":"structure", + "required":["TrainingJobArn"], + "members":{ + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the training job.

    " + } + } + }, + "CreateTransformJobRequest":{ + "type":"structure", + "required":[ + "TransformJobName", + "ModelName", + "TransformInput", + "TransformOutput", + "TransformResources" + ], + "members":{ + "TransformJobName":{ + "shape":"TransformJobName", + "documentation":"

    The name of the transform job. The name must be unique within an AWS Region in an AWS account.

    " + }, + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model that you want to use for the transform job. ModelName must be the name of an existing Amazon SageMaker model within an AWS Region in an AWS account.

    " + }, + "MaxConcurrentTransforms":{ + "shape":"MaxConcurrentTransforms", + "documentation":"

    The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the optimal settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

    " + }, + "MaxPayloadInMB":{ + "shape":"MaxPayloadInMB", + "documentation":"

    The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

    For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

    " + }, + "BatchStrategy":{ + "shape":"BatchStrategy", + "documentation":"

    Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

    To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

    To use only one record when making an HTTP invocation request to a container, set BatchStrategy to SingleRecord and SplitType to Line.

    To fit as many records in a mini-batch as can fit within the MaxPayloadInMB limit, set BatchStrategy to MultiRecord and SplitType to Line.

    " + }, + "Environment":{ + "shape":"TransformEnvironmentMap", + "documentation":"

    The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

    " + }, + "TransformInput":{ + "shape":"TransformInput", + "documentation":"

    Describes the input source and the way the transform job consumes it.

    " + }, + "TransformOutput":{ + "shape":"TransformOutput", + "documentation":"

    Describes the results of the transform job.

    " + }, + "TransformResources":{ + "shape":"TransformResources", + "documentation":"

    Describes the resources, including ML instance types and ML instance count, to use for the transform job.

    " + }, + "DataProcessing":{ + "shape":"DataProcessing", + "documentation":"

    The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    (Optional) An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + } + } + }, + "CreateTransformJobResponse":{ + "type":"structure", + "required":["TransformJobArn"], + "members":{ + "TransformJobArn":{ + "shape":"TransformJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the transform job.

    " + } + } + }, + "CreateWorkteamRequest":{ + "type":"structure", + "required":[ + "WorkteamName", + "MemberDefinitions", + "Description" + ], + "members":{ + "WorkteamName":{ + "shape":"WorkteamName", + "documentation":"

    The name of the work team. Use this name to identify the work team.

    " + }, + "MemberDefinitions":{ + "shape":"MemberDefinitions", + "documentation":"

    A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools.

    All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.

    " + }, + "Description":{ + "shape":"String200", + "documentation":"

    A description of the work team.

    " + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

    Configures notification of workers regarding available or expiring work items.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs.

    For more information, see Resource Tag and Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + } + } + }, + "CreateWorkteamResponse":{ + "type":"structure", + "members":{ + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

    " + } + } + }, + "CreationTime":{"type":"timestamp"}, + "DataInputConfig":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\S\\s]+" + }, + "DataProcessing":{ + "type":"structure", + "members":{ + "InputFilter":{ + "shape":"JsonPath", + "documentation":"

    A JSONPath expression used to select a portion of the input data to pass to the algorithm. Use the InputFilter parameter to exclude fields, such as an ID column, from the input. If you want Amazon SageMaker to pass the entire input dataset to the algorithm, accept the default value $.

    Examples: \"$\", \"$[1:]\", \"$.features\"

    " + }, + "OutputFilter":{ + "shape":"JsonPath", + "documentation":"

    A JSONPath expression used to select a portion of the joined dataset to save in the output file for a batch transform job. If you want Amazon SageMaker to store the entire input dataset in the output file, leave the default value, $. If you specify indexes that aren't within the dimension size of the joined dataset, you get an error.

    Examples: \"$\", \"$[0,5:]\", \"$['id','SageMakerOutput']\"

    " + }, + "JoinSource":{ + "shape":"JoinSource", + "documentation":"

    Specifies the source of the data to join with the transformed data. The valid values are None and Input The default value is None which specifies not to join the input with the transformed data. If you want the batch transform job to join the original input data with the transformed data, set JoinSource to Input.

    For JSON or JSONLines objects, such as a JSON array, Amazon SageMaker adds the transformed data to the input JSON object in an attribute called SageMakerOutput. The joined result for JSON must be a key-value pair object. If the input is not a key-value pair object, Amazon SageMaker creates a new JSON file. In the new JSON file, and the input data is stored under the SageMakerInput key and the results are stored in SageMakerOutput.

    For CSV files, Amazon SageMaker combines the transformed data with the input data at the end of the input data and stores it in the output file. The joined data has the joined input data followed by the transformed data and the output is a CSV file.

    " + } + }, + "documentation":"

    The data structure used to specify the data to be used for inference in a batch transform job and to associate the data that is relevant to the prediction results in the output. The input filter provided allows you to exclude input data that is not needed for inference in a batch transform job. The output filter provided allows you to include input data relevant to interpreting the predictions in the output from the job. For more information, see Associate Prediction Results with their Corresponding Input Records.

    " + }, + "DataSource":{ + "type":"structure", + "members":{ + "S3DataSource":{ + "shape":"S3DataSource", + "documentation":"

    The S3 location of the data source that is associated with a channel.

    " + }, + "FileSystemDataSource":{ + "shape":"FileSystemDataSource", + "documentation":"

    The file system that is associated with a channel.

    " + } + }, + "documentation":"

    Describes the location of the channel data.

    " + }, + "DeleteAlgorithmInput":{ + "type":"structure", + "required":["AlgorithmName"], + "members":{ + "AlgorithmName":{ + "shape":"EntityName", + "documentation":"

    The name of the algorithm to delete.

    " + } + } + }, + "DeleteCodeRepositoryInput":{ + "type":"structure", + "required":["CodeRepositoryName"], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository to delete.

    " + } + } + }, + "DeleteEndpointConfigInput":{ + "type":"structure", + "required":["EndpointConfigName"], + "members":{ + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the endpoint configuration that you want to delete.

    " + } + } + }, + "DeleteEndpointInput":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint that you want to delete.

    " + } + } + }, + "DeleteModelInput":{ + "type":"structure", + "required":["ModelName"], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model to delete.

    " + } + } + }, + "DeleteModelPackageInput":{ + "type":"structure", + "required":["ModelPackageName"], + "members":{ + "ModelPackageName":{ + "shape":"EntityName", + "documentation":"

    The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).

    " + } + } + }, + "DeleteNotebookInstanceInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the Amazon SageMaker notebook instance to delete.

    " + } + } + }, + "DeleteNotebookInstanceLifecycleConfigInput":{ + "type":"structure", + "required":["NotebookInstanceLifecycleConfigName"], + "members":{ + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration to delete.

    " + } + } + }, + "DeleteTagsInput":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource whose tags you want to delete.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    An array or one or more tag keys to delete.

    " + } + } + }, + "DeleteTagsOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkteamRequest":{ + "type":"structure", + "required":["WorkteamName"], + "members":{ + "WorkteamName":{ + "shape":"WorkteamName", + "documentation":"

    The name of the work team to delete.

    " + } + } + }, + "DeleteWorkteamResponse":{ + "type":"structure", + "required":["Success"], + "members":{ + "Success":{ + "shape":"Success", + "documentation":"

    Returns true if the work team was successfully deleted; otherwise, returns false.

    " + } + } + }, + "DeployedImage":{ + "type":"structure", + "members":{ + "SpecifiedImage":{ + "shape":"Image", + "documentation":"

    The image path you specified when you created the model.

    " + }, + "ResolvedImage":{ + "shape":"Image", + "documentation":"

    The specific digest path of the image hosted in this ProductionVariant.

    " + }, + "ResolutionTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time when the image path for the model resolved to the ResolvedImage

    " + } + }, + "documentation":"

    Gets the Amazon EC2 Container Registry path of the docker image of the model that is hosted in this ProductionVariant.

    If you used the registry/repository[:tag] form to specify the image path of the primary container when you created the model hosted in this ProductionVariant, the path resolves to a path of the form registry/repository[@digest]. A digest is a hash value that identifies a specific version of an image. For information about Amazon ECR paths, see Pulling an Image in the Amazon ECR User Guide.

    " + }, + "DeployedImages":{ + "type":"list", + "member":{"shape":"DeployedImage"} + }, + "DescribeAlgorithmInput":{ + "type":"structure", + "required":["AlgorithmName"], + "members":{ + "AlgorithmName":{ + "shape":"ArnOrName", + "documentation":"

    The name of the algorithm to describe.

    " + } + } + }, + "DescribeAlgorithmOutput":{ + "type":"structure", + "required":[ + "AlgorithmName", + "AlgorithmArn", + "CreationTime", + "TrainingSpecification", + "AlgorithmStatus", + "AlgorithmStatusDetails" + ], + "members":{ + "AlgorithmName":{ + "shape":"EntityName", + "documentation":"

    The name of the algorithm being described.

    " + }, + "AlgorithmArn":{ + "shape":"AlgorithmArn", + "documentation":"

    The Amazon Resource Name (ARN) of the algorithm.

    " + }, + "AlgorithmDescription":{ + "shape":"EntityDescription", + "documentation":"

    A brief summary about the algorithm.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp specifying when the algorithm was created.

    " + }, + "TrainingSpecification":{ + "shape":"TrainingSpecification", + "documentation":"

    Details about training jobs run by this algorithm.

    " + }, + "InferenceSpecification":{ + "shape":"InferenceSpecification", + "documentation":"

    Details about inference jobs that the algorithm runs.

    " + }, + "ValidationSpecification":{ + "shape":"AlgorithmValidationSpecification", + "documentation":"

    Details about configurations for one or more training jobs that Amazon SageMaker runs to test the algorithm.

    " + }, + "AlgorithmStatus":{ + "shape":"AlgorithmStatus", + "documentation":"

    The current status of the algorithm.

    " + }, + "AlgorithmStatusDetails":{ + "shape":"AlgorithmStatusDetails", + "documentation":"

    Details about the current status of the algorithm.

    " + }, + "ProductId":{ + "shape":"ProductId", + "documentation":"

    The product identifier of the algorithm.

    " + }, + "CertifyForMarketplace":{ + "shape":"CertifyForMarketplace", + "documentation":"

    Whether the algorithm is certified to be listed in AWS Marketplace.

    " + } + } + }, + "DescribeCodeRepositoryInput":{ + "type":"structure", + "required":["CodeRepositoryName"], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository to describe.

    " + } + } + }, + "DescribeCodeRepositoryOutput":{ + "type":"structure", + "required":[ + "CodeRepositoryName", + "CodeRepositoryArn", + "CreationTime", + "LastModifiedTime" + ], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository.

    " + }, + "CodeRepositoryArn":{ + "shape":"CodeRepositoryArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Git repository.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    The date and time that the repository was created.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    The date and time that the repository was last changed.

    " + }, + "GitConfig":{ + "shape":"GitConfig", + "documentation":"

    Configuration details about the repository, including the URL where the repository is located, the default branch, and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository.

    " + } + } + }, + "DescribeCompilationJobRequest":{ + "type":"structure", + "required":["CompilationJobName"], + "members":{ + "CompilationJobName":{ + "shape":"EntityName", + "documentation":"

    The name of the model compilation job that you want information about.

    " + } + } + }, + "DescribeCompilationJobResponse":{ + "type":"structure", + "required":[ + "CompilationJobName", + "CompilationJobArn", + "CompilationJobStatus", + "StoppingCondition", + "CreationTime", + "LastModifiedTime", + "FailureReason", + "ModelArtifacts", + "RoleArn", + "InputConfig", + "OutputConfig" + ], + "members":{ + "CompilationJobName":{ + "shape":"EntityName", + "documentation":"

    The name of the model compilation job.

    " + }, + "CompilationJobArn":{ + "shape":"CompilationJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

    " + }, + "CompilationJobStatus":{ + "shape":"CompilationJobStatus", + "documentation":"

    The status of the model compilation job.

    " + }, + "CompilationStartTime":{ + "shape":"Timestamp", + "documentation":"

    The time when the model compilation job started the CompilationJob instances.

    You are billed for the time between this timestamp and the timestamp in the DescribeCompilationJobResponse$CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

    " + }, + "CompilationEndTime":{ + "shape":"Timestamp", + "documentation":"

    The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    The time that the model compilation job was created.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    The time that the status of the model compilation job was last modified.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If a model compilation job failed, the reason it failed.

    " + }, + "ModelArtifacts":{ + "shape":"ModelArtifacts", + "documentation":"

    Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model compilation job.

    " + }, + "InputConfig":{ + "shape":"InputConfig", + "documentation":"

    Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

    " + }, + "OutputConfig":{ + "shape":"OutputConfig", + "documentation":"

    Information about the output location for the compiled model and the target device that the model runs on.

    " + } + } + }, + "DescribeEndpointConfigInput":{ + "type":"structure", + "required":["EndpointConfigName"], + "members":{ + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the endpoint configuration.

    " + } + } + }, + "DescribeEndpointConfigOutput":{ + "type":"structure", + "required":[ + "EndpointConfigName", + "EndpointConfigArn", + "ProductionVariants", + "CreationTime" + ], + "members":{ + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    Name of the Amazon SageMaker endpoint configuration.

    " + }, + "EndpointConfigArn":{ + "shape":"EndpointConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint configuration.

    " + }, + "ProductionVariants":{ + "shape":"ProductionVariantList", + "documentation":"

    An array of ProductionVariant objects, one for each model that you want to host at this endpoint.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint configuration was created.

    " + } + } + }, + "DescribeEndpointInput":{ + "type":"structure", + "required":["EndpointName"], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint.

    " + } + } + }, + "DescribeEndpointOutput":{ + "type":"structure", + "required":[ + "EndpointName", + "EndpointArn", + "EndpointConfigName", + "EndpointStatus", + "CreationTime", + "LastModifiedTime" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    Name of the endpoint.

    " + }, + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint.

    " + }, + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the endpoint configuration associated with this endpoint.

    " + }, + "ProductionVariants":{ + "shape":"ProductionVariantSummaryList", + "documentation":"

    An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.

    " + }, + "EndpointStatus":{ + "shape":"EndpointStatus", + "documentation":"

    The status of the endpoint.

    • OutOfService: Endpoint is not available to take incoming requests.

    • Creating: CreateEndpoint is executing.

    • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

    • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

    • InService: Endpoint is available to process incoming requests.

    • Deleting: DeleteEndpoint is executing.

    • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the status of the endpoint is Failed, the reason why it failed.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint was created.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint was last modified.

    " + } + } + }, + "DescribeHyperParameterTuningJobRequest":{ + "type":"structure", + "required":["HyperParameterTuningJobName"], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job to describe.

    " + } + } + }, + "DescribeHyperParameterTuningJobResponse":{ + "type":"structure", + "required":[ + "HyperParameterTuningJobName", + "HyperParameterTuningJobArn", + "HyperParameterTuningJobConfig", + "HyperParameterTuningJobStatus", + "CreationTime", + "TrainingJobStatusCounters", + "ObjectiveStatusCounters" + ], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job.

    " + }, + "HyperParameterTuningJobArn":{ + "shape":"HyperParameterTuningJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the tuning job.

    " + }, + "HyperParameterTuningJobConfig":{ + "shape":"HyperParameterTuningJobConfig", + "documentation":"

    The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

    " + }, + "TrainingJobDefinition":{ + "shape":"HyperParameterTrainingJobDefinition", + "documentation":"

    The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

    " + }, + "HyperParameterTuningJobStatus":{ + "shape":"HyperParameterTuningJobStatus", + "documentation":"

    The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the tuning job started.

    " + }, + "HyperParameterTuningEndTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the tuning job ended.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the status of the tuning job was modified.

    " + }, + "TrainingJobStatusCounters":{ + "shape":"TrainingJobStatusCounters", + "documentation":"

    The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

    " + }, + "ObjectiveStatusCounters":{ + "shape":"ObjectiveStatusCounters", + "documentation":"

    The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

    " + }, + "BestTrainingJob":{ + "shape":"HyperParameterTrainingJobSummary", + "documentation":"

    A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

    " + }, + "OverallBestTrainingJob":{ + "shape":"HyperParameterTrainingJobSummary", + "documentation":"

    If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

    " + }, + "WarmStartConfig":{ + "shape":"HyperParameterTuningJobWarmStartConfig", + "documentation":"

    The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the tuning job failed, the reason it failed.

    " + } + } + }, + "DescribeLabelingJobRequest":{ + "type":"structure", + "required":["LabelingJobName"], + "members":{ + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name of the labeling job to return information for.

    " + } + } + }, + "DescribeLabelingJobResponse":{ + "type":"structure", + "required":[ + "LabelingJobStatus", + "LabelCounters", + "CreationTime", + "LastModifiedTime", + "JobReferenceCode", + "LabelingJobName", + "LabelingJobArn", + "InputConfig", + "OutputConfig", + "RoleArn", + "HumanTaskConfig" + ], + "members":{ + "LabelingJobStatus":{ + "shape":"LabelingJobStatus", + "documentation":"

    The processing status of the labeling job.

    " + }, + "LabelCounters":{ + "shape":"LabelCounters", + "documentation":"

    Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the job failed, the reason that it failed.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the labeling job was created.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the labeling job was last updated.

    " + }, + "JobReferenceCode":{ + "shape":"JobReferenceCode", + "documentation":"

    A unique identifier for work done as part of a labeling job.

    " + }, + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name assigned to the labeling job when it was created.

    " + }, + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the labeling job.

    " + }, + "LabelAttributeName":{ + "shape":"LabelAttributeName", + "documentation":"

    The attribute used as the label in the output manifest file.

    " + }, + "InputConfig":{ + "shape":"LabelingJobInputConfig", + "documentation":"

    Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

    " + }, + "OutputConfig":{ + "shape":"LabelingJobOutputConfig", + "documentation":"

    The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) that Amazon SageMaker assumes to perform tasks on your behalf during data labeling.

    " + }, + "LabelCategoryConfigS3Uri":{ + "shape":"S3Uri", + "documentation":"

    The S3 location of the JSON file that defines the categories used to label data objects.

    The file is a JSON structure in the following format:

    {

    \"document-version\": \"2018-11-28\"

    \"labels\": [

    {

    \"label\": \"label 1\"

    },

    {

    \"label\": \"label 2\"

    },

    ...

    {

    \"label\": \"label n\"

    }

    ]

    }

    " + }, + "StoppingConditions":{ + "shape":"LabelingJobStoppingConditions", + "documentation":"

    A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

    " + }, + "LabelingJobAlgorithmsConfig":{ + "shape":"LabelingJobAlgorithmsConfig", + "documentation":"

    Configuration information for automated data labeling.

    " + }, + "HumanTaskConfig":{ + "shape":"HumanTaskConfig", + "documentation":"

    Configuration information required for human workers to complete a labeling task.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key/value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + }, + "LabelingJobOutput":{ + "shape":"LabelingJobOutput", + "documentation":"

    The location of the output produced by the labeling job.

    " + } + } + }, + "DescribeModelInput":{ + "type":"structure", + "required":["ModelName"], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model.

    " + } + } + }, + "DescribeModelOutput":{ + "type":"structure", + "required":[ + "ModelName", + "ExecutionRoleArn", + "CreationTime", + "ModelArn" + ], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

    Name of the Amazon SageMaker model.

    " + }, + "PrimaryContainer":{ + "shape":"ContainerDefinition", + "documentation":"

    The location of the primary inference code, associated artifacts, and custom environment map that the inference code uses when it is deployed in production.

    " + }, + "Containers":{ + "shape":"ContainerDefinitionList", + "documentation":"

    The containers in the inference pipeline.

    " + }, + "ExecutionRoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that you specified for the model.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    A VpcConfig object that specifies the VPC that this model has access to. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the model was created.

    " + }, + "ModelArn":{ + "shape":"ModelArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    If True, no inbound or outbound network calls can be made to or from the model container.

    The Semantic Segmentation built-in algorithm does not support network isolation.

    " + } + } + }, + "DescribeModelPackageInput":{ + "type":"structure", + "required":["ModelPackageName"], + "members":{ + "ModelPackageName":{ + "shape":"ArnOrName", + "documentation":"

    The name of the model package to describe.

    " + } + } + }, + "DescribeModelPackageOutput":{ + "type":"structure", + "required":[ + "ModelPackageName", + "ModelPackageArn", + "CreationTime", + "ModelPackageStatus", + "ModelPackageStatusDetails" + ], + "members":{ + "ModelPackageName":{ + "shape":"EntityName", + "documentation":"

    The name of the model package being described.

    " + }, + "ModelPackageArn":{ + "shape":"ModelPackageArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model package.

    " + }, + "ModelPackageDescription":{ + "shape":"EntityDescription", + "documentation":"

    A brief summary of the model package.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp specifying when the model package was created.

    " + }, + "InferenceSpecification":{ + "shape":"InferenceSpecification", + "documentation":"

    Details about inference jobs that can be run with models based on this model package.

    " + }, + "SourceAlgorithmSpecification":{ + "shape":"SourceAlgorithmSpecification", + "documentation":"

    Details about the algorithm that was used to create the model package.

    " + }, + "ValidationSpecification":{ + "shape":"ModelPackageValidationSpecification", + "documentation":"

    Configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.

    " + }, + "ModelPackageStatus":{ + "shape":"ModelPackageStatus", + "documentation":"

    The current status of the model package.

    " + }, + "ModelPackageStatusDetails":{ + "shape":"ModelPackageStatusDetails", + "documentation":"

    Details about the current status of the model package.

    " + }, + "CertifyForMarketplace":{ + "shape":"CertifyForMarketplace", + "documentation":"

    Whether the model package is certified for listing on AWS Marketplace.

    " + } + } + }, + "DescribeNotebookInstanceInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance that you want information about.

    " + } + } + }, + "DescribeNotebookInstanceLifecycleConfigInput":{ + "type":"structure", + "required":["NotebookInstanceLifecycleConfigName"], + "members":{ + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration to describe.

    " + } + } + }, + "DescribeNotebookInstanceLifecycleConfigOutput":{ + "type":"structure", + "members":{ + "NotebookInstanceLifecycleConfigArn":{ + "shape":"NotebookInstanceLifecycleConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    " + }, + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration.

    " + }, + "OnCreate":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    The shell script that runs only once, when you create a notebook instance.

    " + }, + "OnStart":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    The shell script that runs every time you start a notebook instance, including when you create the notebook instance.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    A timestamp that tells when the lifecycle configuration was last modified.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp that tells when the lifecycle configuration was created.

    " + } + } + }, + "DescribeNotebookInstanceOutput":{ + "type":"structure", + "members":{ + "NotebookInstanceArn":{ + "shape":"NotebookInstanceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the notebook instance.

    " + }, + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the Amazon SageMaker notebook instance.

    " + }, + "NotebookInstanceStatus":{ + "shape":"NotebookInstanceStatus", + "documentation":"

    The status of the notebook instance.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If status is Failed, the reason it failed.

    " + }, + "Url":{ + "shape":"NotebookInstanceUrl", + "documentation":"

    The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.

    " + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

    The type of ML compute instance running on the notebook instance.

    " + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The ID of the VPC subnet.

    " + }, + "SecurityGroups":{ + "shape":"SecurityGroupIds", + "documentation":"

    The IDs of the VPC security groups.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role associated with the instance.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS KMS key ID Amazon SageMaker uses to encrypt data when storing it on the ML storage volume attached to the instance.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface IDs that Amazon SageMaker created at the time of creating the instance.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    A timestamp. Use this parameter to retrieve the time when the notebook instance was last modified.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp. Use this parameter to return the time when the notebook instance was created

    " + }, + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    Returns the name of a notebook instance lifecycle configuration.

    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance

    " + }, + "DirectInternetAccess":{ + "shape":"DirectInternetAccess", + "documentation":"

    Describes whether Amazon SageMaker provides internet access to the notebook instance. If this value is set to Disabled, the notebook instance does not have internet access, and cannot connect to Amazon SageMaker training and endpoint services.

    For more information, see Notebook Instances Are Internet-Enabled by Default.

    " + }, + "VolumeSizeInGB":{ + "shape":"NotebookInstanceVolumeSizeInGB", + "documentation":"

    The size, in GB, of the ML storage volume attached to the notebook instance.

    " + }, + "AcceleratorTypes":{ + "shape":"NotebookInstanceAcceleratorTypes", + "documentation":"

    A list of the Elastic Inference (EI) instance types associated with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

    " + }, + "DefaultCodeRepository":{ + "shape":"CodeRepositoryNameOrUrl", + "documentation":"

    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "AdditionalCodeRepositories":{ + "shape":"AdditionalCodeRepositoryNamesOrUrls", + "documentation":"

    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "RootAccess":{ + "shape":"RootAccess", + "documentation":"

    Whether root access is enabled or disabled for users of the notebook instance.

    Lifecycle configurations need root access to be able to set up a notebook instance. Because of this, lifecycle configurations associated with a notebook instance always run with root access even if you disable root access for users.

    " + } + } + }, + "DescribeSubscribedWorkteamRequest":{ + "type":"structure", + "required":["WorkteamArn"], + "members":{ + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the subscribed work team to describe.

    " + } + } + }, + "DescribeSubscribedWorkteamResponse":{ + "type":"structure", + "required":["SubscribedWorkteam"], + "members":{ + "SubscribedWorkteam":{ + "shape":"SubscribedWorkteam", + "documentation":"

    A Workteam instance that contains information about the work team.

    " + } + } + }, + "DescribeTrainingJobRequest":{ + "type":"structure", + "required":["TrainingJobName"], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job.

    " + } + } + }, + "DescribeTrainingJobResponse":{ + "type":"structure", + "required":[ + "TrainingJobName", + "TrainingJobArn", + "ModelArtifacts", + "TrainingJobStatus", + "SecondaryStatus", + "AlgorithmSpecification", + "ResourceConfig", + "StoppingCondition", + "CreationTime" + ], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    Name of the model training job.

    " + }, + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the training job.

    " + }, + "TuningJobArn":{ + "shape":"HyperParameterTuningJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

    " + }, + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

    " + }, + "ModelArtifacts":{ + "shape":"ModelArtifacts", + "documentation":"

    Information about the Amazon S3 location that is configured for storing model artifacts.

    " + }, + "TrainingJobStatus":{ + "shape":"TrainingJobStatus", + "documentation":"

    The status of the training job.

    Amazon SageMaker provides the following training job statuses:

    • InProgress - The training is in progress.

    • Completed - The training job has completed.

    • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

    • Stopping - The training job is stopping.

    • Stopped - The training job has stopped.

    For more detailed information, see SecondaryStatus.

    " + }, + "SecondaryStatus":{ + "shape":"SecondaryStatus", + "documentation":"

    Provides detailed information about the state of the training job. For detailed information on the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

    Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

    InProgress

    • Starting - Starting the training job.

    • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

    • Training - Training is in progress.

    • Interrupted - The job stopped because the managed spot training instances were interrupted.

    • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

    Completed

    • Completed - The training job has completed.

    Failed

    • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

    Stopped

    • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

    • MaxWaitTmeExceeded - The job stopped because it exceeded the maximum allowed wait time.

    • Stopped - The training job has stopped.

    Stopping

    • Stopping - Stopping the training job.

    Valid values for SecondaryStatus are subject to change.

    We no longer support the following secondary statuses:

    • LaunchingMLInstances

    • PreparingTrainingStack

    • DownloadingTrainingImage

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the training job failed, the reason it failed.

    " + }, + "HyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    Algorithm-specific parameters.

    " + }, + "AlgorithmSpecification":{ + "shape":"AlgorithmSpecification", + "documentation":"

    Information about the algorithm used for training, and algorithm metadata.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

    An array of Channel objects that describes each data input channel.

    " + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

    " + }, + "ResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

    Resources, including ML compute instances and ML storage volumes, that are configured for model training.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model training job can run. It also specifies the maximum time to wait for a spot instance. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that indicates when the training job was created.

    " + }, + "TrainingStartTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

    " + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that indicates when the status of the training job was last modified.

    " + }, + "SecondaryStatusTransitions":{ + "shape":"SecondaryStatusTransitions", + "documentation":"

    A history of all of the secondary statuses that the training job has transitioned through.

    " + }, + "FinalMetricDataList":{ + "shape":"FinalMetricDataList", + "documentation":"

    A collection of MetricData objects that specify the names, values, and dates and times that the training algorithm emitted to Amazon CloudWatch.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    If you want to allow inbound or outbound network calls, except for calls between peers within a training cluster for distributed training, choose True. If you enable network isolation for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

    The Semantic Segmentation built-in algorithm does not support network isolation.

    " + }, + "EnableInterContainerTrafficEncryption":{ + "shape":"Boolean", + "documentation":"

    To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithms in distributed training.

    " + }, + "EnableManagedSpotTraining":{ + "shape":"Boolean", + "documentation":"

    A Boolean indicating whether managed spot training is enabled (True) or not (False).

    " + }, + "CheckpointConfig":{"shape":"CheckpointConfig"}, + "TrainingTimeInSeconds":{ + "shape":"TrainingTimeInSeconds", + "documentation":"

    The training time in seconds.

    " + }, + "BillableTimeInSeconds":{ + "shape":"BillableTimeInSeconds", + "documentation":"

    The billable time in seconds.

    You can calculate the savings from using managed spot training using the formula (1 - BillableTimeInSeconds / TrainingTimeInSeconds) * 100. For example, if BillableTimeInSeconds is 100 and TrainingTimeInSeconds is 500, the savings is 80%.

    " + } + } + }, + "DescribeTransformJobRequest":{ + "type":"structure", + "required":["TransformJobName"], + "members":{ + "TransformJobName":{ + "shape":"TransformJobName", + "documentation":"

    The name of the transform job that you want to view details of.

    " + } + } + }, + "DescribeTransformJobResponse":{ + "type":"structure", + "required":[ + "TransformJobName", + "TransformJobArn", + "TransformJobStatus", + "ModelName", + "TransformInput", + "TransformResources", + "CreationTime" + ], + "members":{ + "TransformJobName":{ + "shape":"TransformJobName", + "documentation":"

    The name of the transform job.

    " + }, + "TransformJobArn":{ + "shape":"TransformJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the transform job.

    " + }, + "TransformJobStatus":{ + "shape":"TransformJobStatus", + "documentation":"

    The status of the transform job. If the transform job failed, the reason is returned in the FailureReason field.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the transform job failed, FailureReason describes why it failed. A transform job creates a log file, which includes error messages, and stores it as an Amazon S3 object. For more information, see Log Amazon SageMaker Events with Amazon CloudWatch.

    " + }, + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model used in the transform job.

    " + }, + "MaxConcurrentTransforms":{ + "shape":"MaxConcurrentTransforms", + "documentation":"

    The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

    " + }, + "MaxPayloadInMB":{ + "shape":"MaxPayloadInMB", + "documentation":"

    The maximum payload size, in MB, used in the transform job.

    " + }, + "BatchStrategy":{ + "shape":"BatchStrategy", + "documentation":"

    Specifies the number of records to include in a mini-batch for an HTTP inference request. A record is a single unit of input data that inference can be made on. For example, a single line in a CSV file is a record.

    To enable the batch strategy, you must set SplitType to Line, RecordIO, or TFRecord.

    " + }, + "Environment":{ + "shape":"TransformEnvironmentMap", + "documentation":"

    The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

    " + }, + "TransformInput":{ + "shape":"TransformInput", + "documentation":"

    Describes the dataset to be transformed and the Amazon S3 location where it is stored.

    " + }, + "TransformOutput":{ + "shape":"TransformOutput", + "documentation":"

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

    " + }, + "TransformResources":{ + "shape":"TransformResources", + "documentation":"

    Describes the resources, including ML instance types and ML instance count, to use for the transform job.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the transform Job was created.

    " + }, + "TransformStartTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates when the transform job starts on ML instances. You are billed for the time interval between this time and the value of TransformEndTime.

    " + }, + "TransformEndTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates when the transform job has been completed, or has stopped or failed. You are billed for the time interval between this time and the value of TransformStartTime.

    " + }, + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SageMaker Ground Truth labeling job that created the transform or training job.

    " + }, + "DataProcessing":{"shape":"DataProcessing"} + } + }, + "DescribeWorkteamRequest":{ + "type":"structure", + "required":["WorkteamName"], + "members":{ + "WorkteamName":{ + "shape":"WorkteamName", + "documentation":"

    The name of the work team to return a description of.

    " + } + } + }, + "DescribeWorkteamResponse":{ + "type":"structure", + "required":["Workteam"], + "members":{ + "Workteam":{ + "shape":"Workteam", + "documentation":"

    A Workteam instance that contains information about the work team.

    " + } + } + }, + "DesiredWeightAndCapacity":{ + "type":"structure", + "required":["VariantName"], + "members":{ + "VariantName":{ + "shape":"VariantName", + "documentation":"

    The name of the variant to update.

    " + }, + "DesiredWeight":{ + "shape":"VariantWeight", + "documentation":"

    The variant's weight.

    " + }, + "DesiredInstanceCount":{ + "shape":"TaskCount", + "documentation":"

    The variant's capacity.

    " + } + }, + "documentation":"

    Specifies weight and capacity values for a production variant.

    " + }, + "DesiredWeightAndCapacityList":{ + "type":"list", + "member":{"shape":"DesiredWeightAndCapacity"}, + "min":1 + }, + "DetailedAlgorithmStatus":{ + "type":"string", + "enum":[ + "NotStarted", + "InProgress", + "Completed", + "Failed" + ] + }, + "DetailedModelPackageStatus":{ + "type":"string", + "enum":[ + "NotStarted", + "InProgress", + "Completed", + "Failed" + ] + }, + "DirectInternetAccess":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "DirectoryPath":{ + "type":"string", + "max":4096, + "pattern":".*" + }, + "DisassociateAdditionalCodeRepositories":{"type":"boolean"}, + "DisassociateDefaultCodeRepository":{"type":"boolean"}, + "DisassociateNotebookInstanceAcceleratorTypes":{"type":"boolean"}, + "DisassociateNotebookInstanceLifecycleConfig":{"type":"boolean"}, + "Dollars":{ + "type":"integer", + "max":1, + "min":0 + }, + "EndpointArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint/.*" + }, + "EndpointConfigArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:endpoint-config/.*" + }, + "EndpointConfigName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "EndpointConfigNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "EndpointConfigSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, + "EndpointConfigSummary":{ + "type":"structure", + "required":[ + "EndpointConfigName", + "EndpointConfigArn", + "CreationTime" + ], + "members":{ + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the endpoint configuration.

    " + }, + "EndpointConfigArn":{ + "shape":"EndpointConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint configuration.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint configuration was created.

    " + } + }, + "documentation":"

    Provides summary information for an endpoint configuration.

    " + }, + "EndpointConfigSummaryList":{ + "type":"list", + "member":{"shape":"EndpointConfigSummary"} + }, + "EndpointName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "EndpointNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "EndpointSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, + "EndpointStatus":{ + "type":"string", + "enum":[ + "OutOfService", + "Creating", + "Updating", + "SystemUpdating", + "RollingBack", + "InService", + "Deleting", + "Failed" + ] + }, + "EndpointSummary":{ + "type":"structure", + "required":[ + "EndpointName", + "EndpointArn", + "CreationTime", + "LastModifiedTime", + "EndpointStatus" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint.

    " + }, + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint was created.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the endpoint was last modified.

    " + }, + "EndpointStatus":{ + "shape":"EndpointStatus", + "documentation":"

    The status of the endpoint.

    • OutOfService: Endpoint is not available to take incoming requests.

    • Creating: CreateEndpoint is executing.

    • Updating: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing.

    • SystemUpdating: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count.

    • RollingBack: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to an InService status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly.

    • InService: Endpoint is available to process incoming requests.

    • Deleting: DeleteEndpoint is executing.

    • Failed: Endpoint could not be created, updated, or re-scaled. Use DescribeEndpointOutput$FailureReason for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint.

    To get a list of endpoints with a specified status, use the ListEndpointsInput$StatusEquals filter.

    " + } + }, + "documentation":"

    Provides summary information for an endpoint.

    " + }, + "EndpointSummaryList":{ + "type":"list", + "member":{"shape":"EndpointSummary"} + }, + "EntityDescription":{ + "type":"string", + "max":1024, + "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" + }, + "EntityName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "EnvironmentKey":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" + }, + "EnvironmentMap":{ + "type":"map", + "key":{"shape":"EnvironmentKey"}, + "value":{"shape":"EnvironmentValue"}, + "max":16 + }, + "EnvironmentValue":{ + "type":"string", + "max":1024, + "pattern":"[\\S\\s]*" + }, + "FailureReason":{ + "type":"string", + "max":1024 + }, + "FileSystemAccessMode":{ + "type":"string", + "enum":[ + "rw", + "ro" + ] + }, + "FileSystemDataSource":{ + "type":"structure", + "required":[ + "FileSystemId", + "FileSystemAccessMode", + "FileSystemType", + "DirectoryPath" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

    The file system id.

    " + }, + "FileSystemAccessMode":{ + "shape":"FileSystemAccessMode", + "documentation":"

    The access mode of the mount of the directory associated with the channel. A directory can be mounted either in ro (read-only) or rw (read-write) mode.

    " + }, + "FileSystemType":{ + "shape":"FileSystemType", + "documentation":"

    The file system type.

    " + }, + "DirectoryPath":{ + "shape":"DirectoryPath", + "documentation":"

    The full path to the directory to associate with the channel.

    " + } + }, + "documentation":"

    Specifies a file system data source for a channel.

    " + }, + "FileSystemId":{ + "type":"string", + "min":11, + "pattern":".*" + }, + "FileSystemType":{ + "type":"string", + "enum":[ + "EFS", + "FSxLustre" + ] + }, + "Filter":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ResourcePropertyName", + "documentation":"

    A property name. For example, TrainingJobName. For the list of valid property names returned in a search result for each supported resource, see TrainingJob properties. You must specify a valid property name for the resource.

    " + }, + "Operator":{ + "shape":"Operator", + "documentation":"

    A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

    Equals

    The specified resource in Name equals the specified Value.

    NotEquals

    The specified resource in Name does not equal the specified Value.

    GreaterThan

    The specified resource in Name is greater than the specified Value. Not supported for text-based properties.

    GreaterThanOrEqualTo

    The specified resource in Name is greater than or equal to the specified Value. Not supported for text-based properties.

    LessThan

    The specified resource in Name is less than the specified Value. Not supported for text-based properties.

    LessThanOrEqualTo

    The specified resource in Name is less than or equal to the specified Value. Not supported for text-based properties.

    Contains

    Only supported for text-based properties. The word-list of the property contains the specified Value.

    If you have specified a filter Value, the default is Equals.

    " + }, + "Value":{ + "shape":"FilterValue", + "documentation":"

    A value used with Resource and Operator to determine if objects satisfy the filter's condition. For numerical properties, Value must be an integer or floating-point decimal. For timestamp properties, Value must be an ISO 8601 date-time string of the following format: YYYY-mm-dd'T'HH:MM:SS.

    " + } + }, + "documentation":"

    A conditional statement for a search expression that includes a Boolean operator, a resource property, and a value.

    If you don't specify an Operator and a Value, the filter searches for only the specified property. For example, defining a Filter for the FailureReason for the TrainingJob Resource searches for training job objects that have a value in the FailureReason field.

    If you specify a Value, but not an Operator, Amazon SageMaker uses the equals operator as the default.

    In search, there are several property types:

    Metrics

    To define a metric filter, enter a value using the form \"Metrics.<name>\", where <name> is a metric name. For example, the following filter searches for training jobs with an \"accuracy\" metric greater than \"0.9\":

    {

    \"Name\": \"Metrics.accuracy\",

    \"Operator\": \"GREATER_THAN\",

    \"Value\": \"0.9\"

    }

    HyperParameters

    To define a hyperparameter filter, enter a value with the form \"HyperParameters.<name>\". Decimal hyperparameter values are treated as a decimal in a comparison if the specified Value is also a decimal value. If the specified Value is an integer, the decimal hyperparameter values are treated as integers. For example, the following filter is satisfied by training jobs with a \"learning_rate\" hyperparameter that is less than \"0.5\":

    {

    \"Name\": \"HyperParameters.learning_rate\",

    \"Operator\": \"LESS_THAN\",

    \"Value\": \"0.5\"

    }

    Tags

    To define a tag filter, enter a value with the form \"Tags.<key>\".

    " + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":20, + "min":1 + }, + "FilterValue":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".+" + }, + "FinalHyperParameterTuningJobObjectiveMetric":{ + "type":"structure", + "required":[ + "MetricName", + "Value" + ], + "members":{ + "Type":{ + "shape":"HyperParameterTuningJobObjectiveType", + "documentation":"

    Whether to minimize or maximize the objective metric. Valid values are Minimize and Maximize.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    The name of the objective metric.

    " + }, + "Value":{ + "shape":"MetricValue", + "documentation":"

    The value of the objective metric.

    " + } + }, + "documentation":"

    Shows the final value for the objective metric for a training job that was launched by a hyperparameter tuning job. You define the objective metric in the HyperParameterTuningJobObjective parameter of HyperParameterTuningJobConfig.

    " + }, + "FinalMetricDataList":{ + "type":"list", + "member":{"shape":"MetricData"}, + "max":40, + "min":0 + }, + "Float":{"type":"float"}, + "Framework":{ + "type":"string", + "enum":[ + "TENSORFLOW", + "MXNET", + "ONNX", + "PYTORCH", + "XGBOOST" + ] + }, + "GetSearchSuggestionsRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceType", + "documentation":"

    The name of the Amazon SageMaker resource to Search for. The only valid Resource value is TrainingJob.

    " + }, + "SuggestionQuery":{ + "shape":"SuggestionQuery", + "documentation":"

    Limits the property names that are included in the response.

    " + } + } + }, + "GetSearchSuggestionsResponse":{ + "type":"structure", + "members":{ + "PropertyNameSuggestions":{ + "shape":"PropertyNameSuggestionList", + "documentation":"

    A list of property names for a Resource that match a SuggestionQuery.

    " + } + } + }, + "GitConfig":{ + "type":"structure", + "required":["RepositoryUrl"], + "members":{ + "RepositoryUrl":{ + "shape":"GitConfigUrl", + "documentation":"

    The URL where the Git repository is located.

    " + }, + "Branch":{ + "shape":"Branch", + "documentation":"

    The default branch for the Git repository.

    " + }, + "SecretArn":{ + "shape":"SecretArn", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

    {\"username\": UserName, \"password\": Password}

    " + } + }, + "documentation":"

    Specifies configuration details for a Git repository in your AWS account.

    " + }, + "GitConfigForUpdate":{ + "type":"structure", + "members":{ + "SecretArn":{ + "shape":"SecretArn", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the git repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

    {\"username\": UserName, \"password\": Password}

    " + } + }, + "documentation":"

    Specifies configuration details for a Git repository when the repository is updated.

    " + }, + "GitConfigUrl":{ + "type":"string", + "pattern":"^https://([^/]+)/?(.*)$" + }, + "HumanTaskConfig":{ + "type":"structure", + "required":[ + "WorkteamArn", + "UiConfig", + "PreHumanTaskLambdaArn", + "TaskTitle", + "TaskDescription", + "NumberOfHumanWorkersPerDataObject", + "TaskTimeLimitInSeconds", + "AnnotationConsolidationConfig" + ], + "members":{ + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the work team assigned to complete the tasks.

    " + }, + "UiConfig":{ + "shape":"UiConfig", + "documentation":"

    Information about the user interface that workers use to complete the labeling task.

    " + }, + "PreHumanTaskLambdaArn":{ + "shape":"LambdaFunctionArn", + "documentation":"

    The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

    For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

    US East (Northern Virginia) (us-east-1):

    • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

    • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

    • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

    • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

    • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

    US East (Ohio) (us-east-2):

    • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

    • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

    • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

    • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

    • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

    US West (Oregon) (us-west-2):

    • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

    • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

    • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

    • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

    • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

    Canada (Central) (ca-central-1):

    • arn:awslambda:ca-central-1:918755190332:function:PRE-BoundingBox

    • arn:awslambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

    • arn:awslambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

    • arn:awslambda:ca-central-1:918755190332:function:PRE-TextMultiClass

    • arn:awslambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

    EU (Ireland) (eu-west-1):

    • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

    • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

    • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

    • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

    • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

    EU (London) (eu-west-2):

    • arn:awslambda:eu-west-2:487402164563:function:PRE-BoundingBox

    • arn:awslambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

    • arn:awslambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

    • arn:awslambda:eu-west-2:487402164563:function:PRE-TextMultiClass

    • arn:awslambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

    EU Frankfurt (eu-central-1):

    • arn:awslambda:eu-central-1:203001061592:function:PRE-BoundingBox

    • arn:awslambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

    • arn:awslambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

    • arn:awslambda:eu-central-1:203001061592:function:PRE-TextMultiClass

    • arn:awslambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

    Asia Pacific (Tokyo) (ap-northeast-1):

    • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

    • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

    • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

    • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

    • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

    Asia Pacific (Seoul) (ap-northeast-2):

    • arn:awslambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

    • arn:awslambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

    • arn:awslambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

    • arn:awslambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

    • arn:awslambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

    Asia Pacific (Mumbai) (ap-south-1):

    • arn:awslambda:ap-south-1:565803892007:function:PRE-BoundingBox

    • arn:awslambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

    • arn:awslambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

    • arn:awslambda:ap-south-1:565803892007:function:PRE-TextMultiClass

    • arn:awslambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

    Asia Pacific (Singapore) (ap-southeast-1):

    • arn:awslambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

    • arn:awslambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

    • arn:awslambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

    • arn:awslambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

    • arn:awslambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

    Asia Pacific (Sydney) (ap-southeast-2):

    • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

    • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

    • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

    • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

    • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

    " + }, + "TaskKeywords":{ + "shape":"TaskKeywords", + "documentation":"

    Keywords used to describe the task so that workers on Amazon Mechanical Turk can discover the task.

    " + }, + "TaskTitle":{ + "shape":"TaskTitle", + "documentation":"

    A title for the task for your human workers.

    " + }, + "TaskDescription":{ + "shape":"TaskDescription", + "documentation":"

    A description of the task for your human workers.

    " + }, + "NumberOfHumanWorkersPerDataObject":{ + "shape":"NumberOfHumanWorkersPerDataObject", + "documentation":"

    The number of human workers that will label an object.

    " + }, + "TaskTimeLimitInSeconds":{ + "shape":"TaskTimeLimitInSeconds", + "documentation":"

    The amount of time that a worker has to complete a task.

    " + }, + "TaskAvailabilityLifetimeInSeconds":{ + "shape":"TaskAvailabilityLifetimeInSeconds", + "documentation":"

    The length of time that a task remains available for labeling by human workers. If you choose the Amazon Mechanical Turk workforce, the maximum is 12 hours (43200). For private and vendor workforces, the maximum is as listed.

    " + }, + "MaxConcurrentTaskCount":{ + "shape":"MaxConcurrentTaskCount", + "documentation":"

    Defines the maximum number of data objects that can be labeled by human workers at the same time. Each object may have more than one worker at one time.

    " + }, + "AnnotationConsolidationConfig":{ + "shape":"AnnotationConsolidationConfig", + "documentation":"

    Configures how labels are consolidated across human workers.

    " + }, + "PublicWorkforceTaskPrice":{ + "shape":"PublicWorkforceTaskPrice", + "documentation":"

    The price that you pay for each task performed by an Amazon Mechanical Turk worker.

    " + } + }, + "documentation":"

    Information required for human workers to complete a labeling task.

    " + }, + "HyperParameterAlgorithmSpecification":{ + "type":"structure", + "required":["TrainingInputMode"], + "members":{ + "TrainingImage":{ + "shape":"AlgorithmImage", + "documentation":"

    The registry path of the Docker image that contains the training algorithm. For information about Docker registry paths for built-in algorithms, see Algorithms Provided by Amazon SageMaker: Common Parameters. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

    " + }, + "TrainingInputMode":{ + "shape":"TrainingInputMode", + "documentation":"

    The input mode that the algorithm supports: File or Pipe. In File input mode, Amazon SageMaker downloads the training data from Amazon S3 to the storage volume that is attached to the training instance and mounts the directory to the Docker volume for the training container. In Pipe input mode, Amazon SageMaker streams data directly from Amazon S3 to the container.

    If you specify File mode, make sure that you provision the storage volume that is attached to the training instance with enough capacity to accommodate the training data downloaded from Amazon S3, the model artifacts, and intermediate information.

    For more information about input modes, see Algorithms.

    " + }, + "AlgorithmName":{ + "shape":"ArnOrName", + "documentation":"

    The name of the resource algorithm to use for the hyperparameter tuning job. If you specify a value for this parameter, do not specify a value for TrainingImage.

    " + }, + "MetricDefinitions":{ + "shape":"MetricDefinitionList", + "documentation":"

    An array of MetricDefinition objects that specify the metrics that the algorithm emits.

    " + } + }, + "documentation":"

    Specifies which training algorithm to use for training jobs that a hyperparameter tuning job launches and the metrics to monitor.

    " + }, + "HyperParameterScalingType":{ + "type":"string", + "enum":[ + "Auto", + "Linear", + "Logarithmic", + "ReverseLogarithmic" + ] + }, + "HyperParameterSpecification":{ + "type":"structure", + "required":[ + "Name", + "Type" + ], + "members":{ + "Name":{ + "shape":"ParameterName", + "documentation":"

    The name of this hyperparameter. The name must be unique.

    " + }, + "Description":{ + "shape":"EntityDescription", + "documentation":"

    A brief description of the hyperparameter.

    " + }, + "Type":{ + "shape":"ParameterType", + "documentation":"

    The type of this hyperparameter. The valid types are Integer, Continuous, Categorical, and FreeText.

    " + }, + "Range":{ + "shape":"ParameterRange", + "documentation":"

    The allowed range for this hyperparameter.

    " + }, + "IsTunable":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this hyperparameter is tunable in a hyperparameter tuning job.

    " + }, + "IsRequired":{ + "shape":"Boolean", + "documentation":"

    Indicates whether this hyperparameter is required.

    " + }, + "DefaultValue":{ + "shape":"ParameterValue", + "documentation":"

    The default value for this hyperparameter. If a default value is specified, a hyperparameter cannot be required.

    " + } + }, + "documentation":"

    Defines a hyperparameter to be used by an algorithm.

    " + }, + "HyperParameterSpecifications":{ + "type":"list", + "member":{"shape":"HyperParameterSpecification"}, + "max":100, + "min":0 + }, + "HyperParameterTrainingJobDefinition":{ + "type":"structure", + "required":[ + "AlgorithmSpecification", + "RoleArn", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members":{ + "StaticHyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    Specifies the values of hyperparameters that do not change for the tuning job.

    " + }, + "AlgorithmSpecification":{ + "shape":"HyperParameterAlgorithmSpecification", + "documentation":"

    The HyperParameterAlgorithmSpecification object that specifies the resource algorithm to use for the training jobs that the tuning job launches.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role associated with the training jobs that the tuning job launches.

    " + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

    An array of Channel objects that specify the input for the training jobs that the tuning job launches.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    The VpcConfig object that specifies the VPC that you want the training jobs that this hyperparameter tuning job launches to connect to. Control access to and from your training container by configuring the VPC. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

    Specifies the path to the Amazon S3 bucket where you store model artifacts from the training jobs that the tuning job launches.

    " + }, + "ResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

    The resources, including the compute instances and storage volumes, to use for the training jobs that the tuning job launches.

    Storage volumes store model artifacts and incremental states. Training algorithms might also use storage volumes for scratch space. If you want Amazon SageMaker to use the storage volume to store the training data, choose File as the TrainingInputMode in the algorithm specification. For distributed training algorithms, specify an instance count greater than 1.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model hyperparameter training job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the a limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    Isolates the training container. No inbound or outbound network calls can be made, except for calls between peers within a training cluster for distributed training. If network isolation is used for training jobs that are configured to use a VPC, Amazon SageMaker downloads and uploads customer data and model artifacts through the specified VPC, but the training container does not have network access.

    The Semantic Segmentation built-in algorithm does not support network isolation.

    " + }, + "EnableInterContainerTrafficEncryption":{ + "shape":"Boolean", + "documentation":"

    To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

    " + }, + "EnableManagedSpotTraining":{ + "shape":"Boolean", + "documentation":"

    A Boolean indicating whether managed spot training is enabled (True) or not (False).

    " + }, + "CheckpointConfig":{"shape":"CheckpointConfig"} + }, + "documentation":"

    Defines the training jobs launched by a hyperparameter tuning job.

    " + }, + "HyperParameterTrainingJobSummaries":{ + "type":"list", + "member":{"shape":"HyperParameterTrainingJobSummary"} + }, + "HyperParameterTrainingJobSummary":{ + "type":"structure", + "required":[ + "TrainingJobName", + "TrainingJobArn", + "CreationTime", + "TrainingJobStatus", + "TunedHyperParameters" + ], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job.

    " + }, + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the training job.

    " + }, + "TuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The HyperParameter tuning job that launched the training job.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the training job was created.

    " + }, + "TrainingStartTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the training job started.

    " + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

    Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + }, + "TrainingJobStatus":{ + "shape":"TrainingJobStatus", + "documentation":"

    The status of the training job.

    " + }, + "TunedHyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    A list of the hyperparameters for which you specified ranges to search.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    The reason that the training job failed.

    " + }, + "FinalHyperParameterTuningJobObjectiveMetric":{ + "shape":"FinalHyperParameterTuningJobObjectiveMetric", + "documentation":"

    The FinalHyperParameterTuningJobObjectiveMetric object that specifies the value of the objective metric of the tuning job that launched this training job.

    " + }, + "ObjectiveStatus":{ + "shape":"ObjectiveStatus", + "documentation":"

    The status of the objective metric for the training job:

    • Succeeded: The final objective metric for the training job was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

    • Pending: The training job is in progress and evaluation of its final objective metric is pending.

    • Failed: The final objective metric for the training job was not evaluated, and was not used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

    " + } + }, + "documentation":"

    Specifies summary information about a training job.

    " + }, + "HyperParameterTuningJobArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:hyper-parameter-tuning-job/.*" + }, + "HyperParameterTuningJobConfig":{ + "type":"structure", + "required":[ + "Strategy", + "ResourceLimits" + ], + "members":{ + "Strategy":{ + "shape":"HyperParameterTuningJobStrategyType", + "documentation":"

    Specifies how hyperparameter tuning chooses the combinations of hyperparameter values to use for the training job it launches. To use the Bayesian search stategy, set this to Bayesian. To randomly search, set it to Random. For information about search strategies, see How Hyperparameter Tuning Works.

    " + }, + "HyperParameterTuningJobObjective":{ + "shape":"HyperParameterTuningJobObjective", + "documentation":"

    The HyperParameterTuningJobObjective object that specifies the objective metric for this tuning job.

    " + }, + "ResourceLimits":{ + "shape":"ResourceLimits", + "documentation":"

    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs for this tuning job.

    " + }, + "ParameterRanges":{ + "shape":"ParameterRanges", + "documentation":"

    The ParameterRanges object that specifies the ranges of hyperparameters that this tuning job searches.

    " + }, + "TrainingJobEarlyStoppingType":{ + "shape":"TrainingJobEarlyStoppingType", + "documentation":"

    Specifies whether to use early stopping for training jobs launched by the hyperparameter tuning job. This can be one of the following values (the default value is OFF):

    OFF

    Training jobs launched by the hyperparameter tuning job do not use early stopping.

    AUTO

    Amazon SageMaker stops training jobs launched by the hyperparameter tuning job when they are unlikely to perform better than previously completed training jobs. For more information, see Stop Training Jobs Early.

    " + } + }, + "documentation":"

    Configures a hyperparameter tuning job.

    " + }, + "HyperParameterTuningJobName":{ + "type":"string", + "max":32, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "HyperParameterTuningJobObjective":{ + "type":"structure", + "required":[ + "Type", + "MetricName" + ], + "members":{ + "Type":{ + "shape":"HyperParameterTuningJobObjectiveType", + "documentation":"

    Whether to minimize or maximize the objective metric.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    The name of the metric to use for the objective metric.

    " + } + }, + "documentation":"

    Defines the objective metric for a hyperparameter tuning job. Hyperparameter tuning uses the value of this metric to evaluate the training jobs it launches, and returns the training job that results in either the highest or lowest value for this metric, depending on the value you specify for the Type parameter.

    " + }, + "HyperParameterTuningJobObjectiveType":{ + "type":"string", + "enum":[ + "Maximize", + "Minimize" + ] + }, + "HyperParameterTuningJobObjectives":{ + "type":"list", + "member":{"shape":"HyperParameterTuningJobObjective"} + }, + "HyperParameterTuningJobSortByOptions":{ + "type":"string", + "enum":[ + "Name", + "Status", + "CreationTime" + ] + }, + "HyperParameterTuningJobStatus":{ + "type":"string", + "enum":[ + "Completed", + "InProgress", + "Failed", + "Stopped", + "Stopping" + ] + }, + "HyperParameterTuningJobStrategyType":{ + "type":"string", + "documentation":"

    The strategy hyperparameter tuning uses to find the best combination of hyperparameters for your model. Currently, the only supported value is Bayesian.

    ", + "enum":[ + "Bayesian", + "Random" + ] + }, + "HyperParameterTuningJobSummaries":{ + "type":"list", + "member":{"shape":"HyperParameterTuningJobSummary"} + }, + "HyperParameterTuningJobSummary":{ + "type":"structure", + "required":[ + "HyperParameterTuningJobName", + "HyperParameterTuningJobArn", + "HyperParameterTuningJobStatus", + "Strategy", + "CreationTime", + "TrainingJobStatusCounters", + "ObjectiveStatusCounters" + ], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job.

    " + }, + "HyperParameterTuningJobArn":{ + "shape":"HyperParameterTuningJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the tuning job.

    " + }, + "HyperParameterTuningJobStatus":{ + "shape":"HyperParameterTuningJobStatus", + "documentation":"

    The status of the tuning job.

    " + }, + "Strategy":{ + "shape":"HyperParameterTuningJobStrategyType", + "documentation":"

    Specifies the search strategy hyperparameter tuning uses to choose which hyperparameters to use for each iteration. Currently, the only valid value is Bayesian.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the tuning job was created.

    " + }, + "HyperParameterTuningEndTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the tuning job ended.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the tuning job was modified.

    " + }, + "TrainingJobStatusCounters":{ + "shape":"TrainingJobStatusCounters", + "documentation":"

    The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

    " + }, + "ObjectiveStatusCounters":{ + "shape":"ObjectiveStatusCounters", + "documentation":"

    The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

    " + }, + "ResourceLimits":{ + "shape":"ResourceLimits", + "documentation":"

    The ResourceLimits object that specifies the maximum number of training jobs and parallel training jobs allowed for this tuning job.

    " + } + }, + "documentation":"

    Provides summary information about a hyperparameter tuning job.

    " + }, + "HyperParameterTuningJobWarmStartConfig":{ + "type":"structure", + "required":[ + "ParentHyperParameterTuningJobs", + "WarmStartType" + ], + "members":{ + "ParentHyperParameterTuningJobs":{ + "shape":"ParentHyperParameterTuningJobs", + "documentation":"

    An array of hyperparameter tuning jobs that are used as the starting point for the new hyperparameter tuning job. For more information about warm starting a hyperparameter tuning job, see Using a Previous Hyperparameter Tuning Job as a Starting Point.

    Hyperparameter tuning jobs created before October 1, 2018 cannot be used as parent jobs for warm start tuning jobs.

    " + }, + "WarmStartType":{ + "shape":"HyperParameterTuningJobWarmStartType", + "documentation":"

    Specifies one of the following:

    IDENTICAL_DATA_AND_ALGORITHM

    The new hyperparameter tuning job uses the same input data and training image as the parent tuning jobs. You can change the hyperparameter ranges to search and the maximum number of training jobs that the hyperparameter tuning job launches. You cannot use a new version of the training algorithm, unless the changes in the new version do not affect the algorithm itself. For example, changes that improve logging or adding support for a different data format are allowed. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

    TRANSFER_LEARNING

    The new hyperparameter tuning job can include input data, hyperparameter ranges, maximum number of concurrent training jobs, and maximum number of training jobs that are different than those of its parent hyperparameter tuning jobs. The training image can also be a different version from the version used in the parent hyperparameter tuning job. You can also change hyperparameters from tunable to static, and from static to tunable, but the total number of static plus tunable hyperparameters must remain the same as it is in all parent jobs. The objective metric for the new tuning job must be the same as for all parent jobs.

    " + } + }, + "documentation":"

    Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

    All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

    All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

    " + }, + "HyperParameterTuningJobWarmStartType":{ + "type":"string", + "enum":[ + "IdenticalDataAndAlgorithm", + "TransferLearning" + ] + }, + "HyperParameters":{ + "type":"map", + "key":{"shape":"ParameterKey"}, + "value":{"shape":"ParameterValue"}, + "max":100, + "min":0 + }, + "Image":{ + "type":"string", + "max":255, + "pattern":"[\\S]+" + }, + "ImageDigest":{ + "type":"string", + "max":72, + "pattern":"^[Ss][Hh][Aa]256:[0-9a-fA-F]{64}$" + }, + "InferenceSpecification":{ + "type":"structure", + "required":[ + "Containers", + "SupportedTransformInstanceTypes", + "SupportedRealtimeInferenceInstanceTypes", + "SupportedContentTypes", + "SupportedResponseMIMETypes" + ], + "members":{ + "Containers":{ + "shape":"ModelPackageContainerDefinitionList", + "documentation":"

    The Amazon ECR registry path of the Docker image that contains the inference code.

    " + }, + "SupportedTransformInstanceTypes":{ + "shape":"TransformInstanceTypes", + "documentation":"

    A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.

    " + }, + "SupportedRealtimeInferenceInstanceTypes":{ + "shape":"RealtimeInferenceInstanceTypes", + "documentation":"

    A list of the instance types that are used to generate inferences in real-time.

    " + }, + "SupportedContentTypes":{ + "shape":"ContentTypes", + "documentation":"

    The supported MIME types for the input data.

    " + }, + "SupportedResponseMIMETypes":{ + "shape":"ResponseMIMETypes", + "documentation":"

    The supported MIME types for the output data.

    " + } + }, + "documentation":"

    Defines how to perform inference generation after a training job is run.

    " + }, + "InputConfig":{ + "type":"structure", + "required":[ + "S3Uri", + "DataInputConfig", + "Framework" + ], + "members":{ + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

    The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    " + }, + "DataInputConfig":{ + "shape":"DataInputConfig", + "documentation":"

    Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. The data inputs are InputConfig$Framework specific.

    • TensorFlow: You must specify the name and shape (NHWC format) of the expected data inputs using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

      • Examples for one input:

        • If using the console, {\"input\":[1,1024,1024,3]}

        • If using the CLI, {\\\"input\\\":[1,1024,1024,3]}

      • Examples for two inputs:

        • If using the console, {\"data1\": [1,28,28,1], \"data2\":[1,28,28,1]}

        • If using the CLI, {\\\"data1\\\": [1,28,28,1], \\\"data2\\\":[1,28,28,1]}

    • MXNET/ONNX: You must specify the name and shape (NCHW format) of the expected data inputs in order using a dictionary format for your trained model. The dictionary formats required for the console and CLI are different.

      • Examples for one input:

        • If using the console, {\"data\":[1,3,1024,1024]}

        • If using the CLI, {\\\"data\\\":[1,3,1024,1024]}

      • Examples for two inputs:

        • If using the console, {\"var1\": [1,1,28,28], \"var2\":[1,1,28,28]}

        • If using the CLI, {\\\"var1\\\": [1,1,28,28], \\\"var2\\\":[1,1,28,28]}

    • PyTorch: You can either specify the name and shape (NCHW format) of expected data inputs in order using a dictionary format for your trained model or you can specify the shape only using a list format. The dictionary formats required for the console and CLI are different. The list formats for the console and CLI are the same.

      • Examples for one input in dictionary format:

        • If using the console, {\"input0\":[1,3,224,224]}

        • If using the CLI, {\\\"input0\\\":[1,3,224,224]}

      • Example for one input in list format: [[1,3,224,224]]

      • Examples for two inputs in dictionary format:

        • If using the console, {\"input0\":[1,3,224,224], \"input1\":[1,3,224,224]}

        • If using the CLI, {\\\"input0\\\":[1,3,224,224], \\\"input1\\\":[1,3,224,224]}

      • Example for two inputs in list format: [[1,3,224,224], [1,3,224,224]]

    • XGBOOST: input data name and shape are not needed.

    " + }, + "Framework":{ + "shape":"Framework", + "documentation":"

    Identifies the framework in which the model was trained. For example: TENSORFLOW.

    " + } + }, + "documentation":"

    Contains information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

    " + }, + "InputDataConfig":{ + "type":"list", + "member":{"shape":"Channel"}, + "max":20, + "min":1 + }, + "InputModes":{ + "type":"list", + "member":{"shape":"TrainingInputMode"}, + "min":1 + }, + "InstanceType":{ + "type":"string", + "enum":[ + "ml.t2.medium", + "ml.t2.large", + "ml.t2.xlarge", + "ml.t2.2xlarge", + "ml.t3.medium", + "ml.t3.large", + "ml.t3.xlarge", + "ml.t3.2xlarge", + "ml.m4.xlarge", + "ml.m4.2xlarge", + "ml.m4.4xlarge", + "ml.m4.10xlarge", + "ml.m4.16xlarge", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.12xlarge", + "ml.m5.24xlarge", + "ml.c4.xlarge", + "ml.c4.2xlarge", + "ml.c4.4xlarge", + "ml.c4.8xlarge", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.18xlarge", + "ml.c5d.xlarge", + "ml.c5d.2xlarge", + "ml.c5d.4xlarge", + "ml.c5d.9xlarge", + "ml.c5d.18xlarge", + "ml.p2.xlarge", + "ml.p2.8xlarge", + "ml.p2.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge" + ] + }, + "IntegerParameterRange":{ + "type":"structure", + "required":[ + "Name", + "MinValue", + "MaxValue" + ], + "members":{ + "Name":{ + "shape":"ParameterKey", + "documentation":"

    The name of the hyperparameter to search.

    " + }, + "MinValue":{ + "shape":"ParameterValue", + "documentation":"

    The minimum value of the hyperparameter to search.

    " + }, + "MaxValue":{ + "shape":"ParameterValue", + "documentation":"

    The maximum value of the hyperparameter to search.

    " + }, + "ScalingType":{ + "shape":"HyperParameterScalingType", + "documentation":"

    The scale that hyperparameter tuning uses to search the hyperparameter range. For information about choosing a hyperparameter scale, see Hyperparameter Scaling. One of the following values:

    Auto

    Amazon SageMaker hyperparameter tuning chooses the best scale for the hyperparameter.

    Linear

    Hyperparameter tuning searches the values in the hyperparameter range by using a linear scale.

    Logarithmic

    Hyperparemeter tuning searches the values in the hyperparameter range by using a logarithmic scale.

    Logarithmic scaling works only for ranges that have only values greater than 0.

    " + } + }, + "documentation":"

    For a hyperparameter of the integer type, specifies the range that a hyperparameter tuning job searches.

    " + }, + "IntegerParameterRangeSpecification":{ + "type":"structure", + "required":[ + "MinValue", + "MaxValue" + ], + "members":{ + "MinValue":{ + "shape":"ParameterValue", + "documentation":"

    The minimum integer value allowed.

    " + }, + "MaxValue":{ + "shape":"ParameterValue", + "documentation":"

    The maximum integer value allowed.

    " + } + }, + "documentation":"

    Defines the possible values for an integer hyperparameter.

    " + }, + "IntegerParameterRanges":{ + "type":"list", + "member":{"shape":"IntegerParameterRange"}, + "max":20, + "min":0 + }, + "JobReferenceCode":{ + "type":"string", + "min":1, + "pattern":".+" + }, + "JobReferenceCodeContains":{ + "type":"string", + "max":255, + "min":1, + "pattern":".+" + }, + "JoinSource":{ + "type":"string", + "enum":[ + "Input", + "None" + ] + }, + "JsonPath":{ + "type":"string", + "max":63, + "min":0 + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "pattern":".*" + }, + "LabelAttributeName":{ + "type":"string", + "max":127, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "LabelCounter":{ + "type":"integer", + "min":0 + }, + "LabelCounters":{ + "type":"structure", + "members":{ + "TotalLabeled":{ + "shape":"LabelCounter", + "documentation":"

    The total number of objects labeled.

    " + }, + "HumanLabeled":{ + "shape":"LabelCounter", + "documentation":"

    The total number of objects labeled by a human worker.

    " + }, + "MachineLabeled":{ + "shape":"LabelCounter", + "documentation":"

    The total number of objects labeled by automated data labeling.

    " + }, + "FailedNonRetryableError":{ + "shape":"LabelCounter", + "documentation":"

    The total number of objects that could not be labeled due to an error.

    " + }, + "Unlabeled":{ + "shape":"LabelCounter", + "documentation":"

    The total number of objects not yet labeled.

    " + } + }, + "documentation":"

    Provides a breakdown of the number of objects labeled.

    " + }, + "LabelCountersForWorkteam":{ + "type":"structure", + "members":{ + "HumanLabeled":{ + "shape":"LabelCounter", + "documentation":"

    The total number of data objects labeled by a human worker.

    " + }, + "PendingHuman":{ + "shape":"LabelCounter", + "documentation":"

    The total number of data objects that need to be labeled by a human worker.

    " + }, + "Total":{ + "shape":"LabelCounter", + "documentation":"

    The total number of tasks in the labeling job.

    " + } + }, + "documentation":"

    Provides counts for human-labeled tasks in the labeling job.

    " + }, + "LabelingJobAlgorithmSpecificationArn":{ + "type":"string", + "max":2048, + "pattern":"arn:.*" + }, + "LabelingJobAlgorithmsConfig":{ + "type":"structure", + "required":["LabelingJobAlgorithmSpecificationArn"], + "members":{ + "LabelingJobAlgorithmSpecificationArn":{ + "shape":"LabelingJobAlgorithmSpecificationArn", + "documentation":"

    Specifies the Amazon Resource Name (ARN) of the algorithm used for auto-labeling. You must select one of the following ARNs:

    • Image classification

      arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/image-classification

    • Text classification

      arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/text-classification

    • Object detection

      arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/object-detection

    • Semantic Segmentation

      arn:aws:sagemaker:region:027400017018:labeling-job-algorithm-specification/semantic-segmentation

    " + }, + "InitialActiveLearningModelArn":{ + "shape":"ModelArn", + "documentation":"

    At the end of an auto-label job Amazon SageMaker Ground Truth sends the Amazon Resource Nam (ARN) of the final model used for auto-labeling. You can use this model as the starting point for subsequent similar jobs by providing the ARN of the model here.

    " + }, + "LabelingJobResourceConfig":{ + "shape":"LabelingJobResourceConfig", + "documentation":"

    Provides configuration information for a labeling job.

    " + } + }, + "documentation":"

    Provides configuration information for auto-labeling of your data objects. A LabelingJobAlgorithmsConfig object must be supplied in order to use auto-labeling.

    " + }, + "LabelingJobArn":{ + "type":"string", + "max":2048, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:labeling-job/.*" + }, + "LabelingJobDataAttributes":{ + "type":"structure", + "members":{ + "ContentClassifiers":{ + "shape":"ContentClassifiers", + "documentation":"

    Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.

    " + } + }, + "documentation":"

    Attributes of the data specified by the customer. Use these to describe the data to be labeled.

    " + }, + "LabelingJobDataSource":{ + "type":"structure", + "required":["S3DataSource"], + "members":{ + "S3DataSource":{ + "shape":"LabelingJobS3DataSource", + "documentation":"

    The Amazon S3 location of the input data objects.

    " + } + }, + "documentation":"

    Provides information about the location of input data.

    " + }, + "LabelingJobForWorkteamSummary":{ + "type":"structure", + "required":[ + "JobReferenceCode", + "WorkRequesterAccountId", + "CreationTime" + ], + "members":{ + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name of the labeling job that the work team is assigned to.

    " + }, + "JobReferenceCode":{ + "shape":"JobReferenceCode", + "documentation":"

    A unique identifier for a labeling job. You can use this to refer to a specific labeling job.

    " + }, + "WorkRequesterAccountId":{ + "shape":"AccountId", + "documentation":"

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the labeling job was created.

    " + }, + "LabelCounters":{ + "shape":"LabelCountersForWorkteam", + "documentation":"

    Provides information about the progress of a labeling job.

    " + }, + "NumberOfHumanWorkersPerDataObject":{ + "shape":"NumberOfHumanWorkersPerDataObject", + "documentation":"

    The configured number of workers per data object.

    " + } + }, + "documentation":"

    Provides summary information for a work team.

    " + }, + "LabelingJobForWorkteamSummaryList":{ + "type":"list", + "member":{"shape":"LabelingJobForWorkteamSummary"} + }, + "LabelingJobInputConfig":{ + "type":"structure", + "required":["DataSource"], + "members":{ + "DataSource":{ + "shape":"LabelingJobDataSource", + "documentation":"

    The location of the input data.

    " + }, + "DataAttributes":{ + "shape":"LabelingJobDataAttributes", + "documentation":"

    Attributes of the data specified by the customer.

    " + } + }, + "documentation":"

    Input configuration information for a labeling job.

    " + }, + "LabelingJobName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "LabelingJobOutput":{ + "type":"structure", + "required":["OutputDatasetS3Uri"], + "members":{ + "OutputDatasetS3Uri":{ + "shape":"S3Uri", + "documentation":"

    The Amazon S3 bucket location of the manifest file for labeled data.

    " + }, + "FinalActiveLearningModelArn":{ + "shape":"ModelArn", + "documentation":"

    The Amazon Resource Name (ARN) for the most recent Amazon SageMaker model trained as part of automated data labeling.

    " + } + }, + "documentation":"

    Specifies the location of the output produced by the labeling job.

    " + }, + "LabelingJobOutputConfig":{ + "type":"structure", + "required":["S3OutputPath"], + "members":{ + "S3OutputPath":{ + "shape":"S3Uri", + "documentation":"

    The Amazon S3 location to write output data.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service ID of the key used to encrypt the output data, if any.

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for LabelingJobOutputConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

    The KMS key policy must grant permission to the IAM role that you specify in your CreateLabelingJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

    " + } + }, + "documentation":"

    Output configuration information for a labeling job.

    " + }, + "LabelingJobResourceConfig":{ + "type":"structure", + "members":{ + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

    • // KMS Key ID

      \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // Amazon Resource Name (ARN) of a KMS Key

      \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    " + } + }, + "documentation":"

    Provides configuration information for labeling jobs.

    " + }, + "LabelingJobS3DataSource":{ + "type":"structure", + "required":["ManifestS3Uri"], + "members":{ + "ManifestS3Uri":{ + "shape":"S3Uri", + "documentation":"

    The Amazon S3 location of the manifest file that describes the input data objects.

    " + } + }, + "documentation":"

    The Amazon S3 location of the input data objects.

    " + }, + "LabelingJobStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Failed", + "Stopping", + "Stopped" + ] + }, + "LabelingJobStoppingConditions":{ + "type":"structure", + "members":{ + "MaxHumanLabeledObjectCount":{ + "shape":"MaxHumanLabeledObjectCount", + "documentation":"

    The maximum number of objects that can be labeled by human workers.

    " + }, + "MaxPercentageOfInputDatasetLabeled":{ + "shape":"MaxPercentageOfInputDatasetLabeled", + "documentation":"

    The maximum number of input data objects that should be labeled.

    " + } + }, + "documentation":"

    A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped. You can use these conditions to control the cost of data labeling.

    " + }, + "LabelingJobSummary":{ + "type":"structure", + "required":[ + "LabelingJobName", + "LabelingJobArn", + "CreationTime", + "LastModifiedTime", + "LabelingJobStatus", + "LabelCounters", + "WorkteamArn", + "PreHumanTaskLambdaArn" + ], + "members":{ + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name of the labeling job.

    " + }, + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) assigned to the labeling job when it was created.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the job was created (timestamp).

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the job was last modified (timestamp).

    " + }, + "LabelingJobStatus":{ + "shape":"LabelingJobStatus", + "documentation":"

    The current status of the labeling job.

    " + }, + "LabelCounters":{ + "shape":"LabelCounters", + "documentation":"

    Counts showing the progress of the labeling job.

    " + }, + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the work team assigned to the job.

    " + }, + "PreHumanTaskLambdaArn":{ + "shape":"LambdaFunctionArn", + "documentation":"

    The Amazon Resource Name (ARN) of a Lambda function. The function is run before each data object is sent to a worker.

    " + }, + "AnnotationConsolidationLambdaArn":{ + "shape":"LambdaFunctionArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Lambda function used to consolidate the annotations from individual workers into a label for a data object. For more information, see Annotation Consolidation.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the LabelingJobStatus field is Failed, this field contains a description of the error.

    " + }, + "LabelingJobOutput":{ + "shape":"LabelingJobOutput", + "documentation":"

    The location of the output produced by the labeling job.

    " + }, + "InputConfig":{ + "shape":"LabelingJobInputConfig", + "documentation":"

    Input configuration for the labeling job.

    " + } + }, + "documentation":"

    Provides summary information about a labeling job.

    " + }, + "LabelingJobSummaryList":{ + "type":"list", + "member":{"shape":"LabelingJobSummary"} + }, + "LambdaFunctionArn":{ + "type":"string", + "max":2048, + "pattern":"arn:aws[a-z\\-]*:lambda:[a-z]{2}-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_\\.]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?" + }, + "LastModifiedTime":{"type":"timestamp"}, + "ListAlgorithmsInput":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only algorithms created after the specified time (timestamp).

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only algorithms created before the specified time (timestamp).

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of algorithms to return in the response.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response to a previous ListAlgorithms request was truncated, the response includes a NextToken. To retrieve the next set of algorithms, use the token in the next request.

    " + }, + "SortBy":{ + "shape":"AlgorithmSortBy", + "documentation":"

    The parameter by which to sort the results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for the results. The default is Ascending.

    " + } + } + }, + "ListAlgorithmsOutput":{ + "type":"structure", + "required":["AlgorithmSummaryList"], + "members":{ + "AlgorithmSummaryList":{ + "shape":"AlgorithmSummaryList", + "documentation":"

    >An array of AlgorithmSummary objects, each of which lists an algorithm.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

    " + } + } + }, + "ListCodeRepositoriesInput":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only Git repositories that were created after the specified time.

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only Git repositories that were created before the specified time.

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only Git repositories that were last modified after the specified time.

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only Git repositories that were last modified before the specified time.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of Git repositories to return in the response.

    " + }, + "NameContains":{ + "shape":"CodeRepositoryNameContains", + "documentation":"

    A string in the Git repositories name. This filter returns only repositories whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

    " + }, + "SortBy":{ + "shape":"CodeRepositorySortBy", + "documentation":"

    The field to sort results by. The default is Name.

    " + }, + "SortOrder":{ + "shape":"CodeRepositorySortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + } + } + }, + "ListCodeRepositoriesOutput":{ + "type":"structure", + "required":["CodeRepositorySummaryList"], + "members":{ + "CodeRepositorySummaryList":{ + "shape":"CodeRepositorySummaryList", + "documentation":"

    Gets a list of summaries of the Git repositories. Each summary specifies the following values for the repository:

    • Name

    • Amazon Resource Name (ARN)

    • Creation time

    • Last modified time

    • Configuration information, including the URL location of the repository and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of a ListCodeRepositoriesOutput request was truncated, the response includes a NextToken. To get the next set of Git repositories, use the token in the next request.

    " + } + } + }, + "ListCompilationJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken. To retrieve the next set of model compilation jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of model compilation jobs to return in the response.

    ", + "box":true + }, + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns the model compilation jobs that were created after a specified time.

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns the model compilation jobs that were created before a specified time.

    " + }, + "LastModifiedTimeAfter":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns the model compilation jobs that were modified after a specified time.

    " + }, + "LastModifiedTimeBefore":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns the model compilation jobs that were modified before a specified time.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A filter that returns the model compilation jobs whose name contains a specified string.

    " + }, + "StatusEquals":{ + "shape":"CompilationJobStatus", + "documentation":"

    A filter that retrieves model compilation jobs with a specific DescribeCompilationJobResponse$CompilationJobStatus status.

    " + }, + "SortBy":{ + "shape":"ListCompilationJobsSortBy", + "documentation":"

    The field by which to sort results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + } + } + }, + "ListCompilationJobsResponse":{ + "type":"structure", + "required":["CompilationJobSummaries"], + "members":{ + "CompilationJobSummaries":{ + "shape":"CompilationJobSummaries", + "documentation":"

    An array of CompilationJobSummary objects, each describing a model compilation job.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this NextToken. To retrieve the next set of model compilation jobs, use this token in the next request.

    " + } + } + }, + "ListCompilationJobsSortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, + "ListEndpointConfigsInput":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"EndpointConfigSortKey", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"OrderKey", + "documentation":"

    The sort order for results. The default is Descending.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the result of the previous ListEndpointConfig request was truncated, the response includes a NextToken. To retrieve the next set of endpoint configurations, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of training jobs to return in the response.

    " + }, + "NameContains":{ + "shape":"EndpointConfigNameContains", + "documentation":"

    A string in the endpoint configuration name. This filter returns only endpoint configurations whose name contains the specified string.

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoint configurations created before the specified time (timestamp).

    " + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoint configurations with a creation time greater than or equal to the specified time (timestamp).

    " + } + } + }, + "ListEndpointConfigsOutput":{ + "type":"structure", + "required":["EndpointConfigs"], + "members":{ + "EndpointConfigs":{ + "shape":"EndpointConfigSummaryList", + "documentation":"

    An array of endpoint configurations.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of endpoint configurations, use it in the subsequent request

    " + } + } + }, + "ListEndpointsInput":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"EndpointSortKey", + "documentation":"

    Sorts the list of results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"OrderKey", + "documentation":"

    The sort order for results. The default is Descending.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the result of a ListEndpoints request was truncated, the response includes a NextToken. To retrieve the next set of endpoints, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of endpoints to return in the response.

    " + }, + "NameContains":{ + "shape":"EndpointNameContains", + "documentation":"

    A string in endpoint names. This filter returns only endpoints whose name contains the specified string.

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoints that were created before the specified time (timestamp).

    " + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoints with a creation time greater than or equal to the specified time (timestamp).

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoints that were modified before the specified timestamp.

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only endpoints that were modified after the specified timestamp.

    " + }, + "StatusEquals":{ + "shape":"EndpointStatus", + "documentation":"

    A filter that returns only endpoints with the specified status.

    " + } + } + }, + "ListEndpointsOutput":{ + "type":"structure", + "required":["Endpoints"], + "members":{ + "Endpoints":{ + "shape":"EndpointSummaryList", + "documentation":"

    An array or endpoint objects.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

    " + } + } + }, + "ListHyperParameterTuningJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of tuning jobs to return. The default value is 10.

    ", + "box":true + }, + "SortBy":{ + "shape":"HyperParameterTuningJobSortByOptions", + "documentation":"

    The field to sort results by. The default is Name.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

    " + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only tuning jobs that were created after the specified time.

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only tuning jobs that were created before the specified time.

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only tuning jobs that were modified after the specified time.

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only tuning jobs that were modified before the specified time.

    " + }, + "StatusEquals":{ + "shape":"HyperParameterTuningJobStatus", + "documentation":"

    A filter that returns only tuning jobs with the specified status.

    " + } + } + }, + "ListHyperParameterTuningJobsResponse":{ + "type":"structure", + "required":["HyperParameterTuningJobSummaries"], + "members":{ + "HyperParameterTuningJobSummaries":{ + "shape":"HyperParameterTuningJobSummaries", + "documentation":"

    A list of HyperParameterTuningJobSummary objects that describe the tuning jobs that the ListHyperParameterTuningJobs request returned.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of this ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

    " + } + } + }, + "ListLabelingJobsForWorkteamRequest":{ + "type":"structure", + "required":["WorkteamArn"], + "members":{ + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of labeling jobs to return in each page of the response.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListLabelingJobsForWorkteam request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    " + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs created after the specified time (timestamp).

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs created before the specified time (timestamp).

    " + }, + "JobReferenceCodeContains":{ + "shape":"JobReferenceCodeContains", + "documentation":"

    A filter the limits jobs to only the ones whose job reference code contains the specified string.

    " + }, + "SortBy":{ + "shape":"ListLabelingJobsForWorkteamSortByOptions", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + } + } + }, + "ListLabelingJobsForWorkteamResponse":{ + "type":"structure", + "required":["LabelingJobSummaryList"], + "members":{ + "LabelingJobSummaryList":{ + "shape":"LabelingJobForWorkteamSummaryList", + "documentation":"

    An array of LabelingJobSummary objects, each describing a labeling job.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

    " + } + } + }, + "ListLabelingJobsForWorkteamSortByOptions":{ + "type":"string", + "enum":["CreationTime"] + }, + "ListLabelingJobsRequest":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs created after the specified time (timestamp).

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs created before the specified time (timestamp).

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs modified after the specified time (timestamp).

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only labeling jobs modified before the specified time (timestamp).

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of labeling jobs to return in each page of the response.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListLabelingJobs request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.

    " + }, + "SortBy":{ + "shape":"SortBy", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + }, + "StatusEquals":{ + "shape":"LabelingJobStatus", + "documentation":"

    A filter that retrieves only labeling jobs with a specific status.

    " + } + } + }, + "ListLabelingJobsResponse":{ + "type":"structure", + "members":{ + "LabelingJobSummaryList":{ + "shape":"LabelingJobSummaryList", + "documentation":"

    An array of LabelingJobSummary objects, each describing a labeling job.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.

    " + } + } + }, + "ListModelPackagesInput":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only model packages created after the specified time (timestamp).

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only model packages created before the specified time (timestamp).

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of model packages to return in the response.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the model package name. This filter returns only model packages whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.

    " + }, + "SortBy":{ + "shape":"ModelPackageSortBy", + "documentation":"

    The parameter by which to sort the results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for the results. The default is Ascending.

    " + } + } + }, + "ListModelPackagesOutput":{ + "type":"structure", + "required":["ModelPackageSummaryList"], + "members":{ + "ModelPackageSummaryList":{ + "shape":"ModelPackageSummaryList", + "documentation":"

    An array of ModelPackageSummary objects, each of which lists a model package.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.

    " + } + } + }, + "ListModelsInput":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"ModelSortKey", + "documentation":"

    Sorts the list of results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"OrderKey", + "documentation":"

    The sort order for results. The default is Descending.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response to a previous ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of models to return in the response.

    " + }, + "NameContains":{ + "shape":"ModelNameContains", + "documentation":"

    A string in the training job name. This filter returns only models in the training job whose name contains the specified string.

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only models created before the specified time (timestamp).

    " + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

    " + } + } + }, + "ListModelsOutput":{ + "type":"structure", + "required":["Models"], + "members":{ + "Models":{ + "shape":"ModelSummaryList", + "documentation":"

    An array of ModelSummary objects, each of which lists a model.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, use it in the subsequent request.

    " + } + } + }, + "ListNotebookInstanceLifecycleConfigsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of a ListNotebookInstanceLifecycleConfigs request was truncated, the response includes a NextToken. To get the next set of lifecycle configurations, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of lifecycle configurations to return in the response.

    " + }, + "SortBy":{ + "shape":"NotebookInstanceLifecycleConfigSortKey", + "documentation":"

    Sorts the list of results. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"NotebookInstanceLifecycleConfigSortOrder", + "documentation":"

    The sort order for results.

    " + }, + "NameContains":{ + "shape":"NotebookInstanceLifecycleConfigNameContains", + "documentation":"

    A string in the lifecycle configuration name. This filter returns only lifecycle configurations whose name contains the specified string.

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only lifecycle configurations that were created before the specified time (timestamp).

    " + }, + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only lifecycle configurations that were created after the specified time (timestamp).

    " + }, + "LastModifiedTimeBefore":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns only lifecycle configurations that were modified before the specified time (timestamp).

    " + }, + "LastModifiedTimeAfter":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns only lifecycle configurations that were modified after the specified time (timestamp).

    " + } + } + }, + "ListNotebookInstanceLifecycleConfigsOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To get the next set of lifecycle configurations, use it in the next request.

    " + }, + "NotebookInstanceLifecycleConfigs":{ + "shape":"NotebookInstanceLifecycleConfigSummaryList", + "documentation":"

    An array of NotebookInstanceLifecycleConfiguration objects, each listing a lifecycle configuration.

    " + } + } + }, + "ListNotebookInstancesInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

    You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of notebook instances to return.

    " + }, + "SortBy":{ + "shape":"NotebookInstanceSortKey", + "documentation":"

    The field to sort results by. The default is Name.

    " + }, + "SortOrder":{ + "shape":"NotebookInstanceSortOrder", + "documentation":"

    The sort order for results.

    " + }, + "NameContains":{ + "shape":"NotebookInstanceNameContains", + "documentation":"

    A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

    " + }, + "CreationTimeBefore":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only notebook instances that were created before the specified time (timestamp).

    " + }, + "CreationTimeAfter":{ + "shape":"CreationTime", + "documentation":"

    A filter that returns only notebook instances that were created after the specified time (timestamp).

    " + }, + "LastModifiedTimeBefore":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns only notebook instances that were modified before the specified time (timestamp).

    " + }, + "LastModifiedTimeAfter":{ + "shape":"LastModifiedTime", + "documentation":"

    A filter that returns only notebook instances that were modified after the specified time (timestamp).

    " + }, + "StatusEquals":{ + "shape":"NotebookInstanceStatus", + "documentation":"

    A filter that returns only notebook instances with the specified status.

    " + }, + "NotebookInstanceLifecycleConfigNameContains":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

    " + }, + "DefaultCodeRepositoryContains":{ + "shape":"CodeRepositoryContains", + "documentation":"

    A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

    " + }, + "AdditionalCodeRepositoryEquals":{ + "shape":"CodeRepositoryNameOrUrl", + "documentation":"

    A filter that returns only notebook instances with associated with the specified git repository.

    " + } + } + }, + "ListNotebookInstancesOutput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response to the previous ListNotebookInstances request was truncated, Amazon SageMaker returns this token. To retrieve the next set of notebook instances, use the token in the next request.

    " + }, + "NotebookInstances":{ + "shape":"NotebookInstanceSummaryList", + "documentation":"

    An array of NotebookInstanceSummary objects, one for each notebook instance.

    " + } + } + }, + "ListSubscribedWorkteamsRequest":{ + "type":"structure", + "members":{ + "NameContains":{ + "shape":"WorkteamName", + "documentation":"

    A string in the work team name. This filter returns only work teams whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListSubscribedWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of work teams to return in each page of the response.

    ", + "box":true + } + } + }, + "ListSubscribedWorkteamsResponse":{ + "type":"structure", + "required":["SubscribedWorkteams"], + "members":{ + "SubscribedWorkteams":{ + "shape":"SubscribedWorkteams", + "documentation":"

    An array of Workteam objects, each describing a work team.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

    " + } + } + }, + "ListTagsInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response to the previous ListTags request is truncated, Amazon SageMaker returns this token. To retrieve the next set of tags, use it in the subsequent request.

    " + }, + "MaxResults":{ + "shape":"ListTagsMaxResults", + "documentation":"

    Maximum number of tags to return.

    " + } + } + }, + "ListTagsMaxResults":{ + "type":"integer", + "min":50 + }, + "ListTagsOutput":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of Tag objects, each with a tag key and a value.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If response is truncated, Amazon SageMaker includes a token in the response. You can use this token in your subsequent request to fetch next set of tokens.

    " + } + } + }, + "ListTrainingJobsForHyperParameterTuningJobRequest":{ + "type":"structure", + "required":["HyperParameterTuningJobName"], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job whose training jobs you want to list.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of training jobs to return. The default value is 10.

    " + }, + "StatusEquals":{ + "shape":"TrainingJobStatus", + "documentation":"

    A filter that returns only training jobs with the specified status.

    " + }, + "SortBy":{ + "shape":"TrainingJobSortByOptions", + "documentation":"

    The field to sort results by. The default is Name.

    If the value of this field is FinalObjectiveMetricValue, any training jobs that did not return an objective metric are not listed.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + } + } + }, + "ListTrainingJobsForHyperParameterTuningJobResponse":{ + "type":"structure", + "required":["TrainingJobSummaries"], + "members":{ + "TrainingJobSummaries":{ + "shape":"HyperParameterTrainingJobSummaries", + "documentation":"

    A list of TrainingJobSummary objects that describe the training jobs that the ListTrainingJobsForHyperParameterTuningJob request returned.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of this ListTrainingJobsForHyperParameterTuningJob request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    " + } + } + }, + "ListTrainingJobsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListTrainingJobs request was truncated, the response includes a NextToken. To retrieve the next set of training jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of training jobs to return in the response.

    ", + "box":true + }, + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only training jobs created after the specified time (timestamp).

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only training jobs created before the specified time (timestamp).

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only training jobs modified after the specified time (timestamp).

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only training jobs modified before the specified time (timestamp).

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the training job name. This filter returns only training jobs whose name contains the specified string.

    " + }, + "StatusEquals":{ + "shape":"TrainingJobStatus", + "documentation":"

    A filter that retrieves only training jobs with a specific status.

    " + }, + "SortBy":{ + "shape":"SortBy", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + } + } + }, + "ListTrainingJobsResponse":{ + "type":"structure", + "required":["TrainingJobSummaries"], + "members":{ + "TrainingJobSummaries":{ + "shape":"TrainingJobSummaries", + "documentation":"

    An array of TrainingJobSummary objects, each listing a training job.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of training jobs, use it in the subsequent request.

    " + } + } + }, + "ListTransformJobsRequest":{ + "type":"structure", + "members":{ + "CreationTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only transform jobs created after the specified time.

    " + }, + "CreationTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only transform jobs created before the specified time.

    " + }, + "LastModifiedTimeAfter":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only transform jobs modified after the specified time.

    " + }, + "LastModifiedTimeBefore":{ + "shape":"Timestamp", + "documentation":"

    A filter that returns only transform jobs modified before the specified time.

    " + }, + "NameContains":{ + "shape":"NameContains", + "documentation":"

    A string in the transform job name. This filter returns only transform jobs whose name contains the specified string.

    " + }, + "StatusEquals":{ + "shape":"TransformJobStatus", + "documentation":"

    A filter that retrieves only transform jobs with a specific status.

    " + }, + "SortBy":{ + "shape":"SortBy", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Descending.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListTransformJobs request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of transform jobs to return in the response. The default value is 10.

    ", + "box":true + } + } + }, + "ListTransformJobsResponse":{ + "type":"structure", + "required":["TransformJobSummaries"], + "members":{ + "TransformJobSummaries":{ + "shape":"TransformJobSummaries", + "documentation":"

    An array of TransformJobSummary objects.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of transform jobs, use it in the next request.

    " + } + } + }, + "ListWorkteamsRequest":{ + "type":"structure", + "members":{ + "SortBy":{ + "shape":"ListWorkteamsSortByOptions", + "documentation":"

    The field to sort results by. The default is CreationTime.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order for results. The default is Ascending.

    " + }, + "NameContains":{ + "shape":"WorkteamName", + "documentation":"

    A string in the work team's name. This filter returns only work teams whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of work teams to return in each page of the response.

    ", + "box":true + } + } + }, + "ListWorkteamsResponse":{ + "type":"structure", + "required":["Workteams"], + "members":{ + "Workteams":{ + "shape":"Workteams", + "documentation":"

    An array of Workteam objects, each describing a work team.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.

    " + } + } + }, + "ListWorkteamsSortByOptions":{ + "type":"string", + "enum":[ + "Name", + "CreateDate" + ] + }, + "MaxConcurrentTaskCount":{ + "type":"integer", + "max":1000, + "min":1 + }, + "MaxConcurrentTransforms":{ + "type":"integer", + "min":0 + }, + "MaxHumanLabeledObjectCount":{ + "type":"integer", + "min":1 + }, + "MaxNumberOfTrainingJobs":{ + "type":"integer", + "min":1 + }, + "MaxParallelTrainingJobs":{ + "type":"integer", + "min":1 + }, + "MaxPayloadInMB":{ + "type":"integer", + "min":0 + }, + "MaxPercentageOfInputDatasetLabeled":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxRuntimeInSeconds":{ + "type":"integer", + "min":1 + }, + "MaxWaitTimeInSeconds":{ + "type":"integer", + "min":1 + }, + "MemberDefinition":{ + "type":"structure", + "members":{ + "CognitoMemberDefinition":{ + "shape":"CognitoMemberDefinition", + "documentation":"

    The Amazon Cognito user group that is part of the work team.

    " + } + }, + "documentation":"

    Defines the Amazon Cognito user group that is part of a work team.

    " + }, + "MemberDefinitions":{ + "type":"list", + "member":{"shape":"MemberDefinition"}, + "max":10, + "min":1 + }, + "MetricData":{ + "type":"structure", + "members":{ + "MetricName":{ + "shape":"MetricName", + "documentation":"

    The name of the metric.

    " + }, + "Value":{ + "shape":"Float", + "documentation":"

    The value of the metric.

    " + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the algorithm emitted the metric.

    " + } + }, + "documentation":"

    The name, value, and date and time of a metric that was emitted to Amazon CloudWatch.

    " + }, + "MetricDefinition":{ + "type":"structure", + "required":[ + "Name", + "Regex" + ], + "members":{ + "Name":{ + "shape":"MetricName", + "documentation":"

    The name of the metric.

    " + }, + "Regex":{ + "shape":"MetricRegex", + "documentation":"

    A regular expression that searches the output of a training job and gets the value of the metric. For more information about using regular expressions to define metrics, see Defining Objective Metrics.

    " + } + }, + "documentation":"

    Specifies a metric that the training algorithm writes to stderr or stdout . Amazon SageMakerhyperparameter tuning captures all defined metrics. You specify one metric that a hyperparameter tuning job uses as its objective metric to choose the best training job.

    " + }, + "MetricDefinitionList":{ + "type":"list", + "member":{"shape":"MetricDefinition"}, + "max":40, + "min":0 + }, + "MetricName":{ + "type":"string", + "max":255, + "min":1, + "pattern":".+" + }, + "MetricRegex":{ + "type":"string", + "max":500, + "min":1, + "pattern":".+" + }, + "MetricValue":{"type":"float"}, + "ModelArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model/.*" + }, + "ModelArtifacts":{ + "type":"structure", + "required":["S3ModelArtifacts"], + "members":{ + "S3ModelArtifacts":{ + "shape":"S3Uri", + "documentation":"

    The path of the S3 object that contains the model artifacts. For example, s3://bucket-name/keynameprefix/model.tar.gz.

    " + } + }, + "documentation":"

    Provides information about the location that is configured for storing model artifacts.

    " + }, + "ModelName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "ModelNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "ModelPackageArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:model-package/.*" + }, + "ModelPackageContainerDefinition":{ + "type":"structure", + "required":["Image"], + "members":{ + "ContainerHostname":{ + "shape":"ContainerHostname", + "documentation":"

    The DNS host name for the Docker container.

    " + }, + "Image":{ + "shape":"Image", + "documentation":"

    The Amazon EC2 Container Registry (Amazon ECR) path where inference code is stored.

    If you are using your own custom algorithm instead of an algorithm provided by Amazon SageMaker, the inference code must meet Amazon SageMaker requirements. Amazon SageMaker supports both registry/repository[:tag] and registry/repository[@digest] image path formats. For more information, see Using Your Own Algorithms with Amazon SageMaker.

    " + }, + "ImageDigest":{ + "shape":"ImageDigest", + "documentation":"

    An MD5 hash of the training algorithm that identifies the Docker image used for training.

    " + }, + "ModelDataUrl":{ + "shape":"Url", + "documentation":"

    The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    " + }, + "ProductId":{ + "shape":"ProductId", + "documentation":"

    The AWS Marketplace product ID of the model package.

    " + } + }, + "documentation":"

    Describes the Docker container for the model package.

    " + }, + "ModelPackageContainerDefinitionList":{ + "type":"list", + "member":{"shape":"ModelPackageContainerDefinition"}, + "max":1, + "min":1 + }, + "ModelPackageSortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, + "ModelPackageStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Completed", + "Failed", + "Deleting" + ] + }, + "ModelPackageStatusDetails":{ + "type":"structure", + "required":["ValidationStatuses"], + "members":{ + "ValidationStatuses":{ + "shape":"ModelPackageStatusItemList", + "documentation":"

    The validation status of the model package.

    " + }, + "ImageScanStatuses":{ + "shape":"ModelPackageStatusItemList", + "documentation":"

    The status of the scan of the Docker image container for the model package.

    " + } + }, + "documentation":"

    Specifies the validation and image scan statuses of the model package.

    " + }, + "ModelPackageStatusItem":{ + "type":"structure", + "required":[ + "Name", + "Status" + ], + "members":{ + "Name":{ + "shape":"EntityName", + "documentation":"

    The name of the model package for which the overall status is being reported.

    " + }, + "Status":{ + "shape":"DetailedModelPackageStatus", + "documentation":"

    The current status.

    " + }, + "FailureReason":{ + "shape":"String", + "documentation":"

    if the overall status is Failed, the reason for the failure.

    " + } + }, + "documentation":"

    Represents the overall status of a model package.

    " + }, + "ModelPackageStatusItemList":{ + "type":"list", + "member":{"shape":"ModelPackageStatusItem"} + }, + "ModelPackageSummary":{ + "type":"structure", + "required":[ + "ModelPackageName", + "ModelPackageArn", + "CreationTime", + "ModelPackageStatus" + ], + "members":{ + "ModelPackageName":{ + "shape":"EntityName", + "documentation":"

    The name of the model package.

    " + }, + "ModelPackageArn":{ + "shape":"ModelPackageArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model package.

    " + }, + "ModelPackageDescription":{ + "shape":"EntityDescription", + "documentation":"

    A brief description of the model package.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp that shows when the model package was created.

    " + }, + "ModelPackageStatus":{ + "shape":"ModelPackageStatus", + "documentation":"

    The overall status of the model package.

    " + } + }, + "documentation":"

    Provides summary information about a model package.

    " + }, + "ModelPackageSummaryList":{ + "type":"list", + "member":{"shape":"ModelPackageSummary"} + }, + "ModelPackageValidationProfile":{ + "type":"structure", + "required":[ + "ProfileName", + "TransformJobDefinition" + ], + "members":{ + "ProfileName":{ + "shape":"EntityName", + "documentation":"

    The name of the profile for the model package.

    " + }, + "TransformJobDefinition":{ + "shape":"TransformJobDefinition", + "documentation":"

    The TransformJobDefinition object that describes the transform job used for the validation of the model package.

    " + } + }, + "documentation":"

    Contains data, such as the inputs and targeted instance types that are used in the process of validating the model package.

    The data provided in the validation profile is made available to your buyers on AWS Marketplace.

    " + }, + "ModelPackageValidationProfiles":{ + "type":"list", + "member":{"shape":"ModelPackageValidationProfile"}, + "max":1, + "min":1 + }, + "ModelPackageValidationSpecification":{ + "type":"structure", + "required":[ + "ValidationRole", + "ValidationProfiles" + ], + "members":{ + "ValidationRole":{ + "shape":"RoleArn", + "documentation":"

    The IAM roles to be used for the validation of the model package.

    " + }, + "ValidationProfiles":{ + "shape":"ModelPackageValidationProfiles", + "documentation":"

    An array of ModelPackageValidationProfile objects, each of which specifies a batch transform job that Amazon SageMaker runs to validate your model package.

    " + } + }, + "documentation":"

    Specifies batch transform jobs that Amazon SageMaker runs to validate your model package.

    " + }, + "ModelSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime" + ] + }, + "ModelSummary":{ + "type":"structure", + "required":[ + "ModelName", + "ModelArn", + "CreationTime" + ], + "members":{ + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model that you want a summary for.

    " + }, + "ModelArn":{ + "shape":"ModelArn", + "documentation":"

    The Amazon Resource Name (ARN) of the model.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that indicates when the model was created.

    " + } + }, + "documentation":"

    Provides summary information about a model.

    " + }, + "ModelSummaryList":{ + "type":"list", + "member":{"shape":"ModelSummary"} + }, + "NameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9\\-]+" + }, + "NestedFilters":{ + "type":"structure", + "required":[ + "NestedPropertyName", + "Filters" + ], + "members":{ + "NestedPropertyName":{ + "shape":"ResourcePropertyName", + "documentation":"

    The name of the property to use in the nested filters. The value must match a listed property name, such as InputDataConfig .

    " + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

    A list of filters. Each filter acts on a property. Filters must contain at least one Filters value. For example, a NestedFilters call might include a filter on the PropertyName parameter of the InputDataConfig property: InputDataConfig.DataSource.S3DataSource.S3Uri.

    " + } + }, + "documentation":"

    Defines a list of NestedFilters objects. To satisfy the conditions specified in the NestedFilters call, a resource must satisfy the conditions of all of the filters.

    For example, you could define a NestedFilters using the training job's InputDataConfig property to filter on Channel objects.

    A NestedFilters object contains multiple filters. For example, to find all training jobs whose name contains train and that have cat/data in their S3Uri (specified in InputDataConfig), you need to create a NestedFilters object that specifies the InputDataConfig property with the following Filter objects:

    • '{Name:\"InputDataConfig.ChannelName\", \"Operator\":\"EQUALS\", \"Value\":\"train\"}',

    • '{Name:\"InputDataConfig.DataSource.S3DataSource.S3Uri\", \"Operator\":\"CONTAINS\", \"Value\":\"cat/data\"}'

    " + }, + "NestedFiltersList":{ + "type":"list", + "member":{"shape":"NestedFilters"}, + "max":20, + "min":1 + }, + "NetworkInterfaceId":{"type":"string"}, + "NextToken":{ + "type":"string", + "max":8192, + "pattern":".*" + }, + "NotebookInstanceAcceleratorType":{ + "type":"string", + "enum":[ + "ml.eia1.medium", + "ml.eia1.large", + "ml.eia1.xlarge", + "ml.eia2.medium", + "ml.eia2.large", + "ml.eia2.xlarge" + ] + }, + "NotebookInstanceAcceleratorTypes":{ + "type":"list", + "member":{"shape":"NotebookInstanceAcceleratorType"} + }, + "NotebookInstanceArn":{ + "type":"string", + "max":256 + }, + "NotebookInstanceLifecycleConfigArn":{ + "type":"string", + "max":256 + }, + "NotebookInstanceLifecycleConfigContent":{ + "type":"string", + "max":16384, + "min":1, + "pattern":"[\\S\\s]+" + }, + "NotebookInstanceLifecycleConfigList":{ + "type":"list", + "member":{"shape":"NotebookInstanceLifecycleHook"}, + "max":1 + }, + "NotebookInstanceLifecycleConfigName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "NotebookInstanceLifecycleConfigNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "NotebookInstanceLifecycleConfigSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "LastModifiedTime" + ] + }, + "NotebookInstanceLifecycleConfigSortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "NotebookInstanceLifecycleConfigSummary":{ + "type":"structure", + "required":[ + "NotebookInstanceLifecycleConfigName", + "NotebookInstanceLifecycleConfigArn" + ], + "members":{ + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration.

    " + }, + "NotebookInstanceLifecycleConfigArn":{ + "shape":"NotebookInstanceLifecycleConfigArn", + "documentation":"

    The Amazon Resource Name (ARN) of the lifecycle configuration.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp that tells when the lifecycle configuration was created.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    A timestamp that tells when the lifecycle configuration was last modified.

    " + } + }, + "documentation":"

    Provides a summary of a notebook instance lifecycle configuration.

    " + }, + "NotebookInstanceLifecycleConfigSummaryList":{ + "type":"list", + "member":{"shape":"NotebookInstanceLifecycleConfigSummary"} + }, + "NotebookInstanceLifecycleHook":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"NotebookInstanceLifecycleConfigContent", + "documentation":"

    A base64-encoded string that contains a shell script for a notebook instance lifecycle configuration.

    " + } + }, + "documentation":"

    Contains the notebook instance lifecycle configuration script.

    Each lifecycle configuration script has a limit of 16384 characters.

    The value of the $PATH environment variable that is available to both scripts is /sbin:bin:/usr/sbin:/usr/bin.

    View CloudWatch Logs for notebook instance lifecycle configurations in log group /aws/sagemaker/NotebookInstances in log stream [notebook-instance-name]/[LifecycleConfigHook].

    Lifecycle configuration scripts cannot run for longer than 5 minutes. If a script runs for longer than 5 minutes, it fails and the notebook instance is not created or started.

    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "NotebookInstanceName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "NotebookInstanceNameContains":{ + "type":"string", + "max":63, + "pattern":"[a-zA-Z0-9-]+" + }, + "NotebookInstanceSortKey":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, + "NotebookInstanceSortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "NotebookInstanceStatus":{ + "type":"string", + "enum":[ + "Pending", + "InService", + "Stopping", + "Stopped", + "Failed", + "Deleting", + "Updating" + ] + }, + "NotebookInstanceSummary":{ + "type":"structure", + "required":[ + "NotebookInstanceName", + "NotebookInstanceArn" + ], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance that you want a summary for.

    " + }, + "NotebookInstanceArn":{ + "shape":"NotebookInstanceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the notebook instance.

    " + }, + "NotebookInstanceStatus":{ + "shape":"NotebookInstanceStatus", + "documentation":"

    The status of the notebook instance.

    " + }, + "Url":{ + "shape":"NotebookInstanceUrl", + "documentation":"

    The URL that you use to connect to the Jupyter instance running in your notebook instance.

    " + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

    The type of ML compute instance that the notebook instance is running on.

    " + }, + "CreationTime":{ + "shape":"CreationTime", + "documentation":"

    A timestamp that shows when the notebook instance was created.

    " + }, + "LastModifiedTime":{ + "shape":"LastModifiedTime", + "documentation":"

    A timestamp that shows when the notebook instance was last modified.

    " + }, + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of a notebook instance lifecycle configuration associated with this notebook instance.

    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "DefaultCodeRepository":{ + "shape":"CodeRepositoryNameOrUrl", + "documentation":"

    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "AdditionalCodeRepositories":{ + "shape":"AdditionalCodeRepositoryNamesOrUrls", + "documentation":"

    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + } + }, + "documentation":"

    Provides summary information for an Amazon SageMaker notebook instance.

    " + }, + "NotebookInstanceSummaryList":{ + "type":"list", + "member":{"shape":"NotebookInstanceSummary"} + }, + "NotebookInstanceUrl":{"type":"string"}, + "NotebookInstanceVolumeSizeInGB":{ + "type":"integer", + "max":16384, + "min":5 + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "NotificationTopicArn":{ + "shape":"NotificationTopicArn", + "documentation":"

    The ARN for the SNS topic to which notifications should be published.

    " + } + }, + "documentation":"

    Configures SNS notifications of available or expiring work items for work teams.

    " + }, + "NotificationTopicArn":{ + "type":"string", + "pattern":"arn:aws[a-z\\-]*:sns:[a-z0-9\\-]*:[0-9]{12}:[a-zA-Z0-9_.-]*" + }, + "NumberOfHumanWorkersPerDataObject":{ + "type":"integer", + "max":9, + "min":1 + }, + "ObjectiveStatus":{ + "type":"string", + "enum":[ + "Succeeded", + "Pending", + "Failed" + ] + }, + "ObjectiveStatusCounter":{ + "type":"integer", + "min":0 + }, + "ObjectiveStatusCounters":{ + "type":"structure", + "members":{ + "Succeeded":{ + "shape":"ObjectiveStatusCounter", + "documentation":"

    The number of training jobs whose final objective metric was evaluated by the hyperparameter tuning job and used in the hyperparameter tuning process.

    " + }, + "Pending":{ + "shape":"ObjectiveStatusCounter", + "documentation":"

    The number of training jobs that are in progress and pending evaluation of their final objective metric.

    " + }, + "Failed":{ + "shape":"ObjectiveStatusCounter", + "documentation":"

    The number of training jobs whose final objective metric was not evaluated and used in the hyperparameter tuning process. This typically occurs when the training job failed or did not emit an objective metric.

    " + } + }, + "documentation":"

    Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

    " + }, + "Operator":{ + "type":"string", + "enum":[ + "Equals", + "NotEquals", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan", + "LessThanOrEqualTo", + "Contains" + ] + }, + "OrderKey":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "OutputConfig":{ + "type":"structure", + "required":[ + "S3OutputLocation", + "TargetDevice" + ], + "members":{ + "S3OutputLocation":{ + "shape":"S3Uri", + "documentation":"

    Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

    " + }, + "TargetDevice":{ + "shape":"TargetDevice", + "documentation":"

    Identifies the device that you want to run your model on after it has been compiled. For example: ml_c5.

    " + } + }, + "documentation":"

    Contains information about the output location for the compiled model and the device (target) that the model runs on.

    " + }, + "OutputDataConfig":{ + "type":"structure", + "required":["S3OutputPath"], + "members":{ + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

    • // KMS Key ID

      \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // Amazon Resource Name (ARN) of a KMS Key

      \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // KMS Key Alias

      \"alias/ExampleAlias\"

    • // Amazon Resource Name (ARN) of a KMS Key Alias

      \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

    If you use a KMS key ID or an alias of your master key, the Amazon SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. Amazon SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig. If you use a bucket policy with an s3:PutObject permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption to \"aws:kms\". For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

    The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

    " + }, + "S3OutputPath":{ + "shape":"S3Uri", + "documentation":"

    Identifies the S3 path where you want Amazon SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

    " + } + }, + "documentation":"

    Provides information about how to store model training results (model artifacts).

    " + }, + "PaginationToken":{ + "type":"string", + "max":8192, + "pattern":".*" + }, + "ParameterKey":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "ParameterName":{ + "type":"string", + "max":256, + "pattern":"[\\p{L}\\p{M}\\p{Z}\\p{S}\\p{N}\\p{P}]*" + }, + "ParameterRange":{ + "type":"structure", + "members":{ + "IntegerParameterRangeSpecification":{ + "shape":"IntegerParameterRangeSpecification", + "documentation":"

    A IntegerParameterRangeSpecification object that defines the possible values for an integer hyperparameter.

    " + }, + "ContinuousParameterRangeSpecification":{ + "shape":"ContinuousParameterRangeSpecification", + "documentation":"

    A ContinuousParameterRangeSpecification object that defines the possible values for a continuous hyperparameter.

    " + }, + "CategoricalParameterRangeSpecification":{ + "shape":"CategoricalParameterRangeSpecification", + "documentation":"

    A CategoricalParameterRangeSpecification object that defines the possible values for a categorical hyperparameter.

    " + } + }, + "documentation":"

    Defines the possible values for categorical, continuous, and integer hyperparameters to be used by an algorithm.

    " + }, + "ParameterRanges":{ + "type":"structure", + "members":{ + "IntegerParameterRanges":{ + "shape":"IntegerParameterRanges", + "documentation":"

    The array of IntegerParameterRange objects that specify ranges of integer hyperparameters that a hyperparameter tuning job searches.

    " + }, + "ContinuousParameterRanges":{ + "shape":"ContinuousParameterRanges", + "documentation":"

    The array of ContinuousParameterRange objects that specify ranges of continuous hyperparameters that a hyperparameter tuning job searches.

    " + }, + "CategoricalParameterRanges":{ + "shape":"CategoricalParameterRanges", + "documentation":"

    The array of CategoricalParameterRange objects that specify ranges of categorical hyperparameters that a hyperparameter tuning job searches.

    " + } + }, + "documentation":"

    Specifies ranges of integer, continuous, and categorical hyperparameters that a hyperparameter tuning job searches. The hyperparameter tuning job launches training jobs with hyperparameter values within these ranges to find the combination of values that result in the training job with the best performance as measured by the objective metric of the hyperparameter tuning job.

    You can specify a maximum of 20 hyperparameters that a hyperparameter tuning job can search over. Every possible value of a categorical parameter range counts against this limit.

    " + }, + "ParameterType":{ + "type":"string", + "enum":[ + "Integer", + "Continuous", + "Categorical", + "FreeText" + ] + }, + "ParameterValue":{ + "type":"string", + "max":256, + "pattern":".*" + }, + "ParameterValues":{ + "type":"list", + "member":{"shape":"ParameterValue"}, + "max":20, + "min":1 + }, + "ParentHyperParameterTuningJob":{ + "type":"structure", + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

    " + } + }, + "documentation":"

    A previously completed or stopped hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

    " + }, + "ParentHyperParameterTuningJobs":{ + "type":"list", + "member":{"shape":"ParentHyperParameterTuningJob"}, + "max":5, + "min":1 + }, + "ProductId":{ + "type":"string", + "max":256, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*$" + }, + "ProductListings":{ + "type":"list", + "member":{"shape":"String"} + }, + "ProductionVariant":{ + "type":"structure", + "required":[ + "VariantName", + "ModelName", + "InitialInstanceCount", + "InstanceType" + ], + "members":{ + "VariantName":{ + "shape":"VariantName", + "documentation":"

    The name of the production variant.

    " + }, + "ModelName":{ + "shape":"ModelName", + "documentation":"

    The name of the model that you want to host. This is the name that you specified when creating the model.

    " + }, + "InitialInstanceCount":{ + "shape":"TaskCount", + "documentation":"

    Number of instances to launch initially.

    " + }, + "InstanceType":{ + "shape":"ProductionVariantInstanceType", + "documentation":"

    The ML compute instance type.

    " + }, + "InitialVariantWeight":{ + "shape":"VariantWeight", + "documentation":"

    Determines initial traffic distribution among all of the models that you specify in the endpoint configuration. The traffic to a production variant is determined by the ratio of the VariantWeight to the sum of all VariantWeight values across all ProductionVariants. If unspecified, it defaults to 1.0.

    " + }, + "AcceleratorType":{ + "shape":"ProductionVariantAcceleratorType", + "documentation":"

    The size of the Elastic Inference (EI) instance to use for the production variant. EI instances provide on-demand GPU computing for inference. For more information, see Using Elastic Inference in Amazon SageMaker.

    " + } + }, + "documentation":"

    Identifies a model that you want to host and the resources to deploy for hosting it. If you are deploying multiple models, tell Amazon SageMaker how to distribute traffic among the models by specifying variant weights.

    " + }, + "ProductionVariantAcceleratorType":{ + "type":"string", + "enum":[ + "ml.eia1.medium", + "ml.eia1.large", + "ml.eia1.xlarge", + "ml.eia2.medium", + "ml.eia2.large", + "ml.eia2.xlarge" + ] + }, + "ProductionVariantInstanceType":{ + "type":"string", + "enum":[ + "ml.t2.medium", + "ml.t2.large", + "ml.t2.xlarge", + "ml.t2.2xlarge", + "ml.m4.xlarge", + "ml.m4.2xlarge", + "ml.m4.4xlarge", + "ml.m4.10xlarge", + "ml.m4.16xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.12xlarge", + "ml.m5.24xlarge", + "ml.m5d.large", + "ml.m5d.xlarge", + "ml.m5d.2xlarge", + "ml.m5d.4xlarge", + "ml.m5d.12xlarge", + "ml.m5d.24xlarge", + "ml.c4.large", + "ml.c4.xlarge", + "ml.c4.2xlarge", + "ml.c4.4xlarge", + "ml.c4.8xlarge", + "ml.p2.xlarge", + "ml.p2.8xlarge", + "ml.p2.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge", + "ml.c5.large", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.18xlarge", + "ml.c5d.large", + "ml.c5d.xlarge", + "ml.c5d.2xlarge", + "ml.c5d.4xlarge", + "ml.c5d.9xlarge", + "ml.c5d.18xlarge", + "ml.g4dn.xlarge", + "ml.g4dn.2xlarge", + "ml.g4dn.4xlarge", + "ml.g4dn.8xlarge", + "ml.g4dn.12xlarge", + "ml.g4dn.16xlarge", + "ml.r5.large", + "ml.r5.xlarge", + "ml.r5.2xlarge", + "ml.r5.4xlarge", + "ml.r5.12xlarge", + "ml.r5.24xlarge", + "ml.r5d.large", + "ml.r5d.xlarge", + "ml.r5d.2xlarge", + "ml.r5d.4xlarge", + "ml.r5d.12xlarge", + "ml.r5d.24xlarge" + ] + }, + "ProductionVariantList":{ + "type":"list", + "member":{"shape":"ProductionVariant"}, + "max":10, + "min":1 + }, + "ProductionVariantSummary":{ + "type":"structure", + "required":["VariantName"], + "members":{ + "VariantName":{ + "shape":"VariantName", + "documentation":"

    The name of the variant.

    " + }, + "DeployedImages":{ + "shape":"DeployedImages", + "documentation":"

    An array of DeployedImage objects that specify the Amazon EC2 Container Registry paths of the inference images deployed on instances of this ProductionVariant.

    " + }, + "CurrentWeight":{ + "shape":"VariantWeight", + "documentation":"

    The weight associated with the variant.

    " + }, + "DesiredWeight":{ + "shape":"VariantWeight", + "documentation":"

    The requested weight, as specified in the UpdateEndpointWeightsAndCapacities request.

    " + }, + "CurrentInstanceCount":{ + "shape":"TaskCount", + "documentation":"

    The number of instances associated with the variant.

    " + }, + "DesiredInstanceCount":{ + "shape":"TaskCount", + "documentation":"

    The number of instances requested in the UpdateEndpointWeightsAndCapacities request.

    " + } + }, + "documentation":"

    Describes weight and capacities for a production variant associated with an endpoint. If you sent a request to the UpdateEndpointWeightsAndCapacities API and the endpoint status is Updating, you get different desired and current values.

    " + }, + "ProductionVariantSummaryList":{ + "type":"list", + "member":{"shape":"ProductionVariantSummary"}, + "min":1 + }, + "PropertyNameHint":{ + "type":"string", + "max":100, + "min":0, + "pattern":".*" + }, + "PropertyNameQuery":{ + "type":"structure", + "required":["PropertyNameHint"], + "members":{ + "PropertyNameHint":{ + "shape":"PropertyNameHint", + "documentation":"

    Text that is part of a property's name. The property names of hyperparameter, metric, and tag key names that begin with the specified text in the PropertyNameHint.

    " + } + }, + "documentation":"

    A type of SuggestionQuery. A suggestion query for retrieving property names that match the specified hint.

    " + }, + "PropertyNameSuggestion":{ + "type":"structure", + "members":{ + "PropertyName":{ + "shape":"ResourcePropertyName", + "documentation":"

    A suggested property name based on what you entered in the search textbox in the Amazon SageMaker console.

    " + } + }, + "documentation":"

    A property name returned from a GetSearchSuggestions call that specifies a value in the PropertyNameQuery field.

    " + }, + "PropertyNameSuggestionList":{ + "type":"list", + "member":{"shape":"PropertyNameSuggestion"} + }, + "PublicWorkforceTaskPrice":{ + "type":"structure", + "members":{ + "AmountInUsd":{ + "shape":"USD", + "documentation":"

    Defines the amount of money paid to an Amazon Mechanical Turk worker in United States dollars.

    " + } + }, + "documentation":"

    Defines the amount of money paid to an Amazon Mechanical Turk worker for each task performed.

    Use one of the following prices for bounding box tasks. Prices are in US dollars and should be based on the complexity of the task; the longer it takes in your initial testing, the more you should offer.

    • 0.036

    • 0.048

    • 0.060

    • 0.072

    • 0.120

    • 0.240

    • 0.360

    • 0.480

    • 0.600

    • 0.720

    • 0.840

    • 0.960

    • 1.080

    • 1.200

    Use one of the following prices for image classification, text classification, and custom tasks. Prices are in US dollars.

    • 0.012

    • 0.024

    • 0.036

    • 0.048

    • 0.060

    • 0.072

    • 0.120

    • 0.240

    • 0.360

    • 0.480

    • 0.600

    • 0.720

    • 0.840

    • 0.960

    • 1.080

    • 1.200

    Use one of the following prices for semantic segmentation tasks. Prices are in US dollars.

    • 0.840

    • 0.960

    • 1.080

    • 1.200

    " + }, + "RealtimeInferenceInstanceTypes":{ + "type":"list", + "member":{"shape":"ProductionVariantInstanceType"} + }, + "RecordWrapper":{ + "type":"string", + "enum":[ + "None", + "RecordIO" + ] + }, + "RenderUiTemplateRequest":{ + "type":"structure", + "required":[ + "UiTemplate", + "Task", + "RoleArn" + ], + "members":{ + "UiTemplate":{ + "shape":"UiTemplate", + "documentation":"

    A Template object containing the worker UI template to render.

    " + }, + "Task":{ + "shape":"RenderableTask", + "documentation":"

    A RenderableTask object containing a representative task to render.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) that has access to the S3 objects that are used by the template.

    " + } + } + }, + "RenderUiTemplateResponse":{ + "type":"structure", + "required":[ + "RenderedContent", + "Errors" + ], + "members":{ + "RenderedContent":{ + "shape":"String", + "documentation":"

    A Liquid template that renders the HTML for the worker UI.

    " + }, + "Errors":{ + "shape":"RenderingErrorList", + "documentation":"

    A list of one or more RenderingError objects if any were encountered while rendering the template. If there were no errors, the list is empty.

    " + } + } + }, + "RenderableTask":{ + "type":"structure", + "required":["Input"], + "members":{ + "Input":{ + "shape":"TaskInput", + "documentation":"

    A JSON object that contains values for the variables defined in the template. It is made available to the template under the substitution variable task.input. For example, if you define a variable task.input.text in your template, you can supply the variable in the JSON object as \"text\": \"sample text\".

    " + } + }, + "documentation":"

    Contains input values for a task.

    " + }, + "RenderingError":{ + "type":"structure", + "required":[ + "Code", + "Message" + ], + "members":{ + "Code":{ + "shape":"String", + "documentation":"

    A unique identifier for a specific class of errors.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    A human-readable message describing the error.

    " + } + }, + "documentation":"

    A description of an error that occurred while rendering the template.

    " + }, + "RenderingErrorList":{ + "type":"list", + "member":{"shape":"RenderingError"} + }, + "ResourceArn":{ + "type":"string", + "max":256, + "pattern":"arn:.*" + }, + "ResourceConfig":{ + "type":"structure", + "required":[ + "InstanceType", + "InstanceCount", + "VolumeSizeInGB" + ], + "members":{ + "InstanceType":{ + "shape":"TrainingInstanceType", + "documentation":"

    The ML compute instance type.

    " + }, + "InstanceCount":{ + "shape":"TrainingInstanceCount", + "documentation":"

    The number of ML compute instances to use. For distributed training, provide a value greater than 1.

    " + }, + "VolumeSizeInGB":{ + "shape":"VolumeSizeInGB", + "documentation":"

    The size of the ML storage volume that you want to provision.

    ML storage volumes store model artifacts and incremental states. Training algorithms might also use the ML storage volume for scratch space. If you want to store the training data in the ML storage volume, choose File as the TrainingInputMode in the algorithm specification.

    You must specify sufficient ML storage for your scenario.

    Amazon SageMaker supports only the General Purpose SSD (gp2) ML storage volume type.

    " + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the training job. The VolumeKmsKeyId can be any of the following formats:

    • // KMS Key ID

      \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // Amazon Resource Name (ARN) of a KMS Key

      \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    " + } + }, + "documentation":"

    Describes the resources, including ML compute instances and ML storage volumes, to use for model training.

    " + }, + "ResourceInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"FailureReason"} + }, + "documentation":"

    Resource being accessed is in use.

    ", + "exception":true + }, + "ResourceLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"FailureReason"} + }, + "documentation":"

    You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.

    ", + "exception":true + }, + "ResourceLimits":{ + "type":"structure", + "required":[ + "MaxNumberOfTrainingJobs", + "MaxParallelTrainingJobs" + ], + "members":{ + "MaxNumberOfTrainingJobs":{ + "shape":"MaxNumberOfTrainingJobs", + "documentation":"

    The maximum number of training jobs that a hyperparameter tuning job can launch.

    " + }, + "MaxParallelTrainingJobs":{ + "shape":"MaxParallelTrainingJobs", + "documentation":"

    The maximum number of concurrent training jobs that a hyperparameter tuning job can launch.

    " + } + }, + "documentation":"

    Specifies the maximum number of training jobs and parallel training jobs that a hyperparameter tuning job can launch.

    " + }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"FailureReason"} + }, + "documentation":"

    Resource being access is not found.

    ", + "exception":true + }, + "ResourcePropertyName":{ + "type":"string", + "max":255, + "min":1, + "pattern":".+" + }, + "ResourceType":{ + "type":"string", + "enum":["TrainingJob"] + }, + "ResponseMIMEType":{ + "type":"string", + "max":1024, + "pattern":"^[-\\w]+\\/.+$" + }, + "ResponseMIMETypes":{ + "type":"list", + "member":{"shape":"ResponseMIMEType"} + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" + }, + "RootAccess":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "S3DataDistribution":{ + "type":"string", + "enum":[ + "FullyReplicated", + "ShardedByS3Key" + ] + }, + "S3DataSource":{ + "type":"structure", + "required":[ + "S3DataType", + "S3Uri" + ], + "members":{ + "S3DataType":{ + "shape":"S3DataType", + "documentation":"

    If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects that match the specified key name prefix for model training.

    If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for model training.

    If you choose AugmentedManifestFile, S3Uri identifies an object that is an augmented manifest file in JSON lines format. This file contains the data you want to use for model training. AugmentedManifestFile can only be used if the Channel's input mode is Pipe.

    " + }, + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

    Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

    • A key name prefix might look like this: s3://bucketname/exampleprefix.

    • A manifest might look like this: s3://bucketname/example.manifest

      The manifest is an S3 object which is a JSON file with the following format:

      [

      {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

      \"relative/path/to/custdata-1\",

      \"relative/path/custdata-2\",

      ...

      ]

      The preceding JSON matches the following s3Uris:

      s3://customer_bucket/some/prefix/relative/path/to/custdata-1

      s3://customer_bucket/some/prefix/relative/path/custdata-2

      ...

      The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

    " + }, + "S3DataDistributionType":{ + "shape":"S3DataDistribution", + "documentation":"

    If you want Amazon SageMaker to replicate the entire dataset on each ML compute instance that is launched for model training, specify FullyReplicated.

    If you want Amazon SageMaker to replicate a subset of data on each ML compute instance that is launched for model training, specify ShardedByS3Key. If there are n ML compute instances launched for a training job, each instance gets approximately 1/n of the number of S3 objects. In this case, model training on each machine uses only the subset of training data.

    Don't choose more ML compute instances for training than available S3 objects. If you do, some nodes won't get any data and you will pay for nodes that aren't getting any training data. This applies in both File and Pipe modes. Keep this in mind when developing algorithms.

    In distributed training, where you use multiple ML compute EC2 instances, you might choose ShardedByS3Key. If the algorithm requires copying training data to the ML storage volume (when TrainingInputMode is set to File), this copies 1/n of the number of objects.

    " + }, + "AttributeNames":{ + "shape":"AttributeNames", + "documentation":"

    A list of one or more attribute names to use that are found in a specified augmented manifest file.

    " + } + }, + "documentation":"

    Describes the S3 data source.

    " + }, + "S3DataType":{ + "type":"string", + "enum":[ + "ManifestFile", + "S3Prefix", + "AugmentedManifestFile" + ] + }, + "S3Uri":{ + "type":"string", + "max":1024, + "pattern":"^(https|s3)://([^/]+)/?(.*)$" + }, + "SearchExpression":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"FilterList", + "documentation":"

    A list of filter objects.

    " + }, + "NestedFilters":{ + "shape":"NestedFiltersList", + "documentation":"

    A list of nested filter objects.

    " + }, + "SubExpressions":{ + "shape":"SearchExpressionList", + "documentation":"

    A list of search expression objects.

    " + }, + "Operator":{ + "shape":"BooleanOperator", + "documentation":"

    A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

    " + } + }, + "documentation":"

    A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

    A SearchExpression contains the following components:

    • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

    • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

    • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

    • A Boolean operator: And or Or.

    " + }, + "SearchExpressionList":{ + "type":"list", + "member":{"shape":"SearchExpression"}, + "max":20, + "min":1 + }, + "SearchRecord":{ + "type":"structure", + "members":{ + "TrainingJob":{ + "shape":"TrainingJob", + "documentation":"

    A TrainingJob object that is returned as part of a Search request.

    " + } + }, + "documentation":"

    An individual search result record that contains a single resource object.

    " + }, + "SearchRequest":{ + "type":"structure", + "required":["Resource"], + "members":{ + "Resource":{ + "shape":"ResourceType", + "documentation":"

    The name of the Amazon SageMaker resource to search for. Currently, the only valid Resource value is TrainingJob.

    " + }, + "SearchExpression":{ + "shape":"SearchExpression", + "documentation":"

    A Boolean conditional statement. Resource objects must satisfy this condition to be included in search results. You must provide at least one subexpression, filter, or nested filter. The maximum number of recursive SubExpressions, NestedFilters, and Filters that can be included in a SearchExpression object is 50.

    " + }, + "SortBy":{ + "shape":"ResourcePropertyName", + "documentation":"

    The name of the resource property used to sort the SearchResults. The default is LastModifiedTime.

    " + }, + "SortOrder":{ + "shape":"SearchSortOrder", + "documentation":"

    How SearchResults are ordered. Valid values are Ascending or Descending. The default is Descending.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults resource objects match the specified SearchExpression, the SearchResponse includes a NextToken. The NextToken can be passed to the next SearchRequest to continue retrieving results for the specified SearchExpression and Sort parameters.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a SearchResponse.

    ", + "box":true + } + } + }, + "SearchResponse":{ + "type":"structure", + "members":{ + "Results":{ + "shape":"SearchResultsList", + "documentation":"

    A list of SearchResult objects.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous Search request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request.

    " + } + } + }, + "SearchResultsList":{ + "type":"list", + "member":{"shape":"SearchRecord"} + }, + "SearchSortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "SecondaryStatus":{ + "type":"string", + "enum":[ + "Starting", + "LaunchingMLInstances", + "PreparingTrainingStack", + "Downloading", + "DownloadingTrainingImage", + "Training", + "Uploading", + "Stopping", + "Stopped", + "MaxRuntimeExceeded", + "Completed", + "Failed", + "Interrupted", + "MaxWaitTimeExceeded" + ] + }, + "SecondaryStatusTransition":{ + "type":"structure", + "required":[ + "Status", + "StartTime" + ], + "members":{ + "Status":{ + "shape":"SecondaryStatus", + "documentation":"

    Contains a secondary status information from a training job.

    Status might be one of the following secondary statuses:

    InProgress

    • Starting - Starting the training job.

    • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

    • Training - Training is in progress.

    • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

    Completed

    • Completed - The training job has completed.

    Failed

    • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

    Stopped

    • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

    • Stopped - The training job has stopped.

    Stopping

    • Stopping - Stopping the training job.

    We no longer support the following secondary statuses:

    • LaunchingMLInstances

    • PreparingTrainingStack

    • DownloadingTrainingImage

    " + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the training job transitioned to the current secondary status state.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the training job transitioned out of this secondary status state into another secondary status state or when the training job has ended.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    A detailed description of the progress within a secondary status.

    Amazon SageMaker provides secondary statuses and status messages that apply to each of them:

    Starting

    • Starting the training job.

    • Launching requested ML instances.

    • Insufficient capacity error from EC2 while launching instances, retrying!

    • Launched instance was unhealthy, replacing it!

    • Preparing the instances for training.

    Training

    • Downloading the training image.

    • Training image download completed. Training in progress.

    Status messages are subject to change. Therefore, we recommend not including them in code that programmatically initiates actions. For examples, don't use status messages in if statements.

    To have an overview of your training job's progress, view TrainingJobStatus and SecondaryStatus in DescribeTrainingJob, and StatusMessage together. For example, at the start of a training job, you might see the following:

    • TrainingJobStatus - InProgress

    • SecondaryStatus - Training

    • StatusMessage - Downloading the training image

    " + } + }, + "documentation":"

    An array element of DescribeTrainingJobResponse$SecondaryStatusTransitions. It provides additional details about a status that the training job has transitioned through. A training job can be in one of several states, for example, starting, downloading, training, or uploading. Within each state, there are a number of intermediate states. For example, within the starting state, Amazon SageMaker could be starting the training job or launching the ML instances. These transitional states are referred to as the job's secondary status.

    " + }, + "SecondaryStatusTransitions":{ + "type":"list", + "member":{"shape":"SecondaryStatusTransition"} + }, + "SecretArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws[a-z\\-]*:secretsmanager:[a-z0-9\\-]*:[0-9]{12}:secret:.*" + }, + "SecurityGroupId":{ + "type":"string", + "max":32, + "pattern":"[-0-9a-zA-Z]+" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5 + }, + "Seed":{"type":"long"}, + "SessionExpirationDurationInSeconds":{ + "type":"integer", + "max":43200, + "min":1800 + }, + "ShuffleConfig":{ + "type":"structure", + "required":["Seed"], + "members":{ + "Seed":{ + "shape":"Seed", + "documentation":"

    Determines the shuffling order in ShuffleConfig value.

    " + } + }, + "documentation":"

    A configuration for a shuffle option for input data in a channel. If you use S3Prefix for S3DataType, the results of the S3 key prefix matches are shuffled. If you use ManifestFile, the order of the S3 object references in the ManifestFile is shuffled. If you use AugmentedManifestFile, the order of the JSON lines in the AugmentedManifestFile is shuffled. The shuffling order is determined using the Seed value.

    For Pipe input mode, shuffling is done at the start of every epoch. With large datasets, this ensures that the order of the training data is different for each epoch, and it helps reduce bias and possible overfitting. In a multi-node training job when ShuffleConfig is combined with S3DataDistributionType of ShardedByS3Key, the data is shuffled across nodes so that the content sent to a particular node on the first epoch might be sent to a different node on the second epoch.

    " + }, + "SortBy":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status" + ] + }, + "SortOrder":{ + "type":"string", + "enum":[ + "Ascending", + "Descending" + ] + }, + "SourceAlgorithm":{ + "type":"structure", + "required":["AlgorithmName"], + "members":{ + "ModelDataUrl":{ + "shape":"Url", + "documentation":"

    The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

    " + }, + "AlgorithmName":{ + "shape":"ArnOrName", + "documentation":"

    The name of an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

    " + } + }, + "documentation":"

    Specifies an algorithm that was used to create the model package. The algorithm must be either an algorithm resource in your Amazon SageMaker account or an algorithm in AWS Marketplace that you are subscribed to.

    " + }, + "SourceAlgorithmList":{ + "type":"list", + "member":{"shape":"SourceAlgorithm"}, + "max":1, + "min":1 + }, + "SourceAlgorithmSpecification":{ + "type":"structure", + "required":["SourceAlgorithms"], + "members":{ + "SourceAlgorithms":{ + "shape":"SourceAlgorithmList", + "documentation":"

    A list of the algorithms that were used to create a model package.

    " + } + }, + "documentation":"

    A list of algorithms that were used to create a model package.

    " + }, + "SplitType":{ + "type":"string", + "enum":[ + "None", + "Line", + "RecordIO", + "TFRecord" + ] + }, + "StartNotebookInstanceInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance to start.

    " + } + } + }, + "StatusMessage":{"type":"string"}, + "StopCompilationJobRequest":{ + "type":"structure", + "required":["CompilationJobName"], + "members":{ + "CompilationJobName":{ + "shape":"EntityName", + "documentation":"

    The name of the model compilation job to stop.

    " + } + } + }, + "StopHyperParameterTuningJobRequest":{ + "type":"structure", + "required":["HyperParameterTuningJobName"], + "members":{ + "HyperParameterTuningJobName":{ + "shape":"HyperParameterTuningJobName", + "documentation":"

    The name of the tuning job to stop.

    " + } + } + }, + "StopLabelingJobRequest":{ + "type":"structure", + "required":["LabelingJobName"], + "members":{ + "LabelingJobName":{ + "shape":"LabelingJobName", + "documentation":"

    The name of the labeling job to stop.

    " + } + } + }, + "StopNotebookInstanceInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance to terminate.

    " + } + } + }, + "StopTrainingJobRequest":{ + "type":"structure", + "required":["TrainingJobName"], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job to stop.

    " + } + } + }, + "StopTransformJobRequest":{ + "type":"structure", + "required":["TransformJobName"], + "members":{ + "TransformJobName":{ + "shape":"TransformJobName", + "documentation":"

    The name of the transform job to stop.

    " + } + } + }, + "StoppingCondition":{ + "type":"structure", + "members":{ + "MaxRuntimeInSeconds":{ + "shape":"MaxRuntimeInSeconds", + "documentation":"

    The maximum length of time, in seconds, that the training or compilation job can run. If job does not complete during this time, Amazon SageMaker ends the job. If value is not specified, default value is 1 day. The maximum value is 28 days.

    " + }, + "MaxWaitTimeInSeconds":{ + "shape":"MaxWaitTimeInSeconds", + "documentation":"

    The maximum length of time, in seconds, how long you are willing to wait for a managed spot training job to complete. It is the amount of time spent waiting for Spot capacity plus the amount of time the training job runs. It must be equal to or greater than MaxRuntimeInSeconds.

    " + } + }, + "documentation":"

    Specifies a limit to how long a model training or compilation job can run. It also specifies how long you are willing to wait for a managed spot training job to complete. When the job reaches the time limit, Amazon SageMaker ends the training or compilation job. Use this API to cap model training costs.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

    The training algorithms provided by Amazon SageMaker automatically save the intermediate results of a model training job when possible. This attempt to save artifacts is only a best effort case as model might not be in a state from which it can be saved. For example, if training has just started, the model might not be ready to save. When saved, this intermediate data is a valid model artifact. You can use it to create a model with CreateModel.

    The Neural Topic Model (NTM) currently does not support saving intermediate model artifacts. When training NTMs, make sure that the maximum runtime is sufficient for the training job to complete.

    " + }, + "String":{"type":"string"}, + "String200":{ + "type":"string", + "max":200, + "min":1, + "pattern":".+" + }, + "SubnetId":{ + "type":"string", + "max":32, + "pattern":"[-0-9a-zA-Z]+" + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16, + "min":1 + }, + "SubscribedWorkteam":{ + "type":"structure", + "required":["WorkteamArn"], + "members":{ + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) of the vendor that you have subscribed.

    " + }, + "MarketplaceTitle":{ + "shape":"String200", + "documentation":"

    The title of the service provided by the vendor in the Amazon Marketplace.

    " + }, + "SellerName":{ + "shape":"String", + "documentation":"

    The name of the vendor in the Amazon Marketplace.

    " + }, + "MarketplaceDescription":{ + "shape":"String200", + "documentation":"

    The description of the vendor from the Amazon Marketplace.

    " + }, + "ListingId":{ + "shape":"String", + "documentation":"

    " + } + }, + "documentation":"

    Describes a work team of a vendor that does the a labelling job.

    " + }, + "SubscribedWorkteams":{ + "type":"list", + "member":{"shape":"SubscribedWorkteam"} + }, + "Success":{"type":"boolean"}, + "SuggestionQuery":{ + "type":"structure", + "members":{ + "PropertyNameQuery":{ + "shape":"PropertyNameQuery", + "documentation":"

    A type of SuggestionQuery. Defines a property name hint. Only property names that match the specified hint are included in the response.

    " + } + }, + "documentation":"

    Limits the property names that are included in the response.

    " + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The tag key.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The tag value.

    " + } + }, + "documentation":"

    Describes a tag.

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":0 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TargetDevice":{ + "type":"string", + "enum":[ + "lambda", + "ml_m4", + "ml_m5", + "ml_c4", + "ml_c5", + "ml_p2", + "ml_p3", + "jetson_tx1", + "jetson_tx2", + "jetson_nano", + "rasp3b", + "deeplens", + "rk3399", + "rk3288", + "aisage", + "sbe_c", + "qcs605", + "qcs603" + ] + }, + "TaskAvailabilityLifetimeInSeconds":{ + "type":"integer", + "max":864000, + "min":1 + }, + "TaskCount":{ + "type":"integer", + "min":1 + }, + "TaskDescription":{ + "type":"string", + "max":255, + "min":1, + "pattern":".+" + }, + "TaskInput":{ + "type":"string", + "max":128000, + "min":2, + "pattern":"[\\S\\s]+" + }, + "TaskKeyword":{ + "type":"string", + "max":30, + "min":1, + "pattern":"^[A-Za-z0-9]+( [A-Za-z0-9]+)*$" + }, + "TaskKeywords":{ + "type":"list", + "member":{"shape":"TaskKeyword"}, + "max":5, + "min":1 + }, + "TaskTimeLimitInSeconds":{ + "type":"integer", + "max":28800, + "min":30 + }, + "TaskTitle":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[\\t\\n\\r -\\uD7FF\\uE000-\\uFFFD]*$" + }, + "TemplateContent":{ + "type":"string", + "max":128000, + "min":1, + "pattern":"[\\S\\s]+" + }, + "TenthFractionsOfACent":{ + "type":"integer", + "max":9, + "min":0 + }, + "Timestamp":{"type":"timestamp"}, + "TrainingInputMode":{ + "type":"string", + "enum":[ + "Pipe", + "File" + ] + }, + "TrainingInstanceCount":{ + "type":"integer", + "min":1 + }, + "TrainingInstanceType":{ + "type":"string", + "enum":[ + "ml.m4.xlarge", + "ml.m4.2xlarge", + "ml.m4.4xlarge", + "ml.m4.10xlarge", + "ml.m4.16xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.12xlarge", + "ml.m5.24xlarge", + "ml.c4.xlarge", + "ml.c4.2xlarge", + "ml.c4.4xlarge", + "ml.c4.8xlarge", + "ml.p2.xlarge", + "ml.p2.8xlarge", + "ml.p2.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge", + "ml.p3dn.24xlarge", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.18xlarge" + ] + }, + "TrainingInstanceTypes":{ + "type":"list", + "member":{"shape":"TrainingInstanceType"} + }, + "TrainingJob":{ + "type":"structure", + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job.

    " + }, + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the training job.

    " + }, + "TuningJobArn":{ + "shape":"HyperParameterTuningJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

    " + }, + "LabelingJobArn":{ + "shape":"LabelingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the labeling job.

    " + }, + "ModelArtifacts":{ + "shape":"ModelArtifacts", + "documentation":"

    Information about the Amazon S3 location that is configured for storing model artifacts.

    " + }, + "TrainingJobStatus":{ + "shape":"TrainingJobStatus", + "documentation":"

    The status of the training job.

    Training job statuses are:

    • InProgress - The training is in progress.

    • Completed - The training job has completed.

    • Failed - The training job has failed. To see the reason for the failure, see the FailureReason field in the response to a DescribeTrainingJobResponse call.

    • Stopping - The training job is stopping.

    • Stopped - The training job has stopped.

    For more detailed information, see SecondaryStatus.

    " + }, + "SecondaryStatus":{ + "shape":"SecondaryStatus", + "documentation":"

    Provides detailed information about the state of the training job. For detailed information about the secondary status of the training job, see StatusMessage under SecondaryStatusTransition.

    Amazon SageMaker provides primary statuses and secondary statuses that apply to each of them:

    InProgress

    • Starting - Starting the training job.

    • Downloading - An optional stage for algorithms that support File training input mode. It indicates that data is being downloaded to the ML storage volumes.

    • Training - Training is in progress.

    • Uploading - Training is complete and the model artifacts are being uploaded to the S3 location.

    Completed

    • Completed - The training job has completed.

    Failed

    • Failed - The training job has failed. The reason for the failure is returned in the FailureReason field of DescribeTrainingJobResponse.

    Stopped

    • MaxRuntimeExceeded - The job stopped because it exceeded the maximum allowed runtime.

    • Stopped - The training job has stopped.

    Stopping

    • Stopping - Stopping the training job.

    Valid values for SecondaryStatus are subject to change.

    We no longer support the following secondary statuses:

    • LaunchingMLInstances

    • PreparingTrainingStack

    • DownloadingTrainingImage

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the training job failed, the reason it failed.

    " + }, + "HyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    Algorithm-specific parameters.

    " + }, + "AlgorithmSpecification":{ + "shape":"AlgorithmSpecification", + "documentation":"

    Information about the algorithm used for training, and algorithm metadata.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The AWS Identity and Access Management (IAM) role configured for the training job.

    " + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

    An array of Channel objects that describes each data input channel.

    " + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

    The S3 path where model artifacts that you configured when creating the job are stored. Amazon SageMaker creates subfolders for model artifacts.

    " + }, + "ResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

    Resources, including ML compute instances and ML storage volumes, that are configured for model training.

    " + }, + "VpcConfig":{ + "shape":"VpcConfig", + "documentation":"

    A VpcConfig object that specifies the VPC that this training job has access to. For more information, see Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts, so the results of training are not lost.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that indicates when the training job was created.

    " + }, + "TrainingStartTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates the time when the training job starts on training instances. You are billed for the time interval between this time and the value of TrainingEndTime. The start time in CloudWatch Logs might be later than this time. The difference is due to the time it takes to download the training data and to the size of the training container.

    " + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when Amazon SageMaker detects a job failure.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that indicates when the status of the training job was last modified.

    " + }, + "SecondaryStatusTransitions":{ + "shape":"SecondaryStatusTransitions", + "documentation":"

    A history of all of the secondary statuses that the training job has transitioned through.

    " + }, + "FinalMetricDataList":{ + "shape":"FinalMetricDataList", + "documentation":"

    A list of final metric values that are set when the training job completes. Used only if the training job was configured to use metrics.

    " + }, + "EnableNetworkIsolation":{ + "shape":"Boolean", + "documentation":"

    If the TrainingJob was created with network isolation, the value is set to true. If network isolation is enabled, nodes can't communicate beyond the VPC they run in.

    " + }, + "EnableInterContainerTrafficEncryption":{ + "shape":"Boolean", + "documentation":"

    To encrypt all communications between ML compute instances in distributed training, choose True. Encryption provides greater security for distributed training, but training might take longer. How long it takes depends on the amount of communication between compute instances, especially if you use a deep learning algorithm in distributed training.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide.

    " + } + }, + "documentation":"

    Contains information about a training job.

    " + }, + "TrainingJobArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:training-job/.*" + }, + "TrainingJobDefinition":{ + "type":"structure", + "required":[ + "TrainingInputMode", + "InputDataConfig", + "OutputDataConfig", + "ResourceConfig", + "StoppingCondition" + ], + "members":{ + "TrainingInputMode":{ + "shape":"TrainingInputMode", + "documentation":"

    The input mode used by the algorithm for the training job. For the input modes that Amazon SageMaker algorithms support, see Algorithms.

    If an algorithm supports the File input mode, Amazon SageMaker downloads the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker volume for training container. If an algorithm supports the Pipe input mode, Amazon SageMaker streams data directly from S3 to the container.

    " + }, + "HyperParameters":{ + "shape":"HyperParameters", + "documentation":"

    The hyperparameters used for the training job.

    " + }, + "InputDataConfig":{ + "shape":"InputDataConfig", + "documentation":"

    An array of Channel objects, each of which specifies an input source.

    " + }, + "OutputDataConfig":{ + "shape":"OutputDataConfig", + "documentation":"

    the path to the S3 bucket where you want to store model artifacts. Amazon SageMaker creates subfolders for the artifacts.

    " + }, + "ResourceConfig":{ + "shape":"ResourceConfig", + "documentation":"

    The resources, including the ML compute instances and ML storage volumes, to use for model training.

    " + }, + "StoppingCondition":{ + "shape":"StoppingCondition", + "documentation":"

    Specifies a limit to how long a model training job can run. When the job reaches the time limit, Amazon SageMaker ends the training job. Use this API to cap model training costs.

    To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal, which delays job termination for 120 seconds. Algorithms can use this 120-second window to save the model artifacts.

    " + } + }, + "documentation":"

    Defines the input needed to run a training job using the algorithm.

    " + }, + "TrainingJobEarlyStoppingType":{ + "type":"string", + "enum":[ + "Off", + "Auto" + ] + }, + "TrainingJobName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "TrainingJobSortByOptions":{ + "type":"string", + "enum":[ + "Name", + "CreationTime", + "Status", + "FinalObjectiveMetricValue" + ] + }, + "TrainingJobStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Failed", + "Stopping", + "Stopped" + ] + }, + "TrainingJobStatusCounter":{ + "type":"integer", + "min":0 + }, + "TrainingJobStatusCounters":{ + "type":"structure", + "members":{ + "Completed":{ + "shape":"TrainingJobStatusCounter", + "documentation":"

    The number of completed training jobs launched by the hyperparameter tuning job.

    " + }, + "InProgress":{ + "shape":"TrainingJobStatusCounter", + "documentation":"

    The number of in-progress training jobs launched by a hyperparameter tuning job.

    " + }, + "RetryableError":{ + "shape":"TrainingJobStatusCounter", + "documentation":"

    The number of training jobs that failed, but can be retried. A failed training job can be retried only if it failed because an internal service error occurred.

    " + }, + "NonRetryableError":{ + "shape":"TrainingJobStatusCounter", + "documentation":"

    The number of training jobs that failed and can't be retried. A failed training job can't be retried if it failed because a client error occurred.

    " + }, + "Stopped":{ + "shape":"TrainingJobStatusCounter", + "documentation":"

    The number of training jobs launched by a hyperparameter tuning job that were manually stopped.

    " + } + }, + "documentation":"

    The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

    " + }, + "TrainingJobSummaries":{ + "type":"list", + "member":{"shape":"TrainingJobSummary"} + }, + "TrainingJobSummary":{ + "type":"structure", + "required":[ + "TrainingJobName", + "TrainingJobArn", + "CreationTime", + "TrainingJobStatus" + ], + "members":{ + "TrainingJobName":{ + "shape":"TrainingJobName", + "documentation":"

    The name of the training job that you want a summary for.

    " + }, + "TrainingJobArn":{ + "shape":"TrainingJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the training job.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the training job was created.

    " + }, + "TrainingEndTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the training job ended. This field is set only if the training job has one of the terminal statuses (Completed, Failed, or Stopped).

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    Timestamp when the training job was last modified.

    " + }, + "TrainingJobStatus":{ + "shape":"TrainingJobStatus", + "documentation":"

    The status of the training job.

    " + } + }, + "documentation":"

    Provides summary information about a training job.

    " + }, + "TrainingSpecification":{ + "type":"structure", + "required":[ + "TrainingImage", + "SupportedTrainingInstanceTypes", + "TrainingChannels" + ], + "members":{ + "TrainingImage":{ + "shape":"Image", + "documentation":"

    The Amazon ECR registry path of the Docker image that contains the training algorithm.

    " + }, + "TrainingImageDigest":{ + "shape":"ImageDigest", + "documentation":"

    An MD5 hash of the training algorithm that identifies the Docker image used for training.

    " + }, + "SupportedHyperParameters":{ + "shape":"HyperParameterSpecifications", + "documentation":"

    A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.>

    " + }, + "SupportedTrainingInstanceTypes":{ + "shape":"TrainingInstanceTypes", + "documentation":"

    A list of the instance types that this algorithm can use for training.

    " + }, + "SupportsDistributedTraining":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the algorithm supports distributed training. If set to false, buyers can’t request more than one instance during training.

    " + }, + "MetricDefinitions":{ + "shape":"MetricDefinitionList", + "documentation":"

    A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm.

    " + }, + "TrainingChannels":{ + "shape":"ChannelSpecifications", + "documentation":"

    A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm.

    " + }, + "SupportedTuningJobObjectiveMetrics":{ + "shape":"HyperParameterTuningJobObjectives", + "documentation":"

    A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

    " + } + }, + "documentation":"

    Defines how the algorithm is used for a training job.

    " + }, + "TrainingTimeInSeconds":{ + "type":"integer", + "min":1 + }, + "TransformDataSource":{ + "type":"structure", + "required":["S3DataSource"], + "members":{ + "S3DataSource":{ + "shape":"TransformS3DataSource", + "documentation":"

    The S3 location of the data source that is associated with a channel.

    " + } + }, + "documentation":"

    Describes the location of the channel data.

    " + }, + "TransformEnvironmentKey":{ + "type":"string", + "max":1024, + "pattern":"[a-zA-Z_][a-zA-Z0-9_]*" + }, + "TransformEnvironmentMap":{ + "type":"map", + "key":{"shape":"TransformEnvironmentKey"}, + "value":{"shape":"TransformEnvironmentValue"}, + "max":16 + }, + "TransformEnvironmentValue":{ + "type":"string", + "max":10240, + "pattern":"[\\S\\s]*" + }, + "TransformInput":{ + "type":"structure", + "required":["DataSource"], + "members":{ + "DataSource":{ + "shape":"TransformDataSource", + "documentation":"

    Describes the location of the channel data, which is, the S3 location of the input data that the model can consume.

    " + }, + "ContentType":{ + "shape":"ContentType", + "documentation":"

    The multipurpose internet mail extension (MIME) type of the data. Amazon SageMaker uses the MIME type with each http call to transfer data to the transform job.

    " + }, + "CompressionType":{ + "shape":"CompressionType", + "documentation":"

    If your transform data is compressed, specify the compression type. Amazon SageMaker automatically decompresses the data for the transform job accordingly. The default value is None.

    " + }, + "SplitType":{ + "shape":"SplitType", + "documentation":"

    The method to use to split the transform job's data files into smaller batches. Splitting is necessary when the total size of each object is too large to fit in a single request. You can also use data splitting to improve performance by processing multiple concurrent mini-batches. The default value for SplitType is None, which indicates that input data files are not split, and request payloads contain the entire contents of an input object. Set the value of this parameter to Line to split records on a newline character boundary. SplitType also supports a number of record-oriented binary data formats.

    When splitting is enabled, the size of a mini-batch depends on the values of the BatchStrategy and MaxPayloadInMB parameters. When the value of BatchStrategy is MultiRecord, Amazon SageMaker sends the maximum number of records in each request, up to the MaxPayloadInMB limit. If the value of BatchStrategy is SingleRecord, Amazon SageMaker sends individual records in each request.

    Some data formats represent a record as a binary payload wrapped with extra padding bytes. When splitting is applied to a binary data format, padding is removed if the value of BatchStrategy is set to SingleRecord. Padding is not removed if the value of BatchStrategy is set to MultiRecord.

    For more information about the RecordIO, see Data Format in the MXNet documentation. For more information about the TFRecord, see Consuming TFRecord data in the TensorFlow documentation.

    " + } + }, + "documentation":"

    Describes the input source of a transform job and the way the transform job consumes it.

    " + }, + "TransformInstanceCount":{ + "type":"integer", + "min":1 + }, + "TransformInstanceType":{ + "type":"string", + "enum":[ + "ml.m4.xlarge", + "ml.m4.2xlarge", + "ml.m4.4xlarge", + "ml.m4.10xlarge", + "ml.m4.16xlarge", + "ml.c4.xlarge", + "ml.c4.2xlarge", + "ml.c4.4xlarge", + "ml.c4.8xlarge", + "ml.p2.xlarge", + "ml.p2.8xlarge", + "ml.p2.16xlarge", + "ml.p3.2xlarge", + "ml.p3.8xlarge", + "ml.p3.16xlarge", + "ml.c5.xlarge", + "ml.c5.2xlarge", + "ml.c5.4xlarge", + "ml.c5.9xlarge", + "ml.c5.18xlarge", + "ml.m5.large", + "ml.m5.xlarge", + "ml.m5.2xlarge", + "ml.m5.4xlarge", + "ml.m5.12xlarge", + "ml.m5.24xlarge" + ] + }, + "TransformInstanceTypes":{ + "type":"list", + "member":{"shape":"TransformInstanceType"}, + "min":1 + }, + "TransformJobArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:transform-job/.*" + }, + "TransformJobDefinition":{ + "type":"structure", + "required":[ + "TransformInput", + "TransformOutput", + "TransformResources" + ], + "members":{ + "MaxConcurrentTransforms":{ + "shape":"MaxConcurrentTransforms", + "documentation":"

    The maximum number of parallel requests that can be sent to each instance in a transform job. The default value is 1.

    " + }, + "MaxPayloadInMB":{ + "shape":"MaxPayloadInMB", + "documentation":"

    The maximum payload size allowed, in MB. A payload is the data portion of a record (without metadata).

    " + }, + "BatchStrategy":{ + "shape":"BatchStrategy", + "documentation":"

    A string that determines the number of records included in a single mini-batch.

    SingleRecord means only one record is used per mini-batch. MultiRecord means a mini-batch is set to contain as many records that can fit within the MaxPayloadInMB limit.

    " + }, + "Environment":{ + "shape":"TransformEnvironmentMap", + "documentation":"

    The environment variables to set in the Docker container. We support up to 16 key and values entries in the map.

    " + }, + "TransformInput":{ + "shape":"TransformInput", + "documentation":"

    A description of the input source and the way the transform job consumes it.

    " + }, + "TransformOutput":{ + "shape":"TransformOutput", + "documentation":"

    Identifies the Amazon S3 location where you want Amazon SageMaker to save the results from the transform job.

    " + }, + "TransformResources":{ + "shape":"TransformResources", + "documentation":"

    Identifies the ML compute instances for the transform job.

    " + } + }, + "documentation":"

    Defines the input needed to run a transform job using the inference specification specified in the algorithm.

    " + }, + "TransformJobName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "TransformJobStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Completed", + "Failed", + "Stopping", + "Stopped" + ] + }, + "TransformJobSummaries":{ + "type":"list", + "member":{"shape":"TransformJobSummary"} + }, + "TransformJobSummary":{ + "type":"structure", + "required":[ + "TransformJobName", + "TransformJobArn", + "CreationTime", + "TransformJobStatus" + ], + "members":{ + "TransformJobName":{ + "shape":"TransformJobName", + "documentation":"

    The name of the transform job.

    " + }, + "TransformJobArn":{ + "shape":"TransformJobArn", + "documentation":"

    The Amazon Resource Name (ARN) of the transform job.

    " + }, + "CreationTime":{ + "shape":"Timestamp", + "documentation":"

    A timestamp that shows when the transform Job was created.

    " + }, + "TransformEndTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates when the transform job ends on compute instances. For successful jobs and stopped jobs, this is the exact time recorded after the results are uploaded. For failed jobs, this is when Amazon SageMaker detected that the job failed.

    " + }, + "LastModifiedTime":{ + "shape":"Timestamp", + "documentation":"

    Indicates when the transform job was last modified.

    " + }, + "TransformJobStatus":{ + "shape":"TransformJobStatus", + "documentation":"

    The status of the transform job.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the transform job failed, the reason it failed.

    " + } + }, + "documentation":"

    Provides a summary of a transform job. Multiple TransformJobSummary objects are returned as a list after in response to a ListTransformJobs call.

    " + }, + "TransformOutput":{ + "type":"structure", + "required":["S3OutputPath"], + "members":{ + "S3OutputPath":{ + "shape":"S3Uri", + "documentation":"

    The Amazon S3 path where you want Amazon SageMaker to store the results of the transform job. For example, s3://bucket-name/key-name-prefix.

    For every S3 object used as input for the transform job, batch transform stores the transformed data with an .out suffix in a corresponding subfolder in the location in the output prefix. For example, for the input data stored at s3://bucket-name/input-name-prefix/dataset01/data.csv, batch transform stores the transformed data at s3://bucket-name/output-name-prefix/input-name-prefix/data.csv.out. Batch transform doesn't upload partially processed objects. For an input S3 object that contains multiple records, it creates an .out file only if the transform job succeeds on the entire file. When the input contains multiple S3 objects, the batch transform job processes the listed S3 objects and uploads only the output for successfully processed objects. If any object fails in the transform job batch transform marks the job as failed to prompt investigation.

    " + }, + "Accept":{ + "shape":"Accept", + "documentation":"

    The MIME type used to specify the output data. Amazon SageMaker uses the MIME type with each http call to transfer data from the transform job.

    " + }, + "AssembleWith":{ + "shape":"AssemblyType", + "documentation":"

    Defines how to assemble the results of the transform job as a single S3 object. Choose a format that is most convenient to you. To concatenate the results in binary format, specify None. To add a newline character at the end of every transformed record, specify Line.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

    • // KMS Key ID

      \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // Amazon Resource Name (ARN) of a KMS Key

      \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // KMS Key Alias

      \"alias/ExampleAlias\"

    • // Amazon Resource Name (ARN) of a KMS Key Alias

      \"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"

    If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.

    The KMS key policy must grant permission to the IAM role that you specify in your CreateTramsformJob request. For more information, see Using Key Policies in AWS KMS in the AWS Key Management Service Developer Guide.

    " + } + }, + "documentation":"

    Describes the results of a transform job.

    " + }, + "TransformResources":{ + "type":"structure", + "required":[ + "InstanceType", + "InstanceCount" + ], + "members":{ + "InstanceType":{ + "shape":"TransformInstanceType", + "documentation":"

    The ML compute instance type for the transform job. If you are using built-in algorithms to transform moderately sized datasets, we recommend using ml.m4.xlarge or ml.m5.large instance types.

    " + }, + "InstanceCount":{ + "shape":"TransformInstanceCount", + "documentation":"

    The number of ML compute instances to use in the transform job. For distributed transform jobs, specify a value greater than 1. The default value is 1.

    " + }, + "VolumeKmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    The AWS Key Management Service (AWS KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the batch transform job. The VolumeKmsKeyId can be any of the following formats:

    • // KMS Key ID

      \"1234abcd-12ab-34cd-56ef-1234567890ab\"

    • // Amazon Resource Name (ARN) of a KMS Key

      \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"

    " + } + }, + "documentation":"

    Describes the resources, including ML instance types and ML instance count, to use for transform job.

    " + }, + "TransformS3DataSource":{ + "type":"structure", + "required":[ + "S3DataType", + "S3Uri" + ], + "members":{ + "S3DataType":{ + "shape":"S3DataType", + "documentation":"

    If you choose S3Prefix, S3Uri identifies a key name prefix. Amazon SageMaker uses all objects with the specified key name prefix for batch transform.

    If you choose ManifestFile, S3Uri identifies an object that is a manifest file containing a list of object keys that you want Amazon SageMaker to use for batch transform.

    The following values are compatible: ManifestFile, S3Prefix

    The following value is not compatible: AugmentedManifestFile

    " + }, + "S3Uri":{ + "shape":"S3Uri", + "documentation":"

    Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

    • A key name prefix might look like this: s3://bucketname/exampleprefix.

    • A manifest might look like this: s3://bucketname/example.manifest

      The manifest is an S3 object which is a JSON file with the following format:

      [

      {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

      \"relative/path/to/custdata-1\",

      \"relative/path/custdata-2\",

      ...

      ]

      The preceding JSON matches the following S3Uris:

      s3://customer_bucket/some/prefix/relative/path/to/custdata-1

      s3://customer_bucket/some/prefix/relative/path/custdata-1

      ...

      The complete set of S3Uris in this manifest constitutes the input data for the channel for this datasource. The object that each S3Uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

    " + } + }, + "documentation":"

    Describes the S3 data source.

    " + }, + "USD":{ + "type":"structure", + "members":{ + "Dollars":{ + "shape":"Dollars", + "documentation":"

    The whole number of dollars in the amount.

    " + }, + "Cents":{ + "shape":"Cents", + "documentation":"

    The fractional portion, in cents, of the amount.

    " + }, + "TenthFractionsOfACent":{ + "shape":"TenthFractionsOfACent", + "documentation":"

    Fractions of a cent, in tenths.

    " + } + }, + "documentation":"

    Represents an amount of money in United States dollars/

    " + }, + "UiConfig":{ + "type":"structure", + "required":["UiTemplateS3Uri"], + "members":{ + "UiTemplateS3Uri":{ + "shape":"S3Uri", + "documentation":"

    The Amazon S3 bucket location of the UI template. For more information about the contents of a UI template, see Creating Your Custom Labeling Task Template.

    " + } + }, + "documentation":"

    Provided configuration information for the worker UI for a labeling job.

    " + }, + "UiTemplate":{ + "type":"structure", + "required":["Content"], + "members":{ + "Content":{ + "shape":"TemplateContent", + "documentation":"

    The content of the Liquid template for the worker user interface.

    " + } + }, + "documentation":"

    The Liquid template for the worker user interface.

    " + }, + "UpdateCodeRepositoryInput":{ + "type":"structure", + "required":["CodeRepositoryName"], + "members":{ + "CodeRepositoryName":{ + "shape":"EntityName", + "documentation":"

    The name of the Git repository to update.

    " + }, + "GitConfig":{ + "shape":"GitConfigForUpdate", + "documentation":"

    The configuration of the git repository, including the URL and the Amazon Resource Name (ARN) of the AWS Secrets Manager secret that contains the credentials used to access the repository. The secret must have a staging label of AWSCURRENT and must be in the following format:

    {\"username\": UserName, \"password\": Password}

    " + } + } + }, + "UpdateCodeRepositoryOutput":{ + "type":"structure", + "required":["CodeRepositoryArn"], + "members":{ + "CodeRepositoryArn":{ + "shape":"CodeRepositoryArn", + "documentation":"

    The ARN of the Git repository.

    " + } + } + }, + "UpdateEndpointInput":{ + "type":"structure", + "required":[ + "EndpointName", + "EndpointConfigName" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of the endpoint whose configuration you want to update.

    " + }, + "EndpointConfigName":{ + "shape":"EndpointConfigName", + "documentation":"

    The name of the new endpoint configuration.

    " + } + } + }, + "UpdateEndpointOutput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

    The Amazon Resource Name (ARN) of the endpoint.

    " + } + } + }, + "UpdateEndpointWeightsAndCapacitiesInput":{ + "type":"structure", + "required":[ + "EndpointName", + "DesiredWeightsAndCapacities" + ], + "members":{ + "EndpointName":{ + "shape":"EndpointName", + "documentation":"

    The name of an existing Amazon SageMaker endpoint.

    " + }, + "DesiredWeightsAndCapacities":{ + "shape":"DesiredWeightAndCapacityList", + "documentation":"

    An object that provides new capacity and weight values for a variant.

    " + } + } + }, + "UpdateEndpointWeightsAndCapacitiesOutput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"EndpointArn", + "documentation":"

    The Amazon Resource Name (ARN) of the updated endpoint.

    " + } + } + }, + "UpdateNotebookInstanceInput":{ + "type":"structure", + "required":["NotebookInstanceName"], + "members":{ + "NotebookInstanceName":{ + "shape":"NotebookInstanceName", + "documentation":"

    The name of the notebook instance to update.

    " + }, + "InstanceType":{ + "shape":"InstanceType", + "documentation":"

    The Amazon ML compute instance type.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role that Amazon SageMaker can assume to access the notebook instance. For more information, see Amazon SageMaker Roles.

    To be able to pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission.

    " + }, + "LifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of a lifecycle configuration to associate with the notebook instance. For information about lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

    " + }, + "DisassociateLifecycleConfig":{ + "shape":"DisassociateNotebookInstanceLifecycleConfig", + "documentation":"

    Set to true to remove the notebook instance lifecycle configuration currently associated with the notebook instance. This operation is idempotent. If you specify a lifecycle configuration that is not associated with the notebook instance when you call this method, it does not throw an error.

    " + }, + "VolumeSizeInGB":{ + "shape":"NotebookInstanceVolumeSizeInGB", + "documentation":"

    The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. ML storage volumes are encrypted, so Amazon SageMaker can't determine the amount of available free space on the volume. Because of this, you can increase the volume size when you update a notebook instance, but you can't decrease the volume size. If you want to decrease the size of the ML storage volume in use, create a new notebook instance with the desired size.

    " + }, + "DefaultCodeRepository":{ + "shape":"CodeRepositoryNameOrUrl", + "documentation":"

    The Git repository to associate with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in AWS CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "AdditionalCodeRepositories":{ + "shape":"AdditionalCodeRepositoryNamesOrUrls", + "documentation":"

    An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in AWS CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with Amazon SageMaker Notebook Instances.

    " + }, + "AcceleratorTypes":{ + "shape":"NotebookInstanceAcceleratorTypes", + "documentation":"

    A list of the Elastic Inference (EI) instance types to associate with this notebook instance. Currently only one EI instance type can be associated with a notebook instance. For more information, see Using Elastic Inference in Amazon SageMaker.

    " + }, + "DisassociateAcceleratorTypes":{ + "shape":"DisassociateNotebookInstanceAcceleratorTypes", + "documentation":"

    A list of the Elastic Inference (EI) instance types to remove from this notebook instance. This operation is idempotent. If you specify an accelerator type that is not associated with the notebook instance when you call this method, it does not throw an error.

    " + }, + "DisassociateDefaultCodeRepository":{ + "shape":"DisassociateDefaultCodeRepository", + "documentation":"

    The name or URL of the default Git repository to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

    " + }, + "DisassociateAdditionalCodeRepositories":{ + "shape":"DisassociateAdditionalCodeRepositories", + "documentation":"

    A list of names or URLs of the default Git repositories to remove from this notebook instance. This operation is idempotent. If you specify a Git repository that is not associated with the notebook instance when you call this method, it does not throw an error.

    " + }, + "RootAccess":{ + "shape":"RootAccess", + "documentation":"

    Whether root access is enabled or disabled for users of the notebook instance. The default value is Enabled.

    If you set this to Disabled, users don't have root access on the notebook instance, but lifecycle configuration scripts still run with root permissions.

    " + } + } + }, + "UpdateNotebookInstanceLifecycleConfigInput":{ + "type":"structure", + "required":["NotebookInstanceLifecycleConfigName"], + "members":{ + "NotebookInstanceLifecycleConfigName":{ + "shape":"NotebookInstanceLifecycleConfigName", + "documentation":"

    The name of the lifecycle configuration.

    " + }, + "OnCreate":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    The shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

    " + }, + "OnStart":{ + "shape":"NotebookInstanceLifecycleConfigList", + "documentation":"

    The shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

    " + } + } + }, + "UpdateNotebookInstanceLifecycleConfigOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateNotebookInstanceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateWorkteamRequest":{ + "type":"structure", + "required":["WorkteamName"], + "members":{ + "WorkteamName":{ + "shape":"WorkteamName", + "documentation":"

    The name of the work team to update.

    " + }, + "MemberDefinitions":{ + "shape":"MemberDefinitions", + "documentation":"

    A list of MemberDefinition objects that contain the updated work team members.

    " + }, + "Description":{ + "shape":"String200", + "documentation":"

    An updated description for the work team.

    " + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

    Configures SNS topic notifications for available or expiring work items

    " + } + } + }, + "UpdateWorkteamResponse":{ + "type":"structure", + "required":["Workteam"], + "members":{ + "Workteam":{ + "shape":"Workteam", + "documentation":"

    A Workteam object that describes the updated work team.

    " + } + } + }, + "Url":{ + "type":"string", + "max":1024, + "pattern":"^(https|s3)://([^/]+)/?(.*)$" + }, + "VariantName":{ + "type":"string", + "max":63, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "VariantWeight":{ + "type":"float", + "min":0 + }, + "VolumeSizeInGB":{ + "type":"integer", + "min":1 + }, + "VpcConfig":{ + "type":"structure", + "required":[ + "SecurityGroupIds", + "Subnets" + ], + "members":{ + "SecurityGroupIds":{ + "shape":"VpcSecurityGroupIds", + "documentation":"

    The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.

    " + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"

    The ID of the subnets in the VPC to which you want to connect your training job or model.

    Amazon EC2 P3 accelerated computing instances are not available in the c/d/e availability zones of region us-east-1. If you want to create endpoints with P3 instances in VPC mode in region us-east-1, create subnets in a/b/f availability zones instead.

    " + } + }, + "documentation":"

    Specifies a VPC that your training jobs and hosted models have access to. Control access to and from your training and model containers by configuring the VPC. For more information, see Protect Endpoints by Using an Amazon Virtual Private Cloud and Protect Training Jobs by Using an Amazon Virtual Private Cloud.

    " + }, + "VpcSecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, + "Workteam":{ + "type":"structure", + "required":[ + "WorkteamName", + "MemberDefinitions", + "WorkteamArn", + "Description" + ], + "members":{ + "WorkteamName":{ + "shape":"WorkteamName", + "documentation":"

    The name of the work team.

    " + }, + "MemberDefinitions":{ + "shape":"MemberDefinitions", + "documentation":"

    The Amazon Cognito user groups that make up the work team.

    " + }, + "WorkteamArn":{ + "shape":"WorkteamArn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the work team.

    " + }, + "ProductListingIds":{ + "shape":"ProductListings", + "documentation":"

    The Amazon Marketplace identifier for a vendor's work team.

    " + }, + "Description":{ + "shape":"String200", + "documentation":"

    A description of the work team.

    " + }, + "SubDomain":{ + "shape":"String", + "documentation":"

    The URI of the labeling job's user interface. Workers open this URI to start labeling your data objects.

    " + }, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the work team was created (timestamp).

    " + }, + "LastUpdatedDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the work team was last updated (timestamp).

    " + }, + "NotificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

    Configures SNS notifications of available or expiring work items for work teams.

    " + } + }, + "documentation":"

    Provides details about a labeling work team.

    " + }, + "WorkteamArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:workteam/.*" + }, + "WorkteamName":{ + "type":"string", + "max":63, + "min":1, + "pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, + "Workteams":{ + "type":"list", + "member":{"shape":"Workteam"} + } + }, + "documentation":"

    Provides APIs for creating and managing Amazon SageMaker resources.

    " +} diff --git a/aws/dist/botocore/data/sagemaker/2017-07-24/waiters-2.json b/aws/dist/botocore/data/sagemaker/2017-07-24/waiters-2.json new file mode 100644 index 00000000..d033ea33 --- /dev/null +++ b/aws/dist/botocore/data/sagemaker/2017-07-24/waiters-2.json @@ -0,0 +1,163 @@ +{ + "version": 2, + "waiters": { + "NotebookInstanceInService": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeNotebookInstance", + "acceptors": [ + { + "expected": "InService", + "matcher": "path", + "state": "success", + "argument": "NotebookInstanceStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "NotebookInstanceStopped": { + "delay": 30, + "operation": "DescribeNotebookInstance", + "maxAttempts": 60, + "acceptors": [ + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "NotebookInstanceStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "NotebookInstanceDeleted": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeNotebookInstance", + "acceptors": [ + { + "expected": "ValidationException", + "matcher": "error", + "state": "success" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "NotebookInstanceStatus" + } + ] + }, + "TrainingJobCompletedOrStopped": { + "delay": 120, + "maxAttempts": 180, + "operation": "DescribeTrainingJob", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "TrainingJobStatus" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "TrainingJobStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "TrainingJobStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + }, + "EndpointInService": { + "delay": 30, + "maxAttempts": 120, + "operation": "DescribeEndpoint", + "acceptors": [ + { + "expected": "InService", + "matcher": "path", + "state": "success", + "argument": "EndpointStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "EndpointStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + }, + "EndpointDeleted": { + "delay": 30, + "maxAttempts": 60, + "operation": "DescribeEndpoint", + "acceptors": [ + { + "expected": "ValidationException", + "matcher": "error", + "state": "success" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "EndpointStatus" + } + ] + }, + "TransformJobCompletedOrStopped": { + "delay": 60, + "maxAttempts": 60, + "operation": "DescribeTransformJob", + "acceptors": [ + { + "expected": "Completed", + "matcher": "path", + "state": "success", + "argument": "TransformJobStatus" + }, + { + "expected": "Stopped", + "matcher": "path", + "state": "success", + "argument": "TransformJobStatus" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "TransformJobStatus" + }, + { + "expected": "ValidationException", + "matcher": "error", + "state": "failure" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/savingsplans/2019-06-28/paginators-1.json b/aws/dist/botocore/data/savingsplans/2019-06-28/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/savingsplans/2019-06-28/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/savingsplans/2019-06-28/service-2.json b/aws/dist/botocore/data/savingsplans/2019-06-28/service-2.json new file mode 100644 index 00000000..27306bff --- /dev/null +++ b/aws/dist/botocore/data/savingsplans/2019-06-28/service-2.json @@ -0,0 +1,1129 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-06-28", + "endpointPrefix":"savingsplans", + "globalEndpoint":"savingsplans.amazonaws.com", + "jsonVersion":"1.0", + "protocol":"rest-json", + "serviceAbbreviation":"AWSSavingsPlans", + "serviceFullName":"AWS Savings Plans", + "serviceId":"savingsplans", + "signatureVersion":"v4", + "uid":"savingsplans-2019-06-28" + }, + "operations":{ + "CreateSavingsPlan":{ + "name":"CreateSavingsPlan", + "http":{ + "method":"POST", + "requestUri":"/CreateSavingsPlan" + }, + "input":{"shape":"CreateSavingsPlanRequest"}, + "output":{"shape":"CreateSavingsPlanResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

    Creates a Savings Plan.

    " + }, + "DescribeSavingsPlanRates":{ + "name":"DescribeSavingsPlanRates", + "http":{ + "method":"POST", + "requestUri":"/DescribeSavingsPlanRates" + }, + "input":{"shape":"DescribeSavingsPlanRatesRequest"}, + "output":{"shape":"DescribeSavingsPlanRatesResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ], + "documentation":"

    Describes the specified Savings Plans rates.

    " + }, + "DescribeSavingsPlans":{ + "name":"DescribeSavingsPlans", + "http":{ + "method":"POST", + "requestUri":"/DescribeSavingsPlans" + }, + "input":{"shape":"DescribeSavingsPlansRequest"}, + "output":{"shape":"DescribeSavingsPlansResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ], + "documentation":"

    Describes the specified Savings Plans.

    " + }, + "DescribeSavingsPlansOfferingRates":{ + "name":"DescribeSavingsPlansOfferingRates", + "http":{ + "method":"POST", + "requestUri":"/DescribeSavingsPlansOfferingRates" + }, + "input":{"shape":"DescribeSavingsPlansOfferingRatesRequest"}, + "output":{"shape":"DescribeSavingsPlansOfferingRatesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Describes the specified Savings Plans offering rates.

    " + }, + "DescribeSavingsPlansOfferings":{ + "name":"DescribeSavingsPlansOfferings", + "http":{ + "method":"POST", + "requestUri":"/DescribeSavingsPlansOfferings" + }, + "input":{"shape":"DescribeSavingsPlansOfferingsRequest"}, + "output":{"shape":"DescribeSavingsPlansOfferingsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Describes the specified Savings Plans offerings.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/ListTagsForResource" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Lists the tags for the specified resource.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/TagResource" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Adds the specified tags to the specified resource.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/UntagResource" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Removes the specified tags from the specified resource.

    " + } + }, + "shapes":{ + "Amount":{"type":"string"}, + "ClientToken":{"type":"string"}, + "CreateSavingsPlanRequest":{ + "type":"structure", + "required":[ + "savingsPlanOfferingId", + "commitment" + ], + "members":{ + "savingsPlanOfferingId":{ + "shape":"SavingsPlanOfferingId", + "documentation":"

    The ID of the offering.

    " + }, + "commitment":{ + "shape":"Amount", + "documentation":"

    The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more than three digits after the decimal point.

    " + }, + "upfrontPaymentAmount":{ + "shape":"Amount", + "documentation":"

    The up-front payment amount. This is a whole number between 50 and 99 percent of the total value of the Savings Plan. This parameter is supported only if the payment option is Partial Upfront.

    " + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    ", + "idempotencyToken":true + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    One or more tags.

    " + } + } + }, + "CreateSavingsPlanResponse":{ + "type":"structure", + "members":{ + "savingsPlanId":{ + "shape":"SavingsPlanId", + "documentation":"

    The ID of the Savings Plan.

    " + } + } + }, + "CurrencyCode":{ + "type":"string", + "enum":[ + "CNY", + "USD" + ] + }, + "CurrencyList":{ + "type":"list", + "member":{"shape":"CurrencyCode"} + }, + "DescribeSavingsPlanRatesRequest":{ + "type":"structure", + "required":["savingsPlanId"], + "members":{ + "savingsPlanId":{ + "shape":"SavingsPlanId", + "documentation":"

    The ID of the Savings Plan.

    " + }, + "filters":{ + "shape":"SavingsPlanRateFilterList", + "documentation":"

    The filters.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

    " + } + } + }, + "DescribeSavingsPlanRatesResponse":{ + "type":"structure", + "members":{ + "savingsPlanId":{ + "shape":"SavingsPlanId", + "documentation":"

    The ID of the Savings Plan.

    " + }, + "searchResults":{ + "shape":"SavingsPlanRateList", + "documentation":"

    Information about the Savings Plans rates.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "DescribeSavingsPlansOfferingRatesRequest":{ + "type":"structure", + "members":{ + "savingsPlanOfferingIds":{ + "shape":"UUIDs", + "documentation":"

    The IDs of the offerings.

    " + }, + "savingsPlanPaymentOptions":{ + "shape":"SavingsPlanPaymentOptionList", + "documentation":"

    The payment options.

    " + }, + "savingsPlanTypes":{ + "shape":"SavingsPlanTypeList", + "documentation":"

    The plan types.

    " + }, + "products":{ + "shape":"SavingsPlanProductTypeList", + "documentation":"

    The AWS products.

    " + }, + "serviceCodes":{ + "shape":"SavingsPlanRateServiceCodeList", + "documentation":"

    The services.

    " + }, + "usageTypes":{ + "shape":"SavingsPlanRateUsageTypeList", + "documentation":"

    The usage details of the line item in the billing report.

    " + }, + "operations":{ + "shape":"SavingsPlanRateOperationList", + "documentation":"

    The specific AWS operation for the line item in the billing report.

    " + }, + "filters":{ + "shape":"SavingsPlanOfferingRateFiltersList", + "documentation":"

    The filters.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

    " + } + } + }, + "DescribeSavingsPlansOfferingRatesResponse":{ + "type":"structure", + "members":{ + "searchResults":{ + "shape":"SavingsPlanOfferingRatesList", + "documentation":"

    Information about the Savings Plans offering rates.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "DescribeSavingsPlansOfferingsRequest":{ + "type":"structure", + "members":{ + "offeringIds":{ + "shape":"UUIDs", + "documentation":"

    The IDs of the offerings.

    " + }, + "paymentOptions":{ + "shape":"SavingsPlanPaymentOptionList", + "documentation":"

    The payment options.

    " + }, + "productType":{ + "shape":"SavingsPlanProductType", + "documentation":"

    The product type.

    " + }, + "planTypes":{ + "shape":"SavingsPlanTypeList", + "documentation":"

    The plan type.

    " + }, + "durations":{ + "shape":"DurationsList", + "documentation":"

    The durations, in seconds.

    " + }, + "currencies":{ + "shape":"CurrencyList", + "documentation":"

    The currencies.

    " + }, + "descriptions":{ + "shape":"SavingsPlanDescriptionsList", + "documentation":"

    The descriptions.

    " + }, + "serviceCodes":{ + "shape":"SavingsPlanServiceCodeList", + "documentation":"

    The services.

    " + }, + "usageTypes":{ + "shape":"SavingsPlanUsageTypeList", + "documentation":"

    The usage details of the line item in the billing report.

    " + }, + "operations":{ + "shape":"SavingsPlanOperationList", + "documentation":"

    The specific AWS operation for the line item in the billing report.

    " + }, + "filters":{ + "shape":"SavingsPlanOfferingFiltersList", + "documentation":"

    The filters.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

    " + } + } + }, + "DescribeSavingsPlansOfferingsResponse":{ + "type":"structure", + "members":{ + "searchResults":{ + "shape":"SavingsPlanOfferingsList", + "documentation":"

    Information about the Savings Plans offerings.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "DescribeSavingsPlansRequest":{ + "type":"structure", + "members":{ + "savingsPlanArns":{ + "shape":"SavingsPlanArnList", + "documentation":"

    The Amazon Resource Names (ARN) of the Savings Plans.

    " + }, + "savingsPlanIds":{ + "shape":"SavingsPlanIdList", + "documentation":"

    The IDs of the Savings Plans.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token for the next page of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

    " + }, + "states":{ + "shape":"SavingsPlanStateList", + "documentation":"

    The states.

    " + }, + "filters":{ + "shape":"SavingsPlanFilterList", + "documentation":"

    The filters.

    " + } + } + }, + "DescribeSavingsPlansResponse":{ + "type":"structure", + "members":{ + "savingsPlans":{ + "shape":"SavingsPlanList", + "documentation":"

    Information about the Savings Plans.

    " + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

    " + } + } + }, + "DurationsList":{ + "type":"list", + "member":{"shape":"SavingsPlansDuration"} + }, + "EC2InstanceFamily":{"type":"string"}, + "FilterValuesList":{ + "type":"list", + "member":{"shape":"JsonSafeFilterValueString"} + }, + "InternalServerException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    An unexpected error occurred.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "JsonSafeFilterValueString":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_ \\/.\\:\\-\\(\\)]+$" + }, + "ListOfStrings":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"SavingsPlanArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource.

    " + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

    Information about the tags.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "PageSize":{ + "type":"integer", + "max":1000, + "min":0 + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "pattern":"^[A-Za-z0-9/=\\+]+$" + }, + "ParentSavingsPlanOffering":{ + "type":"structure", + "members":{ + "offeringId":{ + "shape":"UUID", + "documentation":"

    The ID of the offering.

    " + }, + "paymentOption":{ + "shape":"SavingsPlanPaymentOption", + "documentation":"

    The payment option.

    " + }, + "planType":{ + "shape":"SavingsPlanType", + "documentation":"

    The plan type.

    " + }, + "durationSeconds":{ + "shape":"SavingsPlansDuration", + "documentation":"

    The duration, in seconds.

    " + }, + "currency":{ + "shape":"CurrencyCode", + "documentation":"

    The currency.

    " + }, + "planDescription":{ + "shape":"SavingsPlanDescription", + "documentation":"

    The description.

    " + } + }, + "documentation":"

    Information about a Savings Plan offering.

    " + }, + "Region":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified resource was not found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "SavingsPlan":{ + "type":"structure", + "members":{ + "offeringId":{ + "shape":"SavingsPlanOfferingId", + "documentation":"

    The ID of the offering.

    " + }, + "savingsPlanId":{ + "shape":"SavingsPlanId", + "documentation":"

    The ID of the Savings Plan.

    " + }, + "savingsPlanArn":{ + "shape":"SavingsPlanArn", + "documentation":"

    The Amazon Resource Name (ARN) of the Savings Plan.

    " + }, + "description":{ + "shape":"String", + "documentation":"

    The description.

    " + }, + "start":{ + "shape":"String", + "documentation":"

    The start time.

    " + }, + "end":{ + "shape":"String", + "documentation":"

    The end time.

    " + }, + "state":{ + "shape":"SavingsPlanState", + "documentation":"

    The state.

    " + }, + "region":{ + "shape":"Region", + "documentation":"

    The AWS Region.

    " + }, + "ec2InstanceFamily":{ + "shape":"EC2InstanceFamily", + "documentation":"

    The EC2 instance family.

    " + }, + "savingsPlanType":{ + "shape":"SavingsPlanType", + "documentation":"

    The plan type.

    " + }, + "paymentOption":{ + "shape":"SavingsPlanPaymentOption", + "documentation":"

    The payment option.

    " + }, + "productTypes":{ + "shape":"SavingsPlanProductTypeList", + "documentation":"

    The product types.

    " + }, + "currency":{ + "shape":"CurrencyCode", + "documentation":"

    The currency.

    " + }, + "commitment":{ + "shape":"Amount", + "documentation":"

    The hourly commitment, in USD.

    " + }, + "upfrontPaymentAmount":{ + "shape":"Amount", + "documentation":"

    The up-front payment amount.

    " + }, + "recurringPaymentAmount":{ + "shape":"Amount", + "documentation":"

    The recurring payment amount.

    " + }, + "termDurationInSeconds":{ + "shape":"TermDurationInSeconds", + "documentation":"

    The duration of the term, in seconds.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    One or more tags.

    " + } + }, + "documentation":"

    Information about a Savings Plan.

    " + }, + "SavingsPlanArn":{ + "type":"string", + "pattern":"arn:aws:[a-z]+:([a-z]{2}-[a-z]+-\\d{1}|):(\\d{12}):savingsplan\\/([0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12})$" + }, + "SavingsPlanArnList":{ + "type":"list", + "member":{"shape":"SavingsPlanArn"}, + "max":100 + }, + "SavingsPlanDescription":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\- ]+$" + }, + "SavingsPlanDescriptionsList":{ + "type":"list", + "member":{"shape":"SavingsPlanDescription"} + }, + "SavingsPlanFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlansFilterName", + "documentation":"

    The filter name.

    " + }, + "values":{ + "shape":"ListOfStrings", + "documentation":"

    The filter value.

    " + } + }, + "documentation":"

    Information about a filter.

    " + }, + "SavingsPlanFilterList":{ + "type":"list", + "member":{"shape":"SavingsPlanFilter"} + }, + "SavingsPlanId":{"type":"string"}, + "SavingsPlanIdList":{ + "type":"list", + "member":{"shape":"SavingsPlanId"} + }, + "SavingsPlanList":{ + "type":"list", + "member":{"shape":"SavingsPlan"} + }, + "SavingsPlanOffering":{ + "type":"structure", + "members":{ + "offeringId":{ + "shape":"UUID", + "documentation":"

    The ID of the offering.

    " + }, + "productTypes":{ + "shape":"SavingsPlanProductTypeList", + "documentation":"

    The product type.

    " + }, + "planType":{ + "shape":"SavingsPlanType", + "documentation":"

    The plan type.

    " + }, + "description":{ + "shape":"SavingsPlanDescription", + "documentation":"

    The description.

    " + }, + "paymentOption":{ + "shape":"SavingsPlanPaymentOption", + "documentation":"

    The payment option.

    " + }, + "durationSeconds":{ + "shape":"SavingsPlansDuration", + "documentation":"

    The duration, in seconds.

    " + }, + "currency":{ + "shape":"CurrencyCode", + "documentation":"

    The currency.

    " + }, + "serviceCode":{ + "shape":"SavingsPlanServiceCode", + "documentation":"

    The service.

    " + }, + "usageType":{ + "shape":"SavingsPlanUsageType", + "documentation":"

    The usage details of the line item in the billing report.

    " + }, + "operation":{ + "shape":"SavingsPlanOperation", + "documentation":"

    The specific AWS operation for the line item in the billing report.

    " + }, + "properties":{ + "shape":"SavingsPlanOfferingPropertyList", + "documentation":"

    The properties.

    " + } + }, + "documentation":"

    Information about a Savings Plan offering.

    " + }, + "SavingsPlanOfferingFilterAttribute":{ + "type":"string", + "enum":[ + "region", + "instanceFamily" + ] + }, + "SavingsPlanOfferingFilterElement":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlanOfferingFilterAttribute", + "documentation":"

    The filter name.

    " + }, + "values":{ + "shape":"FilterValuesList", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Information about a filter.

    " + }, + "SavingsPlanOfferingFiltersList":{ + "type":"list", + "member":{"shape":"SavingsPlanOfferingFilterElement"} + }, + "SavingsPlanOfferingId":{"type":"string"}, + "SavingsPlanOfferingProperty":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlanOfferingPropertyKey", + "documentation":"

    The property name.

    " + }, + "value":{ + "shape":"JsonSafeFilterValueString", + "documentation":"

    The property value.

    " + } + }, + "documentation":"

    Information about a property.

    " + }, + "SavingsPlanOfferingPropertyKey":{ + "type":"string", + "enum":[ + "region", + "instanceFamily" + ] + }, + "SavingsPlanOfferingPropertyList":{ + "type":"list", + "member":{"shape":"SavingsPlanOfferingProperty"} + }, + "SavingsPlanOfferingRate":{ + "type":"structure", + "members":{ + "savingsPlanOffering":{ + "shape":"ParentSavingsPlanOffering", + "documentation":"

    The Savings Plan offering.

    " + }, + "rate":{ + "shape":"SavingsPlanRatePricePerUnit", + "documentation":"

    The Savings Plan rate.

    " + }, + "unit":{ + "shape":"SavingsPlanRateUnit", + "documentation":"

    The unit.

    " + }, + "productType":{ + "shape":"SavingsPlanProductType", + "documentation":"

    The product type.

    " + }, + "serviceCode":{ + "shape":"SavingsPlanRateServiceCode", + "documentation":"

    The service.

    " + }, + "usageType":{ + "shape":"SavingsPlanRateUsageType", + "documentation":"

    The usage details of the line item in the billing report.

    " + }, + "operation":{ + "shape":"SavingsPlanRateOperation", + "documentation":"

    The specific AWS operation for the line item in the billing report.

    " + }, + "properties":{ + "shape":"SavingsPlanOfferingRatePropertyList", + "documentation":"

    The properties.

    " + } + }, + "documentation":"

    Information about a Savings Plan offering rate.

    " + }, + "SavingsPlanOfferingRateFilterElement":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlanRateFilterAttribute", + "documentation":"

    The filter name.

    " + }, + "values":{ + "shape":"FilterValuesList", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Information about a filter.

    " + }, + "SavingsPlanOfferingRateFiltersList":{ + "type":"list", + "member":{"shape":"SavingsPlanOfferingRateFilterElement"} + }, + "SavingsPlanOfferingRateProperty":{ + "type":"structure", + "members":{ + "name":{ + "shape":"JsonSafeFilterValueString", + "documentation":"

    The property name.

    " + }, + "value":{ + "shape":"JsonSafeFilterValueString", + "documentation":"

    The property value.

    " + } + }, + "documentation":"

    Information about a property.

    " + }, + "SavingsPlanOfferingRatePropertyList":{ + "type":"list", + "member":{"shape":"SavingsPlanOfferingRateProperty"} + }, + "SavingsPlanOfferingRatesList":{ + "type":"list", + "member":{"shape":"SavingsPlanOfferingRate"} + }, + "SavingsPlanOfferingsList":{ + "type":"list", + "member":{"shape":"SavingsPlanOffering"} + }, + "SavingsPlanOperation":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z0-9_ \\/.:-]*$" + }, + "SavingsPlanOperationList":{ + "type":"list", + "member":{"shape":"SavingsPlanOperation"} + }, + "SavingsPlanPaymentOption":{ + "type":"string", + "enum":[ + "All Upfront", + "Partial Upfront", + "No Upfront" + ] + }, + "SavingsPlanPaymentOptionList":{ + "type":"list", + "member":{"shape":"SavingsPlanPaymentOption"} + }, + "SavingsPlanProductType":{ + "type":"string", + "enum":[ + "EC2", + "Fargate" + ] + }, + "SavingsPlanProductTypeList":{ + "type":"list", + "member":{"shape":"SavingsPlanProductType"} + }, + "SavingsPlanRate":{ + "type":"structure", + "members":{ + "rate":{ + "shape":"Amount", + "documentation":"

    The rate.

    " + }, + "currency":{ + "shape":"CurrencyCode", + "documentation":"

    The currency.

    " + }, + "unit":{ + "shape":"SavingsPlanRateUnit", + "documentation":"

    The unit.

    " + }, + "productType":{ + "shape":"SavingsPlanProductType", + "documentation":"

    The product type.

    " + }, + "serviceCode":{ + "shape":"SavingsPlanRateServiceCode", + "documentation":"

    The service.

    " + }, + "usageType":{ + "shape":"SavingsPlanRateUsageType", + "documentation":"

    The usage details of the line item in the billing report.

    " + }, + "operation":{ + "shape":"SavingsPlanRateOperation", + "documentation":"

    The specific AWS operation for the line item in the billing report.

    " + }, + "properties":{ + "shape":"SavingsPlanRatePropertyList", + "documentation":"

    The properties.

    " + } + }, + "documentation":"

    Information about a Savings Plan rate.

    " + }, + "SavingsPlanRateFilter":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlanRateFilterName", + "documentation":"

    The filter name.

    " + }, + "values":{ + "shape":"ListOfStrings", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Information about a filter.

    " + }, + "SavingsPlanRateFilterAttribute":{ + "type":"string", + "enum":[ + "region", + "instanceFamily", + "instanceType", + "productDescription", + "tenancy", + "productId" + ] + }, + "SavingsPlanRateFilterList":{ + "type":"list", + "member":{"shape":"SavingsPlanRateFilter"} + }, + "SavingsPlanRateFilterName":{ + "type":"string", + "enum":[ + "region", + "instanceType", + "productDescription", + "tenancy", + "productType", + "serviceCode", + "usageType", + "operation" + ] + }, + "SavingsPlanRateList":{ + "type":"list", + "member":{"shape":"SavingsPlanRate"} + }, + "SavingsPlanRateOperation":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z0-9_ \\/.:-]*$" + }, + "SavingsPlanRateOperationList":{ + "type":"list", + "member":{"shape":"SavingsPlanRateOperation"} + }, + "SavingsPlanRatePricePerUnit":{"type":"string"}, + "SavingsPlanRateProperty":{ + "type":"structure", + "members":{ + "name":{ + "shape":"SavingsPlanRatePropertyKey", + "documentation":"

    The property name.

    " + }, + "value":{ + "shape":"JsonSafeFilterValueString", + "documentation":"

    The property value.

    " + } + }, + "documentation":"

    Information about a property.

    " + }, + "SavingsPlanRatePropertyKey":{ + "type":"string", + "enum":[ + "region", + "instanceType", + "instanceFamily", + "productDescription", + "tenancy" + ] + }, + "SavingsPlanRatePropertyList":{ + "type":"list", + "member":{"shape":"SavingsPlanRateProperty"} + }, + "SavingsPlanRateServiceCode":{ + "type":"string", + "enum":[ + "AmazonEC2", + "AmazonECS" + ] + }, + "SavingsPlanRateServiceCodeList":{ + "type":"list", + "member":{"shape":"SavingsPlanRateServiceCode"} + }, + "SavingsPlanRateUnit":{ + "type":"string", + "enum":["Hrs"] + }, + "SavingsPlanRateUsageType":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z0-9_ \\/.:-]+$" + }, + "SavingsPlanRateUsageTypeList":{ + "type":"list", + "member":{"shape":"SavingsPlanRateUsageType"} + }, + "SavingsPlanServiceCode":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z]+$" + }, + "SavingsPlanServiceCodeList":{ + "type":"list", + "member":{"shape":"SavingsPlanServiceCode"} + }, + "SavingsPlanState":{ + "type":"string", + "enum":[ + "payment-pending", + "payment-failed", + "active", + "retired" + ] + }, + "SavingsPlanStateList":{ + "type":"list", + "member":{"shape":"SavingsPlanState"} + }, + "SavingsPlanType":{ + "type":"string", + "enum":[ + "Compute", + "EC2Instance" + ] + }, + "SavingsPlanTypeList":{ + "type":"list", + "member":{"shape":"SavingsPlanType"} + }, + "SavingsPlanUsageType":{ + "type":"string", + "max":255, + "pattern":"^[a-zA-Z0-9_ \\/.:-]+$" + }, + "SavingsPlanUsageTypeList":{ + "type":"list", + "member":{"shape":"SavingsPlanUsageType"} + }, + "SavingsPlansDuration":{ + "type":"long", + "min":0 + }, + "SavingsPlansFilterName":{ + "type":"string", + "enum":[ + "region", + "ec2-instance-family", + "commitment", + "upfront", + "term", + "savings-plan-type", + "payment-option", + "start", + "end" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A service quota has been exceeded.

    ", + "error":{"httpStatusCode":402}, + "exception":true + }, + "String":{"type":"string"}, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"SavingsPlanArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    One or more tags. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{"type":"string"}, + "TermDurationInSeconds":{"type":"long"}, + "UUID":{ + "type":"string", + "pattern":"^(([0-9a-f]+)(-?))+$" + }, + "UUIDs":{ + "type":"list", + "member":{"shape":"UUID"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"SavingsPlanArn", + "documentation":"

    The Amazon Resource Name (ARN) of the resource.

    " + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tag keys.

    " + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    One of the input parameters is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + } + }, + "documentation":"

    Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For more information, see the AWS Savings Plans User Guide.

    " +} diff --git a/aws/dist/botocore/data/sdb/2009-04-15/paginators-1.json b/aws/dist/botocore/data/sdb/2009-04-15/paginators-1.json new file mode 100644 index 00000000..23620988 --- /dev/null +++ b/aws/dist/botocore/data/sdb/2009-04-15/paginators-1.json @@ -0,0 +1,15 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxNumberOfDomains", + "result_key": "DomainNames" + }, + "Select": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Items" + } + } +} diff --git a/aws/dist/botocore/data/sdb/2009-04-15/service-2.json b/aws/dist/botocore/data/sdb/2009-04-15/service-2.json new file mode 100644 index 00000000..1f243edc --- /dev/null +++ b/aws/dist/botocore/data/sdb/2009-04-15/service-2.json @@ -0,0 +1,1180 @@ +{ + "metadata":{ + "uid":"sdb-2009-04-15", + "apiVersion":"2009-04-15", + "endpointPrefix":"sdb", + "serviceFullName":"Amazon SimpleDB", + "serviceId":"SimpleDB", + "signatureVersion":"v2", + "xmlNamespace":"http://sdb.amazonaws.com/doc/2009-04-15/", + "protocol":"query" + }, + "documentation":"Amazon SimpleDB is a web service providing the core database functions of data indexing and querying in the cloud. By offloading the time and effort associated with building and operating a web-scale database, SimpleDB provides developers the freedom to focus on application development.

    A traditional, clustered relational database requires a sizable upfront capital outlay, is complex to design, and often requires extensive and repetitive database administration. Amazon SimpleDB is dramatically simpler, requiring no schema, automatically indexing your data and providing a simple API for storage and access. This approach eliminates the administrative burden of data modeling, index maintenance, and performance tuning. Developers gain access to this functionality within Amazon's proven computing environment, are able to scale instantly, and pay only for what they use.

    Visit http://aws.amazon.com/simpledb/ for more information.

    ", + "operations":{ + "BatchDeleteAttributes":{ + "name":"BatchDeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDeleteAttributesRequest"}, + "documentation":"

    Performs multiple DeleteAttributes operations in a single call, which reduces round trips and latencies. This enables Amazon SimpleDB to optimize requests, which generally yields better throughput.

    The following limitations are enforced for this operation:

    • 1 MB request size
    • 25 item limit per BatchDeleteAttributes operation

    " + }, + "BatchPutAttributes":{ + "name":"BatchPutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchPutAttributesRequest"}, + "errors":[ + { + "shape":"DuplicateItemName", + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The item name was specified more than once.

    " + }, + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this item.

    " + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this domain.

    " + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many bytes in this domain.

    " + }, + { + "shape":"NumberSubmittedItemsExceeded", + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many items exist in a single call.

    " + }, + { + "shape":"NumberSubmittedAttributesExceeded", + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes exist in a single call.

    " + } + ], + "documentation":"

    The BatchPutAttributes operation creates or replaces attributes within one or more items. By using this operation, the client can perform multiple PutAttribute operation with a single call. This helps yield savings in round trips and latencies, enabling Amazon SimpleDB to optimize requests and generally produce better throughput.

    The client may specify the item name with the Item.X.ItemName parameter. The client may specify new attributes using a combination of the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value parameters. The client may specify the first attribute for the first item using the parameters Item.0.Attribute.0.Name and Item.0.Attribute.0.Value, and for the second attribute for the first item by the parameters Item.0.Attribute.1.Name and Item.0.Attribute.1.Value, and so on.

    Attributes are uniquely identified within an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", \"second_value\" }. However, it cannot have two attribute instances where both the Item.X.Attribute.Y.Name and Item.X.Attribute.Y.Value are the same.

    Optionally, the requester can supply the Replace parameter for each individual value. Setting this value to true will cause the new attribute values to replace the existing attribute values. For example, if an item I has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requester does a BatchPutAttributes of {'I', 'b', '4' } with the Replace parameter set to true, the final attributes of the item will be { 'a', '1' } and { 'b', '4' }, replacing the previous values of the 'b' attribute with the new value.

    This operation is vulnerable to exceeding the maximum URL size when making a REST request using the HTTP GET method. This operation does not support conditions using Expected.X.Name, Expected.X.Value, or Expected.X.Exists.

    You can execute multiple BatchPutAttributes operations and other operations in parallel. However, large numbers of concurrent BatchPutAttributes calls can result in Service Unavailable (503) responses.

    The following limitations are enforced for this operation:

    • 256 attribute name-value pairs per item
    • 1 MB request size
    • 1 billion attributes per domain
    • 10 GB of total user data storage per domain
    • 25 item limit per BatchPutAttributes operation

    " + }, + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NumberDomainsExceeded", + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many domains exist per this account.

    " + } + ], + "documentation":"

    The CreateDomain operation creates a new domain. The domain name should be unique among the domains associated with the Access Key ID provided in the request. The CreateDomain operation may take 10 or more seconds to complete.

    The client can create up to 100 domains per account.

    If the client requires additional domains, go to http://aws.amazon.com/contact-us/simpledb-limit-request/.

    " + }, + "DeleteAttributes":{ + "name":"DeleteAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified attribute does not exist.

    " + } + ], + "documentation":"

    Deletes one or more attributes associated with an item. If all attributes of the item are deleted, the item is deleted.

    DeleteAttributes is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

    Because Amazon SimpleDB makes multiple copies of item data and uses an eventual consistency update model, performing a GetAttributes or Select operation (read) immediately after a DeleteAttributes or PutAttributes operation (write) might not return updated item data.

    " + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + } + ], + "documentation":"

    The DeleteDomain operation deletes a domain. Any items (and their attributes) in the domain are deleted as well. The DeleteDomain operation might take 10 or more seconds to complete.

    " + }, + "DomainMetadata":{ + "name":"DomainMetadata", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DomainMetadataRequest"}, + "output":{ + "shape":"DomainMetadataResult", + "resultWrapper":"DomainMetadataResult" + }, + "errors":[ + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + } + ], + "documentation":"

    Returns information about the domain, including when the domain was created, the number of items and attributes in the domain, and the size of the attribute names and values.

    " + }, + "GetAttributes":{ + "name":"GetAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAttributesRequest"}, + "output":{ + "shape":"GetAttributesResult", + "resultWrapper":"GetAttributesResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + } + ], + "documentation":"

    Returns all of the attributes associated with the specified item. Optionally, the attributes returned can be limited to one or more attributes by specifying an attribute name parameter.

    If the item does not exist on the replica that was accessed for this operation, an empty set is returned. The system does not return an error as it cannot guarantee the item does not exist on other replicas.

    " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{ + "shape":"ListDomainsResult", + "resultWrapper":"ListDomainsResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified NextToken is not valid.

    " + } + ], + "documentation":"

    The ListDomains operation lists all domains associated with the Access Key ID. It returns domain names up to the limit set by MaxNumberOfDomains. A NextToken is returned if there are more than MaxNumberOfDomains domains. Calling ListDomains successive times with the NextToken provided by the operation returns up to MaxNumberOfDomains more domain names with each successive operation call.

    " + }, + "PutAttributes":{ + "name":"PutAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAttributesRequest"}, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + }, + { + "shape":"NumberDomainAttributesExceeded", + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this domain.

    " + }, + { + "shape":"NumberDomainBytesExceeded", + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many bytes in this domain.

    " + }, + { + "shape":"NumberItemAttributesExceeded", + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this item.

    " + }, + { + "shape":"AttributeDoesNotExist", + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified attribute does not exist.

    " + } + ], + "documentation":"

    The PutAttributes operation creates or replaces attributes in an item. The client may specify new attributes using a combination of the Attribute.X.Name and Attribute.X.Value parameters. The client specifies the first attribute by the parameters Attribute.0.Name and Attribute.0.Value, the second attribute by the parameters Attribute.1.Name and Attribute.1.Value, and so on.

    Attributes are uniquely identified in an item by their name/value combination. For example, a single item can have the attributes { \"first_name\", \"first_value\" } and { \"first_name\", second_value\" }. However, it cannot have two attribute instances where both the Attribute.X.Name and Attribute.X.Value are the same.

    Optionally, the requestor can supply the Replace parameter for each individual attribute. Setting this value to true causes the new attribute value to replace the existing attribute value(s). For example, if an item has the attributes { 'a', '1' }, { 'b', '2'} and { 'b', '3' } and the requestor calls PutAttributes using the attributes { 'b', '4' } with the Replace parameter set to true, the final attributes of the item are changed to { 'a', '1' } and { 'b', '4' }, which replaces the previous values of the 'b' attribute with the new value.

    You cannot specify an empty string as an attribute name.

    Because Amazon SimpleDB makes multiple copies of client data and uses an eventual consistency update model, an immediate GetAttributes or Select operation (read) immediately after a PutAttributes or DeleteAttributes operation (write) might not return the updated data.

    The following limitations are enforced for this operation:

    • 256 total attribute name-value pairs per item
    • One billion attributes per domain
    • 10 GB of total user data storage per domain

    " + }, + "Select":{ + "name":"Select", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SelectRequest"}, + "output":{ + "shape":"SelectResult", + "resultWrapper":"SelectResult" + }, + "errors":[ + { + "shape":"InvalidParameterValue", + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + { + "shape":"InvalidNextToken", + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified NextToken is not valid.

    " + }, + { + "shape":"InvalidNumberPredicates", + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many predicates exist in the query expression.

    " + }, + { + "shape":"InvalidNumberValueTests", + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many predicates exist in the query expression.

    " + }, + { + "shape":"InvalidQueryExpression", + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified query expression syntax is not valid.

    " + }, + { + "shape":"MissingParameter", + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + { + "shape":"NoSuchDomain", + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + }, + { + "shape":"RequestTimeout", + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "documentation":"

    A timeout occurred when attempting to query the specified domain with specified query expression.

    " + }, + { + "shape":"TooManyRequestedAttributes", + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes requested.

    " + } + ], + "documentation":"

    The Select operation returns a set of attributes for ItemNames that match the select expression. Select is similar to the standard SQL SELECT statement.

    The total size of the response cannot exceed 1 MB in total size. Amazon SimpleDB automatically adjusts the number of items returned per page to enforce this limit. For example, if the client asks to retrieve 2500 items, but each individual item is 10 kB in size, the system returns 100 items and an appropriate NextToken so the client can access the next page of results.

    For information on how to construct select expressions, see Using Select to Create Amazon SimpleDB Queries in the Developer Guide.

    " + } + }, + "shapes":{ + "Attribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the attribute." + }, + "AlternateNameEncoding":{ + "shape":"String", + "documentation":"

    " + }, + "Value":{ + "shape":"String", + "documentation":"The value of the attribute." + }, + "AlternateValueEncoding":{ + "shape":"String", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "AttributeDoesNotExist":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"AttributeDoesNotExist", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified attribute does not exist.

    " + }, + "AttributeList":{ + "type":"list", + "member":{ + "shape":"Attribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchDeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which the attributes are being deleted." + }, + "Items":{ + "shape":"DeletableItemList", + "documentation":"A list of items on which to perform the operation." + } + } + }, + "BatchPutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "Items" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which the attributes are being stored." + }, + "Items":{ + "shape":"ReplaceableItemList", + "documentation":"A list of items on which to perform the operation." + } + } + }, + "Boolean":{"type":"boolean"}, + "CreateDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain to create. The name can range between 3 and 255 characters and can contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'." + } + } + }, + "DeletableItem":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"String", + "locationName":"ItemName" + }, + "Attributes":{"shape":"AttributeList"} + } + }, + "DeletableItemList":{ + "type":"list", + "member":{ + "shape":"DeletableItem", + "locationName":"Item" + }, + "flattened":true + }, + "DeleteAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item. Similar to rows on a spreadsheet, items represent individual objects that contain one or more value-attribute pairs." + }, + "Attributes":{ + "shape":"AttributeList", + "documentation":"A list of Attributes. Similar to columns on a spreadsheet, attributes represent categories of data that can be assigned to items." + }, + "Expected":{ + "shape":"UpdateCondition", + "documentation":"The update condition which, if specified, determines whether the specified attributes will be deleted or not. The update condition must be satisfied in order for this request to be processed and the attributes to be deleted." + } + } + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain to delete." + } + } + }, + "DomainMetadataRequest":{ + "type":"structure", + "required":["DomainName"], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain for which to display the metadata of." + } + } + }, + "DomainMetadataResult":{ + "type":"structure", + "members":{ + "ItemCount":{ + "shape":"Integer", + "documentation":"The number of all items in the domain." + }, + "ItemNamesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all item names in the domain, in bytes." + }, + "AttributeNameCount":{ + "shape":"Integer", + "documentation":"The number of unique attribute names in the domain." + }, + "AttributeNamesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all unique attribute names in the domain, in bytes." + }, + "AttributeValueCount":{ + "shape":"Integer", + "documentation":"The number of all attribute name/value pairs in the domain." + }, + "AttributeValuesSizeBytes":{ + "shape":"Long", + "documentation":"The total size of all attribute values in the domain, in bytes." + }, + "Timestamp":{ + "shape":"Integer", + "documentation":"The data and time when metadata was calculated, in Epoch (UNIX) seconds." + } + } + }, + "DomainNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"DomainName" + }, + "flattened":true + }, + "DuplicateItemName":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"DuplicateItemName", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The item name was specified more than once.

    " + }, + "Float":{"type":"float"}, + "GetAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item." + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"The names of the attributes." + }, + "ConsistentRead":{ + "shape":"Boolean", + "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read." + } + } + }, + "GetAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"AttributeList", + "documentation":"The list of attributes returned by the operation." + } + } + }, + "Integer":{"type":"integer"}, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNextToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified NextToken is not valid.

    " + }, + "InvalidNumberPredicates":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberPredicates", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many predicates exist in the query expression.

    " + }, + "InvalidNumberValueTests":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidNumberValueTests", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many predicates exist in the query expression.

    " + }, + "InvalidParameterValue":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidParameterValue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The value for a parameter is invalid.

    " + }, + "InvalidQueryExpression":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"InvalidQueryExpression", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified query expression syntax is not valid.

    " + }, + "Item":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the item." + }, + "AlternateNameEncoding":{ + "shape":"String", + "documentation":"

    " + }, + "Attributes":{ + "shape":"AttributeList", + "documentation":"A list of attributes." + } + }, + "documentation":"

    " + }, + "ItemList":{ + "type":"list", + "member":{ + "shape":"Item", + "locationName":"Item" + }, + "flattened":true + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "MaxNumberOfDomains":{ + "shape":"Integer", + "documentation":"The maximum number of domain names you want returned. The range is 1 to 100. The default setting is 100." + }, + "NextToken":{ + "shape":"String", + "documentation":"A string informing Amazon SimpleDB where to start the next list of domain names." + } + } + }, + "ListDomainsResult":{ + "type":"structure", + "members":{ + "DomainNames":{ + "shape":"DomainNameList", + "documentation":"A list of domain names that match the expression." + }, + "NextToken":{ + "shape":"String", + "documentation":"An opaque token indicating that there are more domains than the specified MaxNumberOfDomains still available." + } + } + }, + "Long":{"type":"long"}, + "MissingParameter":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"MissingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The request must contain the specified missing parameter.

    " + }, + "NoSuchDomain":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NoSuchDomain", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    The specified domain does not exist.

    " + }, + "NumberDomainAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this domain.

    " + }, + "NumberDomainBytesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainBytesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many bytes in this domain.

    " + }, + "NumberDomainsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberDomainsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many domains exist per this account.

    " + }, + "NumberItemAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberItemAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes in this item.

    " + }, + "NumberSubmittedAttributesExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedAttributesExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes exist in a single call.

    " + }, + "NumberSubmittedItemsExceeded":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"NumberSubmittedItemsExceeded", + "httpStatusCode":409, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many items exist in a single call.

    " + }, + "PutAttributesRequest":{ + "type":"structure", + "required":[ + "DomainName", + "ItemName", + "Attributes" + ], + "members":{ + "DomainName":{ + "shape":"String", + "documentation":"The name of the domain in which to perform the operation." + }, + "ItemName":{ + "shape":"String", + "documentation":"The name of the item." + }, + "Attributes":{ + "shape":"ReplaceableAttributeList", + "documentation":"The list of attributes." + }, + "Expected":{ + "shape":"UpdateCondition", + "documentation":"The update condition which, if specified, determines whether the specified attributes will be updated or not. The update condition must be satisfied in order for this request to be processed and the attributes to be updated." + } + } + }, + "ReplaceableAttribute":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the replaceable attribute." + }, + "Value":{ + "shape":"String", + "documentation":"The value of the replaceable attribute." + }, + "Replace":{ + "shape":"Boolean", + "documentation":"A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is false." + } + }, + "documentation":"

    " + }, + "ReplaceableAttributeList":{ + "type":"list", + "member":{ + "shape":"ReplaceableAttribute", + "locationName":"Attribute" + }, + "flattened":true + }, + "ReplaceableItem":{ + "type":"structure", + "required":[ + "Name", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"The name of the replaceable item.", + "locationName":"ItemName" + }, + "Attributes":{ + "shape":"ReplaceableAttributeList", + "documentation":"The list of attributes for a replaceable item." + } + }, + "documentation":"

    " + }, + "ReplaceableItemList":{ + "type":"list", + "member":{ + "shape":"ReplaceableItem", + "locationName":"Item" + }, + "flattened":true + }, + "RequestTimeout":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"RequestTimeout", + "httpStatusCode":408, + "senderFault":true + }, + "exception":true, + "documentation":"

    A timeout occurred when attempting to query the specified domain with specified query expression.

    " + }, + "SelectRequest":{ + "type":"structure", + "required":["SelectExpression"], + "members":{ + "SelectExpression":{ + "shape":"String", + "documentation":"The expression used to query the domain." + }, + "NextToken":{ + "shape":"String", + "documentation":"A string informing Amazon SimpleDB where to start the next list of ItemNames." + }, + "ConsistentRead":{ + "shape":"Boolean", + "documentation":"Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If true, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read." + } + } + }, + "SelectResult":{ + "type":"structure", + "members":{ + "Items":{ + "shape":"ItemList", + "documentation":"A list of items that match the select expression." + }, + "NextToken":{ + "shape":"String", + "documentation":"An opaque token indicating that more items than MaxNumberOfItems were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds." + } + } + }, + "String":{"type":"string"}, + "TooManyRequestedAttributes":{ + "type":"structure", + "members":{ + "BoxUsage":{"shape":"Float"} + }, + "error":{ + "code":"TooManyRequestedAttributes", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true, + "documentation":"

    Too many attributes requested.

    " + }, + "UpdateCondition":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the attribute involved in the condition.

    " + }, + "Value":{ + "shape":"String", + "documentation":"

    The value of an attribute. This value can only be specified when the Exists parameter is equal to true.

    " + }, + "Exists":{ + "shape":"Boolean", + "documentation":"

    A value specifying whether or not the specified attribute must exist with the specified value in order for the update condition to be satisfied. Specify true if the attribute must exist for the update condition to be satisfied. Specify false if the attribute should not exist in order for the update condition to be satisfied.

    " + } + }, + "documentation":"

    Specifies the conditions under which data should be updated. If an update condition is specified for a request, the data will only be updated if the condition is satisfied. For example, if an attribute with a specific name and value exists, or if a specific attribute doesn't exist.

    " + } + } +} diff --git a/aws/dist/botocore/data/secretsmanager/2017-10-17/paginators-1.json b/aws/dist/botocore/data/secretsmanager/2017-10-17/paginators-1.json new file mode 100644 index 00000000..0f62e8e1 --- /dev/null +++ b/aws/dist/botocore/data/secretsmanager/2017-10-17/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListSecrets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "SecretList" + } + } +} diff --git a/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.json b/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.json new file mode 100644 index 00000000..ec3075e5 --- /dev/null +++ b/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.json @@ -0,0 +1,1352 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-17", + "endpointPrefix":"secretsmanager", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Secrets Manager", + "serviceId":"Secrets Manager", + "signatureVersion":"v4", + "signingName":"secretsmanager", + "targetPrefix":"secretsmanager", + "uid":"secretsmanager-2017-10-17" + }, + "operations":{ + "CancelRotateSecret":{ + "name":"CancelRotateSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelRotateSecretRequest"}, + "output":{"shape":"CancelRotateSecretResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

    To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

    If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

    To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

    • Not be attached to any version at all

    • Attached to the same version as the staging label AWSCURRENT

    If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:CancelRotateSecret

    Related operations

    • To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

    • To get the rotation configuration details for a secret, use DescribeSecret.

    • To list all of the currently available secrets, use ListSecrets.

    • To list all of the versions currently associated with a secret, use ListSecretVersionIds.

    " + }, + "CreateSecret":{ + "name":"CreateSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSecretRequest"}, + "output":{"shape":"CreateSecretResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"EncryptionFailure"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"PreconditionNotMetException"} + ], + "documentation":"

    Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

    Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

    You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

    • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

    • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:CreateSecret

    • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

    • kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

    • secretsmanager:TagResource - needed only if you include the Tags parameter.

    Related operations

    • To delete a secret, use DeleteSecret.

    • To modify an existing secret, use UpdateSecret.

    • To create a new version of a secret, use PutSecretValue.

    • To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

    • To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.

    • To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

    " + }, + "DeleteResourcePolicy":{ + "name":"DeleteResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourcePolicyRequest"}, + "output":{"shape":"DeleteResourcePolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Deletes the resource-based permission policy that's attached to the secret.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:DeleteResourcePolicy

    Related operations

    • To attach a resource policy to a secret, use PutResourcePolicy.

    • To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.

    • To list all of the currently available secrets, use ListSecrets.

    " + }, + "DeleteSecret":{ + "name":"DeleteSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSecretRequest"}, + "output":{"shape":"DeleteSecretResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.

    At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.

    You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.

    • There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the VersionStage field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in ListSecretVersionIds unless you specify IncludeDeprecated.

    • The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:DeleteSecret

    Related operations

    • To create a secret, use CreateSecret.

    • To cancel deletion of a version of a secret before the recovery window has expired, use RestoreSecret.

    " + }, + "DescribeSecret":{ + "name":"DescribeSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSecretRequest"}, + "output":{"shape":"DescribeSecretResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:DescribeSecret

    Related operations

    " + }, + "GetRandomPassword":{ + "name":"GetRandomPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRandomPasswordRequest"}, + "output":{"shape":"GetRandomPasswordResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:GetRandomPassword

    " + }, + "GetResourcePolicy":{ + "name":"GetResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePolicyRequest"}, + "output":{"shape":"GetResourcePolicyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:GetResourcePolicy

    Related operations

    " + }, + "GetSecretValue":{ + "name":"GetSecretValue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSecretValueRequest"}, + "output":{"shape":"GetSecretValueResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"DecryptionFailure"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:GetSecretValue

    • kms:Decrypt - required only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

    Related operations

    • To create a new version of the secret with different encrypted information, use PutSecretValue.

    • To retrieve the non-encrypted details for the secret, use DescribeSecret.

    " + }, + "ListSecretVersionIds":{ + "name":"ListSecretVersionIds", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSecretVersionIdsRequest"}, + "output":{"shape":"ListSecretVersionIdsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

    Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:ListSecretVersionIds

    Related operations

    " + }, + "ListSecrets":{ + "name":"ListSecrets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSecretsRequest"}, + "output":{"shape":"ListSecretsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

    Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:ListSecrets

    Related operations

    " + }, + "PutResourcePolicy":{ + "name":"PutResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutResourcePolicyRequest"}, + "output":{"shape":"PutResourcePolicyResponse"}, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:PutResourcePolicy

    Related operations

    • To retrieve the resource policy that's attached to a secret, use GetResourcePolicy.

    • To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.

    • To list all of the currently available secrets, use ListSecrets.

    " + }, + "PutSecretValue":{ + "name":"PutSecretValue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutSecretValueRequest"}, + "output":{"shape":"PutSecretValueResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"EncryptionFailure"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

    The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

    • If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

    • If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.

    • If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

    • This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.

    • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

    • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:PutSecretValue

    • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

    Related operations

    " + }, + "RestoreSecret":{ + "name":"RestoreSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreSecretRequest"}, + "output":{"shape":"RestoreSecretResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:RestoreSecret

    Related operations

    " + }, + "RotateSecret":{ + "name":"RotateSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RotateSecretRequest"}, + "output":{"shape":"RotateSecretResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

    This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.

    Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

    The rotation function must end with the versions of the secret in one of two states:

    • The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or

    • The AWSPENDING staging label is not attached to any version of the secret.

    If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:RotateSecret

    • lambda:InvokeFunction (on the function specified in the secret's metadata)

    Related operations

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

    The following basic restrictions apply to tags:

    • Maximum number of tags per secret—50

    • Maximum key length—127 Unicode characters in UTF-8

    • Maximum value length—255 Unicode characters in UTF-8

    • Tag keys and values are case sensitive.

    • Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

    • If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

    If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:TagResource

    Related operations

    • To remove one or more tags from the collection attached to a secret, use UntagResource.

    • To view the list of tags attached to a secret, use DescribeSecret.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Removes one or more tags from the specified secret.

    This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.

    If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:UntagResource

    Related operations

    • To add one or more tags to the collection attached to a secret, use TagResource.

    • To view the list of tags attached to a secret, use DescribeSecret.

    " + }, + "UpdateSecret":{ + "name":"UpdateSecret", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecretRequest"}, + "output":{"shape":"UpdateSecretResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"EncryptionFailure"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"InternalServiceError"}, + {"shape":"PreconditionNotMetException"} + ], + "documentation":"

    Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

    To modify the rotation configuration of a secret, use RotateSecret instead.

    The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

    • If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.

    • If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

    • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

    • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:UpdateSecret

    • kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

    • kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

    Related operations

    " + }, + "UpdateSecretVersionStage":{ + "name":"UpdateSecretVersionStage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSecretVersionStageRequest"}, + "output":{"shape":"UpdateSecretVersionStageResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalServiceError"} + ], + "documentation":"

    Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.

    The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

    You can move the AWSCURRENT staging label to this version by including it in this call.

    Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

    If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

    Minimum permissions

    To run this command, you must have the following permissions:

    • secretsmanager:UpdateSecretVersionStage

    Related operations

    • To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

    " + } + }, + "shapes":{ + "AutomaticallyRotateAfterDaysType":{ + "type":"long", + "max":1000, + "min":1 + }, + "BooleanType":{"type":"boolean"}, + "CancelRotateSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + } + } + }, + "CancelRotateSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret for which rotation was canceled.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret for which rotation was canceled.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.

    " + } + } + }, + "ClientRequestTokenType":{ + "type":"string", + "max":64, + "min":32 + }, + "CreateSecretRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NameType", + "documentation":"

    Specifies the friendly name of the new secret.

    The secret name must be ASCII letters, digits, or the following characters : /_+=.@-

    Don't end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenType", + "documentation":"

    (Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include that value in the request.

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

    • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

    • If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent).

    • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.

    This value becomes the VersionId of the new version.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

    (Optional) Specifies a user-provided description of the secret.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyIdType", + "documentation":"

    (Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

    You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

    If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

    You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.

    " + }, + "SecretBinary":{ + "shape":"SecretBinaryType", + "documentation":"

    (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter.

    Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.

    " + }, + "SecretString":{ + "shape":"SecretStringType", + "documentation":"

    (Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

    Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

    [{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]

    If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

    " + }, + "Tags":{ + "shape":"TagListType", + "documentation":"

    (Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

    • Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".

    • If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

    This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

    [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]

    If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

    The following basic restrictions apply to tags:

    • Maximum number of tags per secret—50

    • Maximum key length—127 Unicode characters in UTF-8

    • Maximum value length—255 Unicode characters in UTF-8

    • Tag keys and values are case sensitive.

    • Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

    • If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

    " + } + } + }, + "CreateSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The Amazon Resource Name (ARN) of the secret that you just created.

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret that you just created.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The unique identifier that's associated with the version of the secret you just created.

    " + } + } + }, + "CreatedDateType":{"type":"timestamp"}, + "DecryptionFailure":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Secrets Manager can't decrypt the protected secret text using the provided KMS key.

    ", + "exception":true + }, + "DeleteResourcePolicyRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + } + } + }, + "DeleteResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that the resource-based policy was deleted for.

    " + }, + "Name":{ + "shape":"NameType", + "documentation":"

    The friendly name of the secret that the resource-based policy was deleted for.

    " + } + } + }, + "DeleteSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "RecoveryWindowInDays":{ + "shape":"RecoveryWindowInDaysType", + "documentation":"

    (Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. You can't use both this parameter and the ForceDeleteWithoutRecovery parameter in the same API call.

    This value can range from 7 to 30 days. The default value is 30.

    ", + "box":true + }, + "ForceDeleteWithoutRecovery":{ + "shape":"BooleanType", + "documentation":"

    (Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the RecoveryWindowInDays parameter in the same API call.

    An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.

    Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the RecoveryWindowInDays parameter. If you delete a secret with the ForceDeleteWithouRecovery parameter, then you have no opportunity to recover the secret. It is permanently lost.

    ", + "box":true + } + } + }, + "DeleteSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that is now scheduled for deletion.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret that is now scheduled for deletion.

    " + }, + "DeletionDate":{ + "shape":"DeletionDateType", + "documentation":"

    The date and time after which this secret can be deleted by Secrets Manager and can no longer be restored. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays.

    ", + "box":true + } + } + }, + "DeletedDateType":{"type":"timestamp"}, + "DeletionDateType":{"type":"timestamp"}, + "DescribeSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + } + } + }, + "DescribeSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The user-provided friendly name of the secret.

    " + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

    The user-provided description of the secret.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyIdType", + "documentation":"

    The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString or SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default AWS KMS CMK (the one named awssecretsmanager) for this account.

    " + }, + "RotationEnabled":{ + "shape":"RotationEnabledType", + "documentation":"

    Specifies whether automatic rotation is enabled for this secret.

    To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret.

    ", + "box":true + }, + "RotationLambdaARN":{ + "shape":"RotationLambdaARNType", + "documentation":"

    The ARN of a Lambda function that's invoked by Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret.

    " + }, + "RotationRules":{ + "shape":"RotationRulesType", + "documentation":"

    A structure that contains the rotation configuration for this secret.

    " + }, + "LastRotatedDate":{ + "shape":"LastRotatedDateType", + "documentation":"

    The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.

    ", + "box":true + }, + "LastChangedDate":{ + "shape":"LastChangedDateType", + "documentation":"

    The last date and time that this secret was modified in any way.

    ", + "box":true + }, + "LastAccessedDate":{ + "shape":"LastAccessedDateType", + "documentation":"

    The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

    ", + "box":true + }, + "DeletedDate":{ + "shape":"DeletedDateType", + "documentation":"

    This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.

    If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.

    ", + "box":true + }, + "Tags":{ + "shape":"TagListType", + "documentation":"

    The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

    " + }, + "VersionIdsToStages":{ + "shape":"SecretVersionsToStagesMapType", + "documentation":"

    A list of all of the currently assigned VersionStage staging labels and the VersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

    A version that does not have any staging labels attached is considered deprecated and subject to deletion. Such versions are not included in this list.

    " + }, + "OwningService":{"shape":"OwningServiceType"} + } + }, + "DescriptionType":{ + "type":"string", + "max":2048 + }, + "EncryptionFailure":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.

    ", + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "ExcludeCharactersType":{ + "type":"string", + "max":4096, + "min":0 + }, + "ExcludeLowercaseType":{"type":"boolean"}, + "ExcludeNumbersType":{"type":"boolean"}, + "ExcludePunctuationType":{"type":"boolean"}, + "ExcludeUppercaseType":{"type":"boolean"}, + "GetRandomPasswordRequest":{ + "type":"structure", + "members":{ + "PasswordLength":{ + "shape":"PasswordLengthType", + "documentation":"

    The desired length of the generated password. The default value if you do not include this parameter is 32 characters.

    ", + "box":true + }, + "ExcludeCharacters":{ + "shape":"ExcludeCharactersType", + "documentation":"

    A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.

    " + }, + "ExcludeNumbers":{ + "shape":"ExcludeNumbersType", + "documentation":"

    Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.

    ", + "box":true + }, + "ExcludePunctuation":{ + "shape":"ExcludePunctuationType", + "documentation":"

    Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.

    The following are the punctuation characters that can be included in the generated password if you don't explicitly exclude them with ExcludeCharacters or ExcludePunctuation:

    ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~

    ", + "box":true + }, + "ExcludeUppercase":{ + "shape":"ExcludeUppercaseType", + "documentation":"

    Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.

    ", + "box":true + }, + "ExcludeLowercase":{ + "shape":"ExcludeLowercaseType", + "documentation":"

    Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.

    ", + "box":true + }, + "IncludeSpace":{ + "shape":"IncludeSpaceType", + "documentation":"

    Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.

    ", + "box":true + }, + "RequireEachIncludedType":{ + "shape":"RequireEachIncludedTypeType", + "documentation":"

    A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.

    ", + "box":true + } + } + }, + "GetRandomPasswordResponse":{ + "type":"structure", + "members":{ + "RandomPassword":{ + "shape":"RandomPasswordType", + "documentation":"

    A string with the generated password.

    " + } + } + }, + "GetResourcePolicyRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + } + } + }, + "GetResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that the resource-based policy was retrieved for.

    " + }, + "Name":{ + "shape":"NameType", + "documentation":"

    The friendly name of the secret that the resource-based policy was retrieved for.

    " + }, + "ResourcePolicy":{ + "shape":"NonEmptyResourcePolicyType", + "documentation":"

    A JSON-formatted string that describes the permissions that are associated with the attached secret. These permissions are combined with any permissions that are associated with the user or role that attempts to access this secret. The combined permissions specify who can access the secret and what actions they can perform. For more information, see Authentication and Access Control for AWS Secrets Manager in the AWS Secrets Manager User Guide.

    " + } + } + }, + "GetSecretValueRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

    This value is typically a UUID-type value with 32 hexadecimal digits.

    " + }, + "VersionStage":{ + "shape":"SecretVersionStageType", + "documentation":"

    Specifies the secret version that you want to retrieve by the staging label attached to the version.

    Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

    " + } + } + }, + "GetSecretValueResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The unique identifier of this version of the secret.

    " + }, + "SecretBinary":{ + "shape":"SecretBinaryType", + "documentation":"

    The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.

    This parameter is not used if the secret is created by the Secrets Manager console.

    If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.

    " + }, + "SecretString":{ + "shape":"SecretStringType", + "documentation":"

    The decrypted part of the protected secret information that was originally provided as a string.

    If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

    If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.

    " + }, + "VersionStages":{ + "shape":"SecretVersionStagesType", + "documentation":"

    A list of all of the staging labels currently attached to this version of the secret.

    " + }, + "CreatedDate":{ + "shape":"CreatedDateType", + "documentation":"

    The date and time that this version of the secret was created.

    ", + "box":true + } + } + }, + "IncludeSpaceType":{"type":"boolean"}, + "InternalServiceError":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    An error occurred on the server side.

    ", + "exception":true, + "fault":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You provided an invalid NextToken value.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You provided an invalid value for a parameter.

    ", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You provided a parameter value that is not valid for the current state of the resource.

    Possible causes:

    • You tried to perform the operation on a secret that's currently marked deleted.

    • You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.

    ", + "exception":true + }, + "KmsKeyIdType":{ + "type":"string", + "max":2048, + "min":0 + }, + "LastAccessedDateType":{"type":"timestamp"}, + "LastChangedDateType":{"type":"timestamp"}, + "LastRotatedDateType":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request failed because it would exceed one of the Secrets Manager internal limits.

    ", + "exception":true + }, + "ListSecretVersionIdsRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "MaxResults":{ + "shape":"MaxResultsType", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextTokenType", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "IncludeDeprecated":{ + "shape":"BooleanType", + "documentation":"

    (Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

    ", + "box":true + } + } + }, + "ListSecretVersionIdsResponse":{ + "type":"structure", + "members":{ + "Versions":{ + "shape":"SecretVersionsListType", + "documentation":"

    The list of the currently available versions of the specified secret.

    " + }, + "NextToken":{ + "shape":"NextTokenType", + "documentation":"

    If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + }, + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The Amazon Resource Name (ARN) for the secret.

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret.

    " + } + } + }, + "ListSecretsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResultsType", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextTokenType", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + } + } + }, + "ListSecretsResponse":{ + "type":"structure", + "members":{ + "SecretList":{ + "shape":"SecretListType", + "documentation":"

    A list of the secrets in the account.

    " + }, + "NextToken":{ + "shape":"NextTokenType", + "documentation":"

    If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + } + } + }, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The policy document that you provided isn't valid.

    ", + "exception":true + }, + "MaxResultsType":{ + "type":"integer", + "max":100, + "min":1 + }, + "NameType":{ + "type":"string", + "max":512, + "min":1 + }, + "NextTokenType":{ + "type":"string", + "max":4096, + "min":1 + }, + "NonEmptyResourcePolicyType":{ + "type":"string", + "max":20480, + "min":1 + }, + "OwningServiceType":{ + "type":"string", + "max":128, + "min":1 + }, + "PasswordLengthType":{ + "type":"long", + "max":4096, + "min":1 + }, + "PreconditionNotMetException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request failed because you did not complete all the prerequisite steps.

    ", + "exception":true + }, + "PutResourcePolicyRequest":{ + "type":"structure", + "required":[ + "SecretId", + "ResourcePolicy" + ], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "ResourcePolicy":{ + "shape":"NonEmptyResourcePolicyType", + "documentation":"

    A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

    " + } + } + }, + "PutResourcePolicyResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that the resource-based policy was retrieved for.

    " + }, + "Name":{ + "shape":"NameType", + "documentation":"

    The friendly name of the secret that the resource-based policy was retrieved for.

    " + } + } + }, + "PutSecretValueRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenType", + "documentation":"

    (Optional) Specifies a unique identifier for the new version of the secret.

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

    This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

    • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

    • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

    • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

    This value becomes the VersionId of the new version.

    ", + "idempotencyToken":true + }, + "SecretBinary":{ + "shape":"SecretBinaryType", + "documentation":"

    (Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    This parameter is not accessible if the secret using the Secrets Manager console.

    " + }, + "SecretString":{ + "shape":"SecretStringType", + "documentation":"

    (Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

    If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

    For example:

    [{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]

    If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

    " + }, + "VersionStages":{ + "shape":"SecretVersionStagesType", + "documentation":"

    (Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.

    A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.

    If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label AWSCURRENT to this new version.

    " + } + } + }, + "PutSecretValueResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The Amazon Resource Name (ARN) for the secret for which you just created a version.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret for which you just created or updated a version.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The unique identifier of the version of the secret you just created or updated.

    " + }, + "VersionStages":{ + "shape":"SecretVersionStagesType", + "documentation":"

    The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.

    " + } + } + }, + "RandomPasswordType":{ + "type":"string", + "max":4096, + "min":0, + "sensitive":true + }, + "RecoveryWindowInDaysType":{"type":"long"}, + "RequireEachIncludedTypeType":{"type":"boolean"}, + "ResourceExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A resource with the ID you requested already exists.

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    We can't find the resource that you asked for.

    ", + "exception":true + }, + "RestoreSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + } + } + }, + "RestoreSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that was restored.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret that was restored.

    " + } + } + }, + "RotateSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenType", + "documentation":"

    (Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

    You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

    Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

    ", + "idempotencyToken":true + }, + "RotationLambdaARN":{ + "shape":"RotationLambdaARNType", + "documentation":"

    (Optional) Specifies the ARN of the Lambda function that can rotate the secret.

    " + }, + "RotationRules":{ + "shape":"RotationRulesType", + "documentation":"

    A structure that defines the rotation configuration for this secret.

    " + } + } + }, + "RotateSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The ID of the new version of the secret created by the rotation started by this request.

    ", + "box":true + } + } + }, + "RotationEnabledType":{"type":"boolean"}, + "RotationLambdaARNType":{ + "type":"string", + "max":2048, + "min":0 + }, + "RotationRulesType":{ + "type":"structure", + "members":{ + "AutomaticallyAfterDays":{ + "shape":"AutomaticallyRotateAfterDaysType", + "documentation":"

    Specifies the number of days between automatic scheduled rotations of the secret.

    Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

    ", + "box":true + } + }, + "documentation":"

    A structure that defines the rotation configuration for the secret.

    " + }, + "SecretARNType":{ + "type":"string", + "max":2048, + "min":20 + }, + "SecretBinaryType":{ + "type":"blob", + "max":10240, + "min":0, + "sensitive":true + }, + "SecretIdType":{ + "type":"string", + "max":2048, + "min":1 + }, + "SecretListEntry":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The Amazon Resource Name (ARN) of the secret.

    For more information about ARNs in Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.

    " + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

    The user-provided description of the secret.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyIdType", + "documentation":"

    The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account.

    " + }, + "RotationEnabled":{ + "shape":"RotationEnabledType", + "documentation":"

    Indicated whether automatic, scheduled rotation is enabled for this secret.

    ", + "box":true + }, + "RotationLambdaARN":{ + "shape":"RotationLambdaARNType", + "documentation":"

    The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

    " + }, + "RotationRules":{ + "shape":"RotationRulesType", + "documentation":"

    A structure that defines the rotation configuration for the secret.

    " + }, + "LastRotatedDate":{ + "shape":"LastRotatedDateType", + "documentation":"

    The last date and time that the rotation process for this secret was invoked.

    ", + "box":true + }, + "LastChangedDate":{ + "shape":"LastChangedDateType", + "documentation":"

    The last date and time that this secret was modified in any way.

    ", + "box":true + }, + "LastAccessedDate":{ + "shape":"LastAccessedDateType", + "documentation":"

    The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.

    ", + "box":true + }, + "DeletedDate":{ + "shape":"DeletedDateType", + "documentation":"

    The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

    " + }, + "Tags":{ + "shape":"TagListType", + "documentation":"

    The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

    " + }, + "SecretVersionsToStages":{ + "shape":"SecretVersionsToStagesMapType", + "documentation":"

    A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

    A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

    " + }, + "OwningService":{"shape":"OwningServiceType"} + }, + "documentation":"

    A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.

    " + }, + "SecretListType":{ + "type":"list", + "member":{"shape":"SecretListEntry"} + }, + "SecretNameType":{ + "type":"string", + "max":256, + "min":1 + }, + "SecretStringType":{ + "type":"string", + "max":10240, + "min":0, + "sensitive":true + }, + "SecretVersionIdType":{ + "type":"string", + "max":64, + "min":32 + }, + "SecretVersionStageType":{ + "type":"string", + "max":256, + "min":1 + }, + "SecretVersionStagesType":{ + "type":"list", + "member":{"shape":"SecretVersionStageType"}, + "max":20, + "min":1 + }, + "SecretVersionsListEntry":{ + "type":"structure", + "members":{ + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    The unique version identifier of this version of the secret.

    " + }, + "VersionStages":{ + "shape":"SecretVersionStagesType", + "documentation":"

    An array of staging labels that are currently associated with this version of the secret.

    " + }, + "LastAccessedDate":{ + "shape":"LastAccessedDateType", + "documentation":"

    The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.

    ", + "box":true + }, + "CreatedDate":{ + "shape":"CreatedDateType", + "documentation":"

    The date and time this version of the secret was created.

    ", + "box":true + } + }, + "documentation":"

    A structure that contains information about one version of a secret.

    " + }, + "SecretVersionsListType":{ + "type":"list", + "member":{"shape":"SecretVersionsListEntry"} + }, + "SecretVersionsToStagesMapType":{ + "type":"map", + "key":{"shape":"SecretVersionIdType"}, + "value":{"shape":"SecretVersionStagesType"} + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKeyType", + "documentation":"

    The key identifier, or name, of the tag.

    " + }, + "Value":{ + "shape":"TagValueType", + "documentation":"

    The string value that's associated with the key of the tag.

    " + } + }, + "documentation":"

    A structure that contains information about a tag.

    " + }, + "TagKeyListType":{ + "type":"list", + "member":{"shape":"TagKeyType"} + }, + "TagKeyType":{ + "type":"string", + "max":128, + "min":1 + }, + "TagListType":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "SecretId", + "Tags" + ], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "Tags":{ + "shape":"TagListType", + "documentation":"

    The tags to attach to the secret. Each element in the list consists of a Key and a Value.

    This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For the AWS CLI, you can also use the syntax: --Tags Key=\"Key1\",Value=\"Value1\",Key=\"Key2\",Value=\"Value2\"[,…]

    " + } + } + }, + "TagValueType":{ + "type":"string", + "max":256, + "min":0 + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "SecretId", + "TagKeys" + ], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "TagKeys":{ + "shape":"TagKeyListType", + "documentation":"

    A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.

    This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

    " + } + } + }, + "UpdateSecretRequest":{ + "type":"structure", + "required":["SecretId"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestTokenType", + "documentation":"

    (Optional) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.

    If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

    You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

    Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing.

    • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

    • If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

    • If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.

    This value becomes the VersionId of the new version.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"DescriptionType", + "documentation":"

    (Optional) Specifies an updated user-provided description of the secret.

    " + }, + "KmsKeyId":{ + "shape":"KmsKeyIdType", + "documentation":"

    (Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret.

    You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.

    " + }, + "SecretBinary":{ + "shape":"SecretBinaryType", + "documentation":"

    (Optional) Specifies updated binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    This parameter is not accessible using the Secrets Manager console.

    " + }, + "SecretString":{ + "shape":"SecretStringType", + "documentation":"

    (Optional) Specifies updated text data that you want to encrypt and store in this new version of the secret. Either SecretBinary or SecretString must have a value, but not both. They cannot both be empty.

    If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.

    For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

    [{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]

    If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. You can also 'escape' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped:

    \"[{\\\"username\\\":\\\"bob\\\"},{\\\"password\\\":\\\"abc123xyz456\\\"}]\"

    " + } + } + }, + "UpdateSecretResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret that was updated.

    Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret that was updated.

    " + }, + "VersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    If a new version of the secret was created by this operation, then VersionId contains the unique identifier of the new version.

    " + } + } + }, + "UpdateSecretVersionStageRequest":{ + "type":"structure", + "required":[ + "SecretId", + "VersionStage" + ], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

    Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

    If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

    " + }, + "VersionStage":{ + "shape":"SecretVersionStageType", + "documentation":"

    The staging label to add to this version.

    " + }, + "RemoveFromVersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

    ", + "box":true + }, + "MoveToVersionId":{ + "shape":"SecretVersionIdType", + "documentation":"

    (Optional) The secret version ID that you want to add the staging label to. If you want to remove a label from a version, then do not specify this parameter.

    If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

    ", + "box":true + } + } + }, + "UpdateSecretVersionStageResponse":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"SecretARNType", + "documentation":"

    The ARN of the secret with the staging label that was modified.

    " + }, + "Name":{ + "shape":"SecretNameType", + "documentation":"

    The friendly name of the secret with the staging label that was modified.

    " + } + } + } + }, + "documentation":"AWS Secrets Manager API Reference

    AWS Secrets Manager is a web service that enables you to store, manage, and retrieve, secrets.

    This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the AWS Secrets Manager User Guide.

    API Version

    This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

    As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (such as Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

    We recommend that you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide.

    Secrets Manager supports GET and POST requests for all actions. That is, the API doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

    Support and Feedback for AWS Secrets Manager

    We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the AWS Secrets Manager Discussion Forum. For more information about the AWS Discussion Forums, see Forums Help.

    How examples are presented

    The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

    Logging API Requests

    AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

    " +} diff --git a/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.sdk-extras.json b/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.sdk-extras.json new file mode 100644 index 00000000..dc78f892 --- /dev/null +++ b/aws/dist/botocore/data/secretsmanager/2017-10-17/service-2.sdk-extras.json @@ -0,0 +1,8 @@ +{ + "version": 1.0, + "merge": { + "metadata": { + "serviceId": "Secrets Manager" + } + } +} diff --git a/aws/dist/botocore/data/securityhub/2018-10-26/paginators-1.json b/aws/dist/botocore/data/securityhub/2018-10-26/paginators-1.json new file mode 100644 index 00000000..1a612b70 --- /dev/null +++ b/aws/dist/botocore/data/securityhub/2018-10-26/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "GetEnabledStandards": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StandardsSubscriptions" + }, + "GetFindings": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Findings" + }, + "GetInsights": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Insights" + }, + "ListEnabledProductsForImport": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ProductSubscriptions" + }, + "ListInvitations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Invitations" + }, + "ListMembers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Members" + } + } +} diff --git a/aws/dist/botocore/data/securityhub/2018-10-26/service-2.json b/aws/dist/botocore/data/securityhub/2018-10-26/service-2.json new file mode 100644 index 00000000..ea899ddf --- /dev/null +++ b/aws/dist/botocore/data/securityhub/2018-10-26/service-2.json @@ -0,0 +1,3179 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-10-26", + "endpointPrefix":"securityhub", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"AWS SecurityHub", + "serviceId":"SecurityHub", + "signatureVersion":"v4", + "signingName":"securityhub", + "uid":"securityhub-2018-10-26" + }, + "operations":{ + "AcceptInvitation":{ + "name":"AcceptInvitation", + "http":{ + "method":"POST", + "requestUri":"/master" + }, + "input":{"shape":"AcceptInvitationRequest"}, + "output":{"shape":"AcceptInvitationResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccessException"} + ], + "documentation":"

    Accepts the invitation to be a member account and be monitored by the Security Hub master account that the invitation was sent from. When the member account accepts the invitation, permission is granted to the master account to view findings generated in the member account.

    " + }, + "BatchDisableStandards":{ + "name":"BatchDisableStandards", + "http":{ + "method":"POST", + "requestUri":"/standards/deregister" + }, + "input":{"shape":"BatchDisableStandardsRequest"}, + "output":{"shape":"BatchDisableStandardsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Standards Supported in AWS Security Hub.

    " + }, + "BatchEnableStandards":{ + "name":"BatchEnableStandards", + "http":{ + "method":"POST", + "requestUri":"/standards/register" + }, + "input":{"shape":"BatchEnableStandardsRequest"}, + "output":{"shape":"BatchEnableStandardsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Enables the standards specified by the provided standardsArn. In this release, only CIS AWS Foundations standards are supported. For more information, see Standards Supported in AWS Security Hub.

    " + }, + "BatchImportFindings":{ + "name":"BatchImportFindings", + "http":{ + "method":"POST", + "requestUri":"/findings/import" + }, + "input":{"shape":"BatchImportFindingsRequest"}, + "output":{"shape":"BatchImportFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"} + ], + "documentation":"

    Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.

    " + }, + "CreateActionTarget":{ + "name":"CreateActionTarget", + "http":{ + "method":"POST", + "requestUri":"/actionTargets" + }, + "input":{"shape":"CreateActionTargetRequest"}, + "output":{"shape":"CreateActionTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceConflictException"} + ], + "documentation":"

    Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.

    " + }, + "CreateInsight":{ + "name":"CreateInsight", + "http":{ + "method":"POST", + "requestUri":"/insights" + }, + "input":{"shape":"CreateInsightRequest"}, + "output":{"shape":"CreateInsightResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceConflictException"} + ], + "documentation":"

    Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. Use the GroupByAttribute to group the related findings in the insight.

    " + }, + "CreateMembers":{ + "name":"CreateMembers", + "http":{ + "method":"POST", + "requestUri":"/members" + }, + "input":{"shape":"CreateMembersRequest"}, + "output":{"shape":"CreateMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceConflictException"} + ], + "documentation":"

    Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the master account. To successfully create a member, you must use this action from an account that already has Security Hub enabled. You can use the EnableSecurityHub to enable Security Hub.

    After you use CreateMembers to create member account associations in Security Hub, you need to use the InviteMembers action, which invites the accounts to enable Security Hub and become member accounts in Security Hub. If the invitation is accepted by the account owner, the account becomes a member account in Security Hub, and a permission policy is added that permits the master account to view the findings generated in the member account. When Security Hub is enabled in the invited account, findings start being sent to both the member and master accounts.

    You can remove the association between the master and member accounts by using the DisassociateFromMasterAccount or DisassociateMembers operation.

    " + }, + "DeclineInvitations":{ + "name":"DeclineInvitations", + "http":{ + "method":"POST", + "requestUri":"/invitations/decline" + }, + "input":{"shape":"DeclineInvitationsRequest"}, + "output":{"shape":"DeclineInvitationsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Declines invitations to become a member account.

    " + }, + "DeleteActionTarget":{ + "name":"DeleteActionTarget", + "http":{ + "method":"DELETE", + "requestUri":"/actionTargets/{ActionTargetArn+}" + }, + "input":{"shape":"DeleteActionTargetRequest"}, + "output":{"shape":"DeleteActionTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes a custom action target from Security Hub. Deleting a custom action target doesn't affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.

    " + }, + "DeleteInsight":{ + "name":"DeleteInsight", + "http":{ + "method":"DELETE", + "requestUri":"/insights/{InsightArn+}" + }, + "input":{"shape":"DeleteInsightRequest"}, + "output":{"shape":"DeleteInsightResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the insight specified by the InsightArn.

    " + }, + "DeleteInvitations":{ + "name":"DeleteInvitations", + "http":{ + "method":"POST", + "requestUri":"/invitations/delete" + }, + "input":{"shape":"DeleteInvitationsRequest"}, + "output":{"shape":"DeleteInvitationsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccessException"} + ], + "documentation":"

    Deletes invitations received by the AWS account to become a member account.

    " + }, + "DeleteMembers":{ + "name":"DeleteMembers", + "http":{ + "method":"POST", + "requestUri":"/members/delete" + }, + "input":{"shape":"DeleteMembersRequest"}, + "output":{"shape":"DeleteMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the specified member accounts from Security Hub.

    " + }, + "DescribeActionTargets":{ + "name":"DescribeActionTargets", + "http":{ + "method":"POST", + "requestUri":"/actionTargets/get" + }, + "input":{"shape":"DescribeActionTargetsRequest"}, + "output":{"shape":"DescribeActionTargetsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns a list of the custom action targets in Security Hub in your account.

    " + }, + "DescribeHub":{ + "name":"DescribeHub", + "http":{ + "method":"GET", + "requestUri":"/accounts" + }, + "input":{"shape":"DescribeHubRequest"}, + "output":{"shape":"DescribeHubResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.

    " + }, + "DescribeProducts":{ + "name":"DescribeProducts", + "http":{ + "method":"GET", + "requestUri":"/products" + }, + "input":{"shape":"DescribeProductsRequest"}, + "output":{"shape":"DescribeProductsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

    Returns information about the products available that you can subscribe to and integrate with Security Hub to consolidate findings.

    " + }, + "DisableImportFindingsForProduct":{ + "name":"DisableImportFindingsForProduct", + "http":{ + "method":"DELETE", + "requestUri":"/productSubscriptions/{ProductSubscriptionArn+}" + }, + "input":{"shape":"DisableImportFindingsForProductRequest"}, + "output":{"shape":"DisableImportFindingsForProductResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Disables the integration of the specified product with Security Hub. Findings from that product are no longer sent to Security Hub after the integration is disabled.

    " + }, + "DisableSecurityHub":{ + "name":"DisableSecurityHub", + "http":{ + "method":"DELETE", + "requestUri":"/accounts" + }, + "input":{"shape":"DisableSecurityHubRequest"}, + "output":{"shape":"DisableSecurityHubResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disables Security Hub in your account only in the current Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. When you disable Security Hub for a master account, it doesn't disable Security Hub for any associated member accounts.

    When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and can't be recovered. Any standards that were enabled are disabled, and your master and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.

    " + }, + "DisassociateFromMasterAccount":{ + "name":"DisassociateFromMasterAccount", + "http":{ + "method":"POST", + "requestUri":"/master/disassociate" + }, + "input":{"shape":"DisassociateFromMasterAccountRequest"}, + "output":{"shape":"DisassociateFromMasterAccountResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates the current Security Hub member account from the associated master account.

    " + }, + "DisassociateMembers":{ + "name":"DisassociateMembers", + "http":{ + "method":"POST", + "requestUri":"/members/disassociate" + }, + "input":{"shape":"DisassociateMembersRequest"}, + "output":{"shape":"DisassociateMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates the specified member accounts from the associated master account.

    " + }, + "EnableImportFindingsForProduct":{ + "name":"EnableImportFindingsForProduct", + "http":{ + "method":"POST", + "requestUri":"/productSubscriptions" + }, + "input":{"shape":"EnableImportFindingsForProductRequest"}, + "output":{"shape":"EnableImportFindingsForProductResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceConflictException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permission policy that grants permission for the product to send findings to Security Hub is applied.

    " + }, + "EnableSecurityHub":{ + "name":"EnableSecurityHub", + "http":{ + "method":"POST", + "requestUri":"/accounts" + }, + "input":{"shape":"EnableSecurityHubRequest"}, + "output":{"shape":"EnableSecurityHubResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceConflictException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from AWS Config, Amazon GuardDuty, Amazon Inspector, and Amazon Macie. To learn more, see Setting Up AWS Security Hub.

    " + }, + "GetEnabledStandards":{ + "name":"GetEnabledStandards", + "http":{ + "method":"POST", + "requestUri":"/standards/get" + }, + "input":{"shape":"GetEnabledStandardsRequest"}, + "output":{"shape":"GetEnabledStandardsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Returns a list of the standards that are currently enabled.

    " + }, + "GetFindings":{ + "name":"GetFindings", + "http":{ + "method":"POST", + "requestUri":"/findings" + }, + "input":{"shape":"GetFindingsRequest"}, + "output":{"shape":"GetFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Returns a list of findings that match the specified criteria.

    " + }, + "GetInsightResults":{ + "name":"GetInsightResults", + "http":{ + "method":"GET", + "requestUri":"/insights/results/{InsightArn+}" + }, + "input":{"shape":"GetInsightResultsRequest"}, + "output":{"shape":"GetInsightResultsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the results of the Security Hub insight that the insight ARN specifies.

    " + }, + "GetInsights":{ + "name":"GetInsights", + "http":{ + "method":"POST", + "requestUri":"/insights/get" + }, + "input":{"shape":"GetInsightsRequest"}, + "output":{"shape":"GetInsightsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists and describes insights that insight ARNs specify.

    " + }, + "GetInvitationsCount":{ + "name":"GetInvitationsCount", + "http":{ + "method":"GET", + "requestUri":"/invitations/count" + }, + "input":{"shape":"GetInvitationsCountRequest"}, + "output":{"shape":"GetInvitationsCountResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.

    " + }, + "GetMasterAccount":{ + "name":"GetMasterAccount", + "http":{ + "method":"GET", + "requestUri":"/master" + }, + "input":{"shape":"GetMasterAccountRequest"}, + "output":{"shape":"GetMasterAccountResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Provides the details for the Security Hub master account to the current member account.

    " + }, + "GetMembers":{ + "name":"GetMembers", + "http":{ + "method":"POST", + "requestUri":"/members/get" + }, + "input":{"shape":"GetMembersRequest"}, + "output":{"shape":"GetMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns the details on the Security Hub member accounts that the account IDs specify.

    " + }, + "InviteMembers":{ + "name":"InviteMembers", + "http":{ + "method":"POST", + "requestUri":"/members/invite" + }, + "input":{"shape":"InviteMembersRequest"}, + "output":{"shape":"InviteMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Invites other AWS accounts to become member accounts for the Security Hub master account that the invitation is sent from. Before you can use this action to invite a member, you must first create the member account in Security Hub by using the CreateMembers action. When the account owner accepts the invitation to become a member account and enables Security Hub, the master account can view the findings generated from member account.

    " + }, + "ListEnabledProductsForImport":{ + "name":"ListEnabledProductsForImport", + "http":{ + "method":"GET", + "requestUri":"/productSubscriptions" + }, + "input":{"shape":"ListEnabledProductsForImportRequest"}, + "output":{"shape":"ListEnabledProductsForImportResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"} + ], + "documentation":"

    Lists all findings-generating solutions (products) whose findings you have subscribed to receive in Security Hub.

    " + }, + "ListInvitations":{ + "name":"ListInvitations", + "http":{ + "method":"GET", + "requestUri":"/invitations" + }, + "input":{"shape":"ListInvitationsRequest"}, + "output":{"shape":"ListInvitationsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Lists all Security Hub membership invitations that were sent to the current AWS account.

    " + }, + "ListMembers":{ + "name":"ListMembers", + "http":{ + "method":"GET", + "requestUri":"/members" + }, + "input":{"shape":"ListMembersRequest"}, + "output":{"shape":"ListMembersResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Lists details about all member accounts for the current Security Hub master account.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns a list of tags associated with a resource.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Adds one or more tags to a resource.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{ResourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Removes one or more tags from a resource.

    " + }, + "UpdateActionTarget":{ + "name":"UpdateActionTarget", + "http":{ + "method":"PATCH", + "requestUri":"/actionTargets/{ActionTargetArn+}" + }, + "input":{"shape":"UpdateActionTargetRequest"}, + "output":{"shape":"UpdateActionTargetResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Updates the name and description of a custom action target in Security Hub.

    " + }, + "UpdateFindings":{ + "name":"UpdateFindings", + "http":{ + "method":"PATCH", + "requestUri":"/findings" + }, + "input":{"shape":"UpdateFindingsRequest"}, + "output":{"shape":"UpdateFindingsResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidAccessException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding.

    " + }, + "UpdateInsight":{ + "name":"UpdateInsight", + "http":{ + "method":"PATCH", + "requestUri":"/insights/{InsightArn+}" + }, + "input":{"shape":"UpdateInsightRequest"}, + "output":{"shape":"UpdateInsightResponse"}, + "errors":[ + {"shape":"InternalException"}, + {"shape":"InvalidInputException"}, + {"shape":"InvalidAccessException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Updates the Security Hub insight that the insight ARN specifies.

    " + } + }, + "shapes":{ + "AcceptInvitationRequest":{ + "type":"structure", + "required":[ + "MasterId", + "InvitationId" + ], + "members":{ + "MasterId":{ + "shape":"NonEmptyString", + "documentation":"

    The account ID of the Security Hub master account that sent the invitation.

    " + }, + "InvitationId":{ + "shape":"NonEmptyString", + "documentation":"

    The ID of the invitation sent from the Security Hub master account.

    " + } + } + }, + "AcceptInvitationResponse":{ + "type":"structure", + "members":{ + } + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    You don't have permission to perform the action specified in the request.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AccountDetails":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The ID of an AWS account.

    " + }, + "Email":{ + "shape":"NonEmptyString", + "documentation":"

    The email of an AWS account.

    " + } + }, + "documentation":"

    The details of an AWS account.

    " + }, + "AccountDetailsList":{ + "type":"list", + "member":{"shape":"AccountDetails"} + }, + "AccountId":{"type":"string"}, + "AccountIdList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "ActionTarget":{ + "type":"structure", + "required":[ + "ActionTargetArn", + "Name", + "Description" + ], + "members":{ + "ActionTargetArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN for the target action.

    " + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the action target.

    " + }, + "Description":{ + "shape":"NonEmptyString", + "documentation":"

    The description of the target action.

    " + } + }, + "documentation":"

    An ActionTarget object.

    " + }, + "ActionTargetList":{ + "type":"list", + "member":{"shape":"ActionTarget"} + }, + "ArnList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "AwsEc2InstanceDetails":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"NonEmptyString", + "documentation":"

    The instance type of the instance.

    " + }, + "ImageId":{ + "shape":"NonEmptyString", + "documentation":"

    The Amazon Machine Image (AMI) ID of the instance.

    " + }, + "IpV4Addresses":{ + "shape":"StringList", + "documentation":"

    The IPv4 addresses associated with the instance.

    " + }, + "IpV6Addresses":{ + "shape":"StringList", + "documentation":"

    The IPv6 addresses associated with the instance.

    " + }, + "KeyName":{ + "shape":"NonEmptyString", + "documentation":"

    The key name associated with the instance.

    " + }, + "IamInstanceProfileArn":{ + "shape":"NonEmptyString", + "documentation":"

    The IAM profile ARN of the instance.

    " + }, + "VpcId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the VPC that the instance was launched in.

    " + }, + "SubnetId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the subnet that the instance was launched in.

    " + }, + "LaunchedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date/time the instance was launched.

    " + } + }, + "documentation":"

    The details of an Amazon EC2 instance.

    " + }, + "AwsIamAccessKeyDetails":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"NonEmptyString", + "documentation":"

    The user associated with the IAM access key related to a finding.

    " + }, + "Status":{ + "shape":"AwsIamAccessKeyStatus", + "documentation":"

    The status of the IAM access key related to a finding.

    " + }, + "CreatedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The creation date/time of the IAM access key related to a finding.

    " + } + }, + "documentation":"

    IAM access key details related to a finding.

    " + }, + "AwsIamAccessKeyStatus":{ + "type":"string", + "enum":[ + "Active", + "Inactive" + ] + }, + "AwsS3BucketDetails":{ + "type":"structure", + "members":{ + "OwnerId":{ + "shape":"NonEmptyString", + "documentation":"

    The canonical user ID of the owner of the S3 bucket.

    " + }, + "OwnerName":{ + "shape":"NonEmptyString", + "documentation":"

    The display name of the owner of the S3 bucket.

    " + } + }, + "documentation":"

    The details of an Amazon S3 bucket.

    " + }, + "AwsSecurityFinding":{ + "type":"structure", + "required":[ + "SchemaVersion", + "Id", + "ProductArn", + "GeneratorId", + "AwsAccountId", + "Types", + "CreatedAt", + "UpdatedAt", + "Severity", + "Title", + "Description", + "Resources" + ], + "members":{ + "SchemaVersion":{ + "shape":"NonEmptyString", + "documentation":"

    The schema version that a finding is formatted for.

    " + }, + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The security findings provider-specific identifier for a finding.

    " + }, + "ProductArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN generated by Security Hub that uniquely identifies a third-party company (security-findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

    " + }, + "GeneratorId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

    " + }, + "AwsAccountId":{ + "shape":"NonEmptyString", + "documentation":"

    The AWS account ID that a finding is generated in.

    " + }, + "Types":{ + "shape":"TypeList", + "documentation":"

    One or more finding types in the format of namespace/category/classifier that classify a finding.

    Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

    " + }, + "FirstObservedAt":{ + "shape":"NonEmptyString", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

    " + }, + "LastObservedAt":{ + "shape":"NonEmptyString", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

    " + }, + "CreatedAt":{ + "shape":"NonEmptyString", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider created the potential security issue that a finding captured.

    " + }, + "UpdatedAt":{ + "shape":"NonEmptyString", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

    " + }, + "Severity":{ + "shape":"Severity", + "documentation":"

    A finding's severity.

    " + }, + "Confidence":{ + "shape":"Integer", + "documentation":"

    A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

    " + }, + "Criticality":{ + "shape":"Integer", + "documentation":"

    The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

    " + }, + "Title":{ + "shape":"NonEmptyString", + "documentation":"

    A finding's title.

    In this release, Title is a required property.

    " + }, + "Description":{ + "shape":"NonEmptyString", + "documentation":"

    A finding's description.

    In this release, Description is a required property.

    " + }, + "Remediation":{ + "shape":"Remediation", + "documentation":"

    A data type that describes the remediation options for a finding.

    " + }, + "SourceUrl":{ + "shape":"NonEmptyString", + "documentation":"

    A URL that links to a page about the current finding in the security-findings provider's solution.

    " + }, + "ProductFields":{ + "shape":"FieldMap", + "documentation":"

    A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

    " + }, + "UserDefinedFields":{ + "shape":"FieldMap", + "documentation":"

    A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

    " + }, + "Malware":{ + "shape":"MalwareList", + "documentation":"

    A list of malware related to a finding.

    " + }, + "Network":{ + "shape":"Network", + "documentation":"

    The details of network-related information about a finding.

    " + }, + "Process":{ + "shape":"ProcessDetails", + "documentation":"

    The details of process-related information about a finding.

    " + }, + "ThreatIntelIndicators":{ + "shape":"ThreatIntelIndicatorList", + "documentation":"

    Threat intel details related to a finding.

    " + }, + "Resources":{ + "shape":"ResourceList", + "documentation":"

    A set of resource data types that describe the resources that the finding refers to.

    " + }, + "Compliance":{ + "shape":"Compliance", + "documentation":"

    This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

    " + }, + "VerificationState":{ + "shape":"VerificationState", + "documentation":"

    Indicates the veracity of a finding.

    " + }, + "WorkflowState":{ + "shape":"WorkflowState", + "documentation":"

    The workflow state of a finding.

    " + }, + "RecordState":{ + "shape":"RecordState", + "documentation":"

    The record state of a finding.

    " + }, + "RelatedFindings":{ + "shape":"RelatedFindingList", + "documentation":"

    A list of related findings.

    " + }, + "Note":{ + "shape":"Note", + "documentation":"

    A user-defined note added to a finding.

    " + } + }, + "documentation":"

    Provides consistent format for the contents of the Security Hub-aggregated findings. AwsSecurityFinding format enables you to share findings between AWS security services and third-party solutions, and compliance checks.

    A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and compliance checks.

    " + }, + "AwsSecurityFindingFilters":{ + "type":"structure", + "members":{ + "ProductArn":{ + "shape":"StringFilterList", + "documentation":"

    The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

    " + }, + "AwsAccountId":{ + "shape":"StringFilterList", + "documentation":"

    The AWS account ID that a finding is generated in.

    " + }, + "Id":{ + "shape":"StringFilterList", + "documentation":"

    The security findings provider-specific identifier for a finding.

    " + }, + "GeneratorId":{ + "shape":"StringFilterList", + "documentation":"

    The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security-findings providers' solutions, this generator can be called a rule, a check, a detector, a plug-in, etc.

    " + }, + "Type":{ + "shape":"StringFilterList", + "documentation":"

    A finding type in the format of namespace/category/classifier that classifies a finding.

    " + }, + "FirstObservedAt":{ + "shape":"DateFilterList", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider first observed the potential security issue that a finding captured.

    " + }, + "LastObservedAt":{ + "shape":"DateFilterList", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider most recently observed the potential security issue that a finding captured.

    " + }, + "CreatedAt":{ + "shape":"DateFilterList", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider captured the potential security issue that a finding captured.

    " + }, + "UpdatedAt":{ + "shape":"DateFilterList", + "documentation":"

    An ISO8601-formatted timestamp that indicates when the security-findings provider last updated the finding record.

    " + }, + "SeverityProduct":{ + "shape":"NumberFilterList", + "documentation":"

    The native severity as defined by the security-findings provider's solution that generated the finding.

    " + }, + "SeverityNormalized":{ + "shape":"NumberFilterList", + "documentation":"

    The normalized severity of a finding.

    " + }, + "SeverityLabel":{ + "shape":"StringFilterList", + "documentation":"

    The label of a finding's severity.

    " + }, + "Confidence":{ + "shape":"NumberFilterList", + "documentation":"

    A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

    " + }, + "Criticality":{ + "shape":"NumberFilterList", + "documentation":"

    The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

    " + }, + "Title":{ + "shape":"StringFilterList", + "documentation":"

    A finding's title.

    " + }, + "Description":{ + "shape":"StringFilterList", + "documentation":"

    A finding's description.

    " + }, + "RecommendationText":{ + "shape":"StringFilterList", + "documentation":"

    The recommendation of what to do about the issue described in a finding.

    " + }, + "SourceUrl":{ + "shape":"StringFilterList", + "documentation":"

    A URL that links to a page about the current finding in the security-findings provider's solution.

    " + }, + "ProductFields":{ + "shape":"MapFilterList", + "documentation":"

    A data type where security-findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

    " + }, + "ProductName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the solution (product) that generates findings.

    " + }, + "CompanyName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the findings provider (company) that owns the solution (product) that generates findings.

    " + }, + "UserDefinedFields":{ + "shape":"MapFilterList", + "documentation":"

    A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

    " + }, + "MalwareName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the malware that was observed.

    " + }, + "MalwareType":{ + "shape":"StringFilterList", + "documentation":"

    The type of the malware that was observed.

    " + }, + "MalwarePath":{ + "shape":"StringFilterList", + "documentation":"

    The filesystem path of the malware that was observed.

    " + }, + "MalwareState":{ + "shape":"StringFilterList", + "documentation":"

    The state of the malware that was observed.

    " + }, + "NetworkDirection":{ + "shape":"StringFilterList", + "documentation":"

    Indicates the direction of network traffic associated with a finding.

    " + }, + "NetworkProtocol":{ + "shape":"StringFilterList", + "documentation":"

    The protocol of network-related information about a finding.

    " + }, + "NetworkSourceIpV4":{ + "shape":"IpFilterList", + "documentation":"

    The source IPv4 address of network-related information about a finding.

    " + }, + "NetworkSourceIpV6":{ + "shape":"IpFilterList", + "documentation":"

    The source IPv6 address of network-related information about a finding.

    " + }, + "NetworkSourcePort":{ + "shape":"NumberFilterList", + "documentation":"

    The source port of network-related information about a finding.

    " + }, + "NetworkSourceDomain":{ + "shape":"StringFilterList", + "documentation":"

    The source domain of network-related information about a finding.

    " + }, + "NetworkSourceMac":{ + "shape":"StringFilterList", + "documentation":"

    The source media access control (MAC) address of network-related information about a finding.

    " + }, + "NetworkDestinationIpV4":{ + "shape":"IpFilterList", + "documentation":"

    The destination IPv4 address of network-related information about a finding.

    " + }, + "NetworkDestinationIpV6":{ + "shape":"IpFilterList", + "documentation":"

    The destination IPv6 address of network-related information about a finding.

    " + }, + "NetworkDestinationPort":{ + "shape":"NumberFilterList", + "documentation":"

    The destination port of network-related information about a finding.

    " + }, + "NetworkDestinationDomain":{ + "shape":"StringFilterList", + "documentation":"

    The destination domain of network-related information about a finding.

    " + }, + "ProcessName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the process.

    " + }, + "ProcessPath":{ + "shape":"StringFilterList", + "documentation":"

    The path to the process executable.

    " + }, + "ProcessPid":{ + "shape":"NumberFilterList", + "documentation":"

    The process ID.

    " + }, + "ProcessParentPid":{ + "shape":"NumberFilterList", + "documentation":"

    The parent process ID.

    " + }, + "ProcessLaunchedAt":{ + "shape":"DateFilterList", + "documentation":"

    The date/time that the process was launched.

    " + }, + "ProcessTerminatedAt":{ + "shape":"DateFilterList", + "documentation":"

    The date/time that the process was terminated.

    " + }, + "ThreatIntelIndicatorType":{ + "shape":"StringFilterList", + "documentation":"

    The type of a threat intel indicator.

    " + }, + "ThreatIntelIndicatorValue":{ + "shape":"StringFilterList", + "documentation":"

    The value of a threat intel indicator.

    " + }, + "ThreatIntelIndicatorCategory":{ + "shape":"StringFilterList", + "documentation":"

    The category of a threat intel indicator.

    " + }, + "ThreatIntelIndicatorLastObservedAt":{ + "shape":"DateFilterList", + "documentation":"

    The date/time of the last observation of a threat intel indicator.

    " + }, + "ThreatIntelIndicatorSource":{ + "shape":"StringFilterList", + "documentation":"

    The source of the threat intel.

    " + }, + "ThreatIntelIndicatorSourceUrl":{ + "shape":"StringFilterList", + "documentation":"

    The URL for more details from the source of the threat intel.

    " + }, + "ResourceType":{ + "shape":"StringFilterList", + "documentation":"

    Specifies the type of the resource that details are provided for.

    " + }, + "ResourceId":{ + "shape":"StringFilterList", + "documentation":"

    The canonical identifier for the given resource type.

    " + }, + "ResourcePartition":{ + "shape":"StringFilterList", + "documentation":"

    The canonical AWS partition name that the Region is assigned to.

    " + }, + "ResourceRegion":{ + "shape":"StringFilterList", + "documentation":"

    The canonical AWS external Region name where this resource is located.

    " + }, + "ResourceTags":{ + "shape":"MapFilterList", + "documentation":"

    A list of AWS tags associated with a resource at the time the finding was processed.

    " + }, + "ResourceAwsEc2InstanceType":{ + "shape":"StringFilterList", + "documentation":"

    The instance type of the instance.

    " + }, + "ResourceAwsEc2InstanceImageId":{ + "shape":"StringFilterList", + "documentation":"

    The Amazon Machine Image (AMI) ID of the instance.

    " + }, + "ResourceAwsEc2InstanceIpV4Addresses":{ + "shape":"IpFilterList", + "documentation":"

    The IPv4 addresses associated with the instance.

    " + }, + "ResourceAwsEc2InstanceIpV6Addresses":{ + "shape":"IpFilterList", + "documentation":"

    The IPv6 addresses associated with the instance.

    " + }, + "ResourceAwsEc2InstanceKeyName":{ + "shape":"StringFilterList", + "documentation":"

    The key name associated with the instance.

    " + }, + "ResourceAwsEc2InstanceIamInstanceProfileArn":{ + "shape":"StringFilterList", + "documentation":"

    The IAM profile ARN of the instance.

    " + }, + "ResourceAwsEc2InstanceVpcId":{ + "shape":"StringFilterList", + "documentation":"

    The identifier of the VPC that the instance was launched in.

    " + }, + "ResourceAwsEc2InstanceSubnetId":{ + "shape":"StringFilterList", + "documentation":"

    The identifier of the subnet that the instance was launched in.

    " + }, + "ResourceAwsEc2InstanceLaunchedAt":{ + "shape":"DateFilterList", + "documentation":"

    The date/time the instance was launched.

    " + }, + "ResourceAwsS3BucketOwnerId":{ + "shape":"StringFilterList", + "documentation":"

    The canonical user ID of the owner of the S3 bucket.

    " + }, + "ResourceAwsS3BucketOwnerName":{ + "shape":"StringFilterList", + "documentation":"

    The display name of the owner of the S3 bucket.

    " + }, + "ResourceAwsIamAccessKeyUserName":{ + "shape":"StringFilterList", + "documentation":"

    The user associated with the IAM access key related to a finding.

    " + }, + "ResourceAwsIamAccessKeyStatus":{ + "shape":"StringFilterList", + "documentation":"

    The status of the IAM access key related to a finding.

    " + }, + "ResourceAwsIamAccessKeyCreatedAt":{ + "shape":"DateFilterList", + "documentation":"

    The creation date/time of the IAM access key related to a finding.

    " + }, + "ResourceContainerName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the container related to a finding.

    " + }, + "ResourceContainerImageId":{ + "shape":"StringFilterList", + "documentation":"

    The identifier of the image related to a finding.

    " + }, + "ResourceContainerImageName":{ + "shape":"StringFilterList", + "documentation":"

    The name of the image related to a finding.

    " + }, + "ResourceContainerLaunchedAt":{ + "shape":"DateFilterList", + "documentation":"

    The date/time that the container was started.

    " + }, + "ResourceDetailsOther":{ + "shape":"MapFilterList", + "documentation":"

    The details of a resource that doesn't have a specific subfield for the resource type defined.

    " + }, + "ComplianceStatus":{ + "shape":"StringFilterList", + "documentation":"

    Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

    " + }, + "VerificationState":{ + "shape":"StringFilterList", + "documentation":"

    The veracity of a finding.

    " + }, + "WorkflowState":{ + "shape":"StringFilterList", + "documentation":"

    The workflow state of a finding.

    " + }, + "RecordState":{ + "shape":"StringFilterList", + "documentation":"

    The updated record state for the finding.

    " + }, + "RelatedFindingsProductArn":{ + "shape":"StringFilterList", + "documentation":"

    The ARN of the solution that generated a related finding.

    " + }, + "RelatedFindingsId":{ + "shape":"StringFilterList", + "documentation":"

    The solution-generated identifier for a related finding.

    " + }, + "NoteText":{ + "shape":"StringFilterList", + "documentation":"

    The text of a note.

    " + }, + "NoteUpdatedAt":{ + "shape":"DateFilterList", + "documentation":"

    The timestamp of when the note was updated.

    " + }, + "NoteUpdatedBy":{ + "shape":"StringFilterList", + "documentation":"

    The principal that created a note.

    " + }, + "Keyword":{ + "shape":"KeywordFilterList", + "documentation":"

    A keyword for a finding.

    " + } + }, + "documentation":"

    A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.

    " + }, + "AwsSecurityFindingList":{ + "type":"list", + "member":{"shape":"AwsSecurityFinding"} + }, + "BatchDisableStandardsRequest":{ + "type":"structure", + "required":["StandardsSubscriptionArns"], + "members":{ + "StandardsSubscriptionArns":{ + "shape":"StandardsSubscriptionArns", + "documentation":"

    The ARNs of the standards subscriptions to disable.

    " + } + } + }, + "BatchDisableStandardsResponse":{ + "type":"structure", + "members":{ + "StandardsSubscriptions":{ + "shape":"StandardsSubscriptions", + "documentation":"

    The details of the standards subscriptions that were disabled.

    " + } + } + }, + "BatchEnableStandardsRequest":{ + "type":"structure", + "required":["StandardsSubscriptionRequests"], + "members":{ + "StandardsSubscriptionRequests":{ + "shape":"StandardsSubscriptionRequests", + "documentation":"

    The list of standards compliance checks to enable.

    In this release, Security Hub supports only the CIS AWS Foundations standard.

    The ARN for the standard is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

    " + } + } + }, + "BatchEnableStandardsResponse":{ + "type":"structure", + "members":{ + "StandardsSubscriptions":{ + "shape":"StandardsSubscriptions", + "documentation":"

    The details of the standards subscriptions that were enabled.

    " + } + } + }, + "BatchImportFindingsRequest":{ + "type":"structure", + "required":["Findings"], + "members":{ + "Findings":{ + "shape":"AwsSecurityFindingList", + "documentation":"

    A list of findings to import. To successfully import a finding, it must follow the AWS Security Finding Format.

    " + } + } + }, + "BatchImportFindingsResponse":{ + "type":"structure", + "required":[ + "FailedCount", + "SuccessCount" + ], + "members":{ + "FailedCount":{ + "shape":"Integer", + "documentation":"

    The number of findings that failed to import.

    " + }, + "SuccessCount":{ + "shape":"Integer", + "documentation":"

    The number of findings that were successfully imported.

    " + }, + "FailedFindings":{ + "shape":"ImportFindingsErrorList", + "documentation":"

    The list of the findings that failed to import.

    " + } + } + }, + "Boolean":{"type":"boolean"}, + "CategoryList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "Compliance":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"ComplianceStatus", + "documentation":"

    The result of a compliance check.

    " + } + }, + "documentation":"

    Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard (for example, CIS AWS Foundations). Contains compliance-related finding details.

    " + }, + "ComplianceStatus":{ + "type":"string", + "enum":[ + "PASSED", + "WARNING", + "FAILED", + "NOT_AVAILABLE" + ] + }, + "ContainerDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the container related to a finding.

    " + }, + "ImageId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the image related to a finding.

    " + }, + "ImageName":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the image related to a finding.

    " + }, + "LaunchedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date and time when the container started.

    " + } + }, + "documentation":"

    Container details related to a finding.

    " + }, + "CreateActionTargetRequest":{ + "type":"structure", + "required":[ + "Name", + "Description", + "Id" + ], + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the custom action target.

    " + }, + "Description":{ + "shape":"NonEmptyString", + "documentation":"

    The description for the custom action target.

    " + }, + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The ID for the custom action target.

    " + } + } + }, + "CreateActionTargetResponse":{ + "type":"structure", + "required":["ActionTargetArn"], + "members":{ + "ActionTargetArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN for the custom action target.

    " + } + } + }, + "CreateInsightRequest":{ + "type":"structure", + "required":[ + "Name", + "Filters", + "GroupByAttribute" + ], + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the custom insight to create.

    " + }, + "Filters":{ + "shape":"AwsSecurityFindingFilters", + "documentation":"

    One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.

    " + }, + "GroupByAttribute":{ + "shape":"NonEmptyString", + "documentation":"

    The attribute used as the aggregator to group related findings for the insight.

    " + } + } + }, + "CreateInsightResponse":{ + "type":"structure", + "required":["InsightArn"], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight created.

    " + } + } + }, + "CreateMembersRequest":{ + "type":"structure", + "members":{ + "AccountDetails":{ + "shape":"AccountDetailsList", + "documentation":"

    A list of account ID and email address pairs of the accounts to associate with the Security Hub master account.

    " + } + } + }, + "CreateMembersResponse":{ + "type":"structure", + "members":{ + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that weren't processed.

    " + } + } + }, + "DateFilter":{ + "type":"structure", + "members":{ + "Start":{ + "shape":"NonEmptyString", + "documentation":"

    A start date for the date filter.

    " + }, + "End":{ + "shape":"NonEmptyString", + "documentation":"

    An end date for the date filter.

    " + }, + "DateRange":{ + "shape":"DateRange", + "documentation":"

    A date range for the date filter.

    " + } + }, + "documentation":"

    A date filter for querying findings.

    " + }, + "DateFilterList":{ + "type":"list", + "member":{"shape":"DateFilter"} + }, + "DateRange":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Integer", + "documentation":"

    A date range value for the date filter.

    " + }, + "Unit":{ + "shape":"DateRangeUnit", + "documentation":"

    A date range unit for the date filter.

    " + } + }, + "documentation":"

    A date range for the date filter.

    " + }, + "DateRangeUnit":{ + "type":"string", + "enum":["DAYS"] + }, + "DeclineInvitationsRequest":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    A list of account IDs that specify the accounts that invitations to Security Hub are declined from.

    " + } + } + }, + "DeclineInvitationsResponse":{ + "type":"structure", + "members":{ + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that weren't processed.

    " + } + } + }, + "DeleteActionTargetRequest":{ + "type":"structure", + "required":["ActionTargetArn"], + "members":{ + "ActionTargetArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the custom action target to delete.

    ", + "location":"uri", + "locationName":"ActionTargetArn" + } + } + }, + "DeleteActionTargetResponse":{ + "type":"structure", + "required":["ActionTargetArn"], + "members":{ + "ActionTargetArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the custom action target that was deleted.

    " + } + } + }, + "DeleteInsightRequest":{ + "type":"structure", + "required":["InsightArn"], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight to delete.

    ", + "location":"uri", + "locationName":"InsightArn" + } + } + }, + "DeleteInsightResponse":{ + "type":"structure", + "required":["InsightArn"], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight that was deleted.

    " + } + } + }, + "DeleteInvitationsRequest":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    A list of the account IDs that sent the invitations to delete.

    " + } + } + }, + "DeleteInvitationsResponse":{ + "type":"structure", + "members":{ + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that invitations weren't deleted for.

    " + } + } + }, + "DeleteMembersRequest":{ + "type":"structure", + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    A list of account IDs of the member accounts to delete.

    " + } + } + }, + "DeleteMembersResponse":{ + "type":"structure", + "members":{ + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that weren't deleted.

    " + } + } + }, + "DescribeActionTargetsRequest":{ + "type":"structure", + "members":{ + "ActionTargetArns":{ + "shape":"ArnList", + "documentation":"

    A list of custom action target ARNs for the custom action targets to retrieve.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return.

    " + } + } + }, + "DescribeActionTargetsResponse":{ + "type":"structure", + "required":["ActionTargets"], + "members":{ + "ActionTargets":{ + "shape":"ActionTargetList", + "documentation":"

    A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "DescribeHubRequest":{ + "type":"structure", + "members":{ + "HubArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the Hub resource to retrieve.

    ", + "location":"querystring", + "locationName":"HubArn" + } + } + }, + "DescribeHubResponse":{ + "type":"structure", + "members":{ + "HubArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the Hub resource retrieved.

    " + }, + "SubscribedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date and time when Security Hub was enabled in the account.

    " + } + } + }, + "DescribeProductsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    ", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return.

    ", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "DescribeProductsResponse":{ + "type":"structure", + "required":["Products"], + "members":{ + "Products":{ + "shape":"ProductsList", + "documentation":"

    A list of products, including details for each product.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "DisableImportFindingsForProductRequest":{ + "type":"structure", + "required":["ProductSubscriptionArn"], + "members":{ + "ProductSubscriptionArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the integrated product to disable the integration for.

    ", + "location":"uri", + "locationName":"ProductSubscriptionArn" + } + } + }, + "DisableImportFindingsForProductResponse":{ + "type":"structure", + "members":{ + } + }, + "DisableSecurityHubRequest":{ + "type":"structure", + "members":{ + } + }, + "DisableSecurityHubResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateFromMasterAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "DisassociateFromMasterAccountResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateMembersRequest":{ + "type":"structure", + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    The account IDs of the member accounts to disassociate from the master account.

    " + } + } + }, + "DisassociateMembersResponse":{ + "type":"structure", + "members":{ + } + }, + "Double":{"type":"double"}, + "EnableImportFindingsForProductRequest":{ + "type":"structure", + "required":["ProductArn"], + "members":{ + "ProductArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the product to enable the integration for.

    " + } + } + }, + "EnableImportFindingsForProductResponse":{ + "type":"structure", + "members":{ + "ProductSubscriptionArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of your subscription to the product to enable integrations for.

    " + } + } + }, + "EnableSecurityHubRequest":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

    The tags to add to the Hub resource when you enable Security Hub.

    " + } + } + }, + "EnableSecurityHubResponse":{ + "type":"structure", + "members":{ + } + }, + "FieldMap":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "GetEnabledStandardsRequest":{ + "type":"structure", + "members":{ + "StandardsSubscriptionArns":{ + "shape":"StandardsSubscriptionArns", + "documentation":"

    A list of the standards subscription ARNs for the standards to retrieve.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in the response.

    " + } + } + }, + "GetEnabledStandardsResponse":{ + "type":"structure", + "members":{ + "StandardsSubscriptions":{ + "shape":"StandardsSubscriptions", + "documentation":"

    A list of StandardsSubscriptions objects that include information about the enabled standards.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "GetFindingsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"AwsSecurityFindingFilters", + "documentation":"

    The findings attributes used to define a condition to filter the findings returned.

    " + }, + "SortCriteria":{ + "shape":"SortCriteria", + "documentation":"

    Findings attributes used to sort the list of findings returned.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. On your first call to the GetFindings operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of findings to return.

    " + } + } + }, + "GetFindingsResponse":{ + "type":"structure", + "required":["Findings"], + "members":{ + "Findings":{ + "shape":"AwsSecurityFindingList", + "documentation":"

    The findings that matched the filters specified in the request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "GetInsightResultsRequest":{ + "type":"structure", + "required":["InsightArn"], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight whose results you want to see.

    ", + "location":"uri", + "locationName":"InsightArn" + } + } + }, + "GetInsightResultsResponse":{ + "type":"structure", + "required":["InsightResults"], + "members":{ + "InsightResults":{ + "shape":"InsightResults", + "documentation":"

    The insight results returned by the operation.

    " + } + } + }, + "GetInsightsRequest":{ + "type":"structure", + "members":{ + "InsightArns":{ + "shape":"ArnList", + "documentation":"

    The ARNs of the insights that you want to describe.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. On your first call to the GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items that you want in the response.

    " + } + } + }, + "GetInsightsResponse":{ + "type":"structure", + "required":["Insights"], + "members":{ + "Insights":{ + "shape":"InsightList", + "documentation":"

    The insights returned by the operation.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "GetInvitationsCountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetInvitationsCountResponse":{ + "type":"structure", + "members":{ + "InvitationsCount":{ + "shape":"Integer", + "documentation":"

    The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.

    " + } + } + }, + "GetMasterAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "GetMasterAccountResponse":{ + "type":"structure", + "members":{ + "Master":{ + "shape":"Invitation", + "documentation":"

    A list of details about the Security Hub master account for the current member account.

    " + } + } + }, + "GetMembersRequest":{ + "type":"structure", + "required":["AccountIds"], + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    A list of account IDs for the Security Hub member accounts that you want to return the details for.

    " + } + } + }, + "GetMembersResponse":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"MemberList", + "documentation":"

    A list of details about the Security Hub member accounts.

    " + }, + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that couldn't be processed.

    " + } + } + }, + "ImportFindingsError":{ + "type":"structure", + "required":[ + "Id", + "ErrorCode", + "ErrorMessage" + ], + "members":{ + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The ID of the error made during the BatchImportFindings operation.

    " + }, + "ErrorCode":{ + "shape":"NonEmptyString", + "documentation":"

    The code of the error made during the BatchImportFindings operation.

    " + }, + "ErrorMessage":{ + "shape":"NonEmptyString", + "documentation":"

    The message of the error made during the BatchImportFindings operation.

    " + } + }, + "documentation":"

    Includes details of the list of the findings that can't be imported.

    " + }, + "ImportFindingsErrorList":{ + "type":"list", + "member":{"shape":"ImportFindingsError"} + }, + "Insight":{ + "type":"structure", + "required":[ + "InsightArn", + "Name", + "Filters", + "GroupByAttribute" + ], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of a Security Hub insight.

    " + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of a Security Hub insight.

    " + }, + "Filters":{ + "shape":"AwsSecurityFindingFilters", + "documentation":"

    One or more attributes used to filter the findings included in the insight. Only findings that match the criteria defined in the filters are included in the insight.

    " + }, + "GroupByAttribute":{ + "shape":"NonEmptyString", + "documentation":"

    The attribute that the insight's findings are grouped by. This attribute is used as a findings aggregator for the purposes of viewing and managing multiple related findings under a single operand.

    " + } + }, + "documentation":"

    Contains information about a Security Hub insight.

    " + }, + "InsightList":{ + "type":"list", + "member":{"shape":"Insight"} + }, + "InsightResultValue":{ + "type":"structure", + "required":[ + "GroupByAttributeValue", + "Count" + ], + "members":{ + "GroupByAttributeValue":{ + "shape":"NonEmptyString", + "documentation":"

    The value of the attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

    " + }, + "Count":{ + "shape":"Integer", + "documentation":"

    The number of findings returned for each GroupByAttributeValue.

    " + } + }, + "documentation":"

    The insight result values returned by the GetInsightResults operation.

    " + }, + "InsightResultValueList":{ + "type":"list", + "member":{"shape":"InsightResultValue"} + }, + "InsightResults":{ + "type":"structure", + "required":[ + "InsightArn", + "GroupByAttribute", + "ResultValues" + ], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight whose results are returned by the GetInsightResults operation.

    " + }, + "GroupByAttribute":{ + "shape":"NonEmptyString", + "documentation":"

    The attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.

    " + }, + "ResultValues":{ + "shape":"InsightResultValueList", + "documentation":"

    The list of insight result values returned by the GetInsightResults operation.

    " + } + }, + "documentation":"

    The insight results returned by the GetInsightResults operation.

    " + }, + "Integer":{"type":"integer"}, + "InternalException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    Internal server error.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidAccessException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    AWS Security Hub isn't enabled for the account used to make this request.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "InvalidInputException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Invitation":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The account ID of the Security Hub master account that the invitation was sent from.

    " + }, + "InvitationId":{ + "shape":"NonEmptyString", + "documentation":"

    The ID of the invitation sent to the member account.

    " + }, + "InvitedAt":{ + "shape":"Timestamp", + "documentation":"

    The timestamp of when the invitation was sent.

    " + }, + "MemberStatus":{ + "shape":"NonEmptyString", + "documentation":"

    The current status of the association between member and master accounts.

    " + } + }, + "documentation":"

    Details about an invitation.

    " + }, + "InvitationList":{ + "type":"list", + "member":{"shape":"Invitation"} + }, + "InviteMembersRequest":{ + "type":"structure", + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    A list of IDs of the AWS accounts that you want to invite to Security Hub as members.

    " + } + } + }, + "InviteMembersResponse":{ + "type":"structure", + "members":{ + "UnprocessedAccounts":{ + "shape":"ResultList", + "documentation":"

    A list of account ID and email address pairs of the AWS accounts that couldn't be processed.

    " + } + } + }, + "IpFilter":{ + "type":"structure", + "members":{ + "Cidr":{ + "shape":"NonEmptyString", + "documentation":"

    A finding's CIDR value.

    " + } + }, + "documentation":"

    The IP filter for querying findings.

    " + }, + "IpFilterList":{ + "type":"list", + "member":{"shape":"IpFilter"} + }, + "KeywordFilter":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"NonEmptyString", + "documentation":"

    A value for the keyword.

    " + } + }, + "documentation":"

    A keyword filter for querying findings.

    " + }, + "KeywordFilterList":{ + "type":"list", + "member":{"shape":"KeywordFilter"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ListEnabledProductsForImportRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

    ", + "location":"querystring", + "locationName":"NextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items that you want in the response.

    ", + "location":"querystring", + "locationName":"MaxResults" + } + } + }, + "ListEnabledProductsForImportResponse":{ + "type":"structure", + "members":{ + "ProductSubscriptions":{ + "shape":"ProductSubscriptionArnList", + "documentation":"

    A list of ARNs for the resources that represent your subscriptions to products.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "ListInvitationsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items that you want in the response.

    ", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. On your first call to the ListInvitations operation, set the value of this parameter to NULL. For subsequent calls to the operation, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

    ", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListInvitationsResponse":{ + "type":"structure", + "members":{ + "Invitations":{ + "shape":"InvitationList", + "documentation":"

    The details of the invitations returned by the operation.

    " + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "ListMembersRequest":{ + "type":"structure", + "members":{ + "OnlyAssociated":{ + "shape":"Boolean", + "documentation":"

    Specifies which member accounts the response includes based on their relationship status with the master account. The default value is TRUE. If onlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the master is set to ENABLED or DISABLED. If onlyAssociated is set to FALSE, the response includes all existing member accounts.

    ", + "location":"querystring", + "locationName":"OnlyAssociated" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items that you want in the response.

    ", + "location":"querystring", + "locationName":"MaxResults" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    Paginates results. Set the value of this parameter to NULL on your first call to the ListMembers operation. For subsequent calls to the operation, fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

    ", + "location":"querystring", + "locationName":"NextToken" + } + } + }, + "ListMembersResponse":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"MemberList", + "documentation":"

    Member details returned by the operation.

    " + }, + "NextToken":{ + "shape":"NonEmptyString", + "documentation":"

    The token that is required for pagination.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN of the resource to retrieve tags for.

    ", + "location":"uri", + "locationName":"ResourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

    The tags associated with a resource.

    " + } + } + }, + "Malware":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the malware that was observed.

    " + }, + "Type":{ + "shape":"MalwareType", + "documentation":"

    The type of the malware that was observed.

    " + }, + "Path":{ + "shape":"NonEmptyString", + "documentation":"

    The file system path of the malware that was observed.

    " + }, + "State":{ + "shape":"MalwareState", + "documentation":"

    The state of the malware that was observed.

    " + } + }, + "documentation":"

    A list of malware related to a finding.

    " + }, + "MalwareList":{ + "type":"list", + "member":{"shape":"Malware"} + }, + "MalwareState":{ + "type":"string", + "enum":[ + "OBSERVED", + "REMOVAL_FAILED", + "REMOVED" + ] + }, + "MalwareType":{ + "type":"string", + "enum":[ + "ADWARE", + "BLENDED_THREAT", + "BOTNET_AGENT", + "COIN_MINER", + "EXPLOIT_KIT", + "KEYLOGGER", + "MACRO", + "POTENTIALLY_UNWANTED", + "SPYWARE", + "RANSOMWARE", + "REMOTE_ACCESS", + "ROOTKIT", + "TROJAN", + "VIRUS", + "WORM" + ] + }, + "MapFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"NonEmptyString", + "documentation":"

    The key of the map filter.

    " + }, + "Value":{ + "shape":"NonEmptyString", + "documentation":"

    The value for the key in the map filter.

    " + }, + "Comparison":{ + "shape":"MapFilterComparison", + "documentation":"

    The condition to apply to a key value when querying for findings with a map filter.

    " + } + }, + "documentation":"

    The map filter for querying findings.

    " + }, + "MapFilterComparison":{ + "type":"string", + "enum":["EQUALS"] + }, + "MapFilterList":{ + "type":"list", + "member":{"shape":"MapFilter"} + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Member":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The AWS account ID of the member account.

    " + }, + "Email":{ + "shape":"NonEmptyString", + "documentation":"

    The email address of the member account.

    " + }, + "MasterId":{ + "shape":"NonEmptyString", + "documentation":"

    The AWS account ID of the Security Hub master account associated with this member account.

    " + }, + "MemberStatus":{ + "shape":"NonEmptyString", + "documentation":"

    The status of the relationship between the member account and its master account.

    " + }, + "InvitedAt":{ + "shape":"Timestamp", + "documentation":"

    A timestamp for the date and time when the invitation was sent to the member account.

    " + }, + "UpdatedAt":{ + "shape":"Timestamp", + "documentation":"

    The timestamp for the date and time when the member account was updated.

    " + } + }, + "documentation":"

    The details about a member account.

    " + }, + "MemberList":{ + "type":"list", + "member":{"shape":"Member"} + }, + "Network":{ + "type":"structure", + "members":{ + "Direction":{ + "shape":"NetworkDirection", + "documentation":"

    The direction of network traffic associated with a finding.

    " + }, + "Protocol":{ + "shape":"NonEmptyString", + "documentation":"

    The protocol of network-related information about a finding.

    " + }, + "SourceIpV4":{ + "shape":"NonEmptyString", + "documentation":"

    The source IPv4 address of network-related information about a finding.

    " + }, + "SourceIpV6":{ + "shape":"NonEmptyString", + "documentation":"

    The source IPv6 address of network-related information about a finding.

    " + }, + "SourcePort":{ + "shape":"Integer", + "documentation":"

    The source port of network-related information about a finding.

    " + }, + "SourceDomain":{ + "shape":"NonEmptyString", + "documentation":"

    The source domain of network-related information about a finding.

    " + }, + "SourceMac":{ + "shape":"NonEmptyString", + "documentation":"

    The source media access control (MAC) address of network-related information about a finding.

    " + }, + "DestinationIpV4":{ + "shape":"NonEmptyString", + "documentation":"

    The destination IPv4 address of network-related information about a finding.

    " + }, + "DestinationIpV6":{ + "shape":"NonEmptyString", + "documentation":"

    The destination IPv6 address of network-related information about a finding.

    " + }, + "DestinationPort":{ + "shape":"Integer", + "documentation":"

    The destination port of network-related information about a finding.

    " + }, + "DestinationDomain":{ + "shape":"NonEmptyString", + "documentation":"

    The destination domain of network-related information about a finding.

    " + } + }, + "documentation":"

    The details of network-related information about a finding.

    " + }, + "NetworkDirection":{ + "type":"string", + "enum":[ + "IN", + "OUT" + ] + }, + "NextToken":{"type":"string"}, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "Note":{ + "type":"structure", + "required":[ + "Text", + "UpdatedBy", + "UpdatedAt" + ], + "members":{ + "Text":{ + "shape":"NonEmptyString", + "documentation":"

    The text of a note.

    " + }, + "UpdatedBy":{ + "shape":"NonEmptyString", + "documentation":"

    The principal that created a note.

    " + }, + "UpdatedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The timestamp of when the note was updated.

    " + } + }, + "documentation":"

    A user-defined note added to a finding.

    " + }, + "NoteUpdate":{ + "type":"structure", + "required":[ + "Text", + "UpdatedBy" + ], + "members":{ + "Text":{ + "shape":"NonEmptyString", + "documentation":"

    The updated note text.

    " + }, + "UpdatedBy":{ + "shape":"NonEmptyString", + "documentation":"

    The principal that updated the note.

    " + } + }, + "documentation":"

    The updated note.

    " + }, + "NumberFilter":{ + "type":"structure", + "members":{ + "Gte":{ + "shape":"Double", + "documentation":"

    The greater-than-equal condition to be applied to a single field when querying for findings.

    " + }, + "Lte":{ + "shape":"Double", + "documentation":"

    The less-than-equal condition to be applied to a single field when querying for findings.

    " + }, + "Eq":{ + "shape":"Double", + "documentation":"

    The equal-to condition to be applied to a single field when querying for findings.

    " + } + }, + "documentation":"

    A number filter for querying findings.

    " + }, + "NumberFilterList":{ + "type":"list", + "member":{"shape":"NumberFilter"} + }, + "Partition":{ + "type":"string", + "enum":[ + "aws", + "aws-cn", + "aws-us-gov" + ] + }, + "ProcessDetails":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the process.

    " + }, + "Path":{ + "shape":"NonEmptyString", + "documentation":"

    The path to the process executable.

    " + }, + "Pid":{ + "shape":"Integer", + "documentation":"

    The process ID.

    " + }, + "ParentPid":{ + "shape":"Integer", + "documentation":"

    The parent process ID.

    " + }, + "LaunchedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date/time that the process was launched.

    " + }, + "TerminatedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date and time when the process was terminated.

    " + } + }, + "documentation":"

    The details of process-related information about a finding.

    " + }, + "Product":{ + "type":"structure", + "required":["ProductArn"], + "members":{ + "ProductArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN assigned to the product.

    " + }, + "ProductName":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the product.

    " + }, + "CompanyName":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the company that provides the product.

    " + }, + "Description":{ + "shape":"NonEmptyString", + "documentation":"

    A description of the product.

    " + }, + "Categories":{ + "shape":"CategoryList", + "documentation":"

    The categories assigned to the product.

    " + }, + "MarketplaceUrl":{ + "shape":"NonEmptyString", + "documentation":"

    The URL for the page that contains more information about the product.

    " + }, + "ActivationUrl":{ + "shape":"NonEmptyString", + "documentation":"

    The URL used to activate the product.

    " + }, + "ProductSubscriptionResourcePolicy":{ + "shape":"NonEmptyString", + "documentation":"

    The resource policy associated with the product.

    " + } + }, + "documentation":"

    Contains details about a product.

    " + }, + "ProductSubscriptionArnList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "ProductsList":{ + "type":"list", + "member":{"shape":"Product"} + }, + "Recommendation":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"NonEmptyString", + "documentation":"

    Describes the recommended steps to take to remediate an issue identified in a finding.

    " + }, + "Url":{ + "shape":"NonEmptyString", + "documentation":"

    A URL to a page or site that contains information about how to remediate a finding.

    " + } + }, + "documentation":"

    A recommendation on how to remediate the issue identified in a finding.

    " + }, + "RecordState":{ + "type":"string", + "enum":[ + "ACTIVE", + "ARCHIVED" + ] + }, + "RelatedFinding":{ + "type":"structure", + "required":[ + "ProductArn", + "Id" + ], + "members":{ + "ProductArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the product that generated a related finding.

    " + }, + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The product-generated identifier for a related finding.

    " + } + }, + "documentation":"

    Details about a related finding.

    " + }, + "RelatedFindingList":{ + "type":"list", + "member":{"shape":"RelatedFinding"} + }, + "Remediation":{ + "type":"structure", + "members":{ + "Recommendation":{ + "shape":"Recommendation", + "documentation":"

    A recommendation on the steps to take to remediate the issue identified by a finding.

    " + } + }, + "documentation":"

    Details about the remediation steps for a finding.

    " + }, + "Resource":{ + "type":"structure", + "required":[ + "Type", + "Id" + ], + "members":{ + "Type":{ + "shape":"NonEmptyString", + "documentation":"

    The type of the resource that details are provided for.

    " + }, + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The canonical identifier for the given resource type.

    " + }, + "Partition":{ + "shape":"Partition", + "documentation":"

    The canonical AWS partition name that the Region is assigned to.

    " + }, + "Region":{ + "shape":"NonEmptyString", + "documentation":"

    The canonical AWS external Region name where this resource is located.

    " + }, + "Tags":{ + "shape":"FieldMap", + "documentation":"

    A list of AWS tags associated with a resource at the time the finding was processed.

    " + }, + "Details":{ + "shape":"ResourceDetails", + "documentation":"

    Additional details about the resource related to a finding.

    " + } + }, + "documentation":"

    A resource related to a finding.

    " + }, + "ResourceArn":{ + "type":"string", + "pattern":"^arn:aws:securityhub:.*" + }, + "ResourceConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    The resource specified in the request conflicts with an existing resource.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceDetails":{ + "type":"structure", + "members":{ + "AwsEc2Instance":{ + "shape":"AwsEc2InstanceDetails", + "documentation":"

    Details about an Amazon EC2 instance related to a finding.

    " + }, + "AwsS3Bucket":{ + "shape":"AwsS3BucketDetails", + "documentation":"

    Details about an Amazon S3 Bucket related to a finding.

    " + }, + "AwsIamAccessKey":{ + "shape":"AwsIamAccessKeyDetails", + "documentation":"

    Details about an IAM access key related to a finding.

    " + }, + "Container":{ + "shape":"ContainerDetails", + "documentation":"

    Details about a container resource related to a finding.

    " + }, + "Other":{ + "shape":"FieldMap", + "documentation":"

    Details about a resource that doesn't have a specific type defined.

    " + } + }, + "documentation":"

    Additional details about a resource related to a finding.

    " + }, + "ResourceList":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"NonEmptyString"}, + "Code":{"shape":"NonEmptyString"} + }, + "documentation":"

    The request was rejected because we can't find the specified resource.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "Result":{ + "type":"structure", + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

    An AWS account ID of the account that wasn't be processed.

    " + }, + "ProcessingResult":{ + "shape":"NonEmptyString", + "documentation":"

    The reason that the account wasn't be processed.

    " + } + }, + "documentation":"

    Details about the account that wasn't processed.

    " + }, + "ResultList":{ + "type":"list", + "member":{"shape":"Result"} + }, + "Severity":{ + "type":"structure", + "required":["Normalized"], + "members":{ + "Product":{ + "shape":"Double", + "documentation":"

    The native severity as defined by the AWS service or integrated partner product that generated the finding.

    " + }, + "Normalized":{ + "shape":"Integer", + "documentation":"

    The normalized severity of a finding.

    " + } + }, + "documentation":"

    The severity of the finding.

    " + }, + "SortCriteria":{ + "type":"list", + "member":{"shape":"SortCriterion"} + }, + "SortCriterion":{ + "type":"structure", + "members":{ + "Field":{ + "shape":"NonEmptyString", + "documentation":"

    The finding attribute used to sort findings.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The order used to sort findings.

    " + } + }, + "documentation":"

    A collection of finding attributes used to sort findings.

    " + }, + "SortOrder":{ + "type":"string", + "enum":[ + "asc", + "desc" + ] + }, + "StandardsInputParameterMap":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "StandardsStatus":{ + "type":"string", + "enum":[ + "PENDING", + "READY", + "FAILED", + "DELETING", + "INCOMPLETE" + ] + }, + "StandardsSubscription":{ + "type":"structure", + "required":[ + "StandardsSubscriptionArn", + "StandardsArn", + "StandardsInput", + "StandardsStatus" + ], + "members":{ + "StandardsSubscriptionArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of a resource that represents your subscription to a supported standard.

    " + }, + "StandardsArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of a standard.

    In this release, Security Hub supports only the CIS AWS Foundations standard, which uses the following ARN: arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

    " + }, + "StandardsInput":{ + "shape":"StandardsInputParameterMap", + "documentation":"

    A key-value pair of input for the standard.

    " + }, + "StandardsStatus":{ + "shape":"StandardsStatus", + "documentation":"

    The status of the standards subscription.

    " + } + }, + "documentation":"

    A resource that represents your subscription to a supported standard.

    " + }, + "StandardsSubscriptionArns":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":25, + "min":1 + }, + "StandardsSubscriptionRequest":{ + "type":"structure", + "required":["StandardsArn"], + "members":{ + "StandardsArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the standard that you want to enable.

    In this release, Security Hub only supports the CIS AWS Foundations standard.

    Its ARN is arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0.

    " + }, + "StandardsInput":{ + "shape":"StandardsInputParameterMap", + "documentation":"

    A key-value pair of input for the standard.

    " + } + }, + "documentation":"

    The standard that you want to enable.

    " + }, + "StandardsSubscriptionRequests":{ + "type":"list", + "member":{"shape":"StandardsSubscriptionRequest"}, + "max":25, + "min":1 + }, + "StandardsSubscriptions":{ + "type":"list", + "member":{"shape":"StandardsSubscription"} + }, + "StringFilter":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"NonEmptyString", + "documentation":"

    The string filter value.

    " + }, + "Comparison":{ + "shape":"StringFilterComparison", + "documentation":"

    The condition to be applied to a string value when querying for findings.

    " + } + }, + "documentation":"

    A string filter for querying findings.

    " + }, + "StringFilterComparison":{ + "type":"string", + "enum":[ + "EQUALS", + "PREFIX" + ] + }, + "StringFilterList":{ + "type":"list", + "member":{"shape":"StringFilter"} + }, + "StringList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN of the resource to apply the tags to.

    ", + "location":"uri", + "locationName":"ResourceArn" + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

    The tags to add to the resource.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "ThreatIntelIndicator":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ThreatIntelIndicatorType", + "documentation":"

    The type of a threat intel indicator.

    " + }, + "Value":{ + "shape":"NonEmptyString", + "documentation":"

    The value of a threat intel indicator.

    " + }, + "Category":{ + "shape":"ThreatIntelIndicatorCategory", + "documentation":"

    The category of a threat intel indicator.

    " + }, + "LastObservedAt":{ + "shape":"NonEmptyString", + "documentation":"

    The date and time when the most recent instance of a threat intel indicator was observed.

    " + }, + "Source":{ + "shape":"NonEmptyString", + "documentation":"

    The source of the threat intel indicator.

    " + }, + "SourceUrl":{ + "shape":"NonEmptyString", + "documentation":"

    The URL to the page or site where you can get more information about the threat intel indicator.

    " + } + }, + "documentation":"

    Details about the threat intel related to a finding.

    " + }, + "ThreatIntelIndicatorCategory":{ + "type":"string", + "enum":[ + "BACKDOOR", + "CARD_STEALER", + "COMMAND_AND_CONTROL", + "DROP_SITE", + "EXPLOIT_SITE", + "KEYLOGGER" + ] + }, + "ThreatIntelIndicatorList":{ + "type":"list", + "member":{"shape":"ThreatIntelIndicator"} + }, + "ThreatIntelIndicatorType":{ + "type":"string", + "enum":[ + "DOMAIN", + "EMAIL_ADDRESS", + "HASH_MD5", + "HASH_SHA1", + "HASH_SHA256", + "HASH_SHA512", + "IPV4_ADDRESS", + "IPV6_ADDRESS", + "MUTEX", + "PROCESS", + "URL" + ] + }, + "Timestamp":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, + "TypeList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN of the resource to remove the tags from.

    ", + "location":"uri", + "locationName":"ResourceArn" + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tag keys associated with the tags to remove from the resource.

    ", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateActionTargetRequest":{ + "type":"structure", + "required":["ActionTargetArn"], + "members":{ + "ActionTargetArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the custom action target to update.

    ", + "location":"uri", + "locationName":"ActionTargetArn" + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The updated name of the custom action target.

    " + }, + "Description":{ + "shape":"NonEmptyString", + "documentation":"

    The updated description for the custom action target.

    " + } + } + }, + "UpdateActionTargetResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateFindingsRequest":{ + "type":"structure", + "required":["Filters"], + "members":{ + "Filters":{ + "shape":"AwsSecurityFindingFilters", + "documentation":"

    A collection of attributes that specify which findings you want to update.

    " + }, + "Note":{ + "shape":"NoteUpdate", + "documentation":"

    The updated note for the finding.

    " + }, + "RecordState":{ + "shape":"RecordState", + "documentation":"

    The updated record state for the finding.

    " + } + } + }, + "UpdateFindingsResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateInsightRequest":{ + "type":"structure", + "required":["InsightArn"], + "members":{ + "InsightArn":{ + "shape":"NonEmptyString", + "documentation":"

    The ARN of the insight that you want to update.

    ", + "location":"uri", + "locationName":"InsightArn" + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The updated name for the insight.

    " + }, + "Filters":{ + "shape":"AwsSecurityFindingFilters", + "documentation":"

    The updated filters that define this insight.

    " + }, + "GroupByAttribute":{ + "shape":"NonEmptyString", + "documentation":"

    The updated GroupBy attribute that defines this insight.

    " + } + } + }, + "UpdateInsightResponse":{ + "type":"structure", + "members":{ + } + }, + "VerificationState":{ + "type":"string", + "enum":[ + "UNKNOWN", + "TRUE_POSITIVE", + "FALSE_POSITIVE", + "BENIGN_POSITIVE" + ] + }, + "WorkflowState":{ + "type":"string", + "enum":[ + "NEW", + "ASSIGNED", + "IN_PROGRESS", + "DEFERRED", + "RESOLVED" + ] + } + }, + "documentation":"

    Security Hub provides you with a comprehensive view of the security state of your AWS environment and resources. It also provides you with the compliance status of your environment based on CIS AWS Foundations compliance checks. Security Hub collects security data from AWS accounts, services, and integrated third-party products and helps you analyze security trends in your environment to identify the highest priority security issues. For more information about Security Hub, see the AWS Security Hub User Guide .

    When you use operations in the Security Hub API, the requests are executed only in the AWS Region that is currently active or in the specific AWS Region that you specify in your request. Any configuration or settings change that results from the operation is applied only to that Region. To make the same change in other Regions, execute the same command for each Region to apply the change to. For example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of the member account with the master account is created only in the us-west-2 Region. Security Hub must be enabled for the member account in the same Region that the invite was sent from.

    " +} diff --git a/aws/dist/botocore/data/serverlessrepo/2017-09-08/paginators-1.json b/aws/dist/botocore/data/serverlessrepo/2017-09-08/paginators-1.json new file mode 100644 index 00000000..a39e5477 --- /dev/null +++ b/aws/dist/botocore/data/serverlessrepo/2017-09-08/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListApplicationDependencies": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "Dependencies" + }, + "ListApplicationVersions": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "Versions" + }, + "ListApplications": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "Applications" + } + } +} diff --git a/aws/dist/botocore/data/serverlessrepo/2017-09-08/service-2.json b/aws/dist/botocore/data/serverlessrepo/2017-09-08/service-2.json new file mode 100644 index 00000000..6158adc7 --- /dev/null +++ b/aws/dist/botocore/data/serverlessrepo/2017-09-08/service-2.json @@ -0,0 +1,2146 @@ +{ + "metadata" : { + "apiVersion" : "2017-09-08", + "endpointPrefix" : "serverlessrepo", + "signingName" : "serverlessrepo", + "serviceFullName" : "AWSServerlessApplicationRepository", + "serviceId" : "ServerlessApplicationRepository", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "serverlessrepo-2017-09-08", + "signatureVersion" : "v4" + }, + "operations" : { + "CreateApplication" : { + "name" : "CreateApplication", + "http" : { + "method" : "POST", + "requestUri" : "/applications", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateApplicationRequest" + }, + "output" : { + "shape" : "CreateApplicationResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ConflictException", + "documentation" : "

    The resource already exists.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Creates an application, optionally including an AWS SAM file to create the first application version in the same call.

    " + }, + "CreateApplicationVersion" : { + "name" : "CreateApplicationVersion", + "http" : { + "method" : "PUT", + "requestUri" : "/applications/{applicationId}/versions/{semanticVersion}", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateApplicationVersionRequest" + }, + "output" : { + "shape" : "CreateApplicationVersionResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ConflictException", + "documentation" : "

    The resource already exists.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Creates an application version.

    " + }, + "CreateCloudFormationChangeSet" : { + "name" : "CreateCloudFormationChangeSet", + "http" : { + "method" : "POST", + "requestUri" : "/applications/{applicationId}/changesets", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateCloudFormationChangeSetRequest" + }, + "output" : { + "shape" : "CreateCloudFormationChangeSetResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Creates an AWS CloudFormation change set for the given application.

    " + }, + "CreateCloudFormationTemplate" : { + "name" : "CreateCloudFormationTemplate", + "http" : { + "method" : "POST", + "requestUri" : "/applications/{applicationId}/templates", + "responseCode" : 201 + }, + "input" : { + "shape" : "CreateCloudFormationTemplateRequest" + }, + "output" : { + "shape" : "CreateCloudFormationTemplateResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Creates an AWS CloudFormation template.

    " + }, + "DeleteApplication" : { + "name" : "DeleteApplication", + "http" : { + "method" : "DELETE", + "requestUri" : "/applications/{applicationId}", + "responseCode" : 204 + }, + "input" : { + "shape" : "DeleteApplicationRequest" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + }, { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "ConflictException", + "documentation" : "

    The resource already exists.

    " + } ], + "documentation" : "

    Deletes the specified application.

    " + }, + "GetApplication" : { + "name" : "GetApplication", + "http" : { + "method" : "GET", + "requestUri" : "/applications/{applicationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApplicationRequest" + }, + "output" : { + "shape" : "GetApplicationResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Gets the specified application.

    " + }, + "GetApplicationPolicy" : { + "name" : "GetApplicationPolicy", + "http" : { + "method" : "GET", + "requestUri" : "/applications/{applicationId}/policy", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetApplicationPolicyRequest" + }, + "output" : { + "shape" : "GetApplicationPolicyResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Retrieves the policy for the application.

    " + }, + "GetCloudFormationTemplate" : { + "name" : "GetCloudFormationTemplate", + "http" : { + "method" : "GET", + "requestUri" : "/applications/{applicationId}/templates/{templateId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetCloudFormationTemplateRequest" + }, + "output" : { + "shape" : "GetCloudFormationTemplateResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Gets the specified AWS CloudFormation template.

    " + }, + "ListApplicationDependencies" : { + "name" : "ListApplicationDependencies", + "http" : { + "method" : "GET", + "requestUri" : "/applications/{applicationId}/dependencies", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListApplicationDependenciesRequest" + }, + "output" : { + "shape" : "ListApplicationDependenciesResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Retrieves the list of applications nested in the containing application.

    " + }, + "ListApplicationVersions" : { + "name" : "ListApplicationVersions", + "http" : { + "method" : "GET", + "requestUri" : "/applications/{applicationId}/versions", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListApplicationVersionsRequest" + }, + "output" : { + "shape" : "ListApplicationVersionsResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Lists versions for the specified application.

    " + }, + "ListApplications" : { + "name" : "ListApplications", + "http" : { + "method" : "GET", + "requestUri" : "/applications", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListApplicationsRequest" + }, + "output" : { + "shape" : "ListApplicationsResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Lists applications owned by the requester.

    " + }, + "PutApplicationPolicy" : { + "name" : "PutApplicationPolicy", + "http" : { + "method" : "PUT", + "requestUri" : "/applications/{applicationId}/policy", + "responseCode" : 200 + }, + "input" : { + "shape" : "PutApplicationPolicyRequest" + }, + "output" : { + "shape" : "PutApplicationPolicyResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + } ], + "documentation" : "

    Sets the permission policy for an application. For the list of actions supported for this operation, see\n Application \n Permissions\n .

    " + }, + "UpdateApplication" : { + "name" : "UpdateApplication", + "http" : { + "method" : "PATCH", + "requestUri" : "/applications/{applicationId}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateApplicationRequest" + }, + "output" : { + "shape" : "UpdateApplicationResponse", + "documentation" : "

    Success

    " + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "

    One of the parameters in the request is invalid.

    " + }, { + "shape" : "InternalServerErrorException", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + }, { + "shape" : "ForbiddenException", + "documentation" : "

    The client is not authenticated.

    " + }, { + "shape" : "NotFoundException", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + }, { + "shape" : "TooManyRequestsException", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + }, { + "shape" : "ConflictException", + "documentation" : "

    The resource already exists.

    " + } ], + "documentation" : "

    Updates the specified application.

    " + } + }, + "shapes" : { + "Application" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "Version" : { + "shape" : "Version", + "locationName" : "version", + "documentation" : "

    Version information about the application.

    " + } + }, + "documentation" : "

    Details about the application.

    ", + "required" : [ "Description", "Author", "ApplicationId", "Name" ] + }, + "ApplicationDependencyPage" : { + "type" : "structure", + "members" : { + "Dependencies" : { + "shape" : "__listOfApplicationDependencySummary", + "locationName" : "dependencies", + "documentation" : "

    An array of application summaries nested in the application.

    " + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + } + }, + "documentation" : "

    A list of application summaries nested in the application.

    ", + "required" : [ "Dependencies" ] + }, + "ApplicationDependencySummary" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the nested application.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the nested application.

    " + } + }, + "documentation" : "

    A nested application summary.

    ", + "required" : [ "ApplicationId", "SemanticVersion" ] + }, + "ApplicationPage" : { + "type" : "structure", + "members" : { + "Applications" : { + "shape" : "__listOfApplicationSummary", + "locationName" : "applications", + "documentation" : "

    An array of application summaries.

    " + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + } + }, + "documentation" : "

    A list of application details.

    ", + "required" : [ "Applications" ] + }, + "ApplicationPolicy" : { + "type" : "structure", + "members" : { + "Statements" : { + "shape" : "__listOfApplicationPolicyStatement", + "locationName" : "statements", + "documentation" : "

    An array of policy statements applied to the application.

    " + } + }, + "documentation" : "

    Policy statements applied to the application.

    ", + "required" : [ "Statements" ] + }, + "ApplicationPolicyStatement" : { + "type" : "structure", + "members" : { + "Actions" : { + "shape" : "__listOf__string", + "locationName" : "actions", + "documentation" : "

    For the list of actions supported for this operation, see Application \n Permissions.

    " + }, + "Principals" : { + "shape" : "__listOf__string", + "locationName" : "principals", + "documentation" : "

    An array of AWS account IDs, or * to make the application public.

    " + }, + "StatementId" : { + "shape" : "__string", + "locationName" : "statementId", + "documentation" : "

    A unique ID for the statement.

    " + } + }, + "documentation" : "

    Policy statement applied to the application.

    ", + "required" : [ "Principals", "Actions" ] + }, + "ApplicationSummary" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + } + }, + "documentation" : "

    Summary of details about the application.

    ", + "required" : [ "Description", "Author", "ApplicationId", "Name" ] + }, + "ApplicationVersionPage" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + }, + "Versions" : { + "shape" : "__listOfVersionSummary", + "locationName" : "versions", + "documentation" : "

    An array of version summaries for the application.

    " + } + }, + "documentation" : "

    A list of version summaries for the application.

    ", + "required" : [ "Versions" ] + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    400

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    One of the parameters in the request is invalid.

    " + } + }, + "documentation" : "

    One of the parameters in the request is invalid.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "Capability" : { + "type" : "string", + "documentation" : "

    Values that must be specified in order to deploy some applications.

    ", + "enum" : [ "CAPABILITY_IAM", "CAPABILITY_NAMED_IAM", "CAPABILITY_AUTO_EXPAND", "CAPABILITY_RESOURCE_POLICY" ] + }, + "ChangeSetDetails" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "ChangeSetId" : { + "shape" : "__string", + "locationName" : "changeSetId", + "documentation" : "

    The Amazon Resource Name (ARN) of the change set.

    Length constraints: Minimum length of 1.

    Pattern: ARN:[-a-zA-Z0-9:/]*

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "StackId" : { + "shape" : "__string", + "locationName" : "stackId", + "documentation" : "

    The unique ID of the stack.

    " + } + }, + "documentation" : "

    Details of the change set.

    ", + "required" : [ "ChangeSetId", "ApplicationId", "StackId", "SemanticVersion" ] + }, + "ConflictException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    409

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    The resource already exists.

    " + } + }, + "documentation" : "

    The resource already exists.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "CreateApplicationInput" : { + "type" : "structure", + "members" : { + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseBody" : { + "shape" : "__string", + "locationName" : "licenseBody", + "documentation" : "

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeBody" : { + "shape" : "__string", + "locationName" : "readmeBody", + "documentation" : "

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "TemplateBody" : { + "shape" : "__string", + "locationName" : "templateBody", + "documentation" : "

    The local raw packaged AWS SAM template file of your application.\n The file has the format file://<path>/<filename>.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the S3 object containing the packaged AWS SAM template of your application.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    " + } + }, + "documentation" : "

    Create an application request.

    ", + "required" : [ "Description", "Name", "Author" ] + }, + "CreateApplicationRequest" : { + "type" : "structure", + "members" : { + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseBody" : { + "shape" : "__string", + "locationName" : "licenseBody", + "documentation" : "

    A local text file that contains the license of the app that matches the spdxLicenseID value of your application.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to the S3 object that contains the license of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    You can specify only one of licenseBody and licenseUrl; otherwise, an error results.

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application that you want to publish.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeBody" : { + "shape" : "__string", + "locationName" : "readmeBody", + "documentation" : "

    A local text readme file in Markdown language that contains a more detailed description of the application and how it works.\n The file has the format file://<path>/<filename>.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the S3 object in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    You can specify only one of readmeBody and readmeUrl; otherwise, an error results.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "TemplateBody" : { + "shape" : "__string", + "locationName" : "templateBody", + "documentation" : "

    The local raw packaged AWS SAM template file of your application.\n The file has the format file://<path>/<filename>.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the S3 object containing the packaged AWS SAM template of your application.

    You can specify only one of templateBody and templateUrl; otherwise an error results.

    " + } + }, + "required" : [ "Description", "Name", "Author" ] + }, + "CreateApplicationResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "Version" : { + "shape" : "Version", + "locationName" : "version", + "documentation" : "

    Version information about the application.

    " + } + } + }, + "CreateApplicationVersionInput" : { + "type" : "structure", + "members" : { + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "TemplateBody" : { + "shape" : "__string", + "locationName" : "templateBody", + "documentation" : "

    The raw packaged AWS SAM template of your application.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the packaged AWS SAM template of your application.

    " + } + }, + "documentation" : "

    Create a version request.

    " + }, + "CreateApplicationVersionRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the new version.

    " + }, + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "TemplateBody" : { + "shape" : "__string", + "locationName" : "templateBody", + "documentation" : "

    The raw packaged AWS SAM template of your application.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the packaged AWS SAM template of your application.

    " + } + }, + "required" : [ "ApplicationId", "SemanticVersion" ] + }, + "CreateApplicationVersionResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "ParameterDefinitions" : { + "shape" : "__listOfParameterDefinition", + "locationName" : "parameterDefinitions", + "documentation" : "

    An array of parameter types supported by the application.

    " + }, + "RequiredCapabilities" : { + "shape" : "__listOfCapability", + "locationName" : "requiredCapabilities", + "documentation" : "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS::TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    " + }, + "ResourcesSupported" : { + "shape" : "__boolean", + "locationName" : "resourcesSupported", + "documentation" : "

    Whether all of the AWS resources contained in this application are supported in the region\n in which it is being retrieved.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the packaged AWS SAM template of your application.

    " + } + } + }, + "CreateCloudFormationChangeSetInput" : { + "type" : "structure", + "members" : { + "Capabilities" : { + "shape" : "__listOf__string", + "locationName" : "capabilities", + "documentation" : "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS:TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    " + }, + "ChangeSetName" : { + "shape" : "__string", + "locationName" : "changeSetName", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "ClientToken" : { + "shape" : "__string", + "locationName" : "clientToken", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "NotificationArns" : { + "shape" : "__listOf__string", + "locationName" : "notificationArns", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "ParameterOverrides" : { + "shape" : "__listOfParameterValue", + "locationName" : "parameterOverrides", + "documentation" : "

    A list of parameter values for the parameters of the application.

    " + }, + "ResourceTypes" : { + "shape" : "__listOf__string", + "locationName" : "resourceTypes", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "RollbackConfiguration" : { + "shape" : "RollbackConfiguration", + "locationName" : "rollbackConfiguration", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "StackName" : { + "shape" : "__string", + "locationName" : "stackName", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "Tags" : { + "shape" : "__listOfTag", + "locationName" : "tags", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "TemplateId" : { + "shape" : "__string", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + } + }, + "documentation" : "

    Create an application change set request.

    ", + "required" : [ "StackName" ] + }, + "CreateCloudFormationChangeSetRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "Capabilities" : { + "shape" : "__listOf__string", + "locationName" : "capabilities", + "documentation" : "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS:TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    " + }, + "ChangeSetName" : { + "shape" : "__string", + "locationName" : "changeSetName", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "ClientToken" : { + "shape" : "__string", + "locationName" : "clientToken", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "NotificationArns" : { + "shape" : "__listOf__string", + "locationName" : "notificationArns", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "ParameterOverrides" : { + "shape" : "__listOfParameterValue", + "locationName" : "parameterOverrides", + "documentation" : "

    A list of parameter values for the parameters of the application.

    " + }, + "ResourceTypes" : { + "shape" : "__listOf__string", + "locationName" : "resourceTypes", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "RollbackConfiguration" : { + "shape" : "RollbackConfiguration", + "locationName" : "rollbackConfiguration", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "StackName" : { + "shape" : "__string", + "locationName" : "stackName", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "Tags" : { + "shape" : "__listOfTag", + "locationName" : "tags", + "documentation" : "

    This property corresponds to the parameter of the same name for the AWS CloudFormation CreateChangeSet\n API.

    " + }, + "TemplateId" : { + "shape" : "__string", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + } + }, + "required" : [ "ApplicationId", "StackName" ] + }, + "CreateCloudFormationChangeSetResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "ChangeSetId" : { + "shape" : "__string", + "locationName" : "changeSetId", + "documentation" : "

    The Amazon Resource Name (ARN) of the change set.

    Length constraints: Minimum length of 1.

    Pattern: ARN:[-a-zA-Z0-9:/]*

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "StackId" : { + "shape" : "__string", + "locationName" : "stackId", + "documentation" : "

    The unique ID of the stack.

    " + } + } + }, + "CreateCloudFormationTemplateRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "CreateCloudFormationTemplateResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "ExpirationTime" : { + "shape" : "__string", + "locationName" : "expirationTime", + "documentation" : "

    The date and time this template expires. Templates\n expire 1 hour after creation.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "Status" : { + "shape" : "Status", + "locationName" : "status", + "documentation" : "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    " + }, + "TemplateId" : { + "shape" : "__string", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the template that can be used to deploy the application using\n AWS CloudFormation.

    " + } + } + }, + "DeleteApplicationRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "ForbiddenException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    403

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    The client is not authenticated.

    " + } + }, + "documentation" : "

    The client is not authenticated.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 403 + } + }, + "GetApplicationPolicyRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "GetApplicationPolicyResponse" : { + "type" : "structure", + "members" : { + "Statements" : { + "shape" : "__listOfApplicationPolicyStatement", + "locationName" : "statements", + "documentation" : "

    An array of policy statements applied to the application.

    " + } + } + }, + "GetApplicationRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application to get.

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "GetApplicationResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "Version" : { + "shape" : "Version", + "locationName" : "version", + "documentation" : "

    Version information about the application.

    " + } + } + }, + "GetCloudFormationTemplateRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "TemplateId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + } + }, + "required" : [ "ApplicationId", "TemplateId" ] + }, + "GetCloudFormationTemplateResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "ExpirationTime" : { + "shape" : "__string", + "locationName" : "expirationTime", + "documentation" : "

    The date and time this template expires. Templates\n expire 1 hour after creation.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "Status" : { + "shape" : "Status", + "locationName" : "status", + "documentation" : "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    " + }, + "TemplateId" : { + "shape" : "__string", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the template that can be used to deploy the application using\n AWS CloudFormation.

    " + } + } + }, + "InternalServerErrorException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    500

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    " + } + }, + "documentation" : "

    The AWS Serverless Application Repository service encountered an internal error.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "ListApplicationDependenciesRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "MaxItems" : { + "shape" : "MaxItems", + "location" : "querystring", + "locationName" : "maxItems", + "documentation" : "

    The total number of items to return.

    " + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

    A token to specify where to start paginating.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application to get.

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "ListApplicationDependenciesResponse" : { + "type" : "structure", + "members" : { + "Dependencies" : { + "shape" : "__listOfApplicationDependencySummary", + "locationName" : "dependencies", + "documentation" : "

    An array of application summaries nested in the application.

    " + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + } + } + }, + "ListApplicationVersionsRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "MaxItems" : { + "shape" : "MaxItems", + "location" : "querystring", + "locationName" : "maxItems", + "documentation" : "

    The total number of items to return.

    " + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

    A token to specify where to start paginating.

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "ListApplicationVersionsResponse" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + }, + "Versions" : { + "shape" : "__listOfVersionSummary", + "locationName" : "versions", + "documentation" : "

    An array of version summaries for the application.

    " + } + } + }, + "ListApplicationsRequest" : { + "type" : "structure", + "members" : { + "MaxItems" : { + "shape" : "MaxItems", + "location" : "querystring", + "locationName" : "maxItems", + "documentation" : "

    The total number of items to return.

    " + }, + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "nextToken", + "documentation" : "

    A token to specify where to start paginating.

    " + } + } + }, + "ListApplicationsResponse" : { + "type" : "structure", + "members" : { + "Applications" : { + "shape" : "__listOfApplicationSummary", + "locationName" : "applications", + "documentation" : "

    An array of application summaries.

    " + }, + "NextToken" : { + "shape" : "__string", + "locationName" : "nextToken", + "documentation" : "

    The token to request the next page of results.

    " + } + } + }, + "MaxItems" : { + "type" : "integer", + "min" : 1, + "max" : 100 + }, + "NotFoundException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    404

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    " + } + }, + "documentation" : "

    The resource (for example, an access policy statement) specified in the request doesn't exist.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "ParameterDefinition" : { + "type" : "structure", + "members" : { + "AllowedPattern" : { + "shape" : "__string", + "locationName" : "allowedPattern", + "documentation" : "

    A regular expression that represents the patterns to allow for String types.

    " + }, + "AllowedValues" : { + "shape" : "__listOf__string", + "locationName" : "allowedValues", + "documentation" : "

    An array containing the list of values allowed for the parameter.

    " + }, + "ConstraintDescription" : { + "shape" : "__string", + "locationName" : "constraintDescription", + "documentation" : "

    A string that explains a constraint when the constraint is violated. For example, without a constraint description,\n a parameter that has an allowed pattern of [A-Za-z0-9]+ displays the following error message when the user\n specifies an invalid value:

    \n Malformed input-Parameter MyParameter must match pattern [A-Za-z0-9]+\n

    By adding a constraint description, such as \"must contain only uppercase and lowercase letters and numbers,\" you can display\n the following customized error message:

    \n Malformed input-Parameter MyParameter must contain only uppercase and lowercase letters and numbers.\n

    " + }, + "DefaultValue" : { + "shape" : "__string", + "locationName" : "defaultValue", + "documentation" : "

    A value of the appropriate type for the template to use if no value is specified when a stack is created.\n If you define constraints for the parameter, you must specify a value that adheres to those constraints.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    A string of up to 4,000 characters that describes the parameter.

    " + }, + "MaxLength" : { + "shape" : "__integer", + "locationName" : "maxLength", + "documentation" : "

    An integer value that determines the largest number of characters that you want to allow for String types.

    " + }, + "MaxValue" : { + "shape" : "__integer", + "locationName" : "maxValue", + "documentation" : "

    A numeric value that determines the largest numeric value that you want to allow for Number types.

    " + }, + "MinLength" : { + "shape" : "__integer", + "locationName" : "minLength", + "documentation" : "

    An integer value that determines the smallest number of characters that you want to allow for String types.

    " + }, + "MinValue" : { + "shape" : "__integer", + "locationName" : "minValue", + "documentation" : "

    A numeric value that determines the smallest numeric value that you want to allow for Number types.

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the parameter.

    " + }, + "NoEcho" : { + "shape" : "__boolean", + "locationName" : "noEcho", + "documentation" : "

    Whether to mask the parameter value whenever anyone makes a call that describes the stack. If you set the\n value to true, the parameter value is masked with asterisks (*****).

    " + }, + "ReferencedByResources" : { + "shape" : "__listOf__string", + "locationName" : "referencedByResources", + "documentation" : "

    A list of AWS SAM resources that use this parameter.

    " + }, + "Type" : { + "shape" : "__string", + "locationName" : "type", + "documentation" : "

    The type of the parameter.

    Valid values: String | Number | List<Number> | CommaDelimitedList\n

    \n String: A literal string.

    For example, users can specify \"MyUserName\".

    \n Number: An integer or float. AWS CloudFormation validates the parameter value as a number. However, when you use the\n parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a string.

    For example, users might specify \"8888\".

    \n List<Number>: An array of integers or floats that are separated by commas. AWS CloudFormation validates the parameter value as numbers. However, when\n you use the parameter elsewhere in your template (for example, by using the Ref intrinsic function), the parameter value becomes a list of strings.

    For example, users might specify \"80,20\", and then Ref results in [\"80\",\"20\"].

    \n CommaDelimitedList: An array of literal strings that are separated by commas. The total number of strings should be one more than the total number of commas.\n Also, each member string is space-trimmed.

    For example, users might specify \"test,dev,prod\", and then Ref results in [\"test\",\"dev\",\"prod\"].

    " + } + }, + "documentation" : "

    Parameters supported by the application.

    ", + "required" : [ "ReferencedByResources", "Name" ] + }, + "ParameterValue" : { + "type" : "structure", + "members" : { + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation\n uses the default value that is specified in your template.

    " + }, + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "

    The input value associated with the parameter.

    " + } + }, + "documentation" : "

    Parameter value of the application.

    ", + "required" : [ "Value", "Name" ] + }, + "PutApplicationPolicyRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "Statements" : { + "shape" : "__listOfApplicationPolicyStatement", + "locationName" : "statements", + "documentation" : "

    An array of policy statements applied to the application.

    " + } + }, + "required" : [ "ApplicationId", "Statements" ] + }, + "PutApplicationPolicyResponse" : { + "type" : "structure", + "members" : { + "Statements" : { + "shape" : "__listOfApplicationPolicyStatement", + "locationName" : "statements", + "documentation" : "

    An array of policy statements applied to the application.

    " + } + } + }, + "RollbackConfiguration" : { + "type" : "structure", + "members" : { + "MonitoringTimeInMinutes" : { + "shape" : "__integer", + "locationName" : "monitoringTimeInMinutes", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration\n Data Type.

    " + }, + "RollbackTriggers" : { + "shape" : "__listOfRollbackTrigger", + "locationName" : "rollbackTriggers", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackConfiguration\n Data Type.

    " + } + }, + "documentation" : "

    This property corresponds to the AWS CloudFormation RollbackConfiguration\n Data Type.

    " + }, + "RollbackTrigger" : { + "type" : "structure", + "members" : { + "Arn" : { + "shape" : "__string", + "locationName" : "arn", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger\n Data Type.

    " + }, + "Type" : { + "shape" : "__string", + "locationName" : "type", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation RollbackTrigger\n Data Type.

    " + } + }, + "documentation" : "

    This property corresponds to the AWS CloudFormation RollbackTrigger\n Data Type.

    ", + "required" : [ "Type", "Arn" ] + }, + "Status" : { + "type" : "string", + "enum" : [ "PREPARING", "ACTIVE", "EXPIRED" ] + }, + "Tag" : { + "type" : "structure", + "members" : { + "Key" : { + "shape" : "__string", + "locationName" : "key", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation Tag\n Data Type.

    " + }, + "Value" : { + "shape" : "__string", + "locationName" : "value", + "documentation" : "

    This property corresponds to the content of the same name for the AWS CloudFormation \n Tag\n \n Data Type.

    " + } + }, + "documentation" : "

    This property corresponds to the AWS CloudFormation Tag\n Data Type.

    ", + "required" : [ "Value", "Key" ] + }, + "TemplateDetails" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "ExpirationTime" : { + "shape" : "__string", + "locationName" : "expirationTime", + "documentation" : "

    The date and time this template expires. Templates\n expire 1 hour after creation.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "Status" : { + "shape" : "Status", + "locationName" : "status", + "documentation" : "

    Status of the template creation workflow.

    Possible values: PREPARING | ACTIVE | EXPIRED\n

    " + }, + "TemplateId" : { + "shape" : "__string", + "locationName" : "templateId", + "documentation" : "

    The UUID returned by CreateCloudFormationTemplate.

    Pattern: [0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the template that can be used to deploy the application using\n AWS CloudFormation.

    " + } + }, + "documentation" : "

    Details of the template.

    ", + "required" : [ "Status", "TemplateUrl", "CreationTime", "ExpirationTime", "ApplicationId", "TemplateId", "SemanticVersion" ] + }, + "TooManyRequestsException" : { + "type" : "structure", + "members" : { + "ErrorCode" : { + "shape" : "__string", + "locationName" : "errorCode", + "documentation" : "

    429

    " + }, + "Message" : { + "shape" : "__string", + "locationName" : "message", + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    " + } + }, + "documentation" : "

    The client is sending more than the allowed number of requests per unit of time.

    ", + "exception" : true, + "error" : { + "httpStatusCode" : 429 + } + }, + "UpdateApplicationInput" : { + "type" : "structure", + "members" : { + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "ReadmeBody" : { + "shape" : "__string", + "locationName" : "readmeBody", + "documentation" : "

    A text readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + } + }, + "documentation" : "

    Update the application request.

    " + }, + "UpdateApplicationRequest" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "applicationId", + "documentation" : "

    The Amazon Resource Name (ARN) of the application.

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "ReadmeBody" : { + "shape" : "__string", + "locationName" : "readmeBody", + "documentation" : "

    A text readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + } + }, + "required" : [ "ApplicationId" ] + }, + "UpdateApplicationResponse" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "Author" : { + "shape" : "__string", + "locationName" : "author", + "documentation" : "

    The name of the author publishing the app.

    Minimum length=1. Maximum length=127.

    Pattern \"^[a-z0-9](([a-z0-9]|-(?!-))*[a-z0-9])?$\";

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "Description" : { + "shape" : "__string", + "locationName" : "description", + "documentation" : "

    The description of the application.

    Minimum length=1. Maximum length=256

    " + }, + "HomePageUrl" : { + "shape" : "__string", + "locationName" : "homePageUrl", + "documentation" : "

    A URL with more information about the application, for example the location of your GitHub repository for the application.

    " + }, + "Labels" : { + "shape" : "__listOf__string", + "locationName" : "labels", + "documentation" : "

    Labels to improve discovery of apps in search results.

    Minimum length=1. Maximum length=127. Maximum number of labels: 10

    Pattern: \"^[a-zA-Z0-9+\\\\-_:\\\\/@]+$\";

    " + }, + "LicenseUrl" : { + "shape" : "__string", + "locationName" : "licenseUrl", + "documentation" : "

    A link to a license file of the app that matches the spdxLicenseID value of your application.

    Maximum size 5 MB

    " + }, + "Name" : { + "shape" : "__string", + "locationName" : "name", + "documentation" : "

    The name of the application.

    Minimum length=1. Maximum length=140

    Pattern: \"[a-zA-Z0-9\\\\-]+\";

    " + }, + "ReadmeUrl" : { + "shape" : "__string", + "locationName" : "readmeUrl", + "documentation" : "

    A link to the readme file in Markdown language that contains a more detailed description of the application and how it works.

    Maximum size 5 MB

    " + }, + "SpdxLicenseId" : { + "shape" : "__string", + "locationName" : "spdxLicenseId", + "documentation" : "

    A valid identifier from https://spdx.org/licenses/.

    " + }, + "Version" : { + "shape" : "Version", + "locationName" : "version", + "documentation" : "

    Version information about the application.

    " + } + } + }, + "Version" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "ParameterDefinitions" : { + "shape" : "__listOfParameterDefinition", + "locationName" : "parameterDefinitions", + "documentation" : "

    An array of parameter types supported by the application.

    " + }, + "RequiredCapabilities" : { + "shape" : "__listOfCapability", + "locationName" : "requiredCapabilities", + "documentation" : "

    A list of values that you must specify before you can deploy certain applications.\n Some applications might include resources that can affect permissions in your AWS\n account, for example, by creating new AWS Identity and Access Management (IAM) users.\n For those applications, you must explicitly acknowledge their capabilities by\n specifying this parameter.

    The only valid values are CAPABILITY_IAM, CAPABILITY_NAMED_IAM,\n CAPABILITY_RESOURCE_POLICY, and CAPABILITY_AUTO_EXPAND.

    The following resources require you to specify CAPABILITY_IAM or\n CAPABILITY_NAMED_IAM:\n AWS::IAM::Group,\n AWS::IAM::InstanceProfile,\n AWS::IAM::Policy, and\n AWS::IAM::Role.\n If the application contains IAM resources, you can specify either CAPABILITY_IAM\n or CAPABILITY_NAMED_IAM. If the application contains IAM resources\n with custom names, you must specify CAPABILITY_NAMED_IAM.

    The following resources require you to specify CAPABILITY_RESOURCE_POLICY:\n AWS::Lambda::Permission,\n AWS::IAM:Policy,\n AWS::ApplicationAutoScaling::ScalingPolicy,\n AWS::S3::BucketPolicy,\n AWS::SQS::QueuePolicy, and\n AWS::SNS::TopicPolicy.

    Applications that contain one or more nested applications require you to specify\n CAPABILITY_AUTO_EXPAND.

    If your application template contains any of the above resources, we recommend that you review\n all permissions associated with the application before deploying. If you don't specify\n this parameter for an application that requires capabilities, the call will fail.

    " + }, + "ResourcesSupported" : { + "shape" : "__boolean", + "locationName" : "resourcesSupported", + "documentation" : "

    Whether all of the AWS resources contained in this application are supported in the region\n in which it is being retrieved.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "SourceCodeArchiveUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeArchiveUrl", + "documentation" : "

    A link to the S3 object that contains the ZIP archive of the source code for this version of your application.

    Maximum size 50 MB

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + }, + "TemplateUrl" : { + "shape" : "__string", + "locationName" : "templateUrl", + "documentation" : "

    A link to the packaged AWS SAM template of your application.

    " + } + }, + "documentation" : "

    Application version details.

    ", + "required" : [ "TemplateUrl", "ParameterDefinitions", "ResourcesSupported", "CreationTime", "RequiredCapabilities", "ApplicationId", "SemanticVersion" ] + }, + "VersionSummary" : { + "type" : "structure", + "members" : { + "ApplicationId" : { + "shape" : "__string", + "locationName" : "applicationId", + "documentation" : "

    The application Amazon Resource Name (ARN).

    " + }, + "CreationTime" : { + "shape" : "__string", + "locationName" : "creationTime", + "documentation" : "

    The date and time this resource was created.

    " + }, + "SemanticVersion" : { + "shape" : "__string", + "locationName" : "semanticVersion", + "documentation" : "

    The semantic version of the application:

    \n https://semver.org/\n

    " + }, + "SourceCodeUrl" : { + "shape" : "__string", + "locationName" : "sourceCodeUrl", + "documentation" : "

    A link to a public repository for the source code of your application, for example the URL of a specific GitHub commit.

    " + } + }, + "documentation" : "

    An application version summary.

    ", + "required" : [ "CreationTime", "ApplicationId", "SemanticVersion" ] + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__listOfApplicationDependencySummary" : { + "type" : "list", + "member" : { + "shape" : "ApplicationDependencySummary" + } + }, + "__listOfApplicationPolicyStatement" : { + "type" : "list", + "member" : { + "shape" : "ApplicationPolicyStatement" + } + }, + "__listOfApplicationSummary" : { + "type" : "list", + "member" : { + "shape" : "ApplicationSummary" + } + }, + "__listOfCapability" : { + "type" : "list", + "member" : { + "shape" : "Capability" + } + }, + "__listOfParameterDefinition" : { + "type" : "list", + "member" : { + "shape" : "ParameterDefinition" + } + }, + "__listOfParameterValue" : { + "type" : "list", + "member" : { + "shape" : "ParameterValue" + } + }, + "__listOfRollbackTrigger" : { + "type" : "list", + "member" : { + "shape" : "RollbackTrigger" + } + }, + "__listOfTag" : { + "type" : "list", + "member" : { + "shape" : "Tag" + } + }, + "__listOfVersionSummary" : { + "type" : "list", + "member" : { + "shape" : "VersionSummary" + } + }, + "__listOf__string" : { + "type" : "list", + "member" : { + "shape" : "__string" + } + }, + "__long" : { + "type" : "long" + }, + "__string" : { + "type" : "string" + } + }, + "documentation" : "

    The AWS Serverless Application Repository makes it easy for developers and enterprises to quickly find\n and deploy serverless applications in the AWS Cloud. For more information about serverless applications,\n see Serverless Computing and Applications on the AWS website.

    The AWS Serverless Application Repository is deeply integrated with the AWS Lambda console, so that developers of \n all levels can get started with serverless computing without needing to learn anything new. You can use category \n keywords to browse for applications such as web and mobile backends, data processing applications, or chatbots. \n You can also search for applications by name, publisher, or event source. To use an application, you simply choose it, \n configure any required fields, and deploy it with a few clicks.

    You can also easily publish applications, sharing them publicly with the community at large, or privately\n within your team or across your organization. To publish a serverless application (or app), you can use the\n AWS Management Console, AWS Command Line Interface (AWS CLI), or AWS SDKs to upload the code. Along with the\n code, you upload a simple manifest file, also known as the AWS Serverless Application Model (AWS SAM) template.\n For more information about AWS SAM, see AWS Serverless Application Model (AWS SAM) on the AWS Labs\n GitHub repository.

    The AWS Serverless Application Repository Developer Guide contains more information about the two developer\n experiences available:

      \n
    • \n

      Consuming Applications – Browse for applications and view information about them, including\n source code and readme files. Also install, configure, and deploy applications of your choosing.

      \n

      Publishing Applications – Configure and upload applications to make them available to other\n developers, and publish new versions of applications.

      \n
      • \n
    " +} diff --git a/aws/dist/botocore/data/service-quotas/2019-06-24/paginators-1.json b/aws/dist/botocore/data/service-quotas/2019-06-24/paginators-1.json new file mode 100644 index 00000000..e0d45476 --- /dev/null +++ b/aws/dist/botocore/data/service-quotas/2019-06-24/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListAWSDefaultServiceQuotas": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Quotas" + }, + "ListRequestedServiceQuotaChangeHistory": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "RequestedQuotas" + }, + "ListRequestedServiceQuotaChangeHistoryByQuota": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "RequestedQuotas" + }, + "ListServiceQuotaIncreaseRequestsInTemplate": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ServiceQuotaIncreaseRequestInTemplateList" + }, + "ListServiceQuotas": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Quotas" + }, + "ListServices": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Services" + } + } +} diff --git a/aws/dist/botocore/data/service-quotas/2019-06-24/service-2.json b/aws/dist/botocore/data/service-quotas/2019-06-24/service-2.json new file mode 100644 index 00000000..b4fe21c7 --- /dev/null +++ b/aws/dist/botocore/data/service-quotas/2019-06-24/service-2.json @@ -0,0 +1,1212 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-06-24", + "endpointPrefix":"servicequotas", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Service Quotas", + "serviceId":"Service Quotas", + "signatureVersion":"v4", + "targetPrefix":"ServiceQuotasV20190624", + "uid":"service-quotas-2019-06-24" + }, + "operations":{ + "AssociateServiceQuotaTemplate":{ + "name":"AssociateServiceQuotaTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateServiceQuotaTemplateRequest"}, + "output":{"shape":"AssociateServiceQuotaTemplateResponse"}, + "errors":[ + {"shape":"DependencyAccessDeniedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"OrganizationNotInAllFeaturesModeException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Associates the Service Quotas template with your organization so that when new accounts are created in your organization, the template submits increase requests for the specified service quotas. Use the Service Quotas template to request an increase for any adjustable quota value. After you define the Service Quotas template, use this operation to associate, or enable, the template.

    " + }, + "DeleteServiceQuotaIncreaseRequestFromTemplate":{ + "name":"DeleteServiceQuotaIncreaseRequestFromTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceQuotaIncreaseRequestFromTemplateRequest"}, + "output":{"shape":"DeleteServiceQuotaIncreaseRequestFromTemplateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"DependencyAccessDeniedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Removes a service quota increase request from the Service Quotas template.

    " + }, + "DisassociateServiceQuotaTemplate":{ + "name":"DisassociateServiceQuotaTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateServiceQuotaTemplateRequest"}, + "output":{"shape":"DisassociateServiceQuotaTemplateResponse"}, + "errors":[ + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ServiceQuotaTemplateNotInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Disables the Service Quotas template. Once the template is disabled, it does not request quota increases for new accounts in your organization. Disabling the quota template does not apply the quota increase requests from the template.

    Related operations

    " + }, + "GetAWSDefaultServiceQuota":{ + "name":"GetAWSDefaultServiceQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAWSDefaultServiceQuotaRequest"}, + "output":{"shape":"GetAWSDefaultServiceQuotaResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves the default service quotas values. The Value returned for each quota is the AWS default value, even if the quotas have been increased..

    " + }, + "GetAssociationForServiceQuotaTemplate":{ + "name":"GetAssociationForServiceQuotaTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAssociationForServiceQuotaTemplateRequest"}, + "output":{"shape":"GetAssociationForServiceQuotaTemplateResponse"}, + "errors":[ + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ServiceQuotaTemplateNotInUseException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Retrieves the ServiceQuotaTemplateAssociationStatus value from the service. Use this action to determine if the Service Quota template is associated, or enabled.

    " + }, + "GetRequestedServiceQuotaChange":{ + "name":"GetRequestedServiceQuotaChange", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRequestedServiceQuotaChangeRequest"}, + "output":{"shape":"GetRequestedServiceQuotaChangeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves the details for a particular increase request.

    " + }, + "GetServiceQuota":{ + "name":"GetServiceQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceQuotaRequest"}, + "output":{"shape":"GetServiceQuotaResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Returns the details for the specified service quota. This operation provides a different Value than the GetAWSDefaultServiceQuota operation. This operation returns the applied value for each quota. GetAWSDefaultServiceQuota returns the default AWS value for each quota.

    " + }, + "GetServiceQuotaIncreaseRequestFromTemplate":{ + "name":"GetServiceQuotaIncreaseRequestFromTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceQuotaIncreaseRequestFromTemplateRequest"}, + "output":{"shape":"GetServiceQuotaIncreaseRequestFromTemplateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Returns the details of the service quota increase request in your template.

    " + }, + "ListAWSDefaultServiceQuotas":{ + "name":"ListAWSDefaultServiceQuotas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAWSDefaultServiceQuotasRequest"}, + "output":{"shape":"ListAWSDefaultServiceQuotasResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Lists all default service quotas for the specified AWS service or all AWS services. ListAWSDefaultServiceQuotas is similar to ListServiceQuotas except for the Value object. The Value object returned by ListAWSDefaultServiceQuotas is the default value assigned by AWS. This request returns a list of all service quotas for the specified service. The listing of each you'll see the default values are the values that AWS provides for the quotas.

    Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

    " + }, + "ListRequestedServiceQuotaChangeHistory":{ + "name":"ListRequestedServiceQuotaChangeHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRequestedServiceQuotaChangeHistoryRequest"}, + "output":{"shape":"ListRequestedServiceQuotaChangeHistoryResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Requests a list of the changes to quotas for a service.

    " + }, + "ListRequestedServiceQuotaChangeHistoryByQuota":{ + "name":"ListRequestedServiceQuotaChangeHistoryByQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRequestedServiceQuotaChangeHistoryByQuotaRequest"}, + "output":{"shape":"ListRequestedServiceQuotaChangeHistoryByQuotaResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Requests a list of the changes to specific service quotas. This command provides additional granularity over the ListRequestedServiceQuotaChangeHistory command. Once a quota change request has reached CASE_CLOSED, APPROVED, or DENIED, the history has been kept for 90 days.

    " + }, + "ListServiceQuotaIncreaseRequestsInTemplate":{ + "name":"ListServiceQuotaIncreaseRequestsInTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceQuotaIncreaseRequestsInTemplateRequest"}, + "output":{"shape":"ListServiceQuotaIncreaseRequestsInTemplateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Returns a list of the quota increase requests in the template.

    " + }, + "ListServiceQuotas":{ + "name":"ListServiceQuotas", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceQuotasRequest"}, + "output":{"shape":"ListServiceQuotasResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Lists all service quotas for the specified AWS service. This request returns a list of the service quotas for the specified service. you'll see the default values are the values that AWS provides for the quotas.

    Always check the NextToken response parameter when calling any of the List* operations. These operations can return an unexpected list of results, even when there are more results available. When this happens, the NextToken response parameter contains a value to pass the next call to the same API to request the next part of the list.

    " + }, + "ListServices":{ + "name":"ListServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServicesRequest"}, + "output":{"shape":"ListServicesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidPaginationTokenException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Lists the AWS services available in Service Quotas. Not all AWS services are available in Service Quotas. To list the see the list of the service quotas for a specific service, use ListServiceQuotas.

    " + }, + "PutServiceQuotaIncreaseRequestIntoTemplate":{ + "name":"PutServiceQuotaIncreaseRequestIntoTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutServiceQuotaIncreaseRequestIntoTemplateRequest"}, + "output":{"shape":"PutServiceQuotaIncreaseRequestIntoTemplateResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"DependencyAccessDeniedException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"QuotaExceededException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"AWSServiceAccessNotEnabledException"}, + {"shape":"TemplatesNotAvailableInRegionException"}, + {"shape":"NoAvailableOrganizationException"} + ], + "documentation":"

    Defines and adds a quota to the service quota template. To add a quota to the template, you must provide the ServiceCode, QuotaCode, AwsRegion, and DesiredValue. Once you add a quota to the template, use ListServiceQuotaIncreaseRequestsInTemplate to see the list of quotas in the template.

    " + }, + "RequestServiceQuotaIncrease":{ + "name":"RequestServiceQuotaIncrease", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestServiceQuotaIncreaseRequest"}, + "output":{"shape":"RequestServiceQuotaIncreaseResponse"}, + "errors":[ + {"shape":"DependencyAccessDeniedException"}, + {"shape":"QuotaExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"AccessDeniedException"}, + {"shape":"NoSuchResourceException"}, + {"shape":"IllegalArgumentException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"ServiceException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves the details of a service quota increase request. The response to this command provides the details in the RequestedServiceQuotaChange object.

    " + } + }, + "shapes":{ + "AWSServiceAccessNotEnabledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The action you attempted is not allowed unless Service Access with Service Quotas is enabled in your organization. To enable, call AssociateServiceQuotaTemplate.

    ", + "exception":true + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    You do not have sufficient access to perform this action.

    ", + "exception":true + }, + "AssociateServiceQuotaTemplateRequest":{ + "type":"structure", + "members":{ + } + }, + "AssociateServiceQuotaTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "AwsRegion":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z][a-zA-Z0-9-]{1,128}" + }, + "CustomerServiceEngagementId":{"type":"string"}, + "DateTime":{"type":"timestamp"}, + "DeleteServiceQuotaIncreaseRequestFromTemplateRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode", + "AwsRegion" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the code for the service that you want to delete.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the code for the quota that you want to delete.

    " + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

    Specifies the AWS Region for the quota that you want to delete.

    " + } + } + }, + "DeleteServiceQuotaIncreaseRequestFromTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DependencyAccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    You can't perform this action because a dependency does not have access.

    ", + "exception":true + }, + "DisassociateServiceQuotaTemplateRequest":{ + "type":"structure", + "members":{ + } + }, + "DisassociateServiceQuotaTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "ErrorCode":{ + "type":"string", + "enum":[ + "DEPENDENCY_ACCESS_DENIED_ERROR", + "DEPENDENCY_THROTTLING_ERROR", + "DEPENDENCY_SERVICE_ERROR", + "SERVICE_QUOTA_NOT_AVAILABLE_ERROR" + ] + }, + "ErrorMessage":{"type":"string"}, + "ErrorReason":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

    Service Quotas returns the following error values.

    DEPENDENCY_ACCESS_DENIED_ERROR is returned when the caller does not have permission to call the service or service quota. To resolve the error, you need permission to access the service or service quota.

    DEPENDENCY_THROTTLING_ERROR is returned when the service being called is throttling Service Quotas.

    DEPENDENCY_SERVICE_ERROR is returned when the service being called has availability issues.

    SERVICE_QUOTA_NOT_AVAILABLE_ERROR is returned when there was an error in Service Quotas.

    " + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

    The error message that provides more detail.

    " + } + }, + "documentation":"

    Returns an error that explains why the action did not succeed.

    " + }, + "ExceptionMessage":{"type":"string"}, + "GetAWSDefaultServiceQuotaRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Identifies the service quota you want to select.

    " + } + } + }, + "GetAWSDefaultServiceQuotaResponse":{ + "type":"structure", + "members":{ + "Quota":{ + "shape":"ServiceQuota", + "documentation":"

    Returns the ServiceQuota object which contains all values for a quota.

    " + } + } + }, + "GetAssociationForServiceQuotaTemplateRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAssociationForServiceQuotaTemplateResponse":{ + "type":"structure", + "members":{ + "ServiceQuotaTemplateAssociationStatus":{ + "shape":"ServiceQuotaTemplateAssociationStatus", + "documentation":"

    Specifies whether the template is ASSOCIATED or DISASSOCIATED. If the template is ASSOCIATED, then it requests service quota increases for all new accounts created in your organization.

    " + } + } + }, + "GetRequestedServiceQuotaChangeRequest":{ + "type":"structure", + "required":["RequestId"], + "members":{ + "RequestId":{ + "shape":"RequestId", + "documentation":"

    Identifies the quota increase request.

    " + } + } + }, + "GetRequestedServiceQuotaChangeResponse":{ + "type":"structure", + "members":{ + "RequestedQuota":{ + "shape":"RequestedServiceQuotaChange", + "documentation":"

    Returns the RequestedServiceQuotaChange object for the specific increase request.

    " + } + } + }, + "GetServiceQuotaIncreaseRequestFromTemplateRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode", + "AwsRegion" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the quota you want.

    " + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

    Specifies the AWS Region for the quota that you want to use.

    " + } + } + }, + "GetServiceQuotaIncreaseRequestFromTemplateResponse":{ + "type":"structure", + "members":{ + "ServiceQuotaIncreaseRequestInTemplate":{ + "shape":"ServiceQuotaIncreaseRequestInTemplate", + "documentation":"

    This object contains the details about the quota increase request.

    " + } + } + }, + "GetServiceQuotaRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Identifies the service quota you want to select.

    " + } + } + }, + "GetServiceQuotaResponse":{ + "type":"structure", + "members":{ + "Quota":{ + "shape":"ServiceQuota", + "documentation":"

    Returns the ServiceQuota object which contains all values for a quota.

    " + } + } + }, + "GlobalQuota":{"type":"boolean"}, + "IllegalArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    Invalid input was provided.

    ", + "exception":true + }, + "InvalidPaginationTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    Invalid input was provided.

    ", + "exception":true + }, + "InvalidResourceStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    Invalid input was provided for the .

    ", + "exception":true + }, + "ListAWSDefaultServiceQuotasRequest":{ + "type":"structure", + "required":["ServiceCode"], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListAWSDefaultServiceQuotasResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "Quotas":{ + "shape":"ServiceQuotaListDefinition", + "documentation":"

    A list of the quotas in the account with the AWS default values.

    " + } + } + }, + "ListRequestedServiceQuotaChangeHistoryByQuotaRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the service quota that you want to use

    " + }, + "Status":{ + "shape":"RequestStatus", + "documentation":"

    Specifies the status value of the quota increase request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListRequestedServiceQuotaChangeHistoryByQuotaResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + }, + "RequestedQuotas":{ + "shape":"RequestedServiceQuotaChangeHistoryListDefinition", + "documentation":"

    Returns a list of service quota requests.

    " + } + } + }, + "ListRequestedServiceQuotaChangeHistoryRequest":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "Status":{ + "shape":"RequestStatus", + "documentation":"

    Specifies the status value of the quota increase request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListRequestedServiceQuotaChangeHistoryResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + }, + "RequestedQuotas":{ + "shape":"RequestedServiceQuotaChangeHistoryListDefinition", + "documentation":"

    Returns a list of service quota requests.

    " + } + } + }, + "ListServiceQuotaIncreaseRequestsInTemplateRequest":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

    " + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

    Specifies the AWS Region for the quota that you want to use.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListServiceQuotaIncreaseRequestsInTemplateResponse":{ + "type":"structure", + "members":{ + "ServiceQuotaIncreaseRequestInTemplateList":{ + "shape":"ServiceQuotaIncreaseRequestInTemplateList", + "documentation":"

    Returns the list of values of the quota increase request in the template.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + } + } + }, + "ListServiceQuotasRequest":{ + "type":"structure", + "required":["ServiceCode"], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    The identifier for a service. When performing an operation, use the ServiceCode to specify a particular service.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListServiceQuotasResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + }, + "Quotas":{ + "shape":"ServiceQuotaListDefinition", + "documentation":"

    The response information for a quota lists all attribute information for the quota.

    " + } + } + }, + "ListServicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    (Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, the response defaults to a value that's specific to the operation. If additional items exist beyond the specified maximum, the NextToken element is present and has a value (isn't null). Include that value as the NextToken request parameter in the call to the operation to get the next part of the results. You should check NextToken after every operation to ensure that you receive all of the results.

    " + } + } + }, + "ListServicesResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If present in the response, this value indicates there's more output available that what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

    " + }, + "Services":{ + "shape":"ServiceInfoListDefinition", + "documentation":"

    Returns a list of services.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "MetricDimensionName":{"type":"string"}, + "MetricDimensionValue":{"type":"string"}, + "MetricDimensionsMapDefinition":{ + "type":"map", + "key":{"shape":"MetricDimensionName"}, + "value":{"shape":"MetricDimensionValue"}, + "max":10 + }, + "MetricInfo":{ + "type":"structure", + "members":{ + "MetricNamespace":{ + "shape":"QuotaMetricNamespace", + "documentation":"

    The namespace of the metric. The namespace is a container for CloudWatch metrics. You can specify a name for the namespace when you create a metric.

    " + }, + "MetricName":{ + "shape":"QuotaMetricName", + "documentation":"

    The name of the CloudWatch metric that measures usage of a service quota. This is a required field.

    " + }, + "MetricDimensions":{ + "shape":"MetricDimensionsMapDefinition", + "documentation":"

    A dimension is a name/value pair that is part of the identity of a metric. Every metric has specific characteristics that describe it, and you can think of dimensions as categories for those characteristics. These dimensions are part of the CloudWatch Metric Identity that measures usage against a particular service quota.

    " + }, + "MetricStatisticRecommendation":{ + "shape":"Statistic", + "documentation":"

    Statistics are metric data aggregations over specified periods of time. This is the recommended statistic to use when comparing usage in the CloudWatch Metric against your Service Quota.

    " + } + }, + "documentation":"

    A structure that uses CloudWatch metrics to gather data about the service quota.

    " + }, + "NextToken":{ + "type":"string", + "max":2048, + "pattern":"^[a-zA-Z0-9/+]*={0,2}$" + }, + "NoAvailableOrganizationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The account making this call is not a member of an organization.

    ", + "exception":true + }, + "NoSuchResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified resource does not exist.

    ", + "exception":true + }, + "OrganizationNotInAllFeaturesModeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The organization that your account belongs to, is not in All Features mode. To enable all features mode, see EnableAllFeatures.

    ", + "exception":true + }, + "PeriodUnit":{ + "type":"string", + "enum":[ + "MICROSECOND", + "MILLISECOND", + "SECOND", + "MINUTE", + "HOUR", + "DAY", + "WEEK" + ] + }, + "PeriodValue":{"type":"integer"}, + "PutServiceQuotaIncreaseRequestIntoTemplateRequest":{ + "type":"structure", + "required":[ + "QuotaCode", + "ServiceCode", + "AwsRegion", + "DesiredValue" + ], + "members":{ + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the service quota that you want to use.

    " + }, + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

    Specifies the AWS Region for the quota.

    " + }, + "DesiredValue":{ + "shape":"QuotaValue", + "documentation":"

    Specifies the new, increased value for the quota.

    " + } + } + }, + "PutServiceQuotaIncreaseRequestIntoTemplateResponse":{ + "type":"structure", + "members":{ + "ServiceQuotaIncreaseRequestInTemplate":{ + "shape":"ServiceQuotaIncreaseRequestInTemplate", + "documentation":"

    A structure that contains information about one service quota increase request.

    " + } + } + }, + "QuotaAdjustable":{"type":"boolean"}, + "QuotaArn":{"type":"string"}, + "QuotaCode":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z][a-zA-Z0-9-]{1,128}" + }, + "QuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

    ", + "exception":true + }, + "QuotaMetricName":{"type":"string"}, + "QuotaMetricNamespace":{"type":"string"}, + "QuotaName":{"type":"string"}, + "QuotaPeriod":{ + "type":"structure", + "members":{ + "PeriodValue":{ + "shape":"PeriodValue", + "documentation":"

    The value of a period.

    " + }, + "PeriodUnit":{ + "shape":"PeriodUnit", + "documentation":"

    The time unit of a period.

    " + } + }, + "documentation":"

    A structure that contains information about the quota period.

    " + }, + "QuotaUnit":{"type":"string"}, + "QuotaValue":{ + "type":"double", + "max":10000000000, + "min":0 + }, + "RequestId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[0-9a-zA-Z][a-zA-Z0-9-]{1,128}" + }, + "RequestServiceQuotaIncreaseRequest":{ + "type":"structure", + "required":[ + "ServiceCode", + "QuotaCode", + "DesiredValue" + ], + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the service quota that you want to use.

    " + }, + "DesiredValue":{ + "shape":"QuotaValue", + "documentation":"

    Specifies the value submitted in the service quota increase request.

    " + } + } + }, + "RequestServiceQuotaIncreaseResponse":{ + "type":"structure", + "members":{ + "RequestedQuota":{ + "shape":"RequestedServiceQuotaChange", + "documentation":"

    Returns a list of service quota requests.

    " + } + } + }, + "RequestStatus":{ + "type":"string", + "enum":[ + "PENDING", + "CASE_OPENED", + "APPROVED", + "DENIED", + "CASE_CLOSED" + ] + }, + "RequestedServiceQuotaChange":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"RequestId", + "documentation":"

    The unique identifier of a requested service quota change.

    " + }, + "CaseId":{ + "shape":"CustomerServiceEngagementId", + "documentation":"

    The case Id for the service quota increase request.

    " + }, + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the AWS service specified in the increase request.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    Specifies the service quota that you want to use.

    " + }, + "QuotaName":{ + "shape":"QuotaName", + "documentation":"

    Name of the service quota.

    " + }, + "DesiredValue":{ + "shape":"QuotaValue", + "documentation":"

    New increased value for the service quota.

    " + }, + "Status":{ + "shape":"RequestStatus", + "documentation":"

    State of the service quota increase request.

    " + }, + "Created":{ + "shape":"DateTime", + "documentation":"

    The date and time when the service quota increase request was received and the case Id was created.

    " + }, + "LastUpdated":{ + "shape":"DateTime", + "documentation":"

    The date and time of the most recent change in the service quota increase request.

    " + }, + "Requester":{ + "shape":"Requester", + "documentation":"

    The IAM identity who submitted the service quota increase request.

    " + }, + "QuotaArn":{ + "shape":"QuotaArn", + "documentation":"

    The Amazon Resource Name (ARN) of the service quota.

    " + }, + "GlobalQuota":{ + "shape":"GlobalQuota", + "documentation":"

    Identifies if the quota is global.

    " + }, + "Unit":{ + "shape":"QuotaUnit", + "documentation":"

    Specifies the unit used for the quota.

    " + } + }, + "documentation":"

    A structure that contains information about a requested change for a quota.

    " + }, + "RequestedServiceQuotaChangeHistoryListDefinition":{ + "type":"list", + "member":{"shape":"RequestedServiceQuotaChange"} + }, + "Requester":{"type":"string"}, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified resource already exists.

    ", + "exception":true + }, + "ServiceCode":{ + "type":"string", + "max":63, + "min":1, + "pattern":"[a-zA-Z][a-zA-Z0-9-]{1,63}" + }, + "ServiceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    Something went wrong.

    ", + "exception":true, + "fault":true + }, + "ServiceInfo":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the AWS service specified in the increase request.

    " + } + }, + "documentation":"

    A structure that contains the ServiceName and ServiceCode. It does not include all details of the service quota. To get those values, use the ListServiceQuotas operation.

    " + }, + "ServiceInfoListDefinition":{ + "type":"list", + "member":{"shape":"ServiceInfo"} + }, + "ServiceName":{"type":"string"}, + "ServiceQuota":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    Specifies the service that you want to use.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the AWS service specified in the increase request.

    " + }, + "QuotaArn":{ + "shape":"QuotaArn", + "documentation":"

    The Amazon Resource Name (ARN) of the service quota.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    The code identifier for the service quota specified.

    " + }, + "QuotaName":{ + "shape":"QuotaName", + "documentation":"

    The name identifier of the service quota.

    " + }, + "Value":{ + "shape":"QuotaValue", + "documentation":"

    The value of service quota.

    " + }, + "Unit":{ + "shape":"QuotaUnit", + "documentation":"

    The unit of measurement for the value of the service quota.

    " + }, + "Adjustable":{ + "shape":"QuotaAdjustable", + "documentation":"

    Specifies if the quota value can be increased.

    " + }, + "GlobalQuota":{ + "shape":"GlobalQuota", + "documentation":"

    Specifies if the quota is global.

    " + }, + "UsageMetric":{ + "shape":"MetricInfo", + "documentation":"

    Specifies the details about the measurement.

    " + }, + "Period":{ + "shape":"QuotaPeriod", + "documentation":"

    Identifies the unit and value of how time is measured.

    " + }, + "ErrorReason":{ + "shape":"ErrorReason", + "documentation":"

    Specifies the ErrorCode and ErrorMessage when success isn't achieved.

    " + } + }, + "documentation":"

    A structure that contains the full set of details that define the service quota.

    " + }, + "ServiceQuotaIncreaseRequestInTemplate":{ + "type":"structure", + "members":{ + "ServiceCode":{ + "shape":"ServiceCode", + "documentation":"

    The code identifier for the AWS service specified in the increase request.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the AWS service specified in the increase request.

    " + }, + "QuotaCode":{ + "shape":"QuotaCode", + "documentation":"

    The code identifier for the service quota specified in the increase request.

    " + }, + "QuotaName":{ + "shape":"QuotaName", + "documentation":"

    The name of the service quota in the increase request.

    " + }, + "DesiredValue":{ + "shape":"QuotaValue", + "documentation":"

    Identifies the new, increased value of the service quota in the increase request.

    " + }, + "AwsRegion":{ + "shape":"AwsRegion", + "documentation":"

    The AWS Region where the increase request occurs.

    " + }, + "Unit":{ + "shape":"QuotaUnit", + "documentation":"

    The unit of measure for the increase request.

    " + }, + "GlobalQuota":{ + "shape":"GlobalQuota", + "documentation":"

    Specifies if the quota is a global quota.

    " + } + }, + "documentation":"

    A structure that contains information about one service quota increase request.

    " + }, + "ServiceQuotaIncreaseRequestInTemplateList":{ + "type":"list", + "member":{"shape":"ServiceQuotaIncreaseRequestInTemplate"} + }, + "ServiceQuotaListDefinition":{ + "type":"list", + "member":{"shape":"ServiceQuota"} + }, + "ServiceQuotaTemplateAssociationStatus":{ + "type":"string", + "enum":[ + "ASSOCIATED", + "DISASSOCIATED" + ] + }, + "ServiceQuotaTemplateNotInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The quota request template is not associated with your organization.

    To use the template, call AssociateServiceQuotaTemplate.

    ", + "exception":true + }, + "Statistic":{ + "type":"string", + "max":256, + "min":1, + "pattern":"(Sum|Maximum)" + }, + "TemplatesNotAvailableInRegionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The Service Quotas template is not available in the Region where you are making the request. Please make the request in us-east-1.

    ", + "exception":true + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    Due to throttling, the request was denied. Slow down the rate of request calls, or request an increase for this quota.

    ", + "exception":true + } + }, + "documentation":"

    Service Quotas is a web service that you can use to manage many of your AWS service quotas. Quotas, also referred to as limits, are the maximum values for a resource, item, or operation. This guide provide descriptions of the Service Quotas actions that you can call from an API. For the Service Quotas user guide, which explains how to use Service Quotas from the console, see What is Service Quotas.

    AWS provides SDKs that consist of libraries and sample code for programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc...,). The SDKs provide a convenient way to create programmatic access to Service Quotas and AWS. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

    " +} diff --git a/aws/dist/botocore/data/servicecatalog/2015-12-10/examples-1.json b/aws/dist/botocore/data/servicecatalog/2015-12-10/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/servicecatalog/2015-12-10/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/servicecatalog/2015-12-10/paginators-1.json b/aws/dist/botocore/data/servicecatalog/2015-12-10/paginators-1.json new file mode 100644 index 00000000..5770fefa --- /dev/null +++ b/aws/dist/botocore/data/servicecatalog/2015-12-10/paginators-1.json @@ -0,0 +1,100 @@ +{ + "pagination": { + "SearchProductsAsAdmin": { + "result_key": "ProductViewDetails", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListAcceptedPortfolioShares": { + "result_key": "PortfolioDetails", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListPortfolios": { + "result_key": "PortfolioDetails", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListConstraintsForPortfolio": { + "result_key": "ConstraintDetails", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListLaunchPaths": { + "result_key": "LaunchPathSummaries", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListTagOptions": { + "result_key": "TagOptionDetails", + "output_token": "PageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListPortfoliosForProduct": { + "result_key": "PortfolioDetails", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListPrincipalsForPortfolio": { + "result_key": "Principals", + "output_token": "NextPageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListResourcesForTagOption": { + "result_key": "ResourceDetails", + "output_token": "PageToken", + "input_token": "PageToken", + "limit_key": "PageSize" + }, + "ListOrganizationPortfolioAccess": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "OrganizationNodes" + }, + "ListProvisionedProductPlans": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "ProvisionedProductPlans" + }, + "ListProvisioningArtifactsForServiceAction": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "ProvisioningArtifactViews" + }, + "ListRecordHistory": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "RecordDetails" + }, + "ListServiceActions": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "ServiceActionSummaries" + }, + "ListServiceActionsForProvisioningArtifact": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "ServiceActionSummaries" + }, + "ScanProvisionedProducts": { + "input_token": "PageToken", + "limit_key": "PageSize", + "output_token": "NextPageToken", + "result_key": "ProvisionedProducts" + } + } +} diff --git a/aws/dist/botocore/data/servicecatalog/2015-12-10/service-2.json b/aws/dist/botocore/data/servicecatalog/2015-12-10/service-2.json new file mode 100644 index 00000000..b8fb691f --- /dev/null +++ b/aws/dist/botocore/data/servicecatalog/2015-12-10/service-2.json @@ -0,0 +1,6095 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-12-10", + "endpointPrefix":"servicecatalog", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Service Catalog", + "serviceId":"Service Catalog", + "signatureVersion":"v4", + "targetPrefix":"AWS242ServiceCatalogService", + "uid":"servicecatalog-2015-12-10" + }, + "operations":{ + "AcceptPortfolioShare":{ + "name":"AcceptPortfolioShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AcceptPortfolioShareInput"}, + "output":{"shape":"AcceptPortfolioShareOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Accepts an offer to share the specified portfolio.

    " + }, + "AssociateBudgetWithResource":{ + "name":"AssociateBudgetWithResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateBudgetWithResourceInput"}, + "output":{"shape":"AssociateBudgetWithResourceOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Associates the specified budget with the specified resource.

    " + }, + "AssociatePrincipalWithPortfolio":{ + "name":"AssociatePrincipalWithPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociatePrincipalWithPortfolioInput"}, + "output":{"shape":"AssociatePrincipalWithPortfolioOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Associates the specified principal ARN with the specified portfolio.

    " + }, + "AssociateProductWithPortfolio":{ + "name":"AssociateProductWithPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateProductWithPortfolioInput"}, + "output":{"shape":"AssociateProductWithPortfolioOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Associates the specified product with the specified portfolio.

    " + }, + "AssociateServiceActionWithProvisioningArtifact":{ + "name":"AssociateServiceActionWithProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateServiceActionWithProvisioningArtifactInput"}, + "output":{"shape":"AssociateServiceActionWithProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Associates a self-service action with a provisioning artifact.

    " + }, + "AssociateTagOptionWithResource":{ + "name":"AssociateTagOptionWithResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateTagOptionWithResourceInput"}, + "output":{"shape":"AssociateTagOptionWithResourceOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Associate the specified TagOption with the specified portfolio or product.

    " + }, + "BatchAssociateServiceActionWithProvisioningArtifact":{ + "name":"BatchAssociateServiceActionWithProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchAssociateServiceActionWithProvisioningArtifactInput"}, + "output":{"shape":"BatchAssociateServiceActionWithProvisioningArtifactOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Associates multiple self-service actions with provisioning artifacts.

    " + }, + "BatchDisassociateServiceActionFromProvisioningArtifact":{ + "name":"BatchDisassociateServiceActionFromProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDisassociateServiceActionFromProvisioningArtifactInput"}, + "output":{"shape":"BatchDisassociateServiceActionFromProvisioningArtifactOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Disassociates a batch of self-service actions from the specified provisioning artifact.

    " + }, + "CopyProduct":{ + "name":"CopyProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyProductInput"}, + "output":{"shape":"CopyProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Copies the specified source product to the specified target product or a new product.

    You can copy a product to the same account or another account. You can copy a product to the same region or another region.

    This operation is performed asynchronously. To track the progress of the operation, use DescribeCopyProductStatus.

    " + }, + "CreateConstraint":{ + "name":"CreateConstraint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConstraintInput"}, + "output":{"shape":"CreateConstraintOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"}, + {"shape":"DuplicateResourceException"} + ], + "documentation":"

    Creates a constraint.

    " + }, + "CreatePortfolio":{ + "name":"CreatePortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePortfolioInput"}, + "output":{"shape":"CreatePortfolioOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Creates a portfolio.

    " + }, + "CreatePortfolioShare":{ + "name":"CreatePortfolioShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePortfolioShareInput"}, + "output":{"shape":"CreatePortfolioShareOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidParametersException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Shares the specified portfolio with the specified account or organization node. Shares to an organization node can only be created by the master account of an Organization. AWSOrganizationsAccess must be enabled in order to create a portfolio share to an organization node.

    " + }, + "CreateProduct":{ + "name":"CreateProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProductInput"}, + "output":{"shape":"CreateProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Creates a product.

    " + }, + "CreateProvisionedProductPlan":{ + "name":"CreateProvisionedProductPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProvisionedProductPlanInput"}, + "output":{"shape":"CreateProvisionedProductPlanOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Creates a plan. A plan includes the list of resources to be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.

    You can create one plan per provisioned product. To create a plan for an existing provisioned product, the product status must be AVAILBLE or TAINTED.

    To view the resource changes in the change set, use DescribeProvisionedProductPlan. To create or modify the provisioned product, use ExecuteProvisionedProductPlan.

    " + }, + "CreateProvisioningArtifact":{ + "name":"CreateProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProvisioningArtifactInput"}, + "output":{"shape":"CreateProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a provisioning artifact (also known as a version) for the specified product.

    You cannot create a provisioning artifact for a product that was shared with you.

    " + }, + "CreateServiceAction":{ + "name":"CreateServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServiceActionInput"}, + "output":{"shape":"CreateServiceActionOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a self-service action.

    " + }, + "CreateTagOption":{ + "name":"CreateTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagOptionInput"}, + "output":{"shape":"CreateTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a TagOption.

    " + }, + "DeleteConstraint":{ + "name":"DeleteConstraint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConstraintInput"}, + "output":{"shape":"DeleteConstraintOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Deletes the specified constraint.

    " + }, + "DeletePortfolio":{ + "name":"DeletePortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePortfolioInput"}, + "output":{"shape":"DeletePortfolioOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"ResourceInUseException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Deletes the specified portfolio.

    You cannot delete a portfolio if it was shared with you or if it has associated products, users, constraints, or shared accounts.

    " + }, + "DeletePortfolioShare":{ + "name":"DeletePortfolioShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePortfolioShareInput"}, + "output":{"shape":"DeletePortfolioShareOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Stops sharing the specified portfolio with the specified account or organization node. Shares to an organization node can only be deleted by the master account of an Organization.

    " + }, + "DeleteProduct":{ + "name":"DeleteProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProductInput"}, + "output":{"shape":"DeleteProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParametersException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Deletes the specified product.

    You cannot delete a product if it was shared with you or is associated with a portfolio.

    " + }, + "DeleteProvisionedProductPlan":{ + "name":"DeleteProvisionedProductPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProvisionedProductPlanInput"}, + "output":{"shape":"DeleteProvisionedProductPlanOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the specified plan.

    " + }, + "DeleteProvisioningArtifact":{ + "name":"DeleteProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProvisioningArtifactInput"}, + "output":{"shape":"DeleteProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Deletes the specified provisioning artifact (also known as a version) for the specified product.

    You cannot delete a provisioning artifact associated with a product that was shared with you. You cannot delete the last provisioning artifact for a product, because a product must have at least one provisioning artifact.

    " + }, + "DeleteServiceAction":{ + "name":"DeleteServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceActionInput"}, + "output":{"shape":"DeleteServiceActionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "documentation":"

    Deletes a self-service action.

    " + }, + "DeleteTagOption":{ + "name":"DeleteTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagOptionInput"}, + "output":{"shape":"DeleteTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceInUseException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the specified TagOption.

    You cannot delete a TagOption if it is associated with a product or portfolio.

    " + }, + "DescribeConstraint":{ + "name":"DescribeConstraint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConstraintInput"}, + "output":{"shape":"DescribeConstraintOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified constraint.

    " + }, + "DescribeCopyProductStatus":{ + "name":"DescribeCopyProductStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCopyProductStatusInput"}, + "output":{"shape":"DescribeCopyProductStatusOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets the status of the specified copy product operation.

    " + }, + "DescribePortfolio":{ + "name":"DescribePortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePortfolioInput"}, + "output":{"shape":"DescribePortfolioOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified portfolio.

    " + }, + "DescribePortfolioShareStatus":{ + "name":"DescribePortfolioShareStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePortfolioShareStatusInput"}, + "output":{"shape":"DescribePortfolioShareStatusOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Gets the status of the specified portfolio share operation. This API can only be called by the master account in the organization.

    " + }, + "DescribeProduct":{ + "name":"DescribeProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProductInput"}, + "output":{"shape":"DescribeProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the specified product.

    " + }, + "DescribeProductAsAdmin":{ + "name":"DescribeProductAsAdmin", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProductAsAdminInput"}, + "output":{"shape":"DescribeProductAsAdminOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified product. This operation is run with administrator access.

    " + }, + "DescribeProductView":{ + "name":"DescribeProductView", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProductViewInput"}, + "output":{"shape":"DescribeProductViewOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the specified product.

    " + }, + "DescribeProvisionedProduct":{ + "name":"DescribeProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProvisionedProductInput"}, + "output":{"shape":"DescribeProvisionedProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified provisioned product.

    " + }, + "DescribeProvisionedProductPlan":{ + "name":"DescribeProvisionedProductPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProvisionedProductPlanInput"}, + "output":{"shape":"DescribeProvisionedProductPlanOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the resource changes for the specified plan.

    " + }, + "DescribeProvisioningArtifact":{ + "name":"DescribeProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProvisioningArtifactInput"}, + "output":{"shape":"DescribeProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified provisioning artifact (also known as a version) for the specified product.

    " + }, + "DescribeProvisioningParameters":{ + "name":"DescribeProvisioningParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProvisioningParametersInput"}, + "output":{"shape":"DescribeProvisioningParametersOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the configuration required to provision the specified product using the specified provisioning artifact.

    If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to ProvisionProduct, do not include conflicted TagOption keys as tags, or this causes the error \"Parameter validation failed: Missing required parameter in Tags[N]:Value\". Tag the provisioned product with the value sc-tagoption-conflict-portfolioId-productId.

    " + }, + "DescribeRecord":{ + "name":"DescribeRecord", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeRecordInput"}, + "output":{"shape":"DescribeRecordOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified request operation.

    Use this operation after calling a request operation (for example, ProvisionProduct, TerminateProvisionedProduct, or UpdateProvisionedProduct).

    If a provisioned product was transferred to a new owner using UpdateProvisionedProductProperties, the new owner will be able to describe all past records for that product. The previous owner will no longer be able to describe the records, but will be able to use ListRecordHistory to see the product's history from when he was the owner.

    " + }, + "DescribeServiceAction":{ + "name":"DescribeServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceActionInput"}, + "output":{"shape":"DescribeServiceActionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Describes a self-service action.

    " + }, + "DescribeServiceActionExecutionParameters":{ + "name":"DescribeServiceActionExecutionParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServiceActionExecutionParametersInput"}, + "output":{"shape":"DescribeServiceActionExecutionParametersOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "DescribeTagOption":{ + "name":"DescribeTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagOptionInput"}, + "output":{"shape":"DescribeTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Gets information about the specified TagOption.

    " + }, + "DisableAWSOrganizationsAccess":{ + "name":"DisableAWSOrganizationsAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableAWSOrganizationsAccessInput"}, + "output":{"shape":"DisableAWSOrganizationsAccessOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Disable portfolio sharing through AWS Organizations feature. This feature will not delete your current shares but it will prevent you from creating new shares throughout your organization. Current shares will not be in sync with your organization structure if it changes after calling this API. This API can only be called by the master account in the organization.

    " + }, + "DisassociateBudgetFromResource":{ + "name":"DisassociateBudgetFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateBudgetFromResourceInput"}, + "output":{"shape":"DisassociateBudgetFromResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates the specified budget from the specified resource.

    " + }, + "DisassociatePrincipalFromPortfolio":{ + "name":"DisassociatePrincipalFromPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociatePrincipalFromPortfolioInput"}, + "output":{"shape":"DisassociatePrincipalFromPortfolioOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates a previously associated principal ARN from a specified portfolio.

    " + }, + "DisassociateProductFromPortfolio":{ + "name":"DisassociateProductFromPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateProductFromPortfolioInput"}, + "output":{"shape":"DisassociateProductFromPortfolioOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Disassociates the specified product from the specified portfolio.

    " + }, + "DisassociateServiceActionFromProvisioningArtifact":{ + "name":"DisassociateServiceActionFromProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateServiceActionFromProvisioningArtifactInput"}, + "output":{"shape":"DisassociateServiceActionFromProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates the specified self-service action association from the specified provisioning artifact.

    " + }, + "DisassociateTagOptionFromResource":{ + "name":"DisassociateTagOptionFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateTagOptionFromResourceInput"}, + "output":{"shape":"DisassociateTagOptionFromResourceOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Disassociates the specified TagOption from the specified resource.

    " + }, + "EnableAWSOrganizationsAccess":{ + "name":"EnableAWSOrganizationsAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EnableAWSOrganizationsAccessInput"}, + "output":{"shape":"EnableAWSOrganizationsAccessOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Enable portfolio sharing feature through AWS Organizations. This API will allow Service Catalog to receive updates on your organization in order to sync your shares with the current structure. This API can only be called by the master account in the organization.

    By calling this API Service Catalog will make a call to organizations:EnableAWSServiceAccess on your behalf so that your shares can be in sync with any changes in your AWS Organizations structure.

    " + }, + "ExecuteProvisionedProductPlan":{ + "name":"ExecuteProvisionedProductPlan", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecuteProvisionedProductPlanInput"}, + "output":{"shape":"ExecuteProvisionedProductPlanOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Provisions or modifies a product based on the resource changes for the specified plan.

    " + }, + "ExecuteProvisionedProductServiceAction":{ + "name":"ExecuteProvisionedProductServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ExecuteProvisionedProductServiceActionInput"}, + "output":{"shape":"ExecuteProvisionedProductServiceActionOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Executes a self-service action against a provisioned product.

    " + }, + "GetAWSOrganizationsAccessStatus":{ + "name":"GetAWSOrganizationsAccessStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAWSOrganizationsAccessStatusInput"}, + "output":{"shape":"GetAWSOrganizationsAccessStatusOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Get the Access Status for AWS Organization portfolio share feature. This API can only be called by the master account in the organization.

    " + }, + "ListAcceptedPortfolioShares":{ + "name":"ListAcceptedPortfolioShares", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAcceptedPortfolioSharesInput"}, + "output":{"shape":"ListAcceptedPortfolioSharesOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Lists all portfolios for which sharing was accepted by this account.

    " + }, + "ListBudgetsForResource":{ + "name":"ListBudgetsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListBudgetsForResourceInput"}, + "output":{"shape":"ListBudgetsForResourceOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all the budgets associated to the specified resource.

    " + }, + "ListConstraintsForPortfolio":{ + "name":"ListConstraintsForPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListConstraintsForPortfolioInput"}, + "output":{"shape":"ListConstraintsForPortfolioOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the constraints for the specified portfolio and product.

    " + }, + "ListLaunchPaths":{ + "name":"ListLaunchPaths", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLaunchPathsInput"}, + "output":{"shape":"ListLaunchPathsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the paths to the specified product. A path is how the user has access to a specified product, and is necessary when provisioning a product. A path also determines the constraints put on the product.

    " + }, + "ListOrganizationPortfolioAccess":{ + "name":"ListOrganizationPortfolioAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOrganizationPortfolioAccessInput"}, + "output":{"shape":"ListOrganizationPortfolioAccessOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Lists the organization nodes that have access to the specified portfolio. This API can only be called by the master account in the organization.

    " + }, + "ListPortfolioAccess":{ + "name":"ListPortfolioAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPortfolioAccessInput"}, + "output":{"shape":"ListPortfolioAccessOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the account IDs that have access to the specified portfolio.

    " + }, + "ListPortfolios":{ + "name":"ListPortfolios", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPortfoliosInput"}, + "output":{"shape":"ListPortfoliosOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all portfolios in the catalog.

    " + }, + "ListPortfoliosForProduct":{ + "name":"ListPortfoliosForProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPortfoliosForProductInput"}, + "output":{"shape":"ListPortfoliosForProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists all portfolios that the specified product is associated with.

    " + }, + "ListPrincipalsForPortfolio":{ + "name":"ListPrincipalsForPortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPrincipalsForPortfolioInput"}, + "output":{"shape":"ListPrincipalsForPortfolioOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all principal ARNs associated with the specified portfolio.

    " + }, + "ListProvisionedProductPlans":{ + "name":"ListProvisionedProductPlans", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProvisionedProductPlansInput"}, + "output":{"shape":"ListProvisionedProductPlansOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the plans for the specified provisioned product or all plans to which the user has access.

    " + }, + "ListProvisioningArtifacts":{ + "name":"ListProvisioningArtifacts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProvisioningArtifactsInput"}, + "output":{"shape":"ListProvisioningArtifactsOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all provisioning artifacts (also known as versions) for the specified product.

    " + }, + "ListProvisioningArtifactsForServiceAction":{ + "name":"ListProvisioningArtifactsForServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProvisioningArtifactsForServiceActionInput"}, + "output":{"shape":"ListProvisioningArtifactsForServiceActionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all provisioning artifacts (also known as versions) for the specified self-service action.

    " + }, + "ListRecordHistory":{ + "name":"ListRecordHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRecordHistoryInput"}, + "output":{"shape":"ListRecordHistoryOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the specified requests or all performed requests.

    " + }, + "ListResourcesForTagOption":{ + "name":"ListResourcesForTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesForTagOptionInput"}, + "output":{"shape":"ListResourcesForTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the resources associated with the specified TagOption.

    " + }, + "ListServiceActions":{ + "name":"ListServiceActions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceActionsInput"}, + "output":{"shape":"ListServiceActionsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists all self-service actions.

    " + }, + "ListServiceActionsForProvisioningArtifact":{ + "name":"ListServiceActionsForProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServiceActionsForProvisioningArtifactInput"}, + "output":{"shape":"ListServiceActionsForProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Returns a paginated list of self-service actions associated with the specified Product ID and Provisioning Artifact ID.

    " + }, + "ListStackInstancesForProvisionedProduct":{ + "name":"ListStackInstancesForProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStackInstancesForProvisionedProductInput"}, + "output":{"shape":"ListStackInstancesForProvisionedProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns summary information about stack instances that are associated with the specified CFN_STACKSET type provisioned product. You can filter for stack instances that are associated with a specific AWS account name or region.

    " + }, + "ListTagOptions":{ + "name":"ListTagOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagOptionsInput"}, + "output":{"shape":"ListTagOptionsOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the specified TagOptions or all TagOptions.

    " + }, + "ProvisionProduct":{ + "name":"ProvisionProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ProvisionProductInput"}, + "output":{"shape":"ProvisionProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DuplicateResourceException"} + ], + "documentation":"

    Provisions the specified product.

    A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using DescribeRecord.

    If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error \"Parameter validation failed: Missing required parameter in Tags[N]:Value\".

    " + }, + "RejectPortfolioShare":{ + "name":"RejectPortfolioShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RejectPortfolioShareInput"}, + "output":{"shape":"RejectPortfolioShareOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Rejects an offer to share the specified portfolio.

    " + }, + "ScanProvisionedProducts":{ + "name":"ScanProvisionedProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ScanProvisionedProductsInput"}, + "output":{"shape":"ScanProvisionedProductsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Lists the provisioned products that are available (not terminated).

    To use additional filtering, see SearchProvisionedProducts.

    " + }, + "SearchProducts":{ + "name":"SearchProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchProductsInput"}, + "output":{"shape":"SearchProductsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the products to which the caller has access.

    " + }, + "SearchProductsAsAdmin":{ + "name":"SearchProductsAsAdmin", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchProductsAsAdminInput"}, + "output":{"shape":"SearchProductsAsAdminOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the products for the specified portfolio or all products.

    " + }, + "SearchProvisionedProducts":{ + "name":"SearchProvisionedProducts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SearchProvisionedProductsInput"}, + "output":{"shape":"SearchProvisionedProductsOutput"}, + "errors":[ + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Gets information about the provisioned products that meet the specified criteria.

    " + }, + "TerminateProvisionedProduct":{ + "name":"TerminateProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateProvisionedProductInput"}, + "output":{"shape":"TerminateProvisionedProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Terminates the specified provisioned product.

    This operation does not delete any records associated with the provisioned product.

    You can check the status of this request using DescribeRecord.

    " + }, + "UpdateConstraint":{ + "name":"UpdateConstraint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConstraintInput"}, + "output":{"shape":"UpdateConstraintOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Updates the specified constraint.

    " + }, + "UpdatePortfolio":{ + "name":"UpdatePortfolio", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePortfolioInput"}, + "output":{"shape":"UpdatePortfolioOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Updates the specified portfolio.

    You cannot update a product that was shared with you.

    " + }, + "UpdateProduct":{ + "name":"UpdateProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProductInput"}, + "output":{"shape":"UpdateProductOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"}, + {"shape":"TagOptionNotMigratedException"} + ], + "documentation":"

    Updates the specified product.

    " + }, + "UpdateProvisionedProduct":{ + "name":"UpdateProvisionedProduct", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProvisionedProductInput"}, + "output":{"shape":"UpdateProvisionedProductOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Requests updates to the configuration of the specified provisioned product.

    If there are tags associated with the object, they cannot be updated or added. Depending on the specific updates requested, this operation can update with no interruption, with some interruption, or replace the provisioned product entirely.

    You can check the status of this request using DescribeRecord.

    " + }, + "UpdateProvisionedProductProperties":{ + "name":"UpdateProvisionedProductProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProvisionedProductPropertiesInput"}, + "output":{"shape":"UpdateProvisionedProductPropertiesOutput"}, + "errors":[ + {"shape":"InvalidParametersException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidStateException"} + ], + "documentation":"

    Requests updates to the properties of the specified provisioned product.

    " + }, + "UpdateProvisioningArtifact":{ + "name":"UpdateProvisioningArtifact", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateProvisioningArtifactInput"}, + "output":{"shape":"UpdateProvisioningArtifactOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Updates the specified provisioning artifact (also known as a version) for the specified product.

    You cannot update a provisioning artifact for a product that was shared with you.

    " + }, + "UpdateServiceAction":{ + "name":"UpdateServiceAction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceActionInput"}, + "output":{"shape":"UpdateServiceActionOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Updates a self-service action.

    " + }, + "UpdateTagOption":{ + "name":"UpdateTagOption", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTagOptionInput"}, + "output":{"shape":"UpdateTagOptionOutput"}, + "errors":[ + {"shape":"TagOptionNotMigratedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"InvalidParametersException"} + ], + "documentation":"

    Updates the specified TagOption.

    " + } + }, + "shapes":{ + "AcceptLanguage":{ + "type":"string", + "max":100 + }, + "AcceptPortfolioShareInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "PortfolioShareType":{ + "shape":"PortfolioShareType", + "documentation":"

    The type of shared portfolios to accept. The default is to accept imported portfolios.

    • AWS_ORGANIZATIONS - Accept portfolios shared by the master account of your organization.

    • IMPORTED - Accept imported portfolios.

    • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

    For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS

    " + } + } + }, + "AcceptPortfolioShareOutput":{ + "type":"structure", + "members":{ + } + }, + "AccessLevelFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"AccessLevelFilterKey", + "documentation":"

    The access level.

    • Account - Filter results based on the account.

    • Role - Filter results based on the federated role of the specified user.

    • User - Filter results based on the specified user.

    " + }, + "Value":{ + "shape":"AccessLevelFilterValue", + "documentation":"

    The user to which the access level applies. The only supported value is Self.

    " + } + }, + "documentation":"

    The access level to use to filter results.

    " + }, + "AccessLevelFilterKey":{ + "type":"string", + "enum":[ + "Account", + "Role", + "User" + ] + }, + "AccessLevelFilterValue":{"type":"string"}, + "AccessStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "UNDER_CHANGE", + "DISABLED" + ] + }, + "AccountId":{ + "type":"string", + "pattern":"^[0-9]{12}$" + }, + "AccountIds":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "AddTags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":20 + }, + "AllowedValue":{"type":"string"}, + "AllowedValues":{ + "type":"list", + "member":{"shape":"AllowedValue"} + }, + "ApproximateCount":{"type":"integer"}, + "AssociateBudgetWithResourceInput":{ + "type":"structure", + "required":[ + "BudgetName", + "ResourceId" + ], + "members":{ + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

    The name of the budget you want to associate.

    " + }, + "ResourceId":{ + "shape":"Id", + "documentation":"

    The resource identifier. Either a portfolio-id or a product-id.

    " + } + } + }, + "AssociateBudgetWithResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "AssociatePrincipalWithPortfolioInput":{ + "type":"structure", + "required":[ + "PortfolioId", + "PrincipalARN", + "PrincipalType" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "PrincipalARN":{ + "shape":"PrincipalARN", + "documentation":"

    The ARN of the principal (IAM user, role, or group).

    " + }, + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"

    The principal type. The supported value is IAM.

    " + } + } + }, + "AssociatePrincipalWithPortfolioOutput":{ + "type":"structure", + "members":{ + } + }, + "AssociateProductWithPortfolioInput":{ + "type":"structure", + "required":[ + "ProductId", + "PortfolioId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "SourcePortfolioId":{ + "shape":"Id", + "documentation":"

    The identifier of the source portfolio.

    " + } + } + }, + "AssociateProductWithPortfolioOutput":{ + "type":"structure", + "members":{ + } + }, + "AssociateServiceActionWithProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId", + "ServiceActionId" + ], + "members":{ + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + }, + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "AssociateServiceActionWithProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + } + }, + "AssociateTagOptionWithResourceInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagOptionId" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The resource identifier.

    " + }, + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + } + } + }, + "AssociateTagOptionWithResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "AttributeValue":{"type":"string"}, + "BatchAssociateServiceActionWithProvisioningArtifactInput":{ + "type":"structure", + "required":["ServiceActionAssociations"], + "members":{ + "ServiceActionAssociations":{ + "shape":"ServiceActionAssociations", + "documentation":"

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "BatchAssociateServiceActionWithProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "FailedServiceActionAssociations":{ + "shape":"FailedServiceActionAssociations", + "documentation":"

    An object that contains a list of errors, along with information to help you identify the self-service action.

    " + } + } + }, + "BatchDisassociateServiceActionFromProvisioningArtifactInput":{ + "type":"structure", + "required":["ServiceActionAssociations"], + "members":{ + "ServiceActionAssociations":{ + "shape":"ServiceActionAssociations", + "documentation":"

    One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "BatchDisassociateServiceActionFromProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "FailedServiceActionAssociations":{ + "shape":"FailedServiceActionAssociations", + "documentation":"

    An object that contains a list of errors, along with information to help you identify the self-service action.

    " + } + } + }, + "BudgetDetail":{ + "type":"structure", + "members":{ + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

    Name of the associated budget.

    " + } + }, + "documentation":"

    Information about a budget.

    " + }, + "BudgetName":{ + "type":"string", + "max":100, + "min":1 + }, + "Budgets":{ + "type":"list", + "member":{"shape":"BudgetDetail"} + }, + "CausingEntity":{"type":"string"}, + "ChangeAction":{ + "type":"string", + "enum":[ + "ADD", + "MODIFY", + "REMOVE" + ] + }, + "CloudWatchDashboard":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CloudWatchDashboardName", + "documentation":"

    The name of the CloudWatch dashboard.

    " + } + }, + "documentation":"

    Information about a CloudWatch dashboard.

    " + }, + "CloudWatchDashboardName":{"type":"string"}, + "CloudWatchDashboards":{ + "type":"list", + "member":{"shape":"CloudWatchDashboard"} + }, + "ConstraintDescription":{ + "type":"string", + "max":2000 + }, + "ConstraintDetail":{ + "type":"structure", + "members":{ + "ConstraintId":{ + "shape":"Id", + "documentation":"

    The identifier of the constraint.

    " + }, + "Type":{ + "shape":"ConstraintType", + "documentation":"

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • STACKSET

    • TEMPLATE

    " + }, + "Description":{ + "shape":"ConstraintDescription", + "documentation":"

    The description of the constraint.

    " + }, + "Owner":{ + "shape":"AccountId", + "documentation":"

    The owner of the constraint.

    " + } + }, + "documentation":"

    Information about a constraint.

    " + }, + "ConstraintDetails":{ + "type":"list", + "member":{"shape":"ConstraintDetail"} + }, + "ConstraintParameters":{"type":"string"}, + "ConstraintSummaries":{ + "type":"list", + "member":{"shape":"ConstraintSummary"} + }, + "ConstraintSummary":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ConstraintType", + "documentation":"

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • STACKSET

    • TEMPLATE

    " + }, + "Description":{ + "shape":"ConstraintDescription", + "documentation":"

    The description of the constraint.

    " + } + }, + "documentation":"

    Summary information about a constraint.

    " + }, + "ConstraintType":{ + "type":"string", + "max":1024, + "min":1 + }, + "CopyOption":{ + "type":"string", + "enum":["CopyTags"] + }, + "CopyOptions":{ + "type":"list", + "member":{"shape":"CopyOption"} + }, + "CopyProductInput":{ + "type":"structure", + "required":[ + "SourceProductArn", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "SourceProductArn":{ + "shape":"ProductArn", + "documentation":"

    The Amazon Resource Name (ARN) of the source product.

    " + }, + "TargetProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the target product. By default, a new product is created.

    " + }, + "TargetProductName":{ + "shape":"ProductViewName", + "documentation":"

    A name for the target product. The default is the name of the source product.

    " + }, + "SourceProvisioningArtifactIdentifiers":{ + "shape":"SourceProvisioningArtifactProperties", + "documentation":"

    The identifiers of the provisioning artifacts (also known as versions) of the product to copy. By default, all provisioning artifacts are copied.

    " + }, + "CopyOptions":{ + "shape":"CopyOptions", + "documentation":"

    The copy options. If the value is CopyTags, the tags from the source product are copied to the target product.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CopyProductOutput":{ + "type":"structure", + "members":{ + "CopyProductToken":{ + "shape":"Id", + "documentation":"

    The token to use to track the progress of the operation.

    " + } + } + }, + "CopyProductStatus":{ + "type":"string", + "enum":[ + "SUCCEEDED", + "IN_PROGRESS", + "FAILED" + ] + }, + "CreateConstraintInput":{ + "type":"structure", + "required":[ + "PortfolioId", + "ProductId", + "Parameters", + "Type", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "Parameters":{ + "shape":"ConstraintParameters", + "documentation":"

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    LAUNCH

    Specify the RoleArn property as follows:

    {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    NOTIFICATION

    Specify the NotificationArns property as follows:

    {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}

    RESOURCE_UPDATE

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    STACKSET

    Specify the Parameters property as follows:

    {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    TEMPLATE

    Specify the Rules property. For more information, see Template Constraint Rules.

    " + }, + "Type":{ + "shape":"ConstraintType", + "documentation":"

    The type of constraint.

    • LAUNCH

    • NOTIFICATION

    • RESOURCE_UPDATE

    • STACKSET

    • TEMPLATE

    " + }, + "Description":{ + "shape":"ConstraintDescription", + "documentation":"

    The description of the constraint.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CreateConstraintOutput":{ + "type":"structure", + "members":{ + "ConstraintDetail":{ + "shape":"ConstraintDetail", + "documentation":"

    Information about the constraint.

    " + }, + "ConstraintParameters":{ + "shape":"ConstraintParameters", + "documentation":"

    The constraint parameters.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "CreatePortfolioInput":{ + "type":"structure", + "required":[ + "DisplayName", + "ProviderName", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "DisplayName":{ + "shape":"PortfolioDisplayName", + "documentation":"

    The name to use for display purposes.

    " + }, + "Description":{ + "shape":"PortfolioDescription", + "documentation":"

    The description of the portfolio.

    " + }, + "ProviderName":{ + "shape":"ProviderName", + "documentation":"

    The name of the portfolio provider.

    " + }, + "Tags":{ + "shape":"AddTags", + "documentation":"

    One or more tags.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CreatePortfolioOutput":{ + "type":"structure", + "members":{ + "PortfolioDetail":{ + "shape":"PortfolioDetail", + "documentation":"

    Information about the portfolio.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the portfolio.

    " + } + } + }, + "CreatePortfolioShareInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The AWS account ID. For example, 123456789012.

    " + }, + "OrganizationNode":{ + "shape":"OrganizationNode", + "documentation":"

    The organization node to whom you are going to share. If OrganizationNode is passed in, PortfolioShare will be created for the node and its children (when applies), and a PortfolioShareToken will be returned in the output in order for the administrator to monitor the status of the PortfolioShare creation process.

    " + } + } + }, + "CreatePortfolioShareOutput":{ + "type":"structure", + "members":{ + "PortfolioShareToken":{ + "shape":"Id", + "documentation":"

    The portfolio share unique identifier. This will only be returned if portfolio is shared to an organization node.

    " + } + } + }, + "CreateProductInput":{ + "type":"structure", + "required":[ + "Name", + "Owner", + "ProductType", + "ProvisioningArtifactParameters", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Name":{ + "shape":"ProductViewName", + "documentation":"

    The name of the product.

    " + }, + "Owner":{ + "shape":"ProductViewOwner", + "documentation":"

    The owner of the product.

    " + }, + "Description":{ + "shape":"ProductViewShortDescription", + "documentation":"

    The description of the product.

    " + }, + "Distributor":{ + "shape":"ProductViewOwner", + "documentation":"

    The distributor of the product.

    " + }, + "SupportDescription":{ + "shape":"SupportDescription", + "documentation":"

    The support information about the product.

    " + }, + "SupportEmail":{ + "shape":"SupportEmail", + "documentation":"

    The contact email for product support.

    " + }, + "SupportUrl":{ + "shape":"SupportUrl", + "documentation":"

    The contact URL for product support.

    " + }, + "ProductType":{ + "shape":"ProductType", + "documentation":"

    The type of product.

    " + }, + "Tags":{ + "shape":"AddTags", + "documentation":"

    One or more tags.

    " + }, + "ProvisioningArtifactParameters":{ + "shape":"ProvisioningArtifactProperties", + "documentation":"

    The configuration of the provisioning artifact.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CreateProductOutput":{ + "type":"structure", + "members":{ + "ProductViewDetail":{ + "shape":"ProductViewDetail", + "documentation":"

    Information about the product view.

    " + }, + "ProvisioningArtifactDetail":{ + "shape":"ProvisioningArtifactDetail", + "documentation":"

    Information about the provisioning artifact.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the product.

    " + } + } + }, + "CreateProvisionedProductPlanInput":{ + "type":"structure", + "required":[ + "PlanName", + "PlanType", + "ProductId", + "ProvisionedProductName", + "ProvisioningArtifactId", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PlanName":{ + "shape":"ProvisionedProductPlanName", + "documentation":"

    The name of the plan.

    " + }, + "PlanType":{ + "shape":"ProvisionedProductPlanType", + "documentation":"

    The plan type.

    " + }, + "NotificationArns":{ + "shape":"NotificationArns", + "documentation":"

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisionedProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "ProvisioningParameters":{ + "shape":"UpdateProvisioningParameters", + "documentation":"

    Parameters specified by the administrator that are required for provisioning the product.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    One or more tags.

    If the plan is for an existing provisioned product, the product must have a RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    " + } + } + }, + "CreateProvisionedProductPlanOutput":{ + "type":"structure", + "members":{ + "PlanName":{ + "shape":"ProvisionedProductPlanName", + "documentation":"

    The name of the plan.

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "ProvisionProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisionedProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + } + } + }, + "CreateProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "Parameters", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "Parameters":{ + "shape":"ProvisioningArtifactProperties", + "documentation":"

    The configuration for the provisioning artifact.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CreateProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactDetail":{ + "shape":"ProvisioningArtifactDetail", + "documentation":"

    Information about the provisioning artifact.

    " + }, + "Info":{ + "shape":"ProvisioningArtifactInfo", + "documentation":"

    The URL of the CloudFormation template in Amazon S3, in JSON format.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "CreateServiceActionInput":{ + "type":"structure", + "required":[ + "Name", + "DefinitionType", + "Definition", + "IdempotencyToken" + ], + "members":{ + "Name":{ + "shape":"ServiceActionName", + "documentation":"

    The self-service action name.

    " + }, + "DefinitionType":{ + "shape":"ServiceActionDefinitionType", + "documentation":"

    The service action definition type. For example, SSM_AUTOMATION.

    " + }, + "Definition":{ + "shape":"ServiceActionDefinitionMap", + "documentation":"

    The self-service action definition. Can be one of the following:

    Name

    The name of the AWS Systems Manager Document. For example, AWS-RestartEC2Instance.

    Version

    The AWS Systems Manager automation document version. For example, \"Version\": \"1\"

    AssumeRole

    The Amazon Resource Name (ARN) of the role that performs the self-service actions on your behalf. For example, \"AssumeRole\": \"arn:aws:iam::12345678910:role/ActionRole\".

    To reuse the provisioned product launch role, set to \"AssumeRole\": \"LAUNCH_ROLE\".

    Parameters

    The list of parameters in JSON format.

    For example: [{\\\"Name\\\":\\\"InstanceId\\\",\\\"Type\\\":\\\"TARGET\\\"}].

    " + }, + "Description":{ + "shape":"ServiceActionDescription", + "documentation":"

    The self-service action description.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "CreateServiceActionOutput":{ + "type":"structure", + "members":{ + "ServiceActionDetail":{ + "shape":"ServiceActionDetail", + "documentation":"

    An object containing information about the self-service action.

    " + } + } + }, + "CreateTagOptionInput":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"

    The TagOption key.

    " + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"

    The TagOption value.

    " + } + } + }, + "CreateTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"

    Information about the TagOption.

    " + } + } + }, + "CreatedTime":{"type":"timestamp"}, + "CreationTime":{"type":"timestamp"}, + "DefaultValue":{"type":"string"}, + "DeleteConstraintInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the constraint.

    " + } + } + }, + "DeleteConstraintOutput":{ + "type":"structure", + "members":{ + } + }, + "DeletePortfolioInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + } + } + }, + "DeletePortfolioOutput":{ + "type":"structure", + "members":{ + } + }, + "DeletePortfolioShareInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "AccountId":{ + "shape":"AccountId", + "documentation":"

    The AWS account ID.

    " + }, + "OrganizationNode":{ + "shape":"OrganizationNode", + "documentation":"

    The organization node to whom you are going to stop sharing.

    " + } + } + }, + "DeletePortfolioShareOutput":{ + "type":"structure", + "members":{ + "PortfolioShareToken":{ + "shape":"Id", + "documentation":"

    The portfolio share unique identifier. This will only be returned if delete is made to an organization node.

    " + } + } + }, + "DeleteProductInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + } + } + }, + "DeleteProductOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteProvisionedProductPlanInput":{ + "type":"structure", + "required":["PlanId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "IgnoreErrors":{ + "shape":"IgnoreErrors", + "documentation":"

    If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

    " + } + } + }, + "DeleteProvisionedProductPlanOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + } + } + }, + "DeleteProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteServiceActionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "DeleteServiceActionOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteTagOptionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + } + } + }, + "DeleteTagOptionOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeConstraintInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the constraint.

    " + } + } + }, + "DescribeConstraintOutput":{ + "type":"structure", + "members":{ + "ConstraintDetail":{ + "shape":"ConstraintDetail", + "documentation":"

    Information about the constraint.

    " + }, + "ConstraintParameters":{ + "shape":"ConstraintParameters", + "documentation":"

    The constraint parameters.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "DescribeCopyProductStatusInput":{ + "type":"structure", + "required":["CopyProductToken"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "CopyProductToken":{ + "shape":"Id", + "documentation":"

    The token for the copy product operation. This token is returned by CopyProduct.

    " + } + } + }, + "DescribeCopyProductStatusOutput":{ + "type":"structure", + "members":{ + "CopyProductStatus":{ + "shape":"CopyProductStatus", + "documentation":"

    The status of the copy product operation.

    " + }, + "TargetProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the copied product.

    " + }, + "StatusDetail":{ + "shape":"StatusDetail", + "documentation":"

    The status message.

    " + } + } + }, + "DescribePortfolioInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + } + } + }, + "DescribePortfolioOutput":{ + "type":"structure", + "members":{ + "PortfolioDetail":{ + "shape":"PortfolioDetail", + "documentation":"

    Information about the portfolio.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the portfolio.

    " + }, + "TagOptions":{ + "shape":"TagOptionDetails", + "documentation":"

    Information about the TagOptions associated with the portfolio.

    " + }, + "Budgets":{ + "shape":"Budgets", + "documentation":"

    Information about the associated budgets.

    " + } + } + }, + "DescribePortfolioShareStatusInput":{ + "type":"structure", + "required":["PortfolioShareToken"], + "members":{ + "PortfolioShareToken":{ + "shape":"Id", + "documentation":"

    The token for the portfolio share operation. This token is returned either by CreatePortfolioShare or by DeletePortfolioShare.

    " + } + } + }, + "DescribePortfolioShareStatusOutput":{ + "type":"structure", + "members":{ + "PortfolioShareToken":{ + "shape":"Id", + "documentation":"

    The token for the portfolio share operation. For example, share-6v24abcdefghi.

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "OrganizationNodeValue":{ + "shape":"OrganizationNodeValue", + "documentation":"

    Organization node identifier. It can be either account id, organizational unit id or organization id.

    " + }, + "Status":{ + "shape":"ShareStatus", + "documentation":"

    Status of the portfolio share operation.

    " + }, + "ShareDetails":{ + "shape":"ShareDetails", + "documentation":"

    Information about the portfolio share operation.

    " + } + } + }, + "DescribeProductAsAdminInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + } + } + }, + "DescribeProductAsAdminOutput":{ + "type":"structure", + "members":{ + "ProductViewDetail":{ + "shape":"ProductViewDetail", + "documentation":"

    Information about the product view.

    " + }, + "ProvisioningArtifactSummaries":{ + "shape":"ProvisioningArtifactSummaries", + "documentation":"

    Information about the provisioning artifacts (also known as versions) for the specified product.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the product.

    " + }, + "TagOptions":{ + "shape":"TagOptionDetails", + "documentation":"

    Information about the TagOptions associated with the product.

    " + }, + "Budgets":{ + "shape":"Budgets", + "documentation":"

    Information about the associated budgets.

    " + } + } + }, + "DescribeProductInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + } + } + }, + "DescribeProductOutput":{ + "type":"structure", + "members":{ + "ProductViewSummary":{ + "shape":"ProductViewSummary", + "documentation":"

    Summary information about the product view.

    " + }, + "ProvisioningArtifacts":{ + "shape":"ProvisioningArtifacts", + "documentation":"

    Information about the provisioning artifacts for the specified product.

    " + }, + "Budgets":{ + "shape":"Budgets", + "documentation":"

    Information about the associated budgets.

    " + } + } + }, + "DescribeProductViewInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The product view identifier.

    " + } + } + }, + "DescribeProductViewOutput":{ + "type":"structure", + "members":{ + "ProductViewSummary":{ + "shape":"ProductViewSummary", + "documentation":"

    Summary information about the product.

    " + }, + "ProvisioningArtifacts":{ + "shape":"ProvisioningArtifacts", + "documentation":"

    Information about the provisioning artifacts for the product.

    " + } + } + }, + "DescribeProvisionedProductInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The provisioned product identifier.

    " + } + } + }, + "DescribeProvisionedProductOutput":{ + "type":"structure", + "members":{ + "ProvisionedProductDetail":{ + "shape":"ProvisionedProductDetail", + "documentation":"

    Information about the provisioned product.

    " + }, + "CloudWatchDashboards":{ + "shape":"CloudWatchDashboards", + "documentation":"

    Any CloudWatch dashboards that were created when provisioning the product.

    " + } + } + }, + "DescribeProvisionedProductPlanInput":{ + "type":"structure", + "required":["PlanId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "DescribeProvisionedProductPlanOutput":{ + "type":"structure", + "members":{ + "ProvisionedProductPlanDetails":{ + "shape":"ProvisionedProductPlanDetails", + "documentation":"

    Information about the plan.

    " + }, + "ResourceChanges":{ + "shape":"ResourceChanges", + "documentation":"

    Information about the resource changes that will occur when the plan is executed.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "DescribeProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProvisioningArtifactId", + "ProductId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "Verbose":{ + "shape":"Verbose", + "documentation":"

    Indicates whether a verbose level of detail is enabled.

    " + } + } + }, + "DescribeProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactDetail":{ + "shape":"ProvisioningArtifactDetail", + "documentation":"

    Information about the provisioning artifact.

    " + }, + "Info":{ + "shape":"ProvisioningArtifactInfo", + "documentation":"

    The URL of the CloudFormation template in Amazon S3.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "DescribeProvisioningParametersInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    " + } + } + }, + "DescribeProvisioningParametersOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactParameters":{ + "shape":"ProvisioningArtifactParameters", + "documentation":"

    Information about the parameters used to provision the product.

    " + }, + "ConstraintSummaries":{ + "shape":"ConstraintSummaries", + "documentation":"

    Information about the constraints used to provision the product.

    " + }, + "UsageInstructions":{ + "shape":"UsageInstructions", + "documentation":"

    Any additional metadata specifically related to the provisioning of the product. For example, see the Version field of the CloudFormation template.

    " + }, + "TagOptions":{ + "shape":"TagOptionSummaries", + "documentation":"

    Information about the TagOptions associated with the resource.

    " + }, + "ProvisioningArtifactPreferences":{ + "shape":"ProvisioningArtifactPreferences", + "documentation":"

    An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.

    " + } + } + }, + "DescribeRecordInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The record identifier of the provisioned product. This identifier is returned by the request operation.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + } + } + }, + "DescribeRecordOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    Information about the product.

    " + }, + "RecordOutputs":{ + "shape":"RecordOutputs", + "documentation":"

    Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "DescribeServiceActionExecutionParametersInput":{ + "type":"structure", + "required":[ + "ProvisionedProductId", + "ServiceActionId" + ], + "members":{ + "ProvisionedProductId":{"shape":"Id"}, + "ServiceActionId":{"shape":"Id"}, + "AcceptLanguage":{"shape":"AcceptLanguage"} + } + }, + "DescribeServiceActionExecutionParametersOutput":{ + "type":"structure", + "members":{ + "ServiceActionParameters":{"shape":"ExecutionParameters"} + } + }, + "DescribeServiceActionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The self-service action identifier.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "DescribeServiceActionOutput":{ + "type":"structure", + "members":{ + "ServiceActionDetail":{ + "shape":"ServiceActionDetail", + "documentation":"

    Detailed information about the self-service action.

    " + } + } + }, + "DescribeTagOptionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + } + } + }, + "DescribeTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"

    Information about the TagOption.

    " + } + } + }, + "Description":{"type":"string"}, + "DisableAWSOrganizationsAccessInput":{ + "type":"structure", + "members":{ + } + }, + "DisableAWSOrganizationsAccessOutput":{ + "type":"structure", + "members":{ + } + }, + "DisableTemplateValidation":{"type":"boolean"}, + "DisassociateBudgetFromResourceInput":{ + "type":"structure", + "required":[ + "BudgetName", + "ResourceId" + ], + "members":{ + "BudgetName":{ + "shape":"BudgetName", + "documentation":"

    The name of the budget you want to disassociate.

    " + }, + "ResourceId":{ + "shape":"Id", + "documentation":"

    The resource identifier you want to disassociate from. Either a portfolio-id or a product-id.

    " + } + } + }, + "DisassociateBudgetFromResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "DisassociatePrincipalFromPortfolioInput":{ + "type":"structure", + "required":[ + "PortfolioId", + "PrincipalARN" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "PrincipalARN":{ + "shape":"PrincipalARN", + "documentation":"

    The ARN of the principal (IAM user, role, or group).

    " + } + } + }, + "DisassociatePrincipalFromPortfolioOutput":{ + "type":"structure", + "members":{ + } + }, + "DisassociateProductFromPortfolioInput":{ + "type":"structure", + "required":[ + "ProductId", + "PortfolioId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + } + } + }, + "DisassociateProductFromPortfolioOutput":{ + "type":"structure", + "members":{ + } + }, + "DisassociateServiceActionFromProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId", + "ServiceActionId" + ], + "members":{ + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + }, + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "DisassociateServiceActionFromProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + } + }, + "DisassociateTagOptionFromResourceInput":{ + "type":"structure", + "required":[ + "ResourceId", + "TagOptionId" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The resource identifier.

    " + }, + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + } + } + }, + "DisassociateTagOptionFromResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "DuplicateResourceException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified resource is a duplicate.

    ", + "exception":true + }, + "EnableAWSOrganizationsAccessInput":{ + "type":"structure", + "members":{ + } + }, + "EnableAWSOrganizationsAccessOutput":{ + "type":"structure", + "members":{ + } + }, + "Error":{"type":"string"}, + "ErrorCode":{"type":"string"}, + "ErrorDescription":{"type":"string"}, + "EvaluationType":{ + "type":"string", + "enum":[ + "STATIC", + "DYNAMIC" + ] + }, + "ExecuteProvisionedProductPlanInput":{ + "type":"structure", + "required":[ + "PlanId", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    ", + "idempotencyToken":true + } + } + }, + "ExecuteProvisionedProductPlanOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    Information about the result of provisioning the product.

    " + } + } + }, + "ExecuteProvisionedProductServiceActionInput":{ + "type":"structure", + "required":[ + "ProvisionedProductId", + "ServiceActionId", + "ExecuteToken" + ], + "members":{ + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "ExecuteToken":{ + "shape":"IdempotencyToken", + "documentation":"

    An idempotency token that uniquely identifies the execute request.

    ", + "idempotencyToken":true + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Parameters":{"shape":"ExecutionParameterMap"} + } + }, + "ExecuteProvisionedProductServiceActionOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    An object containing detailed information about the result of provisioning the product.

    " + } + } + }, + "ExecutionParameter":{ + "type":"structure", + "members":{ + "Name":{"shape":"ExecutionParameterKey"}, + "Type":{"shape":"ExecutionParameterType"}, + "DefaultValues":{"shape":"ExecutionParameterValueList"} + } + }, + "ExecutionParameterKey":{ + "type":"string", + "max":50, + "min":1 + }, + "ExecutionParameterMap":{ + "type":"map", + "key":{"shape":"ExecutionParameterKey"}, + "value":{"shape":"ExecutionParameterValueList"}, + "max":200, + "min":1 + }, + "ExecutionParameterType":{ + "type":"string", + "max":1024, + "min":1 + }, + "ExecutionParameterValue":{ + "type":"string", + "max":512, + "min":0 + }, + "ExecutionParameterValueList":{ + "type":"list", + "member":{"shape":"ExecutionParameterValue"}, + "max":25, + "min":0 + }, + "ExecutionParameters":{ + "type":"list", + "member":{"shape":"ExecutionParameter"} + }, + "FailedServiceActionAssociation":{ + "type":"structure", + "members":{ + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + }, + "ErrorCode":{ + "shape":"ServiceActionAssociationErrorCode", + "documentation":"

    The error code. Valid values are listed below.

    " + }, + "ErrorMessage":{ + "shape":"ServiceActionAssociationErrorMessage", + "documentation":"

    A text description of the error.

    " + } + }, + "documentation":"

    An object containing information about the error, along with identifying information about the self-service action and its associations.

    " + }, + "FailedServiceActionAssociations":{ + "type":"list", + "member":{"shape":"FailedServiceActionAssociation"}, + "max":50 + }, + "GetAWSOrganizationsAccessStatusInput":{ + "type":"structure", + "members":{ + } + }, + "GetAWSOrganizationsAccessStatusOutput":{ + "type":"structure", + "members":{ + "AccessStatus":{ + "shape":"AccessStatus", + "documentation":"

    The status of the portfolio share feature.

    " + } + } + }, + "HasDefaultPath":{"type":"boolean"}, + "Id":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^[a-zA-Z0-9_\\-]*" + }, + "IdempotencyToken":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "IgnoreErrors":{"type":"boolean"}, + "InstructionType":{"type":"string"}, + "InstructionValue":{"type":"string"}, + "InvalidParametersException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    One or more parameters provided to the operation are not valid.

    ", + "exception":true + }, + "InvalidStateException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An attempt was made to modify a resource that is in a state that is not valid. Check your resources to ensure that they are in valid states before retrying the operation.

    ", + "exception":true + }, + "LastRequestId":{"type":"string"}, + "LaunchPathSummaries":{ + "type":"list", + "member":{"shape":"LaunchPathSummary"} + }, + "LaunchPathSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the product path.

    " + }, + "ConstraintSummaries":{ + "shape":"ConstraintSummaries", + "documentation":"

    The constraints on the portfolio-product relationship.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The tags associated with this product path.

    " + }, + "Name":{ + "shape":"PortfolioName", + "documentation":"

    The name of the portfolio to which the user was assigned.

    " + } + }, + "documentation":"

    Summary information about a product path for a user.

    " + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The current limits of the service would have been exceeded by this operation. Decrease your resource use or increase your service limits and retry the operation.

    ", + "exception":true + }, + "ListAcceptedPortfolioSharesInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PortfolioShareType":{ + "shape":"PortfolioShareType", + "documentation":"

    The type of shared portfolios to list. The default is to list imported portfolios.

    • AWS_ORGANIZATIONS - List portfolios shared by the master account of your organization

    • AWS_SERVICECATALOG - List default portfolios

    • IMPORTED - List imported portfolios

    " + } + } + }, + "ListAcceptedPortfolioSharesOutput":{ + "type":"structure", + "members":{ + "PortfolioDetails":{ + "shape":"PortfolioDetails", + "documentation":"

    Information about the portfolios.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListBudgetsForResourceInput":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ResourceId":{ + "shape":"Id", + "documentation":"

    The resource identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListBudgetsForResourceOutput":{ + "type":"structure", + "members":{ + "Budgets":{ + "shape":"Budgets", + "documentation":"

    Information about the associated budgets.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListConstraintsForPortfolioInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListConstraintsForPortfolioOutput":{ + "type":"structure", + "members":{ + "ConstraintDetails":{ + "shape":"ConstraintDetails", + "documentation":"

    Information about the constraints.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListLaunchPathsInput":{ + "type":"structure", + "required":["ProductId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListLaunchPathsOutput":{ + "type":"structure", + "members":{ + "LaunchPathSummaries":{ + "shape":"LaunchPathSummaries", + "documentation":"

    Information about the launch path.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListOrganizationPortfolioAccessInput":{ + "type":"structure", + "required":[ + "PortfolioId", + "OrganizationNodeType" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier. For example, port-2abcdext3y5fk.

    " + }, + "OrganizationNodeType":{ + "shape":"OrganizationNodeType", + "documentation":"

    The organization node type that will be returned in the output.

    • ORGANIZATION - Organization that has access to the portfolio.

    • ORGANIZATIONAL_UNIT - Organizational unit that has access to the portfolio within your organization.

    • ACCOUNT - Account that has access to the portfolio within your organization.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + } + } + }, + "ListOrganizationPortfolioAccessOutput":{ + "type":"structure", + "members":{ + "OrganizationNodes":{ + "shape":"OrganizationNodes", + "documentation":"

    Displays information about the organization nodes.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListPortfolioAccessInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + } + } + }, + "ListPortfolioAccessOutput":{ + "type":"structure", + "members":{ + "AccountIds":{ + "shape":"AccountIds", + "documentation":"

    Information about the AWS accounts with access to the portfolio.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListPortfoliosForProductInput":{ + "type":"structure", + "required":["ProductId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + } + } + }, + "ListPortfoliosForProductOutput":{ + "type":"structure", + "members":{ + "PortfolioDetails":{ + "shape":"PortfolioDetails", + "documentation":"

    Information about the portfolios.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListPortfoliosInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + } + } + }, + "ListPortfoliosOutput":{ + "type":"structure", + "members":{ + "PortfolioDetails":{ + "shape":"PortfolioDetails", + "documentation":"

    Information about the portfolios.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListPrincipalsForPortfolioInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListPrincipalsForPortfolioOutput":{ + "type":"structure", + "members":{ + "Principals":{ + "shape":"Principals", + "documentation":"

    The IAM principals (users or roles) associated with the portfolio.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListProvisionedProductPlansInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProvisionProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "AccessLevelFilter":{ + "shape":"AccessLevelFilter", + "documentation":"

    The access level to use to obtain results. The default is User.

    " + } + } + }, + "ListProvisionedProductPlansOutput":{ + "type":"structure", + "members":{ + "ProvisionedProductPlans":{ + "shape":"ProvisionedProductPlans", + "documentation":"

    Information about the plans.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListProvisioningArtifactsForServiceActionInput":{ + "type":"structure", + "required":["ServiceActionId"], + "members":{ + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "ListProvisioningArtifactsForServiceActionOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactViews":{ + "shape":"ProvisioningArtifactViews", + "documentation":"

    An array of objects with information about product views and provisioning artifacts.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListProvisioningArtifactsInput":{ + "type":"structure", + "required":["ProductId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + } + } + }, + "ListProvisioningArtifactsOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactDetails":{ + "shape":"ProvisioningArtifactDetails", + "documentation":"

    Information about the provisioning artifacts.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListRecordHistoryInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "AccessLevelFilter":{ + "shape":"AccessLevelFilter", + "documentation":"

    The access level to use to obtain results. The default is User.

    " + }, + "SearchFilter":{ + "shape":"ListRecordHistorySearchFilter", + "documentation":"

    The search filter to scope the results.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListRecordHistoryOutput":{ + "type":"structure", + "members":{ + "RecordDetails":{ + "shape":"RecordDetails", + "documentation":"

    The records, in reverse chronological order.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListRecordHistorySearchFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"SearchFilterKey", + "documentation":"

    The filter key.

    • product - Filter results based on the specified product identifier.

    • provisionedproduct - Filter results based on the provisioned product identifier.

    " + }, + "Value":{ + "shape":"SearchFilterValue", + "documentation":"

    The filter value.

    " + } + }, + "documentation":"

    The search filter to use when listing history records.

    " + }, + "ListResourcesForTagOptionInput":{ + "type":"structure", + "required":["TagOptionId"], + "members":{ + "TagOptionId":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The resource type.

    • Portfolio

    • Product

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListResourcesForTagOptionOutput":{ + "type":"structure", + "members":{ + "ResourceDetails":{ + "shape":"ResourceDetails", + "documentation":"

    Information about the resources.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListServiceActionsForProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "ListServiceActionsForProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "ServiceActionSummaries":{ + "shape":"ServiceActionSummaries", + "documentation":"

    An object containing information about the self-service actions associated with the provisioning artifact.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListServiceActionsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListServiceActionsOutput":{ + "type":"structure", + "members":{ + "ServiceActionSummaries":{ + "shape":"ServiceActionSummaries", + "documentation":"

    An object containing information about the service actions associated with the provisioning artifact.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListStackInstancesForProvisionedProductInput":{ + "type":"structure", + "required":["ProvisionedProductId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + } + } + }, + "ListStackInstancesForProvisionedProductOutput":{ + "type":"structure", + "members":{ + "StackInstances":{ + "shape":"StackInstances", + "documentation":"

    List of stack instances.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "ListTagOptionsFilters":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"

    The TagOption key.

    " + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"

    The TagOption value.

    " + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"

    The active state.

    " + } + }, + "documentation":"

    Filters to use when listing TagOptions.

    " + }, + "ListTagOptionsInput":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ListTagOptionsFilters", + "documentation":"

    The search filters. If no search filters are specified, the output includes all TagOptions.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ListTagOptionsOutput":{ + "type":"structure", + "members":{ + "TagOptionDetails":{ + "shape":"TagOptionDetails", + "documentation":"

    Information about the TagOptions.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "LogicalResourceId":{"type":"string"}, + "Message":{"type":"string"}, + "Namespaces":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "NoEcho":{"type":"boolean"}, + "NotificationArn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "NotificationArns":{ + "type":"list", + "member":{"shape":"NotificationArn"}, + "max":5 + }, + "OperationNotSupportedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation is not supported.

    ", + "exception":true + }, + "OrganizationNode":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"OrganizationNodeType", + "documentation":"

    The organization node type.

    " + }, + "Value":{ + "shape":"OrganizationNodeValue", + "documentation":"

    The identifier of the organization node.

    " + } + }, + "documentation":"

    Information about the organization node.

    " + }, + "OrganizationNodeType":{ + "type":"string", + "enum":[ + "ORGANIZATION", + "ORGANIZATIONAL_UNIT", + "ACCOUNT" + ] + }, + "OrganizationNodeValue":{ + "type":"string", + "pattern":"(^[0-9]{12}$)|(^arn:aws:organizations::\\d{12}:organization\\/o-[a-z0-9]{10,32})|(^o-[a-z0-9]{10,32}$)|(^arn:aws:organizations::\\d{12}:ou\\/o-[a-z0-9]{10,32}\\/ou-[0-9a-z]{4,32}-[0-9a-z]{8,32}$)|(^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$)" + }, + "OrganizationNodes":{ + "type":"list", + "member":{"shape":"OrganizationNode"} + }, + "OutputKey":{"type":"string"}, + "OutputValue":{"type":"string"}, + "PageSize":{ + "type":"integer", + "max":20, + "min":0 + }, + "PageToken":{ + "type":"string", + "max":2024, + "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" + }, + "ParameterConstraints":{ + "type":"structure", + "members":{ + "AllowedValues":{ + "shape":"AllowedValues", + "documentation":"

    The values that the administrator has allowed for the parameter.

    " + } + }, + "documentation":"

    The constraints that the administrator has put on the parameter.

    " + }, + "ParameterKey":{ + "type":"string", + "max":1000, + "min":1 + }, + "ParameterType":{"type":"string"}, + "ParameterValue":{ + "type":"string", + "max":4096 + }, + "PhysicalId":{"type":"string"}, + "PhysicalResourceId":{"type":"string"}, + "PlanResourceType":{ + "type":"string", + "max":256, + "min":1 + }, + "PortfolioDescription":{ + "type":"string", + "max":2000 + }, + "PortfolioDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "ARN":{ + "shape":"ResourceARN", + "documentation":"

    The ARN assigned to the portfolio.

    " + }, + "DisplayName":{ + "shape":"PortfolioDisplayName", + "documentation":"

    The name to use for display purposes.

    " + }, + "Description":{ + "shape":"PortfolioDescription", + "documentation":"

    The description of the portfolio.

    " + }, + "CreatedTime":{ + "shape":"CreationTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "ProviderName":{ + "shape":"ProviderName", + "documentation":"

    The name of the portfolio provider.

    " + } + }, + "documentation":"

    Information about a portfolio.

    " + }, + "PortfolioDetails":{ + "type":"list", + "member":{"shape":"PortfolioDetail"} + }, + "PortfolioDisplayName":{ + "type":"string", + "max":100, + "min":1 + }, + "PortfolioName":{"type":"string"}, + "PortfolioShareType":{ + "type":"string", + "enum":[ + "IMPORTED", + "AWS_SERVICECATALOG", + "AWS_ORGANIZATIONS" + ] + }, + "Principal":{ + "type":"structure", + "members":{ + "PrincipalARN":{ + "shape":"PrincipalARN", + "documentation":"

    The ARN of the principal (IAM user, role, or group).

    " + }, + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"

    The principal type. The supported value is IAM.

    " + } + }, + "documentation":"

    Information about a principal.

    " + }, + "PrincipalARN":{ + "type":"string", + "max":1000, + "min":1 + }, + "PrincipalType":{ + "type":"string", + "enum":["IAM"] + }, + "Principals":{ + "type":"list", + "member":{"shape":"Principal"} + }, + "ProductArn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "ProductSource":{ + "type":"string", + "enum":["ACCOUNT"] + }, + "ProductType":{ + "type":"string", + "enum":[ + "CLOUD_FORMATION_TEMPLATE", + "MARKETPLACE" + ], + "max":8191 + }, + "ProductViewAggregationType":{"type":"string"}, + "ProductViewAggregationValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"AttributeValue", + "documentation":"

    The value of the product view aggregation.

    " + }, + "ApproximateCount":{ + "shape":"ApproximateCount", + "documentation":"

    An approximate count of the products that match the value.

    " + } + }, + "documentation":"

    A single product view aggregation value/count pair, containing metadata about each product to which the calling user has access.

    " + }, + "ProductViewAggregationValues":{ + "type":"list", + "member":{"shape":"ProductViewAggregationValue"} + }, + "ProductViewAggregations":{ + "type":"map", + "key":{"shape":"ProductViewAggregationType"}, + "value":{"shape":"ProductViewAggregationValues"} + }, + "ProductViewDetail":{ + "type":"structure", + "members":{ + "ProductViewSummary":{ + "shape":"ProductViewSummary", + "documentation":"

    Summary information about the product view.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the product.

    • AVAILABLE - The product is ready for use.

    • CREATING - Product creation has started; the product is not ready for use.

    • FAILED - An action failed.

    " + }, + "ProductARN":{ + "shape":"ResourceARN", + "documentation":"

    The ARN of the product.

    " + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + } + }, + "documentation":"

    Information about a product view.

    " + }, + "ProductViewDetails":{ + "type":"list", + "member":{"shape":"ProductViewDetail"} + }, + "ProductViewDistributor":{"type":"string"}, + "ProductViewFilterBy":{ + "type":"string", + "enum":[ + "FullTextSearch", + "Owner", + "ProductType", + "SourceProductId" + ] + }, + "ProductViewFilterValue":{"type":"string"}, + "ProductViewFilterValues":{ + "type":"list", + "member":{"shape":"ProductViewFilterValue"} + }, + "ProductViewFilters":{ + "type":"map", + "key":{"shape":"ProductViewFilterBy"}, + "value":{"shape":"ProductViewFilterValues"} + }, + "ProductViewName":{ + "type":"string", + "max":8191 + }, + "ProductViewOwner":{ + "type":"string", + "max":8191 + }, + "ProductViewShortDescription":{ + "type":"string", + "max":8191 + }, + "ProductViewSortBy":{ + "type":"string", + "enum":[ + "Title", + "VersionCount", + "CreationDate" + ] + }, + "ProductViewSummaries":{ + "type":"list", + "member":{"shape":"ProductViewSummary"} + }, + "ProductViewSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The product view identifier.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "Name":{ + "shape":"ProductViewName", + "documentation":"

    The name of the product.

    " + }, + "Owner":{ + "shape":"ProductViewOwner", + "documentation":"

    The owner of the product. Contact the product administrator for the significance of this value.

    " + }, + "ShortDescription":{ + "shape":"ProductViewShortDescription", + "documentation":"

    Short description of the product.

    " + }, + "Type":{ + "shape":"ProductType", + "documentation":"

    The product type. Contact the product administrator for the significance of this value. If this value is MARKETPLACE, the product was created by AWS Marketplace.

    " + }, + "Distributor":{ + "shape":"ProductViewDistributor", + "documentation":"

    The distributor of the product. Contact the product administrator for the significance of this value.

    " + }, + "HasDefaultPath":{ + "shape":"HasDefaultPath", + "documentation":"

    Indicates whether the product has a default path. If the product does not have a default path, call ListLaunchPaths to disambiguate between paths. Otherwise, ListLaunchPaths is not required, and the output of ProductViewSummary can be used directly with DescribeProvisioningParameters.

    " + }, + "SupportEmail":{ + "shape":"SupportEmail", + "documentation":"

    The email contact information to obtain support for this Product.

    " + }, + "SupportDescription":{ + "shape":"SupportDescription", + "documentation":"

    The description of the support for this Product.

    " + }, + "SupportUrl":{ + "shape":"SupportUrl", + "documentation":"

    The URL information to obtain support for this Product.

    " + } + }, + "documentation":"

    Summary information about a product view.

    " + }, + "PropertyKey":{ + "type":"string", + "enum":["OWNER"], + "max":128, + "min":1 + }, + "PropertyName":{"type":"string"}, + "PropertyValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "ProviderName":{ + "type":"string", + "max":50, + "min":1 + }, + "ProvisionProductInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId", + "ProvisionedProductName", + "ProvisionToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    " + }, + "ProvisionedProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.

    " + }, + "ProvisioningParameters":{ + "shape":"ProvisioningParameters", + "documentation":"

    Parameters specified by the administrator that are required for provisioning the product.

    " + }, + "ProvisioningPreferences":{ + "shape":"ProvisioningPreferences", + "documentation":"

    An object that contains information about the provisioning preferences for a stack set.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    One or more tags.

    " + }, + "NotificationArns":{ + "shape":"NotificationArns", + "documentation":"

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    " + }, + "ProvisionToken":{ + "shape":"IdempotencyToken", + "documentation":"

    An idempotency token that uniquely identifies the provisioning request.

    ", + "idempotencyToken":true + } + } + }, + "ProvisionProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    Information about the result of provisioning the product.

    " + } + } + }, + "ProvisionedProductAttribute":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "Arn":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The ARN of the provisioned product.

    " + }, + "Type":{ + "shape":"ProvisionedProductType", + "documentation":"

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "Status":{ + "shape":"ProvisionedProductStatus", + "documentation":"

    The current status of the provisioned product.

    • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

    • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

    • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

    • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

    • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    " + }, + "StatusMessage":{ + "shape":"ProvisionedProductStatusMessage", + "documentation":"

    The current status message of the provisioned product.

    " + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    " + }, + "LastRecordId":{ + "shape":"Id", + "documentation":"

    The record identifier of the last request performed on this provisioned product.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    One or more tags.

    " + }, + "PhysicalId":{ + "shape":"PhysicalId", + "documentation":"

    The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "UserArn":{ + "shape":"UserArn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM user.

    " + }, + "UserArnSession":{ + "shape":"UserArnSession", + "documentation":"

    The ARN of the IAM user in the session. This ARN might contain a session ID.

    " + } + }, + "documentation":"

    Information about a provisioned product.

    " + }, + "ProvisionedProductAttributes":{ + "type":"list", + "member":{"shape":"ProvisionedProductAttribute"} + }, + "ProvisionedProductDetail":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "Arn":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The ARN of the provisioned product.

    " + }, + "Type":{ + "shape":"ProvisionedProductType", + "documentation":"

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " + }, + "Id":{ + "shape":"ProvisionedProductId", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "Status":{ + "shape":"ProvisionedProductStatus", + "documentation":"

    The current status of the provisioned product.

    • AVAILABLE - Stable state, ready to perform any operation. The most recent operation succeeded and completed.

    • UNDER_CHANGE - Transitive state. Operations performed might not have valid results. Wait for an AVAILABLE status before performing operations.

    • TAINTED - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.

    • ERROR - An unexpected error occurred. The provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.

    • PLAN_IN_PROGRESS - Transitive state. The plan operations were performed to provision a new product, but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE status before performing operations.

    " + }, + "StatusMessage":{ + "shape":"ProvisionedProductStatusMessage", + "documentation":"

    The current status message of the provisioned product.

    " + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

    " + }, + "LastRecordId":{ + "shape":"LastRequestId", + "documentation":"

    The record identifier of the last request performed on this provisioned product.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + } + }, + "documentation":"

    Information about a provisioned product.

    " + }, + "ProvisionedProductDetails":{ + "type":"list", + "member":{"shape":"ProvisionedProductDetail"} + }, + "ProvisionedProductFilters":{ + "type":"map", + "key":{"shape":"ProvisionedProductViewFilterBy"}, + "value":{"shape":"ProvisionedProductViewFilterValues"} + }, + "ProvisionedProductId":{"type":"string"}, + "ProvisionedProductName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9._-]*" + }, + "ProvisionedProductNameOrArn":{ + "type":"string", + "max":1224, + "min":1, + "pattern":"[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "ProvisionedProductPlanDetails":{ + "type":"structure", + "members":{ + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use ListLaunchPaths.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "PlanName":{ + "shape":"ProvisionedProductPlanName", + "documentation":"

    The name of the plan.

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "ProvisionProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisionProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "PlanType":{ + "shape":"ProvisionedProductPlanType", + "documentation":"

    The plan type.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "Status":{ + "shape":"ProvisionedProductPlanStatus", + "documentation":"

    The status.

    " + }, + "UpdatedTime":{ + "shape":"UpdatedTime", + "documentation":"

    The time when the plan was last updated.

    " + }, + "NotificationArns":{ + "shape":"NotificationArns", + "documentation":"

    Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.

    " + }, + "ProvisioningParameters":{ + "shape":"UpdateProvisioningParameters", + "documentation":"

    Parameters specified by the administrator that are required for provisioning the product.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    One or more tags.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    The status message.

    " + } + }, + "documentation":"

    Information about a plan.

    " + }, + "ProvisionedProductPlanName":{"type":"string"}, + "ProvisionedProductPlanStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_SUCCESS", + "CREATE_FAILED", + "EXECUTE_IN_PROGRESS", + "EXECUTE_SUCCESS", + "EXECUTE_FAILED" + ] + }, + "ProvisionedProductPlanSummary":{ + "type":"structure", + "members":{ + "PlanName":{ + "shape":"ProvisionedProductPlanName", + "documentation":"

    The name of the plan.

    " + }, + "PlanId":{ + "shape":"Id", + "documentation":"

    The plan identifier.

    " + }, + "ProvisionProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisionProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "PlanType":{ + "shape":"ProvisionedProductPlanType", + "documentation":"

    The plan type.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + } + }, + "documentation":"

    Summary information about a plan.

    " + }, + "ProvisionedProductPlanType":{ + "type":"string", + "enum":["CLOUDFORMATION"] + }, + "ProvisionedProductPlans":{ + "type":"list", + "member":{"shape":"ProvisionedProductPlanSummary"} + }, + "ProvisionedProductProperties":{ + "type":"map", + "key":{"shape":"PropertyKey"}, + "value":{"shape":"PropertyValue"}, + "max":100, + "min":1 + }, + "ProvisionedProductStatus":{ + "type":"string", + "enum":[ + "AVAILABLE", + "UNDER_CHANGE", + "TAINTED", + "ERROR", + "PLAN_IN_PROGRESS" + ] + }, + "ProvisionedProductStatusMessage":{"type":"string"}, + "ProvisionedProductType":{"type":"string"}, + "ProvisionedProductViewFilterBy":{ + "type":"string", + "enum":["SearchQuery"] + }, + "ProvisionedProductViewFilterValue":{"type":"string"}, + "ProvisionedProductViewFilterValues":{ + "type":"list", + "member":{"shape":"ProvisionedProductViewFilterValue"} + }, + "ProvisioningArtifact":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "Name":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The name of the provisioning artifact.

    " + }, + "Description":{ + "shape":"ProvisioningArtifactDescription", + "documentation":"

    The description of the provisioning artifact.

    " + }, + "CreatedTime":{ + "shape":"ProvisioningArtifactCreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "Guidance":{ + "shape":"ProvisioningArtifactGuidance", + "documentation":"

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    " + } + }, + "documentation":"

    Information about a provisioning artifact. A provisioning artifact is also known as a product version.

    " + }, + "ProvisioningArtifactActive":{"type":"boolean"}, + "ProvisioningArtifactCreatedTime":{"type":"timestamp"}, + "ProvisioningArtifactDescription":{"type":"string"}, + "ProvisioningArtifactDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "Name":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The name of the provisioning artifact.

    " + }, + "Description":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The description of the provisioning artifact.

    " + }, + "Type":{ + "shape":"ProvisioningArtifactType", + "documentation":"

    The type of provisioning artifact.

    • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

    • MARKETPLACE_AMI - AWS Marketplace AMI

    • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

    " + }, + "CreatedTime":{ + "shape":"CreationTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "Active":{ + "shape":"ProvisioningArtifactActive", + "documentation":"

    Indicates whether the product version is active.

    " + }, + "Guidance":{ + "shape":"ProvisioningArtifactGuidance", + "documentation":"

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    " + } + }, + "documentation":"

    Information about a provisioning artifact (also known as a version) for a product.

    " + }, + "ProvisioningArtifactDetails":{ + "type":"list", + "member":{"shape":"ProvisioningArtifactDetail"} + }, + "ProvisioningArtifactGuidance":{ + "type":"string", + "enum":[ + "DEFAULT", + "DEPRECATED" + ] + }, + "ProvisioningArtifactInfo":{ + "type":"map", + "key":{"shape":"ProvisioningArtifactInfoKey"}, + "value":{"shape":"ProvisioningArtifactInfoValue"}, + "max":100, + "min":1 + }, + "ProvisioningArtifactInfoKey":{"type":"string"}, + "ProvisioningArtifactInfoValue":{"type":"string"}, + "ProvisioningArtifactName":{"type":"string"}, + "ProvisioningArtifactParameter":{ + "type":"structure", + "members":{ + "ParameterKey":{ + "shape":"ParameterKey", + "documentation":"

    The parameter key.

    " + }, + "DefaultValue":{ + "shape":"DefaultValue", + "documentation":"

    The default value.

    " + }, + "ParameterType":{ + "shape":"ParameterType", + "documentation":"

    The parameter type.

    " + }, + "IsNoEcho":{ + "shape":"NoEcho", + "documentation":"

    If this value is true, the value for this parameter is obfuscated from view when the parameter is retrieved. This parameter is used to hide sensitive information.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The description of the parameter.

    " + }, + "ParameterConstraints":{ + "shape":"ParameterConstraints", + "documentation":"

    Constraints that the administrator has put on a parameter.

    " + } + }, + "documentation":"

    Information about a parameter used to provision a product.

    " + }, + "ProvisioningArtifactParameters":{ + "type":"list", + "member":{"shape":"ProvisioningArtifactParameter"} + }, + "ProvisioningArtifactPreferences":{ + "type":"structure", + "members":{ + "StackSetAccounts":{ + "shape":"StackSetAccounts", + "documentation":"

    One or more AWS accounts where stack instances are deployed from the stack set. These accounts can be scoped in ProvisioningPreferences$StackSetAccounts and UpdateProvisioningPreferences$StackSetAccounts.

    Applicable only to a CFN_STACKSET provisioned product type.

    " + }, + "StackSetRegions":{ + "shape":"StackSetRegions", + "documentation":"

    One or more AWS Regions where stack instances are deployed from the stack set. These regions can be scoped in ProvisioningPreferences$StackSetRegions and UpdateProvisioningPreferences$StackSetRegions.

    Applicable only to a CFN_STACKSET provisioned product type.

    " + } + }, + "documentation":"

    The user-defined preferences that will be applied during product provisioning, unless overridden by ProvisioningPreferences or UpdateProvisioningPreferences.

    For more information on maximum concurrent accounts and failure tolerance, see Stack set operation options in the AWS CloudFormation User Guide.

    " + }, + "ProvisioningArtifactProperties":{ + "type":"structure", + "required":["Info"], + "members":{ + "Name":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The name of the provisioning artifact (for example, v1 v2beta). No spaces are allowed.

    " + }, + "Description":{ + "shape":"ProvisioningArtifactDescription", + "documentation":"

    The description of the provisioning artifact, including how it differs from the previous provisioning artifact.

    " + }, + "Info":{ + "shape":"ProvisioningArtifactInfo", + "documentation":"

    The URL of the CloudFormation template in Amazon S3. Specify the URL in JSON format as follows:

    \"LoadTemplateFromURL\": \"https://s3.amazonaws.com/cf-templates-ozkq9d3hgiq2-us-east-1/...\"

    " + }, + "Type":{ + "shape":"ProvisioningArtifactType", + "documentation":"

    The type of provisioning artifact.

    • CLOUD_FORMATION_TEMPLATE - AWS CloudFormation template

    • MARKETPLACE_AMI - AWS Marketplace AMI

    • MARKETPLACE_CAR - AWS Marketplace Clusters and AWS Resources

    " + }, + "DisableTemplateValidation":{ + "shape":"DisableTemplateValidation", + "documentation":"

    If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.

    " + } + }, + "documentation":"

    Information about a provisioning artifact (also known as a version) for a product.

    " + }, + "ProvisioningArtifactPropertyName":{ + "type":"string", + "enum":["Id"] + }, + "ProvisioningArtifactPropertyValue":{"type":"string"}, + "ProvisioningArtifactSummaries":{ + "type":"list", + "member":{"shape":"ProvisioningArtifactSummary"} + }, + "ProvisioningArtifactSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "Name":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The name of the provisioning artifact.

    " + }, + "Description":{ + "shape":"ProvisioningArtifactDescription", + "documentation":"

    The description of the provisioning artifact.

    " + }, + "CreatedTime":{ + "shape":"ProvisioningArtifactCreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "ProvisioningArtifactMetadata":{ + "shape":"ProvisioningArtifactInfo", + "documentation":"

    The metadata for the provisioning artifact. This is used with AWS Marketplace products.

    " + } + }, + "documentation":"

    Summary information about a provisioning artifact (also known as a version) for a product.

    " + }, + "ProvisioningArtifactType":{ + "type":"string", + "enum":[ + "CLOUD_FORMATION_TEMPLATE", + "MARKETPLACE_AMI", + "MARKETPLACE_CAR" + ] + }, + "ProvisioningArtifactView":{ + "type":"structure", + "members":{ + "ProductViewSummary":{ + "shape":"ProductViewSummary", + "documentation":"

    Summary information about a product view.

    " + }, + "ProvisioningArtifact":{ + "shape":"ProvisioningArtifact", + "documentation":"

    Information about a provisioning artifact. A provisioning artifact is also known as a product version.

    " + } + }, + "documentation":"

    An object that contains summary information about a product view and a provisioning artifact.

    " + }, + "ProvisioningArtifactViews":{ + "type":"list", + "member":{"shape":"ProvisioningArtifactView"} + }, + "ProvisioningArtifacts":{ + "type":"list", + "member":{"shape":"ProvisioningArtifact"} + }, + "ProvisioningParameter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ParameterKey", + "documentation":"

    The parameter key.

    " + }, + "Value":{ + "shape":"ParameterValue", + "documentation":"

    The parameter value.

    " + } + }, + "documentation":"

    Information about a parameter used to provision a product.

    " + }, + "ProvisioningParameters":{ + "type":"list", + "member":{"shape":"ProvisioningParameter"} + }, + "ProvisioningPreferences":{ + "type":"structure", + "members":{ + "StackSetAccounts":{ + "shape":"StackSetAccounts", + "documentation":"

    One or more AWS accounts that will have access to the provisioned product.

    Applicable only to a CFN_STACKSET provisioned product type.

    The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    If no values are specified, the default value is all accounts from the STACKSET constraint.

    " + }, + "StackSetRegions":{ + "shape":"StackSetRegions", + "documentation":"

    One or more AWS Regions where the provisioned product will be available.

    Applicable only to a CFN_STACKSET provisioned product type.

    The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    If no values are specified, the default value is all regions from the STACKSET constraint.

    " + }, + "StackSetFailureToleranceCount":{ + "shape":"StackSetFailureToleranceCount", + "documentation":"

    The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    The default value is 0 if no value is specified.

    " + }, + "StackSetFailureTolerancePercentage":{ + "shape":"StackSetFailureTolerancePercentage", + "documentation":"

    The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    " + }, + "StackSetMaxConcurrencyCount":{ + "shape":"StackSetMaxConcurrencyCount", + "documentation":"

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " + }, + "StackSetMaxConcurrencyPercentage":{ + "shape":"StackSetMaxConcurrencyPercentage", + "documentation":"

    The maximum percentage of accounts in which to perform this operation at one time.

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " + } + }, + "documentation":"

    The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

    " + }, + "RecordDetail":{ + "type":"structure", + "members":{ + "RecordId":{ + "shape":"Id", + "documentation":"

    The identifier of the record.

    " + }, + "ProvisionedProductName":{ + "shape":"ProvisionedProductName", + "documentation":"

    The user-friendly name of the provisioned product.

    " + }, + "Status":{ + "shape":"RecordStatus", + "documentation":"

    The status of the provisioned product.

    • CREATED - The request was created but the operation has not started.

    • IN_PROGRESS - The requested operation is in progress.

    • IN_PROGRESS_IN_ERROR - The provisioned product is under change but the requested operation failed and some remediation is occurring. For example, a rollback.

    • SUCCEEDED - The requested operation has successfully completed.

    • FAILED - The requested operation has unsuccessfully completed. Investigate using the error messages returned.

    " + }, + "CreatedTime":{ + "shape":"CreatedTime", + "documentation":"

    The UTC time stamp of the creation time.

    " + }, + "UpdatedTime":{ + "shape":"UpdatedTime", + "documentation":"

    The time when the record was last updated.

    " + }, + "ProvisionedProductType":{ + "shape":"ProvisionedProductType", + "documentation":"

    The type of provisioned product. The supported values are CFN_STACK and CFN_STACKSET.

    " + }, + "RecordType":{ + "shape":"RecordType", + "documentation":"

    The record type.

    • PROVISION_PRODUCT

    • UPDATE_PROVISIONED_PRODUCT

    • TERMINATE_PROVISIONED_PRODUCT

    " + }, + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The path identifier.

    " + }, + "RecordErrors":{ + "shape":"RecordErrors", + "documentation":"

    The errors that occurred.

    " + }, + "RecordTags":{ + "shape":"RecordTags", + "documentation":"

    One or more tags.

    " + } + }, + "documentation":"

    Information about a request operation.

    " + }, + "RecordDetails":{ + "type":"list", + "member":{"shape":"RecordDetail"} + }, + "RecordError":{ + "type":"structure", + "members":{ + "Code":{ + "shape":"ErrorCode", + "documentation":"

    The numeric value of the error.

    " + }, + "Description":{ + "shape":"ErrorDescription", + "documentation":"

    The description of the error.

    " + } + }, + "documentation":"

    The error code and description resulting from an operation.

    " + }, + "RecordErrors":{ + "type":"list", + "member":{"shape":"RecordError"} + }, + "RecordOutput":{ + "type":"structure", + "members":{ + "OutputKey":{ + "shape":"OutputKey", + "documentation":"

    The output key.

    " + }, + "OutputValue":{ + "shape":"OutputValue", + "documentation":"

    The output value.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The description of the output.

    " + } + }, + "documentation":"

    The output for the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.

    " + }, + "RecordOutputs":{ + "type":"list", + "member":{"shape":"RecordOutput"} + }, + "RecordStatus":{ + "type":"string", + "enum":[ + "CREATED", + "IN_PROGRESS", + "IN_PROGRESS_IN_ERROR", + "SUCCEEDED", + "FAILED" + ] + }, + "RecordTag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"RecordTagKey", + "documentation":"

    The key for this tag.

    " + }, + "Value":{ + "shape":"RecordTagValue", + "documentation":"

    The value for this tag.

    " + } + }, + "documentation":"

    Information about a tag, which is a key-value pair.

    " + }, + "RecordTagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "RecordTagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$" + }, + "RecordTags":{ + "type":"list", + "member":{"shape":"RecordTag"}, + "max":50 + }, + "RecordType":{"type":"string"}, + "Region":{"type":"string"}, + "RejectPortfolioShareInput":{ + "type":"structure", + "required":["PortfolioId"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "PortfolioShareType":{ + "shape":"PortfolioShareType", + "documentation":"

    The type of shared portfolios to reject. The default is to reject imported portfolios.

    • AWS_ORGANIZATIONS - Reject portfolios shared by the master account of your organization.

    • IMPORTED - Reject imported portfolios.

    • AWS_SERVICECATALOG - Not supported. (Throws ResourceNotFoundException.)

    For example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS

    " + } + } + }, + "RejectPortfolioShareOutput":{ + "type":"structure", + "members":{ + } + }, + "Replacement":{ + "type":"string", + "enum":[ + "TRUE", + "FALSE", + "CONDITIONAL" + ] + }, + "RequiresRecreation":{ + "type":"string", + "enum":[ + "NEVER", + "CONDITIONALLY", + "ALWAYS" + ] + }, + "ResourceARN":{ + "type":"string", + "max":150, + "min":1 + }, + "ResourceAttribute":{ + "type":"string", + "enum":[ + "PROPERTIES", + "METADATA", + "CREATIONPOLICY", + "UPDATEPOLICY", + "DELETIONPOLICY", + "TAGS" + ] + }, + "ResourceChange":{ + "type":"structure", + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    The change action.

    " + }, + "LogicalResourceId":{ + "shape":"LogicalResourceId", + "documentation":"

    The ID of the resource, as defined in the CloudFormation template.

    " + }, + "PhysicalResourceId":{ + "shape":"PhysicalResourceId", + "documentation":"

    The ID of the resource, if it was already created.

    " + }, + "ResourceType":{ + "shape":"PlanResourceType", + "documentation":"

    The type of resource.

    " + }, + "Replacement":{ + "shape":"Replacement", + "documentation":"

    If the change type is Modify, indicates whether the existing resource is deleted and replaced with a new one.

    " + }, + "Scope":{ + "shape":"Scope", + "documentation":"

    The change scope.

    " + }, + "Details":{ + "shape":"ResourceChangeDetails", + "documentation":"

    Information about the resource changes.

    " + } + }, + "documentation":"

    Information about a resource change that will occur when a plan is executed.

    " + }, + "ResourceChangeDetail":{ + "type":"structure", + "members":{ + "Target":{ + "shape":"ResourceTargetDefinition", + "documentation":"

    Information about the resource attribute to be modified.

    " + }, + "Evaluation":{ + "shape":"EvaluationType", + "documentation":"

    For static evaluations, the value of the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.

    " + }, + "CausingEntity":{ + "shape":"CausingEntity", + "documentation":"

    The ID of the entity that caused the change.

    " + } + }, + "documentation":"

    Information about a change to a resource attribute.

    " + }, + "ResourceChangeDetails":{ + "type":"list", + "member":{"shape":"ResourceChangeDetail"} + }, + "ResourceChanges":{ + "type":"list", + "member":{"shape":"ResourceChange"} + }, + "ResourceDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceDetailId", + "documentation":"

    The identifier of the resource.

    " + }, + "ARN":{ + "shape":"ResourceDetailARN", + "documentation":"

    The ARN of the resource.

    " + }, + "Name":{ + "shape":"ResourceDetailName", + "documentation":"

    The name of the resource.

    " + }, + "Description":{ + "shape":"ResourceDetailDescription", + "documentation":"

    The description of the resource.

    " + }, + "CreatedTime":{ + "shape":"ResourceDetailCreatedTime", + "documentation":"

    The creation time of the resource.

    " + } + }, + "documentation":"

    Information about a resource.

    " + }, + "ResourceDetailARN":{"type":"string"}, + "ResourceDetailCreatedTime":{"type":"timestamp"}, + "ResourceDetailDescription":{"type":"string"}, + "ResourceDetailId":{"type":"string"}, + "ResourceDetailName":{"type":"string"}, + "ResourceDetails":{ + "type":"list", + "member":{"shape":"ResourceDetail"} + }, + "ResourceId":{"type":"string"}, + "ResourceInUseException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A resource that is currently in use. Ensure that the resource is not in use and retry the operation.

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified resource was not found.

    ", + "exception":true + }, + "ResourceTargetDefinition":{ + "type":"structure", + "members":{ + "Attribute":{ + "shape":"ResourceAttribute", + "documentation":"

    The attribute to be changed.

    " + }, + "Name":{ + "shape":"PropertyName", + "documentation":"

    If the attribute is Properties, the value is the name of the property. Otherwise, the value is null.

    " + }, + "RequiresRecreation":{ + "shape":"RequiresRecreation", + "documentation":"

    If the attribute is Properties, indicates whether a change to this property causes the resource to be re-created.

    " + } + }, + "documentation":"

    Information about a change to a resource attribute.

    " + }, + "ResourceType":{"type":"string"}, + "ScanProvisionedProductsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "AccessLevelFilter":{ + "shape":"AccessLevelFilter", + "documentation":"

    The access level to use to obtain results. The default is User.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "ScanProvisionedProductsOutput":{ + "type":"structure", + "members":{ + "ProvisionedProducts":{ + "shape":"ProvisionedProductDetails", + "documentation":"

    Information about the provisioned products.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "Scope":{ + "type":"list", + "member":{"shape":"ResourceAttribute"} + }, + "SearchFilterKey":{"type":"string"}, + "SearchFilterValue":{"type":"string"}, + "SearchProductsAsAdminInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "PortfolioId":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "Filters":{ + "shape":"ProductViewFilters", + "documentation":"

    The search filters. If no search filters are specified, the output includes all products to which the administrator has access.

    " + }, + "SortBy":{ + "shape":"ProductViewSortBy", + "documentation":"

    The sort field. If no value is specified, the results are not sorted.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order. If no value is specified, the results are not sorted.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "ProductSource":{ + "shape":"ProductSource", + "documentation":"

    Access level of the source of the product.

    " + } + } + }, + "SearchProductsAsAdminOutput":{ + "type":"structure", + "members":{ + "ProductViewDetails":{ + "shape":"ProductViewDetails", + "documentation":"

    Information about the product views.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "SearchProductsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Filters":{ + "shape":"ProductViewFilters", + "documentation":"

    The search filters. If no search filters are specified, the output includes all products to which the caller has access.

    " + }, + "PageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "SortBy":{ + "shape":"ProductViewSortBy", + "documentation":"

    The sort field. If no value is specified, the results are not sorted.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order. If no value is specified, the results are not sorted.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "SearchProductsOutput":{ + "type":"structure", + "members":{ + "ProductViewSummaries":{ + "shape":"ProductViewSummaries", + "documentation":"

    Information about the product views.

    " + }, + "ProductViewAggregations":{ + "shape":"ProductViewAggregations", + "documentation":"

    The product view aggregations.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "SearchProvisionedProductsInput":{ + "type":"structure", + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "AccessLevelFilter":{ + "shape":"AccessLevelFilter", + "documentation":"

    The access level to use to obtain results. The default is User.

    " + }, + "Filters":{ + "shape":"ProvisionedProductFilters", + "documentation":"

    The search filters.

    When the key is SearchQuery, the searchable fields are arn, createdTime, id, lastRecordId, idempotencyToken, name, physicalId, productId, provisioningArtifact, type, status, tags, userArn, and userArnSession.

    Example: \"SearchQuery\":[\"status:AVAILABLE\"]

    " + }, + "SortBy":{ + "shape":"SortField", + "documentation":"

    The sort field. If no value is specified, the results are not sorted. The valid values are arn, id, name, and lastRecordId.

    " + }, + "SortOrder":{ + "shape":"SortOrder", + "documentation":"

    The sort order. If no value is specified, the results are not sorted.

    " + }, + "PageSize":{ + "shape":"SearchProvisionedProductsPageSize", + "documentation":"

    The maximum number of items to return with this call.

    " + }, + "PageToken":{ + "shape":"PageToken", + "documentation":"

    The page token for the next set of results. To retrieve the first set of results, use null.

    " + } + } + }, + "SearchProvisionedProductsOutput":{ + "type":"structure", + "members":{ + "ProvisionedProducts":{ + "shape":"ProvisionedProductAttributes", + "documentation":"

    Information about the provisioned products.

    " + }, + "TotalResultsCount":{ + "shape":"TotalResultsCount", + "documentation":"

    The number of provisioned products found.

    " + }, + "NextPageToken":{ + "shape":"PageToken", + "documentation":"

    The page token to use to retrieve the next set of results. If there are no additional results, this value is null.

    " + } + } + }, + "SearchProvisionedProductsPageSize":{ + "type":"integer", + "max":100, + "min":0 + }, + "ServiceActionAssociation":{ + "type":"structure", + "required":[ + "ServiceActionId", + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "ServiceActionId":{ + "shape":"Id", + "documentation":"

    The self-service action identifier. For example, act-fs7abcd89wxyz.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier. For example, prod-abcdzk7xy33qa.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne.

    " + } + }, + "documentation":"

    A self-service action association consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.

    " + }, + "ServiceActionAssociationErrorCode":{ + "type":"string", + "enum":[ + "DUPLICATE_RESOURCE", + "INTERNAL_FAILURE", + "LIMIT_EXCEEDED", + "RESOURCE_NOT_FOUND", + "THROTTLING" + ] + }, + "ServiceActionAssociationErrorMessage":{ + "type":"string", + "max":1024, + "min":1 + }, + "ServiceActionAssociations":{ + "type":"list", + "member":{"shape":"ServiceActionAssociation"}, + "max":50, + "min":1 + }, + "ServiceActionDefinitionKey":{ + "type":"string", + "enum":[ + "Name", + "Version", + "AssumeRole", + "Parameters" + ] + }, + "ServiceActionDefinitionMap":{ + "type":"map", + "key":{"shape":"ServiceActionDefinitionKey"}, + "value":{"shape":"ServiceActionDefinitionValue"}, + "max":100, + "min":1 + }, + "ServiceActionDefinitionType":{ + "type":"string", + "enum":["SSM_AUTOMATION"] + }, + "ServiceActionDefinitionValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "ServiceActionDescription":{ + "type":"string", + "max":1024 + }, + "ServiceActionDetail":{ + "type":"structure", + "members":{ + "ServiceActionSummary":{ + "shape":"ServiceActionSummary", + "documentation":"

    Summary information about the self-service action.

    " + }, + "Definition":{ + "shape":"ServiceActionDefinitionMap", + "documentation":"

    A map that defines the self-service action.

    " + } + }, + "documentation":"

    An object containing detailed information about the self-service action.

    " + }, + "ServiceActionName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9_\\-.]*" + }, + "ServiceActionSummaries":{ + "type":"list", + "member":{"shape":"ServiceActionSummary"} + }, + "ServiceActionSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The self-service action identifier.

    " + }, + "Name":{ + "shape":"ServiceActionName", + "documentation":"

    The self-service action name.

    " + }, + "Description":{ + "shape":"ServiceActionDescription", + "documentation":"

    The self-service action description.

    " + }, + "DefinitionType":{ + "shape":"ServiceActionDefinitionType", + "documentation":"

    The self-service action definition type. For example, SSM_AUTOMATION.

    " + } + }, + "documentation":"

    Detailed information about the self-service action.

    " + }, + "ShareDetails":{ + "type":"structure", + "members":{ + "SuccessfulShares":{ + "shape":"SuccessfulShares", + "documentation":"

    List of accounts for whom the operation succeeded.

    " + }, + "ShareErrors":{ + "shape":"ShareErrors", + "documentation":"

    List of errors.

    " + } + }, + "documentation":"

    Information about the portfolio share operation.

    " + }, + "ShareError":{ + "type":"structure", + "members":{ + "Accounts":{ + "shape":"Namespaces", + "documentation":"

    List of accounts impacted by the error.

    " + }, + "Message":{ + "shape":"Message", + "documentation":"

    Information about the error.

    " + }, + "Error":{ + "shape":"Error", + "documentation":"

    Error type that happened when processing the operation.

    " + } + }, + "documentation":"

    Errors that occurred during the portfolio share operation.

    " + }, + "ShareErrors":{ + "type":"list", + "member":{"shape":"ShareError"} + }, + "ShareStatus":{ + "type":"string", + "enum":[ + "NOT_STARTED", + "IN_PROGRESS", + "COMPLETED", + "COMPLETED_WITH_ERRORS", + "ERROR" + ] + }, + "SortField":{"type":"string"}, + "SortOrder":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "SourceProvisioningArtifactProperties":{ + "type":"list", + "member":{"shape":"SourceProvisioningArtifactPropertiesMap"} + }, + "SourceProvisioningArtifactPropertiesMap":{ + "type":"map", + "key":{"shape":"ProvisioningArtifactPropertyName"}, + "value":{"shape":"ProvisioningArtifactPropertyValue"} + }, + "StackInstance":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"AccountId", + "documentation":"

    The name of the AWS account that the stack instance is associated with.

    " + }, + "Region":{ + "shape":"Region", + "documentation":"

    The name of the AWS region that the stack instance is associated with.

    " + }, + "StackInstanceStatus":{ + "shape":"StackInstanceStatus", + "documentation":"

    The status of the stack instance, in terms of its synchronization with its associated stack set.

    • INOPERABLE: A DeleteStackInstances operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet operations. You might need to perform a DeleteStackInstances operation, with RetainStacks set to true, to delete the stack instance, and then delete the stack manually.

    • OUTDATED: The stack isn't currently up to date with the stack set because either the associated stack failed during a CreateStackSet or UpdateStackSet operation, or the stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

    • CURRENT: The stack is currently up to date with the stack set.

    " + } + }, + "documentation":"

    An AWS CloudFormation stack, in a specific account and region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

    " + }, + "StackInstanceStatus":{ + "type":"string", + "enum":[ + "CURRENT", + "OUTDATED", + "INOPERABLE" + ] + }, + "StackInstances":{ + "type":"list", + "member":{"shape":"StackInstance"} + }, + "StackSetAccounts":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "StackSetFailureToleranceCount":{ + "type":"integer", + "min":0 + }, + "StackSetFailureTolerancePercentage":{ + "type":"integer", + "max":100, + "min":0 + }, + "StackSetMaxConcurrencyCount":{ + "type":"integer", + "min":1 + }, + "StackSetMaxConcurrencyPercentage":{ + "type":"integer", + "max":100, + "min":1 + }, + "StackSetOperationType":{ + "type":"string", + "enum":[ + "CREATE", + "UPDATE", + "DELETE" + ] + }, + "StackSetRegions":{ + "type":"list", + "member":{"shape":"Region"} + }, + "Status":{ + "type":"string", + "enum":[ + "AVAILABLE", + "CREATING", + "FAILED" + ] + }, + "StatusDetail":{"type":"string"}, + "StatusMessage":{ + "type":"string", + "pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*" + }, + "SuccessfulShares":{ + "type":"list", + "member":{"shape":"AccountId"} + }, + "SupportDescription":{ + "type":"string", + "max":8191 + }, + "SupportEmail":{ + "type":"string", + "max":254 + }, + "SupportUrl":{ + "type":"string", + "max":2083 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The tag key.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value for this key.

    " + } + }, + "documentation":"

    Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagOptionActive":{"type":"boolean"}, + "TagOptionDetail":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"

    The TagOption key.

    " + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"

    The TagOption value.

    " + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"

    The TagOption active state.

    " + }, + "Id":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + } + }, + "documentation":"

    Information about a TagOption.

    " + }, + "TagOptionDetails":{ + "type":"list", + "member":{"shape":"TagOptionDetail"} + }, + "TagOptionId":{ + "type":"string", + "max":100, + "min":1 + }, + "TagOptionKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagOptionNotMigratedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An operation requiring TagOptions failed because the TagOptions migration process has not been performed for this account. Please use the AWS console to perform the migration process before retrying the operation.

    ", + "exception":true + }, + "TagOptionSummaries":{ + "type":"list", + "member":{"shape":"TagOptionSummary"} + }, + "TagOptionSummary":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagOptionKey", + "documentation":"

    The TagOption key.

    " + }, + "Values":{ + "shape":"TagOptionValues", + "documentation":"

    The TagOption value.

    " + } + }, + "documentation":"

    Summary information about a TagOption.

    " + }, + "TagOptionValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagOptionValues":{ + "type":"list", + "member":{"shape":"TagOptionValue"} + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50 + }, + "TerminateProvisionedProductInput":{ + "type":"structure", + "required":["TerminateToken"], + "members":{ + "ProvisionedProductName":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    " + }, + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    " + }, + "TerminateToken":{ + "shape":"IdempotencyToken", + "documentation":"

    An idempotency token that uniquely identifies the termination request. This token is only valid during the termination process. After the provisioned product is terminated, subsequent requests to terminate the same provisioned product always return ResourceNotFound.

    ", + "idempotencyToken":true + }, + "IgnoreErrors":{ + "shape":"IgnoreErrors", + "documentation":"

    If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "TerminateProvisionedProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    Information about the result of this request.

    " + } + } + }, + "TotalResultsCount":{"type":"integer"}, + "UpdateConstraintInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The identifier of the constraint.

    " + }, + "Description":{ + "shape":"ConstraintDescription", + "documentation":"

    The updated description of the constraint.

    " + }, + "Parameters":{ + "shape":"ConstraintParameters", + "documentation":"

    The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

    LAUNCH

    Specify the RoleArn property as follows:

    {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one LAUNCH constraint on a product and portfolio.

    NOTIFICATION

    Specify the NotificationArns property as follows:

    {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}

    RESOURCE_UPDATE

    Specify the TagUpdatesOnProvisionedProduct property as follows:

    {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}

    The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

    STACKSET

    Specify the Parameters property as follows:

    {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}

    You cannot have both a LAUNCH and a STACKSET constraint.

    You also cannot have more than one STACKSET constraint on a product and portfolio.

    Products with a STACKSET constraint will launch an AWS CloudFormation stack set.

    TEMPLATE

    Specify the Rules property. For more information, see Template Constraint Rules.

    " + } + } + }, + "UpdateConstraintOutput":{ + "type":"structure", + "members":{ + "ConstraintDetail":{ + "shape":"ConstraintDetail", + "documentation":"

    Information about the constraint.

    " + }, + "ConstraintParameters":{ + "shape":"ConstraintParameters", + "documentation":"

    The constraint parameters.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "UpdatePortfolioInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The portfolio identifier.

    " + }, + "DisplayName":{ + "shape":"PortfolioDisplayName", + "documentation":"

    The name to use for display purposes.

    " + }, + "Description":{ + "shape":"PortfolioDescription", + "documentation":"

    The updated description of the portfolio.

    " + }, + "ProviderName":{ + "shape":"ProviderName", + "documentation":"

    The updated name of the portfolio provider.

    " + }, + "AddTags":{ + "shape":"AddTags", + "documentation":"

    The tags to add.

    " + }, + "RemoveTags":{ + "shape":"TagKeys", + "documentation":"

    The tags to remove.

    " + } + } + }, + "UpdatePortfolioOutput":{ + "type":"structure", + "members":{ + "PortfolioDetail":{ + "shape":"PortfolioDetail", + "documentation":"

    Information about the portfolio.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the portfolio.

    " + } + } + }, + "UpdateProductInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "Id":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "Name":{ + "shape":"ProductViewName", + "documentation":"

    The updated product name.

    " + }, + "Owner":{ + "shape":"ProductViewOwner", + "documentation":"

    The updated owner of the product.

    " + }, + "Description":{ + "shape":"ProductViewShortDescription", + "documentation":"

    The updated description of the product.

    " + }, + "Distributor":{ + "shape":"ProductViewOwner", + "documentation":"

    The updated distributor of the product.

    " + }, + "SupportDescription":{ + "shape":"SupportDescription", + "documentation":"

    The updated support description for the product.

    " + }, + "SupportEmail":{ + "shape":"SupportEmail", + "documentation":"

    The updated support email for the product.

    " + }, + "SupportUrl":{ + "shape":"SupportUrl", + "documentation":"

    The updated support URL for the product.

    " + }, + "AddTags":{ + "shape":"AddTags", + "documentation":"

    The tags to add to the product.

    " + }, + "RemoveTags":{ + "shape":"TagKeys", + "documentation":"

    The tags to remove from the product.

    " + } + } + }, + "UpdateProductOutput":{ + "type":"structure", + "members":{ + "ProductViewDetail":{ + "shape":"ProductViewDetail", + "documentation":"

    Information about the product view.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Information about the tags associated with the product.

    " + } + } + }, + "UpdateProvisionedProductInput":{ + "type":"structure", + "required":["UpdateToken"], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProvisionedProductName":{ + "shape":"ProvisionedProductNameOrArn", + "documentation":"

    The name of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    " + }, + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product. You cannot specify both ProvisionedProductName and ProvisionedProductId.

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the product.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "PathId":{ + "shape":"Id", + "documentation":"

    The new path identifier. This value is optional if the product has a default path, and required if the product has more than one path.

    " + }, + "ProvisioningParameters":{ + "shape":"UpdateProvisioningParameters", + "documentation":"

    The new parameters.

    " + }, + "ProvisioningPreferences":{ + "shape":"UpdateProvisioningPreferences", + "documentation":"

    An object that contains information about the provisioning preferences for a stack set.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    One or more tags. Requires the product to have RESOURCE_UPDATE constraint with TagUpdatesOnProvisionedProduct set to ALLOWED to allow tag updates.

    " + }, + "UpdateToken":{ + "shape":"IdempotencyToken", + "documentation":"

    The idempotency token that uniquely identifies the provisioning update request.

    ", + "idempotencyToken":true + } + } + }, + "UpdateProvisionedProductOutput":{ + "type":"structure", + "members":{ + "RecordDetail":{ + "shape":"RecordDetail", + "documentation":"

    Information about the result of the request.

    " + } + } + }, + "UpdateProvisionedProductPropertiesInput":{ + "type":"structure", + "required":[ + "ProvisionedProductId", + "ProvisionedProductProperties", + "IdempotencyToken" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioned product.

    " + }, + "ProvisionedProductProperties":{ + "shape":"ProvisionedProductProperties", + "documentation":"

    A map that contains the provisioned product properties to be updated.

    The OWNER key only accepts user ARNs. The owner is the user that is allowed to see, update, terminate, and execute service actions in the provisioned product.

    The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and administrators can see ownership history of the provisioned product using the ListRecordHistory API. The new owner can describe all past records for the provisioned product using the DescribeRecord API. The previous owner can no longer use DescribeRecord, but can still see the product's history from when he was an owner using ListRecordHistory.

    If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or Service Catalog console such as update, terminate, and execute service actions. If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through API or the Service Catalog console on that provisioned product.

    " + }, + "IdempotencyToken":{ + "shape":"IdempotencyToken", + "documentation":"

    The idempotency token that uniquely identifies the provisioning product update request.

    ", + "idempotencyToken":true + } + } + }, + "UpdateProvisionedProductPropertiesOutput":{ + "type":"structure", + "members":{ + "ProvisionedProductId":{ + "shape":"Id", + "documentation":"

    The provisioned product identifier.

    " + }, + "ProvisionedProductProperties":{ + "shape":"ProvisionedProductProperties", + "documentation":"

    A map that contains the properties updated.

    " + }, + "RecordId":{ + "shape":"Id", + "documentation":"

    The identifier of the record.

    " + }, + "Status":{ + "shape":"RecordStatus", + "documentation":"

    The status of the request.

    " + } + } + }, + "UpdateProvisioningArtifactInput":{ + "type":"structure", + "required":[ + "ProductId", + "ProvisioningArtifactId" + ], + "members":{ + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + }, + "ProductId":{ + "shape":"Id", + "documentation":"

    The product identifier.

    " + }, + "ProvisioningArtifactId":{ + "shape":"Id", + "documentation":"

    The identifier of the provisioning artifact.

    " + }, + "Name":{ + "shape":"ProvisioningArtifactName", + "documentation":"

    The updated name of the provisioning artifact.

    " + }, + "Description":{ + "shape":"ProvisioningArtifactDescription", + "documentation":"

    The updated description of the provisioning artifact.

    " + }, + "Active":{ + "shape":"ProvisioningArtifactActive", + "documentation":"

    Indicates whether the product version is active.

    " + }, + "Guidance":{ + "shape":"ProvisioningArtifactGuidance", + "documentation":"

    Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.

    The DEFAULT value indicates that the product version is active.

    The administrator can set the guidance to DEPRECATED to inform users that the product version is deprecated. Users are able to make updates to a provisioned product of a deprecated version but cannot launch new provisioned products using a deprecated version.

    " + } + } + }, + "UpdateProvisioningArtifactOutput":{ + "type":"structure", + "members":{ + "ProvisioningArtifactDetail":{ + "shape":"ProvisioningArtifactDetail", + "documentation":"

    Information about the provisioning artifact.

    " + }, + "Info":{ + "shape":"ProvisioningArtifactInfo", + "documentation":"

    The URL of the CloudFormation template in Amazon S3.

    " + }, + "Status":{ + "shape":"Status", + "documentation":"

    The status of the current request.

    " + } + } + }, + "UpdateProvisioningParameter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ParameterKey", + "documentation":"

    The parameter key.

    " + }, + "Value":{ + "shape":"ParameterValue", + "documentation":"

    The parameter value.

    " + }, + "UsePreviousValue":{ + "shape":"UsePreviousValue", + "documentation":"

    If set to true, Value is ignored and the previous parameter value is kept.

    " + } + }, + "documentation":"

    The parameter key-value pair used to update a provisioned product.

    " + }, + "UpdateProvisioningParameters":{ + "type":"list", + "member":{"shape":"UpdateProvisioningParameter"} + }, + "UpdateProvisioningPreferences":{ + "type":"structure", + "members":{ + "StackSetAccounts":{ + "shape":"StackSetAccounts", + "documentation":"

    One or more AWS accounts that will have access to the provisioned product.

    Applicable only to a CFN_STACKSET provisioned product type.

    The AWS accounts specified should be within the list of accounts in the STACKSET constraint. To get the list of accounts in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    If no values are specified, the default value is all accounts from the STACKSET constraint.

    " + }, + "StackSetRegions":{ + "shape":"StackSetRegions", + "documentation":"

    One or more AWS Regions where the provisioned product will be available.

    Applicable only to a CFN_STACKSET provisioned product type.

    The specified regions should be within the list of regions from the STACKSET constraint. To get the list of regions in the STACKSET constraint, use the DescribeProvisioningParameters operation.

    If no values are specified, the default value is all regions from the STACKSET constraint.

    " + }, + "StackSetFailureToleranceCount":{ + "shape":"StackSetFailureToleranceCount", + "documentation":"

    The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    The default value is 0 if no value is specified.

    " + }, + "StackSetFailureTolerancePercentage":{ + "shape":"StackSetFailureTolerancePercentage", + "documentation":"

    The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetFailureToleranceCount or StackSetFailureTolerancePercentage, but not both.

    " + }, + "StackSetMaxConcurrencyCount":{ + "shape":"StackSetMaxConcurrencyCount", + "documentation":"

    The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount. StackSetMaxConcurrentCount is at most one more than the StackSetFailureToleranceCount.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " + }, + "StackSetMaxConcurrencyPercentage":{ + "shape":"StackSetMaxConcurrencyPercentage", + "documentation":"

    The maximum percentage of accounts in which to perform this operation at one time.

    When calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1 instead.

    Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.

    Applicable only to a CFN_STACKSET provisioned product type.

    Conditional: You must specify either StackSetMaxConcurrentCount or StackSetMaxConcurrentPercentage, but not both.

    " + }, + "StackSetOperationType":{ + "shape":"StackSetOperationType", + "documentation":"

    Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE if nothing is specified.

    Applicable only to a CFN_STACKSET provisioned product type.

    CREATE

    Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.

    UPDATE

    Updates the stack set represented by the provisioned product and also its stack instances.

    DELETE

    Deletes a stack instance in the stack set represented by the provisioned product.

    " + } + }, + "documentation":"

    The user-defined preferences that will be applied when updating a provisioned product. Not all preferences are applicable to all provisioned product types.

    " + }, + "UpdateServiceActionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"Id", + "documentation":"

    The self-service action identifier.

    " + }, + "Name":{ + "shape":"ServiceActionName", + "documentation":"

    The self-service action name.

    " + }, + "Definition":{ + "shape":"ServiceActionDefinitionMap", + "documentation":"

    A map that defines the self-service action.

    " + }, + "Description":{ + "shape":"ServiceActionDescription", + "documentation":"

    The self-service action description.

    " + }, + "AcceptLanguage":{ + "shape":"AcceptLanguage", + "documentation":"

    The language code.

    • en - English (default)

    • jp - Japanese

    • zh - Chinese

    " + } + } + }, + "UpdateServiceActionOutput":{ + "type":"structure", + "members":{ + "ServiceActionDetail":{ + "shape":"ServiceActionDetail", + "documentation":"

    Detailed information about the self-service action.

    " + } + } + }, + "UpdateTagOptionInput":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"TagOptionId", + "documentation":"

    The TagOption identifier.

    " + }, + "Value":{ + "shape":"TagOptionValue", + "documentation":"

    The updated value.

    " + }, + "Active":{ + "shape":"TagOptionActive", + "documentation":"

    The updated active state.

    " + } + } + }, + "UpdateTagOptionOutput":{ + "type":"structure", + "members":{ + "TagOptionDetail":{ + "shape":"TagOptionDetail", + "documentation":"

    Information about the TagOption.

    " + } + } + }, + "UpdatedTime":{"type":"timestamp"}, + "UsageInstruction":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"InstructionType", + "documentation":"

    The usage instruction type for the value.

    " + }, + "Value":{ + "shape":"InstructionValue", + "documentation":"

    The usage instruction value for this type.

    " + } + }, + "documentation":"

    Additional information provided by the administrator.

    " + }, + "UsageInstructions":{ + "type":"list", + "member":{"shape":"UsageInstruction"} + }, + "UsePreviousValue":{"type":"boolean"}, + "UserArn":{"type":"string"}, + "UserArnSession":{"type":"string"}, + "Verbose":{"type":"boolean"} + }, + "documentation":"AWS Service Catalog

    AWS Service Catalog enables organizations to create and manage catalogs of IT services that are approved for use on AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in AWS Service Catalog Concepts.

    " +} diff --git a/aws/dist/botocore/data/servicediscovery/2017-03-14/paginators-1.json b/aws/dist/botocore/data/servicediscovery/2017-03-14/paginators-1.json new file mode 100644 index 00000000..f58df70e --- /dev/null +++ b/aws/dist/botocore/data/servicediscovery/2017-03-14/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "ListServices": { + "result_key": "Services", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListInstances": { + "result_key": "Instances", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListNamespaces": { + "result_key": "Namespaces", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOperations": { + "result_key": "Operations", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/aws/dist/botocore/data/servicediscovery/2017-03-14/service-2.json b/aws/dist/botocore/data/servicediscovery/2017-03-14/service-2.json new file mode 100644 index 00000000..a5b5cfab --- /dev/null +++ b/aws/dist/botocore/data/servicediscovery/2017-03-14/service-2.json @@ -0,0 +1,1683 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-03-14", + "endpointPrefix":"servicediscovery", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"ServiceDiscovery", + "serviceFullName":"AWS Cloud Map", + "serviceId":"ServiceDiscovery", + "signatureVersion":"v4", + "targetPrefix":"Route53AutoNaming_v20170314", + "uid":"servicediscovery-2017-03-14" + }, + "operations":{ + "CreateHttpNamespace":{ + "name":"CreateHttpNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHttpNamespaceRequest"}, + "output":{"shape":"CreateHttpNamespaceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NamespaceAlreadyExists"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"DuplicateRequest"} + ], + "documentation":"

    Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

    For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

    " + }, + "CreatePrivateDnsNamespace":{ + "name":"CreatePrivateDnsNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePrivateDnsNamespaceRequest"}, + "output":{"shape":"CreatePrivateDnsNamespaceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NamespaceAlreadyExists"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"DuplicateRequest"} + ], + "documentation":"

    Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

    " + }, + "CreatePublicDnsNamespace":{ + "name":"CreatePublicDnsNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePublicDnsNamespaceRequest"}, + "output":{"shape":"CreatePublicDnsNamespaceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NamespaceAlreadyExists"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"DuplicateRequest"} + ], + "documentation":"

    Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service will be backend.example.com. For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

    " + }, + "CreateService":{ + "name":"CreateService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServiceRequest"}, + "output":{"shape":"CreateServiceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"NamespaceNotFound"}, + {"shape":"ServiceAlreadyExists"} + ], + "documentation":"

    Creates a service, which defines the configuration for the following entities:

    • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

      • A

      • AAAA

      • A and AAAA

      • SRV

      • CNAME

    • Optionally, a health check

    After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

    For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

    " + }, + "DeleteNamespace":{ + "name":"DeleteNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteNamespaceRequest"}, + "output":{"shape":"DeleteNamespaceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NamespaceNotFound"}, + {"shape":"ResourceInUse"}, + {"shape":"DuplicateRequest"} + ], + "documentation":"

    Deletes a namespace from the current account. If the namespace still contains one or more services, the request fails.

    " + }, + "DeleteService":{ + "name":"DeleteService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServiceRequest"}, + "output":{"shape":"DeleteServiceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"ServiceNotFound"}, + {"shape":"ResourceInUse"} + ], + "documentation":"

    Deletes a specified service. If the service still contains one or more registered instances, the request fails.

    " + }, + "DeregisterInstance":{ + "name":"DeregisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterInstanceRequest"}, + "output":{"shape":"DeregisterInstanceResponse"}, + "errors":[ + {"shape":"DuplicateRequest"}, + {"shape":"InvalidInput"}, + {"shape":"InstanceNotFound"}, + {"shape":"ResourceInUse"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Deletes the Amazon Route 53 DNS records and health check, if any, that AWS Cloud Map created for the specified instance.

    " + }, + "DiscoverInstances":{ + "name":"DiscoverInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DiscoverInstancesRequest"}, + "output":{"shape":"DiscoverInstancesResponse"}, + "errors":[ + {"shape":"ServiceNotFound"}, + {"shape":"NamespaceNotFound"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Discovers registered instances for a specified namespace and service.

    ", + "endpoint":{"hostPrefix":"data-"} + }, + "GetInstance":{ + "name":"GetInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstanceRequest"}, + "output":{"shape":"GetInstanceResponse"}, + "errors":[ + {"shape":"InstanceNotFound"}, + {"shape":"InvalidInput"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Gets information about a specified instance.

    " + }, + "GetInstancesHealthStatus":{ + "name":"GetInstancesHealthStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInstancesHealthStatusRequest"}, + "output":{"shape":"GetInstancesHealthStatusResponse"}, + "errors":[ + {"shape":"InstanceNotFound"}, + {"shape":"InvalidInput"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Gets the current health status (Healthy, Unhealthy, or Unknown) of one or more instances that are associated with a specified service.

    There is a brief delay between when you register an instance and when the health status for the instance is available.

    " + }, + "GetNamespace":{ + "name":"GetNamespace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetNamespaceRequest"}, + "output":{"shape":"GetNamespaceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"NamespaceNotFound"} + ], + "documentation":"

    Gets information about a namespace.

    " + }, + "GetOperation":{ + "name":"GetOperation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOperationRequest"}, + "output":{"shape":"GetOperationResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"OperationNotFound"} + ], + "documentation":"

    Gets information about any operation that returns an operation ID in the response, such as a CreateService request.

    To get a list of operations that match specified criteria, see ListOperations.

    " + }, + "GetService":{ + "name":"GetService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceRequest"}, + "output":{"shape":"GetServiceResponse"}, + "errors":[ + {"shape":"InvalidInput"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Gets the settings for a specified service.

    " + }, + "ListInstances":{ + "name":"ListInstances", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInstancesRequest"}, + "output":{"shape":"ListInstancesResponse"}, + "errors":[ + {"shape":"ServiceNotFound"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Lists summary information about the instances that you registered by using a specified service.

    " + }, + "ListNamespaces":{ + "name":"ListNamespaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListNamespacesRequest"}, + "output":{"shape":"ListNamespacesResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Lists summary information about the namespaces that were created by the current AWS account.

    " + }, + "ListOperations":{ + "name":"ListOperations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOperationsRequest"}, + "output":{"shape":"ListOperationsResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Lists operations that match the criteria that you specify.

    " + }, + "ListServices":{ + "name":"ListServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServicesRequest"}, + "output":{"shape":"ListServicesResponse"}, + "errors":[ + {"shape":"InvalidInput"} + ], + "documentation":"

    Lists summary information for all the services that are associated with one or more specified namespaces.

    " + }, + "RegisterInstance":{ + "name":"RegisterInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterInstanceRequest"}, + "output":{"shape":"RegisterInstanceResponse"}, + "errors":[ + {"shape":"DuplicateRequest"}, + {"shape":"InvalidInput"}, + {"shape":"ResourceInUse"}, + {"shape":"ResourceLimitExceeded"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Creates or updates one or more records and, optionally, creates a health check based on the settings in a specified service. When you submit a RegisterInstance request, the following occurs:

    • For each DNS record that you define in the service that is specified by ServiceId, a record is created or updated in the hosted zone that is associated with the corresponding namespace.

    • If the service includes HealthCheckConfig, a health check is created based on the settings in the health check configuration.

    • The health check, if any, is associated with each of the new or updated records.

    One RegisterInstance request must complete before you can submit another request and specify the same service ID and instance ID.

    For more information, see CreateService.

    When AWS Cloud Map receives a DNS query for the specified DNS name, it returns the applicable value:

    • If the health check is healthy: returns all the records

    • If the health check is unhealthy: returns the applicable value for the last healthy instance

    • If you didn't specify a health check configuration: returns all the records

    For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide.

    " + }, + "UpdateInstanceCustomHealthStatus":{ + "name":"UpdateInstanceCustomHealthStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateInstanceCustomHealthStatusRequest"}, + "errors":[ + {"shape":"InstanceNotFound"}, + {"shape":"ServiceNotFound"}, + {"shape":"CustomHealthNotFound"}, + {"shape":"InvalidInput"} + ], + "documentation":"

    Submits a request to change the health status of a custom health check to healthy or unhealthy.

    You can use UpdateInstanceCustomHealthStatus to change the status only for custom health checks, which you define using HealthCheckCustomConfig when you create a service. You can't use it to change the status for Route 53 health checks, which you define using HealthCheckConfig.

    For more information, see HealthCheckCustomConfig.

    " + }, + "UpdateService":{ + "name":"UpdateService", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceRequest"}, + "output":{"shape":"UpdateServiceResponse"}, + "errors":[ + {"shape":"DuplicateRequest"}, + {"shape":"InvalidInput"}, + {"shape":"ServiceNotFound"} + ], + "documentation":"

    Submits a request to perform the following operations:

    • Add or delete DnsRecords configurations

    • Update the TTL setting for existing DnsRecords configurations

    • Add, update, or delete HealthCheckConfig for a specified service

    For public and private DNS namespaces, you must specify all DnsRecords configurations (and, optionally, HealthCheckConfig) that you want to appear in the updated service. Any current configurations that don't appear in an UpdateService request are deleted.

    When you update the TTL setting for a service, AWS Cloud Map also updates the corresponding settings in all the records and health checks that were created by using the specified service.

    " + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":255 + }, + "AttrKey":{ + "type":"string", + "max":255 + }, + "AttrValue":{ + "type":"string", + "max":1024 + }, + "Attributes":{ + "type":"map", + "key":{"shape":"AttrKey"}, + "value":{"shape":"AttrValue"} + }, + "Code":{"type":"string"}, + "CreateHttpNamespaceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NamespaceName", + "documentation":"

    The name that you want to assign to this namespace.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the namespace.

    " + } + } + }, + "CreateHttpNamespaceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + }, + "CreatePrivateDnsNamespaceRequest":{ + "type":"structure", + "required":[ + "Name", + "Vpc" + ], + "members":{ + "Name":{ + "shape":"NamespaceName", + "documentation":"

    The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the namespace.

    " + }, + "Vpc":{ + "shape":"ResourceId", + "documentation":"

    The ID of the Amazon VPC that you want to associate the namespace with.

    " + } + } + }, + "CreatePrivateDnsNamespaceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + }, + "CreatePublicDnsNamespaceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NamespaceName", + "documentation":"

    The name that you want to assign to this namespace.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the namespace.

    " + } + } + }, + "CreatePublicDnsNamespaceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + }, + "CreateServiceRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ServiceName", + "documentation":"

    The name that you want to assign to the service.

    " + }, + "NamespaceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace that you want to use to create the service.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "idempotencyToken":true + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the service.

    " + }, + "DnsConfig":{ + "shape":"DnsConfig", + "documentation":"

    A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.

    " + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

    Public DNS namespaces only. A complex type that contains settings for an optional Route 53 health check. If you specify settings for a health check, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    For information about the charges for health checks, see AWS Cloud Map Pricing.

    " + }, + "HealthCheckCustomConfig":{ + "shape":"HealthCheckCustomConfig", + "documentation":"

    A complex type that contains information about an optional custom health check.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    " + } + } + }, + "CreateServiceResponse":{ + "type":"structure", + "members":{ + "Service":{ + "shape":"Service", + "documentation":"

    A complex type that contains information about the new service.

    " + } + } + }, + "CustomHealthNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The health check for the instance that is specified by ServiceId and InstanceId is not a custom health check.

    ", + "exception":true + }, + "CustomHealthStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY" + ] + }, + "DeleteNamespaceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace that you want to delete.

    " + } + } + }, + "DeleteNamespaceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + }, + "DeleteServiceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that you want to delete.

    " + } + } + }, + "DeleteServiceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterInstanceRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "InstanceId" + ], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that the instance is associated with.

    " + }, + "InstanceId":{ + "shape":"ResourceId", + "documentation":"

    The value that you specified for Id in the RegisterInstance request.

    " + } + } + }, + "DeregisterInstanceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. For more information, see GetOperation.

    " + } + } + }, + "DiscoverInstancesRequest":{ + "type":"structure", + "required":[ + "NamespaceName", + "ServiceName" + ], + "members":{ + "NamespaceName":{ + "shape":"NamespaceName", + "documentation":"

    The name of the namespace that you specified when you registered the instance.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the service that you specified when you registered the instance.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of instances that you want Cloud Map to return in the response to a DiscoverInstances request. If you don't specify a value for MaxResults, Cloud Map returns up to 100 instances.

    " + }, + "QueryParameters":{ + "shape":"Attributes", + "documentation":"

    A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all the specified key/value pairs will be returned.

    " + }, + "HealthStatus":{ + "shape":"HealthStatusFilter", + "documentation":"

    The health status of the instances that you want to discover.

    " + } + } + }, + "DiscoverInstancesResponse":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"HttpInstanceSummaryList", + "documentation":"

    A complex type that contains one HttpInstanceSummary for each registered instance.

    " + } + } + }, + "DnsConfig":{ + "type":"structure", + "required":["DnsRecords"], + "members":{ + "NamespaceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace to use for DNS configuration.

    ", + "deprecated":true, + "deprecatedMessage":"Top level attribute in request should be used to reference namespace-id" + }, + "RoutingPolicy":{ + "shape":"RoutingPolicy", + "documentation":"

    The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

    If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

    You can specify the following values:

    MULTIVALUE

    If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

    For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

    For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

    WEIGHTED

    Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

    For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

    If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

    For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

    " + }, + "DnsRecords":{ + "shape":"DnsRecordList", + "documentation":"

    An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

    " + } + }, + "documentation":"

    A complex type that contains information about the Amazon Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

    " + }, + "DnsConfigChange":{ + "type":"structure", + "required":["DnsRecords"], + "members":{ + "DnsRecords":{ + "shape":"DnsRecordList", + "documentation":"

    An array that contains one DnsRecord object for each Route 53 record that you want AWS Cloud Map to create when you register an instance.

    " + } + }, + "documentation":"

    A complex type that contains information about changes to the Route 53 DNS records that AWS Cloud Map creates when you register an instance.

    " + }, + "DnsProperties":{ + "type":"structure", + "members":{ + "HostedZoneId":{ + "shape":"ResourceId", + "documentation":"

    The ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    " + } + }, + "documentation":"

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    " + }, + "DnsRecord":{ + "type":"structure", + "required":[ + "Type", + "TTL" + ], + "members":{ + "Type":{ + "shape":"RecordType", + "documentation":"

    The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

    Note the following:

    • A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.

    • CNAME records: If you specify CNAME for Type, you can't define any other records. This is a limitation of DNS: you can't create a CNAME record and any other type of record that has the same name as a CNAME record.

    • Alias records: If you want AWS Cloud Map to create a Route 53 alias record when you register an instance, specify A or AAAA for Type.

    • All records: You specify settings other than TTL and Type when you register an instance.

    The following values are supported:

    A

    Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.

    AAAA

    Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    CNAME

    Route 53 returns the domain name of the resource, such as www.example.com. Note the following:

    • You specify the domain name that you want to route traffic to when you register an instance. For more information, see RegisterInstanceRequest$Attributes.

    • You must specify WEIGHTED for the value of RoutingPolicy.

    • You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

    SRV

    Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

    priority weight port service-hostname

    Note the following about the values:

    • The values of priority and weight are both set to 1 and can't be changed.

    • The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

    • The value of service-hostname is a concatenation of the following values:

      • The value that you specify for InstanceId when you register an instance.

      • The name of the service.

      • The name of the namespace.

      For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is:

      test.backend.example.com

    If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, AWS Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.

    " + }, + "TTL":{ + "shape":"RecordTTL", + "documentation":"

    The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

    Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the AWS_ALIAS_DNS_NAME attribute when you submit a RegisterInstance request, the TTL value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.

    " + } + }, + "documentation":"

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

    " + }, + "DnsRecordList":{ + "type":"list", + "member":{"shape":"DnsRecord"} + }, + "DuplicateRequest":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "DuplicateOperationId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the operation that is already in progress.

    " + } + }, + "documentation":"

    The operation is already in progress.

    ", + "exception":true + }, + "ErrorMessage":{"type":"string"}, + "FailureThreshold":{ + "type":"integer", + "max":10, + "min":1 + }, + "FilterCondition":{ + "type":"string", + "enum":[ + "EQ", + "IN", + "BETWEEN" + ] + }, + "FilterValue":{ + "type":"string", + "max":255, + "min":1 + }, + "FilterValues":{ + "type":"list", + "member":{"shape":"FilterValue"} + }, + "GetInstanceRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "InstanceId" + ], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that the instance is associated with.

    " + }, + "InstanceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the instance that you want to get information about.

    " + } + } + }, + "GetInstanceResponse":{ + "type":"structure", + "members":{ + "Instance":{ + "shape":"Instance", + "documentation":"

    A complex type that contains information about a specified instance.

    " + } + } + }, + "GetInstancesHealthStatusRequest":{ + "type":"structure", + "required":["ServiceId"], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that the instance is associated with.

    " + }, + "Instances":{ + "shape":"InstanceIdList", + "documentation":"

    An array that contains the IDs of all the instances that you want to get the health status for.

    If you omit Instances, AWS Cloud Map returns the health status for all the instances that are associated with the specified service.

    To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of instances that you want AWS Cloud Map to return in the response to a GetInstancesHealthStatus request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first GetInstancesHealthStatus request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    " + } + } + }, + "GetInstancesHealthStatusResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"InstanceHealthStatusMap", + "documentation":"

    A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults instances match the specified criteria, you can submit another GetInstancesHealthStatus request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    " + } + } + }, + "GetNamespaceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace that you want to get information about.

    " + } + } + }, + "GetNamespaceResponse":{ + "type":"structure", + "members":{ + "Namespace":{ + "shape":"Namespace", + "documentation":"

    A complex type that contains information about the specified namespace.

    " + } + } + }, + "GetOperationRequest":{ + "type":"structure", + "required":["OperationId"], + "members":{ + "OperationId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the operation that you want to get more information about.

    " + } + } + }, + "GetOperationResponse":{ + "type":"structure", + "members":{ + "Operation":{ + "shape":"Operation", + "documentation":"

    A complex type that contains information about the operation.

    " + } + } + }, + "GetServiceRequest":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that you want to get settings for.

    " + } + } + }, + "GetServiceResponse":{ + "type":"structure", + "members":{ + "Service":{ + "shape":"Service", + "documentation":"

    A complex type that contains information about the service.

    " + } + } + }, + "HealthCheckConfig":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"HealthCheckType", + "documentation":"

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

    You can't change the value of Type after you create a health check.

    You can create the following types of health checks:

    • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

    • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

      If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

    • TCP: Route 53 tries to establish a TCP connection.

      If you specify TCP for Type, don't specify a value for ResourcePath.

    For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

    " + }, + "ResourcePath":{ + "shape":"ResourcePath", + "documentation":"

    The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

    If you specify TCP for Type, you must not specify a value for ResourcePath.

    " + }, + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

    The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

    " + } + }, + "documentation":"

    Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

    Note the following about configuring health checks.

    A and AAAA records

    If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

    CNAME records

    You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

    Request interval

    A Route 53 health checker in each health-checking region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.

    Health checking regions

    Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions.

    Alias records

    When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

    • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

    • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

    Charges for health checks

    Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

    " + }, + "HealthCheckCustomConfig":{ + "type":"structure", + "members":{ + "FailureThreshold":{ + "shape":"FailureThreshold", + "documentation":"

    The number of 30-second intervals that you want Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold, and then your application sends an UpdateInstanceCustomHealthStatus request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

    Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

    " + } + }, + "documentation":"

    A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

    • You can't use a health check that is defined by HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

    • You want to use a third-party health checker regardless of where your resources are.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

    Here's how custom health checks work:

    1. You create a service and specify a value for FailureThreshold.

      The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.

    2. You register an instance.

    3. You configure a third-party health checker to monitor the resource that is associated with the new instance.

      AWS Cloud Map doesn't check the health of the resource directly.

    4. The third-party health-checker determines that the resource is unhealthy and notifies your application.

    5. Your application submits an UpdateInstanceCustomHealthStatus request.

    6. AWS Cloud Map waits for (FailureThreshold x 30) seconds.

    7. If another UpdateInstanceCustomHealthStatus request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

    Note the following about configuring custom health checks.

    " + }, + "HealthCheckType":{ + "type":"string", + "enum":[ + "HTTP", + "HTTPS", + "TCP" + ] + }, + "HealthStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "UNKNOWN" + ] + }, + "HealthStatusFilter":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY", + "ALL" + ] + }, + "HttpInstanceSummary":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of an instance that matches the values that you specified in the request.

    " + }, + "NamespaceName":{ + "shape":"NamespaceName", + "documentation":"

    The name of the namespace that you specified when you registered the instance.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    The name of the service that you specified when you registered the instance.

    " + }, + "HealthStatus":{ + "shape":"HealthStatus", + "documentation":"

    If you configured health checking in the service, the current health status of the service instance.

    " + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

    If you included any attributes when you registered the instance, the values of those attributes.

    " + } + }, + "documentation":"

    In a response to a DiscoverInstance request, HttpInstanceSummary contains information about one instance that matches the values that you specified in the request.

    " + }, + "HttpInstanceSummaryList":{ + "type":"list", + "member":{"shape":"HttpInstanceSummary"} + }, + "HttpProperties":{ + "type":"structure", + "members":{ + "HttpName":{ + "shape":"NamespaceName", + "documentation":"

    The name of an HTTP namespace.

    " + } + }, + "documentation":"

    A complex type that contains the name of an HTTP namespace.

    " + }, + "Instance":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    An identifier that you want to associate with the instance. Note the following:

    • If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type.

    • You can use this value to update an existing instance.

    • To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

    • If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.

      The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

    A string map that contains the following information for the service that you specify in ServiceId:

    • The attributes that apply to the records that are defined in the service.

    • For each attribute, the applicable value.

    Supported attribute keys include the following:

    AWS_ALIAS_DNS_NAME

    If you want AWS Cloud Map to create a Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget.

    Note the following:

    • The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.

    • In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.

    • If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the health check, but it won't associate the health check with the alias record.

    • Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.

    • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.

    AWS_INSTANCE_CNAME

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com.

    This value is required if the service specified by ServiceId includes settings for an CNAME record.

    AWS_INSTANCE_IPV4

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.

    This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_IPV6

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_PORT

    If the service includes an SRV record, the value that you want Route 53 to return for the port.

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

    This value is required if you specified settings for an SRV record when you created the service.

    " + } + }, + "documentation":"

    A complex type that contains information about an instance that AWS Cloud Map creates when you submit a RegisterInstance request.

    " + }, + "InstanceHealthStatusMap":{ + "type":"map", + "key":{"shape":"ResourceId"}, + "value":{"shape":"HealthStatus"} + }, + "InstanceIdList":{ + "type":"list", + "member":{"shape":"ResourceId"}, + "min":1 + }, + "InstanceNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.

    ", + "exception":true + }, + "InstanceSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID for an instance that you created by using a specified service.

    " + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

    A string map that contains the following information:

    • The attributes that are associate with the instance.

    • For each attribute, the applicable value.

    Supported attribute keys include the following:

    • AWS_ALIAS_DNS_NAME: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer.

    • AWS_INSTANCE_CNAME: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, example.com.

    • AWS_INSTANCE_IPV4: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, 192.0.2.44.

    • AWS_INSTANCE_IPV6: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    • AWS_INSTANCE_PORT: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

    " + } + }, + "documentation":"

    A complex type that contains information about the instances that you registered by using a specified service.

    " + }, + "InstanceSummaryList":{ + "type":"list", + "member":{"shape":"InstanceSummary"} + }, + "InvalidInput":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

    ", + "exception":true + }, + "ListInstancesRequest":{ + "type":"structure", + "required":["ServiceId"], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that you want to list instances for.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListInstances request, omit this value.

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of instances that you want AWS Cloud Map to return in the response to a ListInstances request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 instances.

    " + } + } + }, + "ListInstancesResponse":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"InstanceSummaryList", + "documentation":"

    Summary information about the instances that are associated with the specified service.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If more than MaxResults instances match the specified criteria, you can submit another ListInstances request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    " + } + } + }, + "ListNamespacesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListNamespaces request, omit this value.

    If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of namespaces that you want AWS Cloud Map to return in the response to a ListNamespaces request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 namespaces.

    " + }, + "Filters":{ + "shape":"NamespaceFilters", + "documentation":"

    A complex type that contains specifications for the namespaces that you want to list.

    If you specify more than one filter, a namespace must match all filters to be returned by ListNamespaces.

    " + } + } + }, + "ListNamespacesResponse":{ + "type":"structure", + "members":{ + "Namespaces":{ + "shape":"NamespaceSummariesList", + "documentation":"

    An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response contains NextToken, submit another ListNamespaces request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first MaxResults namespaces matched the specified criteria but that subsequent groups of MaxResults namespaces do contain namespaces that match the criteria.

    " + } + } + }, + "ListOperationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListOperations request, omit this value.

    If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items that you want AWS Cloud Map to return in the response to a ListOperations request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 operations.

    " + }, + "Filters":{ + "shape":"OperationFilters", + "documentation":"

    A complex type that contains specifications for the operations that you want to list, for example, operations that you started between a specified start date and end date.

    If you specify more than one filter, an operation must match all filters to be returned by ListOperations.

    " + } + } + }, + "ListOperationsResponse":{ + "type":"structure", + "members":{ + "Operations":{ + "shape":"OperationSummaryList", + "documentation":"

    Summary information about the operations that match the specified criteria.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response contains NextToken, submit another ListOperations request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults operations and then filters them based on the specified criteria. It's possible that no operations in the first MaxResults operations matched the specified criteria but that subsequent groups of MaxResults operations do contain operations that match the criteria.

    " + } + } + }, + "ListServicesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    For the first ListServices request, omit this value.

    If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of services that you want AWS Cloud Map to return in the response to a ListServices request. If you don't specify a value for MaxResults, AWS Cloud Map returns up to 100 services.

    " + }, + "Filters":{ + "shape":"ServiceFilters", + "documentation":"

    A complex type that contains specifications for the namespaces that you want to list services for.

    If you specify more than one filter, an operation must match all filters to be returned by ListServices.

    " + } + } + }, + "ListServicesResponse":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ServiceSummariesList", + "documentation":"

    An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response contains NextToken, submit another ListServices request to get the next group of results. Specify the value of NextToken from the previous response in the next request.

    AWS Cloud Map gets MaxResults services and then filters them based on the specified criteria. It's possible that no services in the first MaxResults services matched the specified criteria but that subsequent groups of MaxResults services do contain services that match the criteria.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "Message":{"type":"string"}, + "Namespace":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of a namespace.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

    " + }, + "Name":{ + "shape":"NamespaceName", + "documentation":"

    The name of the namespace, such as example.com.

    " + }, + "Type":{ + "shape":"NamespaceType", + "documentation":"

    The type of the namespace. Valid values are DNS_PUBLIC and DNS_PRIVATE.

    " + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    The description that you specify for the namespace when you create it.

    " + }, + "ServiceCount":{ + "shape":"ResourceCount", + "documentation":"

    The number of services that are associated with the namespace.

    " + }, + "Properties":{ + "shape":"NamespaceProperties", + "documentation":"

    A complex type that contains information that's specific to the type of the namespace.

    " + }, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.

    " + } + }, + "documentation":"

    A complex type that contains information about a specified namespace.

    " + }, + "NamespaceAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    The CreatorRequestId that was used to create the namespace.

    " + }, + "NamespaceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the existing namespace.

    " + } + }, + "documentation":"

    The namespace that you're trying to create already exists.

    ", + "exception":true + }, + "NamespaceFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"NamespaceFilterName", + "documentation":"

    Specify TYPE.

    " + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

    If you specify EQ for Condition, specify either DNS_PUBLIC or DNS_PRIVATE.

    If you specify IN for Condition, you can specify DNS_PUBLIC, DNS_PRIVATE, or both.

    " + }, + "Condition":{ + "shape":"FilterCondition", + "documentation":"

    The operator that you want to use to determine whether ListNamespaces returns a namespace. Valid values for condition include:

    • EQ: When you specify EQ for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ is the default condition and can be omitted.

    • IN: When you specify IN for the condition, you can choose to list public namespaces, private namespaces, or both.

    • BETWEEN: Not applicable

    " + } + }, + "documentation":"

    A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.

    " + }, + "NamespaceFilterName":{ + "type":"string", + "enum":["TYPE"] + }, + "NamespaceFilters":{ + "type":"list", + "member":{"shape":"NamespaceFilter"} + }, + "NamespaceName":{ + "type":"string", + "max":1024 + }, + "NamespaceNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    No namespace exists with the specified ID.

    ", + "exception":true + }, + "NamespaceProperties":{ + "type":"structure", + "members":{ + "DnsProperties":{ + "shape":"DnsProperties", + "documentation":"

    A complex type that contains the ID for the Route 53 hosted zone that AWS Cloud Map creates when you create a namespace.

    " + }, + "HttpProperties":{ + "shape":"HttpProperties", + "documentation":"

    A complex type that contains the name of an HTTP namespace.

    " + } + }, + "documentation":"

    A complex type that contains information that is specific to the namespace type.

    " + }, + "NamespaceSummariesList":{ + "type":"list", + "member":{"shape":"NamespaceSummary"} + }, + "NamespaceSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the namespace when you create it.

    " + }, + "Name":{ + "shape":"NamespaceName", + "documentation":"

    The name of the namespace. When you create a namespace, AWS Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

    " + }, + "Type":{ + "shape":"NamespaceType", + "documentation":"

    The type of the namespace, either public or private.

    " + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the namespace.

    " + }, + "ServiceCount":{ + "shape":"ResourceCount", + "documentation":"

    The number of services that were created using the namespace.

    " + }, + "Properties":{"shape":"NamespaceProperties"}, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the namespace was created.

    " + } + }, + "documentation":"

    A complex type that contains information about a namespace.

    " + }, + "NamespaceType":{ + "type":"string", + "enum":[ + "DNS_PUBLIC", + "DNS_PRIVATE", + "HTTP" + ] + }, + "NextToken":{ + "type":"string", + "max":4096 + }, + "Operation":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"OperationId", + "documentation":"

    The ID of the operation that you want to get information about.

    " + }, + "Type":{ + "shape":"OperationType", + "documentation":"

    The name of the operation that is associated with the specified ID.

    " + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

    The status of the operation. Values include the following:

    • SUBMITTED: This is the initial state immediately after you submit a request.

    • PENDING: AWS Cloud Map is performing the operation.

    • SUCCESS: The operation succeeded.

    • FAIL: The operation failed. For the failure reason, see ErrorMessage.

    " + }, + "ErrorMessage":{ + "shape":"Message", + "documentation":"

    If the value of Status is FAIL, the reason that the operation failed.

    " + }, + "ErrorCode":{ + "shape":"Code", + "documentation":"

    The code associated with ErrorMessage. Values for ErrorCode include the following:

    • ACCESS_DENIED

    • CANNOT_CREATE_HOSTED_ZONE

    • EXPIRED_TOKEN

    • HOSTED_ZONE_NOT_FOUND

    • INTERNAL_FAILURE

    • INVALID_CHANGE_BATCH

    • THROTTLED_REQUEST

    " + }, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + }, + "UpdateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the value of Status changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + }, + "Targets":{ + "shape":"OperationTargetsMap", + "documentation":"

    The name of the target entity that is associated with the operation:

    • NAMESPACE: The namespace ID is returned in the ResourceId property.

    • SERVICE: The service ID is returned in the ResourceId property.

    • INSTANCE: The instance ID is returned in the ResourceId property.

    " + } + }, + "documentation":"

    A complex type that contains information about a specified operation.

    " + }, + "OperationFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"OperationFilterName", + "documentation":"

    Specify the operations that you want to get:

    • NAMESPACE_ID: Gets operations related to specified namespaces.

    • SERVICE_ID: Gets operations related to specified services.

    • STATUS: Gets operations based on the status of the operations: SUBMITTED, PENDING, SUCCEED, or FAIL.

    • TYPE: Gets specified types of operation.

    • UPDATE_DATE: Gets operations that changed status during a specified date/time range.

    " + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

    Specify values that are applicable to the value that you specify for Name:

    • NAMESPACE_ID: Specify one namespace ID.

    • SERVICE_ID: Specify one service ID.

    • STATUS: Specify one or more statuses: SUBMITTED, PENDING, SUCCEED, or FAIL.

    • TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_INSTANCE.

    • UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.

    " + }, + "Condition":{ + "shape":"FilterCondition", + "documentation":"

    The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

    • EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.

    • IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. An operation must match one of the specified values to be returned in the response.

    • BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN is supported for UPDATE_DATE.

    " + } + }, + "documentation":"

    A complex type that lets you select the operations that you want to list.

    " + }, + "OperationFilterName":{ + "type":"string", + "enum":[ + "NAMESPACE_ID", + "SERVICE_ID", + "STATUS", + "TYPE", + "UPDATE_DATE" + ] + }, + "OperationFilters":{ + "type":"list", + "member":{"shape":"OperationFilter"} + }, + "OperationId":{ + "type":"string", + "max":255 + }, + "OperationNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    No operation exists with the specified ID.

    ", + "exception":true + }, + "OperationStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "PENDING", + "SUCCESS", + "FAIL" + ] + }, + "OperationSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"OperationId", + "documentation":"

    The ID for an operation.

    " + }, + "Status":{ + "shape":"OperationStatus", + "documentation":"

    The status of the operation. Values include the following:

    • SUBMITTED: This is the initial state immediately after you submit a request.

    • PENDING: AWS Cloud Map is performing the operation.

    • SUCCESS: The operation succeeded.

    • FAIL: The operation failed. For the failure reason, see ErrorMessage.

    " + } + }, + "documentation":"

    A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.

    " + }, + "OperationSummaryList":{ + "type":"list", + "member":{"shape":"OperationSummary"} + }, + "OperationTargetType":{ + "type":"string", + "enum":[ + "NAMESPACE", + "SERVICE", + "INSTANCE" + ] + }, + "OperationTargetsMap":{ + "type":"map", + "key":{"shape":"OperationTargetType"}, + "value":{"shape":"ResourceId"} + }, + "OperationType":{ + "type":"string", + "enum":[ + "CREATE_NAMESPACE", + "DELETE_NAMESPACE", + "UPDATE_SERVICE", + "REGISTER_INSTANCE", + "DEREGISTER_INSTANCE" + ] + }, + "RecordTTL":{ + "type":"long", + "max":2147483647, + "min":0 + }, + "RecordType":{ + "type":"string", + "enum":[ + "SRV", + "A", + "AAAA", + "CNAME" + ] + }, + "RegisterInstanceRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "InstanceId", + "Attributes" + ], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that you want to use for settings for the instance.

    " + }, + "InstanceId":{ + "shape":"ResourceId", + "documentation":"

    An identifier that you want to associate with the instance. Note the following:

    • If the service that is specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. For more information, see DnsRecord$Type.

    • You can use this value to update an existing instance.

    • To register a new instance, you must specify a value that is unique among instances that you register by using the same service.

    • If you specify an existing InstanceId and ServiceId, AWS Cloud Map updates the existing DNS records, if any. If there's also an existing health check, AWS Cloud Map deletes the old health check and creates a new one.

      The health check isn't deleted immediately, so it will still appear for a while if you submit a ListHealthChecks request, for example.
    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string, for example, a date/time stamp.

    ", + "idempotencyToken":true + }, + "Attributes":{ + "shape":"Attributes", + "documentation":"

    A string map that contains the following information for the service that you specify in ServiceId:

    • The attributes that apply to the records that are defined in the service.

    • For each attribute, the applicable value.

    Supported attribute keys include the following:

    AWS_ALIAS_DNS_NAME

    If you want AWS Cloud Map to create an Amazon Route 53 alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see \"DNSName\" in the topic AliasTarget in the Route 53 API Reference.

    Note the following:

    • The configuration for the service that is specified by ServiceId must include settings for an A record, an AAAA record, or both.

    • In the service that is specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.

    • If the service that is specified by ServiceId includes HealthCheckConfig settings, AWS Cloud Map will create the Route 53 health check, but it won't associate the health check with the alias record.

    • Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.

    • If you specify a value for AWS_ALIAS_DNS_NAME, don't specify values for any of the AWS_INSTANCE attributes.

    AWS_INIT_HEALTH_STATUS

    If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

    AWS_INSTANCE_CNAME

    If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com.

    This value is required if the service specified by ServiceId includes settings for an CNAME record.

    AWS_INSTANCE_IPV4

    If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44.

    This value is required if the service specified by ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_IPV6

    If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345.

    This value is required if the service specified by ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

    AWS_INSTANCE_PORT

    If the service includes an SRV record, the value that you want Route 53 to return for the port.

    If the service includes HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.

    This value is required if you specified settings for an SRV record when you created the service.

    Custom attributes

    You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters.

    " + } + } + }, + "RegisterInstanceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + }, + "ResourceCount":{"type":"integer"}, + "ResourceDescription":{ + "type":"string", + "max":1024 + }, + "ResourceId":{ + "type":"string", + "max":64 + }, + "ResourceInUse":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.

    ", + "exception":true + }, + "ResourceLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The resource can't be created because you've reached the limit on the number of resources.

    ", + "exception":true + }, + "ResourcePath":{ + "type":"string", + "max":255 + }, + "RoutingPolicy":{ + "type":"string", + "enum":[ + "MULTIVALUE", + "WEIGHTED" + ] + }, + "Service":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID that AWS Cloud Map assigned to the service when you created it.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " + }, + "Name":{ + "shape":"ServiceName", + "documentation":"

    The name of the service.

    " + }, + "NamespaceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the namespace that was used to create the service.

    " + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    The description of the service.

    " + }, + "InstanceCount":{ + "shape":"ResourceCount", + "documentation":"

    The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

    " + }, + "DnsConfig":{ + "shape":"DnsConfig", + "documentation":"

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

    " + }, + "HealthCheckConfig":{ + "shape":"HealthCheckConfig", + "documentation":"

    Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig.

    For information about the charges for health checks, see Amazon Route 53 Pricing.

    " + }, + "HealthCheckCustomConfig":{ + "shape":"HealthCheckCustomConfig", + "documentation":"

    A complex type that contains information about an optional custom health check.

    If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

    " + }, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

    " + }, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

    " + } + }, + "documentation":"

    A complex type that contains information about the specified service.

    " + }, + "ServiceAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "CreatorRequestId":{ + "shape":"ResourceId", + "documentation":"

    The CreatorRequestId that was used to create the service.

    " + }, + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the existing service.

    " + } + }, + "documentation":"

    The service can't be created because a service with the same name already exists.

    ", + "exception":true + }, + "ServiceChange":{ + "type":"structure", + "required":["DnsConfig"], + "members":{ + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    A description for the service.

    " + }, + "DnsConfig":{ + "shape":"DnsConfigChange", + "documentation":"

    A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

    " + }, + "HealthCheckConfig":{"shape":"HealthCheckConfig"} + }, + "documentation":"

    A complex type that contains changes to an existing service.

    " + }, + "ServiceFilter":{ + "type":"structure", + "required":[ + "Name", + "Values" + ], + "members":{ + "Name":{ + "shape":"ServiceFilterName", + "documentation":"

    Specify NAMESPACE_ID.

    " + }, + "Values":{ + "shape":"FilterValues", + "documentation":"

    The values that are applicable to the value that you specify for Condition to filter the list of services.

    " + }, + "Condition":{ + "shape":"FilterCondition", + "documentation":"

    The operator that you want to use to determine whether a service is returned by ListServices. Valid values for Condition include the following:

    • EQ: When you specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted.

    • IN: When you specify IN, specify a list of the IDs for the namespaces that you want ListServices to return a list of services for.

    • BETWEEN: Not applicable.

    " + } + }, + "documentation":"

    A complex type that lets you specify the namespaces that you want to list services for.

    " + }, + "ServiceFilterName":{ + "type":"string", + "enum":["NAMESPACE_ID"] + }, + "ServiceFilters":{ + "type":"list", + "member":{"shape":"ServiceFilter"} + }, + "ServiceName":{ + "type":"string", + "pattern":"((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(\\.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^\\.$)" + }, + "ServiceNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    No service exists with the specified ID.

    ", + "exception":true + }, + "ServiceSummariesList":{ + "type":"list", + "member":{"shape":"ServiceSummary"} + }, + "ServiceSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID that AWS Cloud Map assigned to the service when you created it.

    " + }, + "Arn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that AWS Cloud Map assigns to the service when you create it.

    " + }, + "Name":{ + "shape":"ServiceName", + "documentation":"

    The name of the service.

    " + }, + "Description":{ + "shape":"ResourceDescription", + "documentation":"

    The description that you specify when you create the service.

    " + }, + "InstanceCount":{ + "shape":"ResourceCount", + "documentation":"

    The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.

    " + }, + "DnsConfig":{"shape":"DnsConfig"}, + "HealthCheckConfig":{"shape":"HealthCheckConfig"}, + "HealthCheckCustomConfig":{"shape":"HealthCheckCustomConfig"}, + "CreateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time that the service was created.

    " + } + }, + "documentation":"

    A complex type that contains information about a specified service.

    " + }, + "Timestamp":{"type":"timestamp"}, + "UpdateInstanceCustomHealthStatusRequest":{ + "type":"structure", + "required":[ + "ServiceId", + "InstanceId", + "Status" + ], + "members":{ + "ServiceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that includes the configuration for the custom health check that you want to change the status for.

    " + }, + "InstanceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the instance that you want to change the health status for.

    " + }, + "Status":{ + "shape":"CustomHealthStatus", + "documentation":"

    The new status of the instance, HEALTHY or UNHEALTHY.

    " + } + } + }, + "UpdateServiceRequest":{ + "type":"structure", + "required":[ + "Id", + "Service" + ], + "members":{ + "Id":{ + "shape":"ResourceId", + "documentation":"

    The ID of the service that you want to update.

    " + }, + "Service":{ + "shape":"ServiceChange", + "documentation":"

    A complex type that contains the new settings for the service.

    " + } + } + }, + "UpdateServiceResponse":{ + "type":"structure", + "members":{ + "OperationId":{ + "shape":"OperationId", + "documentation":"

    A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

    " + } + } + } + }, + "documentation":"

    AWS Cloud Map lets you configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance of the service becomes available, you can call the AWS Cloud Map API to register the instance with AWS Cloud Map. For public or private DNS namespaces, AWS Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.

    " +} diff --git a/aws/dist/botocore/data/ses/2010-12-01/examples-1.json b/aws/dist/botocore/data/ses/2010-12-01/examples-1.json new file mode 100644 index 00000000..88555294 --- /dev/null +++ b/aws/dist/botocore/data/ses/2010-12-01/examples-1.json @@ -0,0 +1,953 @@ +{ + "version": "1.0", + "examples": { + "CloneReceiptRuleSet": [ + { + "input": { + "OriginalRuleSetName": "RuleSetToClone", + "RuleSetName": "RuleSetToCreate" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a receipt rule set by cloning an existing one:", + "id": "clonereceiptruleset-1469055039770", + "title": "CloneReceiptRuleSet" + } + ], + "CreateReceiptFilter": [ + { + "input": { + "Filter": { + "IpFilter": { + "Cidr": "1.2.3.4/24", + "Policy": "Allow" + }, + "Name": "MyFilter" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new IP address filter:", + "id": "createreceiptfilter-1469122681253", + "title": "CreateReceiptFilter" + } + ], + "CreateReceiptRule": [ + { + "input": { + "After": "", + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + }, + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a new receipt rule:", + "id": "createreceiptrule-1469122946515", + "title": "CreateReceiptRule" + } + ], + "CreateReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an empty receipt rule set:", + "id": "createreceiptruleset-1469058761646", + "title": "CreateReceiptRuleSet" + } + ], + "DeleteIdentity": [ + { + "input": { + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an identity from the list of identities that have been submitted for verification with Amazon SES:", + "id": "deleteidentity-1469047858906", + "title": "DeleteIdentity" + } + ], + "DeleteIdentityPolicy": [ + { + "input": { + "Identity": "user@example.com", + "PolicyName": "MyPolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a sending authorization policy for an identity:", + "id": "deleteidentitypolicy-1469055282499", + "title": "DeleteIdentityPolicy" + } + ], + "DeleteReceiptFilter": [ + { + "input": { + "FilterName": "MyFilter" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP address filter:", + "id": "deletereceiptfilter-1469055456835", + "title": "DeleteReceiptFilter" + } + ], + "DeleteReceiptRule": [ + { + "input": { + "RuleName": "MyRule", + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a receipt rule:", + "id": "deletereceiptrule-1469055563599", + "title": "DeleteReceiptRule" + } + ], + "DeleteReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a receipt rule set:", + "id": "deletereceiptruleset-1469055713690", + "title": "DeleteReceiptRuleSet" + } + ], + "DeleteVerifiedEmailAddress": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an email address from the list of identities that have been submitted for verification with Amazon SES:", + "id": "deleteverifiedemailaddress-1469051086444", + "title": "DeleteVerifiedEmailAddress" + } + ], + "DescribeActiveReceiptRuleSet": [ + { + "input": { + }, + "output": { + "Metadata": { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "default-rule-set" + }, + "Rules": [ + { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the metadata and receipt rules for the receipt rule set that is currently active:", + "id": "describeactivereceiptruleset-1469121611502", + "title": "DescribeActiveReceiptRuleSet" + } + ], + "DescribeReceiptRule": [ + { + "input": { + "RuleName": "MyRule", + "RuleSetName": "MyRuleSet" + }, + "output": { + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a receipt rule:", + "id": "describereceiptrule-1469055813118", + "title": "DescribeReceiptRule" + } + ], + "DescribeReceiptRuleSet": [ + { + "input": { + "RuleSetName": "MyRuleSet" + }, + "output": { + "Metadata": { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "MyRuleSet" + }, + "Rules": [ + { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the metadata and receipt rules of a receipt rule set:", + "id": "describereceiptruleset-1469121240385", + "title": "DescribeReceiptRuleSet" + } + ], + "GetIdentityDkimAttributes": [ + { + "input": { + "Identities": [ + "example.com", + "user@example.com" + ] + }, + "output": { + "DkimAttributes": { + "example.com": { + "DkimEnabled": true, + "DkimTokens": [ + "EXAMPLEjcs5xoyqytjsotsijas7236gr", + "EXAMPLEjr76cvoc6mysspnioorxsn6ep", + "EXAMPLEkbmkqkhlm2lyz77ppkulerm4k" + ], + "DkimVerificationStatus": "Success" + }, + "user@example.com": { + "DkimEnabled": false, + "DkimVerificationStatus": "NotStarted" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves the Amazon SES Easy DKIM attributes for a list of identities:", + "id": "getidentitydkimattributes-1469050695628", + "title": "GetIdentityDkimAttributes" + } + ], + "GetIdentityMailFromDomainAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "MailFromDomainAttributes": { + "example.com": { + "BehaviorOnMXFailure": "UseDefaultValue", + "MailFromDomain": "bounces.example.com", + "MailFromDomainStatus": "Success" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the custom MAIL FROM attributes for an identity:", + "id": "getidentitymailfromdomainattributes-1469123114860", + "title": "GetIdentityMailFromDomainAttributes" + } + ], + "GetIdentityNotificationAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "NotificationAttributes": { + "example.com": { + "BounceTopic": "arn:aws:sns:us-east-1:EXAMPLE65304:ExampleTopic", + "ForwardingEnabled": true, + "HeadersInBounceNotificationsEnabled": false, + "HeadersInComplaintNotificationsEnabled": false, + "HeadersInDeliveryNotificationsEnabled": false + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the notification attributes for an identity:", + "id": "getidentitynotificationattributes-1469123466947", + "title": "GetIdentityNotificationAttributes" + } + ], + "GetIdentityPolicies": [ + { + "input": { + "Identity": "example.com", + "PolicyNames": [ + "MyPolicy" + ] + }, + "output": { + "Policies": { + "MyPolicy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a sending authorization policy for an identity:", + "id": "getidentitypolicies-1469123949351", + "title": "GetIdentityPolicies" + } + ], + "GetIdentityVerificationAttributes": [ + { + "input": { + "Identities": [ + "example.com" + ] + }, + "output": { + "VerificationAttributes": { + "example.com": { + "VerificationStatus": "Success", + "VerificationToken": "EXAMPLE3VYb9EDI2nTOQRi/Tf6MI/6bD6THIGiP1MVY=" + } + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the verification status and the verification token for a domain identity:", + "id": "getidentityverificationattributes-1469124205897", + "title": "GetIdentityVerificationAttributes" + } + ], + "GetSendQuota": [ + { + "output": { + "Max24HourSend": 200, + "MaxSendRate": 1, + "SentLast24Hours": 1 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the Amazon SES sending limits for an AWS account:", + "id": "getsendquota-1469047324508", + "title": "GetSendQuota" + } + ], + "GetSendStatistics": [ + { + "output": { + "SendDataPoints": [ + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 5, + "Rejects": 0, + "Timestamp": "2016-07-13T22:43:00Z" + }, + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 3, + "Rejects": 0, + "Timestamp": "2016-07-13T23:13:00Z" + }, + { + "Bounces": 0, + "Complaints": 0, + "DeliveryAttempts": 1, + "Rejects": 0, + "Timestamp": "2016-07-13T21:13:00Z" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns Amazon SES sending statistics:", + "id": "getsendstatistics-1469047741329", + "title": "GetSendStatistics" + } + ], + "ListIdentities": [ + { + "input": { + "IdentityType": "EmailAddress", + "MaxItems": 123, + "NextToken": "" + }, + "output": { + "Identities": [ + "user@example.com" + ], + "NextToken": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the email address identities that have been submitted for verification with Amazon SES:", + "id": "listidentities-1469048638493", + "title": "ListIdentities" + } + ], + "ListIdentityPolicies": [ + { + "input": { + "Identity": "example.com" + }, + "output": { + "PolicyNames": [ + "MyPolicy" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a list of sending authorization policies that are attached to an identity:", + "id": "listidentitypolicies-1469124417674", + "title": "ListIdentityPolicies" + } + ], + "ListReceiptFilters": [ + { + "output": { + "Filters": [ + { + "IpFilter": { + "Cidr": "1.2.3.4/24", + "Policy": "Block" + }, + "Name": "MyFilter" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the IP address filters that are associated with an AWS account:", + "id": "listreceiptfilters-1469120786789", + "title": "ListReceiptFilters" + } + ], + "ListReceiptRuleSets": [ + { + "input": { + "NextToken": "" + }, + "output": { + "NextToken": "", + "RuleSets": [ + { + "CreatedTimestamp": "2016-07-15T16:25:59.607Z", + "Name": "MyRuleSet" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists the receipt rule sets that exist under an AWS account:", + "id": "listreceiptrulesets-1469121037235", + "title": "ListReceiptRuleSets" + } + ], + "ListVerifiedEmailAddresses": [ + { + "output": { + "VerifiedEmailAddresses": [ + "user1@example.com", + "user2@example.com" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example lists all email addresses that have been submitted for verification with Amazon SES:", + "id": "listverifiedemailaddresses-1469051402570", + "title": "ListVerifiedEmailAddresses" + } + ], + "PutIdentityPolicy": [ + { + "input": { + "Identity": "example.com", + "Policy": "{\"Version\":\"2008-10-17\",\"Statement\":[{\"Sid\":\"stmt1469123904194\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789012:root\"},\"Action\":[\"ses:SendEmail\",\"ses:SendRawEmail\"],\"Resource\":\"arn:aws:ses:us-east-1:EXAMPLE65304:identity/example.com\"}]}", + "PolicyName": "MyPolicy" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example adds a sending authorization policy to an identity:", + "id": "putidentitypolicy-1469124560016", + "title": "PutIdentityPolicy" + } + ], + "ReorderReceiptRuleSet": [ + { + "input": { + "RuleNames": [ + "MyRule", + "MyOtherRule" + ], + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example reorders the receipt rules within a receipt rule set:", + "id": "reorderreceiptruleset-1469058156806", + "title": "ReorderReceiptRuleSet" + } + ], + "SendEmail": [ + { + "input": { + "Destination": { + "BccAddresses": [ + + ], + "CcAddresses": [ + "recipient3@example.com" + ], + "ToAddresses": [ + "recipient1@example.com", + "recipient2@example.com" + ] + }, + "Message": { + "Body": { + "Html": { + "Charset": "UTF-8", + "Data": "This message body contains HTML formatting. It can, for example, contain links like this one: Amazon SES Developer Guide." + }, + "Text": { + "Charset": "UTF-8", + "Data": "This is the message body in text format." + } + }, + "Subject": { + "Charset": "UTF-8", + "Data": "Test email" + } + }, + "ReplyToAddresses": [ + + ], + "ReturnPath": "", + "ReturnPathArn": "", + "Source": "sender@example.com", + "SourceArn": "" + }, + "output": { + "MessageId": "EXAMPLE78603177f-7a5433e7-8edb-42ae-af10-f0181f34d6ee-000000" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sends a formatted email:", + "id": "sendemail-1469049656296", + "title": "SendEmail" + } + ], + "SendRawEmail": [ + { + "input": { + "Destinations": [ + + ], + "FromArn": "", + "RawMessage": { + "Data": "From: sender@example.com\\nTo: recipient@example.com\\nSubject: Test email (contains an attachment)\\nMIME-Version: 1.0\\nContent-type: Multipart/Mixed; boundary=\"NextPart\"\\n\\n--NextPart\\nContent-Type: text/plain\\n\\nThis is the message body.\\n\\n--NextPart\\nContent-Type: text/plain;\\nContent-Disposition: attachment; filename=\"attachment.txt\"\\n\\nThis is the text in the attachment.\\n\\n--NextPart--" + }, + "ReturnPathArn": "", + "Source": "", + "SourceArn": "" + }, + "output": { + "MessageId": "EXAMPLEf3f73d99b-c63fb06f-d263-41f8-a0fb-d0dc67d56c07-000000" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sends an email with an attachment:", + "id": "sendrawemail-1469118548649", + "title": "SendRawEmail" + } + ], + "SetActiveReceiptRuleSet": [ + { + "input": { + "RuleSetName": "RuleSetToActivate" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the active receipt rule set:", + "id": "setactivereceiptruleset-1469058391329", + "title": "SetActiveReceiptRuleSet" + } + ], + "SetIdentityDkimEnabled": [ + { + "input": { + "DkimEnabled": true, + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to Easy DKIM-sign the email sent from an identity:", + "id": "setidentitydkimenabled-1469057485202", + "title": "SetIdentityDkimEnabled" + } + ], + "SetIdentityFeedbackForwardingEnabled": [ + { + "input": { + "ForwardingEnabled": true, + "Identity": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to forward an identity's bounces and complaints via email:", + "id": "setidentityfeedbackforwardingenabled-1469056811329", + "title": "SetIdentityFeedbackForwardingEnabled" + } + ], + "SetIdentityHeadersInNotificationsEnabled": [ + { + "input": { + "Enabled": true, + "Identity": "user@example.com", + "NotificationType": "Bounce" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to include the original email headers in the Amazon SNS bounce notifications for an identity:", + "id": "setidentityheadersinnotificationsenabled-1469057295001", + "title": "SetIdentityHeadersInNotificationsEnabled" + } + ], + "SetIdentityMailFromDomain": [ + { + "input": { + "BehaviorOnMXFailure": "UseDefaultValue", + "Identity": "user@example.com", + "MailFromDomain": "bounces.example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example configures Amazon SES to use a custom MAIL FROM domain for an identity:", + "id": "setidentitymailfromdomain-1469057693908", + "title": "SetIdentityMailFromDomain" + } + ], + "SetIdentityNotificationTopic": [ + { + "input": { + "Identity": "user@example.com", + "NotificationType": "Bounce", + "SnsTopic": "arn:aws:sns:us-west-2:111122223333:MyTopic" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the Amazon SNS topic to which Amazon SES will publish bounce, complaint, and/or delivery notifications for emails sent with the specified identity as the Source:", + "id": "setidentitynotificationtopic-1469057854966", + "title": "SetIdentityNotificationTopic" + } + ], + "SetReceiptRulePosition": [ + { + "input": { + "After": "PutRuleAfterThisRule", + "RuleName": "RuleToReposition", + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example sets the position of a receipt rule in a receipt rule set:", + "id": "setreceiptruleposition-1469058530550", + "title": "SetReceiptRulePosition" + } + ], + "UpdateReceiptRule": [ + { + "input": { + "Rule": { + "Actions": [ + { + "S3Action": { + "BucketName": "MyBucket", + "ObjectKeyPrefix": "email" + } + } + ], + "Enabled": true, + "Name": "MyRule", + "ScanEnabled": true, + "TlsPolicy": "Optional" + }, + "RuleSetName": "MyRuleSet" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example updates a receipt rule to use an Amazon S3 action:", + "id": "updatereceiptrule-1469051756940", + "title": "UpdateReceiptRule" + } + ], + "VerifyDomainDkim": [ + { + "input": { + "Domain": "example.com" + }, + "output": { + "DkimTokens": [ + "EXAMPLEq76owjnks3lnluwg65scbemvw", + "EXAMPLEi3dnsj67hstzaj673klariwx2", + "EXAMPLEwfbtcukvimehexktmdtaz6naj" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example generates DKIM tokens for a domain that has been verified with Amazon SES:", + "id": "verifydomaindkim-1469049503083", + "title": "VerifyDomainDkim" + } + ], + "VerifyDomainIdentity": [ + { + "input": { + "Domain": "example.com" + }, + "output": { + "VerificationToken": "eoEmxw+YaYhb3h3iVJHuXMJXqeu1q1/wwmvjuEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the domain verification process with Amazon SES:", + "id": "verifydomainidentity-1469049165936", + "title": "VerifyDomainIdentity" + } + ], + "VerifyEmailAddress": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the email address verification process with Amazon SES:", + "id": "verifyemailaddress-1469048849187", + "title": "VerifyEmailAddress" + } + ], + "VerifyEmailIdentity": [ + { + "input": { + "EmailAddress": "user@example.com" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example starts the email address verification process with Amazon SES:", + "id": "verifyemailidentity-1469049068623", + "title": "VerifyEmailIdentity" + } + ] + } +} diff --git a/aws/dist/botocore/data/ses/2010-12-01/paginators-1.json b/aws/dist/botocore/data/ses/2010-12-01/paginators-1.json new file mode 100644 index 00000000..1eb0054f --- /dev/null +++ b/aws/dist/botocore/data/ses/2010-12-01/paginators-1.json @@ -0,0 +1,33 @@ +{ + "pagination": { + "ListIdentities": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxItems", + "result_key": "Identities" + }, + "ListCustomVerificationEmailTemplates": { + "result_key": "CustomVerificationEmailTemplates", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListConfigurationSets": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "ConfigurationSets" + }, + "ListReceiptRuleSets": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "RuleSets" + }, + "ListTemplates": { + "input_token": "NextToken", + "limit_key": "MaxItems", + "output_token": "NextToken", + "result_key": "TemplatesMetadata" + } + } +} diff --git a/aws/dist/botocore/data/ses/2010-12-01/service-2.json b/aws/dist/botocore/data/ses/2010-12-01/service-2.json new file mode 100644 index 00000000..5c376aa4 --- /dev/null +++ b/aws/dist/botocore/data/ses/2010-12-01/service-2.json @@ -0,0 +1,4479 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-12-01", + "endpointPrefix":"email", + "protocol":"query", + "serviceAbbreviation":"Amazon SES", + "serviceFullName":"Amazon Simple Email Service", + "serviceId":"SES", + "signatureVersion":"v4", + "signingName":"ses", + "uid":"email-2010-12-01", + "xmlNamespace":"http://ses.amazonaws.com/doc/2010-12-01/" + }, + "operations":{ + "CloneReceiptRuleSet":{ + "name":"CloneReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CloneReceiptRuleSetRequest"}, + "output":{ + "shape":"CloneReceiptRuleSetResponse", + "resultWrapper":"CloneReceiptRuleSetResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a receipt rule set by cloning an existing one. All receipt rules and configurations are copied to the new receipt rule set and are completely independent of the source rule set.

    For information about setting up rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateConfigurationSet":{ + "name":"CreateConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConfigurationSetRequest"}, + "output":{ + "shape":"CreateConfigurationSetResponse", + "resultWrapper":"CreateConfigurationSetResult" + }, + "errors":[ + {"shape":"ConfigurationSetAlreadyExistsException"}, + {"shape":"InvalidConfigurationSetException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a configuration set.

    Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateConfigurationSetEventDestination":{ + "name":"CreateConfigurationSetEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConfigurationSetEventDestinationRequest"}, + "output":{ + "shape":"CreateConfigurationSetEventDestinationResponse", + "resultWrapper":"CreateConfigurationSetEventDestinationResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"EventDestinationAlreadyExistsException"}, + {"shape":"InvalidCloudWatchDestinationException"}, + {"shape":"InvalidFirehoseDestinationException"}, + {"shape":"InvalidSNSDestinationException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a configuration set event destination.

    When you create or update an event destination, you must provide one, and only one, destination. The destination can be CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

    An event destination is the AWS service to which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateConfigurationSetTrackingOptions":{ + "name":"CreateConfigurationSetTrackingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateConfigurationSetTrackingOptionsRequest"}, + "output":{ + "shape":"CreateConfigurationSetTrackingOptionsResponse", + "resultWrapper":"CreateConfigurationSetTrackingOptionsResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"TrackingOptionsAlreadyExistsException"}, + {"shape":"InvalidTrackingOptionsException"} + ], + "documentation":"

    Creates an association between a configuration set and a custom domain for open and click event tracking.

    By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    " + }, + "CreateCustomVerificationEmailTemplate":{ + "name":"CreateCustomVerificationEmailTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCustomVerificationEmailTemplateRequest"}, + "errors":[ + {"shape":"CustomVerificationEmailTemplateAlreadyExistsException"}, + {"shape":"FromEmailAddressNotVerifiedException"}, + {"shape":"CustomVerificationEmailInvalidContentException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a new custom verification email template.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateReceiptFilter":{ + "name":"CreateReceiptFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReceiptFilterRequest"}, + "output":{ + "shape":"CreateReceiptFilterResponse", + "resultWrapper":"CreateReceiptFilterResult" + }, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"AlreadyExistsException"} + ], + "documentation":"

    Creates a new IP address filter.

    For information about setting up IP address filters, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateReceiptRule":{ + "name":"CreateReceiptRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReceiptRuleRequest"}, + "output":{ + "shape":"CreateReceiptRuleResponse", + "resultWrapper":"CreateReceiptRuleResult" + }, + "errors":[ + {"shape":"InvalidSnsTopicException"}, + {"shape":"InvalidS3ConfigurationException"}, + {"shape":"InvalidLambdaFunctionException"}, + {"shape":"AlreadyExistsException"}, + {"shape":"RuleDoesNotExistException"}, + {"shape":"RuleSetDoesNotExistException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates a receipt rule.

    For information about setting up receipt rules, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateReceiptRuleSet":{ + "name":"CreateReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReceiptRuleSetRequest"}, + "output":{ + "shape":"CreateReceiptRuleSetResponse", + "resultWrapper":"CreateReceiptRuleSetResult" + }, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates an empty receipt rule set.

    For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "CreateTemplate":{ + "name":"CreateTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTemplateRequest"}, + "output":{ + "shape":"CreateTemplateResponse", + "resultWrapper":"CreateTemplateResult" + }, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"InvalidTemplateException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Creates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteConfigurationSet":{ + "name":"DeleteConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationSetRequest"}, + "output":{ + "shape":"DeleteConfigurationSetResponse", + "resultWrapper":"DeleteConfigurationSetResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"} + ], + "documentation":"

    Deletes a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteConfigurationSetEventDestination":{ + "name":"DeleteConfigurationSetEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationSetEventDestinationRequest"}, + "output":{ + "shape":"DeleteConfigurationSetEventDestinationResponse", + "resultWrapper":"DeleteConfigurationSetEventDestinationResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"EventDestinationDoesNotExistException"} + ], + "documentation":"

    Deletes a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteConfigurationSetTrackingOptions":{ + "name":"DeleteConfigurationSetTrackingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteConfigurationSetTrackingOptionsRequest"}, + "output":{ + "shape":"DeleteConfigurationSetTrackingOptionsResponse", + "resultWrapper":"DeleteConfigurationSetTrackingOptionsResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"TrackingOptionsDoesNotExistException"} + ], + "documentation":"

    Deletes an association between a configuration set and a custom domain for open and click event tracking.

    By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    Deleting this kind of association will result in emails sent using the specified configuration set to capture open and click events using the standard, Amazon SES-operated domains.

    " + }, + "DeleteCustomVerificationEmailTemplate":{ + "name":"DeleteCustomVerificationEmailTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteCustomVerificationEmailTemplateRequest"}, + "documentation":"

    Deletes an existing custom verification email template.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteIdentity":{ + "name":"DeleteIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityRequest"}, + "output":{ + "shape":"DeleteIdentityResponse", + "resultWrapper":"DeleteIdentityResult" + }, + "documentation":"

    Deletes the specified identity (an email address or a domain) from the list of verified identities.

    You can execute this operation no more than once per second.

    " + }, + "DeleteIdentityPolicy":{ + "name":"DeleteIdentityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIdentityPolicyRequest"}, + "output":{ + "shape":"DeleteIdentityPolicyResponse", + "resultWrapper":"DeleteIdentityPolicyResult" + }, + "documentation":"

    Deletes the specified sending authorization policy for the given identity (an email address or a domain). This API returns successfully even if a policy with the specified name does not exist.

    This API is for the identity owner only. If you have not verified the identity, this API will return an error.

    Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteReceiptFilter":{ + "name":"DeleteReceiptFilter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReceiptFilterRequest"}, + "output":{ + "shape":"DeleteReceiptFilterResponse", + "resultWrapper":"DeleteReceiptFilterResult" + }, + "documentation":"

    Deletes the specified IP address filter.

    For information about managing IP address filters, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteReceiptRule":{ + "name":"DeleteReceiptRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReceiptRuleRequest"}, + "output":{ + "shape":"DeleteReceiptRuleResponse", + "resultWrapper":"DeleteReceiptRuleResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"} + ], + "documentation":"

    Deletes the specified receipt rule.

    For information about managing receipt rules, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteReceiptRuleSet":{ + "name":"DeleteReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReceiptRuleSetRequest"}, + "output":{ + "shape":"DeleteReceiptRuleSetResponse", + "resultWrapper":"DeleteReceiptRuleSetResult" + }, + "errors":[ + {"shape":"CannotDeleteException"} + ], + "documentation":"

    Deletes the specified receipt rule set and all of the receipt rules it contains.

    The currently active rule set cannot be deleted.

    For information about managing receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DeleteTemplate":{ + "name":"DeleteTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTemplateRequest"}, + "output":{ + "shape":"DeleteTemplateResponse", + "resultWrapper":"DeleteTemplateResult" + }, + "documentation":"

    Deletes an email template.

    You can execute this operation no more than once per second.

    " + }, + "DeleteVerifiedEmailAddress":{ + "name":"DeleteVerifiedEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVerifiedEmailAddressRequest"}, + "documentation":"

    Deprecated. Use the DeleteIdentity operation to delete email addresses and domains.

    " + }, + "DescribeActiveReceiptRuleSet":{ + "name":"DescribeActiveReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActiveReceiptRuleSetRequest"}, + "output":{ + "shape":"DescribeActiveReceiptRuleSetResponse", + "resultWrapper":"DescribeActiveReceiptRuleSetResult" + }, + "documentation":"

    Returns the metadata and receipt rules for the receipt rule set that is currently active.

    For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DescribeConfigurationSet":{ + "name":"DescribeConfigurationSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeConfigurationSetRequest"}, + "output":{ + "shape":"DescribeConfigurationSetResponse", + "resultWrapper":"DescribeConfigurationSetResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"} + ], + "documentation":"

    Returns the details of the specified configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DescribeReceiptRule":{ + "name":"DescribeReceiptRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReceiptRuleRequest"}, + "output":{ + "shape":"DescribeReceiptRuleResponse", + "resultWrapper":"DescribeReceiptRuleResult" + }, + "errors":[ + {"shape":"RuleDoesNotExistException"}, + {"shape":"RuleSetDoesNotExistException"} + ], + "documentation":"

    Returns the details of the specified receipt rule.

    For information about setting up receipt rules, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "DescribeReceiptRuleSet":{ + "name":"DescribeReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeReceiptRuleSetRequest"}, + "output":{ + "shape":"DescribeReceiptRuleSetResponse", + "resultWrapper":"DescribeReceiptRuleSetResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"} + ], + "documentation":"

    Returns the details of the specified receipt rule set.

    For information about managing receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "GetAccountSendingEnabled":{ + "name":"GetAccountSendingEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetAccountSendingEnabledResponse", + "resultWrapper":"GetAccountSendingEnabledResult" + }, + "documentation":"

    Returns the email sending status of the Amazon SES account for the current region.

    You can execute this operation no more than once per second.

    " + }, + "GetCustomVerificationEmailTemplate":{ + "name":"GetCustomVerificationEmailTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCustomVerificationEmailTemplateRequest"}, + "output":{ + "shape":"GetCustomVerificationEmailTemplateResponse", + "resultWrapper":"GetCustomVerificationEmailTemplateResult" + }, + "errors":[ + {"shape":"CustomVerificationEmailTemplateDoesNotExistException"} + ], + "documentation":"

    Returns the custom email verification template for the template name you specify.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "GetIdentityDkimAttributes":{ + "name":"GetIdentityDkimAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityDkimAttributesRequest"}, + "output":{ + "shape":"GetIdentityDkimAttributesResponse", + "resultWrapper":"GetIdentityDkimAttributesResult" + }, + "documentation":"

    Returns the current status of Easy DKIM signing for an entity. For domain name identities, this operation also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES has successfully verified that these tokens have been published.

    This operation takes a list of identities as input and returns the following information for each:

    • Whether Easy DKIM signing is enabled or disabled.

    • A set of DKIM tokens that represent the identity. If the identity is an email address, the tokens represent the domain of that address.

    • Whether Amazon SES has successfully verified the DKIM tokens published in the domain's DNS. This information is only returned for domain name identities, not for email addresses.

    This operation is throttled at one request per second and can only get DKIM attributes for up to 100 identities at a time.

    For more information about creating DNS records using DKIM tokens, go to the Amazon SES Developer Guide.

    " + }, + "GetIdentityMailFromDomainAttributes":{ + "name":"GetIdentityMailFromDomainAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityMailFromDomainAttributesRequest"}, + "output":{ + "shape":"GetIdentityMailFromDomainAttributesResponse", + "resultWrapper":"GetIdentityMailFromDomainAttributesResult" + }, + "documentation":"

    Returns the custom MAIL FROM attributes for a list of identities (email addresses : domains).

    This operation is throttled at one request per second and can only get custom MAIL FROM attributes for up to 100 identities at a time.

    " + }, + "GetIdentityNotificationAttributes":{ + "name":"GetIdentityNotificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityNotificationAttributesRequest"}, + "output":{ + "shape":"GetIdentityNotificationAttributesResponse", + "resultWrapper":"GetIdentityNotificationAttributesResult" + }, + "documentation":"

    Given a list of verified identities (email addresses and/or domains), returns a structure describing identity notification attributes.

    This operation is throttled at one request per second and can only get notification attributes for up to 100 identities at a time.

    For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityPolicies":{ + "name":"GetIdentityPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityPoliciesRequest"}, + "output":{ + "shape":"GetIdentityPoliciesResponse", + "resultWrapper":"GetIdentityPoliciesResult" + }, + "documentation":"

    Returns the requested sending authorization policies for the given identity (an email address or a domain). The policies are returned as a map of policy names to policy contents. You can retrieve a maximum of 20 policies at a time.

    This API is for the identity owner only. If you have not verified the identity, this API will return an error.

    Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "GetIdentityVerificationAttributes":{ + "name":"GetIdentityVerificationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIdentityVerificationAttributesRequest"}, + "output":{ + "shape":"GetIdentityVerificationAttributesResponse", + "resultWrapper":"GetIdentityVerificationAttributesResult" + }, + "documentation":"

    Given a list of identities (email addresses and/or domains), returns the verification status and (for domain identities) the verification token for each identity.

    The verification status of an email address is \"Pending\" until the email address owner clicks the link within the verification email that Amazon SES sent to that address. If the email address owner clicks the link within 24 hours, the verification status of the email address changes to \"Success\". If the link is not clicked within 24 hours, the verification status changes to \"Failed.\" In that case, if you still want to verify the email address, you must restart the verification process from the beginning.

    For domain identities, the domain's verification status is \"Pending\" as Amazon SES searches for the required TXT record in the DNS settings of the domain. When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

    This operation is throttled at one request per second and can only get verification attributes for up to 100 identities at a time.

    " + }, + "GetSendQuota":{ + "name":"GetSendQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetSendQuotaResponse", + "resultWrapper":"GetSendQuotaResult" + }, + "documentation":"

    Provides the sending limits for the Amazon SES account.

    You can execute this operation no more than once per second.

    " + }, + "GetSendStatistics":{ + "name":"GetSendStatistics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"GetSendStatisticsResponse", + "resultWrapper":"GetSendStatisticsResult" + }, + "documentation":"

    Provides sending statistics for the current AWS Region. The result is a list of data points, representing the last two weeks of sending activity. Each data point in the list contains statistics for a 15-minute period of time.

    You can execute this operation no more than once per second.

    " + }, + "GetTemplate":{ + "name":"GetTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTemplateRequest"}, + "output":{ + "shape":"GetTemplateResponse", + "resultWrapper":"GetTemplateResult" + }, + "errors":[ + {"shape":"TemplateDoesNotExistException"} + ], + "documentation":"

    Displays the template object (which includes the Subject line, HTML part and text part) for the template you specify.

    You can execute this operation no more than once per second.

    " + }, + "ListConfigurationSets":{ + "name":"ListConfigurationSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListConfigurationSetsRequest"}, + "output":{ + "shape":"ListConfigurationSetsResponse", + "resultWrapper":"ListConfigurationSetsResult" + }, + "documentation":"

    Provides a list of the configuration sets associated with your Amazon SES account in the current AWS Region. For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second. This operation will return up to 1,000 configuration sets each time it is run. If your Amazon SES account has more than 1,000 configuration sets, this operation will also return a NextToken element. You can then execute the ListConfigurationSets operation again, passing the NextToken parameter and the value of the NextToken element to retrieve additional results.

    " + }, + "ListCustomVerificationEmailTemplates":{ + "name":"ListCustomVerificationEmailTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCustomVerificationEmailTemplatesRequest"}, + "output":{ + "shape":"ListCustomVerificationEmailTemplatesResponse", + "resultWrapper":"ListCustomVerificationEmailTemplatesResult" + }, + "documentation":"

    Lists the existing custom verification email templates for your account in the current AWS Region.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "ListIdentities":{ + "name":"ListIdentities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIdentitiesRequest"}, + "output":{ + "shape":"ListIdentitiesResponse", + "resultWrapper":"ListIdentitiesResult" + }, + "documentation":"

    Returns a list containing all of the identities (email addresses and domains) for your AWS account in the current AWS Region, regardless of verification status.

    You can execute this operation no more than once per second.

    " + }, + "ListIdentityPolicies":{ + "name":"ListIdentityPolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIdentityPoliciesRequest"}, + "output":{ + "shape":"ListIdentityPoliciesResponse", + "resultWrapper":"ListIdentityPoliciesResult" + }, + "documentation":"

    Returns a list of sending authorization policies that are attached to the given identity (an email address or a domain). This API returns only a list. If you want the actual policy content, you can use GetIdentityPolicies.

    This API is for the identity owner only. If you have not verified the identity, this API will return an error.

    Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "ListReceiptFilters":{ + "name":"ListReceiptFilters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListReceiptFiltersRequest"}, + "output":{ + "shape":"ListReceiptFiltersResponse", + "resultWrapper":"ListReceiptFiltersResult" + }, + "documentation":"

    Lists the IP address filters associated with your AWS account in the current AWS Region.

    For information about managing IP address filters, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "ListReceiptRuleSets":{ + "name":"ListReceiptRuleSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListReceiptRuleSetsRequest"}, + "output":{ + "shape":"ListReceiptRuleSetsResponse", + "resultWrapper":"ListReceiptRuleSetsResult" + }, + "documentation":"

    Lists the receipt rule sets that exist under your AWS account in the current AWS Region. If there are additional receipt rule sets to be retrieved, you will receive a NextToken that you can provide to the next call to ListReceiptRuleSets to retrieve the additional entries.

    For information about managing receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "ListTemplates":{ + "name":"ListTemplates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTemplatesRequest"}, + "output":{ + "shape":"ListTemplatesResponse", + "resultWrapper":"ListTemplatesResult" + }, + "documentation":"

    Lists the email templates present in your Amazon SES account in the current AWS Region.

    You can execute this operation no more than once per second.

    " + }, + "ListVerifiedEmailAddresses":{ + "name":"ListVerifiedEmailAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "output":{ + "shape":"ListVerifiedEmailAddressesResponse", + "resultWrapper":"ListVerifiedEmailAddressesResult" + }, + "documentation":"

    Deprecated. Use the ListIdentities operation to list the email addresses and domains associated with your account.

    " + }, + "PutConfigurationSetDeliveryOptions":{ + "name":"PutConfigurationSetDeliveryOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutConfigurationSetDeliveryOptionsRequest"}, + "output":{ + "shape":"PutConfigurationSetDeliveryOptionsResponse", + "resultWrapper":"PutConfigurationSetDeliveryOptionsResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"InvalidDeliveryOptionsException"} + ], + "documentation":"

    Adds or updates the delivery options for a configuration set.

    " + }, + "PutIdentityPolicy":{ + "name":"PutIdentityPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutIdentityPolicyRequest"}, + "output":{ + "shape":"PutIdentityPolicyResponse", + "resultWrapper":"PutIdentityPolicyResult" + }, + "errors":[ + {"shape":"InvalidPolicyException"} + ], + "documentation":"

    Adds or updates a sending authorization policy for the specified identity (an email address or a domain).

    This API is for the identity owner only. If you have not verified the identity, this API will return an error.

    Sending authorization is a feature that enables an identity owner to authorize other senders to use its identities. For information about using sending authorization, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "ReorderReceiptRuleSet":{ + "name":"ReorderReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReorderReceiptRuleSetRequest"}, + "output":{ + "shape":"ReorderReceiptRuleSetResponse", + "resultWrapper":"ReorderReceiptRuleSetResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"}, + {"shape":"RuleDoesNotExistException"} + ], + "documentation":"

    Reorders the receipt rules within a receipt rule set.

    All of the rules in the rule set must be represented in this request. That is, this API will return an error if the reorder request doesn't explicitly position all of the rules.

    For information about managing receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "SendBounce":{ + "name":"SendBounce", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendBounceRequest"}, + "output":{ + "shape":"SendBounceResponse", + "resultWrapper":"SendBounceResult" + }, + "errors":[ + {"shape":"MessageRejected"} + ], + "documentation":"

    Generates and sends a bounce message to the sender of an email you received through Amazon SES. You can only use this API on an email up to 24 hours after you receive it.

    You cannot use this API to send generic bounces for mail that was not received by Amazon SES.

    For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "SendBulkTemplatedEmail":{ + "name":"SendBulkTemplatedEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendBulkTemplatedEmailRequest"}, + "output":{ + "shape":"SendBulkTemplatedEmailResponse", + "resultWrapper":"SendBulkTemplatedEmailResult" + }, + "errors":[ + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"TemplateDoesNotExistException"}, + {"shape":"ConfigurationSetSendingPausedException"}, + {"shape":"AccountSendingPausedException"} + ], + "documentation":"

    Composes an email message to multiple destinations. The message body is created using an email template.

    In order to send email using the SendBulkTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Each Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendBulkTemplatedEmail operation several times to send the message to each group.

    • The number of destinations you can contact in a single call to the API may be limited by your account's maximum sending rate.

    " + }, + "SendCustomVerificationEmail":{ + "name":"SendCustomVerificationEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendCustomVerificationEmailRequest"}, + "output":{ + "shape":"SendCustomVerificationEmailResponse", + "resultWrapper":"SendCustomVerificationEmailResult" + }, + "errors":[ + {"shape":"MessageRejected"}, + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"CustomVerificationEmailTemplateDoesNotExistException"}, + {"shape":"FromEmailAddressNotVerifiedException"}, + {"shape":"ProductionAccessNotGrantedException"} + ], + "documentation":"

    Adds an email address to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. As a result of executing this operation, a customized verification email is sent to the specified address.

    To use this operation, you must first create a custom verification email template. For more information about creating and using custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "SendEmail":{ + "name":"SendEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendEmailRequest"}, + "output":{ + "shape":"SendEmailResponse", + "resultWrapper":"SendEmailResult" + }, + "errors":[ + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"ConfigurationSetSendingPausedException"}, + {"shape":"AccountSendingPausedException"} + ], + "documentation":"

    Composes an email message and immediately queues it for sending. In order to send email using the SendEmail operation, your message must meet the following requirements:

    • The message must be sent from a verified email address or domain. If you attempt to send email using a non-verified address or domain, the operation will result in an \"Email address not verified\" error.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • The message must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    • The message may not include more than 50 recipients, across the To:, CC: and BCC: fields. If you need to send an email message to a larger audience, you can divide your recipient list into groups of 50 or fewer, and then call the SendEmail operation several times to send the message to each group.

    For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

    " + }, + "SendRawEmail":{ + "name":"SendRawEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendRawEmailRequest"}, + "output":{ + "shape":"SendRawEmailResponse", + "resultWrapper":"SendRawEmailResult" + }, + "errors":[ + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"ConfigurationSetSendingPausedException"}, + {"shape":"AccountSendingPausedException"} + ], + "documentation":"

    Composes an email message and immediately queues it for sending.

    This operation is more flexible than the SendEmail API operation. When you use the SendRawEmail operation, you can specify the headers of the message as well as its content. This flexibility is useful, for example, when you want to send a multipart MIME email (such a message that contains both a text and an HTML version). You can also use this operation to send messages that include attachments.

    The SendRawEmail operation has the following requirements:

    • You can only send email from verified email addresses or domains. If you try to send email from an address that isn't verified, the operation results in an \"Email address not verified\" error.

    • If your account is still in the Amazon SES sandbox, you can only send email to other verified addresses in your account, or to addresses that are associated with the Amazon SES mailbox simulator.

    • The maximum message size, including attachments, is 10 MB.

    • Each message has to include at least one recipient address. A recipient address includes any address on the To:, CC:, or BCC: lines.

    • If you send a single message to more than one recipient address, and one of the recipient addresses isn't in a valid format (that is, it's not in the format UserName@[SubDomain.]Domain.TopLevelDomain), Amazon SES rejects the entire message, even if the other addresses are valid.

    • Each message can include up to 50 recipient addresses across the To:, CC:, or BCC: lines. If you need to send a single message to more than 50 recipients, you have to split the list of recipient addresses into groups of less than 50 recipients, and send separate messages to each group.

    • Amazon SES allows you to specify 8-bit Content-Transfer-Encoding for MIME message parts. However, if Amazon SES has to modify the contents of your message (for example, if you use open and click tracking), 8-bit content isn't preserved. For this reason, we highly recommend that you encode all content that isn't 7-bit ASCII. For more information, see MIME Encoding in the Amazon SES Developer Guide.

    Additionally, keep the following considerations in mind when using the SendRawEmail operation:

    • Although you can customize the message headers when using the SendRawEmail operation, Amazon SES will automatically apply its own Message-ID and Date headers; if you passed these headers when creating the message, they will be overwritten by the values that Amazon SES provides.

    • If you are using sending authorization to send on behalf of another user, SendRawEmail enables you to specify the cross-account identity for the email's Source, From, and Return-Path parameters in one of two ways: you can pass optional parameters SourceArn, FromArn, and/or ReturnPathArn to the API, or you can include the following X-headers in the header of your raw email:

      • X-SES-SOURCE-ARN

      • X-SES-FROM-ARN

      • X-SES-RETURN-PATH-ARN

      Don't include these X-headers in the DKIM signature. Amazon SES removes these before it sends the email.

      If you only specify the SourceIdentityArn parameter, Amazon SES sets the From and Return-Path addresses to the same identity that you specified.

      For more information about sending authorization, see the Using Sending Authorization with Amazon SES in the Amazon SES Developer Guide.

    • For every message that you send, the total number of recipients (including each recipient in the To:, CC: and BCC: fields) is counted against the maximum number of emails you can send in a 24-hour period (your sending quota). For more information about sending quotas in Amazon SES, see Managing Your Amazon SES Sending Limits in the Amazon SES Developer Guide.

    " + }, + "SendTemplatedEmail":{ + "name":"SendTemplatedEmail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTemplatedEmailRequest"}, + "output":{ + "shape":"SendTemplatedEmailResponse", + "resultWrapper":"SendTemplatedEmailResult" + }, + "errors":[ + {"shape":"MessageRejected"}, + {"shape":"MailFromDomainNotVerifiedException"}, + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"TemplateDoesNotExistException"}, + {"shape":"ConfigurationSetSendingPausedException"}, + {"shape":"AccountSendingPausedException"} + ], + "documentation":"

    Composes an email message using an email template and immediately queues it for sending.

    In order to send email using the SendTemplatedEmail operation, your call to the API must meet the following requirements:

    • The call must refer to an existing email template. You can create email templates using the CreateTemplate operation.

    • The message must be sent from a verified email address or domain.

    • If your account is still in the Amazon SES sandbox, you may only send to verified addresses or domains, or to email addresses associated with the Amazon SES Mailbox Simulator. For more information, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    • The maximum message size is 10 MB.

    • Calls to the SendTemplatedEmail operation may only include one Destination parameter. A destination is a set of recipients who will receive the same version of the email. The Destination parameter can include up to 50 recipients, across the To:, CC: and BCC: fields.

    • The Destination parameter must include at least one recipient email address. The recipient address can be a To: address, a CC: address, or a BCC: address. If a recipient email address is invalid (that is, it is not in the format UserName@[SubDomain.]Domain.TopLevelDomain), the entire message will be rejected, even if the message contains other recipients that are valid.

    If your call to the SendTemplatedEmail operation includes all of the required parameters, Amazon SES accepts it and returns a Message ID. However, if Amazon SES can't render the email because the template contains errors, it doesn't send the email. Additionally, because it already accepted the message, Amazon SES doesn't return a message stating that it was unable to send the email.

    For these reasons, we highly recommend that you set up Amazon SES to send you notifications when Rendering Failure events occur. For more information, see Sending Personalized Email Using the Amazon SES API in the Amazon Simple Email Service Developer Guide.

    " + }, + "SetActiveReceiptRuleSet":{ + "name":"SetActiveReceiptRuleSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetActiveReceiptRuleSetRequest"}, + "output":{ + "shape":"SetActiveReceiptRuleSetResponse", + "resultWrapper":"SetActiveReceiptRuleSetResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"} + ], + "documentation":"

    Sets the specified receipt rule set as the active receipt rule set.

    To disable your email-receiving through Amazon SES completely, you can call this API with RuleSetName set to null.

    For information about managing receipt rule sets, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "SetIdentityDkimEnabled":{ + "name":"SetIdentityDkimEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityDkimEnabledRequest"}, + "output":{ + "shape":"SetIdentityDkimEnabledResponse", + "resultWrapper":"SetIdentityDkimEnabledResult" + }, + "documentation":"

    Enables or disables Easy DKIM signing of email sent from an identity. If Easy DKIM signing is enabled for a domain, then Amazon SES uses DKIM to sign all email that it sends from addresses on that domain. If Easy DKIM signing is enabled for an email address, then Amazon SES uses DKIM to sign all email it sends from that address.

    For email addresses (for example, user@example.com), you can only enable DKIM signing if the corresponding domain (in this case, example.com) has been set up to use Easy DKIM.

    You can enable DKIM signing for an identity at any time after you start the verification process for the identity, even if the verification process isn't complete.

    You can execute this operation no more than once per second.

    For more information about Easy DKIM signing, go to the Amazon SES Developer Guide.

    " + }, + "SetIdentityFeedbackForwardingEnabled":{ + "name":"SetIdentityFeedbackForwardingEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityFeedbackForwardingEnabledRequest"}, + "output":{ + "shape":"SetIdentityFeedbackForwardingEnabledResponse", + "resultWrapper":"SetIdentityFeedbackForwardingEnabledResult" + }, + "documentation":"

    Given an identity (an email address or a domain), enables or disables whether Amazon SES forwards bounce and complaint notifications as email. Feedback forwarding can only be disabled when Amazon Simple Notification Service (Amazon SNS) topics are specified for both bounces and complaints.

    Feedback forwarding does not apply to delivery notifications. Delivery notifications are only available through Amazon SNS.

    You can execute this operation no more than once per second.

    For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityHeadersInNotificationsEnabled":{ + "name":"SetIdentityHeadersInNotificationsEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityHeadersInNotificationsEnabledRequest"}, + "output":{ + "shape":"SetIdentityHeadersInNotificationsEnabledResponse", + "resultWrapper":"SetIdentityHeadersInNotificationsEnabledResult" + }, + "documentation":"

    Given an identity (an email address or a domain), sets whether Amazon SES includes the original email headers in the Amazon Simple Notification Service (Amazon SNS) notifications of a specified type.

    You can execute this operation no more than once per second.

    For more information about using notifications with Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityMailFromDomain":{ + "name":"SetIdentityMailFromDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityMailFromDomainRequest"}, + "output":{ + "shape":"SetIdentityMailFromDomainResponse", + "resultWrapper":"SetIdentityMailFromDomainResult" + }, + "documentation":"

    Enables or disables the custom MAIL FROM domain setup for a verified identity (an email address or a domain).

    To send emails using the specified MAIL FROM domain, you must add an MX record to your MAIL FROM domain's DNS settings. If you want your emails to pass Sender Policy Framework (SPF) checks, you must also add or update an SPF record. For more information, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "SetIdentityNotificationTopic":{ + "name":"SetIdentityNotificationTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetIdentityNotificationTopicRequest"}, + "output":{ + "shape":"SetIdentityNotificationTopicResponse", + "resultWrapper":"SetIdentityNotificationTopicResult" + }, + "documentation":"

    Sets an Amazon Simple Notification Service (Amazon SNS) topic to use when delivering notifications. When you use this operation, you specify a verified identity, such as an email address or domain. When you send an email that uses the chosen identity in the Source field, Amazon SES sends notifications to the topic you specified. You can send bounce, complaint, or delivery notifications (or any combination of the three) to the Amazon SNS topic that you specify.

    You can execute this operation no more than once per second.

    For more information about feedback notification, see the Amazon SES Developer Guide.

    " + }, + "SetReceiptRulePosition":{ + "name":"SetReceiptRulePosition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetReceiptRulePositionRequest"}, + "output":{ + "shape":"SetReceiptRulePositionResponse", + "resultWrapper":"SetReceiptRulePositionResult" + }, + "errors":[ + {"shape":"RuleSetDoesNotExistException"}, + {"shape":"RuleDoesNotExistException"} + ], + "documentation":"

    Sets the position of the specified receipt rule in the receipt rule set.

    For information about managing receipt rules, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "TestRenderTemplate":{ + "name":"TestRenderTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestRenderTemplateRequest"}, + "output":{ + "shape":"TestRenderTemplateResponse", + "resultWrapper":"TestRenderTemplateResult" + }, + "errors":[ + {"shape":"TemplateDoesNotExistException"}, + {"shape":"InvalidRenderingParameterException"}, + {"shape":"MissingRenderingAttributeException"} + ], + "documentation":"

    Creates a preview of the MIME content of an email when provided with a template and a set of replacement data.

    You can execute this operation no more than once per second.

    " + }, + "UpdateAccountSendingEnabled":{ + "name":"UpdateAccountSendingEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAccountSendingEnabledRequest"}, + "documentation":"

    Enables or disables email sending across your entire Amazon SES account in the current AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending across your Amazon SES account in a given AWS Region when reputation metrics (such as your bounce or complaint rates) reach certain thresholds.

    You can execute this operation no more than once per second.

    " + }, + "UpdateConfigurationSetEventDestination":{ + "name":"UpdateConfigurationSetEventDestination", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConfigurationSetEventDestinationRequest"}, + "output":{ + "shape":"UpdateConfigurationSetEventDestinationResponse", + "resultWrapper":"UpdateConfigurationSetEventDestinationResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"EventDestinationDoesNotExistException"}, + {"shape":"InvalidCloudWatchDestinationException"}, + {"shape":"InvalidFirehoseDestinationException"}, + {"shape":"InvalidSNSDestinationException"} + ], + "documentation":"

    Updates the event destination of a configuration set. Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see Monitoring Your Amazon SES Sending Activity in the Amazon SES Developer Guide.

    When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS).

    You can execute this operation no more than once per second.

    " + }, + "UpdateConfigurationSetReputationMetricsEnabled":{ + "name":"UpdateConfigurationSetReputationMetricsEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConfigurationSetReputationMetricsEnabledRequest"}, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"} + ], + "documentation":"

    Enables or disables the publishing of reputation metrics for emails sent using a specific configuration set in a given AWS Region. Reputation metrics include bounce and complaint rates. These metrics are published to Amazon CloudWatch. By using CloudWatch, you can create alarms when bounce or complaint rates exceed certain thresholds.

    You can execute this operation no more than once per second.

    " + }, + "UpdateConfigurationSetSendingEnabled":{ + "name":"UpdateConfigurationSetSendingEnabled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConfigurationSetSendingEnabledRequest"}, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"} + ], + "documentation":"

    Enables or disables email sending for messages sent using a specific configuration set in a given AWS Region. You can use this operation in conjunction with Amazon CloudWatch alarms to temporarily pause email sending for a configuration set when the reputation metrics for that configuration set (such as your bounce on complaint rate) exceed certain thresholds.

    You can execute this operation no more than once per second.

    " + }, + "UpdateConfigurationSetTrackingOptions":{ + "name":"UpdateConfigurationSetTrackingOptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateConfigurationSetTrackingOptionsRequest"}, + "output":{ + "shape":"UpdateConfigurationSetTrackingOptionsResponse", + "resultWrapper":"UpdateConfigurationSetTrackingOptionsResult" + }, + "errors":[ + {"shape":"ConfigurationSetDoesNotExistException"}, + {"shape":"TrackingOptionsDoesNotExistException"}, + {"shape":"InvalidTrackingOptionsException"} + ], + "documentation":"

    Modifies an association between a configuration set and a custom domain for open and click event tracking.

    By default, images and links used for tracking open and click events are hosted on domains operated by Amazon SES. You can configure a subdomain of your own to handle these events. For information about using custom domains, see the Amazon SES Developer Guide.

    " + }, + "UpdateCustomVerificationEmailTemplate":{ + "name":"UpdateCustomVerificationEmailTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateCustomVerificationEmailTemplateRequest"}, + "errors":[ + {"shape":"CustomVerificationEmailTemplateDoesNotExistException"}, + {"shape":"FromEmailAddressNotVerifiedException"}, + {"shape":"CustomVerificationEmailInvalidContentException"} + ], + "documentation":"

    Updates an existing custom verification email template.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "UpdateReceiptRule":{ + "name":"UpdateReceiptRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateReceiptRuleRequest"}, + "output":{ + "shape":"UpdateReceiptRuleResponse", + "resultWrapper":"UpdateReceiptRuleResult" + }, + "errors":[ + {"shape":"InvalidSnsTopicException"}, + {"shape":"InvalidS3ConfigurationException"}, + {"shape":"InvalidLambdaFunctionException"}, + {"shape":"RuleSetDoesNotExistException"}, + {"shape":"RuleDoesNotExistException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Updates a receipt rule.

    For information about managing receipt rules, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "UpdateTemplate":{ + "name":"UpdateTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateTemplateRequest"}, + "output":{ + "shape":"UpdateTemplateResponse", + "resultWrapper":"UpdateTemplateResult" + }, + "errors":[ + {"shape":"TemplateDoesNotExistException"}, + {"shape":"InvalidTemplateException"} + ], + "documentation":"

    Updates an email template. Email templates enable you to send personalized email to one or more destinations in a single API operation. For more information, see the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "VerifyDomainDkim":{ + "name":"VerifyDomainDkim", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyDomainDkimRequest"}, + "output":{ + "shape":"VerifyDomainDkimResponse", + "resultWrapper":"VerifyDomainDkimResult" + }, + "documentation":"

    Returns a set of DKIM tokens for a domain identity.

    When you execute the VerifyDomainDkim operation, the domain that you specify is added to the list of identities that are associated with your account. This is true even if you haven't already associated the domain with your account by using the VerifyDomainIdentity operation. However, you can't send email from the domain until you either successfully verify it or you successfully set up DKIM for it.

    You use the tokens that are generated by this operation to create CNAME records. When Amazon SES detects that you've added these records to the DNS configuration for a domain, you can start sending email from that domain. You can start sending email even if you haven't added the TXT record provided by the VerifyDomainIdentity operation to the DNS configuration for your domain. All email that you send from the domain is authenticated using DKIM.

    To create the CNAME records for DKIM authentication, use the following values:

    • Name: token._domainkey.example.com

    • Type: CNAME

    • Value: token.dkim.amazonses.com

    In the preceding example, replace token with one of the tokens that are generated when you execute this operation. Replace example.com with your domain. Repeat this process for each token that's generated by this operation.

    You can execute this operation no more than once per second.

    " + }, + "VerifyDomainIdentity":{ + "name":"VerifyDomainIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyDomainIdentityRequest"}, + "output":{ + "shape":"VerifyDomainIdentityResponse", + "resultWrapper":"VerifyDomainIdentityResult" + }, + "documentation":"

    Adds a domain to the list of identities for your Amazon SES account in the current AWS Region and attempts to verify it. For more information about verifying domains, see Verifying Email Addresses and Domains in the Amazon SES Developer Guide.

    You can execute this operation no more than once per second.

    " + }, + "VerifyEmailAddress":{ + "name":"VerifyEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyEmailAddressRequest"}, + "documentation":"

    Deprecated. Use the VerifyEmailIdentity operation to verify a new email address.

    " + }, + "VerifyEmailIdentity":{ + "name":"VerifyEmailIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"VerifyEmailIdentityRequest"}, + "output":{ + "shape":"VerifyEmailIdentityResponse", + "resultWrapper":"VerifyEmailIdentityResult" + }, + "documentation":"

    Adds an email address to the list of identities for your Amazon SES account in the current AWS region and attempts to verify it. As a result of executing this operation, a verification email is sent to the specified address.

    You can execute this operation no more than once per second.

    " + } + }, + "shapes":{ + "AccountSendingPausedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that email sending is disabled for your entire Amazon SES account.

    You can enable or disable email sending for your Amazon SES account using UpdateAccountSendingEnabled.

    ", + "error":{ + "code":"AccountSendingPausedException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AddHeaderAction":{ + "type":"structure", + "required":[ + "HeaderName", + "HeaderValue" + ], + "members":{ + "HeaderName":{ + "shape":"HeaderName", + "documentation":"

    The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

    " + }, + "HeaderValue":{ + "shape":"HeaderValue", + "documentation":"

    Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").

    " + } + }, + "documentation":"

    When included in a receipt rule, this action adds a header to the received email.

    For information about adding a header using a receipt rule, see the Amazon SES Developer Guide.

    " + }, + "Address":{"type":"string"}, + "AddressList":{ + "type":"list", + "member":{"shape":"Address"} + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleOrRuleSetName", + "documentation":"

    Indicates that a resource could not be created because the resource name already exists.

    " + } + }, + "documentation":"

    Indicates that a resource could not be created because of a naming conflict.

    ", + "error":{ + "code":"AlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "AmazonResourceName":{"type":"string"}, + "ArrivalDate":{"type":"timestamp"}, + "BehaviorOnMXFailure":{ + "type":"string", + "enum":[ + "UseDefaultValue", + "RejectMessage" + ] + }, + "Body":{ + "type":"structure", + "members":{ + "Text":{ + "shape":"Content", + "documentation":"

    The content of the message, in text format. Use this for text-based email clients, or clients on high-latency networks (such as mobile devices).

    " + }, + "Html":{ + "shape":"Content", + "documentation":"

    The content of the message, in HTML format. Use this for email clients that can process HTML. You can include clickable links, formatted text, and much more in an HTML message.

    " + } + }, + "documentation":"

    Represents the body of the message. You can specify text, HTML, or both. If you use both, then the message should display correctly in the widest variety of email clients.

    " + }, + "BounceAction":{ + "type":"structure", + "required":[ + "SmtpReplyCode", + "Message", + "Sender" + ], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the bounce action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + }, + "SmtpReplyCode":{ + "shape":"BounceSmtpReplyCode", + "documentation":"

    The SMTP reply code, as defined by RFC 5321.

    " + }, + "StatusCode":{ + "shape":"BounceStatusCode", + "documentation":"

    The SMTP enhanced status code, as defined by RFC 3463.

    " + }, + "Message":{ + "shape":"BounceMessage", + "documentation":"

    Human-readable text to include in the bounce message.

    " + }, + "Sender":{ + "shape":"Address", + "documentation":"

    The email address of the sender of the bounced email. This is the address from which the bounce message will be sent.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    For information about sending a bounce message in response to a received email, see the Amazon SES Developer Guide.

    " + }, + "BounceMessage":{"type":"string"}, + "BounceSmtpReplyCode":{"type":"string"}, + "BounceStatusCode":{"type":"string"}, + "BounceType":{ + "type":"string", + "enum":[ + "DoesNotExist", + "MessageTooLarge", + "ExceededQuota", + "ContentRejected", + "Undefined", + "TemporaryFailure" + ] + }, + "BouncedRecipientInfo":{ + "type":"structure", + "required":["Recipient"], + "members":{ + "Recipient":{ + "shape":"Address", + "documentation":"

    The email address of the recipient of the bounced email.

    " + }, + "RecipientArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to receive email for the recipient of the bounced email. For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "BounceType":{ + "shape":"BounceType", + "documentation":"

    The reason for the bounce. You must provide either this parameter or RecipientDsnFields.

    " + }, + "RecipientDsnFields":{ + "shape":"RecipientDsnFields", + "documentation":"

    Recipient-related DSN fields, most of which would normally be filled in automatically when provided with a BounceType. You must provide either this parameter or BounceType.

    " + } + }, + "documentation":"

    Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

    For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "BouncedRecipientInfoList":{ + "type":"list", + "member":{"shape":"BouncedRecipientInfo"} + }, + "BulkEmailDestination":{ + "type":"structure", + "required":["Destination"], + "members":{ + "Destination":{"shape":"Destination"}, + "ReplacementTags":{ + "shape":"MessageTagList", + "documentation":"

    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendBulkTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    " + }, + "ReplacementTemplateData":{ + "shape":"TemplateData", + "documentation":"

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    " + } + }, + "documentation":"

    An array that contains one or more Destinations, as well as the tags and replacement data associated with each of those Destinations.

    " + }, + "BulkEmailDestinationList":{ + "type":"list", + "member":{"shape":"BulkEmailDestination"} + }, + "BulkEmailDestinationStatus":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BulkEmailStatus", + "documentation":"

    The status of a message sent using the SendBulkTemplatedEmail operation.

    Possible values for this parameter include:

    • Success: Amazon SES accepted the message, and will attempt to deliver it to the recipients.

    • MessageRejected: The message was rejected because it contained a virus.

    • MailFromDomainNotVerified: The sender's email address or domain was not verified.

    • ConfigurationSetDoesNotExist: The configuration set you specified does not exist.

    • TemplateDoesNotExist: The template you specified does not exist.

    • AccountSuspended: Your account has been shut down because of issues related to your email sending practices.

    • AccountThrottled: The number of emails you can send has been reduced because your account has exceeded its allocated sending limit.

    • AccountDailyQuotaExceeded: You have reached or exceeded the maximum number of emails you can send from your account in a 24-hour period.

    • InvalidSendingPoolName: The configuration set you specified refers to an IP pool that does not exist.

    • AccountSendingPaused: Email sending for the Amazon SES account was disabled using the UpdateAccountSendingEnabled operation.

    • ConfigurationSetSendingPaused: Email sending for this configuration set was disabled using the UpdateConfigurationSetSendingEnabled operation.

    • InvalidParameterValue: One or more of the parameters you specified when calling this operation was invalid. See the error message for additional information.

    • TransientFailure: Amazon SES was unable to process your request because of a temporary issue.

    • Failed: Amazon SES was unable to process your request. See the error message for additional information.

    " + }, + "Error":{ + "shape":"Error", + "documentation":"

    A description of an error that prevented a message being sent using the SendBulkTemplatedEmail operation.

    " + }, + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The unique message identifier returned from the SendBulkTemplatedEmail operation.

    " + } + }, + "documentation":"

    An object that contains the response from the SendBulkTemplatedEmail operation.

    " + }, + "BulkEmailDestinationStatusList":{ + "type":"list", + "member":{"shape":"BulkEmailDestinationStatus"} + }, + "BulkEmailStatus":{ + "type":"string", + "enum":[ + "Success", + "MessageRejected", + "MailFromDomainNotVerified", + "ConfigurationSetDoesNotExist", + "TemplateDoesNotExist", + "AccountSuspended", + "AccountThrottled", + "AccountDailyQuotaExceeded", + "InvalidSendingPoolName", + "AccountSendingPaused", + "ConfigurationSetSendingPaused", + "InvalidParameterValue", + "TransientFailure", + "Failed" + ] + }, + "CannotDeleteException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleOrRuleSetName", + "documentation":"

    Indicates that a resource could not be deleted because no resource with the specified name exists.

    " + } + }, + "documentation":"

    Indicates that the delete operation could not be completed.

    ", + "error":{ + "code":"CannotDelete", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Charset":{"type":"string"}, + "Cidr":{"type":"string"}, + "CloneReceiptRuleSetRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "OriginalRuleSetName" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the rule set to create. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain less than 64 characters.

    " + }, + "OriginalRuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the rule set to clone.

    " + } + }, + "documentation":"

    Represents a request to create a receipt rule set by cloning an existing one. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "CloneReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CloudWatchDestination":{ + "type":"structure", + "required":["DimensionConfigurations"], + "members":{ + "DimensionConfigurations":{ + "shape":"CloudWatchDimensionConfigurations", + "documentation":"

    A list of dimensions upon which to categorize your emails when you publish email sending events to Amazon CloudWatch.

    " + } + }, + "documentation":"

    Contains information associated with an Amazon CloudWatch event destination to which email sending events are published.

    Event destinations, such as Amazon CloudWatch, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "CloudWatchDimensionConfiguration":{ + "type":"structure", + "required":[ + "DimensionName", + "DimensionValueSource", + "DefaultDimensionValue" + ], + "members":{ + "DimensionName":{ + "shape":"DimensionName", + "documentation":"

    The name of an Amazon CloudWatch dimension associated with an email sending metric. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain less than 256 characters.

    " + }, + "DimensionValueSource":{ + "shape":"DimensionValueSource", + "documentation":"

    The place where Amazon SES finds the value of a dimension to publish to Amazon CloudWatch. If you want Amazon SES to use the message tags that you specify using an X-SES-MESSAGE-TAGS header or a parameter to the SendEmail/SendRawEmail API, choose messageTag. If you want Amazon SES to use your own email headers, choose emailHeader.

    " + }, + "DefaultDimensionValue":{ + "shape":"DefaultDimensionValue", + "documentation":"

    The default value of the dimension that is published to Amazon CloudWatch if you do not provide the value of the dimension when you send an email. The default value must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain less than 256 characters.

    " + } + }, + "documentation":"

    Contains the dimension configuration to use when you publish email sending events to Amazon CloudWatch.

    For information about publishing email sending events to Amazon CloudWatch, see the Amazon SES Developer Guide.

    " + }, + "CloudWatchDimensionConfigurations":{ + "type":"list", + "member":{"shape":"CloudWatchDimensionConfiguration"} + }, + "ConfigurationSet":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set. The name must meet the following requirements:

    • Contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain 64 characters or fewer.

    " + } + }, + "documentation":"

    The name of the configuration set.

    Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.

    " + }, + "ConfigurationSetAlreadyExistsException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + } + }, + "documentation":"

    Indicates that the configuration set could not be created because of a naming conflict.

    ", + "error":{ + "code":"ConfigurationSetAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConfigurationSetAttribute":{ + "type":"string", + "enum":[ + "eventDestinations", + "trackingOptions", + "deliveryOptions", + "reputationOptions" + ] + }, + "ConfigurationSetAttributeList":{ + "type":"list", + "member":{"shape":"ConfigurationSetAttribute"} + }, + "ConfigurationSetDoesNotExistException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + } + }, + "documentation":"

    Indicates that the configuration set does not exist.

    ", + "error":{ + "code":"ConfigurationSetDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConfigurationSetName":{"type":"string"}, + "ConfigurationSetSendingPausedException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set for which email sending is disabled.

    " + } + }, + "documentation":"

    Indicates that email sending is disabled for the configuration set.

    You can enable or disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled.

    ", + "error":{ + "code":"ConfigurationSetSendingPausedException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConfigurationSets":{ + "type":"list", + "member":{"shape":"ConfigurationSet"} + }, + "Content":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"MessageData", + "documentation":"

    The textual data of the content.

    " + }, + "Charset":{ + "shape":"Charset", + "documentation":"

    The character set of the content.

    " + } + }, + "documentation":"

    Represents textual data, plus an optional character set specification.

    By default, the text must be 7-bit ASCII, due to the constraints of the SMTP protocol. If the text must contain any other characters, then you must also specify a character set. Examples include UTF-8, ISO-8859-1, and Shift_JIS.

    " + }, + "Counter":{"type":"long"}, + "CreateConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestination" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that the event destination should be associated with.

    " + }, + "EventDestination":{ + "shape":"EventDestination", + "documentation":"

    An object that describes the AWS service that email sending event information will be published to.

    " + } + }, + "documentation":"

    Represents a request to create a configuration set event destination. A configuration set event destination, which can be either Amazon CloudWatch or Amazon Kinesis Firehose, describes an AWS service in which Amazon SES publishes the email sending events associated with a configuration set. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "CreateConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSet"], + "members":{ + "ConfigurationSet":{ + "shape":"ConfigurationSet", + "documentation":"

    A data structure that contains the name of the configuration set.

    " + } + }, + "documentation":"

    Represents a request to create a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "CreateConfigurationSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateConfigurationSetTrackingOptionsRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "TrackingOptions" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that the tracking options should be associated with.

    " + }, + "TrackingOptions":{"shape":"TrackingOptions"} + }, + "documentation":"

    Represents a request to create an open and click tracking option object in a configuration set.

    " + }, + "CreateConfigurationSetTrackingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateCustomVerificationEmailTemplateRequest":{ + "type":"structure", + "required":[ + "TemplateName", + "FromEmailAddress", + "TemplateSubject", + "TemplateContent", + "SuccessRedirectionURL", + "FailureRedirectionURL" + ], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template.

    " + }, + "FromEmailAddress":{ + "shape":"FromAddress", + "documentation":"

    The email address that the custom verification email is sent from.

    " + }, + "TemplateSubject":{ + "shape":"Subject", + "documentation":"

    The subject line of the custom verification email.

    " + }, + "TemplateContent":{ + "shape":"TemplateContent", + "documentation":"

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

    " + }, + "SuccessRedirectionURL":{ + "shape":"SuccessRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    " + }, + "FailureRedirectionURL":{ + "shape":"FailureRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    " + } + }, + "documentation":"

    Represents a request to create a custom verification email template.

    " + }, + "CreateReceiptFilterRequest":{ + "type":"structure", + "required":["Filter"], + "members":{ + "Filter":{ + "shape":"ReceiptFilter", + "documentation":"

    A data structure that describes the IP address filter to create, which consists of a name, an IP address range, and whether to allow or block mail from it.

    " + } + }, + "documentation":"

    Represents a request to create a new IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "CreateReceiptFilterResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateReceiptRuleRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "Rule" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the rule set that the receipt rule will be added to.

    " + }, + "After":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of an existing rule after which the new rule will be placed. If this parameter is null, the new rule will be inserted at the beginning of the rule list.

    " + }, + "Rule":{ + "shape":"ReceiptRule", + "documentation":"

    A data structure that contains the specified rule's name, actions, recipients, domains, enabled status, scan status, and TLS policy.

    " + } + }, + "documentation":"

    Represents a request to create a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "CreateReceiptRuleResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateReceiptRuleSetRequest":{ + "type":"structure", + "required":["RuleSetName"], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the rule set to create. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain less than 64 characters.

    " + } + }, + "documentation":"

    Represents a request to create an empty receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "CreateReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "CreateTemplateRequest":{ + "type":"structure", + "required":["Template"], + "members":{ + "Template":{ + "shape":"Template", + "documentation":"

    The content of the email, composed of a subject line, an HTML part, and a text-only part.

    " + } + }, + "documentation":"

    Represents a request to create an email template. For more information, see the Amazon SES Developer Guide.

    " + }, + "CreateTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "CustomMailFromStatus":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failed", + "TemporaryFailure" + ] + }, + "CustomRedirectDomain":{"type":"string"}, + "CustomVerificationEmailInvalidContentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that custom verification email template provided content is invalid.

    ", + "error":{ + "code":"CustomVerificationEmailInvalidContent", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CustomVerificationEmailTemplate":{ + "type":"structure", + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template.

    " + }, + "FromEmailAddress":{ + "shape":"FromAddress", + "documentation":"

    The email address that the custom verification email is sent from.

    " + }, + "TemplateSubject":{ + "shape":"Subject", + "documentation":"

    The subject line of the custom verification email.

    " + }, + "SuccessRedirectionURL":{ + "shape":"SuccessRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    " + }, + "FailureRedirectionURL":{ + "shape":"FailureRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    " + } + }, + "documentation":"

    Contains information about a custom verification email template.

    " + }, + "CustomVerificationEmailTemplateAlreadyExistsException":{ + "type":"structure", + "members":{ + "CustomVerificationEmailTemplateName":{ + "shape":"TemplateName", + "documentation":"

    Indicates that the provided custom verification email template with the specified template name already exists.

    " + } + }, + "documentation":"

    Indicates that a custom verification email template with the name you specified already exists.

    ", + "error":{ + "code":"CustomVerificationEmailTemplateAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CustomVerificationEmailTemplateDoesNotExistException":{ + "type":"structure", + "members":{ + "CustomVerificationEmailTemplateName":{ + "shape":"TemplateName", + "documentation":"

    Indicates that the provided custom verification email template does not exist.

    " + } + }, + "documentation":"

    Indicates that a custom verification email template with the name you specified does not exist.

    ", + "error":{ + "code":"CustomVerificationEmailTemplateDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "CustomVerificationEmailTemplates":{ + "type":"list", + "member":{"shape":"CustomVerificationEmailTemplate"} + }, + "DefaultDimensionValue":{"type":"string"}, + "DeleteConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestinationName" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set from which to delete the event destination.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    The name of the event destination to delete.

    " + } + }, + "documentation":"

    Represents a request to delete a configuration set event destination. Configuration set event destinations are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "DeleteConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to delete.

    " + } + }, + "documentation":"

    Represents a request to delete a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "DeleteConfigurationSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteConfigurationSetTrackingOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set from which you want to delete the tracking options.

    " + } + }, + "documentation":"

    Represents a request to delete open and click tracking options in a configuration set.

    " + }, + "DeleteConfigurationSetTrackingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteCustomVerificationEmailTemplateRequest":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template that you want to delete.

    " + } + }, + "documentation":"

    Represents a request to delete an existing custom verification email template.

    " + }, + "DeleteIdentityPolicyRequest":{ + "type":"structure", + "required":[ + "Identity", + "PolicyName" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity that is associated with the policy that you want to delete. You can specify the identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    To successfully call this API, you must own the identity.

    " + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

    The name of the policy to be deleted.

    " + } + }, + "documentation":"

    Represents a request to delete a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

    " + }, + "DeleteIdentityPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteIdentityRequest":{ + "type":"structure", + "required":["Identity"], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity to be removed from the list of identities for the AWS Account.

    " + } + }, + "documentation":"

    Represents a request to delete one of your Amazon SES identities (an email address or domain).

    " + }, + "DeleteIdentityResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteReceiptFilterRequest":{ + "type":"structure", + "required":["FilterName"], + "members":{ + "FilterName":{ + "shape":"ReceiptFilterName", + "documentation":"

    The name of the IP address filter to delete.

    " + } + }, + "documentation":"

    Represents a request to delete an IP address filter. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DeleteReceiptFilterResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteReceiptRuleRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "RuleName" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set that contains the receipt rule to delete.

    " + }, + "RuleName":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of the receipt rule to delete.

    " + } + }, + "documentation":"

    Represents a request to delete a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DeleteReceiptRuleResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteReceiptRuleSetRequest":{ + "type":"structure", + "required":["RuleSetName"], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set to delete.

    " + } + }, + "documentation":"

    Represents a request to delete a receipt rule set and all of the receipt rules it contains. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DeleteReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "DeleteTemplateRequest":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the template to be deleted.

    " + } + }, + "documentation":"

    Represents a request to delete an email template. For more information, see the Amazon SES Developer Guide.

    " + }, + "DeleteTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteVerifiedEmailAddressRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

    An email address to be removed from the list of verified addresses.

    " + } + }, + "documentation":"

    Represents a request to delete an email address from the list of email addresses you have attempted to verify under your AWS account.

    " + }, + "DeliveryOptions":{ + "type":"structure", + "members":{ + "TlsPolicy":{ + "shape":"TlsPolicy", + "documentation":"

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS). If the value is Require, messages are only delivered if a TLS connection can be established. If the value is Optional, messages can be delivered in plain text if a TLS connection can't be established.

    " + } + }, + "documentation":"

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

    " + }, + "DescribeActiveReceiptRuleSetRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Represents a request to return the metadata and receipt rules for the receipt rule set that is currently active. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DescribeActiveReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"ReceiptRuleSetMetadata", + "documentation":"

    The metadata for the currently active receipt rule set. The metadata consists of the rule set name and a timestamp of when the rule set was created.

    " + }, + "Rules":{ + "shape":"ReceiptRulesList", + "documentation":"

    The receipt rules that belong to the active rule set.

    " + } + }, + "documentation":"

    Represents the metadata and receipt rules for the receipt rule set that is currently active.

    " + }, + "DescribeConfigurationSetRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to describe.

    " + }, + "ConfigurationSetAttributeNames":{ + "shape":"ConfigurationSetAttributeList", + "documentation":"

    A list of configuration set attributes to return.

    " + } + }, + "documentation":"

    Represents a request to return the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "DescribeConfigurationSetResponse":{ + "type":"structure", + "members":{ + "ConfigurationSet":{ + "shape":"ConfigurationSet", + "documentation":"

    The configuration set object associated with the specified configuration set.

    " + }, + "EventDestinations":{ + "shape":"EventDestinations", + "documentation":"

    A list of event destinations associated with the configuration set.

    " + }, + "TrackingOptions":{ + "shape":"TrackingOptions", + "documentation":"

    The name of the custom open and click tracking domain associated with the configuration set.

    " + }, + "DeliveryOptions":{"shape":"DeliveryOptions"}, + "ReputationOptions":{ + "shape":"ReputationOptions", + "documentation":"

    An object that represents the reputation settings for the configuration set.

    " + } + }, + "documentation":"

    Represents the details of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "DescribeReceiptRuleRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "RuleName" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set that the receipt rule belongs to.

    " + }, + "RuleName":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of the receipt rule.

    " + } + }, + "documentation":"

    Represents a request to return the details of a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DescribeReceiptRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"ReceiptRule", + "documentation":"

    A data structure that contains the specified receipt rule's name, actions, recipients, domains, enabled status, scan status, and Transport Layer Security (TLS) policy.

    " + } + }, + "documentation":"

    Represents the details of a receipt rule.

    " + }, + "DescribeReceiptRuleSetRequest":{ + "type":"structure", + "required":["RuleSetName"], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set to describe.

    " + } + }, + "documentation":"

    Represents a request to return the details of a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "DescribeReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"ReceiptRuleSetMetadata", + "documentation":"

    The metadata for the receipt rule set, which consists of the rule set name and the timestamp of when the rule set was created.

    " + }, + "Rules":{ + "shape":"ReceiptRulesList", + "documentation":"

    A list of the receipt rules that belong to the specified receipt rule set.

    " + } + }, + "documentation":"

    Represents the details of the specified receipt rule set.

    " + }, + "Destination":{ + "type":"structure", + "members":{ + "ToAddresses":{ + "shape":"AddressList", + "documentation":"

    The recipients to place on the To: line of the message.

    " + }, + "CcAddresses":{ + "shape":"AddressList", + "documentation":"

    The recipients to place on the CC: line of the message.

    " + }, + "BccAddresses":{ + "shape":"AddressList", + "documentation":"

    The recipients to place on the BCC: line of the message.

    " + } + }, + "documentation":"

    Represents the destination of the message, consisting of To:, CC:, and BCC: fields.

    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a destination email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492.

    " + }, + "DiagnosticCode":{"type":"string"}, + "DimensionName":{"type":"string"}, + "DimensionValueSource":{ + "type":"string", + "enum":[ + "messageTag", + "emailHeader", + "linkTag" + ] + }, + "DkimAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityDkimAttributes"} + }, + "Domain":{"type":"string"}, + "DsnAction":{ + "type":"string", + "enum":[ + "failed", + "delayed", + "delivered", + "relayed", + "expanded" + ] + }, + "DsnStatus":{"type":"string"}, + "Enabled":{"type":"boolean"}, + "Error":{"type":"string"}, + "EventDestination":{ + "type":"structure", + "required":[ + "Name", + "MatchingEventTypes" + ], + "members":{ + "Name":{ + "shape":"EventDestinationName", + "documentation":"

    The name of the event destination. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain less than 64 characters.

    " + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Sets whether Amazon SES publishes events to this destination when you send an email with the associated configuration set. Set to true to enable publishing to this destination; set to false to prevent publishing to this destination. The default value is false.

    " + }, + "MatchingEventTypes":{ + "shape":"EventTypes", + "documentation":"

    The type of email sending events to publish to the event destination.

    " + }, + "KinesisFirehoseDestination":{ + "shape":"KinesisFirehoseDestination", + "documentation":"

    An object that contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

    " + }, + "CloudWatchDestination":{ + "shape":"CloudWatchDestination", + "documentation":"

    An object that contains the names, default values, and sources of the dimensions associated with an Amazon CloudWatch event destination.

    " + }, + "SNSDestination":{ + "shape":"SNSDestination", + "documentation":"

    An object that contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

    " + } + }, + "documentation":"

    Contains information about the event destination that the specified email sending events will be published to.

    When you create or update an event destination, you must provide one, and only one, destination. The destination can be Amazon CloudWatch, Amazon Kinesis Firehose or Amazon Simple Notification Service (Amazon SNS).

    Event destinations are associated with configuration sets, which enable you to publish email sending events to Amazon CloudWatch, Amazon Kinesis Firehose, or Amazon Simple Notification Service (Amazon SNS). For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "EventDestinationAlreadyExistsException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    Indicates that the event destination does not exist.

    " + } + }, + "documentation":"

    Indicates that the event destination could not be created because of a naming conflict.

    ", + "error":{ + "code":"EventDestinationAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventDestinationDoesNotExistException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    Indicates that the event destination does not exist.

    " + } + }, + "documentation":"

    Indicates that the event destination does not exist.

    ", + "error":{ + "code":"EventDestinationDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "EventDestinationName":{"type":"string"}, + "EventDestinations":{ + "type":"list", + "member":{"shape":"EventDestination"} + }, + "EventType":{ + "type":"string", + "enum":[ + "send", + "reject", + "bounce", + "complaint", + "delivery", + "open", + "click", + "renderingFailure" + ] + }, + "EventTypes":{ + "type":"list", + "member":{"shape":"EventType"} + }, + "Explanation":{"type":"string"}, + "ExtensionField":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"ExtensionFieldName", + "documentation":"

    The name of the header to add. Must be between 1 and 50 characters, inclusive, and consist of alphanumeric (a-z, A-Z, 0-9) characters and dashes only.

    " + }, + "Value":{ + "shape":"ExtensionFieldValue", + "documentation":"

    The value of the header to add. Must be less than 2048 characters, and must not contain newline characters (\"\\r\" or \"\\n\").

    " + } + }, + "documentation":"

    Additional X-headers to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

    For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "ExtensionFieldList":{ + "type":"list", + "member":{"shape":"ExtensionField"} + }, + "ExtensionFieldName":{"type":"string"}, + "ExtensionFieldValue":{"type":"string"}, + "FailureRedirectionURL":{"type":"string"}, + "FromAddress":{"type":"string"}, + "FromEmailAddressNotVerifiedException":{ + "type":"structure", + "members":{ + "FromEmailAddress":{ + "shape":"FromAddress", + "documentation":"

    Indicates that the from email address associated with the custom verification email template is not verified.

    " + } + }, + "documentation":"

    Indicates that the sender address specified for a custom verification email is not verified, and is therefore not eligible to send the custom verification email.

    ", + "error":{ + "code":"FromEmailAddressNotVerified", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "GetAccountSendingEnabledResponse":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

    " + } + }, + "documentation":"

    Represents a request to return the email sending status for your Amazon SES account in the current AWS Region.

    " + }, + "GetCustomVerificationEmailTemplateRequest":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template that you want to retrieve.

    " + } + }, + "documentation":"

    Represents a request to retrieve an existing custom verification email template.

    " + }, + "GetCustomVerificationEmailTemplateResponse":{ + "type":"structure", + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template.

    " + }, + "FromEmailAddress":{ + "shape":"FromAddress", + "documentation":"

    The email address that the custom verification email is sent from.

    " + }, + "TemplateSubject":{ + "shape":"Subject", + "documentation":"

    The subject line of the custom verification email.

    " + }, + "TemplateContent":{ + "shape":"TemplateContent", + "documentation":"

    The content of the custom verification email.

    " + }, + "SuccessRedirectionURL":{ + "shape":"SuccessRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    " + }, + "FailureRedirectionURL":{ + "shape":"FailureRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    " + } + }, + "documentation":"

    The content of the custom verification email template.

    " + }, + "GetIdentityDkimAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

    A list of one or more verified identities - email addresses, domains, or both.

    " + } + }, + "documentation":"

    Represents a request for the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this request also returns the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published. For more information about Easy DKIM, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityDkimAttributesResponse":{ + "type":"structure", + "required":["DkimAttributes"], + "members":{ + "DkimAttributes":{ + "shape":"DkimAttributes", + "documentation":"

    The DKIM attributes for an email address or a domain.

    " + } + }, + "documentation":"

    Represents the status of Amazon SES Easy DKIM signing for an identity. For domain identities, this response also contains the DKIM tokens that are required for Easy DKIM signing, and whether Amazon SES successfully verified that these tokens were published.

    " + }, + "GetIdentityMailFromDomainAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

    A list of one or more identities.

    " + } + }, + "documentation":"

    Represents a request to return the Amazon SES custom MAIL FROM attributes for a list of identities. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityMailFromDomainAttributesResponse":{ + "type":"structure", + "required":["MailFromDomainAttributes"], + "members":{ + "MailFromDomainAttributes":{ + "shape":"MailFromDomainAttributes", + "documentation":"

    A map of identities to custom MAIL FROM attributes.

    " + } + }, + "documentation":"

    Represents the custom MAIL FROM attributes for a list of identities.

    " + }, + "GetIdentityNotificationAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

    A list of one or more identities. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    " + } + }, + "documentation":"

    Represents a request to return the notification attributes for a list of identities you verified with Amazon SES. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityNotificationAttributesResponse":{ + "type":"structure", + "required":["NotificationAttributes"], + "members":{ + "NotificationAttributes":{ + "shape":"NotificationAttributes", + "documentation":"

    A map of Identity to IdentityNotificationAttributes.

    " + } + }, + "documentation":"

    Represents the notification attributes for a list of identities.

    " + }, + "GetIdentityPoliciesRequest":{ + "type":"structure", + "required":[ + "Identity", + "PolicyNames" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity for which the policies will be retrieved. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    To successfully call this API, you must own the identity.

    " + }, + "PolicyNames":{ + "shape":"PolicyNameList", + "documentation":"

    A list of the names of policies to be retrieved. You can retrieve a maximum of 20 policies at a time. If you do not know the names of the policies that are attached to the identity, you can use ListIdentityPolicies.

    " + } + }, + "documentation":"

    Represents a request to return the requested sending authorization policies for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityPoliciesResponse":{ + "type":"structure", + "required":["Policies"], + "members":{ + "Policies":{ + "shape":"PolicyMap", + "documentation":"

    A map of policy names to policies.

    " + } + }, + "documentation":"

    Represents the requested sending authorization policies.

    " + }, + "GetIdentityVerificationAttributesRequest":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

    A list of identities.

    " + } + }, + "documentation":"

    Represents a request to return the Amazon SES verification status of a list of identities. For domain identities, this request also returns the verification token. For information about verifying identities with Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "GetIdentityVerificationAttributesResponse":{ + "type":"structure", + "required":["VerificationAttributes"], + "members":{ + "VerificationAttributes":{ + "shape":"VerificationAttributes", + "documentation":"

    A map of Identities to IdentityVerificationAttributes objects.

    " + } + }, + "documentation":"

    The Amazon SES verification status of a list of identities. For domain identities, this response also contains the verification token.

    " + }, + "GetSendQuotaResponse":{ + "type":"structure", + "members":{ + "Max24HourSend":{ + "shape":"Max24HourSend", + "documentation":"

    The maximum number of emails the user is allowed to send in a 24-hour interval. A value of -1 signifies an unlimited quota.

    " + }, + "MaxSendRate":{ + "shape":"MaxSendRate", + "documentation":"

    The maximum number of emails that Amazon SES can accept from the user's account per second.

    The rate at which Amazon SES accepts the user's messages might be less than the maximum send rate.

    " + }, + "SentLast24Hours":{ + "shape":"SentLast24Hours", + "documentation":"

    The number of emails sent during the previous 24 hours.

    " + } + }, + "documentation":"

    Represents your Amazon SES daily sending quota, maximum send rate, and the number of emails you have sent in the last 24 hours.

    " + }, + "GetSendStatisticsResponse":{ + "type":"structure", + "members":{ + "SendDataPoints":{ + "shape":"SendDataPointList", + "documentation":"

    A list of data points, each of which represents 15 minutes of activity.

    " + } + }, + "documentation":"

    Represents a list of data points. This list contains aggregated data from the previous two weeks of your sending activity with Amazon SES.

    " + }, + "GetTemplateRequest":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the template you want to retrieve.

    " + } + } + }, + "GetTemplateResponse":{ + "type":"structure", + "members":{ + "Template":{"shape":"Template"} + } + }, + "HeaderName":{"type":"string"}, + "HeaderValue":{"type":"string"}, + "HtmlPart":{"type":"string"}, + "Identity":{"type":"string"}, + "IdentityDkimAttributes":{ + "type":"structure", + "required":[ + "DkimEnabled", + "DkimVerificationStatus" + ], + "members":{ + "DkimEnabled":{ + "shape":"Enabled", + "documentation":"

    Is true if DKIM signing is enabled for email sent from the identity. It's false otherwise. The default value is true.

    " + }, + "DkimVerificationStatus":{ + "shape":"VerificationStatus", + "documentation":"

    Describes whether Amazon SES has successfully verified the DKIM DNS records (tokens) published in the domain name's DNS. (This only applies to domain identities, not email address identities.)

    " + }, + "DkimTokens":{ + "shape":"VerificationTokenList", + "documentation":"

    A set of character strings that represent the domain's identity. Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

    For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

    " + } + }, + "documentation":"

    Represents the DKIM attributes of a verified email address or a domain.

    " + }, + "IdentityList":{ + "type":"list", + "member":{"shape":"Identity"} + }, + "IdentityMailFromDomainAttributes":{ + "type":"structure", + "required":[ + "MailFromDomain", + "MailFromDomainStatus", + "BehaviorOnMXFailure" + ], + "members":{ + "MailFromDomain":{ + "shape":"MailFromDomainName", + "documentation":"

    The custom MAIL FROM domain that the identity is configured to use.

    " + }, + "MailFromDomainStatus":{ + "shape":"CustomMailFromStatus", + "documentation":"

    The state that indicates whether Amazon SES has successfully read the MX record required for custom MAIL FROM domain setup. If the state is Success, Amazon SES uses the specified custom MAIL FROM domain when the verified identity sends an email. All other states indicate that Amazon SES takes the action described by BehaviorOnMXFailure.

    " + }, + "BehaviorOnMXFailure":{ + "shape":"BehaviorOnMXFailure", + "documentation":"

    The action that Amazon SES takes if it cannot successfully read the required MX record when you send an email. A value of UseDefaultValue indicates that if Amazon SES cannot read the required MX record, it uses amazonses.com (or a subdomain of that) as the MAIL FROM domain. A value of RejectMessage indicates that if Amazon SES cannot read the required MX record, Amazon SES returns a MailFromDomainNotVerified error and does not send the email.

    The custom MAIL FROM setup states that result in this behavior are Pending, Failed, and TemporaryFailure.

    " + } + }, + "documentation":"

    Represents the custom MAIL FROM domain attributes of a verified identity (email address or domain).

    " + }, + "IdentityNotificationAttributes":{ + "type":"structure", + "required":[ + "BounceTopic", + "ComplaintTopic", + "DeliveryTopic", + "ForwardingEnabled" + ], + "members":{ + "BounceTopic":{ + "shape":"NotificationTopic", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish bounce notifications.

    " + }, + "ComplaintTopic":{ + "shape":"NotificationTopic", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish complaint notifications.

    " + }, + "DeliveryTopic":{ + "shape":"NotificationTopic", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic where Amazon SES will publish delivery notifications.

    " + }, + "ForwardingEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether Amazon SES will forward bounce and complaint notifications as email. true indicates that Amazon SES will forward bounce and complaint notifications as email, while false indicates that bounce and complaint notifications will be published only to the specified bounce and complaint Amazon SNS topics.

    " + }, + "HeadersInBounceNotificationsEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Bounce. A value of true specifies that Amazon SES will include headers in bounce notifications, and a value of false specifies that Amazon SES will not include headers in bounce notifications.

    " + }, + "HeadersInComplaintNotificationsEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Complaint. A value of true specifies that Amazon SES will include headers in complaint notifications, and a value of false specifies that Amazon SES will not include headers in complaint notifications.

    " + }, + "HeadersInDeliveryNotificationsEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether Amazon SES includes the original email headers in Amazon SNS notifications of type Delivery. A value of true specifies that Amazon SES will include headers in delivery notifications, and a value of false specifies that Amazon SES will not include headers in delivery notifications.

    " + } + }, + "documentation":"

    Represents the notification attributes of an identity, including whether an identity has Amazon Simple Notification Service (Amazon SNS) topics set for bounce, complaint, and/or delivery notifications, and whether feedback forwarding is enabled for bounce and complaint notifications.

    " + }, + "IdentityType":{ + "type":"string", + "enum":[ + "EmailAddress", + "Domain" + ] + }, + "IdentityVerificationAttributes":{ + "type":"structure", + "required":["VerificationStatus"], + "members":{ + "VerificationStatus":{ + "shape":"VerificationStatus", + "documentation":"

    The verification status of the identity: \"Pending\", \"Success\", \"Failed\", or \"TemporaryFailure\".

    " + }, + "VerificationToken":{ + "shape":"VerificationToken", + "documentation":"

    The verification token for a domain identity. Null for email address identities.

    " + } + }, + "documentation":"

    Represents the verification attributes of a single identity.

    " + }, + "InvalidCloudWatchDestinationException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    Indicates that the event destination does not exist.

    " + } + }, + "documentation":"

    Indicates that the Amazon CloudWatch destination is invalid. See the error message for details.

    ", + "error":{ + "code":"InvalidCloudWatchDestination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidConfigurationSetException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the configuration set is invalid. See the error message for details.

    ", + "error":{ + "code":"InvalidConfigurationSet", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidDeliveryOptionsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that provided delivery option is invalid.

    ", + "error":{ + "code":"InvalidDeliveryOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidFirehoseDestinationException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    Indicates that the event destination does not exist.

    " + } + }, + "documentation":"

    Indicates that the Amazon Kinesis Firehose destination is invalid. See the error message for details.

    ", + "error":{ + "code":"InvalidFirehoseDestination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidLambdaFunctionException":{ + "type":"structure", + "members":{ + "FunctionArn":{ + "shape":"AmazonResourceName", + "documentation":"

    Indicates that the ARN of the function was not found.

    " + } + }, + "documentation":"

    Indicates that the provided AWS Lambda function is invalid, or that Amazon SES could not execute the provided function, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

    ", + "error":{ + "code":"InvalidLambdaFunction", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidPolicyException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the provided policy is invalid. Check the error stack for more information about what caused the error.

    ", + "error":{ + "code":"InvalidPolicy", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidRenderingParameterException":{ + "type":"structure", + "members":{ + "TemplateName":{"shape":"TemplateName"} + }, + "documentation":"

    Indicates that one or more of the replacement values you provided is invalid. This error may occur when the TemplateData object contains invalid JSON.

    ", + "error":{ + "code":"InvalidRenderingParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidS3ConfigurationException":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"S3BucketName", + "documentation":"

    Indicated that the S3 Bucket was not found.

    " + } + }, + "documentation":"

    Indicates that the provided Amazon S3 bucket or AWS KMS encryption key is invalid, or that Amazon SES could not publish to the bucket, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

    ", + "error":{ + "code":"InvalidS3Configuration", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSNSDestinationException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that the configuration set does not exist.

    " + }, + "EventDestinationName":{ + "shape":"EventDestinationName", + "documentation":"

    Indicates that the event destination does not exist.

    " + } + }, + "documentation":"

    Indicates that the Amazon Simple Notification Service (Amazon SNS) destination is invalid. See the error message for details.

    ", + "error":{ + "code":"InvalidSNSDestination", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSnsTopicException":{ + "type":"structure", + "members":{ + "Topic":{ + "shape":"AmazonResourceName", + "documentation":"

    Indicates that the topic does not exist.

    " + } + }, + "documentation":"

    Indicates that the provided Amazon SNS topic is invalid, or that Amazon SES could not publish to the topic, possibly due to permissions issues. For information about giving permissions, see the Amazon SES Developer Guide.

    ", + "error":{ + "code":"InvalidSnsTopic", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTemplateException":{ + "type":"structure", + "members":{ + "TemplateName":{"shape":"TemplateName"} + }, + "documentation":"

    Indicates that the template that you specified could not be rendered. This issue may occur when a template refers to a partial that does not exist.

    ", + "error":{ + "code":"InvalidTemplate", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidTrackingOptionsException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the custom domain to be used for open and click tracking redirects is invalid. This error appears most often in the following situations:

    • When the tracking domain you specified is not verified in Amazon SES.

    • When the tracking domain you specified is not a valid domain or subdomain.

    ", + "error":{ + "code":"InvalidTrackingOptions", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvocationType":{ + "type":"string", + "enum":[ + "Event", + "RequestResponse" + ] + }, + "KinesisFirehoseDestination":{ + "type":"structure", + "required":[ + "IAMRoleARN", + "DeliveryStreamARN" + ], + "members":{ + "IAMRoleARN":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the IAM role under which Amazon SES publishes email sending events to the Amazon Kinesis Firehose stream.

    " + }, + "DeliveryStreamARN":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the Amazon Kinesis Firehose stream that email sending events should be published to.

    " + } + }, + "documentation":"

    Contains the delivery stream ARN and the IAM role ARN associated with an Amazon Kinesis Firehose event destination.

    Event destinations, such as Amazon Kinesis Firehose, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "LambdaAction":{ + "type":"structure", + "required":["FunctionArn"], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the Lambda action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + }, + "FunctionArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS Lambda function. An example of an AWS Lambda function ARN is arn:aws:lambda:us-west-2:account-id:function:MyFunction. For more information about AWS Lambda, see the AWS Lambda Developer Guide.

    " + }, + "InvocationType":{ + "shape":"InvocationType", + "documentation":"

    The invocation type of the AWS Lambda function. An invocation type of RequestResponse means that the execution of the function will immediately result in a response, and a value of Event means that the function will be invoked asynchronously. The default value is Event. For information about AWS Lambda invocation types, see the AWS Lambda Developer Guide.

    There is a 30-second timeout on RequestResponse invocations. You should use Event invocation in most cases. Use RequestResponse only when you want to make a mail flow decision, such as whether to stop the receipt rule or the receipt rule set.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action calls an AWS Lambda function and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    To enable Amazon SES to call your AWS Lambda function or to publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

    For information about using AWS Lambda actions in receipt rules, see the Amazon SES Developer Guide.

    " + }, + "LastAttemptDate":{"type":"timestamp"}, + "LastFreshStart":{"type":"timestamp"}, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that a resource could not be created because of service limits. For a list of Amazon SES limits, see the Amazon SES Developer Guide.

    ", + "error":{ + "code":"LimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ListConfigurationSetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token returned from a previous call to ListConfigurationSets to indicate the position of the configuration set in the configuration set list.

    " + }, + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

    The number of configuration sets to return.

    " + } + }, + "documentation":"

    Represents a request to list the configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "ListConfigurationSetsResponse":{ + "type":"structure", + "members":{ + "ConfigurationSets":{ + "shape":"ConfigurationSets", + "documentation":"

    A list of configuration sets.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token indicating that there are additional configuration sets available to be listed. Pass this token to successive calls of ListConfigurationSets.

    " + } + }, + "documentation":"

    A list of configuration sets associated with your AWS account. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "ListCustomVerificationEmailTemplatesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    An array the contains the name and creation time stamp for each template in your Amazon SES account.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of custom verification email templates to return. This value must be at least 1 and less than or equal to 50. If you do not specify a value, or if you specify a value less than 1 or greater than 50, the operation will return up to 50 results.

    " + } + }, + "documentation":"

    Represents a request to list the existing custom verification email templates for your account.

    For more information about custom verification email templates, see Using Custom Verification Email Templates in the Amazon SES Developer Guide.

    " + }, + "ListCustomVerificationEmailTemplatesResponse":{ + "type":"structure", + "members":{ + "CustomVerificationEmailTemplates":{ + "shape":"CustomVerificationEmailTemplates", + "documentation":"

    A list of the custom verification email templates that exist in your account.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token indicating that there are additional custom verification email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 custom verification email templates.

    " + } + }, + "documentation":"

    A paginated list of custom verification email templates.

    " + }, + "ListIdentitiesRequest":{ + "type":"structure", + "members":{ + "IdentityType":{ + "shape":"IdentityType", + "documentation":"

    The type of the identities to list. Possible values are \"EmailAddress\" and \"Domain\". If this parameter is omitted, then all identities will be listed.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use for pagination.

    " + }, + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

    The maximum number of identities per page. Possible values are 1-1000 inclusive.

    " + } + }, + "documentation":"

    Represents a request to return a list of all identities (email addresses and domains) that you have attempted to verify under your AWS account, regardless of verification status.

    " + }, + "ListIdentitiesResponse":{ + "type":"structure", + "required":["Identities"], + "members":{ + "Identities":{ + "shape":"IdentityList", + "documentation":"

    A list of identities.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token used for pagination.

    " + } + }, + "documentation":"

    A list of all identities that you have attempted to verify under your AWS account, regardless of verification status.

    " + }, + "ListIdentityPoliciesRequest":{ + "type":"structure", + "required":["Identity"], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity that is associated with the policy for which the policies will be listed. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    To successfully call this API, you must own the identity.

    " + } + }, + "documentation":"

    Represents a request to return a list of sending authorization policies that are attached to an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

    " + }, + "ListIdentityPoliciesResponse":{ + "type":"structure", + "required":["PolicyNames"], + "members":{ + "PolicyNames":{ + "shape":"PolicyNameList", + "documentation":"

    A list of names of policies that apply to the specified identity.

    " + } + }, + "documentation":"

    A list of names of sending authorization policies that apply to an identity.

    " + }, + "ListReceiptFiltersRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Represents a request to list the IP address filters that exist under your AWS account. You use IP address filters when you receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "ListReceiptFiltersResponse":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ReceiptFilterList", + "documentation":"

    A list of IP address filter data structures, which each consist of a name, an IP address range, and whether to allow or block mail from it.

    " + } + }, + "documentation":"

    A list of IP address filters that exist under your AWS account.

    " + }, + "ListReceiptRuleSetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token returned from a previous call to ListReceiptRuleSets to indicate the position in the receipt rule set list.

    " + } + }, + "documentation":"

    Represents a request to list the receipt rule sets that exist under your AWS account. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "ListReceiptRuleSetsResponse":{ + "type":"structure", + "members":{ + "RuleSets":{ + "shape":"ReceiptRuleSetsLists", + "documentation":"

    The metadata for the currently active receipt rule set. The metadata consists of the rule set name and the timestamp of when the rule set was created.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token indicating that there are additional receipt rule sets available to be listed. Pass this token to successive calls of ListReceiptRuleSets to retrieve up to 100 receipt rule sets at a time.

    " + } + }, + "documentation":"

    A list of receipt rule sets that exist under your AWS account.

    " + }, + "ListTemplatesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token returned from a previous call to ListTemplates to indicate the position in the list of email templates.

    " + }, + "MaxItems":{ + "shape":"MaxItems", + "documentation":"

    The maximum number of templates to return. This value must be at least 1 and less than or equal to 10. If you do not specify a value, or if you specify a value less than 1 or greater than 10, the operation will return up to 10 results.

    " + } + } + }, + "ListTemplatesResponse":{ + "type":"structure", + "members":{ + "TemplatesMetadata":{ + "shape":"TemplateMetadataList", + "documentation":"

    An array the contains the name and creation time stamp for each template in your Amazon SES account.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token indicating that there are additional email templates available to be listed. Pass this token to a subsequent call to ListTemplates to retrieve the next 50 email templates.

    " + } + } + }, + "ListVerifiedEmailAddressesResponse":{ + "type":"structure", + "members":{ + "VerifiedEmailAddresses":{ + "shape":"AddressList", + "documentation":"

    A list of email addresses that have been verified.

    " + } + }, + "documentation":"

    A list of email addresses that you have verified with Amazon SES under your AWS account.

    " + }, + "MailFromDomainAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityMailFromDomainAttributes"} + }, + "MailFromDomainName":{"type":"string"}, + "MailFromDomainNotVerifiedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the message could not be sent because Amazon SES could not read the MX record required to use the specified MAIL FROM domain. For information about editing the custom MAIL FROM domain settings for an identity, see the Amazon SES Developer Guide.

    ", + "error":{ + "code":"MailFromDomainNotVerifiedException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Max24HourSend":{"type":"double"}, + "MaxItems":{"type":"integer"}, + "MaxResults":{ + "type":"integer", + "box":true, + "max":50, + "min":1 + }, + "MaxSendRate":{"type":"double"}, + "Message":{ + "type":"structure", + "required":[ + "Subject", + "Body" + ], + "members":{ + "Subject":{ + "shape":"Content", + "documentation":"

    The subject of the message: A short summary of the content, which will appear in the recipient's inbox.

    " + }, + "Body":{ + "shape":"Body", + "documentation":"

    The message body.

    " + } + }, + "documentation":"

    Represents the message to be sent, composed of a subject and a body.

    " + }, + "MessageData":{"type":"string"}, + "MessageDsn":{ + "type":"structure", + "required":["ReportingMta"], + "members":{ + "ReportingMta":{ + "shape":"ReportingMta", + "documentation":"

    The reporting MTA that attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). The default value is dns; inbound-smtp.[region].amazonaws.com.

    " + }, + "ArrivalDate":{ + "shape":"ArrivalDate", + "documentation":"

    When the message was received by the reporting mail transfer agent (MTA), in RFC 822 date-time format.

    " + }, + "ExtensionFields":{ + "shape":"ExtensionFieldList", + "documentation":"

    Additional X-headers to include in the DSN.

    " + } + }, + "documentation":"

    Message-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

    For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "MessageId":{"type":"string"}, + "MessageRejected":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the action failed, and the message could not be sent. Check the error stack for more information about what caused the error.

    ", + "error":{ + "code":"MessageRejected", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "MessageTag":{ + "type":"structure", + "required":[ + "Name", + "Value" + ], + "members":{ + "Name":{ + "shape":"MessageTagName", + "documentation":"

    The name of the tag. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain less than 256 characters.

    " + }, + "Value":{ + "shape":"MessageTagValue", + "documentation":"

    The value of the tag. The value must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Contain less than 256 characters.

    " + } + }, + "documentation":"

    Contains the name and value of a tag that you can provide to SendEmail or SendRawEmail to apply to an email.

    Message tags, which you use with configuration sets, enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "MessageTagList":{ + "type":"list", + "member":{"shape":"MessageTag"} + }, + "MessageTagName":{"type":"string"}, + "MessageTagValue":{"type":"string"}, + "MissingRenderingAttributeException":{ + "type":"structure", + "members":{ + "TemplateName":{"shape":"TemplateName"} + }, + "documentation":"

    Indicates that one or more of the replacement values for the specified template was not specified. Ensure that the TemplateData object contains references to all of the replacement tags in the specified template.

    ", + "error":{ + "code":"MissingRenderingAttribute", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NextToken":{"type":"string"}, + "NotificationAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityNotificationAttributes"} + }, + "NotificationTopic":{"type":"string"}, + "NotificationType":{ + "type":"string", + "enum":[ + "Bounce", + "Complaint", + "Delivery" + ] + }, + "Policy":{ + "type":"string", + "min":1 + }, + "PolicyMap":{ + "type":"map", + "key":{"shape":"PolicyName"}, + "value":{"shape":"Policy"} + }, + "PolicyName":{ + "type":"string", + "max":64, + "min":1 + }, + "PolicyNameList":{ + "type":"list", + "member":{"shape":"PolicyName"} + }, + "ProductionAccessNotGrantedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the account has not been granted production access.

    ", + "error":{ + "code":"ProductionAccessNotGranted", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PutConfigurationSetDeliveryOptionsRequest":{ + "type":"structure", + "required":["ConfigurationSetName"], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that you want to specify the delivery options for.

    " + }, + "DeliveryOptions":{ + "shape":"DeliveryOptions", + "documentation":"

    Specifies whether messages that use the configuration set are required to use Transport Layer Security (TLS).

    " + } + }, + "documentation":"

    A request to modify the delivery options for a configuration set.

    " + }, + "PutConfigurationSetDeliveryOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An HTTP 200 response if the request succeeds, or an error message if the request fails.

    " + }, + "PutIdentityPolicyRequest":{ + "type":"structure", + "required":[ + "Identity", + "PolicyName", + "Policy" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity that the policy will apply to. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). Examples: user@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    To successfully call this API, you must own the identity.

    " + }, + "PolicyName":{ + "shape":"PolicyName", + "documentation":"

    The name of the policy.

    The policy name cannot exceed 64 characters and can only include alphanumeric characters, dashes, and underscores.

    " + }, + "Policy":{ + "shape":"Policy", + "documentation":"

    The text of the policy in JSON format. The policy cannot exceed 4 KB.

    For information about the syntax of sending authorization policies, see the Amazon SES Developer Guide.

    " + } + }, + "documentation":"

    Represents a request to add or update a sending authorization policy for an identity. Sending authorization is an Amazon SES feature that enables you to authorize other senders to use your identities. For information, see the Amazon SES Developer Guide.

    " + }, + "PutIdentityPolicyResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "RawMessage":{ + "type":"structure", + "required":["Data"], + "members":{ + "Data":{ + "shape":"RawMessageData", + "documentation":"

    The raw data of the message. This data needs to base64-encoded if you are accessing Amazon SES directly through the HTTPS interface. If you are accessing Amazon SES using an AWS SDK, the SDK takes care of the base 64-encoding for you. In all cases, the client must ensure that the message format complies with Internet email standards regarding email header fields, MIME types, and MIME encoding.

    The To:, CC:, and BCC: headers in the raw message can contain a group list.

    If you are using SendRawEmail with sending authorization, you can include X-headers in the raw message to specify the \"Source,\" \"From,\" and \"Return-Path\" addresses. For more information, see the documentation for SendRawEmail.

    Do not include these X-headers in the DKIM signature, because they are removed by Amazon SES before sending the email.

    For more information, go to the Amazon SES Developer Guide.

    " + } + }, + "documentation":"

    Represents the raw data of the message.

    " + }, + "RawMessageData":{"type":"blob"}, + "ReceiptAction":{ + "type":"structure", + "members":{ + "S3Action":{ + "shape":"S3Action", + "documentation":"

    Saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon SNS.

    " + }, + "BounceAction":{ + "shape":"BounceAction", + "documentation":"

    Rejects the received email by returning a bounce response to the sender and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    " + }, + "WorkmailAction":{ + "shape":"WorkmailAction", + "documentation":"

    Calls Amazon WorkMail and, optionally, publishes a notification to Amazon Amazon SNS.

    " + }, + "LambdaAction":{ + "shape":"LambdaAction", + "documentation":"

    Calls an AWS Lambda function, and optionally, publishes a notification to Amazon SNS.

    " + }, + "StopAction":{ + "shape":"StopAction", + "documentation":"

    Terminates the evaluation of the receipt rule set and optionally publishes a notification to Amazon SNS.

    " + }, + "AddHeaderAction":{ + "shape":"AddHeaderAction", + "documentation":"

    Adds a header to the received email.

    " + }, + "SNSAction":{ + "shape":"SNSAction", + "documentation":"

    Publishes the email content within a notification to Amazon SNS.

    " + } + }, + "documentation":"

    An action that Amazon SES can take when it receives an email on behalf of one or more email addresses or domains that you own. An instance of this data type can represent only one action.

    For information about setting up receipt rules, see the Amazon SES Developer Guide.

    " + }, + "ReceiptActionsList":{ + "type":"list", + "member":{"shape":"ReceiptAction"} + }, + "ReceiptFilter":{ + "type":"structure", + "required":[ + "Name", + "IpFilter" + ], + "members":{ + "Name":{ + "shape":"ReceiptFilterName", + "documentation":"

    The name of the IP address filter. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain less than 64 characters.

    " + }, + "IpFilter":{ + "shape":"ReceiptIpFilter", + "documentation":"

    A structure that provides the IP addresses to block or allow, and whether to block or allow incoming mail from them.

    " + } + }, + "documentation":"

    A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

    For information about setting up IP address filters, see the Amazon SES Developer Guide.

    " + }, + "ReceiptFilterList":{ + "type":"list", + "member":{"shape":"ReceiptFilter"} + }, + "ReceiptFilterName":{"type":"string"}, + "ReceiptFilterPolicy":{ + "type":"string", + "enum":[ + "Block", + "Allow" + ] + }, + "ReceiptIpFilter":{ + "type":"structure", + "required":[ + "Policy", + "Cidr" + ], + "members":{ + "Policy":{ + "shape":"ReceiptFilterPolicy", + "documentation":"

    Indicates whether to block or allow incoming mail from the specified IP addresses.

    " + }, + "Cidr":{ + "shape":"Cidr", + "documentation":"

    A single IP address or a range of IP addresses that you want to block or allow, specified in Classless Inter-Domain Routing (CIDR) notation. An example of a single email address is 10.0.0.1. An example of a range of IP addresses is 10.0.0.1/24. For more information about CIDR notation, see RFC 2317.

    " + } + }, + "documentation":"

    A receipt IP address filter enables you to specify whether to accept or reject mail originating from an IP address or range of IP addresses.

    For information about setting up IP address filters, see the Amazon SES Developer Guide.

    " + }, + "ReceiptRule":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of the receipt rule. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain less than 64 characters.

    " + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

    If true, the receipt rule is active. The default value is false.

    " + }, + "TlsPolicy":{ + "shape":"TlsPolicy", + "documentation":"

    Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

    " + }, + "Recipients":{ + "shape":"RecipientsList", + "documentation":"

    The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

    " + }, + "Actions":{ + "shape":"ReceiptActionsList", + "documentation":"

    An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

    " + }, + "ScanEnabled":{ + "shape":"Enabled", + "documentation":"

    If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

    " + } + }, + "documentation":"

    Receipt rules enable you to specify which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

    Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

    For information about setting up receipt rules, see the Amazon SES Developer Guide.

    " + }, + "ReceiptRuleName":{"type":"string"}, + "ReceiptRuleNamesList":{ + "type":"list", + "member":{"shape":"ReceiptRuleName"} + }, + "ReceiptRuleSetMetadata":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set. The name must:

    • This value can only contain ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

    • Start and end with a letter or number.

    • Contain less than 64 characters.

    " + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The date and time the receipt rule set was created.

    " + } + }, + "documentation":"

    Information about a receipt rule set.

    A receipt rule set is a collection of rules that specify what Amazon SES should do with mail it receives on behalf of your account's verified domains.

    For information about setting up receipt rule sets, see the Amazon SES Developer Guide.

    " + }, + "ReceiptRuleSetName":{"type":"string"}, + "ReceiptRuleSetsLists":{ + "type":"list", + "member":{"shape":"ReceiptRuleSetMetadata"} + }, + "ReceiptRulesList":{ + "type":"list", + "member":{"shape":"ReceiptRule"} + }, + "Recipient":{"type":"string"}, + "RecipientDsnFields":{ + "type":"structure", + "required":[ + "Action", + "Status" + ], + "members":{ + "FinalRecipient":{ + "shape":"Address", + "documentation":"

    The email address that the message was ultimately delivered to. This corresponds to the Final-Recipient in the DSN. If not specified, FinalRecipient will be set to the Recipient specified in the BouncedRecipientInfo structure. Either FinalRecipient or the recipient in BouncedRecipientInfo must be a recipient of the original bounced message.

    Do not prepend the FinalRecipient email address with rfc 822;, as described in RFC 3798.

    " + }, + "Action":{ + "shape":"DsnAction", + "documentation":"

    The action performed by the reporting mail transfer agent (MTA) as a result of its attempt to deliver the message to the recipient address. This is required by RFC 3464.

    " + }, + "RemoteMta":{ + "shape":"RemoteMta", + "documentation":"

    The MTA to which the remote MTA attempted to deliver the message, formatted as specified in RFC 3464 (mta-name-type; mta-name). This parameter typically applies only to propagating synchronous bounces.

    " + }, + "Status":{ + "shape":"DsnStatus", + "documentation":"

    The status code that indicates what went wrong. This is required by RFC 3464.

    " + }, + "DiagnosticCode":{ + "shape":"DiagnosticCode", + "documentation":"

    An extended explanation of what went wrong; this is usually an SMTP response. See RFC 3463 for the correct formatting of this parameter.

    " + }, + "LastAttemptDate":{ + "shape":"LastAttemptDate", + "documentation":"

    The time the final delivery attempt was made, in RFC 822 date-time format.

    " + }, + "ExtensionFields":{ + "shape":"ExtensionFieldList", + "documentation":"

    Additional X-headers to include in the DSN.

    " + } + }, + "documentation":"

    Recipient-related information to include in the Delivery Status Notification (DSN) when an email that Amazon SES receives on your behalf bounces.

    For information about receiving email through Amazon SES, see the Amazon SES Developer Guide.

    " + }, + "RecipientsList":{ + "type":"list", + "member":{"shape":"Recipient"} + }, + "RemoteMta":{"type":"string"}, + "RenderedTemplate":{"type":"string"}, + "ReorderReceiptRuleSetRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "RuleNames" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set to reorder.

    " + }, + "RuleNames":{ + "shape":"ReceiptRuleNamesList", + "documentation":"

    A list of the specified receipt rule set's receipt rules in the order that you want to put them.

    " + } + }, + "documentation":"

    Represents a request to reorder the receipt rules within a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "ReorderReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "ReportingMta":{"type":"string"}, + "ReputationOptions":{ + "type":"structure", + "members":{ + "SendingEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether email sending is enabled or disabled for the configuration set. If the value is true, then Amazon SES will send emails that use the configuration set. If the value is false, Amazon SES will not send emails that use the configuration set. The default value is true. You can change this setting using UpdateConfigurationSetSendingEnabled.

    " + }, + "ReputationMetricsEnabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

    If the value is true, reputation metrics are published. If the value is false, reputation metrics are not published. The default value is false.

    " + }, + "LastFreshStart":{ + "shape":"LastFreshStart", + "documentation":"

    The date and time at which the reputation metrics for the configuration set were last reset. Resetting these metrics is known as a fresh start.

    When you disable email sending for a configuration set using UpdateConfigurationSetSendingEnabled and later re-enable it, the reputation metrics for the configuration set (but not for the entire Amazon SES account) are reset.

    If email sending for the configuration set has never been disabled and later re-enabled, the value of this attribute is null.

    " + } + }, + "documentation":"

    Contains information about the reputation settings for a configuration set.

    " + }, + "RuleDoesNotExistException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleOrRuleSetName", + "documentation":"

    Indicates that the named receipt rule does not exist.

    " + } + }, + "documentation":"

    Indicates that the provided receipt rule does not exist.

    ", + "error":{ + "code":"RuleDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "RuleOrRuleSetName":{"type":"string"}, + "RuleSetDoesNotExistException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"RuleOrRuleSetName", + "documentation":"

    Indicates that the named receipt rule set does not exist.

    " + } + }, + "documentation":"

    Indicates that the provided receipt rule set does not exist.

    ", + "error":{ + "code":"RuleSetDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "S3Action":{ + "type":"structure", + "required":["BucketName"], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the Amazon SNS topic to notify when the message is saved to the Amazon S3 bucket. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + }, + "BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The name of the Amazon S3 bucket that incoming email will be saved to.

    " + }, + "ObjectKeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The key prefix of the Amazon S3 bucket. The key prefix is similar to a directory name that enables you to store similar data under the same directory in a bucket.

    " + }, + "KmsKeyArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The customer master key that Amazon SES should use to encrypt your emails before saving them to the Amazon S3 bucket. You can use the default master key or a custom master key you created in AWS KMS as follows:

    • To use the default master key, provide an ARN in the form of arn:aws:kms:REGION:ACCOUNT-ID-WITHOUT-HYPHENS:alias/aws/ses. For example, if your AWS account ID is 123456789012 and you want to use the default master key in the US West (Oregon) region, the ARN of the default master key would be arn:aws:kms:us-west-2:123456789012:alias/aws/ses. If you use the default master key, you don't need to perform any extra steps to give Amazon SES permission to use the key.

    • To use a custom master key you created in AWS KMS, provide the ARN of the master key and ensure that you add a statement to your key's policy to give Amazon SES permission to use it. For more information about giving permissions, see the Amazon SES Developer Guide.

    For more information about key policies, see the AWS KMS Developer Guide. If you do not specify a master key, Amazon SES will not encrypt your emails.

    Your mail is encrypted by Amazon SES using the Amazon S3 encryption client before the mail is submitted to Amazon S3 for storage. It is not encrypted using Amazon S3 server-side encryption. This means that you must use the Amazon S3 encryption client to decrypt the email after retrieving it from Amazon S3, as the service has no access to use your AWS KMS keys for decryption. This encryption client is currently available with the AWS SDK for Java and AWS SDK for Ruby only. For more information about client-side encryption using AWS KMS master keys, see the Amazon S3 Developer Guide.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action saves the received message to an Amazon Simple Storage Service (Amazon S3) bucket and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    To enable Amazon SES to write emails to your Amazon S3 bucket, use an AWS KMS key to encrypt your emails, or publish to an Amazon SNS topic of another account, Amazon SES must have permission to access those resources. For information about giving permissions, see the Amazon SES Developer Guide.

    When you save your emails to an Amazon S3 bucket, the maximum email size (including headers) is 30 MB. Emails larger than that will bounce.

    For information about specifying Amazon S3 actions in receipt rules, see the Amazon SES Developer Guide.

    " + }, + "S3BucketName":{"type":"string"}, + "S3KeyPrefix":{"type":"string"}, + "SNSAction":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + }, + "Encoding":{ + "shape":"SNSActionEncoding", + "documentation":"

    The encoding to use for the email within the Amazon SNS notification. UTF-8 is easier to use, but may not preserve all special characters when a message was encoded with a different encoding format. Base64 preserves all special characters. The default value is UTF-8.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action publishes a notification to Amazon Simple Notification Service (Amazon SNS). This action includes a complete copy of the email content in the Amazon SNS notifications. Amazon SNS notifications for all other actions simply provide information about the email. They do not include the email content itself.

    If you own the Amazon SNS topic, you don't need to do anything to give Amazon SES permission to publish emails to it. However, if you don't own the Amazon SNS topic, you need to attach a policy to the topic to give Amazon SES permissions to access it. For information about giving permissions, see the Amazon SES Developer Guide.

    You can only publish emails that are 150 KB or less (including the header) to Amazon SNS. Larger emails will bounce. If you anticipate emails larger than 150 KB, use the S3 action instead.

    For information about using a receipt rule to publish an Amazon SNS notification, see the Amazon SES Developer Guide.

    " + }, + "SNSActionEncoding":{ + "type":"string", + "enum":[ + "UTF-8", + "Base64" + ] + }, + "SNSDestination":{ + "type":"structure", + "required":["TopicARN"], + "members":{ + "TopicARN":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the Amazon SNS topic that email sending events will be published to. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + } + }, + "documentation":"

    Contains the topic ARN associated with an Amazon Simple Notification Service (Amazon SNS) event destination.

    Event destinations, such as Amazon SNS, are associated with configuration sets, which enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "SendBounceRequest":{ + "type":"structure", + "required":[ + "OriginalMessageId", + "BounceSender", + "BouncedRecipientInfoList" + ], + "members":{ + "OriginalMessageId":{ + "shape":"MessageId", + "documentation":"

    The message ID of the message to be bounced.

    " + }, + "BounceSender":{ + "shape":"Address", + "documentation":"

    The address to use in the \"From\" header of the bounce message. This must be an identity that you have verified with Amazon SES.

    " + }, + "Explanation":{ + "shape":"Explanation", + "documentation":"

    Human-readable text for the bounce message to explain the failure. If not specified, the text will be auto-generated based on the bounced recipient information.

    " + }, + "MessageDsn":{ + "shape":"MessageDsn", + "documentation":"

    Message-related DSN fields. If not specified, Amazon SES will choose the values.

    " + }, + "BouncedRecipientInfoList":{ + "shape":"BouncedRecipientInfoList", + "documentation":"

    A list of recipients of the bounced message, including the information required to create the Delivery Status Notifications (DSNs) for the recipients. You must specify at least one BouncedRecipientInfo in the list.

    " + }, + "BounceSenderArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the address in the \"From\" header of the bounce. For more information about sending authorization, see the Amazon SES Developer Guide.

    " + } + }, + "documentation":"

    Represents a request to send a bounce message to the sender of an email you received through Amazon SES.

    " + }, + "SendBounceResponse":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The message ID of the bounce message.

    " + } + }, + "documentation":"

    Represents a unique message ID.

    " + }, + "SendBulkTemplatedEmailRequest":{ + "type":"structure", + "required":[ + "Source", + "Template", + "Destinations" + ], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

    " + }, + "SourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "ReplyToAddresses":{ + "shape":"AddressList", + "documentation":"

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

    " + }, + "ReturnPath":{ + "shape":"Address", + "documentation":"

    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

    " + }, + "ReturnPathArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to use when you send an email using SendBulkTemplatedEmail.

    " + }, + "DefaultTags":{ + "shape":"MessageTagList", + "documentation":"

    A list of tags, in the form of name/value pairs, to apply to an email that you send to a destination using SendBulkTemplatedEmail.

    " + }, + "Template":{ + "shape":"TemplateName", + "documentation":"

    The template to use when sending this email.

    " + }, + "TemplateArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the template to use when sending this email.

    " + }, + "DefaultTemplateData":{ + "shape":"TemplateData", + "documentation":"

    A list of replacement values to apply to the template when replacement data is not specified in a Destination object. These values act as a default or fallback option when no other data is available.

    The template data is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    " + }, + "Destinations":{ + "shape":"BulkEmailDestinationList", + "documentation":"

    One or more Destination objects. All of the recipients in a Destination will receive the same version of the email. You can specify up to 50 Destination objects within a Destinations array.

    " + } + }, + "documentation":"

    Represents a request to send a templated email to multiple destinations using Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SendBulkTemplatedEmailResponse":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"BulkEmailDestinationStatusList", + "documentation":"

    The unique message identifier returned from the SendBulkTemplatedEmail action.

    " + } + } + }, + "SendCustomVerificationEmailRequest":{ + "type":"structure", + "required":[ + "EmailAddress", + "TemplateName" + ], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

    The email address to verify.

    " + }, + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template to use when sending the verification email.

    " + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Name of a configuration set to use when sending the verification email.

    " + } + }, + "documentation":"

    Represents a request to send a custom verification email to a specified recipient.

    " + }, + "SendCustomVerificationEmailResponse":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The unique message identifier returned from the SendCustomVerificationEmail operation.

    " + } + }, + "documentation":"

    The response received when attempting to send the custom verification email.

    " + }, + "SendDataPoint":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    Time of the data point.

    " + }, + "DeliveryAttempts":{ + "shape":"Counter", + "documentation":"

    Number of emails that have been sent.

    " + }, + "Bounces":{ + "shape":"Counter", + "documentation":"

    Number of emails that have bounced.

    " + }, + "Complaints":{ + "shape":"Counter", + "documentation":"

    Number of unwanted emails that were rejected by recipients.

    " + }, + "Rejects":{ + "shape":"Counter", + "documentation":"

    Number of emails rejected by Amazon SES.

    " + } + }, + "documentation":"

    Represents sending statistics data. Each SendDataPoint contains statistics for a 15-minute period of sending activity.

    " + }, + "SendDataPointList":{ + "type":"list", + "member":{"shape":"SendDataPoint"} + }, + "SendEmailRequest":{ + "type":"structure", + "required":[ + "Source", + "Destination", + "Message" + ], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

    " + }, + "Destination":{ + "shape":"Destination", + "documentation":"

    The destination for this email, composed of To:, CC:, and BCC: fields.

    " + }, + "Message":{ + "shape":"Message", + "documentation":"

    The message to be sent.

    " + }, + "ReplyToAddresses":{ + "shape":"AddressList", + "documentation":"

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

    " + }, + "ReturnPath":{ + "shape":"Address", + "documentation":"

    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

    " + }, + "SourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "ReturnPathArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "Tags":{ + "shape":"MessageTagList", + "documentation":"

    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    " + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to use when you send an email using SendEmail.

    " + } + }, + "documentation":"

    Represents a request to send a single formatted email using Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SendEmailResponse":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The unique message identifier returned from the SendEmail action.

    " + } + }, + "documentation":"

    Represents a unique message ID.

    " + }, + "SendRawEmailRequest":{ + "type":"structure", + "required":["RawMessage"], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

    The identity's email address. If you do not provide a value for this parameter, you must specify a \"From\" address in the raw text of the message. (You can also specify both.)

    Amazon SES does not support the SMTPUTF8 extension, as described inRFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described in RFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

    If you specify the Source parameter and have feedback forwarding enabled, then bounces and complaints will be sent to this email address. This takes precedence over any Return-Path header that you might include in the raw text of the message.

    " + }, + "Destinations":{ + "shape":"AddressList", + "documentation":"

    A list of destinations for the message, consisting of To:, CC:, and BCC: addresses.

    " + }, + "RawMessage":{ + "shape":"RawMessage", + "documentation":"

    The raw email message itself. The message has to meet the following criteria:

    • The message has to contain a header and a body, separated by a blank line.

    • All of the required header fields must be present in the message.

    • Each part of a multipart MIME message must be formatted properly.

    • Attachments must be of a content type that Amazon SES supports. For a list on unsupported content types, see Unsupported Attachment Types in the Amazon SES Developer Guide.

    • The entire message must be base64-encoded.

    • If any of the MIME parts in your message contain content that is outside of the 7-bit ASCII character range, we highly recommend that you encode that content. For more information, see Sending Raw Email in the Amazon SES Developer Guide.

    • Per RFC 5321, the maximum length of each line of text, including the <CRLF>, must not exceed 1,000 characters.

    " + }, + "FromArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to specify a particular \"From\" address in the header of the raw email.

    Instead of using this parameter, you can use the X-header X-SES-FROM-ARN in the raw message of the email. If you use both the FromArn parameter and the corresponding X-header, Amazon SES uses the value of the FromArn parameter.

    For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    " + }, + "SourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

    Instead of using this parameter, you can use the X-header X-SES-SOURCE-ARN in the raw message of the email. If you use both the SourceArn parameter and the corresponding X-header, Amazon SES uses the value of the SourceArn parameter.

    For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    " + }, + "ReturnPathArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

    Instead of using this parameter, you can use the X-header X-SES-RETURN-PATH-ARN in the raw message of the email. If you use both the ReturnPathArn parameter and the corresponding X-header, Amazon SES uses the value of the ReturnPathArn parameter.

    For information about when to use this parameter, see the description of SendRawEmail in this guide, or see the Amazon SES Developer Guide.

    " + }, + "Tags":{ + "shape":"MessageTagList", + "documentation":"

    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendRawEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    " + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to use when you send an email using SendRawEmail.

    " + } + }, + "documentation":"

    Represents a request to send a single raw email using Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SendRawEmailResponse":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The unique message identifier returned from the SendRawEmail action.

    " + } + }, + "documentation":"

    Represents a unique message ID.

    " + }, + "SendTemplatedEmailRequest":{ + "type":"structure", + "required":[ + "Source", + "Destination", + "Template", + "TemplateData" + ], + "members":{ + "Source":{ + "shape":"Address", + "documentation":"

    The email address that is sending the email. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES. For information about verifying identities, see the Amazon SES Developer Guide.

    If you are sending on behalf of another user and have been permitted to do so by a sending authorization policy, then you must also specify the SourceArn parameter. For more information about sending authorization, see the Amazon SES Developer Guide.

    Amazon SES does not support the SMTPUTF8 extension, as described in RFC6531. For this reason, the local part of a source email address (the part of the email address that precedes the @ sign) may only contain 7-bit ASCII characters. If the domain part of an address (the part after the @ sign) contains non-ASCII characters, they must be encoded using Punycode, as described in RFC3492. The sender name (also known as the friendly name) may contain non-ASCII characters. These characters must be encoded using MIME encoded-word syntax, as described inRFC 2047. MIME encoded-word syntax uses the following form: =?charset?encoding?encoded-text?=.

    " + }, + "Destination":{ + "shape":"Destination", + "documentation":"

    The destination for this email, composed of To:, CC:, and BCC: fields. A Destination can include up to 50 recipients across these three fields.

    " + }, + "ReplyToAddresses":{ + "shape":"AddressList", + "documentation":"

    The reply-to email address(es) for the message. If the recipient replies to the message, each reply-to address will receive the reply.

    " + }, + "ReturnPath":{ + "shape":"Address", + "documentation":"

    The email address that bounces and complaints will be forwarded to when feedback forwarding is enabled. If the message cannot be delivered to the recipient, then an error message will be returned from the recipient's ISP; this message will then be forwarded to the email address specified by the ReturnPath parameter. The ReturnPath parameter is never overwritten. This email address must be either individually verified with Amazon SES, or from a domain that has been verified with Amazon SES.

    " + }, + "SourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to send for the email address specified in the Source parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to send from user@example.com, then you would specify the SourceArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the Source to be user@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "ReturnPathArn":{ + "shape":"AmazonResourceName", + "documentation":"

    This parameter is used only for sending authorization. It is the ARN of the identity that is associated with the sending authorization policy that permits you to use the email address specified in the ReturnPath parameter.

    For example, if the owner of example.com (which has ARN arn:aws:ses:us-east-1:123456789012:identity/example.com) attaches a policy to it that authorizes you to use feedback@example.com, then you would specify the ReturnPathArn to be arn:aws:ses:us-east-1:123456789012:identity/example.com, and the ReturnPath to be feedback@example.com.

    For more information about sending authorization, see the Amazon SES Developer Guide.

    " + }, + "Tags":{ + "shape":"MessageTagList", + "documentation":"

    A list of tags, in the form of name/value pairs, to apply to an email that you send using SendTemplatedEmail. Tags correspond to characteristics of the email that you define, so that you can publish email sending events.

    " + }, + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set to use when you send an email using SendTemplatedEmail.

    " + }, + "Template":{ + "shape":"TemplateName", + "documentation":"

    The template to use when sending this email.

    " + }, + "TemplateArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the template to use when sending this email.

    " + }, + "TemplateData":{ + "shape":"TemplateData", + "documentation":"

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    " + } + }, + "documentation":"

    Represents a request to send a templated email using Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SendTemplatedEmailResponse":{ + "type":"structure", + "required":["MessageId"], + "members":{ + "MessageId":{ + "shape":"MessageId", + "documentation":"

    The unique message identifier returned from the SendTemplatedEmail action.

    " + } + } + }, + "SentLast24Hours":{"type":"double"}, + "SetActiveReceiptRuleSetRequest":{ + "type":"structure", + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set to make active. Setting this value to null disables all email receiving.

    " + } + }, + "documentation":"

    Represents a request to set a receipt rule set as the active receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SetActiveReceiptRuleSetResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetIdentityDkimEnabledRequest":{ + "type":"structure", + "required":[ + "Identity", + "DkimEnabled" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity for which DKIM signing should be enabled or disabled.

    " + }, + "DkimEnabled":{ + "shape":"Enabled", + "documentation":"

    Sets whether DKIM signing is enabled for an identity. Set to true to enable DKIM signing for this identity; false to disable it.

    " + } + }, + "documentation":"

    Represents a request to enable or disable Amazon SES Easy DKIM signing for an identity. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityDkimEnabledResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetIdentityFeedbackForwardingEnabledRequest":{ + "type":"structure", + "required":[ + "Identity", + "ForwardingEnabled" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity for which to set bounce and complaint notification forwarding. Examples: user@example.com, example.com.

    " + }, + "ForwardingEnabled":{ + "shape":"Enabled", + "documentation":"

    Sets whether Amazon SES will forward bounce and complaint notifications as email. true specifies that Amazon SES will forward bounce and complaint notifications as email, in addition to any Amazon SNS topic publishing otherwise specified. false specifies that Amazon SES will publish bounce and complaint notifications only through Amazon SNS. This value can only be set to false when Amazon SNS topics are set for both Bounce and Complaint notification types.

    " + } + }, + "documentation":"

    Represents a request to enable or disable whether Amazon SES forwards you bounce and complaint notifications through email. For information about email feedback forwarding, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityFeedbackForwardingEnabledResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetIdentityHeadersInNotificationsEnabledRequest":{ + "type":"structure", + "required":[ + "Identity", + "NotificationType", + "Enabled" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity for which to enable or disable headers in notifications. Examples: user@example.com, example.com.

    " + }, + "NotificationType":{ + "shape":"NotificationType", + "documentation":"

    The notification type for which to enable or disable headers in notifications.

    " + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Sets whether Amazon SES includes the original email headers in Amazon SNS notifications of the specified notification type. A value of true specifies that Amazon SES will include headers in notifications, and a value of false specifies that Amazon SES will not include headers in notifications.

    This value can only be set when NotificationType is already set to use a particular Amazon SNS topic.

    " + } + }, + "documentation":"

    Represents a request to set whether Amazon SES includes the original email headers in the Amazon SNS notifications of a specified type. For information about notifications, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityHeadersInNotificationsEnabledResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetIdentityMailFromDomainRequest":{ + "type":"structure", + "required":["Identity"], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The verified identity for which you want to enable or disable the specified custom MAIL FROM domain.

    " + }, + "MailFromDomain":{ + "shape":"MailFromDomainName", + "documentation":"

    The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must 1) be a subdomain of the verified identity, 2) not be used in a \"From\" address if the MAIL FROM domain is the destination of email feedback forwarding (for more information, see the Amazon SES Developer Guide), and 3) not be used to receive emails. A value of null disables the custom MAIL FROM setting for the identity.

    " + }, + "BehaviorOnMXFailure":{ + "shape":"BehaviorOnMXFailure", + "documentation":"

    The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. If you choose UseDefaultValue, Amazon SES will use amazonses.com (or a subdomain of that) as the MAIL FROM domain. If you choose RejectMessage, Amazon SES will return a MailFromDomainNotVerified error and not send the email.

    The action specified in BehaviorOnMXFailure is taken when the custom MAIL FROM domain setup is in the Pending, Failed, and TemporaryFailure states.

    " + } + }, + "documentation":"

    Represents a request to enable or disable the Amazon SES custom MAIL FROM domain setup for a verified identity. For information about using a custom MAIL FROM domain, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityMailFromDomainResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetIdentityNotificationTopicRequest":{ + "type":"structure", + "required":[ + "Identity", + "NotificationType" + ], + "members":{ + "Identity":{ + "shape":"Identity", + "documentation":"

    The identity (email address or domain) that you want to set the Amazon SNS topic for.

    You can only specify a verified identity for this parameter.

    You can specify an identity by using its name or by using its Amazon Resource Name (ARN). The following examples are all valid identities: sender@example.com, example.com, arn:aws:ses:us-east-1:123456789012:identity/example.com.

    " + }, + "NotificationType":{ + "shape":"NotificationType", + "documentation":"

    The type of notifications that will be published to the specified Amazon SNS topic.

    " + }, + "SnsTopic":{ + "shape":"NotificationTopic", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic. If the parameter is omitted from the request or a null value is passed, SnsTopic is cleared and publishing is disabled.

    " + } + }, + "documentation":"

    Represents a request to specify the Amazon SNS topic to which Amazon SES will publish bounce, complaint, or delivery notifications for emails sent with that identity as the Source. For information about Amazon SES notifications, see the Amazon SES Developer Guide.

    " + }, + "SetIdentityNotificationTopicResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "SetReceiptRulePositionRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "RuleName" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set that contains the receipt rule to reposition.

    " + }, + "RuleName":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of the receipt rule to reposition.

    " + }, + "After":{ + "shape":"ReceiptRuleName", + "documentation":"

    The name of the receipt rule after which to place the specified receipt rule.

    " + } + }, + "documentation":"

    Represents a request to set the position of a receipt rule in a receipt rule set. You use receipt rule sets to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "SetReceiptRulePositionResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "StopAction":{ + "type":"structure", + "required":["Scope"], + "members":{ + "Scope":{ + "shape":"StopScope", + "documentation":"

    The scope of the StopAction. The only acceptable value is RuleSet.

    " + }, + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the stop action is taken. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action terminates the evaluation of the receipt rule set and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS).

    For information about setting a stop action in a receipt rule, see the Amazon SES Developer Guide.

    " + }, + "StopScope":{ + "type":"string", + "enum":["RuleSet"] + }, + "Subject":{"type":"string"}, + "SubjectPart":{"type":"string"}, + "SuccessRedirectionURL":{"type":"string"}, + "Template":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the template. You will refer to this name when you send email using the SendTemplatedEmail or SendBulkTemplatedEmail operations.

    " + }, + "SubjectPart":{ + "shape":"SubjectPart", + "documentation":"

    The subject line of the email.

    " + }, + "TextPart":{ + "shape":"TextPart", + "documentation":"

    The email body that will be visible to recipients whose email clients do not display HTML.

    " + }, + "HtmlPart":{ + "shape":"HtmlPart", + "documentation":"

    The HTML body of the email.

    " + } + }, + "documentation":"

    The content of the email, composed of a subject line, an HTML part, and a text-only part.

    " + }, + "TemplateContent":{"type":"string"}, + "TemplateData":{ + "type":"string", + "max":262144 + }, + "TemplateDoesNotExistException":{ + "type":"structure", + "members":{ + "TemplateName":{"shape":"TemplateName"} + }, + "documentation":"

    Indicates that the Template object you specified does not exist in your Amazon SES account.

    ", + "error":{ + "code":"TemplateDoesNotExist", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TemplateMetadata":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"TemplateName", + "documentation":"

    The name of the template.

    " + }, + "CreatedTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The time and date the template was created.

    " + } + }, + "documentation":"

    Contains information about an email template.

    " + }, + "TemplateMetadataList":{ + "type":"list", + "member":{"shape":"TemplateMetadata"} + }, + "TemplateName":{"type":"string"}, + "TestRenderTemplateRequest":{ + "type":"structure", + "required":[ + "TemplateName", + "TemplateData" + ], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the template that you want to render.

    " + }, + "TemplateData":{ + "shape":"TemplateData", + "documentation":"

    A list of replacement values to apply to the template. This parameter is a JSON object, typically consisting of key-value pairs in which the keys correspond to replacement tags in the email template.

    " + } + } + }, + "TestRenderTemplateResponse":{ + "type":"structure", + "members":{ + "RenderedTemplate":{ + "shape":"RenderedTemplate", + "documentation":"

    The complete MIME message rendered by applying the data in the TemplateData parameter to the template specified in the TemplateName parameter.

    " + } + } + }, + "TextPart":{"type":"string"}, + "Timestamp":{"type":"timestamp"}, + "TlsPolicy":{ + "type":"string", + "enum":[ + "Require", + "Optional" + ] + }, + "TrackingOptions":{ + "type":"structure", + "members":{ + "CustomRedirectDomain":{ + "shape":"CustomRedirectDomain", + "documentation":"

    The custom subdomain that will be used to redirect email recipients to the Amazon SES event tracking domain.

    " + } + }, + "documentation":"

    A domain that is used to redirect email recipients to an Amazon SES-operated domain. This domain captures open and click events generated by Amazon SES emails.

    For more information, see Configuring Custom Domains to Handle Open and Click Tracking in the Amazon SES Developer Guide.

    " + }, + "TrackingOptionsAlreadyExistsException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that a TrackingOptions object already exists in the specified configuration set.

    " + } + }, + "documentation":"

    Indicates that the configuration set you specified already contains a TrackingOptions object.

    ", + "error":{ + "code":"TrackingOptionsAlreadyExistsException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TrackingOptionsDoesNotExistException":{ + "type":"structure", + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    Indicates that a TrackingOptions object does not exist in the specified configuration set.

    " + } + }, + "documentation":"

    Indicates that the TrackingOptions object you specified does not exist.

    ", + "error":{ + "code":"TrackingOptionsDoesNotExistException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UpdateAccountSendingEnabledRequest":{ + "type":"structure", + "members":{ + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether email sending is enabled or disabled for your Amazon SES account in the current AWS Region.

    " + } + }, + "documentation":"

    Represents a request to enable or disable the email sending capabilities for your entire Amazon SES account.

    " + }, + "UpdateConfigurationSetEventDestinationRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "EventDestination" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that contains the event destination that you want to update.

    " + }, + "EventDestination":{ + "shape":"EventDestination", + "documentation":"

    The event destination object that you want to apply to the specified configuration set.

    " + } + }, + "documentation":"

    Represents a request to update the event destination of a configuration set. Configuration sets enable you to publish email sending events. For information about using configuration sets, see the Amazon SES Developer Guide.

    " + }, + "UpdateConfigurationSetEventDestinationResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "UpdateConfigurationSetReputationMetricsEnabledRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "Enabled" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that you want to update.

    " + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether or not Amazon SES will publish reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch.

    " + } + }, + "documentation":"

    Represents a request to modify the reputation metric publishing settings for a configuration set.

    " + }, + "UpdateConfigurationSetSendingEnabledRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "Enabled" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set that you want to update.

    " + }, + "Enabled":{ + "shape":"Enabled", + "documentation":"

    Describes whether email sending is enabled or disabled for the configuration set.

    " + } + }, + "documentation":"

    Represents a request to enable or disable the email sending capabilities for a specific configuration set.

    " + }, + "UpdateConfigurationSetTrackingOptionsRequest":{ + "type":"structure", + "required":[ + "ConfigurationSetName", + "TrackingOptions" + ], + "members":{ + "ConfigurationSetName":{ + "shape":"ConfigurationSetName", + "documentation":"

    The name of the configuration set for which you want to update the custom tracking domain.

    " + }, + "TrackingOptions":{"shape":"TrackingOptions"} + }, + "documentation":"

    Represents a request to update the tracking options for a configuration set.

    " + }, + "UpdateConfigurationSetTrackingOptionsResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "UpdateCustomVerificationEmailTemplateRequest":{ + "type":"structure", + "required":["TemplateName"], + "members":{ + "TemplateName":{ + "shape":"TemplateName", + "documentation":"

    The name of the custom verification email template that you want to update.

    " + }, + "FromEmailAddress":{ + "shape":"FromAddress", + "documentation":"

    The email address that the custom verification email is sent from.

    " + }, + "TemplateSubject":{ + "shape":"Subject", + "documentation":"

    The subject line of the custom verification email.

    " + }, + "TemplateContent":{ + "shape":"TemplateContent", + "documentation":"

    The content of the custom verification email. The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations. For more information, see Custom Verification Email Frequently Asked Questions in the Amazon SES Developer Guide.

    " + }, + "SuccessRedirectionURL":{ + "shape":"SuccessRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

    " + }, + "FailureRedirectionURL":{ + "shape":"FailureRedirectionURL", + "documentation":"

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

    " + } + }, + "documentation":"

    Represents a request to update an existing custom verification email template.

    " + }, + "UpdateReceiptRuleRequest":{ + "type":"structure", + "required":[ + "RuleSetName", + "Rule" + ], + "members":{ + "RuleSetName":{ + "shape":"ReceiptRuleSetName", + "documentation":"

    The name of the receipt rule set that the receipt rule belongs to.

    " + }, + "Rule":{ + "shape":"ReceiptRule", + "documentation":"

    A data structure that contains the updated receipt rule information.

    " + } + }, + "documentation":"

    Represents a request to update a receipt rule. You use receipt rules to receive email with Amazon SES. For more information, see the Amazon SES Developer Guide.

    " + }, + "UpdateReceiptRuleResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "UpdateTemplateRequest":{ + "type":"structure", + "required":["Template"], + "members":{ + "Template":{"shape":"Template"} + } + }, + "UpdateTemplateResponse":{ + "type":"structure", + "members":{ + } + }, + "VerificationAttributes":{ + "type":"map", + "key":{"shape":"Identity"}, + "value":{"shape":"IdentityVerificationAttributes"} + }, + "VerificationStatus":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failed", + "TemporaryFailure", + "NotStarted" + ] + }, + "VerificationToken":{"type":"string"}, + "VerificationTokenList":{ + "type":"list", + "member":{"shape":"VerificationToken"} + }, + "VerifyDomainDkimRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"Domain", + "documentation":"

    The name of the domain to be verified for Easy DKIM signing.

    " + } + }, + "documentation":"

    Represents a request to generate the CNAME records needed to set up Easy DKIM with Amazon SES. For more information about setting up Easy DKIM, see the Amazon SES Developer Guide.

    " + }, + "VerifyDomainDkimResponse":{ + "type":"structure", + "required":["DkimTokens"], + "members":{ + "DkimTokens":{ + "shape":"VerificationTokenList", + "documentation":"

    A set of character strings that represent the domain's identity. If the identity is an email address, the tokens represent the domain of that address.

    Using these tokens, you need to create DNS CNAME records that point to DKIM public keys that are hosted by Amazon SES. Amazon Web Services eventually detects that you've updated your DNS records. This detection process might take up to 72 hours. After successful detection, Amazon SES is able to DKIM-sign email originating from that domain. (This only applies to domain identities, not email address identities.)

    For more information about creating DNS records using DKIM tokens, see the Amazon SES Developer Guide.

    " + } + }, + "documentation":"

    Returns CNAME records that you must publish to the DNS server of your domain to set up Easy DKIM with Amazon SES.

    " + }, + "VerifyDomainIdentityRequest":{ + "type":"structure", + "required":["Domain"], + "members":{ + "Domain":{ + "shape":"Domain", + "documentation":"

    The domain to be verified.

    " + } + }, + "documentation":"

    Represents a request to begin Amazon SES domain verification and to generate the TXT records that you must publish to the DNS server of your domain to complete the verification. For information about domain verification, see the Amazon SES Developer Guide.

    " + }, + "VerifyDomainIdentityResponse":{ + "type":"structure", + "required":["VerificationToken"], + "members":{ + "VerificationToken":{ + "shape":"VerificationToken", + "documentation":"

    A TXT record that you must place in the DNS settings of the domain to complete domain verification with Amazon SES.

    As Amazon SES searches for the TXT record, the domain's verification status is \"Pending\". When Amazon SES detects the record, the domain's verification status changes to \"Success\". If Amazon SES is unable to detect the record within 72 hours, the domain's verification status changes to \"Failed.\" In that case, if you still want to verify the domain, you must restart the verification process from the beginning.

    " + } + }, + "documentation":"

    Returns a TXT record that you must publish to the DNS server of your domain to complete domain verification with Amazon SES.

    " + }, + "VerifyEmailAddressRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

    The email address to be verified.

    " + } + }, + "documentation":"

    Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

    " + }, + "VerifyEmailIdentityRequest":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"Address", + "documentation":"

    The email address to be verified.

    " + } + }, + "documentation":"

    Represents a request to begin email address verification with Amazon SES. For information about email address verification, see the Amazon SES Developer Guide.

    " + }, + "VerifyEmailIdentityResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An empty element returned on a successful request.

    " + }, + "WorkmailAction":{ + "type":"structure", + "required":["OrganizationArn"], + "members":{ + "TopicArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon SNS topic to notify when the WorkMail action is called. An example of an Amazon SNS topic ARN is arn:aws:sns:us-west-2:123456789012:MyTopic. For more information about Amazon SNS topics, see the Amazon SNS Developer Guide.

    " + }, + "OrganizationArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the Amazon WorkMail organization. An example of an Amazon WorkMail organization ARN is arn:aws:workmail:us-west-2:123456789012:organization/m-68755160c4cb4e29a2b2f8fb58f359d7. For information about Amazon WorkMail organizations, see the Amazon WorkMail Administrator Guide.

    " + } + }, + "documentation":"

    When included in a receipt rule, this action calls Amazon WorkMail and, optionally, publishes a notification to Amazon Simple Notification Service (Amazon SNS). You will typically not use this action directly because Amazon WorkMail adds the rule automatically during its setup procedure.

    For information using a receipt rule to call Amazon WorkMail, see the Amazon SES Developer Guide.

    " + } + }, + "documentation":"Amazon Simple Email Service

    This document contains reference information for the Amazon Simple Email Service (Amazon SES) API, version 2010-12-01. This document is best used in conjunction with the Amazon SES Developer Guide.

    For a list of Amazon SES endpoints to use in service requests, see Regions and Amazon SES in the Amazon SES Developer Guide.

    " +} diff --git a/aws/dist/botocore/data/ses/2010-12-01/waiters-2.json b/aws/dist/botocore/data/ses/2010-12-01/waiters-2.json new file mode 100644 index 00000000..b585d309 --- /dev/null +++ b/aws/dist/botocore/data/ses/2010-12-01/waiters-2.json @@ -0,0 +1,18 @@ +{ + "version": 2, + "waiters": { + "IdentityExists": { + "delay": 3, + "operation": "GetIdentityVerificationAttributes", + "maxAttempts": 20, + "acceptors": [ + { + "expected": "Success", + "matcher": "pathAll", + "state": "success", + "argument": "VerificationAttributes.*.VerificationStatus" + } + ] + } + } +} diff --git a/aws/dist/botocore/data/shield/2016-06-02/examples-1.json b/aws/dist/botocore/data/shield/2016-06-02/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/shield/2016-06-02/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/shield/2016-06-02/paginators-1.json b/aws/dist/botocore/data/shield/2016-06-02/paginators-1.json new file mode 100644 index 00000000..c5ded642 --- /dev/null +++ b/aws/dist/botocore/data/shield/2016-06-02/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListProtections": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Protections" + }, + "ListAttacks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AttackSummaries" + } + } +} diff --git a/aws/dist/botocore/data/shield/2016-06-02/service-2.json b/aws/dist/botocore/data/shield/2016-06-02/service-2.json new file mode 100644 index 00000000..711c053e --- /dev/null +++ b/aws/dist/botocore/data/shield/2016-06-02/service-2.json @@ -0,0 +1,1170 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-06-02", + "endpointPrefix":"shield", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWS Shield", + "serviceFullName":"AWS Shield", + "serviceId":"Shield", + "signatureVersion":"v4", + "targetPrefix":"AWSShield_20160616", + "uid":"shield-2016-06-02" + }, + "operations":{ + "AssociateDRTLogBucket":{ + "name":"AssociateDRTLogBucket", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDRTLogBucketRequest"}, + "output":{"shape":"AssociateDRTLogBucketResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidOperationException"}, + {"shape":"NoAssociatedRoleException"}, + {"shape":"LimitsExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedForDependencyException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

    To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

    " + }, + "AssociateDRTRole":{ + "name":"AssociateDRTRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDRTRoleRequest"}, + "output":{"shape":"AssociateDRTRoleResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedForDependencyException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

    You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

    Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.

    The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

    You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

    To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

    " + }, + "CreateProtection":{ + "name":"CreateProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateProtectionRequest"}, + "output":{"shape":"CreateProtectionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidResourceException"}, + {"shape":"InvalidOperationException"}, + {"shape":"LimitsExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

    You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.

    " + }, + "CreateSubscription":{ + "name":"CreateSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSubscriptionRequest"}, + "output":{"shape":"CreateSubscriptionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceAlreadyExistsException"} + ], + "documentation":"

    Activates AWS Shield Advanced for an account.

    As part of this request you can specify EmergencySettings that automaticaly grant the DDoS response team (DRT) needed permissions to assist you during a suspected DDoS attack. For more information see Authorize the DDoS Response Team to Create Rules and Web ACLs on Your Behalf.

    To use the services of the DRT, you must be subscribed to the Business Support plan or the Enterprise Support plan.

    When you initally create a subscription, your subscription is set to be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request.

    " + }, + "DeleteProtection":{ + "name":"DeleteProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteProtectionRequest"}, + "output":{"shape":"DeleteProtectionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OptimisticLockException"} + ], + "documentation":"

    Deletes an AWS Shield Advanced Protection.

    " + }, + "DeleteSubscription":{ + "name":"DeleteSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSubscriptionRequest"}, + "output":{"shape":"DeleteSubscriptionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"LockedSubscriptionException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

    ", + "deprecated":true + }, + "DescribeAttack":{ + "name":"DescribeAttack", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAttackRequest"}, + "output":{"shape":"DescribeAttackResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Describes the details of a DDoS attack.

    " + }, + "DescribeDRTAccess":{ + "name":"DescribeDRTAccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDRTAccessRequest"}, + "output":{"shape":"DescribeDRTAccessResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.

    " + }, + "DescribeEmergencyContactSettings":{ + "name":"DescribeEmergencyContactSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEmergencyContactSettingsRequest"}, + "output":{"shape":"DescribeEmergencyContactSettingsResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the email addresses that the DRT can use to contact you during a suspected attack.

    " + }, + "DescribeProtection":{ + "name":"DescribeProtection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeProtectionRequest"}, + "output":{"shape":"DescribeProtectionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the details of a Protection object.

    " + }, + "DescribeSubscription":{ + "name":"DescribeSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSubscriptionRequest"}, + "output":{"shape":"DescribeSubscriptionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Provides details about the AWS Shield Advanced subscription for an account.

    " + }, + "DisassociateDRTLogBucket":{ + "name":"DisassociateDRTLogBucket", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDRTLogBucketRequest"}, + "output":{"shape":"DisassociateDRTLogBucketResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidOperationException"}, + {"shape":"NoAssociatedRoleException"}, + {"shape":"AccessDeniedForDependencyException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

    To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

    " + }, + "DisassociateDRTRole":{ + "name":"DisassociateDRTRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDRTRoleRequest"}, + "output":{"shape":"DisassociateDRTRoleResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidOperationException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Removes the DDoS Response team's (DRT) access to your AWS account.

    To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

    " + }, + "GetSubscriptionState":{ + "name":"GetSubscriptionState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSubscriptionStateRequest"}, + "output":{"shape":"GetSubscriptionStateResponse"}, + "errors":[ + {"shape":"InternalErrorException"} + ], + "documentation":"

    Returns the SubscriptionState, either Active or Inactive.

    " + }, + "ListAttacks":{ + "name":"ListAttacks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAttacksRequest"}, + "output":{"shape":"ListAttacksResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidOperationException"} + ], + "documentation":"

    Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

    " + }, + "ListProtections":{ + "name":"ListProtections", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListProtectionsRequest"}, + "output":{"shape":"ListProtectionsResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidPaginationTokenException"} + ], + "documentation":"

    Lists all Protection objects for the account.

    " + }, + "UpdateEmergencyContactSettings":{ + "name":"UpdateEmergencyContactSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateEmergencyContactSettingsRequest"}, + "output":{"shape":"UpdateEmergencyContactSettingsResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OptimisticLockException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.

    " + }, + "UpdateSubscription":{ + "name":"UpdateSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSubscriptionRequest"}, + "output":{"shape":"UpdateSubscriptionResponse"}, + "errors":[ + {"shape":"InternalErrorException"}, + {"shape":"LockedSubscriptionException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OptimisticLockException"} + ], + "documentation":"

    Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

    " + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates the specified AttackId does not exist, or the requester does not have the appropriate permissions to access the AttackId.

    ", + "exception":true + }, + "AccessDeniedForDependencyException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    In order to grant the necessary access to the DDoS Response Team, the user submitting AssociateDRTRole must have the iam:PassRole permission. This error indicates the user did not have the appropriate permissions. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

    ", + "exception":true + }, + "AssociateDRTLogBucketRequest":{ + "type":"structure", + "required":["LogBucket"], + "members":{ + "LogBucket":{ + "shape":"LogBucket", + "documentation":"

    The Amazon S3 bucket that contains your AWS WAF logs.

    " + } + } + }, + "AssociateDRTLogBucketResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateDRTRoleRequest":{ + "type":"structure", + "required":["RoleArn"], + "members":{ + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.

    Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.

    " + } + } + }, + "AssociateDRTRoleResponse":{ + "type":"structure", + "members":{ + } + }, + "AttackDetail":{ + "type":"structure", + "members":{ + "AttackId":{ + "shape":"AttackId", + "documentation":"

    The unique identifier (ID) of the attack.

    " + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the resource that was attacked.

    " + }, + "SubResources":{ + "shape":"SubResourceSummaryList", + "documentation":"

    If applicable, additional detail about the resource being attacked, for example, IP address or URL.

    " + }, + "StartTime":{ + "shape":"AttackTimestamp", + "documentation":"

    The time the attack started, in Unix time in seconds. For more information see timestamp.

    " + }, + "EndTime":{ + "shape":"AttackTimestamp", + "documentation":"

    The time the attack ended, in Unix time in seconds. For more information see timestamp.

    " + }, + "AttackCounters":{ + "shape":"SummarizedCounterList", + "documentation":"

    List of counters that describe the attack for the specified time period.

    " + }, + "AttackProperties":{ + "shape":"AttackProperties", + "documentation":"

    The array of AttackProperty objects.

    " + }, + "Mitigations":{ + "shape":"MitigationList", + "documentation":"

    List of mitigation actions taken for the attack.

    " + } + }, + "documentation":"

    The details of a DDoS attack.

    " + }, + "AttackId":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[a-zA-Z0-9\\\\-]*" + }, + "AttackLayer":{ + "type":"string", + "enum":[ + "NETWORK", + "APPLICATION" + ] + }, + "AttackProperties":{ + "type":"list", + "member":{"shape":"AttackProperty"} + }, + "AttackProperty":{ + "type":"structure", + "members":{ + "AttackLayer":{ + "shape":"AttackLayer", + "documentation":"

    The type of distributed denial of service (DDoS) event that was observed. NETWORK indicates layer 3 and layer 4 events and APPLICATION indicates layer 7 events.

    " + }, + "AttackPropertyIdentifier":{ + "shape":"AttackPropertyIdentifier", + "documentation":"

    Defines the DDoS attack property information that is provided. The WORDPRESS_PINGBACK_REFLECTOR and WORDPRESS_PINGBACK_SOURCE values are valid only for WordPress reflective pingback DDoS attacks.

    " + }, + "TopContributors":{ + "shape":"TopContributors", + "documentation":"

    The array of Contributor objects that includes the top five contributors to an attack.

    " + }, + "Unit":{ + "shape":"Unit", + "documentation":"

    The unit of the Value of the contributions.

    " + }, + "Total":{ + "shape":"Long", + "documentation":"

    The total contributions made to this attack by all contributors, not just the five listed in the TopContributors list.

    " + } + }, + "documentation":"

    Details of the described attack.

    " + }, + "AttackPropertyIdentifier":{ + "type":"string", + "enum":[ + "DESTINATION_URL", + "REFERRER", + "SOURCE_ASN", + "SOURCE_COUNTRY", + "SOURCE_IP_ADDRESS", + "SOURCE_USER_AGENT", + "WORDPRESS_PINGBACK_REFLECTOR", + "WORDPRESS_PINGBACK_SOURCE" + ] + }, + "AttackSummaries":{ + "type":"list", + "member":{"shape":"AttackSummary"} + }, + "AttackSummary":{ + "type":"structure", + "members":{ + "AttackId":{ + "shape":"String", + "documentation":"

    The unique identifier (ID) of the attack.

    " + }, + "ResourceArn":{ + "shape":"String", + "documentation":"

    The ARN (Amazon Resource Name) of the resource that was attacked.

    " + }, + "StartTime":{ + "shape":"AttackTimestamp", + "documentation":"

    The start time of the attack, in Unix time in seconds. For more information see timestamp.

    " + }, + "EndTime":{ + "shape":"AttackTimestamp", + "documentation":"

    The end time of the attack, in Unix time in seconds. For more information see timestamp.

    " + }, + "AttackVectors":{ + "shape":"AttackVectorDescriptionList", + "documentation":"

    The list of attacks for a specified time period.

    " + } + }, + "documentation":"

    Summarizes all DDoS attacks for a specified time period.

    " + }, + "AttackTimestamp":{"type":"timestamp"}, + "AttackVectorDescription":{ + "type":"structure", + "required":["VectorType"], + "members":{ + "VectorType":{ + "shape":"String", + "documentation":"

    The attack type. Valid values:

    • UDP_TRAFFIC

    • UDP_FRAGMENT

    • GENERIC_UDP_REFLECTION

    • DNS_REFLECTION

    • NTP_REFLECTION

    • CHARGEN_REFLECTION

    • SSDP_REFLECTION

    • PORT_MAPPER

    • RIP_REFLECTION

    • SNMP_REFLECTION

    • MSSQL_REFLECTION

    • NET_BIOS_REFLECTION

    • SYN_FLOOD

    • ACK_FLOOD

    • REQUEST_FLOOD

    • HTTP_REFLECTION

    • UDS_REFLECTION

    • MEMCACHED_REFLECTION

    " + } + }, + "documentation":"

    Describes the attack.

    " + }, + "AttackVectorDescriptionList":{ + "type":"list", + "member":{"shape":"AttackVectorDescription"} + }, + "AutoRenew":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "Contributor":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the contributor. This is dependent on the AttackPropertyIdentifier. For example, if the AttackPropertyIdentifier is SOURCE_COUNTRY, the Name could be United States.

    " + }, + "Value":{ + "shape":"Long", + "documentation":"

    The contribution of this contributor expressed in Protection units. For example 10,000.

    " + } + }, + "documentation":"

    A contributor to the attack and their contribution.

    " + }, + "CreateProtectionRequest":{ + "type":"structure", + "required":[ + "Name", + "ResourceArn" + ], + "members":{ + "Name":{ + "shape":"ProtectionName", + "documentation":"

    Friendly name for the Protection you are creating.

    " + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the resource to be protected.

    The ARN should be in one of the following formats:

    • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

    • For an Elastic Load Balancer (Classic Load Balancer): arn:aws:elasticloadbalancing:region:account-id:loadbalancer/load-balancer-name

    • For an AWS CloudFront distribution: arn:aws:cloudfront::account-id:distribution/distribution-id

    • For an AWS Global Accelerator accelerator: arn:aws:globalaccelerator::account-id:accelerator/accelerator-id

    • For Amazon Route 53: arn:aws:route53:::hostedzone/hosted-zone-id

    • For an Elastic IP address: arn:aws:ec2:region:account-id:eip-allocation/allocation-id

    " + } + } + }, + "CreateProtectionResponse":{ + "type":"structure", + "members":{ + "ProtectionId":{ + "shape":"ProtectionId", + "documentation":"

    The unique identifier (ID) for the Protection object that is created.

    " + } + } + }, + "CreateSubscriptionRequest":{ + "type":"structure", + "members":{ + } + }, + "CreateSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteProtectionRequest":{ + "type":"structure", + "required":["ProtectionId"], + "members":{ + "ProtectionId":{ + "shape":"ProtectionId", + "documentation":"

    The unique identifier (ID) for the Protection object to be deleted.

    " + } + } + }, + "DeleteProtectionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteSubscriptionRequest":{ + "type":"structure", + "members":{ + }, + "deprecated":true + }, + "DeleteSubscriptionResponse":{ + "type":"structure", + "members":{ + }, + "deprecated":true + }, + "DescribeAttackRequest":{ + "type":"structure", + "required":["AttackId"], + "members":{ + "AttackId":{ + "shape":"AttackId", + "documentation":"

    The unique identifier (ID) for the attack that to be described.

    " + } + } + }, + "DescribeAttackResponse":{ + "type":"structure", + "members":{ + "Attack":{ + "shape":"AttackDetail", + "documentation":"

    The attack that is described.

    " + } + } + }, + "DescribeDRTAccessRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeDRTAccessResponse":{ + "type":"structure", + "members":{ + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.

    " + }, + "LogBucketList":{ + "shape":"LogBucketList", + "documentation":"

    The list of Amazon S3 buckets accessed by the DRT.

    " + } + } + }, + "DescribeEmergencyContactSettingsRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeEmergencyContactSettingsResponse":{ + "type":"structure", + "members":{ + "EmergencyContactList":{ + "shape":"EmergencyContactList", + "documentation":"

    A list of email addresses that the DRT can use to contact you during a suspected attack.

    " + } + } + }, + "DescribeProtectionRequest":{ + "type":"structure", + "members":{ + "ProtectionId":{ + "shape":"ProtectionId", + "documentation":"

    The unique identifier (ID) for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

    " + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the AWS resource for the Protection object that is described. When submitting the DescribeProtection request you must provide either the ResourceArn or the ProtectionID, but not both.

    " + } + } + }, + "DescribeProtectionResponse":{ + "type":"structure", + "members":{ + "Protection":{ + "shape":"Protection", + "documentation":"

    The Protection object that is described.

    " + } + } + }, + "DescribeSubscriptionRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeSubscriptionResponse":{ + "type":"structure", + "members":{ + "Subscription":{ + "shape":"Subscription", + "documentation":"

    The AWS Shield Advanced subscription details for an account.

    " + } + } + }, + "DisassociateDRTLogBucketRequest":{ + "type":"structure", + "required":["LogBucket"], + "members":{ + "LogBucket":{ + "shape":"LogBucket", + "documentation":"

    The Amazon S3 bucket that contains your AWS WAF logs.

    " + } + } + }, + "DisassociateDRTLogBucketResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateDRTRoleRequest":{ + "type":"structure", + "members":{ + } + }, + "DisassociateDRTRoleResponse":{ + "type":"structure", + "members":{ + } + }, + "Double":{"type":"double"}, + "DurationInSeconds":{ + "type":"long", + "min":0 + }, + "EmailAddress":{ + "type":"string", + "max":150, + "min":1, + "pattern":"^\\S+@\\S+\\.\\S+$" + }, + "EmergencyContact":{ + "type":"structure", + "required":["EmailAddress"], + "members":{ + "EmailAddress":{ + "shape":"EmailAddress", + "documentation":"

    An email address that the DRT can use to contact you during a suspected attack.

    " + } + }, + "documentation":"

    Contact information that the DRT can use to contact you during a suspected attack.

    " + }, + "EmergencyContactList":{ + "type":"list", + "member":{"shape":"EmergencyContact"}, + "max":10, + "min":0 + }, + "GetSubscriptionStateRequest":{ + "type":"structure", + "members":{ + } + }, + "GetSubscriptionStateResponse":{ + "type":"structure", + "required":["SubscriptionState"], + "members":{ + "SubscriptionState":{ + "shape":"SubscriptionState", + "documentation":"

    The status of the subscription.

    " + } + } + }, + "Integer":{"type":"integer"}, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that a problem occurred with the service infrastructure. You can retry the request.

    ", + "exception":true, + "fault":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that the operation would not cause any change to occur.

    ", + "exception":true + }, + "InvalidPaginationTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that the NextToken specified in the request is invalid. Submit the request using the NextToken value that was returned in the response.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that the parameters passed to the API are invalid.

    ", + "exception":true + }, + "InvalidResourceException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that the resource is invalid. You might not have access to the resource, or the resource might not exist.

    ", + "exception":true + }, + "Limit":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"String", + "documentation":"

    The type of protection.

    " + }, + "Max":{ + "shape":"Long", + "documentation":"

    The maximum number of protections that can be created for the specified Type.

    " + } + }, + "documentation":"

    Specifies how many protections of a given type you can create.

    " + }, + "LimitNumber":{"type":"long"}, + "LimitType":{"type":"string"}, + "Limits":{ + "type":"list", + "member":{"shape":"Limit"} + }, + "LimitsExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"}, + "Type":{"shape":"LimitType"}, + "Limit":{"shape":"LimitNumber"} + }, + "documentation":"

    Exception that indicates that the operation would exceed a limit.

    Type is the type of limit that would be exceeded.

    Limit is the threshold that would be exceeded.

    ", + "exception":true + }, + "ListAttacksRequest":{ + "type":"structure", + "members":{ + "ResourceArns":{ + "shape":"ResourceArnFilterList", + "documentation":"

    The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

    " + }, + "StartTime":{ + "shape":"TimeRange", + "documentation":"

    The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

    " + }, + "EndTime":{ + "shape":"TimeRange", + "documentation":"

    The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

    " + }, + "NextToken":{ + "shape":"Token", + "documentation":"

    The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of AttackSummary objects to be returned. If this is left blank, the first 20 results will be returned.

    This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of AttackSummary objects returned could be less than MaxResults, even if there are still more AttackSummary objects yet to return. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

    " + } + } + }, + "ListAttacksResponse":{ + "type":"structure", + "members":{ + "AttackSummaries":{ + "shape":"AttackSummaries", + "documentation":"

    The attack information for the specified time range.

    " + }, + "NextToken":{ + "shape":"Token", + "documentation":"

    The token returned by a previous call to indicate that there is more data available. If not null, more results are available. Pass this value for the NextMarker parameter in a subsequent call to ListAttacks to retrieve the next set of items.

    AWS WAF might return the list of AttackSummary objects in batches smaller than the number specified by MaxResults. If there are more AttackSummary objects to return, AWS WAF will always also return a NextToken.

    " + } + } + }, + "ListProtectionsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

    The ListProtectionsRequest.NextToken value from a previous call to ListProtections. Pass null if this is the first call.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of Protection objects to be returned. If this is left blank the first 20 results will be returned.

    This is a maximum value; it is possible that AWS WAF will return the results in smaller batches. That is, the number of Protection objects returned could be less than MaxResults, even if there are still more Protection objects yet to return. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

    " + } + } + }, + "ListProtectionsResponse":{ + "type":"structure", + "members":{ + "Protections":{ + "shape":"Protections", + "documentation":"

    The array of enabled Protection objects.

    " + }, + "NextToken":{ + "shape":"Token", + "documentation":"

    If you specify a value for MaxResults and you have more Protections than the value of MaxResults, AWS Shield Advanced returns a NextToken value in the response that allows you to list another group of Protections. For the second and subsequent ListProtections requests, specify the value of NextToken from the previous response to get information about another batch of Protections.

    AWS WAF might return the list of Protection objects in batches smaller than the number specified by MaxResults. If there are more Protection objects to return, AWS WAF will always also return a NextToken.

    " + } + } + }, + "LockedSubscriptionException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    You are trying to update a subscription that has not yet completed the 1-year commitment. You can change the AutoRenew parameter during the last 30 days of your subscription. This exception indicates that you are attempting to change AutoRenew prior to that period.

    ", + "exception":true + }, + "LogBucket":{ + "type":"string", + "max":63, + "min":3, + "pattern":"^([a-z]|(\\d(?!\\d{0,2}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})))([a-z\\d]|(\\.(?!(\\.|-)))|(-(?!\\.))){1,61}[a-z\\d]$" + }, + "LogBucketList":{ + "type":"list", + "member":{"shape":"LogBucket"}, + "max":10, + "min":0 + }, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "box":true, + "max":10000, + "min":0 + }, + "Mitigation":{ + "type":"structure", + "members":{ + "MitigationName":{ + "shape":"String", + "documentation":"

    The name of the mitigation taken for this attack.

    " + } + }, + "documentation":"

    The mitigation applied to a DDoS attack.

    " + }, + "MitigationList":{ + "type":"list", + "member":{"shape":"Mitigation"} + }, + "NoAssociatedRoleException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The ARN of the role that you specifed does not exist.

    ", + "exception":true + }, + "OptimisticLockException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception that indicates that the protection state has been modified by another client. You can retry the request.

    ", + "exception":true + }, + "Protection":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ProtectionId", + "documentation":"

    The unique identifier (ID) of the protection.

    " + }, + "Name":{ + "shape":"ProtectionName", + "documentation":"

    The friendly name of the protection. For example, My CloudFront distributions.

    " + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the AWS resource that is protected.

    " + } + }, + "documentation":"

    An object that represents a resource that is under DDoS protection.

    " + }, + "ProtectionId":{ + "type":"string", + "max":36, + "min":1, + "pattern":"[a-zA-Z0-9\\\\-]*" + }, + "ProtectionName":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[ a-zA-Z0-9_\\\\.\\\\-]*" + }, + "Protections":{ + "type":"list", + "member":{"shape":"Protection"} + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception indicating the specified resource already exists.

    ", + "exception":true + }, + "ResourceArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws.*" + }, + "ResourceArnFilterList":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    Exception indicating the specified resource does not exist.

    ", + "exception":true + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:aws:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "String":{"type":"string"}, + "SubResourceSummary":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"SubResourceType", + "documentation":"

    The SubResource type.

    " + }, + "Id":{ + "shape":"String", + "documentation":"

    The unique identifier (ID) of the SubResource.

    " + }, + "AttackVectors":{ + "shape":"SummarizedAttackVectorList", + "documentation":"

    The list of attack types and associated counters.

    " + }, + "Counters":{ + "shape":"SummarizedCounterList", + "documentation":"

    The counters that describe the details of the attack.

    " + } + }, + "documentation":"

    The attack information for the specified SubResource.

    " + }, + "SubResourceSummaryList":{ + "type":"list", + "member":{"shape":"SubResourceSummary"} + }, + "SubResourceType":{ + "type":"string", + "enum":[ + "IP", + "URL" + ] + }, + "Subscription":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the subscription, in Unix time in seconds. For more information see timestamp.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The date and time your subscription will end.

    " + }, + "TimeCommitmentInSeconds":{ + "shape":"DurationInSeconds", + "documentation":"

    The length, in seconds, of the AWS Shield Advanced subscription for the account.

    " + }, + "AutoRenew":{ + "shape":"AutoRenew", + "documentation":"

    If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

    When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

    " + }, + "Limits":{ + "shape":"Limits", + "documentation":"

    Specifies how many protections of a given type you can create.

    " + } + }, + "documentation":"

    Information about the AWS Shield Advanced subscription for an account.

    " + }, + "SubscriptionState":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE" + ] + }, + "SummarizedAttackVector":{ + "type":"structure", + "required":["VectorType"], + "members":{ + "VectorType":{ + "shape":"String", + "documentation":"

    The attack type, for example, SNMP reflection or SYN flood.

    " + }, + "VectorCounters":{ + "shape":"SummarizedCounterList", + "documentation":"

    The list of counters that describe the details of the attack.

    " + } + }, + "documentation":"

    A summary of information about the attack.

    " + }, + "SummarizedAttackVectorList":{ + "type":"list", + "member":{"shape":"SummarizedAttackVector"} + }, + "SummarizedCounter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The counter name.

    " + }, + "Max":{ + "shape":"Double", + "documentation":"

    The maximum value of the counter for a specified time period.

    " + }, + "Average":{ + "shape":"Double", + "documentation":"

    The average value of the counter for a specified time period.

    " + }, + "Sum":{ + "shape":"Double", + "documentation":"

    The total of counter values for a specified time period.

    " + }, + "N":{ + "shape":"Integer", + "documentation":"

    The number of counters for a specified time period.

    " + }, + "Unit":{ + "shape":"String", + "documentation":"

    The unit of the counters.

    " + } + }, + "documentation":"

    The counter that describes a DDoS attack.

    " + }, + "SummarizedCounterList":{ + "type":"list", + "member":{"shape":"SummarizedCounter"} + }, + "TimeRange":{ + "type":"structure", + "members":{ + "FromInclusive":{ + "shape":"AttackTimestamp", + "documentation":"

    The start time, in Unix time in seconds. For more information see timestamp.

    " + }, + "ToExclusive":{ + "shape":"AttackTimestamp", + "documentation":"

    The end time, in Unix time in seconds. For more information see timestamp.

    " + } + }, + "documentation":"

    The time range.

    " + }, + "Timestamp":{"type":"timestamp"}, + "Token":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^.*$" + }, + "TopContributors":{ + "type":"list", + "member":{"shape":"Contributor"} + }, + "Unit":{ + "type":"string", + "enum":[ + "BITS", + "BYTES", + "PACKETS", + "REQUESTS" + ] + }, + "UpdateEmergencyContactSettingsRequest":{ + "type":"structure", + "members":{ + "EmergencyContactList":{ + "shape":"EmergencyContactList", + "documentation":"

    A list of email addresses that the DRT can use to contact you during a suspected attack.

    " + } + } + }, + "UpdateEmergencyContactSettingsResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateSubscriptionRequest":{ + "type":"structure", + "members":{ + "AutoRenew":{ + "shape":"AutoRenew", + "documentation":"

    When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

    " + } + } + }, + "UpdateSubscriptionResponse":{ + "type":"structure", + "members":{ + } + }, + "errorMessage":{"type":"string"} + }, + "documentation":"AWS Shield Advanced

    This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

    " +} diff --git a/aws/dist/botocore/data/signer/2017-08-25/paginators-1.json b/aws/dist/botocore/data/signer/2017-08-25/paginators-1.json new file mode 100644 index 00000000..1e049e7d --- /dev/null +++ b/aws/dist/botocore/data/signer/2017-08-25/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListSigningJobs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "jobs" + }, + "ListSigningPlatforms": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "platforms" + }, + "ListSigningProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "profiles" + } + } +} diff --git a/aws/dist/botocore/data/signer/2017-08-25/service-2.json b/aws/dist/botocore/data/signer/2017-08-25/service-2.json new file mode 100644 index 00000000..5335e0af --- /dev/null +++ b/aws/dist/botocore/data/signer/2017-08-25/service-2.json @@ -0,0 +1,1143 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-08-25", + "endpointPrefix":"signer", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"signer", + "serviceFullName":"AWS Signer", + "serviceId":"signer", + "signatureVersion":"v4", + "signingName":"signer", + "uid":"signer-2017-08-25" + }, + "operations":{ + "CancelSigningProfile":{ + "name":"CancelSigningProfile", + "http":{ + "method":"DELETE", + "requestUri":"/signing-profiles/{profileName}" + }, + "input":{"shape":"CancelSigningProfileRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Changes the state of an ACTIVE signing profile to CANCELED. A canceled profile is still viewable with the ListSigningProfiles operation, but it cannot perform new signing jobs, and is deleted two years after cancelation.

    " + }, + "DescribeSigningJob":{ + "name":"DescribeSigningJob", + "http":{ + "method":"GET", + "requestUri":"/signing-jobs/{jobId}" + }, + "input":{"shape":"DescribeSigningJobRequest"}, + "output":{"shape":"DescribeSigningJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Returns information about a specific code signing job. You specify the job by using the jobId value that is returned by the StartSigningJob operation.

    " + }, + "GetSigningPlatform":{ + "name":"GetSigningPlatform", + "http":{ + "method":"GET", + "requestUri":"/signing-platforms/{platformId}" + }, + "input":{"shape":"GetSigningPlatformRequest"}, + "output":{"shape":"GetSigningPlatformResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Returns information on a specific signing platform.

    " + }, + "GetSigningProfile":{ + "name":"GetSigningProfile", + "http":{ + "method":"GET", + "requestUri":"/signing-profiles/{profileName}" + }, + "input":{"shape":"GetSigningProfileRequest"}, + "output":{"shape":"GetSigningProfileResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Returns information on a specific signing profile.

    " + }, + "ListSigningJobs":{ + "name":"ListSigningJobs", + "http":{ + "method":"GET", + "requestUri":"/signing-jobs" + }, + "input":{"shape":"ListSigningJobsRequest"}, + "output":{"shape":"ListSigningJobsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Lists all your signing jobs. You can use the maxResults parameter to limit the number of signing jobs that are returned in the response. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    " + }, + "ListSigningPlatforms":{ + "name":"ListSigningPlatforms", + "http":{ + "method":"GET", + "requestUri":"/signing-platforms" + }, + "input":{"shape":"ListSigningPlatformsRequest"}, + "output":{"shape":"ListSigningPlatformsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Lists all signing platforms available in code signing that match the request parameters. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    " + }, + "ListSigningProfiles":{ + "name":"ListSigningProfiles", + "http":{ + "method":"GET", + "requestUri":"/signing-profiles" + }, + "input":{"shape":"ListSigningProfilesRequest"}, + "output":{"shape":"ListSigningProfilesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Lists all available signing profiles in your AWS account. Returns only profiles with an ACTIVE status unless the includeCanceled request field is set to true. If additional jobs remain to be listed, code signing returns a nextToken value. Use this value in subsequent calls to ListSigningJobs to fetch the remaining values. You can continue calling ListSigningJobs with your maxResults parameter and with new values that code signing returns in the nextToken parameter until all of your signing jobs have been returned.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Returns a list of the tags associated with a signing profile resource.

    " + }, + "PutSigningProfile":{ + "name":"PutSigningProfile", + "http":{ + "method":"PUT", + "requestUri":"/signing-profiles/{profileName}" + }, + "input":{"shape":"PutSigningProfileRequest"}, + "output":{"shape":"PutSigningProfileResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Creates a signing profile. A signing profile is a code signing template that can be used to carry out a pre-defined signing job. For more information, see http://docs.aws.amazon.com/signer/latest/developerguide/gs-profile.html

    " + }, + "StartSigningJob":{ + "name":"StartSigningJob", + "http":{ + "method":"POST", + "requestUri":"/signing-jobs" + }, + "input":{"shape":"StartSigningJobRequest"}, + "output":{"shape":"StartSigningJobResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServiceErrorException"} + ], + "documentation":"

    Initiates a signing job to be performed on the code provided. Signing jobs are viewable by the ListSigningJobs operation for two years after they are performed. Note the following requirements:

    • You must create an Amazon S3 source bucket. For more information, see Create a Bucket in the Amazon S3 Getting Started Guide.

    • Your S3 source bucket must be version enabled.

    • You must create an S3 destination bucket. Code signing uses your S3 destination bucket to write your signed code.

    • You specify the name of the source and destination buckets when calling the StartSigningJob operation.

    • You must also specify a request token that identifies your request to code signing.

    You can call the DescribeSigningJob and the ListSigningJobs actions after you call StartSigningJob.

    For a Java example that shows how to use this action, see http://docs.aws.amazon.com/acm/latest/userguide/

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Adds one or more tags to a signing profile. 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 signing profile using its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServiceErrorException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Remove one or more tags from a signing profile. Specify a list of tag keys to remove the tags.

    " + } + }, + "shapes":{ + "key":{"type":"string"}, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You do not have sufficient access to perform this action.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "BadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request contains invalid parameters for the ARN or tags. This exception also occurs when you call a tagging API on a cancelled signing profile.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "BucketName":{"type":"string"}, + "CancelSigningProfileRequest":{ + "type":"structure", + "required":["profileName"], + "members":{ + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the signing profile to be canceled.

    ", + "location":"uri", + "locationName":"profileName" + } + } + }, + "Category":{ + "type":"string", + "enum":["AWSIoT"] + }, + "CertificateArn":{"type":"string"}, + "ClientRequestToken":{"type":"string"}, + "CompletedAt":{"type":"timestamp"}, + "CreatedAt":{"type":"timestamp"}, + "DescribeSigningJobRequest":{ + "type":"structure", + "required":["jobId"], + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

    The ID of the signing job on input.

    ", + "location":"uri", + "locationName":"jobId" + } + } + }, + "DescribeSigningJobResponse":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

    The ID of the signing job on output.

    " + }, + "source":{ + "shape":"Source", + "documentation":"

    The object that contains the name of your S3 bucket or your raw code.

    " + }, + "signingMaterial":{ + "shape":"SigningMaterial", + "documentation":"

    Amazon Resource Name (ARN) of your code signing certificate.

    " + }, + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The microcontroller platform to which your signed code image will be distributed.

    " + }, + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the profile that initiated the signing operation.

    " + }, + "overrides":{ + "shape":"SigningPlatformOverrides", + "documentation":"

    A list of any overrides that were applied to the signing operation.

    " + }, + "signingParameters":{ + "shape":"SigningParameters", + "documentation":"

    Map of user-assigned key-value pairs used during signing. These values contain any information that you specified for use in your signing job.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    Date and time that the signing job was created.

    " + }, + "completedAt":{ + "shape":"CompletedAt", + "documentation":"

    Date and time that the signing job was completed.

    " + }, + "requestedBy":{ + "shape":"RequestedBy", + "documentation":"

    The IAM principal that requested the signing job.

    " + }, + "status":{ + "shape":"SigningStatus", + "documentation":"

    Status of the signing job.

    " + }, + "statusReason":{ + "shape":"StatusReason", + "documentation":"

    String value that contains the status reason.

    " + }, + "signedObject":{ + "shape":"SignedObject", + "documentation":"

    Name of the S3 bucket where the signed code image is saved by code signing.

    " + } + } + }, + "Destination":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"S3Destination", + "documentation":"

    The S3Destination object.

    " + } + }, + "documentation":"

    Points to an S3Destination object that contains information about your S3 bucket.

    " + }, + "DisplayName":{"type":"string"}, + "EncryptionAlgorithm":{ + "type":"string", + "enum":[ + "RSA", + "ECDSA" + ] + }, + "EncryptionAlgorithmOptions":{ + "type":"structure", + "required":[ + "allowedValues", + "defaultValue" + ], + "members":{ + "allowedValues":{ + "shape":"EncryptionAlgorithms", + "documentation":"

    The set of accepted encryption algorithms that are allowed in a code signing job.

    " + }, + "defaultValue":{ + "shape":"EncryptionAlgorithm", + "documentation":"

    The default encryption algorithm that is used by a code signing job.

    " + } + }, + "documentation":"

    The encryption algorithm options that are available to a code signing job.

    " + }, + "EncryptionAlgorithms":{ + "type":"list", + "member":{"shape":"EncryptionAlgorithm"} + }, + "ErrorMessage":{"type":"string"}, + "GetSigningPlatformRequest":{ + "type":"structure", + "required":["platformId"], + "members":{ + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of the target signing platform.

    ", + "location":"uri", + "locationName":"platformId" + } + } + }, + "GetSigningPlatformResponse":{ + "type":"structure", + "members":{ + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of the target signing platform.

    " + }, + "displayName":{ + "shape":"DisplayName", + "documentation":"

    The display name of the target signing platform.

    " + }, + "partner":{ + "shape":"String", + "documentation":"

    A list of partner entities that use the target signing platform.

    " + }, + "target":{ + "shape":"String", + "documentation":"

    The validation template that is used by the target signing platform.

    " + }, + "category":{ + "shape":"Category", + "documentation":"

    The category type of the target signing platform.

    " + }, + "signingConfiguration":{ + "shape":"SigningConfiguration", + "documentation":"

    A list of configurations applied to the target platform at signing.

    " + }, + "signingImageFormat":{ + "shape":"SigningImageFormat", + "documentation":"

    The format of the target platform's signing image.

    " + }, + "maxSizeInMB":{ + "shape":"MaxSizeInMB", + "documentation":"

    The maximum size (in MB) of the payload that can be signed by the target platform.

    " + } + } + }, + "GetSigningProfileRequest":{ + "type":"structure", + "required":["profileName"], + "members":{ + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the target signing profile.

    ", + "location":"uri", + "locationName":"profileName" + } + } + }, + "GetSigningProfileResponse":{ + "type":"structure", + "members":{ + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the target signing profile.

    " + }, + "signingMaterial":{ + "shape":"SigningMaterial", + "documentation":"

    The ARN of the certificate that the target profile uses for signing operations.

    " + }, + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of the platform that is used by the target signing profile.

    " + }, + "overrides":{ + "shape":"SigningPlatformOverrides", + "documentation":"

    A list of overrides applied by the target signing profile for signing operations.

    " + }, + "signingParameters":{ + "shape":"SigningParameters", + "documentation":"

    A map of key-value pairs for signing operations that is attached to the target signing profile.

    " + }, + "status":{ + "shape":"SigningProfileStatus", + "documentation":"

    The status of the target signing profile.

    " + }, + "arn":{ + "shape":"string", + "documentation":"

    The Amazon Resource Name (ARN) for the signing profile.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A list of tags associated with the signing profile.

    " + } + } + }, + "HashAlgorithm":{ + "type":"string", + "enum":[ + "SHA1", + "SHA256" + ] + }, + "HashAlgorithmOptions":{ + "type":"structure", + "required":[ + "allowedValues", + "defaultValue" + ], + "members":{ + "allowedValues":{ + "shape":"HashAlgorithms", + "documentation":"

    The set of accepted hash algorithms allowed in a code signing job.

    " + }, + "defaultValue":{ + "shape":"HashAlgorithm", + "documentation":"

    The default hash algorithm that is used in a code signing job.

    " + } + }, + "documentation":"

    The hash algorithms that are available to a code signing job.

    " + }, + "HashAlgorithms":{ + "type":"list", + "member":{"shape":"HashAlgorithm"} + }, + "ImageFormat":{ + "type":"string", + "enum":["JSON"] + }, + "ImageFormats":{ + "type":"list", + "member":{"shape":"ImageFormat"} + }, + "InternalServiceErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    An internal error occurred.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "JobId":{"type":"string"}, + "Key":{"type":"string"}, + "ListSigningJobsRequest":{ + "type":"structure", + "members":{ + "status":{ + "shape":"SigningStatus", + "documentation":"

    A status value with which to filter your results.

    ", + "location":"querystring", + "locationName":"status" + }, + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of microcontroller platform that you specified for the distribution of your code image.

    ", + "location":"querystring", + "locationName":"platformId" + }, + "requestedBy":{ + "shape":"RequestedBy", + "documentation":"

    The IAM principal that requested the signing job.

    ", + "location":"querystring", + "locationName":"requestedBy" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    Specifies the maximum number of items to return in the response. Use this parameter when paginating results. If additional items exist beyond the number you specify, the nextToken element is set in the response. Use the nextToken value in a subsequent request to retrieve additional items.

    ", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    String for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

    ", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListSigningJobsResponse":{ + "type":"structure", + "members":{ + "jobs":{ + "shape":"SigningJobs", + "documentation":"

    A list of your signing jobs.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    String for specifying the next set of paginated results.

    " + } + } + }, + "ListSigningPlatformsRequest":{ + "type":"structure", + "members":{ + "category":{ + "shape":"String", + "documentation":"

    The category type of a signing platform.

    ", + "location":"querystring", + "locationName":"category" + }, + "partner":{ + "shape":"String", + "documentation":"

    Any partner entities connected to a signing platform.

    ", + "location":"querystring", + "locationName":"partner" + }, + "target":{ + "shape":"String", + "documentation":"

    The validation template that is used by the target signing platform.

    ", + "location":"querystring", + "locationName":"target" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be returned by this operation.

    ", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"String", + "documentation":"

    Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

    ", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListSigningPlatformsResponse":{ + "type":"structure", + "members":{ + "platforms":{ + "shape":"SigningPlatforms", + "documentation":"

    A list of all platforms that match the request parameters.

    " + }, + "nextToken":{ + "shape":"String", + "documentation":"

    Value for specifying the next set of paginated results to return.

    " + } + } + }, + "ListSigningProfilesRequest":{ + "type":"structure", + "members":{ + "includeCanceled":{ + "shape":"bool", + "documentation":"

    Designates whether to include profiles with the status of CANCELED.

    ", + "location":"querystring", + "locationName":"includeCanceled" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of profiles to be returned.

    ", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    Value for specifying the next set of paginated results to return. After you receive a response with truncated results, use this parameter in a subsequent request. Set it to the value of nextToken from the response that you just received.

    ", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListSigningProfilesResponse":{ + "type":"structure", + "members":{ + "profiles":{ + "shape":"SigningProfiles", + "documentation":"

    A list of profiles that are available in the AWS account. This includes profiles with the status of CANCELED if the includeCanceled parameter is set to true.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    Value for specifying the next set of paginated results to return.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) for the signing profile.

    ", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagMap", + "documentation":"

    A list of tags associated with the signing profile.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":25, + "min":1 + }, + "MaxSizeInMB":{"type":"integer"}, + "NextToken":{"type":"string"}, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The signing profile was not found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "PlatformId":{"type":"string"}, + "Prefix":{"type":"string"}, + "ProfileName":{ + "type":"string", + "max":20, + "min":2, + "pattern":"^[a-zA-Z0-9_]{2,}" + }, + "PutSigningProfileRequest":{ + "type":"structure", + "required":[ + "profileName", + "signingMaterial", + "platformId" + ], + "members":{ + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the signing profile to be created.

    ", + "location":"uri", + "locationName":"profileName" + }, + "signingMaterial":{ + "shape":"SigningMaterial", + "documentation":"

    The AWS Certificate Manager certificate that will be used to sign code with the new signing profile.

    " + }, + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of the signing profile to be created.

    " + }, + "overrides":{ + "shape":"SigningPlatformOverrides", + "documentation":"

    A subfield of platform. This specifies any different configuration options that you want to apply to the chosen platform (such as a different hash-algorithm or signing-algorithm).

    " + }, + "signingParameters":{ + "shape":"SigningParameters", + "documentation":"

    Map of key-value pairs for signing. These can include any information that you want to use during signing.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    Tags to be associated with the signing profile being created.

    " + } + } + }, + "PutSigningProfileResponse":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"string", + "documentation":"

    The Amazon Resource Name (ARN) of the signing profile created.

    " + } + } + }, + "RequestedBy":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A specified resource could not be found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "S3Destination":{ + "type":"structure", + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

    Name of the S3 bucket.

    " + }, + "prefix":{ + "shape":"Prefix", + "documentation":"

    An Amazon S3 prefix that you can use to limit responses to those that begin with the specified prefix.

    " + } + }, + "documentation":"

    The name and prefix of the S3 bucket where code signing saves your signed objects.

    " + }, + "S3SignedObject":{ + "type":"structure", + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

    Name of the S3 bucket.

    " + }, + "key":{ + "shape":"key", + "documentation":"

    Key name that uniquely identifies a signed code image in your bucket.

    " + } + }, + "documentation":"

    The S3 bucket name and key where code signing saved your signed code image.

    " + }, + "S3Source":{ + "type":"structure", + "required":[ + "bucketName", + "key", + "version" + ], + "members":{ + "bucketName":{ + "shape":"BucketName", + "documentation":"

    Name of the S3 bucket.

    " + }, + "key":{ + "shape":"Key", + "documentation":"

    Key name of the bucket object that contains your unsigned code.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    Version of your source image in your version enabled S3 bucket.

    " + } + }, + "documentation":"

    Information about the S3 bucket where you saved your unsigned code.

    " + }, + "SignedObject":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"S3SignedObject", + "documentation":"

    The S3SignedObject.

    " + } + }, + "documentation":"

    Points to an S3SignedObject object that contains information about your signed code image.

    " + }, + "SigningConfiguration":{ + "type":"structure", + "required":[ + "encryptionAlgorithmOptions", + "hashAlgorithmOptions" + ], + "members":{ + "encryptionAlgorithmOptions":{ + "shape":"EncryptionAlgorithmOptions", + "documentation":"

    The encryption algorithm options that are available for a code signing job.

    " + }, + "hashAlgorithmOptions":{ + "shape":"HashAlgorithmOptions", + "documentation":"

    The hash algorithm options that are available for a a code signing job.

    " + } + }, + "documentation":"

    The configuration of a code signing operation.

    " + }, + "SigningConfigurationOverrides":{ + "type":"structure", + "members":{ + "encryptionAlgorithm":{ + "shape":"EncryptionAlgorithm", + "documentation":"

    A specified override of the default encryption algorithm that is used in a code signing job.

    " + }, + "hashAlgorithm":{ + "shape":"HashAlgorithm", + "documentation":"

    A specified override of the default hash algorithm that is used in a code signing job.

    " + } + }, + "documentation":"

    A signing configuration that overrides the default encryption or hash algorithm of a signing job.

    " + }, + "SigningImageFormat":{ + "type":"structure", + "required":[ + "supportedFormats", + "defaultFormat" + ], + "members":{ + "supportedFormats":{ + "shape":"ImageFormats", + "documentation":"

    The supported formats of a code signing signing image.

    " + }, + "defaultFormat":{ + "shape":"ImageFormat", + "documentation":"

    The default format of a code signing signing image.

    " + } + }, + "documentation":"

    The image format of a code signing platform or profile.

    " + }, + "SigningJob":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

    The ID of the signing job.

    " + }, + "source":{ + "shape":"Source", + "documentation":"

    A Source that contains information about a signing job's code image source.

    " + }, + "signedObject":{ + "shape":"SignedObject", + "documentation":"

    A SignedObject structure that contains information about a signing job's signed code image.

    " + }, + "signingMaterial":{ + "shape":"SigningMaterial", + "documentation":"

    A SigningMaterial object that contains the Amazon Resource Name (ARN) of the certificate used for the signing job.

    " + }, + "createdAt":{ + "shape":"CreatedAt", + "documentation":"

    The date and time that the signing job was created.

    " + }, + "status":{ + "shape":"SigningStatus", + "documentation":"

    The status of the signing job.

    " + } + }, + "documentation":"

    Contains information about a signing job.

    " + }, + "SigningJobs":{ + "type":"list", + "member":{"shape":"SigningJob"} + }, + "SigningMaterial":{ + "type":"structure", + "required":["certificateArn"], + "members":{ + "certificateArn":{ + "shape":"CertificateArn", + "documentation":"

    The Amazon Resource Name (ARN) of the certificates that is used to sign your code.

    " + } + }, + "documentation":"

    The ACM certificate that is used to sign your code.

    " + }, + "SigningParameterKey":{"type":"string"}, + "SigningParameterValue":{"type":"string"}, + "SigningParameters":{ + "type":"map", + "key":{"shape":"SigningParameterKey"}, + "value":{"shape":"SigningParameterValue"} + }, + "SigningPlatform":{ + "type":"structure", + "members":{ + "platformId":{ + "shape":"String", + "documentation":"

    The ID of a code signing; platform.

    " + }, + "displayName":{ + "shape":"String", + "documentation":"

    The display name of a code signing platform.

    " + }, + "partner":{ + "shape":"String", + "documentation":"

    Any partner entities linked to a code signing platform.

    " + }, + "target":{ + "shape":"String", + "documentation":"

    The types of targets that can be signed by a code signing platform.

    " + }, + "category":{ + "shape":"Category", + "documentation":"

    The category of a code signing platform.

    " + }, + "signingConfiguration":{ + "shape":"SigningConfiguration", + "documentation":"

    The configuration of a code signing platform. This includes the designated hash algorithm and encryption algorithm of a signing platform.

    " + }, + "signingImageFormat":{"shape":"SigningImageFormat"}, + "maxSizeInMB":{ + "shape":"MaxSizeInMB", + "documentation":"

    The maximum size (in MB) of code that can be signed by a code signing platform.

    " + } + }, + "documentation":"

    Contains information about the signing configurations and parameters that is used to perform a code signing job.

    " + }, + "SigningPlatformOverrides":{ + "type":"structure", + "members":{ + "signingConfiguration":{ + "shape":"SigningConfigurationOverrides", + "documentation":"

    A signing configuration that overrides the default encryption or hash algorithm of a signing job.

    " + } + }, + "documentation":"

    Any overrides that are applied to the signing configuration of a code signing platform.

    " + }, + "SigningPlatforms":{ + "type":"list", + "member":{"shape":"SigningPlatform"} + }, + "SigningProfile":{ + "type":"structure", + "members":{ + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the signing profile.

    " + }, + "signingMaterial":{ + "shape":"SigningMaterial", + "documentation":"

    The ACM certificate that is available for use by a signing profile.

    " + }, + "platformId":{ + "shape":"PlatformId", + "documentation":"

    The ID of a platform that is available for use by a signing profile.

    " + }, + "signingParameters":{ + "shape":"SigningParameters", + "documentation":"

    The parameters that are available for use by a code signing user.

    " + }, + "status":{ + "shape":"SigningProfileStatus", + "documentation":"

    The status of a code signing profile.

    " + }, + "arn":{ + "shape":"string", + "documentation":"

    Amazon Resource Name (ARN) for the signing profile.

    " + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    A list of tags associated with the signing profile.

    " + } + }, + "documentation":"

    Contains information about the ACM certificates and code signing configuration parameters that can be used by a given code signing user.

    " + }, + "SigningProfileStatus":{ + "type":"string", + "enum":[ + "Active", + "Canceled" + ] + }, + "SigningProfiles":{ + "type":"list", + "member":{"shape":"SigningProfile"} + }, + "SigningStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Failed", + "Succeeded" + ] + }, + "Source":{ + "type":"structure", + "members":{ + "s3":{ + "shape":"S3Source", + "documentation":"

    The S3Source object.

    " + } + }, + "documentation":"

    An S3Source object that contains information about the S3 bucket where you saved your unsigned code.

    " + }, + "StartSigningJobRequest":{ + "type":"structure", + "required":[ + "source", + "destination", + "clientRequestToken" + ], + "members":{ + "source":{ + "shape":"Source", + "documentation":"

    The S3 bucket that contains the object to sign or a BLOB that contains your raw code.

    " + }, + "destination":{ + "shape":"Destination", + "documentation":"

    The S3 bucket in which to save your signed object. The destination contains the name of your bucket and an optional prefix.

    " + }, + "profileName":{ + "shape":"ProfileName", + "documentation":"

    The name of the signing profile.

    " + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    String that identifies the signing request. All calls after the first that use this token return the same response as the first call.

    ", + "idempotencyToken":true + } + } + }, + "StartSigningJobResponse":{ + "type":"structure", + "members":{ + "jobId":{ + "shape":"JobId", + "documentation":"

    The ID of your signing job.

    " + } + } + }, + "StatusReason":{"type":"string"}, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":1 + }, + "TagMap":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":200, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

    Amazon Resource Name (ARN) for the signing profile.

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    One or more tags to be associated with the signing profile.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The signing job has been throttled.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"String", + "documentation":"

    Amazon Resource Name (ARN) for the signing profile .

    ", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

    A list of tag keys to be removed from the signing profile .

    ", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You signing certificate could not be validated.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "Version":{"type":"string"}, + "bool":{"type":"boolean"}, + "string":{"type":"string"} + }, + "documentation":"

    With code signing for IoT, you can sign code that you create for any IoT device that is supported by Amazon Web Services (AWS). Code signing is available through Amazon FreeRTOS and AWS IoT Device Management, and integrated with AWS Certificate Manager (ACM). In order to sign code, you import a third-party code signing certificate with ACM that is used to sign updates in Amazon FreeRTOS and AWS IoT Device Management. For general information about using code signing, see the Code Signing for IoT Developer Guide.

    " +} diff --git a/aws/dist/botocore/data/signer/2017-08-25/waiters-2.json b/aws/dist/botocore/data/signer/2017-08-25/waiters-2.json new file mode 100644 index 00000000..a0890ade --- /dev/null +++ b/aws/dist/botocore/data/signer/2017-08-25/waiters-2.json @@ -0,0 +1,29 @@ +{ + "version": 2, + "waiters": { + "SuccessfulSigningJob": { + "delay": 20, + "operation": "DescribeSigningJob", + "maxAttempts": 25, + "acceptors": [ + { + "expected": "Succeeded", + "matcher": "path", + "state": "success", + "argument": "status" + }, + { + "expected": "Failed", + "matcher": "path", + "state": "failure", + "argument": "status" + }, + { + "expected": "ResourceNotFoundException", + "matcher": "error", + "state": "failure" + } + ] + } + } +} \ No newline at end of file diff --git a/aws/dist/botocore/data/sms-voice/2018-09-05/service-2.json b/aws/dist/botocore/data/sms-voice/2018-09-05/service-2.json new file mode 100644 index 00000000..e4fc8859 --- /dev/null +++ b/aws/dist/botocore/data/sms-voice/2018-09-05/service-2.json @@ -0,0 +1,744 @@ +{ + "metadata" : { + "apiVersion" : "2018-09-05", + "endpointPrefix" : "sms-voice.pinpoint", + "signingName" : "sms-voice", + "serviceAbbreviation":"Pinpoint SMS Voice", + "serviceFullName" : "Amazon Pinpoint SMS and Voice Service", + "serviceId" : "Pinpoint SMS Voice", + "protocol" : "rest-json", + "jsonVersion" : "1.1", + "uid" : "pinpoint-sms-voice-2018-09-05", + "signatureVersion" : "v4" + }, + "operations" : { + "CreateConfigurationSet" : { + "name" : "CreateConfigurationSet", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/configuration-sets", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConfigurationSetRequest" + }, + "output" : { + "shape" : "CreateConfigurationSetResponse", + "documentation" : "CreateConfigurationSetResponse" + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "LimitExceededException", + "documentation" : "LimitExceededException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + }, { + "shape" : "AlreadyExistsException", + "documentation" : "AlreadyExistsException" + } ], + "documentation" : "Create a new configuration set. After you create the configuration set, you can add one or more event destinations to it." + }, + "CreateConfigurationSetEventDestination" : { + "name" : "CreateConfigurationSetEventDestination", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode" : 200 + }, + "input" : { + "shape" : "CreateConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "CreateConfigurationSetEventDestinationResponse", + "documentation" : "CreateConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "LimitExceededException", + "documentation" : "LimitExceededException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + }, { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "AlreadyExistsException", + "documentation" : "AlreadyExistsException" + } ], + "documentation" : "Create a new event destination in a configuration set." + }, + "DeleteConfigurationSet" : { + "name" : "DeleteConfigurationSet", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteConfigurationSetRequest" + }, + "output" : { + "shape" : "DeleteConfigurationSetResponse", + "documentation" : "DeleteConfigurationSetResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Deletes an existing configuration set." + }, + "DeleteConfigurationSetEventDestination" : { + "name" : "DeleteConfigurationSetEventDestination", + "http" : { + "method" : "DELETE", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "DeleteConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "DeleteConfigurationSetEventDestinationResponse", + "documentation" : "DeleteConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Deletes an event destination in a configuration set." + }, + "GetConfigurationSetEventDestinations" : { + "name" : "GetConfigurationSetEventDestinations", + "http" : { + "method" : "GET", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations", + "responseCode" : 200 + }, + "input" : { + "shape" : "GetConfigurationSetEventDestinationsRequest" + }, + "output" : { + "shape" : "GetConfigurationSetEventDestinationsResponse", + "documentation" : "GetConfigurationSetEventDestinationsResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Obtain information about an event destination, including the types of events it reports, the Amazon Resource Name (ARN) of the destination, and the name of the event destination." + }, + "ListConfigurationSets" : { + "name" : "ListConfigurationSets", + "http" : { + "method" : "GET", + "requestUri" : "/v1/sms-voice/configuration-sets", + "responseCode" : 200 + }, + "input" : { + "shape" : "ListConfigurationSetsRequest" + }, + "output" : { + "shape" : "ListConfigurationSetsResponse", + "documentation" : "ListConfigurationSetsResponse" + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "List all of the configuration sets associated with your Amazon Pinpoint account in the current region." + }, + "SendVoiceMessage" : { + "name" : "SendVoiceMessage", + "http" : { + "method" : "POST", + "requestUri" : "/v1/sms-voice/voice/message", + "responseCode" : 200 + }, + "input" : { + "shape" : "SendVoiceMessageRequest" + }, + "output" : { + "shape" : "SendVoiceMessageResponse", + "documentation" : "SendVoiceMessageResponse" + }, + "errors" : [ { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Create a new voice message and send it to a recipient's phone number." + }, + "UpdateConfigurationSetEventDestination" : { + "name" : "UpdateConfigurationSetEventDestination", + "http" : { + "method" : "PUT", + "requestUri" : "/v1/sms-voice/configuration-sets/{ConfigurationSetName}/event-destinations/{EventDestinationName}", + "responseCode" : 200 + }, + "input" : { + "shape" : "UpdateConfigurationSetEventDestinationRequest" + }, + "output" : { + "shape" : "UpdateConfigurationSetEventDestinationResponse", + "documentation" : "UpdateConfigurationSetEventDestinationResponse" + }, + "errors" : [ { + "shape" : "NotFoundException", + "documentation" : "NotFoundException" + }, { + "shape" : "TooManyRequestsException", + "documentation" : "TooManyRequestsException" + }, { + "shape" : "BadRequestException", + "documentation" : "BadRequestException" + }, { + "shape" : "InternalServiceErrorException", + "documentation" : "InternalServiceErrorException" + } ], + "documentation" : "Update an event destination in a configuration set. An event destination is a location that you publish information about your voice calls to. For example, you can log an event to an Amazon CloudWatch destination when a call fails." + } + }, + "shapes" : { + "AlreadyExistsException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "The resource specified in your request already exists.", + "exception" : true, + "error" : { + "httpStatusCode" : 409 + } + }, + "BadRequestException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "The input you provided is invalid.", + "exception" : true, + "error" : { + "httpStatusCode" : 400 + } + }, + "Boolean" : { + "type" : "boolean" + }, + "CallInstructionsMessageType" : { + "type" : "structure", + "members" : { + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains text formatted using Amazon Pinpoint Voice Instructions markup.", + "required" : [ ] + }, + "CloudWatchLogsDestination" : { + "type" : "structure", + "members" : { + "IamRoleArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of an Amazon Identity and Access Management (IAM) role that is able to write event data to an Amazon CloudWatch destination." + }, + "LogGroupArn" : { + "shape" : "String", + "documentation" : "The name of the Amazon CloudWatch Log Group that you want to record events in." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon CloudWatch Logs.", + "required" : [ ] + }, + "ConfigurationSets" : { + "type" : "list", + "documentation" : "An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.", + "member" : { + "shape" : "WordCharactersWithDelimiters" + } + }, + "CreateConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestination" : { + "shape" : "EventDestinationDefinition" + }, + "EventDestinationName" : { + "shape" : "NonEmptyString", + "documentation" : "A name that identifies the event destination." + } + }, + "documentation" : "Create a new event destination in a configuration set.", + "required" : [ "ConfigurationSetName" ] + }, + "CreateConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was created successfully." + }, + "CreateConfigurationSetRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "WordCharactersWithDelimiters", + "documentation" : "The name that you want to give the configuration set." + } + }, + "documentation" : "A request to create a new configuration set." + }, + "CreateConfigurationSetResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the configuration set was successfully created." + }, + "DeleteConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestinationName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "EventDestinationName", + "documentation" : "EventDestinationName" + } + }, + "required" : [ "EventDestinationName", "ConfigurationSetName" ] + }, + "DeleteConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was deleted successfully." + }, + "DeleteConfigurationSetRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + } + }, + "required" : [ "ConfigurationSetName" ] + }, + "DeleteConfigurationSetResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the configuration set was deleted successfully." + }, + "EventDestination" : { + "type" : "structure", + "members" : { + "CloudWatchLogsDestination" : { + "shape" : "CloudWatchLogsDestination" + }, + "Enabled" : { + "shape" : "Boolean", + "documentation" : "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." + }, + "KinesisFirehoseDestination" : { + "shape" : "KinesisFirehoseDestination" + }, + "MatchingEventTypes" : { + "shape" : "EventTypes" + }, + "Name" : { + "shape" : "String", + "documentation" : "A name that identifies the event destination configuration." + }, + "SnsDestination" : { + "shape" : "SnsDestination" + } + }, + "documentation" : "An object that defines an event destination." + }, + "EventDestinationDefinition" : { + "type" : "structure", + "members" : { + "CloudWatchLogsDestination" : { + "shape" : "CloudWatchLogsDestination" + }, + "Enabled" : { + "shape" : "Boolean", + "documentation" : "Indicates whether or not the event destination is enabled. If the event destination is enabled, then Amazon Pinpoint sends response data to the specified event destination." + }, + "KinesisFirehoseDestination" : { + "shape" : "KinesisFirehoseDestination" + }, + "MatchingEventTypes" : { + "shape" : "EventTypes" + }, + "SnsDestination" : { + "shape" : "SnsDestination" + } + }, + "documentation" : "An object that defines a single event destination.", + "required" : [ ] + }, + "EventDestinations" : { + "type" : "list", + "documentation" : "An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.", + "member" : { + "shape" : "EventDestination" + } + }, + "EventType" : { + "type" : "string", + "documentation" : "The types of events that are sent to the event destination.", + "enum" : [ "INITIATED_CALL", "RINGING", "ANSWERED", "COMPLETED_CALL", "BUSY", "FAILED", "NO_ANSWER" ] + }, + "EventTypes" : { + "type" : "list", + "documentation" : "An array of EventDestination objects. Each EventDestination object includes ARNs and other information that define an event destination.", + "member" : { + "shape" : "EventType" + } + }, + "GetConfigurationSetEventDestinationsRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + } + }, + "required" : [ "ConfigurationSetName" ] + }, + "GetConfigurationSetEventDestinationsResponse" : { + "type" : "structure", + "members" : { + "EventDestinations" : { + "shape" : "EventDestinations" + } + }, + "documentation" : "An object that contains information about an event destination." + }, + "InternalServiceErrorException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.", + "exception" : true, + "error" : { + "httpStatusCode" : 500 + } + }, + "KinesisFirehoseDestination" : { + "type" : "structure", + "members" : { + "DeliveryStreamArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of an IAM role that can write data to an Amazon Kinesis Data Firehose stream." + }, + "IamRoleArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of the Amazon Kinesis Data Firehose destination that you want to use in the event destination." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon Kinesis Data Firehose.", + "required" : [ ] + }, + "LimitExceededException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "There are too many instances of the specified resource type.", + "exception" : true, + "error" : { + "httpStatusCode" : 412 + } + }, + "ListConfigurationSetsRequest" : { + "type" : "structure", + "members" : { + "NextToken" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "NextToken", + "documentation" : "A token returned from a previous call to the API that indicates the position in the list of results." + }, + "PageSize" : { + "shape" : "__string", + "location" : "querystring", + "locationName" : "PageSize", + "documentation" : "Used to specify the number of items that should be returned in the response." + } + } + }, + "ListConfigurationSetsResponse" : { + "type" : "structure", + "members" : { + "ConfigurationSets" : { + "shape" : "ConfigurationSets", + "documentation" : "An object that contains a list of configuration sets for your account in the current region." + }, + "NextToken" : { + "shape" : "NextTokenString", + "documentation" : "A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets." + } + }, + "documentation": "An object that contains information about the configuration sets for your account in the current region." + }, + "NextTokenString" : { + "type" : "string" + }, + "NonEmptyString" : { + "type" : "string" + }, + "NotFoundException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "The resource you attempted to access doesn't exist.", + "exception" : true, + "error" : { + "httpStatusCode" : 404 + } + }, + "PlainTextMessageType" : { + "type" : "structure", + "members" : { + "LanguageCode" : { + "shape" : "String", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + }, + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The plain (not SSML-formatted) text to deliver to the recipient." + }, + "VoiceId" : { + "shape" : "String", + "documentation" : "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains unformatted text.", + "required" : [ ] + }, + "SSMLMessageType" : { + "type" : "structure", + "members" : { + "LanguageCode" : { + "shape" : "String", + "documentation" : "The language to use when delivering the message. For a complete list of supported languages, see the Amazon Polly Developer Guide." + }, + "Text" : { + "shape" : "NonEmptyString", + "documentation" : "The SSML-formatted text to deliver to the recipient." + }, + "VoiceId" : { + "shape" : "String", + "documentation" : "The name of the voice that you want to use to deliver the message. For a complete list of supported voices, see the Amazon Polly Developer Guide." + } + }, + "documentation" : "An object that defines a message that contains SSML-formatted text.", + "required" : [ ] + }, + "SendVoiceMessageRequest" : { + "type" : "structure", + "members" : { + "CallerId" : { + "shape" : "String", + "documentation" : "The phone number that appears on recipients' devices when they receive the message." + }, + "ConfigurationSetName" : { + "shape" : "WordCharactersWithDelimiters", + "documentation" : "The name of the configuration set that you want to use to send the message." + }, + "Content" : { + "shape" : "VoiceMessageContent" + }, + "DestinationPhoneNumber" : { + "shape" : "NonEmptyString", + "documentation" : "The phone number that you want to send the voice message to." + }, + "OriginationPhoneNumber" : { + "shape" : "NonEmptyString", + "documentation" : "The phone number that Amazon Pinpoint should use to send the voice message. This isn't necessarily the phone number that appears on recipients' devices when they receive the message, because you can specify a CallerId parameter in the request." + } + }, + "documentation" : "SendVoiceMessageRequest" + }, + "SendVoiceMessageResponse" : { + "type" : "structure", + "members" : { + "MessageId" : { + "shape" : "String", + "documentation" : "A unique identifier for the voice message." + } + }, + "documentation" : "An object that that contains the Message ID of a Voice message that was sent successfully." + }, + "SnsDestination" : { + "type" : "structure", + "members" : { + "TopicArn" : { + "shape" : "String", + "documentation" : "The Amazon Resource Name (ARN) of the Amazon SNS topic that you want to publish events to." + } + }, + "documentation" : "An object that contains information about an event destination that sends data to Amazon SNS.", + "required" : [ ] + }, + "String" : { + "type" : "string" + }, + "TooManyRequestsException" : { + "type" : "structure", + "members" : { + "Message" : { + "shape" : "String" + } + }, + "documentation" : "You've issued too many requests to the resource. Wait a few minutes, and then try again.", + "exception" : true, + "error" : { + "httpStatusCode" : 429 + } + }, + "UpdateConfigurationSetEventDestinationRequest" : { + "type" : "structure", + "members" : { + "ConfigurationSetName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "ConfigurationSetName", + "documentation" : "ConfigurationSetName" + }, + "EventDestination" : { + "shape" : "EventDestinationDefinition" + }, + "EventDestinationName" : { + "shape" : "__string", + "location" : "uri", + "locationName" : "EventDestinationName", + "documentation" : "EventDestinationName" + } + }, + "documentation" : "UpdateConfigurationSetEventDestinationRequest", + "required" : [ "EventDestinationName", "ConfigurationSetName" ] + }, + "UpdateConfigurationSetEventDestinationResponse" : { + "type" : "structure", + "members" : { }, + "documentation" : "An empty object that indicates that the event destination was updated successfully." + }, + "VoiceMessageContent" : { + "type" : "structure", + "members" : { + "CallInstructionsMessage" : { + "shape" : "CallInstructionsMessageType" + }, + "PlainTextMessage" : { + "shape" : "PlainTextMessageType" + }, + "SSMLMessage" : { + "shape" : "SSMLMessageType" + } + }, + "documentation" : "An object that contains a voice message and information about the recipient that you want to send it to." + }, + "WordCharactersWithDelimiters" : { + "type" : "string" + }, + "__boolean" : { + "type" : "boolean" + }, + "__double" : { + "type" : "double" + }, + "__integer" : { + "type" : "integer" + }, + "__long" : { + "type" : "long" + }, + "__string" : { + "type" : "string" + }, + "__timestampIso8601" : { + "type" : "timestamp", + "timestampFormat" : "iso8601" + }, + "__timestampUnix" : { + "type" : "timestamp", + "timestampFormat" : "unixTimestamp" + } + }, + "documentation" : "Pinpoint SMS and Voice Messaging public facing APIs" +} \ No newline at end of file diff --git a/aws/dist/botocore/data/sms/2016-10-24/examples-1.json b/aws/dist/botocore/data/sms/2016-10-24/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/sms/2016-10-24/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/sms/2016-10-24/paginators-1.json b/aws/dist/botocore/data/sms/2016-10-24/paginators-1.json new file mode 100644 index 00000000..52a8d570 --- /dev/null +++ b/aws/dist/botocore/data/sms/2016-10-24/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "GetReplicationJobs": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "replicationJobList" + }, + "GetReplicationRuns": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "replicationRunList" + }, + "GetConnectors": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "connectorList" + }, + "GetServers": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "serverList" + }, + "ListApps": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "apps" + } + } +} diff --git a/aws/dist/botocore/data/sms/2016-10-24/service-2.json b/aws/dist/botocore/data/sms/2016-10-24/service-2.json new file mode 100644 index 00000000..e4e651fa --- /dev/null +++ b/aws/dist/botocore/data/sms/2016-10-24/service-2.json @@ -0,0 +1,2033 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-10-24", + "endpointPrefix":"sms", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"SMS", + "serviceFullName":"AWS Server Migration Service", + "serviceId":"SMS", + "signatureVersion":"v4", + "targetPrefix":"AWSServerMigrationService_V2016_10_24", + "uid":"sms-2016-10-24" + }, + "operations":{ + "CreateApp":{ + "name":"CreateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAppRequest"}, + "output":{"shape":"CreateAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Creates an application. An application consists of one or more server groups. Each server group contain one or more servers.

    " + }, + "CreateReplicationJob":{ + "name":"CreateReplicationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateReplicationJobRequest"}, + "output":{"shape":"CreateReplicationJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ServerCannotBeReplicatedException"}, + {"shape":"ReplicationJobAlreadyExistsException"}, + {"shape":"NoConnectorsAvailableException"}, + {"shape":"InternalError"}, + {"shape":"TemporarilyUnavailableException"} + ], + "documentation":"

    Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

    " + }, + "DeleteApp":{ + "name":"DeleteApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppRequest"}, + "output":{"shape":"DeleteAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Deletes an existing application. Optionally deletes the launched stack associated with the application and all AWS SMS replication jobs for servers in the application.

    " + }, + "DeleteAppLaunchConfiguration":{ + "name":"DeleteAppLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppLaunchConfigurationRequest"}, + "output":{"shape":"DeleteAppLaunchConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Deletes existing launch configuration for an application.

    " + }, + "DeleteAppReplicationConfiguration":{ + "name":"DeleteAppReplicationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAppReplicationConfigurationRequest"}, + "output":{"shape":"DeleteAppReplicationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Deletes existing replication configuration for an application.

    " + }, + "DeleteReplicationJob":{ + "name":"DeleteReplicationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteReplicationJobRequest"}, + "output":{"shape":"DeleteReplicationJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ReplicationJobNotFoundException"} + ], + "documentation":"

    Deletes the specified replication job.

    After you delete a replication job, there are no further replication runs. AWS deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created by the replication runs are not deleted.

    " + }, + "DeleteServerCatalog":{ + "name":"DeleteServerCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerCatalogRequest"}, + "output":{"shape":"DeleteServerCatalogResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"} + ], + "documentation":"

    Deletes all servers from your server catalog.

    " + }, + "DisassociateConnector":{ + "name":"DisassociateConnector", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateConnectorRequest"}, + "output":{"shape":"DisassociateConnectorResponse"}, + "errors":[ + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Disassociates the specified connector from AWS SMS.

    After you disassociate a connector, it is no longer available to support replication jobs.

    " + }, + "GenerateChangeSet":{ + "name":"GenerateChangeSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateChangeSetRequest"}, + "output":{"shape":"GenerateChangeSetResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Generates a target change set for a currently launched stack and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

    " + }, + "GenerateTemplate":{ + "name":"GenerateTemplate", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GenerateTemplateRequest"}, + "output":{"shape":"GenerateTemplateResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Generates an Amazon CloudFormation template based on the current launch configuration and writes it to an Amazon S3 object in the customer’s Amazon S3 bucket.

    " + }, + "GetApp":{ + "name":"GetApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAppRequest"}, + "output":{"shape":"GetAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Retrieve information about an application.

    " + }, + "GetAppLaunchConfiguration":{ + "name":"GetAppLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAppLaunchConfigurationRequest"}, + "output":{"shape":"GetAppLaunchConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Retrieves the application launch configuration associated with an application.

    " + }, + "GetAppReplicationConfiguration":{ + "name":"GetAppReplicationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAppReplicationConfigurationRequest"}, + "output":{"shape":"GetAppReplicationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Retrieves an application replication configuration associatd with an application.

    " + }, + "GetConnectors":{ + "name":"GetConnectors", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConnectorsRequest"}, + "output":{"shape":"GetConnectorsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"

    Describes the connectors registered with the AWS SMS.

    " + }, + "GetReplicationJobs":{ + "name":"GetReplicationJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReplicationJobsRequest"}, + "output":{"shape":"GetReplicationJobsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"

    Describes the specified replication job or all of your replication jobs.

    " + }, + "GetReplicationRuns":{ + "name":"GetReplicationRuns", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetReplicationRunsRequest"}, + "output":{"shape":"GetReplicationRunsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"

    Describes the replication runs for the specified replication job.

    " + }, + "GetServers":{ + "name":"GetServers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServersRequest"}, + "output":{"shape":"GetServersResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"} + ], + "documentation":"

    Describes the servers in your server catalog.

    Before you can describe your servers, you must import them using ImportServerCatalog.

    " + }, + "ImportServerCatalog":{ + "name":"ImportServerCatalog", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportServerCatalogRequest"}, + "output":{"shape":"ImportServerCatalogResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"NoConnectorsAvailableException"} + ], + "documentation":"

    Gathers a complete list of on-premises servers. Connectors must be installed and monitoring all servers that you want to import.

    This call returns immediately, but might take additional time to retrieve all the servers.

    " + }, + "LaunchApp":{ + "name":"LaunchApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LaunchAppRequest"}, + "output":{"shape":"LaunchAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Launches an application stack.

    " + }, + "ListApps":{ + "name":"ListApps", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAppsRequest"}, + "output":{"shape":"ListAppsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Returns a list of summaries for all applications.

    " + }, + "PutAppLaunchConfiguration":{ + "name":"PutAppLaunchConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAppLaunchConfigurationRequest"}, + "output":{"shape":"PutAppLaunchConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Creates a launch configuration for an application.

    " + }, + "PutAppReplicationConfiguration":{ + "name":"PutAppReplicationConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutAppReplicationConfigurationRequest"}, + "output":{"shape":"PutAppReplicationConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Creates or updates a replication configuration for an application.

    " + }, + "StartAppReplication":{ + "name":"StartAppReplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAppReplicationRequest"}, + "output":{"shape":"StartAppReplicationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Starts replicating an application.

    " + }, + "StartOnDemandReplicationRun":{ + "name":"StartOnDemandReplicationRun", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartOnDemandReplicationRunRequest"}, + "output":{"shape":"StartOnDemandReplicationRunResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"ReplicationRunLimitExceededException"} + ], + "documentation":"

    Starts an on-demand replication run for the specified replication job. This replication run starts immediately. This replication run is in addition to the ones already scheduled.

    There is a limit on the number of on-demand replications runs you can request in a 24-hour period.

    " + }, + "StopAppReplication":{ + "name":"StopAppReplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAppReplicationRequest"}, + "output":{"shape":"StopAppReplicationResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Stops replicating an application.

    " + }, + "TerminateApp":{ + "name":"TerminateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateAppRequest"}, + "output":{"shape":"TerminateAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Terminates the stack for an application.

    " + }, + "UpdateApp":{ + "name":"UpdateApp", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAppRequest"}, + "output":{"shape":"UpdateAppResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"InternalError"}, + {"shape":"OperationNotPermittedException"} + ], + "documentation":"

    Updates an application.

    " + }, + "UpdateReplicationJob":{ + "name":"UpdateReplicationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateReplicationJobRequest"}, + "output":{"shape":"UpdateReplicationJobResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"MissingRequiredParameterException"}, + {"shape":"OperationNotPermittedException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"ServerCannotBeReplicatedException"}, + {"shape":"ReplicationJobNotFoundException"}, + {"shape":"InternalError"}, + {"shape":"TemporarilyUnavailableException"} + ], + "documentation":"

    Updates the specified settings for the specified replication job.

    " + } + }, + "shapes":{ + "AmiId":{"type":"string"}, + "AppDescription":{"type":"string"}, + "AppId":{"type":"string"}, + "AppIds":{ + "type":"list", + "member":{"shape":"AppId"} + }, + "AppLaunchStatus":{ + "type":"string", + "enum":[ + "READY_FOR_CONFIGURATION", + "CONFIGURATION_IN_PROGRESS", + "CONFIGURATION_INVALID", + "READY_FOR_LAUNCH", + "VALIDATION_IN_PROGRESS", + "LAUNCH_PENDING", + "LAUNCH_IN_PROGRESS", + "LAUNCHED", + "DELTA_LAUNCH_IN_PROGRESS", + "DELTA_LAUNCH_FAILED", + "LAUNCH_FAILED", + "TERMINATE_IN_PROGRESS", + "TERMINATE_FAILED", + "TERMINATED" + ] + }, + "AppLaunchStatusMessage":{"type":"string"}, + "AppName":{"type":"string"}, + "AppReplicationStatus":{ + "type":"string", + "enum":[ + "READY_FOR_CONFIGURATION", + "CONFIGURATION_IN_PROGRESS", + "CONFIGURATION_INVALID", + "READY_FOR_REPLICATION", + "VALIDATION_IN_PROGRESS", + "REPLICATION_PENDING", + "REPLICATION_IN_PROGRESS", + "REPLICATED", + "DELTA_REPLICATION_IN_PROGRESS", + "DELTA_REPLICATED", + "DELTA_REPLICATION_FAILED", + "REPLICATION_FAILED", + "REPLICATION_STOPPING", + "REPLICATION_STOP_FAILED", + "REPLICATION_STOPPED" + ] + }, + "AppReplicationStatusMessage":{"type":"string"}, + "AppStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "DELETED", + "DELETE_FAILED" + ] + }, + "AppStatusMessage":{"type":"string"}, + "AppSummary":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    Unique ID of the application.

    " + }, + "name":{ + "shape":"AppName", + "documentation":"

    Name of the application.

    " + }, + "description":{ + "shape":"AppDescription", + "documentation":"

    Description of the application.

    " + }, + "status":{ + "shape":"AppStatus", + "documentation":"

    Status of the application.

    " + }, + "statusMessage":{ + "shape":"AppStatusMessage", + "documentation":"

    A message related to the status of the application

    " + }, + "replicationStatus":{ + "shape":"AppReplicationStatus", + "documentation":"

    Replication status of the application.

    " + }, + "replicationStatusMessage":{ + "shape":"AppReplicationStatusMessage", + "documentation":"

    A message related to the replication status of the application.

    " + }, + "latestReplicationTime":{ + "shape":"Timestamp", + "documentation":"

    Timestamp of the application's most recent successful replication.

    " + }, + "launchStatus":{ + "shape":"AppLaunchStatus", + "documentation":"

    Launch status of the application.

    " + }, + "launchStatusMessage":{ + "shape":"AppLaunchStatusMessage", + "documentation":"

    A message related to the launch status of the application.

    " + }, + "launchDetails":{ + "shape":"LaunchDetails", + "documentation":"

    Details about the latest launch of the application.

    " + }, + "creationTime":{ + "shape":"Timestamp", + "documentation":"

    Time of creation of this application.

    " + }, + "lastModified":{ + "shape":"Timestamp", + "documentation":"

    Timestamp of the application's creation.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    Name of the service role in the customer's account used by AWS SMS.

    " + }, + "totalServerGroups":{ + "shape":"TotalServerGroups", + "documentation":"

    Number of server groups present in the application.

    " + }, + "totalServers":{ + "shape":"TotalServers", + "documentation":"

    Number of servers present in the application.

    " + } + }, + "documentation":"

    Information about the application.

    " + }, + "Apps":{ + "type":"list", + "member":{"shape":"AppSummary"} + }, + "AssociatePublicIpAddress":{"type":"boolean"}, + "BucketName":{"type":"string"}, + "ClientToken":{"type":"string"}, + "Connector":{ + "type":"structure", + "members":{ + "connectorId":{ + "shape":"ConnectorId", + "documentation":"

    The identifier of the connector.

    " + }, + "version":{ + "shape":"ConnectorVersion", + "documentation":"

    The connector version.

    " + }, + "status":{ + "shape":"ConnectorStatus", + "documentation":"

    The status of the connector.

    " + }, + "capabilityList":{ + "shape":"ConnectorCapabilityList", + "documentation":"

    The capabilities of the connector.

    " + }, + "vmManagerName":{ + "shape":"VmManagerName", + "documentation":"

    The name of the VM manager.

    " + }, + "vmManagerType":{ + "shape":"VmManagerType", + "documentation":"

    The VM management product.

    " + }, + "vmManagerId":{ + "shape":"VmManagerId", + "documentation":"

    The identifier of the VM manager.

    " + }, + "ipAddress":{ + "shape":"IpAddress", + "documentation":"

    The IP address of the connector.

    " + }, + "macAddress":{ + "shape":"MacAddress", + "documentation":"

    The MAC address of the connector.

    " + }, + "associatedOn":{ + "shape":"Timestamp", + "documentation":"

    The time the connector was associated.

    " + } + }, + "documentation":"

    Represents a connector.

    " + }, + "ConnectorCapability":{ + "type":"string", + "enum":[ + "VSPHERE", + "SCVMM", + "HYPERV-MANAGER", + "SNAPSHOT_BATCHING" + ] + }, + "ConnectorCapabilityList":{ + "type":"list", + "member":{"shape":"ConnectorCapability"} + }, + "ConnectorId":{"type":"string"}, + "ConnectorList":{ + "type":"list", + "member":{"shape":"Connector"} + }, + "ConnectorStatus":{ + "type":"string", + "enum":[ + "HEALTHY", + "UNHEALTHY" + ] + }, + "ConnectorVersion":{"type":"string"}, + "CreateAppRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"AppName", + "documentation":"

    Name of the new application.

    " + }, + "description":{ + "shape":"AppDescription", + "documentation":"

    Description of the new application

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    Name of service role in customer's account to be used by AWS SMS.

    " + }, + "clientToken":{ + "shape":"ClientToken", + "documentation":"

    A unique, case-sensitive identifier you provide to ensure idempotency of application creation.

    " + }, + "serverGroups":{ + "shape":"ServerGroups", + "documentation":"

    List of server groups to include in the application.

    " + }, + "tags":{ + "shape":"Tags", + "documentation":"

    List of tags to be associated with the application.

    " + } + } + }, + "CreateAppResponse":{ + "type":"structure", + "members":{ + "appSummary":{ + "shape":"AppSummary", + "documentation":"

    Summary description of the application.

    " + }, + "serverGroups":{ + "shape":"ServerGroups", + "documentation":"

    List of server groups included in the application.

    " + }, + "tags":{ + "shape":"Tags", + "documentation":"

    List of taags associated with the application.

    " + } + } + }, + "CreateReplicationJobRequest":{ + "type":"structure", + "required":[ + "serverId", + "seedReplicationTime" + ], + "members":{ + "serverId":{ + "shape":"ServerId", + "documentation":"

    The identifier of the server.

    " + }, + "seedReplicationTime":{ + "shape":"Timestamp", + "documentation":"

    The seed replication time.

    " + }, + "frequency":{ + "shape":"Frequency", + "documentation":"

    The time between consecutive replication runs, in hours.

    " + }, + "runOnce":{ + "shape":"RunOnce", + "documentation":"

    " + }, + "licenseType":{ + "shape":"LicenseType", + "documentation":"

    The license type to be used for the AMI created by a successful replication run.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    The name of the IAM role to be used by the AWS SMS.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the replication job.

    " + }, + "numberOfRecentAmisToKeep":{ + "shape":"NumberOfRecentAmisToKeep", + "documentation":"

    The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

    " + }, + "encrypted":{ + "shape":"Encrypted", + "documentation":"

    When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

    " + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to KMS key ID

    • ARN referring to KMS key alias

    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

    " + } + } + }, + "CreateReplicationJobResponse":{ + "type":"structure", + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The unique identifier of the replication job.

    " + } + } + }, + "DeleteAppLaunchConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the launch configuration.

    " + } + } + }, + "DeleteAppLaunchConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAppReplicationConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the replication configuration.

    " + } + } + }, + "DeleteAppReplicationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAppRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to delete.

    " + }, + "forceStopAppReplication":{ + "shape":"ForceStopAppReplication", + "documentation":"

    While deleting the application, stop all replication jobs corresponding to the servers in the application.

    " + }, + "forceTerminateApp":{ + "shape":"ForceTerminateApp", + "documentation":"

    While deleting the application, terminate the stack corresponding to the application.

    " + } + } + }, + "DeleteAppResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteReplicationJobRequest":{ + "type":"structure", + "required":["replicationJobId"], + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + } + } + }, + "DeleteReplicationJobResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteServerCatalogRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteServerCatalogResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{"type":"string"}, + "DisassociateConnectorRequest":{ + "type":"structure", + "required":["connectorId"], + "members":{ + "connectorId":{ + "shape":"ConnectorId", + "documentation":"

    The identifier of the connector.

    " + } + } + }, + "DisassociateConnectorResponse":{ + "type":"structure", + "members":{ + } + }, + "EC2KeyName":{"type":"string"}, + "Encrypted":{"type":"boolean"}, + "ErrorMessage":{"type":"string"}, + "ForceStopAppReplication":{"type":"boolean"}, + "ForceTerminateApp":{"type":"boolean"}, + "Frequency":{"type":"integer"}, + "GenerateChangeSetRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the change set.

    " + }, + "changesetFormat":{ + "shape":"OutputFormat", + "documentation":"

    Format for the change set.

    " + } + } + }, + "GenerateChangeSetResponse":{ + "type":"structure", + "members":{ + "s3Location":{ + "shape":"S3Location", + "documentation":"

    Location of the Amazon S3 object.

    " + } + } + }, + "GenerateTemplateRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the Amazon CloudFormation template.

    " + }, + "templateFormat":{ + "shape":"OutputFormat", + "documentation":"

    Format for generating the Amazon CloudFormation template.

    " + } + } + }, + "GenerateTemplateResponse":{ + "type":"structure", + "members":{ + "s3Location":{ + "shape":"S3Location", + "documentation":"

    Location of the Amazon S3 object.

    " + } + } + }, + "GetAppLaunchConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application launch configuration.

    " + } + } + }, + "GetAppLaunchConfigurationResponse":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the launch configuration.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    Name of the service role in the customer's account that Amazon CloudFormation uses to launch the application.

    " + }, + "serverGroupLaunchConfigurations":{ + "shape":"ServerGroupLaunchConfigurations", + "documentation":"

    List of launch configurations for server groups in this application.

    " + } + } + }, + "GetAppReplicationConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the replication configuration.

    " + } + } + }, + "GetAppReplicationConfigurationResponse":{ + "type":"structure", + "members":{ + "serverGroupReplicationConfigurations":{ + "shape":"ServerGroupReplicationConfigurations", + "documentation":"

    Replication configurations associated with server groups in this application.

    " + } + } + }, + "GetAppRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application whose information is being retrieved.

    " + } + } + }, + "GetAppResponse":{ + "type":"structure", + "members":{ + "appSummary":{ + "shape":"AppSummary", + "documentation":"

    Information about the application.

    " + }, + "serverGroups":{ + "shape":"ServerGroups", + "documentation":"

    List of server groups belonging to the application.

    " + }, + "tags":{ + "shape":"Tags", + "documentation":"

    List of tags associated with the application.

    " + } + } + }, + "GetConnectorsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

    " + } + } + }, + "GetConnectorsResponse":{ + "type":"structure", + "members":{ + "connectorList":{ + "shape":"ConnectorList", + "documentation":"

    Information about the registered connectors.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token required to retrieve the next set of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetReplicationJobsRequest":{ + "type":"structure", + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

    " + } + } + }, + "GetReplicationJobsResponse":{ + "type":"structure", + "members":{ + "replicationJobList":{ + "shape":"ReplicationJobList", + "documentation":"

    Information about the replication jobs.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token required to retrieve the next set of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetReplicationRunsRequest":{ + "type":"structure", + "required":["replicationJobId"], + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

    " + } + } + }, + "GetReplicationRunsResponse":{ + "type":"structure", + "members":{ + "replicationJob":{ + "shape":"ReplicationJob", + "documentation":"

    Information about the replication job.

    " + }, + "replicationRunList":{ + "shape":"ReplicationRunList", + "documentation":"

    Information about the replication runs.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token required to retrieve the next set of results. This value is null when there are no more results to return.

    " + } + } + }, + "GetServersRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

    " + }, + "vmServerAddressList":{ + "shape":"VmServerAddressList", + "documentation":"

    List of VmServerAddress objects

    " + } + } + }, + "GetServersResponse":{ + "type":"structure", + "members":{ + "lastModifiedOn":{ + "shape":"Timestamp", + "documentation":"

    The time when the server was last modified.

    " + }, + "serverCatalogStatus":{ + "shape":"ServerCatalogStatus", + "documentation":"

    The status of the server catalog.

    " + }, + "serverList":{ + "shape":"ServerList", + "documentation":"

    Information about the servers.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token required to retrieve the next set of results. This value is null when there are no more results to return.

    " + } + } + }, + "ImportServerCatalogRequest":{ + "type":"structure", + "members":{ + } + }, + "ImportServerCatalogResponse":{ + "type":"structure", + "members":{ + } + }, + "InstanceType":{"type":"string"}, + "InternalError":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    An internal error occurred.

    ", + "exception":true, + "fault":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A specified parameter is not valid.

    ", + "exception":true + }, + "IpAddress":{"type":"string"}, + "KeyName":{"type":"string"}, + "KmsKeyId":{"type":"string"}, + "LaunchAppRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to launch.

    " + } + } + }, + "LaunchAppResponse":{ + "type":"structure", + "members":{ + } + }, + "LaunchDetails":{ + "type":"structure", + "members":{ + "latestLaunchTime":{ + "shape":"Timestamp", + "documentation":"

    Latest time this application was launched successfully.

    " + }, + "stackName":{ + "shape":"StackName", + "documentation":"

    Name of the latest stack launched for this application.

    " + }, + "stackId":{ + "shape":"StackId", + "documentation":"

    Identifier of the latest stack launched for this application.

    " + } + }, + "documentation":"

    Details about the latest launch of an application.

    " + }, + "LaunchOrder":{"type":"integer"}, + "LicenseType":{ + "type":"string", + "enum":[ + "AWS", + "BYOL" + ] + }, + "ListAppsRequest":{ + "type":"structure", + "members":{ + "appIds":{ + "shape":"AppIds", + "documentation":"

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of results.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call. The default value is 50. To retrieve the remaining results, make another call with the returned NextToken value.

    " + } + } + }, + "ListAppsResponse":{ + "type":"structure", + "members":{ + "apps":{ + "shape":"Apps", + "documentation":"

    A list of application summaries.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    The token required to retrieve the next set of results. This value is null when there are no more results to return.

    " + } + } + }, + "LogicalId":{"type":"string"}, + "MacAddress":{"type":"string"}, + "MaxResults":{"type":"integer"}, + "MissingRequiredParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A required parameter is missing.

    ", + "exception":true + }, + "NextToken":{"type":"string"}, + "NoConnectorsAvailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    There are no connectors available.

    ", + "exception":true + }, + "NumberOfRecentAmisToKeep":{"type":"integer"}, + "OperationNotPermittedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    This operation is not allowed.

    ", + "exception":true + }, + "OutputFormat":{ + "type":"string", + "enum":[ + "JSON", + "YAML" + ] + }, + "PutAppLaunchConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application associated with the launch configuration.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    Name of service role in the customer's account that Amazon CloudFormation uses to launch the application.

    " + }, + "serverGroupLaunchConfigurations":{ + "shape":"ServerGroupLaunchConfigurations", + "documentation":"

    Launch configurations for server groups in the application.

    " + } + } + }, + "PutAppLaunchConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "PutAppReplicationConfigurationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application tassociated with the replication configuration.

    " + }, + "serverGroupReplicationConfigurations":{ + "shape":"ServerGroupReplicationConfigurations", + "documentation":"

    Replication configurations for server groups in the application.

    " + } + } + }, + "PutAppReplicationConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "ReplicationJob":{ + "type":"structure", + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "serverId":{ + "shape":"ServerId", + "documentation":"

    The identifier of the server.

    " + }, + "serverType":{ + "shape":"ServerType", + "documentation":"

    The type of server.

    " + }, + "vmServer":{ + "shape":"VmServer", + "documentation":"

    Information about the VM server.

    " + }, + "seedReplicationTime":{ + "shape":"Timestamp", + "documentation":"

    The seed replication time.

    " + }, + "frequency":{ + "shape":"Frequency", + "documentation":"

    The time between consecutive replication runs, in hours.

    " + }, + "runOnce":{ + "shape":"RunOnce", + "documentation":"

    " + }, + "nextReplicationRunStartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the next replication run.

    " + }, + "licenseType":{ + "shape":"LicenseType", + "documentation":"

    The license type to be used for the AMI created by a successful replication run.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    The name of the IAM role to be used by the Server Migration Service.

    " + }, + "latestAmiId":{ + "shape":"AmiId", + "documentation":"

    The ID of the latest Amazon Machine Image (AMI).

    " + }, + "state":{ + "shape":"ReplicationJobState", + "documentation":"

    The state of the replication job.

    " + }, + "statusMessage":{ + "shape":"ReplicationJobStatusMessage", + "documentation":"

    The description of the current status of the replication job.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the replication job.

    " + }, + "numberOfRecentAmisToKeep":{ + "shape":"NumberOfRecentAmisToKeep", + "documentation":"

    Number of recent AMIs to keep in the customer's account for a replication job. By default the value is set to zero, meaning that all AMIs are kept.

    " + }, + "encrypted":{ + "shape":"Encrypted", + "documentation":"

    Whether the replication job should produce encrypted AMIs or not. See also KmsKeyId below.

    " + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to KMS key ID

    • ARN referring to KMS key alias

    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

    " + }, + "replicationRunList":{ + "shape":"ReplicationRunList", + "documentation":"

    Information about the replication runs.

    " + } + }, + "documentation":"

    Represents a replication job.

    " + }, + "ReplicationJobAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified replication job already exists.

    ", + "exception":true + }, + "ReplicationJobId":{"type":"string"}, + "ReplicationJobList":{ + "type":"list", + "member":{"shape":"ReplicationJob"} + }, + "ReplicationJobNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified replication job does not exist.

    ", + "exception":true + }, + "ReplicationJobState":{ + "type":"string", + "enum":[ + "PENDING", + "ACTIVE", + "FAILED", + "DELETING", + "DELETED", + "COMPLETED", + "PAUSED_ON_FAILURE", + "FAILING" + ] + }, + "ReplicationJobStatusMessage":{"type":"string"}, + "ReplicationJobTerminated":{"type":"boolean"}, + "ReplicationRun":{ + "type":"structure", + "members":{ + "replicationRunId":{ + "shape":"ReplicationRunId", + "documentation":"

    The identifier of the replication run.

    " + }, + "state":{ + "shape":"ReplicationRunState", + "documentation":"

    The state of the replication run.

    " + }, + "type":{ + "shape":"ReplicationRunType", + "documentation":"

    The type of replication run.

    " + }, + "stageDetails":{ + "shape":"ReplicationRunStageDetails", + "documentation":"

    Details of the current stage of the replication run.

    " + }, + "statusMessage":{ + "shape":"ReplicationRunStatusMessage", + "documentation":"

    The description of the current status of the replication job.

    " + }, + "amiId":{ + "shape":"AmiId", + "documentation":"

    The identifier of the Amazon Machine Image (AMI) from the replication run.

    " + }, + "scheduledStartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the next replication run.

    " + }, + "completedTime":{ + "shape":"Timestamp", + "documentation":"

    The completion time of the last replication run.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the replication run.

    " + }, + "encrypted":{ + "shape":"Encrypted", + "documentation":"

    Whether the replication run should produce encrypted AMI or not. See also KmsKeyId below.

    " + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to KMS key ID

    • ARN referring to KMS key alias

    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

    " + } + }, + "documentation":"

    Represents a replication run.

    " + }, + "ReplicationRunId":{"type":"string"}, + "ReplicationRunLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You have exceeded the number of on-demand replication runs you can request in a 24-hour period.

    ", + "exception":true + }, + "ReplicationRunList":{ + "type":"list", + "member":{"shape":"ReplicationRun"} + }, + "ReplicationRunStage":{"type":"string"}, + "ReplicationRunStageDetails":{ + "type":"structure", + "members":{ + "stage":{ + "shape":"ReplicationRunStage", + "documentation":"

    String describing the current stage of a replication run.

    " + }, + "stageProgress":{ + "shape":"ReplicationRunStageProgress", + "documentation":"

    String describing the progress of the current stage of a replication run.

    " + } + }, + "documentation":"

    Details of the current stage of a replication run.

    " + }, + "ReplicationRunStageProgress":{"type":"string"}, + "ReplicationRunState":{ + "type":"string", + "enum":[ + "PENDING", + "MISSED", + "ACTIVE", + "FAILED", + "COMPLETED", + "DELETING", + "DELETED" + ] + }, + "ReplicationRunStatusMessage":{"type":"string"}, + "ReplicationRunType":{ + "type":"string", + "enum":[ + "ON_DEMAND", + "AUTOMATIC" + ] + }, + "RoleName":{"type":"string"}, + "RunOnce":{"type":"boolean"}, + "S3Location":{ + "type":"structure", + "members":{ + "bucket":{ + "shape":"BucketName", + "documentation":"

    Amazon S3 bucket name.

    " + }, + "key":{ + "shape":"KeyName", + "documentation":"

    Amazon S3 bucket key.

    " + } + }, + "documentation":"

    Location of the Amazon S3 object in the customer's account.

    " + }, + "SecurityGroup":{"type":"string"}, + "Server":{ + "type":"structure", + "members":{ + "serverId":{ + "shape":"ServerId", + "documentation":"

    The identifier of the server.

    " + }, + "serverType":{ + "shape":"ServerType", + "documentation":"

    The type of server.

    " + }, + "vmServer":{ + "shape":"VmServer", + "documentation":"

    Information about the VM server.

    " + }, + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "replicationJobTerminated":{ + "shape":"ReplicationJobTerminated", + "documentation":"

    Indicates whether the replication job is deleted or failed.

    " + } + }, + "documentation":"

    Represents a server.

    " + }, + "ServerCannotBeReplicatedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified server cannot be replicated.

    ", + "exception":true + }, + "ServerCatalogStatus":{ + "type":"string", + "enum":[ + "NOT_IMPORTED", + "IMPORTING", + "AVAILABLE", + "DELETED", + "EXPIRED" + ] + }, + "ServerGroup":{ + "type":"structure", + "members":{ + "serverGroupId":{ + "shape":"ServerGroupId", + "documentation":"

    Identifier of a server group.

    " + }, + "name":{ + "shape":"ServerGroupName", + "documentation":"

    Name of a server group.

    " + }, + "serverList":{ + "shape":"ServerList", + "documentation":"

    List of servers belonging to a server group.

    " + } + }, + "documentation":"

    A logical grouping of servers.

    " + }, + "ServerGroupId":{"type":"string"}, + "ServerGroupLaunchConfiguration":{ + "type":"structure", + "members":{ + "serverGroupId":{ + "shape":"ServerGroupId", + "documentation":"

    Identifier of the server group the launch configuration is associated with.

    " + }, + "launchOrder":{ + "shape":"LaunchOrder", + "documentation":"

    Launch order of servers in the server group.

    " + }, + "serverLaunchConfigurations":{ + "shape":"ServerLaunchConfigurations", + "documentation":"

    Launch configuration for servers in the server group.

    " + } + }, + "documentation":"

    Launch configuration for a server group.

    " + }, + "ServerGroupLaunchConfigurations":{ + "type":"list", + "member":{"shape":"ServerGroupLaunchConfiguration"} + }, + "ServerGroupName":{"type":"string"}, + "ServerGroupReplicationConfiguration":{ + "type":"structure", + "members":{ + "serverGroupId":{ + "shape":"ServerGroupId", + "documentation":"

    Identifier of the server group this replication configuration is associated with.

    " + }, + "serverReplicationConfigurations":{ + "shape":"ServerReplicationConfigurations", + "documentation":"

    Replication configuration for servers in the server group.

    " + } + }, + "documentation":"

    Replication configuration for a server group.

    " + }, + "ServerGroupReplicationConfigurations":{ + "type":"list", + "member":{"shape":"ServerGroupReplicationConfiguration"} + }, + "ServerGroups":{ + "type":"list", + "member":{"shape":"ServerGroup"} + }, + "ServerId":{"type":"string"}, + "ServerLaunchConfiguration":{ + "type":"structure", + "members":{ + "server":{ + "shape":"Server", + "documentation":"

    Identifier of the server the launch configuration is associated with.

    " + }, + "logicalId":{ + "shape":"LogicalId", + "documentation":"

    Logical ID of the server in the Amazon CloudFormation template.

    " + }, + "vpc":{ + "shape":"VPC", + "documentation":"

    Identifier of the VPC the server should be launched into.

    " + }, + "subnet":{ + "shape":"Subnet", + "documentation":"

    Identifier of the subnet the server should be launched into.

    " + }, + "securityGroup":{ + "shape":"SecurityGroup", + "documentation":"

    Identifier of the security group that applies to the launched server.

    " + }, + "ec2KeyName":{ + "shape":"EC2KeyName", + "documentation":"

    Name of the EC2 SSH Key to be used for connecting to the launched server.

    " + }, + "userData":{ + "shape":"UserData", + "documentation":"

    Location of the user-data script to be executed when launching the server.

    " + }, + "instanceType":{ + "shape":"InstanceType", + "documentation":"

    Instance type to be used for launching the server.

    " + }, + "associatePublicIpAddress":{ + "shape":"AssociatePublicIpAddress", + "documentation":"

    If true, a publicly accessible IP address is created when launching the server.

    " + } + }, + "documentation":"

    Launch configuration for a server.

    " + }, + "ServerLaunchConfigurations":{ + "type":"list", + "member":{"shape":"ServerLaunchConfiguration"} + }, + "ServerList":{ + "type":"list", + "member":{"shape":"Server"} + }, + "ServerReplicationConfiguration":{ + "type":"structure", + "members":{ + "server":{ + "shape":"Server", + "documentation":"

    Identifier of the server this replication configuration is associated with.

    " + }, + "serverReplicationParameters":{ + "shape":"ServerReplicationParameters", + "documentation":"

    Parameters for replicating the server.

    " + } + }, + "documentation":"

    Replication configuration of a server.

    " + }, + "ServerReplicationConfigurations":{ + "type":"list", + "member":{"shape":"ServerReplicationConfiguration"} + }, + "ServerReplicationParameters":{ + "type":"structure", + "members":{ + "seedTime":{ + "shape":"Timestamp", + "documentation":"

    Seed time for creating a replication job for the server.

    " + }, + "frequency":{ + "shape":"Frequency", + "documentation":"

    Frequency of creating replication jobs for the server.

    " + }, + "runOnce":{ + "shape":"RunOnce", + "documentation":"

    " + }, + "licenseType":{ + "shape":"LicenseType", + "documentation":"

    License type for creating a replication job for the server.

    " + }, + "numberOfRecentAmisToKeep":{ + "shape":"NumberOfRecentAmisToKeep", + "documentation":"

    Number of recent AMIs to keep when creating a replication job for this server.

    " + }, + "encrypted":{ + "shape":"Encrypted", + "documentation":"

    When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

    " + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to KMS key ID

    • ARN referring to KMS key alias

    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

    " + } + }, + "documentation":"

    Replication parameters for replicating a server.

    " + }, + "ServerType":{ + "type":"string", + "enum":["VIRTUAL_MACHINE"] + }, + "StackId":{"type":"string"}, + "StackName":{"type":"string"}, + "StartAppReplicationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to replicate.

    " + } + } + }, + "StartAppReplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "StartOnDemandReplicationRunRequest":{ + "type":"structure", + "required":["replicationJobId"], + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the replication run.

    " + } + } + }, + "StartOnDemandReplicationRunResponse":{ + "type":"structure", + "members":{ + "replicationRunId":{ + "shape":"ReplicationRunId", + "documentation":"

    The identifier of the replication run.

    " + } + } + }, + "StopAppReplicationRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to stop replicating.

    " + } + } + }, + "StopAppReplicationResponse":{ + "type":"structure", + "members":{ + } + }, + "Subnet":{"type":"string"}, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

    Tag key.

    " + }, + "value":{ + "shape":"TagValue", + "documentation":"

    Tag value.

    " + } + }, + "documentation":"

    A label that can be assigned to an application.

    " + }, + "TagKey":{"type":"string"}, + "TagValue":{"type":"string"}, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TemporarilyUnavailableException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The service is temporarily unavailable.

    ", + "exception":true, + "fault":true + }, + "TerminateAppRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to terminate.

    " + } + } + }, + "TerminateAppResponse":{ + "type":"structure", + "members":{ + } + }, + "Timestamp":{"type":"timestamp"}, + "TotalServerGroups":{"type":"integer"}, + "TotalServers":{"type":"integer"}, + "UnauthorizedOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You lack permissions needed to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

    ", + "exception":true + }, + "UpdateAppRequest":{ + "type":"structure", + "members":{ + "appId":{ + "shape":"AppId", + "documentation":"

    ID of the application to update.

    " + }, + "name":{ + "shape":"AppName", + "documentation":"

    New name of the application.

    " + }, + "description":{ + "shape":"AppDescription", + "documentation":"

    New description of the application.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    Name of the service role in the customer's account used by AWS SMS.

    " + }, + "serverGroups":{ + "shape":"ServerGroups", + "documentation":"

    List of server groups in the application to update.

    " + }, + "tags":{ + "shape":"Tags", + "documentation":"

    List of tags to associate with the application.

    " + } + } + }, + "UpdateAppResponse":{ + "type":"structure", + "members":{ + "appSummary":{ + "shape":"AppSummary", + "documentation":"

    Summary description of the application.

    " + }, + "serverGroups":{ + "shape":"ServerGroups", + "documentation":"

    List of updated server groups in the application.

    " + }, + "tags":{ + "shape":"Tags", + "documentation":"

    List of tags associated with the application.

    " + } + } + }, + "UpdateReplicationJobRequest":{ + "type":"structure", + "required":["replicationJobId"], + "members":{ + "replicationJobId":{ + "shape":"ReplicationJobId", + "documentation":"

    The identifier of the replication job.

    " + }, + "frequency":{ + "shape":"Frequency", + "documentation":"

    The time between consecutive replication runs, in hours.

    " + }, + "nextReplicationRunStartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the next replication run.

    " + }, + "licenseType":{ + "shape":"LicenseType", + "documentation":"

    The license type to be used for the AMI created by a successful replication run.

    " + }, + "roleName":{ + "shape":"RoleName", + "documentation":"

    The name of the IAM role to be used by AWS SMS.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the replication job.

    " + }, + "numberOfRecentAmisToKeep":{ + "shape":"NumberOfRecentAmisToKeep", + "documentation":"

    The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

    " + }, + "encrypted":{ + "shape":"Encrypted", + "documentation":"

    When true, the replication job produces encrypted AMIs . See also KmsKeyId below.

    " + }, + "kmsKeyId":{ + "shape":"KmsKeyId", + "documentation":"

    KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

    • KMS key ID

    • KMS key alias

    • ARN referring to KMS key ID

    • ARN referring to KMS key alias

    If encrypted is true but a KMS key id is not specified, the customer's default KMS key for EBS is used.

    " + } + } + }, + "UpdateReplicationJobResponse":{ + "type":"structure", + "members":{ + } + }, + "UserData":{ + "type":"structure", + "members":{ + "s3Location":{ + "shape":"S3Location", + "documentation":"

    Amazon S3 location of the user-data script.

    " + } + }, + "documentation":"

    A script that runs on first launch of an Amazon EC2 instance. Used for configuring the server during launch.

    " + }, + "VPC":{"type":"string"}, + "VmId":{"type":"string"}, + "VmManagerId":{"type":"string"}, + "VmManagerName":{"type":"string"}, + "VmManagerType":{ + "type":"string", + "enum":[ + "VSPHERE", + "SCVMM", + "HYPERV-MANAGER" + ] + }, + "VmName":{"type":"string"}, + "VmPath":{"type":"string"}, + "VmServer":{ + "type":"structure", + "members":{ + "vmServerAddress":{ + "shape":"VmServerAddress", + "documentation":"

    Information about the VM server location.

    " + }, + "vmName":{ + "shape":"VmName", + "documentation":"

    The name of the VM.

    " + }, + "vmManagerName":{ + "shape":"VmManagerName", + "documentation":"

    The name of the VM manager.

    " + }, + "vmManagerType":{ + "shape":"VmManagerType", + "documentation":"

    The type of VM management product.

    " + }, + "vmPath":{ + "shape":"VmPath", + "documentation":"

    The VM folder path in the vCenter Server virtual machine inventory tree.

    " + } + }, + "documentation":"

    Represents a VM server.

    " + }, + "VmServerAddress":{ + "type":"structure", + "members":{ + "vmManagerId":{ + "shape":"VmManagerId", + "documentation":"

    The identifier of the VM manager.

    " + }, + "vmId":{ + "shape":"VmId", + "documentation":"

    The identifier of the VM.

    " + } + }, + "documentation":"

    Represents a VM server location.

    " + }, + "VmServerAddressList":{ + "type":"list", + "member":{"shape":"VmServerAddress"} + } + }, + "documentation":"AAWS Sever Migration Service

    This is the AWS Sever Migration Service API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types for the AWS Sever Migration Service (AWS SMS). The topic for each action shows the Query API request parameters and the XML response. You can also view the XML request elements in the WSDL.

    Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

    To learn more about the Server Migration Service, see the following resources:

    " +} diff --git a/aws/dist/botocore/data/snowball/2016-06-30/examples-1.json b/aws/dist/botocore/data/snowball/2016-06-30/examples-1.json new file mode 100644 index 00000000..9d699718 --- /dev/null +++ b/aws/dist/botocore/data/snowball/2016-06-30/examples-1.json @@ -0,0 +1,442 @@ +{ + "version": "1.0", + "examples": { + "CancelCluster": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.", + "id": "to-cancel-a-cluster-job-1482533760554", + "title": "To cancel a cluster job" + } + ], + "CancelJob": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "This operation cancels a job. You can only cancel a job before its JobState value changes to PreparingAppliance.", + "id": "to-cancel-a-job-for-a-snowball-device-1482534699477", + "title": "To cancel a job for a Snowball device" + } + ], + "CreateAddress": [ + { + "input": { + "Address": { + "City": "Seattle", + "Company": "My Company's Name", + "Country": "USA", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + }, + "output": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b" + }, + "comments": { + }, + "description": "This operation creates an address for a job. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.", + "id": "to-create-an-address-for-a-job-1482535416294", + "title": "To create an address for a job" + } + ], + "CreateCluster": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "MyCluster", + "JobType": "LOCAL_USE", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY", + "SnowballType": "EDGE" + }, + "output": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.", + "id": "to-create-a-cluster-1482864724077", + "title": "To create a cluster" + } + ], + "CreateJob": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "My Job", + "JobType": "IMPORT", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY", + "SnowballCapacityPreference": "T80", + "SnowballType": "STANDARD" + }, + "output": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "comments": { + }, + "description": "Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.", + "id": "to-create-a-job-1482864834886", + "title": "To create a job" + } + ], + "DescribeAddress": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b" + }, + "output": { + "Address": { + "AddressId": "ADID5643ec50-3eec-4eb3-9be6-9374c10eb51b", + "City": "Seattle", + "Company": "My Company", + "Country": "US", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + }, + "comments": { + }, + "description": "This operation describes an address for a job.", + "id": "to-describe-an-address-for-a-job-1482538608745", + "title": "To describe an address for a job" + } + ], + "DescribeAddresses": [ + { + "input": { + }, + "output": { + "Addresses": [ + { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "City": "Seattle", + "Company": "My Company", + "Country": "US", + "Name": "My Name", + "PhoneNumber": "425-555-5555", + "PostalCode": "98101", + "StateOrProvince": "WA", + "Street1": "123 Main Street" + } + ] + }, + "comments": { + }, + "description": "This operation describes all the addresses that you've created for AWS Snowball. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.", + "id": "to-describe-all-the-addresses-youve-created-for-aws-snowball-1482538936603", + "title": "To describe all the addresses you've created for AWS Snowball" + } + ], + "DescribeCluster": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "ClusterMetadata": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "ClusterState": "Pending", + "CreationDate": "1480475517.0", + "Description": "MyCluster", + "JobType": "LOCAL_USE", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingOption": "SECOND_DAY" + } + }, + "comments": { + }, + "description": "Returns information about a specific cluster including shipping information, cluster status, and other important metadata.", + "id": "to-describe-a-cluster-1482864218396", + "title": "To describe a cluster" + } + ], + "DescribeJob": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "JobMetadata": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "CreationDate": "1475626164", + "Description": "My Job", + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "IMPORT", + "KmsKeyARN": "arn:aws:kms:us-east-1:123456789012:key/abcd1234-12ab-34cd-56ef-123456123456", + "Notification": { + "JobStatesToNotify": [ + + ], + "NotifyAll": false + }, + "Resources": { + "S3Resources": [ + { + "BucketArn": "arn:aws:s3:::MyBucket", + "KeyRange": { + } + } + ] + }, + "RoleARN": "arn:aws:iam::123456789012:role/snowball-import-S3-role", + "ShippingDetails": { + "ShippingOption": "SECOND_DAY" + }, + "SnowballCapacityPreference": "T80", + "SnowballType": "STANDARD" + } + }, + "comments": { + }, + "description": "This operation describes a job you've created for AWS Snowball.", + "id": "to-describe-a-job-youve-created-for-aws-snowball-1482539500180", + "title": "To describe a job you've created for AWS Snowball" + } + ], + "GetJobManifest": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "ManifestURI": "https://awsie-frosty-manifests-prod.s3.amazonaws.com/JID123e4567-e89b-12d3-a456-426655440000_manifest.bin?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20161224T005115Z&X-Amz-SignedHeaders=..." + }, + "comments": { + }, + "description": "Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.\n\nThe manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.\n\nAs a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.\n\nThe credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.", + "id": "to-get-the-manifest-for-a-job-youve-created-for-aws-snowball-1482540389246", + "title": "To get the manifest for a job you've created for AWS Snowball" + } + ], + "GetJobUnlockCode": [ + { + "input": { + "JobId": "JID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "UnlockCode": "12345-abcde-56789-fghij-01234" + }, + "comments": { + }, + "description": "Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.\n\nThe UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.\n\nAs a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.", + "id": "to-get-the-unlock-code-for-a-job-youve-created-for-aws-snowball-1482541987286", + "title": "To get the unlock code for a job you've created for AWS Snowball" + } + ], + "GetSnowballUsage": [ + { + "input": { + }, + "output": { + "SnowballLimit": 1, + "SnowballsInUse": 0 + }, + "comments": { + }, + "description": "Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.\n\nThe default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.", + "id": "to-see-your-snowball-service-limit-and-the-number-of-snowballs-you-have-in-use-1482863394588", + "title": "To see your Snowball service limit and the number of Snowballs you have in use" + } + ], + "ListClusterJobs": [ + { + "input": { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000" + }, + "output": { + "JobListEntries": [ + { + "CreationDate": "1480475524.0", + "Description": "MyClustrer-node-001", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-002", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440001", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-003", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440002", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-004", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440003", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + }, + { + "CreationDate": "1480475525.0", + "Description": "MyClustrer-node-005", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440004", + "JobState": "New", + "JobType": "LOCAL_USE", + "SnowballType": "EDGE" + } + ] + }, + "comments": { + }, + "description": "Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.", + "id": "to-get-a-list-of-jobs-in-a-cluster-that-youve-created-for-aws-snowball-1482863105773", + "title": "To get a list of jobs in a cluster that you've created for AWS Snowball" + } + ], + "ListClusters": [ + { + "input": { + }, + "output": { + "ClusterListEntries": [ + { + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "ClusterState": "Pending", + "CreationDate": "1480475517.0", + "Description": "MyCluster" + } + ] + }, + "comments": { + }, + "description": "Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.", + "id": "to-get-a-list-of-clusters-that-youve-created-for-aws-snowball-1482862223003", + "title": "To get a list of clusters that you've created for AWS Snowball" + } + ], + "ListJobs": [ + { + "input": { + }, + "output": { + "JobListEntries": [ + { + "CreationDate": "1460678186.0", + "Description": "MyJob", + "IsMaster": false, + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "JobState": "New", + "JobType": "IMPORT", + "SnowballType": "STANDARD" + } + ] + }, + "comments": { + }, + "description": "Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.", + "id": "to-get-a-list-of-jobs-that-youve-created-for-aws-snowball-1482542167627", + "title": "To get a list of jobs that you've created for AWS Snowball" + } + ], + "UpdateCluster": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "ClusterId": "CID123e4567-e89b-12d3-a456-426655440000", + "Description": "Updated the address to send this to image processing - RJ" + }, + "comments": { + }, + "description": "This action allows you to update certain parameters for a cluster. Once the cluster changes to a different state, usually within 60 minutes of it being created, this action is no longer available.", + "id": "to-update-a-cluster-1482863900595", + "title": "To update a cluster" + } + ], + "UpdateJob": [ + { + "input": { + "AddressId": "ADID1234ab12-3eec-4eb3-9be6-9374c10eb51b", + "Description": "Upgraded to Edge, shipped to Finance Dept, and requested faster shipping speed - TS.", + "JobId": "JID123e4567-e89b-12d3-a456-426655440000", + "ShippingOption": "NEXT_DAY", + "SnowballCapacityPreference": "T100" + }, + "comments": { + }, + "description": "This action allows you to update certain parameters for a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.", + "id": "to-update-a-job-1482863556886", + "title": "To update a job" + } + ] + } +} diff --git a/aws/dist/botocore/data/snowball/2016-06-30/paginators-1.json b/aws/dist/botocore/data/snowball/2016-06-30/paginators-1.json new file mode 100644 index 00000000..e4e974f3 --- /dev/null +++ b/aws/dist/botocore/data/snowball/2016-06-30/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListJobs": { + "limit_key": "MaxResults", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "JobListEntries" + }, + "DescribeAddresses": { + "limit_key": "MaxResults", + "output_token": "NextToken", + "input_token": "NextToken", + "result_key": "Addresses" + }, + "ListClusterJobs": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "JobListEntries" + }, + "ListClusters": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ClusterListEntries" + }, + "ListCompatibleImages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "CompatibleImages" + } + } +} diff --git a/aws/dist/botocore/data/snowball/2016-06-30/service-2.json b/aws/dist/botocore/data/snowball/2016-06-30/service-2.json new file mode 100644 index 00000000..c170a641 --- /dev/null +++ b/aws/dist/botocore/data/snowball/2016-06-30/service-2.json @@ -0,0 +1,1499 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-06-30", + "endpointPrefix":"snowball", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon Snowball", + "serviceFullName":"Amazon Import/Export Snowball", + "serviceId":"Snowball", + "signatureVersion":"v4", + "targetPrefix":"AWSIESnowballJobManagementService", + "uid":"snowball-2016-06-30" + }, + "operations":{ + "CancelCluster":{ + "name":"CancelCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelClusterRequest"}, + "output":{"shape":"CancelClusterResult"}, + "errors":[ + {"shape":"KMSRequestFailedException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"InvalidResourceException"} + ], + "documentation":"

    Cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status. You'll have at least an hour after creating a cluster job to cancel it.

    " + }, + "CancelJob":{ + "name":"CancelJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelJobRequest"}, + "output":{"shape":"CancelJobResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"KMSRequestFailedException"} + ], + "documentation":"

    Cancels the specified job. You can only cancel a job before its JobState value changes to PreparingAppliance. Requesting the ListJobs or DescribeJob action returns a job's JobState as part of the response element data returned.

    " + }, + "CreateAddress":{ + "name":"CreateAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAddressRequest"}, + "output":{"shape":"CreateAddressResult"}, + "errors":[ + {"shape":"InvalidAddressException"}, + {"shape":"UnsupportedAddressException"} + ], + "documentation":"

    Creates an address for a Snowball to be shipped to. In most regions, addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. If the address is invalid or unsupported, then an exception is thrown.

    " + }, + "CreateCluster":{ + "name":"CreateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateClusterRequest"}, + "output":{"shape":"CreateClusterResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"KMSRequestFailedException"}, + {"shape":"InvalidInputCombinationException"}, + {"shape":"Ec2RequestFailedException"} + ], + "documentation":"

    Creates an empty cluster. Each cluster supports five nodes. You use the CreateJob action separately to create the jobs for each of these nodes. The cluster does not ship until these five node jobs have been created.

    " + }, + "CreateJob":{ + "name":"CreateJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateJobRequest"}, + "output":{"shape":"CreateJobResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"KMSRequestFailedException"}, + {"shape":"InvalidInputCombinationException"}, + {"shape":"ClusterLimitExceededException"}, + {"shape":"Ec2RequestFailedException"} + ], + "documentation":"

    Creates a job to import or export data between Amazon S3 and your on-premises data center. Your AWS account must have the right trust policies and permissions in place to create a job for Snowball. If you're creating a job for a node in a cluster, you only need to provide the clusterId value; the other job attributes are inherited from the cluster.

    " + }, + "DescribeAddress":{ + "name":"DescribeAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressRequest"}, + "output":{"shape":"DescribeAddressResult"}, + "errors":[ + {"shape":"InvalidResourceException"} + ], + "documentation":"

    Takes an AddressId and returns specific details about that address in the form of an Address object.

    " + }, + "DescribeAddresses":{ + "name":"DescribeAddresses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAddressesRequest"}, + "output":{"shape":"DescribeAddressesResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

    Returns a specified number of ADDRESS objects. Calling this API in one of the US regions will return addresses from the list of all addresses associated with this account in all US regions.

    " + }, + "DescribeCluster":{ + "name":"DescribeCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClusterRequest"}, + "output":{"shape":"DescribeClusterResult"}, + "errors":[ + {"shape":"InvalidResourceException"} + ], + "documentation":"

    Returns information about a specific cluster including shipping information, cluster status, and other important metadata.

    " + }, + "DescribeJob":{ + "name":"DescribeJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeJobRequest"}, + "output":{"shape":"DescribeJobResult"}, + "errors":[ + {"shape":"InvalidResourceException"} + ], + "documentation":"

    Returns information about a specific job including shipping information, job status, and other important metadata.

    " + }, + "GetJobManifest":{ + "name":"GetJobManifest", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobManifestRequest"}, + "output":{"shape":"GetJobManifestResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"} + ], + "documentation":"

    Returns a link to an Amazon S3 presigned URL for the manifest file associated with the specified JobId value. You can access the manifest file for up to 60 minutes after this request has been made. To access the manifest file after 60 minutes have passed, you'll have to make another call to the GetJobManifest action.

    The manifest is an encrypted file that you can download after your job enters the WithCustomer status. The manifest is decrypted by using the UnlockCode code value, when you pass both values to the Snowball through the Snowball client when the client is started for the first time.

    As a best practice, we recommend that you don't save a copy of an UnlockCode value in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

    The credentials of a given job, including its manifest file and unlock code, expire 90 days after the job is created.

    " + }, + "GetJobUnlockCode":{ + "name":"GetJobUnlockCode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetJobUnlockCodeRequest"}, + "output":{"shape":"GetJobUnlockCodeResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"} + ], + "documentation":"

    Returns the UnlockCode code value for the specified job. A particular UnlockCode value can be accessed for up to 90 days after the associated job has been created.

    The UnlockCode value is a 29-character code with 25 alphanumeric characters and 4 hyphens. This code is used to decrypt the manifest file when it is passed along with the manifest to the Snowball through the Snowball client when the client is started for the first time.

    As a best practice, we recommend that you don't save a copy of the UnlockCode in the same location as the manifest file for that job. Saving these separately helps prevent unauthorized parties from gaining access to the Snowball associated with that job.

    " + }, + "GetSnowballUsage":{ + "name":"GetSnowballUsage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSnowballUsageRequest"}, + "output":{"shape":"GetSnowballUsageResult"}, + "documentation":"

    Returns information about the Snowball service limit for your account, and also the number of Snowballs your account has in use.

    The default service limit for the number of Snowballs that you can have at one time is 1. If you want to increase your service limit, contact AWS Support.

    " + }, + "GetSoftwareUpdates":{ + "name":"GetSoftwareUpdates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSoftwareUpdatesRequest"}, + "output":{"shape":"GetSoftwareUpdatesResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"} + ], + "documentation":"

    Returns an Amazon S3 presigned URL for an update file associated with a specified JobId.

    " + }, + "ListClusterJobs":{ + "name":"ListClusterJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClusterJobsRequest"}, + "output":{"shape":"ListClusterJobsResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

    Returns an array of JobListEntry objects of the specified length. Each JobListEntry object is for a job in the specified cluster and contains a job's state, a job's ID, and other information.

    " + }, + "ListClusters":{ + "name":"ListClusters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClustersRequest"}, + "output":{"shape":"ListClustersResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

    Returns an array of ClusterListEntry objects of the specified length. Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

    " + }, + "ListCompatibleImages":{ + "name":"ListCompatibleImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCompatibleImagesRequest"}, + "output":{"shape":"ListCompatibleImagesResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"Ec2RequestFailedException"} + ], + "documentation":"

    This action returns a list of the different Amazon EC2 Amazon Machine Images (AMIs) that are owned by your AWS account that would be supported for use on a Snowball Edge device. Currently, supported AMIs are based on the CentOS 7 (x86_64) - with Updates HVM, Ubuntu Server 14.04 LTS (HVM), and Ubuntu 16.04 LTS - Xenial (HVM) images, available on the AWS Marketplace.

    " + }, + "ListJobs":{ + "name":"ListJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListJobsRequest"}, + "output":{"shape":"ListJobsResult"}, + "errors":[ + {"shape":"InvalidNextTokenException"} + ], + "documentation":"

    Returns an array of JobListEntry objects of the specified length. Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs. Calling this API action in one of the US regions will return jobs from the list of all jobs associated with this account in all US regions.

    " + }, + "UpdateCluster":{ + "name":"UpdateCluster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateClusterRequest"}, + "output":{"shape":"UpdateClusterResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"KMSRequestFailedException"}, + {"shape":"InvalidInputCombinationException"}, + {"shape":"Ec2RequestFailedException"} + ], + "documentation":"

    While a cluster's ClusterState value is in the AwaitingQuorum state, you can update some of the information associated with a cluster. Once the cluster changes to a different job state, usually 60 minutes after the cluster being created, this action is no longer available.

    " + }, + "UpdateJob":{ + "name":"UpdateJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateJobRequest"}, + "output":{"shape":"UpdateJobResult"}, + "errors":[ + {"shape":"InvalidResourceException"}, + {"shape":"InvalidJobStateException"}, + {"shape":"KMSRequestFailedException"}, + {"shape":"InvalidInputCombinationException"}, + {"shape":"ClusterLimitExceededException"}, + {"shape":"Ec2RequestFailedException"} + ], + "documentation":"

    While a job's JobState value is New, you can update some of the information associated with a job. Once the job changes to a different job state, usually within 60 minutes of the job being created, this action is no longer available.

    " + } + }, + "shapes":{ + "Address":{ + "type":"structure", + "members":{ + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The unique ID for an address.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of a person to receive a Snowball at an address.

    " + }, + "Company":{ + "shape":"String", + "documentation":"

    The name of the company to receive a Snowball at an address.

    " + }, + "Street1":{ + "shape":"String", + "documentation":"

    The first line in a street address that a Snowball is to be delivered to.

    " + }, + "Street2":{ + "shape":"String", + "documentation":"

    The second line in a street address that a Snowball is to be delivered to.

    " + }, + "Street3":{ + "shape":"String", + "documentation":"

    The third line in a street address that a Snowball is to be delivered to.

    " + }, + "City":{ + "shape":"String", + "documentation":"

    The city in an address that a Snowball is to be delivered to.

    " + }, + "StateOrProvince":{ + "shape":"String", + "documentation":"

    The state or province in an address that a Snowball is to be delivered to.

    " + }, + "PrefectureOrDistrict":{ + "shape":"String", + "documentation":"

    This field is no longer used and the value is ignored.

    " + }, + "Landmark":{ + "shape":"String", + "documentation":"

    This field is no longer used and the value is ignored.

    " + }, + "Country":{ + "shape":"String", + "documentation":"

    The country in an address that a Snowball is to be delivered to.

    " + }, + "PostalCode":{ + "shape":"String", + "documentation":"

    The postal code in an address that a Snowball is to be delivered to.

    " + }, + "PhoneNumber":{ + "shape":"String", + "documentation":"

    The phone number associated with an address that a Snowball is to be delivered to.

    " + }, + "IsRestricted":{ + "shape":"Boolean", + "documentation":"

    If the address you are creating is a primary address, then set this option to true. This field is not supported in most regions.

    " + } + }, + "documentation":"

    The address that you want the Snowball or Snowballs associated with a specific job to be shipped to. Addresses are validated at the time of creation. The address you provide must be located within the serviceable area of your region. Although no individual elements of the Address are required, if the address is invalid or unsupported, then an exception is thrown.

    " + }, + "AddressId":{ + "type":"string", + "max":40, + "min":40, + "pattern":"ADID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "AddressList":{ + "type":"list", + "member":{"shape":"Address"} + }, + "AmiId":{ + "type":"string", + "max":21, + "min":12, + "pattern":"(ami-[0-9a-f]{8})|(ami-[0-9a-f]{17})" + }, + "Boolean":{"type":"boolean"}, + "CancelClusterRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "CancelClusterResult":{ + "type":"structure", + "members":{ + } + }, + "CancelJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The 39-character job ID for the job that you want to cancel, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "CancelJobResult":{ + "type":"structure", + "members":{ + } + }, + "ClusterId":{ + "type":"string", + "max":39, + "min":39, + "pattern":"CID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "ClusterLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Job creation failed. Currently, clusters support five nodes. If you have less than five nodes for your cluster and you have more nodes to create for this cluster, try again and create jobs until your cluster has exactly five notes.

    ", + "exception":true + }, + "ClusterListEntry":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"String", + "documentation":"

    The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "ClusterState":{ + "shape":"ClusterState", + "documentation":"

    The current state of this cluster. For information about the state of a specific node, see JobListEntry$JobState.

    " + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

    The creation date for this cluster.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Defines an optional description of the cluster, for example Environmental Data Cluster-01.

    " + } + }, + "documentation":"

    Contains a cluster's state, a cluster's ID, and other important information.

    " + }, + "ClusterListEntryList":{ + "type":"list", + "member":{"shape":"ClusterListEntry"} + }, + "ClusterMetadata":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"String", + "documentation":"

    The automatically generated ID for a cluster.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The optional description of the cluster.

    " + }, + "KmsKeyARN":{ + "shape":"KmsKeyARN", + "documentation":"

    The KmsKeyARN Amazon Resource Name (ARN) associated with this cluster. This ARN was created using the CreateKey API action in AWS Key Management Service (AWS KMS).

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The role ARN associated with this cluster. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

    " + }, + "ClusterState":{ + "shape":"ClusterState", + "documentation":"

    The current status of the cluster.

    " + }, + "JobType":{ + "shape":"JobType", + "documentation":"

    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

    " + }, + "SnowballType":{ + "shape":"SnowballType", + "documentation":"

    The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is EDGE.

    " + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

    The creation date for this cluster.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    The arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The automatically generated ID for a specific address.

    " + }, + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowball Edges are delivered in one to seven days.

    • In the US, you have access to one-day shipping and two-day shipping.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The ID of the address that you want a cluster shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

    " + } + }, + "documentation":"

    Contains metadata about a specific cluster.

    " + }, + "ClusterState":{ + "type":"string", + "enum":[ + "AwaitingQuorum", + "Pending", + "InUse", + "Complete", + "Cancelled" + ] + }, + "CompatibleImage":{ + "type":"structure", + "members":{ + "AmiId":{ + "shape":"String", + "documentation":"

    The unique identifier for an individual Snowball Edge AMI.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The optional name of a compatible image.

    " + } + }, + "documentation":"

    A JSON-formatted object that describes a compatible Amazon Machine Image (AMI), including the ID and name for a Snowball Edge AMI. This AMI is compatible with the device's physical hardware requirements, and it should be able to be run in an SBE1 instance on the device.

    " + }, + "CompatibleImageList":{ + "type":"list", + "member":{"shape":"CompatibleImage"} + }, + "CreateAddressRequest":{ + "type":"structure", + "required":["Address"], + "members":{ + "Address":{ + "shape":"Address", + "documentation":"

    The address that you want the Snowball shipped to.

    " + } + } + }, + "CreateAddressResult":{ + "type":"structure", + "members":{ + "AddressId":{ + "shape":"String", + "documentation":"

    The automatically generated ID for a specific address. You'll use this ID when you create a job to specify which address you want the Snowball for that job shipped to.

    " + } + } + }, + "CreateClusterRequest":{ + "type":"structure", + "required":[ + "JobType", + "Resources", + "AddressId", + "RoleARN", + "ShippingOption" + ], + "members":{ + "JobType":{ + "shape":"JobType", + "documentation":"

    The type of job for this cluster. Currently, the only job type supported for clusters is LOCAL_USE.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    The resources associated with the cluster job. These resources include Amazon S3 buckets and optional AWS Lambda functions written in the Python language.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    An optional description of this specific cluster, for example Environmental Data Cluster-01.

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The ID for the address that you want the cluster shipped to.

    " + }, + "KmsKeyARN":{ + "shape":"KmsKeyARN", + "documentation":"

    The KmsKeyARN value that you want to associate with this cluster. KmsKeyARN values are created by using the CreateKey API action in AWS Key Management Service (AWS KMS).

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The RoleARN that you want to associate with this cluster. RoleArn values are created by using the CreateRole API action in AWS Identity and Access Management (IAM).

    " + }, + "SnowballType":{ + "shape":"SnowballType", + "documentation":"

    The type of AWS Snowball device to use for this cluster. Currently, the only supported device type for cluster jobs is EDGE.

    " + }, + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The shipping speed for each node in this cluster. This speed doesn't dictate how soon you'll get each Snowball Edge device, rather it represents how quickly each device moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, devices shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowball Edges shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowball Edges are delivered in one to seven days.

    • In the US, you have access to one-day shipping and two-day shipping.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    The Amazon Simple Notification Service (Amazon SNS) notification settings for this cluster.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The forwarding address ID for a cluster. This field is not supported in most regions.

    " + } + } + }, + "CreateClusterResult":{ + "type":"structure", + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The automatically generated ID for a cluster.

    " + } + } + }, + "CreateJobRequest":{ + "type":"structure", + "members":{ + "JobType":{ + "shape":"JobType", + "documentation":"

    Defines the type of job that you're creating.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    Defines the Amazon S3 buckets associated with this job.

    With IMPORT jobs, you specify the bucket or buckets that your transferred data will be imported into.

    With EXPORT jobs, you specify the bucket or buckets that your transferred data will be exported from. Optionally, you can also specify a KeyRange value. If you choose to export a range, you define the length of the range by providing either an inclusive BeginMarker value, an inclusive EndMarker value, or both. Ranges are UTF-8 binary sorted.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    Defines an optional description of this specific job, for example Important Photos 2016-08-11.

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The ID for the address that you want the Snowball shipped to.

    " + }, + "KmsKeyARN":{ + "shape":"KmsKeyARN", + "documentation":"

    The KmsKeyARN that you want to associate with this job. KmsKeyARNs are created using the CreateKey AWS Key Management Service (KMS) API action.

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The RoleARN that you want to associate with this job. RoleArns are created using the CreateRole AWS Identity and Access Management (IAM) API action.

    " + }, + "SnowballCapacityPreference":{ + "shape":"SnowballCapacity", + "documentation":"

    If your job is being created in one of the US regions, you have the option of specifying what size Snowball you'd like for this job. In all other regions, Snowballs come with 80 TB in storage capacity.

    " + }, + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The shipping speed for this job. This speed doesn't dictate how soon you'll get the Snowball, rather it represents how quickly the Snowball moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowballs are delivered in one to seven days.

    • In the US, you have access to one-day shipping and two-day shipping.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    Defines the Amazon Simple Notification Service (Amazon SNS) notification settings for this job.

    " + }, + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The ID of a cluster. If you're creating a job for a node in a cluster, you need to provide only this clusterId value. The other job attributes are inherited from the cluster.

    " + }, + "SnowballType":{ + "shape":"SnowballType", + "documentation":"

    The type of AWS Snowball device to use for this job. Currently, the only supported device type for cluster jobs is EDGE.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The forwarding address ID for a job. This field is not supported in most regions.

    " + } + } + }, + "CreateJobResult":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "DataTransfer":{ + "type":"structure", + "members":{ + "BytesTransferred":{ + "shape":"Long", + "documentation":"

    The number of bytes transferred between a Snowball and Amazon S3.

    " + }, + "ObjectsTransferred":{ + "shape":"Long", + "documentation":"

    The number of objects transferred between a Snowball and Amazon S3.

    " + }, + "TotalBytes":{ + "shape":"Long", + "documentation":"

    The total bytes of data for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

    " + }, + "TotalObjects":{ + "shape":"Long", + "documentation":"

    The total number of objects for a transfer between a Snowball and Amazon S3. This value is set to 0 (zero) until all the keys that will be transferred have been listed.

    " + } + }, + "documentation":"

    Defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

    " + }, + "DescribeAddressRequest":{ + "type":"structure", + "required":["AddressId"], + "members":{ + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The automatically generated ID for a specific address.

    " + } + } + }, + "DescribeAddressResult":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"Address", + "documentation":"

    The address that you want the Snowball or Snowballs associated with a specific job to be shipped to.

    " + } + } + }, + "DescribeAddressesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

    The number of ADDRESS objects to return.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. To identify what object comes \"next\" in the list of ADDRESS objects, you have the option of specifying a value for NextToken as the starting point for your list of returned addresses.

    " + } + } + }, + "DescribeAddressesResult":{ + "type":"structure", + "members":{ + "Addresses":{ + "shape":"AddressList", + "documentation":"

    The Snowball shipping addresses that were created for this account.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. If you use the automatically generated NextToken value in your next DescribeAddresses call, your list of returned addresses will start from this point in the array.

    " + } + } + }, + "DescribeClusterRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The automatically generated ID for a cluster.

    " + } + } + }, + "DescribeClusterResult":{ + "type":"structure", + "members":{ + "ClusterMetadata":{ + "shape":"ClusterMetadata", + "documentation":"

    Information about a specific cluster, including shipping information, cluster status, and other important metadata.

    " + } + } + }, + "DescribeJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "DescribeJobResult":{ + "type":"structure", + "members":{ + "JobMetadata":{ + "shape":"JobMetadata", + "documentation":"

    Information about a specific job, including shipping information, job status, and other important metadata.

    " + }, + "SubJobMetadata":{ + "shape":"JobMetadataList", + "documentation":"

    Information about a specific job part (in the case of an export job), including shipping information, job status, and other important metadata.

    " + } + } + }, + "Ec2AmiResource":{ + "type":"structure", + "required":["AmiId"], + "members":{ + "AmiId":{ + "shape":"AmiId", + "documentation":"

    The ID of the AMI in Amazon EC2.

    " + }, + "SnowballAmiId":{ + "shape":"String", + "documentation":"

    The ID of the AMI on the Snowball Edge device.

    " + } + }, + "documentation":"

    A JSON-formatted object that contains the IDs for an Amazon Machine Image (AMI), including the Amazon EC2 AMI ID and the Snowball Edge AMI ID. Each AMI has these two IDs to simplify identifying the AMI in both the AWS Cloud and on the device.

    " + }, + "Ec2AmiResourceList":{ + "type":"list", + "member":{"shape":"Ec2AmiResource"} + }, + "Ec2RequestFailedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Your IAM user lacks the necessary Amazon EC2 permissions to perform the attempted action.

    ", + "exception":true + }, + "EventTriggerDefinition":{ + "type":"structure", + "members":{ + "EventResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) for any local Amazon S3 resource that is an AWS Lambda function's event trigger associated with this job.

    " + } + }, + "documentation":"

    The container for the EventTriggerDefinition$EventResourceARN.

    " + }, + "EventTriggerDefinitionList":{ + "type":"list", + "member":{"shape":"EventTriggerDefinition"} + }, + "GetJobManifestRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for a job that you want to get the manifest file for, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "GetJobManifestResult":{ + "type":"structure", + "members":{ + "ManifestURI":{ + "shape":"String", + "documentation":"

    The Amazon S3 presigned URL for the manifest file associated with the specified JobId value.

    " + } + } + }, + "GetJobUnlockCodeRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for the job that you want to get the UnlockCode value for, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "GetJobUnlockCodeResult":{ + "type":"structure", + "members":{ + "UnlockCode":{ + "shape":"String", + "documentation":"

    The UnlockCode value for the specified job. The UnlockCode value can be accessed for up to 90 days after the job has been created.

    " + } + } + }, + "GetSnowballUsageRequest":{ + "type":"structure", + "members":{ + } + }, + "GetSnowballUsageResult":{ + "type":"structure", + "members":{ + "SnowballLimit":{ + "shape":"Integer", + "documentation":"

    The service limit for number of Snowballs this account can have at once. The default service limit is 1 (one).

    " + }, + "SnowballsInUse":{ + "shape":"Integer", + "documentation":"

    The number of Snowballs that this account is currently using.

    " + } + } + }, + "GetSoftwareUpdatesRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The ID for a job that you want to get the software update file for, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + } + } + }, + "GetSoftwareUpdatesResult":{ + "type":"structure", + "members":{ + "UpdatesURI":{ + "shape":"String", + "documentation":"

    The Amazon S3 presigned URL for the update file associated with the specified JobId value. The software update will be available for 2 days after this request is made. To access an update after the 2 days have passed, you'll have to make another call to GetSoftwareUpdates.

    " + } + } + }, + "Integer":{"type":"integer"}, + "InvalidAddressException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The address provided was invalid. Check the address with your region's carrier, and try again.

    ", + "exception":true + }, + "InvalidInputCombinationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Job or cluster creation failed. One ore more inputs were invalid. Confirm that the CreateClusterRequest$SnowballType value supports your CreateJobRequest$JobType, and try again.

    ", + "exception":true + }, + "InvalidJobStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The action can't be performed because the job's current state doesn't allow that action to be performed.

    ", + "exception":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The NextToken string was altered unexpectedly, and the operation has stopped. Run the operation without changing the NextToken string, and try again.

    ", + "exception":true + }, + "InvalidResourceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{ + "shape":"String", + "documentation":"

    The provided resource value is invalid.

    " + } + }, + "documentation":"

    The specified resource can't be found. Check the information you provided in your last request, and try again.

    ", + "exception":true + }, + "JobId":{ + "type":"string", + "max":39, + "min":39, + "pattern":"(M|J)ID[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}" + }, + "JobListEntry":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"String", + "documentation":"

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "JobState":{ + "shape":"JobState", + "documentation":"

    The current state of this job.

    " + }, + "IsMaster":{ + "shape":"Boolean", + "documentation":"

    A value that indicates that this job is a master job. A master job represents a successful request to create an export job. Master jobs aren't associated with any Snowballs. Instead, each master job will have at least one job part, and each job part is associated with a Snowball. It might take some time before the job parts associated with a particular master job are listed, because they are created after the master job is created.

    " + }, + "JobType":{ + "shape":"JobType", + "documentation":"

    The type of job.

    " + }, + "SnowballType":{ + "shape":"SnowballType", + "documentation":"

    The type of device used with this job.

    " + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

    The creation date for this job.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The optional description of this specific job, for example Important Photos 2016-08-11.

    " + } + }, + "documentation":"

    Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of an export job.

    " + }, + "JobListEntryList":{ + "type":"list", + "member":{"shape":"JobListEntry"} + }, + "JobLogs":{ + "type":"structure", + "members":{ + "JobCompletionReportURI":{ + "shape":"String", + "documentation":"

    A link to an Amazon S3 presigned URL where the job completion report is located.

    " + }, + "JobSuccessLogURI":{ + "shape":"String", + "documentation":"

    A link to an Amazon S3 presigned URL where the job success log is located.

    " + }, + "JobFailureLogURI":{ + "shape":"String", + "documentation":"

    A link to an Amazon S3 presigned URL where the job failure log is located.

    " + } + }, + "documentation":"

    Contains job logs. Whenever Snowball is used to import data into or export data out of Amazon S3, you'll have the option of downloading a PDF job report. Job logs are returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type. The job logs can be accessed for up to 60 minutes after this request has been made. To access any of the job logs after 60 minutes have passed, you'll have to make another call to the DescribeJob action.

    For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

    The job report provides you insight into the state of your Amazon S3 data transfer. The report includes details about your job or job part for your records.

    For deeper visibility into the status of your transferred objects, you can look at the two associated logs: a success log and a failure log. The logs are saved in comma-separated value (CSV) format, and the name of each log includes the ID of the job or job part that the log describes.

    " + }, + "JobMetadata":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"String", + "documentation":"

    The automatically generated ID for a job, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "JobState":{ + "shape":"JobState", + "documentation":"

    The current status of the jobs.

    " + }, + "JobType":{ + "shape":"JobType", + "documentation":"

    The type of job.

    " + }, + "SnowballType":{ + "shape":"SnowballType", + "documentation":"

    The type of device used with this job.

    " + }, + "CreationDate":{ + "shape":"Timestamp", + "documentation":"

    The creation date for this job.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    An array of S3Resource objects. Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The description of the job, provided at job creation.

    " + }, + "KmsKeyARN":{ + "shape":"KmsKeyARN", + "documentation":"

    The Amazon Resource Name (ARN) for the AWS Key Management Service (AWS KMS) key associated with this job. This ARN was created using the CreateKey API action in AWS KMS.

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The role ARN associated with this job. This ARN was created using the CreateRole API action in AWS Identity and Access Management (IAM).

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The ID for the address that you want the Snowball shipped to.

    " + }, + "ShippingDetails":{ + "shape":"ShippingDetails", + "documentation":"

    A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

    " + }, + "SnowballCapacityPreference":{ + "shape":"SnowballCapacity", + "documentation":"

    The Snowball capacity preference for this job, specified at job creation. In US regions, you can choose between 50 TB and 80 TB Snowballs. All other regions use 80 TB capacity Snowballs.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

    " + }, + "DataTransferProgress":{ + "shape":"DataTransfer", + "documentation":"

    A value that defines the real-time status of a Snowball's data transfer while the device is at AWS. This data is only available while a job has a JobState value of InProgress, for both import and export jobs.

    " + }, + "JobLogInfo":{ + "shape":"JobLogs", + "documentation":"

    Links to Amazon S3 presigned URLs for the job report and logs. For import jobs, the PDF job report becomes available at the end of the import process. For export jobs, your job report typically becomes available while the Snowball for your job part is being delivered to you.

    " + }, + "ClusterId":{ + "shape":"String", + "documentation":"

    The 39-character ID for the cluster, for example CID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The ID of the address that you want a job shipped to, after it will be shipped to its primary address. This field is not supported in most regions.

    " + } + }, + "documentation":"

    Contains information about a specific job including shipping information, job status, and other important metadata. This information is returned as a part of the response syntax of the DescribeJob action.

    " + }, + "JobMetadataList":{ + "type":"list", + "member":{"shape":"JobMetadata"} + }, + "JobResource":{ + "type":"structure", + "members":{ + "S3Resources":{ + "shape":"S3ResourceList", + "documentation":"

    An array of S3Resource objects.

    " + }, + "LambdaResources":{ + "shape":"LambdaResourceList", + "documentation":"

    The Python-language Lambda functions for this job.

    " + }, + "Ec2AmiResources":{ + "shape":"Ec2AmiResourceList", + "documentation":"

    The Amazon Machine Images (AMIs) associated with this job.

    " + } + }, + "documentation":"

    Contains an array of AWS resource objects. Each object represents an Amazon S3 bucket, an AWS Lambda function, or an Amazon Machine Image (AMI) based on Amazon EC2 that is associated with a particular job.

    " + }, + "JobState":{ + "type":"string", + "enum":[ + "New", + "PreparingAppliance", + "PreparingShipment", + "InTransitToCustomer", + "WithCustomer", + "InTransitToAWS", + "WithAWSSortingFacility", + "WithAWS", + "InProgress", + "Complete", + "Cancelled", + "Listing", + "Pending" + ] + }, + "JobStateList":{ + "type":"list", + "member":{"shape":"JobState"} + }, + "JobType":{ + "type":"string", + "enum":[ + "IMPORT", + "EXPORT", + "LOCAL_USE" + ] + }, + "KMSRequestFailedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The provided AWS Key Management Service key lacks the permissions to perform the specified CreateJob or UpdateJob action.

    ", + "exception":true + }, + "KeyRange":{ + "type":"structure", + "members":{ + "BeginMarker":{ + "shape":"String", + "documentation":"

    The key that starts an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    " + }, + "EndMarker":{ + "shape":"String", + "documentation":"

    The key that ends an optional key range for an export job. Ranges are inclusive and UTF-8 binary sorted.

    " + } + }, + "documentation":"

    Contains a key range. For export jobs, a S3Resource object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

    " + }, + "KmsKeyARN":{ + "type":"string", + "max":255, + "pattern":"arn:aws.*:kms:.*:[0-9]{12}:key/.*" + }, + "LambdaResource":{ + "type":"structure", + "members":{ + "LambdaArn":{ + "shape":"ResourceARN", + "documentation":"

    An Amazon Resource Name (ARN) that represents an AWS Lambda function to be triggered by PUT object actions on the associated local Amazon S3 resource.

    " + }, + "EventTriggers":{ + "shape":"EventTriggerDefinitionList", + "documentation":"

    The array of ARNs for S3Resource objects to trigger the LambdaResource objects associated with this job.

    " + } + }, + "documentation":"

    Identifies

    " + }, + "LambdaResourceList":{ + "type":"list", + "member":{"shape":"LambdaResource"} + }, + "ListClusterJobsRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The 39-character ID for the cluster that you want to list, for example CID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

    The number of JobListEntry objects to return.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

    " + } + } + }, + "ListClusterJobsResult":{ + "type":"structure", + "members":{ + "JobListEntries":{ + "shape":"JobListEntryList", + "documentation":"

    Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. If you use the automatically generated NextToken value in your next ListClusterJobsResult call, your list of returned jobs will start from this point in the array.

    " + } + } + }, + "ListClustersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

    The number of ClusterListEntry objects to return.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. To identify what object comes \"next\" in the list of ClusterListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

    " + } + } + }, + "ListClustersResult":{ + "type":"structure", + "members":{ + "ClusterListEntries":{ + "shape":"ClusterListEntryList", + "documentation":"

    Each ClusterListEntry object contains a cluster's state, a cluster's ID, and other important status information.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. If you use the automatically generated NextToken value in your next ClusterListEntry call, your list of returned clusters will start from this point in the array.

    " + } + } + }, + "ListCompatibleImagesRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

    The maximum number of results for the list of compatible images. Currently, a Snowball Edge device can store 10 AMIs.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. To identify what object comes \"next\" in the list of compatible images, you can specify a value for NextToken as the starting point for your list of returned images.

    " + } + } + }, + "ListCompatibleImagesResult":{ + "type":"structure", + "members":{ + "CompatibleImages":{ + "shape":"CompatibleImageList", + "documentation":"

    A JSON-formatted object that describes a compatible AMI, including the ID and name for a Snowball Edge AMI.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Because HTTP requests are stateless, this is the starting point for your next list of returned images.

    " + } + } + }, + "ListJobsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"ListLimit", + "documentation":"

    The number of JobListEntry objects to return.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. To identify what object comes \"next\" in the list of JobListEntry objects, you have the option of specifying NextToken as the starting point for your returned list.

    " + } + } + }, + "ListJobsResult":{ + "type":"structure", + "members":{ + "JobListEntries":{ + "shape":"JobListEntryList", + "documentation":"

    Each JobListEntry object contains a job's state, a job's ID, and a value that indicates whether the job is a job part, in the case of export jobs.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    HTTP requests are stateless. If you use this automatically generated NextToken value in your next ListJobs call, your returned JobListEntry objects will start from this point in the array.

    " + } + } + }, + "ListLimit":{ + "type":"integer", + "max":100, + "min":0 + }, + "Long":{"type":"long"}, + "Notification":{ + "type":"structure", + "members":{ + "SnsTopicARN":{ + "shape":"SnsTopicARN", + "documentation":"

    The new SNS TopicArn that you want to associate with this job. You can create Amazon Resource Names (ARNs) for topics by using the CreateTopic Amazon SNS API action.

    You can subscribe email addresses to an Amazon SNS topic through the AWS Management Console, or by using the Subscribe AWS Simple Notification Service (SNS) API action.

    " + }, + "JobStatesToNotify":{ + "shape":"JobStateList", + "documentation":"

    The list of job states that will trigger a notification for this job.

    " + }, + "NotifyAll":{ + "shape":"Boolean", + "documentation":"

    Any change in job state will trigger a notification for this job.

    " + } + }, + "documentation":"

    The Amazon Simple Notification Service (Amazon SNS) notification settings associated with a specific job. The Notification object is returned as a part of the response syntax of the DescribeJob action in the JobMetadata data type.

    When the notification settings are defined during job creation, you can choose to notify based on a specific set of job states using the JobStatesToNotify array of strings, or you can specify that you want to have Amazon SNS notifications sent out for all job states with NotifyAll set to true.

    " + }, + "ResourceARN":{ + "type":"string", + "max":255 + }, + "RoleARN":{ + "type":"string", + "max":255, + "pattern":"arn:aws.*:iam::[0-9]{12}:role/.*" + }, + "S3Resource":{ + "type":"structure", + "members":{ + "BucketArn":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of an Amazon S3 bucket.

    " + }, + "KeyRange":{ + "shape":"KeyRange", + "documentation":"

    For export jobs, you can provide an optional KeyRange within a specific Amazon S3 bucket. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

    " + } + }, + "documentation":"

    Each S3Resource object represents an Amazon S3 bucket that your transferred data will be exported from or imported into. For export jobs, this object can have an optional KeyRange value. The length of the range is defined at job creation, and has either an inclusive BeginMarker, an inclusive EndMarker, or both. Ranges are UTF-8 binary sorted.

    " + }, + "S3ResourceList":{ + "type":"list", + "member":{"shape":"S3Resource"} + }, + "Shipment":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"String", + "documentation":"

    Status information for a shipment.

    " + }, + "TrackingNumber":{ + "shape":"String", + "documentation":"

    The tracking number for this job. Using this tracking number with your region's carrier's website, you can track a Snowball as the carrier transports it.

    For India, the carrier is Amazon Logistics. For all other regions, UPS is the carrier.

    " + } + }, + "documentation":"

    The Status and TrackingNumber information for an inbound or outbound shipment.

    " + }, + "ShippingDetails":{ + "type":"structure", + "members":{ + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The shipping speed for a particular job. This speed doesn't dictate how soon you'll get the Snowball from the job's creation date. This speed represents how quickly it moves to its destination while in transit. Regional shipping speeds are as follows:

    • In Australia, you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day.

    • In the European Union (EU), you have access to express shipping. Typically, Snowballs shipped express are delivered in about a day. In addition, most countries in the EU have access to standard shipping, which typically takes less than a week, one way.

    • In India, Snowballs are delivered in one to seven days.

    • In the United States of America (US), you have access to one-day shipping and two-day shipping.

    " + }, + "InboundShipment":{ + "shape":"Shipment", + "documentation":"

    The Status and TrackingNumber values for a Snowball being returned to AWS for a particular job.

    " + }, + "OutboundShipment":{ + "shape":"Shipment", + "documentation":"

    The Status and TrackingNumber values for a Snowball being delivered to the address that you specified for a particular job.

    " + } + }, + "documentation":"

    A job's shipping information, including inbound and outbound tracking numbers and shipping speed options.

    " + }, + "ShippingOption":{ + "type":"string", + "enum":[ + "SECOND_DAY", + "NEXT_DAY", + "EXPRESS", + "STANDARD" + ] + }, + "SnowballCapacity":{ + "type":"string", + "enum":[ + "T50", + "T80", + "T100", + "T42", + "NoPreference" + ] + }, + "SnowballType":{ + "type":"string", + "enum":[ + "STANDARD", + "EDGE", + "EDGE_C", + "EDGE_CG" + ] + }, + "SnsTopicARN":{ + "type":"string", + "max":255, + "pattern":"arn:aws.*:sns:.*:[0-9]{12}:.*" + }, + "String":{ + "type":"string", + "min":1 + }, + "Timestamp":{"type":"timestamp"}, + "UnsupportedAddressException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The address is either outside the serviceable area for your region, or an error occurred. Check the address with your region's carrier and try again. If the issue persists, contact AWS Support.

    ", + "exception":true + }, + "UpdateClusterRequest":{ + "type":"structure", + "required":["ClusterId"], + "members":{ + "ClusterId":{ + "shape":"ClusterId", + "documentation":"

    The cluster ID of the cluster that you want to update, for example CID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The new role Amazon Resource Name (ARN) that you want to associate with this cluster. To create a role ARN, use the CreateRole API action in AWS Identity and Access Management (IAM).

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The updated description of this cluster.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    The updated arrays of JobResource objects that can include updated S3Resource objects or LambdaResource objects.

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The ID of the updated Address object.

    " + }, + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The updated shipping option value of this cluster's ShippingDetails object.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    The new or updated Notification object.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The updated ID for the forwarding address for a cluster. This field is not supported in most regions.

    " + } + } + }, + "UpdateClusterResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The job ID of the job that you want to update, for example JID123e4567-e89b-12d3-a456-426655440000.

    " + }, + "RoleARN":{ + "shape":"RoleARN", + "documentation":"

    The new role Amazon Resource Name (ARN) that you want to associate with this job. To create a role ARN, use the CreateRoleAWS Identity and Access Management (IAM) API action.

    " + }, + "Notification":{ + "shape":"Notification", + "documentation":"

    The new or updated Notification object.

    " + }, + "Resources":{ + "shape":"JobResource", + "documentation":"

    The updated JobResource object, or the updated JobResource object.

    " + }, + "AddressId":{ + "shape":"AddressId", + "documentation":"

    The ID of the updated Address object.

    " + }, + "ShippingOption":{ + "shape":"ShippingOption", + "documentation":"

    The updated shipping option value of this job's ShippingDetails object.

    " + }, + "Description":{ + "shape":"String", + "documentation":"

    The updated description of this job's JobMetadata object.

    " + }, + "SnowballCapacityPreference":{ + "shape":"SnowballCapacity", + "documentation":"

    The updated SnowballCapacityPreference of this job's JobMetadata object. The 50 TB Snowballs are only available in the US regions.

    " + }, + "ForwardingAddressId":{ + "shape":"AddressId", + "documentation":"

    The updated ID for the forwarding address for a job. This field is not supported in most regions.

    " + } + } + }, + "UpdateJobResult":{ + "type":"structure", + "members":{ + } + } + }, + "documentation":"

    AWS Snowball is a petabyte-scale data transport solution that uses secure devices to transfer large amounts of data between your on-premises data centers and Amazon Simple Storage Service (Amazon S3). The Snowball commands described here provide access to the same functionality that is available in the AWS Snowball Management Console, which enables you to create and manage jobs for Snowball. To transfer data locally with a Snowball device, you'll need to use the Snowball client or the Amazon S3 API adapter for Snowball. For more information, see the User Guide.

    " +} diff --git a/aws/dist/botocore/data/sns/2010-03-31/examples-1.json b/aws/dist/botocore/data/sns/2010-03-31/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/sns/2010-03-31/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/sns/2010-03-31/paginators-1.json b/aws/dist/botocore/data/sns/2010-03-31/paginators-1.json new file mode 100644 index 00000000..1c30bcc8 --- /dev/null +++ b/aws/dist/botocore/data/sns/2010-03-31/paginators-1.json @@ -0,0 +1,34 @@ +{ + "pagination": { + "ListEndpointsByPlatformApplication": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Endpoints" + }, + "ListPlatformApplications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "PlatformApplications" + }, + "ListSubscriptions": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListSubscriptionsByTopic": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Subscriptions" + }, + "ListTopics": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Topics" + }, + "ListPhoneNumbersOptedOut": { + "input_token": "nextToken", + "output_token": "nextToken", + "result_key": "phoneNumbers" + } + } +} diff --git a/aws/dist/botocore/data/sns/2010-03-31/service-2.json b/aws/dist/botocore/data/sns/2010-03-31/service-2.json new file mode 100644 index 00000000..44aea81c --- /dev/null +++ b/aws/dist/botocore/data/sns/2010-03-31/service-2.json @@ -0,0 +1,1908 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2010-03-31", + "endpointPrefix":"sns", + "protocol":"query", + "serviceAbbreviation":"Amazon SNS", + "serviceFullName":"Amazon Simple Notification Service", + "serviceId":"SNS", + "signatureVersion":"v4", + "uid":"sns-2010-03-31", + "xmlNamespace":"http://sns.amazonaws.com/doc/2010-03-31/" + }, + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddPermissionInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.

    " + }, + "CheckIfPhoneNumberIsOptedOut":{ + "name":"CheckIfPhoneNumberIsOptedOut", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CheckIfPhoneNumberIsOptedOutInput"}, + "output":{ + "shape":"CheckIfPhoneNumberIsOptedOutResponse", + "resultWrapper":"CheckIfPhoneNumberIsOptedOutResult" + }, + "errors":[ + {"shape":"ThrottledException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your account. You cannot send SMS messages to a number that is opted out.

    To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

    " + }, + "ConfirmSubscription":{ + "name":"ConfirmSubscription", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ConfirmSubscriptionInput"}, + "output":{ + "shape":"ConfirmSubscriptionResponse", + "resultWrapper":"ConfirmSubscriptionResult" + }, + "errors":[ + {"shape":"SubscriptionLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NotFoundException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"FilterPolicyLimitExceededException"} + ], + "documentation":"

    Verifies an endpoint owner's intent to receive messages by validating the token sent to the endpoint by an earlier Subscribe action. If the token is valid, the action creates a new subscription and returns its Amazon Resource Name (ARN). This call requires an AWS signature only when the AuthenticateOnUnsubscribe flag is set to \"true\".

    " + }, + "CreatePlatformApplication":{ + "name":"CreatePlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlatformApplicationInput"}, + "output":{ + "shape":"CreatePlatformApplicationResponse", + "resultWrapper":"CreatePlatformApplicationResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".

    For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action. For more information, see Using Amazon SNS Mobile Push Notifications. For more information about obtaining the PlatformPrincipal and PlatformCredential for each of the supported push notification services, see Getting Started with Apple Push Notification Service, Getting Started with Amazon Device Messaging, Getting Started with Baidu Cloud Push, Getting Started with Google Cloud Messaging for Android, Getting Started with MPNS, or Getting Started with WNS.

    " + }, + "CreatePlatformEndpoint":{ + "name":"CreatePlatformEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePlatformEndpointInput"}, + "output":{ + "shape":"CreateEndpointResponse", + "resultWrapper":"CreatePlatformEndpointResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

    When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

    " + }, + "CreateTopic":{ + "name":"CreateTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTopicInput"}, + "output":{ + "shape":"CreateTopicResponse", + "resultWrapper":"CreateTopicResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"TopicLimitExceededException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidSecurityException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"StaleTagException"}, + {"shape":"TagPolicyException"}, + {"shape":"ConcurrentAccessException"} + ], + "documentation":"

    Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

    " + }, + "DeleteEndpoint":{ + "name":"DeleteEndpoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteEndpointInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Deletes the endpoint for a device and mobile app from Amazon SNS. This action is idempotent. For more information, see Using Amazon SNS Mobile Push Notifications.

    When you delete an endpoint that is also subscribed to a topic, then you must also unsubscribe the endpoint from the topic.

    " + }, + "DeletePlatformApplication":{ + "name":"DeletePlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePlatformApplicationInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Deletes a platform application object for one of the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

    " + }, + "DeleteTopic":{ + "name":"DeleteTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTopicInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"StaleTagException"}, + {"shape":"TagPolicyException"}, + {"shape":"ConcurrentAccessException"} + ], + "documentation":"

    Deletes a topic and all its subscriptions. Deleting a topic might prevent some messages previously sent to the topic from being delivered to subscribers. This action is idempotent, so deleting a topic that does not exist does not result in an error.

    " + }, + "GetEndpointAttributes":{ + "name":"GetEndpointAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetEndpointAttributesInput"}, + "output":{ + "shape":"GetEndpointAttributesResponse", + "resultWrapper":"GetEndpointAttributesResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

    " + }, + "GetPlatformApplicationAttributes":{ + "name":"GetPlatformApplicationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPlatformApplicationAttributesInput"}, + "output":{ + "shape":"GetPlatformApplicationAttributesResponse", + "resultWrapper":"GetPlatformApplicationAttributesResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications.

    " + }, + "GetSMSAttributes":{ + "name":"GetSMSAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSMSAttributesInput"}, + "output":{ + "shape":"GetSMSAttributesResponse", + "resultWrapper":"GetSMSAttributesResult" + }, + "errors":[ + {"shape":"ThrottledException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Returns the settings for sending SMS messages from your account.

    These settings are set with the SetSMSAttributes action.

    " + }, + "GetSubscriptionAttributes":{ + "name":"GetSubscriptionAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSubscriptionAttributesInput"}, + "output":{ + "shape":"GetSubscriptionAttributesResponse", + "resultWrapper":"GetSubscriptionAttributesResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Returns all of the properties of a subscription.

    " + }, + "GetTopicAttributes":{ + "name":"GetTopicAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTopicAttributesInput"}, + "output":{ + "shape":"GetTopicAttributesResponse", + "resultWrapper":"GetTopicAttributesResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidSecurityException"} + ], + "documentation":"

    Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

    " + }, + "ListEndpointsByPlatformApplication":{ + "name":"ListEndpointsByPlatformApplication", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListEndpointsByPlatformApplicationInput"}, + "output":{ + "shape":"ListEndpointsByPlatformApplicationResponse", + "resultWrapper":"ListEndpointsByPlatformApplicationResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

    This action is throttled at 30 transactions per second (TPS).

    " + }, + "ListPhoneNumbersOptedOut":{ + "name":"ListPhoneNumbersOptedOut", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPhoneNumbersOptedOutInput"}, + "output":{ + "shape":"ListPhoneNumbersOptedOutResponse", + "resultWrapper":"ListPhoneNumbersOptedOutResult" + }, + "errors":[ + {"shape":"ThrottledException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Returns a list of phone numbers that are opted out, meaning you cannot send SMS messages to them.

    The results for ListPhoneNumbersOptedOut are paginated, and each page returns up to 100 phone numbers. If additional phone numbers are available after the first page of results, then a NextToken string will be returned. To receive the next page, you call ListPhoneNumbersOptedOut again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null.

    " + }, + "ListPlatformApplications":{ + "name":"ListPlatformApplications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPlatformApplicationsInput"}, + "output":{ + "shape":"ListPlatformApplicationsResponse", + "resultWrapper":"ListPlatformApplicationsResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Lists the platform application objects for the supported push notification services, such as APNS and GCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

    This action is throttled at 15 transactions per second (TPS).

    " + }, + "ListSubscriptions":{ + "name":"ListSubscriptions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSubscriptionsInput"}, + "output":{ + "shape":"ListSubscriptionsResponse", + "resultWrapper":"ListSubscriptionsResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Returns a list of the requester's subscriptions. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptions call to get further results.

    This action is throttled at 30 transactions per second (TPS).

    " + }, + "ListSubscriptionsByTopic":{ + "name":"ListSubscriptionsByTopic", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSubscriptionsByTopicInput"}, + "output":{ + "shape":"ListSubscriptionsByTopicResponse", + "resultWrapper":"ListSubscriptionsByTopicResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Returns a list of the subscriptions to a specific topic. Each call returns a limited list of subscriptions, up to 100. If there are more subscriptions, a NextToken is also returned. Use the NextToken parameter in a new ListSubscriptionsByTopic call to get further results.

    This action is throttled at 30 transactions per second (TPS).

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{ + "shape":"ListTagsForResourceResponse", + "resultWrapper":"ListTagsForResourceResult" + }, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TagPolicyException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"ConcurrentAccessException"} + ], + "documentation":"

    List all tags added to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon Simple Notification Service Developer Guide.

    " + }, + "ListTopics":{ + "name":"ListTopics", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTopicsInput"}, + "output":{ + "shape":"ListTopicsResponse", + "resultWrapper":"ListTopicsResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If there are more topics, a NextToken is also returned. Use the NextToken parameter in a new ListTopics call to get further results.

    This action is throttled at 30 transactions per second (TPS).

    " + }, + "OptInPhoneNumber":{ + "name":"OptInPhoneNumber", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"OptInPhoneNumberInput"}, + "output":{ + "shape":"OptInPhoneNumberResponse", + "resultWrapper":"OptInPhoneNumberResult" + }, + "errors":[ + {"shape":"ThrottledException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Use this request to opt in a phone number that is opted out, which enables you to resume sending SMS messages to the number.

    You can opt in a phone number only once every 30 days.

    " + }, + "Publish":{ + "name":"Publish", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PublishInput"}, + "output":{ + "shape":"PublishResponse", + "resultWrapper":"PublishResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"EndpointDisabledException"}, + {"shape":"PlatformApplicationDisabledException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"KMSDisabledException"}, + {"shape":"KMSInvalidStateException"}, + {"shape":"KMSNotFoundException"}, + {"shape":"KMSOptInRequired"}, + {"shape":"KMSThrottlingException"}, + {"shape":"KMSAccessDeniedException"}, + {"shape":"InvalidSecurityException"} + ], + "documentation":"

    Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.

    If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

    When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

    To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

    For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

    " + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemovePermissionInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Removes a statement from a topic's access control policy.

    " + }, + "SetEndpointAttributes":{ + "name":"SetEndpointAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetEndpointAttributesInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

    " + }, + "SetPlatformApplicationAttributes":{ + "name":"SetPlatformApplicationAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetPlatformApplicationAttributesInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

    " + }, + "SetSMSAttributes":{ + "name":"SetSMSAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSMSAttributesInput"}, + "output":{ + "shape":"SetSMSAttributesResponse", + "resultWrapper":"SetSMSAttributesResult" + }, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"ThrottledException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Use this request to set the default settings for sending SMS messages and receiving daily SMS usage reports.

    You can override some of these settings for a single message when you use the Publish action with the MessageAttributes.entry.N parameter. For more information, see Sending an SMS Message in the Amazon SNS Developer Guide.

    " + }, + "SetSubscriptionAttributes":{ + "name":"SetSubscriptionAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSubscriptionAttributesInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"FilterPolicyLimitExceededException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"} + ], + "documentation":"

    Allows a subscription owner to set an attribute of the subscription to a new value.

    " + }, + "SetTopicAttributes":{ + "name":"SetTopicAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetTopicAttributesInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidSecurityException"} + ], + "documentation":"

    Allows a topic owner to set an attribute of the topic to a new value.

    " + }, + "Subscribe":{ + "name":"Subscribe", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SubscribeInput"}, + "output":{ + "shape":"SubscribeResponse", + "resultWrapper":"SubscribeResult" + }, + "errors":[ + {"shape":"SubscriptionLimitExceededException"}, + {"shape":"FilterPolicyLimitExceededException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"InvalidSecurityException"} + ], + "documentation":"

    Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

    This action is throttled at 100 transactions per second (TPS).

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{ + "shape":"TagResourceResponse", + "resultWrapper":"TagResourceResult" + }, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"StaleTagException"}, + {"shape":"TagPolicyException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"ConcurrentAccessException"} + ], + "documentation":"

    Add tags to the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    When you use topic tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a topic isn't recommended.

    • Tags don't have any semantic meaning. Amazon SNS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    • Tagging actions are limited to 10 TPS per AWS account. If your application requires a higher throughput, file a technical support request.

    For a full list of tag restrictions, see Limits Related to Topics in the Amazon SNS Developer Guide.

    " + }, + "Unsubscribe":{ + "name":"Unsubscribe", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UnsubscribeInput"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InternalErrorException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"NotFoundException"}, + {"shape":"InvalidSecurityException"} + ], + "documentation":"

    Deletes a subscription. If the subscription requires authentication for deletion, only the owner of the subscription or the topic's owner can unsubscribe, and an AWS signature is required. If the Unsubscribe call does not require authentication and the requester is not the subscription owner, a final cancellation message is delivered to the endpoint, so that the endpoint owner can easily resubscribe to the topic if the Unsubscribe request was unintended.

    This action is throttled at 100 transactions per second (TPS).

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{ + "shape":"UntagResourceResponse", + "resultWrapper":"UntagResourceResult" + }, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TagLimitExceededException"}, + {"shape":"StaleTagException"}, + {"shape":"TagPolicyException"}, + {"shape":"InvalidParameterException"}, + {"shape":"AuthorizationErrorException"}, + {"shape":"ConcurrentAccessException"} + ], + "documentation":"

    Remove tags from the specified Amazon SNS topic. For an overview, see Amazon SNS Tags in the Amazon SNS Developer Guide.

    " + } + }, + "shapes":{ + "ActionsList":{ + "type":"list", + "member":{"shape":"action"} + }, + "AddPermissionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Label", + "AWSAccountId", + "ActionName" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic whose access control policy you wish to modify.

    " + }, + "Label":{ + "shape":"label", + "documentation":"

    A unique identifier for the new policy statement.

    " + }, + "AWSAccountId":{ + "shape":"DelegatesList", + "documentation":"

    The AWS account IDs of the users (principals) who will be given access to the specified actions. The users must have AWS accounts, but do not need to be signed up for this service.

    " + }, + "ActionName":{ + "shape":"ActionsList", + "documentation":"

    The action you want to allow for the specified principal(s).

    Valid values: any Amazon SNS action name.

    " + } + } + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1 + }, + "AuthorizationErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that the user has been denied access to the requested resource.

    ", + "error":{ + "code":"AuthorizationError", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "Binary":{"type":"blob"}, + "CheckIfPhoneNumberIsOptedOutInput":{ + "type":"structure", + "required":["phoneNumber"], + "members":{ + "phoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

    The phone number for which you want to check the opt out status.

    " + } + }, + "documentation":"

    The input for the CheckIfPhoneNumberIsOptedOut action.

    " + }, + "CheckIfPhoneNumberIsOptedOutResponse":{ + "type":"structure", + "members":{ + "isOptedOut":{ + "shape":"boolean", + "documentation":"

    Indicates whether the phone number is opted out:

    • true – The phone number is opted out, meaning you cannot publish SMS messages to it.

    • false – The phone number is opted in, meaning you can publish SMS messages to it.

    " + } + }, + "documentation":"

    The response from the CheckIfPhoneNumberIsOptedOut action.

    " + }, + "ConcurrentAccessException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Can't perform multiple operations on a tag simultaneously. Perform the operations sequentially.

    ", + "error":{ + "code":"ConcurrentAccess", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ConfirmSubscriptionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Token" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic for which you wish to confirm a subscription.

    " + }, + "Token":{ + "shape":"token", + "documentation":"

    Short-lived token sent to an endpoint during the Subscribe action.

    " + }, + "AuthenticateOnUnsubscribe":{ + "shape":"authenticateOnUnsubscribe", + "documentation":"

    Disallows unauthenticated unsubscribes of the subscription. If the value of this parameter is true and the request has an AWS signature, then only the topic owner and the subscription owner can unsubscribe the endpoint. The unsubscribe action requires AWS authentication.

    " + } + }, + "documentation":"

    Input for ConfirmSubscription action.

    " + }, + "ConfirmSubscriptionResponse":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The ARN of the created subscription.

    " + } + }, + "documentation":"

    Response for ConfirmSubscriptions action.

    " + }, + "CreateEndpointResponse":{ + "type":"structure", + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

    EndpointArn returned from CreateEndpoint action.

    " + } + }, + "documentation":"

    Response from CreateEndpoint action.

    " + }, + "CreatePlatformApplicationInput":{ + "type":"structure", + "required":[ + "Name", + "Platform", + "Attributes" + ], + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.

    " + }, + "Platform":{ + "shape":"String", + "documentation":"

    The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    For a list of attributes, see SetPlatformApplicationAttributes

    " + } + }, + "documentation":"

    Input for CreatePlatformApplication action.

    " + }, + "CreatePlatformApplicationResponse":{ + "type":"structure", + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn is returned.

    " + } + }, + "documentation":"

    Response from CreatePlatformApplication action.

    " + }, + "CreatePlatformEndpointInput":{ + "type":"structure", + "required":[ + "PlatformApplicationArn", + "Token" + ], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.

    " + }, + "Token":{ + "shape":"String", + "documentation":"

    Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.

    " + }, + "CustomUserData":{ + "shape":"String", + "documentation":"

    Arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    For a list of attributes, see SetEndpointAttributes.

    " + } + }, + "documentation":"

    Input for CreatePlatformEndpoint action.

    " + }, + "CreateTopicInput":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"topicName", + "documentation":"

    The name of the topic you want to create.

    Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

    " + }, + "Attributes":{ + "shape":"TopicAttributesMap", + "documentation":"

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • DisplayName – The display name to use for a topic with SMS subscriptions.

    • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

    The following attribute applies only to server-side-encryption:

    • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The list of tags to add to a new topic.

    " + } + }, + "documentation":"

    Input for CreateTopic action.

    " + }, + "CreateTopicResponse":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The Amazon Resource Name (ARN) assigned to the created topic.

    " + } + }, + "documentation":"

    Response from CreateTopic action.

    " + }, + "DelegatesList":{ + "type":"list", + "member":{"shape":"delegate"} + }, + "DeleteEndpointInput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

    EndpointArn of endpoint to delete.

    " + } + }, + "documentation":"

    Input for DeleteEndpoint action.

    " + }, + "DeletePlatformApplicationInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn of platform application object to delete.

    " + } + }, + "documentation":"

    Input for DeletePlatformApplication action.

    " + }, + "DeleteTopicInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic you want to delete.

    " + } + } + }, + "Endpoint":{ + "type":"structure", + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

    EndpointArn for mobile app and device.

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    Attributes for endpoint.

    " + } + }, + "documentation":"

    Endpoint for mobile app and device.

    " + }, + "EndpointDisabledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    Message for endpoint disabled.

    " + } + }, + "documentation":"

    Exception error indicating endpoint disabled.

    ", + "error":{ + "code":"EndpointDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "FilterPolicyLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that the number of filter polices in your AWS account exceeds the limit. To add more filter polices, submit an SNS Limit Increase case in the AWS Support Center.

    ", + "error":{ + "code":"FilterPolicyLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "GetEndpointAttributesInput":{ + "type":"structure", + "required":["EndpointArn"], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

    EndpointArn for GetEndpointAttributes input.

    " + } + }, + "documentation":"

    Input for GetEndpointAttributes action.

    " + }, + "GetEndpointAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    Attributes include the following:

    • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

    • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

    • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

    " + } + }, + "documentation":"

    Response from GetEndpointAttributes of the EndpointArn.

    " + }, + "GetPlatformApplicationAttributesInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn for GetPlatformApplicationAttributesInput.

    " + } + }, + "documentation":"

    Input for GetPlatformApplicationAttributes action.

    " + }, + "GetPlatformApplicationAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    Attributes include the following:

    • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

    • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

    • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

    • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

    " + } + }, + "documentation":"

    Response for GetPlatformApplicationAttributes action.

    " + }, + "GetSMSAttributesInput":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"ListString", + "documentation":"

    A list of the individual attribute names, such as MonthlySpendLimit, for which you want values.

    For all attribute names, see SetSMSAttributes.

    If you don't use this parameter, Amazon SNS returns all SMS attributes.

    " + } + }, + "documentation":"

    The input for the GetSMSAttributes request.

    " + }, + "GetSMSAttributesResponse":{ + "type":"structure", + "members":{ + "attributes":{ + "shape":"MapStringToString", + "documentation":"

    The SMS attribute names and their values.

    " + } + }, + "documentation":"

    The response from the GetSMSAttributes request.

    " + }, + "GetSubscriptionAttributesInput":{ + "type":"structure", + "required":["SubscriptionArn"], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The ARN of the subscription whose properties you want to get.

    " + } + }, + "documentation":"

    Input for GetSubscriptionAttributes.

    " + }, + "GetSubscriptionAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"SubscriptionAttributesMap", + "documentation":"

    A map of the subscription's attributes. Attributes in this map include the following:

    • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

    • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

    • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

    • FilterPolicy – The filter policy JSON that is assigned to the subscription.

    • Owner – The AWS account ID of the subscription's owner.

    • PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

    • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

    • SubscriptionArn – The subscription's ARN.

    • TopicArn – The topic ARN that the subscription is associated with.

    " + } + }, + "documentation":"

    Response for GetSubscriptionAttributes action.

    " + }, + "GetTopicAttributesInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic whose properties you want to get.

    " + } + }, + "documentation":"

    Input for GetTopicAttributes action.

    " + }, + "GetTopicAttributesResponse":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"TopicAttributesMap", + "documentation":"

    A map of the topic's attributes. Attributes in this map include the following:

    • TopicArn – the topic's ARN

    • Owner – the AWS account ID of the topic's owner

    • Policy – the JSON serialization of the topic's access control policy

    • DisplayName – the human-readable name used in the \"From\" field for notifications to email and email-json endpoints

    • SubscriptionsPending – the number of subscriptions pending confirmation on this topic

    • SubscriptionsConfirmed – the number of confirmed subscriptions on this topic

    • SubscriptionsDeleted – the number of deleted subscriptions on this topic

    • DeliveryPolicy – the JSON serialization of the topic's delivery policy

    • EffectiveDeliveryPolicy – the JSON serialization of the effective delivery policy that takes into account system defaults

    " + } + }, + "documentation":"

    Response for GetTopicAttributes action.

    " + }, + "InternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates an internal service error.

    ", + "error":{ + "code":"InternalError", + "httpStatusCode":500 + }, + "exception":true, + "fault":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that a request parameter does not comply with the associated constraints.

    ", + "error":{ + "code":"InvalidParameter", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    The parameter value is invalid.

    " + } + }, + "documentation":"

    Indicates that a request parameter does not comply with the associated constraints.

    ", + "error":{ + "code":"ParameterValueInvalid", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidSecurityException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

    ", + "error":{ + "code":"InvalidSecurity", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "KMSAccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The ciphertext references a key that doesn't exist or that you don't have access to.

    ", + "error":{ + "code":"KMSAccessDenied", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSDisabledException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The request was rejected because the specified customer master key (CMK) isn't enabled.

    ", + "error":{ + "code":"KMSDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSInvalidStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The request was rejected because the state of the specified resource isn't valid for this request. For more information, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

    ", + "error":{ + "code":"KMSInvalidState", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The request was rejected because the specified entity or resource can't be found.

    ", + "error":{ + "code":"KMSNotFound", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "KMSOptInRequired":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The AWS access key ID needs a subscription for the service.

    ", + "error":{ + "code":"KMSOptInRequired", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "KMSThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The request was denied due to request throttling. For more information about throttling, see Limits in the AWS Key Management Service Developer Guide.

    ", + "error":{ + "code":"KMSThrottling", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "ListEndpointsByPlatformApplicationInput":{ + "type":"structure", + "required":["PlatformApplicationArn"], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.

    " + } + }, + "documentation":"

    Input for ListEndpointsByPlatformApplication action.

    " + }, + "ListEndpointsByPlatformApplicationResponse":{ + "type":"structure", + "members":{ + "Endpoints":{ + "shape":"ListOfEndpoints", + "documentation":"

    Endpoints returned for ListEndpointsByPlatformApplication action.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.

    " + } + }, + "documentation":"

    Response for ListEndpointsByPlatformApplication action.

    " + }, + "ListOfEndpoints":{ + "type":"list", + "member":{"shape":"Endpoint"} + }, + "ListOfPlatformApplications":{ + "type":"list", + "member":{"shape":"PlatformApplication"} + }, + "ListPhoneNumbersOptedOutInput":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"string", + "documentation":"

    A NextToken string is used when you call the ListPhoneNumbersOptedOut action to retrieve additional records that are available after the first page of results.

    " + } + }, + "documentation":"

    The input for the ListPhoneNumbersOptedOut action.

    " + }, + "ListPhoneNumbersOptedOutResponse":{ + "type":"structure", + "members":{ + "phoneNumbers":{ + "shape":"PhoneNumberList", + "documentation":"

    A list of phone numbers that are opted out of receiving SMS messages. The list is paginated, and each page can contain up to 100 phone numbers.

    " + }, + "nextToken":{ + "shape":"string", + "documentation":"

    A NextToken string is returned when you call the ListPhoneNumbersOptedOut action if additional records are available after the first page of results.

    " + } + }, + "documentation":"

    The response from the ListPhoneNumbersOptedOut action.

    " + }, + "ListPlatformApplicationsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

    NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.

    " + } + }, + "documentation":"

    Input for ListPlatformApplications action.

    " + }, + "ListPlatformApplicationsResponse":{ + "type":"structure", + "members":{ + "PlatformApplications":{ + "shape":"ListOfPlatformApplications", + "documentation":"

    Platform applications returned when calling ListPlatformApplications action.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.

    " + } + }, + "documentation":"

    Response for ListPlatformApplications action.

    " + }, + "ListString":{ + "type":"list", + "member":{"shape":"String"} + }, + "ListSubscriptionsByTopicInput":{ + "type":"structure", + "required":["TopicArn"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic for which you wish to find subscriptions.

    " + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token returned by the previous ListSubscriptionsByTopic request.

    " + } + }, + "documentation":"

    Input for ListSubscriptionsByTopic action.

    " + }, + "ListSubscriptionsByTopicResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionsList", + "documentation":"

    A list of subscriptions.

    " + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token to pass along to the next ListSubscriptionsByTopic request. This element is returned if there are more subscriptions to retrieve.

    " + } + }, + "documentation":"

    Response for ListSubscriptionsByTopic action.

    " + }, + "ListSubscriptionsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token returned by the previous ListSubscriptions request.

    " + } + }, + "documentation":"

    Input for ListSubscriptions action.

    " + }, + "ListSubscriptionsResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionsList", + "documentation":"

    A list of subscriptions.

    " + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token to pass along to the next ListSubscriptions request. This element is returned if there are more subscriptions to retrieve.

    " + } + }, + "documentation":"

    Response for ListSubscriptions action

    " + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the topic for which to list tags.

    " + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags associated with the specified topic.

    " + } + } + }, + "ListTopicsInput":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token returned by the previous ListTopics request.

    " + } + } + }, + "ListTopicsResponse":{ + "type":"structure", + "members":{ + "Topics":{ + "shape":"TopicsList", + "documentation":"

    A list of topic ARNs.

    " + }, + "NextToken":{ + "shape":"nextToken", + "documentation":"

    Token to pass along to the next ListTopics request. This element is returned if there are additional topics to retrieve.

    " + } + }, + "documentation":"

    Response for ListTopics action.

    " + }, + "MapStringToString":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "MessageAttributeMap":{ + "type":"map", + "key":{ + "shape":"String", + "locationName":"Name" + }, + "value":{ + "shape":"MessageAttributeValue", + "locationName":"Value" + } + }, + "MessageAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "DataType":{ + "shape":"String", + "documentation":"

    Amazon SNS supports the following logical data types: String, String.Array, Number, and Binary. For more information, see Message Attribute Data Types.

    " + }, + "StringValue":{ + "shape":"String", + "documentation":"

    Strings are Unicode with UTF8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " + }, + "BinaryValue":{ + "shape":"Binary", + "documentation":"

    Binary type attributes can store any binary data, for example, compressed data, encrypted data, or images.

    " + } + }, + "documentation":"

    The user-specified message attribute value. For string data types, the value attribute has the same restrictions on the content as the message body. For more information, see Publish.

    Name, type, and value must not be empty or null. In addition, the message body should not be empty or null. All parts of the message attribute, including name, type, and value, are included in the message size restriction, which is currently 256 KB (262,144 bytes). For more information, see Using Amazon SNS Message Attributes.

    " + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that the requested resource does not exist.

    ", + "error":{ + "code":"NotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "OptInPhoneNumberInput":{ + "type":"structure", + "required":["phoneNumber"], + "members":{ + "phoneNumber":{ + "shape":"PhoneNumber", + "documentation":"

    The phone number to opt in.

    " + } + }, + "documentation":"

    Input for the OptInPhoneNumber action.

    " + }, + "OptInPhoneNumberResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The response for the OptInPhoneNumber action.

    " + }, + "PhoneNumber":{"type":"string"}, + "PhoneNumberList":{ + "type":"list", + "member":{"shape":"PhoneNumber"} + }, + "PlatformApplication":{ + "type":"structure", + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn for platform application object.

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    Attributes for platform application object.

    " + } + }, + "documentation":"

    Platform application object.

    " + }, + "PlatformApplicationDisabledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    Message for platform application disabled.

    " + } + }, + "documentation":"

    Exception error indicating platform application disabled.

    ", + "error":{ + "code":"PlatformApplicationDisabled", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PublishInput":{ + "type":"structure", + "required":["Message"], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The topic you want to publish to.

    If you don't specify a value for the TopicArn parameter, you must specify a value for the PhoneNumber or TargetArn parameters.

    " + }, + "TargetArn":{ + "shape":"String", + "documentation":"

    If you don't specify a value for the TargetArn parameter, you must specify a value for the PhoneNumber or TopicArn parameters.

    " + }, + "PhoneNumber":{ + "shape":"String", + "documentation":"

    The phone number to which you want to deliver an SMS message. Use E.164 format.

    If you don't specify a value for the PhoneNumber parameter, you must specify a value for the TargetArn or TopicArn parameters.

    " + }, + "Message":{ + "shape":"message", + "documentation":"

    The message you want to send.

    The Message parameter is always a string. If you set MessageStructure to json, you must string-encode the Message parameter.

    If you are publishing to a topic and you want to send the same message to all transport protocols, include the text of the message as a String value. If you want to send different messages for each transport protocol, set the value of the MessageStructure parameter to json and use a JSON object for the Message parameter.

    Constraints:

    • With the exception of SMS, messages must be UTF-8 encoded strings and at most 256 KB in size (262,144 bytes, not 262,144 characters).

    • For SMS, each message can contain up to 140 characters. This character limit depends on the encoding schema. For example, an SMS message can contain 160 GSM characters, 140 ASCII characters, or 70 UCS-2 characters.

      If you publish a message that exceeds this size limit, Amazon SNS sends the message as multiple messages, each fitting within the size limit. Messages aren't truncated mid-word but are cut off at whole-word boundaries.

      The total size limit for a single SMS Publish action is 1,600 characters.

    JSON-specific constraints:

    • Keys in the JSON object that correspond to supported transport protocols must have simple JSON string values.

    • The values will be parsed (unescaped) before they are used in outgoing messages.

    • Outbound notifications are JSON encoded (meaning that the characters will be reescaped for sending).

    • Values have a minimum length of 0 (the empty string, \"\", is allowed).

    • Values have a maximum length bounded by the overall message size (so, including multiple protocols may limit message sizes).

    • Non-string values will cause the key to be ignored.

    • Keys that do not correspond to supported transport protocols are ignored.

    • Duplicate keys are not allowed.

    • Failure to parse or validate any key or value in the message will cause the Publish call to return an error (no partial delivery).

    " + }, + "Subject":{ + "shape":"subject", + "documentation":"

    Optional parameter to be used as the \"Subject\" line when the message is delivered to email endpoints. This field will also be included, if present, in the standard JSON messages delivered to other endpoints.

    Constraints: Subjects must be ASCII text that begins with a letter, number, or punctuation mark; must not include line breaks or control characters; and must be less than 100 characters long.

    " + }, + "MessageStructure":{ + "shape":"messageStructure", + "documentation":"

    Set MessageStructure to json if you want to send a different message for each protocol. For example, using one publish action, you can send a short message to your SMS subscribers and a longer message to your email subscribers. If you set MessageStructure to json, the value of the Message parameter must:

    • be a syntactically valid JSON object; and

    • contain at least a top-level JSON key of \"default\" with a value that is a string.

    You can define other top-level keys that define the message you want to send to a specific transport protocol (e.g., \"http\").

    For information about sending different messages for each protocol using the AWS Management Console, go to Create Different Messages for Each Protocol in the Amazon Simple Notification Service Getting Started Guide.

    Valid value: json

    " + }, + "MessageAttributes":{ + "shape":"MessageAttributeMap", + "documentation":"

    Message attributes for Publish action.

    " + } + }, + "documentation":"

    Input for Publish action.

    " + }, + "PublishResponse":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"messageId", + "documentation":"

    Unique identifier assigned to the published message.

    Length Constraint: Maximum 100 characters

    " + } + }, + "documentation":"

    Response for Publish action.

    " + }, + "RemovePermissionInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Label" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic whose access control policy you wish to modify.

    " + }, + "Label":{ + "shape":"label", + "documentation":"

    The unique label of the statement you want to remove.

    " + } + }, + "documentation":"

    Input for RemovePermission action.

    " + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Can't tag resource. Verify that the topic exists.

    ", + "error":{ + "code":"ResourceNotFound", + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "SetEndpointAttributesInput":{ + "type":"structure", + "required":[ + "EndpointArn", + "Attributes" + ], + "members":{ + "EndpointArn":{ + "shape":"String", + "documentation":"

    EndpointArn used for SetEndpointAttributes action.

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    A map of the endpoint attributes. Attributes in this map include the following:

    • CustomUserData – arbitrary user data to associate with the endpoint. Amazon SNS does not use this data. The data must be in UTF-8 format and less than 2KB.

    • Enabled – flag that enables/disables delivery to the endpoint. Amazon SNS will set this to false when a notification service indicates to Amazon SNS that the endpoint is invalid. Users can set it back to true, typically after updating Token.

    • Token – device token, also referred to as a registration id, for an app and mobile device. This is returned from the notification service when an app and mobile device are registered with the notification service.

    " + } + }, + "documentation":"

    Input for SetEndpointAttributes action.

    " + }, + "SetPlatformApplicationAttributesInput":{ + "type":"structure", + "required":[ + "PlatformApplicationArn", + "Attributes" + ], + "members":{ + "PlatformApplicationArn":{ + "shape":"String", + "documentation":"

    PlatformApplicationArn for SetPlatformApplicationAttributes action.

    " + }, + "Attributes":{ + "shape":"MapStringToString", + "documentation":"

    A map of the platform application attributes. Attributes in this map include the following:

    • PlatformCredential – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For GCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".

    • PlatformPrincipal – The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".

    • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

    • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

    • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

    • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

    • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

    • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

    " + } + }, + "documentation":"

    Input for SetPlatformApplicationAttributes action.

    " + }, + "SetSMSAttributesInput":{ + "type":"structure", + "required":["attributes"], + "members":{ + "attributes":{ + "shape":"MapStringToString", + "documentation":"

    The default settings for sending SMS messages from your account. You can set values for the following attribute names:

    MonthlySpendLimit – The maximum amount in USD that you are willing to spend each month to send SMS messages. When Amazon SNS determines that sending an SMS message would incur a cost that exceeds this limit, it stops sending SMS messages within minutes.

    Amazon SNS stops sending SMS messages within minutes of the limit being crossed. During that interval, if you continue to send SMS messages, you will incur costs that exceed your limit.

    By default, the spend limit is set to the maximum allowed by Amazon SNS. If you want to raise the limit, submit an SNS Limit Increase case. For New limit value, enter your desired monthly spend limit. In the Use Case Description field, explain that you are requesting an SMS monthly spend limit increase.

    DeliveryStatusIAMRole – The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. For each SMS message that you send, Amazon SNS writes a log that includes the message price, the success or failure status, the reason for failure (if the message failed), the message dwell time, and other information.

    DeliveryStatusSuccessSamplingRate – The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value can be an integer from 0 - 100. For example, to write logs only for failed deliveries, set this value to 0. To write logs for 10% of your successful deliveries, set it to 10.

    DefaultSenderID – A string, such as your business brand, that is displayed as the sender on the receiving device. Support for sender IDs varies by country. The sender ID can be 1 - 11 alphanumeric characters, and it must contain at least one letter.

    DefaultSMSType – The type of SMS message that you will send by default. You can assign the following values:

    • Promotional – (Default) Noncritical messages, such as marketing messages. Amazon SNS optimizes the message delivery to incur the lowest cost.

    • Transactional – Critical messages that support customer transactions, such as one-time passcodes for multi-factor authentication. Amazon SNS optimizes the message delivery to achieve the highest reliability.

    UsageReportS3Bucket – The name of the Amazon S3 bucket to receive daily SMS usage reports from Amazon SNS. Each day, Amazon SNS will deliver a usage report as a CSV file to the bucket. The report includes the following information for each SMS message that was successfully delivered by your account:

    • Time that the message was published (in UTC)

    • Message ID

    • Destination phone number

    • Message type

    • Delivery status

    • Message price (in USD)

    • Part number (a message is split into multiple parts if it is too long for a single message)

    • Total number of parts

    To receive the report, the bucket must have a policy that allows the Amazon SNS service principle to perform the s3:PutObject and s3:GetBucketLocation actions.

    For an example bucket policy and usage report, see Monitoring SMS Activity in the Amazon SNS Developer Guide.

    " + } + }, + "documentation":"

    The input for the SetSMSAttributes action.

    " + }, + "SetSMSAttributesResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The response for the SetSMSAttributes action.

    " + }, + "SetSubscriptionAttributesInput":{ + "type":"structure", + "required":[ + "SubscriptionArn", + "AttributeName" + ], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The ARN of the subscription to modify.

    " + }, + "AttributeName":{ + "shape":"attributeName", + "documentation":"

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

    • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

    " + }, + "AttributeValue":{ + "shape":"attributeValue", + "documentation":"

    The new value for the attribute in JSON format.

    " + } + }, + "documentation":"

    Input for SetSubscriptionAttributes action.

    " + }, + "SetTopicAttributesInput":{ + "type":"structure", + "required":[ + "TopicArn", + "AttributeName" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic to modify.

    " + }, + "AttributeName":{ + "shape":"attributeName", + "documentation":"

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • DisplayName – The display name to use for a topic with SMS subscriptions.

    • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

    The following attribute applies only to server-side-encryption:

    • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

    " + }, + "AttributeValue":{ + "shape":"attributeValue", + "documentation":"

    The new value for the attribute.

    " + } + }, + "documentation":"

    Input for SetTopicAttributes action.

    " + }, + "StaleTagException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    A tag has been added to a resource with the same ARN as a deleted resource. Wait a short while and then retry the operation.

    ", + "error":{ + "code":"StaleTag", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "String":{"type":"string"}, + "SubscribeInput":{ + "type":"structure", + "required":[ + "TopicArn", + "Protocol" + ], + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the topic you want to subscribe to.

    " + }, + "Protocol":{ + "shape":"protocol", + "documentation":"

    The protocol you want to use. Supported protocols include:

    • http – delivery of JSON-encoded message via HTTP POST

    • https – delivery of JSON-encoded message via HTTPS POST

    • email – delivery of message via SMTP

    • email-json – delivery of JSON-encoded message via SMTP

    • sms – delivery of message via SMS

    • sqs – delivery of JSON-encoded message to an Amazon SQS queue

    • application – delivery of JSON-encoded message to an EndpointArn for a mobile app and device.

    • lambda – delivery of JSON-encoded message to an AWS Lambda function.

    " + }, + "Endpoint":{ + "shape":"endpoint", + "documentation":"

    The endpoint that you want to receive notifications. Endpoints vary by protocol:

    • For the http protocol, the endpoint is an URL beginning with \"https://\"

    • For the https protocol, the endpoint is a URL beginning with \"https://\"

    • For the email protocol, the endpoint is an email address

    • For the email-json protocol, the endpoint is an email address

    • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

    • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

    • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

    • For the lambda protocol, the endpoint is the ARN of an AWS Lambda function.

    " + }, + "Attributes":{ + "shape":"SubscriptionAttributesMap", + "documentation":"

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

    • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

    • FilterPolicy – The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.

    • RawMessageDelivery – When set to true, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.

    " + }, + "ReturnSubscriptionArn":{ + "shape":"boolean", + "documentation":"

    Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

    If you set this parameter to false, the response includes the ARN for confirmed subscriptions, but it includes an ARN value of \"pending subscription\" for subscriptions that are not yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

    If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

    The default value is false.

    " + } + }, + "documentation":"

    Input for Subscribe action.

    " + }, + "SubscribeResponse":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The ARN of the subscription if it is confirmed, or the string \"pending confirmation\" if the subscription requires confirmation. However, if the API request parameter ReturnSubscriptionArn is true, then the value is always the subscription ARN, even if the subscription requires confirmation.

    " + } + }, + "documentation":"

    Response for Subscribe action.

    " + }, + "Subscription":{ + "type":"structure", + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The subscription's ARN.

    " + }, + "Owner":{ + "shape":"account", + "documentation":"

    The subscription's owner.

    " + }, + "Protocol":{ + "shape":"protocol", + "documentation":"

    The subscription's protocol.

    " + }, + "Endpoint":{ + "shape":"endpoint", + "documentation":"

    The subscription's endpoint (format depends on the protocol).

    " + }, + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The ARN of the subscription's topic.

    " + } + }, + "documentation":"

    A wrapper type for the attributes of an Amazon SNS subscription.

    " + }, + "SubscriptionAttributesMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"attributeValue"} + }, + "SubscriptionLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that the customer already owns the maximum allowed number of subscriptions.

    ", + "error":{ + "code":"SubscriptionLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "SubscriptionsList":{ + "type":"list", + "member":{"shape":"Subscription"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The required key portion of the tag.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The optional value portion of the tag.

    " + } + }, + "documentation":"

    The list of tags to be added to the specified topic.

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Can't add more than 50 tags to a topic.

    ", + "error":{ + "code":"TagLimitExceeded", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    The request doesn't comply with the IAM tag policy. Correct your request and then retry it.

    ", + "error":{ + "code":"TagPolicy", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the topic to which to add tags.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags to be added to the specified topic. A tag consists of a required key and an optional value.

    " + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "ThrottledException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    Throttled request.

    " + } + }, + "documentation":"

    Indicates that the rate at which requests have been submitted for this action exceeds the limit for your account.

    ", + "error":{ + "code":"Throttled", + "httpStatusCode":429, + "senderFault":true + }, + "exception":true + }, + "Topic":{ + "type":"structure", + "members":{ + "TopicArn":{ + "shape":"topicARN", + "documentation":"

    The topic's ARN.

    " + } + }, + "documentation":"

    A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use GetTopicAttributes.

    " + }, + "TopicAttributesMap":{ + "type":"map", + "key":{"shape":"attributeName"}, + "value":{"shape":"attributeValue"} + }, + "TopicLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"string"} + }, + "documentation":"

    Indicates that the customer already owns the maximum allowed number of topics.

    ", + "error":{ + "code":"TopicLimitExceeded", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "TopicsList":{ + "type":"list", + "member":{"shape":"Topic"} + }, + "UnsubscribeInput":{ + "type":"structure", + "required":["SubscriptionArn"], + "members":{ + "SubscriptionArn":{ + "shape":"subscriptionARN", + "documentation":"

    The ARN of the subscription to be deleted.

    " + } + }, + "documentation":"

    Input for Unsubscribe action.

    " + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"AmazonResourceName", + "documentation":"

    The ARN of the topic from which to remove tags.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The list of tag keys to remove from the specified topic.

    " + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "account":{"type":"string"}, + "action":{"type":"string"}, + "attributeName":{"type":"string"}, + "attributeValue":{"type":"string"}, + "authenticateOnUnsubscribe":{"type":"string"}, + "boolean":{"type":"boolean"}, + "delegate":{"type":"string"}, + "endpoint":{"type":"string"}, + "label":{"type":"string"}, + "message":{"type":"string"}, + "messageId":{"type":"string"}, + "messageStructure":{"type":"string"}, + "nextToken":{"type":"string"}, + "protocol":{"type":"string"}, + "string":{"type":"string"}, + "subject":{"type":"string"}, + "subscriptionARN":{"type":"string"}, + "token":{"type":"string"}, + "topicARN":{"type":"string"}, + "topicName":{"type":"string"} + }, + "documentation":"Amazon Simple Notification Service

    Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. Applications can use Amazon SNS to easily push real-time notification messages to interested subscribers over multiple delivery protocols. For more information about this product see https://aws.amazon.com/sns. For detailed information about Amazon SNS features and their associated API calls, see the Amazon SNS Developer Guide.

    We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, retrying requests, and handling error responses. For a list of available SDKs, go to Tools for Amazon Web Services.

    " +} diff --git a/aws/dist/botocore/data/sqs/2012-11-05/examples-1.json b/aws/dist/botocore/data/sqs/2012-11-05/examples-1.json new file mode 100644 index 00000000..9dc8ac74 --- /dev/null +++ b/aws/dist/botocore/data/sqs/2012-11-05/examples-1.json @@ -0,0 +1,44 @@ +{ + "version": "1.0", + "examples": { + "CreateQueue": [ + { + "input": { + "QueueName": "MyQueue" + }, + "output": { + "QueueUrl": "https://queue.amazonaws.com/012345678910/MyQueue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following operation creates an SQS queue named MyQueue.", + "id": "create-an-sqs-queue-1445915686197", + "title": "Create an SQS queue" + } + ], + "GetQueueUrl": [ + { + "input": { + "QueueName": "MyQueue", + "QueueOwnerAWSAccountId": "12345678910" + }, + "output": { + "QueueUrl": "https://queue.amazonaws.com/123456789101112/MyQueue" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example retrieves the queue ARN.", + "id": "retrieve-queue-attributes-from-an-sqs-queue-1445915930574", + "title": "Retrieve queue attributes from an SQS queue" + } + ] + } +} diff --git a/aws/dist/botocore/data/sqs/2012-11-05/paginators-1.json b/aws/dist/botocore/data/sqs/2012-11-05/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/sqs/2012-11-05/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/sqs/2012-11-05/service-2.json b/aws/dist/botocore/data/sqs/2012-11-05/service-2.json new file mode 100644 index 00000000..2a50ef13 --- /dev/null +++ b/aws/dist/botocore/data/sqs/2012-11-05/service-2.json @@ -0,0 +1,1495 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-11-05", + "endpointPrefix":"sqs", + "protocol":"query", + "serviceAbbreviation":"Amazon SQS", + "serviceFullName":"Amazon Simple Queue Service", + "serviceId":"SQS", + "signatureVersion":"v4", + "uid":"sqs-2012-11-05", + "xmlNamespace":"http://queue.amazonaws.com/doc/2012-11-05/" + }, + "operations":{ + "AddPermission":{ + "name":"AddPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddPermissionRequest"}, + "errors":[ + {"shape":"OverLimit"} + ], + "documentation":"

    Adds a permission to a queue for a specific principal. This allows sharing access to the queue.

    When you create a queue, you have full control access rights for the queue. Only you, the owner of the queue, can grant or deny permissions to the queue. For more information about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    • AddPermission generates a policy for you. You can use SetQueueAttributes to upload your policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in the Amazon Simple Queue Service Developer Guide.

    • An Amazon SQS policy can have a maximum of 7 actions.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "ChangeMessageVisibility":{ + "name":"ChangeMessageVisibility", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityRequest"}, + "errors":[ + {"shape":"MessageNotInflight"}, + {"shape":"ReceiptHandleIsInvalid"} + ], + "documentation":"

    Changes the visibility timeout of a specified message in a queue to a new value. The default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The maximum is 12 hours. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    For example, you have a message with a visibility timeout of 5 minutes. After 3 minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You can continue to call ChangeMessageVisibility to extend the visibility timeout to the maximum allowed time. If you try to extend the visibility timeout beyond the maximum, your request is rejected.

    An Amazon SQS message has three basic states:

    1. Sent to a queue by a producer.

    2. Received from the queue by a consumer.

    3. Deleted from the queue.

    A message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages. A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.

    Limits that apply to inflight messages are unrelated to the unlimited number of stored messages.

    For most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns the OverLimit error message. To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages. To request a limit increase, file a support request.

    For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.

    If you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.

    Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.

    " + }, + "ChangeMessageVisibilityBatch":{ + "name":"ChangeMessageVisibilityBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ChangeMessageVisibilityBatchRequest"}, + "output":{ + "shape":"ChangeMessageVisibilityBatchResult", + "resultWrapper":"ChangeMessageVisibilityBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"InvalidBatchEntryId"} + ], + "documentation":"

    Changes the visibility timeout of multiple messages. This is a batch version of ChangeMessageVisibility. The result of the action on each message is reported individually in the response. You can send up to 10 ChangeMessageVisibility requests with each ChangeMessageVisibilityBatch action.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    " + }, + "CreateQueue":{ + "name":"CreateQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateQueueRequest"}, + "output":{ + "shape":"CreateQueueResult", + "resultWrapper":"CreateQueueResult" + }, + "errors":[ + {"shape":"QueueDeletedRecently"}, + {"shape":"QueueNameExists"} + ], + "documentation":"

    Creates a new standard or FIFO queue. You can pass one or more attributes in the request. Keep the following caveats in mind:

    • If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.

      You can't change the queue type after you create it and you can't convert an existing standard queue into a FIFO queue. You must either create a new FIFO queue for your application or delete your existing standard queue and recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the Amazon Simple Queue Service Developer Guide.

    • If you don't provide a value for an attribute, the queue is created with the default value for the attribute.

    • If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    To successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.

    To get the queue URL, use the GetQueueUrl action. GetQueueUrl requires only the QueueName parameter. be aware of existing queue names:

    • If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.

    • If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "DeleteMessage":{ + "name":"DeleteMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageRequest"}, + "errors":[ + {"shape":"InvalidIdFormat"}, + {"shape":"ReceiptHandleIsInvalid"} + ], + "documentation":"

    Deletes the specified message from the specified queue. To select the message to delete, use the ReceiptHandle of the message (not the MessageId which you receive when you send the message). Amazon SQS can delete a message from a queue even if a visibility timeout setting causes the message to be locked by another consumer. Amazon SQS automatically deletes messages left in a queue longer than the retention period configured for the queue.

    The ReceiptHandle is associated with a specific instance of receiving a message. If you receive a message more than once, the ReceiptHandle is different each time you receive a message. When you use the DeleteMessage action, you must provide the most recently received ReceiptHandle for the message (otherwise, the request succeeds, but the message might not be deleted).

    For standard queues, it is possible to receive a message even after you delete it. This might happen on rare occasions if one of the servers which stores a copy of the message is unavailable when you send the request to delete the message. The copy remains on the server and might be returned to you during a subsequent receive request. You should ensure that your application is idempotent, so that receiving a message more than once does not cause issues.

    " + }, + "DeleteMessageBatch":{ + "name":"DeleteMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMessageBatchRequest"}, + "output":{ + "shape":"DeleteMessageBatchResult", + "resultWrapper":"DeleteMessageBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"InvalidBatchEntryId"} + ], + "documentation":"

    Deletes up to ten messages from the specified queue. This is a batch version of DeleteMessage. The result of the action on each message is reported individually in the response.

    Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    " + }, + "DeleteQueue":{ + "name":"DeleteQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteQueueRequest"}, + "documentation":"

    Deletes the queue specified by the QueueUrl, regardless of the queue's contents. If the specified queue doesn't exist, Amazon SQS returns a successful response.

    Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.

    When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a SendMessage request might succeed, but after 60 seconds the queue and the message you sent no longer exist.

    When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "GetQueueAttributes":{ + "name":"GetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueAttributesRequest"}, + "output":{ + "shape":"GetQueueAttributesResult", + "resultWrapper":"GetQueueAttributesResult" + }, + "errors":[ + {"shape":"InvalidAttributeName"} + ], + "documentation":"

    Gets attributes for the specified queue.

    To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    " + }, + "GetQueueUrl":{ + "name":"GetQueueUrl", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetQueueUrlRequest"}, + "output":{ + "shape":"GetQueueUrlResult", + "resultWrapper":"GetQueueUrlResult" + }, + "errors":[ + {"shape":"QueueDoesNotExist"} + ], + "documentation":"

    Returns the URL of an existing Amazon SQS queue.

    To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. For more information about shared queue access, see AddPermission or see Allow Developers to Write Messages to a Shared Queue in the Amazon Simple Queue Service Developer Guide.

    " + }, + "ListDeadLetterSourceQueues":{ + "name":"ListDeadLetterSourceQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDeadLetterSourceQueuesRequest"}, + "output":{ + "shape":"ListDeadLetterSourceQueuesResult", + "resultWrapper":"ListDeadLetterSourceQueuesResult" + }, + "errors":[ + {"shape":"QueueDoesNotExist"} + ], + "documentation":"

    Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

    " + }, + "ListQueueTags":{ + "name":"ListQueueTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQueueTagsRequest"}, + "output":{ + "shape":"ListQueueTagsResult", + "resultWrapper":"ListQueueTagsResult" + }, + "documentation":"

    List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "ListQueues":{ + "name":"ListQueues", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListQueuesRequest"}, + "output":{ + "shape":"ListQueuesResult", + "resultWrapper":"ListQueuesResult" + }, + "documentation":"

    Returns a list of your queues. The maximum number of queues that can be returned is 1,000. If you specify a value for the optional QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "PurgeQueue":{ + "name":"PurgeQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PurgeQueueRequest"}, + "errors":[ + {"shape":"QueueDoesNotExist"}, + {"shape":"PurgeQueueInProgress"} + ], + "documentation":"

    Deletes the messages in a queue specified by the QueueURL parameter.

    When you use the PurgeQueue action, you can't retrieve any messages deleted from a queue.

    The message deletion process takes up to 60 seconds. We recommend waiting for 60 seconds regardless of your queue's size.

    Messages sent to the queue before you call PurgeQueue might be received but are deleted within the next minute.

    Messages sent to the queue after you call PurgeQueue might be deleted while the queue is being purged.

    " + }, + "ReceiveMessage":{ + "name":"ReceiveMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ReceiveMessageRequest"}, + "output":{ + "shape":"ReceiveMessageResult", + "resultWrapper":"ReceiveMessageResult" + }, + "errors":[ + {"shape":"OverLimit"} + ], + "documentation":"

    Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. For more information, see Amazon SQS Long Polling in the Amazon Simple Queue Service Developer Guide.

    Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.

    For each message returned, the response includes the following:

    • The message body.

    • An MD5 digest of the message body. For information about MD5, see RFC1321.

    • The MessageId you received when you sent the message to the queue.

    • The receipt handle.

    • The message attributes.

    • An MD5 digest of the message attributes.

    The receipt handle is the identifier you must provide when deleting the message. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.

    You can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue is used for the returned messages. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    " + }, + "RemovePermission":{ + "name":"RemovePermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemovePermissionRequest"}, + "documentation":"

    Revokes any permissions in the queue policy that matches the specified Label parameter.

    • Only the owner of a queue can remove permissions from it.

    • Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    " + }, + "SendMessage":{ + "name":"SendMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageRequest"}, + "output":{ + "shape":"SendMessageResult", + "resultWrapper":"SendMessageResult" + }, + "errors":[ + {"shape":"InvalidMessageContents"}, + {"shape":"UnsupportedOperation"} + ], + "documentation":"

    Delivers a message to the specified queue.

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    " + }, + "SendMessageBatch":{ + "name":"SendMessageBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendMessageBatchRequest"}, + "output":{ + "shape":"SendMessageBatchResult", + "resultWrapper":"SendMessageBatchResult" + }, + "errors":[ + {"shape":"TooManyEntriesInBatchRequest"}, + {"shape":"EmptyBatchRequest"}, + {"shape":"BatchEntryIdsNotDistinct"}, + {"shape":"BatchRequestTooLong"}, + {"shape":"InvalidBatchEntryId"}, + {"shape":"UnsupportedOperation"} + ], + "documentation":"

    Delivers up to ten messages to the specified queue. This is a batch version of SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.

    The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.

    The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    If you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.

    Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:

    &Attribute.1=first

    &Attribute.2=second

    " + }, + "SetQueueAttributes":{ + "name":"SetQueueAttributes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetQueueAttributesRequest"}, + "errors":[ + {"shape":"InvalidAttributeName"} + ], + "documentation":"

    Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.

    • In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    • Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    • To remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.

    " + }, + "TagQueue":{ + "name":"TagQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagQueueRequest"}, + "documentation":"

    Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn't recommended.

    • Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + }, + "UntagQueue":{ + "name":"UntagQueue", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagQueueRequest"}, + "documentation":"

    Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "shapes":{ + "AWSAccountIdList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"AWSAccountId" + }, + "flattened":true + }, + "ActionNameList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"ActionName" + }, + "flattened":true + }, + "AddPermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label", + "AWSAccountIds", + "Actions" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue to which permissions are added.

    Queue URLs and names are case-sensitive.

    " + }, + "Label":{ + "shape":"String", + "documentation":"

    The unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).

    " + }, + "AWSAccountIds":{ + "shape":"AWSAccountIdList", + "documentation":"

    The AWS account number of the principal who is given permission. The principal must have an AWS account, but does not need to be signed up for Amazon SQS. For information about locating the AWS account identification, see Your AWS Identifiers in the Amazon Simple Queue Service Developer Guide.

    " + }, + "Actions":{ + "shape":"ActionNameList", + "documentation":"

    The action the client wants to allow for the specified principal. Valid values: the name of any action or *.

    For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource in the Amazon Simple Queue Service Developer Guide.

    Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.

    " + } + }, + "documentation":"

    " + }, + "AttributeNameList":{ + "type":"list", + "member":{ + "shape":"QueueAttributeName", + "locationName":"AttributeName" + }, + "flattened":true + }, + "BatchEntryIdsNotDistinct":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Two or more batch entries in the request have the same Id.

    ", + "error":{ + "code":"AWS.SimpleQueueService.BatchEntryIdsNotDistinct", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchRequestTooLong":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The length of all the messages put together is more than the limit.

    ", + "error":{ + "code":"AWS.SimpleQueueService.BatchRequestTooLong", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "BatchResultErrorEntry":{ + "type":"structure", + "required":[ + "Id", + "SenderFault", + "Code" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    The Id of an entry in a batch request.

    " + }, + "SenderFault":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the error happened due to the producer.

    " + }, + "Code":{ + "shape":"String", + "documentation":"

    An error code representing why the action failed on this entry.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    A message explaining why the action failed on this entry.

    " + } + }, + "documentation":"

    Gives a detailed description of the result of an action on each entry in the request.

    " + }, + "BatchResultErrorEntryList":{ + "type":"list", + "member":{ + "shape":"BatchResultErrorEntry", + "locationName":"BatchResultErrorEntry" + }, + "flattened":true + }, + "Binary":{"type":"blob"}, + "BinaryList":{ + "type":"list", + "member":{ + "shape":"Binary", + "locationName":"BinaryListValue" + } + }, + "Boolean":{"type":"boolean"}, + "ChangeMessageVisibilityBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue whose messages' visibility is changed.

    Queue URLs and names are case-sensitive.

    " + }, + "Entries":{ + "shape":"ChangeMessageVisibilityBatchRequestEntryList", + "documentation":"

    A list of receipt handles of the messages for which the visibility timeout must be changed.

    " + } + }, + "documentation":"

    " + }, + "ChangeMessageVisibilityBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    An identifier for this particular receipt handle used to communicate the result.

    The Ids of a batch request need to be unique within a request

    " + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

    A receipt handle.

    " + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

    The new value (in seconds) for the message's visibility timeout.

    " + } + }, + "documentation":"

    Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.

    All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:

    &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2

    &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle

    &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45

    " + }, + "ChangeMessageVisibilityBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchRequestEntry", + "locationName":"ChangeMessageVisibilityBatchRequestEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"ChangeMessageVisibilityBatchResultEntryList", + "documentation":"

    A list of ChangeMessageVisibilityBatchResultEntry items.

    " + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

    A list of BatchResultErrorEntry items.

    " + } + }, + "documentation":"

    For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

    " + }, + "ChangeMessageVisibilityBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    Represents a message whose visibility timeout has been changed successfully.

    " + } + }, + "documentation":"

    Encloses the Id of an entry in ChangeMessageVisibilityBatch.

    " + }, + "ChangeMessageVisibilityBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"ChangeMessageVisibilityBatchResultEntry", + "locationName":"ChangeMessageVisibilityBatchResultEntry" + }, + "flattened":true + }, + "ChangeMessageVisibilityRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle", + "VisibilityTimeout" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue whose message's visibility is changed.

    Queue URLs and names are case-sensitive.

    " + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

    The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the ReceiveMessage action.

    " + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

    The new value for the message's visibility timeout (in seconds). Values values: 0 to 43200. Maximum: 12 hours.

    " + } + } + }, + "CreateQueueRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{ + "shape":"String", + "documentation":"

    The name of the new queue. The following limits apply to this name:

    • A queue name can have up to 80 characters.

    • Valid values: alphanumeric characters, hyphens (-), and underscores (_).

    • A FIFO queue name must end with the .fifo suffix.

    Queue URLs and names are case-sensitive.

    " + }, + "Attributes":{ + "shape":"QueueAttributeMap", + "documentation":"

    A map of attributes with their corresponding values.

    The following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:

    • DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.

    • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    • MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).

    • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

    • ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.

    • RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

      • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    • VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue - Designates a queue as FIFO. Valid values: true, false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You can provide this attribute only during queue creation. You can't change it for an existing queue. When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.

      For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.

    • ContentBasedDeduplication - Enables content-based deduplication. Valid values: true, false. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

      • Every message must have a unique MessageDeduplicationId,

        • You may provide a MessageDeduplicationId explicitly.

        • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    ", + "locationName":"Attribute" + }, + "tags":{ + "shape":"TagMap", + "documentation":"

    Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging Your Amazon SQS Queues in the Amazon Simple Queue Service Developer Guide.

    When you use queue tags, keep the following guidelines in mind:

    • Adding more than 50 tags to a queue isn't recommended.

    • Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.

    • Tags are case-sensitive.

    • A new tag with a key identical to that of an existing tag overwrites the existing tag.

    For a full list of tag restrictions, see Limits Related to Queues in the Amazon Simple Queue Service Developer Guide.

    To be able to tag a queue on creation, you must have the sqs:CreateQueue and sqs:TagQueue permissions.

    Cross-account permissions don't apply to this action. For more information, see Grant Cross-Account Permissions to a Role and a User Name in the Amazon Simple Queue Service Developer Guide.

    ", + "locationName":"Tag" + } + }, + "documentation":"

    " + }, + "CreateQueueResult":{ + "type":"structure", + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the created Amazon SQS queue.

    " + } + }, + "documentation":"

    Returns the QueueUrl attribute of the created queue.

    " + }, + "DeleteMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

    " + }, + "Entries":{ + "shape":"DeleteMessageBatchRequestEntryList", + "documentation":"

    A list of receipt handles for the messages to be deleted.

    " + } + }, + "documentation":"

    " + }, + "DeleteMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "ReceiptHandle" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    An identifier for this particular receipt handle. This is used to communicate the result.

    The Ids of a batch request need to be unique within a request

    " + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

    A receipt handle.

    " + } + }, + "documentation":"

    Encloses a receipt handle and an identifier for it.

    " + }, + "DeleteMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchRequestEntry", + "locationName":"DeleteMessageBatchRequestEntry" + }, + "flattened":true + }, + "DeleteMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"DeleteMessageBatchResultEntryList", + "documentation":"

    A list of DeleteMessageBatchResultEntry items.

    " + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

    A list of BatchResultErrorEntry items.

    " + } + }, + "documentation":"

    For each message in the batch, the response contains a DeleteMessageBatchResultEntry tag if the message is deleted or a BatchResultErrorEntry tag if the message can't be deleted.

    " + }, + "DeleteMessageBatchResultEntry":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    Represents a successfully deleted message.

    " + } + }, + "documentation":"

    Encloses the Id of an entry in DeleteMessageBatch.

    " + }, + "DeleteMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"DeleteMessageBatchResultEntry", + "locationName":"DeleteMessageBatchResultEntry" + }, + "flattened":true + }, + "DeleteMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "ReceiptHandle" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue from which messages are deleted.

    Queue URLs and names are case-sensitive.

    " + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

    The receipt handle associated with the message to delete.

    " + } + }, + "documentation":"

    " + }, + "DeleteQueueRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue to delete.

    Queue URLs and names are case-sensitive.

    " + } + }, + "documentation":"

    " + }, + "EmptyBatchRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The batch request doesn't contain any entries.

    ", + "error":{ + "code":"AWS.SimpleQueueService.EmptyBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "GetQueueAttributesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue whose attribute information is retrieved.

    Queue URLs and names are case-sensitive.

    " + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

    A list of attributes for which to retrieve information.

    In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.

    The following attributes are supported:

    • All - Returns all values.

    • ApproximateNumberOfMessages - Returns the approximate number of messages available for retrieval from the queue.

    • ApproximateNumberOfMessagesDelayed - Returns the approximate number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.

    • ApproximateNumberOfMessagesNotVisible - Returns the approximate number of messages that are in flight. Messages are considered to be in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.

    • CreatedTimestamp - Returns the time when the queue was created in seconds (epoch time).

    • DelaySeconds - Returns the default delay on the queue in seconds.

    • LastModifiedTimestamp - Returns the time when the queue was last changed in seconds (epoch time).

    • MaximumMessageSize - Returns the limit of how many bytes a message can contain before Amazon SQS rejects it.

    • MessageRetentionPeriod - Returns the length of time, in seconds, for which Amazon SQS retains a message.

    • Policy - Returns the policy of the queue.

    • QueueArn - Returns the Amazon resource name (ARN) of the queue.

    • ReceiveMessageWaitTimeSeconds - Returns the length of time, in seconds, for which the ReceiveMessage action waits for a message to arrive.

    • RedrivePolicy - Returns the string that includes the parameters for dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

      • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

    • VisibilityTimeout - Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId - Returns the ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.

    • KmsDataKeyReusePeriodSeconds - Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. For more information, see How Does the Data Key Reuse Period Work?.

    The following attributes apply only to FIFO (first-in-first-out) queues:

    • FifoQueue - Returns whether the queue is FIFO. For more information, see FIFO Queue Logic in the Amazon Simple Queue Service Developer Guide.

      To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.

    • ContentBasedDeduplication - Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "documentation":"

    " + }, + "GetQueueAttributesResult":{ + "type":"structure", + "members":{ + "Attributes":{ + "shape":"QueueAttributeMap", + "documentation":"

    A map of attributes to their respective values.

    ", + "locationName":"Attribute" + } + }, + "documentation":"

    A list of returned queue attributes.

    " + }, + "GetQueueUrlRequest":{ + "type":"structure", + "required":["QueueName"], + "members":{ + "QueueName":{ + "shape":"String", + "documentation":"

    The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).

    Queue URLs and names are case-sensitive.

    " + }, + "QueueOwnerAWSAccountId":{ + "shape":"String", + "documentation":"

    The AWS account ID of the account that created the queue.

    " + } + }, + "documentation":"

    " + }, + "GetQueueUrlResult":{ + "type":"structure", + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the queue.

    " + } + }, + "documentation":"

    For more information, see Interpreting Responses in the Amazon Simple Queue Service Developer Guide.

    " + }, + "Integer":{"type":"integer"}, + "InvalidAttributeName":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified attribute doesn't exist.

    ", + "exception":true + }, + "InvalidBatchEntryId":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The Id of a batch entry in a batch request doesn't abide by the specification.

    ", + "error":{ + "code":"AWS.SimpleQueueService.InvalidBatchEntryId", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidIdFormat":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified receipt handle isn't valid for the current version.

    ", + "exception":true + }, + "InvalidMessageContents":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The message contains characters outside the allowed set.

    ", + "exception":true + }, + "ListDeadLetterSourceQueuesRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of a dead-letter queue.

    Queue URLs and names are case-sensitive.

    " + } + }, + "documentation":"

    " + }, + "ListDeadLetterSourceQueuesResult":{ + "type":"structure", + "required":["queueUrls"], + "members":{ + "queueUrls":{ + "shape":"QueueUrlList", + "documentation":"

    A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.

    " + } + }, + "documentation":"

    A list of your dead letter source queues.

    " + }, + "ListQueueTagsRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the queue.

    " + } + } + }, + "ListQueueTagsResult":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"TagMap", + "documentation":"

    The list of all tags added to the specified queue.

    ", + "locationName":"Tag" + } + } + }, + "ListQueuesRequest":{ + "type":"structure", + "members":{ + "QueueNamePrefix":{ + "shape":"String", + "documentation":"

    A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.

    Queue URLs and names are case-sensitive.

    " + } + }, + "documentation":"

    " + }, + "ListQueuesResult":{ + "type":"structure", + "members":{ + "QueueUrls":{ + "shape":"QueueUrlList", + "documentation":"

    A list of queue URLs, up to 1,000 entries.

    " + } + }, + "documentation":"

    A list of your queues.

    " + }, + "Message":{ + "type":"structure", + "members":{ + "MessageId":{ + "shape":"String", + "documentation":"

    A unique identifier for the message. A MessageIdis considered unique across all AWS accounts for an extended period of time.

    " + }, + "ReceiptHandle":{ + "shape":"String", + "documentation":"

    An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.

    " + }, + "MD5OfBody":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message body string.

    " + }, + "Body":{ + "shape":"String", + "documentation":"

    The message's contents (not URL-encoded).

    " + }, + "Attributes":{ + "shape":"MessageSystemAttributeMap", + "documentation":"

    A map of the attributes requested in ReceiveMessage to their respective values. Supported attributes:

    • ApproximateReceiveCount

    • ApproximateFirstReceiveTimestamp

    • MessageDeduplicationId

    • MessageGroupId

    • SenderId

    • SentTimestamp

    • SequenceNumber

    ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the epoch time in milliseconds.

    ", + "locationName":"Attribute" + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "MessageAttributes":{ + "shape":"MessageBodyAttributeMap", + "documentation":"

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "locationName":"MessageAttribute" + } + }, + "documentation":"

    An Amazon SQS message.

    " + }, + "MessageAttributeName":{"type":"string"}, + "MessageAttributeNameList":{ + "type":"list", + "member":{ + "shape":"MessageAttributeName", + "locationName":"MessageAttributeName" + }, + "flattened":true + }, + "MessageAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "StringValue":{ + "shape":"String", + "documentation":"

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " + }, + "BinaryValue":{ + "shape":"Binary", + "documentation":"

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    " + }, + "StringListValues":{ + "shape":"StringList", + "documentation":"

    Not implemented. Reserved for future use.

    ", + "flattened":true, + "locationName":"StringListValue" + }, + "BinaryListValues":{ + "shape":"BinaryList", + "documentation":"

    Not implemented. Reserved for future use.

    ", + "flattened":true, + "locationName":"BinaryListValue" + }, + "DataType":{ + "shape":"String", + "documentation":"

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "documentation":"

    The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

    Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).

    " + }, + "MessageBodyAttributeMap":{ + "type":"map", + "key":{ + "shape":"String", + "locationName":"Name" + }, + "value":{ + "shape":"MessageAttributeValue", + "locationName":"Value" + }, + "flattened":true + }, + "MessageBodySystemAttributeMap":{ + "type":"map", + "key":{ + "shape":"MessageSystemAttributeNameForSends", + "locationName":"Name" + }, + "value":{ + "shape":"MessageSystemAttributeValue", + "locationName":"Value" + }, + "flattened":true + }, + "MessageList":{ + "type":"list", + "member":{ + "shape":"Message", + "locationName":"Message" + }, + "flattened":true + }, + "MessageNotInflight":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified message isn't in flight.

    ", + "error":{ + "code":"AWS.SimpleQueueService.MessageNotInflight", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "MessageSystemAttributeMap":{ + "type":"map", + "key":{ + "shape":"MessageSystemAttributeName", + "locationName":"Name" + }, + "value":{ + "shape":"String", + "locationName":"Value" + }, + "flattened":true, + "locationName":"Attribute" + }, + "MessageSystemAttributeName":{ + "type":"string", + "enum":[ + "SenderId", + "SentTimestamp", + "ApproximateReceiveCount", + "ApproximateFirstReceiveTimestamp", + "SequenceNumber", + "MessageDeduplicationId", + "MessageGroupId", + "AWSTraceHeader" + ] + }, + "MessageSystemAttributeNameForSends":{ + "type":"string", + "enum":["AWSTraceHeader"] + }, + "MessageSystemAttributeValue":{ + "type":"structure", + "required":["DataType"], + "members":{ + "StringValue":{ + "shape":"String", + "documentation":"

    Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.

    " + }, + "BinaryValue":{ + "shape":"Binary", + "documentation":"

    Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.

    " + }, + "StringListValues":{ + "shape":"StringList", + "documentation":"

    Not implemented. Reserved for future use.

    ", + "flattened":true, + "locationName":"StringListValue" + }, + "BinaryListValues":{ + "shape":"BinaryList", + "documentation":"

    Not implemented. Reserved for future use.

    ", + "flattened":true, + "locationName":"BinaryListValue" + }, + "DataType":{ + "shape":"String", + "documentation":"

    Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.

    You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "documentation":"

    The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see SendMessage.

    Name, type, value and the message body must not be empty or null.

    " + }, + "OverLimit":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified action violates a limit. For example, ReceiveMessage returns this error if the maximum number of inflight messages is reached and AddPermission returns this error if the maximum number of permissions for the queue is reached.

    ", + "error":{ + "code":"OverLimit", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "PurgeQueueInProgress":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).

    ", + "error":{ + "code":"AWS.SimpleQueueService.PurgeQueueInProgress", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "PurgeQueueRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the queue from which the PurgeQueue action deletes messages.

    Queue URLs and names are case-sensitive.

    " + } + }, + "documentation":"

    " + }, + "QueueAttributeMap":{ + "type":"map", + "key":{ + "shape":"QueueAttributeName", + "locationName":"Name" + }, + "value":{ + "shape":"String", + "locationName":"Value" + }, + "flattened":true, + "locationName":"Attribute" + }, + "QueueAttributeName":{ + "type":"string", + "enum":[ + "All", + "Policy", + "VisibilityTimeout", + "MaximumMessageSize", + "MessageRetentionPeriod", + "ApproximateNumberOfMessages", + "ApproximateNumberOfMessagesNotVisible", + "CreatedTimestamp", + "LastModifiedTimestamp", + "QueueArn", + "ApproximateNumberOfMessagesDelayed", + "DelaySeconds", + "ReceiveMessageWaitTimeSeconds", + "RedrivePolicy", + "FifoQueue", + "ContentBasedDeduplication", + "KmsMasterKeyId", + "KmsDataKeyReusePeriodSeconds" + ] + }, + "QueueDeletedRecently":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You must wait 60 seconds after deleting a queue before you can create another queue with the same name.

    ", + "error":{ + "code":"AWS.SimpleQueueService.QueueDeletedRecently", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueDoesNotExist":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified queue doesn't exist.

    ", + "error":{ + "code":"AWS.SimpleQueueService.NonExistentQueue", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueNameExists":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A queue with this name already exists. Amazon SQS returns this error only if the request includes attributes whose values differ from those of the existing queue.

    ", + "error":{ + "code":"QueueAlreadyExists", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "QueueUrlList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"QueueUrl" + }, + "flattened":true + }, + "ReceiptHandleIsInvalid":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified receipt handle isn't valid.

    ", + "exception":true + }, + "ReceiveMessageRequest":{ + "type":"structure", + "required":["QueueUrl"], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue from which messages are received.

    Queue URLs and names are case-sensitive.

    " + }, + "AttributeNames":{ + "shape":"AttributeNameList", + "documentation":"

    A list of attributes that need to be returned along with each message. These attributes include:

    • All - Returns all values.

    • ApproximateFirstReceiveTimestamp - Returns the time the message was first received from the queue (epoch time in milliseconds).

    • ApproximateReceiveCount - Returns the number of times a message has been received from the queue but not deleted.

    • AWSTraceHeader - Returns the AWS X-Ray trace header string.

    • SenderId

      • For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.

      • For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.

    • SentTimestamp - Returns the time the message was sent to the queue (epoch time in milliseconds).

    • MessageDeduplicationId - Returns the value provided by the producer that calls the SendMessage action.

    • MessageGroupId - Returns the value provided by the producer that calls the SendMessage action. Messages with the same MessageGroupId are returned in sequence.

    • SequenceNumber - Returns the value provided by Amazon SQS.

    " + }, + "MessageAttributeNames":{ + "shape":"MessageAttributeNameList", + "documentation":"

    The name of the message attribute, where N is the index.

    • The name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).

    • The name is case-sensitive and must be unique among all attribute names for the message.

    • The name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).

    • The name must not start or end with a period (.), and it should not have periods in succession (..).

    • The name can be up to 256 characters long.

    When using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. You can also use all message attributes starting with a prefix, for example bar.*.

    " + }, + "MaxNumberOfMessages":{ + "shape":"Integer", + "documentation":"

    The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.

    " + }, + "VisibilityTimeout":{ + "shape":"Integer", + "documentation":"

    The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.

    " + }, + "WaitTimeSeconds":{ + "shape":"Integer", + "documentation":"

    The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.

    " + }, + "ReceiveRequestAttemptId":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, you can retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.

    • You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.

    • When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.

    • If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.

    • You can retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).

    • During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, it resets the visibility timeout. For more information, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

      If a caller of the ReceiveMessage action still processes messages when the visibility timeout expires and messages become visible, another worker consuming from the same queue can receive the same messages and therefore process duplicates. Also, if a consumer whose message processing time is longer than the visibility timeout tries to delete the processed messages, the action fails with an error.

      To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.

    • While messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive messages with another MessageGroupId as long as it is also visible.

    • If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but the messages in the queue remain in a strict order.

    The length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon Simple Queue Service Developer Guide.

    " + } + }, + "documentation":"

    " + }, + "ReceiveMessageResult":{ + "type":"structure", + "members":{ + "Messages":{ + "shape":"MessageList", + "documentation":"

    A list of messages.

    " + } + }, + "documentation":"

    A list of received messages.

    " + }, + "RemovePermissionRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Label" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue from which permissions are removed.

    Queue URLs and names are case-sensitive.

    " + }, + "Label":{ + "shape":"String", + "documentation":"

    The identification of the permission to remove. This is the label added using the AddPermission action.

    " + } + }, + "documentation":"

    " + }, + "SendMessageBatchRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Entries" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue to which batched messages are sent.

    Queue URLs and names are case-sensitive.

    " + }, + "Entries":{ + "shape":"SendMessageBatchRequestEntryList", + "documentation":"

    A list of SendMessageBatchRequestEntry items.

    " + } + }, + "documentation":"

    " + }, + "SendMessageBatchRequestEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageBody" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    An identifier for a message in this batch used to communicate the result.

    The Ids of a batch request need to be unique within a request

    This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).

    " + }, + "MessageBody":{ + "shape":"String", + "documentation":"

    The body of the message.

    " + }, + "DelaySeconds":{ + "shape":"Integer", + "documentation":"

    The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue is applied.

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    " + }, + "MessageAttributes":{ + "shape":"MessageBodyAttributeMap", + "documentation":"

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "locationName":"MessageAttribute" + }, + "MessageSystemAttributes":{ + "shape":"MessageBodySystemAttributeMap", + "documentation":"

    The message system attribute to send Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace string.

    • The size of a message system attribute doesn't count towards the total size of a message.

    ", + "locationName":"MessageSystemAttribute" + }, + "MessageDeduplicationId":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are accepted successfully but aren't delivered. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.

      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

    " + }, + "MessageGroupId":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    " + } + }, + "documentation":"

    Contains the details of a single Amazon SQS message along with an Id.

    " + }, + "SendMessageBatchRequestEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchRequestEntry", + "locationName":"SendMessageBatchRequestEntry" + }, + "flattened":true + }, + "SendMessageBatchResult":{ + "type":"structure", + "required":[ + "Successful", + "Failed" + ], + "members":{ + "Successful":{ + "shape":"SendMessageBatchResultEntryList", + "documentation":"

    A list of SendMessageBatchResultEntry items.

    " + }, + "Failed":{ + "shape":"BatchResultErrorEntryList", + "documentation":"

    A list of BatchResultErrorEntry items with error details about each message that can't be enqueued.

    " + } + }, + "documentation":"

    For each message in the batch, the response contains a SendMessageBatchResultEntry tag if the message succeeds or a BatchResultErrorEntry tag if the message fails.

    " + }, + "SendMessageBatchResultEntry":{ + "type":"structure", + "required":[ + "Id", + "MessageId", + "MD5OfMessageBody" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    An identifier for the message in this batch.

    " + }, + "MessageId":{ + "shape":"String", + "documentation":"

    An identifier for the message.

    " + }, + "MD5OfMessageBody":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "MD5OfMessageSystemAttributes":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "SequenceNumber":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The large, non-consecutive number that Amazon SQS assigns to each message.

    The length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.

    " + } + }, + "documentation":"

    Encloses a MessageId for a successfully-enqueued message in a SendMessageBatch.

    " + }, + "SendMessageBatchResultEntryList":{ + "type":"list", + "member":{ + "shape":"SendMessageBatchResultEntry", + "locationName":"SendMessageBatchResultEntry" + }, + "flattened":true + }, + "SendMessageRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "MessageBody" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue to which a message is sent.

    Queue URLs and names are case-sensitive.

    " + }, + "MessageBody":{ + "shape":"String", + "documentation":"

    The message to send. The maximum string size is 256 KB.

    A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:

    #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF

    Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.

    " + }, + "DelaySeconds":{ + "shape":"Integer", + "documentation":"

    The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies.

    When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.

    " + }, + "MessageAttributes":{ + "shape":"MessageBodyAttributeMap", + "documentation":"

    Each message attribute consists of a Name, Type, and Value. For more information, see Amazon SQS Message Attributes in the Amazon Simple Queue Service Developer Guide.

    ", + "locationName":"MessageAttribute" + }, + "MessageSystemAttributes":{ + "shape":"MessageBodySystemAttributeMap", + "documentation":"

    The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.

    • Currently, the only supported message system attribute is AWSTraceHeader. Its type must be String and its value must be a correctly formatted AWS X-Ray trace string.

    • The size of a message system attribute doesn't count towards the total size of a message.

    ", + "locationName":"MessageSystemAttribute" + }, + "MessageDeduplicationId":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

    • Every message must have a unique MessageDeduplicationId,

      • You may provide a MessageDeduplicationId explicitly.

      • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

      • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

      • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

    • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

    • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    The MessageDeduplicationId is available to the consumer of the message (this can be useful for troubleshooting delivery issues).

    If a message is sent successfully but the acknowledgement is lost and the message is resent with the same MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.

    Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.

    The length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon Simple Queue Service Developer Guide.

    " + }, + "MessageGroupId":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The tag that specifies that a message belongs to a specific message group. Messages that belong to the same message group are processed in a FIFO manner (however, messages in different message groups might be processed out of order). To interleave multiple ordered streams within a single queue, use MessageGroupId values (for example, session data for multiple users). In this scenario, multiple consumers can process the queue, but the session data of each user is processed in a FIFO fashion.

    • You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.

    • ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't specify a MessageGroupId.

    The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).

    For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon Simple Queue Service Developer Guide.

    MessageGroupId is required for FIFO queues. You can't use it for Standard queues.

    " + } + }, + "documentation":"

    " + }, + "SendMessageResult":{ + "type":"structure", + "members":{ + "MD5OfMessageBody":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "MD5OfMessageAttributes":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest. For information about MD5, see RFC1321.

    " + }, + "MD5OfMessageSystemAttributes":{ + "shape":"String", + "documentation":"

    An MD5 digest of the non-URL-encoded message system attribute string. You can use this attribute to verify that Amazon SQS received the message correctly. Amazon SQS URL-decodes the message before creating the MD5 digest.

    " + }, + "MessageId":{ + "shape":"String", + "documentation":"

    An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers in the Amazon Simple Queue Service Developer Guide.

    " + }, + "SequenceNumber":{ + "shape":"String", + "documentation":"

    This parameter applies only to FIFO (first-in-first-out) queues.

    The large, non-consecutive number that Amazon SQS assigns to each message.

    The length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.

    " + } + }, + "documentation":"

    The MD5OfMessageBody and MessageId elements.

    " + }, + "SetQueueAttributesRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Attributes" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the Amazon SQS queue whose attributes are set.

    Queue URLs and names are case-sensitive.

    " + }, + "Attributes":{ + "shape":"QueueAttributeMap", + "documentation":"

    A map of attributes to set.

    The following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:

    • DelaySeconds - The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.

    • MaximumMessageSize - The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).

    • MessageRetentionPeriod - The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).

    • Policy - The queue's policy. A valid AWS policy. For more information about policy structure, see Overview of AWS IAM Policies in the Amazon IAM User Guide.

    • ReceiveMessageWaitTimeSeconds - The length of time, in seconds, for which a ReceiveMessage action waits for a message to arrive. Valid values: an integer from 0 to 20 (seconds). Default: 0.

    • RedrivePolicy - The string that includes the parameters for the dead-letter queue functionality of the source queue. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon Simple Queue Service Developer Guide.

      • deadLetterTargetArn - The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

      • maxReceiveCount - The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.

      The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.

    • VisibilityTimeout - The visibility timeout for the queue, in seconds. Valid values: an integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see Visibility Timeout in the Amazon Simple Queue Service Developer Guide.

    The following attributes apply only to server-side-encryption:

    • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias . For more examples, see KeyId in the AWS Key Management Service API Reference.

    • KmsDataKeyReusePeriodSeconds - The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security but results in more calls to KMS which might incur charges after Free Tier. For more information, see How Does the Data Key Reuse Period Work?.

    The following attribute applies only to FIFO (first-in-first-out) queues:

    • ContentBasedDeduplication - Enables content-based deduplication. For more information, see Exactly-Once Processing in the Amazon Simple Queue Service Developer Guide.

      • Every message must have a unique MessageDeduplicationId,

        • You may provide a MessageDeduplicationId explicitly.

        • If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

        • If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set, the action fails with an error.

        • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

      • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

      • If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.

    ", + "locationName":"Attribute" + } + }, + "documentation":"

    " + }, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{ + "shape":"String", + "locationName":"StringListValue" + } + }, + "TagKey":{"type":"string"}, + "TagKeyList":{ + "type":"list", + "member":{ + "shape":"TagKey", + "locationName":"TagKey" + }, + "flattened":true + }, + "TagMap":{ + "type":"map", + "key":{ + "shape":"TagKey", + "locationName":"Key" + }, + "value":{ + "shape":"TagValue", + "locationName":"Value" + }, + "flattened":true, + "locationName":"Tag" + }, + "TagQueueRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "Tags" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the queue.

    " + }, + "Tags":{ + "shape":"TagMap", + "documentation":"

    The list of tags to be added to the specified queue.

    " + } + } + }, + "TagValue":{"type":"string"}, + "TooManyEntriesInBatchRequest":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The batch request contains more entries than permissible.

    ", + "error":{ + "code":"AWS.SimpleQueueService.TooManyEntriesInBatchRequest", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UnsupportedOperation":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Error code 400. Unsupported operation.

    ", + "error":{ + "code":"AWS.SimpleQueueService.UnsupportedOperation", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagQueueRequest":{ + "type":"structure", + "required":[ + "QueueUrl", + "TagKeys" + ], + "members":{ + "QueueUrl":{ + "shape":"String", + "documentation":"

    The URL of the queue.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The list of tags to be removed from the specified queue.

    " + } + } + } + }, + "documentation":"

    Welcome to the Amazon Simple Queue Service API Reference.

    Amazon Simple Queue Service (Amazon SQS) is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.

    You can use AWS SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:

    • Cryptographically sign your service requests

    • Retry requests

    • Handle error responses

    Additional Information

    " +} diff --git a/aws/dist/botocore/data/ssm/2014-11-06/examples-1.json b/aws/dist/botocore/data/ssm/2014-11-06/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/ssm/2014-11-06/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/ssm/2014-11-06/paginators-1.json b/aws/dist/botocore/data/ssm/2014-11-06/paginators-1.json new file mode 100644 index 00000000..e7b95820 --- /dev/null +++ b/aws/dist/botocore/data/ssm/2014-11-06/paginators-1.json @@ -0,0 +1,244 @@ +{ + "pagination": { + "ListAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Associations" + }, + "ListCommandInvocations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "CommandInvocations" + }, + "ListCommands": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Commands" + }, + "ListDocuments": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "DocumentIdentifiers" + }, + "DescribeInstanceInformation": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "InstanceInformationList" + }, + "DescribeActivations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "ActivationList" + }, + "DescribeParameters": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Parameters" + }, + "DescribeAssociationExecutions": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AssociationExecutions" + }, + "DescribeAssociationExecutionTargets": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "AssociationExecutionTargets" + }, + "GetInventory": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Entities" + }, + "GetParametersByPath": { + "result_key": "Parameters", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "GetParameterHistory": { + "result_key": "Parameters", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "DescribeAutomationExecutions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AutomationExecutionMetadataList" + }, + "DescribeAutomationStepExecutions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "StepExecutions" + }, + "DescribeAvailablePatches": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Patches" + }, + "DescribeEffectiveInstanceAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Associations" + }, + "DescribeEffectivePatchesForPatchBaseline": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "EffectivePatches" + }, + "DescribeInstanceAssociationsStatus": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstanceAssociationStatusInfos" + }, + "DescribeInstancePatchStates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstancePatchStates" + }, + "DescribeInstancePatchStatesForPatchGroup": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InstancePatchStates" + }, + "DescribeInstancePatches": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Patches" + }, + "DescribeInventoryDeletions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "InventoryDeletions" + }, + "DescribeMaintenanceWindowExecutionTaskInvocations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WindowExecutionTaskInvocationIdentities" + }, + "DescribeMaintenanceWindowExecutionTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WindowExecutionTaskIdentities" + }, + "DescribeMaintenanceWindowExecutions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WindowExecutions" + }, + "DescribeMaintenanceWindowSchedule": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ScheduledWindowExecutions" + }, + "DescribeMaintenanceWindowTargets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Targets" + }, + "DescribeMaintenanceWindowTasks": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Tasks" + }, + "DescribeMaintenanceWindows": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WindowIdentities" + }, + "DescribeMaintenanceWindowsForTarget": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WindowIdentities" + }, + "DescribePatchBaselines": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "BaselineIdentities" + }, + "DescribePatchGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Mappings" + }, + "DescribeSessions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Sessions" + }, + "GetInventorySchema": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Schemas" + }, + "ListAssociationVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "AssociationVersions" + }, + "ListComplianceItems": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ComplianceItems" + }, + "ListComplianceSummaries": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ComplianceSummaryItems" + }, + "ListDocumentVersions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DocumentVersions" + }, + "ListResourceComplianceSummaries": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ResourceComplianceSummaryItems" + }, + "ListResourceDataSync": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ResourceDataSyncItems" + } + } +} diff --git a/aws/dist/botocore/data/ssm/2014-11-06/service-2.json b/aws/dist/botocore/data/ssm/2014-11-06/service-2.json new file mode 100644 index 00000000..7ed74666 --- /dev/null +++ b/aws/dist/botocore/data/ssm/2014-11-06/service-2.json @@ -0,0 +1,13589 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2014-11-06", + "endpointPrefix":"ssm", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"Amazon SSM", + "serviceFullName":"Amazon Simple Systems Manager (SSM)", + "serviceId":"SSM", + "signatureVersion":"v4", + "targetPrefix":"AmazonSSM", + "uid":"ssm-2014-11-06" + }, + "operations":{ + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceRequest"}, + "output":{"shape":"AddTagsToResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"}, + {"shape":"TooManyTagsError"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    Adds or overwrites one or more tags for the specified resource. Tags are metadata that you can assign to your documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define. For example, you could define a set of tags for your account's managed instances that helps you track each instance's owner and stack level. For example: Key=Owner and Value=DbAdmin, SysAdmin, or Dev. Or Key=Stack and Value=Production, Pre-Production, or Test.

    Each resource can have a maximum of 50 tags.

    We recommend that you devise a set of tag keys that meets your needs for each resource type. Using a consistent set of tag keys makes it easier for you to manage your resources. You can search and filter the resources based on the tags you add. Tags don't have any semantic meaning to Amazon EC2 and are interpreted strictly as a string of characters.

    For more information about tags, see Tagging Your Amazon EC2 Resources in the Amazon EC2 User Guide.

    " + }, + "CancelCommand":{ + "name":"CancelCommand", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelCommandRequest"}, + "output":{"shape":"CancelCommandResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"DuplicateInstanceId"} + ], + "documentation":"

    Attempts to cancel the command specified by the Command ID. There is no guarantee that the command will be terminated and the underlying process stopped.

    " + }, + "CancelMaintenanceWindowExecution":{ + "name":"CancelMaintenanceWindowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelMaintenanceWindowExecutionRequest"}, + "output":{"shape":"CancelMaintenanceWindowExecutionResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"DoesNotExistException"} + ], + "documentation":"

    Stops a maintenance window execution that is already in progress and cancels any tasks in the window that have not already starting running. (Tasks already in progress will continue to completion.)

    " + }, + "CreateActivation":{ + "name":"CreateActivation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateActivationRequest"}, + "output":{"shape":"CreateActivationResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up AWS Systems Manager for Hybrid Environments.

    " + }, + "CreateAssociation":{ + "name":"CreateAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssociationRequest"}, + "output":{"shape":"CreateAssociationResult"}, + "errors":[ + {"shape":"AssociationAlreadyExists"}, + {"shape":"AssociationLimitExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"InvalidInstanceId"}, + {"shape":"UnsupportedPlatformType"}, + {"shape":"InvalidOutputLocation"}, + {"shape":"InvalidParameters"}, + {"shape":"InvalidTarget"}, + {"shape":"InvalidSchedule"} + ], + "documentation":"

    Associates the specified Systems Manager document with the specified instances or targets.

    When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

    If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

    " + }, + "CreateAssociationBatch":{ + "name":"CreateAssociationBatch", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAssociationBatchRequest"}, + "output":{"shape":"CreateAssociationBatchResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidParameters"}, + {"shape":"DuplicateInstanceId"}, + {"shape":"AssociationLimitExceeded"}, + {"shape":"UnsupportedPlatformType"}, + {"shape":"InvalidOutputLocation"}, + {"shape":"InvalidTarget"}, + {"shape":"InvalidSchedule"} + ], + "documentation":"

    Associates the specified Systems Manager document with the specified instances or targets.

    When you associate a document with one or more instances using instance IDs or tags, SSM Agent running on the instance processes the document and configures the instance as specified.

    If you associate a document with an instance that already has an associated document, the system returns the AssociationAlreadyExists exception.

    " + }, + "CreateDocument":{ + "name":"CreateDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDocumentRequest"}, + "output":{"shape":"CreateDocumentResult"}, + "errors":[ + {"shape":"DocumentAlreadyExists"}, + {"shape":"MaxDocumentSizeExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocumentContent"}, + {"shape":"DocumentLimitExceeded"}, + {"shape":"InvalidDocumentSchemaVersion"} + ], + "documentation":"

    Creates a Systems Manager document.

    After you create a document, you can use CreateAssociation to associate it with one or more running instances.

    " + }, + "CreateMaintenanceWindow":{ + "name":"CreateMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateMaintenanceWindowRequest"}, + "output":{"shape":"CreateMaintenanceWindowResult"}, + "errors":[ + {"shape":"IdempotentParameterMismatch"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a new maintenance window.

    The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

    " + }, + "CreateOpsItem":{ + "name":"CreateOpsItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateOpsItemRequest"}, + "output":{"shape":"CreateOpsItemResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemAlreadyExistsException"}, + {"shape":"OpsItemLimitExceededException"}, + {"shape":"OpsItemInvalidParameterException"} + ], + "documentation":"

    Creates a new OpsItem. You must have permission in AWS Identity and Access Management (IAM) to create a new OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

    " + }, + "CreatePatchBaseline":{ + "name":"CreatePatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreatePatchBaselineRequest"}, + "output":{"shape":"CreatePatchBaselineResult"}, + "errors":[ + {"shape":"IdempotentParameterMismatch"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a patch baseline.

    For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

    " + }, + "CreateResourceDataSync":{ + "name":"CreateResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceDataSyncRequest"}, + "output":{"shape":"CreateResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ResourceDataSyncCountExceededException"}, + {"shape":"ResourceDataSyncAlreadyExistsException"}, + {"shape":"ResourceDataSyncInvalidConfigurationException"} + ], + "documentation":"

    Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.

    By default, data is not encrypted in Amazon S3. We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide.

    " + }, + "DeleteActivation":{ + "name":"DeleteActivation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteActivationRequest"}, + "output":{"shape":"DeleteActivationResult"}, + "errors":[ + {"shape":"InvalidActivationId"}, + {"shape":"InvalidActivation"}, + {"shape":"InternalServerError"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    Deletes an activation. You are not required to delete an activation. If you delete an activation, you can no longer use it to register additional managed instances. Deleting an activation does not de-register managed instances. You must manually de-register managed instances.

    " + }, + "DeleteAssociation":{ + "name":"DeleteAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAssociationRequest"}, + "output":{"shape":"DeleteAssociationResult"}, + "errors":[ + {"shape":"AssociationDoesNotExist"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    Disassociates the specified Systems Manager document from the specified instance.

    When you disassociate a document from an instance, it does not change the configuration of the instance. To change the configuration state of an instance after you disassociate a document, you must create a new document with the desired configuration and associate it with the instance.

    " + }, + "DeleteDocument":{ + "name":"DeleteDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDocumentRequest"}, + "output":{"shape":"DeleteDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentOperation"}, + {"shape":"AssociatedInstances"} + ], + "documentation":"

    Deletes the Systems Manager document and all instance associations to the document.

    Before you delete the document, we recommend that you use DeleteAssociation to disassociate all instances that are associated with the document.

    " + }, + "DeleteInventory":{ + "name":"DeleteInventory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteInventoryRequest"}, + "output":{"shape":"DeleteInventoryResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidOptionException"}, + {"shape":"InvalidDeleteInventoryParametersException"}, + {"shape":"InvalidInventoryRequestException"} + ], + "documentation":"

    Delete a custom inventory type, or the data associated with a custom Inventory type. Deleting a custom inventory type is also referred to as deleting a custom inventory schema.

    " + }, + "DeleteMaintenanceWindow":{ + "name":"DeleteMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMaintenanceWindowRequest"}, + "output":{"shape":"DeleteMaintenanceWindowResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes a maintenance window.

    " + }, + "DeleteParameter":{ + "name":"DeleteParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteParameterRequest"}, + "output":{"shape":"DeleteParameterResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ParameterNotFound"} + ], + "documentation":"

    Delete a parameter from the system.

    " + }, + "DeleteParameters":{ + "name":"DeleteParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteParametersRequest"}, + "output":{"shape":"DeleteParametersResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Delete a list of parameters.

    " + }, + "DeletePatchBaseline":{ + "name":"DeletePatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePatchBaselineRequest"}, + "output":{"shape":"DeletePatchBaselineResult"}, + "errors":[ + {"shape":"ResourceInUseException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes a patch baseline.

    " + }, + "DeleteResourceDataSync":{ + "name":"DeleteResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceDataSyncRequest"}, + "output":{"shape":"DeleteResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ResourceDataSyncNotFoundException"} + ], + "documentation":"

    Deletes a Resource Data Sync configuration. After the configuration is deleted, changes to inventory data on managed instances are no longer synced with the target Amazon S3 bucket. Deleting a sync configuration does not delete data in the target Amazon S3 bucket.

    " + }, + "DeregisterManagedInstance":{ + "name":"DeregisterManagedInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterManagedInstanceRequest"}, + "output":{"shape":"DeregisterManagedInstanceResult"}, + "errors":[ + {"shape":"InvalidInstanceId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Removes the server or virtual machine from the list of registered servers. You can reregister the instance again at any time. If you don't plan to use Run Command on the server, we suggest uninstalling SSM Agent first.

    " + }, + "DeregisterPatchBaselineForPatchGroup":{ + "name":"DeregisterPatchBaselineForPatchGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterPatchBaselineForPatchGroupRequest"}, + "output":{"shape":"DeregisterPatchBaselineForPatchGroupResult"}, + "errors":[ + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Removes a patch group from a patch baseline.

    " + }, + "DeregisterTargetFromMaintenanceWindow":{ + "name":"DeregisterTargetFromMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterTargetFromMaintenanceWindowRequest"}, + "output":{"shape":"DeregisterTargetFromMaintenanceWindowResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"}, + {"shape":"TargetInUseException"} + ], + "documentation":"

    Removes a target from a maintenance window.

    " + }, + "DeregisterTaskFromMaintenanceWindow":{ + "name":"DeregisterTaskFromMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterTaskFromMaintenanceWindowRequest"}, + "output":{"shape":"DeregisterTaskFromMaintenanceWindowResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Removes a task from a maintenance window.

    " + }, + "DescribeActivations":{ + "name":"DescribeActivations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivationsRequest"}, + "output":{"shape":"DescribeActivationsResult"}, + "errors":[ + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Describes details about the activation, such as the date and time the activation was created, its expiration date, the IAM role assigned to the instances in the activation, and the number of instances registered by using this activation.

    " + }, + "DescribeAssociation":{ + "name":"DescribeAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssociationRequest"}, + "output":{"shape":"DescribeAssociationResult"}, + "errors":[ + {"shape":"AssociationDoesNotExist"}, + {"shape":"InvalidAssociationVersion"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidInstanceId"} + ], + "documentation":"

    Describes the association for the specified target or instance. If you created the association by using the Targets parameter, then you must retrieve the association by using the association ID. If you created the association by specifying an instance ID and a Systems Manager document, then you retrieve the association by specifying the document name and the instance ID.

    " + }, + "DescribeAssociationExecutionTargets":{ + "name":"DescribeAssociationExecutionTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssociationExecutionTargetsRequest"}, + "output":{"shape":"DescribeAssociationExecutionTargetsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AssociationDoesNotExist"}, + {"shape":"InvalidNextToken"}, + {"shape":"AssociationExecutionDoesNotExist"} + ], + "documentation":"

    Use this API action to view information about a specific execution of a specific association.

    " + }, + "DescribeAssociationExecutions":{ + "name":"DescribeAssociationExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAssociationExecutionsRequest"}, + "output":{"shape":"DescribeAssociationExecutionsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AssociationDoesNotExist"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Use this API action to view all executions for a specific association ID.

    " + }, + "DescribeAutomationExecutions":{ + "name":"DescribeAutomationExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAutomationExecutionsRequest"}, + "output":{"shape":"DescribeAutomationExecutionsResult"}, + "errors":[ + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidFilterValue"}, + {"shape":"InvalidNextToken"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Provides details about all active and terminated Automation executions.

    " + }, + "DescribeAutomationStepExecutions":{ + "name":"DescribeAutomationStepExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAutomationStepExecutionsRequest"}, + "output":{"shape":"DescribeAutomationStepExecutionsResult"}, + "errors":[ + {"shape":"AutomationExecutionNotFoundException"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidFilterValue"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Information about all active and terminated step executions in an Automation workflow.

    " + }, + "DescribeAvailablePatches":{ + "name":"DescribeAvailablePatches", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAvailablePatchesRequest"}, + "output":{"shape":"DescribeAvailablePatchesResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists all patches eligible to be included in a patch baseline.

    " + }, + "DescribeDocument":{ + "name":"DescribeDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentRequest"}, + "output":{"shape":"DescribeDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"} + ], + "documentation":"

    Describes the specified Systems Manager document.

    " + }, + "DescribeDocumentPermission":{ + "name":"DescribeDocumentPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDocumentPermissionRequest"}, + "output":{"shape":"DescribeDocumentPermissionResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidPermissionType"} + ], + "documentation":"

    Describes the permissions for a Systems Manager document. If you created the document, you are the owner. If a document is shared, it can either be shared privately (by specifying a user's AWS account ID) or publicly (All).

    " + }, + "DescribeEffectiveInstanceAssociations":{ + "name":"DescribeEffectiveInstanceAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEffectiveInstanceAssociationsRequest"}, + "output":{"shape":"DescribeEffectiveInstanceAssociationsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    All associations for the instance(s).

    " + }, + "DescribeEffectivePatchesForPatchBaseline":{ + "name":"DescribeEffectivePatchesForPatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeEffectivePatchesForPatchBaselineRequest"}, + "output":{"shape":"DescribeEffectivePatchesForPatchBaselineResult"}, + "errors":[ + {"shape":"InvalidResourceId"}, + {"shape":"DoesNotExistException"}, + {"shape":"UnsupportedOperatingSystem"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the current effective patches (the patch and the approval state) for the specified patch baseline. Note that this API applies only to Windows patch baselines.

    " + }, + "DescribeInstanceAssociationsStatus":{ + "name":"DescribeInstanceAssociationsStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceAssociationsStatusRequest"}, + "output":{"shape":"DescribeInstanceAssociationsStatusResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    The status of the associations for the instance(s).

    " + }, + "DescribeInstanceInformation":{ + "name":"DescribeInstanceInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstanceInformationRequest"}, + "output":{"shape":"DescribeInstanceInformationResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidInstanceInformationFilterValue"}, + {"shape":"InvalidFilterKey"} + ], + "documentation":"

    Describes one or more of your instances. You can use this to get information about instances like the operating system platform, the SSM Agent version (Linux), status etc. If you specify one or more instance IDs, it returns information for those instances. If you do not specify instance IDs, it returns information for all your instances. If you specify an instance ID that is not valid or an instance that you do not own, you receive an error.

    The IamRole field for this API action is the Amazon Identity and Access Management (IAM) role assigned to on-premises instances. This call does not return the IAM role for Amazon EC2 instances.

    " + }, + "DescribeInstancePatchStates":{ + "name":"DescribeInstancePatchStates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancePatchStatesRequest"}, + "output":{"shape":"DescribeInstancePatchStatesResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Retrieves the high-level patch state of one or more instances.

    " + }, + "DescribeInstancePatchStatesForPatchGroup":{ + "name":"DescribeInstancePatchStatesForPatchGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancePatchStatesForPatchGroupRequest"}, + "output":{"shape":"DescribeInstancePatchStatesForPatchGroupResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Retrieves the high-level patch state for the instances in the specified patch group.

    " + }, + "DescribeInstancePatches":{ + "name":"DescribeInstancePatches", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInstancePatchesRequest"}, + "output":{"shape":"DescribeInstancePatchesResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Retrieves information about the patches on the specified instance and their state relative to the patch baseline being used for the instance.

    " + }, + "DescribeInventoryDeletions":{ + "name":"DescribeInventoryDeletions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeInventoryDeletionsRequest"}, + "output":{"shape":"DescribeInventoryDeletionsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDeletionIdException"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Describes a specific delete inventory operation.

    " + }, + "DescribeMaintenanceWindowExecutionTaskInvocations":{ + "name":"DescribeMaintenanceWindowExecutionTaskInvocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsRequest"}, + "output":{"shape":"DescribeMaintenanceWindowExecutionTaskInvocationsResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the individual task executions (one per target) for a particular task run as part of a maintenance window execution.

    " + }, + "DescribeMaintenanceWindowExecutionTasks":{ + "name":"DescribeMaintenanceWindowExecutionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowExecutionTasksRequest"}, + "output":{"shape":"DescribeMaintenanceWindowExecutionTasksResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    For a given maintenance window execution, lists the tasks that were run.

    " + }, + "DescribeMaintenanceWindowExecutions":{ + "name":"DescribeMaintenanceWindowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowExecutionsRequest"}, + "output":{"shape":"DescribeMaintenanceWindowExecutionsResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the executions of a maintenance window. This includes information about when the maintenance window was scheduled to be active, and information about tasks registered and run with the maintenance window.

    " + }, + "DescribeMaintenanceWindowSchedule":{ + "name":"DescribeMaintenanceWindowSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowScheduleRequest"}, + "output":{"shape":"DescribeMaintenanceWindowScheduleResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"DoesNotExistException"} + ], + "documentation":"

    Retrieves information about upcoming executions of a maintenance window.

    " + }, + "DescribeMaintenanceWindowTargets":{ + "name":"DescribeMaintenanceWindowTargets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowTargetsRequest"}, + "output":{"shape":"DescribeMaintenanceWindowTargetsResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the targets registered with the maintenance window.

    " + }, + "DescribeMaintenanceWindowTasks":{ + "name":"DescribeMaintenanceWindowTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowTasksRequest"}, + "output":{"shape":"DescribeMaintenanceWindowTasksResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the tasks in a maintenance window.

    " + }, + "DescribeMaintenanceWindows":{ + "name":"DescribeMaintenanceWindows", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowsRequest"}, + "output":{"shape":"DescribeMaintenanceWindowsResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the maintenance windows in an AWS account.

    " + }, + "DescribeMaintenanceWindowsForTarget":{ + "name":"DescribeMaintenanceWindowsForTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceWindowsForTargetRequest"}, + "output":{"shape":"DescribeMaintenanceWindowsForTargetResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves information about the maintenance window targets or tasks that an instance is associated with.

    " + }, + "DescribeOpsItems":{ + "name":"DescribeOpsItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOpsItemsRequest"}, + "output":{"shape":"DescribeOpsItemsResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Query a set of OpsItems. You must have permission in AWS Identity and Access Management (IAM) to query a list of OpsItems. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

    " + }, + "DescribeParameters":{ + "name":"DescribeParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeParametersRequest"}, + "output":{"shape":"DescribeParametersResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidFilterOption"}, + {"shape":"InvalidFilterValue"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Get information about a parameter.

    Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

    " + }, + "DescribePatchBaselines":{ + "name":"DescribePatchBaselines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePatchBaselinesRequest"}, + "output":{"shape":"DescribePatchBaselinesResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the patch baselines in your AWS account.

    " + }, + "DescribePatchGroupState":{ + "name":"DescribePatchGroupState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePatchGroupStateRequest"}, + "output":{"shape":"DescribePatchGroupStateResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Returns high-level aggregated patch compliance state for a patch group.

    " + }, + "DescribePatchGroups":{ + "name":"DescribePatchGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePatchGroupsRequest"}, + "output":{"shape":"DescribePatchGroupsResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists all patch groups that have been registered with patch baselines.

    " + }, + "DescribePatchProperties":{ + "name":"DescribePatchProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePatchPropertiesRequest"}, + "output":{"shape":"DescribePatchPropertiesResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the properties of available patches organized by product, product family, classification, severity, and other properties of available patches. You can use the reported properties in the filters you specify in requests for actions such as CreatePatchBaseline, UpdatePatchBaseline, DescribeAvailablePatches, and DescribePatchBaselines.

    The following section lists the properties that can be used in filters for each major operating system type:

    WINDOWS

    Valid properties: PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, MSRC_SEVERITY

    AMAZON_LINUX

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    AMAZON_LINUX_2

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    UBUNTU

    Valid properties: PRODUCT, PRIORITY

    REDHAT_ENTERPRISE_LINUX

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    SUSE

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    CENTOS

    Valid properties: PRODUCT, CLASSIFICATION, SEVERITY

    " + }, + "DescribeSessions":{ + "name":"DescribeSessions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSessionsRequest"}, + "output":{"shape":"DescribeSessionsResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Retrieves a list of all active sessions (both connected and disconnected) or terminated sessions from the past 30 days.

    " + }, + "GetAutomationExecution":{ + "name":"GetAutomationExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAutomationExecutionRequest"}, + "output":{"shape":"GetAutomationExecutionResult"}, + "errors":[ + {"shape":"AutomationExecutionNotFoundException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Get detailed information about a particular Automation execution.

    " + }, + "GetCommandInvocation":{ + "name":"GetCommandInvocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommandInvocationRequest"}, + "output":{"shape":"GetCommandInvocationResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidPluginName"}, + {"shape":"InvocationDoesNotExist"} + ], + "documentation":"

    Returns detailed information about command execution for an invocation or plugin.

    " + }, + "GetConnectionStatus":{ + "name":"GetConnectionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetConnectionStatusRequest"}, + "output":{"shape":"GetConnectionStatusResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the Session Manager connection status for an instance to determine whether it is connected and ready to receive Session Manager connections.

    " + }, + "GetDefaultPatchBaseline":{ + "name":"GetDefaultPatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDefaultPatchBaselineRequest"}, + "output":{"shape":"GetDefaultPatchBaselineResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the default patch baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

    If you do not specify an operating system value, the default patch baseline for Windows is returned.

    " + }, + "GetDeployablePatchSnapshotForInstance":{ + "name":"GetDeployablePatchSnapshotForInstance", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDeployablePatchSnapshotForInstanceRequest"}, + "output":{"shape":"GetDeployablePatchSnapshotForInstanceResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"UnsupportedOperatingSystem"}, + {"shape":"UnsupportedFeatureRequiredException"} + ], + "documentation":"

    Retrieves the current snapshot for the patch baseline the instance uses. This API is primarily used by the AWS-RunPatchBaseline Systems Manager document.

    " + }, + "GetDocument":{ + "name":"GetDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDocumentRequest"}, + "output":{"shape":"GetDocumentResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"} + ], + "documentation":"

    Gets the contents of the specified Systems Manager document.

    " + }, + "GetInventory":{ + "name":"GetInventory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInventoryRequest"}, + "output":{"shape":"GetInventoryResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidInventoryGroupException"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidAggregatorException"}, + {"shape":"InvalidResultAttributeException"} + ], + "documentation":"

    Query inventory information.

    " + }, + "GetInventorySchema":{ + "name":"GetInventorySchema", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetInventorySchemaRequest"}, + "output":{"shape":"GetInventorySchemaResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Return a list of inventory type names for the account, or return a list of attribute names for a specific Inventory item type.

    " + }, + "GetMaintenanceWindow":{ + "name":"GetMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMaintenanceWindowRequest"}, + "output":{"shape":"GetMaintenanceWindowResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves a maintenance window.

    " + }, + "GetMaintenanceWindowExecution":{ + "name":"GetMaintenanceWindowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMaintenanceWindowExecutionRequest"}, + "output":{"shape":"GetMaintenanceWindowExecutionResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves details about a specific a maintenance window execution.

    " + }, + "GetMaintenanceWindowExecutionTask":{ + "name":"GetMaintenanceWindowExecutionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMaintenanceWindowExecutionTaskRequest"}, + "output":{"shape":"GetMaintenanceWindowExecutionTaskResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the details about a specific task run as part of a maintenance window execution.

    " + }, + "GetMaintenanceWindowExecutionTaskInvocation":{ + "name":"GetMaintenanceWindowExecutionTaskInvocation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMaintenanceWindowExecutionTaskInvocationRequest"}, + "output":{"shape":"GetMaintenanceWindowExecutionTaskInvocationResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves information about a specific task running on a specific target.

    " + }, + "GetMaintenanceWindowTask":{ + "name":"GetMaintenanceWindowTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMaintenanceWindowTaskRequest"}, + "output":{"shape":"GetMaintenanceWindowTaskResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the tasks in a maintenance window.

    " + }, + "GetOpsItem":{ + "name":"GetOpsItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpsItemRequest"}, + "output":{"shape":"GetOpsItemResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemNotFoundException"} + ], + "documentation":"

    Get information about an OpsItem by using the ID. You must have permission in AWS Identity and Access Management (IAM) to view information about an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

    " + }, + "GetOpsSummary":{ + "name":"GetOpsSummary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetOpsSummaryRequest"}, + "output":{"shape":"GetOpsSummaryResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidAggregatorException"} + ], + "documentation":"

    View a summary of OpsItems based on specified filters and aggregators.

    " + }, + "GetParameter":{ + "name":"GetParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParameterRequest"}, + "output":{"shape":"GetParameterResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidKeyId"}, + {"shape":"ParameterNotFound"}, + {"shape":"ParameterVersionNotFound"} + ], + "documentation":"

    Get information about a parameter by using the parameter name. Don't confuse this API action with the GetParameters API action.

    " + }, + "GetParameterHistory":{ + "name":"GetParameterHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParameterHistoryRequest"}, + "output":{"shape":"GetParameterHistoryResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ParameterNotFound"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidKeyId"} + ], + "documentation":"

    Query a list of all parameters used by the AWS account.

    " + }, + "GetParameters":{ + "name":"GetParameters", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParametersRequest"}, + "output":{"shape":"GetParametersResult"}, + "errors":[ + {"shape":"InvalidKeyId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Get details of a parameter. Don't confuse this API action with the GetParameter API action.

    " + }, + "GetParametersByPath":{ + "name":"GetParametersByPath", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetParametersByPathRequest"}, + "output":{"shape":"GetParametersByPathResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidFilterOption"}, + {"shape":"InvalidFilterValue"}, + {"shape":"InvalidKeyId"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Retrieve parameters in a specific hierarchy. For more information, see Working with Systems Manager Parameters in the AWS Systems Manager User Guide.

    Request results are returned on a best-effort basis. If you specify MaxResults in the request, the response includes information up to the limit specified. The number of items returned, however, can be between zero and the value of MaxResults. If the service reaches an internal limit while processing the results, it stops the operation and returns the matching values up to that point and a NextToken. You can specify the NextToken in a subsequent call to get the next set of results.

    This API action doesn't support filtering by tags.

    " + }, + "GetPatchBaseline":{ + "name":"GetPatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPatchBaselineRequest"}, + "output":{"shape":"GetPatchBaselineResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves information about a patch baseline.

    " + }, + "GetPatchBaselineForPatchGroup":{ + "name":"GetPatchBaselineForPatchGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPatchBaselineForPatchGroupRequest"}, + "output":{"shape":"GetPatchBaselineForPatchGroupResult"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the patch baseline that should be used for the specified patch group.

    " + }, + "GetServiceSetting":{ + "name":"GetServiceSetting", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetServiceSettingRequest"}, + "output":{"shape":"GetServiceSettingResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ServiceSettingNotFound"} + ], + "documentation":"

    ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.

    Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

    Query the current service setting for the account.

    " + }, + "LabelParameterVersion":{ + "name":"LabelParameterVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"LabelParameterVersionRequest"}, + "output":{"shape":"LabelParameterVersionResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"TooManyUpdates"}, + {"shape":"ParameterNotFound"}, + {"shape":"ParameterVersionNotFound"}, + {"shape":"ParameterVersionLabelLimitExceeded"} + ], + "documentation":"

    A parameter label is a user-defined alias to help you manage different versions of a parameter. When you modify a parameter, Systems Manager automatically saves a new version and increments the version number by one. A label can help you remember the purpose of a parameter when there are multiple versions.

    Parameter labels have the following requirements and restrictions.

    • A version of a parameter can have a maximum of 10 labels.

    • You can't attach the same label to different versions of the same parameter. For example, if version 1 has the label Production, then you can't attach Production to version 2.

    • You can move a label from one version of a parameter to another.

    • You can't create a label when you create a new parameter. You must attach a label to a specific version of a parameter.

    • You can't delete a parameter label. If you no longer want to use a parameter label, then you must move it to a different version of a parameter.

    • A label can have a maximum of 100 characters.

    • Labels can contain letters (case sensitive), numbers, periods (.), hyphens (-), or underscores (_).

    • Labels can't begin with a number, \"aws,\" or \"ssm\" (not case sensitive). If a label fails to meet these requirements, then the label is not associated with a parameter and the system displays it in the list of InvalidLabels.

    " + }, + "ListAssociationVersions":{ + "name":"ListAssociationVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociationVersionsRequest"}, + "output":{"shape":"ListAssociationVersionsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"}, + {"shape":"AssociationDoesNotExist"} + ], + "documentation":"

    Retrieves all versions of an association for a specific association ID.

    " + }, + "ListAssociations":{ + "name":"ListAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAssociationsRequest"}, + "output":{"shape":"ListAssociationsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Lists the associations for the specified Systems Manager document or instance.

    " + }, + "ListCommandInvocations":{ + "name":"ListCommandInvocations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCommandInvocationsRequest"}, + "output":{"shape":"ListCommandInvocationsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. ListCommandInvocations provide status about command execution.

    " + }, + "ListCommands":{ + "name":"ListCommands", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListCommandsRequest"}, + "output":{"shape":"ListCommandsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidCommandId"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidFilterKey"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Lists the commands requested by users of the AWS account.

    " + }, + "ListComplianceItems":{ + "name":"ListComplianceItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComplianceItemsRequest"}, + "output":{"shape":"ListComplianceItemsResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    For a specified resource ID, this API action returns a list of compliance statuses for different resource types. Currently, you can only specify one resource ID per call. List results depend on the criteria specified in the filter.

    " + }, + "ListComplianceSummaries":{ + "name":"ListComplianceSummaries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListComplianceSummariesRequest"}, + "output":{"shape":"ListComplianceSummariesResult"}, + "errors":[ + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a summary count of compliant and non-compliant resources for a compliance type. For example, this call can return State Manager associations, patches, or custom compliance types according to the filter criteria that you specify.

    " + }, + "ListDocumentVersions":{ + "name":"ListDocumentVersions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDocumentVersionsRequest"}, + "output":{"shape":"ListDocumentVersionsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidDocument"} + ], + "documentation":"

    List all versions for a document.

    " + }, + "ListDocuments":{ + "name":"ListDocuments", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDocumentsRequest"}, + "output":{"shape":"ListDocumentsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"}, + {"shape":"InvalidFilterKey"} + ], + "documentation":"

    Describes one or more of your Systems Manager documents.

    " + }, + "ListInventoryEntries":{ + "name":"ListInventoryEntries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListInventoryEntriesRequest"}, + "output":{"shape":"ListInventoryEntriesResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    A list of inventory items returned by the request.

    " + }, + "ListResourceComplianceSummaries":{ + "name":"ListResourceComplianceSummaries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceComplianceSummariesRequest"}, + "output":{"shape":"ListResourceComplianceSummariesResult"}, + "errors":[ + {"shape":"InvalidFilter"}, + {"shape":"InvalidNextToken"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a resource-level summary count. The summary includes information about compliant and non-compliant statuses and detailed compliance-item severity counts, according to the filter criteria you specify.

    " + }, + "ListResourceDataSync":{ + "name":"ListResourceDataSync", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceDataSyncRequest"}, + "output":{"shape":"ListResourceDataSyncResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidNextToken"} + ], + "documentation":"

    Lists your resource data sync configurations. Includes information about the last time a sync attempted to start, the last sync status, and the last time a sync successfully completed.

    The number of sync configurations might be too large to return using a single call to ListResourceDataSync. You can limit the number of sync configurations returned by using the MaxResults parameter. To determine whether there are more sync configurations to list, check the value of NextToken in the output. If there are more sync configurations to list, you can request them by specifying the NextToken returned in the call to the parameter of a subsequent call.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a list of the tags assigned to the specified resource.

    " + }, + "ModifyDocumentPermission":{ + "name":"ModifyDocumentPermission", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyDocumentPermissionRequest"}, + "output":{"shape":"ModifyDocumentPermissionResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidPermissionType"}, + {"shape":"DocumentPermissionLimit"}, + {"shape":"DocumentLimitExceeded"} + ], + "documentation":"

    Shares a Systems Manager document publicly or privately. If you share a document privately, you must specify the AWS user account IDs for those people who can use the document. If you share a document publicly, you must specify All as the account ID.

    " + }, + "PutComplianceItems":{ + "name":"PutComplianceItems", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutComplianceItemsRequest"}, + "output":{"shape":"PutComplianceItemsResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidItemContentException"}, + {"shape":"TotalSizeLimitExceededException"}, + {"shape":"ItemSizeLimitExceededException"}, + {"shape":"ComplianceTypeCountLimitExceededException"}, + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"} + ], + "documentation":"

    Registers a compliance type and other compliance details on a designated resource. This action lets you register custom compliance details with a resource. This call overwrites existing compliance information on the resource, so you must provide a full list of compliance items each time that you send the request.

    ComplianceType can be one of the following:

    • ExecutionId: The execution ID when the patch, association, or custom compliance item was applied.

    • ExecutionType: Specify patch, association, or Custom:string.

    • ExecutionTime. The time the patch, association, or custom compliance item was applied to the instance.

    • Id: The patch, association, or custom compliance ID.

    • Title: A title.

    • Status: The status of the compliance item. For example, approved for patches, or Failed for associations.

    • Severity: A patch severity. For example, critical.

    • DocumentName: A SSM document name. For example, AWS-RunPatchBaseline.

    • DocumentVersion: An SSM document version number. For example, 4.

    • Classification: A patch classification. For example, security updates.

    • PatchBaselineId: A patch baseline ID.

    • PatchSeverity: A patch severity. For example, Critical.

    • PatchState: A patch state. For example, InstancesWithFailedPatches.

    • PatchGroup: The name of a patch group.

    • InstalledTime: The time the association, patch, or custom compliance item was applied to the resource. Specify the time by using the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

    " + }, + "PutInventory":{ + "name":"PutInventory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutInventoryRequest"}, + "output":{"shape":"PutInventoryResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidTypeNameException"}, + {"shape":"InvalidItemContentException"}, + {"shape":"TotalSizeLimitExceededException"}, + {"shape":"ItemSizeLimitExceededException"}, + {"shape":"ItemContentMismatchException"}, + {"shape":"CustomSchemaCountLimitExceededException"}, + {"shape":"UnsupportedInventorySchemaVersionException"}, + {"shape":"UnsupportedInventoryItemContextException"}, + {"shape":"InvalidInventoryItemContextException"}, + {"shape":"SubTypeCountLimitExceededException"} + ], + "documentation":"

    Bulk update custom inventory items on one more instance. The request adds an inventory item, if it doesn't already exist, or updates an inventory item, if it does exist.

    " + }, + "PutParameter":{ + "name":"PutParameter", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutParameterRequest"}, + "output":{"shape":"PutParameterResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidKeyId"}, + {"shape":"ParameterLimitExceeded"}, + {"shape":"TooManyUpdates"}, + {"shape":"ParameterAlreadyExists"}, + {"shape":"HierarchyLevelLimitExceededException"}, + {"shape":"HierarchyTypeMismatchException"}, + {"shape":"InvalidAllowedPatternException"}, + {"shape":"ParameterMaxVersionLimitExceeded"}, + {"shape":"ParameterPatternMismatchException"}, + {"shape":"UnsupportedParameterType"}, + {"shape":"PoliciesLimitExceededException"}, + {"shape":"InvalidPolicyTypeException"}, + {"shape":"InvalidPolicyAttributeException"}, + {"shape":"IncompatiblePolicyException"} + ], + "documentation":"

    Add a parameter to the system.

    " + }, + "RegisterDefaultPatchBaseline":{ + "name":"RegisterDefaultPatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDefaultPatchBaselineRequest"}, + "output":{"shape":"RegisterDefaultPatchBaselineResult"}, + "errors":[ + {"shape":"InvalidResourceId"}, + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Defines the default patch baseline for the relevant operating system.

    To reset the AWS predefined patch baseline as the default, specify the full patch baseline ARN as the baseline ID value. For example, for CentOS, specify arn:aws:ssm:us-east-2:733109147000:patchbaseline/pb-0574b43a65ea646ed instead of pb-0574b43a65ea646ed.

    " + }, + "RegisterPatchBaselineForPatchGroup":{ + "name":"RegisterPatchBaselineForPatchGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterPatchBaselineForPatchGroupRequest"}, + "output":{"shape":"RegisterPatchBaselineForPatchGroupResult"}, + "errors":[ + {"shape":"AlreadyExistsException"}, + {"shape":"DoesNotExistException"}, + {"shape":"InvalidResourceId"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Registers a patch baseline for a patch group.

    " + }, + "RegisterTargetWithMaintenanceWindow":{ + "name":"RegisterTargetWithMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterTargetWithMaintenanceWindowRequest"}, + "output":{"shape":"RegisterTargetWithMaintenanceWindowResult"}, + "errors":[ + {"shape":"IdempotentParameterMismatch"}, + {"shape":"DoesNotExistException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Registers a target with a maintenance window.

    " + }, + "RegisterTaskWithMaintenanceWindow":{ + "name":"RegisterTaskWithMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterTaskWithMaintenanceWindowRequest"}, + "output":{"shape":"RegisterTaskWithMaintenanceWindowResult"}, + "errors":[ + {"shape":"IdempotentParameterMismatch"}, + {"shape":"DoesNotExistException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"FeatureNotAvailableException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Adds a new task to a maintenance window.

    " + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceRequest"}, + "output":{"shape":"RemoveTagsFromResourceResult"}, + "errors":[ + {"shape":"InvalidResourceType"}, + {"shape":"InvalidResourceId"}, + {"shape":"InternalServerError"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    Removes tag keys from the specified resource.

    " + }, + "ResetServiceSetting":{ + "name":"ResetServiceSetting", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetServiceSettingRequest"}, + "output":{"shape":"ResetServiceSettingResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ServiceSettingNotFound"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.

    Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Use the UpdateServiceSetting API action to change the default setting.

    Reset the service setting for the account to the default value as provisioned by the AWS service team.

    " + }, + "ResumeSession":{ + "name":"ResumeSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResumeSessionRequest"}, + "output":{"shape":"ResumeSessionResponse"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Reconnects a session to an instance after it has been disconnected. Connections can be resumed for disconnected sessions, but not terminated sessions.

    This command is primarily for use by client machines to automatically reconnect during intermittent network issues. It is not intended for any other use.

    " + }, + "SendAutomationSignal":{ + "name":"SendAutomationSignal", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendAutomationSignalRequest"}, + "output":{"shape":"SendAutomationSignalResult"}, + "errors":[ + {"shape":"AutomationExecutionNotFoundException"}, + {"shape":"AutomationStepNotFoundException"}, + {"shape":"InvalidAutomationSignalException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Sends a signal to an Automation execution to change the current behavior or status of the execution.

    " + }, + "SendCommand":{ + "name":"SendCommand", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendCommandRequest"}, + "output":{"shape":"SendCommandResult"}, + "errors":[ + {"shape":"DuplicateInstanceId"}, + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"InvalidOutputFolder"}, + {"shape":"InvalidParameters"}, + {"shape":"UnsupportedPlatformType"}, + {"shape":"MaxDocumentSizeExceeded"}, + {"shape":"InvalidRole"}, + {"shape":"InvalidNotificationConfig"} + ], + "documentation":"

    Runs commands on one or more managed instances.

    " + }, + "StartAssociationsOnce":{ + "name":"StartAssociationsOnce", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAssociationsOnceRequest"}, + "output":{"shape":"StartAssociationsOnceResult"}, + "errors":[ + {"shape":"InvalidAssociation"}, + {"shape":"AssociationDoesNotExist"} + ], + "documentation":"

    Use this API action to run an association immediately and only one time. This action can be helpful when troubleshooting associations.

    " + }, + "StartAutomationExecution":{ + "name":"StartAutomationExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartAutomationExecutionRequest"}, + "output":{"shape":"StartAutomationExecutionResult"}, + "errors":[ + {"shape":"AutomationDefinitionNotFoundException"}, + {"shape":"InvalidAutomationExecutionParametersException"}, + {"shape":"AutomationExecutionLimitExceededException"}, + {"shape":"AutomationDefinitionVersionNotFoundException"}, + {"shape":"IdempotentParameterMismatch"}, + {"shape":"InvalidTarget"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Initiates execution of an Automation document.

    " + }, + "StartSession":{ + "name":"StartSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSessionRequest"}, + "output":{"shape":"StartSessionResponse"}, + "errors":[ + {"shape":"InvalidDocument"}, + {"shape":"TargetNotConnected"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Initiates a connection to a target (for example, an instance) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

    AWS CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager Plugin for the AWS CLI in the AWS Systems Manager User Guide.

    AWS Tools for PowerShell usage: Start-SSMSession is not currently supported by AWS Tools for PowerShell on Windows local machines.

    " + }, + "StopAutomationExecution":{ + "name":"StopAutomationExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopAutomationExecutionRequest"}, + "output":{"shape":"StopAutomationExecutionResult"}, + "errors":[ + {"shape":"AutomationExecutionNotFoundException"}, + {"shape":"InvalidAutomationStatusUpdateException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Stop an Automation that is currently running.

    " + }, + "TerminateSession":{ + "name":"TerminateSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateSessionRequest"}, + "output":{"shape":"TerminateSessionResponse"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Permanently ends a session and closes the data connection between the Session Manager client and SSM Agent on the instance. A terminated session cannot be resumed.

    " + }, + "UpdateAssociation":{ + "name":"UpdateAssociation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssociationRequest"}, + "output":{"shape":"UpdateAssociationResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidSchedule"}, + {"shape":"InvalidParameters"}, + {"shape":"InvalidOutputLocation"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"AssociationDoesNotExist"}, + {"shape":"InvalidUpdate"}, + {"shape":"TooManyUpdates"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidTarget"}, + {"shape":"InvalidAssociationVersion"}, + {"shape":"AssociationVersionLimitExceeded"} + ], + "documentation":"

    Updates an association. You can update the association name and version, the document version, schedule, parameters, and Amazon S3 output.

    In order to call this API action, your IAM user account, group, or role must be configured with permission to call the DescribeAssociation API action. If you don't have permission to call DescribeAssociation, then you receive the following error: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> is not authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

    When you update an association, the association immediately runs against the specified targets.

    " + }, + "UpdateAssociationStatus":{ + "name":"UpdateAssociationStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateAssociationStatusRequest"}, + "output":{"shape":"UpdateAssociationStatusResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidInstanceId"}, + {"shape":"InvalidDocument"}, + {"shape":"AssociationDoesNotExist"}, + {"shape":"StatusUnchanged"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    Updates the status of the Systems Manager document associated with the specified instance.

    " + }, + "UpdateDocument":{ + "name":"UpdateDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDocumentRequest"}, + "output":{"shape":"UpdateDocumentResult"}, + "errors":[ + {"shape":"MaxDocumentSizeExceeded"}, + {"shape":"DocumentVersionLimitExceeded"}, + {"shape":"InternalServerError"}, + {"shape":"DuplicateDocumentContent"}, + {"shape":"DuplicateDocumentVersionName"}, + {"shape":"InvalidDocumentContent"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"InvalidDocumentSchemaVersion"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentOperation"} + ], + "documentation":"

    Updates one or more values for an SSM document.

    " + }, + "UpdateDocumentDefaultVersion":{ + "name":"UpdateDocumentDefaultVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDocumentDefaultVersionRequest"}, + "output":{"shape":"UpdateDocumentDefaultVersionResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"InvalidDocument"}, + {"shape":"InvalidDocumentVersion"}, + {"shape":"InvalidDocumentSchemaVersion"} + ], + "documentation":"

    Set the default version of a document.

    " + }, + "UpdateMaintenanceWindow":{ + "name":"UpdateMaintenanceWindow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMaintenanceWindowRequest"}, + "output":{"shape":"UpdateMaintenanceWindowResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates an existing maintenance window. Only specified parameters are modified.

    The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

    " + }, + "UpdateMaintenanceWindowTarget":{ + "name":"UpdateMaintenanceWindowTarget", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMaintenanceWindowTargetRequest"}, + "output":{"shape":"UpdateMaintenanceWindowTargetResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Modifies the target of an existing maintenance window. You can change the following:

    • Name

    • Description

    • Owner

    • IDs for an ID target

    • Tags for a Tag target

    • From any supported tag type to another. The three supported tag types are ID target, Tag target, and resource group. For more information, see Target.

    If a parameter is null, then the corresponding field is not modified.

    " + }, + "UpdateMaintenanceWindowTask":{ + "name":"UpdateMaintenanceWindowTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMaintenanceWindowTaskRequest"}, + "output":{"shape":"UpdateMaintenanceWindowTaskResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Modifies a task assigned to a maintenance window. You can't change the task type, but you can change the following values:

    • TaskARN. For example, you can change a RUN_COMMAND task from AWS-RunPowerShellScript to AWS-RunShellScript.

    • ServiceRoleArn

    • TaskInvocationParameters

    • Priority

    • MaxConcurrency

    • MaxErrors

    If a parameter is null, then the corresponding field is not modified. Also, if you set Replace to true, then all fields required by the RegisterTaskWithMaintenanceWindow action are required for this request. Optional fields that aren't specified are set to null.

    " + }, + "UpdateManagedInstanceRole":{ + "name":"UpdateManagedInstanceRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateManagedInstanceRoleRequest"}, + "output":{"shape":"UpdateManagedInstanceRoleResult"}, + "errors":[ + {"shape":"InvalidInstanceId"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Assigns or changes an Amazon Identity and Access Management (IAM) role for the managed instance.

    " + }, + "UpdateOpsItem":{ + "name":"UpdateOpsItem", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateOpsItemRequest"}, + "output":{"shape":"UpdateOpsItemResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"OpsItemNotFoundException"}, + {"shape":"OpsItemAlreadyExistsException"}, + {"shape":"OpsItemLimitExceededException"}, + {"shape":"OpsItemInvalidParameterException"} + ], + "documentation":"

    Edit or change an OpsItem. You must have permission in AWS Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

    " + }, + "UpdatePatchBaseline":{ + "name":"UpdatePatchBaseline", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePatchBaselineRequest"}, + "output":{"shape":"UpdatePatchBaselineResult"}, + "errors":[ + {"shape":"DoesNotExistException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Modifies an existing patch baseline. Fields not specified in the request are left unchanged.

    For information about valid key and value pairs in PatchFilters for each supported operating system type, see PatchFilter.

    " + }, + "UpdateServiceSetting":{ + "name":"UpdateServiceSetting", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServiceSettingRequest"}, + "output":{"shape":"UpdateServiceSettingResult"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"ServiceSettingNotFound"}, + {"shape":"TooManyUpdates"} + ], + "documentation":"

    ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.

    Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the GetServiceSetting API action to view the current value. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

    Update the service setting for the account.

    " + } + }, + "shapes":{ + "Account":{"type":"string"}, + "AccountId":{ + "type":"string", + "pattern":"(?i)all|[0-9]{12}" + }, + "AccountIdList":{ + "type":"list", + "member":{"shape":"AccountId"}, + "max":20 + }, + "Accounts":{ + "type":"list", + "member":{"shape":"Account"}, + "max":50, + "min":1 + }, + "Activation":{ + "type":"structure", + "members":{ + "ActivationId":{ + "shape":"ActivationId", + "documentation":"

    The ID created by Systems Manager when you submitted the activation.

    " + }, + "Description":{ + "shape":"ActivationDescription", + "documentation":"

    A user defined description of the activation.

    " + }, + "DefaultInstanceName":{ + "shape":"DefaultInstanceName", + "documentation":"

    A name for the managed instance when it is created.

    " + }, + "IamRole":{ + "shape":"IamRole", + "documentation":"

    The Amazon Identity and Access Management (IAM) role to assign to the managed instance.

    " + }, + "RegistrationLimit":{ + "shape":"RegistrationLimit", + "documentation":"

    The maximum number of managed instances that can be registered using this activation.

    " + }, + "RegistrationsCount":{ + "shape":"RegistrationsCount", + "documentation":"

    The number of managed instances already registered with this activation.

    " + }, + "ExpirationDate":{ + "shape":"ExpirationDate", + "documentation":"

    The date when this activation can no longer be used to register managed instances.

    " + }, + "Expired":{ + "shape":"Boolean", + "documentation":"

    Whether or not the activation is expired.

    " + }, + "CreatedDate":{ + "shape":"CreatedDate", + "documentation":"

    The date the activation was created.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Tags assigned to the activation.

    " + } + }, + "documentation":"

    An activation registers one or more on-premises servers or virtual machines (VMs) with AWS so that you can configure those servers or VMs using Run Command. A server or VM that has been registered with AWS is called a managed instance.

    " + }, + "ActivationCode":{ + "type":"string", + "max":250, + "min":20 + }, + "ActivationDescription":{ + "type":"string", + "max":256, + "min":0 + }, + "ActivationId":{ + "type":"string", + "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" + }, + "ActivationList":{ + "type":"list", + "member":{"shape":"Activation"} + }, + "AddTagsToResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId", + "Tags" + ], + "members":{ + "ResourceType":{ + "shape":"ResourceTypeForTagging", + "documentation":"

    Specifies the type of resource you are tagging.

    The ManagedInstance type for this API action is for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The resource ID you want to tag.

    Use the ID of the resource. Here are some examples:

    ManagedInstance: mi-012345abcde

    MaintenanceWindow: mw-012345abcde

    PatchBaseline: pb-012345abcde

    For the Document and Parameter values, use the name of the resource.

    The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    One or more tags. The value parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

    Do not enter personally identifiable information in this field.

    " + } + } + }, + "AddTagsToResourceResult":{ + "type":"structure", + "members":{ + } + }, + "AgentErrorCode":{ + "type":"string", + "max":10 + }, + "AggregatorSchemaOnly":{"type":"boolean"}, + "AllowedPattern":{ + "type":"string", + "max":1024, + "min":0 + }, + "AlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Error returned if an attempt is made to register a patch group with a patch baseline that is already registered with a different patch baseline.

    ", + "exception":true + }, + "ApproveAfterDays":{ + "type":"integer", + "max":100, + "min":0 + }, + "AssociatedInstances":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You must disassociate a document from all instances before you can delete it.

    ", + "exception":true + }, + "Association":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The ID created by the system when you create an association. An association is a binding between a document and a set of targets with a schedule.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The association version.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of the document used in the association.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The instances targeted by the request to create an association.

    " + }, + "LastExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date on which the association was last run.

    " + }, + "Overview":{ + "shape":"AssociationOverview", + "documentation":"

    Information about the association.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    A cron expression that specifies a schedule when the association runs.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    The association name.

    " + } + }, + "documentation":"

    Describes an association of a Systems Manager document and an instance.

    " + }, + "AssociationAlreadyExists":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified association already exists.

    ", + "exception":true + }, + "AssociationComplianceSeverity":{ + "type":"string", + "enum":[ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW", + "UNSPECIFIED" + ] + }, + "AssociationDescription":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The association version.

    " + }, + "Date":{ + "shape":"DateTime", + "documentation":"

    The date when the association was made.

    " + }, + "LastUpdateAssociationDate":{ + "shape":"DateTime", + "documentation":"

    The date when the association was last updated.

    " + }, + "Status":{ + "shape":"AssociationStatus", + "documentation":"

    The association status.

    " + }, + "Overview":{ + "shape":"AssociationOverview", + "documentation":"

    Information about the association.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "AutomationTargetParameterName":{ + "shape":"AutomationTargetParameterName", + "documentation":"

    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    A description of the parameters for a document.

    " + }, + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The instances targeted by the request.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    A cron expression that specifies a schedule when the association runs.

    " + }, + "OutputLocation":{ + "shape":"InstanceAssociationOutputLocation", + "documentation":"

    An Amazon S3 bucket where you want to store the output details of the request.

    " + }, + "LastExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date on which the association was last run.

    " + }, + "LastSuccessfulExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The last date on which the association was successfully run.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    The association name.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    " + }, + "ComplianceSeverity":{ + "shape":"AssociationComplianceSeverity", + "documentation":"

    The severity level that is assigned to the association.

    " + } + }, + "documentation":"

    Describes the parameters for a document.

    " + }, + "AssociationDescriptionList":{ + "type":"list", + "member":{"shape":"AssociationDescription"} + }, + "AssociationDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified association does not exist.

    ", + "exception":true + }, + "AssociationExecution":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The association version.

    " + }, + "ExecutionId":{ + "shape":"AssociationExecutionId", + "documentation":"

    The execution ID for the association.

    " + }, + "Status":{ + "shape":"StatusName", + "documentation":"

    The status of the association execution.

    " + }, + "DetailedStatus":{ + "shape":"StatusName", + "documentation":"

    Detailed status information about the execution.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution started.

    " + }, + "LastExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date of the last execution.

    " + }, + "ResourceCountByStatus":{ + "shape":"ResourceCountByStatus", + "documentation":"

    An aggregate status of the resources in the execution based on the status type.

    " + } + }, + "documentation":"

    Includes information about the specified association.

    " + }, + "AssociationExecutionDoesNotExist":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified execution ID does not exist. Verify the ID number and try again.

    ", + "exception":true + }, + "AssociationExecutionFilter":{ + "type":"structure", + "required":[ + "Key", + "Value", + "Type" + ], + "members":{ + "Key":{ + "shape":"AssociationExecutionFilterKey", + "documentation":"

    The key value used in the request.

    " + }, + "Value":{ + "shape":"AssociationExecutionFilterValue", + "documentation":"

    The value specified for the key.

    " + }, + "Type":{ + "shape":"AssociationFilterOperatorType", + "documentation":"

    The filter type specified in the request.

    " + } + }, + "documentation":"

    Filters used in the request.

    " + }, + "AssociationExecutionFilterKey":{ + "type":"string", + "enum":[ + "ExecutionId", + "Status", + "CreatedTime" + ] + }, + "AssociationExecutionFilterList":{ + "type":"list", + "member":{"shape":"AssociationExecutionFilter"}, + "min":1 + }, + "AssociationExecutionFilterValue":{ + "type":"string", + "min":1 + }, + "AssociationExecutionId":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "AssociationExecutionTarget":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The association version.

    " + }, + "ExecutionId":{ + "shape":"AssociationExecutionId", + "documentation":"

    The execution ID.

    " + }, + "ResourceId":{ + "shape":"AssociationResourceId", + "documentation":"

    The resource ID, for example, the instance ID where the association ran.

    " + }, + "ResourceType":{ + "shape":"AssociationResourceType", + "documentation":"

    The resource type, for example, instance.

    " + }, + "Status":{ + "shape":"StatusName", + "documentation":"

    The association execution status.

    " + }, + "DetailedStatus":{ + "shape":"StatusName", + "documentation":"

    Detailed information about the execution status.

    " + }, + "LastExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date of the last execution.

    " + }, + "OutputSource":{ + "shape":"OutputSource", + "documentation":"

    The location where the association details are saved.

    " + } + }, + "documentation":"

    Includes information about the specified association execution.

    " + }, + "AssociationExecutionTargetsFilter":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"AssociationExecutionTargetsFilterKey", + "documentation":"

    The key value used in the request.

    " + }, + "Value":{ + "shape":"AssociationExecutionTargetsFilterValue", + "documentation":"

    The value specified for the key.

    " + } + }, + "documentation":"

    Filters for the association execution.

    " + }, + "AssociationExecutionTargetsFilterKey":{ + "type":"string", + "enum":[ + "Status", + "ResourceId", + "ResourceType" + ] + }, + "AssociationExecutionTargetsFilterList":{ + "type":"list", + "member":{"shape":"AssociationExecutionTargetsFilter"}, + "min":1 + }, + "AssociationExecutionTargetsFilterValue":{ + "type":"string", + "min":1 + }, + "AssociationExecutionTargetsList":{ + "type":"list", + "member":{"shape":"AssociationExecutionTarget"} + }, + "AssociationExecutionsList":{ + "type":"list", + "member":{"shape":"AssociationExecution"} + }, + "AssociationFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"AssociationFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "value":{ + "shape":"AssociationFilterValue", + "documentation":"

    The filter value.

    " + } + }, + "documentation":"

    Describes a filter.

    " + }, + "AssociationFilterKey":{ + "type":"string", + "enum":[ + "InstanceId", + "Name", + "AssociationId", + "AssociationStatusName", + "LastExecutedBefore", + "LastExecutedAfter", + "AssociationName" + ] + }, + "AssociationFilterList":{ + "type":"list", + "member":{"shape":"AssociationFilter"}, + "min":1 + }, + "AssociationFilterOperatorType":{ + "type":"string", + "enum":[ + "EQUAL", + "LESS_THAN", + "GREATER_THAN" + ] + }, + "AssociationFilterValue":{ + "type":"string", + "min":1 + }, + "AssociationId":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "AssociationIdList":{ + "type":"list", + "member":{"shape":"AssociationId"}, + "max":10, + "min":1 + }, + "AssociationLimitExceeded":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You can have at most 2,000 active associations.

    ", + "exception":true + }, + "AssociationList":{ + "type":"list", + "member":{"shape":"Association"} + }, + "AssociationName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "AssociationOverview":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"StatusName", + "documentation":"

    The status of the association. Status can be: Pending, Success, or Failed.

    " + }, + "DetailedStatus":{ + "shape":"StatusName", + "documentation":"

    A detailed status of the association.

    " + }, + "AssociationStatusAggregatedCount":{ + "shape":"AssociationStatusAggregatedCount", + "documentation":"

    Returns the number of targets for the association status. For example, if you created an association with two instances, and one of them was successful, this would return the count of instances by status.

    " + } + }, + "documentation":"

    Information about the association.

    " + }, + "AssociationResourceId":{ + "type":"string", + "max":100, + "min":1 + }, + "AssociationResourceType":{ + "type":"string", + "max":50, + "min":1 + }, + "AssociationStatus":{ + "type":"structure", + "required":[ + "Date", + "Name", + "Message" + ], + "members":{ + "Date":{ + "shape":"DateTime", + "documentation":"

    The date when the status changed.

    " + }, + "Name":{ + "shape":"AssociationStatusName", + "documentation":"

    The status.

    " + }, + "Message":{ + "shape":"StatusMessage", + "documentation":"

    The reason for the status.

    " + }, + "AdditionalInfo":{ + "shape":"StatusAdditionalInfo", + "documentation":"

    A user-defined string.

    " + } + }, + "documentation":"

    Describes an association status.

    " + }, + "AssociationStatusAggregatedCount":{ + "type":"map", + "key":{"shape":"StatusName"}, + "value":{"shape":"InstanceCount"} + }, + "AssociationStatusName":{ + "type":"string", + "enum":[ + "Pending", + "Success", + "Failed" + ] + }, + "AssociationVersion":{ + "type":"string", + "pattern":"([$]LATEST)|([1-9][0-9]*)" + }, + "AssociationVersionInfo":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The ID created by the system when the association was created.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The association version.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date the association version was created.

    " + }, + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name specified when the association was created.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of a Systems Manager document used when the association version was created.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    Parameters specified when the association version was created.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets specified for the association when the association version was created.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    The cron or rate schedule specified for the association when the association version was created.

    " + }, + "OutputLocation":{ + "shape":"InstanceAssociationOutputLocation", + "documentation":"

    The location in Amazon S3 specified for the association when the association version was created.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    The name specified for the association version when the association version was created.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    " + }, + "ComplianceSeverity":{ + "shape":"AssociationComplianceSeverity", + "documentation":"

    The severity level that is assigned to the association.

    " + } + }, + "documentation":"

    Information about the association version.

    " + }, + "AssociationVersionLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You have reached the maximum number versions allowed for an association. Each association has a limit of 1,000 versions.

    ", + "exception":true + }, + "AssociationVersionList":{ + "type":"list", + "member":{"shape":"AssociationVersionInfo"}, + "min":1 + }, + "AttachmentContent":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"AttachmentName", + "documentation":"

    The name of an attachment.

    " + }, + "Size":{ + "shape":"ContentLength", + "documentation":"

    The size of an attachment in bytes.

    " + }, + "Hash":{ + "shape":"AttachmentHash", + "documentation":"

    The cryptographic hash value of the document content.

    " + }, + "HashType":{ + "shape":"AttachmentHashType", + "documentation":"

    The hash algorithm used to calculate the hash value.

    " + }, + "Url":{ + "shape":"AttachmentUrl", + "documentation":"

    The URL location of the attachment content.

    " + } + }, + "documentation":"

    A structure that includes attributes that describe a document attachment.

    " + }, + "AttachmentContentList":{ + "type":"list", + "member":{"shape":"AttachmentContent"} + }, + "AttachmentHash":{ + "type":"string", + "max":256 + }, + "AttachmentHashType":{ + "type":"string", + "enum":["Sha256"] + }, + "AttachmentInformation":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"AttachmentName", + "documentation":"

    The name of the attachment.

    " + } + }, + "documentation":"

    An attribute of an attachment, such as the attachment name.

    " + }, + "AttachmentInformationList":{ + "type":"list", + "member":{"shape":"AttachmentInformation"} + }, + "AttachmentName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "AttachmentUrl":{"type":"string"}, + "AttachmentsSource":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"AttachmentsSourceKey", + "documentation":"

    The key of a key and value pair that identifies the location of an attachment to a document.

    " + }, + "Values":{ + "shape":"AttachmentsSourceValues", + "documentation":"

    The URL of the location of a document attachment, such as the URL of an Amazon S3 bucket.

    " + } + }, + "documentation":"

    A key and value pair that identifies the location of an attachment to a document.

    " + }, + "AttachmentsSourceKey":{ + "type":"string", + "enum":["SourceUrl"] + }, + "AttachmentsSourceList":{ + "type":"list", + "member":{"shape":"AttachmentsSource"}, + "max":1, + "min":0 + }, + "AttachmentsSourceValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "AttachmentsSourceValues":{ + "type":"list", + "member":{"shape":"AttachmentsSourceValue"}, + "max":1, + "min":1 + }, + "AttributeName":{ + "type":"string", + "max":64, + "min":1 + }, + "AttributeValue":{ + "type":"string", + "max":4096, + "min":0 + }, + "AutomationActionName":{ + "type":"string", + "pattern":"^aws:[a-zA-Z]{3,25}$" + }, + "AutomationDefinitionNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    An Automation document with the specified name could not be found.

    ", + "exception":true + }, + "AutomationDefinitionVersionNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    An Automation document with the specified name and version could not be found.

    ", + "exception":true + }, + "AutomationExecution":{ + "type":"structure", + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The execution ID.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The name of the Automation document used during the execution.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of the document to use during execution.

    " + }, + "ExecutionStartTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution started.

    " + }, + "ExecutionEndTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution finished.

    " + }, + "AutomationExecutionStatus":{ + "shape":"AutomationExecutionStatus", + "documentation":"

    The execution status of the Automation.

    " + }, + "StepExecutions":{ + "shape":"StepExecutionList", + "documentation":"

    A list of details about the current state of all steps that comprise an execution. An Automation document contains a list of steps that are run in order.

    " + }, + "StepExecutionsTruncated":{ + "shape":"Boolean", + "documentation":"

    A boolean value that indicates if the response contains the full list of the Automation step executions. If true, use the DescribeAutomationStepExecutions API action to get the full list of step executions.

    " + }, + "Parameters":{ + "shape":"AutomationParameterMap", + "documentation":"

    The key-value map of execution parameters, which were supplied when calling StartAutomationExecution.

    " + }, + "Outputs":{ + "shape":"AutomationParameterMap", + "documentation":"

    The list of execution outputs as defined in the automation document.

    " + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

    A message describing why an execution has failed, if the status is set to Failed.

    " + }, + "Mode":{ + "shape":"ExecutionMode", + "documentation":"

    The automation execution mode.

    " + }, + "ParentAutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The AutomationExecutionId of the parent automation.

    " + }, + "ExecutedBy":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the user who ran the automation.

    " + }, + "CurrentStepName":{ + "shape":"String", + "documentation":"

    The name of the step that is currently running.

    " + }, + "CurrentAction":{ + "shape":"String", + "documentation":"

    The action of the step that is currently running.

    " + }, + "TargetParameterName":{ + "shape":"AutomationParameterKey", + "documentation":"

    The parameter name.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The specified targets.

    " + }, + "TargetMaps":{ + "shape":"TargetMaps", + "documentation":"

    The specified key-value mapping of document parameters to target resources.

    " + }, + "ResolvedTargets":{ + "shape":"ResolvedTargets", + "documentation":"

    A list of resolved targets in the rate control execution.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The MaxConcurrency value specified by the user when the execution started.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The MaxErrors value specified by the user when the execution started.

    " + }, + "Target":{ + "shape":"String", + "documentation":"

    The target of the execution.

    " + }, + "TargetLocations":{ + "shape":"TargetLocations", + "documentation":"

    The combination of AWS Regions and/or AWS accounts where you want to run the Automation.

    ", + "box":true + }, + "ProgressCounters":{ + "shape":"ProgressCounters", + "documentation":"

    An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

    " + } + }, + "documentation":"

    Detailed information about the current state of an individual Automation execution.

    " + }, + "AutomationExecutionFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"AutomationExecutionFilterKey", + "documentation":"

    One or more keys to limit the results. Valid filter keys include the following: DocumentNamePrefix, ExecutionStatus, ExecutionId, ParentExecutionId, CurrentAction, StartTimeBefore, StartTimeAfter.

    " + }, + "Values":{ + "shape":"AutomationExecutionFilterValueList", + "documentation":"

    The values used to limit the execution information associated with the filter's key.

    " + } + }, + "documentation":"

    A filter used to match specific automation executions. This is used to limit the scope of Automation execution information returned.

    " + }, + "AutomationExecutionFilterKey":{ + "type":"string", + "enum":[ + "DocumentNamePrefix", + "ExecutionStatus", + "ExecutionId", + "ParentExecutionId", + "CurrentAction", + "StartTimeBefore", + "StartTimeAfter", + "AutomationType" + ] + }, + "AutomationExecutionFilterList":{ + "type":"list", + "member":{"shape":"AutomationExecutionFilter"}, + "max":10, + "min":1 + }, + "AutomationExecutionFilterValue":{ + "type":"string", + "max":150, + "min":1 + }, + "AutomationExecutionFilterValueList":{ + "type":"list", + "member":{"shape":"AutomationExecutionFilterValue"}, + "max":10, + "min":1 + }, + "AutomationExecutionId":{ + "type":"string", + "max":36, + "min":36 + }, + "AutomationExecutionLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The number of simultaneously running Automation executions exceeded the allowable limit.

    ", + "exception":true + }, + "AutomationExecutionMetadata":{ + "type":"structure", + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The execution ID.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The name of the Automation document used during execution.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version used during the execution.

    " + }, + "AutomationExecutionStatus":{ + "shape":"AutomationExecutionStatus", + "documentation":"

    The status of the execution. Valid values include: Running, Succeeded, Failed, Timed out, or Cancelled.

    " + }, + "ExecutionStartTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution started.>

    " + }, + "ExecutionEndTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution finished. This is not populated if the execution is still in progress.

    " + }, + "ExecutedBy":{ + "shape":"String", + "documentation":"

    The IAM role ARN of the user who ran the Automation.

    " + }, + "LogFile":{ + "shape":"String", + "documentation":"

    An Amazon S3 bucket where execution information is stored.

    " + }, + "Outputs":{ + "shape":"AutomationParameterMap", + "documentation":"

    The list of execution outputs as defined in the Automation document.

    " + }, + "Mode":{ + "shape":"ExecutionMode", + "documentation":"

    The Automation execution mode.

    " + }, + "ParentAutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The ExecutionId of the parent Automation.

    " + }, + "CurrentStepName":{ + "shape":"String", + "documentation":"

    The name of the step that is currently running.

    " + }, + "CurrentAction":{ + "shape":"String", + "documentation":"

    The action of the step that is currently running.

    " + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

    The list of execution outputs as defined in the Automation document.

    " + }, + "TargetParameterName":{ + "shape":"AutomationParameterKey", + "documentation":"

    The list of execution outputs as defined in the Automation document.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets defined by the user when starting the Automation.

    " + }, + "TargetMaps":{ + "shape":"TargetMaps", + "documentation":"

    The specified key-value mapping of document parameters to target resources.

    " + }, + "ResolvedTargets":{ + "shape":"ResolvedTargets", + "documentation":"

    A list of targets that resolved during the execution.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The MaxConcurrency value specified by the user when starting the Automation.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The MaxErrors value specified by the user when starting the Automation.

    " + }, + "Target":{ + "shape":"String", + "documentation":"

    The list of execution outputs as defined in the Automation document.

    " + }, + "AutomationType":{ + "shape":"AutomationType", + "documentation":"

    Use this filter with DescribeAutomationExecutions. Specify either Local or CrossAccount. CrossAccount is an Automation that runs in multiple AWS Regions and accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

    " + } + }, + "documentation":"

    Details about a specific Automation execution.

    " + }, + "AutomationExecutionMetadataList":{ + "type":"list", + "member":{"shape":"AutomationExecutionMetadata"} + }, + "AutomationExecutionNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    There is no automation execution information for the requested automation execution ID.

    ", + "exception":true + }, + "AutomationExecutionStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Waiting", + "Success", + "TimedOut", + "Cancelling", + "Cancelled", + "Failed" + ] + }, + "AutomationParameterKey":{ + "type":"string", + "max":50, + "min":1 + }, + "AutomationParameterMap":{ + "type":"map", + "key":{"shape":"AutomationParameterKey"}, + "value":{"shape":"AutomationParameterValueList"}, + "max":200, + "min":1 + }, + "AutomationParameterValue":{ + "type":"string", + "max":512, + "min":1 + }, + "AutomationParameterValueList":{ + "type":"list", + "member":{"shape":"AutomationParameterValue"}, + "max":10, + "min":0 + }, + "AutomationStepNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified step name and execution ID don't exist. Verify the information and try again.

    ", + "exception":true + }, + "AutomationTargetParameterName":{ + "type":"string", + "max":50, + "min":1 + }, + "AutomationType":{ + "type":"string", + "enum":[ + "CrossAccount", + "Local" + ] + }, + "BaselineDescription":{ + "type":"string", + "max":1024, + "min":1 + }, + "BaselineId":{ + "type":"string", + "max":128, + "min":20, + "pattern":"^[a-zA-Z0-9_\\-:/]{20,128}$" + }, + "BaselineName":{ + "type":"string", + "max":128, + "min":3, + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "BatchErrorMessage":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "CancelCommandRequest":{ + "type":"structure", + "required":["CommandId"], + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    The ID of the command you want to cancel.

    " + }, + "InstanceIds":{ + "shape":"InstanceIdList", + "documentation":"

    (Optional) A list of instance IDs on which you want to cancel the command. If not provided, the command is canceled on every instance on which it was requested.

    " + } + }, + "documentation":"

    " + }, + "CancelCommandResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Whether or not the command was successfully canceled. There is no guarantee that a request can be canceled.

    " + }, + "CancelMaintenanceWindowExecutionRequest":{ + "type":"structure", + "required":["WindowExecutionId"], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution to stop.

    " + } + } + }, + "CancelMaintenanceWindowExecutionResult":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that has been stopped.

    " + } + } + }, + "ClientToken":{ + "type":"string", + "max":64, + "min":1 + }, + "CloudWatchLogGroupName":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\.\\-_/#A-Za-z0-9]+" + }, + "CloudWatchOutputConfig":{ + "type":"structure", + "members":{ + "CloudWatchLogGroupName":{ + "shape":"CloudWatchLogGroupName", + "documentation":"

    The name of the CloudWatch log group where you want to send command output. If you don't specify a group name, Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/SystemsManagerDocumentName.

    " + }, + "CloudWatchOutputEnabled":{ + "shape":"CloudWatchOutputEnabled", + "documentation":"

    Enables Systems Manager to send command output to CloudWatch Logs.

    " + } + }, + "documentation":"

    Configuration options for sending command output to CloudWatch Logs.

    " + }, + "CloudWatchOutputEnabled":{"type":"boolean"}, + "Command":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    A unique identifier for this command.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The name of the document requested for execution.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The SSM document version.

    " + }, + "Comment":{ + "shape":"Comment", + "documentation":"

    User-specified information about the command, such as a brief description of what the command should do.

    " + }, + "ExpiresAfter":{ + "shape":"DateTime", + "documentation":"

    If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    The parameter values to be inserted in the document when running the command.

    " + }, + "InstanceIds":{ + "shape":"InstanceIdList", + "documentation":"

    The instance IDs against which this command was requested.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

    " + }, + "RequestedDateTime":{ + "shape":"DateTime", + "documentation":"

    The date and time the command was requested.

    " + }, + "Status":{ + "shape":"CommandStatus", + "documentation":"

    The status of the command.

    " + }, + "StatusDetails":{ + "shape":"StatusDetails", + "documentation":"

    A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

    • Pending: The command has not been sent to any instances.

    • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

    • Success: The command successfully ran on all invocations. This is a terminal state.

    • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

    • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

    • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

    • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

    • Canceled: The command was terminated before it was completed. This is a terminal state.

    • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

    " + }, + "OutputS3Region":{ + "shape":"S3Region", + "documentation":"

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

    " + }, + "OutputS3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running Commands Using Systems Manager Run Command in the AWS Systems Manager User Guide.

    " + }, + "TargetCount":{ + "shape":"TargetCount", + "documentation":"

    The number of targets for the command.

    " + }, + "CompletedCount":{ + "shape":"CompletedCount", + "documentation":"

    The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

    " + }, + "ErrorCount":{ + "shape":"ErrorCount", + "documentation":"

    The number of targets for which the status is Failed or Execution Timed Out.

    " + }, + "DeliveryTimedOutCount":{ + "shape":"DeliveryTimedOutCount", + "documentation":"

    The number of targets for which the status is Delivery Timed Out.

    " + }, + "ServiceRole":{ + "shape":"ServiceRole", + "documentation":"

    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

    " + }, + "NotificationConfig":{ + "shape":"NotificationConfig", + "documentation":"

    Configurations for sending notifications about command status changes.

    " + }, + "CloudWatchOutputConfig":{ + "shape":"CloudWatchOutputConfig", + "documentation":"

    CloudWatch Logs information where you want Systems Manager to send the command output.

    " + } + }, + "documentation":"

    Describes a command request.

    " + }, + "CommandFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"CommandFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "value":{ + "shape":"CommandFilterValue", + "documentation":"

    The filter value. Valid values for each filter key are as follows:

    • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions occurring July 7, 2018, and later.

    • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-07-07T00:00:00Z to see a list of command executions from before July 7, 2018.

    • Status: Specify a valid command status to see a list of all command executions with that status. Status values you can specify include:

      • Pending

      • InProgress

      • Success

      • Cancelled

      • Failed

      • TimedOut

      • Cancelling

    • DocumentName: Specify name of the SSM document for which you want to see command execution results. For example, specify AWS-RunPatchBaseline to see command executions that used this SSM document to perform security patching operations on instances.

    • ExecutionStage: Specify one of the following values:

      • Executing: Returns a list of command executions that are currently still running.

      • Complete: Returns a list of command executions that have already completed.

    " + } + }, + "documentation":"

    Describes a command filter.

    " + }, + "CommandFilterKey":{ + "type":"string", + "enum":[ + "InvokedAfter", + "InvokedBefore", + "Status", + "ExecutionStage", + "DocumentName" + ] + }, + "CommandFilterList":{ + "type":"list", + "member":{"shape":"CommandFilter"}, + "max":5, + "min":1 + }, + "CommandFilterValue":{ + "type":"string", + "max":128, + "min":1 + }, + "CommandId":{ + "type":"string", + "max":36, + "min":36 + }, + "CommandInvocation":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    The command against which this invocation was requested.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID in which this invocation was requested.

    " + }, + "InstanceName":{ + "shape":"InstanceTagName", + "documentation":"

    The name of the invocation target. For Amazon EC2 instances this is the value for the aws:Name tag. For on-premises instances, this is the name of the instance.

    " + }, + "Comment":{ + "shape":"Comment", + "documentation":"

    User-specified information about the command, such as a brief description of what the command should do.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The document name that was requested for execution.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The SSM document version.

    " + }, + "RequestedDateTime":{ + "shape":"DateTime", + "documentation":"

    The time and date the request was sent to this instance.

    " + }, + "Status":{ + "shape":"CommandInvocationStatus", + "documentation":"

    Whether or not the invocation succeeded, failed, or is pending.

    " + }, + "StatusDetails":{ + "shape":"StatusDetails", + "documentation":"

    A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

    • Pending: The command has not been sent to the instance.

    • In Progress: The command has been sent to the instance but has not reached a terminal state.

    • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

    • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

    • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

    • Canceled: The command was terminated before it was completed. This is a terminal state.

    • Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

    " + }, + "TraceOutput":{ + "shape":"InvocationTraceOutput", + "documentation":"

    Gets the trace output sent by the agent.

    " + }, + "StandardOutputUrl":{ + "shape":"Url", + "documentation":"

    The URL to the plugin's StdOut file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

    " + }, + "StandardErrorUrl":{ + "shape":"Url", + "documentation":"

    The URL to the plugin's StdErr file in Amazon S3, if the Amazon S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the Amazon S3 bucket was defined for the command.

    " + }, + "CommandPlugins":{"shape":"CommandPluginList"}, + "ServiceRole":{ + "shape":"ServiceRole", + "documentation":"

    The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes on a per instance basis.

    " + }, + "NotificationConfig":{ + "shape":"NotificationConfig", + "documentation":"

    Configurations for sending notifications about command status changes on a per instance basis.

    " + }, + "CloudWatchOutputConfig":{ + "shape":"CloudWatchOutputConfig", + "documentation":"

    CloudWatch Logs information where you want Systems Manager to send the command output.

    " + } + }, + "documentation":"

    An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you ran.

    " + }, + "CommandInvocationList":{ + "type":"list", + "member":{"shape":"CommandInvocation"} + }, + "CommandInvocationStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Delayed", + "Success", + "Cancelled", + "TimedOut", + "Failed", + "Cancelling" + ] + }, + "CommandList":{ + "type":"list", + "member":{"shape":"Command"} + }, + "CommandMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "CommandPlugin":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"CommandPluginName", + "documentation":"

    The name of the plugin. Must be one of the following: aws:updateAgent, aws:domainjoin, aws:applications, aws:runPowerShellScript, aws:psmodule, aws:cloudWatch, aws:runShellScript, or aws:updateSSMAgent.

    " + }, + "Status":{ + "shape":"CommandPluginStatus", + "documentation":"

    The status of this plugin. You can run a document with multiple plugins.

    " + }, + "StatusDetails":{ + "shape":"StatusDetails", + "documentation":"

    A detailed status of the plugin execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

    • Pending: The command has not been sent to the instance.

    • In Progress: The command has been sent to the instance but has not reached a terminal state.

    • Success: The execution of the command or plugin was successfully completed. This is a terminal state.

    • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Execution Timed Out: Command execution started on the instance, but the execution was not complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

    • Failed: The command was not successful on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

    • Canceled: The command was terminated before it was completed. This is a terminal state.

    • Undeliverable: The command can't be delivered to the instance. The instance might not exist, or it might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit, and they don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

    " + }, + "ResponseCode":{ + "shape":"ResponseCode", + "documentation":"

    A numeric response code generated after running the plugin.

    " + }, + "ResponseStartDateTime":{ + "shape":"DateTime", + "documentation":"

    The time the plugin started running.

    " + }, + "ResponseFinishDateTime":{ + "shape":"DateTime", + "documentation":"

    The time the plugin stopped running. Could stop prematurely if, for example, a cancel command was sent.

    " + }, + "Output":{ + "shape":"CommandPluginOutput", + "documentation":"

    Output of the plugin execution.

    " + }, + "StandardOutputUrl":{ + "shape":"Url", + "documentation":"

    The URL for the complete text written by the plugin to stdout in Amazon S3. If the Amazon S3 bucket for the command was not specified, then this string is empty.

    " + }, + "StandardErrorUrl":{ + "shape":"Url", + "documentation":"

    The URL for the complete text written by the plugin to stderr. If execution is not yet complete, then this string is empty.

    " + }, + "OutputS3Region":{ + "shape":"S3Region", + "documentation":"

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

    " + }, + "OutputS3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

    test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

    test_folder is the name of the Amazon S3 bucket;

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    i-1234567876543 is the instance ID;

    awsrunShellScript is the name of the plugin.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command. For example, in the following response:

    test_folder/ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix/i-1234567876543/awsrunShellScript

    test_folder is the name of the Amazon S3 bucket;

    ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix is the name of the S3 prefix;

    i-1234567876543 is the instance ID;

    awsrunShellScript is the name of the plugin.

    " + } + }, + "documentation":"

    Describes plugin details.

    " + }, + "CommandPluginList":{ + "type":"list", + "member":{"shape":"CommandPlugin"} + }, + "CommandPluginName":{ + "type":"string", + "min":4 + }, + "CommandPluginOutput":{ + "type":"string", + "max":2500 + }, + "CommandPluginStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Success", + "TimedOut", + "Cancelled", + "Failed" + ] + }, + "CommandStatus":{ + "type":"string", + "enum":[ + "Pending", + "InProgress", + "Success", + "Cancelled", + "Failed", + "TimedOut", + "Cancelling" + ] + }, + "Comment":{ + "type":"string", + "max":100 + }, + "CompletedCount":{"type":"integer"}, + "ComplianceExecutionId":{ + "type":"string", + "max":100 + }, + "ComplianceExecutionSummary":{ + "type":"structure", + "required":["ExecutionTime"], + "members":{ + "ExecutionTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

    " + }, + "ExecutionId":{ + "shape":"ComplianceExecutionId", + "documentation":"

    An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

    " + }, + "ExecutionType":{ + "shape":"ComplianceExecutionType", + "documentation":"

    The type of execution. For example, Command is a valid execution type.

    " + } + }, + "documentation":"

    A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

    " + }, + "ComplianceExecutionType":{ + "type":"string", + "max":50 + }, + "ComplianceFilterValue":{"type":"string"}, + "ComplianceItem":{ + "type":"structure", + "members":{ + "ComplianceType":{ + "shape":"ComplianceTypeName", + "documentation":"

    The compliance type. For example, Association (for a State Manager association), Patch, or Custom:string are all valid compliance types.

    " + }, + "ResourceType":{ + "shape":"ComplianceResourceType", + "documentation":"

    The type of resource. ManagedInstance is currently the only supported resource type.

    " + }, + "ResourceId":{ + "shape":"ComplianceResourceId", + "documentation":"

    An ID for the resource. For a managed instance, this is the instance ID.

    " + }, + "Id":{ + "shape":"ComplianceItemId", + "documentation":"

    An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.

    " + }, + "Title":{ + "shape":"ComplianceItemTitle", + "documentation":"

    A title for the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

    " + }, + "Status":{ + "shape":"ComplianceStatus", + "documentation":"

    The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

    " + }, + "Severity":{ + "shape":"ComplianceSeverity", + "documentation":"

    The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

    " + }, + "ExecutionSummary":{ + "shape":"ComplianceExecutionSummary", + "documentation":"

    A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.

    " + }, + "Details":{ + "shape":"ComplianceItemDetails", + "documentation":"

    A \"Key\": \"Value\" tag combination for the compliance item.

    " + } + }, + "documentation":"

    Information about the compliance as defined by the resource type. For example, for a patch resource type, Items includes information about the PatchSeverity, Classification, etc.

    " + }, + "ComplianceItemContentHash":{ + "type":"string", + "max":256 + }, + "ComplianceItemDetails":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "ComplianceItemEntry":{ + "type":"structure", + "required":[ + "Severity", + "Status" + ], + "members":{ + "Id":{ + "shape":"ComplianceItemId", + "documentation":"

    The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

    " + }, + "Title":{ + "shape":"ComplianceItemTitle", + "documentation":"

    The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

    " + }, + "Severity":{ + "shape":"ComplianceSeverity", + "documentation":"

    The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

    " + }, + "Status":{ + "shape":"ComplianceStatus", + "documentation":"

    The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

    " + }, + "Details":{ + "shape":"ComplianceItemDetails", + "documentation":"

    A \"Key\": \"Value\" tag combination for the compliance item.

    " + } + }, + "documentation":"

    Information about a compliance item.

    " + }, + "ComplianceItemEntryList":{ + "type":"list", + "member":{"shape":"ComplianceItemEntry"}, + "max":10000, + "min":0 + }, + "ComplianceItemId":{ + "type":"string", + "max":100, + "min":1 + }, + "ComplianceItemList":{ + "type":"list", + "member":{"shape":"ComplianceItem"} + }, + "ComplianceItemTitle":{ + "type":"string", + "max":500 + }, + "ComplianceQueryOperatorType":{ + "type":"string", + "enum":[ + "EQUAL", + "NOT_EQUAL", + "BEGIN_WITH", + "LESS_THAN", + "GREATER_THAN" + ] + }, + "ComplianceResourceId":{ + "type":"string", + "max":100, + "min":1 + }, + "ComplianceResourceIdList":{ + "type":"list", + "member":{"shape":"ComplianceResourceId"}, + "min":1 + }, + "ComplianceResourceType":{ + "type":"string", + "max":50, + "min":1 + }, + "ComplianceResourceTypeList":{ + "type":"list", + "member":{"shape":"ComplianceResourceType"}, + "min":1 + }, + "ComplianceSeverity":{ + "type":"string", + "enum":[ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW", + "INFORMATIONAL", + "UNSPECIFIED" + ] + }, + "ComplianceStatus":{ + "type":"string", + "enum":[ + "COMPLIANT", + "NON_COMPLIANT" + ] + }, + "ComplianceStringFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"ComplianceStringFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Values":{ + "shape":"ComplianceStringFilterValueList", + "documentation":"

    The value for which to search.

    " + }, + "Type":{ + "shape":"ComplianceQueryOperatorType", + "documentation":"

    The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

    " + } + }, + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "ComplianceStringFilterKey":{ + "type":"string", + "max":200, + "min":1 + }, + "ComplianceStringFilterList":{ + "type":"list", + "member":{"shape":"ComplianceStringFilter"} + }, + "ComplianceStringFilterValueList":{ + "type":"list", + "member":{"shape":"ComplianceFilterValue"}, + "max":20, + "min":1 + }, + "ComplianceSummaryCount":{"type":"integer"}, + "ComplianceSummaryItem":{ + "type":"structure", + "members":{ + "ComplianceType":{ + "shape":"ComplianceTypeName", + "documentation":"

    The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

    " + }, + "CompliantSummary":{ + "shape":"CompliantSummary", + "documentation":"

    A list of COMPLIANT items for the specified compliance type.

    " + }, + "NonCompliantSummary":{ + "shape":"NonCompliantSummary", + "documentation":"

    A list of NON_COMPLIANT items for the specified compliance type.

    " + } + }, + "documentation":"

    A summary of compliance information by compliance type.

    " + }, + "ComplianceSummaryItemList":{ + "type":"list", + "member":{"shape":"ComplianceSummaryItem"} + }, + "ComplianceTypeCountLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You specified too many custom compliance types. You can specify a maximum of 10 different types.

    ", + "exception":true + }, + "ComplianceTypeName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"[A-Za-z0-9_\\-]\\w+|Custom:[a-zA-Z0-9_\\-]\\w+" + }, + "CompliantSummary":{ + "type":"structure", + "members":{ + "CompliantCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources that are compliant.

    " + }, + "SeveritySummary":{ + "shape":"SeveritySummary", + "documentation":"

    A summary of the compliance severity by compliance type.

    " + } + }, + "documentation":"

    A summary of resources that are compliant. The summary is organized according to the resource count for each compliance type.

    " + }, + "ComputerName":{ + "type":"string", + "max":255, + "min":1 + }, + "ConnectionStatus":{ + "type":"string", + "enum":[ + "Connected", + "NotConnected" + ] + }, + "ContentLength":{"type":"long"}, + "CreateActivationRequest":{ + "type":"structure", + "required":["IamRole"], + "members":{ + "Description":{ + "shape":"ActivationDescription", + "documentation":"

    A user-defined description of the resource that you want to register with Amazon EC2.

    Do not enter personally identifiable information in this field.

    " + }, + "DefaultInstanceName":{ + "shape":"DefaultInstanceName", + "documentation":"

    The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources.

    Do not enter personally identifiable information in this field.

    " + }, + "IamRole":{ + "shape":"IamRole", + "documentation":"

    The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

    " + }, + "RegistrationLimit":{ + "shape":"RegistrationLimit", + "documentation":"

    Specify the maximum number of managed instances you want to register. The default value is 1 instance.

    ", + "box":true + }, + "ExpirationDate":{ + "shape":"ExpirationDate", + "documentation":"

    The date by which this activation request should expire. The default value is 24 hours.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key name/value pairs:

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

    You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers and VMs after they connect to Systems Manager for the first time and are assigned a managed instance ID. This means they are listed in the AWS Systems Manager console with an ID that is prefixed with \"mi-\". For information about how to add tags to your managed instances, see AddTagsToResource. For information about how to remove tags from your managed instances, see RemoveTagsFromResource.

    " + } + } + }, + "CreateActivationResult":{ + "type":"structure", + "members":{ + "ActivationId":{ + "shape":"ActivationId", + "documentation":"

    The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

    " + }, + "ActivationCode":{ + "shape":"ActivationCode", + "documentation":"

    The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

    " + } + } + }, + "CreateAssociationBatchRequest":{ + "type":"structure", + "required":["Entries"], + "members":{ + "Entries":{ + "shape":"CreateAssociationBatchRequestEntries", + "documentation":"

    One or more associations.

    " + } + } + }, + "CreateAssociationBatchRequestEntries":{ + "type":"list", + "member":{"shape":"CreateAssociationBatchRequestEntry"}, + "min":1 + }, + "CreateAssociationBatchRequestEntry":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

    You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

    For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

    arn:aws:ssm:region:account-id:document/document-name

    For example:

    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

    For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    A description of the parameters for a document.

    " + }, + "AutomationTargetParameterName":{ + "shape":"AutomationTargetParameterName", + "documentation":"

    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The instances targeted by the request.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    A cron expression that specifies a schedule when the association runs.

    " + }, + "OutputLocation":{ + "shape":"InstanceAssociationOutputLocation", + "documentation":"

    An Amazon S3 bucket where you want to store the results of this request.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    Specify a descriptive name for the association.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    " + }, + "ComplianceSeverity":{ + "shape":"AssociationComplianceSeverity", + "documentation":"

    The severity level to assign to the association.

    " + } + }, + "documentation":"

    Describes the association of a Systems Manager SSM document and an instance.

    " + }, + "CreateAssociationBatchResult":{ + "type":"structure", + "members":{ + "Successful":{ + "shape":"AssociationDescriptionList", + "documentation":"

    Information about the associations that succeeded.

    " + }, + "Failed":{ + "shape":"FailedCreateAssociationList", + "documentation":"

    Information about the associations that failed.

    " + } + } + }, + "CreateAssociationRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

    You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

    For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

    arn:partition:ssm:region:account-id:document/document-name

    For example:

    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

    For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version you want to associate with the target(s). Can be a specific version or the default version.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID.

    InstanceId has been deprecated. To specify an instance ID for an association, use the Targets parameter. If you use the parameter InstanceId, you cannot use the parameters AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation, or ScheduleExpression. To use these parameters, you must use the Targets parameter.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    The parameters for the runtime configuration of the document.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets (either instances or tags) for the association. You must specify a value for Targets if you don't specify a value for InstanceId.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    A cron expression when the association will be applied to the target(s).

    " + }, + "OutputLocation":{ + "shape":"InstanceAssociationOutputLocation", + "documentation":"

    An Amazon S3 bucket where you want to store the output details of the request.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    Specify a descriptive name for the association.

    " + }, + "AutomationTargetParameterName":{ + "shape":"AutomationTargetParameterName", + "documentation":"

    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    " + }, + "ComplianceSeverity":{ + "shape":"AssociationComplianceSeverity", + "documentation":"

    The severity level to assign to the association.

    " + } + } + }, + "CreateAssociationResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{ + "shape":"AssociationDescription", + "documentation":"

    Information about the association.

    " + } + } + }, + "CreateDocumentRequest":{ + "type":"structure", + "required":[ + "Content", + "Name" + ], + "members":{ + "Content":{ + "shape":"DocumentContent", + "documentation":"

    A valid JSON or YAML string.

    " + }, + "Attachments":{ + "shape":"AttachmentsSourceList", + "documentation":"

    A list of key and value pairs that describe attachments to a version of a document.

    " + }, + "Name":{ + "shape":"DocumentName", + "documentation":"

    A name for the Systems Manager document.

    Do not use the following to begin the names of documents you create. They are reserved by AWS for use as document prefixes:

    • aws

    • amazon

    • amzn

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    An optional field specifying the version of the artifact you are creating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "DocumentType":{ + "shape":"DocumentType", + "documentation":"

    The type of document to create. Valid document types include: Command, Policy, Automation, Session, and Package.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    Specify the document format for the request. The document format can be either JSON or YAML. JSON is the default format.

    " + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"

    Specify a target type to define the kinds of resources the document can run on. For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance. If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an SSM document to identify the types of targets or the environment where it will run. In this case, you could specify the following key name/value pairs:

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    To add tags to an existing SSM document, use the AddTagsToResource action.

    " + } + } + }, + "CreateDocumentResult":{ + "type":"structure", + "members":{ + "DocumentDescription":{ + "shape":"DocumentDescription", + "documentation":"

    Information about the Systems Manager document.

    " + } + } + }, + "CreateMaintenanceWindowRequest":{ + "type":"structure", + "required":[ + "Name", + "Schedule", + "Duration", + "Cutoff", + "AllowUnassociatedTargets" + ], + "members":{ + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

    " + }, + "StartDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

    " + }, + "EndDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    " + }, + "Schedule":{ + "shape":"MaintenanceWindowSchedule", + "documentation":"

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + }, + "ScheduleTimezone":{ + "shape":"MaintenanceWindowTimezone", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.

    " + }, + "Duration":{ + "shape":"MaintenanceWindowDurationHours", + "documentation":"

    The duration of the maintenance window in hours.

    " + }, + "Cutoff":{ + "shape":"MaintenanceWindowCutoff", + "documentation":"

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

    " + }, + "AllowUnassociatedTargets":{ + "shape":"MaintenanceWindowAllowUnassociatedTargets", + "documentation":"

    Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets. If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

    If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    User-provided idempotency token.

    ", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in. In this case, you could specify the following key name/value pairs:

    • Key=TaskType,Value=AgentUpdate

    • Key=OS,Value=Windows

    • Key=Environment,Value=Production

    To add tags to an existing maintenance window, use the AddTagsToResource action.

    " + } + } + }, + "CreateMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the created maintenance window.

    " + } + } + }, + "CreateOpsItemRequest":{ + "type":"structure", + "required":[ + "Description", + "Source", + "Title" + ], + "members":{ + "Description":{ + "shape":"OpsItemDescription", + "documentation":"

    Information about the OpsItem.

    " + }, + "OperationalData":{ + "shape":"OpsItemOperationalData", + "documentation":"

    Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

    Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

    You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

    Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

    " + }, + "Notifications":{ + "shape":"OpsItemNotifications", + "documentation":"

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    " + }, + "Priority":{ + "shape":"OpsItemPriority", + "documentation":"

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + }, + "RelatedOpsItems":{ + "shape":"RelatedOpsItems", + "documentation":"

    One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    " + }, + "Source":{ + "shape":"OpsItemSource", + "documentation":"

    The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.

    " + }, + "Title":{ + "shape":"OpsItemTitle", + "documentation":"

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

    Tags use a key-value pair. For example:

    Key=Department,Value=Finance

    To add tags to an existing OpsItem, use the AddTagsToResource action.

    " + } + } + }, + "CreateOpsItemResponse":{ + "type":"structure", + "members":{ + "OpsItemId":{ + "shape":"String", + "documentation":"

    The ID of the OpsItem.

    " + } + } + }, + "CreatePatchBaselineRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

    " + }, + "Name":{ + "shape":"BaselineName", + "documentation":"

    The name of the patch baseline.

    " + }, + "GlobalFilters":{ + "shape":"PatchFilterGroup", + "documentation":"

    A set of global filters used to include patches in the baseline.

    " + }, + "ApprovalRules":{ + "shape":"PatchRuleGroup", + "documentation":"

    A set of rules used to include patches in the baseline.

    " + }, + "ApprovedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly approved patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    " + }, + "ApprovedPatchesComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.

    " + }, + "ApprovedPatchesEnableNonSecurity":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

    ", + "box":true + }, + "RejectedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly rejected patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    " + }, + "RejectedPatchesAction":{ + "shape":"PatchAction", + "documentation":"

    The action for Patch Manager to take on patches included in the RejectedPackages list.

    • ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.

    • BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

    " + }, + "Description":{ + "shape":"BaselineDescription", + "documentation":"

    A description of the patch baseline.

    " + }, + "Sources":{ + "shape":"PatchSourceList", + "documentation":"

    Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    User-provided idempotency token.

    ", + "idempotencyToken":true + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a patch baseline to identify the severity level of patches it specifies and the operating system family it applies to. In this case, you could specify the following key name/value pairs:

    • Key=PatchSeverity,Value=Critical

    • Key=OS,Value=Windows

    To add tags to an existing patch baseline, use the AddTagsToResource action.

    " + } + } + }, + "CreatePatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the created patch baseline.

    " + } + } + }, + "CreateResourceDataSyncRequest":{ + "type":"structure", + "required":[ + "SyncName", + "S3Destination" + ], + "members":{ + "SyncName":{ + "shape":"ResourceDataSyncName", + "documentation":"

    A name for the configuration.

    " + }, + "S3Destination":{ + "shape":"ResourceDataSyncS3Destination", + "documentation":"

    Amazon S3 configuration details for the sync.

    " + } + } + }, + "CreateResourceDataSyncResult":{ + "type":"structure", + "members":{ + } + }, + "CreatedDate":{"type":"timestamp"}, + "CustomSchemaCountLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You have exceeded the limit for custom schemas. Delete one or more custom schemas and try again.

    ", + "exception":true + }, + "DateTime":{"type":"timestamp"}, + "DefaultBaseline":{"type":"boolean"}, + "DefaultInstanceName":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "DeleteActivationRequest":{ + "type":"structure", + "required":["ActivationId"], + "members":{ + "ActivationId":{ + "shape":"ActivationId", + "documentation":"

    The ID of the activation that you want to delete.

    " + } + } + }, + "DeleteActivationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteAssociationRequest":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID that you want to delete.

    " + } + } + }, + "DeleteAssociationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of the document that you want to delete. If not provided, all versions of the document are deleted.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

    " + } + } + }, + "DeleteDocumentResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteInventoryRequest":{ + "type":"structure", + "required":["TypeName"], + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the custom inventory type for which you want to delete either all previously collected data, or the inventory type itself.

    " + }, + "SchemaDeleteOption":{ + "shape":"InventorySchemaDeleteOption", + "documentation":"

    Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

    DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

    DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

    " + }, + "DryRun":{ + "shape":"DryRun", + "documentation":"

    Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    User-provided idempotency token.

    ", + "idempotencyToken":true + } + } + }, + "DeleteInventoryResult":{ + "type":"structure", + "members":{ + "DeletionId":{ + "shape":"InventoryDeletionId", + "documentation":"

    Every DeleteInventory action is assigned a unique ID. This option returns a unique ID. You can use this ID to query the status of a delete operation. This option is useful for ensuring that a delete operation has completed before you begin other actions.

    " + }, + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the inventory data type specified in the request.

    " + }, + "DeletionSummary":{ + "shape":"InventoryDeletionSummary", + "documentation":"

    A summary of the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.

    " + } + } + }, + "DeleteMaintenanceWindowRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window to delete.

    " + } + } + }, + "DeleteMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the deleted maintenance window.

    " + } + } + }, + "DeleteParameterRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The name of the parameter to delete.

    " + } + } + }, + "DeleteParameterResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteParametersRequest":{ + "type":"structure", + "required":["Names"], + "members":{ + "Names":{ + "shape":"ParameterNameList", + "documentation":"

    The names of the parameters to delete.

    " + } + } + }, + "DeleteParametersResult":{ + "type":"structure", + "members":{ + "DeletedParameters":{ + "shape":"ParameterNameList", + "documentation":"

    The names of the deleted parameters.

    " + }, + "InvalidParameters":{ + "shape":"ParameterNameList", + "documentation":"

    The names of parameters that weren't deleted because the parameters are not valid.

    " + } + } + }, + "DeletePatchBaselineRequest":{ + "type":"structure", + "required":["BaselineId"], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to delete.

    " + } + } + }, + "DeletePatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the deleted patch baseline.

    " + } + } + }, + "DeleteResourceDataSyncRequest":{ + "type":"structure", + "required":["SyncName"], + "members":{ + "SyncName":{ + "shape":"ResourceDataSyncName", + "documentation":"

    The name of the configuration to delete.

    " + } + } + }, + "DeleteResourceDataSyncResult":{ + "type":"structure", + "members":{ + } + }, + "DeliveryTimedOutCount":{"type":"integer"}, + "DeregisterManagedInstanceRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"ManagedInstanceId", + "documentation":"

    The ID assigned to the managed instance when you registered it using the activation process.

    " + } + } + }, + "DeregisterManagedInstanceResult":{ + "type":"structure", + "members":{ + } + }, + "DeregisterPatchBaselineForPatchGroupRequest":{ + "type":"structure", + "required":[ + "BaselineId", + "PatchGroup" + ], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to deregister the patch group from.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group that should be deregistered from the patch baseline.

    " + } + } + }, + "DeregisterPatchBaselineForPatchGroupResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline the patch group was deregistered from.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group deregistered from the patch baseline.

    " + } + } + }, + "DeregisterTargetFromMaintenanceWindowRequest":{ + "type":"structure", + "required":[ + "WindowId", + "WindowTargetId" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the target should be removed from.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The ID of the target definition to remove.

    " + }, + "Safe":{ + "shape":"Boolean", + "documentation":"

    The system checks if the target is being referenced by a task. If the target is being referenced, the system returns an error and does not deregister the target from the maintenance window.

    ", + "box":true + } + } + }, + "DeregisterTargetFromMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the target was removed from.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The ID of the removed target definition.

    " + } + } + }, + "DeregisterTaskFromMaintenanceWindowRequest":{ + "type":"structure", + "required":[ + "WindowId", + "WindowTaskId" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the task should be removed from.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The ID of the task to remove from the maintenance window.

    " + } + } + }, + "DeregisterTaskFromMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the task was removed from.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The ID of the task removed from the maintenance window.

    " + } + } + }, + "DescribeActivationsFilter":{ + "type":"structure", + "members":{ + "FilterKey":{ + "shape":"DescribeActivationsFilterKeys", + "documentation":"

    The name of the filter.

    " + }, + "FilterValues":{ + "shape":"StringList", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Filter for the DescribeActivation API.

    " + }, + "DescribeActivationsFilterKeys":{ + "type":"string", + "enum":[ + "ActivationIds", + "DefaultInstanceName", + "IamRole" + ] + }, + "DescribeActivationsFilterList":{ + "type":"list", + "member":{"shape":"DescribeActivationsFilter"} + }, + "DescribeActivationsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"DescribeActivationsFilterList", + "documentation":"

    A filter to view information about your activations.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "DescribeActivationsResult":{ + "type":"structure", + "members":{ + "ActivationList":{ + "shape":"ActivationList", + "documentation":"

    A list of activations for your AWS account.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "DescribeAssociationExecutionTargetsRequest":{ + "type":"structure", + "required":[ + "AssociationId", + "ExecutionId" + ], + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID that includes the execution for which you want to view details.

    " + }, + "ExecutionId":{ + "shape":"AssociationExecutionId", + "documentation":"

    The execution ID for which you want to view details.

    " + }, + "Filters":{ + "shape":"AssociationExecutionTargetsFilterList", + "documentation":"

    Filters for the request. You can specify the following filters and values.

    Status (EQUAL)

    ResourceId (EQUAL)

    ResourceType (EQUAL)

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "DescribeAssociationExecutionTargetsResult":{ + "type":"structure", + "members":{ + "AssociationExecutionTargets":{ + "shape":"AssociationExecutionTargetsList", + "documentation":"

    Information about the execution.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "DescribeAssociationExecutionsRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID for which you want to view execution history details.

    " + }, + "Filters":{ + "shape":"AssociationExecutionFilterList", + "documentation":"

    Filters for the request. You can specify the following filters and values.

    ExecutionId (EQUAL)

    Status (EQUAL)

    CreatedTime (EQUAL, GREATER_THAN, LESS_THAN)

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "DescribeAssociationExecutionsResult":{ + "type":"structure", + "members":{ + "AssociationExecutions":{ + "shape":"AssociationExecutionsList", + "documentation":"

    A list of the executions for the specified association ID.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "DescribeAssociationRequest":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID.

    " + }, + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID for which you want information.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    Specify the association version to retrieve. To view the latest version, either specify $LATEST for this parameter, or omit this parameter. To view a list of all associations for an instance, use ListAssociations. To get a list of versions for a specific association, use ListAssociationVersions.

    " + } + } + }, + "DescribeAssociationResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{ + "shape":"AssociationDescription", + "documentation":"

    Information about the association.

    " + } + } + }, + "DescribeAutomationExecutionsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"AutomationExecutionFilterList", + "documentation":"

    Filters used to limit the scope of executions that are requested.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeAutomationExecutionsResult":{ + "type":"structure", + "members":{ + "AutomationExecutionMetadataList":{ + "shape":"AutomationExecutionMetadataList", + "documentation":"

    The list of details about each automation execution which has occurred which matches the filter specification, if any.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeAutomationStepExecutionsRequest":{ + "type":"structure", + "required":["AutomationExecutionId"], + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The Automation execution ID for which you want step execution descriptions.

    " + }, + "Filters":{ + "shape":"StepExecutionFilterList", + "documentation":"

    One or more filters to limit the number of step executions returned by the request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "ReverseOrder":{ + "shape":"Boolean", + "documentation":"

    A boolean that indicates whether to list step executions in reverse order by start time. The default value is false.

    ", + "box":true + } + } + }, + "DescribeAutomationStepExecutionsResult":{ + "type":"structure", + "members":{ + "StepExecutions":{ + "shape":"StepExecutionList", + "documentation":"

    A list of details about the current state of all steps that make up an execution.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeAvailablePatchesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"PatchOrchestratorFilterList", + "documentation":"

    Filters used to scope down the returned patches.

    " + }, + "MaxResults":{ + "shape":"PatchBaselineMaxResults", + "documentation":"

    The maximum number of patches to return (per page).

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeAvailablePatchesResult":{ + "type":"structure", + "members":{ + "Patches":{ + "shape":"PatchList", + "documentation":"

    An array of patches. Each entry in the array is a patch structure.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeDocumentPermissionRequest":{ + "type":"structure", + "required":[ + "Name", + "PermissionType" + ], + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document for which you are the owner.

    " + }, + "PermissionType":{ + "shape":"DocumentPermissionType", + "documentation":"

    The permission type for the document. The permission type can be Share.

    " + } + } + }, + "DescribeDocumentPermissionResponse":{ + "type":"structure", + "members":{ + "AccountIds":{ + "shape":"AccountIdList", + "documentation":"

    The account IDs that have permission to use this document. The ID can be either an AWS account or All.

    " + } + } + }, + "DescribeDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version for which you want information. Can be a specific version or the default version.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + } + } + }, + "DescribeDocumentResult":{ + "type":"structure", + "members":{ + "Document":{ + "shape":"DocumentDescription", + "documentation":"

    Information about the Systems Manager document.

    " + } + } + }, + "DescribeEffectiveInstanceAssociationsRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID for which you want to view all associations.

    " + }, + "MaxResults":{ + "shape":"EffectiveInstanceAssociationMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeEffectiveInstanceAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"InstanceAssociationList", + "documentation":"

    The associations for the requested instance.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeEffectivePatchesForPatchBaselineRequest":{ + "type":"structure", + "required":["BaselineId"], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to retrieve the effective patches for.

    " + }, + "MaxResults":{ + "shape":"PatchBaselineMaxResults", + "documentation":"

    The maximum number of patches to return (per page).

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeEffectivePatchesForPatchBaselineResult":{ + "type":"structure", + "members":{ + "EffectivePatches":{ + "shape":"EffectivePatchList", + "documentation":"

    An array of patches and patch status.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInstanceAssociationsStatusRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance IDs for which you want association status information.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeInstanceAssociationsStatusResult":{ + "type":"structure", + "members":{ + "InstanceAssociationStatusInfos":{ + "shape":"InstanceAssociationStatusInfos", + "documentation":"

    Status information about the association.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInstanceInformationRequest":{ + "type":"structure", + "members":{ + "InstanceInformationFilterList":{ + "shape":"InstanceInformationFilterList", + "documentation":"

    This is a legacy method. We recommend that you don't use this method. Instead, use the InstanceInformationFilter action. The InstanceInformationFilter action enables you to return instance information by using tags that are specified as a key-value mapping.

    If you do use this method, then you can't use the InstanceInformationFilter action. Using this method and the InstanceInformationFilter action causes an exception error.

    " + }, + "Filters":{ + "shape":"InstanceInformationStringFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of instances. You can filter on Amazon EC2 tag. Specify tags by using a key-value mapping.

    " + }, + "MaxResults":{ + "shape":"MaxResultsEC2Compatible", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeInstanceInformationResult":{ + "type":"structure", + "members":{ + "InstanceInformationList":{ + "shape":"InstanceInformationList", + "documentation":"

    The instance information list.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInstancePatchStatesForPatchGroupRequest":{ + "type":"structure", + "required":["PatchGroup"], + "members":{ + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group for which the patch state information should be retrieved.

    " + }, + "Filters":{ + "shape":"InstancePatchStateFilterList", + "documentation":"

    Each entry in the array is a structure containing:

    Key (string between 1 and 200 characters)

    Values (array containing a single string)

    Type (string \"Equal\", \"NotEqual\", \"LessThan\", \"GreaterThan\")

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"PatchComplianceMaxResults", + "documentation":"

    The maximum number of patches to return (per page).

    ", + "box":true + } + } + }, + "DescribeInstancePatchStatesForPatchGroupResult":{ + "type":"structure", + "members":{ + "InstancePatchStates":{ + "shape":"InstancePatchStatesList", + "documentation":"

    The high-level patch state for the requested instances.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInstancePatchStatesRequest":{ + "type":"structure", + "required":["InstanceIds"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdList", + "documentation":"

    The ID of the instance whose patch state information should be retrieved.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"PatchComplianceMaxResults", + "documentation":"

    The maximum number of instances to return (per page).

    ", + "box":true + } + } + }, + "DescribeInstancePatchStatesResult":{ + "type":"structure", + "members":{ + "InstancePatchStates":{ + "shape":"InstancePatchStateList", + "documentation":"

    The high-level patch state for the requested instances.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInstancePatchesRequest":{ + "type":"structure", + "required":["InstanceId"], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance whose patch state information should be retrieved.

    " + }, + "Filters":{ + "shape":"PatchOrchestratorFilterList", + "documentation":"

    An array of structures. Each entry in the array is a structure containing a Key, Value combination. Valid values for Key are Classification | KBId | Severity | State.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"PatchComplianceMaxResults", + "documentation":"

    The maximum number of patches to return (per page).

    ", + "box":true + } + } + }, + "DescribeInstancePatchesResult":{ + "type":"structure", + "members":{ + "Patches":{ + "shape":"PatchComplianceDataList", + "documentation":"

    Each entry in the array is a structure containing:

    Title (string)

    KBId (string)

    Classification (string)

    Severity (string)

    State (string, such as \"INSTALLED\" or \"FAILED\")

    InstalledTime (DateTime)

    InstalledBy (string)

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeInventoryDeletionsRequest":{ + "type":"structure", + "members":{ + "DeletionId":{ + "shape":"InventoryDeletionId", + "documentation":"

    Specify the delete inventory ID for which you want information. This ID was returned by the DeleteInventory action.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "DescribeInventoryDeletionsResult":{ + "type":"structure", + "members":{ + "InventoryDeletions":{ + "shape":"InventoryDeletionsList", + "documentation":"

    A list of status items for deleted inventory.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "DescribeMaintenanceWindowExecutionTaskInvocationsRequest":{ + "type":"structure", + "required":[ + "WindowExecutionId", + "TaskId" + ], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution the task is part of.

    " + }, + "TaskId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task in the maintenance window task that should be retrieved.

    " + }, + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Optional filters used to scope down the returned task invocations. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowExecutionTaskInvocationsResult":{ + "type":"structure", + "members":{ + "WindowExecutionTaskInvocationIdentities":{ + "shape":"MaintenanceWindowExecutionTaskInvocationIdentityList", + "documentation":"

    Information about the task invocation results per invocation.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeMaintenanceWindowExecutionTasksRequest":{ + "type":"structure", + "required":["WindowExecutionId"], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution whose task executions should be retrieved.

    " + }, + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Optional filters used to scope down the returned tasks. The supported filter key is STATUS with the corresponding values PENDING, IN_PROGRESS, SUCCESS, FAILED, TIMED_OUT, CANCELLING, and CANCELLED.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowExecutionTasksResult":{ + "type":"structure", + "members":{ + "WindowExecutionTaskIdentities":{ + "shape":"MaintenanceWindowExecutionTaskIdentityList", + "documentation":"

    Information about the task executions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeMaintenanceWindowExecutionsRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window whose executions should be retrieved.

    " + }, + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Each entry in the array is a structure containing:

    Key (string, between 1 and 128 characters)

    Values (array of strings, each string is between 1 and 256 characters)

    The supported Keys are ExecutedBefore and ExecutedAfter with the value being a date/time string such as 2016-11-04T05:00:00Z.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowExecutionsResult":{ + "type":"structure", + "members":{ + "WindowExecutions":{ + "shape":"MaintenanceWindowExecutionList", + "documentation":"

    Information about the maintenance window executions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeMaintenanceWindowScheduleRequest":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window to retrieve information about.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The instance ID or key/value pair to retrieve information about.

    " + }, + "ResourceType":{ + "shape":"MaintenanceWindowResourceType", + "documentation":"

    The type of resource you want to retrieve information about. For example, \"INSTANCE\".

    " + }, + "Filters":{ + "shape":"PatchOrchestratorFilterList", + "documentation":"

    Filters used to limit the range of results. For example, you can limit maintenance window executions to only those scheduled before or after a certain date and time.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowSearchMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowScheduleResult":{ + "type":"structure", + "members":{ + "ScheduledWindowExecutions":{ + "shape":"ScheduledWindowExecutionList", + "documentation":"

    Information about maintenance window executions scheduled for the specified time range.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You use this token in the next call.)

    " + } + } + }, + "DescribeMaintenanceWindowTargetsRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window whose targets should be retrieved.

    " + }, + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Optional filters that can be used to narrow down the scope of the returned window targets. The supported filter keys are Type, WindowTargetId and OwnerInformation.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowTargetsResult":{ + "type":"structure", + "members":{ + "Targets":{ + "shape":"MaintenanceWindowTargetList", + "documentation":"

    Information about the targets in the maintenance window.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeMaintenanceWindowTasksRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window whose tasks should be retrieved.

    " + }, + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Optional filters used to narrow down the scope of the returned tasks. The supported filter keys are WindowTaskId, TaskArn, Priority, and TaskType.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowTasksResult":{ + "type":"structure", + "members":{ + "Tasks":{ + "shape":"MaintenanceWindowTaskList", + "documentation":"

    Information about the tasks in the maintenance window.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeMaintenanceWindowsForTargetRequest":{ + "type":"structure", + "required":[ + "Targets", + "ResourceType" + ], + "members":{ + "Targets":{ + "shape":"Targets", + "documentation":"

    The instance ID or key/value pair to retrieve information about.

    " + }, + "ResourceType":{ + "shape":"MaintenanceWindowResourceType", + "documentation":"

    The type of resource you want to retrieve information about. For example, \"INSTANCE\".

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowSearchMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowsForTargetResult":{ + "type":"structure", + "members":{ + "WindowIdentities":{ + "shape":"MaintenanceWindowsForTargetList", + "documentation":"

    Information about the maintenance window targets and tasks an instance is associated with.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You use this token in the next call.)

    " + } + } + }, + "DescribeMaintenanceWindowsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"MaintenanceWindowFilterList", + "documentation":"

    Optional filters used to narrow down the scope of the returned maintenance windows. Supported filter keys are Name and Enabled.

    " + }, + "MaxResults":{ + "shape":"MaintenanceWindowMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeMaintenanceWindowsResult":{ + "type":"structure", + "members":{ + "WindowIdentities":{ + "shape":"MaintenanceWindowIdentityList", + "documentation":"

    Information about the maintenance windows.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribeOpsItemsRequest":{ + "type":"structure", + "members":{ + "OpsItemFilters":{ + "shape":"OpsItemFilters", + "documentation":"

    One or more filters to limit the reponse.

    • Key: CreatedTime

      Operations: GreaterThan, LessThan

    • Key: LastModifiedBy

      Operations: Contains, Equals

    • Key: LastModifiedTime

      Operations: GreaterThan, LessThan

    • Key: Priority

      Operations: Equals

    • Key: Source

      Operations: Contains, Equals

    • Key: Status

      Operations: Equals

    • Key: Title

      Operations: Contains

    • Key: OperationalData*

      Operations: Equals

    • Key: OperationalDataKey

      Operations: Equals

    • Key: OperationalDataValue

      Operations: Equals, Contains

    • Key: OpsItemId

      Operations: Equals

    • Key: ResourceId

      Operations: Contains

    • Key: AutomationId

      Operations: Equals

    *If you filter the response by using the OperationalData operator, specify a key-value pair by using the following JSON format: {\"key\":\"key_name\",\"value\":\"a_value\"}

    " + }, + "MaxResults":{ + "shape":"OpsItemMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "DescribeOpsItemsResponse":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + }, + "OpsItemSummaries":{ + "shape":"OpsItemSummaries", + "documentation":"

    A list of OpsItems.

    " + } + } + }, + "DescribeParametersRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ParametersFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "ParameterFilters":{ + "shape":"ParameterStringFilterList", + "documentation":"

    Filters to limit the request results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribeParametersResult":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParameterMetadataList", + "documentation":"

    Parameters returned by the request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribePatchBaselinesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"PatchOrchestratorFilterList", + "documentation":"

    Each element in the array is a structure containing:

    Key: (string, \"NAME_PREFIX\" or \"OWNER\")

    Value: (array of strings, exactly 1 entry, between 1 and 255 characters)

    " + }, + "MaxResults":{ + "shape":"PatchBaselineMaxResults", + "documentation":"

    The maximum number of patch baselines to return (per page).

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribePatchBaselinesResult":{ + "type":"structure", + "members":{ + "BaselineIdentities":{ + "shape":"PatchBaselineIdentityList", + "documentation":"

    An array of PatchBaselineIdentity elements.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribePatchGroupStateRequest":{ + "type":"structure", + "required":["PatchGroup"], + "members":{ + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group whose patch snapshot should be retrieved.

    " + } + } + }, + "DescribePatchGroupStateResult":{ + "type":"structure", + "members":{ + "Instances":{ + "shape":"Integer", + "documentation":"

    The number of instances in the patch group.

    " + }, + "InstancesWithInstalledPatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with installed patches.

    " + }, + "InstancesWithInstalledOtherPatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with patches installed that aren't defined in the patch baseline.

    " + }, + "InstancesWithInstalledRejectedPatches":{ + "shape":"InstancesCount", + "documentation":"

    The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of INSTALLED_REJECTED were typically installed before they were added to a RejectedPatches list.

    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstancesWithInstalledRejectedPatches will always be 0 (zero).

    ", + "box":true + }, + "InstancesWithMissingPatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with missing patches from the patch baseline.

    " + }, + "InstancesWithFailedPatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with patches from the patch baseline that failed to install.

    " + }, + "InstancesWithNotApplicablePatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with patches that aren't applicable.

    " + }, + "InstancesWithUnreportedNotApplicablePatches":{ + "shape":"Integer", + "documentation":"

    The number of instances with NotApplicable patches beyond the supported limit, which are not reported by name to Systems Manager Inventory.

    ", + "box":true + } + } + }, + "DescribePatchGroupsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"PatchBaselineMaxResults", + "documentation":"

    The maximum number of patch groups to return (per page).

    ", + "box":true + }, + "Filters":{ + "shape":"PatchOrchestratorFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribePatchGroupsResult":{ + "type":"structure", + "members":{ + "Mappings":{ + "shape":"PatchGroupPatchBaselineMappingList", + "documentation":"

    Each entry in the array contains:

    PatchGroup: string (between 1 and 256 characters, Regex: ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$)

    PatchBaselineIdentity: A PatchBaselineIdentity element.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "DescribePatchPropertiesRequest":{ + "type":"structure", + "required":[ + "OperatingSystem", + "Property" + ], + "members":{ + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    The operating system type for which to list patches.

    " + }, + "Property":{ + "shape":"PatchProperty", + "documentation":"

    The patch property for which you want to view patch details.

    " + }, + "PatchSet":{ + "shape":"PatchSet", + "documentation":"

    Indicates whether to list patches for the Windows operating system or for Microsoft applications. Not applicable for Linux operating systems.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescribePatchPropertiesResult":{ + "type":"structure", + "members":{ + "Properties":{ + "shape":"PatchPropertiesList", + "documentation":"

    A list of the properties for patches matching the filter request parameters.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You use this token in the next call.)

    " + } + } + }, + "DescribeSessionsRequest":{ + "type":"structure", + "required":["State"], + "members":{ + "State":{ + "shape":"SessionState", + "documentation":"

    The session status to retrieve a list of sessions for. For example, \"Active\".

    " + }, + "MaxResults":{ + "shape":"SessionMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "Filters":{ + "shape":"SessionFilterList", + "documentation":"

    One or more filters to limit the type of sessions returned by the request.

    " + } + } + }, + "DescribeSessionsResponse":{ + "type":"structure", + "members":{ + "Sessions":{ + "shape":"SessionList", + "documentation":"

    A list of sessions meeting the request parameters.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "DescriptionInDocument":{"type":"string"}, + "DocumentARN":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.:/]{3,128}$" + }, + "DocumentAlreadyExists":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified document already exists.

    ", + "exception":true + }, + "DocumentContent":{ + "type":"string", + "min":1 + }, + "DocumentDefaultVersionDescription":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document.

    " + }, + "DefaultVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The default version of the document.

    " + }, + "DefaultVersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    The default version of the artifact associated with the document.

    " + } + }, + "documentation":"

    A default version of a document.

    " + }, + "DocumentDescription":{ + "type":"structure", + "members":{ + "Sha1":{ + "shape":"DocumentSha1", + "documentation":"

    The SHA1 hash of the document, which you can use for verification.

    " + }, + "Hash":{ + "shape":"DocumentHash", + "documentation":"

    The Sha256 or Sha1 hash created by the system when the document was created.

    Sha1 hashes have been deprecated.

    " + }, + "HashType":{ + "shape":"DocumentHashType", + "documentation":"

    The hash type of the document. Valid values include Sha256 or Sha1.

    Sha1 hashes have been deprecated.

    " + }, + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    The version of the artifact associated with the document.

    " + }, + "Owner":{ + "shape":"DocumentOwner", + "documentation":"

    The AWS user account that created the document.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date when the document was created.

    " + }, + "Status":{ + "shape":"DocumentStatus", + "documentation":"

    The status of the Systems Manager document.

    " + }, + "StatusInformation":{ + "shape":"DocumentStatusInformation", + "documentation":"

    A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "Description":{ + "shape":"DescriptionInDocument", + "documentation":"

    A description of the document.

    " + }, + "Parameters":{ + "shape":"DocumentParameterList", + "documentation":"

    A description of the parameters for a document.

    " + }, + "PlatformTypes":{ + "shape":"PlatformTypeList", + "documentation":"

    The list of OS platforms compatible with this Systems Manager document.

    " + }, + "DocumentType":{ + "shape":"DocumentType", + "documentation":"

    The type of document.

    " + }, + "SchemaVersion":{ + "shape":"DocumentSchemaVersion", + "documentation":"

    The schema version.

    " + }, + "LatestVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The latest version of the document.

    " + }, + "DefaultVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The default version.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    The document format, either JSON or YAML.

    " + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"

    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags, or metadata, that have been applied to the document.

    " + }, + "AttachmentsInformation":{ + "shape":"AttachmentInformationList", + "documentation":"

    Details about the document attachments, including names, locations, sizes, etc.

    " + } + }, + "documentation":"

    Describes a Systems Manager document.

    " + }, + "DocumentFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"DocumentFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "value":{ + "shape":"DocumentFilterValue", + "documentation":"

    The value of the filter.

    " + } + }, + "documentation":"

    Describes a filter.

    " + }, + "DocumentFilterKey":{ + "type":"string", + "enum":[ + "Name", + "Owner", + "PlatformTypes", + "DocumentType" + ] + }, + "DocumentFilterList":{ + "type":"list", + "member":{"shape":"DocumentFilter"}, + "min":1 + }, + "DocumentFilterValue":{ + "type":"string", + "min":1 + }, + "DocumentFormat":{ + "type":"string", + "enum":[ + "YAML", + "JSON" + ] + }, + "DocumentHash":{ + "type":"string", + "max":256 + }, + "DocumentHashType":{ + "type":"string", + "enum":[ + "Sha256", + "Sha1" + ] + }, + "DocumentIdentifier":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "Owner":{ + "shape":"DocumentOwner", + "documentation":"

    The AWS user account that created the document.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "PlatformTypes":{ + "shape":"PlatformTypeList", + "documentation":"

    The operating system platform.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "DocumentType":{ + "shape":"DocumentType", + "documentation":"

    The document type.

    " + }, + "SchemaVersion":{ + "shape":"DocumentSchemaVersion", + "documentation":"

    The schema version.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    The document format, either JSON or YAML.

    " + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"

    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see AWS Resource Types Reference in the AWS CloudFormation User Guide.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags, or metadata, that have been applied to the document.

    " + } + }, + "documentation":"

    Describes the name of a Systems Manager document.

    " + }, + "DocumentIdentifierList":{ + "type":"list", + "member":{"shape":"DocumentIdentifier"} + }, + "DocumentKeyValuesFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"DocumentKeyValuesFilterKey", + "documentation":"

    The name of the filter key.

    " + }, + "Values":{ + "shape":"DocumentKeyValuesFilterValues", + "documentation":"

    The value for the filter key.

    " + } + }, + "documentation":"

    One or more filters. Use a filter to return a more specific list of documents.

    For keys, you can specify one or more tags that have been applied to a document.

    Other valid values include Owner, Name, PlatformTypes, and DocumentType.

    Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

    If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the AWS CLI, to return a list of all documents that begin with Te, run the following command:

    aws ssm list-documents --filters Key=Name,Values=Te

    If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

    To specify a custom key and value pair, use the format Key=tag:[tagName],Values=[valueName].

    For example, if you created a Key called region and are using the AWS CLI to call the list-documents command:

    aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

    " + }, + "DocumentKeyValuesFilterKey":{ + "type":"string", + "max":128, + "min":1 + }, + "DocumentKeyValuesFilterList":{ + "type":"list", + "member":{"shape":"DocumentKeyValuesFilter"}, + "max":6, + "min":0 + }, + "DocumentKeyValuesFilterValue":{ + "type":"string", + "max":256, + "min":1 + }, + "DocumentKeyValuesFilterValues":{ + "type":"list", + "member":{"shape":"DocumentKeyValuesFilterValue"} + }, + "DocumentLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You can have at most 500 active Systems Manager documents.

    ", + "exception":true + }, + "DocumentName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "DocumentOwner":{"type":"string"}, + "DocumentParameter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentParameterName", + "documentation":"

    The name of the parameter.

    " + }, + "Type":{ + "shape":"DocumentParameterType", + "documentation":"

    The type of parameter. The type can be either String or StringList.

    " + }, + "Description":{ + "shape":"DocumentParameterDescrption", + "documentation":"

    A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

    " + }, + "DefaultValue":{ + "shape":"DocumentParameterDefaultValue", + "documentation":"

    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.

    " + } + }, + "documentation":"

    Parameters specified in a System Manager document that run on the server when the command is run.

    " + }, + "DocumentParameterDefaultValue":{"type":"string"}, + "DocumentParameterDescrption":{"type":"string"}, + "DocumentParameterList":{ + "type":"list", + "member":{"shape":"DocumentParameter"} + }, + "DocumentParameterName":{"type":"string"}, + "DocumentParameterType":{ + "type":"string", + "enum":[ + "String", + "StringList" + ] + }, + "DocumentPermissionLimit":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The document cannot be shared with more AWS user accounts. You can share a document with a maximum of 20 accounts. You can publicly share up to five documents. If you need to increase this limit, contact AWS Support.

    ", + "exception":true + }, + "DocumentPermissionType":{ + "type":"string", + "enum":["Share"] + }, + "DocumentSchemaVersion":{ + "type":"string", + "pattern":"([0-9]+)\\.([0-9]+)" + }, + "DocumentSha1":{"type":"string"}, + "DocumentStatus":{ + "type":"string", + "documentation":"

    The status of a document.

    ", + "enum":[ + "Creating", + "Active", + "Updating", + "Deleting", + "Failed" + ] + }, + "DocumentStatusInformation":{"type":"string"}, + "DocumentType":{ + "type":"string", + "enum":[ + "Command", + "Policy", + "Automation", + "Session", + "Package" + ] + }, + "DocumentVersion":{ + "type":"string", + "pattern":"([$]LATEST|[$]DEFAULT|^[1-9][0-9]*$)" + }, + "DocumentVersionInfo":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The document name.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date the document was created.

    " + }, + "IsDefaultVersion":{ + "shape":"Boolean", + "documentation":"

    An identifier for the default version of the document.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    The document format, either JSON or YAML.

    " + }, + "Status":{ + "shape":"DocumentStatus", + "documentation":"

    The status of the Systems Manager document, such as Creating, Active, Failed, and Deleting.

    " + }, + "StatusInformation":{ + "shape":"DocumentStatusInformation", + "documentation":"

    A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"

    " + } + }, + "documentation":"

    Version information about the document.

    " + }, + "DocumentVersionLimitExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The document has too many versions. Delete one or more document versions and try again.

    ", + "exception":true + }, + "DocumentVersionList":{ + "type":"list", + "member":{"shape":"DocumentVersionInfo"}, + "min":1 + }, + "DocumentVersionName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{1,128}$" + }, + "DocumentVersionNumber":{ + "type":"string", + "pattern":"(^[1-9][0-9]*$)" + }, + "DoesNotExistException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Error returned when the ID specified for a resource, such as a maintenance window or Patch baseline, doesn't exist.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

    ", + "exception":true + }, + "DryRun":{"type":"boolean"}, + "DuplicateDocumentContent":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The content of the association document matches another document. Change the content of the document and try again.

    ", + "exception":true + }, + "DuplicateDocumentVersionName":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The version name has already been used in this document. Specify a different version name, and then try again.

    ", + "exception":true + }, + "DuplicateInstanceId":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You cannot specify an instance ID in more than one association.

    ", + "exception":true + }, + "EffectiveInstanceAssociationMaxResults":{ + "type":"integer", + "max":5, + "min":1 + }, + "EffectivePatch":{ + "type":"structure", + "members":{ + "Patch":{ + "shape":"Patch", + "documentation":"

    Provides metadata for a patch, including information such as the KB ID, severity, classification and a URL for where more information can be obtained about the patch.

    " + }, + "PatchStatus":{ + "shape":"PatchStatus", + "documentation":"

    The status of the patch in a patch baseline. This includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

    " + } + }, + "documentation":"

    The EffectivePatch structure defines metadata about a patch along with the approval state of the patch in a particular patch baseline. The approval state includes information about whether the patch is currently approved, due to be approved by a rule, explicitly approved, or explicitly rejected and the date the patch was or will be approved.

    " + }, + "EffectivePatchList":{ + "type":"list", + "member":{"shape":"EffectivePatch"} + }, + "ErrorCount":{"type":"integer"}, + "ExecutionMode":{ + "type":"string", + "enum":[ + "Auto", + "Interactive" + ] + }, + "ExecutionRoleName":{ + "type":"string", + "max":64, + "min":1 + }, + "ExpirationDate":{"type":"timestamp"}, + "FailedCreateAssociation":{ + "type":"structure", + "members":{ + "Entry":{ + "shape":"CreateAssociationBatchRequestEntry", + "documentation":"

    The association.

    " + }, + "Message":{ + "shape":"BatchErrorMessage", + "documentation":"

    A description of the failure.

    " + }, + "Fault":{ + "shape":"Fault", + "documentation":"

    The source of the failure.

    " + } + }, + "documentation":"

    Describes a failed association.

    " + }, + "FailedCreateAssociationList":{ + "type":"list", + "member":{"shape":"FailedCreateAssociation"} + }, + "FailureDetails":{ + "type":"structure", + "members":{ + "FailureStage":{ + "shape":"String", + "documentation":"

    The stage of the Automation execution when the failure occurred. The stages include the following: InputValidation, PreVerification, Invocation, PostVerification.

    " + }, + "FailureType":{ + "shape":"String", + "documentation":"

    The type of Automation failure. Failure types include the following: Action, Permission, Throttling, Verification, Internal.

    " + }, + "Details":{ + "shape":"AutomationParameterMap", + "documentation":"

    Detailed information about the Automation step failure.

    " + } + }, + "documentation":"

    Information about an Automation failure.

    " + }, + "Fault":{ + "type":"string", + "enum":[ + "Client", + "Server", + "Unknown" + ] + }, + "FeatureNotAvailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You attempted to register a LAMBDA or STEP_FUNCTIONS task in a region where the corresponding service is not available.

    ", + "exception":true + }, + "GetAutomationExecutionRequest":{ + "type":"structure", + "required":["AutomationExecutionId"], + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The unique identifier for an existing automation execution to examine. The execution ID is returned by StartAutomationExecution when the execution of an Automation document is initiated.

    " + } + } + }, + "GetAutomationExecutionResult":{ + "type":"structure", + "members":{ + "AutomationExecution":{ + "shape":"AutomationExecution", + "documentation":"

    Detailed information about the current state of an automation execution.

    " + } + } + }, + "GetCommandInvocationRequest":{ + "type":"structure", + "required":[ + "CommandId", + "InstanceId" + ], + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    (Required) The parent command ID of the invocation plugin.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    (Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

    " + }, + "PluginName":{ + "shape":"CommandPluginName", + "documentation":"

    (Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.

    " + } + } + }, + "GetCommandInvocationResult":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    The parent command ID of the invocation plugin.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the managed instance targeted by the command. A managed instance can be an Amazon EC2 instance or an instance in your hybrid environment that is configured for Systems Manager.

    " + }, + "Comment":{ + "shape":"Comment", + "documentation":"

    The comment text for the command.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The name of the document that was run. For example, AWS-RunShellScript.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The SSM document version used in the request.

    " + }, + "PluginName":{ + "shape":"CommandPluginName", + "documentation":"

    The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.

    " + }, + "ResponseCode":{ + "shape":"ResponseCode", + "documentation":"

    The error level response code for the plugin script. If the response code is -1, then the command has not started running on the instance, or it was not received by the instance.

    " + }, + "ExecutionStartDateTime":{ + "shape":"StringDateTime", + "documentation":"

    The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedBefore filter.

    aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z

    If the plugin has not started to run, the string is empty.

    " + }, + "ExecutionElapsedTime":{ + "shape":"StringDateTime", + "documentation":"

    Duration since ExecutionStartDateTime.

    " + }, + "ExecutionEndDateTime":{ + "shape":"StringDateTime", + "documentation":"

    The date and time the plugin was finished running. Date and time are written in ISO 8601 format. For example, June 7, 2017 is represented as 2017-06-7. The following sample AWS CLI command uses the InvokedAfter filter.

    aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z

    If the plugin has not started to run, the string is empty.

    " + }, + "Status":{ + "shape":"CommandInvocationStatus", + "documentation":"

    The status of this invocation plugin. This status can be different than StatusDetails.

    " + }, + "StatusDetails":{ + "shape":"StatusDetails", + "documentation":"

    A detailed status of the command execution for an invocation. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding Command Statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

    • Pending: The command has not been sent to the instance.

    • In Progress: The command has been sent to the instance but has not reached a terminal state.

    • Delayed: The system attempted to send the command to the target, but the target was not available. The instance might not be available because of network issues, the instance was stopped, etc. The system will try to deliver the command again.

    • Success: The command or plugin was run successfully. This is a terminal state.

    • Delivery Timed Out: The command was not delivered to the instance before the delivery timeout expired. Delivery timeouts do not count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Execution Timed Out: The command started to run on the instance, but the execution was not complete before the timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.

    • Failed: The command wasn't run successfully on the instance. For a plugin, this indicates that the result code was not zero. For a command invocation, this indicates that the result code for one or more plugins was not zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.

    • Canceled: The command was terminated before it was completed. This is a terminal state.

    • Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.

    • Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.

    " + }, + "StandardOutputContent":{ + "shape":"StandardOutputContent", + "documentation":"

    The first 24,000 characters written by the plugin to stdout. If the command has not finished running, if ExecutionStatus is neither Succeeded nor Failed, then this string is empty.

    " + }, + "StandardOutputUrl":{ + "shape":"Url", + "documentation":"

    The URL for the complete text written by the plugin to stdout in Amazon S3. If an Amazon S3 bucket was not specified, then this string is empty.

    " + }, + "StandardErrorContent":{ + "shape":"StandardErrorContent", + "documentation":"

    The first 8,000 characters written by the plugin to stderr. If the command has not finished running, then this string is empty.

    " + }, + "StandardErrorUrl":{ + "shape":"Url", + "documentation":"

    The URL for the complete text written by the plugin to stderr. If the command has not finished running, then this string is empty.

    " + }, + "CloudWatchOutputConfig":{ + "shape":"CloudWatchOutputConfig", + "documentation":"

    CloudWatch Logs information where Systems Manager sent the command output.

    " + } + } + }, + "GetConnectionStatusRequest":{ + "type":"structure", + "required":["Target"], + "members":{ + "Target":{ + "shape":"SessionTarget", + "documentation":"

    The ID of the instance.

    " + } + } + }, + "GetConnectionStatusResponse":{ + "type":"structure", + "members":{ + "Target":{ + "shape":"SessionTarget", + "documentation":"

    The ID of the instance to check connection status.

    " + }, + "Status":{ + "shape":"ConnectionStatus", + "documentation":"

    The status of the connection to the instance. For example, 'Connected' or 'Not Connected'.

    " + } + } + }, + "GetDefaultPatchBaselineRequest":{ + "type":"structure", + "members":{ + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    Returns the default patch baseline for the specified operating system.

    " + } + } + }, + "GetDefaultPatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the default patch baseline.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    The operating system for the returned patch baseline.

    " + } + } + }, + "GetDeployablePatchSnapshotForInstanceRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "SnapshotId" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance for which the appropriate patch snapshot should be retrieved.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The user-defined snapshot ID.

    " + } + } + }, + "GetDeployablePatchSnapshotForInstanceResult":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The user-defined snapshot ID.

    " + }, + "SnapshotDownloadUrl":{ + "shape":"SnapshotDownloadUrl", + "documentation":"

    A pre-signed Amazon S3 URL that can be used to download the patch snapshot.

    " + }, + "Product":{ + "shape":"Product", + "documentation":"

    Returns the specific operating system (for example Windows Server 2012 or Amazon Linux 2015.09) on the instance for the specified patch snapshot.

    " + } + } + }, + "GetDocumentRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    An optional field specifying the version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version for which you want information.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

    " + } + } + }, + "GetDocumentResult":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    The version of the artifact associated with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version.

    " + }, + "Status":{ + "shape":"DocumentStatus", + "documentation":"

    The status of the Systems Manager document, such as Creating, Active, Updating, Failed, and Deleting.

    " + }, + "StatusInformation":{ + "shape":"DocumentStatusInformation", + "documentation":"

    A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, \"The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.\"

    " + }, + "Content":{ + "shape":"DocumentContent", + "documentation":"

    The contents of the Systems Manager document.

    " + }, + "DocumentType":{ + "shape":"DocumentType", + "documentation":"

    The document type.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    The document format, either JSON or YAML.

    " + }, + "AttachmentsContent":{ + "shape":"AttachmentContentList", + "documentation":"

    A description of the document attachments, including names, locations, sizes, etc.

    " + } + } + }, + "GetInventoryRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"InventoryFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "Aggregators":{ + "shape":"InventoryAggregatorList", + "documentation":"

    Returns counts of inventory types based on one or more expressions. For example, if you aggregate by using an expression that uses the AWS:InstanceInformation.PlatformType type, you can see a count of how many Windows and Linux instances exist in your inventoried fleet.

    " + }, + "ResultAttributes":{ + "shape":"ResultAttributeList", + "documentation":"

    The list of inventory item types to return.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "GetInventoryResult":{ + "type":"structure", + "members":{ + "Entities":{ + "shape":"InventoryResultEntityList", + "documentation":"

    Collection of inventory entities such as a collection of instance inventory.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "GetInventorySchemaMaxResults":{ + "type":"integer", + "max":200, + "min":50 + }, + "GetInventorySchemaRequest":{ + "type":"structure", + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeNameFilter", + "documentation":"

    The type of inventory item to return.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"GetInventorySchemaMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "Aggregator":{ + "shape":"AggregatorSchemaOnly", + "documentation":"

    Returns inventory schemas that support aggregation. For example, this call returns the AWS:InstanceInformation type, because it supports aggregation based on the PlatformName, PlatformType, and PlatformVersion attributes.

    " + }, + "SubType":{ + "shape":"IsSubTypeSchema", + "documentation":"

    Returns the sub-type schema for a specified inventory type.

    ", + "box":true + } + } + }, + "GetInventorySchemaResult":{ + "type":"structure", + "members":{ + "Schemas":{ + "shape":"InventoryItemSchemaResultList", + "documentation":"

    Inventory schemas returned by the request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "GetMaintenanceWindowExecutionRequest":{ + "type":"structure", + "required":["WindowExecutionId"], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that includes the task.

    " + } + } + }, + "GetMaintenanceWindowExecutionResult":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution.

    " + }, + "TaskIds":{ + "shape":"MaintenanceWindowExecutionTaskIdList", + "documentation":"

    The ID of the task executions from the maintenance window execution.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The status of the maintenance window execution.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the Status. Only available for certain status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time the maintenance window started running.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time the maintenance window finished running.

    " + } + } + }, + "GetMaintenanceWindowExecutionTaskInvocationRequest":{ + "type":"structure", + "required":[ + "WindowExecutionId", + "TaskId", + "InvocationId" + ], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution for which the task is a part.

    " + }, + "TaskId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task in the maintenance window task that should be retrieved.

    " + }, + "InvocationId":{ + "shape":"MaintenanceWindowExecutionTaskInvocationId", + "documentation":"

    The invocation ID to retrieve.

    " + } + } + }, + "GetMaintenanceWindowExecutionTaskInvocationResult":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The maintenance window execution ID.

    " + }, + "TaskExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The task execution ID.

    " + }, + "InvocationId":{ + "shape":"MaintenanceWindowExecutionTaskInvocationId", + "documentation":"

    The invocation ID.

    " + }, + "ExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskExecutionId", + "documentation":"

    The execution ID.

    " + }, + "TaskType":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    Retrieves the task type for a maintenance window. Task types include the following: LAMBDA, STEP_FUNCTIONS, AUTOMATION, RUN_COMMAND.

    " + }, + "Parameters":{ + "shape":"MaintenanceWindowExecutionTaskInvocationParameters", + "documentation":"

    The parameters used at the time that the task ran.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The task status for an invocation.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the status. Details are only available for certain status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time that the task started running on the target.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time that the task finished running on the target.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    User-provided value to be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTaskTargetId", + "documentation":"

    The maintenance window target ID.

    " + } + } + }, + "GetMaintenanceWindowExecutionTaskRequest":{ + "type":"structure", + "required":[ + "WindowExecutionId", + "TaskId" + ], + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that includes the task.

    " + }, + "TaskId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task execution in the maintenance window task that should be retrieved.

    " + } + } + }, + "GetMaintenanceWindowExecutionTaskResult":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that includes the task.

    " + }, + "TaskExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task execution in the maintenance window task that was retrieved.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The ARN of the task that ran.

    " + }, + "ServiceRole":{ + "shape":"ServiceRole", + "documentation":"

    The role that was assumed when running the task.

    " + }, + "Type":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The type of task that was run.

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParametersList", + "documentation":"

    The parameters passed to the task when it was run.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    The map has the following format:

    Key: string, between 1 and 255 characters

    Value: an array of strings, each string is between 1 and 255 characters

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The priority of the task.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The defined maximum number of task executions that could be run in parallel.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The defined maximum number of task execution errors allowed before scheduling of the task execution would have been stopped.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The status of the task.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the Status. Only available for certain status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time the task execution started.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time the task execution completed.

    " + } + } + }, + "GetMaintenanceWindowRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window for which you want to retrieve information.

    " + } + } + }, + "GetMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the created maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    The description of the maintenance window.

    " + }, + "StartDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

    " + }, + "EndDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

    " + }, + "Schedule":{ + "shape":"MaintenanceWindowSchedule", + "documentation":"

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + }, + "ScheduleTimezone":{ + "shape":"MaintenanceWindowTimezone", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.

    " + }, + "NextExecutionTime":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

    " + }, + "Duration":{ + "shape":"MaintenanceWindowDurationHours", + "documentation":"

    The duration of the maintenance window in hours.

    " + }, + "Cutoff":{ + "shape":"MaintenanceWindowCutoff", + "documentation":"

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

    " + }, + "AllowUnassociatedTargets":{ + "shape":"MaintenanceWindowAllowUnassociatedTargets", + "documentation":"

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

    " + }, + "Enabled":{ + "shape":"MaintenanceWindowEnabled", + "documentation":"

    Indicates whether the maintenance window is enabled.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date the maintenance window was created.

    " + }, + "ModifiedDate":{ + "shape":"DateTime", + "documentation":"

    The date the maintenance window was last modified.

    " + } + } + }, + "GetMaintenanceWindowTaskRequest":{ + "type":"structure", + "required":[ + "WindowId", + "WindowTaskId" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The maintenance window ID that includes the task to retrieve.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The maintenance window task ID to retrieve.

    " + } + } + }, + "GetMaintenanceWindowTaskResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The retrieved maintenance window ID.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The retrieved maintenance window task ID.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets where the task should run.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The resource that the task used during execution. For RUN_COMMAND and AUTOMATION task types, the TaskArn is the Systems Manager Document name/ARN. For LAMBDA tasks, the value is the function name/ARN. For STEP_FUNCTIONS tasks, the value is the state machine ARN.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

    " + }, + "TaskType":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The type of task to run.

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParameters", + "documentation":"

    The parameters to pass to the task when it runs.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "TaskInvocationParameters":{ + "shape":"MaintenanceWindowTaskInvocationParameters", + "documentation":"

    The parameters to pass to the task when it runs.

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The priority of the task when it runs. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run this task in parallel.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed before the task stops being scheduled.

    " + }, + "LoggingInfo":{ + "shape":"LoggingInfo", + "documentation":"

    The location in Amazon S3 where the task results are logged.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The retrieved task name.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    The retrieved task description.

    " + } + } + }, + "GetOpsItemRequest":{ + "type":"structure", + "required":["OpsItemId"], + "members":{ + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"

    The ID of the OpsItem that you want to get.

    " + } + } + }, + "GetOpsItemResponse":{ + "type":"structure", + "members":{ + "OpsItem":{ + "shape":"OpsItem", + "documentation":"

    The OpsItem.

    " + } + } + }, + "GetOpsSummaryRequest":{ + "type":"structure", + "required":["Aggregators"], + "members":{ + "Filters":{ + "shape":"OpsFilterList", + "documentation":"

    Optional filters used to scope down the returned OpsItems.

    " + }, + "Aggregators":{ + "shape":"OpsAggregatorList", + "documentation":"

    Optional aggregators that return counts of OpsItems based on one or more expressions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "GetOpsSummaryResult":{ + "type":"structure", + "members":{ + "Entities":{ + "shape":"OpsEntityList", + "documentation":"

    The list of aggregated and filtered OpsItems.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "GetParameterHistoryRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The name of a parameter you want to query.

    " + }, + "WithDecryption":{ + "shape":"Boolean", + "documentation":"

    Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    ", + "box":true + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "GetParameterHistoryResult":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParameterHistoryList", + "documentation":"

    A list of parameters returned by the request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "GetParameterRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The name of the parameter you want to query.

    " + }, + "WithDecryption":{ + "shape":"Boolean", + "documentation":"

    Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    ", + "box":true + } + } + }, + "GetParameterResult":{ + "type":"structure", + "members":{ + "Parameter":{ + "shape":"Parameter", + "documentation":"

    Information about a parameter.

    " + } + } + }, + "GetParametersByPathMaxResults":{ + "type":"integer", + "max":10, + "min":1 + }, + "GetParametersByPathRequest":{ + "type":"structure", + "required":["Path"], + "members":{ + "Path":{ + "shape":"PSParameterName", + "documentation":"

    The hierarchy for the parameter. Hierarchies start with a forward slash (/) and end with the parameter name. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

    " + }, + "Recursive":{ + "shape":"Boolean", + "documentation":"

    Retrieve all parameters within a hierarchy.

    If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

    ", + "box":true + }, + "ParameterFilters":{ + "shape":"ParameterStringFilterList", + "documentation":"

    Filters to limit the request results.

    You can't filter using the parameter name.

    " + }, + "WithDecryption":{ + "shape":"Boolean", + "documentation":"

    Retrieve all parameters in a hierarchy with their value decrypted.

    ", + "box":true + }, + "MaxResults":{ + "shape":"GetParametersByPathMaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "GetParametersByPathResult":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParameterList", + "documentation":"

    A list of parameters found in the specified hierarchy.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "GetParametersRequest":{ + "type":"structure", + "required":["Names"], + "members":{ + "Names":{ + "shape":"ParameterNameList", + "documentation":"

    Names of the parameters for which you want to query information.

    " + }, + "WithDecryption":{ + "shape":"Boolean", + "documentation":"

    Return decrypted secure string value. Return decrypted values for secure string parameters. This flag is ignored for String and StringList parameter types.

    ", + "box":true + } + } + }, + "GetParametersResult":{ + "type":"structure", + "members":{ + "Parameters":{ + "shape":"ParameterList", + "documentation":"

    A list of details for a parameter.

    " + }, + "InvalidParameters":{ + "shape":"ParameterNameList", + "documentation":"

    A list of parameters that are not formatted correctly or do not run during an execution.

    " + } + } + }, + "GetPatchBaselineForPatchGroupRequest":{ + "type":"structure", + "required":["PatchGroup"], + "members":{ + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group whose patch baseline should be retrieved.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    Returns he operating system rule specified for patch groups using the patch baseline.

    " + } + } + }, + "GetPatchBaselineForPatchGroupResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline that should be used for the patch group.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    The operating system rule specified for patch groups using the patch baseline.

    " + } + } + }, + "GetPatchBaselineRequest":{ + "type":"structure", + "required":["BaselineId"], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to retrieve.

    " + } + } + }, + "GetPatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the retrieved patch baseline.

    " + }, + "Name":{ + "shape":"BaselineName", + "documentation":"

    The name of the patch baseline.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    Returns the operating system specified for the patch baseline.

    " + }, + "GlobalFilters":{ + "shape":"PatchFilterGroup", + "documentation":"

    A set of global filters used to exclude patches from the baseline.

    " + }, + "ApprovalRules":{ + "shape":"PatchRuleGroup", + "documentation":"

    A set of rules used to include patches in the baseline.

    " + }, + "ApprovedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly approved patches for the baseline.

    " + }, + "ApprovedPatchesComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    Returns the specified compliance severity level for approved patches in the patch baseline.

    " + }, + "ApprovedPatchesEnableNonSecurity":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

    ", + "box":true + }, + "RejectedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly rejected patches for the baseline.

    " + }, + "RejectedPatchesAction":{ + "shape":"PatchAction", + "documentation":"

    The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

    " + }, + "PatchGroups":{ + "shape":"PatchGroupList", + "documentation":"

    Patch groups included in the patch baseline.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date the patch baseline was created.

    " + }, + "ModifiedDate":{ + "shape":"DateTime", + "documentation":"

    The date the patch baseline was last modified.

    " + }, + "Description":{ + "shape":"BaselineDescription", + "documentation":"

    A description of the patch baseline.

    " + }, + "Sources":{ + "shape":"PatchSourceList", + "documentation":"

    Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

    " + } + } + }, + "GetServiceSettingRequest":{ + "type":"structure", + "required":["SettingId"], + "members":{ + "SettingId":{ + "shape":"ServiceSettingId", + "documentation":"

    The ID of the service setting to get.

    " + } + }, + "documentation":"

    The request body of the GetServiceSetting API action.

    " + }, + "GetServiceSettingResult":{ + "type":"structure", + "members":{ + "ServiceSetting":{ + "shape":"ServiceSetting", + "documentation":"

    The query result of the current service setting.

    " + } + }, + "documentation":"

    The query result body of the GetServiceSetting API action.

    " + }, + "HierarchyLevelLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

    A hierarchy can have a maximum of 15 levels. For more information, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

    " + } + }, + "documentation":"

    A hierarchy can have a maximum of 15 levels. For more information, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

    ", + "exception":true + }, + "HierarchyTypeMismatchException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

    Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.

    " + } + }, + "documentation":"

    Parameter Store does not support changing a parameter type in a hierarchy. For example, you can't change a parameter from a String type to a SecureString type. You must create a new, unique parameter.

    ", + "exception":true + }, + "IPAddress":{ + "type":"string", + "max":46, + "min":1 + }, + "IamRole":{ + "type":"string", + "max":64 + }, + "IdempotencyToken":{ + "type":"string", + "max":36, + "min":36, + "pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + }, + "IdempotentParameterMismatch":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Error returned when an idempotent operation is retried and the parameters don't match the original call to the API with the same idempotency token.

    ", + "exception":true + }, + "IncompatiblePolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    There is a conflict in the policies specified for this parameter. You can't, for example, specify two Expiration policies for a parameter. Review your policies, and try again.

    ", + "exception":true + }, + "InstallOverrideList":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^https://.+$|^s3://([^/]+)/(.*?([^/]+))$" + }, + "InstanceAggregatedAssociationOverview":{ + "type":"structure", + "members":{ + "DetailedStatus":{ + "shape":"StatusName", + "documentation":"

    Detailed status information about the aggregated associations.

    " + }, + "InstanceAssociationStatusAggregatedCount":{ + "shape":"InstanceAssociationStatusAggregatedCount", + "documentation":"

    The number of associations for the instance(s).

    " + } + }, + "documentation":"

    Status information about the aggregated associations.

    " + }, + "InstanceAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID.

    " + }, + "Content":{ + "shape":"DocumentContent", + "documentation":"

    The content of the association document for the instance(s).

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    Version information for the association on the instance.

    " + } + }, + "documentation":"

    One or more association documents on the instance.

    " + }, + "InstanceAssociationExecutionSummary":{ + "type":"string", + "max":512, + "min":1 + }, + "InstanceAssociationList":{ + "type":"list", + "member":{"shape":"InstanceAssociation"} + }, + "InstanceAssociationOutputLocation":{ + "type":"structure", + "members":{ + "S3Location":{ + "shape":"S3OutputLocation", + "documentation":"

    An Amazon S3 bucket where you want to store the results of this request.

    " + } + }, + "documentation":"

    An Amazon S3 bucket where you want to store the results of this request.

    " + }, + "InstanceAssociationOutputUrl":{ + "type":"structure", + "members":{ + "S3OutputUrl":{ + "shape":"S3OutputUrl", + "documentation":"

    The URL of Amazon S3 bucket where you want to store the results of this request.

    " + } + }, + "documentation":"

    The URL of Amazon S3 bucket where you want to store the results of this request.

    " + }, + "InstanceAssociationStatusAggregatedCount":{ + "type":"map", + "key":{"shape":"StatusName"}, + "value":{"shape":"InstanceCount"} + }, + "InstanceAssociationStatusInfo":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID.

    " + }, + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the association.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The association document versions.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    The version of the association applied to the instance.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID where the association was created.

    " + }, + "ExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date the instance association ran.

    " + }, + "Status":{ + "shape":"StatusName", + "documentation":"

    Status information about the instance association.

    " + }, + "DetailedStatus":{ + "shape":"StatusName", + "documentation":"

    Detailed status information about the instance association.

    " + }, + "ExecutionSummary":{ + "shape":"InstanceAssociationExecutionSummary", + "documentation":"

    Summary information about association execution.

    " + }, + "ErrorCode":{ + "shape":"AgentErrorCode", + "documentation":"

    An error code returned by the request to create the association.

    " + }, + "OutputUrl":{ + "shape":"InstanceAssociationOutputUrl", + "documentation":"

    A URL for an Amazon S3 bucket where you want to store the results of this request.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    The name of the association applied to the instance.

    " + } + }, + "documentation":"

    Status information about the instance association.

    " + }, + "InstanceAssociationStatusInfos":{ + "type":"list", + "member":{"shape":"InstanceAssociationStatusInfo"} + }, + "InstanceCount":{"type":"integer"}, + "InstanceId":{ + "type":"string", + "pattern":"(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" + }, + "InstanceIdList":{ + "type":"list", + "member":{"shape":"InstanceId"}, + "max":50, + "min":0 + }, + "InstanceInformation":{ + "type":"structure", + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID.

    " + }, + "PingStatus":{ + "shape":"PingStatus", + "documentation":"

    Connection status of SSM Agent.

    " + }, + "LastPingDateTime":{ + "shape":"DateTime", + "documentation":"

    The date and time when agent last pinged Systems Manager service.

    ", + "box":true + }, + "AgentVersion":{ + "shape":"Version", + "documentation":"

    The version of SSM Agent running on your Linux instance.

    " + }, + "IsLatestVersion":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the latest version of SSM Agent is running on your Linux Managed Instance. This field does not indicate whether or not the latest version is installed on Windows managed instances, because some older versions of Windows Server use the EC2Config service to process SSM requests.

    ", + "box":true + }, + "PlatformType":{ + "shape":"PlatformType", + "documentation":"

    The operating system platform type.

    " + }, + "PlatformName":{ + "shape":"String", + "documentation":"

    The name of the operating system platform running on your instance.

    " + }, + "PlatformVersion":{ + "shape":"String", + "documentation":"

    The version of the OS platform running on your instance.

    " + }, + "ActivationId":{ + "shape":"ActivationId", + "documentation":"

    The activation ID created by Systems Manager when the server or VM was registered.

    " + }, + "IamRole":{ + "shape":"IamRole", + "documentation":"

    The Amazon Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed instances. This call does not return the IAM role for Amazon EC2 instances.

    " + }, + "RegistrationDate":{ + "shape":"DateTime", + "documentation":"

    The date the server or VM was registered with AWS as a managed instance.

    ", + "box":true + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of instance. Instances are either EC2 instances or managed instances.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of the managed instance.

    " + }, + "IPAddress":{ + "shape":"IPAddress", + "documentation":"

    The IP address of the managed instance.

    " + }, + "ComputerName":{ + "shape":"ComputerName", + "documentation":"

    The fully qualified host name of the managed instance.

    " + }, + "AssociationStatus":{ + "shape":"StatusName", + "documentation":"

    The status of the association.

    " + }, + "LastAssociationExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The date the association was last run.

    " + }, + "LastSuccessfulAssociationExecutionDate":{ + "shape":"DateTime", + "documentation":"

    The last date the association was successfully run.

    " + }, + "AssociationOverview":{ + "shape":"InstanceAggregatedAssociationOverview", + "documentation":"

    Information about the association.

    " + } + }, + "documentation":"

    Describes a filter for a specific list of instances.

    " + }, + "InstanceInformationFilter":{ + "type":"structure", + "required":[ + "key", + "valueSet" + ], + "members":{ + "key":{ + "shape":"InstanceInformationFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "valueSet":{ + "shape":"InstanceInformationFilterValueSet", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Describes a filter for a specific list of instances. You can filter instances information by using tags. You specify tags by using a key-value mapping.

    Use this action instead of the DescribeInstanceInformationRequest$InstanceInformationFilterList method. The InstanceInformationFilterList method is a legacy method and does not support tags.

    " + }, + "InstanceInformationFilterKey":{ + "type":"string", + "enum":[ + "InstanceIds", + "AgentVersion", + "PingStatus", + "PlatformTypes", + "ActivationIds", + "IamRole", + "ResourceType", + "AssociationStatus" + ] + }, + "InstanceInformationFilterList":{ + "type":"list", + "member":{"shape":"InstanceInformationFilter"}, + "min":0 + }, + "InstanceInformationFilterValue":{ + "type":"string", + "min":1 + }, + "InstanceInformationFilterValueSet":{ + "type":"list", + "member":{"shape":"InstanceInformationFilterValue"}, + "max":100, + "min":1 + }, + "InstanceInformationList":{ + "type":"list", + "member":{"shape":"InstanceInformation"} + }, + "InstanceInformationStringFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"InstanceInformationStringFilterKey", + "documentation":"

    The filter key name to describe your instances. For example:

    \"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"

    " + }, + "Values":{ + "shape":"InstanceInformationFilterValueSet", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    The filters to describe or get information about your managed instances.

    " + }, + "InstanceInformationStringFilterKey":{ + "type":"string", + "min":1 + }, + "InstanceInformationStringFilterList":{ + "type":"list", + "member":{"shape":"InstanceInformationStringFilter"}, + "min":0 + }, + "InstancePatchState":{ + "type":"structure", + "required":[ + "InstanceId", + "PatchGroup", + "BaselineId", + "OperationStartTime", + "OperationEndTime", + "Operation" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the managed instance the high-level patch compliance information was collected for.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group the managed instance belongs to.

    " + }, + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline used to patch the instance.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The ID of the patch baseline snapshot used during the patching operation when this compliance data was collected.

    " + }, + "InstallOverrideList":{ + "shape":"InstallOverrideList", + "documentation":"

    An https URL or an Amazon S3 path-style URL to a list of patches to be installed. This patch installation list, which you maintain in an Amazon S3 bucket in YAML format and specify in the SSM document AWS-RunPatchBaseline, overrides the patches specified by the default patch baseline.

    For more information about the InstallOverrideList parameter, see About the SSM Document AWS-RunPatchBaseline in the AWS Systems Manager User Guide.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    Placeholder information. This field will always be empty in the current release of the service.

    " + }, + "InstalledCount":{ + "shape":"PatchInstalledCount", + "documentation":"

    The number of patches from the patch baseline that are installed on the instance.

    " + }, + "InstalledOtherCount":{ + "shape":"PatchInstalledOtherCount", + "documentation":"

    The number of patches not specified in the patch baseline that are installed on the instance.

    " + }, + "InstalledRejectedCount":{ + "shape":"PatchInstalledRejectedCount", + "documentation":"

    The number of instances with patches installed that are specified in a RejectedPatches list. Patches with a status of InstalledRejected were typically installed before they were added to a RejectedPatches list.

    If ALLOW_AS_DEPENDENCY is the specified option for RejectedPatchesAction, the value of InstalledRejectedCount will always be 0 (zero).

    ", + "box":true + }, + "MissingCount":{ + "shape":"PatchMissingCount", + "documentation":"

    The number of patches from the patch baseline that are applicable for the instance but aren't currently installed.

    " + }, + "FailedCount":{ + "shape":"PatchFailedCount", + "documentation":"

    The number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install.

    " + }, + "UnreportedNotApplicableCount":{ + "shape":"PatchUnreportedNotApplicableCount", + "documentation":"

    The number of patches beyond the supported limit of NotApplicableCount that are not reported by name to Systems Manager Inventory.

    ", + "box":true + }, + "NotApplicableCount":{ + "shape":"PatchNotApplicableCount", + "documentation":"

    The number of patches from the patch baseline that aren't applicable for the instance and therefore aren't installed on the instance. This number may be truncated if the list of patch names is very large. The number of patches beyond this limit are reported in UnreportedNotApplicableCount.

    " + }, + "OperationStartTime":{ + "shape":"DateTime", + "documentation":"

    The time the most recent patching operation was started on the instance.

    " + }, + "OperationEndTime":{ + "shape":"DateTime", + "documentation":"

    The time the most recent patching operation completed on the instance.

    " + }, + "Operation":{ + "shape":"PatchOperationType", + "documentation":"

    The type of patching operation that was performed: SCAN (assess patch compliance state) or INSTALL (install missing patches).

    " + } + }, + "documentation":"

    Defines the high-level patch compliance state for a managed instance, providing information about the number of installed, missing, not applicable, and failed patches along with metadata about the operation when this information was gathered for the instance.

    " + }, + "InstancePatchStateFilter":{ + "type":"structure", + "required":[ + "Key", + "Values", + "Type" + ], + "members":{ + "Key":{ + "shape":"InstancePatchStateFilterKey", + "documentation":"

    The key for the filter. Supported values are FailedCount, InstalledCount, InstalledOtherCount, MissingCount and NotApplicableCount.

    " + }, + "Values":{ + "shape":"InstancePatchStateFilterValues", + "documentation":"

    The value for the filter, must be an integer greater than or equal to 0.

    " + }, + "Type":{ + "shape":"InstancePatchStateOperatorType", + "documentation":"

    The type of comparison that should be performed for the value: Equal, NotEqual, LessThan or GreaterThan.

    " + } + }, + "documentation":"

    Defines a filter used in DescribeInstancePatchStatesForPatchGroup used to scope down the information returned by the API.

    " + }, + "InstancePatchStateFilterKey":{ + "type":"string", + "max":200, + "min":1 + }, + "InstancePatchStateFilterList":{ + "type":"list", + "member":{"shape":"InstancePatchStateFilter"}, + "max":4, + "min":0 + }, + "InstancePatchStateFilterValue":{"type":"string"}, + "InstancePatchStateFilterValues":{ + "type":"list", + "member":{"shape":"InstancePatchStateFilterValue"}, + "max":1, + "min":1 + }, + "InstancePatchStateList":{ + "type":"list", + "member":{"shape":"InstancePatchState"} + }, + "InstancePatchStateOperatorType":{ + "type":"string", + "enum":[ + "Equal", + "NotEqual", + "LessThan", + "GreaterThan" + ] + }, + "InstancePatchStatesList":{ + "type":"list", + "member":{"shape":"InstancePatchState"}, + "max":5, + "min":1 + }, + "InstanceTagName":{ + "type":"string", + "max":255 + }, + "InstancesCount":{"type":"integer"}, + "Integer":{"type":"integer"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    An error occurred on the server side.

    ", + "exception":true, + "fault":true + }, + "InvalidActivation":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The activation is not valid. The activation might have been deleted, or the ActivationId and the ActivationCode do not match.

    ", + "exception":true + }, + "InvalidActivationId":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The activation ID is not valid. Verify the you entered the correct ActivationId or ActivationCode and try again.

    ", + "exception":true + }, + "InvalidAggregatorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified aggregator is not valid for inventory groups. Verify that the aggregator uses a valid inventory type such as AWS:Application or AWS:InstanceInformation.

    ", + "exception":true + }, + "InvalidAllowedPatternException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

    The request does not meet the regular expression requirement.

    " + } + }, + "documentation":"

    The request does not meet the regular expression requirement.

    ", + "exception":true + }, + "InvalidAssociation":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The association is not valid or does not exist.

    ", + "exception":true + }, + "InvalidAssociationVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The version you specified is not valid. Use ListAssociationVersions to view all versions of an association according to the association ID. Or, use the $LATEST parameter to view the latest version of the association.

    ", + "exception":true + }, + "InvalidAutomationExecutionParametersException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The supplied parameters for invoking the specified Automation document are incorrect. For example, they may not match the set of parameters permitted for the specified Automation document.

    ", + "exception":true + }, + "InvalidAutomationSignalException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The signal is not valid for the current Automation execution.

    ", + "exception":true + }, + "InvalidAutomationStatusUpdateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified update status operation is not valid.

    ", + "exception":true + }, + "InvalidCommandId":{ + "type":"structure", + "members":{ + }, + "exception":true + }, + "InvalidDeleteInventoryParametersException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    One or more of the parameters specified for the delete operation is not valid. Verify all parameters and try again.

    ", + "exception":true + }, + "InvalidDeletionIdException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The ID specified for the delete operation does not exist or is not valid. Verify the ID and try again.

    ", + "exception":true + }, + "InvalidDocument":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

    The document does not exist or the document is not available to the user. This exception can be issued by CreateAssociation, CreateAssociationBatch, DeleteAssociation, DeleteDocument, DescribeAssociation, DescribeDocument, GetDocument, SendCommand, or UpdateAssociationStatus.

    " + } + }, + "documentation":"

    The specified document does not exist.

    ", + "exception":true + }, + "InvalidDocumentContent":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"String", + "documentation":"

    A description of the validation error.

    " + } + }, + "documentation":"

    The content for the document is not valid.

    ", + "exception":true + }, + "InvalidDocumentOperation":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You attempted to delete a document while it is still shared. You must stop sharing the document before you can delete it.

    ", + "exception":true + }, + "InvalidDocumentSchemaVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The version of the document schema is not supported.

    ", + "exception":true + }, + "InvalidDocumentVersion":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The document version is not valid or does not exist.

    ", + "exception":true + }, + "InvalidFilter":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The filter name is not valid. Verify the you entered the correct name and try again.

    ", + "exception":true + }, + "InvalidFilterKey":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The specified key is not valid.

    ", + "exception":true + }, + "InvalidFilterOption":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

    The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

    " + } + }, + "documentation":"

    The specified filter option is not valid. Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

    ", + "exception":true + }, + "InvalidFilterValue":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The filter value is not valid. Verify the value and try again.

    ", + "exception":true + }, + "InvalidInstanceId":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The following problems can cause this exception:

    You do not have permission to access the instance.

    SSM Agent is not running. Verify that SSM Agent is running.

    SSM Agent is not registered with the SSM endpoint. Try reinstalling SSM Agent.

    The instance is not in valid state. Valid states are: Running, Pending, Stopped, Stopping. Invalid states are: Shutting-down and Terminated.

    ", + "exception":true + }, + "InvalidInstanceInformationFilterValue":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified filter value is not valid.

    ", + "exception":true + }, + "InvalidInventoryGroupException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified inventory group is not valid.

    ", + "exception":true + }, + "InvalidInventoryItemContextException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You specified invalid keys or values in the Context attribute for InventoryItem. Verify the keys and values, and try again.

    ", + "exception":true + }, + "InvalidInventoryRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The request is not valid.

    ", + "exception":true + }, + "InvalidItemContentException":{ + "type":"structure", + "members":{ + "TypeName":{"shape":"InventoryItemTypeName"}, + "Message":{"shape":"String"} + }, + "documentation":"

    One or more content items is not valid.

    ", + "exception":true + }, + "InvalidKeyId":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The query key ID is not valid.

    ", + "exception":true + }, + "InvalidNextToken":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified token is not valid.

    ", + "exception":true + }, + "InvalidNotificationConfig":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    One or more configuration items is not valid. Verify that a valid Amazon Resource Name (ARN) was provided for an Amazon SNS topic.

    ", + "exception":true + }, + "InvalidOptionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The delete inventory option specified is not valid. Verify the option and try again.

    ", + "exception":true + }, + "InvalidOutputFolder":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The S3 bucket does not exist.

    ", + "exception":true + }, + "InvalidOutputLocation":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The output location is not valid or does not exist.

    ", + "exception":true + }, + "InvalidParameters":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You must specify values for all required parameters in the Systems Manager document. You can only supply values to parameters defined in the Systems Manager document.

    ", + "exception":true + }, + "InvalidPermissionType":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The permission type is not supported. Share is the only supported permission type.

    ", + "exception":true + }, + "InvalidPluginName":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The plugin name is not valid.

    ", + "exception":true + }, + "InvalidPolicyAttributeException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A policy attribute or its value is invalid.

    ", + "exception":true + }, + "InvalidPolicyTypeException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The policy type is not supported. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

    ", + "exception":true + }, + "InvalidResourceId":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The resource ID is not valid. Verify that you entered the correct ID and try again.

    ", + "exception":true + }, + "InvalidResourceType":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The resource type is not valid. For example, if you are attempting to tag an instance, the instance must be a registered, managed instance.

    ", + "exception":true + }, + "InvalidResultAttributeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified inventory item result attribute is not valid.

    ", + "exception":true + }, + "InvalidRole":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about configuring the IAM role for Run Command notifications, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

    ", + "exception":true + }, + "InvalidSchedule":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The schedule is invalid. Verify your cron or rate expression and try again.

    ", + "exception":true + }, + "InvalidTarget":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The target is not valid or does not exist. It might not be configured for EC2 Systems Manager or you might not have permission to perform the operation.

    ", + "exception":true + }, + "InvalidTypeNameException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The parameter type name is not valid.

    ", + "exception":true + }, + "InvalidUpdate":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The update is not valid.

    ", + "exception":true + }, + "InventoryAggregator":{ + "type":"structure", + "members":{ + "Expression":{ + "shape":"InventoryAggregatorExpression", + "documentation":"

    The inventory type and attribute name for aggregation.

    " + }, + "Aggregators":{ + "shape":"InventoryAggregatorList", + "documentation":"

    Nested aggregators to further refine aggregation for an inventory type.

    " + }, + "Groups":{ + "shape":"InventoryGroupList", + "documentation":"

    A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

    " + } + }, + "documentation":"

    Specifies the inventory type and attribute for the aggregation execution.

    " + }, + "InventoryAggregatorExpression":{ + "type":"string", + "max":1000, + "min":1 + }, + "InventoryAggregatorList":{ + "type":"list", + "member":{"shape":"InventoryAggregator"}, + "max":10, + "min":1 + }, + "InventoryAttributeDataType":{ + "type":"string", + "enum":[ + "string", + "number" + ] + }, + "InventoryDeletionId":{"type":"string"}, + "InventoryDeletionLastStatusMessage":{"type":"string"}, + "InventoryDeletionLastStatusUpdateTime":{"type":"timestamp"}, + "InventoryDeletionStartTime":{"type":"timestamp"}, + "InventoryDeletionStatus":{ + "type":"string", + "enum":[ + "InProgress", + "Complete" + ] + }, + "InventoryDeletionStatusItem":{ + "type":"structure", + "members":{ + "DeletionId":{ + "shape":"InventoryDeletionId", + "documentation":"

    The deletion ID returned by the DeleteInventory action.

    " + }, + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the inventory data type.

    " + }, + "DeletionStartTime":{ + "shape":"InventoryDeletionStartTime", + "documentation":"

    The UTC timestamp when the delete operation started.

    " + }, + "LastStatus":{ + "shape":"InventoryDeletionStatus", + "documentation":"

    The status of the operation. Possible values are InProgress and Complete.

    " + }, + "LastStatusMessage":{ + "shape":"InventoryDeletionLastStatusMessage", + "documentation":"

    Information about the status.

    " + }, + "DeletionSummary":{ + "shape":"InventoryDeletionSummary", + "documentation":"

    Information about the delete operation. For more information about this summary, see Understanding the Delete Inventory Summary in the AWS Systems Manager User Guide.

    " + }, + "LastStatusUpdateTime":{ + "shape":"InventoryDeletionLastStatusUpdateTime", + "documentation":"

    The UTC timestamp of when the last status report.

    " + } + }, + "documentation":"

    Status information returned by the DeleteInventory action.

    " + }, + "InventoryDeletionSummary":{ + "type":"structure", + "members":{ + "TotalCount":{ + "shape":"TotalCount", + "documentation":"

    The total number of items to delete. This count does not change during the delete operation.

    " + }, + "RemainingCount":{ + "shape":"RemainingCount", + "documentation":"

    Remaining number of items to delete.

    " + }, + "SummaryItems":{ + "shape":"InventoryDeletionSummaryItems", + "documentation":"

    A list of counts and versions for deleted items.

    " + } + }, + "documentation":"

    Information about the delete operation.

    " + }, + "InventoryDeletionSummaryItem":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"InventoryItemSchemaVersion", + "documentation":"

    The inventory type version.

    " + }, + "Count":{ + "shape":"ResourceCount", + "documentation":"

    A count of the number of deleted items.

    " + }, + "RemainingCount":{ + "shape":"RemainingCount", + "documentation":"

    The remaining number of items to delete.

    " + } + }, + "documentation":"

    Either a count, remaining count, or a version number in a delete inventory summary.

    " + }, + "InventoryDeletionSummaryItems":{ + "type":"list", + "member":{"shape":"InventoryDeletionSummaryItem"} + }, + "InventoryDeletionsList":{ + "type":"list", + "member":{"shape":"InventoryDeletionStatusItem"} + }, + "InventoryFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"InventoryFilterKey", + "documentation":"

    The name of the filter key.

    " + }, + "Values":{ + "shape":"InventoryFilterValueList", + "documentation":"

    Inventory filter values. Example: inventory filter where instance IDs are specified as values Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g, i-1a2b3c4d5e6,Type=Equal

    " + }, + "Type":{ + "shape":"InventoryQueryOperatorType", + "documentation":"

    The type of filter. Valid values include the following: \"Equal\"|\"NotEqual\"|\"BeginWith\"|\"LessThan\"|\"GreaterThan\"

    " + } + }, + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "InventoryFilterKey":{ + "type":"string", + "max":200, + "min":1 + }, + "InventoryFilterList":{ + "type":"list", + "member":{"shape":"InventoryFilter"}, + "max":5, + "min":1 + }, + "InventoryFilterValue":{"type":"string"}, + "InventoryFilterValueList":{ + "type":"list", + "member":{"shape":"InventoryFilterValue"}, + "max":40, + "min":1 + }, + "InventoryGroup":{ + "type":"structure", + "required":[ + "Name", + "Filters" + ], + "members":{ + "Name":{ + "shape":"InventoryGroupName", + "documentation":"

    The name of the group.

    " + }, + "Filters":{ + "shape":"InventoryFilterList", + "documentation":"

    Filters define the criteria for the group. The matchingCount field displays the number of resources that match the criteria. The notMatchingCount field displays the number of resources that don't match the criteria.

    " + } + }, + "documentation":"

    A user-defined set of one or more filters on which to aggregate inventory data. Groups return a count of resources that match and don't match the specified criteria.

    " + }, + "InventoryGroupList":{ + "type":"list", + "member":{"shape":"InventoryGroup"}, + "max":15, + "min":1 + }, + "InventoryGroupName":{ + "type":"string", + "max":200, + "min":1 + }, + "InventoryItem":{ + "type":"structure", + "required":[ + "TypeName", + "SchemaVersion", + "CaptureTime" + ], + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

    " + }, + "SchemaVersion":{ + "shape":"InventoryItemSchemaVersion", + "documentation":"

    The schema version for the inventory item.

    " + }, + "CaptureTime":{ + "shape":"InventoryItemCaptureTime", + "documentation":"

    The time the inventory information was collected.

    " + }, + "ContentHash":{ + "shape":"InventoryItemContentHash", + "documentation":"

    MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

    " + }, + "Content":{ + "shape":"InventoryItemEntryList", + "documentation":"

    The inventory data of the inventory type.

    " + }, + "Context":{ + "shape":"InventoryItemContentContext", + "documentation":"

    A map of associated properties for a specified inventory type. For example, with this attribute, you can specify the ExecutionId, ExecutionType, ComplianceType properties of the AWS:ComplianceItem type.

    " + } + }, + "documentation":"

    Information collected from managed instances based on your inventory policy document

    " + }, + "InventoryItemAttribute":{ + "type":"structure", + "required":[ + "Name", + "DataType" + ], + "members":{ + "Name":{ + "shape":"InventoryItemAttributeName", + "documentation":"

    Name of the inventory item attribute.

    " + }, + "DataType":{ + "shape":"InventoryAttributeDataType", + "documentation":"

    The data type of the inventory item attribute.

    " + } + }, + "documentation":"

    Attributes are the entries within the inventory item content. It contains name and value.

    " + }, + "InventoryItemAttributeList":{ + "type":"list", + "member":{"shape":"InventoryItemAttribute"}, + "max":50, + "min":1 + }, + "InventoryItemAttributeName":{"type":"string"}, + "InventoryItemCaptureTime":{ + "type":"string", + "pattern":"^(20)[0-9][0-9]-(0[1-9]|1[012])-([12][0-9]|3[01]|0[1-9])(T)(2[0-3]|[0-1][0-9])(:[0-5][0-9])(:[0-5][0-9])(Z)$" + }, + "InventoryItemContentContext":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "max":50, + "min":0 + }, + "InventoryItemContentHash":{ + "type":"string", + "max":256 + }, + "InventoryItemEntry":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "max":50, + "min":0 + }, + "InventoryItemEntryList":{ + "type":"list", + "member":{"shape":"InventoryItemEntry"}, + "max":10000, + "min":0 + }, + "InventoryItemList":{ + "type":"list", + "member":{"shape":"InventoryItem"}, + "max":30, + "min":1 + }, + "InventoryItemSchema":{ + "type":"structure", + "required":[ + "TypeName", + "Attributes" + ], + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the inventory type. Default inventory item type names start with AWS. Custom inventory type names will start with Custom. Default inventory item types include the following: AWS:AWSComponent, AWS:Application, AWS:InstanceInformation, AWS:Network, and AWS:WindowsUpdate.

    " + }, + "Version":{ + "shape":"InventoryItemSchemaVersion", + "documentation":"

    The schema version for the inventory item.

    " + }, + "Attributes":{ + "shape":"InventoryItemAttributeList", + "documentation":"

    The schema attributes for inventory. This contains data type and attribute name.

    " + }, + "DisplayName":{ + "shape":"InventoryTypeDisplayName", + "documentation":"

    The alias name of the inventory type. The alias name is used for display purposes.

    " + } + }, + "documentation":"

    The inventory item schema definition. Users can use this to compose inventory query filters.

    " + }, + "InventoryItemSchemaResultList":{ + "type":"list", + "member":{"shape":"InventoryItemSchema"} + }, + "InventoryItemSchemaVersion":{ + "type":"string", + "pattern":"^([0-9]{1,6})(\\.[0-9]{1,6})$" + }, + "InventoryItemTypeName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^(AWS|Custom):.*$" + }, + "InventoryItemTypeNameFilter":{ + "type":"string", + "max":100, + "min":0 + }, + "InventoryQueryOperatorType":{ + "type":"string", + "enum":[ + "Equal", + "NotEqual", + "BeginWith", + "LessThan", + "GreaterThan", + "Exists" + ] + }, + "InventoryResultEntity":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"InventoryResultEntityId", + "documentation":"

    ID of the inventory result entity. For example, for managed instance inventory the result will be the managed instance ID. For EC2 instance inventory, the result will be the instance ID.

    " + }, + "Data":{ + "shape":"InventoryResultItemMap", + "documentation":"

    The data section in the inventory result entity JSON.

    " + } + }, + "documentation":"

    Inventory query results.

    " + }, + "InventoryResultEntityId":{"type":"string"}, + "InventoryResultEntityList":{ + "type":"list", + "member":{"shape":"InventoryResultEntity"} + }, + "InventoryResultItem":{ + "type":"structure", + "required":[ + "TypeName", + "SchemaVersion", + "Content" + ], + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The name of the inventory result item type.

    " + }, + "SchemaVersion":{ + "shape":"InventoryItemSchemaVersion", + "documentation":"

    The schema version for the inventory result item/

    " + }, + "CaptureTime":{ + "shape":"InventoryItemCaptureTime", + "documentation":"

    The time inventory item data was captured.

    " + }, + "ContentHash":{ + "shape":"InventoryItemContentHash", + "documentation":"

    MD5 hash of the inventory item type contents. The content hash is used to determine whether to update inventory information. The PutInventory API does not update the inventory item type contents if the MD5 hash has not changed since last update.

    " + }, + "Content":{ + "shape":"InventoryItemEntryList", + "documentation":"

    Contains all the inventory data of the item type. Results include attribute names and values.

    " + } + }, + "documentation":"

    The inventory result item.

    " + }, + "InventoryResultItemKey":{"type":"string"}, + "InventoryResultItemMap":{ + "type":"map", + "key":{"shape":"InventoryResultItemKey"}, + "value":{"shape":"InventoryResultItem"} + }, + "InventorySchemaDeleteOption":{ + "type":"string", + "enum":[ + "DisableSchema", + "DeleteSchema" + ] + }, + "InventoryTypeDisplayName":{"type":"string"}, + "InvocationDoesNotExist":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The command ID and instance ID you specified did not match any invocations. Verify the command ID and the instance ID and try again.

    ", + "exception":true + }, + "InvocationTraceOutput":{ + "type":"string", + "max":2500 + }, + "IsSubTypeSchema":{"type":"boolean"}, + "ItemContentMismatchException":{ + "type":"structure", + "members":{ + "TypeName":{"shape":"InventoryItemTypeName"}, + "Message":{"shape":"String"} + }, + "documentation":"

    The inventory item has invalid content.

    ", + "exception":true + }, + "ItemSizeLimitExceededException":{ + "type":"structure", + "members":{ + "TypeName":{"shape":"InventoryItemTypeName"}, + "Message":{"shape":"String"} + }, + "documentation":"

    The inventory item size has exceeded the size limit.

    ", + "exception":true + }, + "KeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "LabelParameterVersionRequest":{ + "type":"structure", + "required":[ + "Name", + "Labels" + ], + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The parameter name on which you want to attach one or more labels.

    " + }, + "ParameterVersion":{ + "shape":"PSParameterVersion", + "documentation":"

    The specific version of the parameter on which you want to attach one or more labels. If no version is specified, the system attaches the label to the latest version.

    ", + "box":true + }, + "Labels":{ + "shape":"ParameterLabelList", + "documentation":"

    One or more labels to attach to the specified parameter version.

    " + } + } + }, + "LabelParameterVersionResult":{ + "type":"structure", + "members":{ + "InvalidLabels":{ + "shape":"ParameterLabelList", + "documentation":"

    The label does not meet the requirements. For information about parameter label requirements, see Labeling Parameters in the AWS Systems Manager User Guide.

    " + }, + "ParameterVersion":{ + "shape":"PSParameterVersion", + "documentation":"

    The version of the parameter that has been labeled.

    " + } + } + }, + "LastResourceDataSyncMessage":{"type":"string"}, + "LastResourceDataSyncStatus":{ + "type":"string", + "enum":[ + "Successful", + "Failed", + "InProgress" + ] + }, + "LastResourceDataSyncTime":{"type":"timestamp"}, + "LastSuccessfulResourceDataSyncTime":{"type":"timestamp"}, + "ListAssociationVersionsRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The association ID for which you want to view all versions.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + } + } + }, + "ListAssociationVersionsResult":{ + "type":"structure", + "members":{ + "AssociationVersions":{ + "shape":"AssociationVersionList", + "documentation":"

    Information about all versions of the association for the specified association ID.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "ListAssociationsRequest":{ + "type":"structure", + "members":{ + "AssociationFilterList":{ + "shape":"AssociationFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "ListAssociationsResult":{ + "type":"structure", + "members":{ + "Associations":{ + "shape":"AssociationList", + "documentation":"

    The associations.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "ListCommandInvocationsRequest":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    (Optional) The invocations for a specific command ID.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    (Optional) The command execution details for a specific instance ID.

    " + }, + "MaxResults":{ + "shape":"CommandMaxResults", + "documentation":"

    (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "Filters":{ + "shape":"CommandFilterList", + "documentation":"

    (Optional) One or more filters. Use a filter to return a more specific list of results.

    " + }, + "Details":{ + "shape":"Boolean", + "documentation":"

    (Optional) If set this returns the response of the command executions and any command output. By default this is set to False.

    " + } + } + }, + "ListCommandInvocationsResult":{ + "type":"structure", + "members":{ + "CommandInvocations":{ + "shape":"CommandInvocationList", + "documentation":"

    (Optional) A list of all invocations.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "ListCommandsRequest":{ + "type":"structure", + "members":{ + "CommandId":{ + "shape":"CommandId", + "documentation":"

    (Optional) If provided, lists only the specified command.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    (Optional) Lists commands issued against this instance ID.

    " + }, + "MaxResults":{ + "shape":"CommandMaxResults", + "documentation":"

    (Optional) The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "Filters":{ + "shape":"CommandFilterList", + "documentation":"

    (Optional) One or more filters. Use a filter to return a more specific list of results.

    " + } + } + }, + "ListCommandsResult":{ + "type":"structure", + "members":{ + "Commands":{ + "shape":"CommandList", + "documentation":"

    (Optional) The list of commands requested by the user.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    (Optional) The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "ListComplianceItemsRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ComplianceStringFilterList", + "documentation":"

    One or more compliance filters. Use a filter to return a more specific list of results.

    " + }, + "ResourceIds":{ + "shape":"ComplianceResourceIdList", + "documentation":"

    The ID for the resources from which to get compliance information. Currently, you can only specify one resource ID.

    " + }, + "ResourceTypes":{ + "shape":"ComplianceResourceTypeList", + "documentation":"

    The type of resource from which to get compliance information. Currently, the only supported resource type is ManagedInstance.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "ListComplianceItemsResult":{ + "type":"structure", + "members":{ + "ComplianceItems":{ + "shape":"ComplianceItemList", + "documentation":"

    A list of compliance information for the specified resource ID.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "ListComplianceSummariesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ComplianceStringFilterList", + "documentation":"

    One or more compliance or inventory filters. Use a filter to return a more specific list of results.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. Currently, you can specify null or 50. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "ListComplianceSummariesResult":{ + "type":"structure", + "members":{ + "ComplianceSummaryItems":{ + "shape":"ComplianceSummaryItemList", + "documentation":"

    A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "ListDocumentVersionsRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document about which you want version information.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "ListDocumentVersionsResult":{ + "type":"structure", + "members":{ + "DocumentVersions":{ + "shape":"DocumentVersionList", + "documentation":"

    The document versions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "ListDocumentsRequest":{ + "type":"structure", + "members":{ + "DocumentFilterList":{ + "shape":"DocumentFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "Filters":{ + "shape":"DocumentKeyValuesFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + } + } + }, + "ListDocumentsResult":{ + "type":"structure", + "members":{ + "DocumentIdentifiers":{ + "shape":"DocumentIdentifierList", + "documentation":"

    The names of the Systems Manager documents.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "ListInventoryEntriesRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "TypeName" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID for which you want inventory information.

    " + }, + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The type of inventory item for which you want information.

    " + }, + "Filters":{ + "shape":"InventoryFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. (You received this token from a previous call.)

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "ListInventoryEntriesResult":{ + "type":"structure", + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    The type of inventory item returned by the request.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The instance ID targeted by the request to query inventory information.

    " + }, + "SchemaVersion":{ + "shape":"InventoryItemSchemaVersion", + "documentation":"

    The inventory schema version used by the instance(s).

    " + }, + "CaptureTime":{ + "shape":"InventoryItemCaptureTime", + "documentation":"

    The time that inventory information was collected for the instance(s).

    " + }, + "Entries":{ + "shape":"InventoryItemEntryList", + "documentation":"

    A list of inventory items on the instance(s).

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.

    " + } + } + }, + "ListResourceComplianceSummariesRequest":{ + "type":"structure", + "members":{ + "Filters":{ + "shape":"ComplianceStringFilterList", + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "ListResourceComplianceSummariesResult":{ + "type":"structure", + "members":{ + "ResourceComplianceSummaryItems":{ + "shape":"ResourceComplianceSummaryItemList", + "documentation":"

    A summary count for specified or targeted managed instances. Summary count includes information about compliant and non-compliant State Manager associations, patch status, or custom items according to the filter criteria that you specify.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "ListResourceDataSyncRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    A token to start the list. Use this token to get the next set of results.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

    ", + "box":true + } + } + }, + "ListResourceDataSyncResult":{ + "type":"structure", + "members":{ + "ResourceDataSyncItems":{ + "shape":"ResourceDataSyncItemList", + "documentation":"

    A list of your current Resource Data Sync configurations and their statuses.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token for the next set of items to return. Use this token to get the next set of results.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId" + ], + "members":{ + "ResourceType":{ + "shape":"ResourceTypeForTagging", + "documentation":"

    Returns a list of tags for a specific resource type.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The resource ID for which you want to see a list of tags.

    " + } + } + }, + "ListTagsForResourceResult":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

    A list of tags.

    " + } + } + }, + "LoggingInfo":{ + "type":"structure", + "required":[ + "S3BucketName", + "S3Region" + ], + "members":{ + "S3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The name of an Amazon S3 bucket where execution logs are stored .

    " + }, + "S3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    (Optional) The Amazon S3 bucket subfolder.

    " + }, + "S3Region":{ + "shape":"S3Region", + "documentation":"

    The region where the Amazon S3 bucket is located.

    " + } + }, + "documentation":"

    Information about an Amazon S3 bucket to write instance-level logs to.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Long":{"type":"long"}, + "MaintenanceWindowAllowUnassociatedTargets":{"type":"boolean"}, + "MaintenanceWindowAutomationParameters":{ + "type":"structure", + "members":{ + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of an Automation document to use during task execution.

    " + }, + "Parameters":{ + "shape":"AutomationParameterMap", + "documentation":"

    The parameters for the AUTOMATION task.

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    For AUTOMATION task types, Systems Manager ignores any values specified for these parameters.

    " + } + }, + "documentation":"

    The parameters for an AUTOMATION task type.

    " + }, + "MaintenanceWindowCutoff":{ + "type":"integer", + "max":23, + "min":0 + }, + "MaintenanceWindowDescription":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "MaintenanceWindowDurationHours":{ + "type":"integer", + "max":24, + "min":1 + }, + "MaintenanceWindowEnabled":{"type":"boolean"}, + "MaintenanceWindowExecution":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window.

    " + }, + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The status of the execution.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the Status. Only available for certain status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution started.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time the execution finished.

    " + } + }, + "documentation":"

    Describes the information about an execution of a maintenance window.

    " + }, + "MaintenanceWindowExecutionId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + }, + "MaintenanceWindowExecutionList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowExecution"} + }, + "MaintenanceWindowExecutionStatus":{ + "type":"string", + "enum":[ + "PENDING", + "IN_PROGRESS", + "SUCCESS", + "FAILED", + "TIMED_OUT", + "CANCELLING", + "CANCELLED", + "SKIPPED_OVERLAPPING" + ] + }, + "MaintenanceWindowExecutionStatusDetails":{ + "type":"string", + "max":250, + "min":0 + }, + "MaintenanceWindowExecutionTaskExecutionId":{"type":"string"}, + "MaintenanceWindowExecutionTaskId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + }, + "MaintenanceWindowExecutionTaskIdList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowExecutionTaskId"} + }, + "MaintenanceWindowExecutionTaskIdentity":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that ran the task.

    " + }, + "TaskExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task execution in the maintenance window execution.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The status of the task execution.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the status of the task execution. Only available for certain status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time the task execution started.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time the task execution finished.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The ARN of the task that ran.

    " + }, + "TaskType":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The type of task that ran.

    " + } + }, + "documentation":"

    Information about a task execution performed as part of a maintenance window execution.

    " + }, + "MaintenanceWindowExecutionTaskIdentityList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowExecutionTaskIdentity"} + }, + "MaintenanceWindowExecutionTaskInvocationId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + }, + "MaintenanceWindowExecutionTaskInvocationIdentity":{ + "type":"structure", + "members":{ + "WindowExecutionId":{ + "shape":"MaintenanceWindowExecutionId", + "documentation":"

    The ID of the maintenance window execution that ran the task.

    " + }, + "TaskExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskId", + "documentation":"

    The ID of the specific task execution in the maintenance window execution.

    " + }, + "InvocationId":{ + "shape":"MaintenanceWindowExecutionTaskInvocationId", + "documentation":"

    The ID of the task invocation.

    " + }, + "ExecutionId":{ + "shape":"MaintenanceWindowExecutionTaskExecutionId", + "documentation":"

    The ID of the action performed in the service that actually handled the task invocation. If the task type is RUN_COMMAND, this value is the command ID.

    " + }, + "TaskType":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The task type.

    " + }, + "Parameters":{ + "shape":"MaintenanceWindowExecutionTaskInvocationParameters", + "documentation":"

    The parameters that were provided for the invocation when it was run.

    " + }, + "Status":{ + "shape":"MaintenanceWindowExecutionStatus", + "documentation":"

    The status of the task invocation.

    " + }, + "StatusDetails":{ + "shape":"MaintenanceWindowExecutionStatusDetails", + "documentation":"

    The details explaining the status of the task invocation. Only available for certain Status values.

    " + }, + "StartTime":{ + "shape":"DateTime", + "documentation":"

    The time the invocation started.

    " + }, + "EndTime":{ + "shape":"DateTime", + "documentation":"

    The time the invocation finished.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    User-provided value that was specified when the target was registered with the maintenance window. This was also included in any CloudWatch events raised during the task invocation.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTaskTargetId", + "documentation":"

    The ID of the target definition in this maintenance window the invocation was performed for.

    " + } + }, + "documentation":"

    Describes the information about a task invocation for a particular target as part of a task execution performed as part of a maintenance window execution.

    " + }, + "MaintenanceWindowExecutionTaskInvocationIdentityList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowExecutionTaskInvocationIdentity"} + }, + "MaintenanceWindowExecutionTaskInvocationParameters":{ + "type":"string", + "sensitive":true + }, + "MaintenanceWindowFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"MaintenanceWindowFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Values":{ + "shape":"MaintenanceWindowFilterValues", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    Filter used in the request. Supported filter keys are Name and Enabled.

    " + }, + "MaintenanceWindowFilterKey":{ + "type":"string", + "max":128, + "min":1 + }, + "MaintenanceWindowFilterList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowFilter"}, + "max":5, + "min":0 + }, + "MaintenanceWindowFilterValue":{ + "type":"string", + "max":256, + "min":1 + }, + "MaintenanceWindowFilterValues":{ + "type":"list", + "member":{"shape":"MaintenanceWindowFilterValue"} + }, + "MaintenanceWindowId":{ + "type":"string", + "max":20, + "min":20, + "pattern":"^mw-[0-9a-f]{17}$" + }, + "MaintenanceWindowIdentity":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    A description of the maintenance window.

    " + }, + "Enabled":{ + "shape":"MaintenanceWindowEnabled", + "documentation":"

    Indicates whether the maintenance window is enabled.

    " + }, + "Duration":{ + "shape":"MaintenanceWindowDurationHours", + "documentation":"

    The duration of the maintenance window in hours.

    " + }, + "Cutoff":{ + "shape":"MaintenanceWindowCutoff", + "documentation":"

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

    " + }, + "Schedule":{ + "shape":"MaintenanceWindowSchedule", + "documentation":"

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + }, + "ScheduleTimezone":{ + "shape":"MaintenanceWindowTimezone", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

    " + }, + "EndDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

    " + }, + "StartDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

    " + }, + "NextExecutionTime":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The next time the maintenance window will actually run, taking into account any specified times for the maintenance window to become active or inactive.

    " + } + }, + "documentation":"

    Information about the maintenance window.

    " + }, + "MaintenanceWindowIdentityForTarget":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + } + }, + "documentation":"

    The maintenance window to which the specified target belongs.

    " + }, + "MaintenanceWindowIdentityList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowIdentity"} + }, + "MaintenanceWindowLambdaClientContext":{ + "type":"string", + "max":8000, + "min":1 + }, + "MaintenanceWindowLambdaParameters":{ + "type":"structure", + "members":{ + "ClientContext":{ + "shape":"MaintenanceWindowLambdaClientContext", + "documentation":"

    Pass client-specific information to the Lambda function that you are invoking. You can then process the client information in your Lambda function as you choose through the context variable.

    " + }, + "Qualifier":{ + "shape":"MaintenanceWindowLambdaQualifier", + "documentation":"

    (Optional) Specify a Lambda function version or alias name. If you specify a function version, the action uses the qualified function ARN to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version to which the alias points.

    " + }, + "Payload":{ + "shape":"MaintenanceWindowLambdaPayload", + "documentation":"

    JSON to provide to your Lambda function as input.

    " + } + }, + "documentation":"

    The parameters for a LAMBDA task type.

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    For Lambda tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

    " + }, + "MaintenanceWindowLambdaPayload":{ + "type":"blob", + "max":4096, + "sensitive":true + }, + "MaintenanceWindowLambdaQualifier":{ + "type":"string", + "max":128, + "min":1 + }, + "MaintenanceWindowMaxResults":{ + "type":"integer", + "max":100, + "min":10 + }, + "MaintenanceWindowName":{ + "type":"string", + "max":128, + "min":3, + "pattern":"^[a-zA-Z0-9_\\-.]{3,128}$" + }, + "MaintenanceWindowResourceType":{ + "type":"string", + "enum":[ + "INSTANCE", + "RESOURCE_GROUP" + ] + }, + "MaintenanceWindowRunCommandParameters":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"Comment", + "documentation":"

    Information about the commands to run.

    " + }, + "DocumentHash":{ + "shape":"DocumentHash", + "documentation":"

    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

    " + }, + "DocumentHashType":{ + "shape":"DocumentHashType", + "documentation":"

    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.

    " + }, + "NotificationConfig":{ + "shape":"NotificationConfig", + "documentation":"

    Configurations for sending notifications about command status changes on a per-instance basis.

    " + }, + "OutputS3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The name of the Amazon S3 bucket.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The Amazon S3 bucket subfolder.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    The parameters for the RUN_COMMAND task execution.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

    " + }, + "TimeoutSeconds":{ + "shape":"TimeoutSeconds", + "documentation":"

    If this time is reached and the command has not already started running, it doesn't run.

    ", + "box":true + } + }, + "documentation":"

    The parameters for a RUN_COMMAND task type.

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

    " + }, + "MaintenanceWindowSchedule":{ + "type":"string", + "max":256, + "min":1 + }, + "MaintenanceWindowSearchMaxResults":{ + "type":"integer", + "min":1 + }, + "MaintenanceWindowStepFunctionsInput":{ + "type":"string", + "max":4096, + "sensitive":true + }, + "MaintenanceWindowStepFunctionsName":{ + "type":"string", + "max":80, + "min":1 + }, + "MaintenanceWindowStepFunctionsParameters":{ + "type":"structure", + "members":{ + "Input":{ + "shape":"MaintenanceWindowStepFunctionsInput", + "documentation":"

    The inputs for the STEP_FUNCTIONS task.

    " + }, + "Name":{ + "shape":"MaintenanceWindowStepFunctionsName", + "documentation":"

    The name of the STEP_FUNCTIONS task.

    " + } + }, + "documentation":"

    The parameters for a STEP_FUNCTIONS task.

    For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    For Step Functions tasks, Systems Manager ignores any values specified for TaskParameters and LoggingInfo.

    " + }, + "MaintenanceWindowStringDateTime":{"type":"string"}, + "MaintenanceWindowTarget":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window to register the target with.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The ID of the target.

    " + }, + "ResourceType":{ + "shape":"MaintenanceWindowResourceType", + "documentation":"

    The type of target that is being registered with the maintenance window.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets, either instances or tags.

    Specify instances using the following format:

    Key=instanceids,Values=<instanceid1>,<instanceid2>

    Tags are specified using the following format:

    Key=<tag name>,Values=<tag value>.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    A user-provided value that will be included in any CloudWatch events that are raised while running tasks for these targets in this maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name for the maintenance window target.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    A description for the target.

    " + } + }, + "documentation":"

    The target registered with the maintenance window.

    " + }, + "MaintenanceWindowTargetId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + }, + "MaintenanceWindowTargetList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowTarget"} + }, + "MaintenanceWindowTask":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window where the task is registered.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The task ID.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the Systems Manager document name or ARN. For LAMBDA tasks, it's the function name or ARN. For STEP_FUNCTIONS tasks, it's the state machine ARN.

    " + }, + "Type":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The type of task. The type can be one of the following: RUN_COMMAND, AUTOMATION, LAMBDA, or STEP_FUNCTIONS.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets (either instances or tags). Instances are specified using Key=instanceids,Values=<instanceid1>,<instanceid2>. Tags are specified using Key=<tag name>,Values=<tag value>.

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParameters", + "documentation":"

    The parameters that should be passed to the task when it is run.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    " + }, + "LoggingInfo":{ + "shape":"LoggingInfo", + "documentation":"

    Information about an Amazon S3 bucket to write task-level logs to.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets this task can be run for, in parallel.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed before this task stops being scheduled.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The task name.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    A description of the task.

    " + } + }, + "documentation":"

    Information about a task defined for a maintenance window.

    " + }, + "MaintenanceWindowTaskArn":{ + "type":"string", + "max":1600, + "min":1 + }, + "MaintenanceWindowTaskId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" + }, + "MaintenanceWindowTaskInvocationParameters":{ + "type":"structure", + "members":{ + "RunCommand":{ + "shape":"MaintenanceWindowRunCommandParameters", + "documentation":"

    The parameters for a RUN_COMMAND task type.

    " + }, + "Automation":{ + "shape":"MaintenanceWindowAutomationParameters", + "documentation":"

    The parameters for an AUTOMATION task type.

    " + }, + "StepFunctions":{ + "shape":"MaintenanceWindowStepFunctionsParameters", + "documentation":"

    The parameters for a STEP_FUNCTIONS task type.

    " + }, + "Lambda":{ + "shape":"MaintenanceWindowLambdaParameters", + "documentation":"

    The parameters for a LAMBDA task type.

    " + } + }, + "documentation":"

    The parameters for task execution.

    " + }, + "MaintenanceWindowTaskList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowTask"} + }, + "MaintenanceWindowTaskParameterName":{ + "type":"string", + "max":255, + "min":1 + }, + "MaintenanceWindowTaskParameterValue":{ + "type":"string", + "max":255, + "min":1, + "sensitive":true + }, + "MaintenanceWindowTaskParameterValueExpression":{ + "type":"structure", + "members":{ + "Values":{ + "shape":"MaintenanceWindowTaskParameterValueList", + "documentation":"

    This field contains an array of 0 or more strings, each 1 to 255 characters in length.

    " + } + }, + "documentation":"

    Defines the values for a task parameter.

    ", + "sensitive":true + }, + "MaintenanceWindowTaskParameterValueList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowTaskParameterValue"}, + "sensitive":true + }, + "MaintenanceWindowTaskParameters":{ + "type":"map", + "key":{"shape":"MaintenanceWindowTaskParameterName"}, + "value":{"shape":"MaintenanceWindowTaskParameterValueExpression"}, + "sensitive":true + }, + "MaintenanceWindowTaskParametersList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowTaskParameters"}, + "sensitive":true + }, + "MaintenanceWindowTaskPriority":{ + "type":"integer", + "min":0 + }, + "MaintenanceWindowTaskTargetId":{ + "type":"string", + "max":36 + }, + "MaintenanceWindowTaskType":{ + "type":"string", + "enum":[ + "RUN_COMMAND", + "AUTOMATION", + "STEP_FUNCTIONS", + "LAMBDA" + ] + }, + "MaintenanceWindowTimezone":{"type":"string"}, + "MaintenanceWindowsForTargetList":{ + "type":"list", + "member":{"shape":"MaintenanceWindowIdentityForTarget"} + }, + "ManagedInstanceId":{ + "type":"string", + "pattern":"^mi-[0-9a-f]{17}$" + }, + "MaxConcurrency":{ + "type":"string", + "max":7, + "min":1, + "pattern":"^([1-9][0-9]*|[1-9][0-9]%|[1-9]%|100%)$" + }, + "MaxDocumentSizeExceeded":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The size limit of a document is 64 KB.

    ", + "exception":true + }, + "MaxErrors":{ + "type":"string", + "max":7, + "min":1, + "pattern":"^([1-9][0-9]*|[0]|[1-9][0-9]%|[0-9]%|100%)$" + }, + "MaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxResultsEC2Compatible":{ + "type":"integer", + "max":50, + "min":5 + }, + "ModifyDocumentPermissionRequest":{ + "type":"structure", + "required":[ + "Name", + "PermissionType" + ], + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document that you want to share.

    " + }, + "PermissionType":{ + "shape":"DocumentPermissionType", + "documentation":"

    The permission type for the document. The permission type can be Share.

    " + }, + "AccountIdsToAdd":{ + "shape":"AccountIdList", + "documentation":"

    The AWS user accounts that should have access to the document. The account IDs can either be a group of account IDs or All.

    " + }, + "AccountIdsToRemove":{ + "shape":"AccountIdList", + "documentation":"

    The AWS user accounts that should no longer have access to the document. The AWS user account can either be a group of account IDs or All. This action has a higher priority than AccountIdsToAdd. If you specify an account ID to add and the same ID to remove, the system removes access to the document.

    " + } + } + }, + "ModifyDocumentPermissionResponse":{ + "type":"structure", + "members":{ + } + }, + "NextToken":{"type":"string"}, + "NonCompliantSummary":{ + "type":"structure", + "members":{ + "NonCompliantCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of compliance items that are not compliant.

    " + }, + "SeveritySummary":{ + "shape":"SeveritySummary", + "documentation":"

    A summary of the non-compliance severity by compliance type

    " + } + }, + "documentation":"

    A summary of resources that are not compliant. The summary is organized according to resource type.

    " + }, + "NormalStringMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"String"} + }, + "NotificationArn":{"type":"string"}, + "NotificationConfig":{ + "type":"structure", + "members":{ + "NotificationArn":{ + "shape":"NotificationArn", + "documentation":"

    An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

    " + }, + "NotificationEvents":{ + "shape":"NotificationEventList", + "documentation":"

    The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide.

    " + }, + "NotificationType":{ + "shape":"NotificationType", + "documentation":"

    Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

    " + } + }, + "documentation":"

    Configurations for sending notifications.

    " + }, + "NotificationEvent":{ + "type":"string", + "enum":[ + "All", + "InProgress", + "Success", + "TimedOut", + "Cancelled", + "Failed" + ] + }, + "NotificationEventList":{ + "type":"list", + "member":{"shape":"NotificationEvent"} + }, + "NotificationType":{ + "type":"string", + "enum":[ + "Command", + "Invocation" + ] + }, + "OperatingSystem":{ + "type":"string", + "enum":[ + "WINDOWS", + "AMAZON_LINUX", + "AMAZON_LINUX_2", + "UBUNTU", + "REDHAT_ENTERPRISE_LINUX", + "SUSE", + "CENTOS" + ] + }, + "OpsAggregator":{ + "type":"structure", + "members":{ + "AggregatorType":{ + "shape":"OpsAggregatorType", + "documentation":"

    Either a Range or Count aggregator for limiting an OpsItem summary.

    " + }, + "TypeName":{ + "shape":"OpsDataTypeName", + "documentation":"

    The data type name to use for viewing counts of OpsItems.

    " + }, + "AttributeName":{ + "shape":"OpsDataAttributeName", + "documentation":"

    The name of an OpsItem attribute on which to limit the count of OpsItems.

    " + }, + "Values":{ + "shape":"OpsAggregatorValueMap", + "documentation":"

    The aggregator value.

    " + }, + "Filters":{ + "shape":"OpsFilterList", + "documentation":"

    The aggregator filters.

    " + }, + "Aggregators":{ + "shape":"OpsAggregatorList", + "documentation":"

    A nested aggregator for viewing counts of OpsItems.

    " + } + }, + "documentation":"

    One or more aggregators for viewing counts of OpsItems using different dimensions such as Source, CreatedTime, or Source and CreatedTime, to name a few.

    " + }, + "OpsAggregatorList":{ + "type":"list", + "member":{"shape":"OpsAggregator"}, + "max":12, + "min":1 + }, + "OpsAggregatorType":{ + "type":"string", + "max":20, + "min":1, + "pattern":"^(range|count)" + }, + "OpsAggregatorValue":{ + "type":"string", + "max":512, + "min":0 + }, + "OpsAggregatorValueKey":{ + "type":"string", + "max":32, + "min":1 + }, + "OpsAggregatorValueMap":{ + "type":"map", + "key":{"shape":"OpsAggregatorValueKey"}, + "value":{"shape":"OpsAggregatorValue"}, + "max":5, + "min":0 + }, + "OpsDataAttributeName":{"type":"string"}, + "OpsDataTypeName":{ + "type":"string", + "max":100, + "min":1, + "pattern":"^(AWS|Custom):.*$" + }, + "OpsEntity":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"OpsEntityId", + "documentation":"

    The query ID.

    " + }, + "Data":{ + "shape":"OpsEntityItemMap", + "documentation":"

    The data returned by the query.

    " + } + }, + "documentation":"

    The result of the query.

    " + }, + "OpsEntityId":{"type":"string"}, + "OpsEntityItem":{ + "type":"structure", + "members":{ + "Content":{ + "shape":"OpsEntityItemEntryList", + "documentation":"

    The detailed data content for an OpsItem summaries result item.

    " + } + }, + "documentation":"

    The OpsItem summaries result item.

    " + }, + "OpsEntityItemEntry":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"}, + "max":50, + "min":0 + }, + "OpsEntityItemEntryList":{ + "type":"list", + "member":{"shape":"OpsEntityItemEntry"}, + "max":10000, + "min":0 + }, + "OpsEntityItemKey":{"type":"string"}, + "OpsEntityItemMap":{ + "type":"map", + "key":{"shape":"OpsEntityItemKey"}, + "value":{"shape":"OpsEntityItem"} + }, + "OpsEntityList":{ + "type":"list", + "member":{"shape":"OpsEntity"} + }, + "OpsFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"OpsFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Values":{ + "shape":"OpsFilterValueList", + "documentation":"

    The filter value.

    " + }, + "Type":{ + "shape":"OpsFilterOperatorType", + "documentation":"

    The type of filter.

    " + } + }, + "documentation":"

    A filter for viewing OpsItem summaries.

    " + }, + "OpsFilterKey":{ + "type":"string", + "max":200, + "min":1 + }, + "OpsFilterList":{ + "type":"list", + "member":{"shape":"OpsFilter"}, + "max":5, + "min":1 + }, + "OpsFilterOperatorType":{ + "type":"string", + "enum":[ + "Equal", + "NotEqual", + "BeginWith", + "LessThan", + "GreaterThan", + "Exists" + ] + }, + "OpsFilterValue":{"type":"string"}, + "OpsFilterValueList":{ + "type":"list", + "member":{"shape":"OpsFilterValue"}, + "max":40, + "min":1 + }, + "OpsItem":{ + "type":"structure", + "members":{ + "CreatedBy":{ + "shape":"String", + "documentation":"

    The ARN of the AWS account that created the OpsItem.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time the OpsItem was created.

    " + }, + "Description":{ + "shape":"OpsItemDescription", + "documentation":"

    The OpsItem description.

    " + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"

    The ARN of the AWS account that last updated the OpsItem.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time the OpsItem was last updated.

    " + }, + "Notifications":{ + "shape":"OpsItemNotifications", + "documentation":"

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    " + }, + "Priority":{ + "shape":"OpsItemPriority", + "documentation":"

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + }, + "RelatedOpsItems":{ + "shape":"RelatedOpsItems", + "documentation":"

    One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    " + }, + "Status":{ + "shape":"OpsItemStatus", + "documentation":"

    The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

    " + }, + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"

    The ID of the OpsItem.

    " + }, + "Version":{ + "shape":"String", + "documentation":"

    The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

    " + }, + "Title":{ + "shape":"OpsItemTitle", + "documentation":"

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + }, + "Source":{ + "shape":"OpsItemSource", + "documentation":"

    The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.

    " + }, + "OperationalData":{ + "shape":"OpsItemOperationalData", + "documentation":"

    Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

    Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

    You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

    Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

    " + } + }, + "documentation":"

    Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

    " + }, + "OpsItemAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "OpsItemId":{"shape":"String"} + }, + "documentation":"

    The OpsItem already exists.

    ", + "exception":true + }, + "OpsItemDataKey":{ + "type":"string", + "max":128, + "min":1 + }, + "OpsItemDataType":{ + "type":"string", + "enum":[ + "SearchableString", + "String" + ] + }, + "OpsItemDataValue":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"OpsItemDataValueString", + "documentation":"

    The value of the OperationalData key.

    " + }, + "Type":{ + "shape":"OpsItemDataType", + "documentation":"

    The type of key-value pair. Valid types include SearchableString and String.

    " + } + }, + "documentation":"

    An object that defines the value of the key and its type in the OperationalData map.

    " + }, + "OpsItemDataValueString":{"type":"string"}, + "OpsItemDescription":{ + "type":"string", + "max":1024, + "min":1 + }, + "OpsItemFilter":{ + "type":"structure", + "required":[ + "Key", + "Values", + "Operator" + ], + "members":{ + "Key":{ + "shape":"OpsItemFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Values":{ + "shape":"OpsItemFilterValues", + "documentation":"

    The filter value.

    " + }, + "Operator":{ + "shape":"OpsItemFilterOperator", + "documentation":"

    The operator used by the filter call.

    " + } + }, + "documentation":"

    Describes an OpsItem filter.

    " + }, + "OpsItemFilterKey":{ + "type":"string", + "enum":[ + "Status", + "CreatedBy", + "Source", + "Priority", + "Title", + "OpsItemId", + "CreatedTime", + "LastModifiedTime", + "OperationalData", + "OperationalDataKey", + "OperationalDataValue", + "ResourceId", + "AutomationId" + ] + }, + "OpsItemFilterOperator":{ + "type":"string", + "enum":[ + "Equal", + "Contains", + "GreaterThan", + "LessThan" + ] + }, + "OpsItemFilterValue":{"type":"string"}, + "OpsItemFilterValues":{ + "type":"list", + "member":{"shape":"OpsItemFilterValue"} + }, + "OpsItemFilters":{ + "type":"list", + "member":{"shape":"OpsItemFilter"} + }, + "OpsItemId":{ + "type":"string", + "pattern":"^(oi)-[0-9a-f]{12}$" + }, + "OpsItemInvalidParameterException":{ + "type":"structure", + "members":{ + "ParameterNames":{"shape":"OpsItemParameterNamesList"}, + "Message":{"shape":"String"} + }, + "documentation":"

    A specified parameter argument isn't valid. Verify the available arguments and try again.

    ", + "exception":true + }, + "OpsItemLimitExceededException":{ + "type":"structure", + "members":{ + "ResourceTypes":{"shape":"OpsItemParameterNamesList"}, + "Limit":{"shape":"Integer"}, + "LimitType":{"shape":"String"}, + "Message":{"shape":"String"} + }, + "documentation":"

    The request caused OpsItems to exceed one or more limits. For information about OpsItem limits, see What are the resource limits for OpsCenter?.

    ", + "exception":true + }, + "OpsItemMaxResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "OpsItemNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified OpsItem ID doesn't exist. Verify the ID and try again.

    ", + "exception":true + }, + "OpsItemNotification":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    " + } + }, + "documentation":"

    A notification about the OpsItem.

    " + }, + "OpsItemNotifications":{ + "type":"list", + "member":{"shape":"OpsItemNotification"} + }, + "OpsItemOperationalData":{ + "type":"map", + "key":{"shape":"OpsItemDataKey"}, + "value":{"shape":"OpsItemDataValue"} + }, + "OpsItemOpsDataKeysList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OpsItemParameterNamesList":{ + "type":"list", + "member":{"shape":"String"} + }, + "OpsItemPriority":{ + "type":"integer", + "max":5, + "min":1 + }, + "OpsItemSource":{ + "type":"string", + "max":64, + "min":1 + }, + "OpsItemStatus":{ + "type":"string", + "enum":[ + "Open", + "InProgress", + "Resolved" + ] + }, + "OpsItemSummaries":{ + "type":"list", + "member":{"shape":"OpsItemSummary"} + }, + "OpsItemSummary":{ + "type":"structure", + "members":{ + "CreatedBy":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time the OpsItem was created.

    " + }, + "LastModifiedBy":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM entity that created the OpsItem.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time the OpsItem was last updated.

    " + }, + "Priority":{ + "shape":"OpsItemPriority", + "documentation":"

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + }, + "Source":{ + "shape":"OpsItemSource", + "documentation":"

    The impacted AWS resource.

    " + }, + "Status":{ + "shape":"OpsItemStatus", + "documentation":"

    The OpsItem status. Status can be Open, In Progress, or Resolved.

    " + }, + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"

    The ID of the OpsItem.

    " + }, + "Title":{ + "shape":"OpsItemTitle", + "documentation":"

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + }, + "OperationalData":{ + "shape":"OpsItemOperationalData", + "documentation":"

    Operational data is custom data that provides useful reference details about the OpsItem.

    " + } + }, + "documentation":"

    A count of OpsItems.

    " + }, + "OpsItemTitle":{ + "type":"string", + "max":1024, + "min":1 + }, + "OutputSource":{ + "type":"structure", + "members":{ + "OutputSourceId":{ + "shape":"OutputSourceId", + "documentation":"

    The ID of the output source, for example the URL of an Amazon S3 bucket.

    " + }, + "OutputSourceType":{ + "shape":"OutputSourceType", + "documentation":"

    The type of source where the association execution details are stored, for example, Amazon S3.

    " + } + }, + "documentation":"

    Information about the source where the association execution details are stored.

    " + }, + "OutputSourceId":{ + "type":"string", + "max":36, + "min":36 + }, + "OutputSourceType":{"type":"string"}, + "OwnerInformation":{ + "type":"string", + "max":128, + "min":1, + "sensitive":true + }, + "PSParameterName":{ + "type":"string", + "max":2048, + "min":1 + }, + "PSParameterSelector":{ + "type":"string", + "max":128, + "min":0 + }, + "PSParameterValue":{"type":"string"}, + "PSParameterVersion":{"type":"long"}, + "Parameter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The name of the parameter.

    " + }, + "Type":{ + "shape":"ParameterType", + "documentation":"

    The type of parameter. Valid values include the following: String, String list, Secure string.

    " + }, + "Value":{ + "shape":"PSParameterValue", + "documentation":"

    The parameter value.

    " + }, + "Version":{ + "shape":"PSParameterVersion", + "documentation":"

    The parameter version.

    " + }, + "Selector":{ + "shape":"PSParameterSelector", + "documentation":"

    Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:

    parameter_name:version

    parameter_name:label

    " + }, + "SourceResult":{ + "shape":"String", + "documentation":"

    Applies to parameters that reference information in other AWS services. SourceResult is the raw result or response from the source.

    " + }, + "LastModifiedDate":{ + "shape":"DateTime", + "documentation":"

    Date the parameter was last changed or updated and the parameter version was created.

    " + }, + "ARN":{ + "shape":"String", + "documentation":"

    The Amazon Resource Name (ARN) of the parameter.

    " + } + }, + "documentation":"

    An Amazon EC2 Systems Manager parameter in Parameter Store.

    " + }, + "ParameterAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The parameter already exists. You can't create duplicate parameters.

    ", + "exception":true + }, + "ParameterDescription":{ + "type":"string", + "max":1024, + "min":0 + }, + "ParameterHistory":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The name of the parameter.

    " + }, + "Type":{ + "shape":"ParameterType", + "documentation":"

    The type of parameter used.

    " + }, + "KeyId":{ + "shape":"ParameterKeyId", + "documentation":"

    The ID of the query key used for this parameter.

    " + }, + "LastModifiedDate":{ + "shape":"DateTime", + "documentation":"

    Date the parameter was last changed or updated.

    " + }, + "LastModifiedUser":{ + "shape":"String", + "documentation":"

    Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

    " + }, + "Description":{ + "shape":"ParameterDescription", + "documentation":"

    Information about the parameter.

    " + }, + "Value":{ + "shape":"PSParameterValue", + "documentation":"

    The parameter value.

    " + }, + "AllowedPattern":{ + "shape":"AllowedPattern", + "documentation":"

    Parameter names can include the following letters and symbols.

    a-zA-Z0-9_.-

    " + }, + "Version":{ + "shape":"PSParameterVersion", + "documentation":"

    The parameter version.

    " + }, + "Labels":{ + "shape":"ParameterLabelList", + "documentation":"

    Labels assigned to the parameter version.

    " + }, + "Tier":{ + "shape":"ParameterTier", + "documentation":"

    The parameter tier.

    " + }, + "Policies":{ + "shape":"ParameterPolicyList", + "documentation":"

    Information about the policies assigned to a parameter.

    Working with Parameter Policies in the AWS Systems Manager User Guide.

    " + } + }, + "documentation":"

    Information about parameter usage.

    " + }, + "ParameterHistoryList":{ + "type":"list", + "member":{"shape":"ParameterHistory"} + }, + "ParameterInlinePolicy":{ + "type":"structure", + "members":{ + "PolicyText":{ + "shape":"String", + "documentation":"

    The JSON text of the policy.

    " + }, + "PolicyType":{ + "shape":"String", + "documentation":"

    The type of policy. Parameter Store supports the following policy types: Expiration, ExpirationNotification, and NoChangeNotification.

    " + }, + "PolicyStatus":{ + "shape":"String", + "documentation":"

    The status of the policy. Policies report the following statuses: Pending (the policy has not been enforced or applied yet), Finished (the policy was applied), Failed (the policy was not applied), or InProgress (the policy is being applied now).

    " + } + }, + "documentation":"

    One or more policies assigned to a parameter.

    " + }, + "ParameterKeyId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([a-zA-Z0-9:/_-]+)$" + }, + "ParameterLabel":{ + "type":"string", + "max":100, + "min":1 + }, + "ParameterLabelList":{ + "type":"list", + "member":{"shape":"ParameterLabel"}, + "max":10, + "min":1 + }, + "ParameterLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    You have exceeded the number of parameters for this AWS account. Delete one or more parameters and try again.

    ", + "exception":true + }, + "ParameterList":{ + "type":"list", + "member":{"shape":"Parameter"} + }, + "ParameterMaxVersionLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The parameter exceeded the maximum number of allowed versions.

    ", + "exception":true + }, + "ParameterMetadata":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The parameter name.

    " + }, + "Type":{ + "shape":"ParameterType", + "documentation":"

    The type of parameter. Valid parameter types include the following: String, String list, Secure string.

    " + }, + "KeyId":{ + "shape":"ParameterKeyId", + "documentation":"

    The ID of the query key used for this parameter.

    " + }, + "LastModifiedDate":{ + "shape":"DateTime", + "documentation":"

    Date the parameter was last changed or updated.

    " + }, + "LastModifiedUser":{ + "shape":"String", + "documentation":"

    Amazon Resource Name (ARN) of the AWS user who last changed the parameter.

    " + }, + "Description":{ + "shape":"ParameterDescription", + "documentation":"

    Description of the parameter actions.

    " + }, + "AllowedPattern":{ + "shape":"AllowedPattern", + "documentation":"

    A parameter name can include only the following letters and symbols.

    a-zA-Z0-9_.-

    " + }, + "Version":{ + "shape":"PSParameterVersion", + "documentation":"

    The parameter version.

    " + }, + "Tier":{ + "shape":"ParameterTier", + "documentation":"

    The parameter tier.

    " + }, + "Policies":{ + "shape":"ParameterPolicyList", + "documentation":"

    A list of policies associated with a parameter.

    " + } + }, + "documentation":"

    Metadata includes information like the ARN of the last user and the date/time the parameter was last used.

    " + }, + "ParameterMetadataList":{ + "type":"list", + "member":{"shape":"ParameterMetadata"} + }, + "ParameterName":{"type":"string"}, + "ParameterNameList":{ + "type":"list", + "member":{"shape":"PSParameterName"}, + "max":10, + "min":1 + }, + "ParameterNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The parameter could not be found. Verify the name and try again.

    ", + "exception":true + }, + "ParameterPatternMismatchException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"String", + "documentation":"

    The parameter name is not valid.

    " + } + }, + "documentation":"

    The parameter name is not valid.

    ", + "exception":true + }, + "ParameterPolicies":{ + "type":"string", + "max":4096, + "min":1 + }, + "ParameterPolicyList":{ + "type":"list", + "member":{"shape":"ParameterInlinePolicy"} + }, + "ParameterStringFilter":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"ParameterStringFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Option":{ + "shape":"ParameterStringQueryOption", + "documentation":"

    Valid options are Equals and BeginsWith. For Path filter, valid options are Recursive and OneLevel.

    " + }, + "Values":{ + "shape":"ParameterStringFilterValueList", + "documentation":"

    The value you want to search for.

    " + } + }, + "documentation":"

    One or more filters. Use a filter to return a more specific list of results.

    The Name and Tier filter keys can't be used with the GetParametersByPath API action. Also, the Label filter key can't be used with the DescribeParameters API action.

    " + }, + "ParameterStringFilterKey":{ + "type":"string", + "max":132, + "min":1, + "pattern":"tag:.+|Name|Type|KeyId|Path|Label|Tier" + }, + "ParameterStringFilterList":{ + "type":"list", + "member":{"shape":"ParameterStringFilter"} + }, + "ParameterStringFilterValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "ParameterStringFilterValueList":{ + "type":"list", + "member":{"shape":"ParameterStringFilterValue"}, + "max":50, + "min":1 + }, + "ParameterStringQueryOption":{ + "type":"string", + "max":10, + "min":1 + }, + "ParameterTier":{ + "type":"string", + "enum":[ + "Standard", + "Advanced", + "Intelligent-Tiering" + ] + }, + "ParameterType":{ + "type":"string", + "enum":[ + "String", + "StringList", + "SecureString" + ] + }, + "ParameterValue":{"type":"string"}, + "ParameterValueList":{ + "type":"list", + "member":{"shape":"ParameterValue"} + }, + "ParameterVersionLabelLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    A parameter version can have a maximum of ten labels.

    ", + "exception":true + }, + "ParameterVersionNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The specified parameter version was not found. Verify the parameter name and version, and try again.

    ", + "exception":true + }, + "Parameters":{ + "type":"map", + "key":{"shape":"ParameterName"}, + "value":{"shape":"ParameterValueList"} + }, + "ParametersFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"ParametersFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "Values":{ + "shape":"ParametersFilterValueList", + "documentation":"

    The filter values.

    " + } + }, + "documentation":"

    This data type is deprecated. Instead, use ParameterStringFilter.

    " + }, + "ParametersFilterKey":{ + "type":"string", + "enum":[ + "Name", + "Type", + "KeyId" + ] + }, + "ParametersFilterList":{ + "type":"list", + "member":{"shape":"ParametersFilter"} + }, + "ParametersFilterValue":{ + "type":"string", + "max":1024, + "min":1 + }, + "ParametersFilterValueList":{ + "type":"list", + "member":{"shape":"ParametersFilterValue"}, + "max":50, + "min":1 + }, + "Patch":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"PatchId", + "documentation":"

    The ID of the patch (this is different than the Microsoft Knowledge Base ID).

    " + }, + "ReleaseDate":{ + "shape":"DateTime", + "documentation":"

    The date the patch was released.

    " + }, + "Title":{ + "shape":"PatchTitle", + "documentation":"

    The title of the patch.

    " + }, + "Description":{ + "shape":"PatchDescription", + "documentation":"

    The description of the patch.

    " + }, + "ContentUrl":{ + "shape":"PatchContentUrl", + "documentation":"

    The URL where more information can be obtained about the patch.

    " + }, + "Vendor":{ + "shape":"PatchVendor", + "documentation":"

    The name of the vendor providing the patch.

    " + }, + "ProductFamily":{ + "shape":"PatchProductFamily", + "documentation":"

    The product family the patch is applicable for (for example, Windows).

    " + }, + "Product":{ + "shape":"PatchProduct", + "documentation":"

    The specific product the patch is applicable for (for example, WindowsServer2016).

    " + }, + "Classification":{ + "shape":"PatchClassification", + "documentation":"

    The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

    " + }, + "MsrcSeverity":{ + "shape":"PatchMsrcSeverity", + "documentation":"

    The severity of the patch (for example Critical, Important, Moderate).

    " + }, + "KbNumber":{ + "shape":"PatchKbNumber", + "documentation":"

    The Microsoft Knowledge Base ID of the patch.

    " + }, + "MsrcNumber":{ + "shape":"PatchMsrcNumber", + "documentation":"

    The ID of the MSRC bulletin the patch is related to.

    " + }, + "Language":{ + "shape":"PatchLanguage", + "documentation":"

    The language of the patch if it's language-specific.

    " + } + }, + "documentation":"

    Represents metadata about a patch.

    " + }, + "PatchAction":{ + "type":"string", + "enum":[ + "ALLOW_AS_DEPENDENCY", + "BLOCK" + ] + }, + "PatchBaselineIdentity":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline.

    " + }, + "BaselineName":{ + "shape":"BaselineName", + "documentation":"

    The name of the patch baseline.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    Defines the operating system the patch baseline applies to. The Default value is WINDOWS.

    " + }, + "BaselineDescription":{ + "shape":"BaselineDescription", + "documentation":"

    The description of the patch baseline.

    " + }, + "DefaultBaseline":{ + "shape":"DefaultBaseline", + "documentation":"

    Whether this is the default baseline. Note that Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.

    " + } + }, + "documentation":"

    Defines the basic information about a patch baseline.

    " + }, + "PatchBaselineIdentityList":{ + "type":"list", + "member":{"shape":"PatchBaselineIdentity"} + }, + "PatchBaselineMaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "PatchClassification":{"type":"string"}, + "PatchComplianceData":{ + "type":"structure", + "required":[ + "Title", + "KBId", + "Classification", + "Severity", + "State", + "InstalledTime" + ], + "members":{ + "Title":{ + "shape":"PatchTitle", + "documentation":"

    The title of the patch.

    " + }, + "KBId":{ + "shape":"PatchKbNumber", + "documentation":"

    The operating system-specific ID of the patch.

    " + }, + "Classification":{ + "shape":"PatchClassification", + "documentation":"

    The classification of the patch (for example, SecurityUpdates, Updates, CriticalUpdates).

    " + }, + "Severity":{ + "shape":"PatchSeverity", + "documentation":"

    The severity of the patch (for example, Critical, Important, Moderate).

    " + }, + "State":{ + "shape":"PatchComplianceDataState", + "documentation":"

    The state of the patch on the instance, such as INSTALLED or FAILED.

    For descriptions of each patch state, see About Patch Compliance in the AWS Systems Manager User Guide.

    " + }, + "InstalledTime":{ + "shape":"DateTime", + "documentation":"

    The date/time the patch was installed on the instance. Note that not all operating systems provide this level of information.

    " + } + }, + "documentation":"

    Information about the state of a patch on a particular instance as it relates to the patch baseline used to patch the instance.

    " + }, + "PatchComplianceDataList":{ + "type":"list", + "member":{"shape":"PatchComplianceData"} + }, + "PatchComplianceDataState":{ + "type":"string", + "enum":[ + "INSTALLED", + "INSTALLED_OTHER", + "INSTALLED_REJECTED", + "MISSING", + "NOT_APPLICABLE", + "FAILED" + ] + }, + "PatchComplianceLevel":{ + "type":"string", + "enum":[ + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW", + "INFORMATIONAL", + "UNSPECIFIED" + ] + }, + "PatchComplianceMaxResults":{ + "type":"integer", + "max":100, + "min":10 + }, + "PatchContentUrl":{"type":"string"}, + "PatchDeploymentStatus":{ + "type":"string", + "enum":[ + "APPROVED", + "PENDING_APPROVAL", + "EXPLICIT_APPROVED", + "EXPLICIT_REJECTED" + ] + }, + "PatchDescription":{"type":"string"}, + "PatchFailedCount":{"type":"integer"}, + "PatchFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"PatchFilterKey", + "documentation":"

    The key for the filter.

    Run the DescribePatchProperties command to view lists of valid keys for each operating system type.

    " + }, + "Values":{ + "shape":"PatchFilterValueList", + "documentation":"

    The value for the filter key.

    Run the DescribePatchProperties command to view lists of valid values for each key based on operating system type.

    " + } + }, + "documentation":"

    Defines which patches should be included in a patch baseline.

    A patch filter consists of a key and a set of values. The filter key is a patch property. For example, the available filter keys for WINDOWS are PATCH_SET, PRODUCT, PRODUCT_FAMILY, CLASSIFICATION, and MSRC_SEVERITY. The filter values define a matching criterion for the patch property indicated by the key. For example, if the filter key is PRODUCT and the filter values are [\"Office 2013\", \"Office 2016\"], then the filter accepts all patches where product name is either \"Office 2013\" or \"Office 2016\". The filter values can be exact values for the patch property given as a key, or a wildcard (*), which matches all values.

    You can view lists of valid values for the patch properties by running the DescribePatchProperties command. For information about which patch properties can be used with each major operating system, see DescribePatchProperties.

    " + }, + "PatchFilterGroup":{ + "type":"structure", + "required":["PatchFilters"], + "members":{ + "PatchFilters":{ + "shape":"PatchFilterList", + "documentation":"

    The set of patch filters that make up the group.

    " + } + }, + "documentation":"

    A set of patch filters, typically used for approval rules.

    " + }, + "PatchFilterKey":{ + "type":"string", + "enum":[ + "PATCH_SET", + "PRODUCT", + "PRODUCT_FAMILY", + "CLASSIFICATION", + "MSRC_SEVERITY", + "PATCH_ID", + "SECTION", + "PRIORITY", + "SEVERITY" + ] + }, + "PatchFilterList":{ + "type":"list", + "member":{"shape":"PatchFilter"}, + "max":4, + "min":0 + }, + "PatchFilterValue":{ + "type":"string", + "max":64, + "min":1 + }, + "PatchFilterValueList":{ + "type":"list", + "member":{"shape":"PatchFilterValue"}, + "max":20, + "min":1 + }, + "PatchGroup":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "PatchGroupList":{ + "type":"list", + "member":{"shape":"PatchGroup"} + }, + "PatchGroupPatchBaselineMapping":{ + "type":"structure", + "members":{ + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group registered with the patch baseline.

    " + }, + "BaselineIdentity":{ + "shape":"PatchBaselineIdentity", + "documentation":"

    The patch baseline the patch group is registered with.

    " + } + }, + "documentation":"

    The mapping between a patch group and the patch baseline the patch group is registered with.

    " + }, + "PatchGroupPatchBaselineMappingList":{ + "type":"list", + "member":{"shape":"PatchGroupPatchBaselineMapping"} + }, + "PatchId":{ + "type":"string", + "max":100, + "min":1 + }, + "PatchIdList":{ + "type":"list", + "member":{"shape":"PatchId"}, + "max":50, + "min":0 + }, + "PatchInstalledCount":{"type":"integer"}, + "PatchInstalledOtherCount":{"type":"integer"}, + "PatchInstalledRejectedCount":{"type":"integer"}, + "PatchKbNumber":{"type":"string"}, + "PatchLanguage":{"type":"string"}, + "PatchList":{ + "type":"list", + "member":{"shape":"Patch"} + }, + "PatchMissingCount":{"type":"integer"}, + "PatchMsrcNumber":{"type":"string"}, + "PatchMsrcSeverity":{"type":"string"}, + "PatchNotApplicableCount":{"type":"integer"}, + "PatchOperationType":{ + "type":"string", + "enum":[ + "Scan", + "Install" + ] + }, + "PatchOrchestratorFilter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"PatchOrchestratorFilterKey", + "documentation":"

    The key for the filter.

    " + }, + "Values":{ + "shape":"PatchOrchestratorFilterValues", + "documentation":"

    The value for the filter.

    " + } + }, + "documentation":"

    Defines a filter used in Patch Manager APIs.

    " + }, + "PatchOrchestratorFilterKey":{ + "type":"string", + "max":128, + "min":1 + }, + "PatchOrchestratorFilterList":{ + "type":"list", + "member":{"shape":"PatchOrchestratorFilter"}, + "max":5, + "min":0 + }, + "PatchOrchestratorFilterValue":{ + "type":"string", + "max":256, + "min":1 + }, + "PatchOrchestratorFilterValues":{ + "type":"list", + "member":{"shape":"PatchOrchestratorFilterValue"} + }, + "PatchProduct":{"type":"string"}, + "PatchProductFamily":{"type":"string"}, + "PatchPropertiesList":{ + "type":"list", + "member":{"shape":"PatchPropertyEntry"} + }, + "PatchProperty":{ + "type":"string", + "enum":[ + "PRODUCT", + "PRODUCT_FAMILY", + "CLASSIFICATION", + "MSRC_SEVERITY", + "PRIORITY", + "SEVERITY" + ] + }, + "PatchPropertyEntry":{ + "type":"map", + "key":{"shape":"AttributeName"}, + "value":{"shape":"AttributeValue"} + }, + "PatchRule":{ + "type":"structure", + "required":[ + "PatchFilterGroup", + "ApproveAfterDays" + ], + "members":{ + "PatchFilterGroup":{ + "shape":"PatchFilterGroup", + "documentation":"

    The patch filter group that defines the criteria for the rule.

    " + }, + "ComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    A compliance severity level for all approved patches in a patch baseline. Valid compliance severity levels include the following: Unspecified, Critical, High, Medium, Low, and Informational.

    " + }, + "ApproveAfterDays":{ + "shape":"ApproveAfterDays", + "documentation":"

    The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of 7 means that patches are approved seven days after they are released.

    ", + "box":true + }, + "EnableNonSecurity":{ + "shape":"Boolean", + "documentation":"

    For instances identified by the approval rule filters, enables a patch baseline to apply non-security updates available in the specified repository. The default value is 'false'. Applies to Linux instances only.

    ", + "box":true + } + }, + "documentation":"

    Defines an approval rule for a patch baseline.

    " + }, + "PatchRuleGroup":{ + "type":"structure", + "required":["PatchRules"], + "members":{ + "PatchRules":{ + "shape":"PatchRuleList", + "documentation":"

    The rules that make up the rule group.

    " + } + }, + "documentation":"

    A set of rules defining the approval rules for a patch baseline.

    " + }, + "PatchRuleList":{ + "type":"list", + "member":{"shape":"PatchRule"}, + "max":10, + "min":0 + }, + "PatchSet":{ + "type":"string", + "enum":[ + "OS", + "APPLICATION" + ] + }, + "PatchSeverity":{"type":"string"}, + "PatchSource":{ + "type":"structure", + "required":[ + "Name", + "Products", + "Configuration" + ], + "members":{ + "Name":{ + "shape":"PatchSourceName", + "documentation":"

    The name specified to identify the patch source.

    " + }, + "Products":{ + "shape":"PatchSourceProductList", + "documentation":"

    The specific operating system versions a patch repository applies to, such as \"Ubuntu16.04\", \"AmazonLinux2016.09\", \"RedhatEnterpriseLinux7.2\" or \"Suse12.7\". For lists of supported product values, see PatchFilter.

    " + }, + "Configuration":{ + "shape":"PatchSourceConfiguration", + "documentation":"

    The value of the yum repo configuration. For example:

    [main]

    cachedir=/var/cache/yum/$basesearch$releasever

    keepcache=0

    debuglevel=2

    " + } + }, + "documentation":"

    Information about the patches to use to update the instances, including target operating systems and source repository. Applies to Linux instances only.

    " + }, + "PatchSourceConfiguration":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "PatchSourceList":{ + "type":"list", + "member":{"shape":"PatchSource"}, + "max":20, + "min":0 + }, + "PatchSourceName":{ + "type":"string", + "pattern":"^[a-zA-Z0-9_\\-.]{3,50}$" + }, + "PatchSourceProduct":{ + "type":"string", + "max":128, + "min":1 + }, + "PatchSourceProductList":{ + "type":"list", + "member":{"shape":"PatchSourceProduct"}, + "max":20, + "min":1 + }, + "PatchStatus":{ + "type":"structure", + "members":{ + "DeploymentStatus":{ + "shape":"PatchDeploymentStatus", + "documentation":"

    The approval status of a patch (APPROVED, PENDING_APPROVAL, EXPLICIT_APPROVED, EXPLICIT_REJECTED).

    " + }, + "ComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    The compliance severity level for a patch.

    " + }, + "ApprovalDate":{ + "shape":"DateTime", + "documentation":"

    The date the patch was approved (or will be approved if the status is PENDING_APPROVAL).

    " + } + }, + "documentation":"

    Information about the approval status of a patch.

    " + }, + "PatchTitle":{"type":"string"}, + "PatchUnreportedNotApplicableCount":{"type":"integer"}, + "PatchVendor":{"type":"string"}, + "PingStatus":{ + "type":"string", + "enum":[ + "Online", + "ConnectionLost", + "Inactive" + ] + }, + "PlatformType":{ + "type":"string", + "enum":[ + "Windows", + "Linux" + ] + }, + "PlatformTypeList":{ + "type":"list", + "member":{"shape":"PlatformType"} + }, + "PoliciesLimitExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    You specified more than the maximum number of allowed policies for the parameter. The maximum is 10.

    ", + "exception":true + }, + "Product":{"type":"string"}, + "ProgressCounters":{ + "type":"structure", + "members":{ + "TotalSteps":{ + "shape":"Integer", + "documentation":"

    The total number of steps run in all specified AWS Regions and accounts for the current Automation execution.

    " + }, + "SuccessSteps":{ + "shape":"Integer", + "documentation":"

    The total number of steps that successfully completed in all specified AWS Regions and accounts for the current Automation execution.

    " + }, + "FailedSteps":{ + "shape":"Integer", + "documentation":"

    The total number of steps that failed to run in all specified AWS Regions and accounts for the current Automation execution.

    " + }, + "CancelledSteps":{ + "shape":"Integer", + "documentation":"

    The total number of steps that the system cancelled in all specified AWS Regions and accounts for the current Automation execution.

    " + }, + "TimedOutSteps":{ + "shape":"Integer", + "documentation":"

    The total number of steps that timed out in all specified AWS Regions and accounts for the current Automation execution.

    " + } + }, + "documentation":"

    An aggregate of step execution statuses displayed in the AWS Console for a multi-Region and multi-account Automation execution.

    " + }, + "PutComplianceItemsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "ResourceType", + "ComplianceType", + "ExecutionSummary", + "Items" + ], + "members":{ + "ResourceId":{ + "shape":"ComplianceResourceId", + "documentation":"

    Specify an ID for this resource. For a managed instance, this is the instance ID.

    " + }, + "ResourceType":{ + "shape":"ComplianceResourceType", + "documentation":"

    Specify the type of resource. ManagedInstance is currently the only supported resource type.

    " + }, + "ComplianceType":{ + "shape":"ComplianceTypeName", + "documentation":"

    Specify the compliance type. For example, specify Association (for a State Manager association), Patch, or Custom:string.

    " + }, + "ExecutionSummary":{ + "shape":"ComplianceExecutionSummary", + "documentation":"

    A summary of the call execution that includes an execution ID, the type of execution (for example, Command), and the date/time of the execution using a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'.

    " + }, + "Items":{ + "shape":"ComplianceItemEntryList", + "documentation":"

    Information about the compliance as defined by the resource type. For example, for a patch compliance type, Items includes information about the PatchSeverity, Classification, etc.

    " + }, + "ItemContentHash":{ + "shape":"ComplianceItemContentHash", + "documentation":"

    MD5 or SHA-256 content hash. The content hash is used to determine if existing information should be overwritten or ignored. If the content hashes match, the request to put compliance information is ignored.

    " + } + } + }, + "PutComplianceItemsResult":{ + "type":"structure", + "members":{ + } + }, + "PutInventoryMessage":{"type":"string"}, + "PutInventoryRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "Items" + ], + "members":{ + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    One or more instance IDs where you want to add or update inventory items.

    " + }, + "Items":{ + "shape":"InventoryItemList", + "documentation":"

    The inventory items that you want to add or update on instances.

    " + } + } + }, + "PutInventoryResult":{ + "type":"structure", + "members":{ + "Message":{ + "shape":"PutInventoryMessage", + "documentation":"

    Information about the request.

    " + } + } + }, + "PutParameterRequest":{ + "type":"structure", + "required":[ + "Name", + "Value", + "Type" + ], + "members":{ + "Name":{ + "shape":"PSParameterName", + "documentation":"

    The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For example: /Dev/DBServer/MySQL/db-string13

    Naming Constraints:

    • Parameter names are case sensitive.

    • A parameter name must be unique within an AWS Region

    • A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).

    • Parameter names can include only the following symbols and letters: a-zA-Z0-9_.-/

    • A parameter name can't include spaces.

    • Parameter hierarchies are limited to a maximum depth of fifteen levels.

    For additional information about valid values for parameter names, see Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide.

    The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for the fully qualified parameter name is 1011 characters.

    " + }, + "Description":{ + "shape":"ParameterDescription", + "documentation":"

    Information about the parameter that you want to add to the system. Optional but recommended.

    Do not enter personally identifiable information in this field.

    " + }, + "Value":{ + "shape":"PSParameterValue", + "documentation":"

    The parameter value that you want to add to the system. Standard parameters have a value limit of 4 KB. Advanced parameters have a value limit of 8 KB.

    " + }, + "Type":{ + "shape":"ParameterType", + "documentation":"

    The type of parameter that you want to add to the system.

    Items in a StringList must be separated by a comma (,). You can't use other punctuation or special character to escape items in the list. If you have a parameter value that requires a comma, then use the String data type.

    SecureString is not currently supported for AWS CloudFormation templates or in the China Regions.

    " + }, + "KeyId":{ + "shape":"ParameterKeyId", + "documentation":"

    The KMS Key ID that you want to use to encrypt a parameter. Either the default AWS Key Management Service (AWS KMS) key automatically assigned to your AWS account or a custom key. Required for parameters that use the SecureString data type.

    If you don't specify a key ID, the system uses the default key associated with your AWS account.

    • To use your default AWS KMS key, choose the SecureString data type, and do not specify the Key ID when you create the parameter. The system automatically populates Key ID with your default KMS key.

    • To use a custom KMS key, choose the SecureString data type with the Key ID parameter.

    " + }, + "Overwrite":{ + "shape":"Boolean", + "documentation":"

    Overwrite an existing parameter. If not specified, will default to \"false\".

    ", + "box":true + }, + "AllowedPattern":{ + "shape":"AllowedPattern", + "documentation":"

    A regular expression used to validate the parameter value. For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\\d+$

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. In this case, you could specify the following key name/value pairs:

    • Key=Resource,Value=S3bucket

    • Key=OS,Value=Windows

    • Key=ParameterType,Value=LicenseKey

    To add tags to an existing Systems Manager parameter, use the AddTagsToResource action.

    " + }, + "Tier":{ + "shape":"ParameterTier", + "documentation":"

    The parameter tier to assign to a parameter.

    Parameter Store offers a standard tier and an advanced tier for parameters. Standard parameters have a content size limit of 4 KB and can't be configured to use parameter policies. You can create a maximum of 10,000 standard parameters for each Region in an AWS account. Standard parameters are offered at no additional cost.

    Advanced parameters have a content size limit of 8 KB and can be configured to use parameter policies. You can create a maximum of 100,000 advanced parameters for each Region in an AWS account. Advanced parameters incur a charge. For more information, see About Advanced Parameters in the AWS Systems Manager User Guide.

    You can change a standard parameter to an advanced parameter any time. But you can't revert an advanced parameter to a standard parameter. Reverting an advanced parameter to a standard parameter would result in data loss because the system would truncate the size of the parameter from 8 KB to 4 KB. Reverting would also remove any policies attached to the parameter. Lastly, advanced parameters use a different form of encryption than standard parameters.

    If you no longer need an advanced parameter, or if you no longer want to incur charges for an advanced parameter, you must delete it and recreate it as a new standard parameter.

    Using the Default Tier Configuration

    In PutParameter requests, you can specify the tier to create the parameter in. Whenever you specify a tier in the request, Parameter Store creates or updates the parameter according to that request. However, if you do not specify a tier in a request, Parameter Store assigns the tier based on the current Parameter Store default tier configuration.

    The default tier when you begin using Parameter Store is the standard-parameter tier. If you use the advanced-parameter tier, you can specify one of the following as the default:

    • Advanced: With this option, Parameter Store evaluates all requests as advanced parameters.

    • Intelligent-Tiering: With this option, Parameter Store evaluates each request to determine if the parameter is standard or advanced.

      If the request doesn't include any options that require an advanced parameter, the parameter is created in the standard-parameter tier. If one or more options requiring an advanced parameter are included in the request, Parameter Store create a parameter in the advanced-parameter tier.

      This approach helps control your parameter-related costs by always creating standard parameters unless an advanced parameter is necessary.

    Options that require an advanced parameter include the following:

    • The content size of the parameter is more than 4 KB.

    • The parameter uses a parameter policy.

    • More than 10,000 parameters already exist in your AWS account in the current Region.

    For more information about configuring the default tier option, see Specifying a Default Parameter Tier in the AWS Systems Manager User Guide.

    " + }, + "Policies":{ + "shape":"ParameterPolicies", + "documentation":"

    One or more policies to apply to a parameter. This action takes a JSON array. Parameter Store supports the following policy types:

    Expiration: This policy deletes the parameter after it expires. When you create the policy, you specify the expiration date. You can update the expiration date and time by updating the policy. Updating the parameter does not affect the expiration date and time. When the expiration time is reached, Parameter Store deletes the parameter.

    ExpirationNotification: This policy triggers an event in Amazon CloudWatch Events that notifies you about the expiration. By using this policy, you can receive notification before or after the expiration time is reached, in units of days or hours.

    NoChangeNotification: This policy triggers a CloudWatch event if a parameter has not been modified for a specified period of time. This policy type is useful when, for example, a secret needs to be changed within a period of time, but it has not been changed.

    All existing policies are preserved until you send new policies or an empty policy. For more information about parameter policies, see Working with Parameter Policies.

    " + } + } + }, + "PutParameterResult":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"PSParameterVersion", + "documentation":"

    The new version number of a parameter. If you edit a parameter value, Parameter Store automatically creates a new version and assigns this new version a unique ID. You can reference a parameter version ID in API actions or in Systems Manager documents (SSM documents). By default, if you don't specify a specific version, the system returns the latest parameter value when a parameter is called.

    " + }, + "Tier":{ + "shape":"ParameterTier", + "documentation":"

    The tier assigned to the parameter.

    " + } + } + }, + "Region":{"type":"string"}, + "Regions":{ + "type":"list", + "member":{"shape":"Region"}, + "max":50, + "min":1 + }, + "RegisterDefaultPatchBaselineRequest":{ + "type":"structure", + "required":["BaselineId"], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline that should be the default patch baseline.

    " + } + } + }, + "RegisterDefaultPatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the default patch baseline.

    " + } + } + }, + "RegisterPatchBaselineForPatchGroupRequest":{ + "type":"structure", + "required":[ + "BaselineId", + "PatchGroup" + ], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to register the patch group with.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group that should be registered with the patch baseline.

    " + } + } + }, + "RegisterPatchBaselineForPatchGroupResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline the patch group was registered with.

    " + }, + "PatchGroup":{ + "shape":"PatchGroup", + "documentation":"

    The name of the patch group registered with the patch baseline.

    " + } + } + }, + "RegisterTargetWithMaintenanceWindowRequest":{ + "type":"structure", + "required":[ + "WindowId", + "ResourceType", + "Targets" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the target should be registered with.

    " + }, + "ResourceType":{ + "shape":"MaintenanceWindowResourceType", + "documentation":"

    The type of target being registered with the maintenance window.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.

    You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.

    Example 1: Specify instance IDs

    Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

    Example 2: Use tag key-pairs applied to instances

    Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

    Example 3: Use tag-keys applied to instances

    Key=tag-key,Values=my-tag-key-1,my-tag-key-2

    Example 4: Use resource group names

    Key=resource-groups:Name,Values=resource-group-name

    Example 5: Use filters for resource group types

    Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

    For Key=resource-groups:ResourceTypeFilters, specify resource types in the following format

    Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

    For more information about these examples formats, including the best use case for each one, see Examples: Register Targets with a Maintenance Window in the AWS Systems Manager User Guide.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    An optional name for the target.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description for the target.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    User-provided idempotency token.

    ", + "idempotencyToken":true + } + } + }, + "RegisterTargetWithMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The ID of the target definition in this maintenance window.

    " + } + } + }, + "RegisterTaskWithMaintenanceWindowRequest":{ + "type":"structure", + "required":[ + "WindowId", + "Targets", + "TaskArn", + "TaskType", + "MaxConcurrency", + "MaxErrors" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window the task should be added to.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets (either instances or maintenance window targets).

    Specify instances using the following format:

    Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>

    Specify maintenance window targets using the following format:

    Key=WindowTargetIds;,Values=<window-target-id-1>,<window-target-id-2>

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The ARN of the task to run.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    For more information, see the following topics in the in the AWS Systems Manager User Guide:

    " + }, + "TaskType":{ + "shape":"MaintenanceWindowTaskType", + "documentation":"

    The type of task being registered.

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParameters", + "documentation":"

    The parameters that should be passed to the task when it is run.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "TaskInvocationParameters":{ + "shape":"MaintenanceWindowTaskInvocationParameters", + "documentation":"

    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The priority of the task in the maintenance window, the lower the number the higher the priority. Tasks in a maintenance window are scheduled in priority order with tasks that have the same priority scheduled in parallel.

    ", + "box":true + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets this task can be run for in parallel.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed before this task stops being scheduled.

    " + }, + "LoggingInfo":{ + "shape":"LoggingInfo", + "documentation":"

    A structure containing information about an Amazon S3 bucket to write instance-level logs to.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    An optional name for the task.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description for the task.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    User-provided idempotency token.

    ", + "idempotencyToken":true + } + } + }, + "RegisterTaskWithMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The ID of the task in the maintenance window.

    " + } + } + }, + "RegistrationLimit":{ + "type":"integer", + "max":1000, + "min":1 + }, + "RegistrationsCount":{ + "type":"integer", + "max":1000, + "min":1 + }, + "RelatedOpsItem":{ + "type":"structure", + "required":["OpsItemId"], + "members":{ + "OpsItemId":{ + "shape":"String", + "documentation":"

    The ID of an OpsItem related to the current OpsItem.

    " + } + }, + "documentation":"

    An OpsItems that shares something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    " + }, + "RelatedOpsItems":{ + "type":"list", + "member":{"shape":"RelatedOpsItem"} + }, + "RemainingCount":{"type":"integer"}, + "RemoveTagsFromResourceRequest":{ + "type":"structure", + "required":[ + "ResourceType", + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceType":{ + "shape":"ResourceTypeForTagging", + "documentation":"

    The type of resource from which you want to remove a tag.

    The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The ID of the resource from which you want to remove tags. For example:

    ManagedInstance: mi-012345abcde

    MaintenanceWindow: mw-012345abcde

    PatchBaseline: pb-012345abcde

    For the Document and Parameter values, use the name of the resource.

    The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.

    " + }, + "TagKeys":{ + "shape":"KeyList", + "documentation":"

    Tag keys that you want to remove from the specified resource.

    " + } + } + }, + "RemoveTagsFromResourceResult":{ + "type":"structure", + "members":{ + } + }, + "ResetServiceSettingRequest":{ + "type":"structure", + "required":["SettingId"], + "members":{ + "SettingId":{ + "shape":"ServiceSettingId", + "documentation":"

    The ID of the service setting to reset.

    " + } + }, + "documentation":"

    The request body of the ResetServiceSetting API action.

    " + }, + "ResetServiceSettingResult":{ + "type":"structure", + "members":{ + "ServiceSetting":{ + "shape":"ServiceSetting", + "documentation":"

    The current, effective service setting after calling the ResetServiceSetting API action.

    " + } + }, + "documentation":"

    The result body of the ResetServiceSetting API action.

    " + }, + "ResolvedTargets":{ + "type":"structure", + "members":{ + "ParameterValues":{ + "shape":"TargetParameterList", + "documentation":"

    A list of parameter values sent to targets that resolved during the Automation execution.

    " + }, + "Truncated":{ + "shape":"Boolean", + "documentation":"

    A boolean value indicating whether the resolved target list is truncated.

    " + } + }, + "documentation":"

    Information about targets that resolved during the Automation execution.

    " + }, + "ResourceComplianceSummaryItem":{ + "type":"structure", + "members":{ + "ComplianceType":{ + "shape":"ComplianceTypeName", + "documentation":"

    The compliance type.

    " + }, + "ResourceType":{ + "shape":"ComplianceResourceType", + "documentation":"

    The resource type.

    " + }, + "ResourceId":{ + "shape":"ComplianceResourceId", + "documentation":"

    The resource ID.

    " + }, + "Status":{ + "shape":"ComplianceStatus", + "documentation":"

    The compliance status for the resource.

    " + }, + "OverallSeverity":{ + "shape":"ComplianceSeverity", + "documentation":"

    The highest severity item found for the resource. The resource is compliant for this item.

    " + }, + "ExecutionSummary":{ + "shape":"ComplianceExecutionSummary", + "documentation":"

    Information about the execution.

    " + }, + "CompliantSummary":{ + "shape":"CompliantSummary", + "documentation":"

    A list of items that are compliant for the resource.

    " + }, + "NonCompliantSummary":{ + "shape":"NonCompliantSummary", + "documentation":"

    A list of items that aren't compliant for the resource.

    " + } + }, + "documentation":"

    Compliance summary information for a specific resource.

    " + }, + "ResourceComplianceSummaryItemList":{ + "type":"list", + "member":{"shape":"ResourceComplianceSummaryItem"} + }, + "ResourceCount":{"type":"integer"}, + "ResourceCountByStatus":{"type":"string"}, + "ResourceDataSyncAWSKMSKeyARN":{ + "type":"string", + "max":512, + "min":1, + "pattern":"arn:.*" + }, + "ResourceDataSyncAlreadyExistsException":{ + "type":"structure", + "members":{ + "SyncName":{"shape":"ResourceDataSyncName"} + }, + "documentation":"

    A sync configuration with the same name already exists.

    ", + "exception":true + }, + "ResourceDataSyncCountExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You have exceeded the allowed maximum sync configurations.

    ", + "exception":true + }, + "ResourceDataSyncCreatedTime":{"type":"timestamp"}, + "ResourceDataSyncInvalidConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified sync configuration is invalid.

    ", + "exception":true + }, + "ResourceDataSyncItem":{ + "type":"structure", + "members":{ + "SyncName":{ + "shape":"ResourceDataSyncName", + "documentation":"

    The name of the Resource Data Sync.

    " + }, + "S3Destination":{ + "shape":"ResourceDataSyncS3Destination", + "documentation":"

    Configuration information for the target Amazon S3 bucket.

    " + }, + "LastSyncTime":{ + "shape":"LastResourceDataSyncTime", + "documentation":"

    The last time the configuration attempted to sync (UTC).

    " + }, + "LastSuccessfulSyncTime":{ + "shape":"LastSuccessfulResourceDataSyncTime", + "documentation":"

    The last time the sync operations returned a status of SUCCESSFUL (UTC).

    " + }, + "LastStatus":{ + "shape":"LastResourceDataSyncStatus", + "documentation":"

    The status reported by the last sync.

    " + }, + "SyncCreatedTime":{ + "shape":"ResourceDataSyncCreatedTime", + "documentation":"

    The date and time the configuration was created (UTC).

    " + }, + "LastSyncStatusMessage":{ + "shape":"LastResourceDataSyncMessage", + "documentation":"

    The status message details reported by the last sync.

    " + } + }, + "documentation":"

    Information about a Resource Data Sync configuration, including its current status and last successful sync.

    " + }, + "ResourceDataSyncItemList":{ + "type":"list", + "member":{"shape":"ResourceDataSyncItem"} + }, + "ResourceDataSyncName":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceDataSyncNotFoundException":{ + "type":"structure", + "members":{ + "SyncName":{"shape":"ResourceDataSyncName"} + }, + "documentation":"

    The specified sync name was not found.

    ", + "exception":true + }, + "ResourceDataSyncS3BucketName":{ + "type":"string", + "max":2048, + "min":1 + }, + "ResourceDataSyncS3Destination":{ + "type":"structure", + "required":[ + "BucketName", + "SyncFormat", + "Region" + ], + "members":{ + "BucketName":{ + "shape":"ResourceDataSyncS3BucketName", + "documentation":"

    The name of the Amazon S3 bucket where the aggregated data is stored.

    " + }, + "Prefix":{ + "shape":"ResourceDataSyncS3Prefix", + "documentation":"

    An Amazon S3 prefix for the bucket.

    " + }, + "SyncFormat":{ + "shape":"ResourceDataSyncS3Format", + "documentation":"

    A supported sync format. The following format is currently supported: JsonSerDe

    " + }, + "Region":{ + "shape":"ResourceDataSyncS3Region", + "documentation":"

    The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

    " + }, + "AWSKMSKeyARN":{ + "shape":"ResourceDataSyncAWSKMSKeyARN", + "documentation":"

    The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.

    " + } + }, + "documentation":"

    Information about the target Amazon S3 bucket for the Resource Data Sync.

    " + }, + "ResourceDataSyncS3Format":{ + "type":"string", + "enum":["JsonSerDe"] + }, + "ResourceDataSyncS3Prefix":{ + "type":"string", + "max":256, + "min":1 + }, + "ResourceDataSyncS3Region":{ + "type":"string", + "max":64, + "min":1 + }, + "ResourceId":{"type":"string"}, + "ResourceInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Error returned if an attempt is made to delete a patch baseline that is registered for a patch group.

    ", + "exception":true + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Error returned when the caller has exceeded the default resource limits. For example, too many maintenance windows or patch baselines have been created.

    For information about resource limits in Systems Manager, see AWS Systems Manager Limits.

    ", + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "ManagedInstance", + "Document", + "EC2Instance" + ] + }, + "ResourceTypeForTagging":{ + "type":"string", + "enum":[ + "Document", + "ManagedInstance", + "MaintenanceWindow", + "Parameter", + "PatchBaseline", + "OpsItem" + ] + }, + "ResponseCode":{"type":"integer"}, + "ResultAttribute":{ + "type":"structure", + "required":["TypeName"], + "members":{ + "TypeName":{ + "shape":"InventoryItemTypeName", + "documentation":"

    Name of the inventory item type. Valid value: AWS:InstanceInformation. Default Value: AWS:InstanceInformation.

    " + } + }, + "documentation":"

    The inventory item result attribute.

    " + }, + "ResultAttributeList":{ + "type":"list", + "member":{"shape":"ResultAttribute"}, + "max":1, + "min":1 + }, + "ResumeSessionRequest":{ + "type":"structure", + "required":["SessionId"], + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the disconnected session to resume.

    " + } + } + }, + "ResumeSessionResponse":{ + "type":"structure", + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the session.

    " + }, + "TokenValue":{ + "shape":"TokenValue", + "documentation":"

    An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

    " + }, + "StreamUrl":{ + "shape":"StreamUrl", + "documentation":"

    A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output).

    region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference.

    session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

    " + } + } + }, + "S3BucketName":{ + "type":"string", + "max":63, + "min":3 + }, + "S3KeyPrefix":{ + "type":"string", + "max":500 + }, + "S3OutputLocation":{ + "type":"structure", + "members":{ + "OutputS3Region":{ + "shape":"S3Region", + "documentation":"

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

    " + }, + "OutputS3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The name of the Amazon S3 bucket.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The Amazon S3 bucket subfolder.

    " + } + }, + "documentation":"

    An Amazon S3 bucket where you want to store the results of this request.

    " + }, + "S3OutputUrl":{ + "type":"structure", + "members":{ + "OutputUrl":{ + "shape":"Url", + "documentation":"

    A URL for an Amazon S3 bucket where you want to store the results of this request.

    " + } + }, + "documentation":"

    A URL for the Amazon S3 bucket where you want to store the results of this request.

    " + }, + "S3Region":{ + "type":"string", + "max":20, + "min":3 + }, + "ScheduleExpression":{ + "type":"string", + "max":256, + "min":1 + }, + "ScheduledWindowExecution":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window to be run.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window to be run.

    " + }, + "ExecutionTime":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The time, in ISO-8601 Extended format, that the maintenance window is scheduled to be run.

    " + } + }, + "documentation":"

    Information about a scheduled execution for a maintenance window.

    " + }, + "ScheduledWindowExecutionList":{ + "type":"list", + "member":{"shape":"ScheduledWindowExecution"} + }, + "SendAutomationSignalRequest":{ + "type":"structure", + "required":[ + "AutomationExecutionId", + "SignalType" + ], + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The unique identifier for an existing Automation execution that you want to send the signal to.

    " + }, + "SignalType":{ + "shape":"SignalType", + "documentation":"

    The type of signal to send to an Automation execution.

    " + }, + "Payload":{ + "shape":"AutomationParameterMap", + "documentation":"

    The data sent with the signal. The data schema depends on the type of signal used in the request.

    For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

    Comment=\"Looks good\"

    For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

    StepName=\"step1\"

    For the StopStep signal type, you must send the step execution ID as the payload. For example:

    StepExecutionId=\"97fff367-fc5a-4299-aed8-0123456789ab\"

    " + } + } + }, + "SendAutomationSignalResult":{ + "type":"structure", + "members":{ + } + }, + "SendCommandRequest":{ + "type":"structure", + "required":["DocumentName"], + "members":{ + "InstanceIds":{ + "shape":"InstanceIdList", + "documentation":"

    The instance IDs where the command should run. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    (Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use targets, see Sending Commands to a Fleet in the AWS Systems Manager User Guide.

    " + }, + "DocumentName":{ + "shape":"DocumentARN", + "documentation":"

    Required. The name of the Systems Manager document to run. This can be a public document or a custom document.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

    --document-version \"\\$DEFAULT\"

    --document-version \"\\$LATEST\"

    --document-version \"3\"

    " + }, + "DocumentHash":{ + "shape":"DocumentHash", + "documentation":"

    The Sha256 or Sha1 hash created by the system when the document was created.

    Sha1 hashes have been deprecated.

    " + }, + "DocumentHashType":{ + "shape":"DocumentHashType", + "documentation":"

    Sha256 or Sha1.

    Sha1 hashes have been deprecated.

    " + }, + "TimeoutSeconds":{ + "shape":"TimeoutSeconds", + "documentation":"

    If this time is reached and the command has not already started running, it will not run.

    ", + "box":true + }, + "Comment":{ + "shape":"Comment", + "documentation":"

    User-specified information about the command, such as a brief description of what the command should do.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    The required and optional parameters specified in the document being run.

    " + }, + "OutputS3Region":{ + "shape":"S3Region", + "documentation":"

    (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

    " + }, + "OutputS3BucketName":{ + "shape":"S3BucketName", + "documentation":"

    The name of the S3 bucket where command execution responses should be stored.

    " + }, + "OutputS3KeyPrefix":{ + "shape":"S3KeyPrefix", + "documentation":"

    The directory structure within the S3 bucket where the responses should be stored.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    (Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls in the AWS Systems Manager User Guide.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using Error Controls in the AWS Systems Manager User Guide.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

    " + }, + "NotificationConfig":{ + "shape":"NotificationConfig", + "documentation":"

    Configurations for sending notifications.

    " + }, + "CloudWatchOutputConfig":{ + "shape":"CloudWatchOutputConfig", + "documentation":"

    Enables Systems Manager to send Run Command output to Amazon CloudWatch Logs.

    " + } + } + }, + "SendCommandResult":{ + "type":"structure", + "members":{ + "Command":{ + "shape":"Command", + "documentation":"

    The request as it was received by Systems Manager. Also provides the command ID which can be used future references to this request.

    " + } + } + }, + "ServiceRole":{"type":"string"}, + "ServiceSetting":{ + "type":"structure", + "members":{ + "SettingId":{ + "shape":"ServiceSettingId", + "documentation":"

    The ID of the service setting.

    " + }, + "SettingValue":{ + "shape":"ServiceSettingValue", + "documentation":"

    The value of the service setting.

    " + }, + "LastModifiedDate":{ + "shape":"DateTime", + "documentation":"

    The last time the service setting was modified.

    " + }, + "LastModifiedUser":{ + "shape":"String", + "documentation":"

    The ARN of the last modified user. This field is populated only if the setting value was overwritten.

    " + }, + "ARN":{ + "shape":"String", + "documentation":"

    The ARN of the service setting.

    " + }, + "Status":{ + "shape":"String", + "documentation":"

    The status of the service setting. The value can be Default, Customized or PendingUpdate.

    • Default: The current setting uses a default value provisioned by the AWS service team.

    • Customized: The current setting use a custom value specified by the customer.

    • PendingUpdate: The current setting uses a default or custom value, but a setting change request is pending approval.

    " + } + }, + "documentation":"

    The service setting data structure.

    ServiceSetting is an account-level setting for an AWS service. This setting defines how a user interacts with or uses a service or a feature of a service. For example, if an AWS service charges money to the account based on feature or service usage, then the AWS service team might create a default setting of \"false\". This means the user can't use this feature unless they change the setting to \"true\" and intentionally opt in for a paid feature.

    Services map a SettingId object to a setting value. AWS services teams define the default value for a SettingId. You can't create a new SettingId, but you can overwrite the default value if you have the ssm:UpdateServiceSetting permission for the setting. Use the UpdateServiceSetting API action to change the default setting. Or, use the ResetServiceSetting to change the value back to the original value defined by the AWS service team.

    " + }, + "ServiceSettingId":{ + "type":"string", + "max":1000, + "min":1 + }, + "ServiceSettingNotFound":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified service setting was not found. Either the service name or the setting has not been provisioned by the AWS service team.

    ", + "exception":true + }, + "ServiceSettingValue":{ + "type":"string", + "max":4096, + "min":1 + }, + "Session":{ + "type":"structure", + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the session.

    " + }, + "Target":{ + "shape":"SessionTarget", + "documentation":"

    The instance that the Session Manager session connected to.

    " + }, + "Status":{ + "shape":"SessionStatus", + "documentation":"

    The status of the session. For example, \"Connected\" or \"Terminated\".

    " + }, + "StartDate":{ + "shape":"DateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, when the session began.

    " + }, + "EndDate":{ + "shape":"DateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, when the session was terminated.

    " + }, + "DocumentName":{ + "shape":"DocumentName", + "documentation":"

    The name of the Session Manager SSM document used to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell.

    " + }, + "Owner":{ + "shape":"SessionOwner", + "documentation":"

    The ID of the AWS user account that started the session.

    " + }, + "Details":{ + "shape":"SessionDetails", + "documentation":"

    Reserved for future use.

    " + }, + "OutputUrl":{ + "shape":"SessionManagerOutputUrl", + "documentation":"

    Reserved for future use.

    " + } + }, + "documentation":"

    Information about a Session Manager connection to an instance.

    " + }, + "SessionDetails":{ + "type":"string", + "max":1024, + "min":1 + }, + "SessionFilter":{ + "type":"structure", + "required":[ + "key", + "value" + ], + "members":{ + "key":{ + "shape":"SessionFilterKey", + "documentation":"

    The name of the filter.

    " + }, + "value":{ + "shape":"SessionFilterValue", + "documentation":"

    The filter value. Valid values for each filter key are as follows:

    • InvokedAfter: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.

    • InvokedBefore: Specify a timestamp to limit your results. For example, specify 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.

    • Target: Specify an instance to which session connections have been made.

    • Owner: Specify an AWS user account to see a list of sessions started by that user.

    • Status: Specify a valid session status to see a list of all sessions with that status. Status values you can specify include:

      • Connected

      • Connecting

      • Disconnected

      • Terminated

      • Terminating

      • Failed

    " + } + }, + "documentation":"

    Describes a filter for Session Manager information.

    " + }, + "SessionFilterKey":{ + "type":"string", + "enum":[ + "InvokedAfter", + "InvokedBefore", + "Target", + "Owner", + "Status" + ] + }, + "SessionFilterList":{ + "type":"list", + "member":{"shape":"SessionFilter"}, + "max":5, + "min":1 + }, + "SessionFilterValue":{ + "type":"string", + "max":400, + "min":1 + }, + "SessionId":{ + "type":"string", + "max":96, + "min":1 + }, + "SessionList":{ + "type":"list", + "member":{"shape":"Session"} + }, + "SessionManagerCloudWatchOutputUrl":{ + "type":"string", + "max":2083, + "min":1 + }, + "SessionManagerOutputUrl":{ + "type":"structure", + "members":{ + "S3OutputUrl":{ + "shape":"SessionManagerS3OutputUrl", + "documentation":"

    Reserved for future use.

    " + }, + "CloudWatchOutputUrl":{ + "shape":"SessionManagerCloudWatchOutputUrl", + "documentation":"

    Reserved for future use.

    " + } + }, + "documentation":"

    Reserved for future use.

    " + }, + "SessionManagerParameterName":{ + "type":"string", + "max":255, + "min":1 + }, + "SessionManagerParameterValue":{ + "type":"string", + "max":65535, + "min":1 + }, + "SessionManagerParameterValueList":{ + "type":"list", + "member":{"shape":"SessionManagerParameterValue"} + }, + "SessionManagerParameters":{ + "type":"map", + "key":{"shape":"SessionManagerParameterName"}, + "value":{"shape":"SessionManagerParameterValueList"} + }, + "SessionManagerS3OutputUrl":{ + "type":"string", + "max":2083, + "min":1 + }, + "SessionMaxResults":{ + "type":"integer", + "max":200, + "min":1 + }, + "SessionOwner":{ + "type":"string", + "max":256, + "min":1 + }, + "SessionState":{ + "type":"string", + "enum":[ + "Active", + "History" + ] + }, + "SessionStatus":{ + "type":"string", + "enum":[ + "Connected", + "Connecting", + "Disconnected", + "Terminated", + "Terminating", + "Failed" + ] + }, + "SessionTarget":{ + "type":"string", + "max":400, + "min":1 + }, + "SeveritySummary":{ + "type":"structure", + "members":{ + "CriticalCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of critical. Critical severity is determined by the organization that published the compliance items.

    " + }, + "HighCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

    " + }, + "MediumCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

    " + }, + "LowCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

    " + }, + "InformationalCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

    " + }, + "UnspecifiedCount":{ + "shape":"ComplianceSummaryCount", + "documentation":"

    The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

    " + } + }, + "documentation":"

    The number of managed instances found for each patch severity level defined in the request filter.

    " + }, + "SignalType":{ + "type":"string", + "enum":[ + "Approve", + "Reject", + "StartStep", + "StopStep", + "Resume" + ] + }, + "SnapshotDownloadUrl":{"type":"string"}, + "SnapshotId":{ + "type":"string", + "max":36, + "min":36, + "pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, + "StandardErrorContent":{ + "type":"string", + "max":8000 + }, + "StandardOutputContent":{ + "type":"string", + "max":24000 + }, + "StartAssociationsOnceRequest":{ + "type":"structure", + "required":["AssociationIds"], + "members":{ + "AssociationIds":{ + "shape":"AssociationIdList", + "documentation":"

    The association IDs that you want to run immediately and only one time.

    " + } + } + }, + "StartAssociationsOnceResult":{ + "type":"structure", + "members":{ + } + }, + "StartAutomationExecutionRequest":{ + "type":"structure", + "required":["DocumentName"], + "members":{ + "DocumentName":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Automation document to use for this execution.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The version of the Automation document to use for this execution.

    ", + "box":true + }, + "Parameters":{ + "shape":"AutomationParameterMap", + "documentation":"

    A key-value map of execution parameters, which match the declared parameters in the Automation document.

    " + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"

    User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

    " + }, + "Mode":{ + "shape":"ExecutionMode", + "documentation":"

    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

    " + }, + "TargetParameterName":{ + "shape":"AutomationParameterKey", + "documentation":"

    The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    A key-value mapping to target resources. Required if you specify TargetParameterName.

    " + }, + "TargetMaps":{ + "shape":"TargetMaps", + "documentation":"

    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

    Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

    " + }, + "TargetLocations":{ + "shape":"TargetLocations", + "documentation":"

    A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

    ", + "box":true + } + } + }, + "StartAutomationExecutionResult":{ + "type":"structure", + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The unique ID of a newly scheduled automation execution.

    " + } + } + }, + "StartSessionRequest":{ + "type":"structure", + "required":["Target"], + "members":{ + "Target":{ + "shape":"SessionTarget", + "documentation":"

    The instance to connect to for the session.

    " + }, + "DocumentName":{ + "shape":"DocumentARN", + "documentation":"

    The name of the SSM document to define the parameters and plugin settings for the session. For example, SSM-SessionManagerRunShell. If no document name is provided, a shell to the instance is launched by default.

    " + }, + "Parameters":{ + "shape":"SessionManagerParameters", + "documentation":"

    Reserved for future use.

    " + } + } + }, + "StartSessionResponse":{ + "type":"structure", + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the session.

    " + }, + "TokenValue":{ + "shape":"TokenValue", + "documentation":"

    An encrypted token value containing session and caller information. Used to authenticate the connection to the instance.

    " + }, + "StreamUrl":{ + "shape":"StreamUrl", + "documentation":"

    A URL back to SSM Agent on the instance that the Session Manager client uses to send commands and receive output from the instance. Format: wss://ssmmessages.region.amazonaws.com/v1/data-channel/session-id?stream=(input|output)

    region represents the Region identifier for an AWS Region supported by AWS Systems Manager, such as us-east-2 for the US East (Ohio) Region. For a list of supported region values, see the Region column in the AWS Systems Manager table of regions and endpoints in the AWS General Reference.

    session-id represents the ID of a Session Manager session, such as 1a2b3c4dEXAMPLE.

    " + } + } + }, + "StatusAdditionalInfo":{ + "type":"string", + "max":1024 + }, + "StatusDetails":{ + "type":"string", + "max":100, + "min":0 + }, + "StatusMessage":{ + "type":"string", + "max":1024, + "min":1 + }, + "StatusName":{"type":"string"}, + "StatusUnchanged":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The updated status is the same as the current status.

    ", + "exception":true + }, + "StepExecution":{ + "type":"structure", + "members":{ + "StepName":{ + "shape":"String", + "documentation":"

    The name of this execution step.

    " + }, + "Action":{ + "shape":"AutomationActionName", + "documentation":"

    The action this step performs. The action determines the behavior of the step.

    " + }, + "TimeoutSeconds":{ + "shape":"Long", + "documentation":"

    The timeout seconds of the step.

    ", + "box":true + }, + "OnFailure":{ + "shape":"String", + "documentation":"

    The action to take if the step fails. The default value is Abort.

    " + }, + "MaxAttempts":{ + "shape":"Integer", + "documentation":"

    The maximum number of tries to run the action of the step. The default value is 1.

    ", + "box":true + }, + "ExecutionStartTime":{ + "shape":"DateTime", + "documentation":"

    If a step has begun execution, this contains the time the step started. If the step is in Pending status, this field is not populated.

    " + }, + "ExecutionEndTime":{ + "shape":"DateTime", + "documentation":"

    If a step has finished execution, this contains the time the execution ended. If the step has not yet concluded, this field is not populated.

    " + }, + "StepStatus":{ + "shape":"AutomationExecutionStatus", + "documentation":"

    The execution status for this step. Valid values include: Pending, InProgress, Success, Cancelled, Failed, and TimedOut.

    " + }, + "ResponseCode":{ + "shape":"String", + "documentation":"

    The response code returned by the execution of the step.

    " + }, + "Inputs":{ + "shape":"NormalStringMap", + "documentation":"

    Fully-resolved values passed into the step before execution.

    " + }, + "Outputs":{ + "shape":"AutomationParameterMap", + "documentation":"

    Returned values from the execution of the step.

    " + }, + "Response":{ + "shape":"String", + "documentation":"

    A message associated with the response code for an execution.

    " + }, + "FailureMessage":{ + "shape":"String", + "documentation":"

    If a step failed, this message explains why the execution failed.

    " + }, + "FailureDetails":{ + "shape":"FailureDetails", + "documentation":"

    Information about the Automation failure.

    " + }, + "StepExecutionId":{ + "shape":"String", + "documentation":"

    The unique ID of a step execution.

    " + }, + "OverriddenParameters":{ + "shape":"AutomationParameterMap", + "documentation":"

    A user-specified list of parameters to override when running a step.

    " + }, + "IsEnd":{ + "shape":"Boolean", + "documentation":"

    The flag which can be used to end automation no matter whether the step succeeds or fails.

    ", + "box":true + }, + "NextStep":{ + "shape":"String", + "documentation":"

    The next step after the step succeeds.

    ", + "box":true + }, + "IsCritical":{ + "shape":"Boolean", + "documentation":"

    The flag which can be used to help decide whether the failure of current step leads to the Automation failure.

    ", + "box":true + }, + "ValidNextSteps":{ + "shape":"ValidNextStepList", + "documentation":"

    Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step. With conditional branching, we add step:stepName to support the automation to go to another specific step.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets for the step execution.

    ", + "box":true + }, + "TargetLocation":{ + "shape":"TargetLocation", + "documentation":"

    The combination of AWS Regions and accounts targeted by the current Automation execution.

    ", + "box":true + } + }, + "documentation":"

    Detailed information about an the execution state of an Automation step.

    " + }, + "StepExecutionFilter":{ + "type":"structure", + "required":[ + "Key", + "Values" + ], + "members":{ + "Key":{ + "shape":"StepExecutionFilterKey", + "documentation":"

    One or more keys to limit the results. Valid filter keys include the following: StepName, Action, StepExecutionId, StepExecutionStatus, StartTimeBefore, StartTimeAfter.

    " + }, + "Values":{ + "shape":"StepExecutionFilterValueList", + "documentation":"

    The values of the filter key.

    " + } + }, + "documentation":"

    A filter to limit the amount of step execution information returned by the call.

    " + }, + "StepExecutionFilterKey":{ + "type":"string", + "enum":[ + "StartTimeBefore", + "StartTimeAfter", + "StepExecutionStatus", + "StepExecutionId", + "StepName", + "Action" + ] + }, + "StepExecutionFilterList":{ + "type":"list", + "member":{"shape":"StepExecutionFilter"}, + "max":6, + "min":1 + }, + "StepExecutionFilterValue":{ + "type":"string", + "max":150, + "min":1 + }, + "StepExecutionFilterValueList":{ + "type":"list", + "member":{"shape":"StepExecutionFilterValue"}, + "max":10, + "min":1 + }, + "StepExecutionList":{ + "type":"list", + "member":{"shape":"StepExecution"} + }, + "StopAutomationExecutionRequest":{ + "type":"structure", + "required":["AutomationExecutionId"], + "members":{ + "AutomationExecutionId":{ + "shape":"AutomationExecutionId", + "documentation":"

    The execution ID of the Automation to stop.

    " + }, + "Type":{ + "shape":"StopType", + "documentation":"

    The stop request type. Valid types include the following: Cancel and Complete. The default type is Cancel.

    " + } + } + }, + "StopAutomationExecutionResult":{ + "type":"structure", + "members":{ + } + }, + "StopType":{ + "type":"string", + "enum":[ + "Complete", + "Cancel" + ] + }, + "StreamUrl":{"type":"string"}, + "String":{"type":"string"}, + "StringDateTime":{ + "type":"string", + "pattern":"^([\\-]?\\d{4}(?!\\d{2}\\b))((-?)((0[1-9]|1[0-2])(\\3([12]\\d|0[1-9]|3[01]))?|W([0-4]\\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\\d|[12]\\d{2}|3([0-5]\\d|6[1-6])))([T\\s]((([01]\\d|2[0-3])((:?)[0-5]\\d)?|24\\:?00)([\\.,]\\d(?!:))?)?(\\17[0-5]\\d([\\.,]\\d)?)?([zZ]|([\\-])([01]\\d|2[0-3]):?([0-5]\\d)?)?)?)?$" + }, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubTypeCountLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The sub-type count exceeded the limit for the inventory type.

    ", + "exception":true + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The name of the tag.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value of the tag.

    " + } + }, + "documentation":"

    Metadata that you assign to your AWS resources. Tags enable you to categorize your resources in different ways, for example, by purpose, owner, or environment. In Systems Manager, you can apply tags to documents, managed instances, maintenance windows, Parameter Store parameters, and patch baselines.

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":1000 + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Target":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TargetKey", + "documentation":"

    User-defined criteria for sending commands that target instances that meet the criteria.

    " + }, + "Values":{ + "shape":"TargetValues", + "documentation":"

    User-defined criteria that maps to Key. For example, if you specified tag:ServerRole, you could specify value:WebServer to run a command on instances that include Amazon EC2 tags of ServerRole,WebServer.

    " + } + }, + "documentation":"

    An array of search criteria that targets instances using a Key,Value combination that you specify.

    Supported formats include the following.

    • Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3

    • Key=tag:my-tag-key,Values=my-tag-value-1,my-tag-value-2

    • Key=tag-key,Values=my-tag-key-1,my-tag-key-2

    • (Maintenance window targets only) Key=resource-groups:Name,Values=resource-group-name

    • (Maintenance window targets only) Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

    For example:

    • Key=InstanceIds,Values=i-02573cafcfEXAMPLE,i-0471e04240EXAMPLE,i-07782c72faEXAMPLE

    • Key=tag:CostCenter,Values=CostCenter1,CostCenter2,CostCenter3

    • Key=tag-key,Values=Name,Instance-Type,CostCenter

    • (Maintenance window targets only) Key=resource-groups:Name,Values=ProductionResourceGroup

    • (Maintenance window targets only) Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC

    For information about how to send commands that target instances using Key,Value parameters, see Using Targets and Rate Controls to Send Commands to a Fleet in the AWS Systems Manager User Guide.

    " + }, + "TargetCount":{"type":"integer"}, + "TargetInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You specified the Safe option for the DeregisterTargetFromMaintenanceWindow operation, but the target is still referenced in a task.

    ", + "exception":true + }, + "TargetKey":{ + "type":"string", + "max":163, + "min":1, + "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=\\-@]*$|resource-groups:ResourceTypeFilters|resource-groups:Name" + }, + "TargetLocation":{ + "type":"structure", + "members":{ + "Accounts":{ + "shape":"Accounts", + "documentation":"

    The AWS accounts targeted by the current Automation execution.

    " + }, + "Regions":{ + "shape":"Regions", + "documentation":"

    The AWS Regions targeted by the current Automation execution.

    " + }, + "TargetLocationMaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of AWS accounts and AWS regions allowed to run the Automation concurrently

    ", + "box":true + }, + "TargetLocationMaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation.

    ", + "box":true + }, + "ExecutionRoleName":{ + "shape":"ExecutionRoleName", + "documentation":"

    The Automation execution role used by the currently running Automation.

    ", + "box":true + } + }, + "documentation":"

    The combination of AWS Regions and accounts targeted by the current Automation execution.

    " + }, + "TargetLocations":{ + "type":"list", + "member":{"shape":"TargetLocation"}, + "max":100, + "min":1 + }, + "TargetMap":{ + "type":"map", + "key":{"shape":"TargetMapKey"}, + "value":{"shape":"TargetMapValueList"}, + "max":20, + "min":1 + }, + "TargetMapKey":{ + "type":"string", + "max":50, + "min":1 + }, + "TargetMapValue":{ + "type":"string", + "max":50, + "min":1 + }, + "TargetMapValueList":{ + "type":"list", + "member":{"shape":"TargetMapValue"}, + "max":25, + "min":0 + }, + "TargetMaps":{ + "type":"list", + "member":{"shape":"TargetMap"}, + "max":300, + "min":0 + }, + "TargetNotConnected":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified target instance for the session is not fully configured for use with Session Manager. For more information, see Getting Started with Session Manager in the AWS Systems Manager User Guide.

    ", + "exception":true + }, + "TargetParameterList":{ + "type":"list", + "member":{"shape":"ParameterValue"} + }, + "TargetType":{ + "type":"string", + "max":200, + "pattern":"^\\/[\\w\\.\\-\\:\\/]*$" + }, + "TargetValue":{"type":"string"}, + "TargetValues":{ + "type":"list", + "member":{"shape":"TargetValue"}, + "max":50, + "min":0 + }, + "Targets":{ + "type":"list", + "member":{"shape":"Target"}, + "max":5, + "min":0 + }, + "TerminateSessionRequest":{ + "type":"structure", + "required":["SessionId"], + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the session to terminate.

    " + } + } + }, + "TerminateSessionResponse":{ + "type":"structure", + "members":{ + "SessionId":{ + "shape":"SessionId", + "documentation":"

    The ID of the session that has been terminated.

    " + } + } + }, + "TimeoutSeconds":{ + "type":"integer", + "max":2592000, + "min":30 + }, + "TokenValue":{ + "type":"string", + "max":300, + "min":0 + }, + "TooManyTagsError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The Targets parameter includes too many tags. Remove one or more tags and try the command again.

    ", + "exception":true + }, + "TooManyUpdates":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    There are concurrent updates for a resource that supports one update at a time.

    ", + "exception":true + }, + "TotalCount":{"type":"integer"}, + "TotalSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The size of inventory data has exceeded the total size limit for the resource.

    ", + "exception":true + }, + "UnsupportedFeatureRequiredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Microsoft application patching is only available on EC2 instances and Advanced Instances. To patch Microsoft applications on on-premises servers and VMs, you must enable Advanced Instances. For more information, see Using the Advanced-Instances Tier in the AWS Systems Manager User Guide.

    ", + "exception":true + }, + "UnsupportedInventoryItemContextException":{ + "type":"structure", + "members":{ + "TypeName":{"shape":"InventoryItemTypeName"}, + "Message":{"shape":"String"} + }, + "documentation":"

    The Context attribute that you specified for the InventoryItem is not allowed for this inventory type. You can only use the Context attribute with inventory types like AWS:ComplianceItem.

    ", + "exception":true + }, + "UnsupportedInventorySchemaVersionException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Inventory item type schema version has to match supported versions in the service. Check output of GetInventorySchema to see the available schema version for each type.

    ", + "exception":true + }, + "UnsupportedOperatingSystem":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The operating systems you specified is not supported, or the operation is not supported for the operating system. Valid operating systems include: Windows, AmazonLinux, RedhatEnterpriseLinux, and Ubuntu.

    ", + "exception":true + }, + "UnsupportedParameterType":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "documentation":"

    The parameter type is not supported.

    ", + "exception":true + }, + "UnsupportedPlatformType":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The document does not support the platform type of the given instance ID(s). For example, you sent an document for a Windows instance to a Linux instance.

    ", + "exception":true + }, + "UpdateAssociationRequest":{ + "type":"structure", + "required":["AssociationId"], + "members":{ + "AssociationId":{ + "shape":"AssociationId", + "documentation":"

    The ID of the association you want to update.

    " + }, + "Parameters":{ + "shape":"Parameters", + "documentation":"

    The parameters you want to update for the association. If you create a parameter using Parameter Store, you can reference the parameter using {{ssm:parameter-name}}

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    The document version you want update for the association.

    " + }, + "ScheduleExpression":{ + "shape":"ScheduleExpression", + "documentation":"

    The cron expression used to schedule the association that you want to update.

    " + }, + "OutputLocation":{ + "shape":"InstanceAssociationOutputLocation", + "documentation":"

    An Amazon S3 bucket where you want to store the results of this request.

    " + }, + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the SSM document that contains the configuration information for the instance. You can specify Command or Automation documents.

    You can specify AWS-predefined documents, documents you created, or a document that is shared with you from another account.

    For SSM documents that are shared with you from other AWS accounts, you must specify the complete SSM document ARN, in the following format:

    arn:aws:ssm:region:account-id:document/document-name

    For example:

    arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

    For AWS-predefined documents and SSM documents you created in your account, you only need to specify the document name. For example, AWS-ApplyPatchBaseline or My-Document.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets of the association.

    " + }, + "AssociationName":{ + "shape":"AssociationName", + "documentation":"

    The name of the association that you want to update.

    " + }, + "AssociationVersion":{ + "shape":"AssociationVersion", + "documentation":"

    This parameter is provided for concurrency control purposes. You must specify the latest association version in the service. If you want to ensure that this request succeeds, either specify $LATEST, or omit this parameter.

    " + }, + "AutomationTargetParameterName":{ + "shape":"AutomationTargetParameterName", + "documentation":"

    Specify the target for the association. This target is required for associations that use an Automation document and target resources by using rate controls.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops sending requests when the fourth error is received. If you specify 0, then the system stops sending requests after the first error is returned. If you run an association on 50 instances and set MaxError to 10%, then the system stops sending the request when the sixth error is received.

    Executions that are already running an association when MaxErrors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set MaxConcurrency to 1 so that executions proceed one at a time.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. The default value is 100%, which means all targets run the association at the same time.

    If a new instance starts and attempts to run an association while Systems Manager is running MaxConcurrency associations, the association is allowed to run. During the next association interval, the new instance will process its association within the limit specified for MaxConcurrency.

    " + }, + "ComplianceSeverity":{ + "shape":"AssociationComplianceSeverity", + "documentation":"

    The severity level to assign to the association.

    " + } + } + }, + "UpdateAssociationResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{ + "shape":"AssociationDescription", + "documentation":"

    The description of the association that was updated.

    " + } + } + }, + "UpdateAssociationStatusRequest":{ + "type":"structure", + "required":[ + "Name", + "InstanceId", + "AssociationStatus" + ], + "members":{ + "Name":{ + "shape":"DocumentARN", + "documentation":"

    The name of the Systems Manager document.

    " + }, + "InstanceId":{ + "shape":"InstanceId", + "documentation":"

    The ID of the instance.

    " + }, + "AssociationStatus":{ + "shape":"AssociationStatus", + "documentation":"

    The association status.

    " + } + } + }, + "UpdateAssociationStatusResult":{ + "type":"structure", + "members":{ + "AssociationDescription":{ + "shape":"AssociationDescription", + "documentation":"

    Information about the association.

    " + } + } + }, + "UpdateDocumentDefaultVersionRequest":{ + "type":"structure", + "required":[ + "Name", + "DocumentVersion" + ], + "members":{ + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of a custom document that you want to set as the default version.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersionNumber", + "documentation":"

    The version of a custom document that you want to set as the default version.

    " + } + } + }, + "UpdateDocumentDefaultVersionResult":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"DocumentDefaultVersionDescription", + "documentation":"

    The description of a custom document that you want to set as the default version.

    " + } + } + }, + "UpdateDocumentRequest":{ + "type":"structure", + "required":[ + "Content", + "Name" + ], + "members":{ + "Content":{ + "shape":"DocumentContent", + "documentation":"

    A valid JSON or YAML string.

    " + }, + "Attachments":{ + "shape":"AttachmentsSourceList", + "documentation":"

    A list of key and value pairs that describe attachments to a version of a document.

    " + }, + "Name":{ + "shape":"DocumentName", + "documentation":"

    The name of the document that you want to update.

    " + }, + "VersionName":{ + "shape":"DocumentVersionName", + "documentation":"

    An optional field specifying the version of the artifact you are updating with the document. For example, \"Release 12, Update 6\". This value is unique across all versions of a document, and cannot be changed.

    " + }, + "DocumentVersion":{ + "shape":"DocumentVersion", + "documentation":"

    (Required) The version of the document that you want to update.

    " + }, + "DocumentFormat":{ + "shape":"DocumentFormat", + "documentation":"

    Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

    " + }, + "TargetType":{ + "shape":"TargetType", + "documentation":"

    Specify a new target type for the document.

    " + } + } + }, + "UpdateDocumentResult":{ + "type":"structure", + "members":{ + "DocumentDescription":{ + "shape":"DocumentDescription", + "documentation":"

    A description of the document that was updated.

    " + } + } + }, + "UpdateMaintenanceWindowRequest":{ + "type":"structure", + "required":["WindowId"], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window to update.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description for the update request.

    " + }, + "StartDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.

    " + }, + "EndDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

    " + }, + "Schedule":{ + "shape":"MaintenanceWindowSchedule", + "documentation":"

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + }, + "ScheduleTimezone":{ + "shape":"MaintenanceWindowTimezone", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.

    " + }, + "Duration":{ + "shape":"MaintenanceWindowDurationHours", + "documentation":"

    The duration of the maintenance window in hours.

    ", + "box":true + }, + "Cutoff":{ + "shape":"MaintenanceWindowCutoff", + "documentation":"

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

    ", + "box":true + }, + "AllowUnassociatedTargets":{ + "shape":"MaintenanceWindowAllowUnassociatedTargets", + "documentation":"

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

    ", + "box":true + }, + "Enabled":{ + "shape":"MaintenanceWindowEnabled", + "documentation":"

    Whether the maintenance window is enabled.

    ", + "box":true + }, + "Replace":{ + "shape":"Boolean", + "documentation":"

    If True, then all fields that are required by the CreateMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

    ", + "box":true + } + } + }, + "UpdateMaintenanceWindowResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the created maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The name of the maintenance window.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description of the update.

    " + }, + "StartDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active. The maintenance window will not run before this specified time.

    " + }, + "EndDate":{ + "shape":"MaintenanceWindowStringDateTime", + "documentation":"

    The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive. The maintenance window will not run after this specified time.

    " + }, + "Schedule":{ + "shape":"MaintenanceWindowSchedule", + "documentation":"

    The schedule of the maintenance window in the form of a cron or rate expression.

    " + }, + "ScheduleTimezone":{ + "shape":"MaintenanceWindowTimezone", + "documentation":"

    The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: \"America/Los_Angeles\", \"etc/UTC\", or \"Asia/Seoul\". For more information, see the Time Zone Database on the IANA website.

    " + }, + "Duration":{ + "shape":"MaintenanceWindowDurationHours", + "documentation":"

    The duration of the maintenance window in hours.

    " + }, + "Cutoff":{ + "shape":"MaintenanceWindowCutoff", + "documentation":"

    The number of hours before the end of the maintenance window that Systems Manager stops scheduling new tasks for execution.

    " + }, + "AllowUnassociatedTargets":{ + "shape":"MaintenanceWindowAllowUnassociatedTargets", + "documentation":"

    Whether targets must be registered with the maintenance window before tasks can be defined for those targets.

    " + }, + "Enabled":{ + "shape":"MaintenanceWindowEnabled", + "documentation":"

    Whether the maintenance window is enabled.

    " + } + } + }, + "UpdateMaintenanceWindowTargetRequest":{ + "type":"structure", + "required":[ + "WindowId", + "WindowTargetId" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The maintenance window ID with which to modify the target.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The target ID to modify.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets to add or replace.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    User-provided value that will be included in any CloudWatch events raised while running tasks for these targets in this maintenance window.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    A name for the update.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    An optional description for the update.

    " + }, + "Replace":{ + "shape":"Boolean", + "documentation":"

    If True, then all fields that are required by the RegisterTargetWithMaintenanceWindow action are also required for this API request. Optional fields that are not specified are set to null.

    ", + "box":true + } + } + }, + "UpdateMaintenanceWindowTargetResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The maintenance window ID specified in the update request.

    " + }, + "WindowTargetId":{ + "shape":"MaintenanceWindowTargetId", + "documentation":"

    The target ID specified in the update request.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The updated targets.

    " + }, + "OwnerInformation":{ + "shape":"OwnerInformation", + "documentation":"

    The updated owner.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The updated name.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    The updated description.

    " + } + } + }, + "UpdateMaintenanceWindowTaskRequest":{ + "type":"structure", + "required":[ + "WindowId", + "WindowTaskId" + ], + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The maintenance window ID that contains the task to modify.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The task ID to modify.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The targets (either instances or tags) to modify. Instances are specified using Key=instanceids,Values=instanceID_1,instanceID_2. Tags are specified using Key=tag_name,Values=tag_value.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The task ARN to modify.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role for Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses your account's service-linked role. If no service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

    For more information, see the following topics in the in the AWS Systems Manager User Guide:

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParameters", + "documentation":"

    The parameters to modify.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    The map has the following format:

    Key: string, between 1 and 255 characters

    Value: an array of strings, each string is between 1 and 255 characters

    " + }, + "TaskInvocationParameters":{ + "shape":"MaintenanceWindowTaskInvocationParameters", + "documentation":"

    The parameters that the task should use during execution. Populate only the fields that match the task type. All other fields should be empty.

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The new task priority to specify. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.

    ", + "box":true + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The new MaxConcurrency value you want to specify. MaxConcurrency is the number of targets that are allowed to run this task in parallel.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The new MaxErrors value to specify. MaxErrors is the maximum number of errors that are allowed before the task stops being scheduled.

    " + }, + "LoggingInfo":{ + "shape":"LoggingInfo", + "documentation":"

    The new logging location in Amazon S3 to specify.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The new task name to specify.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    The new task description to specify.

    " + }, + "Replace":{ + "shape":"Boolean", + "documentation":"

    If True, then all fields that are required by the RegisterTaskWithMaintenanceWndow action are also required for this API request. Optional fields that are not specified are set to null.

    ", + "box":true + } + } + }, + "UpdateMaintenanceWindowTaskResult":{ + "type":"structure", + "members":{ + "WindowId":{ + "shape":"MaintenanceWindowId", + "documentation":"

    The ID of the maintenance window that was updated.

    " + }, + "WindowTaskId":{ + "shape":"MaintenanceWindowTaskId", + "documentation":"

    The task ID of the maintenance window that was updated.

    " + }, + "Targets":{ + "shape":"Targets", + "documentation":"

    The updated target values.

    " + }, + "TaskArn":{ + "shape":"MaintenanceWindowTaskArn", + "documentation":"

    The updated task ARN value.

    " + }, + "ServiceRoleArn":{ + "shape":"ServiceRole", + "documentation":"

    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

    " + }, + "TaskParameters":{ + "shape":"MaintenanceWindowTaskParameters", + "documentation":"

    The updated parameter values.

    TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "TaskInvocationParameters":{ + "shape":"MaintenanceWindowTaskInvocationParameters", + "documentation":"

    The updated parameter values.

    " + }, + "Priority":{ + "shape":"MaintenanceWindowTaskPriority", + "documentation":"

    The updated priority value.

    " + }, + "MaxConcurrency":{ + "shape":"MaxConcurrency", + "documentation":"

    The updated MaxConcurrency value.

    " + }, + "MaxErrors":{ + "shape":"MaxErrors", + "documentation":"

    The updated MaxErrors value.

    " + }, + "LoggingInfo":{ + "shape":"LoggingInfo", + "documentation":"

    The updated logging information in Amazon S3.

    LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

    " + }, + "Name":{ + "shape":"MaintenanceWindowName", + "documentation":"

    The updated task name.

    " + }, + "Description":{ + "shape":"MaintenanceWindowDescription", + "documentation":"

    The updated task description.

    " + } + } + }, + "UpdateManagedInstanceRoleRequest":{ + "type":"structure", + "required":[ + "InstanceId", + "IamRole" + ], + "members":{ + "InstanceId":{ + "shape":"ManagedInstanceId", + "documentation":"

    The ID of the managed instance where you want to update the role.

    " + }, + "IamRole":{ + "shape":"IamRole", + "documentation":"

    The IAM role you want to assign or change.

    " + } + } + }, + "UpdateManagedInstanceRoleResult":{ + "type":"structure", + "members":{ + } + }, + "UpdateOpsItemRequest":{ + "type":"structure", + "required":["OpsItemId"], + "members":{ + "Description":{ + "shape":"OpsItemDescription", + "documentation":"

    Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

    " + }, + "OperationalData":{ + "shape":"OpsItemOperationalData", + "documentation":"

    Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

    Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

    Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

    You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

    Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

    " + }, + "OperationalDataToDelete":{ + "shape":"OpsItemOpsDataKeysList", + "documentation":"

    Keys that you want to remove from the OperationalData map.

    " + }, + "Notifications":{ + "shape":"OpsItemNotifications", + "documentation":"

    The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

    " + }, + "Priority":{ + "shape":"OpsItemPriority", + "documentation":"

    The importance of this OpsItem in relation to other OpsItems in the system.

    " + }, + "RelatedOpsItems":{ + "shape":"RelatedOpsItems", + "documentation":"

    One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

    " + }, + "Status":{ + "shape":"OpsItemStatus", + "documentation":"

    The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

    " + }, + "OpsItemId":{ + "shape":"OpsItemId", + "documentation":"

    The ID of the OpsItem.

    " + }, + "Title":{ + "shape":"OpsItemTitle", + "documentation":"

    A short heading that describes the nature of the OpsItem and the impacted resource.

    " + } + } + }, + "UpdateOpsItemResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePatchBaselineRequest":{ + "type":"structure", + "required":["BaselineId"], + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the patch baseline to update.

    " + }, + "Name":{ + "shape":"BaselineName", + "documentation":"

    The name of the patch baseline.

    " + }, + "GlobalFilters":{ + "shape":"PatchFilterGroup", + "documentation":"

    A set of global filters used to include patches in the baseline.

    " + }, + "ApprovalRules":{ + "shape":"PatchRuleGroup", + "documentation":"

    A set of rules used to include patches in the baseline.

    " + }, + "ApprovedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly approved patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    " + }, + "ApprovedPatchesComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    Assigns a new compliance severity level to an existing patch baseline.

    " + }, + "ApprovedPatchesEnableNonSecurity":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

    ", + "box":true + }, + "RejectedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly rejected patches for the baseline.

    For information about accepted formats for lists of approved patches and rejected patches, see Package Name Formats for Approved and Rejected Patch Lists in the AWS Systems Manager User Guide.

    " + }, + "RejectedPatchesAction":{ + "shape":"PatchAction", + "documentation":"

    The action for Patch Manager to take on patches included in the RejectedPackages list.

    • ALLOW_AS_DEPENDENCY: A package in the Rejected patches list is installed only if it is a dependency of another package. It is considered compliant with the patch baseline, and its status is reported as InstalledOther. This is the default action if no option is specified.

    • BLOCK: Packages in the RejectedPatches list, and packages that include them as dependencies, are not installed under any circumstances. If a package was installed before it was added to the Rejected patches list, it is considered non-compliant with the patch baseline, and its status is reported as InstalledRejected.

    " + }, + "Description":{ + "shape":"BaselineDescription", + "documentation":"

    A description of the patch baseline.

    " + }, + "Sources":{ + "shape":"PatchSourceList", + "documentation":"

    Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

    " + }, + "Replace":{ + "shape":"Boolean", + "documentation":"

    If True, then all fields that are required by the CreatePatchBaseline action are also required for this API request. Optional fields that are not specified are set to null.

    ", + "box":true + } + } + }, + "UpdatePatchBaselineResult":{ + "type":"structure", + "members":{ + "BaselineId":{ + "shape":"BaselineId", + "documentation":"

    The ID of the deleted patch baseline.

    " + }, + "Name":{ + "shape":"BaselineName", + "documentation":"

    The name of the patch baseline.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    The operating system rule used by the updated patch baseline.

    " + }, + "GlobalFilters":{ + "shape":"PatchFilterGroup", + "documentation":"

    A set of global filters used to exclude patches from the baseline.

    " + }, + "ApprovalRules":{ + "shape":"PatchRuleGroup", + "documentation":"

    A set of rules used to include patches in the baseline.

    " + }, + "ApprovedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly approved patches for the baseline.

    " + }, + "ApprovedPatchesComplianceLevel":{ + "shape":"PatchComplianceLevel", + "documentation":"

    The compliance severity level assigned to the patch baseline after the update completed.

    " + }, + "ApprovedPatchesEnableNonSecurity":{ + "shape":"Boolean", + "documentation":"

    Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.

    ", + "box":true + }, + "RejectedPatches":{ + "shape":"PatchIdList", + "documentation":"

    A list of explicitly rejected patches for the baseline.

    " + }, + "RejectedPatchesAction":{ + "shape":"PatchAction", + "documentation":"

    The action specified to take on patches included in the RejectedPatches list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.

    " + }, + "CreatedDate":{ + "shape":"DateTime", + "documentation":"

    The date when the patch baseline was created.

    " + }, + "ModifiedDate":{ + "shape":"DateTime", + "documentation":"

    The date when the patch baseline was last modified.

    " + }, + "Description":{ + "shape":"BaselineDescription", + "documentation":"

    A description of the Patch Baseline.

    " + }, + "Sources":{ + "shape":"PatchSourceList", + "documentation":"

    Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.

    " + } + } + }, + "UpdateServiceSettingRequest":{ + "type":"structure", + "required":[ + "SettingId", + "SettingValue" + ], + "members":{ + "SettingId":{ + "shape":"ServiceSettingId", + "documentation":"

    The ID of the service setting to update.

    " + }, + "SettingValue":{ + "shape":"ServiceSettingValue", + "documentation":"

    The new value to specify for the service setting.

    " + } + }, + "documentation":"

    The request body of the UpdateServiceSetting API action.

    " + }, + "UpdateServiceSettingResult":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The result body of the UpdateServiceSetting API action.

    " + }, + "Url":{"type":"string"}, + "ValidNextStep":{ + "type":"string", + "max":65535, + "min":1 + }, + "ValidNextStepList":{ + "type":"list", + "member":{"shape":"ValidNextStep"} + }, + "Version":{ + "type":"string", + "pattern":"^[0-9]{1,6}(\\.[0-9]{1,6}){2,3}$" + } + }, + "documentation":"AWS Systems Manager

    AWS Systems Manager is a collection of capabilities that helps you automate management tasks such as collecting system inventory, applying operating system (OS) patches, automating the creation of Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale. Systems Manager lets you remotely and securely manage the configuration of your managed instances. A managed instance is any Amazon EC2 instance or on-premises machine in your hybrid environment that has been configured for Systems Manager.

    This reference is intended to be used with the AWS Systems Manager User Guide.

    To get started, verify prerequisites and configure managed instances. For more information, see Setting Up AWS Systems Manager in the AWS Systems Manager User Guide.

    For information about other API actions you can perform on Amazon EC2 instances, see the Amazon EC2 API Reference. For information about how to use a Query API, see Making API Requests.

    " +} diff --git a/aws/dist/botocore/data/sso-oidc/2019-06-10/paginators-1.json b/aws/dist/botocore/data/sso-oidc/2019-06-10/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/sso-oidc/2019-06-10/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/sso-oidc/2019-06-10/service-2.json b/aws/dist/botocore/data/sso-oidc/2019-06-10/service-2.json new file mode 100644 index 00000000..79b2efe1 --- /dev/null +++ b/aws/dist/botocore/data/sso-oidc/2019-06-10/service-2.json @@ -0,0 +1,392 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-06-10", + "endpointPrefix":"oidc", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"SSO OIDC", + "serviceFullName":"AWS SSO OIDC", + "serviceId":"SSO OIDC", + "signatureVersion":"v4", + "signingName":"awsssooidc", + "uid":"sso-oidc-2019-06-10" + }, + "operations":{ + "CreateToken":{ + "name":"CreateToken", + "http":{ + "method":"POST", + "requestUri":"/token" + }, + "input":{"shape":"CreateTokenRequest"}, + "output":{"shape":"CreateTokenResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidClientException"}, + {"shape":"InvalidGrantException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"UnsupportedGrantTypeException"}, + {"shape":"InvalidScopeException"}, + {"shape":"AuthorizationPendingException"}, + {"shape":"SlowDownException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ExpiredTokenException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

    ", + "authtype":"none" + }, + "RegisterClient":{ + "name":"RegisterClient", + "http":{ + "method":"POST", + "requestUri":"/client/register" + }, + "input":{"shape":"RegisterClientRequest"}, + "output":{"shape":"RegisterClientResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidScopeException"}, + {"shape":"InvalidClientMetadataException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

    ", + "authtype":"none" + }, + "StartDeviceAuthorization":{ + "name":"StartDeviceAuthorization", + "http":{ + "method":"POST", + "requestUri":"/device_authorization" + }, + "input":{"shape":"StartDeviceAuthorizationRequest"}, + "output":{"shape":"StartDeviceAuthorizationResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"InvalidClientException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"SlowDownException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Initiates device authorization by requesting a pair of verification codes from the authorization service.

    ", + "authtype":"none" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    You do not have sufficient access to perform this action.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AccessToken":{"type":"string"}, + "AuthCode":{"type":"string"}, + "AuthorizationPendingException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that a request to authorize a client with an access user session token is pending.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ClientId":{"type":"string"}, + "ClientName":{"type":"string"}, + "ClientSecret":{"type":"string"}, + "ClientType":{"type":"string"}, + "CreateTokenRequest":{ + "type":"structure", + "required":[ + "clientId", + "clientSecret", + "grantType", + "deviceCode" + ], + "members":{ + "clientId":{ + "shape":"ClientId", + "documentation":"

    The unique identifier string for each client. This value should come from the persisted result of the RegisterClient API.

    " + }, + "clientSecret":{ + "shape":"ClientSecret", + "documentation":"

    A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.

    " + }, + "grantType":{ + "shape":"GrantType", + "documentation":"

    Supports grant types for authorization code, refresh token, and device code request.

    " + }, + "deviceCode":{ + "shape":"DeviceCode", + "documentation":"

    Used only when calling this API for the device code grant type. This short-term code is used to identify this authentication attempt. This should come from an in-memory reference to the result of the StartDeviceAuthorization API.

    " + }, + "code":{ + "shape":"AuthCode", + "documentation":"

    The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.

    " + }, + "refreshToken":{ + "shape":"RefreshToken", + "documentation":"

    The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.

    " + }, + "scope":{ + "shape":"Scopes", + "documentation":"

    The list of scopes that is defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

    " + }, + "redirectUri":{ + "shape":"URI", + "documentation":"

    The location of the application that will receive the authorization code. Users authorize the service to send the request to this location.

    " + } + } + }, + "CreateTokenResponse":{ + "type":"structure", + "members":{ + "accessToken":{ + "shape":"AccessToken", + "documentation":"

    An opaque token to access AWS SSO resources assigned to a user.

    " + }, + "tokenType":{ + "shape":"TokenType", + "documentation":"

    Used to notify the client that the returned token is an access token. The supported type is BearerToken.

    " + }, + "expiresIn":{ + "shape":"ExpirationInSeconds", + "documentation":"

    Indicates the time in seconds when an access token will expire.

    " + }, + "refreshToken":{ + "shape":"RefreshToken", + "documentation":"

    A token that, if present, can be used to refresh a previously issued access token that might have expired.

    " + }, + "idToken":{ + "shape":"IdToken", + "documentation":"

    The identifier of the user that associated with the access token, if present.

    " + } + } + }, + "DeviceCode":{"type":"string"}, + "Error":{"type":"string"}, + "ErrorDescription":{"type":"string"}, + "ExpirationInSeconds":{"type":"integer"}, + "ExpiredTokenException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the token issued by the service is expired and is no longer valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "GrantType":{"type":"string"}, + "IdToken":{"type":"string"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that an error from the service occurred while trying to process a request.

    ", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "IntervalInSeconds":{"type":"integer"}, + "InvalidClientException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the clientId or clientSecret in the request is invalid. For example, this can occur when a client sends an incorrect clientId or an expired clientSecret.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "InvalidClientMetadataException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the client information sent in the request during registration is invalid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidGrantException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that a request contains an invalid grant. This can occur if a client makes a CreateToken request with an invalid grant type.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that something is wrong with the input to the request. For example, a required parameter might be missing or out of range.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidScopeException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the scope provided in the request is invalid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "LongTimeStampType":{"type":"long"}, + "RefreshToken":{"type":"string"}, + "RegisterClientRequest":{ + "type":"structure", + "required":[ + "clientName", + "clientType" + ], + "members":{ + "clientName":{ + "shape":"ClientName", + "documentation":"

    The friendly name of the client.

    " + }, + "clientType":{ + "shape":"ClientType", + "documentation":"

    The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

    " + }, + "scopes":{ + "shape":"Scopes", + "documentation":"

    The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

    " + } + } + }, + "RegisterClientResponse":{ + "type":"structure", + "members":{ + "clientId":{ + "shape":"ClientId", + "documentation":"

    The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.

    " + }, + "clientSecret":{ + "shape":"ClientSecret", + "documentation":"

    A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.

    " + }, + "clientIdIssuedAt":{ + "shape":"LongTimeStampType", + "documentation":"

    Indicates the time at which the clientId and clientSecret were issued.

    " + }, + "clientSecretExpiresAt":{ + "shape":"LongTimeStampType", + "documentation":"

    Indicates the time at which the clientId and clientSecret will become invalid.

    " + }, + "authorizationEndpoint":{ + "shape":"URI", + "documentation":"

    The endpoint where the client can request authorization.

    " + }, + "tokenEndpoint":{ + "shape":"URI", + "documentation":"

    The endpoint where the client can get an access token.

    " + } + } + }, + "Scope":{"type":"string"}, + "Scopes":{ + "type":"list", + "member":{"shape":"Scope"} + }, + "SlowDownException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the client is making the request too frequently and is more than the service can handle.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "StartDeviceAuthorizationRequest":{ + "type":"structure", + "required":[ + "clientId", + "clientSecret", + "startUrl" + ], + "members":{ + "clientId":{ + "shape":"ClientId", + "documentation":"

    The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the RegisterClient API operation.

    " + }, + "clientSecret":{ + "shape":"ClientSecret", + "documentation":"

    A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.

    " + }, + "startUrl":{ + "shape":"URI", + "documentation":"

    The URL for the AWS SSO user portal. For more information, see Using the User Portal in the AWS Single Sign-On User Guide.

    " + } + } + }, + "StartDeviceAuthorizationResponse":{ + "type":"structure", + "members":{ + "deviceCode":{ + "shape":"DeviceCode", + "documentation":"

    The short-lived code that is used by the device when polling for a session token.

    " + }, + "userCode":{ + "shape":"UserCode", + "documentation":"

    A one-time user verification code. This is needed to authorize an in-use device.

    " + }, + "verificationUri":{ + "shape":"URI", + "documentation":"

    The URI of the verification page that takes the userCode to authorize the device.

    " + }, + "verificationUriComplete":{ + "shape":"URI", + "documentation":"

    An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.

    " + }, + "expiresIn":{ + "shape":"ExpirationInSeconds", + "documentation":"

    Indicates the number of seconds in which the verification code will become invalid.

    " + }, + "interval":{ + "shape":"IntervalInSeconds", + "documentation":"

    Indicates the number of seconds the client must wait between attempts when polling for a session.

    " + } + } + }, + "TokenType":{"type":"string"}, + "URI":{"type":"string"}, + "UnauthorizedClientException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the client is not currently authorized to make the request. This can happen when a clientId is not issued for a public client.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UnsupportedGrantTypeException":{ + "type":"structure", + "members":{ + "error":{"shape":"Error"}, + "error_description":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the grant type in the request is not supported by the service.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "UserCode":{"type":"string"} + }, + "documentation":"

    AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

    For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

    This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

    AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

    " +} diff --git a/aws/dist/botocore/data/sso/2019-06-10/paginators-1.json b/aws/dist/botocore/data/sso/2019-06-10/paginators-1.json new file mode 100644 index 00000000..daaed6fe --- /dev/null +++ b/aws/dist/botocore/data/sso/2019-06-10/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "ListAccountRoles": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "roleList" + }, + "ListAccounts": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "accountList" + } + } +} diff --git a/aws/dist/botocore/data/sso/2019-06-10/service-2.json b/aws/dist/botocore/data/sso/2019-06-10/service-2.json new file mode 100644 index 00000000..84e4fa40 --- /dev/null +++ b/aws/dist/botocore/data/sso/2019-06-10/service-2.json @@ -0,0 +1,346 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-06-10", + "endpointPrefix":"portal.sso", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"SSO", + "serviceFullName":"AWS Single Sign-On", + "serviceId":"SSO", + "signatureVersion":"v4", + "signingName":"awsssoportal", + "uid":"sso-2019-06-10" + }, + "operations":{ + "GetRoleCredentials":{ + "name":"GetRoleCredentials", + "http":{ + "method":"GET", + "requestUri":"/federation/credentials" + }, + "input":{"shape":"GetRoleCredentialsRequest"}, + "output":{"shape":"GetRoleCredentialsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Returns the STS short-term credentials for a given role name that is assigned to the user.

    ", + "authtype":"none" + }, + "ListAccountRoles":{ + "name":"ListAccountRoles", + "http":{ + "method":"GET", + "requestUri":"/assignment/roles" + }, + "input":{"shape":"ListAccountRolesRequest"}, + "output":{"shape":"ListAccountRolesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists all roles that are assigned to the user for a given AWS account.

    ", + "authtype":"none" + }, + "ListAccounts":{ + "name":"ListAccounts", + "http":{ + "method":"GET", + "requestUri":"/assignment/accounts" + }, + "input":{"shape":"ListAccountsRequest"}, + "output":{"shape":"ListAccountsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access in the AWS SSO User Guide. This operation returns a paginated response.

    ", + "authtype":"none" + }, + "Logout":{ + "name":"Logout", + "http":{ + "method":"POST", + "requestUri":"/logout" + }, + "input":{"shape":"LogoutRequest"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"UnauthorizedException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Removes the client- and server-side session that is associated with the user.

    ", + "authtype":"none" + } + }, + "shapes":{ + "AccessKeyType":{"type":"string"}, + "AccessTokenType":{ + "type":"string", + "sensitive":true + }, + "AccountIdType":{"type":"string"}, + "AccountInfo":{ + "type":"structure", + "members":{ + "accountId":{ + "shape":"AccountIdType", + "documentation":"

    The identifier of the AWS account that is assigned to the user.

    " + }, + "accountName":{ + "shape":"AccountNameType", + "documentation":"

    The display name of the AWS account that is assigned to the user.

    " + }, + "emailAddress":{ + "shape":"EmailAddressType", + "documentation":"

    The email address of the AWS account that is assigned to the user.

    " + } + }, + "documentation":"

    Provides information about your AWS account.

    " + }, + "AccountListType":{ + "type":"list", + "member":{"shape":"AccountInfo"} + }, + "AccountNameType":{"type":"string"}, + "EmailAddressType":{ + "type":"string", + "max":254, + "min":1 + }, + "ErrorDescription":{"type":"string"}, + "ExpirationTimestampType":{"type":"long"}, + "GetRoleCredentialsRequest":{ + "type":"structure", + "required":[ + "roleName", + "accountId", + "accessToken" + ], + "members":{ + "roleName":{ + "shape":"RoleNameType", + "documentation":"

    The friendly name of the role that is assigned to the user.

    ", + "location":"querystring", + "locationName":"role_name" + }, + "accountId":{ + "shape":"AccountIdType", + "documentation":"

    The identifier for the AWS account that is assigned to the user.

    ", + "location":"querystring", + "locationName":"account_id" + }, + "accessToken":{ + "shape":"AccessTokenType", + "documentation":"

    The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

    ", + "location":"header", + "locationName":"x-amz-sso_bearer_token" + } + } + }, + "GetRoleCredentialsResponse":{ + "type":"structure", + "members":{ + "roleCredentials":{ + "shape":"RoleCredentials", + "documentation":"

    The credentials for the role that is assigned to the user.

    " + } + } + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListAccountRolesRequest":{ + "type":"structure", + "required":[ + "accessToken", + "accountId" + ], + "members":{ + "nextToken":{ + "shape":"NextTokenType", + "documentation":"

    The page token from the previous response output when you request subsequent pages.

    ", + "location":"querystring", + "locationName":"next_token" + }, + "maxResults":{ + "shape":"MaxResultType", + "documentation":"

    The number of items that clients can request per page.

    ", + "location":"querystring", + "locationName":"max_result" + }, + "accessToken":{ + "shape":"AccessTokenType", + "documentation":"

    The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

    ", + "location":"header", + "locationName":"x-amz-sso_bearer_token" + }, + "accountId":{ + "shape":"AccountIdType", + "documentation":"

    The identifier for the AWS account that is assigned to the user.

    ", + "location":"querystring", + "locationName":"account_id" + } + } + }, + "ListAccountRolesResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextTokenType", + "documentation":"

    The page token client that is used to retrieve the list of accounts.

    " + }, + "roleList":{ + "shape":"RoleListType", + "documentation":"

    A paginated response with the list of roles and the next token if more results are available.

    " + } + } + }, + "ListAccountsRequest":{ + "type":"structure", + "required":["accessToken"], + "members":{ + "nextToken":{ + "shape":"NextTokenType", + "documentation":"

    (Optional) When requesting subsequent pages, this is the page token from the previous response output.

    ", + "location":"querystring", + "locationName":"next_token" + }, + "maxResults":{ + "shape":"MaxResultType", + "documentation":"

    This is the number of items clients can request per page.

    ", + "location":"querystring", + "locationName":"max_result" + }, + "accessToken":{ + "shape":"AccessTokenType", + "documentation":"

    The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

    ", + "location":"header", + "locationName":"x-amz-sso_bearer_token" + } + } + }, + "ListAccountsResponse":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"NextTokenType", + "documentation":"

    The page token client that is used to retrieve the list of accounts.

    " + }, + "accountList":{ + "shape":"AccountListType", + "documentation":"

    A paginated response with the list of account information and the next token if more results are available.

    " + } + } + }, + "LogoutRequest":{ + "type":"structure", + "required":["accessToken"], + "members":{ + "accessToken":{ + "shape":"AccessTokenType", + "documentation":"

    The token issued by the CreateToken API call. For more information, see CreateToken in the AWS SSO OIDC API Reference Guide.

    ", + "location":"header", + "locationName":"x-amz-sso_bearer_token" + } + } + }, + "MaxResultType":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "NextTokenType":{"type":"string"}, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorDescription"} + }, + "documentation":"

    The specified resource doesn't exist.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RoleCredentials":{ + "type":"structure", + "members":{ + "accessKeyId":{ + "shape":"AccessKeyType", + "documentation":"

    The identifier used for the temporary security credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

    " + }, + "secretAccessKey":{ + "shape":"SecretAccessKeyType", + "documentation":"

    The key that is used to sign the request. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

    " + }, + "sessionToken":{ + "shape":"SessionTokenType", + "documentation":"

    The token used for temporary credentials. For more information, see Using Temporary Security Credentials to Request Access to AWS Resources in the AWS IAM User Guide.

    " + }, + "expiration":{ + "shape":"ExpirationTimestampType", + "documentation":"

    The date on which temporary security credentials expire.

    " + } + }, + "documentation":"

    Provides information about the role credentials that are assigned to the user.

    " + }, + "RoleInfo":{ + "type":"structure", + "members":{ + "roleName":{ + "shape":"RoleNameType", + "documentation":"

    The friendly name of the role that is assigned to the user.

    " + }, + "accountId":{ + "shape":"AccountIdType", + "documentation":"

    The identifier of the AWS account assigned to the user.

    " + } + }, + "documentation":"

    Provides information about the role that is assigned to the user.

    " + }, + "RoleListType":{ + "type":"list", + "member":{"shape":"RoleInfo"} + }, + "RoleNameType":{"type":"string"}, + "SecretAccessKeyType":{ + "type":"string", + "sensitive":true + }, + "SessionTokenType":{ + "type":"string", + "sensitive":true + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the request is being made too frequently and is more than what the server can handle.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorDescription"} + }, + "documentation":"

    Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

    ", + "error":{"httpStatusCode":401}, + "exception":true + } + }, + "documentation":"

    AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

    For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

    This API reference guide describes the AWS SSO Portal operations that you can call programatically and includes detailed information on data types and errors.

    AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

    " +} diff --git a/aws/dist/botocore/data/stepfunctions/2016-11-23/examples-1.json b/aws/dist/botocore/data/stepfunctions/2016-11-23/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/stepfunctions/2016-11-23/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/stepfunctions/2016-11-23/paginators-1.json b/aws/dist/botocore/data/stepfunctions/2016-11-23/paginators-1.json new file mode 100644 index 00000000..9feccba6 --- /dev/null +++ b/aws/dist/botocore/data/stepfunctions/2016-11-23/paginators-1.json @@ -0,0 +1,28 @@ +{ + "pagination": { + "GetExecutionHistory": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "events" + }, + "ListActivities": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "activities" + }, + "ListExecutions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "executions" + }, + "ListStateMachines": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "stateMachines" + } + } +} diff --git a/aws/dist/botocore/data/stepfunctions/2016-11-23/service-2.json b/aws/dist/botocore/data/stepfunctions/2016-11-23/service-2.json new file mode 100644 index 00000000..a715453d --- /dev/null +++ b/aws/dist/botocore/data/stepfunctions/2016-11-23/service-2.json @@ -0,0 +1,2045 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-23", + "endpointPrefix":"states", + "jsonVersion":"1.0", + "protocol":"json", + "serviceAbbreviation":"AWS SFN", + "serviceFullName":"AWS Step Functions", + "serviceId":"SFN", + "signatureVersion":"v4", + "targetPrefix":"AWSStepFunctions", + "uid":"states-2016-11-23" + }, + "operations":{ + "CreateActivity":{ + "name":"CreateActivity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateActivityInput"}, + "output":{"shape":"CreateActivityOutput"}, + "errors":[ + {"shape":"ActivityLimitExceeded"}, + {"shape":"InvalidName"}, + {"shape":"TooManyTags"} + ], + "documentation":"

    Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.

    ", + "idempotent":true + }, + "CreateStateMachine":{ + "name":"CreateStateMachine", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStateMachineInput"}, + "output":{"shape":"CreateStateMachineOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"InvalidDefinition"}, + {"shape":"InvalidName"}, + {"shape":"StateMachineAlreadyExists"}, + {"shape":"StateMachineDeleting"}, + {"shape":"StateMachineLimitExceeded"}, + {"shape":"TooManyTags"} + ], + "documentation":"

    Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.

    ", + "idempotent":true + }, + "DeleteActivity":{ + "name":"DeleteActivity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteActivityInput"}, + "output":{"shape":"DeleteActivityOutput"}, + "errors":[ + {"shape":"InvalidArn"} + ], + "documentation":"

    Deletes an activity.

    " + }, + "DeleteStateMachine":{ + "name":"DeleteStateMachine", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteStateMachineInput"}, + "output":{"shape":"DeleteStateMachineOutput"}, + "errors":[ + {"shape":"InvalidArn"} + ], + "documentation":"

    Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.

    The state machine itself is deleted after all executions are completed or deleted.

    " + }, + "DescribeActivity":{ + "name":"DescribeActivity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivityInput"}, + "output":{"shape":"DescribeActivityOutput"}, + "errors":[ + {"shape":"ActivityDoesNotExist"}, + {"shape":"InvalidArn"} + ], + "documentation":"

    Describes an activity.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "DescribeExecution":{ + "name":"DescribeExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExecutionInput"}, + "output":{"shape":"DescribeExecutionOutput"}, + "errors":[ + {"shape":"ExecutionDoesNotExist"}, + {"shape":"InvalidArn"} + ], + "documentation":"

    Describes an execution.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "DescribeStateMachine":{ + "name":"DescribeStateMachine", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStateMachineInput"}, + "output":{"shape":"DescribeStateMachineOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"StateMachineDoesNotExist"} + ], + "documentation":"

    Describes a state machine.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "DescribeStateMachineForExecution":{ + "name":"DescribeStateMachineForExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStateMachineForExecutionInput"}, + "output":{"shape":"DescribeStateMachineForExecutionOutput"}, + "errors":[ + {"shape":"ExecutionDoesNotExist"}, + {"shape":"InvalidArn"} + ], + "documentation":"

    Describes the state machine associated with a specific execution.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "GetActivityTask":{ + "name":"GetActivityTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetActivityTaskInput"}, + "output":{"shape":"GetActivityTaskOutput"}, + "errors":[ + {"shape":"ActivityDoesNotExist"}, + {"shape":"ActivityWorkerLimitExceeded"}, + {"shape":"InvalidArn"} + ], + "documentation":"

    Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string.

    Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request).

    Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.

    " + }, + "GetExecutionHistory":{ + "name":"GetExecutionHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetExecutionHistoryInput"}, + "output":{"shape":"GetExecutionHistoryOutput"}, + "errors":[ + {"shape":"ExecutionDoesNotExist"}, + {"shape":"InvalidArn"}, + {"shape":"InvalidToken"} + ], + "documentation":"

    Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first.

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + }, + "ListActivities":{ + "name":"ListActivities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivitiesInput"}, + "output":{"shape":"ListActivitiesOutput"}, + "errors":[ + {"shape":"InvalidToken"} + ], + "documentation":"

    Lists the existing activities.

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "ListExecutions":{ + "name":"ListExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExecutionsInput"}, + "output":{"shape":"ListExecutionsOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"InvalidToken"}, + {"shape":"StateMachineDoesNotExist"} + ], + "documentation":"

    Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first.

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "ListStateMachines":{ + "name":"ListStateMachines", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListStateMachinesInput"}, + "output":{"shape":"ListStateMachinesOutput"}, + "errors":[ + {"shape":"InvalidToken"} + ], + "documentation":"

    Lists the existing state machines.

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"ResourceNotFound"} + ], + "documentation":"

    List tags for a given resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + }, + "SendTaskFailure":{ + "name":"SendTaskFailure", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTaskFailureInput"}, + "output":{"shape":"SendTaskFailureOutput"}, + "errors":[ + {"shape":"TaskDoesNotExist"}, + {"shape":"InvalidToken"}, + {"shape":"TaskTimedOut"} + ], + "documentation":"

    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.

    " + }, + "SendTaskHeartbeat":{ + "name":"SendTaskHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTaskHeartbeatInput"}, + "output":{"shape":"SendTaskHeartbeatOutput"}, + "errors":[ + {"shape":"TaskDoesNotExist"}, + {"shape":"InvalidToken"}, + {"shape":"TaskTimedOut"} + ], + "documentation":"

    Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern.

    The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.

    " + }, + "SendTaskSuccess":{ + "name":"SendTaskSuccess", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SendTaskSuccessInput"}, + "output":{"shape":"SendTaskSuccessOutput"}, + "errors":[ + {"shape":"TaskDoesNotExist"}, + {"shape":"InvalidOutput"}, + {"shape":"InvalidToken"}, + {"shape":"TaskTimedOut"} + ], + "documentation":"

    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.

    " + }, + "StartExecution":{ + "name":"StartExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartExecutionInput"}, + "output":{"shape":"StartExecutionOutput"}, + "errors":[ + {"shape":"ExecutionLimitExceeded"}, + {"shape":"ExecutionAlreadyExists"}, + {"shape":"InvalidArn"}, + {"shape":"InvalidExecutionInput"}, + {"shape":"InvalidName"}, + {"shape":"StateMachineDoesNotExist"}, + {"shape":"StateMachineDeleting"} + ], + "documentation":"

    Starts a state machine execution.

    StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

    ", + "idempotent":true + }, + "StopExecution":{ + "name":"StopExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopExecutionInput"}, + "output":{"shape":"StopExecutionOutput"}, + "errors":[ + {"shape":"ExecutionDoesNotExist"}, + {"shape":"InvalidArn"} + ], + "documentation":"

    Stops an execution.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "output":{"shape":"TagResourceOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"ResourceNotFound"}, + {"shape":"TooManyTags"} + ], + "documentation":"

    Add a tag to a Step Functions resource.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "output":{"shape":"UntagResourceOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"ResourceNotFound"} + ], + "documentation":"

    Remove a tag from a Step Functions resource

    " + }, + "UpdateStateMachine":{ + "name":"UpdateStateMachine", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateStateMachineInput"}, + "output":{"shape":"UpdateStateMachineOutput"}, + "errors":[ + {"shape":"InvalidArn"}, + {"shape":"InvalidDefinition"}, + {"shape":"MissingRequiredParameter"}, + {"shape":"StateMachineDeleting"}, + {"shape":"StateMachineDoesNotExist"} + ], + "documentation":"

    Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

    All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.

    ", + "idempotent":true + } + }, + "shapes":{ + "ActivityDoesNotExist":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified activity does not exist.

    ", + "exception":true + }, + "ActivityFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about an activity that failed during an execution.

    " + }, + "ActivityLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum number of activities has been reached. Existing activities must be deleted before a new activity can be created.

    ", + "exception":true + }, + "ActivityList":{ + "type":"list", + "member":{"shape":"ActivityListItem"} + }, + "ActivityListItem":{ + "type":"structure", + "required":[ + "activityArn", + "name", + "creationDate" + ], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the activity.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the activity.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the activity is created.

    " + } + }, + "documentation":"

    Contains details about an activity.

    " + }, + "ActivityScheduleFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about an activity schedule failure that occurred during an execution.

    " + }, + "ActivityScheduledEventDetails":{ + "type":"structure", + "required":["resource"], + "members":{ + "resource":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the scheduled activity.

    " + }, + "input":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data input to the activity task.

    " + }, + "timeoutInSeconds":{ + "shape":"TimeoutInSeconds", + "documentation":"

    The maximum allowed duration of the activity task.

    ", + "box":true + }, + "heartbeatInSeconds":{ + "shape":"TimeoutInSeconds", + "documentation":"

    The maximum allowed duration between two heartbeats for the activity task.

    ", + "box":true + } + }, + "documentation":"

    Contains details about an activity scheduled during an execution.

    " + }, + "ActivityStartedEventDetails":{ + "type":"structure", + "members":{ + "workerName":{ + "shape":"Identity", + "documentation":"

    The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.

    " + } + }, + "documentation":"

    Contains details about the start of an activity during an execution.

    " + }, + "ActivitySucceededEventDetails":{ + "type":"structure", + "members":{ + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data output by the activity task.

    " + } + }, + "documentation":"

    Contains details about an activity that successfully terminated during an execution.

    " + }, + "ActivityTimedOutEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the timeout.

    " + } + }, + "documentation":"

    Contains details about an activity timeout that occurred during an execution.

    " + }, + "ActivityWorkerLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum number of workers concurrently polling for activity tasks has been reached.

    ", + "exception":true + }, + "Arn":{ + "type":"string", + "max":256, + "min":1 + }, + "ConnectorParameters":{ + "type":"string", + "max":32768, + "min":0, + "sensitive":true + }, + "CreateActivityInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    The list of tags to add to a resource.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + } + } + }, + "CreateActivityOutput":{ + "type":"structure", + "required":[ + "activityArn", + "creationDate" + ], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the created activity.

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the activity is created.

    " + } + } + }, + "CreateStateMachineInput":{ + "type":"structure", + "required":[ + "name", + "definition", + "roleArn" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the state machine.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "definition":{ + "shape":"Definition", + "documentation":"

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    Tags to be added when creating a state machine.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + } + } + }, + "CreateStateMachineOutput":{ + "type":"structure", + "required":[ + "stateMachineArn", + "creationDate" + ], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the created state machine.

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the state machine is created.

    " + } + } + }, + "Definition":{ + "type":"string", + "max":1048576, + "min":1, + "sensitive":true + }, + "DeleteActivityInput":{ + "type":"structure", + "required":["activityArn"], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the activity to delete.

    " + } + } + }, + "DeleteActivityOutput":{ + "type":"structure", + "members":{ + } + }, + "DeleteStateMachineInput":{ + "type":"structure", + "required":["stateMachineArn"], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine to delete.

    " + } + } + }, + "DeleteStateMachineOutput":{ + "type":"structure", + "members":{ + } + }, + "DescribeActivityInput":{ + "type":"structure", + "required":["activityArn"], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the activity to describe.

    " + } + } + }, + "DescribeActivityOutput":{ + "type":"structure", + "required":[ + "activityArn", + "name", + "creationDate" + ], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the activity.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the activity.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the activity is created.

    " + } + } + }, + "DescribeExecutionInput":{ + "type":"structure", + "required":["executionArn"], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the execution to describe.

    " + } + } + }, + "DescribeExecutionOutput":{ + "type":"structure", + "required":[ + "executionArn", + "stateMachineArn", + "status", + "startDate", + "input" + ], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the execution.

    " + }, + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the executed stated machine.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the execution.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

    The current status of the execution.

    " + }, + "startDate":{ + "shape":"Timestamp", + "documentation":"

    The date the execution is started.

    " + }, + "stopDate":{ + "shape":"Timestamp", + "documentation":"

    If the execution has already ended, the date the execution stopped.

    " + }, + "input":{ + "shape":"SensitiveData", + "documentation":"

    The string that contains the JSON input data of the execution.

    " + }, + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON output data of the execution.

    This field is set only if the execution succeeds. If the execution fails, this field is null.

    " + } + } + }, + "DescribeStateMachineForExecutionInput":{ + "type":"structure", + "required":["executionArn"], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the execution you want state machine information for.

    " + } + } + }, + "DescribeStateMachineForExecutionOutput":{ + "type":"structure", + "required":[ + "stateMachineArn", + "name", + "definition", + "roleArn", + "updateDate" + ], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine associated with the execution.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the state machine associated with the execution.

    " + }, + "definition":{ + "shape":"Definition", + "documentation":"

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.

    " + }, + "updateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.

    " + } + } + }, + "DescribeStateMachineInput":{ + "type":"structure", + "required":["stateMachineArn"], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine to describe.

    " + } + } + }, + "DescribeStateMachineOutput":{ + "type":"structure", + "required":[ + "stateMachineArn", + "name", + "definition", + "roleArn", + "creationDate" + ], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the state machine.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the state machine.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "status":{ + "shape":"StateMachineStatus", + "documentation":"

    The current status of the state machine.

    " + }, + "definition":{ + "shape":"Definition", + "documentation":"

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the state machine is created.

    " + } + } + }, + "ErrorMessage":{"type":"string"}, + "EventId":{"type":"long"}, + "ExecutionAbortedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about an abort of an execution.

    " + }, + "ExecutionAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The execution has the same name as another execution (but a different input).

    Executions with the same name and input are considered idempotent.

    ", + "exception":true + }, + "ExecutionDoesNotExist":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified execution does not exist.

    ", + "exception":true + }, + "ExecutionFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about an execution failure event.

    " + }, + "ExecutionLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum number of running executions has been reached. Running executions must end or be stopped before a new execution can be started.

    ", + "exception":true + }, + "ExecutionList":{ + "type":"list", + "member":{"shape":"ExecutionListItem"} + }, + "ExecutionListItem":{ + "type":"structure", + "required":[ + "executionArn", + "stateMachineArn", + "name", + "status", + "startDate" + ], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the execution.

    " + }, + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the executed state machine.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the execution.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "status":{ + "shape":"ExecutionStatus", + "documentation":"

    The current status of the execution.

    " + }, + "startDate":{ + "shape":"Timestamp", + "documentation":"

    The date the execution started.

    " + }, + "stopDate":{ + "shape":"Timestamp", + "documentation":"

    If the execution already ended, the date the execution stopped.

    " + } + }, + "documentation":"

    Contains details about an execution.

    " + }, + "ExecutionStartedEventDetails":{ + "type":"structure", + "members":{ + "input":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data input to the execution.

    " + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.

    " + } + }, + "documentation":"

    Contains details about the start of the execution.

    " + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "RUNNING", + "SUCCEEDED", + "FAILED", + "TIMED_OUT", + "ABORTED" + ] + }, + "ExecutionSucceededEventDetails":{ + "type":"structure", + "members":{ + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data output by the execution.

    " + } + }, + "documentation":"

    Contains details about the successful termination of the execution.

    " + }, + "ExecutionTimedOutEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the timeout.

    " + } + }, + "documentation":"

    Contains details about the execution timeout that occurred during the execution.

    " + }, + "GetActivityTaskInput":{ + "type":"structure", + "required":["activityArn"], + "members":{ + "activityArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)

    " + }, + "workerName":{ + "shape":"Name", + "documentation":"

    You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.

    " + } + } + }, + "GetActivityTaskOutput":{ + "type":"structure", + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.

    " + }, + "input":{ + "shape":"SensitiveDataJobInput", + "documentation":"

    The string that contains the JSON input data for the task.

    " + } + } + }, + "GetExecutionHistoryInput":{ + "type":"structure", + "required":["executionArn"], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the execution.

    " + }, + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    Lists events in descending order of their timeStamp.

    " + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "GetExecutionHistoryOutput":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{ + "shape":"HistoryEventList", + "documentation":"

    The list of events that occurred in the execution.

    " + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "HistoryEvent":{ + "type":"structure", + "required":[ + "timestamp", + "type", + "id" + ], + "members":{ + "timestamp":{ + "shape":"Timestamp", + "documentation":"

    The date and time the event occurred.

    " + }, + "type":{ + "shape":"HistoryEventType", + "documentation":"

    The type of the event.

    " + }, + "id":{ + "shape":"EventId", + "documentation":"

    The id of the event. Events are numbered sequentially, starting at one.

    " + }, + "previousEventId":{ + "shape":"EventId", + "documentation":"

    The id of the previous event.

    " + }, + "activityFailedEventDetails":{"shape":"ActivityFailedEventDetails"}, + "activityScheduleFailedEventDetails":{ + "shape":"ActivityScheduleFailedEventDetails", + "documentation":"

    Contains details about an activity schedule event that failed during an execution.

    " + }, + "activityScheduledEventDetails":{"shape":"ActivityScheduledEventDetails"}, + "activityStartedEventDetails":{"shape":"ActivityStartedEventDetails"}, + "activitySucceededEventDetails":{"shape":"ActivitySucceededEventDetails"}, + "activityTimedOutEventDetails":{"shape":"ActivityTimedOutEventDetails"}, + "taskFailedEventDetails":{ + "shape":"TaskFailedEventDetails", + "documentation":"

    Contains details about the failure of a task.

    " + }, + "taskScheduledEventDetails":{ + "shape":"TaskScheduledEventDetails", + "documentation":"

    Contains details about a task that was scheduled.

    " + }, + "taskStartFailedEventDetails":{ + "shape":"TaskStartFailedEventDetails", + "documentation":"

    Contains details about a task that failed to start.

    " + }, + "taskStartedEventDetails":{ + "shape":"TaskStartedEventDetails", + "documentation":"

    Contains details about a task that was started.

    " + }, + "taskSubmitFailedEventDetails":{ + "shape":"TaskSubmitFailedEventDetails", + "documentation":"

    Contains details about a task that where the submit failed.

    " + }, + "taskSubmittedEventDetails":{ + "shape":"TaskSubmittedEventDetails", + "documentation":"

    Contains details about a submitted task.

    " + }, + "taskSucceededEventDetails":{ + "shape":"TaskSucceededEventDetails", + "documentation":"

    Contains details about a task that succeeded.

    " + }, + "taskTimedOutEventDetails":{ + "shape":"TaskTimedOutEventDetails", + "documentation":"

    Contains details about a task that timed out.

    " + }, + "executionFailedEventDetails":{"shape":"ExecutionFailedEventDetails"}, + "executionStartedEventDetails":{"shape":"ExecutionStartedEventDetails"}, + "executionSucceededEventDetails":{"shape":"ExecutionSucceededEventDetails"}, + "executionAbortedEventDetails":{"shape":"ExecutionAbortedEventDetails"}, + "executionTimedOutEventDetails":{"shape":"ExecutionTimedOutEventDetails"}, + "mapStateStartedEventDetails":{ + "shape":"MapStateStartedEventDetails", + "documentation":"

    Contains details about Map state that was started.

    " + }, + "mapIterationStartedEventDetails":{ + "shape":"MapIterationEventDetails", + "documentation":"

    Contains details about an iteration of a Map state that was started.

    " + }, + "mapIterationSucceededEventDetails":{ + "shape":"MapIterationEventDetails", + "documentation":"

    Contains details about an iteration of a Map state that succeeded.

    " + }, + "mapIterationFailedEventDetails":{ + "shape":"MapIterationEventDetails", + "documentation":"

    Contains details about an iteration of a Map state that failed.

    " + }, + "mapIterationAbortedEventDetails":{ + "shape":"MapIterationEventDetails", + "documentation":"

    Contains details about an iteration of a Map state that was aborted.

    " + }, + "lambdaFunctionFailedEventDetails":{"shape":"LambdaFunctionFailedEventDetails"}, + "lambdaFunctionScheduleFailedEventDetails":{"shape":"LambdaFunctionScheduleFailedEventDetails"}, + "lambdaFunctionScheduledEventDetails":{"shape":"LambdaFunctionScheduledEventDetails"}, + "lambdaFunctionStartFailedEventDetails":{ + "shape":"LambdaFunctionStartFailedEventDetails", + "documentation":"

    Contains details about a lambda function that failed to start during an execution.

    " + }, + "lambdaFunctionSucceededEventDetails":{ + "shape":"LambdaFunctionSucceededEventDetails", + "documentation":"

    Contains details about a lambda function that terminated successfully during an execution.

    " + }, + "lambdaFunctionTimedOutEventDetails":{"shape":"LambdaFunctionTimedOutEventDetails"}, + "stateEnteredEventDetails":{"shape":"StateEnteredEventDetails"}, + "stateExitedEventDetails":{"shape":"StateExitedEventDetails"} + }, + "documentation":"

    Contains details about the events of an execution.

    " + }, + "HistoryEventList":{ + "type":"list", + "member":{"shape":"HistoryEvent"}, + "documentation":"

    Contains details about the events that occurred during an execution.

    " + }, + "HistoryEventType":{ + "type":"string", + "enum":[ + "ActivityFailed", + "ActivityScheduled", + "ActivityScheduleFailed", + "ActivityStarted", + "ActivitySucceeded", + "ActivityTimedOut", + "ChoiceStateEntered", + "ChoiceStateExited", + "ExecutionAborted", + "ExecutionFailed", + "ExecutionStarted", + "ExecutionSucceeded", + "ExecutionTimedOut", + "FailStateEntered", + "LambdaFunctionFailed", + "LambdaFunctionScheduled", + "LambdaFunctionScheduleFailed", + "LambdaFunctionStarted", + "LambdaFunctionStartFailed", + "LambdaFunctionSucceeded", + "LambdaFunctionTimedOut", + "MapIterationAborted", + "MapIterationFailed", + "MapIterationStarted", + "MapIterationSucceeded", + "MapStateAborted", + "MapStateEntered", + "MapStateExited", + "MapStateFailed", + "MapStateStarted", + "MapStateSucceeded", + "ParallelStateAborted", + "ParallelStateEntered", + "ParallelStateExited", + "ParallelStateFailed", + "ParallelStateStarted", + "ParallelStateSucceeded", + "PassStateEntered", + "PassStateExited", + "SucceedStateEntered", + "SucceedStateExited", + "TaskFailed", + "TaskScheduled", + "TaskStarted", + "TaskStartFailed", + "TaskStateAborted", + "TaskStateEntered", + "TaskStateExited", + "TaskSubmitFailed", + "TaskSubmitted", + "TaskSucceeded", + "TaskTimedOut", + "WaitStateAborted", + "WaitStateEntered", + "WaitStateExited" + ] + }, + "Identity":{ + "type":"string", + "max":256 + }, + "InvalidArn":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided Amazon Resource Name (ARN) is invalid.

    ", + "exception":true + }, + "InvalidDefinition":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided Amazon States Language definition is invalid.

    ", + "exception":true + }, + "InvalidExecutionInput":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided JSON input data is invalid.

    ", + "exception":true + }, + "InvalidName":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided name is invalid.

    ", + "exception":true + }, + "InvalidOutput":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided JSON output data is invalid.

    ", + "exception":true + }, + "InvalidToken":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The provided token is invalid.

    ", + "exception":true + }, + "LambdaFunctionFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a lambda function that failed during an execution.

    " + }, + "LambdaFunctionScheduleFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a failed lambda function schedule event that occurred during an execution.

    " + }, + "LambdaFunctionScheduledEventDetails":{ + "type":"structure", + "required":["resource"], + "members":{ + "resource":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the scheduled lambda function.

    " + }, + "input":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data input to the lambda function.

    " + }, + "timeoutInSeconds":{ + "shape":"TimeoutInSeconds", + "documentation":"

    The maximum allowed duration of the lambda function.

    ", + "box":true + } + }, + "documentation":"

    Contains details about a lambda function scheduled during an execution.

    " + }, + "LambdaFunctionStartFailedEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a lambda function that failed to start during an execution.

    " + }, + "LambdaFunctionSucceededEventDetails":{ + "type":"structure", + "members":{ + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON data output by the lambda function.

    " + } + }, + "documentation":"

    Contains details about a lambda function that successfully terminated during an execution.

    " + }, + "LambdaFunctionTimedOutEventDetails":{ + "type":"structure", + "members":{ + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the timeout.

    " + } + }, + "documentation":"

    Contains details about a lambda function timeout that occurred during an execution.

    " + }, + "ListActivitiesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListActivitiesOutput":{ + "type":"structure", + "required":["activities"], + "members":{ + "activities":{ + "shape":"ActivityList", + "documentation":"

    The list of activities.

    " + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListExecutionsInput":{ + "type":"structure", + "required":["stateMachineArn"], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine whose executions is listed.

    " + }, + "statusFilter":{ + "shape":"ExecutionStatus", + "documentation":"

    If specified, only list the executions whose current execution status matches the given filter.

    " + }, + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " + }, + "nextToken":{ + "shape":"ListExecutionsPageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListExecutionsOutput":{ + "type":"structure", + "required":["executions"], + "members":{ + "executions":{ + "shape":"ExecutionList", + "documentation":"

    The list of matching executions.

    " + }, + "nextToken":{ + "shape":"ListExecutionsPageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListExecutionsPageToken":{ + "type":"string", + "max":3096, + "min":1 + }, + "ListStateMachinesInput":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

    " + }, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListStateMachinesOutput":{ + "type":"structure", + "required":["stateMachines"], + "members":{ + "stateMachines":{"shape":"StateMachineList"}, + "nextToken":{ + "shape":"PageToken", + "documentation":"

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    " + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

    " + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"TagList", + "documentation":"

    An array of tags associated with the resource.

    " + } + } + }, + "MapIterationEventDetails":{ + "type":"structure", + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the iteration’s parent Map state.

    " + }, + "index":{ + "shape":"UnsignedInteger", + "documentation":"

    The index of the array belonging to the Map state iteration.

    " + } + }, + "documentation":"

    Contains details about an iteration of a Map state.

    " + }, + "MapStateStartedEventDetails":{ + "type":"structure", + "members":{ + "length":{ + "shape":"UnsignedInteger", + "documentation":"

    The size of the array for Map state iterations.

    " + } + }, + "documentation":"

    Details about a Map state that was started.

    " + }, + "MissingRequiredParameter":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    Request is missing a required parameter. This error occurs if both definition and roleArn are not specified.

    ", + "exception":true + }, + "Name":{ + "type":"string", + "max":80, + "min":1 + }, + "PageSize":{ + "type":"integer", + "max":1000, + "min":0 + }, + "PageToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "ResourceNotFound":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceName":{"shape":"Arn"} + }, + "documentation":"

    Could not find the referenced resource. Only state machine and activity ARNs are supported.

    ", + "exception":true + }, + "ReverseOrder":{"type":"boolean"}, + "SendTaskFailureInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + } + }, + "SendTaskFailureOutput":{ + "type":"structure", + "members":{ + } + }, + "SendTaskHeartbeatInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

    " + } + } + }, + "SendTaskHeartbeatOutput":{ + "type":"structure", + "members":{ + } + }, + "SendTaskSuccessInput":{ + "type":"structure", + "required":[ + "taskToken", + "output" + ], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.

    " + }, + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON output of the task.

    " + } + } + }, + "SendTaskSuccessOutput":{ + "type":"structure", + "members":{ + } + }, + "SensitiveCause":{ + "type":"string", + "max":32768, + "min":0, + "sensitive":true + }, + "SensitiveData":{ + "type":"string", + "max":32768, + "sensitive":true + }, + "SensitiveDataJobInput":{ + "type":"string", + "max":65536, + "sensitive":true + }, + "SensitiveError":{ + "type":"string", + "max":256, + "min":0, + "sensitive":true + }, + "StartExecutionInput":{ + "type":"structure", + "required":["stateMachineArn"], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine to execute.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "input":{ + "shape":"SensitiveData", + "documentation":"

    The string that contains the JSON input data for the execution, for example:

    \"input\": \"{\\\"first_name\\\" : \\\"test\\\"}\"

    If you don't include any JSON input data, you still must include the two braces, for example: \"input\": \"{}\"

    " + } + } + }, + "StartExecutionOutput":{ + "type":"structure", + "required":[ + "executionArn", + "startDate" + ], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the execution.

    " + }, + "startDate":{ + "shape":"Timestamp", + "documentation":"

    The date the execution is started.

    " + } + } + }, + "StateEnteredEventDetails":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the state.

    " + }, + "input":{ + "shape":"SensitiveData", + "documentation":"

    The string that contains the JSON input data for the state.

    " + } + }, + "documentation":"

    Contains details about a state entered during an execution.

    " + }, + "StateExitedEventDetails":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the state.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "output":{ + "shape":"SensitiveData", + "documentation":"

    The JSON output data of the state.

    " + } + }, + "documentation":"

    Contains details about an exit from a state during an execution.

    " + }, + "StateMachineAlreadyExists":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    A state machine with the same name but a different definition or role ARN already exists.

    ", + "exception":true + }, + "StateMachineDeleting":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified state machine is being deleted.

    ", + "exception":true + }, + "StateMachineDoesNotExist":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The specified state machine does not exist.

    ", + "exception":true + }, + "StateMachineLimitExceeded":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The maximum number of state machines has been reached. Existing state machines must be deleted before a new state machine can be created.

    ", + "exception":true + }, + "StateMachineList":{ + "type":"list", + "member":{"shape":"StateMachineListItem"} + }, + "StateMachineListItem":{ + "type":"structure", + "required":[ + "stateMachineArn", + "name", + "creationDate" + ], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) that identifies the state machine.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the state machine.

    A name must not contain:

    • white space

    • brackets < > { } [ ]

    • wildcard characters ? *

    • special characters \" # % \\ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date the state machine is created.

    " + } + }, + "documentation":"

    Contains details about the state machine.

    " + }, + "StateMachineStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "DELETING" + ] + }, + "StopExecutionInput":{ + "type":"structure", + "required":["executionArn"], + "members":{ + "executionArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the execution to stop.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + } + }, + "StopExecutionOutput":{ + "type":"structure", + "required":["stopDate"], + "members":{ + "stopDate":{ + "shape":"Timestamp", + "documentation":"

    The date the execution is stopped.

    " + } + } + }, + "Tag":{ + "type":"structure", + "members":{ + "key":{ + "shape":"TagKey", + "documentation":"

    The key of a tag.

    " + }, + "value":{ + "shape":"TagValue", + "documentation":"

    The value of a tag.

    " + } + }, + "documentation":"

    Tags are key-value pairs that can be associated with Step Functions state machines and activities.

    An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

    " + }, + "tags":{ + "shape":"TagList", + "documentation":"

    The list of tags to add to a resource.

    Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.

    " + } + } + }, + "TagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TaskDoesNotExist":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TaskFailedEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a task failure event.

    " + }, + "TaskScheduledEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource", + "region", + "parameters" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "region":{ + "shape":"Name", + "documentation":"

    The region of the scheduled task

    " + }, + "parameters":{ + "shape":"ConnectorParameters", + "documentation":"

    The JSON data passed to the resource referenced in a task state.

    " + }, + "timeoutInSeconds":{ + "shape":"TimeoutInSeconds", + "documentation":"

    The maximum allowed duration of the task.

    ", + "box":true + } + }, + "documentation":"

    Contains details about a task scheduled during an execution.

    " + }, + "TaskStartFailedEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a task that failed to start during an execution.

    " + }, + "TaskStartedEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + } + }, + "documentation":"

    Contains details about the start of a task during an execution.

    " + }, + "TaskSubmitFailedEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a task that failed to submit during an execution.

    " + }, + "TaskSubmittedEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "output":{ + "shape":"SensitiveData", + "documentation":"

    The response from a resource when a task has started.

    " + } + }, + "documentation":"

    Contains details about a task submitted to a resource .

    " + }, + "TaskSucceededEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "output":{ + "shape":"SensitiveData", + "documentation":"

    The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.

    " + } + }, + "documentation":"

    Contains details about the successful completion of a task state.

    " + }, + "TaskTimedOut":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "exception":true + }, + "TaskTimedOutEventDetails":{ + "type":"structure", + "required":[ + "resourceType", + "resource" + ], + "members":{ + "resourceType":{ + "shape":"Name", + "documentation":"

    The action of the resource called by a task state.

    " + }, + "resource":{ + "shape":"Name", + "documentation":"

    The service name of the resource in a task state.

    " + }, + "error":{ + "shape":"SensitiveError", + "documentation":"

    The error code of the failure.

    " + }, + "cause":{ + "shape":"SensitiveCause", + "documentation":"

    A more detailed explanation of the cause of the failure.

    " + } + }, + "documentation":"

    Contains details about a resource timeout that occurred during an execution.

    " + }, + "TaskToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "TimeoutInSeconds":{"type":"long"}, + "Timestamp":{"type":"timestamp"}, + "TooManyTags":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"}, + "resourceName":{"shape":"Arn"} + }, + "documentation":"

    You've exceeded the number of tags allowed for a resource. See the Limits Topic in the AWS Step Functions Developer Guide.

    ", + "exception":true + }, + "UnsignedInteger":{ + "type":"integer", + "min":0 + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

    " + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The list of tags to remove from the resource.

    " + } + } + }, + "UntagResourceOutput":{ + "type":"structure", + "members":{ + } + }, + "UpdateStateMachineInput":{ + "type":"structure", + "required":["stateMachineArn"], + "members":{ + "stateMachineArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the state machine.

    " + }, + "definition":{ + "shape":"Definition", + "documentation":"

    The Amazon States Language definition of the state machine. See Amazon States Language.

    " + }, + "roleArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM role of the state machine.

    " + } + } + }, + "UpdateStateMachineOutput":{ + "type":"structure", + "required":["updateDate"], + "members":{ + "updateDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time the state machine was updated.

    " + } + } + } + }, + "documentation":"AWS Step Functions

    AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

    You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.

    Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the AWS Step Functions Developer Guide .

    " +} diff --git a/aws/dist/botocore/data/storagegateway/2013-06-30/examples-1.json b/aws/dist/botocore/data/storagegateway/2013-06-30/examples-1.json new file mode 100644 index 00000000..7cc0d7d4 --- /dev/null +++ b/aws/dist/botocore/data/storagegateway/2013-06-30/examples-1.json @@ -0,0 +1,1381 @@ +{ + "version": "1.0", + "examples": { + "ActivateGateway": [ + { + "input": { + "ActivationKey": "29AV1-3OFV9-VVIUB-NKT0I-LRO6V", + "GatewayName": "My_Gateway", + "GatewayRegion": "us-east-1", + "GatewayTimezone": "GMT-12:00", + "GatewayType": "STORED", + "MediumChangerType": "AWS-Gateway-VTL", + "TapeDriveType": "IBM-ULT3580-TD5" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Activates the gateway you previously deployed on your host.", + "id": "to-activate-the-gateway-1471281611207", + "title": "To activate the gateway" + } + ], + "AddCache": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example shows a request that activates a gateway-stored volume.", + "id": "to-add-a-cache-1471043606854", + "title": "To add a cache" + } + ], + "AddTagsToResource": [ + { + "input": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "Tags": [ + { + "Key": "Dev Gatgeway Region", + "Value": "East Coast" + } + ] + }, + "output": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Adds one or more tags to the specified resource.", + "id": "to-add-tags-to-resource-1471283689460", + "title": "To add tags to resource" + } + ], + "AddUploadBuffer": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Configures one or more gateway local disks as upload buffer for a specified gateway.", + "id": "to-add-upload-buffer-on-local-disk-1471293902847", + "title": "To add upload buffer on local disk" + } + ], + "AddWorkingStorage": [ + { + "input": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Configures one or more gateway local disks as working storage for a gateway. (Working storage is also referred to as upload buffer.)", + "id": "to-add-storage-on-local-disk-1471294305401", + "title": "To add storage on local disk" + } + ], + "CancelArchival": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated.", + "id": "to-cancel-virtual-tape-archiving-1471294865203", + "title": "To cancel virtual tape archiving" + } + ], + "CancelRetrieval": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated.", + "id": "to-cancel-virtual-tape-retrieval-1471295704491", + "title": "To cancel virtual tape retrieval" + } + ], + "CreateCachediSCSIVolume": [ + { + "input": { + "ClientToken": "cachedvol112233", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "NetworkInterfaceId": "10.1.1.1", + "SnapshotId": "snap-f47b7b94", + "TargetName": "my-volume", + "VolumeSizeInBytes": 536870912000 + }, + "output": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a cached volume on a specified cached gateway.", + "id": "to-create-a-cached-iscsi-volume-1471296661787", + "title": "To create a cached iSCSI volume" + } + ], + "CreateSnapshot": [ + { + "input": { + "SnapshotDescription": "My root volume snapshot as of 10/03/2017", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "SnapshotId": "snap-78e22663", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Initiates an ad-hoc snapshot of a gateway volume.", + "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561", + "title": "To create a snapshot of a gateway volume" + } + ], + "CreateSnapshotFromVolumeRecoveryPoint": [ + { + "input": { + "SnapshotDescription": "My root volume snapshot as of 2017-06-30T10:10:10.000Z", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "SnapshotId": "snap-78e22663", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeRecoveryPointTime": "2017-06-30T10:10:10.000Z" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Initiates a snapshot of a gateway from a volume recovery point.", + "id": "to-create-a-snapshot-of-a-gateway-volume-1471301469561", + "title": "To create a snapshot of a gateway volume" + } + ], + "CreateStorediSCSIVolume": [ + { + "input": { + "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "NetworkInterfaceId": "10.1.1.1", + "PreserveExistingData": true, + "SnapshotId": "snap-f47b7b94", + "TargetName": "my-volume" + }, + "output": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeSizeInBytes": 1099511627776 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a stored volume on a specified stored gateway.", + "id": "to-create-a-stored-iscsi-volume-1471367662813", + "title": "To create a stored iSCSI volume" + } + ], + "CreateTapeWithBarcode": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeBarcode": "TEST12345", + "TapeSizeInBytes": 107374182400 + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST12345" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates a virtual tape by using your own barcode.", + "id": "to-create-a-virtual-tape-using-a-barcode-1471371842452", + "title": "To create a virtual tape using a barcode" + } + ], + "CreateTapes": [ + { + "input": { + "ClientToken": "77777", + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "NumTapesToCreate": 3, + "TapeBarcodePrefix": "TEST", + "TapeSizeInBytes": 107374182400 + }, + "output": { + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST38A29D", + "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3AA29F", + "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST3BA29E" + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Creates one or more virtual tapes.", + "id": "to-create-a-virtual-tape-1471372061659", + "title": "To create a virtual tape" + } + ], + "DeleteBandwidthRateLimit": [ + { + "input": { + "BandwidthType": "All", + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the bandwidth rate limits of a gateway; either the upload or download limit, or both.", + "id": "to-delete-bandwidth-rate-limits-of-gateway-1471373225520", + "title": "To delete bandwidth rate limits of gateway" + } + ], + "DeleteChapCredentials": [ + { + "input": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.", + "id": "to-delete-chap-credentials-1471375025612", + "title": "To delete CHAP credentials" + } + ], + "DeleteGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation deletes the gateway, but not the gateway's VM from the host computer.", + "id": "to-delete-a-gatgeway-1471381697333", + "title": "To delete a gatgeway" + } + ], + "DeleteSnapshotSchedule": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This action enables you to delete a snapshot schedule for a volume.", + "id": "to-delete-a-snapshot-of-a-volume-1471382234377", + "title": "To delete a snapshot of a volume" + } + ], + "DeleteTape": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:204469490176:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example deletes the specified virtual tape.", + "id": "to-delete-a-virtual-tape-1471382444157", + "title": "To delete a virtual tape" + } + ], + "DeleteTapeArchive": [ + { + "input": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:204469490176:tape/TEST05A2A0" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified virtual tape from the virtual tape shelf (VTS).", + "id": "to-delete-a-virtual-tape-from-the-shelf-vts-1471383964329", + "title": "To delete a virtual tape from the shelf (VTS)" + } + ], + "DeleteVolume": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Deletes the specified gateway volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API.", + "id": "to-delete-a-gateway-volume-1471384418416", + "title": "To delete a gateway volume" + } + ], + "DescribeBandwidthRateLimit": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "AverageDownloadRateLimitInBitsPerSec": 204800, + "AverageUploadRateLimitInBitsPerSec": 102400, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a value for a bandwidth rate limit if set. If not set, then only the gateway ARN is returned.", + "id": "to-describe-the-bandwidth-rate-limits-of-a-gateway-1471384826404", + "title": "To describe the bandwidth rate limits of a gateway" + } + ], + "DescribeCache": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "CacheAllocatedInBytes": 2199023255552, + "CacheDirtyPercentage": 0.07, + "CacheHitPercentage": 99.68, + "CacheMissPercentage": 0.32, + "CacheUsedPercentage": 0.07, + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the cache of a gateway.", + "id": "to-describe-cache-information-1471385756036", + "title": "To describe cache information" + } + ], + "DescribeCachediSCSIVolumes": [ + { + "input": { + "VolumeARNs": [ + "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + ] + }, + "output": { + "CachediSCSIVolumes": [ + { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 1099511627776, + "VolumeStatus": "AVAILABLE", + "VolumeType": "CACHED iSCSI", + "VolumeiSCSIAttributes": { + "ChapEnabled": true, + "LunNumber": 1, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of the gateway cached iSCSI volumes specified in the request.", + "id": "to-describe-gateway-cached-iscsi-volumes-1471458094649", + "title": "To describe gateway cached iSCSI volumes" + } + ], + "DescribeChapCredentials": [ + { + "input": { + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "ChapCredentials": [ + { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "SecretToAuthenticateInitiator": "111111111111", + "SecretToAuthenticateTarget": "222222222222", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.", + "id": "to-describe-chap-credetnitals-for-an-iscsi-1471467462967", + "title": "To describe CHAP credetnitals for an iSCSI" + } + ], + "DescribeGatewayInformation": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayId": "sgw-AABB1122", + "GatewayName": "My_Gateway", + "GatewayNetworkInterfaces": [ + { + "Ipv4Address": "10.35.69.216" + } + ], + "GatewayState": "STATE_RUNNING", + "GatewayTimezone": "GMT-8:00", + "GatewayType": "STORED", + "LastSoftwareUpdate": "2016-01-02T16:00:00", + "NextUpdateAvailabilityDate": "2017-01-02T16:00:00" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not).", + "id": "to-describe-metadata-about-the-gateway-1471467849079", + "title": "To describe metadata about the gateway" + } + ], + "DescribeMaintenanceStartTime": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DayOfWeek": 2, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "HourOfDay": 15, + "MinuteOfHour": 35, + "Timezone": "GMT+7:00" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns your gateway's weekly maintenance start time including the day and time of the week.", + "id": "to-describe-gateways-maintenance-start-time-1471470727387", + "title": "To describe gateway's maintenance start time" + } + ], + "DescribeSnapshotSchedule": [ + { + "input": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "Description": "sgw-AABB1122:vol-AABB1122:Schedule", + "RecurrenceInHours": 24, + "StartAt": 6, + "Timezone": "GMT+7:00", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Describes the snapshot schedule for the specified gateway volume including intervals at which snapshots are automatically initiated.", + "id": "to-describe-snapshot-schedule-for-gateway-volume-1471471139538", + "title": "To describe snapshot schedule for gateway volume" + } + ], + "DescribeStorediSCSIVolumes": [ + { + "input": { + "VolumeARNs": [ + "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + ] + }, + "output": { + "StorediSCSIVolumes": [ + { + "PreservedExistingData": false, + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeDiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "VolumeId": "vol-1122AABB", + "VolumeProgress": 23.7, + "VolumeSizeInBytes": 1099511627776, + "VolumeStatus": "BOOTSTRAPPING", + "VolumeiSCSIAttributes": { + "ChapEnabled": true, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + } + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns the description of the gateway volumes specified in the request belonging to the same gateway.", + "id": "to-describe-the-volumes-of-a-gateway-1471472640660", + "title": "To describe the volumes of a gateway" + } + ], + "DescribeTapeArchives": [ + { + "input": { + "Limit": 123, + "Marker": "1", + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/AM08A1AD", + "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" + ] + }, + "output": { + "Marker": "1", + "TapeArchives": [ + { + "CompletionTime": "2016-12-16T13:50Z", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AM08A1AD", + "TapeBarcode": "AM08A1AD", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "ARCHIVED" + }, + { + "CompletionTime": "2016-12-16T13:59Z", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", + "TapeBarcode": "AMZN01A2A4", + "TapeSizeInBytes": 429496729600, + "TapeStatus": "ARCHIVED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of specified virtual tapes in the virtual tape shelf (VTS).", + "id": "to-describe-virtual-tapes-in-the-vts-1471473188198", + "title": "To describe virtual tapes in the VTS" + } + ], + "DescribeTapeRecoveryPoints": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Limit": 1, + "Marker": "1" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Marker": "1", + "TapeRecoveryPointInfos": [ + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999:tape/AMZN01A2A4", + "TapeRecoveryPointTime": "2016-12-16T13:50Z", + "TapeSizeInBytes": 1471550497, + "TapeStatus": "AVAILABLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a list of virtual tape recovery points that are available for the specified gateway-VTL.", + "id": "to-describe-virtual-tape-recovery-points-1471542042026", + "title": "To describe virtual tape recovery points" + } + ], + "DescribeTapes": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Limit": 2, + "Marker": "1", + "TapeARNs": [ + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", + "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0" + ] + }, + "output": { + "Marker": "1", + "Tapes": [ + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST04A2A1", + "TapeBarcode": "TEST04A2A1", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "AVAILABLE" + }, + { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST05A2A0", + "TapeBarcode": "TEST05A2A0", + "TapeSizeInBytes": 107374182400, + "TapeStatus": "AVAILABLE" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes.", + "id": "to-describe-virtual-tapes-associated-with-gateway-1471629287727", + "title": "To describe virtual tape(s) associated with gateway" + } + ], + "DescribeUploadBuffer": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "UploadBufferAllocatedInBytes": 0, + "UploadBufferUsedInBytes": 161061273600 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated/used.", + "id": "to-describe-upload-buffer-of-gateway-1471631099003", + "title": "To describe upload buffer of gateway" + }, + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:04:00.0-scsi-0:1:0:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "UploadBufferAllocatedInBytes": 161061273600, + "UploadBufferUsedInBytes": 0 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns information about the upload buffer of a gateway including disk IDs and the amount of upload buffer space allocated and used.", + "id": "to-describe-upload-buffer-of-a-gateway--1471904566370", + "title": "To describe upload buffer of a gateway" + } + ], + "DescribeVTLDevices": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Limit": 123, + "Marker": "1", + "VTLDeviceARNs": [ + + ] + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "Marker": "1", + "VTLDevices": [ + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.207", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-mediachanger" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001", + "VTLDeviceProductIdentifier": "L700", + "VTLDeviceType": "Medium Changer", + "VTLDeviceVendor": "STK" + }, + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.209", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-01" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00001", + "VTLDeviceProductIdentifier": "ULT3580-TD5", + "VTLDeviceType": "Tape Drive", + "VTLDeviceVendor": "IBM" + }, + { + "DeviceiSCSIAttributes": { + "ChapEnabled": false, + "NetworkInterfaceId": "10.243.43.209", + "NetworkInterfacePort": 3260, + "TargetARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:sgw-1fad4876-tapedrive-02" + }, + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_TAPEDRIVE_00002", + "VTLDeviceProductIdentifier": "ULT3580-TD5", + "VTLDeviceType": "Tape Drive", + "VTLDeviceVendor": "IBM" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Returns a description of virtual tape library (VTL) devices for the specified gateway.", + "id": "to-describe-virtual-tape-library-vtl-devices-of-a-single-gateway-1471906071410", + "title": "To describe virtual tape library (VTL) devices of a single gateway" + } + ], + "DescribeWorkingStorage": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "DiskIds": [ + "pci-0000:03:00.0-scsi-0:0:0:0", + "pci-0000:03:00.0-scsi-0:0:1:0" + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "WorkingStorageAllocatedInBytes": 2199023255552, + "WorkingStorageUsedInBytes": 789207040 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation is supported only for the gateway-stored volume architecture. This operation is deprecated in cached-volumes API version (20120630). Use DescribeUploadBuffer instead.", + "id": "to-describe-the-working-storage-of-a-gateway-depreciated-1472070842332", + "title": "To describe the working storage of a gateway [Depreciated]" + } + ], + "DisableGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Disables a gateway when the gateway is no longer functioning. Use this operation for a gateway-VTL that is not reachable or not functioning.", + "id": "to-disable-a-gateway-when-it-is-no-longer-functioning-1472076046936", + "title": "To disable a gateway when it is no longer functioning" + } + ], + "ListGateways": [ + { + "input": { + "Limit": 2, + "Marker": "1" + }, + "output": { + "Gateways": [ + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-23A4567C" + } + ], + "Marker": "1" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists gateways owned by an AWS account in a specified region as requested. Results are sorted by gateway ARN up to a maximum of 100 gateways.", + "id": "to-lists-region-specific-gateways-per-aws-account-1472077860657", + "title": "To lists region specific gateways per AWS account" + } + ], + "ListLocalDisks": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "Disks": [ + { + "DiskAllocationType": "CACHE_STORAGE", + "DiskId": "pci-0000:03:00.0-scsi-0:0:0:0", + "DiskNode": "SCSI(0:0)", + "DiskPath": "/dev/sda", + "DiskSizeInBytes": 1099511627776, + "DiskStatus": "missing" + }, + { + "DiskAllocationResource": "", + "DiskAllocationType": "UPLOAD_BUFFER", + "DiskId": "pci-0000:03:00.0-scsi-0:0:1:0", + "DiskNode": "SCSI(0:1)", + "DiskPath": "/dev/sdb", + "DiskSizeInBytes": 1099511627776, + "DiskStatus": "present" + } + ], + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all.", + "id": "to-list-the-gateways-local-disks-1472079564618", + "title": "To list the gateway's local disks" + } + ], + "ListTagsForResource": [ + { + "input": { + "Limit": 1, + "Marker": "1", + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "output": { + "Marker": "1", + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "Tags": [ + { + "Key": "Dev Gatgeway Region", + "Value": "East Coast" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the tags that have been added to the specified resource.", + "id": "to-list-tags-that-have-been-added-to-a-resource-1472080268972", + "title": "To list tags that have been added to a resource" + } + ], + "ListVolumeRecoveryPoints": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "VolumeRecoveryPointInfos": [ + { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeRecoveryPointTime": "2012-09-04T21:08:44.627Z", + "VolumeSizeInBytes": 536870912000 + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the recovery points for a specified gateway in which all data of the volume is consistent and can be used to create a snapshot.", + "id": "to-list-recovery-points-for-a-gateway-1472143015088", + "title": "To list recovery points for a gateway" + } + ], + "ListVolumes": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Limit": 2, + "Marker": "1" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "Marker": "1", + "VolumeInfos": [ + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayId": "sgw-12A3456B", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 107374182400, + "VolumeType": "STORED" + }, + { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C", + "GatewayId": "sgw-gw-13B4567C", + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C/volume/vol-3344CCDD", + "VolumeId": "vol-1122AABB", + "VolumeSizeInBytes": 107374182400, + "VolumeType": "STORED" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN up to a maximum of 100 volumes.", + "id": "to-list-the-iscsi-stored-volumes-of-a-gateway-1472145723653", + "title": "To list the iSCSI stored volumes of a gateway" + } + ], + "RemoveTagsFromResource": [ + { + "input": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B", + "TagKeys": [ + "Dev Gatgeway Region", + "East Coast" + ] + }, + "output": { + "ResourceARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-11A2222B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Lists the iSCSI stored volumes of a gateway. Removes one or more tags from the specified resource.", + "id": "to-remove-tags-from-a-resource-1472147210553", + "title": "To remove tags from a resource" + } + ], + "ResetCache": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-13B4567C" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage.", + "id": "to-reset-cache-disks-in-error-status-1472148909807", + "title": "To reset cache disks in error status" + } + ], + "RetrieveTapeArchive": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a gateway-VTL. Virtual tapes archived in the VTS are not associated with any gateway.", + "id": "to-retrieve-an-archived-tape-from-the-vts-1472149812358", + "title": "To retrieve an archived tape from the VTS" + } + ], + "RetrieveTapeRecoveryPoint": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "output": { + "TapeARN": "arn:aws:storagegateway:us-east-1:999999999999:tape/TEST0AA2AF" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Retrieves the recovery point for the specified virtual tape.", + "id": "to-retrieve-the-recovery-point-of-a-virtual-tape-1472150014805", + "title": "To retrieve the recovery point of a virtual tape" + } + ], + "SetLocalConsolePassword": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B", + "LocalConsolePassword": "PassWordMustBeAtLeast6Chars." + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Sets the password for your VM local console.", + "id": "to-set-a-password-for-your-vm-1472150202632", + "title": "To set a password for your VM" + } + ], + "ShutdownGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation shuts down the gateway service component running in the storage gateway's virtual machine (VM) and not the VM.", + "id": "to-shut-down-a-gateway-service-1472150508835", + "title": "To shut down a gateway service" + } + ], + "StartGateway": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Starts a gateway service that was previously shut down.", + "id": "to-start-a-gateway-service-1472150722315", + "title": "To start a gateway service" + } + ], + "UpdateBandwidthRateLimit": [ + { + "input": { + "AverageDownloadRateLimitInBitsPerSec": 102400, + "AverageUploadRateLimitInBitsPerSec": 51200, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the bandwidth rate limits of a gateway. Both the upload and download bandwidth rate limit can be set, or either one of the two. If a new limit is not set, the existing rate limit remains.", + "id": "to-update-the-bandwidth-rate-limits-of-a-gateway-1472151016202", + "title": "To update the bandwidth rate limits of a gateway" + } + ], + "UpdateChapCredentials": [ + { + "input": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "SecretToAuthenticateInitiator": "111111111111", + "SecretToAuthenticateTarget": "222222222222", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "output": { + "InitiatorName": "iqn.1991-05.com.microsoft:computername.domain.example.com", + "TargetARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target.", + "id": "to-update-chap-credentials-for-an-iscsi-target-1472151325795", + "title": "To update CHAP credentials for an iSCSI target" + } + ], + "UpdateGatewayInformation": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayName": "MyGateway2", + "GatewayTimezone": "GMT-12:00" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "GatewayName": "" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a gateway's metadata, which includes the gateway's name and time zone.", + "id": "to-update-a-gateways-metadata-1472151688693", + "title": "To update a gateway's metadata" + } + ], + "UpdateGatewaySoftwareNow": [ + { + "input": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.", + "id": "to-update-a-gateways-vm-software-1472152020929", + "title": "To update a gateway's VM software" + } + ], + "UpdateMaintenanceStartTime": [ + { + "input": { + "DayOfWeek": 2, + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", + "HourOfDay": 0, + "MinuteOfHour": 30 + }, + "output": { + "GatewayARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is in your gateway's time zone.", + "id": "to-update-a-gateways-maintenance-start-time-1472152552031", + "title": "To update a gateway's maintenance start time" + } + ], + "UpdateSnapshotSchedule": [ + { + "input": { + "Description": "Hourly snapshot", + "RecurrenceInHours": 1, + "StartAt": 0, + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "output": { + "VolumeARN": "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates a snapshot schedule configured for a gateway volume.", + "id": "to-update-a-volume-snapshot-schedule-1472152757068", + "title": "To update a volume snapshot schedule" + } + ], + "UpdateVTLDeviceType": [ + { + "input": { + "DeviceType": "Medium Changer", + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" + }, + "output": { + "VTLDeviceARN": "arn:aws:storagegateway:us-east-1:999999999999:gateway/sgw-12A3456B/device/AMZN_SGW-1FAD4876_MEDIACHANGER_00001" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "Updates the type of medium changer in a gateway-VTL after a gateway-VTL is activated.", + "id": "to-update-a-vtl-device-type-1472153012967", + "title": "To update a VTL device type" + } + ] + } +} diff --git a/aws/dist/botocore/data/storagegateway/2013-06-30/paginators-1.json b/aws/dist/botocore/data/storagegateway/2013-06-30/paginators-1.json new file mode 100644 index 00000000..6126e782 --- /dev/null +++ b/aws/dist/botocore/data/storagegateway/2013-06-30/paginators-1.json @@ -0,0 +1,64 @@ +{ + "pagination": { + "DescribeTapeArchives": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeArchives" + }, + "DescribeTapeRecoveryPoints": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeRecoveryPointInfos" + }, + "DescribeTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Tapes" + }, + "DescribeVTLDevices": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VTLDevices" + }, + "ListGateways": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Gateways" + }, + "ListVolumes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "VolumeInfos" + }, + "ListTapes": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "TapeInfos" + }, + "ListFileShares": { + "input_token": "Marker", + "limit_key": "Limit", + "non_aggregate_keys": [ + "Marker" + ], + "output_token": "NextMarker", + "result_key": "FileShareInfoList" + }, + "ListTagsForResource": { + "input_token": "Marker", + "limit_key": "Limit", + "non_aggregate_keys": [ + "ResourceARN" + ], + "output_token": "Marker", + "result_key": "Tags" + } + } +} diff --git a/aws/dist/botocore/data/storagegateway/2013-06-30/service-2.json b/aws/dist/botocore/data/storagegateway/2013-06-30/service-2.json new file mode 100644 index 00000000..f7ee221e --- /dev/null +++ b/aws/dist/botocore/data/storagegateway/2013-06-30/service-2.json @@ -0,0 +1,4693 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-06-30", + "endpointPrefix":"storagegateway", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Storage Gateway", + "serviceId":"Storage Gateway", + "signatureVersion":"v4", + "targetPrefix":"StorageGateway_20130630", + "uid":"storagegateway-2013-06-30" + }, + "operations":{ + "ActivateGateway":{ + "name":"ActivateGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ActivateGatewayInput"}, + "output":{"shape":"ActivateGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the AWS Region that you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

    You must turn on the gateway VM before you can activate your gateway.

    " + }, + "AddCache":{ + "name":"AddCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddCacheInput"}, + "output":{"shape":"AddCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Configures one or more gateway local disks as cache for a gateway. This operation is only supported in the cached volume, tape and file gateway type (see Storage Gateway Concepts).

    In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add cache, and one or more disk IDs that you want to configure as cache.

    " + }, + "AddTagsToResource":{ + "name":"AddTagsToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddTagsToResourceInput"}, + "output":{"shape":"AddTagsToResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

    • Storage gateways of all types

    • Storage volumes

    • Virtual tapes

    • NFS and SMB file shares

    You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

    " + }, + "AddUploadBuffer":{ + "name":"AddUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddUploadBufferInput"}, + "output":{"shape":"AddUploadBufferOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

    In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

    " + }, + "AddWorkingStorage":{ + "name":"AddWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddWorkingStorageInput"}, + "output":{"shape":"AddWorkingStorageOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

    Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

    In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

    " + }, + "AssignTapePool":{ + "name":"AssignTapePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignTapePoolInput"}, + "output":{"shape":"AssignTapePoolOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Assigns a tape to a tape pool for archiving. The tape assigned to a pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + }, + "AttachVolume":{ + "name":"AttachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AttachVolumeInput"}, + "output":{"shape":"AttachVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

    " + }, + "CancelArchival":{ + "name":"CancelArchival", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelArchivalInput"}, + "output":{"shape":"CancelArchivalOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

    " + }, + "CancelRetrieval":{ + "name":"CancelRetrieval", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CancelRetrievalInput"}, + "output":{"shape":"CancelRetrievalOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

    " + }, + "CreateCachediSCSIVolume":{ + "name":"CreateCachediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCachediSCSIVolumeInput"}, + "output":{"shape":"CreateCachediSCSIVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a cached volume on a specified cached volume gateway. This operation is only supported in the cached volume gateway type.

    Cache storage must be allocated to the gateway before you can create a cached volume. Use the AddCache operation to add cache storage to a gateway.

    In the request, you must specify the gateway, size of the volume in bytes, the iSCSI target name, an IP address on which to expose the target, and a unique client token. In response, the gateway creates the volume and returns information about it. This information includes the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

    Optionally, you can provide the ARN for an existing volume as the SourceVolumeARN for this cached volume, which creates an exact copy of the existing volume’s latest recovery point. The VolumeSizeInBytes value must be equal to or larger than the size of the copied volume, in bytes.

    " + }, + "CreateNFSFileShare":{ + "name":"CreateNFSFileShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateNFSFileShareInput"}, + "output":{"shape":"CreateNFSFileShareOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a Network File System (NFS) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway exposes file shares using a NFS interface. This operation is only supported for file gateways.

    File gateway requires AWS Security Token Service (AWS STS) to be activated to enable you create a file share. Make sure AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in the AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

    File gateway does not support creating hard or symbolic links on a file share.

    " + }, + "CreateSMBFileShare":{ + "name":"CreateSMBFileShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSMBFileShareInput"}, + "output":{"shape":"CreateSMBFileShareOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a Server Message Block (SMB) file share on an existing file gateway. In Storage Gateway, a file share is a file system mount point backed by Amazon S3 cloud storage. Storage Gateway expose file shares using a SMB interface. This operation is only supported for file gateways.

    File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

    File gateways don't support creating hard or symbolic links on a file share.

    " + }, + "CreateSnapshot":{ + "name":"CreateSnapshot", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotInput"}, + "output":{"shape":"CreateSnapshotOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Initiates a snapshot of a volume.

    AWS Storage Gateway provides the ability to back up point-in-time snapshots of your data to Amazon Simple Storage (S3) for durable off-site recovery, as well as import the data to an Amazon Elastic Block Store (EBS) volume in Amazon Elastic Compute Cloud (EC2). You can take snapshots of your gateway volume on a scheduled or ad hoc basis. This API enables you to take ad-hoc snapshot. For more information, see Editing a Snapshot Schedule.

    In the CreateSnapshot request you identify the volume by providing its Amazon Resource Name (ARN). You must also provide description for the snapshot. When AWS Storage Gateway takes the snapshot of specified volume, the snapshot and description appears in the AWS Storage Gateway Console. In response, AWS Storage Gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot. This operation is only supported in stored and cached volume gateway type.

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information, see DescribeSnapshots or DeleteSnapshot in the EC2 API reference.

    Volume and snapshot IDs are changing to a longer length ID format. For more information, see the important note on the Welcome page.

    " + }, + "CreateSnapshotFromVolumeRecoveryPoint":{ + "name":"CreateSnapshotFromVolumeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSnapshotFromVolumeRecoveryPointInput"}, + "output":{"shape":"CreateSnapshotFromVolumeRecoveryPointOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"}, + {"shape":"ServiceUnavailableError"} + ], + "documentation":"

    Initiates a snapshot of a gateway from a volume recovery point. This operation is only supported in the cached volume gateway type.

    A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot. To get a list of volume recovery point for cached volume gateway, use ListVolumeRecoveryPoints.

    In the CreateSnapshotFromVolumeRecoveryPoint request, you identify the volume by providing its Amazon Resource Name (ARN). You must also provide a description for the snapshot. When the gateway takes a snapshot of the specified volume, the snapshot and its description appear in the AWS Storage Gateway console. In response, the gateway returns you a snapshot ID. You can use this snapshot ID to check the snapshot progress or later use it when you want to create a volume from a snapshot.

    To list or delete a snapshot, you must use the Amazon EC2 API. For more information, in Amazon Elastic Compute Cloud API Reference.

    " + }, + "CreateStorediSCSIVolume":{ + "name":"CreateStorediSCSIVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateStorediSCSIVolumeInput"}, + "output":{"shape":"CreateStorediSCSIVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a volume on a specified gateway. This operation is only supported in the stored volume gateway type.

    The size of the volume to create is inferred from the disk size. You can choose to preserve existing data on the disk, create volume from an existing snapshot, or create an empty volume. If you choose to create an empty gateway volume, then any existing data on the disk is erased.

    In the request you must specify the gateway and the disk information on which you are creating the volume. In response, the gateway creates the volume and returns volume information such as the volume Amazon Resource Name (ARN), its size, and the iSCSI target ARN that initiators can use to connect to the volume target.

    " + }, + "CreateTapeWithBarcode":{ + "name":"CreateTapeWithBarcode", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTapeWithBarcodeInput"}, + "output":{"shape":"CreateTapeWithBarcodeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates a virtual tape by using your own barcode. You write data to the virtual tape and then archive the tape. A barcode is unique and can not be reused if it has already been used on a tape . This applies to barcodes used on deleted tapes. This operation is only supported in the tape gateway type.

    Cache storage must be allocated to the gateway before you can create a virtual tape. Use the AddCache operation to add cache storage to a gateway.

    " + }, + "CreateTapes":{ + "name":"CreateTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTapesInput"}, + "output":{"shape":"CreateTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Creates one or more virtual tapes. You write data to the virtual tapes and then archive the tapes. This operation is only supported in the tape gateway type.

    Cache storage must be allocated to the gateway before you can create virtual tapes. Use the AddCache operation to add cache storage to a gateway.

    " + }, + "DeleteBandwidthRateLimit":{ + "name":"DeleteBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteBandwidthRateLimitInput"}, + "output":{"shape":"DeleteBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes the bandwidth rate limits of a gateway. You can delete either the upload and download bandwidth rate limit, or you can delete both. If you delete only one of the limits, the other limit remains unchanged. To specify which gateway to work with, use the Amazon Resource Name (ARN) of the gateway in your request.

    " + }, + "DeleteChapCredentials":{ + "name":"DeleteChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteChapCredentialsInput"}, + "output":{"shape":"DeleteChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target and initiator pair.

    " + }, + "DeleteFileShare":{ + "name":"DeleteFileShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFileShareInput"}, + "output":{"shape":"DeleteFileShareOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes a file share from a file gateway. This operation is only supported for file gateways.

    " + }, + "DeleteGateway":{ + "name":"DeleteGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGatewayInput"}, + "output":{"shape":"DeleteGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes a gateway. To specify which gateway to delete, use the Amazon Resource Name (ARN) of the gateway in your request. The operation deletes the gateway; however, it does not delete the gateway virtual machine (VM) from your host computer.

    After you delete a gateway, you cannot reactivate it. Completed snapshots of the gateway volumes are not deleted upon deleting the gateway, however, pending snapshots will not complete. After you delete a gateway, your next step is to remove it from your environment.

    You no longer pay software charges after the gateway is deleted; however, your existing Amazon EBS snapshots persist and you will continue to be billed for these snapshots. You can choose to remove all remaining Amazon EBS snapshots by canceling your Amazon EC2 subscription.  If you prefer not to cancel your Amazon EC2 subscription, you can delete your snapshots using the Amazon EC2 console. For more information, see the AWS Storage Gateway Detail Page.

    " + }, + "DeleteSnapshotSchedule":{ + "name":"DeleteSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSnapshotScheduleInput"}, + "output":{"shape":"DeleteSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes a snapshot of a volume.

    You can take snapshots of your gateway volumes on a scheduled or ad hoc basis. This API action enables you to delete a snapshot schedule for a volume. For more information, see Working with Snapshots. In the DeleteSnapshotSchedule request, you identify the volume by providing its Amazon Resource Name (ARN). This operation is only supported in stored and cached volume gateway types.

    To list or delete a snapshot, you must use the Amazon EC2 API. in Amazon Elastic Compute Cloud API Reference.

    " + }, + "DeleteTape":{ + "name":"DeleteTape", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTapeInput"}, + "output":{"shape":"DeleteTapeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes the specified virtual tape. This operation is only supported in the tape gateway type.

    " + }, + "DeleteTapeArchive":{ + "name":"DeleteTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTapeArchiveInput"}, + "output":{"shape":"DeleteTapeArchiveOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes the specified virtual tape from the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

    " + }, + "DeleteVolume":{ + "name":"DeleteVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVolumeInput"}, + "output":{"shape":"DeleteVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Deletes the specified storage volume that you previously created using the CreateCachediSCSIVolume or CreateStorediSCSIVolume API. This operation is only supported in the cached volume and stored volume types. For stored volume gateways, the local disk that was configured as the storage volume is not deleted. You can reuse the local disk to create another storage volume.

    Before you delete a volume, make sure there are no iSCSI connections to the volume you are deleting. You should also make sure there is no snapshot in progress. You can use the Amazon Elastic Compute Cloud (Amazon EC2) API to query snapshots on the volume you are deleting and check the snapshot status. For more information, go to DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    In the request, you must provide the Amazon Resource Name (ARN) of the storage volume you want to delete.

    " + }, + "DescribeBandwidthRateLimit":{ + "name":"DescribeBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeBandwidthRateLimitInput"}, + "output":{"shape":"DescribeBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the bandwidth rate limits of a gateway. By default, these limits are not set, which means no bandwidth rate limiting is in effect.

    This operation only returns a value for a bandwidth rate limit only if the limit is set. If no limits are set for the gateway, then this operation returns only the gateway ARN in the response body. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

    " + }, + "DescribeCache":{ + "name":"DescribeCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCacheInput"}, + "output":{"shape":"DescribeCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns information about the cache of a gateway. This operation is only supported in the cached volume, tape and file gateway types.

    The response includes disk IDs that are configured as cache, and it includes the amount of cache allocated and used.

    " + }, + "DescribeCachediSCSIVolumes":{ + "name":"DescribeCachediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCachediSCSIVolumesInput"}, + "output":{"shape":"DescribeCachediSCSIVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a description of the gateway volumes specified in the request. This operation is only supported in the cached volume gateway types.

    The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume Amazon Resource Name (ARN).

    " + }, + "DescribeChapCredentials":{ + "name":"DescribeChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeChapCredentialsInput"}, + "output":{"shape":"DescribeChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns an array of Challenge-Handshake Authentication Protocol (CHAP) credentials information for a specified iSCSI target, one for each target-initiator pair.

    " + }, + "DescribeGatewayInformation":{ + "name":"DescribeGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGatewayInformationInput"}, + "output":{"shape":"DescribeGatewayInformationOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.

    " + }, + "DescribeMaintenanceStartTime":{ + "name":"DescribeMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeMaintenanceStartTimeInput"}, + "output":{"shape":"DescribeMaintenanceStartTimeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone.

    " + }, + "DescribeNFSFileShares":{ + "name":"DescribeNFSFileShares", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeNFSFileSharesInput"}, + "output":{"shape":"DescribeNFSFileSharesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Gets a description for one or more Network File System (NFS) file shares from a file gateway. This operation is only supported for file gateways.

    " + }, + "DescribeSMBFileShares":{ + "name":"DescribeSMBFileShares", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSMBFileSharesInput"}, + "output":{"shape":"DescribeSMBFileSharesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Gets a description for one or more Server Message Block (SMB) file shares from a file gateway. This operation is only supported for file gateways.

    " + }, + "DescribeSMBSettings":{ + "name":"DescribeSMBSettings", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSMBSettingsInput"}, + "output":{"shape":"DescribeSMBSettingsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Gets a description of a Server Message Block (SMB) file share settings from a file gateway. This operation is only supported for file gateways.

    " + }, + "DescribeSnapshotSchedule":{ + "name":"DescribeSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSnapshotScheduleInput"}, + "output":{"shape":"DescribeSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Describes the snapshot schedule for the specified gateway volume. The snapshot schedule information includes intervals at which snapshots are automatically initiated on the volume. This operation is only supported in the cached volume and stored volume types.

    " + }, + "DescribeStorediSCSIVolumes":{ + "name":"DescribeStorediSCSIVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeStorediSCSIVolumesInput"}, + "output":{"shape":"DescribeStorediSCSIVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the description of the gateway volumes specified in the request. The list of gateway volumes in the request must be from one gateway. In the response Amazon Storage Gateway returns volume information sorted by volume ARNs. This operation is only supported in stored volume gateway type.

    " + }, + "DescribeTapeArchives":{ + "name":"DescribeTapeArchives", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapeArchivesInput"}, + "output":{"shape":"DescribeTapeArchivesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a description of specified virtual tapes in the virtual tape shelf (VTS). This operation is only supported in the tape gateway type.

    If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

    " + }, + "DescribeTapeRecoveryPoints":{ + "name":"DescribeTapeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapeRecoveryPointsInput"}, + "output":{"shape":"DescribeTapeRecoveryPointsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a list of virtual tape recovery points that are available for the specified tape gateway.

    A recovery point is a point-in-time view of a virtual tape at which all the data on the virtual tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway. This operation is only supported in the tape gateway type.

    " + }, + "DescribeTapes":{ + "name":"DescribeTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTapesInput"}, + "output":{"shape":"DescribeTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway. This operation is only supported in the tape gateway type.

    " + }, + "DescribeUploadBuffer":{ + "name":"DescribeUploadBuffer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUploadBufferInput"}, + "output":{"shape":"DescribeUploadBufferOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns information about the upload buffer of a gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

    The response includes disk IDs that are configured as upload buffer space, and it includes the amount of upload buffer space allocated and used.

    " + }, + "DescribeVTLDevices":{ + "name":"DescribeVTLDevices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeVTLDevicesInput"}, + "output":{"shape":"DescribeVTLDevicesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a description of virtual tape library (VTL) devices for the specified tape gateway. In the response, AWS Storage Gateway returns VTL device information.

    This operation is only supported in the tape gateway type.

    " + }, + "DescribeWorkingStorage":{ + "name":"DescribeWorkingStorage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkingStorageInput"}, + "output":{"shape":"DescribeWorkingStorageOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns information about the working storage of a gateway. This operation is only supported in the stored volumes gateway type. This operation is deprecated in cached volumes API version (20120630). Use DescribeUploadBuffer instead.

    Working storage is also referred to as upload buffer. You can also use the DescribeUploadBuffer operation to add upload buffer to a stored volume gateway.

    The response includes disk IDs that are configured as working storage, and it includes the amount of working storage allocated and used.

    " + }, + "DetachVolume":{ + "name":"DetachVolume", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetachVolumeInput"}, + "output":{"shape":"DetachVolumeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Disconnects a volume from an iSCSI connection and then detaches the volume from the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

    " + }, + "DisableGateway":{ + "name":"DisableGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisableGatewayInput"}, + "output":{"shape":"DisableGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Disables a tape gateway when the gateway is no longer functioning. For example, if your gateway VM is damaged, you can disable the gateway so you can recover virtual tapes.

    Use this operation for a tape gateway that is not reachable or not functioning. This operation is only supported in the tape gateway type.

    Once a gateway is disabled it cannot be enabled.

    " + }, + "JoinDomain":{ + "name":"JoinDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"JoinDomainInput"}, + "output":{"shape":"JoinDomainOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Adds a file gateway to an Active Directory domain. This operation is only supported for file gateways that support the SMB file protocol.

    " + }, + "ListFileShares":{ + "name":"ListFileShares", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFileSharesInput"}, + "output":{"shape":"ListFileSharesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Gets a list of the file shares for a specific file gateway, or the list of file shares that belong to the calling user account. This operation is only supported for file gateways.

    " + }, + "ListGateways":{ + "name":"ListGateways", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGatewaysInput"}, + "output":{"shape":"ListGatewaysOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists gateways owned by an AWS account in an AWS Region specified in the request. The returned list is ordered by gateway Amazon Resource Name (ARN).

    By default, the operation returns a maximum of 100 gateways. This operation supports pagination that allows you to optionally reduce the number of gateways returned in a response.

    If you have more gateways than are returned in a response (that is, the response returns only a truncated list of your gateways), the response contains a marker that you can specify in your next request to fetch the next page of gateways.

    " + }, + "ListLocalDisks":{ + "name":"ListLocalDisks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLocalDisksInput"}, + "output":{"shape":"ListLocalDisksOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns a list of the gateway's local disks. To specify which gateway to describe, you use the Amazon Resource Name (ARN) of the gateway in the body of the request.

    The request returns a list of all disks, specifying which are configured as working storage, cache storage, or stored volume or not configured at all. The response includes a DiskStatus field. This field can have a value of present (the disk is available to use), missing (the disk is no longer connected to the gateway), or mismatch (the disk node is occupied by a disk that has incorrect metadata or the disk content is corrupted).

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the tags that have been added to the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway type.

    " + }, + "ListTapes":{ + "name":"ListTapes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTapesInput"}, + "output":{"shape":"ListTapesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists virtual tapes in your virtual tape library (VTL) and your virtual tape shelf (VTS). You specify the tapes to list by specifying one or more tape Amazon Resource Names (ARNs). If you don't specify a tape ARN, the operation lists all virtual tapes in both your VTL and VTS.

    This operation supports pagination. By default, the operation returns a maximum of up to 100 tapes. You can optionally specify the Limit parameter in the body to limit the number of tapes in the response. If the number of tapes returned in the response is truncated, the response includes a Marker element that you can use in your subsequent request to retrieve the next set of tapes. This operation is only supported in the tape gateway type.

    " + }, + "ListVolumeInitiators":{ + "name":"ListVolumeInitiators", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumeInitiatorsInput"}, + "output":{"shape":"ListVolumeInitiatorsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists iSCSI initiators that are connected to a volume. You can use this operation to determine whether a volume is being used or not. This operation is only supported in the cached volume and stored volume gateway types.

    " + }, + "ListVolumeRecoveryPoints":{ + "name":"ListVolumeRecoveryPoints", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumeRecoveryPointsInput"}, + "output":{"shape":"ListVolumeRecoveryPointsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the recovery points for a specified gateway. This operation is only supported in the cached volume gateway type.

    Each cache volume has one recovery point. A volume recovery point is a point in time at which all data of the volume is consistent and from which you can create a snapshot or clone a new cached volume from a source volume. To create a snapshot from a volume recovery point use the CreateSnapshotFromVolumeRecoveryPoint operation.

    " + }, + "ListVolumes":{ + "name":"ListVolumes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVolumesInput"}, + "output":{"shape":"ListVolumesOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Lists the iSCSI stored volumes of a gateway. Results are sorted by volume ARN. The response includes only the volume ARNs. If you want additional volume information, use the DescribeStorediSCSIVolumes or the DescribeCachediSCSIVolumes API.

    The operation supports pagination. By default, the operation returns a maximum of up to 100 volumes. You can optionally specify the Limit field in the body to limit the number of volumes in the response. If the number of volumes returned in the response is truncated, the response includes a Marker field. You can use this Marker value in your subsequent request to retrieve the next set of volumes. This operation is only supported in the cached volume and stored volume gateway types.

    " + }, + "NotifyWhenUploaded":{ + "name":"NotifyWhenUploaded", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"NotifyWhenUploadedInput"}, + "output":{"shape":"NotifyWhenUploadedOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Sends you notification through CloudWatch Events when all files written to your file share have been uploaded to Amazon S3.

    AWS Storage Gateway can send a notification through Amazon CloudWatch Events when all files written to your file share up to that point in time have been uploaded to Amazon S3. These files include files written to the file share up to the time that you make a request for notification. When the upload is done, Storage Gateway sends you notification through an Amazon CloudWatch Event. You can configure CloudWatch Events to send the notification through event targets such as Amazon SNS or AWS Lambda function. This operation is only supported for file gateways.

    For more information, see Getting File Upload Notification in the Storage Gateway User Guide (https://docs.aws.amazon.com/storagegateway/latest/userguide/monitoring-file-gateway.html#get-upload-notification).

    " + }, + "RefreshCache":{ + "name":"RefreshCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RefreshCacheInput"}, + "output":{"shape":"RefreshCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting Notified About File Operations.

    When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

    " + }, + "RemoveTagsFromResource":{ + "name":"RemoveTagsFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RemoveTagsFromResourceInput"}, + "output":{"shape":"RemoveTagsFromResourceOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Removes one or more tags from the specified resource. This operation is only supported in the cached volume, stored volume and tape gateway types.

    " + }, + "ResetCache":{ + "name":"ResetCache", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetCacheInput"}, + "output":{"shape":"ResetCacheOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Resets all cache disks that have encountered a error and makes the disks available for reconfiguration as cache storage. If your cache disk encounters a error, the gateway prevents read and write operations on virtual tapes in the gateway. For example, an error can occur when a disk is corrupted or removed from the gateway. When a cache is reset, the gateway loses its cache storage. At this point you can reconfigure the disks as cache disks. This operation is only supported in the cached volume and tape types.

    If the cache disk you are resetting contains data that has not been uploaded to Amazon S3 yet, that data can be lost. After you reset cache disks, there will be no configured cache disks left in the gateway, so you must configure at least one new cache disk for your gateway to function properly.

    " + }, + "RetrieveTapeArchive":{ + "name":"RetrieveTapeArchive", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveTapeArchiveInput"}, + "output":{"shape":"RetrieveTapeArchiveOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves an archived virtual tape from the virtual tape shelf (VTS) to a tape gateway. Virtual tapes archived in the VTS are not associated with any gateway. However after a tape is retrieved, it is associated with a gateway, even though it is also listed in the VTS, that is, archive. This operation is only supported in the tape gateway type.

    Once a tape is successfully retrieved to a gateway, it cannot be retrieved again to another gateway. You must archive the tape again before you can retrieve it to another gateway. This operation is only supported in the tape gateway type.

    " + }, + "RetrieveTapeRecoveryPoint":{ + "name":"RetrieveTapeRecoveryPoint", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RetrieveTapeRecoveryPointInput"}, + "output":{"shape":"RetrieveTapeRecoveryPointOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Retrieves the recovery point for the specified virtual tape. This operation is only supported in the tape gateway type.

    A recovery point is a point in time view of a virtual tape at which all the data on the tape is consistent. If your gateway crashes, virtual tapes that have recovery points can be recovered to a new gateway.

    The virtual tape can be retrieved to only one gateway. The retrieved tape is read-only. The virtual tape can be retrieved to only a tape gateway. There is no charge for retrieving recovery points.

    " + }, + "SetLocalConsolePassword":{ + "name":"SetLocalConsolePassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetLocalConsolePasswordInput"}, + "output":{"shape":"SetLocalConsolePasswordOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Sets the password for your VM local console. When you log in to the local console for the first time, you log in to the VM with the default credentials. We recommend that you set a new password. You don't need to know the default password to set a new password.

    " + }, + "SetSMBGuestPassword":{ + "name":"SetSMBGuestPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SetSMBGuestPasswordInput"}, + "output":{"shape":"SetSMBGuestPasswordOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Sets the password for the guest user smbguest. The smbguest user is the user when the authentication method for the file share is set to GuestAccess.

    " + }, + "ShutdownGateway":{ + "name":"ShutdownGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ShutdownGatewayInput"}, + "output":{"shape":"ShutdownGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Shuts down a gateway. To specify which gateway to shut down, use the Amazon Resource Name (ARN) of the gateway in the body of your request.

    The operation shuts down the gateway service component running in the gateway's virtual machine (VM) and not the host VM.

    If you want to shut down the VM, it is recommended that you first shut down the gateway component in the VM to avoid unpredictable conditions.

    After the gateway is shutdown, you cannot call any other API except StartGateway, DescribeGatewayInformation, and ListGateways. For more information, see ActivateGateway. Your applications cannot read from or write to the gateway's storage volumes, and there are no snapshots taken.

    When you make a shutdown request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to shut down. You can call the DescribeGatewayInformation API to check the status. For more information, see ActivateGateway.

    If do not intend to use the gateway again, you must delete the gateway (using DeleteGateway) to no longer pay software charges associated with the gateway.

    " + }, + "StartGateway":{ + "name":"StartGateway", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartGatewayInput"}, + "output":{"shape":"StartGatewayOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Starts a gateway that you previously shut down (see ShutdownGateway). After the gateway starts, you can then make other API calls, your applications can read from or write to the gateway's storage volumes and you will be able to take snapshot backups.

    When you make a request, you will get a 200 OK success response immediately. However, it might take some time for the gateway to be ready. You should call DescribeGatewayInformation and check the status before making any additional API calls. For more information, see ActivateGateway.

    To specify which gateway to start, use the Amazon Resource Name (ARN) of the gateway in your request.

    " + }, + "UpdateBandwidthRateLimit":{ + "name":"UpdateBandwidthRateLimit", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateBandwidthRateLimitInput"}, + "output":{"shape":"UpdateBandwidthRateLimitOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates the bandwidth rate limits of a gateway. You can update both the upload and download bandwidth rate limit or specify only one of the two. If you don't set a bandwidth rate limit, the existing rate limit remains.

    By default, a gateway's bandwidth rate limits are not set. If you don't set any limit, the gateway does not have any limitations on its bandwidth usage and could potentially use the maximum available bandwidth.

    To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

    " + }, + "UpdateChapCredentials":{ + "name":"UpdateChapCredentials", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateChapCredentialsInput"}, + "output":{"shape":"UpdateChapCredentialsOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates the Challenge-Handshake Authentication Protocol (CHAP) credentials for a specified iSCSI target. By default, a gateway does not have CHAP enabled; however, for added security, you might use it.

    When you update CHAP credentials, all existing connections on the target are closed and initiators must reconnect with the new credentials.

    " + }, + "UpdateGatewayInformation":{ + "name":"UpdateGatewayInformation", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewayInformationInput"}, + "output":{"shape":"UpdateGatewayInformationOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates a gateway's metadata, which includes the gateway's name and time zone. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

    For Gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

    " + }, + "UpdateGatewaySoftwareNow":{ + "name":"UpdateGatewaySoftwareNow", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGatewaySoftwareNowInput"}, + "output":{"shape":"UpdateGatewaySoftwareNowOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

    When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete. You can call DescribeGatewayInformation to verify the gateway is in the STATE_RUNNING state.

    A software update forces a system restart of your gateway. You can minimize the chance of any disruption to your applications by increasing your iSCSI Initiators' timeouts. For more information about increasing iSCSI Initiator timeouts for Windows and Linux, see Customizing Your Windows iSCSI Settings and Customizing Your Linux iSCSI Settings, respectively.

    " + }, + "UpdateMaintenanceStartTime":{ + "name":"UpdateMaintenanceStartTime", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMaintenanceStartTimeInput"}, + "output":{"shape":"UpdateMaintenanceStartTimeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates a gateway's weekly maintenance start time information, including day and time of the week. The maintenance time is the time in your gateway's time zone.

    " + }, + "UpdateNFSFileShare":{ + "name":"UpdateNFSFileShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateNFSFileShareInput"}, + "output":{"shape":"UpdateNFSFileShareOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates a Network File System (NFS) file share. This operation is only supported in the file gateway type.

    To leave a file share field unchanged, set the corresponding input field to null.

    Updates the following file share setting:

    • Default storage class for your S3 bucket

    • Metadata defaults for your S3 bucket

    • Allowed NFS clients for your file share

    • Squash settings

    • Write status of your file share

    To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported in file gateways.

    " + }, + "UpdateSMBFileShare":{ + "name":"UpdateSMBFileShare", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSMBFileShareInput"}, + "output":{"shape":"UpdateSMBFileShareOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates a Server Message Block (SMB) file share.

    To leave a file share field unchanged, set the corresponding input field to null. This operation is only supported for file gateways.

    File gateways require AWS Security Token Service (AWS STS) to be activated to enable you to create a file share. Make sure that AWS STS is activated in the AWS Region you are creating your file gateway in. If AWS STS is not activated in this AWS Region, activate it. For information about how to activate AWS STS, see Activating and Deactivating AWS STS in an AWS Region in the AWS Identity and Access Management User Guide.

    File gateways don't support creating hard or symbolic links on a file share.

    " + }, + "UpdateSMBSecurityStrategy":{ + "name":"UpdateSMBSecurityStrategy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSMBSecurityStrategyInput"}, + "output":{"shape":"UpdateSMBSecurityStrategyOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates the SMB security strategy on a file gateway. This action is only supported in file gateways.

    This API is called Security level in the User Guide.

    A higher security level can affect performance of the gateway.

    " + }, + "UpdateSnapshotSchedule":{ + "name":"UpdateSnapshotSchedule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSnapshotScheduleInput"}, + "output":{"shape":"UpdateSnapshotScheduleOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates a snapshot schedule configured for a gateway volume. This operation is only supported in the cached volume and stored volume gateway types.

    The default snapshot schedule for volume is once every 24 hours, starting at the creation time of the volume. You can use this API to change the snapshot schedule configured for the volume.

    In the request you must identify the gateway volume whose snapshot schedule you want to update, and the schedule information, including when you want the snapshot to begin on a day and the frequency (in hours) of snapshots.

    " + }, + "UpdateVTLDeviceType":{ + "name":"UpdateVTLDeviceType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVTLDeviceTypeInput"}, + "output":{"shape":"UpdateVTLDeviceTypeOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ], + "documentation":"

    Updates the type of medium changer in a tape gateway. When you activate a tape gateway, you select a medium changer type for the tape gateway. This operation enables you to select a different type of medium changer after a tape gateway is activated. This operation is only supported in the tape gateway type.

    " + } + }, + "shapes":{ + "ActivateGatewayInput":{ + "type":"structure", + "required":[ + "ActivationKey", + "GatewayName", + "GatewayTimezone", + "GatewayRegion" + ], + "members":{ + "ActivationKey":{ + "shape":"ActivationKey", + "documentation":"

    Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

    " + }, + "GatewayName":{ + "shape":"GatewayName", + "documentation":"

    The name you configured for your gateway.

    " + }, + "GatewayTimezone":{ + "shape":"GatewayTimezone", + "documentation":"

    A value that indicates the time zone you want to set for the gateway. The time zone is of the format \"GMT-hr:mm\" or \"GMT+hr:mm\". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

    " + }, + "GatewayRegion":{ + "shape":"RegionId", + "documentation":"

    A value that indicates the AWS Region where you want to store your data. The gateway AWS Region specified must be the same AWS Region as the AWS Region in your Host header in the request. For more information about available AWS Regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

    Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.

    " + }, + "GatewayType":{ + "shape":"GatewayType", + "documentation":"

    A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is CACHED.

    Valid Values: \"STORED\", \"CACHED\", \"VTL\", \"FILE_S3\"

    " + }, + "TapeDriveType":{ + "shape":"TapeDriveType", + "documentation":"

    The value that indicates the type of tape drive to use for tape gateway. This field is optional.

    Valid Values: \"IBM-ULT3580-TD5\"

    " + }, + "MediumChangerType":{ + "shape":"MediumChangerType", + "documentation":"

    The value that indicates the type of medium changer to use for tape gateway. This field is optional.

    Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "ActivateGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    AWS Storage Gateway returns the Amazon Resource Name (ARN) of the activated gateway. It is a string made of information such as your account, gateway name, and AWS Region. This ARN is used to reference the gateway in other API operations as well as resource-based authorization.

    For gateways activated prior to September 02, 2015, the gateway ARN contains the gateway name rather than the gateway ID. Changing the name of the gateway has no effect on the gateway ARN.

    " + }, + "ActivationKey":{ + "type":"string", + "max":50, + "min":1 + }, + "AddCacheInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    " + } + } + }, + "AddCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddTagsToResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    The key-value pair that represents the tag you want to add to the resource. The value can be an empty string.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    AddTagsToResourceInput

    " + }, + "AddTagsToResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the resource you want to add tags to.

    " + } + }, + "documentation":"

    AddTagsToResourceOutput

    " + }, + "AddUploadBufferInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    " + } + } + }, + "AddUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "AddWorkingStorageInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskIds" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "AddWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway for which working storage was configured.

    " + }, + "AssignTapePoolInput":{ + "type":"structure", + "required":[ + "TapeARN", + "PoolId" + ], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.

    " + }, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + } + } + }, + "AssignTapePoolOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.

    " + } + } + }, + "AttachVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "VolumeARN", + "NetworkInterfaceId" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway that you want to attach the volume to.

    " + }, + "TargetName":{ + "shape":"TargetName", + "documentation":"

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    " + }, + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume to attach to the specified gateway.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    " + }, + "DiskId":{ + "shape":"DiskId", + "documentation":"

    The unique device ID or other distinguishing data that identifies the local disk used to create the volume. This value is only required when you are attaching a stored volume.

    " + } + }, + "documentation":"

    AttachVolumeInput

    " + }, + "AttachVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume that was attached to the gateway.

    " + }, + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name for the initiator that was used to connect to the target.

    " + } + }, + "documentation":"

    AttachVolumeOutput

    " + }, + "Authentication":{ + "type":"string", + "documentation":"

    The authentication method of the file share.

    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

    ", + "max":15, + "min":5 + }, + "BandwidthDownloadRateLimit":{ + "type":"long", + "min":102400 + }, + "BandwidthType":{ + "type":"string", + "max":25, + "min":3 + }, + "BandwidthUploadRateLimit":{ + "type":"long", + "min":51200 + }, + "Boolean":{"type":"boolean"}, + "CachediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the storage volume.

    " + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

    The unique identifier of the volume, e.g. vol-AE4B946D.

    " + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

    One of the VolumeType enumeration values that describes the type of the volume.

    " + }, + "VolumeStatus":{ + "shape":"VolumeStatus", + "documentation":"

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + }, + "VolumeAttachmentStatus":{ + "shape":"VolumeAttachmentStatus", + "documentation":"

    A value that indicates whether a storage volume is attached to or detached from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

    " + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size, in bytes, of the volume capacity.

    " + }, + "VolumeProgress":{ + "shape":"DoubleObject", + "documentation":"

    Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the cached volume is not restoring or bootstrapping.

    " + }, + "SourceSnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    If the cached volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

    " + }, + "VolumeiSCSIAttributes":{ + "shape":"VolumeiSCSIAttributes", + "documentation":"

    An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

    " + }, + "CreatedDate":{ + "shape":"CreatedDate", + "documentation":"

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.

    " + }, + "VolumeUsedInBytes":{ + "shape":"VolumeUsedInBytes", + "documentation":"

    The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

    This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "TargetName":{ + "shape":"TargetName", + "documentation":"

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    " + } + }, + "documentation":"

    Describes an iSCSI cached volume.

    " + }, + "CachediSCSIVolumes":{ + "type":"list", + "member":{"shape":"CachediSCSIVolume"} + }, + "CancelArchivalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

    " + } + }, + "documentation":"

    CancelArchivalInput

    " + }, + "CancelArchivalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

    " + } + }, + "documentation":"

    CancelArchivalOutput

    " + }, + "CancelRetrievalInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

    " + } + }, + "documentation":"

    CancelRetrievalInput

    " + }, + "CancelRetrievalOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape for which retrieval was canceled.

    " + } + }, + "documentation":"

    CancelRetrievalOutput

    " + }, + "ChapCredentials":{ + "type":"list", + "member":{"shape":"ChapInfo"} + }, + "ChapInfo":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + }, + "SecretToAuthenticateInitiator":{ + "shape":"ChapSecret", + "documentation":"

    The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    " + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

    The iSCSI initiator that connects to the target.

    " + }, + "SecretToAuthenticateTarget":{ + "shape":"ChapSecret", + "documentation":"

    The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

    " + } + }, + "documentation":"

    Describes Challenge-Handshake Authentication Protocol (CHAP) information that supports authentication between your gateway and iSCSI initiators.

    " + }, + "ChapSecret":{ + "type":"string", + "max":100, + "min":1, + "sensitive":true + }, + "ClientToken":{ + "type":"string", + "max":100, + "min":5 + }, + "CloudWatchLogGroupARN":{ + "type":"string", + "max":562 + }, + "CreateCachediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "VolumeSizeInBytes", + "TargetName", + "NetworkInterfaceId", + "ClientToken" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size of the volume in bytes.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    " + }, + "TargetName":{ + "shape":"TargetName", + "documentation":"

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    " + }, + "SourceVolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume's latest recovery point. The VolumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers that you can represent in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

    " + } + } + }, + "CreateCachediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the configured volume.

    " + }, + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

    " + } + } + }, + "CreateNFSFileShareInput":{ + "type":"structure", + "required":[ + "ClientToken", + "GatewayARN", + "Role", + "LocationARN" + ], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

    " + }, + "NFSFileShareDefaults":{ + "shape":"NFSFileShareDefaults", + "documentation":"

    File share default values. Optional.

    " + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

    " + }, + "LocationARN":{ + "shape":"LocationARN", + "documentation":"

    The ARN of the backed storage used for storing file data.

    " + }, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{ + "shape":"ObjectACL", + "documentation":"

    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

    " + }, + "ClientList":{ + "shape":"FileShareClientList", + "documentation":"

    The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    " + }, + "Squash":{ + "shape":"Squash", + "documentation":"

    A value that maps a user to anonymous user. Valid options are the following:

    • RootSquash - Only root is mapped to anonymous user.

    • NoSquash - No one is mapped to anonymous user

    • AllSquash - Everyone is mapped to anonymous user.

    " + }, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    CreateNFSFileShareInput

    " + }, + "CreateNFSFileShareOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the newly created file share.

    " + } + }, + "documentation":"

    CreateNFSFileShareOutput

    " + }, + "CreateSMBFileShareInput":{ + "type":"structure", + "required":[ + "ClientToken", + "GatewayARN", + "Role", + "LocationARN" + ], + "members":{ + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    A unique string value that you supply that is used by file gateway to ensure idempotent file share creation.

    " + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file gateway on which you want to create a file share.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

    " + }, + "LocationARN":{ + "shape":"LocationARN", + "documentation":"

    The ARN of the backed storage used for storing file data.

    " + }, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{ + "shape":"ObjectACL", + "documentation":"

    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

    " + }, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + }, + "SMBACLEnabled":{ + "shape":"Boolean", + "documentation":"

    Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.

    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

    " + }, + "AdminUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.

    Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

    " + }, + "ValidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "InvalidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "Authentication":{ + "shape":"Authentication", + "documentation":"

    The authentication method that users use to access the file share.

    Valid values are ActiveDirectory or GuestAccess. The default is ActiveDirectory.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    CreateSMBFileShareInput

    " + }, + "CreateSMBFileShareOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the newly created file share.

    " + } + }, + "documentation":"

    CreateSMBFileShareOutput

    " + }, + "CreateSnapshotFromVolumeRecoveryPointInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    " + }, + "SnapshotDescription":{ + "shape":"SnapshotDescription", + "documentation":"

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + } + }, + "CreateSnapshotFromVolumeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The ID of the snapshot.

    " + }, + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    " + }, + "VolumeRecoveryPointTime":{ + "shape":"string", + "documentation":"

    The time the volume was created from the recovery point.

    " + } + } + }, + "CreateSnapshotInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "SnapshotDescription" + ], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    " + }, + "SnapshotDescription":{ + "shape":"SnapshotDescription", + "documentation":"

    Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "CreateSnapshotOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume of which the snapshot was taken.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The snapshot ID that is used to refer to the snapshot in future operations such as describing snapshots (Amazon Elastic Compute Cloud API DescribeSnapshots) or creating a volume from a snapshot (CreateStorediSCSIVolume).

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "CreateStorediSCSIVolumeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DiskId", + "PreserveExistingData", + "TargetName", + "NetworkInterfaceId" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskId":{ + "shape":"DiskId", + "documentation":"

    The unique identifier for the gateway local disk that is configured as a stored volume. Use ListLocalDisks to list disk IDs for a gateway.

    " + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored volume. Specify this field if you want to create the iSCSI storage volume from a snapshot otherwise do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API Reference.

    " + }, + "PreserveExistingData":{ + "shape":"boolean", + "documentation":"

    Specify this field as true if you want to preserve the data on the local disk. Otherwise, specifying this field as false creates an empty volume.

    Valid Values: true, false

    " + }, + "TargetName":{ + "shape":"TargetName", + "documentation":"

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. Use DescribeGatewayInformation to get a list of the network interfaces available on a gateway.

    Valid Values: A valid IP address.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "CreateStorediSCSIVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the configured volume.

    " + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size of the volume in bytes.

    " + }, + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume target, which includes the iSCSI name that initiators can use to connect to the target.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "CreateTapeWithBarcodeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeSizeInBytes", + "TapeBarcode" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tape with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of the virtual tape that you want to create.

    The size must be aligned by gigabyte (1024*1024*1024 byte).

    " + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

    The barcode that you want to assign to the tape.

    Barcodes cannot be reused. This includes barcodes used for tapes that have been deleted.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS Key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    CreateTapeWithBarcodeInput

    " + }, + "CreateTapeWithBarcodeOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    A unique Amazon Resource Name (ARN) that represents the virtual tape that was created.

    " + } + }, + "documentation":"

    CreateTapeOutput

    " + }, + "CreateTapesInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeSizeInBytes", + "ClientToken", + "NumTapesToCreate", + "TapeBarcodePrefix" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The unique Amazon Resource Name (ARN) that represents the gateway to associate the virtual tapes with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of the virtual tapes that you want to create.

    The size must be aligned by gigabyte (1024*1024*1024 byte).

    " + }, + "ClientToken":{ + "shape":"ClientToken", + "documentation":"

    A unique identifier that you use to retry a request. If you retry a request, use the same ClientToken you specified in the initial request.

    Using the same ClientToken prevents creating the tape multiple times.

    " + }, + "NumTapesToCreate":{ + "shape":"NumTapesToCreate", + "documentation":"

    The number of virtual tapes that you want to create.

    " + }, + "TapeBarcodePrefix":{ + "shape":"TapeBarcodePrefix", + "documentation":"

    A prefix that you append to the barcode of the virtual tape you are creating. This prefix makes the barcode unique.

    The prefix must be 1 to 4 characters in length and must be one of the uppercase letters from A to Z.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    CreateTapesInput

    " + }, + "CreateTapesOutput":{ + "type":"structure", + "members":{ + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

    A list of unique Amazon Resource Names (ARNs) that represents the virtual tapes that were created.

    " + } + }, + "documentation":"

    CreateTapeOutput

    " + }, + "CreatedDate":{"type":"timestamp"}, + "DayOfMonth":{ + "type":"integer", + "max":28, + "min":1 + }, + "DayOfWeek":{ + "type":"integer", + "max":6, + "min":0 + }, + "DeleteBandwidthRateLimitInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "BandwidthType" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "BandwidthType":{ + "shape":"BandwidthType", + "documentation":"

    One of the BandwidthType values that indicates the gateway bandwidth rate limit to delete.

    Valid Values: Upload, Download, All.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DeleteBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway whose bandwidth rate information was deleted.

    " + }, + "DeleteChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "InitiatorName" + ], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    " + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

    The iSCSI initiator that connects to the target.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "DeleteChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the target.

    " + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

    The iSCSI initiator that connects to the target.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DeleteFileShareInput":{ + "type":"structure", + "required":["FileShareARN"], + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file share to be deleted.

    " + }, + "ForceDelete":{ + "shape":"boolean", + "documentation":"

    If this value is set to true, the operation deletes a file share immediately and aborts all data uploads to AWS. Otherwise, the file share is not deleted until all data is uploaded to AWS. This process aborts the data upload process, and the file share enters the FORCE_DELETING status.

    " + } + }, + "documentation":"

    DeleteFileShareInput

    " + }, + "DeleteFileShareOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the deleted file share.

    " + } + }, + "documentation":"

    DeleteFileShareOutput

    " + }, + "DeleteGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the ID of the gateway to delete.

    " + }, + "DeleteGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the ID of the deleted gateway.

    " + }, + "DeleteSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The volume which snapshot schedule to delete.

    " + } + } + }, + "DeleteSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The volume which snapshot schedule was deleted.

    " + } + } + }, + "DeleteTapeArchiveInput":{ + "type":"structure", + "required":["TapeARN"], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf (VTS).

    " + } + }, + "documentation":"

    DeleteTapeArchiveInput

    " + }, + "DeleteTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape that was deleted from the virtual tape shelf (VTS).

    " + } + }, + "documentation":"

    DeleteTapeArchiveOutput

    " + }, + "DeleteTapeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "TapeARN" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The unique Amazon Resource Name (ARN) of the gateway that the virtual tape to delete is associated with. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape to delete.

    " + } + }, + "documentation":"

    DeleteTapeInput

    " + }, + "DeleteTapeOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the deleted virtual tape.

    " + } + }, + "documentation":"

    DeleteTapeOutput

    " + }, + "DeleteVolumeInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    " + } + }, + "documentation":"

    A JSON object containing the DeleteVolumeInput$VolumeARN to delete.

    " + }, + "DeleteVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the storage volume that was deleted. It is the same ARN you provided in the request.

    " + } + }, + "documentation":"

    A JSON object containing the of the storage volume that was deleted

    " + }, + "DescribeBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway.

    " + }, + "DescribeBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{ + "shape":"BandwidthUploadRateLimit", + "documentation":"

    The average upload bandwidth rate limit in bits per second. This field does not appear in the response if the upload rate limit is not set.

    " + }, + "AverageDownloadRateLimitInBitsPerSec":{ + "shape":"BandwidthDownloadRateLimit", + "documentation":"

    The average download bandwidth rate limit in bits per second. This field does not appear in the response if the download rate limit is not set.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DescribeCacheInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of strings that identify disks that are to be configured as working storage. Each string have a minimum length of 1 and maximum length of 300. You can get the disk IDs from the ListLocalDisks API.

    " + }, + "CacheAllocatedInBytes":{ + "shape":"long", + "documentation":"

    The amount of cache in bytes allocated to the a gateway.

    " + }, + "CacheUsedPercentage":{ + "shape":"double", + "documentation":"

    Percent use of the gateway's cache storage. This metric applies only to the gateway-cached volume setup. The sample is taken at the end of the reporting period.

    " + }, + "CacheDirtyPercentage":{ + "shape":"double", + "documentation":"

    The file share's contribution to the overall percentage of the gateway's cache that has not been persisted to AWS. The sample is taken at the end of the reporting period.

    " + }, + "CacheHitPercentage":{ + "shape":"double", + "documentation":"

    Percent of application read operations from the file shares that are served from cache. The sample is taken at the end of the reporting period.

    " + }, + "CacheMissPercentage":{ + "shape":"double", + "documentation":"

    Percent of application read operations from the file shares that are not served from cache. The sample is taken at the end of the reporting period.

    " + } + } + }, + "DescribeCachediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{ + "shape":"VolumeARNs", + "documentation":"

    An array of strings where each string represents the Amazon Resource Name (ARN) of a cached volume. All of the specified cached volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

    " + } + } + }, + "DescribeCachediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "CachediSCSIVolumes":{ + "shape":"CachediSCSIVolumes", + "documentation":"

    An array of objects where each object contains metadata about one cached volume.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DescribeChapCredentialsInput":{ + "type":"structure", + "required":["TargetARN"], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for specified VolumeARN.

    " + } + }, + "documentation":"

    A JSON object containing the Amazon Resource Name (ARN) of the iSCSI volume target.

    " + }, + "DescribeChapCredentialsOutput":{ + "type":"structure", + "members":{ + "ChapCredentials":{ + "shape":"ChapCredentials", + "documentation":"

    An array of ChapInfo objects that represent CHAP credentials. Each object in the array contains CHAP credential information for one target-initiator pair. If no CHAP credentials are set, an empty array is returned. CHAP credential information is provided in a JSON object with the following fields:

    • InitiatorName: The iSCSI initiator that connects to the target.

    • SecretToAuthenticateInitiator: The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    • SecretToAuthenticateTarget: The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

    • TargetARN: The Amazon Resource Name (ARN) of the storage volume.

    " + } + }, + "documentation":"

    A JSON object containing a .

    " + }, + "DescribeGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the ID of the gateway.

    " + }, + "DescribeGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayId":{ + "shape":"GatewayId", + "documentation":"

    The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

    " + }, + "GatewayName":{ + "shape":"string", + "documentation":"

    The name you configured for your gateway.

    " + }, + "GatewayTimezone":{ + "shape":"GatewayTimezone", + "documentation":"

    A value that indicates the time zone configured for the gateway.

    " + }, + "GatewayState":{ + "shape":"GatewayState", + "documentation":"

    A value that indicates the operating state of the gateway.

    " + }, + "GatewayNetworkInterfaces":{ + "shape":"GatewayNetworkInterfaces", + "documentation":"

    A NetworkInterface array that contains descriptions of the gateway network interfaces.

    " + }, + "GatewayType":{ + "shape":"GatewayType", + "documentation":"

    The type of the gateway.

    " + }, + "NextUpdateAvailabilityDate":{ + "shape":"NextUpdateAvailabilityDate", + "documentation":"

    The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.

    " + }, + "LastSoftwareUpdate":{ + "shape":"LastSoftwareUpdate", + "documentation":"

    The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.

    " + }, + "Ec2InstanceId":{ + "shape":"Ec2InstanceId", + "documentation":"

    The ID of the Amazon EC2 instance that was used to launch the gateway.

    " + }, + "Ec2InstanceRegion":{ + "shape":"Ec2InstanceRegion", + "documentation":"

    The AWS Region where the Amazon EC2 instance is located.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

    " + }, + "VPCEndpoint":{ + "shape":"string", + "documentation":"

    The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

    " + }, + "CloudWatchLogGroupARN":{ + "shape":"CloudWatchLogGroupARN", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to monitor and log events in the gateway.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DescribeMaintenanceStartTimeInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway.

    " + }, + "DescribeMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{ + "shape":"HourOfDay", + "documentation":"

    The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    " + }, + "MinuteOfHour":{ + "shape":"MinuteOfHour", + "documentation":"

    The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

    " + }, + "DayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

    An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

    " + }, + "DayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

    The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

    This value is only available for tape and volume gateways.

    " + }, + "Timezone":{ + "shape":"GatewayTimezone", + "documentation":"

    A value that indicates the time zone that is set for the gateway. The start time and day of week specified should be in the time zone of the gateway.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "DescribeNFSFileSharesInput":{ + "type":"structure", + "required":["FileShareARNList"], + "members":{ + "FileShareARNList":{ + "shape":"FileShareARNList", + "documentation":"

    An array containing the Amazon Resource Name (ARN) of each file share to be described.

    " + } + }, + "documentation":"

    DescribeNFSFileSharesInput

    " + }, + "DescribeNFSFileSharesOutput":{ + "type":"structure", + "members":{ + "NFSFileShareInfoList":{ + "shape":"NFSFileShareInfoList", + "documentation":"

    An array containing a description for each requested file share.

    " + } + }, + "documentation":"

    DescribeNFSFileSharesOutput

    " + }, + "DescribeSMBFileSharesInput":{ + "type":"structure", + "required":["FileShareARNList"], + "members":{ + "FileShareARNList":{ + "shape":"FileShareARNList", + "documentation":"

    An array containing the Amazon Resource Name (ARN) of each file share to be described.

    " + } + }, + "documentation":"

    DescribeSMBFileSharesInput

    " + }, + "DescribeSMBFileSharesOutput":{ + "type":"structure", + "members":{ + "SMBFileShareInfoList":{ + "shape":"SMBFileShareInfoList", + "documentation":"

    An array containing a description for each requested file share.

    " + } + }, + "documentation":"

    DescribeSMBFileSharesOutput

    " + }, + "DescribeSMBSettingsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeSMBSettingsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that the gateway is joined to.

    " + }, + "SMBGuestPasswordSet":{ + "shape":"Boolean", + "documentation":"

    This value is true if a password for the guest user “smbguest” is set, and otherwise false.

    " + }, + "SMBSecurityStrategy":{ + "shape":"SMBSecurityStrategy", + "documentation":"

    The type of security strategy that was specified for file gateway.

    ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.

    MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

    MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

    " + } + } + }, + "DescribeSnapshotScheduleInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    " + } + }, + "documentation":"

    A JSON object containing the DescribeSnapshotScheduleInput$VolumeARN of the volume.

    " + }, + "DescribeSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume that was specified in the request.

    " + }, + "StartAt":{ + "shape":"HourOfDay", + "documentation":"

    The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    " + }, + "RecurrenceInHours":{ + "shape":"RecurrenceInHours", + "documentation":"

    The number of hours between snapshots.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The snapshot description.

    " + }, + "Timezone":{ + "shape":"GatewayTimezone", + "documentation":"

    A value that indicates the time zone of the gateway.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

    " + } + } + }, + "DescribeStorediSCSIVolumesInput":{ + "type":"structure", + "required":["VolumeARNs"], + "members":{ + "VolumeARNs":{ + "shape":"VolumeARNs", + "documentation":"

    An array of strings where each string represents the Amazon Resource Name (ARN) of a stored volume. All of the specified stored volumes must from the same gateway. Use ListVolumes to get volume ARNs for a gateway.

    " + } + }, + "documentation":"

    A JSON object containing a list of DescribeStorediSCSIVolumesInput$VolumeARNs.

    " + }, + "DescribeStorediSCSIVolumesOutput":{ + "type":"structure", + "members":{ + "StorediSCSIVolumes":{ + "shape":"StorediSCSIVolumes", + "documentation":"

    Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

    • ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

    • LunNumber: The logical disk number.

    • NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

    • NetworkInterfacePort: The port used to communicate with iSCSI targets.

    • PreservedExistingData: Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

    • SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

    • StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

    • TargetARN: The Amazon Resource Name (ARN) of the volume target.

    • VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

    • VolumeDiskId: The disk ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

    • VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

    • VolumeiSCSIAttributes: An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

    • VolumeProgress: Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

    • VolumeSizeInBytes: The size of the volume in bytes.

    • VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

    • VolumeType: One of the enumeration values describing the type of the volume. Currently, on STORED volumes are supported.

    " + } + } + }, + "DescribeTapeArchivesInput":{ + "type":"structure", + "members":{ + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to begin describing virtual tapes.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the number of virtual tapes descried be limited to the specified number.

    " + } + }, + "documentation":"

    DescribeTapeArchivesInput

    " + }, + "DescribeTapeArchivesOutput":{ + "type":"structure", + "members":{ + "TapeArchives":{ + "shape":"TapeArchives", + "documentation":"

    An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description and tape barcode.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

    " + } + }, + "documentation":"

    DescribeTapeArchivesOutput

    " + }, + "DescribeTapeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to begin describing the virtual tape recovery points.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the number of virtual tape recovery points that are described be limited to the specified number.

    " + } + }, + "documentation":"

    DescribeTapeRecoveryPointsInput

    " + }, + "DescribeTapeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeRecoveryPointInfos":{ + "shape":"TapeRecoveryPointInfos", + "documentation":"

    An array of TapeRecoveryPointInfos that are available for the specified gateway.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which the virtual tape recovery points that were listed for description ended.

    Use this marker in your next request to list the next set of virtual tape recovery points in the list. If there are no more recovery points to describe, this field does not appear in the response.

    " + } + }, + "documentation":"

    DescribeTapeRecoveryPointsOutput

    " + }, + "DescribeTapesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "TapeARNs":{ + "shape":"TapeARNs", + "documentation":"

    Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

    If not specified, the first page of results is retrieved.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the number of virtual tapes described be limited to the specified number.

    Amazon Web Services may impose its own limit, if this field is not set.

    " + } + }, + "documentation":"

    DescribeTapesInput

    " + }, + "DescribeTapesOutput":{ + "type":"structure", + "members":{ + "Tapes":{ + "shape":"Tapes", + "documentation":"

    An array of virtual tape descriptions.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string which can be used as part of a subsequent DescribeTapes call to retrieve the next page of results.

    If a response does not contain a marker, then there are no more results to be retrieved.

    " + } + }, + "documentation":"

    DescribeTapesOutput

    " + }, + "DescribeUploadBufferInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "DescribeUploadBufferOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

    " + }, + "UploadBufferUsedInBytes":{ + "shape":"long", + "documentation":"

    The total number of bytes being used in the gateway's upload buffer.

    " + }, + "UploadBufferAllocatedInBytes":{ + "shape":"long", + "documentation":"

    The total number of bytes allocated in the gateway's as upload buffer.

    " + } + } + }, + "DescribeVTLDevicesInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDeviceARNs":{ + "shape":"VTLDeviceARNs", + "documentation":"

    An array of strings, where each string represents the Amazon Resource Name (ARN) of a VTL device.

    All of the specified VTL devices must be from the same gateway. If no VTL devices are specified, the result will contain all devices on the specified gateway.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to begin describing the VTL devices.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the number of VTL devices described be limited to the specified number.

    " + } + }, + "documentation":"

    DescribeVTLDevicesInput

    " + }, + "DescribeVTLDevicesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VTLDevices":{ + "shape":"VTLDevices", + "documentation":"

    An array of VTL device objects composed of the Amazon Resource Name(ARN) of the VTL devices.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which the VTL devices that were fetched for description ended. Use the marker in your next request to fetch the next set of VTL devices in the list. If there are no more VTL devices to describe, this field does not appear in the response.

    " + } + }, + "documentation":"

    DescribeVTLDevicesOutput

    " + }, + "DescribeWorkingStorageInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway.

    " + }, + "DescribeWorkingStorageOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "DiskIds":{ + "shape":"DiskIds", + "documentation":"

    An array of the gateway's local disk IDs that are configured as working storage. Each local disk ID is specified as a string (minimum length of 1 and maximum length of 300). If no local disks are configured as working storage, then the DiskIds array is empty.

    " + }, + "WorkingStorageUsedInBytes":{ + "shape":"long", + "documentation":"

    The total working storage in bytes in use by the gateway. If no working storage is configured for the gateway, this field returns 0.

    " + }, + "WorkingStorageAllocatedInBytes":{ + "shape":"long", + "documentation":"

    The total working storage in bytes allocated for the gateway. If no working storage is configured for the gateway, this field returns 0.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "Description":{ + "type":"string", + "max":255, + "min":1 + }, + "DetachVolumeInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume to detach from the gateway.

    " + }, + "ForceDetach":{ + "shape":"Boolean", + "documentation":"

    Set to true to forcibly remove the iSCSI connection of the target volume and detach the volume. The default is false. If this value is set to false, you must manually disconnect the iSCSI connection from the target volume.

    " + } + }, + "documentation":"

    AttachVolumeInput

    " + }, + "DetachVolumeOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume that was detached.

    " + } + }, + "documentation":"

    AttachVolumeOutput

    " + }, + "DeviceType":{ + "type":"string", + "max":50, + "min":2 + }, + "DeviceiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified name(iqn) of a tape drive or media changer target.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface identifier of the VTL device.

    " + }, + "NetworkInterfacePort":{ + "shape":"integer", + "documentation":"

    The port used to communicate with iSCSI VTL device targets.

    " + }, + "ChapEnabled":{ + "shape":"boolean", + "documentation":"

    Indicates whether mutual CHAP is enabled for the iSCSI target.

    " + } + }, + "documentation":"

    Lists iSCSI information about a VTL device.

    " + }, + "DisableGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    DisableGatewayInput

    " + }, + "DisableGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The unique Amazon Resource Name (ARN) of the disabled gateway.

    " + } + }, + "documentation":"

    DisableGatewayOutput

    " + }, + "Disk":{ + "type":"structure", + "members":{ + "DiskId":{ + "shape":"DiskId", + "documentation":"

    The unique device ID or other distinguishing data that identifies a local disk.

    " + }, + "DiskPath":{ + "shape":"string", + "documentation":"

    The path of a local disk in the gateway virtual machine (VM).

    " + }, + "DiskNode":{ + "shape":"string", + "documentation":"

    The device node of a local disk as assigned by the virtualization environment.

    " + }, + "DiskStatus":{ + "shape":"string", + "documentation":"

    A value that represents the status of a local disk.

    " + }, + "DiskSizeInBytes":{ + "shape":"long", + "documentation":"

    The local disk size in bytes.

    " + }, + "DiskAllocationType":{"shape":"DiskAllocationType"}, + "DiskAllocationResource":{ + "shape":"string", + "documentation":"

    The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in the response if the local disk is not defined as an iSCSI target. The format of this field is targetIqn::LUNNumber::region-volumeId.

    " + }, + "DiskAttributeList":{"shape":"DiskAttributeList"} + }, + "documentation":"

    Represents a gateway's local disk.

    " + }, + "DiskAllocationType":{ + "type":"string", + "documentation":"

    One of the DiskAllocationType enumeration values that identifies how a local disk is used. Valid values: UPLOAD_BUFFER, CACHE_STORAGE

    ", + "max":100, + "min":3 + }, + "DiskAttribute":{ + "type":"string", + "max":64, + "min":1 + }, + "DiskAttributeList":{ + "type":"list", + "member":{"shape":"DiskAttribute"}, + "documentation":"

    A list of values that represents attributes of a local disk.

    ", + "max":10, + "min":0 + }, + "DiskId":{ + "type":"string", + "max":300, + "min":1 + }, + "DiskIds":{ + "type":"list", + "member":{"shape":"DiskId"} + }, + "Disks":{ + "type":"list", + "member":{"shape":"Disk"} + }, + "DomainName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,}$" + }, + "DomainUserName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^\\w[\\w\\.\\- ]*$" + }, + "DomainUserPassword":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^[ -~]+$", + "sensitive":true + }, + "DoubleObject":{"type":"double"}, + "Ec2InstanceId":{"type":"string"}, + "Ec2InstanceRegion":{"type":"string"}, + "ErrorCode":{ + "type":"string", + "enum":[ + "ActivationKeyExpired", + "ActivationKeyInvalid", + "ActivationKeyNotFound", + "GatewayInternalError", + "GatewayNotConnected", + "GatewayNotFound", + "GatewayProxyNetworkConnectionBusy", + "AuthenticationFailure", + "BandwidthThrottleScheduleNotFound", + "Blocked", + "CannotExportSnapshot", + "ChapCredentialNotFound", + "DiskAlreadyAllocated", + "DiskDoesNotExist", + "DiskSizeGreaterThanVolumeMaxSize", + "DiskSizeLessThanVolumeSize", + "DiskSizeNotGigAligned", + "DuplicateCertificateInfo", + "DuplicateSchedule", + "EndpointNotFound", + "IAMNotSupported", + "InitiatorInvalid", + "InitiatorNotFound", + "InternalError", + "InvalidGateway", + "InvalidEndpoint", + "InvalidParameters", + "InvalidSchedule", + "LocalStorageLimitExceeded", + "LunAlreadyAllocated ", + "LunInvalid", + "MaximumContentLengthExceeded", + "MaximumTapeCartridgeCountExceeded", + "MaximumVolumeCountExceeded", + "NetworkConfigurationChanged", + "NoDisksAvailable", + "NotImplemented", + "NotSupported", + "OperationAborted", + "OutdatedGateway", + "ParametersNotImplemented", + "RegionInvalid", + "RequestTimeout", + "ServiceUnavailable", + "SnapshotDeleted", + "SnapshotIdInvalid", + "SnapshotInProgress", + "SnapshotNotFound", + "SnapshotScheduleNotFound", + "StagingAreaFull", + "StorageFailure", + "TapeCartridgeNotFound", + "TargetAlreadyExists", + "TargetInvalid", + "TargetNotFound", + "UnauthorizedOperation", + "VolumeAlreadyExists", + "VolumeIdInvalid", + "VolumeInUse", + "VolumeNotFound", + "VolumeNotReady" + ] + }, + "FileShareARN":{ + "type":"string", + "documentation":"

    The Amazon Resource Name (ARN) of the file share.

    ", + "max":500, + "min":50 + }, + "FileShareARNList":{ + "type":"list", + "member":{"shape":"FileShareARN"}, + "max":10, + "min":1 + }, + "FileShareClientList":{ + "type":"list", + "member":{"shape":"IPV4AddressCIDR"}, + "documentation":"

    The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    ", + "max":100, + "min":1 + }, + "FileShareId":{ + "type":"string", + "documentation":"

    The ID of the file share.

    ", + "max":30, + "min":12 + }, + "FileShareInfo":{ + "type":"structure", + "members":{ + "FileShareType":{"shape":"FileShareType"}, + "FileShareARN":{"shape":"FileShareARN"}, + "FileShareId":{"shape":"FileShareId"}, + "FileShareStatus":{"shape":"FileShareStatus"}, + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    Describes a file share.

    " + }, + "FileShareInfoList":{ + "type":"list", + "member":{"shape":"FileShareInfo"} + }, + "FileShareStatus":{ + "type":"string", + "documentation":"

    The status of the file share. Possible values are CREATING, UPDATING, AVAILABLE and DELETING.

    ", + "max":50, + "min":3 + }, + "FileShareType":{ + "type":"string", + "documentation":"

    The type of the file share.

    ", + "enum":[ + "NFS", + "SMB" + ] + }, + "FileShareUser":{ + "type":"string", + "max":64, + "min":1 + }, + "FileShareUserList":{ + "type":"list", + "member":{"shape":"FileShareUser"}, + "max":100, + "min":0 + }, + "Folder":{ + "type":"string", + "max":1024, + "min":1 + }, + "FolderList":{ + "type":"list", + "member":{"shape":"Folder"}, + "max":50, + "min":1 + }, + "GatewayARN":{ + "type":"string", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    ", + "max":500, + "min":50 + }, + "GatewayId":{ + "type":"string", + "max":30, + "min":12 + }, + "GatewayInfo":{ + "type":"structure", + "members":{ + "GatewayId":{ + "shape":"GatewayId", + "documentation":"

    The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

    " + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "GatewayType":{ + "shape":"GatewayType", + "documentation":"

    The type of the gateway.

    " + }, + "GatewayOperationalState":{ + "shape":"GatewayOperationalState", + "documentation":"

    The state of the gateway.

    Valid Values: DISABLED or ACTIVE

    " + }, + "GatewayName":{ + "shape":"string", + "documentation":"

    The name of the gateway.

    " + }, + "Ec2InstanceId":{ + "shape":"Ec2InstanceId", + "documentation":"

    The ID of the Amazon EC2 instance that was used to launch the gateway.

    " + }, + "Ec2InstanceRegion":{ + "shape":"Ec2InstanceRegion", + "documentation":"

    The AWS Region where the Amazon EC2 instance is located.

    " + } + }, + "documentation":"

    Describes a gateway object.

    " + }, + "GatewayName":{ + "type":"string", + "documentation":"

    The name you configured for your gateway.

    ", + "max":255, + "min":2, + "pattern":"^[ -\\.0-\\[\\]-~]*[!-\\.0-\\[\\]-~][ -\\.0-\\[\\]-~]*$" + }, + "GatewayNetworkInterfaces":{ + "type":"list", + "member":{"shape":"NetworkInterface"} + }, + "GatewayOperationalState":{ + "type":"string", + "max":25, + "min":2 + }, + "GatewayState":{ + "type":"string", + "max":25, + "min":2 + }, + "GatewayTimezone":{ + "type":"string", + "max":10, + "min":3 + }, + "GatewayType":{ + "type":"string", + "max":20, + "min":2 + }, + "Gateways":{ + "type":"list", + "member":{"shape":"GatewayInfo"} + }, + "Host":{ + "type":"string", + "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(:(\\d+))?$" + }, + "Hosts":{ + "type":"list", + "member":{"shape":"Host"} + }, + "HourOfDay":{ + "type":"integer", + "max":23, + "min":0 + }, + "IPV4AddressCIDR":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/([0-9]|[1-2][0-9]|3[0-2]))?$" + }, + "Initiator":{ + "type":"string", + "max":50, + "min":1 + }, + "Initiators":{ + "type":"list", + "member":{"shape":"Initiator"} + }, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    A human-readable message describing the error that occurred.

    " + }, + "error":{ + "shape":"StorageGatewayError", + "documentation":"

    A StorageGatewayError that provides more information about the cause of the error.

    " + } + }, + "documentation":"

    An internal server error has occurred during the request. For more information, see the error and message fields.

    ", + "exception":true + }, + "InvalidGatewayRequestException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    A human-readable message describing the error that occurred.

    " + }, + "error":{ + "shape":"StorageGatewayError", + "documentation":"

    A StorageGatewayError that provides more detail about the cause of the error.

    " + } + }, + "documentation":"

    An exception occurred because an invalid gateway request was issued to the service. For more information, see the error and message fields.

    ", + "exception":true + }, + "IqnName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[0-9a-z:.-]+" + }, + "JoinDomainInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "DomainName", + "UserName", + "Password" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that you want the gateway to join.

    " + }, + "OrganizationalUnit":{ + "shape":"OrganizationalUnit", + "documentation":"

    The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain.

    " + }, + "DomainControllers":{ + "shape":"Hosts", + "documentation":"

    List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (“:”). For example, mydc.mydomain.com:389.

    " + }, + "UserName":{ + "shape":"DomainUserName", + "documentation":"

    Sets the user name of user who has permission to add the gateway to the Active Directory domain.

    " + }, + "Password":{ + "shape":"DomainUserPassword", + "documentation":"

    Sets the password of the user who has permission to add the gateway to the Active Directory domain.

    " + } + }, + "documentation":"

    JoinDomainInput

    " + }, + "JoinDomainOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The unique Amazon Resource Name (ARN) of the gateway that joined the domain.

    " + } + }, + "documentation":"

    JoinDomainOutput

    " + }, + "KMSKey":{ + "type":"string", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    ", + "max":2048, + "min":7 + }, + "LastSoftwareUpdate":{ + "type":"string", + "max":25, + "min":1 + }, + "ListFileSharesInput":{ + "type":"structure", + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon resource Name (ARN) of the gateway whose file shares you want to list. If this field is not present, all file shares under your account are listed.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    The maximum number of file shares to return in the response. The value must be an integer with a value greater than zero. Optional.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    Opaque pagination token returned from a previous ListFileShares operation. If present, Marker specifies where to continue the list from after a previous call to ListFileShares. Optional.

    " + } + }, + "documentation":"

    ListFileShareInput

    " + }, + "ListFileSharesOutput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

    If the request includes Marker, the response returns that value in this field.

    " + }, + "NextMarker":{ + "shape":"Marker", + "documentation":"

    If a value is present, there are more file shares to return. In a subsequent request, use NextMarker as the value for Marker to retrieve the next set of file shares.

    " + }, + "FileShareInfoList":{ + "shape":"FileShareInfoList", + "documentation":"

    An array of information about the file gateway's file shares.

    " + } + }, + "documentation":"

    ListFileShareOutput

    " + }, + "ListGatewaysInput":{ + "type":"structure", + "members":{ + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to begin the returned list of gateways.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the list of gateways returned be limited to the specified number of items.

    " + } + }, + "documentation":"

    A JSON object containing zero or more of the following fields:

    " + }, + "ListGatewaysOutput":{ + "type":"structure", + "members":{ + "Gateways":{ + "shape":"Gateways", + "documentation":"

    An array of GatewayInfo objects.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    Use the marker in your next request to fetch the next set of gateways in the list. If there are no more gateways to list, this field does not appear in the response.

    " + } + } + }, + "ListLocalDisksInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway.

    " + }, + "ListLocalDisksOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Disks":{ + "shape":"Disks", + "documentation":"

    A JSON object containing the following fields:

    " + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the resource for which you want to list tags.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to begin returning the list of tags.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the list of tags returned be limited to the specified number of items.

    " + } + }, + "documentation":"

    ListTagsForResourceInput

    " + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    he Amazon Resource Name (ARN) of the resource for which you want to list tags.

    " + }, + "Marker":{ + "shape":"Marker", + "documentation":"

    An opaque string that indicates the position at which to stop returning the list of tags.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    An array that contains the tags for the specified resource.

    " + } + }, + "documentation":"

    ListTagsForResourceOutput

    " + }, + "ListTapesInput":{ + "type":"structure", + "members":{ + "TapeARNs":{"shape":"TapeARNs"}, + "Marker":{ + "shape":"Marker", + "documentation":"

    A string that indicates the position at which to begin the returned list of tapes.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    An optional number limit for the tapes in the list returned by this call.

    " + } + }, + "documentation":"

    A JSON object that contains one or more of the following fields:

    " + }, + "ListTapesOutput":{ + "type":"structure", + "members":{ + "TapeInfos":{"shape":"TapeInfos"}, + "Marker":{ + "shape":"Marker", + "documentation":"

    A string that indicates the position at which to begin returning the next list of tapes. Use the marker in your next request to continue pagination of tapes. If there are no more tapes to list, this element does not appear in the response body.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "ListVolumeInitiatorsInput":{ + "type":"structure", + "required":["VolumeARN"], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes for the gateway.

    " + } + }, + "documentation":"

    ListVolumeInitiatorsInput

    " + }, + "ListVolumeInitiatorsOutput":{ + "type":"structure", + "members":{ + "Initiators":{ + "shape":"Initiators", + "documentation":"

    The host names and port numbers of all iSCSI initiators that are connected to the gateway.

    " + } + }, + "documentation":"

    ListVolumeInitiatorsOutput

    " + }, + "ListVolumeRecoveryPointsInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ListVolumeRecoveryPointsOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "VolumeRecoveryPointInfos":{ + "shape":"VolumeRecoveryPointInfos", + "documentation":"

    An array of VolumeRecoveryPointInfo objects.

    " + } + } + }, + "ListVolumesInput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{ + "shape":"Marker", + "documentation":"

    A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

    " + }, + "Limit":{ + "shape":"PositiveIntObject", + "documentation":"

    Specifies that the list of volumes returned be limited to the specified number of items.

    " + } + }, + "documentation":"

    A JSON object that contains one or more of the following fields:

    " + }, + "ListVolumesOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "Marker":{ + "shape":"Marker", + "documentation":"

    Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

    " + }, + "VolumeInfos":{ + "shape":"VolumeInfos", + "documentation":"

    An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array \"[]\".

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "LocalConsolePassword":{ + "type":"string", + "max":512, + "min":6, + "pattern":"^[ -~]+$", + "sensitive":true + }, + "LocationARN":{ + "type":"string", + "documentation":"

    The ARN of the backend storage used for storing file data.

    ", + "max":310, + "min":16 + }, + "Marker":{ + "type":"string", + "max":1000, + "min":1 + }, + "MediumChangerType":{ + "type":"string", + "max":50, + "min":2 + }, + "MinuteOfHour":{ + "type":"integer", + "max":59, + "min":0 + }, + "NFSFileShareDefaults":{ + "type":"structure", + "members":{ + "FileMode":{ + "shape":"PermissionMode", + "documentation":"

    The Unix file mode in the form \"nnnn\". For example, \"0666\" represents the default file mode inside the file share. The default value is 0666.

    " + }, + "DirectoryMode":{ + "shape":"PermissionMode", + "documentation":"

    The Unix directory mode in the form \"nnnn\". For example, \"0666\" represents the default access mode for all directories inside the file share. The default value is 0777.

    " + }, + "GroupId":{ + "shape":"PermissionId", + "documentation":"

    The default group ID for the file share (unless the files have another group ID specified). The default value is nfsnobody.

    " + }, + "OwnerId":{ + "shape":"PermissionId", + "documentation":"

    The default owner ID for files in the file share (unless the files have another owner ID specified). The default value is nfsnobody.

    " + } + }, + "documentation":"

    Describes Network File System (NFS) file share default values. Files and folders stored as Amazon S3 objects in S3 buckets don't, by default, have Unix file permissions assigned to them. Upon discovery in an S3 bucket by Storage Gateway, the S3 objects that represent files and folders are assigned these default Unix permissions. This operation is only supported for file gateways.

    " + }, + "NFSFileShareInfo":{ + "type":"structure", + "members":{ + "NFSFileShareDefaults":{"shape":"NFSFileShareDefaults"}, + "FileShareARN":{"shape":"FileShareARN"}, + "FileShareId":{"shape":"FileShareId"}, + "FileShareStatus":{"shape":"FileShareStatus"}, + "GatewayARN":{"shape":"GatewayARN"}, + "KMSEncrypted":{ + "shape":"boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "Path":{"shape":"Path"}, + "Role":{"shape":"Role"}, + "LocationARN":{"shape":"LocationARN"}, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{"shape":"ObjectACL"}, + "ClientList":{"shape":"FileShareClientList"}, + "Squash":{"shape":"Squash"}, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

    " + } + }, + "documentation":"

    The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.

    " + }, + "NFSFileShareInfoList":{ + "type":"list", + "member":{"shape":"NFSFileShareInfo"} + }, + "NetworkInterface":{ + "type":"structure", + "members":{ + "Ipv4Address":{ + "shape":"string", + "documentation":"

    The Internet Protocol version 4 (IPv4) address of the interface.

    " + }, + "MacAddress":{ + "shape":"string", + "documentation":"

    The Media Access Control (MAC) address of the interface.

    This is currently unsupported and will not be returned in output.

    " + }, + "Ipv6Address":{ + "shape":"string", + "documentation":"

    The Internet Protocol version 6 (IPv6) address of the interface. Currently not supported.

    " + } + }, + "documentation":"

    Describes a gateway's network interface.

    " + }, + "NetworkInterfaceId":{ + "type":"string", + "pattern":"\\A(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(\\.(25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}\\z" + }, + "NextUpdateAvailabilityDate":{ + "type":"string", + "max":25, + "min":1 + }, + "NotificationId":{ + "type":"string", + "documentation":"

    The randomly generated ID of the notification that was sent. This ID is in UUID format.

    ", + "max":2048, + "min":1 + }, + "NotifyWhenUploadedInput":{ + "type":"structure", + "required":["FileShareARN"], + "members":{ + "FileShareARN":{"shape":"FileShareARN"} + } + }, + "NotifyWhenUploadedOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{"shape":"FileShareARN"}, + "NotificationId":{"shape":"NotificationId"} + } + }, + "NumTapesToCreate":{ + "type":"integer", + "max":10, + "min":1 + }, + "ObjectACL":{ + "type":"string", + "documentation":"

    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

    ", + "enum":[ + "private", + "public-read", + "public-read-write", + "authenticated-read", + "bucket-owner-read", + "bucket-owner-full-control", + "aws-exec-read" + ] + }, + "OrganizationalUnit":{ + "type":"string", + "max":1024, + "min":1 + }, + "Path":{ + "type":"string", + "documentation":"

    The file share path used by the NFS client to identify the mount point.

    " + }, + "PermissionId":{ + "type":"long", + "max":4294967294, + "min":0 + }, + "PermissionMode":{ + "type":"string", + "max":4, + "min":1, + "pattern":"^[0-7]{4}$" + }, + "PoolId":{ + "type":"string", + "max":100, + "min":1 + }, + "PositiveIntObject":{ + "type":"integer", + "min":1 + }, + "RecurrenceInHours":{ + "type":"integer", + "max":24, + "min":1 + }, + "RefreshCacheInput":{ + "type":"structure", + "required":["FileShareARN"], + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file share you want to refresh.

    " + }, + "FolderList":{ + "shape":"FolderList", + "documentation":"

    A comma-separated list of the paths of folders to refresh in the cache. The default is [\"/\"]. The default refreshes objects and folders at the root of the Amazon S3 bucket. If Recursive is set to \"true\", the entire S3 bucket that the file share has access to is refreshed.

    " + }, + "Recursive":{ + "shape":"Boolean", + "documentation":"

    A value that specifies whether to recursively refresh folders in the cache. The refresh includes folders that were in the cache the last time the gateway listed the folder's contents. If this value set to \"true\", each folder that is listed in FolderList is recursively updated. Otherwise, subfolders listed in FolderList are not refreshed. Only objects that are in folders listed directly under FolderList are found and used for the update. The default is \"true\".

    " + } + }, + "documentation":"

    RefreshCacheInput

    " + }, + "RefreshCacheOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{"shape":"FileShareARN"}, + "NotificationId":{"shape":"NotificationId"} + }, + "documentation":"

    RefreshCacheOutput

    " + }, + "RegionId":{ + "type":"string", + "max":25, + "min":1 + }, + "RemoveTagsFromResourceInput":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the resource you want to remove the tags from.

    " + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

    The keys of the tags you want to remove from the specified resource. A tag is composed of a key/value pair.

    " + } + }, + "documentation":"

    RemoveTagsFromResourceInput

    " + }, + "RemoveTagsFromResourceOutput":{ + "type":"structure", + "members":{ + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the resource that the tags were removed from.

    " + } + }, + "documentation":"

    RemoveTagsFromResourceOutput

    " + }, + "ResetCacheInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ResetCacheOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ResourceARN":{ + "type":"string", + "max":500, + "min":50 + }, + "RetrieveTapeArchiveInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape you want to retrieve from the virtual tape shelf (VTS).

    " + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway you want to retrieve the virtual tape to. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    You retrieve archived virtual tapes to only one gateway and the gateway must be a tape gateway.

    " + } + }, + "documentation":"

    RetrieveTapeArchiveInput

    " + }, + "RetrieveTapeArchiveOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the retrieved virtual tape.

    " + } + }, + "documentation":"

    RetrieveTapeArchiveOutput

    " + }, + "RetrieveTapeRecoveryPointInput":{ + "type":"structure", + "required":[ + "TapeARN", + "GatewayARN" + ], + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the recovery point.

    " + }, + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    RetrieveTapeRecoveryPointInput

    " + }, + "RetrieveTapeRecoveryPointOutput":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape for which the recovery point was retrieved.

    " + } + }, + "documentation":"

    RetrieveTapeRecoveryPointOutput

    " + }, + "Role":{ + "type":"string", + "documentation":"

    The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

    ", + "max":2048, + "min":20 + }, + "SMBFileShareInfo":{ + "type":"structure", + "members":{ + "FileShareARN":{"shape":"FileShareARN"}, + "FileShareId":{"shape":"FileShareId"}, + "FileShareStatus":{"shape":"FileShareStatus"}, + "GatewayARN":{"shape":"GatewayARN"}, + "KMSEncrypted":{ + "shape":"boolean", + "documentation":"

    True to use Amazon S3 server-side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "Path":{ + "shape":"Path", + "documentation":"

    The file share path used by the SMB client to identify the mount point.

    " + }, + "Role":{"shape":"Role"}, + "LocationARN":{"shape":"LocationARN"}, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{"shape":"ObjectACL"}, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + }, + "SMBACLEnabled":{ + "shape":"Boolean", + "documentation":"

    If this value is set to \"true\", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to \"false\", it indicates that file and directory permissions are mapped to the POSIX permission.

    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.

    " + }, + "AdminUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "ValidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "InvalidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "Authentication":{"shape":"Authentication"}, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

    " + } + }, + "documentation":"

    The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

    " + }, + "SMBFileShareInfoList":{ + "type":"list", + "member":{"shape":"SMBFileShareInfo"} + }, + "SMBGuestPassword":{ + "type":"string", + "max":512, + "min":6, + "pattern":"^[ -~]+$", + "sensitive":true + }, + "SMBSecurityStrategy":{ + "type":"string", + "enum":[ + "ClientSpecified", + "MandatorySigning", + "MandatoryEncryption" + ] + }, + "ServiceUnavailableError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"string", + "documentation":"

    A human-readable message describing the error that occurred.

    " + }, + "error":{ + "shape":"StorageGatewayError", + "documentation":"

    A StorageGatewayError that provides more information about the cause of the error.

    " + } + }, + "documentation":"

    An internal server error has occurred because the service is unavailable. For more information, see the error and message fields.

    ", + "exception":true + }, + "SetLocalConsolePasswordInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "LocalConsolePassword" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "LocalConsolePassword":{ + "shape":"LocalConsolePassword", + "documentation":"

    The password you want to set for your VM local console.

    " + } + }, + "documentation":"

    SetLocalConsolePasswordInput

    " + }, + "SetLocalConsolePasswordOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "SetSMBGuestPasswordInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "Password" + ], + "members":{ + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated with.

    " + }, + "Password":{ + "shape":"SMBGuestPassword", + "documentation":"

    The password that you want to set for your SMB Server.

    " + } + }, + "documentation":"

    SetSMBGuestPasswordInput

    " + }, + "SetSMBGuestPasswordOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "ShutdownGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway to shut down.

    " + }, + "ShutdownGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway that was shut down.

    " + }, + "SnapshotDescription":{ + "type":"string", + "max":255, + "min":1 + }, + "SnapshotId":{ + "type":"string", + "pattern":"\\Asnap-([0-9A-Fa-f]{8}|[0-9A-Fa-f]{17})\\z" + }, + "Squash":{ + "type":"string", + "documentation":"

    The user mapped to anonymous user. Valid options are the following:

    • RootSquash - Only root is mapped to anonymous user.

    • NoSquash - No one is mapped to anonymous user

    • AllSquash - Everyone is mapped to anonymous user.

    ", + "max":15, + "min":5 + }, + "StartGatewayInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway to start.

    " + }, + "StartGatewayOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway that was restarted.

    " + }, + "StorageClass":{ + "type":"string", + "documentation":"

    ", + "max":20, + "min":5 + }, + "StorageGatewayError":{ + "type":"structure", + "members":{ + "errorCode":{ + "shape":"ErrorCode", + "documentation":"

    Additional information about the error.

    " + }, + "errorDetails":{ + "shape":"errorDetails", + "documentation":"

    Human-readable text that provides detail about the error that occurred.

    " + } + }, + "documentation":"

    Provides additional information about an error that was returned by the service as an or. See the errorCode and errorDetails members for more information about the error.

    " + }, + "StorediSCSIVolume":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the storage volume.

    " + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

    The unique identifier of the volume, e.g. vol-AE4B946D.

    " + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

    One of the VolumeType enumeration values describing the type of the volume.

    " + }, + "VolumeStatus":{ + "shape":"VolumeStatus", + "documentation":"

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + }, + "VolumeAttachmentStatus":{ + "shape":"VolumeAttachmentStatus", + "documentation":"

    A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving Your Volumes to a Different Gateway.

    " + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size of the volume in bytes.

    " + }, + "VolumeProgress":{ + "shape":"DoubleObject", + "documentation":"

    Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

    " + }, + "VolumeDiskId":{ + "shape":"DiskId", + "documentation":"

    The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

    " + }, + "SourceSnapshotId":{ + "shape":"SnapshotId", + "documentation":"

    If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

    " + }, + "PreservedExistingData":{ + "shape":"boolean", + "documentation":"

    Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

    Valid Values: true, false

    " + }, + "VolumeiSCSIAttributes":{ + "shape":"VolumeiSCSIAttributes", + "documentation":"

    An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

    " + }, + "CreatedDate":{ + "shape":"CreatedDate", + "documentation":"

    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.

    " + }, + "VolumeUsedInBytes":{ + "shape":"VolumeUsedInBytes", + "documentation":"

    The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

    This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "TargetName":{ + "shape":"TargetName", + "documentation":"

    The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume. The target name must be unique across all volumes on a gateway.

    If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

    " + } + }, + "documentation":"

    Describes an iSCSI stored volume.

    " + }, + "StorediSCSIVolumes":{ + "type":"list", + "member":{"shape":"StorediSCSIVolume"} + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    Tag key (String). The key can't start with aws:.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    Value of the tag key.

    " + } + }, + "documentation":"

    A key-value pair that helps you manage, filter, and search for your resource. Allowed characters: letters, white space, and numbers, representable in UTF-8, and the following characters: + - = . _ : /

    " + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"} + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "Tape":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape.

    " + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

    The barcode that identifies a specific virtual tape.

    " + }, + "TapeCreatedDate":{ + "shape":"Time", + "documentation":"

    The date the virtual tape was created.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of the virtual tape capacity.

    " + }, + "TapeStatus":{ + "shape":"TapeStatus", + "documentation":"

    The current state of the virtual tape.

    " + }, + "VTLDevice":{ + "shape":"VTLDeviceARN", + "documentation":"

    The virtual tape library (VTL) device that the virtual tape is associated with.

    " + }, + "Progress":{ + "shape":"DoubleObject", + "documentation":"

    For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

    Range: 0 (not started) to 100 (complete).

    " + }, + "TapeUsedInBytes":{ + "shape":"TapeUsage", + "documentation":"

    The size, in bytes, of data stored on the virtual tape.

    This value is not available for tapes created prior to May 13, 2015.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + } + }, + "documentation":"

    Describes a virtual tape object.

    " + }, + "TapeARN":{ + "type":"string", + "max":500, + "min":50, + "pattern":"^arn:(aws|aws-cn|aws-us-gov):storagegateway:[a-z\\-0-9]+:[0-9]+:tape\\/[0-9A-Z]{7,16}$" + }, + "TapeARNs":{ + "type":"list", + "member":{"shape":"TapeARN"}, + "documentation":"

    The Amazon Resource Name (ARN) of each of the tapes you want to list. If you don't specify a tape ARN, the response lists all tapes in both your VTL and VTS.

    " + }, + "TapeArchive":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of an archived virtual tape.

    " + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

    The barcode that identifies the archived virtual tape.

    " + }, + "TapeCreatedDate":{ + "shape":"Time", + "documentation":"

    The date the virtual tape was created.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of the archived virtual tape.

    " + }, + "CompletionTime":{ + "shape":"Time", + "documentation":"

    The time that the archiving of the virtual tape was completed.

    The default time stamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    " + }, + "RetrievedTo":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

    The virtual tape is retrieved from the virtual tape shelf (VTS).

    " + }, + "TapeStatus":{ + "shape":"TapeArchiveStatus", + "documentation":"

    The current state of the archived virtual tape.

    " + }, + "TapeUsedInBytes":{ + "shape":"TapeUsage", + "documentation":"

    The size, in bytes, of data stored on the virtual tape.

    This value is not available for tapes created prior to May 13, 2015.

    " + }, + "KMSKey":{"shape":"KMSKey"}, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + } + }, + "documentation":"

    Represents a virtual tape that is archived in the virtual tape shelf (VTS).

    " + }, + "TapeArchiveStatus":{"type":"string"}, + "TapeArchives":{ + "type":"list", + "member":{"shape":"TapeArchive"} + }, + "TapeBarcode":{ + "type":"string", + "max":16, + "min":7, + "pattern":"^[A-Z0-9]*$" + }, + "TapeBarcodePrefix":{ + "type":"string", + "max":4, + "min":1, + "pattern":"^[A-Z]*$" + }, + "TapeDriveType":{ + "type":"string", + "max":50, + "min":2 + }, + "TapeInfo":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of a virtual tape.

    " + }, + "TapeBarcode":{ + "shape":"TapeBarcode", + "documentation":"

    The barcode that identifies a specific virtual tape.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of a virtual tape.

    " + }, + "TapeStatus":{ + "shape":"TapeStatus", + "documentation":"

    The status of the tape.

    " + }, + "GatewayARN":{ + "shape":"GatewayARN", + "documentation":"

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.

    " + }, + "PoolId":{ + "shape":"PoolId", + "documentation":"

    The ID of the pool that you want to add your tape to for archiving. The tape in this pool is archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

    Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

    " + } + }, + "documentation":"

    Describes a virtual tape.

    " + }, + "TapeInfos":{ + "type":"list", + "member":{"shape":"TapeInfo"}, + "documentation":"

    An array of TapeInfo objects, where each object describes an a single tape. If there not tapes in the tape library or VTS, then the TapeInfos is an empty array.

    " + }, + "TapeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "TapeARN":{ + "shape":"TapeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the virtual tape.

    " + }, + "TapeRecoveryPointTime":{ + "shape":"Time", + "documentation":"

    The time when the point-in-time view of the virtual tape was replicated for later recovery.

    The default time stamp format of the tape recovery point time is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    " + }, + "TapeSizeInBytes":{ + "shape":"TapeSize", + "documentation":"

    The size, in bytes, of the virtual tapes to recover.

    " + }, + "TapeStatus":{ + "shape":"TapeRecoveryPointStatus", + "documentation":"

    The status of the virtual tapes.

    " + } + }, + "documentation":"

    Describes a recovery point.

    " + }, + "TapeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"TapeRecoveryPointInfo"} + }, + "TapeRecoveryPointStatus":{"type":"string"}, + "TapeSize":{"type":"long"}, + "TapeStatus":{"type":"string"}, + "TapeUsage":{"type":"long"}, + "Tapes":{ + "type":"list", + "member":{"shape":"Tape"} + }, + "TargetARN":{ + "type":"string", + "max":800, + "min":50 + }, + "TargetName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[-\\.;a-z0-9]+$" + }, + "Time":{"type":"timestamp"}, + "UpdateBandwidthRateLimitInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "AverageUploadRateLimitInBitsPerSec":{ + "shape":"BandwidthUploadRateLimit", + "documentation":"

    The average upload bandwidth rate limit in bits per second.

    " + }, + "AverageDownloadRateLimitInBitsPerSec":{ + "shape":"BandwidthDownloadRateLimit", + "documentation":"

    The average download bandwidth rate limit in bits per second.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "UpdateBandwidthRateLimitOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway whose throttle information was updated.

    " + }, + "UpdateChapCredentialsInput":{ + "type":"structure", + "required":[ + "TargetARN", + "SecretToAuthenticateInitiator", + "InitiatorName" + ], + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified VolumeARN.

    " + }, + "SecretToAuthenticateInitiator":{ + "shape":"ChapSecret", + "documentation":"

    The secret key that the initiator (for example, the Windows client) must provide to participate in mutual CHAP with the target.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    " + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

    The iSCSI initiator that connects to the target.

    " + }, + "SecretToAuthenticateTarget":{ + "shape":"ChapSecret", + "documentation":"

    The secret key that the target must provide to participate in mutual CHAP with the initiator (e.g. Windows client).

    Byte constraints: Minimum bytes of 12. Maximum bytes of 16.

    The secret key must be between 12 and 16 bytes when encoded in UTF-8.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "UpdateChapCredentialsOutput":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the target. This is the same target specified in the request.

    " + }, + "InitiatorName":{ + "shape":"IqnName", + "documentation":"

    The iSCSI initiator that connects to the target. This is the same initiator name specified in the request.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "UpdateGatewayInformationInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayName":{"shape":"GatewayName"}, + "GatewayTimezone":{ + "shape":"GatewayTimezone", + "documentation":"

    A value that indicates the time zone of the gateway.

    " + }, + "CloudWatchLogGroupARN":{ + "shape":"CloudWatchLogGroupARN", + "documentation":"

    The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

    For more information, see What Is Amazon CloudWatch Logs?.

    " + } + } + }, + "UpdateGatewayInformationOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayName":{ + "shape":"string", + "documentation":"

    The name you configured for your gateway.

    " + } + }, + "documentation":"

    A JSON object containing the ARN of the gateway that was updated.

    " + }, + "UpdateGatewaySoftwareNowInput":{ + "type":"structure", + "required":["GatewayARN"], + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway to update.

    " + }, + "UpdateGatewaySoftwareNowOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway that was updated.

    " + }, + "UpdateMaintenanceStartTimeInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "HourOfDay", + "MinuteOfHour" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "HourOfDay":{ + "shape":"HourOfDay", + "documentation":"

    The hour component of the maintenance start time represented as hh, where hh is the hour (00 to 23). The hour of the day is in the time zone of the gateway.

    " + }, + "MinuteOfHour":{ + "shape":"MinuteOfHour", + "documentation":"

    The minute component of the maintenance start time represented as mm, where mm is the minute (00 to 59). The minute of the hour is in the time zone of the gateway.

    " + }, + "DayOfWeek":{ + "shape":"DayOfWeek", + "documentation":"

    The day of the week component of the maintenance start time week represented as an ordinal number from 0 to 6, where 0 represents Sunday and 6 Saturday.

    " + }, + "DayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

    The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

    This value is only available for tape and volume gateways.

    " + } + }, + "documentation":"

    A JSON object containing the following fields:

    " + }, + "UpdateMaintenanceStartTimeOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + }, + "documentation":"

    A JSON object containing the of the gateway whose maintenance start time is updated.

    " + }, + "UpdateNFSFileShareInput":{ + "type":"structure", + "required":["FileShareARN"], + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the file share to be updated.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "NFSFileShareDefaults":{ + "shape":"NFSFileShareDefaults", + "documentation":"

    The default values for the file share. Optional.

    " + }, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{ + "shape":"ObjectACL", + "documentation":"

    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

    " + }, + "ClientList":{ + "shape":"FileShareClientList", + "documentation":"

    The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks.

    " + }, + "Squash":{ + "shape":"Squash", + "documentation":"

    The user mapped to anonymous user. Valid options are the following:

    • RootSquash - Only root is mapped to anonymous user.

    • NoSquash - No one is mapped to anonymous user

    • AllSquash - Everyone is mapped to anonymous user.

    " + }, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + } + }, + "documentation":"

    UpdateNFSFileShareInput

    " + }, + "UpdateNFSFileShareOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the updated file share.

    " + } + }, + "documentation":"

    UpdateNFSFileShareOutput

    " + }, + "UpdateSMBFileShareInput":{ + "type":"structure", + "required":["FileShareARN"], + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the SMB file share that you want to update.

    " + }, + "KMSEncrypted":{ + "shape":"Boolean", + "documentation":"

    True to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Optional.

    " + }, + "KMSKey":{ + "shape":"KMSKey", + "documentation":"

    The Amazon Resource Name (ARN) of the AWS KMS key used for Amazon S3 server side encryption. This value can only be set when KMSEncrypted is true. Optional.

    " + }, + "DefaultStorageClass":{ + "shape":"StorageClass", + "documentation":"

    The default storage class for objects put into an Amazon S3 bucket by the file gateway. Possible values are S3_STANDARD, S3_STANDARD_IA, or S3_ONEZONE_IA. If this field is not populated, the default value S3_STANDARD is used. Optional.

    " + }, + "ObjectACL":{ + "shape":"ObjectACL", + "documentation":"

    A value that sets the access control list permission for objects in the S3 bucket that a file gateway puts objects into. The default value is \"private\".

    " + }, + "ReadOnly":{ + "shape":"Boolean", + "documentation":"

    A value that sets the write status of a file share. This value is true if the write status is read-only, and otherwise false.

    " + }, + "GuessMIMETypeEnabled":{ + "shape":"Boolean", + "documentation":"

    A value that enables guessing of the MIME type for uploaded objects based on file extensions. Set this value to true to enable MIME type guessing, and otherwise to false. The default value is true.

    " + }, + "RequesterPays":{ + "shape":"Boolean", + "documentation":"

    A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs. Otherwise the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

    RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

    " + }, + "SMBACLEnabled":{ + "shape":"Boolean", + "documentation":"

    Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.

    For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.

    " + }, + "AdminUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "ValidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + }, + "InvalidUserList":{ + "shape":"FileShareUserList", + "documentation":"

    A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

    " + } + }, + "documentation":"

    UpdateSMBFileShareInput

    " + }, + "UpdateSMBFileShareOutput":{ + "type":"structure", + "members":{ + "FileShareARN":{ + "shape":"FileShareARN", + "documentation":"

    The Amazon Resource Name (ARN) of the updated SMB file share.

    " + } + }, + "documentation":"

    UpdateSMBFileShareOutput

    " + }, + "UpdateSMBSecurityStrategyInput":{ + "type":"structure", + "required":[ + "GatewayARN", + "SMBSecurityStrategy" + ], + "members":{ + "GatewayARN":{"shape":"GatewayARN"}, + "SMBSecurityStrategy":{ + "shape":"SMBSecurityStrategy", + "documentation":"

    Specifies the type of security strategy.

    ClientSpecified: if you use this option, requests are established based on what is negotiated by the client. This option is recommended when you want to maximize compatibility across different clients in your environment.

    MandatorySigning: if you use this option, file gateway only allows connections from SMBv2 or SMBv3 clients that have signing enabled. This option works with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.

    MandatoryEncryption: if you use this option, file gateway only allows connections from SMBv3 clients that have encryption enabled. This option is highly recommended for environments that handle sensitive data. This option works with SMB clients on Microsoft Windows 8, Windows Server 2012 or newer.

    " + } + } + }, + "UpdateSMBSecurityStrategyOutput":{ + "type":"structure", + "members":{ + "GatewayARN":{"shape":"GatewayARN"} + } + }, + "UpdateSnapshotScheduleInput":{ + "type":"structure", + "required":[ + "VolumeARN", + "StartAt", + "RecurrenceInHours" + ], + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    " + }, + "StartAt":{ + "shape":"HourOfDay", + "documentation":"

    The hour of the day at which the snapshot schedule begins represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

    " + }, + "RecurrenceInHours":{ + "shape":"RecurrenceInHours", + "documentation":"

    Frequency of snapshots. Specify the number of hours between snapshots.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    Optional description of the snapshot that overwrites the existing description.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.

    Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

    " + } + }, + "documentation":"

    A JSON object containing one or more of the following fields:

    " + }, + "UpdateSnapshotScheduleOutput":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume. Use the ListVolumes operation to return a list of gateway volumes.

    " + } + }, + "documentation":"

    A JSON object containing the of the updated storage volume.

    " + }, + "UpdateVTLDeviceTypeInput":{ + "type":"structure", + "required":[ + "VTLDeviceARN", + "DeviceType" + ], + "members":{ + "VTLDeviceARN":{ + "shape":"VTLDeviceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the medium changer you want to select.

    " + }, + "DeviceType":{ + "shape":"DeviceType", + "documentation":"

    The type of medium changer you want to select.

    Valid Values: \"STK-L700\", \"AWS-Gateway-VTL\"

    " + } + } + }, + "UpdateVTLDeviceTypeOutput":{ + "type":"structure", + "members":{ + "VTLDeviceARN":{ + "shape":"VTLDeviceARN", + "documentation":"

    The Amazon Resource Name (ARN) of the medium changer you have selected.

    " + } + }, + "documentation":"

    UpdateVTLDeviceTypeOutput

    " + }, + "VTLDevice":{ + "type":"structure", + "members":{ + "VTLDeviceARN":{ + "shape":"VTLDeviceARN", + "documentation":"

    Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media changer).

    " + }, + "VTLDeviceType":{ + "shape":"VTLDeviceType", + "documentation":"

    Specifies the type of device that the VTL device emulates.

    " + }, + "VTLDeviceVendor":{ + "shape":"VTLDeviceVendor", + "documentation":"

    Specifies the vendor of the device that the VTL device object emulates.

    " + }, + "VTLDeviceProductIdentifier":{ + "shape":"VTLDeviceProductIdentifier", + "documentation":"

    Specifies the model number of device that the VTL device emulates.

    " + }, + "DeviceiSCSIAttributes":{ + "shape":"DeviceiSCSIAttributes", + "documentation":"

    A list of iSCSI information about a VTL device.

    " + } + }, + "documentation":"

    Represents a device object associated with a tape gateway.

    " + }, + "VTLDeviceARN":{ + "type":"string", + "max":500, + "min":50 + }, + "VTLDeviceARNs":{ + "type":"list", + "member":{"shape":"VTLDeviceARN"} + }, + "VTLDeviceProductIdentifier":{"type":"string"}, + "VTLDeviceType":{"type":"string"}, + "VTLDeviceVendor":{"type":"string"}, + "VTLDevices":{ + "type":"list", + "member":{"shape":"VTLDevice"} + }, + "VolumeARN":{ + "type":"string", + "max":500, + "min":50 + }, + "VolumeARNs":{ + "type":"list", + "member":{"shape":"VolumeARN"} + }, + "VolumeAttachmentStatus":{ + "type":"string", + "max":50, + "min":3 + }, + "VolumeId":{ + "type":"string", + "max":30, + "min":12 + }, + "VolumeInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) for the storage volume. For example, the following is a valid ARN:

    arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + }, + "VolumeId":{ + "shape":"VolumeId", + "documentation":"

    The unique identifier assigned to the volume. This ID becomes part of the volume Amazon Resource Name (ARN), which you use as input for other operations.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + }, + "GatewayARN":{"shape":"GatewayARN"}, + "GatewayId":{ + "shape":"GatewayId", + "documentation":"

    The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + }, + "VolumeType":{ + "shape":"VolumeType", + "documentation":"

    One of the VolumeType enumeration values describing the type of the volume.

    " + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size of the volume in bytes.

    Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).

    " + }, + "VolumeAttachmentStatus":{ + "shape":"VolumeAttachmentStatus", + "documentation":"

    One of the VolumeStatus values that indicates the state of the storage volume.

    " + } + }, + "documentation":"

    Describes a storage volume object.

    " + }, + "VolumeInfos":{ + "type":"list", + "member":{"shape":"VolumeInfo"} + }, + "VolumeRecoveryPointInfo":{ + "type":"structure", + "members":{ + "VolumeARN":{ + "shape":"VolumeARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume target.

    " + }, + "VolumeSizeInBytes":{ + "shape":"long", + "documentation":"

    The size of the volume in bytes.

    " + }, + "VolumeUsageInBytes":{ + "shape":"long", + "documentation":"

    The size of the data stored on the volume in bytes.

    This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

    " + }, + "VolumeRecoveryPointTime":{ + "shape":"string", + "documentation":"

    The time the recovery point was taken.

    " + } + }, + "documentation":"

    Describes a storage volume recovery point object.

    " + }, + "VolumeRecoveryPointInfos":{ + "type":"list", + "member":{"shape":"VolumeRecoveryPointInfo"} + }, + "VolumeStatus":{ + "type":"string", + "max":50, + "min":3 + }, + "VolumeType":{ + "type":"string", + "max":100, + "min":3 + }, + "VolumeUsedInBytes":{"type":"long"}, + "VolumeiSCSIAttributes":{ + "type":"structure", + "members":{ + "TargetARN":{ + "shape":"TargetARN", + "documentation":"

    The Amazon Resource Name (ARN) of the volume target.

    " + }, + "NetworkInterfaceId":{ + "shape":"NetworkInterfaceId", + "documentation":"

    The network interface identifier.

    " + }, + "NetworkInterfacePort":{ + "shape":"integer", + "documentation":"

    The port used to communicate with iSCSI targets.

    " + }, + "LunNumber":{ + "shape":"PositiveIntObject", + "documentation":"

    The logical disk number.

    " + }, + "ChapEnabled":{ + "shape":"boolean", + "documentation":"

    Indicates whether mutual CHAP is enabled for the iSCSI target.

    " + } + }, + "documentation":"

    Lists iSCSI information about a volume.

    " + }, + "boolean":{"type":"boolean"}, + "double":{"type":"double"}, + "errorDetails":{ + "type":"map", + "key":{"shape":"string"}, + "value":{"shape":"string"} + }, + "integer":{"type":"integer"}, + "long":{"type":"long"}, + "string":{"type":"string"} + }, + "documentation":"AWS Storage Gateway Service

    AWS Storage Gateway is the service that connects an on-premises software appliance with cloud-based storage to provide seamless and secure integration between an organization's on-premises IT environment and the AWS storage infrastructure. The service enables you to securely upload data to the AWS cloud for cost effective backup and rapid disaster recovery.

    Use the following links to get started using the AWS Storage Gateway Service API Reference:

    AWS Storage Gateway resource IDs are in uppercase. When you use these resource IDs with the Amazon EC2 API, EC2 expects resource IDs in lowercase. You must change your resource ID to lowercase to use it with the EC2 API. For example, in Storage Gateway the ID for a volume might be vol-AA22BB012345DAF670. When you use this ID with the EC2 API, you must change it to vol-aa22bb012345daf670. Otherwise, the EC2 API might not behave as expected.

    IDs for Storage Gateway volumes and Amazon EBS snapshots created from gateway volumes are changing to a longer format. Starting in December 2016, all new volumes and snapshots will be created with a 17-character string. Starting in April 2016, you will be able to use these longer IDs so you can test your systems with the new format. For more information, see Longer EC2 and EBS Resource IDs.

    For example, a volume Amazon Resource Name (ARN) with the longer volume ID format looks like the following:

    arn:aws:storagegateway:us-west-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABBCCDDEEFFG.

    A snapshot ID with the longer ID format looks like the following: snap-78e226633445566ee.

    For more information, see Announcement: Heads-up – Longer AWS Storage Gateway volume and snapshot IDs coming in 2016.

    " +} diff --git a/aws/dist/botocore/data/sts/2011-06-15/examples-1.json b/aws/dist/botocore/data/sts/2011-06-15/examples-1.json new file mode 100644 index 00000000..84442a10 --- /dev/null +++ b/aws/dist/botocore/data/sts/2011-06-15/examples-1.json @@ -0,0 +1,206 @@ +{ + "version": "1.0", + "examples": { + "AssumeRole": [ + { + "input": { + "DurationSeconds": 3600, + "ExternalId": "123ABC", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}", + "RoleArn": "arn:aws:iam::123456789012:role/demo", + "RoleSessionName": "Bob" + }, + "output": { + "AssumedRoleUser": { + "Arn": "arn:aws:sts::123456789012:assumed-role/demo/Bob", + "AssumedRoleId": "ARO123EXAMPLE123:Bob" + }, + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-15T23:28:33.359Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==" + }, + "PackedPolicySize": 6 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-assume-a-role-1480532402212", + "title": "To assume a role" + } + ], + "AssumeRoleWithWebIdentity": [ + { + "input": { + "DurationSeconds": 3600, + "ProviderId": "www.amazon.com", + "RoleArn": "arn:aws:iam::123456789012:role/FederatedWebIdentityRole", + "RoleSessionName": "app1", + "WebIdentityToken": "Atza%7CIQEBLjAsAhRFiXuWpUXuRvQ9PZL3GMFcYevydwIUFAHZwXZXXXXXXXXJnrulxKDHwy87oGKPznh0D6bEQZTSCzyoCtL_8S07pLpr0zMbn6w1lfVZKNTBdDansFBmtGnIsIapjI6xKR02Yc_2bQ8LZbUXSGm6Ry6_BG7PrtLZtj_dfCTj92xNGed-CrKqjG7nPBjNIL016GGvuS5gSvPRUxWES3VYfm1wl7WTI7jn-Pcb6M-buCgHhFOzTQxod27L9CqnOLio7N3gZAGpsp6n1-AJBOCJckcyXe2c6uD0srOJeZlKUm2eTDVMf8IehDVI0r1QOnTV6KzzAI3OY87Vd_cVMQ" + }, + "output": { + "AssumedRoleUser": { + "Arn": "arn:aws:sts::123456789012:assumed-role/FederatedWebIdentityRole/app1", + "AssumedRoleId": "AROACLKWSDQRAOEXAMPLE:app1" + }, + "Audience": "client.5498841531868486423.1548@apps.example.com", + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2014-10-24T23:00:23Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEE0a8ANXXXXXXXXNO1ewxE5TijQyp+IEXAMPLE" + }, + "PackedPolicySize": 123, + "Provider": "www.amazon.com", + "SubjectFromWebIdentityToken": "amzn1.account.AF6RHO7KZU5XRVQJGXK6HEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-assume-a-role-as-an-openid-connect-federated-user-1480533445696", + "title": "To assume a role as an OpenID Connect-federated user" + } + ], + "DecodeAuthorizationMessage": [ + { + "input": { + "EncodedMessage": "" + }, + "output": { + "DecodedMessage": "{\"allowed\": \"false\",\"explicitDeny\": \"false\",\"matchedStatements\": \"\",\"failures\": \"\",\"context\": {\"principal\": {\"id\": \"AIDACKCEVSQ6C2EXAMPLE\",\"name\": \"Bob\",\"arn\": \"arn:aws:iam::123456789012:user/Bob\"},\"action\": \"ec2:StopInstances\",\"resource\": \"arn:aws:ec2:us-east-1:123456789012:instance/i-dd01c9bd\",\"conditions\": [{\"item\": {\"key\": \"ec2:Tenancy\",\"values\": [\"default\"]},{\"item\": {\"key\": \"ec2:ResourceTag/elasticbeanstalk:environment-name\",\"values\": [\"Default-Environment\"]}},(Additional items ...)]}}" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-decode-information-about-an-authorization-status-of-a-request-1480533854499", + "title": "To decode information about an authorization status of a request" + } + ], + "GetCallerIdentity": [ + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:iam::123456789012:user/Alice", + "UserId": "AKIAI44QH8DHBEXAMPLE" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with the credentials for a user named Alice in the AWS account 123456789012.", + "id": "to-get-details-about-a-calling-iam-user-1480540050376", + "title": "To get details about a calling IAM user" + }, + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:sts::123456789012:assumed-role/my-role-name/my-role-session-name", + "UserId": "AKIAI44QH8DHBEXAMPLE:my-role-session-name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with temporary credentials created by AssumeRole. The name of the assumed role is my-role-name, and the RoleSessionName is set to my-role-session-name.", + "id": "to-get-details-about-a-calling-user-federated-with-assumerole-1480540158545", + "title": "To get details about a calling user federated with AssumeRole" + }, + { + "input": { + }, + "output": { + "Account": "123456789012", + "Arn": "arn:aws:sts::123456789012:federated-user/my-federated-user-name", + "UserId": "123456789012:my-federated-user-name" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This example shows a request and response made with temporary credentials created by using GetFederationToken. The Name parameter is set to my-federated-user-name.", + "id": "to-get-details-about-a-calling-user-federated-with-getfederationtoken-1480540231316", + "title": "To get details about a calling user federated with GetFederationToken" + } + ], + "GetFederationToken": [ + { + "input": { + "DurationSeconds": 3600, + "Name": "Bob", + "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Sid\":\"Stmt1\",\"Effect\":\"Allow\",\"Action\":\"s3:*\",\"Resource\":\"*\"}]}" + }, + "output": { + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-15T23:28:33.359Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoDYXdzEPT//////////wEXAMPLEtc764bNrC9SAPBSM22wDOk4x4HIZ8j4FZTwdQWLWsKWHGBuFqwAeMicRXmxfpSPfIeoIYRqTflfKD8YUuwthAx7mSEI/qkPpKPi/kMcGdQrmGdeehM4IC1NtBmUpp2wUE8phUZampKsburEDy0KPkyQDYwT7WZ0wq5VSXDvp75YU9HFvlRd8Tx6q6fE8YQcHNVXAkiY9q6d+xo0rKwT38xVqr7ZD0u0iPPkUL64lIZbqBAz+scqKmlzm8FDrypNC9Yjc8fPOLn9FX9KSYvKTr4rvx3iSIlTJabIQwj2ICCR/oLxBA==" + }, + "FederatedUser": { + "Arn": "arn:aws:sts::123456789012:federated-user/Bob", + "FederatedUserId": "123456789012:Bob" + }, + "PackedPolicySize": 6 + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-get-temporary-credentials-for-a-role-by-using-getfederationtoken-1480540749900", + "title": "To get temporary credentials for a role by using GetFederationToken" + } + ], + "GetSessionToken": [ + { + "input": { + "DurationSeconds": 3600, + "SerialNumber": "YourMFASerialNumber", + "TokenCode": "123456" + }, + "output": { + "Credentials": { + "AccessKeyId": "AKIAIOSFODNN7EXAMPLE", + "Expiration": "2011-07-11T19:55:29.611Z", + "SecretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYzEXAMPLEKEY", + "SessionToken": "AQoEXAMPLEH4aoAH0gNCAPyJxz4BlCFFxWNE1OPTgk5TthT+FvwqnKwRcOIfrRh3c/LTo6UDdyJwOOvEVPvLXCrrrUtdnniCEXAMPLE/IvU1dYUg2RVAJBanLiHb4IgRmpRV3zrkuWJOgQs8IZZaIv2BXIa2R4OlgkBN9bkUDNCJiBeb/AXlzBBko7b15fjrBs2+cTQtpZ3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "", + "id": "to-get-temporary-credentials-for-an-iam-user-or-an-aws-account-1480540814038", + "title": "To get temporary credentials for an IAM user or an AWS account" + } + ] + } +} diff --git a/aws/dist/botocore/data/sts/2011-06-15/paginators-1.json b/aws/dist/botocore/data/sts/2011-06-15/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/sts/2011-06-15/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/sts/2011-06-15/service-2.json b/aws/dist/botocore/data/sts/2011-06-15/service-2.json new file mode 100644 index 00000000..acfdbc95 --- /dev/null +++ b/aws/dist/botocore/data/sts/2011-06-15/service-2.json @@ -0,0 +1,785 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2011-06-15", + "endpointPrefix":"sts", + "globalEndpoint":"sts.amazonaws.com", + "protocol":"query", + "serviceAbbreviation":"AWS STS", + "serviceFullName":"AWS Security Token Service", + "serviceId":"STS", + "signatureVersion":"v4", + "uid":"sts-2011-06-15", + "xmlNamespace":"https://sts.amazonaws.com/doc/2011-06-15/" + }, + "operations":{ + "AssumeRole":{ + "name":"AssumeRole", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleRequest"}, + "output":{ + "shape":"AssumeRoleResponse", + "resultWrapper":"AssumeRoleResult" + }, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PackedPolicyTooLargeException"}, + {"shape":"RegionDisabledException"} + ], + "documentation":"

    Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

    You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an IAM user or an IAM role to call AssumeRole.

    For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account. Then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles in the IAM User Guide.

    By default, the temporary security credentials created by AssumeRole last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

    The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS GetFederationToken or GetSessionToken API operations.

    (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.

    A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:

    • Attach a policy to the user (identical to the previous user in a different account).

    • Add the user as a principal directly in the role's trust policy.

    In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.

    Using MFA with AssumeRole

    (Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.

    \"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}

    For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.

    To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.

    " + }, + "AssumeRoleWithSAML":{ + "name":"AssumeRoleWithSAML", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleWithSAMLRequest"}, + "output":{ + "shape":"AssumeRoleWithSAMLResponse", + "resultWrapper":"AssumeRoleWithSAMLResult" + }, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PackedPolicyTooLargeException"}, + {"shape":"IDPRejectedClaimException"}, + {"shape":"InvalidIdentityTokenException"}, + {"shape":"ExpiredTokenException"}, + {"shape":"RegionDisabledException"} + ], + "documentation":"

    Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

    The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.

    By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

    The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

    (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.

    Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

    Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

    For more information, see the following resources:

    " + }, + "AssumeRoleWithWebIdentity":{ + "name":"AssumeRoleWithWebIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssumeRoleWithWebIdentityRequest"}, + "output":{ + "shape":"AssumeRoleWithWebIdentityResponse", + "resultWrapper":"AssumeRoleWithWebIdentityResult" + }, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PackedPolicyTooLargeException"}, + {"shape":"IDPRejectedClaimException"}, + {"shape":"IDPCommunicationErrorException"}, + {"shape":"InvalidIdentityTokenException"}, + {"shape":"ExpiredTokenException"}, + {"shape":"RegionDisabledException"} + ], + "documentation":"

    Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.

    For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.

    To learn more about Amazon Cognito, see Amazon Cognito Overview in AWS SDK for Android Developer Guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.

    Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

    The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations.

    By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

    The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

    (Optional) You can pass inline or managed session policies to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

    Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.

    For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

    " + }, + "DecodeAuthorizationMessage":{ + "name":"DecodeAuthorizationMessage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DecodeAuthorizationMessageRequest"}, + "output":{ + "shape":"DecodeAuthorizationMessageResponse", + "resultWrapper":"DecodeAuthorizationMessageResult" + }, + "errors":[ + {"shape":"InvalidAuthorizationMessageException"} + ], + "documentation":"

    Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.

    For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure.

    Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.

    The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.

    The decoded message includes the following type of information:

    • Whether the request was denied due to an explicit deny or due to the absence of an explicit allow. For more information, see Determining Whether a Request is Allowed or Denied in the IAM User Guide.

    • The principal who made the request.

    • The requested action.

    • The requested resource.

    • The values of condition keys in the context of the user's request.

    " + }, + "GetAccessKeyInfo":{ + "name":"GetAccessKeyInfo", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetAccessKeyInfoRequest"}, + "output":{ + "shape":"GetAccessKeyInfoResponse", + "resultWrapper":"GetAccessKeyInfoResult" + }, + "documentation":"

    Returns the account identifier for the specified access key ID.

    Access keys consist of two parts: an access key ID (for example, AKIAIOSFODNN7EXAMPLE) and a secret access key (for example, wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY). For more information about access keys, see Managing Access Keys for IAM Users in the IAM User Guide.

    When you pass an access key ID to this operation, it returns the ID of the AWS account to which the keys belong. Access key IDs beginning with AKIA are long-term credentials for an IAM user or the AWS account root user. Access key IDs beginning with ASIA are temporary credentials that are created using STS operations. If the account in the response belongs to you, you can sign in as the root user and review your root user access keys. Then, you can pull a credentials report to learn which IAM user owns the keys. To learn who requested the temporary credentials for an ASIA access key, view the STS events in your CloudTrail logs.

    This operation does not indicate the state of the access key. The key might be active, inactive, or deleted. Active keys might not have permissions to perform an operation. Providing a deleted access key might return an error that the key doesn't exist.

    " + }, + "GetCallerIdentity":{ + "name":"GetCallerIdentity", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCallerIdentityRequest"}, + "output":{ + "shape":"GetCallerIdentityResponse", + "resultWrapper":"GetCallerIdentityResult" + }, + "documentation":"

    Returns details about the IAM user or role whose credentials are used to call the operation.

    No permissions are required to perform this operation. If an administrator adds a policy to your IAM user or role that explicitly denies access to the sts:GetCallerIdentity action, you can still perform this operation. Permissions are not required because the same information is returned when an IAM user or role is denied access. To view an example response, see I Am Not Authorized to Perform: iam:DeleteVirtualMFADevice.

    " + }, + "GetFederationToken":{ + "name":"GetFederationToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetFederationTokenRequest"}, + "output":{ + "shape":"GetFederationTokenResponse", + "resultWrapper":"GetFederationTokenResult" + }, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"PackedPolicyTooLargeException"}, + {"shape":"RegionDisabledException"} + ], + "documentation":"

    Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

    You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.

    You can also call GetFederationToken using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide.

    The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).

    The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions:

    • You cannot use these credentials to call any IAM API operations.

    • You cannot call any STS API operations except GetCallerIdentity.

    Permissions

    You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.

    Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy. When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

    " + }, + "GetSessionToken":{ + "name":"GetSessionToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSessionTokenRequest"}, + "output":{ + "shape":"GetSessionTokenResponse", + "resultWrapper":"GetSessionTokenResult" + }, + "errors":[ + {"shape":"RegionDisabledException"} + ], + "documentation":"

    Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

    The GetSessionToken operation must be called by using the long-term AWS security credentials of the AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.

    The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions:

    • You cannot call any IAM API operations unless MFA authentication information is included in the request.

    • You cannot call any STS API except AssumeRole or GetCallerIdentity.

    We recommend that you do not call GetSessionToken with AWS account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.

    The credentials that are returned by GetSessionToken are based on permissions associated with the user whose credentials were used to call the operation. If GetSessionToken is called using AWS account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.

    For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.

    " + } + }, + "shapes":{ + "AssumeRoleRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "RoleSessionName" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

    The Amazon Resource Name (ARN) of the role to assume.

    " + }, + "RoleSessionName":{ + "shape":"roleSessionNameType", + "documentation":"

    An identifier for the assumed role session.

    Use the role session name to uniquely identify a session when the same role is assumed by different principals or for different reasons. In cross-account scenarios, the role session name is visible to, and can be logged by the account that owns the role. The role session name is also used in the ARN of the assumed role principal. This means that subsequent cross-account API requests that use the temporary security credentials will expose the role session name to the external account in their AWS CloudTrail logs.

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    " + }, + "PolicyArns":{ + "shape":"policyDescriptorListType", + "documentation":"

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    " + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

    An IAM policy in JSON format that you want to use as an inline session policy.

    This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    " + }, + "DurationSeconds":{ + "shape":"roleDurationSecondsType", + "documentation":"

    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

    By default, the value is set to 3600 seconds.

    The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

    " + }, + "ExternalId":{ + "shape":"externalIdType", + "documentation":"

    A unique identifier that might be required when you assume a role in another account. If the administrator of the account to which the role belongs provided you with an external ID, then provide that value in the ExternalId parameter. This value can be any string, such as a passphrase or account number. A cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the trusting account might send an external ID to the administrator of the trusted account. That way, only someone with the ID can assume the role, rather than everyone in the account. For more information about the external ID, see How to Use an External ID When Granting Access to Your AWS Resources to a Third Party in the IAM User Guide.

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    " + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

    The identification number of the MFA device that is associated with the user who is making the AssumeRole call. Specify this value if the trust policy of the role being assumed includes a condition that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user).

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    " + }, + "TokenCode":{ + "shape":"tokenCodeType", + "documentation":"

    The value provided by the MFA device, if the trust policy of the role being assumed requires MFA (that is, if the policy includes a condition that tests for MFA). If the role being assumed requires MFA and if the TokenCode value is missing or expired, the AssumeRole call returns an \"access denied\" error.

    The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

    " + } + } + }, + "AssumeRoleResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

    The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    " + }, + "AssumedRoleUser":{ + "shape":"AssumedRoleUser", + "documentation":"

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

    " + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

    A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

    " + } + }, + "documentation":"

    Contains the response to a successful AssumeRole request, including temporary AWS credentials that can be used to make AWS requests.

    " + }, + "AssumeRoleWithSAMLRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "PrincipalArn", + "SAMLAssertion" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    " + }, + "PrincipalArn":{ + "shape":"arnType", + "documentation":"

    The Amazon Resource Name (ARN) of the SAML provider in IAM that describes the IdP.

    " + }, + "SAMLAssertion":{ + "shape":"SAMLAssertionType", + "documentation":"

    The base-64 encoded SAML authentication response provided by the IdP.

    For more information, see Configuring a Relying Party and Adding Claims in the IAM User Guide.

    " + }, + "PolicyArns":{ + "shape":"policyDescriptorListType", + "documentation":"

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    " + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

    An IAM policy in JSON format that you want to use as an inline session policy.

    This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    " + }, + "DurationSeconds":{ + "shape":"roleDurationSecondsType", + "documentation":"

    The duration, in seconds, of the role session. Your role session lasts for the duration that you specify for the DurationSeconds parameter, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

    By default, the value is set to 3600 seconds.

    The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

    " + } + } + }, + "AssumeRoleWithSAMLResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

    The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    " + }, + "AssumedRoleUser":{ + "shape":"AssumedRoleUser", + "documentation":"

    The identifiers for the temporary security credentials that the operation returns.

    " + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

    A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

    " + }, + "Subject":{ + "shape":"Subject", + "documentation":"

    The value of the NameID element in the Subject element of the SAML assertion.

    " + }, + "SubjectType":{ + "shape":"SubjectType", + "documentation":"

    The format of the name ID, as defined by the Format attribute in the NameID element of the SAML assertion. Typical examples of the format are transient or persistent.

    If the format includes the prefix urn:oasis:names:tc:SAML:2.0:nameid-format, that prefix is removed. For example, urn:oasis:names:tc:SAML:2.0:nameid-format:transient is returned as transient. If the format includes any other prefix, the format is returned with no modifications.

    " + }, + "Issuer":{ + "shape":"Issuer", + "documentation":"

    The value of the Issuer element of the SAML assertion.

    " + }, + "Audience":{ + "shape":"Audience", + "documentation":"

    The value of the Recipient attribute of the SubjectConfirmationData element of the SAML assertion.

    " + }, + "NameQualifier":{ + "shape":"NameQualifier", + "documentation":"

    A hash value based on the concatenation of the Issuer response value, the AWS account ID, and the friendly name (the last part of the ARN) of the SAML provider in IAM. The combination of NameQualifier and Subject can be used to uniquely identify a federated user.

    The following pseudocode shows how the hash value is calculated:

    BASE64 ( SHA1 ( \"https://example.com/saml\" + \"123456789012\" + \"/MySAMLIdP\" ) )

    " + } + }, + "documentation":"

    Contains the response to a successful AssumeRoleWithSAML request, including temporary AWS credentials that can be used to make AWS requests.

    " + }, + "AssumeRoleWithWebIdentityRequest":{ + "type":"structure", + "required":[ + "RoleArn", + "RoleSessionName", + "WebIdentityToken" + ], + "members":{ + "RoleArn":{ + "shape":"arnType", + "documentation":"

    The Amazon Resource Name (ARN) of the role that the caller is assuming.

    " + }, + "RoleSessionName":{ + "shape":"roleSessionNameType", + "documentation":"

    An identifier for the assumed role session. Typically, you pass the name or identifier that is associated with the user who is using your application. That way, the temporary security credentials that your application will use are associated with that user. This session name is included as part of the ARN and assumed role ID in the AssumedRoleUser response element.

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    " + }, + "WebIdentityToken":{ + "shape":"clientTokenType", + "documentation":"

    The OAuth 2.0 access token or OpenID Connect ID token that is provided by the identity provider. Your application must get this token by authenticating the user who is using your application with a web identity provider before the application makes an AssumeRoleWithWebIdentity call.

    " + }, + "ProviderId":{ + "shape":"urlType", + "documentation":"

    The fully qualified host component of the domain name of the identity provider.

    Specify this value only for OAuth 2.0 access tokens. Currently www.amazon.com and graph.facebook.com are the only supported identity providers for OAuth 2.0 access tokens. Do not include URL schemes and port numbers.

    Do not specify this value for OpenID Connect ID tokens.

    " + }, + "PolicyArns":{ + "shape":"policyDescriptorListType", + "documentation":"

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as managed session policies. The policies must exist in the same account as the role.

    This parameter is optional. You can provide up to 10 managed policy ARNs. However, the plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    " + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

    An IAM policy in JSON format that you want to use as an inline session policy.

    This parameter is optional. Passing policies to this operation returns new temporary credentials. The resulting session's permissions are the intersection of the role's identity-based policy and the session policies. You can use the role's temporary credentials in subsequent AWS API calls to access resources in the account that owns the role. You cannot use session policies to grant more permissions than those allowed by the identity-based policy of the role that is being assumed. For more information, see Session Policies in the IAM User Guide.

    The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    " + }, + "DurationSeconds":{ + "shape":"roleDurationSecondsType", + "documentation":"

    The duration, in seconds, of the role session. The value can range from 900 seconds (15 minutes) up to the maximum session duration setting for the role. This setting can have a value from 1 hour to 12 hours. If you specify a value higher than this setting, the operation fails. For example, if you specify a session duration of 12 hours, but your administrator set the maximum session duration to 6 hours, your operation fails. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide.

    By default, the value is set to 3600 seconds.

    The DurationSeconds parameter is separate from the duration of a console session that you might request using the returned credentials. The request to the federation endpoint for a console sign-in token takes a SessionDuration parameter that specifies the maximum length of the console session. For more information, see Creating a URL that Enables Federated Users to Access the AWS Management Console in the IAM User Guide.

    " + } + } + }, + "AssumeRoleWithWebIdentityResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

    The temporary security credentials, which include an access key ID, a secret access key, and a security token.

    The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    " + }, + "SubjectFromWebIdentityToken":{ + "shape":"webIdentitySubjectType", + "documentation":"

    The unique user identifier that is returned by the identity provider. This identifier is associated with the WebIdentityToken that was submitted with the AssumeRoleWithWebIdentity call. The identifier is typically unique to the user and the application that acquired the WebIdentityToken (pairwise identifier). For OpenID Connect ID tokens, this field contains the value returned by the identity provider as the token's sub (Subject) claim.

    " + }, + "AssumedRoleUser":{ + "shape":"AssumedRoleUser", + "documentation":"

    The Amazon Resource Name (ARN) and the assumed role ID, which are identifiers that you can use to refer to the resulting temporary security credentials. For example, you can reference these credentials as a principal in a resource-based policy by using the ARN or assumed role ID. The ARN and ID include the RoleSessionName that you specified when you called AssumeRole.

    " + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

    A percentage value that indicates the size of the policy in packed form. The service rejects any policy with a packed size greater than 100 percent, which means the policy exceeded the allowed space.

    " + }, + "Provider":{ + "shape":"Issuer", + "documentation":"

    The issuing authority of the web identity token presented. For OpenID Connect ID tokens, this contains the value of the iss field. For OAuth 2.0 access tokens, this contains the value of the ProviderId parameter that was passed in the AssumeRoleWithWebIdentity request.

    " + }, + "Audience":{ + "shape":"Audience", + "documentation":"

    The intended audience (also known as client ID) of the web identity token. This is traditionally the client identifier issued to the application that requested the web identity token.

    " + } + }, + "documentation":"

    Contains the response to a successful AssumeRoleWithWebIdentity request, including temporary AWS credentials that can be used to make AWS requests.

    " + }, + "AssumedRoleUser":{ + "type":"structure", + "required":[ + "AssumedRoleId", + "Arn" + ], + "members":{ + "AssumedRoleId":{ + "shape":"assumedRoleIdType", + "documentation":"

    A unique identifier that contains the role ID and the role session name of the role that is being assumed. The role ID is generated by AWS when the role is created.

    " + }, + "Arn":{ + "shape":"arnType", + "documentation":"

    The ARN of the temporary security credentials that are returned from the AssumeRole action. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

    " + } + }, + "documentation":"

    The identifiers for the temporary security credentials that the operation returns.

    " + }, + "Audience":{"type":"string"}, + "Credentials":{ + "type":"structure", + "required":[ + "AccessKeyId", + "SecretAccessKey", + "SessionToken", + "Expiration" + ], + "members":{ + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

    The access key ID that identifies the temporary security credentials.

    " + }, + "SecretAccessKey":{ + "shape":"accessKeySecretType", + "documentation":"

    The secret access key that can be used to sign requests.

    " + }, + "SessionToken":{ + "shape":"tokenType", + "documentation":"

    The token that users must pass to the service API to use the temporary credentials.

    " + }, + "Expiration":{ + "shape":"dateType", + "documentation":"

    The date on which the current credentials expire.

    " + } + }, + "documentation":"

    AWS credentials for API authentication.

    " + }, + "DecodeAuthorizationMessageRequest":{ + "type":"structure", + "required":["EncodedMessage"], + "members":{ + "EncodedMessage":{ + "shape":"encodedMessageType", + "documentation":"

    The encoded message that was returned with the response.

    " + } + } + }, + "DecodeAuthorizationMessageResponse":{ + "type":"structure", + "members":{ + "DecodedMessage":{ + "shape":"decodedMessageType", + "documentation":"

    An XML document that contains the decoded message.

    " + } + }, + "documentation":"

    A document that contains additional information about the authorization status of a request from an encoded message that is returned in response to an AWS request.

    " + }, + "ExpiredTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"expiredIdentityTokenMessage"} + }, + "documentation":"

    The web identity token that was passed is expired or is not valid. Get a new identity token from the identity provider and then retry the request.

    ", + "error":{ + "code":"ExpiredTokenException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "FederatedUser":{ + "type":"structure", + "required":[ + "FederatedUserId", + "Arn" + ], + "members":{ + "FederatedUserId":{ + "shape":"federatedIdType", + "documentation":"

    The string that identifies the federated user associated with the credentials, similar to the unique ID of an IAM user.

    " + }, + "Arn":{ + "shape":"arnType", + "documentation":"

    The ARN that specifies the federated user that is associated with the credentials. For more information about ARNs and how to use them in policies, see IAM Identifiers in Using IAM.

    " + } + }, + "documentation":"

    Identifiers for the federated user that is associated with the credentials.

    " + }, + "GetAccessKeyInfoRequest":{ + "type":"structure", + "required":["AccessKeyId"], + "members":{ + "AccessKeyId":{ + "shape":"accessKeyIdType", + "documentation":"

    The identifier of an access key.

    This parameter allows (through its regex pattern) a string of characters that can consist of any upper- or lowercased letter or digit.

    " + } + } + }, + "GetAccessKeyInfoResponse":{ + "type":"structure", + "members":{ + "Account":{ + "shape":"accountType", + "documentation":"

    The number used to identify the AWS account.

    " + } + } + }, + "GetCallerIdentityRequest":{ + "type":"structure", + "members":{ + } + }, + "GetCallerIdentityResponse":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"userIdType", + "documentation":"

    The unique identifier of the calling entity. The exact value depends on the type of entity that is making the call. The values returned are those listed in the aws:userid column in the Principal table found on the Policy Variables reference page in the IAM User Guide.

    " + }, + "Account":{ + "shape":"accountType", + "documentation":"

    The AWS account ID number of the account that owns or contains the calling entity.

    " + }, + "Arn":{ + "shape":"arnType", + "documentation":"

    The AWS ARN associated with the calling entity.

    " + } + }, + "documentation":"

    Contains the response to a successful GetCallerIdentity request, including information about the entity making the request.

    " + }, + "GetFederationTokenRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"userNameType", + "documentation":"

    The name of the federated user. The name is used as an identifier for the temporary security credentials (such as Bob). For example, you can reference the federated user name in a resource-based policy, such as in an Amazon S3 bucket policy.

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@-

    " + }, + "Policy":{ + "shape":"sessionPolicyDocumentType", + "documentation":"

    An IAM policy in JSON format that you want to use as an inline session policy.

    You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies.

    This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

    When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.

    The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. The JSON policy characters can be any ASCII character from the space character to the end of the valid character list (\\u0020 through \\u00FF). It can also include the tab (\\u0009), linefeed (\\u000A), and carriage return (\\u000D) characters.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    " + }, + "PolicyArns":{ + "shape":"policyDescriptorListType", + "documentation":"

    The Amazon Resource Names (ARNs) of the IAM managed policies that you want to use as a managed session policy. The policies must exist in the same account as the IAM user that is requesting federated access.

    You must pass an inline or managed session policy to this operation. You can pass a single JSON policy document to use as an inline session policy. You can also specify up to 10 managed policies to use as managed session policies. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

    When you pass session policies, the session permissions are the intersection of the IAM user policies and the session policies that you pass. This gives you a way to further restrict the permissions for a federated user. You cannot use session policies to grant more permissions than those that are defined in the permissions policy of the IAM user. For more information, see Session Policies in the IAM User Guide.

    The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

    " + }, + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

    The duration, in seconds, that the session should last. Acceptable durations for federation sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions obtained using AWS account root user credentials are restricted to a maximum of 3,600 seconds (one hour). If the specified duration is longer than one hour, the session obtained by using root user credentials defaults to one hour.

    " + } + } + }, + "GetFederationTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

    The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    " + }, + "FederatedUser":{ + "shape":"FederatedUser", + "documentation":"

    Identifiers for the federated user associated with the credentials (such as arn:aws:sts::123456789012:federated-user/Bob or 123456789012:Bob). You can use the federated user's ARN in your resource-based policies, such as an Amazon S3 bucket policy.

    " + }, + "PackedPolicySize":{ + "shape":"nonNegativeIntegerType", + "documentation":"

    A percentage value indicating the size of the policy in packed form. The service rejects policies for which the packed size is greater than 100 percent of the allowed value.

    " + } + }, + "documentation":"

    Contains the response to a successful GetFederationToken request, including temporary AWS credentials that can be used to make AWS requests.

    " + }, + "GetSessionTokenRequest":{ + "type":"structure", + "members":{ + "DurationSeconds":{ + "shape":"durationSecondsType", + "documentation":"

    The duration, in seconds, that the credentials should remain valid. Acceptable durations for IAM user sessions range from 900 seconds (15 minutes) to 129,600 seconds (36 hours), with 43,200 seconds (12 hours) as the default. Sessions for AWS account owners are restricted to a maximum of 3,600 seconds (one hour). If the duration is longer than one hour, the session for AWS account owners defaults to one hour.

    " + }, + "SerialNumber":{ + "shape":"serialNumberType", + "documentation":"

    The identification number of the MFA device that is associated with the IAM user who is making the GetSessionToken call. Specify this value if the IAM user has a policy that requires MFA authentication. The value is either the serial number for a hardware device (such as GAHT12345678) or an Amazon Resource Name (ARN) for a virtual device (such as arn:aws:iam::123456789012:mfa/user). You can find the device for an IAM user by going to the AWS Management Console and viewing the user's security credentials.

    The regex used to validate this parameter is a string of characters consisting of upper- and lower-case alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-

    " + }, + "TokenCode":{ + "shape":"tokenCodeType", + "documentation":"

    The value provided by the MFA device, if MFA is required. If any policy requires the IAM user to submit an MFA code, specify this value. If MFA authentication is required, the user must provide a code when requesting a set of temporary security credentials. A user who fails to provide the code receives an \"access denied\" response when requesting resources that require MFA authentication.

    The format for this parameter, as described by its regex pattern, is a sequence of six numeric digits.

    " + } + } + }, + "GetSessionTokenResponse":{ + "type":"structure", + "members":{ + "Credentials":{ + "shape":"Credentials", + "documentation":"

    The temporary security credentials, which include an access key ID, a secret access key, and a security (or session) token.

    The size of the security token that STS API operations return is not fixed. We strongly recommend that you make no assumptions about the maximum size.

    " + } + }, + "documentation":"

    Contains the response to a successful GetSessionToken request, including temporary AWS credentials that can be used to make AWS requests.

    " + }, + "IDPCommunicationErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"idpCommunicationErrorMessage"} + }, + "documentation":"

    The request could not be fulfilled because the non-AWS identity provider (IDP) that was asked to verify the incoming identity token could not be reached. This is often a transient error caused by network conditions. Retry the request a limited number of times so that you don't exceed the request rate. If the error persists, the non-AWS identity provider might be down or not responding.

    ", + "error":{ + "code":"IDPCommunicationError", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "IDPRejectedClaimException":{ + "type":"structure", + "members":{ + "message":{"shape":"idpRejectedClaimMessage"} + }, + "documentation":"

    The identity provider (IdP) reported that authentication failed. This might be because the claim is invalid.

    If this error is returned for the AssumeRoleWithWebIdentity operation, it can also mean that the claim has expired or has been explicitly revoked.

    ", + "error":{ + "code":"IDPRejectedClaim", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "InvalidAuthorizationMessageException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidAuthorizationMessage"} + }, + "documentation":"

    This error is returned if the message passed to DecodeAuthorizationMessage was invalid. This can happen if the token contains invalid characters, such as linebreaks.

    ", + "error":{ + "code":"InvalidAuthorizationMessageException", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "InvalidIdentityTokenException":{ + "type":"structure", + "members":{ + "message":{"shape":"invalidIdentityTokenMessage"} + }, + "documentation":"

    The web identity token that was passed could not be validated by AWS. Get a new identity token from the identity provider and then retry the request.

    ", + "error":{ + "code":"InvalidIdentityToken", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "Issuer":{"type":"string"}, + "MalformedPolicyDocumentException":{ + "type":"structure", + "members":{ + "message":{"shape":"malformedPolicyDocumentMessage"} + }, + "documentation":"

    The request was rejected because the policy document was malformed. The error message describes the specific error.

    ", + "error":{ + "code":"MalformedPolicyDocument", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "NameQualifier":{"type":"string"}, + "PackedPolicyTooLargeException":{ + "type":"structure", + "members":{ + "message":{"shape":"packedPolicyTooLargeMessage"} + }, + "documentation":"

    The request was rejected because the policy document was too large. The error message describes how big the policy document is, in packed form, as a percentage of what the API allows.

    ", + "error":{ + "code":"PackedPolicyTooLarge", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "PolicyDescriptorType":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"arnType", + "documentation":"

    The Amazon Resource Name (ARN) of the IAM managed policy to use as a session policy for the role. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

    " + } + }, + "documentation":"

    A reference to the IAM managed policy that is passed as a session policy for a role session or a federated user session.

    " + }, + "RegionDisabledException":{ + "type":"structure", + "members":{ + "message":{"shape":"regionDisabledMessage"} + }, + "documentation":"

    STS is not activated in the requested region for the account that is being asked to generate credentials. The account administrator must use the IAM console to activate STS in that region. For more information, see Activating and Deactivating AWS STS in an AWS Region in the IAM User Guide.

    ", + "error":{ + "code":"RegionDisabledException", + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "SAMLAssertionType":{ + "type":"string", + "max":100000, + "min":4 + }, + "Subject":{"type":"string"}, + "SubjectType":{"type":"string"}, + "accessKeyIdType":{ + "type":"string", + "max":128, + "min":16, + "pattern":"[\\w]*" + }, + "accessKeySecretType":{"type":"string"}, + "accountType":{"type":"string"}, + "arnType":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u007E\\u0085\\u00A0-\\uD7FF\\uE000-\\uFFFD\\u10000-\\u10FFFF]+" + }, + "assumedRoleIdType":{ + "type":"string", + "max":193, + "min":2, + "pattern":"[\\w+=,.@:-]*" + }, + "clientTokenType":{ + "type":"string", + "max":2048, + "min":4 + }, + "dateType":{"type":"timestamp"}, + "decodedMessageType":{"type":"string"}, + "durationSecondsType":{ + "type":"integer", + "max":129600, + "min":900 + }, + "encodedMessageType":{ + "type":"string", + "max":10240, + "min":1 + }, + "expiredIdentityTokenMessage":{"type":"string"}, + "externalIdType":{ + "type":"string", + "max":1224, + "min":2, + "pattern":"[\\w+=,.@:\\/-]*" + }, + "federatedIdType":{ + "type":"string", + "max":193, + "min":2, + "pattern":"[\\w+=,.@\\:-]*" + }, + "idpCommunicationErrorMessage":{"type":"string"}, + "idpRejectedClaimMessage":{"type":"string"}, + "invalidAuthorizationMessage":{"type":"string"}, + "invalidIdentityTokenMessage":{"type":"string"}, + "malformedPolicyDocumentMessage":{"type":"string"}, + "nonNegativeIntegerType":{ + "type":"integer", + "min":0 + }, + "packedPolicyTooLargeMessage":{"type":"string"}, + "policyDescriptorListType":{ + "type":"list", + "member":{"shape":"PolicyDescriptorType"} + }, + "regionDisabledMessage":{"type":"string"}, + "roleDurationSecondsType":{ + "type":"integer", + "max":43200, + "min":900 + }, + "roleSessionNameType":{ + "type":"string", + "max":64, + "min":2, + "pattern":"[\\w+=,.@-]*" + }, + "serialNumberType":{ + "type":"string", + "max":256, + "min":9, + "pattern":"[\\w+=/:,.@-]*" + }, + "sessionPolicyDocumentType":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+" + }, + "tokenCodeType":{ + "type":"string", + "max":6, + "min":6, + "pattern":"[\\d]*" + }, + "tokenType":{"type":"string"}, + "urlType":{ + "type":"string", + "max":2048, + "min":4 + }, + "userIdType":{"type":"string"}, + "userNameType":{ + "type":"string", + "max":32, + "min":2, + "pattern":"[\\w+=,.@-]*" + }, + "webIdentitySubjectType":{ + "type":"string", + "max":255, + "min":6 + } + }, + "documentation":"AWS Security Token Service

    The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.

    For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the IAM User Guide.

    If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

    Endpoints

    By default, AWS Security Token Service (STS) is available as a global service, and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. Global requests map to the US East (N. Virginia) region. AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase session token validity. For more information, see Managing AWS STS in an AWS Region in the IAM User Guide.

    Most AWS Regions are enabled for operations in all AWS services by default. Those Regions are automatically activated for use with AWS STS. Some Regions, such as Asia Pacific (Hong Kong), must be manually enabled. To learn more about enabling and disabling AWS Regions, see Managing AWS Regions in the AWS General Reference. When you enable these AWS Regions, they are automatically activated for use with AWS STS. You cannot activate the STS endpoint for a Region that is disabled. Tokens that are valid in all AWS Regions are longer than tokens that are valid in Regions that are enabled by default. Changing this setting might affect existing systems where you temporarily store tokens. For more information, see Managing Global Endpoint Session Tokens in the IAM User Guide.

    After you activate a Region for use with AWS STS, you can direct AWS STS API calls to that Region. AWS STS recommends that you provide both the Region and endpoint when you make calls to a Regional endpoint. You can provide the Region alone for manually enabled Regions, such as Asia Pacific (Hong Kong). In this case, the calls are directed to the STS Regional endpoint. However, if you provide the Region alone for Regions enabled by default, the calls are directed to the global endpoint of https://sts.amazonaws.com.

    To view the list of AWS STS endpoints and whether they are active by default, see Writing Code to Use AWS STS Regions in the IAM User Guide.

    Recording API requests

    STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on.

    If you activate AWS STS endpoints in Regions other than the default global endpoint, then you must also turn on CloudTrail logging in those Regions. This is necessary to record any AWS STS API calls that are made in those Regions. For more information, see Turning On CloudTrail in Additional Regions in the AWS CloudTrail User Guide.

    AWS Security Token Service (STS) is a global service with a single endpoint at https://sts.amazonaws.com. Calls to this endpoint are logged as calls to a global service. However, because this endpoint is physically located in the US East (N. Virginia) Region, your logs list us-east-1 as the event Region. CloudTrail does not write these logs to the US East (Ohio) Region unless you choose to include global service logs in that Region. CloudTrail writes calls to all Regional endpoints to their respective Regions. For example, calls to sts.us-east-2.amazonaws.com are published to the US East (Ohio) Region and calls to sts.eu-central-1.amazonaws.com are published to the EU (Frankfurt) Region.

    To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

    " +} diff --git a/aws/dist/botocore/data/support/2013-04-15/examples-1.json b/aws/dist/botocore/data/support/2013-04-15/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/support/2013-04-15/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/support/2013-04-15/paginators-1.json b/aws/dist/botocore/data/support/2013-04-15/paginators-1.json new file mode 100644 index 00000000..11bdb62c --- /dev/null +++ b/aws/dist/botocore/data/support/2013-04-15/paginators-1.json @@ -0,0 +1,16 @@ +{ + "pagination": { + "DescribeCases": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "cases" + }, + "DescribeCommunications": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "communications" + } + } +} diff --git a/aws/dist/botocore/data/support/2013-04-15/service-2.json b/aws/dist/botocore/data/support/2013-04-15/service-2.json new file mode 100644 index 00000000..5787cdd6 --- /dev/null +++ b/aws/dist/botocore/data/support/2013-04-15/service-2.json @@ -0,0 +1,1214 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2013-04-15", + "endpointPrefix":"support", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"AWS Support", + "serviceId":"Support", + "signatureVersion":"v4", + "targetPrefix":"AWSSupport_20130415", + "uid":"support-2013-04-15" + }, + "operations":{ + "AddAttachmentsToSet":{ + "name":"AddAttachmentsToSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddAttachmentsToSetRequest"}, + "output":{"shape":"AddAttachmentsToSetResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"AttachmentSetIdNotFound"}, + {"shape":"AttachmentSetExpired"}, + {"shape":"AttachmentSetSizeLimitExceeded"}, + {"shape":"AttachmentLimitExceeded"} + ], + "documentation":"

    Adds one or more attachments to an attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

    An attachment set is a temporary container for attachments that are to be added to a case or case communication. The set is available for one hour after it is created; the expiryTime returned in the response indicates when the set expires. The maximum number of attachments in a set is 3, and the maximum size of any attachment in the set is 5 MB.

    " + }, + "AddCommunicationToCase":{ + "name":"AddCommunicationToCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AddCommunicationToCaseRequest"}, + "output":{"shape":"AddCommunicationToCaseResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"CaseIdNotFound"}, + {"shape":"AttachmentSetIdNotFound"}, + {"shape":"AttachmentSetExpired"} + ], + "documentation":"

    Adds additional customer communication to an AWS Support case. You use the caseId value to identify the case to add communication to. You can list a set of email addresses to copy on the communication using the ccEmailAddresses value. The communicationBody value contains the text of the communication.

    The response indicates the success or failure of the request.

    This operation implements a subset of the features of the AWS Support Center.

    " + }, + "CreateCase":{ + "name":"CreateCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateCaseRequest"}, + "output":{"shape":"CreateCaseResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"CaseCreationLimitExceeded"}, + {"shape":"AttachmentSetIdNotFound"}, + {"shape":"AttachmentSetExpired"} + ], + "documentation":"

    Creates a new case in the AWS Support Center. This operation is modeled on the behavior of the AWS Support Center Create Case page. Its parameters require you to specify the following information:

    • issueType. The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"

      Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center.

      The caseId is not the displayId that appears in Support Center. You can use the DescribeCases API to get the displayId.

    • serviceCode. The code for an AWS service. You can get the possible serviceCode values by calling DescribeServices.

    • categoryCode. The category for the service defined for the serviceCode value. You also get the category code for a service by calling DescribeServices. Each AWS service defines its own set of category codes.

    • severityCode. A value that indicates the urgency of the case, which in turn determines the response time according to your service level agreement with AWS Support. You can get the possible severityCode values by calling DescribeSeverityLevels. For more information about the meaning of the codes, see SeverityLevel and Choosing a Severity.

    • subject. The Subject field on the AWS Support Center Create Case page.

    • communicationBody. The Description field on the AWS Support Center Create Case page.

    • attachmentSetId. The ID of a set of attachments that has been created by using AddAttachmentsToSet.

    • language. The human language in which AWS Support handles the case. English and Japanese are currently supported.

    • ccEmailAddresses. The AWS Support Center CC field on the Create Case page. You can list email addresses to be copied on any correspondence about the case. The account that opens the case is already identified by passing the AWS Credentials in the HTTP POST method or in a method or function call from one of the programming languages supported by an AWS SDK.

    To add additional communication or attachments to an existing case, use AddCommunicationToCase.

    A successful CreateCase request returns an AWS Support case number. Case numbers are used by the DescribeCases operation to retrieve existing AWS Support cases.

    " + }, + "DescribeAttachment":{ + "name":"DescribeAttachment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAttachmentRequest"}, + "output":{"shape":"DescribeAttachmentResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"DescribeAttachmentLimitExceeded"}, + {"shape":"AttachmentIdNotFound"} + ], + "documentation":"

    Returns the attachment that has the specified ID. Attachment IDs are generated by the case management system when you add an attachment to a case or case communication. Attachment IDs are returned in the AttachmentDetails objects that are returned by the DescribeCommunications operation.

    " + }, + "DescribeCases":{ + "name":"DescribeCases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCasesRequest"}, + "output":{"shape":"DescribeCasesResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"CaseIdNotFound"} + ], + "documentation":"

    Returns a list of cases that you specify by passing one or more case IDs. In addition, you can filter the cases by date by setting values for the afterTime and beforeTime request parameters. You can set values for the includeResolvedCases and includeCommunications request parameters to control how much information is returned.

    Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

    The response returns the following in JSON format:

    • One or more CaseDetails data types.

    • One or more nextToken values, which specify where to paginate the returned records represented by the CaseDetails objects.

    " + }, + "DescribeCommunications":{ + "name":"DescribeCommunications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeCommunicationsRequest"}, + "output":{"shape":"DescribeCommunicationsResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"CaseIdNotFound"} + ], + "documentation":"

    Returns communications (and attachments) for one or more support cases. You can use the afterTime and beforeTime parameters to filter by date. You can use the caseId parameter to restrict the results to a particular case.

    Case data is available for 12 months after creation. If a case was created more than 12 months ago, a request for data might cause an error.

    You can use the maxResults and nextToken parameters to control the pagination of the result set. Set maxResults to the number of cases you want displayed on each page, and use nextToken to specify the resumption of pagination.

    " + }, + "DescribeServices":{ + "name":"DescribeServices", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServicesRequest"}, + "output":{"shape":"DescribeServicesResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the current list of AWS services and a list of service categories that applies to each one. You then use service names and categories in your CreateCase requests. Each AWS service has its own set of categories.

    The service codes and category codes correspond to the values that are displayed in the Service and Category drop-down lists on the AWS Support Center Create Case page. The values in those fields, however, do not necessarily match the service codes and categories returned by the DescribeServices request. Always use the service codes and categories obtained programmatically. This practice ensures that you always have the most recent set of service and category codes.

    " + }, + "DescribeSeverityLevels":{ + "name":"DescribeSeverityLevels", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSeverityLevelsRequest"}, + "output":{"shape":"DescribeSeverityLevelsResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the list of severity levels that you can assign to an AWS Support case. The severity level for a case is also a field in the CaseDetails data type included in any CreateCase request.

    " + }, + "DescribeTrustedAdvisorCheckRefreshStatuses":{ + "name":"DescribeTrustedAdvisorCheckRefreshStatuses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesRequest"}, + "output":{"shape":"DescribeTrustedAdvisorCheckRefreshStatusesResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the refresh status of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

    Some checks are refreshed automatically, and their refresh statuses cannot be retrieved by using this operation. Use of the DescribeTrustedAdvisorCheckRefreshStatuses operation for these checks causes an InvalidParameterValue error.

    " + }, + "DescribeTrustedAdvisorCheckResult":{ + "name":"DescribeTrustedAdvisorCheckResult", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckResultRequest"}, + "output":{"shape":"DescribeTrustedAdvisorCheckResultResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the results of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

    The response contains a TrustedAdvisorCheckResult object, which contains these three objects:

    In addition, the response contains these fields:

    • status. The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

    • timestamp. The time of the last refresh of the check.

    • checkId. The unique identifier for the check.

    " + }, + "DescribeTrustedAdvisorCheckSummaries":{ + "name":"DescribeTrustedAdvisorCheckSummaries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorCheckSummariesRequest"}, + "output":{"shape":"DescribeTrustedAdvisorCheckSummariesResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns the summaries of the results of the Trusted Advisor checks that have the specified check IDs. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

    The response contains an array of TrustedAdvisorCheckSummary objects.

    " + }, + "DescribeTrustedAdvisorChecks":{ + "name":"DescribeTrustedAdvisorChecks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTrustedAdvisorChecksRequest"}, + "output":{"shape":"DescribeTrustedAdvisorChecksResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Returns information about all available Trusted Advisor checks, including name, ID, category, description, and metadata. You must specify a language code; English (\"en\") and Japanese (\"ja\") are currently supported. The response contains a TrustedAdvisorCheckDescription for each check. The region must be set to us-east-1.

    " + }, + "RefreshTrustedAdvisorCheck":{ + "name":"RefreshTrustedAdvisorCheck", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RefreshTrustedAdvisorCheckRequest"}, + "output":{"shape":"RefreshTrustedAdvisorCheckResponse"}, + "errors":[ + {"shape":"InternalServerError"} + ], + "documentation":"

    Requests a refresh of the Trusted Advisor check that has the specified check ID. Check IDs can be obtained by calling DescribeTrustedAdvisorChecks.

    Some checks are refreshed automatically, and they cannot be refreshed by using this operation. Use of the RefreshTrustedAdvisorCheck operation for these checks causes an InvalidParameterValue error.

    The response contains a TrustedAdvisorCheckRefreshStatus object, which contains these fields:

    • status. The refresh status of the check:

      • none: The check is not refreshed or the non-success status exceeds the timeout

      • enqueued: The check refresh requests has entered the refresh queue

      • processing: The check refresh request is picked up by the rule processing engine

      • success: The check is successfully refreshed

      • abandoned: The check refresh has failed

    • millisUntilNextRefreshable. The amount of time, in milliseconds, until the check is eligible for refresh.

    • checkId. The unique identifier for the check.

    " + }, + "ResolveCase":{ + "name":"ResolveCase", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResolveCaseRequest"}, + "output":{"shape":"ResolveCaseResponse"}, + "errors":[ + {"shape":"InternalServerError"}, + {"shape":"CaseIdNotFound"} + ], + "documentation":"

    Takes a caseId and returns the initial state of the case along with the state of the case after the call to ResolveCase completed.

    " + } + }, + "shapes":{ + "AddAttachmentsToSetRequest":{ + "type":"structure", + "required":["attachments"], + "members":{ + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

    The ID of the attachment set. If an attachmentSetId is not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId is specified, the attachments are added to the specified set, if it exists.

    " + }, + "attachments":{ + "shape":"Attachments", + "documentation":"

    One or more attachments to add to the set. The limit is 3 attachments per set, and the size limit is 5 MB per attachment.

    " + } + }, + "documentation":"

    " + }, + "AddAttachmentsToSetResponse":{ + "type":"structure", + "members":{ + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

    The ID of the attachment set. If an attachmentSetId was not specified, a new attachment set is created, and the ID of the set is returned in the response. If an attachmentSetId was specified, the attachments are added to the specified set, if it exists.

    " + }, + "expiryTime":{ + "shape":"ExpiryTime", + "documentation":"

    The time and date when the attachment set expires.

    " + } + }, + "documentation":"

    The ID and expiry time of the attachment set returned by the AddAttachmentsToSet operation.

    " + }, + "AddCommunicationToCaseRequest":{ + "type":"structure", + "required":["communicationBody"], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + }, + "communicationBody":{ + "shape":"CommunicationBody", + "documentation":"

    The body of an email communication to add to the support case.

    " + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

    The email addresses in the CC line of an email to be added to the support case.

    " + }, + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

    The ID of a set of one or more attachments for the communication to add to the case. Create the set by calling AddAttachmentsToSet

    " + } + }, + "documentation":"

    To be written.

    " + }, + "AddCommunicationToCaseResponse":{ + "type":"structure", + "members":{ + "result":{ + "shape":"Result", + "documentation":"

    True if AddCommunicationToCase succeeds. Otherwise, returns an error.

    " + } + }, + "documentation":"

    The result of the AddCommunicationToCase operation.

    " + }, + "AfterTime":{"type":"string"}, + "Attachment":{ + "type":"structure", + "members":{ + "fileName":{ + "shape":"FileName", + "documentation":"

    The name of the attachment file.

    " + }, + "data":{ + "shape":"Data", + "documentation":"

    The content of the attachment file.

    " + } + }, + "documentation":"

    An attachment to a case communication. The attachment consists of the file name and the content of the file.

    " + }, + "AttachmentDetails":{ + "type":"structure", + "members":{ + "attachmentId":{ + "shape":"AttachmentId", + "documentation":"

    The ID of the attachment.

    " + }, + "fileName":{ + "shape":"FileName", + "documentation":"

    The file name of the attachment.

    " + } + }, + "documentation":"

    The file name and ID of an attachment to a case communication. You can use the ID to retrieve the attachment with the DescribeAttachment operation.

    " + }, + "AttachmentId":{"type":"string"}, + "AttachmentIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    An attachment with the specified ID could not be found.

    " + } + }, + "documentation":"

    An attachment with the specified ID could not be found.

    ", + "exception":true + }, + "AttachmentLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The limit for the number of attachment sets created in a short period of time has been exceeded.

    " + } + }, + "documentation":"

    The limit for the number of attachment sets created in a short period of time has been exceeded.

    ", + "exception":true + }, + "AttachmentSet":{ + "type":"list", + "member":{"shape":"AttachmentDetails"} + }, + "AttachmentSetExpired":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

    " + } + }, + "documentation":"

    The expiration time of the attachment set has passed. The set expires 1 hour after it is created.

    ", + "exception":true + }, + "AttachmentSetId":{"type":"string"}, + "AttachmentSetIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    An attachment set with the specified ID could not be found.

    " + } + }, + "documentation":"

    An attachment set with the specified ID could not be found.

    ", + "exception":true + }, + "AttachmentSetSizeLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

    " + } + }, + "documentation":"

    A limit for the size of an attachment set has been exceeded. The limits are 3 attachments and 5 MB per attachment.

    ", + "exception":true + }, + "Attachments":{ + "type":"list", + "member":{"shape":"Attachment"} + }, + "BeforeTime":{"type":"string"}, + "Boolean":{"type":"boolean"}, + "CaseCreationLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    An error message that indicates that you have exceeded the number of cases you can have open.

    " + } + }, + "documentation":"

    The case creation limit for the account has been exceeded.

    ", + "exception":true + }, + "CaseDetails":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + }, + "displayId":{ + "shape":"DisplayId", + "documentation":"

    The ID displayed for the case in the AWS Support Center. This is a numeric string.

    " + }, + "subject":{ + "shape":"Subject", + "documentation":"

    The subject line for the case in the AWS Support Center.

    " + }, + "status":{ + "shape":"Status", + "documentation":"

    The status of the case. Valid values: resolved | pending-customer-action | opened | unassigned | work-in-progress.

    " + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"

    The code for the AWS service. You can get a list of codes and the corresponding service names by calling DescribeServices.

    " + }, + "categoryCode":{ + "shape":"CategoryCode", + "documentation":"

    The category of problem for the AWS Support case.

    " + }, + "severityCode":{ + "shape":"SeverityCode", + "documentation":"

    The code for the severity level returned by the call to DescribeSeverityLevels.

    " + }, + "submittedBy":{ + "shape":"SubmittedBy", + "documentation":"

    The email address of the account that submitted the case.

    " + }, + "timeCreated":{ + "shape":"TimeCreated", + "documentation":"

    The time that the case was case created in the AWS Support Center.

    " + }, + "recentCommunications":{ + "shape":"RecentCaseCommunications", + "documentation":"

    The five most recent communications between you and AWS Support Center, including the IDs of any attachments to the communications. Also includes a nextToken that you can use to retrieve earlier communications.

    " + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

    The email addresses that receive copies of communication about the case.

    " + }, + "language":{ + "shape":"Language", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + } + }, + "documentation":"

    A JSON-formatted object that contains the metadata for a support case. It is contained the response from a DescribeCases request. CaseDetails contains the following fields:

    • caseId. The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47.

    • categoryCode. The category of problem for the AWS Support case. Corresponds to the CategoryCode values returned by a call to DescribeServices.

    • displayId. The identifier for the case on pages in the AWS Support Center.

    • language. The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    • recentCommunications. One or more Communication objects. Fields of these objects are attachments, body, caseId, submittedBy, and timeCreated.

    • nextToken. A resumption point for pagination.

    • serviceCode. The identifier for the AWS service that corresponds to the service code defined in the call to DescribeServices.

    • severityCode. The severity code assigned to the case. Contains one of the values returned by the call to DescribeSeverityLevels. The possible values are: low, normal, high, urgent, and critical.

    • status. The status of the case in the AWS Support Center. The possible values are: resolved, pending-customer-action, opened, unassigned, and work-in-progress.

    • subject. The subject line of the case.

    • submittedBy. The email address of the account that submitted the case.

    • timeCreated. The time the case was created, in ISO-8601 format.

    " + }, + "CaseId":{"type":"string"}, + "CaseIdList":{ + "type":"list", + "member":{"shape":"CaseId"}, + "max":100, + "min":0 + }, + "CaseIdNotFound":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The requested CaseId could not be located.

    " + } + }, + "documentation":"

    The requested caseId could not be located.

    ", + "exception":true + }, + "CaseList":{ + "type":"list", + "member":{"shape":"CaseDetails"} + }, + "CaseStatus":{"type":"string"}, + "Category":{ + "type":"structure", + "members":{ + "code":{ + "shape":"CategoryCode", + "documentation":"

    The category code for the support case.

    " + }, + "name":{ + "shape":"CategoryName", + "documentation":"

    The category name for the support case.

    " + } + }, + "documentation":"

    A JSON-formatted name/value pair that represents the category name and category code of the problem, selected from the DescribeServices response for each AWS service.

    " + }, + "CategoryCode":{"type":"string"}, + "CategoryList":{ + "type":"list", + "member":{"shape":"Category"} + }, + "CategoryName":{"type":"string"}, + "CcEmailAddress":{"type":"string"}, + "CcEmailAddressList":{ + "type":"list", + "member":{"shape":"CcEmailAddress"}, + "max":10, + "min":0 + }, + "Communication":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + }, + "body":{ + "shape":"CommunicationBody", + "documentation":"

    The text of the communication between the customer and AWS Support.

    " + }, + "submittedBy":{ + "shape":"SubmittedBy", + "documentation":"

    The identity of the account that submitted, or responded to, the support case. Customer entries include the role or IAM user as well as the email address. For example, \"AdminRole (Role) <someone@example.com>. Entries from the AWS Support team display \"Amazon Web Services,\" and do not show an email address.

    " + }, + "timeCreated":{ + "shape":"TimeCreated", + "documentation":"

    The time the communication was created.

    " + }, + "attachmentSet":{ + "shape":"AttachmentSet", + "documentation":"

    Information about the attachments to the case communication.

    " + } + }, + "documentation":"

    A communication associated with an AWS Support case. The communication consists of the case ID, the message body, attachment information, the submitter of the communication, and the date and time of the communication.

    " + }, + "CommunicationBody":{ + "type":"string", + "max":8000, + "min":1 + }, + "CommunicationList":{ + "type":"list", + "member":{"shape":"Communication"} + }, + "CreateCaseRequest":{ + "type":"structure", + "required":[ + "subject", + "communicationBody" + ], + "members":{ + "subject":{ + "shape":"Subject", + "documentation":"

    The title of the AWS Support case.

    " + }, + "serviceCode":{ + "shape":"ServiceCode", + "documentation":"

    The code for the AWS service returned by the call to DescribeServices.

    " + }, + "severityCode":{ + "shape":"SeverityCode", + "documentation":"

    The code for the severity level returned by the call to DescribeSeverityLevels.

    The availability of severity levels depends on the support plan for the account.

    " + }, + "categoryCode":{ + "shape":"CategoryCode", + "documentation":"

    The category of problem for the AWS Support case.

    " + }, + "communicationBody":{ + "shape":"CommunicationBody", + "documentation":"

    The communication body text when you create an AWS Support case by calling CreateCase.

    " + }, + "ccEmailAddresses":{ + "shape":"CcEmailAddressList", + "documentation":"

    A list of email addresses that AWS Support copies on case correspondence.

    " + }, + "language":{ + "shape":"Language", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + }, + "issueType":{ + "shape":"IssueType", + "documentation":"

    The type of issue for the case. You can specify either \"customer-service\" or \"technical.\" If you do not indicate a value, the default is \"technical.\"

    Service limit increases are not supported by the Support API; you must submit service limit increase requests in Support Center.

    " + }, + "attachmentSetId":{ + "shape":"AttachmentSetId", + "documentation":"

    The ID of a set of one or more attachments for the case. Create the set by using AddAttachmentsToSet.

    " + } + } + }, + "CreateCaseResponse":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + } + }, + "documentation":"

    The AWS Support case ID returned by a successful completion of the CreateCase operation.

    " + }, + "Data":{"type":"blob"}, + "DescribeAttachmentLimitExceeded":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

    " + } + }, + "documentation":"

    The limit for the number of DescribeAttachment requests in a short period of time has been exceeded.

    ", + "exception":true + }, + "DescribeAttachmentRequest":{ + "type":"structure", + "required":["attachmentId"], + "members":{ + "attachmentId":{ + "shape":"AttachmentId", + "documentation":"

    The ID of the attachment to return. Attachment IDs are returned by the DescribeCommunications operation.

    " + } + } + }, + "DescribeAttachmentResponse":{ + "type":"structure", + "members":{ + "attachment":{ + "shape":"Attachment", + "documentation":"

    The attachment content and file name.

    " + } + }, + "documentation":"

    The content and file name of the attachment returned by the DescribeAttachment operation.

    " + }, + "DescribeCasesRequest":{ + "type":"structure", + "members":{ + "caseIdList":{ + "shape":"CaseIdList", + "documentation":"

    A list of ID numbers of the support cases you want returned. The maximum number of cases is 100.

    " + }, + "displayId":{ + "shape":"DisplayId", + "documentation":"

    The ID displayed for a case in the AWS Support Center user interface.

    " + }, + "afterTime":{ + "shape":"AfterTime", + "documentation":"

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    " + }, + "beforeTime":{ + "shape":"BeforeTime", + "documentation":"

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    " + }, + "includeResolvedCases":{ + "shape":"IncludeResolvedCases", + "documentation":"

    Specifies whether resolved support cases should be included in the DescribeCases results. The default is false.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    A resumption point for pagination.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return before paginating.

    " + }, + "language":{ + "shape":"Language", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + }, + "includeCommunications":{ + "shape":"IncludeCommunications", + "documentation":"

    Specifies whether communications should be included in the DescribeCases results. The default is true.

    " + } + } + }, + "DescribeCasesResponse":{ + "type":"structure", + "members":{ + "cases":{ + "shape":"CaseList", + "documentation":"

    The details for the cases that match the request.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    A resumption point for pagination.

    " + } + }, + "documentation":"

    Returns an array of CaseDetails objects and a nextToken that defines a point for pagination in the result set.

    " + }, + "DescribeCommunicationsRequest":{ + "type":"structure", + "required":["caseId"], + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + }, + "beforeTime":{ + "shape":"BeforeTime", + "documentation":"

    The end date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    " + }, + "afterTime":{ + "shape":"AfterTime", + "documentation":"

    The start date for a filtered date search on support case communications. Case communications are available for 12 months after creation.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    A resumption point for pagination.

    " + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return before paginating.

    " + } + } + }, + "DescribeCommunicationsResponse":{ + "type":"structure", + "members":{ + "communications":{ + "shape":"CommunicationList", + "documentation":"

    The communications for the case.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    A resumption point for pagination.

    " + } + }, + "documentation":"

    The communications returned by the DescribeCommunications operation.

    " + }, + "DescribeServicesRequest":{ + "type":"structure", + "members":{ + "serviceCodeList":{ + "shape":"ServiceCodeList", + "documentation":"

    A JSON-formatted list of service codes available for AWS services.

    " + }, + "language":{ + "shape":"Language", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + } + } + }, + "DescribeServicesResponse":{ + "type":"structure", + "members":{ + "services":{ + "shape":"ServiceList", + "documentation":"

    A JSON-formatted list of AWS services.

    " + } + }, + "documentation":"

    The list of AWS services returned by the DescribeServices operation.

    " + }, + "DescribeSeverityLevelsRequest":{ + "type":"structure", + "members":{ + "language":{ + "shape":"Language", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + } + } + }, + "DescribeSeverityLevelsResponse":{ + "type":"structure", + "members":{ + "severityLevels":{ + "shape":"SeverityLevelsList", + "documentation":"

    The available severity levels for the support case. Available severity levels are defined by your service level agreement with AWS.

    " + } + }, + "documentation":"

    The list of severity levels returned by the DescribeSeverityLevels operation.

    " + }, + "DescribeTrustedAdvisorCheckRefreshStatusesRequest":{ + "type":"structure", + "required":["checkIds"], + "members":{ + "checkIds":{ + "shape":"StringList", + "documentation":"

    The IDs of the Trusted Advisor checks to get the status of. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

    " + } + }, + "documentation":"

    " + }, + "DescribeTrustedAdvisorCheckRefreshStatusesResponse":{ + "type":"structure", + "required":["statuses"], + "members":{ + "statuses":{ + "shape":"TrustedAdvisorCheckRefreshStatusList", + "documentation":"

    The refresh status of the specified Trusted Advisor checks.

    " + } + }, + "documentation":"

    The statuses of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckRefreshStatuses operation.

    " + }, + "DescribeTrustedAdvisorCheckResultRequest":{ + "type":"structure", + "required":["checkId"], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check.

    " + }, + "language":{ + "shape":"String", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + } + }, + "documentation":"

    " + }, + "DescribeTrustedAdvisorCheckResultResponse":{ + "type":"structure", + "members":{ + "result":{ + "shape":"TrustedAdvisorCheckResult", + "documentation":"

    The detailed results of the Trusted Advisor check.

    " + } + }, + "documentation":"

    The result of the Trusted Advisor check returned by the DescribeTrustedAdvisorCheckResult operation.

    " + }, + "DescribeTrustedAdvisorCheckSummariesRequest":{ + "type":"structure", + "required":["checkIds"], + "members":{ + "checkIds":{ + "shape":"StringList", + "documentation":"

    The IDs of the Trusted Advisor checks.

    " + } + } + }, + "DescribeTrustedAdvisorCheckSummariesResponse":{ + "type":"structure", + "required":["summaries"], + "members":{ + "summaries":{ + "shape":"TrustedAdvisorCheckSummaryList", + "documentation":"

    The summary information for the requested Trusted Advisor checks.

    " + } + }, + "documentation":"

    The summaries of the Trusted Advisor checks returned by the DescribeTrustedAdvisorCheckSummaries operation.

    " + }, + "DescribeTrustedAdvisorChecksRequest":{ + "type":"structure", + "required":["language"], + "members":{ + "language":{ + "shape":"String", + "documentation":"

    The ISO 639-1 code for the language in which AWS provides support. AWS Support currently supports English (\"en\") and Japanese (\"ja\"). Language parameters must be passed explicitly for operations that take them.

    " + } + }, + "documentation":"

    " + }, + "DescribeTrustedAdvisorChecksResponse":{ + "type":"structure", + "required":["checks"], + "members":{ + "checks":{ + "shape":"TrustedAdvisorCheckList", + "documentation":"

    Information about all available Trusted Advisor checks.

    " + } + }, + "documentation":"

    Information about the Trusted Advisor checks returned by the DescribeTrustedAdvisorChecks operation.

    " + }, + "DisplayId":{"type":"string"}, + "Double":{"type":"double"}, + "ErrorMessage":{"type":"string"}, + "ExpiryTime":{"type":"string"}, + "FileName":{"type":"string"}, + "IncludeCommunications":{"type":"boolean"}, + "IncludeResolvedCases":{"type":"boolean"}, + "InternalServerError":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    An internal server error occurred.

    " + } + }, + "documentation":"

    An internal server error occurred.

    ", + "exception":true, + "fault":true + }, + "IssueType":{"type":"string"}, + "Language":{"type":"string"}, + "Long":{"type":"long"}, + "MaxResults":{ + "type":"integer", + "max":100, + "min":10 + }, + "NextToken":{"type":"string"}, + "RecentCaseCommunications":{ + "type":"structure", + "members":{ + "communications":{ + "shape":"CommunicationList", + "documentation":"

    The five most recent communications associated with the case.

    " + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

    A resumption point for pagination.

    " + } + }, + "documentation":"

    The five most recent communications associated with the case.

    " + }, + "RefreshTrustedAdvisorCheckRequest":{ + "type":"structure", + "required":["checkId"], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check to refresh. Note: Specifying the check ID of a check that is automatically refreshed causes an InvalidParameterValue error.

    " + } + }, + "documentation":"

    " + }, + "RefreshTrustedAdvisorCheckResponse":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"TrustedAdvisorCheckRefreshStatus", + "documentation":"

    The current refresh status for a check, including the amount of time until the check is eligible for refresh.

    " + } + }, + "documentation":"

    The current refresh status of a Trusted Advisor check.

    " + }, + "ResolveCaseRequest":{ + "type":"structure", + "members":{ + "caseId":{ + "shape":"CaseId", + "documentation":"

    The AWS Support case ID requested or returned in the call. The case ID is an alphanumeric string formatted as shown in this example: case-12345678910-2013-c4c1d2bf33c5cf47

    " + } + } + }, + "ResolveCaseResponse":{ + "type":"structure", + "members":{ + "initialCaseStatus":{ + "shape":"CaseStatus", + "documentation":"

    The status of the case when the ResolveCase request was sent.

    " + }, + "finalCaseStatus":{ + "shape":"CaseStatus", + "documentation":"

    The status of the case after the ResolveCase request was processed.

    " + } + }, + "documentation":"

    The status of the case returned by the ResolveCase operation.

    " + }, + "Result":{"type":"boolean"}, + "Service":{ + "type":"structure", + "members":{ + "code":{ + "shape":"ServiceCode", + "documentation":"

    The code for an AWS service returned by the DescribeServices response. The name element contains the corresponding friendly name.

    " + }, + "name":{ + "shape":"ServiceName", + "documentation":"

    The friendly name for an AWS service. The code element contains the corresponding code.

    " + }, + "categories":{ + "shape":"CategoryList", + "documentation":"

    A list of categories that describe the type of support issue a case describes. Categories consist of a category name and a category code. Category names and codes are passed to AWS Support when you call CreateCase.

    " + } + }, + "documentation":"

    Information about an AWS service returned by the DescribeServices operation.

    " + }, + "ServiceCode":{"type":"string"}, + "ServiceCodeList":{ + "type":"list", + "member":{"shape":"ServiceCode"}, + "max":100, + "min":0 + }, + "ServiceList":{ + "type":"list", + "member":{"shape":"Service"} + }, + "ServiceName":{"type":"string"}, + "SeverityCode":{"type":"string"}, + "SeverityLevel":{ + "type":"structure", + "members":{ + "code":{ + "shape":"SeverityLevelCode", + "documentation":"

    The code for case severity level.

    Valid values: low | normal | high | urgent | critical

    " + }, + "name":{ + "shape":"SeverityLevelName", + "documentation":"

    The name of the severity level that corresponds to the severity level code.

    The values returned by the API differ from the values that are displayed in the AWS Support Center. For example, for the code \"low\", the API name is \"Low\", but the name in the Support Center is \"General guidance\". These are the Support Center code/name mappings:

    • low: General guidance

    • normal: System impaired

    • high: Production system impaired

    • urgent: Production system down

    • critical: Business-critical system down

    For more information, see Choosing a Severity

    " + } + }, + "documentation":"

    A code and name pair that represents the severity level of a support case. The available values depend on the support plan for the account. For more information, see Choosing a Severity.

    " + }, + "SeverityLevelCode":{"type":"string"}, + "SeverityLevelName":{"type":"string"}, + "SeverityLevelsList":{ + "type":"list", + "member":{"shape":"SeverityLevel"} + }, + "Status":{"type":"string"}, + "String":{"type":"string"}, + "StringList":{ + "type":"list", + "member":{"shape":"String"} + }, + "Subject":{"type":"string"}, + "SubmittedBy":{"type":"string"}, + "TimeCreated":{"type":"string"}, + "TrustedAdvisorCategorySpecificSummary":{ + "type":"structure", + "members":{ + "costOptimizing":{ + "shape":"TrustedAdvisorCostOptimizingSummary", + "documentation":"

    The summary information about cost savings for a Trusted Advisor check that is in the Cost Optimizing category.

    " + } + }, + "documentation":"

    The container for summary information that relates to the category of the Trusted Advisor check.

    " + }, + "TrustedAdvisorCheckDescription":{ + "type":"structure", + "required":[ + "id", + "name", + "description", + "category", + "metadata" + ], + "members":{ + "id":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check.

    " + }, + "name":{ + "shape":"String", + "documentation":"

    The display name for the Trusted Advisor check.

    " + }, + "description":{ + "shape":"String", + "documentation":"

    The description of the Trusted Advisor check, which includes the alert criteria and recommended actions (contains HTML markup).

    " + }, + "category":{ + "shape":"String", + "documentation":"

    The category of the Trusted Advisor check.

    " + }, + "metadata":{ + "shape":"StringList", + "documentation":"

    The column headings for the data returned by the Trusted Advisor check. The order of the headings corresponds to the order of the data in the Metadata element of the TrustedAdvisorResourceDetail for the check. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

    " + } + }, + "documentation":"

    The description and metadata for a Trusted Advisor check.

    " + }, + "TrustedAdvisorCheckList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckDescription"} + }, + "TrustedAdvisorCheckRefreshStatus":{ + "type":"structure", + "required":[ + "checkId", + "status", + "millisUntilNextRefreshable" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check.

    " + }, + "status":{ + "shape":"String", + "documentation":"

    The status of the Trusted Advisor check for which a refresh has been requested:

    • none: The check is not refreshed or the non-success status exceeds the timeout

    • enqueued: The check refresh requests has entered the refresh queue

    • processing: The check refresh request is picked up by the rule processing engine

    • success: The check is successfully refreshed

    • abandoned: The check refresh has failed

    " + }, + "millisUntilNextRefreshable":{ + "shape":"Long", + "documentation":"

    The amount of time, in milliseconds, until the Trusted Advisor check is eligible for refresh.

    " + } + }, + "documentation":"

    The refresh status of a Trusted Advisor check.

    " + }, + "TrustedAdvisorCheckRefreshStatusList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckRefreshStatus"} + }, + "TrustedAdvisorCheckResult":{ + "type":"structure", + "required":[ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary", + "flaggedResources" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check.

    " + }, + "timestamp":{ + "shape":"String", + "documentation":"

    The time of the last refresh of the check.

    " + }, + "status":{ + "shape":"String", + "documentation":"

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

    " + }, + "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, + "categorySpecificSummary":{ + "shape":"TrustedAdvisorCategorySpecificSummary", + "documentation":"

    Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

    " + }, + "flaggedResources":{ + "shape":"TrustedAdvisorResourceDetailList", + "documentation":"

    The details about each resource listed in the check result.

    " + } + }, + "documentation":"

    The results of a Trusted Advisor check returned by DescribeTrustedAdvisorCheckResult.

    " + }, + "TrustedAdvisorCheckSummary":{ + "type":"structure", + "required":[ + "checkId", + "timestamp", + "status", + "resourcesSummary", + "categorySpecificSummary" + ], + "members":{ + "checkId":{ + "shape":"String", + "documentation":"

    The unique identifier for the Trusted Advisor check.

    " + }, + "timestamp":{ + "shape":"String", + "documentation":"

    The time of the last refresh of the check.

    " + }, + "status":{ + "shape":"String", + "documentation":"

    The alert status of the check: \"ok\" (green), \"warning\" (yellow), \"error\" (red), or \"not_available\".

    " + }, + "hasFlaggedResources":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the Trusted Advisor check has flagged resources.

    " + }, + "resourcesSummary":{"shape":"TrustedAdvisorResourcesSummary"}, + "categorySpecificSummary":{ + "shape":"TrustedAdvisorCategorySpecificSummary", + "documentation":"

    Summary information that relates to the category of the check. Cost Optimizing is the only category that is currently supported.

    " + } + }, + "documentation":"

    A summary of a Trusted Advisor check result, including the alert status, last refresh, and number of resources examined.

    " + }, + "TrustedAdvisorCheckSummaryList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorCheckSummary"} + }, + "TrustedAdvisorCostOptimizingSummary":{ + "type":"structure", + "required":[ + "estimatedMonthlySavings", + "estimatedPercentMonthlySavings" + ], + "members":{ + "estimatedMonthlySavings":{ + "shape":"Double", + "documentation":"

    The estimated monthly savings that might be realized if the recommended actions are taken.

    " + }, + "estimatedPercentMonthlySavings":{ + "shape":"Double", + "documentation":"

    The estimated percentage of savings that might be realized if the recommended actions are taken.

    " + } + }, + "documentation":"

    The estimated cost savings that might be realized if the recommended actions are taken.

    " + }, + "TrustedAdvisorResourceDetail":{ + "type":"structure", + "required":[ + "status", + "resourceId", + "metadata" + ], + "members":{ + "status":{ + "shape":"String", + "documentation":"

    The status code for the resource identified in the Trusted Advisor check.

    " + }, + "region":{ + "shape":"String", + "documentation":"

    The AWS region in which the identified resource is located.

    " + }, + "resourceId":{ + "shape":"String", + "documentation":"

    The unique identifier for the identified resource.

    " + }, + "isSuppressed":{ + "shape":"Boolean", + "documentation":"

    Specifies whether the AWS resource was ignored by Trusted Advisor because it was marked as suppressed by the user.

    " + }, + "metadata":{ + "shape":"StringList", + "documentation":"

    Additional information about the identified resource. The exact metadata and its order can be obtained by inspecting the TrustedAdvisorCheckDescription object returned by the call to DescribeTrustedAdvisorChecks. Metadata contains all the data that is shown in the Excel download, even in those cases where the UI shows just summary data.

    " + } + }, + "documentation":"

    Contains information about a resource identified by a Trusted Advisor check.

    " + }, + "TrustedAdvisorResourceDetailList":{ + "type":"list", + "member":{"shape":"TrustedAdvisorResourceDetail"} + }, + "TrustedAdvisorResourcesSummary":{ + "type":"structure", + "required":[ + "resourcesProcessed", + "resourcesFlagged", + "resourcesIgnored", + "resourcesSuppressed" + ], + "members":{ + "resourcesProcessed":{ + "shape":"Long", + "documentation":"

    The number of AWS resources that were analyzed by the Trusted Advisor check.

    " + }, + "resourcesFlagged":{ + "shape":"Long", + "documentation":"

    The number of AWS resources that were flagged (listed) by the Trusted Advisor check.

    " + }, + "resourcesIgnored":{ + "shape":"Long", + "documentation":"

    The number of AWS resources ignored by Trusted Advisor because information was unavailable.

    " + }, + "resourcesSuppressed":{ + "shape":"Long", + "documentation":"

    The number of AWS resources ignored by Trusted Advisor because they were marked as suppressed by the user.

    " + } + }, + "documentation":"

    Details about AWS resources that were analyzed in a call to Trusted Advisor DescribeTrustedAdvisorCheckSummaries.

    " + } + }, + "documentation":"AWS Support

    The AWS Support API reference is intended for programmers who need detailed information about the AWS Support operations and data types. This service enables you to manage your AWS Support cases programmatically. It uses HTTP methods that return results in JSON format.

    The AWS Support service also exposes a set of Trusted Advisor features. You can retrieve a list of checks and their descriptions, get check results, specify checks to refresh, and get the refresh status of checks.

    The following list describes the AWS Support case management operations:

    The following list describes the operations available from the AWS Support service for Trusted Advisor:

    For authentication of requests, AWS Support uses Signature Version 4 Signing Process.

    See About the AWS Support API in the AWS Support User Guide for information about how to use this service to create and manage your support cases, and how to call Trusted Advisor for results of checks on your resources.

    " +} diff --git a/aws/dist/botocore/data/swf/2012-01-25/paginators-1.json b/aws/dist/botocore/data/swf/2012-01-25/paginators-1.json new file mode 100644 index 00000000..e92bfebe --- /dev/null +++ b/aws/dist/botocore/data/swf/2012-01-25/paginators-1.json @@ -0,0 +1,53 @@ +{ + "pagination": { + "GetWorkflowExecutionHistory": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events" + }, + "ListActivityTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "ListClosedWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListDomains": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "domainInfos" + }, + "ListOpenWorkflowExecutions": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "executionInfos" + }, + "ListWorkflowTypes": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "typeInfos" + }, + "PollForDecisionTask": { + "limit_key": "maximumPageSize", + "input_token": "nextPageToken", + "output_token": "nextPageToken", + "result_key": "events", + "non_aggregate_keys": [ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "previousStartedEventId" + ] + } + } +} diff --git a/aws/dist/botocore/data/swf/2012-01-25/service-2.json b/aws/dist/botocore/data/swf/2012-01-25/service-2.json new file mode 100644 index 00000000..dfb7c957 --- /dev/null +++ b/aws/dist/botocore/data/swf/2012-01-25/service-2.json @@ -0,0 +1,4744 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2012-01-25", + "endpointPrefix":"swf", + "jsonVersion":"1.0", + "protocol":"json", + "serviceAbbreviation":"Amazon SWF", + "serviceFullName":"Amazon Simple Workflow Service", + "serviceId":"SWF", + "signatureVersion":"v4", + "targetPrefix":"SimpleWorkflowService", + "uid":"swf-2012-01-25" + }, + "operations":{ + "CountClosedWorkflowExecutions":{ + "name":"CountClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountClosedWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionCount"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

      • typeFilter.name: String constraint. The key is swf:typeFilter.name.

      • typeFilter.version: String constraint. The key is swf:typeFilter.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CountOpenWorkflowExecutions":{ + "name":"CountOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountOpenWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionCount"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the number of open workflow executions within the given domain that meet the specified filtering criteria.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

      • typeFilter.name: String constraint. The key is swf:typeFilter.name.

      • typeFilter.version: String constraint. The key is swf:typeFilter.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CountPendingActivityTasks":{ + "name":"CountPendingActivityTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingActivityTasksInput"}, + "output":{"shape":"PendingTaskCount"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the estimated number of activity tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no activity task was ever scheduled in then 0 is returned.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CountPendingDecisionTasks":{ + "name":"CountPendingDecisionTasks", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CountPendingDecisionTasksInput"}, + "output":{"shape":"PendingTaskCount"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the estimated number of decision tasks in the specified task list. The count returned is an approximation and isn't guaranteed to be exact. If you specify a task list that no decision task was ever scheduled in then 0 is returned.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DeprecateActivityType":{ + "name":"DeprecateActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateActivityTypeInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Deprecates the specified activity type. After an activity type has been deprecated, you cannot create new tasks of that activity type. Tasks of this type that were scheduled before the type was deprecated continue to run.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • activityType.name: String constraint. The key is swf:activityType.name.

      • activityType.version: String constraint. The key is swf:activityType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DeprecateDomain":{ + "name":"DeprecateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateDomainInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"DomainDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Deprecates the specified domain. After a domain has been deprecated it cannot be used to create new workflow executions or register new types. However, you can still use visibility actions on this domain. Deprecating a domain also deprecates all activity and workflow types registered in the domain. Executions that were started before the domain was deprecated continues to run.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DeprecateWorkflowType":{ + "name":"DeprecateWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeprecateWorkflowTypeInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated continues to run. A deprecated workflow type may still be used when calling visibility actions.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • workflowType.name: String constraint. The key is swf:workflowType.name.

      • workflowType.version: String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DescribeActivityType":{ + "name":"DescribeActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeActivityTypeInput"}, + "output":{"shape":"ActivityTypeDetail"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns information about the specified activity type. This includes configuration settings provided when the type was registered and other general information about the type.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • activityType.name: String constraint. The key is swf:activityType.name.

      • activityType.version: String constraint. The key is swf:activityType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DescribeDomain":{ + "name":"DescribeDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainInput"}, + "output":{"shape":"DomainDetail"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns information about the specified domain, including description and status.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DescribeWorkflowExecution":{ + "name":"DescribeWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowExecutionInput"}, + "output":{"shape":"WorkflowExecutionDetail"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns information about the specified workflow execution including its type and some statistics.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "DescribeWorkflowType":{ + "name":"DescribeWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkflowTypeInput"}, + "output":{"shape":"WorkflowTypeDetail"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, etc.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • workflowType.name: String constraint. The key is swf:workflowType.name.

      • workflowType.version: String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "GetWorkflowExecutionHistory":{ + "name":"GetWorkflowExecutionHistory", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWorkflowExecutionHistoryInput"}, + "output":{"shape":"History"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the history of the specified workflow execution. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ListActivityTypes":{ + "name":"ListActivityTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivityTypesInput"}, + "output":{"shape":"ActivityTypeInfos"}, + "errors":[ + {"shape":"OperationNotPermittedFault"}, + {"shape":"UnknownResourceFault"} + ], + "documentation":"

    Returns information about all activities registered in the specified domain that match the specified name and registration status. The result includes information like creation date, current status of the activity, etc. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ListClosedWorkflowExecutions":{ + "name":"ListClosedWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListClosedWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionInfos"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns a list of closed workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

      • typeFilter.name: String constraint. The key is swf:typeFilter.name.

      • typeFilter.version: String constraint. The key is swf:typeFilter.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsInput"}, + "output":{"shape":"DomainInfos"}, + "errors":[ + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns the list of domains registered in the account. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains. The element must be set to arn:aws:swf::AccountID:domain/*, where AccountID is the account ID, with no dashes.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ListOpenWorkflowExecutions":{ + "name":"ListOpenWorkflowExecutions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOpenWorkflowExecutionsInput"}, + "output":{"shape":"WorkflowExecutionInfos"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Returns a list of open workflow executions in the specified domain that meet the filtering criteria. The results may be split into multiple pages. To retrieve subsequent pages, make the call again using the nextPageToken returned by the initial call.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagFilter.tag: String constraint. The key is swf:tagFilter.tag.

      • typeFilter.name: String constraint. The key is swf:typeFilter.name.

      • typeFilter.version: String constraint. The key is swf:typeFilter.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceInput"}, + "output":{"shape":"ListTagsForResourceOutput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    List tags for a given domain.

    " + }, + "ListWorkflowTypes":{ + "name":"ListWorkflowTypes", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWorkflowTypesInput"}, + "output":{"shape":"WorkflowTypeInfos"}, + "errors":[ + {"shape":"OperationNotPermittedFault"}, + {"shape":"UnknownResourceFault"} + ], + "documentation":"

    Returns information about workflow types in the specified domain. The results may be split into multiple pages that can be retrieved by making the call repeatedly.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "PollForActivityTask":{ + "name":"PollForActivityTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForActivityTaskInput"}, + "output":{"shape":"ActivityTask"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"LimitExceededFault"} + ], + "documentation":"

    Used by workers to get an ActivityTask from the specified activity taskList. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available. The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns an empty result. An empty result, in this context, means that an ActivityTask is returned, but that the value of taskToken is an empty string. If a task is returned, the worker should use its type to identify and process it correctly.

    Workers should set their client side socket timeout to at least 70 seconds (10 seconds higher than the maximum time service may hold the poll request).

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "PollForDecisionTask":{ + "name":"PollForDecisionTask", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PollForDecisionTaskInput"}, + "output":{"shape":"DecisionTask"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"LimitExceededFault"} + ], + "documentation":"

    Used by deciders to get a DecisionTask from the specified decision taskList. A decision task may be returned for any open workflow execution that is using the specified task list. The task includes a paginated view of the history of the workflow execution. The decider should use the workflow type and the history to determine how to properly handle the task.

    This action initiates a long poll, where the service holds the HTTP connection open and responds as soon a task becomes available. If no decision task is available in the specified task list before the timeout of 60 seconds expires, an empty result is returned. An empty result, in this context, means that a DecisionTask is returned, but that the value of taskToken is an empty string.

    Deciders should set their client side socket timeout to at least 70 seconds (10 seconds higher than the timeout).

    Because the number of workflow history events for a single workflow execution might be very large, the result returned might be split up across a number of pages. To retrieve subsequent pages, make additional calls to PollForDecisionTask using the nextPageToken returned by the initial call. Note that you do not call GetWorkflowExecutionHistory with this nextPageToken. Instead, call PollForDecisionTask again.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the taskList.name parameter by using a Condition element with the swf:taskList.name key to allow the action to access only certain task lists.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RecordActivityTaskHeartbeat":{ + "name":"RecordActivityTaskHeartbeat", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RecordActivityTaskHeartbeatInput"}, + "output":{"shape":"ActivityTaskStatus"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Used by activity workers to report to the service that the ActivityTask represented by the specified taskToken is still making progress. The worker can also specify details of the progress, for example percent complete, using the details parameter. This action can also be used by the worker as a mechanism to check if cancellation is being requested for the activity task. If a cancellation is being attempted for the specified task, then the boolean cancelRequested flag returned by the service is set to true.

    This action resets the taskHeartbeatTimeout clock. The taskHeartbeatTimeout is specified in RegisterActivityType.

    This action doesn't in itself create an event in the workflow execution history. However, if the task times out, the workflow execution history contains a ActivityTaskTimedOut event that contains the information from the last heartbeat generated by the activity worker.

    The taskStartToCloseTimeout of an activity type is the maximum duration of an activity task, regardless of the number of RecordActivityTaskHeartbeat requests received. The taskStartToCloseTimeout is also specified in RegisterActivityType.

    This operation is only useful for long-lived activities to report liveliness of the task and to determine if a cancellation is being attempted.

    If the cancelRequested flag returns true, a cancellation is being attempted. If the worker can cancel the activity, it should respond with RespondActivityTaskCanceled. Otherwise, it should ignore the cancellation request.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RegisterActivityType":{ + "name":"RegisterActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterActivityTypeInput"}, + "errors":[ + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Registers a new activity type along with its configuration settings in the specified domain.

    A TypeAlreadyExists fault is returned if the type already exists in the domain. You cannot change any configuration settings of the type after its registration, and it must be registered as a new version.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

      • name: String constraint. The key is swf:name.

      • version: String constraint. The key is swf:version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RegisterDomain":{ + "name":"RegisterDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterDomainInput"}, + "errors":[ + {"shape":"DomainAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"TooManyTagsFault"} + ], + "documentation":"

    Registers a new domain.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • You cannot use an IAM policy to control domain access for this action. The name of the domain being registered is available as the resource of this action.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RegisterWorkflowType":{ + "name":"RegisterWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterWorkflowTypeInput"}, + "errors":[ + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Registers a new workflow type and its configuration settings in the specified domain.

    The retention period for the workflow history is set by the RegisterDomain action.

    If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.

      • name: String constraint. The key is swf:name.

      • version: String constraint. The key is swf:version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RequestCancelWorkflowExecution":{ + "name":"RequestCancelWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RequestCancelWorkflowExecutionInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Records a WorkflowExecutionCancelRequested event in the currently running workflow execution identified by the given domain, workflowId, and runId. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    If the runId isn't specified, the WorkflowExecutionCancelRequested event is recorded in the history of the current open workflow execution with the specified workflowId in the domain.

    Because this action allows the workflow to properly clean up and gracefully close, it should be used instead of TerminateWorkflowExecution when possible.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RespondActivityTaskCanceled":{ + "name":"RespondActivityTaskCanceled", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCanceledInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Used by workers to tell the service that the ActivityTask identified by the taskToken was successfully canceled. Additional details can be provided using the details argument.

    These details (if provided) appear in the ActivityTaskCanceled event added to the workflow history.

    Only use this operation if the canceled flag of a RecordActivityTaskHeartbeat request returns true and if the activity can be safely undone or abandoned.

    A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RespondActivityTaskCompleted":{ + "name":"RespondActivityTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskCompletedInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Used by workers to tell the service that the ActivityTask identified by the taskToken completed successfully with a result (if provided). The result appears in the ActivityTaskCompleted event in the workflow history.

    If the requested task doesn't complete successfully, use RespondActivityTaskFailed instead. If the worker finds that the task is canceled through the canceled flag returned by RecordActivityTaskHeartbeat, it should cancel the task, clean up and then call RespondActivityTaskCanceled.

    A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RespondActivityTaskFailed":{ + "name":"RespondActivityTaskFailed", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondActivityTaskFailedInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Used by workers to tell the service that the ActivityTask identified by the taskToken has failed with reason (if specified). The reason and details appear in the ActivityTaskFailed event added to the workflow history.

    A task is considered open from the time that it is scheduled until it is closed. Therefore a task is reported as open while a worker is processing it. A task is closed after it has been specified in a call to RespondActivityTaskCompleted, RespondActivityTaskCanceled, RespondActivityTaskFailed, or the task has timed out.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RespondDecisionTaskCompleted":{ + "name":"RespondDecisionTaskCompleted", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RespondDecisionTaskCompletedInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Used by deciders to tell the service that the DecisionTask identified by the taskToken has successfully completed. The decisions argument specifies the list of decisions made while processing the task.

    A DecisionTaskCompleted event is added to the workflow history. The executionContext specified is attached to the event in the workflow execution history.

    Access Control

    If an IAM policy grants permission to use RespondDecisionTaskCompleted, it can express permissions for the list of decisions in the decisions parameter. Each of the decisions has one or more parameters, much like a regular API call. To allow for policies to be as readable as possible, you can express permissions on decisions as if they were actual API calls, including applying conditions to some parameters. For more information, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "SignalWorkflowExecution":{ + "name":"SignalWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"SignalWorkflowExecutionInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution identified by the given domain, workflowId and runId. The event is recorded with the specified user defined signalName and input (if provided).

    If a runId isn't specified, then the WorkflowExecutionSignaled event is recorded in the history of the current open workflow with the matching workflowId in the domain.

    If the specified workflow execution isn't open, this method fails with UnknownResource.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "StartWorkflowExecution":{ + "name":"StartWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkflowExecutionInput"}, + "output":{"shape":"Run"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TypeDeprecatedFault"}, + {"shape":"WorkflowExecutionAlreadyStartedFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"}, + {"shape":"DefaultUndefinedFault"} + ], + "documentation":"

    Starts an execution of the workflow type in the specified domain using the provided workflowId and input data.

    This action returns the newly started workflow execution.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagList.member.0: The key is swf:tagList.member.0.

      • tagList.member.1: The key is swf:tagList.member.1.

      • tagList.member.2: The key is swf:tagList.member.2.

      • tagList.member.3: The key is swf:tagList.member.3.

      • tagList.member.4: The key is swf:tagList.member.4.

      • taskList: String constraint. The key is swf:taskList.name.

      • workflowType.name: String constraint. The key is swf:workflowType.name.

      • workflowType.version: String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TooManyTagsFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Add a tag to a Amazon SWF domain.

    Amazon SWF supports a maximum of 50 tags per resource.

    " + }, + "TerminateWorkflowExecution":{ + "name":"TerminateWorkflowExecution", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkflowExecutionInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Records a WorkflowExecutionTerminated event and forces closure of the workflow execution identified by the given domain, runId, and workflowId. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

    If the identified workflow execution was in progress, it is terminated immediately.

    If a runId isn't specified, then the WorkflowExecutionTerminated event is recorded in the history of the current open workflow with the matching workflowId in the domain.

    You should consider using RequestCancelWorkflowExecution action instead because it allows the workflow to gracefully close while TerminateWorkflowExecution doesn't.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "UndeprecateActivityType":{ + "name":"UndeprecateActivityType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UndeprecateActivityTypeInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Undeprecates a previously deprecated activity type. After an activity type has been undeprecated, you can create new tasks of that activity type.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • activityType.name: String constraint. The key is swf:activityType.name.

      • activityType.version: String constraint. The key is swf:activityType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "UndeprecateDomain":{ + "name":"UndeprecateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UndeprecateDomainInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"DomainAlreadyExistsFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used to create new workflow executions or register new types.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "UndeprecateWorkflowType":{ + "name":"UndeprecateWorkflowType", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UndeprecateWorkflowTypeInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"TypeAlreadyExistsFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Undeprecates a previously deprecated workflow type. After a workflow type has been undeprecated, you can create new executions of that type.

    This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

    Access Control

    You can use IAM policies to control this action's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • workflowType.name: String constraint. The key is swf:workflowType.name.

      • workflowType.version: String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceInput"}, + "errors":[ + {"shape":"UnknownResourceFault"}, + {"shape":"LimitExceededFault"}, + {"shape":"OperationNotPermittedFault"} + ], + "documentation":"

    Remove a tag from a Amazon SWF domain.

    " + } + }, + "shapes":{ + "ActivityId":{ + "type":"string", + "max":256, + "min":1 + }, + "ActivityTask":{ + "type":"structure", + "required":[ + "taskToken", + "activityId", + "startedEventId", + "workflowExecution", + "activityType" + ], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

    " + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The unique ID of the task.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event recorded in the history.

    " + }, + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The workflow execution that started this activity task.

    " + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The type of this activity task.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The inputs provided when the activity task was scheduled. The form of the input is user defined and should be meaningful to the activity implementation.

    " + } + }, + "documentation":"

    Unit of work sent to an activity worker.

    " + }, + "ActivityTaskCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "activityId" + ], + "members":{ + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The unique ID of the task.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskCancelRequested event.

    " + }, + "ActivityTaskCanceledEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "details":{ + "shape":"Data", + "documentation":"

    Details of the cancellation.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "latestCancelRequestedEventId":{ + "shape":"EventId", + "documentation":"

    If set, contains the ID of the last ActivityTaskCancelRequested event recorded for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskCanceled event.

    " + }, + "ActivityTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "result":{ + "shape":"Data", + "documentation":"

    The results of the activity task.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskCompleted event.

    " + }, + "ActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

    The reason provided for the failure.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the failure.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskFailed event.

    " + }, + "ActivityTaskScheduledEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "taskList", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The type of the activity task.

    " + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The unique ID of the activity task.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the activity task.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " + }, + "scheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum amount of time the activity task can wait to be assigned to a worker.

    " + }, + "scheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum amount of time for this activity task.

    " + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum amount of time a worker may take to process the activity task.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The task list in which the activity task has been scheduled.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

    Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "heartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskScheduled event.

    " + }, + "ActivityTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{ + "shape":"Identity", + "documentation":"

    Identity of the worker that was assigned this task. This aids diagnostics when problems arise. The form of this identity is user defined.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskStarted event.

    " + }, + "ActivityTaskStatus":{ + "type":"structure", + "required":["cancelRequested"], + "members":{ + "cancelRequested":{ + "shape":"Canceled", + "documentation":"

    Set to true if cancellation of the task is requested.

    " + } + }, + "documentation":"

    Status information about an activity task.

    " + }, + "ActivityTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{ + "shape":"ActivityTaskTimeoutType", + "documentation":"

    The type of the timeout that caused this event.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event recorded when this activity task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "details":{ + "shape":"LimitedData", + "documentation":"

    Contains the content of the details parameter for the last call made by the activity to RecordActivityTaskHeartbeat.

    " + } + }, + "documentation":"

    Provides the details of the ActivityTaskTimedOut event.

    " + }, + "ActivityTaskTimeoutType":{ + "type":"string", + "enum":[ + "START_TO_CLOSE", + "SCHEDULE_TO_START", + "SCHEDULE_TO_CLOSE", + "HEARTBEAT" + ] + }, + "ActivityType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of this activity.

    The combination of activity type name and version must be unique within a domain.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of this activity.

    The combination of activity type name and version must be unique with in a domain.

    " + } + }, + "documentation":"

    Represents an activity type.

    " + }, + "ActivityTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskHeartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.

    You can specify this value only when registering an activity type. The registered default value can be overridden when you schedule a task through the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

    The default task list specified for this activity type at registration. This default is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision. You can override the default registered task list when scheduling a task through the ScheduleActivityTask Decision.

    " + }, + "defaultTaskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The default task priority for tasks of this activity type, specified at registration. If not set, then 0 is used as the default priority. This default can be overridden when scheduling an activity task.

    Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "defaultTaskScheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskScheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + }, + "documentation":"

    Configuration settings registered with the activity type.

    " + }, + "ActivityTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{ + "shape":"ActivityTypeInfo", + "documentation":"

    General information about the activity type.

    The status of activity type (returned in the ActivityTypeInfo structure) can be one of the following.

    • REGISTERED – The type is registered and available. Workers supporting this type should be running.

    • DEPRECATED – The type was deprecated using DeprecateActivityType, but is still in use. You should keep workers supporting this type running. You cannot create new tasks of this type.

    " + }, + "configuration":{ + "shape":"ActivityTypeConfiguration", + "documentation":"

    The configuration settings registered with the activity type.

    " + } + }, + "documentation":"

    Detailed information about an activity type.

    " + }, + "ActivityTypeInfo":{ + "type":"structure", + "required":[ + "activityType", + "status", + "creationDate" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The ActivityType type structure representing the activity type.

    " + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

    The current status of the activity type.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the activity type provided in RegisterActivityType.

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time this activity type was created through RegisterActivityType.

    " + }, + "deprecationDate":{ + "shape":"Timestamp", + "documentation":"

    If DEPRECATED, the date and time DeprecateActivityType was called.

    " + } + }, + "documentation":"

    Detailed information about an activity type.

    " + }, + "ActivityTypeInfoList":{ + "type":"list", + "member":{"shape":"ActivityTypeInfo"} + }, + "ActivityTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{ + "shape":"ActivityTypeInfoList", + "documentation":"

    List of activity type information.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, + "documentation":"

    Contains a paginated list of activity type information structures.

    " + }, + "Arn":{ + "type":"string", + "max":1600, + "min":1 + }, + "CancelTimerDecisionAttributes":{ + "type":"structure", + "required":["timerId"], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The unique ID of the timer to cancel.

    " + } + }, + "documentation":"

    Provides the details of the CancelTimer decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CancelTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The timerId provided in the CancelTimer decision that failed.

    " + }, + "cause":{ + "shape":"CancelTimerFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the CancelTimerFailed event.

    " + }, + "CancelWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "details":{ + "shape":"Data", + "documentation":"

    Details of the cancellation.

    " + } + }, + "documentation":"

    Provides the details of the CancelWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CancelWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CancelWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"CancelWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the CancelWorkflowExecutionFailed event.

    " + }, + "Canceled":{"type":"boolean"}, + "CauseMessage":{ + "type":"string", + "max":1728 + }, + "ChildPolicy":{ + "type":"string", + "enum":[ + "TERMINATE", + "REQUEST_CANCEL", + "ABANDON" + ] + }, + "ChildWorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that was canceled.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    Details of the cancellation (if provided).

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provide details of the ChildWorkflowExecutionCanceled event.

    " + }, + "ChildWorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that was completed.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "result":{ + "shape":"Data", + "documentation":"

    The result of the child workflow execution.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ChildWorkflowExecutionCompleted event.

    " + }, + "ChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that failed.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "reason":{ + "shape":"FailureReason", + "documentation":"

    The reason for the failure (if provided).

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the failure (if provided).

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ChildWorkflowExecutionFailed event.

    " + }, + "ChildWorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that was started.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ChildWorkflowExecutionStarted event.

    " + }, + "ChildWorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that was terminated.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ChildWorkflowExecutionTerminated event.

    " + }, + "ChildWorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "workflowType", + "timeoutType", + "initiatedEventId", + "startedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The child workflow execution that timed out.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "timeoutType":{ + "shape":"WorkflowExecutionTimeoutType", + "documentation":"

    The type of the timeout that caused the child workflow execution to time out.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ChildWorkflowExecutionStarted event recorded when this child workflow execution was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ChildWorkflowExecutionTimedOut event.

    " + }, + "CloseStatus":{ + "type":"string", + "enum":[ + "COMPLETED", + "FAILED", + "CANCELED", + "TERMINATED", + "CONTINUED_AS_NEW", + "TIMED_OUT" + ] + }, + "CloseStatusFilter":{ + "type":"structure", + "required":["status"], + "members":{ + "status":{ + "shape":"CloseStatus", + "documentation":"

    The close status that must match the close status of an execution for it to meet the criteria of this filter.

    " + } + }, + "documentation":"

    Used to filter the closed workflow executions in visibility APIs by their close status.

    " + }, + "CompleteWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "result":{ + "shape":"Data", + "documentation":"

    The result of the workflow execution. The form of the result is implementation defined.

    " + } + }, + "documentation":"

    Provides the details of the CompleteWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "CompleteWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "CompleteWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"CompleteWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the CompleteWorkflowExecutionFailed event.

    " + }, + "ContinueAsNewWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the new workflow execution.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this field. If neither this field is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The task list to use for the decisions of the new (continued) workflow execution.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The task priority that, if set, specifies the priority for the decision tasks for this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    Specifies the maximum duration of decision tasks for the new workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A task start-to-close timeout for the new workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    If set, specifies the policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags to associate with the new workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

    " + }, + "workflowTypeVersion":{ + "shape":"Version", + "documentation":"

    The version of the workflow to start.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role to attach to the new (continued) execution.

    " + } + }, + "documentation":"

    Provides the details of the ContinueAsNewWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tag – A tag used to identify the workflow execution

      • taskList – String constraint. The key is swf:taskList.name.

      • workflowType.version – String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ContinueAsNewWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "WORKFLOW_TYPE_DEPRECATED", + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "CONTINUE_AS_NEW_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ContinueAsNewWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"ContinueAsNewWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ContinueAsNewWorkflowExecutionFailed event.

    " + }, + "Count":{ + "type":"integer", + "min":0 + }, + "CountClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow executions to count.

    " + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    If specified, only workflow executions that meet the start time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    " + }, + "closeTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    If specified, only workflow executions that meet the close time criteria of the filter are counted.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    " + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

    If specified, indicates the type of the workflow executions to be counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

    If specified, only executions that have a tag that matches the filter are counted.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "closeStatusFilter":{ + "shape":"CloseStatusFilter", + "documentation":"

    If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + } + } + }, + "CountOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow executions to count.

    " + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    Specifies the start time criteria that workflow executions must meet in order to be counted.

    " + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

    Specifies the type of the workflow executions to be counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

    If specified, only executions that have a tag that matches the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

    If specified, only workflow executions matching the WorkflowId in the filter are counted.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + } + } + }, + "CountPendingActivityTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that contains the task list.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list.

    " + } + } + }, + "CountPendingDecisionTasksInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that contains the task list.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list.

    " + } + } + }, + "Data":{ + "type":"string", + "max":32768 + }, + "Decision":{ + "type":"structure", + "required":["decisionType"], + "members":{ + "decisionType":{ + "shape":"DecisionType", + "documentation":"

    Specifies the type of the decision.

    " + }, + "scheduleActivityTaskDecisionAttributes":{ + "shape":"ScheduleActivityTaskDecisionAttributes", + "documentation":"

    Provides the details of the ScheduleActivityTask decision. It isn't set for other decision types.

    " + }, + "requestCancelActivityTaskDecisionAttributes":{ + "shape":"RequestCancelActivityTaskDecisionAttributes", + "documentation":"

    Provides the details of the RequestCancelActivityTask decision. It isn't set for other decision types.

    " + }, + "completeWorkflowExecutionDecisionAttributes":{ + "shape":"CompleteWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the CompleteWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "failWorkflowExecutionDecisionAttributes":{ + "shape":"FailWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the FailWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "cancelWorkflowExecutionDecisionAttributes":{ + "shape":"CancelWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the CancelWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "continueAsNewWorkflowExecutionDecisionAttributes":{ + "shape":"ContinueAsNewWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the ContinueAsNewWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "recordMarkerDecisionAttributes":{ + "shape":"RecordMarkerDecisionAttributes", + "documentation":"

    Provides the details of the RecordMarker decision. It isn't set for other decision types.

    " + }, + "startTimerDecisionAttributes":{ + "shape":"StartTimerDecisionAttributes", + "documentation":"

    Provides the details of the StartTimer decision. It isn't set for other decision types.

    " + }, + "cancelTimerDecisionAttributes":{ + "shape":"CancelTimerDecisionAttributes", + "documentation":"

    Provides the details of the CancelTimer decision. It isn't set for other decision types.

    " + }, + "signalExternalWorkflowExecutionDecisionAttributes":{ + "shape":"SignalExternalWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the SignalExternalWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "requestCancelExternalWorkflowExecutionDecisionAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the RequestCancelExternalWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "startChildWorkflowExecutionDecisionAttributes":{ + "shape":"StartChildWorkflowExecutionDecisionAttributes", + "documentation":"

    Provides the details of the StartChildWorkflowExecution decision. It isn't set for other decision types.

    " + }, + "scheduleLambdaFunctionDecisionAttributes":{ + "shape":"ScheduleLambdaFunctionDecisionAttributes", + "documentation":"

    Provides the details of the ScheduleLambdaFunction decision. It isn't set for other decision types.

    " + } + }, + "documentation":"

    Specifies a decision made by the decider. A decision can be one of these types:

    • CancelTimer – Cancels a previously started timer and records a TimerCanceled event in the history.

    • CancelWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCanceled event in the history.

    • CompleteWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionCompleted event in the history .

    • ContinueAsNewWorkflowExecution – Closes the workflow execution and starts a new workflow execution of the same type using the same workflow ID and a unique run Id. A WorkflowExecutionContinuedAsNew event is recorded in the history.

    • FailWorkflowExecution – Closes the workflow execution and records a WorkflowExecutionFailed event in the history.

    • RecordMarker – Records a MarkerRecorded event in the history. Markers can be used for adding custom information in the history for instance to let deciders know that they don't need to look at the history beyond the marker event.

    • RequestCancelActivityTask – Attempts to cancel a previously scheduled activity task. If the activity task was scheduled but has not been assigned to a worker, then it is canceled. If the activity task was already assigned to a worker, then the worker is informed that cancellation has been requested in the response to RecordActivityTaskHeartbeat.

    • RequestCancelExternalWorkflowExecution – Requests that a request be made to cancel the specified external workflow execution and records a RequestCancelExternalWorkflowExecutionInitiated event in the history.

    • ScheduleActivityTask – Schedules an activity task.

    • SignalExternalWorkflowExecution – Requests a signal to be delivered to the specified external workflow execution and records a SignalExternalWorkflowExecutionInitiated event in the history.

    • StartChildWorkflowExecution – Requests that a child workflow execution be started and records a StartChildWorkflowExecutionInitiated event in the history. The child workflow execution is a separate workflow execution with its own history.

    • StartTimer – Starts a timer for this workflow execution and records a TimerStarted event in the history. This timer fires after the specified delay and record a TimerFired event.

    Access Control

    If you grant permission to use RespondDecisionTaskCompleted, you can use IAM policies to express permissions for the list of decisions returned by this action as if they were members of the API. Treating decisions as a pseudo API maintains a uniform conceptual model and helps keep policies readable. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    Decision Failure

    Decisions can fail for several reasons

    • The ordering of decisions should follow a logical flow. Some decisions might not make sense in the current context of the workflow execution and therefore fails.

    • A limit on your account was reached.

    • The decision lacks sufficient permissions.

    One of the following events might be added to the history to indicate an error. The event attribute's cause parameter indicates the cause. If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    • ScheduleActivityTaskFailed – A ScheduleActivityTask decision failed. This could happen if the activity type specified in the decision isn't registered, is in a deprecated state, or the decision isn't properly configured.

    • RequestCancelActivityTaskFailed – A RequestCancelActivityTask decision failed. This could happen if there is no open activity task with the specified activityId.

    • StartTimerFailed – A StartTimer decision failed. This could happen if there is another open timer with the same timerId.

    • CancelTimerFailed – A CancelTimer decision failed. This could happen if there is no open timer with the specified timerId.

    • StartChildWorkflowExecutionFailed – A StartChildWorkflowExecution decision failed. This could happen if the workflow type specified isn't registered, is deprecated, or the decision isn't properly configured.

    • SignalExternalWorkflowExecutionFailed – A SignalExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

    • RequestCancelExternalWorkflowExecutionFailed – A RequestCancelExternalWorkflowExecution decision failed. This could happen if the workflowID specified in the decision was incorrect.

    • CancelWorkflowExecutionFailed – A CancelWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    • CompleteWorkflowExecutionFailed – A CompleteWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    • ContinueAsNewWorkflowExecutionFailed – A ContinueAsNewWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution or the ContinueAsNewWorkflowExecution decision was not configured correctly.

    • FailWorkflowExecutionFailed – A FailWorkflowExecution decision failed. This could happen if there is an unhandled decision task pending in the workflow execution.

    The preceding error events might occur due to an error in the decider logic, which might put the workflow execution in an unstable state The cause field in the event structure for the error event indicates the cause of the error.

    A workflow execution may be closed by the decider by returning one of the following decisions when completing a decision task: CompleteWorkflowExecution, FailWorkflowExecution, CancelWorkflowExecution and ContinueAsNewWorkflowExecution. An UnhandledDecision fault is returned if a workflow closing decision is specified and a signal or activity event had been added to the history while the decision task was being performed by the decider. Unlike the above situations which are logic issues, this fault is always possible because of race conditions in a distributed system. The right action here is to call RespondDecisionTaskCompleted without any decisions. This would result in another decision task with these new events included in the history. The decider should handle the new events and may decide to close the workflow execution.

    How to Code a Decision

    You code a decision by first setting the decision type field to one of the above decision values, and then set the corresponding attributes field shown below:

    " + }, + "DecisionList":{ + "type":"list", + "member":{"shape":"Decision"} + }, + "DecisionTask":{ + "type":"structure", + "required":[ + "taskToken", + "startedEventId", + "workflowExecution", + "workflowType", + "events" + ], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The opaque string used as a handle on the task. This token is used by workers to communicate progress and response information back to the system about the task.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskStarted event recorded in the history.

    " + }, + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The workflow execution for which this decision task was created.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the workflow execution for which this decision task was created.

    " + }, + "events":{ + "shape":"HistoryEventList", + "documentation":"

    A paginated list of history events of the workflow execution. The decider uses this during the processing of the decision task.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "previousStartedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskStarted event of the previous decision task of this workflow execution that was processed by the decider. This can be used to determine the events in the history new since the last decision task received by the decider.

    " + } + }, + "documentation":"

    A structure that represents a decision task. Decision tasks are sent to deciders in order for them to make decisions.

    " + }, + "DecisionTaskCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "executionContext":{ + "shape":"Data", + "documentation":"

    User defined context for the workflow execution.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the DecisionTaskCompleted event.

    " + }, + "DecisionTaskScheduledEventAttributes":{ + "type":"structure", + "required":["taskList"], + "members":{ + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list in which the decision task was scheduled.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    A task priority that, if set, specifies the priority for this decision task. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration for this decision task. The task is considered timed out if it doesn't completed within this duration.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + }, + "documentation":"

    Provides details about the DecisionTaskScheduled event.

    " + }, + "DecisionTaskStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "identity":{ + "shape":"Identity", + "documentation":"

    Identity of the decider making the request. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the DecisionTaskStarted event.

    " + }, + "DecisionTaskTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "scheduledEventId", + "startedEventId" + ], + "members":{ + "timeoutType":{ + "shape":"DecisionTaskTimeoutType", + "documentation":"

    The type of timeout that expired before the decision task could be completed.

    " + }, + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskScheduled event that was recorded when this decision task was scheduled. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskStarted event recorded when this decision task was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the DecisionTaskTimedOut event.

    " + }, + "DecisionTaskTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "DecisionType":{ + "type":"string", + "enum":[ + "ScheduleActivityTask", + "RequestCancelActivityTask", + "CompleteWorkflowExecution", + "FailWorkflowExecution", + "CancelWorkflowExecution", + "ContinueAsNewWorkflowExecution", + "RecordMarker", + "StartTimer", + "CancelTimer", + "SignalExternalWorkflowExecution", + "RequestCancelExternalWorkflowExecution", + "StartChildWorkflowExecution", + "ScheduleLambdaFunction" + ] + }, + "DefaultUndefinedFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The StartWorkflowExecution API action was called without the required parameters set.

    Some workflow execution parameters, such as the decision taskList, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the StartWorkflowExecution call and Amazon SWF uses the values defined in the workflow type.

    If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.

    ", + "exception":true + }, + "DeprecateActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the activity type is registered.

    " + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The activity type to deprecate.

    " + } + } + }, + "DeprecateDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

    The name of the domain to deprecate.

    " + } + } + }, + "DeprecateWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the workflow type is registered.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type to deprecate.

    " + } + } + }, + "DescribeActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the activity type is registered.

    " + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The activity type to get information about. Activity types are identified by the name and version that were supplied when the activity was registered.

    " + } + } + }, + "DescribeDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

    The name of the domain to describe.

    " + } + } + }, + "DescribeWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow execution.

    " + }, + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

    The workflow execution to describe.

    " + } + } + }, + "DescribeWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which this workflow type is registered.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type to describe.

    " + } + } + }, + "Description":{ + "type":"string", + "max":1024 + }, + "DomainAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned if the domain already exists. You may get this fault if you are registering a domain that is either already registered or deprecated, or if you undeprecate a domain that is currently registered.

    ", + "exception":true + }, + "DomainConfiguration":{ + "type":"structure", + "required":["workflowExecutionRetentionPeriodInDays"], + "members":{ + "workflowExecutionRetentionPeriodInDays":{ + "shape":"DurationInDays", + "documentation":"

    The retention period for workflow executions in this domain.

    " + } + }, + "documentation":"

    Contains the configuration settings of a domain.

    " + }, + "DomainDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned when the specified domain has been deprecated.

    ", + "exception":true + }, + "DomainDetail":{ + "type":"structure", + "required":[ + "domainInfo", + "configuration" + ], + "members":{ + "domainInfo":{ + "shape":"DomainInfo", + "documentation":"

    The basic information about a domain, such as its name, status, and description.

    " + }, + "configuration":{ + "shape":"DomainConfiguration", + "documentation":"

    The domain configuration. Currently, this includes only the domain's retention period.

    " + } + }, + "documentation":"

    Contains details of a domain.

    " + }, + "DomainInfo":{ + "type":"structure", + "required":[ + "name", + "status" + ], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

    The name of the domain. This name is unique within the account.

    " + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

    The status of the domain:

    • REGISTERED – The domain is properly registered and available. You can use this domain for registering types and creating new workflow executions.

    • DEPRECATED – The domain was deprecated using DeprecateDomain, but is still in use. You should not create new workflow executions in this domain.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the domain provided through RegisterDomain.

    " + }, + "arn":{ + "shape":"Arn", + "documentation":"

    The ARN of the domain.

    " + } + }, + "documentation":"

    Contains general information about a domain.

    " + }, + "DomainInfoList":{ + "type":"list", + "member":{"shape":"DomainInfo"} + }, + "DomainInfos":{ + "type":"structure", + "required":["domainInfos"], + "members":{ + "domainInfos":{ + "shape":"DomainInfoList", + "documentation":"

    A list of DomainInfo structures.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, + "documentation":"

    Contains a paginated collection of DomainInfo structures.

    " + }, + "DomainName":{ + "type":"string", + "max":256, + "min":1 + }, + "DurationInDays":{ + "type":"string", + "max":8, + "min":1 + }, + "DurationInSeconds":{ + "type":"string", + "max":8, + "min":1 + }, + "DurationInSecondsOptional":{ + "type":"string", + "max":8 + }, + "ErrorMessage":{"type":"string"}, + "EventId":{"type":"long"}, + "EventType":{ + "type":"string", + "enum":[ + "WorkflowExecutionStarted", + "WorkflowExecutionCancelRequested", + "WorkflowExecutionCompleted", + "CompleteWorkflowExecutionFailed", + "WorkflowExecutionFailed", + "FailWorkflowExecutionFailed", + "WorkflowExecutionTimedOut", + "WorkflowExecutionCanceled", + "CancelWorkflowExecutionFailed", + "WorkflowExecutionContinuedAsNew", + "ContinueAsNewWorkflowExecutionFailed", + "WorkflowExecutionTerminated", + "DecisionTaskScheduled", + "DecisionTaskStarted", + "DecisionTaskCompleted", + "DecisionTaskTimedOut", + "ActivityTaskScheduled", + "ScheduleActivityTaskFailed", + "ActivityTaskStarted", + "ActivityTaskCompleted", + "ActivityTaskFailed", + "ActivityTaskTimedOut", + "ActivityTaskCanceled", + "ActivityTaskCancelRequested", + "RequestCancelActivityTaskFailed", + "WorkflowExecutionSignaled", + "MarkerRecorded", + "RecordMarkerFailed", + "TimerStarted", + "StartTimerFailed", + "TimerFired", + "TimerCanceled", + "CancelTimerFailed", + "StartChildWorkflowExecutionInitiated", + "StartChildWorkflowExecutionFailed", + "ChildWorkflowExecutionStarted", + "ChildWorkflowExecutionCompleted", + "ChildWorkflowExecutionFailed", + "ChildWorkflowExecutionTimedOut", + "ChildWorkflowExecutionCanceled", + "ChildWorkflowExecutionTerminated", + "SignalExternalWorkflowExecutionInitiated", + "SignalExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionSignaled", + "RequestCancelExternalWorkflowExecutionInitiated", + "RequestCancelExternalWorkflowExecutionFailed", + "ExternalWorkflowExecutionCancelRequested", + "LambdaFunctionScheduled", + "LambdaFunctionStarted", + "LambdaFunctionCompleted", + "LambdaFunctionFailed", + "LambdaFunctionTimedOut", + "ScheduleLambdaFunctionFailed", + "StartLambdaFunctionFailed" + ] + }, + "ExecutionStatus":{ + "type":"string", + "enum":[ + "OPEN", + "CLOSED" + ] + }, + "ExecutionTimeFilter":{ + "type":"structure", + "required":["oldestDate"], + "members":{ + "oldestDate":{ + "shape":"Timestamp", + "documentation":"

    Specifies the oldest start or close date and time to return.

    " + }, + "latestDate":{ + "shape":"Timestamp", + "documentation":"

    Specifies the latest start or close date and time to return.

    " + } + }, + "documentation":"

    Used to filter the workflow executions in visibility APIs by various time-based rules. Each parameter, if specified, defines a rule that must be satisfied by each returned query result. The parameter values are in the Unix Time format. For example: \"oldestDate\": 1325376070.

    " + }, + "ExternalWorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The external workflow execution to which the cancellation request was delivered.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ExternalWorkflowExecutionCancelRequested event.

    " + }, + "ExternalWorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":[ + "workflowExecution", + "initiatedEventId" + ], + "members":{ + "workflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The external workflow execution that the signal was delivered to.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ExternalWorkflowExecutionSignaled event.

    " + }, + "FailWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

    A descriptive reason for the failure that may help in diagnostics.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    Details of the failure.

    " + } + }, + "documentation":"

    Provides the details of the FailWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "FailWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNHANDLED_DECISION", + "OPERATION_NOT_PERMITTED" + ] + }, + "FailWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "cause":{ + "shape":"FailWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the FailWorkflowExecutionFailed event.

    " + }, + "FailureReason":{ + "type":"string", + "max":256 + }, + "FunctionId":{ + "type":"string", + "max":256, + "min":1 + }, + "FunctionInput":{ + "type":"string", + "max":32768, + "min":0 + }, + "FunctionName":{ + "type":"string", + "max":64, + "min":1 + }, + "GetWorkflowExecutionHistoryInput":{ + "type":"structure", + "required":[ + "domain", + "execution" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow execution.

    " + }, + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

    Specifies the workflow execution for which to return the history.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimeStamp of the events.

    " + } + } + }, + "History":{ + "type":"structure", + "required":["events"], + "members":{ + "events":{ + "shape":"HistoryEventList", + "documentation":"

    The list of history events.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, + "documentation":"

    Paginated representation of a workflow history for a workflow execution. This is the up to date, complete and authoritative record of the events related to all tasks and events in the life of the workflow execution.

    " + }, + "HistoryEvent":{ + "type":"structure", + "required":[ + "eventTimestamp", + "eventType", + "eventId" + ], + "members":{ + "eventTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The date and time when the event occurred.

    " + }, + "eventType":{ + "shape":"EventType", + "documentation":"

    The type of the history event.

    " + }, + "eventId":{ + "shape":"EventId", + "documentation":"

    The system generated ID of the event. This ID uniquely identifies the event with in the workflow execution history.

    " + }, + "workflowExecutionStartedEventAttributes":{ + "shape":"WorkflowExecutionStartedEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionCompletedEventAttributes":{ + "shape":"WorkflowExecutionCompletedEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "completeWorkflowExecutionFailedEventAttributes":{ + "shape":"CompleteWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type CompleteWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionFailedEventAttributes":{ + "shape":"WorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "failWorkflowExecutionFailedEventAttributes":{ + "shape":"FailWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type FailWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionTimedOutEventAttributes":{ + "shape":"WorkflowExecutionTimedOutEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionCanceledEventAttributes":{ + "shape":"WorkflowExecutionCanceledEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "cancelWorkflowExecutionFailedEventAttributes":{ + "shape":"CancelWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type CancelWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionContinuedAsNewEventAttributes":{ + "shape":"WorkflowExecutionContinuedAsNewEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionContinuedAsNew then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "continueAsNewWorkflowExecutionFailedEventAttributes":{ + "shape":"ContinueAsNewWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type ContinueAsNewWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionTerminatedEventAttributes":{ + "shape":"WorkflowExecutionTerminatedEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionCancelRequestedEventAttributes":{ + "shape":"WorkflowExecutionCancelRequestedEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "decisionTaskScheduledEventAttributes":{ + "shape":"DecisionTaskScheduledEventAttributes", + "documentation":"

    If the event is of type DecisionTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "decisionTaskStartedEventAttributes":{ + "shape":"DecisionTaskStartedEventAttributes", + "documentation":"

    If the event is of type DecisionTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "decisionTaskCompletedEventAttributes":{ + "shape":"DecisionTaskCompletedEventAttributes", + "documentation":"

    If the event is of type DecisionTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "decisionTaskTimedOutEventAttributes":{ + "shape":"DecisionTaskTimedOutEventAttributes", + "documentation":"

    If the event is of type DecisionTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskScheduledEventAttributes":{ + "shape":"ActivityTaskScheduledEventAttributes", + "documentation":"

    If the event is of type ActivityTaskScheduled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskStartedEventAttributes":{ + "shape":"ActivityTaskStartedEventAttributes", + "documentation":"

    If the event is of type ActivityTaskStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskCompletedEventAttributes":{ + "shape":"ActivityTaskCompletedEventAttributes", + "documentation":"

    If the event is of type ActivityTaskCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskFailedEventAttributes":{ + "shape":"ActivityTaskFailedEventAttributes", + "documentation":"

    If the event is of type ActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskTimedOutEventAttributes":{ + "shape":"ActivityTaskTimedOutEventAttributes", + "documentation":"

    If the event is of type ActivityTaskTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskCanceledEventAttributes":{ + "shape":"ActivityTaskCanceledEventAttributes", + "documentation":"

    If the event is of type ActivityTaskCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "activityTaskCancelRequestedEventAttributes":{ + "shape":"ActivityTaskCancelRequestedEventAttributes", + "documentation":"

    If the event is of type ActivityTaskcancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "workflowExecutionSignaledEventAttributes":{ + "shape":"WorkflowExecutionSignaledEventAttributes", + "documentation":"

    If the event is of type WorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "markerRecordedEventAttributes":{ + "shape":"MarkerRecordedEventAttributes", + "documentation":"

    If the event is of type MarkerRecorded then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "recordMarkerFailedEventAttributes":{ + "shape":"RecordMarkerFailedEventAttributes", + "documentation":"

    If the event is of type DecisionTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "timerStartedEventAttributes":{ + "shape":"TimerStartedEventAttributes", + "documentation":"

    If the event is of type TimerStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "timerFiredEventAttributes":{ + "shape":"TimerFiredEventAttributes", + "documentation":"

    If the event is of type TimerFired then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "timerCanceledEventAttributes":{ + "shape":"TimerCanceledEventAttributes", + "documentation":"

    If the event is of type TimerCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "startChildWorkflowExecutionInitiatedEventAttributes":{ + "shape":"StartChildWorkflowExecutionInitiatedEventAttributes", + "documentation":"

    If the event is of type StartChildWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionStartedEventAttributes":{ + "shape":"ChildWorkflowExecutionStartedEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionStarted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionCompletedEventAttributes":{ + "shape":"ChildWorkflowExecutionCompletedEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionCompleted then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionFailedEventAttributes":{ + "shape":"ChildWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionTimedOutEventAttributes":{ + "shape":"ChildWorkflowExecutionTimedOutEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionTimedOut then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionCanceledEventAttributes":{ + "shape":"ChildWorkflowExecutionCanceledEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionCanceled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "childWorkflowExecutionTerminatedEventAttributes":{ + "shape":"ChildWorkflowExecutionTerminatedEventAttributes", + "documentation":"

    If the event is of type ChildWorkflowExecutionTerminated then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "signalExternalWorkflowExecutionInitiatedEventAttributes":{ + "shape":"SignalExternalWorkflowExecutionInitiatedEventAttributes", + "documentation":"

    If the event is of type SignalExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "externalWorkflowExecutionSignaledEventAttributes":{ + "shape":"ExternalWorkflowExecutionSignaledEventAttributes", + "documentation":"

    If the event is of type ExternalWorkflowExecutionSignaled then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "signalExternalWorkflowExecutionFailedEventAttributes":{ + "shape":"SignalExternalWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type SignalExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "externalWorkflowExecutionCancelRequestedEventAttributes":{ + "shape":"ExternalWorkflowExecutionCancelRequestedEventAttributes", + "documentation":"

    If the event is of type ExternalWorkflowExecutionCancelRequested then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "requestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionInitiatedEventAttributes", + "documentation":"

    If the event is of type RequestCancelExternalWorkflowExecutionInitiated then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "requestCancelExternalWorkflowExecutionFailedEventAttributes":{ + "shape":"RequestCancelExternalWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type RequestCancelExternalWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "scheduleActivityTaskFailedEventAttributes":{ + "shape":"ScheduleActivityTaskFailedEventAttributes", + "documentation":"

    If the event is of type ScheduleActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "requestCancelActivityTaskFailedEventAttributes":{ + "shape":"RequestCancelActivityTaskFailedEventAttributes", + "documentation":"

    If the event is of type RequestCancelActivityTaskFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "startTimerFailedEventAttributes":{ + "shape":"StartTimerFailedEventAttributes", + "documentation":"

    If the event is of type StartTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "cancelTimerFailedEventAttributes":{ + "shape":"CancelTimerFailedEventAttributes", + "documentation":"

    If the event is of type CancelTimerFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "startChildWorkflowExecutionFailedEventAttributes":{ + "shape":"StartChildWorkflowExecutionFailedEventAttributes", + "documentation":"

    If the event is of type StartChildWorkflowExecutionFailed then this member is set and provides detailed information about the event. It isn't set for other event types.

    " + }, + "lambdaFunctionScheduledEventAttributes":{ + "shape":"LambdaFunctionScheduledEventAttributes", + "documentation":"

    Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

    " + }, + "lambdaFunctionStartedEventAttributes":{ + "shape":"LambdaFunctionStartedEventAttributes", + "documentation":"

    Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

    " + }, + "lambdaFunctionCompletedEventAttributes":{ + "shape":"LambdaFunctionCompletedEventAttributes", + "documentation":"

    Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

    " + }, + "lambdaFunctionFailedEventAttributes":{ + "shape":"LambdaFunctionFailedEventAttributes", + "documentation":"

    Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

    " + }, + "lambdaFunctionTimedOutEventAttributes":{ + "shape":"LambdaFunctionTimedOutEventAttributes", + "documentation":"

    Provides the details of the LambdaFunctionTimedOut event. It isn't set for other event types.

    " + }, + "scheduleLambdaFunctionFailedEventAttributes":{ + "shape":"ScheduleLambdaFunctionFailedEventAttributes", + "documentation":"

    Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

    " + }, + "startLambdaFunctionFailedEventAttributes":{ + "shape":"StartLambdaFunctionFailedEventAttributes", + "documentation":"

    Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

    " + } + }, + "documentation":"

    Event within a workflow execution. A history event can be one of these types:

    • ActivityTaskCancelRequested – A RequestCancelActivityTask decision was received by the system.

    • ActivityTaskCanceled – The activity task was successfully canceled.

    • ActivityTaskCompleted – An activity worker successfully completed an activity task by calling RespondActivityTaskCompleted.

    • ActivityTaskFailed – An activity worker failed an activity task by calling RespondActivityTaskFailed.

    • ActivityTaskScheduled – An activity task was scheduled for execution.

    • ActivityTaskStarted – The scheduled activity task was dispatched to a worker.

    • ActivityTaskTimedOut – The activity task timed out.

    • CancelTimerFailed – Failed to process CancelTimer decision. This happens when the decision isn't configured properly, for example no timer exists with the specified timer Id.

    • CancelWorkflowExecutionFailed – A request to cancel a workflow execution failed.

    • ChildWorkflowExecutionCanceled – A child workflow execution, started by this workflow execution, was canceled and closed.

    • ChildWorkflowExecutionCompleted – A child workflow execution, started by this workflow execution, completed successfully and was closed.

    • ChildWorkflowExecutionFailed – A child workflow execution, started by this workflow execution, failed to complete successfully and was closed.

    • ChildWorkflowExecutionStarted – A child workflow execution was successfully started.

    • ChildWorkflowExecutionTerminated – A child workflow execution, started by this workflow execution, was terminated.

    • ChildWorkflowExecutionTimedOut – A child workflow execution, started by this workflow execution, timed out and was closed.

    • CompleteWorkflowExecutionFailed – The workflow execution failed to complete.

    • ContinueAsNewWorkflowExecutionFailed – The workflow execution failed to complete after being continued as a new workflow execution.

    • DecisionTaskCompleted – The decider successfully completed a decision task by calling RespondDecisionTaskCompleted.

    • DecisionTaskScheduled – A decision task was scheduled for the workflow execution.

    • DecisionTaskStarted – The decision task was dispatched to a decider.

    • DecisionTaskTimedOut – The decision task timed out.

    • ExternalWorkflowExecutionCancelRequested – Request to cancel an external workflow execution was successfully delivered to the target execution.

    • ExternalWorkflowExecutionSignaled – A signal, requested by this workflow execution, was successfully delivered to the target external workflow execution.

    • FailWorkflowExecutionFailed – A request to mark a workflow execution as failed, itself failed.

    • MarkerRecorded – A marker was recorded in the workflow history as the result of a RecordMarker decision.

    • RecordMarkerFailed – A RecordMarker decision was returned as failed.

    • RequestCancelActivityTaskFailed – Failed to process RequestCancelActivityTask decision. This happens when the decision isn't configured properly.

    • RequestCancelExternalWorkflowExecutionFailed – Request to cancel an external workflow execution failed.

    • RequestCancelExternalWorkflowExecutionInitiated – A request was made to request the cancellation of an external workflow execution.

    • ScheduleActivityTaskFailed – Failed to process ScheduleActivityTask decision. This happens when the decision isn't configured properly, for example the activity type specified isn't registered.

    • SignalExternalWorkflowExecutionFailed – The request to signal an external workflow execution failed.

    • SignalExternalWorkflowExecutionInitiated – A request to signal an external workflow was made.

    • StartActivityTaskFailed – A scheduled activity task failed to start.

    • StartChildWorkflowExecutionFailed – Failed to process StartChildWorkflowExecution decision. This happens when the decision isn't configured properly, for example the workflow type specified isn't registered.

    • StartChildWorkflowExecutionInitiated – A request was made to start a child workflow execution.

    • StartTimerFailed – Failed to process StartTimer decision. This happens when the decision isn't configured properly, for example a timer already exists with the specified timer Id.

    • TimerCanceled – A timer, previously started for this workflow execution, was successfully canceled.

    • TimerFired – A timer, previously started for this workflow execution, fired.

    • TimerStarted – A timer was started for the workflow execution due to a StartTimer decision.

    • WorkflowExecutionCancelRequested – A request to cancel this workflow execution was made.

    • WorkflowExecutionCanceled – The workflow execution was successfully canceled and closed.

    • WorkflowExecutionCompleted – The workflow execution was closed due to successful completion.

    • WorkflowExecutionContinuedAsNew – The workflow execution was closed and a new execution of the same type was created with the same workflowId.

    • WorkflowExecutionFailed – The workflow execution closed due to a failure.

    • WorkflowExecutionSignaled – An external signal was received for the workflow execution.

    • WorkflowExecutionStarted – The workflow execution was started.

    • WorkflowExecutionTerminated – The workflow execution was terminated.

    • WorkflowExecutionTimedOut – The workflow execution was closed because a time out was exceeded.

    " + }, + "HistoryEventList":{ + "type":"list", + "member":{"shape":"HistoryEvent"} + }, + "Identity":{ + "type":"string", + "max":256 + }, + "LambdaFunctionCompletedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionScheduled event that was recorded when this Lambda task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "result":{ + "shape":"Data", + "documentation":"

    The results of the Lambda task.

    " + } + }, + "documentation":"

    Provides the details of the LambdaFunctionCompleted event. It isn't set for other event types.

    " + }, + "LambdaFunctionFailedEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionStarted event recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "reason":{ + "shape":"FailureReason", + "documentation":"

    The reason provided for the failure.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the failure.

    " + } + }, + "documentation":"

    Provides the details of the LambdaFunctionFailed event. It isn't set for other event types.

    " + }, + "LambdaFunctionScheduledEventAttributes":{ + "type":"structure", + "required":[ + "id", + "name", + "decisionTaskCompletedEventId" + ], + "members":{ + "id":{ + "shape":"FunctionId", + "documentation":"

    The unique ID of the Lambda task.

    " + }, + "name":{ + "shape":"FunctionName", + "documentation":"

    The name of the Lambda function.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

    " + }, + "input":{ + "shape":"FunctionInput", + "documentation":"

    The input provided to the Lambda task.

    " + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum amount of time a worker can take to process the Lambda task.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this activity task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the LambdaFunctionScheduled event. It isn't set for other event types.

    " + }, + "LambdaFunctionStartedEventAttributes":{ + "type":"structure", + "required":["scheduledEventId"], + "members":{ + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the LambdaFunctionStarted event. It isn't set for other event types.

    " + }, + "LambdaFunctionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "scheduledEventId", + "startedEventId" + ], + "members":{ + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskStarted event that was recorded when this activity task started. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "timeoutType":{ + "shape":"LambdaFunctionTimeoutType", + "documentation":"

    The type of the timeout that caused this event.

    " + } + }, + "documentation":"

    Provides details of the LambdaFunctionTimedOut event.

    " + }, + "LambdaFunctionTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "LimitExceededFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.

    ", + "exception":true + }, + "LimitedData":{ + "type":"string", + "max":2048 + }, + "ListActivityTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the activity types have been registered.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    If specified, only lists the activity types that have this name.

    " + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

    Specifies the registration status of the activity types to list.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the activity types.

    " + } + } + }, + "ListClosedWorkflowExecutionsInput":{ + "type":"structure", + "required":["domain"], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that contains the workflow executions to list.

    " + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    If specified, the workflow executions are included in the returned results based on whether their start times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their start times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    " + }, + "closeTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    If specified, the workflow executions are included in the returned results based on whether their close times are within the range specified by this filter. Also, if this parameter is specified, the returned results are ordered by their close times.

    startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

    " + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "closeStatusFilter":{ + "shape":"CloseStatusFilter", + "documentation":"

    If specified, only workflow executions that match this close status are listed. For example, if TERMINATED is specified, then only TERMINATED workflow executions are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

    If specified, only executions of the type specified in the filter are returned.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

    If specified, only executions that have the matching tag are listed.

    closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start or the close time of the executions.

    " + } + } + }, + "ListDomainsInput":{ + "type":"structure", + "required":["registrationStatus"], + "members":{ + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

    Specifies the registration status of the domains to list.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the results in reverse order. By default, the results are returned in ascending alphabetical order by name of the domains.

    " + } + } + }, + "ListOpenWorkflowExecutionsInput":{ + "type":"structure", + "required":[ + "domain", + "startTimeFilter" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that contains the workflow executions to list.

    " + }, + "startTimeFilter":{ + "shape":"ExecutionTimeFilter", + "documentation":"

    Workflow executions are included in the returned results based on whether their start times are within the range specified by this filter.

    " + }, + "typeFilter":{ + "shape":"WorkflowTypeFilter", + "documentation":"

    If specified, only executions of the type specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "tagFilter":{ + "shape":"TagFilter", + "documentation":"

    If specified, only executions that have the matching tag are listed.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the results in reverse order. By default the results are returned in descending order of the start time of the executions.

    " + }, + "executionFilter":{ + "shape":"WorkflowExecutionFilter", + "documentation":"

    If specified, only workflow executions matching the workflow ID specified in the filter are returned.

    executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

    " + } + } + }, + "ListTagsForResourceInput":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    " + } + } + }, + "ListTagsForResourceOutput":{ + "type":"structure", + "members":{ + "tags":{ + "shape":"ResourceTagList", + "documentation":"

    An array of tags associated with the domain.

    " + } + } + }, + "ListWorkflowTypesInput":{ + "type":"structure", + "required":[ + "domain", + "registrationStatus" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the workflow types have been registered.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    If specified, lists the workflow type with this name.

    " + }, + "registrationStatus":{ + "shape":"RegistrationStatus", + "documentation":"

    Specifies the registration status of the workflow types to list.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the results in reverse order. By default the results are returned in ascending alphabetical order of the name of the workflow types.

    " + } + } + }, + "MarkerName":{ + "type":"string", + "max":256, + "min":1 + }, + "MarkerRecordedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

    The name of the marker.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the marker.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarker decision that requested this marker. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the MarkerRecorded event.

    " + }, + "Name":{ + "type":"string", + "max":256, + "min":1 + }, + "OpenDecisionTasksCount":{ + "type":"integer", + "max":1, + "min":0 + }, + "OperationNotPermittedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned when the caller doesn't have sufficient permissions to invoke the action.

    ", + "exception":true + }, + "PageSize":{ + "type":"integer", + "max":1000, + "min":0 + }, + "PageToken":{ + "type":"string", + "max":2048 + }, + "PendingTaskCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{ + "shape":"Count", + "documentation":"

    The number of tasks in the task list.

    " + }, + "truncated":{ + "shape":"Truncated", + "documentation":"

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " + } + }, + "documentation":"

    Contains the count of tasks in a task list.

    " + }, + "PollForActivityTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain that contains the task lists being polled.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    Specifies the task list to poll for activity tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "identity":{ + "shape":"Identity", + "documentation":"

    Identity of the worker making the request, recorded in the ActivityTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    " + } + } + }, + "PollForDecisionTaskInput":{ + "type":"structure", + "required":[ + "domain", + "taskList" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the task lists to poll.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    Specifies the task list to poll for decision tasks.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "identity":{ + "shape":"Identity", + "documentation":"

    Identity of the decider making the request, which is recorded in the DecisionTaskStarted event in the workflow history. This enables diagnostic tracing when problems arise. The form of this identity is user defined.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 seconds. Using an expired pagination token will return a 400 error: \"Specified token has exceeded its maximum lifetime\".

    The configured maximumPageSize determines how many results can be returned in a single call.

    The nextPageToken returned by this action cannot be used with GetWorkflowExecutionHistory to get the next page. You must call PollForDecisionTask again (with the nextPageToken) to retrieve the next page of history records. Calling PollForDecisionTask with a nextPageToken doesn't return a new decision task.

    " + }, + "maximumPageSize":{ + "shape":"PageSize", + "documentation":"

    The maximum number of results that are returned per call. Use nextPageToken to obtain further pages of results.

    This is an upper limit only; the actual number of results returned per call may be fewer than the specified maximum.

    " + }, + "reverseOrder":{ + "shape":"ReverseOrder", + "documentation":"

    When set to true, returns the events in reverse order. By default the results are returned in ascending order of the eventTimestamp of the events.

    " + } + } + }, + "RecordActivityTaskHeartbeatInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    " + }, + "details":{ + "shape":"LimitedData", + "documentation":"

    If specified, contains details about the progress of the task.

    " + } + } + }, + "RecordMarkerDecisionAttributes":{ + "type":"structure", + "required":["markerName"], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

    The name of the marker.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the marker.

    " + } + }, + "documentation":"

    Provides the details of the RecordMarker decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RecordMarkerFailedCause":{ + "type":"string", + "enum":["OPERATION_NOT_PERMITTED"] + }, + "RecordMarkerFailedEventAttributes":{ + "type":"structure", + "required":[ + "markerName", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "markerName":{ + "shape":"MarkerName", + "documentation":"

    The marker's name.

    " + }, + "cause":{ + "shape":"RecordMarkerFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RecordMarkerFailed decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the RecordMarkerFailed event.

    " + }, + "RegisterActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which this activity is to be registered.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the activity type within the domain.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the activity type.

    The activity type consists of the name and version, the combination of which must be unique within the domain.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    A textual description of the activity type.

    " + }, + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum duration that a worker can take to process tasks of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskHeartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

    If set, specifies the default task list to use for scheduling tasks of this activity type. This default task list is used if a task list isn't provided when a task is scheduled through the ScheduleActivityTask Decision.

    " + }, + "defaultTaskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The default task priority to assign to the activity type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the in the Amazon SWF Developer Guide..

    " + }, + "defaultTaskScheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum duration that a task of this activity type can wait before being assigned to a worker. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskScheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum duration for a task of this activity type. This default can be overridden when scheduling an activity task using the ScheduleActivityTask Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + } + }, + "RegisterDomainInput":{ + "type":"structure", + "required":[ + "name", + "workflowExecutionRetentionPeriodInDays" + ], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

    Name of the domain to register. The name must be unique in the region that the domain is registered in.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    A text description of the domain.

    " + }, + "workflowExecutionRetentionPeriodInDays":{ + "shape":"DurationInDays", + "documentation":"

    The duration (in days) that records and histories of workflow executions on the domain should be kept by the service. After the retention period, the workflow execution isn't available in the results of visibility calls.

    If you pass the value NONE or 0 (zero), then the workflow execution history isn't retained. As soon as the workflow execution completes, the execution record and its history are deleted.

    The maximum workflow execution retention period is 90 days. For more information about Amazon SWF service limits, see: Amazon SWF Service Limits in the Amazon SWF Developer Guide.

    " + }, + "tags":{ + "shape":"ResourceTagList", + "documentation":"

    Tags to be added when registering a domain.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    " + } + } + }, + "RegisterWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "name", + "version" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which to register the workflow type.

    " + }, + "name":{ + "shape":"Name", + "documentation":"

    The name of the workflow type.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the workflow type.

    The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    Textual description of the workflow type.

    " + }, + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultExecutionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

    The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

    " + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

    If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

    " + }, + "defaultTaskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "defaultChildPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "defaultLambdaRole":{ + "shape":"Arn", + "documentation":"

    The default IAM role attached to this workflow type.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

    " + } + } + }, + "RegistrationStatus":{ + "type":"string", + "enum":[ + "REGISTERED", + "DEPRECATED" + ] + }, + "RequestCancelActivityTaskDecisionAttributes":{ + "type":"structure", + "required":["activityId"], + "members":{ + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The activityId of the activity task to be canceled.

    " + } + }, + "documentation":"

    Provides the details of the RequestCancelActivityTask decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RequestCancelActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_ID_UNKNOWN", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The activityId provided in the RequestCancelActivityTask decision that failed.

    " + }, + "cause":{ + "shape":"RequestCancelActivityTaskFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelActivityTask decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the RequestCancelActivityTaskFailed event.

    " + }, + "RequestCancelExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the external workflow execution to cancel.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the external workflow execution to cancel.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + } + }, + "documentation":"

    Provides the details of the RequestCancelExternalWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "RequestCancelExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "RequestCancelExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the external workflow to which the cancel request was to be delivered.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the external workflow execution.

    " + }, + "cause":{ + "shape":"RequestCancelExternalWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this external workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the RequestCancelExternalWorkflowExecutionFailed event.

    " + }, + "RequestCancelExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the external workflow execution to be canceled.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the external workflow execution to be canceled.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the RequestCancelExternalWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + } + }, + "documentation":"

    Provides the details of the RequestCancelExternalWorkflowExecutionInitiated event.

    " + }, + "RequestCancelWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow execution to cancel.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the workflow execution to cancel.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the workflow execution to cancel.

    " + } + } + }, + "ResourceTag":{ + "type":"structure", + "required":["key"], + "members":{ + "key":{ + "shape":"ResourceTagKey", + "documentation":"

    The key of a tag.

    " + }, + "value":{ + "shape":"ResourceTagValue", + "documentation":"

    The value of a tag.

    " + } + }, + "documentation":"

    Tags are key-value pairs that can be associated with Amazon SWF state machines and activities.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    " + }, + "ResourceTagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceTagKeyList":{ + "type":"list", + "member":{"shape":"ResourceTagKey"} + }, + "ResourceTagList":{ + "type":"list", + "member":{"shape":"ResourceTag"} + }, + "ResourceTagValue":{ + "type":"string", + "max":256 + }, + "RespondActivityTaskCanceledInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    Information about the cancellation.

    " + } + } + }, + "RespondActivityTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    " + }, + "result":{ + "shape":"Data", + "documentation":"

    The result of the activity task. It is a free form string that is implementation specific.

    " + } + } + }, + "RespondActivityTaskFailedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The taskToken of the ActivityTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    " + }, + "reason":{ + "shape":"FailureReason", + "documentation":"

    Description of the error that may assist in diagnostics.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    Detailed information about the failure.

    " + } + } + }, + "RespondDecisionTaskCompletedInput":{ + "type":"structure", + "required":["taskToken"], + "members":{ + "taskToken":{ + "shape":"TaskToken", + "documentation":"

    The taskToken from the DecisionTask.

    taskToken is generated by the service and should be treated as an opaque value. If the task is passed to another process, its taskToken must also be passed. This enables it to provide its progress and respond with results.

    " + }, + "decisions":{ + "shape":"DecisionList", + "documentation":"

    The list of decisions (possibly empty) made by the decider while processing this decision task. See the docs for the Decision structure for details.

    " + }, + "executionContext":{ + "shape":"Data", + "documentation":"

    User defined context to add to workflow execution.

    " + } + }, + "documentation":"

    Input data for a TaskCompleted response to a decision task.

    " + }, + "ReverseOrder":{"type":"boolean"}, + "Run":{ + "type":"structure", + "members":{ + "runId":{ + "shape":"WorkflowRunId", + "documentation":"

    The runId of a workflow execution. This ID is generated by the service and can be used to uniquely identify the workflow execution within a domain.

    " + } + }, + "documentation":"

    Specifies the runId of a workflow execution.

    " + }, + "ScheduleActivityTaskDecisionAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The type of the activity task to schedule.

    " + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The activityId of the activity task.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the activity task.

    " + }, + "scheduleToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration for this activity task.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A schedule-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    If set, specifies the name of the task list in which to schedule the activity task. If not specified, the defaultTaskList registered with the activity type is used.

    A task list for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default task list was specified at registration time then a fault is returned.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    If set, specifies the priority with which the activity task is to be assigned to a worker. This overrides the defaultTaskPriority specified when registering the activity type using RegisterActivityType. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "scheduleToStartTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the maximum duration the activity task can wait to be assigned to a worker. This overrides the default schedule-to-start timeout specified when registering the activity type using RegisterActivityType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A schedule-to-start timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default schedule-to-start timeout was specified at registration time then a fault is returned.

    " + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the maximum duration a worker may take to process this activity task. This overrides the default start-to-close timeout specified when registering the activity type using RegisterActivityType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A start-to-close timeout for this activity task must be specified either as a default for the activity type or through this field. If neither this field is set nor a default start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "heartbeatTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    If set, specifies the maximum time before which a worker processing a task of this type must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or returns a result, it is ignored. This overrides the default heartbeat timeout specified when registering the activity type using RegisterActivityType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + } + }, + "documentation":"

    Provides the details of the ScheduleActivityTask decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • activityType.name – String constraint. The key is swf:activityType.name.

      • activityType.version – String constraint. The key is swf:activityType.version.

      • taskList – String constraint. The key is swf:taskList.name.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "ScheduleActivityTaskFailedCause":{ + "type":"string", + "enum":[ + "ACTIVITY_TYPE_DEPRECATED", + "ACTIVITY_TYPE_DOES_NOT_EXIST", + "ACTIVITY_ID_ALREADY_IN_USE", + "OPEN_ACTIVITIES_LIMIT_EXCEEDED", + "ACTIVITY_CREATION_RATE_EXCEEDED", + "DEFAULT_SCHEDULE_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_SCHEDULE_TO_START_TIMEOUT_UNDEFINED", + "DEFAULT_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_HEARTBEAT_TIMEOUT_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "ScheduleActivityTaskFailedEventAttributes":{ + "type":"structure", + "required":[ + "activityType", + "activityId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The activity type provided in the ScheduleActivityTask decision that failed.

    " + }, + "activityId":{ + "shape":"ActivityId", + "documentation":"

    The activityId provided in the ScheduleActivityTask decision that failed.

    " + }, + "cause":{ + "shape":"ScheduleActivityTaskFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ScheduleActivityTaskFailed event.

    " + }, + "ScheduleLambdaFunctionDecisionAttributes":{ + "type":"structure", + "required":[ + "id", + "name" + ], + "members":{ + "id":{ + "shape":"FunctionId", + "documentation":"

    A string that identifies the Lambda function execution in the event history.

    " + }, + "name":{ + "shape":"FunctionName", + "documentation":"

    The name, or ARN, of the Lambda function to schedule.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the Lambda task.

    " + }, + "input":{ + "shape":"FunctionInput", + "documentation":"

    The optional input data to be supplied to the Lambda function.

    " + }, + "startToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The timeout value, in seconds, after which the Lambda function is considered to be failed once it has started. This can be any integer from 1-300 (1s-5m). If no value is supplied, than a default value of 300s is assumed.

    " + } + }, + "documentation":"

    Decision attributes specified in scheduleLambdaFunctionDecisionAttributes within the list of decisions decisions passed to RespondDecisionTaskCompleted.

    " + }, + "ScheduleLambdaFunctionFailedCause":{ + "type":"string", + "enum":[ + "ID_ALREADY_IN_USE", + "OPEN_LAMBDA_FUNCTIONS_LIMIT_EXCEEDED", + "LAMBDA_FUNCTION_CREATION_RATE_EXCEEDED", + "LAMBDA_SERVICE_NOT_AVAILABLE_IN_REGION" + ] + }, + "ScheduleLambdaFunctionFailedEventAttributes":{ + "type":"structure", + "required":[ + "id", + "name", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "id":{ + "shape":"FunctionId", + "documentation":"

    The ID provided in the ScheduleLambdaFunction decision that failed.

    " + }, + "name":{ + "shape":"FunctionName", + "documentation":"

    The name of the Lambda function.

    " + }, + "cause":{ + "shape":"ScheduleLambdaFunctionFailedCause", + "documentation":"

    The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the LambdaFunctionCompleted event corresponding to the decision that resulted in scheduling this Lambda task. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the ScheduleLambdaFunctionFailed event. It isn't set for other event types.

    " + }, + "SignalExternalWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the workflow execution to be signaled.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the workflow execution to be signaled.

    " + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

    The name of the signal.The target workflow execution uses the signal name and input to process the signal.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input data to be provided with the signal. The target workflow execution uses the signal name and input data to process the signal.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that can be used by the decider in subsequent decision tasks.

    " + } + }, + "documentation":"

    Provides the details of the SignalExternalWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "SignalExternalWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "UNKNOWN_EXTERNAL_WORKFLOW_EXECUTION", + "SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "SignalExternalWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "cause", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the external workflow execution that the signal was being delivered to.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the external workflow execution that the signal was being delivered to.

    " + }, + "cause":{ + "shape":"SignalExternalWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflowExecution decision to request this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the SignalExternalWorkflowExecutionFailed event.

    " + }, + "SignalExternalWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "signalName", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the external workflow execution.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the external workflow execution to send the signal to.

    " + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

    The name of the signal.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the signal.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the SignalExternalWorkflowExecution decision for this signal. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent decision tasks.

    " + } + }, + "documentation":"

    Provides the details of the SignalExternalWorkflowExecutionInitiated event.

    " + }, + "SignalName":{ + "type":"string", + "max":256, + "min":1 + }, + "SignalWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "signalName" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain containing the workflow execution to signal.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the workflow execution to signal.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the workflow execution to signal.

    " + }, + "signalName":{ + "shape":"SignalName", + "documentation":"

    The name of the signal. This name must be meaningful to the target workflow.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    Data to attach to the WorkflowExecutionSignaled event in the target workflow execution's history.

    " + } + } + }, + "StartChildWorkflowExecutionDecisionAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "workflowId" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the workflow execution to be started.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the workflow execution.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the child workflow execution.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input to be provided to the workflow execution.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    An execution start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default execution start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list to be used for decision tasks of the child workflow execution.

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    A task priority that, if set, specifies the priority for a decision task of this workflow execution. This overrides the defaultTaskPriority specified when registering the workflow type. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    If set, specifies the policy to use for the child workflow executions if the workflow execution being started is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags to associate with the child workflow execution. A maximum of 5 tags can be specified. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role attached to the child workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the StartChildWorkflowExecution decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • Constrain the following parameters by using a Condition element with the appropriate keys.

      • tagList.member.N – The key is \"swf:tagList.N\" where N is the tag number from 0 to 4, inclusive.

      • taskList – String constraint. The key is swf:taskList.name.

      • workflowType.name – String constraint. The key is swf:workflowType.name.

      • workflowType.version – String constraint. The key is swf:workflowType.version.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "StartChildWorkflowExecutionFailedCause":{ + "type":"string", + "enum":[ + "WORKFLOW_TYPE_DOES_NOT_EXIST", + "WORKFLOW_TYPE_DEPRECATED", + "OPEN_CHILDREN_LIMIT_EXCEEDED", + "OPEN_WORKFLOWS_LIMIT_EXCEEDED", + "CHILD_CREATION_RATE_EXCEEDED", + "WORKFLOW_ALREADY_RUNNING", + "DEFAULT_EXECUTION_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_TASK_LIST_UNDEFINED", + "DEFAULT_TASK_START_TO_CLOSE_TIMEOUT_UNDEFINED", + "DEFAULT_CHILD_POLICY_UNDEFINED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartChildWorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":[ + "workflowType", + "cause", + "workflowId", + "initiatedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type provided in the StartChildWorkflowExecution Decision that failed.

    " + }, + "cause":{ + "shape":"StartChildWorkflowExecutionFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    When cause is set to OPERATION_NOT_PERMITTED, the decision fails because it lacks sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the child workflow execution.

    " + }, + "initiatedEventId":{ + "shape":"EventId", + "documentation":"

    When the cause is WORKFLOW_ALREADY_RUNNING, initiatedEventId is the ID of the StartChildWorkflowExecutionInitiated event that corresponds to the StartChildWorkflowExecution Decision to start the workflow execution. You can use this information to diagnose problems by tracing back the chain of events leading up to this event.

    When the cause isn't WORKFLOW_ALREADY_RUNNING, initiatedEventId is set to 0 because the StartChildWorkflowExecutionInitiated event doesn't exist.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that the decider can use in subsequent workflow tasks. This data isn't sent to the child workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the StartChildWorkflowExecutionFailed event.

    " + }, + "StartChildWorkflowExecutionInitiatedEventAttributes":{ + "type":"structure", + "required":[ + "workflowId", + "workflowType", + "taskList", + "decisionTaskCompletedEventId", + "childPolicy" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the child workflow execution.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the child workflow execution.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent decision tasks. This data isn't sent to the activity.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The inputs provided to the child workflow execution.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration for the child workflow execution. If the workflow execution isn't closed within this duration, it is timed out and force-terminated.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list used for the decision tasks of the child workflow execution.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The priority assigned for the decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartChildWorkflowExecution Decision to request this child workflow execution. This information can be useful for diagnosing problems by tracing back the cause of events.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy to use for the child workflow executions if this execution gets terminated by explicitly calling the TerminateWorkflowExecution action or due to an expired timeout.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration allowed for the decision tasks for this workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags to associated with the child workflow execution.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role to attach to the child workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the StartChildWorkflowExecutionInitiated event.

    " + }, + "StartLambdaFunctionFailedCause":{ + "type":"string", + "enum":["ASSUME_ROLE_FAILED"] + }, + "StartLambdaFunctionFailedEventAttributes":{ + "type":"structure", + "members":{ + "scheduledEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the ActivityTaskScheduled event that was recorded when this activity task was scheduled. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    " + }, + "cause":{ + "shape":"StartLambdaFunctionFailedCause", + "documentation":"

    The cause of the failure. To help diagnose issues, use this information to trace back the chain of events leading up to this event.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because the IAM role attached to the execution lacked sufficient permissions. For details and example IAM policies, see Lambda Tasks in the Amazon SWF Developer Guide.

    " + }, + "message":{ + "shape":"CauseMessage", + "documentation":"

    A description that can help diagnose the cause of the fault.

    " + } + }, + "documentation":"

    Provides the details of the StartLambdaFunctionFailed event. It isn't set for other event types.

    " + }, + "StartTimerDecisionAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The unique ID of the timer.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not contain the literal string arn.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    The data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + }, + "startToFireTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

    The duration to wait before firing the timer.

    The duration is specified in seconds, an integer greater than or equal to 0.

    " + } + }, + "documentation":"

    Provides the details of the StartTimer decision.

    Access Control

    You can use IAM policies to control this decision's access to Amazon SWF resources as follows:

    • Use a Resource element with the domain name to limit the action to only specified domains.

    • Use an Action element to allow or deny permission to call this action.

    • You cannot use an IAM policy to constrain this action's parameters.

    If the caller doesn't have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "StartTimerFailedCause":{ + "type":"string", + "enum":[ + "TIMER_ID_ALREADY_IN_USE", + "OPEN_TIMERS_LIMIT_EXCEEDED", + "TIMER_CREATION_RATE_EXCEEDED", + "OPERATION_NOT_PERMITTED" + ] + }, + "StartTimerFailedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "cause", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The timerId provided in the StartTimer decision that failed.

    " + }, + "cause":{ + "shape":"StartTimerFailedCause", + "documentation":"

    The cause of the failure. This information is generated by the system and can be useful for diagnostic purposes.

    If cause is set to OPERATION_NOT_PERMITTED, the decision failed because it lacked sufficient permissions. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows in the Amazon SWF Developer Guide.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the StartTimerFailed event.

    " + }, + "StartWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain in which the workflow execution is created.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The user defined identifier associated with the workflow execution. You can use this to associate a custom identifier with the workflow execution. You may specify the same identifier if a workflow execution is logically a restart of a previous execution. You cannot have two open workflow executions with the same workflowId at the same time within the same domain.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the workflow to start.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The task list to use for the decision tasks generated for this workflow execution. This overrides the defaultTaskList specified when registering the workflow type.

    A task list for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task list was specified at registration time then a fault is returned.

    The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\\u0000-\\u001f | \\u007f-\\u009f). Also, it must not be the literal string arn.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The task priority to use for this workflow execution. This overrides any default priority that was assigned when the workflow type was registered. If not set, then the default task priority for the workflow type is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The input for the workflow execution. This is a free form string which should be meaningful to the workflow you are starting. This input is made available to the new workflow execution in the WorkflowExecutionStarted history event.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The total duration for this workflow execution. This overrides the defaultExecutionStartToCloseTimeout specified when registering the workflow type.

    The duration is specified in seconds; an integer greater than or equal to 0. Exceeding this limit causes the workflow execution to time out. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of \"NONE\" for this timeout; there is a one-year max limit on the time that a workflow execution can run.

    An execution start-to-close timeout must be specified either through this parameter or as a default when the workflow type is registered. If neither this parameter nor a default execution start-to-close timeout is specified, a fault is returned.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags to associate with the workflow execution. You can specify a maximum of 5 tags. You can list workflow executions with a specific tag by calling ListOpenWorkflowExecutions or ListClosedWorkflowExecutions and specifying a TagFilter.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    Specifies the maximum duration of decision tasks for this workflow execution. This parameter overrides the defaultTaskStartToCloseTimout specified when registering the workflow type using RegisterWorkflowType.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    A task start-to-close timeout for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default task start-to-close timeout was specified at registration time then a fault is returned.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    If set, specifies the policy to use for the child workflow executions of this workflow execution if it is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This policy overrides the default child policy specified when registering the workflow type using RegisterWorkflowType.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role to attach to this workflow execution.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't attach an IAM role, any attempt to schedule a Lambda task fails. This results in a ScheduleLambdaFunctionFailed history event. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

    " + } + } + }, + "Tag":{ + "type":"string", + "max":256, + "min":0 + }, + "TagFilter":{ + "type":"structure", + "required":["tag"], + "members":{ + "tag":{ + "shape":"Tag", + "documentation":"

    Specifies the tag that must be associated with the execution for it to meet the filter criteria.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    " + } + }, + "documentation":"

    Used to filter the workflow executions in visibility APIs based on a tag.

    " + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":5 + }, + "TagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    " + }, + "tags":{ + "shape":"ResourceTagList", + "documentation":"

    The list of tags to add to a domain.

    Tags may only contain unicode letters, digits, whitespace, or these symbols: _ . : / = + - @.

    " + } + } + }, + "TaskList":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the task list.

    " + } + }, + "documentation":"

    Represents a task list.

    " + }, + "TaskPriority":{"type":"string"}, + "TaskToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "TerminateReason":{ + "type":"string", + "max":256 + }, + "TerminateWorkflowExecutionInput":{ + "type":"structure", + "required":[ + "domain", + "workflowId" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The domain of the workflow execution to terminate.

    " + }, + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId of the workflow execution to terminate.

    " + }, + "runId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    The runId of the workflow execution to terminate.

    " + }, + "reason":{ + "shape":"TerminateReason", + "documentation":"

    A descriptive reason for terminating the workflow execution.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    Details for terminating the workflow execution.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    If set, specifies the policy to use for the child workflow executions of the workflow execution being terminated. This policy overrides the child policy specified for the workflow execution at registration time or when starting the execution.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    A child policy for this workflow execution must be specified either as a default for the workflow type or through this parameter. If neither this parameter is set nor a default child policy was specified at registration time then a fault is returned.

    " + } + } + }, + "TimerCanceledEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The unique ID of the timer that was canceled.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelTimer decision to cancel this timer. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the TimerCanceled event.

    " + }, + "TimerFiredEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The unique ID of the timer that fired.

    " + }, + "startedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the TimerStarted event that was recorded when this timer was started. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the TimerFired event.

    " + }, + "TimerId":{ + "type":"string", + "max":256, + "min":1 + }, + "TimerStartedEventAttributes":{ + "type":"structure", + "required":[ + "timerId", + "startToFireTimeout", + "decisionTaskCompletedEventId" + ], + "members":{ + "timerId":{ + "shape":"TimerId", + "documentation":"

    The unique ID of the timer that was started.

    " + }, + "control":{ + "shape":"Data", + "documentation":"

    Data attached to the event that can be used by the decider in subsequent workflow tasks.

    " + }, + "startToFireTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

    The duration of time after which the timer fires.

    The duration is specified in seconds, an integer greater than or equal to 0.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the StartTimer decision for this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the TimerStarted event.

    " + }, + "Timestamp":{"type":"timestamp"}, + "TooManyTagsFault":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You've exceeded the number of tags allowed for a domain.

    ", + "exception":true + }, + "Truncated":{"type":"boolean"}, + "TypeAlreadyExistsFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned if the type already exists in the specified domain. You may get this fault if you are registering a type that is either already registered or deprecated, or if you undeprecate a type that is currently registered.

    ", + "exception":true + }, + "TypeDeprecatedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned when the specified activity or workflow type was already deprecated.

    ", + "exception":true + }, + "UndeprecateActivityTypeInput":{ + "type":"structure", + "required":[ + "domain", + "activityType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain of the deprecated activity type.

    " + }, + "activityType":{ + "shape":"ActivityType", + "documentation":"

    The activity type to undeprecate.

    " + } + } + }, + "UndeprecateDomainInput":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"DomainName", + "documentation":"

    The name of the domain of the deprecated workflow type.

    " + } + } + }, + "UndeprecateWorkflowTypeInput":{ + "type":"structure", + "required":[ + "domain", + "workflowType" + ], + "members":{ + "domain":{ + "shape":"DomainName", + "documentation":"

    The name of the domain of the deprecated workflow type.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The name of the domain of the deprecated workflow type.

    " + } + } + }, + "UnknownResourceFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.

    ", + "exception":true + }, + "UntagResourceInput":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "documentation":"

    The Amazon Resource Name (ARN) for the Amazon SWF domain.

    " + }, + "tagKeys":{ + "shape":"ResourceTagKeyList", + "documentation":"

    The list of tags to remove from the Amazon SWF domain.

    " + } + } + }, + "Version":{ + "type":"string", + "max":64, + "min":1 + }, + "VersionOptional":{ + "type":"string", + "max":64 + }, + "WorkflowExecution":{ + "type":"structure", + "required":[ + "workflowId", + "runId" + ], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The user defined identifier associated with the workflow execution.

    " + }, + "runId":{ + "shape":"WorkflowRunId", + "documentation":"

    A system-generated unique identifier for the workflow execution.

    " + } + }, + "documentation":"

    Represents a workflow execution.

    " + }, + "WorkflowExecutionAlreadyStartedFault":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ErrorMessage", + "documentation":"

    A description that may help with diagnosing the cause of the fault.

    " + } + }, + "documentation":"

    Returned by StartWorkflowExecution when an open execution with the same workflowId is already running in the specified domain.

    ", + "exception":true + }, + "WorkflowExecutionCancelRequestedCause":{ + "type":"string", + "enum":["CHILD_POLICY_APPLIED"] + }, + "WorkflowExecutionCancelRequestedEventAttributes":{ + "type":"structure", + "members":{ + "externalWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The external workflow execution for which the cancellation was requested.

    " + }, + "externalInitiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the RequestCancelExternalWorkflowExecutionInitiated event corresponding to the RequestCancelExternalWorkflowExecution decision to cancel this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "cause":{ + "shape":"WorkflowExecutionCancelRequestedCause", + "documentation":"

    If set, indicates that the request to cancel the workflow execution was automatically generated, and specifies the cause. This happens if the parent workflow execution times out or is terminated, and the child policy is set to cancel child executions.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionCancelRequested event.

    " + }, + "WorkflowExecutionCanceledEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "details":{ + "shape":"Data", + "documentation":"

    The details of the cancellation.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CancelWorkflowExecution decision for this cancellation request. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionCanceled event.

    " + }, + "WorkflowExecutionCompletedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "result":{ + "shape":"Data", + "documentation":"

    The result produced by the workflow execution upon successful completion.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the CompleteWorkflowExecution decision to complete this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionCompleted event.

    " + }, + "WorkflowExecutionConfiguration":{ + "type":"structure", + "required":[ + "taskStartToCloseTimeout", + "executionStartToCloseTimeout", + "taskList", + "childPolicy" + ], + "members":{ + "taskStartToCloseTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

    The maximum duration allowed for decision tasks for this workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSeconds", + "documentation":"

    The total duration for this workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The task list used for the decision tasks generated for this workflow execution.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The priority assigned to decision tasks for this workflow execution. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role attached to the child workflow execution.

    " + } + }, + "documentation":"

    The configuration settings for a workflow execution including timeout values, tasklist etc. These configuration settings are determined from the defaults specified when registering the workflow type and those specified when starting the workflow execution.

    " + }, + "WorkflowExecutionContinuedAsNewEventAttributes":{ + "type":"structure", + "required":[ + "decisionTaskCompletedEventId", + "newExecutionRunId", + "taskList", + "childPolicy", + "workflowType" + ], + "members":{ + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the new workflow execution.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the ContinueAsNewWorkflowExecution decision that started this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "newExecutionRunId":{ + "shape":"WorkflowRunId", + "documentation":"

    The runId of the new workflow execution.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The total duration allowed for the new workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The task list to use for the decisions of the new (continued) workflow execution.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The priority of the task to use for the decisions of the new (continued) workflow execution.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration of decision tasks for the new workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy to use for the child workflow executions of the new execution if it is terminated by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags associated with the new workflow execution.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type of this execution.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role to attach to the new (continued) workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionContinuedAsNew event.

    " + }, + "WorkflowExecutionCount":{ + "type":"structure", + "required":["count"], + "members":{ + "count":{ + "shape":"Count", + "documentation":"

    The number of workflow executions.

    " + }, + "truncated":{ + "shape":"Truncated", + "documentation":"

    If set to true, indicates that the actual count was more than the maximum supported by this API and the count returned is the truncated value.

    " + } + }, + "documentation":"

    Contains the count of workflow executions returned from CountOpenWorkflowExecutions or CountClosedWorkflowExecutions

    " + }, + "WorkflowExecutionDetail":{ + "type":"structure", + "required":[ + "executionInfo", + "executionConfiguration", + "openCounts" + ], + "members":{ + "executionInfo":{ + "shape":"WorkflowExecutionInfo", + "documentation":"

    Information about the workflow execution.

    " + }, + "executionConfiguration":{ + "shape":"WorkflowExecutionConfiguration", + "documentation":"

    The configuration settings for this workflow execution including timeout values, tasklist etc.

    " + }, + "openCounts":{ + "shape":"WorkflowExecutionOpenCounts", + "documentation":"

    The number of tasks for this workflow execution. This includes open and closed tasks of all types.

    " + }, + "latestActivityTaskTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The time when the last activity task was scheduled for this workflow execution. You can use this information to determine if the workflow has not made progress for an unusually long period of time and might require a corrective action.

    " + }, + "latestExecutionContext":{ + "shape":"Data", + "documentation":"

    The latest executionContext provided by the decider for this workflow execution. A decider can provide an executionContext (a free-form string) when closing a decision task using RespondDecisionTaskCompleted.

    " + } + }, + "documentation":"

    Contains details about a workflow execution.

    " + }, + "WorkflowExecutionFailedEventAttributes":{ + "type":"structure", + "required":["decisionTaskCompletedEventId"], + "members":{ + "reason":{ + "shape":"FailureReason", + "documentation":"

    The descriptive reason provided for the failure.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details of the failure.

    " + }, + "decisionTaskCompletedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the DecisionTaskCompleted event corresponding to the decision task that resulted in the FailWorkflowExecution decision to fail this execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionFailed event.

    " + }, + "WorkflowExecutionFilter":{ + "type":"structure", + "required":["workflowId"], + "members":{ + "workflowId":{ + "shape":"WorkflowId", + "documentation":"

    The workflowId to pass of match the criteria of this filter.

    " + } + }, + "documentation":"

    Used to filter the workflow executions in visibility APIs by their workflowId.

    " + }, + "WorkflowExecutionInfo":{ + "type":"structure", + "required":[ + "execution", + "workflowType", + "startTimestamp", + "executionStatus" + ], + "members":{ + "execution":{ + "shape":"WorkflowExecution", + "documentation":"

    The workflow execution this information is about.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The type of the workflow execution.

    " + }, + "startTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The time when the execution was started.

    " + }, + "closeTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The time when the workflow execution was closed. Set only if the execution status is CLOSED.

    " + }, + "executionStatus":{ + "shape":"ExecutionStatus", + "documentation":"

    The current status of the execution.

    " + }, + "closeStatus":{ + "shape":"CloseStatus", + "documentation":"

    If the execution status is closed then this specifies how the execution was closed:

    • COMPLETED – the execution was successfully completed.

    • CANCELED – the execution was canceled.Cancellation allows the implementation to gracefully clean up before the execution is closed.

    • TERMINATED – the execution was force terminated.

    • FAILED – the execution failed to complete.

    • TIMED_OUT – the execution did not complete in the alloted time and was automatically timed out.

    • CONTINUED_AS_NEW – the execution is logically continued. This means the current execution was completed and a new execution was started to carry on the workflow.

    " + }, + "parent":{ + "shape":"WorkflowExecution", + "documentation":"

    If this workflow execution is a child of another execution then contains the workflow execution that started this execution.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags associated with the workflow execution. Tags can be used to identify and list workflow executions of interest through the visibility APIs. A workflow execution can have a maximum of 5 tags.

    " + }, + "cancelRequested":{ + "shape":"Canceled", + "documentation":"

    Set to true if a cancellation is requested for this workflow execution.

    " + } + }, + "documentation":"

    Contains information about a workflow execution.

    " + }, + "WorkflowExecutionInfoList":{ + "type":"list", + "member":{"shape":"WorkflowExecutionInfo"} + }, + "WorkflowExecutionInfos":{ + "type":"structure", + "required":["executionInfos"], + "members":{ + "executionInfos":{ + "shape":"WorkflowExecutionInfoList", + "documentation":"

    The list of workflow information structures.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, + "documentation":"

    Contains a paginated list of information about workflow executions.

    " + }, + "WorkflowExecutionOpenCounts":{ + "type":"structure", + "required":[ + "openActivityTasks", + "openDecisionTasks", + "openTimers", + "openChildWorkflowExecutions" + ], + "members":{ + "openActivityTasks":{ + "shape":"Count", + "documentation":"

    The count of activity tasks whose status is OPEN.

    " + }, + "openDecisionTasks":{ + "shape":"OpenDecisionTasksCount", + "documentation":"

    The count of decision tasks whose status is OPEN. A workflow execution can have at most one open decision task.

    " + }, + "openTimers":{ + "shape":"Count", + "documentation":"

    The count of timers started by this workflow execution that have not fired yet.

    " + }, + "openChildWorkflowExecutions":{ + "shape":"Count", + "documentation":"

    The count of child workflow executions whose status is OPEN.

    " + }, + "openLambdaFunctions":{ + "shape":"Count", + "documentation":"

    The count of Lambda tasks whose status is OPEN.

    " + } + }, + "documentation":"

    Contains the counts of open tasks, child workflow executions and timers for a workflow execution.

    " + }, + "WorkflowExecutionSignaledEventAttributes":{ + "type":"structure", + "required":["signalName"], + "members":{ + "signalName":{ + "shape":"SignalName", + "documentation":"

    The name of the signal received. The decider can use the signal name and inputs to determine how to the process the signal.

    " + }, + "input":{ + "shape":"Data", + "documentation":"

    The inputs provided with the signal. The decider can use the signal name and inputs to determine how to process the signal.

    " + }, + "externalWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The workflow execution that sent the signal. This is set only of the signal was sent by another workflow execution.

    " + }, + "externalInitiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the SignalExternalWorkflowExecutionInitiated event corresponding to the SignalExternalWorkflow decision to signal this workflow execution.The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event. This field is set only if the signal was initiated by another workflow execution.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionSignaled event.

    " + }, + "WorkflowExecutionStartedEventAttributes":{ + "type":"structure", + "required":[ + "childPolicy", + "taskList", + "workflowType" + ], + "members":{ + "input":{ + "shape":"Data", + "documentation":"

    The input provided to the workflow execution.

    " + }, + "executionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration for this workflow execution.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "taskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The maximum duration of decision tasks for this workflow type.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy to use for the child workflow executions if this workflow execution is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "taskList":{ + "shape":"TaskList", + "documentation":"

    The name of the task list for scheduling the decision tasks for this workflow execution.

    " + }, + "taskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The priority of the decision tasks in the workflow execution.

    " + }, + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type of this execution.

    " + }, + "tagList":{ + "shape":"TagList", + "documentation":"

    The list of tags associated with this workflow execution. An execution can have up to 5 tags.

    " + }, + "continuedExecutionRunId":{ + "shape":"WorkflowRunIdOptional", + "documentation":"

    If this workflow execution was started due to a ContinueAsNewWorkflowExecution decision, then it contains the runId of the previous workflow execution that was closed and continued as this execution.

    " + }, + "parentWorkflowExecution":{ + "shape":"WorkflowExecution", + "documentation":"

    The source workflow execution that started this workflow execution. The member isn't set if the workflow execution was not started by a workflow.

    " + }, + "parentInitiatedEventId":{ + "shape":"EventId", + "documentation":"

    The ID of the StartChildWorkflowExecutionInitiated event corresponding to the StartChildWorkflowExecution Decision to start this workflow execution. The source event with this ID can be found in the history of the source workflow execution. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

    " + }, + "lambdaRole":{ + "shape":"Arn", + "documentation":"

    The IAM role attached to the workflow execution.

    " + } + }, + "documentation":"

    Provides details of WorkflowExecutionStarted event.

    " + }, + "WorkflowExecutionTerminatedCause":{ + "type":"string", + "enum":[ + "CHILD_POLICY_APPLIED", + "EVENT_LIMIT_EXCEEDED", + "OPERATOR_INITIATED" + ] + }, + "WorkflowExecutionTerminatedEventAttributes":{ + "type":"structure", + "required":["childPolicy"], + "members":{ + "reason":{ + "shape":"TerminateReason", + "documentation":"

    The reason provided for the termination.

    " + }, + "details":{ + "shape":"Data", + "documentation":"

    The details provided for the termination.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy used for the child workflow executions of this workflow execution.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "cause":{ + "shape":"WorkflowExecutionTerminatedCause", + "documentation":"

    If set, indicates that the workflow execution was automatically terminated, and specifies the cause. This happens if the parent workflow execution times out or is terminated and the child policy is set to terminate child executions.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionTerminated event.

    " + }, + "WorkflowExecutionTimedOutEventAttributes":{ + "type":"structure", + "required":[ + "timeoutType", + "childPolicy" + ], + "members":{ + "timeoutType":{ + "shape":"WorkflowExecutionTimeoutType", + "documentation":"

    The type of timeout that caused this event.

    " + }, + "childPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The policy used for the child workflow executions of this workflow execution.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + } + }, + "documentation":"

    Provides the details of the WorkflowExecutionTimedOut event.

    " + }, + "WorkflowExecutionTimeoutType":{ + "type":"string", + "enum":["START_TO_CLOSE"] + }, + "WorkflowId":{ + "type":"string", + "max":256, + "min":1 + }, + "WorkflowRunId":{ + "type":"string", + "max":64, + "min":1 + }, + "WorkflowRunIdOptional":{ + "type":"string", + "max":64 + }, + "WorkflowType":{ + "type":"structure", + "required":[ + "name", + "version" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    The name of the workflow type.

    The combination of workflow type name and version must be unique with in a domain.

    " + }, + "version":{ + "shape":"Version", + "documentation":"

    The version of the workflow type.

    The combination of workflow type name and version must be unique with in a domain.

    " + } + }, + "documentation":"

    Represents a workflow type.

    " + }, + "WorkflowTypeConfiguration":{ + "type":"structure", + "members":{ + "defaultTaskStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum duration, specified when registering the workflow type, that a decision task for executions of this workflow type might take before returning completion or failure. If the task doesn'tdo close in the specified time then the task is automatically timed out and rescheduled. If the decider eventually reports a completion or failure, it is ignored. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultExecutionStartToCloseTimeout":{ + "shape":"DurationInSecondsOptional", + "documentation":"

    The default maximum duration, specified when registering the workflow type, for executions of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

    " + }, + "defaultTaskList":{ + "shape":"TaskList", + "documentation":"

    The default task list, specified when registering the workflow type, for decisions tasks scheduled for workflow executions of this type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    " + }, + "defaultTaskPriority":{ + "shape":"TaskPriority", + "documentation":"

    The default task priority, specified when registering the workflow type, for all decision tasks of this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution decision.

    Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

    For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

    " + }, + "defaultChildPolicy":{ + "shape":"ChildPolicy", + "documentation":"

    The default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

    The supported child policies are:

    • TERMINATE – The child executions are terminated.

    • REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.

    • ABANDON – No action is taken. The child executions continue to run.

    " + }, + "defaultLambdaRole":{ + "shape":"Arn", + "documentation":"

    The default IAM role attached to this workflow type.

    Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when starting this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

    " + } + }, + "documentation":"

    The configuration settings of a workflow type.

    " + }, + "WorkflowTypeDetail":{ + "type":"structure", + "required":[ + "typeInfo", + "configuration" + ], + "members":{ + "typeInfo":{ + "shape":"WorkflowTypeInfo", + "documentation":"

    General information about the workflow type.

    The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

    • REGISTERED – The type is registered and available. Workers supporting this type should be running.

    • DEPRECATED – The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

    " + }, + "configuration":{ + "shape":"WorkflowTypeConfiguration", + "documentation":"

    Configuration settings of the workflow type registered through RegisterWorkflowType

    " + } + }, + "documentation":"

    Contains details about a workflow type.

    " + }, + "WorkflowTypeFilter":{ + "type":"structure", + "required":["name"], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

    Name of the workflow type.

    " + }, + "version":{ + "shape":"VersionOptional", + "documentation":"

    Version of the workflow type.

    " + } + }, + "documentation":"

    Used to filter workflow execution query results by type. Each parameter, if specified, defines a rule that must be satisfied by each returned result.

    " + }, + "WorkflowTypeInfo":{ + "type":"structure", + "required":[ + "workflowType", + "status", + "creationDate" + ], + "members":{ + "workflowType":{ + "shape":"WorkflowType", + "documentation":"

    The workflow type this information is about.

    " + }, + "status":{ + "shape":"RegistrationStatus", + "documentation":"

    The current status of the workflow type.

    " + }, + "description":{ + "shape":"Description", + "documentation":"

    The description of the type registered through RegisterWorkflowType.

    " + }, + "creationDate":{ + "shape":"Timestamp", + "documentation":"

    The date when this type was registered.

    " + }, + "deprecationDate":{ + "shape":"Timestamp", + "documentation":"

    If the type is in deprecated state, then it is set to the date when the type was deprecated.

    " + } + }, + "documentation":"

    Contains information about a workflow type.

    " + }, + "WorkflowTypeInfoList":{ + "type":"list", + "member":{"shape":"WorkflowTypeInfo"} + }, + "WorkflowTypeInfos":{ + "type":"structure", + "required":["typeInfos"], + "members":{ + "typeInfos":{ + "shape":"WorkflowTypeInfoList", + "documentation":"

    The list of workflow type information.

    " + }, + "nextPageToken":{ + "shape":"PageToken", + "documentation":"

    If a NextPageToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextPageToken. Keep all other arguments unchanged.

    The configured maximumPageSize determines how many results can be returned in a single call.

    " + } + }, + "documentation":"

    Contains a paginated list of information structures about workflow types.

    " + } + }, + "documentation":"Amazon Simple Workflow Service

    The Amazon Simple Workflow Service (Amazon SWF) makes it easy to build applications that use Amazon's cloud to coordinate work across distributed components. In Amazon SWF, a task represents a logical unit of work that is performed by a component of your workflow. Coordinating tasks in a workflow involves managing intertask dependencies, scheduling, and concurrency in accordance with the logical flow of the application.

    Amazon SWF gives you full control over implementing tasks and coordinating them without worrying about underlying complexities such as tracking their progress and maintaining their state.

    This documentation serves as reference only. For a broader overview of the Amazon SWF programming model, see the Amazon SWF Developer Guide .

    " +} diff --git a/aws/dist/botocore/data/textract/2018-06-27/paginators-1.json b/aws/dist/botocore/data/textract/2018-06-27/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/textract/2018-06-27/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/textract/2018-06-27/service-2.json b/aws/dist/botocore/data/textract/2018-06-27/service-2.json new file mode 100644 index 00000000..6e0a4081 --- /dev/null +++ b/aws/dist/botocore/data/textract/2018-06-27/service-2.json @@ -0,0 +1,812 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-06-27", + "endpointPrefix":"textract", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Textract", + "serviceId":"Textract", + "signatureVersion":"v4", + "targetPrefix":"Textract", + "uid":"textract-2018-06-27" + }, + "operations":{ + "AnalyzeDocument":{ + "name":"AnalyzeDocument", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AnalyzeDocumentRequest"}, + "output":{"shape":"AnalyzeDocumentResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"UnsupportedDocumentException"}, + {"shape":"DocumentTooLargeException"}, + {"shape":"BadDocumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Analyzes an input document for relationships between detected items.

    The types of information returned are as follows:

    • Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects.

    You can choose which type of analysis to perform by specifying the FeatureTypes list.

    The output is returned in a list of BLOCK objects.

    AnalyzeDocument is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    " + }, + "DetectDocumentText":{ + "name":"DetectDocumentText", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectDocumentTextRequest"}, + "output":{"shape":"DetectDocumentTextResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"UnsupportedDocumentException"}, + {"shape":"DocumentTooLargeException"}, + {"shape":"BadDocumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText returns the detected text in an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.

    For more information, see Document Text Detection.

    " + }, + "GetDocumentAnalysis":{ + "name":"GetDocumentAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDocumentAnalysisRequest"}, + "output":{"shape":"GetDocumentAnalysisResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidJobIdException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.

    You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    GetDocumentAnalysis returns an array of Block objects. The following types of information are returned:

    • Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.

    • Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.

    • Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.

    • Lines and words of text. A LINE Block object contains one or more WORD Block objects.

    Use the MaxResults parameter to limit the number of blocks returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentAnalysis.

    For more information, see Document Text Analysis.

    " + }, + "GetDocumentTextDetection":{ + "name":"GetDocumentTextDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetDocumentTextDetectionRequest"}, + "output":{"shape":"GetDocumentTextDetectionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InvalidJobIdException"}, + {"shape":"InternalServerError"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Gets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    You start asynchronous text detection by calling StartDocumentTextDetection, which returns a job identifier (JobId). When the text detection operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentTextDetection. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    GetDocumentTextDetection returns an array of Block objects.

    Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD.

    Use the MaxResults parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentTextDetection, and populate the NextToken request parameter with the token value that's returned from the previous call to GetDocumentTextDetection.

    For more information, see Document Text Detection.

    " + }, + "StartDocumentAnalysis":{ + "name":"StartDocumentAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDocumentAnalysisRequest"}, + "output":{"shape":"StartDocumentAnalysisResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"UnsupportedDocumentException"}, + {"shape":"DocumentTooLargeException"}, + {"shape":"BadDocumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.

    StartDocumentAnalysis can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartDocumentAnalysis returns a job identifier (JobId) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentAnalysis, and pass the job identifier (JobId) from the initial call to StartDocumentAnalysis.

    For more information, see Document Text Analysis.

    " + }, + "StartDocumentTextDetection":{ + "name":"StartDocumentTextDetection", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartDocumentTextDetectionRequest"}, + "output":{"shape":"StartDocumentTextDetectionResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"InvalidS3ObjectException"}, + {"shape":"UnsupportedDocumentException"}, + {"shape":"DocumentTooLargeException"}, + {"shape":"BadDocumentException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ProvisionedThroughputExceededException"}, + {"shape":"InternalServerError"}, + {"shape":"IdempotentParameterMismatchException"}, + {"shape":"ThrottlingException"}, + {"shape":"LimitExceededException"} + ], + "documentation":"

    Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.

    StartDocumentTextDetection can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.

    StartTextDetection returns a job identifier (JobId) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetDocumentTextDetection, and pass the job identifier (JobId) from the initial call to StartDocumentTextDetection.

    For more information, see Document Text Detection.

    " + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    You aren't authorized to perform the action.

    ", + "exception":true + }, + "AnalyzeDocumentRequest":{ + "type":"structure", + "required":[ + "Document", + "FeatureTypes" + ], + "members":{ + "Document":{ + "shape":"Document", + "documentation":"

    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format.

    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

    " + }, + "FeatureTypes":{ + "shape":"FeatureTypes", + "documentation":"

    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes.

    " + } + } + }, + "AnalyzeDocumentResponse":{ + "type":"structure", + "members":{ + "DocumentMetadata":{ + "shape":"DocumentMetadata", + "documentation":"

    Metadata about the analyzed document. An example is the number of pages.

    " + }, + "Blocks":{ + "shape":"BlockList", + "documentation":"

    The text that's detected and analyzed by AnalyzeDocument.

    " + } + } + }, + "BadDocumentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Textract isn't able to read the document.

    ", + "exception":true + }, + "Block":{ + "type":"structure", + "members":{ + "BlockType":{ + "shape":"BlockType", + "documentation":"

    The type of text that's recognized in a block. In text-detection operations, the following types are returned:

    • PAGE - Contains a list of the LINE Block objects that are detected on a document page.

    • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.

    • LINE - A string of tab-delimited, contiguous words that's detected on a document page.

    In text analysis operations, the following types are returned:

    • PAGE - Contains a list of child Block objects that are detected on a document page.

    • KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.

    • WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces that's detected on a document page.

    • LINE - A string of tab-delimited, contiguous words that's detected on a document page.

    • TABLE - A table that's detected on a document page. A table is any grid-based information with 2 or more rows or columns with a cell span of 1 row and 1 column each.

    • CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.

    • SELECTION_ELEMENT - A selectable element such as a radio button or checkbox that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.

    " + }, + "Confidence":{ + "shape":"Percent", + "documentation":"

    The confidence that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.

    " + }, + "Text":{ + "shape":"String", + "documentation":"

    The word or line of text that's recognized by Amazon Textract.

    " + }, + "RowIndex":{ + "shape":"UInteger", + "documentation":"

    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

    " + }, + "ColumnIndex":{ + "shape":"UInteger", + "documentation":"

    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.

    " + }, + "RowSpan":{ + "shape":"UInteger", + "documentation":"

    The number of rows that a table spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

    " + }, + "ColumnSpan":{ + "shape":"UInteger", + "documentation":"

    The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.

    " + }, + "Geometry":{ + "shape":"Geometry", + "documentation":"

    The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.

    " + }, + "Id":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier for the recognized text. The identifier is only unique for a single operation.

    " + }, + "Relationships":{ + "shape":"RelationshipList", + "documentation":"

    A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:

    • 0 - The block has no child blocks.

    • 1 - The block has child blocks.

    " + }, + "EntityTypes":{ + "shape":"EntityTypes", + "documentation":"

    The type of entity. The following can be returned:

    • KEY - An identifier for a field on the document.

    • VALUE - The field text.

    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.

    " + }, + "SelectionStatus":{ + "shape":"SelectionStatus", + "documentation":"

    The selection status of a selectable element such as a radio button or checkbox.

    " + }, + "Page":{ + "shape":"UInteger", + "documentation":"

    The page in which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multi-page documents that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple document pages, is always considered to be a single-page document and the value of Page is always 1. Synchronous operations don't return Page as every input document is considered to be a single-page document.

    " + } + }, + "documentation":"

    A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block depends on the type of operation. In document-text detection (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables and selection elements that are detected in the document.

    An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.

    For more information, see How Amazon Textract Works.

    " + }, + "BlockList":{ + "type":"list", + "member":{"shape":"Block"} + }, + "BlockType":{ + "type":"string", + "enum":[ + "KEY_VALUE_SET", + "PAGE", + "LINE", + "WORD", + "TABLE", + "CELL", + "SELECTION_ELEMENT" + ] + }, + "BoundingBox":{ + "type":"structure", + "members":{ + "Width":{ + "shape":"Float", + "documentation":"

    The width of the bounding box as a ratio of the overall document page width.

    " + }, + "Height":{ + "shape":"Float", + "documentation":"

    The height of the bounding box as a ratio of the overall document page height.

    " + }, + "Left":{ + "shape":"Float", + "documentation":"

    The left coordinate of the bounding box as a ratio of overall document page width.

    " + }, + "Top":{ + "shape":"Float", + "documentation":"

    The top coordinate of the bounding box as a ratio of overall document page height.

    " + } + }, + "documentation":"

    The bounding box around the recognized text, key, value, table or table cell on a document page. The left (x-coordinate) and top (y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).

    The top and left values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left value of 0.5 (350/700) and a top value of 0.25 (50/200).

    The width and height values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.

    " + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "DetectDocumentTextRequest":{ + "type":"structure", + "required":["Document"], + "members":{ + "Document":{ + "shape":"Document", + "documentation":"

    The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format.

    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

    " + } + } + }, + "DetectDocumentTextResponse":{ + "type":"structure", + "members":{ + "DocumentMetadata":{ + "shape":"DocumentMetadata", + "documentation":"

    Metadata about the document. Contains the number of pages that are detected in the document.

    " + }, + "Blocks":{ + "shape":"BlockList", + "documentation":"

    An array of Block objects containing the text detected in the document.

    " + } + } + }, + "Document":{ + "type":"structure", + "members":{ + "Bytes":{ + "shape":"ImageBlob", + "documentation":"

    A blob of base-64 encoded documents bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPG format.

    If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.

    " + }, + "S3Object":{ + "shape":"S3Object", + "documentation":"

    Identifies an S3 object as the document source. The maximum size of a document stored in an S3 bucket is 5 MB.

    " + } + }, + "documentation":"

    The input document, either as bytes or as an S3 object.

    You pass image bytes to an Amazon Textract API operation by using the Bytes property. For example, you would use the Bytes property to pass a document loaded from a local file system. Image bytes passed by using the Bytes property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.

    You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object property. Documents stored in an S3 bucket don't need to be base64 encoded.

    The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.

    If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.

    For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.

    " + }, + "DocumentLocation":{ + "type":"structure", + "members":{ + "S3Object":{ + "shape":"S3Object", + "documentation":"

    The Amazon S3 bucket that contains the input document.

    " + } + }, + "documentation":"

    The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.

    The input document can be an image file in JPG or PNG format. It can also be a file in PDF format.

    " + }, + "DocumentMetadata":{ + "type":"structure", + "members":{ + "Pages":{ + "shape":"UInteger", + "documentation":"

    The number of pages detected in the document.

    " + } + }, + "documentation":"

    Information about the input document.

    " + }, + "DocumentTooLargeException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The document can't be processed because it's too large. The maximum document size for synchronous operations 5 MB. The maximum document size for asynchronous operations is 500 MB for PDF format files.

    ", + "exception":true + }, + "EntityType":{ + "type":"string", + "enum":[ + "KEY", + "VALUE" + ] + }, + "EntityTypes":{ + "type":"list", + "member":{"shape":"EntityType"} + }, + "ErrorCode":{"type":"string"}, + "FeatureType":{ + "type":"string", + "enum":[ + "TABLES", + "FORMS" + ] + }, + "FeatureTypes":{ + "type":"list", + "member":{"shape":"FeatureType"} + }, + "Float":{"type":"float"}, + "Geometry":{ + "type":"structure", + "members":{ + "BoundingBox":{ + "shape":"BoundingBox", + "documentation":"

    An axis-aligned coarse representation of the location of the recognized text on the document page.

    " + }, + "Polygon":{ + "shape":"Polygon", + "documentation":"

    Within the bounding box, a fine-grained polygon around the recognized text.

    " + } + }, + "documentation":"

    Information about where a recognized text, key, value, table, or table cell is located on a document page.

    " + }, + "GetDocumentAnalysisRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    A unique identifier for the text-detection job. The JobId is returned from StartDocumentAnalysis.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return per paginated call. The largest value that you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

    " + } + } + }, + "GetDocumentAnalysisResponse":{ + "type":"structure", + "members":{ + "DocumentMetadata":{ + "shape":"DocumentMetadata", + "documentation":"

    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

    " + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

    The current status of the text detection job.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text detection results.

    " + }, + "Blocks":{ + "shape":"BlockList", + "documentation":"

    The results of the text analysis operation.

    " + }, + "Warnings":{ + "shape":"Warnings", + "documentation":"

    A list of warnings that occurred during the document analysis operation.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    The current status of an asynchronous document analysis operation.

    " + } + } + }, + "GetDocumentTextDetectionRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    A unique identifier for the text detection job. The JobId is returned from StartDocumentTextDetection.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return per paginated call. The largest value you can specify is 1,000. If you specify a value greater than 1,000, a maximum of 1,000 results is returned. The default value is 1,000.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.

    " + } + } + }, + "GetDocumentTextDetectionResponse":{ + "type":"structure", + "members":{ + "DocumentMetadata":{ + "shape":"DocumentMetadata", + "documentation":"

    Information about a document that Amazon Textract processed. DocumentMetadata is returned in every page of paginated responses from an Amazon Textract video operation.

    " + }, + "JobStatus":{ + "shape":"JobStatus", + "documentation":"

    The current status of the text detection job.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.

    " + }, + "Blocks":{ + "shape":"BlockList", + "documentation":"

    The results of the text-detection operation.

    " + }, + "Warnings":{ + "shape":"Warnings", + "documentation":"

    A list of warnings that occurred during the document text-detection operation.

    " + }, + "StatusMessage":{ + "shape":"StatusMessage", + "documentation":"

    The current status of an asynchronous document text-detection operation.

    " + } + } + }, + "IdList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "IdempotentParameterMismatchException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.

    ", + "exception":true + }, + "ImageBlob":{ + "type":"blob", + "max":5242880, + "min":1 + }, + "InternalServerError":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Textract experienced a service issue. Try your call again.

    ", + "exception":true, + "fault":true + }, + "InvalidJobIdException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An invalid job identifier was passed to GetDocumentAnalysis or to GetDocumentAnalysis.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An input parameter violated a constraint. For example, in synchronous operations, an InvalidParameterException exception occurs when neither of the S3Object or Bytes values are supplied in the Document request parameter. Validate your parameter before calling the API operation again.

    ", + "exception":true + }, + "InvalidS3ObjectException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Textract is unable to access the S3 object that's specified in the request.

    ", + "exception":true + }, + "JobId":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "JobStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "SUCCEEDED", + "FAILED", + "PARTIAL_SUCCESS" + ] + }, + "JobTag":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[a-zA-Z0-9_.\\-:]+" + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    An Amazon Textract service limit was exceeded. For example, if you start too many asynchronous jobs concurrently, calls to start operations (StartDocumentTextDetection, for example) raise a LimitExceededException exception (HTTP status code: 400) until the number of concurrently running jobs is below the Amazon Textract service limit.

    ", + "exception":true + }, + "MaxResults":{ + "type":"integer", + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "pattern":".*\\S.*" + }, + "NotificationChannel":{ + "type":"structure", + "required":[ + "SNSTopicArn", + "RoleArn" + ], + "members":{ + "SNSTopicArn":{ + "shape":"SNSTopicArn", + "documentation":"

    The Amazon SNS topic that Amazon Textract posts the completion status to.

    " + }, + "RoleArn":{ + "shape":"RoleArn", + "documentation":"

    The Amazon Resource Name (ARN) of an IAM role that gives Amazon Textract publishing permissions to the Amazon SNS topic.

    " + } + }, + "documentation":"

    The Amazon Simple Notification Service (Amazon SNS) topic to which Amazon Textract publishes the completion status of an asynchronous document operation, such as StartDocumentTextDetection.

    " + }, + "Pages":{ + "type":"list", + "member":{"shape":"UInteger"} + }, + "PaginationToken":{ + "type":"string", + "max":255, + "min":1, + "pattern":".*\\S.*" + }, + "Percent":{ + "type":"float", + "max":100, + "min":0 + }, + "Point":{ + "type":"structure", + "members":{ + "X":{ + "shape":"Float", + "documentation":"

    The value of the X coordinate for a point on a Polygon.

    " + }, + "Y":{ + "shape":"Float", + "documentation":"

    The value of the Y coordinate for a point on a Polygon.

    " + } + }, + "documentation":"

    The X and Y coordinates of a point on a document page. The X and Y values returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.

    An array of Point objects, Polygon, is returned by DetectDocumentText. Polygon represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.

    " + }, + "Polygon":{ + "type":"list", + "member":{"shape":"Point"} + }, + "ProvisionedThroughputExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.

    ", + "exception":true + }, + "Relationship":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"RelationshipType", + "documentation":"

    The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD.

    " + }, + "Ids":{ + "shape":"IdList", + "documentation":"

    An array of IDs for related blocks. You can get the type of the relationship from the Type element.

    " + } + }, + "documentation":"

    Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

    The Type element provides the type of the relationship for all blocks in the IDs array.

    " + }, + "RelationshipList":{ + "type":"list", + "member":{"shape":"Relationship"} + }, + "RelationshipType":{ + "type":"string", + "enum":[ + "VALUE", + "CHILD" + ] + }, + "RoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:([a-z\\d-]+):iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+" + }, + "S3Bucket":{ + "type":"string", + "max":255, + "min":3, + "pattern":"[0-9A-Za-z\\.\\-_]*" + }, + "S3Object":{ + "type":"structure", + "members":{ + "Bucket":{ + "shape":"S3Bucket", + "documentation":"

    The name of the S3 bucket.

    " + }, + "Name":{ + "shape":"S3ObjectName", + "documentation":"

    The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.

    " + }, + "Version":{ + "shape":"S3ObjectVersion", + "documentation":"

    If the bucket has versioning enabled, you can specify the object version.

    " + } + }, + "documentation":"

    The S3 bucket name and file name that identifies the document.

    The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.

    For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.

    " + }, + "S3ObjectName":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "S3ObjectVersion":{ + "type":"string", + "max":1024, + "min":1, + "pattern":".*\\S.*" + }, + "SNSTopicArn":{ + "type":"string", + "max":1024, + "min":20, + "pattern":"(^arn:([a-z\\d-]+):sns:[a-zA-Z\\d-]{1,20}:\\w{12}:.+$)" + }, + "SelectionStatus":{ + "type":"string", + "enum":[ + "SELECTED", + "NOT_SELECTED" + ] + }, + "StartDocumentAnalysisRequest":{ + "type":"structure", + "required":[ + "DocumentLocation", + "FeatureTypes" + ], + "members":{ + "DocumentLocation":{ + "shape":"DocumentLocation", + "documentation":"

    The location of the document to be processed.

    " + }, + "FeatureTypes":{ + "shape":"FeatureTypes", + "documentation":"

    A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes. All selectable elements (SELECTION_ELEMENT) that are detected are returned, whatever the value of FeatureTypes.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

    " + } + } + }, + "StartDocumentAnalysisResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the document text detection job. Use JobId to identify the job in a subsequent call to GetDocumentAnalysis.

    " + } + } + }, + "StartDocumentTextDetectionRequest":{ + "type":"structure", + "required":["DocumentLocation"], + "members":{ + "DocumentLocation":{ + "shape":"DocumentLocation", + "documentation":"

    The location of the document to be processed.

    " + }, + "ClientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

    The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidentally started more than once.

    " + }, + "JobTag":{ + "shape":"JobTag", + "documentation":"

    An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.

    " + }, + "NotificationChannel":{ + "shape":"NotificationChannel", + "documentation":"

    The Amazon SNS topic ARN that you want Amazon Textract to publish the completion status of the operation to.

    " + } + } + }, + "StartDocumentTextDetectionResponse":{ + "type":"structure", + "members":{ + "JobId":{ + "shape":"JobId", + "documentation":"

    The identifier for the document text-detection job. Use JobId to identify the job in a subsequent call to GetDocumentTextDetection.

    " + } + } + }, + "StatusMessage":{"type":"string"}, + "String":{"type":"string"}, + "ThrottlingException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    Amazon Textract is temporarily unable to process the request. Try your call again.

    ", + "exception":true, + "fault":true + }, + "UInteger":{ + "type":"integer", + "min":0 + }, + "UnsupportedDocumentException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The format of the input document isn't supported. Amazon Textract supports documents that are .png or .jpg format.

    ", + "exception":true + }, + "Warning":{ + "type":"structure", + "members":{ + "ErrorCode":{ + "shape":"ErrorCode", + "documentation":"

    The error code for the warning.

    " + }, + "Pages":{ + "shape":"Pages", + "documentation":"

    A list of the pages that the warning applies to.

    " + } + }, + "documentation":"

    A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document-text detection (StartDocumentTextDetection).

    " + }, + "Warnings":{ + "type":"list", + "member":{"shape":"Warning"} + } + }, + "documentation":"

    Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

    " +} diff --git a/aws/dist/botocore/data/transcribe/2017-10-26/paginators-1.json b/aws/dist/botocore/data/transcribe/2017-10-26/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/transcribe/2017-10-26/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/transcribe/2017-10-26/service-2.json b/aws/dist/botocore/data/transcribe/2017-10-26/service-2.json new file mode 100644 index 00000000..fbd5f99a --- /dev/null +++ b/aws/dist/botocore/data/transcribe/2017-10-26/service-2.json @@ -0,0 +1,771 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-26", + "endpointPrefix":"transcribe", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Transcribe Service", + "serviceId":"Transcribe", + "signatureVersion":"v4", + "signingName":"transcribe", + "targetPrefix":"Transcribe", + "uid":"transcribe-2017-10-26" + }, + "operations":{ + "CreateVocabulary":{ + "name":"CreateVocabulary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateVocabularyRequest"}, + "output":{"shape":"CreateVocabularyResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"} + ], + "documentation":"

    Creates a new custom vocabulary that you can use to change the way Amazon Transcribe handles transcription of an audio file.

    " + }, + "DeleteTranscriptionJob":{ + "name":"DeleteTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTranscriptionJobRequest"}, + "errors":[ + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

    Deletes a previously submitted transcription job along with any other generated results such as the transcription, models, and so on.

    " + }, + "DeleteVocabulary":{ + "name":"DeleteVocabulary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteVocabularyRequest"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"BadRequestException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

    Deletes a vocabulary from Amazon Transcribe.

    " + }, + "GetTranscriptionJob":{ + "name":"GetTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTranscriptionJobRequest"}, + "output":{"shape":"GetTranscriptionJobResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"} + ], + "documentation":"

    Returns information about a transcription job. To see the status of the job, check the TranscriptionJobStatus field. If the status is COMPLETED, the job is finished and you can find the results at the location specified in the TranscriptionFileUri field.

    " + }, + "GetVocabulary":{ + "name":"GetVocabulary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetVocabularyRequest"}, + "output":{"shape":"GetVocabularyResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"BadRequestException"} + ], + "documentation":"

    Gets information about a vocabulary.

    " + }, + "ListTranscriptionJobs":{ + "name":"ListTranscriptionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTranscriptionJobsRequest"}, + "output":{"shape":"ListTranscriptionJobsResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

    Lists transcription jobs with the specified status.

    " + }, + "ListVocabularies":{ + "name":"ListVocabularies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListVocabulariesRequest"}, + "output":{"shape":"ListVocabulariesResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

    Returns a list of vocabularies that match the specified criteria. If no criteria are specified, returns the entire list of vocabularies.

    " + }, + "StartTranscriptionJob":{ + "name":"StartTranscriptionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartTranscriptionJobRequest"}, + "output":{"shape":"StartTranscriptionJobResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"} + ], + "documentation":"

    Starts an asynchronous job to transcribe speech to text.

    " + }, + "UpdateVocabulary":{ + "name":"UpdateVocabulary", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateVocabularyRequest"}, + "output":{"shape":"UpdateVocabularyResponse"}, + "errors":[ + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"NotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

    Updates an existing vocabulary with new values. The UpdateVocabulary operation overwrites all of the existing information with the values that you provide in the request.

    " + } + }, + "shapes":{ + "BadRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"FailureReason"} + }, + "documentation":"

    Your request didn't pass one or more validation tests. For example, if the transcription you're trying to delete doesn't exist or if it is in a non-terminal state (for example, it's \"in progress\"). See the exception Message field for more information.

    ", + "exception":true + }, + "Boolean":{"type":"boolean"}, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    When you are using the StartTranscriptionJob operation, the JobName field is a duplicate of a previously entered job name. Resend your request with a different name.

    When you are using the UpdateVocabulary operation, there are two jobs running at the same time. Resend the second request later.

    ", + "exception":true + }, + "CreateVocabularyRequest":{ + "type":"structure", + "required":[ + "VocabularyName", + "LanguageCode" + ], + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary. The name must be unique within an AWS account. The name is case-sensitive.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "Phrases":{ + "shape":"Phrases", + "documentation":"

    An array of strings that contains the vocabulary entries.

    " + }, + "VocabularyFileUri":{ + "shape":"Uri", + "documentation":"

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

    https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

    For example:

    https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    For more information about custom vocabularies, see Custom Vocabularies.

    " + } + } + }, + "CreateVocabularyResponse":{ + "type":"structure", + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "VocabularyState":{ + "shape":"VocabularyState", + "documentation":"

    The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time that the vocabulary was created.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the VocabularyState field is FAILED, this field contains information about why the job failed.

    " + } + } + }, + "DateTime":{"type":"timestamp"}, + "DeleteTranscriptionJobRequest":{ + "type":"structure", + "required":["TranscriptionJobName"], + "members":{ + "TranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"

    The name of the transcription job to be deleted.

    " + } + } + }, + "DeleteVocabularyRequest":{ + "type":"structure", + "required":["VocabularyName"], + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary to delete.

    " + } + } + }, + "FailureReason":{"type":"string"}, + "GetTranscriptionJobRequest":{ + "type":"structure", + "required":["TranscriptionJobName"], + "members":{ + "TranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"

    The name of the job.

    " + } + } + }, + "GetTranscriptionJobResponse":{ + "type":"structure", + "members":{ + "TranscriptionJob":{ + "shape":"TranscriptionJob", + "documentation":"

    An object that contains the results of the transcription job.

    " + } + } + }, + "GetVocabularyRequest":{ + "type":"structure", + "required":["VocabularyName"], + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary to return information about. The name is case-sensitive.

    " + } + } + }, + "GetVocabularyResponse":{ + "type":"structure", + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary to return.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "VocabularyState":{ + "shape":"VocabularyState", + "documentation":"

    The processing state of the vocabulary.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time that the vocabulary was last modified.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the VocabularyState field is FAILED, this field contains information about why the job failed.

    " + }, + "DownloadUri":{ + "shape":"Uri", + "documentation":"

    The S3 location where the vocabulary is stored. Use this URI to get the contents of the vocabulary. The URI is available for a limited time.

    " + } + } + }, + "InternalFailureException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    There was an internal error. Check the error message and try your request again.

    ", + "exception":true, + "fault":true + }, + "KMSKeyId":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" + }, + "LanguageCode":{ + "type":"string", + "enum":[ + "en-US", + "es-US", + "en-AU", + "fr-CA", + "en-GB", + "de-DE", + "pt-BR", + "fr-FR", + "it-IT", + "ko-KR", + "es-ES", + "en-IN", + "hi-IN", + "ar-SA", + "ru-RU", + "zh-CN" + ] + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    Either you have sent too many requests or your input file is too long. Wait before you resend your request, or use a smaller file and resend the request.

    ", + "exception":true + }, + "ListTranscriptionJobsRequest":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"TranscriptionJobStatus", + "documentation":"

    When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

    " + }, + "JobNameContains":{ + "shape":"TranscriptionJobName", + "documentation":"

    When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

    " + } + } + }, + "ListTranscriptionJobsResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"TranscriptionJobStatus", + "documentation":"

    The requested status of the jobs returned.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.

    " + }, + "TranscriptionJobSummaries":{ + "shape":"TranscriptionJobSummaries", + "documentation":"

    A list of objects containing summary information for a transcription job.

    " + } + } + }, + "ListVocabulariesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of vocabularies to return in the response. If there are fewer results in the list, this response contains only the actual results.

    " + }, + "StateEquals":{ + "shape":"VocabularyState", + "documentation":"

    When specified, only returns vocabularies with the VocabularyState field equal to the specified state.

    " + }, + "NameContains":{ + "shape":"VocabularyName", + "documentation":"

    When specified, the vocabularies returned in the list are limited to vocabularies whose name contains the specified string. The search is case-insensitive, ListVocabularies will return both \"vocabularyname\" and \"VocabularyName\" in the response list.

    " + } + } + }, + "ListVocabulariesResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"TranscriptionJobStatus", + "documentation":"

    The requested vocabulary state.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListVocabularies operation to return in the next page of jobs.

    " + }, + "Vocabularies":{ + "shape":"Vocabularies", + "documentation":"

    A list of objects that describe the vocabularies that match the search criteria in the request.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "max":100, + "min":1 + }, + "MaxSpeakers":{ + "type":"integer", + "max":10, + "min":2 + }, + "Media":{ + "type":"structure", + "members":{ + "MediaFileUri":{ + "shape":"Uri", + "documentation":"

    The S3 location of the input media file. The URI must be in the same region as the API endpoint that you are calling. The general form is:

    https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

    For example:

    https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4

    https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    " + } + }, + "documentation":"

    Describes the input media file in a transcription request.

    " + }, + "MediaFormat":{ + "type":"string", + "enum":[ + "mp3", + "mp4", + "wav", + "flac" + ] + }, + "MediaSampleRateHertz":{ + "type":"integer", + "max":48000, + "min":8000 + }, + "NextToken":{ + "type":"string", + "max":8192, + "pattern":".+" + }, + "NotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    We can't find the requested resource. Check the name and try your request again.

    ", + "exception":true + }, + "OutputBucketName":{ + "type":"string", + "max":64, + "pattern":"[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + }, + "OutputLocationType":{ + "type":"string", + "enum":[ + "CUSTOMER_BUCKET", + "SERVICE_BUCKET" + ] + }, + "Phrase":{ + "type":"string", + "max":256, + "min":0, + "pattern":".+" + }, + "Phrases":{ + "type":"list", + "member":{"shape":"Phrase"} + }, + "Settings":{ + "type":"structure", + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of a vocabulary to use when processing the transcription job.

    " + }, + "ShowSpeakerLabels":{ + "shape":"Boolean", + "documentation":"

    Determines whether the transcription job uses speaker recognition to identify different speakers in the input audio. Speaker recognition labels individual speakers in the audio file. If you set the ShowSpeakerLabels field to true, you must also set the maximum number of speaker labels MaxSpeakerLabels field.

    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

    " + }, + "MaxSpeakerLabels":{ + "shape":"MaxSpeakers", + "documentation":"

    The maximum number of speakers to identify in the input audio. If there are more speakers in the audio than this number, multiple speakers will be identified as a single speaker. If you specify the MaxSpeakerLabels field, you must set the ShowSpeakerLabels field to true.

    " + }, + "ChannelIdentification":{ + "shape":"Boolean", + "documentation":"

    Instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

    Amazon Transcribe also produces a transcription of each item detected on an audio channel, including the start time and end time of the item and alternative transcriptions of the item including the confidence that Amazon Transcribe has in the transcription.

    You can't set both ShowSpeakerLabels and ChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

    " + } + }, + "documentation":"

    Provides optional settings for the StartTranscriptionJob operation.

    " + }, + "StartTranscriptionJobRequest":{ + "type":"structure", + "required":[ + "TranscriptionJobName", + "LanguageCode", + "Media" + ], + "members":{ + "TranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"

    The name of the job. Note that you can't use the strings \".\" or \"..\" by themselves as the job name. The name must also be unique within an AWS account.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code for the language used in the input media file.

    " + }, + "MediaSampleRateHertz":{ + "shape":"MediaSampleRateHertz", + "documentation":"

    The sample rate, in Hertz, of the audio track in the input media file.

    If you do not specify the media sample rate, Amazon Transcribe determines the sample rate. If you specify the sample rate, it must match the sample rate detected by Amazon Transcribe. In most cases, you should leave the MediaSampleRateHertz field blank and let Amazon Transcribe determine the sample rate.

    " + }, + "MediaFormat":{ + "shape":"MediaFormat", + "documentation":"

    The format of the input media file.

    " + }, + "Media":{ + "shape":"Media", + "documentation":"

    An object that describes the input media for a transcription job.

    " + }, + "OutputBucketName":{ + "shape":"OutputBucketName", + "documentation":"

    The location where the transcription is stored.

    If you set the OutputBucketName, Amazon Transcribe puts the transcription in the specified S3 bucket. When you call the GetTranscriptionJob operation, the operation returns this location in the TranscriptFileUri field. The S3 bucket must have permissions that allow Amazon Transcribe to put files in the bucket. For more information, see Permissions Required for IAM User Roles.

    Amazon Transcribe uses the default Amazon S3 key for server-side encryption of transcripts that are placed in your S3 bucket. You can't specify your own encryption key.

    If you don't set the OutputBucketName, Amazon Transcribe generates a pre-signed URL, a shareable URL that provides secure access to your transcription, and returns it in the TranscriptFileUri field. Use this URL to download the transcription.

    " + }, + "OutputEncryptionKMSKeyId":{"shape":"KMSKeyId"}, + "Settings":{ + "shape":"Settings", + "documentation":"

    A Settings object that provides optional settings for a transcription job.

    " + } + } + }, + "StartTranscriptionJobResponse":{ + "type":"structure", + "members":{ + "TranscriptionJob":{ + "shape":"TranscriptionJob", + "documentation":"

    An object containing details of the asynchronous transcription job.

    " + } + } + }, + "String":{"type":"string"}, + "Transcript":{ + "type":"structure", + "members":{ + "TranscriptFileUri":{ + "shape":"Uri", + "documentation":"

    The location where the transcription is stored.

    Use this URI to access the transcription. If you specified an S3 bucket in the OutputBucketName field when you created the job, this is the URI of that bucket. If you chose to store the transcription in Amazon Transcribe, this is a shareable URL that provides secure access to that location.

    " + } + }, + "documentation":"

    Identifies the location of a transcription.

    " + }, + "TranscriptionJob":{ + "type":"structure", + "members":{ + "TranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"

    The name of the transcription job.

    " + }, + "TranscriptionJobStatus":{ + "shape":"TranscriptionJobStatus", + "documentation":"

    The status of the transcription job.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code for the input speech.

    " + }, + "MediaSampleRateHertz":{ + "shape":"MediaSampleRateHertz", + "documentation":"

    The sample rate, in Hertz, of the audio track in the input media file.

    " + }, + "MediaFormat":{ + "shape":"MediaFormat", + "documentation":"

    The format of the input media file.

    " + }, + "Media":{ + "shape":"Media", + "documentation":"

    An object that describes the input media for the transcription job.

    " + }, + "Transcript":{ + "shape":"Transcript", + "documentation":"

    An object that describes the output of the transcription job.

    " + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

    A timestamp that shows when the job was created.

    " + }, + "CompletionTime":{ + "shape":"DateTime", + "documentation":"

    A timestamp that shows when the job was completed.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the TranscriptionJobStatus field is FAILED, this field contains information about why the job failed.

    The FailureReason field can contain one of the following values:

    • Unsupported media format - The media format specified in the MediaFormat field of the request isn't valid. See the description of the MediaFormat field for a list of valid values.

    • The media format provided does not match the detected media format - The media format of the audio file doesn't match the format specified in the MediaFormat field in the request. Check the media format of your media file and make sure that the two values match.

    • Invalid sample rate for audio file - The sample rate specified in the MediaSampleRateHertz of the request isn't valid. The sample rate must be between 8000 and 48000 Hertz.

    • The sample rate provided does not match the detected sample rate - The sample rate in the audio file doesn't match the sample rate specified in the MediaSampleRateHertz field in the request. Check the sample rate of your media file and make sure that the two values match.

    • Invalid file size: file size too large - The size of your audio file is larger than Amazon Transcribe can process. For more information, see Limits in the Amazon Transcribe Developer Guide.

    • Invalid number of channels: number of channels too large - Your audio contains more channels than Amazon Transcribe is configured to process. To request additional channels, see Amazon Transcribe Limits in the Amazon Web Services General Reference.

    " + }, + "Settings":{ + "shape":"Settings", + "documentation":"

    Optional settings for the transcription job. Use these settings to turn on speaker recognition, to set the maximum number of speakers that should be identified and to specify a custom vocabulary to use when processing the transcription job.

    " + } + }, + "documentation":"

    Describes an asynchronous transcription job that was created with the StartTranscriptionJob operation.

    " + }, + "TranscriptionJobName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "TranscriptionJobStatus":{ + "type":"string", + "enum":[ + "IN_PROGRESS", + "FAILED", + "COMPLETED" + ] + }, + "TranscriptionJobSummaries":{ + "type":"list", + "member":{"shape":"TranscriptionJobSummary"} + }, + "TranscriptionJobSummary":{ + "type":"structure", + "members":{ + "TranscriptionJobName":{ + "shape":"TranscriptionJobName", + "documentation":"

    The name of the transcription job.

    " + }, + "CreationTime":{ + "shape":"DateTime", + "documentation":"

    A timestamp that shows when the job was created.

    " + }, + "CompletionTime":{ + "shape":"DateTime", + "documentation":"

    A timestamp that shows when the job was completed.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code for the input speech.

    " + }, + "TranscriptionJobStatus":{ + "shape":"TranscriptionJobStatus", + "documentation":"

    The status of the transcription job. When the status is COMPLETED, use the GetTranscriptionJob operation to get the results of the transcription.

    " + }, + "FailureReason":{ + "shape":"FailureReason", + "documentation":"

    If the TranscriptionJobStatus field is FAILED, a description of the error.

    " + }, + "OutputLocationType":{ + "shape":"OutputLocationType", + "documentation":"

    Indicates the location of the output of the transcription job.

    If the value is CUSTOMER_BUCKET then the location is the S3 bucket specified in the outputBucketName field when the transcription job was started with the StartTranscriptionJob operation.

    If the value is SERVICE_BUCKET then the output is stored by Amazon Transcribe and can be retrieved using the URI in the GetTranscriptionJob response's TranscriptFileUri field.

    " + } + }, + "documentation":"

    Provides a summary of information about a transcription job.

    " + }, + "UpdateVocabularyRequest":{ + "type":"structure", + "required":[ + "VocabularyName", + "LanguageCode" + ], + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary to update. The name is case-sensitive.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "Phrases":{ + "shape":"Phrases", + "documentation":"

    An array of strings containing the vocabulary entries.

    " + }, + "VocabularyFileUri":{ + "shape":"Uri", + "documentation":"

    The S3 location of the text file that contains the definition of the custom vocabulary. The URI must be in the same region as the API endpoint that you are calling. The general form is

    https://s3-<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>

    For example:

    https://s3-us-east-1.amazonaws.com/examplebucket/vocab.txt

    For more information about S3 object names, see Object Keys in the Amazon S3 Developer Guide.

    For more information about custom vocabularies, see Custom Vocabularies.

    " + } + } + }, + "UpdateVocabularyResponse":{ + "type":"structure", + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary that was updated.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time that the vocabulary was updated.

    " + }, + "VocabularyState":{ + "shape":"VocabularyState", + "documentation":"

    The processing state of the vocabulary. When the VocabularyState field contains READY the vocabulary is ready to be used in a StartTranscriptionJob request.

    " + } + } + }, + "Uri":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"(s3://|http(s*)://).+" + }, + "Vocabularies":{ + "type":"list", + "member":{"shape":"VocabularyInfo"} + }, + "VocabularyInfo":{ + "type":"structure", + "members":{ + "VocabularyName":{ + "shape":"VocabularyName", + "documentation":"

    The name of the vocabulary.

    " + }, + "LanguageCode":{ + "shape":"LanguageCode", + "documentation":"

    The language code of the vocabulary entries.

    " + }, + "LastModifiedTime":{ + "shape":"DateTime", + "documentation":"

    The date and time that the vocabulary was last modified.

    " + }, + "VocabularyState":{ + "shape":"VocabularyState", + "documentation":"

    The processing state of the vocabulary. If the state is READY you can use the vocabulary in a StartTranscriptionJob request.

    " + } + }, + "documentation":"

    Provides information about a custom vocabulary.

    " + }, + "VocabularyName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "VocabularyState":{ + "type":"string", + "enum":[ + "PENDING", + "READY", + "FAILED" + ] + } + }, + "documentation":"

    Operations and objects for transcribing speech to text.

    " +} diff --git a/aws/dist/botocore/data/transfer/2018-11-05/paginators-1.json b/aws/dist/botocore/data/transfer/2018-11-05/paginators-1.json new file mode 100644 index 00000000..cef79508 --- /dev/null +++ b/aws/dist/botocore/data/transfer/2018-11-05/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListServers": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Servers" + } + } +} diff --git a/aws/dist/botocore/data/transfer/2018-11-05/service-2.json b/aws/dist/botocore/data/transfer/2018-11-05/service-2.json new file mode 100644 index 00000000..dfc84fcc --- /dev/null +++ b/aws/dist/botocore/data/transfer/2018-11-05/service-2.json @@ -0,0 +1,1354 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-11-05", + "endpointPrefix":"transfer", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"AWS Transfer", + "serviceFullName":"AWS Transfer for SFTP", + "serviceId":"Transfer", + "signatureVersion":"v4", + "signingName":"transfer", + "targetPrefix":"TransferService", + "uid":"transfer-2018-11-05" + }, + "operations":{ + "CreateServer":{ + "name":"CreateServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateServerRequest"}, + "output":{"shape":"CreateServerResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"} + ], + "documentation":"

    Instantiates an autoscaling virtual server based on Secure File Transfer Protocol (SFTP) in AWS. When you make updates to your server or when you work with users, use the service-generated ServerId property that is assigned to the newly created server.

    " + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Creates a user and associates them with an existing Secure File Transfer Protocol (SFTP) server. You can only create and associate users with SFTP servers that have the IdentityProviderType set to SERVICE_MANAGED. Using parameters for CreateUser, you can specify the user name, set the home directory, store the user's public key, and assign the user's AWS Identity and Access Management (IAM) role. You can also optionally add a scope-down policy, and assign metadata with tags that can be used to group and search for users.

    " + }, + "DeleteServer":{ + "name":"DeleteServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteServerRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

    No response returns from this operation.

    " + }, + "DeleteSshPublicKey":{ + "name":"DeleteSshPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSshPublicKeyRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Deletes a user's Secure Shell (SSH) public key.

    No response is returned from this operation.

    " + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Deletes the user belonging to the server you specify.

    No response returns from this operation.

    When you delete a user from a server, the user's information is lost.

    " + }, + "DescribeServer":{ + "name":"DescribeServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeServerRequest"}, + "output":{"shape":"DescribeServerResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Describes the server that you specify by passing the ServerId parameter.

    The response contains a description of the server's properties.

    " + }, + "DescribeUser":{ + "name":"DescribeUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserRequest"}, + "output":{"shape":"DescribeUserResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Describes the user assigned to a specific server, as identified by its ServerId property.

    The response from this call returns the properties of the user associated with the ServerId value that was specified.

    " + }, + "ImportSshPublicKey":{ + "name":"ImportSshPublicKey", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportSshPublicKeyRequest"}, + "output":{"shape":"ImportSshPublicKeyResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Adds a Secure Shell (SSH) public key to a user account identified by a UserName value assigned to a specific server, identified by ServerId.

    The response returns the UserName value, the ServerId value, and the name of the SshPublicKeyId.

    " + }, + "ListServers":{ + "name":"ListServers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListServersRequest"}, + "output":{"shape":"ListServersResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Lists the Secure File Transfer Protocol (SFTP) servers that are associated with your AWS account.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

    Lists all of the tags associated with the Amazon Resource Number (ARN) you specify. The resource can be a user, server, or role.

    " + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Lists the users for the server that you specify by passing the ServerId parameter.

    " + }, + "StartServer":{ + "name":"StartServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartServerRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Changes the state of a Secure File Transfer Protocol (SFTP) server from OFFLINE to ONLINE. It has no impact on an SFTP server that is already ONLINE. An ONLINE server can accept and process file transfer jobs.

    The state of STARTING indicates that the server is in an intermediate state, either not fully able to respond, or not fully online. The values of START_FAILED can indicate an error condition.

    No response is returned from this call.

    " + }, + "StopServer":{ + "name":"StopServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopServerRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Changes the state of an SFTP server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server such as server and user properties are not affected by stopping your server. Stopping a server will not reduce or impact your Secure File Transfer Protocol (SFTP) endpoint billing.

    The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

    No response is returned from this call.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

    There is no response returned from this call.

    " + }, + "TestIdentityProvider":{ + "name":"TestIdentityProvider", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TestIdentityProviderRequest"}, + "output":{"shape":"TestIdentityProviderResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    If the IdentityProviderType of the server is API_Gateway, tests whether your API Gateway is set up successfully. We highly recommend that you call this operation to test your authentication method as soon as you create your server. By doing so, you can troubleshoot issues with the API Gateway integration to ensure that your users can successfully use the service.

    " + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Resources are users, servers, roles, and other entities.

    No response is returned from this call.

    " + }, + "UpdateServer":{ + "name":"UpdateServer", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateServerRequest"}, + "output":{"shape":"UpdateServerResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Updates the server properties after that server has been created.

    The UpdateServer call returns the ServerId of the Secure File Transfer Protocol (SFTP) server you updated.

    " + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

    Assigns new properties to a user. Parameters you pass modify any or all of the following: the home directory, role, and policy for the UserName and ServerId you specify.

    The response returns the ServerId and the UserName for the updated user.

    " + } + }, + "shapes":{ + "Arn":{ + "type":"string", + "max":1600, + "min":20, + "pattern":"arn:.*" + }, + "CreateServerRequest":{ + "type":"structure", + "members":{ + "EndpointDetails":{ + "shape":"EndpointDetails", + "documentation":"

    The virtual private cloud (VPC) endpoint settings that you want to configure for your SFTP server. This parameter is required when you specify a value for the EndpointType parameter.

    " + }, + "EndpointType":{ + "shape":"EndpointType", + "documentation":"

    The type of VPC endpoint that you want your SFTP server to connect to. If you connect to a VPC endpoint, your SFTP server isn't accessible over the public internet.

    " + }, + "HostKey":{ + "shape":"HostKey", + "documentation":"

    The RSA private key as generated by the ssh-keygen -N \"\" -f my-new-server-key command.

    If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

    For more information, see \"https://alpha-docs-aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.

    " + }, + "IdentityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"

    This parameter is required when the IdentityProviderType is set to API_GATEWAY. Accepts an array containing all of the information required to call a customer-supplied authentication API, including the API Gateway URL. This property is not required when the IdentityProviderType is set to SERVICE_MANAGED.

    " + }, + "IdentityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"

    Specifies the mode of authentication for the SFTP server. The default value is SERVICE_MANAGED, which allows you to store and access SFTP user credentials within the AWS Transfer for SFTP service. Use the API_GATEWAY value to integrate with an identity provider of your choosing. The API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

    " + }, + "LoggingRole":{ + "shape":"Role", + "documentation":"

    A value that allows the service to write your SFTP users' activity to your Amazon CloudWatch logs for monitoring and auditing purposes.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Key-value pairs that can be used to group and search for servers.

    " + } + } + }, + "CreateServerResponse":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    The service-assigned ID of the SFTP server that is created.

    " + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "Role", + "ServerId", + "UserName" + ], + "members":{ + "HomeDirectory":{ + "shape":"HomeDirectory", + "documentation":"

    The landing directory (folder) for a user when they log in to the server using their SFTP client.

    An example is <your-Amazon-S3-bucket-name>/home/username.

    " + }, + "HomeDirectoryType":{ + "shape":"HomeDirectoryType", + "documentation":"

    The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

    " + }, + "HomeDirectoryMappings":{ + "shape":"HomeDirectoryMappings", + "documentation":"

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

    '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

    In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

    " + }, + "Policy":{ + "shape":"Policy", + "documentation":"

    A scope-down policy for your user so you can use the same IAM role across multiple users. This policy scopes down user access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.

    For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server instance. This is the specific SFTP server that you added your user to.

    " + }, + "SshPublicKeyBody":{ + "shape":"SshPublicKeyBody", + "documentation":"

    The public portion of the Secure Shell (SSH) key used to authenticate the user to the SFTP server.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A unique string that identifies a user and is associated with a server as specified by the ServerId. This user name must be a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    " + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    The ID of the SFTP server that the user is attached to.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A unique string that identifies a user account associated with an SFTP server.

    " + } + } + }, + "DateImported":{"type":"timestamp"}, + "DeleteServerRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A unique system-assigned identifier for an SFTP server instance.

    " + } + } + }, + "DeleteSshPublicKeyRequest":{ + "type":"structure", + "required":[ + "ServerId", + "SshPublicKeyId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server instance that has the user assigned to it.

    " + }, + "SshPublicKeyId":{ + "shape":"SshPublicKeyId", + "documentation":"

    A unique identifier used to reference your user's specific SSH key.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A unique string that identifies a user whose public key is being deleted.

    " + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server instance that has the user assigned to it.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A unique string that identifies a user that is being deleted from the server.

    " + } + } + }, + "DescribeServerRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server.

    " + } + } + }, + "DescribeServerResponse":{ + "type":"structure", + "required":["Server"], + "members":{ + "Server":{ + "shape":"DescribedServer", + "documentation":"

    An array containing the properties of the server with the ServerID you specified.

    " + } + } + }, + "DescribeUserRequest":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that has this user assigned.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the AWS Transfer for SFTP service and perform file transfer tasks.

    " + } + } + }, + "DescribeUserResponse":{ + "type":"structure", + "required":[ + "ServerId", + "User" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that has this user assigned.

    " + }, + "User":{ + "shape":"DescribedUser", + "documentation":"

    An array containing the properties of the user account for the ServerID value that you specified.

    " + } + } + }, + "DescribedServer":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    Specifies the unique Amazon Resource Name (ARN) for the server to be described.

    " + }, + "EndpointDetails":{ + "shape":"EndpointDetails", + "documentation":"

    The virtual private cloud (VPC) endpoint settings that you configured for your SFTP server.

    " + }, + "EndpointType":{ + "shape":"EndpointType", + "documentation":"

    The type of endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

    " + }, + "HostKeyFingerprint":{ + "shape":"HostKeyFingerprint", + "documentation":"

    This value contains the message-digest algorithm (MD5) hash of the server's host key. This value is equivalent to the output of the ssh-keygen -l -E md5 -f my-new-server-key command.

    " + }, + "IdentityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"

    Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the server is SERVICE_MANAGED>.

    " + }, + "IdentityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"

    This property defines the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access SFTP user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

    " + }, + "LoggingRole":{ + "shape":"Role", + "documentation":"

    This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    This property is a unique system-assigned identifier for the SFTP server that you instantiate.

    " + }, + "State":{ + "shape":"State", + "documentation":"

    The condition of the SFTP server for the server that was described. A value of ONLINE indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    This property contains the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.

    " + }, + "UserCount":{ + "shape":"UserCount", + "documentation":"

    The number of users that are assigned to the SFTP server you specified with the ServerId.

    " + } + }, + "documentation":"

    Describes the properties of the server that was specified. Information returned includes the following: the server Amazon Resource Name (ARN), the authentication configuration and type, the logging role, the server ID and state, and assigned tags or metadata.

    " + }, + "DescribedUser":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    This property contains the unique Amazon Resource Name (ARN) for the user that was requested to be described.

    " + }, + "HomeDirectory":{ + "shape":"HomeDirectory", + "documentation":"

    This property specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket for the described user. An example is /your s3 bucket name/home/username .

    " + }, + "HomeDirectoryMappings":{ + "shape":"HomeDirectoryMappings", + "documentation":"

    Logical directory mappings that you specified for what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target.

    In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

    In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

    " + }, + "HomeDirectoryType":{ + "shape":"HomeDirectoryType", + "documentation":"

    The type of landing directory (folder) you mapped for your users' to see when they log into the SFTP server. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

    " + }, + "Policy":{ + "shape":"Policy", + "documentation":"

    Specifies the name of the policy in use for the described user.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    This property specifies the IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the SFTP server to access your resources when servicing your SFTP user's transfer requests.

    " + }, + "SshPublicKeys":{ + "shape":"SshPublicKeys", + "documentation":"

    This property contains the public key portion of the Secure Shell (SSH) keys stored for the described user.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    This property contains the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    This property is the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your SFTP server.

    " + } + }, + "documentation":"

    Returns properties of the user that you want to describe.

    " + }, + "EndpointDetails":{ + "type":"structure", + "members":{ + "VpcEndpointId":{ + "shape":"VpcEndpointId", + "documentation":"

    The ID of the VPC endpoint.

    " + } + }, + "documentation":"

    The configuration settings for the virtual private cloud (VPC) endpoint for your SFTP server.

    " + }, + "EndpointType":{ + "type":"string", + "enum":[ + "PUBLIC", + "VPC_ENDPOINT" + ] + }, + "HomeDirectory":{ + "type":"string", + "max":1024, + "pattern":"^$|/.*" + }, + "HomeDirectoryMapEntry":{ + "type":"structure", + "required":[ + "Entry", + "Target" + ], + "members":{ + "Entry":{ + "shape":"MapEntry", + "documentation":"

    Represents an entry and a target for HomeDirectoryMappings.

    " + }, + "Target":{ + "shape":"MapTarget", + "documentation":"

    Represents the map target that is used in a HomeDirectorymapEntry.

    " + } + }, + "documentation":"

    Represents an object that contains entries and a targets for HomeDirectoryMappings.

    " + }, + "HomeDirectoryMappings":{ + "type":"list", + "member":{"shape":"HomeDirectoryMapEntry"}, + "max":50, + "min":1 + }, + "HomeDirectoryType":{ + "type":"string", + "enum":[ + "PATH", + "LOGICAL" + ] + }, + "HostKey":{ + "type":"string", + "max":4096, + "sensitive":true + }, + "HostKeyFingerprint":{"type":"string"}, + "IdentityProviderDetails":{ + "type":"structure", + "members":{ + "Url":{ + "shape":"Url", + "documentation":"

    The Url parameter provides contains the location of the service endpoint used to authenticate users.

    " + }, + "InvocationRole":{ + "shape":"Role", + "documentation":"

    The InvocationRole parameter provides the type of InvocationRole used to authenticate the user account.

    " + } + }, + "documentation":"

    Returns information related to the type of user authentication that is in use for a server's users. A server can have only one method of authentication.

    " + }, + "IdentityProviderType":{ + "type":"string", + "documentation":"

    Returns information related to the type of user authentication that is in use for a server's users. For SERVICE_MANAGED authentication, the Secure Shell (SSH) public keys are stored with a user on an SFTP server instance. For API_GATEWAY authentication, your custom authentication method is implemented by using an API call. A server can have only one method of authentication.

    ", + "enum":[ + "SERVICE_MANAGED", + "API_GATEWAY" + ] + }, + "ImportSshPublicKeyRequest":{ + "type":"structure", + "required":[ + "ServerId", + "SshPublicKeyBody", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server.

    " + }, + "SshPublicKeyBody":{ + "shape":"SshPublicKeyBody", + "documentation":"

    The public key portion of an SSH key pair.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the user account that is assigned to one or more servers.

    " + } + } + }, + "ImportSshPublicKeyResponse":{ + "type":"structure", + "required":[ + "ServerId", + "SshPublicKeyId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server.

    " + }, + "SshPublicKeyId":{ + "shape":"SshPublicKeyId", + "documentation":"

    This identifier is the name given to a public key by the system that was imported.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A user name assigned to the ServerID value that you specified.

    " + } + }, + "documentation":"

    This response identifies the user, the server they belong to, and the identifier of the SSH public key associated with that user. A user can have more than one key on each server that they are associated with.

    " + }, + "InternalServiceError":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

    ", + "exception":true, + "fault":true + }, + "InvalidNextTokenException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    The NextToken parameter that was passed is invalid.

    ", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "required":["Message"], + "members":{ + "Message":{"shape":"Message"} + }, + "documentation":"

    This exception is thrown when the client submits a malformed request.

    ", + "exception":true + }, + "ListServersRequest":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Specifies the number of servers to return as a response to the ListServers query.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When additional results are obtained from the ListServers command, a NextToken parameter is returned in the output. You can then pass the NextToken parameter in a subsequent command to continue listing additional servers.

    " + } + } + }, + "ListServersResponse":{ + "type":"structure", + "required":["Servers"], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When you can get additional results from the ListServers operation, a NextToken parameter is returned in the output. In a following command, you can pass in the NextToken parameter to continue listing additional servers.

    " + }, + "Servers":{ + "shape":"ListedServers", + "documentation":"

    An array of servers that were listed.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific AWS resource, such as a server, user, or role.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Specifies the number of tags to return as a response to the ListTagsForResource request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When you request additional results from the ListTagsForResource operation, a NextToken parameter is returned in the input. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

    " + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    This value is the ARN you specified to list the tags of.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When you can get additional results from the ListTagsForResource call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional tags.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.

    " + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    Specifies the number of users to return as a response to the ListUsers request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for a Secure File Transfer Protocol (SFTP) server that has users assigned to it.

    " + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "required":[ + "ServerId", + "Users" + ], + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    When you can get additional results from the ListUsers call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional users.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that the users are assigned to.

    " + }, + "Users":{ + "shape":"ListedUsers", + "documentation":"

    Returns the user accounts and their properties for the ServerId value that you specify.

    " + } + } + }, + "ListedServer":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    The unique Amazon Resource Name (ARN) for the server to be listed.

    " + }, + "IdentityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"

    The authentication method used to validate a user for the server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

    " + }, + "EndpointType":{ + "shape":"EndpointType", + "documentation":"

    The type of VPC endpoint that your SFTP server is connected to. If your SFTP server is connected to a VPC endpoint, your server isn't accessible over the public internet.

    " + }, + "LoggingRole":{ + "shape":"Role", + "documentation":"

    The AWS Identity and Access Management entity that allows the server to turn on Amazon CloudWatch logging.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    This value is the unique system assigned identifier for the SFTP servers that were listed.

    " + }, + "State":{ + "shape":"State", + "documentation":"

    This property describes the condition of the SFTP server for the server that was described. A value of ONLINE> indicates that the server can accept jobs and transfer files. A State value of OFFLINE means that the server cannot perform file transfer operations.

    The states of STARTING and STOPPING indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of START_FAILED or STOP_FAILED can indicate an error condition.

    " + }, + "UserCount":{ + "shape":"UserCount", + "documentation":"

    This property is a numeric value that indicates the number of users that are assigned to the SFTP server you specified with the ServerId.

    " + } + }, + "documentation":"

    Returns properties of the server that was specified.

    " + }, + "ListedServers":{ + "type":"list", + "member":{"shape":"ListedServer"} + }, + "ListedUser":{ + "type":"structure", + "required":["Arn"], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    This property is the unique Amazon Resource Name (ARN) for the user that you want to learn about.

    " + }, + "HomeDirectory":{ + "shape":"HomeDirectory", + "documentation":"

    This value specifies the location that files are written to or read from an Amazon S3 bucket for the user you specify by their ARN.

    " + }, + "HomeDirectoryType":{ + "shape":"HomeDirectoryType", + "documentation":"

    The type of landing directory (folder) you mapped for your users' home directory. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    The role in use by this user. A role is an AWS Identity and Access Management (IAM) entity that, in this case, allows the SFTP server to act on a user's behalf. It allows the server to inherit the trust relationship that enables that user to perform file operations to their Amazon S3 bucket.

    " + }, + "SshPublicKeyCount":{ + "shape":"SshPublicKeyCount", + "documentation":"

    This value is the number of SSH public keys stored for the user you specified.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the user whose ARN was specified. User names are used for authentication purposes.

    " + } + }, + "documentation":"

    Returns properties of the user that you specify.

    " + }, + "ListedUsers":{ + "type":"list", + "member":{"shape":"ListedUser"} + }, + "MapEntry":{ + "type":"string", + "max":1024, + "pattern":"^/.*" + }, + "MapTarget":{ + "type":"string", + "max":1024, + "pattern":"^/.*" + }, + "MaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, + "Message":{"type":"string"}, + "NextToken":{ + "type":"string", + "max":6144, + "min":1 + }, + "NullableRole":{ + "type":"string", + "max":2048, + "pattern":"^$|arn:.*role/.*" + }, + "Policy":{ + "type":"string", + "max":2048 + }, + "Resource":{"type":"string"}, + "ResourceExistsException":{ + "type":"structure", + "required":[ + "Message", + "Resource", + "ResourceType" + ], + "members":{ + "Message":{"shape":"Message"}, + "Resource":{"shape":"Resource"}, + "ResourceType":{"shape":"ResourceType"} + }, + "documentation":"

    The requested resource does not exist.

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "required":[ + "Message", + "Resource", + "ResourceType" + ], + "members":{ + "Message":{"shape":"Message"}, + "Resource":{"shape":"Resource"}, + "ResourceType":{"shape":"ResourceType"} + }, + "documentation":"

    This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

    ", + "exception":true + }, + "ResourceType":{"type":"string"}, + "Response":{"type":"string"}, + "RetryAfterSeconds":{"type":"string"}, + "Role":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"arn:.*role/.*" + }, + "ServerId":{ + "type":"string", + "max":19, + "min":19, + "pattern":"^s-([0-9a-f]{17})$" + }, + "ServiceErrorMessage":{"type":"string"}, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ServiceErrorMessage"} + }, + "documentation":"

    The request has failed because the AWS Transfer for SFTP service is not available.

    ", + "exception":true, + "fault":true, + "synthetic":true + }, + "SshPublicKey":{ + "type":"structure", + "required":[ + "DateImported", + "SshPublicKeyBody", + "SshPublicKeyId" + ], + "members":{ + "DateImported":{ + "shape":"DateImported", + "documentation":"

    The date that the public key was added to the user account.

    " + }, + "SshPublicKeyBody":{ + "shape":"SshPublicKeyBody", + "documentation":"

    The content of the SSH public key as specified by the PublicKeyId.

    " + }, + "SshPublicKeyId":{ + "shape":"SshPublicKeyId", + "documentation":"

    The SshPublicKeyId parameter contains the identifier of the public key.

    " + } + }, + "documentation":"

    Provides information about the public Secure Shell (SSH) key that is associated with a user account for a specific server (as identified by ServerId). The information returned includes the date the key was imported, the public key contents, and the public key ID. A user can store more than one SSH public key associated with their user name on a specific SFTP server.

    " + }, + "SshPublicKeyBody":{ + "type":"string", + "max":2048, + "pattern":"^ssh-rsa\\s+[A-Za-z0-9+/]+[=]{0,3}(\\s+.+)?\\s*$" + }, + "SshPublicKeyCount":{"type":"integer"}, + "SshPublicKeyId":{ + "type":"string", + "max":21, + "min":21, + "pattern":"^key-[0-9a-f]{17}$" + }, + "SshPublicKeys":{ + "type":"list", + "member":{"shape":"SshPublicKey"}, + "max":5 + }, + "StartServerRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that you start.

    " + } + } + }, + "State":{ + "type":"string", + "documentation":"

    Describes the condition of the SFTP server with respect to its ability to perform file operations. There are six possible states: OFFLINE, ONLINE, STARTING, STOPPING, START_FAILED, and STOP_FAILED.

    OFFLINE indicates that the SFTP server exists, but that it is not available for file operations. ONLINE indicates that the SFTP server is available to perform file operations. STARTING indicates that the SFTP server's was instantiated, but the server is not yet available to perform file operations. Under normal conditions, it can take a couple of minutes for an SFTP server to be completely operational. Both START_FAILED and STOP_FAILED are error conditions.

    ", + "enum":[ + "OFFLINE", + "ONLINE", + "STARTING", + "STOPPING", + "START_FAILED", + "STOP_FAILED" + ] + }, + "StatusCode":{"type":"integer"}, + "StopServerRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that you stopped.

    " + } + } + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The name assigned to the tag that you create.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    This property contains one or more values that you assigned to the key name you create.

    " + } + }, + "documentation":"

    Creates a key-value pair for a specific resource. Tags are metadata that you can use to search for and group a resource for various purposes. You can apply tags to servers, users, and roles. A tag key can take more than one value. For example, to group servers for accounting purposes, you might create a tag called Group and assign the values Research and Accounting to that group.

    " + }, + "TagKey":{ + "type":"string", + "max":128 + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "Tags" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    An Amazon Resource Name (ARN) for a specific AWS resource, such as a server, user, or role.

    " + }, + "Tags":{ + "shape":"Tags", + "documentation":"

    Key-value pairs assigned to ARNs that you can use to group and search for resources by type. You can attach this metadata to user accounts for any purpose.

    " + } + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":50, + "min":1 + }, + "TestIdentityProviderRequest":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    This request parameter is the name of the user account to be tested.

    " + }, + "UserPassword":{ + "shape":"UserPassword", + "documentation":"

    The password of the user account to be tested.

    " + } + } + }, + "TestIdentityProviderResponse":{ + "type":"structure", + "required":[ + "StatusCode", + "Url" + ], + "members":{ + "Response":{ + "shape":"Response", + "documentation":"

    The response that is returned from your API Gateway.

    " + }, + "StatusCode":{ + "shape":"StatusCode", + "documentation":"

    The HTTP status code that is the response from your API Gateway.

    " + }, + "Message":{ + "shape":"Message", + "documentation":"

    A message that indicates whether the test was successful or not.

    " + }, + "Url":{ + "shape":"Url", + "documentation":"

    The endpoint of the service used to authenticate a user.

    " + } + } + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "RetryAfterSeconds":{"shape":"RetryAfterSeconds"} + }, + "documentation":"

    The request was denied due to request throttling.

    HTTP Status Code: 400

    ", + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "Arn", + "TagKeys" + ], + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

    This is the value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role.

    " + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

    TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.

    " + } + } + }, + "UpdateServerRequest":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "EndpointDetails":{ + "shape":"EndpointDetails", + "documentation":"

    The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

    " + }, + "EndpointType":{ + "shape":"EndpointType", + "documentation":"

    The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

    " + }, + "HostKey":{ + "shape":"HostKey", + "documentation":"

    The RSA private key as generated by ssh-keygen -N \"\" -f my-new-server-key.

    If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

    For more information, see \"https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key\" in the AWS SFTP User Guide.

    " + }, + "IdentityProviderDetails":{ + "shape":"IdentityProviderDetails", + "documentation":"

    This response parameter is an array containing all of the information required to call a customer's authentication API method.

    " + }, + "LoggingRole":{ + "shape":"NullableRole", + "documentation":"

    A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

    " + } + } + }, + "UpdateServerResponse":{ + "type":"structure", + "required":["ServerId"], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server that the user account is assigned to.

    " + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "HomeDirectory":{ + "shape":"HomeDirectory", + "documentation":"

    A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client.

    An example is <your-Amazon-S3-bucket-name>/home/username.

    " + }, + "HomeDirectoryType":{ + "shape":"HomeDirectoryType", + "documentation":"

    The type of landing directory (folder) you want your users' home directory to be when they log into the SFTP serve. If you set it to PATH, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make S3 paths visible to your user.

    " + }, + "HomeDirectoryMappings":{ + "shape":"HomeDirectoryMappings", + "documentation":"

    Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the \"Entry\" and \"Target\" pair, where Entry shows how the path is made visible and Target is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in Target. The following is an example.

    '[ \"/bucket2/documentation\", { \"Entry\": \"your-personal-report.pdf\", \"Target\": \"/bucket3/customized-reports/${transfer:UserName}.pdf\" } ]'

    In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (\"chroot\"). To do this, you can set Entry to '/' and set Target to the HomeDirectory parameter value.

    " + }, + "Policy":{ + "shape":"Policy", + "documentation":"

    Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

    For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy argument.

    For an example of a scope-down policy, see \"https://docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down\">Creating a Scope-Down Policy.

    For more information, see \"https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html\" in the AWS Security Token Service API Reference.

    " + }, + "Role":{ + "shape":"Role", + "documentation":"

    The IAM role that controls your user's access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user's transfer requests.

    " + }, + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    A unique string that identifies a user and is associated with a server as specified by the ServerId. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can't start with a hyphen.

    " + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "required":[ + "ServerId", + "UserName" + ], + "members":{ + "ServerId":{ + "shape":"ServerId", + "documentation":"

    A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The unique identifier for a user that is assigned to the SFTP server instance that was specified in the request.

    " + } + }, + "documentation":"

    UpdateUserResponse returns the user name and server identifier for the request to update a user's properties.

    " + }, + "Url":{ + "type":"string", + "max":255 + }, + "UserCount":{"type":"integer"}, + "UserName":{ + "type":"string", + "max":32, + "min":3, + "pattern":"^[a-zA-Z0-9_][a-zA-Z0-9_-]{2,31}$" + }, + "UserPassword":{ + "type":"string", + "max":2048, + "sensitive":true + }, + "VpcEndpointId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^vpce-[0-9a-f]{17}$" + } + }, + "documentation":"

    AWS Transfer for SFTP is a fully managed service that enables the transfer of files directly into and out of Amazon S3 using the Secure File Transfer Protocol (SFTP)—also known as Secure Shell (SSH) File Transfer Protocol. AWS helps you seamlessly migrate your file transfer workflows to AWS Transfer for SFTP—by integrating with existing authentication systems, and providing DNS routing with Amazon Route 53—so nothing changes for your customers and partners, or their applications. With your data in S3, you can use it with AWS services for processing, analytics, machine learning, and archiving. Getting started with AWS Transfer for SFTP (AWS SFTP) is easy; there is no infrastructure to buy and set up.

    " +} diff --git a/aws/dist/botocore/data/translate/2017-07-01/paginators-1.json b/aws/dist/botocore/data/translate/2017-07-01/paginators-1.json new file mode 100644 index 00000000..6898cd44 --- /dev/null +++ b/aws/dist/botocore/data/translate/2017-07-01/paginators-1.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListTerminologies": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "TerminologyPropertiesList" + } + } +} diff --git a/aws/dist/botocore/data/translate/2017-07-01/service-2.json b/aws/dist/botocore/data/translate/2017-07-01/service-2.json new file mode 100644 index 00000000..22360d03 --- /dev/null +++ b/aws/dist/botocore/data/translate/2017-07-01/service-2.json @@ -0,0 +1,568 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-07-01", + "endpointPrefix":"translate", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon Translate", + "serviceId":"Translate", + "signatureVersion":"v4", + "signingName":"translate", + "targetPrefix":"AWSShineFrontendService_20170701", + "uid":"translate-2017-07-01" + }, + "operations":{ + "DeleteTerminology":{ + "name":"DeleteTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTerminologyRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    A synchronous action that deletes a custom terminology.

    " + }, + "GetTerminology":{ + "name":"GetTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetTerminologyRequest"}, + "output":{"shape":"GetTerminologyResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Retrieves a custom terminology.

    " + }, + "ImportTerminology":{ + "name":"ImportTerminology", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportTerminologyRequest"}, + "output":{"shape":"ImportTerminologyResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Creates or updates a custom terminology, depending on whether or not one already exists for the given terminology name. Importing a terminology with the same name as an existing one will merge the terminologies based on the chosen merge strategy. Currently, the only supported merge strategy is OVERWRITE, and so the imported terminology will overwrite an existing terminology of the same name.

    If you import a terminology that overwrites an existing one, the new terminology take up to 10 minutes to fully propagate and be available for use in a translation due to cache policies with the DataPlane service that performs the translations.

    " + }, + "ListTerminologies":{ + "name":"ListTerminologies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTerminologiesRequest"}, + "output":{"shape":"ListTerminologiesResponse"}, + "errors":[ + {"shape":"InvalidParameterValueException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

    Provides a list of custom terminologies associated with your account.

    " + }, + "TranslateText":{ + "name":"TranslateText", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TranslateTextRequest"}, + "output":{"shape":"TranslateTextResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"UnsupportedLanguagePairException"}, + {"shape":"DetectedLanguageLowConfidenceException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InternalServerException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Translates input text from the source language to the target language. It is not necessary to use English (en) as either the source or the target language but not all language combinations are supported by Amazon Translate. For more information, see Supported Language Pairs.

    • Arabic (ar)

    • Chinese (Simplified) (zh)

    • Chinese (Traditional) (zh-TW)

    • Czech (cs)

    • Danish (da)

    • Dutch (nl)

    • English (en)

    • Finnish (fi)

    • French (fr)

    • German (de)

    • Hebrew (he)

    • Indonesian (id)

    • Italian (it)

    • Japanese (ja)

    • Korean (ko)

    • Polish (pl)

    • Portuguese (pt)

    • Russian (ru)

    • Spanish (es)

    • Swedish (sv)

    • Turkish (tr)

    To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

    " + } + }, + "shapes":{ + "AppliedTerminology":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the custom terminology applied to the input text by Amazon Translate for the translated text response.

    " + }, + "Terms":{ + "shape":"TermList", + "documentation":"

    The specific terms of the custom terminology applied to the input text by Amazon Translate for the translated text response. A maximum of 250 terms will be returned, and the specific terms applied will be the first 250 terms in the source text.

    " + } + }, + "documentation":"

    The custom terminology applied to the input text by Amazon Translate for the translated text response. This is optional in the response and will only be present if you specified terminology input in the request. Currently, only one terminology can be applied per TranslateText request.

    " + }, + "AppliedTerminologyList":{ + "type":"list", + "member":{"shape":"AppliedTerminology"} + }, + "BoundedLengthString":{ + "type":"string", + "max":5000, + "min":1, + "pattern":"[\\P{M}\\p{M}]{1,5000}" + }, + "DeleteTerminologyRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the custom terminology being deleted.

    " + } + } + }, + "Description":{ + "type":"string", + "max":256, + "pattern":"[\\P{M}\\p{M}]{0,256}" + }, + "DetectedLanguageLowConfidenceException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "DetectedLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code of the auto-detected language from Amazon Comprehend.

    " + } + }, + "documentation":"

    The confidence that Amazon Comprehend accurately detected the source language is low. If a low confidence level is acceptable for your application, you can use the language in the exception to call Amazon Translate again. For more information, see the DetectDominantLanguage operation in the Amazon Comprehend Developer Guide.

    ", + "exception":true + }, + "EncryptionKey":{ + "type":"structure", + "required":[ + "Type", + "Id" + ], + "members":{ + "Type":{ + "shape":"EncryptionKeyType", + "documentation":"

    The type of encryption key used by Amazon Translate to encrypt custom terminologies.

    " + }, + "Id":{ + "shape":"EncryptionKeyID", + "documentation":"

    The Amazon Resource Name (ARN) of the encryption key being used to encrypt the custom terminology.

    " + } + }, + "documentation":"

    The encryption key used to encrypt the custom terminologies used by Amazon Translate.

    " + }, + "EncryptionKeyID":{ + "type":"string", + "max":400, + "min":1, + "pattern":"(arn:aws((-us-gov)|(-cn))?:kms:)?([a-z]{2}-[a-z]+-\\d:)?(\\d{12}:)?(((key/)?[a-zA-Z0-9-_]+)|(alias/[a-zA-Z0-9:/_-]+))" + }, + "EncryptionKeyType":{ + "type":"string", + "enum":["KMS"] + }, + "GetTerminologyRequest":{ + "type":"structure", + "required":[ + "Name", + "TerminologyDataFormat" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the custom terminology being retrieved.

    " + }, + "TerminologyDataFormat":{ + "shape":"TerminologyDataFormat", + "documentation":"

    The data format of the custom terminology being retrieved, either CSV or TMX.

    " + } + } + }, + "GetTerminologyResponse":{ + "type":"structure", + "members":{ + "TerminologyProperties":{ + "shape":"TerminologyProperties", + "documentation":"

    The properties of the custom terminology being retrieved.

    " + }, + "TerminologyDataLocation":{ + "shape":"TerminologyDataLocation", + "documentation":"

    The data location of the custom terminology being retrieved. The custom terminology file is returned in a presigned url that has a 30 minute expiration.

    " + } + } + }, + "ImportTerminologyRequest":{ + "type":"structure", + "required":[ + "Name", + "MergeStrategy", + "TerminologyData" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the custom terminology being imported.

    " + }, + "MergeStrategy":{ + "shape":"MergeStrategy", + "documentation":"

    The merge strategy of the custom terminology being imported. Currently, only the OVERWRITE merge strategy is supported. In this case, the imported terminology will overwrite an existing terminology of the same name.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The description of the custom terminology being imported.

    " + }, + "TerminologyData":{ + "shape":"TerminologyData", + "documentation":"

    The terminology data for the custom terminology being imported.

    " + }, + "EncryptionKey":{ + "shape":"EncryptionKey", + "documentation":"

    The encryption key for the custom terminology being imported.

    " + } + } + }, + "ImportTerminologyResponse":{ + "type":"structure", + "members":{ + "TerminologyProperties":{ + "shape":"TerminologyProperties", + "documentation":"

    The properties of the custom terminology being imported.

    " + } + } + }, + "Integer":{"type":"integer"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    An internal server error occurred. Retry your request.

    ", + "exception":true, + "fault":true + }, + "InvalidParameterValueException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The value of the parameter is invalid. Review the value of the parameter you are using to correct it, and then retry your operation.

    ", + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The request that you made is invalid. Check your request to determine why it's invalid and then retry the request.

    ", + "exception":true + }, + "LanguageCodeString":{ + "type":"string", + "max":5, + "min":2 + }, + "LanguageCodeStringList":{ + "type":"list", + "member":{"shape":"LanguageCodeString"} + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The specified limit has been exceeded. Review your request and retry it with a quantity below the stated limit.

    ", + "exception":true + }, + "ListTerminologiesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the result of the request to ListTerminologies was truncated, include the NextToken to fetch the next group of custom terminologies.

    " + }, + "MaxResults":{ + "shape":"MaxResultsInteger", + "documentation":"

    The maximum number of custom terminologies returned per list request.

    " + } + } + }, + "ListTerminologiesResponse":{ + "type":"structure", + "members":{ + "TerminologyPropertiesList":{ + "shape":"TerminologyPropertiesList", + "documentation":"

    The properties list of the custom terminologies returned on the list request.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    If the response to the ListTerminologies was truncated, the NextToken fetches the next group of custom terminologies.

    " + } + } + }, + "MaxResultsInteger":{ + "type":"integer", + "max":500, + "min":1 + }, + "MergeStrategy":{ + "type":"string", + "enum":["OVERWRITE"] + }, + "NextToken":{ + "type":"string", + "max":8192, + "pattern":"\\p{ASCII}{0,8192}" + }, + "ResourceName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^([A-Za-z0-9-]_?)+$" + }, + "ResourceNameList":{ + "type":"list", + "member":{"shape":"ResourceName"} + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The resource you are looking for has not been found. Review the resource you're looking for and see if a different resource will accomplish your needs before retrying the revised request. .

    ", + "exception":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The Amazon Translate service is temporarily unavailable. Please wait a bit and then retry your request.

    ", + "exception":true + }, + "String":{ + "type":"string", + "max":10000, + "pattern":"[\\P{M}\\p{M}]{0,10000}" + }, + "Term":{ + "type":"structure", + "members":{ + "SourceText":{ + "shape":"String", + "documentation":"

    The source text of the term being translated by the custom terminology.

    " + }, + "TargetText":{ + "shape":"String", + "documentation":"

    The target text of the term being translated by the custom terminology.

    " + } + }, + "documentation":"

    The term being translated by the custom terminology.

    " + }, + "TermList":{ + "type":"list", + "member":{"shape":"Term"} + }, + "TerminologyArn":{ + "type":"string", + "pattern":"^arn:aws((-us-gov)|(-cn))?:translate:[a-zA-Z0-9-]+:[0-9]{12}:terminology/.+?/.+?$" + }, + "TerminologyData":{ + "type":"structure", + "required":[ + "File", + "Format" + ], + "members":{ + "File":{ + "shape":"TerminologyFile", + "documentation":"

    The file containing the custom terminology data.

    " + }, + "Format":{ + "shape":"TerminologyDataFormat", + "documentation":"

    The data format of the custom terminology. Either CSV or TMX.

    " + } + }, + "documentation":"

    The data associated with the custom terminology.

    " + }, + "TerminologyDataFormat":{ + "type":"string", + "enum":[ + "CSV", + "TMX" + ] + }, + "TerminologyDataLocation":{ + "type":"structure", + "required":[ + "RepositoryType", + "Location" + ], + "members":{ + "RepositoryType":{ + "shape":"String", + "documentation":"

    The repository type for the custom terminology data.

    " + }, + "Location":{ + "shape":"String", + "documentation":"

    The location of the custom terminology data.

    " + } + }, + "documentation":"

    The location of the custom terminology data.

    " + }, + "TerminologyFile":{ + "type":"blob", + "max":10485760, + "sensitive":true + }, + "TerminologyProperties":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the custom terminology.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    The description of the custom terminology properties.

    " + }, + "Arn":{ + "shape":"TerminologyArn", + "documentation":"

    The Amazon Resource Name (ARN) of the custom terminology.

    " + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the source text of the translation request for which the custom terminology is being used.

    " + }, + "TargetLanguageCodes":{ + "shape":"LanguageCodeStringList", + "documentation":"

    The language codes for the target languages available with the custom terminology file. All possible target languages are returned in array.

    " + }, + "EncryptionKey":{ + "shape":"EncryptionKey", + "documentation":"

    The encryption key for the custom terminology.

    " + }, + "SizeBytes":{ + "shape":"Integer", + "documentation":"

    The size of the file used when importing a custom terminology.

    " + }, + "TermCount":{ + "shape":"Integer", + "documentation":"

    The number of terms included in the custom terminology.

    " + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"

    The time at which the custom terminology was created, based on the timestamp.

    " + }, + "LastUpdatedAt":{ + "shape":"Timestamp", + "documentation":"

    The time at which the custom terminology was last update, based on the timestamp.

    " + } + }, + "documentation":"

    The properties of the custom terminology.

    " + }, + "TerminologyPropertiesList":{ + "type":"list", + "member":{"shape":"TerminologyProperties"} + }, + "TextSizeLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The size of the text you submitted exceeds the size limit. Reduce the size of the text or use a smaller document and then retry your request.

    ", + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You have made too many requests within a short period of time. Wait for a short time and then try your request again.

    ", + "exception":true + }, + "TranslateTextRequest":{ + "type":"structure", + "required":[ + "Text", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members":{ + "Text":{ + "shape":"BoundedLengthString", + "documentation":"

    The text to translate. The text string can be a maximum of 5,000 bytes long. Depending on your character set, this may be fewer than 5,000 characters.

    " + }, + "TerminologyNames":{ + "shape":"ResourceNameList", + "documentation":"

    The TerminologyNames list that is taken as input to the TranslateText request. This has a minimum length of 0 and a maximum length of 1.

    " + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the language of the source text. The language must be a language supported by Amazon Translate.

    To have Amazon Translate determine the source language of your text, you can specify auto in the SourceLanguageCode field. If you specify auto, Amazon Translate will call Amazon Comprehend to determine the source language.

    " + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code requested for the language of the target text. The language must be a language supported by Amazon Translate.

    " + } + } + }, + "TranslateTextResponse":{ + "type":"structure", + "required":[ + "TranslatedText", + "SourceLanguageCode", + "TargetLanguageCode" + ], + "members":{ + "TranslatedText":{ + "shape":"String", + "documentation":"

    The the translated text. The maximum length of this text is 5kb.

    " + }, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the language of the source text.

    " + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the language of the target text.

    " + }, + "AppliedTerminologies":{ + "shape":"AppliedTerminologyList", + "documentation":"

    The names of the custom terminologies applied to the input text by Amazon Translate for the translated text response.

    " + } + } + }, + "UnsupportedLanguagePairException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "SourceLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the language of the input text.

    " + }, + "TargetLanguageCode":{ + "shape":"LanguageCodeString", + "documentation":"

    The language code for the language of the translated text.

    " + } + }, + "documentation":"

    Amazon Translate does not support translation from the language of the source text into the requested target language. For more information, see how-to-error-msg.

    ", + "exception":true + } + }, + "documentation":"

    Provides translation between one source language and another of the same set of languages.

    " +} diff --git a/aws/dist/botocore/data/waf-regional/2016-11-28/examples-1.json b/aws/dist/botocore/data/waf-regional/2016-11-28/examples-1.json new file mode 100644 index 00000000..eee5b6f4 --- /dev/null +++ b/aws/dist/botocore/data/waf-regional/2016-11-28/examples-1.json @@ -0,0 +1,1017 @@ +{ + "version": "1.0", + "examples": { + "CreateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an IP match set named MyIPSetFriendlyName.", + "id": "createipset-1472501003122", + "title": "To create an IP set" + } + ], + "CreateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "WAFRule-1-Example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a rule named WAFByteHeaderRule.", + "id": "createrule-1474072675555", + "title": "To create a rule" + } + ], + "CreateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleSizeConstraintSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates size constraint set named MySampleSizeConstraintSet.", + "id": "createsizeconstraint-1474299140754", + "title": "To create a size constraint" + } + ], + "CreateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySQLInjectionMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.", + "id": "createsqlinjectionmatchset-1474492796105", + "title": "To create a SQL injection match set" + } + ], + "CreateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "example-46da-4444-5555-example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a web ACL named CreateExample.", + "id": "createwebacl-1472061481310", + "title": "To create a web ACL" + } + ], + "CreateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleXssMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an XSS match set named MySampleXssMatchSet.", + "id": "createxssmatchset-1474560868500", + "title": "To create an XSS match set" + } + ], + "DeleteByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletebytematchset-1473367566229", + "title": "To delete a byte match set" + } + ], + "DeleteIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deleteipset-1472767434306", + "title": "To delete an IP set" + } + ], + "DeleteRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "WAFRule-1-Example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a rule with the ID WAFRule-1-Example.", + "id": "deleterule-1474073108749", + "title": "To delete a rule" + } + ], + "DeleteSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesizeconstraintset-1474299857905", + "title": "To delete a size constraint set" + } + ], + "DeleteSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesqlinjectionmatchset-1474493373197", + "title": "To delete a SQL injection match set" + } + ], + "DeleteWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACLId": "example-46da-4444-5555-example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.", + "id": "deletewebacl-1472767755931", + "title": "To delete a web ACL" + } + ], + "DeleteXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletexssmatchset-1474561302618", + "title": "To delete an XSS match set" + } + ], + "GetByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ByteMatchSet": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ByteMatchTuples": [ + { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + ], + "Name": "ByteMatchNameExample" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getbytematchset-1473273311532", + "title": "To get a byte match set" + } + ], + "GetChangeToken": [ + { + "input": { + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a change token to use for a create, update or delete operation.", + "id": "get-change-token-example-1471635120794", + "title": "To get a change token" + } + ], + "GetChangeTokenStatus": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeTokenStatus": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.", + "id": "getchangetokenstatus-1474658417107", + "title": "To get the change token status" + } + ], + "GetIPSet": [ + { + "input": { + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getipset-1474658688675", + "title": "To get an IP set" + } + ], + "GetRule": [ + { + "input": { + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getrule-1474659238790", + "title": "To get a rule" + } + ], + "GetSampledRequests": [ + { + "input": { + "MaxItems": 100, + "RuleId": "WAFRule-1-Example", + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T15:50Z" + }, + "WebAclId": "createwebacl-1472061481310" + }, + "output": { + "PopulationSize": 50, + "SampledRequests": [ + { + "Action": "BLOCK", + "Request": { + "ClientIP": "192.0.2.44", + "Country": "US", + "HTTPVersion": "HTTP/1.1", + "Headers": [ + { + "Name": "User-Agent", + "Value": "BadBot " + } + ], + "Method": "HEAD" + }, + "Timestamp": "2016-09-27T14:55Z", + "Weight": 1 + } + ], + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T14:50Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.", + "id": "getsampledrequests-1474927997195", + "title": "To get a sampled requests" + } + ], + "GetSizeConstraintSet": [ + { + "input": { + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsizeconstraintset-1475005422493", + "title": "To get a size constraint set" + } + ], + "GetSqlInjectionMatchSet": [ + { + "input": { + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsqlinjectionmatchset-1475005940137", + "title": "To get a SQL injection match set" + } + ], + "GetWebACL": [ + { + "input": { + "WebACLId": "createwebacl-1472061481310" + }, + "output": { + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "createwebacl-1472061481310" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.", + "id": "getwebacl-1475006348525", + "title": "To get a web ACL" + } + ], + "GetXssMatchSet": [ + { + "input": { + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getxssmatchset-1475187879017", + "title": "To get an XSS match set" + } + ], + "ListIPSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "IPSets": [ + { + "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 IP match sets.", + "id": "listipsets-1472235676229", + "title": "To list IP sets" + } + ], + "ListRules": [ + { + "input": { + "Limit": 100 + }, + "output": { + "Rules": [ + { + "Name": "WAFByteHeaderRule", + "RuleId": "WAFRule-1-Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 rules.", + "id": "listrules-1475258406433", + "title": "To list rules" + } + ], + "ListSizeConstraintSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SizeConstraintSets": [ + { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 size contraint match sets.", + "id": "listsizeconstraintsets-1474300067597", + "title": "To list a size constraint sets" + } + ], + "ListSqlInjectionMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SqlInjectionMatchSets": [ + { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 SQL injection match sets.", + "id": "listsqlinjectionmatchset-1474493560103", + "title": "To list SQL injection match sets" + } + ], + "ListWebACLs": [ + { + "input": { + "Limit": 100 + }, + "output": { + "WebACLs": [ + { + "Name": "WebACLexample", + "WebACLId": "webacl-1472061481310" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 web ACLs.", + "id": "listwebacls-1475258732691", + "title": "To list Web ACLs" + } + ], + "ListXssMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "XssMatchSets": [ + { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 XSS match sets.", + "id": "listxssmatchsets-1474561481168", + "title": "To list XSS match sets" + } + ], + "UpdateByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "ByteMatchTuple": { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatebytematchset-1475259074558", + "title": "To update a byte match set" + } + ], + "UpdateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "IPSetDescriptor": { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updateipset-1475259733625", + "title": "To update an IP set" + } + ], + "UpdateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "Predicate": { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updaterule-1475260064720", + "title": "To update a rule" + } + ], + "UpdateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SizeConstraint": { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesizeconstraintset-1475531697891", + "title": "To update a size constraint set" + } + ], + "UpdateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SqlInjectionMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesqlinjectionmatchset-1475532094686", + "title": "To update a SQL injection match set" + } + ], + "UpdateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "Updates": [ + { + "Action": "DELETE", + "ActivatedRule": { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + } + ], + "WebACLId": "webacl-1472061481310" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.", + "id": "updatewebacl-1475533627385", + "title": "To update a Web ACL" + } + ], + "UpdateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "XssMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ], + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatexssmatchset-1475534098881", + "title": "To update an XSS match set" + } + ] + } +} diff --git a/aws/dist/botocore/data/waf-regional/2016-11-28/paginators-1.json b/aws/dist/botocore/data/waf-regional/2016-11-28/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/waf-regional/2016-11-28/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/waf-regional/2016-11-28/service-2.json b/aws/dist/botocore/data/waf-regional/2016-11-28/service-2.json new file mode 100644 index 00000000..58ae7c2f --- /dev/null +++ b/aws/dist/botocore/data/waf-regional/2016-11-28/service-2.json @@ -0,0 +1,5356 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-11-28", + "endpointPrefix":"waf-regional", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"WAF Regional", + "serviceFullName":"AWS WAF Regional", + "serviceId":"WAF Regional", + "signatureVersion":"v4", + "targetPrefix":"AWSWAF_Regional_20161128", + "uid":"waf-regional-2016-11-28" + }, + "operations":{ + "AssociateWebACL":{ + "name":"AssociateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateWebACLRequest"}, + "output":{"shape":"AssociateWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFUnavailableEntityException"} + ], + "documentation":"

    Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.

    " + }, + "CreateByteMatchSet":{ + "name":"CreateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateByteMatchSetRequest"}, + "output":{"shape":"CreateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

    To create and configure a ByteMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

    2. Submit a CreateByteMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

    4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateGeoMatchSet":{ + "name":"CreateGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGeoMatchSetRequest"}, + "output":{"shape":"CreateGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

    To create and configure a GeoMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request.

    2. Submit a CreateGeoMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

    4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateIPSet":{ + "name":"CreateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIPSetRequest"}, + "output":{"shape":"CreateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

    To create and configure an IPSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

    2. Submit a CreateIPSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRateBasedRule":{ + "name":"CreateRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRateBasedRuleRequest"}, + "output":{"shape":"CreateRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

    If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    Further, you specify a RateLimit of 15,000.

    You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests.

    As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

    • A ByteMatchSet with FieldToMatch of URI

    • A PositionalConstraint of STARTS_WITH

    • A TargetString of login

    Further, you specify a RateLimit of 15,000.

    By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

    To create and configure a RateBasedRule, perform the following steps:

    1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

    3. Submit a CreateRateBasedRule request.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

    6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRegexMatchSet":{ + "name":"CreateRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegexMatchSetRequest"}, + "output":{"shape":"CreateRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.

    2. Submit a CreateRegexMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

    4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRegexPatternSet":{ + "name":"CreateRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegexPatternSetRequest"}, + "output":{"shape":"CreateRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexPatternSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

    2. Submit a CreateRegexPatternSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

    4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRule":{ + "name":"CreateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleRequest"}, + "output":{"shape":"CreateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

    To create and configure a Rule, perform the following steps:

    1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

    3. Submit a CreateRule request.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

    6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRuleGroup":{ + "name":"CreateRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleGroupRequest"}, + "output":{"shape":"CreateRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

    Rule groups are subject to the following limits:

    • Three rule groups per account. You can request an increase to this limit by contacting customer support.

    • One rule group per web ACL.

    • Ten rules per rule group.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateSizeConstraintSet":{ + "name":"CreateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSizeConstraintSetRequest"}, + "output":{"shape":"CreateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

    To create and configure a SizeConstraintSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

    2. Submit a CreateSizeConstraintSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

    4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateSqlInjectionMatchSet":{ + "name":"CreateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, + "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

    To create and configure a SqlInjectionMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

    2. Submit a CreateSqlInjectionMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

    4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateWebACL":{ + "name":"CreateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWebACLRequest"}, + "output":{"shape":"CreateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

    You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

    To create and configure a WebACL, perform the following steps:

    1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

    4. Submit a CreateWebACL request.

    5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

    6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

    For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

    " + }, + "CreateXssMatchSet":{ + "name":"CreateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateXssMatchSetRequest"}, + "output":{"shape":"CreateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

    To create and configure an XssMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

    2. Submit a CreateXssMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

    4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "DeleteByteMatchSet":{ + "name":"DeleteByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteByteMatchSetRequest"}, + "output":{"shape":"DeleteByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

    If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

    To permanently delete a ByteMatchSet, perform the following steps:

    1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

    3. Submit a DeleteByteMatchSet request.

    " + }, + "DeleteGeoMatchSet":{ + "name":"DeleteGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGeoMatchSetRequest"}, + "output":{"shape":"DeleteGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

    If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

    To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

    1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.

    3. Submit a DeleteGeoMatchSet request.

    " + }, + "DeleteIPSet":{ + "name":"DeleteIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIPSetRequest"}, + "output":{"shape":"DeleteIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

    If you just want to remove an IPSet from a Rule, use UpdateRule.

    To permanently delete an IPSet from AWS WAF, perform the following steps:

    1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

    3. Submit a DeleteIPSet request.

    " + }, + "DeleteLoggingConfiguration":{ + "name":"DeleteLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoggingConfigurationRequest"}, + "output":{"shape":"DeleteLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"} + ], + "documentation":"

    Permanently deletes the LoggingConfiguration from the specified web ACL.

    " + }, + "DeletePermissionPolicy":{ + "name":"DeletePermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePermissionPolicyRequest"}, + "output":{"shape":"DeletePermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Permanently deletes an IAM policy from the specified RuleGroup.

    The user making the request must be the owner of the RuleGroup.

    " + }, + "DeleteRateBasedRule":{ + "name":"DeleteRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRateBasedRuleRequest"}, + "output":{"shape":"DeleteRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

    If you just want to remove a rule from a WebACL, use UpdateWebACL.

    To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

    1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.

    3. Submit a DeleteRateBasedRule request.

    " + }, + "DeleteRegexMatchSet":{ + "name":"DeleteRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegexMatchSetRequest"}, + "output":{"shape":"DeleteRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters).

    If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

    To permanently delete a RegexMatchSet, perform the following steps:

    1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request.

    3. Submit a DeleteRegexMatchSet request.

    " + }, + "DeleteRegexPatternSet":{ + "name":"DeleteRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegexPatternSetRequest"}, + "output":{"shape":"DeleteRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.

    " + }, + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleRequest"}, + "output":{"shape":"DeleteRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

    If you just want to remove a Rule from a WebACL, use UpdateWebACL.

    To permanently delete a Rule from AWS WAF, perform the following steps:

    1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

    3. Submit a DeleteRule request.

    " + }, + "DeleteRuleGroup":{ + "name":"DeleteRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleGroupRequest"}, + "output":{"shape":"DeleteRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

    If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

    To permanently delete a RuleGroup from AWS WAF, perform the following steps:

    1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request.

    3. Submit a DeleteRuleGroup request.

    " + }, + "DeleteSizeConstraintSet":{ + "name":"DeleteSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSizeConstraintSetRequest"}, + "output":{"shape":"DeleteSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

    If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

    To permanently delete a SizeConstraintSet, perform the following steps:

    1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

    3. Submit a DeleteSizeConstraintSet request.

    " + }, + "DeleteSqlInjectionMatchSet":{ + "name":"DeleteSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, + "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

    If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

    To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

    1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

    3. Submit a DeleteSqlInjectionMatchSet request.

    " + }, + "DeleteWebACL":{ + "name":"DeleteWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebACLRequest"}, + "output":{"shape":"DeleteWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

    To delete a WebACL, perform the following steps:

    1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

    3. Submit a DeleteWebACL request.

    " + }, + "DeleteXssMatchSet":{ + "name":"DeleteXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteXssMatchSetRequest"}, + "output":{"shape":"DeleteXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

    If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

    To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

    1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

    3. Submit a DeleteXssMatchSet request.

    " + }, + "DisassociateWebACL":{ + "name":"DisassociateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateWebACLRequest"}, + "output":{"shape":"DisassociateWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.

    " + }, + "GetByteMatchSet":{ + "name":"GetByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetByteMatchSetRequest"}, + "output":{"shape":"GetByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the ByteMatchSet specified by ByteMatchSetId.

    " + }, + "GetChangeToken":{ + "name":"GetChangeToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenRequest"}, + "output":{"shape":"GetChangeTokenResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

    Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

    When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

    " + }, + "GetChangeTokenStatus":{ + "name":"GetChangeTokenStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenStatusRequest"}, + "output":{"shape":"GetChangeTokenStatusResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

    • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

    • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

    • INSYNC: Propagation is complete.

    " + }, + "GetGeoMatchSet":{ + "name":"GetGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGeoMatchSetRequest"}, + "output":{"shape":"GetGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the GeoMatchSet that is specified by GeoMatchSetId.

    " + }, + "GetIPSet":{ + "name":"GetIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIPSetRequest"}, + "output":{"shape":"GetIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the IPSet that is specified by IPSetId.

    " + }, + "GetLoggingConfiguration":{ + "name":"GetLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoggingConfigurationRequest"}, + "output":{"shape":"GetLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the LoggingConfiguration for the specified web ACL.

    " + }, + "GetPermissionPolicy":{ + "name":"GetPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPermissionPolicyRequest"}, + "output":{"shape":"GetPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the IAM policy attached to the RuleGroup.

    " + }, + "GetRateBasedRule":{ + "name":"GetRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRateBasedRuleRequest"}, + "output":{"shape":"GetRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.

    " + }, + "GetRateBasedRuleManagedKeys":{ + "name":"GetRateBasedRuleManagedKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRateBasedRuleManagedKeysRequest"}, + "output":{"shape":"GetRateBasedRuleManagedKeysResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

    " + }, + "GetRegexMatchSet":{ + "name":"GetRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegexMatchSetRequest"}, + "output":{"shape":"GetRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RegexMatchSet specified by RegexMatchSetId.

    " + }, + "GetRegexPatternSet":{ + "name":"GetRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegexPatternSetRequest"}, + "output":{"shape":"GetRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RegexPatternSet specified by RegexPatternSetId.

    " + }, + "GetRule":{ + "name":"GetRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleRequest"}, + "output":{"shape":"GetRuleResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the Rule that is specified by the RuleId that you included in the GetRule request.

    " + }, + "GetRuleGroup":{ + "name":"GetRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleGroupRequest"}, + "output":{"shape":"GetRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

    To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

    " + }, + "GetSampledRequests":{ + "name":"GetSampledRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSampledRequestsRequest"}, + "output":{"shape":"GetSampledRequestsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

    GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

    " + }, + "GetSizeConstraintSet":{ + "name":"GetSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSizeConstraintSetRequest"}, + "output":{"shape":"GetSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the SizeConstraintSet specified by SizeConstraintSetId.

    " + }, + "GetSqlInjectionMatchSet":{ + "name":"GetSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSqlInjectionMatchSetRequest"}, + "output":{"shape":"GetSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

    " + }, + "GetWebACL":{ + "name":"GetWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWebACLRequest"}, + "output":{"shape":"GetWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the WebACL that is specified by WebACLId.

    " + }, + "GetWebACLForResource":{ + "name":"GetWebACLForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWebACLForResourceRequest"}, + "output":{"shape":"GetWebACLForResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFUnavailableEntityException"} + ], + "documentation":"

    Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.

    " + }, + "GetXssMatchSet":{ + "name":"GetXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetXssMatchSetRequest"}, + "output":{"shape":"GetXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the XssMatchSet that is specified by XssMatchSetId.

    " + }, + "ListActivatedRulesInRuleGroup":{ + "name":"ListActivatedRulesInRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivatedRulesInRuleGroupRequest"}, + "output":{"shape":"ListActivatedRulesInRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of ActivatedRule objects.

    " + }, + "ListByteMatchSets":{ + "name":"ListByteMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListByteMatchSetsRequest"}, + "output":{"shape":"ListByteMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of ByteMatchSetSummary objects.

    " + }, + "ListGeoMatchSets":{ + "name":"ListGeoMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGeoMatchSetsRequest"}, + "output":{"shape":"ListGeoMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of GeoMatchSetSummary objects in the response.

    " + }, + "ListIPSets":{ + "name":"ListIPSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIPSetsRequest"}, + "output":{"shape":"ListIPSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of IPSetSummary objects in the response.

    " + }, + "ListLoggingConfigurations":{ + "name":"ListLoggingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLoggingConfigurationsRequest"}, + "output":{"shape":"ListLoggingConfigurationsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of LoggingConfiguration objects.

    " + }, + "ListRateBasedRules":{ + "name":"ListRateBasedRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRateBasedRulesRequest"}, + "output":{"shape":"ListRateBasedRulesResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RuleSummary objects.

    " + }, + "ListRegexMatchSets":{ + "name":"ListRegexMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegexMatchSetsRequest"}, + "output":{"shape":"ListRegexMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RegexMatchSetSummary objects.

    " + }, + "ListRegexPatternSets":{ + "name":"ListRegexPatternSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegexPatternSetsRequest"}, + "output":{"shape":"ListRegexPatternSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RegexPatternSetSummary objects.

    " + }, + "ListResourcesForWebACL":{ + "name":"ListResourcesForWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesForWebACLRequest"}, + "output":{"shape":"ListResourcesForWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of resources associated with the specified web ACL.

    " + }, + "ListRuleGroups":{ + "name":"ListRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRuleGroupsRequest"}, + "output":{"shape":"ListRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns an array of RuleGroup objects.

    " + }, + "ListRules":{ + "name":"ListRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesRequest"}, + "output":{"shape":"ListRulesResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RuleSummary objects.

    " + }, + "ListSizeConstraintSets":{ + "name":"ListSizeConstraintSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSizeConstraintSetsRequest"}, + "output":{"shape":"ListSizeConstraintSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of SizeConstraintSetSummary objects.

    " + }, + "ListSqlInjectionMatchSets":{ + "name":"ListSqlInjectionMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, + "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of SqlInjectionMatchSet objects.

    " + }, + "ListSubscribedRuleGroups":{ + "name":"ListSubscribedRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSubscribedRuleGroupsRequest"}, + "output":{"shape":"ListSubscribedRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns an array of RuleGroup objects that you are subscribed to.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "ListWebACLs":{ + "name":"ListWebACLs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWebACLsRequest"}, + "output":{"shape":"ListWebACLsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of WebACLSummary objects in the response.

    " + }, + "ListXssMatchSets":{ + "name":"ListXssMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListXssMatchSetsRequest"}, + "output":{"shape":"ListXssMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of XssMatchSet objects.

    " + }, + "PutLoggingConfiguration":{ + "name":"PutLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLoggingConfigurationRequest"}, + "output":{"shape":"PutLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFServiceLinkedRoleErrorException"} + ], + "documentation":"

    Associates a LoggingConfiguration with a specified web ACL.

    You can access information about all traffic that AWS WAF inspects using the following steps:

    1. Create an Amazon Kinesis Data Firehose.

      Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

      Do not create the data firehose using a Kinesis stream as your source.

    2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

    " + }, + "PutPermissionPolicy":{ + "name":"PutPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPermissionPolicyRequest"}, + "output":{"shape":"PutPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidPermissionPolicyException"} + ], + "documentation":"

    Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

    The PutPermissionPolicy is subject to the following restrictions:

    • You can attach only one policy with each PutPermissionPolicy request.

    • The policy must include an Effect, Action and Principal.

    • Effect must specify Allow.

    • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    • The policy cannot include a Resource parameter.

    • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    • The user making the request must be the owner of the RuleGroup.

    • Your policy must be composed using IAM Policy version 2012-10-17.

    For more information, see IAM Policies.

    An example of a valid policy parameter is shown in the Examples section below.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "UpdateByteMatchSet":{ + "name":"UpdateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateByteMatchSetRequest"}, + "output":{"shape":"UpdateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

    • Where to look, such as at the beginning or the end of a query string.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

    To create and configure a ByteMatchSet, perform the following steps:

    1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

    3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateGeoMatchSet":{ + "name":"UpdateGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGeoMatchSetRequest"}, + "output":{"shape":"UpdateGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

    • The Type. The only valid value for Type is Country.

    • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

    To create and configure an GeoMatchSet, perform the following steps:

    1. Submit a CreateGeoMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

    3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

    When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateIPSet":{ + "name":"UpdateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIPSetRequest"}, + "output":{"shape":"UpdateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

    • The IP address version, IPv4 or IPv6.

    • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

    AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    IPv6 addresses can be represented using any of the following formats:

    • 1111:0000:0000:0000:0000:0000:0000:0111/128

    • 1111:0:0:0:0:0:0:0111/128

    • 1111::0111/128

    • 1111::111/128

    You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

    To create and configure an IPSet, perform the following steps:

    1. Submit a CreateIPSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

    You can insert a maximum of 1000 addresses in a single request.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRateBasedRule":{ + "name":"UpdateRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRateBasedRuleRequest"}, + "output":{"shape":"UpdateRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

    Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

    If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    Further, you specify a RateLimit of 15,000.

    You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

    As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

    • A ByteMatchSet with FieldToMatch of URI

    • A PositionalConstraint of STARTS_WITH

    • A TargetString of login

    Further, you specify a RateLimit of 15,000.

    By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

    " + }, + "UpdateRegexMatchSet":{ + "name":"UpdateRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRegexMatchSetRequest"}, + "output":{"shape":"UpdateRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexMatchSet, perform the following steps:

    1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

    3. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRegexPatternSet":{ + "name":"UpdateRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRegexPatternSetRequest"}, + "output":{"shape":"UpdateRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidRegexPatternException"} + ], + "documentation":"

    Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

    • Whether to insert or delete the RegexPatternString.

    • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

    For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

    • BadBot

    • BadB0t

    • B@dBot

    • B@dB0t

    To create and configure a RegexPatternSet, perform the following steps:

    1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

    3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRule":{ + "name":"UpdateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleRequest"}, + "output":{"shape":"UpdateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

    • A ByteMatchSet that matches the value BadBot in the User-Agent header

    • An IPSet that matches the IP address 192.0.2.44

    You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

    To create and configure a Rule, perform the following steps:

    1. Create and update the predicates that you want to include in the Rule.

    2. Create the Rule. See CreateRule.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    4. Submit an UpdateRule request to add predicates to the Rule.

    5. Create and update a WebACL that contains the Rule. See CreateWebACL.

    If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRuleGroup":{ + "name":"UpdateRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleGroupRequest"}, + "output":{"shape":"UpdateRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Inserts or deletes ActivatedRule objects in a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    You can have a maximum of ten rules per rule group.

    To create and configure a RuleGroup, perform the following steps:

    1. Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.

    3. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

    4. Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

    If you want to replace one Rule with another, you delete the existing one and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateSizeConstraintSet":{ + "name":"UpdateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSizeConstraintSetRequest"}, + "output":{"shape":"UpdateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

    • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

      You can only specify a single type of TextTransformation.

    • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

    • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

    For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

    To create and configure a SizeConstraintSet, perform the following steps:

    1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

    3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateSqlInjectionMatchSet":{ + "name":"UpdateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, + "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

    • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

    • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

    • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

      You can only specify a single type of TextTransformation.

    You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

    To create and configure a SqlInjectionMatchSet, perform the following steps:

    1. Submit a CreateSqlInjectionMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateWebACL":{ + "name":"UpdateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWebACLRequest"}, + "output":{"shape":"UpdateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFSubscriptionNotFoundException"} + ], + "documentation":"

    Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

    • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

    • The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

    • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

    • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

    To create and configure a WebACL, perform the following steps:

    1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

    3. Create a WebACL. See CreateWebACL.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

    5. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

      The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group.

      If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules.

    Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateXssMatchSet":{ + "name":"UpdateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateXssMatchSetRequest"}, + "output":{"shape":"UpdateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

    • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

    • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

    • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

      You can only specify a single type of TextTransformation.

    You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

    To create and configure an XssMatchSet, perform the following steps:

    1. Submit a CreateXssMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + } + }, + "shapes":{ + "Action":{"type":"string"}, + "ActivatedRule":{ + "type":"structure", + "required":[ + "Priority", + "RuleId" + ], + "members":{ + "Priority":{ + "shape":"RulePriority", + "documentation":"

    Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

    " + }, + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Action":{ + "shape":"WafAction", + "documentation":"

    Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

    • ALLOW: CloudFront responds with the requested object.

    • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

    • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "OverrideAction":{ + "shape":"WafOverrideAction", + "documentation":"

    Use the OverrideAction to test your RuleGroup.

    Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "Type":{ + "shape":"WafRuleType", + "documentation":"

    The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

    " + }, + "ExcludedRules":{ + "shape":"ExcludedRules", + "documentation":"

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

    Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

    2. Submit an UpdateWebACL request that has two actions:

      • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

      • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

    " + } + }, + "documentation":"

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

    " + }, + "ActivatedRules":{ + "type":"list", + "member":{"shape":"ActivatedRule"} + }, + "AssociateWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ResourceArn" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier (ID) for the web ACL.

    " + }, + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the resource to be protected, either an application load balancer or Amazon API Gateway stage.

    The ARN should be in one of the following formats:

    • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

    • For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

    " + } + } + }, + "AssociateWebACLResponse":{ + "type":"structure", + "members":{ + } + }, + "ByteMatchSet":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ByteMatchTuples" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + }, + "ByteMatchTuples":{ + "shape":"ByteMatchTuples", + "documentation":"

    Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    " + } + }, + "documentation":"

    In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

    A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

    " + }, + "ByteMatchSetSummaries":{ + "type":"list", + "member":{"shape":"ByteMatchSetSummary"} + }, + "ByteMatchSetSummary":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "Name" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + } + }, + "documentation":"

    Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

    " + }, + "ByteMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "ByteMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a ByteMatchTuple.

    " + }, + "ByteMatchTuple":{ + "shape":"ByteMatchTuple", + "documentation":"

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    " + } + }, + "documentation":"

    In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

    " + }, + "ByteMatchSetUpdates":{ + "type":"list", + "member":{"shape":"ByteMatchSetUpdate"}, + "min":1 + }, + "ByteMatchTargetString":{"type":"blob"}, + "ByteMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TargetString", + "TextTransformation", + "PositionalConstraint" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

    " + }, + "TargetString":{ + "shape":"ByteMatchTargetString", + "documentation":"

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

    Valid values depend on the values that you specified for FieldToMatch:

    • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

    • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

    • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    If you're using the AWS WAF API

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString.

    If you're using the AWS CLI or one of the AWS SDKs

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + }, + "PositionalConstraint":{ + "shape":"PositionalConstraint", + "documentation":"

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    CONTAINS

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    CONTAINS_WORD

    The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

    • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

    • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.

    • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.

    • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

    EXACTLY

    The value of the specified part of the web request must exactly match the value of TargetString.

    STARTS_WITH

    The value of TargetString must appear at the beginning of the specified part of the web request.

    ENDS_WITH

    The value of TargetString must appear at the end of the specified part of the web request.

    " + } + }, + "documentation":"

    The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    " + }, + "ByteMatchTuples":{ + "type":"list", + "member":{"shape":"ByteMatchTuple"} + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "INSERT", + "DELETE" + ] + }, + "ChangeToken":{ + "type":"string", + "min":1 + }, + "ChangeTokenStatus":{ + "type":"string", + "enum":[ + "PROVISIONED", + "PENDING", + "INSYNC" + ] + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ] + }, + "Country":{"type":"string"}, + "CreateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{ + "shape":"ByteMatchSet", + "documentation":"

    A ByteMatchSet that contains no ByteMatchTuple objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "GeoMatchSet":{ + "shape":"GeoMatchSet", + "documentation":"

    The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{ + "shape":"IPSet", + "documentation":"

    The IPSet returned in the CreateIPSet response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "RateKey", + "RateLimit", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule.

    " + }, + "RateKey":{ + "shape":"RateKey", + "documentation":"

    The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"RateBasedRule", + "documentation":"

    The RateBasedRule that is returned in the CreateRateBasedRule response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "RegexMatchSet":{ + "shape":"RegexMatchSet", + "documentation":"

    A RegexMatchSet that contains no RegexMatchTuple objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "RegexPatternSet":{ + "shape":"RegexPatternSet", + "documentation":"

    A RegexPatternSet that contains no objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRuleGroupRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRuleGroupResponse":{ + "type":"structure", + "members":{ + "RuleGroup":{ + "shape":"RuleGroup", + "documentation":"

    An empty RuleGroup.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the Rule.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"Rule", + "documentation":"

    The Rule returned in the CreateRule response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{ + "shape":"SizeConstraintSet", + "documentation":"

    A SizeConstraintSet that contains no SizeConstraint objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to create a SqlInjectionMatchSet.

    " + }, + "CreateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{ + "shape":"SqlInjectionMatchSet", + "documentation":"

    A SqlInjectionMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a CreateSqlInjectionMatchSet request.

    " + }, + "CreateWebACLRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "DefaultAction", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{ + "shape":"WebACL", + "documentation":"

    The WebACL returned in the CreateWebACL response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to create an XssMatchSet.

    " + }, + "CreateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{ + "shape":"XssMatchSet", + "documentation":"

    An XssMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a CreateXssMatchSet request.

    " + }, + "DeleteByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "ChangeToken" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteLoggingConfigurationRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

    " + } + } + }, + "DeleteLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeletePermissionPolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.

    The user making the request must be the owner of the RuleGroup.

    " + } + } + }, + "DeletePermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "ChangeToken" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "ChangeToken" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRuleGroupRequest":{ + "type":"structure", + "required":[ + "RuleGroupId", + "ChangeToken" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRuleGroupResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to delete a SqlInjectionMatchSet from AWS WAF.

    " + }, + "DeleteSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

    " + }, + "DeleteWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to delete an XssMatchSet from AWS WAF.

    " + }, + "DeleteXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a request to delete an XssMatchSet from AWS WAF.

    " + }, + "DisassociateWebACLRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed, either an application load balancer or Amazon API Gateway stage.

    The ARN should be in one of the following formats:

    • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

    • For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

    " + } + } + }, + "DisassociateWebACLResponse":{ + "type":"structure", + "members":{ + } + }, + "ExcludedRule":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The unique identifier for the rule to exclude from the rule group.

    " + } + }, + "documentation":"

    The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is specified by the ActivatedRule.

    " + }, + "ExcludedRules":{ + "type":"list", + "member":{"shape":"ExcludedRule"} + }, + "FieldToMatch":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"MatchFieldType", + "documentation":"

    The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

    • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

    • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

    • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

    " + }, + "Data":{ + "shape":"MatchFieldData", + "documentation":"

    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

    When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

    If the value of Type is any other value, omit Data.

    " + } + }, + "documentation":"

    Specifies where in a web request to look for TargetString.

    " + }, + "GeoMatchConstraint":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"GeoMatchConstraintType", + "documentation":"

    The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

    " + }, + "Value":{ + "shape":"GeoMatchConstraintValue", + "documentation":"

    The country that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    The country from which web requests originate that you want AWS WAF to search for.

    " + }, + "GeoMatchConstraintType":{ + "type":"string", + "enum":["Country"] + }, + "GeoMatchConstraintValue":{ + "type":"string", + "enum":[ + "AF", + "AX", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AQ", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BQ", + "BA", + "BW", + "BV", + "BR", + "IO", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CA", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CX", + "CC", + "CO", + "KM", + "CG", + "CD", + "CK", + "CR", + "CI", + "HR", + "CU", + "CW", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "GF", + "PF", + "TF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HM", + "VA", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IM", + "IL", + "IT", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KP", + "KR", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "MX", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NF", + "MP", + "NO", + "OM", + "PK", + "PW", + "PS", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "PR", + "QA", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SG", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "GS", + "SS", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TL", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "GB", + "US", + "UM", + "UY", + "UZ", + "VU", + "VE", + "VN", + "VG", + "VI", + "WF", + "EH", + "YE", + "ZM", + "ZW" + ] + }, + "GeoMatchConstraints":{ + "type":"list", + "member":{"shape":"GeoMatchConstraint"} + }, + "GeoMatchSet":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "GeoMatchConstraints" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet).

    GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    " + }, + "GeoMatchConstraints":{ + "shape":"GeoMatchConstraints", + "documentation":"

    An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    Contains one or more countries that AWS WAF will search for.

    " + }, + "GeoMatchSetSummaries":{ + "type":"list", + "member":{"shape":"GeoMatchSetSummary"} + }, + "GeoMatchSetSummary":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "Name" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name of the GeoMatchSet.

    " + }, + "GeoMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "GeoMatchConstraint" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    " + }, + "GeoMatchConstraint":{ + "shape":"GeoMatchConstraint", + "documentation":"

    The country from which web requests originate that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

    " + }, + "GeoMatchSetUpdates":{ + "type":"list", + "member":{"shape":"GeoMatchSetUpdate"}, + "min":1 + }, + "GetByteMatchSetRequest":{ + "type":"structure", + "required":["ByteMatchSetId"], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + } + } + }, + "GetByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{ + "shape":"ByteMatchSet", + "documentation":"

    Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

    • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

    • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

    • FieldToMatch: Contains Data and Type

    " + } + } + }, + "GetChangeTokenRequest":{ + "type":"structure", + "members":{ + } + }, + "GetChangeTokenResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

    " + } + } + }, + "GetChangeTokenStatusRequest":{ + "type":"structure", + "required":["ChangeToken"], + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

    " + } + } + }, + "GetChangeTokenStatusResponse":{ + "type":"structure", + "members":{ + "ChangeTokenStatus":{ + "shape":"ChangeTokenStatus", + "documentation":"

    The status of the change token.

    " + } + } + }, + "GetGeoMatchSetRequest":{ + "type":"structure", + "required":["GeoMatchSetId"], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + } + } + }, + "GetGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "GeoMatchSet":{ + "shape":"GeoMatchSet", + "documentation":"

    Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.

    " + } + } + }, + "GetIPSetRequest":{ + "type":"structure", + "required":["IPSetId"], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + } + } + }, + "GetIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{ + "shape":"IPSet", + "documentation":"

    Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

    • IPSet: Contains IPSetDescriptors, IPSetId, and Name

    • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

    " + } + } + }, + "GetLoggingConfigurationRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

    " + } + } + }, + "GetLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The LoggingConfiguration for the specified web ACL.

    " + } + } + }, + "GetPermissionPolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.

    " + } + } + }, + "GetPermissionPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyString", + "documentation":"

    The IAM policy attached to the specified RuleGroup.

    " + } + } + }, + "GetRateBasedRuleManagedKeysRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    A null value and not currently used. Do not include this in your request.

    " + } + } + }, + "GetRateBasedRuleManagedKeysResponse":{ + "type":"structure", + "members":{ + "ManagedKeys":{ + "shape":"ManagedKeys", + "documentation":"

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    A null value and not currently used.

    " + } + } + }, + "GetRateBasedRuleRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + } + } + }, + "GetRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"RateBasedRule", + "documentation":"

    Information about the RateBasedRule that you specified in the GetRateBasedRule request.

    " + } + } + }, + "GetRegexMatchSetRequest":{ + "type":"structure", + "required":["RegexMatchSetId"], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + } + } + }, + "GetRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "RegexMatchSet":{ + "shape":"RegexMatchSet", + "documentation":"

    Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

    " + } + } + }, + "GetRegexPatternSetRequest":{ + "type":"structure", + "required":["RegexPatternSetId"], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + } + } + }, + "GetRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "RegexPatternSet":{ + "shape":"RegexPatternSet", + "documentation":"

    Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

    " + } + } + }, + "GetRuleGroupRequest":{ + "type":"structure", + "required":["RuleGroupId"], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + } + } + }, + "GetRuleGroupResponse":{ + "type":"structure", + "members":{ + "RuleGroup":{ + "shape":"RuleGroup", + "documentation":"

    Information about the RuleGroup that you specified in the GetRuleGroup request.

    " + } + } + }, + "GetRuleRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

    " + } + } + }, + "GetRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"Rule", + "documentation":"

    Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

    • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

    • Predicate: Each Predicate object contains DataId, Negated, and Type

    " + } + } + }, + "GetSampledRequestsMaxItems":{ + "type":"long", + "max":500, + "min":1 + }, + "GetSampledRequestsRequest":{ + "type":"structure", + "required":[ + "WebAclId", + "RuleId", + "TimeWindow", + "MaxItems" + ], + "members":{ + "WebAclId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    " + }, + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    RuleId is one of three values:

    • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

    • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

    " + }, + "TimeWindow":{ + "shape":"TimeWindow", + "documentation":"

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + }, + "MaxItems":{ + "shape":"GetSampledRequestsMaxItems", + "documentation":"

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

    " + } + } + }, + "GetSampledRequestsResponse":{ + "type":"structure", + "members":{ + "SampledRequests":{ + "shape":"SampledHTTPRequests", + "documentation":"

    A complex type that contains detailed information about each of the requests in the sample.

    " + }, + "PopulationSize":{ + "shape":"PopulationSize", + "documentation":"

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

    " + }, + "TimeWindow":{ + "shape":"TimeWindow", + "documentation":"

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

    " + } + } + }, + "GetSizeConstraintSetRequest":{ + "type":"structure", + "required":["SizeConstraintSetId"], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + } + } + }, + "GetSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{ + "shape":"SizeConstraintSet", + "documentation":"

    Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

    " + } + } + }, + "GetSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":["SqlInjectionMatchSetId"], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + } + }, + "documentation":"

    A request to get a SqlInjectionMatchSet.

    " + }, + "GetSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{ + "shape":"SqlInjectionMatchSet", + "documentation":"

    Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

    " + } + }, + "documentation":"

    The response to a GetSqlInjectionMatchSet request.

    " + }, + "GetWebACLForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The ARN (Amazon Resource Name) of the resource for which to get the web ACL, either an application load balancer or Amazon API Gateway stage.

    The ARN should be in one of the following formats:

    • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

    • For an Amazon API Gateway stage: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

    " + } + } + }, + "GetWebACLForResourceResponse":{ + "type":"structure", + "members":{ + "WebACLSummary":{ + "shape":"WebACLSummary", + "documentation":"

    Information about the web ACL that you specified in the GetWebACLForResource request. If there is no associated resource, a null WebACLSummary is returned.

    " + } + } + }, + "GetWebACLRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + } + } + }, + "GetWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{ + "shape":"WebACL", + "documentation":"

    Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

    • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

    • DefaultAction (Data type is WafAction): Contains Type

    • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

    • Action: Contains Type

    " + } + } + }, + "GetXssMatchSetRequest":{ + "type":"structure", + "required":["XssMatchSetId"], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + } + }, + "documentation":"

    A request to get an XssMatchSet.

    " + }, + "GetXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{ + "shape":"XssMatchSet", + "documentation":"

    Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

    • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

    • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

    " + } + }, + "documentation":"

    The response to a GetXssMatchSet request.

    " + }, + "HTTPHeader":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"HeaderName", + "documentation":"

    The name of one of the headers in the sampled web request.

    " + }, + "Value":{ + "shape":"HeaderValue", + "documentation":"

    The value of one of the headers in the sampled web request.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

    " + }, + "HTTPHeaders":{ + "type":"list", + "member":{"shape":"HTTPHeader"} + }, + "HTTPMethod":{"type":"string"}, + "HTTPRequest":{ + "type":"structure", + "members":{ + "ClientIP":{ + "shape":"IPString", + "documentation":"

    The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

    • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

    • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

    " + }, + "Country":{ + "shape":"Country", + "documentation":"

    The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

    " + }, + "URI":{ + "shape":"URIString", + "documentation":"

    The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

    " + }, + "Method":{ + "shape":"HTTPMethod", + "documentation":"

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " + }, + "HTTPVersion":{ + "shape":"HTTPVersion", + "documentation":"

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " + }, + "Headers":{ + "shape":"HTTPHeaders", + "documentation":"

    A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

    " + }, + "HTTPVersion":{"type":"string"}, + "HeaderName":{"type":"string"}, + "HeaderValue":{"type":"string"}, + "IPSet":{ + "type":"structure", + "required":[ + "IPSetId", + "IPSetDescriptors" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

    IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    " + }, + "IPSetDescriptors":{ + "shape":"IPSetDescriptors", + "documentation":"

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

    " + } + }, + "documentation":"

    Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.

    To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    " + }, + "IPSetDescriptor":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"IPSetDescriptorType", + "documentation":"

    Specify IPV4 or IPV6.

    " + }, + "Value":{ + "shape":"IPSetDescriptorValue", + "documentation":"

    Specify an IPv4 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    Specify an IPv6 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    " + } + }, + "documentation":"

    Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

    " + }, + "IPSetDescriptorType":{ + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "IPSetDescriptorValue":{"type":"string"}, + "IPSetDescriptors":{ + "type":"list", + "member":{"shape":"IPSetDescriptor"} + }, + "IPSetSummaries":{ + "type":"list", + "member":{"shape":"IPSetSummary"} + }, + "IPSetSummary":{ + "type":"structure", + "required":[ + "IPSetId", + "Name" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name of the IPSet.

    " + }, + "IPSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "IPSetDescriptor" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete an IP address with UpdateIPSet.

    " + }, + "IPSetDescriptor":{ + "shape":"IPSetDescriptor", + "documentation":"

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

    " + } + }, + "documentation":"

    Specifies the type of update to perform to an IPSet with UpdateIPSet.

    " + }, + "IPSetUpdates":{ + "type":"list", + "member":{"shape":"IPSetUpdate"}, + "min":1 + }, + "IPString":{"type":"string"}, + "ListActivatedRulesInRuleGroupRequest":{ + "type":"structure", + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

    " + } + } + }, + "ListActivatedRulesInRuleGroupResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "ActivatedRules":{ + "shape":"ActivatedRules", + "documentation":"

    An array of ActivatedRules objects.

    " + } + } + }, + "ListByteMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

    " + } + } + }, + "ListByteMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "ByteMatchSets":{ + "shape":"ByteMatchSetSummaries", + "documentation":"

    An array of ByteMatchSetSummary objects.

    " + } + } + }, + "ListGeoMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.

    " + } + } + }, + "ListGeoMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "GeoMatchSets":{ + "shape":"GeoMatchSetSummaries", + "documentation":"

    An array of GeoMatchSetSummary objects.

    " + } + } + }, + "ListIPSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

    " + } + } + }, + "ListIPSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.

    " + }, + "IPSets":{ + "shape":"IPSetSummaries", + "documentation":"

    An array of IPSetSummary objects.

    " + } + } + }, + "ListLoggingConfigurationsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

    " + } + } + }, + "ListLoggingConfigurationsResponse":{ + "type":"structure", + "members":{ + "LoggingConfigurations":{ + "shape":"LoggingConfigurations", + "documentation":"

    An array of LoggingConfiguration objects.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + } + } + }, + "ListRateBasedRulesRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + } + }, + "ListRateBasedRulesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "Rules":{ + "shape":"RuleSummaries", + "documentation":"

    An array of RuleSummary objects.

    " + } + } + }, + "ListRegexMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.

    " + } + } + }, + "ListRegexMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RegexMatchSets":{ + "shape":"RegexMatchSetSummaries", + "documentation":"

    An array of RegexMatchSetSummary objects.

    " + } + } + }, + "ListRegexPatternSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.

    " + } + } + }, + "ListRegexPatternSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RegexPatternSets":{ + "shape":"RegexPatternSetSummaries", + "documentation":"

    An array of RegexPatternSetSummary objects.

    " + } + } + }, + "ListResourcesForWebACLRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The unique identifier (ID) of the web ACL for which to list the associated resources.

    " + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

    The type of resource to list, either an application load balancer or Amazon API Gateway.

    " + } + } + }, + "ListResourcesForWebACLResponse":{ + "type":"structure", + "members":{ + "ResourceArns":{ + "shape":"ResourceArns", + "documentation":"

    An array of ARNs (Amazon Resource Names) of the resources associated with the specified web ACL. An array with zero elements is returned if there are no resources associated with the web ACL.

    " + } + } + }, + "ListRuleGroupsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    " + } + } + }, + "ListRuleGroupsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RuleGroups":{ + "shape":"RuleGroupSummaries", + "documentation":"

    An array of RuleGroup objects.

    " + } + } + }, + "ListRulesRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + } + }, + "ListRulesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "Rules":{ + "shape":"RuleSummaries", + "documentation":"

    An array of RuleSummary objects.

    " + } + } + }, + "ListSizeConstraintSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

    " + } + } + }, + "ListSizeConstraintSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "SizeConstraintSets":{ + "shape":"SizeConstraintSetSummaries", + "documentation":"

    An array of SizeConstraintSetSummary objects.

    " + } + } + }, + "ListSqlInjectionMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + }, + "documentation":"

    A request to list the SqlInjectionMatchSet objects created by the current AWS account.

    " + }, + "ListSqlInjectionMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "SqlInjectionMatchSets":{ + "shape":"SqlInjectionMatchSetSummaries", + "documentation":"

    An array of SqlInjectionMatchSetSummary objects.

    " + } + }, + "documentation":"

    The response to a ListSqlInjectionMatchSets request.

    " + }, + "ListSubscribedRuleGroupsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.

    " + } + } + }, + "ListSubscribedRuleGroupsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RuleGroups":{ + "shape":"SubscribedRuleGroupSummaries", + "documentation":"

    An array of RuleGroup objects.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"}, + "ResourceARN":{"shape":"ResourceArn"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "TagInfoForResource":{"shape":"TagInfoForResource"} + } + }, + "ListWebACLsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

    " + } + } + }, + "ListWebACLsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "WebACLs":{ + "shape":"WebACLSummaries", + "documentation":"

    An array of WebACLSummary objects.

    " + } + } + }, + "ListXssMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + }, + "documentation":"

    A request to list the XssMatchSet objects created by the current AWS account.

    " + }, + "ListXssMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "XssMatchSets":{ + "shape":"XssMatchSetSummaries", + "documentation":"

    An array of XssMatchSetSummary objects.

    " + } + }, + "documentation":"

    The response to a ListXssMatchSets request.

    " + }, + "LogDestinationConfigs":{ + "type":"list", + "member":{"shape":"ResourceArn"}, + "max":1, + "min":1 + }, + "LoggingConfiguration":{ + "type":"structure", + "required":[ + "ResourceArn", + "LogDestinationConfigs" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

    " + }, + "LogDestinationConfigs":{ + "shape":"LogDestinationConfigs", + "documentation":"

    An array of Amazon Kinesis Data Firehose ARNs.

    " + }, + "RedactedFields":{ + "shape":"RedactedFields", + "documentation":"

    The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

    " + } + }, + "documentation":"

    The Amazon Kinesis Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN).

    " + }, + "LoggingConfigurations":{ + "type":"list", + "member":{"shape":"LoggingConfiguration"} + }, + "ManagedKey":{"type":"string"}, + "ManagedKeys":{ + "type":"list", + "member":{"shape":"ManagedKey"} + }, + "MatchFieldData":{"type":"string"}, + "MatchFieldType":{ + "type":"string", + "enum":[ + "URI", + "QUERY_STRING", + "HEADER", + "METHOD", + "BODY", + "SINGLE_QUERY_ARG", + "ALL_QUERY_ARGS" + ] + }, + "MetricName":{"type":"string"}, + "Negated":{"type":"boolean"}, + "NextMarker":{ + "type":"string", + "min":1 + }, + "PaginationLimit":{ + "type":"integer", + "max":100, + "min":0 + }, + "ParameterExceptionField":{ + "type":"string", + "enum":[ + "CHANGE_ACTION", + "WAF_ACTION", + "WAF_OVERRIDE_ACTION", + "PREDICATE_TYPE", + "IPSET_TYPE", + "BYTE_MATCH_FIELD_TYPE", + "SQL_INJECTION_MATCH_FIELD_TYPE", + "BYTE_MATCH_TEXT_TRANSFORMATION", + "BYTE_MATCH_POSITIONAL_CONSTRAINT", + "SIZE_CONSTRAINT_COMPARISON_OPERATOR", + "GEO_MATCH_LOCATION_TYPE", + "GEO_MATCH_LOCATION_VALUE", + "RATE_KEY", + "RULE_TYPE", + "NEXT_MARKER", + "RESOURCE_ARN", + "TAGS", + "TAG_KEYS" + ] + }, + "ParameterExceptionParameter":{ + "type":"string", + "min":1 + }, + "ParameterExceptionReason":{ + "type":"string", + "enum":[ + "INVALID_OPTION", + "ILLEGAL_COMBINATION", + "ILLEGAL_ARGUMENT", + "INVALID_TAG_KEY" + ] + }, + "PolicyString":{ + "type":"string", + "min":1 + }, + "PopulationSize":{"type":"long"}, + "PositionalConstraint":{ + "type":"string", + "enum":[ + "EXACTLY", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CONTAINS_WORD" + ] + }, + "Predicate":{ + "type":"structure", + "required":[ + "Negated", + "Type", + "DataId" + ], + "members":{ + "Negated":{ + "shape":"Negated", + "documentation":"

    Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

    Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

    " + }, + "Type":{ + "shape":"PredicateType", + "documentation":"

    The type of predicate in a Rule, such as ByteMatch or IPSet.

    " + }, + "DataId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

    " + } + }, + "documentation":"

    Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

    " + }, + "PredicateType":{ + "type":"string", + "enum":[ + "IPMatch", + "ByteMatch", + "SqlInjectionMatch", + "GeoMatch", + "SizeConstraint", + "XssMatch", + "RegexMatch" + ] + }, + "Predicates":{ + "type":"list", + "member":{"shape":"Predicate"} + }, + "PutLoggingConfigurationRequest":{ + "type":"structure", + "required":["LoggingConfiguration"], + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.

    When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

    " + } + } + }, + "PutLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The LoggingConfiguration that you submitted in the request.

    " + } + } + }, + "PutPermissionPolicyRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Policy" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    " + }, + "Policy":{ + "shape":"PolicyString", + "documentation":"

    The policy to attach to the specified RuleGroup.

    " + } + } + }, + "PutPermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "RateBasedRule":{ + "type":"structure", + "required":[ + "RuleId", + "MatchPredicates", + "RateKey", + "RateLimit" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule.

    " + }, + "MatchPredicates":{ + "shape":"Predicates", + "documentation":"

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

    " + }, + "RateKey":{ + "shape":"RateKey", + "documentation":"

    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + } + }, + "documentation":"

    A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

    • The requests come from 192.0.2.44.

    • They contain the value BadBot in the User-Agent header.

    In the rule, you also define the rate limit as 15,000.

    Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

    " + }, + "RateKey":{ + "type":"string", + "enum":["IP"] + }, + "RateLimit":{ + "type":"long", + "max":2000000000, + "min":100 + }, + "RedactedFields":{ + "type":"list", + "member":{"shape":"FieldToMatch"} + }, + "RegexMatchSet":{ + "type":"structure", + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + }, + "RegexMatchTuples":{ + "shape":"RegexMatchTuples", + "documentation":"

    Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    " + } + }, + "documentation":"

    In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

    The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

    " + }, + "RegexMatchSetSummaries":{ + "type":"list", + "member":{"shape":"RegexMatchSetSummary"} + }, + "RegexMatchSetSummary":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "Name" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + } + }, + "documentation":"

    Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

    " + }, + "RegexMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "RegexMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a RegexMatchTuple.

    " + }, + "RegexMatchTuple":{ + "shape":"RegexMatchTuple", + "documentation":"

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    " + } + }, + "documentation":"

    In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple.

    " + }, + "RegexMatchSetUpdates":{ + "type":"list", + "member":{"shape":"RegexMatchSetUpdate"}, + "min":1 + }, + "RegexMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation", + "RegexPatternSetId" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for the RegexPatternSet.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + }, + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + } + }, + "documentation":"

    The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    " + }, + "RegexMatchTuples":{ + "type":"list", + "member":{"shape":"RegexMatchTuple"} + }, + "RegexPatternSet":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "RegexPatternStrings" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + }, + "RegexPatternStrings":{ + "shape":"RegexPatternStrings", + "documentation":"

    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    " + } + }, + "documentation":"

    The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    " + }, + "RegexPatternSetSummaries":{ + "type":"list", + "member":{"shape":"RegexPatternSetSummary"} + }, + "RegexPatternSetSummary":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "Name" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + } + }, + "documentation":"

    Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

    " + }, + "RegexPatternSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "RegexPatternString" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a RegexPatternString.

    " + }, + "RegexPatternString":{ + "shape":"RegexPatternString", + "documentation":"

    Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    " + } + }, + "documentation":"

    In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString.

    " + }, + "RegexPatternSetUpdates":{ + "type":"list", + "member":{"shape":"RegexPatternSetUpdate"}, + "min":1 + }, + "RegexPatternString":{ + "type":"string", + "min":1 + }, + "RegexPatternStrings":{ + "type":"list", + "member":{"shape":"RegexPatternString"}, + "max":10 + }, + "ResourceArn":{ + "type":"string", + "max":1224, + "min":1 + }, + "ResourceArns":{ + "type":"list", + "member":{"shape":"ResourceArn"} + }, + "ResourceId":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceName":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceType":{ + "type":"string", + "enum":[ + "APPLICATION_LOAD_BALANCER", + "API_GATEWAY" + ] + }, + "Rule":{ + "type":"structure", + "required":[ + "RuleId", + "Predicates" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " + }, + "Predicates":{ + "shape":"Predicates", + "documentation":"

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

    " + } + }, + "documentation":"

    A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

    • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

    • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

    To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

    " + }, + "RuleGroup":{ + "type":"structure", + "required":["RuleGroupId"], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + } + }, + "documentation":"

    A collection of predefined rules that you can add to a web ACL.

    Rule groups are subject to the following limits:

    • Three rule groups per account. You can request an increase to this limit by contacting customer support.

    • One rule group per web ACL.

    • Ten rules per rule group.

    " + }, + "RuleGroupSummaries":{ + "type":"list", + "member":{"shape":"RuleGroupSummary"} + }, + "RuleGroupSummary":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Name" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the friendly name or description of the RuleGroup.

    " + }, + "RuleGroupUpdate":{ + "type":"structure", + "required":[ + "Action", + "ActivatedRule" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.

    " + }, + "ActivatedRule":{ + "shape":"ActivatedRule", + "documentation":"

    The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    " + } + }, + "documentation":"

    Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup.

    " + }, + "RuleGroupUpdates":{ + "type":"list", + "member":{"shape":"RuleGroupUpdate"}, + "min":1 + }, + "RulePriority":{"type":"integer"}, + "RuleSummaries":{ + "type":"list", + "member":{"shape":"RuleSummary"} + }, + "RuleSummary":{ + "type":"structure", + "required":[ + "RuleId", + "Name" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the friendly name or description of the Rule.

    " + }, + "RuleUpdate":{ + "type":"structure", + "required":[ + "Action", + "Predicate" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

    " + }, + "Predicate":{ + "shape":"Predicate", + "documentation":"

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    " + } + }, + "documentation":"

    Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

    " + }, + "RuleUpdates":{ + "type":"list", + "member":{"shape":"RuleUpdate"} + }, + "SampleWeight":{ + "type":"long", + "min":0 + }, + "SampledHTTPRequest":{ + "type":"structure", + "required":[ + "Request", + "Weight" + ], + "members":{ + "Request":{ + "shape":"HTTPRequest", + "documentation":"

    A complex type that contains detailed information about the request.

    " + }, + "Weight":{ + "shape":"SampleWeight", + "documentation":"

    A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

    " + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + }, + "Action":{ + "shape":"Action", + "documentation":"

    The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

    " + }, + "RuleWithinRuleGroup":{ + "shape":"ResourceId", + "documentation":"

    This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

    " + }, + "SampledHTTPRequests":{ + "type":"list", + "member":{"shape":"SampledHTTPRequest"} + }, + "Size":{ + "type":"long", + "max":21474836480, + "min":0 + }, + "SizeConstraint":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation", + "ComparisonOperator", + "Size" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for the size constraint.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    " + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    EQ: Used to test if the Size is equal to the size of the FieldToMatch

    NE: Used to test if the Size is not equal to the size of the FieldToMatch

    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

    LT: Used to test if the Size is strictly less than the size of the FieldToMatch

    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

    If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

    " + } + }, + "documentation":"

    Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    " + }, + "SizeConstraintSet":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "SizeConstraints" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the SizeConstraintSet.

    " + }, + "SizeConstraints":{ + "shape":"SizeConstraints", + "documentation":"

    Specifies the parts of web requests that you want to inspect the size of.

    " + } + }, + "documentation":"

    A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

    " + }, + "SizeConstraintSetSummaries":{ + "type":"list", + "member":{"shape":"SizeConstraintSetSummary"} + }, + "SizeConstraintSetSummary":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "Name" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the SizeConstraintSet, if any.

    " + } + }, + "documentation":"

    The Id and Name of a SizeConstraintSet.

    " + }, + "SizeConstraintSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SizeConstraint" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

    " + }, + "SizeConstraint":{ + "shape":"SizeConstraint", + "documentation":"

    Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

    " + }, + "SizeConstraintSetUpdates":{ + "type":"list", + "member":{"shape":"SizeConstraintSetUpdate"}, + "min":1 + }, + "SizeConstraints":{ + "type":"list", + "member":{"shape":"SizeConstraint"} + }, + "SqlInjectionMatchSet":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "SqlInjectionMatchTuples" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchTuples":{ + "shape":"SqlInjectionMatchTuples", + "documentation":"

    Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

    " + } + }, + "documentation":"

    A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

    " + }, + "SqlInjectionMatchSetSummaries":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetSummary"} + }, + "SqlInjectionMatchSetSummary":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "Name" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    " + } + }, + "documentation":"

    The Id and Name of a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SqlInjectionMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchTuple":{ + "shape":"SqlInjectionMatchTuple", + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchSetUpdates":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetUpdate"}, + "min":1 + }, + "SqlInjectionMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for snippets of malicious SQL code.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    " + }, + "SqlInjectionMatchTuples":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchTuple"} + }, + "SubscribedRuleGroupSummaries":{ + "type":"list", + "member":{"shape":"SubscribedRuleGroupSummary"} + }, + "SubscribedRuleGroupSummary":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Name", + "MetricName" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + } + }, + "documentation":"

    A summary of the rule groups you are subscribed to.

    " + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagInfoForResource":{ + "type":"structure", + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "TagList":{"shape":"TagList"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "Tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TextTransformation":{ + "type":"string", + "enum":[ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE" + ] + }, + "TimeWindow":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + } + }, + "documentation":"

    In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

    In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

    " + }, + "Timestamp":{"type":"timestamp"}, + "URIString":{"type":"string"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"ByteMatchSetUpdates", + "documentation":"

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

    " + } + } + }, + "UpdateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"GeoMatchSetUpdates", + "documentation":"

    An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

    • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint

    • GeoMatchConstraint: Contains Type and Value

      You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.

    " + } + } + }, + "UpdateGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"IPSetUpdates", + "documentation":"

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

    You can insert a maximum of 1000 addresses in a single request.

    " + } + } + }, + "UpdateIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken", + "Updates", + "RateLimit" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"RuleUpdates", + "documentation":"

    An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + } + } + }, + "UpdateRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "Updates", + "ChangeToken" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Updates":{ + "shape":"RegexMatchSetUpdates", + "documentation":"

    An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "Updates", + "ChangeToken" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Updates":{ + "shape":"RegexPatternSetUpdates", + "documentation":"

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRuleGroupRequest":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Updates", + "ChangeToken" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Updates":{ + "shape":"RuleGroupUpdates", + "documentation":"

    An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRuleGroupResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken", + "Updates" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"RuleUpdates", + "documentation":"

    An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

    " + } + } + }, + "UpdateRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"SizeConstraintSetUpdates", + "documentation":"

    An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

    " + } + } + }, + "UpdateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"SqlInjectionMatchSetUpdates", + "documentation":"

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

    " + } + }, + "documentation":"

    A request to update a SqlInjectionMatchSet.

    " + }, + "UpdateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to an UpdateSqlInjectionMatchSets request.

    " + }, + "UpdateWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"WebACLUpdates", + "documentation":"

    An array of updates to make to the WebACL.

    An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

    • WebACLUpdate: Contains Action and ActivatedRule

    • ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    • WafAction: Contains Type

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

    " + } + } + }, + "UpdateWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"XssMatchSetUpdates", + "documentation":"

    An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

    " + } + }, + "documentation":"

    A request to update an XssMatchSet.

    " + }, + "UpdateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to an UpdateXssMatchSets request.

    " + }, + "WAFBadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFDisallowedNameException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The name specified is invalid.

    ", + "exception":true + }, + "WAFInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because of a system problem, even though the request was valid. Retry your request.

    ", + "exception":true, + "fault":true + }, + "WAFInvalidAccountException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

    ", + "exception":true + }, + "WAFInvalidOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because there was nothing to do. For example:

    • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

    • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

    • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

    • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

    • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

    ", + "exception":true + }, + "WAFInvalidParameterException":{ + "type":"structure", + "members":{ + "field":{"shape":"ParameterExceptionField"}, + "parameter":{"shape":"ParameterExceptionParameter"}, + "reason":{"shape":"ParameterExceptionReason"} + }, + "documentation":"

    The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

    • You specified an invalid parameter name.

    • You specified an invalid value.

    • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

    • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

    • You tried to create a RateBasedRule with a RateKey value other than IP.

    • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

    • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

    • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

    • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

    ", + "exception":true + }, + "WAFInvalidPermissionPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because the specified policy is not in the proper format.

    The policy is subject to the following restrictions:

    • You can attach only one policy with each PutPermissionPolicy request.

    • The policy must include an Effect, Action and Principal.

    • Effect must specify Allow.

    • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    • The policy cannot include a Resource parameter.

    • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    • The user making the request must be the owner of the RuleGroup.

    • Your policy must be composed using IAM Policy version 2012-10-17.

    ", + "exception":true + }, + "WAFInvalidRegexPatternException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The regular expression (regex) you specified in RegexPatternString is invalid.

    ", + "exception":true + }, + "WAFLimitsExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

    ", + "exception":true + }, + "WAFNonEmptyEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to delete an object that isn't empty. For example:

    • You tried to delete a WebACL that still contains one or more Rule objects.

    • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

    • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

    • You tried to delete an IPSet that references one or more IP addresses.

    ", + "exception":true + }, + "WAFNonexistentContainerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

    • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

    • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

    • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

    • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

    ", + "exception":true + }, + "WAFNonexistentItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because the referenced object doesn't exist.

    ", + "exception":true + }, + "WAFReferencedItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to delete an object that is still in use. For example:

    • You tried to delete a ByteMatchSet that is still referenced by a Rule.

    • You tried to delete a Rule that is still referenced by a WebACL.

    ", + "exception":true + }, + "WAFServiceLinkedRoleErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

    ", + "exception":true + }, + "WAFStaleDataException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

    ", + "exception":true + }, + "WAFSubscriptionNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The specified subscription does not exist.

    ", + "exception":true + }, + "WAFTagOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFTagOperationInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true, + "fault":true + }, + "WAFUnavailableEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because the entity referenced is temporarily unavailable. Retry your request.

    ", + "exception":true + }, + "WafAction":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"WafActionType", + "documentation":"

    Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

    • ALLOW: AWS WAF allows requests

    • BLOCK: AWS WAF blocks requests

    • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

    " + } + }, + "documentation":"

    For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

    " + }, + "WafActionType":{ + "type":"string", + "enum":[ + "BLOCK", + "ALLOW", + "COUNT" + ] + }, + "WafOverrideAction":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"WafOverrideActionType", + "documentation":"

    COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

    " + } + }, + "documentation":"

    The action to take if any rule within the RuleGroup matches a request.

    " + }, + "WafOverrideActionType":{ + "type":"string", + "enum":[ + "NONE", + "COUNT" + ] + }, + "WafRuleType":{ + "type":"string", + "enum":[ + "REGULAR", + "RATE_BASED", + "GROUP" + ] + }, + "WebACL":{ + "type":"structure", + "required":[ + "WebACLId", + "DefaultAction", + "Rules" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

    " + }, + "Rules":{ + "shape":"ActivatedRules", + "documentation":"

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

    " + }, + "WebACLArn":{ + "shape":"ResourceArn", + "documentation":"

    Tha Amazon Resource Name (ARN) of the web ACL.

    " + } + }, + "documentation":"

    Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

    " + }, + "WebACLSummaries":{ + "type":"list", + "member":{"shape":"WebACLSummary"} + }, + "WebACLSummary":{ + "type":"structure", + "required":[ + "WebACLId", + "Name" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name or description of the WebACL.

    " + }, + "WebACLUpdate":{ + "type":"structure", + "required":[ + "Action", + "ActivatedRule" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert a Rule into or delete a Rule from a WebACL.

    " + }, + "ActivatedRule":{ + "shape":"ActivatedRule", + "documentation":"

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    " + } + }, + "documentation":"

    Specifies whether to insert a Rule into or delete a Rule from a WebACL.

    " + }, + "WebACLUpdates":{ + "type":"list", + "member":{"shape":"WebACLUpdate"} + }, + "XssMatchSet":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "XssMatchTuples" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the XssMatchSet.

    " + }, + "XssMatchTuples":{ + "shape":"XssMatchTuples", + "documentation":"

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    " + } + }, + "documentation":"

    A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

    " + }, + "XssMatchSetSummaries":{ + "type":"list", + "member":{"shape":"XssMatchSetSummary"} + }, + "XssMatchSetSummary":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "Name" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the XssMatchSet, if any, specified by Id.

    " + } + }, + "documentation":"

    The Id and Name of an XssMatchSet.

    " + }, + "XssMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "XssMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.

    " + }, + "XssMatchTuple":{ + "shape":"XssMatchTuple", + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

    " + }, + "XssMatchSetUpdates":{ + "type":"list", + "member":{"shape":"XssMatchSetUpdate"}, + "min":1 + }, + "XssMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for cross-site scripting attacks.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    " + }, + "XssMatchTuples":{ + "type":"list", + "member":{"shape":"XssMatchTuple"} + }, + "errorMessage":{"type":"string"} + }, + "documentation":"

    This is the AWS WAF Regional API Reference for using AWS WAF with Elastic Load Balancing (ELB) Application Load Balancers. The AWS WAF actions and data types listed in the reference are available for protecting Application Load Balancers. You can use these actions and data types by means of the endpoints listed in AWS Regions and Endpoints. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

    " +} diff --git a/aws/dist/botocore/data/waf/2015-08-24/examples-1.json b/aws/dist/botocore/data/waf/2015-08-24/examples-1.json new file mode 100644 index 00000000..eee5b6f4 --- /dev/null +++ b/aws/dist/botocore/data/waf/2015-08-24/examples-1.json @@ -0,0 +1,1017 @@ +{ + "version": "1.0", + "examples": { + "CreateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an IP match set named MyIPSetFriendlyName.", + "id": "createipset-1472501003122", + "title": "To create an IP set" + } + ], + "CreateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "WAFRule-1-Example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a rule named WAFByteHeaderRule.", + "id": "createrule-1474072675555", + "title": "To create a rule" + } + ], + "CreateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleSizeConstraintSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates size constraint set named MySampleSizeConstraintSet.", + "id": "createsizeconstraint-1474299140754", + "title": "To create a size constraint" + } + ], + "CreateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySQLInjectionMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a SQL injection match set named MySQLInjectionMatchSet.", + "id": "createsqlinjectionmatchset-1474492796105", + "title": "To create a SQL injection match set" + } + ], + "CreateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "example-46da-4444-5555-example" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates a web ACL named CreateExample.", + "id": "createwebacl-1472061481310", + "title": "To create a web ACL" + } + ], + "CreateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MySampleXssMatchSet" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example creates an XSS match set named MySampleXssMatchSet.", + "id": "createxssmatchset-1474560868500", + "title": "To create an XSS match set" + } + ], + "DeleteByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletebytematchset-1473367566229", + "title": "To delete a byte match set" + } + ], + "DeleteIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deleteipset-1472767434306", + "title": "To delete an IP set" + } + ], + "DeleteRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "WAFRule-1-Example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a rule with the ID WAFRule-1-Example.", + "id": "deleterule-1474073108749", + "title": "To delete a rule" + } + ], + "DeleteSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesizeconstraintset-1474299857905", + "title": "To delete a size constraint set" + } + ], + "DeleteSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletesqlinjectionmatchset-1474493373197", + "title": "To delete a SQL injection match set" + } + ], + "DeleteWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "WebACLId": "example-46da-4444-5555-example" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a web ACL with the ID example-46da-4444-5555-example.", + "id": "deletewebacl-1472767755931", + "title": "To delete a web ACL" + } + ], + "DeleteXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "deletexssmatchset-1474561302618", + "title": "To delete an XSS match set" + } + ], + "GetByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ByteMatchSet": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ByteMatchTuples": [ + { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + ], + "Name": "ByteMatchNameExample" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getbytematchset-1473273311532", + "title": "To get a byte match set" + } + ], + "GetChangeToken": [ + { + "input": { + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns a change token to use for a create, update or delete operation.", + "id": "get-change-token-example-1471635120794", + "title": "To get a change token" + } + ], + "GetChangeTokenStatus": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "output": { + "ChangeTokenStatus": "PENDING" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.", + "id": "getchangetokenstatus-1474658417107", + "title": "To get the change token status" + } + ], + "GetIPSet": [ + { + "input": { + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "IPSet": { + "IPSetDescriptors": [ + { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + ], + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Name": "MyIPSetFriendlyName" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getipset-1474658688675", + "title": "To get an IP set" + } + ], + "GetRule": [ + { + "input": { + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "Rule": { + "MetricName": "WAFByteHeaderRule", + "Name": "WAFByteHeaderRule", + "Predicates": [ + { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + ], + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getrule-1474659238790", + "title": "To get a rule" + } + ], + "GetSampledRequests": [ + { + "input": { + "MaxItems": 100, + "RuleId": "WAFRule-1-Example", + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T15:50Z" + }, + "WebAclId": "createwebacl-1472061481310" + }, + "output": { + "PopulationSize": 50, + "SampledRequests": [ + { + "Action": "BLOCK", + "Request": { + "ClientIP": "192.0.2.44", + "Country": "US", + "HTTPVersion": "HTTP/1.1", + "Headers": [ + { + "Name": "User-Agent", + "Value": "BadBot " + } + ], + "Method": "HEAD" + }, + "Timestamp": "2016-09-27T14:55Z", + "Weight": 1 + } + ], + "TimeWindow": { + "EndTime": "2016-09-27T15:50Z", + "StartTime": "2016-09-27T14:50Z" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.", + "id": "getsampledrequests-1474927997195", + "title": "To get a sampled requests" + } + ], + "GetSizeConstraintSet": [ + { + "input": { + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SizeConstraintSet": { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SizeConstraints": [ + { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsizeconstraintset-1475005422493", + "title": "To get a size constraint set" + } + ], + "GetSqlInjectionMatchSet": [ + { + "input": { + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "SqlInjectionMatchSet": { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "SqlInjectionMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getsqlinjectionmatchset-1475005940137", + "title": "To get a SQL injection match set" + } + ], + "GetWebACL": [ + { + "input": { + "WebACLId": "createwebacl-1472061481310" + }, + "output": { + "WebACL": { + "DefaultAction": { + "Type": "ALLOW" + }, + "MetricName": "CreateExample", + "Name": "CreateExample", + "Rules": [ + { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + ], + "WebACLId": "createwebacl-1472061481310" + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of a web ACL with the ID createwebacl-1472061481310.", + "id": "getwebacl-1475006348525", + "title": "To get a web ACL" + } + ], + "GetXssMatchSet": [ + { + "input": { + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "XssMatchSet": { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "XssMatchTuples": [ + { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + ] + } + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "getxssmatchset-1475187879017", + "title": "To get an XSS match set" + } + ], + "ListIPSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "IPSets": [ + { + "IPSetId": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Name": "MyIPSetFriendlyName" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 IP match sets.", + "id": "listipsets-1472235676229", + "title": "To list IP sets" + } + ], + "ListRules": [ + { + "input": { + "Limit": 100 + }, + "output": { + "Rules": [ + { + "Name": "WAFByteHeaderRule", + "RuleId": "WAFRule-1-Example" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 rules.", + "id": "listrules-1475258406433", + "title": "To list rules" + } + ], + "ListSizeConstraintSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SizeConstraintSets": [ + { + "Name": "MySampleSizeConstraintSet", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 size contraint match sets.", + "id": "listsizeconstraintsets-1474300067597", + "title": "To list a size constraint sets" + } + ], + "ListSqlInjectionMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "SqlInjectionMatchSets": [ + { + "Name": "MySQLInjectionMatchSet", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 SQL injection match sets.", + "id": "listsqlinjectionmatchset-1474493560103", + "title": "To list SQL injection match sets" + } + ], + "ListWebACLs": [ + { + "input": { + "Limit": 100 + }, + "output": { + "WebACLs": [ + { + "Name": "WebACLexample", + "WebACLId": "webacl-1472061481310" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 web ACLs.", + "id": "listwebacls-1475258732691", + "title": "To list Web ACLs" + } + ], + "ListXssMatchSets": [ + { + "input": { + "Limit": 100 + }, + "output": { + "XssMatchSets": [ + { + "Name": "MySampleXssMatchSet", + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example returns an array of up to 100 XSS match sets.", + "id": "listxssmatchsets-1474561481168", + "title": "To list XSS match sets" + } + ], + "UpdateByteMatchSet": [ + { + "input": { + "ByteMatchSetId": "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "ByteMatchTuple": { + "FieldToMatch": { + "Data": "referer", + "Type": "HEADER" + }, + "PositionalConstraint": "CONTAINS", + "TargetString": "badrefer1", + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatebytematchset-1475259074558", + "title": "To update a byte match set" + } + ], + "UpdateIPSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "IPSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "IPSetDescriptor": { + "Type": "IPV4", + "Value": "192.0.2.44/32" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updateipset-1475259733625", + "title": "To update an IP set" + } + ], + "UpdateRule": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "RuleId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "Predicate": { + "DataId": "MyByteMatchSetID", + "Negated": false, + "Type": "ByteMatch" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updaterule-1475260064720", + "title": "To update a rule" + } + ], + "UpdateSizeConstraintSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SizeConstraintSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SizeConstraint": { + "ComparisonOperator": "GT", + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "Size": 0, + "TextTransformation": "NONE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesizeconstraintset-1475531697891", + "title": "To update a size constraint set" + } + ], + "UpdateSqlInjectionMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "SqlInjectionMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5", + "Updates": [ + { + "Action": "DELETE", + "SqlInjectionMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ] + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatesqlinjectionmatchset-1475532094686", + "title": "To update a SQL injection match set" + } + ], + "UpdateWebACL": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "DefaultAction": { + "Type": "ALLOW" + }, + "Updates": [ + { + "Action": "DELETE", + "ActivatedRule": { + "Action": { + "Type": "ALLOW" + }, + "Priority": 1, + "RuleId": "WAFRule-1-Example" + } + } + ], + "WebACLId": "webacl-1472061481310" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.", + "id": "updatewebacl-1475533627385", + "title": "To update a Web ACL" + } + ], + "UpdateXssMatchSet": [ + { + "input": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", + "Updates": [ + { + "Action": "DELETE", + "XssMatchTuple": { + "FieldToMatch": { + "Type": "QUERY_STRING" + }, + "TextTransformation": "URL_DECODE" + } + } + ], + "XssMatchSetId": "example1ds3t-46da-4fdb-b8d5-abc321j569j5" + }, + "output": { + "ChangeToken": "abcd12f2-46da-4fdb-b8d5-fbd4c466928f" + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.", + "id": "updatexssmatchset-1475534098881", + "title": "To update an XSS match set" + } + ] + } +} diff --git a/aws/dist/botocore/data/waf/2015-08-24/paginators-1.json b/aws/dist/botocore/data/waf/2015-08-24/paginators-1.json new file mode 100644 index 00000000..9f2eba80 --- /dev/null +++ b/aws/dist/botocore/data/waf/2015-08-24/paginators-1.json @@ -0,0 +1,99 @@ +{ + "pagination": { + "ListByteMatchSets": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "ByteMatchSets" + }, + "ListIPSets": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "IPSets" + }, + "ListRules": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "Rules" + }, + "ListSizeConstraintSets": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "SizeConstraintSets" + }, + "ListSqlInjectionMatchSets": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "SqlInjectionMatchSets" + }, + "ListWebACLs": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "WebACLs" + }, + "ListXssMatchSets": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "limit_key": "Limit", + "result_key": "XssMatchSets" + }, + "GetRateBasedRuleManagedKeys": { + "input_token": "NextMarker", + "output_token": "NextMarker", + "result_key": "ManagedKeys" + }, + "ListActivatedRulesInRuleGroup": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "ActivatedRules" + }, + "ListGeoMatchSets": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "GeoMatchSets" + }, + "ListLoggingConfigurations": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "LoggingConfigurations" + }, + "ListRateBasedRules": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "Rules" + }, + "ListRegexMatchSets": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "RegexMatchSets" + }, + "ListRegexPatternSets": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "RegexPatternSets" + }, + "ListRuleGroups": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "RuleGroups" + }, + "ListSubscribedRuleGroups": { + "input_token": "NextMarker", + "limit_key": "Limit", + "output_token": "NextMarker", + "result_key": "RuleGroups" + } + } +} diff --git a/aws/dist/botocore/data/waf/2015-08-24/service-2.json b/aws/dist/botocore/data/waf/2015-08-24/service-2.json new file mode 100644 index 00000000..e3abe896 --- /dev/null +++ b/aws/dist/botocore/data/waf/2015-08-24/service-2.json @@ -0,0 +1,5192 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-08-24", + "endpointPrefix":"waf", + "jsonVersion":"1.1", + "protocol":"json", + "serviceAbbreviation":"WAF", + "serviceFullName":"AWS WAF", + "serviceId":"WAF", + "signatureVersion":"v4", + "targetPrefix":"AWSWAF_20150824", + "uid":"waf-2015-08-24" + }, + "operations":{ + "CreateByteMatchSet":{ + "name":"CreateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateByteMatchSetRequest"}, + "output":{"shape":"CreateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

    To create and configure a ByteMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

    2. Submit a CreateByteMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

    4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateGeoMatchSet":{ + "name":"CreateGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGeoMatchSetRequest"}, + "output":{"shape":"CreateGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

    To create and configure a GeoMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request.

    2. Submit a CreateGeoMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

    4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateIPSet":{ + "name":"CreateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIPSetRequest"}, + "output":{"shape":"CreateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

    To create and configure an IPSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

    2. Submit a CreateIPSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRateBasedRule":{ + "name":"CreateRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRateBasedRuleRequest"}, + "output":{"shape":"CreateRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

    If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    Further, you specify a RateLimit of 15,000.

    You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests.

    As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

    • A ByteMatchSet with FieldToMatch of URI

    • A PositionalConstraint of STARTS_WITH

    • A TargetString of login

    Further, you specify a RateLimit of 15,000.

    By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

    To create and configure a RateBasedRule, perform the following steps:

    1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

    3. Submit a CreateRateBasedRule request.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

    6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRegexMatchSet":{ + "name":"CreateRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegexMatchSetRequest"}, + "output":{"shape":"CreateRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.

    2. Submit a CreateRegexMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

    4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRegexPatternSet":{ + "name":"CreateRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRegexPatternSetRequest"}, + "output":{"shape":"CreateRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexPatternSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

    2. Submit a CreateRegexPatternSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

    4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRule":{ + "name":"CreateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleRequest"}, + "output":{"shape":"CreateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

    To create and configure a Rule, perform the following steps:

    1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

    3. Submit a CreateRule request.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

    6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateRuleGroup":{ + "name":"CreateRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateRuleGroupRequest"}, + "output":{"shape":"CreateRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

    Rule groups are subject to the following limits:

    • Three rule groups per account. You can request an increase to this limit by contacting customer support.

    • One rule group per web ACL.

    • Ten rules per rule group.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateSizeConstraintSet":{ + "name":"CreateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSizeConstraintSetRequest"}, + "output":{"shape":"CreateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

    To create and configure a SizeConstraintSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

    2. Submit a CreateSizeConstraintSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

    4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateSqlInjectionMatchSet":{ + "name":"CreateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateSqlInjectionMatchSetRequest"}, + "output":{"shape":"CreateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

    To create and configure a SqlInjectionMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

    2. Submit a CreateSqlInjectionMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

    4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "CreateWebACL":{ + "name":"CreateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWebACLRequest"}, + "output":{"shape":"CreateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"}, + {"shape":"WAFBadRequestException"} + ], + "documentation":"

    Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

    You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

    To create and configure a WebACL, perform the following steps:

    1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

    4. Submit a CreateWebACL request.

    5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

    6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

    For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

    " + }, + "CreateXssMatchSet":{ + "name":"CreateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateXssMatchSetRequest"}, + "output":{"shape":"CreateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

    To create and configure an XssMatchSet, perform the following steps:

    1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

    2. Submit a CreateXssMatchSet request.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

    4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "DeleteByteMatchSet":{ + "name":"DeleteByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteByteMatchSetRequest"}, + "output":{"shape":"DeleteByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

    If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

    To permanently delete a ByteMatchSet, perform the following steps:

    1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

    3. Submit a DeleteByteMatchSet request.

    " + }, + "DeleteGeoMatchSet":{ + "name":"DeleteGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGeoMatchSetRequest"}, + "output":{"shape":"DeleteGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

    If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

    To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

    1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.

    3. Submit a DeleteGeoMatchSet request.

    " + }, + "DeleteIPSet":{ + "name":"DeleteIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIPSetRequest"}, + "output":{"shape":"DeleteIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

    If you just want to remove an IPSet from a Rule, use UpdateRule.

    To permanently delete an IPSet from AWS WAF, perform the following steps:

    1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

    3. Submit a DeleteIPSet request.

    " + }, + "DeleteLoggingConfiguration":{ + "name":"DeleteLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteLoggingConfigurationRequest"}, + "output":{"shape":"DeleteLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"} + ], + "documentation":"

    Permanently deletes the LoggingConfiguration from the specified web ACL.

    " + }, + "DeletePermissionPolicy":{ + "name":"DeletePermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeletePermissionPolicyRequest"}, + "output":{"shape":"DeletePermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Permanently deletes an IAM policy from the specified RuleGroup.

    The user making the request must be the owner of the RuleGroup.

    " + }, + "DeleteRateBasedRule":{ + "name":"DeleteRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRateBasedRuleRequest"}, + "output":{"shape":"DeleteRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

    If you just want to remove a rule from a WebACL, use UpdateWebACL.

    To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

    1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.

    3. Submit a DeleteRateBasedRule request.

    " + }, + "DeleteRegexMatchSet":{ + "name":"DeleteRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegexMatchSetRequest"}, + "output":{"shape":"DeleteRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters).

    If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

    To permanently delete a RegexMatchSet, perform the following steps:

    1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request.

    3. Submit a DeleteRegexMatchSet request.

    " + }, + "DeleteRegexPatternSet":{ + "name":"DeleteRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRegexPatternSetRequest"}, + "output":{"shape":"DeleteRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.

    " + }, + "DeleteRule":{ + "name":"DeleteRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleRequest"}, + "output":{"shape":"DeleteRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

    If you just want to remove a Rule from a WebACL, use UpdateWebACL.

    To permanently delete a Rule from AWS WAF, perform the following steps:

    1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

    3. Submit a DeleteRule request.

    " + }, + "DeleteRuleGroup":{ + "name":"DeleteRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteRuleGroupRequest"}, + "output":{"shape":"DeleteRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

    If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

    To permanently delete a RuleGroup from AWS WAF, perform the following steps:

    1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request.

    3. Submit a DeleteRuleGroup request.

    " + }, + "DeleteSizeConstraintSet":{ + "name":"DeleteSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSizeConstraintSetRequest"}, + "output":{"shape":"DeleteSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

    If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

    To permanently delete a SizeConstraintSet, perform the following steps:

    1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

    3. Submit a DeleteSizeConstraintSet request.

    " + }, + "DeleteSqlInjectionMatchSet":{ + "name":"DeleteSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSqlInjectionMatchSetRequest"}, + "output":{"shape":"DeleteSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

    If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

    To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

    1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

    3. Submit a DeleteSqlInjectionMatchSet request.

    " + }, + "DeleteWebACL":{ + "name":"DeleteWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWebACLRequest"}, + "output":{"shape":"DeleteWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFNonEmptyEntityException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ], + "documentation":"

    Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

    To delete a WebACL, perform the following steps:

    1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

    3. Submit a DeleteWebACL request.

    " + }, + "DeleteXssMatchSet":{ + "name":"DeleteXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteXssMatchSetRequest"}, + "output":{"shape":"DeleteXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonEmptyEntityException"} + ], + "documentation":"

    Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

    If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

    To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

    1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

    3. Submit a DeleteXssMatchSet request.

    " + }, + "GetByteMatchSet":{ + "name":"GetByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetByteMatchSetRequest"}, + "output":{"shape":"GetByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the ByteMatchSet specified by ByteMatchSetId.

    " + }, + "GetChangeToken":{ + "name":"GetChangeToken", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenRequest"}, + "output":{"shape":"GetChangeTokenResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

    Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

    When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

    " + }, + "GetChangeTokenStatus":{ + "name":"GetChangeTokenStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetChangeTokenStatusRequest"}, + "output":{"shape":"GetChangeTokenStatusResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

    • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

    • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

    • INSYNC: Propagation is complete.

    " + }, + "GetGeoMatchSet":{ + "name":"GetGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetGeoMatchSetRequest"}, + "output":{"shape":"GetGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the GeoMatchSet that is specified by GeoMatchSetId.

    " + }, + "GetIPSet":{ + "name":"GetIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetIPSetRequest"}, + "output":{"shape":"GetIPSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the IPSet that is specified by IPSetId.

    " + }, + "GetLoggingConfiguration":{ + "name":"GetLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetLoggingConfigurationRequest"}, + "output":{"shape":"GetLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the LoggingConfiguration for the specified web ACL.

    " + }, + "GetPermissionPolicy":{ + "name":"GetPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetPermissionPolicyRequest"}, + "output":{"shape":"GetPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the IAM policy attached to the RuleGroup.

    " + }, + "GetRateBasedRule":{ + "name":"GetRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRateBasedRuleRequest"}, + "output":{"shape":"GetRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.

    " + }, + "GetRateBasedRuleManagedKeys":{ + "name":"GetRateBasedRuleManagedKeys", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRateBasedRuleManagedKeysRequest"}, + "output":{"shape":"GetRateBasedRuleManagedKeysResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

    " + }, + "GetRegexMatchSet":{ + "name":"GetRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegexMatchSetRequest"}, + "output":{"shape":"GetRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RegexMatchSet specified by RegexMatchSetId.

    " + }, + "GetRegexPatternSet":{ + "name":"GetRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRegexPatternSetRequest"}, + "output":{"shape":"GetRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RegexPatternSet specified by RegexPatternSetId.

    " + }, + "GetRule":{ + "name":"GetRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleRequest"}, + "output":{"shape":"GetRuleResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the Rule that is specified by the RuleId that you included in the GetRule request.

    " + }, + "GetRuleGroup":{ + "name":"GetRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetRuleGroupRequest"}, + "output":{"shape":"GetRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

    To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

    " + }, + "GetSampledRequests":{ + "name":"GetSampledRequests", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSampledRequestsRequest"}, + "output":{"shape":"GetSampledRequestsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

    GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

    " + }, + "GetSizeConstraintSet":{ + "name":"GetSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSizeConstraintSetRequest"}, + "output":{"shape":"GetSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the SizeConstraintSet specified by SizeConstraintSetId.

    " + }, + "GetSqlInjectionMatchSet":{ + "name":"GetSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetSqlInjectionMatchSetRequest"}, + "output":{"shape":"GetSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

    " + }, + "GetWebACL":{ + "name":"GetWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetWebACLRequest"}, + "output":{"shape":"GetWebACLResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the WebACL that is specified by WebACLId.

    " + }, + "GetXssMatchSet":{ + "name":"GetXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetXssMatchSetRequest"}, + "output":{"shape":"GetXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFNonexistentItemException"} + ], + "documentation":"

    Returns the XssMatchSet that is specified by XssMatchSetId.

    " + }, + "ListActivatedRulesInRuleGroup":{ + "name":"ListActivatedRulesInRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListActivatedRulesInRuleGroupRequest"}, + "output":{"shape":"ListActivatedRulesInRuleGroupResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of ActivatedRule objects.

    " + }, + "ListByteMatchSets":{ + "name":"ListByteMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListByteMatchSetsRequest"}, + "output":{"shape":"ListByteMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of ByteMatchSetSummary objects.

    " + }, + "ListGeoMatchSets":{ + "name":"ListGeoMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGeoMatchSetsRequest"}, + "output":{"shape":"ListGeoMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of GeoMatchSetSummary objects in the response.

    " + }, + "ListIPSets":{ + "name":"ListIPSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListIPSetsRequest"}, + "output":{"shape":"ListIPSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of IPSetSummary objects in the response.

    " + }, + "ListLoggingConfigurations":{ + "name":"ListLoggingConfigurations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListLoggingConfigurationsRequest"}, + "output":{"shape":"ListLoggingConfigurationsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Returns an array of LoggingConfiguration objects.

    " + }, + "ListRateBasedRules":{ + "name":"ListRateBasedRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRateBasedRulesRequest"}, + "output":{"shape":"ListRateBasedRulesResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RuleSummary objects.

    " + }, + "ListRegexMatchSets":{ + "name":"ListRegexMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegexMatchSetsRequest"}, + "output":{"shape":"ListRegexMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RegexMatchSetSummary objects.

    " + }, + "ListRegexPatternSets":{ + "name":"ListRegexPatternSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRegexPatternSetsRequest"}, + "output":{"shape":"ListRegexPatternSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RegexPatternSetSummary objects.

    " + }, + "ListRuleGroups":{ + "name":"ListRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRuleGroupsRequest"}, + "output":{"shape":"ListRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns an array of RuleGroup objects.

    " + }, + "ListRules":{ + "name":"ListRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListRulesRequest"}, + "output":{"shape":"ListRulesResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of RuleSummary objects.

    " + }, + "ListSizeConstraintSets":{ + "name":"ListSizeConstraintSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSizeConstraintSetsRequest"}, + "output":{"shape":"ListSizeConstraintSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of SizeConstraintSetSummary objects.

    " + }, + "ListSqlInjectionMatchSets":{ + "name":"ListSqlInjectionMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSqlInjectionMatchSetsRequest"}, + "output":{"shape":"ListSqlInjectionMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of SqlInjectionMatchSet objects.

    " + }, + "ListSubscribedRuleGroups":{ + "name":"ListSubscribedRuleGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSubscribedRuleGroupsRequest"}, + "output":{"shape":"ListSubscribedRuleGroupsResponse"}, + "errors":[ + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInternalErrorException"} + ], + "documentation":"

    Returns an array of RuleGroup objects that you are subscribed to.

    " + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "ListWebACLs":{ + "name":"ListWebACLs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWebACLsRequest"}, + "output":{"shape":"ListWebACLsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of WebACLSummary objects in the response.

    " + }, + "ListXssMatchSets":{ + "name":"ListXssMatchSets", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListXssMatchSetsRequest"}, + "output":{"shape":"ListXssMatchSetsResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Returns an array of XssMatchSet objects.

    " + }, + "PutLoggingConfiguration":{ + "name":"PutLoggingConfiguration", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutLoggingConfigurationRequest"}, + "output":{"shape":"PutLoggingConfigurationResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFServiceLinkedRoleErrorException"} + ], + "documentation":"

    Associates a LoggingConfiguration with a specified web ACL.

    You can access information about all traffic that AWS WAF inspects using the following steps:

    1. Create an Amazon Kinesis Data Firehose.

      Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

      Do not create the data firehose using a Kinesis stream as your source.

    2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

    When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

    " + }, + "PutPermissionPolicy":{ + "name":"PutPermissionPolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutPermissionPolicyRequest"}, + "output":{"shape":"PutPermissionPolicyResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidPermissionPolicyException"} + ], + "documentation":"

    Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

    The PutPermissionPolicy is subject to the following restrictions:

    • You can attach only one policy with each PutPermissionPolicy request.

    • The policy must include an Effect, Action and Principal.

    • Effect must specify Allow.

    • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    • The policy cannot include a Resource parameter.

    • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    • The user making the request must be the owner of the RuleGroup.

    • Your policy must be composed using IAM Policy version 2012-10-17.

    For more information, see IAM Policies.

    An example of a valid policy parameter is shown in the Examples section below.

    " + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFBadRequestException"}, + {"shape":"WAFTagOperationException"}, + {"shape":"WAFTagOperationInternalErrorException"} + ] + }, + "UpdateByteMatchSet":{ + "name":"UpdateByteMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateByteMatchSetRequest"}, + "output":{"shape":"UpdateByteMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

    • Where to look, such as at the beginning or the end of a query string.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

    To create and configure a ByteMatchSet, perform the following steps:

    1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

    3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateGeoMatchSet":{ + "name":"UpdateGeoMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateGeoMatchSetRequest"}, + "output":{"shape":"UpdateGeoMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

    • The Type. The only valid value for Type is Country.

    • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

    To create and configure an GeoMatchSet, perform the following steps:

    1. Submit a CreateGeoMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

    3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

    When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateIPSet":{ + "name":"UpdateIPSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateIPSetRequest"}, + "output":{"shape":"UpdateIPSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

    • The IP address version, IPv4 or IPv6.

    • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

    AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    IPv6 addresses can be represented using any of the following formats:

    • 1111:0000:0000:0000:0000:0000:0000:0111/128

    • 1111:0:0:0:0:0:0:0111/128

    • 1111::0111/128

    • 1111::111/128

    You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

    To create and configure an IPSet, perform the following steps:

    1. Submit a CreateIPSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

    When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

    You can insert a maximum of 1000 addresses in a single request.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRateBasedRule":{ + "name":"UpdateRateBasedRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRateBasedRuleRequest"}, + "output":{"shape":"UpdateRateBasedRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

    Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

    If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

    • An IPSet that matches the IP address 192.0.2.44/32

    • A ByteMatchSet that matches BadBot in the User-Agent header

    Further, you specify a RateLimit of 15,000.

    You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

    As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

    • A ByteMatchSet with FieldToMatch of URI

    • A PositionalConstraint of STARTS_WITH

    • A TargetString of login

    Further, you specify a RateLimit of 15,000.

    By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

    " + }, + "UpdateRegexMatchSet":{ + "name":"UpdateRegexMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRegexMatchSetRequest"}, + "output":{"shape":"UpdateRegexMatchSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFDisallowedNameException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidAccountException"} + ], + "documentation":"

    Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    To create and configure a RegexMatchSet, perform the following steps:

    1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

    3. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRegexPatternSet":{ + "name":"UpdateRegexPatternSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRegexPatternSetRequest"}, + "output":{"shape":"UpdateRegexPatternSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidRegexPatternException"} + ], + "documentation":"

    Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

    • Whether to insert or delete the RegexPatternString.

    • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

    For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

    • BadBot

    • BadB0t

    • B@dBot

    • B@dB0t

    To create and configure a RegexPatternSet, perform the following steps:

    1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

    3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRule":{ + "name":"UpdateRule", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleRequest"}, + "output":{"shape":"UpdateRuleResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

    • A ByteMatchSet that matches the value BadBot in the User-Agent header

    • An IPSet that matches the IP address 192.0.2.44

    You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

    To create and configure a Rule, perform the following steps:

    1. Create and update the predicates that you want to include in the Rule.

    2. Create the Rule. See CreateRule.

    3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

    4. Submit an UpdateRule request to add predicates to the Rule.

    5. Create and update a WebACL that contains the Rule. See CreateWebACL.

    If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateRuleGroup":{ + "name":"UpdateRuleGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRuleGroupRequest"}, + "output":{"shape":"UpdateRuleGroupResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFInvalidParameterException"} + ], + "documentation":"

    Inserts or deletes ActivatedRule objects in a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    You can have a maximum of ten rules per rule group.

    To create and configure a RuleGroup, perform the following steps:

    1. Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.

    3. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

    4. Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

    If you want to replace one Rule with another, you delete the existing one and add the new one.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateSizeConstraintSet":{ + "name":"UpdateSizeConstraintSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSizeConstraintSetRequest"}, + "output":{"shape":"UpdateSizeConstraintSetResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

    • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

    • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

    • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

      You can only specify a single type of TextTransformation.

    • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

    • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

    For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

    To create and configure a SizeConstraintSet, perform the following steps:

    1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

    3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateSqlInjectionMatchSet":{ + "name":"UpdateSqlInjectionMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateSqlInjectionMatchSetRequest"}, + "output":{"shape":"UpdateSqlInjectionMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

    • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

    • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

    • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

      You can only specify a single type of TextTransformation.

    You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

    To create and configure a SqlInjectionMatchSet, perform the following steps:

    1. Submit a CreateSqlInjectionMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateWebACL":{ + "name":"UpdateWebACL", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateWebACLRequest"}, + "output":{"shape":"UpdateWebACLResponse"}, + "errors":[ + {"shape":"WAFStaleDataException"}, + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFReferencedItemException"}, + {"shape":"WAFLimitsExceededException"}, + {"shape":"WAFSubscriptionNotFoundException"} + ], + "documentation":"

    Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

    • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

    • The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

    • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

    • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

    To create and configure a WebACL, perform the following steps:

    1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

    2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

    3. Create a WebACL. See CreateWebACL.

    4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

    5. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

      The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group.

      If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules.

    Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + }, + "UpdateXssMatchSet":{ + "name":"UpdateXssMatchSet", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateXssMatchSetRequest"}, + "output":{"shape":"UpdateXssMatchSetResponse"}, + "errors":[ + {"shape":"WAFInternalErrorException"}, + {"shape":"WAFInvalidAccountException"}, + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFInvalidParameterException"}, + {"shape":"WAFNonexistentContainerException"}, + {"shape":"WAFNonexistentItemException"}, + {"shape":"WAFStaleDataException"}, + {"shape":"WAFLimitsExceededException"} + ], + "documentation":"

    Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

    • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

    • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

    • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

      You can only specify a single type of TextTransformation.

    You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

    To create and configure an XssMatchSet, perform the following steps:

    1. Submit a CreateXssMatchSet request.

    2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

    3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

    For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

    " + } + }, + "shapes":{ + "Action":{"type":"string"}, + "ActivatedRule":{ + "type":"structure", + "required":[ + "Priority", + "RuleId" + ], + "members":{ + "Priority":{ + "shape":"RulePriority", + "documentation":"

    Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

    " + }, + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Action":{ + "shape":"WafAction", + "documentation":"

    Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

    • ALLOW: CloudFront responds with the requested object.

    • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

    • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "OverrideAction":{ + "shape":"WafOverrideAction", + "documentation":"

    Use the OverrideAction to test your RuleGroup.

    Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "Type":{ + "shape":"WafRuleType", + "documentation":"

    The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

    " + }, + "ExcludedRules":{ + "shape":"ExcludedRules", + "documentation":"

    An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

    Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

    Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

    If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

    1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

    2. Submit an UpdateWebACL request that has two actions:

      • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

      • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

    " + } + }, + "documentation":"

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type.

    " + }, + "ActivatedRules":{ + "type":"list", + "member":{"shape":"ActivatedRule"} + }, + "ByteMatchSet":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ByteMatchTuples" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + }, + "ByteMatchTuples":{ + "shape":"ByteMatchTuples", + "documentation":"

    Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    " + } + }, + "documentation":"

    In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you specified when you updated the ByteMatchSet.

    A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

    " + }, + "ByteMatchSetSummaries":{ + "type":"list", + "member":{"shape":"ByteMatchSetSummary"} + }, + "ByteMatchSetSummary":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "Name" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

    ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + } + }, + "documentation":"

    Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet.

    " + }, + "ByteMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "ByteMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a ByteMatchTuple.

    " + }, + "ByteMatchTuple":{ + "shape":"ByteMatchTuple", + "documentation":"

    Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

    " + } + }, + "documentation":"

    In an UpdateByteMatchSet request, ByteMatchSetUpdate specifies whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple.

    " + }, + "ByteMatchSetUpdates":{ + "type":"list", + "member":{"shape":"ByteMatchSetUpdate"}, + "min":1 + }, + "ByteMatchTargetString":{"type":"blob"}, + "ByteMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TargetString", + "TextTransformation", + "PositionalConstraint" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

    " + }, + "TargetString":{ + "shape":"ByteMatchTargetString", + "documentation":"

    The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

    Valid values depend on the values that you specified for FieldToMatch:

    • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

    • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

    • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

    If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.

    If you're using the AWS WAF API

    Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.

    For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString.

    If you're using the AWS CLI or one of the AWS SDKs

    The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + }, + "PositionalConstraint":{ + "shape":"PositionalConstraint", + "documentation":"

    Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

    CONTAINS

    The specified part of the web request must include the value of TargetString, but the location doesn't matter.

    CONTAINS_WORD

    The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following:

    • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

    • TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;.

    • TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot.

    • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.

    EXACTLY

    The value of the specified part of the web request must exactly match the value of TargetString.

    STARTS_WITH

    The value of TargetString must appear at the beginning of the specified part of the web request.

    ENDS_WITH

    The value of TargetString must appear at the end of the specified part of the web request.

    " + } + }, + "documentation":"

    The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

    " + }, + "ByteMatchTuples":{ + "type":"list", + "member":{"shape":"ByteMatchTuple"} + }, + "ChangeAction":{ + "type":"string", + "enum":[ + "INSERT", + "DELETE" + ] + }, + "ChangeToken":{ + "type":"string", + "min":1 + }, + "ChangeTokenStatus":{ + "type":"string", + "enum":[ + "PROVISIONED", + "PENDING", + "INSYNC" + ] + }, + "ComparisonOperator":{ + "type":"string", + "enum":[ + "EQ", + "NE", + "LE", + "LT", + "GE", + "GT" + ] + }, + "Country":{"type":"string"}, + "CreateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{ + "shape":"ByteMatchSet", + "documentation":"

    A ByteMatchSet that contains no ByteMatchTuple objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "GeoMatchSet":{ + "shape":"GeoMatchSet", + "documentation":"

    The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateIPSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{ + "shape":"IPSet", + "documentation":"

    The IPSet returned in the CreateIPSet response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "RateKey", + "RateLimit", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule.

    " + }, + "RateKey":{ + "shape":"RateKey", + "documentation":"

    The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"RateBasedRule", + "documentation":"

    The RateBasedRule that is returned in the CreateRateBasedRule response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "RegexMatchSet":{ + "shape":"RegexMatchSet", + "documentation":"

    A RegexMatchSet that contains no RegexMatchTuple objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "RegexPatternSet":{ + "shape":"RegexPatternSet", + "documentation":"

    A RegexPatternSet that contains no objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRuleGroupRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRuleGroupResponse":{ + "type":"structure", + "members":{ + "RuleGroup":{ + "shape":"RuleGroup", + "documentation":"

    An empty RuleGroup.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateRuleRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the Rule.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"Rule", + "documentation":"

    The Rule returned in the CreateRule response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "CreateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{ + "shape":"SizeConstraintSet", + "documentation":"

    A SizeConstraintSet that contains no SizeConstraint objects.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to create a SqlInjectionMatchSet.

    " + }, + "CreateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{ + "shape":"SqlInjectionMatchSet", + "documentation":"

    A SqlInjectionMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a CreateSqlInjectionMatchSet request.

    " + }, + "CreateWebACLRequest":{ + "type":"structure", + "required":[ + "Name", + "MetricName", + "DefaultAction", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Tags":{"shape":"TagList"} + } + }, + "CreateWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{ + "shape":"WebACL", + "documentation":"

    The WebACL returned in the CreateWebACL response.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "CreateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "Name", + "ChangeToken" + ], + "members":{ + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to create an XssMatchSet.

    " + }, + "CreateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{ + "shape":"XssMatchSet", + "documentation":"

    An XssMatchSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a CreateXssMatchSet request.

    " + }, + "DeleteByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "ChangeToken" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteLoggingConfigurationRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

    " + } + } + }, + "DeleteLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeletePermissionPolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.

    The user making the request must be the owner of the RuleGroup.

    " + } + } + }, + "DeletePermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "ChangeToken" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "ChangeToken" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRuleGroupRequest":{ + "type":"structure", + "required":[ + "RuleGroupId", + "ChangeToken" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRuleGroupResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to delete a SqlInjectionMatchSet from AWS WAF.

    " + }, + "DeleteSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a request to delete a SqlInjectionMatchSet from AWS WAF.

    " + }, + "DeleteWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "DeleteWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "DeleteXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + }, + "documentation":"

    A request to delete an XssMatchSet from AWS WAF.

    " + }, + "DeleteXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to a request to delete an XssMatchSet from AWS WAF.

    " + }, + "ExcludedRule":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The unique identifier for the rule to exclude from the rule group.

    " + } + }, + "documentation":"

    The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is specified by the ActivatedRule.

    " + }, + "ExcludedRules":{ + "type":"list", + "member":{"shape":"ExcludedRule"} + }, + "FieldToMatch":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"MatchFieldType", + "documentation":"

    The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

    • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

    • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

    • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

    • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

    • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

    • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

    " + }, + "Data":{ + "shape":"MatchFieldData", + "documentation":"

    When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

    When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

    If the value of Type is any other value, omit Data.

    " + } + }, + "documentation":"

    Specifies where in a web request to look for TargetString.

    " + }, + "GeoMatchConstraint":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"GeoMatchConstraintType", + "documentation":"

    The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

    " + }, + "Value":{ + "shape":"GeoMatchConstraintValue", + "documentation":"

    The country that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    The country from which web requests originate that you want AWS WAF to search for.

    " + }, + "GeoMatchConstraintType":{ + "type":"string", + "enum":["Country"] + }, + "GeoMatchConstraintValue":{ + "type":"string", + "enum":[ + "AF", + "AX", + "AL", + "DZ", + "AS", + "AD", + "AO", + "AI", + "AQ", + "AG", + "AR", + "AM", + "AW", + "AU", + "AT", + "AZ", + "BS", + "BH", + "BD", + "BB", + "BY", + "BE", + "BZ", + "BJ", + "BM", + "BT", + "BO", + "BQ", + "BA", + "BW", + "BV", + "BR", + "IO", + "BN", + "BG", + "BF", + "BI", + "KH", + "CM", + "CA", + "CV", + "KY", + "CF", + "TD", + "CL", + "CN", + "CX", + "CC", + "CO", + "KM", + "CG", + "CD", + "CK", + "CR", + "CI", + "HR", + "CU", + "CW", + "CY", + "CZ", + "DK", + "DJ", + "DM", + "DO", + "EC", + "EG", + "SV", + "GQ", + "ER", + "EE", + "ET", + "FK", + "FO", + "FJ", + "FI", + "FR", + "GF", + "PF", + "TF", + "GA", + "GM", + "GE", + "DE", + "GH", + "GI", + "GR", + "GL", + "GD", + "GP", + "GU", + "GT", + "GG", + "GN", + "GW", + "GY", + "HT", + "HM", + "VA", + "HN", + "HK", + "HU", + "IS", + "IN", + "ID", + "IR", + "IQ", + "IE", + "IM", + "IL", + "IT", + "JM", + "JP", + "JE", + "JO", + "KZ", + "KE", + "KI", + "KP", + "KR", + "KW", + "KG", + "LA", + "LV", + "LB", + "LS", + "LR", + "LY", + "LI", + "LT", + "LU", + "MO", + "MK", + "MG", + "MW", + "MY", + "MV", + "ML", + "MT", + "MH", + "MQ", + "MR", + "MU", + "YT", + "MX", + "FM", + "MD", + "MC", + "MN", + "ME", + "MS", + "MA", + "MZ", + "MM", + "NA", + "NR", + "NP", + "NL", + "NC", + "NZ", + "NI", + "NE", + "NG", + "NU", + "NF", + "MP", + "NO", + "OM", + "PK", + "PW", + "PS", + "PA", + "PG", + "PY", + "PE", + "PH", + "PN", + "PL", + "PT", + "PR", + "QA", + "RE", + "RO", + "RU", + "RW", + "BL", + "SH", + "KN", + "LC", + "MF", + "PM", + "VC", + "WS", + "SM", + "ST", + "SA", + "SN", + "RS", + "SC", + "SL", + "SG", + "SX", + "SK", + "SI", + "SB", + "SO", + "ZA", + "GS", + "SS", + "ES", + "LK", + "SD", + "SR", + "SJ", + "SZ", + "SE", + "CH", + "SY", + "TW", + "TJ", + "TZ", + "TH", + "TL", + "TG", + "TK", + "TO", + "TT", + "TN", + "TR", + "TM", + "TC", + "TV", + "UG", + "UA", + "AE", + "GB", + "US", + "UM", + "UY", + "UZ", + "VU", + "VE", + "VN", + "VG", + "VI", + "WF", + "EH", + "YE", + "ZM", + "ZW" + ] + }, + "GeoMatchConstraints":{ + "type":"list", + "member":{"shape":"GeoMatchConstraint"} + }, + "GeoMatchSet":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "GeoMatchConstraints" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet).

    GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    " + }, + "GeoMatchConstraints":{ + "shape":"GeoMatchConstraints", + "documentation":"

    An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    Contains one or more countries that AWS WAF will search for.

    " + }, + "GeoMatchSetSummaries":{ + "type":"list", + "member":{"shape":"GeoMatchSetSummary"} + }, + "GeoMatchSetSummary":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "Name" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name of the GeoMatchSet.

    " + }, + "GeoMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "GeoMatchConstraint" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a country with UpdateGeoMatchSet.

    " + }, + "GeoMatchConstraint":{ + "shape":"GeoMatchConstraint", + "documentation":"

    The country from which web requests originate that you want AWS WAF to search for.

    " + } + }, + "documentation":"

    Specifies the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet.

    " + }, + "GeoMatchSetUpdates":{ + "type":"list", + "member":{"shape":"GeoMatchSetUpdate"}, + "min":1 + }, + "GetByteMatchSetRequest":{ + "type":"structure", + "required":["ByteMatchSetId"], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + } + } + }, + "GetByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ByteMatchSet":{ + "shape":"ByteMatchSet", + "documentation":"

    Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

    • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

    • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

    • FieldToMatch: Contains Data and Type

    " + } + } + }, + "GetChangeTokenRequest":{ + "type":"structure", + "members":{ + } + }, + "GetChangeTokenResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

    " + } + } + }, + "GetChangeTokenStatusRequest":{ + "type":"structure", + "required":["ChangeToken"], + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

    " + } + } + }, + "GetChangeTokenStatusResponse":{ + "type":"structure", + "members":{ + "ChangeTokenStatus":{ + "shape":"ChangeTokenStatus", + "documentation":"

    The status of the change token.

    " + } + } + }, + "GetGeoMatchSetRequest":{ + "type":"structure", + "required":["GeoMatchSetId"], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + } + } + }, + "GetGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "GeoMatchSet":{ + "shape":"GeoMatchSet", + "documentation":"

    Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.

    " + } + } + }, + "GetIPSetRequest":{ + "type":"structure", + "required":["IPSetId"], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + } + } + }, + "GetIPSetResponse":{ + "type":"structure", + "members":{ + "IPSet":{ + "shape":"IPSet", + "documentation":"

    Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

    • IPSet: Contains IPSetDescriptors, IPSetId, and Name

    • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

    " + } + } + }, + "GetLoggingConfigurationRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

    " + } + } + }, + "GetLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The LoggingConfiguration for the specified web ACL.

    " + } + } + }, + "GetPermissionPolicyRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.

    " + } + } + }, + "GetPermissionPolicyResponse":{ + "type":"structure", + "members":{ + "Policy":{ + "shape":"PolicyString", + "documentation":"

    The IAM policy attached to the specified RuleGroup.

    " + } + } + }, + "GetRateBasedRuleManagedKeysRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    A null value and not currently used. Do not include this in your request.

    " + } + } + }, + "GetRateBasedRuleManagedKeysResponse":{ + "type":"structure", + "members":{ + "ManagedKeys":{ + "shape":"ManagedKeys", + "documentation":"

    An array of IP addresses that currently are blocked by the specified RateBasedRule.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    A null value and not currently used.

    " + } + } + }, + "GetRateBasedRuleRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + } + } + }, + "GetRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"RateBasedRule", + "documentation":"

    Information about the RateBasedRule that you specified in the GetRateBasedRule request.

    " + } + } + }, + "GetRegexMatchSetRequest":{ + "type":"structure", + "required":["RegexMatchSetId"], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + } + } + }, + "GetRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "RegexMatchSet":{ + "shape":"RegexMatchSet", + "documentation":"

    Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

    " + } + } + }, + "GetRegexPatternSetRequest":{ + "type":"structure", + "required":["RegexPatternSetId"], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + } + } + }, + "GetRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "RegexPatternSet":{ + "shape":"RegexPatternSet", + "documentation":"

    Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

    " + } + } + }, + "GetRuleGroupRequest":{ + "type":"structure", + "required":["RuleGroupId"], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + } + } + }, + "GetRuleGroupResponse":{ + "type":"structure", + "members":{ + "RuleGroup":{ + "shape":"RuleGroup", + "documentation":"

    Information about the RuleGroup that you specified in the GetRuleGroup request.

    " + } + } + }, + "GetRuleRequest":{ + "type":"structure", + "required":["RuleId"], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

    " + } + } + }, + "GetRuleResponse":{ + "type":"structure", + "members":{ + "Rule":{ + "shape":"Rule", + "documentation":"

    Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

    • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

    • Predicate: Each Predicate object contains DataId, Negated, and Type

    " + } + } + }, + "GetSampledRequestsMaxItems":{ + "type":"long", + "max":500, + "min":1 + }, + "GetSampledRequestsRequest":{ + "type":"structure", + "required":[ + "WebAclId", + "RuleId", + "TimeWindow", + "MaxItems" + ], + "members":{ + "WebAclId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    " + }, + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    RuleId is one of three values:

    • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

    • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

    " + }, + "TimeWindow":{ + "shape":"TimeWindow", + "documentation":"

    The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + }, + "MaxItems":{ + "shape":"GetSampledRequestsMaxItems", + "documentation":"

    The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

    " + } + } + }, + "GetSampledRequestsResponse":{ + "type":"structure", + "members":{ + "SampledRequests":{ + "shape":"SampledHTTPRequests", + "documentation":"

    A complex type that contains detailed information about each of the requests in the sample.

    " + }, + "PopulationSize":{ + "shape":"PopulationSize", + "documentation":"

    The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

    " + }, + "TimeWindow":{ + "shape":"TimeWindow", + "documentation":"

    Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

    " + } + } + }, + "GetSizeConstraintSetRequest":{ + "type":"structure", + "required":["SizeConstraintSetId"], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + } + } + }, + "GetSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "SizeConstraintSet":{ + "shape":"SizeConstraintSet", + "documentation":"

    Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

    " + } + } + }, + "GetSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":["SqlInjectionMatchSetId"], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + } + }, + "documentation":"

    A request to get a SqlInjectionMatchSet.

    " + }, + "GetSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "SqlInjectionMatchSet":{ + "shape":"SqlInjectionMatchSet", + "documentation":"

    Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

    " + } + }, + "documentation":"

    The response to a GetSqlInjectionMatchSet request.

    " + }, + "GetWebACLRequest":{ + "type":"structure", + "required":["WebACLId"], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + } + } + }, + "GetWebACLResponse":{ + "type":"structure", + "members":{ + "WebACL":{ + "shape":"WebACL", + "documentation":"

    Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

    • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

    • DefaultAction (Data type is WafAction): Contains Type

    • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

    • Action: Contains Type

    " + } + } + }, + "GetXssMatchSetRequest":{ + "type":"structure", + "required":["XssMatchSetId"], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + } + }, + "documentation":"

    A request to get an XssMatchSet.

    " + }, + "GetXssMatchSetResponse":{ + "type":"structure", + "members":{ + "XssMatchSet":{ + "shape":"XssMatchSet", + "documentation":"

    Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

    • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

    • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

    • FieldToMatch: Contains Data and Type

    " + } + }, + "documentation":"

    The response to a GetXssMatchSet request.

    " + }, + "HTTPHeader":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"HeaderName", + "documentation":"

    The name of one of the headers in the sampled web request.

    " + }, + "Value":{ + "shape":"HeaderValue", + "documentation":"

    The value of one of the headers in the sampled web request.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests.

    " + }, + "HTTPHeaders":{ + "type":"list", + "member":{"shape":"HTTPHeader"} + }, + "HTTPMethod":{"type":"string"}, + "HTTPRequest":{ + "type":"structure", + "members":{ + "ClientIP":{ + "shape":"IPString", + "documentation":"

    The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

    • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

    • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

    " + }, + "Country":{ + "shape":"Country", + "documentation":"

    The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

    " + }, + "URI":{ + "shape":"URIString", + "documentation":"

    The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

    " + }, + "Method":{ + "shape":"HTTPMethod", + "documentation":"

    The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

    " + }, + "HTTPVersion":{ + "shape":"HTTPVersion", + "documentation":"

    The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    " + }, + "Headers":{ + "shape":"HTTPHeaders", + "documentation":"

    A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

    " + }, + "HTTPVersion":{"type":"string"}, + "HeaderName":{"type":"string"}, + "HeaderValue":{"type":"string"}, + "IPSet":{ + "type":"structure", + "required":[ + "IPSetId", + "IPSetDescriptors" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

    IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    " + }, + "IPSetDescriptors":{ + "shape":"IPSetDescriptors", + "documentation":"

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

    " + } + }, + "documentation":"

    Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128.

    To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    " + }, + "IPSetDescriptor":{ + "type":"structure", + "required":[ + "Type", + "Value" + ], + "members":{ + "Type":{ + "shape":"IPSetDescriptorType", + "documentation":"

    Specify IPV4 or IPV6.

    " + }, + "Value":{ + "shape":"IPSetDescriptorValue", + "documentation":"

    Specify an IPv4 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

    Specify an IPv6 address by using CIDR notation. For example:

    • To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.

    • To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.

    " + } + }, + "documentation":"

    Specifies the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from.

    " + }, + "IPSetDescriptorType":{ + "type":"string", + "enum":[ + "IPV4", + "IPV6" + ] + }, + "IPSetDescriptorValue":{"type":"string"}, + "IPSetDescriptors":{ + "type":"list", + "member":{"shape":"IPSetDescriptor"} + }, + "IPSetSummaries":{ + "type":"list", + "member":{"shape":"IPSetSummary"} + }, + "IPSetSummary":{ + "type":"structure", + "required":[ + "IPSetId", + "Name" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name of the IPSet.

    " + }, + "IPSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "IPSetDescriptor" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete an IP address with UpdateIPSet.

    " + }, + "IPSetDescriptor":{ + "shape":"IPSetDescriptor", + "documentation":"

    The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

    " + } + }, + "documentation":"

    Specifies the type of update to perform to an IPSet with UpdateIPSet.

    " + }, + "IPSetUpdates":{ + "type":"list", + "member":{"shape":"IPSetUpdate"}, + "min":1 + }, + "IPString":{"type":"string"}, + "ListActivatedRulesInRuleGroupRequest":{ + "type":"structure", + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

    " + } + } + }, + "ListActivatedRulesInRuleGroupResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "ActivatedRules":{ + "shape":"ActivatedRules", + "documentation":"

    An array of ActivatedRules objects.

    " + } + } + }, + "ListByteMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.

    " + } + } + }, + "ListByteMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "ByteMatchSets":{ + "shape":"ByteMatchSetSummaries", + "documentation":"

    An array of ByteMatchSetSummary objects.

    " + } + } + }, + "ListGeoMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.

    " + } + } + }, + "ListGeoMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "GeoMatchSets":{ + "shape":"GeoMatchSetSummaries", + "documentation":"

    An array of GeoMatchSetSummary objects.

    " + } + } + }, + "ListIPSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.

    " + } + } + }, + "ListIPSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.

    " + }, + "IPSets":{ + "shape":"IPSetSummaries", + "documentation":"

    An array of IPSetSummary objects.

    " + } + } + }, + "ListLoggingConfigurationsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

    " + } + } + }, + "ListLoggingConfigurationsResponse":{ + "type":"structure", + "members":{ + "LoggingConfigurations":{ + "shape":"LoggingConfigurations", + "documentation":"

    An array of LoggingConfiguration objects.

    " + }, + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + } + } + }, + "ListRateBasedRulesRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + } + }, + "ListRateBasedRulesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "Rules":{ + "shape":"RuleSummaries", + "documentation":"

    An array of RuleSummary objects.

    " + } + } + }, + "ListRegexMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.

    " + } + } + }, + "ListRegexMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RegexMatchSets":{ + "shape":"RegexMatchSetSummaries", + "documentation":"

    An array of RegexMatchSetSummary objects.

    " + } + } + }, + "ListRegexPatternSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.

    " + } + } + }, + "ListRegexPatternSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RegexPatternSets":{ + "shape":"RegexPatternSetSummaries", + "documentation":"

    An array of RegexPatternSetSummary objects.

    " + } + } + }, + "ListRuleGroupsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

    " + } + } + }, + "ListRuleGroupsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RuleGroups":{ + "shape":"RuleGroupSummaries", + "documentation":"

    An array of RuleGroup objects.

    " + } + } + }, + "ListRulesRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + } + }, + "ListRulesResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "Rules":{ + "shape":"RuleSummaries", + "documentation":"

    An array of RuleSummary objects.

    " + } + } + }, + "ListSizeConstraintSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.

    " + } + } + }, + "ListSizeConstraintSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "SizeConstraintSets":{ + "shape":"SizeConstraintSetSummaries", + "documentation":"

    An array of SizeConstraintSetSummary objects.

    " + } + } + }, + "ListSqlInjectionMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + }, + "documentation":"

    A request to list the SqlInjectionMatchSet objects created by the current AWS account.

    " + }, + "ListSqlInjectionMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "SqlInjectionMatchSets":{ + "shape":"SqlInjectionMatchSetSummaries", + "documentation":"

    An array of SqlInjectionMatchSetSummary objects.

    " + } + }, + "documentation":"

    The response to a ListSqlInjectionMatchSets request.

    " + }, + "ListSubscribedRuleGroupsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.

    " + } + } + }, + "ListSubscribedRuleGroupsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "RuleGroups":{ + "shape":"SubscribedRuleGroupSummaries", + "documentation":"

    An array of RuleGroup objects.

    " + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceARN"], + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "Limit":{"shape":"PaginationLimit"}, + "ResourceARN":{"shape":"ResourceArn"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "NextMarker":{"shape":"NextMarker"}, + "TagInfoForResource":{"shape":"TagInfoForResource"} + } + }, + "ListWebACLsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.

    " + } + } + }, + "ListWebACLsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "WebACLs":{ + "shape":"WebACLSummaries", + "documentation":"

    An array of WebACLSummary objects.

    " + } + } + }, + "ListXssMatchSetsRequest":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    " + }, + "Limit":{ + "shape":"PaginationLimit", + "documentation":"

    Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

    " + } + }, + "documentation":"

    A request to list the XssMatchSet objects created by the current AWS account.

    " + }, + "ListXssMatchSetsResponse":{ + "type":"structure", + "members":{ + "NextMarker":{ + "shape":"NextMarker", + "documentation":"

    If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    " + }, + "XssMatchSets":{ + "shape":"XssMatchSetSummaries", + "documentation":"

    An array of XssMatchSetSummary objects.

    " + } + }, + "documentation":"

    The response to a ListXssMatchSets request.

    " + }, + "LogDestinationConfigs":{ + "type":"list", + "member":{"shape":"ResourceArn"}, + "max":1, + "min":1 + }, + "LoggingConfiguration":{ + "type":"structure", + "required":[ + "ResourceArn", + "LogDestinationConfigs" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

    " + }, + "LogDestinationConfigs":{ + "shape":"LogDestinationConfigs", + "documentation":"

    An array of Amazon Kinesis Data Firehose ARNs.

    " + }, + "RedactedFields":{ + "shape":"RedactedFields", + "documentation":"

    The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

    " + } + }, + "documentation":"

    The Amazon Kinesis Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN).

    " + }, + "LoggingConfigurations":{ + "type":"list", + "member":{"shape":"LoggingConfiguration"} + }, + "ManagedKey":{"type":"string"}, + "ManagedKeys":{ + "type":"list", + "member":{"shape":"ManagedKey"} + }, + "MatchFieldData":{"type":"string"}, + "MatchFieldType":{ + "type":"string", + "enum":[ + "URI", + "QUERY_STRING", + "HEADER", + "METHOD", + "BODY", + "SINGLE_QUERY_ARG", + "ALL_QUERY_ARGS" + ] + }, + "MetricName":{"type":"string"}, + "Negated":{"type":"boolean"}, + "NextMarker":{ + "type":"string", + "min":1 + }, + "PaginationLimit":{ + "type":"integer", + "max":100, + "min":0 + }, + "ParameterExceptionField":{ + "type":"string", + "enum":[ + "CHANGE_ACTION", + "WAF_ACTION", + "WAF_OVERRIDE_ACTION", + "PREDICATE_TYPE", + "IPSET_TYPE", + "BYTE_MATCH_FIELD_TYPE", + "SQL_INJECTION_MATCH_FIELD_TYPE", + "BYTE_MATCH_TEXT_TRANSFORMATION", + "BYTE_MATCH_POSITIONAL_CONSTRAINT", + "SIZE_CONSTRAINT_COMPARISON_OPERATOR", + "GEO_MATCH_LOCATION_TYPE", + "GEO_MATCH_LOCATION_VALUE", + "RATE_KEY", + "RULE_TYPE", + "NEXT_MARKER", + "RESOURCE_ARN", + "TAGS", + "TAG_KEYS" + ] + }, + "ParameterExceptionParameter":{ + "type":"string", + "min":1 + }, + "ParameterExceptionReason":{ + "type":"string", + "enum":[ + "INVALID_OPTION", + "ILLEGAL_COMBINATION", + "ILLEGAL_ARGUMENT", + "INVALID_TAG_KEY" + ] + }, + "PolicyString":{ + "type":"string", + "min":1 + }, + "PopulationSize":{"type":"long"}, + "PositionalConstraint":{ + "type":"string", + "enum":[ + "EXACTLY", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "CONTAINS_WORD" + ] + }, + "Predicate":{ + "type":"structure", + "required":[ + "Negated", + "Type", + "DataId" + ], + "members":{ + "Negated":{ + "shape":"Negated", + "documentation":"

    Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

    Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

    " + }, + "Type":{ + "shape":"PredicateType", + "documentation":"

    The type of predicate in a Rule, such as ByteMatch or IPSet.

    " + }, + "DataId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

    " + } + }, + "documentation":"

    Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

    " + }, + "PredicateType":{ + "type":"string", + "enum":[ + "IPMatch", + "ByteMatch", + "SqlInjectionMatch", + "GeoMatch", + "SizeConstraint", + "XssMatch", + "RegexMatch" + ] + }, + "Predicates":{ + "type":"list", + "member":{"shape":"Predicate"} + }, + "PutLoggingConfigurationRequest":{ + "type":"structure", + "required":["LoggingConfiguration"], + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.

    When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.

    " + } + } + }, + "PutLoggingConfigurationResponse":{ + "type":"structure", + "members":{ + "LoggingConfiguration":{ + "shape":"LoggingConfiguration", + "documentation":"

    The LoggingConfiguration that you submitted in the request.

    " + } + } + }, + "PutPermissionPolicyRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Policy" + ], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

    The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    " + }, + "Policy":{ + "shape":"PolicyString", + "documentation":"

    The policy to attach to the specified RuleGroup.

    " + } + } + }, + "PutPermissionPolicyResponse":{ + "type":"structure", + "members":{ + } + }, + "RateBasedRule":{ + "type":"structure", + "required":[ + "RuleId", + "MatchPredicates", + "RateKey", + "RateLimit" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RateBasedRule.

    " + }, + "MatchPredicates":{ + "shape":"Predicates", + "documentation":"

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

    " + }, + "RateKey":{ + "shape":"RateKey", + "documentation":"

    The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + } + }, + "documentation":"

    A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a specified IP address every five minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions:

    • The requests come from 192.0.2.44.

    • They contain the value BadBot in the User-Agent header.

    In the rule, you also define the rate limit as 15,000.

    Requests that meet both of these conditions and exceed 15,000 requests every five minutes trigger the rule's action (block or count), which is defined in the web ACL.

    " + }, + "RateKey":{ + "type":"string", + "enum":["IP"] + }, + "RateLimit":{ + "type":"long", + "max":2000000000, + "min":100 + }, + "RedactedFields":{ + "type":"list", + "member":{"shape":"FieldToMatch"} + }, + "RegexMatchSet":{ + "type":"structure", + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + }, + "RegexMatchTuples":{ + "shape":"RegexMatchTuples", + "documentation":"

    Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    " + } + }, + "documentation":"

    In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you specified when you updated the RegexMatchSet.

    The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match.

    " + }, + "RegexMatchSetSummaries":{ + "type":"list", + "member":{"shape":"RegexMatchSetSummary"} + }, + "RegexMatchSetSummary":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "Name" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    " + } + }, + "documentation":"

    Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet.

    " + }, + "RegexMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "RegexMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a RegexMatchTuple.

    " + }, + "RegexMatchTuple":{ + "shape":"RegexMatchTuple", + "documentation":"

    Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

    " + } + }, + "documentation":"

    In an UpdateRegexMatchSet request, RegexMatchSetUpdate specifies whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple.

    " + }, + "RegexMatchSetUpdates":{ + "type":"list", + "member":{"shape":"RegexMatchSetUpdate"}, + "min":1 + }, + "RegexMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation", + "RegexPatternSetId" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for the RegexPatternSet.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + }, + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + } + }, + "documentation":"

    The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains:

    • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

    • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

    • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

    " + }, + "RegexMatchTuples":{ + "type":"list", + "member":{"shape":"RegexMatchTuple"} + }, + "RegexPatternSet":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "RegexPatternStrings" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + }, + "RegexPatternStrings":{ + "shape":"RegexPatternStrings", + "documentation":"

    Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    " + } + }, + "documentation":"

    The RegexPatternSet specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

    " + }, + "RegexPatternSetSummaries":{ + "type":"list", + "member":{"shape":"RegexPatternSetSummary"} + }, + "RegexPatternSetSummary":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "Name" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

    RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    " + } + }, + "documentation":"

    Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet.

    " + }, + "RegexPatternSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "RegexPatternString" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert or delete a RegexPatternString.

    " + }, + "RegexPatternString":{ + "shape":"RegexPatternString", + "documentation":"

    Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    " + } + }, + "documentation":"

    In an UpdateRegexPatternSet request, RegexPatternSetUpdate specifies whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString.

    " + }, + "RegexPatternSetUpdates":{ + "type":"list", + "member":{"shape":"RegexPatternSetUpdate"}, + "min":1 + }, + "RegexPatternString":{ + "type":"string", + "min":1 + }, + "RegexPatternStrings":{ + "type":"list", + "member":{"shape":"RegexPatternString"}, + "max":10 + }, + "ResourceArn":{ + "type":"string", + "max":1224, + "min":1 + }, + "ResourceId":{ + "type":"string", + "max":128, + "min":1 + }, + "ResourceName":{ + "type":"string", + "max":128, + "min":1 + }, + "Rule":{ + "type":"structure", + "required":[ + "RuleId", + "Predicates" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the Rule.

    " + }, + "Predicates":{ + "shape":"Predicates", + "documentation":"

    The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

    " + } + }, + "documentation":"

    A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates:

    • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44

    • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot.

    To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot.

    " + }, + "RuleGroup":{ + "type":"structure", + "required":["RuleGroupId"], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + } + }, + "documentation":"

    A collection of predefined rules that you can add to a web ACL.

    Rule groups are subject to the following limits:

    • Three rule groups per account. You can request an increase to this limit by contacting customer support.

    • One rule group per web ACL.

    • Ten rules per rule group.

    " + }, + "RuleGroupSummaries":{ + "type":"list", + "member":{"shape":"RuleGroupSummary"} + }, + "RuleGroupSummary":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Name" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

    RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the friendly name or description of the RuleGroup.

    " + }, + "RuleGroupUpdate":{ + "type":"structure", + "required":[ + "Action", + "ActivatedRule" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.

    " + }, + "ActivatedRule":{ + "shape":"ActivatedRule", + "documentation":"

    The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    " + } + }, + "documentation":"

    Specifies an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup.

    " + }, + "RuleGroupUpdates":{ + "type":"list", + "member":{"shape":"RuleGroupUpdate"}, + "min":1 + }, + "RulePriority":{"type":"integer"}, + "RuleSummaries":{ + "type":"list", + "member":{"shape":"RuleSummary"} + }, + "RuleSummary":{ + "type":"structure", + "required":[ + "RuleId", + "Name" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

    RuleId is returned by CreateRule and by ListRules.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the friendly name or description of the Rule.

    " + }, + "RuleUpdate":{ + "type":"structure", + "required":[ + "Action", + "Predicate" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

    " + }, + "Predicate":{ + "shape":"Predicate", + "documentation":"

    The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

    " + } + }, + "documentation":"

    Specifies a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule.

    " + }, + "RuleUpdates":{ + "type":"list", + "member":{"shape":"RuleUpdate"} + }, + "SampleWeight":{ + "type":"long", + "min":0 + }, + "SampledHTTPRequest":{ + "type":"structure", + "required":[ + "Request", + "Weight" + ], + "members":{ + "Request":{ + "shape":"HTTPRequest", + "documentation":"

    A complex type that contains detailed information about the request.

    " + }, + "Weight":{ + "shape":"SampleWeight", + "documentation":"

    A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.

    " + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

    " + }, + "Action":{ + "shape":"Action", + "documentation":"

    The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

    " + }, + "RuleWithinRuleGroup":{ + "shape":"ResourceId", + "documentation":"

    This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

    " + } + }, + "documentation":"

    The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests.

    " + }, + "SampledHTTPRequests":{ + "type":"list", + "member":{"shape":"SampledHTTPRequest"} + }, + "Size":{ + "type":"long", + "max":21474836480, + "min":0 + }, + "SizeConstraint":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation", + "ComparisonOperator", + "Size" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for the size constraint.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    " + }, + "ComparisonOperator":{ + "shape":"ComparisonOperator", + "documentation":"

    The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    EQ: Used to test if the Size is equal to the size of the FieldToMatch

    NE: Used to test if the Size is not equal to the size of the FieldToMatch

    LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

    LT: Used to test if the Size is strictly less than the size of the FieldToMatch

    GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

    GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

    " + }, + "Size":{ + "shape":"Size", + "documentation":"

    The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

    If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

    " + } + }, + "documentation":"

    Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    " + }, + "SizeConstraintSet":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "SizeConstraints" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the SizeConstraintSet.

    " + }, + "SizeConstraints":{ + "shape":"SizeConstraints", + "documentation":"

    Specifies the parts of web requests that you want to inspect the size of.

    " + } + }, + "documentation":"

    A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

    " + }, + "SizeConstraintSetSummaries":{ + "type":"list", + "member":{"shape":"SizeConstraintSetSummary"} + }, + "SizeConstraintSetSummary":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "Name" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

    SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the SizeConstraintSet, if any.

    " + } + }, + "documentation":"

    The Id and Name of a SizeConstraintSet.

    " + }, + "SizeConstraintSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SizeConstraint" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

    " + }, + "SizeConstraint":{ + "shape":"SizeConstraint", + "documentation":"

    Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of \"Size ComparisonOperator size in bytes of FieldToMatch\". If that expression is true, the SizeConstraint is considered to match.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect the size of and indicates whether you want to add the specification to a SizeConstraintSet or delete it from a SizeConstraintSet.

    " + }, + "SizeConstraintSetUpdates":{ + "type":"list", + "member":{"shape":"SizeConstraintSetUpdate"}, + "min":1 + }, + "SizeConstraints":{ + "type":"list", + "member":{"shape":"SizeConstraint"} + }, + "SqlInjectionMatchSet":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "SqlInjectionMatchTuples" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchTuples":{ + "shape":"SqlInjectionMatchTuples", + "documentation":"

    Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

    " + } + }, + "documentation":"

    A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the specified parts of the request to be considered a match.

    " + }, + "SqlInjectionMatchSetSummaries":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetSummary"} + }, + "SqlInjectionMatchSetSummary":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "Name" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

    SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the SqlInjectionMatchSet, if any, specified by Id.

    " + } + }, + "documentation":"

    The Id and Name of a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "SqlInjectionMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchTuple":{ + "shape":"SqlInjectionMatchTuple", + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the specification to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet.

    " + }, + "SqlInjectionMatchSetUpdates":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchSetUpdate"}, + "min":1 + }, + "SqlInjectionMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for snippets of malicious SQL code.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

    " + }, + "SqlInjectionMatchTuples":{ + "type":"list", + "member":{"shape":"SqlInjectionMatchTuple"} + }, + "SubscribedRuleGroupSummaries":{ + "type":"list", + "member":{"shape":"SubscribedRuleGroupSummary"} + }, + "SubscribedRuleGroupSummary":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Name", + "MetricName" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a RuleGroup.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change the name of the metric after you create the RuleGroup.

    " + } + }, + "documentation":"

    A summary of the rule groups you are subscribed to.

    " + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagInfoForResource":{ + "type":"structure", + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "TagList":{"shape":"TagList"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "min":1 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "Tags" + ], + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "Tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0 + }, + "TextTransformation":{ + "type":"string", + "enum":[ + "NONE", + "COMPRESS_WHITE_SPACE", + "HTML_ENTITY_DECODE", + "LOWERCASE", + "CMD_LINE", + "URL_DECODE" + ] + }, + "TimeWindow":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

    " + } + }, + "documentation":"

    In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

    In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

    " + }, + "Timestamp":{"type":"timestamp"}, + "URIString":{"type":"string"}, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceARN", + "TagKeys" + ], + "members":{ + "ResourceARN":{"shape":"ResourceArn"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateByteMatchSetRequest":{ + "type":"structure", + "required":[ + "ByteMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "ByteMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"ByteMatchSetUpdates", + "documentation":"

    An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

    " + } + } + }, + "UpdateByteMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateGeoMatchSetRequest":{ + "type":"structure", + "required":[ + "GeoMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "GeoMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"GeoMatchSetUpdates", + "documentation":"

    An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

    • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint

    • GeoMatchConstraint: Contains Type and Value

      You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.

    " + } + } + }, + "UpdateGeoMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateIPSetRequest":{ + "type":"structure", + "required":[ + "IPSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "IPSetId":{ + "shape":"ResourceId", + "documentation":"

    The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"IPSetUpdates", + "documentation":"

    An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

    You can insert a maximum of 1000 addresses in a single request.

    " + } + } + }, + "UpdateIPSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRateBasedRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken", + "Updates", + "RateLimit" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"RuleUpdates", + "documentation":"

    An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

    " + }, + "RateLimit":{ + "shape":"RateLimit", + "documentation":"

    The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    " + } + } + }, + "UpdateRateBasedRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRegexMatchSetRequest":{ + "type":"structure", + "required":[ + "RegexMatchSetId", + "Updates", + "ChangeToken" + ], + "members":{ + "RegexMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    " + }, + "Updates":{ + "shape":"RegexMatchSetUpdates", + "documentation":"

    An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRegexMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRegexPatternSetRequest":{ + "type":"structure", + "required":[ + "RegexPatternSetId", + "Updates", + "ChangeToken" + ], + "members":{ + "RegexPatternSetId":{ + "shape":"ResourceId", + "documentation":"

    The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    " + }, + "Updates":{ + "shape":"RegexPatternSetUpdates", + "documentation":"

    An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRegexPatternSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRuleGroupRequest":{ + "type":"structure", + "required":[ + "RuleGroupId", + "Updates", + "ChangeToken" + ], + "members":{ + "RuleGroupId":{ + "shape":"ResourceId", + "documentation":"

    The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    " + }, + "Updates":{ + "shape":"RuleGroupUpdates", + "documentation":"

    An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

    You can only insert REGULAR rules into a rule group.

    ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + } + } + }, + "UpdateRuleGroupResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateRuleRequest":{ + "type":"structure", + "required":[ + "RuleId", + "ChangeToken", + "Updates" + ], + "members":{ + "RuleId":{ + "shape":"ResourceId", + "documentation":"

    The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"RuleUpdates", + "documentation":"

    An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

    " + } + } + }, + "UpdateRuleResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateSizeConstraintSetRequest":{ + "type":"structure", + "required":[ + "SizeConstraintSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SizeConstraintSetId":{ + "shape":"ResourceId", + "documentation":"

    The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"SizeConstraintSetUpdates", + "documentation":"

    An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

    " + } + } + }, + "UpdateSizeConstraintSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateSqlInjectionMatchSetRequest":{ + "type":"structure", + "required":[ + "SqlInjectionMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "SqlInjectionMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"SqlInjectionMatchSetUpdates", + "documentation":"

    An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

    " + } + }, + "documentation":"

    A request to update a SqlInjectionMatchSet.

    " + }, + "UpdateSqlInjectionMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to an UpdateSqlInjectionMatchSets request.

    " + }, + "UpdateWebACLRequest":{ + "type":"structure", + "required":[ + "WebACLId", + "ChangeToken" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"WebACLUpdates", + "documentation":"

    An array of updates to make to the WebACL.

    An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

    • WebACLUpdate: Contains Action and ActivatedRule

    • ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

    • WafAction: Contains Type

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

    " + } + } + }, + "UpdateWebACLResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + } + }, + "UpdateXssMatchSetRequest":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "ChangeToken", + "Updates" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The value returned by the most recent call to GetChangeToken.

    " + }, + "Updates":{ + "shape":"XssMatchSetUpdates", + "documentation":"

    An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

    " + } + }, + "documentation":"

    A request to update an XssMatchSet.

    " + }, + "UpdateXssMatchSetResponse":{ + "type":"structure", + "members":{ + "ChangeToken":{ + "shape":"ChangeToken", + "documentation":"

    The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

    " + } + }, + "documentation":"

    The response to an UpdateXssMatchSets request.

    " + }, + "WAFBadRequestException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFDisallowedNameException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The name specified is invalid.

    ", + "exception":true + }, + "WAFInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because of a system problem, even though the request was valid. Retry your request.

    ", + "exception":true, + "fault":true + }, + "WAFInvalidAccountException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

    ", + "exception":true + }, + "WAFInvalidOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because there was nothing to do. For example:

    • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL.

    • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet.

    • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL.

    • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL.

    • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL.

    ", + "exception":true + }, + "WAFInvalidParameterException":{ + "type":"structure", + "members":{ + "field":{"shape":"ParameterExceptionField"}, + "parameter":{"shape":"ParameterExceptionParameter"}, + "reason":{"shape":"ParameterExceptionReason"} + }, + "documentation":"

    The operation failed because AWS WAF didn't recognize a parameter in the request. For example:

    • You specified an invalid parameter name.

    • You specified an invalid value.

    • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE.

    • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT.

    • You tried to create a RateBasedRule with a RateKey value other than IP.

    • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT.

    • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY.

    • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data.

    • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.

    ", + "exception":true + }, + "WAFInvalidPermissionPolicyException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because the specified policy is not in the proper format.

    The policy is subject to the following restrictions:

    • You can attach only one policy with each PutPermissionPolicy request.

    • The policy must include an Effect, Action and Principal.

    • Effect must specify Allow.

    • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

    • The policy cannot include a Resource parameter.

    • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

    • The user making the request must be the owner of the RuleGroup.

    • Your policy must be composed using IAM Policy version 2012-10-17.

    ", + "exception":true + }, + "WAFInvalidRegexPatternException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The regular expression (regex) you specified in RegexPatternString is invalid.

    ", + "exception":true + }, + "WAFLimitsExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.

    ", + "exception":true + }, + "WAFNonEmptyEntityException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to delete an object that isn't empty. For example:

    • You tried to delete a WebACL that still contains one or more Rule objects.

    • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates.

    • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects.

    • You tried to delete an IPSet that references one or more IP addresses.

    ", + "exception":true + }, + "WAFNonexistentContainerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:

    • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist.

    • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist.

    • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist.

    • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist.

    ", + "exception":true + }, + "WAFNonexistentItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because the referenced object doesn't exist.

    ", + "exception":true + }, + "WAFReferencedItemException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to delete an object that is still in use. For example:

    • You tried to delete a ByteMatchSet that is still referenced by a Rule.

    • You tried to delete a Rule that is still referenced by a WebACL.

    ", + "exception":true + }, + "WAFServiceLinkedRoleErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.

    ", + "exception":true + }, + "WAFStaleDataException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

    ", + "exception":true + }, + "WAFSubscriptionNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The specified subscription does not exist.

    ", + "exception":true + }, + "WAFTagOperationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true + }, + "WAFTagOperationInternalErrorException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "exception":true, + "fault":true + }, + "WafAction":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"WafActionType", + "documentation":"

    Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

    • ALLOW: AWS WAF allows requests

    • BLOCK: AWS WAF blocks requests

    • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

    " + } + }, + "documentation":"

    For the action that is associated with a rule in a WebACL, specifies the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, specifies the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL.

    " + }, + "WafActionType":{ + "type":"string", + "enum":[ + "BLOCK", + "ALLOW", + "COUNT" + ] + }, + "WafOverrideAction":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"WafOverrideActionType", + "documentation":"

    COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

    " + } + }, + "documentation":"

    The action to take if any rule within the RuleGroup matches a request.

    " + }, + "WafOverrideActionType":{ + "type":"string", + "enum":[ + "NONE", + "COUNT" + ] + }, + "WafRuleType":{ + "type":"string", + "enum":[ + "REGULAR", + "RATE_BASED", + "GROUP" + ] + }, + "WebACL":{ + "type":"structure", + "required":[ + "WebACLId", + "DefaultAction", + "Rules" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " + }, + "MetricName":{ + "shape":"MetricName", + "documentation":"

    A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including \"All\" and \"Default_Action.\" You can't change MetricName after you create the WebACL.

    " + }, + "DefaultAction":{ + "shape":"WafAction", + "documentation":"

    The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

    " + }, + "Rules":{ + "shape":"ActivatedRules", + "documentation":"

    An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

    " + }, + "WebACLArn":{ + "shape":"ResourceArn", + "documentation":"

    Tha Amazon Resource Name (ARN) of the web ACL.

    " + } + }, + "documentation":"

    Contains the Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from specified IP addresses or block requests from specified referrers. You also associate the WebACL with a CloudFront distribution to identify the requests that you want AWS WAF to filter. If you add more than one Rule to a WebACL, a request needs to match only one of the specifications to be allowed, blocked, or counted. For more information, see UpdateWebACL.

    " + }, + "WebACLSummaries":{ + "type":"list", + "member":{"shape":"WebACLSummary"} + }, + "WebACLSummary":{ + "type":"structure", + "required":[ + "WebACLId", + "Name" + ], + "members":{ + "WebACLId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

    WebACLId is returned by CreateWebACL and by ListWebACLs.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

    " + } + }, + "documentation":"

    Contains the identifier and the name or description of the WebACL.

    " + }, + "WebACLUpdate":{ + "type":"structure", + "required":[ + "Action", + "ActivatedRule" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specifies whether to insert a Rule into or delete a Rule from a WebACL.

    " + }, + "ActivatedRule":{ + "shape":"ActivatedRule", + "documentation":"

    The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

    " + } + }, + "documentation":"

    Specifies whether to insert a Rule into or delete a Rule from a WebACL.

    " + }, + "WebACLUpdates":{ + "type":"list", + "member":{"shape":"WebACLUpdate"} + }, + "XssMatchSet":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "XssMatchTuples" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name, if any, of the XssMatchSet.

    " + }, + "XssMatchTuples":{ + "shape":"XssMatchTuples", + "documentation":"

    Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

    " + } + }, + "documentation":"

    A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the specified parts of the request to be considered a match.

    " + }, + "XssMatchSetSummaries":{ + "type":"list", + "member":{"shape":"XssMatchSetSummary"} + }, + "XssMatchSetSummary":{ + "type":"structure", + "required":[ + "XssMatchSetId", + "Name" + ], + "members":{ + "XssMatchSetId":{ + "shape":"ResourceId", + "documentation":"

    A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

    XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the XssMatchSet, if any, specified by Id.

    " + } + }, + "documentation":"

    The Id and Name of an XssMatchSet.

    " + }, + "XssMatchSetUpdate":{ + "type":"structure", + "required":[ + "Action", + "XssMatchTuple" + ], + "members":{ + "Action":{ + "shape":"ChangeAction", + "documentation":"

    Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.

    " + }, + "XssMatchTuple":{ + "shape":"XssMatchTuple", + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the specification to an XssMatchSet or delete it from an XssMatchSet.

    " + }, + "XssMatchSetUpdates":{ + "type":"list", + "member":{"shape":"XssMatchSetUpdate"}, + "min":1 + }, + "XssMatchTuple":{ + "type":"structure", + "required":[ + "FieldToMatch", + "TextTransformation" + ], + "members":{ + "FieldToMatch":{ + "shape":"FieldToMatch", + "documentation":"

    Specifies where in a web request to look for cross-site scripting attacks.

    " + }, + "TextTransformation":{ + "shape":"TextTransformation", + "documentation":"

    Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

    You can only specify a single type of TextTransformation.

    CMD_LINE

    When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

    • Delete the following characters: \\ \" ' ^

    • Delete spaces before the following characters: / (

    • Replace the following characters with a space: , ;

    • Replace multiple spaces with one space

    • Convert uppercase letters (A-Z) to lowercase (a-z)

    COMPRESS_WHITE_SPACE

    Use this option to replace the following characters with a space character (decimal 32):

    • \\f, formfeed, decimal 12

    • \\t, tab, decimal 9

    • \\n, newline, decimal 10

    • \\r, carriage return, decimal 13

    • \\v, vertical tab, decimal 11

    • non-breaking space, decimal 160

    COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

    HTML_ENTITY_DECODE

    Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

    • Replaces (ampersand)quot; with \"

    • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

    • Replaces (ampersand)lt; with a \"less than\" symbol

    • Replaces (ampersand)gt; with >

    • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

    • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

    LOWERCASE

    Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

    URL_DECODE

    Use this option to decode a URL-encoded value.

    NONE

    Specify NONE if you don't want to perform any text transformations.

    " + } + }, + "documentation":"

    Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

    " + }, + "XssMatchTuples":{ + "type":"list", + "member":{"shape":"XssMatchTuple"} + }, + "errorMessage":{"type":"string"} + }, + "documentation":"

    This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

    " +} diff --git a/aws/dist/botocore/data/workdocs/2016-05-01/paginators-1.json b/aws/dist/botocore/data/workdocs/2016-05-01/paginators-1.json new file mode 100644 index 00000000..a7cade37 --- /dev/null +++ b/aws/dist/botocore/data/workdocs/2016-05-01/paginators-1.json @@ -0,0 +1,61 @@ +{ + "pagination": { + "DescribeDocumentVersions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "DocumentVersions" + }, + "DescribeFolderContents": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": [ + "Folders", + "Documents" + ] + }, + "DescribeUsers": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Users" + }, + "DescribeActivities": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "UserActivities" + }, + "DescribeComments": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Comments" + }, + "DescribeGroups": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Groups" + }, + "DescribeNotificationSubscriptions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Subscriptions" + }, + "DescribeResourcePermissions": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Principals" + }, + "DescribeRootFolders": { + "input_token": "Marker", + "limit_key": "Limit", + "output_token": "Marker", + "result_key": "Folders" + } + } +} diff --git a/aws/dist/botocore/data/workdocs/2016-05-01/service-2.json b/aws/dist/botocore/data/workdocs/2016-05-01/service-2.json new file mode 100644 index 00000000..84fdf10c --- /dev/null +++ b/aws/dist/botocore/data/workdocs/2016-05-01/service-2.json @@ -0,0 +1,3721 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-05-01", + "endpointPrefix":"workdocs", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon WorkDocs", + "serviceId":"WorkDocs", + "signatureVersion":"v4", + "uid":"workdocs-2016-05-01" + }, + "operations":{ + "AbortDocumentVersionUpload":{ + "name":"AbortDocumentVersionUpload", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":204 + }, + "input":{"shape":"AbortDocumentVersionUploadRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Aborts the upload of the specified document version that was previously initiated by InitiateDocumentVersionUpload. The client should make this call only when it no longer intends to upload the document version, or fails to do so.

    " + }, + "ActivateUser":{ + "name":"ActivateUser", + "http":{ + "method":"POST", + "requestUri":"/api/v1/users/{UserId}/activation", + "responseCode":200 + }, + "input":{"shape":"ActivateUserRequest"}, + "output":{"shape":"ActivateUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Activates the specified user. Only active users can access Amazon WorkDocs.

    " + }, + "AddResourcePermissions":{ + "name":"AddResourcePermissions", + "http":{ + "method":"POST", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":201 + }, + "input":{"shape":"AddResourcePermissionsRequest"}, + "output":{"shape":"AddResourcePermissionsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Creates a set of permissions for the specified folder or document. The resource permissions are overwritten if the principals already have different permissions.

    " + }, + "CreateComment":{ + "name":"CreateComment", + "http":{ + "method":"POST", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment", + "responseCode":201 + }, + "input":{"shape":"CreateCommentRequest"}, + "output":{"shape":"CreateCommentResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DocumentLockedForCommentsException"}, + {"shape":"InvalidCommentOperationException"} + ], + "documentation":"

    Adds a new comment to the specified document version.

    " + }, + "CreateCustomMetadata":{ + "name":"CreateCustomMetadata", + "http":{ + "method":"PUT", + "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", + "responseCode":200 + }, + "input":{"shape":"CreateCustomMetadataRequest"}, + "output":{"shape":"CreateCustomMetadataResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"CustomMetadataLimitExceededException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Adds one or more custom properties to the specified resource (a folder, document, or version).

    " + }, + "CreateFolder":{ + "name":"CreateFolder", + "http":{ + "method":"POST", + "requestUri":"/api/v1/folders", + "responseCode":201 + }, + "input":{"shape":"CreateFolderRequest"}, + "output":{"shape":"CreateFolderResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Creates a folder with the specified name and parent folder.

    " + }, + "CreateLabels":{ + "name":"CreateLabels", + "http":{ + "method":"PUT", + "requestUri":"/api/v1/resources/{ResourceId}/labels", + "responseCode":200 + }, + "input":{"shape":"CreateLabelsRequest"}, + "output":{"shape":"CreateLabelsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"TooManyLabelsException"} + ], + "documentation":"

    Adds the specified list of labels to the given resource (a document or folder)

    " + }, + "CreateNotificationSubscription":{ + "name":"CreateNotificationSubscription", + "http":{ + "method":"POST", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"CreateNotificationSubscriptionRequest"}, + "output":{"shape":"CreateNotificationSubscriptionResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"TooManySubscriptionsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Configure Amazon WorkDocs to use Amazon SNS notifications. The endpoint receives a confirmation message, and must confirm the subscription.

    For more information, see Subscribe to Notifications in the Amazon WorkDocs Developer Guide.

    " + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/api/v1/users", + "responseCode":201 + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"EntityAlreadyExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is \"ACTIVE\". New users can access Amazon WorkDocs.

    " + }, + "DeactivateUser":{ + "name":"DeactivateUser", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/users/{UserId}/activation", + "responseCode":204 + }, + "input":{"shape":"DeactivateUserRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.

    " + }, + "DeleteComment":{ + "name":"DeleteComment", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comment/{CommentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteCommentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DocumentLockedForCommentsException"} + ], + "documentation":"

    Deletes the specified comment from the document version.

    " + }, + "DeleteCustomMetadata":{ + "name":"DeleteCustomMetadata", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/customMetadata", + "responseCode":200 + }, + "input":{"shape":"DeleteCustomMetadataRequest"}, + "output":{"shape":"DeleteCustomMetadataResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deletes custom metadata from the specified resource.

    " + }, + "DeleteDocument":{ + "name":"DeleteDocument", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteDocumentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Permanently deletes the specified document and its associated metadata.

    " + }, + "DeleteFolder":{ + "name":"DeleteFolder", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":204 + }, + "input":{"shape":"DeleteFolderRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Permanently deletes the specified folder and its contents.

    " + }, + "DeleteFolderContents":{ + "name":"DeleteFolderContents", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/folders/{FolderId}/contents", + "responseCode":204 + }, + "input":{"shape":"DeleteFolderContentsRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deletes the contents of the specified folder.

    " + }, + "DeleteLabels":{ + "name":"DeleteLabels", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/labels", + "responseCode":200 + }, + "input":{"shape":"DeleteLabelsRequest"}, + "output":{"shape":"DeleteLabelsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deletes the specified list of labels from a resource.

    " + }, + "DeleteNotificationSubscription":{ + "name":"DeleteNotificationSubscription", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions/{SubscriptionId}", + "responseCode":200 + }, + "input":{"shape":"DeleteNotificationSubscriptionRequest"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"EntityNotExistsException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"

    Deletes the specified subscription from the specified organization.

    " + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/users/{UserId}", + "responseCode":204 + }, + "input":{"shape":"DeleteUserRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Deletes the specified user from a Simple AD or Microsoft AD directory.

    " + }, + "DescribeActivities":{ + "name":"DescribeActivities", + "http":{ + "method":"GET", + "requestUri":"/api/v1/activities", + "responseCode":200 + }, + "input":{"shape":"DescribeActivitiesRequest"}, + "output":{"shape":"DescribeActivitiesResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Describes the user activities in a specified time period.

    " + }, + "DescribeComments":{ + "name":"DescribeComments", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}/comments", + "responseCode":200 + }, + "input":{"shape":"DescribeCommentsRequest"}, + "output":{"shape":"DescribeCommentsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    List all the comments for the specified document version.

    " + }, + "DescribeDocumentVersions":{ + "name":"DescribeDocumentVersions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions", + "responseCode":200 + }, + "input":{"shape":"DescribeDocumentVersionsRequest"}, + "output":{"shape":"DescribeDocumentVersionsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"

    Retrieves the document versions for the specified document.

    By default, only active versions are returned.

    " + }, + "DescribeFolderContents":{ + "name":"DescribeFolderContents", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}/contents", + "responseCode":200 + }, + "input":{"shape":"DescribeFolderContentsRequest"}, + "output":{"shape":"DescribeFolderContentsResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"

    Describes the contents of the specified folder, including its documents and subfolders.

    By default, Amazon WorkDocs returns the first 100 active document and folder metadata items. If there are more results, the response includes a marker that you can use to request the next set of results. You can also request initialized documents.

    " + }, + "DescribeGroups":{ + "name":"DescribeGroups", + "http":{ + "method":"GET", + "requestUri":"/api/v1/groups", + "responseCode":200 + }, + "input":{"shape":"DescribeGroupsRequest"}, + "output":{"shape":"DescribeGroupsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Describes the groups specified by the query. Groups are defined by the underlying Active Directory.

    " + }, + "DescribeNotificationSubscriptions":{ + "name":"DescribeNotificationSubscriptions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/organizations/{OrganizationId}/subscriptions", + "responseCode":200 + }, + "input":{"shape":"DescribeNotificationSubscriptionsRequest"}, + "output":{"shape":"DescribeNotificationSubscriptionsResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"EntityNotExistsException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Lists the specified notification subscriptions.

    " + }, + "DescribeResourcePermissions":{ + "name":"DescribeResourcePermissions", + "http":{ + "method":"GET", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":200 + }, + "input":{"shape":"DescribeResourcePermissionsRequest"}, + "output":{"shape":"DescribeResourcePermissionsResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Describes the permissions of a specified resource.

    " + }, + "DescribeRootFolders":{ + "name":"DescribeRootFolders", + "http":{ + "method":"GET", + "requestUri":"/api/v1/me/root", + "responseCode":200 + }, + "input":{"shape":"DescribeRootFoldersRequest"}, + "output":{"shape":"DescribeRootFoldersResponse"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Describes the current user's special folders; the RootFolder and the RecycleBin. RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

    This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

    " + }, + "DescribeUsers":{ + "name":"DescribeUsers", + "http":{ + "method":"GET", + "requestUri":"/api/v1/users", + "responseCode":200 + }, + "input":{"shape":"DescribeUsersRequest"}, + "output":{"shape":"DescribeUsersResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"RequestedEntityTooLargeException"} + ], + "documentation":"

    Describes the specified users. You can describe all users or filter the results (for example, by status or organization).

    By default, Amazon WorkDocs returns the first 24 active or pending users. If there are more results, the response includes a marker that you can use to request the next set of results.

    " + }, + "GetCurrentUser":{ + "name":"GetCurrentUser", + "http":{ + "method":"GET", + "requestUri":"/api/v1/me", + "responseCode":200 + }, + "input":{"shape":"GetCurrentUserRequest"}, + "output":{"shape":"GetCurrentUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

    " + }, + "GetDocument":{ + "name":"GetDocument", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":200 + }, + "input":{"shape":"GetDocumentRequest"}, + "output":{"shape":"GetDocumentResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"

    Retrieves details of a document.

    " + }, + "GetDocumentPath":{ + "name":"GetDocumentPath", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/path", + "responseCode":200 + }, + "input":{"shape":"GetDocumentPathRequest"}, + "output":{"shape":"GetDocumentPathResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Retrieves the path information (the hierarchy from the root folder) for the requested document.

    By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

    " + }, + "GetDocumentVersion":{ + "name":"GetDocumentVersion", + "http":{ + "method":"GET", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":200 + }, + "input":{"shape":"GetDocumentVersionRequest"}, + "output":{"shape":"GetDocumentVersionResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"InvalidPasswordException"} + ], + "documentation":"

    Retrieves version metadata for the specified document.

    " + }, + "GetFolder":{ + "name":"GetFolder", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":200 + }, + "input":{"shape":"GetFolderRequest"}, + "output":{"shape":"GetFolderResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ProhibitedStateException"} + ], + "documentation":"

    Retrieves the metadata of the specified folder.

    " + }, + "GetFolderPath":{ + "name":"GetFolderPath", + "http":{ + "method":"GET", + "requestUri":"/api/v1/folders/{FolderId}/path", + "responseCode":200 + }, + "input":{"shape":"GetFolderPathRequest"}, + "output":{"shape":"GetFolderPathResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Retrieves the path information (the hierarchy from the root folder) for the specified folder.

    By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.

    " + }, + "GetResources":{ + "name":"GetResources", + "http":{ + "method":"GET", + "requestUri":"/api/v1/resources", + "responseCode":200 + }, + "input":{"shape":"GetResourcesRequest"}, + "output":{"shape":"GetResourcesResponse"}, + "errors":[ + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"InvalidArgumentException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Retrieves a collection of resources, including folders and documents. The only CollectionType supported is SHARED_WITH_ME.

    " + }, + "InitiateDocumentVersionUpload":{ + "name":"InitiateDocumentVersionUpload", + "http":{ + "method":"POST", + "requestUri":"/api/v1/documents", + "responseCode":201 + }, + "input":{"shape":"InitiateDocumentVersionUploadRequest"}, + "output":{"shape":"InitiateDocumentVersionUploadResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"StorageLimitExceededException"}, + {"shape":"StorageLimitWillExceedException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DraftUploadOutOfSyncException"}, + {"shape":"ResourceAlreadyCheckedOutException"} + ], + "documentation":"

    Creates a new document object and version object.

    The client specifies the parent folder ID and name of the document to upload. The ID is optionally specified when creating a new version of an existing document. This is the first step to upload a document. Next, upload the document to the URL returned from the call, and then call UpdateDocumentVersion.

    To cancel the document upload, call AbortDocumentVersionUpload.

    " + }, + "RemoveAllResourcePermissions":{ + "name":"RemoveAllResourcePermissions", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/permissions", + "responseCode":204 + }, + "input":{"shape":"RemoveAllResourcePermissionsRequest"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Removes all the permissions from the specified resource.

    " + }, + "RemoveResourcePermission":{ + "name":"RemoveResourcePermission", + "http":{ + "method":"DELETE", + "requestUri":"/api/v1/resources/{ResourceId}/permissions/{PrincipalId}", + "responseCode":204 + }, + "input":{"shape":"RemoveResourcePermissionRequest"}, + "errors":[ + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Removes the permission for the specified principal from the specified resource.

    " + }, + "UpdateDocument":{ + "name":"UpdateDocument", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/documents/{DocumentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDocumentRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"LimitExceededException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Updates the specified attributes of a document. The user must have access to both the document and its parent folder, if applicable.

    " + }, + "UpdateDocumentVersion":{ + "name":"UpdateDocumentVersion", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/documents/{DocumentId}/versions/{VersionId}", + "responseCode":200 + }, + "input":{"shape":"UpdateDocumentVersionRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"InvalidOperationException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Changes the status of the document version to ACTIVE.

    Amazon WorkDocs also sets its document container to ACTIVE. This is the last step in a document upload, after the client uploads the document to an S3-presigned URL returned by InitiateDocumentVersionUpload.

    " + }, + "UpdateFolder":{ + "name":"UpdateFolder", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/folders/{FolderId}", + "responseCode":200 + }, + "input":{"shape":"UpdateFolderRequest"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"EntityAlreadyExistsException"}, + {"shape":"ProhibitedStateException"}, + {"shape":"ConflictingOperationException"}, + {"shape":"ConcurrentModificationException"}, + {"shape":"LimitExceededException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"} + ], + "documentation":"

    Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

    " + }, + "UpdateUser":{ + "name":"UpdateUser", + "http":{ + "method":"PATCH", + "requestUri":"/api/v1/users/{UserId}", + "responseCode":200 + }, + "input":{"shape":"UpdateUserRequest"}, + "output":{"shape":"UpdateUserResponse"}, + "errors":[ + {"shape":"EntityNotExistsException"}, + {"shape":"UnauthorizedOperationException"}, + {"shape":"UnauthorizedResourceAccessException"}, + {"shape":"IllegalUserStateException"}, + {"shape":"FailedDependencyException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"DeactivatingLastSystemUserException"}, + {"shape":"InvalidArgumentException"} + ], + "documentation":"

    Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

    " + } + }, + "shapes":{ + "AbortDocumentVersionUploadRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the version.

    ", + "location":"uri", + "locationName":"VersionId" + } + } + }, + "ActivateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    ", + "location":"uri", + "locationName":"UserId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + } + } + }, + "ActivateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The user information.

    " + } + } + }, + "Activity":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ActivityType", + "documentation":"

    The activity type.

    " + }, + "TimeStamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the action was performed.

    " + }, + "IsIndirectActivity":{ + "shape":"BooleanType", + "documentation":"

    Indicates whether an activity is indirect or direct. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

    " + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    " + }, + "Initiator":{ + "shape":"UserMetadata", + "documentation":"

    The user who performed the action.

    " + }, + "Participants":{ + "shape":"Participants", + "documentation":"

    The list of users or groups impacted by this action. This is an optional field and is filled for the following sharing activities: DOCUMENT_SHARED, DOCUMENT_SHARED, DOCUMENT_UNSHARED, FOLDER_SHARED, FOLDER_UNSHARED.

    " + }, + "ResourceMetadata":{ + "shape":"ResourceMetadata", + "documentation":"

    The metadata of the resource involved in the user action.

    " + }, + "OriginalParent":{ + "shape":"ResourceMetadata", + "documentation":"

    The original parent of the resource. This is an optional field and is filled for move activities.

    " + }, + "CommentMetadata":{ + "shape":"CommentMetadata", + "documentation":"

    Metadata of the commenting activity. This is an optional field and is filled for commenting activities.

    " + } + }, + "documentation":"

    Describes the activity information.

    " + }, + "ActivityNamesFilterType":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"[\\w,]+" + }, + "ActivityType":{ + "type":"string", + "enum":[ + "DOCUMENT_CHECKED_IN", + "DOCUMENT_CHECKED_OUT", + "DOCUMENT_RENAMED", + "DOCUMENT_VERSION_UPLOADED", + "DOCUMENT_VERSION_DELETED", + "DOCUMENT_VERSION_VIEWED", + "DOCUMENT_VERSION_DOWNLOADED", + "DOCUMENT_RECYCLED", + "DOCUMENT_RESTORED", + "DOCUMENT_REVERTED", + "DOCUMENT_SHARED", + "DOCUMENT_UNSHARED", + "DOCUMENT_SHARE_PERMISSION_CHANGED", + "DOCUMENT_SHAREABLE_LINK_CREATED", + "DOCUMENT_SHAREABLE_LINK_REMOVED", + "DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED", + "DOCUMENT_MOVED", + "DOCUMENT_COMMENT_ADDED", + "DOCUMENT_COMMENT_DELETED", + "DOCUMENT_ANNOTATION_ADDED", + "DOCUMENT_ANNOTATION_DELETED", + "FOLDER_CREATED", + "FOLDER_DELETED", + "FOLDER_RENAMED", + "FOLDER_RECYCLED", + "FOLDER_RESTORED", + "FOLDER_SHARED", + "FOLDER_UNSHARED", + "FOLDER_SHARE_PERMISSION_CHANGED", + "FOLDER_SHAREABLE_LINK_CREATED", + "FOLDER_SHAREABLE_LINK_REMOVED", + "FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED", + "FOLDER_MOVED" + ] + }, + "AddResourcePermissionsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Principals" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "Principals":{ + "shape":"SharePrincipalList", + "documentation":"

    The users, groups, or organization being granted permission.

    " + }, + "NotificationOptions":{ + "shape":"NotificationOptions", + "documentation":"

    The notification options.

    " + } + } + }, + "AddResourcePermissionsResponse":{ + "type":"structure", + "members":{ + "ShareResults":{ + "shape":"ShareResultsList", + "documentation":"

    The share results.

    " + } + } + }, + "AuthenticationHeaderType":{ + "type":"string", + "max":8199, + "min":1, + "sensitive":true + }, + "BooleanEnumType":{ + "type":"string", + "enum":[ + "TRUE", + "FALSE" + ] + }, + "BooleanType":{"type":"boolean"}, + "Comment":{ + "type":"structure", + "required":["CommentId"], + "members":{ + "CommentId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the comment.

    " + }, + "ParentId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the parent comment.

    " + }, + "ThreadId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the root comment in the thread.

    " + }, + "Text":{ + "shape":"CommentTextType", + "documentation":"

    The text of the comment.

    " + }, + "Contributor":{ + "shape":"User", + "documentation":"

    The details of the user who made the comment.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time that the comment was created.

    " + }, + "Status":{ + "shape":"CommentStatusType", + "documentation":"

    The status of the comment.

    " + }, + "Visibility":{ + "shape":"CommentVisibilityType", + "documentation":"

    The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

    " + }, + "RecipientId":{ + "shape":"IdType", + "documentation":"

    If the comment is a reply to another user's comment, this field contains the user ID of the user being replied to.

    " + } + }, + "documentation":"

    Describes a comment.

    " + }, + "CommentIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "CommentList":{ + "type":"list", + "member":{"shape":"Comment"} + }, + "CommentMetadata":{ + "type":"structure", + "members":{ + "CommentId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the comment.

    " + }, + "Contributor":{ + "shape":"User", + "documentation":"

    The user who made the comment.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp that the comment was created.

    " + }, + "CommentStatus":{ + "shape":"CommentStatusType", + "documentation":"

    The status of the comment.

    " + }, + "RecipientId":{ + "shape":"IdType", + "documentation":"

    The ID of the user being replied to.

    " + } + }, + "documentation":"

    Describes the metadata of a comment.

    " + }, + "CommentStatusType":{ + "type":"string", + "enum":[ + "DRAFT", + "PUBLISHED", + "DELETED" + ] + }, + "CommentTextType":{ + "type":"string", + "max":2048, + "min":1, + "sensitive":true + }, + "CommentVisibilityType":{ + "type":"string", + "enum":[ + "PUBLIC", + "PRIVATE" + ] + }, + "ConcurrentModificationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The resource hierarchy is changing.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ConflictingOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    Another operation is in progress on the resource that conflicts with the current operation.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "CreateCommentRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId", + "Text" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the document version.

    ", + "location":"uri", + "locationName":"VersionId" + }, + "ParentId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the parent comment.

    " + }, + "ThreadId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the root comment in the thread.

    " + }, + "Text":{ + "shape":"CommentTextType", + "documentation":"

    The text of the comment.

    " + }, + "Visibility":{ + "shape":"CommentVisibilityType", + "documentation":"

    The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.

    " + }, + "NotifyCollaborators":{ + "shape":"BooleanType", + "documentation":"

    Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.

    " + } + } + }, + "CreateCommentResponse":{ + "type":"structure", + "members":{ + "Comment":{ + "shape":"Comment", + "documentation":"

    The comment that has been created.

    " + } + } + }, + "CreateCustomMetadataRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "CustomMetadata" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the version, if the custom metadata is being added to a document version.

    ", + "location":"querystring", + "locationName":"versionid" + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"

    Custom metadata in the form of name-value pairs.

    " + } + } + }, + "CreateCustomMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateFolderRequest":{ + "type":"structure", + "required":["ParentFolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the new folder.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + } + } + }, + "CreateFolderResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"FolderMetadata", + "documentation":"

    The metadata of the folder.

    " + } + } + }, + "CreateLabelsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Labels" + ], + "members":{ + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"

    List of labels to add to the resource.

    " + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + } + } + }, + "CreateLabelsResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateNotificationSubscriptionRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Endpoint", + "Protocol", + "SubscriptionType" + ], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    ", + "location":"uri", + "locationName":"OrganizationId" + }, + "Endpoint":{ + "shape":"SubscriptionEndPointType", + "documentation":"

    The endpoint to receive the notifications. If the protocol is HTTPS, the endpoint is a URL that begins with https.

    " + }, + "Protocol":{ + "shape":"SubscriptionProtocolType", + "documentation":"

    The protocol to use. The supported value is https, which delivers JSON-encoded messages using HTTPS POST.

    " + }, + "SubscriptionType":{ + "shape":"SubscriptionType", + "documentation":"

    The notification type.

    " + } + } + }, + "CreateNotificationSubscriptionResponse":{ + "type":"structure", + "members":{ + "Subscription":{ + "shape":"Subscription", + "documentation":"

    The subscription.

    " + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "Username", + "GivenName", + "Surname", + "Password" + ], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    " + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

    The login name of the user.

    " + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"

    The email address of the user.

    " + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"

    The given name of the user.

    " + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"

    The surname of the user.

    " + }, + "Password":{ + "shape":"PasswordType", + "documentation":"

    The password of the user.

    " + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"

    The time zone ID of the user.

    " + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"

    The amount of storage for the user.

    " + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The user information.

    " + } + } + }, + "CustomMetadataKeyList":{ + "type":"list", + "member":{"shape":"CustomMetadataKeyType"}, + "max":8 + }, + "CustomMetadataKeyType":{ + "type":"string", + "max":56, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "CustomMetadataLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The limit has been reached on the number of custom properties for the specified resource.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "CustomMetadataMap":{ + "type":"map", + "key":{"shape":"CustomMetadataKeyType"}, + "value":{"shape":"CustomMetadataValueType"}, + "max":8, + "min":1 + }, + "CustomMetadataValueType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "DeactivateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "UserId":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    ", + "location":"uri", + "locationName":"UserId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + } + } + }, + "DeactivatingLastSystemUserException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The last user in the organization is being deactivated.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DeleteCommentRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId", + "CommentId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the document version.

    ", + "location":"uri", + "locationName":"VersionId" + }, + "CommentId":{ + "shape":"CommentIdType", + "documentation":"

    The ID of the comment.

    ", + "location":"uri", + "locationName":"CommentId" + } + } + }, + "DeleteCustomMetadataRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource, either a document or folder.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the version, if the custom metadata is being deleted from a document version.

    ", + "location":"querystring", + "locationName":"versionId" + }, + "Keys":{ + "shape":"CustomMetadataKeyList", + "documentation":"

    List of properties to remove.

    ", + "location":"querystring", + "locationName":"keys" + }, + "DeleteAll":{ + "shape":"BooleanType", + "documentation":"

    Flag to indicate removal of all custom metadata properties from the specified resource.

    ", + "location":"querystring", + "locationName":"deleteAll" + } + } + }, + "DeleteCustomMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + } + } + }, + "DeleteFolderContentsRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + } + } + }, + "DeleteFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + } + } + }, + "DeleteLabelsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"

    List of labels to delete from the resource.

    ", + "location":"querystring", + "locationName":"labels" + }, + "DeleteAll":{ + "shape":"BooleanType", + "documentation":"

    Flag to request removal of all labels from the specified resource.

    ", + "location":"querystring", + "locationName":"deleteAll" + } + } + }, + "DeleteLabelsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteNotificationSubscriptionRequest":{ + "type":"structure", + "required":[ + "SubscriptionId", + "OrganizationId" + ], + "members":{ + "SubscriptionId":{ + "shape":"IdType", + "documentation":"

    The ID of the subscription.

    ", + "location":"uri", + "locationName":"SubscriptionId" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    ", + "location":"uri", + "locationName":"OrganizationId" + } + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    ", + "location":"uri", + "locationName":"UserId" + } + } + }, + "DescribeActivitiesRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "StartTime":{ + "shape":"TimestampType", + "documentation":"

    The timestamp that determines the starting time of the activities. The response includes the activities performed after the specified timestamp.

    ", + "location":"querystring", + "locationName":"startTime" + }, + "EndTime":{ + "shape":"TimestampType", + "documentation":"

    The timestamp that determines the end time of the activities. The response includes the activities performed before the specified timestamp.

    ", + "location":"querystring", + "locationName":"endTime" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization. This is a mandatory parameter when using administrative API (SigV4) requests.

    ", + "location":"querystring", + "locationName":"organizationId" + }, + "ActivityTypes":{ + "shape":"ActivityNamesFilterType", + "documentation":"

    Specifies which activity types to include in the response. If this field is left empty, all activity types are returned.

    ", + "location":"querystring", + "locationName":"activityTypes" + }, + "ResourceId":{ + "shape":"IdType", + "documentation":"

    The document or folder ID for which to describe activity types.

    ", + "location":"querystring", + "locationName":"resourceId" + }, + "UserId":{ + "shape":"IdType", + "documentation":"

    The ID of the user who performed the action. The response includes activities pertaining to this user. This is an optional parameter and is only applicable for administrative API (SigV4) requests.

    ", + "location":"querystring", + "locationName":"userId" + }, + "IncludeIndirectActivities":{ + "shape":"BooleanType", + "documentation":"

    Includes indirect activities. An indirect activity results from a direct activity performed on a parent resource. For example, sharing a parent folder (the direct activity) shares all of the subfolders and documents within the parent folder (the indirect activity).

    ", + "location":"querystring", + "locationName":"includeIndirectActivities" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker for the next set of results.

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeActivitiesResponse":{ + "type":"structure", + "members":{ + "UserActivities":{ + "shape":"UserActivities", + "documentation":"

    The list of activities for the specified user and time period.

    " + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker for the next set of results.

    " + } + } + }, + "DescribeCommentsRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the document version.

    ", + "location":"uri", + "locationName":"VersionId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker for the next set of results. This marker was received from a previous call.

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeCommentsResponse":{ + "type":"structure", + "members":{ + "Comments":{ + "shape":"CommentList", + "documentation":"

    The list of comments for the specified document version.

    " + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker for the next set of results. This marker was received from a previous call.

    " + } + } + }, + "DescribeDocumentVersionsRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call.)

    ", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of versions to return with this call.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Include":{ + "shape":"FieldNamesType", + "documentation":"

    A comma-separated list of values. Specify \"INITIALIZED\" to include incomplete versions.

    ", + "location":"querystring", + "locationName":"include" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"

    Specify \"SOURCE\" to include initialized versions and a URL for the source document.

    ", + "location":"querystring", + "locationName":"fields" + } + } + }, + "DescribeDocumentVersionsResponse":{ + "type":"structure", + "members":{ + "DocumentVersions":{ + "shape":"DocumentVersionMetadataList", + "documentation":"

    The document versions.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DescribeFolderContentsRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + }, + "Sort":{ + "shape":"ResourceSortType", + "documentation":"

    The sorting criteria.

    ", + "location":"querystring", + "locationName":"sort" + }, + "Order":{ + "shape":"OrderType", + "documentation":"

    The order for the contents of the folder.

    ", + "location":"querystring", + "locationName":"order" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return with this call.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. This marker was received from a previous call.

    ", + "location":"querystring", + "locationName":"marker" + }, + "Type":{ + "shape":"FolderContentType", + "documentation":"

    The type of items.

    ", + "location":"querystring", + "locationName":"type" + }, + "Include":{ + "shape":"FieldNamesType", + "documentation":"

    The contents to include. Specify \"INITIALIZED\" to include initialized documents.

    ", + "location":"querystring", + "locationName":"include" + } + } + }, + "DescribeFolderContentsResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"

    The subfolders in the specified folder.

    " + }, + "Documents":{ + "shape":"DocumentMetadataList", + "documentation":"

    The documents in the specified folder.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DescribeGroupsRequest":{ + "type":"structure", + "required":["SearchQuery"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "SearchQuery":{ + "shape":"SearchQueryType", + "documentation":"

    A query to describe groups by group name.

    ", + "location":"querystring", + "locationName":"searchQuery" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    ", + "location":"querystring", + "locationName":"organizationId" + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call.)

    ", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"PositiveIntegerType", + "documentation":"

    The maximum number of items to return with this call.

    ", + "location":"querystring", + "locationName":"limit" + } + } + }, + "DescribeGroupsResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupMetadataList", + "documentation":"

    The list of groups.

    " + }, + "Marker":{ + "shape":"MarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DescribeNotificationSubscriptionsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    ", + "location":"uri", + "locationName":"OrganizationId" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call.)

    ", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return with this call.

    ", + "location":"querystring", + "locationName":"limit" + } + } + }, + "DescribeNotificationSubscriptionsResponse":{ + "type":"structure", + "members":{ + "Subscriptions":{ + "shape":"SubscriptionList", + "documentation":"

    The subscriptions.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DescribeResourcePermissionsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "PrincipalId":{ + "shape":"IdType", + "documentation":"

    The ID of the principal to filter permissions by.

    ", + "location":"querystring", + "locationName":"principalId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return with this call.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call)

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeResourcePermissionsResponse":{ + "type":"structure", + "members":{ + "Principals":{ + "shape":"PrincipalList", + "documentation":"

    The principals.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DescribeRootFoldersRequest":{ + "type":"structure", + "required":["AuthenticationToken"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call.)

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "DescribeRootFoldersResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"

    The user's special folders.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results.

    " + } + } + }, + "DescribeUsersRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    ", + "location":"querystring", + "locationName":"organizationId" + }, + "UserIds":{ + "shape":"UserIdsType", + "documentation":"

    The IDs of the users.

    ", + "location":"querystring", + "locationName":"userIds" + }, + "Query":{ + "shape":"SearchQueryType", + "documentation":"

    A query to filter users by user name.

    ", + "location":"querystring", + "locationName":"query" + }, + "Include":{ + "shape":"UserFilterType", + "documentation":"

    The state of the users. Specify \"ALL\" to include inactive users.

    ", + "location":"querystring", + "locationName":"include" + }, + "Order":{ + "shape":"OrderType", + "documentation":"

    The order for the results.

    ", + "location":"querystring", + "locationName":"order" + }, + "Sort":{ + "shape":"UserSortType", + "documentation":"

    The sorting criteria.

    ", + "location":"querystring", + "locationName":"sort" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. (You received this marker from a previous call.)

    ", + "location":"querystring", + "locationName":"marker" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of items to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"

    A comma-separated list of values. Specify \"STORAGE_METADATA\" to include the user storage quota and utilization information.

    ", + "location":"querystring", + "locationName":"fields" + } + } + }, + "DescribeUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"OrganizationUserList", + "documentation":"

    The users.

    " + }, + "TotalNumberOfUsers":{ + "shape":"SizeType", + "documentation":"

    The total number of users included in the results.

    ", + "deprecated":true + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "DocumentContentType":{ + "type":"string", + "max":128, + "min":1 + }, + "DocumentLockedForCommentsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    This exception is thrown when the document is locked for comments and user tries to create or delete a comment on that document.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "DocumentMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    " + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"

    The ID of the creator.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the document was created.

    " + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the document was updated.

    " + }, + "LatestVersionMetadata":{ + "shape":"DocumentVersionMetadata", + "documentation":"

    The latest version of the document.

    " + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"

    The resource state.

    " + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"

    List of labels on the document.

    " + } + }, + "documentation":"

    Describes the document.

    " + }, + "DocumentMetadataList":{ + "type":"list", + "member":{"shape":"DocumentMetadata"} + }, + "DocumentSourceType":{ + "type":"string", + "enum":[ + "ORIGINAL", + "WITH_COMMENTS" + ] + }, + "DocumentSourceUrlMap":{ + "type":"map", + "key":{"shape":"DocumentSourceType"}, + "value":{"shape":"UrlType"} + }, + "DocumentStatusType":{ + "type":"string", + "enum":[ + "INITIALIZED", + "ACTIVE" + ] + }, + "DocumentThumbnailType":{ + "type":"string", + "enum":[ + "SMALL", + "SMALL_HQ", + "LARGE" + ] + }, + "DocumentThumbnailUrlMap":{ + "type":"map", + "key":{"shape":"DocumentThumbnailType"}, + "value":{"shape":"UrlType"} + }, + "DocumentVersionIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "DocumentVersionMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The ID of the version.

    " + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the version.

    " + }, + "ContentType":{ + "shape":"DocumentContentType", + "documentation":"

    The content type of the document.

    " + }, + "Size":{ + "shape":"SizeType", + "documentation":"

    The size of the document, in bytes.

    " + }, + "Signature":{ + "shape":"HashType", + "documentation":"

    The signature of the document.

    " + }, + "Status":{ + "shape":"DocumentStatusType", + "documentation":"

    The status of the document.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the document was first uploaded.

    " + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the document was last uploaded.

    " + }, + "ContentCreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the content of the document was originally created.

    " + }, + "ContentModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the content of the document was modified.

    " + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"

    The ID of the creator.

    " + }, + "Thumbnail":{ + "shape":"DocumentThumbnailUrlMap", + "documentation":"

    The thumbnail of the document.

    " + }, + "Source":{ + "shape":"DocumentSourceUrlMap", + "documentation":"

    The source of the document.

    " + } + }, + "documentation":"

    Describes a version of a document.

    " + }, + "DocumentVersionMetadataList":{ + "type":"list", + "member":{"shape":"DocumentVersionMetadata"} + }, + "DocumentVersionStatus":{ + "type":"string", + "enum":["ACTIVE"] + }, + "DraftUploadOutOfSyncException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    This exception is thrown when a valid checkout ID is not presented on document version upload calls for a document that has been checked out from Web client.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "EmailAddressType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}" + }, + "EntityAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The resource already exists.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "EntityIdList":{ + "type":"list", + "member":{"shape":"IdType"} + }, + "EntityNotExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"}, + "EntityIds":{"shape":"EntityIdList"} + }, + "documentation":"

    The resource does not exist.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ErrorMessageType":{"type":"string"}, + "FailedDependencyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

    ", + "error":{"httpStatusCode":424}, + "exception":true + }, + "FieldNamesType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w,]+" + }, + "FolderContentType":{ + "type":"string", + "enum":[ + "ALL", + "DOCUMENT", + "FOLDER" + ] + }, + "FolderMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    " + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the folder.

    " + }, + "CreatorId":{ + "shape":"IdType", + "documentation":"

    The ID of the creator.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the folder was created.

    " + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the folder was updated.

    " + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"

    The resource state of the folder.

    " + }, + "Signature":{ + "shape":"HashType", + "documentation":"

    The unique identifier created from the subfolders and documents of the folder.

    " + }, + "Labels":{ + "shape":"SharedLabels", + "documentation":"

    List of labels on the folder.

    " + }, + "Size":{ + "shape":"SizeType", + "documentation":"

    The size of the folder metadata.

    " + }, + "LatestVersionSize":{ + "shape":"SizeType", + "documentation":"

    The size of the latest version of the folder metadata.

    " + } + }, + "documentation":"

    Describes a folder.

    " + }, + "FolderMetadataList":{ + "type":"list", + "member":{"shape":"FolderMetadata"} + }, + "GetCurrentUserRequest":{ + "type":"structure", + "required":["AuthenticationToken"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + } + } + }, + "GetCurrentUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    Metadata of the user.

    " + } + } + }, + "GetDocumentPathRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"IdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of levels in the hierarchy to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"

    A comma-separated list of values. Specify NAME to include the names of the parent folders.

    ", + "location":"querystring", + "locationName":"fields" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    This value is not supported.

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetDocumentPathResponse":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"ResourcePath", + "documentation":"

    The path information.

    " + } + } + }, + "GetDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"

    Set this to TRUE to include custom metadata in the response.

    ", + "location":"querystring", + "locationName":"includeCustomMetadata" + } + } + }, + "GetDocumentResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"DocumentMetadata", + "documentation":"

    The metadata details of the document.

    " + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"

    The custom metadata on the document.

    " + } + } + }, + "GetDocumentVersionRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The version ID of the document.

    ", + "location":"uri", + "locationName":"VersionId" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"

    A comma-separated list of values. Specify \"SOURCE\" to include a URL for the source document.

    ", + "location":"querystring", + "locationName":"fields" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"

    Set this to TRUE to include custom metadata in the response.

    ", + "location":"querystring", + "locationName":"includeCustomMetadata" + } + } + }, + "GetDocumentVersionResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"DocumentVersionMetadata", + "documentation":"

    The version metadata.

    " + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"

    The custom metadata on the document version.

    " + } + } + }, + "GetFolderPathRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"IdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of levels in the hierarchy to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Fields":{ + "shape":"FieldNamesType", + "documentation":"

    A comma-separated list of values. Specify \"NAME\" to include the names of the parent folders.

    ", + "location":"querystring", + "locationName":"fields" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    This value is not supported.

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetFolderPathResponse":{ + "type":"structure", + "members":{ + "Path":{ + "shape":"ResourcePath", + "documentation":"

    The path information.

    " + } + } + }, + "GetFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + }, + "IncludeCustomMetadata":{ + "shape":"BooleanType", + "documentation":"

    Set to TRUE to include custom metadata in the response.

    ", + "location":"querystring", + "locationName":"includeCustomMetadata" + } + } + }, + "GetFolderResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"FolderMetadata", + "documentation":"

    The metadata of the folder.

    " + }, + "CustomMetadata":{ + "shape":"CustomMetadataMap", + "documentation":"

    The custom metadata on the folder.

    " + } + } + }, + "GetResourcesRequest":{ + "type":"structure", + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    The Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API operation using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"

    The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

    ", + "location":"querystring", + "locationName":"userId" + }, + "CollectionType":{ + "shape":"ResourceCollectionType", + "documentation":"

    The collection type.

    ", + "location":"querystring", + "locationName":"collectionType" + }, + "Limit":{ + "shape":"LimitType", + "documentation":"

    The maximum number of resources to return.

    ", + "location":"querystring", + "locationName":"limit" + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker for the next set of results. This marker was received from a previous call.

    ", + "location":"querystring", + "locationName":"marker" + } + } + }, + "GetResourcesResponse":{ + "type":"structure", + "members":{ + "Folders":{ + "shape":"FolderMetadataList", + "documentation":"

    The folders in the specified folder.

    " + }, + "Documents":{ + "shape":"DocumentMetadataList", + "documentation":"

    The documents in the specified collection.

    " + }, + "Marker":{ + "shape":"PageMarkerType", + "documentation":"

    The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

    " + } + } + }, + "GroupMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the user group.

    " + }, + "Name":{ + "shape":"GroupNameType", + "documentation":"

    The name of the group.

    " + } + }, + "documentation":"

    Describes the metadata of a user group.

    " + }, + "GroupMetadataList":{ + "type":"list", + "member":{"shape":"GroupMetadata"} + }, + "GroupNameType":{"type":"string"}, + "HashType":{ + "type":"string", + "max":128, + "min":0, + "pattern":"[&\\w+-.@]+" + }, + "HeaderNameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w-]+" + }, + "HeaderValueType":{ + "type":"string", + "max":1024, + "min":1 + }, + "IdType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[&\\w+-.@]+" + }, + "IllegalUserStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The user is undergoing transfer of ownership.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "InitiateDocumentVersionUploadRequest":{ + "type":"structure", + "required":["ParentFolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "Id":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    " + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the document.

    " + }, + "ContentCreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the content of the document was originally created.

    " + }, + "ContentModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The timestamp when the content of the document was modified.

    " + }, + "ContentType":{ + "shape":"DocumentContentType", + "documentation":"

    The content type of the document.

    " + }, + "DocumentSizeInBytes":{ + "shape":"SizeType", + "documentation":"

    The size of the document, in bytes.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + } + } + }, + "InitiateDocumentVersionUploadResponse":{ + "type":"structure", + "members":{ + "Metadata":{ + "shape":"DocumentMetadata", + "documentation":"

    The document metadata.

    " + }, + "UploadMetadata":{ + "shape":"UploadMetadata", + "documentation":"

    The upload metadata.

    " + } + } + }, + "InvalidArgumentException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The pagination marker or limit fields are not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "InvalidCommentOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The requested operation is not allowed on the specified comment object.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "InvalidOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The operation is invalid.

    ", + "error":{"httpStatusCode":405}, + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The password is invalid.

    ", + "error":{"httpStatusCode":401}, + "exception":true + }, + "LimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The maximum of 100,000 folders under the parent folder has been exceeded.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "LimitType":{ + "type":"integer", + "max":999, + "min":1 + }, + "LocaleType":{ + "type":"string", + "enum":[ + "en", + "fr", + "ko", + "de", + "es", + "ja", + "ru", + "zh_CN", + "zh_TW", + "pt_BR", + "default" + ] + }, + "MarkerType":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"[\\u0000-\\u00FF]+" + }, + "MessageType":{ + "type":"string", + "max":2048, + "min":0, + "sensitive":true + }, + "NotificationOptions":{ + "type":"structure", + "members":{ + "SendEmail":{ + "shape":"BooleanType", + "documentation":"

    Boolean value to indicate an email notification should be sent to the receipients.

    " + }, + "EmailMessage":{ + "shape":"MessageType", + "documentation":"

    Text value to be included in the email body.

    " + } + }, + "documentation":"

    Set of options which defines notification preferences of given action.

    " + }, + "OrderType":{ + "type":"string", + "enum":[ + "ASCENDING", + "DESCENDING" + ] + }, + "OrganizationUserList":{ + "type":"list", + "member":{"shape":"User"} + }, + "PageMarkerType":{ + "type":"string", + "max":2048, + "min":1 + }, + "Participants":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"UserMetadataList", + "documentation":"

    The list of users.

    " + }, + "Groups":{ + "shape":"GroupMetadataList", + "documentation":"

    The list of user groups.

    " + } + }, + "documentation":"

    Describes the users or user groups.

    " + }, + "PasswordType":{ + "type":"string", + "max":32, + "min":4, + "pattern":"[\\u0020-\\u00FF]+", + "sensitive":true + }, + "PermissionInfo":{ + "type":"structure", + "members":{ + "Role":{ + "shape":"RoleType", + "documentation":"

    The role of the user.

    " + }, + "Type":{ + "shape":"RolePermissionType", + "documentation":"

    The type of permissions.

    " + } + }, + "documentation":"

    Describes the permissions.

    " + }, + "PermissionInfoList":{ + "type":"list", + "member":{"shape":"PermissionInfo"} + }, + "PositiveIntegerType":{ + "type":"integer", + "min":1 + }, + "PositiveSizeType":{ + "type":"long", + "min":0 + }, + "Principal":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the resource.

    " + }, + "Type":{ + "shape":"PrincipalType", + "documentation":"

    The type of resource.

    " + }, + "Roles":{ + "shape":"PermissionInfoList", + "documentation":"

    The permission information for the resource.

    " + } + }, + "documentation":"

    Describes a resource.

    " + }, + "PrincipalList":{ + "type":"list", + "member":{"shape":"Principal"} + }, + "PrincipalType":{ + "type":"string", + "enum":[ + "USER", + "GROUP", + "INVITE", + "ANONYMOUS", + "ORGANIZATION" + ] + }, + "ProhibitedStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The specified document version is not in the INITIALIZED state.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "RemoveAllResourcePermissionsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + } + } + }, + "RemoveResourcePermissionRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "PrincipalId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "ResourceId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    ", + "location":"uri", + "locationName":"ResourceId" + }, + "PrincipalId":{ + "shape":"IdType", + "documentation":"

    The principal ID of the resource.

    ", + "location":"uri", + "locationName":"PrincipalId" + }, + "PrincipalType":{ + "shape":"PrincipalType", + "documentation":"

    The principal type of the resource.

    ", + "location":"querystring", + "locationName":"type" + } + } + }, + "RequestedEntityTooLargeException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The response is too large to return. The request must include a filter to reduce the size of the response.

    ", + "error":{"httpStatusCode":413}, + "exception":true + }, + "ResourceAlreadyCheckedOutException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The resource is already checked out.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "ResourceCollectionType":{ + "type":"string", + "enum":["SHARED_WITH_ME"] + }, + "ResourceIdType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"[\\w+-.@]+" + }, + "ResourceMetadata":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ResourceType", + "documentation":"

    The type of resource.

    " + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the resource.

    " + }, + "OriginalName":{ + "shape":"ResourceNameType", + "documentation":"

    The original name of the resource before a rename operation.

    " + }, + "Id":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource.

    " + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The version ID of the resource. This is an optional field and is filled for action on document version.

    " + }, + "Owner":{ + "shape":"UserMetadata", + "documentation":"

    The owner of the resource.

    " + }, + "ParentId":{ + "shape":"ResourceIdType", + "documentation":"

    The parent ID of the resource before a rename operation.

    " + } + }, + "documentation":"

    Describes the metadata of a resource.

    " + }, + "ResourceNameType":{ + "type":"string", + "max":255, + "min":1, + "pattern":"[\\u0020-\\u202D\\u202F-\\uFFFF]+" + }, + "ResourcePath":{ + "type":"structure", + "members":{ + "Components":{ + "shape":"ResourcePathComponentList", + "documentation":"

    The components of the resource path.

    " + } + }, + "documentation":"

    Describes the path information of a resource.

    " + }, + "ResourcePathComponent":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the resource path.

    " + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the resource path.

    " + } + }, + "documentation":"

    Describes the resource path.

    " + }, + "ResourcePathComponentList":{ + "type":"list", + "member":{"shape":"ResourcePathComponent"} + }, + "ResourceSortType":{ + "type":"string", + "enum":[ + "DATE", + "NAME" + ] + }, + "ResourceStateType":{ + "type":"string", + "enum":[ + "ACTIVE", + "RESTORING", + "RECYCLING", + "RECYCLED" + ] + }, + "ResourceType":{ + "type":"string", + "enum":[ + "FOLDER", + "DOCUMENT" + ] + }, + "RolePermissionType":{ + "type":"string", + "enum":[ + "DIRECT", + "INHERITED" + ] + }, + "RoleType":{ + "type":"string", + "enum":[ + "VIEWER", + "CONTRIBUTOR", + "OWNER", + "COOWNER" + ] + }, + "SearchQueryType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[\\u0020-\\uFFFF]+", + "sensitive":true + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    One or more of the dependencies is unavailable.

    ", + "error":{"httpStatusCode":503}, + "exception":true, + "fault":true + }, + "SharePrincipal":{ + "type":"structure", + "required":[ + "Id", + "Type", + "Role" + ], + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the recipient.

    " + }, + "Type":{ + "shape":"PrincipalType", + "documentation":"

    The type of the recipient.

    " + }, + "Role":{ + "shape":"RoleType", + "documentation":"

    The role of the recipient.

    " + } + }, + "documentation":"

    Describes the recipient type and ID, if available.

    " + }, + "SharePrincipalList":{ + "type":"list", + "member":{"shape":"SharePrincipal"} + }, + "ShareResult":{ + "type":"structure", + "members":{ + "PrincipalId":{ + "shape":"IdType", + "documentation":"

    The ID of the principal.

    " + }, + "InviteePrincipalId":{ + "shape":"IdType", + "documentation":"

    The ID of the invited user.

    " + }, + "Role":{ + "shape":"RoleType", + "documentation":"

    The role.

    " + }, + "Status":{ + "shape":"ShareStatusType", + "documentation":"

    The status.

    " + }, + "ShareId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the resource that was shared.

    " + }, + "StatusMessage":{ + "shape":"MessageType", + "documentation":"

    The status message.

    " + } + }, + "documentation":"

    Describes the share results of a resource.

    " + }, + "ShareResultsList":{ + "type":"list", + "member":{"shape":"ShareResult"} + }, + "ShareStatusType":{ + "type":"string", + "enum":[ + "SUCCESS", + "FAILURE" + ] + }, + "SharedLabel":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[a-zA-Z0-9._+-/=][a-zA-Z0-9 ._+-/=]*" + }, + "SharedLabels":{ + "type":"list", + "member":{"shape":"SharedLabel"}, + "max":20 + }, + "SignedHeaderMap":{ + "type":"map", + "key":{"shape":"HeaderNameType"}, + "value":{"shape":"HeaderValueType"} + }, + "SizeType":{"type":"long"}, + "StorageLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The storage limit has been exceeded.

    ", + "error":{"httpStatusCode":409}, + "exception":true + }, + "StorageLimitWillExceedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The storage limit will be exceeded.

    ", + "error":{"httpStatusCode":413}, + "exception":true + }, + "StorageRuleType":{ + "type":"structure", + "members":{ + "StorageAllocatedInBytes":{ + "shape":"PositiveSizeType", + "documentation":"

    The amount of storage allocated, in bytes.

    " + }, + "StorageType":{ + "shape":"StorageType", + "documentation":"

    The type of storage.

    " + } + }, + "documentation":"

    Describes the storage for a user.

    " + }, + "StorageType":{ + "type":"string", + "enum":[ + "UNLIMITED", + "QUOTA" + ] + }, + "Subscription":{ + "type":"structure", + "members":{ + "SubscriptionId":{ + "shape":"IdType", + "documentation":"

    The ID of the subscription.

    " + }, + "EndPoint":{ + "shape":"SubscriptionEndPointType", + "documentation":"

    The endpoint of the subscription.

    " + }, + "Protocol":{ + "shape":"SubscriptionProtocolType", + "documentation":"

    The protocol of the subscription.

    " + } + }, + "documentation":"

    Describes a subscription.

    " + }, + "SubscriptionEndPointType":{ + "type":"string", + "max":256, + "min":1 + }, + "SubscriptionList":{ + "type":"list", + "member":{"shape":"Subscription"}, + "max":256 + }, + "SubscriptionProtocolType":{ + "type":"string", + "enum":["HTTPS"] + }, + "SubscriptionType":{ + "type":"string", + "enum":["ALL"] + }, + "TimeZoneIdType":{ + "type":"string", + "max":256, + "min":1 + }, + "TimestampType":{"type":"timestamp"}, + "TooManyLabelsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The limit has been reached on the number of labels for the specified resource.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TooManySubscriptionsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    You've reached the limit on the number of subscriptions for the WorkDocs instance.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedOperationException":{ + "type":"structure", + "members":{ + }, + "documentation":"

    The operation is not permitted.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "UnauthorizedResourceAccessException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessageType"} + }, + "documentation":"

    The caller does not have access to perform the action on the resource.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "UpdateDocumentRequest":{ + "type":"structure", + "required":["DocumentId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the document.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"

    The resource state of the document. Only ACTIVE and RECYCLED are supported.

    " + } + } + }, + "UpdateDocumentVersionRequest":{ + "type":"structure", + "required":[ + "DocumentId", + "VersionId" + ], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "DocumentId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the document.

    ", + "location":"uri", + "locationName":"DocumentId" + }, + "VersionId":{ + "shape":"DocumentVersionIdType", + "documentation":"

    The version ID of the document.

    ", + "location":"uri", + "locationName":"VersionId" + }, + "VersionStatus":{ + "shape":"DocumentVersionStatus", + "documentation":"

    The status of the version.

    " + } + } + }, + "UpdateFolderRequest":{ + "type":"structure", + "required":["FolderId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "FolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the folder.

    ", + "location":"uri", + "locationName":"FolderId" + }, + "Name":{ + "shape":"ResourceNameType", + "documentation":"

    The name of the folder.

    " + }, + "ParentFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the parent folder.

    " + }, + "ResourceState":{ + "shape":"ResourceStateType", + "documentation":"

    The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

    " + } + } + }, + "UpdateUserRequest":{ + "type":"structure", + "required":["UserId"], + "members":{ + "AuthenticationToken":{ + "shape":"AuthenticationHeaderType", + "documentation":"

    Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

    ", + "location":"header", + "locationName":"Authentication" + }, + "UserId":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    ", + "location":"uri", + "locationName":"UserId" + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"

    The given name of the user.

    " + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"

    The surname of the user.

    " + }, + "Type":{ + "shape":"UserType", + "documentation":"

    The type of the user.

    " + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"

    The amount of storage for the user.

    " + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"

    The time zone ID of the user.

    " + }, + "Locale":{ + "shape":"LocaleType", + "documentation":"

    The locale of the user.

    " + }, + "GrantPoweruserPrivileges":{ + "shape":"BooleanEnumType", + "documentation":"

    Boolean value to determine whether the user is granted Poweruser privileges.

    " + } + } + }, + "UpdateUserResponse":{ + "type":"structure", + "members":{ + "User":{ + "shape":"User", + "documentation":"

    The user information.

    " + } + } + }, + "UploadMetadata":{ + "type":"structure", + "members":{ + "UploadUrl":{ + "shape":"UrlType", + "documentation":"

    The URL of the upload.

    " + }, + "SignedHeaders":{ + "shape":"SignedHeaderMap", + "documentation":"

    The signed headers.

    " + } + }, + "documentation":"

    Describes the upload.

    " + }, + "UrlType":{ + "type":"string", + "max":1024, + "min":1, + "sensitive":true + }, + "User":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    " + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

    The login name of the user.

    " + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"

    The email address of the user.

    " + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"

    The given name of the user.

    " + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"

    The surname of the user.

    " + }, + "OrganizationId":{ + "shape":"IdType", + "documentation":"

    The ID of the organization.

    " + }, + "RootFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the root folder.

    " + }, + "RecycleBinFolderId":{ + "shape":"ResourceIdType", + "documentation":"

    The ID of the recycle bin folder.

    " + }, + "Status":{ + "shape":"UserStatusType", + "documentation":"

    The status of the user.

    " + }, + "Type":{ + "shape":"UserType", + "documentation":"

    The type of user.

    " + }, + "CreatedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the user was created.

    " + }, + "ModifiedTimestamp":{ + "shape":"TimestampType", + "documentation":"

    The time when the user was modified.

    " + }, + "TimeZoneId":{ + "shape":"TimeZoneIdType", + "documentation":"

    The time zone ID of the user.

    " + }, + "Locale":{ + "shape":"LocaleType", + "documentation":"

    The locale of the user.

    " + }, + "Storage":{ + "shape":"UserStorageMetadata", + "documentation":"

    The storage for the user.

    " + } + }, + "documentation":"

    Describes a user.

    " + }, + "UserActivities":{ + "type":"list", + "member":{"shape":"Activity"} + }, + "UserAttributeValueType":{ + "type":"string", + "max":64, + "min":1 + }, + "UserFilterType":{ + "type":"string", + "enum":[ + "ALL", + "ACTIVE_PENDING" + ] + }, + "UserIdsType":{ + "type":"string", + "max":2000, + "min":1, + "pattern":"[&\\w+-.@, ]+" + }, + "UserMetadata":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"IdType", + "documentation":"

    The ID of the user.

    " + }, + "Username":{ + "shape":"UsernameType", + "documentation":"

    The name of the user.

    " + }, + "GivenName":{ + "shape":"UserAttributeValueType", + "documentation":"

    The given name of the user before a rename operation.

    " + }, + "Surname":{ + "shape":"UserAttributeValueType", + "documentation":"

    The surname of the user.

    " + }, + "EmailAddress":{ + "shape":"EmailAddressType", + "documentation":"

    The email address of the user.

    " + } + }, + "documentation":"

    Describes the metadata of the user.

    " + }, + "UserMetadataList":{ + "type":"list", + "member":{"shape":"UserMetadata"} + }, + "UserSortType":{ + "type":"string", + "enum":[ + "USER_NAME", + "FULL_NAME", + "STORAGE_LIMIT", + "USER_STATUS", + "STORAGE_USED" + ] + }, + "UserStatusType":{ + "type":"string", + "enum":[ + "ACTIVE", + "INACTIVE", + "PENDING" + ] + }, + "UserStorageMetadata":{ + "type":"structure", + "members":{ + "StorageUtilizedInBytes":{ + "shape":"SizeType", + "documentation":"

    The amount of storage used, in bytes.

    " + }, + "StorageRule":{ + "shape":"StorageRuleType", + "documentation":"

    The storage for a user.

    " + } + }, + "documentation":"

    Describes the storage for a user.

    " + }, + "UserType":{ + "type":"string", + "enum":[ + "USER", + "ADMIN", + "POWERUSER", + "MINIMALUSER", + "WORKSPACESUSER" + ] + }, + "UsernameType":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\w\\-+.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z]+)?" + } + }, + "documentation":"

    The WorkDocs API is designed for the following use cases:

    • File Migration: File migration applications are supported for users who want to migrate their files from an on-premises or off-premises file system or service. Users can insert files into a user directory structure, as well as allow for basic metadata changes, such as modifications to the permissions of files.

    • Security: Support security applications are supported for users who have additional security needs, such as antivirus or data loss prevention. The API actions, along with AWS CloudTrail, allow these applications to detect when changes occur in Amazon WorkDocs. Then, the application can take the necessary actions and replace the target file. If the target file violates the policy, the application can also choose to email the user.

    • eDiscovery/Analytics: General administrative applications are supported, such as eDiscovery and analytics. These applications can choose to mimic or record the actions in an Amazon WorkDocs site, along with AWS CloudTrail, to replicate data for eDiscovery, backup, or analytical applications.

    All Amazon WorkDocs API actions are Amazon authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of IAM users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the Amazon WorkDocs site, the IAM user gains full administrative visibility into the entire Amazon WorkDocs site (or as set in the IAM policy). This includes, but is not limited to, the ability to modify file permissions and upload any file to any user. This allows developers to perform the three use cases above, as well as give users the ability to grant access on a selective basis using the IAM model.

    " +} diff --git a/aws/dist/botocore/data/worklink/2018-09-25/paginators-1.json b/aws/dist/botocore/data/worklink/2018-09-25/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/worklink/2018-09-25/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/worklink/2018-09-25/service-2.json b/aws/dist/botocore/data/worklink/2018-09-25/service-2.json new file mode 100644 index 00000000..6383c105 --- /dev/null +++ b/aws/dist/botocore/data/worklink/2018-09-25/service-2.json @@ -0,0 +1,1707 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2018-09-25", + "endpointPrefix":"worklink", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"WorkLink", + "serviceFullName":"Amazon WorkLink", + "serviceId":"WorkLink", + "signatureVersion":"v4", + "signingName":"worklink", + "uid":"worklink-2018-09-25" + }, + "operations":{ + "AssociateDomain":{ + "name":"AssociateDomain", + "http":{ + "method":"POST", + "requestUri":"/associateDomain" + }, + "input":{"shape":"AssociateDomainRequest"}, + "output":{"shape":"AssociateDomainResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Specifies a domain to be associated to Amazon WorkLink.

    " + }, + "AssociateWebsiteAuthorizationProvider":{ + "name":"AssociateWebsiteAuthorizationProvider", + "http":{ + "method":"POST", + "requestUri":"/associateWebsiteAuthorizationProvider" + }, + "input":{"shape":"AssociateWebsiteAuthorizationProviderRequest"}, + "output":{"shape":"AssociateWebsiteAuthorizationProviderResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Associates a website authorization provider with a specified fleet. This is used to authorize users against associated websites in the company network.

    " + }, + "AssociateWebsiteCertificateAuthority":{ + "name":"AssociateWebsiteCertificateAuthority", + "http":{ + "method":"POST", + "requestUri":"/associateWebsiteCertificateAuthority" + }, + "input":{"shape":"AssociateWebsiteCertificateAuthorityRequest"}, + "output":{"shape":"AssociateWebsiteCertificateAuthorityResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Imports the root certificate of a certificate authority (CA) used to obtain TLS certificates used by associated websites within the company network.

    " + }, + "CreateFleet":{ + "name":"CreateFleet", + "http":{ + "method":"POST", + "requestUri":"/createFleet" + }, + "input":{"shape":"CreateFleetRequest"}, + "output":{"shape":"CreateFleetResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Creates a fleet. A fleet consists of resources and the configuration that delivers associated websites to authorized users who download and set up the Amazon WorkLink app.

    " + }, + "DeleteFleet":{ + "name":"DeleteFleet", + "http":{ + "method":"POST", + "requestUri":"/deleteFleet" + }, + "input":{"shape":"DeleteFleetRequest"}, + "output":{"shape":"DeleteFleetResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Deletes a fleet. Prevents users from accessing previously associated websites.

    " + }, + "DescribeAuditStreamConfiguration":{ + "name":"DescribeAuditStreamConfiguration", + "http":{ + "method":"POST", + "requestUri":"/describeAuditStreamConfiguration" + }, + "input":{"shape":"DescribeAuditStreamConfigurationRequest"}, + "output":{"shape":"DescribeAuditStreamConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Describes the configuration for delivering audit streams to the customer account.

    " + }, + "DescribeCompanyNetworkConfiguration":{ + "name":"DescribeCompanyNetworkConfiguration", + "http":{ + "method":"POST", + "requestUri":"/describeCompanyNetworkConfiguration" + }, + "input":{"shape":"DescribeCompanyNetworkConfigurationRequest"}, + "output":{"shape":"DescribeCompanyNetworkConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Describes the networking configuration to access the internal websites associated with the specified fleet.

    " + }, + "DescribeDevice":{ + "name":"DescribeDevice", + "http":{ + "method":"POST", + "requestUri":"/describeDevice" + }, + "input":{"shape":"DescribeDeviceRequest"}, + "output":{"shape":"DescribeDeviceResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Provides information about a user's device.

    " + }, + "DescribeDevicePolicyConfiguration":{ + "name":"DescribeDevicePolicyConfiguration", + "http":{ + "method":"POST", + "requestUri":"/describeDevicePolicyConfiguration" + }, + "input":{"shape":"DescribeDevicePolicyConfigurationRequest"}, + "output":{"shape":"DescribeDevicePolicyConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Describes the device policy configuration for the specified fleet.

    " + }, + "DescribeDomain":{ + "name":"DescribeDomain", + "http":{ + "method":"POST", + "requestUri":"/describeDomain" + }, + "input":{"shape":"DescribeDomainRequest"}, + "output":{"shape":"DescribeDomainResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Provides information about the domain.

    " + }, + "DescribeFleetMetadata":{ + "name":"DescribeFleetMetadata", + "http":{ + "method":"POST", + "requestUri":"/describeFleetMetadata" + }, + "input":{"shape":"DescribeFleetMetadataRequest"}, + "output":{"shape":"DescribeFleetMetadataResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Provides basic information for the specified fleet, excluding identity provider, networking, and device configuration details.

    " + }, + "DescribeIdentityProviderConfiguration":{ + "name":"DescribeIdentityProviderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/describeIdentityProviderConfiguration" + }, + "input":{"shape":"DescribeIdentityProviderConfigurationRequest"}, + "output":{"shape":"DescribeIdentityProviderConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Describes the identity provider configuration of the specified fleet.

    " + }, + "DescribeWebsiteCertificateAuthority":{ + "name":"DescribeWebsiteCertificateAuthority", + "http":{ + "method":"POST", + "requestUri":"/describeWebsiteCertificateAuthority" + }, + "input":{"shape":"DescribeWebsiteCertificateAuthorityRequest"}, + "output":{"shape":"DescribeWebsiteCertificateAuthorityResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Provides information about the certificate authority.

    " + }, + "DisassociateDomain":{ + "name":"DisassociateDomain", + "http":{ + "method":"POST", + "requestUri":"/disassociateDomain" + }, + "input":{"shape":"DisassociateDomainRequest"}, + "output":{"shape":"DisassociateDomainResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Disassociates a domain from Amazon WorkLink. End users lose the ability to access the domain with Amazon WorkLink.

    " + }, + "DisassociateWebsiteAuthorizationProvider":{ + "name":"DisassociateWebsiteAuthorizationProvider", + "http":{ + "method":"POST", + "requestUri":"/disassociateWebsiteAuthorizationProvider" + }, + "input":{"shape":"DisassociateWebsiteAuthorizationProviderRequest"}, + "output":{"shape":"DisassociateWebsiteAuthorizationProviderResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Disassociates a website authorization provider from a specified fleet. After the disassociation, users can't load any associated websites that require this authorization provider.

    " + }, + "DisassociateWebsiteCertificateAuthority":{ + "name":"DisassociateWebsiteCertificateAuthority", + "http":{ + "method":"POST", + "requestUri":"/disassociateWebsiteCertificateAuthority" + }, + "input":{"shape":"DisassociateWebsiteCertificateAuthorityRequest"}, + "output":{"shape":"DisassociateWebsiteCertificateAuthorityResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Removes a certificate authority (CA).

    " + }, + "ListDevices":{ + "name":"ListDevices", + "http":{ + "method":"POST", + "requestUri":"/listDevices" + }, + "input":{"shape":"ListDevicesRequest"}, + "output":{"shape":"ListDevicesResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves a list of devices registered with the specified fleet.

    " + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/listDomains" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves a list of domains associated to a specified fleet.

    " + }, + "ListFleets":{ + "name":"ListFleets", + "http":{ + "method":"POST", + "requestUri":"/listFleets" + }, + "input":{"shape":"ListFleetsRequest"}, + "output":{"shape":"ListFleetsResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves a list of fleets for the current account and Region.

    " + }, + "ListWebsiteAuthorizationProviders":{ + "name":"ListWebsiteAuthorizationProviders", + "http":{ + "method":"POST", + "requestUri":"/listWebsiteAuthorizationProviders" + }, + "input":{"shape":"ListWebsiteAuthorizationProvidersRequest"}, + "output":{"shape":"ListWebsiteAuthorizationProvidersResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves a list of website authorization providers associated with a specified fleet.

    " + }, + "ListWebsiteCertificateAuthorities":{ + "name":"ListWebsiteCertificateAuthorities", + "http":{ + "method":"POST", + "requestUri":"/listWebsiteCertificateAuthorities" + }, + "input":{"shape":"ListWebsiteCertificateAuthoritiesRequest"}, + "output":{"shape":"ListWebsiteCertificateAuthoritiesResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Retrieves a list of certificate authorities added for the current account and Region.

    " + }, + "RestoreDomainAccess":{ + "name":"RestoreDomainAccess", + "http":{ + "method":"POST", + "requestUri":"/restoreDomainAccess" + }, + "input":{"shape":"RestoreDomainAccessRequest"}, + "output":{"shape":"RestoreDomainAccessResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Moves a domain to ACTIVE status if it was in the INACTIVE status.

    " + }, + "RevokeDomainAccess":{ + "name":"RevokeDomainAccess", + "http":{ + "method":"POST", + "requestUri":"/revokeDomainAccess" + }, + "input":{"shape":"RevokeDomainAccessRequest"}, + "output":{"shape":"RevokeDomainAccessResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Moves a domain to INACTIVE status if it was in the ACTIVE status.

    " + }, + "SignOutUser":{ + "name":"SignOutUser", + "http":{ + "method":"POST", + "requestUri":"/signOutUser" + }, + "input":{"shape":"SignOutUserRequest"}, + "output":{"shape":"SignOutUserResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Signs the user out from all of their devices. The user can sign in again if they have valid credentials.

    " + }, + "UpdateAuditStreamConfiguration":{ + "name":"UpdateAuditStreamConfiguration", + "http":{ + "method":"POST", + "requestUri":"/updateAuditStreamConfiguration" + }, + "input":{"shape":"UpdateAuditStreamConfigurationRequest"}, + "output":{"shape":"UpdateAuditStreamConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates the audit stream configuration for the fleet.

    " + }, + "UpdateCompanyNetworkConfiguration":{ + "name":"UpdateCompanyNetworkConfiguration", + "http":{ + "method":"POST", + "requestUri":"/updateCompanyNetworkConfiguration" + }, + "input":{"shape":"UpdateCompanyNetworkConfigurationRequest"}, + "output":{"shape":"UpdateCompanyNetworkConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates the company network configuration for the fleet.

    " + }, + "UpdateDevicePolicyConfiguration":{ + "name":"UpdateDevicePolicyConfiguration", + "http":{ + "method":"POST", + "requestUri":"/updateDevicePolicyConfiguration" + }, + "input":{"shape":"UpdateDevicePolicyConfigurationRequest"}, + "output":{"shape":"UpdateDevicePolicyConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates the device policy configuration for the fleet.

    " + }, + "UpdateDomainMetadata":{ + "name":"UpdateDomainMetadata", + "http":{ + "method":"POST", + "requestUri":"/updateDomainMetadata" + }, + "input":{"shape":"UpdateDomainMetadataRequest"}, + "output":{"shape":"UpdateDomainMetadataResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates domain metadata, such as DisplayName.

    " + }, + "UpdateFleetMetadata":{ + "name":"UpdateFleetMetadata", + "http":{ + "method":"POST", + "requestUri":"/UpdateFleetMetadata" + }, + "input":{"shape":"UpdateFleetMetadataRequest"}, + "output":{"shape":"UpdateFleetMetadataResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates fleet metadata, such as DisplayName.

    " + }, + "UpdateIdentityProviderConfiguration":{ + "name":"UpdateIdentityProviderConfiguration", + "http":{ + "method":"POST", + "requestUri":"/updateIdentityProviderConfiguration" + }, + "input":{"shape":"UpdateIdentityProviderConfigurationRequest"}, + "output":{"shape":"UpdateIdentityProviderConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedException"}, + {"shape":"InternalServerErrorException"}, + {"shape":"InvalidRequestException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"TooManyRequestsException"} + ], + "documentation":"

    Updates the identity provider configuration for the fleet.

    " + } + }, + "shapes":{ + "AcmCertificateArn":{ + "type":"string", + "pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*" + }, + "AssociateDomainRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName", + "AcmCertificateArn" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The Amazon Resource Name (ARN) of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The fully qualified domain name (FQDN).

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + }, + "AcmCertificateArn":{ + "shape":"AcmCertificateArn", + "documentation":"

    The ARN of an issued ACM certificate that is valid for the domain being associated.

    " + } + } + }, + "AssociateDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateWebsiteAuthorizationProviderRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "AuthorizationProviderType" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "AuthorizationProviderType":{ + "shape":"AuthorizationProviderType", + "documentation":"

    The authorization provider type.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain name of the authorization provider. This applies only to SAML-based authorization providers.

    " + } + } + }, + "AssociateWebsiteAuthorizationProviderResponse":{ + "type":"structure", + "members":{ + "AuthorizationProviderId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the authorization provider.

    " + } + } + }, + "AssociateWebsiteCertificateAuthorityRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "Certificate" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "Certificate":{ + "shape":"Certificate", + "documentation":"

    The root certificate of the CA.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The certificate name to display.

    " + } + } + }, + "AssociateWebsiteCertificateAuthorityResponse":{ + "type":"structure", + "members":{ + "WebsiteCaId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the CA.

    " + } + } + }, + "AuditStreamArn":{"type":"string"}, + "AuthorizationProviderType":{ + "type":"string", + "enum":["SAML"] + }, + "Boolean":{"type":"boolean"}, + "Certificate":{ + "type":"string", + "max":8192, + "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)?" + }, + "CertificateChain":{ + "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)*-{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)?" + }, + "CompanyCode":{ + "type":"string", + "max":32, + "min":1 + }, + "CreateFleetRequest":{ + "type":"structure", + "required":["FleetName"], + "members":{ + "FleetName":{ + "shape":"FleetName", + "documentation":"

    A unique name for the fleet.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The fleet name to display.

    " + }, + "OptimizeForEndUserLocation":{ + "shape":"Boolean", + "documentation":"

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

    " + } + } + }, + "CreateFleetResponse":{ + "type":"structure", + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DateTime":{"type":"timestamp"}, + "DeleteFleetRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DeleteFleetResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeAuditStreamConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DescribeAuditStreamConfigurationResponse":{ + "type":"structure", + "members":{ + "AuditStreamArn":{ + "shape":"AuditStreamArn", + "documentation":"

    The ARN of the Amazon Kinesis data stream that will receive the audit events.

    " + } + } + }, + "DescribeCompanyNetworkConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DescribeCompanyNetworkConfigurationResponse":{ + "type":"structure", + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

    The VPC with connectivity to associated websites.

    " + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

    The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

    " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

    The security groups associated with access to the provided subnets.

    " + } + } + }, + "DescribeDevicePolicyConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DescribeDevicePolicyConfigurationResponse":{ + "type":"structure", + "members":{ + "DeviceCaCertificate":{ + "shape":"Certificate", + "documentation":"

    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

    " + } + } + }, + "DescribeDeviceRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DeviceId" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DeviceId":{ + "shape":"Id", + "documentation":"

    A unique identifier for a registered user's device.

    " + } + } + }, + "DescribeDeviceResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"DeviceStatus", + "documentation":"

    The current state of the device.

    " + }, + "Model":{ + "shape":"DeviceModel", + "documentation":"

    The model of the device.

    " + }, + "Manufacturer":{ + "shape":"DeviceManufacturer", + "documentation":"

    The manufacturer of the device.

    " + }, + "OperatingSystem":{ + "shape":"DeviceOperatingSystemName", + "documentation":"

    The operating system of the device.

    " + }, + "OperatingSystemVersion":{ + "shape":"DeviceOperatingSystemVersion", + "documentation":"

    The operating system version of the device.

    " + }, + "PatchLevel":{ + "shape":"DevicePatchLevel", + "documentation":"

    The operating system patch level of the device.

    " + }, + "FirstAccessedTime":{ + "shape":"DateTime", + "documentation":"

    The date that the device first signed in to Amazon WorkLink.

    " + }, + "LastAccessedTime":{ + "shape":"DateTime", + "documentation":"

    The date that the device last accessed Amazon WorkLink.

    " + }, + "Username":{ + "shape":"Username", + "documentation":"

    The user name associated with the device.

    " + } + } + }, + "DescribeDomainRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + } + } + }, + "DescribeDomainResponse":{ + "type":"structure", + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time that the domain was added.

    " + }, + "DomainStatus":{ + "shape":"DomainStatus", + "documentation":"

    The current state for the domain.

    " + }, + "AcmCertificateArn":{ + "shape":"AcmCertificateArn", + "documentation":"

    The ARN of an issued ACM certificate that is valid for the domain being associated.

    " + } + } + }, + "DescribeFleetMetadataRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DescribeFleetMetadataResponse":{ + "type":"structure", + "members":{ + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time that the fleet was created.

    " + }, + "LastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time that the fleet was last updated.

    " + }, + "FleetName":{ + "shape":"FleetName", + "documentation":"

    The name of the fleet.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + }, + "OptimizeForEndUserLocation":{ + "shape":"Boolean", + "documentation":"

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

    " + }, + "CompanyCode":{ + "shape":"CompanyCode", + "documentation":"

    The identifier used by users to sign in to the Amazon WorkLink app.

    " + }, + "FleetStatus":{ + "shape":"FleetStatus", + "documentation":"

    The current state of the fleet.

    " + } + } + }, + "DescribeIdentityProviderConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + } + } + }, + "DescribeIdentityProviderConfigurationResponse":{ + "type":"structure", + "members":{ + "IdentityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"

    The type of identity provider.

    " + }, + "ServiceProviderSamlMetadata":{ + "shape":"SamlMetadata", + "documentation":"

    The SAML metadata document uploaded to the user’s identity provider.

    " + }, + "IdentityProviderSamlMetadata":{ + "shape":"SamlMetadata", + "documentation":"

    The SAML metadata document provided by the user’s identity provider.

    " + } + } + }, + "DescribeWebsiteCertificateAuthorityRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "WebsiteCaId" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "WebsiteCaId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the certificate authority.

    " + } + } + }, + "DescribeWebsiteCertificateAuthorityResponse":{ + "type":"structure", + "members":{ + "Certificate":{ + "shape":"Certificate", + "documentation":"

    The root certificate of the certificate authority.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time that the certificate authority was added.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The certificate name to display.

    " + } + } + }, + "DeviceManufacturer":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceModel":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceOperatingSystemName":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceOperatingSystemVersion":{ + "type":"string", + "max":256, + "min":1 + }, + "DevicePatchLevel":{ + "type":"string", + "max":256, + "min":1 + }, + "DeviceStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "SIGNED_OUT" + ] + }, + "DeviceSummary":{ + "type":"structure", + "members":{ + "DeviceId":{ + "shape":"Id", + "documentation":"

    The ID of the device.

    " + }, + "DeviceStatus":{ + "shape":"DeviceStatus", + "documentation":"

    The status of the device.

    " + } + }, + "documentation":"

    The summary of devices.

    " + }, + "DeviceSummaryList":{ + "type":"list", + "member":{"shape":"DeviceSummary"} + }, + "DisassociateDomainRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + } + } + }, + "DisassociateDomainResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateWebsiteAuthorizationProviderRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "AuthorizationProviderId" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "AuthorizationProviderId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the authorization provider.

    " + } + } + }, + "DisassociateWebsiteAuthorizationProviderResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateWebsiteCertificateAuthorityRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "WebsiteCaId" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "WebsiteCaId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the CA.

    " + } + } + }, + "DisassociateWebsiteCertificateAuthorityResponse":{ + "type":"structure", + "members":{ + } + }, + "DisplayName":{ + "type":"string", + "max":100 + }, + "DomainName":{ + "type":"string", + "max":253, + "min":1, + "pattern":"^[a-zA-Z0-9]?((?!-)([A-Za-z0-9-]*[A-Za-z0-9])\\.)+[a-zA-Z0-9]+$" + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "PENDING_VALIDATION", + "ASSOCIATING", + "ACTIVE", + "INACTIVE", + "DISASSOCIATING", + "DISASSOCIATED", + "FAILED_TO_ASSOCIATE", + "FAILED_TO_DISASSOCIATE" + ] + }, + "DomainSummary":{ + "type":"structure", + "required":[ + "DomainName", + "CreatedTime", + "DomainStatus" + ], + "members":{ + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time that the domain was created.

    " + }, + "DomainStatus":{ + "shape":"DomainStatus", + "documentation":"

    The status of the domain.

    " + } + }, + "documentation":"

    The summary of the domain.

    " + }, + "DomainSummaryList":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "ExceptionMessage":{"type":"string"}, + "FleetArn":{ + "type":"string", + "max":2048, + "min":20 + }, + "FleetName":{ + "type":"string", + "max":48, + "min":1, + "pattern":"^[a-z0-9](?:[a-z0-9\\-]{0,46}[a-z0-9])?$" + }, + "FleetStatus":{ + "type":"string", + "enum":[ + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED_TO_CREATE", + "FAILED_TO_DELETE" + ] + }, + "FleetSummary":{ + "type":"structure", + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the fleet was created.

    " + }, + "LastUpdatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the fleet was last updated.

    " + }, + "FleetName":{ + "shape":"FleetName", + "documentation":"

    The name of the fleet.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + }, + "CompanyCode":{ + "shape":"CompanyCode", + "documentation":"

    The identifier used by users to sign into the Amazon WorkLink app.

    " + }, + "FleetStatus":{ + "shape":"FleetStatus", + "documentation":"

    The status of the fleet.

    " + } + }, + "documentation":"

    The summary of the fleet.

    " + }, + "FleetSummaryList":{ + "type":"list", + "member":{"shape":"FleetSummary"} + }, + "Id":{ + "type":"string", + "max":256, + "min":1 + }, + "IdentityProviderType":{ + "type":"string", + "enum":["SAML"] + }, + "InternalServerErrorException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The service is temporarily unavailable.

    ", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The request is not valid.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ListDevicesRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be included in the next page.

    " + } + } + }, + "ListDevicesResponse":{ + "type":"structure", + "members":{ + "Devices":{ + "shape":"DeviceSummaryList", + "documentation":"

    Information about the devices.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    " + } + } + }, + "ListDomainsRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be included in the next page.

    " + } + } + }, + "ListDomainsResponse":{ + "type":"structure", + "members":{ + "Domains":{ + "shape":"DomainSummaryList", + "documentation":"

    Information about the domains.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    " + } + } + }, + "ListFleetsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be included in the next page.

    " + } + } + }, + "ListFleetsResponse":{ + "type":"structure", + "members":{ + "FleetSummaryList":{ + "shape":"FleetSummaryList", + "documentation":"

    The summary list of the fleets.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    " + } + } + }, + "ListWebsiteAuthorizationProvidersRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be included in the next page.

    " + } + } + }, + "ListWebsiteAuthorizationProvidersResponse":{ + "type":"structure", + "members":{ + "WebsiteAuthorizationProviders":{ + "shape":"WebsiteAuthorizationProvidersSummaryList", + "documentation":"

    The website authorization providers.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + } + } + }, + "ListWebsiteCertificateAuthoritiesRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to be included in the next page.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

    " + } + } + }, + "ListWebsiteCertificateAuthoritiesResponse":{ + "type":"structure", + "members":{ + "WebsiteCertificateAuthorities":{ + "shape":"WebsiteCaSummaryList", + "documentation":"

    Information about the certificates.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The pagination token used to retrieve the next page of results for this operation. If there are no more pages, this value is null.

    " + } + } + }, + "MaxResults":{ + "type":"integer", + "min":1 + }, + "NextToken":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"[\\w\\-]+" + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The resource already exists.

    ", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The requested resource was not found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "RestoreDomainAccessRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + } + } + }, + "RestoreDomainAccessResponse":{ + "type":"structure", + "members":{ + } + }, + "RevokeDomainAccessRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + } + } + }, + "RevokeDomainAccessResponse":{ + "type":"structure", + "members":{ + } + }, + "SamlMetadata":{ + "type":"string", + "max":204800, + "min":1 + }, + "SecurityGroupId":{ + "type":"string", + "pattern":"^sg-([0-9a-f]{8}|[0-9a-f]{17})$" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5 + }, + "SignOutUserRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "Username" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "Username":{ + "shape":"Username", + "documentation":"

    The name of the user.

    " + } + } + }, + "SignOutUserResponse":{ + "type":"structure", + "members":{ + } + }, + "SubnetId":{ + "type":"string", + "pattern":"^subnet-([0-9a-f]{8}|[0-9a-f]{17})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "TooManyRequestsException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The number of requests exceeds the limit.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "UnauthorizedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    You are not authorized to perform this action.

    ", + "error":{"httpStatusCode":403}, + "exception":true + }, + "UpdateAuditStreamConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "AuditStreamArn":{ + "shape":"AuditStreamArn", + "documentation":"

    The ARN of the Amazon Kinesis data stream that receives the audit events.

    " + } + } + }, + "UpdateAuditStreamConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateCompanyNetworkConfigurationRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "VpcId", + "SubnetIds", + "SecurityGroupIds" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

    The VPC with connectivity to associated websites.

    " + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

    The subnets used for X-ENI connections from Amazon WorkLink rendering containers.

    " + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

    The security groups associated with access to the provided subnets.

    " + } + } + }, + "UpdateCompanyNetworkConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDevicePolicyConfigurationRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DeviceCaCertificate":{ + "shape":"CertificateChain", + "documentation":"

    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

    " + } + } + }, + "UpdateDevicePolicyConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDomainMetadataRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "DomainName" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The name of the domain.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + } + } + }, + "UpdateDomainMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateFleetMetadataRequest":{ + "type":"structure", + "required":["FleetArn"], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The fleet name to display. The existing DisplayName is unset if null is passed.

    " + }, + "OptimizeForEndUserLocation":{ + "shape":"Boolean", + "documentation":"

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region.

    " + } + } + }, + "UpdateFleetMetadataResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateIdentityProviderConfigurationRequest":{ + "type":"structure", + "required":[ + "FleetArn", + "IdentityProviderType" + ], + "members":{ + "FleetArn":{ + "shape":"FleetArn", + "documentation":"

    The ARN of the fleet.

    " + }, + "IdentityProviderType":{ + "shape":"IdentityProviderType", + "documentation":"

    The type of identity provider.

    " + }, + "IdentityProviderSamlMetadata":{ + "shape":"SamlMetadata", + "documentation":"

    The SAML metadata document provided by the customer’s identity provider. The existing IdentityProviderSamlMetadata is unset if null is passed.

    " + } + } + }, + "UpdateIdentityProviderConfigurationResponse":{ + "type":"structure", + "members":{ + } + }, + "Username":{ + "type":"string", + "max":256, + "min":1 + }, + "VpcId":{ + "type":"string", + "pattern":"^vpc-([0-9a-f]{8}|[0-9a-f]{17})$" + }, + "WebsiteAuthorizationProviderSummary":{ + "type":"structure", + "required":["AuthorizationProviderType"], + "members":{ + "AuthorizationProviderId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the authorization provider.

    " + }, + "AuthorizationProviderType":{ + "shape":"AuthorizationProviderType", + "documentation":"

    The authorization provider type.

    " + }, + "DomainName":{ + "shape":"DomainName", + "documentation":"

    The domain name of the authorization provider. This applies only to SAML-based authorization providers.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time of creation.

    " + } + }, + "documentation":"

    The summary of the website authorization provider.

    " + }, + "WebsiteAuthorizationProvidersSummaryList":{ + "type":"list", + "member":{"shape":"WebsiteAuthorizationProviderSummary"} + }, + "WebsiteCaSummary":{ + "type":"structure", + "members":{ + "WebsiteCaId":{ + "shape":"Id", + "documentation":"

    A unique identifier for the CA.

    " + }, + "CreatedTime":{ + "shape":"DateTime", + "documentation":"

    The time when the CA was added.

    " + }, + "DisplayName":{ + "shape":"DisplayName", + "documentation":"

    The name to display.

    " + } + }, + "documentation":"

    The summary of the certificate authority (CA).

    " + }, + "WebsiteCaSummaryList":{ + "type":"list", + "member":{"shape":"WebsiteCaSummary"} + } + }, + "documentation":"

    Amazon WorkLink is a cloud-based service that provides secure access to internal websites and web apps from iOS phones. In a single step, your users, such as employees, can access internal websites as efficiently as they access any other public website. They enter a URL in their web browser, or choose a link to an internal website in an email. Amazon WorkLink authenticates the user's access and securely renders authorized internal web content in a secure rendering service in the AWS cloud. Amazon WorkLink doesn't download or store any internal web content on mobile devices.

    " +} diff --git a/aws/dist/botocore/data/workmail/2017-10-01/paginators-1.json b/aws/dist/botocore/data/workmail/2017-10-01/paginators-1.json new file mode 100644 index 00000000..511c0ef6 --- /dev/null +++ b/aws/dist/botocore/data/workmail/2017-10-01/paginators-1.json @@ -0,0 +1,52 @@ +{ + "pagination": { + "ListUsers": { + "result_key": "Users", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroupMembers": { + "result_key": "Members", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListOrganizations": { + "result_key": "OrganizationSummaries", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListGroups": { + "result_key": "Groups", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListResources": { + "result_key": "Resources", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListAliases": { + "result_key": "Aliases", + "output_token": "NextToken", + "input_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListMailboxPermissions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Permissions" + }, + "ListResourceDelegates": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Delegates" + } + } +} diff --git a/aws/dist/botocore/data/workmail/2017-10-01/service-2.json b/aws/dist/botocore/data/workmail/2017-10-01/service-2.json new file mode 100644 index 00000000..b9ca6278 --- /dev/null +++ b/aws/dist/botocore/data/workmail/2017-10-01/service-2.json @@ -0,0 +1,2170 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2017-10-01", + "endpointPrefix":"workmail", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon WorkMail", + "serviceId":"WorkMail", + "signatureVersion":"v4", + "targetPrefix":"WorkMailService", + "uid":"workmail-2017-10-01" + }, + "operations":{ + "AssociateDelegateToResource":{ + "name":"AssociateDelegateToResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateDelegateToResourceRequest"}, + "output":{"shape":"AssociateDelegateToResourceResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Adds a member (user or group) to the resource's set of delegates.

    ", + "idempotent":true + }, + "AssociateMemberToGroup":{ + "name":"AssociateMemberToGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateMemberToGroupRequest"}, + "output":{"shape":"AssociateMemberToGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Adds a member (user or group) to the group's set.

    ", + "idempotent":true + }, + "CreateAlias":{ + "name":"CreateAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAliasRequest"}, + "output":{"shape":"CreateAliasResponse"}, + "errors":[ + {"shape":"EmailAddressInUseException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Adds an alias to the set of a given member (user or group) of Amazon WorkMail.

    ", + "idempotent":true + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{"shape":"CreateGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ReservedNameException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Creates a group that can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

    ", + "idempotent":true + }, + "CreateResource":{ + "name":"CreateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateResourceRequest"}, + "output":{"shape":"CreateResourceResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ReservedNameException"} + ], + "documentation":"

    Creates a new Amazon WorkMail resource.

    ", + "idempotent":true + }, + "CreateUser":{ + "name":"CreateUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateUserRequest"}, + "output":{"shape":"CreateUserResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"ReservedNameException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Creates a user who can be used in Amazon WorkMail by calling the RegisterToWorkMail operation.

    ", + "idempotent":true + }, + "DeleteAlias":{ + "name":"DeleteAlias", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteAliasRequest"}, + "output":{"shape":"DeleteAliasResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Remove one or more specified aliases from a set of aliases for a given user.

    ", + "idempotent":true + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Deletes a group from Amazon WorkMail.

    ", + "idempotent":true + }, + "DeleteMailboxPermissions":{ + "name":"DeleteMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteMailboxPermissionsRequest"}, + "output":{"shape":"DeleteMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Deletes permissions granted to a member (user or group).

    ", + "idempotent":true + }, + "DeleteResource":{ + "name":"DeleteResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteResourceRequest"}, + "output":{"shape":"DeleteResourceResponse"}, + "errors":[ + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Deletes the specified resource.

    ", + "idempotent":true + }, + "DeleteUser":{ + "name":"DeleteUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteUserRequest"}, + "output":{"shape":"DeleteUserResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Deletes a user from Amazon WorkMail and all subsequent systems. Before you can delete a user, the user state must be DISABLED. Use the DescribeUser action to confirm the user state.

    Deleting a user is permanent and cannot be undone. WorkMail archives user mailboxes for 30 days before they are permanently removed.

    ", + "idempotent":true + }, + "DeregisterFromWorkMail":{ + "name":"DeregisterFromWorkMail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeregisterFromWorkMailRequest"}, + "output":{"shape":"DeregisterFromWorkMailResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Mark a user, group, or resource as no longer used in Amazon WorkMail. This action disassociates the mailbox and schedules it for clean-up. WorkMail keeps mailboxes for 30 days before they are permanently removed. The functionality in the console is Disable.

    ", + "idempotent":true + }, + "DescribeGroup":{ + "name":"DescribeGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeGroupRequest"}, + "output":{"shape":"DescribeGroupResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns the data available for the group.

    ", + "idempotent":true + }, + "DescribeOrganization":{ + "name":"DescribeOrganization", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeOrganizationRequest"}, + "output":{"shape":"DescribeOrganizationResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"} + ], + "documentation":"

    Provides more information regarding a given organization based on its identifier.

    ", + "idempotent":true + }, + "DescribeResource":{ + "name":"DescribeResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeResourceRequest"}, + "output":{"shape":"DescribeResourceResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns the data available for the resource.

    ", + "idempotent":true + }, + "DescribeUser":{ + "name":"DescribeUser", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeUserRequest"}, + "output":{"shape":"DescribeUserResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Provides information regarding the user.

    ", + "idempotent":true + }, + "DisassociateDelegateFromResource":{ + "name":"DisassociateDelegateFromResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateDelegateFromResourceRequest"}, + "output":{"shape":"DisassociateDelegateFromResourceResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Removes a member from the resource's set of delegates.

    ", + "idempotent":true + }, + "DisassociateMemberFromGroup":{ + "name":"DisassociateMemberFromGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateMemberFromGroupRequest"}, + "output":{"shape":"DisassociateMemberFromGroupResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Removes a member from a group.

    ", + "idempotent":true + }, + "GetMailboxDetails":{ + "name":"GetMailboxDetails", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetMailboxDetailsRequest"}, + "output":{"shape":"GetMailboxDetailsResponse"}, + "errors":[ + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"} + ], + "documentation":"

    Requests a user's mailbox details for a specified organization and user.

    ", + "idempotent":true + }, + "ListAliases":{ + "name":"ListAliases", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAliasesRequest"}, + "output":{"shape":"ListAliasesResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Creates a paginated call to list the aliases associated with a given entity.

    ", + "idempotent":true + }, + "ListGroupMembers":{ + "name":"ListGroupMembers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupMembersRequest"}, + "output":{"shape":"ListGroupMembersResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns an overview of the members of a group. Users and groups can be members of a group.

    ", + "idempotent":true + }, + "ListGroups":{ + "name":"ListGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListGroupsRequest"}, + "output":{"shape":"ListGroupsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns summaries of the organization's groups.

    ", + "idempotent":true + }, + "ListMailboxPermissions":{ + "name":"ListMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListMailboxPermissionsRequest"}, + "output":{"shape":"ListMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Lists the mailbox permissions associated with a user, group, or resource mailbox.

    ", + "idempotent":true + }, + "ListOrganizations":{ + "name":"ListOrganizations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListOrganizationsRequest"}, + "output":{"shape":"ListOrganizationsResponse"}, + "errors":[ + {"shape":"InvalidParameterException"} + ], + "documentation":"

    Returns summaries of the customer's non-deleted organizations.

    ", + "idempotent":true + }, + "ListResourceDelegates":{ + "name":"ListResourceDelegates", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourceDelegatesRequest"}, + "output":{"shape":"ListResourceDelegatesResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Lists the delegates associated with a resource. Users and groups can be resource delegates and answer requests on behalf of the resource.

    ", + "idempotent":true + }, + "ListResources":{ + "name":"ListResources", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListResourcesRequest"}, + "output":{"shape":"ListResourcesResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns summaries of the organization's resources.

    ", + "idempotent":true + }, + "ListUsers":{ + "name":"ListUsers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListUsersRequest"}, + "output":{"shape":"ListUsersResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Returns summaries of the organization's users.

    ", + "idempotent":true + }, + "PutMailboxPermissions":{ + "name":"PutMailboxPermissions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutMailboxPermissionsRequest"}, + "output":{"shape":"PutMailboxPermissionsResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Sets permissions for a user, group, or resource. This replaces any pre-existing permissions.

    ", + "idempotent":true + }, + "RegisterToWorkMail":{ + "name":"RegisterToWorkMail", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RegisterToWorkMailRequest"}, + "output":{"shape":"RegisterToWorkMailResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"EntityAlreadyRegisteredException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Registers an existing and disabled user, group, or resource for Amazon WorkMail use by associating a mailbox and calendaring capabilities. It performs no change if the user, group, or resource is enabled and fails if the user, group, or resource is deleted. This operation results in the accumulation of costs. For more information, see Pricing. The equivalent console functionality for this operation is Enable.

    Users can either be created by calling the CreateUser API operation or they can be synchronized from your directory. For more information, see DeregisterFromWorkMail.

    ", + "idempotent":true + }, + "ResetPassword":{ + "name":"ResetPassword", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ResetPasswordRequest"}, + "output":{"shape":"ResetPasswordResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InvalidPasswordException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Allows the administrator to reset the password for a user.

    ", + "idempotent":true + }, + "UpdateMailboxQuota":{ + "name":"UpdateMailboxQuota", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateMailboxQuotaRequest"}, + "output":{"shape":"UpdateMailboxQuotaResponse"}, + "errors":[ + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"} + ], + "documentation":"

    Updates a user's current mailbox quota for a specified organization and user.

    ", + "idempotent":true + }, + "UpdatePrimaryEmailAddress":{ + "name":"UpdatePrimaryEmailAddress", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdatePrimaryEmailAddressRequest"}, + "output":{"shape":"UpdatePrimaryEmailAddressResponse"}, + "errors":[ + {"shape":"DirectoryServiceAuthenticationFailedException"}, + {"shape":"DirectoryUnavailableException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"InvalidParameterException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"}, + {"shape":"UnsupportedOperationException"} + ], + "documentation":"

    Updates the primary email for a user, group, or resource. The current email is moved into the list of aliases (or swapped between an existing alias and the current primary email), and the email provided in the input is promoted as the primary.

    ", + "idempotent":true + }, + "UpdateResource":{ + "name":"UpdateResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateResourceRequest"}, + "output":{"shape":"UpdateResourceResponse"}, + "errors":[ + {"shape":"DirectoryUnavailableException"}, + {"shape":"EntityNotFoundException"}, + {"shape":"EntityStateException"}, + {"shape":"InvalidConfigurationException"}, + {"shape":"EmailAddressInUseException"}, + {"shape":"MailDomainNotFoundException"}, + {"shape":"MailDomainStateException"}, + {"shape":"NameAvailabilityException"}, + {"shape":"OrganizationNotFoundException"}, + {"shape":"OrganizationStateException"} + ], + "documentation":"

    Updates data for the resource. To have the latest information, it must be preceded by a DescribeResource call. The dataset in the request should be the one expected when performing another DescribeResource call.

    ", + "idempotent":true + } + }, + "shapes":{ + "Aliases":{ + "type":"list", + "member":{"shape":"EmailAddress"} + }, + "AssociateDelegateToResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization under which the resource exists.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The resource for which members (users or groups) are associated.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The member (user or group) to associate to the resource.

    " + } + } + }, + "AssociateDelegateToResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "AssociateMemberToGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId", + "MemberId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization under which the group exists.

    " + }, + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The group to which the member (user or group) is associated.

    " + }, + "MemberId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The member (user or group) to associate to the group.

    " + } + } + }, + "AssociateMemberToGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "BookingOptions":{ + "type":"structure", + "members":{ + "AutoAcceptRequests":{ + "shape":"Boolean", + "documentation":"

    The resource's ability to automatically reply to requests. If disabled, delegates must be associated to the resource.

    " + }, + "AutoDeclineRecurringRequests":{ + "shape":"Boolean", + "documentation":"

    The resource's ability to automatically decline any recurring requests.

    " + }, + "AutoDeclineConflictingRequests":{ + "shape":"Boolean", + "documentation":"

    The resource's ability to automatically decline any conflicting requests.

    " + } + }, + "documentation":"

    At least one delegate must be associated to the resource to disable automatic replies from the resource.

    " + }, + "Boolean":{"type":"boolean"}, + "CreateAliasRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Alias" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization under which the member (user or group) exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The member (user or group) to which this alias is added.

    " + }, + "Alias":{ + "shape":"EmailAddress", + "documentation":"

    The alias to add to the member set.

    " + } + } + }, + "CreateAliasResponse":{ + "type":"structure", + "members":{ + } + }, + "CreateGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization under which the group is to be created.

    " + }, + "Name":{ + "shape":"GroupName", + "documentation":"

    The name of the group.

    " + } + } + }, + "CreateGroupResponse":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the group.

    " + } + } + }, + "CreateResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "Type" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier associated with the organization for which the resource is created.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the new resource.

    " + }, + "Type":{ + "shape":"ResourceType", + "documentation":"

    The type of the new resource. The available types are equipment and room.

    " + } + } + }, + "CreateResourceResponse":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the new resource.

    " + } + } + }, + "CreateUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "Name", + "DisplayName", + "Password" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of the organization for which the user is created.

    " + }, + "Name":{ + "shape":"UserName", + "documentation":"

    The name for the new user. Simple AD or AD Connector user names have a maximum length of 20. All others have a maximum length of 64.

    " + }, + "DisplayName":{ + "shape":"String", + "documentation":"

    The display name for the new user.

    " + }, + "Password":{ + "shape":"Password", + "documentation":"

    The password for the new user.

    " + } + } + }, + "CreateUserResponse":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the new user.

    " + } + } + }, + "Delegate":{ + "type":"structure", + "required":[ + "Id", + "Type" + ], + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    The identifier for the user or group associated as the resource's delegate.

    " + }, + "Type":{ + "shape":"MemberType", + "documentation":"

    The type of the delegate: user or group.

    " + } + }, + "documentation":"

    The name of the attribute, which is one of the values defined in the UserAttribute enumeration.

    " + }, + "DeleteAliasRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Alias" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the user exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the member (user or group) from which to have the aliases removed.

    " + }, + "Alias":{ + "shape":"EmailAddress", + "documentation":"

    The aliases to be removed from the user's set of aliases. Duplicate entries in the list are collapsed into single entries (the list is transformed into a set).

    " + } + } + }, + "DeleteAliasResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization that contains the group.

    " + }, + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the group to be deleted.

    " + } + } + }, + "DeleteGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "GranteeId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of the organization under which the member (user or group) exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the member (user or group)that owns the mailbox.

    " + }, + "GranteeId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the member (user or group) for which to delete granted permissions.

    " + } + } + }, + "DeleteMailboxPermissionsResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier associated with the organization from which the resource is deleted.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the resource to be deleted.

    " + } + } + }, + "DeleteResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization that contains the user to be deleted.

    " + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user to be deleted.

    " + } + } + }, + "DeleteUserResponse":{ + "type":"structure", + "members":{ + } + }, + "DeregisterFromWorkMailRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the Amazon WorkMail entity exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the member (user or group) to be updated.

    " + } + } + }, + "DeregisterFromWorkMailResponse":{ + "type":"structure", + "members":{ + } + }, + "DescribeGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the group exists.

    " + }, + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the group to be described.

    " + } + } + }, + "DescribeGroupResponse":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the described group.

    " + }, + "Name":{ + "shape":"GroupName", + "documentation":"

    The name of the described group.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the described group.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time when a user was registered to WorkMail, in UNIX epoch time format.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time when a user was deregistered from WorkMail, in UNIX epoch time format.

    " + } + } + }, + "DescribeOrganizationRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization to be described.

    " + } + } + }, + "DescribeOrganizationResponse":{ + "type":"structure", + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of an organization.

    " + }, + "Alias":{ + "shape":"OrganizationName", + "documentation":"

    The alias for an organization.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The state of an organization.

    " + }, + "DirectoryId":{ + "shape":"String", + "documentation":"

    The identifier for the directory associated with an Amazon WorkMail organization.

    " + }, + "DirectoryType":{ + "shape":"String", + "documentation":"

    The type of directory associated with the WorkMail organization.

    " + }, + "DefaultMailDomain":{ + "shape":"String", + "documentation":"

    The default mail domain associated with the organization.

    " + }, + "CompletedDate":{ + "shape":"Timestamp", + "documentation":"

    The date at which the organization became usable in the WorkMail context, in UNIX epoch time format.

    " + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

    (Optional) The error message indicating if unexpected behavior was encountered with regards to the organization.

    " + } + } + }, + "DescribeResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier associated with the organization for which the resource is described.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the resource to be described.

    " + } + } + }, + "DescribeResourceResponse":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the described resource.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the described resource.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the described resource.

    " + }, + "Type":{ + "shape":"ResourceType", + "documentation":"

    The type of the described resource.

    " + }, + "BookingOptions":{ + "shape":"BookingOptions", + "documentation":"

    The booking options for the described resource.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the resource: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time when a resource was enabled for WorkMail, in UNIX epoch time format.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time when a resource was disabled from WorkMail, in UNIX epoch time format.

    " + } + } + }, + "DescribeUserRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the user exists.

    " + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the user to be described.

    " + } + } + }, + "DescribeUserResponse":{ + "type":"structure", + "members":{ + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the described user.

    " + }, + "Name":{ + "shape":"UserName", + "documentation":"

    The name for the user.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the user.

    " + }, + "DisplayName":{ + "shape":"String", + "documentation":"

    The display name of the user.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of a user: enabled (registered to Amazon WorkMail) or disabled (deregistered or never registered to WorkMail).

    " + }, + "UserRole":{ + "shape":"UserRole", + "documentation":"

    In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into Amazon WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time at which the user was enabled for Amazon WorkMail usage, in UNIX epoch time format.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date and time at which the user was disabled for Amazon WorkMail usage, in UNIX epoch time format.

    " + } + } + }, + "DirectoryServiceAuthenticationFailedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The directory service doesn't recognize the credentials supplied by WorkMail.

    ", + "exception":true + }, + "DirectoryUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The directory on which you are trying to perform operations isn't available.

    ", + "exception":true + }, + "DisassociateDelegateFromResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the resource exists.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the resource from which delegates' set members are removed.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the member (user, group) to be removed from the resource's delegates.

    " + } + } + }, + "DisassociateDelegateFromResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "DisassociateMemberFromGroupRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId", + "MemberId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the group exists.

    " + }, + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the group from which members are removed.

    " + }, + "MemberId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the member to be removed to the group.

    " + } + } + }, + "DisassociateMemberFromGroupResponse":{ + "type":"structure", + "members":{ + } + }, + "EmailAddress":{ + "type":"string", + "max":254, + "min":1, + "pattern":"[a-zA-Z0-9._%+-]{1,64}@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}" + }, + "EmailAddressInUseException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The email address that you're trying to assign is already created for a different user, group, or resource.

    ", + "exception":true + }, + "EntityAlreadyRegisteredException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The user, group, or resource that you're trying to register is already registered.

    ", + "exception":true + }, + "EntityNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The identifier supplied for the user, group, or resource does not exist in your organization.

    ", + "exception":true + }, + "EntityState":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED", + "DELETED" + ] + }, + "EntityStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You are performing an operation on a user, group, or resource that isn't in the expected state, such as trying to delete an active user.

    ", + "exception":true + }, + "GetMailboxDetailsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization that contains the user whose mailbox details are being requested.

    " + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the user whose mailbox details are being requested.

    " + } + } + }, + "GetMailboxDetailsResponse":{ + "type":"structure", + "members":{ + "MailboxQuota":{ + "shape":"MailboxQuota", + "documentation":"

    The maximum allowed mailbox size, in MB, for the specified user.

    " + }, + "MailboxSize":{ + "shape":"MailboxSize", + "documentation":"

    The current mailbox size, in MB, for the specified user.

    " + } + } + }, + "Group":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the group.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the group.

    " + }, + "Name":{ + "shape":"GroupName", + "documentation":"

    The name of the group.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the group, which can be ENABLED, DISABLED, or DELETED.

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the group was enabled for Amazon WorkMail use.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the group was disabled from Amazon WorkMail use.

    " + } + }, + "documentation":"

    The representation of an Amazon WorkMail group.

    " + }, + "GroupName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"[\\u0020-\\u00FF]+" + }, + "Groups":{ + "type":"list", + "member":{"shape":"Group"} + }, + "InvalidConfigurationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The configuration for a resource isn't valid. A resource must either be able to auto-respond to requests or have at least one delegate associated that can do so on its behalf.

    ", + "exception":true + }, + "InvalidParameterException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    One or more of the input parameters don't match the service's restrictions.

    ", + "exception":true + }, + "InvalidPasswordException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The supplied password doesn't match the minimum security constraints, such as length or use of special characters.

    ", + "exception":true + }, + "ListAliasesRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the entity exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the entity for which to list the aliases.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListAliasesResponse":{ + "type":"structure", + "members":{ + "Aliases":{ + "shape":"Aliases", + "documentation":"

    The entity's paginated aliases.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.

    " + } + } + }, + "ListGroupMembersRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "GroupId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the group exists.

    " + }, + "GroupId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the group to which the members (users or groups) are associated.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListGroupMembersResponse":{ + "type":"structure", + "members":{ + "Members":{ + "shape":"Members", + "documentation":"

    The members associated to the group.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + } + } + }, + "ListGroupsRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the groups exist.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListGroupsResponse":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"Groups", + "documentation":"

    The overview of groups for an organization.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.

    " + } + } + }, + "ListMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of the organization under which the user, group, or resource exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user, group, or resource for which to list mailbox permissions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListMailboxPermissionsResponse":{ + "type":"structure", + "members":{ + "Permissions":{ + "shape":"Permissions", + "documentation":"

    One page of the user, group, or resource mailbox permissions.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.

    " + } + } + }, + "ListOrganizationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListOrganizationsResponse":{ + "type":"structure", + "members":{ + "OrganizationSummaries":{ + "shape":"OrganizationSummaries", + "documentation":"

    The overview of owned organizations presented as a list of organization summaries.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The value is \"null\" when there are no more results to return.

    " + } + } + }, + "ListResourceDelegatesRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization that contains the resource for which delegates are listed.

    " + }, + "ResourceId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the resource whose delegates are listed.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token used to paginate through the delegates associated with a resource.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The number of maximum results in a page.

    " + } + } + }, + "ListResourceDelegatesResponse":{ + "type":"structure", + "members":{ + "Delegates":{ + "shape":"ResourceDelegates", + "documentation":"

    One page of the resource's delegates.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token used to paginate through the delegates associated with a resource. While results are still available, it has an associated value. When the last page is reached, the token is empty.

    " + } + } + }, + "ListResourcesRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the resources exist.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListResourcesResponse":{ + "type":"structure", + "members":{ + "Resources":{ + "shape":"Resources", + "documentation":"

    One page of the organization's resource representation.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token used to paginate through all the organization's resources. While results are still available, it has an associated value. When the last page is reached, the token is empty.

    " + } + } + }, + "ListUsersRequest":{ + "type":"structure", + "required":["OrganizationId"], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the users exist.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. The first call does not contain any tokens.

    " + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

    The maximum number of results to return in a single call.

    " + } + } + }, + "ListUsersResponse":{ + "type":"structure", + "members":{ + "Users":{ + "shape":"Users", + "documentation":"

    The overview of users for an organization.

    " + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

    The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.

    " + } + } + }, + "MailDomainNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    For an email or alias to be created in Amazon WorkMail, the included domain must be defined in the organization.

    ", + "exception":true + }, + "MailDomainStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    After a domain has been added to the organization, it must be verified. The domain is not yet verified.

    ", + "exception":true + }, + "MailboxQuota":{ + "type":"integer", + "box":true, + "min":1 + }, + "MailboxSize":{ + "type":"double", + "min":0 + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Member":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    The identifier of the member.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The name of the member.

    " + }, + "Type":{ + "shape":"MemberType", + "documentation":"

    A member can be a user or group.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the member, which can be ENABLED, DISABLED, or DELETED.

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the member was enabled for Amazon WorkMail use.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the member was disabled from Amazon WorkMail use.

    " + } + }, + "documentation":"

    The representation of a user or group.

    " + }, + "MemberType":{ + "type":"string", + "enum":[ + "GROUP", + "USER" + ] + }, + "Members":{ + "type":"list", + "member":{"shape":"Member"} + }, + "NameAvailabilityException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The user, group, or resource name isn't unique in Amazon WorkMail.

    ", + "exception":true + }, + "NextToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "OrganizationId":{ + "type":"string", + "pattern":"^m-[0-9a-f]{32}$" + }, + "OrganizationName":{ + "type":"string", + "max":62, + "min":1, + "pattern":"^(?!d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*" + }, + "OrganizationNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    An operation received a valid organization identifier that either doesn't belong or exist in the system.

    ", + "exception":true + }, + "OrganizationStateException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    The organization must have a valid state (Active or Synchronizing) to perform certain operations on the organization or its members.

    ", + "exception":true + }, + "OrganizationSummaries":{ + "type":"list", + "member":{"shape":"OrganizationSummary"} + }, + "OrganizationSummary":{ + "type":"structure", + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier associated with the organization.

    " + }, + "Alias":{ + "shape":"OrganizationName", + "documentation":"

    The alias associated with the organization.

    " + }, + "ErrorMessage":{ + "shape":"String", + "documentation":"

    The error message associated with the organization. It is only present if unexpected behavior has occurred with regards to the organization. It provides insight or solutions regarding unexpected behavior.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The state associated with the organization.

    " + } + }, + "documentation":"

    The representation of an organization.

    " + }, + "Password":{ + "type":"string", + "max":256, + "pattern":"[\\u0020-\\u00FF]+", + "sensitive":true + }, + "Permission":{ + "type":"structure", + "required":[ + "GranteeId", + "GranteeType", + "PermissionValues" + ], + "members":{ + "GranteeId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user, group, or resource to which the permissions are granted.

    " + }, + "GranteeType":{ + "shape":"MemberType", + "documentation":"

    The type of user, group, or resource referred to in GranteeId.

    " + }, + "PermissionValues":{ + "shape":"PermissionValues", + "documentation":"

    The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

    " + } + }, + "documentation":"

    Permission granted to a user, group, or resource to access a certain aspect of another user, group, or resource mailbox.

    " + }, + "PermissionType":{ + "type":"string", + "enum":[ + "FULL_ACCESS", + "SEND_AS", + "SEND_ON_BEHALF" + ] + }, + "PermissionValues":{ + "type":"list", + "member":{"shape":"PermissionType"} + }, + "Permissions":{ + "type":"list", + "member":{"shape":"Permission"} + }, + "PutMailboxPermissionsRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "GranteeId", + "PermissionValues" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of the organization under which the user, group, or resource exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user, group, or resource for which to update mailbox permissions.

    " + }, + "GranteeId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user, group, or resource to which to grant the permissions.

    " + }, + "PermissionValues":{ + "shape":"PermissionValues", + "documentation":"

    The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.

    " + } + } + }, + "PutMailboxPermissionsResponse":{ + "type":"structure", + "members":{ + } + }, + "RegisterToWorkMailRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Email" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization under which the user, group, or resource exists.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier for the user, group, or resource to be updated.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email for the user, group, or resource to be updated.

    " + } + } + }, + "RegisterToWorkMailResponse":{ + "type":"structure", + "members":{ + } + }, + "ReservedNameException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    This user, group, or resource name is not allowed in Amazon WorkMail.

    ", + "exception":true + }, + "ResetPasswordRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "Password" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier of the organization that contains the user for which the password is reset.

    " + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user for whom the password is reset.

    " + }, + "Password":{ + "shape":"Password", + "documentation":"

    The new password for the user.

    " + } + } + }, + "ResetPasswordResponse":{ + "type":"structure", + "members":{ + } + }, + "Resource":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the resource.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the resource.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource.

    " + }, + "Type":{ + "shape":"ResourceType", + "documentation":"

    The type of the resource: equipment or room.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the resource, which can be ENABLED, DISABLED, or DELETED.

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the resource was enabled for Amazon WorkMail use.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the resource was disabled from Amazon WorkMail use.

    " + } + }, + "documentation":"

    The representation of a resource.

    " + }, + "ResourceDelegates":{ + "type":"list", + "member":{"shape":"Delegate"} + }, + "ResourceId":{ + "type":"string", + "pattern":"^r-[0-9a-f]{32}$" + }, + "ResourceName":{ + "type":"string", + "max":20, + "min":1, + "pattern":"[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?" + }, + "ResourceType":{ + "type":"string", + "enum":[ + "ROOM", + "EQUIPMENT" + ] + }, + "Resources":{ + "type":"list", + "member":{"shape":"Resource"} + }, + "String":{ + "type":"string", + "max":256 + }, + "Timestamp":{"type":"timestamp"}, + "UnsupportedOperationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "documentation":"

    You can't perform a write operation against a read-only directory.

    ", + "exception":true + }, + "UpdateMailboxQuotaRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "UserId", + "MailboxQuota" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier for the organization that contains the user for whom to update the mailbox quota.

    " + }, + "UserId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifer for the user for whom to update the mailbox quota.

    " + }, + "MailboxQuota":{ + "shape":"MailboxQuota", + "documentation":"

    The updated mailbox quota, in MB, for the specified user.

    " + } + } + }, + "UpdateMailboxQuotaResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdatePrimaryEmailAddressRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "EntityId", + "Email" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The organization that contains the user, group, or resource to update.

    " + }, + "EntityId":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The user, group, or resource to update.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The value of the email to be updated as primary.

    " + } + } + }, + "UpdatePrimaryEmailAddressResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateResourceRequest":{ + "type":"structure", + "required":[ + "OrganizationId", + "ResourceId" + ], + "members":{ + "OrganizationId":{ + "shape":"OrganizationId", + "documentation":"

    The identifier associated with the organization for which the resource is updated.

    " + }, + "ResourceId":{ + "shape":"ResourceId", + "documentation":"

    The identifier of the resource to be updated.

    " + }, + "Name":{ + "shape":"ResourceName", + "documentation":"

    The name of the resource to be updated.

    " + }, + "BookingOptions":{ + "shape":"BookingOptions", + "documentation":"

    The resource's booking options to be updated.

    " + } + } + }, + "UpdateResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "User":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"WorkMailIdentifier", + "documentation":"

    The identifier of the user.

    " + }, + "Email":{ + "shape":"EmailAddress", + "documentation":"

    The email of the user.

    " + }, + "Name":{ + "shape":"UserName", + "documentation":"

    The name of the user.

    " + }, + "DisplayName":{ + "shape":"String", + "documentation":"

    The display name of the user.

    " + }, + "State":{ + "shape":"EntityState", + "documentation":"

    The state of the user, which can be ENABLED, DISABLED, or DELETED.

    " + }, + "UserRole":{ + "shape":"UserRole", + "documentation":"

    The role of the user.

    " + }, + "EnabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the user was enabled for Amazon WorkMail use.

    " + }, + "DisabledDate":{ + "shape":"Timestamp", + "documentation":"

    The date indicating when the user was disabled from Amazon WorkMail use.

    " + } + }, + "documentation":"

    The representation of an Amazon WorkMail user.

    " + }, + "UserName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"[\\w\\-.]+(@[a-zA-Z0-9.\\-]+\\.[a-zA-Z0-9]{2,})?" + }, + "UserRole":{ + "type":"string", + "enum":[ + "USER", + "RESOURCE", + "SYSTEM_USER" + ] + }, + "Users":{ + "type":"list", + "member":{"shape":"User"} + }, + "WorkMailIdentifier":{ + "type":"string", + "max":256, + "min":12 + } + }, + "documentation":"

    Amazon WorkMail is a secure, managed business email and calendaring service with support for existing desktop and mobile email clients. You can access your email, contacts, and calendars using Microsoft Outlook, your browser, or other native iOS and Android email applications. You can integrate WorkMail with your existing corporate directory and control both the keys that encrypt your data and the location in which your data is stored.

    The WorkMail API is designed for the following scenarios:

    • Listing and describing organizations

    • Managing users

    • Managing groups

    • Managing resources

    All WorkMail API operations are Amazon-authenticated and certificate-signed. They not only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management users and roles to help facilitate access, trust, and permission policies. By creating a role and allowing an IAM user to access the WorkMail site, the IAM user gains full administrative visibility into the entire WorkMail organization (or as set in the IAM policy). This includes, but is not limited to, the ability to create, update, and delete users, groups, and resources. This allows developers to perform the scenarios listed above, as well as give users the ability to grant access on a selective basis using the IAM model.

    " +} diff --git a/aws/dist/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json b/aws/dist/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/aws/dist/botocore/data/workmailmessageflow/2019-05-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/aws/dist/botocore/data/workmailmessageflow/2019-05-01/service-2.json b/aws/dist/botocore/data/workmailmessageflow/2019-05-01/service-2.json new file mode 100644 index 00000000..6d4d4fda --- /dev/null +++ b/aws/dist/botocore/data/workmailmessageflow/2019-05-01/service-2.json @@ -0,0 +1,74 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2019-05-01", + "endpointPrefix":"workmailmessageflow", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon WorkMail Message Flow", + "serviceId":"WorkMailMessageFlow", + "signatureVersion":"v4", + "uid":"workmailmessageflow-2019-05-01" + }, + "operations":{ + "GetRawMessageContent":{ + "name":"GetRawMessageContent", + "http":{ + "method":"GET", + "requestUri":"/messages/{messageId}" + }, + "input":{"shape":"GetRawMessageContentRequest"}, + "output":{"shape":"GetRawMessageContentResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Retrieves the raw content of an in-transit email message, in MIME format.

    " + } + }, + "shapes":{ + "GetRawMessageContentRequest":{ + "type":"structure", + "required":["messageId"], + "members":{ + "messageId":{ + "shape":"messageIdType", + "documentation":"

    The identifier of the email message to retrieve.

    ", + "location":"uri", + "locationName":"messageId" + } + } + }, + "GetRawMessageContentResponse":{ + "type":"structure", + "required":["messageContent"], + "members":{ + "messageContent":{ + "shape":"messageContentBlob", + "documentation":"

    The raw content of the email message, in MIME format.

    " + } + }, + "payload":"messageContent" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "documentation":"

    The requested email message is not found.

    ", + "error":{"httpStatusCode":404}, + "exception":true + }, + "errorMessage":{"type":"string"}, + "messageContentBlob":{ + "type":"blob", + "streaming":true + }, + "messageIdType":{ + "type":"string", + "max":120, + "min":1, + "pattern":"[a-z0-9\\-]*" + } + }, + "documentation":"

    The WorkMail Message Flow API provides access to email messages as they are being sent and received by a WorkMail organization.

    " +} diff --git a/aws/dist/botocore/data/workspaces/2015-04-08/examples-1.json b/aws/dist/botocore/data/workspaces/2015-04-08/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/workspaces/2015-04-08/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/workspaces/2015-04-08/paginators-1.json b/aws/dist/botocore/data/workspaces/2015-04-08/paginators-1.json new file mode 100644 index 00000000..57e10e02 --- /dev/null +++ b/aws/dist/botocore/data/workspaces/2015-04-08/paginators-1.json @@ -0,0 +1,48 @@ +{ + "pagination": { + "DescribeWorkspaceBundles": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Bundles" + }, + "DescribeWorkspaceDirectories": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Directories" + }, + "DescribeWorkspaces": { + "limit_key": "Limit", + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Workspaces" + }, + "DescribeAccountModifications": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "AccountModifications" + }, + "DescribeIpGroups": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Result" + }, + "DescribeWorkspaceImages": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Images" + }, + "DescribeWorkspacesConnectionStatus": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "WorkspacesConnectionStatus" + }, + "ListAvailableManagementCidrRanges": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "ManagementCidrRanges" + } + } +} diff --git a/aws/dist/botocore/data/workspaces/2015-04-08/service-2.json b/aws/dist/botocore/data/workspaces/2015-04-08/service-2.json new file mode 100644 index 00000000..e7562943 --- /dev/null +++ b/aws/dist/botocore/data/workspaces/2015-04-08/service-2.json @@ -0,0 +1,2466 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2015-04-08", + "endpointPrefix":"workspaces", + "jsonVersion":"1.1", + "protocol":"json", + "serviceFullName":"Amazon WorkSpaces", + "serviceId":"WorkSpaces", + "signatureVersion":"v4", + "targetPrefix":"WorkspacesService", + "uid":"workspaces-2015-04-08" + }, + "operations":{ + "AssociateIpGroups":{ + "name":"AssociateIpGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssociateIpGroupsRequest"}, + "output":{"shape":"AssociateIpGroupsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"}, + {"shape":"OperationNotSupportedException"} + ], + "documentation":"

    Associates the specified IP access control group with the specified directory.

    " + }, + "AuthorizeIpRules":{ + "name":"AuthorizeIpRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AuthorizeIpRulesRequest"}, + "output":{"shape":"AuthorizeIpRulesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Adds one or more rules to the specified IP access control group.

    This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.

    " + }, + "CopyWorkspaceImage":{ + "name":"CopyWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CopyWorkspaceImageRequest"}, + "output":{"shape":"CopyWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Copies the specified image from the specified Region to the current Region.

    " + }, + "CreateIpGroup":{ + "name":"CreateIpGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateIpGroupRequest"}, + "output":{"shape":"CreateIpGroupResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceCreationFailedException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Creates an IP access control group.

    An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.

    There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.

    " + }, + "CreateTags":{ + "name":"CreateTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateTagsRequest"}, + "output":{"shape":"CreateTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceLimitExceededException"} + ], + "documentation":"

    Creates the specified tags for the specified WorkSpaces resource.

    " + }, + "CreateWorkspaces":{ + "name":"CreateWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWorkspacesRequest"}, + "output":{"shape":"CreateWorkspacesResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Creates one or more WorkSpaces.

    This operation is asynchronous and returns before the WorkSpaces are created.

    " + }, + "DeleteIpGroup":{ + "name":"DeleteIpGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteIpGroupRequest"}, + "output":{"shape":"DeleteIpGroupResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceAssociatedException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Deletes the specified IP access control group.

    You cannot delete an IP access control group that is associated with a directory.

    " + }, + "DeleteTags":{ + "name":"DeleteTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteTagsRequest"}, + "output":{"shape":"DeleteTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Deletes the specified tags from the specified WorkSpaces resource.

    " + }, + "DeleteWorkspaceImage":{ + "name":"DeleteWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWorkspaceImageRequest"}, + "output":{"shape":"DeleteWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceAssociatedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and un-share the image if it is shared with other accounts.

    " + }, + "DescribeAccount":{ + "name":"DescribeAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountRequest"}, + "output":{"shape":"DescribeAccountResult"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.

    " + }, + "DescribeAccountModifications":{ + "name":"DescribeAccountModifications", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAccountModificationsRequest"}, + "output":{"shape":"DescribeAccountModificationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Retrieves a list that describes modifications to the configuration of bring your own license (BYOL) for the specified account.

    " + }, + "DescribeClientProperties":{ + "name":"DescribeClientProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeClientPropertiesRequest"}, + "output":{"shape":"DescribeClientPropertiesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

    " + }, + "DescribeIpGroups":{ + "name":"DescribeIpGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeIpGroupsRequest"}, + "output":{"shape":"DescribeIpGroupsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Describes one or more of your IP access control groups.

    " + }, + "DescribeTags":{ + "name":"DescribeTags", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeTagsRequest"}, + "output":{"shape":"DescribeTagsResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Describes the specified tags for the specified WorkSpaces resource.

    " + }, + "DescribeWorkspaceBundles":{ + "name":"DescribeWorkspaceBundles", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceBundlesRequest"}, + "output":{"shape":"DescribeWorkspaceBundlesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Retrieves a list that describes the available WorkSpace bundles.

    You can filter the results using either bundle ID or owner, but not both.

    " + }, + "DescribeWorkspaceDirectories":{ + "name":"DescribeWorkspaceDirectories", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceDirectoriesRequest"}, + "output":{"shape":"DescribeWorkspaceDirectoriesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

    " + }, + "DescribeWorkspaceImages":{ + "name":"DescribeWorkspaceImages", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceImagesRequest"}, + "output":{"shape":"DescribeWorkspaceImagesResult"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.

    " + }, + "DescribeWorkspaceSnapshots":{ + "name":"DescribeWorkspaceSnapshots", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspaceSnapshotsRequest"}, + "output":{"shape":"DescribeWorkspaceSnapshotsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Describes the snapshots for the specified WorkSpace.

    " + }, + "DescribeWorkspaces":{ + "name":"DescribeWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesRequest"}, + "output":{"shape":"DescribeWorkspacesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Describes the specified WorkSpaces.

    You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.

    " + }, + "DescribeWorkspacesConnectionStatus":{ + "name":"DescribeWorkspacesConnectionStatus", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWorkspacesConnectionStatusRequest"}, + "output":{"shape":"DescribeWorkspacesConnectionStatusResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Describes the connection status of the specified WorkSpaces.

    " + }, + "DisassociateIpGroups":{ + "name":"DisassociateIpGroups", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DisassociateIpGroupsRequest"}, + "output":{"shape":"DisassociateIpGroupsResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Disassociates the specified IP access control group from the specified directory.

    " + }, + "ImportWorkspaceImage":{ + "name":"ImportWorkspaceImage", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ImportWorkspaceImageRequest"}, + "output":{"shape":"ImportWorkspaceImageResult"}, + "errors":[ + {"shape":"ResourceLimitExceededException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"OperationNotSupportedException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValuesException"} + ], + "documentation":"

    Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.

    " + }, + "ListAvailableManagementCidrRanges":{ + "name":"ListAvailableManagementCidrRanges", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListAvailableManagementCidrRangesRequest"}, + "output":{"shape":"ListAvailableManagementCidrRangesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable bring your own license (BYOL).

    The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " + }, + "ModifyAccount":{ + "name":"ModifyAccount", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyAccountRequest"}, + "output":{"shape":"ModifyAccountResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"ResourceUnavailableException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Modifies the configuration of bring your own license (BYOL) for the specified account.

    " + }, + "ModifyClientProperties":{ + "name":"ModifyClientProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyClientPropertiesRequest"}, + "output":{"shape":"ModifyClientPropertiesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Modifies the properties of the specified Amazon WorkSpaces clients.

    " + }, + "ModifyWorkspaceProperties":{ + "name":"ModifyWorkspaceProperties", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyWorkspacePropertiesRequest"}, + "output":{"shape":"ModifyWorkspacePropertiesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"OperationInProgressException"}, + {"shape":"UnsupportedWorkspaceConfigurationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

    Modifies the specified WorkSpace properties.

    " + }, + "ModifyWorkspaceState":{ + "name":"ModifyWorkspaceState", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyWorkspaceStateRequest"}, + "output":{"shape":"ModifyWorkspaceStateResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

    Sets the state of the specified WorkSpace.

    To maintain a WorkSpace without being interrupted, set the WorkSpace state to ADMIN_MAINTENANCE. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the ADMIN_MAINTENANCE state.

    " + }, + "RebootWorkspaces":{ + "name":"RebootWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebootWorkspacesRequest"}, + "output":{"shape":"RebootWorkspacesResult"}, + "documentation":"

    Reboots the specified WorkSpaces.

    You cannot reboot a WorkSpace unless its state is AVAILABLE or UNHEALTHY.

    This operation is asynchronous and returns before the WorkSpaces have rebooted.

    " + }, + "RebuildWorkspaces":{ + "name":"RebuildWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RebuildWorkspacesRequest"}, + "output":{"shape":"RebuildWorkspacesResult"}, + "documentation":"

    Rebuilds the specified WorkSpace.

    You cannot rebuild a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY.

    Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.

    This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.

    " + }, + "RestoreWorkspace":{ + "name":"RestoreWorkspace", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreWorkspaceRequest"}, + "output":{"shape":"RestoreWorkspaceResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Restores the specified WorkSpace to its last known healthy state.

    You cannot restore a WorkSpace unless its state is AVAILABLE, ERROR, or UNHEALTHY.

    Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.

    This operation is asynchronous and returns before the WorkSpace is completely restored.

    " + }, + "RevokeIpRules":{ + "name":"RevokeIpRules", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RevokeIpRulesRequest"}, + "output":{"shape":"RevokeIpRulesResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Removes one or more rules from the specified IP access control group.

    " + }, + "StartWorkspaces":{ + "name":"StartWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartWorkspacesRequest"}, + "output":{"shape":"StartWorkspacesResult"}, + "documentation":"

    Starts the specified WorkSpaces.

    You cannot start a WorkSpace unless it has a running mode of AutoStop and a state of STOPPED.

    " + }, + "StopWorkspaces":{ + "name":"StopWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopWorkspacesRequest"}, + "output":{"shape":"StopWorkspacesResult"}, + "documentation":"

    Stops the specified WorkSpaces.

    You cannot stop a WorkSpace unless it has a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.

    " + }, + "TerminateWorkspaces":{ + "name":"TerminateWorkspaces", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TerminateWorkspacesRequest"}, + "output":{"shape":"TerminateWorkspacesResult"}, + "documentation":"

    Terminates the specified WorkSpaces.

    Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.

    You can terminate a WorkSpace that is in any state except SUSPENDED.

    This operation is asynchronous and returns before the WorkSpaces have been completely terminated.

    " + }, + "UpdateRulesOfIpGroup":{ + "name":"UpdateRulesOfIpGroup", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateRulesOfIpGroupRequest"}, + "output":{"shape":"UpdateRulesOfIpGroupResult"}, + "errors":[ + {"shape":"InvalidParameterValuesException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"InvalidResourceStateException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

    Replaces the current rules of the specified IP access control group with the specified rules.

    " + } + }, + "shapes":{ + "ARN":{ + "type":"string", + "pattern":"^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" + }, + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The user is not authorized to access a resource.

    ", + "exception":true + }, + "AccountModification":{ + "type":"structure", + "members":{ + "ModificationState":{ + "shape":"DedicatedTenancyModificationStateEnum", + "documentation":"

    The state of the modification to the configuration of BYOL.

    " + }, + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportResultEnum", + "documentation":"

    The status of BYOL (whether BYOL is being enabled or disabled).

    " + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"

    The IP address range, specified as an IPv4 CIDR block, for the management network interface used for the account.

    " + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The timestamp when the modification of the BYOL configuration was started.

    " + }, + "ErrorCode":{ + "shape":"WorkspaceErrorCode", + "documentation":"

    The error code that is returned if the configuration of BYOL cannot be modified.

    " + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"

    The text of the error message that is returned if the configuration of BYOL cannot be modified.

    " + } + }, + "documentation":"

    Describes a modification to the configuration of bring your own license (BYOL) for the specified account.

    " + }, + "AccountModificationList":{ + "type":"list", + "member":{"shape":"AccountModification"} + }, + "Alias":{"type":"string"}, + "AssociateIpGroupsRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "GroupIds" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The identifier of the directory.

    " + }, + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"

    The identifiers of one or more IP access control groups.

    " + } + } + }, + "AssociateIpGroupsResult":{ + "type":"structure", + "members":{ + } + }, + "AuthorizeIpRulesRequest":{ + "type":"structure", + "required":[ + "GroupId", + "UserRules" + ], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the group.

    " + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"

    The rules to add to the group.

    " + } + } + }, + "AuthorizeIpRulesResult":{ + "type":"structure", + "members":{ + } + }, + "BooleanObject":{"type":"boolean"}, + "BundleId":{ + "type":"string", + "pattern":"^wsb-[0-9a-z]{8,63}$" + }, + "BundleIdList":{ + "type":"list", + "member":{"shape":"BundleId"}, + "max":25, + "min":1 + }, + "BundleList":{ + "type":"list", + "member":{"shape":"WorkspaceBundle"} + }, + "BundleOwner":{"type":"string"}, + "ClientProperties":{ + "type":"structure", + "members":{ + "ReconnectEnabled":{ + "shape":"ReconnectEnum", + "documentation":"

    Specifies whether users can cache their credentials on the Amazon WorkSpaces client. When enabled, users can choose to reconnect to their WorkSpaces without re-entering their credentials.

    " + } + }, + "documentation":"

    Describes an Amazon WorkSpaces client.

    " + }, + "ClientPropertiesList":{ + "type":"list", + "member":{"shape":"ClientPropertiesResult"} + }, + "ClientPropertiesResult":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The resource identifier, in the form of a directory ID.

    " + }, + "ClientProperties":{ + "shape":"ClientProperties", + "documentation":"

    Information about the Amazon WorkSpaces client.

    " + } + }, + "documentation":"

    Information about the Amazon WorkSpaces client.

    " + }, + "Compute":{ + "type":"string", + "enum":[ + "VALUE", + "STANDARD", + "PERFORMANCE", + "POWER", + "GRAPHICS", + "POWERPRO", + "GRAPHICSPRO" + ] + }, + "ComputeType":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"Compute", + "documentation":"

    The compute type.

    " + } + }, + "documentation":"

    Describes the compute type.

    " + }, + "ComputerName":{"type":"string"}, + "ConnectionState":{ + "type":"string", + "enum":[ + "CONNECTED", + "DISCONNECTED", + "UNKNOWN" + ] + }, + "CopyWorkspaceImageRequest":{ + "type":"structure", + "required":[ + "Name", + "SourceImageId", + "SourceRegion" + ], + "members":{ + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"

    The name of the image.

    " + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"

    A description of the image.

    " + }, + "SourceImageId":{ + "shape":"WorkspaceImageId", + "documentation":"

    The identifier of the source image.

    " + }, + "SourceRegion":{ + "shape":"Region", + "documentation":"

    The identifier of the source Region.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags for the image.

    " + } + } + }, + "CopyWorkspaceImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"

    The identifier of the image.

    " + } + } + }, + "CreateIpGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"IpGroupName", + "documentation":"

    The name of the group.

    " + }, + "GroupDesc":{ + "shape":"IpGroupDesc", + "documentation":"

    The description of the group.

    " + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"

    The rules to add to the group.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + } + }, + "CreateIpGroupResult":{ + "type":"structure", + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the group.

    " + } + } + }, + "CreateTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "Tags" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + } + }, + "CreateTagsResult":{ + "type":"structure", + "members":{ + } + }, + "CreateWorkspacesRequest":{ + "type":"structure", + "required":["Workspaces"], + "members":{ + "Workspaces":{ + "shape":"WorkspaceRequestList", + "documentation":"

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

    " + } + } + }, + "CreateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedCreateWorkspaceRequests", + "documentation":"

    Information about the WorkSpaces that could not be created.

    " + }, + "PendingRequests":{ + "shape":"WorkspaceList", + "documentation":"

    Information about the WorkSpaces that were created.

    Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call DescribeWorkspaces before the WorkSpace is created, the information returned can be incomplete.

    " + } + } + }, + "DedicatedTenancyCidrRangeList":{ + "type":"list", + "member":{"shape":"DedicatedTenancyManagementCidrRange"} + }, + "DedicatedTenancyManagementCidrRange":{ + "type":"string", + "pattern":"(^([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.0\\.0)(\\/(16$))$" + }, + "DedicatedTenancyModificationStateEnum":{ + "type":"string", + "enum":[ + "PENDING", + "COMPLETED", + "FAILED" + ] + }, + "DedicatedTenancySupportEnum":{ + "type":"string", + "enum":["ENABLED"] + }, + "DedicatedTenancySupportResultEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "DefaultOu":{"type":"string"}, + "DefaultWorkspaceCreationProperties":{ + "type":"structure", + "members":{ + "EnableWorkDocs":{ + "shape":"BooleanObject", + "documentation":"

    Specifies whether the directory is enabled for Amazon WorkDocs.

    " + }, + "EnableInternetAccess":{ + "shape":"BooleanObject", + "documentation":"

    Specifies whether to automatically assign a public IP address to WorkSpaces in this directory by default. If enabled, the public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

    " + }, + "DefaultOu":{ + "shape":"DefaultOu", + "documentation":"

    The organizational unit (OU) in the directory for the WorkSpace machine accounts.

    " + }, + "CustomSecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"

    The identifier of any security groups to apply to WorkSpaces when they are created.

    " + }, + "UserEnabledAsLocalAdministrator":{ + "shape":"BooleanObject", + "documentation":"

    Specifies whether the WorkSpace user is an administrator on the WorkSpace.

    " + } + }, + "documentation":"

    Describes the default values used to create a WorkSpace.

    " + }, + "DeleteIpGroupRequest":{ + "type":"structure", + "required":["GroupId"], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the IP access control group.

    " + } + } + }, + "DeleteIpGroupResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteTagsRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "TagKeys" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.

    " + }, + "TagKeys":{ + "shape":"TagKeyList", + "documentation":"

    The tag keys.

    " + } + } + }, + "DeleteTagsResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteWorkspaceImageRequest":{ + "type":"structure", + "required":["ImageId"], + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"

    The identifier of the image.

    " + } + } + }, + "DeleteWorkspaceImageResult":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountModificationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + } + } + }, + "DescribeAccountModificationsResult":{ + "type":"structure", + "members":{ + "AccountModifications":{ + "shape":"AccountModificationList", + "documentation":"

    The list of modifications to the configuration of BYOL.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "DescribeAccountRequest":{ + "type":"structure", + "members":{ + } + }, + "DescribeAccountResult":{ + "type":"structure", + "members":{ + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportResultEnum", + "documentation":"

    The status of BYOL (whether BYOL is enabled or disabled).

    " + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"

    The IP address range, specified as an IPv4 CIDR block, used for the management network interface.

    The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.

    " + } + } + }, + "DescribeClientPropertiesRequest":{ + "type":"structure", + "required":["ResourceIds"], + "members":{ + "ResourceIds":{ + "shape":"ResourceIdList", + "documentation":"

    The resource identifier, in the form of directory IDs.

    " + } + } + }, + "DescribeClientPropertiesResult":{ + "type":"structure", + "members":{ + "ClientPropertiesList":{ + "shape":"ClientPropertiesList", + "documentation":"

    Information about the specified Amazon WorkSpaces clients.

    " + } + } + }, + "DescribeIpGroupsRequest":{ + "type":"structure", + "members":{ + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"

    The identifiers of one or more IP access control groups.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + }, + "MaxResults":{ + "shape":"Limit", + "documentation":"

    The maximum number of items to return.

    " + } + } + }, + "DescribeIpGroupsResult":{ + "type":"structure", + "members":{ + "Result":{ + "shape":"WorkspacesIpGroupsList", + "documentation":"

    Information about the IP access control groups.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "DescribeTagsRequest":{ + "type":"structure", + "required":["ResourceId"], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, and IP access control groups.

    " + } + } + }, + "DescribeTagsResult":{ + "type":"structure", + "members":{ + "TagList":{ + "shape":"TagList", + "documentation":"

    The tags.

    " + } + } + }, + "DescribeWorkspaceBundlesRequest":{ + "type":"structure", + "members":{ + "BundleIds":{ + "shape":"BundleIdList", + "documentation":"

    The identifiers of the bundles. You cannot combine this parameter with any other filter.

    " + }, + "Owner":{ + "shape":"BundleOwner", + "documentation":"

    The owner of the bundles. You cannot combine this parameter with any other filter.

    Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token for the next set of results. (You received this token from a previous call.)

    " + } + } + }, + "DescribeWorkspaceBundlesResult":{ + "type":"structure", + "members":{ + "Bundles":{ + "shape":"BundleList", + "documentation":"

    Information about the bundles.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.

    " + } + } + }, + "DescribeWorkspaceDirectoriesRequest":{ + "type":"structure", + "members":{ + "DirectoryIds":{ + "shape":"DirectoryIdList", + "documentation":"

    The identifiers of the directories. If the value is null, all directories are retrieved.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + } + } + }, + "DescribeWorkspaceDirectoriesResult":{ + "type":"structure", + "members":{ + "Directories":{ + "shape":"DirectoryList", + "documentation":"

    Information about the directories.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "DescribeWorkspaceImagesRequest":{ + "type":"structure", + "members":{ + "ImageIds":{ + "shape":"WorkspaceImageIdList", + "documentation":"

    The identifier of the image.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + }, + "MaxResults":{ + "shape":"Limit", + "documentation":"

    The maximum number of items to return.

    " + } + } + }, + "DescribeWorkspaceImagesResult":{ + "type":"structure", + "members":{ + "Images":{ + "shape":"WorkspaceImageList", + "documentation":"

    Information about the images.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "DescribeWorkspaceSnapshotsRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + } + }, + "DescribeWorkspaceSnapshotsResult":{ + "type":"structure", + "members":{ + "RebuildSnapshots":{ + "shape":"SnapshotList", + "documentation":"

    Information about the snapshots that can be used to rebuild a WorkSpace. These snapshots include the user volume.

    " + }, + "RestoreSnapshots":{ + "shape":"SnapshotList", + "documentation":"

    Information about the snapshots that can be used to restore a WorkSpace. These snapshots include both the root volume and the user volume.

    " + } + } + }, + "DescribeWorkspacesConnectionStatusRequest":{ + "type":"structure", + "members":{ + "WorkspaceIds":{ + "shape":"WorkspaceIdList", + "documentation":"

    The identifiers of the WorkSpaces. You can specify up to 25 WorkSpaces.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + } + } + }, + "DescribeWorkspacesConnectionStatusResult":{ + "type":"structure", + "members":{ + "WorkspacesConnectionStatus":{ + "shape":"WorkspaceConnectionStatusList", + "documentation":"

    Information about the connection status of the WorkSpace.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "DescribeWorkspacesRequest":{ + "type":"structure", + "members":{ + "WorkspaceIds":{ + "shape":"WorkspaceIdList", + "documentation":"

    The identifiers of the WorkSpaces. You cannot combine this parameter with any other filter.

    Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

    " + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The identifier of the directory. In addition, you can optionally specify a specific directory user (see UserName). You cannot combine this parameter with any other filter.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The name of the directory user. You must specify this parameter with DirectoryId.

    " + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"

    The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

    " + }, + "Limit":{ + "shape":"Limit", + "documentation":"

    The maximum number of items to return.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + } + } + }, + "DescribeWorkspacesResult":{ + "type":"structure", + "members":{ + "Workspaces":{ + "shape":"WorkspaceList", + "documentation":"

    Information about the WorkSpaces.

    Because CreateWorkspaces is an asynchronous operation, some of the returned information could be incomplete.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "Description":{"type":"string"}, + "DirectoryId":{ + "type":"string", + "pattern":"^d-[0-9a-f]{8,63}$" + }, + "DirectoryIdList":{ + "type":"list", + "member":{"shape":"DirectoryId"}, + "max":25, + "min":1 + }, + "DirectoryList":{ + "type":"list", + "member":{"shape":"WorkspaceDirectory"} + }, + "DirectoryName":{"type":"string"}, + "DisassociateIpGroupsRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "GroupIds" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The identifier of the directory.

    " + }, + "GroupIds":{ + "shape":"IpGroupIdList", + "documentation":"

    The identifiers of one or more IP access control groups.

    " + } + } + }, + "DisassociateIpGroupsResult":{ + "type":"structure", + "members":{ + } + }, + "DnsIpAddresses":{ + "type":"list", + "member":{"shape":"IpAddress"} + }, + "Ec2ImageId":{ + "type":"string", + "pattern":"^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$" + }, + "ErrorType":{"type":"string"}, + "ExceptionMessage":{"type":"string"}, + "FailedCreateWorkspaceRequest":{ + "type":"structure", + "members":{ + "WorkspaceRequest":{ + "shape":"WorkspaceRequest", + "documentation":"

    Information about the WorkSpace.

    " + }, + "ErrorCode":{ + "shape":"ErrorType", + "documentation":"

    The error code that is returned if the WorkSpace cannot be created.

    " + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"

    The text of the error message that is returned if the WorkSpace cannot be created.

    " + } + }, + "documentation":"

    Describes a WorkSpace that cannot be created.

    " + }, + "FailedCreateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedCreateWorkspaceRequest"} + }, + "FailedRebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedRebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedStartWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedStopWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedTerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"FailedWorkspaceChangeRequest"} + }, + "FailedWorkspaceChangeRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + }, + "ErrorCode":{ + "shape":"ErrorType", + "documentation":"

    The error code that is returned if the WorkSpace cannot be rebooted.

    " + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"

    The text of the error message that is returned if the WorkSpace cannot be rebooted.

    " + } + }, + "documentation":"

    Describes a WorkSpace that could not be rebooted. (RebootWorkspaces), rebuilt (RebuildWorkspaces), restored (RestoreWorkspace), terminated (TerminateWorkspaces), started (StartWorkspaces), or stopped (StopWorkspaces).

    " + }, + "ImportWorkspaceImageRequest":{ + "type":"structure", + "required":[ + "Ec2ImageId", + "IngestionProcess", + "ImageName", + "ImageDescription" + ], + "members":{ + "Ec2ImageId":{ + "shape":"Ec2ImageId", + "documentation":"

    The identifier of the EC2 image.

    " + }, + "IngestionProcess":{ + "shape":"WorkspaceImageIngestionProcess", + "documentation":"

    The ingestion process to be used when importing the image.

    " + }, + "ImageName":{ + "shape":"WorkspaceImageName", + "documentation":"

    The name of the WorkSpace image.

    " + }, + "ImageDescription":{ + "shape":"WorkspaceImageDescription", + "documentation":"

    The description of the WorkSpace image.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags. Each WorkSpaces resource can have a maximum of 50 tags.

    " + } + } + }, + "ImportWorkspaceImageResult":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"

    The identifier of the WorkSpace image.

    " + } + } + }, + "InvalidParameterValuesException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

    The exception error message.

    " + } + }, + "documentation":"

    One or more parameter values are not valid.

    ", + "exception":true + }, + "InvalidResourceStateException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The state of the resource is not valid for this operation.

    ", + "exception":true + }, + "IpAddress":{"type":"string"}, + "IpGroupDesc":{"type":"string"}, + "IpGroupId":{ + "type":"string", + "pattern":"wsipg-[0-9a-z]{8,63}$" + }, + "IpGroupIdList":{ + "type":"list", + "member":{"shape":"IpGroupId"} + }, + "IpGroupName":{"type":"string"}, + "IpRevokedRuleList":{ + "type":"list", + "member":{"shape":"IpRule"} + }, + "IpRule":{"type":"string"}, + "IpRuleDesc":{"type":"string"}, + "IpRuleItem":{ + "type":"structure", + "members":{ + "ipRule":{ + "shape":"IpRule", + "documentation":"

    The IP address range, in CIDR notation.

    " + }, + "ruleDesc":{ + "shape":"IpRuleDesc", + "documentation":"

    The description.

    " + } + }, + "documentation":"

    Describes a rule for an IP access control group.

    " + }, + "IpRuleList":{ + "type":"list", + "member":{"shape":"IpRuleItem"} + }, + "Limit":{ + "type":"integer", + "max":25, + "min":1 + }, + "ListAvailableManagementCidrRangesRequest":{ + "type":"structure", + "required":["ManagementCidrRangeConstraint"], + "members":{ + "ManagementCidrRangeConstraint":{ + "shape":"ManagementCidrRangeConstraint", + "documentation":"

    The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

    " + }, + "MaxResults":{ + "shape":"ManagementCidrRangeMaxResults", + "documentation":"

    The maximum number of items to return.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    If you received a NextToken from a previous call that was paginated, provide this token to receive the next set of results.

    " + } + } + }, + "ListAvailableManagementCidrRangesResult":{ + "type":"structure", + "members":{ + "ManagementCidrRanges":{ + "shape":"DedicatedTenancyCidrRangeList", + "documentation":"

    The list of available IP address ranges, specified as IPv4 CIDR blocks.

    " + }, + "NextToken":{ + "shape":"PaginationToken", + "documentation":"

    The token to use to retrieve the next set of results, or null if no more results are available.

    " + } + } + }, + "ManagementCidrRangeConstraint":{ + "type":"string", + "pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[0-9]))$" + }, + "ManagementCidrRangeMaxResults":{ + "type":"integer", + "max":5, + "min":1 + }, + "ModificationResourceEnum":{ + "type":"string", + "enum":[ + "ROOT_VOLUME", + "USER_VOLUME", + "COMPUTE_TYPE" + ] + }, + "ModificationState":{ + "type":"structure", + "members":{ + "Resource":{ + "shape":"ModificationResourceEnum", + "documentation":"

    The resource.

    " + }, + "State":{ + "shape":"ModificationStateEnum", + "documentation":"

    The modification state.

    " + } + }, + "documentation":"

    Describes a WorkSpace modification.

    " + }, + "ModificationStateEnum":{ + "type":"string", + "enum":[ + "UPDATE_INITIATED", + "UPDATE_IN_PROGRESS" + ] + }, + "ModificationStateList":{ + "type":"list", + "member":{"shape":"ModificationState"} + }, + "ModifyAccountRequest":{ + "type":"structure", + "members":{ + "DedicatedTenancySupport":{ + "shape":"DedicatedTenancySupportEnum", + "documentation":"

    The status of BYOL.

    " + }, + "DedicatedTenancyManagementCidrRange":{ + "shape":"DedicatedTenancyManagementCidrRange", + "documentation":"

    The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ListAvailableManagementCidrRanges operation.

    " + } + } + }, + "ModifyAccountResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyClientPropertiesRequest":{ + "type":"structure", + "required":[ + "ResourceId", + "ClientProperties" + ], + "members":{ + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The resource identifiers, in the form of directory IDs.

    " + }, + "ClientProperties":{ + "shape":"ClientProperties", + "documentation":"

    Information about the Amazon WorkSpaces client.

    " + } + } + }, + "ModifyClientPropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspacePropertiesRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "WorkspaceProperties" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"

    The properties of the WorkSpace.

    " + } + } + }, + "ModifyWorkspacePropertiesResult":{ + "type":"structure", + "members":{ + } + }, + "ModifyWorkspaceStateRequest":{ + "type":"structure", + "required":[ + "WorkspaceId", + "WorkspaceState" + ], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + }, + "WorkspaceState":{ + "shape":"TargetWorkspaceState", + "documentation":"

    The WorkSpace state.

    " + } + } + }, + "ModifyWorkspaceStateResult":{ + "type":"structure", + "members":{ + } + }, + "NonEmptyString":{ + "type":"string", + "min":1 + }, + "OperatingSystem":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"OperatingSystemType", + "documentation":"

    The operating system.

    " + } + }, + "documentation":"

    The operating system that the image is running.

    " + }, + "OperatingSystemType":{ + "type":"string", + "enum":[ + "WINDOWS", + "LINUX" + ] + }, + "OperationInProgressException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The properties of this WorkSpace are currently being modified. Try again in a moment.

    ", + "exception":true + }, + "OperationNotSupportedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    This operation is not supported.

    ", + "exception":true + }, + "PaginationToken":{ + "type":"string", + "max":63, + "min":1 + }, + "RebootRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + }, + "documentation":"

    Describes the information used to reboot a WorkSpace.

    " + }, + "RebootWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebootRequest"}, + "max":25, + "min":1 + }, + "RebootWorkspacesRequest":{ + "type":"structure", + "required":["RebootWorkspaceRequests"], + "members":{ + "RebootWorkspaceRequests":{ + "shape":"RebootWorkspaceRequests", + "documentation":"

    The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

    " + } + } + }, + "RebootWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedRebootWorkspaceRequests", + "documentation":"

    Information about the WorkSpaces that could not be rebooted.

    " + } + } + }, + "RebuildRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + }, + "documentation":"

    Describes the information used to rebuild a WorkSpace.

    " + }, + "RebuildWorkspaceRequests":{ + "type":"list", + "member":{"shape":"RebuildRequest"}, + "max":1, + "min":1 + }, + "RebuildWorkspacesRequest":{ + "type":"structure", + "required":["RebuildWorkspaceRequests"], + "members":{ + "RebuildWorkspaceRequests":{ + "shape":"RebuildWorkspaceRequests", + "documentation":"

    The WorkSpace to rebuild. You can specify a single WorkSpace.

    " + } + } + }, + "RebuildWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedRebuildWorkspaceRequests", + "documentation":"

    Information about the WorkSpace that could not be rebuilt.

    " + } + } + }, + "ReconnectEnum":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, + "Region":{ + "type":"string", + "max":31, + "min":1, + "pattern":"^[-0-9a-z]{1,31}$" + }, + "RegistrationCode":{ + "type":"string", + "max":20, + "min":1 + }, + "ResourceAlreadyExistsException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The specified resource already exists.

    ", + "exception":true + }, + "ResourceAssociatedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The resource is associated with a directory.

    ", + "exception":true + }, + "ResourceCreationFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The resource could not be created.

    ", + "exception":true + }, + "ResourceIdList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":25, + "min":1 + }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

    The exception error message.

    " + } + }, + "documentation":"

    Your resource limits have been exceeded.

    ", + "exception":true + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

    The resource could not be found.

    " + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The ID of the resource that could not be found.

    " + } + }, + "documentation":"

    The resource could not be found.

    ", + "exception":true + }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "message":{ + "shape":"ExceptionMessage", + "documentation":"

    The exception error message.

    " + }, + "ResourceId":{ + "shape":"NonEmptyString", + "documentation":"

    The identifier of the resource that is not available.

    " + } + }, + "documentation":"

    The specified resource is not available.

    ", + "exception":true + }, + "RestoreWorkspaceRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + } + }, + "RestoreWorkspaceResult":{ + "type":"structure", + "members":{ + } + }, + "RevokeIpRulesRequest":{ + "type":"structure", + "required":[ + "GroupId", + "UserRules" + ], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the group.

    " + }, + "UserRules":{ + "shape":"IpRevokedRuleList", + "documentation":"

    The rules to remove from the group.

    " + } + } + }, + "RevokeIpRulesResult":{ + "type":"structure", + "members":{ + } + }, + "RootStorage":{ + "type":"structure", + "members":{ + "Capacity":{ + "shape":"NonEmptyString", + "documentation":"

    The size of the root volume.

    " + } + }, + "documentation":"

    Describes the root volume for a WorkSpace bundle.

    " + }, + "RootVolumeSizeGib":{"type":"integer"}, + "RunningMode":{ + "type":"string", + "enum":[ + "AUTO_STOP", + "ALWAYS_ON" + ] + }, + "RunningModeAutoStopTimeoutInMinutes":{"type":"integer"}, + "SecurityGroupId":{ + "type":"string", + "pattern":"^(sg-[0-9a-f]{8})$" + }, + "Snapshot":{ + "type":"structure", + "members":{ + "SnapshotTime":{ + "shape":"Timestamp", + "documentation":"

    The time when the snapshot was created.

    " + } + }, + "documentation":"

    Describes a snapshot.

    " + }, + "SnapshotList":{ + "type":"list", + "member":{"shape":"Snapshot"} + }, + "StartRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + }, + "documentation":"

    Information used to start a WorkSpace.

    " + }, + "StartWorkspaceRequests":{ + "type":"list", + "member":{"shape":"StartRequest"}, + "max":25, + "min":1 + }, + "StartWorkspacesRequest":{ + "type":"structure", + "required":["StartWorkspaceRequests"], + "members":{ + "StartWorkspaceRequests":{ + "shape":"StartWorkspaceRequests", + "documentation":"

    The WorkSpaces to start. You can specify up to 25 WorkSpaces.

    " + } + } + }, + "StartWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedStartWorkspaceRequests", + "documentation":"

    Information about the WorkSpaces that could not be started.

    " + } + } + }, + "StopRequest":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + }, + "documentation":"

    Describes the information used to stop a WorkSpace.

    " + }, + "StopWorkspaceRequests":{ + "type":"list", + "member":{"shape":"StopRequest"}, + "max":25, + "min":1 + }, + "StopWorkspacesRequest":{ + "type":"structure", + "required":["StopWorkspaceRequests"], + "members":{ + "StopWorkspaceRequests":{ + "shape":"StopWorkspaceRequests", + "documentation":"

    The WorkSpaces to stop. You can specify up to 25 WorkSpaces.

    " + } + } + }, + "StopWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedStopWorkspaceRequests", + "documentation":"

    Information about the WorkSpaces that could not be stopped.

    " + } + } + }, + "SubnetId":{ + "type":"string", + "pattern":"^(subnet-[0-9a-f]{8})$" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"} + }, + "Tag":{ + "type":"structure", + "required":["Key"], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

    The key of the tag.

    " + }, + "Value":{ + "shape":"TagValue", + "documentation":"

    The value of the tag.

    " + } + }, + "documentation":"

    Describes a tag.

    " + }, + "TagKey":{ + "type":"string", + "max":127, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"NonEmptyString"} + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"} + }, + "TagValue":{ + "type":"string", + "max":255 + }, + "TargetWorkspaceState":{ + "type":"string", + "enum":[ + "AVAILABLE", + "ADMIN_MAINTENANCE" + ] + }, + "TerminateRequest":{ + "type":"structure", + "required":["WorkspaceId"], + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + } + }, + "documentation":"

    Describes the information used to terminate a WorkSpace.

    " + }, + "TerminateWorkspaceRequests":{ + "type":"list", + "member":{"shape":"TerminateRequest"}, + "max":25, + "min":1 + }, + "TerminateWorkspacesRequest":{ + "type":"structure", + "required":["TerminateWorkspaceRequests"], + "members":{ + "TerminateWorkspaceRequests":{ + "shape":"TerminateWorkspaceRequests", + "documentation":"

    The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.

    " + } + } + }, + "TerminateWorkspacesResult":{ + "type":"structure", + "members":{ + "FailedRequests":{ + "shape":"FailedTerminateWorkspaceRequests", + "documentation":"

    Information about the WorkSpaces that could not be terminated.

    " + } + } + }, + "Timestamp":{"type":"timestamp"}, + "UnsupportedWorkspaceConfigurationException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

    The configuration of this WorkSpace is not supported for this operation. For more information, see the Amazon WorkSpaces Administration Guide.

    ", + "exception":true + }, + "UpdateRulesOfIpGroupRequest":{ + "type":"structure", + "required":[ + "GroupId", + "UserRules" + ], + "members":{ + "GroupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the group.

    " + }, + "UserRules":{ + "shape":"IpRuleList", + "documentation":"

    One or more rules.

    " + } + } + }, + "UpdateRulesOfIpGroupResult":{ + "type":"structure", + "members":{ + } + }, + "UserName":{ + "type":"string", + "max":63, + "min":1 + }, + "UserStorage":{ + "type":"structure", + "members":{ + "Capacity":{ + "shape":"NonEmptyString", + "documentation":"

    The size of the user storage.

    " + } + }, + "documentation":"

    Describes the user storage for a WorkSpace bundle.

    " + }, + "UserVolumeSizeGib":{"type":"integer"}, + "VolumeEncryptionKey":{"type":"string"}, + "Workspace":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + }, + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The identifier of the AWS Directory Service directory for the WorkSpace.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The user for the WorkSpace.

    " + }, + "IpAddress":{ + "shape":"IpAddress", + "documentation":"

    The IP address of the WorkSpace.

    " + }, + "State":{ + "shape":"WorkspaceState", + "documentation":"

    The operational state of the WorkSpace.

    " + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"

    The identifier of the bundle used to create the WorkSpace.

    " + }, + "SubnetId":{ + "shape":"SubnetId", + "documentation":"

    The identifier of the subnet for the WorkSpace.

    " + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"

    The text of the error message that is returned if the WorkSpace cannot be created.

    " + }, + "ErrorCode":{ + "shape":"WorkspaceErrorCode", + "documentation":"

    The error code that is returned if the WorkSpace cannot be created.

    " + }, + "ComputerName":{ + "shape":"ComputerName", + "documentation":"

    The name of the WorkSpace, as seen by the operating system.

    " + }, + "VolumeEncryptionKey":{ + "shape":"VolumeEncryptionKey", + "documentation":"

    The KMS key used to encrypt data stored on your WorkSpace.

    " + }, + "UserVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"

    Indicates whether the data stored on the user volume is encrypted.

    " + }, + "RootVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"

    Indicates whether the data stored on the root volume is encrypted.

    " + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"

    The properties of the WorkSpace.

    " + }, + "ModificationStates":{ + "shape":"ModificationStateList", + "documentation":"

    The modification states of the WorkSpace.

    " + } + }, + "documentation":"

    Describes a WorkSpace.

    " + }, + "WorkspaceBundle":{ + "type":"structure", + "members":{ + "BundleId":{ + "shape":"BundleId", + "documentation":"

    The bundle identifier.

    " + }, + "Name":{ + "shape":"NonEmptyString", + "documentation":"

    The name of the bundle.

    " + }, + "Owner":{ + "shape":"BundleOwner", + "documentation":"

    The owner of the bundle. This is the account identifier of the owner, or AMAZON if the bundle is provided by AWS.

    " + }, + "Description":{ + "shape":"Description", + "documentation":"

    A description.

    " + }, + "RootStorage":{ + "shape":"RootStorage", + "documentation":"

    The size of the root volume.

    " + }, + "UserStorage":{ + "shape":"UserStorage", + "documentation":"

    The size of the user storage.

    " + }, + "ComputeType":{ + "shape":"ComputeType", + "documentation":"

    The compute type. For more information, see Amazon WorkSpaces Bundles.

    " + } + }, + "documentation":"

    Describes a WorkSpace bundle.

    " + }, + "WorkspaceConnectionStatus":{ + "type":"structure", + "members":{ + "WorkspaceId":{ + "shape":"WorkspaceId", + "documentation":"

    The identifier of the WorkSpace.

    " + }, + "ConnectionState":{ + "shape":"ConnectionState", + "documentation":"

    The connection state of the WorkSpace. The connection state is unknown if the WorkSpace is stopped.

    " + }, + "ConnectionStateCheckTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The timestamp of the connection status check.

    " + }, + "LastKnownUserConnectionTimestamp":{ + "shape":"Timestamp", + "documentation":"

    The timestamp of the last known user connection.

    " + } + }, + "documentation":"

    Describes the connection status of a WorkSpace.

    " + }, + "WorkspaceConnectionStatusList":{ + "type":"list", + "member":{"shape":"WorkspaceConnectionStatus"} + }, + "WorkspaceDirectory":{ + "type":"structure", + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The directory identifier.

    " + }, + "Alias":{ + "shape":"Alias", + "documentation":"

    The directory alias.

    " + }, + "DirectoryName":{ + "shape":"DirectoryName", + "documentation":"

    The name of the directory.

    " + }, + "RegistrationCode":{ + "shape":"RegistrationCode", + "documentation":"

    The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

    " + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

    The identifiers of the subnets used with the directory.

    " + }, + "DnsIpAddresses":{ + "shape":"DnsIpAddresses", + "documentation":"

    The IP addresses of the DNS servers for the directory.

    " + }, + "CustomerUserName":{ + "shape":"UserName", + "documentation":"

    The user name for the service account.

    " + }, + "IamRoleId":{ + "shape":"ARN", + "documentation":"

    The identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

    " + }, + "DirectoryType":{ + "shape":"WorkspaceDirectoryType", + "documentation":"

    The directory type.

    " + }, + "WorkspaceSecurityGroupId":{ + "shape":"SecurityGroupId", + "documentation":"

    The identifier of the security group that is assigned to new WorkSpaces.

    " + }, + "State":{ + "shape":"WorkspaceDirectoryState", + "documentation":"

    The state of the directory's registration with Amazon WorkSpaces

    " + }, + "WorkspaceCreationProperties":{ + "shape":"DefaultWorkspaceCreationProperties", + "documentation":"

    The default creation properties for all WorkSpaces in the directory.

    " + }, + "ipGroupIds":{ + "shape":"IpGroupIdList", + "documentation":"

    The identifiers of the IP access control groups associated with the directory.

    " + } + }, + "documentation":"

    Describes an AWS Directory Service directory that is used with Amazon WorkSpaces.

    " + }, + "WorkspaceDirectoryState":{ + "type":"string", + "enum":[ + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "DEREGISTERED", + "ERROR" + ] + }, + "WorkspaceDirectoryType":{ + "type":"string", + "enum":[ + "SIMPLE_AD", + "AD_CONNECTOR" + ] + }, + "WorkspaceErrorCode":{"type":"string"}, + "WorkspaceId":{ + "type":"string", + "pattern":"^ws-[0-9a-z]{8,63}$" + }, + "WorkspaceIdList":{ + "type":"list", + "member":{"shape":"WorkspaceId"}, + "max":25, + "min":1 + }, + "WorkspaceImage":{ + "type":"structure", + "members":{ + "ImageId":{ + "shape":"WorkspaceImageId", + "documentation":"

    The identifier of the image.

    " + }, + "Name":{ + "shape":"WorkspaceImageName", + "documentation":"

    The name of the image.

    " + }, + "Description":{ + "shape":"WorkspaceImageDescription", + "documentation":"

    The description of the image.

    " + }, + "OperatingSystem":{ + "shape":"OperatingSystem", + "documentation":"

    The operating system that the image is running.

    " + }, + "State":{ + "shape":"WorkspaceImageState", + "documentation":"

    The status of the image.

    " + }, + "RequiredTenancy":{ + "shape":"WorkspaceImageRequiredTenancy", + "documentation":"

    Specifies whether the image is running on dedicated hardware. When bring your own license (BYOL) is enabled, this value is set to DEDICATED.

    " + }, + "ErrorCode":{ + "shape":"WorkspaceImageErrorCode", + "documentation":"

    The error code that is returned for the image.

    " + }, + "ErrorMessage":{ + "shape":"Description", + "documentation":"

    The text of the error message that is returned for the image.

    " + } + }, + "documentation":"

    Describes a WorkSpace image.

    " + }, + "WorkspaceImageDescription":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9_./() -]+$" + }, + "WorkspaceImageErrorCode":{"type":"string"}, + "WorkspaceImageId":{ + "type":"string", + "pattern":"wsi-[0-9a-z]{9,63}$" + }, + "WorkspaceImageIdList":{ + "type":"list", + "member":{"shape":"WorkspaceImageId"}, + "max":25, + "min":1 + }, + "WorkspaceImageIngestionProcess":{ + "type":"string", + "enum":[ + "BYOL_REGULAR", + "BYOL_GRAPHICS", + "BYOL_GRAPHICSPRO" + ] + }, + "WorkspaceImageList":{ + "type":"list", + "member":{"shape":"WorkspaceImage"} + }, + "WorkspaceImageName":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9_./()\\\\-]+$" + }, + "WorkspaceImageRequiredTenancy":{ + "type":"string", + "enum":[ + "DEFAULT", + "DEDICATED" + ] + }, + "WorkspaceImageState":{ + "type":"string", + "enum":[ + "AVAILABLE", + "PENDING", + "ERROR" + ] + }, + "WorkspaceList":{ + "type":"list", + "member":{"shape":"Workspace"} + }, + "WorkspaceProperties":{ + "type":"structure", + "members":{ + "RunningMode":{ + "shape":"RunningMode", + "documentation":"

    The running mode. For more information, see Manage the WorkSpace Running Mode.

    " + }, + "RunningModeAutoStopTimeoutInMinutes":{ + "shape":"RunningModeAutoStopTimeoutInMinutes", + "documentation":"

    The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

    " + }, + "RootVolumeSizeGib":{ + "shape":"RootVolumeSizeGib", + "documentation":"

    The size of the root volume.

    " + }, + "UserVolumeSizeGib":{ + "shape":"UserVolumeSizeGib", + "documentation":"

    The size of the user storage.

    " + }, + "ComputeTypeName":{ + "shape":"Compute", + "documentation":"

    The compute type. For more information, see Amazon WorkSpaces Bundles.

    " + } + }, + "documentation":"

    Describes a WorkSpace.

    " + }, + "WorkspaceRequest":{ + "type":"structure", + "required":[ + "DirectoryId", + "UserName", + "BundleId" + ], + "members":{ + "DirectoryId":{ + "shape":"DirectoryId", + "documentation":"

    The identifier of the AWS Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

    " + }, + "UserName":{ + "shape":"UserName", + "documentation":"

    The username of the user for the WorkSpace. This username must exist in the AWS Directory Service directory for the WorkSpace.

    " + }, + "BundleId":{ + "shape":"BundleId", + "documentation":"

    The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    " + }, + "VolumeEncryptionKey":{ + "shape":"VolumeEncryptionKey", + "documentation":"

    The KMS key used to encrypt data stored on your WorkSpace.

    " + }, + "UserVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"

    Indicates whether the data stored on the user volume is encrypted.

    " + }, + "RootVolumeEncryptionEnabled":{ + "shape":"BooleanObject", + "documentation":"

    Indicates whether the data stored on the root volume is encrypted.

    " + }, + "WorkspaceProperties":{ + "shape":"WorkspaceProperties", + "documentation":"

    The WorkSpace properties.

    " + }, + "Tags":{ + "shape":"TagList", + "documentation":"

    The tags for the WorkSpace.

    " + } + }, + "documentation":"

    Describes the information used to create a WorkSpace.

    " + }, + "WorkspaceRequestList":{ + "type":"list", + "member":{"shape":"WorkspaceRequest"}, + "max":25, + "min":1 + }, + "WorkspaceState":{ + "type":"string", + "enum":[ + "PENDING", + "AVAILABLE", + "IMPAIRED", + "UNHEALTHY", + "REBOOTING", + "STARTING", + "REBUILDING", + "RESTORING", + "MAINTENANCE", + "ADMIN_MAINTENANCE", + "TERMINATING", + "TERMINATED", + "SUSPENDED", + "UPDATING", + "STOPPING", + "STOPPED", + "ERROR" + ] + }, + "WorkspacesIpGroup":{ + "type":"structure", + "members":{ + "groupId":{ + "shape":"IpGroupId", + "documentation":"

    The identifier of the group.

    " + }, + "groupName":{ + "shape":"IpGroupName", + "documentation":"

    The name of the group.

    " + }, + "groupDesc":{ + "shape":"IpGroupDesc", + "documentation":"

    The description of the group.

    " + }, + "userRules":{ + "shape":"IpRuleList", + "documentation":"

    The rules.

    " + } + }, + "documentation":"

    Describes an IP access control group.

    " + }, + "WorkspacesIpGroupsList":{ + "type":"list", + "member":{"shape":"WorkspacesIpGroup"} + } + }, + "documentation":"Amazon WorkSpaces Service

    Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows and Amazon Linux desktops for your users.

    " +} diff --git a/aws/dist/botocore/data/xray/2016-04-12/examples-1.json b/aws/dist/botocore/data/xray/2016-04-12/examples-1.json new file mode 100644 index 00000000..0ea7e3b0 --- /dev/null +++ b/aws/dist/botocore/data/xray/2016-04-12/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/aws/dist/botocore/data/xray/2016-04-12/paginators-1.json b/aws/dist/botocore/data/xray/2016-04-12/paginators-1.json new file mode 100644 index 00000000..c416bf87 --- /dev/null +++ b/aws/dist/botocore/data/xray/2016-04-12/paginators-1.json @@ -0,0 +1,59 @@ +{ + "pagination": { + "BatchGetTraces": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Traces", + "non_aggregate_keys": [ + "UnprocessedTraceIds" + ] + }, + "GetServiceGraph": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Services", + "non_aggregate_keys": [ + "StartTime", + "EndTime", + "ContainsOldGroupVersions" + ] + }, + "GetTraceGraph": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Services" + }, + "GetTraceSummaries": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "TraceSummaries", + "non_aggregate_keys": [ + "TracesProcessedCount", + "ApproximateTime" + ] + }, + "GetGroups": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "Groups" + }, + "GetSamplingRules": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingRuleRecords" + }, + "GetSamplingStatisticSummaries": { + "input_token": "NextToken", + "output_token": "NextToken", + "result_key": "SamplingStatisticSummaries" + }, + "GetTimeSeriesServiceStatistics": { + "input_token": "NextToken", + "non_aggregate_keys": [ + "ContainsOldGroupVersions" + ], + "output_token": "NextToken", + "result_key": "TimeSeriesServiceStatistics" + } + } +} diff --git a/aws/dist/botocore/data/xray/2016-04-12/service-2.json b/aws/dist/botocore/data/xray/2016-04-12/service-2.json new file mode 100644 index 00000000..9271ab6f --- /dev/null +++ b/aws/dist/botocore/data/xray/2016-04-12/service-2.json @@ -0,0 +1,2236 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2016-04-12", + "endpointPrefix":"xray", + "protocol":"rest-json", + "serviceFullName":"AWS X-Ray", + "serviceId":"XRay", + "signatureVersion":"v4", + "uid":"xray-2016-04-12" + }, + "operations":{ + "BatchGetTraces":{ + "name":"BatchGetTraces", + "http":{ + "method":"POST", + "requestUri":"/Traces" + }, + "input":{"shape":"BatchGetTracesRequest"}, + "output":{"shape":"BatchGetTracesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

    " + }, + "CreateGroup":{ + "name":"CreateGroup", + "http":{ + "method":"POST", + "requestUri":"/CreateGroup" + }, + "input":{"shape":"CreateGroupRequest"}, + "output":{"shape":"CreateGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Creates a group resource with a name and a filter expression.

    " + }, + "CreateSamplingRule":{ + "name":"CreateSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/CreateSamplingRule" + }, + "input":{"shape":"CreateSamplingRuleRequest"}, + "output":{"shape":"CreateSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"}, + {"shape":"RuleLimitExceededException"} + ], + "documentation":"

    Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

    " + }, + "DeleteGroup":{ + "name":"DeleteGroup", + "http":{ + "method":"POST", + "requestUri":"/DeleteGroup" + }, + "input":{"shape":"DeleteGroupRequest"}, + "output":{"shape":"DeleteGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Deletes a group resource.

    " + }, + "DeleteSamplingRule":{ + "name":"DeleteSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/DeleteSamplingRule" + }, + "input":{"shape":"DeleteSamplingRuleRequest"}, + "output":{"shape":"DeleteSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Deletes a sampling rule.

    " + }, + "GetEncryptionConfig":{ + "name":"GetEncryptionConfig", + "http":{ + "method":"POST", + "requestUri":"/EncryptionConfig" + }, + "input":{"shape":"GetEncryptionConfigRequest"}, + "output":{"shape":"GetEncryptionConfigResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves the current encryption configuration for X-Ray data.

    " + }, + "GetGroup":{ + "name":"GetGroup", + "http":{ + "method":"POST", + "requestUri":"/GetGroup" + }, + "input":{"shape":"GetGroupRequest"}, + "output":{"shape":"GetGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves group resource details.

    " + }, + "GetGroups":{ + "name":"GetGroups", + "http":{ + "method":"POST", + "requestUri":"/Groups" + }, + "input":{"shape":"GetGroupsRequest"}, + "output":{"shape":"GetGroupsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves all active group details.

    " + }, + "GetSamplingRules":{ + "name":"GetSamplingRules", + "http":{ + "method":"POST", + "requestUri":"/GetSamplingRules" + }, + "input":{"shape":"GetSamplingRulesRequest"}, + "output":{"shape":"GetSamplingRulesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves all sampling rules.

    " + }, + "GetSamplingStatisticSummaries":{ + "name":"GetSamplingStatisticSummaries", + "http":{ + "method":"POST", + "requestUri":"/SamplingStatisticSummaries" + }, + "input":{"shape":"GetSamplingStatisticSummariesRequest"}, + "output":{"shape":"GetSamplingStatisticSummariesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves information about recent sampling results for all sampling rules.

    " + }, + "GetSamplingTargets":{ + "name":"GetSamplingTargets", + "http":{ + "method":"POST", + "requestUri":"/SamplingTargets" + }, + "input":{"shape":"GetSamplingTargetsRequest"}, + "output":{"shape":"GetSamplingTargetsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Requests a sampling quota for rules that the service is using to sample requests.

    " + }, + "GetServiceGraph":{ + "name":"GetServiceGraph", + "http":{ + "method":"POST", + "requestUri":"/ServiceGraph" + }, + "input":{"shape":"GetServiceGraphRequest"}, + "output":{"shape":"GetServiceGraphResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

    " + }, + "GetTimeSeriesServiceStatistics":{ + "name":"GetTimeSeriesServiceStatistics", + "http":{ + "method":"POST", + "requestUri":"/TimeSeriesServiceStatistics" + }, + "input":{"shape":"GetTimeSeriesServiceStatisticsRequest"}, + "output":{"shape":"GetTimeSeriesServiceStatisticsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Get an aggregation of service statistics defined by a specific time range.

    " + }, + "GetTraceGraph":{ + "name":"GetTraceGraph", + "http":{ + "method":"POST", + "requestUri":"/TraceGraph" + }, + "input":{"shape":"GetTraceGraphRequest"}, + "output":{"shape":"GetTraceGraphResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves a service graph for one or more specific trace IDs.

    " + }, + "GetTraceSummaries":{ + "name":"GetTraceSummaries", + "http":{ + "method":"POST", + "requestUri":"/TraceSummaries" + }, + "input":{"shape":"GetTraceSummariesRequest"}, + "output":{"shape":"GetTraceSummariesResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

    A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

    service(\"api.example.com\")

    This filter expression finds traces that have an annotation named account with the value 12345:

    annotation.account = \"12345\"

    For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.

    " + }, + "PutEncryptionConfig":{ + "name":"PutEncryptionConfig", + "http":{ + "method":"POST", + "requestUri":"/PutEncryptionConfig" + }, + "input":{"shape":"PutEncryptionConfigRequest"}, + "output":{"shape":"PutEncryptionConfigResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Updates the encryption configuration for X-Ray data.

    " + }, + "PutTelemetryRecords":{ + "name":"PutTelemetryRecords", + "http":{ + "method":"POST", + "requestUri":"/TelemetryRecords" + }, + "input":{"shape":"PutTelemetryRecordsRequest"}, + "output":{"shape":"PutTelemetryRecordsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Used by the AWS X-Ray daemon to upload telemetry.

    " + }, + "PutTraceSegments":{ + "name":"PutTraceSegments", + "http":{ + "method":"POST", + "requestUri":"/TraceSegments" + }, + "input":{"shape":"PutTraceSegmentsRequest"}, + "output":{"shape":"PutTraceSegmentsResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

    Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.

    Required Segment Document Fields

    • name - The name of the service that handled the request.

    • id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

    • trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

    • start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

    • end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

    • in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in progress segment when your application receives a request that will take a long time to serve, to trace the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

    A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

    Trace ID Format

    • The version number, i.e. 1.

    • The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.

    • A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

    " + }, + "UpdateGroup":{ + "name":"UpdateGroup", + "http":{ + "method":"POST", + "requestUri":"/UpdateGroup" + }, + "input":{"shape":"UpdateGroupRequest"}, + "output":{"shape":"UpdateGroupResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Updates a group resource.

    " + }, + "UpdateSamplingRule":{ + "name":"UpdateSamplingRule", + "http":{ + "method":"POST", + "requestUri":"/UpdateSamplingRule" + }, + "input":{"shape":"UpdateSamplingRuleRequest"}, + "output":{"shape":"UpdateSamplingRuleResult"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"ThrottledException"} + ], + "documentation":"

    Modifies a sampling rule's configuration.

    " + } + }, + "shapes":{ + "Alias":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The canonical name of the alias.

    " + }, + "Names":{ + "shape":"AliasNames", + "documentation":"

    A list of names for the alias, including the canonical name.

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    The type of the alias.

    " + } + }, + "documentation":"

    An alias for an edge.

    " + }, + "AliasList":{ + "type":"list", + "member":{"shape":"Alias"} + }, + "AliasNames":{ + "type":"list", + "member":{"shape":"String"} + }, + "AnnotationKey":{"type":"string"}, + "AnnotationValue":{ + "type":"structure", + "members":{ + "NumberValue":{ + "shape":"NullableDouble", + "documentation":"

    Value for a Number annotation.

    " + }, + "BooleanValue":{ + "shape":"NullableBoolean", + "documentation":"

    Value for a Boolean annotation.

    " + }, + "StringValue":{ + "shape":"String", + "documentation":"

    Value for a String annotation.

    " + } + }, + "documentation":"

    Value of a segment annotation. Has one of three value types: Number, Boolean or String.

    " + }, + "Annotations":{ + "type":"map", + "key":{"shape":"AnnotationKey"}, + "value":{"shape":"ValuesWithServiceIds"} + }, + "AttributeKey":{ + "type":"string", + "max":32, + "min":1 + }, + "AttributeMap":{ + "type":"map", + "key":{"shape":"AttributeKey"}, + "value":{"shape":"AttributeValue"}, + "max":5 + }, + "AttributeValue":{ + "type":"string", + "max":32, + "min":1 + }, + "AvailabilityZoneDetail":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of a corresponding availability zone.

    " + } + }, + "documentation":"

    A list of availability zones corresponding to the segments in a trace.

    " + }, + "BackendConnectionErrors":{ + "type":"structure", + "members":{ + "TimeoutCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "ConnectionRefusedCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "HTTPCode4XXCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "HTTPCode5XXCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "UnknownHostCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "OtherCount":{ + "shape":"NullableInteger", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "BatchGetTracesRequest":{ + "type":"structure", + "required":["TraceIds"], + "members":{ + "TraceIds":{ + "shape":"TraceIdList", + "documentation":"

    Specify the trace IDs of requests for which to retrieve segments.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "BatchGetTracesResult":{ + "type":"structure", + "members":{ + "Traces":{ + "shape":"TraceList", + "documentation":"

    Full traces for the specified requests.

    " + }, + "UnprocessedTraceIds":{ + "shape":"UnprocessedTraceIdList", + "documentation":"

    Trace IDs of requests that haven't been processed.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "Boolean":{"type":"boolean"}, + "BorrowCount":{ + "type":"integer", + "min":0 + }, + "ClientID":{ + "type":"string", + "max":24, + "min":24 + }, + "CreateGroupRequest":{ + "type":"structure", + "required":["GroupName"], + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The case-sensitive name of the new group. Default is a reserved name and names must be unique.

    " + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"

    The filter expression defining criteria by which to group traces.

    " + } + } + }, + "CreateGroupResult":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The group that was created. Contains the name of the group that was created, the ARN of the group that was generated based on the group name, and the filter expression that was assigned to the group.

    " + } + } + }, + "CreateSamplingRuleRequest":{ + "type":"structure", + "required":["SamplingRule"], + "members":{ + "SamplingRule":{ + "shape":"SamplingRule", + "documentation":"

    The rule definition.

    " + } + } + }, + "CreateSamplingRuleResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecord":{ + "shape":"SamplingRuleRecord", + "documentation":"

    The saved rule definition and metadata.

    " + } + } + }, + "DeleteGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The case-sensitive name of the group.

    " + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"

    The ARN of the group that was generated on creation.

    " + } + } + }, + "DeleteGroupResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteSamplingRuleRequest":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + }, + "RuleARN":{ + "shape":"String", + "documentation":"

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + } + } + }, + "DeleteSamplingRuleResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecord":{ + "shape":"SamplingRuleRecord", + "documentation":"

    The deleted rule definition and metadata.

    " + } + } + }, + "Double":{"type":"double"}, + "EC2InstanceId":{ + "type":"string", + "max":20 + }, + "Edge":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"

    Identifier of the edge. Unique within a service map.

    " + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the first segment on the edge.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end time of the last segment on the edge.

    " + }, + "SummaryStatistics":{ + "shape":"EdgeStatistics", + "documentation":"

    Response statistics for segments on the edge.

    " + }, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"

    A histogram that maps the spread of client response times on an edge.

    " + }, + "Aliases":{ + "shape":"AliasList", + "documentation":"

    Aliases for the edge.

    " + } + }, + "documentation":"

    Information about a connection between two services.

    " + }, + "EdgeList":{ + "type":"list", + "member":{"shape":"Edge"} + }, + "EdgeStatistics":{ + "type":"structure", + "members":{ + "OkCount":{ + "shape":"NullableLong", + "documentation":"

    The number of requests that completed with a 2xx Success status code.

    " + }, + "ErrorStatistics":{ + "shape":"ErrorStatistics", + "documentation":"

    Information about requests that failed with a 4xx Client Error status code.

    " + }, + "FaultStatistics":{ + "shape":"FaultStatistics", + "documentation":"

    Information about requests that failed with a 5xx Server Error status code.

    " + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"

    The total number of completed requests.

    " + }, + "TotalResponseTime":{ + "shape":"NullableDouble", + "documentation":"

    The aggregate response time of completed requests.

    " + } + }, + "documentation":"

    Response statistics for an edge.

    " + }, + "EncryptionConfig":{ + "type":"structure", + "members":{ + "KeyId":{ + "shape":"String", + "documentation":"

    The ID of the customer master key (CMK) used for encryption, if applicable.

    " + }, + "Status":{ + "shape":"EncryptionStatus", + "documentation":"

    The encryption status. While the status is UPDATING, X-Ray may encrypt data with a combination of the new and old settings.

    " + }, + "Type":{ + "shape":"EncryptionType", + "documentation":"

    The type of encryption. Set to KMS for encryption with CMKs. Set to NONE for default encryption.

    " + } + }, + "documentation":"

    A configuration document that specifies encryption configuration settings.

    " + }, + "EncryptionKeyId":{ + "type":"string", + "max":3000, + "min":1 + }, + "EncryptionStatus":{ + "type":"string", + "enum":[ + "UPDATING", + "ACTIVE" + ] + }, + "EncryptionType":{ + "type":"string", + "enum":[ + "NONE", + "KMS" + ] + }, + "EntitySelectorExpression":{ + "type":"string", + "max":500, + "min":1 + }, + "ErrorMessage":{"type":"string"}, + "ErrorRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ErrorRootCauseServices", + "documentation":"

    A list of services corresponding to an error. A service identifies a segment and it contains a name, account ID, type, and inferred flag.

    " + } + }, + "documentation":"

    The root cause of a trace summary error.

    " + }, + "ErrorRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the entity.

    " + }, + "Exceptions":{ + "shape":"RootCauseExceptions", + "documentation":"

    The types and messages of the exceptions.

    " + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"

    A flag that denotes a remote subsegment.

    " + } + }, + "documentation":"

    A collection of segments and corresponding subsegments associated to a trace summary error.

    " + }, + "ErrorRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"ErrorRootCauseEntity"} + }, + "ErrorRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The service name.

    " + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"

    A collection of associated service names.

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    The type associated to the service.

    " + }, + "AccountId":{ + "shape":"String", + "documentation":"

    The account ID associated to the service.

    " + }, + "EntityPath":{ + "shape":"ErrorRootCauseEntityPath", + "documentation":"

    The path of root cause entities found on the service.

    " + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"

    A Boolean value indicating if the service is inferred from the trace.

    " + } + }, + "documentation":"

    A collection of fields identifying the services in a trace summary error.

    " + }, + "ErrorRootCauseServices":{ + "type":"list", + "member":{"shape":"ErrorRootCauseService"} + }, + "ErrorRootCauses":{ + "type":"list", + "member":{"shape":"ErrorRootCause"} + }, + "ErrorStatistics":{ + "type":"structure", + "members":{ + "ThrottleCount":{ + "shape":"NullableLong", + "documentation":"

    The number of requests that failed with a 419 throttling status code.

    " + }, + "OtherCount":{ + "shape":"NullableLong", + "documentation":"

    The number of requests that failed with untracked 4xx Client Error status codes.

    " + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"

    The total number of requests that failed with a 4xx Client Error status code.

    " + } + }, + "documentation":"

    Information about requests that failed with a 4xx Client Error status code.

    " + }, + "FaultRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"FaultRootCauseServices", + "documentation":"

    A list of corresponding services. A service identifies a segment and it contains a name, account ID, type, and inferred flag.

    " + } + }, + "documentation":"

    The root cause information for a trace summary fault.

    " + }, + "FaultRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the entity.

    " + }, + "Exceptions":{ + "shape":"RootCauseExceptions", + "documentation":"

    The types and messages of the exceptions.

    " + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"

    A flag that denotes a remote subsegment.

    " + } + }, + "documentation":"

    A collection of segments and corresponding subsegments associated to a trace summary fault error.

    " + }, + "FaultRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"FaultRootCauseEntity"} + }, + "FaultRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The service name.

    " + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"

    A collection of associated service names.

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    The type associated to the service.

    " + }, + "AccountId":{ + "shape":"String", + "documentation":"

    The account ID associated to the service.

    " + }, + "EntityPath":{ + "shape":"FaultRootCauseEntityPath", + "documentation":"

    The path of root cause entities found on the service.

    " + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"

    A Boolean value indicating if the service is inferred from the trace.

    " + } + }, + "documentation":"

    A collection of fields identifying the services in a trace summary fault.

    " + }, + "FaultRootCauseServices":{ + "type":"list", + "member":{"shape":"FaultRootCauseService"} + }, + "FaultRootCauses":{ + "type":"list", + "member":{"shape":"FaultRootCause"} + }, + "FaultStatistics":{ + "type":"structure", + "members":{ + "OtherCount":{ + "shape":"NullableLong", + "documentation":"

    The number of requests that failed with untracked 5xx Server Error status codes.

    " + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"

    The total number of requests that failed with a 5xx Server Error status code.

    " + } + }, + "documentation":"

    Information about requests that failed with a 5xx Server Error status code.

    " + }, + "FilterExpression":{"type":"string"}, + "FixedRate":{ + "type":"double", + "max":1, + "min":0 + }, + "GetEncryptionConfigRequest":{ + "type":"structure", + "members":{ + } + }, + "GetEncryptionConfigResult":{ + "type":"structure", + "members":{ + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

    The encryption configuration document.

    " + } + } + }, + "GetGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The case-sensitive name of the group.

    " + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"

    The ARN of the group that was generated on creation.

    " + } + } + }, + "GetGroupResult":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The group that was requested. Contains the name of the group, the ARN of the group, and the filter expression that assigned to the group.

    " + } + } + }, + "GetGroupsNextToken":{ + "type":"string", + "max":100, + "min":1 + }, + "GetGroupsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"GetGroupsNextToken", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetGroupsResult":{ + "type":"structure", + "members":{ + "Groups":{ + "shape":"GroupSummaryList", + "documentation":"

    The collection of all active groups.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetSamplingRulesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetSamplingRulesResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecords":{ + "shape":"SamplingRuleRecordList", + "documentation":"

    Rule definitions and metadata.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetSamplingStatisticSummariesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetSamplingStatisticSummariesResult":{ + "type":"structure", + "members":{ + "SamplingStatisticSummaries":{ + "shape":"SamplingStatisticSummaryList", + "documentation":"

    Information about the number of requests instrumented for each sampling rule.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetSamplingTargetsRequest":{ + "type":"structure", + "required":["SamplingStatisticsDocuments"], + "members":{ + "SamplingStatisticsDocuments":{ + "shape":"SamplingStatisticsDocumentList", + "documentation":"

    Information about rules that the service is using to sample requests.

    " + } + } + }, + "GetSamplingTargetsResult":{ + "type":"structure", + "members":{ + "SamplingTargetDocuments":{ + "shape":"SamplingTargetDocumentList", + "documentation":"

    Updated rules that the service should use to sample requests.

    " + }, + "LastRuleModification":{ + "shape":"Timestamp", + "documentation":"

    The last time a user changed the sampling rule configuration. If the sampling rule configuration changed since the service last retrieved it, the service should call GetSamplingRules to get the latest version.

    " + }, + "UnprocessedStatistics":{ + "shape":"UnprocessedStatisticsList", + "documentation":"

    Information about SamplingStatisticsDocument that X-Ray could not process.

    " + } + } + }, + "GetServiceGraphRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start of the time frame for which to generate a graph.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the timeframe for which to generate a graph.

    " + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The name of a group to generate a graph based on.

    " + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"

    The ARN of a group to generate a graph based on.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetServiceGraphResult":{ + "type":"structure", + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start of the time frame for which the graph was generated.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the time frame for which the graph was generated.

    " + }, + "Services":{ + "shape":"ServiceList", + "documentation":"

    The services that have processed a traced request during the specified time frame.

    " + }, + "ContainsOldGroupVersions":{ + "shape":"Boolean", + "documentation":"

    A flag indicating whether the group's filter expression has been consistent, or if the returned service graph may show traces from an older version of the group's filter expression.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetTimeSeriesServiceStatisticsRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start of the time frame for which to aggregate statistics.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the time frame for which to aggregate statistics.

    " + }, + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The case-sensitive name of the group for which to pull statistics from.

    " + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"

    The ARN of the group for which to pull statistics from.

    " + }, + "EntitySelectorExpression":{ + "shape":"EntitySelectorExpression", + "documentation":"

    A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.

    " + }, + "Period":{ + "shape":"NullableInteger", + "documentation":"

    Aggregation period in seconds.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetTimeSeriesServiceStatisticsResult":{ + "type":"structure", + "members":{ + "TimeSeriesServiceStatistics":{ + "shape":"TimeSeriesServiceStatisticsList", + "documentation":"

    The collection of statistics.

    " + }, + "ContainsOldGroupVersions":{ + "shape":"Boolean", + "documentation":"

    A flag indicating whether or not a group's filter expression has been consistent, or if a returned aggregation may show statistics from an older version of the group's filter expression.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetTraceGraphRequest":{ + "type":"structure", + "required":["TraceIds"], + "members":{ + "TraceIds":{ + "shape":"TraceIdList", + "documentation":"

    Trace IDs of requests for which to generate a service graph.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetTraceGraphResult":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ServiceList", + "documentation":"

    The services that have processed one of the specified requests.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Pagination token. Not used.

    " + } + } + }, + "GetTraceSummariesRequest":{ + "type":"structure", + "required":[ + "StartTime", + "EndTime" + ], + "members":{ + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start of the time frame for which to retrieve traces.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end of the time frame for which to retrieve traces.

    " + }, + "TimeRangeType":{ + "shape":"TimeRangeType", + "documentation":"

    A parameter to indicate whether to query trace summaries by TraceId or Event time.

    " + }, + "Sampling":{ + "shape":"NullableBoolean", + "documentation":"

    Set to true to get summaries for only a subset of available traces.

    " + }, + "SamplingStrategy":{ + "shape":"SamplingStrategy", + "documentation":"

    A paramater to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.

    " + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"

    Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    Specify the pagination token returned by a previous request to retrieve the next page of results.

    " + } + } + }, + "GetTraceSummariesResult":{ + "type":"structure", + "members":{ + "TraceSummaries":{ + "shape":"TraceSummaryList", + "documentation":"

    Trace IDs and metadata for traces that were found in the specified time frame.

    " + }, + "ApproximateTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of this page of results.

    " + }, + "TracesProcessedCount":{ + "shape":"NullableLong", + "documentation":"

    The total number of traces processed, including traces that did not match the specified filter expression.

    " + }, + "NextToken":{ + "shape":"String", + "documentation":"

    If the requested time frame contained more than one page of results, you can use this token to retrieve the next page. The first page contains the most most recent results, closest to the end of the time frame.

    " + } + } + }, + "Group":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

    The unique case-sensitive name of the group.

    " + }, + "GroupARN":{ + "shape":"String", + "documentation":"

    The ARN of the group generated based on the GroupName.

    " + }, + "FilterExpression":{ + "shape":"String", + "documentation":"

    The filter expression defining the parameters to include traces.

    " + } + }, + "documentation":"

    Details and metadata for a group.

    " + }, + "GroupARN":{ + "type":"string", + "max":400, + "min":1 + }, + "GroupName":{ + "type":"string", + "max":32, + "min":1 + }, + "GroupSummary":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"String", + "documentation":"

    The unique case-sensitive name of the group.

    " + }, + "GroupARN":{ + "shape":"String", + "documentation":"

    The ARN of the group generated based on the GroupName.

    " + }, + "FilterExpression":{ + "shape":"String", + "documentation":"

    The filter expression defining the parameters to include traces.

    " + } + }, + "documentation":"

    Details for a group without metadata.

    " + }, + "GroupSummaryList":{ + "type":"list", + "member":{"shape":"GroupSummary"} + }, + "HTTPMethod":{ + "type":"string", + "max":10 + }, + "Histogram":{ + "type":"list", + "member":{"shape":"HistogramEntry"} + }, + "HistogramEntry":{ + "type":"structure", + "members":{ + "Value":{ + "shape":"Double", + "documentation":"

    The value of the entry.

    " + }, + "Count":{ + "shape":"Integer", + "documentation":"

    The prevalence of the entry.

    " + } + }, + "documentation":"

    An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.

    " + }, + "Host":{ + "type":"string", + "max":64 + }, + "Hostname":{ + "type":"string", + "max":255 + }, + "Http":{ + "type":"structure", + "members":{ + "HttpURL":{ + "shape":"String", + "documentation":"

    The request URL.

    " + }, + "HttpStatus":{ + "shape":"NullableInteger", + "documentation":"

    The response status.

    " + }, + "HttpMethod":{ + "shape":"String", + "documentation":"

    The request method.

    " + }, + "UserAgent":{ + "shape":"String", + "documentation":"

    The request's user agent string.

    " + }, + "ClientIp":{ + "shape":"String", + "documentation":"

    The IP address of the requestor.

    " + } + }, + "documentation":"

    Information about an HTTP request.

    " + }, + "InstanceIdDetail":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    The ID of a corresponding EC2 instance.

    " + } + }, + "documentation":"

    A list of EC2 instance IDs corresponding to the segments in a trace.

    " + }, + "Integer":{"type":"integer"}, + "InvalidRequestException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request is missing required parameters or has invalid parameters.

    ", + "exception":true + }, + "NullableBoolean":{"type":"boolean"}, + "NullableDouble":{"type":"double"}, + "NullableInteger":{"type":"integer"}, + "NullableLong":{"type":"long"}, + "Priority":{ + "type":"integer", + "max":9999, + "min":1 + }, + "PutEncryptionConfigRequest":{ + "type":"structure", + "required":["Type"], + "members":{ + "KeyId":{ + "shape":"EncryptionKeyId", + "documentation":"

    An AWS KMS customer master key (CMK) in one of the following formats:

    • Alias - The name of the key. For example, alias/MyKey.

    • Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.

    • ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account.

    Omit this key if you set Type to NONE.

    " + }, + "Type":{ + "shape":"EncryptionType", + "documentation":"

    The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

    " + } + } + }, + "PutEncryptionConfigResult":{ + "type":"structure", + "members":{ + "EncryptionConfig":{ + "shape":"EncryptionConfig", + "documentation":"

    The new encryption configuration.

    " + } + } + }, + "PutTelemetryRecordsRequest":{ + "type":"structure", + "required":["TelemetryRecords"], + "members":{ + "TelemetryRecords":{ + "shape":"TelemetryRecordList", + "documentation":"

    " + }, + "EC2InstanceId":{ + "shape":"EC2InstanceId", + "documentation":"

    " + }, + "Hostname":{ + "shape":"Hostname", + "documentation":"

    " + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    " + } + } + }, + "PutTelemetryRecordsResult":{ + "type":"structure", + "members":{ + } + }, + "PutTraceSegmentsRequest":{ + "type":"structure", + "required":["TraceSegmentDocuments"], + "members":{ + "TraceSegmentDocuments":{ + "shape":"TraceSegmentDocumentList", + "documentation":"

    A string containing a JSON document defining one or more segments or subsegments.

    " + } + } + }, + "PutTraceSegmentsResult":{ + "type":"structure", + "members":{ + "UnprocessedTraceSegments":{ + "shape":"UnprocessedTraceSegmentList", + "documentation":"

    Segments that failed processing.

    " + } + } + }, + "RequestCount":{ + "type":"integer", + "min":0 + }, + "ReservoirSize":{ + "type":"integer", + "min":0 + }, + "ResourceARN":{ + "type":"string", + "max":500 + }, + "ResourceARNDetail":{ + "type":"structure", + "members":{ + "ARN":{ + "shape":"String", + "documentation":"

    The ARN of a corresponding resource.

    " + } + }, + "documentation":"

    A list of resources ARNs corresponding to the segments in a trace.

    " + }, + "ResponseTimeRootCause":{ + "type":"structure", + "members":{ + "Services":{ + "shape":"ResponseTimeRootCauseServices", + "documentation":"

    A list of corresponding services. A service identifies a segment and contains a name, account ID, type, and inferred flag.

    " + } + }, + "documentation":"

    The root cause information for a response time warning.

    " + }, + "ResponseTimeRootCauseEntity":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the entity.

    " + }, + "Coverage":{ + "shape":"NullableDouble", + "documentation":"

    The types and messages of the exceptions.

    " + }, + "Remote":{ + "shape":"NullableBoolean", + "documentation":"

    A flag that denotes a remote subsegment.

    " + } + }, + "documentation":"

    A collection of segments and corresponding subsegments associated to a response time warning.

    " + }, + "ResponseTimeRootCauseEntityPath":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCauseEntity"} + }, + "ResponseTimeRootCauseService":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The service name.

    " + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"

    A collection of associated service names.

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    The type associated to the service.

    " + }, + "AccountId":{ + "shape":"String", + "documentation":"

    The account ID associated to the service.

    " + }, + "EntityPath":{ + "shape":"ResponseTimeRootCauseEntityPath", + "documentation":"

    The path of root cause entities found on the service.

    " + }, + "Inferred":{ + "shape":"NullableBoolean", + "documentation":"

    A Boolean value indicating if the service is inferred from the trace.

    " + } + }, + "documentation":"

    A collection of fields identifying the service in a response time warning.

    " + }, + "ResponseTimeRootCauseServices":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCauseService"} + }, + "ResponseTimeRootCauses":{ + "type":"list", + "member":{"shape":"ResponseTimeRootCause"} + }, + "RootCauseException":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    The name of the exception.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    The message of the exception.

    " + } + }, + "documentation":"

    The exception associated with a root cause.

    " + }, + "RootCauseExceptions":{ + "type":"list", + "member":{"shape":"RootCauseException"} + }, + "RuleLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    You have reached the maximum number of sampling rules.

    ", + "exception":true + }, + "RuleName":{ + "type":"string", + "max":32, + "min":1 + }, + "SampledCount":{ + "type":"integer", + "min":0 + }, + "SamplingRule":{ + "type":"structure", + "required":[ + "ResourceARN", + "Priority", + "FixedRate", + "ReservoirSize", + "ServiceName", + "ServiceType", + "Host", + "HTTPMethod", + "URLPath", + "Version" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + }, + "RuleARN":{ + "shape":"String", + "documentation":"

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    Matches the ARN of the AWS resource on which the service runs.

    " + }, + "Priority":{ + "shape":"Priority", + "documentation":"

    The priority of the sampling rule.

    " + }, + "FixedRate":{ + "shape":"FixedRate", + "documentation":"

    The percentage of matching requests to instrument, after the reservoir is exhausted.

    " + }, + "ReservoirSize":{ + "shape":"ReservoirSize", + "documentation":"

    A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    Matches the name that the service uses to identify itself in segments.

    " + }, + "ServiceType":{ + "shape":"ServiceType", + "documentation":"

    Matches the origin that the service uses to identify its type in segments.

    " + }, + "Host":{ + "shape":"Host", + "documentation":"

    Matches the hostname from a request URL.

    " + }, + "HTTPMethod":{ + "shape":"HTTPMethod", + "documentation":"

    Matches the HTTP method of a request.

    " + }, + "URLPath":{ + "shape":"URLPath", + "documentation":"

    Matches the path from a request URL.

    " + }, + "Version":{ + "shape":"Version", + "documentation":"

    The version of the sampling rule format (1).

    " + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

    Matches attributes derived from the request.

    " + } + }, + "documentation":"

    A sampling rule that services use to decide whether to instrument a request. Rule fields can match properties of the service, or properties of a request. The service can ignore rules that don't match its properties.

    " + }, + "SamplingRuleRecord":{ + "type":"structure", + "members":{ + "SamplingRule":{ + "shape":"SamplingRule", + "documentation":"

    The sampling rule.

    " + }, + "CreatedAt":{ + "shape":"Timestamp", + "documentation":"

    When the rule was created.

    " + }, + "ModifiedAt":{ + "shape":"Timestamp", + "documentation":"

    When the rule was last modified.

    " + } + }, + "documentation":"

    A SamplingRule and its metadata.

    " + }, + "SamplingRuleRecordList":{ + "type":"list", + "member":{"shape":"SamplingRuleRecord"} + }, + "SamplingRuleUpdate":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"

    The name of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + }, + "RuleARN":{ + "shape":"String", + "documentation":"

    The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.

    " + }, + "ResourceARN":{ + "shape":"ResourceARN", + "documentation":"

    Matches the ARN of the AWS resource on which the service runs.

    " + }, + "Priority":{ + "shape":"NullableInteger", + "documentation":"

    The priority of the sampling rule.

    " + }, + "FixedRate":{ + "shape":"NullableDouble", + "documentation":"

    The percentage of matching requests to instrument, after the reservoir is exhausted.

    " + }, + "ReservoirSize":{ + "shape":"NullableInteger", + "documentation":"

    A fixed number of matching requests to instrument per second, prior to applying the fixed rate. The reservoir is not used directly by services, but applies to all services using the rule collectively.

    " + }, + "Host":{ + "shape":"Host", + "documentation":"

    Matches the hostname from a request URL.

    " + }, + "ServiceName":{ + "shape":"ServiceName", + "documentation":"

    Matches the name that the service uses to identify itself in segments.

    " + }, + "ServiceType":{ + "shape":"ServiceType", + "documentation":"

    Matches the origin that the service uses to identify its type in segments.

    " + }, + "HTTPMethod":{ + "shape":"HTTPMethod", + "documentation":"

    Matches the HTTP method of a request.

    " + }, + "URLPath":{ + "shape":"URLPath", + "documentation":"

    Matches the path from a request URL.

    " + }, + "Attributes":{ + "shape":"AttributeMap", + "documentation":"

    Matches attributes derived from the request.

    " + } + }, + "documentation":"

    A document specifying changes to a sampling rule's configuration.

    " + }, + "SamplingStatisticSummary":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"

    The name of the sampling rule.

    " + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The start time of the reporting window.

    " + }, + "RequestCount":{ + "shape":"Integer", + "documentation":"

    The number of requests that matched the rule.

    " + }, + "BorrowCount":{ + "shape":"Integer", + "documentation":"

    The number of requests recorded with borrowed reservoir quota.

    " + }, + "SampledCount":{ + "shape":"Integer", + "documentation":"

    The number of requests recorded.

    " + } + }, + "documentation":"

    Aggregated request sampling data for a sampling rule across all services for a 10 second window.

    " + }, + "SamplingStatisticSummaryList":{ + "type":"list", + "member":{"shape":"SamplingStatisticSummary"} + }, + "SamplingStatisticsDocument":{ + "type":"structure", + "required":[ + "RuleName", + "ClientID", + "Timestamp", + "RequestCount", + "SampledCount" + ], + "members":{ + "RuleName":{ + "shape":"RuleName", + "documentation":"

    The name of the sampling rule.

    " + }, + "ClientID":{ + "shape":"ClientID", + "documentation":"

    A unique identifier for the service in hexadecimal.

    " + }, + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    The current time.

    " + }, + "RequestCount":{ + "shape":"RequestCount", + "documentation":"

    The number of requests that matched the rule.

    " + }, + "SampledCount":{ + "shape":"SampledCount", + "documentation":"

    The number of requests recorded.

    " + }, + "BorrowCount":{ + "shape":"BorrowCount", + "documentation":"

    The number of requests recorded with borrowed reservoir quota.

    " + } + }, + "documentation":"

    Request sampling results for a single rule from a service. Results are for the last 10 seconds unless the service has been assigned a longer reporting interval after a previous call to GetSamplingTargets.

    " + }, + "SamplingStatisticsDocumentList":{ + "type":"list", + "member":{"shape":"SamplingStatisticsDocument"}, + "max":25 + }, + "SamplingStrategy":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"SamplingStrategyName", + "documentation":"

    The name of a sampling rule.

    " + }, + "Value":{ + "shape":"NullableDouble", + "documentation":"

    The value of a sampling rule.

    " + } + }, + "documentation":"

    The name and value of a sampling rule to apply to a trace summary.

    " + }, + "SamplingStrategyName":{ + "type":"string", + "enum":[ + "PartialScan", + "FixedRate" + ] + }, + "SamplingTargetDocument":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"

    The name of the sampling rule.

    " + }, + "FixedRate":{ + "shape":"Double", + "documentation":"

    The percentage of matching requests to instrument, after the reservoir is exhausted.

    " + }, + "ReservoirQuota":{ + "shape":"NullableInteger", + "documentation":"

    The number of requests per second that X-Ray allocated this service.

    " + }, + "ReservoirQuotaTTL":{ + "shape":"Timestamp", + "documentation":"

    When the reservoir quota expires.

    " + }, + "Interval":{ + "shape":"NullableInteger", + "documentation":"

    The number of seconds for the service to wait before getting sampling targets again.

    " + } + }, + "documentation":"

    Temporary changes to a sampling rule configuration. To meet the global sampling target for a rule, X-Ray calculates a new reservoir for each service based on the recent sampling results of all services that called GetSamplingTargets.

    " + }, + "SamplingTargetDocumentList":{ + "type":"list", + "member":{"shape":"SamplingTargetDocument"} + }, + "Segment":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"SegmentId", + "documentation":"

    The segment's ID.

    " + }, + "Document":{ + "shape":"SegmentDocument", + "documentation":"

    The segment document.

    " + } + }, + "documentation":"

    A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.

    For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.

    " + }, + "SegmentDocument":{ + "type":"string", + "min":1 + }, + "SegmentId":{"type":"string"}, + "SegmentList":{ + "type":"list", + "member":{"shape":"Segment"} + }, + "Service":{ + "type":"structure", + "members":{ + "ReferenceId":{ + "shape":"NullableInteger", + "documentation":"

    Identifier for the service. Unique within the service map.

    " + }, + "Name":{ + "shape":"String", + "documentation":"

    The canonical name of the service.

    " + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"

    A list of names for the service, including the canonical name.

    " + }, + "Root":{ + "shape":"NullableBoolean", + "documentation":"

    Indicates that the service was the first service to process a request.

    " + }, + "AccountId":{ + "shape":"String", + "documentation":"

    Identifier of the AWS account in which the service runs.

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    The type of service.

    • AWS Resource - The type of an AWS resource. For example, AWS::EC2::Instance for a application running on Amazon EC2 or AWS::DynamoDB::Table for an Amazon DynamoDB table that the application used.

    • AWS Service - The type of an AWS service. For example, AWS::DynamoDB for downstream calls to Amazon DynamoDB that didn't target a specific table.

    • client - Represents the clients that sent requests to a root service.

    • remote - A downstream service of indeterminate type.

    " + }, + "State":{ + "shape":"String", + "documentation":"

    The service's state.

    " + }, + "StartTime":{ + "shape":"Timestamp", + "documentation":"

    The start time of the first segment that the service generated.

    " + }, + "EndTime":{ + "shape":"Timestamp", + "documentation":"

    The end time of the last segment that the service generated.

    " + }, + "Edges":{ + "shape":"EdgeList", + "documentation":"

    Connections to downstream services.

    " + }, + "SummaryStatistics":{ + "shape":"ServiceStatistics", + "documentation":"

    Aggregated statistics for the service.

    " + }, + "DurationHistogram":{ + "shape":"Histogram", + "documentation":"

    A histogram that maps the spread of service durations.

    " + }, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"

    A histogram that maps the spread of service response times.

    " + } + }, + "documentation":"

    Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.

    " + }, + "ServiceId":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"String", + "documentation":"

    " + }, + "Names":{ + "shape":"ServiceNames", + "documentation":"

    " + }, + "AccountId":{ + "shape":"String", + "documentation":"

    " + }, + "Type":{ + "shape":"String", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "ServiceIds":{ + "type":"list", + "member":{"shape":"ServiceId"} + }, + "ServiceList":{ + "type":"list", + "member":{"shape":"Service"} + }, + "ServiceName":{ + "type":"string", + "max":64 + }, + "ServiceNames":{ + "type":"list", + "member":{"shape":"String"} + }, + "ServiceStatistics":{ + "type":"structure", + "members":{ + "OkCount":{ + "shape":"NullableLong", + "documentation":"

    The number of requests that completed with a 2xx Success status code.

    " + }, + "ErrorStatistics":{ + "shape":"ErrorStatistics", + "documentation":"

    Information about requests that failed with a 4xx Client Error status code.

    " + }, + "FaultStatistics":{ + "shape":"FaultStatistics", + "documentation":"

    Information about requests that failed with a 5xx Server Error status code.

    " + }, + "TotalCount":{ + "shape":"NullableLong", + "documentation":"

    The total number of completed requests.

    " + }, + "TotalResponseTime":{ + "shape":"NullableDouble", + "documentation":"

    The aggregate response time of completed requests.

    " + } + }, + "documentation":"

    Response statistics for a service.

    " + }, + "ServiceType":{ + "type":"string", + "max":64 + }, + "String":{"type":"string"}, + "TelemetryRecord":{ + "type":"structure", + "required":["Timestamp"], + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    " + }, + "SegmentsReceivedCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "SegmentsSentCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "SegmentsSpilloverCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "SegmentsRejectedCount":{ + "shape":"NullableInteger", + "documentation":"

    " + }, + "BackendConnectionErrors":{ + "shape":"BackendConnectionErrors", + "documentation":"

    " + } + }, + "documentation":"

    " + }, + "TelemetryRecordList":{ + "type":"list", + "member":{"shape":"TelemetryRecord"} + }, + "ThrottledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

    The request exceeds the maximum number of requests per second.

    ", + "error":{"httpStatusCode":429}, + "exception":true + }, + "TimeRangeType":{ + "type":"string", + "enum":[ + "TraceId", + "Event" + ] + }, + "TimeSeriesServiceStatistics":{ + "type":"structure", + "members":{ + "Timestamp":{ + "shape":"Timestamp", + "documentation":"

    Timestamp of the window for which statistics are aggregated.

    " + }, + "EdgeSummaryStatistics":{"shape":"EdgeStatistics"}, + "ServiceSummaryStatistics":{"shape":"ServiceStatistics"}, + "ResponseTimeHistogram":{ + "shape":"Histogram", + "documentation":"

    The response time histogram for the selected entities.

    " + } + }, + "documentation":"

    A list of TimeSeriesStatistic structures.

    " + }, + "TimeSeriesServiceStatisticsList":{ + "type":"list", + "member":{"shape":"TimeSeriesServiceStatistics"} + }, + "Timestamp":{"type":"timestamp"}, + "Trace":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TraceId", + "documentation":"

    The unique identifier for the request that generated the trace's segments and subsegments.

    " + }, + "Duration":{ + "shape":"NullableDouble", + "documentation":"

    The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

    " + }, + "Segments":{ + "shape":"SegmentList", + "documentation":"

    Segment documents for the segments and subsegments that comprise the trace.

    " + } + }, + "documentation":"

    A collection of segment documents with matching trace IDs.

    " + }, + "TraceAvailabilityZones":{ + "type":"list", + "member":{"shape":"AvailabilityZoneDetail"} + }, + "TraceId":{ + "type":"string", + "max":35, + "min":1 + }, + "TraceIdList":{ + "type":"list", + "member":{"shape":"TraceId"} + }, + "TraceInstanceIds":{ + "type":"list", + "member":{"shape":"InstanceIdDetail"} + }, + "TraceList":{ + "type":"list", + "member":{"shape":"Trace"} + }, + "TraceResourceARNs":{ + "type":"list", + "member":{"shape":"ResourceARNDetail"} + }, + "TraceSegmentDocument":{"type":"string"}, + "TraceSegmentDocumentList":{ + "type":"list", + "member":{"shape":"TraceSegmentDocument"} + }, + "TraceSummary":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"TraceId", + "documentation":"

    The unique identifier for the request that generated the trace's segments and subsegments.

    " + }, + "Duration":{ + "shape":"NullableDouble", + "documentation":"

    The length of time in seconds between the start time of the root segment and the end time of the last segment that completed.

    " + }, + "ResponseTime":{ + "shape":"NullableDouble", + "documentation":"

    The length of time in seconds between the start and end times of the root segment. If the service performs work asynchronously, the response time measures the time before the response is sent to the user, while the duration measures the amount of time before the last traced activity completes.

    " + }, + "HasFault":{ + "shape":"NullableBoolean", + "documentation":"

    One or more of the segment documents has a 500 series error.

    " + }, + "HasError":{ + "shape":"NullableBoolean", + "documentation":"

    One or more of the segment documents has a 400 series error.

    " + }, + "HasThrottle":{ + "shape":"NullableBoolean", + "documentation":"

    One or more of the segment documents has a 429 throttling error.

    " + }, + "IsPartial":{ + "shape":"NullableBoolean", + "documentation":"

    One or more of the segment documents is in progress.

    " + }, + "Http":{ + "shape":"Http", + "documentation":"

    Information about the HTTP request served by the trace.

    " + }, + "Annotations":{ + "shape":"Annotations", + "documentation":"

    Annotations from the trace's segment documents.

    " + }, + "Users":{ + "shape":"TraceUsers", + "documentation":"

    Users from the trace's segment documents.

    " + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"

    Service IDs from the trace's segment documents.

    " + }, + "ResourceARNs":{ + "shape":"TraceResourceARNs", + "documentation":"

    A list of resource ARNs for any resource corresponding to the trace segments.

    " + }, + "InstanceIds":{ + "shape":"TraceInstanceIds", + "documentation":"

    A list of EC2 instance IDs for any instance corresponding to the trace segments.

    " + }, + "AvailabilityZones":{ + "shape":"TraceAvailabilityZones", + "documentation":"

    A list of availability zones for any zone corresponding to the trace segments.

    " + }, + "EntryPoint":{ + "shape":"ServiceId", + "documentation":"

    The root of a trace.

    " + }, + "FaultRootCauses":{ + "shape":"FaultRootCauses", + "documentation":"

    A collection of FaultRootCause structures corresponding to the the trace segments.

    " + }, + "ErrorRootCauses":{ + "shape":"ErrorRootCauses", + "documentation":"

    A collection of ErrorRootCause structures corresponding to the trace segments.

    " + }, + "ResponseTimeRootCauses":{ + "shape":"ResponseTimeRootCauses", + "documentation":"

    A collection of ResponseTimeRootCause structures corresponding to the trace segments.

    " + }, + "Revision":{ + "shape":"Integer", + "documentation":"

    The revision number of a trace.

    " + }, + "MatchedEventTime":{ + "shape":"Timestamp", + "documentation":"

    The matched time stamp of a defined event.

    " + } + }, + "documentation":"

    Metadata generated from the segment documents in a trace.

    " + }, + "TraceSummaryList":{ + "type":"list", + "member":{"shape":"TraceSummary"} + }, + "TraceUser":{ + "type":"structure", + "members":{ + "UserName":{ + "shape":"String", + "documentation":"

    The user's name.

    " + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"

    Services that the user's request hit.

    " + } + }, + "documentation":"

    Information about a user recorded in segment documents.

    " + }, + "TraceUsers":{ + "type":"list", + "member":{"shape":"TraceUser"} + }, + "URLPath":{ + "type":"string", + "max":128 + }, + "UnprocessedStatistics":{ + "type":"structure", + "members":{ + "RuleName":{ + "shape":"String", + "documentation":"

    The name of the sampling rule.

    " + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

    The error code.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    The error message.

    " + } + }, + "documentation":"

    Sampling statistics from a call to GetSamplingTargets that X-Ray could not process.

    " + }, + "UnprocessedStatisticsList":{ + "type":"list", + "member":{"shape":"UnprocessedStatistics"} + }, + "UnprocessedTraceIdList":{ + "type":"list", + "member":{"shape":"TraceId"} + }, + "UnprocessedTraceSegment":{ + "type":"structure", + "members":{ + "Id":{ + "shape":"String", + "documentation":"

    The segment's ID.

    " + }, + "ErrorCode":{ + "shape":"String", + "documentation":"

    The error that caused processing to fail.

    " + }, + "Message":{ + "shape":"String", + "documentation":"

    The error message.

    " + } + }, + "documentation":"

    Information about a segment that failed processing.

    " + }, + "UnprocessedTraceSegmentList":{ + "type":"list", + "member":{"shape":"UnprocessedTraceSegment"} + }, + "UpdateGroupRequest":{ + "type":"structure", + "members":{ + "GroupName":{ + "shape":"GroupName", + "documentation":"

    The case-sensitive name of the group.

    " + }, + "GroupARN":{ + "shape":"GroupARN", + "documentation":"

    The ARN that was generated upon creation.

    " + }, + "FilterExpression":{ + "shape":"FilterExpression", + "documentation":"

    The updated filter expression defining criteria by which to group traces.

    " + } + } + }, + "UpdateGroupResult":{ + "type":"structure", + "members":{ + "Group":{ + "shape":"Group", + "documentation":"

    The group that was updated. Contains the name of the group that was updated, the ARN of the group that was updated, and the updated filter expression assigned to the group.

    " + } + } + }, + "UpdateSamplingRuleRequest":{ + "type":"structure", + "required":["SamplingRuleUpdate"], + "members":{ + "SamplingRuleUpdate":{ + "shape":"SamplingRuleUpdate", + "documentation":"

    The rule and fields to change.

    " + } + } + }, + "UpdateSamplingRuleResult":{ + "type":"structure", + "members":{ + "SamplingRuleRecord":{ + "shape":"SamplingRuleRecord", + "documentation":"

    The updated rule definition and metadata.

    " + } + } + }, + "ValueWithServiceIds":{ + "type":"structure", + "members":{ + "AnnotationValue":{ + "shape":"AnnotationValue", + "documentation":"

    Values of the annotation.

    " + }, + "ServiceIds":{ + "shape":"ServiceIds", + "documentation":"

    Services to which the annotation applies.

    " + } + }, + "documentation":"

    Information about a segment annotation.

    " + }, + "ValuesWithServiceIds":{ + "type":"list", + "member":{"shape":"ValueWithServiceIds"} + }, + "Version":{ + "type":"integer", + "min":1 + } + }, + "documentation":"

    AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

    " +} diff --git a/aws/dist/docutils/parsers/rst/include/README.txt b/aws/dist/docutils/parsers/rst/include/README.txt new file mode 100644 index 00000000..cd03135f --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/README.txt @@ -0,0 +1,17 @@ +============================================ + ``docutils/parsers/rst/include`` Directory +============================================ + +This directory contains standard data files intended for inclusion in +reStructuredText documents. To access these files, use the "include" +directive with the special syntax for standard "include" data files, +angle brackets around the file name:: + + .. include:: + +See the documentation for the `"include" directive`__ and +`reStructuredText Standard Substitution Definition Sets`__ for +details. + +__ http://docutils.sf.net/docs/ref/rst/directives.html#include +__ http://docutils.sf.net/docs/ref/rst/substitutions.html diff --git a/aws/dist/docutils/parsers/rst/include/isoamsa.txt b/aws/dist/docutils/parsers/rst/include/isoamsa.txt new file mode 100644 index 00000000..e6f45180 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamsa.txt @@ -0,0 +1,162 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |angzarr| unicode:: U+0237C .. RIGHT ANGLE WITH DOWNWARDS ZIGZAG ARROW +.. |cirmid| unicode:: U+02AEF .. VERTICAL LINE WITH CIRCLE ABOVE +.. |cudarrl| unicode:: U+02938 .. RIGHT-SIDE ARC CLOCKWISE ARROW +.. |cudarrr| unicode:: U+02935 .. ARROW POINTING RIGHTWARDS THEN CURVING DOWNWARDS +.. |cularr| unicode:: U+021B6 .. ANTICLOCKWISE TOP SEMICIRCLE ARROW +.. |cularrp| unicode:: U+0293D .. TOP ARC ANTICLOCKWISE ARROW WITH PLUS +.. |curarr| unicode:: U+021B7 .. CLOCKWISE TOP SEMICIRCLE ARROW +.. |curarrm| unicode:: U+0293C .. TOP ARC CLOCKWISE ARROW WITH MINUS +.. |Darr| unicode:: U+021A1 .. DOWNWARDS TWO HEADED ARROW +.. |dArr| unicode:: U+021D3 .. DOWNWARDS DOUBLE ARROW +.. |darr2| unicode:: U+021CA .. DOWNWARDS PAIRED ARROWS +.. |ddarr| unicode:: U+021CA .. DOWNWARDS PAIRED ARROWS +.. |DDotrahd| unicode:: U+02911 .. RIGHTWARDS ARROW WITH DOTTED STEM +.. |dfisht| unicode:: U+0297F .. DOWN FISH TAIL +.. |dHar| unicode:: U+02965 .. DOWNWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT +.. |dharl| unicode:: U+021C3 .. DOWNWARDS HARPOON WITH BARB LEFTWARDS +.. |dharr| unicode:: U+021C2 .. DOWNWARDS HARPOON WITH BARB RIGHTWARDS +.. |dlarr| unicode:: U+02199 .. SOUTH WEST ARROW +.. |drarr| unicode:: U+02198 .. SOUTH EAST ARROW +.. |duarr| unicode:: U+021F5 .. DOWNWARDS ARROW LEFTWARDS OF UPWARDS ARROW +.. |duhar| unicode:: U+0296F .. DOWNWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT +.. |dzigrarr| unicode:: U+027FF .. LONG RIGHTWARDS SQUIGGLE ARROW +.. |erarr| unicode:: U+02971 .. EQUALS SIGN ABOVE RIGHTWARDS ARROW +.. |hArr| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |harr| unicode:: U+02194 .. LEFT RIGHT ARROW +.. |harrcir| unicode:: U+02948 .. LEFT RIGHT ARROW THROUGH SMALL CIRCLE +.. |harrw| unicode:: U+021AD .. LEFT RIGHT WAVE ARROW +.. |hoarr| unicode:: U+021FF .. LEFT RIGHT OPEN-HEADED ARROW +.. |imof| unicode:: U+022B7 .. IMAGE OF +.. |lAarr| unicode:: U+021DA .. LEFTWARDS TRIPLE ARROW +.. |Larr| unicode:: U+0219E .. LEFTWARDS TWO HEADED ARROW +.. |larr2| unicode:: U+021C7 .. LEFTWARDS PAIRED ARROWS +.. |larrbfs| unicode:: U+0291F .. LEFTWARDS ARROW FROM BAR TO BLACK DIAMOND +.. |larrfs| unicode:: U+0291D .. LEFTWARDS ARROW TO BLACK DIAMOND +.. |larrhk| unicode:: U+021A9 .. LEFTWARDS ARROW WITH HOOK +.. |larrlp| unicode:: U+021AB .. LEFTWARDS ARROW WITH LOOP +.. |larrpl| unicode:: U+02939 .. LEFT-SIDE ARC ANTICLOCKWISE ARROW +.. |larrsim| unicode:: U+02973 .. LEFTWARDS ARROW ABOVE TILDE OPERATOR +.. |larrtl| unicode:: U+021A2 .. LEFTWARDS ARROW WITH TAIL +.. |lAtail| unicode:: U+0291B .. LEFTWARDS DOUBLE ARROW-TAIL +.. |latail| unicode:: U+02919 .. LEFTWARDS ARROW-TAIL +.. |lBarr| unicode:: U+0290E .. LEFTWARDS TRIPLE DASH ARROW +.. |lbarr| unicode:: U+0290C .. LEFTWARDS DOUBLE DASH ARROW +.. |ldca| unicode:: U+02936 .. ARROW POINTING DOWNWARDS THEN CURVING LEFTWARDS +.. |ldrdhar| unicode:: U+02967 .. LEFTWARDS HARPOON WITH BARB DOWN ABOVE RIGHTWARDS HARPOON WITH BARB DOWN +.. |ldrushar| unicode:: U+0294B .. LEFT BARB DOWN RIGHT BARB UP HARPOON +.. |ldsh| unicode:: U+021B2 .. DOWNWARDS ARROW WITH TIP LEFTWARDS +.. |lfisht| unicode:: U+0297C .. LEFT FISH TAIL +.. |lHar| unicode:: U+02962 .. LEFTWARDS HARPOON WITH BARB UP ABOVE LEFTWARDS HARPOON WITH BARB DOWN +.. |lhard| unicode:: U+021BD .. LEFTWARDS HARPOON WITH BARB DOWNWARDS +.. |lharu| unicode:: U+021BC .. LEFTWARDS HARPOON WITH BARB UPWARDS +.. |lharul| unicode:: U+0296A .. LEFTWARDS HARPOON WITH BARB UP ABOVE LONG DASH +.. |llarr| unicode:: U+021C7 .. LEFTWARDS PAIRED ARROWS +.. |llhard| unicode:: U+0296B .. LEFTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH +.. |loarr| unicode:: U+021FD .. LEFTWARDS OPEN-HEADED ARROW +.. |lrarr| unicode:: U+021C6 .. LEFTWARDS ARROW OVER RIGHTWARDS ARROW +.. |lrarr2| unicode:: U+021C6 .. LEFTWARDS ARROW OVER RIGHTWARDS ARROW +.. |lrhar| unicode:: U+021CB .. LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON +.. |lrhar2| unicode:: U+021CB .. LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON +.. |lrhard| unicode:: U+0296D .. RIGHTWARDS HARPOON WITH BARB DOWN BELOW LONG DASH +.. |lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS +.. |lurdshar| unicode:: U+0294A .. LEFT BARB UP RIGHT BARB DOWN HARPOON +.. |luruhar| unicode:: U+02966 .. LEFTWARDS HARPOON WITH BARB UP ABOVE RIGHTWARDS HARPOON WITH BARB UP +.. |Map| unicode:: U+02905 .. RIGHTWARDS TWO-HEADED ARROW FROM BAR +.. |map| unicode:: U+021A6 .. RIGHTWARDS ARROW FROM BAR +.. |midcir| unicode:: U+02AF0 .. VERTICAL LINE WITH CIRCLE BELOW +.. |mumap| unicode:: U+022B8 .. MULTIMAP +.. |nearhk| unicode:: U+02924 .. NORTH EAST ARROW WITH HOOK +.. |neArr| unicode:: U+021D7 .. NORTH EAST DOUBLE ARROW +.. |nearr| unicode:: U+02197 .. NORTH EAST ARROW +.. |nesear| unicode:: U+02928 .. NORTH EAST ARROW AND SOUTH EAST ARROW +.. |nhArr| unicode:: U+021CE .. LEFT RIGHT DOUBLE ARROW WITH STROKE +.. |nharr| unicode:: U+021AE .. LEFT RIGHT ARROW WITH STROKE +.. |nlArr| unicode:: U+021CD .. LEFTWARDS DOUBLE ARROW WITH STROKE +.. |nlarr| unicode:: U+0219A .. LEFTWARDS ARROW WITH STROKE +.. |nrArr| unicode:: U+021CF .. RIGHTWARDS DOUBLE ARROW WITH STROKE +.. |nrarr| unicode:: U+0219B .. RIGHTWARDS ARROW WITH STROKE +.. |nrarrc| unicode:: U+02933 U+00338 .. WAVE ARROW POINTING DIRECTLY RIGHT with slash +.. |nrarrw| unicode:: U+0219D U+00338 .. RIGHTWARDS WAVE ARROW with slash +.. |nvHarr| unicode:: U+02904 .. LEFT RIGHT DOUBLE ARROW WITH VERTICAL STROKE +.. |nvlArr| unicode:: U+02902 .. LEFTWARDS DOUBLE ARROW WITH VERTICAL STROKE +.. |nvrArr| unicode:: U+02903 .. RIGHTWARDS DOUBLE ARROW WITH VERTICAL STROKE +.. |nwarhk| unicode:: U+02923 .. NORTH WEST ARROW WITH HOOK +.. |nwArr| unicode:: U+021D6 .. NORTH WEST DOUBLE ARROW +.. |nwarr| unicode:: U+02196 .. NORTH WEST ARROW +.. |nwnear| unicode:: U+02927 .. NORTH WEST ARROW AND NORTH EAST ARROW +.. |olarr| unicode:: U+021BA .. ANTICLOCKWISE OPEN CIRCLE ARROW +.. |orarr| unicode:: U+021BB .. CLOCKWISE OPEN CIRCLE ARROW +.. |origof| unicode:: U+022B6 .. ORIGINAL OF +.. |rAarr| unicode:: U+021DB .. RIGHTWARDS TRIPLE ARROW +.. |Rarr| unicode:: U+021A0 .. RIGHTWARDS TWO HEADED ARROW +.. |rarr2| unicode:: U+021C9 .. RIGHTWARDS PAIRED ARROWS +.. |rarrap| unicode:: U+02975 .. RIGHTWARDS ARROW ABOVE ALMOST EQUAL TO +.. |rarrbfs| unicode:: U+02920 .. RIGHTWARDS ARROW FROM BAR TO BLACK DIAMOND +.. |rarrc| unicode:: U+02933 .. WAVE ARROW POINTING DIRECTLY RIGHT +.. |rarrfs| unicode:: U+0291E .. RIGHTWARDS ARROW TO BLACK DIAMOND +.. |rarrhk| unicode:: U+021AA .. RIGHTWARDS ARROW WITH HOOK +.. |rarrlp| unicode:: U+021AC .. RIGHTWARDS ARROW WITH LOOP +.. |rarrpl| unicode:: U+02945 .. RIGHTWARDS ARROW WITH PLUS BELOW +.. |rarrsim| unicode:: U+02974 .. RIGHTWARDS ARROW ABOVE TILDE OPERATOR +.. |Rarrtl| unicode:: U+02916 .. RIGHTWARDS TWO-HEADED ARROW WITH TAIL +.. |rarrtl| unicode:: U+021A3 .. RIGHTWARDS ARROW WITH TAIL +.. |rarrw| unicode:: U+0219D .. RIGHTWARDS WAVE ARROW +.. |rAtail| unicode:: U+0291C .. RIGHTWARDS DOUBLE ARROW-TAIL +.. |ratail| unicode:: U+0291A .. RIGHTWARDS ARROW-TAIL +.. |RBarr| unicode:: U+02910 .. RIGHTWARDS TWO-HEADED TRIPLE DASH ARROW +.. |rBarr| unicode:: U+0290F .. RIGHTWARDS TRIPLE DASH ARROW +.. |rbarr| unicode:: U+0290D .. RIGHTWARDS DOUBLE DASH ARROW +.. |rdca| unicode:: U+02937 .. ARROW POINTING DOWNWARDS THEN CURVING RIGHTWARDS +.. |rdldhar| unicode:: U+02969 .. RIGHTWARDS HARPOON WITH BARB DOWN ABOVE LEFTWARDS HARPOON WITH BARB DOWN +.. |rdsh| unicode:: U+021B3 .. DOWNWARDS ARROW WITH TIP RIGHTWARDS +.. |rfisht| unicode:: U+0297D .. RIGHT FISH TAIL +.. |rHar| unicode:: U+02964 .. RIGHTWARDS HARPOON WITH BARB UP ABOVE RIGHTWARDS HARPOON WITH BARB DOWN +.. |rhard| unicode:: U+021C1 .. RIGHTWARDS HARPOON WITH BARB DOWNWARDS +.. |rharu| unicode:: U+021C0 .. RIGHTWARDS HARPOON WITH BARB UPWARDS +.. |rharul| unicode:: U+0296C .. RIGHTWARDS HARPOON WITH BARB UP ABOVE LONG DASH +.. |rlarr| unicode:: U+021C4 .. RIGHTWARDS ARROW OVER LEFTWARDS ARROW +.. |rlarr2| unicode:: U+021C4 .. RIGHTWARDS ARROW OVER LEFTWARDS ARROW +.. |rlhar| unicode:: U+021CC .. RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON +.. |rlhar2| unicode:: U+021CC .. RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON +.. |roarr| unicode:: U+021FE .. RIGHTWARDS OPEN-HEADED ARROW +.. |rrarr| unicode:: U+021C9 .. RIGHTWARDS PAIRED ARROWS +.. |rsh| unicode:: U+021B1 .. UPWARDS ARROW WITH TIP RIGHTWARDS +.. |ruluhar| unicode:: U+02968 .. RIGHTWARDS HARPOON WITH BARB UP ABOVE LEFTWARDS HARPOON WITH BARB UP +.. |searhk| unicode:: U+02925 .. SOUTH EAST ARROW WITH HOOK +.. |seArr| unicode:: U+021D8 .. SOUTH EAST DOUBLE ARROW +.. |searr| unicode:: U+02198 .. SOUTH EAST ARROW +.. |seswar| unicode:: U+02929 .. SOUTH EAST ARROW AND SOUTH WEST ARROW +.. |simrarr| unicode:: U+02972 .. TILDE OPERATOR ABOVE RIGHTWARDS ARROW +.. |slarr| unicode:: U+02190 .. LEFTWARDS ARROW +.. |srarr| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |swarhk| unicode:: U+02926 .. SOUTH WEST ARROW WITH HOOK +.. |swArr| unicode:: U+021D9 .. SOUTH WEST DOUBLE ARROW +.. |swarr| unicode:: U+02199 .. SOUTH WEST ARROW +.. |swnwar| unicode:: U+0292A .. SOUTH WEST ARROW AND NORTH WEST ARROW +.. |Uarr| unicode:: U+0219F .. UPWARDS TWO HEADED ARROW +.. |uArr| unicode:: U+021D1 .. UPWARDS DOUBLE ARROW +.. |uarr2| unicode:: U+021C8 .. UPWARDS PAIRED ARROWS +.. |Uarrocir| unicode:: U+02949 .. UPWARDS TWO-HEADED ARROW FROM SMALL CIRCLE +.. |udarr| unicode:: U+021C5 .. UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW +.. |udhar| unicode:: U+0296E .. UPWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT +.. |ufisht| unicode:: U+0297E .. UP FISH TAIL +.. |uHar| unicode:: U+02963 .. UPWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT +.. |uharl| unicode:: U+021BF .. UPWARDS HARPOON WITH BARB LEFTWARDS +.. |uharr| unicode:: U+021BE .. UPWARDS HARPOON WITH BARB RIGHTWARDS +.. |uuarr| unicode:: U+021C8 .. UPWARDS PAIRED ARROWS +.. |vArr| unicode:: U+021D5 .. UP DOWN DOUBLE ARROW +.. |varr| unicode:: U+02195 .. UP DOWN ARROW +.. |xhArr| unicode:: U+027FA .. LONG LEFT RIGHT DOUBLE ARROW +.. |xharr| unicode:: U+027F7 .. LONG LEFT RIGHT ARROW +.. |xlArr| unicode:: U+027F8 .. LONG LEFTWARDS DOUBLE ARROW +.. |xlarr| unicode:: U+027F5 .. LONG LEFTWARDS ARROW +.. |xmap| unicode:: U+027FC .. LONG RIGHTWARDS ARROW FROM BAR +.. |xrArr| unicode:: U+027F9 .. LONG RIGHTWARDS DOUBLE ARROW +.. |xrarr| unicode:: U+027F6 .. LONG RIGHTWARDS ARROW +.. |zigrarr| unicode:: U+021DD .. RIGHTWARDS SQUIGGLE ARROW diff --git a/aws/dist/docutils/parsers/rst/include/isoamsb.txt b/aws/dist/docutils/parsers/rst/include/isoamsb.txt new file mode 100644 index 00000000..05e68d99 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamsb.txt @@ -0,0 +1,126 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |ac| unicode:: U+0223E .. INVERTED LAZY S +.. |acE| unicode:: U+0223E U+00333 .. INVERTED LAZY S with double underline +.. |amalg| unicode:: U+02A3F .. AMALGAMATION OR COPRODUCT +.. |barvee| unicode:: U+022BD .. NOR +.. |Barwed| unicode:: U+02306 .. PERSPECTIVE +.. |barwed| unicode:: U+02305 .. PROJECTIVE +.. |bsolb| unicode:: U+029C5 .. SQUARED FALLING DIAGONAL SLASH +.. |Cap| unicode:: U+022D2 .. DOUBLE INTERSECTION +.. |capand| unicode:: U+02A44 .. INTERSECTION WITH LOGICAL AND +.. |capbrcup| unicode:: U+02A49 .. INTERSECTION ABOVE BAR ABOVE UNION +.. |capcap| unicode:: U+02A4B .. INTERSECTION BESIDE AND JOINED WITH INTERSECTION +.. |capcup| unicode:: U+02A47 .. INTERSECTION ABOVE UNION +.. |capdot| unicode:: U+02A40 .. INTERSECTION WITH DOT +.. |caps| unicode:: U+02229 U+0FE00 .. INTERSECTION with serifs +.. |ccaps| unicode:: U+02A4D .. CLOSED INTERSECTION WITH SERIFS +.. |ccups| unicode:: U+02A4C .. CLOSED UNION WITH SERIFS +.. |ccupssm| unicode:: U+02A50 .. CLOSED UNION WITH SERIFS AND SMASH PRODUCT +.. |coprod| unicode:: U+02210 .. N-ARY COPRODUCT +.. |Cup| unicode:: U+022D3 .. DOUBLE UNION +.. |cupbrcap| unicode:: U+02A48 .. UNION ABOVE BAR ABOVE INTERSECTION +.. |cupcap| unicode:: U+02A46 .. UNION ABOVE INTERSECTION +.. |cupcup| unicode:: U+02A4A .. UNION BESIDE AND JOINED WITH UNION +.. |cupdot| unicode:: U+0228D .. MULTISET MULTIPLICATION +.. |cupor| unicode:: U+02A45 .. UNION WITH LOGICAL OR +.. |cups| unicode:: U+0222A U+0FE00 .. UNION with serifs +.. |cuvee| unicode:: U+022CE .. CURLY LOGICAL OR +.. |cuwed| unicode:: U+022CF .. CURLY LOGICAL AND +.. |Dagger| unicode:: U+02021 .. DOUBLE DAGGER +.. |dagger| unicode:: U+02020 .. DAGGER +.. |diam| unicode:: U+022C4 .. DIAMOND OPERATOR +.. |divonx| unicode:: U+022C7 .. DIVISION TIMES +.. |eplus| unicode:: U+02A71 .. EQUALS SIGN ABOVE PLUS SIGN +.. |hercon| unicode:: U+022B9 .. HERMITIAN CONJUGATE MATRIX +.. |intcal| unicode:: U+022BA .. INTERCALATE +.. |iprod| unicode:: U+02A3C .. INTERIOR PRODUCT +.. |loplus| unicode:: U+02A2D .. PLUS SIGN IN LEFT HALF CIRCLE +.. |lotimes| unicode:: U+02A34 .. MULTIPLICATION SIGN IN LEFT HALF CIRCLE +.. |lthree| unicode:: U+022CB .. LEFT SEMIDIRECT PRODUCT +.. |ltimes| unicode:: U+022C9 .. LEFT NORMAL FACTOR SEMIDIRECT PRODUCT +.. |midast| unicode:: U+0002A .. ASTERISK +.. |minusb| unicode:: U+0229F .. SQUARED MINUS +.. |minusd| unicode:: U+02238 .. DOT MINUS +.. |minusdu| unicode:: U+02A2A .. MINUS SIGN WITH DOT BELOW +.. |ncap| unicode:: U+02A43 .. INTERSECTION WITH OVERBAR +.. |ncup| unicode:: U+02A42 .. UNION WITH OVERBAR +.. |oast| unicode:: U+0229B .. CIRCLED ASTERISK OPERATOR +.. |ocir| unicode:: U+0229A .. CIRCLED RING OPERATOR +.. |odash| unicode:: U+0229D .. CIRCLED DASH +.. |odiv| unicode:: U+02A38 .. CIRCLED DIVISION SIGN +.. |odot| unicode:: U+02299 .. CIRCLED DOT OPERATOR +.. |odsold| unicode:: U+029BC .. CIRCLED ANTICLOCKWISE-ROTATED DIVISION SIGN +.. |ofcir| unicode:: U+029BF .. CIRCLED BULLET +.. |ogt| unicode:: U+029C1 .. CIRCLED GREATER-THAN +.. |ohbar| unicode:: U+029B5 .. CIRCLE WITH HORIZONTAL BAR +.. |olcir| unicode:: U+029BE .. CIRCLED WHITE BULLET +.. |olt| unicode:: U+029C0 .. CIRCLED LESS-THAN +.. |omid| unicode:: U+029B6 .. CIRCLED VERTICAL BAR +.. |ominus| unicode:: U+02296 .. CIRCLED MINUS +.. |opar| unicode:: U+029B7 .. CIRCLED PARALLEL +.. |operp| unicode:: U+029B9 .. CIRCLED PERPENDICULAR +.. |oplus| unicode:: U+02295 .. CIRCLED PLUS +.. |osol| unicode:: U+02298 .. CIRCLED DIVISION SLASH +.. |Otimes| unicode:: U+02A37 .. MULTIPLICATION SIGN IN DOUBLE CIRCLE +.. |otimes| unicode:: U+02297 .. CIRCLED TIMES +.. |otimesas| unicode:: U+02A36 .. CIRCLED MULTIPLICATION SIGN WITH CIRCUMFLEX ACCENT +.. |ovbar| unicode:: U+0233D .. APL FUNCTIONAL SYMBOL CIRCLE STILE +.. |plusacir| unicode:: U+02A23 .. PLUS SIGN WITH CIRCUMFLEX ACCENT ABOVE +.. |plusb| unicode:: U+0229E .. SQUARED PLUS +.. |pluscir| unicode:: U+02A22 .. PLUS SIGN WITH SMALL CIRCLE ABOVE +.. |plusdo| unicode:: U+02214 .. DOT PLUS +.. |plusdu| unicode:: U+02A25 .. PLUS SIGN WITH DOT BELOW +.. |pluse| unicode:: U+02A72 .. PLUS SIGN ABOVE EQUALS SIGN +.. |plussim| unicode:: U+02A26 .. PLUS SIGN WITH TILDE BELOW +.. |plustwo| unicode:: U+02A27 .. PLUS SIGN WITH SUBSCRIPT TWO +.. |prod| unicode:: U+0220F .. N-ARY PRODUCT +.. |race| unicode:: U+029DA .. LEFT DOUBLE WIGGLY FENCE +.. |roplus| unicode:: U+02A2E .. PLUS SIGN IN RIGHT HALF CIRCLE +.. |rotimes| unicode:: U+02A35 .. MULTIPLICATION SIGN IN RIGHT HALF CIRCLE +.. |rthree| unicode:: U+022CC .. RIGHT SEMIDIRECT PRODUCT +.. |rtimes| unicode:: U+022CA .. RIGHT NORMAL FACTOR SEMIDIRECT PRODUCT +.. |sdot| unicode:: U+022C5 .. DOT OPERATOR +.. |sdotb| unicode:: U+022A1 .. SQUARED DOT OPERATOR +.. |setmn| unicode:: U+02216 .. SET MINUS +.. |simplus| unicode:: U+02A24 .. PLUS SIGN WITH TILDE ABOVE +.. |smashp| unicode:: U+02A33 .. SMASH PRODUCT +.. |solb| unicode:: U+029C4 .. SQUARED RISING DIAGONAL SLASH +.. |sqcap| unicode:: U+02293 .. SQUARE CAP +.. |sqcaps| unicode:: U+02293 U+0FE00 .. SQUARE CAP with serifs +.. |sqcup| unicode:: U+02294 .. SQUARE CUP +.. |sqcups| unicode:: U+02294 U+0FE00 .. SQUARE CUP with serifs +.. |ssetmn| unicode:: U+02216 .. SET MINUS +.. |sstarf| unicode:: U+022C6 .. STAR OPERATOR +.. |subdot| unicode:: U+02ABD .. SUBSET WITH DOT +.. |sum| unicode:: U+02211 .. N-ARY SUMMATION +.. |supdot| unicode:: U+02ABE .. SUPERSET WITH DOT +.. |timesb| unicode:: U+022A0 .. SQUARED TIMES +.. |timesbar| unicode:: U+02A31 .. MULTIPLICATION SIGN WITH UNDERBAR +.. |timesd| unicode:: U+02A30 .. MULTIPLICATION SIGN WITH DOT ABOVE +.. |top| unicode:: U+022A4 .. DOWN TACK +.. |tridot| unicode:: U+025EC .. WHITE UP-POINTING TRIANGLE WITH DOT +.. |triminus| unicode:: U+02A3A .. MINUS SIGN IN TRIANGLE +.. |triplus| unicode:: U+02A39 .. PLUS SIGN IN TRIANGLE +.. |trisb| unicode:: U+029CD .. TRIANGLE WITH SERIFS AT BOTTOM +.. |tritime| unicode:: U+02A3B .. MULTIPLICATION SIGN IN TRIANGLE +.. |uplus| unicode:: U+0228E .. MULTISET UNION +.. |veebar| unicode:: U+022BB .. XOR +.. |wedbar| unicode:: U+02A5F .. LOGICAL AND WITH UNDERBAR +.. |wreath| unicode:: U+02240 .. WREATH PRODUCT +.. |xcap| unicode:: U+022C2 .. N-ARY INTERSECTION +.. |xcirc| unicode:: U+025EF .. LARGE CIRCLE +.. |xcup| unicode:: U+022C3 .. N-ARY UNION +.. |xdtri| unicode:: U+025BD .. WHITE DOWN-POINTING TRIANGLE +.. |xodot| unicode:: U+02A00 .. N-ARY CIRCLED DOT OPERATOR +.. |xoplus| unicode:: U+02A01 .. N-ARY CIRCLED PLUS OPERATOR +.. |xotime| unicode:: U+02A02 .. N-ARY CIRCLED TIMES OPERATOR +.. |xsqcup| unicode:: U+02A06 .. N-ARY SQUARE UNION OPERATOR +.. |xuplus| unicode:: U+02A04 .. N-ARY UNION OPERATOR WITH PLUS +.. |xutri| unicode:: U+025B3 .. WHITE UP-POINTING TRIANGLE +.. |xvee| unicode:: U+022C1 .. N-ARY LOGICAL OR +.. |xwedge| unicode:: U+022C0 .. N-ARY LOGICAL AND diff --git a/aws/dist/docutils/parsers/rst/include/isoamsc.txt b/aws/dist/docutils/parsers/rst/include/isoamsc.txt new file mode 100644 index 00000000..343504d8 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamsc.txt @@ -0,0 +1,29 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |dlcorn| unicode:: U+0231E .. BOTTOM LEFT CORNER +.. |drcorn| unicode:: U+0231F .. BOTTOM RIGHT CORNER +.. |gtlPar| unicode:: U+02995 .. DOUBLE LEFT ARC GREATER-THAN BRACKET +.. |langd| unicode:: U+02991 .. LEFT ANGLE BRACKET WITH DOT +.. |lbrke| unicode:: U+0298B .. LEFT SQUARE BRACKET WITH UNDERBAR +.. |lbrksld| unicode:: U+0298F .. LEFT SQUARE BRACKET WITH TICK IN BOTTOM CORNER +.. |lbrkslu| unicode:: U+0298D .. LEFT SQUARE BRACKET WITH TICK IN TOP CORNER +.. |lceil| unicode:: U+02308 .. LEFT CEILING +.. |lfloor| unicode:: U+0230A .. LEFT FLOOR +.. |lmoust| unicode:: U+023B0 .. UPPER LEFT OR LOWER RIGHT CURLY BRACKET SECTION +.. |lpargt| unicode:: U+029A0 .. SPHERICAL ANGLE OPENING LEFT +.. |lparlt| unicode:: U+02993 .. LEFT ARC LESS-THAN BRACKET +.. |ltrPar| unicode:: U+02996 .. DOUBLE RIGHT ARC LESS-THAN BRACKET +.. |rangd| unicode:: U+02992 .. RIGHT ANGLE BRACKET WITH DOT +.. |rbrke| unicode:: U+0298C .. RIGHT SQUARE BRACKET WITH UNDERBAR +.. |rbrksld| unicode:: U+0298E .. RIGHT SQUARE BRACKET WITH TICK IN BOTTOM CORNER +.. |rbrkslu| unicode:: U+02990 .. RIGHT SQUARE BRACKET WITH TICK IN TOP CORNER +.. |rceil| unicode:: U+02309 .. RIGHT CEILING +.. |rfloor| unicode:: U+0230B .. RIGHT FLOOR +.. |rmoust| unicode:: U+023B1 .. UPPER RIGHT OR LOWER LEFT CURLY BRACKET SECTION +.. |rpargt| unicode:: U+02994 .. RIGHT ARC GREATER-THAN BRACKET +.. |ulcorn| unicode:: U+0231C .. TOP LEFT CORNER +.. |urcorn| unicode:: U+0231D .. TOP RIGHT CORNER diff --git a/aws/dist/docutils/parsers/rst/include/isoamsn.txt b/aws/dist/docutils/parsers/rst/include/isoamsn.txt new file mode 100644 index 00000000..5ff17291 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamsn.txt @@ -0,0 +1,96 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |gnap| unicode:: U+02A8A .. GREATER-THAN AND NOT APPROXIMATE +.. |gnE| unicode:: U+02269 .. GREATER-THAN BUT NOT EQUAL TO +.. |gne| unicode:: U+02A88 .. GREATER-THAN AND SINGLE-LINE NOT EQUAL TO +.. |gnsim| unicode:: U+022E7 .. GREATER-THAN BUT NOT EQUIVALENT TO +.. |gvnE| unicode:: U+02269 U+0FE00 .. GREATER-THAN BUT NOT EQUAL TO - with vertical stroke +.. |lnap| unicode:: U+02A89 .. LESS-THAN AND NOT APPROXIMATE +.. |lnE| unicode:: U+02268 .. LESS-THAN BUT NOT EQUAL TO +.. |lne| unicode:: U+02A87 .. LESS-THAN AND SINGLE-LINE NOT EQUAL TO +.. |lnsim| unicode:: U+022E6 .. LESS-THAN BUT NOT EQUIVALENT TO +.. |lvnE| unicode:: U+02268 U+0FE00 .. LESS-THAN BUT NOT EQUAL TO - with vertical stroke +.. |nap| unicode:: U+02249 .. NOT ALMOST EQUAL TO +.. |napE| unicode:: U+02A70 U+00338 .. APPROXIMATELY EQUAL OR EQUAL TO with slash +.. |napid| unicode:: U+0224B U+00338 .. TRIPLE TILDE with slash +.. |ncong| unicode:: U+02247 .. NEITHER APPROXIMATELY NOR ACTUALLY EQUAL TO +.. |ncongdot| unicode:: U+02A6D U+00338 .. CONGRUENT WITH DOT ABOVE with slash +.. |nequiv| unicode:: U+02262 .. NOT IDENTICAL TO +.. |ngE| unicode:: U+02267 U+00338 .. GREATER-THAN OVER EQUAL TO with slash +.. |nge| unicode:: U+02271 .. NEITHER GREATER-THAN NOR EQUAL TO +.. |nges| unicode:: U+02A7E U+00338 .. GREATER-THAN OR SLANTED EQUAL TO with slash +.. |nGg| unicode:: U+022D9 U+00338 .. VERY MUCH GREATER-THAN with slash +.. |ngsim| unicode:: U+02275 .. NEITHER GREATER-THAN NOR EQUIVALENT TO +.. |nGt| unicode:: U+0226B U+020D2 .. MUCH GREATER THAN with vertical line +.. |ngt| unicode:: U+0226F .. NOT GREATER-THAN +.. |nGtv| unicode:: U+0226B U+00338 .. MUCH GREATER THAN with slash +.. |nlE| unicode:: U+02266 U+00338 .. LESS-THAN OVER EQUAL TO with slash +.. |nle| unicode:: U+02270 .. NEITHER LESS-THAN NOR EQUAL TO +.. |nles| unicode:: U+02A7D U+00338 .. LESS-THAN OR SLANTED EQUAL TO with slash +.. |nLl| unicode:: U+022D8 U+00338 .. VERY MUCH LESS-THAN with slash +.. |nlsim| unicode:: U+02274 .. NEITHER LESS-THAN NOR EQUIVALENT TO +.. |nLt| unicode:: U+0226A U+020D2 .. MUCH LESS THAN with vertical line +.. |nlt| unicode:: U+0226E .. NOT LESS-THAN +.. |nltri| unicode:: U+022EA .. NOT NORMAL SUBGROUP OF +.. |nltrie| unicode:: U+022EC .. NOT NORMAL SUBGROUP OF OR EQUAL TO +.. |nLtv| unicode:: U+0226A U+00338 .. MUCH LESS THAN with slash +.. |nmid| unicode:: U+02224 .. DOES NOT DIVIDE +.. |npar| unicode:: U+02226 .. NOT PARALLEL TO +.. |npr| unicode:: U+02280 .. DOES NOT PRECEDE +.. |nprcue| unicode:: U+022E0 .. DOES NOT PRECEDE OR EQUAL +.. |npre| unicode:: U+02AAF U+00338 .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |nrtri| unicode:: U+022EB .. DOES NOT CONTAIN AS NORMAL SUBGROUP +.. |nrtrie| unicode:: U+022ED .. DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL +.. |nsc| unicode:: U+02281 .. DOES NOT SUCCEED +.. |nsccue| unicode:: U+022E1 .. DOES NOT SUCCEED OR EQUAL +.. |nsce| unicode:: U+02AB0 U+00338 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |nsim| unicode:: U+02241 .. NOT TILDE +.. |nsime| unicode:: U+02244 .. NOT ASYMPTOTICALLY EQUAL TO +.. |nsmid| unicode:: U+02224 .. DOES NOT DIVIDE +.. |nspar| unicode:: U+02226 .. NOT PARALLEL TO +.. |nsqsube| unicode:: U+022E2 .. NOT SQUARE IMAGE OF OR EQUAL TO +.. |nsqsupe| unicode:: U+022E3 .. NOT SQUARE ORIGINAL OF OR EQUAL TO +.. |nsub| unicode:: U+02284 .. NOT A SUBSET OF +.. |nsubE| unicode:: U+02AC5 U+00338 .. SUBSET OF ABOVE EQUALS SIGN with slash +.. |nsube| unicode:: U+02288 .. NEITHER A SUBSET OF NOR EQUAL TO +.. |nsup| unicode:: U+02285 .. NOT A SUPERSET OF +.. |nsupE| unicode:: U+02AC6 U+00338 .. SUPERSET OF ABOVE EQUALS SIGN with slash +.. |nsupe| unicode:: U+02289 .. NEITHER A SUPERSET OF NOR EQUAL TO +.. |ntgl| unicode:: U+02279 .. NEITHER GREATER-THAN NOR LESS-THAN +.. |ntlg| unicode:: U+02278 .. NEITHER LESS-THAN NOR GREATER-THAN +.. |nvap| unicode:: U+0224D U+020D2 .. EQUIVALENT TO with vertical line +.. |nVDash| unicode:: U+022AF .. NEGATED DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE +.. |nVdash| unicode:: U+022AE .. DOES NOT FORCE +.. |nvDash| unicode:: U+022AD .. NOT TRUE +.. |nvdash| unicode:: U+022AC .. DOES NOT PROVE +.. |nvge| unicode:: U+02265 U+020D2 .. GREATER-THAN OR EQUAL TO with vertical line +.. |nvgt| unicode:: U+0003E U+020D2 .. GREATER-THAN SIGN with vertical line +.. |nvle| unicode:: U+02264 U+020D2 .. LESS-THAN OR EQUAL TO with vertical line +.. |nvlt| unicode:: U+0003C U+020D2 .. LESS-THAN SIGN with vertical line +.. |nvltrie| unicode:: U+022B4 U+020D2 .. NORMAL SUBGROUP OF OR EQUAL TO with vertical line +.. |nvrtrie| unicode:: U+022B5 U+020D2 .. CONTAINS AS NORMAL SUBGROUP OR EQUAL TO with vertical line +.. |nvsim| unicode:: U+0223C U+020D2 .. TILDE OPERATOR with vertical line +.. |parsim| unicode:: U+02AF3 .. PARALLEL WITH TILDE OPERATOR +.. |prnap| unicode:: U+02AB9 .. PRECEDES ABOVE NOT ALMOST EQUAL TO +.. |prnE| unicode:: U+02AB5 .. PRECEDES ABOVE NOT EQUAL TO +.. |prnsim| unicode:: U+022E8 .. PRECEDES BUT NOT EQUIVALENT TO +.. |rnmid| unicode:: U+02AEE .. DOES NOT DIVIDE WITH REVERSED NEGATION SLASH +.. |scnap| unicode:: U+02ABA .. SUCCEEDS ABOVE NOT ALMOST EQUAL TO +.. |scnE| unicode:: U+02AB6 .. SUCCEEDS ABOVE NOT EQUAL TO +.. |scnsim| unicode:: U+022E9 .. SUCCEEDS BUT NOT EQUIVALENT TO +.. |simne| unicode:: U+02246 .. APPROXIMATELY BUT NOT ACTUALLY EQUAL TO +.. |solbar| unicode:: U+0233F .. APL FUNCTIONAL SYMBOL SLASH BAR +.. |subnE| unicode:: U+02ACB .. SUBSET OF ABOVE NOT EQUAL TO +.. |subne| unicode:: U+0228A .. SUBSET OF WITH NOT EQUAL TO +.. |supnE| unicode:: U+02ACC .. SUPERSET OF ABOVE NOT EQUAL TO +.. |supne| unicode:: U+0228B .. SUPERSET OF WITH NOT EQUAL TO +.. |vnsub| unicode:: U+02282 U+020D2 .. SUBSET OF with vertical line +.. |vnsup| unicode:: U+02283 U+020D2 .. SUPERSET OF with vertical line +.. |vsubnE| unicode:: U+02ACB U+0FE00 .. SUBSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members +.. |vsubne| unicode:: U+0228A U+0FE00 .. SUBSET OF WITH NOT EQUAL TO - variant with stroke through bottom members +.. |vsupnE| unicode:: U+02ACC U+0FE00 .. SUPERSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members +.. |vsupne| unicode:: U+0228B U+0FE00 .. SUPERSET OF WITH NOT EQUAL TO - variant with stroke through bottom members diff --git a/aws/dist/docutils/parsers/rst/include/isoamso.txt b/aws/dist/docutils/parsers/rst/include/isoamso.txt new file mode 100644 index 00000000..65cc17e9 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamso.txt @@ -0,0 +1,62 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |ang| unicode:: U+02220 .. ANGLE +.. |ange| unicode:: U+029A4 .. ANGLE WITH UNDERBAR +.. |angmsd| unicode:: U+02221 .. MEASURED ANGLE +.. |angmsdaa| unicode:: U+029A8 .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING UP AND RIGHT +.. |angmsdab| unicode:: U+029A9 .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING UP AND LEFT +.. |angmsdac| unicode:: U+029AA .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING DOWN AND RIGHT +.. |angmsdad| unicode:: U+029AB .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING DOWN AND LEFT +.. |angmsdae| unicode:: U+029AC .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING RIGHT AND UP +.. |angmsdaf| unicode:: U+029AD .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING LEFT AND UP +.. |angmsdag| unicode:: U+029AE .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING RIGHT AND DOWN +.. |angmsdah| unicode:: U+029AF .. MEASURED ANGLE WITH OPEN ARM ENDING IN ARROW POINTING LEFT AND DOWN +.. |angrtvb| unicode:: U+022BE .. RIGHT ANGLE WITH ARC +.. |angrtvbd| unicode:: U+0299D .. MEASURED RIGHT ANGLE WITH DOT +.. |bbrk| unicode:: U+023B5 .. BOTTOM SQUARE BRACKET +.. |bbrktbrk| unicode:: U+023B6 .. BOTTOM SQUARE BRACKET OVER TOP SQUARE BRACKET +.. |bemptyv| unicode:: U+029B0 .. REVERSED EMPTY SET +.. |beth| unicode:: U+02136 .. BET SYMBOL +.. |boxbox| unicode:: U+029C9 .. TWO JOINED SQUARES +.. |bprime| unicode:: U+02035 .. REVERSED PRIME +.. |bsemi| unicode:: U+0204F .. REVERSED SEMICOLON +.. |cemptyv| unicode:: U+029B2 .. EMPTY SET WITH SMALL CIRCLE ABOVE +.. |cirE| unicode:: U+029C3 .. CIRCLE WITH TWO HORIZONTAL STROKES TO THE RIGHT +.. |cirscir| unicode:: U+029C2 .. CIRCLE WITH SMALL CIRCLE TO THE RIGHT +.. |comp| unicode:: U+02201 .. COMPLEMENT +.. |daleth| unicode:: U+02138 .. DALET SYMBOL +.. |demptyv| unicode:: U+029B1 .. EMPTY SET WITH OVERBAR +.. |ell| unicode:: U+02113 .. SCRIPT SMALL L +.. |empty| unicode:: U+02205 .. EMPTY SET +.. |emptyv| unicode:: U+02205 .. EMPTY SET +.. |gimel| unicode:: U+02137 .. GIMEL SYMBOL +.. |iiota| unicode:: U+02129 .. TURNED GREEK SMALL LETTER IOTA +.. |image| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |imath| unicode:: U+00131 .. LATIN SMALL LETTER DOTLESS I +.. |inodot| unicode:: U+00131 .. LATIN SMALL LETTER DOTLESS I +.. |jmath| unicode:: U+0006A .. LATIN SMALL LETTER J +.. |jnodot| unicode:: U+0006A .. LATIN SMALL LETTER J +.. |laemptyv| unicode:: U+029B4 .. EMPTY SET WITH LEFT ARROW ABOVE +.. |lltri| unicode:: U+025FA .. LOWER LEFT TRIANGLE +.. |lrtri| unicode:: U+022BF .. RIGHT TRIANGLE +.. |mho| unicode:: U+02127 .. INVERTED OHM SIGN +.. |nang| unicode:: U+02220 U+020D2 .. ANGLE with vertical line +.. |nexist| unicode:: U+02204 .. THERE DOES NOT EXIST +.. |oS| unicode:: U+024C8 .. CIRCLED LATIN CAPITAL LETTER S +.. |planck| unicode:: U+0210F .. PLANCK CONSTANT OVER TWO PI +.. |plankv| unicode:: U+0210F .. PLANCK CONSTANT OVER TWO PI +.. |raemptyv| unicode:: U+029B3 .. EMPTY SET WITH RIGHT ARROW ABOVE +.. |range| unicode:: U+029A5 .. REVERSED ANGLE WITH UNDERBAR +.. |real| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |sbsol| unicode:: U+0FE68 .. SMALL REVERSE SOLIDUS +.. |tbrk| unicode:: U+023B4 .. TOP SQUARE BRACKET +.. |trpezium| unicode:: U+0FFFD .. REPLACEMENT CHARACTER +.. |ultri| unicode:: U+025F8 .. UPPER LEFT TRIANGLE +.. |urtri| unicode:: U+025F9 .. UPPER RIGHT TRIANGLE +.. |vprime| unicode:: U+02032 .. PRIME +.. |vzigzag| unicode:: U+0299A .. VERTICAL ZIGZAG LINE +.. |weierp| unicode:: U+02118 .. SCRIPT CAPITAL P diff --git a/aws/dist/docutils/parsers/rst/include/isoamsr.txt b/aws/dist/docutils/parsers/rst/include/isoamsr.txt new file mode 100644 index 00000000..a3d03dab --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isoamsr.txt @@ -0,0 +1,191 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |apE| unicode:: U+02A70 .. APPROXIMATELY EQUAL OR EQUAL TO +.. |ape| unicode:: U+0224A .. ALMOST EQUAL OR EQUAL TO +.. |apid| unicode:: U+0224B .. TRIPLE TILDE +.. |asymp| unicode:: U+02248 .. ALMOST EQUAL TO +.. |Barv| unicode:: U+02AE7 .. SHORT DOWN TACK WITH OVERBAR +.. |bcong| unicode:: U+0224C .. ALL EQUAL TO +.. |bepsi| unicode:: U+003F6 .. GREEK REVERSED LUNATE EPSILON SYMBOL +.. |bowtie| unicode:: U+022C8 .. BOWTIE +.. |bsim| unicode:: U+0223D .. REVERSED TILDE +.. |bsime| unicode:: U+022CD .. REVERSED TILDE EQUALS +.. |bsolhsub| unicode:: U+0005C U+02282 .. REVERSE SOLIDUS, SUBSET OF +.. |bump| unicode:: U+0224E .. GEOMETRICALLY EQUIVALENT TO +.. |bumpE| unicode:: U+02AAE .. EQUALS SIGN WITH BUMPY ABOVE +.. |bumpe| unicode:: U+0224F .. DIFFERENCE BETWEEN +.. |cire| unicode:: U+02257 .. RING EQUAL TO +.. |Colon| unicode:: U+02237 .. PROPORTION +.. |Colone| unicode:: U+02A74 .. DOUBLE COLON EQUAL +.. |colone| unicode:: U+02254 .. COLON EQUALS +.. |congdot| unicode:: U+02A6D .. CONGRUENT WITH DOT ABOVE +.. |csub| unicode:: U+02ACF .. CLOSED SUBSET +.. |csube| unicode:: U+02AD1 .. CLOSED SUBSET OR EQUAL TO +.. |csup| unicode:: U+02AD0 .. CLOSED SUPERSET +.. |csupe| unicode:: U+02AD2 .. CLOSED SUPERSET OR EQUAL TO +.. |cuepr| unicode:: U+022DE .. EQUAL TO OR PRECEDES +.. |cuesc| unicode:: U+022DF .. EQUAL TO OR SUCCEEDS +.. |cupre| unicode:: U+0227C .. PRECEDES OR EQUAL TO +.. |Dashv| unicode:: U+02AE4 .. VERTICAL BAR DOUBLE LEFT TURNSTILE +.. |dashv| unicode:: U+022A3 .. LEFT TACK +.. |easter| unicode:: U+02A6E .. EQUALS WITH ASTERISK +.. |ecir| unicode:: U+02256 .. RING IN EQUAL TO +.. |ecolon| unicode:: U+02255 .. EQUALS COLON +.. |eDDot| unicode:: U+02A77 .. EQUALS SIGN WITH TWO DOTS ABOVE AND TWO DOTS BELOW +.. |eDot| unicode:: U+02251 .. GEOMETRICALLY EQUAL TO +.. |efDot| unicode:: U+02252 .. APPROXIMATELY EQUAL TO OR THE IMAGE OF +.. |eg| unicode:: U+02A9A .. DOUBLE-LINE EQUAL TO OR GREATER-THAN +.. |egs| unicode:: U+02A96 .. SLANTED EQUAL TO OR GREATER-THAN +.. |egsdot| unicode:: U+02A98 .. SLANTED EQUAL TO OR GREATER-THAN WITH DOT INSIDE +.. |el| unicode:: U+02A99 .. DOUBLE-LINE EQUAL TO OR LESS-THAN +.. |els| unicode:: U+02A95 .. SLANTED EQUAL TO OR LESS-THAN +.. |elsdot| unicode:: U+02A97 .. SLANTED EQUAL TO OR LESS-THAN WITH DOT INSIDE +.. |equest| unicode:: U+0225F .. QUESTIONED EQUAL TO +.. |equivDD| unicode:: U+02A78 .. EQUIVALENT WITH FOUR DOTS ABOVE +.. |erDot| unicode:: U+02253 .. IMAGE OF OR APPROXIMATELY EQUAL TO +.. |esdot| unicode:: U+02250 .. APPROACHES THE LIMIT +.. |Esim| unicode:: U+02A73 .. EQUALS SIGN ABOVE TILDE OPERATOR +.. |esim| unicode:: U+02242 .. MINUS TILDE +.. |fork| unicode:: U+022D4 .. PITCHFORK +.. |forkv| unicode:: U+02AD9 .. ELEMENT OF OPENING DOWNWARDS +.. |frown| unicode:: U+02322 .. FROWN +.. |gap| unicode:: U+02A86 .. GREATER-THAN OR APPROXIMATE +.. |gE| unicode:: U+02267 .. GREATER-THAN OVER EQUAL TO +.. |gEl| unicode:: U+02A8C .. GREATER-THAN ABOVE DOUBLE-LINE EQUAL ABOVE LESS-THAN +.. |gel| unicode:: U+022DB .. GREATER-THAN EQUAL TO OR LESS-THAN +.. |ges| unicode:: U+02A7E .. GREATER-THAN OR SLANTED EQUAL TO +.. |gescc| unicode:: U+02AA9 .. GREATER-THAN CLOSED BY CURVE ABOVE SLANTED EQUAL +.. |gesdot| unicode:: U+02A80 .. GREATER-THAN OR SLANTED EQUAL TO WITH DOT INSIDE +.. |gesdoto| unicode:: U+02A82 .. GREATER-THAN OR SLANTED EQUAL TO WITH DOT ABOVE +.. |gesdotol| unicode:: U+02A84 .. GREATER-THAN OR SLANTED EQUAL TO WITH DOT ABOVE LEFT +.. |gesl| unicode:: U+022DB U+0FE00 .. GREATER-THAN slanted EQUAL TO OR LESS-THAN +.. |gesles| unicode:: U+02A94 .. GREATER-THAN ABOVE SLANTED EQUAL ABOVE LESS-THAN ABOVE SLANTED EQUAL +.. |Gg| unicode:: U+022D9 .. VERY MUCH GREATER-THAN +.. |gl| unicode:: U+02277 .. GREATER-THAN OR LESS-THAN +.. |gla| unicode:: U+02AA5 .. GREATER-THAN BESIDE LESS-THAN +.. |glE| unicode:: U+02A92 .. GREATER-THAN ABOVE LESS-THAN ABOVE DOUBLE-LINE EQUAL +.. |glj| unicode:: U+02AA4 .. GREATER-THAN OVERLAPPING LESS-THAN +.. |gsdot| unicode:: U+022D7 .. GREATER-THAN WITH DOT +.. |gsim| unicode:: U+02273 .. GREATER-THAN OR EQUIVALENT TO +.. |gsime| unicode:: U+02A8E .. GREATER-THAN ABOVE SIMILAR OR EQUAL +.. |gsiml| unicode:: U+02A90 .. GREATER-THAN ABOVE SIMILAR ABOVE LESS-THAN +.. |Gt| unicode:: U+0226B .. MUCH GREATER-THAN +.. |gtcc| unicode:: U+02AA7 .. GREATER-THAN CLOSED BY CURVE +.. |gtcir| unicode:: U+02A7A .. GREATER-THAN WITH CIRCLE INSIDE +.. |gtdot| unicode:: U+022D7 .. GREATER-THAN WITH DOT +.. |gtquest| unicode:: U+02A7C .. GREATER-THAN WITH QUESTION MARK ABOVE +.. |gtrarr| unicode:: U+02978 .. GREATER-THAN ABOVE RIGHTWARDS ARROW +.. |homtht| unicode:: U+0223B .. HOMOTHETIC +.. |lap| unicode:: U+02A85 .. LESS-THAN OR APPROXIMATE +.. |lat| unicode:: U+02AAB .. LARGER THAN +.. |late| unicode:: U+02AAD .. LARGER THAN OR EQUAL TO +.. |lates| unicode:: U+02AAD U+0FE00 .. LARGER THAN OR slanted EQUAL +.. |ldot| unicode:: U+022D6 .. LESS-THAN WITH DOT +.. |lE| unicode:: U+02266 .. LESS-THAN OVER EQUAL TO +.. |lEg| unicode:: U+02A8B .. LESS-THAN ABOVE DOUBLE-LINE EQUAL ABOVE GREATER-THAN +.. |leg| unicode:: U+022DA .. LESS-THAN EQUAL TO OR GREATER-THAN +.. |les| unicode:: U+02A7D .. LESS-THAN OR SLANTED EQUAL TO +.. |lescc| unicode:: U+02AA8 .. LESS-THAN CLOSED BY CURVE ABOVE SLANTED EQUAL +.. |lesdot| unicode:: U+02A7F .. LESS-THAN OR SLANTED EQUAL TO WITH DOT INSIDE +.. |lesdoto| unicode:: U+02A81 .. LESS-THAN OR SLANTED EQUAL TO WITH DOT ABOVE +.. |lesdotor| unicode:: U+02A83 .. LESS-THAN OR SLANTED EQUAL TO WITH DOT ABOVE RIGHT +.. |lesg| unicode:: U+022DA U+0FE00 .. LESS-THAN slanted EQUAL TO OR GREATER-THAN +.. |lesges| unicode:: U+02A93 .. LESS-THAN ABOVE SLANTED EQUAL ABOVE GREATER-THAN ABOVE SLANTED EQUAL +.. |lg| unicode:: U+02276 .. LESS-THAN OR GREATER-THAN +.. |lgE| unicode:: U+02A91 .. LESS-THAN ABOVE GREATER-THAN ABOVE DOUBLE-LINE EQUAL +.. |Ll| unicode:: U+022D8 .. VERY MUCH LESS-THAN +.. |lsim| unicode:: U+02272 .. LESS-THAN OR EQUIVALENT TO +.. |lsime| unicode:: U+02A8D .. LESS-THAN ABOVE SIMILAR OR EQUAL +.. |lsimg| unicode:: U+02A8F .. LESS-THAN ABOVE SIMILAR ABOVE GREATER-THAN +.. |Lt| unicode:: U+0226A .. MUCH LESS-THAN +.. |ltcc| unicode:: U+02AA6 .. LESS-THAN CLOSED BY CURVE +.. |ltcir| unicode:: U+02A79 .. LESS-THAN WITH CIRCLE INSIDE +.. |ltdot| unicode:: U+022D6 .. LESS-THAN WITH DOT +.. |ltlarr| unicode:: U+02976 .. LESS-THAN ABOVE LEFTWARDS ARROW +.. |ltquest| unicode:: U+02A7B .. LESS-THAN WITH QUESTION MARK ABOVE +.. |ltrie| unicode:: U+022B4 .. NORMAL SUBGROUP OF OR EQUAL TO +.. |mcomma| unicode:: U+02A29 .. MINUS SIGN WITH COMMA ABOVE +.. |mDDot| unicode:: U+0223A .. GEOMETRIC PROPORTION +.. |mid| unicode:: U+02223 .. DIVIDES +.. |mlcp| unicode:: U+02ADB .. TRANSVERSAL INTERSECTION +.. |models| unicode:: U+022A7 .. MODELS +.. |mstpos| unicode:: U+0223E .. INVERTED LAZY S +.. |Pr| unicode:: U+02ABB .. DOUBLE PRECEDES +.. |pr| unicode:: U+0227A .. PRECEDES +.. |prap| unicode:: U+02AB7 .. PRECEDES ABOVE ALMOST EQUAL TO +.. |prcue| unicode:: U+0227C .. PRECEDES OR EQUAL TO +.. |prE| unicode:: U+02AB3 .. PRECEDES ABOVE EQUALS SIGN +.. |pre| unicode:: U+02AAF .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN +.. |prsim| unicode:: U+0227E .. PRECEDES OR EQUIVALENT TO +.. |prurel| unicode:: U+022B0 .. PRECEDES UNDER RELATION +.. |ratio| unicode:: U+02236 .. RATIO +.. |rtrie| unicode:: U+022B5 .. CONTAINS AS NORMAL SUBGROUP OR EQUAL TO +.. |rtriltri| unicode:: U+029CE .. RIGHT TRIANGLE ABOVE LEFT TRIANGLE +.. |samalg| unicode:: U+02210 .. N-ARY COPRODUCT +.. |Sc| unicode:: U+02ABC .. DOUBLE SUCCEEDS +.. |sc| unicode:: U+0227B .. SUCCEEDS +.. |scap| unicode:: U+02AB8 .. SUCCEEDS ABOVE ALMOST EQUAL TO +.. |sccue| unicode:: U+0227D .. SUCCEEDS OR EQUAL TO +.. |scE| unicode:: U+02AB4 .. SUCCEEDS ABOVE EQUALS SIGN +.. |sce| unicode:: U+02AB0 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN +.. |scsim| unicode:: U+0227F .. SUCCEEDS OR EQUIVALENT TO +.. |sdote| unicode:: U+02A66 .. EQUALS SIGN WITH DOT BELOW +.. |sfrown| unicode:: U+02322 .. FROWN +.. |simg| unicode:: U+02A9E .. SIMILAR OR GREATER-THAN +.. |simgE| unicode:: U+02AA0 .. SIMILAR ABOVE GREATER-THAN ABOVE EQUALS SIGN +.. |siml| unicode:: U+02A9D .. SIMILAR OR LESS-THAN +.. |simlE| unicode:: U+02A9F .. SIMILAR ABOVE LESS-THAN ABOVE EQUALS SIGN +.. |smid| unicode:: U+02223 .. DIVIDES +.. |smile| unicode:: U+02323 .. SMILE +.. |smt| unicode:: U+02AAA .. SMALLER THAN +.. |smte| unicode:: U+02AAC .. SMALLER THAN OR EQUAL TO +.. |smtes| unicode:: U+02AAC U+0FE00 .. SMALLER THAN OR slanted EQUAL +.. |spar| unicode:: U+02225 .. PARALLEL TO +.. |sqsub| unicode:: U+0228F .. SQUARE IMAGE OF +.. |sqsube| unicode:: U+02291 .. SQUARE IMAGE OF OR EQUAL TO +.. |sqsup| unicode:: U+02290 .. SQUARE ORIGINAL OF +.. |sqsupe| unicode:: U+02292 .. SQUARE ORIGINAL OF OR EQUAL TO +.. |ssmile| unicode:: U+02323 .. SMILE +.. |Sub| unicode:: U+022D0 .. DOUBLE SUBSET +.. |subE| unicode:: U+02AC5 .. SUBSET OF ABOVE EQUALS SIGN +.. |subedot| unicode:: U+02AC3 .. SUBSET OF OR EQUAL TO WITH DOT ABOVE +.. |submult| unicode:: U+02AC1 .. SUBSET WITH MULTIPLICATION SIGN BELOW +.. |subplus| unicode:: U+02ABF .. SUBSET WITH PLUS SIGN BELOW +.. |subrarr| unicode:: U+02979 .. SUBSET ABOVE RIGHTWARDS ARROW +.. |subsim| unicode:: U+02AC7 .. SUBSET OF ABOVE TILDE OPERATOR +.. |subsub| unicode:: U+02AD5 .. SUBSET ABOVE SUBSET +.. |subsup| unicode:: U+02AD3 .. SUBSET ABOVE SUPERSET +.. |Sup| unicode:: U+022D1 .. DOUBLE SUPERSET +.. |supdsub| unicode:: U+02AD8 .. SUPERSET BESIDE AND JOINED BY DASH WITH SUBSET +.. |supE| unicode:: U+02AC6 .. SUPERSET OF ABOVE EQUALS SIGN +.. |supedot| unicode:: U+02AC4 .. SUPERSET OF OR EQUAL TO WITH DOT ABOVE +.. |suphsol| unicode:: U+02283 U+0002F .. SUPERSET OF, SOLIDUS +.. |suphsub| unicode:: U+02AD7 .. SUPERSET BESIDE SUBSET +.. |suplarr| unicode:: U+0297B .. SUPERSET ABOVE LEFTWARDS ARROW +.. |supmult| unicode:: U+02AC2 .. SUPERSET WITH MULTIPLICATION SIGN BELOW +.. |supplus| unicode:: U+02AC0 .. SUPERSET WITH PLUS SIGN BELOW +.. |supsim| unicode:: U+02AC8 .. SUPERSET OF ABOVE TILDE OPERATOR +.. |supsub| unicode:: U+02AD4 .. SUPERSET ABOVE SUBSET +.. |supsup| unicode:: U+02AD6 .. SUPERSET ABOVE SUPERSET +.. |thkap| unicode:: U+02248 .. ALMOST EQUAL TO +.. |thksim| unicode:: U+0223C .. TILDE OPERATOR +.. |topfork| unicode:: U+02ADA .. PITCHFORK WITH TEE TOP +.. |trie| unicode:: U+0225C .. DELTA EQUAL TO +.. |twixt| unicode:: U+0226C .. BETWEEN +.. |Vbar| unicode:: U+02AEB .. DOUBLE UP TACK +.. |vBar| unicode:: U+02AE8 .. SHORT UP TACK WITH UNDERBAR +.. |vBarv| unicode:: U+02AE9 .. SHORT UP TACK ABOVE SHORT DOWN TACK +.. |VDash| unicode:: U+022AB .. DOUBLE VERTICAL BAR DOUBLE RIGHT TURNSTILE +.. |Vdash| unicode:: U+022A9 .. FORCES +.. |vDash| unicode:: U+022A8 .. TRUE +.. |vdash| unicode:: U+022A2 .. RIGHT TACK +.. |Vdashl| unicode:: U+02AE6 .. LONG DASH FROM LEFT MEMBER OF DOUBLE VERTICAL +.. |veebar| unicode:: U+022BB .. XOR +.. |vltri| unicode:: U+022B2 .. NORMAL SUBGROUP OF +.. |vprop| unicode:: U+0221D .. PROPORTIONAL TO +.. |vrtri| unicode:: U+022B3 .. CONTAINS AS NORMAL SUBGROUP +.. |Vvdash| unicode:: U+022AA .. TRIPLE VERTICAL BAR RIGHT TURNSTILE diff --git a/aws/dist/docutils/parsers/rst/include/isobox.txt b/aws/dist/docutils/parsers/rst/include/isobox.txt new file mode 100644 index 00000000..2304f877 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isobox.txt @@ -0,0 +1,46 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |boxDL| unicode:: U+02557 .. BOX DRAWINGS DOUBLE DOWN AND LEFT +.. |boxDl| unicode:: U+02556 .. BOX DRAWINGS DOWN DOUBLE AND LEFT SINGLE +.. |boxdL| unicode:: U+02555 .. BOX DRAWINGS DOWN SINGLE AND LEFT DOUBLE +.. |boxdl| unicode:: U+02510 .. BOX DRAWINGS LIGHT DOWN AND LEFT +.. |boxDR| unicode:: U+02554 .. BOX DRAWINGS DOUBLE DOWN AND RIGHT +.. |boxDr| unicode:: U+02553 .. BOX DRAWINGS DOWN DOUBLE AND RIGHT SINGLE +.. |boxdR| unicode:: U+02552 .. BOX DRAWINGS DOWN SINGLE AND RIGHT DOUBLE +.. |boxdr| unicode:: U+0250C .. BOX DRAWINGS LIGHT DOWN AND RIGHT +.. |boxH| unicode:: U+02550 .. BOX DRAWINGS DOUBLE HORIZONTAL +.. |boxh| unicode:: U+02500 .. BOX DRAWINGS LIGHT HORIZONTAL +.. |boxHD| unicode:: U+02566 .. BOX DRAWINGS DOUBLE DOWN AND HORIZONTAL +.. |boxHd| unicode:: U+02564 .. BOX DRAWINGS DOWN SINGLE AND HORIZONTAL DOUBLE +.. |boxhD| unicode:: U+02565 .. BOX DRAWINGS DOWN DOUBLE AND HORIZONTAL SINGLE +.. |boxhd| unicode:: U+0252C .. BOX DRAWINGS LIGHT DOWN AND HORIZONTAL +.. |boxHU| unicode:: U+02569 .. BOX DRAWINGS DOUBLE UP AND HORIZONTAL +.. |boxHu| unicode:: U+02567 .. BOX DRAWINGS UP SINGLE AND HORIZONTAL DOUBLE +.. |boxhU| unicode:: U+02568 .. BOX DRAWINGS UP DOUBLE AND HORIZONTAL SINGLE +.. |boxhu| unicode:: U+02534 .. BOX DRAWINGS LIGHT UP AND HORIZONTAL +.. |boxUL| unicode:: U+0255D .. BOX DRAWINGS DOUBLE UP AND LEFT +.. |boxUl| unicode:: U+0255C .. BOX DRAWINGS UP DOUBLE AND LEFT SINGLE +.. |boxuL| unicode:: U+0255B .. BOX DRAWINGS UP SINGLE AND LEFT DOUBLE +.. |boxul| unicode:: U+02518 .. BOX DRAWINGS LIGHT UP AND LEFT +.. |boxUR| unicode:: U+0255A .. BOX DRAWINGS DOUBLE UP AND RIGHT +.. |boxUr| unicode:: U+02559 .. BOX DRAWINGS UP DOUBLE AND RIGHT SINGLE +.. |boxuR| unicode:: U+02558 .. BOX DRAWINGS UP SINGLE AND RIGHT DOUBLE +.. |boxur| unicode:: U+02514 .. BOX DRAWINGS LIGHT UP AND RIGHT +.. |boxV| unicode:: U+02551 .. BOX DRAWINGS DOUBLE VERTICAL +.. |boxv| unicode:: U+02502 .. BOX DRAWINGS LIGHT VERTICAL +.. |boxVH| unicode:: U+0256C .. BOX DRAWINGS DOUBLE VERTICAL AND HORIZONTAL +.. |boxVh| unicode:: U+0256B .. BOX DRAWINGS VERTICAL DOUBLE AND HORIZONTAL SINGLE +.. |boxvH| unicode:: U+0256A .. BOX DRAWINGS VERTICAL SINGLE AND HORIZONTAL DOUBLE +.. |boxvh| unicode:: U+0253C .. BOX DRAWINGS LIGHT VERTICAL AND HORIZONTAL +.. |boxVL| unicode:: U+02563 .. BOX DRAWINGS DOUBLE VERTICAL AND LEFT +.. |boxVl| unicode:: U+02562 .. BOX DRAWINGS VERTICAL DOUBLE AND LEFT SINGLE +.. |boxvL| unicode:: U+02561 .. BOX DRAWINGS VERTICAL SINGLE AND LEFT DOUBLE +.. |boxvl| unicode:: U+02524 .. BOX DRAWINGS LIGHT VERTICAL AND LEFT +.. |boxVR| unicode:: U+02560 .. BOX DRAWINGS DOUBLE VERTICAL AND RIGHT +.. |boxVr| unicode:: U+0255F .. BOX DRAWINGS VERTICAL DOUBLE AND RIGHT SINGLE +.. |boxvR| unicode:: U+0255E .. BOX DRAWINGS VERTICAL SINGLE AND RIGHT DOUBLE +.. |boxvr| unicode:: U+0251C .. BOX DRAWINGS LIGHT VERTICAL AND RIGHT diff --git a/aws/dist/docutils/parsers/rst/include/isocyr1.txt b/aws/dist/docutils/parsers/rst/include/isocyr1.txt new file mode 100644 index 00000000..afee744c --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isocyr1.txt @@ -0,0 +1,73 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Acy| unicode:: U+00410 .. CYRILLIC CAPITAL LETTER A +.. |acy| unicode:: U+00430 .. CYRILLIC SMALL LETTER A +.. |Bcy| unicode:: U+00411 .. CYRILLIC CAPITAL LETTER BE +.. |bcy| unicode:: U+00431 .. CYRILLIC SMALL LETTER BE +.. |CHcy| unicode:: U+00427 .. CYRILLIC CAPITAL LETTER CHE +.. |chcy| unicode:: U+00447 .. CYRILLIC SMALL LETTER CHE +.. |Dcy| unicode:: U+00414 .. CYRILLIC CAPITAL LETTER DE +.. |dcy| unicode:: U+00434 .. CYRILLIC SMALL LETTER DE +.. |Ecy| unicode:: U+0042D .. CYRILLIC CAPITAL LETTER E +.. |ecy| unicode:: U+0044D .. CYRILLIC SMALL LETTER E +.. |Fcy| unicode:: U+00424 .. CYRILLIC CAPITAL LETTER EF +.. |fcy| unicode:: U+00444 .. CYRILLIC SMALL LETTER EF +.. |Gcy| unicode:: U+00413 .. CYRILLIC CAPITAL LETTER GHE +.. |gcy| unicode:: U+00433 .. CYRILLIC SMALL LETTER GHE +.. |HARDcy| unicode:: U+0042A .. CYRILLIC CAPITAL LETTER HARD SIGN +.. |hardcy| unicode:: U+0044A .. CYRILLIC SMALL LETTER HARD SIGN +.. |Icy| unicode:: U+00418 .. CYRILLIC CAPITAL LETTER I +.. |icy| unicode:: U+00438 .. CYRILLIC SMALL LETTER I +.. |IEcy| unicode:: U+00415 .. CYRILLIC CAPITAL LETTER IE +.. |iecy| unicode:: U+00435 .. CYRILLIC SMALL LETTER IE +.. |IOcy| unicode:: U+00401 .. CYRILLIC CAPITAL LETTER IO +.. |iocy| unicode:: U+00451 .. CYRILLIC SMALL LETTER IO +.. |Jcy| unicode:: U+00419 .. CYRILLIC CAPITAL LETTER SHORT I +.. |jcy| unicode:: U+00439 .. CYRILLIC SMALL LETTER SHORT I +.. |Kcy| unicode:: U+0041A .. CYRILLIC CAPITAL LETTER KA +.. |kcy| unicode:: U+0043A .. CYRILLIC SMALL LETTER KA +.. |KHcy| unicode:: U+00425 .. CYRILLIC CAPITAL LETTER HA +.. |khcy| unicode:: U+00445 .. CYRILLIC SMALL LETTER HA +.. |Lcy| unicode:: U+0041B .. CYRILLIC CAPITAL LETTER EL +.. |lcy| unicode:: U+0043B .. CYRILLIC SMALL LETTER EL +.. |Mcy| unicode:: U+0041C .. CYRILLIC CAPITAL LETTER EM +.. |mcy| unicode:: U+0043C .. CYRILLIC SMALL LETTER EM +.. |Ncy| unicode:: U+0041D .. CYRILLIC CAPITAL LETTER EN +.. |ncy| unicode:: U+0043D .. CYRILLIC SMALL LETTER EN +.. |numero| unicode:: U+02116 .. NUMERO SIGN +.. |Ocy| unicode:: U+0041E .. CYRILLIC CAPITAL LETTER O +.. |ocy| unicode:: U+0043E .. CYRILLIC SMALL LETTER O +.. |Pcy| unicode:: U+0041F .. CYRILLIC CAPITAL LETTER PE +.. |pcy| unicode:: U+0043F .. CYRILLIC SMALL LETTER PE +.. |Rcy| unicode:: U+00420 .. CYRILLIC CAPITAL LETTER ER +.. |rcy| unicode:: U+00440 .. CYRILLIC SMALL LETTER ER +.. |Scy| unicode:: U+00421 .. CYRILLIC CAPITAL LETTER ES +.. |scy| unicode:: U+00441 .. CYRILLIC SMALL LETTER ES +.. |SHCHcy| unicode:: U+00429 .. CYRILLIC CAPITAL LETTER SHCHA +.. |shchcy| unicode:: U+00449 .. CYRILLIC SMALL LETTER SHCHA +.. |SHcy| unicode:: U+00428 .. CYRILLIC CAPITAL LETTER SHA +.. |shcy| unicode:: U+00448 .. CYRILLIC SMALL LETTER SHA +.. |SOFTcy| unicode:: U+0042C .. CYRILLIC CAPITAL LETTER SOFT SIGN +.. |softcy| unicode:: U+0044C .. CYRILLIC SMALL LETTER SOFT SIGN +.. |Tcy| unicode:: U+00422 .. CYRILLIC CAPITAL LETTER TE +.. |tcy| unicode:: U+00442 .. CYRILLIC SMALL LETTER TE +.. |TScy| unicode:: U+00426 .. CYRILLIC CAPITAL LETTER TSE +.. |tscy| unicode:: U+00446 .. CYRILLIC SMALL LETTER TSE +.. |Ucy| unicode:: U+00423 .. CYRILLIC CAPITAL LETTER U +.. |ucy| unicode:: U+00443 .. CYRILLIC SMALL LETTER U +.. |Vcy| unicode:: U+00412 .. CYRILLIC CAPITAL LETTER VE +.. |vcy| unicode:: U+00432 .. CYRILLIC SMALL LETTER VE +.. |YAcy| unicode:: U+0042F .. CYRILLIC CAPITAL LETTER YA +.. |yacy| unicode:: U+0044F .. CYRILLIC SMALL LETTER YA +.. |Ycy| unicode:: U+0042B .. CYRILLIC CAPITAL LETTER YERU +.. |ycy| unicode:: U+0044B .. CYRILLIC SMALL LETTER YERU +.. |YUcy| unicode:: U+0042E .. CYRILLIC CAPITAL LETTER YU +.. |yucy| unicode:: U+0044E .. CYRILLIC SMALL LETTER YU +.. |Zcy| unicode:: U+00417 .. CYRILLIC CAPITAL LETTER ZE +.. |zcy| unicode:: U+00437 .. CYRILLIC SMALL LETTER ZE +.. |ZHcy| unicode:: U+00416 .. CYRILLIC CAPITAL LETTER ZHE +.. |zhcy| unicode:: U+00436 .. CYRILLIC SMALL LETTER ZHE diff --git a/aws/dist/docutils/parsers/rst/include/isocyr2.txt b/aws/dist/docutils/parsers/rst/include/isocyr2.txt new file mode 100644 index 00000000..fe09c015 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isocyr2.txt @@ -0,0 +1,32 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |DJcy| unicode:: U+00402 .. CYRILLIC CAPITAL LETTER DJE +.. |djcy| unicode:: U+00452 .. CYRILLIC SMALL LETTER DJE +.. |DScy| unicode:: U+00405 .. CYRILLIC CAPITAL LETTER DZE +.. |dscy| unicode:: U+00455 .. CYRILLIC SMALL LETTER DZE +.. |DZcy| unicode:: U+0040F .. CYRILLIC CAPITAL LETTER DZHE +.. |dzcy| unicode:: U+0045F .. CYRILLIC SMALL LETTER DZHE +.. |GJcy| unicode:: U+00403 .. CYRILLIC CAPITAL LETTER GJE +.. |gjcy| unicode:: U+00453 .. CYRILLIC SMALL LETTER GJE +.. |Iukcy| unicode:: U+00406 .. CYRILLIC CAPITAL LETTER BYELORUSSIAN-UKRAINIAN I +.. |iukcy| unicode:: U+00456 .. CYRILLIC SMALL LETTER BYELORUSSIAN-UKRAINIAN I +.. |Jsercy| unicode:: U+00408 .. CYRILLIC CAPITAL LETTER JE +.. |jsercy| unicode:: U+00458 .. CYRILLIC SMALL LETTER JE +.. |Jukcy| unicode:: U+00404 .. CYRILLIC CAPITAL LETTER UKRAINIAN IE +.. |jukcy| unicode:: U+00454 .. CYRILLIC SMALL LETTER UKRAINIAN IE +.. |KJcy| unicode:: U+0040C .. CYRILLIC CAPITAL LETTER KJE +.. |kjcy| unicode:: U+0045C .. CYRILLIC SMALL LETTER KJE +.. |LJcy| unicode:: U+00409 .. CYRILLIC CAPITAL LETTER LJE +.. |ljcy| unicode:: U+00459 .. CYRILLIC SMALL LETTER LJE +.. |NJcy| unicode:: U+0040A .. CYRILLIC CAPITAL LETTER NJE +.. |njcy| unicode:: U+0045A .. CYRILLIC SMALL LETTER NJE +.. |TSHcy| unicode:: U+0040B .. CYRILLIC CAPITAL LETTER TSHE +.. |tshcy| unicode:: U+0045B .. CYRILLIC SMALL LETTER TSHE +.. |Ubrcy| unicode:: U+0040E .. CYRILLIC CAPITAL LETTER SHORT U +.. |ubrcy| unicode:: U+0045E .. CYRILLIC SMALL LETTER SHORT U +.. |YIcy| unicode:: U+00407 .. CYRILLIC CAPITAL LETTER YI +.. |yicy| unicode:: U+00457 .. CYRILLIC SMALL LETTER YI diff --git a/aws/dist/docutils/parsers/rst/include/isodia.txt b/aws/dist/docutils/parsers/rst/include/isodia.txt new file mode 100644 index 00000000..ede6d994 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isodia.txt @@ -0,0 +1,20 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |acute| unicode:: U+000B4 .. ACUTE ACCENT +.. |breve| unicode:: U+002D8 .. BREVE +.. |caron| unicode:: U+002C7 .. CARON +.. |cedil| unicode:: U+000B8 .. CEDILLA +.. |circ| unicode:: U+002C6 .. MODIFIER LETTER CIRCUMFLEX ACCENT +.. |dblac| unicode:: U+002DD .. DOUBLE ACUTE ACCENT +.. |die| unicode:: U+000A8 .. DIAERESIS +.. |dot| unicode:: U+002D9 .. DOT ABOVE +.. |grave| unicode:: U+00060 .. GRAVE ACCENT +.. |macr| unicode:: U+000AF .. MACRON +.. |ogon| unicode:: U+002DB .. OGONEK +.. |ring| unicode:: U+002DA .. RING ABOVE +.. |tilde| unicode:: U+002DC .. SMALL TILDE +.. |uml| unicode:: U+000A8 .. DIAERESIS diff --git a/aws/dist/docutils/parsers/rst/include/isogrk1.txt b/aws/dist/docutils/parsers/rst/include/isogrk1.txt new file mode 100644 index 00000000..434368a0 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isogrk1.txt @@ -0,0 +1,55 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Agr| unicode:: U+00391 .. GREEK CAPITAL LETTER ALPHA +.. |agr| unicode:: U+003B1 .. GREEK SMALL LETTER ALPHA +.. |Bgr| unicode:: U+00392 .. GREEK CAPITAL LETTER BETA +.. |bgr| unicode:: U+003B2 .. GREEK SMALL LETTER BETA +.. |Dgr| unicode:: U+00394 .. GREEK CAPITAL LETTER DELTA +.. |dgr| unicode:: U+003B4 .. GREEK SMALL LETTER DELTA +.. |EEgr| unicode:: U+00397 .. GREEK CAPITAL LETTER ETA +.. |eegr| unicode:: U+003B7 .. GREEK SMALL LETTER ETA +.. |Egr| unicode:: U+00395 .. GREEK CAPITAL LETTER EPSILON +.. |egr| unicode:: U+003B5 .. GREEK SMALL LETTER EPSILON +.. |Ggr| unicode:: U+00393 .. GREEK CAPITAL LETTER GAMMA +.. |ggr| unicode:: U+003B3 .. GREEK SMALL LETTER GAMMA +.. |Igr| unicode:: U+00399 .. GREEK CAPITAL LETTER IOTA +.. |igr| unicode:: U+003B9 .. GREEK SMALL LETTER IOTA +.. |Kgr| unicode:: U+0039A .. GREEK CAPITAL LETTER KAPPA +.. |kgr| unicode:: U+003BA .. GREEK SMALL LETTER KAPPA +.. |KHgr| unicode:: U+003A7 .. GREEK CAPITAL LETTER CHI +.. |khgr| unicode:: U+003C7 .. GREEK SMALL LETTER CHI +.. |Lgr| unicode:: U+0039B .. GREEK CAPITAL LETTER LAMDA +.. |lgr| unicode:: U+003BB .. GREEK SMALL LETTER LAMDA +.. |Mgr| unicode:: U+0039C .. GREEK CAPITAL LETTER MU +.. |mgr| unicode:: U+003BC .. GREEK SMALL LETTER MU +.. |Ngr| unicode:: U+0039D .. GREEK CAPITAL LETTER NU +.. |ngr| unicode:: U+003BD .. GREEK SMALL LETTER NU +.. |Ogr| unicode:: U+0039F .. GREEK CAPITAL LETTER OMICRON +.. |ogr| unicode:: U+003BF .. GREEK SMALL LETTER OMICRON +.. |OHgr| unicode:: U+003A9 .. GREEK CAPITAL LETTER OMEGA +.. |ohgr| unicode:: U+003C9 .. GREEK SMALL LETTER OMEGA +.. |Pgr| unicode:: U+003A0 .. GREEK CAPITAL LETTER PI +.. |pgr| unicode:: U+003C0 .. GREEK SMALL LETTER PI +.. |PHgr| unicode:: U+003A6 .. GREEK CAPITAL LETTER PHI +.. |phgr| unicode:: U+003C6 .. GREEK SMALL LETTER PHI +.. |PSgr| unicode:: U+003A8 .. GREEK CAPITAL LETTER PSI +.. |psgr| unicode:: U+003C8 .. GREEK SMALL LETTER PSI +.. |Rgr| unicode:: U+003A1 .. GREEK CAPITAL LETTER RHO +.. |rgr| unicode:: U+003C1 .. GREEK SMALL LETTER RHO +.. |sfgr| unicode:: U+003C2 .. GREEK SMALL LETTER FINAL SIGMA +.. |Sgr| unicode:: U+003A3 .. GREEK CAPITAL LETTER SIGMA +.. |sgr| unicode:: U+003C3 .. GREEK SMALL LETTER SIGMA +.. |Tgr| unicode:: U+003A4 .. GREEK CAPITAL LETTER TAU +.. |tgr| unicode:: U+003C4 .. GREEK SMALL LETTER TAU +.. |THgr| unicode:: U+00398 .. GREEK CAPITAL LETTER THETA +.. |thgr| unicode:: U+003B8 .. GREEK SMALL LETTER THETA +.. |Ugr| unicode:: U+003A5 .. GREEK CAPITAL LETTER UPSILON +.. |ugr| unicode:: U+003C5 .. GREEK SMALL LETTER UPSILON +.. |Xgr| unicode:: U+0039E .. GREEK CAPITAL LETTER XI +.. |xgr| unicode:: U+003BE .. GREEK SMALL LETTER XI +.. |Zgr| unicode:: U+00396 .. GREEK CAPITAL LETTER ZETA +.. |zgr| unicode:: U+003B6 .. GREEK SMALL LETTER ZETA diff --git a/aws/dist/docutils/parsers/rst/include/isogrk2.txt b/aws/dist/docutils/parsers/rst/include/isogrk2.txt new file mode 100644 index 00000000..fa59f968 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isogrk2.txt @@ -0,0 +1,26 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Aacgr| unicode:: U+00386 .. GREEK CAPITAL LETTER ALPHA WITH TONOS +.. |aacgr| unicode:: U+003AC .. GREEK SMALL LETTER ALPHA WITH TONOS +.. |Eacgr| unicode:: U+00388 .. GREEK CAPITAL LETTER EPSILON WITH TONOS +.. |eacgr| unicode:: U+003AD .. GREEK SMALL LETTER EPSILON WITH TONOS +.. |EEacgr| unicode:: U+00389 .. GREEK CAPITAL LETTER ETA WITH TONOS +.. |eeacgr| unicode:: U+003AE .. GREEK SMALL LETTER ETA WITH TONOS +.. |Iacgr| unicode:: U+0038A .. GREEK CAPITAL LETTER IOTA WITH TONOS +.. |iacgr| unicode:: U+003AF .. GREEK SMALL LETTER IOTA WITH TONOS +.. |idiagr| unicode:: U+00390 .. GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS +.. |Idigr| unicode:: U+003AA .. GREEK CAPITAL LETTER IOTA WITH DIALYTIKA +.. |idigr| unicode:: U+003CA .. GREEK SMALL LETTER IOTA WITH DIALYTIKA +.. |Oacgr| unicode:: U+0038C .. GREEK CAPITAL LETTER OMICRON WITH TONOS +.. |oacgr| unicode:: U+003CC .. GREEK SMALL LETTER OMICRON WITH TONOS +.. |OHacgr| unicode:: U+0038F .. GREEK CAPITAL LETTER OMEGA WITH TONOS +.. |ohacgr| unicode:: U+003CE .. GREEK SMALL LETTER OMEGA WITH TONOS +.. |Uacgr| unicode:: U+0038E .. GREEK CAPITAL LETTER UPSILON WITH TONOS +.. |uacgr| unicode:: U+003CD .. GREEK SMALL LETTER UPSILON WITH TONOS +.. |udiagr| unicode:: U+003B0 .. GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS +.. |Udigr| unicode:: U+003AB .. GREEK CAPITAL LETTER UPSILON WITH DIALYTIKA +.. |udigr| unicode:: U+003CB .. GREEK SMALL LETTER UPSILON WITH DIALYTIKA diff --git a/aws/dist/docutils/parsers/rst/include/isogrk3.txt b/aws/dist/docutils/parsers/rst/include/isogrk3.txt new file mode 100644 index 00000000..efacd980 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isogrk3.txt @@ -0,0 +1,52 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |alpha| unicode:: U+003B1 .. GREEK SMALL LETTER ALPHA +.. |beta| unicode:: U+003B2 .. GREEK SMALL LETTER BETA +.. |chi| unicode:: U+003C7 .. GREEK SMALL LETTER CHI +.. |Delta| unicode:: U+00394 .. GREEK CAPITAL LETTER DELTA +.. |delta| unicode:: U+003B4 .. GREEK SMALL LETTER DELTA +.. |epsi| unicode:: U+003F5 .. GREEK LUNATE EPSILON SYMBOL +.. |epsis| unicode:: U+003F5 .. GREEK LUNATE EPSILON SYMBOL +.. |epsiv| unicode:: U+003B5 .. GREEK SMALL LETTER EPSILON +.. |eta| unicode:: U+003B7 .. GREEK SMALL LETTER ETA +.. |Gamma| unicode:: U+00393 .. GREEK CAPITAL LETTER GAMMA +.. |gamma| unicode:: U+003B3 .. GREEK SMALL LETTER GAMMA +.. |Gammad| unicode:: U+003DC .. GREEK LETTER DIGAMMA +.. |gammad| unicode:: U+003DD .. GREEK SMALL LETTER DIGAMMA +.. |iota| unicode:: U+003B9 .. GREEK SMALL LETTER IOTA +.. |kappa| unicode:: U+003BA .. GREEK SMALL LETTER KAPPA +.. |kappav| unicode:: U+003F0 .. GREEK KAPPA SYMBOL +.. |Lambda| unicode:: U+0039B .. GREEK CAPITAL LETTER LAMDA +.. |lambda| unicode:: U+003BB .. GREEK SMALL LETTER LAMDA +.. |mu| unicode:: U+003BC .. GREEK SMALL LETTER MU +.. |nu| unicode:: U+003BD .. GREEK SMALL LETTER NU +.. |Omega| unicode:: U+003A9 .. GREEK CAPITAL LETTER OMEGA +.. |omega| unicode:: U+003C9 .. GREEK SMALL LETTER OMEGA +.. |Phi| unicode:: U+003A6 .. GREEK CAPITAL LETTER PHI +.. |phi| unicode:: U+003D5 .. GREEK PHI SYMBOL +.. |phis| unicode:: U+003D5 .. GREEK PHI SYMBOL +.. |phiv| unicode:: U+003C6 .. GREEK SMALL LETTER PHI +.. |Pi| unicode:: U+003A0 .. GREEK CAPITAL LETTER PI +.. |pi| unicode:: U+003C0 .. GREEK SMALL LETTER PI +.. |piv| unicode:: U+003D6 .. GREEK PI SYMBOL +.. |Psi| unicode:: U+003A8 .. GREEK CAPITAL LETTER PSI +.. |psi| unicode:: U+003C8 .. GREEK SMALL LETTER PSI +.. |rho| unicode:: U+003C1 .. GREEK SMALL LETTER RHO +.. |rhov| unicode:: U+003F1 .. GREEK RHO SYMBOL +.. |Sigma| unicode:: U+003A3 .. GREEK CAPITAL LETTER SIGMA +.. |sigma| unicode:: U+003C3 .. GREEK SMALL LETTER SIGMA +.. |sigmav| unicode:: U+003C2 .. GREEK SMALL LETTER FINAL SIGMA +.. |tau| unicode:: U+003C4 .. GREEK SMALL LETTER TAU +.. |Theta| unicode:: U+00398 .. GREEK CAPITAL LETTER THETA +.. |theta| unicode:: U+003B8 .. GREEK SMALL LETTER THETA +.. |thetas| unicode:: U+003B8 .. GREEK SMALL LETTER THETA +.. |thetav| unicode:: U+003D1 .. GREEK THETA SYMBOL +.. |Upsi| unicode:: U+003D2 .. GREEK UPSILON WITH HOOK SYMBOL +.. |upsi| unicode:: U+003C5 .. GREEK SMALL LETTER UPSILON +.. |Xi| unicode:: U+0039E .. GREEK CAPITAL LETTER XI +.. |xi| unicode:: U+003BE .. GREEK SMALL LETTER XI +.. |zeta| unicode:: U+003B6 .. GREEK SMALL LETTER ZETA diff --git a/aws/dist/docutils/parsers/rst/include/isogrk4-wide.txt b/aws/dist/docutils/parsers/rst/include/isogrk4-wide.txt new file mode 100644 index 00000000..39a63075 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isogrk4-wide.txt @@ -0,0 +1,49 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |b.alpha| unicode:: U+1D6C2 .. MATHEMATICAL BOLD SMALL ALPHA +.. |b.beta| unicode:: U+1D6C3 .. MATHEMATICAL BOLD SMALL BETA +.. |b.chi| unicode:: U+1D6D8 .. MATHEMATICAL BOLD SMALL CHI +.. |b.Delta| unicode:: U+1D6AB .. MATHEMATICAL BOLD CAPITAL DELTA +.. |b.delta| unicode:: U+1D6C5 .. MATHEMATICAL BOLD SMALL DELTA +.. |b.epsi| unicode:: U+1D6C6 .. MATHEMATICAL BOLD SMALL EPSILON +.. |b.epsiv| unicode:: U+1D6DC .. MATHEMATICAL BOLD EPSILON SYMBOL +.. |b.eta| unicode:: U+1D6C8 .. MATHEMATICAL BOLD SMALL ETA +.. |b.Gamma| unicode:: U+1D6AA .. MATHEMATICAL BOLD CAPITAL GAMMA +.. |b.gamma| unicode:: U+1D6C4 .. MATHEMATICAL BOLD SMALL GAMMA +.. |b.Gammad| unicode:: U+003DC .. GREEK LETTER DIGAMMA +.. |b.gammad| unicode:: U+003DD .. GREEK SMALL LETTER DIGAMMA +.. |b.iota| unicode:: U+1D6CA .. MATHEMATICAL BOLD SMALL IOTA +.. |b.kappa| unicode:: U+1D6CB .. MATHEMATICAL BOLD SMALL KAPPA +.. |b.kappav| unicode:: U+1D6DE .. MATHEMATICAL BOLD KAPPA SYMBOL +.. |b.Lambda| unicode:: U+1D6B2 .. MATHEMATICAL BOLD CAPITAL LAMDA +.. |b.lambda| unicode:: U+1D6CC .. MATHEMATICAL BOLD SMALL LAMDA +.. |b.mu| unicode:: U+1D6CD .. MATHEMATICAL BOLD SMALL MU +.. |b.nu| unicode:: U+1D6CE .. MATHEMATICAL BOLD SMALL NU +.. |b.Omega| unicode:: U+1D6C0 .. MATHEMATICAL BOLD CAPITAL OMEGA +.. |b.omega| unicode:: U+1D6DA .. MATHEMATICAL BOLD SMALL OMEGA +.. |b.Phi| unicode:: U+1D6BD .. MATHEMATICAL BOLD CAPITAL PHI +.. |b.phi| unicode:: U+1D6D7 .. MATHEMATICAL BOLD SMALL PHI +.. |b.phiv| unicode:: U+1D6DF .. MATHEMATICAL BOLD PHI SYMBOL +.. |b.Pi| unicode:: U+1D6B7 .. MATHEMATICAL BOLD CAPITAL PI +.. |b.pi| unicode:: U+1D6D1 .. MATHEMATICAL BOLD SMALL PI +.. |b.piv| unicode:: U+1D6E1 .. MATHEMATICAL BOLD PI SYMBOL +.. |b.Psi| unicode:: U+1D6BF .. MATHEMATICAL BOLD CAPITAL PSI +.. |b.psi| unicode:: U+1D6D9 .. MATHEMATICAL BOLD SMALL PSI +.. |b.rho| unicode:: U+1D6D2 .. MATHEMATICAL BOLD SMALL RHO +.. |b.rhov| unicode:: U+1D6E0 .. MATHEMATICAL BOLD RHO SYMBOL +.. |b.Sigma| unicode:: U+1D6BA .. MATHEMATICAL BOLD CAPITAL SIGMA +.. |b.sigma| unicode:: U+1D6D4 .. MATHEMATICAL BOLD SMALL SIGMA +.. |b.sigmav| unicode:: U+1D6D3 .. MATHEMATICAL BOLD SMALL FINAL SIGMA +.. |b.tau| unicode:: U+1D6D5 .. MATHEMATICAL BOLD SMALL TAU +.. |b.Theta| unicode:: U+1D6AF .. MATHEMATICAL BOLD CAPITAL THETA +.. |b.thetas| unicode:: U+1D6C9 .. MATHEMATICAL BOLD SMALL THETA +.. |b.thetav| unicode:: U+1D6DD .. MATHEMATICAL BOLD THETA SYMBOL +.. |b.Upsi| unicode:: U+1D6BC .. MATHEMATICAL BOLD CAPITAL UPSILON +.. |b.upsi| unicode:: U+1D6D6 .. MATHEMATICAL BOLD SMALL UPSILON +.. |b.Xi| unicode:: U+1D6B5 .. MATHEMATICAL BOLD CAPITAL XI +.. |b.xi| unicode:: U+1D6CF .. MATHEMATICAL BOLD SMALL XI +.. |b.zeta| unicode:: U+1D6C7 .. MATHEMATICAL BOLD SMALL ZETA diff --git a/aws/dist/docutils/parsers/rst/include/isogrk4.txt b/aws/dist/docutils/parsers/rst/include/isogrk4.txt new file mode 100644 index 00000000..5b9f4104 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isogrk4.txt @@ -0,0 +1,8 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |b.Gammad| unicode:: U+003DC .. GREEK LETTER DIGAMMA +.. |b.gammad| unicode:: U+003DD .. GREEK SMALL LETTER DIGAMMA diff --git a/aws/dist/docutils/parsers/rst/include/isolat1.txt b/aws/dist/docutils/parsers/rst/include/isolat1.txt new file mode 100644 index 00000000..3e9ad9df --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isolat1.txt @@ -0,0 +1,68 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Aacute| unicode:: U+000C1 .. LATIN CAPITAL LETTER A WITH ACUTE +.. |aacute| unicode:: U+000E1 .. LATIN SMALL LETTER A WITH ACUTE +.. |Acirc| unicode:: U+000C2 .. LATIN CAPITAL LETTER A WITH CIRCUMFLEX +.. |acirc| unicode:: U+000E2 .. LATIN SMALL LETTER A WITH CIRCUMFLEX +.. |AElig| unicode:: U+000C6 .. LATIN CAPITAL LETTER AE +.. |aelig| unicode:: U+000E6 .. LATIN SMALL LETTER AE +.. |Agrave| unicode:: U+000C0 .. LATIN CAPITAL LETTER A WITH GRAVE +.. |agrave| unicode:: U+000E0 .. LATIN SMALL LETTER A WITH GRAVE +.. |Aring| unicode:: U+000C5 .. LATIN CAPITAL LETTER A WITH RING ABOVE +.. |aring| unicode:: U+000E5 .. LATIN SMALL LETTER A WITH RING ABOVE +.. |Atilde| unicode:: U+000C3 .. LATIN CAPITAL LETTER A WITH TILDE +.. |atilde| unicode:: U+000E3 .. LATIN SMALL LETTER A WITH TILDE +.. |Auml| unicode:: U+000C4 .. LATIN CAPITAL LETTER A WITH DIAERESIS +.. |auml| unicode:: U+000E4 .. LATIN SMALL LETTER A WITH DIAERESIS +.. |Ccedil| unicode:: U+000C7 .. LATIN CAPITAL LETTER C WITH CEDILLA +.. |ccedil| unicode:: U+000E7 .. LATIN SMALL LETTER C WITH CEDILLA +.. |Eacute| unicode:: U+000C9 .. LATIN CAPITAL LETTER E WITH ACUTE +.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE +.. |Ecirc| unicode:: U+000CA .. LATIN CAPITAL LETTER E WITH CIRCUMFLEX +.. |ecirc| unicode:: U+000EA .. LATIN SMALL LETTER E WITH CIRCUMFLEX +.. |Egrave| unicode:: U+000C8 .. LATIN CAPITAL LETTER E WITH GRAVE +.. |egrave| unicode:: U+000E8 .. LATIN SMALL LETTER E WITH GRAVE +.. |ETH| unicode:: U+000D0 .. LATIN CAPITAL LETTER ETH +.. |eth| unicode:: U+000F0 .. LATIN SMALL LETTER ETH +.. |Euml| unicode:: U+000CB .. LATIN CAPITAL LETTER E WITH DIAERESIS +.. |euml| unicode:: U+000EB .. LATIN SMALL LETTER E WITH DIAERESIS +.. |Iacute| unicode:: U+000CD .. LATIN CAPITAL LETTER I WITH ACUTE +.. |iacute| unicode:: U+000ED .. LATIN SMALL LETTER I WITH ACUTE +.. |Icirc| unicode:: U+000CE .. LATIN CAPITAL LETTER I WITH CIRCUMFLEX +.. |icirc| unicode:: U+000EE .. LATIN SMALL LETTER I WITH CIRCUMFLEX +.. |Igrave| unicode:: U+000CC .. LATIN CAPITAL LETTER I WITH GRAVE +.. |igrave| unicode:: U+000EC .. LATIN SMALL LETTER I WITH GRAVE +.. |Iuml| unicode:: U+000CF .. LATIN CAPITAL LETTER I WITH DIAERESIS +.. |iuml| unicode:: U+000EF .. LATIN SMALL LETTER I WITH DIAERESIS +.. |Ntilde| unicode:: U+000D1 .. LATIN CAPITAL LETTER N WITH TILDE +.. |ntilde| unicode:: U+000F1 .. LATIN SMALL LETTER N WITH TILDE +.. |Oacute| unicode:: U+000D3 .. LATIN CAPITAL LETTER O WITH ACUTE +.. |oacute| unicode:: U+000F3 .. LATIN SMALL LETTER O WITH ACUTE +.. |Ocirc| unicode:: U+000D4 .. LATIN CAPITAL LETTER O WITH CIRCUMFLEX +.. |ocirc| unicode:: U+000F4 .. LATIN SMALL LETTER O WITH CIRCUMFLEX +.. |Ograve| unicode:: U+000D2 .. LATIN CAPITAL LETTER O WITH GRAVE +.. |ograve| unicode:: U+000F2 .. LATIN SMALL LETTER O WITH GRAVE +.. |Oslash| unicode:: U+000D8 .. LATIN CAPITAL LETTER O WITH STROKE +.. |oslash| unicode:: U+000F8 .. LATIN SMALL LETTER O WITH STROKE +.. |Otilde| unicode:: U+000D5 .. LATIN CAPITAL LETTER O WITH TILDE +.. |otilde| unicode:: U+000F5 .. LATIN SMALL LETTER O WITH TILDE +.. |Ouml| unicode:: U+000D6 .. LATIN CAPITAL LETTER O WITH DIAERESIS +.. |ouml| unicode:: U+000F6 .. LATIN SMALL LETTER O WITH DIAERESIS +.. |szlig| unicode:: U+000DF .. LATIN SMALL LETTER SHARP S +.. |THORN| unicode:: U+000DE .. LATIN CAPITAL LETTER THORN +.. |thorn| unicode:: U+000FE .. LATIN SMALL LETTER THORN +.. |Uacute| unicode:: U+000DA .. LATIN CAPITAL LETTER U WITH ACUTE +.. |uacute| unicode:: U+000FA .. LATIN SMALL LETTER U WITH ACUTE +.. |Ucirc| unicode:: U+000DB .. LATIN CAPITAL LETTER U WITH CIRCUMFLEX +.. |ucirc| unicode:: U+000FB .. LATIN SMALL LETTER U WITH CIRCUMFLEX +.. |Ugrave| unicode:: U+000D9 .. LATIN CAPITAL LETTER U WITH GRAVE +.. |ugrave| unicode:: U+000F9 .. LATIN SMALL LETTER U WITH GRAVE +.. |Uuml| unicode:: U+000DC .. LATIN CAPITAL LETTER U WITH DIAERESIS +.. |uuml| unicode:: U+000FC .. LATIN SMALL LETTER U WITH DIAERESIS +.. |Yacute| unicode:: U+000DD .. LATIN CAPITAL LETTER Y WITH ACUTE +.. |yacute| unicode:: U+000FD .. LATIN SMALL LETTER Y WITH ACUTE +.. |yuml| unicode:: U+000FF .. LATIN SMALL LETTER Y WITH DIAERESIS diff --git a/aws/dist/docutils/parsers/rst/include/isolat2.txt b/aws/dist/docutils/parsers/rst/include/isolat2.txt new file mode 100644 index 00000000..20de8457 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isolat2.txt @@ -0,0 +1,128 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Abreve| unicode:: U+00102 .. LATIN CAPITAL LETTER A WITH BREVE +.. |abreve| unicode:: U+00103 .. LATIN SMALL LETTER A WITH BREVE +.. |Amacr| unicode:: U+00100 .. LATIN CAPITAL LETTER A WITH MACRON +.. |amacr| unicode:: U+00101 .. LATIN SMALL LETTER A WITH MACRON +.. |Aogon| unicode:: U+00104 .. LATIN CAPITAL LETTER A WITH OGONEK +.. |aogon| unicode:: U+00105 .. LATIN SMALL LETTER A WITH OGONEK +.. |Cacute| unicode:: U+00106 .. LATIN CAPITAL LETTER C WITH ACUTE +.. |cacute| unicode:: U+00107 .. LATIN SMALL LETTER C WITH ACUTE +.. |Ccaron| unicode:: U+0010C .. LATIN CAPITAL LETTER C WITH CARON +.. |ccaron| unicode:: U+0010D .. LATIN SMALL LETTER C WITH CARON +.. |Ccirc| unicode:: U+00108 .. LATIN CAPITAL LETTER C WITH CIRCUMFLEX +.. |ccirc| unicode:: U+00109 .. LATIN SMALL LETTER C WITH CIRCUMFLEX +.. |Cdot| unicode:: U+0010A .. LATIN CAPITAL LETTER C WITH DOT ABOVE +.. |cdot| unicode:: U+0010B .. LATIN SMALL LETTER C WITH DOT ABOVE +.. |Dcaron| unicode:: U+0010E .. LATIN CAPITAL LETTER D WITH CARON +.. |dcaron| unicode:: U+0010F .. LATIN SMALL LETTER D WITH CARON +.. |Dstrok| unicode:: U+00110 .. LATIN CAPITAL LETTER D WITH STROKE +.. |dstrok| unicode:: U+00111 .. LATIN SMALL LETTER D WITH STROKE +.. |Ecaron| unicode:: U+0011A .. LATIN CAPITAL LETTER E WITH CARON +.. |ecaron| unicode:: U+0011B .. LATIN SMALL LETTER E WITH CARON +.. |Edot| unicode:: U+00116 .. LATIN CAPITAL LETTER E WITH DOT ABOVE +.. |edot| unicode:: U+00117 .. LATIN SMALL LETTER E WITH DOT ABOVE +.. |Emacr| unicode:: U+00112 .. LATIN CAPITAL LETTER E WITH MACRON +.. |emacr| unicode:: U+00113 .. LATIN SMALL LETTER E WITH MACRON +.. |ENG| unicode:: U+0014A .. LATIN CAPITAL LETTER ENG +.. |eng| unicode:: U+0014B .. LATIN SMALL LETTER ENG +.. |Eogon| unicode:: U+00118 .. LATIN CAPITAL LETTER E WITH OGONEK +.. |eogon| unicode:: U+00119 .. LATIN SMALL LETTER E WITH OGONEK +.. |gacute| unicode:: U+001F5 .. LATIN SMALL LETTER G WITH ACUTE +.. |Gbreve| unicode:: U+0011E .. LATIN CAPITAL LETTER G WITH BREVE +.. |gbreve| unicode:: U+0011F .. LATIN SMALL LETTER G WITH BREVE +.. |Gcedil| unicode:: U+00122 .. LATIN CAPITAL LETTER G WITH CEDILLA +.. |gcedil| unicode:: U+00123 .. LATIN SMALL LETTER G WITH CEDILLA +.. |Gcirc| unicode:: U+0011C .. LATIN CAPITAL LETTER G WITH CIRCUMFLEX +.. |gcirc| unicode:: U+0011D .. LATIN SMALL LETTER G WITH CIRCUMFLEX +.. |Gdot| unicode:: U+00120 .. LATIN CAPITAL LETTER G WITH DOT ABOVE +.. |gdot| unicode:: U+00121 .. LATIN SMALL LETTER G WITH DOT ABOVE +.. |Hcirc| unicode:: U+00124 .. LATIN CAPITAL LETTER H WITH CIRCUMFLEX +.. |hcirc| unicode:: U+00125 .. LATIN SMALL LETTER H WITH CIRCUMFLEX +.. |Hstrok| unicode:: U+00126 .. LATIN CAPITAL LETTER H WITH STROKE +.. |hstrok| unicode:: U+00127 .. LATIN SMALL LETTER H WITH STROKE +.. |Idot| unicode:: U+00130 .. LATIN CAPITAL LETTER I WITH DOT ABOVE +.. |IJlig| unicode:: U+00132 .. LATIN CAPITAL LIGATURE IJ +.. |ijlig| unicode:: U+00133 .. LATIN SMALL LIGATURE IJ +.. |Imacr| unicode:: U+0012A .. LATIN CAPITAL LETTER I WITH MACRON +.. |imacr| unicode:: U+0012B .. LATIN SMALL LETTER I WITH MACRON +.. |inodot| unicode:: U+00131 .. LATIN SMALL LETTER DOTLESS I +.. |Iogon| unicode:: U+0012E .. LATIN CAPITAL LETTER I WITH OGONEK +.. |iogon| unicode:: U+0012F .. LATIN SMALL LETTER I WITH OGONEK +.. |Itilde| unicode:: U+00128 .. LATIN CAPITAL LETTER I WITH TILDE +.. |itilde| unicode:: U+00129 .. LATIN SMALL LETTER I WITH TILDE +.. |Jcirc| unicode:: U+00134 .. LATIN CAPITAL LETTER J WITH CIRCUMFLEX +.. |jcirc| unicode:: U+00135 .. LATIN SMALL LETTER J WITH CIRCUMFLEX +.. |Kcedil| unicode:: U+00136 .. LATIN CAPITAL LETTER K WITH CEDILLA +.. |kcedil| unicode:: U+00137 .. LATIN SMALL LETTER K WITH CEDILLA +.. |kgreen| unicode:: U+00138 .. LATIN SMALL LETTER KRA +.. |Lacute| unicode:: U+00139 .. LATIN CAPITAL LETTER L WITH ACUTE +.. |lacute| unicode:: U+0013A .. LATIN SMALL LETTER L WITH ACUTE +.. |Lcaron| unicode:: U+0013D .. LATIN CAPITAL LETTER L WITH CARON +.. |lcaron| unicode:: U+0013E .. LATIN SMALL LETTER L WITH CARON +.. |Lcedil| unicode:: U+0013B .. LATIN CAPITAL LETTER L WITH CEDILLA +.. |lcedil| unicode:: U+0013C .. LATIN SMALL LETTER L WITH CEDILLA +.. |Lmidot| unicode:: U+0013F .. LATIN CAPITAL LETTER L WITH MIDDLE DOT +.. |lmidot| unicode:: U+00140 .. LATIN SMALL LETTER L WITH MIDDLE DOT +.. |Lstrok| unicode:: U+00141 .. LATIN CAPITAL LETTER L WITH STROKE +.. |lstrok| unicode:: U+00142 .. LATIN SMALL LETTER L WITH STROKE +.. |Nacute| unicode:: U+00143 .. LATIN CAPITAL LETTER N WITH ACUTE +.. |nacute| unicode:: U+00144 .. LATIN SMALL LETTER N WITH ACUTE +.. |napos| unicode:: U+00149 .. LATIN SMALL LETTER N PRECEDED BY APOSTROPHE +.. |Ncaron| unicode:: U+00147 .. LATIN CAPITAL LETTER N WITH CARON +.. |ncaron| unicode:: U+00148 .. LATIN SMALL LETTER N WITH CARON +.. |Ncedil| unicode:: U+00145 .. LATIN CAPITAL LETTER N WITH CEDILLA +.. |ncedil| unicode:: U+00146 .. LATIN SMALL LETTER N WITH CEDILLA +.. |Odblac| unicode:: U+00150 .. LATIN CAPITAL LETTER O WITH DOUBLE ACUTE +.. |odblac| unicode:: U+00151 .. LATIN SMALL LETTER O WITH DOUBLE ACUTE +.. |OElig| unicode:: U+00152 .. LATIN CAPITAL LIGATURE OE +.. |oelig| unicode:: U+00153 .. LATIN SMALL LIGATURE OE +.. |Omacr| unicode:: U+0014C .. LATIN CAPITAL LETTER O WITH MACRON +.. |omacr| unicode:: U+0014D .. LATIN SMALL LETTER O WITH MACRON +.. |Racute| unicode:: U+00154 .. LATIN CAPITAL LETTER R WITH ACUTE +.. |racute| unicode:: U+00155 .. LATIN SMALL LETTER R WITH ACUTE +.. |Rcaron| unicode:: U+00158 .. LATIN CAPITAL LETTER R WITH CARON +.. |rcaron| unicode:: U+00159 .. LATIN SMALL LETTER R WITH CARON +.. |Rcedil| unicode:: U+00156 .. LATIN CAPITAL LETTER R WITH CEDILLA +.. |rcedil| unicode:: U+00157 .. LATIN SMALL LETTER R WITH CEDILLA +.. |Sacute| unicode:: U+0015A .. LATIN CAPITAL LETTER S WITH ACUTE +.. |sacute| unicode:: U+0015B .. LATIN SMALL LETTER S WITH ACUTE +.. |Scaron| unicode:: U+00160 .. LATIN CAPITAL LETTER S WITH CARON +.. |scaron| unicode:: U+00161 .. LATIN SMALL LETTER S WITH CARON +.. |Scedil| unicode:: U+0015E .. LATIN CAPITAL LETTER S WITH CEDILLA +.. |scedil| unicode:: U+0015F .. LATIN SMALL LETTER S WITH CEDILLA +.. |Scirc| unicode:: U+0015C .. LATIN CAPITAL LETTER S WITH CIRCUMFLEX +.. |scirc| unicode:: U+0015D .. LATIN SMALL LETTER S WITH CIRCUMFLEX +.. |Tcaron| unicode:: U+00164 .. LATIN CAPITAL LETTER T WITH CARON +.. |tcaron| unicode:: U+00165 .. LATIN SMALL LETTER T WITH CARON +.. |Tcedil| unicode:: U+00162 .. LATIN CAPITAL LETTER T WITH CEDILLA +.. |tcedil| unicode:: U+00163 .. LATIN SMALL LETTER T WITH CEDILLA +.. |Tstrok| unicode:: U+00166 .. LATIN CAPITAL LETTER T WITH STROKE +.. |tstrok| unicode:: U+00167 .. LATIN SMALL LETTER T WITH STROKE +.. |Ubreve| unicode:: U+0016C .. LATIN CAPITAL LETTER U WITH BREVE +.. |ubreve| unicode:: U+0016D .. LATIN SMALL LETTER U WITH BREVE +.. |Udblac| unicode:: U+00170 .. LATIN CAPITAL LETTER U WITH DOUBLE ACUTE +.. |udblac| unicode:: U+00171 .. LATIN SMALL LETTER U WITH DOUBLE ACUTE +.. |Umacr| unicode:: U+0016A .. LATIN CAPITAL LETTER U WITH MACRON +.. |umacr| unicode:: U+0016B .. LATIN SMALL LETTER U WITH MACRON +.. |Uogon| unicode:: U+00172 .. LATIN CAPITAL LETTER U WITH OGONEK +.. |uogon| unicode:: U+00173 .. LATIN SMALL LETTER U WITH OGONEK +.. |Uring| unicode:: U+0016E .. LATIN CAPITAL LETTER U WITH RING ABOVE +.. |uring| unicode:: U+0016F .. LATIN SMALL LETTER U WITH RING ABOVE +.. |Utilde| unicode:: U+00168 .. LATIN CAPITAL LETTER U WITH TILDE +.. |utilde| unicode:: U+00169 .. LATIN SMALL LETTER U WITH TILDE +.. |Wcirc| unicode:: U+00174 .. LATIN CAPITAL LETTER W WITH CIRCUMFLEX +.. |wcirc| unicode:: U+00175 .. LATIN SMALL LETTER W WITH CIRCUMFLEX +.. |Ycirc| unicode:: U+00176 .. LATIN CAPITAL LETTER Y WITH CIRCUMFLEX +.. |ycirc| unicode:: U+00177 .. LATIN SMALL LETTER Y WITH CIRCUMFLEX +.. |Yuml| unicode:: U+00178 .. LATIN CAPITAL LETTER Y WITH DIAERESIS +.. |Zacute| unicode:: U+00179 .. LATIN CAPITAL LETTER Z WITH ACUTE +.. |zacute| unicode:: U+0017A .. LATIN SMALL LETTER Z WITH ACUTE +.. |Zcaron| unicode:: U+0017D .. LATIN CAPITAL LETTER Z WITH CARON +.. |zcaron| unicode:: U+0017E .. LATIN SMALL LETTER Z WITH CARON +.. |Zdot| unicode:: U+0017B .. LATIN CAPITAL LETTER Z WITH DOT ABOVE +.. |zdot| unicode:: U+0017C .. LATIN SMALL LETTER Z WITH DOT ABOVE diff --git a/aws/dist/docutils/parsers/rst/include/isomfrk-wide.txt b/aws/dist/docutils/parsers/rst/include/isomfrk-wide.txt new file mode 100644 index 00000000..75bba257 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomfrk-wide.txt @@ -0,0 +1,58 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Afr| unicode:: U+1D504 .. MATHEMATICAL FRAKTUR CAPITAL A +.. |afr| unicode:: U+1D51E .. MATHEMATICAL FRAKTUR SMALL A +.. |Bfr| unicode:: U+1D505 .. MATHEMATICAL FRAKTUR CAPITAL B +.. |bfr| unicode:: U+1D51F .. MATHEMATICAL FRAKTUR SMALL B +.. |Cfr| unicode:: U+0212D .. BLACK-LETTER CAPITAL C +.. |cfr| unicode:: U+1D520 .. MATHEMATICAL FRAKTUR SMALL C +.. |Dfr| unicode:: U+1D507 .. MATHEMATICAL FRAKTUR CAPITAL D +.. |dfr| unicode:: U+1D521 .. MATHEMATICAL FRAKTUR SMALL D +.. |Efr| unicode:: U+1D508 .. MATHEMATICAL FRAKTUR CAPITAL E +.. |efr| unicode:: U+1D522 .. MATHEMATICAL FRAKTUR SMALL E +.. |Ffr| unicode:: U+1D509 .. MATHEMATICAL FRAKTUR CAPITAL F +.. |ffr| unicode:: U+1D523 .. MATHEMATICAL FRAKTUR SMALL F +.. |Gfr| unicode:: U+1D50A .. MATHEMATICAL FRAKTUR CAPITAL G +.. |gfr| unicode:: U+1D524 .. MATHEMATICAL FRAKTUR SMALL G +.. |Hfr| unicode:: U+0210C .. BLACK-LETTER CAPITAL H +.. |hfr| unicode:: U+1D525 .. MATHEMATICAL FRAKTUR SMALL H +.. |Ifr| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |ifr| unicode:: U+1D526 .. MATHEMATICAL FRAKTUR SMALL I +.. |Jfr| unicode:: U+1D50D .. MATHEMATICAL FRAKTUR CAPITAL J +.. |jfr| unicode:: U+1D527 .. MATHEMATICAL FRAKTUR SMALL J +.. |Kfr| unicode:: U+1D50E .. MATHEMATICAL FRAKTUR CAPITAL K +.. |kfr| unicode:: U+1D528 .. MATHEMATICAL FRAKTUR SMALL K +.. |Lfr| unicode:: U+1D50F .. MATHEMATICAL FRAKTUR CAPITAL L +.. |lfr| unicode:: U+1D529 .. MATHEMATICAL FRAKTUR SMALL L +.. |Mfr| unicode:: U+1D510 .. MATHEMATICAL FRAKTUR CAPITAL M +.. |mfr| unicode:: U+1D52A .. MATHEMATICAL FRAKTUR SMALL M +.. |Nfr| unicode:: U+1D511 .. MATHEMATICAL FRAKTUR CAPITAL N +.. |nfr| unicode:: U+1D52B .. MATHEMATICAL FRAKTUR SMALL N +.. |Ofr| unicode:: U+1D512 .. MATHEMATICAL FRAKTUR CAPITAL O +.. |ofr| unicode:: U+1D52C .. MATHEMATICAL FRAKTUR SMALL O +.. |Pfr| unicode:: U+1D513 .. MATHEMATICAL FRAKTUR CAPITAL P +.. |pfr| unicode:: U+1D52D .. MATHEMATICAL FRAKTUR SMALL P +.. |Qfr| unicode:: U+1D514 .. MATHEMATICAL FRAKTUR CAPITAL Q +.. |qfr| unicode:: U+1D52E .. MATHEMATICAL FRAKTUR SMALL Q +.. |Rfr| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |rfr| unicode:: U+1D52F .. MATHEMATICAL FRAKTUR SMALL R +.. |Sfr| unicode:: U+1D516 .. MATHEMATICAL FRAKTUR CAPITAL S +.. |sfr| unicode:: U+1D530 .. MATHEMATICAL FRAKTUR SMALL S +.. |Tfr| unicode:: U+1D517 .. MATHEMATICAL FRAKTUR CAPITAL T +.. |tfr| unicode:: U+1D531 .. MATHEMATICAL FRAKTUR SMALL T +.. |Ufr| unicode:: U+1D518 .. MATHEMATICAL FRAKTUR CAPITAL U +.. |ufr| unicode:: U+1D532 .. MATHEMATICAL FRAKTUR SMALL U +.. |Vfr| unicode:: U+1D519 .. MATHEMATICAL FRAKTUR CAPITAL V +.. |vfr| unicode:: U+1D533 .. MATHEMATICAL FRAKTUR SMALL V +.. |Wfr| unicode:: U+1D51A .. MATHEMATICAL FRAKTUR CAPITAL W +.. |wfr| unicode:: U+1D534 .. MATHEMATICAL FRAKTUR SMALL W +.. |Xfr| unicode:: U+1D51B .. MATHEMATICAL FRAKTUR CAPITAL X +.. |xfr| unicode:: U+1D535 .. MATHEMATICAL FRAKTUR SMALL X +.. |Yfr| unicode:: U+1D51C .. MATHEMATICAL FRAKTUR CAPITAL Y +.. |yfr| unicode:: U+1D536 .. MATHEMATICAL FRAKTUR SMALL Y +.. |Zfr| unicode:: U+02128 .. BLACK-LETTER CAPITAL Z +.. |zfr| unicode:: U+1D537 .. MATHEMATICAL FRAKTUR SMALL Z diff --git a/aws/dist/docutils/parsers/rst/include/isomfrk.txt b/aws/dist/docutils/parsers/rst/include/isomfrk.txt new file mode 100644 index 00000000..868b687a --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomfrk.txt @@ -0,0 +1,11 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Cfr| unicode:: U+0212D .. BLACK-LETTER CAPITAL C +.. |Hfr| unicode:: U+0210C .. BLACK-LETTER CAPITAL H +.. |Ifr| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |Rfr| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |Zfr| unicode:: U+02128 .. BLACK-LETTER CAPITAL Z diff --git a/aws/dist/docutils/parsers/rst/include/isomopf-wide.txt b/aws/dist/docutils/parsers/rst/include/isomopf-wide.txt new file mode 100644 index 00000000..a91ea43e --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomopf-wide.txt @@ -0,0 +1,32 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Aopf| unicode:: U+1D538 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL A +.. |Bopf| unicode:: U+1D539 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL B +.. |Copf| unicode:: U+02102 .. DOUBLE-STRUCK CAPITAL C +.. |Dopf| unicode:: U+1D53B .. MATHEMATICAL DOUBLE-STRUCK CAPITAL D +.. |Eopf| unicode:: U+1D53C .. MATHEMATICAL DOUBLE-STRUCK CAPITAL E +.. |Fopf| unicode:: U+1D53D .. MATHEMATICAL DOUBLE-STRUCK CAPITAL F +.. |Gopf| unicode:: U+1D53E .. MATHEMATICAL DOUBLE-STRUCK CAPITAL G +.. |Hopf| unicode:: U+0210D .. DOUBLE-STRUCK CAPITAL H +.. |Iopf| unicode:: U+1D540 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL I +.. |Jopf| unicode:: U+1D541 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL J +.. |Kopf| unicode:: U+1D542 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL K +.. |Lopf| unicode:: U+1D543 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL L +.. |Mopf| unicode:: U+1D544 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL M +.. |Nopf| unicode:: U+02115 .. DOUBLE-STRUCK CAPITAL N +.. |Oopf| unicode:: U+1D546 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL O +.. |Popf| unicode:: U+02119 .. DOUBLE-STRUCK CAPITAL P +.. |Qopf| unicode:: U+0211A .. DOUBLE-STRUCK CAPITAL Q +.. |Ropf| unicode:: U+0211D .. DOUBLE-STRUCK CAPITAL R +.. |Sopf| unicode:: U+1D54A .. MATHEMATICAL DOUBLE-STRUCK CAPITAL S +.. |Topf| unicode:: U+1D54B .. MATHEMATICAL DOUBLE-STRUCK CAPITAL T +.. |Uopf| unicode:: U+1D54C .. MATHEMATICAL DOUBLE-STRUCK CAPITAL U +.. |Vopf| unicode:: U+1D54D .. MATHEMATICAL DOUBLE-STRUCK CAPITAL V +.. |Wopf| unicode:: U+1D54E .. MATHEMATICAL DOUBLE-STRUCK CAPITAL W +.. |Xopf| unicode:: U+1D54F .. MATHEMATICAL DOUBLE-STRUCK CAPITAL X +.. |Yopf| unicode:: U+1D550 .. MATHEMATICAL DOUBLE-STRUCK CAPITAL Y +.. |Zopf| unicode:: U+02124 .. DOUBLE-STRUCK CAPITAL Z diff --git a/aws/dist/docutils/parsers/rst/include/isomopf.txt b/aws/dist/docutils/parsers/rst/include/isomopf.txt new file mode 100644 index 00000000..4350db61 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomopf.txt @@ -0,0 +1,13 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Copf| unicode:: U+02102 .. DOUBLE-STRUCK CAPITAL C +.. |Hopf| unicode:: U+0210D .. DOUBLE-STRUCK CAPITAL H +.. |Nopf| unicode:: U+02115 .. DOUBLE-STRUCK CAPITAL N +.. |Popf| unicode:: U+02119 .. DOUBLE-STRUCK CAPITAL P +.. |Qopf| unicode:: U+0211A .. DOUBLE-STRUCK CAPITAL Q +.. |Ropf| unicode:: U+0211D .. DOUBLE-STRUCK CAPITAL R +.. |Zopf| unicode:: U+02124 .. DOUBLE-STRUCK CAPITAL Z diff --git a/aws/dist/docutils/parsers/rst/include/isomscr-wide.txt b/aws/dist/docutils/parsers/rst/include/isomscr-wide.txt new file mode 100644 index 00000000..34b278b9 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomscr-wide.txt @@ -0,0 +1,58 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Ascr| unicode:: U+1D49C .. MATHEMATICAL SCRIPT CAPITAL A +.. |ascr| unicode:: U+1D4B6 .. MATHEMATICAL SCRIPT SMALL A +.. |Bscr| unicode:: U+0212C .. SCRIPT CAPITAL B +.. |bscr| unicode:: U+1D4B7 .. MATHEMATICAL SCRIPT SMALL B +.. |Cscr| unicode:: U+1D49E .. MATHEMATICAL SCRIPT CAPITAL C +.. |cscr| unicode:: U+1D4B8 .. MATHEMATICAL SCRIPT SMALL C +.. |Dscr| unicode:: U+1D49F .. MATHEMATICAL SCRIPT CAPITAL D +.. |dscr| unicode:: U+1D4B9 .. MATHEMATICAL SCRIPT SMALL D +.. |Escr| unicode:: U+02130 .. SCRIPT CAPITAL E +.. |escr| unicode:: U+0212F .. SCRIPT SMALL E +.. |Fscr| unicode:: U+02131 .. SCRIPT CAPITAL F +.. |fscr| unicode:: U+1D4BB .. MATHEMATICAL SCRIPT SMALL F +.. |Gscr| unicode:: U+1D4A2 .. MATHEMATICAL SCRIPT CAPITAL G +.. |gscr| unicode:: U+0210A .. SCRIPT SMALL G +.. |Hscr| unicode:: U+0210B .. SCRIPT CAPITAL H +.. |hscr| unicode:: U+1D4BD .. MATHEMATICAL SCRIPT SMALL H +.. |Iscr| unicode:: U+02110 .. SCRIPT CAPITAL I +.. |iscr| unicode:: U+1D4BE .. MATHEMATICAL SCRIPT SMALL I +.. |Jscr| unicode:: U+1D4A5 .. MATHEMATICAL SCRIPT CAPITAL J +.. |jscr| unicode:: U+1D4BF .. MATHEMATICAL SCRIPT SMALL J +.. |Kscr| unicode:: U+1D4A6 .. MATHEMATICAL SCRIPT CAPITAL K +.. |kscr| unicode:: U+1D4C0 .. MATHEMATICAL SCRIPT SMALL K +.. |Lscr| unicode:: U+02112 .. SCRIPT CAPITAL L +.. |lscr| unicode:: U+1D4C1 .. MATHEMATICAL SCRIPT SMALL L +.. |Mscr| unicode:: U+02133 .. SCRIPT CAPITAL M +.. |mscr| unicode:: U+1D4C2 .. MATHEMATICAL SCRIPT SMALL M +.. |Nscr| unicode:: U+1D4A9 .. MATHEMATICAL SCRIPT CAPITAL N +.. |nscr| unicode:: U+1D4C3 .. MATHEMATICAL SCRIPT SMALL N +.. |Oscr| unicode:: U+1D4AA .. MATHEMATICAL SCRIPT CAPITAL O +.. |oscr| unicode:: U+02134 .. SCRIPT SMALL O +.. |Pscr| unicode:: U+1D4AB .. MATHEMATICAL SCRIPT CAPITAL P +.. |pscr| unicode:: U+1D4C5 .. MATHEMATICAL SCRIPT SMALL P +.. |Qscr| unicode:: U+1D4AC .. MATHEMATICAL SCRIPT CAPITAL Q +.. |qscr| unicode:: U+1D4C6 .. MATHEMATICAL SCRIPT SMALL Q +.. |Rscr| unicode:: U+0211B .. SCRIPT CAPITAL R +.. |rscr| unicode:: U+1D4C7 .. MATHEMATICAL SCRIPT SMALL R +.. |Sscr| unicode:: U+1D4AE .. MATHEMATICAL SCRIPT CAPITAL S +.. |sscr| unicode:: U+1D4C8 .. MATHEMATICAL SCRIPT SMALL S +.. |Tscr| unicode:: U+1D4AF .. MATHEMATICAL SCRIPT CAPITAL T +.. |tscr| unicode:: U+1D4C9 .. MATHEMATICAL SCRIPT SMALL T +.. |Uscr| unicode:: U+1D4B0 .. MATHEMATICAL SCRIPT CAPITAL U +.. |uscr| unicode:: U+1D4CA .. MATHEMATICAL SCRIPT SMALL U +.. |Vscr| unicode:: U+1D4B1 .. MATHEMATICAL SCRIPT CAPITAL V +.. |vscr| unicode:: U+1D4CB .. MATHEMATICAL SCRIPT SMALL V +.. |Wscr| unicode:: U+1D4B2 .. MATHEMATICAL SCRIPT CAPITAL W +.. |wscr| unicode:: U+1D4CC .. MATHEMATICAL SCRIPT SMALL W +.. |Xscr| unicode:: U+1D4B3 .. MATHEMATICAL SCRIPT CAPITAL X +.. |xscr| unicode:: U+1D4CD .. MATHEMATICAL SCRIPT SMALL X +.. |Yscr| unicode:: U+1D4B4 .. MATHEMATICAL SCRIPT CAPITAL Y +.. |yscr| unicode:: U+1D4CE .. MATHEMATICAL SCRIPT SMALL Y +.. |Zscr| unicode:: U+1D4B5 .. MATHEMATICAL SCRIPT CAPITAL Z +.. |zscr| unicode:: U+1D4CF .. MATHEMATICAL SCRIPT SMALL Z diff --git a/aws/dist/docutils/parsers/rst/include/isomscr.txt b/aws/dist/docutils/parsers/rst/include/isomscr.txt new file mode 100644 index 00000000..a77890e9 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isomscr.txt @@ -0,0 +1,17 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Bscr| unicode:: U+0212C .. SCRIPT CAPITAL B +.. |Escr| unicode:: U+02130 .. SCRIPT CAPITAL E +.. |escr| unicode:: U+0212F .. SCRIPT SMALL E +.. |Fscr| unicode:: U+02131 .. SCRIPT CAPITAL F +.. |gscr| unicode:: U+0210A .. SCRIPT SMALL G +.. |Hscr| unicode:: U+0210B .. SCRIPT CAPITAL H +.. |Iscr| unicode:: U+02110 .. SCRIPT CAPITAL I +.. |Lscr| unicode:: U+02112 .. SCRIPT CAPITAL L +.. |Mscr| unicode:: U+02133 .. SCRIPT CAPITAL M +.. |oscr| unicode:: U+02134 .. SCRIPT SMALL O +.. |Rscr| unicode:: U+0211B .. SCRIPT CAPITAL R diff --git a/aws/dist/docutils/parsers/rst/include/isonum.txt b/aws/dist/docutils/parsers/rst/include/isonum.txt new file mode 100644 index 00000000..35793b36 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isonum.txt @@ -0,0 +1,82 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |amp| unicode:: U+00026 .. AMPERSAND +.. |apos| unicode:: U+00027 .. APOSTROPHE +.. |ast| unicode:: U+0002A .. ASTERISK +.. |brvbar| unicode:: U+000A6 .. BROKEN BAR +.. |bsol| unicode:: U+0005C .. REVERSE SOLIDUS +.. |cent| unicode:: U+000A2 .. CENT SIGN +.. |colon| unicode:: U+0003A .. COLON +.. |comma| unicode:: U+0002C .. COMMA +.. |commat| unicode:: U+00040 .. COMMERCIAL AT +.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN +.. |curren| unicode:: U+000A4 .. CURRENCY SIGN +.. |darr| unicode:: U+02193 .. DOWNWARDS ARROW +.. |deg| unicode:: U+000B0 .. DEGREE SIGN +.. |divide| unicode:: U+000F7 .. DIVISION SIGN +.. |dollar| unicode:: U+00024 .. DOLLAR SIGN +.. |equals| unicode:: U+0003D .. EQUALS SIGN +.. |excl| unicode:: U+00021 .. EXCLAMATION MARK +.. |frac12| unicode:: U+000BD .. VULGAR FRACTION ONE HALF +.. |frac14| unicode:: U+000BC .. VULGAR FRACTION ONE QUARTER +.. |frac18| unicode:: U+0215B .. VULGAR FRACTION ONE EIGHTH +.. |frac34| unicode:: U+000BE .. VULGAR FRACTION THREE QUARTERS +.. |frac38| unicode:: U+0215C .. VULGAR FRACTION THREE EIGHTHS +.. |frac58| unicode:: U+0215D .. VULGAR FRACTION FIVE EIGHTHS +.. |frac78| unicode:: U+0215E .. VULGAR FRACTION SEVEN EIGHTHS +.. |gt| unicode:: U+0003E .. GREATER-THAN SIGN +.. |half| unicode:: U+000BD .. VULGAR FRACTION ONE HALF +.. |horbar| unicode:: U+02015 .. HORIZONTAL BAR +.. |hyphen| unicode:: U+02010 .. HYPHEN +.. |iexcl| unicode:: U+000A1 .. INVERTED EXCLAMATION MARK +.. |iquest| unicode:: U+000BF .. INVERTED QUESTION MARK +.. |laquo| unicode:: U+000AB .. LEFT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |larr| unicode:: U+02190 .. LEFTWARDS ARROW +.. |lcub| unicode:: U+0007B .. LEFT CURLY BRACKET +.. |ldquo| unicode:: U+0201C .. LEFT DOUBLE QUOTATION MARK +.. |lowbar| unicode:: U+0005F .. LOW LINE +.. |lpar| unicode:: U+00028 .. LEFT PARENTHESIS +.. |lsqb| unicode:: U+0005B .. LEFT SQUARE BRACKET +.. |lsquo| unicode:: U+02018 .. LEFT SINGLE QUOTATION MARK +.. |lt| unicode:: U+0003C .. LESS-THAN SIGN +.. |micro| unicode:: U+000B5 .. MICRO SIGN +.. |middot| unicode:: U+000B7 .. MIDDLE DOT +.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE +.. |not| unicode:: U+000AC .. NOT SIGN +.. |num| unicode:: U+00023 .. NUMBER SIGN +.. |ohm| unicode:: U+02126 .. OHM SIGN +.. |ordf| unicode:: U+000AA .. FEMININE ORDINAL INDICATOR +.. |ordm| unicode:: U+000BA .. MASCULINE ORDINAL INDICATOR +.. |para| unicode:: U+000B6 .. PILCROW SIGN +.. |percnt| unicode:: U+00025 .. PERCENT SIGN +.. |period| unicode:: U+0002E .. FULL STOP +.. |plus| unicode:: U+0002B .. PLUS SIGN +.. |plusmn| unicode:: U+000B1 .. PLUS-MINUS SIGN +.. |pound| unicode:: U+000A3 .. POUND SIGN +.. |quest| unicode:: U+0003F .. QUESTION MARK +.. |quot| unicode:: U+00022 .. QUOTATION MARK +.. |raquo| unicode:: U+000BB .. RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |rarr| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |rcub| unicode:: U+0007D .. RIGHT CURLY BRACKET +.. |rdquo| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARK +.. |reg| unicode:: U+000AE .. REGISTERED SIGN +.. |rpar| unicode:: U+00029 .. RIGHT PARENTHESIS +.. |rsqb| unicode:: U+0005D .. RIGHT SQUARE BRACKET +.. |rsquo| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARK +.. |sect| unicode:: U+000A7 .. SECTION SIGN +.. |semi| unicode:: U+0003B .. SEMICOLON +.. |shy| unicode:: U+000AD .. SOFT HYPHEN +.. |sol| unicode:: U+0002F .. SOLIDUS +.. |sung| unicode:: U+0266A .. EIGHTH NOTE +.. |sup1| unicode:: U+000B9 .. SUPERSCRIPT ONE +.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO +.. |sup3| unicode:: U+000B3 .. SUPERSCRIPT THREE +.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN +.. |trade| unicode:: U+02122 .. TRADE MARK SIGN +.. |uarr| unicode:: U+02191 .. UPWARDS ARROW +.. |verbar| unicode:: U+0007C .. VERTICAL LINE +.. |yen| unicode:: U+000A5 .. YEN SIGN diff --git a/aws/dist/docutils/parsers/rst/include/isopub.txt b/aws/dist/docutils/parsers/rst/include/isopub.txt new file mode 100644 index 00000000..bc5b6d49 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isopub.txt @@ -0,0 +1,90 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |blank| unicode:: U+02423 .. OPEN BOX +.. |blk12| unicode:: U+02592 .. MEDIUM SHADE +.. |blk14| unicode:: U+02591 .. LIGHT SHADE +.. |blk34| unicode:: U+02593 .. DARK SHADE +.. |block| unicode:: U+02588 .. FULL BLOCK +.. |bull| unicode:: U+02022 .. BULLET +.. |caret| unicode:: U+02041 .. CARET INSERTION POINT +.. |check| unicode:: U+02713 .. CHECK MARK +.. |cir| unicode:: U+025CB .. WHITE CIRCLE +.. |clubs| unicode:: U+02663 .. BLACK CLUB SUIT +.. |copysr| unicode:: U+02117 .. SOUND RECORDING COPYRIGHT +.. |cross| unicode:: U+02717 .. BALLOT X +.. |Dagger| unicode:: U+02021 .. DOUBLE DAGGER +.. |dagger| unicode:: U+02020 .. DAGGER +.. |dash| unicode:: U+02010 .. HYPHEN +.. |diams| unicode:: U+02666 .. BLACK DIAMOND SUIT +.. |dlcrop| unicode:: U+0230D .. BOTTOM LEFT CROP +.. |drcrop| unicode:: U+0230C .. BOTTOM RIGHT CROP +.. |dtri| unicode:: U+025BF .. WHITE DOWN-POINTING SMALL TRIANGLE +.. |dtrif| unicode:: U+025BE .. BLACK DOWN-POINTING SMALL TRIANGLE +.. |emsp| unicode:: U+02003 .. EM SPACE +.. |emsp13| unicode:: U+02004 .. THREE-PER-EM SPACE +.. |emsp14| unicode:: U+02005 .. FOUR-PER-EM SPACE +.. |ensp| unicode:: U+02002 .. EN SPACE +.. |female| unicode:: U+02640 .. FEMALE SIGN +.. |ffilig| unicode:: U+0FB03 .. LATIN SMALL LIGATURE FFI +.. |fflig| unicode:: U+0FB00 .. LATIN SMALL LIGATURE FF +.. |ffllig| unicode:: U+0FB04 .. LATIN SMALL LIGATURE FFL +.. |filig| unicode:: U+0FB01 .. LATIN SMALL LIGATURE FI +.. |flat| unicode:: U+0266D .. MUSIC FLAT SIGN +.. |fllig| unicode:: U+0FB02 .. LATIN SMALL LIGATURE FL +.. |frac13| unicode:: U+02153 .. VULGAR FRACTION ONE THIRD +.. |frac15| unicode:: U+02155 .. VULGAR FRACTION ONE FIFTH +.. |frac16| unicode:: U+02159 .. VULGAR FRACTION ONE SIXTH +.. |frac23| unicode:: U+02154 .. VULGAR FRACTION TWO THIRDS +.. |frac25| unicode:: U+02156 .. VULGAR FRACTION TWO FIFTHS +.. |frac35| unicode:: U+02157 .. VULGAR FRACTION THREE FIFTHS +.. |frac45| unicode:: U+02158 .. VULGAR FRACTION FOUR FIFTHS +.. |frac56| unicode:: U+0215A .. VULGAR FRACTION FIVE SIXTHS +.. |hairsp| unicode:: U+0200A .. HAIR SPACE +.. |hearts| unicode:: U+02665 .. BLACK HEART SUIT +.. |hellip| unicode:: U+02026 .. HORIZONTAL ELLIPSIS +.. |hybull| unicode:: U+02043 .. HYPHEN BULLET +.. |incare| unicode:: U+02105 .. CARE OF +.. |ldquor| unicode:: U+0201E .. DOUBLE LOW-9 QUOTATION MARK +.. |lhblk| unicode:: U+02584 .. LOWER HALF BLOCK +.. |loz| unicode:: U+025CA .. LOZENGE +.. |lozf| unicode:: U+029EB .. BLACK LOZENGE +.. |lsquor| unicode:: U+0201A .. SINGLE LOW-9 QUOTATION MARK +.. |ltri| unicode:: U+025C3 .. WHITE LEFT-POINTING SMALL TRIANGLE +.. |ltrif| unicode:: U+025C2 .. BLACK LEFT-POINTING SMALL TRIANGLE +.. |male| unicode:: U+02642 .. MALE SIGN +.. |malt| unicode:: U+02720 .. MALTESE CROSS +.. |marker| unicode:: U+025AE .. BLACK VERTICAL RECTANGLE +.. |mdash| unicode:: U+02014 .. EM DASH +.. |mldr| unicode:: U+02026 .. HORIZONTAL ELLIPSIS +.. |natur| unicode:: U+0266E .. MUSIC NATURAL SIGN +.. |ndash| unicode:: U+02013 .. EN DASH +.. |nldr| unicode:: U+02025 .. TWO DOT LEADER +.. |numsp| unicode:: U+02007 .. FIGURE SPACE +.. |phone| unicode:: U+0260E .. BLACK TELEPHONE +.. |puncsp| unicode:: U+02008 .. PUNCTUATION SPACE +.. |rdquor| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARK +.. |rect| unicode:: U+025AD .. WHITE RECTANGLE +.. |rsquor| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARK +.. |rtri| unicode:: U+025B9 .. WHITE RIGHT-POINTING SMALL TRIANGLE +.. |rtrif| unicode:: U+025B8 .. BLACK RIGHT-POINTING SMALL TRIANGLE +.. |rx| unicode:: U+0211E .. PRESCRIPTION TAKE +.. |sext| unicode:: U+02736 .. SIX POINTED BLACK STAR +.. |sharp| unicode:: U+0266F .. MUSIC SHARP SIGN +.. |spades| unicode:: U+02660 .. BLACK SPADE SUIT +.. |squ| unicode:: U+025A1 .. WHITE SQUARE +.. |squf| unicode:: U+025AA .. BLACK SMALL SQUARE +.. |star| unicode:: U+02606 .. WHITE STAR +.. |starf| unicode:: U+02605 .. BLACK STAR +.. |target| unicode:: U+02316 .. POSITION INDICATOR +.. |telrec| unicode:: U+02315 .. TELEPHONE RECORDER +.. |thinsp| unicode:: U+02009 .. THIN SPACE +.. |uhblk| unicode:: U+02580 .. UPPER HALF BLOCK +.. |ulcrop| unicode:: U+0230F .. TOP LEFT CROP +.. |urcrop| unicode:: U+0230E .. TOP RIGHT CROP +.. |utri| unicode:: U+025B5 .. WHITE UP-POINTING SMALL TRIANGLE +.. |utrif| unicode:: U+025B4 .. BLACK UP-POINTING SMALL TRIANGLE +.. |vellip| unicode:: U+022EE .. VERTICAL ELLIPSIS diff --git a/aws/dist/docutils/parsers/rst/include/isotech.txt b/aws/dist/docutils/parsers/rst/include/isotech.txt new file mode 100644 index 00000000..01f7e346 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/isotech.txt @@ -0,0 +1,168 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |acd| unicode:: U+0223F .. SINE WAVE +.. |aleph| unicode:: U+02135 .. ALEF SYMBOL +.. |And| unicode:: U+02A53 .. DOUBLE LOGICAL AND +.. |and| unicode:: U+02227 .. LOGICAL AND +.. |andand| unicode:: U+02A55 .. TWO INTERSECTING LOGICAL AND +.. |andd| unicode:: U+02A5C .. LOGICAL AND WITH HORIZONTAL DASH +.. |andslope| unicode:: U+02A58 .. SLOPING LARGE AND +.. |andv| unicode:: U+02A5A .. LOGICAL AND WITH MIDDLE STEM +.. |ang90| unicode:: U+0221F .. RIGHT ANGLE +.. |angrt| unicode:: U+0221F .. RIGHT ANGLE +.. |angsph| unicode:: U+02222 .. SPHERICAL ANGLE +.. |angst| unicode:: U+0212B .. ANGSTROM SIGN +.. |ap| unicode:: U+02248 .. ALMOST EQUAL TO +.. |apacir| unicode:: U+02A6F .. ALMOST EQUAL TO WITH CIRCUMFLEX ACCENT +.. |awconint| unicode:: U+02233 .. ANTICLOCKWISE CONTOUR INTEGRAL +.. |awint| unicode:: U+02A11 .. ANTICLOCKWISE INTEGRATION +.. |becaus| unicode:: U+02235 .. BECAUSE +.. |bernou| unicode:: U+0212C .. SCRIPT CAPITAL B +.. |bne| unicode:: U+0003D U+020E5 .. EQUALS SIGN with reverse slash +.. |bnequiv| unicode:: U+02261 U+020E5 .. IDENTICAL TO with reverse slash +.. |bNot| unicode:: U+02AED .. REVERSED DOUBLE STROKE NOT SIGN +.. |bnot| unicode:: U+02310 .. REVERSED NOT SIGN +.. |bottom| unicode:: U+022A5 .. UP TACK +.. |cap| unicode:: U+02229 .. INTERSECTION +.. |Cconint| unicode:: U+02230 .. VOLUME INTEGRAL +.. |cirfnint| unicode:: U+02A10 .. CIRCULATION FUNCTION +.. |compfn| unicode:: U+02218 .. RING OPERATOR +.. |cong| unicode:: U+02245 .. APPROXIMATELY EQUAL TO +.. |Conint| unicode:: U+0222F .. SURFACE INTEGRAL +.. |conint| unicode:: U+0222E .. CONTOUR INTEGRAL +.. |ctdot| unicode:: U+022EF .. MIDLINE HORIZONTAL ELLIPSIS +.. |cup| unicode:: U+0222A .. UNION +.. |cwconint| unicode:: U+02232 .. CLOCKWISE CONTOUR INTEGRAL +.. |cwint| unicode:: U+02231 .. CLOCKWISE INTEGRAL +.. |cylcty| unicode:: U+0232D .. CYLINDRICITY +.. |disin| unicode:: U+022F2 .. ELEMENT OF WITH LONG HORIZONTAL STROKE +.. |Dot| unicode:: U+000A8 .. DIAERESIS +.. |DotDot| unicode:: U+020DC .. COMBINING FOUR DOTS ABOVE +.. |dsol| unicode:: U+029F6 .. SOLIDUS WITH OVERBAR +.. |dtdot| unicode:: U+022F1 .. DOWN RIGHT DIAGONAL ELLIPSIS +.. |dwangle| unicode:: U+029A6 .. OBLIQUE ANGLE OPENING UP +.. |elinters| unicode:: U+0FFFD .. REPLACEMENT CHARACTER +.. |epar| unicode:: U+022D5 .. EQUAL AND PARALLEL TO +.. |eparsl| unicode:: U+029E3 .. EQUALS SIGN AND SLANTED PARALLEL +.. |equiv| unicode:: U+02261 .. IDENTICAL TO +.. |eqvparsl| unicode:: U+029E5 .. IDENTICAL TO AND SLANTED PARALLEL +.. |exist| unicode:: U+02203 .. THERE EXISTS +.. |fltns| unicode:: U+025B1 .. WHITE PARALLELOGRAM +.. |fnof| unicode:: U+00192 .. LATIN SMALL LETTER F WITH HOOK +.. |forall| unicode:: U+02200 .. FOR ALL +.. |fpartint| unicode:: U+02A0D .. FINITE PART INTEGRAL +.. |ge| unicode:: U+02265 .. GREATER-THAN OR EQUAL TO +.. |hamilt| unicode:: U+0210B .. SCRIPT CAPITAL H +.. |iff| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |iinfin| unicode:: U+029DC .. INCOMPLETE INFINITY +.. |imped| unicode:: U+001B5 .. LATIN CAPITAL LETTER Z WITH STROKE +.. |infin| unicode:: U+0221E .. INFINITY +.. |infintie| unicode:: U+029DD .. TIE OVER INFINITY +.. |Int| unicode:: U+0222C .. DOUBLE INTEGRAL +.. |int| unicode:: U+0222B .. INTEGRAL +.. |intlarhk| unicode:: U+02A17 .. INTEGRAL WITH LEFTWARDS ARROW WITH HOOK +.. |isin| unicode:: U+02208 .. ELEMENT OF +.. |isindot| unicode:: U+022F5 .. ELEMENT OF WITH DOT ABOVE +.. |isinE| unicode:: U+022F9 .. ELEMENT OF WITH TWO HORIZONTAL STROKES +.. |isins| unicode:: U+022F4 .. SMALL ELEMENT OF WITH VERTICAL BAR AT END OF HORIZONTAL STROKE +.. |isinsv| unicode:: U+022F3 .. ELEMENT OF WITH VERTICAL BAR AT END OF HORIZONTAL STROKE +.. |isinv| unicode:: U+02208 .. ELEMENT OF +.. |lagran| unicode:: U+02112 .. SCRIPT CAPITAL L +.. |Lang| unicode:: U+0300A .. LEFT DOUBLE ANGLE BRACKET +.. |lang| unicode:: U+02329 .. LEFT-POINTING ANGLE BRACKET +.. |lArr| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |lbbrk| unicode:: U+03014 .. LEFT TORTOISE SHELL BRACKET +.. |le| unicode:: U+02264 .. LESS-THAN OR EQUAL TO +.. |loang| unicode:: U+03018 .. LEFT WHITE TORTOISE SHELL BRACKET +.. |lobrk| unicode:: U+0301A .. LEFT WHITE SQUARE BRACKET +.. |lopar| unicode:: U+02985 .. LEFT WHITE PARENTHESIS +.. |lowast| unicode:: U+02217 .. ASTERISK OPERATOR +.. |minus| unicode:: U+02212 .. MINUS SIGN +.. |mnplus| unicode:: U+02213 .. MINUS-OR-PLUS SIGN +.. |nabla| unicode:: U+02207 .. NABLA +.. |ne| unicode:: U+02260 .. NOT EQUAL TO +.. |nedot| unicode:: U+02250 U+00338 .. APPROACHES THE LIMIT with slash +.. |nhpar| unicode:: U+02AF2 .. PARALLEL WITH HORIZONTAL STROKE +.. |ni| unicode:: U+0220B .. CONTAINS AS MEMBER +.. |nis| unicode:: U+022FC .. SMALL CONTAINS WITH VERTICAL BAR AT END OF HORIZONTAL STROKE +.. |nisd| unicode:: U+022FA .. CONTAINS WITH LONG HORIZONTAL STROKE +.. |niv| unicode:: U+0220B .. CONTAINS AS MEMBER +.. |Not| unicode:: U+02AEC .. DOUBLE STROKE NOT SIGN +.. |notin| unicode:: U+02209 .. NOT AN ELEMENT OF +.. |notindot| unicode:: U+022F5 U+00338 .. ELEMENT OF WITH DOT ABOVE with slash +.. |notinE| unicode:: U+022F9 U+00338 .. ELEMENT OF WITH TWO HORIZONTAL STROKES with slash +.. |notinva| unicode:: U+02209 .. NOT AN ELEMENT OF +.. |notinvb| unicode:: U+022F7 .. SMALL ELEMENT OF WITH OVERBAR +.. |notinvc| unicode:: U+022F6 .. ELEMENT OF WITH OVERBAR +.. |notni| unicode:: U+0220C .. DOES NOT CONTAIN AS MEMBER +.. |notniva| unicode:: U+0220C .. DOES NOT CONTAIN AS MEMBER +.. |notnivb| unicode:: U+022FE .. SMALL CONTAINS WITH OVERBAR +.. |notnivc| unicode:: U+022FD .. CONTAINS WITH OVERBAR +.. |nparsl| unicode:: U+02AFD U+020E5 .. DOUBLE SOLIDUS OPERATOR with reverse slash +.. |npart| unicode:: U+02202 U+00338 .. PARTIAL DIFFERENTIAL with slash +.. |npolint| unicode:: U+02A14 .. LINE INTEGRATION NOT INCLUDING THE POLE +.. |nvinfin| unicode:: U+029DE .. INFINITY NEGATED WITH VERTICAL BAR +.. |olcross| unicode:: U+029BB .. CIRCLE WITH SUPERIMPOSED X +.. |Or| unicode:: U+02A54 .. DOUBLE LOGICAL OR +.. |or| unicode:: U+02228 .. LOGICAL OR +.. |ord| unicode:: U+02A5D .. LOGICAL OR WITH HORIZONTAL DASH +.. |order| unicode:: U+02134 .. SCRIPT SMALL O +.. |oror| unicode:: U+02A56 .. TWO INTERSECTING LOGICAL OR +.. |orslope| unicode:: U+02A57 .. SLOPING LARGE OR +.. |orv| unicode:: U+02A5B .. LOGICAL OR WITH MIDDLE STEM +.. |par| unicode:: U+02225 .. PARALLEL TO +.. |parsl| unicode:: U+02AFD .. DOUBLE SOLIDUS OPERATOR +.. |part| unicode:: U+02202 .. PARTIAL DIFFERENTIAL +.. |permil| unicode:: U+02030 .. PER MILLE SIGN +.. |perp| unicode:: U+022A5 .. UP TACK +.. |pertenk| unicode:: U+02031 .. PER TEN THOUSAND SIGN +.. |phmmat| unicode:: U+02133 .. SCRIPT CAPITAL M +.. |pointint| unicode:: U+02A15 .. INTEGRAL AROUND A POINT OPERATOR +.. |Prime| unicode:: U+02033 .. DOUBLE PRIME +.. |prime| unicode:: U+02032 .. PRIME +.. |profalar| unicode:: U+0232E .. ALL AROUND-PROFILE +.. |profline| unicode:: U+02312 .. ARC +.. |profsurf| unicode:: U+02313 .. SEGMENT +.. |prop| unicode:: U+0221D .. PROPORTIONAL TO +.. |qint| unicode:: U+02A0C .. QUADRUPLE INTEGRAL OPERATOR +.. |qprime| unicode:: U+02057 .. QUADRUPLE PRIME +.. |quatint| unicode:: U+02A16 .. QUATERNION INTEGRAL OPERATOR +.. |radic| unicode:: U+0221A .. SQUARE ROOT +.. |Rang| unicode:: U+0300B .. RIGHT DOUBLE ANGLE BRACKET +.. |rang| unicode:: U+0232A .. RIGHT-POINTING ANGLE BRACKET +.. |rArr| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |rbbrk| unicode:: U+03015 .. RIGHT TORTOISE SHELL BRACKET +.. |roang| unicode:: U+03019 .. RIGHT WHITE TORTOISE SHELL BRACKET +.. |robrk| unicode:: U+0301B .. RIGHT WHITE SQUARE BRACKET +.. |ropar| unicode:: U+02986 .. RIGHT WHITE PARENTHESIS +.. |rppolint| unicode:: U+02A12 .. LINE INTEGRATION WITH RECTANGULAR PATH AROUND POLE +.. |scpolint| unicode:: U+02A13 .. LINE INTEGRATION WITH SEMICIRCULAR PATH AROUND POLE +.. |sim| unicode:: U+0223C .. TILDE OPERATOR +.. |simdot| unicode:: U+02A6A .. TILDE OPERATOR WITH DOT ABOVE +.. |sime| unicode:: U+02243 .. ASYMPTOTICALLY EQUAL TO +.. |smeparsl| unicode:: U+029E4 .. EQUALS SIGN AND SLANTED PARALLEL WITH TILDE ABOVE +.. |square| unicode:: U+025A1 .. WHITE SQUARE +.. |squarf| unicode:: U+025AA .. BLACK SMALL SQUARE +.. |strns| unicode:: U+000AF .. MACRON +.. |sub| unicode:: U+02282 .. SUBSET OF +.. |sube| unicode:: U+02286 .. SUBSET OF OR EQUAL TO +.. |sup| unicode:: U+02283 .. SUPERSET OF +.. |supe| unicode:: U+02287 .. SUPERSET OF OR EQUAL TO +.. |tdot| unicode:: U+020DB .. COMBINING THREE DOTS ABOVE +.. |there4| unicode:: U+02234 .. THEREFORE +.. |tint| unicode:: U+0222D .. TRIPLE INTEGRAL +.. |top| unicode:: U+022A4 .. DOWN TACK +.. |topbot| unicode:: U+02336 .. APL FUNCTIONAL SYMBOL I-BEAM +.. |topcir| unicode:: U+02AF1 .. DOWN TACK WITH CIRCLE BELOW +.. |tprime| unicode:: U+02034 .. TRIPLE PRIME +.. |utdot| unicode:: U+022F0 .. UP RIGHT DIAGONAL ELLIPSIS +.. |uwangle| unicode:: U+029A7 .. OBLIQUE ANGLE OPENING DOWN +.. |vangrt| unicode:: U+0299C .. RIGHT ANGLE VARIANT WITH SQUARE +.. |veeeq| unicode:: U+0225A .. EQUIANGULAR TO +.. |Verbar| unicode:: U+02016 .. DOUBLE VERTICAL LINE +.. |wedgeq| unicode:: U+02259 .. ESTIMATES +.. |xnis| unicode:: U+022FB .. CONTAINS WITH VERTICAL BAR AT END OF HORIZONTAL STROKE diff --git a/aws/dist/docutils/parsers/rst/include/mmlalias.txt b/aws/dist/docutils/parsers/rst/include/mmlalias.txt new file mode 100644 index 00000000..cabc54ac --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/mmlalias.txt @@ -0,0 +1,554 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |angle| unicode:: U+02220 .. ANGLE +.. |ApplyFunction| unicode:: U+02061 .. FUNCTION APPLICATION +.. |approx| unicode:: U+02248 .. ALMOST EQUAL TO +.. |approxeq| unicode:: U+0224A .. ALMOST EQUAL OR EQUAL TO +.. |Assign| unicode:: U+02254 .. COLON EQUALS +.. |backcong| unicode:: U+0224C .. ALL EQUAL TO +.. |backepsilon| unicode:: U+003F6 .. GREEK REVERSED LUNATE EPSILON SYMBOL +.. |backprime| unicode:: U+02035 .. REVERSED PRIME +.. |backsim| unicode:: U+0223D .. REVERSED TILDE +.. |backsimeq| unicode:: U+022CD .. REVERSED TILDE EQUALS +.. |Backslash| unicode:: U+02216 .. SET MINUS +.. |barwedge| unicode:: U+02305 .. PROJECTIVE +.. |Because| unicode:: U+02235 .. BECAUSE +.. |because| unicode:: U+02235 .. BECAUSE +.. |Bernoullis| unicode:: U+0212C .. SCRIPT CAPITAL B +.. |between| unicode:: U+0226C .. BETWEEN +.. |bigcap| unicode:: U+022C2 .. N-ARY INTERSECTION +.. |bigcirc| unicode:: U+025EF .. LARGE CIRCLE +.. |bigcup| unicode:: U+022C3 .. N-ARY UNION +.. |bigodot| unicode:: U+02A00 .. N-ARY CIRCLED DOT OPERATOR +.. |bigoplus| unicode:: U+02A01 .. N-ARY CIRCLED PLUS OPERATOR +.. |bigotimes| unicode:: U+02A02 .. N-ARY CIRCLED TIMES OPERATOR +.. |bigsqcup| unicode:: U+02A06 .. N-ARY SQUARE UNION OPERATOR +.. |bigstar| unicode:: U+02605 .. BLACK STAR +.. |bigtriangledown| unicode:: U+025BD .. WHITE DOWN-POINTING TRIANGLE +.. |bigtriangleup| unicode:: U+025B3 .. WHITE UP-POINTING TRIANGLE +.. |biguplus| unicode:: U+02A04 .. N-ARY UNION OPERATOR WITH PLUS +.. |bigvee| unicode:: U+022C1 .. N-ARY LOGICAL OR +.. |bigwedge| unicode:: U+022C0 .. N-ARY LOGICAL AND +.. |bkarow| unicode:: U+0290D .. RIGHTWARDS DOUBLE DASH ARROW +.. |blacklozenge| unicode:: U+029EB .. BLACK LOZENGE +.. |blacksquare| unicode:: U+025AA .. BLACK SMALL SQUARE +.. |blacktriangle| unicode:: U+025B4 .. BLACK UP-POINTING SMALL TRIANGLE +.. |blacktriangledown| unicode:: U+025BE .. BLACK DOWN-POINTING SMALL TRIANGLE +.. |blacktriangleleft| unicode:: U+025C2 .. BLACK LEFT-POINTING SMALL TRIANGLE +.. |blacktriangleright| unicode:: U+025B8 .. BLACK RIGHT-POINTING SMALL TRIANGLE +.. |bot| unicode:: U+022A5 .. UP TACK +.. |boxminus| unicode:: U+0229F .. SQUARED MINUS +.. |boxplus| unicode:: U+0229E .. SQUARED PLUS +.. |boxtimes| unicode:: U+022A0 .. SQUARED TIMES +.. |Breve| unicode:: U+002D8 .. BREVE +.. |bullet| unicode:: U+02022 .. BULLET +.. |Bumpeq| unicode:: U+0224E .. GEOMETRICALLY EQUIVALENT TO +.. |bumpeq| unicode:: U+0224F .. DIFFERENCE BETWEEN +.. |CapitalDifferentialD| unicode:: U+02145 .. DOUBLE-STRUCK ITALIC CAPITAL D +.. |Cayleys| unicode:: U+0212D .. BLACK-LETTER CAPITAL C +.. |Cedilla| unicode:: U+000B8 .. CEDILLA +.. |CenterDot| unicode:: U+000B7 .. MIDDLE DOT +.. |centerdot| unicode:: U+000B7 .. MIDDLE DOT +.. |checkmark| unicode:: U+02713 .. CHECK MARK +.. |circeq| unicode:: U+02257 .. RING EQUAL TO +.. |circlearrowleft| unicode:: U+021BA .. ANTICLOCKWISE OPEN CIRCLE ARROW +.. |circlearrowright| unicode:: U+021BB .. CLOCKWISE OPEN CIRCLE ARROW +.. |circledast| unicode:: U+0229B .. CIRCLED ASTERISK OPERATOR +.. |circledcirc| unicode:: U+0229A .. CIRCLED RING OPERATOR +.. |circleddash| unicode:: U+0229D .. CIRCLED DASH +.. |CircleDot| unicode:: U+02299 .. CIRCLED DOT OPERATOR +.. |circledR| unicode:: U+000AE .. REGISTERED SIGN +.. |circledS| unicode:: U+024C8 .. CIRCLED LATIN CAPITAL LETTER S +.. |CircleMinus| unicode:: U+02296 .. CIRCLED MINUS +.. |CirclePlus| unicode:: U+02295 .. CIRCLED PLUS +.. |CircleTimes| unicode:: U+02297 .. CIRCLED TIMES +.. |ClockwiseContourIntegral| unicode:: U+02232 .. CLOCKWISE CONTOUR INTEGRAL +.. |CloseCurlyDoubleQuote| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARK +.. |CloseCurlyQuote| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARK +.. |clubsuit| unicode:: U+02663 .. BLACK CLUB SUIT +.. |coloneq| unicode:: U+02254 .. COLON EQUALS +.. |complement| unicode:: U+02201 .. COMPLEMENT +.. |complexes| unicode:: U+02102 .. DOUBLE-STRUCK CAPITAL C +.. |Congruent| unicode:: U+02261 .. IDENTICAL TO +.. |ContourIntegral| unicode:: U+0222E .. CONTOUR INTEGRAL +.. |Coproduct| unicode:: U+02210 .. N-ARY COPRODUCT +.. |CounterClockwiseContourIntegral| unicode:: U+02233 .. ANTICLOCKWISE CONTOUR INTEGRAL +.. |CupCap| unicode:: U+0224D .. EQUIVALENT TO +.. |curlyeqprec| unicode:: U+022DE .. EQUAL TO OR PRECEDES +.. |curlyeqsucc| unicode:: U+022DF .. EQUAL TO OR SUCCEEDS +.. |curlyvee| unicode:: U+022CE .. CURLY LOGICAL OR +.. |curlywedge| unicode:: U+022CF .. CURLY LOGICAL AND +.. |curvearrowleft| unicode:: U+021B6 .. ANTICLOCKWISE TOP SEMICIRCLE ARROW +.. |curvearrowright| unicode:: U+021B7 .. CLOCKWISE TOP SEMICIRCLE ARROW +.. |dbkarow| unicode:: U+0290F .. RIGHTWARDS TRIPLE DASH ARROW +.. |ddagger| unicode:: U+02021 .. DOUBLE DAGGER +.. |ddotseq| unicode:: U+02A77 .. EQUALS SIGN WITH TWO DOTS ABOVE AND TWO DOTS BELOW +.. |Del| unicode:: U+02207 .. NABLA +.. |DiacriticalAcute| unicode:: U+000B4 .. ACUTE ACCENT +.. |DiacriticalDot| unicode:: U+002D9 .. DOT ABOVE +.. |DiacriticalDoubleAcute| unicode:: U+002DD .. DOUBLE ACUTE ACCENT +.. |DiacriticalGrave| unicode:: U+00060 .. GRAVE ACCENT +.. |DiacriticalTilde| unicode:: U+002DC .. SMALL TILDE +.. |Diamond| unicode:: U+022C4 .. DIAMOND OPERATOR +.. |diamond| unicode:: U+022C4 .. DIAMOND OPERATOR +.. |diamondsuit| unicode:: U+02666 .. BLACK DIAMOND SUIT +.. |DifferentialD| unicode:: U+02146 .. DOUBLE-STRUCK ITALIC SMALL D +.. |digamma| unicode:: U+003DD .. GREEK SMALL LETTER DIGAMMA +.. |div| unicode:: U+000F7 .. DIVISION SIGN +.. |divideontimes| unicode:: U+022C7 .. DIVISION TIMES +.. |doteq| unicode:: U+02250 .. APPROACHES THE LIMIT +.. |doteqdot| unicode:: U+02251 .. GEOMETRICALLY EQUAL TO +.. |DotEqual| unicode:: U+02250 .. APPROACHES THE LIMIT +.. |dotminus| unicode:: U+02238 .. DOT MINUS +.. |dotplus| unicode:: U+02214 .. DOT PLUS +.. |dotsquare| unicode:: U+022A1 .. SQUARED DOT OPERATOR +.. |doublebarwedge| unicode:: U+02306 .. PERSPECTIVE +.. |DoubleContourIntegral| unicode:: U+0222F .. SURFACE INTEGRAL +.. |DoubleDot| unicode:: U+000A8 .. DIAERESIS +.. |DoubleDownArrow| unicode:: U+021D3 .. DOWNWARDS DOUBLE ARROW +.. |DoubleLeftArrow| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |DoubleLeftRightArrow| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |DoubleLeftTee| unicode:: U+02AE4 .. VERTICAL BAR DOUBLE LEFT TURNSTILE +.. |DoubleLongLeftArrow| unicode:: U+027F8 .. LONG LEFTWARDS DOUBLE ARROW +.. |DoubleLongLeftRightArrow| unicode:: U+027FA .. LONG LEFT RIGHT DOUBLE ARROW +.. |DoubleLongRightArrow| unicode:: U+027F9 .. LONG RIGHTWARDS DOUBLE ARROW +.. |DoubleRightArrow| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |DoubleRightTee| unicode:: U+022A8 .. TRUE +.. |DoubleUpArrow| unicode:: U+021D1 .. UPWARDS DOUBLE ARROW +.. |DoubleUpDownArrow| unicode:: U+021D5 .. UP DOWN DOUBLE ARROW +.. |DoubleVerticalBar| unicode:: U+02225 .. PARALLEL TO +.. |DownArrow| unicode:: U+02193 .. DOWNWARDS ARROW +.. |Downarrow| unicode:: U+021D3 .. DOWNWARDS DOUBLE ARROW +.. |downarrow| unicode:: U+02193 .. DOWNWARDS ARROW +.. |DownArrowUpArrow| unicode:: U+021F5 .. DOWNWARDS ARROW LEFTWARDS OF UPWARDS ARROW +.. |downdownarrows| unicode:: U+021CA .. DOWNWARDS PAIRED ARROWS +.. |downharpoonleft| unicode:: U+021C3 .. DOWNWARDS HARPOON WITH BARB LEFTWARDS +.. |downharpoonright| unicode:: U+021C2 .. DOWNWARDS HARPOON WITH BARB RIGHTWARDS +.. |DownLeftVector| unicode:: U+021BD .. LEFTWARDS HARPOON WITH BARB DOWNWARDS +.. |DownRightVector| unicode:: U+021C1 .. RIGHTWARDS HARPOON WITH BARB DOWNWARDS +.. |DownTee| unicode:: U+022A4 .. DOWN TACK +.. |DownTeeArrow| unicode:: U+021A7 .. DOWNWARDS ARROW FROM BAR +.. |drbkarow| unicode:: U+02910 .. RIGHTWARDS TWO-HEADED TRIPLE DASH ARROW +.. |Element| unicode:: U+02208 .. ELEMENT OF +.. |emptyset| unicode:: U+02205 .. EMPTY SET +.. |eqcirc| unicode:: U+02256 .. RING IN EQUAL TO +.. |eqcolon| unicode:: U+02255 .. EQUALS COLON +.. |eqsim| unicode:: U+02242 .. MINUS TILDE +.. |eqslantgtr| unicode:: U+02A96 .. SLANTED EQUAL TO OR GREATER-THAN +.. |eqslantless| unicode:: U+02A95 .. SLANTED EQUAL TO OR LESS-THAN +.. |EqualTilde| unicode:: U+02242 .. MINUS TILDE +.. |Equilibrium| unicode:: U+021CC .. RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON +.. |Exists| unicode:: U+02203 .. THERE EXISTS +.. |expectation| unicode:: U+02130 .. SCRIPT CAPITAL E +.. |ExponentialE| unicode:: U+02147 .. DOUBLE-STRUCK ITALIC SMALL E +.. |exponentiale| unicode:: U+02147 .. DOUBLE-STRUCK ITALIC SMALL E +.. |fallingdotseq| unicode:: U+02252 .. APPROXIMATELY EQUAL TO OR THE IMAGE OF +.. |ForAll| unicode:: U+02200 .. FOR ALL +.. |Fouriertrf| unicode:: U+02131 .. SCRIPT CAPITAL F +.. |geq| unicode:: U+02265 .. GREATER-THAN OR EQUAL TO +.. |geqq| unicode:: U+02267 .. GREATER-THAN OVER EQUAL TO +.. |geqslant| unicode:: U+02A7E .. GREATER-THAN OR SLANTED EQUAL TO +.. |gg| unicode:: U+0226B .. MUCH GREATER-THAN +.. |ggg| unicode:: U+022D9 .. VERY MUCH GREATER-THAN +.. |gnapprox| unicode:: U+02A8A .. GREATER-THAN AND NOT APPROXIMATE +.. |gneq| unicode:: U+02A88 .. GREATER-THAN AND SINGLE-LINE NOT EQUAL TO +.. |gneqq| unicode:: U+02269 .. GREATER-THAN BUT NOT EQUAL TO +.. |GreaterEqual| unicode:: U+02265 .. GREATER-THAN OR EQUAL TO +.. |GreaterEqualLess| unicode:: U+022DB .. GREATER-THAN EQUAL TO OR LESS-THAN +.. |GreaterFullEqual| unicode:: U+02267 .. GREATER-THAN OVER EQUAL TO +.. |GreaterLess| unicode:: U+02277 .. GREATER-THAN OR LESS-THAN +.. |GreaterSlantEqual| unicode:: U+02A7E .. GREATER-THAN OR SLANTED EQUAL TO +.. |GreaterTilde| unicode:: U+02273 .. GREATER-THAN OR EQUIVALENT TO +.. |gtrapprox| unicode:: U+02A86 .. GREATER-THAN OR APPROXIMATE +.. |gtrdot| unicode:: U+022D7 .. GREATER-THAN WITH DOT +.. |gtreqless| unicode:: U+022DB .. GREATER-THAN EQUAL TO OR LESS-THAN +.. |gtreqqless| unicode:: U+02A8C .. GREATER-THAN ABOVE DOUBLE-LINE EQUAL ABOVE LESS-THAN +.. |gtrless| unicode:: U+02277 .. GREATER-THAN OR LESS-THAN +.. |gtrsim| unicode:: U+02273 .. GREATER-THAN OR EQUIVALENT TO +.. |gvertneqq| unicode:: U+02269 U+0FE00 .. GREATER-THAN BUT NOT EQUAL TO - with vertical stroke +.. |Hacek| unicode:: U+002C7 .. CARON +.. |hbar| unicode:: U+0210F .. PLANCK CONSTANT OVER TWO PI +.. |heartsuit| unicode:: U+02665 .. BLACK HEART SUIT +.. |HilbertSpace| unicode:: U+0210B .. SCRIPT CAPITAL H +.. |hksearow| unicode:: U+02925 .. SOUTH EAST ARROW WITH HOOK +.. |hkswarow| unicode:: U+02926 .. SOUTH WEST ARROW WITH HOOK +.. |hookleftarrow| unicode:: U+021A9 .. LEFTWARDS ARROW WITH HOOK +.. |hookrightarrow| unicode:: U+021AA .. RIGHTWARDS ARROW WITH HOOK +.. |hslash| unicode:: U+0210F .. PLANCK CONSTANT OVER TWO PI +.. |HumpDownHump| unicode:: U+0224E .. GEOMETRICALLY EQUIVALENT TO +.. |HumpEqual| unicode:: U+0224F .. DIFFERENCE BETWEEN +.. |iiiint| unicode:: U+02A0C .. QUADRUPLE INTEGRAL OPERATOR +.. |iiint| unicode:: U+0222D .. TRIPLE INTEGRAL +.. |Im| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |ImaginaryI| unicode:: U+02148 .. DOUBLE-STRUCK ITALIC SMALL I +.. |imagline| unicode:: U+02110 .. SCRIPT CAPITAL I +.. |imagpart| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |Implies| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |in| unicode:: U+02208 .. ELEMENT OF +.. |integers| unicode:: U+02124 .. DOUBLE-STRUCK CAPITAL Z +.. |Integral| unicode:: U+0222B .. INTEGRAL +.. |intercal| unicode:: U+022BA .. INTERCALATE +.. |Intersection| unicode:: U+022C2 .. N-ARY INTERSECTION +.. |intprod| unicode:: U+02A3C .. INTERIOR PRODUCT +.. |InvisibleComma| unicode:: U+02063 .. INVISIBLE SEPARATOR +.. |InvisibleTimes| unicode:: U+02062 .. INVISIBLE TIMES +.. |langle| unicode:: U+02329 .. LEFT-POINTING ANGLE BRACKET +.. |Laplacetrf| unicode:: U+02112 .. SCRIPT CAPITAL L +.. |lbrace| unicode:: U+0007B .. LEFT CURLY BRACKET +.. |lbrack| unicode:: U+0005B .. LEFT SQUARE BRACKET +.. |LeftAngleBracket| unicode:: U+02329 .. LEFT-POINTING ANGLE BRACKET +.. |LeftArrow| unicode:: U+02190 .. LEFTWARDS ARROW +.. |Leftarrow| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |leftarrow| unicode:: U+02190 .. LEFTWARDS ARROW +.. |LeftArrowBar| unicode:: U+021E4 .. LEFTWARDS ARROW TO BAR +.. |LeftArrowRightArrow| unicode:: U+021C6 .. LEFTWARDS ARROW OVER RIGHTWARDS ARROW +.. |leftarrowtail| unicode:: U+021A2 .. LEFTWARDS ARROW WITH TAIL +.. |LeftCeiling| unicode:: U+02308 .. LEFT CEILING +.. |LeftDoubleBracket| unicode:: U+0301A .. LEFT WHITE SQUARE BRACKET +.. |LeftDownVector| unicode:: U+021C3 .. DOWNWARDS HARPOON WITH BARB LEFTWARDS +.. |LeftFloor| unicode:: U+0230A .. LEFT FLOOR +.. |leftharpoondown| unicode:: U+021BD .. LEFTWARDS HARPOON WITH BARB DOWNWARDS +.. |leftharpoonup| unicode:: U+021BC .. LEFTWARDS HARPOON WITH BARB UPWARDS +.. |leftleftarrows| unicode:: U+021C7 .. LEFTWARDS PAIRED ARROWS +.. |LeftRightArrow| unicode:: U+02194 .. LEFT RIGHT ARROW +.. |Leftrightarrow| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |leftrightarrow| unicode:: U+02194 .. LEFT RIGHT ARROW +.. |leftrightarrows| unicode:: U+021C6 .. LEFTWARDS ARROW OVER RIGHTWARDS ARROW +.. |leftrightharpoons| unicode:: U+021CB .. LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON +.. |leftrightsquigarrow| unicode:: U+021AD .. LEFT RIGHT WAVE ARROW +.. |LeftTee| unicode:: U+022A3 .. LEFT TACK +.. |LeftTeeArrow| unicode:: U+021A4 .. LEFTWARDS ARROW FROM BAR +.. |leftthreetimes| unicode:: U+022CB .. LEFT SEMIDIRECT PRODUCT +.. |LeftTriangle| unicode:: U+022B2 .. NORMAL SUBGROUP OF +.. |LeftTriangleEqual| unicode:: U+022B4 .. NORMAL SUBGROUP OF OR EQUAL TO +.. |LeftUpVector| unicode:: U+021BF .. UPWARDS HARPOON WITH BARB LEFTWARDS +.. |LeftVector| unicode:: U+021BC .. LEFTWARDS HARPOON WITH BARB UPWARDS +.. |leq| unicode:: U+02264 .. LESS-THAN OR EQUAL TO +.. |leqq| unicode:: U+02266 .. LESS-THAN OVER EQUAL TO +.. |leqslant| unicode:: U+02A7D .. LESS-THAN OR SLANTED EQUAL TO +.. |lessapprox| unicode:: U+02A85 .. LESS-THAN OR APPROXIMATE +.. |lessdot| unicode:: U+022D6 .. LESS-THAN WITH DOT +.. |lesseqgtr| unicode:: U+022DA .. LESS-THAN EQUAL TO OR GREATER-THAN +.. |lesseqqgtr| unicode:: U+02A8B .. LESS-THAN ABOVE DOUBLE-LINE EQUAL ABOVE GREATER-THAN +.. |LessEqualGreater| unicode:: U+022DA .. LESS-THAN EQUAL TO OR GREATER-THAN +.. |LessFullEqual| unicode:: U+02266 .. LESS-THAN OVER EQUAL TO +.. |LessGreater| unicode:: U+02276 .. LESS-THAN OR GREATER-THAN +.. |lessgtr| unicode:: U+02276 .. LESS-THAN OR GREATER-THAN +.. |lesssim| unicode:: U+02272 .. LESS-THAN OR EQUIVALENT TO +.. |LessSlantEqual| unicode:: U+02A7D .. LESS-THAN OR SLANTED EQUAL TO +.. |LessTilde| unicode:: U+02272 .. LESS-THAN OR EQUIVALENT TO +.. |ll| unicode:: U+0226A .. MUCH LESS-THAN +.. |llcorner| unicode:: U+0231E .. BOTTOM LEFT CORNER +.. |Lleftarrow| unicode:: U+021DA .. LEFTWARDS TRIPLE ARROW +.. |lmoustache| unicode:: U+023B0 .. UPPER LEFT OR LOWER RIGHT CURLY BRACKET SECTION +.. |lnapprox| unicode:: U+02A89 .. LESS-THAN AND NOT APPROXIMATE +.. |lneq| unicode:: U+02A87 .. LESS-THAN AND SINGLE-LINE NOT EQUAL TO +.. |lneqq| unicode:: U+02268 .. LESS-THAN BUT NOT EQUAL TO +.. |LongLeftArrow| unicode:: U+027F5 .. LONG LEFTWARDS ARROW +.. |Longleftarrow| unicode:: U+027F8 .. LONG LEFTWARDS DOUBLE ARROW +.. |longleftarrow| unicode:: U+027F5 .. LONG LEFTWARDS ARROW +.. |LongLeftRightArrow| unicode:: U+027F7 .. LONG LEFT RIGHT ARROW +.. |Longleftrightarrow| unicode:: U+027FA .. LONG LEFT RIGHT DOUBLE ARROW +.. |longleftrightarrow| unicode:: U+027F7 .. LONG LEFT RIGHT ARROW +.. |longmapsto| unicode:: U+027FC .. LONG RIGHTWARDS ARROW FROM BAR +.. |LongRightArrow| unicode:: U+027F6 .. LONG RIGHTWARDS ARROW +.. |Longrightarrow| unicode:: U+027F9 .. LONG RIGHTWARDS DOUBLE ARROW +.. |longrightarrow| unicode:: U+027F6 .. LONG RIGHTWARDS ARROW +.. |looparrowleft| unicode:: U+021AB .. LEFTWARDS ARROW WITH LOOP +.. |looparrowright| unicode:: U+021AC .. RIGHTWARDS ARROW WITH LOOP +.. |LowerLeftArrow| unicode:: U+02199 .. SOUTH WEST ARROW +.. |LowerRightArrow| unicode:: U+02198 .. SOUTH EAST ARROW +.. |lozenge| unicode:: U+025CA .. LOZENGE +.. |lrcorner| unicode:: U+0231F .. BOTTOM RIGHT CORNER +.. |Lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS +.. |lvertneqq| unicode:: U+02268 U+0FE00 .. LESS-THAN BUT NOT EQUAL TO - with vertical stroke +.. |maltese| unicode:: U+02720 .. MALTESE CROSS +.. |mapsto| unicode:: U+021A6 .. RIGHTWARDS ARROW FROM BAR +.. |measuredangle| unicode:: U+02221 .. MEASURED ANGLE +.. |Mellintrf| unicode:: U+02133 .. SCRIPT CAPITAL M +.. |MinusPlus| unicode:: U+02213 .. MINUS-OR-PLUS SIGN +.. |mp| unicode:: U+02213 .. MINUS-OR-PLUS SIGN +.. |multimap| unicode:: U+022B8 .. MULTIMAP +.. |napprox| unicode:: U+02249 .. NOT ALMOST EQUAL TO +.. |natural| unicode:: U+0266E .. MUSIC NATURAL SIGN +.. |naturals| unicode:: U+02115 .. DOUBLE-STRUCK CAPITAL N +.. |nearrow| unicode:: U+02197 .. NORTH EAST ARROW +.. |NegativeMediumSpace| unicode:: U+0200B .. ZERO WIDTH SPACE +.. |NegativeThickSpace| unicode:: U+0200B .. ZERO WIDTH SPACE +.. |NegativeThinSpace| unicode:: U+0200B .. ZERO WIDTH SPACE +.. |NegativeVeryThinSpace| unicode:: U+0200B .. ZERO WIDTH SPACE +.. |NestedGreaterGreater| unicode:: U+0226B .. MUCH GREATER-THAN +.. |NestedLessLess| unicode:: U+0226A .. MUCH LESS-THAN +.. |nexists| unicode:: U+02204 .. THERE DOES NOT EXIST +.. |ngeq| unicode:: U+02271 .. NEITHER GREATER-THAN NOR EQUAL TO +.. |ngeqq| unicode:: U+02267 U+00338 .. GREATER-THAN OVER EQUAL TO with slash +.. |ngeqslant| unicode:: U+02A7E U+00338 .. GREATER-THAN OR SLANTED EQUAL TO with slash +.. |ngtr| unicode:: U+0226F .. NOT GREATER-THAN +.. |nLeftarrow| unicode:: U+021CD .. LEFTWARDS DOUBLE ARROW WITH STROKE +.. |nleftarrow| unicode:: U+0219A .. LEFTWARDS ARROW WITH STROKE +.. |nLeftrightarrow| unicode:: U+021CE .. LEFT RIGHT DOUBLE ARROW WITH STROKE +.. |nleftrightarrow| unicode:: U+021AE .. LEFT RIGHT ARROW WITH STROKE +.. |nleq| unicode:: U+02270 .. NEITHER LESS-THAN NOR EQUAL TO +.. |nleqq| unicode:: U+02266 U+00338 .. LESS-THAN OVER EQUAL TO with slash +.. |nleqslant| unicode:: U+02A7D U+00338 .. LESS-THAN OR SLANTED EQUAL TO with slash +.. |nless| unicode:: U+0226E .. NOT LESS-THAN +.. |NonBreakingSpace| unicode:: U+000A0 .. NO-BREAK SPACE +.. |NotCongruent| unicode:: U+02262 .. NOT IDENTICAL TO +.. |NotDoubleVerticalBar| unicode:: U+02226 .. NOT PARALLEL TO +.. |NotElement| unicode:: U+02209 .. NOT AN ELEMENT OF +.. |NotEqual| unicode:: U+02260 .. NOT EQUAL TO +.. |NotEqualTilde| unicode:: U+02242 U+00338 .. MINUS TILDE with slash +.. |NotExists| unicode:: U+02204 .. THERE DOES NOT EXIST +.. |NotGreater| unicode:: U+0226F .. NOT GREATER-THAN +.. |NotGreaterEqual| unicode:: U+02271 .. NEITHER GREATER-THAN NOR EQUAL TO +.. |NotGreaterFullEqual| unicode:: U+02266 U+00338 .. LESS-THAN OVER EQUAL TO with slash +.. |NotGreaterGreater| unicode:: U+0226B U+00338 .. MUCH GREATER THAN with slash +.. |NotGreaterLess| unicode:: U+02279 .. NEITHER GREATER-THAN NOR LESS-THAN +.. |NotGreaterSlantEqual| unicode:: U+02A7E U+00338 .. GREATER-THAN OR SLANTED EQUAL TO with slash +.. |NotGreaterTilde| unicode:: U+02275 .. NEITHER GREATER-THAN NOR EQUIVALENT TO +.. |NotHumpDownHump| unicode:: U+0224E U+00338 .. GEOMETRICALLY EQUIVALENT TO with slash +.. |NotLeftTriangle| unicode:: U+022EA .. NOT NORMAL SUBGROUP OF +.. |NotLeftTriangleEqual| unicode:: U+022EC .. NOT NORMAL SUBGROUP OF OR EQUAL TO +.. |NotLess| unicode:: U+0226E .. NOT LESS-THAN +.. |NotLessEqual| unicode:: U+02270 .. NEITHER LESS-THAN NOR EQUAL TO +.. |NotLessGreater| unicode:: U+02278 .. NEITHER LESS-THAN NOR GREATER-THAN +.. |NotLessLess| unicode:: U+0226A U+00338 .. MUCH LESS THAN with slash +.. |NotLessSlantEqual| unicode:: U+02A7D U+00338 .. LESS-THAN OR SLANTED EQUAL TO with slash +.. |NotLessTilde| unicode:: U+02274 .. NEITHER LESS-THAN NOR EQUIVALENT TO +.. |NotPrecedes| unicode:: U+02280 .. DOES NOT PRECEDE +.. |NotPrecedesEqual| unicode:: U+02AAF U+00338 .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |NotPrecedesSlantEqual| unicode:: U+022E0 .. DOES NOT PRECEDE OR EQUAL +.. |NotReverseElement| unicode:: U+0220C .. DOES NOT CONTAIN AS MEMBER +.. |NotRightTriangle| unicode:: U+022EB .. DOES NOT CONTAIN AS NORMAL SUBGROUP +.. |NotRightTriangleEqual| unicode:: U+022ED .. DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL +.. |NotSquareSubsetEqual| unicode:: U+022E2 .. NOT SQUARE IMAGE OF OR EQUAL TO +.. |NotSquareSupersetEqual| unicode:: U+022E3 .. NOT SQUARE ORIGINAL OF OR EQUAL TO +.. |NotSubset| unicode:: U+02282 U+020D2 .. SUBSET OF with vertical line +.. |NotSubsetEqual| unicode:: U+02288 .. NEITHER A SUBSET OF NOR EQUAL TO +.. |NotSucceeds| unicode:: U+02281 .. DOES NOT SUCCEED +.. |NotSucceedsEqual| unicode:: U+02AB0 U+00338 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |NotSucceedsSlantEqual| unicode:: U+022E1 .. DOES NOT SUCCEED OR EQUAL +.. |NotSuperset| unicode:: U+02283 U+020D2 .. SUPERSET OF with vertical line +.. |NotSupersetEqual| unicode:: U+02289 .. NEITHER A SUPERSET OF NOR EQUAL TO +.. |NotTilde| unicode:: U+02241 .. NOT TILDE +.. |NotTildeEqual| unicode:: U+02244 .. NOT ASYMPTOTICALLY EQUAL TO +.. |NotTildeFullEqual| unicode:: U+02247 .. NEITHER APPROXIMATELY NOR ACTUALLY EQUAL TO +.. |NotTildeTilde| unicode:: U+02249 .. NOT ALMOST EQUAL TO +.. |NotVerticalBar| unicode:: U+02224 .. DOES NOT DIVIDE +.. |nparallel| unicode:: U+02226 .. NOT PARALLEL TO +.. |nprec| unicode:: U+02280 .. DOES NOT PRECEDE +.. |npreceq| unicode:: U+02AAF U+00338 .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |nRightarrow| unicode:: U+021CF .. RIGHTWARDS DOUBLE ARROW WITH STROKE +.. |nrightarrow| unicode:: U+0219B .. RIGHTWARDS ARROW WITH STROKE +.. |nshortmid| unicode:: U+02224 .. DOES NOT DIVIDE +.. |nshortparallel| unicode:: U+02226 .. NOT PARALLEL TO +.. |nsimeq| unicode:: U+02244 .. NOT ASYMPTOTICALLY EQUAL TO +.. |nsubset| unicode:: U+02282 U+020D2 .. SUBSET OF with vertical line +.. |nsubseteq| unicode:: U+02288 .. NEITHER A SUBSET OF NOR EQUAL TO +.. |nsubseteqq| unicode:: U+02AC5 U+00338 .. SUBSET OF ABOVE EQUALS SIGN with slash +.. |nsucc| unicode:: U+02281 .. DOES NOT SUCCEED +.. |nsucceq| unicode:: U+02AB0 U+00338 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN with slash +.. |nsupset| unicode:: U+02283 U+020D2 .. SUPERSET OF with vertical line +.. |nsupseteq| unicode:: U+02289 .. NEITHER A SUPERSET OF NOR EQUAL TO +.. |nsupseteqq| unicode:: U+02AC6 U+00338 .. SUPERSET OF ABOVE EQUALS SIGN with slash +.. |ntriangleleft| unicode:: U+022EA .. NOT NORMAL SUBGROUP OF +.. |ntrianglelefteq| unicode:: U+022EC .. NOT NORMAL SUBGROUP OF OR EQUAL TO +.. |ntriangleright| unicode:: U+022EB .. DOES NOT CONTAIN AS NORMAL SUBGROUP +.. |ntrianglerighteq| unicode:: U+022ED .. DOES NOT CONTAIN AS NORMAL SUBGROUP OR EQUAL +.. |nwarrow| unicode:: U+02196 .. NORTH WEST ARROW +.. |oint| unicode:: U+0222E .. CONTOUR INTEGRAL +.. |OpenCurlyDoubleQuote| unicode:: U+0201C .. LEFT DOUBLE QUOTATION MARK +.. |OpenCurlyQuote| unicode:: U+02018 .. LEFT SINGLE QUOTATION MARK +.. |orderof| unicode:: U+02134 .. SCRIPT SMALL O +.. |parallel| unicode:: U+02225 .. PARALLEL TO +.. |PartialD| unicode:: U+02202 .. PARTIAL DIFFERENTIAL +.. |pitchfork| unicode:: U+022D4 .. PITCHFORK +.. |PlusMinus| unicode:: U+000B1 .. PLUS-MINUS SIGN +.. |pm| unicode:: U+000B1 .. PLUS-MINUS SIGN +.. |Poincareplane| unicode:: U+0210C .. BLACK-LETTER CAPITAL H +.. |prec| unicode:: U+0227A .. PRECEDES +.. |precapprox| unicode:: U+02AB7 .. PRECEDES ABOVE ALMOST EQUAL TO +.. |preccurlyeq| unicode:: U+0227C .. PRECEDES OR EQUAL TO +.. |Precedes| unicode:: U+0227A .. PRECEDES +.. |PrecedesEqual| unicode:: U+02AAF .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN +.. |PrecedesSlantEqual| unicode:: U+0227C .. PRECEDES OR EQUAL TO +.. |PrecedesTilde| unicode:: U+0227E .. PRECEDES OR EQUIVALENT TO +.. |preceq| unicode:: U+02AAF .. PRECEDES ABOVE SINGLE-LINE EQUALS SIGN +.. |precnapprox| unicode:: U+02AB9 .. PRECEDES ABOVE NOT ALMOST EQUAL TO +.. |precneqq| unicode:: U+02AB5 .. PRECEDES ABOVE NOT EQUAL TO +.. |precnsim| unicode:: U+022E8 .. PRECEDES BUT NOT EQUIVALENT TO +.. |precsim| unicode:: U+0227E .. PRECEDES OR EQUIVALENT TO +.. |primes| unicode:: U+02119 .. DOUBLE-STRUCK CAPITAL P +.. |Proportion| unicode:: U+02237 .. PROPORTION +.. |Proportional| unicode:: U+0221D .. PROPORTIONAL TO +.. |propto| unicode:: U+0221D .. PROPORTIONAL TO +.. |quaternions| unicode:: U+0210D .. DOUBLE-STRUCK CAPITAL H +.. |questeq| unicode:: U+0225F .. QUESTIONED EQUAL TO +.. |rangle| unicode:: U+0232A .. RIGHT-POINTING ANGLE BRACKET +.. |rationals| unicode:: U+0211A .. DOUBLE-STRUCK CAPITAL Q +.. |rbrace| unicode:: U+0007D .. RIGHT CURLY BRACKET +.. |rbrack| unicode:: U+0005D .. RIGHT SQUARE BRACKET +.. |Re| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |realine| unicode:: U+0211B .. SCRIPT CAPITAL R +.. |realpart| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |reals| unicode:: U+0211D .. DOUBLE-STRUCK CAPITAL R +.. |ReverseElement| unicode:: U+0220B .. CONTAINS AS MEMBER +.. |ReverseEquilibrium| unicode:: U+021CB .. LEFTWARDS HARPOON OVER RIGHTWARDS HARPOON +.. |ReverseUpEquilibrium| unicode:: U+0296F .. DOWNWARDS HARPOON WITH BARB LEFT BESIDE UPWARDS HARPOON WITH BARB RIGHT +.. |RightAngleBracket| unicode:: U+0232A .. RIGHT-POINTING ANGLE BRACKET +.. |RightArrow| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |Rightarrow| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |rightarrow| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |RightArrowBar| unicode:: U+021E5 .. RIGHTWARDS ARROW TO BAR +.. |RightArrowLeftArrow| unicode:: U+021C4 .. RIGHTWARDS ARROW OVER LEFTWARDS ARROW +.. |rightarrowtail| unicode:: U+021A3 .. RIGHTWARDS ARROW WITH TAIL +.. |RightCeiling| unicode:: U+02309 .. RIGHT CEILING +.. |RightDoubleBracket| unicode:: U+0301B .. RIGHT WHITE SQUARE BRACKET +.. |RightDownVector| unicode:: U+021C2 .. DOWNWARDS HARPOON WITH BARB RIGHTWARDS +.. |RightFloor| unicode:: U+0230B .. RIGHT FLOOR +.. |rightharpoondown| unicode:: U+021C1 .. RIGHTWARDS HARPOON WITH BARB DOWNWARDS +.. |rightharpoonup| unicode:: U+021C0 .. RIGHTWARDS HARPOON WITH BARB UPWARDS +.. |rightleftarrows| unicode:: U+021C4 .. RIGHTWARDS ARROW OVER LEFTWARDS ARROW +.. |rightleftharpoons| unicode:: U+021CC .. RIGHTWARDS HARPOON OVER LEFTWARDS HARPOON +.. |rightrightarrows| unicode:: U+021C9 .. RIGHTWARDS PAIRED ARROWS +.. |rightsquigarrow| unicode:: U+0219D .. RIGHTWARDS WAVE ARROW +.. |RightTee| unicode:: U+022A2 .. RIGHT TACK +.. |RightTeeArrow| unicode:: U+021A6 .. RIGHTWARDS ARROW FROM BAR +.. |rightthreetimes| unicode:: U+022CC .. RIGHT SEMIDIRECT PRODUCT +.. |RightTriangle| unicode:: U+022B3 .. CONTAINS AS NORMAL SUBGROUP +.. |RightTriangleEqual| unicode:: U+022B5 .. CONTAINS AS NORMAL SUBGROUP OR EQUAL TO +.. |RightUpVector| unicode:: U+021BE .. UPWARDS HARPOON WITH BARB RIGHTWARDS +.. |RightVector| unicode:: U+021C0 .. RIGHTWARDS HARPOON WITH BARB UPWARDS +.. |risingdotseq| unicode:: U+02253 .. IMAGE OF OR APPROXIMATELY EQUAL TO +.. |rmoustache| unicode:: U+023B1 .. UPPER RIGHT OR LOWER LEFT CURLY BRACKET SECTION +.. |Rrightarrow| unicode:: U+021DB .. RIGHTWARDS TRIPLE ARROW +.. |Rsh| unicode:: U+021B1 .. UPWARDS ARROW WITH TIP RIGHTWARDS +.. |searrow| unicode:: U+02198 .. SOUTH EAST ARROW +.. |setminus| unicode:: U+02216 .. SET MINUS +.. |ShortDownArrow| unicode:: U+02193 .. DOWNWARDS ARROW +.. |ShortLeftArrow| unicode:: U+02190 .. LEFTWARDS ARROW +.. |shortmid| unicode:: U+02223 .. DIVIDES +.. |shortparallel| unicode:: U+02225 .. PARALLEL TO +.. |ShortRightArrow| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |ShortUpArrow| unicode:: U+02191 .. UPWARDS ARROW +.. |simeq| unicode:: U+02243 .. ASYMPTOTICALLY EQUAL TO +.. |SmallCircle| unicode:: U+02218 .. RING OPERATOR +.. |smallsetminus| unicode:: U+02216 .. SET MINUS +.. |spadesuit| unicode:: U+02660 .. BLACK SPADE SUIT +.. |Sqrt| unicode:: U+0221A .. SQUARE ROOT +.. |sqsubset| unicode:: U+0228F .. SQUARE IMAGE OF +.. |sqsubseteq| unicode:: U+02291 .. SQUARE IMAGE OF OR EQUAL TO +.. |sqsupset| unicode:: U+02290 .. SQUARE ORIGINAL OF +.. |sqsupseteq| unicode:: U+02292 .. SQUARE ORIGINAL OF OR EQUAL TO +.. |Square| unicode:: U+025A1 .. WHITE SQUARE +.. |SquareIntersection| unicode:: U+02293 .. SQUARE CAP +.. |SquareSubset| unicode:: U+0228F .. SQUARE IMAGE OF +.. |SquareSubsetEqual| unicode:: U+02291 .. SQUARE IMAGE OF OR EQUAL TO +.. |SquareSuperset| unicode:: U+02290 .. SQUARE ORIGINAL OF +.. |SquareSupersetEqual| unicode:: U+02292 .. SQUARE ORIGINAL OF OR EQUAL TO +.. |SquareUnion| unicode:: U+02294 .. SQUARE CUP +.. |Star| unicode:: U+022C6 .. STAR OPERATOR +.. |straightepsilon| unicode:: U+003F5 .. GREEK LUNATE EPSILON SYMBOL +.. |straightphi| unicode:: U+003D5 .. GREEK PHI SYMBOL +.. |Subset| unicode:: U+022D0 .. DOUBLE SUBSET +.. |subset| unicode:: U+02282 .. SUBSET OF +.. |subseteq| unicode:: U+02286 .. SUBSET OF OR EQUAL TO +.. |subseteqq| unicode:: U+02AC5 .. SUBSET OF ABOVE EQUALS SIGN +.. |SubsetEqual| unicode:: U+02286 .. SUBSET OF OR EQUAL TO +.. |subsetneq| unicode:: U+0228A .. SUBSET OF WITH NOT EQUAL TO +.. |subsetneqq| unicode:: U+02ACB .. SUBSET OF ABOVE NOT EQUAL TO +.. |succ| unicode:: U+0227B .. SUCCEEDS +.. |succapprox| unicode:: U+02AB8 .. SUCCEEDS ABOVE ALMOST EQUAL TO +.. |succcurlyeq| unicode:: U+0227D .. SUCCEEDS OR EQUAL TO +.. |Succeeds| unicode:: U+0227B .. SUCCEEDS +.. |SucceedsEqual| unicode:: U+02AB0 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN +.. |SucceedsSlantEqual| unicode:: U+0227D .. SUCCEEDS OR EQUAL TO +.. |SucceedsTilde| unicode:: U+0227F .. SUCCEEDS OR EQUIVALENT TO +.. |succeq| unicode:: U+02AB0 .. SUCCEEDS ABOVE SINGLE-LINE EQUALS SIGN +.. |succnapprox| unicode:: U+02ABA .. SUCCEEDS ABOVE NOT ALMOST EQUAL TO +.. |succneqq| unicode:: U+02AB6 .. SUCCEEDS ABOVE NOT EQUAL TO +.. |succnsim| unicode:: U+022E9 .. SUCCEEDS BUT NOT EQUIVALENT TO +.. |succsim| unicode:: U+0227F .. SUCCEEDS OR EQUIVALENT TO +.. |SuchThat| unicode:: U+0220B .. CONTAINS AS MEMBER +.. |Sum| unicode:: U+02211 .. N-ARY SUMMATION +.. |Superset| unicode:: U+02283 .. SUPERSET OF +.. |SupersetEqual| unicode:: U+02287 .. SUPERSET OF OR EQUAL TO +.. |Supset| unicode:: U+022D1 .. DOUBLE SUPERSET +.. |supset| unicode:: U+02283 .. SUPERSET OF +.. |supseteq| unicode:: U+02287 .. SUPERSET OF OR EQUAL TO +.. |supseteqq| unicode:: U+02AC6 .. SUPERSET OF ABOVE EQUALS SIGN +.. |supsetneq| unicode:: U+0228B .. SUPERSET OF WITH NOT EQUAL TO +.. |supsetneqq| unicode:: U+02ACC .. SUPERSET OF ABOVE NOT EQUAL TO +.. |swarrow| unicode:: U+02199 .. SOUTH WEST ARROW +.. |Therefore| unicode:: U+02234 .. THEREFORE +.. |therefore| unicode:: U+02234 .. THEREFORE +.. |thickapprox| unicode:: U+02248 .. ALMOST EQUAL TO +.. |thicksim| unicode:: U+0223C .. TILDE OPERATOR +.. |ThinSpace| unicode:: U+02009 .. THIN SPACE +.. |Tilde| unicode:: U+0223C .. TILDE OPERATOR +.. |TildeEqual| unicode:: U+02243 .. ASYMPTOTICALLY EQUAL TO +.. |TildeFullEqual| unicode:: U+02245 .. APPROXIMATELY EQUAL TO +.. |TildeTilde| unicode:: U+02248 .. ALMOST EQUAL TO +.. |toea| unicode:: U+02928 .. NORTH EAST ARROW AND SOUTH EAST ARROW +.. |tosa| unicode:: U+02929 .. SOUTH EAST ARROW AND SOUTH WEST ARROW +.. |triangle| unicode:: U+025B5 .. WHITE UP-POINTING SMALL TRIANGLE +.. |triangledown| unicode:: U+025BF .. WHITE DOWN-POINTING SMALL TRIANGLE +.. |triangleleft| unicode:: U+025C3 .. WHITE LEFT-POINTING SMALL TRIANGLE +.. |trianglelefteq| unicode:: U+022B4 .. NORMAL SUBGROUP OF OR EQUAL TO +.. |triangleq| unicode:: U+0225C .. DELTA EQUAL TO +.. |triangleright| unicode:: U+025B9 .. WHITE RIGHT-POINTING SMALL TRIANGLE +.. |trianglerighteq| unicode:: U+022B5 .. CONTAINS AS NORMAL SUBGROUP OR EQUAL TO +.. |TripleDot| unicode:: U+020DB .. COMBINING THREE DOTS ABOVE +.. |twoheadleftarrow| unicode:: U+0219E .. LEFTWARDS TWO HEADED ARROW +.. |twoheadrightarrow| unicode:: U+021A0 .. RIGHTWARDS TWO HEADED ARROW +.. |ulcorner| unicode:: U+0231C .. TOP LEFT CORNER +.. |Union| unicode:: U+022C3 .. N-ARY UNION +.. |UnionPlus| unicode:: U+0228E .. MULTISET UNION +.. |UpArrow| unicode:: U+02191 .. UPWARDS ARROW +.. |Uparrow| unicode:: U+021D1 .. UPWARDS DOUBLE ARROW +.. |uparrow| unicode:: U+02191 .. UPWARDS ARROW +.. |UpArrowDownArrow| unicode:: U+021C5 .. UPWARDS ARROW LEFTWARDS OF DOWNWARDS ARROW +.. |UpDownArrow| unicode:: U+02195 .. UP DOWN ARROW +.. |Updownarrow| unicode:: U+021D5 .. UP DOWN DOUBLE ARROW +.. |updownarrow| unicode:: U+02195 .. UP DOWN ARROW +.. |UpEquilibrium| unicode:: U+0296E .. UPWARDS HARPOON WITH BARB LEFT BESIDE DOWNWARDS HARPOON WITH BARB RIGHT +.. |upharpoonleft| unicode:: U+021BF .. UPWARDS HARPOON WITH BARB LEFTWARDS +.. |upharpoonright| unicode:: U+021BE .. UPWARDS HARPOON WITH BARB RIGHTWARDS +.. |UpperLeftArrow| unicode:: U+02196 .. NORTH WEST ARROW +.. |UpperRightArrow| unicode:: U+02197 .. NORTH EAST ARROW +.. |upsilon| unicode:: U+003C5 .. GREEK SMALL LETTER UPSILON +.. |UpTee| unicode:: U+022A5 .. UP TACK +.. |UpTeeArrow| unicode:: U+021A5 .. UPWARDS ARROW FROM BAR +.. |upuparrows| unicode:: U+021C8 .. UPWARDS PAIRED ARROWS +.. |urcorner| unicode:: U+0231D .. TOP RIGHT CORNER +.. |varepsilon| unicode:: U+003B5 .. GREEK SMALL LETTER EPSILON +.. |varkappa| unicode:: U+003F0 .. GREEK KAPPA SYMBOL +.. |varnothing| unicode:: U+02205 .. EMPTY SET +.. |varphi| unicode:: U+003C6 .. GREEK SMALL LETTER PHI +.. |varpi| unicode:: U+003D6 .. GREEK PI SYMBOL +.. |varpropto| unicode:: U+0221D .. PROPORTIONAL TO +.. |varrho| unicode:: U+003F1 .. GREEK RHO SYMBOL +.. |varsigma| unicode:: U+003C2 .. GREEK SMALL LETTER FINAL SIGMA +.. |varsubsetneq| unicode:: U+0228A U+0FE00 .. SUBSET OF WITH NOT EQUAL TO - variant with stroke through bottom members +.. |varsubsetneqq| unicode:: U+02ACB U+0FE00 .. SUBSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members +.. |varsupsetneq| unicode:: U+0228B U+0FE00 .. SUPERSET OF WITH NOT EQUAL TO - variant with stroke through bottom members +.. |varsupsetneqq| unicode:: U+02ACC U+0FE00 .. SUPERSET OF ABOVE NOT EQUAL TO - variant with stroke through bottom members +.. |vartheta| unicode:: U+003D1 .. GREEK THETA SYMBOL +.. |vartriangleleft| unicode:: U+022B2 .. NORMAL SUBGROUP OF +.. |vartriangleright| unicode:: U+022B3 .. CONTAINS AS NORMAL SUBGROUP +.. |Vee| unicode:: U+022C1 .. N-ARY LOGICAL OR +.. |vee| unicode:: U+02228 .. LOGICAL OR +.. |Vert| unicode:: U+02016 .. DOUBLE VERTICAL LINE +.. |vert| unicode:: U+0007C .. VERTICAL LINE +.. |VerticalBar| unicode:: U+02223 .. DIVIDES +.. |VerticalTilde| unicode:: U+02240 .. WREATH PRODUCT +.. |VeryThinSpace| unicode:: U+0200A .. HAIR SPACE +.. |Wedge| unicode:: U+022C0 .. N-ARY LOGICAL AND +.. |wedge| unicode:: U+02227 .. LOGICAL AND +.. |wp| unicode:: U+02118 .. SCRIPT CAPITAL P +.. |wr| unicode:: U+02240 .. WREATH PRODUCT +.. |zeetrf| unicode:: U+02128 .. BLACK-LETTER CAPITAL Z diff --git a/aws/dist/docutils/parsers/rst/include/mmlextra-wide.txt b/aws/dist/docutils/parsers/rst/include/mmlextra-wide.txt new file mode 100644 index 00000000..0177ccc0 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/mmlextra-wide.txt @@ -0,0 +1,113 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |af| unicode:: U+02061 .. FUNCTION APPLICATION +.. |aopf| unicode:: U+1D552 .. MATHEMATICAL DOUBLE-STRUCK SMALL A +.. |asympeq| unicode:: U+0224D .. EQUIVALENT TO +.. |bopf| unicode:: U+1D553 .. MATHEMATICAL DOUBLE-STRUCK SMALL B +.. |copf| unicode:: U+1D554 .. MATHEMATICAL DOUBLE-STRUCK SMALL C +.. |Cross| unicode:: U+02A2F .. VECTOR OR CROSS PRODUCT +.. |DD| unicode:: U+02145 .. DOUBLE-STRUCK ITALIC CAPITAL D +.. |dd| unicode:: U+02146 .. DOUBLE-STRUCK ITALIC SMALL D +.. |dopf| unicode:: U+1D555 .. MATHEMATICAL DOUBLE-STRUCK SMALL D +.. |DownArrowBar| unicode:: U+02913 .. DOWNWARDS ARROW TO BAR +.. |DownBreve| unicode:: U+00311 .. COMBINING INVERTED BREVE +.. |DownLeftRightVector| unicode:: U+02950 .. LEFT BARB DOWN RIGHT BARB DOWN HARPOON +.. |DownLeftTeeVector| unicode:: U+0295E .. LEFTWARDS HARPOON WITH BARB DOWN FROM BAR +.. |DownLeftVectorBar| unicode:: U+02956 .. LEFTWARDS HARPOON WITH BARB DOWN TO BAR +.. |DownRightTeeVector| unicode:: U+0295F .. RIGHTWARDS HARPOON WITH BARB DOWN FROM BAR +.. |DownRightVectorBar| unicode:: U+02957 .. RIGHTWARDS HARPOON WITH BARB DOWN TO BAR +.. |ee| unicode:: U+02147 .. DOUBLE-STRUCK ITALIC SMALL E +.. |EmptySmallSquare| unicode:: U+025FB .. WHITE MEDIUM SQUARE +.. |EmptyVerySmallSquare| unicode:: U+025AB .. WHITE SMALL SQUARE +.. |eopf| unicode:: U+1D556 .. MATHEMATICAL DOUBLE-STRUCK SMALL E +.. |Equal| unicode:: U+02A75 .. TWO CONSECUTIVE EQUALS SIGNS +.. |FilledSmallSquare| unicode:: U+025FC .. BLACK MEDIUM SQUARE +.. |FilledVerySmallSquare| unicode:: U+025AA .. BLACK SMALL SQUARE +.. |fopf| unicode:: U+1D557 .. MATHEMATICAL DOUBLE-STRUCK SMALL F +.. |gopf| unicode:: U+1D558 .. MATHEMATICAL DOUBLE-STRUCK SMALL G +.. |GreaterGreater| unicode:: U+02AA2 .. DOUBLE NESTED GREATER-THAN +.. |Hat| unicode:: U+0005E .. CIRCUMFLEX ACCENT +.. |hopf| unicode:: U+1D559 .. MATHEMATICAL DOUBLE-STRUCK SMALL H +.. |HorizontalLine| unicode:: U+02500 .. BOX DRAWINGS LIGHT HORIZONTAL +.. |ic| unicode:: U+02063 .. INVISIBLE SEPARATOR +.. |ii| unicode:: U+02148 .. DOUBLE-STRUCK ITALIC SMALL I +.. |iopf| unicode:: U+1D55A .. MATHEMATICAL DOUBLE-STRUCK SMALL I +.. |it| unicode:: U+02062 .. INVISIBLE TIMES +.. |jopf| unicode:: U+1D55B .. MATHEMATICAL DOUBLE-STRUCK SMALL J +.. |kopf| unicode:: U+1D55C .. MATHEMATICAL DOUBLE-STRUCK SMALL K +.. |larrb| unicode:: U+021E4 .. LEFTWARDS ARROW TO BAR +.. |LeftDownTeeVector| unicode:: U+02961 .. DOWNWARDS HARPOON WITH BARB LEFT FROM BAR +.. |LeftDownVectorBar| unicode:: U+02959 .. DOWNWARDS HARPOON WITH BARB LEFT TO BAR +.. |LeftRightVector| unicode:: U+0294E .. LEFT BARB UP RIGHT BARB UP HARPOON +.. |LeftTeeVector| unicode:: U+0295A .. LEFTWARDS HARPOON WITH BARB UP FROM BAR +.. |LeftTriangleBar| unicode:: U+029CF .. LEFT TRIANGLE BESIDE VERTICAL BAR +.. |LeftUpDownVector| unicode:: U+02951 .. UP BARB LEFT DOWN BARB LEFT HARPOON +.. |LeftUpTeeVector| unicode:: U+02960 .. UPWARDS HARPOON WITH BARB LEFT FROM BAR +.. |LeftUpVectorBar| unicode:: U+02958 .. UPWARDS HARPOON WITH BARB LEFT TO BAR +.. |LeftVectorBar| unicode:: U+02952 .. LEFTWARDS HARPOON WITH BARB UP TO BAR +.. |LessLess| unicode:: U+02AA1 .. DOUBLE NESTED LESS-THAN +.. |lopf| unicode:: U+1D55D .. MATHEMATICAL DOUBLE-STRUCK SMALL L +.. |mapstodown| unicode:: U+021A7 .. DOWNWARDS ARROW FROM BAR +.. |mapstoleft| unicode:: U+021A4 .. LEFTWARDS ARROW FROM BAR +.. |mapstoup| unicode:: U+021A5 .. UPWARDS ARROW FROM BAR +.. |MediumSpace| unicode:: U+0205F .. MEDIUM MATHEMATICAL SPACE +.. |mopf| unicode:: U+1D55E .. MATHEMATICAL DOUBLE-STRUCK SMALL M +.. |nbump| unicode:: U+0224E U+00338 .. GEOMETRICALLY EQUIVALENT TO with slash +.. |nbumpe| unicode:: U+0224F U+00338 .. DIFFERENCE BETWEEN with slash +.. |nesim| unicode:: U+02242 U+00338 .. MINUS TILDE with slash +.. |NewLine| unicode:: U+0000A .. LINE FEED (LF) +.. |NoBreak| unicode:: U+02060 .. WORD JOINER +.. |nopf| unicode:: U+1D55F .. MATHEMATICAL DOUBLE-STRUCK SMALL N +.. |NotCupCap| unicode:: U+0226D .. NOT EQUIVALENT TO +.. |NotHumpEqual| unicode:: U+0224F U+00338 .. DIFFERENCE BETWEEN with slash +.. |NotLeftTriangleBar| unicode:: U+029CF U+00338 .. LEFT TRIANGLE BESIDE VERTICAL BAR with slash +.. |NotNestedGreaterGreater| unicode:: U+02AA2 U+00338 .. DOUBLE NESTED GREATER-THAN with slash +.. |NotNestedLessLess| unicode:: U+02AA1 U+00338 .. DOUBLE NESTED LESS-THAN with slash +.. |NotRightTriangleBar| unicode:: U+029D0 U+00338 .. VERTICAL BAR BESIDE RIGHT TRIANGLE with slash +.. |NotSquareSubset| unicode:: U+0228F U+00338 .. SQUARE IMAGE OF with slash +.. |NotSquareSuperset| unicode:: U+02290 U+00338 .. SQUARE ORIGINAL OF with slash +.. |NotSucceedsTilde| unicode:: U+0227F U+00338 .. SUCCEEDS OR EQUIVALENT TO with slash +.. |oopf| unicode:: U+1D560 .. MATHEMATICAL DOUBLE-STRUCK SMALL O +.. |OverBar| unicode:: U+000AF .. MACRON +.. |OverBrace| unicode:: U+0FE37 .. PRESENTATION FORM FOR VERTICAL LEFT CURLY BRACKET +.. |OverBracket| unicode:: U+023B4 .. TOP SQUARE BRACKET +.. |OverParenthesis| unicode:: U+0FE35 .. PRESENTATION FORM FOR VERTICAL LEFT PARENTHESIS +.. |planckh| unicode:: U+0210E .. PLANCK CONSTANT +.. |popf| unicode:: U+1D561 .. MATHEMATICAL DOUBLE-STRUCK SMALL P +.. |Product| unicode:: U+0220F .. N-ARY PRODUCT +.. |qopf| unicode:: U+1D562 .. MATHEMATICAL DOUBLE-STRUCK SMALL Q +.. |rarrb| unicode:: U+021E5 .. RIGHTWARDS ARROW TO BAR +.. |RightDownTeeVector| unicode:: U+0295D .. DOWNWARDS HARPOON WITH BARB RIGHT FROM BAR +.. |RightDownVectorBar| unicode:: U+02955 .. DOWNWARDS HARPOON WITH BARB RIGHT TO BAR +.. |RightTeeVector| unicode:: U+0295B .. RIGHTWARDS HARPOON WITH BARB UP FROM BAR +.. |RightTriangleBar| unicode:: U+029D0 .. VERTICAL BAR BESIDE RIGHT TRIANGLE +.. |RightUpDownVector| unicode:: U+0294F .. UP BARB RIGHT DOWN BARB RIGHT HARPOON +.. |RightUpTeeVector| unicode:: U+0295C .. UPWARDS HARPOON WITH BARB RIGHT FROM BAR +.. |RightUpVectorBar| unicode:: U+02954 .. UPWARDS HARPOON WITH BARB RIGHT TO BAR +.. |RightVectorBar| unicode:: U+02953 .. RIGHTWARDS HARPOON WITH BARB UP TO BAR +.. |ropf| unicode:: U+1D563 .. MATHEMATICAL DOUBLE-STRUCK SMALL R +.. |RoundImplies| unicode:: U+02970 .. RIGHT DOUBLE ARROW WITH ROUNDED HEAD +.. |RuleDelayed| unicode:: U+029F4 .. RULE-DELAYED +.. |sopf| unicode:: U+1D564 .. MATHEMATICAL DOUBLE-STRUCK SMALL S +.. |Tab| unicode:: U+00009 .. CHARACTER TABULATION +.. |ThickSpace| unicode:: U+02009 U+0200A U+0200A .. space of width 5/18 em +.. |topf| unicode:: U+1D565 .. MATHEMATICAL DOUBLE-STRUCK SMALL T +.. |UnderBar| unicode:: U+00332 .. COMBINING LOW LINE +.. |UnderBrace| unicode:: U+0FE38 .. PRESENTATION FORM FOR VERTICAL RIGHT CURLY BRACKET +.. |UnderBracket| unicode:: U+023B5 .. BOTTOM SQUARE BRACKET +.. |UnderParenthesis| unicode:: U+0FE36 .. PRESENTATION FORM FOR VERTICAL RIGHT PARENTHESIS +.. |uopf| unicode:: U+1D566 .. MATHEMATICAL DOUBLE-STRUCK SMALL U +.. |UpArrowBar| unicode:: U+02912 .. UPWARDS ARROW TO BAR +.. |Upsilon| unicode:: U+003A5 .. GREEK CAPITAL LETTER UPSILON +.. |VerticalLine| unicode:: U+0007C .. VERTICAL LINE +.. |VerticalSeparator| unicode:: U+02758 .. LIGHT VERTICAL BAR +.. |vopf| unicode:: U+1D567 .. MATHEMATICAL DOUBLE-STRUCK SMALL V +.. |wopf| unicode:: U+1D568 .. MATHEMATICAL DOUBLE-STRUCK SMALL W +.. |xopf| unicode:: U+1D569 .. MATHEMATICAL DOUBLE-STRUCK SMALL X +.. |yopf| unicode:: U+1D56A .. MATHEMATICAL DOUBLE-STRUCK SMALL Y +.. |ZeroWidthSpace| unicode:: U+0200B .. ZERO WIDTH SPACE +.. |zopf| unicode:: U+1D56B .. MATHEMATICAL DOUBLE-STRUCK SMALL Z diff --git a/aws/dist/docutils/parsers/rst/include/mmlextra.txt b/aws/dist/docutils/parsers/rst/include/mmlextra.txt new file mode 100644 index 00000000..790a9775 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/mmlextra.txt @@ -0,0 +1,87 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |af| unicode:: U+02061 .. FUNCTION APPLICATION +.. |asympeq| unicode:: U+0224D .. EQUIVALENT TO +.. |Cross| unicode:: U+02A2F .. VECTOR OR CROSS PRODUCT +.. |DD| unicode:: U+02145 .. DOUBLE-STRUCK ITALIC CAPITAL D +.. |dd| unicode:: U+02146 .. DOUBLE-STRUCK ITALIC SMALL D +.. |DownArrowBar| unicode:: U+02913 .. DOWNWARDS ARROW TO BAR +.. |DownBreve| unicode:: U+00311 .. COMBINING INVERTED BREVE +.. |DownLeftRightVector| unicode:: U+02950 .. LEFT BARB DOWN RIGHT BARB DOWN HARPOON +.. |DownLeftTeeVector| unicode:: U+0295E .. LEFTWARDS HARPOON WITH BARB DOWN FROM BAR +.. |DownLeftVectorBar| unicode:: U+02956 .. LEFTWARDS HARPOON WITH BARB DOWN TO BAR +.. |DownRightTeeVector| unicode:: U+0295F .. RIGHTWARDS HARPOON WITH BARB DOWN FROM BAR +.. |DownRightVectorBar| unicode:: U+02957 .. RIGHTWARDS HARPOON WITH BARB DOWN TO BAR +.. |ee| unicode:: U+02147 .. DOUBLE-STRUCK ITALIC SMALL E +.. |EmptySmallSquare| unicode:: U+025FB .. WHITE MEDIUM SQUARE +.. |EmptyVerySmallSquare| unicode:: U+025AB .. WHITE SMALL SQUARE +.. |Equal| unicode:: U+02A75 .. TWO CONSECUTIVE EQUALS SIGNS +.. |FilledSmallSquare| unicode:: U+025FC .. BLACK MEDIUM SQUARE +.. |FilledVerySmallSquare| unicode:: U+025AA .. BLACK SMALL SQUARE +.. |GreaterGreater| unicode:: U+02AA2 .. DOUBLE NESTED GREATER-THAN +.. |Hat| unicode:: U+0005E .. CIRCUMFLEX ACCENT +.. |HorizontalLine| unicode:: U+02500 .. BOX DRAWINGS LIGHT HORIZONTAL +.. |ic| unicode:: U+02063 .. INVISIBLE SEPARATOR +.. |ii| unicode:: U+02148 .. DOUBLE-STRUCK ITALIC SMALL I +.. |it| unicode:: U+02062 .. INVISIBLE TIMES +.. |larrb| unicode:: U+021E4 .. LEFTWARDS ARROW TO BAR +.. |LeftDownTeeVector| unicode:: U+02961 .. DOWNWARDS HARPOON WITH BARB LEFT FROM BAR +.. |LeftDownVectorBar| unicode:: U+02959 .. DOWNWARDS HARPOON WITH BARB LEFT TO BAR +.. |LeftRightVector| unicode:: U+0294E .. LEFT BARB UP RIGHT BARB UP HARPOON +.. |LeftTeeVector| unicode:: U+0295A .. LEFTWARDS HARPOON WITH BARB UP FROM BAR +.. |LeftTriangleBar| unicode:: U+029CF .. LEFT TRIANGLE BESIDE VERTICAL BAR +.. |LeftUpDownVector| unicode:: U+02951 .. UP BARB LEFT DOWN BARB LEFT HARPOON +.. |LeftUpTeeVector| unicode:: U+02960 .. UPWARDS HARPOON WITH BARB LEFT FROM BAR +.. |LeftUpVectorBar| unicode:: U+02958 .. UPWARDS HARPOON WITH BARB LEFT TO BAR +.. |LeftVectorBar| unicode:: U+02952 .. LEFTWARDS HARPOON WITH BARB UP TO BAR +.. |LessLess| unicode:: U+02AA1 .. DOUBLE NESTED LESS-THAN +.. |mapstodown| unicode:: U+021A7 .. DOWNWARDS ARROW FROM BAR +.. |mapstoleft| unicode:: U+021A4 .. LEFTWARDS ARROW FROM BAR +.. |mapstoup| unicode:: U+021A5 .. UPWARDS ARROW FROM BAR +.. |MediumSpace| unicode:: U+0205F .. MEDIUM MATHEMATICAL SPACE +.. |nbump| unicode:: U+0224E U+00338 .. GEOMETRICALLY EQUIVALENT TO with slash +.. |nbumpe| unicode:: U+0224F U+00338 .. DIFFERENCE BETWEEN with slash +.. |nesim| unicode:: U+02242 U+00338 .. MINUS TILDE with slash +.. |NewLine| unicode:: U+0000A .. LINE FEED (LF) +.. |NoBreak| unicode:: U+02060 .. WORD JOINER +.. |NotCupCap| unicode:: U+0226D .. NOT EQUIVALENT TO +.. |NotHumpEqual| unicode:: U+0224F U+00338 .. DIFFERENCE BETWEEN with slash +.. |NotLeftTriangleBar| unicode:: U+029CF U+00338 .. LEFT TRIANGLE BESIDE VERTICAL BAR with slash +.. |NotNestedGreaterGreater| unicode:: U+02AA2 U+00338 .. DOUBLE NESTED GREATER-THAN with slash +.. |NotNestedLessLess| unicode:: U+02AA1 U+00338 .. DOUBLE NESTED LESS-THAN with slash +.. |NotRightTriangleBar| unicode:: U+029D0 U+00338 .. VERTICAL BAR BESIDE RIGHT TRIANGLE with slash +.. |NotSquareSubset| unicode:: U+0228F U+00338 .. SQUARE IMAGE OF with slash +.. |NotSquareSuperset| unicode:: U+02290 U+00338 .. SQUARE ORIGINAL OF with slash +.. |NotSucceedsTilde| unicode:: U+0227F U+00338 .. SUCCEEDS OR EQUIVALENT TO with slash +.. |OverBar| unicode:: U+000AF .. MACRON +.. |OverBrace| unicode:: U+0FE37 .. PRESENTATION FORM FOR VERTICAL LEFT CURLY BRACKET +.. |OverBracket| unicode:: U+023B4 .. TOP SQUARE BRACKET +.. |OverParenthesis| unicode:: U+0FE35 .. PRESENTATION FORM FOR VERTICAL LEFT PARENTHESIS +.. |planckh| unicode:: U+0210E .. PLANCK CONSTANT +.. |Product| unicode:: U+0220F .. N-ARY PRODUCT +.. |rarrb| unicode:: U+021E5 .. RIGHTWARDS ARROW TO BAR +.. |RightDownTeeVector| unicode:: U+0295D .. DOWNWARDS HARPOON WITH BARB RIGHT FROM BAR +.. |RightDownVectorBar| unicode:: U+02955 .. DOWNWARDS HARPOON WITH BARB RIGHT TO BAR +.. |RightTeeVector| unicode:: U+0295B .. RIGHTWARDS HARPOON WITH BARB UP FROM BAR +.. |RightTriangleBar| unicode:: U+029D0 .. VERTICAL BAR BESIDE RIGHT TRIANGLE +.. |RightUpDownVector| unicode:: U+0294F .. UP BARB RIGHT DOWN BARB RIGHT HARPOON +.. |RightUpTeeVector| unicode:: U+0295C .. UPWARDS HARPOON WITH BARB RIGHT FROM BAR +.. |RightUpVectorBar| unicode:: U+02954 .. UPWARDS HARPOON WITH BARB RIGHT TO BAR +.. |RightVectorBar| unicode:: U+02953 .. RIGHTWARDS HARPOON WITH BARB UP TO BAR +.. |RoundImplies| unicode:: U+02970 .. RIGHT DOUBLE ARROW WITH ROUNDED HEAD +.. |RuleDelayed| unicode:: U+029F4 .. RULE-DELAYED +.. |Tab| unicode:: U+00009 .. CHARACTER TABULATION +.. |ThickSpace| unicode:: U+02009 U+0200A U+0200A .. space of width 5/18 em +.. |UnderBar| unicode:: U+00332 .. COMBINING LOW LINE +.. |UnderBrace| unicode:: U+0FE38 .. PRESENTATION FORM FOR VERTICAL RIGHT CURLY BRACKET +.. |UnderBracket| unicode:: U+023B5 .. BOTTOM SQUARE BRACKET +.. |UnderParenthesis| unicode:: U+0FE36 .. PRESENTATION FORM FOR VERTICAL RIGHT PARENTHESIS +.. |UpArrowBar| unicode:: U+02912 .. UPWARDS ARROW TO BAR +.. |Upsilon| unicode:: U+003A5 .. GREEK CAPITAL LETTER UPSILON +.. |VerticalLine| unicode:: U+0007C .. VERTICAL LINE +.. |VerticalSeparator| unicode:: U+02758 .. LIGHT VERTICAL BAR +.. |ZeroWidthSpace| unicode:: U+0200B .. ZERO WIDTH SPACE diff --git a/aws/dist/docutils/parsers/rst/include/s5defs.txt b/aws/dist/docutils/parsers/rst/include/s5defs.txt new file mode 100644 index 00000000..8aceeac0 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/s5defs.txt @@ -0,0 +1,68 @@ +.. Definitions of interpreted text roles (classes) for S5/HTML data. +.. This data file has been placed in the public domain. + +.. Colours + ======= + +.. role:: black +.. role:: gray +.. role:: silver +.. role:: white + +.. role:: maroon +.. role:: red +.. role:: magenta +.. role:: fuchsia +.. role:: pink +.. role:: orange +.. role:: yellow +.. role:: lime +.. role:: green +.. role:: olive +.. role:: teal +.. role:: cyan +.. role:: aqua +.. role:: blue +.. role:: navy +.. role:: purple + + +.. Text Sizes + ========== + +.. role:: huge +.. role:: big +.. role:: small +.. role:: tiny + + +.. Display in Slides (Presentation Mode) Only + ========================================== + +.. role:: slide + :class: slide-display + + +.. Display in Outline Mode Only + ============================ + +.. role:: outline + + +.. Display in Print Only + ===================== + +.. role:: print + + +.. Display in Handout Mode Only + ============================ + +.. role:: handout + + +.. Incremental Display + =================== + +.. role:: incremental +.. default-role:: incremental diff --git a/aws/dist/docutils/parsers/rst/include/xhtml1-lat1.txt b/aws/dist/docutils/parsers/rst/include/xhtml1-lat1.txt new file mode 100644 index 00000000..824dc61c --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/xhtml1-lat1.txt @@ -0,0 +1,102 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |Aacute| unicode:: U+000C1 .. LATIN CAPITAL LETTER A WITH ACUTE +.. |aacute| unicode:: U+000E1 .. LATIN SMALL LETTER A WITH ACUTE +.. |Acirc| unicode:: U+000C2 .. LATIN CAPITAL LETTER A WITH CIRCUMFLEX +.. |acirc| unicode:: U+000E2 .. LATIN SMALL LETTER A WITH CIRCUMFLEX +.. |acute| unicode:: U+000B4 .. ACUTE ACCENT +.. |AElig| unicode:: U+000C6 .. LATIN CAPITAL LETTER AE +.. |aelig| unicode:: U+000E6 .. LATIN SMALL LETTER AE +.. |Agrave| unicode:: U+000C0 .. LATIN CAPITAL LETTER A WITH GRAVE +.. |agrave| unicode:: U+000E0 .. LATIN SMALL LETTER A WITH GRAVE +.. |Aring| unicode:: U+000C5 .. LATIN CAPITAL LETTER A WITH RING ABOVE +.. |aring| unicode:: U+000E5 .. LATIN SMALL LETTER A WITH RING ABOVE +.. |Atilde| unicode:: U+000C3 .. LATIN CAPITAL LETTER A WITH TILDE +.. |atilde| unicode:: U+000E3 .. LATIN SMALL LETTER A WITH TILDE +.. |Auml| unicode:: U+000C4 .. LATIN CAPITAL LETTER A WITH DIAERESIS +.. |auml| unicode:: U+000E4 .. LATIN SMALL LETTER A WITH DIAERESIS +.. |brvbar| unicode:: U+000A6 .. BROKEN BAR +.. |Ccedil| unicode:: U+000C7 .. LATIN CAPITAL LETTER C WITH CEDILLA +.. |ccedil| unicode:: U+000E7 .. LATIN SMALL LETTER C WITH CEDILLA +.. |cedil| unicode:: U+000B8 .. CEDILLA +.. |cent| unicode:: U+000A2 .. CENT SIGN +.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN +.. |curren| unicode:: U+000A4 .. CURRENCY SIGN +.. |deg| unicode:: U+000B0 .. DEGREE SIGN +.. |divide| unicode:: U+000F7 .. DIVISION SIGN +.. |Eacute| unicode:: U+000C9 .. LATIN CAPITAL LETTER E WITH ACUTE +.. |eacute| unicode:: U+000E9 .. LATIN SMALL LETTER E WITH ACUTE +.. |Ecirc| unicode:: U+000CA .. LATIN CAPITAL LETTER E WITH CIRCUMFLEX +.. |ecirc| unicode:: U+000EA .. LATIN SMALL LETTER E WITH CIRCUMFLEX +.. |Egrave| unicode:: U+000C8 .. LATIN CAPITAL LETTER E WITH GRAVE +.. |egrave| unicode:: U+000E8 .. LATIN SMALL LETTER E WITH GRAVE +.. |ETH| unicode:: U+000D0 .. LATIN CAPITAL LETTER ETH +.. |eth| unicode:: U+000F0 .. LATIN SMALL LETTER ETH +.. |Euml| unicode:: U+000CB .. LATIN CAPITAL LETTER E WITH DIAERESIS +.. |euml| unicode:: U+000EB .. LATIN SMALL LETTER E WITH DIAERESIS +.. |frac12| unicode:: U+000BD .. VULGAR FRACTION ONE HALF +.. |frac14| unicode:: U+000BC .. VULGAR FRACTION ONE QUARTER +.. |frac34| unicode:: U+000BE .. VULGAR FRACTION THREE QUARTERS +.. |Iacute| unicode:: U+000CD .. LATIN CAPITAL LETTER I WITH ACUTE +.. |iacute| unicode:: U+000ED .. LATIN SMALL LETTER I WITH ACUTE +.. |Icirc| unicode:: U+000CE .. LATIN CAPITAL LETTER I WITH CIRCUMFLEX +.. |icirc| unicode:: U+000EE .. LATIN SMALL LETTER I WITH CIRCUMFLEX +.. |iexcl| unicode:: U+000A1 .. INVERTED EXCLAMATION MARK +.. |Igrave| unicode:: U+000CC .. LATIN CAPITAL LETTER I WITH GRAVE +.. |igrave| unicode:: U+000EC .. LATIN SMALL LETTER I WITH GRAVE +.. |iquest| unicode:: U+000BF .. INVERTED QUESTION MARK +.. |Iuml| unicode:: U+000CF .. LATIN CAPITAL LETTER I WITH DIAERESIS +.. |iuml| unicode:: U+000EF .. LATIN SMALL LETTER I WITH DIAERESIS +.. |laquo| unicode:: U+000AB .. LEFT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |macr| unicode:: U+000AF .. MACRON +.. |micro| unicode:: U+000B5 .. MICRO SIGN +.. |middot| unicode:: U+000B7 .. MIDDLE DOT +.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACE +.. |not| unicode:: U+000AC .. NOT SIGN +.. |Ntilde| unicode:: U+000D1 .. LATIN CAPITAL LETTER N WITH TILDE +.. |ntilde| unicode:: U+000F1 .. LATIN SMALL LETTER N WITH TILDE +.. |Oacute| unicode:: U+000D3 .. LATIN CAPITAL LETTER O WITH ACUTE +.. |oacute| unicode:: U+000F3 .. LATIN SMALL LETTER O WITH ACUTE +.. |Ocirc| unicode:: U+000D4 .. LATIN CAPITAL LETTER O WITH CIRCUMFLEX +.. |ocirc| unicode:: U+000F4 .. LATIN SMALL LETTER O WITH CIRCUMFLEX +.. |Ograve| unicode:: U+000D2 .. LATIN CAPITAL LETTER O WITH GRAVE +.. |ograve| unicode:: U+000F2 .. LATIN SMALL LETTER O WITH GRAVE +.. |ordf| unicode:: U+000AA .. FEMININE ORDINAL INDICATOR +.. |ordm| unicode:: U+000BA .. MASCULINE ORDINAL INDICATOR +.. |Oslash| unicode:: U+000D8 .. LATIN CAPITAL LETTER O WITH STROKE +.. |oslash| unicode:: U+000F8 .. LATIN SMALL LETTER O WITH STROKE +.. |Otilde| unicode:: U+000D5 .. LATIN CAPITAL LETTER O WITH TILDE +.. |otilde| unicode:: U+000F5 .. LATIN SMALL LETTER O WITH TILDE +.. |Ouml| unicode:: U+000D6 .. LATIN CAPITAL LETTER O WITH DIAERESIS +.. |ouml| unicode:: U+000F6 .. LATIN SMALL LETTER O WITH DIAERESIS +.. |para| unicode:: U+000B6 .. PILCROW SIGN +.. |plusmn| unicode:: U+000B1 .. PLUS-MINUS SIGN +.. |pound| unicode:: U+000A3 .. POUND SIGN +.. |raquo| unicode:: U+000BB .. RIGHT-POINTING DOUBLE ANGLE QUOTATION MARK +.. |reg| unicode:: U+000AE .. REGISTERED SIGN +.. |sect| unicode:: U+000A7 .. SECTION SIGN +.. |shy| unicode:: U+000AD .. SOFT HYPHEN +.. |sup1| unicode:: U+000B9 .. SUPERSCRIPT ONE +.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWO +.. |sup3| unicode:: U+000B3 .. SUPERSCRIPT THREE +.. |szlig| unicode:: U+000DF .. LATIN SMALL LETTER SHARP S +.. |THORN| unicode:: U+000DE .. LATIN CAPITAL LETTER THORN +.. |thorn| unicode:: U+000FE .. LATIN SMALL LETTER THORN +.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGN +.. |Uacute| unicode:: U+000DA .. LATIN CAPITAL LETTER U WITH ACUTE +.. |uacute| unicode:: U+000FA .. LATIN SMALL LETTER U WITH ACUTE +.. |Ucirc| unicode:: U+000DB .. LATIN CAPITAL LETTER U WITH CIRCUMFLEX +.. |ucirc| unicode:: U+000FB .. LATIN SMALL LETTER U WITH CIRCUMFLEX +.. |Ugrave| unicode:: U+000D9 .. LATIN CAPITAL LETTER U WITH GRAVE +.. |ugrave| unicode:: U+000F9 .. LATIN SMALL LETTER U WITH GRAVE +.. |uml| unicode:: U+000A8 .. DIAERESIS +.. |Uuml| unicode:: U+000DC .. LATIN CAPITAL LETTER U WITH DIAERESIS +.. |uuml| unicode:: U+000FC .. LATIN SMALL LETTER U WITH DIAERESIS +.. |Yacute| unicode:: U+000DD .. LATIN CAPITAL LETTER Y WITH ACUTE +.. |yacute| unicode:: U+000FD .. LATIN SMALL LETTER Y WITH ACUTE +.. |yen| unicode:: U+000A5 .. YEN SIGN +.. |yuml| unicode:: U+000FF .. LATIN SMALL LETTER Y WITH DIAERESIS diff --git a/aws/dist/docutils/parsers/rst/include/xhtml1-special.txt b/aws/dist/docutils/parsers/rst/include/xhtml1-special.txt new file mode 100644 index 00000000..dc6f5753 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/xhtml1-special.txt @@ -0,0 +1,37 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |bdquo| unicode:: U+0201E .. DOUBLE LOW-9 QUOTATION MARK +.. |circ| unicode:: U+002C6 .. MODIFIER LETTER CIRCUMFLEX ACCENT +.. |Dagger| unicode:: U+02021 .. DOUBLE DAGGER +.. |dagger| unicode:: U+02020 .. DAGGER +.. |emsp| unicode:: U+02003 .. EM SPACE +.. |ensp| unicode:: U+02002 .. EN SPACE +.. |euro| unicode:: U+020AC .. EURO SIGN +.. |gt| unicode:: U+0003E .. GREATER-THAN SIGN +.. |ldquo| unicode:: U+0201C .. LEFT DOUBLE QUOTATION MARK +.. |lrm| unicode:: U+0200E .. LEFT-TO-RIGHT MARK +.. |lsaquo| unicode:: U+02039 .. SINGLE LEFT-POINTING ANGLE QUOTATION MARK +.. |lsquo| unicode:: U+02018 .. LEFT SINGLE QUOTATION MARK +.. |lt| unicode:: U+0003C .. LESS-THAN SIGN +.. |mdash| unicode:: U+02014 .. EM DASH +.. |ndash| unicode:: U+02013 .. EN DASH +.. |OElig| unicode:: U+00152 .. LATIN CAPITAL LIGATURE OE +.. |oelig| unicode:: U+00153 .. LATIN SMALL LIGATURE OE +.. |permil| unicode:: U+02030 .. PER MILLE SIGN +.. |quot| unicode:: U+00022 .. QUOTATION MARK +.. |rdquo| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARK +.. |rlm| unicode:: U+0200F .. RIGHT-TO-LEFT MARK +.. |rsaquo| unicode:: U+0203A .. SINGLE RIGHT-POINTING ANGLE QUOTATION MARK +.. |rsquo| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARK +.. |sbquo| unicode:: U+0201A .. SINGLE LOW-9 QUOTATION MARK +.. |Scaron| unicode:: U+00160 .. LATIN CAPITAL LETTER S WITH CARON +.. |scaron| unicode:: U+00161 .. LATIN SMALL LETTER S WITH CARON +.. |thinsp| unicode:: U+02009 .. THIN SPACE +.. |tilde| unicode:: U+002DC .. SMALL TILDE +.. |Yuml| unicode:: U+00178 .. LATIN CAPITAL LETTER Y WITH DIAERESIS +.. |zwj| unicode:: U+0200D .. ZERO WIDTH JOINER +.. |zwnj| unicode:: U+0200C .. ZERO WIDTH NON-JOINER diff --git a/aws/dist/docutils/parsers/rst/include/xhtml1-symbol.txt b/aws/dist/docutils/parsers/rst/include/xhtml1-symbol.txt new file mode 100644 index 00000000..8fe97f80 --- /dev/null +++ b/aws/dist/docutils/parsers/rst/include/xhtml1-symbol.txt @@ -0,0 +1,130 @@ +.. This data file has been placed in the public domain. +.. Derived from the Unicode character mappings available from + . + Processed by unicode2rstsubs.py, part of Docutils: + . + +.. |alefsym| unicode:: U+02135 .. ALEF SYMBOL +.. |Alpha| unicode:: U+00391 .. GREEK CAPITAL LETTER ALPHA +.. |alpha| unicode:: U+003B1 .. GREEK SMALL LETTER ALPHA +.. |and| unicode:: U+02227 .. LOGICAL AND +.. |ang| unicode:: U+02220 .. ANGLE +.. |asymp| unicode:: U+02248 .. ALMOST EQUAL TO +.. |Beta| unicode:: U+00392 .. GREEK CAPITAL LETTER BETA +.. |beta| unicode:: U+003B2 .. GREEK SMALL LETTER BETA +.. |bull| unicode:: U+02022 .. BULLET +.. |cap| unicode:: U+02229 .. INTERSECTION +.. |Chi| unicode:: U+003A7 .. GREEK CAPITAL LETTER CHI +.. |chi| unicode:: U+003C7 .. GREEK SMALL LETTER CHI +.. |clubs| unicode:: U+02663 .. BLACK CLUB SUIT +.. |cong| unicode:: U+02245 .. APPROXIMATELY EQUAL TO +.. |crarr| unicode:: U+021B5 .. DOWNWARDS ARROW WITH CORNER LEFTWARDS +.. |cup| unicode:: U+0222A .. UNION +.. |dArr| unicode:: U+021D3 .. DOWNWARDS DOUBLE ARROW +.. |darr| unicode:: U+02193 .. DOWNWARDS ARROW +.. |Delta| unicode:: U+00394 .. GREEK CAPITAL LETTER DELTA +.. |delta| unicode:: U+003B4 .. GREEK SMALL LETTER DELTA +.. |diams| unicode:: U+02666 .. BLACK DIAMOND SUIT +.. |empty| unicode:: U+02205 .. EMPTY SET +.. |Epsilon| unicode:: U+00395 .. GREEK CAPITAL LETTER EPSILON +.. |epsilon| unicode:: U+003B5 .. GREEK SMALL LETTER EPSILON +.. |equiv| unicode:: U+02261 .. IDENTICAL TO +.. |Eta| unicode:: U+00397 .. GREEK CAPITAL LETTER ETA +.. |eta| unicode:: U+003B7 .. GREEK SMALL LETTER ETA +.. |exist| unicode:: U+02203 .. THERE EXISTS +.. |fnof| unicode:: U+00192 .. LATIN SMALL LETTER F WITH HOOK +.. |forall| unicode:: U+02200 .. FOR ALL +.. |frasl| unicode:: U+02044 .. FRACTION SLASH +.. |Gamma| unicode:: U+00393 .. GREEK CAPITAL LETTER GAMMA +.. |gamma| unicode:: U+003B3 .. GREEK SMALL LETTER GAMMA +.. |ge| unicode:: U+02265 .. GREATER-THAN OR EQUAL TO +.. |hArr| unicode:: U+021D4 .. LEFT RIGHT DOUBLE ARROW +.. |harr| unicode:: U+02194 .. LEFT RIGHT ARROW +.. |hearts| unicode:: U+02665 .. BLACK HEART SUIT +.. |hellip| unicode:: U+02026 .. HORIZONTAL ELLIPSIS +.. |image| unicode:: U+02111 .. BLACK-LETTER CAPITAL I +.. |infin| unicode:: U+0221E .. INFINITY +.. |int| unicode:: U+0222B .. INTEGRAL +.. |Iota| unicode:: U+00399 .. GREEK CAPITAL LETTER IOTA +.. |iota| unicode:: U+003B9 .. GREEK SMALL LETTER IOTA +.. |isin| unicode:: U+02208 .. ELEMENT OF +.. |Kappa| unicode:: U+0039A .. GREEK CAPITAL LETTER KAPPA +.. |kappa| unicode:: U+003BA .. GREEK SMALL LETTER KAPPA +.. |Lambda| unicode:: U+0039B .. GREEK CAPITAL LETTER LAMDA +.. |lambda| unicode:: U+003BB .. GREEK SMALL LETTER LAMDA +.. |lang| unicode:: U+02329 .. LEFT-POINTING ANGLE BRACKET +.. |lArr| unicode:: U+021D0 .. LEFTWARDS DOUBLE ARROW +.. |larr| unicode:: U+02190 .. LEFTWARDS ARROW +.. |lceil| unicode:: U+02308 .. LEFT CEILING +.. |le| unicode:: U+02264 .. LESS-THAN OR EQUAL TO +.. |lfloor| unicode:: U+0230A .. LEFT FLOOR +.. |lowast| unicode:: U+02217 .. ASTERISK OPERATOR +.. |loz| unicode:: U+025CA .. LOZENGE +.. |minus| unicode:: U+02212 .. MINUS SIGN +.. |Mu| unicode:: U+0039C .. GREEK CAPITAL LETTER MU +.. |mu| unicode:: U+003BC .. GREEK SMALL LETTER MU +.. |nabla| unicode:: U+02207 .. NABLA +.. |ne| unicode:: U+02260 .. NOT EQUAL TO +.. |ni| unicode:: U+0220B .. CONTAINS AS MEMBER +.. |notin| unicode:: U+02209 .. NOT AN ELEMENT OF +.. |nsub| unicode:: U+02284 .. NOT A SUBSET OF +.. |Nu| unicode:: U+0039D .. GREEK CAPITAL LETTER NU +.. |nu| unicode:: U+003BD .. GREEK SMALL LETTER NU +.. |oline| unicode:: U+0203E .. OVERLINE +.. |Omega| unicode:: U+003A9 .. GREEK CAPITAL LETTER OMEGA +.. |omega| unicode:: U+003C9 .. GREEK SMALL LETTER OMEGA +.. |Omicron| unicode:: U+0039F .. GREEK CAPITAL LETTER OMICRON +.. |omicron| unicode:: U+003BF .. GREEK SMALL LETTER OMICRON +.. |oplus| unicode:: U+02295 .. CIRCLED PLUS +.. |or| unicode:: U+02228 .. LOGICAL OR +.. |otimes| unicode:: U+02297 .. CIRCLED TIMES +.. |part| unicode:: U+02202 .. PARTIAL DIFFERENTIAL +.. |perp| unicode:: U+022A5 .. UP TACK +.. |Phi| unicode:: U+003A6 .. GREEK CAPITAL LETTER PHI +.. |phi| unicode:: U+003D5 .. GREEK PHI SYMBOL +.. |Pi| unicode:: U+003A0 .. GREEK CAPITAL LETTER PI +.. |pi| unicode:: U+003C0 .. GREEK SMALL LETTER PI +.. |piv| unicode:: U+003D6 .. GREEK PI SYMBOL +.. |Prime| unicode:: U+02033 .. DOUBLE PRIME +.. |prime| unicode:: U+02032 .. PRIME +.. |prod| unicode:: U+0220F .. N-ARY PRODUCT +.. |prop| unicode:: U+0221D .. PROPORTIONAL TO +.. |Psi| unicode:: U+003A8 .. GREEK CAPITAL LETTER PSI +.. |psi| unicode:: U+003C8 .. GREEK SMALL LETTER PSI +.. |radic| unicode:: U+0221A .. SQUARE ROOT +.. |rang| unicode:: U+0232A .. RIGHT-POINTING ANGLE BRACKET +.. |rArr| unicode:: U+021D2 .. RIGHTWARDS DOUBLE ARROW +.. |rarr| unicode:: U+02192 .. RIGHTWARDS ARROW +.. |rceil| unicode:: U+02309 .. RIGHT CEILING +.. |real| unicode:: U+0211C .. BLACK-LETTER CAPITAL R +.. |rfloor| unicode:: U+0230B .. RIGHT FLOOR +.. |Rho| unicode:: U+003A1 .. GREEK CAPITAL LETTER RHO +.. |rho| unicode:: U+003C1 .. GREEK SMALL LETTER RHO +.. |sdot| unicode:: U+022C5 .. DOT OPERATOR +.. |Sigma| unicode:: U+003A3 .. GREEK CAPITAL LETTER SIGMA +.. |sigma| unicode:: U+003C3 .. GREEK SMALL LETTER SIGMA +.. |sigmaf| unicode:: U+003C2 .. GREEK SMALL LETTER FINAL SIGMA +.. |sim| unicode:: U+0223C .. TILDE OPERATOR +.. |spades| unicode:: U+02660 .. BLACK SPADE SUIT +.. |sub| unicode:: U+02282 .. SUBSET OF +.. |sube| unicode:: U+02286 .. SUBSET OF OR EQUAL TO +.. |sum| unicode:: U+02211 .. N-ARY SUMMATION +.. |sup| unicode:: U+02283 .. SUPERSET OF +.. |supe| unicode:: U+02287 .. SUPERSET OF OR EQUAL TO +.. |Tau| unicode:: U+003A4 .. GREEK CAPITAL LETTER TAU +.. |tau| unicode:: U+003C4 .. GREEK SMALL LETTER TAU +.. |there4| unicode:: U+02234 .. THEREFORE +.. |Theta| unicode:: U+00398 .. GREEK CAPITAL LETTER THETA +.. |theta| unicode:: U+003B8 .. GREEK SMALL LETTER THETA +.. |thetasym| unicode:: U+003D1 .. GREEK THETA SYMBOL +.. |trade| unicode:: U+02122 .. TRADE MARK SIGN +.. |uArr| unicode:: U+021D1 .. UPWARDS DOUBLE ARROW +.. |uarr| unicode:: U+02191 .. UPWARDS ARROW +.. |upsih| unicode:: U+003D2 .. GREEK UPSILON WITH HOOK SYMBOL +.. |Upsilon| unicode:: U+003A5 .. GREEK CAPITAL LETTER UPSILON +.. |upsilon| unicode:: U+003C5 .. GREEK SMALL LETTER UPSILON +.. |weierp| unicode:: U+02118 .. SCRIPT CAPITAL P +.. |Xi| unicode:: U+0039E .. GREEK CAPITAL LETTER XI +.. |xi| unicode:: U+003BE .. GREEK SMALL LETTER XI +.. |Zeta| unicode:: U+00396 .. GREEK CAPITAL LETTER ZETA +.. |zeta| unicode:: U+003B6 .. GREEK SMALL LETTER ZETA diff --git a/aws/dist/docutils/writers/html4css1/html4css1.css b/aws/dist/docutils/writers/html4css1/html4css1.css new file mode 100644 index 00000000..427d33e1 --- /dev/null +++ b/aws/dist/docutils/writers/html4css1/html4css1.css @@ -0,0 +1,349 @@ +/* +:Author: David Goodger (goodger@python.org) +:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $ +:Copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the HTML output of Docutils. + +See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to +customize this style sheet. +*/ + +/* used to remove borders from tables and images */ +.borderless, table.borderless td, table.borderless th { + border: 0 } + +table.borderless td, table.borderless th { + /* Override padding for "table.docutils td" with "! important". + The right padding separates the table cells. */ + padding: 0 0.5em 0 0 ! important } + +.first { + /* Override more specific margin styles with "! important". */ + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +.subscript { + vertical-align: sub; + font-size: smaller } + +.superscript { + vertical-align: super; + font-size: smaller } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +dl.docutils dd { + margin-bottom: 0.5em } + +object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] { + overflow: hidden; +} + +/* Uncomment (and remove this text!) to get bold-faced definition list terms +dl.docutils dt { + font-weight: bold } +*/ + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title, .code .error { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin: 0 0 0.5em 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1.title { + text-align: center } + +h2.subtitle { + text-align: center } + +hr.docutils { + width: 75% } + +img.align-left, .figure.align-left, object.align-left, table.align-left { + clear: left ; + float: left ; + margin-right: 1em } + +img.align-right, .figure.align-right, object.align-right, table.align-right { + clear: right ; + float: right ; + margin-left: 1em } + +img.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left } + +.align-center { + clear: both ; + text-align: center } + +.align-right { + text-align: right } + +/* reset inner alignment in figures */ +div.align-right { + text-align: inherit } + +/* div.align-center * { */ +/* text-align: left } */ + +.align-top { + vertical-align: top } + +.align-middle { + vertical-align: middle } + +.align-bottom { + vertical-align: bottom } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font: inherit } + +pre.literal-block, pre.doctest-block, pre.math, pre.code { + margin-left: 2em ; + margin-right: 2em } + +pre.code .ln { color: grey; } /* line numbers */ +pre.code, code { background-color: #eeeeee } +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +table.docutils th.field-name, table.docinfo th.docinfo-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +/* "booktabs" style (no vertical lines) */ +table.docutils.booktabs { + border: 0px; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.docutils.booktabs * { + border: 0px; +} +table.docutils.booktabs th { + border-bottom: thin solid; + text-align: left; +} + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } diff --git a/aws/dist/docutils/writers/html4css1/template.txt b/aws/dist/docutils/writers/html4css1/template.txt new file mode 100644 index 00000000..2591bce3 --- /dev/null +++ b/aws/dist/docutils/writers/html4css1/template.txt @@ -0,0 +1,8 @@ +%(head_prefix)s +%(head)s +%(stylesheet)s +%(body_prefix)s +%(body_pre_docinfo)s +%(docinfo)s +%(body)s +%(body_suffix)s diff --git a/aws/dist/docutils/writers/html5_polyglot/math.css b/aws/dist/docutils/writers/html5_polyglot/math.css new file mode 100644 index 00000000..e6eec656 --- /dev/null +++ b/aws/dist/docutils/writers/html5_polyglot/math.css @@ -0,0 +1,276 @@ +/* +* math2html: convert LaTeX equations to HTML output. +* +* Copyright (C) 2009,2010 Alex Fernández +* +* Released under the terms of the `2-Clause BSD license'_, in short: +* Copying and distribution of this file, with or without modification, +* are permitted in any medium without royalty provided the copyright +* notice and this notice are preserved. +* This file is offered as-is, without any warranty. +* +* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause +* +* Based on eLyXer: convert LyX source files to HTML output. +* http://elyxer.nongnu.org/ +*/ +/* --end-- +* CSS file for LaTeX formulas. +*/ + +/* Formulas */ +.formula { + text-align: center; + font-family: "Droid Serif", "DejaVu Serif", "STIX", serif; + margin: 1.2em 0; +} +span.formula { + white-space: nowrap; +} +div.formula { + padding: 0.5ex; + margin-left: auto; + margin-right: auto; +} + +/* Basic features */ +a.eqnumber { + display: inline-block; + float: right; + clear: right; + font-weight: bold; +} +span.unknown { + color: #800000; +} +span.ignored, span.arraydef { + display: none; +} +.formula i { + letter-spacing: 0.1ex; +} + +/* Alignment */ +.align-left, .align-l { + text-align: left; +} +.align-right, .align-r { + text-align: right; +} +.align-center, .align-c { + text-align: center; +} + +/* Structures */ +span.overline, span.bar { + text-decoration: overline; +} +.fraction, .fullfraction { + display: inline-block; + vertical-align: middle; + text-align: center; +} +.fraction .fraction { + font-size: 80%; + line-height: 100%; +} +span.numerator { + display: block; +} +span.denominator { + display: block; + padding: 0ex; + border-top: thin solid; +} +sup.numerator, sup.unit { + font-size: 70%; + vertical-align: 80%; +} +sub.denominator, sub.unit { + font-size: 70%; + vertical-align: -20%; +} +span.sqrt { + display: inline-block; + vertical-align: middle; + padding: 0.1ex; +} +sup.root { + font-size: 70%; + position: relative; + left: 1.4ex; +} +span.radical { + display: inline-block; + padding: 0ex; + font-size: 150%; + vertical-align: top; +} +span.root { + display: inline-block; + border-top: thin solid; + padding: 0ex; + vertical-align: middle; +} +span.symbol { + line-height: 125%; + font-size: 125%; +} +span.bigsymbol { + line-height: 150%; + font-size: 150%; +} +span.largesymbol { + font-size: 175%; +} +span.hugesymbol { + font-size: 200%; +} +span.scripts { + display: inline-table; + vertical-align: middle; +} +.script { + display: table-row; + text-align: left; + line-height: 150%; +} +span.limits { + display: inline-table; + vertical-align: middle; +} +.limit { + display: table-row; + line-height: 99%; +} +sup.limit, sub.limit { + line-height: 100%; +} +span.symbolover { + display: inline-block; + text-align: center; + position: relative; + float: right; + right: 100%; + bottom: 0.5em; + width: 0px; +} +span.withsymbol { + display: inline-block; +} +span.symbolunder { + display: inline-block; + text-align: center; + position: relative; + float: right; + right: 80%; + top: 0.3em; + width: 0px; +} + +/* Environments */ +span.array, span.bracketcases, span.binomial, span.environment { + display: inline-table; + text-align: center; + border-collapse: collapse; + margin: 0em; + vertical-align: middle; +} +span.arrayrow, span.binomrow { + display: table-row; + padding: 0ex; + border: 0ex; +} +span.arraycell, span.bracket, span.case, span.binomcell, span.environmentcell { + display: table-cell; + padding: 0ex 0.2ex; + line-height: 99%; + border: 0ex; +} +/* +* CSS file for LaTeX formulas, extra stuff: +* binomials, vertical braces, stackrel, fonts and colors. +*/ + +/* Inline binomials */ +span.binom { + display: inline-block; + vertical-align: middle; + text-align: center; + font-size: 80%; +} +span.binomstack { + display: block; + padding: 0em; +} + +/* Over- and underbraces */ +span.overbrace { + border-top: 2pt solid; +} +span.underbrace { + border-bottom: 2pt solid; +} + +/* Stackrel */ +span.stackrel { + display: inline-block; + text-align: center; +} +span.upstackrel { + display: block; + padding: 0em; + font-size: 80%; + line-height: 64%; + position: relative; + top: 0.15em; + +} +span.downstackrel { + display: block; + vertical-align: bottom; + padding: 0em; +} + +/* Fonts */ +span.mathsf, span.textsf { + font-style: normal; + font-family: sans-serif; +} +span.mathrm, span.textrm { + font-style: normal; + font-family: serif; +} +span.text, span.textnormal { + font-style: normal; +} +span.textipa { + color: #008080; +} +span.fraktur { + font-family: "Lucida Blackletter", eufm10, blackletter; +} +span.blackboard { + font-family: Blackboard, msbm10, serif; +} +span.scriptfont { + font-family: "Monotype Corsiva", "Apple Chancery", "URW Chancery L", cursive; + font-style: italic; +} + +/* Colors */ +span.colorbox { + display: inline-block; + padding: 5px; +} +span.fbox { + display: inline-block; + border: thin solid black; + padding: 2px; +} +span.boxed, span.framebox { + display: inline-block; + border: thin solid black; + padding: 5px; +} + diff --git a/aws/dist/docutils/writers/html5_polyglot/minimal.css b/aws/dist/docutils/writers/html5_polyglot/minimal.css new file mode 100644 index 00000000..a48a3c80 --- /dev/null +++ b/aws/dist/docutils/writers/html5_polyglot/minimal.css @@ -0,0 +1,262 @@ +/* Minimal style sheet for the HTML output of Docutils. */ +/* */ +/* :Author: Günter Milde, based on html4css1.css by David Goodger */ +/* :Id: $Id: minimal.css 8216 2018-06-05 13:37:44Z milde $ */ +/* :Copyright: © 2015 Günter Milde. */ +/* :License: Released under the terms of the `2-Clause BSD license`_, */ +/* in short: */ +/* */ +/* Copying and distribution of this file, with or without modification, */ +/* are permitted in any medium without royalty provided the copyright */ +/* notice and this notice are preserved. */ +/* */ +/* This file is offered as-is, without any warranty. */ +/* */ +/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */ + +/* This CSS2.1_ stylesheet defines rules for Docutils elements without */ +/* HTML equivalent. It is required to make the document semantic visible. */ +/* */ +/* .. _CSS2.1: http://www.w3.org/TR/CSS2 */ +/* .. _validates: http://jigsaw.w3.org/css-validator/validator$link */ + +/* alignment of text and inline objects inside block objects*/ +.align-left { text-align: left; } +.align-right { text-align: right; } +.align-center { clear: both; text-align: center; } +.align-top { vertical-align: top; } +.align-middle { vertical-align: middle; } +.align-bottom { vertical-align: bottom; } + +/* titles */ +h1.title, p.subtitle { + text-align: center; +} +p.admonition-title, +p.topic-title, +p.sidebar-title, +p.rubric, +p.system-message-title { + font-weight: bold; +} +h1 + p.subtitle, +h1 + p.section-subtitle { + font-size: 1.6em; +} +h2 + p.section-subtitle { font-size: 1.28em; } +p.subtitle, +p.section-subtitle, +p.sidebar-subtitle { + font-weight: bold; + margin-top: -0.5em; +} +p.sidebar-title, +p.rubric { + font-size: larger; +} +p.rubric { color: maroon; } +a.toc-backref { + color: black; + text-decoration: none; } + +/* Warnings, Errors */ +div.caution p.admonition-title, +div.attention p.admonition-title, +div.danger p.admonition-title, +div.error p.admonition-title, +div.warning p.admonition-title, +div.system-messages h1, +div.error, +span.problematic, +p.system-message-title { + color: red; +} + +/* inline literals */ +span.docutils.literal { + font-family: monospace; + white-space: pre-wrap; +} +/* do not wraph at hyphens and similar: */ +.literal > span.pre { white-space: nowrap; } + +/* Lists */ + +/* compact and simple lists: no margin between items */ +.simple li, .compact li, +.simple ul, .compact ul, +.simple ol, .compact ol, +.simple > li p, .compact > li p, +dl.simple > dd, dl.compact > dd { + margin-top: 0; + margin-bottom: 0; +} + +/* Table of Contents */ +div.topic.contents { margin: 0; } +div.topic.contents ul { + list-style-type: none; + padding-left: 1.5em; +} + +/* Enumerated Lists */ +ol.arabic { list-style: decimal } +ol.loweralpha { list-style: lower-alpha } +ol.upperalpha { list-style: upper-alpha } +ol.lowerroman { list-style: lower-roman } +ol.upperroman { list-style: upper-roman } + +dt span.classifier { font-style: italic } +dt span.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + +/* Field Lists and drivatives */ +/* bold field name, content starts on the same line */ +dl.field-list > dt, +dl.option-list > dt, +dl.docinfo > dt, +dl.footnote > dt, +dl.citation > dt { + font-weight: bold; + clear: left; + float: left; + margin: 0; + padding: 0; + padding-right: 0.5em; +} +/* Offset for field content (corresponds to the --field-name-limit option) */ +dl.field-list > dd, +dl.option-list > dd, +dl.docinfo > dd { + margin-left: 9em; /* ca. 14 chars in the test examples */ +} +/* start field-body on a new line after long field names */ +dl.field-list > dd > *:first-child, +dl.option-list > dd > *:first-child +{ + display: inline-block; + width: 100%; + margin: 0; +} +/* field names followed by a colon */ +dl.field-list > dt:after, +dl.docinfo > dt:after { + content: ":"; +} + +/* Bibliographic Fields (docinfo) */ +pre.address { font: inherit; } +dd.authors > p { margin: 0; } + +/* Option Lists */ +dl.option-list { margin-left: 40px; } +dl.option-list > dt { font-weight: normal; } +span.option { white-space: nowrap; } + +/* Footnotes and Citations */ +dl.footnote.superscript > dd {margin-left: 1em; } +dl.footnote.brackets > dd {margin-left: 2em; } +dl > dt.label { font-weight: normal; } +a.footnote-reference.brackets:before, +dt.label > span.brackets:before { content: "["; } +a.footnote-reference.brackets:after, +dt.label > span.brackets:after { content: "]"; } +a.footnote-reference.superscript, +dl.footnote.superscript > dt.label { + vertical-align: super; + font-size: smaller; +} +dt.label > span.fn-backref { margin-left: 0.2em; } +dt.label > span.fn-backref > a { font-style: italic; } + +/* Line Blocks */ +div.line-block { display: block; } +div.line-block div.line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 40px; +} + +/* Figures, Images, and Tables */ +.figure.align-left, +img.align-left, +object.align-left, +table.align-left { + margin-right: auto; +} +.figure.align-center, +img.align-center, +object.align-center { + margin-left: auto; + margin-right: auto; + display: block; +} +table.align-center { + margin-left: auto; + margin-right: auto; +} +.figure.align-right, +img.align-right, +object.align-right, +table.align-right { + margin-left: auto; +} +/* reset inner alignment in figures and tables */ +/* div.align-left, div.align-center, div.align-right, */ +table.align-left, table.align-center, table.align-right +{ text-align: inherit } + +/* Admonitions and System Messages */ +div.admonition, +div.system-message, +div.sidebar{ + margin: 40px; + border: medium outset; + padding-right: 1em; + padding-left: 1em; +} + +/* Sidebar */ +div.sidebar { + width: 30%; + max-width: 26em; + float: right; + clear: right; +} + +/* Text Blocks */ +blockquote, +div.topic, +pre.literal-block, +pre.doctest-block, +pre.math, +pre.code { + margin-left: 1.5em; + margin-right: 1.5em +} +pre.code .ln { color: gray; } /* line numbers */ + +/* Tables */ +table { border-collapse: collapse; } +td, th { + border-style: solid; + border-color: silver; + padding: 0 1ex; + border-width: thin; +} +td > p:first-child, th > p:first-child { margin-top: 0; } +td > p, th > p { margin-bottom: 0; } + +table > caption { + text-align: left; + margin-bottom: 0.25em +} + +table.borderless td, table.borderless th { + border: 0; + padding: 0; + padding-right: 0.5em /* separate table cells */ +} diff --git a/aws/dist/docutils/writers/html5_polyglot/plain.css b/aws/dist/docutils/writers/html5_polyglot/plain.css new file mode 100644 index 00000000..79e5b761 --- /dev/null +++ b/aws/dist/docutils/writers/html5_polyglot/plain.css @@ -0,0 +1,281 @@ +/* CSS31_ style sheet for the output of Docutils HTML writers. */ +/* Rules for easy reading and pre-defined style variants. */ +/* */ +/* :Author: Günter Milde, based on html4css1.css by David Goodger */ +/* :Id: $Id: plain.css 8229 2018-11-20 17:47:12Z milde $ */ +/* :Copyright: © 2015 Günter Milde. */ +/* :License: Released under the terms of the `2-Clause BSD license`_, */ +/* in short: */ +/* */ +/* Copying and distribution of this file, with or without modification, */ +/* are permitted in any medium without royalty provided the copyright */ +/* notice and this notice are preserved. */ +/* */ +/* This file is offered as-is, without any warranty. */ +/* */ +/* .. _2-Clause BSD license: http://www.spdx.org/licenses/BSD-2-Clause */ +/* .. _CSS3: http://www.w3.org/TR/CSS3 */ + + +/* Document Structure */ +/* ****************** */ + +/* "page layout" */ +body { + margin: 0; + background-color: #dbdbdb; +} +div.document { + line-height:1.3; + counter-reset: table; + /* counter-reset: figure; */ + /* avoid long lines --> better reading */ + /* OTOH: lines should not be too short because of missing hyphenation, */ + max-width: 50em; + padding: 1px 2%; /* 1px on top avoids grey bar above title (mozilla) */ + margin: auto; + background-color: white; +} + +/* Sections */ + +/* Transitions */ + +hr.docutils { + width: 80%; + margin-top: 1em; + margin-bottom: 1em; + clear: both; +} + +/* Paragraphs */ +/* ========== */ + +/* vertical space (parskip) */ +p, ol, ul, dl, +div.line-block, +table{ + margin-top: 0.5em; + margin-bottom: 0.5em; +} +h1, h2, h3, h4, h5, h6, +dl > dd { + margin-bottom: 0.5em; +} + +/* Lists */ +/* ========== */ + +/* Definition Lists */ + +dl > dd > p:first-child { margin-top: 0; } +/* :last-child is not part of CSS 2.1 (introduced in CSS 3) */ +dl > dd > p:last-child { margin-bottom: 0; } + +/* lists nested in definition lists */ +/* :only-child is not part of CSS 2.1 (introduced in CSS 3) */ +dd > ul:only-child, dd > ol:only-child { padding-left: 1em; } + +/* Description Lists */ +/* styled like in most dictionaries, encyclopedias etc. */ +dl.description > dt { + font-weight: bold; + clear: left; + float: left; + margin: 0; + padding: 0; + padding-right: 0.5em; +} + +/* Field Lists */ + +/* example for custom field-name width */ +dl.field-list.narrow > dd { + margin-left: 5em; +} +/* run-in: start field-body on same line after long field names */ +dl.field-list.run-in > dd p { + display: block; +} + +/* Bibliographic Fields */ + +/* generally, bibliographic fields use special definition list dl.docinfo */ +/* but dedication and abstract are placed into "topic" divs */ +div.abstract p.topic-title { + text-align: center; +} +div.dedication { + margin: 2em 5em; + text-align: center; + font-style: italic; +} +div.dedication p.topic-title { + font-style: normal; +} + +/* Citations */ +dl.citation dt.label { + font-weight: bold; +} +span.fn-backref { + font-weight: normal; +} + +/* Text Blocks */ +/* ============ */ + +/* Literal Blocks */ + +/* Block Quotes */ + +blockquote > table, +div.topic > table { + margin-top: 0; + margin-bottom: 0; +} +blockquote p.attribution, +div.topic p.attribution { + text-align: right; + margin-left: 20%; +} + +/* Tables */ +/* ====== */ + +/* th { vertical-align: bottom; } */ + +table tr { text-align: left; } + +/* "booktabs" style (no vertical lines) */ +table.booktabs { + border: 0; + border-top: 2px solid; + border-bottom: 2px solid; + border-collapse: collapse; +} +table.booktabs * { + border: 0; +} +table.booktabs th { + border-bottom: thin solid; +} + +/* numbered tables (counter defined in div.document) */ +table.numbered > caption:before { + counter-increment: table; + content: "Table " counter(table) ": "; + font-weight: bold; +} + +/* Explicit Markup Blocks */ +/* ====================== */ + +/* Footnotes and Citations */ +/* ----------------------- */ + +/* line on the left */ +dl.footnote { + padding-left: 1ex; + border-left: solid; + border-left-width: thin; +} + +/* Directives */ +/* ---------- */ + +/* Body Elements */ +/* ~~~~~~~~~~~~~ */ + +/* Images and Figures */ + +/* let content flow to the side of aligned images and figures */ +.figure.align-left, +img.align-left, +object.align-left { + display: block; + clear: left; + float: left; + margin-right: 1em +} +.figure.align-right, +img.align-right, +object.align-right { + display: block; + clear: right; + float: right; + margin-left: 1em +} +/* Stop floating sidebars, images and figures at section level 1,2,3 */ +h1, h2, h3 { clear: both; } + +/* Sidebar */ + +/* Move into the margin. In a layout with fixed margins, */ +/* it can be moved into the margin completely. */ +div.sidebar { + width: 30%; + max-width: 26em; + margin-left: 1em; + margin-right: -5.5%; + background-color: #ffffee ; +} + +/* Code */ + +pre.code { padding: 0.7ex } +pre.code, code { background-color: #eeeeee } +pre.code .ln { color: gray; } /* line numbers */ +/* basic highlighting: for a complete scheme, see */ +/* http://docutils.sourceforge.net/sandbox/stylesheets/ */ +pre.code .comment, code .comment { color: #5C6576 } +pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold } +pre.code .literal.string, code .literal.string { color: #0C5404 } +pre.code .name.builtin, code .name.builtin { color: #352B84 } +pre.code .deleted, code .deleted { background-color: #DEB0A1} +pre.code .inserted, code .inserted { background-color: #A3D289} + +/* Math */ +/* styled separately (see math.css for math-output=HTML) */ + +/* Epigraph */ +/* Highlights */ +/* Pull-Quote */ +/* Compound Paragraph */ +/* Container */ + +/* can be styled in a custom stylesheet */ + +/* Document Header and Footer */ + +div.footer, div.header { + clear: both; + font-size: smaller; +} + +/* Inline Markup */ +/* ============= */ + +/* Emphasis */ +/* em */ +/* Strong Emphasis */ +/* strong */ +/* Interpreted Text */ +/* span.interpreted */ +/* Title Reference */ +/* cite */ +/* Inline Literals */ +/* possible values: normal, nowrap, pre, pre-wrap, pre-line */ +/* span.docutils.literal { white-space: pre-wrap; } */ + +/* Hyperlink References */ +a { text-decoration: none; } + +/* External Targets */ +/* span.target.external */ +/* Internal Targets */ +/* span.target.internal */ +/* Footnote References */ +/* a.footnote-reference */ +/* Citation References */ +/* a.citation-reference */ diff --git a/aws/dist/docutils/writers/html5_polyglot/template.txt b/aws/dist/docutils/writers/html5_polyglot/template.txt new file mode 100644 index 00000000..2591bce3 --- /dev/null +++ b/aws/dist/docutils/writers/html5_polyglot/template.txt @@ -0,0 +1,8 @@ +%(head_prefix)s +%(head)s +%(stylesheet)s +%(body_prefix)s +%(body_pre_docinfo)s +%(docinfo)s +%(body)s +%(body_suffix)s diff --git a/aws/dist/docutils/writers/latex2e/default.tex b/aws/dist/docutils/writers/latex2e/default.tex new file mode 100644 index 00000000..8a39d80c --- /dev/null +++ b/aws/dist/docutils/writers/latex2e/default.tex @@ -0,0 +1,14 @@ +$head_prefix% generated by Docutils +\usepackage{cmap} % fix search and cut-and-paste in Acrobat +$requirements +%%% Custom LaTeX preamble +$latex_preamble +%%% User specified packages and stylesheets +$stylesheet +%%% Fallback definitions for Docutils-specific commands +$fallbacks +$pdfsetup +%%% Body +\begin{document} +$titledata$body_pre_docinfo$docinfo$dedication$abstract$body +\end{document} diff --git a/aws/dist/docutils/writers/latex2e/titlepage.tex b/aws/dist/docutils/writers/latex2e/titlepage.tex new file mode 100644 index 00000000..d57deca3 --- /dev/null +++ b/aws/dist/docutils/writers/latex2e/titlepage.tex @@ -0,0 +1,20 @@ +% generated by Docutils +$head_prefix +\usepackage{fixltx2e} % LaTeX patches, \textsubscript +\usepackage{cmap} % fix search and cut-and-paste in Acrobat +$requirements +%%% Custom LaTeX preamble +$latex_preamble +%%% User specified packages and stylesheets +$stylesheet +%%% Fallback definitions for Docutils-specific commands +$fallbacks$pdfsetup +$titledata +%%% Body +\begin{document} +\begin{titlepage} +$body_pre_docinfo$docinfo$dedication$abstract +\thispagestyle{empty} +\end{titlepage} +$body +\end{document} diff --git a/aws/dist/docutils/writers/latex2e/xelatex.tex b/aws/dist/docutils/writers/latex2e/xelatex.tex new file mode 100644 index 00000000..22c1311d --- /dev/null +++ b/aws/dist/docutils/writers/latex2e/xelatex.tex @@ -0,0 +1,21 @@ +$head_prefix% generated by Docutils +% rubber: set program xelatex +\usepackage{fontspec} +% \defaultfontfeatures{Scale=MatchLowercase} +% straight double quotes (defined T1 but missing in TU): +\ifdefined \UnicodeEncodingName + \DeclareTextCommand{\textquotedbl}{\UnicodeEncodingName}{% + {\addfontfeatures{RawFeature=-tlig,Mapping=}\char34}}% +\fi +$requirements +%%% Custom LaTeX preamble +$latex_preamble +%%% User specified packages and stylesheets +$stylesheet +%%% Fallback definitions for Docutils-specific commands +$fallbacks$pdfsetup +$titledata +%%% Body +\begin{document} +$body_pre_docinfo$docinfo$dedication$abstract$body +\end{document} diff --git a/aws/dist/docutils/writers/odf_odt/styles.odt b/aws/dist/docutils/writers/odf_odt/styles.odt new file mode 100644 index 00000000..e17b0072 Binary files /dev/null and b/aws/dist/docutils/writers/odf_odt/styles.odt differ diff --git a/aws/dist/docutils/writers/pep_html/pep.css b/aws/dist/docutils/writers/pep_html/pep.css new file mode 100644 index 00000000..7d6fcafe --- /dev/null +++ b/aws/dist/docutils/writers/pep_html/pep.css @@ -0,0 +1,344 @@ +/* +:Author: David Goodger +:Contact: goodger@python.org +:date: $Date: 2006-05-21 22:44:42 +0200 (So, 21. Mai 2006) $ +:version: $Revision: 4564 $ +:copyright: This stylesheet has been placed in the public domain. + +Default cascading style sheet for the PEP HTML output of Docutils. +*/ + +/* "! important" is used here to override other ``margin-top`` and + ``margin-bottom`` styles that are later in the stylesheet or + more specific. See http://www.w3.org/TR/CSS1#the-cascade */ +.first { + margin-top: 0 ! important } + +.last, .with-subtitle { + margin-bottom: 0 ! important } + +.hidden { + display: none } + +.navigation { + width: 100% ; + background: #99ccff ; + margin-top: 0px ; + margin-bottom: 0px } + +.navigation .navicon { + width: 150px ; + height: 35px } + +.navigation .textlinks { + padding-left: 1em ; + text-align: left } + +.navigation td, .navigation th { + padding-left: 0em ; + padding-right: 0em ; + vertical-align: middle } + +.rfc2822 { + margin-top: 0.5em ; + margin-left: 0.5em ; + margin-right: 0.5em ; + margin-bottom: 0em } + +.rfc2822 td { + text-align: left } + +.rfc2822 th.field-name { + text-align: right ; + font-family: sans-serif ; + padding-right: 0.5em ; + font-weight: bold ; + margin-bottom: 0em } + +a.toc-backref { + text-decoration: none ; + color: black } + +blockquote.epigraph { + margin: 2em 5em ; } + +body { + margin: 0px ; + margin-bottom: 1em ; + padding: 0px } + +dl.docutils dd { + margin-bottom: 0.5em } + +div.section { + margin-left: 1em ; + margin-right: 1em ; + margin-bottom: 1.5em } + +div.section div.section { + margin-left: 0em ; + margin-right: 0em ; + margin-top: 1.5em } + +div.abstract { + margin: 2em 5em } + +div.abstract p.topic-title { + font-weight: bold ; + text-align: center } + +div.admonition, div.attention, div.caution, div.danger, div.error, +div.hint, div.important, div.note, div.tip, div.warning { + margin: 2em ; + border: medium outset ; + padding: 1em } + +div.admonition p.admonition-title, div.hint p.admonition-title, +div.important p.admonition-title, div.note p.admonition-title, +div.tip p.admonition-title { + font-weight: bold ; + font-family: sans-serif } + +div.attention p.admonition-title, div.caution p.admonition-title, +div.danger p.admonition-title, div.error p.admonition-title, +div.warning p.admonition-title { + color: red ; + font-weight: bold ; + font-family: sans-serif } + +/* Uncomment (and remove this text!) to get reduced vertical space in + compound paragraphs. +div.compound .compound-first, div.compound .compound-middle { + margin-bottom: 0.5em } + +div.compound .compound-last, div.compound .compound-middle { + margin-top: 0.5em } +*/ + +div.dedication { + margin: 2em 5em ; + text-align: center ; + font-style: italic } + +div.dedication p.topic-title { + font-weight: bold ; + font-style: normal } + +div.figure { + margin-left: 2em ; + margin-right: 2em } + +div.footer, div.header { + clear: both; + font-size: smaller } + +div.footer { + margin-left: 1em ; + margin-right: 1em } + +div.line-block { + display: block ; + margin-top: 1em ; + margin-bottom: 1em } + +div.line-block div.line-block { + margin-top: 0 ; + margin-bottom: 0 ; + margin-left: 1.5em } + +div.sidebar { + margin-left: 1em ; + border: medium outset ; + padding: 1em ; + background-color: #ffffee ; + width: 40% ; + float: right ; + clear: right } + +div.sidebar p.rubric { + font-family: sans-serif ; + font-size: medium } + +div.system-messages { + margin: 5em } + +div.system-messages h1 { + color: red } + +div.system-message { + border: medium outset ; + padding: 1em } + +div.system-message p.system-message-title { + color: red ; + font-weight: bold } + +div.topic { + margin: 2em } + +h1.section-subtitle, h2.section-subtitle, h3.section-subtitle, +h4.section-subtitle, h5.section-subtitle, h6.section-subtitle { + margin-top: 0.4em } + +h1 { + font-family: sans-serif ; + font-size: large } + +h2 { + font-family: sans-serif ; + font-size: medium } + +h3 { + font-family: sans-serif ; + font-size: small } + +h4 { + font-family: sans-serif ; + font-style: italic ; + font-size: small } + +h5 { + font-family: sans-serif; + font-size: x-small } + +h6 { + font-family: sans-serif; + font-style: italic ; + font-size: x-small } + +hr.docutils { + width: 75% } + +img.align-left { + clear: left } + +img.align-right { + clear: right } + +img.borderless { + border: 0 } + +ol.simple, ul.simple { + margin-bottom: 1em } + +ol.arabic { + list-style: decimal } + +ol.loweralpha { + list-style: lower-alpha } + +ol.upperalpha { + list-style: upper-alpha } + +ol.lowerroman { + list-style: lower-roman } + +ol.upperroman { + list-style: upper-roman } + +p.attribution { + text-align: right ; + margin-left: 50% } + +p.caption { + font-style: italic } + +p.credits { + font-style: italic ; + font-size: smaller } + +p.label { + white-space: nowrap } + +p.rubric { + font-weight: bold ; + font-size: larger ; + color: maroon ; + text-align: center } + +p.sidebar-title { + font-family: sans-serif ; + font-weight: bold ; + font-size: larger } + +p.sidebar-subtitle { + font-family: sans-serif ; + font-weight: bold } + +p.topic-title { + font-family: sans-serif ; + font-weight: bold } + +pre.address { + margin-bottom: 0 ; + margin-top: 0 ; + font-family: serif ; + font-size: 100% } + +pre.literal-block, pre.doctest-block { + margin-left: 2em ; + margin-right: 2em } + +span.classifier { + font-family: sans-serif ; + font-style: oblique } + +span.classifier-delimiter { + font-family: sans-serif ; + font-weight: bold } + +span.interpreted { + font-family: sans-serif } + +span.option { + white-space: nowrap } + +span.option-argument { + font-style: italic } + +span.pre { + white-space: pre } + +span.problematic { + color: red } + +span.section-subtitle { + /* font-size relative to parent (h1..h6 element) */ + font-size: 80% } + +table.citation { + border-left: solid 1px gray; + margin-left: 1px } + +table.docinfo { + margin: 2em 4em } + +table.docutils { + margin-top: 0.5em ; + margin-bottom: 0.5em } + +table.footnote { + border-left: solid 1px black; + margin-left: 1px } + +table.docutils td, table.docutils th, +table.docinfo td, table.docinfo th { + padding-left: 0.5em ; + padding-right: 0.5em ; + vertical-align: top } + +td.num { + text-align: right } + +th.field-name { + font-weight: bold ; + text-align: left ; + white-space: nowrap ; + padding-left: 0 } + +h1 tt.docutils, h2 tt.docutils, h3 tt.docutils, +h4 tt.docutils, h5 tt.docutils, h6 tt.docutils { + font-size: 100% } + +ul.auto-toc { + list-style-type: none } diff --git a/aws/dist/docutils/writers/pep_html/template.txt b/aws/dist/docutils/writers/pep_html/template.txt new file mode 100644 index 00000000..62c07a87 --- /dev/null +++ b/aws/dist/docutils/writers/pep_html/template.txt @@ -0,0 +1,29 @@ + + + + + + + + PEP %(pep)s -- %(title)s + %(stylesheet)s + + + + +
    + +[Python] +[Python Home] +[PEP Index] +[PEP Source] +
    +
    +%(body)s +%(body_suffix)s diff --git a/aws/dist/docutils/writers/s5_html/themes/README.txt b/aws/dist/docutils/writers/s5_html/themes/README.txt new file mode 100644 index 00000000..2e01b51e --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/README.txt @@ -0,0 +1,6 @@ +Except where otherwise noted (default/iepngfix.htc), all files in this +directory have been released into the Public Domain. + +These files are based on files from S5 1.1, released into the Public +Domain by Eric Meyer. For further details, please see +http://www.meyerweb.com/eric/tools/s5/credits.html. diff --git a/aws/dist/docutils/writers/s5_html/themes/big-black/__base__ b/aws/dist/docutils/writers/s5_html/themes/big-black/__base__ new file mode 100644 index 00000000..f08be9ad --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/big-black/__base__ @@ -0,0 +1,2 @@ +# base theme of this theme: +big-white diff --git a/aws/dist/docutils/writers/s5_html/themes/big-black/framing.css b/aws/dist/docutils/writers/s5_html/themes/big-black/framing.css new file mode 100644 index 00000000..5a31113f --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/big-black/framing.css @@ -0,0 +1,25 @@ +/* The following styles size, place, and layer the slide components. + Edit these if you want to change the overall slide layout. + The commented lines can be uncommented (and modified, if necessary) + to help you with the rearrangement process. */ + +/* target = 1024x768 */ + +div#header, div#footer, .slide {width: 100%; top: 0; left: 0;} +div#header {top: 0; z-index: 1;} +div#footer {display:none;} +.slide {top: 0; width: 92%; padding: 0.1em 4% 4%; z-index: 2;} +/* list-style: none;} */ +div#controls {left: 50%; bottom: 0; width: 50%; z-index: 100;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0;} +#currentSlide {position: absolute; width: 10%; left: 45%; bottom: 1em; + z-index: 10;} +html>body #currentSlide {position: fixed;} + +/* +div#header {background: #FCC;} +div#footer {background: #CCF;} +div#controls {background: #BBD;} +div#currentSlide {background: #FFC;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/big-black/pretty.css b/aws/dist/docutils/writers/s5_html/themes/big-black/pretty.css new file mode 100644 index 00000000..82bcc9dc --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/big-black/pretty.css @@ -0,0 +1,109 @@ +/* This file has been placed in the public domain. */ +/* Following are the presentation styles -- edit away! */ + +html, body {margin: 0; padding: 0;} +body {background: black; color: white;} +:link, :visited {text-decoration: none; color: cyan;} +#controls :active {color: #888 !important;} +#controls :focus {outline: 1px dotted #CCC;} + +blockquote {padding: 0 2em 0.5em; margin: 0 1.5em 0.5em;} +blockquote p {margin: 0;} + +kbd {font-weight: bold; font-size: 1em;} +sup {font-size: smaller; line-height: 1px;} + +.slide pre {padding: 0; margin-left: 0; margin-right: 0; font-size: 90%;} +.slide ul ul li {list-style: square;} +.slide img.leader {display: block; margin: 0 auto;} +.slide tt {font-size: 90%;} + +.slide {font-size: 3em; font-family: sans-serif; font-weight: bold;} +.slide h1 {padding-top: 0; z-index: 1; margin: 0; font-size: 120%;} +.slide h2 {font-size: 110%;} +.slide h3 {font-size: 105%;} +h1 abbr {font-variant: small-caps;} + +div#controls {position: absolute; left: 50%; bottom: 0; + width: 50%; text-align: right; font: bold 0.9em sans-serif;} +html>body div#controls {position: fixed; padding: 0 0 1em 0; top: auto;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0; padding: 0;} +#controls #navLinks a {padding: 0; margin: 0 0.5em; + border: none; color: #888; cursor: pointer;} +#controls #navList {height: 1em;} +#controls #navList #jumplist {position: absolute; bottom: 0; right: 0; + background: black; color: #CCC;} + +#currentSlide {text-align: center; font-size: 0.5em; color: #AAA; + font-family: sans-serif; font-weight: bold;} + +#slide0 h1 {position: static; margin: 0 0 0.5em; padding-top: 0.3em; top: 0; + font-size: 150%; white-space: normal; background: transparent;} +#slide0 h2 {font: 110%; font-style: italic; color: gray;} +#slide0 h3 {margin-top: 1.5em; font-size: 1.5em;} +#slide0 h4 {margin-top: 0; font-size: 1em;} + +ul.urls {list-style: none; display: inline; margin: 0;} +.urls li {display: inline; margin: 0;} +.external {border-bottom: 1px dotted gray;} +html>body .external {border-bottom: none;} +.external:after {content: " \274F"; font-size: smaller; color: #FCC;} + +.incremental, .incremental *, .incremental *:after { + color: black; visibility: visible; border: 0;} +img.incremental {visibility: hidden;} +.slide .current {color: lime;} + +.slide-display {display: inline ! important;} + +.huge {font-size: 150%;} +.big {font-size: 120%;} +.small {font-size: 75%;} +.tiny {font-size: 50%;} +.huge tt, .big tt, .small tt, .tiny tt {font-size: 115%;} +.huge pre, .big pre, .small pre, .tiny pre {font-size: 115%;} + +.maroon {color: maroon;} +.red {color: red;} +.magenta {color: magenta;} +.fuchsia {color: fuchsia;} +.pink {color: #FAA;} +.orange {color: orange;} +.yellow {color: yellow;} +.lime {color: lime;} +.green {color: green;} +.olive {color: olive;} +.teal {color: teal;} +.cyan {color: cyan;} +.aqua {color: aqua;} +.blue {color: blue;} +.navy {color: navy;} +.purple {color: purple;} +.black {color: black;} +.gray {color: gray;} +.silver {color: silver;} +.white {color: white;} + +.left {text-align: left ! important;} +.center {text-align: center ! important;} +.right {text-align: right ! important;} + +.animation {position: relative; margin: 1em 0; padding: 0;} +.animation img {position: absolute;} + +/* Docutils-specific overrides */ + +.slide table.docinfo {margin: 0.5em 0 0.5em 1em;} + +div.sidebar {background-color: black;} + +pre.literal-block, pre.doctest-block {background-color: black;} + +tt.docutils {background-color: black;} + +/* diagnostics */ +/* +li:after {content: " [" attr(class) "]"; color: #F88;} +div:before {content: "[" attr(class) "]"; color: #F88;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/big-white/framing.css b/aws/dist/docutils/writers/s5_html/themes/big-white/framing.css new file mode 100644 index 00000000..cd343432 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/big-white/framing.css @@ -0,0 +1,24 @@ +/* This file has been placed in the public domain. */ +/* The following styles size, place, and layer the slide components. + Edit these if you want to change the overall slide layout. + The commented lines can be uncommented (and modified, if necessary) + to help you with the rearrangement process. */ + +/* target = 1024x768 */ + +div#header, div#footer, .slide {width: 100%; top: 0; left: 0;} +div#footer {display:none;} +.slide {top: 0; width: 92%; padding: 0.25em 4% 4%; z-index: 2;} +div#controls {left: 50%; bottom: 0; width: 50%; z-index: 100;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0;} +#currentSlide {position: absolute; width: 10%; left: 45%; bottom: 1em; + z-index: 10;} +html>body #currentSlide {position: fixed;} + +/* +div#header {background: #FCC;} +div#footer {background: #CCF;} +div#controls {background: #BBD;} +div#currentSlide {background: #FFC;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/big-white/pretty.css b/aws/dist/docutils/writers/s5_html/themes/big-white/pretty.css new file mode 100644 index 00000000..c5e2fcf9 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/big-white/pretty.css @@ -0,0 +1,107 @@ +/* This file has been placed in the public domain. */ +/* Following are the presentation styles -- edit away! */ + +html, body {margin: 0; padding: 0;} +body {background: white; color: black;} +:link, :visited {text-decoration: none; color: #00C;} +#controls :active {color: #88A !important;} +#controls :focus {outline: 1px dotted #227;} + +blockquote {padding: 0 2em 0.5em; margin: 0 1.5em 0.5em;} +blockquote p {margin: 0;} + +kbd {font-weight: bold; font-size: 1em;} +sup {font-size: smaller; line-height: 1px;} + +.slide pre {padding: 0; margin-left: 0; margin-right: 0; font-size: 90%;} +.slide ul ul li {list-style: square;} +.slide img.leader {display: block; margin: 0 auto;} +.slide tt {font-size: 90%;} + +.slide {font-size: 3em; font-family: sans-serif; font-weight: bold;} +.slide h1 {padding-top: 0; z-index: 1; margin: 0; font-size: 120%;} +.slide h2 {font-size: 110%;} +.slide h3 {font-size: 105%;} +h1 abbr {font-variant: small-caps;} + +div#controls {position: absolute; left: 50%; bottom: 0; + width: 50%; text-align: right; font: bold 0.9em sans-serif;} +html>body div#controls {position: fixed; padding: 0 0 1em 0; top: auto;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0; padding: 0;} +#controls #navLinks a {padding: 0; margin: 0 0.5em; + border: none; color: #005; cursor: pointer;} +#controls #navList {height: 1em;} +#controls #navList #jumplist {position: absolute; bottom: 0; right: 0; + background: #DDD; color: #227;} + +#currentSlide {text-align: center; font-size: 0.5em; color: #444; + font-family: sans-serif; font-weight: bold;} + +#slide0 h1 {position: static; margin: 0 0 0.5em; padding-top: 0.3em; top: 0; + font-size: 150%; white-space: normal; background: transparent;} +#slide0 h2 {font: 110%; font-style: italic; color: gray;} +#slide0 h3 {margin-top: 1.5em; font-size: 1.5em;} +#slide0 h4 {margin-top: 0; font-size: 1em;} + +ul.urls {list-style: none; display: inline; margin: 0;} +.urls li {display: inline; margin: 0;} +.external {border-bottom: 1px dotted gray;} +html>body .external {border-bottom: none;} +.external:after {content: " \274F"; font-size: smaller; color: #77B;} + +.incremental, .incremental *, .incremental *:after { + color: white; visibility: visible; border: 0;} +img.incremental {visibility: hidden;} +.slide .current {color: green;} + +.slide-display {display: inline ! important;} + +.huge {font-size: 150%;} +.big {font-size: 120%;} +.small {font-size: 75%;} +.tiny {font-size: 50%;} +.huge tt, .big tt, .small tt, .tiny tt {font-size: 115%;} +.huge pre, .big pre, .small pre, .tiny pre {font-size: 115%;} + +.maroon {color: maroon;} +.red {color: red;} +.magenta {color: magenta;} +.fuchsia {color: fuchsia;} +.pink {color: #FAA;} +.orange {color: orange;} +.yellow {color: yellow;} +.lime {color: lime;} +.green {color: green;} +.olive {color: olive;} +.teal {color: teal;} +.cyan {color: cyan;} +.aqua {color: aqua;} +.blue {color: blue;} +.navy {color: navy;} +.purple {color: purple;} +.black {color: black;} +.gray {color: gray;} +.silver {color: silver;} +.white {color: white;} + +.left {text-align: left ! important;} +.center {text-align: center ! important;} +.right {text-align: right ! important;} + +.animation {position: relative; margin: 1em 0; padding: 0;} +.animation img {position: absolute;} + +/* Docutils-specific overrides */ + +.slide table.docinfo {margin: 0.5em 0 0.5em 1em;} + +pre.literal-block, pre.doctest-block {background-color: white;} + +tt.docutils {background-color: white;} + +/* diagnostics */ +/* +li:after {content: " [" attr(class) "]"; color: #F88;} +div:before {content: "[" attr(class) "]"; color: #F88;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/default/blank.gif b/aws/dist/docutils/writers/s5_html/themes/default/blank.gif new file mode 100644 index 00000000..75b945d2 Binary files /dev/null and b/aws/dist/docutils/writers/s5_html/themes/default/blank.gif differ diff --git a/aws/dist/docutils/writers/s5_html/themes/default/framing.css b/aws/dist/docutils/writers/s5_html/themes/default/framing.css new file mode 100644 index 00000000..c4727f30 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/framing.css @@ -0,0 +1,25 @@ +/* This file has been placed in the public domain. */ +/* The following styles size, place, and layer the slide components. + Edit these if you want to change the overall slide layout. + The commented lines can be uncommented (and modified, if necessary) + to help you with the rearrangement process. */ + +/* target = 1024x768 */ + +div#header, div#footer, .slide {width: 100%; top: 0; left: 0;} +div#header {position: fixed; top: 0; height: 3em; z-index: 1;} +div#footer {top: auto; bottom: 0; height: 2.5em; z-index: 5;} +.slide {top: 0; width: 92%; padding: 2.5em 4% 4%; z-index: 2;} +div#controls {left: 50%; bottom: 0; width: 50%; z-index: 100;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0;} +#currentSlide {position: absolute; width: 10%; left: 45%; bottom: 1em; + z-index: 10;} +html>body #currentSlide {position: fixed;} + +/* +div#header {background: #FCC;} +div#footer {background: #CCF;} +div#controls {background: #BBD;} +div#currentSlide {background: #FFC;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/default/iepngfix.htc b/aws/dist/docutils/writers/s5_html/themes/default/iepngfix.htc new file mode 100644 index 00000000..9f3d628b --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/iepngfix.htc @@ -0,0 +1,42 @@ + + + + + \ No newline at end of file diff --git a/aws/dist/docutils/writers/s5_html/themes/default/opera.css b/aws/dist/docutils/writers/s5_html/themes/default/opera.css new file mode 100644 index 00000000..c9d1148b --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/opera.css @@ -0,0 +1,8 @@ +/* This file has been placed in the public domain. */ +/* DO NOT CHANGE THESE unless you really want to break Opera Show */ +.slide { + visibility: visible !important; + position: static !important; + page-break-before: always; +} +#slide0 {page-break-before: avoid;} diff --git a/aws/dist/docutils/writers/s5_html/themes/default/outline.css b/aws/dist/docutils/writers/s5_html/themes/default/outline.css new file mode 100644 index 00000000..fa767e22 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/outline.css @@ -0,0 +1,16 @@ +/* This file has been placed in the public domain. */ +/* Don't change this unless you want the layout stuff to show up in the + outline view! */ + +.layout div, #footer *, #controlForm * {display: none;} +#footer, #controls, #controlForm, #navLinks, #toggle { + display: block; visibility: visible; margin: 0; padding: 0;} +#toggle {float: right; padding: 0.5em;} +html>body #toggle {position: fixed; top: 0; right: 0;} + +/* making the outline look pretty-ish */ + +#slide0 h1, #slide0 h2, #slide0 h3, #slide0 h4 {border: none; margin: 0;} +#toggle {border: 1px solid; border-width: 0 0 1px 1px; background: #FFF;} + +.outline {display: inline ! important;} diff --git a/aws/dist/docutils/writers/s5_html/themes/default/pretty.css b/aws/dist/docutils/writers/s5_html/themes/default/pretty.css new file mode 100644 index 00000000..1cede72d --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/pretty.css @@ -0,0 +1,120 @@ +/* This file has been placed in the public domain. */ +/* Following are the presentation styles -- edit away! */ + +html, body {margin: 0; padding: 0;} +body {background: white; color: black;} +/* Replace the background style above with the style below (and again for + div#header) for a graphic: */ +/* background: white url(bodybg.gif) -16px 0 no-repeat; */ +:link, :visited {text-decoration: none; color: #00C;} +#controls :active {color: #88A !important;} +#controls :focus {outline: 1px dotted #227;} +h1, h2, h3, h4 {font-size: 100%; margin: 0; padding: 0; font-weight: inherit;} + +blockquote {padding: 0 2em 0.5em; margin: 0 1.5em 0.5em;} +blockquote p {margin: 0;} + +kbd {font-weight: bold; font-size: 1em;} +sup {font-size: smaller; line-height: 1px;} + +.slide pre {padding: 0; margin-left: 0; margin-right: 0; font-size: 90%;} +.slide ul ul li {list-style: square;} +.slide img.leader {display: block; margin: 0 auto;} +.slide tt {font-size: 90%;} + +div#header, div#footer {background: #005; color: #AAB; font-family: sans-serif;} +/* background: #005 url(bodybg.gif) -16px 0 no-repeat; */ +div#footer {font-size: 0.5em; font-weight: bold; padding: 1em 0;} +#footer h1 {display: block; padding: 0 1em;} +#footer h2 {display: block; padding: 0.8em 1em 0;} + +.slide {font-size: 1.2em;} +.slide h1 {position: absolute; top: 0.45em; z-index: 1; + margin: 0; padding-left: 0.7em; white-space: nowrap; + font: bold 150% sans-serif; color: #DDE; background: #005;} +.slide h2 {font: bold 120%/1em sans-serif; padding-top: 0.5em;} +.slide h3 {font: bold 100% sans-serif; padding-top: 0.5em;} +h1 abbr {font-variant: small-caps;} + +div#controls {position: absolute; left: 50%; bottom: 0; + width: 50%; text-align: right; font: bold 0.9em sans-serif;} +html>body div#controls {position: fixed; padding: 0 0 1em 0; top: auto;} +div#controls form {position: absolute; bottom: 0; right: 0; width: 100%; + margin: 0; padding: 0;} +#controls #navLinks a {padding: 0; margin: 0 0.5em; + background: #005; border: none; color: #779; cursor: pointer;} +#controls #navList {height: 1em;} +#controls #navList #jumplist {position: absolute; bottom: 0; right: 0; + background: #DDD; color: #227;} + +#currentSlide {text-align: center; font-size: 0.5em; color: #449; + font-family: sans-serif; font-weight: bold;} + +#slide0 {padding-top: 1.5em} +#slide0 h1 {position: static; margin: 1em 0 0; padding: 0; color: #000; + font: bold 2em sans-serif; white-space: normal; background: transparent;} +#slide0 h2 {font: bold italic 1em sans-serif; margin: 0.25em;} +#slide0 h3 {margin-top: 1.5em; font-size: 1.5em;} +#slide0 h4 {margin-top: 0; font-size: 1em;} + +ul.urls {list-style: none; display: inline; margin: 0;} +.urls li {display: inline; margin: 0;} +.external {border-bottom: 1px dotted gray;} +html>body .external {border-bottom: none;} +.external:after {content: " \274F"; font-size: smaller; color: #77B;} + +.incremental, .incremental *, .incremental *:after {visibility: visible; + color: white; border: 0;} +img.incremental {visibility: hidden;} +.slide .current {color: green;} + +.slide-display {display: inline ! important;} + +.huge {font-family: sans-serif; font-weight: bold; font-size: 150%;} +.big {font-family: sans-serif; font-weight: bold; font-size: 120%;} +.small {font-size: 75%;} +.tiny {font-size: 50%;} +.huge tt, .big tt, .small tt, .tiny tt {font-size: 115%;} +.huge pre, .big pre, .small pre, .tiny pre {font-size: 115%;} + +.maroon {color: maroon;} +.red {color: red;} +.magenta {color: magenta;} +.fuchsia {color: fuchsia;} +.pink {color: #FAA;} +.orange {color: orange;} +.yellow {color: yellow;} +.lime {color: lime;} +.green {color: green;} +.olive {color: olive;} +.teal {color: teal;} +.cyan {color: cyan;} +.aqua {color: aqua;} +.blue {color: blue;} +.navy {color: navy;} +.purple {color: purple;} +.black {color: black;} +.gray {color: gray;} +.silver {color: silver;} +.white {color: white;} + +.left {text-align: left ! important;} +.center {text-align: center ! important;} +.right {text-align: right ! important;} + +.animation {position: relative; margin: 1em 0; padding: 0;} +.animation img {position: absolute;} + +/* Docutils-specific overrides */ + +.slide table.docinfo {margin: 1em 0 0.5em 2em;} + +pre.literal-block, pre.doctest-block {background-color: white;} + +tt.docutils {background-color: white;} + +/* diagnostics */ +/* +li:after {content: " [" attr(class) "]"; color: #F88;} +div:before {content: "[" attr(class) "]"; color: #F88;} +*/ diff --git a/aws/dist/docutils/writers/s5_html/themes/default/print.css b/aws/dist/docutils/writers/s5_html/themes/default/print.css new file mode 100644 index 00000000..9d057cc8 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/print.css @@ -0,0 +1,24 @@ +/* This file has been placed in the public domain. */ +/* The following rule is necessary to have all slides appear in print! + DO NOT REMOVE IT! */ +.slide, ul {page-break-inside: avoid; visibility: visible !important;} +h1 {page-break-after: avoid;} + +body {font-size: 12pt; background: white;} +* {color: black;} + +#slide0 h1 {font-size: 200%; border: none; margin: 0.5em 0 0.25em;} +#slide0 h3 {margin: 0; padding: 0;} +#slide0 h4 {margin: 0 0 0.5em; padding: 0;} +#slide0 {margin-bottom: 3em;} + +#header {display: none;} +#footer h1 {margin: 0; border-bottom: 1px solid; color: gray; + font-style: italic;} +#footer h2, #controls {display: none;} + +.print {display: inline ! important;} + +/* The following rule keeps the layout stuff out of print. + Remove at your own risk! */ +.layout, .layout * {display: none !important;} diff --git a/aws/dist/docutils/writers/s5_html/themes/default/s5-core.css b/aws/dist/docutils/writers/s5_html/themes/default/s5-core.css new file mode 100644 index 00000000..6965f5e8 --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/s5-core.css @@ -0,0 +1,11 @@ +/* This file has been placed in the public domain. */ +/* Do not edit or override these styles! + The system will likely break if you do. */ + +div#header, div#footer, div#controls, .slide {position: absolute;} +html>body div#header, html>body div#footer, + html>body div#controls, html>body .slide {position: fixed;} +.handout {display: none;} +.layout {display: block;} +.slide, .hideme, .incremental {visibility: hidden;} +#slide0 {visibility: visible;} diff --git a/aws/dist/docutils/writers/s5_html/themes/default/slides.css b/aws/dist/docutils/writers/s5_html/themes/default/slides.css new file mode 100644 index 00000000..82bdc0ee --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/slides.css @@ -0,0 +1,10 @@ +/* This file has been placed in the public domain. */ + +/* required to make the slide show run at all */ +@import url(s5-core.css); + +/* sets basic placement and size of slide components */ +@import url(framing.css); + +/* styles that make the slides look good */ +@import url(pretty.css); diff --git a/aws/dist/docutils/writers/s5_html/themes/default/slides.js b/aws/dist/docutils/writers/s5_html/themes/default/slides.js new file mode 100644 index 00000000..81e04e5d --- /dev/null +++ b/aws/dist/docutils/writers/s5_html/themes/default/slides.js @@ -0,0 +1,558 @@ +// S5 v1.1 slides.js -- released into the Public Domain +// Modified for Docutils (http://docutils.sf.net) by David Goodger +// +// Please see http://www.meyerweb.com/eric/tools/s5/credits.html for +// information about all the wonderful and talented contributors to this code! + +var undef; +var slideCSS = ''; +var snum = 0; +var smax = 1; +var slideIDs = new Array(); +var incpos = 0; +var number = undef; +var s5mode = true; +var defaultView = 'slideshow'; +var controlVis = 'visible'; + +var isIE = navigator.appName == 'Microsoft Internet Explorer' ? 1 : 0; +var isOp = navigator.userAgent.indexOf('Opera') > -1 ? 1 : 0; +var isGe = navigator.userAgent.indexOf('Gecko') > -1 && navigator.userAgent.indexOf('Safari') < 1 ? 1 : 0; + +function hasClass(object, className) { + if (!object.className) return false; + return (object.className.search('(^|\\s)' + className + '(\\s|$)') != -1); +} + +function hasValue(object, value) { + if (!object) return false; + return (object.search('(^|\\s)' + value + '(\\s|$)') != -1); +} + +function removeClass(object,className) { + if (!object) return; + object.className = object.className.replace(new RegExp('(^|\\s)'+className+'(\\s|$)'), RegExp.$1+RegExp.$2); +} + +function addClass(object,className) { + if (!object || hasClass(object, className)) return; + if (object.className) { + object.className += ' '+className; + } else { + object.className = className; + } +} + +function GetElementsWithClassName(elementName,className) { + var allElements = document.getElementsByTagName(elementName); + var elemColl = new Array(); + for (var i = 0; i< allElements.length; i++) { + if (hasClass(allElements[i], className)) { + elemColl[elemColl.length] = allElements[i]; + } + } + return elemColl; +} + +function isParentOrSelf(element, id) { + if (element == null || element.nodeName=='BODY') return false; + else if (element.id == id) return true; + else return isParentOrSelf(element.parentNode, id); +} + +function nodeValue(node) { + var result = ""; + if (node.nodeType == 1) { + var children = node.childNodes; + for (var i = 0; i < children.length; ++i) { + result += nodeValue(children[i]); + } + } + else if (node.nodeType == 3) { + result = node.nodeValue; + } + return(result); +} + +function slideLabel() { + var slideColl = GetElementsWithClassName('*','slide'); + var list = document.getElementById('jumplist'); + smax = slideColl.length; + for (var n = 0; n < smax; n++) { + var obj = slideColl[n]; + + var did = 'slide' + n.toString(); + if (obj.getAttribute('id')) { + slideIDs[n] = obj.getAttribute('id'); + } + else { + obj.setAttribute('id',did); + slideIDs[n] = did; + } + if (isOp) continue; + + var otext = ''; + var menu = obj.firstChild; + if (!menu) continue; // to cope with empty slides + while (menu && menu.nodeType == 3) { + menu = menu.nextSibling; + } + if (!menu) continue; // to cope with slides with only text nodes + + var menunodes = menu.childNodes; + for (var o = 0; o < menunodes.length; o++) { + otext += nodeValue(menunodes[o]); + } + list.options[list.length] = new Option(n + ' : ' + otext, n); + } +} + +function currentSlide() { + var cs; + var footer_nodes; + var vis = 'visible'; + if (document.getElementById) { + cs = document.getElementById('currentSlide'); + footer_nodes = document.getElementById('footer').childNodes; + } else { + cs = document.currentSlide; + footer = document.footer.childNodes; + } + cs.innerHTML = '' + snum + '<\/span> ' + + '\/<\/span> ' + + '' + (smax-1) + '<\/span>'; + if (snum == 0) { + vis = 'hidden'; + } + cs.style.visibility = vis; + for (var i = 0; i < footer_nodes.length; i++) { + if (footer_nodes[i].nodeType == 1) { + footer_nodes[i].style.visibility = vis; + } + } +} + +function go(step) { + if (document.getElementById('slideProj').disabled || step == 0) return; + var jl = document.getElementById('jumplist'); + var cid = slideIDs[snum]; + var ce = document.getElementById(cid); + if (incrementals[snum].length > 0) { + for (var i = 0; i < incrementals[snum].length; i++) { + removeClass(incrementals[snum][i], 'current'); + removeClass(incrementals[snum][i], 'incremental'); + } + } + if (step != 'j') { + snum += step; + lmax = smax - 1; + if (snum > lmax) snum = lmax; + if (snum < 0) snum = 0; + } else + snum = parseInt(jl.value); + var nid = slideIDs[snum]; + var ne = document.getElementById(nid); + if (!ne) { + ne = document.getElementById(slideIDs[0]); + snum = 0; + } + if (step < 0) {incpos = incrementals[snum].length} else {incpos = 0;} + if (incrementals[snum].length > 0 && incpos == 0) { + for (var i = 0; i < incrementals[snum].length; i++) { + if (hasClass(incrementals[snum][i], 'current')) + incpos = i + 1; + else + addClass(incrementals[snum][i], 'incremental'); + } + } + if (incrementals[snum].length > 0 && incpos > 0) + addClass(incrementals[snum][incpos - 1], 'current'); + ce.style.visibility = 'hidden'; + ne.style.visibility = 'visible'; + jl.selectedIndex = snum; + currentSlide(); + number = 0; +} + +function goTo(target) { + if (target >= smax || target == snum) return; + go(target - snum); +} + +function subgo(step) { + if (step > 0) { + removeClass(incrementals[snum][incpos - 1],'current'); + removeClass(incrementals[snum][incpos], 'incremental'); + addClass(incrementals[snum][incpos],'current'); + incpos++; + } else { + incpos--; + removeClass(incrementals[snum][incpos],'current'); + addClass(incrementals[snum][incpos], 'incremental'); + addClass(incrementals[snum][incpos - 1],'current'); + } +} + +function toggle() { + var slideColl = GetElementsWithClassName('*','slide'); + var slides = document.getElementById('slideProj'); + var outline = document.getElementById('outlineStyle'); + if (!slides.disabled) { + slides.disabled = true; + outline.disabled = false; + s5mode = false; + fontSize('1em'); + for (var n = 0; n < smax; n++) { + var slide = slideColl[n]; + slide.style.visibility = 'visible'; + } + } else { + slides.disabled = false; + outline.disabled = true; + s5mode = true; + fontScale(); + for (var n = 0; n < smax; n++) { + var slide = slideColl[n]; + slide.style.visibility = 'hidden'; + } + slideColl[snum].style.visibility = 'visible'; + } +} + +function showHide(action) { + var obj = GetElementsWithClassName('*','hideme')[0]; + switch (action) { + case 's': obj.style.visibility = 'visible'; break; + case 'h': obj.style.visibility = 'hidden'; break; + case 'k': + if (obj.style.visibility != 'visible') { + obj.style.visibility = 'visible'; + } else { + obj.style.visibility = 'hidden'; + } + break; + } +} + +// 'keys' code adapted from MozPoint (http://mozpoint.mozdev.org/) +function keys(key) { + if (!key) { + key = event; + key.which = key.keyCode; + } + if (key.which == 84) { + toggle(); + return; + } + if (s5mode) { + switch (key.which) { + case 10: // return + case 13: // enter + if (window.event && isParentOrSelf(window.event.srcElement, 'controls')) return; + if (key.target && isParentOrSelf(key.target, 'controls')) return; + if(number != undef) { + goTo(number); + break; + } + case 32: // spacebar + case 34: // page down + case 39: // rightkey + case 40: // downkey + if(number != undef) { + go(number); + } else if (!incrementals[snum] || incpos >= incrementals[snum].length) { + go(1); + } else { + subgo(1); + } + break; + case 33: // page up + case 37: // leftkey + case 38: // upkey + if(number != undef) { + go(-1 * number); + } else if (!incrementals[snum] || incpos <= 0) { + go(-1); + } else { + subgo(-1); + } + break; + case 36: // home + goTo(0); + break; + case 35: // end + goTo(smax-1); + break; + case 67: // c + showHide('k'); + break; + } + if (key.which < 48 || key.which > 57) { + number = undef; + } else { + if (window.event && isParentOrSelf(window.event.srcElement, 'controls')) return; + if (key.target && isParentOrSelf(key.target, 'controls')) return; + number = (((number != undef) ? number : 0) * 10) + (key.which - 48); + } + } + return false; +} + +function clicker(e) { + number = undef; + var target; + if (window.event) { + target = window.event.srcElement; + e = window.event; + } else target = e.target; + if (target.href != null || hasValue(target.rel, 'external') || isParentOrSelf(target, 'controls') || isParentOrSelf(target,'embed') || isParentOrSelf(target, 'object')) return true; + if (!e.which || e.which == 1) { + if (!incrementals[snum] || incpos >= incrementals[snum].length) { + go(1); + } else { + subgo(1); + } + } +} + +function findSlide(hash) { + var target = document.getElementById(hash); + if (target) { + for (var i = 0; i < slideIDs.length; i++) { + if (target.id == slideIDs[i]) return i; + } + } + return null; +} + +function slideJump() { + if (window.location.hash == null || window.location.hash == '') { + currentSlide(); + return; + } + if (window.location.hash == null) return; + var dest = null; + dest = findSlide(window.location.hash.slice(1)); + if (dest == null) { + dest = 0; + } + go(dest - snum); +} + +function fixLinks() { + var thisUri = window.location.href; + thisUri = thisUri.slice(0, thisUri.length - window.location.hash.length); + var aelements = document.getElementsByTagName('A'); + for (var i = 0; i < aelements.length; i++) { + var a = aelements[i].href; + var slideID = a.match('\#.+'); + if ((slideID) && (slideID[0].slice(0,1) == '#')) { + var dest = findSlide(slideID[0].slice(1)); + if (dest != null) { + if (aelements[i].addEventListener) { + aelements[i].addEventListener("click", new Function("e", + "if (document.getElementById('slideProj').disabled) return;" + + "go("+dest+" - snum); " + + "if (e.preventDefault) e.preventDefault();"), true); + } else if (aelements[i].attachEvent) { + aelements[i].attachEvent("onclick", new Function("", + "if (document.getElementById('slideProj').disabled) return;" + + "go("+dest+" - snum); " + + "event.returnValue = false;")); + } + } + } + } +} + +function externalLinks() { + if (!document.getElementsByTagName) return; + var anchors = document.getElementsByTagName('a'); + for (var i=0; i' + + '